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

package/dist/analysis/clientNames.d.cts

@@ -0,0 +1,55 @@
+import { TagAliasAggregate } from '../wow/model.cjs';
+import { Operation } from '@ahoo-wang/fetcher-openapi';
+/**
+ * The path of a client module of an aggregate, relative to the output
+ * directory: `<contextAlias>/<aggregateName>/<fileName>.ts`.
+ *
+ * @param aggregate - The aggregate metadata containing context alias and aggregate name
+ * @param fileName - The name of the file, without extension
+ *
+ * @example
+ * ```typescript
+ * clientModulePath({ contextAlias: 'user', aggregateName: 'profile' }, 'queryClient');
+ * // 'user/profile/queryClient.ts'
+ * ```
+ */
+export declare function clientModulePath(aggregate: Pick<TagAliasAggregate, 'contextAlias' | 'aggregateName'>, fileName: string): string;
+/**
+ * The name of a class or type of an aggregate: its name as a type, then the
+ * suffix (`order`, `CommandClient` → `OrderCommandClient`).
+ */
+export declare function resolveClassName(aggregate: Pick<TagAliasAggregate, 'aggregateName'>, suffix: string): string;
+/** Operation extension naming the method an operation generates. */
+export declare const OPERATION_METHOD_NAME_KEY = "x-fetcher-method";
+/**
+ * Names the method an operation generates.
+ *
+ * The name depends on the operation alone, so adding an operation never
+ * renames an existing method:
+ *
+ * 1. a name configured for the operationId (`apiClients[tag].methodNames`);
+ * 2. else the operation's `x-fetcher-method` extension;
+ * 3. else the last dot-separated segment of the operationId, camel-cased:
+ *    `getUserById` → `getUserById`, `delete_user_by_id` → `deleteUserById`,
+ *    `getUser_1` → `getUser1`, `users.list` → `list`,
+ *    `example.cart.add_cart_item` → `addCartItem`; a name starting with a
+ *    digit is prefixed with `_`.
+ *
+ * Two operations of one client that arrive at the same name are an error the
+ * caller reports; the first two sources resolve it.
+ *
+ * @param operation - The OpenAPI operation
+ * @param configured - The name configured for its operationId, if any
+ * @returns The method name, or undefined for an operation without an operationId
+ * @throws GeneratorError when a configured or extension name is not a valid method name
+ */
+export declare function resolveMethodName(operation: Operation, configured?: string): string | undefined;
+/**
+ * Turns a parameter name from the document into a unique parameter
+ * identifier: `item-id` → `itemId`, and `id` twice → `id`, `id2`.
+ *
+ * @param name - The name the document uses
+ * @param used - The identifiers the method already uses; updated
+ * @returns The identifier
+ */
+export declare function uniqueParameterName(name: string, used: Set<string>): string;

package/dist/analysis/clientNames.d.ts

