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

package/dist/emitters/emit.d.cts

@@ -0,0 +1,15 @@
+import { GenerationModel } from '../analysis/model.cjs';
+import { EmitTarget } from './target.cjs';
+/**
+ * Describes every file of a generation to its module: the bounded contexts,
+ * the models, the query and command clients of each aggregate, then the API
+ * clients. Nothing reaches a source file until the modules are built.
+ *
+ * The order is the one the files have always been written in, so the
+ * imports of a module, and the aliases a name clash gives them, come out
+ * the same.
+ *
+ * @param model - What the document generates
+ * @param target - Where it is written
+ */
+export declare function emitGeneration(model: GenerationModel, target: EmitTarget): void;

package/dist/emitters/emit.d.ts

@@ -0,0 +1,15 @@
+import { GenerationModel } from '../analysis/model.js';
+import { EmitTarget } from './target.js';
+/**
+ * Describes every file of a generation to its module: the bounded contexts,
+ * the models, the query and command clients of each aggregate, then the API
+ * clients. Nothing reaches a source file until the modules are built.
+ *
+ * The order is the one the files have always been written in, so the
+ * imports of a module, and the aliases a name clash gives them, come out
+ * the same.
+ *
+ * @param model - What the document generates
+ * @param target - Where it is written
+ */
+export declare function emitGeneration(model: GenerationModel, target: EmitTarget): void;

package/dist/emitters/indexFiles.d.cts

@@ -0,0 +1,12 @@
+import { Directory, SourceFile } from 'ts-morph';
+/**
+ * Writes an `index.ts` into the output directory and each directory under
+ * it, re-exporting its files and the indexes of its subdirectories.
+ *
+ * @param outputDir - The output directory, holding the files written
+ * @param claim - Returns the index file of a directory, emptied and claimed
+ * for the generation
+ * @returns A warning for every name an index leaves out because two of its
+ * children export it
+ */
+export declare function emitIndexFiles(outputDir: Directory, claim: (directoryPath: string) => SourceFile): string[];

package/dist/emitters/indexFiles.d.ts

@@ -0,0 +1,12 @@
+import { Directory, SourceFile } from 'ts-morph';
+/**
+ * Writes an `index.ts` into the output directory and each directory under
+ * it, re-exporting its files and the indexes of its subdirectories.
+ *
+ * @param outputDir - The output directory, holding the files written
+ * @param claim - Returns the index file of a directory, emptied and claimed
+ * for the generation
+ * @returns A warning for every name an index leaves out because two of its
+ * children export it
+ */
+export declare function emitIndexFiles(outputDir: Directory, claim: (directoryPath: string) => SourceFile): string[];

package/dist/emitters/models.d.cts

