@ahoo-wang/wow-generator 9.2.0-rc.0

package/dist/emit/importRegistry.d.cts

@@ -0,0 +1,50 @@
+import { ImportDeclarationStructure, OptionalKind } from 'ts-morph';
+/** A name one module imports from another, under an alias or its own name. */
+export interface NamedImport {
+    readonly name: string;
+    alias?: string;
+}
+/**
+ * The imports of one generated module, kept in memory until the module is
+ * written.
+ *
+ * Declarations stay in the order their modules were first imported, and
+ * names in the order they were first asked for, as the file would have
+ * received them one by one; `organizeImports` sorts them when the file is
+ * finished.
+ */
+export declare class ImportRegistry {
+    private readonly declarations;
+    /**
+     * Imports names from a module, keeping the ones it already imports.
+     *
+     * @param moduleSpecifier - The module to import from
+     * @param names - The names to import
+     * @returns The names the module now imports
+     */
+    add(moduleSpecifier: string, names: readonly string[]): readonly NamedImport[];
+    /**
+     * Applies imports a resolved type asks for, in order: each name is
+     * imported, and takes the alias the request gives it.
+     *
+     * @param requests - The imports, as `types/typeResolver.ts` returns them
+     */
+    apply(requests: readonly {
+        moduleSpecifier: string;
+        name: string;
+        alias?: string;
+    }[]): void;
+    /** Every name imported, with its module and alias, in the order first asked for. */
+    entries(): {
+        moduleSpecifier: string;
+        name: string;
+        alias?: string;
+    }[];
+    /**
+     * The local names every import binds, the ones of `except` aside: an
+     * alias where it has one, else the name.
+     */
+    localNames(except?: NamedImport): string[];
+    /** The import declarations, in the order they were first asked for. */
+    structures(): OptionalKind<ImportDeclarationStructure>[];
+}

package/dist/emit/importRegistry.d.ts

@@ -0,0 +1,50 @@
+import { ImportDeclarationStructure, OptionalKind } from 'ts-morph';
+/** A name one module imports from another, under an alias or its own name. */
+export interface NamedImport {
+    readonly name: string;
+    alias?: string;
+}
+/**
+ * The imports of one generated module, kept in memory until the module is
+ * written.
+ *
+ * Declarations stay in the order their modules were first imported, and
+ * names in the order they were first asked for, as the file would have
+ * received them one by one; `organizeImports` sorts them when the file is
+ * finished.
+ */
+export declare class ImportRegistry {
+    private readonly declarations;
+    /**
+     * Imports names from a module, keeping the ones it already imports.
+     *
+     * @param moduleSpecifier - The module to import from
+     * @param names - The names to import
+     * @returns The names the module now imports
+     */
+    add(moduleSpecifier: string, names: readonly string[]): readonly NamedImport[];
+    /**
+     * Applies imports a resolved type asks for, in order: each name is
+     * imported, and takes the alias the request gives it.
+     *
+     * @param requests - The imports, as `types/typeResolver.ts` returns them
+     */
+    apply(requests: readonly {
+        moduleSpecifier: string;
+        name: string;
+        alias?: string;
+    }[]): void;
+    /** Every name imported, with its module and alias, in the order first asked for. */
+    entries(): {
+        moduleSpecifier: string;
+        name: string;
+        alias?: string;
+    }[];
+    /**
+     * The local names every import binds, the ones of `except` aside: an
+     * alias where it has one, else the name.
+     */
+    localNames(except?: NamedImport): string[];
+    /** The import declarations, in the order they were first asked for. */
+    structures(): OptionalKind<ImportDeclarationStructure>[];
+}

package/dist/emit/imports.d.cts

