ts-openapi-codegen 2.1.0-beta.1 → 2.1.0-beta.10

package/dist/core/utils/__tests__/templateRendering.test.js

@@ -0,0 +1,190 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_assert_1 = __importDefault(require("node:assert"));
+const node_test_1 = require("node:test");
+const HttpClient_enum_1 = require("../../types/enums/HttpClient.enum");
+const ModelsMode_enum_1 = require("../../types/enums/ModelsMode.enum");
+const ValidationLibrary_enum_1 = require("../../types/enums/ValidationLibrary.enum");
+const registerHandlebarTemplates_1 = require("../registerHandlebarTemplates");
+const requestContext = {
+    httpClient: HttpClient_enum_1.HttpClient.FETCH,
+    server: 'https://api.example.com',
+    version: '1.0.0',
+    useCancelableRequest: false,
+    useSeparatedIndexes: false,
+};
+const schemaModel = {
+    name: 'UserSchema',
+    alias: '',
+    path: 'schemas',
+    export: 'interface',
+    type: 'UserSchema',
+    base: 'UserSchema',
+    template: null,
+    link: null,
+    description: null,
+    isDefinition: true,
+    isReadOnly: false,
+    isRequired: false,
+    isNullable: false,
+    imports: [],
+    enum: [],
+    enums: [],
+    properties: [
+        {
+            name: 'id',
+            alias: '',
+            path: 'schemas',
+            export: 'generic',
+            type: 'string',
+            base: 'string',
+            template: null,
+            link: null,
+            description: null,
+            isDefinition: false,
+            isReadOnly: false,
+            isRequired: true,
+            isNullable: false,
+            imports: [],
+            enum: [],
+            enums: [],
+            properties: [],
+        },
+    ],
+};
+const exportClientContext = {
+    outputCore: './generated/core',
+    useCustomRequest: false,
+    services: [],
+};
+const exportModelsContext = {
+    models: [schemaModel],
+    httpClient: HttpClient_enum_1.HttpClient.FETCH,
+    useUnionTypes: false,
+    useOptions: false,
+    outputCore: '../core',
+    modelsMode: ModelsMode_enum_1.ModelsMode.CLASSES,
+};
+(0, node_test_1.describe)('@unit: templateRendering', () => {
+    for (const httpClient of Object.values(HttpClient_enum_1.HttpClient)) {
+        for (const useCancelableRequest of [false, true]) {
+            (0, node_test_1.test)(`renders request template for ${httpClient} (cancelable=${useCancelableRequest})`, () => {
+                const templates = (0, registerHandlebarTemplates_1.registerHandlebarTemplates)({
+                    httpClient,
+                    useOptions: false,
+                    useUnionTypes: false,
+                    validationLibrary: ValidationLibrary_enum_1.ValidationLibrary.NONE,
+                });
+                const output = templates.core.request({
+                    ...requestContext,
+                    httpClient,
+                    useCancelableRequest,
+                });
+                node_assert_1.default.ok(output.length > 100);
+                node_assert_1.default.match(output, /function request/i);
+            });
+        }
+    }
+    (0, node_test_1.test)('renders exportClient and exportModels templates', () => {
+        const templates = (0, registerHandlebarTemplates_1.registerHandlebarTemplates)({
+            httpClient: HttpClient_enum_1.HttpClient.FETCH,
+            useOptions: false,
+            useUnionTypes: false,
+            validationLibrary: ValidationLibrary_enum_1.ValidationLibrary.NONE,
+        });
+        const clientOutput = templates.exports.client(exportClientContext);
+        const modelsOutput = templates.exports.models(exportModelsContext);
+        node_assert_1.default.match(clientOutput, /createClient|RequestExecutor/i);
+        node_assert_1.default.match(modelsOutput, /BaseDto|fromArray/);
+    });
+    (0, node_test_1.test)('renders exportModels with ghost properties and type aliases', () => {
+        const modelWithGhost = {
+            ...schemaModel,
+            name: 'IUser',
+            type: 'IUser',
+            base: 'IUser',
+            rawName: 'IUserRaw',
+            dtoName: 'IUserDto',
+            exportName: 'IUser',
+            dtoKind: 'class',
+            ghostProperties: [
+                {
+                    name: 'legacyField',
+                    alias: '',
+                    path: 'models',
+                    export: 'generic',
+                    type: 'unknown',
+                    base: 'unknown',
+                    template: null,
+                    link: null,
+                    description: null,
+                    isDefinition: false,
+                    isReadOnly: false,
+                    isRequired: false,
+                    isNullable: false,
+                    imports: [],
+                    enum: [],
+                    enums: [],
+                    properties: [],
+                    isGhost: true,
+                },
+            ],
+            properties: [
+                {
+                    name: 'id',
+                    alias: '',
+                    path: 'models',
+                    export: 'generic',
+                    type: 'string',
+                    base: 'string',
+                    template: null,
+                    link: null,
+                    description: null,
+                    isDefinition: false,
+                    isReadOnly: false,
+                    isRequired: true,
+                    isNullable: false,
+                    imports: [],
+                    enum: [],
+                    enums: [],
+                    properties: [],
+                    rawType: 'string',
+                    dtoType: 'string',
+                    dtoInit: 'data.id',
+                    dtoTarget: '.id',
+                },
+            ],
+        };
+        const templates = (0, registerHandlebarTemplates_1.registerHandlebarTemplates)({
+            httpClient: HttpClient_enum_1.HttpClient.FETCH,
+            useOptions: false,
+            useUnionTypes: false,
+            validationLibrary: ValidationLibrary_enum_1.ValidationLibrary.NONE,
+        });
+        const output = templates.exports.models({
+            ...exportModelsContext,
+            models: [modelWithGhost],
+        });
+        node_assert_1.default.match(output, /legacyField\?: unknown/);
+        node_assert_1.default.match(output, /export type IUser = IUserRaw/);
+    });
+    (0, node_test_1.test)('renders schema export with validation library context', () => {
+        const templates = (0, registerHandlebarTemplates_1.registerHandlebarTemplates)({
+            httpClient: HttpClient_enum_1.HttpClient.FETCH,
+            useOptions: false,
+            useUnionTypes: false,
+            validationLibrary: ValidationLibrary_enum_1.ValidationLibrary.ZOD,
+        });
+        const output = templates.exports.schema({
+            ...schemaModel,
+            httpClient: HttpClient_enum_1.HttpClient.FETCH,
+            useUnionTypes: false,
+            validationLibrary: ValidationLibrary_enum_1.ValidationLibrary.ZOD,
+        });
+        node_assert_1.default.ok(output.length > 20);
+        node_assert_1.default.match(output, /UserSchema/i);
+    });
+});

