@redocly/openapi-core 1.18.0 → 1.19.0

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @redocly/openapi-core
 
+## 1.19.0
+
+### Minor Changes
+
+- Added support for AsyncAPI 3.0 description linting.
+
+### Patch Changes
+
+- Fixed an issue where `patternProperties` incorrectly caused linting errors due to a missing `PatternProperties` node.
+
+## 1.18.1
+
+### Patch Changes
+
+- Allowed the `theme.openapi` configuration option to accept settings specific to Redoc 2.x and earlier.
+- Fixed an issue in the OpenAPI `spec` rule where `dependentSchemas` was parsed as an array.
+  It is now correctly parsed as a map.
+- Fixed bundling of `$refs` inside `patternProperties`.
+- Updated AsyncAPI v2 typings to abide by JSON Schema draft-07 specification.
+
 ## 1.18.0
 
 ### Minor Changes

package/lib/benchmark/benches/lint-with-many-rules.bench.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.measureAsync = exports.count = exports.name = void 0;
+exports.count = exports.name = void 0;
+exports.measureAsync = measureAsync;
 const fs_1 = require("fs");
 const path_1 = require("path");
 const lint_1 = require("../../lint");
@@ -31,4 +32,3 @@ function measureAsync() {
         config,
     });
 }
-exports.measureAsync = measureAsync;

package/lib/benchmark/benches/lint-with-nested-rule.bench.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.measureAsync = exports.count = exports.name = void 0;
+exports.count = exports.name = void 0;
+exports.measureAsync = measureAsync;
 const fs_1 = require("fs");
 const path_1 = require("path");
 const lint_1 = require("../../lint");
@@ -37,4 +38,3 @@ function measureAsync() {
         config,
     });
 }
-exports.measureAsync = measureAsync;

package/lib/benchmark/benches/lint-with-no-rules.bench.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.measureAsync = exports.count = exports.name = void 0;
+exports.count = exports.name = void 0;
+exports.measureAsync = measureAsync;
 const fs_1 = require("fs");
 const path_1 = require("path");
 const lint_1 = require("../../lint");
@@ -18,4 +19,3 @@ function measureAsync() {
         config,
     });
 }
-exports.measureAsync = measureAsync;

package/lib/benchmark/benches/lint-with-top-level-rule-report.bench.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.measureAsync = exports.count = exports.name = void 0;
+exports.count = exports.name = void 0;
+exports.measureAsync = measureAsync;
 const fs_1 = require("fs");
 const path_1 = require("path");
 const lint_1 = require("../../lint");
@@ -30,4 +31,3 @@ function measureAsync() {
         config,
     });
 }
-exports.measureAsync = measureAsync;

package/lib/benchmark/benches/lint-with-top-level-rule.bench.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.measureAsync = exports.count = exports.name = void 0;
+exports.count = exports.name = void 0;
+exports.measureAsync = measureAsync;
 const fs_1 = require("fs");
 const path_1 = require("path");
 const lint_1 = require("../../lint");
@@ -29,4 +30,3 @@ function measureAsync() {
         config,
     });
 }
-exports.measureAsync = measureAsync;

package/lib/benchmark/benches/recommended-oas3.bench.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.measureAsync = exports.count = exports.name = void 0;
+exports.count = exports.name = void 0;
+exports.measureAsync = measureAsync;
 const fs_1 = require("fs");
 const path_1 = require("path");
 const lint_1 = require("../../lint");
@@ -18,4 +19,3 @@ function measureAsync() {
         config: new config_1.StyleguideConfig((0, config_1.resolvePreset)('recommended', [config_1.defaultPlugin])),
     });
 }
-exports.measureAsync = measureAsync;

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

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.measureAsync = exports.count = exports.name = void 0;
+exports.count = exports.name = void 0;
+exports.measureAsync = measureAsync;
 const path = require("path");
 const fs_1 = require("fs");
 const resolve_1 = require("../../resolve");
@@ -19,4 +20,3 @@ function measureAsync() {
         rootType: (0, types_1.normalizeTypes)(oas3_1.Oas3Types).Root,
     });
 }
-exports.measureAsync = measureAsync;

package/lib/benchmark/utils.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeConfigForRuleset = exports.parseYamlToDocument = void 0;
+exports.parseYamlToDocument = parseYamlToDocument;
+exports.makeConfigForRuleset = makeConfigForRuleset;
 const js_yaml_1 = require("../js-yaml");
 const resolve_1 = require("../resolve");
 const config_1 = require("../config");
@@ -10,7 +11,6 @@ function parseYamlToDocument(body, absoluteRef = '') {
         parsed: (0, js_yaml_1.parseYaml)(body, { filename: absoluteRef }),
     };
 }