@@ -0,0 +1,49 @@
+import { ModelInfo } from '../naming/modelInfo.cjs';
+import { NamedImport } from './importRegistry.cjs';
+import { ModuleBuilder } from './moduleBuilder.cjs';
+/**
+ * Adds named imports to a module.
+ * @param module - The module to modify
+ * @param moduleSpecifier - The module to import from
+ * @param namedImports - Array of named imports to add
+ * @returns The names the module now imports from `moduleSpecifier`
+ */
+export declare function addImport(module: ModuleBuilder, moduleSpecifier: string, namedImports: string[]): readonly NamedImport[];
+/**
+ * Adds an import for a referenced model.
+ * @param module - The module to modify
+ * @param outputDir - The output directory
+ * @param refModelInfo - The referenced model information
+ */
+export declare function addImportRefModel(module: ModuleBuilder, outputDir: string, refModelInfo: ModelInfo): readonly NamedImport[];
+/**
+ * The specifier a module imports a model by: the package of a model imported
+ * from one (a path starting with `@`), else the relative path of the
+ * `types.ts` that declares it.
+ *
+ * @param module - The importing module
+ * @param outputDir - The output directory
+ * @param model - The model
+ */
+export declare function modelModuleSpecifier(module: ModuleBuilder, outputDir: string, model: ModelInfo): string;
+/**
+ * The specifier a source file imports another generated file by.
+ *
+ * Relative specifiers carry the `.js` extension, which every module
+ * resolution TypeScript offers accepts for a `.ts` file: `NodeNext` and
+ * `Node16` require it, and `bundler` and `node10` map it back to the source.
+ *
+ * @param fromDirectory - The directory of the importing file
+ * @param targetFilePath - The imported `.ts` file, or a directory holding an `index.ts`
+ * @returns A specifier starting with `./` or `../` and ending with `.js`
+ */
+export declare function relativeModuleSpecifier(fromDirectory: string, targetFilePath: string): string;
+/**
+ * Imports a bounded context's alias constant into a generated file.
+ *
+ * @param module - The importing module
+ * @param outputDir - The output directory
+ * @param contextAlias - The bounded context alias
+ * @param declarationName - The name of the alias constant
+ */
+export declare function addImportBoundedContext(module: ModuleBuilder, outputDir: string, contextAlias: string, declarationName: string): readonly NamedImport[];

package/dist/emit/imports.d.ts

@@ -0,0 +1,49 @@
+import { ModelInfo } from '../naming/modelInfo.js';
+import { NamedImport } from './importRegistry.js';
+import { ModuleBuilder } from './moduleBuilder.js';
+/**
+ * Adds named imports to a module.
+ * @param module - The module to modify
+ * @param moduleSpecifier - The module to import from
+ * @param namedImports - Array of named imports to add
+ * @returns The names the module now imports from `moduleSpecifier`
+ */
+export declare function addImport(module: ModuleBuilder, moduleSpecifier: string, namedImports: string[]): readonly NamedImport[];
+/**
+ * Adds an import for a referenced model.
+ * @param module - The module to modify
+ * @param outputDir - The output directory
+ * @param refModelInfo - The referenced model information
+ */
+export declare function addImportRefModel(module: ModuleBuilder, outputDir: string, refModelInfo: ModelInfo): readonly NamedImport[];
+/**
+ * The specifier a module imports a model by: the package of a model imported
+ * from one (a path starting with `@`), else the relative path of the
+ * `types.ts` that declares it.
+ *
+ * @param module - The importing module
+ * @param outputDir - The output directory
+ * @param model - The model
+ */
+export declare function modelModuleSpecifier(module: ModuleBuilder, outputDir: string, model: ModelInfo): string;
+/**
+ * The specifier a source file imports another generated file by.
+ *
+ * Relative specifiers carry the `.js` extension, which every module
+ * resolution TypeScript offers accepts for a `.ts` file: `NodeNext` and
+ * `Node16` require it, and `bundler` and `node10` map it back to the source.
+ *
+ * @param fromDirectory - The directory of the importing file
+ * @param targetFilePath - The imported `.ts` file, or a directory holding an `index.ts`
+ * @returns A specifier starting with `./` or `../` and ending with `.js`
+ */
+export declare function relativeModuleSpecifier(fromDirectory: string, targetFilePath: string): string;
+/**
+ * Imports a bounded context's alias constant into a generated file.
+ *
+ * @param module - The importing module
+ * @param outputDir - The output directory
+ * @param contextAlias - The bounded context alias
+ * @param declarationName - The name of the alias constant
+ */
+export declare function addImportBoundedContext(module: ModuleBuilder, outputDir: string, contextAlias: string, declarationName: string): readonly NamedImport[];

package/dist/emit/jsdoc.d.cts

