@redocly/openapi-core 1.0.0-beta.105 → 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,12 +163,12 @@ 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];
         if (!SEVERITY_NAMES[problem.severity]) {
-            return 'Error not found severity. Please check your config file. Allowed values: \`warn,error,off\`';
+            return 'Error not found severity. Please check your config file. Allowed values: `warn,error,off`';
         }
         const severityName = color(SEVERITY_NAMES[problem.severity].toLowerCase().padEnd(7));
         const { start } = problem.location[0];
@@ -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, LintConfig, 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.LintConfig = 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");
@@ -19,7 +20,7 @@ var stats_1 = require("./rules/other/stats");
 Object.defineProperty(exports, "Stats", { enumerable: true, get: function () { return stats_1.Stats; } });
 var config_1 = require("./config");
 Object.defineProperty(exports, "Config", { enumerable: true, get: function () { return config_1.Config; } });
-Object.defineProperty(exports, "LintConfig", { enumerable: true, get: function () { return config_1.LintConfig; } });
+Object.defineProperty(exports, "StyleguideConfig", { enumerable: true, get: function () { return config_1.StyleguideConfig; } });
 Object.defineProperty(exports, "IGNORE_FILE", { enumerable: true, get: function () { return config_1.IGNORE_FILE; } });
 Object.defineProperty(exports, "getMergedConfig", { enumerable: true, get: function () { return config_1.getMergedConfig; } });
 Object.defineProperty(exports, "transformConfig", { enumerable: true, get: function () { return config_1.transformConfig; } });
@@ -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,16 +2,12 @@
 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({
     implicit: [js_yaml_1.types.merge],
-    explicit: [
-        js_yaml_1.types.binary,
-        js_yaml_1.types.omap,
-        js_yaml_1.types.pairs,
-        js_yaml_1.types.set,
-    ],
+    explicit: [js_yaml_1.types.binary, js_yaml_1.types.omap, js_yaml_1.types.pairs, js_yaml_1.types.set],
 });
 const parseYaml = (str, opts) => js_yaml_1.load(str, Object.assign({ schema: DEFAULT_SCHEMA_WITHOUT_TIMESTAMP }, opts));
 exports.parseYaml = parseYaml;

package/lib/lint.d.ts

@@ -1,7 +1,7 @@
 import { BaseResolver, Document } from './resolve';
 import { NodeType } from './types';
 import { ProblemSeverity } from './walk';
