@redocly/cli 1.18.1 → 1.20.0

package/lib/utils/miscellaneous.js

@@ -1,26 +1,37 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __rest = (this && this.__rest) || function (s, e) {
-    var t = {};
-    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
-        t[p] = s[p];
-    if (s != null && typeof Object.getOwnPropertySymbols === "function")
-        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
-            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
-                t[p[i]] = s[p[i]];
-        }
-    return t;
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.notifyAboutIncompatibleConfigOptions = exports.checkForDeprecatedOptions = exports.cleanRawInput = exports.cleanArgs = exports.sendTelemetry = exports.cleanColors = exports.checkIfRulesetExist = exports.sortTopLevelKeysForOas = exports.loadConfigAndHandleErrors = exports.isSubdir = exports.exitWithError = exports.printUnusedWarnings = exports.getOutputFileName = exports.printConfigLintTotals = exports.printLintTotals = exports.HandledError = exports.handleError = exports.pluralize = exports.getAndValidateFileExtension = exports.writeJson = exports.writeYaml = exports.writeToFileByExtension = exports.readYaml = exports.promptUser = exports.saveBundle = exports.dumpBundle = exports.CircularJSONNotSupportedError = exports.langToExt = exports.escapeLanguageName = exports.pathToFilename = exports.printExecutionTime = exports.getExecutionTime = exports.getFallbackApisOrExit = void 0;
+exports.HandledError = exports.CircularJSONNotSupportedError = void 0;
+exports.getFallbackApisOrExit = getFallbackApisOrExit;
+exports.getExecutionTime = getExecutionTime;
+exports.printExecutionTime = printExecutionTime;
+exports.pathToFilename = pathToFilename;
+exports.escapeLanguageName = escapeLanguageName;
+exports.langToExt = langToExt;
+exports.dumpBundle = dumpBundle;
+exports.saveBundle = saveBundle;
+exports.promptUser = promptUser;
+exports.readYaml = readYaml;
+exports.writeToFileByExtension = writeToFileByExtension;
+exports.writeYaml = writeYaml;
+exports.writeJson = writeJson;
+exports.getAndValidateFileExtension = getAndValidateFileExtension;
+exports.pluralize = pluralize;
+exports.handleError = handleError;
+exports.printLintTotals = printLintTotals;
+exports.printConfigLintTotals = printConfigLintTotals;
+exports.getOutputFileName = getOutputFileName;
+exports.printUnusedWarnings = printUnusedWarnings;
+exports.exitWithError = exitWithError;
+exports.isSubdir = isSubdir;
+exports.loadConfigAndHandleErrors = loadConfigAndHandleErrors;
+exports.sortTopLevelKeysForOas = sortTopLevelKeysForOas;
+exports.checkIfRulesetExist = checkIfRulesetExist;
+exports.cleanColors = cleanColors;
+exports.sendTelemetry = sendTelemetry;
+exports.cleanArgs = cleanArgs;
+exports.cleanRawInput = cleanRawInput;
+exports.checkForDeprecatedOptions = checkForDeprecatedOptions;
+exports.notifyAboutIncompatibleConfigOptions = notifyAboutIncompatibleConfigOptions;
 const pluralizeOne = require("pluralize");
 const path_1 = require("path");
 const colorette_1 = require("colorette");
@@ -39,24 +50,21 @@ const types_1 = require("../types");
 const update_version_notifier_1 = require("./update-version-notifier");
 const push_1 = require("../commands/push");
 const fetch_with_timeout_1 = require("./fetch-with-timeout");