@@ -0,0 +1,77 @@
+import { Components, Reference, Schema } from '@ahoo-wang/fetcher-openapi';
+import { ModelDeclaration } from '../analysis/model.cjs';
+import { ModuleBuilder } from '../emit/moduleBuilder.cjs';
+import { TypeContext } from '../types/typeResolver.cjs';
+import { EmitTarget } from './target.cjs';
+/**
+ * The type context of a document: its components, named the way the
+ * generator names models. Build it once per generation and share it, so the
+ * model names of each path are read once.
+ *
+ * @param components - The document's components
+ */
+export declare function documentTypeContext(components?: Components): TypeContext;
+/**
+ * Writes a model into the `types.ts` of its package: an interface, an enum or
+ * a type alias, with its doc comment, and imports the models it uses.
+ *
+ * @param declaration - The model
+ * @param target - Where it is written
+ */
+export declare function emitModel(declaration: ModelDeclaration, target: EmitTarget): void;
+/**
+ * Names the members of an enum. Each value takes its UPPER_SNAKE_CASE form;
+ * when another value already took that form - `in-progress`, `IN_PROGRESS`
+ * and `inProgress` all give `IN_PROGRESS` - it takes its own value as a
+ * quoted member name, or else a numbered form.
+ *
+ * @param values - The distinct values, in document order
+ * @returns The member name of each value, quoted where it has to be
+ */
+export declare function uniqueEnumMemberNames(values: readonly string[]): Map<string, string>;
+/** The model a {@link ModelEmitter} writes. */
+export type ModelSource = Pick<ModelDeclaration, 'key' | 'info' | 'schema' | 'docSchema'>;
+/**
+ * Writes one model into a module: the declaration its schema calls for,
+ * with the model's doc comment.
+ */
+export declare class ModelEmitter {
+    private readonly model;
+    readonly module: ModuleBuilder;
+    private readonly target;
+    private readonly modelInfo;
+    private readonly components?;
+    /**
+     * @param model - The model
+     * @param module - The module the model is written into, which also
+     * receives its imports
+     * @param target - The output directory, the document's type context and
+     * how much of the schema the doc comment carries
+     */
+    constructor(model: ModelSource, module: ModuleBuilder, target: Pick<EmitTarget, 'outputDir' | 'types' | 'schemaDocs'>);
+    /** Writes the model's declaration and its doc comment. */
+    write(): void;
+    private process;
+    /** Where the types of this model are written. */
+    private readonly scope;
+    /** Applies the imports a resolved type needs to the module. */
+    private emit;
+    /** The type a schema generates in this model's module, its imports added. */
+    resolveType(schema: Schema | Reference): string;
+    private processEnum;
+    /**
+     * Adds a declared property. Property names are distinct, and
+     * `resolvePropertyName` keeps them distinct: a name is kept or quoted.
+     */
+    private addPropertyToInterface;
+    private processInterface;
+    private processArray;
+    /**
+     * A string-keyed map is an interface with an index signature rather than an
+     * alias of `Record`: an alias may not reference itself through `Record`
+     * (TS2456), and a map of its own type - a tree of dictionaries - does.
+     */
+    private processIndexSignature;
+    private processComposition;
+    private processTypeAlias;
+}

package/dist/emitters/models.d.ts

@@ -0,0 +1,77 @@
+import { Components, Reference, Schema } from '@ahoo-wang/fetcher-openapi';
+import { ModelDeclaration } from '../analysis/model.js';
+import { ModuleBuilder } from '../emit/moduleBuilder.js';
+import { TypeContext } from '../types/typeResolver.js';
+import { EmitTarget } from './target.js';
+/**
+ * The type context of a document: its components, named the way the
+ * generator names models. Build it once per generation and share it, so the
+ * model names of each path are read once.
+ *
+ * @param components - The document's components
+ */
+export declare function documentTypeContext(components?: Components): TypeContext;
+/**
+ * Writes a model into the `types.ts` of its package: an interface, an enum or
+ * a type alias, with its doc comment, and imports the models it uses.
+ *
+ * @param declaration - The model
+ * @param target - Where it is written
+ */
+export declare function emitModel(declaration: ModelDeclaration, target: EmitTarget): void;
+/**
+ * Names the members of an enum. Each value takes its UPPER_SNAKE_CASE form;
+ * when another value already took that form - `in-progress`, `IN_PROGRESS`
+ * and `inProgress` all give `IN_PROGRESS` - it takes its own value as a
+ * quoted member name, or else a numbered form.
+ *
+ * @param values - The distinct values, in document order
+ * @returns The member name of each value, quoted where it has to be
+ */
+export declare function uniqueEnumMemberNames(values: readonly string[]): Map<string, string>;
+/** The model a {@link ModelEmitter} writes. */
+export type ModelSource = Pick<ModelDeclaration, 'key' | 'info' | 'schema' | 'docSchema'>;
+/**
+ * Writes one model into a module: the declaration its schema calls for,
+ * with the model's doc comment.
+ */
+export declare class ModelEmitter {
+    private readonly model;
+    readonly module: ModuleBuilder;
+    private readonly target;
+    private readonly modelInfo;
+    private readonly components?;
+    /**
+     * @param model - The model
+     * @param module - The module the model is written into, which also
+     * receives its imports
+     * @param target - The output directory, the document's type context and
+     * how much of the schema the doc comment carries
+     */
+    constructor(model: ModelSource, module: ModuleBuilder, target: Pick<EmitTarget, 'outputDir' | 'types' | 'schemaDocs'>);
+    /** Writes the model's declaration and its doc comment. */
+    write(): void;
+    private process;
+    /** Where the types of this model are written. */
+    private readonly scope;
+    /** Applies the imports a resolved type needs to the module. */
+    private emit;
+    /** The type a schema generates in this model's module, its imports added. */
+    resolveType(schema: Schema | Reference): string;
+    private processEnum;
+    /**
+     * Adds a declared property. Property names are distinct, and
+     * `resolvePropertyName` keeps them distinct: a name is kept or quoted.
+     */
+    private addPropertyToInterface;
+    private processInterface;
+    private processArray;
+    /**
+     * A string-keyed map is an interface with an index signature rather than an
+     * alias of `Record`: an alias may not reference itself through `Record`
+     * (TS2456), and a map of its own type - a tree of dictionaries - does.
+     */
+    private processIndexSignature;
+    private processComposition;
+    private processTypeAlias;
+}

