@goast/typescript 0.9.0 → 0.9.1

package/dist/src/generators/models/models.d.ts

@@ -3,6 +3,10 @@ import { ts } from '../../ast/index.ts';
 import type { TypeScriptComponentOutput } from '../../common-results.ts';
 import { type TypeScriptGeneratorConfig } from '../../config.ts';
 import type { TypeScriptFileBuilder } from '../../file-builder.ts';
+/**
+ * The options of a single model. They control how the `TypeScriptModelGenerator` writes the model of each schema.
+ * They extend the common TypeScript generator options.
+ */
 export type TypeScriptModelGeneratorConfig = TypeScriptGeneratorConfig & {
     /**
      * Determines how to generate enums.
@@ -49,6 +53,10 @@ export type TypeScriptModelGeneratorConfig = TypeScriptGeneratorConfig & {
      */
     binarySchemaType: () => ts.Type<TypeScriptFileBuilder>;
 };
+/**
+ * The options of the `TypeScriptModelsGenerator`. They extend the model options with the location of the index file
+ * that re-exports all generated models.
+ */
 export type TypeScriptModelsGeneratorConfig = TypeScriptModelGeneratorConfig & {
     /**
      * The path to the index file where all models should be exported. If nullish, no index file will be generated.
@@ -56,21 +64,66 @@ export type TypeScriptModelsGeneratorConfig = TypeScriptModelGeneratorConfig & {
      */
     modelsIndexFile: Nullable<string>;
 };
+/**
+ * The default values of the `TypeScriptModelGeneratorConfig` options. Options that are not set take these values.
+ * @see TypeScriptModelGeneratorConfig
+ */
 export declare const defaultTypeScriptModelGeneratorConfig: DefaultGenerationProviderConfig<TypeScriptModelGeneratorConfig>;
+/**
+ * The default values of the `TypeScriptModelsGeneratorConfig` options. Options that are not set take these values.
+ * @see TypeScriptModelsGeneratorConfig
+ */
 export declare const defaultTypeScriptModelsGeneratorConfig: DefaultGenerationProviderConfig<TypeScriptModelsGeneratorConfig>;
+/**
+ * The input of the `TypeScriptModelsGenerator`. It is empty because the generator only reads the schemas of the
+ * OpenAPI documents from the context.
+ */
 export type TypeScriptModelsGeneratorInput = {};
+/**
+ * The output of the `TypeScriptModelsGenerator`. Later generators read the generated models and index file from it.
+ */
 export type TypeScriptModelsGeneratorOutput = {
+    /**
+     * The TypeScript results of the models generator.
+     */
     typescript: {
+        /**
+         * The generated models, keyed by the ID of their schema (`ApiSchema['id']`).
+         */
         models: {
+            /**
+             * The result for the schema with the given ID.
+             */
             [schemaId: string]: TypeScriptModelGeneratorOutput;
         };
+        /**
+         * The index files that were generated.
+         */
         indexFiles: {
+            /**
+             * The path to the models index file, or `null` if no index file was generated (`modelsIndexFile` is nullish).
+             */
             models: Nullable<string>;
         };
     };
 };
+/**
+ * The result of generating a single model. For a schema that is written to its own file, `component` is the declared
+ * type name and `filePath` is set. For an inline schema, `component` is the type expression and no file is written.
+ */
 export type TypeScriptModelGeneratorOutput = TypeScriptComponentOutput;
+/**
+ * The context of the `TypeScriptModelsGenerator`. It is passed to the models generator for all schemas.
+ * @see TypeScriptModelGeneratorContext
+ */
 export type TypeScriptModelsGeneratorContext = OpenApiSchemasGenerationProviderContext<TypeScriptModelsGeneratorInput, TypeScriptModelsGeneratorOutput, TypeScriptModelsGeneratorConfig, TypeScriptModelGeneratorOutput>;
+/**
+ * The context of the `TypeScriptModelGenerator` for a single schema.
+ * @see TypeScriptModelsGeneratorContext
+ */
 export type TypeScriptModelGeneratorContext = TypeScriptModelsGeneratorContext & {
+    /**
+     * The schema to generate the model for.
+     */
     schema: ApiSchema;
 };

package/dist/src/generators/models/models.js

