@goast/typescript 0.5.3 → 0.6.0-beta.1

package/src/src/generators/services/angular-services/models.ts

@@ -1,277 +0,0 @@
-import type {
-  ApiEndpoint,
-  ApiSchema,
-  ApiService,
-  DefaultGenerationProviderConfig,
-  ExtendedStringCasing,
-  Nullable,
-  OpenApiServicesGenerationProviderContext,
-} from '@goast/core';
-
-import type { ts } from '../../../ast/index.js';
-import type { TypeScriptExportOutput } from '../../../common-results.js';
-import { defaultTypeScriptGeneratorConfig, type TypeScriptGeneratorConfig } from '../../../config.js';
-import type { TypeScriptFileBuilder } from '../../../file-builder.js';
-import type { TypeScriptModelGeneratorOutput } from '../../models/index.js';
-import type { getReferenceFactories } from './refs.js';
-
-export type TypeScriptAngularServicesGeneratorConfig = TypeScriptGeneratorConfig & {
-  /**
-   * How the services should be provided in the Angular application.
-   * - `root` - provides all the services using `Injectable({ providedIn: 'root' })`
-   * - `provide-fn` - generates a function `provideApiClients` that provides the services
-   * @default 'root'
-   */
-  provideKind: 'root' | 'provide-fn';
-
-  /**
-   * The domain name of the API. Used as a prefix for exported components (e.g. `ApiConfiguration`).
-   * @default undefined
-   */
-  domainName: Nullable<string>;
-
-  /**
-   * Whether to use strict response types for the services.
-   * If enabled only the status codes are included that are defined in the OpenAPI specification or the `defaultStatusCodeResponseTypes` option.
-   * @default true
-   */
-  strictResponseTypes: boolean;
-
-  /**
-   * The default response types for status codes that are not defined in the OpenAPI specification.
-   * @example
-   * {
-   *   400: {
-   *     parser: 'json',
-   *     type: schemas =>
-   *       schemas.find(s => s.name === 'BadRequestResponse')
-   *         ?? throwExp('BadRequestResponse not found'),
-   *   },
-   *   404: null,
-   *   500: {
-   *     parser: 'json',
-   *     type: ts.refs.any(),
-   *   },
-   * }
-   * @default
-   * {
-   *   401: null,
-   *   403: null,
-   *   500: null,
-   * }
-   */
-  defaultStatusCodeResponseTypes: Record<
-    number,
-    {
-      parser: 'text' | 'json';
-      // deno-lint-ignore ban-types
-      type: Exclude<ts.Type<TypeScriptFileBuilder>, Function> | ((schemas: readonly ApiSchema[]) => ApiSchema);
-    } | null
-  >;
-
-  /**
-   * The default content type which is used for the request. If not defined the first one defined in the OpenApi specification is used.
-   * @default undefined
-   */
-  defaultRequestContentType: Nullable<string>;
-
-  /**
-   * The default content type which is used for the success response. If not defined the first one defined in the OpenApi specification is used.
-   * @default undefined
-   */
-  defaultSuccessResponseContentType: Nullable<string>;
-
-  /**
-   * The possible status codes that any API endpoint can return.
-   * This is only used when `strictResponseTypes` is set to `false`.
-   * @default
-   * [100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 303, 304, 305, 306, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 421, 422, 423, 424, 425, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, 511]
-   */
-  possibleStatusCodes: number[];
-
-  /**
-   * Explicitly set the root URL of the API. If `undefined`, the root URL is taken from the first `server` in the OpenAPI specification.
-   * @default undefined
-   */
-  rootUrl: Nullable<string | RegExp | ((rootUrl: string) => string)>;
-
-  /**
-   * Modifier that is applied to the path of each endpoint.
-   * @default undefined
-   */
-  pathModifier: Nullable<RegExp | ((path: string, endpoint: ApiEndpoint) => string)>;
-
-  /**
-   * The directory where the services should be saved. The path is relative to the output directory.
-   * @default 'services'
-   */
-  servicesDir: string;
-
-  /**
-   * The casing of the file names for the services. If nullish, the `fileNameCasing` is used.
-   * @default { casing: 'kebab', suffix: '.service' }
-   */
-  serviceFileNameCasing: Nullable<ExtendedStringCasing>;
-
-  /**
-   * The path to the index file where all services should be exported. The path is relative to the output directory. If nullish, no index file will be generated.
-   * @default 'services.ts'
-   */
-  servicesIndexFile: Nullable<string>;
-
-  /**
-   * The directory where the response models should be saved. The path is relative to the output directory.
-   * @default 'models/responses'
-   */
-  responseModelsDir: string;
-
-  /**
-   * The casing of the file names for the response models. If nullish, the `fileNameCasing` is used.
-   * @default { casing: 'kebab', suffix: '-responses.model' }
-   */
-  responseModelFileNameCasing: Nullable<ExtendedStringCasing>;
-
-  /**
-   * The path to the index file where all response models should be exported. The path is relative to the output directory. If nullish, no index file will be generated.
-   * @default 'responses.ts'
-   */
-  responseModelsIndexFile: Nullable<string>;
-
-  /**
-   * The directory where the utilies should be saved. The path is relative to the output directory.
-   * @default 'utils'
-   */
-  utilsDir: string;
-};
-
-export const defaultTypeScriptAngularServicesGeneratorConfig: DefaultGenerationProviderConfig<
-  TypeScriptAngularServicesGeneratorConfig
-> = {
-  ...defaultTypeScriptGeneratorConfig,
-
-  provideKind: 'provide-fn',
-  domainName: undefined,
-  strictResponseTypes: true,
-  defaultStatusCodeResponseTypes: {
-    401: null,
-    403: null,
-    500: null,
-  },
-  defaultRequestContentType: undefined,
-  defaultSuccessResponseContentType: undefined,
-  possibleStatusCodes: [
-    100,
-    101,
-    102,
-    103,
-    200,
-    201,
-    202,
-    203,
-    204,
-    205,
-    206,
-    207,
-    208,
-    226,
-    300,
-    301,
-    302,
-    303,
-    304,
-    305,
-    306,
-    307,
-    308,
-    400,
-    401,
-    402,
-    403,
-    404,
-    405,
-    406,
-    407,
-    408,
-    409,
-    410,
-    411,
-    412,
-    413,
-    414,
-    415,
-    416,
-    417,
-    421,
-    422,
-    423,
-    424,
-    425,
-    426,
-    428,
-    429,
-    431,
-    451,
-    500,
-    501,
-    502,
-    503,
-    504,
-    505,
-    506,
-    507,
-    508,
-    510,
-    511,
-  ],
-  rootUrl: undefined,
-  pathModifier: undefined,
-
-  servicesDir: 'services',
-  serviceFileNameCasing: { casing: 'kebab', suffix: '.service' },
-  servicesIndexFile: 'services.ts',
-  responseModelsDir: 'models/responses',
-  responseModelFileNameCasing: { casing: 'kebab', suffix: '-responses.model' },
-  responseModelsIndexFile: 'responses.ts',
-  utilsDir: 'utils',
-};
-
-export type TypeScriptAngularServicesGeneratorInput = {
-  typescript: {
-    models: {
-      [schemaId: string]: TypeScriptModelGeneratorOutput;
-    };
-  };
-};
-
-export type TypeScriptAngularServicesGeneratorOutput = {
-  typescript: {
-    services: {
-      [serviceId: string]: TypeScriptAngularServiceGeneratorOutput;
-    };
-    indexFiles: {
-      services: Nullable<string>;
-      responseModels: Nullable<string>;
-    };
-  };
-};
-
-export type TypeScriptAngularServiceGeneratorOutput = TypeScriptExportOutput & {
-  responseModels: {
-    [operationId: string]: TypeScriptExportOutput;
-  };
-};
-
-export type TypeScriptAngularServicesGeneratorContext =
-  & OpenApiServicesGenerationProviderContext<
-    TypeScriptAngularServicesGeneratorInput,
-    TypeScriptAngularServicesGeneratorOutput,
-    TypeScriptAngularServicesGeneratorConfig,
-    TypeScriptAngularServiceGeneratorOutput
-  >
-  & {
-    refs: ReturnType<typeof getReferenceFactories>;
-  };
-
-export type TypeScriptAngularServiceGeneratorContext = TypeScriptAngularServicesGeneratorContext & {
-  readonly service: ApiService;
-};

