@kattebak/openapi-generator-ts 1.0.0

package/dist/core/config.d.ts

@@ -0,0 +1,252 @@
+/**
+ * Generator configuration
+ */
+export interface CodegenConfig {
+    /**
+     * Generator name/type
+     */
+    generatorName: string;
+    /**
+     * Input OpenAPI spec file
+     */
+    inputSpec: string;
+    /**
+     * Output directory
+     */
+    outputDir: string;
+    /**
+     * Custom template directory
+     */
+    templateDir?: string;
+    /**
+     * Library variant to use
+     */
+    library?: string;
+    /**
+     * Package name for generated code
+     */
+    packageName?: string;
+    /**
+     * API package name
+     */
+    apiPackage?: string;
+    /**
+     * Model package name
+     */
+    modelPackage?: string;
+    /**
+     * Invoker package name
+     */
+    invokerPackage?: string;
+    /**
+     * Additional properties to pass to templates
+     */
+    additionalProperties?: Record<string, unknown>;
+    /**
+     * Global properties
+     */
+    globalProperties?: Record<string, string>;
+    /**
+     * Type mappings (OpenAPI type -> target type)
+     */
+    typeMappings?: Record<string, string>;
+    /**
+     * Import mappings (model name -> import path)
+     */
+    importMappings?: Record<string, string>;
+    /**
+     * Name mappings (OpenAPI name -> target name)
+     */
+    nameMappings?: Record<string, string>;
+    /**
+     * Reserved words that should not be used as names
+     */
+    reservedWordsMappings?: Record<string, string>;
+    /**
+     * Skip generating these files
+     */
+    skipFiles?: string[];
+    /**
+     * Only generate these files
+     */
+    files?: Record<string, string>;
+    /**
+     * Skip overwriting existing files
+     */
+    skipOverwrite?: boolean;
+    /**
+     * Only write files if content changed
+     */
+    minimalUpdate?: boolean;
+    /**
+     * Don't write files, just show what would be generated
+     */
+    dryRun?: boolean;
+    /**
+     * Generate models
+     */
+    generateModels?: boolean;
+    /**
+     * Generate APIs
+     */
+    generateApis?: boolean;
+    /**
+     * Generate supporting files
+     */
+    generateSupportingFiles?: boolean;
+    /**
+     * Validate spec before generation
+     */
+    validateSpec?: boolean;
+    /**
+     * Strict spec mode
+     */
+    strictSpec?: boolean;
+    /**
+     * Enable verbose output
+     */
+    verbose?: boolean;
+    /**
+     * Enable debug mode
+     */
+    debug?: boolean;
+}
+export interface SupportingFileConfig {
+    /**
+     * Template file name
+     */
+    templateFile: string;
+    /**
+     * Destination folder (relative to output dir)
+     */
+    folder: string;
+    /**
+     * Destination file name
+     */
+    destinationFilename: string;
+    /**
+     * Condition to check before generating
+     */
+    condition?: (config: CodegenConfig) => boolean;
+}
+export interface GeneratorMetadata {
+    /**
+     * Generator name
+     */
+    name: string;
+    /**
+     * Generator description
+     */
+    description?: string;
+    /**
+     * Generator type (client, server, documentation, etc.)
+     */
+    type: "client" | "server" | "documentation" | "config" | "schema" | "other";
+    /**
+     * Target language
+     */
+    language: string;
+    /**
+     * Available libraries/variants
+     */
+    libraries?: string[];
+    /**
+     * Default library
+     */
+    defaultLibrary?: string;
+    /**
+     * Embedded template directory name
+     */
+    embeddedTemplateDir: string;
+    /**
+     * File extension for models
+     */
+    modelFileExtension: string;
+    /**
+     * File extension for APIs
+     */
+    apiFileExtension: string;
+    /**
+     * Model template name
+     */
+    modelTemplateFile: string;
+    /**
+     * API template name
+     */
+    apiTemplateFile: string;
+    /**
+     * Template file for model documentation
+     */
+    modelDocTemplateFile?: string;
+    /**
+     * Template file for API documentation
+     */
+    apiDocTemplateFile?: string;
+    /**
+     * Default API package/folder (defaults to "api")
+     */
+    defaultApiPackage?: string;
+    /**
+     * Default model package/folder (defaults to "models")
+     */
+    defaultModelPackage?: string;
+    /**
+     * Supporting files to generate
+     */
+    supportingFiles: SupportingFileConfig[];
+    /**
+     * Reserved words in the target language
+     */
+    reservedWords: Set<string>;
+    /**
+     * Default type mappings
+     */
+    defaultTypeMappings: Record<string, string>;
+    /**
+     * Default import mappings
+     */
+    defaultImportMappings: Record<string, string>;
+    /**
+     * API name suffix (e.g., "Api" for TypeScript, "API" for Go)
+     */
+    apiNameSuffix?: string;
+    /**
+     * Convert API tag to class name (e.g., "pets" -> "PetsApi" or "PetsAPI")
+     */
+    toApiClassName?: (tag: string, suffix: string) => string;
+    /**
+     * Convert model name to file name (e.g., "Pet" -> "Pet.ts" or "model_pet.go")
+     */
+    toModelFilename?: (modelName: string) => string;
+    /**
+     * Convert API class name to file name (e.g., "PetsApi" -> "PetsApi.ts" or "api_pets.go")
+     */
+    toApiFilename?: (className: string) => string;
+    /**
+     * Convert operation ID for the target language (e.g., "getPet" -> "GetPet" for Go)
+     */
+    toOperationId?: (name: string) => string;
+    /**
+     * Convert property name for the target language (e.g., "petId" -> "PetId" for Go)
+     */
+    toVarName?: (name: string) => string;
+    /**
+     * Post-process a property for generator-specific transformations.
+     * For Go, this adds x-go-base-type and x-go-datatag vendor extensions.
+     */
+    postProcessProperty?: (property: import("../models/index.js").CodegenProperty) => void;
+    /**
+     * Post-process a model for generator-specific transformations.
+     * For Go, this adds x-go-generate-marshal-json and x-go-generate-unmarshal-json.
+     */
+    postProcessModel?: (model: import("../models/index.js").CodegenModel, config: CodegenConfig) => void;
+    /**
+     * Post-process an operation for generator-specific transformations.
+     */
+    postProcessOperation?: (operation: import("../models/index.js").CodegenOperation, config: CodegenConfig) => void;
+}
+/**
+ * Create default config with sensible defaults
+ */
+export declare function createDefaultConfig(overrides?: Partial<CodegenConfig>): CodegenConfig;
+//# sourceMappingURL=config.d.ts.map