package/dist/core/utils/__tests__/writeFileIfChanged.test.d.ts

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

package/dist/core/utils/__tests__/writeFileIfChanged.test.d.ts.map

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

package/dist/core/utils/__tests__/writeFileIfChanged.test.js

@@ -0,0 +1,30 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const strict_1 = __importDefault(require("node:assert/strict"));
+const promises_1 = require("node:fs/promises");
+const node_os_1 = require("node:os");
+const node_path_1 = require("node:path");
+const node_test_1 = require("node:test");
+const writeFileIfChanged_1 = require("../writeFileIfChanged");
+(0, node_test_1.describe)('@unit: writeFileIfChanged', () => {
+    (0, node_test_1.test)('writes new file and skips unchanged content', async () => {
+        const dir = await (0, promises_1.mkdtemp)((0, node_path_1.join)((0, node_os_1.tmpdir)(), 'openapi-codegen-'));
+        const file = (0, node_path_1.join)(dir, 'index.ts');
+        try {
+            const firstResult = await (0, writeFileIfChanged_1.writeFileIfChanged)(file, 'export const a = 1;\n');
+            const secondResult = await (0, writeFileIfChanged_1.writeFileIfChanged)(file, 'export const a = 1;\n');
+            const thirdResult = await (0, writeFileIfChanged_1.writeFileIfChanged)(file, 'export const a = 2;\n');
+            const content = await (0, promises_1.readFile)(file, 'utf8');
+            strict_1.default.equal(firstResult, 'written');
+            strict_1.default.equal(secondResult, 'unchanged');
+            strict_1.default.equal(thirdResult, 'written');
+            strict_1.default.equal(content, 'export const a = 2;\n');
+        }
+        finally {
+            await (0, promises_1.rm)(dir, { recursive: true, force: true });
+        }
+    });
+});

