@redocly/cli 1.3.0 → 1.4.0

package/lib/commands/join.js

@@ -26,18 +26,19 @@ function handleJoin(argv, config, packageVersion) {
     return __awaiter(this, void 0, void 0, function* () {
         const startedAt = perf_hooks_1.performance.now();
         if (argv.apis.length < 2) {
-            return utils_1.exitWithError(`At least 2 apis should be provided. \n\n`);
+            return (0, utils_1.exitWithError)(`At least 2 apis should be provided. \n\n`);
         }
-        const { 'prefix-components-with-info-prop': prefixComponentsWithInfoProp, 'prefix-tags-with-filename': prefixTagsWithFilename, 'prefix-tags-with-info-prop': prefixTagsWithInfoProp, 'without-x-tag-groups': withoutXTagGroups, output: specFilename = 'openapi.yaml', } = argv;
+        const fileExtension = (0, utils_1.getAndValidateFileExtension)(argv.output || argv.apis[0]);
+        const { 'prefix-components-with-info-prop': prefixComponentsWithInfoProp, 'prefix-tags-with-filename': prefixTagsWithFilename, 'prefix-tags-with-info-prop': prefixTagsWithInfoProp, 'without-x-tag-groups': withoutXTagGroups, output: specFilename = `openapi.${fileExtension}`, } = argv;
         const usedTagsOptions = [
             prefixTagsWithFilename && 'prefix-tags-with-filename',
             prefixTagsWithInfoProp && 'prefix-tags-with-info-prop',
             withoutXTagGroups && 'without-x-tag-groups',
         ].filter(Boolean);
         if (usedTagsOptions.length > 1) {
-            return utils_1.exitWithError(`You use ${colorette_1.yellow(usedTagsOptions.join(', '))} together.\nPlease choose only one! \n\n`);
+            return (0, utils_1.exitWithError)(`You use ${(0, colorette_1.yellow)(usedTagsOptions.join(', '))} together.\nPlease choose only one! \n\n`);
         }
-        const apis = yield utils_1.getFallbackApisOrExit(argv.apis, config);
+        const apis = yield (0, utils_1.getFallbackApisOrExit)(argv.apis, config);
         const externalRefResolver = new openapi_core_1.BaseResolver(config.resolve);
         const documents = yield Promise.all(apis.map(({ path }) => externalRefResolver.resolveDocument(null, path, true)));
         if (!argv.decorate) {
@@ -56,37 +57,37 @@ function handleJoin(argv, config, packageVersion) {
             ]);
             config.styleguide.skipPreprocessors(Array.from(preprocessors));
         }
-        const bundleResults = yield Promise.all(documents.map((document) => openapi_core_1.bundleDocument({
+        const bundleResults = yield Promise.all(documents.map((document) => (0, openapi_core_1.bundleDocument)({
             document,
             config: config.styleguide,
             externalRefResolver: new openapi_core_1.BaseResolver(config.resolve),
         }).catch((e) => {
-            utils_1.exitWithError(`${e.message}: ${colorette_1.blue(document.source.absoluteRef)}`);
+            (0, utils_1.exitWithError)(`${e.message}: ${(0, colorette_1.blue)(document.source.absoluteRef)}`);
         })));
         for (const { problems, bundle: document } of bundleResults) {
-            const fileTotals = openapi_core_1.getTotals(problems);
+            const fileTotals = (0, openapi_core_1.getTotals)(problems);
             if (fileTotals.errors) {
-                openapi_core_1.formatProblems(problems, {
+                (0, openapi_core_1.formatProblems)(problems, {
                     totals: fileTotals,
                     version: document.parsed.version,
                 });
-                utils_1.exitWithError(`❌ Errors encountered while bundling ${colorette_1.blue(document.source.absoluteRef)}: join will not proceed.\n`);
+                (0, utils_1.exitWithError)(`❌ Errors encountered while bundling ${(0, colorette_1.blue)(document.source.absoluteRef)}: join will not proceed.\n`);
             }
         }
         let oasVersion = null;
         for (const document of documents) {
             try {
-                const version = openapi_core_1.detectSpec(document.parsed);
+                const version = (0, openapi_core_1.detectSpec)(document.parsed);
                 if (version !== openapi_core_1.SpecVersion.OAS3_0 && version !== openapi_core_1.SpecVersion.OAS3_1) {
-                    return utils_1.exitWithError(`Only OpenAPI 3.0 and OpenAPI 3.1 are supported: ${colorette_1.blue(document.source.absoluteRef)} \n\n`);
+                    return (0, utils_1.exitWithError)(`Only OpenAPI 3.0 and OpenAPI 3.1 are supported: ${(0, colorette_1.blue)(document.source.absoluteRef)} \n\n`);
                 }
                 oasVersion = oasVersion !== null && oasVersion !== void 0 ? oasVersion : version;
                 if (oasVersion !== version) {
-                    return utils_1.exitWithError(`All APIs must use the same OpenAPI version: ${colorette_1.blue(document.source.absoluteRef)} \n\n`);
+                    return (0, utils_1.exitWithError)(`All APIs must use the same OpenAPI version: ${(0, colorette_1.blue)(document.source.absoluteRef)} \n\n`);
                 }
             }
             catch (e) {
-                return utils_1.exitWithError(`${e.message}: ${colorette_1.blue(document.source.absoluteRef)}`);
+                return (0, utils_1.exitWithError)(`${e.message}: ${(0, colorette_1.blue)(document.source.absoluteRef)}`);
             }
         }
         if (argv.lint) {
@@ -112,7 +113,7 @@ function handleJoin(argv, config, packageVersion) {
                 : getInfoPrefix(info, prefixTagsWithInfoProp, 'tags');
             const componentsPrefix = getInfoPrefix(info, prefixComponentsWithInfoProp, COMPONENTS);
             if (openapi.hasOwnProperty('x-tagGroups')) {
-                process.stderr.write(colorette_1.yellow(`warning: x-tagGroups at ${colorette_1.blue(api)} will be skipped \n`));
+                process.stderr.write((0, colorette_1.yellow)(`warning: x-tagGroups at ${(0, colorette_1.blue)(api)} will be skipped \n`));
             }
             const context = {
                 api,
@@ -138,10 +139,10 @@ function handleJoin(argv, config, packageVersion) {
         iteratePotentialConflicts(potentialConflicts, withoutXTagGroups);
         const noRefs = true;
         if (potentialConflictsTotal) {
-            return utils_1.exitWithError(`Please fix conflicts before running ${colorette_1.yellow('join')}.`);
+            return (0, utils_1.exitWithError)(`Please fix conflicts before running ${(0, colorette_1.yellow)('join')}.`);
         }
-        utils_1.writeYaml(utils_1.sortTopLevelKeysForOas(joinedDef), specFilename, noRefs);
-        utils_1.printExecutionTime('join', startedAt, specFilename);
+        (0, utils_1.writeToFileByExtension)((0, utils_1.sortTopLevelKeysForOas)(joinedDef), specFilename, noRefs);
+        (0, utils_1.printExecutionTime)('join', startedAt, specFilename);
         function populateTags({ api, apiFilename, tags, potentialConflicts, tagsPrefix, componentsPrefix, }) {
             if (!joinedDef.hasOwnProperty(Tags)) {
                 joinedDef[Tags] = [];
@@ -237,7 +238,7 @@ function handleJoin(argv, config, packageVersion) {
             const { externalDocs } = openapi;
             if (externalDocs) {
                 if (joinedDef.hasOwnProperty('externalDocs')) {
-                    process.stderr.write(colorette_1.yellow(`warning: skip externalDocs from ${colorette_1.blue(path.basename(api))} \n`));
+                    process.stderr.write((0, colorette_1.yellow)(`warning: skip externalDocs from ${(0, colorette_1.blue)(path.basename(api))} \n`));
                     return;
                 }
                 joinedDef['externalDocs'] = externalDocs;
@@ -245,12 +246,12 @@ function handleJoin(argv, config, packageVersion) {
         }
         function collectPaths(openapi, { apiFilename, api, potentialConflicts, tagsPrefix, componentsPrefix }) {
             const { paths } = openapi;
-            const operationsSet = new Set(js_utils_1.keysOf(types_1.OPENAPI3_METHOD));
+            const operationsSet = new Set((0, js_utils_1.keysOf)(types_1.OPENAPI3_METHOD));
             if (paths) {
                 if (!joinedDef.hasOwnProperty('paths')) {
                     joinedDef['paths'] = {};
                 }
-                for (const path of js_utils_1.keysOf(paths)) {
+                for (const path of (0, js_utils_1.keysOf)(paths)) {
                     if (!joinedDef.paths.hasOwnProperty(path)) {
                         joinedDef.paths[path] = {};
                     }
@@ -258,7 +259,7 @@ function handleJoin(argv, config, packageVersion) {
                         potentialConflicts.paths[path] = {};
                     }
                     const pathItem = paths[path];
-                    for (const field of js_utils_1.keysOf(pathItem)) {
+                    for (const field of (0, js_utils_1.keysOf)(pathItem)) {
                         if (operationsSet.has(field)) {
                             collectPathOperation(pathItem, path, field);
                         }
@@ -278,7 +279,7 @@ function handleJoin(argv, config, packageVersion) {
                 const fieldValue = pathItem[field];
                 if (joinedDef.paths[path].hasOwnProperty(field) &&
                     joinedDef.paths[path][field] !== fieldValue) {
-                    process.stderr.write(colorette_1.yellow(`warning: different ${field} values in ${path}\n`));
+                    process.stderr.write((0, colorette_1.yellow)(`warning: different ${field} values in ${path}\n`));
                     return;
                 }
                 joinedDef.paths[path][field] = fieldValue;
@@ -295,7 +296,7 @@ function handleJoin(argv, config, packageVersion) {
                     for (const pathServer of joinedDef.paths[path].servers) {
                         if (pathServer.url === server.url) {
                             if (!isServersEqual(pathServer, server)) {
-                                utils_1.exitWithError(`Different server values for (${server.url}) in ${path}`);
+                                (0, utils_1.exitWithError)(`Different server values for (${server.url}) in ${path}`);
                             }
                             isFoundServer = true;
                         }
@@ -317,16 +318,16 @@ function handleJoin(argv, config, packageVersion) {
                     for (const pathParameter of joinedDef.paths[path]
                         .parameters) {
                         // Compare $ref only if both are reference objects
-                        if (openapi_core_1.isRef(pathParameter) && openapi_core_1.isRef(parameter)) {
+                        if ((0, openapi_core_1.isRef)(pathParameter) && (0, openapi_core_1.isRef)(parameter)) {
                             if (pathParameter['$ref'] === parameter['$ref']) {
                                 isFoundParameter = true;
                             }
                         }
                         // Compare properties only if both are reference objects
-                        if (!openapi_core_1.isRef(pathParameter) && !openapi_core_1.isRef(parameter)) {
+                        if (!(0, openapi_core_1.isRef)(pathParameter) && !(0, openapi_core_1.isRef)(parameter)) {
                             if (pathParameter.name === parameter.name && pathParameter.in === parameter.in) {
                                 if (!isEqual(pathParameter.schema, parameter.schema)) {
-                                    utils_1.exitWithError(`Different parameter schemas for (${parameter.name}) in ${path}`);
+                                    (0, utils_1.exitWithError)(`Different parameter schemas for (${parameter.name}) in ${path}`);
                                 }
                                 isFoundParameter = true;
                             }
@@ -457,9 +458,9 @@ function handleJoin(argv, config, packageVersion) {
             const openapi = firstApi.parsed;
             const componentsPrefix = getInfoPrefix(openapi.info, prefixComponentsWithInfoProp, COMPONENTS);
             if (!openapi.openapi)
-                utils_1.exitWithError('Version of specification is not found in. \n');
+                (0, utils_1.exitWithError)('Version of specification is not found in. \n');
             if (!openapi.info)
-                utils_1.exitWithError('Info section is not found in specification. \n');
+                (0, utils_1.exitWithError)('Info section is not found in specification. \n');
             if ((_a = openapi.info) === null || _a === void 0 ? void 0 : _a.description) {
                 openapi.info.description = addComponentsPrefix(openapi.info.description, componentsPrefix);
             }
@@ -491,7 +492,7 @@ function iteratePotentialConflicts(potentialConflicts, withoutXTagGroups) {
                     for (const [_, conflict] of Object.entries(conflicts)) {
                         if (validateComponentsDifference(conflict[1])) {
                             conflict[1] = conflict[1].map((c) => Object.keys(c)[0]);
-                            showConflicts(colorette_1.green(group) + ' => ' + key, [conflict]);
+                            showConflicts((0, colorette_1.green)(group) + ' => ' + key, [conflict]);
                             potentialConflictsTotal += 1;
                         }
                     }
@@ -502,7 +503,7 @@ function iteratePotentialConflicts(potentialConflicts, withoutXTagGroups) {
                     }
                     else {
                         potentialConflictsTotal += conflicts.length;
-                        showConflicts(colorette_1.green(group) + ' => ' + key, conflicts);
+                        showConflicts((0, colorette_1.green)(group) + ' => ' + key, conflicts);
                     }
                 }
                 if (group === 'tags' && !withoutXTagGroups) {
@@ -514,15 +515,15 @@ function iteratePotentialConflicts(potentialConflicts, withoutXTagGroups) {
 }
 function duplicateTagDescriptionWarning(conflicts) {
     const tagsKeys = conflicts.map(([tagName]) => `\`${tagName}\``);
-    const joinString = colorette_1.yellow(', ');
-    process.stderr.write(colorette_1.yellow(`\nwarning: ${tagsKeys.length} conflict(s) on the ${colorette_1.red(tagsKeys.join(joinString))} tags description.\n`));
+    const joinString = (0, colorette_1.yellow)(', ');
+    process.stderr.write((0, colorette_1.yellow)(`\nwarning: ${tagsKeys.length} conflict(s) on the ${(0, colorette_1.red)(tagsKeys.join(joinString))} tags description.\n`));
 }
 function prefixTagSuggestion(conflictsLength) {
-    process.stderr.write(colorette_1.green(`\n${conflictsLength} conflict(s) on tags.\nSuggestion: please use ${colorette_1.blue('prefix-tags-with-filename')}, ${colorette_1.blue('prefix-tags-with-info-prop')} or ${colorette_1.blue('without-x-tag-groups')} to prevent naming conflicts.\n\n`));
+    process.stderr.write((0, colorette_1.green)(`\n${conflictsLength} conflict(s) on tags.\nSuggestion: please use ${(0, colorette_1.blue)('prefix-tags-with-filename')}, ${(0, colorette_1.blue)('prefix-tags-with-info-prop')} or ${(0, colorette_1.blue)('without-x-tag-groups')} to prevent naming conflicts.\n\n`));
 }
 function showConflicts(key, conflicts) {
     for (const [path, files] of conflicts) {
-        process.stderr.write(colorette_1.yellow(`Conflict on ${key} : ${colorette_1.red(path)} in files: ${colorette_1.blue(files)} \n`));
+        process.stderr.write((0, colorette_1.yellow)(`Conflict on ${key} : ${(0, colorette_1.red)(path)} in files: ${(0, colorette_1.blue)(files)} \n`));
     }
 }
 function filterConflicts(entities) {
@@ -555,30 +556,30 @@ function getInfoPrefix(info, prefixArg, type) {
     if (!prefixArg)
         return '';
     if (!info)
-        utils_1.exitWithError('Info section is not found in specification. \n');
+        (0, utils_1.exitWithError)('Info section is not found in specification. \n');
     if (!info[prefixArg])
-        utils_1.exitWithError(`${colorette_1.yellow(`prefix-${type}-with-info-prop`)} argument value is not found in info section. \n`);
-    if (!js_utils_1.isString(info[prefixArg]))
-        utils_1.exitWithError(`${colorette_1.yellow(`prefix-${type}-with-info-prop`)} argument value should be string. \n\n`);
+        (0, utils_1.exitWithError)(`${(0, colorette_1.yellow)(`prefix-${type}-with-info-prop`)} argument value is not found in info section. \n`);
+    if (!(0, js_utils_1.isString)(info[prefixArg]))
+        (0, utils_1.exitWithError)(`${(0, colorette_1.yellow)(`prefix-${type}-with-info-prop`)} argument value should be string. \n\n`);
     if (info[prefixArg].length > 50)
-        utils_1.exitWithError(`${colorette_1.yellow(`prefix-${type}-with-info-prop`)} argument value length should not exceed 50 characters. \n\n`);
+        (0, utils_1.exitWithError)(`${(0, colorette_1.yellow)(`prefix-${type}-with-info-prop`)} argument value length should not exceed 50 characters. \n\n`);
     return info[prefixArg];
 }
 function validateApi(document, config, externalRefResolver, packageVersion) {
     return __awaiter(this, void 0, void 0, function* () {
         try {
-            const results = yield openapi_core_1.lintDocument({ document, config, externalRefResolver });
-            const fileTotals = openapi_core_1.getTotals(results);
-            openapi_core_1.formatProblems(results, { format: 'stylish', totals: fileTotals, version: packageVersion });
-            utils_1.printLintTotals(fileTotals, 2);
+            const results = yield (0, openapi_core_1.lintDocument)({ document, config, externalRefResolver });
+            const fileTotals = (0, openapi_core_1.getTotals)(results);
+            (0, openapi_core_1.formatProblems)(results, { format: 'stylish', totals: fileTotals, version: packageVersion });
+            (0, utils_1.printLintTotals)(fileTotals, 2);
         }
         catch (err) {
-            utils_1.handleError(err, document.parsed);
+            (0, utils_1.handleError)(err, document.parsed);
         }
     });
 }
 function crawl(object, visitor) {
-    if (!js_utils_1.isObject(object))
+    if (!(0, js_utils_1.isObject)(object))
         return;
     for (const key of Object.keys(object)) {
         visitor(object, key);
@@ -587,16 +588,16 @@ function crawl(object, visitor) {
 }
 function replace$Refs(obj, componentsPrefix) {
     crawl(obj, (node) => {
-        if (node.$ref && js_utils_1.isString(node.$ref) && node.$ref.startsWith(`#/${COMPONENTS}/`)) {
+        if (node.$ref && (0, js_utils_1.isString)(node.$ref) && node.$ref.startsWith(`#/${COMPONENTS}/`)) {
             const name = path.basename(node.$ref);
             node.$ref = node.$ref.replace(name, componentsPrefix + '_' + name);
         }
         else if (node.discriminator &&
             node.discriminator.mapping &&
-            js_utils_1.isObject(node.discriminator.mapping)) {
+            (0, js_utils_1.isObject)(node.discriminator.mapping)) {
             const { mapping } = node.discriminator;
             for (const name of Object.keys(mapping)) {
-                if (js_utils_1.isString(mapping[name]) && mapping[name].startsWith(`#/${COMPONENTS}/`)) {
+                if ((0, js_utils_1.isString)(mapping[name]) && mapping[name].startsWith(`#/${COMPONENTS}/`)) {
                     mapping[name] = mapping[name]
                         .split('/')
                         .map((name, i, arr) => {

package/lib/commands/lint.d.ts

@@ -1,7 +1,7 @@
 import { Config } from '@redocly/openapi-core';
 import type { OutputFormat, RawConfig, RuleSeverity } from '@redocly/openapi-core';
 import type { CommandOptions, Skips } from '../types';
-export declare type LintOptions = {
+export type LintOptions = {
     apis?: string[];
     'max-problems': number;
     extends?: string[];

package/lib/commands/lint.js

@@ -17,9 +17,9 @@ const colorette_1 = require("colorette");
 const perf_hooks_1 = require("perf_hooks");
 function handleLint(argv, config, version) {
     return __awaiter(this, void 0, void 0, function* () {
-        const apis = yield utils_1.getFallbackApisOrExit(argv.apis, config);
+        const apis = yield (0, utils_1.getFallbackApisOrExit)(argv.apis, config);
         if (!apis.length) {
-            utils_1.exitWithError('No APIs were provided');
+            (0, utils_1.exitWithError)('No APIs were provided');
         }
         if (argv['generate-ignore-file']) {
             config.styleguide.ignore = {}; // clear ignore
@@ -30,20 +30,20 @@ function handleLint(argv, config, version) {
         for (const { path, alias } of apis) {
             try {
                 const startedAt = perf_hooks_1.performance.now();
-                const resolvedConfig = openapi_core_1.getMergedConfig(config, alias);
+                const resolvedConfig = (0, openapi_core_1.getMergedConfig)(config, alias);
                 const { styleguide } = resolvedConfig;
-                utils_1.checkIfRulesetExist(styleguide.rules);
+                (0, utils_1.checkIfRulesetExist)(styleguide.rules);
                 styleguide.skipRules(argv['skip-rule']);
                 styleguide.skipPreprocessors(argv['skip-preprocessor']);
                 if (styleguide.recommendedFallback) {
-                    process.stderr.write(`No configurations were provided -- using built in ${colorette_1.blue('recommended')} configuration by default.\n\n`);
+                    process.stderr.write(`No configurations were provided -- using built in ${(0, colorette_1.blue)('recommended')} configuration by default.\n\n`);
                 }
-                process.stderr.write(colorette_1.gray(`validating ${path.replace(process.cwd(), '')}...\n`));
-                const results = yield openapi_core_1.lint({
+                process.stderr.write((0, colorette_1.gray)(`validating ${path.replace(process.cwd(), '')}...\n`));
+                const results = yield (0, openapi_core_1.lint)({
                     ref: path,
                     config: resolvedConfig,
                 });
-                const fileTotals = openapi_core_1.getTotals(results);
+                const fileTotals = (0, openapi_core_1.getTotals)(results);
                 totals.errors += fileTotals.errors;
                 totals.warnings += fileTotals.warnings;
                 totals.ignored += fileTotals.ignored;
@@ -54,28 +54,28 @@ function handleLint(argv, config, version) {
                     }
                 }
                 else {
-                    openapi_core_1.formatProblems(results, {
+                    (0, openapi_core_1.formatProblems)(results, {
                         format: argv.format,
                         maxProblems: argv['max-problems'],
                         totals: fileTotals,
                         version,
                     });
                 }
-                const elapsed = utils_1.getExecutionTime(startedAt);
-                process.stderr.write(colorette_1.gray(`${path.replace(process.cwd(), '')}: validated in ${elapsed}\n\n`));
+                const elapsed = (0, utils_1.getExecutionTime)(startedAt);
+                process.stderr.write((0, colorette_1.gray)(`${path.replace(process.cwd(), '')}: validated in ${elapsed}\n\n`));
             }
             catch (e) {
-                utils_1.handleError(e, path);
+                (0, utils_1.handleError)(e, path);
             }
         }
         if (argv['generate-ignore-file']) {
             config.styleguide.saveIgnore();
-            process.stderr.write(`Generated ignore file with ${totalIgnored} ${utils_1.pluralize('problem', totalIgnored)}.\n\n`);
+            process.stderr.write(`Generated ignore file with ${totalIgnored} ${(0, utils_1.pluralize)('problem', totalIgnored)}.\n\n`);
         }
         else {
-            utils_1.printLintTotals(totals, apis.length);
+            (0, utils_1.printLintTotals)(totals, apis.length);
         }
-        utils_1.printUnusedWarnings(config.styleguide);
+        (0, utils_1.printUnusedWarnings)(config.styleguide);
         if (!(totals.errors === 0 || argv['generate-ignore-file'])) {
             throw new Error('Lint failed.');
         }
@@ -91,21 +91,21 @@ function lintConfigCallback(argv, version) {
         return;
     }
     return (config) => __awaiter(this, void 0, void 0, function* () {
-        const configPath = openapi_core_1.findConfig(argv.config) || '';
-        const stringYaml = openapi_core_1.stringifyYaml(config);
-        const configContent = openapi_core_1.makeDocumentFromString(stringYaml, configPath);
-        const problems = yield openapi_core_1.lintConfig({
+        const configPath = (0, openapi_core_1.findConfig)(argv.config) || '';
+        const stringYaml = (0, openapi_core_1.stringifyYaml)(config);
+        const configContent = (0, openapi_core_1.makeDocumentFromString)(stringYaml, configPath);
+        const problems = yield (0, openapi_core_1.lintConfig)({
             document: configContent,
             severity: (argv['lint-config'] || 'warn'),
         });
-        const fileTotals = openapi_core_1.getTotals(problems);
-        openapi_core_1.formatProblems(problems, {
+        const fileTotals = (0, openapi_core_1.getTotals)(problems);
+        (0, openapi_core_1.formatProblems)(problems, {
             format: argv.format,
             maxProblems: argv['max-problems'],
             totals: fileTotals,
             version,
         });
-        utils_1.printConfigLintTotals(fileTotals);
+        (0, utils_1.printConfigLintTotals)(fileTotals);
         if (fileTotals.errors > 0) {
             throw new config_1.ConfigValidationError();
         }

package/lib/commands/login.d.ts

@@ -1,6 +1,6 @@
 import { Region, Config } from '@redocly/openapi-core';
 export declare function promptClientToken(domain: string): Promise<string>;
-export declare type LoginOptions = {
+export type LoginOptions = {
     verbose?: boolean;
     region?: Region;
     config?: string;

package/lib/commands/login.js

@@ -14,7 +14,7 @@ const openapi_core_1 = require("@redocly/openapi-core");
 const colorette_1 = require("colorette");
 const utils_1 = require("../utils");
 function promptClientToken(domain) {
-    return utils_1.promptUser(colorette_1.green(`\n  🔑 Copy your API key from ${colorette_1.blue(`https://app.${domain}/profile`)} and paste it below`), true);
+    return (0, utils_1.promptUser)((0, colorette_1.green)(`\n  🔑 Copy your API key from ${(0, colorette_1.blue)(`https://app.${domain}/profile`)} and paste it below`), true);
 }
 exports.promptClientToken = promptClientToken;
 function handleLogin(argv, config) {
@@ -22,9 +22,9 @@ function handleLogin(argv, config) {
         const region = argv.region || config.region;
         const client = new openapi_core_1.RedoclyClient(region);
         const clientToken = yield promptClientToken(client.domain);
-        process.stdout.write(colorette_1.gray('\n  Logging in...\n'));
+        process.stdout.write((0, colorette_1.gray)('\n  Logging in...\n'));
         yield client.login(clientToken, argv.verbose);
-        process.stdout.write(colorette_1.green('  Authorization confirmed. ✅\n\n'));
+        process.stdout.write((0, colorette_1.green)('  Authorization confirmed. ✅\n\n'));
     });
 }
 exports.handleLogin = handleLogin;

package/lib/commands/preview-docs/index.d.ts

@@ -1,6 +1,6 @@
 import { Config } from '@redocly/openapi-core';
 import type { Skips } from '../../types';
-export declare type PreviewDocsOptions = {
+export type PreviewDocsOptions = {
     port: number;
     host: string;
     'use-community-edition'?: boolean;

package/lib/commands/preview-docs/index.js

@@ -20,7 +20,7 @@ function previewDocs(argv, configFromFile) {
         let isAuthorizedWithRedocly = false;
         let redocOptions = {};
         let config = yield reloadConfig(configFromFile);
-        const apis = yield utils_1.getFallbackApisOrExit(argv.api ? [argv.api] : [], config);
+        const apis = yield (0, utils_1.getFallbackApisOrExit)(argv.api ? [argv.api] : [], config);
         const api = apis[0];
         let cachedBundle;
         const deps = new Set();
@@ -33,7 +33,7 @@ function previewDocs(argv, configFromFile) {
             return __awaiter(this, void 0, void 0, function* () {
                 process.stdout.write('\nBundling...\n\n');
                 try {
-                    const { bundle: openapiBundle, problems, fileDependencies, } = yield openapi_core_1.bundle({
+                    const { bundle: openapiBundle, problems, fileDependencies, } = yield (0, openapi_core_1.bundle)({
                         ref: api.path,
                         config,
                     });
@@ -42,7 +42,7 @@ function previewDocs(argv, configFromFile) {
                     watcher.add([...fileDependencies]);
                     deps.clear();
                     fileDependencies.forEach(deps.add, deps);
-                    const fileTotals = openapi_core_1.getTotals(problems);
+                    const fileTotals = (0, openapi_core_1.getTotals)(problems);
                     if (fileTotals.errors === 0) {
                         process.stdout.write(fileTotals.errors === 0
                             ? `Created a bundle for ${api.alias || api.path} ${fileTotals.warnings > 0 ? 'with warnings' : 'successfully'}\n`
@@ -51,7 +51,7 @@ function previewDocs(argv, configFromFile) {
                     return openapiBundle.parsed;
                 }
                 catch (e) {
-                    utils_1.handleError(e, api.path);
+                    (0, utils_1.handleError)(e, api.path);
                 }
             });
         }
@@ -62,7 +62,7 @@ function previewDocs(argv, configFromFile) {
         if (!isAuthorized) {
             process.stderr.write(`Using Redoc community edition.\nLogin with redocly ${colorette.blue('login')} or use an enterprise license key to preview with the premium docs.\n\n`);
         }
-        const hotClients = yield preview_server_1.default(argv.port, argv.host, {
+        const hotClients = yield (0, preview_server_1.default)(argv.port, argv.host, {
             getBundle,
             getOptions: () => redocOptions,
             useRedocPro: isAuthorized && !redocOptions.useCommunityEdition,
@@ -97,7 +97,7 @@ function previewDocs(argv, configFromFile) {
             return __awaiter(this, void 0, void 0, function* () {
                 if (!config) {
                     try {
-                        config = (yield utils_1.loadConfigAndHandleErrors({ configPath: argv.config }));
+                        config = (yield (0, utils_1.loadConfigAndHandleErrors)({ configPath: argv.config }));
                     }
                     catch (err) {
                         config = new openapi_core_1.Config({ apis: {}, styleguide: {} });
@@ -105,7 +105,7 @@ function previewDocs(argv, configFromFile) {
                 }
                 const redoclyClient = new openapi_core_1.RedoclyClient();
                 isAuthorizedWithRedocly = yield redoclyClient.isAuthorizedWithRedocly();
-                const resolvedConfig = openapi_core_1.getMergedConfig(config, argv.api);
+                const resolvedConfig = (0, openapi_core_1.getMergedConfig)(config, argv.api);
                 const { styleguide } = resolvedConfig;
                 styleguide.skipPreprocessors(argv['skip-preprocessor']);
                 styleguide.skipDecorators(argv['skip-decorator']);

package/lib/commands/preview-docs/preview-server/hot.js

@@ -1,13 +1,29 @@
 (function run() {
   const Socket = window.SimpleWebsocket;
   const port = window.__OPENAPI_CLI_WS_PORT;
+  const host = window.__OPENAPI_CLI_WS_HOST;
 
   let socket;
 
   reconnect();
 
+  function getFormattedHost() {
+    // Use localhost when bound to all interfaces
+    if (host === '::' || host === '0.0.0.0') {
+      return 'localhost';
+    }
+
+    // Other IPv6 addresses must be wrapped in brackets
+    if (host.includes('::')) {
+      return `[${host}]`;
+    }
+
+    // Otherwise return as-is
+    return host;
+  }
+
   function reconnect() {
-    socket = new Socket(`ws://127.0.0.1:${port}`);
+    socket = new Socket(`ws://${getFormattedHost()}:${port}`);
     socket.on('connect', () => {
       socket.send('{"type": "ping"}');
     });
@@ -29,13 +45,14 @@
 
     socket.on('close', () => {
       socket.destroy();
-      console.log('Connection lost, trying to reconnect in 4s');
+      console.log('[hot] Connection lost, trying to reconnect in 4s');
       setTimeout(() => {
         reconnect();
       }, 4000);
     });
 
     socket.on('error', () => {
+      console.log('[hot] Error connecting to hot reloading server');
       socket.destroy();
     });
   }

package/lib/commands/preview-docs/preview-server/preview-server.js

@@ -16,18 +16,19 @@ const fs_1 = require("fs");
 const path = require("path");
 const server_1 = require("./server");
 const utils_1 = require("../../../utils");
-function getPageHTML(htmlTemplate, redocOptions = {}, useRedocPro, wsPort) {
-    let templateSrc = fs_1.readFileSync(htmlTemplate, 'utf-8');
+function getPageHTML(htmlTemplate, redocOptions = {}, useRedocPro, wsPort, host) {
+    let templateSrc = (0, fs_1.readFileSync)(htmlTemplate, 'utf-8');
     // fix template for backward compatibility
     templateSrc = templateSrc
         .replace(/{?{{redocHead}}}?/, '{{{redocHead}}}')
         .replace('{{redocBody}}', '{{{redocHTML}}}');
-    const template = handlebars_1.compile(templateSrc);
+    const template = (0, handlebars_1.compile)(templateSrc);
     return template({
         redocHead: `
   <script>
     window.__REDOC_EXPORT = '${useRedocPro ? 'RedoclyReferenceDocs' : 'Redoc'}';
     window.__OPENAPI_CLI_WS_PORT = ${wsPort};
+    window.__OPENAPI_CLI_WS_HOST = "${host}";
   </script>
   <script src="/simplewebsocket.min.js"></script>
   <script src="/hot.js"></script>
@@ -54,14 +55,14 @@ function startPreviewServer(port, host, { getBundle, getOptions, useRedocPro, })
             console.time(colorette.dim(`GET ${request.url}`));
             const { htmlTemplate } = getOptions() || {};
             if (((_a = request.url) === null || _a === void 0 ? void 0 : _a.endsWith('/')) || path.extname(request.url) === '') {
-                server_1.respondWithGzip(getPageHTML(htmlTemplate || defaultTemplate, getOptions(), useRedocPro, wsPort), request, response, {
+                (0, server_1.respondWithGzip)(getPageHTML(htmlTemplate || defaultTemplate, getOptions(), useRedocPro, wsPort, host), request, response, {
                     'Content-Type': 'text/html',
                 });
             }
             else if (request.url === '/openapi.json') {
                 const bundle = yield getBundle();
                 if (bundle === undefined) {
-                    server_1.respondWithGzip(JSON.stringify({
+                    (0, server_1.respondWithGzip)(JSON.stringify({
                         openapi: '3.0.0',
                         info: {
                             description: '<code> Failed to generate bundle: check out console output for more details </code>',
@@ -72,7 +73,7 @@ function startPreviewServer(port, host, { getBundle, getOptions, useRedocPro, })
                     });
                 }
                 else {
-                    server_1.respondWithGzip(JSON.stringify(bundle), request, response, {
+                    (0, server_1.respondWithGzip)(JSON.stringify(bundle), request, response, {
                         'Content-Type': 'application/json',
                     });
                 }
@@ -89,8 +90,8 @@ function startPreviewServer(port, host, { getBundle, getOptions, useRedocPro, })
                 if (!filePath) {
                     const basePath = htmlTemplate ? path.dirname(htmlTemplate) : process.cwd();
                     filePath = path.resolve(basePath, `.${request.url}`);
-                    if (!utils_1.isSubdir(basePath, filePath)) {
-                        server_1.respondWithGzip('404 Not Found', request, response, { 'Content-Type': 'text/html' }, 404);
+                    if (!(0, utils_1.isSubdir)(basePath, filePath)) {
+                        (0, server_1.respondWithGzip)('404 Not Found', request, response, { 'Content-Type': 'text/html' }, 404);
                         console.timeEnd(colorette.dim(`GET ${request.url}`));
                         return;
                     }
@@ -98,27 +99,27 @@ function startPreviewServer(port, host, { getBundle, getOptions, useRedocPro, })
                 const extname = String(path.extname(filePath)).toLowerCase();
                 const contentType = server_1.mimeTypes[extname] || 'application/octet-stream';
                 try {
-                    server_1.respondWithGzip(yield fs_1.promises.readFile(filePath), request, response, {
+                    (0, server_1.respondWithGzip)(yield fs_1.promises.readFile(filePath), request, response, {
                         'Content-Type': contentType,
                     });
                 }
                 catch (e) {
                     if (e.code === 'ENOENT') {
-                        server_1.respondWithGzip('404 Not Found', request, response, { 'Content-Type': 'text/html' }, 404);
+                        (0, server_1.respondWithGzip)('404 Not Found', request, response, { 'Content-Type': 'text/html' }, 404);
                     }
                     else {
-                        server_1.respondWithGzip(`Something went wrong: ${e.code || e.message}...\n`, request, response, {}, 500);
+                        (0, server_1.respondWithGzip)(`Something went wrong: ${e.code || e.message}...\n`, request, response, {}, 500);
                     }
                 }
             }
             console.timeEnd(colorette.dim(`GET ${request.url}`));
         });
-        const wsPort = yield get_port_please_1.getPort({ portRange: [32201, 32301] });
-        const server = server_1.startHttpServer(port, host, handler);
+        const wsPort = yield (0, get_port_please_1.getPort)({ port: 32201, portRange: [32201, 32301], host });
+        const server = (0, server_1.startHttpServer)(port, host, handler);
         server.on('listening', () => {
             process.stdout.write(`\n  🔎  Preview server running at ${colorette.blue(`http://${host}:${port}\n`)}`);
         });
-        return server_1.startWsServer(wsPort);
+        return (0, server_1.startWsServer)(wsPort, host);
     });
 }
 exports.default = startPreviewServer;