-exports.parseYamlToDocument = parseYamlToDocument;
 function makeConfigForRuleset(rules, plugin) {
     const rulesConf = {};
     const ruleId = 'test';
@@ -19,7 +19,11 @@ function makeConfigForRuleset(rules, plugin) {
     });
     const extendConfigs = [
         (0, config_1.resolvePlugins)([
-            Object.assign(Object.assign({}, plugin), { id: ruleId, rules: { oas3: rules } }),
+            {
+                ...plugin,
+                id: ruleId,
+                rules: { oas3: rules },
+            },
         ]),
     ];
     if (rules) {
@@ -28,4 +32,3 @@ function makeConfigForRuleset(rules, plugin) {
     const styleguide = (0, config_1.mergeExtends)(extendConfigs);
     return new config_1.StyleguideConfig(styleguide);
 }
-exports.makeConfigForRuleset = makeConfigForRuleset;

package/lib/bundle.d.ts

@@ -1,11 +1,10 @@
 import { BaseResolver } from './resolve';
 import { SpecMajorVersion } from './oas-types';
-import type { Oas3Rule } from './visitors';
 import type { NormalizedNodeType, NodeType } from './types';
 import type { NormalizedProblem } from './walk';
 import type { Config, StyleguideConfig } from './config';
 import type { Document, ResolvedRefMap } from './resolve';
-export type Oas3RuleSet = Record<string, Oas3Rule>;
+import type { CollectFn } from './utils';
 export declare enum OasVersion {
     Version2 = "oas2",
     Version3_0 = "oas3_0",
@@ -24,6 +23,7 @@ export declare function bundleConfig(document: Document, resolvedRefMap: Resolve
 export declare function bundle(opts: {
     ref?: string;
     doc?: Document;
+    collectSpecData?: CollectFn;
 } & BundleOptions): Promise<BundleResult>;
 export declare function bundleFromString(opts: {
     source: string;
@@ -47,4 +47,4 @@ export declare function bundleDocument(opts: {
     removeUnusedComponents?: boolean;
     keepUrlRefs?: boolean;
 }): Promise<BundleResult>;
-export declare function mapTypeToComponent(typeName: string, version: SpecMajorVersion): "definitions" | "parameters" | "examples" | "headers" | "schemas" | "responses" | "requestBodies" | "securitySchemes" | "links" | "callbacks" | null;
+export declare function mapTypeToComponent(typeName: string, version: SpecMajorVersion): "definitions" | "links" | "responses" | "parameters" | "examples" | "headers" | "schemas" | "requestBodies" | "securitySchemes" | "callbacks" | null;

package/lib/bundle.js

@@ -1,16 +1,11 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.mapTypeToComponent = exports.bundleDocument = exports.bundleFromString = exports.bundle = exports.bundleConfig = exports.OasVersion = void 0;
-const isEqual = require("lodash.isequal");
+exports.OasVersion = void 0;
+exports.bundleConfig = bundleConfig;
+exports.bundle = bundle;
+exports.bundleFromString = bundleFromString;
+exports.bundleDocument = bundleDocument;
+exports.mapTypeToComponent = mapTypeToComponent;
 const resolve_1 = require("./resolve");
 const visitors_1 = require("./visitors");
 const types_1 = require("./types");
@@ -30,132 +25,130 @@ var OasVersion;
     OasVersion["Version3_0"] = "oas3_0";
     OasVersion["Version3_1"] = "oas3_1";
 })(OasVersion || (exports.OasVersion = OasVersion = {}));
-function bundleConfig(document, resolvedRefMap) {
-    var _a;
-    return __awaiter(this, void 0, void 0, function* () {
-        const types = (0, types_1.normalizeTypes)(redocly_yaml_1.ConfigTypes);
-        const ctx = {
-            problems: [],
-            oasVersion: oas_types_1.SpecVersion.OAS3_0,
-            refTypes: new Map(),
-            visitorsData: {},
-        };
-        const bundleVisitor = (0, visitors_1.normalizeVisitors)([
-            {
-                severity: 'error',
-                ruleId: 'configBundler',
-                visitor: {
-                    ref: {
-                        leave(node, ctx, resolved) {
-                            replaceRef(node, resolved, ctx);
-                        },
+async function bundleConfig(document, resolvedRefMap) {
+    const types = (0, types_1.normalizeTypes)(redocly_yaml_1.ConfigTypes);
+    const ctx = {
+        problems: [],
+        oasVersion: oas_types_1.SpecVersion.OAS3_0,
+        refTypes: new Map(),
+        visitorsData: {},
+    };
+    const bundleVisitor = (0, visitors_1.normalizeVisitors)([
+        {
+            severity: 'error',
+            ruleId: 'configBundler',
+            visitor: {
+                ref: {
+                    leave(node, ctx, resolved) {
+                        replaceRef(node, resolved, ctx);
                     },
                 },
             },
-        ], types);
-        (0, walk_1.walkDocument)({
-            document,
-            rootType: types.ConfigRoot,
-            normalizedVisitors: bundleVisitor,
-            resolvedRefMap,
-            ctx,
-        });
-        return (_a = document.parsed) !== null && _a !== void 0 ? _a : {};
+        },
+    ], types);
+    (0, walk_1.walkDocument)({
+        document,
+        rootType: types.ConfigRoot,
+        normalizedVisitors: bundleVisitor,
+        resolvedRefMap,
+        ctx,
     });
+    return document.parsed ?? {};
 }
-exports.bundleConfig = bundleConfig;
-function bundle(opts) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const { ref, doc, externalRefResolver = new resolve_1.BaseResolver(opts.config.resolve), base = null, } = opts;
-        if (!(ref || doc)) {
-            throw new Error('Document or reference is required.\n');
-        }
-        const document = doc === undefined ? yield externalRefResolver.resolveDocument(base, ref, true) : doc;
-        if (document instanceof Error) {
-            throw document;
-        }
-        return bundleDocument(Object.assign(Object.assign({ document }, opts), { config: opts.config.styleguide, externalRefResolver }));
+async function bundle(opts) {
+    const { ref, doc, externalRefResolver = new resolve_1.BaseResolver(opts.config.resolve), base = null, } = opts;
+    if (!(ref || doc)) {
+        throw new Error('Document or reference is required.\n');
+    }
+    const document = doc === undefined ? await externalRefResolver.resolveDocument(base, ref, true) : doc;
+    if (document instanceof Error) {
+        throw document;
+    }
+    opts.collectSpecData?.(document.parsed);
+    return bundleDocument({
+        document,
+        ...opts,
+        config: opts.config.styleguide,
+        externalRefResolver,
     });
 }
-exports.bundle = bundle;
-function bundleFromString(opts) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const { source, absoluteRef, externalRefResolver = new resolve_1.BaseResolver(opts.config.resolve) } = opts;
-        const document = (0, resolve_1.makeDocumentFromString)(source, absoluteRef || '/');
-        return bundleDocument(Object.assign(Object.assign({ document }, opts), { externalRefResolver, config: opts.config.styleguide }));
+async function bundleFromString(opts) {
+    const { source, absoluteRef, externalRefResolver = new resolve_1.BaseResolver(opts.config.resolve) } = opts;
+    const document = (0, resolve_1.makeDocumentFromString)(source, absoluteRef || '/');
+    return bundleDocument({
+        document,
+        ...opts,
+        externalRefResolver,
+        config: opts.config.styleguide,
     });
 }
-exports.bundleFromString = bundleFromString;
-function bundleDocument(opts) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const { document, config, customTypes, externalRefResolver, dereference = false, skipRedoclyRegistryRefs = false, removeUnusedComponents = false, keepUrlRefs = false, } = opts;
-        const specVersion = (0, oas_types_1.detectSpec)(document.parsed);
-        const specMajorVersion = (0, oas_types_1.getMajorSpecVersion)(specVersion);
-        const rules = config.getRulesForOasVersion(specMajorVersion);
-        const types = (0, types_1.normalizeTypes)(config.extendTypes(customTypes !== null && customTypes !== void 0 ? customTypes : (0, oas_types_1.getTypes)(specVersion), specVersion), config);
-        const preprocessors = (0, rules_1.initRules)(rules, config, 'preprocessors', specVersion);
-        const decorators = (0, rules_1.initRules)(rules, config, 'decorators', specVersion);
-        const ctx = {
-            problems: [],
-            oasVersion: specVersion,
-            refTypes: new Map(),
-            visitorsData: {},
-        };
-        if (removeUnusedComponents) {
-            decorators.push({
-                severity: 'error',
-                ruleId: 'remove-unused-components',
-                visitor: specMajorVersion === oas_types_1.SpecMajorVersion.OAS2
-                    ? (0, remove_unused_components_1.RemoveUnusedComponents)({})
-                    : (0, remove_unused_components_2.RemoveUnusedComponents)({}),
-            });
-        }
-        let resolvedRefMap = yield (0, resolve_1.resolveDocument)({
-            rootDocument: document,
-            rootType: types.Root,
-            externalRefResolver,
+async function bundleDocument(opts) {
+    const { document, config, customTypes, externalRefResolver, dereference = false, skipRedoclyRegistryRefs = false, removeUnusedComponents = false, keepUrlRefs = false, } = opts;
+    const specVersion = (0, oas_types_1.detectSpec)(document.parsed);
+    const specMajorVersion = (0, oas_types_1.getMajorSpecVersion)(specVersion);
+    const rules = config.getRulesForOasVersion(specMajorVersion);
+    const types = (0, types_1.normalizeTypes)(config.extendTypes(customTypes ?? (0, oas_types_1.getTypes)(specVersion), specVersion), config);
+    const preprocessors = (0, rules_1.initRules)(rules, config, 'preprocessors', specVersion);
+    const decorators = (0, rules_1.initRules)(rules, config, 'decorators', specVersion);
+    const ctx = {
+        problems: [],
+        oasVersion: specVersion,
+        refTypes: new Map(),
+        visitorsData: {},
+    };
+    if (removeUnusedComponents) {
+        decorators.push({
+            severity: 'error',
+            ruleId: 'remove-unused-components',
+            visitor: specMajorVersion === oas_types_1.SpecMajorVersion.OAS2
+                ? (0, remove_unused_components_1.RemoveUnusedComponents)({})
+                : (0, remove_unused_components_2.RemoveUnusedComponents)({}),
         });
-        if (preprocessors.length > 0) {
-            // Make additional pass to resolve refs defined in preprocessors.
-            (0, walk_1.walkDocument)({
-                document,
-                rootType: types.Root,
-                normalizedVisitors: (0, visitors_1.normalizeVisitors)(preprocessors, types),
-                resolvedRefMap,
-                ctx,
-            });
-            resolvedRefMap = yield (0, resolve_1.resolveDocument)({
-                rootDocument: document,
-                rootType: types.Root,
-                externalRefResolver,
-            });
-        }
-        const bundleVisitor = (0, visitors_1.normalizeVisitors)([
-            {
-                severity: 'error',
-                ruleId: 'bundler',
-                visitor: makeBundleVisitor(specMajorVersion, dereference, skipRedoclyRegistryRefs, document, resolvedRefMap, keepUrlRefs),
-            },
-            ...decorators,
-        ], types);
+    }
+    let resolvedRefMap = await (0, resolve_1.resolveDocument)({
+        rootDocument: document,
+        rootType: types.Root,
+        externalRefResolver,
+    });
+    if (preprocessors.length > 0) {
+        // Make additional pass to resolve refs defined in preprocessors.
         (0, walk_1.walkDocument)({
             document,
             rootType: types.Root,
-            normalizedVisitors: bundleVisitor,
+            normalizedVisitors: (0, visitors_1.normalizeVisitors)(preprocessors, types),
             resolvedRefMap,
             ctx,
         });
-        return {
-            bundle: document,
-            problems: ctx.problems.map((problem) => config.addProblemToIgnore(problem)),
-            fileDependencies: externalRefResolver.getFiles(),
+        resolvedRefMap = await (0, resolve_1.resolveDocument)({
+            rootDocument: document,
             rootType: types.Root,
-            refTypes: ctx.refTypes,
-            visitorsData: ctx.visitorsData,
-        };
+            externalRefResolver,
+        });
+    }
+    const bundleVisitor = (0, visitors_1.normalizeVisitors)([
+        {
+            severity: 'error',
+            ruleId: 'bundler',
+            visitor: makeBundleVisitor(specMajorVersion, dereference, skipRedoclyRegistryRefs, document, resolvedRefMap, keepUrlRefs),
+        },
+        ...decorators,
+    ], types);
+    (0, walk_1.walkDocument)({
+        document,
+        rootType: types.Root,
+        normalizedVisitors: bundleVisitor,
+        resolvedRefMap,
+        ctx,
     });
+    return {
+        bundle: document,
+        problems: ctx.problems.map((problem) => config.addProblemToIgnore(problem)),
+        fileDependencies: externalRefResolver.getFiles(),
+        rootType: types.Root,
+        refTypes: ctx.refTypes,
+        visitorsData: ctx.visitorsData,
+    };
 }
-exports.bundleDocument = bundleDocument;
 function mapTypeToComponent(typeName, version) {
     switch (version) {
         case oas_types_1.SpecMajorVersion.OAS3:
@@ -201,6 +194,15 @@ function mapTypeToComponent(typeName, version) {
                 default:
                     return null;
             }
+        case oas_types_1.SpecMajorVersion.Async3:
+            switch (typeName) {
+                case 'Schema':
+                    return 'schemas';
+                case 'Parameter':
+                    return 'parameters';
+                default:
+                    return null;
+            }
         case oas_types_1.SpecMajorVersion.Arazzo:
             switch (typeName) {
                 case 'Root.x-parameters_items':
@@ -212,7 +214,6 @@ function mapTypeToComponent(typeName, version) {
             }
     }
 }
-exports.mapTypeToComponent = mapTypeToComponent;
 function replaceRef(ref, resolved, ctx) {
     if (!(0, utils_1.isPlainObject)(resolved.node)) {
         ctx.parent[ctx.key] = resolved.node;
@@ -277,6 +278,9 @@ function makeBundleVisitor(version, dereference, skipRedoclyRegistryRefs, rootDo
                 else if (version === oas_types_1.SpecMajorVersion.Async2) {
                     components = root.components = root.components || {};
                 }
+                else if (version === oas_types_1.SpecMajorVersion.Async3) {
+                    components = root.components = root.components || {};
+                }
                 else if (version === oas_types_1.SpecMajorVersion.Arazzo) {
                     components = root.components = root.components || {};
                 }
@@ -321,18 +325,20 @@ function makeBundleVisitor(version, dereference, skipRedoclyRegistryRefs, rootDo
         if (version === oas_types_1.SpecMajorVersion.OAS3) {
             return `#/components/${componentType}/${name}`;
         }
+        else if (version === oas_types_1.SpecMajorVersion.Async2 || version === oas_types_1.SpecMajorVersion.Async3) {
+            return `#/components/${componentType}/${name}`;
+        }
         else {
             return `#/${componentType}/${name}`;
         }
     }
     function isEqualOrEqualRef(node, target, ctx) {
-        var _a;
         if ((0, ref_utils_1.isRef)(node) &&
-            ((_a = ctx.resolve(node, rootLocation.absolutePointer).location) === null || _a === void 0 ? void 0 : _a.absolutePointer) ===
+            ctx.resolve(node, rootLocation.absolutePointer).location?.absolutePointer ===
                 target.location.absolutePointer) {
             return true;
         }
-        return isEqual(node, target.node);
+        return (0, utils_1.dequal)(node, target.node);
     }
     function getComponentName(target, componentType, ctx) {
         const [fileRef, pointer] = [target.location.source.absoluteRef, target.location.pointer];

package/lib/config/all.js

@@ -114,6 +114,15 @@ const all = {
         'channels-kebab-case': 'error',
         'no-channel-trailing-slash': 'error',
     },
+    async3Rules: {
+        spec: 'error',
+        'info-contact': 'error',
+        'operation-operationId': 'error',
+        'tag-description': 'error',
+        'tags-alphabetical': 'error',
+        'channels-kebab-case': 'error',
+        'no-channel-trailing-slash': 'error',
+    },
     arazzoRules: { spec: 'error' },
 };
 exports.default = all;

package/lib/config/builtIn.js

@@ -8,14 +8,17 @@ const minimal_1 = require("./minimal");
 const oas3_1 = require("../rules/oas3");
 const oas2_1 = require("../rules/oas2");
 const async2_1 = require("../rules/async2");
+const async3_1 = require("../rules/async3");
 const arazzo_1 = require("../rules/arazzo");
 const oas3_2 = require("../rules/oas3");
 const oas2_2 = require("../rules/oas2");
 const async2_2 = require("../rules/async2");
+const async3_2 = require("../rules/async3");
 const arazzo_2 = require("../rules/arazzo");
 const oas3_3 = require("../decorators/oas3");
 const oas2_3 = require("../decorators/oas2");
 const async2_3 = require("../decorators/async2");
+const async3_3 = require("../decorators/async3");
 const arazzo_3 = require("../decorators/arazzo");
 exports.builtInConfigs = {
     recommended: recommended_1.default,
@@ -27,23 +30,26 @@ exports.builtInConfigs = {
     },
 };
 exports.defaultPlugin = {
-    id: '',
+    id: '', // default plugin doesn't have id
     rules: {
         oas3: oas3_1.rules,
         oas2: oas2_1.rules,
         async2: async2_1.rules,
+        async3: async3_1.rules,
         arazzo: arazzo_1.rules,
     },
     preprocessors: {
         oas3: oas3_2.preprocessors,
         oas2: oas2_2.preprocessors,
         async2: async2_2.preprocessors,
+        async3: async3_2.preprocessors,
         arazzo: arazzo_2.preprocessors,
     },
     decorators: {
         oas3: oas3_3.decorators,
         oas2: oas2_3.decorators,
         async2: async2_3.decorators,
+        async3: async3_3.decorators,
         arazzo: arazzo_3.decorators,
     },
     configs: exports.builtInConfigs,