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

package/dist/common/VersionedSchema/Utils/__tests__/allUtils.test.js

@@ -0,0 +1,185 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable simple-import-sort/imports */
+const node_assert_1 = __importDefault(require("node:assert"));
+const node_test_1 = require("node:test");
+const zod_1 = require("zod");
+const Enums_1 = require("../../Enums");
+const buildVersionedSchema_1 = require("../buildVersionedSchema");
+const createDefaultFieldsMigration_1 = require("../createDefaultFieldsMigration");
+const createFieldTransformationMigration_1 = require("../createFieldTransformationMigration");
+const createTrivialMigration_1 = require("../createTrivialMigration");
+const determineBestMatchingSchemaVersion_1 = require("../determineBestMatchingSchemaVersion");
+const generateKeyMappingForInvalidKeys_1 = require("../generateKeyMappingForInvalidKeys");
+const getCurrentErrorMessage_1 = require("../getCurrentErrorMessage");
+const getKeyByMapValue_1 = require("../getKeyByMapValue");
+const getLatestVersionFromMigrationPlans_1 = require("../getLatestVersionFromMigrationPlans");
+const getUniqueKeysFromSchemas_1 = require("../getUniqueKeysFromSchemas");
+const getUniqueObjectKeys_1 = require("../getUniqueObjectKeys");
+const replaceInvalidKeysWithMappedNames_1 = require("../replaceInvalidKeysWithMappedNames");
+const validateAndSuggestKeyCorrections_1 = require("../validateAndSuggestKeyCorrections");
+(0, node_test_1.describe)('@unit: buildVersionedSchema', () => {
+    (0, node_test_1.test)('builds schema metadata without refine', () => {
+        const base = zod_1.z.object({ input: zod_1.z.string() });
+        const result = (0, buildVersionedSchema_1.buildVersionedSchema)({
+            base,
+            version: 'v1',
+            type: Enums_1.EVersionedSchemaType.OPTIONS,
+        });
+        node_assert_1.default.strictEqual(result.baseSchema, base);
+        node_assert_1.default.strictEqual(result.version, 'v1');
+        node_assert_1.default.strictEqual(result.type, Enums_1.EVersionedSchemaType.OPTIONS);
+        node_assert_1.default.deepStrictEqual(result.schema.parse({ input: 'ok' }), { input: 'ok' });
+    });
+    (0, node_test_1.test)('applies refine when provided', () => {
+        const base = zod_1.z.object({ input: zod_1.z.string(), output: zod_1.z.string() });
+        const schema = (0, buildVersionedSchema_1.buildVersionedSchema)({
+            base,
+            version: 'v2',
+            type: Enums_1.EVersionedSchemaType.OPTIONS,
+            refine: (data, ctx) => {
+                if (data.input === data.output) {
+                    ctx.addIssue({
+                        code: 'custom',
+                        message: 'input and output must be different',
+                        path: ['output'],
+                    });
+                }
+            },
+        }).schema;
+        const result = schema.safeParse({ input: 'same', output: 'same' });
+        node_assert_1.default.strictEqual(result.success, false);
+    });
+});
+(0, node_test_1.describe)('@unit: migration plan helpers', () => {
+    (0, node_test_1.test)('createDefaultFieldsMigration merges default values', () => {
+        const plan = (0, createDefaultFieldsMigration_1.createDefaultFieldsMigration)('v1', 'v2', { enabled: true });
+        node_assert_1.default.strictEqual(plan.fromVersion, 'v1');
+        node_assert_1.default.strictEqual(plan.toVersion, 'v2');
+        node_assert_1.default.deepStrictEqual(plan.migrate({ name: 'demo' }), { name: 'demo', enabled: true });
+        node_assert_1.default.match(plan.description ?? '', /enabled/);
+    });
+    (0, node_test_1.test)('createFieldTransformationMigration keeps custom migrate and custom description', () => {
+        const plan = (0, createFieldTransformationMigration_1.createFieldTransformationMigration)('v1', 'v2', ({ oldField, ...rest }) => ({ ...rest, newField: oldField }), 'rename oldField');
+        node_assert_1.default.strictEqual(plan.fromVersion, 'v1');
+        node_assert_1.default.strictEqual(plan.toVersion, 'v2');
+        node_assert_1.default.strictEqual(plan.description, 'rename oldField');
+        node_assert_1.default.deepStrictEqual(plan.migrate({ oldField: 'x', other: 1 }), { other: 1, newField: 'x' });
+    });
+    (0, node_test_1.test)('createTrivialMigration copies object as-is', () => {
+        const plan = (0, createTrivialMigration_1.createTrivialMigration)('v3', 'v4');
+        const source = { a: 1 };
+        const migrated = plan.migrate(source);
+        node_assert_1.default.deepStrictEqual(migrated, source);
+        node_assert_1.default.notStrictEqual(migrated, source);
+        node_assert_1.default.match(plan.description ?? '', /Trivial migration/);
+    });
+});
+(0, node_test_1.describe)('@unit: determineBestMatchingSchemaVersion', () => {
+    const mk = (schema, version) => ({
+        schema,
+        baseSchema: zod_1.z.object({}),
+        version,
+        type: Enums_1.EVersionedSchemaType.OPTIONS,
+    });
+    (0, node_test_1.test)('throws on empty schema list', () => {
+        node_assert_1.default.throws(() => (0, determineBestMatchingSchemaVersion_1.determineBestMatchingSchemaVersion)({}, []), /cannot be empty/i);
+    });
+    (0, node_test_1.test)('returns latest from multiple valid matches', () => {
+        const versionedSchemas = [
+            mk(zod_1.z.object({ a: zod_1.z.string() }), 'v1'),
+            mk(zod_1.z.object({ a: zod_1.z.string(), b: zod_1.z.string().optional() }), 'v2'),
+        ];
+        const result = (0, determineBestMatchingSchemaVersion_1.determineBestMatchingSchemaVersion)({ a: 'ok' }, versionedSchemas);
+        node_assert_1.default.deepStrictEqual(result, {
+            lastVersionIndex: 1,
+            latestVersion: 'v2',
+            firstVersion: 'v1',
+        });
+    });
+    (0, node_test_1.test)('falls back to the best key/error balance when no full match', () => {
+        const versionedSchemas = [
+            mk(zod_1.z.object({ a: zod_1.z.string() }), 'v1'),
+            mk(zod_1.z.object({ b: zod_1.z.string() }), 'v2'),
+        ];
+        const result = (0, determineBestMatchingSchemaVersion_1.determineBestMatchingSchemaVersion)({ a: 1 }, versionedSchemas);
+        node_assert_1.default.deepStrictEqual(result, {
+            lastVersionIndex: 0,
+            latestVersion: 'v1',
+            firstVersion: 'v1',
+        });
+    });
+});
+(0, node_test_1.describe)('@unit: key mapping and validation helpers', () => {
+    (0, node_test_1.test)('generateKeyMappingForInvalidKeys maps close invalid keys', () => {
+        const mapping = (0, generateKeyMappingForInvalidKeys_1.generateKeyMappingForInvalidKeys)(['nmae', 'title', 'unknown'], new Set(['name', 'title']));
+        node_assert_1.default.deepStrictEqual(Array.from(mapping.entries()), [['nmae', 'name']]);
+    });
+    (0, node_test_1.test)('validateAndSuggestKeyCorrections throws with suggestion', () => {
+        node_assert_1.default.throws(() => (0, validateAndSuggestKeyCorrections_1.validateAndSuggestKeyCorrections)(['nmae'], new Set(['name'])), /Perhaps you meant "name"/);
+    });
+    (0, node_test_1.test)('validateAndSuggestKeyCorrections does not throw for valid keys', () => {
+        node_assert_1.default.doesNotThrow(() => (0, validateAndSuggestKeyCorrections_1.validateAndSuggestKeyCorrections)(['name'], new Set(['name'])));
+    });
+});
+(0, node_test_1.describe)('@unit: getCurrentErrorMessage and getKeyByMapValue', () => {
+    (0, node_test_1.test)('getKeyByMapValue finds key by value', () => {
+        const key = (0, getKeyByMapValue_1.getKeyByMapValue)(new Map([['nmae', '--name']]), '--name');
+        node_assert_1.default.strictEqual(key, 'nmae');
+    });
+    (0, node_test_1.test)('getCurrentErrorMessage does nothing when no issues', () => {
+        node_assert_1.default.doesNotThrow(() => {
+            (0, getCurrentErrorMessage_1.getCurrentErrorMessage)({ issues: [], message: '' }, new Map());
+        });
+    });
+    (0, node_test_1.test)('getCurrentErrorMessage throws deduplicated transformed message', () => {
+        const error = {
+            message: '--name is invalid',
+            issues: [
+                { path: ['name'], message: 'wrong value' },
+                { path: ['name'], message: 'wrong value' },
+            ],
+        };
+        node_assert_1.default.throws(() => (0, getCurrentErrorMessage_1.getCurrentErrorMessage)(error, new Map([['nmae', '--name']])), /nmae is invalid/);
+    });
+});
+(0, node_test_1.describe)('@unit: collection helpers', () => {
+    (0, node_test_1.test)('getLatestVersionFromMigrationPlans returns toVersion of last plan', () => {
+        const version = (0, getLatestVersionFromMigrationPlans_1.getLatestVersionFromMigrationPlans)([
+            (0, createTrivialMigration_1.createTrivialMigration)('v1', 'v2'),
+            (0, createTrivialMigration_1.createTrivialMigration)('v2', 'v3'),
+        ]);
+        node_assert_1.default.strictEqual(version, 'v3');
+    });
+    (0, node_test_1.test)('getLatestVersionFromMigrationPlans throws for empty list', () => {
+        node_assert_1.default.throws(() => (0, getLatestVersionFromMigrationPlans_1.getLatestVersionFromMigrationPlans)([]), /empty/i);
+    });
+    (0, node_test_1.test)('getUniqueKeysFromSchemas returns keys from root and nested objects', () => {
+        const keys = (0, getUniqueKeysFromSchemas_1.getUniqueKeysFromSchemas)([
+            zod_1.z.object({
+                a: zod_1.z.string(),
+                nested: zod_1.z.object({ inner: zod_1.z.number() }),
+            }),
+            zod_1.z.object({ b: zod_1.z.boolean() }),
+        ]);
+        node_assert_1.default.deepStrictEqual(Array.from(keys).sort(), ['a', 'b', 'inner', 'nested']);
+    });
+    (0, node_test_1.test)('getUniqueObjectKeys returns unique keys for nested object and arrays', () => {
+        const keys = (0, getUniqueObjectKeys_1.getUniqueObjectKeys)({
+            a: 1,
+            nested: { b: 2 },
+            items: [{ c: 3 }, { a: 4 }],
+        });
+        node_assert_1.default.deepStrictEqual(keys, ['a', 'nested', 'b', 'items', 'c']);
+    });
+    (0, node_test_1.test)('replaceInvalidKeysWithMappedNames replaces keys recursively for arrays', () => {
+        const replaced = (0, replaceInvalidKeysWithMappedNames_1.replaceInvalidKeysWithMappedNames)([{ nmae: 'a' }, { nmae: 'b', extra: [{ nmae: 'c' }] }], new Map([['nmae', 'name']]));
+        node_assert_1.default.deepStrictEqual(replaced, [
+            { name: 'a' },
+            { name: 'b', extra: [{ name: 'c' }] },
+        ]);
+    });
+});