package/dist/emitters/queryClients.d.cts

@@ -0,0 +1,11 @@
+import { AggregateModel } from '../analysis/model.cjs';
+import { EmitTarget } from './target.cjs';
+/**
+ * Writes the query client of an aggregate: the enum of its event titles, the
+ * union of its event types, and the factory of its snapshot and event
+ * stream query clients.
+ *
+ * @param aggregate - The aggregate
+ * @param target - Where it is written
+ */
+export declare function emitQueryClient(aggregate: AggregateModel, target: EmitTarget): void;

package/dist/emitters/queryClients.d.ts

@@ -0,0 +1,11 @@
+import { AggregateModel } from '../analysis/model.js';
+import { EmitTarget } from './target.js';
+/**
+ * Writes the query client of an aggregate: the enum of its event titles, the
+ * union of its event types, and the factory of its snapshot and event
+ * stream query clients.
+ *
+ * @param aggregate - The aggregate
+ * @param target - Where it is written
+ */
+export declare function emitQueryClient(aggregate: AggregateModel, target: EmitTarget): void;

package/dist/emitters/target.d.cts

@@ -0,0 +1,14 @@
+import { SchemaDocs } from '../api/options.cjs';
+import { ModuleSet } from '../emit/moduleBuilder.cjs';
+import { TypeContext } from '../types/typeResolver.cjs';
+/** Where the emitters write, and what every module of a run shares. */
+export interface EmitTarget {
+    /** The module of each file, claimed from the output the first time asked. */
+    readonly modules: ModuleSet;
+    /** The output directory, which relative imports are computed under. */
+    readonly outputDir: string;
+    /** What every schema of the document resolves against. */
+    readonly types: TypeContext;
+    /** How much of each schema a model's doc comment carries. */
+    readonly schemaDocs: SchemaDocs;
+}

package/dist/emitters/target.d.ts

@@ -0,0 +1,14 @@
+import { SchemaDocs } from '../api/options.js';
+import { ModuleSet } from '../emit/moduleBuilder.js';
+import { TypeContext } from '../types/typeResolver.js';
+/** Where the emitters write, and what every module of a run shares. */
+export interface EmitTarget {
+    /** The module of each file, claimed from the output the first time asked. */
+    readonly modules: ModuleSet;
+    /** The output directory, which relative imports are computed under. */
+    readonly outputDir: string;
+    /** What every schema of the document resolves against. */
+    readonly types: TypeContext;
+    /** How much of each schema a model's doc comment carries. */
+    readonly schemaDocs: SchemaDocs;
+}

package/dist/finalize/finalize.d.cts

@@ -0,0 +1,16 @@
+import { SourceFile } from 'ts-morph';
+import { Logger } from '../api/logger.cjs';
+/**
+ * Finishes the files a generation wrote: formats them, organizes and types
+ * their imports, checks that the result declares or imports every name it
+ * uses, and adds the generated-file header.
+ *
+ * Imports are written explicitly while generating, never inferred from
+ * whatever the output directory happens to resolve, so the output is the
+ * same wherever it is written.
+ *
+ * @param sourceFiles - The files to finish, each written by this generation
+ * @param logger - Receives a debug line for each file
+ * @throws Error listing each diagnostic when the code does not compile
+ */
+export declare function finalizeSourceFiles(sourceFiles: readonly SourceFile[], logger: Logger): void;

package/dist/finalize/finalize.d.ts