-function getFallbackApisOrExit(argsApis, config) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const { apis } = config;
-        const shouldFallbackToAllDefinitions = !isNotEmptyArray(argsApis) && apis && Object.keys(apis).length > 0;
-        const res = shouldFallbackToAllDefinitions
-            ? fallbackToAllDefinitions(apis, config)
-            : yield expandGlobsInEntrypoints(argsApis, config);
-        const filteredInvalidEntrypoints = res.filter(({ path }) => !isApiPathValid(path));
-        if (isNotEmptyArray(filteredInvalidEntrypoints)) {
-            for (const { path } of filteredInvalidEntrypoints) {
-                process.stderr.write((0, colorette_1.yellow)(`\n${(0, path_1.relative)(process.cwd(), path)} ${(0, colorette_1.red)(`does not exist or is invalid.\n\n`)}`));
-            }
-            exitWithError('Please provide a valid path.');
+async function getFallbackApisOrExit(argsApis, config) {
+    const { apis } = config;
+    const shouldFallbackToAllDefinitions = !isNotEmptyArray(argsApis) && apis && Object.keys(apis).length > 0;
+    const res = shouldFallbackToAllDefinitions
+        ? fallbackToAllDefinitions(apis, config)
+        : await expandGlobsInEntrypoints(argsApis, config);
+    const filteredInvalidEntrypoints = res.filter(({ path }) => !isApiPathValid(path));
+    if (isNotEmptyArray(filteredInvalidEntrypoints)) {
+        for (const { path } of filteredInvalidEntrypoints) {
+            process.stderr.write((0, colorette_1.yellow)(`\n${(0, path_1.relative)(process.cwd(), path)} ${(0, colorette_1.red)(`does not exist or is invalid.\n\n`)}`));
         }
-        return res;
-    });
+        exitWithError('Please provide a valid path.');
+    }
+    return res;
 }
-exports.getFallbackApisOrExit = getFallbackApisOrExit;
 function getConfigDirectory(config) {
     return config.configFile ? (0, path_1.dirname)(config.configFile) : process.cwd();
 }
@@ -77,37 +85,32 @@ function fallbackToAllDefinitions(apis, config) {
     }));
 }
 function getAliasOrPath(config, aliasOrPath) {
-    var _a, _b, _c;
     return config.apis[aliasOrPath]
-        ? { path: (_a = config.apis[aliasOrPath]) === null || _a === void 0 ? void 0 : _a.root, alias: aliasOrPath }
+        ? { path: config.apis[aliasOrPath]?.root, alias: aliasOrPath }
         : {
             path: aliasOrPath,
             // find alias by path, take the first match
-            alias: (_c = (_b = Object.entries(config.apis).find(([_alias, api]) => {
+            alias: Object.entries(config.apis).find(([_alias, api]) => {
                 return (0, path_1.resolve)(api.root) === (0, path_1.resolve)(aliasOrPath);
-            })) === null || _b === void 0 ? void 0 : _b[0]) !== null && _c !== void 0 ? _c : undefined,
+            })?.[0] ?? undefined,
         };
 }