@@ -0,0 +1,38 @@
+import { Reference, Schema } from '@ahoo-wang/fetcher-openapi';
+import { JSDocableNodeStructure } from 'ts-morph';
+/**
+ * Generates a JSDoc comment string from a title and description.
+ * @returns The formatted JSDoc string or undefined if both title and description are empty
+ */
+export declare function jsDoc(descriptions: (string | undefined)[], separator?: string): string | undefined;
+/**
+ * Keeps document text from ending the comment it is written into: a
+ * description holding `*` followed by `/` - a cron expression such as
+ * `*` `/5 * * * *`, a glob - would otherwise close the JSDoc early.
+ *
+ * @param text - Text taken from the document
+ * @returns The text with every comment terminator broken up
+ */
+export declare function escapeJsDoc(text: string): string;
+/**
+ * Adds a JSDoc comment to a declaration with the provided title and
+ * description, after the ones it already has.
+ */
+export declare function addJSDoc(node: JSDocableNodeStructure, descriptions: (string | undefined)[]): void;
+export declare function schemaJSDoc(schema: Schema, key?: string): (string | undefined)[];
+/**
+ * Adds a JSDoc comment to a declaration based on the schema's title and description.
+ * @param node - The declaration to add the JSDoc comment to
+ * @param schema - The schema containing title and description
+ * @param key - The key associated with the schema
+ */
+export declare function addSchemaJSDoc(node: JSDocableNodeStructure, schema: Schema | Reference, key?: string): void;
+/**
+ * Adds the doc comment of a model.
+ *
+ * @param node - The model declaration
+ * @param schema - The schema it is generated from
+ * @param key - The schema's component key
+ * @param includeSchema - Also embed the complete JSON schema
+ */
+export declare function addMainSchemaJSDoc(node: JSDocableNodeStructure, schema: Schema | Reference, key?: string, includeSchema?: boolean): void;

package/dist/emit/jsdoc.d.ts

@@ -0,0 +1,38 @@
+import { Reference, Schema } from '@ahoo-wang/fetcher-openapi';
+import { JSDocableNodeStructure } from 'ts-morph';
+/**
+ * Generates a JSDoc comment string from a title and description.
+ * @returns The formatted JSDoc string or undefined if both title and description are empty
+ */
+export declare function jsDoc(descriptions: (string | undefined)[], separator?: string): string | undefined;
+/**
+ * Keeps document text from ending the comment it is written into: a
+ * description holding `*` followed by `/` - a cron expression such as
+ * `*` `/5 * * * *`, a glob - would otherwise close the JSDoc early.
+ *
+ * @param text - Text taken from the document
+ * @returns The text with every comment terminator broken up
+ */
+export declare function escapeJsDoc(text: string): string;
+/**
+ * Adds a JSDoc comment to a declaration with the provided title and
+ * description, after the ones it already has.
+ */
+export declare function addJSDoc(node: JSDocableNodeStructure, descriptions: (string | undefined)[]): void;
+export declare function schemaJSDoc(schema: Schema, key?: string): (string | undefined)[];
+/**
+ * Adds a JSDoc comment to a declaration based on the schema's title and description.
+ * @param node - The declaration to add the JSDoc comment to
+ * @param schema - The schema containing title and description
+ * @param key - The key associated with the schema
+ */
+export declare function addSchemaJSDoc(node: JSDocableNodeStructure, schema: Schema | Reference, key?: string): void;
+/**
+ * Adds the doc comment of a model.
+ *
+ * @param node - The model declaration
+ * @param schema - The schema it is generated from
+ * @param key - The schema's component key
+ * @param includeSchema - Also embed the complete JSON schema
+ */
+export declare function addMainSchemaJSDoc(node: JSDocableNodeStructure, schema: Schema | Reference, key?: string, includeSchema?: boolean): void;

package/dist/emit/moduleBuilder.d.cts

