ts-openapi-codegen 2.1.0-beta.8 → 2.1.0-beta.9

package/dist/core/types/DiffReport.model.d.ts

@@ -0,0 +1,101 @@
+import type { GovernanceReport } from '../governance/evaluateGovernanceRules';
+import type { SemanticDiffChange, SemanticDiffRecommendation, SemanticDiffSummary } from '../semanticDiff/analyzeOpenApiDiff';
+import type { DiffInfo } from './shared/DiffInfo.model';
+import type { MiracleEntry } from './shared/Miracle.model';
+/** Версия схемы унифицированного diff-отчёта. */
+export declare const UNIFIED_DIFF_REPORT_SCHEMA_VERSION = "2.0.0";
+/** Запись структурного diff с обязательным действием изменения. */
+export interface DiffReportEntry extends DiffInfo {
+    action: DiffInfo['action'];
+}
+/**
+ * Метаданные diff-отчёта.
+ * @property [base] источник базовой спецификации
+ * @property [target] источник целевой спецификации
+ * @property [baseHash] хеш базовой спецификации
+ * @property [targetHash] хеш целевой спецификации
+ */
+export interface DiffReportMetadata {
+    base?: string;
+    target?: string;
+    baseHash?: string;
+    targetHash?: string;
+}
+/**
+ * Статистика изменений в diff-отчёте.
+ * @property [totalChanges] общее количество изменений
+ * @property [added] количество добавлений
+ * @property [removed] количество удалений
+ * @property [changed] количество изменений
+ * @property [ignored] количество проигнорированных изменений
+ * @property [stabilityScore] оценка стабильности API в процентах
+ */
+export interface DiffReportStats {
+    totalChanges?: number;
+    added?: number;
+    removed?: number;
+    changed?: number;
+    ignored?: number;
+    stabilityScore?: number;
+}
+/**
+ * Структурная часть diff-отчёта для генерации клиента.
+ * @property diff группы изменений по уровню серьёзности
+ * @property miracles кандидаты на переименование и приведение типов
+ * @property stats агрегированная статистика изменений
+ */
+export interface StructuralDiffPart {
+    diff: {
+        breaking: DiffReportEntry[];
+        warnings: DiffReportEntry[];
+        info: DiffReportEntry[];
+        all: DiffReportEntry[];
+    };
+    miracles: MiracleEntry[];
+    stats: DiffReportStats;
+}
+/**
+ * Legacy diff-отчёт для обратной совместимости.
+ * @property [version] версия схемы отчёта
+ * @property [timestamp] время формирования отчёта
+ * @property [metadata] метаданные сравниваемых спецификаций
+ * @property [stats] статистика изменений
+ * @property [diff] группы изменений по уровню серьёзности
+ * @property [miracles] кандидаты на переименование и приведение типов
+ */
+export interface DiffReport {
+    version?: string;
+    timestamp?: string;
+    metadata?: DiffReportMetadata;
+    stats?: DiffReportStats;
+    diff?: {
+        breaking?: DiffReportEntry[];
+        warnings?: DiffReportEntry[];
+        info?: DiffReportEntry[];
+        all?: DiffReportEntry[];
+    };
+    miracles?: MiracleEntry[];
+}
+/**
+ * Унифицированный diff-отчёт с семантической и структурной частями.
+ * @property schemaVersion версия схемы отчёта
+ * @property timestamp время формирования отчёта
+ * @property metadata метаданные сравниваемых спецификаций
+ * @property semantic семантический анализ изменений
+ * @property structural структурная часть для генерации клиента
+ */
+export interface UnifiedDiffReport {
+    schemaVersion: typeof UNIFIED_DIFF_REPORT_SCHEMA_VERSION;
+    timestamp: string;
+    metadata: DiffReportMetadata;
+    semantic: {
+        changes: SemanticDiffChange[];
+        governance: GovernanceReport;
+        recommendation: SemanticDiffRecommendation;
+        summary: SemanticDiffSummary;
+    };
+    structural: StructuralDiffPart;
+}
+/** Реэкспорт типов структурного diff и miracles. */
+export type { DiffInfo, MiracleEntry };
+//# sourceMappingURL=DiffReport.model.d.ts.map