package/dist/core/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/core/config.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,WAAW,aAAa;IAC7B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE/C;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAE1C;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEtC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAExC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEtC;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAE/C;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAE/B;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAElC;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CAChB;AAED,MAAM,WAAW,oBAAoB;IACpC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE,aAAa,KAAK,OAAO,CAAC;CAC/C;AAED,MAAM,WAAW,iBAAiB;IACjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,eAAe,GAAG,QAAQ,GAAG,QAAQ,GAAG,OAAO,CAAC;IAE5E;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IAErB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,eAAe,EAAE,oBAAoB,EAAE,CAAC;IAExC;;OAEG;IACH,aAAa,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAE3B;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAE5C;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAE9C;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,cAAc,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,MAAM,CAAC;IAEzD;;OAEG;IACH,eAAe,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,MAAM,CAAC;IAEhD;;OAEG;IACH,aAAa,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,MAAM,CAAC;IAC9C;;OAEG;IACH,aAAa,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;IAEzC;;OAEG;IACH,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;IAErC;;;OAGG;IACH,mBAAmB,CAAC,EAAE,CACrB,QAAQ,EAAE,OAAO,oBAAoB,EAAE,eAAe,KAClD,IAAI,CAAC;IAEV;;;OAGG;IACH,gBAAgB,CAAC,EAAE,CAClB,KAAK,EAAE,OAAO,oBAAoB,EAAE,YAAY,EAChD,MAAM,EAAE,aAAa,KACjB,IAAI,CAAC;IACV;;OAEG;IACH,oBAAoB,CAAC,EAAE,CACtB,SAAS,EAAE,OAAO,oBAAoB,EAAE,gBAAgB,EACxD,MAAM,EAAE,aAAa,KACjB,IAAI,CAAC;CACV;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAClC,SAAS,GAAE,OAAO,CAAC,aAAa,CAAM,GACpC,aAAa,CAuBf"}