@@ -0,0 +1,80 @@
+import { ClassDeclarationStructure, EnumDeclarationStructure, EnumMemberStructure, InterfaceDeclarationStructure, OptionalKind, SourceFile, TypeAliasDeclarationStructure, VariableStatementStructure } from 'ts-morph';
+import { ImportRegistry } from './importRegistry.cjs';
+/** A top-level statement of a generated module. */
+export type ModuleStatement = ClassDeclarationStructure | EnumDeclarationStructure | InterfaceDeclarationStructure | TypeAliasDeclarationStructure | VariableStatementStructure | string;
+/**
+ * A generated module, collected in memory and written into its source file
+ * once.
+ *
+ * ts-morph re-parses the whole file on every change, so a file written a
+ * declaration, a property and a doc comment at a time costs time that grows
+ * with the square of its length: the root `types.ts` of a large document runs
+ * to 20,000 lines. Here the emitters describe each declaration as a ts-morph
+ * structure, with its members and docs, and {@link build} inserts the lot in
+ * one change, printed by the same printers.
+ *
+ * The blank lines between statements are the ones the file would have got
+ * receiving the statements one by one, so the output is byte for byte the
+ * same: a type alias follows a type alias, and a variable statement a
+ * variable statement, on the next line; anything else is set off by a blank
+ * line.
+ */
+export declare class ModuleBuilder {
+    readonly sourceFile: SourceFile;
+    /** The imports of the module. */
+    readonly imports: ImportRegistry;
+    private readonly statements;
+    /**
+     * @param sourceFile - The file the module is written into; it stays empty
+     * until {@link build}.
+     */
+    constructor(sourceFile: SourceFile);
+    /** The directory of the module's file, which relative imports start from. */
+    get directoryPath(): string;
+    /**
+     * Adds a top-level statement. A structure stays open to changes until the
+     * module is built.
+     *
+     * @returns The statement added
+     */
+    add<T extends ModuleStatement>(statement: T): T;
+    /** Writes the imports and the statements into the file in one change. */
+    build(): SourceFile;
+}
+/**
+ * The modules of one generation, one builder per file, written together at
+ * the end.
+ */
+export declare class ModuleSet {
+    private readonly open;
+    private readonly modules;
+    /**
+     * @param open - Returns the source file a path relative to the output
+     * directory is written to, claiming it for the generation
+     */
+    constructor(open: (filePath: string) => SourceFile);
+    /**
+     * The module written to a path under the output directory, created the
+     * first time it is asked for.
+     */
+    module(filePath: string): ModuleBuilder;
+    /** Writes every module into its file, each in one go. */
+    build(): void;
+}
+/**
+ * Enum members printed as adding them one at a time to an enum leaves them:
+ * each one followed by a comma, the last one too. The printer separates
+ * members with commas only where a member does not already end with one.
+ *
+ * @param members - The members, each with a string initializer
+ */
+export declare function membersWithTrailingComma(members: readonly OptionalKind<EnumMemberStructure>[]): OptionalKind<EnumMemberStructure>[];
+/**
+ * The index signature of an interface, as a member printed after its
+ * properties, where adding it after them puts it: a structure's
+ * `indexSignatures` are printed first.
+ *
+ * @param returnType - The type of the additional properties
+ * @param docs - Its doc comments
+ */
+export declare function indexSignatureMember(returnType: string, docs?: string[]): OptionalKind<NonNullable<InterfaceDeclarationStructure['properties']>[number]>;

package/dist/emit/moduleBuilder.d.ts