package/dist/core/types/DiffReport.model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DiffReport.model.d.ts","sourceRoot":"","sources":["../../../src/core/types/DiffReport.model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,uCAAuC,CAAC;AAC9E,OAAO,KAAK,EAAE,kBAAkB,EAAE,0BAA0B,EAAE,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AAC9H,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAE3D,iDAAiD;AACjD,eAAO,MAAM,kCAAkC,UAAU,CAAC;AAE1D,mEAAmE;AACnE,MAAM,WAAW,eAAgB,SAAQ,QAAQ;IAC7C,MAAM,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;CAC9B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,kBAAkB;IAC/B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,eAAe;IAC5B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,cAAc,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IAC/B,IAAI,EAAE;QACF,QAAQ,EAAE,eAAe,EAAE,CAAC;QAC5B,QAAQ,EAAE,eAAe,EAAE,CAAC;QAC5B,IAAI,EAAE,eAAe,EAAE,CAAC;QACxB,GAAG,EAAE,eAAe,EAAE,CAAC;KAC1B,CAAC;IACF,QAAQ,EAAE,YAAY,EAAE,CAAC;IACzB,KAAK,EAAE,eAAe,CAAC;CAC1B;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,UAAU;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,kBAAkB,CAAC;IAC9B,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB,IAAI,CAAC,EAAE;QACH,QAAQ,CAAC,EAAE,eAAe,EAAE,CAAC;QAC7B,QAAQ,CAAC,EAAE,eAAe,EAAE,CAAC;QAC7B,IAAI,CAAC,EAAE,eAAe,EAAE,CAAC;QACzB,GAAG,CAAC,EAAE,eAAe,EAAE,CAAC;KAC3B,CAAC;IACF,QAAQ,CAAC,EAAE,YAAY,EAAE,CAAC;CAC7B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,iBAAiB;IAC9B,aAAa,EAAE,OAAO,kCAAkC,CAAC;IACzD,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,QAAQ,EAAE;QACN,OAAO,EAAE,kBAAkB,EAAE,CAAC;QAC9B,UAAU,EAAE,gBAAgB,CAAC;QAC7B,cAAc,EAAE,0BAA0B,CAAC;QAC3C,OAAO,EAAE,mBAAmB,CAAC;KAChC,CAAC;IACF,UAAU,EAAE,kBAAkB,CAAC;CAClC;AAED,oDAAoD;AACpD,YAAY,EAAE,QAAQ,EAAE,YAAY,EAAE,CAAC"}

package/dist/core/types/DiffReport.model.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UNIFIED_DIFF_REPORT_SCHEMA_VERSION = void 0;
+/** Версия схемы унифицированного diff-отчёта. */
+exports.UNIFIED_DIFF_REPORT_SCHEMA_VERSION = '2.0.0';

package/dist/core/types/shared/Model.model.d.ts

@@ -2,6 +2,41 @@ import type { DiffInfo } from './DiffInfo.model';
 import type { Enum } from './Enum.model';
 import { Import } from './Import.model';
 import type { Schema } from './Schema.model';
