feat: Add AWS Signiture Ability

- Add AWS Signature Ability
- Remove Static Instance Generation
- Remove remainder of Legacy HTTP Clients

Author: moretalk

README.md

@@ -49,7 +49,6 @@ $ openapi --help
     --exportSchemas <value>   Write schemas to disk (default: false)
     --postfix <value>         Service name postfix (default: "Service")
     --request <value>         Path to custom request file
-    --exportClient <value>    Generate and write client class to disk (default: false)
     --name <value>            Custom client class name (default: "AppClient")
     -h, --help                display help for command
 
@@ -344,15 +343,15 @@ interface ModelWithNullableString {
 }
 ```
 
-### Generate client instance with `--exportClient` option
+### Generate client instance
 
 The OpenAPI generator allows to create client instances to support the multiple backend services use case.
-The generated client uses an instance of the server configuration and not the global `OpenAPI` constant.
+The generated client uses an instance of the server configuration.
 
-To generate a client instance, use `--exportClient` option. To set a custom name to the client class, use `--name` option.
+To set a custom name to the client class, use `--name` option.
 
 ```
-openapi --input ./spec.json --output ./dist --exportClient true --name DemoAppClient
+openapi --input ./spec.json --output ./dist --name DemoAppClient
 ```
 
 The generated client will be exported from the `index` file and can be used as shown below:

bin/index.js

@@ -20,7 +20,7 @@ const params = program
     .option('--exportModels <value>', 'Write models to disk', true)
     .option('--exportSchemas <value>', 'Write schemas to disk', false)
     .option('--postfix <value>', 'Service name postfix', 'Service')
-    .option('--exportClient <value>', 'Generate and write client class to disk', false)
+    .option('--awsSign <value>', 'Sign Requests with AWS V4 Signiture', false)
     .option('--request <value>', 'Path to custom request file')
     .option('--name <value>', 'Custom client class name', 'AppClient')
     .parse(process.argv)
@@ -40,8 +40,8 @@ if (OpenAPI) {
         exportModels: JSON.parse(params.exportModels) === true,
         exportSchemas: JSON.parse(params.exportSchemas) === true,
         postfix: params.postfix,
-        exportClient: JSON.parse(params.exportClient) === true,
         clientName: params.name,
+        awsSign: JSON.parse(params.awsSign) === true,
         request: params.request,
     })
         .then(() => {

package-lock.json

@@ -24,7 +24,6 @@
         "typescript",
         "yaml",
         "json",
-        "fetch",
         "axios",
         "node"
     ],
@@ -61,6 +60,8 @@
         "prepublishOnly": "npm run clean && npm run release"
     },
     "dependencies": {
+        "@aws-crypto/sha256-js": "^4.0.0",
+        "@aws-sdk/signature-v4": "^3.310.0",
         "abort-controller": "^3.0.0",
         "axios": "^0.27.2",
         "camelcase": "6.3.0",

package.json

@@ -1,6 +1,3 @@
 export enum HttpClient {
-    FETCH = 'fetch',
-    XHR = 'xhr',
-    NODE = 'node',
     AXIOS = 'axios',
 }

src/HttpClient.ts

@@ -20,9 +20,9 @@ export type Options = {
     exportModels?: boolean;
     exportSchemas?: boolean;
     postfix?: string;
-    exportClient?: boolean;
     request?: string;
     clientName?: string;
+    awsSign?: boolean;
     write?: boolean;
 };
 
@@ -32,32 +32,32 @@ export type Options = {
  * service layer, etc.
  * @param input The relative ___location of the OpenAPI spec
  * @param output The relative ___location of the output directory
- * @param httpClient The selected httpClient (fetch, xhr, node or axios)
+ * @param httpClient The selected httpClient (axios)
  * @param useOptions Use options or arguments functions
  * @param useUnionTypes Use union types instead of enums
  * @param exportCore: Generate core client classes
  * @param exportServices: Generate services
  * @param exportModels: Generate models
  * @param exportSchemas: Generate schemas
  * @param postfix: Service name postfix
- * @param exportClient: Generate client class
  * @param clientName: Custom client class name
+ * @param awsSign: Sign Requests with AWS V4 Signiture
  * @param request: Path to custom request file
  * @param write Write the files to disk (true or false)
  */
 export async function generate({
     input,
     output,
-    httpClient = HttpClient.FETCH,
+    httpClient = HttpClient.AXIOS,
     useOptions = false,
     useUnionTypes = false,
     exportCore = true,
     exportServices = true,
     exportModels = true,
     exportSchemas = false,
     postfix = 'Service',
-    exportClient = false,
     clientName = 'AppClient',
+    awsSign = false,
     request,
     write = true,
 }: Options): Promise<void> {
@@ -72,7 +72,7 @@ export async function generate({
     switch (openApiVersion) {
         case OpenApiVersion.V3: {
             const client = parseV3(openApi);
-            const clientFinal = postProcessClient(client, exportClient);
+            const clientFinal = postProcessClient(client);
             if (!write) break;
             await writeClient(
                 clientFinal,
@@ -86,8 +86,8 @@ export async function generate({
                 exportModels,
                 exportSchemas,
                 postfix,
-                exportClient,
                 clientName,
+                awsSign,
                 request
             );
             break;

src/index.ts

@@ -18,15 +18,4 @@ export type OpenAPIConfig2 = {
     token?: string | Resolver<string>;
     accountSid?: string | Resolver<string>;
     authToken?: string | Resolver<string>;
-}
-
-{{#unless @root.exportClient}}
-
-export const OpenAPI: OpenAPIConfig = {
-    base: '{{{server}}}',
-    version: '{{{version}}}',
-    edge: '{{#if server.edgeRegions}}{{server.edgeRegions.[0]}}{{else}}gll{{/if}}',
-    token: undefined,
-    accountSid: undefined,
-    authToken: undefined
-};{{/unless}}
+}

src/templates/core/OpenAPI.hbs

@@ -1,10 +1,11 @@
-async function getHeaders(options: ApiRequestOptions, config: OpenAPIConfig2, formData?: FormData): Promise<Record<string, string>> {
+async function getHeaders(options: ApiRequestOptions, config: OpenAPIConfig2, url: URL): Promise<Record<string, string>> {
     const token = await resolve(options, config.token);
     const accountSid = await resolve(options, config.accountSid);
     const authToken = await resolve(options, config.authToken);
 
     const headers = Object.entries({
         Accept: 'application/json',
+        host: url.hostname,
         ...options.headers,
     })
     .filter(([_, value]) => isDefined(value))

src/templates/core/axios/getHeaders.hbs

@@ -10,11 +10,16 @@ import type { ApiResult } from './ApiResult';
 import { CancelablePromise } from './CancelablePromise';
 import type { OnCancel } from './CancelablePromise';
 import type { OpenAPIConfig2 } from './OpenAPI';
-{{#if @root.exportClient}}
 import { BaseHttpRequest } from './BaseHttpRequest';
-{{else}}
-import { OpenAPI } from './OpenAPI';
+
+{{#if @root.awsSign}}
+import { SignatureV4 } from '@aws-sdk/signature-v4';
+import { Sha256 } from '@aws-crypto/sha256-js';
+
+{{>functions/signAWS}}
 {{/if}}
+
+
 {{>functions/isDefined}}
 
 
@@ -66,7 +71,6 @@ import { OpenAPI } from './OpenAPI';
 {{>functions/catchErrors}}
 
 
-{{#if @root.exportClient}}
 export class AxiosHttpRequest extends BaseHttpRequest {
     constructor(openApiConfig: OpenAPIConfig2) {
         super(openApiConfig);
@@ -84,15 +88,20 @@ export class AxiosHttpRequest extends BaseHttpRequest {
                 const url = getUrl(options, this.openApiConfig);
                 const formData = getFormData(options);
                 const body = getRequestBody(options);
-                const headers = await getHeaders(options, this.openApiConfig, formData);
+                const headers = await getHeaders(options, this.openApiConfig, url);
+
+                {{#if @root.awsSign}}
+                    const signed = await signAWS({ url, options, headers, body: body ?? formData });
+                    console.log("It worked!", signed);
+                {{/if}}
 
                 if (!onCancel.isCancelled) {
                     const response = await sendRequest(options, url, formData, body, headers, onCancel, this.openApiConfig);
                     const responseBody = getResponseBody(response);
                     const responseHeader = getResponseHeader(response, options.responseHeader);
 
                     const result: ApiResult = {
-                        url,
+                        url: url.toString(),
                         ok: isSuccess(response.status),
                         status: response.status,
                         statusText: response.statusText,
@@ -109,41 +118,3 @@ export class AxiosHttpRequest extends BaseHttpRequest {
         });
     }
 }
-{{else}}
-/**
- * Request using axios client
- * @param options The request options from the the service
- * @returns CancelablePromise<T>
- * @throws ApiError
- */
-export function request<T>(options: ApiRequestOptions): CancelablePromise<T> {
-    return new CancelablePromise(async (resolve, reject, onCancel) => {
-        try {
-            const url = getUrl(options, OpenAPI);
-            const formData = getFormData(options);
-            const body = getRequestBody(options);
-            const headers = await getHeaders(options, OpenAPI, formData);
-
-            if (!onCancel.isCancelled) {
-                const response = await sendRequest(options, url, formData, body, headers, onCancel, OpenAPI);
-                const responseBody = getResponseBody(response);
-                const responseHeader = getResponseHeader(response, options.responseHeader);
-
-                const result: ApiResult = {
-                    url,
-                    ok: isSuccess(response.status),
-                    status: response.status,
-                    statusText: response.statusText,
-                    body: responseHeader || responseBody,
-                };
-
-                catchErrors(options, result);
-
-                resolve(result.body);
-            }
-        } catch (error) {
-            reject(error);
-        }
-    });
-}
-{{/if}}

src/templates/core/axios/request.hbs

@@ -1,17 +1,16 @@
 const sendRequest = async <T>(
     options: ApiRequestOptions,
-    url: string,
+    url: URL,
     formData: FormData | undefined,
     body: any,
     headers: Record<string, string>,
     onCancel: OnCancel,
     openApiConfig: OpenAPIConfig2
 ): Promise<AxiosResponse<T>> => {
     const source = axios.CancelToken.source();
-    const newUrl = openApiConfig.edge ? url.replace("{edge}", openApiConfig.edge) : url;
 
     const requestConfig: AxiosRequestConfig = {
-        url: newUrl,
+        url: url.toString(),
         headers,
         data: body ?? formData,
         method: options.method,