-function expandGlobsInEntrypoints(args, config) {
-    return __awaiter(this, void 0, void 0, function* () {
-        return (yield Promise.all(args.map((aliasOrPath) => __awaiter(this, void 0, void 0, function* () {
-            return glob.hasMagic(aliasOrPath) && !(0, openapi_core_1.isAbsoluteUrl)(aliasOrPath)
-                ? (yield (0, util_1.promisify)(glob)(aliasOrPath)).map((g) => getAliasOrPath(config, g))
-                : getAliasOrPath(config, aliasOrPath);
-        })))).flat();
-    });
+async function expandGlobsInEntrypoints(args, config) {
+    return (await Promise.all(args.map(async (aliasOrPath) => {
+        return glob.hasMagic(aliasOrPath) && !(0, openapi_core_1.isAbsoluteUrl)(aliasOrPath)
+            ? (await (0, util_1.promisify)(glob)(aliasOrPath)).map((g) => getAliasOrPath(config, g))
+            : getAliasOrPath(config, aliasOrPath);
+    }))).flat();
 }
 function getExecutionTime(startedAt) {
     return process.env.NODE_ENV === 'test'
         ? '<test>ms'
         : `${Math.ceil(perf_hooks_1.performance.now() - startedAt)}ms`;
 }
-exports.getExecutionTime = getExecutionTime;
 function printExecutionTime(commandName, startedAt, api) {
     const elapsed = getExecutionTime(startedAt);
     process.stderr.write((0, colorette_1.gray)(`\n${api}: ${commandName} processed in ${elapsed}\n\n`));
 }
-exports.printExecutionTime = printExecutionTime;
 function pathToFilename(path, pathSeparator) {
     return path
         .replace(/~1/g, '/')
@@ -115,11 +118,9 @@ function pathToFilename(path, pathSeparator) {
         .replace(/^\//, '')
         .replace(/\//g, pathSeparator);
 }
-exports.pathToFilename = pathToFilename;
 function escapeLanguageName(lang) {
     return lang.replace(/#/g, '_sharp').replace(/\//, '_').replace(/\s/g, '');
 }
-exports.escapeLanguageName = escapeLanguageName;
 function langToExt(lang) {
     const langObj = {
         php: '.php',
@@ -151,7 +152,6 @@ function langToExt(lang) {
     };
     return langObj[lang.toLowerCase()];
 }
-exports.langToExt = langToExt;
 class CircularJSONNotSupportedError extends Error {
     constructor(originalError) {
         super(originalError.message);
@@ -180,46 +180,40 @@ function dumpBundle(obj, format, dereference) {
         });
     }
 }
-exports.dumpBundle = dumpBundle;
 function saveBundle(filename, output) {
     fs.mkdirSync((0, path_1.dirname)(filename), { recursive: true });
     fs.writeFileSync(filename, output);
 }
-exports.saveBundle = saveBundle;
-function promptUser(query, hideUserInput = false) {
-    return __awaiter(this, void 0, void 0, function* () {
-        return new Promise((resolve) => {
-            let output = process.stdout;
-            let isOutputMuted = false;
-            if (hideUserInput) {
-                output = new stream_1.Writable({
-                    write: (chunk, encoding, callback) => {
-                        if (!isOutputMuted) {
-                            process.stdout.write(chunk, encoding);
-                        }
-                        callback();
-                    },
-                });
-            }
-            const rl = readline.createInterface({
-                input: process.stdin,
-                output,
-                terminal: true,
-                historySize: hideUserInput ? 0 : 30,
-            });
-            rl.question(`${query}:\n\n  `, (answer) => {
-                rl.close();
-                resolve(answer);
+async function promptUser(query, hideUserInput = false) {
+    return new Promise((resolve) => {
+        let output = process.stdout;
+        let isOutputMuted = false;
+        if (hideUserInput) {
+            output = new stream_1.Writable({
+                write: (chunk, encoding, callback) => {
+                    if (!isOutputMuted) {
+                        process.stdout.write(chunk, encoding);
+                    }
+                    callback();
+                },
             });
-            isOutputMuted = hideUserInput;
+        }
+        const rl = readline.createInterface({
+            input: process.stdin,
+            output,
+            terminal: true,
+            historySize: hideUserInput ? 0 : 30,
         });
+        rl.question(`${query}:\n\n  `, (answer) => {
+            rl.close();
+            resolve(answer);
+        });
+        isOutputMuted = hideUserInput;
     });
 }
-exports.promptUser = promptUser;
 function readYaml(filename) {
     return (0, openapi_core_1.parseYaml)(fs.readFileSync(filename, 'utf-8'), { filename });
 }
-exports.readYaml = readYaml;
 function writeToFileByExtension(data, filePath, noRefs) {
     const ext = getAndValidateFileExtension(filePath);
     if (ext === 'json') {
@@ -228,7 +222,6 @@ function writeToFileByExtension(data, filePath, noRefs) {
     }
     writeYaml(data, filePath, noRefs);
 }
-exports.writeToFileByExtension = writeToFileByExtension;
 function writeYaml(data, filename, noRefs = false) {
     const content = (0, openapi_core_1.stringifyYaml)(data, { noRefs });
     if (process.env.NODE_ENV === 'test') {
@@ -238,7 +231,6 @@ function writeYaml(data, filename, noRefs = false) {
     fs.mkdirSync((0, path_1.dirname)(filename), { recursive: true });
     fs.writeFileSync(filename, content);
 }
-exports.writeYaml = writeYaml;
 function writeJson(data, filename) {
     const content = JSON.stringify(data, null, 2);
     if (process.env.NODE_ENV === 'test') {
@@ -248,7 +240,6 @@ function writeJson(data, filename) {
     fs.mkdirSync((0, path_1.dirname)(filename), { recursive: true });
     fs.writeFileSync(filename, content);
 }
-exports.writeJson = writeJson;
 function getAndValidateFileExtension(fileName) {
     const ext = fileName.split('.').pop();
     if (['yaml', 'yml', 'json'].includes(ext)) {
@@ -257,16 +248,13 @@ function getAndValidateFileExtension(fileName) {
     process.stderr.write((0, colorette_1.yellow)(`Unsupported file extension: ${ext}. Using yaml.\n`));
     return 'yaml';
 }
-exports.getAndValidateFileExtension = getAndValidateFileExtension;
 function pluralize(sentence, count, inclusive) {
     return sentence
         .split(' ')
         .map((word) => pluralizeOne(word, count, inclusive))
         .join(' ');
 }
-exports.pluralize = pluralize;
 function handleError(e, ref) {
-    var _a, _b;
     switch (e.constructor) {
         case HandledError: {
             throw e;
@@ -280,7 +268,7 @@ function handleError(e, ref) {
                 `Try to use ${(0, colorette_1.blue)('yaml')} output or remove ${(0, colorette_1.blue)('--dereferenced')}.`);
         }
         case SyntaxError:
-            return exitWithError(`Syntax error: ${e.message} ${(_b = (_a = e.stack) === null || _a === void 0 ? void 0 : _a.split('\n\n')) === null || _b === void 0 ? void 0 : _b[0]}`);
+            return exitWithError(`Syntax error: ${e.message} ${e.stack?.split('\n\n')?.[0]}`);
         case config_1.ConfigValidationError:
             return exitWithError(e.message);
         default: {
@@ -288,7 +276,6 @@ function handleError(e, ref) {
         }
     }
 }
-exports.handleError = handleError;
 class HandledError extends Error {
 }
 exports.HandledError = HandledError;
@@ -313,7 +300,6 @@ function printLintTotals(totals, definitionsCount) {
     }
     process.stderr.write('\n');
 }
-exports.printLintTotals = printLintTotals;
 function printConfigLintTotals(totals, command) {
     if (totals.errors > 0) {
         process.stderr.write((0, colorette_1.red)(`❌ Your config has ${totals.errors} ${pluralize('error', totals.errors)}.`));
@@ -325,7 +311,6 @@ function printConfigLintTotals(totals, command) {
         process.stderr.write((0, colorette_1.green)('✅  Your config is valid.\n'));
     }
 }
-exports.printConfigLintTotals = printConfigLintTotals;
 function getOutputFileName(entrypoint, entries, output, ext) {
     if (!output) {
         return { outputFile: 'stdout', ext: ext || 'yaml' };
@@ -350,7 +335,6 @@ function getOutputFileName(entrypoint, entries, output, ext) {
     }
     return { outputFile, ext };
 }
-exports.getOutputFileName = getOutputFileName;
 function printUnusedWarnings(config) {
     const { preprocessors, rules, decorators } = config.getUnusedRules();
     if (rules.length) {
@@ -366,12 +350,10 @@ function printUnusedWarnings(config) {
         process.stderr.write(`Check the spelling and verify the added plugin prefix.\n`);
     }
 }
-exports.printUnusedWarnings = printUnusedWarnings;
 function exitWithError(message) {
     process.stderr.write((0, colorette_1.red)(message) + '\n\n');
     throw new HandledError(message);
 }
-exports.exitWithError = exitWithError;
 /**
  * Checks if dir is subdir of parent
  */
@@ -379,25 +361,20 @@ function isSubdir(parent, dir) {
     const relativePath = (0, path_1.relative)(parent, dir);
     return !!relativePath && !/^..($|\/)/.test(relativePath) && !(0, path_1.isAbsolute)(relativePath);
 }
-exports.isSubdir = isSubdir;
-function loadConfigAndHandleErrors(options = {}) {
-    return __awaiter(this, void 0, void 0, function* () {
-        try {
-            return yield (0, openapi_core_1.loadConfig)(options);
-        }
-        catch (e) {
-            handleError(e, '');
-        }
-    });
+async function loadConfigAndHandleErrors(options = {}) {
+    try {
+        return await (0, openapi_core_1.loadConfig)(options);
+    }
+    catch (e) {
+        handleError(e, '');
+    }
 }
-exports.loadConfigAndHandleErrors = loadConfigAndHandleErrors;
 function sortTopLevelKeysForOas(document) {
     if ('swagger' in document) {
         return sortOas2Keys(document);
     }
     return sortOas3Keys(document);
 }
-exports.sortTopLevelKeysForOas = sortTopLevelKeysForOas;
 function sortOas2Keys(document) {
     const orderedKeys = [
         'swagger',
@@ -449,56 +426,61 @@ function sortOas3Keys(document) {
     return Object.assign(result, document);
 }
 function checkIfRulesetExist(rules) {
-    const ruleset = Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, rules.oas2), rules.oas3_0), rules.oas3_1), rules.async2), rules.arazzo);
+    const ruleset = {
+        ...rules.oas2,
+        ...rules.oas3_0,
+        ...rules.oas3_1,
+        ...rules.async2,
+        ...rules.async3,
+        ...rules.arazzo,
+    };
     if ((0, utils_1.isEmptyObject)(ruleset)) {
         exitWithError('⚠️ No rules were configured. Learn how to configure rules: https://redocly.com/docs/cli/rules/');
     }
 }
-exports.checkIfRulesetExist = checkIfRulesetExist;
 function cleanColors(input) {
     // eslint-disable-next-line no-control-regex
     return input.replace(/\x1b\[\d+m/g, '');
 }
-exports.cleanColors = cleanColors;
-function sendTelemetry(argv, exit_code, has_config) {
-    return __awaiter(this, void 0, void 0, function* () {
-        try {
-            if (!argv) {
-                return;
-            }
-            const { _: [command], $0: _ } = argv, args = __rest(argv, ["_", "$0"]);
-            const event_time = new Date().toISOString();
-            const redoclyClient = new openapi_core_1.RedoclyClient();
-            const logged_in = redoclyClient.hasTokens();
-            const data = {
-                event: 'cli_command',
-                event_time,
-                logged_in,
-                command,
-                arguments: cleanArgs(args),
-                node_version: process.version,
-                npm_version: (0, child_process_1.execSync)('npm -v').toString().replace('\n', ''),
-                version: update_version_notifier_1.version,
-                exit_code,
-                environment: process.env.REDOCLY_ENVIRONMENT,
-                environment_ci: process.env.CI,
-                raw_input: cleanRawInput(process.argv.slice(2)),
-                has_config,
-            };
-            yield (0, fetch_with_timeout_1.default)(`https://api.redocly.com/registry/telemetry/cli`, {
-                method: 'POST',
-                headers: {
-                    'content-type': 'application/json',
-                },
-                body: JSON.stringify(data),
-            });
+async function sendTelemetry(argv, exit_code, has_config, spec_version, spec_keyword, spec_full_version) {
+    try {
+        if (!argv) {
+            return;
         }
-        catch (err) {
-            // Do nothing.
-        }
-    });
+        const { _: [command], $0: _, ...args } = argv;
+        const event_time = new Date().toISOString();
+        const redoclyClient = new openapi_core_1.RedoclyClient();
+        const logged_in = redoclyClient.hasTokens();
+        const data = {
+            event: 'cli_command',
+            event_time,
+            logged_in,
+            command,
+            arguments: cleanArgs(args),
+            node_version: process.version,
+            npm_version: (0, child_process_1.execSync)('npm -v').toString().replace('\n', ''),
+            version: update_version_notifier_1.version,
+            exit_code,
+            environment: process.env.REDOCLY_ENVIRONMENT,
+            environment_ci: process.env.CI,
+            raw_input: cleanRawInput(process.argv.slice(2)),
+            has_config,
+            spec_version,
+            spec_keyword,
+            spec_full_version,
+        };
+        await (0, fetch_with_timeout_1.default)(`https://api.redocly.com/registry/telemetry/cli`, {
+            method: 'POST',
+            headers: {
+                'content-type': 'application/json',
+            },
+            body: JSON.stringify(data),
+        });
+    }
+    catch (err) {
+        // Do nothing.
+    }
 }
-exports.sendTelemetry = sendTelemetry;
 function isFile(value) {
     return fs.existsSync(value) && fs.statSync(value).isFile();
 }
@@ -542,11 +524,9 @@ function cleanArgs(args) {
     }
     return result;
 }
-exports.cleanArgs = cleanArgs;
 function cleanRawInput(argv) {
     return argv.map((entry) => entry.split('=').map(cleanString).join('=')).join(' ');
 }
-exports.cleanRawInput = cleanRawInput;
 function checkForDeprecatedOptions(argv, deprecatedOptions) {
     for (const option of deprecatedOptions) {
         if (argv[option]) {
@@ -554,7 +534,6 @@ function checkForDeprecatedOptions(argv, deprecatedOptions) {
         }
     }
 }
-exports.checkForDeprecatedOptions = checkForDeprecatedOptions;
 function notifyAboutIncompatibleConfigOptions(themeOpenapiOptions) {
     if ((0, utils_1.isPlainObject)(themeOpenapiOptions)) {
         const propertiesSet = Object.keys(themeOpenapiOptions);
@@ -565,4 +544,3 @@ function notifyAboutIncompatibleConfigOptions(themeOpenapiOptions) {
         }
     }
 }
-exports.notifyAboutIncompatibleConfigOptions = notifyAboutIncompatibleConfigOptions;

package/lib/utils/update-version-notifier.js

@@ -1,13 +1,4 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.cacheLatestVersion = exports.notifyUpdateCliVersion = exports.name = exports.version = void 0;
@@ -39,14 +30,14 @@ const notifyUpdateCliVersion = () => {
 };
 exports.notifyUpdateCliVersion = notifyUpdateCliVersion;
 const isNewVersionAvailable = (current, latest) => (0, semver_1.compare)(current, latest) < 0;
-const getLatestVersion = (packageName) => __awaiter(void 0, void 0, void 0, function* () {
+const getLatestVersion = async (packageName) => {
     const latestUrl = `http://registry.npmjs.org/${packageName}/latest`;
-    const response = yield (0, fetch_with_timeout_1.default)(latestUrl);
+    const response = await (0, fetch_with_timeout_1.default)(latestUrl);
     if (!response)
         return;
-    const info = yield response.json();
+    const info = await response.json();
     return info.version;
-});
+};
 const cacheLatestVersion = () => {
     if (!isNeedToBeCached() || SHOULD_NOT_NOTIFY) {
         return;

package/lib/wrapper.d.ts

@@ -1,4 +1,11 @@
-import { Config } from '@redocly/openapi-core';
 import type { Arguments } from 'yargs';
+import type { Config } from '@redocly/openapi-core';
+import type { CollectFn } from '@redocly/openapi-core/lib/utils';
 import type { CommandOptions } from './types';
-export declare function commandWrapper<T extends CommandOptions>(commandHandler?: (argv: T, config: Config, version: string) => Promise<unknown>): (argv: Arguments<T>) => Promise<void>;
+export type CommandArgs<T extends CommandOptions> = {
+    argv: T;
+    config: Config;
+    version: string;
+    collectSpecData?: CollectFn;
+};
+export declare function commandWrapper<T extends CommandOptions>(commandHandler?: (wrapperArgs: CommandArgs<T>) => Promise<unknown>): (argv: Arguments<T>) => Promise<void>;

package/lib/wrapper.js

@@ -1,29 +1,41 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.commandWrapper = void 0;
+exports.commandWrapper = commandWrapper;
 const openapi_core_1 = require("@redocly/openapi-core");
+const utils_1 = require("@redocly/openapi-core/lib/utils");
 const update_version_notifier_1 = require("./utils/update-version-notifier");
 const miscellaneous_1 = require("./utils/miscellaneous");
 const lint_1 = require("./commands/lint");
 function commandWrapper(commandHandler) {
-    return (argv) => __awaiter(this, void 0, void 0, function* () {
+    return async (argv) => {
         let code = 2;
         let hasConfig;
         let telemetry;
+        let specVersion;
+        let specKeyword;
+        let specFullVersion;
+        const collectSpecData = (document) => {
+            specVersion = (0, openapi_core_1.detectSpec)(document);
+            if (!(0, utils_1.isPlainObject)(document))
+                return;
+            specKeyword = document?.openapi
+                ? 'openapi'
+                : document?.swagger
+                    ? 'swagger'
+                    : document?.asyncapi
+                        ? 'asyncapi'
+                        : document?.arazzo
+                            ? 'arazzo'
+                            : undefined;
+            if (specKeyword) {
+                specFullVersion = document[specKeyword];
+            }
+        };
         try {
             if (argv.config && !(0, openapi_core_1.doesYamlFileExist)(argv.config)) {
                 (0, miscellaneous_1.exitWithError)('Please provide a valid path to the configuration file.');
             }
-            const config = (yield (0, miscellaneous_1.loadConfigAndHandleErrors)({
+            const config = (await (0, miscellaneous_1.loadConfigAndHandleErrors)({
                 configPath: argv.config,
                 customExtends: argv.extends,
                 region: argv.region,
@@ -34,7 +46,7 @@ function commandWrapper(commandHandler) {
             hasConfig = !config.styleguide.recommendedFallback;
             code = 1;
             if (typeof commandHandler === 'function') {
-                yield commandHandler(argv, config, update_version_notifier_1.version);
+                await commandHandler({ argv, config, version: update_version_notifier_1.version, collectSpecData });
             }
             code = 0;
         }
@@ -43,12 +55,11 @@ function commandWrapper(commandHandler) {
         }
         finally {
             if (process.env.REDOCLY_TELEMETRY !== 'off' && telemetry !== 'off') {
-                yield (0, miscellaneous_1.sendTelemetry)(argv, code, hasConfig);
+                await (0, miscellaneous_1.sendTelemetry)(argv, code, hasConfig, specVersion, specKeyword, specFullVersion);
             }
             process.once('beforeExit', () => {
                 process.exit(code);
             });
         }
-    });
+    };
 }
-exports.commandWrapper = commandWrapper;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/cli",
-  "version": "1.18.1",
+  "version": "1.20.0",
   "description": "",
   "license": "MIT",
   "bin": {
@@ -36,7 +36,7 @@
     "Roman Hotsiy <roman@redoc.ly> (https://redoc.ly/)"
   ],
   "dependencies": {
-    "@redocly/openapi-core": "1.18.1",
+    "@redocly/openapi-core": "1.20.0",
     "abort-controller": "^3.0.0",
     "chokidar": "^3.5.1",
     "colorette": "^1.2.0",
@@ -64,6 +64,6 @@
     "@types/react-dom": "^17.0.0 || ^18.2.7",
     "@types/semver": "^7.5.0",
     "@types/yargs": "17.0.32",
-    "typescript": "^5.2.2"
+    "typescript": "5.5.3"
   }
 }

package/src/__mocks__/@redocly/openapi-core.ts

@@ -73,6 +73,7 @@ export enum SpecVersion {
   OAS3_0 = 'oas3_0',
   OAS3_1 = 'oas3_1',
   Async2 = 'async2',
+  Async3 = 'async3',
 }
 
 export enum Oas3Operations {

package/src/__tests__/commands/build-docs.test.ts

@@ -39,8 +39,8 @@ describe('build-docs', () => {
 
   it('should work correctly when calling handlerBuildCommand', async () => {
     const processExitMock = jest.spyOn(process, 'exit').mockImplementation();
-    await handlerBuildCommand(
-      {
+    await handlerBuildCommand({
+      argv: {
         o: '',
         title: 'test',
         disableGoogleFont: false,
@@ -49,8 +49,9 @@ describe('build-docs', () => {
         theme: { openapi: {} },
         api: '../some-path/openapi.yaml',
       } as BuildDocsArgv,
-      {} as any
-    );
+      config: {} as any,
+      version: 'cli-version',
+    });
     expect(loadAndBundleSpec).toBeCalledTimes(1);
     expect(getFallbackApisOrExit).toBeCalledTimes(1);
     expect(processExitMock).toBeCalledTimes(0);