@@ -0,0 +1,55 @@
+import { TagAliasAggregate } from '../wow/model.js';
+import { Operation } from '@ahoo-wang/fetcher-openapi';
+/**
+ * The path of a client module of an aggregate, relative to the output
+ * directory: `<contextAlias>/<aggregateName>/<fileName>.ts`.
+ *
+ * @param aggregate - The aggregate metadata containing context alias and aggregate name
+ * @param fileName - The name of the file, without extension
+ *
+ * @example
+ * ```typescript
+ * clientModulePath({ contextAlias: 'user', aggregateName: 'profile' }, 'queryClient');
+ * // 'user/profile/queryClient.ts'
+ * ```
+ */
+export declare function clientModulePath(aggregate: Pick<TagAliasAggregate, 'contextAlias' | 'aggregateName'>, fileName: string): string;
+/**
+ * The name of a class or type of an aggregate: its name as a type, then the
+ * suffix (`order`, `CommandClient` → `OrderCommandClient`).
+ */
+export declare function resolveClassName(aggregate: Pick<TagAliasAggregate, 'aggregateName'>, suffix: string): string;
+/** Operation extension naming the method an operation generates. */
+export declare const OPERATION_METHOD_NAME_KEY = "x-fetcher-method";
+/**
+ * Names the method an operation generates.
+ *
+ * The name depends on the operation alone, so adding an operation never
+ * renames an existing method:
+ *
+ * 1. a name configured for the operationId (`apiClients[tag].methodNames`);
+ * 2. else the operation's `x-fetcher-method` extension;
+ * 3. else the last dot-separated segment of the operationId, camel-cased:
+ *    `getUserById` → `getUserById`, `delete_user_by_id` → `deleteUserById`,
+ *    `getUser_1` → `getUser1`, `users.list` → `list`,
+ *    `example.cart.add_cart_item` → `addCartItem`; a name starting with a
+ *    digit is prefixed with `_`.
+ *
+ * Two operations of one client that arrive at the same name are an error the
+ * caller reports; the first two sources resolve it.
+ *
+ * @param operation - The OpenAPI operation
+ * @param configured - The name configured for its operationId, if any
+ * @returns The method name, or undefined for an operation without an operationId
+ * @throws GeneratorError when a configured or extension name is not a valid method name
+ */
+export declare function resolveMethodName(operation: Operation, configured?: string): string | undefined;
+/**
+ * Turns a parameter name from the document into a unique parameter
+ * identifier: `item-id` → `itemId`, and `id` twice → `id`, `id2`.
+ *
+ * @param name - The name the document uses
+ * @param used - The identifiers the method already uses; updated
+ * @returns The identifier
+ */
+export declare function uniqueParameterName(name: string, used: Set<string>): string;

package/dist/analysis/model.d.cts

