APIClient and query/body/params

cosmology-tech · May 26, 2024 · 33d8b8c · 33d8b8c
1 parent 2d1f9e6
commit 33d8b8c
Show file tree

Hide file tree

Showing 8 changed files with 6,071 additions and 5,806 deletions.
diff --git a/__fixtures__/output/swagger-client.merged.ts b/__fixtures__/output/swagger-client.merged.ts
diff --git a/__fixtures__/output/swagger-client.ts b/__fixtures__/output/swagger-client.ts
diff --git a/package.json b/package.json
@@ -40,5 +40,8 @@
     "ts-jest": "^29.1.1",
     "ts-node": "^10.9.2",
     "typescript": "^5.1.6"
+  },
+  "dependencies": {
+    "@interweb/fetch-api-client": "^0.4.1"
   }
 }
diff --git a/packages/fetch-api-client/src/index.ts b/packages/fetch-api-client/src/index.ts
@@ -1,4 +1,4 @@
-import fetch from 'isomorphic-fetch';
+import { URLSearchParams } from 'url';
 
 interface RequestOptions<Params> {
   hostname: string;
@@ -13,6 +13,93 @@ export interface APIClientOptions {
   restEndpoint: string;
 }
 
+export interface APIClientRequestHeaders {
+  accept?: string | string[] | undefined;
+  'accept-charset'?: string | string[] | undefined;
+  'accept-encoding'?: string | string[] | undefined;
+  'accept-language'?: string | string[] | undefined;
+  'accept-ranges'?: string | undefined;
+  'access-control-allow-credentials'?: string | undefined;
+  'access-control-allow-headers'?: string | undefined;
+  'access-control-allow-methods'?: string | undefined;
+  'access-control-allow-origin'?: string | undefined;
+  'access-control-expose-headers'?: string | undefined;
+  'access-control-max-age'?: string | undefined;
+  'access-control-request-headers'?: string | undefined;
+  'access-control-request-method'?: string | undefined;
+  age?: string | undefined;
+  allow?: string | undefined;
+  authorization?: string | undefined;
+  'cache-control'?: string | undefined;
+  'cdn-cache-control'?: string | undefined;
+  connection?: string | string[] | undefined;
+  'content-disposition'?: string | undefined;
+  'content-encoding'?: string | undefined;
+  'content-language'?: string | undefined;
+  'content-length'?: string | number | undefined;
+  'content-location'?: string | undefined;
+  'content-range'?: string | undefined;
+  'content-security-policy'?: string | undefined;
+  'content-security-policy-report-only'?: string | undefined;
+  cookie?: string | string[] | undefined;
+  dav?: string | string[] | undefined;
+  dnt?: string | undefined;
+  date?: string | undefined;
+  etag?: string | undefined;
+  expect?: string | undefined;
+  expires?: string | undefined;
+  forwarded?: string | undefined;
+  from?: string | undefined;
+  host?: string | undefined;
+  'if-match'?: string | undefined;
+  'if-modified-since'?: string | undefined;
+  'if-none-match'?: string | undefined;
+  'if-range'?: string | undefined;
+  'if-unmodified-since'?: string | undefined;
+  'last-modified'?: string | undefined;
+  link?: string | string[] | undefined;
+  location?: string | undefined;
+  'max-forwards'?: string | undefined;
+  origin?: string | undefined;
+  prgama?: string | string[] | undefined;
+  'proxy-authenticate'?: string | string[] | undefined;
+  'proxy-authorization'?: string | undefined;
+  'public-key-pins'?: string | undefined;
+  'public-key-pins-report-only'?: string | undefined;
+  range?: string | undefined;
+  referer?: string | undefined;
+  'referrer-policy'?: string | undefined;
+  refresh?: string | undefined;
+  'retry-after'?: string | undefined;
+  'sec-websocket-accept'?: string | undefined;
+  'sec-websocket-extensions'?: string | string[] | undefined;
+  'sec-websocket-key'?: string | undefined;
+  'sec-websocket-protocol'?: string | string[] | undefined;
+  'sec-websocket-version'?: string | undefined;
+  server?: string | undefined;
+  'set-cookie'?: string | string[] | undefined;
+  'strict-transport-security'?: string | undefined;
+  te?: string | undefined;
+  trailer?: string | undefined;
+  'transfer-encoding'?: string | undefined;
+  'user-agent'?: string | undefined;
+  upgrade?: string | undefined;
+  'upgrade-insecure-requests'?: string | undefined;
+  vary?: string | undefined;
+  via?: string | string[] | undefined;
+  warning?: string | undefined;
+  'www-authenticate'?: string | string[] | undefined;
+  'x-content-type-options'?: string | undefined;
+  'x-dns-prefetch-control'?: string | undefined;
+  'x-frame-options'?: string | undefined;
+  'x-xss-protection'?: string | undefined;
+}
+export type APIClientRequestOpts = {
+  headers?: APIClientRequestHeaders;
+  timeout?: number;
+  isFormData?: boolean;
+};
+
 export class APIClient {
   private baseUrl: string;
   private defaultTimeout: number = 10000; // 10 seconds
@@ -21,7 +108,7 @@ export class APIClient {
     this.baseUrl = options.restEndpoint;
   }
 
-  private buildUrl(endpoint: string, query?: { [key: string]: any }): string {
+  private buildFullPath(endpoint: string, query?: { [key: string]: any }): string {
     const url = new URL(endpoint, this.baseUrl);
     if (query) {
       Object.keys(query).forEach(key => url.searchParams.append(key, query[key]));
@@ -31,87 +118,142 @@ export class APIClient {
 
   private async request<Resp>(options: RequestOptions<any>): Promise<Resp> {
     const { path, headers, method, params, timeout } = options;
-    const url = this.buildUrl(path, method === 'GET' && params);
+    const url = this.buildFullPath(path, method === 'GET' ? params : undefined);
+
+    const controller = new AbortController();
+    const id = setTimeout(() => controller.abort(), timeout || this.defaultTimeout);
+
     const fetchOptions: RequestInit = {
       method,
       headers,
+      signal: controller.signal,
       body: method !== 'GET' && method !== 'DELETE' ? JSON.stringify(params) : null,
     };
 
-    const controller = new AbortController();
-    const id = setTimeout(() => controller.abort(), timeout || this.defaultTimeout);
-    fetchOptions.signal = controller.signal;
+    try {
+      const response = await fetch(url, fetchOptions);
+      clearTimeout(id);
 
-    const response = await fetch(url, fetchOptions);
-    clearTimeout(id);
+      if (!response.ok) {
+        throw new Error(`HTTP error! status: ${response.status}`);
+      }
 
-    if (!response.ok) {
-      throw new Error(`HTTP error! status: ${response.status}`);
+      return response.json() as Promise<Resp>;
+    } catch (error) {
+      clearTimeout(id);
+      throw error;
     }
-
-    return response.json() as Promise<Resp>;
   }
 
-  get<Resp = unknown>(endpoint: string, query?: { [key: string]: any }, opts: { headers?: { [key: string]: string }, timeout?: number } = {}): Promise<Resp> {
+  get<Resp = unknown>(
+    endpoint: string,
+    query?: { [key: string]: any },
+    body?: void,
+    opts: APIClientRequestOpts = {}
+  ): Promise<Resp> {
     return this.request<Resp>({
       path: endpoint,
       method: 'GET',
+      // @ts-ignore
       headers: opts.headers,
       timeout: opts.timeout || this.defaultTimeout,
-      params: query, // Correctly use query parameters for GET
-      hostname: '',
+      params: query,
     });
   }
 
-  post<Resp = unknown, Params = any>(endpoint: string, params: Params, opts: { headers?: { [key: string]: string }, timeout?: number } = {}): Promise<Resp> {
+  post<Resp = unknown, Params = any>(
+    endpoint: string,
+    query?: { [key: string]: any },
+    body?: Params,
+    opts: APIClientRequestOpts = {}
+  ): Promise<Resp> {
+    const headers = opts.isFormData
+      ? {
+        'Content-Type': 'application/x-www-form-urlencoded',
+        ...opts.headers,
+      }
+      : {
+        'Content-Type': 'application/json',
+        ...opts.headers,
+      };
+    const bodyContent = opts.isFormData
+      ? new URLSearchParams(body as any).toString()
+      : JSON.stringify(body);
+
     return this.request<Resp>({
       path: endpoint,
       method: 'POST',
-      headers: {
-        'Content-Type': 'application/json',
-        ...opts.headers,
-      },
-      params,
+      // @ts-ignore
+      headers,
       timeout: opts.timeout || this.defaultTimeout,
-      hostname: '',
+      params: bodyContent,
     });
   }
 
-  put<Resp = unknown, Params = any>(endpoint: string, params: Params, opts: { headers?: { [key: string]: string }, timeout?: number } = {}): Promise<Resp> {
-    return this.request<Resp>({
-      path: endpoint,
-      method: 'PUT',
-      headers: {
+  patch<Resp = unknown, Params = any>(
+    endpoint: string,
+    query?: { [key: string]: any },
+    body?: Params,
+    opts: APIClientRequestOpts = {}
+  ): Promise<Resp> {
+    const headers = opts.isFormData
+      ? {
+        'Content-Type': 'application/x-www-form-urlencoded',
+        ...opts.headers,
+      }
+      : {
         'Content-Type': 'application/json',
         ...opts.headers,
-      },
-      params,
+      };
+    const bodyContent = opts.isFormData
+      ? new URLSearchParams(body as any).toString()
+      : JSON.stringify(body);
+
+    return this.request<Resp>({
+      path: endpoint,
+      method: 'PATCH',
+      // @ts-ignore
+      headers,
       timeout: opts.timeout || this.defaultTimeout,
-      hostname: '',
+      params: bodyContent,
     });
   }
 
-  patch<Resp = unknown, Params = any>(endpoint: string, params: Params, opts: { headers?: { [key: string]: string }, timeout?: number } = {}): Promise<Resp> {
+  put<Resp = unknown, Params = any>(
+    endpoint: string,
+    query?: { [key: string]: any },
+    body?: Params,
+    opts: APIClientRequestOpts = {}
+  ): Promise<Resp> {
+    const headers = {
+      'Content-Type': 'application/json',
+      ...opts.headers,
+    };
+    const bodyContent = JSON.stringify(body);
+
     return this.request<Resp>({
       path: endpoint,
-      method: 'PATCH',
-      headers: {
-        'Content-Type': 'application/json',
-        ...opts.headers,
-      },
-      params,
+      method: 'PUT',
+      // @ts-ignore
+      headers,
       timeout: opts.timeout || this.defaultTimeout,
-      hostname: '',
+      params: bodyContent,
     });
   }
 
-  delete<Resp = unknown>(endpoint: string, opts: { headers?: { [key: string]: string }, timeout?: number } = {}): Promise<Resp> {
+  delete<Resp = unknown>(
+    endpoint: string,
+    query?: { [key: string]: any },
+    body?: void,
+    opts: APIClientRequestOpts = {}
+  ): Promise<Resp> {
     return this.request<Resp>({
       path: endpoint,
       method: 'DELETE',
+      // @ts-ignore
       headers: opts.headers,
       timeout: opts.timeout || this.defaultTimeout,
-      hostname: '',
+      params: query,
     });
   }
 }