ts-openapi-codegen 2.0.0-beta.9 → 2.1.0-beta.1

package/dist/core/plugins/applySemanticDiffPluginHooks.d.ts

@@ -0,0 +1,28 @@
+import { SemanticDiffReport } from '../semanticDiff/analyzeOpenApiDiff';
+import { OpenApiGeneratorPlugin } from './GeneratorPlugin.model';
+export type PluginHookName = 'afterSemanticDiff' | 'mapRecommendation' | 'beforeReportWrite';
+export type PluginHookDiagnostic = {
+    pluginName: string;
+    hook: PluginHookName;
+    status: 'applied' | 'skipped' | 'failed';
+    durationMs: number;
+    message?: string;
+};
+export type ApplySemanticDiffPluginHooksInput = {
+    report: SemanticDiffReport;
+    reportPath: string;
+    plugins: OpenApiGeneratorPlugin[];
+    allowBreaking: boolean;
+    strictPluginMode?: boolean;
+    onDiagnostic?: (diagnostic: PluginHookDiagnostic) => void;
+};
+export type ApplySemanticDiffPluginHooksResult = {
+    report: SemanticDiffReport;
+    reportPath: string;
+    diagnostics: PluginHookDiagnostic[];
+};
+/**
+ * Safely applies semantic diff plugin hooks in deterministic order.
+ */
+export declare function applySemanticDiffPluginHooks(input: ApplySemanticDiffPluginHooksInput): Promise<ApplySemanticDiffPluginHooksResult>;
+//# sourceMappingURL=applySemanticDiffPluginHooks.d.ts.map

package/dist/core/plugins/applySemanticDiffPluginHooks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"applySemanticDiffPluginHooks.d.ts","sourceRoot":"","sources":["../../../src/core/plugins/applySemanticDiffPluginHooks.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,oCAAoC,CAAC;AACxE,OAAO,EAAE,sBAAsB,EAAE,MAAM,yBAAyB,CAAC;AAEjE,MAAM,MAAM,cAAc,GAAG,mBAAmB,GAAG,mBAAmB,GAAG,mBAAmB,CAAC;AAE7F,MAAM,MAAM,oBAAoB,GAAG;IAC/B,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,cAAc,CAAC;IACrB,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,QAAQ,CAAC;IACzC,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,iCAAiC,GAAG;IAC5C,MAAM,EAAE,kBAAkB,CAAC;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,sBAAsB,EAAE,CAAC;IAClC,aAAa,EAAE,OAAO,CAAC;IACvB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,YAAY,CAAC,EAAE,CAAC,UAAU,EAAE,oBAAoB,KAAK,IAAI,CAAC;CAC7D,CAAC;AAEF,MAAM,MAAM,kCAAkC,GAAG;IAC7C,MAAM,EAAE,kBAAkB,CAAC;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,oBAAoB,EAAE,CAAC;CACvC,CAAC;AAEF;;GAEG;AACH,wBAAsB,4BAA4B,CAC9C,KAAK,EAAE,iCAAiC,GACzC,OAAO,CAAC,kCAAkC,CAAC,CAmK7C"}

package/dist/core/plugins/applySemanticDiffPluginHooks.js

