Allow to provide unserialized req body to http client

Author: nebarf

src/client/http-request.ts

@@ -2,7 +2,7 @@ import { HttpMethod } from '../enum';
 
 export interface HttpRequestProps {
   baseUrl: string;
-  body?: BodyInit | null;
+  body?: unknown;
   credentials?: RequestCredentials;
   headers?: HeadersInit;
   maxAge?: number;
@@ -28,7 +28,7 @@ export class HttpRequest implements HttpRequestProps {
   /**
    * The request body.
    */
-  private _body?: BodyInit;
+  private _body?: unknown;
 
   /**
    * The request credentials.
@@ -88,7 +88,7 @@ export class HttpRequest implements HttpRequestProps {
     return this._baseUrl;
   }
 
-  get body(): BodyInit | null {
+  get body(): unknown {
     return this._body || null;
   }
 

src/client/types.ts

@@ -39,7 +39,7 @@ export interface UseHttpClientReturn {
   abortableDelete: HttpClientAbortableRequest;
 }
 
-export interface HttpRequestOptions<RequestBody = BodyInit> {
+export interface HttpRequestOptions<RequestBody = unknown> {
   body: RequestBody | null | undefined;
   credentials: RequestCredentials | undefined;
   headers?: HeadersInit;

src/client/use-http-client.ts

@@ -56,7 +56,7 @@ export const useHttpClient = (): UseHttpClientReturn => {
           ...defaultOptions.headers,
           ...headers,
         },
-        body: body && requestBodySerializer(body),
+        body: body ? requestBodySerializer(body) : null,
         maxAge: maxAge || 0,
         queryParams,
       };
@@ -66,6 +66,7 @@ export const useHttpClient = (): UseHttpClientReturn => {
        */
       const requestInfo: HttpRequest = new HttpRequest({
         ...mergedOptions,
+        body,
         baseUrl: computedBaseUrl,
         relativeUrl: relativeUrl || '',
       });

src/config/request-body-serializer.ts

@@ -1,42 +1,15 @@
+import {
+  isArrayBuffer,
+  isBlob,
+  isBoolean,
+  isFormData,
+  isNumber,
+  isObject,
+  isUrlSearchParams,
+} from '../shared';
 import { ReqBodySerializerReturn } from './types';
 
-/**
- * Safely assert whether the given value is an ArrayBuffer.
- *
- * In some execution environments ArrayBuffer is not defined.
- */
-function isArrayBuffer(value: unknown): value is ArrayBuffer {
-  return typeof ArrayBuffer !== 'undefined' && value instanceof ArrayBuffer;
-}
-
-/**
- * Safely assert whether the given value is a Blob.
- *
- * In some execution environments Blob is not defined.
- */
-function isBlob(value: unknown): value is Blob {
-  return typeof Blob !== 'undefined' && value instanceof Blob;
-}
-
-/**
- * Safely assert whether the given value is a FormData instance.
- *
- * In some execution environments FormData is not defined.
- */
-function isFormData(value: unknown): value is FormData {
-  return typeof FormData !== 'undefined' && value instanceof FormData;
-}
-
-/**
- * Safely assert whether the given value is a URLSearchParams instance.
- *
- * In some execution environments URLSearchParams is not defined.
- */
-function isUrlSearchParams(value: unknown): value is URLSearchParams {
-  return typeof URLSearchParams !== 'undefined' && value instanceof URLSearchParams;
-}
-
-export function serializeRequestBody(body: BodyInit): ReqBodySerializerReturn {
+export function serializeRequestBody(body: unknown): ReqBodySerializerReturn {
   // If no body is present, no need to serialize it.
   if (body === null || typeof body === 'undefined') {
     return null;
@@ -54,11 +27,11 @@ export function serializeRequestBody(body: BodyInit): ReqBodySerializerReturn {
     return body;
   }
 
-  // Check whether the body is an object or array, and serialize with JSON if so.
-  if (typeof body === 'object' || typeof body === 'boolean' || Array.isArray(body)) {
+  // Check whether the body is an object, an array, a boolean or a number, and serialize with JSON if so.
+  if (isObject(body) || isBoolean(body) || isNumber(body) || Array.isArray(body)) {
     return JSON.stringify(body);
   }
 
-  // Fall back to unmodified body.
-  return body;
+  // Fallback to body string literal.
+  return `${body}`;
 }

src/config/types.ts

@@ -2,14 +2,8 @@ import { HttpCacheService, HttpCacheStore } from '../cache';
 import { ReactElement } from 'react';
 import { HttpRequestOptions, HttpResponseParser } from '../client';
 
-export type ReqBodySerializerReturn =
-  | string
-  | null
-  | ArrayBuffer
-  | Blob
-  | FormData
-  | URLSearchParams;
-export type HttpRequestBodySerializer = (body: BodyInit) => ReqBodySerializerReturn;
+export type ReqBodySerializerReturn = BodyInit | null;
+export type HttpRequestBodySerializer = (body: unknown) => ReqBodySerializerReturn;
 
 export interface HttpClientConfig {
   reqOptions: Partial<HttpRequestOptions>;

src/shared/index.ts

@@ -2,3 +2,5 @@ export * from './use-compare-callback';
 export * from './use-compare-effect';
 export * from './use-compare-memo';
 export * from './use-compare-ref';
+export * from './types';
+export * from './type-checker';

src/shared/type-checker.ts

@@ -0,0 +1,56 @@
+/**
+ * Safely assert whether the given value is an ArrayBuffer.
+ *
+ * In some execution environments ArrayBuffer is not defined.
+ */
+export function isArrayBuffer(value: unknown): value is ArrayBuffer {
+  return typeof ArrayBuffer !== 'undefined' && value instanceof ArrayBuffer;
+}
+
+/**
+ * Safely assert whether the given value is a Blob.
+ *
+ * In some execution environments Blob is not defined.
+ */
+export function isBlob(value: unknown): value is Blob {
+  return typeof Blob !== 'undefined' && value instanceof Blob;
+}
+
+/**
+ * Safely assert whether the given value is a FormData instance.
+ *
+ * In some execution environments FormData is not defined.
+ */
+export function isFormData(value: unknown): value is FormData {
+  return typeof FormData !== 'undefined' && value instanceof FormData;
+}
+
+/**
+ * Safely assert whether the given value is a URLSearchParams instance.
+ *
+ * In some execution environments URLSearchParams is not defined.
+ */
+export function isUrlSearchParams(value: unknown): value is URLSearchParams {
+  return typeof URLSearchParams !== 'undefined' && value instanceof URLSearchParams;
+}
+
+/**
+ * Safely assert whether the given value is a number.
+ */
+export function isNumber(value: unknown): value is number {
+  return typeof value === 'number';
+}
+
+/**
+ * Safely assert whether the given value is a boolean.
+ */
+export function isBoolean(value: unknown): value is number {
+  return typeof value === 'boolean';
+}
+
+/**
+ * Safely assert whether the given value is an object.
+ */
+export function isObject(value: unknown): value is number {
+  return typeof value === 'object';
+}