@@ -0,0 +1,16 @@
+import { SourceFile } from 'ts-morph';
+import { Logger } from '../api/logger.js';
+/**
+ * Finishes the files a generation wrote: formats them, organizes and types
+ * their imports, checks that the result declares or imports every name it
+ * uses, and adds the generated-file header.
+ *
+ * Imports are written explicitly while generating, never inferred from
+ * whatever the output directory happens to resolve, so the output is the
+ * same wherever it is written.
+ *
+ * @param sourceFiles - The files to finish, each written by this generation
+ * @param logger - Receives a debug line for each file
+ * @throws Error listing each diagnostic when the code does not compile
+ */
+export declare function finalizeSourceFiles(sourceFiles: readonly SourceFile[], logger: Logger): void;

package/dist/finalize/typeOnlyImports.d.cts

@@ -0,0 +1,13 @@
+import { SourceFile } from 'ts-morph';
+/**
+ * Rewrites named imports by how each file uses them, as
+ * `@typescript-eslint/consistent-type-imports` expects:
+ *
+ * - every specifier used only as a type: `import type { A, B } from '…'`;
+ * - values and types mixed: `import { type A, b } from '…'`;
+ * - values only: `import { a, b } from '…'`.
+ *
+ * Usage alone decides, so an existing `type` modifier that a value use
+ * contradicts is removed. Default and namespace imports are left as they are.
+ */
+export declare function applyTypeOnlyImports(sourceFiles: readonly SourceFile[]): void;

package/dist/finalize/typeOnlyImports.d.ts

@@ -0,0 +1,13 @@
+import { SourceFile } from 'ts-morph';
+/**
+ * Rewrites named imports by how each file uses them, as
+ * `@typescript-eslint/consistent-type-imports` expects:
+ *
+ * - every specifier used only as a type: `import type { A, B } from '…'`;
+ * - values and types mixed: `import { type A, b } from '…'`;
+ * - values only: `import { a, b } from '…'`.
+ *
+ * Usage alone decides, so an existing `type` modifier that a value use
+ * contradicts is removed. Default and namespace imports are left as they are.
+ */
+export declare function applyTypeOnlyImports(sourceFiles: readonly SourceFile[]): void;

package/dist/finalize/verification.d.cts

@@ -0,0 +1,14 @@
+import { SourceFile } from 'ts-morph';
+/**
+ * Fails when generated code references a name it does not declare or import,
+ * or declares one twice.
+ *
+ * This is a safety net under the emitters, which write every import
+ * explicitly: the output must be the same whether or not its directory
+ * resolves `@ahoo-wang/*`, and it must never be saved in a state that cannot
+ * compile.
+ *
+ * @param sourceFiles - The generated files
+ * @throws Error listing each diagnostic with its file and line
+ */
+export declare function verifyGeneratedCode(sourceFiles: readonly SourceFile[]): void;

package/dist/finalize/verification.d.ts

@@ -0,0 +1,14 @@
+import { SourceFile } from 'ts-morph';
+/**
+ * Fails when generated code references a name it does not declare or import,
+ * or declares one twice.
+ *
+ * This is a safety net under the emitters, which write every import
+ * explicitly: the output must be the same whether or not its directory
+ * resolves `@ahoo-wang/*`, and it must never be saved in a state that cannot
+ * compile.
+ *
+ * @param sourceFiles - The generated files
+ * @throws Error listing each diagnostic with its file and line
+ */
+export declare function verifyGeneratedCode(sourceFiles: readonly SourceFile[]): void;

package/dist/index.cjs

@@ -0,0 +1 @@
+Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});const e=require("./codeGenerator-DpDTDC4o.cjs");exports.CodeGenerator=e.t,exports.ConsoleLogger=e.i,exports.DEFAULT_CONFIG_PATH=e.c,exports.EXIT_CODES=e.o,exports.GeneratorError=e.s,exports.SilentLogger=e.a;

package/dist/index.d.cts

