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

package/README.md

@@ -10,7 +10,7 @@ See https://github.com/Redocly/redocly-cli
 import { formatProblems, lint, loadConfig } from '@redocly/openapi-core';
 
 const pathToApi = 'openapi.yaml';
-const config = loadConfig('optional/path/to/.redocly.yaml');
+const config = loadConfig({ configPath: 'optional/path/to/.redocly.yaml' });
 const lintResults = await lint({ ref: pathToApi, config });
 ```
 
@@ -20,6 +20,6 @@ const lintResults = await lint({ ref: pathToApi, config });
 import { formatProblems, bundle, loadConfig } from '@redocly/openapi-core';
 
 const pathToApi = 'openapi.yaml';
-const config = loadConfig('optional/path/to/.redocly.yaml');
+const config = loadConfig({ configPath: 'optional/path/to/.redocly.yaml' });
 const { bundle, problems } = await bundle({ ref: pathToApi, config });
 ```

package/lib/benchmark/benches/resolve-with-no-external.bench.js

@@ -16,7 +16,7 @@ function measureAsync() {
     return resolve_1.resolveDocument({
         rootDocument: rebillyDocument,
         externalRefResolver,
-        rootType: types_1.normalizeTypes(oas3_1.Oas3Types).DefinitionRoot,
+        rootType: types_1.normalizeTypes(oas3_1.Oas3Types).Root,
     });
 }
 exports.measureAsync = measureAsync;

package/lib/bundle.d.ts