-import { LintConfig, Config } from './config';
+import { StyleguideConfig, Config } from './config';
 export declare function lint(opts: {
     ref: string;
     config: Config;
@@ -15,7 +15,7 @@ export declare function lintFromString(opts: {
 }): Promise<import("./walk").NormalizedProblem[]>;
 export declare function lintDocument(opts: {
     document: Document;
-    config: LintConfig;
+    config: StyleguideConfig;
     customTypes?: Record<string, NodeType>;
     externalRefResolver: BaseResolver;
 }): Promise<import("./walk").NormalizedProblem[]>;

package/lib/lint.js

@@ -26,7 +26,7 @@ function lint(opts) {
     return __awaiter(this, void 0, void 0, function* () {
         const { ref, externalRefResolver = new resolve_1.BaseResolver(opts.config.resolve) } = opts;
         const document = (yield externalRefResolver.resolveDocument(null, ref, true));
-        return lintDocument(Object.assign(Object.assign({ document }, opts), { externalRefResolver, config: opts.config.lint }));
+        return lintDocument(Object.assign(Object.assign({ document }, opts), { externalRefResolver, config: opts.config.styleguide }));
     });
 }
 exports.lint = lint;
@@ -34,7 +34,7 @@ function lintFromString(opts) {
     return __awaiter(this, void 0, void 0, function* () {
         const { source, absoluteRef, externalRefResolver = new resolve_1.BaseResolver(opts.config.resolve) } = opts;
         const document = resolve_1.makeDocumentFromString(source, absoluteRef || '/');
-        return lintDocument(Object.assign(Object.assign({ document }, opts), { externalRefResolver, config: opts.config.lint }));
+        return lintDocument(Object.assign(Object.assign({ document }, opts), { externalRefResolver, config: opts.config.styleguide }));
     });
 }
 exports.lintFromString = lintFromString;
@@ -45,7 +45,11 @@ function lintDocument(opts) {
         const oasVersion = oas_types_1.detectOpenAPI(document.parsed);
         const oasMajorVersion = oas_types_1.openAPIMajor(oasVersion);
         const rules = config.getRulesForOasVersion(oasMajorVersion);
-        const types = types_1.normalizeTypes(config.extendTypes((customTypes !== null && customTypes !== void 0 ? customTypes : oasMajorVersion === oas_types_1.OasMajorVersion.Version3) ? (oasVersion === oas_types_1.OasVersion.Version3_1 ? oas3_1_1.Oas3_1Types : oas3_1.Oas3Types) : oas2_1.Oas2Types, oasVersion), config);
+        const types = types_1.normalizeTypes(config.extendTypes((customTypes !== null && customTypes !== void 0 ? customTypes : oasMajorVersion === oas_types_1.OasMajorVersion.Version3)
+            ? oasVersion === oas_types_1.OasVersion.Version3_1
+                ? oas3_1_1.Oas3_1Types
+                : oas3_1.Oas3Types
+            : oas2_1.Oas2Types, oasVersion), config);
         const ctx = {
             problems: [],
             oasVersion: oasVersion,
@@ -57,7 +61,7 @@ function lintDocument(opts) {
         const resolvedRefMap = yield resolve_1.resolveDocument({
             rootDocument: document,
             rootType: types.DefinitionRoot,
-            externalRefResolver
+            externalRefResolver,
         });
         walk_1.walkDocument({
             document,
@@ -79,12 +83,18 @@ function lintConfig(opts) {
             visitorsData: {},
         };
         const plugins = config_1.resolvePlugins([config_1.defaultPlugin]);
-        const config = new config_1.LintConfig({
+        const config = new config_1.StyleguideConfig({
             plugins,
             rules: { spec: 'error' },
         });
         const types = types_1.normalizeTypes(redocly_yaml_1.ConfigTypes, config);
-        const rules = [{ severity: severity || 'error', ruleId: 'configuration spec', visitor: spec_1.OasSpec({ severity: 'error' }) }];
+        const rules = [
+            {
+                severity: severity || 'error',
+                ruleId: 'configuration spec',
+                visitor: spec_1.OasSpec({ severity: 'error' }),
+            },
+        ];
         const normalizedVisitors = visitors_1.normalizeVisitors(rules, types);
         walk_1.walkDocument({
             document,

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');
             }
@@ -80,7 +85,7 @@ class RegistryApi {
             throw new Error('Could not prepare file upload');
         });
     }
-    pushApi({ organizationId, name, version, rootFilePath, filePaths, branch, isUpsert, isPublic, batchId, batchSize }) {
+    pushApi({ organizationId, name, version, rootFilePath, filePaths, branch, isUpsert, isPublic, batchId, batchSize, }) {
         return __awaiter(this, void 0, void 0, function* () {
             const response = yield this.request(`/${organizationId}/${name}/${version}`, {
                 method: 'PUT',
@@ -95,7 +100,7 @@ class RegistryApi {
                     isUpsert,
                     isPublic,
                     batchId,
-                    batchSize
+                    batchSize,
                 }),
             }, this.region);
             if (response.ok) {

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.d.ts

@@ -2,7 +2,7 @@ import { ErrorObject } from '@redocly/ajv';
 import { Location } from '../ref-utils';
 import { ResolveFn } from '../walk';
 export declare function releaseAjvInstance(): void;
-export declare function validateJsonSchema(data: any, schema: any, schemaLoc: Location, instancePath: string, resolve: ResolveFn, disallowAdditionalProperties: boolean): {
+export declare function validateJsonSchema(data: any, schema: any, schemaLoc: Location, instancePath: string, resolve: ResolveFn, allowAdditionalProperties: boolean): {
     valid: boolean;
     errors: (ErrorObject & {
         suggest?: string[];