@@ -0,0 +1,8 @@
+export type { ApiClientConfiguration, GeneratorConfiguration, } from './api/configuration.cjs';
+export { DEFAULT_CONFIG_PATH } from './api/configuration.cjs';
+export type { GeneratorErrorKind } from './api/errors.cjs';
+export { EXIT_CODES, GeneratorError } from './api/errors.cjs';
+export type { ConsoleLoggerOptions, LogLevel, Logger } from './api/logger.cjs';
+export { ConsoleLogger, SilentLogger } from './api/logger.cjs';
+export type { GenerationResult, GeneratorOptions } from './api/options.cjs';
+export { CodeGenerator } from './pipeline/codeGenerator.cjs';

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+export type { ApiClientConfiguration, GeneratorConfiguration, } from './api/configuration.js';
+export { DEFAULT_CONFIG_PATH } from './api/configuration.js';
+export type { GeneratorErrorKind } from './api/errors.js';
+export { EXIT_CODES, GeneratorError } from './api/errors.js';
+export type { ConsoleLoggerOptions, LogLevel, Logger } from './api/logger.js';
+export { ConsoleLogger, SilentLogger } from './api/logger.js';
+export type { GenerationResult, GeneratorOptions } from './api/options.js';
+export { CodeGenerator } from './pipeline/codeGenerator.js';

package/dist/index.js

@@ -0,0 +1,2 @@
+import { a as e, c as t, i as n, o as r, s as i, t as a } from "./codeGenerator-kyY9eLML.js";
+export { a as CodeGenerator, n as ConsoleLogger, t as DEFAULT_CONFIG_PATH, r as EXIT_CODES, i as GeneratorError, e as SilentLogger };

package/dist/input/configuration.d.cts

@@ -0,0 +1,87 @@
+import { GeneratorConfiguration } from '../api/configuration.cjs';
+import { Logger } from '../api/logger.cjs';
+import { LoadResourceOptions } from './resources.cjs';
+export declare const LEGACY_CONFIG_PATH = "./fetcher-generator.config.json";
+/**
+ * A configuration, and the warnings reading it gave: keys the generator does
+ * not read, an empty file.
+ */
+export interface LoadedConfiguration {
+    readonly config: GeneratorConfiguration;
+    /** One line each, in the order they arose. */
+    readonly warnings: readonly string[];
+}
+/**
+ * A configuration, the place it was read from, and the warnings reading it
+ * gave.
+ */
+export interface ResolvedConfiguration extends LoadedConfiguration {
+    /** The absolute path or URL read, or undefined when there was none. */
+    readonly origin?: string;
+}
+/**
+ * Finds and loads the generator configuration.
+ *
+ * A path the caller names has to exist. Without one the generator reads
+ * {@link DEFAULT_CONFIG_PATH}, then the pre-Wow name
+ * {@link LEGACY_CONFIG_PATH} with a deprecation warning, and generates with
+ * the defaults when neither exists.
+ *
+ * @param configPath - The path or URL the caller named, if any
+ * @param logger - Receives what was read, at `debug`
+ * @param options - Headers and timeout for a configuration read over http(s)
+ * @returns The configuration, where it came from and the warnings it gave
+ * @throws GeneratorError of kind `configuration` when it cannot be read,
+ * parsed or understood
+ */
+export declare function resolveConfiguration(configPath: string | undefined, logger: Logger, options?: LoadResourceOptions): Promise<ResolvedConfiguration>;
+/**
+ * Where a configuration is read from, and whether the caller chose that place.
+ */
+export interface ConfigurationSource {
+    /** A file path, or an http(s) URL. */
+    readonly path: string;
+    /**
+     * True when the caller asked for this path. An absent file is then a
+     * mistake worth failing on; under the default path it is merely the common
+     * case of a project that has no configuration.
+     */
+    readonly explicit: boolean;
+}
+/**
+ * Reads, validates and reports a generator configuration.
+ *
+ * A configuration that fails to load used to degrade to the defaults with a
+ * single line among hundreds of progress lines, so a misplaced file looked
+ * exactly like a generator that ignores its options. Loading now either
+ * succeeds and says what it read, or fails loudly - with the sole exception of
+ * the default path being absent, which stays a normal, quiet outcome.
+ *
+ * @param source - Where to read the configuration from
+ * @param logger - Receives what was read and the settings it resolved to, at
+ * `debug`
+ * @param options - Headers and timeout for a configuration read over http(s)
+ * @returns The validated configuration and the warnings about it; undefined
+ * when a path the caller did not name does not exist
+ * @throws GeneratorError of kind `configuration` when the configuration
+ * cannot be read, parsed or understood
+ */
+export declare function loadConfiguration(source: ConfigurationSource & {
+    explicit: true;
+}, logger: Logger, options?: LoadResourceOptions): Promise<LoadedConfiguration>;
+export declare function loadConfiguration(source: ConfigurationSource, logger: Logger, options?: LoadResourceOptions): Promise<LoadedConfiguration | undefined>;
+/**
+ * Checks a parsed configuration against the options the generator reads.
+ *
+ * Shape errors throw: a block the generator cannot read is a request the user
+ * made and the generator would otherwise drop. Unknown keys only warn, so a
+ * configuration written for a newer version still generates.
+ *
+ * @param parsed - The parsed configuration document
+ * @param origin - Where it was read from, for messages
+ * @returns The same configuration, typed, and a warning for every key the
+ * generator ignores
+ * @throws GeneratorError of kind `configuration` when a block or option has
+ * a shape the generator cannot read
+ */
+export declare function validateConfiguration(parsed: unknown, origin: string): LoadedConfiguration;

