@redocly/openapi-core 1.17.1 → 1.18.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @redocly/openapi-core
 
+## 1.18.0
+
+### Minor Changes
+
+- Added support for Arazzo description linting.
+
+### Patch Changes
+
+- Removed `additionalItems` from OAS 3.0.x typings. This keyword is not supported by the specification.
+
 ## 1.17.1
 
 ### Patch Changes

package/lib/bundle.d.ts

@@ -47,4 +47,4 @@ export declare function bundleDocument(opts: {
     removeUnusedComponents?: boolean;
     keepUrlRefs?: boolean;
 }): Promise<BundleResult>;
-export declare function mapTypeToComponent(typeName: string, version: SpecMajorVersion): "definitions" | "examples" | "parameters" | "headers" | "schemas" | "responses" | "requestBodies" | "securitySchemes" | "links" | "callbacks" | null;
+export declare function mapTypeToComponent(typeName: string, version: SpecMajorVersion): "definitions" | "parameters" | "examples" | "headers" | "schemas" | "responses" | "requestBodies" | "securitySchemes" | "links" | "callbacks" | null;

package/lib/bundle.js

@@ -201,6 +201,15 @@ function mapTypeToComponent(typeName, version) {
                 default:
                     return null;
             }
+        case oas_types_1.SpecMajorVersion.Arazzo:
+            switch (typeName) {
+                case 'Root.x-parameters_items':
+                case 'Root.workflows_items.parameters_items':
+                case 'Root.workflows_items.steps_items.parameters_items':
+                    return 'parameters';
+                default:
+                    return null;
+            }
     }
 }
 exports.mapTypeToComponent = mapTypeToComponent;
@@ -265,6 +274,12 @@ function makeBundleVisitor(version, dereference, skipRedoclyRegistryRefs, rootDo
                 else if (version === oas_types_1.SpecMajorVersion.OAS2) {
                     components = root;
                 }
+                else if (version === oas_types_1.SpecMajorVersion.Async2) {
+                    components = root.components = root.components || {};
+                }
+                else if (version === oas_types_1.SpecMajorVersion.Arazzo) {
+                    components = root.components = root.components || {};
+                }
             },
         },
     };

package/lib/config/all.js

