Version 0.25.1

Add error callback

Author: John Egan

README.md

@@ -1,7 +1,12 @@
 # OpenAPI TypeScript Codegen
 
-Fork of [ferdikoomen/openapi-typescript-codegen](https://github.com/ferdikoomen/openapi-typescript-codegen). See that repository for documentation.
+Fork of [ferdikoomen/openapi-typescript-codegen](https://github.com/ferdikoomen/openapi-typescript-codegen). See that repository for more documentation.
 
 ## List of changes
+1. Headers are always optional, whether the OpenAPI JSON says they are required or not.
+2. Added an optional config property called `ERROR_CALLBACK` which is a function that will run before API errors are thrown.
 
-1. Headers are always optional, whether the Open API JSON says they are required or not.
+## Testing
+1. Run `npm test` to run automated tests
+2. If a snapshot test fails due to an intentional change, run `npm run test:update` to update the snapshots
+3. To test local changes with your application, first run `npm run build`. Then, replace `npx @jegan321/openapi-typescript-codegen` with `node ../openapi-typescript-codegen/bin/index.js` in your application-side script.

package.json

@@ -1,6 +1,6 @@
 {
     "name": "@jegan321/openapi-typescript-codegen",
-    "version": "0.25.0",
+    "version": "0.25.1",
     "description": "Library that generates Typescript clients based on the OpenAPI specification. Fork of ferdikoomen/openapi-typescript-codegen",
     "author": "John Egan",
     "homepage": "https://github.com/jegan321/openapi-typescript-codegen",

src/templates/core/OpenAPI.hbs

@@ -1,6 +1,7 @@
 {{>header}}
 
 import type { ApiRequestOptions } from './ApiRequestOptions';
+import { ApiError } from './ApiError';
 
 type Resolver<T> = (options: ApiRequestOptions) => Promise<T>;
 type Headers = Record<string, string>;
@@ -15,6 +16,7 @@ export type OpenAPIConfig = {
 	PASSWORD?: string | Resolver<string> | undefined;
 	HEADERS?: Headers | Resolver<Headers> | undefined;
 	ENCODE_PATH?: ((path: string) => string) | undefined;
+	ERROR_CALLBACK?: (error: ApiError) => void;
 };
 
 export const OpenAPI: OpenAPIConfig = {

src/templates/core/angular/request.hbs

@@ -100,7 +100,7 @@ export const request = <T>(config: OpenAPIConfig, http: HttpClient, options: Api
 			} as ApiResult);
 		}),
 		map(result => {
-			catchErrorCodes(options, result);
+			catchErrorCodes(config, options, result);
 			return result.body as T;
 		}),
 		catchError((error: ApiError) => {

src/templates/core/axios/request.hbs

@@ -91,7 +91,7 @@ export const request = <T>(config: OpenAPIConfig, options: ApiRequestOptions, ax
 					body: responseHeader ?? responseBody,
 				};
 
-				catchErrorCodes(options, result);
+				catchErrorCodes(config, options, result);
 
 				resolve(result.body);
 			}

src/templates/core/fetch/request.hbs

@@ -83,7 +83,7 @@ export const request = <T>(config: OpenAPIConfig, options: ApiRequestOptions): C
 					body: responseHeader ?? responseBody,
 				};
 
-				catchErrorCodes(options, result);
+				catchErrorCodes(config, options, result);
 
 				resolve(result.body);
 			}

src/templates/core/functions/catchErrorCodes.hbs