@@ -0,0 +1,80 @@
+import { ClassDeclarationStructure, EnumDeclarationStructure, EnumMemberStructure, InterfaceDeclarationStructure, OptionalKind, SourceFile, TypeAliasDeclarationStructure, VariableStatementStructure } from 'ts-morph';
+import { ImportRegistry } from './importRegistry.js';
+/** A top-level statement of a generated module. */
+export type ModuleStatement = ClassDeclarationStructure | EnumDeclarationStructure | InterfaceDeclarationStructure | TypeAliasDeclarationStructure | VariableStatementStructure | string;
+/**
+ * A generated module, collected in memory and written into its source file
+ * once.
+ *
+ * ts-morph re-parses the whole file on every change, so a file written a
+ * declaration, a property and a doc comment at a time costs time that grows
+ * with the square of its length: the root `types.ts` of a large document runs
+ * to 20,000 lines. Here the emitters describe each declaration as a ts-morph
+ * structure, with its members and docs, and {@link build} inserts the lot in
+ * one change, printed by the same printers.
+ *
+ * The blank lines between statements are the ones the file would have got
+ * receiving the statements one by one, so the output is byte for byte the
+ * same: a type alias follows a type alias, and a variable statement a
+ * variable statement, on the next line; anything else is set off by a blank
+ * line.
+ */
+export declare class ModuleBuilder {
+    readonly sourceFile: SourceFile;
+    /** The imports of the module. */
+    readonly imports: ImportRegistry;
+    private readonly statements;
+    /**
+     * @param sourceFile - The file the module is written into; it stays empty
+     * until {@link build}.
+     */
+    constructor(sourceFile: SourceFile);
+    /** The directory of the module's file, which relative imports start from. */
+    get directoryPath(): string;
+    /**
+     * Adds a top-level statement. A structure stays open to changes until the
+     * module is built.
+     *
+     * @returns The statement added
+     */
+    add<T extends ModuleStatement>(statement: T): T;
+    /** Writes the imports and the statements into the file in one change. */
+    build(): SourceFile;
+}
+/**
+ * The modules of one generation, one builder per file, written together at
+ * the end.
+ */
+export declare class ModuleSet {
+    private readonly open;
+    private readonly modules;
+    /**
+     * @param open - Returns the source file a path relative to the output
+     * directory is written to, claiming it for the generation
+     */
+    constructor(open: (filePath: string) => SourceFile);
+    /**
+     * The module written to a path under the output directory, created the
+     * first time it is asked for.
+     */
+    module(filePath: string): ModuleBuilder;
+    /** Writes every module into its file, each in one go. */
+    build(): void;
+}
+/**
+ * Enum members printed as adding them one at a time to an enum leaves them:
+ * each one followed by a comma, the last one too. The printer separates
+ * members with commas only where a member does not already end with one.
+ *
+ * @param members - The members, each with a string initializer
+ */
+export declare function membersWithTrailingComma(members: readonly OptionalKind<EnumMemberStructure>[]): OptionalKind<EnumMemberStructure>[];
+/**
+ * The index signature of an interface, as a member printed after its
+ * properties, where adding it after them puts it: a structure's
+ * `indexSignatures` are printed first.
+ *
+ * @param returnType - The type of the additional properties
+ * @param docs - Its doc comments
+ */
+export declare function indexSignatureMember(returnType: string, docs?: string[]): OptionalKind<NonNullable<InterfaceDeclarationStructure['properties']>[number]>;

package/dist/emitters/apiClients.d.cts

@@ -0,0 +1,10 @@
+import { ApiClientModel } from '../analysis/model.cjs';
+import { EmitTarget } from './target.cjs';
+/**
+ * Writes the API client of a tag: a decorated class with a method per
+ * operation.
+ *
+ * @param client - The client
+ * @param target - Where it is written
+ */
+export declare function emitApiClient(client: ApiClientModel, target: EmitTarget): void;

package/dist/emitters/apiClients.d.ts

@@ -0,0 +1,10 @@
+import { ApiClientModel } from '../analysis/model.js';
+import { EmitTarget } from './target.js';
+/**
+ * Writes the API client of a tag: a decorated class with a method per
+ * operation.
+ *
+ * @param client - The client
+ * @param target - Where it is written
+ */
+export declare function emitApiClient(client: ApiClientModel, target: EmitTarget): void;

package/dist/emitters/commandClients.d.cts

@@ -0,0 +1,14 @@
+import { AggregateModel } from '../analysis/model.cjs';
+import { EmitTarget } from './target.cjs';
+/**
+ * Writes the command client of an aggregate: the enum of its command routes,
+ * a type per command body whose name does not already end in `Command`, the client, whose methods send the commands, and
+ * the streaming client, which waits on their results as server-sent events.
+ * An aggregate the document routes no command to (every command route
+ * disabled or closed by the service) gets none: a client without a method
+ * sends nothing, and its result type would go unused.
+ *
+ * @param aggregate - The aggregate
+ * @param target - Where it is written
+ */
+export declare function emitCommandClient(aggregate: AggregateModel, target: EmitTarget): void;

package/dist/emitters/commandClients.d.ts

@@ -0,0 +1,14 @@
+import { AggregateModel } from '../analysis/model.js';
+import { EmitTarget } from './target.js';
+/**
+ * Writes the command client of an aggregate: the enum of its command routes,
+ * a type per command body whose name does not already end in `Command`, the client, whose methods send the commands, and
+ * the streaming client, which waits on their results as server-sent events.
+ * An aggregate the document routes no command to (every command route
+ * disabled or closed by the service) gets none: a client without a method
+ * sends nothing, and its result type would go unused.
+ *
+ * @param aggregate - The aggregate
+ * @param target - Where it is written
+ */
+export declare function emitCommandClient(aggregate: AggregateModel, target: EmitTarget): void;