package/dist/input/configuration.d.ts

@@ -0,0 +1,87 @@
+import { GeneratorConfiguration } from '../api/configuration.js';
+import { Logger } from '../api/logger.js';
+import { LoadResourceOptions } from './resources.js';
+export declare const LEGACY_CONFIG_PATH = "./fetcher-generator.config.json";
+/**
+ * A configuration, and the warnings reading it gave: keys the generator does
+ * not read, an empty file.
+ */
+export interface LoadedConfiguration {
+    readonly config: GeneratorConfiguration;
+    /** One line each, in the order they arose. */
+    readonly warnings: readonly string[];
+}
+/**
+ * A configuration, the place it was read from, and the warnings reading it
+ * gave.
+ */
+export interface ResolvedConfiguration extends LoadedConfiguration {
+    /** The absolute path or URL read, or undefined when there was none. */
+    readonly origin?: string;
+}
+/**
+ * Finds and loads the generator configuration.
+ *
+ * A path the caller names has to exist. Without one the generator reads
+ * {@link DEFAULT_CONFIG_PATH}, then the pre-Wow name
+ * {@link LEGACY_CONFIG_PATH} with a deprecation warning, and generates with
+ * the defaults when neither exists.
+ *
+ * @param configPath - The path or URL the caller named, if any
+ * @param logger - Receives what was read, at `debug`
+ * @param options - Headers and timeout for a configuration read over http(s)
+ * @returns The configuration, where it came from and the warnings it gave
+ * @throws GeneratorError of kind `configuration` when it cannot be read,
+ * parsed or understood
+ */
+export declare function resolveConfiguration(configPath: string | undefined, logger: Logger, options?: LoadResourceOptions): Promise<ResolvedConfiguration>;
+/**
+ * Where a configuration is read from, and whether the caller chose that place.
+ */
+export interface ConfigurationSource {
+    /** A file path, or an http(s) URL. */
+    readonly path: string;
+    /**
+     * True when the caller asked for this path. An absent file is then a
+     * mistake worth failing on; under the default path it is merely the common
+     * case of a project that has no configuration.
+     */
+    readonly explicit: boolean;
+}
+/**
+ * Reads, validates and reports a generator configuration.
+ *
+ * A configuration that fails to load used to degrade to the defaults with a
+ * single line among hundreds of progress lines, so a misplaced file looked
+ * exactly like a generator that ignores its options. Loading now either
+ * succeeds and says what it read, or fails loudly - with the sole exception of
+ * the default path being absent, which stays a normal, quiet outcome.
+ *
+ * @param source - Where to read the configuration from
+ * @param logger - Receives what was read and the settings it resolved to, at
+ * `debug`
+ * @param options - Headers and timeout for a configuration read over http(s)
+ * @returns The validated configuration and the warnings about it; undefined
+ * when a path the caller did not name does not exist
+ * @throws GeneratorError of kind `configuration` when the configuration
+ * cannot be read, parsed or understood
+ */
+export declare function loadConfiguration(source: ConfigurationSource & {
+    explicit: true;
+}, logger: Logger, options?: LoadResourceOptions): Promise<LoadedConfiguration>;
+export declare function loadConfiguration(source: ConfigurationSource, logger: Logger, options?: LoadResourceOptions): Promise<LoadedConfiguration | undefined>;
+/**
+ * Checks a parsed configuration against the options the generator reads.
+ *
+ * Shape errors throw: a block the generator cannot read is a request the user
+ * made and the generator would otherwise drop. Unknown keys only warn, so a
+ * configuration written for a newer version still generates.
+ *
+ * @param parsed - The parsed configuration document
+ * @param origin - Where it was read from, for messages
+ * @returns The same configuration, typed, and a warning for every key the
+ * generator ignores
+ * @throws GeneratorError of kind `configuration` when a block or option has
+ * a shape the generator cannot read
+ */
+export declare function validateConfiguration(parsed: unknown, origin: string): LoadedConfiguration;