package/dist/core/utils/adapters/__tests__/semanticToStructural.test.d.ts

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

package/dist/core/utils/adapters/__tests__/semanticToStructural.test.d.ts.map

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

package/dist/core/utils/adapters/__tests__/semanticToStructural.test.js

@@ -0,0 +1,63 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_assert_1 = __importDefault(require("node:assert"));
+const node_test_1 = require("node:test");
+const semanticToStructural_1 = require("../semanticToStructural");
+(0, node_test_1.describe)('@unit: semanticToStructural adapter', () => {
+    (0, node_test_1.test)('groups semantic changes by legacy severity and calculates stats', () => {
+        const changes = [
+            {
+                type: 'model.property.removed',
+                severity: 'breaking',
+                path: '#/components/schemas/User/properties/oldName',
+                message: 'removed',
+                from: { type: 'string' },
+            },
+            {
+                type: 'model.property.added',
+                severity: 'non-breaking',
+                path: '#/components/schemas/User/properties/newName',
+                message: 'added',
+                to: { type: 'string' },
+            },
+            {
+                type: 'model.property.type.changed',
+                severity: 'informational',
+                path: '#/components/schemas/User/properties/age',
+                message: 'type changed',
+                from: 'integer',
+                to: 'integer:int64',
+            },
+        ];
+        const structural = (0, semanticToStructural_1.adaptSemanticToStructural)({ changes }, 2);
+        node_assert_1.default.strictEqual(structural.diff.all.length, 3);
+        node_assert_1.default.strictEqual(structural.diff.breaking.length, 1);
+        node_assert_1.default.strictEqual(structural.diff.warnings.length, 1);
+        node_assert_1.default.strictEqual(structural.diff.info.length, 1);
+        node_assert_1.default.strictEqual(structural.stats.totalChanges, 3);
+        node_assert_1.default.strictEqual(structural.stats.added, 1);
+        node_assert_1.default.strictEqual(structural.stats.removed, 1);
+        node_assert_1.default.strictEqual(structural.stats.changed, 1);
+        node_assert_1.default.strictEqual(structural.stats.ignored, 2);
+        node_assert_1.default.strictEqual(structural.stats.stabilityScore, 67);
+    });
+    (0, node_test_1.test)('uses provided miracles instead of rebuilding them', () => {
+        const structural = (0, semanticToStructural_1.adaptSemanticToStructural)({
+            changes: [],
+            miracles: [
+                {
+                    oldPath: '$.old',
+                    newPath: '$.new',
+                    type: 'RENAME',
+                    confidence: 1,
+                    status: 'confirmed',
+                },
+            ],
+        });
+        node_assert_1.default.strictEqual(structural.miracles.length, 1);
+        node_assert_1.default.strictEqual(structural.miracles[0].status, 'confirmed');
+    });
+});

package/dist/core/utils/adapters/extractMiraclesFromSemantic.d.ts

@@ -0,0 +1,10 @@
+import type { SemanticDiffChange } from '../../semanticDiff/analyzeOpenApiDiff';
+import type { MiracleEntry } from '../../types/shared/Miracle.model';
+/**
+ * Возвращает miracles из отчёта или строит их из семантических изменений.
+ * @param changes список семантических изменений
+ * @param [miracles] готовый список miracles из отчёта
+ * @returns список miracles для структурного diff
+ */
+export declare function extractMiraclesFromSemantic(changes: SemanticDiffChange[], miracles?: MiracleEntry[]): MiracleEntry[];
+//# sourceMappingURL=extractMiraclesFromSemantic.d.ts.map

package/dist/core/utils/adapters/extractMiraclesFromSemantic.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"extractMiraclesFromSemantic.d.ts","sourceRoot":"","sources":["../../../../src/core/utils/adapters/extractMiraclesFromSemantic.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,uCAAuC,CAAC;AAChF,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAC;AAGrE;;;;;GAKG;AACH,wBAAgB,2BAA2B,CAAC,OAAO,EAAE,kBAAkB,EAAE,EAAE,QAAQ,CAAC,EAAE,YAAY,EAAE,GAAG,YAAY,EAAE,CAEpH"}