package/dist/emitters/decorators.d.cts

@@ -0,0 +1,83 @@
+import { ClassDeclarationStructure } from 'ts-morph';
+import { ModuleBuilder } from '../emit/moduleBuilder.cjs';
+export declare const FETCHER_MODULE_SPECIFIER = "@ahoo-wang/fetcher";
+export declare const FETCHER_NAMED_IMPORTS: string[];
+/**
+ * The module specifier for the fetcher-decorator package.
+ */
+export declare const DECORATOR_MODULE_SPECIFIER = "@ahoo-wang/fetcher-decorator";
+/**
+ * Named imports from the fetcher-decorator package.
+ */
+export declare const DECORATOR_NAMED_IMPORTS: string[];
+export interface MethodReturnType {
+    type: string;
+    metadata?: string;
+}
+export declare const DEFAULT_RETURN_TYPE: MethodReturnType;
+export declare const STRING_RETURN_TYPE: MethodReturnType;
+/**
+ * Metadata configuration for stream result extraction.
+ */
+export declare const STREAM_RESULT_EXTRACTOR_METADATA = "{\n  headers: { Accept: ContentTypeValues.TEXT_EVENT_STREAM },\n  resultExtractor: JsonEventStreamResultExtractor,\n}";
+/**
+ * The endpoint options of a streaming command client, imported from
+ * `@ahoo-wang/wow-client`: `Accept: text/event-stream` and a result
+ * extractor that errors the stream with a `WowError` when the server sends an
+ * error event instead of passing the event on as a result.
+ */
+export declare const COMMAND_STREAM_ENDPOINT_METADATA = "COMMAND_STREAM_ENDPOINT";
+export declare function addImportFetcher(module: ModuleBuilder): void;
+/**
+ * Adds the necessary imports for decorator functionality to a module.
+ *
+ * @param module - The module to add imports to
+ */
+export declare function addImportDecorator(module: ModuleBuilder): void;
+/**
+ * Adds a class declaration with the @api decorator to a module.
+ *
+ * @param className - The name of the class to create
+ * @param module - The module to add the class to
+ * @param apiArgs - Optional arguments for the @api decorator
+ * @param typeParameters - Optional type parameters for the class
+ * @param extendsClass - Optional class to extend
+ * @returns The class declaration, open to members until the module is built
+ *
+ * @example
+ * ```typescript
+ * const classDecl = createDecoratorClass('UserApi', module, ['baseUrl']);
+ * ```
+ */
+export declare function createDecoratorClass(className: string, module: ModuleBuilder, apiArgs?: string[], typeParameters?: string[], extendsClass?: string): ClassDeclarationStructure;
+/**
+ * Adds the ApiMetadataCapable interface implementation and constructor to a class declaration.
+ *
+ * With defaults, the constructor merges what the caller passes over them, so
+ * `new CartCommandClient({ fetcher })` keeps the bounded context's base path:
+ *
+ * ```typescript
+ * readonly apiMetadata: ApiMetadata;
+ * constructor(apiMetadata?: ApiMetadata) {
+ *   this.apiMetadata = { ...DEFAULT_COMMAND_CLIENT_OPTIONS, ...apiMetadata };
+ * }
+ * ```
+ *
+ * @param classDeclaration - The class declaration to modify
+ * @param defaults - Object literal entries the constructor starts from, such
+ * as `...DEFAULT_COMMAND_CLIENT_OPTIONS` or `basePath: X`; none by default
+ */
+export declare function addApiMetadataCtor(classDeclaration: ClassDeclarationStructure, defaults?: string): void;
+/**
+ * The decorator of an HTTP method: its name, but `del` for `delete`, a
+ * reserved word.
+ *
+ * @example
+ * ```typescript
+ * methodToDecorator('get');    // 'get'
+ * methodToDecorator('delete'); // 'del'
+ * ```
+ */
+export declare function methodToDecorator(method: string): string;
+export declare const EVENTSTREAM_MODULE_SPECIFIER = "@ahoo-wang/fetcher-eventstream";
+export declare function addImportEventStream(module: ModuleBuilder): void;