package/src/src/generators/services/angular-services/refs.ts

@@ -1,54 +0,0 @@
-import { join, resolve } from 'node:path';
-
-import { toCasing } from '@goast/core';
-
-import { ts } from '../../../ast/index.js';
-
-import type { TypeScriptAngularServicesGeneratorConfig } from './models.js';
-
-// See packages/typescript/assets/client/angular for reference
-export function getReferenceFactories(options: TypeScriptAngularServicesGeneratorConfig): {
-  abortablePromise: ts.GenericModuleReferenceFactory<1>;
-  waitForResponse: ts.GenericModuleReferenceFactory<1>;
-  requestBuilder: ts.ModuleReferenceFactory;
-  apiConfiguration: ts.ModuleReferenceFactory;
-  apiBaseService: ts.ModuleReferenceFactory;
-  httpStatusCode: ts.ModuleReferenceFactory;
-  provide: ts.ModuleReferenceFactory;
-} {
-  const utilsDirPath = resolve(options.outputDir, options.utilsDir);
-  return {
-    // angular-service.utils.ts
-    abortablePromise: ts.reference.genericFactory<1>(
-      'AbortablePromise',
-      join(utilsDirPath, 'angular-service.utils.ts'),
-      {
-        importType: 'type-import',
-      },
-    ),
-    waitForResponse: ts.reference.genericFactory<1>('waitForResponse', join(utilsDirPath, 'angular-service.utils.ts')),
-
-    // request-builder.ts
-    requestBuilder: ts.reference.factory('RequestBuilder', join(utilsDirPath, 'request-builder.ts')),
-
-    // api-configuration.ts - generated in angular-services-generator.ts
-    apiConfiguration: ts.reference.factory(
-      toCasing(`${options.domainName ?? ''}ApiConfiguration`, options.typeNameCasing),
-      join(utilsDirPath, 'api-configuration.ts'),
-    ),
-
-    // api-base-service.ts - generated in angular-service-generator.ts
-    apiBaseService: ts.reference.factory('ApiBaseService', join(utilsDirPath, 'api-base-service.ts')),
-
-    // http-status-code.ts - generated in angular-services-generator.ts
-    httpStatusCode: ts.reference.factory('HttpStatusCode', join(utilsDirPath, 'http-status-code.ts'), {
-      importType: 'type-import',
-    }),
-
-    // provide.ts - generated in angular-services-generator.ts
-    provide: ts.reference.factory(
-      toCasing(`provide_${options.domainName ?? ''}_Api`, options.functionNameCasing),
-      join(utilsDirPath, 'provide.ts'),
-    ),
-  };
-}

