@redocly/openapi-core 1.0.0-beta.107 → 1.0.0-beta.108

package/lib/format/format.js

@@ -2,20 +2,21 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.formatProblems = exports.getTotals = void 0;
 const path = require("path");
-const colorette_1 = require("colorette");
+const logger_1 = require("../logger");
+const output_1 = require("../output");
 const coreVersion = require('../../package.json').version;
 const codeframes_1 = require("./codeframes");
-const config_1 = require("../config");
+const env_1 = require("../env");
 const ERROR_MESSAGE = {
     INVALID_SEVERITY_LEVEL: 'Invalid severity level; accepted values: error or warn',
 };
 const BG_COLORS = {
-    warn: (str) => colorette_1.bgYellow(colorette_1.black(str)),
-    error: colorette_1.bgRed,
+    warn: (str) => logger_1.colorize.bgYellow(logger_1.colorize.black(str)),
+    error: logger_1.colorize.bgRed,
 };
 const COLORS = {
-    warn: colorette_1.yellow,
-    error: colorette_1.red,
+    warn: logger_1.colorize.yellow,
+    error: logger_1.colorize.red,
 };
 const SEVERITY_NAMES = {
     warn: 'Warning',
@@ -51,8 +52,8 @@ function getTotals(problems) {
 }
 exports.getTotals = getTotals;
 function formatProblems(problems, opts) {
-    const { maxProblems = 100, cwd = process.cwd(), format = 'codeframe', color = colorette_1.options.enabled, totals = getTotals(problems), version = coreVersion, } = opts;
-    colorette_1.options.enabled = color; // force colors if specified
+    const { maxProblems = 100, cwd = process.cwd(), format = 'codeframe', color = logger_1.colorOptions.enabled, totals = getTotals(problems), version = coreVersion, } = opts;
+    logger_1.colorOptions.enabled = color; // force colors if specified
     const totalProblems = problems.length;
     problems = problems.filter((m) => !m.ignored);
     const ignoredProblems = totalProblems - problems.length;
@@ -68,31 +69,31 @@ function formatProblems(problems, opts) {
         case 'codeframe':
             for (let i = 0; i < problems.length; i++) {
                 const problem = problems[i];
-                process.stderr.write(`${formatCodeframe(problem, i)}\n`);
+                logger_1.logger.info(`${formatCodeframe(problem, i)}\n`);
             }
             break;
         case 'stylish': {
             const groupedByFile = groupByFiles(problems);
             for (const [file, { ruleIdPad, locationPad: positionPad, fileProblems }] of Object.entries(groupedByFile)) {
-                process.stderr.write(`${colorette_1.blue(path.relative(cwd, file))}:\n`);
+                logger_1.logger.info(`${logger_1.colorize.blue(path.relative(cwd, file))}:\n`);
                 for (let i = 0; i < fileProblems.length; i++) {
                     const problem = fileProblems[i];
-                    process.stderr.write(`${formatStylish(problem, positionPad, ruleIdPad)}\n`);
+                    logger_1.logger.info(`${formatStylish(problem, positionPad, ruleIdPad)}\n`);
                 }
-                process.stderr.write('\n');
+                logger_1.logger.info('\n');
             }
             break;
         }
         case 'checkstyle': {
             const groupedByFile = groupByFiles(problems);
-            process.stdout.write('<?xml version="1.0" encoding="UTF-8"?>\n');
-            process.stdout.write('<checkstyle version="4.3">\n');
+            output_1.output.write('<?xml version="1.0" encoding="UTF-8"?>\n');
+            output_1.output.write('<checkstyle version="4.3">\n');
             for (const [file, { fileProblems }] of Object.entries(groupedByFile)) {
-                process.stdout.write(`<file name="${xmlEscape(path.relative(cwd, file))}">\n`);
+                output_1.output.write(`<file name="${xmlEscape(path.relative(cwd, file))}">\n`);
                 fileProblems.forEach(formatCheckstyle);
-                process.stdout.write(`</file>\n`);
+                output_1.output.write(`</file>\n`);
             }
-            process.stdout.write(`</checkstyle>\n`);
+            output_1.output.write(`</checkstyle>\n`);
             break;
         }
         case 'codeclimate':
@@ -100,7 +101,7 @@ function formatProblems(problems, opts) {
             break;
     }
     if (totalProblems - ignoredProblems > maxProblems) {
-        process.stderr.write(`< ... ${totalProblems - maxProblems} more problems hidden > ${colorette_1.gray('increase with `--max-problems N`')}\n`);
+        logger_1.logger.info(`< ... ${totalProblems - maxProblems} more problems hidden > ${logger_1.colorize.gray('increase with `--max-problems N`')}\n`);
     }
     function outputForCodeClimate() {
         const issues = problems.map((p) => {
@@ -118,7 +119,7 @@ function formatProblems(problems, opts) {
                 fingerprint: `${p.ruleId}${p.location.length > 0 ? '-' + p.location[0].pointer : ''}`,
             };
         });
-        process.stdout.write(JSON.stringify(issues, null, 2));
+        output_1.output.write(JSON.stringify(issues, null, 2));
     }
     function outputJSON() {
         const resultObject = {
@@ -126,13 +127,13 @@ function formatProblems(problems, opts) {
             version,
             problems: problems.map((p) => {
                 var _a;
-                let problem = Object.assign(Object.assign({}, p), { location: p.location.map((location) => (Object.assign(Object.assign({}, location), { source: {
+                const problem = Object.assign(Object.assign({}, p), { location: p.location.map((location) => (Object.assign(Object.assign({}, location), { source: {
                             ref: path.relative(cwd, location.source.absoluteRef),
                         } }))), from: p.from
                         ? Object.assign(Object.assign({}, p.from), { source: {
                                 ref: path.relative(cwd, ((_a = p.from) === null || _a === void 0 ? void 0 : _a.source.absoluteRef) || cwd),
                             } }) : undefined });
-                if (config_1.env.FORMAT_JSON_WITH_CODEFRAMES) {
+                if (env_1.env.FORMAT_JSON_WITH_CODEFRAMES) {
                     const location = p.location[0]; // TODO: support multiple locations
                     const loc = codeframes_1.getLineColLocation(location);
                     problem.codeframe = codeframes_1.getCodeframe(loc, color);
@@ -140,7 +141,7 @@ function formatProblems(problems, opts) {
                 return problem;
             }),
         };
-        process.stdout.write(JSON.stringify(resultObject, null, 2));
+        output_1.output.write(JSON.stringify(resultObject, null, 2));
     }
     function getBgColor(problem) {
         const { severity } = problem;
@@ -154,7 +155,7 @@ function formatProblems(problems, opts) {
         const location = problem.location[0]; // TODO: support multiple locations
         const relativePath = path.relative(cwd, location.source.absoluteRef);
         const loc = codeframes_1.getLineColLocation(location);
-        const atPointer = location.pointer ? colorette_1.gray(`at ${location.pointer}`) : '';
+        const atPointer = location.pointer ? logger_1.colorize.gray(`at ${location.pointer}`) : '';
         const fileWithLoc = `${relativePath}:${loc.start.line}:${loc.start.col}`;
         return (`[${idx + 1}] ${bgColor(fileWithLoc)} ${atPointer}\n\n` +
             `${problem.message}\n\n` +
@@ -162,7 +163,7 @@ function formatProblems(problems, opts) {
             codeframes_1.getCodeframe(loc, color) +
             '\n\n' +
             formatFrom(cwd, problem.from) +
-            `${SEVERITY_NAMES[problem.severity]} was generated by the ${colorette_1.blue(problem.ruleId)} rule.\n\n`);
+            `${SEVERITY_NAMES[problem.severity]} was generated by the ${logger_1.colorize.blue(problem.ruleId)} rule.\n\n`);
     }
     function formatStylish(problem, locationPad, ruleIdPad) {
         const color = COLORS[problem.severity];
@@ -178,7 +179,7 @@ function formatProblems(problems, opts) {
         const severity = problem.severity == 'warn' ? 'warning' : 'error';
         const message = xmlEscape(problem.message);
         const source = xmlEscape(problem.ruleId);
-        process.stdout.write(`<error line="${line}" column="${col}" severity="${severity}" message="${message}" source="${source}" />\n`);
+        output_1.output.write(`<error line="${line}" column="${col}" severity="${severity}" message="${message}" source="${source}" />\n`);
     }
 }
 exports.formatProblems = formatProblems;
@@ -188,7 +189,7 @@ function formatFrom(cwd, location) {
     const relativePath = path.relative(cwd, location.source.absoluteRef);
     const loc = codeframes_1.getLineColLocation(location);
     const fileWithLoc = `${relativePath}:${loc.start.line}:${loc.start.col}`;
-    return `referenced from ${colorette_1.blue(fileWithLoc)}\n\n`;
+    return `referenced from ${logger_1.colorize.blue(fileWithLoc)}\n\n`;
 }
 function formatDidYouMean(problem) {
     if (problem.suggest.length === 0)
@@ -217,6 +218,7 @@ const groupByFiles = (problems) => {
     return fileGroups;
 };
 function xmlEscape(s) {
+    // eslint-disable-next-line no-control-regex
     return s.replace(/[<>&"'\x00-\x1F\x7F\u0080-\uFFFF]/gu, (char) => {
         switch (char) {
             case '<':

package/lib/index.d.ts

@@ -1,14 +1,14 @@
-export { BundleOutputFormat, readFileFromUrl, slash, doesYamlFileExist } from './utils';
+export { BundleOutputFormat, readFileFromUrl, slash, doesYamlFileExist, isTruthy } from './utils';
 export { Oas3_1Types } from './types/oas3_1';
 export { Oas3Types } from './types/oas3';
 export { Oas2Types } from './types/oas2';
 export { ConfigTypes } from './types/redocly-yaml';
-export { Oas3Definition, Oas3_1Definition, Oas3Components, Oas3PathItem, Oas3Paths, Oas3ComponentName, Oas3Schema, Oas3_1Schema, Oas3Tag, Oas3_1Webhooks, Referenced, } from './typings/openapi';
-export { Oas2Definition } from './typings/swagger';
-export { StatsAccumulator, StatsName } from './typings/common';
+export type { Oas3Definition, Oas3_1Definition, Oas3Components, Oas3PathItem, Oas3Paths, Oas3ComponentName, Oas3Schema, Oas3_1Schema, Oas3Tag, Oas3_1Webhooks, Referenced, OasRef, } from './typings/openapi';
+export type { Oas2Definition } from './typings/swagger';
+export type { StatsAccumulator, StatsName } from './typings/common';
 export { normalizeTypes } from './types';
 export { Stats } from './rules/other/stats';
-export { Config, StyleguideConfig, RawConfig, IGNORE_FILE, Region, getMergedConfig, transformConfig, loadConfig, getConfig, findConfig, CONFIG_FILE_NAMES, RuleSeverity, } from './config';
+export { Config, StyleguideConfig, RawConfig, IGNORE_FILE, Region, getMergedConfig, transformConfig, loadConfig, getConfig, findConfig, CONFIG_FILE_NAMES, RuleSeverity, createConfig, } from './config';
 export { RedoclyClient, isRedoclyRegistryURL } from './redocly';
 export { Source, BaseResolver, Document, resolveDocument, ResolveError, YamlParseError, makeDocumentFromString, } from './resolve';
 export { parseYaml, stringifyYaml } from './js-yaml';

package/lib/index.js

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.mapTypeToComponent = exports.bundleDocument = exports.bundle = exports.lintConfig = exports.lintFromString = exports.lintDocument = exports.validate = exports.lint = exports.getTotals = exports.formatProblems = exports.getLineColLocation = exports.getAstNodeByPointer = exports.walkDocument = exports.normalizeVisitors = exports.OasVersion = exports.openAPIMajor = exports.OasMajorVersion = exports.detectOpenAPI = exports.isRef = exports.unescapePointer = exports.stringifyYaml = exports.parseYaml = exports.makeDocumentFromString = exports.YamlParseError = exports.ResolveError = exports.resolveDocument = exports.BaseResolver = exports.Source = exports.isRedoclyRegistryURL = exports.RedoclyClient = exports.CONFIG_FILE_NAMES = exports.findConfig = exports.getConfig = exports.loadConfig = exports.transformConfig = exports.getMergedConfig = exports.IGNORE_FILE = exports.StyleguideConfig = exports.Config = exports.Stats = exports.normalizeTypes = exports.ConfigTypes = exports.Oas2Types = exports.Oas3Types = exports.Oas3_1Types = exports.doesYamlFileExist = exports.slash = exports.readFileFromUrl = void 0;
+exports.mapTypeToComponent = exports.bundleDocument = exports.bundle = exports.lintConfig = exports.lintFromString = exports.lintDocument = exports.validate = exports.lint = exports.getTotals = exports.formatProblems = exports.getLineColLocation = exports.getAstNodeByPointer = exports.walkDocument = exports.normalizeVisitors = exports.OasVersion = exports.openAPIMajor = exports.OasMajorVersion = exports.detectOpenAPI = exports.isRef = exports.unescapePointer = exports.stringifyYaml = exports.parseYaml = exports.makeDocumentFromString = exports.YamlParseError = exports.ResolveError = exports.resolveDocument = exports.BaseResolver = exports.Source = exports.isRedoclyRegistryURL = exports.RedoclyClient = exports.createConfig = exports.CONFIG_FILE_NAMES = exports.findConfig = exports.getConfig = exports.loadConfig = exports.transformConfig = exports.getMergedConfig = exports.IGNORE_FILE = exports.StyleguideConfig = exports.Config = exports.Stats = exports.normalizeTypes = exports.ConfigTypes = exports.Oas2Types = exports.Oas3Types = exports.Oas3_1Types = exports.isTruthy = exports.doesYamlFileExist = exports.slash = exports.readFileFromUrl = void 0;
 var utils_1 = require("./utils");
 Object.defineProperty(exports, "readFileFromUrl", { enumerable: true, get: function () { return utils_1.readFileFromUrl; } });
 Object.defineProperty(exports, "slash", { enumerable: true, get: function () { return utils_1.slash; } });
 Object.defineProperty(exports, "doesYamlFileExist", { enumerable: true, get: function () { return utils_1.doesYamlFileExist; } });
+Object.defineProperty(exports, "isTruthy", { enumerable: true, get: function () { return utils_1.isTruthy; } });
 var oas3_1_1 = require("./types/oas3_1");
 Object.defineProperty(exports, "Oas3_1Types", { enumerable: true, get: function () { return oas3_1_1.Oas3_1Types; } });
 var oas3_1 = require("./types/oas3");
@@ -27,6 +28,7 @@ Object.defineProperty(exports, "loadConfig", { enumerable: true, get: function (
 Object.defineProperty(exports, "getConfig", { enumerable: true, get: function () { return config_1.getConfig; } });
 Object.defineProperty(exports, "findConfig", { enumerable: true, get: function () { return config_1.findConfig; } });
 Object.defineProperty(exports, "CONFIG_FILE_NAMES", { enumerable: true, get: function () { return config_1.CONFIG_FILE_NAMES; } });
+Object.defineProperty(exports, "createConfig", { enumerable: true, get: function () { return config_1.createConfig; } });
 var redocly_1 = require("./redocly");
 Object.defineProperty(exports, "RedoclyClient", { enumerable: true, get: function () { return redocly_1.RedoclyClient; } });
 Object.defineProperty(exports, "isRedoclyRegistryURL", { enumerable: true, get: function () { return redocly_1.isRedoclyRegistryURL; } });

package/lib/js-yaml/index.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.stringifyYaml = exports.parseYaml = void 0;
 // TODO: add a type for "types" https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/js-yaml/index.d.ts
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
 // @ts-ignore
 const js_yaml_1 = require("js-yaml");
 const DEFAULT_SCHEMA_WITHOUT_TIMESTAMP = js_yaml_1.JSON_SCHEMA.extend({

package/lib/logger.d.ts

@@ -0,0 +1,10 @@
+import * as colorette from 'colorette';
+export { options as colorOptions } from 'colorette';
+export declare const colorize: typeof colorette;
+declare class Logger {
+    protected stderr(str: string): boolean;
+    info(str: string): boolean | void;
+    warn(str: string): boolean | void;
+    error(str: string): boolean | void;
+}
+export declare const logger: Logger;

package/lib/logger.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logger = exports.colorize = exports.colorOptions = void 0;
+const colorette = require("colorette");
+var colorette_1 = require("colorette");
+Object.defineProperty(exports, "colorOptions", { enumerable: true, get: function () { return colorette_1.options; } });
+const env_1 = require("./env");
+const utils_1 = require("./utils");
+exports.colorize = new Proxy(colorette, {
+    get(target, prop) {
+        if (env_1.isBrowser) {
+            return utils_1.identity;
+        }
+        return target[prop];
+    },
+});
+class Logger {
+    stderr(str) {
+        return process.stderr.write(str);
+    }
+    info(str) {
+        return env_1.isBrowser ? console.log(str) : this.stderr(str);
+    }
+    warn(str) {
+        return env_1.isBrowser ? console.warn(str) : this.stderr(exports.colorize.yellow(str));
+    }
+    error(str) {
+        return env_1.isBrowser ? console.error(str) : this.stderr(exports.colorize.red(str));
+    }
+}
+exports.logger = new Logger();

package/lib/output.d.ts

@@ -0,0 +1,3 @@
+export declare const output: {
+    write(str: string): boolean | undefined;
+};

package/lib/output.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.output = void 0;
+const env_1 = require("./env");
+exports.output = {
+    write(str) {
+        return env_1.isBrowser ? undefined : process.stdout.write(str);
+    },
+};

package/lib/redocly/index.js

@@ -13,26 +13,27 @@ exports.isRedoclyRegistryURL = exports.RedoclyClient = void 0;
 const fs_1 = require("fs");
 const path_1 = require("path");
 const os_1 = require("os");
-const colorette_1 = require("colorette");
 const registry_api_1 = require("./registry-api");
 const config_1 = require("../config/config");
+const env_1 = require("../env");
 const utils_1 = require("../utils");
+const logger_1 = require("../logger");
 const TOKEN_FILENAME = '.redocly-config.json';
 class RedoclyClient {
     constructor(region) {
         this.accessTokens = {};
         this.region = this.loadRegion(region);
         this.loadTokens();
-        this.domain = region ? config_1.DOMAINS[region] : config_1.env.REDOCLY_DOMAIN || config_1.DOMAINS[config_1.DEFAULT_REGION];
-        config_1.env.REDOCLY_DOMAIN = this.domain; // isRedoclyRegistryURL depends on the value to be set
+        this.domain = region ? config_1.DOMAINS[region] : env_1.env.REDOCLY_DOMAIN || config_1.DOMAINS[config_1.DEFAULT_REGION];
+        env_1.env.REDOCLY_DOMAIN = this.domain; // isRedoclyRegistryURL depends on the value to be set
         this.registryApi = new registry_api_1.RegistryApi(this.accessTokens, this.region);
     }
     loadRegion(region) {
         if (region && !config_1.DOMAINS[region]) {
-            throw new Error(`Invalid argument: region in config file.\nGiven: ${colorette_1.green(region)}, choices: "us", "eu".`);
+            throw new Error(`Invalid argument: region in config file.\nGiven: ${logger_1.colorize.green(region)}, choices: "us", "eu".`);
         }
-        if (config_1.env.REDOCLY_DOMAIN) {
-            return (config_1.AVAILABLE_REGIONS.find((region) => config_1.DOMAINS[region] === config_1.env.REDOCLY_DOMAIN) || config_1.DEFAULT_REGION);
+        if (env_1.env.REDOCLY_DOMAIN) {
+            return (config_1.AVAILABLE_REGIONS.find((region) => config_1.DOMAINS[region] === env_1.env.REDOCLY_DOMAIN) || config_1.DEFAULT_REGION);
         }
         return region || config_1.DEFAULT_REGION;
     }
@@ -64,8 +65,8 @@ class RedoclyClient {
                 [this.region]: credentials.token,
             })));
         }
-        if (config_1.env.REDOCLY_AUTHORIZATION) {
-            this.setAccessTokens(Object.assign(Object.assign({}, this.accessTokens), { [this.region]: config_1.env.REDOCLY_AUTHORIZATION }));
+        if (env_1.env.REDOCLY_AUTHORIZATION) {
+            this.setAccessTokens(Object.assign(Object.assign({}, this.accessTokens), { [this.region]: env_1.env.REDOCLY_AUTHORIZATION }));
         }
     }
     getAllTokens() {
@@ -142,7 +143,7 @@ class RedoclyClient {
 }
 exports.RedoclyClient = RedoclyClient;
 function isRedoclyRegistryURL(link) {
-    const domain = config_1.env.REDOCLY_DOMAIN || config_1.DOMAINS[config_1.DEFAULT_REGION];
+    const domain = env_1.env.REDOCLY_DOMAIN || config_1.DOMAINS[config_1.DEFAULT_REGION];
     const legacyDomain = domain === 'redocly.com' ? 'redoc.ly' : domain;
     if (!link.startsWith(`https://api.${domain}/registry/`) &&
         !link.startsWith(`https://api.${legacyDomain}/registry/`)) {

package/lib/redocly/registry-api-types.d.ts

@@ -1,31 +1,29 @@
-export declare namespace RegistryApiTypes {
-    interface VersionParams {
-        organizationId: string;
-        name: string;
-        version: string;
-    }
-    export interface PrepareFileuploadParams extends VersionParams {
-        filesHash: string;
-        filename: string;
-        isUpsert?: boolean;
-    }
-    export interface PushApiParams extends VersionParams {
-        rootFilePath: string;
-        filePaths: string[];
-        branch?: string;
-        isUpsert?: boolean;
-        isPublic?: boolean;
-        batchId?: string;
-        batchSize?: number;
-    }
-    export interface PrepareFileuploadOKResponse {
-        filePath: string;
-        signedUploadUrl: string;
-    }
-    export interface NotFoundProblemResponse {
-        status: 404;
-        title: 'Not Found';
-        code: 'ORGANIZATION_NOT_FOUND' | 'API_VERSION_NOT_FOUND';
-    }
-    export {};
+interface VersionParams {
+    organizationId: string;
+    name: string;
+    version: string;
 }
+export interface PrepareFileuploadParams extends VersionParams {
+    filesHash: string;
+    filename: string;
+    isUpsert?: boolean;
+}
+export interface PushApiParams extends VersionParams {
+    rootFilePath: string;
+    filePaths: string[];
+    branch?: string;
+    isUpsert?: boolean;
+    isPublic?: boolean;
+    batchId?: string;
+    batchSize?: number;
+}
+export interface PrepareFileuploadOKResponse {
+    filePath: string;
+    signedUploadUrl: string;
+}
+export interface NotFoundProblemResponse {
+    status: 404;
+    title: 'Not Found';
+    code: 'ORGANIZATION_NOT_FOUND' | 'API_VERSION_NOT_FOUND';
+}
+export {};

package/lib/redocly/registry-api.d.ts

@@ -1,5 +1,6 @@
-import { RegistryApiTypes } from './registry-api-types';
+import type { PrepareFileuploadOKResponse, PrepareFileuploadParams, PushApiParams } from './registry-api-types';
 import type { AccessTokens, Region } from '../config/types';
+export declare const currentCommand: string;
 export declare class RegistryApi {
     private accessTokens;
     private region;
@@ -12,6 +13,6 @@ export declare class RegistryApi {
         viewerId: string;
         organizations: string[];
     }>;
-    prepareFileUpload({ organizationId, name, version, filesHash, filename, isUpsert, }: RegistryApiTypes.PrepareFileuploadParams): Promise<RegistryApiTypes.PrepareFileuploadOKResponse>;
-    pushApi({ organizationId, name, version, rootFilePath, filePaths, branch, isUpsert, isPublic, batchId, batchSize, }: RegistryApiTypes.PushApiParams): Promise<void>;
+    prepareFileUpload({ organizationId, name, version, filesHash, filename, isUpsert, }: PrepareFileuploadParams): Promise<PrepareFileuploadOKResponse>;
+    pushApi({ organizationId, name, version, rootFilePath, filePaths, branch, isUpsert, isPublic, batchId, batchSize, }: PushApiParams): Promise<void>;
 }

package/lib/redocly/registry-api.js

@@ -8,12 +8,14 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RegistryApi = void 0;
+exports.RegistryApi = exports.currentCommand = void 0;
 const node_fetch_1 = require("node-fetch");
 const config_1 = require("../config/config");
 const utils_1 = require("../utils");
 const version = require('../../package.json').version;
+exports.currentCommand = typeof process !== 'undefined' ? ((_a = process.env) === null || _a === void 0 ? void 0 : _a.REDOCLY_CLI_COMMAND) || '' : '';
 class RegistryApi {
     constructor(accessTokens, region) {
         this.accessTokens = accessTokens;
@@ -31,7 +33,10 @@ class RegistryApi {
     }
     request(path = '', options = {}, region) {
         return __awaiter(this, void 0, void 0, function* () {
-            const headers = Object.assign({}, options.headers || {}, { 'x-redocly-cli-version': version });
+            const headers = Object.assign({}, options.headers || {}, {
+                'x-redocly-cli-version': version,
+                'user-agent': `redocly-cli / ${version} ${exports.currentCommand}`,
+            });
             if (!headers.hasOwnProperty('authorization')) {
                 throw new Error('Unauthorized');
             }

package/lib/ref-utils.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isMappingRef = exports.isAbsoluteUrl = exports.refBaseName = exports.pointerBaseName = exports.parsePointer = exports.parseRef = exports.escapePointer = exports.unescapePointer = exports.Location = exports.isRef = exports.joinPointer = void 0;
+const utils_1 = require("./utils");
 function joinPointer(base, key) {
     if (base === '')
         base = '#/';
@@ -41,7 +42,7 @@ function parseRef(ref) {
     const [uri, pointer] = ref.split('#/');
     return {
         uri: uri || null,
-        pointer: pointer ? pointer.split('/').map(unescapePointer).filter(Boolean) : [],
+        pointer: pointer ? pointer.split('/').map(unescapePointer).filter(utils_1.isTruthy) : [],
     };
 }
 exports.parseRef = parseRef;

package/lib/resolve.d.ts

@@ -33,7 +33,7 @@ export declare function makeDocumentFromString(sourceString: string, absoluteRef
     parsed: unknown;
 };
 export declare class BaseResolver {
-    private config;
+    protected config: ResolveConfig;
     cache: Map<string, Promise<Document | ResolveError>>;
     constructor(config?: ResolveConfig);
     getFiles(): Set<string>;

package/lib/resolve.js

@@ -271,7 +271,7 @@ function resolveDocument(opts) {
                     };
                     let target = targetDoc.parsed;
                     const segments = pointer;
-                    for (let segment of segments) {
+                    for (const segment of segments) {
                         if (typeof target !== 'object') {
                             target = undefined;
                             break;

package/lib/rules/ajv.js

@@ -56,7 +56,7 @@ function validateJsonSchema(data, schema, schemaLoc, instancePath, resolve, allo
     };
     function beatifyErrorMessage(error) {
         let message = error.message;
-        let suggest = error.keyword === 'enum' ? error.params.allowedValues : undefined;
+        const suggest = error.keyword === 'enum' ? error.params.allowedValues : undefined;
         if (suggest) {
             message += ` ${suggest.map((e) => `"${e}"`).join(', ')}`;
         }

package/lib/rules/common/assertions/asserts.js

@@ -35,7 +35,7 @@ exports.asserts = {
             return { isValid: true }; // property doesn't exist, no need to lint it with this assert
         const values = utils_1.isString(value) ? [value] : value;
         const regx = utils_2.regexFromString(condition);
-        for (let _val of values) {
+        for (const _val of values) {
             if (!(regx === null || regx === void 0 ? void 0 : regx.test(_val))) {
                 return { isValid: false, location: utils_1.isString(value) ? baseLocation : baseLocation.key() };
             }
@@ -46,7 +46,7 @@ exports.asserts = {
         if (typeof value === 'undefined')
             return { isValid: true }; // property doesn't exist, no need to lint it with this assert
         const values = utils_1.isString(value) ? [value] : value;
-        for (let _val of values) {
+        for (const _val of values) {
             if (!condition.includes(_val)) {
                 return {
                     isValid: false,
@@ -72,7 +72,7 @@ exports.asserts = {
         if (typeof value === 'undefined')
             return { isValid: true }; // property doesn't exist, no need to lint it with this assert
         const values = utils_1.isString(value) ? [value] : value;
-        for (let _val of values) {
+        for (const _val of values) {
             if (condition.includes(_val)) {
                 return {
                     isValid: false,
@@ -104,7 +104,7 @@ exports.asserts = {
         if (typeof value === 'undefined')
             return { isValid: true }; // property doesn't exist, no need to lint it with this assert
         const values = utils_1.isString(value) ? [value] : value;
-        for (let _val of values) {
+        for (const _val of values) {
             let matchCase = false;
             switch (condition) {
                 case 'camelCase':

package/lib/rules/common/assertions/index.js

@@ -4,7 +4,7 @@ exports.Assertions = void 0;
 const asserts_1 = require("./asserts");
 const utils_1 = require("./utils");
 const Assertions = (opts) => {
-    let visitors = [];
+    const visitors = [];
     // As 'Assertions' has an array of asserts,
     // that array spreads into an 'opts' object on init rules phase here
     // https://github.com/Redocly/redocly-cli/blob/master/packages/core/src/config/config.ts#L311

package/lib/rules/common/operation-security-defined.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OperationSecurityDefined = void 0;
 const OperationSecurityDefined = () => {
-    let referencedSchemes = new Map();
+    const referencedSchemes = new Map();
     return {
         DefinitionRoot: {
             leave(_, { report }) {

package/lib/rules/common/spec.js

@@ -27,7 +27,7 @@ const OasSpec = () => {
                 return;
             }
             const required = typeof type.required === 'function' ? type.required(node, key) : type.required;
-            for (let propName of required || []) {
+            for (const propName of required || []) {
                 if (!node.hasOwnProperty(propName)) {
                     report({
                         message: `The field \`${propName}\` must be present on this level.`,
@@ -52,7 +52,7 @@ const OasSpec = () => {
             const requiredOneOf = type.requiredOneOf || null;
             if (requiredOneOf) {
                 let hasProperty = false;
-                for (let propName of requiredOneOf || []) {
+                for (const propName of requiredOneOf || []) {
                     if (node.hasOwnProperty(propName)) {
                         hasProperty = true;
                     }

package/lib/rules/oas2/remove-unused-components.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.RemoveUnusedComponents = void 0;
 const utils_1 = require("../../utils");
 const RemoveUnusedComponents = () => {
-    let components = new Map();
+    const components = new Map();
     function registerComponent(location, componentType, name) {
         var _a;
         components.set(location.absolutePointer, {
@@ -30,7 +30,7 @@ const RemoveUnusedComponents = () => {
             leave(root, ctx) {
                 const data = ctx.getVisitorData();
                 data.removedCount = 0;
-                let rootComponents = new Set();
+                const rootComponents = new Set();
                 components.forEach((usageInfo) => {
                     const { used, name, componentType } = usageInfo;
                     if (!used && componentType) {

package/lib/rules/oas3/index.js

@@ -39,7 +39,7 @@ const no_undefined_server_variable_1 = require("./no-undefined-server-variable")
 const operation_operationId_1 = require("../common/operation-operationId");
 const operation_summary_1 = require("../common/operation-summary");
 const no_ambiguous_paths_1 = require("../common/no-ambiguous-paths");
-const no_servers_empty_enum_1 = require("./no-servers-empty-enum");
+const no_server_variables_empty_enum_1 = require("./no-server-variables-empty-enum");
 const no_http_verbs_in_paths_1 = require("../common/no-http-verbs-in-paths");
 const request_mime_type_1 = require("./request-mime-type");
 const response_mime_type_1 = require("./response-mime-type");
@@ -90,7 +90,7 @@ exports.rules = {
     'no-identical-paths': no_identical_paths_1.NoIdenticalPaths,
     'no-ambiguous-paths': no_ambiguous_paths_1.NoAmbiguousPaths,
     'no-undefined-server-variable': no_undefined_server_variable_1.NoUndefinedServerVariable,
-    'no-servers-empty-enum': no_servers_empty_enum_1.NoEmptyEnumServers,
+    'no-server-variables-empty-enum': no_server_variables_empty_enum_1.NoServerVariablesEmptyEnum,
     'no-http-verbs-in-paths': no_http_verbs_in_paths_1.NoHttpVerbsInPaths,
     'path-excludes-patterns': path_excludes_patterns_1.PathExcludesPatterns,
     'request-mime-type': request_mime_type_1.RequestMimeType,

package/lib/rules/oas3/no-server-variables-empty-enum.d.ts

@@ -0,0 +1,2 @@
+import { Oas3Rule } from '../../visitors';
+export declare const NoServerVariablesEmptyEnum: Oas3Rule;

package/lib/rules/oas3/{no-servers-empty-enum.js → no-server-variables-empty-enum.js}

@@ -1,12 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NoEmptyEnumServers = void 0;
+exports.NoServerVariablesEmptyEnum = void 0;
 var enumError;
 (function (enumError) {
     enumError["empty"] = "empty";
     enumError["invalidDefaultValue"] = "invalidDefaultValue";
 })(enumError || (enumError = {}));
-const NoEmptyEnumServers = () => {
+const NoServerVariablesEmptyEnum = () => {
     return {
         DefinitionRoot(root, { report, location }) {
             if (!root.servers || root.servers.length === 0)
@@ -43,13 +43,13 @@ const NoEmptyEnumServers = () => {
         },
     };
 };
-exports.NoEmptyEnumServers = NoEmptyEnumServers;
+exports.NoServerVariablesEmptyEnum = NoServerVariablesEmptyEnum;
 function checkEnumVariables(server) {
     var _a;
     if (server.variables && Object.keys(server.variables).length === 0)
         return;
     const errors = [];
-    for (var variable in server.variables) {
+    for (const variable in server.variables) {
         const serverVariable = server.variables[variable];
         if (!serverVariable.enum)
             continue;