@@ -0,0 +1,212 @@
+import { HTTPMethod, Reference, Schema } from '@ahoo-wang/fetcher-openapi';
+import { ModelInfo } from '../naming/modelInfo.cjs';
+/**
+ * What a document generates, decided before anything is written: every
+ * name, file, parameter and kind of body or response, as plain data. It
+ * holds no ts-morph node and no operation of the document; the emitters read
+ * it, and only they resolve schemas to types, in this order, so the imports
+ * of each module come out the way they always have.
+ *
+ * Files are relative to the output directory.
+ */
+export interface GenerationModel {
+    /** The bounded contexts, each a file declaring its alias constant; sorted. */
+    readonly contexts: readonly BoundedContextModel[];
+    /** The models, in the order of the document's components. */
+    readonly models: readonly ModelDeclaration[];
+    /** The aggregates with a command and a query client, by bounded context. */
+    readonly aggregates: readonly AggregateModel[];
+    /** The API clients, one per tag, sorted by tag name. */
+    readonly apiClients: readonly ApiClientModel[];
+}
+/** What a generation decided, and the warnings it gave on the way. */
+export interface Analysis {
+    readonly model: GenerationModel;
+    /** One line each, in the order they arose. */
+    readonly warnings: readonly string[];
+}
+/** A bounded context's alias constant: `export const SHOP_BOUNDED_CONTEXT_ALIAS = 'shop';`. */
+export interface BoundedContextModel {
+    readonly alias: string;
+    readonly constantName: string;
+    readonly file: string;
+}
+/** The constant a module imports to name its bounded context. */
+export interface ContextReference {
+    readonly alias: string;
+    readonly constantName: string;
+}
+/** A model: one declaration (and its companions) of a component schema. */
+export interface ModelDeclaration {
+    /** The component key. */
+    readonly key: string;
+    /** Its name, and the package path of its file. */
+    readonly info: ModelInfo;
+    readonly file: string;
+    /** The schema as the document has it; the types read this one. */
+    readonly schema: Schema | Reference;
+    /**
+     * The schema its doc comment reads: with the title and description the
+     * Wow metadata lends it over it, when it lends any.
+     */
+    readonly docSchema: Schema | Reference;
+    /**
+     * A command or event body that declares nothing - a Kotlin `data object` -
+     * which generates `Record<string, never>` rather than any object.
+     */
+    readonly emptyMessageBody: boolean;
+}
+/** An aggregate: its command client and its query client. */
+export interface AggregateModel {
+    readonly contextAlias: string;
+    readonly aggregateName: string;
+    readonly context: ContextReference;
+    readonly commandClient: CommandClientModel;
+    readonly queryClient: QueryClientModel;
+}
+/** The command client of an aggregate, and its streaming twin. */
+export interface CommandClientModel {
+    readonly file: string;
+    /** The enum of the command routes: `CartCommandEndpointPaths`. */
+    readonly endpointPathsName: string;
+    readonly className: string;
+    readonly streamClassName: string;
+    readonly commands: readonly CommandModel[];
+}
+/** A command of an aggregate. */
+export interface CommandModel {
+    /** The command's route, and the member of the route enum that holds it. */
+    readonly path: string;
+    readonly endpointMember: string;
+    readonly httpMethod: HTTPMethod;
+    readonly methodName: string;
+    /**
+     * The alias of the command's body type: `AddCartItemCommand`. None when
+     * the body's name already ends in `Command`: its methods then take
+     * `CommandBody<MountedCommand>` itself, so no name repeats the suffix.
+     */
+    readonly typeName?: string;
+    /** The body's model; one of Wow's own lives in wow-client, with its type. */
+    readonly body: ModelInfo;
+    /** The component key of the body's schema. */
+    readonly bodyKey: string;
+    /** The body's properties a caller may leave out. */
+    readonly optionalFields: readonly string[];
+    /** Whether a request may leave out the body: it has no properties. */
+    readonly requestOptional: boolean;
+    /** The path parameters the caller passes. */
+    readonly pathParameters: readonly PathParameterModel[];
+    readonly docs: readonly (string | undefined)[];
+}
+/** A path parameter of a command method, in the order the route holds them. */
+export interface PathParameterModel {
+    /** The method's parameter: an identifier. */
+    readonly name: string;
+    /** The name in the route. */
+    readonly pathName: string;
+    readonly type: string;
+}
+/** The query client factory of an aggregate. */
+export interface QueryClientModel {
+    readonly file: string;
+    /** The aggregate's route segment: its resource name. */
+    readonly resourceName: string;
+    /** A `ResourceAttributionPathSpec` member, as code. */
+    readonly resourceAttribution: string;
+    readonly state: ModelInfo;
+    readonly fields: ModelInfo;
+    /** The enum of the event titles: `CartDomainEventTypeMapTitle`. */
+    readonly eventTitlesName: string;
+    /** The union of the event types: `CartDomainEventType`. */
+    readonly eventTypeName: string;
+    readonly events: readonly EventModel[];
+    readonly factoryName: string;
+}
+/** A domain event of an aggregate. */
+export interface EventModel {
+    /** Its member of the event title enum. */
+    readonly memberName: string;
+    readonly title: string;
+    readonly body: ModelInfo;
+}
+/** The API client of a tag. */
+export interface ApiClientModel {
+    readonly tagName: string;
+    readonly className: string;
+    readonly file: string;
+    /** The tag's description, the class's doc comment. */
+    readonly description?: string;
+    /** The bounded context whose alias is the base path, in a Wow document. */
+    readonly basePath?: ContextReference;
+    /** In the order of the document's operations, by operation id. */
+    readonly methods: readonly ApiMethodModel[];
+}
+/** A method of an API client: one operation. */
+export interface ApiMethodModel {
+    readonly name: string;
+    readonly httpMethod: HTTPMethod;
+    readonly path: string;
+    /**
+     * The path, query and header parameters, in the order the types resolve:
+     * path, then query, then header, each in document order. The method takes
+     * the required ones first, then the body if required, then the optional
+     * ones, then the body if optional.
+     */
+    readonly parameters: readonly ParameterModel[];
+    readonly body?: BodyModel;
+    readonly returns: ReturnModel;
+    readonly docs: readonly (string | undefined)[];
+}
+/** A path, query or header parameter of an API method. */
+export interface ParameterModel {
+    /** The method's parameter: an identifier. */
+    readonly name: string;
+    readonly location: 'path' | 'query' | 'header';
+    /** The name the request uses. */
+    readonly parameterName: string;
+    /** Its schema; a parameter without one is a string. */
+    readonly schema?: Schema | Reference;
+    readonly required: boolean;
+}
+/** The request body of an API method. */
+export interface BodyModel {
+    /** The method's parameter: `body`, unless a parameter took the name. */
+    readonly name: string;
+    readonly required: boolean;
+    readonly content: BodyContent;
+}
+/**
+ * What a body holds:
+ *
+ * - `json`: the schema's type, with the properties the schema does not
+ *   require optional (`PartialBy<Item, 'id'>`);
+ * - `formData`: `FormData`; `urlEncoded`: `URLSearchParams`;
+ * - `text`: a string; `binary`: whatever a fetch request accepts.
+ */
+export type BodyContent = {
+    readonly kind: 'json';
+    readonly schema: Schema | Reference;
+    readonly optionalFields: readonly string[];
+} | {
+    readonly kind: 'formData' | 'urlEncoded' | 'text' | 'binary';
+};
+/**
+ * What an API method returns, read from its success response:
+ *
+ * - `json`: the schema's type; a response of any media type (`wildcard`)
+ *   whose schema resolves to `string` is text;
+ * - `eventStream`: a JSON server-sent event stream of the items' type, the
+ *   `data` of a `ServerSentEvent` model, or of anything without one;
+ * - `text`: a string; `response`: the raw `Response`.
+ */
+export type ReturnModel = {
+    readonly kind: 'json';
+    readonly schema: Schema | Reference;
+    readonly wildcard: boolean;
+} | {
+    readonly kind: 'eventStream';
+    readonly items?: Reference;
+    readonly serverSentEvent: boolean;
+} | {
+    readonly kind: 'text' | 'response';
+};