package/dist/core/config.js

@@ -0,0 +1,31 @@
+/**
+ * Generator configuration
+ */
+/**
+ * Create default config with sensible defaults
+ */
+export function createDefaultConfig(overrides = {}) {
+    return {
+        generatorName: "typescript",
+        inputSpec: "",
+        outputDir: "./generated",
+        generateModels: true,
+        generateApis: true,
+        generateSupportingFiles: true,
+        validateSpec: true,
+        strictSpec: false,
+        skipOverwrite: false,
+        minimalUpdate: true,
+        dryRun: false,
+        verbose: false,
+        debug: false,
+        additionalProperties: {},
+        globalProperties: {},
+        typeMappings: {},
+        importMappings: {},
+        nameMappings: {},
+        reservedWordsMappings: {},
+        ...overrides,
+    };
+}
+//# sourceMappingURL=config.js.map

package/dist/core/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/core/config.ts"],"names":[],"mappings":"AAAA;;GAEG;AAsTH;;GAEG;AACH,MAAM,UAAU,mBAAmB,CAClC,YAAoC,EAAE;IAEtC,OAAO;QACN,aAAa,EAAE,YAAY;QAC3B,SAAS,EAAE,EAAE;QACb,SAAS,EAAE,aAAa;QACxB,cAAc,EAAE,IAAI;QACpB,YAAY,EAAE,IAAI;QAClB,uBAAuB,EAAE,IAAI;QAC7B,YAAY,EAAE,IAAI;QAClB,UAAU,EAAE,KAAK;QACjB,aAAa,EAAE,KAAK;QACpB,aAAa,EAAE,IAAI;QACnB,MAAM,EAAE,KAAK;QACb,OAAO,EAAE,KAAK;QACd,KAAK,EAAE,KAAK;QACZ,oBAAoB,EAAE,EAAE;QACxB,gBAAgB,EAAE,EAAE;QACpB,YAAY,EAAE,EAAE;QAChB,cAAc,EAAE,EAAE;QAClB,YAAY,EAAE,EAAE;QAChB,qBAAqB,EAAE,EAAE;QACzB,GAAG,SAAS;KACZ,CAAC;AACH,CAAC"}

package/dist/core/generator.d.ts

@@ -0,0 +1,99 @@
+/**
+ * Default Generator
+ * Main orchestrator for code generation
+ */
+import type { CodegenModel, CodegenOperation } from "../models/index.js";
+import { type ParsedSpec } from "../parser/openapi-parser.js";
+import { TemplateManager } from "../template/template-manager.js";
+import type { CodegenConfig, GeneratorMetadata } from "./config.js";
+import type { GeneratedFile } from "./types.js";
+export interface GenerationResult {
+    /**
+     * Files that were generated
+     */
+    files: GeneratedFile[];
+    /**
+     * Models that were processed
+     */
+    models: Map<string, CodegenModel>;
+    /**
+     * Operations grouped by tag
+     */
+    operations: Map<string, CodegenOperation[]>;
+    /**
+     * Any warnings during generation
+     */
+    warnings: string[];
+    /**
+     * Any errors during generation
+     */
+    errors: string[];
+}
+export interface GeneratorContext {
+    config: CodegenConfig;
+    spec: ParsedSpec;
+    models: Map<string, CodegenModel>;
+    operations: Map<string, CodegenOperation[]>;
+    templateManager: TemplateManager;
+    globalProperties: Record<string, unknown>;
+}
+/**
+ * Default code generator
+ */
+export declare class DefaultGenerator {
+    private config;
+    private metadata;
+    private templateManager;
+    private schemaTransformer;
+    private operationTransformer;
+    private embeddedTemplatesDir;
+    constructor(config: CodegenConfig, metadata: GeneratorMetadata);
+    /**
+     * Find the embedded templates directory
+     */
+    private findEmbeddedTemplatesDir;
+    /**
+     * Run the code generation process
+     */
+    generate(): Promise<GenerationResult>;
+    /**
+     * Generate model files
+     */
+    private generateModels;
+    /**
+     * Generate API files
+     */
+    private generateApis;
+    /**
+     * Generate supporting files
+     */
+    private generateSupportingFiles;
+    /**
+     * Derive a package name from the API title
+     * This is used when packageName is not explicitly set
+     */
+    private derivePackageName;
+    /**
+     * Interpolate simple template variables in folder paths
+     * Supports {{variableName}} syntax for path interpolation
+     */
+    private interpolatePath;
+    /**
+     * Create global template data available to all templates
+     */
+    private createGlobalTemplateData;
+    /**
+     * Convert tag to API class name
+     */
+    private toApiClassName;
+    /**
+     * Collect imports from operations
+     * Returns array of { className, classname, classVarName } objects for template
+     */
+    private collectImports;
+}
+/**
+ * Create a generator with the given config and metadata
+ */
+export declare function createGenerator(config: CodegenConfig, metadata: GeneratorMetadata): DefaultGenerator;
+//# sourceMappingURL=generator.d.ts.map