package/dist/common/VersionedSchema/Utils/__tests__/compareShapes.test.js

@@ -9,14 +9,31 @@ const node_assert_1 = __importDefault(require("node:assert"));
 const compareShapes_1 = require("../compareShapes");
 const AllVersionedSchemas_1 = require("../../../VersionedSchema/AllVersionedSchemas/AllVersionedSchemas");
 const compatibilityCases_1 = require("../__mocks__/compatibilityCases");
+(0, node_test_1.default)('@unit: schema versions compatibility cases must cover all adjacent transitions', () => {
+    const cases = new Set(compatibilityCases_1.compatibilityCases.map(testCase => `${testCase.type}:${testCase.from}->${testCase.to}`));
+    const transitions = new Set();
+    for (let idx = 0; idx < AllVersionedSchemas_1.allVersionedSchemas.length - 1; idx++) {
+        const current = AllVersionedSchemas_1.allVersionedSchemas[idx];
+        const next = AllVersionedSchemas_1.allVersionedSchemas[idx + 1];
+        if (current.type !== next.type) {
+            continue;
+        }
+        const from = current.version.split('_').at(-1);
+        const to = next.version.split('_').at(-1);
+        if (!from || !to) {
+            continue;
+        }
+        transitions.add(`${current.type}:${from}->${to}`);
+    }
+    node_assert_1.default.deepStrictEqual([...cases].sort(), [...transitions].sort(), 'compatibilityCases must include all adjacent schema transitions');
+});
 (0, node_test_1.default)('@unit: schema versions compatibility', () => {
     for (const testCase of compatibilityCases_1.compatibilityCases) {
         const { type, from, to, expect } = testCase;
         const prev = AllVersionedSchemas_1.allVersionedSchemas.find(vs => vs.type === type && vs.version === `${type}_${from}`)?.baseSchema;
         const next = AllVersionedSchemas_1.allVersionedSchemas.find(vs => vs.type === type && vs.version === `${type}_${to}`)?.baseSchema;
-        if (!prev || !next) {
-            return;
-        }
+        node_assert_1.default.ok(prev, `Previous schema was not found for ${type} ${from}`);
+        node_assert_1.default.ok(next, `Next schema was not found for ${type} ${to}`);
         const issues = (0, compareShapes_1.compareShapes)(prev, next);
         node_assert_1.default.deepStrictEqual(issues, expect, `${type} ${from} → ${to} mismatch`);
     }

package/dist/common/VersionedSchema/Utils/__tests__/migrateDataToLatestSchemaVersion.test.js

@@ -69,7 +69,25 @@ const migrateDataToLatestSchemaVersion_1 = require("../migrateDataToLatestSchema
     });
     node_assert_1.default.ok(result);
     node_assert_1.default.strictEqual(result?.schemaType, Enums_2.EVersionedSchemaType.UNIFIED_OPTIONS);
-    node_assert_1.default.strictEqual(result?.schemaVersion, 'UNIFIED_OPTIONS_v3');
+    node_assert_1.default.strictEqual(result?.schemaVersion, 'UNIFIED_OPTIONS_v4');
     node_assert_1.default.strictEqual(result?.value.httpClient, 'fetch');
     node_assert_1.default.strictEqual(result?.value.validationLibrary, ValidationLibrary_enum_1.ValidationLibrary.NONE);
 });