package/dist/analysis/model.d.ts

@@ -0,0 +1,212 @@
+import { HTTPMethod, Reference, Schema } from '@ahoo-wang/fetcher-openapi';
+import { ModelInfo } from '../naming/modelInfo.js';
+/**
+ * What a document generates, decided before anything is written: every
+ * name, file, parameter and kind of body or response, as plain data. It
+ * holds no ts-morph node and no operation of the document; the emitters read
+ * it, and only they resolve schemas to types, in this order, so the imports
+ * of each module come out the way they always have.
+ *
+ * Files are relative to the output directory.
+ */
+export interface GenerationModel {
+    /** The bounded contexts, each a file declaring its alias constant; sorted. */
+    readonly contexts: readonly BoundedContextModel[];
+    /** The models, in the order of the document's components. */
+    readonly models: readonly ModelDeclaration[];
+    /** The aggregates with a command and a query client, by bounded context. */
+    readonly aggregates: readonly AggregateModel[];
+    /** The API clients, one per tag, sorted by tag name. */
+    readonly apiClients: readonly ApiClientModel[];
+}
+/** What a generation decided, and the warnings it gave on the way. */
+export interface Analysis {
+    readonly model: GenerationModel;
+    /** One line each, in the order they arose. */
+    readonly warnings: readonly string[];
+}
+/** A bounded context's alias constant: `export const SHOP_BOUNDED_CONTEXT_ALIAS = 'shop';`. */
+export interface BoundedContextModel {
+    readonly alias: string;
+    readonly constantName: string;
+    readonly file: string;
+}
+/** The constant a module imports to name its bounded context. */
+export interface ContextReference {
+    readonly alias: string;
+    readonly constantName: string;
+}
+/** A model: one declaration (and its companions) of a component schema. */
+export interface ModelDeclaration {
+    /** The component key. */
+    readonly key: string;
+    /** Its name, and the package path of its file. */
+    readonly info: ModelInfo;
+    readonly file: string;
+    /** The schema as the document has it; the types read this one. */
+    readonly schema: Schema | Reference;
+    /**
+     * The schema its doc comment reads: with the title and description the
+     * Wow metadata lends it over it, when it lends any.
+     */
+    readonly docSchema: Schema | Reference;
+    /**
+     * A command or event body that declares nothing - a Kotlin `data object` -
+     * which generates `Record<string, never>` rather than any object.
+     */
+    readonly emptyMessageBody: boolean;
+}
+/** An aggregate: its command client and its query client. */
+export interface AggregateModel {
+    readonly contextAlias: string;
+    readonly aggregateName: string;
+    readonly context: ContextReference;
+    readonly commandClient: CommandClientModel;
+    readonly queryClient: QueryClientModel;
+}
+/** The command client of an aggregate, and its streaming twin. */
+export interface CommandClientModel {
+    readonly file: string;
+    /** The enum of the command routes: `CartCommandEndpointPaths`. */
+    readonly endpointPathsName: string;
+    readonly className: string;
+    readonly streamClassName: string;
+    readonly commands: readonly CommandModel[];
+}
+/** A command of an aggregate. */
+export interface CommandModel {
+    /** The command's route, and the member of the route enum that holds it. */
+    readonly path: string;
+    readonly endpointMember: string;
+    readonly httpMethod: HTTPMethod;
+    readonly methodName: string;
+    /**
+     * The alias of the command's body type: `AddCartItemCommand`. None when
+     * the body's name already ends in `Command`: its methods then take
+     * `CommandBody<MountedCommand>` itself, so no name repeats the suffix.
+     */
+    readonly typeName?: string;
+    /** The body's model; one of Wow's own lives in wow-client, with its type. */
+    readonly body: ModelInfo;
+    /** The component key of the body's schema. */
+    readonly bodyKey: string;
+    /** The body's properties a caller may leave out. */
+    readonly optionalFields: readonly string[];
+    /** Whether a request may leave out the body: it has no properties. */
+    readonly requestOptional: boolean;
+    /** The path parameters the caller passes. */
+    readonly pathParameters: readonly PathParameterModel[];
+    readonly docs: readonly (string | undefined)[];
+}
+/** A path parameter of a command method, in the order the route holds them. */
+export interface PathParameterModel {
+    /** The method's parameter: an identifier. */
+    readonly name: string;
+    /** The name in the route. */
+    readonly pathName: string;
+    readonly type: string;
+}
+/** The query client factory of an aggregate. */
+export interface QueryClientModel {
+    readonly file: string;
+    /** The aggregate's route segment: its resource name. */
+    readonly resourceName: string;
+    /** A `ResourceAttributionPathSpec` member, as code. */
+    readonly resourceAttribution: string;
+    readonly state: ModelInfo;
+    readonly fields: ModelInfo;
+    /** The enum of the event titles: `CartDomainEventTypeMapTitle`. */
+    readonly eventTitlesName: string;
+    /** The union of the event types: `CartDomainEventType`. */
+    readonly eventTypeName: string;
+    readonly events: readonly EventModel[];
+    readonly factoryName: string;
+}
+/** A domain event of an aggregate. */
+export interface EventModel {
+    /** Its member of the event title enum. */
+    readonly memberName: string;
+    readonly title: string;
+    readonly body: ModelInfo;
+}
+/** The API client of a tag. */
+export interface ApiClientModel {
+    readonly tagName: string;
+    readonly className: string;
+    readonly file: string;
+    /** The tag's description, the class's doc comment. */
+    readonly description?: string;
+    /** The bounded context whose alias is the base path, in a Wow document. */
+    readonly basePath?: ContextReference;
+    /** In the order of the document's operations, by operation id. */
+    readonly methods: readonly ApiMethodModel[];
+}
+/** A method of an API client: one operation. */
+export interface ApiMethodModel {
+    readonly name: string;
+    readonly httpMethod: HTTPMethod;
+    readonly path: string;
+    /**
+     * The path, query and header parameters, in the order the types resolve:
+     * path, then query, then header, each in document order. The method takes
+     * the required ones first, then the body if required, then the optional
+     * ones, then the body if optional.
+     */
+    readonly parameters: readonly ParameterModel[];
+    readonly body?: BodyModel;
+    readonly returns: ReturnModel;
+    readonly docs: readonly (string | undefined)[];
+}
+/** A path, query or header parameter of an API method. */
+export interface ParameterModel {
+    /** The method's parameter: an identifier. */
+    readonly name: string;
+    readonly location: 'path' | 'query' | 'header';
+    /** The name the request uses. */
+    readonly parameterName: string;
+    /** Its schema; a parameter without one is a string. */
+    readonly schema?: Schema | Reference;
+    readonly required: boolean;
+}
+/** The request body of an API method. */
+export interface BodyModel {
+    /** The method's parameter: `body`, unless a parameter took the name. */
+    readonly name: string;
+    readonly required: boolean;
+    readonly content: BodyContent;
+}
+/**
+ * What a body holds:
+ *
+ * - `json`: the schema's type, with the properties the schema does not
+ *   require optional (`PartialBy<Item, 'id'>`);
+ * - `formData`: `FormData`; `urlEncoded`: `URLSearchParams`;
+ * - `text`: a string; `binary`: whatever a fetch request accepts.
+ */
+export type BodyContent = {
+    readonly kind: 'json';
+    readonly schema: Schema | Reference;
+    readonly optionalFields: readonly string[];
+} | {
+    readonly kind: 'formData' | 'urlEncoded' | 'text' | 'binary';
+};
+/**
+ * What an API method returns, read from its success response:
+ *
+ * - `json`: the schema's type; a response of any media type (`wildcard`)
+ *   whose schema resolves to `string` is text;
+ * - `eventStream`: a JSON server-sent event stream of the items' type, the
+ *   `data` of a `ServerSentEvent` model, or of anything without one;
+ * - `text`: a string; `response`: the raw `Response`.
+ */
+export type ReturnModel = {
+    readonly kind: 'json';
+    readonly schema: Schema | Reference;
+    readonly wildcard: boolean;
+} | {
+    readonly kind: 'eventStream';
+    readonly items?: Reference;
+    readonly serverSentEvent: boolean;
+} | {
+    readonly kind: 'text' | 'response';
+};

