Cleaning up typing a bit

Author: jdalrymple

packages/core/src/infrastructure/RequestHelper.ts

@@ -4,10 +4,11 @@ import { BaseResource } from '@gitbeaker/requester-utils';
 import type {
   FormattedResponse,
   RequestHandlerFn,
+  RequesterBodyType,
   ResponseBodyTypes,
 } from '@gitbeaker/requester-utils';
 import { appendFormFromObject, parseLinkHeader } from './Utils';
-import type { AllOrNone, Camelize, OptionValueType } from './Utils';
+import type { AllOrNone, Camelize } from './Utils';
 
 export interface IsForm {
   isForm?: boolean;
@@ -321,11 +322,12 @@ export function post<T extends ResponseBodyTypes>() {
   return async <C extends boolean = false, E extends boolean = false>(
     service: BaseResource<C>,
     endpoint: string,
-    { searchParams, isForm, sudo, showExpanded, ...options }: IsForm & BaseRequestOptions<E> = {},
+    { searchParams, sudo, showExpanded, rawBody, ...options }: IsForm & BaseRequestOptions<E> = {},
   ): Promise<GitlabAPIResponse<T, C, E, void>> => {
-    const body = isForm
-      ? appendFormFromObject(options as Record<string, OptionValueType>)
-      : options;
+    let body: RequesterBodyType | undefined;
+
+    if (rawBody) body = rawBody;
+    else body = options;
 
     const response = await service.requester.post(endpoint, {
       searchParams,
@@ -345,11 +347,12 @@ export function put<T extends ResponseBodyTypes>() {
   return async <C extends boolean = false, E extends boolean = false>(
     service: BaseResource<C>,
     endpoint: string,
-    { searchParams, isForm, sudo, showExpanded, ...options }: IsForm & BaseRequestOptions<E> = {},
+    { searchParams, sudo, showExpanded, rawBody, ...options }: IsForm & BaseRequestOptions<E> = {},
   ): Promise<GitlabAPIResponse<T, C, E, void>> => {
-    const body = isForm
-      ? appendFormFromObject(options as Record<string, OptionValueType>)
-      : options;
+    let body: RequesterBodyType | undefined;
+
+    if (rawBody) body = rawBody;
+    else body = options;
 
     const response = await service.requester.put(endpoint, {
       body,
@@ -369,11 +372,20 @@ export function patch<T extends ResponseBodyTypes>() {
   return async <C extends boolean = false, E extends boolean = false>(
     service: BaseResource<C>,
     endpoint: string,
-    { searchParams, isForm, sudo, showExpanded, ...options }: IsForm & BaseRequestOptions<E> = {},
+    {
+      searchParams,
+      sudo,
+      showExpanded,
+      rawBody,
+      isForm,
+      ...options
+    }: IsForm & BaseRequestOptions<E> = {},
   ): Promise<GitlabAPIResponse<T, C, E, void>> => {
-    const body = isForm
-      ? appendFormFromObject(options as Record<string, OptionValueType>)
-      : options;
+    let body: RequesterBodyType | undefined;
+
+    if (rawBody) body = rawBody;
+    else if (isForm) body = appendFormFromObject(options as Record<string, ResponseBodyTypes>);
+    else body = options;
 
     const response = await service.requester.patch(endpoint, {
       body,

packages/core/src/infrastructure/Utils.ts

@@ -26,8 +26,6 @@ export type AllOrNone<T extends Record<string, any>> = T | Partial<Record<keyof
 
 export type MappedOmit<T, K extends keyof T> = { [P in keyof T as P extends K ? never : P]: T[P] };
 
-export type OptionValueType = undefined | string | boolean | Blob | number | (Blob | string)[];
-
 export function appendFormFromObject(object: Record<string, OptionValueType>): FormData {
   const form = new FormData();
 

packages/requester-utils/src/RequesterUtils.ts

@@ -39,9 +39,11 @@ export type ResourceOptions = {
   rateLimits?: RateLimitOptions;
 };
 
+export type OptionValueType = string | boolean | Blob | number | (Blob | string)[];
+export type RequesterBodyType = string | Blob | FormData | Record<string, OptionValueType>;
 export type DefaultRequestOptions = {
-  body?: FormData | Record<string, unknown>;
-  searchParams?: Record<string, unknown>;
+  body?: RequesterBodyType;
+  searchParams?: Record<string, string>;
   sudo?: string | number;
   method?: string;
   asStream?: boolean;
@@ -54,7 +56,7 @@ export type RequestOptions = {
   method?: string;
   searchParams?: string;
   prefixUrl?: string;
-  body?: string | FormData;
+  body?: BodyInit;
   asStream?: boolean;
   signal?: AbortSignal;
   rateLimiters?: Record<string, RateLimiterFn>;
@@ -132,14 +134,10 @@ export async function defaultOptionsHandler(
 
   if (sudo) defaultOptions.headers.sudo = `${sudo}`;
 
-  // FIXME: Not the best comparison, but...it will have to do for now.
-  if (body) {
-    if (body instanceof FormData) {
-      defaultOptions.body = body;
-    } else {
-      defaultOptions.body = JSON.stringify(decamelizeKeys(body));
-      defaultOptions.headers['content-type'] = 'application/json';
-    }
+  if (body instanceof FormData || body instanceof Blob || typeof body === 'string') {
+    defaultOptions.body = body;
+  } else {
+    defaultOptions.body = JSON.stringify(decamelizeKeys(body));
   }
 
   if (Object.keys(authHeaders).length > 0) {