feat: provide currying functional api client (#109)

Co-authored-by: hrsh7th <[email protected]>

Author: Himenon

README.md

@@ -74,6 +74,196 @@ const main = () => {
 main();
 ```
 
+### The variation of template code
+
+This library provides three types of templates
+
+```ts
+import * as Templates from "@himenon/openapi-typescript-code-generator/templates";
+
+Templates.ClassApiClient.generator;
+Templates.FunctionalApiClient.generator;
+Templates.CurryingFunctionalApiClient.generator;
+```
+
+#### `Templates.ClassApiClient.generator`
+
+We provide a class-based API client. Please inject the API client dependency and use it instead of `constructor`.
+
+```ts
+export interface RequestArgs {
+  httpMethod: HttpMethod;
+  url: string;
+  headers: ObjectLike | any;
+  requestBody?: ObjectLike | any;
+  requestBodyEncoding?: Record<string, Encoding>;
+  queryParameters?: QueryParameters | undefined;
+}
+
+export interface ApiClient<RequestOption> {
+  request: <T = SuccessResponses>(requestArgs: RequestArgs, options?: RequestOption) => Promise<T>;
+}
+
+export class Client<RequestOption> {
+  private baseUrl: string;
+  constructor(private apiClient: ApiClient<RequestOption>, baseUrl: string) {
+    this.baseUrl = baseUrl.replace(/\/$/, "");
+  }
+
+  public async createPublisherV2<RequestContentType extends RequestContentType$createPublisherV2>(
+    params: Params$createPublisherV2<RequestContentType>,
+    option?: RequestOption,
+  ): Promise<Response$createPublisherV2$Status$200["application/json"]> {
+    const url = this.baseUrl + `/create/v2/publisher/{id}`;
+    const headers = {
+      "Content-Type": params.headers["Content-Type"],
+      Accept: "application/json",
+    };
+    const requestEncodings = {
+      "application/x-www-form-urlencoded": {
+        color: {
+          style: "form",
+          explode: false,
+        },
+      },
+      "application/json": {
+        color: {
+          style: "form",
+          explode: false,
+        },
+      },
+    };
+    return this.apiClient.request(
+      {
+        httpMethod: "POST",
+        url,
+        headers,
+        requestBody: params.requestBody,
+        requestBodyEncoding: requestEncodings[params.headers["Content-Type"]],
+      },
+      option,
+    );
+  }
+}
+```
+
+#### `Templates.FunctionalApiClient.generator`
+
+We also provide a function-based API client that replaces the class-based API client with `createClient`. Please inject the API client dependency and use it.
+
+```ts
+export interface RequestArgs {
+  httpMethod: HttpMethod;
+  url: string;
+  headers: ObjectLike | any;
+  requestBody?: ObjectLike | any;
+  requestBodyEncoding?: Record<string, Encoding>;
+  queryParameters?: QueryParameters | undefined;
+}
+
+export interface ApiClient<RequestOption> {
+  request: <T = SuccessResponses>(requestArgs: RequestArgs, options?: RequestOption) => Promise<T>;
+}
+
+export const createClient = <RequestOption>(apiClient: ApiClient<RequestOption>, baseUrl: string) => {
+  const _baseUrl = baseUrl.replace(/\/$/, "");
+  return {
+    createPublisherV2: <RequestContentType extends RequestContentType$createPublisherV2>(
+      params: Params$createPublisherV2<RequestContentType>,
+      option?: RequestOption,
+    ): Promise<Response$createPublisherV2$Status$200["application/json"]> => {
+      const url = _baseUrl + `/create/v2/publisher/{id}`;
+      const headers = {
+        "Content-Type": params.headers["Content-Type"],
+        Accept: "application/json",
+      };
+      const requestEncodings = {
+        "application/x-www-form-urlencoded": {
+          color: {
+            style: "form",
+            explode: false,
+          },
+        },
+        "application/json": {
+          color: {
+            style: "form",
+            explode: false,
+          },
+        },
+      };
+      return apiClient.request(
+        {
+          httpMethod: "POST",
+          url,
+          headers,
+          requestBody: params.requestBody,
+          requestBodyEncoding: requestEncodings[params.headers["Content-Type"]],
+        },
+        option,
+      );
+    },
+  };
+};
+```
+
+#### `Templates.CurryingFunctionalApiClient.generator`
+
+**Tree shaking support**
+
+We also provide a curried function-based API client that requires injection of API client for each `operationId`. The first function argument demands `ApiClient` while the second function argument demands `RequestArgs`. The `ApiClient` interface is different from the others, as it requires `uri` as an argument.
+
+This is designed for use cases that utilize **tree shaking**.
+
+```ts
+export interface RequestArgs {
+  httpMethod: HttpMethod;
+  uri: string; // <------------------ Note that the uri
+  headers: ObjectLike | any;
+  requestBody?: ObjectLike | any;
+  requestBodyEncoding?: Record<string, Encoding>;
+  queryParameters?: QueryParameters | undefined;
+}
+export interface ApiClient<RequestOption> {
+  request: <T = SuccessResponses>(requestArgs: RequestArgs, options?: RequestOption) => Promise<T>;
+}
+export const createPublisherV2 =
+  <RequestOption>(apiClient: ApiClient<RequestOption>) =>
+  <RequestContentType extends RequestContentType$createPublisherV2>(
+    params: Params$createPublisherV2<RequestContentType>,
+    option?: RequestOption,
+  ): Promise<Response$createPublisherV2$Status$200["application/json"]> => {
+    const uri = `/create/v2/publisher/{id}`;
+    const headers = {
+      "Content-Type": params.headers["Content-Type"],
+      Accept: "application/json",
+    };
+    const requestEncodings = {
+      "application/x-www-form-urlencoded": {
+        color: {
+          style: "form",
+          explode: false,
+        },
+      },
+      "application/json": {
+        color: {
+          style: "form",
+          explode: false,
+        },
+      },
+    };
+    return apiClient.request(
+      {
+        httpMethod: "POST",
+        uri,
+        headers,
+        requestBody: params.requestBody,
+        requestBodyEncoding: requestEncodings[params.headers["Content-Type"]],
+      },
+      option,
+    );
+  };
+```
+
 ### Split the type definition file and the API Client implementation
 
 ```ts
@@ -400,4 +590,3 @@ TypeScript AST
 Validation Design
 
 - Copyright (c) 2018 Kogo Software LLC - [https://github.com/kogosoftwarellc/open-api/tree/master/packages/openapi-schema-validator#readme](openapi-schema-validator)
-