@redocly/openapi-core 1.18.1 → 1.20.0

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @redocly/openapi-core
 
+## 1.20.0
+
+### Minor Changes
+
+- Added support for ESM plugins and importing of plugins directly from npm package: `@vendor/package/plugin.js` instead of `./node_modules/@vendor/package/plugin.js`.
+- Added `info-license-strict` rule as a replacement of the `info-license-url` to support the OpenAPI 3.1 changes to allow identifier or URL license details.
+- Changed plugins format to export a function instead of an object for compatibility with other Redocly products. The backwards compatibility with an old format of plugins is maintained.
+
+### Patch Changes
+
+- Updated @redocly/config to v0.9.0.
+
+## 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

package/__tests__/utils.ts

@@ -45,7 +45,7 @@ export const yamlSerializer = {
   },
 };
 
-export function makeConfigForRuleset(
+export async function makeConfigForRuleset(
   rules: Oas3RuleSet,
   plugin?: Partial<Plugin>,
   version: string = 'oas3'
@@ -55,7 +55,7 @@ export function makeConfigForRuleset(
   Object.keys(rules).forEach((name) => {
     rulesConf[`${ruleId}/${name}`] = 'error';
   });
-  const plugins = resolvePlugins([
+  const plugins = await resolvePlugins([
     {
       ...plugin,
       id: ruleId,
@@ -69,17 +69,24 @@ export function makeConfigForRuleset(
   });
 }
 
-export async function makeConfig(
-  rules: Record<string, RuleConfig>,
-  decorators?: Record<string, DecoratorConfig>,
-  configPath?: string
-) {
+export async function makeConfig({
+  rules,
+  decorators,
+  configPath,
+  arazzoRules,
+}: {
+  rules: Record<string, RuleConfig>;
+  decorators?: Record<string, DecoratorConfig>;
+  configPath?: string;
+  arazzoRules?: Record<string, RuleConfig>;
+}) {
   return new StyleguideConfig(
     await resolveStyleguideConfig({
       styleguideConfig: {
         plugins: [],
         extends: [],
         rules,
+        arazzoRules,
         decorators,
       },
     }),

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

@@ -1,3 +1,4 @@
 export declare const name = "Validate with 50 top-level rules";
 export declare const count = 10;
+export declare function setupAsync(): Promise<void>;
 export declare function measureAsync(): Promise<import("../..").NormalizedProblem[]>;

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

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.measureAsync = exports.count = exports.name = void 0;
+exports.count = exports.name = void 0;
+exports.setupAsync = setupAsync;
+exports.measureAsync = measureAsync;
 const fs_1 = require("fs");
 const path_1 = require("path");
 const lint_1 = require("../../lint");
@@ -23,7 +25,10 @@ for (let i = 0; i < 50; i++) {
         };
     };
 }
-const config = (0, utils_1.makeConfigForRuleset)(ruleset);
+let config;
+async function setupAsync() {
+    config = await (0, utils_1.makeConfigForRuleset)(ruleset);
+}
 function measureAsync() {
     return (0, lint_1.lintDocument)({
         externalRefResolver: new resolve_1.BaseResolver(),
@@ -31,4 +36,3 @@ function measureAsync() {
         config,
     });
 }
-exports.measureAsync = measureAsync;

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

@@ -1,3 +1,4 @@
 export declare const name = "Validate with single nested rule";
 export declare const count = 10;
+export declare function setupAsync(): Promise<void>;
 export declare function measureAsync(): Promise<import("../..").NormalizedProblem[]>;

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

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.measureAsync = exports.count = exports.name = void 0;
+exports.count = exports.name = void 0;
+exports.setupAsync = setupAsync;
+exports.measureAsync = measureAsync;
 const fs_1 = require("fs");
 const path_1 = require("path");
 const lint_1 = require("../../lint");
@@ -29,7 +31,10 @@ const visitor = {
         };
     },
 };
-const config = (0, utils_1.makeConfigForRuleset)(visitor);
+let config;
+async function setupAsync() {
+    config = await (0, utils_1.makeConfigForRuleset)(visitor);
+}
 function measureAsync() {
     return (0, lint_1.lintDocument)({
         externalRefResolver: new resolve_1.BaseResolver(),
@@ -37,4 +42,3 @@ function measureAsync() {
         config,
     });
 }
-exports.measureAsync = measureAsync;

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

@@ -1,3 +1,4 @@
 export declare const name = "Validate with no rules";
 export declare const count = 10;
+export declare function setupAsync(): Promise<void>;
 export declare function measureAsync(): Promise<import("../..").NormalizedProblem[]>;

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

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.measureAsync = exports.count = exports.name = void 0;
+exports.count = exports.name = void 0;
+exports.setupAsync = setupAsync;
+exports.measureAsync = measureAsync;
 const fs_1 = require("fs");
 const path_1 = require("path");
 const lint_1 = require("../../lint");
@@ -10,7 +12,10 @@ exports.name = 'Validate with no rules';
 exports.count = 10;
 const rebillyDefinitionRef = (0, path_1.resolve)((0, path_1.join)(__dirname, 'rebilly.yaml'));
 const rebillyDocument = (0, utils_1.parseYamlToDocument)((0, fs_1.readFileSync)(rebillyDefinitionRef, 'utf-8'), rebillyDefinitionRef);
-const config = (0, utils_1.makeConfigForRuleset)({});
+let config;
+async function setupAsync() {
+    config = await (0, utils_1.makeConfigForRuleset)({});
+}
 function measureAsync() {
     return (0, lint_1.lintDocument)({
         externalRefResolver: new resolve_1.BaseResolver(),
@@ -18,4 +23,3 @@ function measureAsync() {
         config,
     });
 }
-exports.measureAsync = measureAsync;

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

@@ -1,3 +1,4 @@
 export declare const name = "Validate with single top-level rule and report";
 export declare const count = 10;
+export declare function setupAsync(): Promise<void>;
 export declare function measureAsync(): Promise<import("../..").NormalizedProblem[]>;

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

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.measureAsync = exports.count = exports.name = void 0;
+exports.count = exports.name = void 0;
+exports.setupAsync = setupAsync;
+exports.measureAsync = measureAsync;
 const fs_1 = require("fs");
 const path_1 = require("path");
 const lint_1 = require("../../lint");
@@ -10,19 +12,22 @@ exports.name = 'Validate with single top-level rule and report';
 exports.count = 10;
 const rebillyDefinitionRef = (0, path_1.resolve)((0, path_1.join)(__dirname, 'rebilly.yaml'));
 const rebillyDocument = (0, utils_1.parseYamlToDocument)((0, fs_1.readFileSync)(rebillyDefinitionRef, 'utf-8'), rebillyDefinitionRef);
-const config = (0, utils_1.makeConfigForRuleset)({
-    test: () => {
-        return {
-            Schema(schema, ctx) {
-                if (schema.type === 'number') {
-                    ctx.report({
-                        message: 'type number is not allowed',
-                    });
-                }
-            },
-        };
-    },
-});
+let config;
+async function setupAsync() {
+    config = await (0, utils_1.makeConfigForRuleset)({
+        test: () => {
+            return {
+                Schema(schema, ctx) {
+                    if (schema.type === 'number') {
+                        ctx.report({
+                            message: 'type number is not allowed',
+                        });
+                    }
+                },
+            };
+        },
+    });
+}
 function measureAsync() {
     return (0, lint_1.lintDocument)({
         externalRefResolver: new resolve_1.BaseResolver(),
@@ -30,4 +35,3 @@ function measureAsync() {
         config,
     });
 }
-exports.measureAsync = measureAsync;

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

@@ -1,3 +1,4 @@
 export declare const name = "Validate with single top-level rule";
 export declare const count = 10;
+export declare function setupAsync(): Promise<void>;
 export declare function measureAsync(): Promise<import("../..").NormalizedProblem[]>;

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

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.measureAsync = exports.count = exports.name = void 0;
+exports.count = exports.name = void 0;
+exports.setupAsync = setupAsync;
+exports.measureAsync = measureAsync;
 const fs_1 = require("fs");
 const path_1 = require("path");
 const lint_1 = require("../../lint");
@@ -10,18 +12,21 @@ exports.name = 'Validate with single top-level rule';
 exports.count = 10;
 const rebillyDefinitionRef = (0, path_1.resolve)((0, path_1.join)(__dirname, 'rebilly.yaml'));
 const rebillyDocument = (0, utils_1.parseYamlToDocument)((0, fs_1.readFileSync)(rebillyDefinitionRef, 'utf-8'), rebillyDefinitionRef);
-const config = (0, utils_1.makeConfigForRuleset)({
-    test: () => {
-        let count = 0;
-        return {
-            Schema() {
-                count++;
-                if (count === -1)
-                    throw new Error('Disable optimization');
-            },
-        };
-    },
-});
+let config;
+async function setupAsync() {
+    config = await (0, utils_1.makeConfigForRuleset)({
+        test: () => {
+            let count = 0;
+            return {
+                Schema() {
+                    count++;
+                    if (count === -1)
+                        throw new Error('Disable optimization');
+                },
+            };
+        },
+    });
+}
 function measureAsync() {
     return (0, lint_1.lintDocument)({
         externalRefResolver: new resolve_1.BaseResolver(),
@@ -29,4 +34,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.d.ts

@@ -1,6 +1,6 @@
-import { Document } from '../resolve';
-import { Oas3RuleSet } from '../oas-types';
 import { StyleguideConfig } from '../config';
+import type { Document } from '../resolve';
+import type { Oas3RuleSet } from '../oas-types';
 import type { Plugin } from '../config/types';
 export declare function parseYamlToDocument(body: string, absoluteRef?: string): Document;
-export declare function makeConfigForRuleset(rules: Oas3RuleSet, plugin?: Partial<Plugin>): StyleguideConfig;
+export declare function makeConfigForRuleset(rules: Oas3RuleSet, plugin?: Partial<Plugin>): Promise<StyleguideConfig>;

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,17 +11,20 @@ function parseYamlToDocument(body, absoluteRef = '') {
         parsed: (0, js_yaml_1.parseYaml)(body, { filename: absoluteRef }),
     };
 }
-exports.parseYamlToDocument = parseYamlToDocument;
-function makeConfigForRuleset(rules, plugin) {
+async function makeConfigForRuleset(rules, plugin) {
     const rulesConf = {};
     const ruleId = 'test';
     Object.keys(rules).forEach((name) => {
         rulesConf[`${ruleId}/${name}`] = 'error';
     });
     const extendConfigs = [
-        (0, config_1.resolvePlugins)([
-            Object.assign(Object.assign({}, plugin), { id: ruleId, rules: { oas3: rules } }),
-        ]),
+        (await (0, config_1.resolvePlugins)([
+            {
+                ...plugin,
+                id: ruleId,
+                rules: { oas3: rules },
+            },
+        ])),
     ];
     if (rules) {
         extendConfigs.push({ 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;