ts-openapi-codegen 1.0.0-beta.3 → 1.0.0-beta.5

package/dist/common/__tests__/__mock__/mockJoiSchema.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mockJoiSchema = void 0;
+const mockJoiSchema = (keys, isValid, errors = [], isArray = false) => ({
+    validate: (input, options) => ({
+        error: isValid ? null : { details: errors },
+        value: input,
+    }),
+    describe: () => ({
+        keys: isArray ? undefined : keys.reduce((acc, key) => ({ ...acc, [key]: {} }), {}),
+        items: isArray ? [{}] : undefined,
+    }),
+});
+exports.mockJoiSchema = mockJoiSchema;

package/dist/common/__tests__/determineBestMatchingSchemaVersion.test.d.ts

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

package/dist/common/__tests__/determineBestMatchingSchemaVersion.test.d.ts.map

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

package/dist/common/__tests__/determineBestMatchingSchemaVersion.test.js

@@ -0,0 +1,38 @@
+"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 Enums_1 = require("../../common/VersionedSchema/Enums");
+const determineBestMatchingSchemaVersion_1 = require("../VersionedSchema/Utils/determineBestMatchingSchemaVersion");
+const mockJoiSchema_1 = require("./__mock__/mockJoiSchema");
+(0, node_test_1.describe)('determineBestMatchingSchemaVersion', () => {
+    (0, node_test_1.test)('@unit: it should return the latest version if there is an exact match.', async () => {
+        const schemas = [
+            { schema: (0, mockJoiSchema_1.mockJoiSchema)(['name'], true), version: '1.0', type: Enums_1.EVersionedSchemaType.OPTIONS },
+            { schema: (0, mockJoiSchema_1.mockJoiSchema)(['name', 'age'], true), version: '2.0', type: Enums_1.EVersionedSchemaType.OPTIONS },
+        ];
+        const input = { name: 'John', age: 30 };
+        const result = (0, determineBestMatchingSchemaVersion_1.determineBestMatchingSchemaVersion)(input, schemas);
+        node_assert_1.default.deepEqual(result, {
+            lastVersionIndex: 1,
+            latestVersion: '2.0',
+            firstVersion: '1.0',
+        });
+    });
+    (0, node_test_1.test)('@unit: should return the best scheme in the absence of exact matches.', async () => {
+        const schemas = [
+            { schema: (0, mockJoiSchema_1.mockJoiSchema)(['name'], false, [{ path: 'age', type: 'string' }]), version: '1.0', type: Enums_1.EVersionedSchemaType.OPTIONS },
+            { schema: (0, mockJoiSchema_1.mockJoiSchema)(['name', 'age'], true), version: '2.0', type: Enums_1.EVersionedSchemaType.OPTIONS },
+        ];
+        const input = { name: 'John', age: 30 };
+        const result = (0, determineBestMatchingSchemaVersion_1.determineBestMatchingSchemaVersion)(input, schemas);
+        node_assert_1.default.deepEqual(result, {
+            lastVersionIndex: 1,
+            latestVersion: '2.0',
+            firstVersion: '2.0',
+        });
+    });
+});

package/dist/common/__tests__/generateKeyMappingForInvalidKeys.test.d.ts

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

package/dist/common/__tests__/generateKeyMappingForInvalidKeys.test.d.ts.map

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

package/dist/common/__tests__/generateKeyMappingForInvalidKeys.test.js

@@ -0,0 +1,22 @@
+"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 generateKeyMappingForInvalidKeys_1 = require("../VersionedSchema/Utils/generateKeyMappingForInvalidKeys");
+(0, node_test_1.describe)('generateKeyMappingForInvalidKeys', () => {
+    (0, node_test_1.test)('@unit: must create a replacement card for invalid keys', async () => {
+        const inputKeys = ['nmae', 'title'];
+        const allowedKeys = new Set(['name', 'title']);
+        const result = (0, generateKeyMappingForInvalidKeys_1.generateKeyMappingForInvalidKeys)(inputKeys, allowedKeys);
+        node_assert_1.default.deepEqual(result, new Map([['nmae', 'name']]));
+    });
+    (0, node_test_1.test)('@unit: must return an empty card if all keys are valid.', async () => {
+        const inputKeys = ['name', 'title'];
+        const allowedKeys = new Set(['name', 'title']);
+        const result = (0, generateKeyMappingForInvalidKeys_1.generateKeyMappingForInvalidKeys)(inputKeys, allowedKeys);
+        node_assert_1.default.deepEqual(result, new Map());
+    });
+});