package/dist/analysis/modelInfo.d.cts

@@ -0,0 +1,23 @@
+import { Components, Reference, Schema } from '@ahoo-wang/fetcher-openapi';
+import { ModelInfo } from '../naming/modelInfo.cjs';
+export type { ModelInfo } from '../naming/modelInfo.cjs';
+/**
+ * Resolves model information from a schema key.
+ *
+ * This function parses a dot-separated schema key and extracts the model name and path.
+ * It assumes that the model name is the first part that starts with an uppercase letter.
+ * All parts before the model name are treated as the path.
+ *
+ * @example
+ *
+ * - "wow.api.BindingError" -> {path:'/wow/api',name:'BindingError'}
+ * - "compensation.ApiVersion" -> {path:'/compensation',name:'ApiVersion'}
+ * - "ai.AiMessage.Assistant" -> {path:'/ai',name:'AiMessageAssistant'}
+ * - "Result" -> {path:'/',name:'Result'}
+ *
+ * @param schemaKey - The dot-separated schema key (e.g., "com.example.User")
+ * @returns ModelInfo object containing the parsed name and path
+ */
+export declare function resolveModelInfo(schemaKey: string, schema?: Schema): ModelInfo;
+export declare function resolveReferenceModelInfo(reference: Reference, components?: Components): ModelInfo;
+export declare function resolveContextDeclarationName(contextAlias: string): string;