+(0, node_test_1.default)('@unit: migrateDataToLatestSchemaVersion (all schemas: chooses old options branch before unified)', () => {
+    const rawInput = {
+        input: './spec.json',
+        output: './dist',
+        httpClient: 'fetch',
+        exportCore: true,
+    };
+    const result = (0, migrateDataToLatestSchemaVersion_1.migrateDataToLatestSchemaVersion)({
+        rawInput,
+        migrationPlans: AllMigrationPlans_1.allMigrationPlans,
+        versionedSchemas: AllVersionedSchemas_1.allVersionedSchemas,
+        migrationMode: Enums_1.EMigrationMode.VALIDATE_CONFIG,
+    });
+    node_assert_1.default.ok(result);
+    node_assert_1.default.strictEqual(result?.schemaType, Enums_2.EVersionedSchemaType.UNIFIED_OPTIONS);
+    node_assert_1.default.strictEqual(result?.schemaVersion, 'UNIFIED_OPTIONS_v4');
+    node_assert_1.default.ok(result?.guessedVersion.latestVersion.startsWith('OPTIONS_'));
+});

package/dist/common/VersionedSchema/Utils/determineBestMatchingSchemaVersion.d.ts

@@ -1,4 +1,8 @@
 import { z } from 'zod';
 import { VersionedSchema, VersionMatchResult } from '../Types';