+/**
+ * Модель OpenAPI-схемы для генерации TypeScript-типов и DTO.
+ * @property name имя модели
+ * @property alias алиас для экспорта
+ * @property path путь к схеме в спецификации
+ * @property export способ экспорта модели
+ * @property type строковое представление типа
+ * @property base базовый тип
+ * @property template шаблон generic-типа
+ * @property link связанная модель
+ * @property description описание схемы
+ * @property [default] значение по умолчанию
+ * @property imports импорты модели
+ * @property enum значения enum
+ * @property enums вложенные enum-модели
+ * @property properties свойства модели
+ * @property [ghostProperties] свойства, удалённые в новой версии API
+ * @property [diff] основное diff-изменение свойства
+ * @property [structuralDiff] список структурных diff-изменений
+ * @property [isGhost] признак ghost-свойства
+ * @property [rawName] имя raw-типа в режиме classes
+ * @property [dtoName] имя DTO-типа в режиме classes
+ * @property [exportName] имя для экспорта в режиме classes
+ * @property [rawType] строковое представление raw-типа
+ * @property [dtoType] строковое представление DTO-типа
+ * @property [dtoInit] инициализатор DTO
+ * @property [dtoToJSON] метод сериализации DTO
+ * @property [dtoTarget] целевой тип DTO
+ * @property [dtoKind] вид DTO: class или alias
+ * @property [dtoGetters] геттеры для переименованных свойств
+ * @property [needsCoercion] требуется приведение типа
+ * @property [coercionFrom] исходный тип приведения
+ * @property [coercionTo] целевой тип приведения
+ * @property [hasCoercion] признак наличия приведения типа
+ */
 export interface Model extends Schema {
     name: string;
     alias: string;
@@ -23,6 +58,7 @@ export interface Model extends Schema {
     isGhost?: boolean;
     rawName?: string;
     dtoName?: string;
+    exportName?: string;
     rawType?: string;
     dtoType?: string;
     dtoInit?: string;

package/dist/core/types/shared/Model.model.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Model.model.d.ts","sourceRoot":"","sources":["../../../../src/core/types/shared/Model.model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AACxC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,WAAW,KAAM,SAAQ,MAAM;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,WAAW,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,YAAY,GAAG,WAAW,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC;IACjH,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,IAAI,EAAE,KAAK,GAAG,IAAI,CAAC;IACnB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,IAAI,EAAE,IAAI,EAAE,CAAC;IACb,KAAK,EAAE,KAAK,EAAE,CAAC;IACf,UAAU,EAAE,KAAK,EAAE,CAAC;IACpB,eAAe,CAAC,EAAE,KAAK,EAAE,CAAC;IAC1B,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,cAAc,CAAC,EAAE,QAAQ,EAAE,CAAC;IAC5B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;IAC5B,UAAU,CAAC,EAAE;QACT,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;QAChB,MAAM,EAAE,MAAM,CAAC;QACf,UAAU,CAAC,EAAE,MAAM,CAAC;KACvB,EAAE,CAAC;IACJ,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,OAAO,CAAC;CACzB"}
+{"version":3,"file":"Model.model.d.ts","sourceRoot":"","sources":["../../../../src/core/types/shared/Model.model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AACxC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAE7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAM,WAAW,KAAM,SAAQ,MAAM;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,WAAW,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,YAAY,GAAG,WAAW,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC;IACjH,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,IAAI,EAAE,KAAK,GAAG,IAAI,CAAC;IACnB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,IAAI,EAAE,IAAI,EAAE,CAAC;IACb,KAAK,EAAE,KAAK,EAAE,CAAC;IACf,UAAU,EAAE,KAAK,EAAE,CAAC;IACpB,eAAe,CAAC,EAAE,KAAK,EAAE,CAAC;IAC1B,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,cAAc,CAAC,EAAE,QAAQ,EAAE,CAAC;IAC5B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;IAC5B,UAAU,CAAC,EAAE;QACT,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;QAChB,MAAM,EAAE,MAAM,CAAC;QACf,UAAU,CAAC,EAAE,MAAM,CAAC;KACvB,EAAE,CAAC;IACJ,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,OAAO,CAAC;CACzB"}

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

@@ -105,4 +105,186 @@ const createObjectModel = (name, properties) => ({
         node_assert_1.default.strictEqual(property?.coercionTo, 'number');
         node_assert_1.default.ok(updatedModel.hasCoercion, 'Expected model.hasCoercion to be true');
     });
+    (0, node_test_1.test)('marks needsCoercion for $ref alias schema via Context resolver', () => {
+        const userBodyDef = {
+            type: 'object',
+            properties: {
+                age: { type: 'number' },
+            },
+        };
+        const mockContext = {
+            get: (ref) => {
+                if (ref === '#/components/schemas/User') {
+                    return userBodyDef;
+                }
+                return undefined;
+            },
+        };
+        const userModel = createObjectModel('IUser', [createPropertyModel('age', 'number')]);
+        const client = {
+            version: '1.0.0',
+            server: 'http://localhost',
+            models: [userModel],
+            services: [],
+        };
+        const openApi = {
+            openapi: '3.0.0',
+            info: { title: 'Test', version: '1.0.0' },
+            paths: {},
+            components: {
+                schemas: {
+                    User: { $ref: '#/components/schemas/UserBody' },
+                    UserBody: userBodyDef,
+                },
+            },
+        };
+        const report = {
+            diff: {
+                all: [
+                    {
+                        action: 'changed',
+                        path: '$.components.schemas.User.properties.age.type',
+                        severity: 'warning',
+                        from: 'string',
+                        to: 'number',
+                    },
+                ],
+            },
+            miracles: [
+                {
+                    oldPath: '$.components.schemas.User.properties.age',
+                    newPath: '$.components.schemas.User.properties.age',
+                    type: 'TYPE_COERCION',
+                    confidence: 1,
+                    status: 'auto-generated',
+                },
+            ],
+        };
+        const result = (0, applyDiffReportToClient_1.applyDiffReportToClient)({
+            client,
+            openApi,
+            openApiVersion: getOpenApiVersion_1.OpenApiVersion.V3,
+            diffReport: report,
+            prefix: { interface: 'I', enum: 'E', type: 'T' },
+            context: mockContext,
+        });
+        const updatedModel = result.models[0];
+        const property = updatedModel.properties.find(prop => prop.name === 'age');
+        node_assert_1.default.ok(property?.needsCoercion, 'Expected needsCoercion to be true for $ref schema');
+        node_assert_1.default.strictEqual(property?.coercionFrom, 'string');
+        node_assert_1.default.strictEqual(property?.coercionTo, 'number');
+        node_assert_1.default.ok(updatedModel.hasCoercion, 'Expected model.hasCoercion to be true');
+    });
+    (0, node_test_1.test)('marks needsCoercion on property via applyModelDiffs with $ref schema', () => {
+        const userBodyDef = {
+            type: 'object',
+            properties: {
+                age: { type: 'number' },
+            },
+        };
+        const mockContext = {
+            get: (ref) => {
+                if (ref === '#/components/schemas/User') {
+                    return userBodyDef;
+                }
+                return undefined;
+            },
+        };
+        const userModel = createObjectModel('IUser', [createPropertyModel('age', 'number')]);
+        const client = {
+            version: '1.0.0',
+            server: 'http://localhost',
+            models: [userModel],
+            services: [],
+        };
+        const openApi = {
+            openapi: '3.0.0',
+            info: { title: 'Test', version: '1.0.0' },
+            paths: {},
+            components: {
+                schemas: {
+                    User: { $ref: '#/components/schemas/UserBody' },
+                    UserBody: userBodyDef,
+                },
+            },
+        };
+        const report = {
+            diff: {
+                all: [
+                    {
+                        action: 'changed',
+                        path: '$.components.schemas.User.properties.age.type',
+                        severity: 'warning',
+                        from: 'string',
+                        to: 'number',
+                    },
+                ],
+            },
+        };
+        const result = (0, applyDiffReportToClient_1.applyDiffReportToClient)({
+            client,
+            openApi,
+            openApiVersion: getOpenApiVersion_1.OpenApiVersion.V3,
+            diffReport: report,
+            prefix: { interface: 'I', enum: 'E', type: 'T' },
+            context: mockContext,
+        });
+        const updatedModel = result.models[0];
+        const property = updatedModel.properties.find(prop => prop.name === 'age');
+        node_assert_1.default.ok(property?.needsCoercion, 'Expected needsCoercion from applyModelDiffs');
+        node_assert_1.default.strictEqual(property?.coercionFrom, 'string');
+        node_assert_1.default.strictEqual(property?.coercionTo, 'number');
+        node_assert_1.default.ok(updatedModel.hasCoercion, 'Expected model.hasCoercion to be true');
+    });
+    (0, node_test_1.test)('applies model diffs to all models with the same schema name', () => {
+        const sequence1 = createObjectModel('ISequence', [createPropertyModel('pathway_id', 'string')]);
+        const sequence2 = createObjectModel('ISequence', [createPropertyModel('pathwayId', 'string')]);
+        sequence2.alias = 'ISequence$2';
+        const client = {
+            version: '1.0.0',
+            server: 'http://localhost',
+            models: [sequence1, sequence2],
+            services: [],
+        };
+        const openApi = {
+            openapi: '3.0.0',
+            info: { title: 'Test', version: '1.0.0' },
+            paths: {},
+            components: {
+                schemas: {
+                    Sequence: {
+                        type: 'object',
+                        properties: {
+                            pathway_id: { type: 'string' },
+                            pathwayId: { type: 'string' },
+                        },
+                    },
+                },
+            },
+        };
+        const report = {
+            diff: {
+                all: [
+                    {
+                        action: 'removed',
+                        path: '$.components.schemas.Sequence.properties.legacyField',
+                        severity: 'warning',
+                    },
+                ],
+            },
+        };
+        const result = (0, applyDiffReportToClient_1.applyDiffReportToClient)({
+            client,
+            openApi,
+            openApiVersion: getOpenApiVersion_1.OpenApiVersion.V3,
+            diffReport: report,
+            prefix: { interface: 'I', enum: 'E', type: 'T' },
+        });
+        const updated1 = result.models.find(model => model.name === 'ISequence' && !model.alias);
+        const updated2 = result.models.find(model => model.alias === 'ISequence$2');
+        node_assert_1.default.strictEqual(updated1?.ghostProperties?.length, 1);
+        node_assert_1.default.strictEqual(updated1?.ghostProperties?.[0].name, 'legacyField');
+        node_assert_1.default.strictEqual(updated2?.ghostProperties?.length, 1);
+        node_assert_1.default.strictEqual(updated2?.ghostProperties?.[0].name, 'legacyField');
+    });
 });

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

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

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

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

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

@@ -0,0 +1,77 @@
+"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 buildMiraclesFromSemanticChanges_1 = require("../buildMiraclesFromSemanticChanges");
+(0, node_test_1.describe)('@unit: buildMiraclesFromSemanticChanges', () => {
+    (0, node_test_1.test)('parses schema property pointer', () => {
+        const parsed = (0, buildMiraclesFromSemanticChanges_1.parseSchemaPropertyPointer)('#/components/schemas/User/properties/first_name');
+        node_assert_1.default.ok(parsed);
+        node_assert_1.default.strictEqual(parsed.schemaName, 'User');
+        node_assert_1.default.strictEqual(parsed.propertyName, 'first_name');
+        node_assert_1.default.strictEqual(parsed.jsonPath, '$.components.schemas.User.properties.first_name');
+    });
+    (0, node_test_1.test)('creates RENAME miracle between removed and added property', () => {
+        const changes = [
+            {
+                type: 'model.property.removed',
+                severity: 'breaking',
+                path: '#/components/schemas/User/properties/first_name',
+                message: 'removed',
+                from: { type: 'string' },
+            },
+            {
+                type: 'model.property.added',
+                severity: 'non-breaking',
+                path: '#/components/schemas/User/properties/firstName',
+                message: 'added',
+                to: { type: 'string' },
+            },
+        ];
+        const miracles = (0, buildMiraclesFromSemanticChanges_1.buildMiraclesFromSemanticChanges)(changes);
+        node_assert_1.default.strictEqual(miracles.length, 1);
+        node_assert_1.default.strictEqual(miracles[0].type, 'RENAME');
+        node_assert_1.default.strictEqual(miracles[0].oldPath, '$.components.schemas.User.properties.first_name');
+        node_assert_1.default.strictEqual(miracles[0].newPath, '$.components.schemas.User.properties.firstName');
+        node_assert_1.default.ok(miracles[0].confidence >= 0.8);
+    });
+    (0, node_test_1.test)('creates TYPE_COERCION miracle for scalar type changes', () => {
+        const changes = [
+            {
+                type: 'model.property.type.changed',
+                severity: 'breaking',
+                path: '#/components/schemas/User/properties/age',
+                message: 'type changed',
+                from: 'string',
+                to: 'integer',
+            },
+        ];
+        const miracles = (0, buildMiraclesFromSemanticChanges_1.buildMiraclesFromSemanticChanges)(changes);
+        node_assert_1.default.strictEqual(miracles.length, 1);
+        node_assert_1.default.strictEqual(miracles[0].type, 'TYPE_COERCION');
+        node_assert_1.default.strictEqual(miracles[0].oldPath, '$.components.schemas.User.properties.age');
+    });
+    (0, node_test_1.test)('returns empty list when rename candidates do not match', () => {
+        const changes = [
+            {
+                type: 'model.property.removed',
+                severity: 'breaking',
+                path: '#/components/schemas/User/properties/id',
+                message: 'removed',
+                from: { type: 'string' },
+            },
+            {
+                type: 'model.property.added',
+                severity: 'non-breaking',
+                path: '#/components/schemas/Account/properties/accountId',
+                message: 'added',
+                to: { type: 'string' },
+            },
+        ];
+        const miracles = (0, buildMiraclesFromSemanticChanges_1.buildMiraclesFromSemanticChanges)(changes);
+        node_assert_1.default.deepStrictEqual(miracles, []);
+    });
+});

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

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

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

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

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

@@ -0,0 +1,159 @@
+"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 expandOpenApiRefsForSemanticDiff_1 = require("../expandOpenApiRefsForSemanticDiff");
+const sourceFile = '/tmp/openapi/api.yaml';
+function createResolver(entries) {
+    return {
+        exists: ref => Object.prototype.hasOwnProperty.call(entries, ref),
+        get: ref => entries[ref],
+    };
+}
+(0, node_test_1.describe)('@unit: expandOpenApiRefsForSemanticDiff', () => {
+    (0, node_test_1.test)('expands local refs without mutating the original document', () => {
+        const spec = {
+            openapi: '3.0.0',
+            info: { title: 'Test', version: '1.0.0' },
+            paths: {},
+            components: {
+                schemas: {
+                    User: {
+                        type: 'object',
+                        properties: {
+                            id: { $ref: '#/components/schemas/UserId' },
+                        },
+                    },
+                    UserId: { type: 'string', format: 'uuid' },
+                },
+            },
+        };
+        const expanded = (0, expandOpenApiRefsForSemanticDiff_1.expandOpenApiRefsForSemanticDiff)(spec, { sourceFile });
+        node_assert_1.default.deepStrictEqual(expanded.components.schemas.User.properties.id, { type: 'string', format: 'uuid' });
+        node_assert_1.default.deepStrictEqual(spec.components.schemas.User.properties.id, { $ref: '#/components/schemas/UserId' });
+    });
+    (0, node_test_1.test)('expands external file refs through the resolver', () => {
+        const spec = {
+            openapi: '3.0.0',
+            info: { title: 'Test', version: '1.0.0' },
+            paths: {},
+            components: {
+                schemas: {
+                    User: { $ref: './schemas/User.yaml' },
+                },
+            },
+        };
+        const resolver = createResolver({
+            '/tmp/openapi/schemas/User.yaml': {
+                type: 'object',
+                properties: {
+                    name: { type: 'string' },
+                },
+            },
+        });
+        const expanded = (0, expandOpenApiRefsForSemanticDiff_1.expandOpenApiRefsForSemanticDiff)(spec, { refs: resolver, sourceFile });
+        node_assert_1.default.deepStrictEqual(expanded.components.schemas.User, {
+            type: 'object',
+            properties: {
+                name: { type: 'string' },
+            },
+        });
+    });
+    (0, node_test_1.test)('expands external file fragment refs through the resolver', () => {
+        const spec = {
+            openapi: '3.0.0',
+            info: { title: 'Test', version: '1.0.0' },
+            paths: {},
+            components: {
+                schemas: {
+                    User: { $ref: './schemas/common.yaml#/components/schemas/User' },
+                },
+            },
+        };
+        const resolver = createResolver({
+            '/tmp/openapi/schemas/common.yaml#/components/schemas/User': {
+                type: 'object',
+                required: ['id'],
+                properties: {
+                    id: { type: 'string' },
+                },
+            },
+        });
+        const expanded = (0, expandOpenApiRefsForSemanticDiff_1.expandOpenApiRefsForSemanticDiff)(spec, { refs: resolver, sourceFile });
+        node_assert_1.default.deepStrictEqual(expanded.components.schemas.User, {
+            type: 'object',
+            required: ['id'],
+            properties: {
+                id: { type: 'string' },
+            },
+        });
+    });
+    (0, node_test_1.test)('expands path item refs', () => {
+        const spec = {
+            openapi: '3.0.0',
+            info: { title: 'Test', version: '1.0.0' },
+            paths: {
+                '/users': { $ref: '#/components/pathItems/Users' },
+            },
+            components: {
+                pathItems: {
+                    Users: {
+                        get: {
+                            operationId: 'listUsers',
+                            responses: {
+                                '200': { description: 'ok' },
+                            },
+                        },
+                    },
+                },
+            },
+        };
+        const expanded = (0, expandOpenApiRefsForSemanticDiff_1.expandOpenApiRefsForSemanticDiff)(spec, { sourceFile });
+        node_assert_1.default.deepStrictEqual(expanded.paths['/users'], {
+            get: {
+                operationId: 'listUsers',
+                responses: {
+                    '200': { description: 'ok' },
+                },
+            },
+        });
+    });
+    (0, node_test_1.test)('keeps unresolved refs stable', () => {
+        const spec = {
+            openapi: '3.0.0',
+            info: { title: 'Test', version: '1.0.0' },
+            paths: {},
+            components: {
+                schemas: {
+                    Missing: { $ref: './missing.yaml#/Missing' },
+                },
+            },
+        };
+        const expanded = (0, expandOpenApiRefsForSemanticDiff_1.expandOpenApiRefsForSemanticDiff)(spec, { sourceFile });
+        node_assert_1.default.deepStrictEqual(expanded.components.schemas.Missing, { $ref: './missing.yaml#/Missing' });
+    });
+    (0, node_test_1.test)('keeps circular refs stringify-safe', () => {
+        const spec = {
+            openapi: '3.0.0',
+            info: { title: 'Test', version: '1.0.0' },
+            paths: {},
+            components: {
+                schemas: {
+                    Node: {
+                        type: 'object',
+                        properties: {
+                            child: { $ref: '#/components/schemas/Node' },
+                        },
+                    },
+                },
+            },
+        };
+        const expanded = (0, expandOpenApiRefsForSemanticDiff_1.expandOpenApiRefsForSemanticDiff)(spec, { sourceFile });
+        const child = expanded.components.schemas.Node.properties.child;
+        node_assert_1.default.deepStrictEqual(child.properties.child, { $ref: '#/components/schemas/Node' });
+        node_assert_1.default.doesNotThrow(() => JSON.stringify(expanded));
+    });
+});