package/dist/input/parsers.d.cts

@@ -0,0 +1,39 @@
+import { OpenAPI } from '@ahoo-wang/fetcher-openapi';
+import { LoadResourceOptions } from './resources.cjs';
+/**
+ * Loads and parses an OpenAPI 3 document.
+ *
+ * Every failure is a {@link GeneratorError} of kind `input` whose message
+ * names the document: it cannot be read or fetched, it is neither JSON nor
+ * YAML, or it is not an OpenAPI 3 document. A Swagger 2.0 document is
+ * refused rather than generated into clients without models.
+ *
+ * @param inputPath - The path or http(s) URL of the document
+ * @param options - Headers and timeout for an http(s) document
+ * @returns The parsed document; `paths` is an empty object when it has none
+ */
+export declare function parseOpenAPI(inputPath: string, options?: LoadResourceOptions): Promise<OpenAPI>;
+/**
+ * Checks that a parsed document is an OpenAPI 3 document the generator reads.
+ *
+ * @param document - The parsed document
+ * @param source - Where it came from, for messages
+ * @returns The document, with `paths` defaulted to an empty object
+ * @throws GeneratorError when it is not an OpenAPI 3.x document
+ */
+export declare function validateOpenAPIDocument(document: unknown, source: string): OpenAPI;
+/**
+ * Parses already-loaded document content in whichever format it is written.
+ *
+ * Callers name the source in their own error, so a failure here carries only
+ * what went wrong with the text.
+ *
+ * @param content - The document text
+ * @returns The parsed document
+ */
+export declare function parseContent<T>(content: string): T;
+export declare enum FileFormat {
+    JSON = "json",
+    YAML = "yaml"
+}
+export declare function inferFileFormat(content: string): FileFormat;

package/dist/input/parsers.d.ts

@@ -0,0 +1,39 @@
+import { OpenAPI } from '@ahoo-wang/fetcher-openapi';
+import { LoadResourceOptions } from './resources.js';
+/**
+ * Loads and parses an OpenAPI 3 document.
+ *
+ * Every failure is a {@link GeneratorError} of kind `input` whose message
+ * names the document: it cannot be read or fetched, it is neither JSON nor
+ * YAML, or it is not an OpenAPI 3 document. A Swagger 2.0 document is
+ * refused rather than generated into clients without models.
+ *
+ * @param inputPath - The path or http(s) URL of the document
+ * @param options - Headers and timeout for an http(s) document
+ * @returns The parsed document; `paths` is an empty object when it has none
+ */
+export declare function parseOpenAPI(inputPath: string, options?: LoadResourceOptions): Promise<OpenAPI>;
+/**
+ * Checks that a parsed document is an OpenAPI 3 document the generator reads.
+ *
+ * @param document - The parsed document
+ * @param source - Where it came from, for messages
+ * @returns The document, with `paths` defaulted to an empty object
+ * @throws GeneratorError when it is not an OpenAPI 3.x document
+ */
+export declare function validateOpenAPIDocument(document: unknown, source: string): OpenAPI;
+/**
+ * Parses already-loaded document content in whichever format it is written.
+ *
+ * Callers name the source in their own error, so a failure here carries only
+ * what went wrong with the text.
+ *
+ * @param content - The document text
+ * @returns The parsed document
+ */
+export declare function parseContent<T>(content: string): T;
+export declare enum FileFormat {
+    JSON = "json",
+    YAML = "yaml"
+}
+export declare function inferFileFormat(content: string): FileFormat;