package/dist/core/generator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generator.d.ts","sourceRoot":"","sources":["../../src/core/generator.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAyBH,OAAO,KAAK,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACzE,OAAO,EAON,KAAK,UAAU,EAEf,MAAM,6BAA6B,CAAC;AAGrC,OAAO,EACN,eAAe,EAEf,MAAM,iCAAiC,CAAC;AACzC,OAAO,KAAK,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AACpE,OAAO,KAAK,EAAE,aAAa,EAAgB,MAAM,YAAY,CAAC;AAE9D,MAAM,WAAW,gBAAgB;IAChC;;OAEG;IACH,KAAK,EAAE,aAAa,EAAE,CAAC;IAEvB;;OAEG;IACH,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IAElC;;OAEG;IACH,UAAU,EAAE,GAAG,CAAC,MAAM,EAAE,gBAAgB,EAAE,CAAC,CAAC;IAE5C;;OAEG;IACH,QAAQ,EAAE,MAAM,EAAE,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,gBAAgB;IAChC,MAAM,EAAE,aAAa,CAAC;IACtB,IAAI,EAAE,UAAU,CAAC;IACjB,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IAClC,UAAU,EAAE,GAAG,CAAC,MAAM,EAAE,gBAAgB,EAAE,CAAC,CAAC;IAC5C,eAAe,EAAE,eAAe,CAAC;IACjC,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC1C;AAED;;GAEG;AACH,qBAAa,gBAAgB;IAC5B,OAAO,CAAC,MAAM,CAAgB;IAC9B,OAAO,CAAC,QAAQ,CAAoB;IACpC,OAAO,CAAC,eAAe,CAAgC;IACvD,OAAO,CAAC,iBAAiB,CAAoB;IAC7C,OAAO,CAAC,oBAAoB,CAAuB;IACnD,OAAO,CAAC,oBAAoB,CAAS;gBAEzB,MAAM,EAAE,aAAa,EAAE,QAAQ,EAAE,iBAAiB;IA0B9D;;OAEG;IACH,OAAO,CAAC,wBAAwB;IA6BhC;;OAEG;IACG,QAAQ,IAAI,OAAO,CAAC,gBAAgB,CAAC;IAkH3C;;OAEG;YACW,cAAc;IA2F5B;;OAEG;YACW,YAAY;IAiG1B;;OAEG;YACW,uBAAuB;IA+FrC;;;OAGG;IACH,OAAO,CAAC,iBAAiB;IAQzB;;;OAGG;IACH,OAAO,CAAC,eAAe;IAUvB;;OAEG;IACH,OAAO,CAAC,wBAAwB;IAuEhC;;OAEG;IACH,OAAO,CAAC,cAAc;IAkBtB;;;OAGG;IACH,OAAO,CAAC,cAAc;CAmBtB;AAED;;GAEG;AACH,wBAAgB,eAAe,CAC9B,MAAM,EAAE,aAAa,EACrB,QAAQ,EAAE,iBAAiB,GACzB,gBAAgB,CAElB"}