package/dist/analysis/modelInfo.d.ts

@@ -0,0 +1,23 @@
+import { Components, Reference, Schema } from '@ahoo-wang/fetcher-openapi';
+import { ModelInfo } from '../naming/modelInfo.js';
+export type { ModelInfo } from '../naming/modelInfo.js';
+/**
+ * Resolves model information from a schema key.
+ *
+ * This function parses a dot-separated schema key and extracts the model name and path.
+ * It assumes that the model name is the first part that starts with an uppercase letter.
+ * All parts before the model name are treated as the path.
+ *
+ * @example
+ *
+ * - "wow.api.BindingError" -> {path:'/wow/api',name:'BindingError'}
+ * - "compensation.ApiVersion" -> {path:'/compensation',name:'ApiVersion'}
+ * - "ai.AiMessage.Assistant" -> {path:'/ai',name:'AiMessageAssistant'}
+ * - "Result" -> {path:'/',name:'Result'}
+ *
+ * @param schemaKey - The dot-separated schema key (e.g., "com.example.User")
+ * @returns ModelInfo object containing the parsed name and path
+ */
+export declare function resolveModelInfo(schemaKey: string, schema?: Schema): ModelInfo;
+export declare function resolveReferenceModelInfo(reference: Reference, components?: Components): ModelInfo;
+export declare function resolveContextDeclarationName(contextAlias: string): string;

