@goast/typescript 0.2.15 → 0.2.17

package/assets/client/angular/angular-service.utils.ts

@@ -1,7 +1,7 @@
 import { HttpErrorResponse, HttpEvent, HttpResponse } from '@angular/common/http';
 import { Observable, Subscription, filter, take, map, catchError, EMPTY } from 'rxjs';
 
-export type AbortablePromise<T> = {
+export type AbortablePromise<T> = Omit<Promise<T>, 'then' | 'catch' | 'finally'> & {
   abort(): void;
   then<TResult1 = T, TResult2 = never>(
     onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | undefined | null,

package/cjs/lib/ast/nodes/type-alias.js

@@ -16,6 +16,8 @@ class TsTypeAlias extends node_1.TsNode {
         this.export = (_d = options.export) !== null && _d !== void 0 ? _d : false;
     }
     onWrite(builder) {
+        if (this.doc)
+            (0, write_ts_nodes_1.writeTsNode)(builder, this.doc);
         if (this.export)
             builder.append('export ');
         builder.append('type ');

package/cjs/lib/generators/models/model-generator.js

@@ -51,6 +51,10 @@ class DefaultTypeScriptModelGenerator extends file_generator_1.TypeScriptFileGen
     getEnum(ctx) {
         var _a, _b;
         return ast_1.ts.enum(this.getDeclarationTypeName(ctx, ctx.schema), {
+            doc: ast_1.ts.doc({
+                description: ctx.schema.description,
+                tags: [ctx.schema.deprecated ? ast_1.ts.docTag('deprecated') : null],
+            }),
             export: true,
             members: ((_b = (_a = ctx.schema.enum) === null || _a === void 0 ? void 0 : _a.map((x) => String(x))) !== null && _b !== void 0 ? _b : []).map((x) => ast_1.ts.enumValue((0, core_1.toCasing)(x, ctx.config.enumValueNameCasing), { value: ast_1.ts.string(x) })),
         });
@@ -58,7 +62,10 @@ class DefaultTypeScriptModelGenerator extends file_generator_1.TypeScriptFileGen
     getInterface(ctx, schema) {
         return ast_1.ts.interface(this.getDeclarationTypeName(ctx, ctx.schema), {
             export: true,
-            doc: ast_1.ts.doc({ description: schema.description }),
+            doc: ast_1.ts.doc({
+                description: schema.description,
+                tags: [ctx.schema.deprecated ? ast_1.ts.docTag('deprecated') : null],
+            }),
             members: [...this.getProperties(ctx, schema), this.getIndexer(ctx, schema)],
         });
     }
@@ -67,7 +74,10 @@ class DefaultTypeScriptModelGenerator extends file_generator_1.TypeScriptFileGen
         const hasDiscriminator = schema.discriminator && Object.keys(schema.discriminator.mapping).length > 0;
         const result = ast_1.ts.typeAlias(this.getDeclarationTypeName(ctx, schema), (_a = (hasDiscriminator ? this.getDiscriminatorType(ctx, schema) : this.getType(ctx, schema, { skipSchemas: true }))) !== null && _a !== void 0 ? _a : this.getAnyType(ctx), {
             export: true,
-            doc: ast_1.ts.doc({ description: schema.description }),
+            doc: ast_1.ts.doc({
+                description: schema.description,
+                tags: [ctx.schema.deprecated ? ast_1.ts.docTag('deprecated') : null],
+            }),
         });
         if (hasDiscriminator) {
             const propertyValue = this.getDiscriminatorTypeName(ctx, ctx.schema);
@@ -108,7 +118,10 @@ class DefaultTypeScriptModelGenerator extends file_generator_1.TypeScriptFileGen
     getProperties(ctx, schema) {
         return Array.from(schema.properties.values()).map((property) => {
             return ast_1.ts.property(property.name, {
-                doc: ast_1.ts.doc({ description: property.schema.description }),
+                doc: ast_1.ts.doc({
+                    description: property.schema.description,
+                    tags: [property.schema.deprecated ? ast_1.ts.docTag('deprecated') : null],
+                }),
                 readonly: ctx.config.immutableTypes,
                 optional: !schema.required.has(property.name),
                 type: ast_1.ts.unionType([this.getType(ctx, property.schema), property.schema.nullable ? 'null' : null]),

package/cjs/lib/generators/services/angular-services/angular-service-generator.js

@@ -78,6 +78,10 @@ class DefaultTypeScriptAngularServiceGenerator extends file_generator_1.TypeScri
             ]),
             ast_1.ts.objectType({ members: [ast_1.ts.property('status', { type: 'TStatus' })] }),
         ]), {
+            doc: ast_1.ts.doc({
+                description: `Response model for operation ${this.getEndpointMethodName(ctx, endpoint)}`,
+                tags: [endpoint.deprecated ? ast_1.ts.docTag('deprecated') : null],
+            }),
             export: true,
             generics: [
                 ast_1.ts.genericParameter('TStatus', {
@@ -132,7 +136,10 @@ class DefaultTypeScriptAngularServiceGenerator extends file_generator_1.TypeScri
         for (const parameter of endpoint.parameters) {
             const schema = parameter.schema;
             type.members.push(ast_1.ts.property((0, core_1.toCasing)(parameter.name, ctx.config.propertyNameCasing), {
-                doc: ast_1.ts.doc({ description: parameter.description }),
+                doc: ast_1.ts.doc({
+                    description: parameter.description,
+                    tags: [parameter.deprecated ? ast_1.ts.docTag('deprecated') : null],
+                }),
                 type: schema ? (b) => b.appendModelUsage(ctx.input.models[schema.id]) : this.getAnyType(ctx),
                 optional: !parameter.required,
             }));
@@ -152,7 +159,14 @@ class DefaultTypeScriptAngularServiceGenerator extends file_generator_1.TypeScri
     }
     getClass(ctx) {
         return ast_1.ts.class(this.getServiceClassName(ctx), {
-            doc: ast_1.ts.doc({ description: ctx.service.description }),
+            doc: ast_1.ts.doc({
+                description: ctx.service.description,
+                tags: [
+                    ctx.service.endpoints.length === 0 || ctx.service.endpoints.some((x) => !x.deprecated)
+                        ? null
+                        : ast_1.ts.docTag('deprecated'),
+                ],
+            }),
             decorators: [
                 ast_1.ts.decorator(ast_1.ts.refs.angular.injectable(), ctx.config.provideKind === 'root' ? [ast_1.ts.toNode({ providedIn: 'root' })] : []),
             ],
@@ -188,6 +202,10 @@ class DefaultTypeScriptAngularServiceGenerator extends file_generator_1.TypeScri
                     : null,
                 ast_1.ts.parameter('context', { optional: true, type: ast_1.ts.refs.angular.httpContext() }),
             ],
+            doc: ast_1.ts.doc({
+                description: endpoint.description,
+                tags: [endpoint.deprecated ? ast_1.ts.docTag('deprecated') : null],
+            }),
             returnType,
             body: (0, core_1.appendValueGroup)([
                 (0, core_1.builderTemplate) `const rb = new ${ctx.refs.requestBuilder()}(this.rootUrl, ${this.getServiceClassName(ctx)}.${this.getEndpointPathPropertyName(ctx, endpoint)}, '${endpoint.method}');`,

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

@@ -39,7 +39,14 @@ class DefaultTypeScriptFetchClientGenerator extends file_generator_1.TypeScriptF
     }
     getInterface(ctx) {
         return ast_1.ts.interface(this.getInterfaceName(ctx), {
-            doc: ast_1.ts.doc({ description: ctx.service.description }),
+            doc: ast_1.ts.doc({
+                description: ctx.service.description,
+                tags: [
+                    ctx.service.endpoints.length === 0 || ctx.service.endpoints.some((x) => !x.deprecated)
+                        ? null
+                        : ast_1.ts.docTag('deprecated'),
+                ],
+            }),
             export: true,
             members: ctx.service.endpoints.map((endpoint) => this.getInterfaceEndpointMethod(ctx, endpoint)),
         });
@@ -50,13 +57,14 @@ class DefaultTypeScriptFetchClientGenerator extends file_generator_1.TypeScriptF
         const bodySchema = (_b = (_a = endpoint.requestBody) === null || _a === void 0 ? void 0 : _a.content[0]) === null || _b === void 0 ? void 0 : _b.schema;
         const responseSchema = this.getResponseSchema(ctx, endpoint);
         return ast_1.ts.method((0, core_1.toCasing)(endpoint.name, ctx.config.methodCasing), {
-            doc: ast_1.ts.doc({ description: endpoint.description }),
+            doc: ast_1.ts.doc({ description: endpoint.description, tags: [endpoint.deprecated ? ast_1.ts.docTag('deprecated') : null] }),
             parameters: [
                 params.length > 0
                     ? ast_1.ts.parameter('params', {
                         description: 'Parameters for the endpoint.',
                         type: ast_1.ts.objectType({
                             members: params.map((x) => ast_1.ts.property((0, core_1.toCasing)(x.name, ctx.config.propertyNameCasing), {
+                                doc: ast_1.ts.doc({ tags: [x.deprecated ? ast_1.ts.docTag('deprecated') : null] }),
                                 type: this.getSchemaType(ctx, x.schema),
                                 optional: !x.required,
                             })),
@@ -92,7 +100,14 @@ class DefaultTypeScriptFetchClientGenerator extends file_generator_1.TypeScriptF
     }
     getClass(ctx) {
         return ast_1.ts.class(this.getClassName(ctx), {
-            doc: ast_1.ts.doc({ description: ctx.service.description }),
+            doc: ast_1.ts.doc({
+                description: ctx.service.description,
+                tags: [
+                    ctx.service.endpoints.length === 0 || ctx.service.endpoints.some((x) => !x.deprecated)
+                        ? null
+                        : ast_1.ts.docTag('deprecated'),
+                ],
+            }),
             export: true,
             implements: this.shouldGenerateInterface(ctx)
                 ? [ast_1.ts.reference(this.getInterfaceName(ctx), this.getInterfaceFilePath(ctx))]

package/esm/lib/ast/nodes/type-alias.js

@@ -13,6 +13,8 @@ export class TsTypeAlias extends TsNode {
         this.export = (_d = options.export) !== null && _d !== void 0 ? _d : false;
     }
     onWrite(builder) {
+        if (this.doc)
+            writeTsNode(builder, this.doc);
         if (this.export)
             builder.append('export ');
         builder.append('type ');

package/esm/lib/generators/models/model-generator.js

@@ -48,6 +48,10 @@ export class DefaultTypeScriptModelGenerator extends TypeScriptFileGenerator {
     getEnum(ctx) {
         var _a, _b;
         return ts.enum(this.getDeclarationTypeName(ctx, ctx.schema), {
+            doc: ts.doc({
+                description: ctx.schema.description,
+                tags: [ctx.schema.deprecated ? ts.docTag('deprecated') : null],
+            }),
             export: true,
             members: ((_b = (_a = ctx.schema.enum) === null || _a === void 0 ? void 0 : _a.map((x) => String(x))) !== null && _b !== void 0 ? _b : []).map((x) => ts.enumValue(toCasing(x, ctx.config.enumValueNameCasing), { value: ts.string(x) })),
         });
@@ -55,7 +59,10 @@ export class DefaultTypeScriptModelGenerator extends TypeScriptFileGenerator {
     getInterface(ctx, schema) {
         return ts.interface(this.getDeclarationTypeName(ctx, ctx.schema), {
             export: true,
-            doc: ts.doc({ description: schema.description }),
+            doc: ts.doc({
+                description: schema.description,
+                tags: [ctx.schema.deprecated ? ts.docTag('deprecated') : null],
+            }),
             members: [...this.getProperties(ctx, schema), this.getIndexer(ctx, schema)],
         });
     }
@@ -64,7 +71,10 @@ export class DefaultTypeScriptModelGenerator extends TypeScriptFileGenerator {
         const hasDiscriminator = schema.discriminator && Object.keys(schema.discriminator.mapping).length > 0;
         const result = ts.typeAlias(this.getDeclarationTypeName(ctx, schema), (_a = (hasDiscriminator ? this.getDiscriminatorType(ctx, schema) : this.getType(ctx, schema, { skipSchemas: true }))) !== null && _a !== void 0 ? _a : this.getAnyType(ctx), {
             export: true,
-            doc: ts.doc({ description: schema.description }),
+            doc: ts.doc({
+                description: schema.description,
+                tags: [ctx.schema.deprecated ? ts.docTag('deprecated') : null],
+            }),
         });
         if (hasDiscriminator) {
             const propertyValue = this.getDiscriminatorTypeName(ctx, ctx.schema);
@@ -105,7 +115,10 @@ export class DefaultTypeScriptModelGenerator extends TypeScriptFileGenerator {
     getProperties(ctx, schema) {
         return Array.from(schema.properties.values()).map((property) => {
             return ts.property(property.name, {
-                doc: ts.doc({ description: property.schema.description }),
+                doc: ts.doc({
+                    description: property.schema.description,
+                    tags: [property.schema.deprecated ? ts.docTag('deprecated') : null],
+                }),
                 readonly: ctx.config.immutableTypes,
                 optional: !schema.required.has(property.name),
                 type: ts.unionType([this.getType(ctx, property.schema), property.schema.nullable ? 'null' : null]),

package/esm/lib/generators/services/angular-services/angular-service-generator.js

@@ -75,6 +75,10 @@ export class DefaultTypeScriptAngularServiceGenerator extends TypeScriptFileGene
             ]),
             ts.objectType({ members: [ts.property('status', { type: 'TStatus' })] }),
         ]), {
+            doc: ts.doc({
+                description: `Response model for operation ${this.getEndpointMethodName(ctx, endpoint)}`,
+                tags: [endpoint.deprecated ? ts.docTag('deprecated') : null],
+            }),
             export: true,
             generics: [
                 ts.genericParameter('TStatus', {
@@ -129,7 +133,10 @@ export class DefaultTypeScriptAngularServiceGenerator extends TypeScriptFileGene
         for (const parameter of endpoint.parameters) {
             const schema = parameter.schema;
             type.members.push(ts.property(toCasing(parameter.name, ctx.config.propertyNameCasing), {
-                doc: ts.doc({ description: parameter.description }),
+                doc: ts.doc({
+                    description: parameter.description,
+                    tags: [parameter.deprecated ? ts.docTag('deprecated') : null],
+                }),
                 type: schema ? (b) => b.appendModelUsage(ctx.input.models[schema.id]) : this.getAnyType(ctx),
                 optional: !parameter.required,
             }));
@@ -149,7 +156,14 @@ export class DefaultTypeScriptAngularServiceGenerator extends TypeScriptFileGene
     }
     getClass(ctx) {
         return ts.class(this.getServiceClassName(ctx), {
-            doc: ts.doc({ description: ctx.service.description }),
+            doc: ts.doc({
+                description: ctx.service.description,
+                tags: [
+                    ctx.service.endpoints.length === 0 || ctx.service.endpoints.some((x) => !x.deprecated)
+                        ? null
+                        : ts.docTag('deprecated'),
+                ],
+            }),
             decorators: [
                 ts.decorator(ts.refs.angular.injectable(), ctx.config.provideKind === 'root' ? [ts.toNode({ providedIn: 'root' })] : []),
             ],
@@ -185,6 +199,10 @@ export class DefaultTypeScriptAngularServiceGenerator extends TypeScriptFileGene
                     : null,
                 ts.parameter('context', { optional: true, type: ts.refs.angular.httpContext() }),
             ],
+            doc: ts.doc({
+                description: endpoint.description,
+                tags: [endpoint.deprecated ? ts.docTag('deprecated') : null],
+            }),
             returnType,
             body: appendValueGroup([
                 s `const rb = new ${ctx.refs.requestBuilder()}(this.rootUrl, ${this.getServiceClassName(ctx)}.${this.getEndpointPathPropertyName(ctx, endpoint)}, '${endpoint.method}');`,

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

@@ -36,7 +36,14 @@ export class DefaultTypeScriptFetchClientGenerator extends TypeScriptFileGenerat
     }
     getInterface(ctx) {
         return ts.interface(this.getInterfaceName(ctx), {
-            doc: ts.doc({ description: ctx.service.description }),
+            doc: ts.doc({
+                description: ctx.service.description,
+                tags: [
+                    ctx.service.endpoints.length === 0 || ctx.service.endpoints.some((x) => !x.deprecated)
+                        ? null
+                        : ts.docTag('deprecated'),
+                ],
+            }),
             export: true,
             members: ctx.service.endpoints.map((endpoint) => this.getInterfaceEndpointMethod(ctx, endpoint)),
         });
@@ -47,13 +54,14 @@ export class DefaultTypeScriptFetchClientGenerator extends TypeScriptFileGenerat
         const bodySchema = (_b = (_a = endpoint.requestBody) === null || _a === void 0 ? void 0 : _a.content[0]) === null || _b === void 0 ? void 0 : _b.schema;
         const responseSchema = this.getResponseSchema(ctx, endpoint);
         return ts.method(toCasing(endpoint.name, ctx.config.methodCasing), {
-            doc: ts.doc({ description: endpoint.description }),
+            doc: ts.doc({ description: endpoint.description, tags: [endpoint.deprecated ? ts.docTag('deprecated') : null] }),
             parameters: [
                 params.length > 0
                     ? ts.parameter('params', {
                         description: 'Parameters for the endpoint.',
                         type: ts.objectType({
                             members: params.map((x) => ts.property(toCasing(x.name, ctx.config.propertyNameCasing), {
+                                doc: ts.doc({ tags: [x.deprecated ? ts.docTag('deprecated') : null] }),
                                 type: this.getSchemaType(ctx, x.schema),
                                 optional: !x.required,
                             })),
@@ -89,7 +97,14 @@ export class DefaultTypeScriptFetchClientGenerator extends TypeScriptFileGenerat
     }
     getClass(ctx) {
         return ts.class(this.getClassName(ctx), {
-            doc: ts.doc({ description: ctx.service.description }),
+            doc: ts.doc({
+                description: ctx.service.description,
+                tags: [
+                    ctx.service.endpoints.length === 0 || ctx.service.endpoints.some((x) => !x.deprecated)
+                        ? null
+                        : ts.docTag('deprecated'),
+                ],
+            }),
             export: true,
             implements: this.shouldGenerateInterface(ctx)
                 ? [ts.reference(this.getInterfaceName(ctx), this.getInterfaceFilePath(ctx))]

package/package.json

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