@@ -106,8 +106,14 @@ const all = {
         'array-parameter-serialization': 'error',
     },
     async2Rules: {
+        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,10 +8,15 @@ const minimal_1 = require("./minimal");
 const oas3_1 = require("../rules/oas3");
 const oas2_1 = require("../rules/oas2");
 const async2_1 = require("../rules/async2");
+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 arazzo_2 = require("../rules/arazzo");
 const oas3_3 = require("../decorators/oas3");
 const oas2_3 = require("../decorators/oas2");
+const async2_3 = require("../decorators/async2");
+const arazzo_3 = require("../decorators/arazzo");
 exports.builtInConfigs = {
     recommended: recommended_1.default,
     'recommended-strict': recommended_strict_1.default,
@@ -27,16 +32,19 @@ exports.defaultPlugin = {
         oas3: oas3_1.rules,
         oas2: oas2_1.rules,
         async2: async2_1.rules,
+        arazzo: arazzo_1.rules,
     },
     preprocessors: {
         oas3: oas3_2.preprocessors,
         oas2: oas2_2.preprocessors,
-        async2: {},
+        async2: async2_2.preprocessors,
+        arazzo: arazzo_2.preprocessors,
     },
     decorators: {
         oas3: oas3_3.decorators,
         oas2: oas2_3.decorators,
-        async2: {},
+        async2: async2_3.decorators,
+        arazzo: arazzo_3.decorators,
     },
     configs: exports.builtInConfigs,
 };

package/lib/config/config-resolvers.js

@@ -127,7 +127,7 @@ function resolvePlugins(plugins, configPath = '') {
         const plugin = Object.assign(Object.assign({ id }, (pluginModule.configs ? { configs: pluginModule.configs } : {})), (pluginModule.typeExtension ? { typeExtension: pluginModule.typeExtension } : {}));
         if (pluginModule.rules) {
             if (!pluginModule.rules.oas3 && !pluginModule.rules.oas2 && !pluginModule.rules.async2) {
-                throw new Error(`Plugin rules must have \`oas3\`, \`oas2\` or \`async2\` rules "${p}.`);
+                throw new Error(`Plugin rules must have \`oas3\`, \`oas2\`, \`async2\`, or \`arazzo\` rules "${p}.`);
             }
             plugin.rules = {};
             if (pluginModule.rules.oas3) {
@@ -139,11 +139,15 @@ function resolvePlugins(plugins, configPath = '') {
             if (pluginModule.rules.async2) {
                 plugin.rules.async2 = (0, utils_2.prefixRules)(pluginModule.rules.async2, id);
             }
+            if (pluginModule.rules.arazzo) {
+                plugin.rules.arazzo = (0, utils_2.prefixRules)(pluginModule.rules.arazzo, id);
+            }
         }
         if (pluginModule.preprocessors) {
             if (!pluginModule.preprocessors.oas3 &&
                 !pluginModule.preprocessors.oas2 &&
-                !pluginModule.preprocessors.async2) {
+                !pluginModule.preprocessors.async2 &&
+                !pluginModule.preprocessors.arazzo) {
                 throw new Error(`Plugin \`preprocessors\` must have \`oas3\`, \`oas2\` or \`async2\` preprocessors "${p}.`);
             }
             plugin.preprocessors = {};
@@ -156,11 +160,15 @@ function resolvePlugins(plugins, configPath = '') {
             if (pluginModule.preprocessors.async2) {
                 plugin.preprocessors.async2 = (0, utils_2.prefixRules)(pluginModule.preprocessors.async2, id);
             }
+            if (pluginModule.preprocessors.arazzo) {
+                plugin.preprocessors.arazzo = (0, utils_2.prefixRules)(pluginModule.preprocessors.arazzo, id);
+            }
         }
         if (pluginModule.decorators) {
             if (!pluginModule.decorators.oas3 &&
                 !pluginModule.decorators.oas2 &&
-                !pluginModule.decorators.async2) {
+                !pluginModule.decorators.async2 &&
+                !pluginModule.decorators.arazzo) {
                 throw new Error(`Plugin \`decorators\` must have \`oas3\`, \`oas2\` or \`async2\` decorators "${p}.`);
             }
             plugin.decorators = {};
@@ -173,6 +181,9 @@ function resolvePlugins(plugins, configPath = '') {
             if (pluginModule.decorators.async2) {
                 plugin.decorators.async2 = (0, utils_2.prefixRules)(pluginModule.decorators.async2, id);
             }
+            if (pluginModule.decorators.arazzo) {
+                plugin.decorators.arazzo = (0, utils_2.prefixRules)(pluginModule.decorators.arazzo, id);
+            }
         }
         if (pluginModule.assertions) {
             plugin.assertions = pluginModule.assertions;
@@ -276,7 +287,7 @@ function loadExtendStyleguideConfig(filePath, resolver) {
     });
 }
 function getMergedRawStyleguideConfig(rootStyleguideConfig, apiStyleguideConfig) {
-    const resultLint = Object.assign(Object.assign(Object.assign({}, rootStyleguideConfig), (0, 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)
+    const resultLint = Object.assign(Object.assign(Object.assign({}, rootStyleguideConfig), (0, 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), arazzoRules: Object.assign(Object.assign({}, rootStyleguideConfig === null || rootStyleguideConfig === void 0 ? void 0 : rootStyleguideConfig.arazzoRules), apiStyleguideConfig === null || apiStyleguideConfig === void 0 ? void 0 : apiStyleguideConfig.arazzoRules), 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;

package/lib/config/config.d.ts

@@ -1,5 +1,5 @@
 import { NormalizedProblem } from '../walk';
-import { SpecVersion, SpecMajorVersion, Oas2RuleSet, Oas3RuleSet, Async2RuleSet } from '../oas-types';
+import { SpecVersion, SpecMajorVersion, Oas2RuleSet, Oas3RuleSet, Async2RuleSet, ArazzoRuleSet } from '../oas-types';
 import type { NodeType } from '../types';
 import type { DecoratorConfig, Plugin, PreprocessorConfig, Region, ResolveConfig, ResolvedApi, ResolvedConfig, ResolvedStyleguideConfig, RuleConfig, RuleSettings, Telemetry, ThemeRawConfig } from './types';
 export declare const IGNORE_FILE = ".redocly.lint-ignore.yaml";
@@ -31,7 +31,7 @@ export declare class StyleguideConfig {
         preprocessors: string[];
         decorators: string[];
     };
-    getRulesForOasVersion(version: SpecMajorVersion): Oas3RuleSet[] | Oas2RuleSet[] | Async2RuleSet[];
+    getRulesForOasVersion(version: SpecMajorVersion): Oas3RuleSet[] | Oas2RuleSet[] | Async2RuleSet[] | ArazzoRuleSet[];
     skipRules(rules?: string[]): void;
     skipPreprocessors(preprocessors?: string[]): void;
     skipDecorators(decorators?: string[]): void;

package/lib/config/config.js

@@ -37,18 +37,21 @@ class StyleguideConfig {
             [oas_types_1.SpecVersion.OAS3_0]: Object.assign(Object.assign({}, rawConfig.rules), rawConfig.oas3_0Rules),
             [oas_types_1.SpecVersion.OAS3_1]: Object.assign(Object.assign({}, rawConfig.rules), rawConfig.oas3_1Rules),
             [oas_types_1.SpecVersion.Async2]: Object.assign(Object.assign({}, rawConfig.rules), rawConfig.async2Rules),
+            [oas_types_1.SpecVersion.Arazzo]: Object.assign({}, rawConfig.arazzoRules),
         };
         this.preprocessors = {
             [oas_types_1.SpecVersion.OAS2]: Object.assign(Object.assign({}, rawConfig.preprocessors), rawConfig.oas2Preprocessors),
             [oas_types_1.SpecVersion.OAS3_0]: Object.assign(Object.assign({}, rawConfig.preprocessors), rawConfig.oas3_0Preprocessors),
             [oas_types_1.SpecVersion.OAS3_1]: Object.assign(Object.assign({}, rawConfig.preprocessors), rawConfig.oas3_1Preprocessors),
             [oas_types_1.SpecVersion.Async2]: Object.assign(Object.assign({}, rawConfig.preprocessors), rawConfig.async2Preprocessors),
+            [oas_types_1.SpecVersion.Arazzo]: Object.assign({}, rawConfig.arazzoPreprocessors),
         };
         this.decorators = {
             [oas_types_1.SpecVersion.OAS2]: Object.assign(Object.assign({}, rawConfig.decorators), rawConfig.oas2Decorators),
             [oas_types_1.SpecVersion.OAS3_0]: Object.assign(Object.assign({}, rawConfig.decorators), rawConfig.oas3_0Decorators),
             [oas_types_1.SpecVersion.OAS3_1]: Object.assign(Object.assign({}, rawConfig.decorators), rawConfig.oas3_1Decorators),
             [oas_types_1.SpecVersion.Async2]: Object.assign(Object.assign({}, rawConfig.decorators), rawConfig.async2Decorators),
+            [oas_types_1.SpecVersion.Arazzo]: Object.assign({}, rawConfig.arazzoDecorators),
         };
         this.extendPaths = rawConfig.extendPaths || [];
         this.pluginPaths = rawConfig.pluginPaths || [];
@@ -125,6 +128,11 @@ class StyleguideConfig {
                             continue;
                         extendedTypes = plugin.typeExtension.async2(extendedTypes, version);
                         break;
+                    case oas_types_1.SpecVersion.Arazzo:
+                        if (!plugin.typeExtension.arazzo)
+                            continue;
+                        extendedTypes = plugin.typeExtension.arazzo(extendedTypes, version);
+                        break;
                     default:
                         throw new Error('Not implemented');
                 }
@@ -209,6 +217,13 @@ class StyleguideConfig {
                 this.plugins.forEach((p) => { var _a; return ((_a = p.rules) === null || _a === void 0 ? void 0 : _a.async2) && asyncApiRules.push(p.rules.async2); });
                 this.plugins.forEach((p) => { var _a; return ((_a = p.decorators) === null || _a === void 0 ? void 0 : _a.async2) && asyncApiRules.push(p.decorators.async2); });
                 return asyncApiRules;
+            case oas_types_1.SpecMajorVersion.Arazzo:
+                // eslint-disable-next-line no-case-declarations
+                const arazzoRules = []; // default ruleset
+                this.plugins.forEach((p) => { var _a; return ((_a = p.preprocessors) === null || _a === void 0 ? void 0 : _a.arazzo) && arazzoRules.push(p.preprocessors.arazzo); });
+                this.plugins.forEach((p) => { var _a; return ((_a = p.rules) === null || _a === void 0 ? void 0 : _a.arazzo) && arazzoRules.push(p.rules.arazzo); });
+                this.plugins.forEach((p) => { var _a; return ((_a = p.decorators) === null || _a === void 0 ? void 0 : _a.arazzo) && arazzoRules.push(p.decorators.arazzo); });
+                return arazzoRules;
         }
     }
     skipRules(rules) {

package/lib/config/minimal.js

@@ -88,8 +88,16 @@ const minimal = {
         'array-parameter-serialization': 'off',
     },
     async2Rules: {
+        spec: 'error',
+        'info-contact': 'off',
+        'operation-operationId': 'warn',
+        'tag-description': 'warn',
+        'tags-alphabetical': 'off',
         'channels-kebab-case': 'off',
         'no-channel-trailing-slash': 'off',
     },
+    arazzoRules: {
+        spec: 'error',
+    },
 };
 exports.default = minimal;

package/lib/config/recommended-strict.js

@@ -88,8 +88,16 @@ const recommendedStrict = {
         'array-parameter-serialization': 'off',
     },
     async2Rules: {
+        spec: 'error',
+        'info-contact': 'off',
+        'operation-operationId': 'error',
+        'tag-description': 'error',
+        'tags-alphabetical': 'off',
         'channels-kebab-case': 'off',
         'no-channel-trailing-slash': 'off',
     },
+    arazzoRules: {
+        spec: 'error',
+    },
 };
 exports.default = recommendedStrict;

package/lib/config/recommended.js

@@ -88,8 +88,16 @@ const recommended = {
         'array-parameter-serialization': 'off',
     },
     async2Rules: {
+        spec: 'error',
+        'info-contact': 'off',
+        'operation-operationId': 'warn',
+        'tag-description': 'warn',
+        'tags-alphabetical': 'off',
         'channels-kebab-case': 'off',
         'no-channel-trailing-slash': 'off',
     },
+    arazzoRules: {
+        spec: 'error',
+    },
 };
 exports.default = recommended;

package/lib/config/types.d.ts

@@ -1,9 +1,9 @@
 import type { ProblemSeverity, UserContext } from '../walk';
-import type { Oas3PreprocessorsSet, SpecMajorVersion, Oas3DecoratorsSet, Oas2RuleSet, Oas2PreprocessorsSet, Oas2DecoratorsSet, Oas3RuleSet, SpecVersion, Async2PreprocessorsSet, Async2DecoratorsSet, Async2RuleSet, RuleMap } from '../oas-types';
+import type { Oas3PreprocessorsSet, SpecMajorVersion, Oas3DecoratorsSet, Oas2RuleSet, Oas2PreprocessorsSet, Oas2DecoratorsSet, Oas3RuleSet, SpecVersion, Async2PreprocessorsSet, Async2DecoratorsSet, Async2RuleSet, ArazzoRuleSet, ArazzoPreprocessorsSet, ArazzoDecoratorsSet, RuleMap } from '../oas-types';
 import type { NodeType } from '../types';
 import { Location } from '../ref-utils';
 import type { SkipFunctionContext } from '../visitors';
-import { BuiltInAsync2RuleId, BuiltInCommonOASRuleId, BuiltInCommonRuleId, BuiltInOAS2RuleId, BuiltInOAS3RuleId } from '../types/redocly-yaml';
+import { BuiltInAsync2RuleId, BuiltInCommonOASRuleId, BuiltInOAS2RuleId, BuiltInOAS3RuleId, BuiltInArazzoRuleId } from '../types/redocly-yaml';
 export type RuleSeverity = ProblemSeverity | 'off';
 export type RuleSettings = {
     severity: RuleSeverity;
@@ -21,21 +21,24 @@ export type StyleguideRawConfig<T = undefined> = {
     extends?: string[];
     doNotResolveExamples?: boolean;
     recommendedFallback?: boolean;
-    rules?: RuleMap<BuiltInCommonRuleId | BuiltInCommonOASRuleId, RuleConfig, T>;
+    rules?: RuleMap<BuiltInCommonOASRuleId, RuleConfig, T>;
     oas2Rules?: RuleMap<BuiltInOAS2RuleId, RuleConfig, T>;
     oas3_0Rules?: RuleMap<BuiltInOAS3RuleId, RuleConfig, T>;
     oas3_1Rules?: RuleMap<BuiltInOAS3RuleId, RuleConfig, T>;
     async2Rules?: RuleMap<BuiltInAsync2RuleId, RuleConfig, T>;
+    arazzoRules?: RuleMap<BuiltInArazzoRuleId, RuleConfig, T>;
     preprocessors?: Record<string, PreprocessorConfig>;
     oas2Preprocessors?: Record<string, PreprocessorConfig>;
     oas3_0Preprocessors?: Record<string, PreprocessorConfig>;
     oas3_1Preprocessors?: Record<string, PreprocessorConfig>;
     async2Preprocessors?: Record<string, PreprocessorConfig>;
+    arazzoPreprocessors?: Record<string, PreprocessorConfig>;
     decorators?: Record<string, DecoratorConfig>;
     oas2Decorators?: Record<string, DecoratorConfig>;
     oas3_0Decorators?: Record<string, DecoratorConfig>;
     oas3_1Decorators?: Record<string, DecoratorConfig>;
     async2Decorators?: Record<string, DecoratorConfig>;
+    arazzoDecorators?: Record<string, DecoratorConfig>;
 };
 export type ApiStyleguideRawConfig = Omit<StyleguideRawConfig, 'plugins'>;
 export type ResolvedStyleguideConfig = PluginStyleguideConfig & {
@@ -49,11 +52,13 @@ export type PreprocessorsConfig = {
     oas3?: Oas3PreprocessorsSet;
     oas2?: Oas2PreprocessorsSet;
     async2?: Async2PreprocessorsSet;
+    arazzo?: ArazzoPreprocessorsSet;
 };
 export type DecoratorsConfig = {
     oas3?: Oas3DecoratorsSet;
     oas2?: Oas2DecoratorsSet;
     async2?: Async2DecoratorsSet;
+    arazzo?: ArazzoDecoratorsSet;
 };
 export type TypesExtensionFn = (types: Record<string, NodeType>, oasVersion: SpecVersion) => Record<string, NodeType>;
 export type TypeExtensionsConfig = Partial<Record<SpecMajorVersion, TypesExtensionFn>>;
@@ -61,6 +66,7 @@ export type CustomRulesConfig = {
     oas3?: Oas3RuleSet;
     oas2?: Oas2RuleSet;
     async2?: Async2RuleSet;
+    arazzo?: ArazzoRuleSet;
 };
 export type AssertionContext = Partial<UserContext> & SkipFunctionContext & {
     node: any;
@@ -156,5 +162,5 @@ export type ThemeRawConfig = {
     openapi?: Record<string, any>;
     mockServer?: Record<string, any>;
 };
-export type RulesFields = 'rules' | 'oas2Rules' | 'oas3_0Rules' | 'oas3_1Rules' | 'async2Rules' | 'preprocessors' | 'oas2Preprocessors' | 'oas3_0Preprocessors' | 'oas3_1Preprocessors' | 'async2Preprocessors' | 'decorators' | 'oas2Decorators' | 'oas3_0Decorators' | 'oas3_1Decorators' | 'async2Decorators';
+export type RulesFields = 'rules' | 'oas2Rules' | 'oas3_0Rules' | 'oas3_1Rules' | 'async2Rules' | 'arazzoRules' | 'preprocessors' | 'oas2Preprocessors' | 'oas3_0Preprocessors' | 'oas3_1Preprocessors' | 'async2Preprocessors' | 'arazzoPreprocessors' | 'decorators' | 'oas2Decorators' | 'oas3_0Decorators' | 'oas3_1Decorators' | 'arazzoDecorators' | 'async2Decorators';
 export {};

package/lib/config/utils.js

@@ -37,7 +37,7 @@ function transformApiDefinitionsToApis(apiDefinitions) {
 exports.transformApiDefinitionsToApis = transformApiDefinitionsToApis;
 function extractFlatConfig(_a) {
     var _b;
-    var { plugins, extends: _extends, rules, oas2Rules, oas3_0Rules, oas3_1Rules, async2Rules, preprocessors, oas2Preprocessors, oas3_0Preprocessors, oas3_1Preprocessors, async2Preprocessors, decorators, oas2Decorators, oas3_0Decorators, oas3_1Decorators, async2Decorators } = _a, rawConfigRest = __rest(_a, ["plugins", "extends", "rules", "oas2Rules", "oas3_0Rules", "oas3_1Rules", "async2Rules", "preprocessors", "oas2Preprocessors", "oas3_0Preprocessors", "oas3_1Preprocessors", "async2Preprocessors", "decorators", "oas2Decorators", "oas3_0Decorators", "oas3_1Decorators", "async2Decorators"]);
+    var { plugins, extends: _extends, rules, oas2Rules, oas3_0Rules, oas3_1Rules, async2Rules, arazzoRules, preprocessors, oas2Preprocessors, oas3_0Preprocessors, oas3_1Preprocessors, async2Preprocessors, arazzoPreprocessors, decorators, oas2Decorators, oas3_0Decorators, oas3_1Decorators, async2Decorators, arazzoDecorators } = _a, rawConfigRest = __rest(_a, ["plugins", "extends", "rules", "oas2Rules", "oas3_0Rules", "oas3_1Rules", "async2Rules", "arazzoRules", "preprocessors", "oas2Preprocessors", "oas3_0Preprocessors", "oas3_1Preprocessors", "async2Preprocessors", "arazzoPreprocessors", "decorators", "oas2Decorators", "oas3_0Decorators", "oas3_1Decorators", "async2Decorators", "arazzoDecorators"]);
     const styleguideConfig = {
         plugins,
         extends: _extends,
@@ -46,16 +46,19 @@ function extractFlatConfig(_a) {
         oas3_0Rules,
         oas3_1Rules,
         async2Rules,
+        arazzoRules,
         preprocessors,
         oas2Preprocessors,
         oas3_0Preprocessors,
         oas3_1Preprocessors,
         async2Preprocessors,
+        arazzoPreprocessors,
         decorators,
         oas2Decorators,
         oas3_0Decorators,
         oas3_1Decorators,
         async2Decorators,
+        arazzoDecorators,
         doNotResolveExamples: (_b = rawConfigRest.resolve) === null || _b === void 0 ? void 0 : _b.doNotResolveExamples,
     };
     if ((rawConfigRest.lint && rawConfigRest.styleguide) ||
@@ -98,16 +101,19 @@ function mergeExtends(rulesConfList) {
         oas3_0Rules: {},
         oas3_1Rules: {},
         async2Rules: {},
+        arazzoRules: {},
         preprocessors: {},
         oas2Preprocessors: {},
         oas3_0Preprocessors: {},
         oas3_1Preprocessors: {},
         async2Preprocessors: {},
+        arazzoPreprocessors: {},
         decorators: {},
         oas2Decorators: {},
         oas3_0Decorators: {},
         oas3_1Decorators: {},
         async2Decorators: {},
+        arazzoDecorators: {},
         plugins: [],
         pluginPaths: [],
         extendPaths: [],
@@ -125,6 +131,8 @@ function mergeExtends(rulesConfList) {
         (0, utils_1.assignExisting)(result.oas3_1Rules, rulesConf.rules || {});
         Object.assign(result.async2Rules, rulesConf.async2Rules);
         (0, utils_1.assignExisting)(result.async2Rules, rulesConf.rules || {});
+        Object.assign(result.arazzoRules, rulesConf.arazzoRules);
+        (0, utils_1.assignExisting)(result.arazzoRules, rulesConf.rules || {});
         Object.assign(result.preprocessors, rulesConf.preprocessors);
         Object.assign(result.oas2Preprocessors, rulesConf.oas2Preprocessors);
         (0, utils_1.assignExisting)(result.oas2Preprocessors, rulesConf.preprocessors || {});
@@ -134,6 +142,8 @@ function mergeExtends(rulesConfList) {
         (0, utils_1.assignExisting)(result.oas3_1Preprocessors, rulesConf.preprocessors || {});
         Object.assign(result.async2Preprocessors, rulesConf.async2Preprocessors);
         (0, utils_1.assignExisting)(result.async2Preprocessors, rulesConf.preprocessors || {});
+        Object.assign(result.arazzoPreprocessors, rulesConf.arazzoPreprocessors);
+        (0, utils_1.assignExisting)(result.arazzoPreprocessors, rulesConf.preprocessors || {});
         Object.assign(result.decorators, rulesConf.decorators);
         Object.assign(result.oas2Decorators, rulesConf.oas2Decorators);
         (0, utils_1.assignExisting)(result.oas2Decorators, rulesConf.decorators || {});
@@ -143,6 +153,8 @@ function mergeExtends(rulesConfList) {
         (0, utils_1.assignExisting)(result.oas3_1Decorators, rulesConf.decorators || {});
         Object.assign(result.async2Decorators, rulesConf.async2Decorators);
         (0, utils_1.assignExisting)(result.async2Decorators, rulesConf.decorators || {});
+        Object.assign(result.arazzoDecorators, rulesConf.arazzoDecorators);
+        (0, utils_1.assignExisting)(result.arazzoDecorators, rulesConf.decorators || {});
         result.plugins.push(...(rulesConf.plugins || []));
         result.pluginPaths.push(...(rulesConf.pluginPaths || []));
         result.extendPaths.push(...new Set(rulesConf.extendPaths));

package/lib/decorators/arazzo/index.d.ts

@@ -0,0 +1 @@
+export declare const decorators: {};

package/lib/decorators/arazzo/index.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.decorators = void 0;
+exports.decorators = {};

package/lib/decorators/async2/index.d.ts

@@ -0,0 +1 @@
+export declare const decorators: {};

package/lib/decorators/async2/index.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.decorators = void 0;
+exports.decorators = {};

package/lib/index.d.ts

@@ -1,5 +1,6 @@
 export { BundleOutputFormat, readFileFromUrl, slash, doesYamlFileExist, isTruthy, getProxyAgent, pause, } from './utils';
 export { Oas3_1Types } from './types/oas3_1';
+export { ArazzoTypes } from './types/arazzo';
 export { Oas3Types } from './types/oas3';
 export { Oas2Types } from './types/oas2';
 export { AsyncApi2Types } from './types/asyncapi';

package/lib/index.js

@@ -14,8 +14,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.lintFromString = exports.lintDocument = exports.validate = exports.lint = exports.getTotals = exports.formatProblems = exports.getLineColLocation = exports.getAstNodeByPointer = exports.walkDocument = exports.normalizeVisitors = exports.getTypes = exports.detectSpec = exports.SpecVersion = exports.getMajorSpecVersion = exports.SpecMajorVersion = exports.isAbsoluteUrl = exports.isRef = exports.unescapePointer = exports.stringifyYaml = exports.parseYaml = exports.makeDocumentFromString = exports.YamlParseError = exports.ResolveError = exports.resolveDocument = exports.BaseResolver = exports.Source = exports.RedoclyClient = exports.createConfig = exports.CONFIG_FILE_NAMES = exports.findConfig = exports.getConfig = exports.loadConfig = exports.transformConfig = exports.getMergedConfig = exports.IGNORE_FILE = exports.StyleguideConfig = exports.Config = exports.Stats = exports.normalizeTypes = exports.ConfigTypes = exports.AsyncApi2Types = exports.Oas2Types = exports.Oas3Types = exports.Oas3_1Types = exports.pause = exports.getProxyAgent = exports.isTruthy = exports.doesYamlFileExist = exports.slash = exports.readFileFromUrl = void 0;
-exports.bundleFromString = exports.mapTypeToComponent = exports.bundleDocument = exports.bundle = exports.lintConfig = void 0;
+exports.lintDocument = exports.validate = exports.lint = exports.getTotals = exports.formatProblems = exports.getLineColLocation = exports.getAstNodeByPointer = exports.walkDocument = exports.normalizeVisitors = exports.getTypes = exports.detectSpec = exports.SpecVersion = exports.getMajorSpecVersion = exports.SpecMajorVersion = exports.isAbsoluteUrl = exports.isRef = exports.unescapePointer = exports.stringifyYaml = exports.parseYaml = exports.makeDocumentFromString = exports.YamlParseError = exports.ResolveError = exports.resolveDocument = exports.BaseResolver = exports.Source = exports.RedoclyClient = exports.createConfig = exports.CONFIG_FILE_NAMES = exports.findConfig = exports.getConfig = exports.loadConfig = exports.transformConfig = exports.getMergedConfig = exports.IGNORE_FILE = exports.StyleguideConfig = exports.Config = exports.Stats = exports.normalizeTypes = exports.ConfigTypes = exports.AsyncApi2Types = exports.Oas2Types = exports.Oas3Types = exports.ArazzoTypes = exports.Oas3_1Types = exports.pause = exports.getProxyAgent = exports.isTruthy = exports.doesYamlFileExist = exports.slash = exports.readFileFromUrl = void 0;
+exports.bundleFromString = exports.mapTypeToComponent = exports.bundleDocument = exports.bundle = exports.lintConfig = exports.lintFromString = void 0;
 var utils_1 = require("./utils");
 Object.defineProperty(exports, "readFileFromUrl", { enumerable: true, get: function () { return utils_1.readFileFromUrl; } });
 Object.defineProperty(exports, "slash", { enumerable: true, get: function () { return utils_1.slash; } });
@@ -25,6 +25,8 @@ Object.defineProperty(exports, "getProxyAgent", { enumerable: true, get: functio
 Object.defineProperty(exports, "pause", { enumerable: true, get: function () { return utils_1.pause; } });
 var oas3_1_1 = require("./types/oas3_1");
 Object.defineProperty(exports, "Oas3_1Types", { enumerable: true, get: function () { return oas3_1_1.Oas3_1Types; } });
+var arazzo_1 = require("./types/arazzo");
+Object.defineProperty(exports, "ArazzoTypes", { enumerable: true, get: function () { return arazzo_1.ArazzoTypes; } });
 var oas3_1 = require("./types/oas3");
 Object.defineProperty(exports, "Oas3Types", { enumerable: true, get: function () { return oas3_1.Oas3Types; } });
 var oas2_1 = require("./types/oas2");

package/lib/oas-types.d.ts

@@ -1,27 +1,32 @@
-import { Oas3Rule, Oas3Preprocessor, Oas2Rule, Oas2Preprocessor, Async2Preprocessor, Async2Rule } from './visitors';
-import { BuiltInAsync2RuleId, BuiltInCommonOASRuleId, BuiltInCommonRuleId, BuiltInOAS2RuleId, BuiltInOAS3RuleId } from './types/redocly-yaml';
+import { Oas3Rule, Oas3Preprocessor, Oas2Rule, Oas2Preprocessor, Async2Preprocessor, Async2Rule, ArazzoPreprocessor, ArazzoRule } from './visitors';
+import { BuiltInAsync2RuleId, BuiltInCommonOASRuleId, BuiltInArazzoRuleId, BuiltInOAS2RuleId, BuiltInOAS3RuleId } from './types/redocly-yaml';
 export type RuleSet<T> = Record<string, T>;
 export declare enum SpecVersion {
     OAS2 = "oas2",
     OAS3_0 = "oas3_0",
     OAS3_1 = "oas3_1",
-    Async2 = "async2"
+    Async2 = "async2",
+    Arazzo = "arazzo"
 }
 export declare enum SpecMajorVersion {
     OAS2 = "oas2",
     OAS3 = "oas3",
-    Async2 = "async2"
+    Async2 = "async2",
+    Arazzo = "arazzo"
 }
 export type RuleMap<Key extends string, RuleConfig, T> = Record<T extends 'built-in' ? Key : string, RuleConfig>;
-export type Oas3RuleSet<T = undefined> = RuleMap<BuiltInCommonRuleId | BuiltInCommonOASRuleId | BuiltInOAS3RuleId | 'assertions', Oas3Rule, T>;
-export type Oas2RuleSet<T = undefined> = RuleMap<BuiltInCommonRuleId | BuiltInCommonOASRuleId | BuiltInOAS2RuleId | 'assertions', Oas2Rule, T>;
-export type Async2RuleSet<T = undefined> = RuleMap<BuiltInCommonRuleId | BuiltInAsync2RuleId | 'assertions', Async2Rule, T>;
+export type Oas3RuleSet<T = undefined> = RuleMap<BuiltInCommonOASRuleId | BuiltInOAS3RuleId | 'assertions', Oas3Rule, T>;
+export type Oas2RuleSet<T = undefined> = RuleMap<BuiltInCommonOASRuleId | BuiltInOAS2RuleId | 'assertions', Oas2Rule, T>;
+export type Async2RuleSet<T = undefined> = RuleMap<BuiltInAsync2RuleId | 'assertions', Async2Rule, T>;
+export type ArazzoRuleSet<T = undefined> = RuleMap<BuiltInArazzoRuleId | 'assertions', ArazzoRule, T>;
 export type Oas3PreprocessorsSet = Record<string, Oas3Preprocessor>;
 export type Oas2PreprocessorsSet = Record<string, Oas2Preprocessor>;
 export type Async2PreprocessorsSet = Record<string, Async2Preprocessor>;
+export type ArazzoPreprocessorsSet = Record<string, ArazzoPreprocessor>;
 export type Oas3DecoratorsSet = Record<string, Oas3Preprocessor>;
 export type Oas2DecoratorsSet = Record<string, Oas2Preprocessor>;
 export type Async2DecoratorsSet = Record<string, Async2Preprocessor>;
+export type ArazzoDecoratorsSet = Record<string, ArazzoPreprocessor>;
 export declare function detectSpec(root: any): SpecVersion;
 export declare function getMajorSpecVersion(version: SpecVersion): SpecMajorVersion;
 export declare function getTypes(spec: SpecVersion): Record<string, import("./types").NodeType> | Record<"Root" | "Tag" | "ExternalDocs" | "SecurityRequirement" | "Info" | "Contact" | "License" | "Paths" | "PathItem" | "Parameter" | "Operation" | "Example" | "Header" | "Responses" | "Response" | "Schema" | "Xml" | "SchemaProperties" | "NamedSchemas" | "NamedResponses" | "NamedParameters" | "NamedSecuritySchemes" | "SecurityScheme" | "Examples" | "ExamplesMap" | "TagList" | "SecurityRequirementList" | "ParameterList" | "ParameterItems" | "TagGroup" | "TagGroups" | "EnumDescriptions" | "Logo" | "XCodeSample" | "XCodeSampleList" | "XServer" | "XServerList", import("./types").NodeType> | Record<"Root" | "Tag" | "ExternalDocs" | "Server" | "ServerVariable" | "SecurityRequirement" | "Info" | "Contact" | "License" | "Paths" | "PathItem" | "Callback" | "CallbacksMap" | "Parameter" | "Operation" | "RequestBody" | "MediaTypesMap" | "MediaType" | "Example" | "Encoding" | "Header" | "Responses" | "Response" | "Link" | "Schema" | "Xml" | "SchemaProperties" | "DiscriminatorMapping" | "Discriminator" | "Components" | "NamedSchemas" | "NamedResponses" | "NamedParameters" | "NamedExamples" | "NamedRequestBodies" | "NamedHeaders" | "NamedSecuritySchemes" | "NamedLinks" | "NamedCallbacks" | "ImplicitFlow" | "PasswordFlow" | "ClientCredentials" | "AuthorizationCode" | "OAuth2Flows" | "SecurityScheme" | "ServerVariablesMap" | "ExamplesMap" | "EncodingMap" | "HeadersMap" | "LinksMap" | "WebhooksMap" | "TagList" | "SecurityRequirementList" | "ParameterList" | "TagGroup" | "TagGroups" | "EnumDescriptions" | "Logo" | "XCodeSample" | "XCodeSampleList" | "ServerList" | "XUsePkce", import("./types").NodeType> | Record<"Root" | "Info" | "License" | "Operation" | "Schema" | "SchemaProperties" | "Components" | "SecurityScheme" | "NamedPathItems" | "DependentRequired", import("./types").NodeType>;

package/lib/oas-types.js

@@ -5,24 +5,28 @@ const oas2_1 = require("./types/oas2");
 const oas3_1 = require("./types/oas3");
 const oas3_1_1 = require("./types/oas3_1");
 const asyncapi_1 = require("./types/asyncapi");
+const arazzo_1 = require("./types/arazzo");
 var SpecVersion;
 (function (SpecVersion) {
     SpecVersion["OAS2"] = "oas2";
     SpecVersion["OAS3_0"] = "oas3_0";
     SpecVersion["OAS3_1"] = "oas3_1";
     SpecVersion["Async2"] = "async2";
+    SpecVersion["Arazzo"] = "arazzo";
 })(SpecVersion || (exports.SpecVersion = SpecVersion = {}));
 var SpecMajorVersion;
 (function (SpecMajorVersion) {
     SpecMajorVersion["OAS2"] = "oas2";
     SpecMajorVersion["OAS3"] = "oas3";
     SpecMajorVersion["Async2"] = "async2";
+    SpecMajorVersion["Arazzo"] = "arazzo";
 })(SpecMajorVersion || (exports.SpecMajorVersion = SpecMajorVersion = {}));
 const typesMap = {
     [SpecVersion.OAS2]: oas2_1.Oas2Types,
     [SpecVersion.OAS3_0]: oas3_1.Oas3Types,
     [SpecVersion.OAS3_1]: oas3_1_1.Oas3_1Types,
     [SpecVersion.Async2]: asyncapi_1.AsyncApi2Types,
+    [SpecVersion.Arazzo]: arazzo_1.ArazzoTypes,
 };
 function detectSpec(root) {
     if (typeof root !== 'object') {
@@ -50,6 +54,9 @@ function detectSpec(root) {
     if (root.asyncapi) {
         throw new Error(`Unsupported AsyncAPI version: ${root.asyncapi}`);
     }
+    if (root.arazzo && root.arazzo.startsWith('1.')) {
+        return SpecVersion.Arazzo;
+    }
     throw new Error(`Unsupported specification`);
 }
 exports.detectSpec = detectSpec;
@@ -60,6 +67,9 @@ function getMajorSpecVersion(version) {
     else if (version === SpecVersion.Async2) {
         return SpecMajorVersion.Async2;
     }
+    else if (version === SpecVersion.Arazzo) {
+        return SpecMajorVersion.Arazzo;
+    }
     else {
         return SpecMajorVersion.OAS3;
     }

package/lib/rules/arazzo/index.d.ts

@@ -0,0 +1,3 @@
+import type { ArazzoRuleSet } from '../../oas-types';
+export declare const rules: ArazzoRuleSet<'built-in'>;
+export declare const preprocessors: {};

package/lib/rules/arazzo/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.preprocessors = exports.rules = void 0;
+const spec_1 = require("../common/spec");
+const assertions_1 = require("../common/assertions");
+exports.rules = {
+    spec: spec_1.Spec,
+    assertions: assertions_1.Assertions,
+};
+exports.preprocessors = {};

package/lib/rules/common/spec.d.ts

@@ -1,2 +1,2 @@
-import type { Oas3Rule, Oas2Rule, Async2Rule } from '../../visitors';
-export declare const Spec: Oas3Rule | Oas2Rule | Async2Rule;
+import type { Oas3Rule, Oas2Rule, Async2Rule, ArazzoRule } from '../../visitors';
+export declare const Spec: Oas3Rule | Oas2Rule | Async2Rule | ArazzoRule;