Programmatic API

The package root exports CodeGenerator, DEFAULT_CONFIG_PATH, the loggers ConsoleLogger and SilentLogger, GeneratorError and EXIT_CODES, and the types GeneratorOptions, GenerationResult, GeneratorConfiguration, ApiClientConfiguration, Logger, ConsoleLoggerOptions, LogLevel and GeneratorErrorKind. The executable is separately exposed as the wow-generator binary. Do not import internal resolveWowModel, analyze, the emitters, OutputStore, setupCLI or parser helpers from undocumented subpaths. Both ESM import and CommonJS require work.

CodeGenerator

Member	Parameters/defaults	Return and effects
constructor(options)	GeneratorOptions, see below	Reads the tsconfig synchronously; an unreadable tsconfig throws a GeneratorError of kind configuration. Its only parameter is the options
generate()	No arguments	Promise<GenerationResult>; reads the configuration, then the document, resolves aggregates, writes models/clients/indexes, formats and saves owned output
DEFAULT_CONFIG_PATH	Constant	./wow-generator.config.json

GeneratorOptions field	Default	Meaning
inputPath	Required	Path or HTTP/HTTPS URL of the OpenAPI 3.x document
outputDir	Required	Directory the generated files are written to
configPath	DEFAULT_CONFIG_PATH if present	Path or URL of the configuration; a named one has to exist
tsConfigFilePath	None	The project's tsconfig, used to resolve the modules the output imports
logger	new ConsoleLogger()	Receives progress, warnings and errors
headers	None	Request headers used when inputPath or configPath is an HTTP/HTTPS URL
timeoutMs	30000	Milliseconds before fetching an HTTP/HTTPS document is abandoned
schemaDocs	'summary'	'full' also embeds each model's JSON schema in its doc comment

GeneratorOptions no longer extends ts-morph's ProjectOptions; only tsConfigFilePath is passed to the project.

generate() resolves to a GenerationResult: files, the sorted absolute paths written; configPath, the configuration read, or undefined when none was found; and warnings, how many warnings the run logged. It rejects with a GeneratorError when the document, the configuration or the output directory cannot be read, understood or written, and with a plain Error only for a defect of the generator.

The internal ts-morph Project and the index and formatting steps are private, and the package's public declarations do not import ts-morph. There is no close/dispose, cancellation signal or watch method. Avoid concurrent generate() calls on the same instance/output directory; there is no locking contract.

Loggers

A Logger implements four methods, each (message: string, ...params: unknown[]) => void: debug for every step and detail, info for the outcome of the run, warn for something the run carried on past but the user probably did not intend, and error for a failure. The generator counts its warn calls for GenerationResult.warnings.

ConsoleLogger is the CLI's logger. ConsoleLoggerOptions.level is a LogLevel: quiet prints warn and error, normal (the default) also info, verbose also every debug line, each with a timestamp. decorate prefixes lines with symbols; it defaults to true on a TTY unless NO_COLOR is set. SilentLogger prints nothing.

Errors

GeneratorError carries kind, a GeneratorErrorKind (input, configuration, specification or output), and exitCode, the CLI exit code for that kind. EXIT_CODES maps success 0, internal 1, input 2, configuration 3, specification 4, output 5 and interrupted 130; see CLI exit codes.

Complete script

import {
  CodeGenerator,
  ConsoleLogger,
  GeneratorError,
} from '@ahoo-wang/wow-generator';

const generator = new CodeGenerator({
  inputPath: './openapi.json',
  outputDir: './src/generated',
  tsConfigFilePath: './tsconfig.json',
  logger: new ConsoleLogger({ level: 'quiet' }),
});
try {
  const { files, warnings } = await generator.generate();
  console.log(`Generated ${files.length} files, ${warnings} warnings`);
} catch (error) {
  console.error(error instanceof Error ? error.message : error);
  process.exitCode = error instanceof GeneratorError ? error.exitCode : 1;
}

DEFAULT_CONFIG_PATH — typescript/wow-generator/src/api/configuration.ts

CodeGenerator — typescript/wow-generator/src/pipeline/codeGenerator.ts

ConsoleLogger, SilentLogger — typescript/wow-generator/src/api/logger.ts

GeneratorError, EXIT_CODES — typescript/wow-generator/src/api/errors.ts

GeneratorOptions, GenerationResult — typescript/wow-generator/src/api/options.ts

GeneratorConfiguration, ApiClientConfiguration — typescript/wow-generator/src/api/configuration.ts

Logger, LogLevel, ConsoleLoggerOptions — typescript/wow-generator/src/api/logger.ts