package/dist/core/utils/adapters/extractMiraclesFromSemantic.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractMiraclesFromSemantic = extractMiraclesFromSemantic;
+const buildMiraclesFromSemanticChanges_1 = require("../buildMiraclesFromSemanticChanges");
+/**
+ * Возвращает miracles из отчёта или строит их из семантических изменений.
+ * @param changes список семантических изменений
+ * @param [miracles] готовый список miracles из отчёта
+ * @returns список miracles для структурного diff
+ */
+function extractMiraclesFromSemantic(changes, miracles) {
+    return miracles?.length ? miracles : (0, buildMiraclesFromSemanticChanges_1.buildMiraclesFromSemanticChanges)(changes);
+}

package/dist/core/utils/adapters/index.d.ts

@@ -0,0 +1,3 @@
+/** Реэкспорт адаптеров семантического diff в структурный формат. */
+export { adaptSemanticToStructural, type SemanticDiffLike } from './semanticToStructural';
+//# sourceMappingURL=index.d.ts.map

package/dist/core/utils/adapters/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/core/utils/adapters/index.ts"],"names":[],"mappings":"AAAA,oEAAoE;AACpE,OAAO,EAAE,yBAAyB,EAAE,KAAK,gBAAgB,EAAE,MAAM,wBAAwB,CAAC"}

package/dist/core/utils/adapters/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.adaptSemanticToStructural = void 0;
+/** Реэкспорт адаптеров семантического diff в структурный формат. */
+var semanticToStructural_1 = require("./semanticToStructural");
+Object.defineProperty(exports, "adaptSemanticToStructural", { enumerable: true, get: function () { return semanticToStructural_1.adaptSemanticToStructural; } });

package/dist/core/utils/adapters/semanticToStructural.d.ts

@@ -0,0 +1,12 @@
+import type { SemanticDiffReport } from '../../semanticDiff/analyzeOpenApiDiff';
+import type { StructuralDiffPart } from '../../types/DiffReport.model';
+/** Минимальный набор полей семантического diff для адаптации в структурный формат. */
+export type SemanticDiffLike = Pick<SemanticDiffReport, 'changes' | 'miracles'>;
+/**
+ * Преобразует семантический diff в структурную часть legacy-отчёта.
+ * @param semantic семантический diff или его подмножество
+ * @param [ignored] количество проигнорированных изменений
+ * @returns структурная часть diff-отчёта
+ */
+export declare function adaptSemanticToStructural(semantic: SemanticDiffLike, ignored?: number): StructuralDiffPart;
+//# sourceMappingURL=semanticToStructural.d.ts.map

package/dist/core/utils/adapters/semanticToStructural.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"semanticToStructural.d.ts","sourceRoot":"","sources":["../../../../src/core/utils/adapters/semanticToStructural.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,uCAAuC,CAAC;AAChF,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAIvE,sFAAsF;AACtF,MAAM,MAAM,gBAAgB,GAAG,IAAI,CAAC,kBAAkB,EAAE,SAAS,GAAG,UAAU,CAAC,CAAC;AAgBhF;;;;;GAKG;AACH,wBAAgB,yBAAyB,CAAC,QAAQ,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,kBAAkB,CAa1G"}