package/src/src/generators/services/easy-network-stub/easy-network-stub-generator.ts

@@ -1,242 +0,0 @@
-import { resolve } from 'node:path';
-
-import {
-  adjustCasing,
-  type ApiEndpoint,
-  type ApiSchema,
-  type AppendValueGroup,
-  appendValueGroup,
-  builderTemplate as s,
-  type MaybePromise,
-  toCasing,
-} from '@goast/core';
-
-import { ts } from '../../../ast/index.js';
-import { TypeScriptFileBuilder } from '../../../file-builder.js';
-import { TypeScriptFileGenerator } from '../../file-generator.js';
-import type { TypeScriptEasyNetworkStubGeneratorContext, TypeScriptEasyNetworkStubGeneratorOutput } from './models.js';
-
-type Context = TypeScriptEasyNetworkStubGeneratorContext;
-type Output = TypeScriptEasyNetworkStubGeneratorOutput;
-type Builder = TypeScriptFileBuilder;
-
-export interface TypeScriptEasyNetworkStubGenerator<TOutput extends Output = Output> {
-  generate(ctx: Context): MaybePromise<TOutput>;
-}
-
-export class DefaultTypeScriptEasyNetworkStubGenerator extends TypeScriptFileGenerator<Context, Output>
-  implements TypeScriptEasyNetworkStubGenerator {
-  public generate(ctx: Context): MaybePromise<Output> {
-    const filePath = this.getStubFilePath(ctx);
-    const name = this.getStubClassName(ctx);
-
-    TypeScriptFileBuilder.generate({
-      logName: `stub ${name}`,
-      filePath,
-      options: ctx.config,
-      generator: (b) => b.append(this.getStubFileContent(ctx)),
-    });
-
-    return {
-      filePath,
-      component: name,
-    };
-  }
-
-  protected getStubFileContent(ctx: Context): AppendValueGroup<Builder> {
-    return appendValueGroup(
-      [...ctx.service.endpoints.map((endpoint) => this.getResponderVariable(ctx, endpoint)), this.getStubClass(ctx)],
-      '\n',
-    );
-  }
-
-  protected getResponderVariable(ctx: Context, endpoint: ApiEndpoint): ts.Variable<Builder> {
-    return ts.variable(this.getResponderVariableName(ctx, endpoint), {
-      readonly: true,
-      value: ts.call(
-        ctx.refs.getStubResponder([
-          ts.objectType({
-            members: Object.entries(this.getEndpointStatusCodes(ctx, endpoint)).map(([statusCode, type]) =>
-              ts.property<Builder>(statusCode, { type })
-            ),
-          }),
-        ]),
-        [],
-      ),
-    });
-  }
-
-  protected getStubClass(ctx: Context): ts.Class<Builder> {
-    return ts.class(this.getStubClassName(ctx), {
-      export: true,
-      extends: ctx.refs.easyNetworkStubBase(),
-      members: [
-        ...ctx.service.endpoints.map((endpoint) =>
-          ts.property<Builder>(this.getEndpointPathPropertyName(ctx, endpoint), {
-            static: true,
-            readonly: true,
-            accessModifier: 'private',
-            value: s`${ts.string(this.getStubRoute(ctx, endpoint))} as const`,
-          })
-        ),
-        '\n',
-        ...ctx.service.endpoints.map((endpoint) =>
-          ts.property<Builder>(this.getEndpointRequestsFieldName(ctx, endpoint), {
-            readonly: true,
-            accessModifier: 'private',
-            type: this.getEndpointRequestsType(ctx, endpoint),
-            value: ts.tuple([]),
-          })
-        ),
-        '\n',
-        ...ctx.service.endpoints.map((endpoint) =>
-          ts.property<Builder>(this.getEndpointRequestsPropertyName(ctx, endpoint), {
-            readonly: true,
-            accessModifier: 'public',
-            type: this.getEndpointRequestsType(ctx, endpoint, { readonly: true }),
-            get: ts.property.getter({
-              body: appendValueGroup([`return this.${this.getEndpointRequestsFieldName(ctx, endpoint)};`], '\n'),
-            }),
-          })
-        ),
-        ...ctx.service.endpoints.map((endpoint) => this.getEndpointStubMethod(ctx, endpoint)),
-        ts.method('reset', {
-          accessModifier: 'public',
-          override: true,
-          returnType: ts.refs.void_(),
-          body: appendValueGroup(
-            [
-              ...ctx.service.endpoints.map((endpoint) =>
-                `this.${this.getEndpointRequestsFieldName(ctx, endpoint)}.length = 0;`
-              ),
-              'super.reset();',
-            ],
-            '\n',
-          ),
-        }),
-      ],
-    });
-  }
-
-  protected getEndpointRequestsType(
-    ctx: Context,
-    endpoint: ApiEndpoint,
-    options?: { readonly?: boolean },
-  ): ts.Type<Builder> {
-    return ts.arrayType(
-      ctx.refs.stubRequestInfo([
-        ts.typeof(ts.call([this.getStubClassName(ctx), this.getEndpointPathPropertyName(ctx, endpoint)])),
-        this.getSchemaType(ctx, endpoint.requestBody?.content[0].schema),
-      ]),
-      options,
-    );
-  }
-
-  protected getEndpointStubMethod(ctx: Context, endpoint: ApiEndpoint): ts.Method<Builder> {
-    const requestType = this.getSchemaType(ctx, endpoint.requestBody?.content[0].schema);
-    return ts.method(this.getEndpointStubMethodName(ctx, endpoint), {
-      accessModifier: 'public',
-      parameters: [
-        ts.parameter('response', {
-          type: ctx.refs.strictRouteResponseCallback([
-            requestType,
-            ts.typeof(ts.call([this.getStubClassName(ctx), this.getEndpointPathPropertyName(ctx, endpoint)])),
-            ts.typeof(this.getResponderVariableName(ctx, endpoint)),
-          ]),
-        }),
-      ],
-      returnType: 'this',
-      body: appendValueGroup(
-        [
-          s`this.stubWrapper.stub2<${requestType}>()(${s.indent`
-              ${ts.string(endpoint.method.toUpperCase())},
-              ${this.getStubClassName(ctx)}.${this.getEndpointPathPropertyName(ctx, endpoint)},
-              async (request) => {${s.indent`
-                if (this.stubWrapper.options.rememberRequests) {${s.indent`
-                  this.${this.getEndpointRequestsFieldName(ctx, endpoint)}.push(request);`}
-                }
-                throw await response(${this.getResponderVariableName(ctx, endpoint)}, request);`}
-              }`}
-            );`,
-          'return this;',
-        ],
-        '\n',
-      ),
-    });
-  }
-
-  protected getStubFilePath(ctx: Context): string {
-    return resolve(
-      ctx.config.outputDir,
-      ctx.config.stubsDir,
-      `${toCasing(ctx.service.name, ctx.config.stubFileNameCasing ?? ctx.config.fileNameCasing)}.ts`,
-    );
-  }
-
-  protected getResponderVariableName(ctx: Context, endpoint: ApiEndpoint): string {
-    return toCasing(endpoint.name + '_Responder', ctx.config.propertyNameCasing);
-  }
-
-  protected getStubClassName(ctx: Context): string {
-    return toCasing(ctx.service.name + '_Stubs', ctx.config.typeNameCasing);
-  }
-
-  protected getEndpointPathPropertyName(ctx: Context, endpoint: ApiEndpoint): string {
-    return toCasing(endpoint.name + '_Path', ctx.config.constantNameCasing);
-  }
-
-  protected getEndpointRequestsFieldName(ctx: Context, endpoint: ApiEndpoint): string {
-    return toCasing(endpoint.name + '_Requests', adjustCasing(ctx.config.propertyNameCasing, { prefix: '_' }));
-  }
-
-  protected getEndpointRequestsPropertyName(ctx: Context, endpoint: ApiEndpoint): string {
-    return toCasing(endpoint.name + '_Requests', ctx.config.propertyNameCasing);
-  }
-
-  protected getEndpointStubMethodName(ctx: Context, endpoint: ApiEndpoint): string {
-    return toCasing('stub_' + endpoint.name, ctx.config.functionNameCasing);
-  }
-
-  protected getStubRoute(ctx: Context, endpoint: ApiEndpoint): string {
-    let path = endpoint.path;
-    let isFirstQueryParam = true;
-    for (const param of endpoint.parameters) {
-      let type = ((param.schema && ctx.input.typescript.models[param.schema.id]?.component) ?? ts.refs.unknown.name)
-        .replace(
-          /^readonly /,
-          '',
-        );
-
-      const arrayMatch = /^\((.*)\)\[\]$/.exec(type);
-      if (arrayMatch !== null) {
-        type = `${arrayMatch[1]}[]`;
-      }
-
-      if (param.target === 'path') {
-        path = path.replace(`{${param.name}}`, `{${param.name}${param.required ? '' : '?'}:${type}}`);
-      } else if (param.target === 'query') {
-        path = path + (isFirstQueryParam ? '?' : '&') + `{${param.name}${param.required ? '' : '?'}:${type}}`;
-        isFirstQueryParam = false;
-      }
-    }
-    return path.replace(/^\/+/, '');
-  }
-
-  protected getEndpointStatusCodes(ctx: Context, endpoint: ApiEndpoint): Record<number, ts.Type<Builder>> {
-    return Object.fromEntries([
-      ...Object.entries(ctx.config.defaultStatusCodeResponseTypes).map(([key, value]) => [
-        key,
-        typeof value === 'function' ? this.getSchemaType(ctx, value(ctx.data.schemas)) : value,
-      ]),
-      ...endpoint.responses
-        .filter((x) => x.statusCode)
-        .map((x) => [x.statusCode, this.getSchemaType(ctx, x.contentOptions[0]?.schema, ts.refs.never())]),
-    ]);
-  }
-
-  protected getSchemaType(ctx: Context, schema: ApiSchema | undefined, fallback?: ts.Type<Builder>): ts.Type<Builder> {
-    const output = schema && ctx.input.typescript.models[schema.id];
-    if (!output) return fallback ?? this.getAnyType(ctx);
-    return (b) => b.appendModelUsage(output);
-  }
-}