@@ -0,0 +1,160 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.applySemanticDiffPluginHooks = applySemanticDiffPluginHooks;
+/**
+ * Safely applies semantic diff plugin hooks in deterministic order.
+ */
+async function applySemanticDiffPluginHooks(input) {
+    const diagnostics = [];
+    const strictPluginMode = input.strictPluginMode ?? false;
+    let currentReport = input.report;
+    let currentReportPath = input.reportPath;
+    for (const plugin of input.plugins) {
+        if (!plugin.afterSemanticDiff) {
+            continue;
+        }
+        const startedAt = Date.now();
+        try {
+            const maybeReport = await plugin.afterSemanticDiff({
+                report: currentReport,
+                options: {
+                    allowBreaking: input.allowBreaking,
+                },
+            });
+            if (maybeReport) {
+                currentReport = maybeReport;
+                const diagnostic = {
+                    pluginName: plugin.name,
+                    hook: 'afterSemanticDiff',
+                    status: 'applied',
+                    durationMs: Date.now() - startedAt,
+                };
+                diagnostics.push(diagnostic);
+                input.onDiagnostic?.(diagnostic);
+            }
+            else {
+                const diagnostic = {
+                    pluginName: plugin.name,
+                    hook: 'afterSemanticDiff',
+                    status: 'skipped',
+                    durationMs: Date.now() - startedAt,
+                };
+                diagnostics.push(diagnostic);
+                input.onDiagnostic?.(diagnostic);
+            }
+        }
+        catch (error) {
+            const message = error instanceof Error ? error.message : String(error);
+            const diagnostic = {
+                pluginName: plugin.name,
+                hook: 'afterSemanticDiff',
+                status: 'failed',
+                durationMs: Date.now() - startedAt,
+                message,
+            };
+            diagnostics.push(diagnostic);
+            input.onDiagnostic?.(diagnostic);
+            if (strictPluginMode) {
+                throw new Error(`Plugin "${plugin.name}" failed in afterSemanticDiff: ${message}`);
+            }
+        }
+    }
+    for (const plugin of input.plugins) {
+        if (!plugin.mapRecommendation) {
+            continue;
+        }
+        const startedAt = Date.now();
+        try {
+            const maybeRecommendation = await plugin.mapRecommendation({
+                recommendation: currentReport.recommendation,
+                summary: currentReport.summary,
+                governance: currentReport.governance,
+            });
+            if (maybeRecommendation) {
+                currentReport = {
+                    ...currentReport,
+                    recommendation: maybeRecommendation,
+                };
+                const diagnostic = {
+                    pluginName: plugin.name,
+                    hook: 'mapRecommendation',
+                    status: 'applied',
+                    durationMs: Date.now() - startedAt,
+                };
+                diagnostics.push(diagnostic);
+                input.onDiagnostic?.(diagnostic);
+            }
+            else {
+                const diagnostic = {
+                    pluginName: plugin.name,
+                    hook: 'mapRecommendation',
+                    status: 'skipped',
+                    durationMs: Date.now() - startedAt,
+                };
+                diagnostics.push(diagnostic);
+                input.onDiagnostic?.(diagnostic);
+            }
+        }
+        catch (error) {
+            const message = error instanceof Error ? error.message : String(error);
+            const diagnostic = {
+                pluginName: plugin.name,
+                hook: 'mapRecommendation',
+                status: 'failed',
+                durationMs: Date.now() - startedAt,
+                message,
+            };
+            diagnostics.push(diagnostic);
+            input.onDiagnostic?.(diagnostic);
+            if (strictPluginMode) {
+                throw new Error(`Plugin "${plugin.name}" failed in mapRecommendation: ${message}`);
+            }
+        }
+    }
+    for (const plugin of input.plugins) {
+        if (!plugin.beforeReportWrite) {
+            continue;
+        }
+        const startedAt = Date.now();
+        try {
+            const maybeResult = await plugin.beforeReportWrite({
+                report: currentReport,
+                reportPath: currentReportPath,
+            });
+            if (maybeResult?.report) {
+                currentReport = maybeResult.report;
+            }
+            if (maybeResult?.reportPath) {
+                currentReportPath = maybeResult.reportPath;
+            }
+            const diagnostic = {
+                pluginName: plugin.name,
+                hook: 'beforeReportWrite',
+                status: maybeResult ? 'applied' : 'skipped',
+                durationMs: Date.now() - startedAt,
+            };
+            diagnostics.push(diagnostic);
+            input.onDiagnostic?.(diagnostic);
+        }
+        catch (error) {
+            const message = error instanceof Error ? error.message : String(error);
+            const diagnostic = {
+                pluginName: plugin.name,
+                hook: 'beforeReportWrite',
+                status: 'failed',
+                durationMs: Date.now() - startedAt,
+                message,
+            };
+            diagnostics.push(diagnostic);
+            input.onDiagnostic?.(diagnostic);
+            if (strictPluginMode) {
+                throw new Error(`Plugin "${plugin.name}" failed in beforeReportWrite: ${message}`);
+            }
+        }
+    }
+    return {
+        report: currentReport,
+        reportPath: currentReportPath,
+        diagnostics,
+    };
+}