package/dist/emitters/decorators.d.ts

@@ -0,0 +1,83 @@
+import { ClassDeclarationStructure } from 'ts-morph';
+import { ModuleBuilder } from '../emit/moduleBuilder.js';
+export declare const FETCHER_MODULE_SPECIFIER = "@ahoo-wang/fetcher";
+export declare const FETCHER_NAMED_IMPORTS: string[];
+/**
+ * The module specifier for the fetcher-decorator package.
+ */
+export declare const DECORATOR_MODULE_SPECIFIER = "@ahoo-wang/fetcher-decorator";
+/**
+ * Named imports from the fetcher-decorator package.
+ */
+export declare const DECORATOR_NAMED_IMPORTS: string[];
+export interface MethodReturnType {
+    type: string;
+    metadata?: string;
+}
+export declare const DEFAULT_RETURN_TYPE: MethodReturnType;
+export declare const STRING_RETURN_TYPE: MethodReturnType;
+/**
+ * Metadata configuration for stream result extraction.
+ */
+export declare const STREAM_RESULT_EXTRACTOR_METADATA = "{\n  headers: { Accept: ContentTypeValues.TEXT_EVENT_STREAM },\n  resultExtractor: JsonEventStreamResultExtractor,\n}";
+/**
+ * The endpoint options of a streaming command client, imported from
+ * `@ahoo-wang/wow-client`: `Accept: text/event-stream` and a result
+ * extractor that errors the stream with a `WowError` when the server sends an
+ * error event instead of passing the event on as a result.
+ */
+export declare const COMMAND_STREAM_ENDPOINT_METADATA = "COMMAND_STREAM_ENDPOINT";
+export declare function addImportFetcher(module: ModuleBuilder): void;
+/**
+ * Adds the necessary imports for decorator functionality to a module.
+ *
+ * @param module - The module to add imports to
+ */
+export declare function addImportDecorator(module: ModuleBuilder): void;
+/**
+ * Adds a class declaration with the @api decorator to a module.
+ *
+ * @param className - The name of the class to create
+ * @param module - The module to add the class to
+ * @param apiArgs - Optional arguments for the @api decorator
+ * @param typeParameters - Optional type parameters for the class
+ * @param extendsClass - Optional class to extend
+ * @returns The class declaration, open to members until the module is built
+ *
+ * @example
+ * ```typescript
+ * const classDecl = createDecoratorClass('UserApi', module, ['baseUrl']);
+ * ```
+ */
+export declare function createDecoratorClass(className: string, module: ModuleBuilder, apiArgs?: string[], typeParameters?: string[], extendsClass?: string): ClassDeclarationStructure;
+/**
+ * Adds the ApiMetadataCapable interface implementation and constructor to a class declaration.
+ *
+ * With defaults, the constructor merges what the caller passes over them, so
+ * `new CartCommandClient({ fetcher })` keeps the bounded context's base path:
+ *
+ * ```typescript
+ * readonly apiMetadata: ApiMetadata;
+ * constructor(apiMetadata?: ApiMetadata) {
+ *   this.apiMetadata = { ...DEFAULT_COMMAND_CLIENT_OPTIONS, ...apiMetadata };
+ * }
+ * ```
+ *
+ * @param classDeclaration - The class declaration to modify
+ * @param defaults - Object literal entries the constructor starts from, such
+ * as `...DEFAULT_COMMAND_CLIENT_OPTIONS` or `basePath: X`; none by default
+ */
+export declare function addApiMetadataCtor(classDeclaration: ClassDeclarationStructure, defaults?: string): void;
+/**
+ * The decorator of an HTTP method: its name, but `del` for `delete`, a
+ * reserved word.
+ *
+ * @example
+ * ```typescript
+ * methodToDecorator('get');    // 'get'
+ * methodToDecorator('delete'); // 'del'
+ * ```
+ */
+export declare function methodToDecorator(method: string): string;
+export declare const EVENTSTREAM_MODULE_SPECIFIER = "@ahoo-wang/fetcher-eventstream";
+export declare function addImportEventStream(module: ModuleBuilder): void;