@redocly/openapi-core 1.1.0 → 1.2.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @redocly/openapi-core
 
+## 1.2.0
+
+### Minor Changes
+
+- Added support for linting AsyncAPI v2 files, so that a wider range of API descriptions can use the Redocly linting workflow.
+
+### Patch Changes
+
+- Renamed API definition to API description for consistency.
+
 ## 1.1.0
 
 ### Minor Changes

package/lib/bundle.d.ts

@@ -2,7 +2,7 @@ import { BaseResolver, Document } from './resolve';
 import { Oas3Rule } from './visitors';
 import { NormalizedNodeType, NodeType } from './types';
 import { NormalizedProblem } from './walk';
-import { OasMajorVersion } from './oas-types';
+import { SpecMajorVersion } from './oas-types';
 import type { Config, StyleguideConfig } from './config';
 export declare type Oas3RuleSet = Record<string, Oas3Rule>;
 export declare enum OasVersion {
@@ -39,4 +39,4 @@ export declare function bundleDocument(opts: {
     removeUnusedComponents?: boolean;
     keepUrlRefs?: boolean;
 }): Promise<BundleResult>;
-export declare function mapTypeToComponent(typeName: string, version: OasMajorVersion): "parameters" | "examples" | "headers" | "schemas" | "responses" | "requestBodies" | "securitySchemes" | "links" | "callbacks" | "definitions" | null;
+export declare function mapTypeToComponent(typeName: string, version: SpecMajorVersion): "responses" | "parameters" | "examples" | "headers" | "schemas" | "requestBodies" | "securitySchemes" | "links" | "callbacks" | "definitions" | null;

package/lib/bundle.js

@@ -13,9 +13,6 @@ exports.mapTypeToComponent = exports.bundleDocument = exports.bundle = exports.O
 const isEqual = require("lodash.isequal");
 const resolve_1 = require("./resolve");
 const visitors_1 = require("./visitors");
-const oas3_1 = require("./types/oas3");
-const oas2_1 = require("./types/oas2");
-const oas3_1_1 = require("./types/oas3_1");
 const types_1 = require("./types");
 const walk_1 = require("./walk");
 const oas_types_1 = require("./oas-types");
@@ -49,19 +46,15 @@ exports.bundle = bundle;
 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 oasVersion = oas_types_1.detectOpenAPI(document.parsed);
-        const oasMajorVersion = oas_types_1.openAPIMajor(oasVersion);
-        const rules = config.getRulesForOasVersion(oasMajorVersion);
-        const types = types_1.normalizeTypes(config.extendTypes((customTypes !== null && customTypes !== void 0 ? customTypes : oasMajorVersion === oas_types_1.OasMajorVersion.Version3)
-            ? oasVersion === OasVersion.Version3_1
-                ? oas3_1_1.Oas3_1Types
-                : oas3_1.Oas3Types
-            : oas2_1.Oas2Types, oasVersion), config);
-        const preprocessors = rules_1.initRules(rules, config, 'preprocessors', oasVersion);
-        const decorators = rules_1.initRules(rules, config, 'decorators', oasVersion);
+        const specVersion = oas_types_1.detectSpec(document.parsed);
+        const specMajorVersion = oas_types_1.getMajorSpecVersion(specVersion);
+        const rules = config.getRulesForOasVersion(specMajorVersion);
+        const types = types_1.normalizeTypes(config.extendTypes(customTypes !== null && customTypes !== void 0 ? customTypes : oas_types_1.getTypes(specVersion), specVersion), config);
+        const preprocessors = rules_1.initRules(rules, config, 'preprocessors', specVersion);
+        const decorators = rules_1.initRules(rules, config, 'decorators', specVersion);
         const ctx = {
             problems: [],
-            oasVersion: oasVersion,
+            oasVersion: specVersion,
             refTypes: new Map(),
             visitorsData: {},
         };
@@ -69,7 +62,7 @@ function bundleDocument(opts) {
             decorators.push({
                 severity: 'error',
                 ruleId: 'remove-unused-components',
-                visitor: oasMajorVersion === oas_types_1.OasMajorVersion.Version2
+                visitor: specMajorVersion === oas_types_1.SpecMajorVersion.OAS2
                     ? remove_unused_components_1.RemoveUnusedComponents({})
                     : remove_unused_components_2.RemoveUnusedComponents({}),
             });
@@ -98,7 +91,7 @@ function bundleDocument(opts) {
             {
                 severity: 'error',
                 ruleId: 'bundler',
-                visitor: makeBundleVisitor(oasMajorVersion, dereference, skipRedoclyRegistryRefs, document, resolvedRefMap, keepUrlRefs),
+                visitor: makeBundleVisitor(specMajorVersion, dereference, skipRedoclyRegistryRefs, document, resolvedRefMap, keepUrlRefs),
             },
             ...decorators,
         ], types);
@@ -122,7 +115,7 @@ function bundleDocument(opts) {
 exports.bundleDocument = bundleDocument;
 function mapTypeToComponent(typeName, version) {
     switch (version) {
-        case oas_types_1.OasMajorVersion.Version3:
+        case oas_types_1.SpecMajorVersion.OAS3:
             switch (typeName) {
                 case 'Schema':
                     return 'schemas';
@@ -145,7 +138,7 @@ function mapTypeToComponent(typeName, version) {
                 default:
                     return null;
             }
-        case oas_types_1.OasMajorVersion.Version2:
+        case oas_types_1.SpecMajorVersion.OAS2:
             switch (typeName) {
                 case 'Schema':
                     return 'definitions';
@@ -156,6 +149,15 @@ function mapTypeToComponent(typeName, version) {
                 default:
                     return null;
             }
+        case oas_types_1.SpecMajorVersion.Async2:
+            switch (typeName) {
+                case 'Schema':
+                    return 'schemas';
+                case 'Parameter':
+                    return 'parameters';
+                default:
+                    return null;
+            }
     }
 }
 exports.mapTypeToComponent = mapTypeToComponent;
@@ -202,16 +204,16 @@ function makeBundleVisitor(version, dereference, skipRedoclyRegistryRefs, rootDo
         Root: {
             enter(root, ctx) {
                 rootLocation = ctx.location;
-                if (version === oas_types_1.OasMajorVersion.Version3) {
+                if (version === oas_types_1.SpecMajorVersion.OAS3) {
                     components = root.components = root.components || {};
                 }
-                else if (version === oas_types_1.OasMajorVersion.Version2) {
+                else if (version === oas_types_1.SpecMajorVersion.OAS2) {
                     components = root;
                 }
             },
         },
     };
-    if (version === oas_types_1.OasMajorVersion.Version3) {
+    if (version === oas_types_1.SpecMajorVersion.OAS3) {
         visitor.DiscriminatorMapping = {
             leave(mapping, ctx) {
                 for (const name of Object.keys(mapping)) {
@@ -259,7 +261,7 @@ function makeBundleVisitor(version, dereference, skipRedoclyRegistryRefs, rootDo
         components[componentType] = components[componentType] || {};
         const name = getComponentName(target, componentType, ctx);
         components[componentType][name] = target.node;
-        if (version === oas_types_1.OasMajorVersion.Version3) {
+        if (version === oas_types_1.SpecMajorVersion.OAS3) {
             return `#/components/${componentType}/${name}`;
         }
         else {

package/lib/config/builtIn.js

@@ -6,6 +6,7 @@ const all_1 = require("./all");
 const minimal_1 = require("./minimal");
 const oas3_1 = require("../rules/oas3");
 const oas2_1 = require("../rules/oas2");
+const async2_1 = require("../rules/async2");
 const oas3_2 = require("../rules/oas3");
 const oas2_2 = require("../rules/oas2");
 const oas3_3 = require("../decorators/oas3");
@@ -23,14 +24,17 @@ exports.defaultPlugin = {
     rules: {
         oas3: oas3_1.rules,
         oas2: oas2_1.rules,
+        async2: async2_1.rules,
     },
     preprocessors: {
         oas3: oas3_2.preprocessors,
         oas2: oas2_2.preprocessors,
+        async2: {},
     },
     decorators: {
         oas3: oas3_3.decorators,
         oas2: oas2_3.decorators,
+        async2: {},
     },
     configs: exports.builtInConfigs,
 };

package/lib/config/config-resolvers.js

@@ -105,8 +105,8 @@ function resolvePlugins(plugins, configPath = '') {
         seenPluginIds.set(id, p.toString());
         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) {
-                throw new Error(`Plugin rules must have \`oas3\` or \`oas2\` rules "${p}.`);
+            if (!pluginModule.rules.oas3 && !pluginModule.rules.oas2 && !pluginModule.rules.async2) {
+                throw new Error(`Plugin rules must have \`oas3\`, \`oas2\` or \`async2\` rules "${p}.`);
             }
             plugin.rules = {};
             if (pluginModule.rules.oas3) {
@@ -115,10 +115,15 @@ function resolvePlugins(plugins, configPath = '') {
             if (pluginModule.rules.oas2) {
                 plugin.rules.oas2 = utils_2.prefixRules(pluginModule.rules.oas2, id);
             }
+            if (pluginModule.rules.async2) {
+                plugin.rules.async2 = utils_2.prefixRules(pluginModule.rules.async2, id);
+            }
         }
         if (pluginModule.preprocessors) {
-            if (!pluginModule.preprocessors.oas3 && !pluginModule.preprocessors.oas2) {
-                throw new Error(`Plugin \`preprocessors\` must have \`oas3\` or \`oas2\` preprocessors "${p}.`);
+            if (!pluginModule.preprocessors.oas3 &&
+                !pluginModule.preprocessors.oas2 &&
+                !pluginModule.preprocessors.async2) {
+                throw new Error(`Plugin \`preprocessors\` must have \`oas3\`, \`oas2\` or \`async2\` preprocessors "${p}.`);
             }
             plugin.preprocessors = {};
             if (pluginModule.preprocessors.oas3) {
@@ -127,10 +132,15 @@ function resolvePlugins(plugins, configPath = '') {
             if (pluginModule.preprocessors.oas2) {
                 plugin.preprocessors.oas2 = utils_2.prefixRules(pluginModule.preprocessors.oas2, id);
             }
+            if (pluginModule.preprocessors.async2) {
+                plugin.preprocessors.async2 = utils_2.prefixRules(pluginModule.preprocessors.async2, id);
+            }
         }
         if (pluginModule.decorators) {
-            if (!pluginModule.decorators.oas3 && !pluginModule.decorators.oas2) {
-                throw new Error(`Plugin \`decorators\` must have \`oas3\` or \`oas2\` decorators "${p}.`);
+            if (!pluginModule.decorators.oas3 &&
+                !pluginModule.decorators.oas2 &&
+                !pluginModule.decorators.async2) {
+                throw new Error(`Plugin \`decorators\` must have \`oas3\`, \`oas2\` or \`async2\` decorators "${p}.`);
             }
             plugin.decorators = {};
             if (pluginModule.decorators.oas3) {
@@ -139,6 +149,9 @@ function resolvePlugins(plugins, configPath = '') {
             if (pluginModule.decorators.oas2) {
                 plugin.decorators.oas2 = utils_2.prefixRules(pluginModule.decorators.oas2, id);
             }
+            if (pluginModule.decorators.async2) {
+                plugin.decorators.async2 = utils_2.prefixRules(pluginModule.decorators.async2, id);
+            }
         }
         if (pluginModule.assertions) {
             plugin.assertions = pluginModule.assertions;

package/lib/config/config.d.ts

@@ -1,5 +1,5 @@
 import { NormalizedProblem } from '../walk';
-import { OasVersion, OasMajorVersion, Oas2RuleSet, Oas3RuleSet } from '../oas-types';
+import { SpecVersion, SpecMajorVersion, Oas2RuleSet, Oas3RuleSet, Async2RuleSet } 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";
@@ -15,9 +15,9 @@ export declare class StyleguideConfig {
     plugins: Plugin[];
     ignore: Record<string, Record<string, Set<string>>>;
     doNotResolveExamples: boolean;
-    rules: Record<OasVersion, Record<string, RuleConfig>>;
-    preprocessors: Record<OasVersion, Record<string, PreprocessorConfig>>;
-    decorators: Record<OasVersion, Record<string, DecoratorConfig>>;
+    rules: Record<SpecVersion, Record<string, RuleConfig>>;
+    preprocessors: Record<SpecVersion, Record<string, PreprocessorConfig>>;
+    decorators: Record<SpecVersion, Record<string, DecoratorConfig>>;
     private _usedRules;
     private _usedVersions;
     recommendedFallback: boolean;
@@ -28,16 +28,16 @@ export declare class StyleguideConfig {
     saveIgnore(): void;
     addIgnore(problem: NormalizedProblem): void;
     addProblemToIgnore(problem: NormalizedProblem): NormalizedProblem;
-    extendTypes(types: Record<string, NodeType>, version: OasVersion): Record<string, NodeType>;
-    getRuleSettings(ruleId: string, oasVersion: OasVersion): RuleSettings;
-    getPreprocessorSettings(ruleId: string, oasVersion: OasVersion): RuleSettings;
-    getDecoratorSettings(ruleId: string, oasVersion: OasVersion): RuleSettings;
+    extendTypes(types: Record<string, NodeType>, version: SpecVersion): Record<string, NodeType>;
+    getRuleSettings(ruleId: string, oasVersion: SpecVersion): RuleSettings;
+    getPreprocessorSettings(ruleId: string, oasVersion: SpecVersion): RuleSettings;
+    getDecoratorSettings(ruleId: string, oasVersion: SpecVersion): RuleSettings;
     getUnusedRules(): {
         rules: string[];
         preprocessors: string[];
         decorators: string[];
     };
-    getRulesForOasVersion(version: OasMajorVersion): Oas3RuleSet[] | Oas2RuleSet[];
+    getRulesForOasVersion(version: SpecMajorVersion): Oas3RuleSet[] | Oas2RuleSet[] | Async2RuleSet[];
     skipRules(rules?: string[]): void;
     skipPreprocessors(preprocessors?: string[]): void;
     skipDecorators(decorators?: string[]): void;

package/lib/config/config.js

@@ -51,19 +51,22 @@ class StyleguideConfig {
         this.doNotResolveExamples = !!rawConfig.doNotResolveExamples;
         this.recommendedFallback = rawConfig.recommendedFallback || false;
         this.rules = {
-            [oas_types_1.OasVersion.Version2]: Object.assign(Object.assign({}, rawConfig.rules), rawConfig.oas2Rules),
-            [oas_types_1.OasVersion.Version3_0]: Object.assign(Object.assign({}, rawConfig.rules), rawConfig.oas3_0Rules),
-            [oas_types_1.OasVersion.Version3_1]: Object.assign(Object.assign({}, rawConfig.rules), rawConfig.oas3_1Rules),
+            [oas_types_1.SpecVersion.OAS2]: Object.assign(Object.assign({}, rawConfig.rules), rawConfig.oas2Rules),
+            [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),
         };
         this.preprocessors = {
-            [oas_types_1.OasVersion.Version2]: Object.assign(Object.assign({}, rawConfig.preprocessors), rawConfig.oas2Preprocessors),
-            [oas_types_1.OasVersion.Version3_0]: Object.assign(Object.assign({}, rawConfig.preprocessors), rawConfig.oas3_0Preprocessors),
-            [oas_types_1.OasVersion.Version3_1]: Object.assign(Object.assign({}, rawConfig.preprocessors), rawConfig.oas3_1Preprocessors),
+            [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),
         };
         this.decorators = {
-            [oas_types_1.OasVersion.Version2]: Object.assign(Object.assign({}, rawConfig.decorators), rawConfig.oas2Decorators),
-            [oas_types_1.OasVersion.Version3_0]: Object.assign(Object.assign({}, rawConfig.decorators), rawConfig.oas3_0Decorators),
-            [oas_types_1.OasVersion.Version3_1]: Object.assign(Object.assign({}, rawConfig.decorators), rawConfig.oas3_1Decorators),
+            [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),
         };
         this.extendPaths = rawConfig.extendPaths || [];
         this.pluginPaths = rawConfig.pluginPaths || [];
@@ -124,17 +127,22 @@ class StyleguideConfig {
         for (const plugin of this.plugins) {
             if (plugin.typeExtension !== undefined) {
                 switch (version) {
-                    case oas_types_1.OasVersion.Version3_0:
-                    case oas_types_1.OasVersion.Version3_1:
+                    case oas_types_1.SpecVersion.OAS3_0:
+                    case oas_types_1.SpecVersion.OAS3_1:
                         if (!plugin.typeExtension.oas3)
                             continue;
                         extendedTypes = plugin.typeExtension.oas3(extendedTypes, version);
                         break;
-                    case oas_types_1.OasVersion.Version2:
+                    case oas_types_1.SpecVersion.OAS2:
                         if (!plugin.typeExtension.oas2)
                             continue;
                         extendedTypes = plugin.typeExtension.oas2(extendedTypes, version);
                         break;
+                    case oas_types_1.SpecVersion.Async2:
+                        if (!plugin.typeExtension.async2)
+                            continue;
+                        extendedTypes = plugin.typeExtension.async2(extendedTypes, version);
+                        break;
                     default:
                         throw new Error('Not implemented');
                 }
@@ -198,25 +206,32 @@ class StyleguideConfig {
     }
     getRulesForOasVersion(version) {
         switch (version) {
-            case oas_types_1.OasMajorVersion.Version3:
+            case oas_types_1.SpecMajorVersion.OAS3:
                 // eslint-disable-next-line no-case-declarations
                 const oas3Rules = []; // default ruleset
                 this.plugins.forEach((p) => { var _a; return ((_a = p.preprocessors) === null || _a === void 0 ? void 0 : _a.oas3) && oas3Rules.push(p.preprocessors.oas3); });
                 this.plugins.forEach((p) => { var _a; return ((_a = p.rules) === null || _a === void 0 ? void 0 : _a.oas3) && oas3Rules.push(p.rules.oas3); });
                 this.plugins.forEach((p) => { var _a; return ((_a = p.decorators) === null || _a === void 0 ? void 0 : _a.oas3) && oas3Rules.push(p.decorators.oas3); });
                 return oas3Rules;
-            case oas_types_1.OasMajorVersion.Version2:
+            case oas_types_1.SpecMajorVersion.OAS2:
                 // eslint-disable-next-line no-case-declarations
                 const oas2Rules = []; // default ruleset
                 this.plugins.forEach((p) => { var _a; return ((_a = p.preprocessors) === null || _a === void 0 ? void 0 : _a.oas2) && oas2Rules.push(p.preprocessors.oas2); });
                 this.plugins.forEach((p) => { var _a; return ((_a = p.rules) === null || _a === void 0 ? void 0 : _a.oas2) && oas2Rules.push(p.rules.oas2); });
                 this.plugins.forEach((p) => { var _a; return ((_a = p.decorators) === null || _a === void 0 ? void 0 : _a.oas2) && oas2Rules.push(p.decorators.oas2); });
                 return oas2Rules;
+            case oas_types_1.SpecMajorVersion.Async2:
+                // eslint-disable-next-line no-case-declarations
+                const asyncApiRules = []; // default ruleset
+                this.plugins.forEach((p) => { var _a; return ((_a = p.preprocessors) === null || _a === void 0 ? void 0 : _a.async2) && asyncApiRules.push(p.preprocessors.async2); });
+                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;
         }
     }
     skipRules(rules) {
         for (const ruleId of rules || []) {
-            for (const version of Object.values(oas_types_1.OasVersion)) {
+            for (const version of Object.values(oas_types_1.SpecVersion)) {
                 if (this.rules[version][ruleId]) {
                     this.rules[version][ruleId] = 'off';
                 }
@@ -225,7 +240,7 @@ class StyleguideConfig {
     }
     skipPreprocessors(preprocessors) {
         for (const preprocessorId of preprocessors || []) {
-            for (const version of Object.values(oas_types_1.OasVersion)) {
+            for (const version of Object.values(oas_types_1.SpecVersion)) {
                 if (this.preprocessors[version][preprocessorId]) {
                     this.preprocessors[version][preprocessorId] = 'off';
                 }
@@ -234,7 +249,7 @@ class StyleguideConfig {
     }
     skipDecorators(decorators) {
         for (const decoratorId of decorators || []) {
-            for (const version of Object.values(oas_types_1.OasVersion)) {
+            for (const version of Object.values(oas_types_1.SpecVersion)) {
                 if (this.decorators[version][decoratorId]) {
                     this.decorators[version][decoratorId] = 'off';
                 }

package/lib/config/rules.d.ts

@@ -1,4 +1,4 @@
-import { RuleSet, OasVersion } from '../oas-types';
+import { RuleSet, SpecVersion } from '../oas-types';
 import { StyleguideConfig } from './config';
 import type { ProblemSeverity } from '../walk';
 declare type InitializedRule = {
@@ -6,5 +6,5 @@ declare type InitializedRule = {
     ruleId: string;
     visitor: any;
 };
-export declare function initRules<T extends Function, P extends RuleSet<T>>(rules: P[], config: StyleguideConfig, type: 'rules' | 'preprocessors' | 'decorators', oasVersion: OasVersion): InitializedRule[];
+export declare function initRules<T extends Function, P extends RuleSet<T>>(rules: P[], config: StyleguideConfig, type: 'rules' | 'preprocessors' | 'decorators', oasVersion: SpecVersion): InitializedRule[];
 export {};

package/lib/config/types.d.ts

@@ -1,5 +1,5 @@
 import type { ProblemSeverity, UserContext } from '../walk';
-import type { Oas3PreprocessorsSet, OasMajorVersion, Oas3DecoratorsSet, Oas2RuleSet, Oas2PreprocessorsSet, Oas2DecoratorsSet, Oas3RuleSet, OasVersion } from '../oas-types';
+import type { Oas3PreprocessorsSet, SpecMajorVersion, Oas3DecoratorsSet, Oas2RuleSet, Oas2PreprocessorsSet, Oas2DecoratorsSet, Oas3RuleSet, SpecVersion, Async2PreprocessorsSet, Async2DecoratorsSet, Async2RuleSet } from '../oas-types';
 import type { NodeType } from '../types';
 import { Location } from '../ref-utils';
 import type { SkipFunctionContext } from '../visitors';
@@ -24,14 +24,17 @@ export declare type StyleguideRawConfig = {
     oas2Rules?: Record<string, RuleConfig>;
     oas3_0Rules?: Record<string, RuleConfig>;
     oas3_1Rules?: Record<string, RuleConfig>;
+    async2Rules?: Record<string, RuleConfig>;
     preprocessors?: Record<string, PreprocessorConfig>;
     oas2Preprocessors?: Record<string, PreprocessorConfig>;
     oas3_0Preprocessors?: Record<string, PreprocessorConfig>;
     oas3_1Preprocessors?: Record<string, PreprocessorConfig>;
+    async2Preprocessors?: 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>;
 };
 export declare type ApiStyleguideRawConfig = Omit<StyleguideRawConfig, 'plugins'>;
 export declare type ResolvedStyleguideConfig = PluginStyleguideConfig & {
@@ -44,16 +47,19 @@ export declare type ResolvedStyleguideConfig = PluginStyleguideConfig & {
 export declare type PreprocessorsConfig = {
     oas3?: Oas3PreprocessorsSet;
     oas2?: Oas2PreprocessorsSet;
+    async2?: Async2PreprocessorsSet;
 };
 export declare type DecoratorsConfig = {
     oas3?: Oas3DecoratorsSet;
     oas2?: Oas2DecoratorsSet;
+    async2?: Async2DecoratorsSet;
 };
-export declare type TypesExtensionFn = (types: Record<string, NodeType>, oasVersion: OasVersion) => Record<string, NodeType>;
-export declare type TypeExtensionsConfig = Partial<Record<OasMajorVersion, TypesExtensionFn>>;
+export declare type TypesExtensionFn = (types: Record<string, NodeType>, oasVersion: SpecVersion) => Record<string, NodeType>;
+export declare type TypeExtensionsConfig = Partial<Record<SpecMajorVersion, TypesExtensionFn>>;
 export declare type CustomRulesConfig = {
     oas3?: Oas3RuleSet;
     oas2?: Oas2RuleSet;
+    async2?: Async2RuleSet;
 };
 export declare type AssertionContext = Partial<UserContext> & SkipFunctionContext & {
     node: any;

package/lib/index.d.ts

@@ -13,7 +13,7 @@ export { RedoclyClient, isRedoclyRegistryURL } from './redocly';
 export { Source, BaseResolver, Document, resolveDocument, ResolveError, YamlParseError, makeDocumentFromString, } from './resolve';
 export { parseYaml, stringifyYaml } from './js-yaml';
 export { unescapePointer, isRef, isAbsoluteUrl } from './ref-utils';
-export { detectOpenAPI, OasMajorVersion, openAPIMajor, OasVersion } from './oas-types';
+export { SpecMajorVersion, getMajorSpecVersion, SpecVersion, detectSpec, getTypes, } from './oas-types';
 export { normalizeVisitors } from './visitors';
 export { WalkContext, walkDocument, NormalizedProblem, ProblemSeverity, LineColLocationObject, LocationObject, Loc, } from './walk';
 export { getAstNodeByPointer, getLineColLocation } from './format/codeframes';

package/lib/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.bundleDocument = exports.bundle = exports.lintConfig = exports.lintFromString = exports.lintDocument = exports.validate = exports.lint = exports.getTotals = exports.formatProblems = exports.getLineColLocation = exports.getAstNodeByPointer = exports.walkDocument = exports.normalizeVisitors = exports.OasVersion = exports.openAPIMajor = exports.OasMajorVersion = exports.detectOpenAPI = exports.isAbsoluteUrl = exports.isRef = exports.unescapePointer = exports.stringifyYaml = exports.parseYaml = exports.makeDocumentFromString = exports.YamlParseError = exports.ResolveError = exports.resolveDocument = exports.BaseResolver = exports.Source = exports.isRedoclyRegistryURL = 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.Oas2Types = exports.Oas3Types = exports.Oas3_1Types = exports.isTruthy = exports.doesYamlFileExist = exports.slash = exports.readFileFromUrl = void 0;
-exports.mapTypeToComponent = void 0;
+exports.bundle = exports.lintConfig = 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.isRedoclyRegistryURL = 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.Oas2Types = exports.Oas3Types = exports.Oas3_1Types = exports.isTruthy = exports.doesYamlFileExist = exports.slash = exports.readFileFromUrl = void 0;
+exports.mapTypeToComponent = exports.bundleDocument = 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; } });
@@ -48,10 +48,11 @@ Object.defineProperty(exports, "unescapePointer", { enumerable: true, get: funct
 Object.defineProperty(exports, "isRef", { enumerable: true, get: function () { return ref_utils_1.isRef; } });
 Object.defineProperty(exports, "isAbsoluteUrl", { enumerable: true, get: function () { return ref_utils_1.isAbsoluteUrl; } });
 var oas_types_1 = require("./oas-types");
-Object.defineProperty(exports, "detectOpenAPI", { enumerable: true, get: function () { return oas_types_1.detectOpenAPI; } });
-Object.defineProperty(exports, "OasMajorVersion", { enumerable: true, get: function () { return oas_types_1.OasMajorVersion; } });
-Object.defineProperty(exports, "openAPIMajor", { enumerable: true, get: function () { return oas_types_1.openAPIMajor; } });
-Object.defineProperty(exports, "OasVersion", { enumerable: true, get: function () { return oas_types_1.OasVersion; } });
+Object.defineProperty(exports, "SpecMajorVersion", { enumerable: true, get: function () { return oas_types_1.SpecMajorVersion; } });
+Object.defineProperty(exports, "getMajorSpecVersion", { enumerable: true, get: function () { return oas_types_1.getMajorSpecVersion; } });
+Object.defineProperty(exports, "SpecVersion", { enumerable: true, get: function () { return oas_types_1.SpecVersion; } });
+Object.defineProperty(exports, "detectSpec", { enumerable: true, get: function () { return oas_types_1.detectSpec; } });
+Object.defineProperty(exports, "getTypes", { enumerable: true, get: function () { return oas_types_1.getTypes; } });
 var visitors_1 = require("./visitors");
 Object.defineProperty(exports, "normalizeVisitors", { enumerable: true, get: function () { return visitors_1.normalizeVisitors; } });
 var walk_1 = require("./walk");

package/lib/lint.js

@@ -12,9 +12,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.lintConfig = exports.lintDocument = exports.lintFromString = exports.lint = void 0;
 const resolve_1 = require("./resolve");
 const visitors_1 = require("./visitors");
-const oas3_1_1 = require("./types/oas3_1");
-const oas3_1 = require("./types/oas3");
-const oas2_1 = require("./types/oas2");
 const walk_1 = require("./walk");
 const config_1 = require("./config");
 const types_1 = require("./types");
@@ -42,21 +39,17 @@ function lintDocument(opts) {
     return __awaiter(this, void 0, void 0, function* () {
         ajv_1.releaseAjvInstance(); // FIXME: preprocessors can modify nodes which are then cached to ajv-instance by absolute path
         const { document, customTypes, externalRefResolver, config } = opts;
-        const oasVersion = oas_types_1.detectOpenAPI(document.parsed);
-        const oasMajorVersion = oas_types_1.openAPIMajor(oasVersion);
-        const rules = config.getRulesForOasVersion(oasMajorVersion);
-        const types = types_1.normalizeTypes(config.extendTypes((customTypes !== null && customTypes !== void 0 ? customTypes : oasMajorVersion === oas_types_1.OasMajorVersion.Version3)
-            ? oasVersion === oas_types_1.OasVersion.Version3_1
-                ? oas3_1_1.Oas3_1Types
-                : oas3_1.Oas3Types
-            : oas2_1.Oas2Types, oasVersion), config);
+        const specVersion = oas_types_1.detectSpec(document.parsed);
+        const specMajorVersion = oas_types_1.getMajorSpecVersion(specVersion);
+        const rules = config.getRulesForOasVersion(specMajorVersion);
+        const types = types_1.normalizeTypes(config.extendTypes(customTypes !== null && customTypes !== void 0 ? customTypes : oas_types_1.getTypes(specVersion), specVersion), config);
         const ctx = {
             problems: [],
-            oasVersion: oasVersion,
+            oasVersion: specVersion,
             visitorsData: {},
         };
-        const preprocessors = config_1.initRules(rules, config, 'preprocessors', oasVersion);
-        const regularRules = config_1.initRules(rules, config, 'rules', oasVersion);
+        const preprocessors = config_1.initRules(rules, config, 'preprocessors', specVersion);
+        const regularRules = config_1.initRules(rules, config, 'rules', specVersion);
         let resolvedRefMap = yield resolve_1.resolveDocument({
             rootDocument: document,
             rootType: types.Root,
@@ -94,7 +87,7 @@ function lintConfig(opts) {
         const { document, severity } = opts;
         const ctx = {
             problems: [],
-            oasVersion: oas_types_1.OasVersion.Version3_0,
+            oasVersion: oas_types_1.SpecVersion.OAS3_0,
             visitorsData: {},
         };
         const plugins = config_1.resolvePlugins([config_1.defaultPlugin]);
@@ -107,9 +100,10 @@ function lintConfig(opts) {
             {
                 severity: severity || 'error',
                 ruleId: 'configuration spec',
-                visitor: spec_1.OasSpec({ severity: 'error' }),
+                visitor: spec_1.Spec({ severity: 'error' }),
             },
         ];
+        // TODO: check why any is needed
         const normalizedVisitors = visitors_1.normalizeVisitors(rules, types);
         walk_1.walkDocument({
             document,

package/lib/oas-types.d.ts

@@ -1,19 +1,25 @@
-import { Oas3Rule, Oas3Preprocessor, Oas2Rule, Oas2Preprocessor } from './visitors';
+import { Oas3Rule, Oas3Preprocessor, Oas2Rule, Oas2Preprocessor, Async2Preprocessor, Async2Rule } from './visitors';
 export declare type RuleSet<T> = Record<string, T>;
-export declare enum OasVersion {
-    Version2 = "oas2",
-    Version3_0 = "oas3_0",
-    Version3_1 = "oas3_1"
+export declare enum SpecVersion {
+    OAS2 = "oas2",
+    OAS3_0 = "oas3_0",
+    OAS3_1 = "oas3_1",
+    Async2 = "async2"
 }
-export declare enum OasMajorVersion {
-    Version2 = "oas2",
-    Version3 = "oas3"
+export declare enum SpecMajorVersion {
+    OAS2 = "oas2",
+    OAS3 = "oas3",
+    Async2 = "async2"
 }
 export declare type Oas3RuleSet = Record<string, Oas3Rule>;
 export declare type Oas2RuleSet = Record<string, Oas2Rule>;
+export declare type Async2RuleSet = Record<string, Async2Rule>;
 export declare type Oas3PreprocessorsSet = Record<string, Oas3Preprocessor>;
 export declare type Oas2PreprocessorsSet = Record<string, Oas2Preprocessor>;
+export declare type Async2PreprocessorsSet = Record<string, Async2Preprocessor>;
 export declare type Oas3DecoratorsSet = Record<string, Oas3Preprocessor>;
 export declare type Oas2DecoratorsSet = Record<string, Oas2Preprocessor>;
-export declare function detectOpenAPI(root: any): OasVersion;
-export declare function openAPIMajor(version: OasVersion): OasMajorVersion;
+export declare type Async2DecoratorsSet = Record<string, Async2Preprocessor>;
+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>;