@@ -1,6 +1,6 @@
 
 
-export const catchErrorCodes = (options: ApiRequestOptions, result: ApiResult): void => {
+export const catchErrorCodes = (config: OpenAPIConfig, options: ApiRequestOptions, result: ApiResult): void => {
 	const errors: Record<number, string> = {
 		400: 'Bad Request',
 		401: 'Unauthorized',
@@ -14,7 +14,12 @@ export const catchErrorCodes = (options: ApiRequestOptions, result: ApiResult):
 
 	const error = errors[result.status];
 	if (error) {
-		throw new ApiError(options, result, error);
+		const apiError = new ApiError(options, result, error);
+		const errorCallback = config.ERROR_CALLBACK;
+		if (errorCallback) {
+			errorCallback(apiError);
+		}
+		throw apiError;
 	}
 
 	if (!result.ok) {

src/templates/core/node/request.hbs

@@ -88,7 +88,7 @@ export const request = <T>(config: OpenAPIConfig, options: ApiRequestOptions): C
 					body: responseHeader ?? responseBody,
 				};
 
-				catchErrorCodes(options, result);
+				catchErrorCodes(config, options, result);
 
 				resolve(result.body);
 			}

src/templates/core/xhr/request.hbs

@@ -86,7 +86,7 @@ export const request = <T>(config: OpenAPIConfig, options: ApiRequestOptions): C
 					body: responseHeader ?? responseBody,
 				};
 
-				catchErrorCodes(options, result);
+				catchErrorCodes(config, options, result);
 
 				resolve(result.body);
 			}

test/__snapshots__/index.spec.ts.snap

@@ -206,6 +206,7 @@ exports[`v2 should generate: test/generated/v2/core/OpenAPI.ts 1`] = `
 /* tslint:disable */
 /* eslint-disable */
 import type { ApiRequestOptions } from './ApiRequestOptions';
+import { ApiError } from './ApiError';
 
 type Resolver<T> = (options: ApiRequestOptions) => Promise<T>;
 type Headers = Record<string, string>;
@@ -220,6 +221,7 @@ export type OpenAPIConfig = {
     PASSWORD?: string | Resolver<string> | undefined;
     HEADERS?: Headers | Resolver<Headers> | undefined;
     ENCODE_PATH?: ((path: string) => string) | undefined;
+    ERROR_CALLBACK?: (error: ApiError) => void;
 };
 
 export const OpenAPI: OpenAPIConfig = {
@@ -500,6 +502,10 @@ export const catchErrorCodes = (options: ApiRequestOptions, result: ApiResult):
 
     const error = errors[result.status];
     if (error) {
+        const errorCallback = OpenAPI.ERROR_CALLBACK;
+        if (errorCallback) {
+            errorCallback(new ApiError(options, result, error));
+        }
         throw new ApiError(options, result, error);
     }
 
@@ -2821,19 +2827,19 @@ import { OpenAPI } from '../core/OpenAPI';
 import { request as __request } from '../core/request';
 export class ParametersService {
     /**
-     * @param parameterHeader This is the parameter that goes into the header
      * @param parameterQuery This is the parameter that goes into the query params
      * @param parameterForm This is the parameter that goes into the form data
      * @param parameterBody This is the parameter that is sent as request body
      * @param parameterPath This is the parameter that goes into the path
+     * @param parameterHeader This is the parameter that goes into the header
      * @throws ApiError
      */
     public static callWithParameters(
-        parameterHeader: string,
         parameterQuery: string,
         parameterForm: string,
         parameterBody: string,
         parameterPath: string,
+        parameterHeader?: string,
     ): CancelablePromise<void> {
         return __request(OpenAPI, {
             method: 'POST',
@@ -2854,25 +2860,25 @@ export class ParametersService {
         });
     }
     /**
-     * @param parameterHeader This is the parameter that goes into the request header
      * @param parameterQuery This is the parameter that goes into the request query params
      * @param parameterForm This is the parameter that goes into the request form data
      * @param parameterBody This is the parameter that is sent as request body
      * @param parameterPath1 This is the parameter that goes into the path
      * @param parameterPath2 This is the parameter that goes into the path
      * @param parameterPath3 This is the parameter that goes into the path
      * @param _default This is the parameter with a reserved keyword
+     * @param parameterHeader This is the parameter that goes into the request header
      * @throws ApiError
      */
     public static callWithWeirdParameterNames(
-        parameterHeader: string,
         parameterQuery: string,
         parameterForm: string,
         parameterBody: string,
         parameterPath1?: string,
         parameterPath2?: string,
         parameterPath3?: string,
         _default?: string,
+        parameterHeader?: string,
     ): CancelablePromise<void> {
         return __request(OpenAPI, {
             method: 'POST',
@@ -3299,6 +3305,7 @@ exports[`v3 should generate: test/generated/v3/core/OpenAPI.ts 1`] = `
 /* tslint:disable */
 /* eslint-disable */
 import type { ApiRequestOptions } from './ApiRequestOptions';