package/dist/common/__tests__/getUniqueKeysFromSchemas.test.d.ts

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

package/dist/common/__tests__/getUniqueKeysFromSchemas.test.d.ts.map

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

package/dist/common/__tests__/getUniqueKeysFromSchemas.test.js

@@ -0,0 +1,20 @@
+"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 getUniqueKeysFromSchemas_1 = require("../VersionedSchema/Utils/getUniqueKeysFromSchemas");
+const mockJoiSchema_1 = require("./__mock__/mockJoiSchema");
+(0, node_test_1.describe)('getUniqueKeysFromSchemas', () => {
+    (0, node_test_1.test)('@unit: must return unique keys from the schema', async () => {
+        const schema = (0, mockJoiSchema_1.mockJoiSchema)(['name', 'age'], true);
+        const result = (0, getUniqueKeysFromSchemas_1.getUniqueKeysFromSchemas)([schema]);
+        node_assert_1.default.deepEqual(result, new Set(['name', 'age']));
+    });
+    (0, node_test_1.test)('@unit: should return an empty set for an empty list of schemas', async () => {
+        const result = (0, getUniqueKeysFromSchemas_1.getUniqueKeysFromSchemas)([]);
+        node_assert_1.default.deepEqual(result, new Set());
+    });
+});

package/dist/common/__tests__/getUniqueObjectKeys.test.d.ts

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

package/dist/common/__tests__/getUniqueObjectKeys.test.d.ts.map

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

package/dist/common/__tests__/getUniqueObjectKeys.test.js

@@ -0,0 +1,24 @@
+"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 getUniqueObjectKeys_1 = require("../VersionedSchema/Utils/getUniqueObjectKeys");
+(0, node_test_1.describe)('getUniqueObjectKeys', () => {
+    (0, node_test_1.test)('@unit: must return unique keys from the object', async () => {
+        const input = { name: 'John', age: 30, nested: { id: 1 } };
+        const result = (0, getUniqueObjectKeys_1.getUniqueObjectKeys)(input);
+        node_assert_1.default.deepEqual(result, ['name', 'age', 'nested', 'id']);
+    });
+    (0, node_test_1.test)('@unit: must return unique keys from an array of objects', async () => {
+        const input = [{ name: 'John' }, { age: 30 }];
+        const result = (0, getUniqueObjectKeys_1.getUniqueObjectKeys)(input);
+        node_assert_1.default.deepEqual(result, ['name', 'age']);
+    });
+    (0, node_test_1.test)('@unit: must return an empty array for an empty object', async () => {
+        const result = (0, getUniqueObjectKeys_1.getUniqueObjectKeys)({});
+        node_assert_1.default.deepEqual(result, []);
+    });
+});

package/dist/common/__tests__/mergeObjectSchemas.test.js

@@ -27,7 +27,7 @@ const mergeObjectSchemas_1 = require("../VersionedSchema/Utils/mergeObjectSchema
         };
         const invalidData = {
             input: 'source/path',
-            httpClient: 'invalid-client', // Некорректное значение для httpClient
+            httpClient: 'invalid-client',
         };
         node_assert_1.default.equal(OptionsSchemaV2_1.optionsSchemaV2.validate(validData).error, null, 'Valid data should pass optionsSchemaV2 validation');
         node_assert_1.default.notEqual(OptionsSchemaV2_1.optionsSchemaV2.validate(invalidData).error, null, 'Invalid data should fail optionsSchemaV2 validation');

package/dist/common/__tests__/migrationForMultiOptions.test.js

@@ -3,85 +3,100 @@ 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 strict_1 = __importDefault(require("node:assert/strict"));
 const node_test_1 = require("node:test");
-const MultiOptionsMigrationPlan_1 = require("common/VersionedSchema/MultiOptionsMigrationPlan");
-const MultiOptionsVersionedSchemas_1 = require("common/VersionedSchema/MultiOptionsVersionedSchemas");
-const core_1 = require("../../core");
 const Enums_1 = require("../VersionedSchema/Enums");