package/dist/core/plugins/builtins/xTypescriptTypePlugin.d.ts

@@ -0,0 +1,6 @@
+import { OpenApiGeneratorPlugin } from '../GeneratorPlugin.model';
+/**
+ * Reads `x-typescript-type` OpenAPI extension and maps it to a generated TS type.
+ */
+export declare const xTypescriptTypePlugin: OpenApiGeneratorPlugin;
+//# sourceMappingURL=xTypescriptTypePlugin.d.ts.map

package/dist/core/plugins/builtins/xTypescriptTypePlugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"xTypescriptTypePlugin.d.ts","sourceRoot":"","sources":["../../../../src/core/plugins/builtins/xTypescriptTypePlugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAElE;;GAEG;AACH,eAAO,MAAM,qBAAqB,EAAE,sBAMnC,CAAC"}

package/dist/core/plugins/builtins/xTypescriptTypePlugin.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.xTypescriptTypePlugin = void 0;
+/**
+ * Reads `x-typescript-type` OpenAPI extension and maps it to a generated TS type.
+ */
+exports.xTypescriptTypePlugin = {
+    name: 'x-typescript-type',
+    resolveSchemaTypeOverride: ({ schema }) => {
+        const customType = schema['x-typescript-type'];
+        return typeof customType === 'string' && customType.trim() ? customType.trim() : undefined;
+    },
+};

package/dist/core/plugins/getBuiltinPlugins.d.ts

@@ -0,0 +1,6 @@
+import { OpenApiGeneratorPlugin } from './GeneratorPlugin.model';
+/**
+ * Returns built-in plugins bundled with the generator.
+ */
+export declare function getBuiltinPlugins(): OpenApiGeneratorPlugin[];
+//# sourceMappingURL=getBuiltinPlugins.d.ts.map

package/dist/core/plugins/getBuiltinPlugins.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getBuiltinPlugins.d.ts","sourceRoot":"","sources":["../../../src/core/plugins/getBuiltinPlugins.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,yBAAyB,CAAC;AAGjE;;GAEG;AACH,wBAAgB,iBAAiB,IAAI,sBAAsB,EAAE,CAE5D"}

package/dist/core/plugins/getBuiltinPlugins.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBuiltinPlugins = getBuiltinPlugins;
+const xTypescriptTypePlugin_1 = require("./builtins/xTypescriptTypePlugin");
+/**
+ * Returns built-in plugins bundled with the generator.
+ */
+function getBuiltinPlugins() {
+    return [xTypescriptTypePlugin_1.xTypescriptTypePlugin];
+}

package/dist/core/plugins/index.d.ts

@@ -0,0 +1,4 @@
+export type { ApplySemanticDiffPluginHooksResult, PluginHookDiagnostic, PluginHookName } from './applySemanticDiffPluginHooks';
+export { applySemanticDiffPluginHooks } from './applySemanticDiffPluginHooks';
+export type { OpenApiGeneratorPlugin, SchemaTypeOverrideContext, SchemaTypeOverrideInput, TOpenApiVersion } from './GeneratorPlugin.model';
+//# sourceMappingURL=index.d.ts.map

package/dist/core/plugins/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/core/plugins/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,kCAAkC,EAAE,oBAAoB,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AAC/H,OAAO,EAAE,4BAA4B,EAAE,MAAM,gCAAgC,CAAC;AAC9E,YAAY,EAAE,sBAAsB,EAAE,yBAAyB,EAAE,uBAAuB,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC"}

package/dist/core/plugins/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.applySemanticDiffPluginHooks = void 0;
+var applySemanticDiffPluginHooks_1 = require("./applySemanticDiffPluginHooks");
+Object.defineProperty(exports, "applySemanticDiffPluginHooks", { enumerable: true, get: function () { return applySemanticDiffPluginHooks_1.applySemanticDiffPluginHooks; } });