+/**
+ * Determines the best matching schema version for input data.
+ * `invalid_value` issues are intentionally ignored to allow migration from older enum/value variants.
+ */
 export declare function determineBestMatchingSchemaVersion(inputData: Record<string, any>, versionedSchemas: VersionedSchema<z.ZodTypeAny>[]): VersionMatchResult;
 //# sourceMappingURL=determineBestMatchingSchemaVersion.d.ts.map

package/dist/common/VersionedSchema/Utils/determineBestMatchingSchemaVersion.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"determineBestMatchingSchemaVersion.d.ts","sourceRoot":"","sources":["../../../../src/common/VersionedSchema/Utils/determineBestMatchingSchemaVersion.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,OAAO,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAK/D,wBAAgB,kCAAkC,CAAC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,gBAAgB,EAAE,eAAe,CAAC,CAAC,CAAC,UAAU,CAAC,EAAE,GAAG,kBAAkB,CA4CxJ"}
+{"version":3,"file":"determineBestMatchingSchemaVersion.d.ts","sourceRoot":"","sources":["../../../../src/common/VersionedSchema/Utils/determineBestMatchingSchemaVersion.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,OAAO,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAiE/D;;;GAGG;AACH,wBAAgB,kCAAkC,CAAC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,gBAAgB,EAAE,eAAe,CAAC,CAAC,CAAC,UAAU,CAAC,EAAE,GAAG,kBAAkB,CAgDxJ"}

package/dist/common/VersionedSchema/Utils/determineBestMatchingSchemaVersion.js

@@ -4,38 +4,83 @@ exports.determineBestMatchingSchemaVersion = determineBestMatchingSchemaVersion;
 const validateZodOptions_1 = require("../../Validation/validateZodOptions");
 const getUniqueKeysFromSchemas_1 = require("./getUniqueKeysFromSchemas");
 const getUniqueObjectKeys_1 = require("./getUniqueObjectKeys");
-// Determining the most appropriate schema version
+/**
+ * Counts unknown keys using a strict schema variant.
+ * The strict check is used only for ranking candidates, not for final validation.
+ */
+function getStrictUnrecognizedKeyCount(schema, inputData) {
+    const strictResult = (0, validateZodOptions_1.validateZodOptionsRaw)(schema.strict(), inputData);
+    if (strictResult.success) {
+        return 0;
+    }
+    return strictResult.error.issues.reduce((count, issue) => {
+        if (issue.code !== 'unrecognized_keys' || !('keys' in issue)) {
+            return count;
+        }
+        return count + issue.keys.length;
+    }, 0);
+}
+/**
+ * Compares two schema candidates and returns the better one.
+ * Priority:
+ * 1) fewer structural errors;
+ * 2) fewer strict-mode unknown keys;
+ * 3) more matching keys;
+ * 4) newer version inside the same schema family;
+ * 5) lower index when schema families differ.
+ */
+function compareCandidates(best, current) {
+    if (current.structuralErrorCount !== best.structuralErrorCount) {
+        return current.structuralErrorCount < best.structuralErrorCount ? current : best;
+    }
+    if (current.strictUnrecognizedKeyCount !== best.strictUnrecognizedKeyCount) {
+        return current.strictUnrecognizedKeyCount < best.strictUnrecognizedKeyCount ? current : best;
+    }
+    if (current.matchingKeysCount !== best.matchingKeysCount) {
+        return current.matchingKeysCount > best.matchingKeysCount ? current : best;
+    }
+    if (current.type === best.type) {
+        return current.index > best.index ? current : best;
+    }
+    return current.index < best.index ? current : best;
+}
+/**
+ * Determines the best matching schema version for input data.
+ * `invalid_value` issues are intentionally ignored to allow migration from older enum/value variants.
+ */
 function determineBestMatchingSchemaVersion(inputData, versionedSchemas) {
     if (!versionedSchemas.length) {
         throw new Error('The list of schemes cannot be empty');
     }
     const inputKeys = (0, getUniqueObjectKeys_1.getUniqueObjectKeys)(inputData);
-    const matchingSchemas = versionedSchemas
-        .map(({ schema, version }, idx) => {
+    const schemaMatches = versionedSchemas.map(({ schema, baseSchema, version, type }, idx) => {
+        const schemaKeys = (0, getUniqueKeysFromSchemas_1.getUniqueKeysFromSchemas)([schema]);
+        const matchingKeysCount = inputKeys.filter(key => schemaKeys.has(key)).length;
+        const strictUnrecognizedKeyCount = getStrictUnrecognizedKeyCount(baseSchema, inputData);
         const validationResult = (0, validateZodOptions_1.validateZodOptionsRaw)(schema, inputData);
-        const errorFields = !validationResult.success ? validationResult.error.issues.filter(err => err.code !== 'invalid_value') : [];
-        return errorFields.length === 0 ? { version, index: idx } : null;
-    })
-        .filter((match) => match !== null);
-    if (matchingSchemas.length > 0) {
-        const latestMatch = matchingSchemas.reduce((prev, curr) => (curr.index > prev.index ? curr : prev));
+        const structuralErrorCount = !validationResult.success
+            ? validationResult.error.issues.filter(issue => issue.code !== 'invalid_value').length
+            : 0;
         return {
-            lastVersionIndex: latestMatch.index,
-            latestVersion: latestMatch.version,
-            firstVersion: matchingSchemas[0].version,
+            index: idx,
+            version,
+            type,
+            structuralErrorCount,
+            strictUnrecognizedKeyCount,
+            matchingKeysCount,
         };
-    }
-    const schemaMatches = versionedSchemas.map(({ schema, version }, idx) => {
-        const schemaKeys = (0, getUniqueKeysFromSchemas_1.getUniqueKeysFromSchemas)([schema]);
-        const validationResult = (0, validateZodOptions_1.validateZodOptionsRaw)(schema, inputData);
-        const errorFields = !validationResult.success ? validationResult.error.issues.filter(err => err.code !== 'invalid_value') : [];
-        const matchingKeys = inputKeys.filter(key => schemaKeys.has(key));
-        return { index: idx, version, errorFields, matchingKeys };
     });
-    const bestMatch = schemaMatches.reduce((best, current) => {
-        const isBetterMatch = current.matchingKeys.length >= best.matchingKeys.length && current.errorFields.length <= best.errorFields.length;
-        return isBetterMatch ? current : best;
-    }, schemaMatches[0]);
+    const structurallyValidMatches = schemaMatches.filter(match => match.structuralErrorCount === 0);
+    if (structurallyValidMatches.length > 0) {
+        const bestStructurallyValidMatch = structurallyValidMatches.reduce(compareCandidates);
+        const firstVersion = structurallyValidMatches.reduce((earliest, current) => (current.index < earliest.index ? current : earliest)).version;
+        return {
+            lastVersionIndex: bestStructurallyValidMatch.index,
+            latestVersion: bestStructurallyValidMatch.version,
+            firstVersion,
+        };
+    }
+    const bestMatch = schemaMatches.reduce(compareCandidates);
     return {
         lastVersionIndex: bestMatch.index,
         latestVersion: bestMatch.version,

package/dist/common/VersionedSchema/Utils/getUniqueKeysFromSchemas.d.ts

@@ -1,7 +1,7 @@
 import { z } from 'zod';
 /**
  * Get all the unique parameter keys of all Joi schemes in the array
- * @param schemas array of joi schemes
+ * @param schemas array of zod schemes
  * @returns All the unique parameter keys of all Joi schemes in the array
  */
 export declare function getUniqueKeysFromSchemas(schemas: z.ZodTypeAny[]): Set<string>;

package/dist/common/VersionedSchema/Utils/getUniqueKeysFromSchemas.js

@@ -18,7 +18,7 @@ function collectKeys(schema, result) {
 }
 /**
  * Get all the unique parameter keys of all Joi schemes in the array
- * @param schemas array of joi schemes
+ * @param schemas array of zod schemes
  * @returns All the unique parameter keys of all Joi schemes in the array
  */
 function getUniqueKeysFromSchemas(schemas) {

package/dist/common/VersionedSchema/Utils/migrateDataToLatestSchemaVersion.d.ts

@@ -2,18 +2,28 @@ import { z } from 'zod';
 import { EMigrationMode } from '../../Enums';
 import { EVersionedSchemaType } from '../Enums';
 import { SchemaMigrationPlan, VersionedSchema, VersionMatchResult } from '../Types';
+/**
+ * Input arguments for migrating arbitrary config data to the latest schema version.
+ */
 type MigrateToLatestProps = {
     rawInput: Record<string, any>;
     migrationPlans: SchemaMigrationPlan<Record<string, any>, Record<string, any>>[];
     versionedSchemas: VersionedSchema<z.ZodTypeAny>[];
     migrationMode: EMigrationMode;
 };
+/**
+ * Result of successful migration to the latest schema.
+ */
 type MigrateToLatestResult = {
     value: Record<string, any>;
     guessedVersion: VersionMatchResult;
     schemaVersion: string;
     schemaType: EVersionedSchemaType;
 };
+/**
+ * Migrates raw input through the migration graph to the latest schema version.
+ * Migration path is resolved by `fromVersion -> toVersion` links from `migrationPlans`.
+ */
 export declare function migrateDataToLatestSchemaVersion({ rawInput, migrationPlans, versionedSchemas, migrationMode }: MigrateToLatestProps): MigrateToLatestResult | null;
 export {};
 //# sourceMappingURL=migrateDataToLatestSchemaVersion.d.ts.map

package/dist/common/VersionedSchema/Utils/migrateDataToLatestSchemaVersion.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"migrateDataToLatestSchemaVersion.d.ts","sourceRoot":"","sources":["../../../../src/common/VersionedSchema/Utils/migrateDataToLatestSchemaVersion.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE7C,OAAO,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAChD,OAAO,EAAE,mBAAmB,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AASpF,KAAK,oBAAoB,GAAG;IACxB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC9B,cAAc,EAAE,mBAAmB,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC;IAChF,gBAAgB,EAAE,eAAe,CAAC,CAAC,CAAC,UAAU,CAAC,EAAE,CAAC;IAClD,aAAa,EAAE,cAAc,CAAC;CACjC,CAAC;AAEF,KAAK,qBAAqB,GAAG;IACzB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC3B,cAAc,EAAE,kBAAkB,CAAC;IACnC,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,oBAAoB,CAAC;CACpC,CAAC;AAEF,wBAAgB,gCAAgC,CAAC,EAAE,QAAQ,EAAE,cAAc,EAAE,gBAAgB,EAAE,aAAa,EAAE,EAAE,oBAAoB,GAAG,qBAAqB,GAAG,IAAI,CAiElK"}
+{"version":3,"file":"migrateDataToLatestSchemaVersion.d.ts","sourceRoot":"","sources":["../../../../src/common/VersionedSchema/Utils/migrateDataToLatestSchemaVersion.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE7C,OAAO,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAChD,OAAO,EAAE,mBAAmB,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AASpF;;GAEG;AACH,KAAK,oBAAoB,GAAG;IACxB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC9B,cAAc,EAAE,mBAAmB,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC;IAChF,gBAAgB,EAAE,eAAe,CAAC,CAAC,CAAC,UAAU,CAAC,EAAE,CAAC;IAClD,aAAa,EAAE,cAAc,CAAC;CACjC,CAAC;AAEF;;GAEG;AACH,KAAK,qBAAqB,GAAG;IACzB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC3B,cAAc,EAAE,kBAAkB,CAAC;IACnC,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,oBAAoB,CAAC;CACpC,CAAC;AAEF;;;GAGG;AACH,wBAAgB,gCAAgC,CAAC,EAAE,QAAQ,EAAE,cAAc,EAAE,gBAAgB,EAAE,aAAa,EAAE,EAAE,oBAAoB,GAAG,qBAAqB,GAAG,IAAI,CAoFlK"}

package/dist/common/VersionedSchema/Utils/migrateDataToLatestSchemaVersion.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.migrateDataToLatestSchemaVersion = migrateDataToLatestSchemaVersion;
+const Consts_1 = require("../../Consts");
 const Enums_1 = require("../../Enums");
 const validateZodOptions_1 = require("../../Validation/validateZodOptions");
 const determineBestMatchingSchemaVersion_1 = require("./determineBestMatchingSchemaVersion");
@@ -10,6 +11,10 @@ const getUniqueKeysFromSchemas_1 = require("./getUniqueKeysFromSchemas");
 const getUniqueObjectKeys_1 = require("./getUniqueObjectKeys");
 const replaceInvalidKeysWithMappedNames_1 = require("./replaceInvalidKeysWithMappedNames");
 const validateAndSuggestKeyCorrections_1 = require("./validateAndSuggestKeyCorrections");
+/**
+ * Migrates raw input through the migration graph to the latest schema version.
+ * Migration path is resolved by `fromVersion -> toVersion` links from `migrationPlans`.
+ */
 function migrateDataToLatestSchemaVersion({ rawInput, migrationPlans, versionedSchemas, migrationMode }) {
     const schemas = versionedSchemas.map(el => el.schema);
     const allUniqueKeysFromSchemas = (0, getUniqueKeysFromSchemas_1.getUniqueKeysFromSchemas)(schemas);
@@ -20,34 +25,47 @@ function migrateDataToLatestSchemaVersion({ rawInput, migrationPlans, versionedS
     const schemaPossibleKeys = (0, getUniqueKeysFromSchemas_1.getUniqueKeysFromSchemas)([guessedValidationSchema]);
     const replacingKeysMap = (0, generateKeyMappingForInvalidKeys_1.generateKeyMappingForInvalidKeys)(allUniqueKeysFromRawInput, schemaPossibleKeys);
     let currentData = replacingKeysMap.size ? (0, replaceInvalidKeysWithMappedNames_1.replaceInvalidKeysWithMappedNames)(rawInput, replacingKeysMap) : rawInput;
-    const actualVersionIndex = versionedSchemas.length - 1;
-    const actualSchema = versionedSchemas[actualVersionIndex];
-    for (let idx = guessedVersion.lastVersionIndex; idx < versionedSchemas.length - 1; idx++) {
-        const currentVersionSchema = versionedSchemas[idx];
-        const firstValidationResult = (0, validateZodOptions_1.validateZodOptionsRaw)(currentVersionSchema.schema, currentData);
+    const actualSchema = versionedSchemas[versionedSchemas.length - 1];
+    const schemasByVersion = new Map(versionedSchemas.map(schemaInfo => [schemaInfo.version, schemaInfo.schema]));
+    const migrationPlanByFromVersion = new Map(migrationPlans.map(plan => [plan.fromVersion, plan]));
+    let currentVersion = guessedVersion.latestVersion;
+    const visitedVersions = new Set([currentVersion]);
+    while (currentVersion !== actualSchema.version) {
+        const currentVersionSchema = schemasByVersion.get(currentVersion);
+        if (!currentVersionSchema) {
+            throw new Error(`No schema found for version ${currentVersion}.`);
+        }
+        const firstValidationResult = (0, validateZodOptions_1.validateZodOptionsRaw)(currentVersionSchema, currentData);
         if (!firstValidationResult.success) {
             (0, getCurrentErrorMessage_1.getCurrentErrorMessage)(firstValidationResult.error, replacingKeysMap);
         }
-        const fromVersion = currentVersionSchema.version;
-        const migrationPlan = migrationPlans.find(p => p.fromVersion === fromVersion);
+        const migrationPlan = migrationPlanByFromVersion.get(currentVersion);
         if (!migrationPlan) {
-            const availableVersions = migrationPlans.map(p => p.fromVersion).join(', ');
-            throw new Error(`No migration plan from ${fromVersion}. ` +
+            const availableVersions = Array.from(migrationPlanByFromVersion.keys()).join(', ');
+            throw new Error(`No migration plan from ${currentVersion}. ` +
                 `Available migration plans: ${availableVersions}. ` +
                 `This usually means the migration chain is incomplete.`);
         }
-        const toVersion = versionedSchemas[idx + 1].version;
+        const nextVersion = migrationPlan.toVersion;
+        const nextSchema = schemasByVersion.get(nextVersion);
+        if (!nextSchema) {
+            throw new Error(`Migration plan from ${migrationPlan.fromVersion} points to unknown schema version ${nextVersion}.`);
+        }
         const migratedRaw = migrationPlan.migrate(currentData);
-        const validationResult = (0, validateZodOptions_1.validateZodOptions)(versionedSchemas[idx + 1].schema, migratedRaw);
+        const validationResult = (0, validateZodOptions_1.validateZodOptions)(nextSchema, migratedRaw);
         if (!validationResult.success) {
-            throw new Error(`Migration from ${fromVersion} to ${toVersion} failed validation. ` +
+            throw new Error(`Migration from ${currentVersion} to ${nextVersion} failed validation. ` +
                 `Error: ${validationResult.errors.join('\n')}. ` +
                 `Migration description: ${migrationPlan.description || 'No description provided'}.`);
         }
         currentData = { ...migratedRaw };
-        const isLastIteration = idx + 1 === actualVersionIndex;
-        if (isLastIteration && migrationMode === Enums_1.EMigrationMode.GENERATE_OPENAPI) {
-            console.warn('Для выполнения генерации OpenApi потребовалось мигрировать схему Ваших данных на актуальную. Для обновленмя конфигурации в файле используйте команду `npm name_cli_tool update-config`');
+        currentVersion = nextVersion;
+        if (visitedVersions.has(currentVersion)) {
+            throw new Error(`Migration loop detected at version ${currentVersion}.`);
+        }
+        visitedVersions.add(currentVersion);
+        if (currentVersion === actualSchema.version && migrationMode === Enums_1.EMigrationMode.GENERATE_OPENAPI) {
+            Consts_1.APP_LOGGER.warn('To perform OpenAPI generation, it was necessary to migrate the schema of your data to the current one. To update the configuration in the file, use the command `npm openapi-codegen-cli update-config`');
         }
     }
     const validationResult = (0, validateZodOptions_1.validateZodOptionsRaw)(actualSchema.schema, currentData);