package/dist/analysis/models.d.cts

@@ -0,0 +1,17 @@
+import { OpenApiDocument } from '../openapi/document.cjs';
+import { WowModel } from '../wow/model.cjs';
+import { BoundedContextModel, ModelDeclaration } from './model.cjs';
+/**
+ * The bounded contexts whose alias constant is generated: every context with
+ * aggregates, and the document's own, which API clients take their base path
+ * from. Sorted by alias.
+ */
+export declare function analyzeContexts(wow: WowModel): BoundedContextModel[];
+/**
+ * The models of a document: one per component schema, in the document's
+ * order, but for Wow's own schemas, which wow-client declares (`wow.*`, and
+ * the types every aggregate derives from its state).
+ *
+ * @throws GeneratorError when two schemas generate the same model
+ */
+export declare function analyzeModels(document: OpenApiDocument, wow: WowModel): ModelDeclaration[];

package/dist/analysis/models.d.ts

@@ -0,0 +1,17 @@
+import { OpenApiDocument } from '../openapi/document.js';
+import { WowModel } from '../wow/model.js';
+import { BoundedContextModel, ModelDeclaration } from './model.js';
+/**
+ * The bounded contexts whose alias constant is generated: every context with
+ * aggregates, and the document's own, which API clients take their base path
+ * from. Sorted by alias.
+ */
+export declare function analyzeContexts(wow: WowModel): BoundedContextModel[];
+/**
+ * The models of a document: one per component schema, in the document's
+ * order, but for Wow's own schemas, which wow-client declares (`wow.*`, and
+ * the types every aggregate derives from its state).
+ *
+ * @throws GeneratorError when two schemas generate the same model
+ */
+export declare function analyzeModels(document: OpenApiDocument, wow: WowModel): ModelDeclaration[];

package/dist/api/configuration.d.cts

@@ -0,0 +1,30 @@
+/**
+ * Where the generator looks for its configuration when none is named.
+ */
+export declare const DEFAULT_CONFIG_PATH = "./wow-generator.config.json";
+/**
+ * The generator configuration, read from {@link DEFAULT_CONFIG_PATH} or the
+ * path `GeneratorOptions.configPath` names.
+ */
+export interface GeneratorConfiguration {
+    /**
+     * tag name -> api client configuration
+     */
+    apiClients?: Record<string, ApiClientConfiguration>;
+}
+export interface ApiClientConfiguration {
+    /**
+     * The path parameters the client leaves out, because an interceptor fills
+     * them.
+     *
+     * Default: `['tenantId', 'ownerId']` for a Wow document (one with
+     * `x-wow-context-alias` or aggregates), whose CoSec interceptor fills them;
+     * none for any other document.
+     */
+    ignorePathParameters?: string[];
+    /**
+     * Method names by operationId, overriding the name derived from it. Use it
+     * when two operations of one tag derive the same name.
+     */
+    methodNames?: Record<string, string>;
+}