+import { ApiError } from './ApiError';
 
 type Resolver<T> = (options: ApiRequestOptions) => Promise<T>;
 type Headers = Record<string, string>;
@@ -3313,6 +3320,7 @@ export type OpenAPIConfig = {
     PASSWORD?: string | Resolver<string> | undefined;
     HEADERS?: Headers | Resolver<Headers> | undefined;
     ENCODE_PATH?: ((path: string) => string) | undefined;
+    ERROR_CALLBACK?: (error: ApiError) => void;
 };
 
 export const OpenAPI: OpenAPIConfig = {
@@ -3593,6 +3601,10 @@ export const catchErrorCodes = (options: ApiRequestOptions, result: ApiResult):
 
     const error = errors[result.status];
     if (error) {
+        const errorCallback = OpenAPI.ERROR_CALLBACK;
+        if (errorCallback) {
+            errorCallback(new ApiError(options, result, error));
+        }
         throw new ApiError(options, result, error);
     }
 
@@ -6621,7 +6633,7 @@ export class DeprecatedService {
      * @throws ApiError
      */
     public static deprecatedCall(
-        parameter: DeprecatedModel | null,
+        parameter?: DeprecatedModel | null,
     ): CancelablePromise<void> {
         return __request(OpenAPI, {
             method: 'POST',
@@ -6997,21 +7009,21 @@ import { OpenAPI } from '../core/OpenAPI';
 import { request as __request } from '../core/request';
 export class ParametersService {
     /**
-     * @param parameterHeader This is the parameter that goes into the header
      * @param parameterQuery This is the parameter that goes into the query params
      * @param parameterForm This is the parameter that goes into the form data
      * @param parameterCookie This is the parameter that goes into the cookie
      * @param parameterPath This is the parameter that goes into the path
      * @param requestBody This is the parameter that goes into the body
+     * @param parameterHeader This is the parameter that goes into the header
      * @throws ApiError
      */
     public static callWithParameters(
-        parameterHeader: string | null,
         parameterQuery: string | null,
         parameterForm: string | null,
         parameterCookie: string | null,
         parameterPath: string | null,
         requestBody: ModelWithString | null,
+        parameterHeader?: string | null,
     ): CancelablePromise<void> {
         return __request(OpenAPI, {
             method: 'POST',
@@ -7036,7 +7048,6 @@ export class ParametersService {
         });
     }
     /**
-     * @param parameterHeader This is the parameter that goes into the request header
      * @param parameterQuery This is the parameter that goes into the request query params
      * @param parameterForm This is the parameter that goes into the request form data
      * @param parameterCookie This is the parameter that goes into the cookie
@@ -7045,10 +7056,10 @@ export class ParametersService {
      * @param parameterPath2 This is the parameter that goes into the path
      * @param parameterPath3 This is the parameter that goes into the path
      * @param _default This is the parameter with a reserved keyword
+     * @param parameterHeader This is the parameter that goes into the request header
      * @throws ApiError
      */
     public static callWithWeirdParameterNames(
-        parameterHeader: string | null,
         parameterQuery: string | null,
         parameterForm: string | null,
         parameterCookie: string | null,
@@ -7057,6 +7068,7 @@ export class ParametersService {
         parameterPath2?: string,
         parameterPath3?: string,
         _default?: string,
+        parameterHeader?: string | null,
     ): CancelablePromise<void> {
         return __request(OpenAPI, {
             method: 'POST',