@goast/typescript 0.0.3 → 0.0.5

package/README.md

@@ -1,11 +1,11 @@
-# typescript
-
-This library was generated with [Nx](https://nx.dev).
-
-## Building
-
-Run `nx build typescript` to build the library.
-
-## Running unit tests
-
-Run `nx test typescript` to execute the unit tests via [Jest](https://jestjs.io).
+# typescript
+
+This library was generated with [Nx](https://nx.dev).
+
+## Building
+
+Run `nx build typescript` to build the library.
+
+## Running unit tests
+
+Run `nx test typescript` to execute the unit tests via [Jest](https://jestjs.io).

package/assets/client/fetch/types.ts

@@ -1,9 +1,14 @@
-export type TypedResponse<T> = Response & {
+type _VoidResponse = Omit<Response, 'json'> & {
+  isVoidResponse: true;
+};
+type _TypedResponse<T> = Response & {
   json(): Promise<T>;
+  isVoidResponse: false;
 };
+export type TypedResponse<T> = void extends T ? _VoidResponse : _TypedResponse<T>;
 
 export type FetchClientOptions = {
-  readonly baseUrl?: string;
-  readonly fetch?: typeof fetch;
-  readonly headers?: Record<string, string>;
+  baseUrl?: string;
+  fetch?: typeof fetch;
+  headers?: Record<string, string>;
 };

package/cjs/lib/generators/services/fetch-clients/fetch-client-generator.js

@@ -104,19 +104,19 @@ class DefaultTypeScriptFetchClientGenerator extends file_generator_1.TypeScriptF
             .forEach(ctx.service.endpoints, (builder, endpoint) => this.generateClassServiceMethod(ctx, builder, endpoint));
     }
     generateClassFields(ctx, builder) {
-        builder.ensureCurrentLineEmpty().appendLine('private readonly _options: FetchClientOptions;');
+        builder.ensureCurrentLineEmpty().appendLine('public options: FetchClientOptions;');
     }
     generateClassConstructor(ctx, builder) {
         builder
             .ensurePreviousLineEmpty()
-            .append('constructor(options?: FetchClientOptions)')
+            .append('constructor(options?: Partial<FetchClientOptions>)')
             .parenthesize('{}', (builder) => this.generateClassConstructorContent(ctx, builder), {
             indent: true,
             multiline: true,
         });
     }
     generateClassConstructorContent(ctx, builder) {
-        builder.appendLine('this._options = { ...', this.getDefaultOptionsConstantName(ctx), ', ...options };');
+        builder.appendLine('this.options = { ...', this.getDefaultOptionsConstantName(ctx), ', ...options };');
     }
     generateClassServiceMethod(ctx, builder, endpoint) {
         builder
@@ -168,21 +168,20 @@ class DefaultTypeScriptFetchClientGenerator extends file_generator_1.TypeScriptF
             .appendLineIf(params.length > 0 && !!bodySchemaId);
     }
     generateServiceMethodReturnValue(ctx, builder, endpoint) {
-        var _a, _b, _c;
-        const successResponse = (_a = endpoint.responses.find((x) => x.statusCode === 200)) !== null && _a !== void 0 ? _a : endpoint.responses.find((x) => x.statusCode && x.statusCode > 200 && x.statusCode < 300);
-        const schema = (_c = (_b = successResponse === null || successResponse === void 0 ? void 0 : successResponse.contentOptions) === null || _b === void 0 ? void 0 : _b.find((x) => x.schema !== undefined)) === null || _c === void 0 ? void 0 : _c.schema;
-        builder.append('Promise').parenthesize('<>', (builder) => this.generateTypedResponse(ctx, builder, schema));
+        builder
+            .append('Promise')
+            .parenthesize('<>', (builder) => this.generateTypedResponse(ctx, builder, this.getResponseSchema(ctx, endpoint)));
     }
     generateTypedResponse(ctx, builder, schema) {
         builder
             .addImport('TypedResponse', this.getUtilPath(ctx, 'types.ts'))
             .append('TypedResponse')
-            .parenthesize('<>', (builder) => builder.append(this.getTypeName(ctx, builder, schema === null || schema === void 0 ? void 0 : schema.id)));
+            .parenthesize('<>', (builder) => builder.append(this.getTypeName(ctx, builder, schema === null || schema === void 0 ? void 0 : schema.id, 'void')));
     }
     generateServiceMethodContent(ctx, builder, endpoint) {
         builder
             .addImport('UrlBuilder', this.getUtilPath(ctx, 'url-builder.ts'))
-            .appendLine('const url = new UrlBuilder(this._options.baseUrl)')
+            .appendLine('const url = new UrlBuilder(this.options.baseUrl)')
             .indent((builder) => builder
             .appendLine(`.withPath(${this.toStringLiteral(ctx, endpoint.path)})`)
             .forEach(endpoint.parameters.filter((x) => x.target === 'path' || x.target === 'query'), (builder, parameter) => builder
@@ -191,19 +190,21 @@ class DefaultTypeScriptFetchClientGenerator extends file_generator_1.TypeScriptF
             .parenthesize('()', `${this.toStringLiteral(ctx, parameter.name)}, params.${this.toPropertyName(ctx, parameter.name)}`)
             .appendLine())
             .appendLine('.build();'))
-            .append('return (this._options.fetch ?? fetch)')
+            .append('const response = (this.options.fetch ?? fetch)')
             .parenthesize('()', (builder) => builder.append('url, ').parenthesize('{}', (builder) => {
             var _a, _b;
             return builder
                 .appendLine('method: ', this.toStringLiteral(ctx, (0, core_1.toCasing)(endpoint.method, 'all-upper')), ',')
-                .appendLine('headers: this._options.headers,')
+                .appendLine('headers: this.options.headers,')
                 .appendLineIf(!!((_b = (_a = endpoint.requestBody) === null || _a === void 0 ? void 0 : _a.content[0]) === null || _b === void 0 ? void 0 : _b.schema), 'body: JSON.stringify(body),');
         }, { indent: true, multiline: true }), { indent: false })
-            .appendLine(' as ', (builder) => this.generateServiceMethodReturnValue(ctx, builder, endpoint), ';');
+            .appendLine(';')
+            .appendLine("Object.defineProperty(response, 'isVoidResponse', { value: ", this.getResponseSchema(ctx, endpoint) ? 'false' : 'true', ' });')
+            .appendLine('return response as unknown as ', (builder) => this.generateServiceMethodReturnValue(ctx, builder, endpoint), ';');
     }
-    getTypeName(ctx, builder, schemaId) {
+    getTypeName(ctx, builder, schemaId, fallback) {
         if (!schemaId) {
-            return this.getAnyType(ctx);
+            return fallback ? fallback : this.getAnyType(ctx);
         }
         const modelInfo = ctx.input.models[schemaId];
         if (!modelInfo) {
@@ -237,5 +238,10 @@ class DefaultTypeScriptFetchClientGenerator extends file_generator_1.TypeScriptF
     getUtilPath(ctx, fileName) {
         return (0, path_1.resolve)(ctx.config.outputDir, ctx.config.utilsDirPath, fileName);
     }
+    getResponseSchema(ctx, endpoint) {
+        var _a, _b, _c;
+        const successResponse = (_a = endpoint.responses.find((x) => x.statusCode === 200)) !== null && _a !== void 0 ? _a : endpoint.responses.find((x) => x.statusCode && x.statusCode > 200 && x.statusCode < 300);
+        return (_c = (_b = successResponse === null || successResponse === void 0 ? void 0 : successResponse.contentOptions) === null || _b === void 0 ? void 0 : _b.find((x) => x.schema !== undefined)) === null || _c === void 0 ? void 0 : _c.schema;
+    }
 }
 exports.DefaultTypeScriptFetchClientGenerator = DefaultTypeScriptFetchClientGenerator;

package/esm/lib/generators/services/fetch-clients/fetch-client-generator.js

@@ -101,19 +101,19 @@ export class DefaultTypeScriptFetchClientGenerator extends TypeScriptFileGenerat
             .forEach(ctx.service.endpoints, (builder, endpoint) => this.generateClassServiceMethod(ctx, builder, endpoint));
     }
     generateClassFields(ctx, builder) {
-        builder.ensureCurrentLineEmpty().appendLine('private readonly _options: FetchClientOptions;');
+        builder.ensureCurrentLineEmpty().appendLine('public options: FetchClientOptions;');
     }
     generateClassConstructor(ctx, builder) {
         builder
             .ensurePreviousLineEmpty()
-            .append('constructor(options?: FetchClientOptions)')
+            .append('constructor(options?: Partial<FetchClientOptions>)')
             .parenthesize('{}', (builder) => this.generateClassConstructorContent(ctx, builder), {
             indent: true,
             multiline: true,
         });
     }
     generateClassConstructorContent(ctx, builder) {
-        builder.appendLine('this._options = { ...', this.getDefaultOptionsConstantName(ctx), ', ...options };');
+        builder.appendLine('this.options = { ...', this.getDefaultOptionsConstantName(ctx), ', ...options };');
     }
     generateClassServiceMethod(ctx, builder, endpoint) {
         builder
@@ -165,21 +165,20 @@ export class DefaultTypeScriptFetchClientGenerator extends TypeScriptFileGenerat
             .appendLineIf(params.length > 0 && !!bodySchemaId);
     }
     generateServiceMethodReturnValue(ctx, builder, endpoint) {
-        var _a, _b, _c;
-        const successResponse = (_a = endpoint.responses.find((x) => x.statusCode === 200)) !== null && _a !== void 0 ? _a : endpoint.responses.find((x) => x.statusCode && x.statusCode > 200 && x.statusCode < 300);
-        const schema = (_c = (_b = successResponse === null || successResponse === void 0 ? void 0 : successResponse.contentOptions) === null || _b === void 0 ? void 0 : _b.find((x) => x.schema !== undefined)) === null || _c === void 0 ? void 0 : _c.schema;
-        builder.append('Promise').parenthesize('<>', (builder) => this.generateTypedResponse(ctx, builder, schema));
+        builder
+            .append('Promise')
+            .parenthesize('<>', (builder) => this.generateTypedResponse(ctx, builder, this.getResponseSchema(ctx, endpoint)));
     }
     generateTypedResponse(ctx, builder, schema) {
         builder
             .addImport('TypedResponse', this.getUtilPath(ctx, 'types.ts'))
             .append('TypedResponse')
-            .parenthesize('<>', (builder) => builder.append(this.getTypeName(ctx, builder, schema === null || schema === void 0 ? void 0 : schema.id)));
+            .parenthesize('<>', (builder) => builder.append(this.getTypeName(ctx, builder, schema === null || schema === void 0 ? void 0 : schema.id, 'void')));
     }
     generateServiceMethodContent(ctx, builder, endpoint) {
         builder
             .addImport('UrlBuilder', this.getUtilPath(ctx, 'url-builder.ts'))
-            .appendLine('const url = new UrlBuilder(this._options.baseUrl)')
+            .appendLine('const url = new UrlBuilder(this.options.baseUrl)')
             .indent((builder) => builder
             .appendLine(`.withPath(${this.toStringLiteral(ctx, endpoint.path)})`)
             .forEach(endpoint.parameters.filter((x) => x.target === 'path' || x.target === 'query'), (builder, parameter) => builder
@@ -188,19 +187,21 @@ export class DefaultTypeScriptFetchClientGenerator extends TypeScriptFileGenerat
             .parenthesize('()', `${this.toStringLiteral(ctx, parameter.name)}, params.${this.toPropertyName(ctx, parameter.name)}`)
             .appendLine())
             .appendLine('.build();'))
-            .append('return (this._options.fetch ?? fetch)')
+            .append('const response = (this.options.fetch ?? fetch)')
             .parenthesize('()', (builder) => builder.append('url, ').parenthesize('{}', (builder) => {
             var _a, _b;
             return builder
                 .appendLine('method: ', this.toStringLiteral(ctx, toCasing(endpoint.method, 'all-upper')), ',')
-                .appendLine('headers: this._options.headers,')
+                .appendLine('headers: this.options.headers,')
                 .appendLineIf(!!((_b = (_a = endpoint.requestBody) === null || _a === void 0 ? void 0 : _a.content[0]) === null || _b === void 0 ? void 0 : _b.schema), 'body: JSON.stringify(body),');
         }, { indent: true, multiline: true }), { indent: false })
-            .appendLine(' as ', (builder) => this.generateServiceMethodReturnValue(ctx, builder, endpoint), ';');
+            .appendLine(';')
+            .appendLine("Object.defineProperty(response, 'isVoidResponse', { value: ", this.getResponseSchema(ctx, endpoint) ? 'false' : 'true', ' });')
+            .appendLine('return response as unknown as ', (builder) => this.generateServiceMethodReturnValue(ctx, builder, endpoint), ';');
     }
-    getTypeName(ctx, builder, schemaId) {
+    getTypeName(ctx, builder, schemaId, fallback) {
         if (!schemaId) {
-            return this.getAnyType(ctx);
+            return fallback ? fallback : this.getAnyType(ctx);
         }
         const modelInfo = ctx.input.models[schemaId];
         if (!modelInfo) {
@@ -234,4 +235,9 @@ export class DefaultTypeScriptFetchClientGenerator extends TypeScriptFileGenerat
     getUtilPath(ctx, fileName) {
         return resolve(ctx.config.outputDir, ctx.config.utilsDirPath, fileName);
     }
+    getResponseSchema(ctx, endpoint) {
+        var _a, _b, _c;
+        const successResponse = (_a = endpoint.responses.find((x) => x.statusCode === 200)) !== null && _a !== void 0 ? _a : endpoint.responses.find((x) => x.statusCode && x.statusCode > 200 && x.statusCode < 300);
+        return (_c = (_b = successResponse === null || successResponse === void 0 ? void 0 : successResponse.contentOptions) === null || _b === void 0 ? void 0 : _b.find((x) => x.schema !== undefined)) === null || _c === void 0 ? void 0 : _c.schema;
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@goast/typescript",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "repository": "https://github.com/MaSch0212/goast.git",
   "author": {
     "name": "Marc Schmidt (MaSch0212)",

package/types/lib/generators/services/fetch-clients/fetch-client-generator.d.ts

@@ -30,7 +30,7 @@ export declare class DefaultTypeScriptFetchClientGenerator extends TypeScriptFil
     protected generateServiceMethodReturnValue(ctx: Context, builder: Builder, endpoint: ApiEndpoint): void;
     protected generateTypedResponse(ctx: Context, builder: Builder, schema: ApiSchema | undefined): void;
     protected generateServiceMethodContent(ctx: Context, builder: Builder, endpoint: ApiEndpoint): void;
-    protected getTypeName(ctx: Context, builder: Builder, schemaId: string | undefined): string;
+    protected getTypeName(ctx: Context, builder: Builder, schemaId: string | undefined, fallback?: string): string;
     protected shouldGenerateInterface(ctx: Context): boolean;
     protected shouldGenerateClass(ctx: Context): boolean;
     protected getInterfaceName(ctx: Context): string;
@@ -39,5 +39,6 @@ export declare class DefaultTypeScriptFetchClientGenerator extends TypeScriptFil
     protected getInterfaceFilePath(ctx: Context): string;
     protected getClassFilePath(ctx: Context): string;
     protected getUtilPath(ctx: Context, fileName: string): string;
+    private getResponseSchema;
 }
 export {};