package/dist/core/utils/adapters/semanticToStructural.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.adaptSemanticToStructural = adaptSemanticToStructural;
+const semanticChangesToDiffEntries_1 = require("../semanticChangesToDiffEntries");
+const extractMiraclesFromSemantic_1 = require("./extractMiraclesFromSemantic");
+function calculateStats(all, ignored) {
+    const breakingCount = all.filter(entry => entry.severity === 'breaking').length;
+    const stabilityScore = all.length === 0 ? 100 : Math.round(((all.length - breakingCount) / all.length) * 100);
+    return {
+        totalChanges: all.length,
+        added: all.filter(entry => entry.action === 'added').length,
+        removed: all.filter(entry => entry.action === 'removed').length,
+        changed: all.filter(entry => entry.action === 'changed').length,
+        ignored: ignored || undefined,
+        stabilityScore,
+    };
+}
+/**
+ * Преобразует семантический diff в структурную часть legacy-отчёта.
+ * @param semantic семантический diff или его подмножество
+ * @param [ignored] количество проигнорированных изменений
+ * @returns структурная часть diff-отчёта
+ */
+function adaptSemanticToStructural(semantic, ignored) {
+    const all = (0, semanticChangesToDiffEntries_1.semanticChangesToDiffEntries)(semantic.changes);
+    return {
+        diff: {
+            breaking: all.filter(entry => entry.severity === 'breaking'),
+            warnings: all.filter(entry => entry.severity === 'warning'),
+            info: all.filter(entry => entry.severity === 'info'),
+            all,
+        },
+        miracles: (0, extractMiraclesFromSemantic_1.extractMiraclesFromSemantic)(semantic.changes, semantic.miracles),
+        stats: calculateStats(all, ignored),
+    };
+}

package/dist/core/utils/applyDiffReportToClient.d.ts

@@ -1,3 +1,4 @@
+import type { Context } from '../Context';
 import type { PrefixArtifacts } from '../types/base/PrefixArtifacts.model';
 import type { Client } from '../types/shared/Client.model';
 import { OpenApiVersion } from './getOpenApiVersion';
@@ -8,7 +9,18 @@ type ApplyDiffParams = {
     openApiVersion: OpenApiVersion;
     diffReport: DiffReport | null;
     prefix: PrefixArtifacts;
+    context?: Context;
 };
-export declare const applyDiffReportToClient: ({ client, openApi, openApiVersion, diffReport, prefix }: ApplyDiffParams) => Client;
+/**
+ * Применяет структурный diff-отчёт к сгенерированному клиенту: помечает изменения, miracles и ghost-свойства.
+ * @param client сгенерированный клиент
+ * @param openApi исходная OpenAPI-спецификация
+ * @param openApiVersion версия OpenAPI
+ * @param diffReport загруженный diff-отчёт или null
+ * @param prefix артефакты префиксов имён
+ * @param [context] контекст генерации для разрешения имён схем
+ * @returns клиент с аннотациями diff
+ */
+export declare const applyDiffReportToClient: ({ client, openApi, openApiVersion, diffReport, prefix, context }: ApplyDiffParams) => Client;
 export {};
 //# sourceMappingURL=applyDiffReportToClient.d.ts.map

package/dist/core/utils/applyDiffReportToClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"applyDiffReportToClient.d.ts","sourceRoot":"","sources":["../../../src/core/utils/applyDiffReportToClient.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qCAAqC,CAAC;AAC3E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,8BAA8B,CAAC;AAW3D,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAIrD,OAAO,KAAK,EAAE,UAAU,EAAmB,MAAM,kBAAkB,CAAC;AAGpE,KAAK,eAAe,GAAG;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,cAAc,EAAE,cAAc,CAAC;IAC/B,UAAU,EAAE,UAAU,GAAG,IAAI,CAAC;IAC9B,MAAM,EAAE,eAAe,CAAC;CAC3B,CAAC;AA2WF,eAAO,MAAM,uBAAuB,GAAI,yDAAyD,eAAe,KAAG,MAwClH,CAAC"}
+{"version":3,"file":"applyDiffReportToClient.d.ts","sourceRoot":"","sources":["../../../src/core/utils/applyDiffReportToClient.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qCAAqC,CAAC;AAC3E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,8BAA8B,CAAC;AAY3D,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAKrD,OAAO,KAAK,EAAE,UAAU,EAAmB,MAAM,kBAAkB,CAAC;AAGpE,KAAK,eAAe,GAAG;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,cAAc,EAAE,cAAc,CAAC;IAC/B,UAAU,EAAE,UAAU,GAAG,IAAI,CAAC;IAC9B,MAAM,EAAE,eAAe,CAAC;IACxB,OAAO,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC;AAsbF;;;;;;;;;GASG;AACH,eAAO,MAAM,uBAAuB,GAAI,kEAAkE,eAAe,KAAG,MAwC3H,CAAC"}