Add Either support (#3)

CodeLenny · web-flow · commit c59d9ed52844 · 2022-06-22T17:29:12.000-04:00
* Remove codecov token

* Add Either support

* Update snapshots

* Add types for ApiError, fix error for babel

* Update snapshots

* Apply changes to v3 parser too, fix formatting, reject with error results (not successes)
diff --git a/src/client/interfaces/Operation.d.ts b/src/client/interfaces/Operation.d.ts
@@ -12,5 +12,6 @@ export interface Operation extends OperationParameters {
     path: string;
     errors: OperationError[];
     results: OperationResponse[];
+    errorResults: OperationResponse[];
     responseHeader: string | null;
 }
diff --git a/src/openApi/v2/parser/getOperation.ts b/src/openApi/v2/parser/getOperation.ts
@@ -7,7 +7,7 @@ import { getOperationName } from './getOperationName';
 import { getOperationParameters } from './getOperationParameters';
 import { getOperationResponseHeader } from './getOperationResponseHeader';
 import { getOperationResponses } from './getOperationResponses';
-import { getOperationResults } from './getOperationResults';
+import { getOperationErrorResults, getOperationResults } from './getOperationResults';
 import { getServiceName } from './getServiceName';
 import { sortByRequired } from './sortByRequired';
 
@@ -41,6 +41,7 @@ export const getOperation = (
         imports: [],
         errors: [],
         results: [],
+        errorResults: [],
         responseHeader: null,
     };
 
@@ -61,13 +62,19 @@ export const getOperation = (
     if (op.responses) {
         const operationResponses = getOperationResponses(openApi, op.responses);
         const operationResults = getOperationResults(operationResponses);
+        const operationErrorResults = getOperationErrorResults(operationResponses);
         operation.errors = getOperationErrors(operationResponses);
         operation.responseHeader = getOperationResponseHeader(operationResults);
 
         operationResults.forEach(operationResult => {
             operation.results.push(operationResult);
             operation.imports.push(...operationResult.imports);
         });
+
+        operationErrorResults.forEach(operationResult => {
+            operation.errorResults.push(operationResult);
+            operation.imports.push(...operationResult.imports);
+        });
     }
 
     operation.parameters = operation.parameters.sort(sortByRequired);
diff --git a/src/openApi/v2/parser/getOperationResults.ts b/src/openApi/v2/parser/getOperationResults.ts
@@ -9,6 +9,41 @@ const areEqual = (a: Model, b: Model): boolean => {
     return equal;
 };
 
+export const getOperationErrorResults = (operationResponses: OperationResponse[]): OperationResponse[] => {
+    const operationResults: OperationResponse[] = [];
+
+    operationResponses.forEach(operationResponse => {
+        const { code } = operationResponse;
+        if (code && (code === 204 || code < 200 || code >= 300)) {
+            operationResults.push(operationResponse);
+        }
+    });
+
+    if (!operationResults.length) {
+        operationResults.push({
+            in: 'response',
+            name: '',
+            code: 0,
+            description: '',
+            export: 'generic',
+            type: 'any',
+            base: 'any',
+            template: null,
+            link: null,
+            isDefinition: false,
+            isReadOnly: false,
+            isRequired: false,
+            isNullable: false,
+            imports: [],
+            enum: [],
+            enums: [],
+            properties: [],
+        });
+    }
+
+    return operationResults;
+};
+
 export const getOperationResults = (operationResponses: OperationResponse[]): OperationResponse[] => {
     const operationResults: OperationResponse[] = [];
 
diff --git a/src/openApi/v3/parser/getOperation.ts b/src/openApi/v3/parser/getOperation.ts
@@ -9,7 +9,7 @@ import { getOperationParameters } from './getOperationParameters';
 import { getOperationRequestBody } from './getOperationRequestBody';
 import { getOperationResponseHeader } from './getOperationResponseHeader';
 import { getOperationResponses } from './getOperationResponses';
-import { getOperationResults } from './getOperationResults';
+import { getOperationErrorResults, getOperationResults } from './getOperationResults';
 import { getRef } from './getRef';
 import { getServiceName } from './getServiceName';
 import { sortByRequired } from './sortByRequired';
@@ -44,6 +44,7 @@ export const getOperation = (
         imports: [],
         errors: [],
         results: [],
+        errorResults: [],
         responseHeader: null,
     };
 
@@ -72,13 +73,19 @@ export const getOperation = (
     if (op.responses) {
         const operationResponses = getOperationResponses(openApi, op.responses);
         const operationResults = getOperationResults(operationResponses);
+        const operationErrorResults = getOperationErrorResults(operationResponses);
         operation.errors = getOperationErrors(operationResponses);
         operation.responseHeader = getOperationResponseHeader(operationResults);
 
         operationResults.forEach(operationResult => {
             operation.results.push(operationResult);
             operation.imports.push(...operationResult.imports);
         });
+
+        operationErrorResults.forEach(operationResult => {
+            operation.errorResults.push(operationResult);
+            operation.imports.push(...operationResult.imports);
+        });
     }
 
     operation.parameters = operation.parameters.sort(sortByRequired);
diff --git a/src/openApi/v3/parser/getOperationResults.ts b/src/openApi/v3/parser/getOperationResults.ts
@@ -9,6 +9,41 @@ const areEqual = (a: Model, b: Model): boolean => {
     return equal;
 };
 
+export const getOperationErrorResults = (operationResponses: OperationResponse[]): OperationResponse[] => {
+    const operationResults: OperationResponse[] = [];
+
+    operationResponses.forEach(operationResponse => {
+        const { code } = operationResponse;
+        if (code && (code === 204 || code < 200 || code >= 300)) {
+            operationResults.push(operationResponse);
+        }
+    });
+
+    if (!operationResults.length) {
+        operationResults.push({
+            in: 'response',
+            name: '',
+            code: 0,
+            description: '',
+            export: 'generic',
+            type: 'any',
+            base: 'any',
+            template: null,
+            link: null,
+            isDefinition: false,
+            isReadOnly: false,
+            isRequired: false,
+            isNullable: false,
+            imports: [],
+            enum: [],
+            enums: [],
+            properties: [],
+        });
+    }
+
+    return operationResults;
+};
+
 export const getOperationResults = (operationResponses: OperationResponse[]): OperationResponse[] => {
     const operationResults: OperationResponse[] = [];
 
diff --git a/src/templates/core/ApiError.hbs b/src/templates/core/ApiError.hbs
@@ -3,14 +3,17 @@
 import type { ApiRequestOptions } from './ApiRequestOptions';
 import type { ApiResult } from './ApiResult';
 
-export class ApiError extends Error {
+export class ApiError<
+	StatusCode extends number = number,
+	ApiErrorBody = any,
+> extends Error {
 	public readonly url: string;
-	public readonly status: number;
+	public readonly status: StatusCode;
 	public readonly statusText: string;
-	public readonly body: any;
+	public readonly body: ApiErrorBody;
 	public readonly request: ApiRequestOptions;
 
-	constructor(request: ApiRequestOptions, response: ApiResult, message: string) {
+	constructor(request: ApiRequestOptions, response: ApiResult<StatusCode, ApiErrorBody>, message: string) {
 		super(message);
 
 		this.name = 'ApiError';
diff --git a/src/templates/core/ApiResult.hbs b/src/templates/core/ApiResult.hbs
@@ -1,9 +1,24 @@
 {{>header}}
 
-export type ApiResult = {
+export type ApiResult<
+	StatusCode extends number = number,
+	ApiErrorBody = any,
+> = {
 	readonly url: string;
 	readonly ok: boolean;
-	readonly status: number;
+	readonly status: StatusCode;
 	readonly statusText: string;
-	readonly body: any;
+	readonly body: ApiErrorBody;
 };
+
+export interface Left<E> {
+	readonly _tag: 'Left';
+	readonly left: E;
+}
+
+export interface Right<A> {
+	readonly _tag: 'Right';
+	readonly right: A;
+}
+
+export type Either<E, A> = Left<E> | Right<A>;
diff --git a/src/templates/exportService.hbs b/src/templates/exportService.hbs
@@ -25,10 +25,14 @@ import type { CancelablePromise } from '../core/CancelablePromise';
 import { BaseHttpRequest } from '../core/BaseHttpRequest';
 {{else}}
 import type { BaseHttpRequest } from '../core/BaseHttpRequest';
+import type { Left, Right, Either } from '../core/ApiResult';
+import type { ApiError } from '../core/ApiError';
 {{/equals}}
 {{else}}
 import { OpenAPI } from '../core/OpenAPI';
 import { request as __request } from '../core/request';
+import type { Left, Right, Either } from '../core/ApiResult';
+import type { ApiError } from '../core/ApiError';
 {{/if}}
 
 {{#equals @root.httpClient 'angular'}}
@@ -146,5 +150,128 @@ export class {{{name}}}{{{@root.postfix}}} {
 		});
 	}
 
+	{{#equals @root.httpClient 'angular'}}
+	{{else}}
+	/**
+	{{#if deprecated}}
+	 * @deprecated
+	{{/if}}
+	{{#if summary}}
+	 * {{{escapeComment summary}}}
+	{{/if}}
+	{{#if description}}
+	 * {{{escapeComment description}}}
+	{{/if}}
+	{{#unless @root.useOptions}}
+	{{#if parameters}}
+	{{#each parameters}}
+	 * @param {{{name}}} {{#if description}}{{{escapeComment description}}}{{/if}}
+	{{/each}}
+	{{/if}}
+	{{/unless}}
+	{{#each results}}
+	 * @returns {{{type}}} {{#if description}}{{{escapeComment description}}}{{/if}}
+	{{/each}}
+	 * @throws ApiError
+	 */
+	{{#if @root.exportClient}}
+	{{#equals @root.httpClient 'angular'}}
+	public async {{{name}}}Either({{>parameters}}): Observable<{{>result}}> {
+		try {
+			const result: ({{>result}}) = await this.httpRequest.request({
+	{{else}}
+	public async {{{name}}}Either({{>parameters}}): Promise<Either<{{>errorResult}}, {{>result}}>> {
+		try {
+			const result: ({{>result}}) = await this.httpRequest.request({
+	{{/equals}}
+	{{else}}
+	{{#equals @root.httpClient 'angular'}}
+	public async {{{name}}}Either({{>parameters}}): Observable<{{>result}}> {
+		try {
+			const result: ({{>result}}) = await __request(OpenAPI, this.http, {
+	{{else}}
+	public static async {{{name}}}Either({{>parameters}}): Promise<Either<{{>errorResult}}, {{>result}}>> {
+		try {
+			const result: ({{>result}}) = await __request(OpenAPI, {
+	{{/equals}}
+	{{/if}}
+				method: '{{{method}}}',
+				url: '{{{path}}}',
+				{{#if parametersPath}}
+				path: {
+					{{#each parametersPath}}
+					'{{{prop}}}': {{{name}}},
+					{{/each}}
+				},
+				{{/if}}
+				{{#if parametersCookie}}
+				cookies: {
+					{{#each parametersCookie}}
+					'{{{prop}}}': {{{name}}},
+					{{/each}}
+				},
+				{{/if}}
+				{{#if parametersHeader}}
+				headers: {
+					{{#each parametersHeader}}
+					'{{{prop}}}': {{{name}}},
+					{{/each}}
+				},
+				{{/if}}
+				{{#if parametersQuery}}
+				query: {
+					{{#each parametersQuery}}
+					'{{{prop}}}': {{{name}}},
+					{{/each}}
+				},
+				{{/if}}
+				{{#if parametersForm}}
+				formData: {
+					{{#each parametersForm}}
+					'{{{prop}}}': {{{name}}},
+					{{/each}}
+				},
+				{{/if}}
+				{{#if parametersBody}}
+				{{#equals parametersBody.in 'formData'}}
+				formData: {{{parametersBody.name}}},
+				{{/equals}}
+				{{#equals parametersBody.in 'body'}}
+				body: {{{parametersBody.name}}},
+				{{/equals}}
+				{{#if parametersBody.mediaType}}
+				mediaType: '{{{parametersBody.mediaType}}}',
+				{{/if}}
+				{{/if}}
+				{{#if responseHeader}}
+				responseHeader: '{{{responseHeader}}}',
+				{{/if}}
+				{{#if errors}}
+				errors: {
+					{{#each errors}}
+					{{{code}}}: `{{{escapeDescription description}}}`,
+					{{/each}}
+				},
+				{{/if}}
+			});
+
+			const right: Right<{{>result}}> = {
+				_tag: 'Right',
+				right: result,
+			};
+
+			return right;
+		} catch (e) {
+			const left: Left<{{>errorResult}}> = {
+				_tag: 'Left',
+				left: e as ({{>errorResult}}),
+			};
+
+			return left;
+		}
+	}
+	{{/equals}}
+
+
 	{{/each}}
 }
diff --git a/src/templates/partials/errorResult.hbs b/src/templates/partials/errorResult.hbs
@@ -0,0 +1,5 @@
+{{~#if errorResults~}}
+{{#each errorResults}}ApiError<{{#equals code 0}}number{{else}}{{{code}}}{{/equals}}, {{type}}>{{#unless @last}} | {{/unless}}{{/each}}
+{{~else~}}
+ApiError<number, any>
+{{~/if~}}
diff --git a/src/utils/registerHandlebarTemplates.ts b/src/utils/registerHandlebarTemplates.ts
@@ -57,6 +57,7 @@ import templateExportSchema from '../templates/exportSchema.hbs';
 import templateExportService from '../templates/exportService.hbs';
 import templateIndex from '../templates/index.hbs';
 import partialBase from '../templates/partials/base.hbs';
+import partialErrorResult from '../templates/partials/errorResult.hbs';
 import partialExportComposition from '../templates/partials/exportComposition.hbs';
 import partialExportEnum from '../templates/partials/exportEnum.hbs';
 import partialExportInterface from '../templates/partials/exportInterface.hbs';
@@ -148,6 +149,7 @@ export const registerHandlebarTemplates = (root: {
     Handlebars.registerPartial('isRequired', Handlebars.template(partialIsRequired));
     Handlebars.registerPartial('parameters', Handlebars.template(partialParameters));
     Handlebars.registerPartial('result', Handlebars.template(partialResult));
+    Handlebars.registerPartial('errorResult', Handlebars.template(partialErrorResult));
     Handlebars.registerPartial('schema', Handlebars.template(partialSchema));
     Handlebars.registerPartial('schemaArray', Handlebars.template(partialSchemaArray));
     Handlebars.registerPartial('schemaDictionary', Handlebars.template(partialSchemaDictionary));
diff --git a/test/__snapshots__/index.spec.ts.snap b/test/__snapshots__/index.spec.ts.snap
diff --git a/test/e2e/client.node.spec.ts b/test/e2e/client.node.spec.ts

Original file line number	Diff line number	Diff line change
`@@ -12,5 +12,6 @@ export interface Operation extends OperationParameters {`
`12`	`12`	`path: string;`
`13`	`13`	`errors: OperationError[];`
`14`	`14`	`results: OperationResponse[];`
	`15`	`+ errorResults: OperationResponse[];`
`15`	`16`	`responseHeader: string \| null;`
`16`	`17`	`}`