package/dist/core/plugins/loadGeneratorPlugins.d.ts

@@ -0,0 +1,6 @@
+import { OpenApiGeneratorPlugin } from './GeneratorPlugin.model';
+/**
+ * Loads user plugins and appends built-in plugins as fallback handlers.
+ */
+export declare function loadGeneratorPlugins(pluginPaths: string[]): Promise<OpenApiGeneratorPlugin[]>;
+//# sourceMappingURL=loadGeneratorPlugins.d.ts.map

package/dist/core/plugins/loadGeneratorPlugins.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"loadGeneratorPlugins.d.ts","sourceRoot":"","sources":["../../../src/core/plugins/loadGeneratorPlugins.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,sBAAsB,EAAE,MAAM,yBAAyB,CAAC;AAiDjE;;GAEG;AACH,wBAAsB,oBAAoB,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,sBAAsB,EAAE,CAAC,CAcnG"}

package/dist/core/plugins/loadGeneratorPlugins.js

@@ -0,0 +1,94 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadGeneratorPlugins = loadGeneratorPlugins;
+const pathHelpers_1 = require("../../common/utils/pathHelpers");
+const getBuiltinPlugins_1 = require("./getBuiltinPlugins");
+const node_url_1 = require("node:url");
+/**
+ * Type guard for runtime plugin objects.
+ */
+function isOpenApiGeneratorPlugin(value) {
+    return !!value && typeof value === 'object' && typeof value.name === 'string';
+}
+/**
+ * Resolves plugin export from a required module.
+ */
+function getPluginFromModule(moduleExports) {
+    const exported = moduleExports;
+    return exported?.default ?? exported?.plugin ?? moduleExports;
+}
+/**
+ * Checks whether loader can fallback from require() to dynamic import().
+ */
+function canFallbackToDynamicImport(error) {
+    const errorCode = typeof error === 'object' && error && 'code' in error ? String(error.code) : '';
+    const errorMessage = error instanceof Error ? error.message : '';
+    return (errorCode === 'ERR_REQUIRE_ESM' ||
+        errorCode === 'ERR_UNKNOWN_FILE_EXTENSION' ||
+        errorMessage.includes('Cannot use import statement outside a module') ||
+        errorMessage.includes('Unexpected token export'));
+}
+/**
+ * Loads a plugin module from a file path using require() with import() fallback.
+ */
+async function loadPluginModule(pluginPath) {
+    try {
+        // eslint-disable-next-line @typescript-eslint/no-require-imports
+        return require(pluginPath);
+    }
+    catch (error) {
+        if (!canFallbackToDynamicImport(error)) {
+            throw error;
+        }
+        return Promise.resolve(`${(0, node_url_1.pathToFileURL)(pluginPath).href}`).then(s => __importStar(require(s)));
+    }
+}
+/**
+ * Loads user plugins and appends built-in plugins as fallback handlers.
+ */
+async function loadGeneratorPlugins(pluginPaths) {
+    const loadedPlugins = [];
+    for (const pluginPath of pluginPaths) {
+        const resolvedPath = (0, pathHelpers_1.resolveHelper)(process.cwd(), pluginPath);
+        const moduleExports = await loadPluginModule(resolvedPath);
+        const plugin = getPluginFromModule(moduleExports);
+        if (!isOpenApiGeneratorPlugin(plugin)) {
+            throw new Error(`Invalid plugin at "${pluginPath}": expected export with shape { name: string }`);
+        }
+        loadedPlugins.push(plugin);
+    }
+    return [...loadedPlugins, ...(0, getBuiltinPlugins_1.getBuiltinPlugins)()];
+}

package/dist/core/semanticDiff/__tests__/analyzeOpenApiDiff.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=analyzeOpenApiDiff.test.d.ts.map

package/dist/core/semanticDiff/__tests__/analyzeOpenApiDiff.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"analyzeOpenApiDiff.test.d.ts","sourceRoot":"","sources":["../../../../src/core/semanticDiff/__tests__/analyzeOpenApiDiff.test.ts"],"names":[],"mappings":""}