@redocly/openapi-core 1.0.0-beta.98 → 1.0.0-rc.1

package/lib/config/config-resolvers.js

@@ -20,62 +20,87 @@ var __rest = (this && this.__rest) || function (s, e) {
     return t;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolvePreset = exports.resolveLint = exports.resolveApis = exports.resolvePlugins = exports.resolveConfig = void 0;
+exports.resolvePreset = exports.resolveStyleguideConfig = exports.resolveApis = exports.resolvePlugins = exports.resolveConfig = void 0;
 const path = require("path");
-const colorette_1 = require("colorette");
 const ref_utils_1 = require("../ref-utils");
+const utils_1 = require("../utils");
 const resolve_1 = require("../resolve");
 const builtIn_1 = require("./builtIn");
-const utils_1 = require("./utils");
-const utils_2 = require("../utils");
+const utils_2 = require("./utils");
+const env_1 = require("../env");
+const utils_3 = require("../utils");
 const config_1 = require("./config");
+const logger_1 = require("../logger");
+const asserts_1 = require("../rules/common/assertions/asserts");
 function resolveConfig(rawConfig, configPath) {
-    var _a, _b, _c, _d, _e;
+    var _a, _b;
     return __awaiter(this, void 0, void 0, function* () {
-        if ((_b = (_a = rawConfig.lint) === null || _a === void 0 ? void 0 : _a.extends) === null || _b === void 0 ? void 0 : _b.some(utils_2.isNotString)) {
+        if ((_b = (_a = rawConfig.styleguide) === null || _a === void 0 ? void 0 : _a.extends) === null || _b === void 0 ? void 0 : _b.some(utils_3.isNotString)) {
             throw new Error(`Error configuration format not detected in extends value must contain strings`);
         }
-        const resolver = new resolve_1.BaseResolver(utils_1.getResolveConfig(rawConfig.resolve));
-        const configExtends = (_d = (_c = rawConfig === null || rawConfig === void 0 ? void 0 : rawConfig.lint) === null || _c === void 0 ? void 0 : _c.extends) !== null && _d !== void 0 ? _d : ['recommended'];
-        const recommendedFallback = !((_e = rawConfig === null || rawConfig === void 0 ? void 0 : rawConfig.lint) === null || _e === void 0 ? void 0 : _e.extends);
-        const lintConfig = Object.assign(Object.assign({}, rawConfig === null || rawConfig === void 0 ? void 0 : rawConfig.lint), { extends: configExtends, recommendedFallback });
+        const resolver = new resolve_1.BaseResolver(utils_2.getResolveConfig(rawConfig.resolve));
         const apis = yield resolveApis({
-            rawConfig: Object.assign(Object.assign({}, rawConfig), { lint: lintConfig }),
+            rawConfig,
             configPath,
             resolver,
         });
-        const lint = yield resolveLint({
-            lintConfig,
+        const styleguide = yield resolveStyleguideConfig({
+            styleguideConfig: rawConfig.styleguide,
             configPath,
             resolver,
         });
         return new config_1.Config(Object.assign(Object.assign({}, rawConfig), { apis,
-            lint }), configPath);
+            styleguide }), configPath);
     });
 }
 exports.resolveConfig = resolveConfig;
 function resolvePlugins(plugins, configPath = '') {
     if (!plugins)
         return [];
-    // @ts-ignore
-    const requireFunc = typeof __webpack_require__ === 'function' ? __non_webpack_require__ : require;
+    // TODO: implement or reuse Resolver approach so it will work in node and browser envs
+    const requireFunc = (plugin) => {
+        if (env_1.isBrowser && utils_3.isString(plugin)) {
+            logger_1.logger.error(`Cannot load ${plugin}. Plugins aren't supported in browser yet.`);
+            return undefined;
+        }
+        if (utils_3.isString(plugin)) {
+            try {
+                const absoltePluginPath = path.resolve(path.dirname(configPath), plugin);
+                // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+                // @ts-ignore
+                return typeof __webpack_require__ === 'function'
+                    ? // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+                        // @ts-ignore
+                        __non_webpack_require__(absoltePluginPath)
+                    : require(absoltePluginPath);
+            }
+            catch (e) {
+                if (e instanceof SyntaxError) {
+                    throw e;
+                }
+                throw new Error(`Failed to load plugin "${plugin}". Please provide a valid path`);
+            }
+        }
+        return plugin;
+    };
     const seenPluginIds = new Map();
     return plugins
         .map((p) => {
-        if (utils_2.isString(p) && ref_utils_1.isAbsoluteUrl(p)) {
-            throw new Error(colorette_1.red(`We don't support remote plugins yet.`));
+        if (utils_3.isString(p) && ref_utils_1.isAbsoluteUrl(p)) {
+            throw new Error(logger_1.colorize.red(`We don't support remote plugins yet.`));
         }
         // TODO: resolve npm packages similar to eslint
-        const pluginModule = utils_2.isString(p)
-            ? requireFunc(path.resolve(path.dirname(configPath), p))
-            : p;
+        const pluginModule = requireFunc(p);
+        if (!pluginModule) {
+            return;
+        }
         const id = pluginModule.id;
         if (typeof id !== 'string') {
-            throw new Error(colorette_1.red(`Plugin must define \`id\` property in ${colorette_1.blue(p.toString())}.`));
+            throw new Error(logger_1.colorize.red(`Plugin must define \`id\` property in ${logger_1.colorize.blue(p.toString())}.`));
         }
         if (seenPluginIds.has(id)) {
             const pluginPath = seenPluginIds.get(id);
-            throw new Error(colorette_1.red(`Plugin "id" must be unique. Plugin ${colorette_1.blue(p.toString())} uses id "${colorette_1.blue(id)}" already seen in ${colorette_1.blue(pluginPath)}`));
+            throw new Error(logger_1.colorize.red(`Plugin "id" must be unique. Plugin ${logger_1.colorize.blue(p.toString())} uses id "${logger_1.colorize.blue(id)}" already seen in ${logger_1.colorize.blue(pluginPath)}`));
         }
         seenPluginIds.set(id, p.toString());
         const plugin = Object.assign(Object.assign({ id }, (pluginModule.configs ? { configs: pluginModule.configs } : {})), (pluginModule.typeExtension ? { typeExtension: pluginModule.typeExtension } : {}));
@@ -85,10 +110,10 @@ function resolvePlugins(plugins, configPath = '') {
             }
             plugin.rules = {};
             if (pluginModule.rules.oas3) {
-                plugin.rules.oas3 = utils_1.prefixRules(pluginModule.rules.oas3, id);
+                plugin.rules.oas3 = utils_2.prefixRules(pluginModule.rules.oas3, id);
             }
             if (pluginModule.rules.oas2) {
-                plugin.rules.oas2 = utils_1.prefixRules(pluginModule.rules.oas2, id);
+                plugin.rules.oas2 = utils_2.prefixRules(pluginModule.rules.oas2, id);
             }
         }
         if (pluginModule.preprocessors) {
@@ -97,10 +122,10 @@ function resolvePlugins(plugins, configPath = '') {
             }
             plugin.preprocessors = {};
             if (pluginModule.preprocessors.oas3) {
-                plugin.preprocessors.oas3 = utils_1.prefixRules(pluginModule.preprocessors.oas3, id);
+                plugin.preprocessors.oas3 = utils_2.prefixRules(pluginModule.preprocessors.oas3, id);
             }
             if (pluginModule.preprocessors.oas2) {
-                plugin.preprocessors.oas2 = utils_1.prefixRules(pluginModule.preprocessors.oas2, id);
+                plugin.preprocessors.oas2 = utils_2.prefixRules(pluginModule.preprocessors.oas2, id);
             }
         }
         if (pluginModule.decorators) {
@@ -109,50 +134,53 @@ function resolvePlugins(plugins, configPath = '') {
             }
             plugin.decorators = {};
             if (pluginModule.decorators.oas3) {
-                plugin.decorators.oas3 = utils_1.prefixRules(pluginModule.decorators.oas3, id);
+                plugin.decorators.oas3 = utils_2.prefixRules(pluginModule.decorators.oas3, id);
             }
             if (pluginModule.decorators.oas2) {
-                plugin.decorators.oas2 = utils_1.prefixRules(pluginModule.decorators.oas2, id);
+                plugin.decorators.oas2 = utils_2.prefixRules(pluginModule.decorators.oas2, id);
             }
         }
+        if (pluginModule.assertions) {
+            plugin.assertions = pluginModule.assertions;
+        }
         return plugin;
     })
-        .filter(utils_2.notUndefined);
+        .filter(utils_3.isDefined);
 }
 exports.resolvePlugins = resolvePlugins;
 function resolveApis({ rawConfig, configPath = '', resolver, }) {
     var _a, _b;
     return __awaiter(this, void 0, void 0, function* () {
-        const { apis = {}, lint: lintConfig = {} } = rawConfig;
-        let resolvedApis = {};
+        const { apis = {}, styleguide: styleguideConfig = {} } = rawConfig;
+        const resolvedApis = {};
         for (const [apiName, apiContent] of Object.entries(apis || {})) {
-            if ((_b = (_a = apiContent.lint) === null || _a === void 0 ? void 0 : _a.extends) === null || _b === void 0 ? void 0 : _b.some(utils_2.isNotString)) {
+            if ((_b = (_a = apiContent.styleguide) === null || _a === void 0 ? void 0 : _a.extends) === null || _b === void 0 ? void 0 : _b.some(utils_3.isNotString)) {
                 throw new Error(`Error configuration format not detected in extends value must contain strings`);
             }
-            const rawLintConfig = getMergedLintRawConfig(lintConfig, apiContent.lint);
-            const apiLint = yield resolveLint({
-                lintConfig: rawLintConfig,
+            const rawStyleguideConfig = getMergedRawStyleguideConfig(styleguideConfig, apiContent.styleguide);
+            const resolvedApiConfig = yield resolveStyleguideConfig({
+                styleguideConfig: rawStyleguideConfig,
                 configPath,
                 resolver,
             });
-            resolvedApis[apiName] = Object.assign(Object.assign({}, apiContent), { lint: apiLint });
+            resolvedApis[apiName] = Object.assign(Object.assign({}, apiContent), { styleguide: resolvedApiConfig });
         }
         return resolvedApis;
     });
 }
 exports.resolveApis = resolveApis;
-function resolveAndMergeNestedLint({ lintConfig, configPath = '', resolver = new resolve_1.BaseResolver(), }, parentConfigPaths = [], extendPaths = []) {
+function resolveAndMergeNestedStyleguideConfig({ styleguideConfig, configPath = '', resolver = new resolve_1.BaseResolver(), }, parentConfigPaths = [], extendPaths = []) {
     var _a, _b, _c;
     return __awaiter(this, void 0, void 0, function* () {
         if (parentConfigPaths.includes(configPath)) {
             throw new Error(`Circular dependency in config file: "${configPath}"`);
         }
-        const plugins = utils_1.getUniquePlugins(resolvePlugins([...((lintConfig === null || lintConfig === void 0 ? void 0 : lintConfig.plugins) || []), builtIn_1.defaultPlugin], configPath));
-        const pluginPaths = (_a = lintConfig === null || lintConfig === void 0 ? void 0 : lintConfig.plugins) === null || _a === void 0 ? void 0 : _a.filter(utils_2.isString).map((p) => path.resolve(path.dirname(configPath), p));
+        const plugins = utils_2.getUniquePlugins(resolvePlugins([...((styleguideConfig === null || styleguideConfig === void 0 ? void 0 : styleguideConfig.plugins) || []), builtIn_1.defaultPlugin], configPath));
+        const pluginPaths = (_a = styleguideConfig === null || styleguideConfig === void 0 ? void 0 : styleguideConfig.plugins) === null || _a === void 0 ? void 0 : _a.filter(utils_3.isString).map((p) => path.resolve(path.dirname(configPath), p));
         const resolvedConfigPath = ref_utils_1.isAbsoluteUrl(configPath)
             ? configPath
             : configPath && path.resolve(configPath);
-        const extendConfigs = yield Promise.all(((_b = lintConfig === null || lintConfig === void 0 ? void 0 : lintConfig.extends) === null || _b === void 0 ? void 0 : _b.map((presetItem) => __awaiter(this, void 0, void 0, function* () {
+        const extendConfigs = yield Promise.all(((_b = styleguideConfig === null || styleguideConfig === void 0 ? void 0 : styleguideConfig.extends) === null || _b === void 0 ? void 0 : _b.map((presetItem) => __awaiter(this, void 0, void 0, function* () {
             if (!ref_utils_1.isAbsoluteUrl(presetItem) && !path.extname(presetItem)) {
                 return resolvePreset(presetItem, plugins);
             }
@@ -161,63 +189,65 @@ function resolveAndMergeNestedLint({ lintConfig, configPath = '', resolver = new
                 : ref_utils_1.isAbsoluteUrl(configPath)
                     ? new URL(presetItem, configPath).href
                     : path.resolve(path.dirname(configPath), presetItem);
-            const extendedLintConfig = yield loadExtendLintConfig(pathItem, resolver);
-            return yield resolveAndMergeNestedLint({
-                lintConfig: extendedLintConfig,
+            const extendedStyleguideConfig = yield loadExtendStyleguideConfig(pathItem, resolver);
+            return yield resolveAndMergeNestedStyleguideConfig({
+                styleguideConfig: extendedStyleguideConfig,
                 configPath: pathItem,
                 resolver: resolver,
             }, [...parentConfigPaths, resolvedConfigPath], extendPaths);
         }))) || []);
-        const _d = utils_1.mergeExtends([
+        const _d = utils_2.mergeExtends([
             ...extendConfigs,
-            Object.assign(Object.assign({}, lintConfig), { plugins, extends: undefined, extendPaths: [...parentConfigPaths, resolvedConfigPath], pluginPaths }),
-        ]), { plugins: mergedPlugins = [] } = _d, lint = __rest(_d, ["plugins"]);
-        return Object.assign(Object.assign({}, lint), { extendPaths: (_c = lint.extendPaths) === null || _c === void 0 ? void 0 : _c.filter((path) => path && !ref_utils_1.isAbsoluteUrl(path)), plugins: utils_1.getUniquePlugins(mergedPlugins), recommendedFallback: lintConfig === null || lintConfig === void 0 ? void 0 : lintConfig.recommendedFallback, doNotResolveExamples: lintConfig === null || lintConfig === void 0 ? void 0 : lintConfig.doNotResolveExamples });
+            Object.assign(Object.assign({}, styleguideConfig), { plugins, extends: undefined, extendPaths: [...parentConfigPaths, resolvedConfigPath], pluginPaths }),
+        ]), { plugins: mergedPlugins = [] } = _d, styleguide = __rest(_d, ["plugins"]);
+        return Object.assign(Object.assign({}, styleguide), { extendPaths: (_c = styleguide.extendPaths) === null || _c === void 0 ? void 0 : _c.filter((path) => path && !ref_utils_1.isAbsoluteUrl(path)), plugins: utils_2.getUniquePlugins(mergedPlugins), recommendedFallback: styleguideConfig === null || styleguideConfig === void 0 ? void 0 : styleguideConfig.recommendedFallback, doNotResolveExamples: styleguideConfig === null || styleguideConfig === void 0 ? void 0 : styleguideConfig.doNotResolveExamples });
     });
 }
-function resolveLint(lintOpts, parentConfigPaths = [], extendPaths = []) {
+function resolveStyleguideConfig(opts, parentConfigPaths = [], extendPaths = []) {
     return __awaiter(this, void 0, void 0, function* () {
-        const resolvedLint = yield resolveAndMergeNestedLint(lintOpts, parentConfigPaths, extendPaths);
-        return Object.assign(Object.assign({}, resolvedLint), { rules: resolvedLint.rules && groupLintAssertionRules(resolvedLint.rules) });
+        const resolvedStyleguideConfig = yield resolveAndMergeNestedStyleguideConfig(opts, parentConfigPaths, extendPaths);
+        return Object.assign(Object.assign({}, resolvedStyleguideConfig), { rules: resolvedStyleguideConfig.rules && groupStyleguideAssertionRules(resolvedStyleguideConfig) });
     });
 }
-exports.resolveLint = resolveLint;
+exports.resolveStyleguideConfig = resolveStyleguideConfig;
 function resolvePreset(presetName, plugins) {
     var _a;
-    const { pluginId, configName } = utils_1.parsePresetName(presetName);
+    const { pluginId, configName } = utils_2.parsePresetName(presetName);
     const plugin = plugins.find((p) => p.id === pluginId);
     if (!plugin) {
-        throw new Error(`Invalid config ${colorette_1.red(presetName)}: plugin ${pluginId} is not included.`);
+        throw new Error(`Invalid config ${logger_1.colorize.red(presetName)}: plugin ${pluginId} is not included.`);
     }
     const preset = (_a = plugin.configs) === null || _a === void 0 ? void 0 : _a[configName];
     if (!preset) {
         throw new Error(pluginId
-            ? `Invalid config ${colorette_1.red(presetName)}: plugin ${pluginId} doesn't export config with name ${configName}.`
-            : `Invalid config ${colorette_1.red(presetName)}: there is no such built-in config.`);
+            ? `Invalid config ${logger_1.colorize.red(presetName)}: plugin ${pluginId} doesn't export config with name ${configName}.`
+            : `Invalid config ${logger_1.colorize.red(presetName)}: there is no such built-in config.`);
     }
     return preset;
 }
 exports.resolvePreset = resolvePreset;
-function loadExtendLintConfig(filePath, resolver) {
+function loadExtendStyleguideConfig(filePath, resolver) {
     return __awaiter(this, void 0, void 0, function* () {
         try {
             const fileSource = yield resolver.loadExternalRef(filePath);
-            const rawConfig = utils_1.transformConfig(utils_2.parseYaml(fileSource.body));
-            if (!rawConfig.lint) {
-                throw new Error(`Lint configuration format not detected: "${filePath}"`);
+            const rawConfig = utils_2.transformConfig(utils_3.parseYaml(fileSource.body));
+            if (!rawConfig.styleguide) {
+                throw new Error(`Styleguide configuration format not detected: "${filePath}"`);
             }
-            return rawConfig.lint;
+            return rawConfig.styleguide;
         }
         catch (error) {
             throw new Error(`Failed to load "${filePath}": ${error.message}`);
         }
     });
 }
-function getMergedLintRawConfig(configLint, apiLint) {
-    const resultLint = Object.assign(Object.assign(Object.assign({}, configLint), apiLint), { rules: Object.assign(Object.assign({}, configLint === null || configLint === void 0 ? void 0 : configLint.rules), apiLint === null || apiLint === void 0 ? void 0 : apiLint.rules), oas2Rules: Object.assign(Object.assign({}, configLint === null || configLint === void 0 ? void 0 : configLint.oas2Rules), apiLint === null || apiLint === void 0 ? void 0 : apiLint.oas2Rules), oas3_0Rules: Object.assign(Object.assign({}, configLint === null || configLint === void 0 ? void 0 : configLint.oas3_0Rules), apiLint === null || apiLint === void 0 ? void 0 : apiLint.oas3_0Rules), oas3_1Rules: Object.assign(Object.assign({}, configLint === null || configLint === void 0 ? void 0 : configLint.oas3_1Rules), apiLint === null || apiLint === void 0 ? void 0 : apiLint.oas3_1Rules), preprocessors: Object.assign(Object.assign({}, configLint === null || configLint === void 0 ? void 0 : configLint.preprocessors), apiLint === null || apiLint === void 0 ? void 0 : apiLint.preprocessors), oas2Preprocessors: Object.assign(Object.assign({}, configLint === null || configLint === void 0 ? void 0 : configLint.oas2Preprocessors), apiLint === null || apiLint === void 0 ? void 0 : apiLint.oas2Preprocessors), oas3_0Preprocessors: Object.assign(Object.assign({}, configLint === null || configLint === void 0 ? void 0 : configLint.oas3_0Preprocessors), apiLint === null || apiLint === void 0 ? void 0 : apiLint.oas3_0Preprocessors), oas3_1Preprocessors: Object.assign(Object.assign({}, configLint === null || configLint === void 0 ? void 0 : configLint.oas3_1Preprocessors), apiLint === null || apiLint === void 0 ? void 0 : apiLint.oas3_1Preprocessors), decorators: Object.assign(Object.assign({}, configLint === null || configLint === void 0 ? void 0 : configLint.decorators), apiLint === null || apiLint === void 0 ? void 0 : apiLint.decorators), oas2Decorators: Object.assign(Object.assign({}, configLint === null || configLint === void 0 ? void 0 : configLint.oas2Decorators), apiLint === null || apiLint === void 0 ? void 0 : apiLint.oas2Decorators), oas3_0Decorators: Object.assign(Object.assign({}, configLint === null || configLint === void 0 ? void 0 : configLint.oas3_0Decorators), apiLint === null || apiLint === void 0 ? void 0 : apiLint.oas3_0Decorators), oas3_1Decorators: Object.assign(Object.assign({}, configLint === null || configLint === void 0 ? void 0 : configLint.oas3_1Decorators), apiLint === null || apiLint === void 0 ? void 0 : apiLint.oas3_1Decorators), recommendedFallback: (apiLint === null || apiLint === void 0 ? void 0 : apiLint.extends) ? false : configLint.recommendedFallback });
+function getMergedRawStyleguideConfig(rootStyleguideConfig, apiStyleguideConfig) {
+    const resultLint = Object.assign(Object.assign(Object.assign({}, rootStyleguideConfig), utils_1.pickDefined(apiStyleguideConfig)), { rules: Object.assign(Object.assign({}, rootStyleguideConfig === null || rootStyleguideConfig === void 0 ? void 0 : rootStyleguideConfig.rules), apiStyleguideConfig === null || apiStyleguideConfig === void 0 ? void 0 : apiStyleguideConfig.rules), oas2Rules: Object.assign(Object.assign({}, rootStyleguideConfig === null || rootStyleguideConfig === void 0 ? void 0 : rootStyleguideConfig.oas2Rules), apiStyleguideConfig === null || apiStyleguideConfig === void 0 ? void 0 : apiStyleguideConfig.oas2Rules), oas3_0Rules: Object.assign(Object.assign({}, rootStyleguideConfig === null || rootStyleguideConfig === void 0 ? void 0 : rootStyleguideConfig.oas3_0Rules), apiStyleguideConfig === null || apiStyleguideConfig === void 0 ? void 0 : apiStyleguideConfig.oas3_0Rules), oas3_1Rules: Object.assign(Object.assign({}, rootStyleguideConfig === null || rootStyleguideConfig === void 0 ? void 0 : rootStyleguideConfig.oas3_1Rules), apiStyleguideConfig === null || apiStyleguideConfig === void 0 ? void 0 : apiStyleguideConfig.oas3_1Rules), preprocessors: Object.assign(Object.assign({}, rootStyleguideConfig === null || rootStyleguideConfig === void 0 ? void 0 : rootStyleguideConfig.preprocessors), apiStyleguideConfig === null || apiStyleguideConfig === void 0 ? void 0 : apiStyleguideConfig.preprocessors), oas2Preprocessors: Object.assign(Object.assign({}, rootStyleguideConfig === null || rootStyleguideConfig === void 0 ? void 0 : rootStyleguideConfig.oas2Preprocessors), apiStyleguideConfig === null || apiStyleguideConfig === void 0 ? void 0 : apiStyleguideConfig.oas2Preprocessors), oas3_0Preprocessors: Object.assign(Object.assign({}, rootStyleguideConfig === null || rootStyleguideConfig === void 0 ? void 0 : rootStyleguideConfig.oas3_0Preprocessors), apiStyleguideConfig === null || apiStyleguideConfig === void 0 ? void 0 : apiStyleguideConfig.oas3_0Preprocessors), oas3_1Preprocessors: Object.assign(Object.assign({}, rootStyleguideConfig === null || rootStyleguideConfig === void 0 ? void 0 : rootStyleguideConfig.oas3_1Preprocessors), apiStyleguideConfig === null || apiStyleguideConfig === void 0 ? void 0 : apiStyleguideConfig.oas3_1Preprocessors), decorators: Object.assign(Object.assign({}, rootStyleguideConfig === null || rootStyleguideConfig === void 0 ? void 0 : rootStyleguideConfig.decorators), apiStyleguideConfig === null || apiStyleguideConfig === void 0 ? void 0 : apiStyleguideConfig.decorators), oas2Decorators: Object.assign(Object.assign({}, rootStyleguideConfig === null || rootStyleguideConfig === void 0 ? void 0 : rootStyleguideConfig.oas2Decorators), apiStyleguideConfig === null || apiStyleguideConfig === void 0 ? void 0 : apiStyleguideConfig.oas2Decorators), oas3_0Decorators: Object.assign(Object.assign({}, rootStyleguideConfig === null || rootStyleguideConfig === void 0 ? void 0 : rootStyleguideConfig.oas3_0Decorators), apiStyleguideConfig === null || apiStyleguideConfig === void 0 ? void 0 : apiStyleguideConfig.oas3_0Decorators), oas3_1Decorators: Object.assign(Object.assign({}, rootStyleguideConfig === null || rootStyleguideConfig === void 0 ? void 0 : rootStyleguideConfig.oas3_1Decorators), apiStyleguideConfig === null || apiStyleguideConfig === void 0 ? void 0 : apiStyleguideConfig.oas3_1Decorators), recommendedFallback: (apiStyleguideConfig === null || apiStyleguideConfig === void 0 ? void 0 : apiStyleguideConfig.extends)
+            ? false
+            : rootStyleguideConfig.recommendedFallback });
     return resultLint;
 }
-function groupLintAssertionRules(rules) {
+function groupStyleguideAssertionRules({ rules, plugins, }) {
     if (!rules) {
         return rules;
     }
@@ -226,9 +256,19 @@ function groupLintAssertionRules(rules) {
     // Collect assertion rules
     const assertions = [];
     for (const [ruleKey, rule] of Object.entries(rules)) {
-        if (ruleKey.startsWith('assert/') && typeof rule === 'object' && rule !== null) {
+        // keep the old assert/ syntax as an alias
+        if ((ruleKey.startsWith('rule/') || ruleKey.startsWith('assert/')) &&
+            typeof rule === 'object' &&
+            rule !== null) {
             const assertion = rule;
-            assertions.push(Object.assign(Object.assign({}, assertion), { assertionId: ruleKey.replace('assert/', '') }));
+            if (plugins) {
+                registerCustomAssertions(plugins, assertion);
+                // We may have custom assertion inside where block
+                for (const context of assertion.where || []) {
+                    registerCustomAssertions(plugins, context);
+                }
+            }
+            assertions.push(Object.assign(Object.assign({}, assertion), { assertionId: ruleKey }));
         }
         else {
             // If it's not an assertion, keep it as is
@@ -240,3 +280,18 @@ function groupLintAssertionRules(rules) {
     }
     return transformedRules;
 }
+function registerCustomAssertions(plugins, assertion) {
+    for (const field of utils_3.keysOf(assertion.assertions)) {
+        const [pluginId, fn] = field.split('/');
+        if (!pluginId || !fn)
+            continue;
+        const plugin = plugins.find((plugin) => plugin.id === pluginId);
+        if (!plugin) {
+            throw Error(logger_1.colorize.red(`Plugin ${logger_1.colorize.blue(pluginId)} isn't found.`));
+        }
+        if (!plugin.assertions || !plugin.assertions[fn]) {
+            throw Error(`Plugin ${logger_1.colorize.red(pluginId)} doesn't export assertions function with name ${logger_1.colorize.red(fn)}.`);
+        }
+        asserts_1.asserts[field] = asserts_1.buildAssertCustomFunction(plugin.assertions[fn]);
+    }
+}

package/lib/config/config.d.ts

@@ -1,9 +1,7 @@
-/// <reference types="node" />
 import { NormalizedProblem } from '../walk';
 import { OasVersion, OasMajorVersion, Oas2RuleSet, Oas3RuleSet } from '../oas-types';
 import type { NodeType } from '../types';
-import type { DecoratorConfig, Plugin, PreprocessorConfig, Region, ResolveConfig, ResolvedApi, ResolvedConfig, ResolvedLintConfig, RuleConfig } from './types';
-export declare const env: NodeJS.ProcessEnv;
+import type { DecoratorConfig, Plugin, PreprocessorConfig, Region, ResolveConfig, ResolvedApi, ResolvedConfig, ResolvedStyleguideConfig, RuleConfig, RuleSettings, Telemetry, ThemeRawConfig } from './types';
 export declare const IGNORE_FILE = ".redocly.lint-ignore.yaml";
 export declare const DEFAULT_REGION = "us";
 export declare const DOMAINS: {
@@ -11,8 +9,8 @@ export declare const DOMAINS: {
     eu: string;
 };
 export declare const AVAILABLE_REGIONS: Region[];
-export declare class LintConfig {
-    rawConfig: ResolvedLintConfig;
+export declare class StyleguideConfig {
+    rawConfig: ResolvedStyleguideConfig;
     configFile?: string | undefined;
     plugins: Plugin[];
     ignore: Record<string, Record<string, Set<string>>>;
@@ -25,20 +23,15 @@ export declare class LintConfig {
     recommendedFallback: boolean;
     extendPaths: string[];
     pluginPaths: string[];
-    constructor(rawConfig: ResolvedLintConfig, configFile?: string | undefined);
+    constructor(rawConfig: ResolvedStyleguideConfig, configFile?: string | undefined);
+    resolveIgnore(ignoreFile?: string): void;
     saveIgnore(): void;
     addIgnore(problem: NormalizedProblem): void;
     addProblemToIgnore(problem: NormalizedProblem): NormalizedProblem;
     extendTypes(types: Record<string, NodeType>, version: OasVersion): Record<string, NodeType>;
-    getRuleSettings(ruleId: string, oasVersion: OasVersion): {
-        severity: import("../walk").ProblemSeverity | "off";
-    };
-    getPreprocessorSettings(ruleId: string, oasVersion: OasVersion): {
-        severity: import("../walk").ProblemSeverity | "off";
-    };
-    getDecoratorSettings(ruleId: string, oasVersion: OasVersion): {
-        severity: import("../walk").ProblemSeverity | "off";
-    };
+    getRuleSettings(ruleId: string, oasVersion: OasVersion): RuleSettings;
+    getPreprocessorSettings(ruleId: string, oasVersion: OasVersion): RuleSettings;
+    getDecoratorSettings(ruleId: string, oasVersion: OasVersion): RuleSettings;
     getUnusedRules(): {
         rules: string[];
         preprocessors: string[];
@@ -53,12 +46,13 @@ export declare class Config {
     rawConfig: ResolvedConfig;
     configFile?: string | undefined;
     apis: Record<string, ResolvedApi>;
-    lint: LintConfig;
+    styleguide: StyleguideConfig;
     resolve: ResolveConfig;
     licenseKey?: string;
     region?: Region;
-    'features.openapi': Record<string, any>;
-    'features.mockServer'?: Record<string, any>;
+    theme: ThemeRawConfig;
     organization?: string;
+    files: string[];
+    telemetry?: Telemetry;
     constructor(rawConfig: ResolvedConfig, configFile?: string | undefined);
 }

package/lib/config/config.js

@@ -1,14 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Config = exports.LintConfig = exports.AVAILABLE_REGIONS = exports.DOMAINS = exports.DEFAULT_REGION = exports.IGNORE_FILE = exports.env = void 0;
+exports.Config = exports.StyleguideConfig = exports.AVAILABLE_REGIONS = exports.DOMAINS = exports.DEFAULT_REGION = exports.IGNORE_FILE = void 0;
 const fs = require("fs");
 const path = require("path");
 const js_yaml_1 = require("../js-yaml");
 const utils_1 = require("../utils");
 const oas_types_1 = require("../oas-types");
+const env_1 = require("../env");
 const utils_2 = require("./utils");
-// Alias environment here so this file can work in browser environments too.
-exports.env = typeof process !== 'undefined' ? process.env || {} : {};
+const ref_utils_1 = require("../ref-utils");
 exports.IGNORE_FILE = '.redocly.lint-ignore.yaml';
 const IGNORE_BANNER = `# This file instructs Redocly's linter to ignore the rules contained for specific parts of your API.\n` +
     `# See https://redoc.ly/docs/cli/ for more information.\n`;
@@ -19,7 +19,7 @@ function getDomains() {
         eu: 'eu.redocly.com',
     };
     // FIXME: temporary fix for our lab environments
-    const domain = exports.env.REDOCLY_DOMAIN;
+    const domain = env_1.env.REDOCLY_DOMAIN;
     if (domain === null || domain === void 0 ? void 0 : domain.endsWith('.redocly.host')) {
         domains[domain.split('.')[0]] = domain;
     }
@@ -28,9 +28,19 @@ function getDomains() {
     }
     return domains;
 }
+function getIgnoreFilePath(configFile) {
+    if (configFile) {
+        return utils_1.doesYamlFileExist(configFile)
+            ? path.join(path.dirname(configFile), exports.IGNORE_FILE)
+            : path.join(configFile, exports.IGNORE_FILE);
+    }
+    else {
+        return env_1.isBrowser ? undefined : path.join(process.cwd(), exports.IGNORE_FILE);
+    }
+}
 exports.DOMAINS = getDomains();
 exports.AVAILABLE_REGIONS = Object.keys(exports.DOMAINS);
-class LintConfig {
+class StyleguideConfig {
     constructor(rawConfig, configFile) {
         this.rawConfig = rawConfig;
         this.configFile = configFile;
@@ -57,21 +67,20 @@ class LintConfig {
         };
         this.extendPaths = rawConfig.extendPaths || [];
         this.pluginPaths = rawConfig.pluginPaths || [];
-        const dir = this.configFile
-            ? path.dirname(this.configFile)
-            : (typeof process !== 'undefined' && process.cwd()) || '';
-        const ignoreFile = path.join(dir, exports.IGNORE_FILE);
-        /* no crash when using it on the client */
-        if (fs.hasOwnProperty('existsSync') && fs.existsSync(ignoreFile)) {
-            // TODO: parse errors
-            this.ignore =
-                js_yaml_1.parseYaml(fs.readFileSync(ignoreFile, 'utf-8')) || {};
-            // resolve ignore paths
-            for (const fileName of Object.keys(this.ignore)) {
-                this.ignore[path.resolve(path.dirname(ignoreFile), fileName)] = this.ignore[fileName];
-                for (const ruleId of Object.keys(this.ignore[fileName])) {
-                    this.ignore[fileName][ruleId] = new Set(this.ignore[fileName][ruleId]);
-                }
+        this.resolveIgnore(getIgnoreFilePath(configFile));
+    }
+    resolveIgnore(ignoreFile) {
+        if (!ignoreFile || !utils_1.doesYamlFileExist(ignoreFile))
+            return;
+        this.ignore =
+            js_yaml_1.parseYaml(fs.readFileSync(ignoreFile, 'utf-8')) || {};
+        // resolve ignore paths
+        for (const fileName of Object.keys(this.ignore)) {
+            this.ignore[ref_utils_1.isAbsoluteUrl(fileName) ? fileName : path.resolve(path.dirname(ignoreFile), fileName)] = this.ignore[fileName];
+            for (const ruleId of Object.keys(this.ignore[fileName])) {
+                this.ignore[fileName][ruleId] = new Set(this.ignore[fileName][ruleId]);
+            }
+            if (!ref_utils_1.isAbsoluteUrl(fileName)) {
                 delete this.ignore[fileName];
             }
         }
@@ -81,8 +90,10 @@ class LintConfig {
         const ignoreFile = path.join(dir, exports.IGNORE_FILE);
         const mapped = {};
         for (const absFileName of Object.keys(this.ignore)) {
-            const ignoredRules = (mapped[utils_1.slash(path.relative(dir, absFileName))] =
-                this.ignore[absFileName]);
+            const mappedDefinitionName = ref_utils_1.isAbsoluteUrl(absFileName)
+                ? absFileName
+                : utils_1.slash(path.relative(dir, absFileName));
+            const ignoredRules = (mapped[mappedDefinitionName] = this.ignore[absFileName]);
             for (const ruleId of Object.keys(ignoredRules)) {
                 ignoredRules[ruleId] = Array.from(ignoredRules[ruleId]);
             }
@@ -118,10 +129,12 @@ class LintConfig {
                         if (!plugin.typeExtension.oas3)
                             continue;
                         extendedTypes = plugin.typeExtension.oas3(extendedTypes, version);
+                        break;
                     case oas_types_1.OasVersion.Version2:
                         if (!plugin.typeExtension.oas2)
                             continue;
                         extendedTypes = plugin.typeExtension.oas2(extendedTypes, version);
+                        break;
                     default:
                         throw new Error('Not implemented');
                 }
@@ -186,12 +199,14 @@ class LintConfig {
     getRulesForOasVersion(version) {
         switch (version) {
             case oas_types_1.OasMajorVersion.Version3:
+                // eslint-disable-next-line no-case-declarations
                 const oas3Rules = []; // default ruleset
                 this.plugins.forEach((p) => { var _a; return ((_a = p.preprocessors) === null || _a === void 0 ? void 0 : _a.oas3) && oas3Rules.push(p.preprocessors.oas3); });
                 this.plugins.forEach((p) => { var _a; return ((_a = p.rules) === null || _a === void 0 ? void 0 : _a.oas3) && oas3Rules.push(p.rules.oas3); });
                 this.plugins.forEach((p) => { var _a; return ((_a = p.decorators) === null || _a === void 0 ? void 0 : _a.oas3) && oas3Rules.push(p.decorators.oas3); });
                 return oas3Rules;
             case oas_types_1.OasMajorVersion.Version2:
+                // eslint-disable-next-line no-case-declarations
                 const oas2Rules = []; // default ruleset
                 this.plugins.forEach((p) => { var _a; return ((_a = p.preprocessors) === null || _a === void 0 ? void 0 : _a.oas2) && oas2Rules.push(p.preprocessors.oas2); });
                 this.plugins.forEach((p) => { var _a; return ((_a = p.rules) === null || _a === void 0 ? void 0 : _a.oas2) && oas2Rules.push(p.rules.oas2); });
@@ -227,18 +242,19 @@ class LintConfig {
         }
     }
 }
-exports.LintConfig = LintConfig;
+exports.StyleguideConfig = StyleguideConfig;
 class Config {
     constructor(rawConfig, configFile) {
         this.rawConfig = rawConfig;
         this.configFile = configFile;
         this.apis = rawConfig.apis || {};
-        this.lint = new LintConfig(rawConfig.lint || {}, configFile);
-        this['features.openapi'] = rawConfig['features.openapi'] || {};
-        this['features.mockServer'] = rawConfig['features.mockServer'] || {};
+        this.styleguide = new StyleguideConfig(rawConfig.styleguide || {}, configFile);
+        this.theme = rawConfig.theme || {};
         this.resolve = utils_2.getResolveConfig(rawConfig === null || rawConfig === void 0 ? void 0 : rawConfig.resolve);
         this.region = rawConfig.region;
         this.organization = rawConfig.organization;
+        this.files = rawConfig.files || [];
+        this.telemetry = rawConfig.telemetry;
     }
 }
 exports.Config = Config;

package/lib/config/load.d.ts

@@ -1,6 +1,19 @@
 import { Config } from './config';
-import type { RawConfig } from './types';
-export declare function loadConfig(configPath?: string | undefined, customExtends?: string[]): Promise<Config>;
+import type { RawConfig, Region } from './types';
+import { RegionalTokenWithValidity } from '../redocly/redocly-client-types';
+export declare function loadConfig(options?: {
+    configPath?: string;
+    customExtends?: string[];
+    processRawConfig?: (rawConfig: RawConfig) => void | Promise<void>;
+    files?: string[];
+    region?: Region;
+}): Promise<Config>;
 export declare const CONFIG_FILE_NAMES: string[];
 export declare function findConfig(dir?: string): string | undefined;
-export declare function getConfig(configPath?: string | undefined): Promise<RawConfig>;
+export declare function getConfig(configPath?: string | undefined, processRawConfig?: (rawConfig: RawConfig) => void | Promise<void>): Promise<RawConfig>;
+declare type CreateConfigOptions = {
+    extends?: string[];
+    tokens?: RegionalTokenWithValidity[];
+};
+export declare function createConfig(config: string | RawConfig, options?: CreateConfigOptions): Promise<Config>;
+export {};