ts-openapi-codegen 1.0.0-beta.4 → 1.0.0-beta.6

package/README.md

@@ -57,7 +57,7 @@ $ openapi --help
     -os, --outputServices <value> Output directory for services
     -om, --outputModels <value>   Output directory for models
     -osm, --outputSchemas <value> Output directory for schemas
-    -c, --client <value>          HTTP client to generate [fetch, xhr, node] (default: "fetch")
+    -c, --httpClient <value>      HTTP client to generate [fetch, xhr, node] (default: "fetch")
     --useOptions <value>          Use options instead of arguments (default: false)
     --useUnionTypes <value>       Use union types instead of enums (default: false)
     --exportCore <value>          Write core files to disk (default: true)
@@ -69,6 +69,7 @@ $ openapi --help
     --enumPrefix <value>          Prefix for enum model(default: "E")
     --typePrefix <value>          Prefix for type model(default: "T")
     --useCancelableRequest        Use cancelled promise as returned data type in request(default: false)
+    -s, --sortByRequired          Property sorting strategy: simplified or extended
 
   Examples
     $ openapi --input ./spec.json
@@ -389,6 +390,39 @@ const MyForm = () => (
 
 ```
 
+### Cancelable promise `--useCancelableRequest`
+By default, the OpenAPI generator generates services for accessing the API that use non-cancellable requests. Therefore, we have added the ability to switch the generator to generate canceled API requests. To do this, use the flag `--useCancelableRequest`.
+An example of a cancelled request would look like this:
+
+```typescript
+export function request<T>(config: TOpenAPIConfig, options: ApiRequestOptions): CancelablePromise<T> {
+    return new CancelablePromise(async(resolve, reject, onCancel) => {
+        const url = `${config.BASE}${options.path}`.replace('{api-version}', config.VERSION);
+        try {
+            if (!onCancel.isCancelled) {
+                const response = await sendRequest(options, url, config, onCancel);
+                const responseBody = await getResponseBody(response);
+                const responseHeader = getResponseHeader(response, options.responseHeader);
+                const result: ApiResult = {
+                    url,
+                    ok: response.ok,
+                    status: response.status,
+                    statusText: response.statusText,
+                    body: responseHeader || responseBody,
+                };
+
+                catchErrors(options, result);
+                resolve(result.body);
+            }
+        } catch (e) {
+            reject(e);
+        }
+    });
+}
+```
+
+### Sorting strategy for function arguments `--sortByRequired`
+By default, the OpenAPI generator sorts the parameters of service functions according to a simplified scheme. If you need a more strict sorting option, then you need to use the sortByRequired flag. The simplified sorting option is similar to the one used in version 0.2.3 of the OpenAPI generator. This flag allows you to upgrade to a new version of the generator if you are "stuck" on version 0.2.3.
 
 ### Enum with custom names and descriptions
 You can use `x-enum-varnames` and `x-enum-descriptions` in your spec to generate enum with custom names and descriptions.

package/dist/cli/chekOpenApiConfig/chekOpenApiConfig.d.ts

@@ -0,0 +1,5 @@
+/**
+ * The function checks whether the configuration file data is filled in correctly
+ */
+export declare function chekOpenApiConfig(): void;
+//# sourceMappingURL=chekOpenApiConfig.d.ts.map

package/dist/cli/chekOpenApiConfig/chekOpenApiConfig.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"chekOpenApiConfig.d.ts","sourceRoot":"","sources":["../../../src/cli/chekOpenApiConfig/chekOpenApiConfig.ts"],"names":[],"mappings":"AAQA;;GAEG;AACH,wBAAgB,iBAAiB,SA4BhC"}

package/dist/cli/chekOpenApiConfig/chekOpenApiConfig.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.chekOpenApiConfig = chekOpenApiConfig;
+const Enums_1 = require("../../common/Enums");
+const Logger_1 = require("../../common/Logger");
+const Utils_1 = require("../../common/Utils");
+const MultiOptionsVersionedSchemas_1 = require("../../common/VersionedSchema/MultiOptionsVersionedSchemas");
+const OptionsVersionedSchemas_1 = require("../../common/VersionedSchema/OptionsVersionedSchemas");
+const getErrorFieldsFromValidation_1 = require("../../common/VersionedSchema/Utils/getErrorFieldsFromValidation");
+const isInstanceOfMultiOptions_1 = require("../../core/utils/isInstanceOfMultiOptions");
+/**
+ * The function checks whether the configuration file data is filled in correctly
+ */
+function chekOpenApiConfig() {
+    const logger = new Logger_1.Logger({
+        level: Enums_1.ELogLevel.INFO,
+        instanceId: 'check-openapi-config',
+        logOutput: Enums_1.ELogOutput.CONSOLE,
+    });
+    try {
+        const configData = (0, Utils_1.loadConfigIfExists)();
+        if (!configData) {
+            logger.error('The configuration file is missing');
+        }
+        const preparedOptions = (0, Utils_1.convertArrayToObject)(configData);
+        const isMultiOptions = (0, isInstanceOfMultiOptions_1.isInstanceOfMultioptions)(preparedOptions);
+        const currentMigrationPlan = isMultiOptions ? MultiOptionsVersionedSchemas_1.multiOptionsVersionedSchema : OptionsVersionedSchemas_1.optionsVersionedSchemas;
+        const currentSchema = currentMigrationPlan
+            .map((sch, idx) => ({ ...sch, index: idx + 1 }))
+            .reduce((prev, curr) => (curr.index > prev.index ? curr : prev));
+        const { error } = currentSchema.schema.validate(preparedOptions);
+        if (error) {
+            const details = (0, getErrorFieldsFromValidation_1.getErrorFieldsFromValidation)(error).map((e) => `${e.path}: ${e.type}`).join(',');
+            logger.error(`The configuration file data is specified incorrectly: ${details}`);
+        }
+    }
+    catch (error) {
+        logger.error(error.message);
+    }
+}

package/dist/cli/index.js

@@ -1,17 +1,30 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 const commander_1 = require("commander");
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
 const Enums_1 = require("../common/Enums");
+const Logger_1 = require("../common/Logger");
+const UpdateNotifier_1 = require("../common/UpdateNotifier");
 const Enums_2 = require("../core/types/Enums");
+const chekOpenApiConfig_1 = require("./chekOpenApiConfig/chekOpenApiConfig");
 const runGenerateOpenApi_1 = require("./generate/runGenerateOpenApi");
-const APP_NAME = 'ts-openapi-codegen-cli';
-const APP_VERSION = '1.0.0';
+const utils_1 = require("./utils");
+const packageDetails = JSON.parse(fs_1.default.readFileSync(path_1.default.join(__dirname, '../../package.json'), 'utf-8'));
+const APP_NAME = packageDetails.name || 'ts-openapi-codegen-cli';
+const APP_VERSION = packageDetails.version || '1.0.0';
+const APP_DESCRIPTION = packageDetails.description || 'Description';
+const updateNotifier = new UpdateNotifier_1.UpdateNotifier(APP_NAME, APP_VERSION);
 const program = new commander_1.Command();
-program.version(APP_VERSION).name(APP_NAME).description('Описание').addHelpText('before', 'Дополнительный текст');
+program.version(APP_VERSION).name(APP_NAME).description(APP_DESCRIPTION).addHelpText('before', (0, utils_1.getCLIName)(APP_NAME));
 program
     .command('generate')
+    .description('Starts code generation based on the provided opeanpi specifications')
+    .addHelpText('before', (0, utils_1.getCLIName)(APP_NAME))
     .usage('[options]')
-    .version(APP_VERSION)
     .option('-i, --input <value>', 'OpenAPI specification, can be a path, url or string content (required)', '')
     .option('-o, --output <value>', 'Output directory (required)', '')
     .option('-oc, --outputCore <value>', 'Output directory for core files')
@@ -33,7 +46,36 @@ program
     .option('--useCancelableRequest <value>', 'Use cancelled promise as returned data type in request(default: false)', false)
     .addOption(new commander_1.Option('-l, --logLevel <level>', 'Logging level').choices([...Object.values(Enums_1.ELogLevel)]).default(Enums_1.ELogLevel.ERROR))
     .addOption(new commander_1.Option('-t, --logTarget <target>', 'Target of logging').choices([...Object.values(Enums_1.ELogOutput)]).default(Enums_1.ELogOutput.CONSOLE))
+    .option('-s, --sortByRequired', 'Property sorting strategy: simplified or extended')
+    .hook('preAction', () => {
+    updateNotifier.checkAndNotify();
+})
     .action(async (options) => {
     await (0, runGenerateOpenApi_1.runGenerateOpenApi)(options);
 });
-program.parse(process.argv);
+program
+    .command('check-openapi-config')
+    .description('Starts checking whether the configuration file data is filled in correctly.')
+    .addHelpText('before', (0, utils_1.getCLIName)(APP_NAME))
+    .hook('preAction', () => {
+    updateNotifier.checkAndNotify();
+})
+    .action(() => {
+    (0, chekOpenApiConfig_1.chekOpenApiConfig)();
+});
+try {
+    program.parse(process.argv);
+}
+catch (error) {
+    if (error.code === 'commander.unknownOption') {
+        const errorMessage = error?.message ?? '';
+        if (errorMessage) {
+            const logger = new Logger_1.Logger({
+                level: Enums_1.ELogLevel.INFO,
+                instanceId: 'check-openapi-config',
+                logOutput: Enums_1.ELogOutput.CONSOLE,
+            });
+            logger.error(errorMessage);
+        }
+    }
+}

package/dist/cli/utils.d.ts

@@ -16,4 +16,9 @@
  */
 export declare function isNil(value: any): boolean;
 export declare function isValidJson(value: any): boolean;
+/**
+ * Returns the stylized package name to display in the terminal
+ * @param appName Package name
+ */
+export declare function getCLIName(appName: string): string;
 //# sourceMappingURL=utils.d.ts.map

package/dist/cli/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/cli/utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,KAAK,CAAC,KAAK,EAAE,GAAG,WAE/B;AAED,wBAAgB,WAAW,CAAC,KAAK,EAAE,GAAG,WAOrC"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/cli/utils.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,KAAK,CAAC,KAAK,EAAE,GAAG,WAE/B;AAED,wBAAgB,WAAW,CAAC,KAAK,EAAE,GAAG,WAOrC;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,MAAM,UAazC"}

package/dist/cli/utils.js

@@ -1,7 +1,12 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isNil = isNil;
 exports.isValidJson = isValidJson;
+exports.getCLIName = getCLIName;
+const figlet_1 = __importDefault(require("figlet"));
 /**
  * Checks if `value` is `null` or `undefined`.
  *
@@ -30,3 +35,20 @@ function isValidJson(value) {
         return false;
     }
 }
+/**
+ * Returns the stylized package name to display in the terminal
+ * @param appName Package name
+ */
+function getCLIName(appName) {
+    const name = figlet_1.default.textSync(appName, {
+        horizontalLayout: 'default',
+        verticalLayout: 'default',
+        width: 75,
+        whitespaceBreak: true,
+    });
+    return `
+    
+    ${name}
+    
+    `;
+}

package/dist/common/Options.d.ts

@@ -20,6 +20,7 @@ export type TOptions = {
     enumPrefix?: string;
     typePrefix?: string;
     useCancelableRequest?: boolean;
+    sortByRequired?: boolean;
 };
 export type TMultiOptions = {
     items: TOptions[];

package/dist/common/Options.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Options.d.ts","sourceRoot":"","sources":["../../src/common/Options.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjD,MAAM,MAAM,QAAQ,GAAG;IACnB,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,KAAK,EAAE,QAAQ,EAAE,CAAC;CACnB,GAAG,IAAI,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,CAAC,CAAC"}
+{"version":3,"file":"Options.d.ts","sourceRoot":"","sources":["../../src/common/Options.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjD,MAAM,MAAM,QAAQ,GAAG;IACnB,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,cAAc,CAAC,EAAE,OAAO,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,KAAK,EAAE,QAAQ,EAAE,CAAC;CACnB,GAAG,IAAI,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,CAAC,CAAC"}

package/dist/common/UpdateNotifier.d.ts

@@ -0,0 +1,24 @@
+/**
+ * A class for tracking the release of a newer version of the generator
+ */
+export declare class UpdateNotifier {
+    private _packageName;
+    private _packageVersion;
+    private _configStore;
+    private _packageStoreInfo;
+    private _logger;
+    constructor(packageName: string, packageVersion: string);
+    /**
+     * Requests the latest version of the generator via npm
+     */
+    private fetchNpmPackageInfo;
+    /**
+     * Checks for updates and writes useful information to the cache
+     */
+    private checkUpdate;
+    /**
+     * Checks for updates and notifies about the possibility to install a new version.
+     */
+    checkAndNotify(): void;
+}
+//# sourceMappingURL=UpdateNotifier.d.ts.map

package/dist/common/UpdateNotifier.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"UpdateNotifier.d.ts","sourceRoot":"","sources":["../../src/common/UpdateNotifier.ts"],"names":[],"mappings":"AAqBA;;GAEG;AACH,qBAAa,cAAc;IACvB,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,eAAe,CAAS;IAChC,OAAO,CAAC,YAAY,CAA4B;IAChD,OAAO,CAAC,iBAAiB,CAAkC;IAC3D,OAAO,CAAC,OAAO,CAAS;gBAEZ,WAAW,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM;IA0BvD;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAkB3B;;OAEG;IACH,OAAO,CAAC,WAAW;IAwBnB;;OAEG;IACH,cAAc;CAmCjB"}

package/dist/common/UpdateNotifier.js

@@ -0,0 +1,120 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UpdateNotifier = void 0;
+const boxen_1 = __importDefault(require("boxen"));
+const chalk_1 = __importDefault(require("chalk"));
+const child_process_1 = require("child_process");
+const configstore_1 = __importDefault(require("configstore"));
+const semver_1 = __importDefault(require("semver"));
+const Enums_1 = require("./Enums");
+const Logger_1 = require("./Logger");
+// one week
+const UPDATE_CHECK_INTERVAL = 1000 * 60 * 60 * 24 * 7;
+const INCLUDED_RELEASE_TYPES = ['major', 'minor'];
+/**
+ * A class for tracking the release of a newer version of the generator
+ */
+class UpdateNotifier {
+    _packageName;
+    _packageVersion;
+    _configStore = null;
+    _packageStoreInfo = null;
+    _logger;
+    constructor(packageName, packageVersion) {
+        this._logger = new Logger_1.Logger({
+            instanceId: '',
+            level: Enums_1.ELogLevel.INFO,
+            logOutput: Enums_1.ELogOutput.CONSOLE,
+        });
+        if (!packageName || !packageVersion) {
+            this._logger.warn(`
+                The necessary parameters for checking the version are not specified.
+                Current values packageName: ${packageName}, packageVersion: ${packageVersion}
+            `);
+        }
+        this._packageName = packageName;
+        this._packageVersion = packageVersion;
+        try {
+            this._configStore = new configstore_1.default(`-${this._packageName}`, {
+                lastUpdateCheck: Date.now(),
+            });
+        }
+        catch {
+            this._logger.warn('The settings store has not been created. The package update will be checked more often than once every 1 week!');
+        }
+    }
+    /**
+     * Requests the latest version of the generator via npm
+     */
+    fetchNpmPackageInfo() {
+        try {
+            const latestVersion = (0, child_process_1.execSync)(`npm view ${this._packageName} version`).toString().trim();
+            const releaseType = semver_1.default.diff(this._packageVersion, latestVersion);
+            return {
+                currentVersion: this._packageVersion,
+                differenceType: releaseType,
+                latestVersion,
+                packageName: this._packageName,
+            };
+        }
+        catch {
+            this._logger.warn("Couldn't get information about the latest current version");
+            return null;
+        }
+    }
+    /**
+     * Checks for updates and writes useful information to the cache
+     */
+    checkUpdate() {
+        if (!this._configStore) {
+            return;
+        }
+        this._packageStoreInfo = this._configStore.get('package_store_info');
+        if (this._packageStoreInfo) {
+            this._packageStoreInfo.currentVersion = this._packageVersion;
+            // clean cache
+            this._configStore.delete('package_store_info');
+        }
+        if (Date.now() - this._configStore.get('lastUpdateCheck') < UPDATE_CHECK_INTERVAL) {
+            return;
+        }
+        const fetchInfo = this.fetchNpmPackageInfo();
+        this._configStore.set('lastUpdateCheck', Date.now());
+        if (fetchInfo?.differenceType && INCLUDED_RELEASE_TYPES.includes(fetchInfo.differenceType)) {
+            this._configStore.set('package_store_info', fetchInfo);
+        }
+    }
+    /**
+     * Checks for updates and notifies about the possibility to install a new version.
+     */
+    checkAndNotify() {
+        if (!this._configStore) {
+            this._logger.warn("Couldn't get information about the latest current version");
+            this._logger.shutdownLogger();
+            return;
+        }
+        this.checkUpdate();
+        if (!this._packageStoreInfo || !semver_1.default.gt(this._packageStoreInfo.latestVersion, this._packageStoreInfo.currentVersion)) {
+            return;
+        }
+        const { packageName, currentVersion, latestVersion } = this._packageStoreInfo;
+        const scriptText = chalk_1.default.yellowBright(`npm i -D ${packageName}@${latestVersion}`);
+        const message = `
+        An update is available: ${chalk_1.default.gray(currentVersion)} -> ${chalk_1.default.greenBright(latestVersion)}}
+        Run ${scriptText} to update
+        `;
+        console.log((0, boxen_1.default)(message, {
+            borderColor: 'cyanBright',
+            margin: 1,
+            padding: 1,
+            title: 'Pay attention',
+            titleAlignment: 'center',
+            textAlignment: 'center',
+        }));
+        this._logger.shutdownLogger();
+    }
+}
+exports.UpdateNotifier = UpdateNotifier;

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/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/{utils/writeClient.d.ts → WriteClient.d.ts}

@@ -1,8 +1,8 @@
-import { Logger } from '../../common/Logger';
-import { HttpClient } from '../types/Enums';
-import { IOutput } from '../types/Models';
-import type { Client } from '../types/shared/Client.model';
-import { Templates } from './registerHandlebarTemplates';
+import { Logger } from '../common/Logger';
+import { HttpClient } from './types/Enums';
+import { IOutput } from './types/Models';
+import type { Client } from './types/shared/Client.model';
+import { Templates } from './utils/registerHandlebarTemplates';
 /**
  * @param client Client object with all the models, services, etc.
  * @param templates Templates wrapper with all loaded Handlebars templates
@@ -84,6 +84,13 @@ export declare class WriteClient {
     writeClientIndex(options: IWriteClientIndex): Promise<void>;
     combineAndWrite(): Promise<void>;
     get logger(): Logger;
+    private buildClientIndexMap;
+    private finalizeAndWright;
+    private getOutputPath;
+    private ensureClientIndex;
+    private isSameModel;
+    private isSameShema;
+    private isSomeService;
 }
 export {};
-//# sourceMappingURL=writeClient.d.ts.map
+//# sourceMappingURL=WriteClient.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"WriteClient.d.ts","sourceRoot":"","sources":["../../src/core/WriteClient.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AACzC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,6BAA6B,CAAC;AAI1D,OAAO,EAAE,SAAS,EAAE,MAAM,oCAAoC,CAAC;AAU/D;;;;;;;;;;;;;;GAcG;AACH,UAAU,YAAY;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,SAAS,CAAC;IACrB,WAAW,EAAE,OAAO,CAAC;IACrB,UAAU,EAAE,UAAU,CAAC;IACvB,UAAU,EAAE,OAAO,CAAC;IACpB,aAAa,EAAE,OAAO,CAAC;IACvB,UAAU,EAAE,OAAO,CAAC;IACpB,cAAc,EAAE,OAAO,CAAC;IACxB,YAAY,EAAE,OAAO,CAAC;IACtB,aAAa,EAAE,OAAO,CAAC;IACvB,KAAK,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAClC;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,iBAAiB;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,SAAS,CAAC;IACrB,WAAW,EAAE,OAAO,CAAC;IACrB,aAAa,EAAE,OAAO,CAAC;IACvB,UAAU,EAAE,OAAO,CAAC;IACpB,cAAc,EAAE,OAAO,CAAC;IACxB,YAAY,EAAE,OAAO,CAAC;IACtB,aAAa,EAAE,OAAO,CAAC;CAC1B;AAED;;GAEG;AACH,qBAAa,WAAW;IACpB,OAAO,CAAC,OAAO,CAA+C;IAC9D,OAAO,CAAC,OAAO,CAAS;;IAUxB;;;;;;;;;;;;;;;OAeG;IACG,WAAW,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IA+DvD;;;OAGG;IACG,gBAAgB,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAU3D,eAAe;IAKrB,IAAW,MAAM,WAEhB;IAED,OAAO,CAAC,mBAAmB;YAgEb,iBAAiB;IAU/B,OAAO,CAAC,aAAa;IAIrB,OAAO,CAAC,iBAAiB;IAmBzB,OAAO,CAAC,WAAW;IAWnB,OAAO,CAAC,WAAW;IAInB,OAAO,CAAC,aAAa;CAGxB"}