@@ -1,5 +1,9 @@
 import { ts } from '../../ast/index.js';
 import { defaultTypeScriptGeneratorConfig } from '../../config.js';
+/**
+ * The default values of the `TypeScriptModelGeneratorConfig` options. Options that are not set take these values.
+ * @see TypeScriptModelGeneratorConfig
+ */
 export const defaultTypeScriptModelGeneratorConfig = {
     ...defaultTypeScriptGeneratorConfig,
     enumGeneration: 'union',
@@ -11,6 +15,10 @@ export const defaultTypeScriptModelGeneratorConfig = {
     discriminatorBaseTypeCasing: { casing: 'pascal', prefix: '_', suffix: 'Base' },
     binarySchemaType: ts.refs.blob,
 };
+/**
+ * The default values of the `TypeScriptModelsGeneratorConfig` options. Options that are not set take these values.
+ * @see TypeScriptModelsGeneratorConfig
+ */
 export const defaultTypeScriptModelsGeneratorConfig = {
     ...defaultTypeScriptModelGeneratorConfig,
     modelsIndexFile: 'models.ts',

package/dist/src/generators/services/angular-services/angular-service-generator.d.ts

@@ -7,10 +7,37 @@ import type { TypeScriptAngularServiceGeneratorContext, TypeScriptAngularService
 type Context = TypeScriptAngularServiceGeneratorContext;
 type Output = TypeScriptAngularServiceGeneratorOutput;
 type Builder = TypeScriptFileBuilder;
+/**
+ * Generates the Angular service class and the response models of a single OpenAPI service. Implement it to replace the
+ * default service generation.
+ * @template TOutput The type of the result that is returned for the service.
+ */
 export interface TypeScriptAngularServiceGenerator<TOutput extends Output = Output> {
+    /**
+     * Generates the response models and the service class of the service in the context.
+     * @param ctx The context of the service to generate, including its configuration and the generated models.
+     * @returns The result of the service, or a promise that resolves to it.
+     */
     generate(ctx: Context): MaybePromise<TOutput>;
 }
+/**
+ * The default Angular service generator. It writes the response models of an OpenAPI service and the Angular service
+ * class with one method per endpoint.
+ *
+ * The response models are written to `{outputDir}/{responseModelsDir}`, one file per service. Each endpoint gets a
+ * `{Method}ApiResponse` type that lists its possible responses. The service class is written to
+ * `{outputDir}/{servicesDir}`, one file per service, together with a `{Method}_Params` type for each endpoint that has
+ * parameters or a request body.
+ *
+ * The result contains the file path and class name of the service, and the response models keyed by endpoint ID. The
+ * services generator publishes it as `typescript.services[serviceId]`.
+ */
 export declare class DefaultTypeScriptAngularServiceGenerator extends TypeScriptFileGenerator<Context, Output> implements TypeScriptAngularServiceGenerator {
+    /**
+     * Generates the response models and the service class of the service in the context.
+     * @param ctx The context of the service to generate, including its configuration and the generated models.
+     * @returns The result of the service, including its file path, class name and response models.
+     */
     generate(ctx: Context): MaybePromise<Output>;
     protected generateResponseModels(ctx: Context): Record<string, TypeScriptExportOutput>;
     protected getResponseModelFileContent(ctx: Context, endpoint: ApiEndpoint): AppendValueGroup<Builder>;

package/dist/src/generators/services/angular-services/angular-service-generator.js

@@ -4,7 +4,24 @@ import { ts } from '../../../ast/index.js';
 import { TypeScriptFileBuilder } from '../../../file-builder.js';
 import { getSourceDocLine } from '../../../utils.js';
 import { TypeScriptFileGenerator } from '../../file-generator.js';
+/**
+ * The default Angular service generator. It writes the response models of an OpenAPI service and the Angular service
+ * class with one method per endpoint.
+ *
+ * The response models are written to `{outputDir}/{responseModelsDir}`, one file per service. Each endpoint gets a
+ * `{Method}ApiResponse` type that lists its possible responses. The service class is written to
+ * `{outputDir}/{servicesDir}`, one file per service, together with a `{Method}_Params` type for each endpoint that has
+ * parameters or a request body.
+ *
+ * The result contains the file path and class name of the service, and the response models keyed by endpoint ID. The
+ * services generator publishes it as `typescript.services[serviceId]`.
+ */
 export class DefaultTypeScriptAngularServiceGenerator extends TypeScriptFileGenerator {
+    /**
+     * Generates the response models and the service class of the service in the context.
+     * @param ctx The context of the service to generate, including its configuration and the generated models.
+     * @returns The result of the service, including its file path, class name and response models.
+     */
     generate(ctx) {
         const responseModels = this.generateResponseModels(ctx);
         const filePath = this.getServiceFilePath(ctx);

package/dist/src/generators/services/angular-services/angular-services-generator.d.ts

@@ -7,8 +7,29 @@ type Output = TypeScriptAngularServicesGeneratorOutput;
 type Config = TypeScriptAngularServicesGeneratorConfig;
 type ServiceOutput = TypeScriptAngularServiceGeneratorOutput;
 type Context = TypeScriptAngularServicesGeneratorContext;
+/**
+ * Generates the Angular services for all OpenAPI services, together with the shared utility and index files.
+ *
+ * The utility files are written to `{outputDir}/{utilsDir}`: `request-builder.ts` and `angular-service.utils.ts`,
+ * which are copied from the assets, `api-configuration.ts`, `api-base-service.ts`, `http-status-code.ts` (only if
+ * `strictResponseTypes` is `false`) and `provide.ts` (only if `provideKind` is `'provide-fn'`). Each service is
+ * generated by a `TypeScriptAngularServiceGenerator` into `{outputDir}/{servicesDir}`, and its response models into
+ * `{outputDir}/{responseModelsDir}`. The index files are written to `{outputDir}/{servicesIndexFile}` and
+ * `{outputDir}/{responseModelsIndexFile}`.
+ *
+ * It publishes the following data for later generators:
+ * - `typescript.services`: The result of each service, keyed by the service ID (`ApiService['id']`).
+ * - `typescript.indexFiles.services`: The path of the services index file, or `null` if none was generated.
+ * - `typescript.indexFiles.responseModels`: The path of the response models index file, or `null` if none
+ *   was generated.
+ */
 export declare class TypeScriptAngularServicesGenerator extends OpenApiServicesGenerationProviderBase<Input, Output, Config, ServiceOutput, Context> {
     private readonly _clientGeneratorFactory;
+    /**
+     * Initializes a new instance of the TypeScriptAngularServicesGenerator class.
+     * @param clientGeneratorFactory The factory that creates the service generator used for each service. If omitted, a
+     * `DefaultTypeScriptAngularServiceGenerator` is used.
+     */
     constructor(clientGeneratorFactory?: Factory<TypeScriptAngularServiceGenerator, []>);
     protected initResult(): Output;
     protected buildContext(context: OpenApiGeneratorContext<Input>, config?: Partial<Config> | undefined): Context;

package/dist/src/generators/services/angular-services/angular-services-generator.js

@@ -8,8 +8,29 @@ import { modifyString } from '../../../utils.js';
 import { DefaultTypeScriptAngularServiceGenerator, } from './angular-service-generator.js';
 import { defaultTypeScriptAngularServicesGeneratorConfig, } from './models.js';
 import { getReferenceFactories } from './refs.js';
+/**
+ * Generates the Angular services for all OpenAPI services, together with the shared utility and index files.
+ *
+ * The utility files are written to `{outputDir}/{utilsDir}`: `request-builder.ts` and `angular-service.utils.ts`,
+ * which are copied from the assets, `api-configuration.ts`, `api-base-service.ts`, `http-status-code.ts` (only if
+ * `strictResponseTypes` is `false`) and `provide.ts` (only if `provideKind` is `'provide-fn'`). Each service is
+ * generated by a `TypeScriptAngularServiceGenerator` into `{outputDir}/{servicesDir}`, and its response models into
+ * `{outputDir}/{responseModelsDir}`. The index files are written to `{outputDir}/{servicesIndexFile}` and
+ * `{outputDir}/{responseModelsIndexFile}`.
+ *
+ * It publishes the following data for later generators:
+ * - `typescript.services`: The result of each service, keyed by the service ID (`ApiService['id']`).
+ * - `typescript.indexFiles.services`: The path of the services index file, or `null` if none was generated.
+ * - `typescript.indexFiles.responseModels`: The path of the response models index file, or `null` if none
+ *   was generated.
+ */
 export class TypeScriptAngularServicesGenerator extends OpenApiServicesGenerationProviderBase {
     _clientGeneratorFactory;
+    /**
+     * Initializes a new instance of the TypeScriptAngularServicesGenerator class.
+     * @param clientGeneratorFactory The factory that creates the service generator used for each service. If omitted, a
+     * `DefaultTypeScriptAngularServiceGenerator` is used.
+     */
     constructor(clientGeneratorFactory) {
         super();
         this._clientGeneratorFactory =

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

@@ -5,12 +5,16 @@ import { type TypeScriptGeneratorConfig } from '../../../config.ts';
 import type { TypeScriptFileBuilder } from '../../../file-builder.ts';
 import type { TypeScriptModelGeneratorOutput } from '../../models/index.ts';
 import type { getReferenceFactories } from './refs.ts';
+/**
+ * The options of the `TypeScriptAngularServicesGenerator`. They extend the common TypeScript generator options with
+ * the settings for the services, their response models and the utility files.
+ */
 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'
+     * @default 'provide-fn'
      */
     provideKind: 'root' | 'provide-fn';
     /**
@@ -114,33 +118,98 @@ export type TypeScriptAngularServicesGeneratorConfig = TypeScriptGeneratorConfig
      */
     utilsDir: string;
 };
+/**
+ * The default values of the `TypeScriptAngularServicesGeneratorConfig` options. Options that are not set take these
+ * values.
+ * @see TypeScriptAngularServicesGeneratorConfig
+ */
 export declare const defaultTypeScriptAngularServicesGeneratorConfig: DefaultGenerationProviderConfig<TypeScriptAngularServicesGeneratorConfig>;
+/**
+ * The input of the `TypeScriptAngularServicesGenerator`. It contains the models generated before, which the services
+ * use for their parameter and response types.
+ */
 export type TypeScriptAngularServicesGeneratorInput = {
+    /**
+     * The TypeScript results of the models generator.
+     */
     typescript: {
+        /**
+         * The generated models, keyed by the ID of their schema (`ApiSchema['id']`).
+         */
         models: {
+            /**
+             * The result of the model for the schema with the given ID.
+             */
             [schemaId: string]: TypeScriptModelGeneratorOutput;
         };
     };
 };
+/**
+ * The output of the `TypeScriptAngularServicesGenerator`. Later generators read the generated services and index files
+ * from it.
+ */
 export type TypeScriptAngularServicesGeneratorOutput = {
+    /**
+     * The TypeScript results of the services generator.
+     */
     typescript: {
+        /**
+         * The generated services, keyed by the ID of their service (`ApiService['id']`).
+         */
         services: {
+            /**
+             * The result of the service with the given ID.
+             */
             [serviceId: string]: TypeScriptAngularServiceGeneratorOutput;
         };
+        /**
+         * The index files that were generated.
+         */
         indexFiles: {
+            /**
+             * The path to the services index file, or `null` if `servicesIndexFile` is nullish.
+             */
             services: Nullable<string>;
+            /**
+             * The path to the response models index file, or `null` if `responseModelsIndexFile` is nullish.
+             */
             responseModels: Nullable<string>;
         };
     };
 };
+/**
+ * The result of generating a single Angular service. `component` is the name of the service class, and `filePath` is
+ * the file it is written to.
+ */
 export type TypeScriptAngularServiceGeneratorOutput = TypeScriptExportOutput & {
+    /**
+     * The response models of the service, keyed by the ID of their endpoint (`ApiEndpoint['id']`).
+     */
     responseModels: {
+        /**
+         * The export of the response model for the endpoint with the given ID.
+         */
         [operationId: string]: TypeScriptExportOutput;
     };
 };
+/**
+ * The context of the `TypeScriptAngularServicesGenerator`. It is passed to the services generator, and each service
+ * generator receives it together with its `service`.
+ */
 export type TypeScriptAngularServicesGeneratorContext = OpenApiServicesGenerationProviderContext<TypeScriptAngularServicesGeneratorInput, TypeScriptAngularServicesGeneratorOutput, TypeScriptAngularServicesGeneratorConfig, TypeScriptAngularServiceGeneratorOutput> & {
+    /**
+     * The factories for the references to the utility files and the generated API infrastructure.
+     * See `getReferenceFactories`.
+     */
     refs: ReturnType<typeof getReferenceFactories>;
 };
+/**
+ * The context of the `TypeScriptAngularServiceGenerator` for a single service.
+ * @see TypeScriptAngularServicesGeneratorContext
+ */
 export type TypeScriptAngularServiceGeneratorContext = TypeScriptAngularServicesGeneratorContext & {
+    /**
+     * The service to generate the Angular service class for.
+     */
     readonly service: ApiService;
 };

package/dist/src/generators/services/angular-services/models.js

@@ -1,4 +1,9 @@
 import { defaultTypeScriptGeneratorConfig } from '../../../config.js';
+/**
+ * The default values of the `TypeScriptAngularServicesGeneratorConfig` options. Options that are not set take these
+ * values.
+ * @see TypeScriptAngularServicesGeneratorConfig
+ */
 export const defaultTypeScriptAngularServicesGeneratorConfig = {
     ...defaultTypeScriptGeneratorConfig,
     provideKind: 'provide-fn',

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

@@ -1,5 +1,16 @@
 import { ts } from '../../../ast/index.ts';
 import type { TypeScriptAngularServicesGeneratorConfig } from './models.ts';
+/**
+ * Creates the factories for the references to the Angular utility files and the generated API infrastructure.
+ *
+ * The references point into `{outputDir}/{utilsDir}`. `abortablePromise` and `waitForResponse` are exported by
+ * `angular-service.utils.ts`, `requestBuilder` by `request-builder.ts`, and `apiConfiguration`, `apiBaseService`,
+ * `httpStatusCode` and `provide` by the files that the services generator writes.
+ *
+ * @param options The services generator configuration. It determines the names and the location of the references.
+ * @returns The reference factories, keyed by the name of the referenced component.
+ * @see TypeScriptAngularServicesGeneratorConfig
+ */
 export declare function getReferenceFactories(options: TypeScriptAngularServicesGeneratorConfig): {
     abortablePromise: ts.GenericModuleReferenceFactory<1>;
     waitForResponse: ts.GenericModuleReferenceFactory<1>;

package/dist/src/generators/services/angular-services/refs.js

@@ -1,6 +1,17 @@
 import { join, resolve } from 'node:path';
 import { toCasing } from '@goast/core';
 import { ts } from '../../../ast/index.js';
+/**
+ * Creates the factories for the references to the Angular utility files and the generated API infrastructure.
+ *
+ * The references point into `{outputDir}/{utilsDir}`. `abortablePromise` and `waitForResponse` are exported by
+ * `angular-service.utils.ts`, `requestBuilder` by `request-builder.ts`, and `apiConfiguration`, `apiBaseService`,
+ * `httpStatusCode` and `provide` by the files that the services generator writes.
+ *
+ * @param options The services generator configuration. It determines the names and the location of the references.
+ * @returns The reference factories, keyed by the name of the referenced component.
+ * @see TypeScriptAngularServicesGeneratorConfig
+ */
 // See packages/typescript/assets/client/angular for reference
 export function getReferenceFactories(options) {
     const utilsDirPath = resolve(options.outputDir, options.utilsDir);

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

@@ -6,10 +6,32 @@ import type { TypeScriptEasyNetworkStubGeneratorContext, TypeScriptEasyNetworkSt
 type Context = TypeScriptEasyNetworkStubGeneratorContext;
 type Output = TypeScriptEasyNetworkStubGeneratorOutput;
 type Builder = TypeScriptFileBuilder;
+/**
+ * Generates the stub class of one API service.
+ * @template TOutput The type of the output returned for the service.
+ * @see DefaultTypeScriptEasyNetworkStubGenerator
+ */
 export interface TypeScriptEasyNetworkStubGenerator<TOutput extends Output = Output> {
+    /**
+     * Generates the stub file of the service in the context and returns the export that was written.
+     * @param ctx The context of the service to generate.
+     * @returns The output for the service, or a promise that resolves to it.
+     */
     generate(ctx: Context): MaybePromise<TOutput>;
 }
+/**
+ * The default implementation of `TypeScriptEasyNetworkStubGenerator`. It writes the stub class of one service to
+ * `{outputDir}/{stubsDir}/{service}.stubs.ts`, where `{service}` is the kebab-cased service name. The class extends
+ * `EasyNetworkStubBase` and has a responder, a request list and a `stub_*` method for each endpoint.
+ * Extend it to customize the output.
+ * @see TypeScriptEasyNetworkStubsGenerator
+ */
 export declare class DefaultTypeScriptEasyNetworkStubGenerator extends TypeScriptFileGenerator<Context, Output> implements TypeScriptEasyNetworkStubGenerator {
+    /**
+     * Generates the stub file of the service and returns the export that was written.
+     * @param ctx The context of the service to generate.
+     * @returns The `component` (the stub class name) and `filePath` of the generated stub class.
+     */
     generate(ctx: Context): MaybePromise<Output>;
     protected getStubFileContent(ctx: Context): AppendValueGroup<Builder>;
     protected getResponderVariable(ctx: Context, endpoint: ApiEndpoint): ts.Variable<Builder>;

package/dist/src/generators/services/easy-network-stub/easy-network-stub-generator.js

@@ -3,7 +3,19 @@ import { adjustCasing, appendValueGroup, builderTemplate as s, getSourceDisplayN
 import { ts } from '../../../ast/index.js';
 import { TypeScriptFileBuilder } from '../../../file-builder.js';
 import { TypeScriptFileGenerator } from '../../file-generator.js';
+/**
+ * The default implementation of `TypeScriptEasyNetworkStubGenerator`. It writes the stub class of one service to
+ * `{outputDir}/{stubsDir}/{service}.stubs.ts`, where `{service}` is the kebab-cased service name. The class extends
+ * `EasyNetworkStubBase` and has a responder, a request list and a `stub_*` method for each endpoint.
+ * Extend it to customize the output.
+ * @see TypeScriptEasyNetworkStubsGenerator
+ */
 export class DefaultTypeScriptEasyNetworkStubGenerator extends TypeScriptFileGenerator {
+    /**
+     * Generates the stub file of the service and returns the export that was written.
+     * @param ctx The context of the service to generate.
+     * @returns The `component` (the stub class name) and `filePath` of the generated stub class.
+     */
     generate(ctx) {
         const filePath = this.getStubFilePath(ctx);
         const name = this.getStubClassName(ctx);

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

@@ -9,8 +9,24 @@ type Output = TypeScriptEasyNetworkStubsGeneratorOutput;
 type Config = TypeScriptEasyNetworkStubsGeneratorConfig;
 type ServiceOutput = TypeScriptEasyNetworkStubGeneratorOutput;
 type Context = TypeScriptEasyNetworkStubsGeneratorContext;
+/**
+ * Generates an easy-network-stub stub class for each API service (tag), and an index file that combines them.
+ *
+ * Each service produces `{outputDir}/{stubsDir}/{service}.stubs.ts`, where `{service}` is the kebab-cased service name.
+ * The utilities are copied to `{outputDir}/{utilsDir}`. The index file `{outputDir}/{stubsIndexFile}` exports all stub
+ * classes and an aggregate `{domainName}_ApiStubs` class (named by `typeNameCasing`) with one group per service.
+ *
+ * It publishes `typescript.stubs[serviceId]` with the `component` and `filePath` of each stub class, and
+ * `typescript.indexFiles.stubs` with the path of the index file, for subsequent generators.
+ * @see TypeScriptEasyNetworkStubGenerator
+ */
 export declare class TypeScriptEasyNetworkStubsGenerator extends OpenApiServicesGenerationProviderBase<Input, Output, Config, ServiceOutput, Context> {
     private readonly _generatorFactory;
+    /**
+     * Initializes a new instance of the TypeScriptEasyNetworkStubsGenerator class.
+     * @param generatorFactory The factory that creates the generator for each service. Defaults to a
+     * `DefaultTypeScriptEasyNetworkStubGenerator`.
+     */
     constructor(generatorFactory?: Factory<TypeScriptEasyNetworkStubGenerator, []>);
     protected initResult(): Output;
     protected buildContext(context: OpenApiGeneratorContext<Input>, config?: Partial<Config> | undefined): Context;

package/dist/src/generators/services/easy-network-stub/easy-network-stubs-generator.js

@@ -7,8 +7,24 @@ import { TypeScriptFileBuilder } from '../../../file-builder.js';
 import { DefaultTypeScriptEasyNetworkStubGenerator, } from './easy-network-stub-generator.js';
 import { defaultTypeScriptEasyNetworkStubsGeneratorConfig, } from './models.js';
 import { getReferenceFactories } from './refs.js';
+/**
+ * Generates an easy-network-stub stub class for each API service (tag), and an index file that combines them.
+ *
+ * Each service produces `{outputDir}/{stubsDir}/{service}.stubs.ts`, where `{service}` is the kebab-cased service name.
+ * The utilities are copied to `{outputDir}/{utilsDir}`. The index file `{outputDir}/{stubsIndexFile}` exports all stub
+ * classes and an aggregate `{domainName}_ApiStubs` class (named by `typeNameCasing`) with one group per service.
+ *
+ * It publishes `typescript.stubs[serviceId]` with the `component` and `filePath` of each stub class, and
+ * `typescript.indexFiles.stubs` with the path of the index file, for subsequent generators.
+ * @see TypeScriptEasyNetworkStubGenerator
+ */
 export class TypeScriptEasyNetworkStubsGenerator extends OpenApiServicesGenerationProviderBase {
     _generatorFactory;
+    /**
+     * Initializes a new instance of the TypeScriptEasyNetworkStubsGenerator class.
+     * @param generatorFactory The factory that creates the generator for each service. Defaults to a
+     * `DefaultTypeScriptEasyNetworkStubGenerator`.
+     */
     constructor(generatorFactory) {
         super();
         this._generatorFactory = generatorFactory ?? Factory.fromValue(new DefaultTypeScriptEasyNetworkStubGenerator());

package/dist/src/generators/services/easy-network-stub/models.d.ts

@@ -5,6 +5,11 @@ import { type TypeScriptGeneratorConfig } from '../../../config.ts';
 import type { TypeScriptFileBuilder } from '../../../file-builder.ts';
 import type { TypeScriptModelGeneratorOutput } from '../../models/index.ts';
 import type { getReferenceFactories } from './refs.ts';
+/**
+ * The configuration of the `TypeScriptEasyNetworkStubsGenerator`. It extends the common TypeScript generator
+ * configuration with the naming, directory and index file settings of the generated stubs.
+ * @see TypeScriptEasyNetworkStubsGenerator
+ */
 export type TypeScriptEasyNetworkStubsGeneratorConfig = TypeScriptGeneratorConfig & {
     /**
      * The domain name of the API. Used as a prefix for exported components (e.g. `ApiStubs`).
@@ -50,28 +55,84 @@ export type TypeScriptEasyNetworkStubsGeneratorConfig = TypeScriptGeneratorConfi
      */
     utilsDir: string;
 };
+/**
+ * The default configuration of the `TypeScriptEasyNetworkStubsGenerator`. The provider uses these values for every
+ * option that is not set in its configuration.
+ * @see TypeScriptEasyNetworkStubsGeneratorConfig
+ */
 export declare const defaultTypeScriptEasyNetworkStubsGeneratorConfig: DefaultGenerationProviderConfig<TypeScriptEasyNetworkStubsGeneratorConfig>;
+/**
+ * The input of the `TypeScriptEasyNetworkStubsGenerator`. It is the output of the models generator, which the stubs use
+ * to reference the request and response model types.
+ */
 export type TypeScriptEasyNetworkStubsGeneratorInput = {
+    /**
+     * The TypeScript-specific results of the models generator.
+     */
     typescript: {
+        /**
+         * The generated models, keyed by the ID of their schema (`ApiSchema['id']`).
+         */
         models: {
+            /**
+             * The model output of one schema.
+             */
             [schemaId: string]: TypeScriptModelGeneratorOutput;
         };
     };
 };
+/**
+ * The output of the `TypeScriptEasyNetworkStubsGenerator`. It is published under the `typescript` key for subsequent
+ * generators.
+ */
 export type TypeScriptEasyNetworkStubsGeneratorOutput = {
+    /**
+     * The TypeScript-specific results of the stubs generator.
+     */
     typescript: {
+        /**
+         * The stub classes, keyed by the ID of their service (`ApiService['id']`).
+         */
         stubs: {
+            /**
+             * The stub class that was generated for one service.
+             */
             [serviceId: string]: TypeScriptEasyNetworkStubGeneratorOutput;
         };
+        /**
+         * The paths of the index files.
+         */
         indexFiles: {
+            /**
+             * The path to the index file that exports the stub classes. `null` when `stubsIndexFile` is disabled.
+             */
             stubs: Nullable<string>;
         };
     };
 };
+/**
+ * The output of the `TypeScriptEasyNetworkStubGenerator` for one service: the exported stub class and its file.
+ * @see TypeScriptExportOutput
+ */
 export type TypeScriptEasyNetworkStubGeneratorOutput = TypeScriptExportOutput;
+/**
+ * The context passed to the `TypeScriptEasyNetworkStubsGenerator` methods. It extends the services generator context
+ * with the reference factories of the stubs.
+ * @see TypeScriptEasyNetworkStubGeneratorContext
+ */
 export type TypeScriptEasyNetworkStubsGeneratorContext = OpenApiServicesGenerationProviderContext<TypeScriptEasyNetworkStubsGeneratorInput, TypeScriptEasyNetworkStubsGeneratorOutput, TypeScriptEasyNetworkStubsGeneratorConfig, TypeScriptEasyNetworkStubGeneratorOutput> & {
+    /**
+     * The factories that create references to the utilities, as returned by `getReferenceFactories`.
+     */
     refs: ReturnType<typeof getReferenceFactories>;
 };
+/**
+ * The context passed to `TypeScriptEasyNetworkStubGenerator.generate` for a single service.
+ * @see TypeScriptEasyNetworkStubsGeneratorContext
+ */
 export type TypeScriptEasyNetworkStubGeneratorContext = TypeScriptEasyNetworkStubsGeneratorContext & {
+    /**
+     * The API service whose stubs are generated.
+     */
     readonly service: ApiService;
 };

package/dist/src/generators/services/easy-network-stub/models.js

@@ -1,5 +1,10 @@
 import { ts } from '../../../ast/index.js';
 import { defaultTypeScriptGeneratorConfig } from '../../../config.js';
+/**
+ * The default configuration of the `TypeScriptEasyNetworkStubsGenerator`. The provider uses these values for every
+ * option that is not set in its configuration.
+ * @see TypeScriptEasyNetworkStubsGeneratorConfig
+ */
 export const defaultTypeScriptEasyNetworkStubsGeneratorConfig = {
     ...defaultTypeScriptGeneratorConfig,
     domainName: undefined,

package/dist/src/generators/services/easy-network-stub/refs.d.ts

@@ -1,5 +1,12 @@
 import { ts } from '../../../ast/index.ts';
 import type { TypeScriptEasyNetworkStubsGeneratorConfig } from './models.ts';
+/**
+ * Creates the references to the utilities that the generated stubs import from the `utils` directory.
+ * `TypeScriptEasyNetworkStubsGenerator` copies these utilities to `{outputDir}/{utilsDir}`.
+ * @param options The configuration of the stubs generator, which provides `outputDir` and `utilsDir`.
+ * @returns The reference factories for the members of `easy-network-stub.utils.ts`, and for `StubHandle`, which is
+ * imported from the `easy-network-stub` module.
+ */
 export declare function getReferenceFactories(options: TypeScriptEasyNetworkStubsGeneratorConfig): {
     easyNetworkStubWrapperOptions: ts.ModuleReferenceFactory;
     stubRequestItem: ts.ModuleReferenceFactory;

package/dist/src/generators/services/easy-network-stub/refs.js

@@ -1,5 +1,12 @@
 import { join, resolve } from 'node:path';
 import { ts } from '../../../ast/index.js';
+/**
+ * Creates the references to the utilities that the generated stubs import from the `utils` directory.
+ * `TypeScriptEasyNetworkStubsGenerator` copies these utilities to `{outputDir}/{utilsDir}`.
+ * @param options The configuration of the stubs generator, which provides `outputDir` and `utilsDir`.
+ * @returns The reference factories for the members of `easy-network-stub.utils.ts`, and for `StubHandle`, which is
+ * imported from the `easy-network-stub` module.
+ */
 // See packages/typescript/assets/stubs/easy-network-stub for reference
 export function getReferenceFactories(options) {
     const utilsDirPath = resolve(options.outputDir, options.utilsDir);