@@ -44,4 +44,4 @@ export declare function bundleDocument(opts: {
     refTypes: Map<string, NormalizedNodeType> | undefined;
     visitorsData: Record<string, Record<string, unknown>>;
 }>;
-export declare function mapTypeToComponent(typeName: string, version: OasMajorVersion): "headers" | "definitions" | "parameters" | "examples" | "responses" | "schemas" | "requestBodies" | "securitySchemes" | "links" | "callbacks" | null;
+export declare function mapTypeToComponent(typeName: string, version: OasMajorVersion): "headers" | "definitions" | "parameters" | "examples" | "responses" | "schemas" | "requestBodies" | "links" | "callbacks" | "securitySchemes" | null;

package/lib/bundle.js

@@ -76,7 +76,7 @@ function bundleDocument(opts) {
         }
         const resolvedRefMap = yield resolve_1.resolveDocument({
             rootDocument: document,
-            rootType: types.DefinitionRoot,
+            rootType: types.Root,
             externalRefResolver,
         });
         const bundleVisitor = visitors_1.normalizeVisitors([
@@ -90,7 +90,7 @@ function bundleDocument(opts) {
         ], types);
         walk_1.walkDocument({
             document,
-            rootType: types.DefinitionRoot,
+            rootType: types.Root,
             normalizedVisitors: bundleVisitor,
             resolvedRefMap,
             ctx,
@@ -99,7 +99,7 @@ function bundleDocument(opts) {
             bundle: document,
             problems: ctx.problems.map((problem) => config.addProblemToIgnore(problem)),
             fileDependencies: externalRefResolver.getFiles(),
-            rootType: types.DefinitionRoot,
+            rootType: types.Root,
             refTypes: ctx.refTypes,
             visitorsData: ctx.visitorsData,
         };
@@ -184,7 +184,7 @@ function makeBundleVisitor(version, dereference, skipRedoclyRegistryRefs, rootDo
                 }
             },
         },
-        DefinitionRoot: {
+        Root: {
             enter(root) {
                 if (version === oas_types_1.OasMajorVersion.Version3) {
                     components = root.components = root.components || {};

package/lib/config/all.js

@@ -26,7 +26,7 @@ exports.default = {
         'operation-operationId-url-safe': 'error',
         'operation-parameters-unique': 'error',
         'operation-tag-defined': 'error',
-        'operation-security-defined': 'error',
+        'security-defined': 'error',
         'operation-singular-tag': 'error',
         'no-unresolved-refs': 'error',
         'no-enum-type-mismatch': 'error',
@@ -52,6 +52,7 @@ exports.default = {
         'no-unused-components': 'error',
         'no-undefined-server-variable': 'error',
         'no-server-variables-empty-enum': 'error',
+        'operation-4xx-problem-details-rfc7807': 'error',
     },
     oas3_1Rules: {
         'no-server-example.com': 'error',
@@ -61,5 +62,6 @@ exports.default = {
         'no-unused-components': 'error',
         'no-undefined-server-variable': 'error',
         'no-server-variables-empty-enum': 'error',
+        'operation-4xx-problem-details-rfc7807': 'error',
     },
 };

package/lib/config/config-resolvers.js

@@ -30,6 +30,7 @@ const env_1 = require("../env");
 const utils_2 = 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* () {
@@ -133,9 +134,12 @@ function resolvePlugins(plugins, configPath = '') {
                 plugin.decorators.oas2 = utils_1.prefixRules(pluginModule.decorators.oas2, id);
             }
         }
+        if (pluginModule.assertions) {
+            plugin.assertions = pluginModule.assertions;
+        }
         return plugin;
     })
-        .filter(utils_2.notUndefined);
+        .filter(utils_2.isDefined);
 }
 exports.resolvePlugins = resolvePlugins;
 function resolveApis({ rawConfig, configPath = '', resolver, }) {
@@ -196,8 +200,7 @@ function resolveAndMergeNestedStyleguideConfig({ styleguideConfig, configPath =
 function resolveStyleguideConfig(opts, parentConfigPaths = [], extendPaths = []) {
     return __awaiter(this, void 0, void 0, function* () {
         const resolvedStyleguideConfig = yield resolveAndMergeNestedStyleguideConfig(opts, parentConfigPaths, extendPaths);
-        return Object.assign(Object.assign({}, resolvedStyleguideConfig), { rules: resolvedStyleguideConfig.rules &&
-                groupStyleguideAssertionRules(resolvedStyleguideConfig.rules) });
+        return Object.assign(Object.assign({}, resolvedStyleguideConfig), { rules: resolvedStyleguideConfig.rules && groupStyleguideAssertionRules(resolvedStyleguideConfig) });
     });
 }
 exports.resolveStyleguideConfig = resolveStyleguideConfig;
@@ -238,7 +241,7 @@ function getMergedRawStyleguideConfig(rootStyleguideConfig, apiStyleguideConfig)
             : rootStyleguideConfig.recommendedFallback });
     return resultLint;
 }
-function groupStyleguideAssertionRules(rules) {
+function groupStyleguideAssertionRules({ rules, plugins, }) {
     if (!rules) {
         return rules;
     }
@@ -249,6 +252,21 @@ function groupStyleguideAssertionRules(rules) {
     for (const [ruleKey, rule] of Object.entries(rules)) {
         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]);
+                }
+            }
             assertions.push(Object.assign(Object.assign({}, assertion), { assertionId: ruleKey.replace('assert/', '') }));
         }
         else {

package/lib/config/config.d.ts

@@ -59,5 +59,6 @@ export declare class Config {
     'features.openapi': Record<string, any>;
     'features.mockServer'?: Record<string, any>;
     organization?: string;
+    files: string[];
     constructor(rawConfig: ResolvedConfig, configFile?: string | undefined);
 }

package/lib/config/config.js

@@ -249,6 +249,7 @@ class Config {
         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 || [];
     }
 }
 exports.Config = Config;

package/lib/config/load.d.ts

@@ -1,7 +1,13 @@
 import { Config } from './config';
-import type { RawConfig } from './types';
+import type { RawConfig, Region } from './types';
 import { RegionalTokenWithValidity } from '../redocly/redocly-client-types';
-export declare function loadConfig(configPath?: string | undefined, customExtends?: string[], processRawConfig?: (rawConfig: RawConfig) => void | Promise<void>): Promise<Config>;
+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>;

package/lib/config/load.js

@@ -59,9 +59,11 @@ function addConfigMetadata({ rawConfig, customExtends, configPath, tokens, }) {
         return config_resolvers_1.resolveConfig(rawConfig, configPath);
     });
 }
-function loadConfig(configPath = findConfig(), customExtends, processRawConfig) {
+function loadConfig(options = {}) {
     return __awaiter(this, void 0, void 0, function* () {
-        const rawConfig = yield getConfig(configPath);
+        const { configPath = findConfig(), customExtends, processRawConfig, files, region } = options;
+        const config = yield getConfig(configPath);
+        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);
         }

package/lib/config/minimal.js

@@ -24,7 +24,7 @@ exports.default = {
         'operation-operationId-unique': 'warn',
         'operation-parameters-unique': 'warn',
         'operation-tag-defined': 'off',
-        'operation-security-defined': 'warn',
+        'security-defined': 'warn',
         'operation-operationId-url-safe': 'warn',
         'operation-singular-tag': 'off',
         'no-unresolved-refs': 'error',
@@ -45,6 +45,7 @@ exports.default = {
         'no-unused-components': 'warn',
         'no-undefined-server-variable': 'warn',
         'no-server-variables-empty-enum': 'error',
+        'spec-components-invalid-map-name': 'warn',
     },
     oas3_1Rules: {
         'no-invalid-media-type-examples': 'warn',
@@ -55,5 +56,6 @@ exports.default = {
         'no-unused-components': 'warn',
         'no-undefined-server-variable': 'warn',
         'no-server-variables-empty-enum': 'error',
+        'spec-components-invalid-map-name': 'warn',
     },
 };

package/lib/config/recommended.js

@@ -25,7 +25,7 @@ exports.default = {
         'operation-operationId-url-safe': 'error',
         'operation-parameters-unique': 'error',
         'operation-tag-defined': 'off',
-        'operation-security-defined': 'error',
+        'security-defined': 'error',
         'operation-singular-tag': 'off',
         'no-unresolved-refs': 'error',
         'no-enum-type-mismatch': 'error',
@@ -45,6 +45,7 @@ exports.default = {
         'no-unused-components': 'warn',
         'no-undefined-server-variable': 'error',
         'no-server-variables-empty-enum': 'error',
+        'spec-components-invalid-map-name': 'error',
     },
     oas3_1Rules: {
         'no-invalid-media-type-examples': 'warn',
@@ -55,5 +56,6 @@ exports.default = {
         'no-unused-components': 'warn',
         'no-undefined-server-variable': 'error',
         'no-server-variables-empty-enum': 'error',
+        'spec-components-invalid-map-name': 'error',
     },
 };

package/lib/config/rules.js

@@ -29,6 +29,6 @@ function initRules(rules, config, type, oasVersion) {
         };
     }))
         .flatMap((visitor) => visitor)
-        .filter(utils_1.notUndefined);
+        .filter(utils_1.isDefined);
 }
 exports.initRules = initRules;

package/lib/config/types.d.ts

@@ -1,6 +1,7 @@
 import type { ProblemSeverity } from '../walk';
 import type { Oas3PreprocessorsSet, OasMajorVersion, Oas3DecoratorsSet, Oas2RuleSet, Oas2PreprocessorsSet, Oas2DecoratorsSet, Oas3RuleSet, OasVersion } from '../oas-types';
 import type { NodeType } from '../types';
+import { Location } from '../ref-utils';
 export declare type RuleSeverity = ProblemSeverity | 'off';
 export declare type PreprocessorSeverity = RuleSeverity | 'on';
 export declare type RuleConfig = RuleSeverity | ({
@@ -50,6 +51,12 @@ export declare type CustomRulesConfig = {
     oas3?: Oas3RuleSet;
     oas2?: Oas2RuleSet;
 };
+export declare type AssertResult = {
+    message?: string;
+    location?: Location;
+};
+export declare type CustomFunction = (value: any, options: unknown, baseLocation: Location) => AssertResult[];
+export declare type AssertionsConfig = Record<string, CustomFunction>;
 export declare type Plugin = {
     id: string;
     configs?: Record<string, PluginStyleguideConfig>;
@@ -57,6 +64,7 @@ export declare type Plugin = {
     preprocessors?: PreprocessorsConfig;
     decorators?: DecoratorsConfig;
     typeExtension?: TypeExtensionsConfig;
+    assertions?: AssertionsConfig;
 };
 export declare type PluginStyleguideConfig = Omit<StyleguideRawConfig, 'plugins' | 'extends'>;
 export declare type ResolveHeader = {
@@ -72,6 +80,7 @@ export declare type ResolveHeader = {
 };
 export declare type RawResolveConfig = {
     http?: Partial<HttpResolveConfig>;
+    doNotResolveExamples?: boolean;
 };
 export declare type HttpResolveConfig = {
     headers: ResolveHeader[];
@@ -87,6 +96,7 @@ export declare type AccessTokens = {
 export declare type DeprecatedInRawConfig = {
     apiDefinitions?: Record<string, string>;
     lint?: StyleguideRawConfig;
+    styleguide?: StyleguideRawConfig;
     referenceDocs?: Record<string, any>;
     apis?: Record<string, Api & DeprecatedInApi>;
 };
@@ -99,6 +109,7 @@ export declare type DeprecatedInApi = {
 };
 export declare type ResolvedApi = Omit<Api, 'styleguide'> & {
     styleguide: ResolvedStyleguideConfig;
+    files?: string[];
 };
 export declare type RawConfig = {
     apis?: Record<string, Api>;
@@ -106,7 +117,13 @@ export declare type RawConfig = {
     resolve?: RawResolveConfig;
     region?: Region;
     organization?: string;
+    files?: string[];
 } & FeaturesConfig;
+export declare type FlatApi = Omit<Api, 'styleguide'> & Omit<ApiStyleguideRawConfig, 'doNotResolveExamples'>;
+export declare type FlatRawConfig = Omit<RawConfig, 'styleguide' | 'resolve' | 'apis'> & Omit<StyleguideRawConfig, 'doNotResolveExamples'> & {
+    resolve?: RawResolveConfig;
+    apis?: Record<string, FlatApi>;
+};
 export declare type ResolvedConfig = Omit<RawConfig, 'apis' | 'styleguide'> & {
     apis: Record<string, ResolvedApi>;
     styleguide: ResolvedStyleguideConfig;

package/lib/config/utils.d.ts

@@ -1,5 +1,5 @@
 import { Config } from './config';
-import type { Api, DeprecatedInRawConfig, Plugin, RawConfig, RawResolveConfig, ResolveConfig, ResolvedStyleguideConfig, RulesFields } from './types';
+import type { Api, DeprecatedInRawConfig, FlatRawConfig, Plugin, RawConfig, RawResolveConfig, ResolveConfig, ResolvedStyleguideConfig, RulesFields } from './types';
 export declare function parsePresetName(presetName: string): {
     pluginId: string;
     configName: string;
@@ -8,6 +8,6 @@ export declare function transformApiDefinitionsToApis(apiDefinitions?: Deprecate
 export declare function prefixRules<T extends Record<string, any>>(rules: T, prefix: string): any;
 export declare function mergeExtends(rulesConfList: ResolvedStyleguideConfig[]): Omit<ResolvedStyleguideConfig, RulesFields> & Required<Pick<ResolvedStyleguideConfig, RulesFields>>;
 export declare function getMergedConfig(config: Config, apiName?: string): Config;
-export declare function transformConfig(rawConfig: DeprecatedInRawConfig & RawConfig): RawConfig;
+export declare function transformConfig(rawConfig: DeprecatedInRawConfig & RawConfig & FlatRawConfig): RawConfig;
 export declare function getResolveConfig(resolve?: RawResolveConfig): ResolveConfig;
 export declare function getUniquePlugins(plugins: Plugin[]): Plugin[];

package/lib/config/utils.js

@@ -35,13 +35,46 @@ function transformApiDefinitionsToApis(apiDefinitions) {
     return apis;
 }
 exports.transformApiDefinitionsToApis = transformApiDefinitionsToApis;
+function extractFlatConfig(_a) {
+    var _b;
+    var { plugins, extends: _extends, rules, oas2Rules, oas3_0Rules, oas3_1Rules, preprocessors, oas2Preprocessors, oas3_0Preprocessors, oas3_1Preprocessors, decorators, oas2Decorators, oas3_0Decorators, oas3_1Decorators } = _a, rawConfigRest = __rest(_a, ["plugins", "extends", "rules", "oas2Rules", "oas3_0Rules", "oas3_1Rules", "preprocessors", "oas2Preprocessors", "oas3_0Preprocessors", "oas3_1Preprocessors", "decorators", "oas2Decorators", "oas3_0Decorators", "oas3_1Decorators"]);
+    const styleguideConfig = {
+        plugins,
+        extends: _extends,
+        rules,
+        oas2Rules,
+        oas3_0Rules,
+        oas3_1Rules,
+        preprocessors,
+        oas2Preprocessors,
+        oas3_0Preprocessors,
+        oas3_1Preprocessors,
+        decorators,
+        oas2Decorators,
+        oas3_0Decorators,
+        oas3_1Decorators,
+        doNotResolveExamples: (_b = rawConfigRest.resolve) === null || _b === void 0 ? void 0 : _b.doNotResolveExamples,
+    };
+    if ((rawConfigRest.lint && rawConfigRest.styleguide) ||
+        (Object.values(styleguideConfig).some(utils_1.isDefined) &&
+            (rawConfigRest.lint || rawConfigRest.styleguide))) {
+        throw new Error(`Do not use 'lint', 'styleguide' and flat syntax together. \nSee more about the configuration in the docs: https://redocly.com/docs/cli/configuration/ \n`);
+    }
+    return {
+        styleguideConfig: Object.values(styleguideConfig).some(utils_1.isDefined)
+            ? styleguideConfig
+            : undefined,
+        rawConfigRest,
+    };
+}
 function transformApis(legacyApis) {
     if (!legacyApis)
         return undefined;
     const apis = {};
     for (let _a of Object.entries(legacyApis)) {
         const [apiName, _b] = _a, { lint } = _b, apiContent = __rest(_b, ["lint"]);
-        apis[apiName] = Object.assign({ styleguide: lint }, apiContent);
+        const { styleguideConfig, rawConfigRest } = extractFlatConfig(apiContent);
+        apis[apiName] = Object.assign({ styleguide: styleguideConfig || lint }, rawConfigRest);
     }
     return apis;
 }
@@ -106,7 +139,7 @@ function mergeExtends(rulesConfList) {
 }
 exports.mergeExtends = mergeExtends;
 function getMergedConfig(config, apiName) {
-    var _a, _b, _c, _d, _e, _f;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j;
     const extendPaths = [
         ...Object.values(config.apis).map((api) => { var _a; return (_a = api === null || api === void 0 ? void 0 : api.styleguide) === null || _a === void 0 ? void 0 : _a.extendPaths; }),
         (_b = (_a = config.rawConfig) === null || _a === void 0 ? void 0 : _a.styleguide) === null || _b === void 0 ? void 0 : _b.extendPaths,
@@ -123,14 +156,17 @@ function getMergedConfig(config, apiName) {
         ? new config_1.Config(Object.assign(Object.assign({}, config.rawConfig), { styleguide: Object.assign(Object.assign({}, (config.apis[apiName]
                 ? config.apis[apiName].styleguide
                 : config.rawConfig.styleguide)), { extendPaths,
-                pluginPaths }), 'features.openapi': Object.assign(Object.assign({}, config['features.openapi']), (_e = config.apis[apiName]) === null || _e === void 0 ? void 0 : _e['features.openapi']), 'features.mockServer': Object.assign(Object.assign({}, config['features.mockServer']), (_f = config.apis[apiName]) === null || _f === void 0 ? void 0 : _f['features.mockServer']) }), config.configFile)
+                pluginPaths }), 'features.openapi': Object.assign(Object.assign({}, config['features.openapi']), (_e = config.apis[apiName]) === null || _e === void 0 ? void 0 : _e['features.openapi']), 'features.mockServer': Object.assign(Object.assign({}, config['features.mockServer']), (_f = config.apis[apiName]) === null || _f === void 0 ? void 0 : _f['features.mockServer']), files: [...config.files, ...((_j = (_h = (_g = config.apis) === null || _g === void 0 ? void 0 : _g[apiName]) === null || _h === void 0 ? void 0 : _h.files) !== null && _j !== void 0 ? _j : [])] }), config.configFile)
         : config;
 }
 exports.getMergedConfig = getMergedConfig;
 function checkForDeprecatedFields(deprecatedField, updatedField, rawConfig) {
     const isDeprecatedFieldInApis = rawConfig.apis &&
         Object.values(rawConfig.apis).some((api) => api[deprecatedField]);
-    if (rawConfig[deprecatedField] && rawConfig[updatedField]) {
+    if (rawConfig[deprecatedField] && updatedField === null) {
+        utils_1.showWarningForDeprecatedField(deprecatedField);
+    }
+    if (rawConfig[deprecatedField] && updatedField && rawConfig[updatedField]) {
         utils_1.showErrorForDeprecatedField(deprecatedField, updatedField);
     }
     if (rawConfig[deprecatedField] || isDeprecatedFieldInApis) {
@@ -141,13 +177,15 @@ function transformConfig(rawConfig) {
     const migratedFields = [
         ['apiDefinitions', 'apis'],
         ['referenceDocs', 'features.openapi'],
-        ['lint', 'styleguide'], // TODO: update docs
+        ['lint', undefined],
+        ['styleguide', undefined],
     ];
     for (const [deprecatedField, updatedField] of migratedFields) {
         checkForDeprecatedFields(deprecatedField, updatedField, rawConfig);
     }
     const { apis, apiDefinitions, referenceDocs, lint } = rawConfig, rest = __rest(rawConfig, ["apis", "apiDefinitions", "referenceDocs", "lint"]);
-    return Object.assign({ 'features.openapi': referenceDocs, apis: transformApis(apis) || transformApiDefinitionsToApis(apiDefinitions), styleguide: lint }, rest);
+    const { styleguideConfig, rawConfigRest } = extractFlatConfig(rest);
+    return Object.assign({ 'features.openapi': referenceDocs, apis: transformApis(apis) || transformApiDefinitionsToApis(apiDefinitions), styleguide: styleguideConfig || lint }, rawConfigRest);
 }
 exports.transformConfig = transformConfig;
 function getResolveConfig(resolve) {

package/lib/decorators/common/registry-dependencies.js

@@ -5,7 +5,7 @@ const redocly_1 = require("../../redocly");
 const RegistryDependencies = () => {
     const registryDependencies = new Set();
     return {
-        DefinitionRoot: {
+        Root: {
             leave(_, ctx) {
                 const data = ctx.getVisitorData();
                 data.links = Array.from(registryDependencies);

package/lib/format/format.d.ts

@@ -4,7 +4,7 @@ export declare type Totals = {
     warnings: number;
     ignored: number;
 };
-export declare type OutputFormat = 'codeframe' | 'stylish' | 'json' | 'checkstyle' | 'codeclimate';
+export declare type OutputFormat = 'codeframe' | 'stylish' | 'json' | 'checkstyle' | 'codeclimate' | 'summary';
 export declare function getTotals(problems: (NormalizedProblem & {
     ignored?: boolean;
 })[]): Totals;

package/lib/format/format.js

@@ -99,6 +99,9 @@ function formatProblems(problems, opts) {
         case 'codeclimate':
             outputForCodeClimate();
             break;
+        case 'summary':
+            formatSummary(problems);
+            break;
     }
     if (totalProblems - ignoredProblems > maxProblems) {
         logger_1.logger.info(`< ... ${totalProblems - maxProblems} more problems hidden > ${logger_1.colorize.gray('increase with `--max-problems N`')}\n`);
@@ -183,13 +186,31 @@ function formatProblems(problems, opts) {
     }
 }
 exports.formatProblems = formatProblems;
+function formatSummary(problems) {
+    const counts = {};
+    for (const problem of problems) {
+        counts[problem.ruleId] = counts[problem.ruleId] || { count: 0, severity: problem.severity };
+        counts[problem.ruleId].count++;
+    }
+    const sorted = Object.entries(counts).sort(([, a], [, b]) => {
+        const severityDiff = severityToNumber(a.severity) - severityToNumber(b.severity);
+        return severityDiff || b.count - a.count;
+    });
+    for (const [ruleId, info] of sorted) {
+        const color = COLORS[info.severity];
+        const severityName = color(SEVERITY_NAMES[info.severity].toLowerCase().padEnd(7));
+        logger_1.logger.info(`${severityName} ${ruleId}: ${info.count}\n`);
+    }
+    logger_1.logger.info('\n');
+}
 function formatFrom(cwd, location) {
     if (!location)
         return '';
     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 ${logger_1.colorize.blue(fileWithLoc)}\n\n`;
+    const atPointer = location.pointer ? logger_1.colorize.gray(`at ${location.pointer}`) : '';
+    return `referenced from ${logger_1.colorize.blue(fileWithLoc)} ${atPointer} \n\n`;
 }
 function formatDidYouMean(problem) {
     if (problem.suggest.length === 0)

package/lib/lint.js

@@ -60,12 +60,12 @@ function lintDocument(opts) {
         const normalizedVisitors = visitors_1.normalizeVisitors([...preprocessors, ...regularRules], types);
         const resolvedRefMap = yield resolve_1.resolveDocument({
             rootDocument: document,
-            rootType: types.DefinitionRoot,
+            rootType: types.Root,
             externalRefResolver,
         });
         walk_1.walkDocument({
             document,
-            rootType: types.DefinitionRoot,
+            rootType: types.Root,
             normalizedVisitors,
             resolvedRefMap,
             ctx,

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

@@ -1,6 +1,5 @@
 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;

package/lib/redocly/registry-api.js

@@ -8,14 +8,12 @@ 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 = exports.currentCommand = void 0;
+exports.RegistryApi = 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;
@@ -32,10 +30,13 @@ class RegistryApi {
         return this;
     }
     request(path = '', options = {}, region) {
+        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
+            const currentCommand = typeof process !== 'undefined' ? ((_a = process.env) === null || _a === void 0 ? void 0 : _a.REDOCLY_CLI_COMMAND) || '' : '';
+            const redoclyEnv = typeof process !== 'undefined' ? ((_b = process.env) === null || _b === void 0 ? void 0 : _b.REDOCLY_ENVIRONMENT) || '' : '';
             const headers = Object.assign({}, options.headers || {}, {
                 'x-redocly-cli-version': version,
-                'user-agent': `redocly-cli / ${version} ${exports.currentCommand}`,
+                'user-agent': `redocly-cli / ${version} ${currentCommand} ${redoclyEnv}`,
             });
             if (!headers.hasOwnProperty('authorization')) {
                 throw new Error('Unauthorized');

package/lib/resolve.js

@@ -110,7 +110,9 @@ class BaseResolver {
                     return new Source(absoluteRef, body, mimeType);
                 }
                 else {
-                    return new Source(absoluteRef, yield fs.promises.readFile(absoluteRef, 'utf-8'));
+                    const content = yield fs.promises.readFile(absoluteRef, 'utf-8');
+                    // In some cases file have \r\n line delimeters like on windows, we should skip it.
+                    return new Source(absoluteRef, content.replace(/\r\n/g, '\n'));
                 }
             }
             catch (error) {

package/lib/rules/ajv.d.ts

@@ -1,4 +1,4 @@
-import { ErrorObject } from '@redocly/ajv';
+import { ErrorObject } from '@redocly/ajv/dist/2020';
 import { Location } from '../ref-utils';
 import { ResolveFn } from '../walk';
 export declare function releaseAjvInstance(): void;

package/lib/rules/ajv.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateJsonSchema = exports.releaseAjvInstance = void 0;
-const ajv_1 = require("@redocly/ajv");
+const _2020_1 = require("@redocly/ajv/dist/2020");
 const ref_utils_1 = require("../ref-utils");
 let ajvInstance = null;
 function releaseAjvInstance() {
@@ -10,7 +10,7 @@ function releaseAjvInstance() {
 exports.releaseAjvInstance = releaseAjvInstance;
 function getAjv(resolve, allowAdditionalProperties) {
     if (!ajvInstance) {
-        ajvInstance = new ajv_1.default({
+        ajvInstance = new _2020_1.default({
             schemaId: '$id',
             meta: true,
             allErrors: true,
@@ -20,7 +20,7 @@ function getAjv(resolve, allowAdditionalProperties) {
             discriminator: true,
             allowUnionTypes: true,
             validateFormats: false,
-            defaultAdditionalProperties: allowAdditionalProperties,
+            defaultUnevaluatedProperties: allowAdditionalProperties,
             loadSchemaSync(base, $ref) {
                 const resolvedRef = resolve({ $ref }, base.split('#')[0]);
                 if (!resolvedRef || !resolvedRef.location)
@@ -68,8 +68,8 @@ function validateJsonSchema(data, schema, schemaLoc, instancePath, resolve, allo
         if (propName) {
             message = `\`${propName}\` property ${message}`;
         }
-        if (error.keyword === 'additionalProperties') {
-            const property = error.params.additionalProperty;
+        if (error.keyword === 'additionalProperties' || error.keyword === 'unevaluatedProperties') {
+            const property = error.params.additionalProperty || error.params.unevaluatedProperty;
             message = `${message} \`${property}\``;
             error.instancePath += '/' + ref_utils_1.escapePointer(property);
         }

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

@@ -1,10 +1,8 @@
+import { AssertResult, CustomFunction } from 'core/src/config/types';
 import { Location } from '../../../ref-utils';
-declare type AssertResult = {
-    isValid: boolean;
-    location?: Location;
-};
-declare type Asserts = Record<string, (value: any, condition: any, baseLocation: Location, rawValue?: any) => AssertResult>;
+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 const asserts: Asserts;
+export declare function buildAssertCustomFunction(fn: CustomFunction): (value: string[], options: any, baseLocation: Location) => any;
 export {};