-const migrateToLatestVersion_1 = require("../VersionedSchema/Utils/migrateToLatestVersion");
-(0, node_test_1.describe)('migrateToLatestVersion for Multioptions', () => {
-    (0, node_test_1.test)('@unit: should migrate Multioptions data from 1.0.0 to 2.0.0', () => {
-        const dataMultiV1 = {
-            input: 'source/path',
-            output: 'generated/path',
-            client: core_1.HttpClient.AXIOS,
-            items: [{ input: 'source/path' }, { input: 'source/path' }],
-        };
-        const expectedDataMultiV3 = {
-            httpClient: core_1.HttpClient.AXIOS,
-            items: [
-                { input: 'source/path', output: 'generated/path', outputCore: undefined, outputServices: undefined, outputModels: undefined, outputSchemas: undefined },
-                { input: 'source/path', output: 'generated/path', outputCore: undefined, outputServices: undefined, outputModels: undefined, outputSchemas: undefined },
-            ],
-            useCancelableRequest: false,
-        };
-        const result = (0, migrateToLatestVersion_1.migrateToLatestVersion)({
-            rawInput: dataMultiV1,
-            versionedSchemas: MultiOptionsVersionedSchemas_1.multiOptionsVersionedSchema,
+const MultiOptionsMigrationPlan_1 = require("../VersionedSchema/MultiOptionsMigrationPlan");
+const MultiOptionsVersionedSchemas_1 = require("../VersionedSchema/MultiOptionsVersionedSchemas");
+const migrateDataToLatestSchemaVersion_1 = require("../VersionedSchema/Utils/migrateDataToLatestSchemaVersion");
+const mockJoiSchema_1 = require("./__mock__/mockJoiSchema");
+(0, node_test_1.describe)('migrationForMultiOptions', () => {
+    (0, node_test_1.test)('@unit: must successfully migrate MULTI_OPTIONS data to the latest version', async () => {
+        const input = { input: 'input/path', output: 'output/path', client: 'fetch', items: [{ input: 'path/item1' }] };
+        const result = (0, migrateDataToLatestSchemaVersion_1.migrateDataToLatestSchemaVersion)({
+            rawInput: input,
             migrationPlans: MultiOptionsMigrationPlan_1.multiOptionsMigrationPlan,
+            versionedSchemas: MultiOptionsVersionedSchemas_1.multiOptionsVersionedSchema,
+        });
+        strict_1.default.deepEqual(result, {
+            value: {
+                httpClient: 'fetch',
+                useCancelableRequest: false,
+                items: [
+                    {
+                        input: 'input/path',
+                        output: 'output/path',
+                        outputCore: undefined,
+                        outputModels: undefined,
+                        outputSchemas: undefined,
+                        outputServices: undefined,
+                    },
+                ],
+            },
+            schemaVersion: '2.0.0',
+            schemaType: Enums_1.EVersionedSchemaType.MULTI_OPTIONS,
         });
-        node_assert_1.default.deepEqual(result, { value: expectedDataMultiV3, schemaVersion: '2.0.0', schemaType: Enums_1.EVersionedSchemaType.MULTI_OPTIONS }, 'Should migrate Multioptions V1 data to V3 correctly');
     });
-    (0, node_test_1.test)('@unit: should migrate Multioptions data from 1.0.1 to 2.0.0', () => {
-        const dataMultiV2 = {
-            input: 'source/path',
-            output: 'generated/path',
-            httpClient: core_1.HttpClient.FETCH,
-            items: [{ input: 'item1' }, { input: 'item2' }],
-        };
-        const expectedDataMultiV3 = {
-            httpClient: core_1.HttpClient.FETCH,
-            items: [
-                { input: 'source/path', output: 'generated/path', outputCore: undefined, outputServices: undefined, outputModels: undefined, outputSchemas: undefined },
-                { input: 'source/path', output: 'generated/path', outputCore: undefined, outputServices: undefined, outputModels: undefined, outputSchemas: undefined },
-            ],
-        };
-        const result = (0, migrateToLatestVersion_1.migrateToLatestVersion)({
-            rawInput: dataMultiV2,
-            versionedSchemas: MultiOptionsVersionedSchemas_1.multiOptionsVersionedSchema,
+    (0, node_test_1.test)('@unit: should return null in case of validation error of the last MULTI_OPTIONS scheme', async () => {
+        const input = { input: 'input/path' };
+        const result = (0, migrateDataToLatestSchemaVersion_1.migrateDataToLatestSchemaVersion)({
+            rawInput: input,
             migrationPlans: MultiOptionsMigrationPlan_1.multiOptionsMigrationPlan,
+            versionedSchemas: MultiOptionsVersionedSchemas_1.multiOptionsVersionedSchema,
         });
-        node_assert_1.default.deepEqual(result, { value: expectedDataMultiV3, schemaVersion: '2.0.0', schemaType: Enums_1.EVersionedSchemaType.MULTI_OPTIONS }, 'Should migrate Multioptions 1.0.1 data to 2.0.0 correctly');
+        strict_1.default.equal(result, null);
     });
-    (0, node_test_1.test)('@unit: should throw error if not conform any known version schema', () => {
-        const dataMultiV1 = {
-            input: 'source/path',
-            output: 'generated/path',
-            client: 'invalid-client',
-            items: [{ input: 'item1' }, { input: 'item2' }],
-        };
-        node_assert_1.default.throws(() => {
-            (0, migrateToLatestVersion_1.migrateToLatestVersion)({
-                rawInput: dataMultiV1,
-                versionedSchemas: MultiOptionsVersionedSchemas_1.multiOptionsVersionedSchema,
-                migrationPlans: MultiOptionsMigrationPlan_1.multiOptionsMigrationPlan,
-            });
-        }, /Data does not conform to any known version schema/, 'Should throw error if not conform any known version schema');
+    (0, node_test_1.test)('@unit: should throw an error if the migration plan for MULTI_OPTIONS is not found.', async () => {
+        const input = { input: 'input/path', output: 'output/path', client: 'fetch', items: [{ input: 'path/item1' }] };
+        strict_1.default.throws(() => (0, migrateDataToLatestSchemaVersion_1.migrateDataToLatestSchemaVersion)({
+            rawInput: input,
+            migrationPlans: [],
+            versionedSchemas: MultiOptionsVersionedSchemas_1.multiOptionsVersionedSchema,
+        }), /No migration plan from 1.0.0/);
     });
-    (0, node_test_1.test)('@unit: should throw error if no migration plan exists for Multioptions', () => {
-        const dataMultiV1 = {
-            input: 'source/path',
-            output: 'generated/path',
-            client: 'axios',
-            items: [{ input: 'item1' }, { input: 'item2' }],
+    (0, node_test_1.test)('@unit: should throw an error on unrecognized fields in MULTI_OPTIONS', async () => {
+        const input = {
+            input: 'input/path',
+            output: 'output/path',
+            client: 'fetch',
+            items: [{ input: 'path/item1', name: 'Item1' }],
         };
-        node_assert_1.default.throws(() => {
-            (0, migrateToLatestVersion_1.migrateToLatestVersion)({
-                rawInput: dataMultiV1,
-                versionedSchemas: MultiOptionsVersionedSchemas_1.multiOptionsVersionedSchema,
-                migrationPlans: [],
-            });
-        }, /No migration plan from 1.0.0/, 'Should throw for missing migration plan in Multioptions');
+        strict_1.default.throws(() => (0, migrateDataToLatestSchemaVersion_1.migrateDataToLatestSchemaVersion)({
+            rawInput: input,
+            migrationPlans: MultiOptionsMigrationPlan_1.multiOptionsMigrationPlan,
+            versionedSchemas: MultiOptionsVersionedSchemas_1.multiOptionsVersionedSchema,
+        }), /The "name" field is not recognized./);
+    });
+    (0, node_test_1.test)('@unit: must process an empty array of MULTI_OPTIONS data', async () => {
+        const schemas = [
+            {
+                schema: (0, mockJoiSchema_1.mockJoiSchema)(['name'], true, [], true),
+                version: '1.0',
+                type: Enums_1.EVersionedSchemaType.MULTI_OPTIONS,
+            },
+            {
+                schema: (0, mockJoiSchema_1.mockJoiSchema)(['name', 'options'], true, [], true),
+                version: '2.0',
+                type: Enums_1.EVersionedSchemaType.MULTI_OPTIONS,
+            },
+        ];
+        const migrationPlans = [
+            {
+                fromVersion: '1.0',
+                toVersion: '2.0',
+                migrate: (input) => input.map((item) => ({ ...item, options: [] })),
+            },
+        ];
+        const input = [];
+        const result = (0, migrateDataToLatestSchemaVersion_1.migrateDataToLatestSchemaVersion)({
+            rawInput: input,
+            migrationPlans,
+            versionedSchemas: schemas,
+        });
+        strict_1.default.deepEqual(result, {
+            value: [],
+            schemaVersion: '2.0',
+            schemaType: Enums_1.EVersionedSchemaType.MULTI_OPTIONS,
+        });
     });
 });

package/dist/common/__tests__/migrationForOptions.test.js

@@ -3,61 +3,41 @@ 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 strict_1 = __importDefault(require("node:assert/strict"));
 const node_test_1 = require("node:test");
-const OptionsMigrationPlans_1 = require("common/VersionedSchema/OptionsMigrationPlans");
-const OptionsVersionedSchemas_1 = require("common/VersionedSchema/OptionsVersionedSchemas");
-const core_1 = require("../../core");
 const Enums_1 = require("../VersionedSchema/Enums");
-const migrateToLatestVersion_1 = require("../VersionedSchema/Utils/migrateToLatestVersion");
-(0, node_test_1.describe)('migrateToLatestVersion', () => {
-    (0, node_test_1.test)('@unit: should migrate data from 1.0.0 to 2.0.0', () => {
-        const dataV1 = { input: 'source/path', output: 'generated/path', client: core_1.HttpClient.AXIOS };
-        const expectedDataV3 = {
-            input: 'source/path',
-            output: 'generated/path',
-            httpClient: core_1.HttpClient.AXIOS,
-            useCancelableRequest: false,
-        };
-        const result = (0, migrateToLatestVersion_1.migrateToLatestVersion)({
-            rawInput: dataV1,
-            versionedSchemas: OptionsVersionedSchemas_1.optionsVersionedSchemas,
+const OptionsMigrationPlans_1 = require("../VersionedSchema/OptionsMigrationPlans");
+const OptionsVersionedSchemas_1 = require("../VersionedSchema/OptionsVersionedSchemas");
+const migrateDataToLatestSchemaVersion_1 = require("../VersionedSchema/Utils/migrateDataToLatestSchemaVersion");
+(0, node_test_1.describe)('migrationForOptions', () => {
+    (0, node_test_1.test)('@unit: must migrate data to the latest schema version', async () => {
+        const input = { input: "input/path", output: "output/path", client: "fetch" };
+        const result = (0, migrateDataToLatestSchemaVersion_1.migrateDataToLatestSchemaVersion)({
+            rawInput: input,
             migrationPlans: OptionsMigrationPlans_1.optionsMigrationPlans,
+            versionedSchemas: OptionsVersionedSchemas_1.optionsVersionedSchemas,
+        });
+        strict_1.default.deepEqual(result, {
+            value: { input: 'input/path', output: 'output/path', httpClient: 'fetch', useCancelableRequest: false },
+            schemaVersion: '2.0.0',
+            schemaType: Enums_1.EVersionedSchemaType.OPTIONS,
         });
-        node_assert_1.default.deepEqual(result, { value: expectedDataV3, schemaVersion: '2.0.0', schemaType: Enums_1.EVersionedSchemaType.OPTIONS }, 'Should migrate 1.0.0 data to 2.0.0 correctly');
     });
-    (0, node_test_1.test)('@unit: should migrate data from 1.0.1 to 2.0.0', () => {
-        const dataV2 = { input: 'source/path', output: 'generated/path', httpClient: core_1.HttpClient.FETCH };
-        const expectedDataV3 = {
-            input: 'source/path',
-            output: 'generated/path',
-            httpClient: core_1.HttpClient.FETCH,
-        };
-        const result = (0, migrateToLatestVersion_1.migrateToLatestVersion)({
-            rawInput: dataV2,
-            versionedSchemas: OptionsVersionedSchemas_1.optionsVersionedSchemas,
+    (0, node_test_1.test)('@unit: should return null if the validation error occurred for the last schema.', async () => {
+        const input = { input: "input/path", };
+        const result = (0, migrateDataToLatestSchemaVersion_1.migrateDataToLatestSchemaVersion)({
+            rawInput: input,
             migrationPlans: OptionsMigrationPlans_1.optionsMigrationPlans,
+            versionedSchemas: OptionsVersionedSchemas_1.optionsVersionedSchemas,
         });
-        node_assert_1.default.deepEqual(result, { value: expectedDataV3, schemaVersion: '2.0.0', schemaType: Enums_1.EVersionedSchemaType.OPTIONS }, 'Should migrate 1.0.1 data to 2.0.0 correctly');
-    });
-    (0, node_test_1.test)('@unit: should throw error if not conform any known version schema', () => {
-        const dataV1 = { input: 'source/path', output: 'generated/path', client: 'invalid-client' };
-        node_assert_1.default.throws(() => {
-            (0, migrateToLatestVersion_1.migrateToLatestVersion)({
-                rawInput: dataV1,
-                versionedSchemas: OptionsVersionedSchemas_1.optionsVersionedSchemas,
-                migrationPlans: OptionsMigrationPlans_1.optionsMigrationPlans,
-            });
-        }, /Data does not conform to any known version schema/, 'Should throw error if not conform any known version schema');
+        strict_1.default.equal(result, null);
     });
-    (0, node_test_1.test)('@unit: should throw error if no migration plan exists', () => {
-        const dataV1 = { input: 'source/path', output: 'generated/path', client: core_1.HttpClient.AXIOS };
-        node_assert_1.default.throws(() => {
-            (0, migrateToLatestVersion_1.migrateToLatestVersion)({
-                rawInput: dataV1,
-                versionedSchemas: OptionsVersionedSchemas_1.optionsVersionedSchemas,
-                migrationPlans: [],
-            });
-        }, /No migration plan from 1.0.0/, 'Should throw for missing migration plan');
+    (0, node_test_1.test)('@unit: It should throw an error if the migration plan is not found.', async () => {
+        const input = { input: "input/path", output: "output/path", client: "fetch" };
+        strict_1.default.throws(() => (0, migrateDataToLatestSchemaVersion_1.migrateDataToLatestSchemaVersion)({
+            rawInput: input,
+            migrationPlans: [],
+            versionedSchemas: OptionsVersionedSchemas_1.optionsVersionedSchemas,
+        }), /No migration plan from 1.0.0/);
     });
 });

package/dist/common/__tests__/replaceInvalidKeysWithMappedNames.test.d.ts

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

package/dist/common/__tests__/replaceInvalidKeysWithMappedNames.test.d.ts.map

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

package/dist/common/__tests__/replaceInvalidKeysWithMappedNames.test.js

@@ -0,0 +1,25 @@
+"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 replaceInvalidKeysWithMappedNames_1 = require("../VersionedSchema/Utils/replaceInvalidKeysWithMappedNames");
+(0, node_test_1.describe)('replaceInvalidKeysWithMappedNames', () => {
+    (0, node_test_1.test)('@unit: must replace invalid keys in the object', async () => {
+        const input = { nmae: 'John', title: 'Mr' };
+        const keyMap = new Map([['nmae', 'name']]);
+        const result = (0, replaceInvalidKeysWithMappedNames_1.replaceInvalidKeysWithMappedNames)(input, keyMap);
+        node_assert_1.default.deepEqual(result, { name: 'John', title: 'Mr' });
+    });
+    (0, node_test_1.test)('@unit: must replace invalid keys in an array of objects', async () => {
+        const input = [{ nmae: 'John' }, { nmae: 'Jane' }];
+        const keyMap = new Map([['nmae', 'name']]);
+        const result = (0, replaceInvalidKeysWithMappedNames_1.replaceInvalidKeysWithMappedNames)(input, keyMap);
+        node_assert_1.default.deepEqual(result, [{ name: 'John' }, { name: 'Jane' }]);
+    });
+    (0, node_test_1.test)('@unit: should throw an error for null or undefined', async () => {
+        node_assert_1.default.throws(() => (0, replaceInvalidKeysWithMappedNames_1.replaceInvalidKeysWithMappedNames)(null, new Map()), /The input data cannot be null or undefined./);
+    });
+});

package/dist/common/__tests__/validateAndSuggestKeyCorrections.test.d.ts

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

package/dist/common/__tests__/validateAndSuggestKeyCorrections.test.d.ts.map

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

package/dist/common/__tests__/validateAndSuggestKeyCorrections.test.js

@@ -0,0 +1,25 @@
+"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 validateAndSuggestKeyCorrections_1 = require("../VersionedSchema/Utils/validateAndSuggestKeyCorrections");
+(0, node_test_1.describe)('validateAndSuggestKeyCorrections', () => {
+    (0, node_test_1.test)('@unit: should throw an error for unknown keys with a suggestion for correction', async () => {
+        const inputKeys = ['nmae'];
+        const allowedKeys = new Set(['name', 'title']);
+        node_assert_1.default.throws(() => (0, validateAndSuggestKeyCorrections_1.validateAndSuggestKeyCorrections)(inputKeys, allowedKeys), /The "nmae" field is not recognized. Perhaps you meant "name"./);
+    });
+    (0, node_test_1.test)('@unit: should throw an error without suggestions for keys with a large distance', async () => {
+        const inputKeys = ['unknown'];
+        const allowedKeys = new Set(['name', 'title']);
+        node_assert_1.default.throws(() => (0, validateAndSuggestKeyCorrections_1.validateAndSuggestKeyCorrections)(inputKeys, allowedKeys), /The "unknown" field is not recognized./);
+    });
+    (0, node_test_1.test)('@unit: should not throw an error for valid keys', async () => {
+        const inputKeys = ['name', 'title'];
+        const allowedKeys = new Set(['name', 'title']);
+        node_assert_1.default.doesNotThrow(() => (0, validateAndSuggestKeyCorrections_1.validateAndSuggestKeyCorrections)(inputKeys, allowedKeys));
+    });
+});

package/dist/core/Context.d.ts

@@ -1,6 +1,12 @@
 import { JSONSchema4Type, JSONSchema6Type, JSONSchema7Type } from 'json-schema';
 import RefParser from 'json-schema-ref-parser';
 import { IOutput, Prefix } from './types/Models';
+type TContextProps = {
+    input: string | Record<string, any>;
+    output: IOutput;
+    prefix?: Prefix;
+    sortByRequired?: boolean;
+};
 /**
  * A Context wich can share a data between methods
  */
@@ -9,7 +15,8 @@ export declare class Context {
     private _root;
     private _output;
     prefix: Prefix;
-    constructor(input: string | Record<string, any>, output: IOutput, prefix?: Prefix);
+    private _sortByRequired;
+    constructor({ input, output, prefix, sortByRequired }: TContextProps);
     addRefs(refs: RefParser.$Refs): Context;
     values(...types: string[]): Record<string, any>;
     get($ref: string): JSONSchema4Type | JSONSchema6Type | JSONSchema7Type;
@@ -17,5 +24,7 @@ export declare class Context {
     exists($ref: string): boolean;
     fileName(): string;
     get output(): IOutput;
+    get sortByRequired(): boolean;
 }
+export {};
 //# sourceMappingURL=Context.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Context.d.ts","sourceRoot":"","sources":["../../src/core/Context.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAChF,OAAO,SAAS,MAAM,wBAAwB,CAAC;AAE/C,OAAO,EAAS,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAKxD;;GAEG;AACH,qBAAa,OAAO;IAChB,OAAO,CAAC,KAAK,CAA8B;IAC3C,OAAO,CAAC,KAAK,CAAoB;IACjC,OAAO,CAAC,OAAO,CAAU;IAClB,MAAM,EAAE,MAAM,CAInB;gBAEU,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,MAAM;IAc1E,OAAO,CAAC,IAAI,EAAE,SAAS,CAAC,KAAK,GAAG,OAAO;IAKvC,MAAM,CAAC,GAAG,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAO/C,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,eAAe,GAAG,eAAe,GAAG,eAAe;IAOtE,KAAK,CAAC,GAAG,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE;IAOnC,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAO7B,QAAQ,IAAI,MAAM;IAOzB,IAAW,MAAM,YAKhB;CACJ"}
+{"version":3,"file":"Context.d.ts","sourceRoot":"","sources":["../../src/core/Context.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAChF,OAAO,SAAS,MAAM,wBAAwB,CAAC;AAE/C,OAAO,EAAS,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAKxD,KAAK,aAAa,GAAG;IACjB,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACpC,MAAM,EAAE,OAAO,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE,OAAO,CAAC;CAC5B,CAAA;AAED;;GAEG;AACH,qBAAa,OAAO;IAChB,OAAO,CAAC,KAAK,CAA8B;IAC3C,OAAO,CAAC,KAAK,CAAoB;IACjC,OAAO,CAAC,OAAO,CAAU;IAClB,MAAM,EAAE,MAAM,CAInB;IAEF,OAAO,CAAC,eAAe,CAAkB;gBAE7B,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,EAAE,aAAa;IAmB7D,OAAO,CAAC,IAAI,EAAE,SAAS,CAAC,KAAK,GAAG,OAAO;IAKvC,MAAM,CAAC,GAAG,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAO/C,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,eAAe,GAAG,eAAe,GAAG,eAAe;IAOtE,KAAK,CAAC,GAAG,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE;IAOnC,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAO7B,QAAQ,IAAI,MAAM;IAOzB,IAAW,MAAM,YAKhB;IAED,IAAW,cAAc,YAExB;CACJ"}

package/dist/core/Context.js

@@ -16,7 +16,8 @@ class Context {
         enum: 'E',
         type: 'T',
     };
-    constructor(input, output, prefix) {
+    _sortByRequired = false;
+    constructor({ input, output, prefix, sortByRequired }) {
         this._output = output;
         this._refs = {};
         if ((0, isString_1.isString)(input)) {
@@ -28,6 +29,9 @@ class Context {
         if (prefix) {
             this.prefix = prefix;
         }
+        if (sortByRequired !== undefined && sortByRequired !== null) {
+            this._sortByRequired = sortByRequired;
+        }
         return this;
     }
     addRefs(refs) {
@@ -70,5 +74,8 @@ class Context {
         }
         return this._output;
     }
+    get sortByRequired() {
+        return this._sortByRequired;
+    }
 }
 exports.Context = Context;

package/dist/core/api/v2/parser/__tests__/getType.test.js

@@ -14,7 +14,7 @@ const Parser_1 = require("../../Parser");
         // eslint-disable-next-line @typescript-eslint/ban-ts-comment
         // @ts-ignore
         const parser = new json_schema_ref_parser_1.default();
-        const context = new Context_1.Context('test/spec/v3.yml', (0, getOutputPaths_1.getOutputPaths)({ output: './generated' }));
+        const context = new Context_1.Context({ input: 'test/spec/v3.yml', output: (0, getOutputPaths_1.getOutputPaths)({ output: './generated' }) });
         context.addRefs(await parser.resolve('test/spec/v3.yml'));
         const type = new Parser_1.Parser(context).getType('int', '');
         node_assert_1.default.strictEqual(type.type, 'number');
@@ -26,7 +26,7 @@ const Parser_1 = require("../../Parser");
         // eslint-disable-next-line @typescript-eslint/ban-ts-comment
         // @ts-ignore
         const parser = new json_schema_ref_parser_1.default();
-        const context = new Context_1.Context('test/spec/v3.yml', (0, getOutputPaths_1.getOutputPaths)({ output: './generated' }));
+        const context = new Context_1.Context({ input: 'test/spec/v3.yml', output: (0, getOutputPaths_1.getOutputPaths)({ output: './generated' }) });
         context.addRefs(await parser.resolve('test/spec/v3.yml'));
         const type = new Parser_1.Parser(context).getType('schemas/ModelWithString.yml', '');
         node_assert_1.default.strictEqual(type.type, 'IModelWithString');
@@ -53,7 +53,7 @@ const Parser_1 = require("../../Parser");
         // eslint-disable-next-line @typescript-eslint/ban-ts-comment
         // @ts-ignore
         const parser = new json_schema_ref_parser_1.default();
-        const context = new Context_1.Context(object, (0, getOutputPaths_1.getOutputPaths)({ output: './generated' }));
+        const context = new Context_1.Context({ input: object, output: (0, getOutputPaths_1.getOutputPaths)({ output: './generated' }) });
         context.addRefs(await parser.resolve(object));
         const type = new Parser_1.Parser(context).getType('#/components/schemas/someSpecialSchema', '');
         node_assert_1.default.strictEqual(type.type, 'ISomeSpecialSchema');

package/dist/core/api/v2/parser/getOperationParameters.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getOperationParameters.d.ts","sourceRoot":"","sources":["../../../../../src/core/api/v2/parser/getOperationParameters.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,iDAAiD,CAAC;AAE3F,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAExE,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,GAAG,mBAAmB,CA6D1H"}
+{"version":3,"file":"getOperationParameters.d.ts","sourceRoot":"","sources":["../../../../../src/core/api/v2/parser/getOperationParameters.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,iDAAiD,CAAC;AAG3F,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAExE,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,GAAG,mBAAmB,CA+D1H"}