@redocly/openapi-core 1.0.0-beta.110 → 1.0.0-beta.112

package/lib/config/all.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = {
     rules: {
-        'info-description': 'error',
         'info-contact': 'error',
         'info-license': 'error',
         'info-license-url': 'error',

package/lib/config/config-resolvers.js

@@ -23,21 +23,22 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.resolvePreset = exports.resolveStyleguideConfig = exports.resolveApis = exports.resolvePlugins = exports.resolveConfig = void 0;
 const path = require("path");
 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 env_1 = require("../env");
-const utils_2 = require("../utils");
+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;
     return __awaiter(this, void 0, void 0, function* () {
-        if ((_b = (_a = rawConfig.styleguide) === 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 resolver = new resolve_1.BaseResolver(utils_2.getResolveConfig(rawConfig.resolve));
         const configExtends = (_d = (_c = rawConfig === null || rawConfig === void 0 ? void 0 : rawConfig.styleguide) === 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.styleguide) === null || _e === void 0 ? void 0 : _e.extends);
         const styleguideConfig = Object.assign(Object.assign({}, rawConfig === null || rawConfig === void 0 ? void 0 : rawConfig.styleguide), { extends: configExtends, recommendedFallback });
@@ -61,11 +62,11 @@ function resolvePlugins(plugins, configPath = '') {
         return [];
     // TODO: implement or reuse Resolver approach so it will work in node and browser envs
     const requireFunc = (plugin) => {
-        if (env_1.isBrowser && utils_2.isString(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_2.isString(plugin)) {
+        if (utils_3.isString(plugin)) {
             const absoltePluginPath = path.resolve(path.dirname(configPath), plugin);
             // eslint-disable-next-line @typescript-eslint/ban-ts-comment
             // @ts-ignore
@@ -80,7 +81,7 @@ function resolvePlugins(plugins, configPath = '') {
     const seenPluginIds = new Map();
     return plugins
         .map((p) => {
-        if (utils_2.isString(p) && ref_utils_1.isAbsoluteUrl(p)) {
+        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
@@ -104,10 +105,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) {
@@ -116,10 +117,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) {
@@ -128,10 +129,10 @@ 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) {
@@ -139,7 +140,7 @@ function resolvePlugins(plugins, configPath = '') {
         }
         return plugin;
     })
-        .filter(utils_2.isDefined);
+        .filter(utils_3.isDefined);
 }
 exports.resolvePlugins = resolvePlugins;
 function resolveApis({ rawConfig, configPath = '', resolver, }) {
@@ -148,7 +149,7 @@ function resolveApis({ rawConfig, configPath = '', resolver, }) {
         const { apis = {}, styleguide: styleguideConfig = {} } = rawConfig;
         const resolvedApis = {};
         for (const [apiName, apiContent] of Object.entries(apis || {})) {
-            if ((_b = (_a = apiContent.styleguide) === 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 rawStyleguideConfig = getMergedRawStyleguideConfig(styleguideConfig, apiContent.styleguide);
@@ -169,8 +170,8 @@ function resolveAndMergeNestedStyleguideConfig({ styleguideConfig, configPath =
         if (parentConfigPaths.includes(configPath)) {
             throw new Error(`Circular dependency in config file: "${configPath}"`);
         }
-        const plugins = utils_1.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_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);
@@ -190,11 +191,11 @@ function resolveAndMergeNestedStyleguideConfig({ styleguideConfig, configPath =
                 resolver: resolver,
             }, [...parentConfigPaths, resolvedConfigPath], extendPaths);
         }))) || []);
-        const _d = utils_1.mergeExtends([
+        const _d = utils_2.mergeExtends([
             ...extendConfigs,
             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_1.getUniquePlugins(mergedPlugins), recommendedFallback: styleguideConfig === null || styleguideConfig === void 0 ? void 0 : styleguideConfig.recommendedFallback, doNotResolveExamples: styleguideConfig === null || styleguideConfig === void 0 ? void 0 : styleguideConfig.doNotResolveExamples });
+        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 resolveStyleguideConfig(opts, parentConfigPaths = [], extendPaths = []) {
@@ -206,7 +207,7 @@ function resolveStyleguideConfig(opts, parentConfigPaths = [], extendPaths = [])
 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 ${logger_1.colorize.red(presetName)}: plugin ${pluginId} is not included.`);
@@ -224,7 +225,7 @@ 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));
+            const rawConfig = utils_2.transformConfig(utils_3.parseYaml(fileSource.body));
             if (!rawConfig.styleguide) {
                 throw new Error(`Styleguide configuration format not detected: "${filePath}"`);
             }
@@ -236,7 +237,7 @@ function loadExtendStyleguideConfig(filePath, resolver) {
     });
 }
 function getMergedRawStyleguideConfig(rootStyleguideConfig, apiStyleguideConfig) {
-    const resultLint = Object.assign(Object.assign(Object.assign({}, rootStyleguideConfig), 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)
+    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;
@@ -253,18 +254,10 @@ function groupStyleguideAssertionRules({ rules, plugins, }) {
         if (ruleKey.startsWith('assert/') && typeof rule === 'object' && rule !== null) {
             const assertion = rule;
             if (plugins) {
-                for (const field of Object.keys(assertion)) {
-                    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]);
+                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.replace('assert/', '') }));
@@ -279,3 +272,18 @@ function groupStyleguideAssertionRules({ rules, plugins, }) {
     }
     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/load.d.ts

@@ -10,7 +10,7 @@ export declare function loadConfig(options?: {
 }): 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[];

package/lib/config/load.js

@@ -62,11 +62,8 @@ function addConfigMetadata({ rawConfig, customExtends, configPath, tokens, }) {
 function loadConfig(options = {}) {
     return __awaiter(this, void 0, void 0, function* () {
         const { configPath = findConfig(), customExtends, processRawConfig, files, region } = options;
-        const config = yield getConfig(configPath);
+        const config = yield getConfig(configPath, processRawConfig);
         const rawConfig = Object.assign(Object.assign({}, config), { files: files !== null && files !== void 0 ? files : config.files, region: region !== null && region !== void 0 ? region : config.region });
-        if (typeof processRawConfig === 'function') {
-            yield processRawConfig(rawConfig);
-        }
         const redoclyClient = new redocly_1.RedoclyClient();
         const tokens = yield redoclyClient.getTokens();
         return addConfigMetadata({
@@ -93,12 +90,15 @@ function findConfig(dir) {
     return existingConfigFiles[0];
 }
 exports.findConfig = findConfig;
-function getConfig(configPath = findConfig()) {
+function getConfig(configPath = findConfig(), processRawConfig) {
     return __awaiter(this, void 0, void 0, function* () {
         if (!configPath || !utils_1.doesYamlFileExist(configPath))
             return {};
         try {
             const rawConfig = (yield utils_1.loadYaml(configPath)) || {};
+            if (typeof processRawConfig === 'function') {
+                yield processRawConfig(rawConfig);
+            }
             return utils_2.transformConfig(rawConfig);
         }
         catch (e) {

package/lib/config/minimal.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = {
     rules: {
-        'info-description': 'warn',
         'info-contact': 'off',
         'info-license': 'off',
         'info-license-url': 'off',

package/lib/config/recommended.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = {
     rules: {
-        'info-description': 'warn',
         'info-contact': 'off',
         'info-license': 'warn',
         'info-license-url': 'warn',

package/lib/rules/common/assertions/asserts.d.ts

@@ -1,8 +1,25 @@
 import { AssertResult, CustomFunction } from 'core/src/config/types';
 import { Location } from '../../../ref-utils';
-declare type Asserts = Record<string, (value: any, condition: any, baseLocation: Location, rawValue?: any) => AssertResult[]>;
-export declare const runOnKeysSet: Set<string>;
-export declare const runOnValuesSet: Set<string>;
+export declare type AssertionFn = (value: any, condition: any, baseLocation: Location, rawValue?: any) => AssertResult[];
+export declare type Asserts = {
+    pattern: AssertionFn;
+    enum: AssertionFn;
+    defined: AssertionFn;
+    required: AssertionFn;
+    disallowed: AssertionFn;
+    undefined: AssertionFn;
+    nonEmpty: AssertionFn;
+    minLength: AssertionFn;
+    maxLength: AssertionFn;
+    casing: AssertionFn;
+    sortOrder: AssertionFn;
+    mutuallyExclusive: AssertionFn;
+    mutuallyRequired: AssertionFn;
+    requireAny: AssertionFn;
+    ref: AssertionFn;
+    const: AssertionFn;
+};
+export declare const runOnKeysSet: Set<keyof Asserts>;
+export declare const runOnValuesSet: Set<keyof Asserts>;
 export declare const asserts: Asserts;
-export declare function buildAssertCustomFunction(fn: CustomFunction): (value: string[], options: any, baseLocation: Location) => any;
-export {};
+export declare function buildAssertCustomFunction(fn: CustomFunction): AssertionFn;

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

@@ -16,6 +16,8 @@ exports.runOnKeysSet = new Set([
     'required',
     'requireAny',
     'ref',
+    'const',
+    'defined', // In case if `property` for assertions is not added
 ]);
 exports.runOnValuesSet = new Set([
     'pattern',
@@ -28,6 +30,7 @@ exports.runOnValuesSet = new Set([
     'casing',
     'sortOrder',
     'ref',
+    'const',
 ]);
 exports.asserts = {
     pattern: (value, condition, baseLocation) => {
@@ -84,6 +87,28 @@ exports.asserts = {
         })
             .filter(utils_1.isTruthy);
     },
+    const: (value, condition, baseLocation) => {
+        if (typeof value === 'undefined')
+            return [];
+        if (Array.isArray(value)) {
+            return value
+                .map((_val) => condition !== _val && {
+                message: `"${_val}" should be equal ${condition} `,
+                location: utils_1.isString(value) ? baseLocation : baseLocation.child(_val).key(),
+            })
+                .filter(utils_1.isTruthy);
+        }
+        else {
+            return value !== condition
+                ? [
+                    {
+                        message: `${value} should be equal ${condition}`,
+                        location: baseLocation,
+                    },
+                ]
+                : [];
+        }
+    },
     undefined: (value, condition = true, baseLocation) => {
         const isUndefined = typeof value === 'undefined';
         const isValid = condition ? isUndefined : !isUndefined;

package/lib/rules/common/assertions/index.d.ts

@@ -1,2 +1,27 @@
-import { Oas2Rule, Oas3Rule } from '../../../visitors';
-export declare const Assertions: Oas3Rule | Oas2Rule;
+import { asserts, AssertionFn } from './asserts';
+import { Oas2Visitor, Oas3Visitor } from '../../../visitors';
+import { RuleSeverity } from '../../../config';
+export declare type AssertionLocators = {
+    filterInParentKeys?: (string | number)[];
+    filterOutParentKeys?: (string | number)[];
+    matchParentKeys?: string;
+};
+export declare type AssertionDefinition = {
+    subject: {
+        type: string;
+        property?: string | string[];
+    } & AssertionLocators;
+    assertions: {
+        [name in keyof typeof asserts]?: AssertionFn;
+    };
+};
+export declare type RawAssertion = AssertionDefinition & {
+    where?: AssertionDefinition[];
+    message?: string;
+    suggest?: string[];
+    severity?: RuleSeverity;
+};
+export declare type Assertion = RawAssertion & {
+    assertionId: string;
+};
+export declare const Assertions: (opts: Record<string, Assertion>) => (Oas3Visitor | Oas2Visitor)[];

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

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Assertions = void 0;
-const asserts_1 = require("./asserts");
 const utils_1 = require("./utils");
+const utils_2 = require("../../../utils");
 const Assertions = (opts) => {
     const visitors = [];
     // As 'Assertions' has an array of asserts,
@@ -13,35 +13,12 @@ const Assertions = (opts) => {
     const assertions = Object.values(opts).filter((opt) => typeof opt === 'object' && opt !== null);
     for (const [index, assertion] of assertions.entries()) {
         const assertId = (assertion.assertionId && `${assertion.assertionId} assertion`) || `assertion #${index + 1}`;
-        if (!assertion.subject) {
-            throw new Error(`${assertId}: 'subject' is required`);
-        }
-        const subjects = Array.isArray(assertion.subject)
-            ? assertion.subject
-            : [assertion.subject];
-        const assertsToApply = Object.keys(asserts_1.asserts)
-            .filter((assertName) => assertion[assertName] !== undefined)
-            .map((assertName) => {
-            return {
-                name: assertName,
-                conditions: assertion[assertName],
-                runsOnKeys: asserts_1.runOnKeysSet.has(assertName),
-                runsOnValues: asserts_1.runOnValuesSet.has(assertName),
-            };
-        });
-        const shouldRunOnKeys = assertsToApply.find((assert) => assert.runsOnKeys && !assert.runsOnValues);
-        const shouldRunOnValues = assertsToApply.find((assert) => assert.runsOnValues && !assert.runsOnKeys);
-        if (shouldRunOnValues && !assertion.property) {
-            throw new Error(`${shouldRunOnValues.name} can't be used on all keys. Please provide a single property.`);
-        }
-        if (shouldRunOnKeys && assertion.property) {
-            throw new Error(`${shouldRunOnKeys.name} can't be used on a single property. Please use 'property'.`);
-        }
-        for (const subject of subjects) {
-            const subjectVisitor = utils_1.buildSubjectVisitor(assertId, assertion, assertsToApply);
-            const visitorObject = utils_1.buildVisitorObject(subject, assertion.context, subjectVisitor);
-            visitors.push(visitorObject);
+        if (!utils_2.isString(assertion.subject.type)) {
+            throw new Error(`${assertId}: 'type' (String) is required`);
         }
+        const subjectVisitor = utils_1.buildSubjectVisitor(assertId, assertion);
+        const visitorObject = utils_1.buildVisitorObject(assertion, subjectVisitor);
+        visitors.push(visitorObject);
     }
     return visitors;
 };

package/lib/rules/common/assertions/utils.d.ts

@@ -1,27 +1,20 @@
-import type { RuleSeverity } from '../../../config';
-import { UserContext } from '../../../walk';
+import { Asserts } from './asserts';
+import type { Assertion, AssertionDefinition } from '.';
+import type { Oas2Visitor, Oas3Visitor, VisitFunction } from '../../../visitors';
 export declare type OrderDirection = 'asc' | 'desc';
 export declare type OrderOptions = {
     direction: OrderDirection;
     property: string;
 };
-declare type Assertion = {
-    property: string | string[];
-    context?: Record<string, any>[];
-    severity?: RuleSeverity;
-    suggest?: any[];
-    message?: string;
-    subject: string;
-};
 export declare type AssertToApply = {
-    name: string;
+    name: keyof Asserts;
     conditions: any;
     runsOnKeys: boolean;
     runsOnValues: boolean;
 };
-export declare function buildVisitorObject(subject: string, context: Record<string, any>[], subjectVisitor: any): Record<string, any>;
-export declare function buildSubjectVisitor(assertId: string, assertion: Assertion, asserts: AssertToApply[]): (node: any, { report, location, rawLocation, key, type, resolve, rawNode }: UserContext) => void;
+export declare function getAssertsToApply(assertion: AssertionDefinition): AssertToApply[];
+export declare function buildVisitorObject(assertion: Assertion, subjectVisitor: VisitFunction<any>): Oas2Visitor | Oas3Visitor;
+export declare function buildSubjectVisitor(assertId: string, assertion: Assertion): VisitFunction<any>;
 export declare function getIntersectionLength(keys: string[], properties: string[]): number;
 export declare function isOrdered(value: any[], options: OrderOptions | OrderDirection): boolean;
 export declare function regexFromString(input: string): RegExp | null;
-export {};