@redocly/openapi-core 1.1.0 → 1.2.1

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/load.d.ts

@@ -1,5 +1,5 @@
 import { Config } from './config';
-import type { RawConfig, Region } from './types';
+import type { RawConfig, RawUniversalConfig, Region } from './types';
 import { RegionalTokenWithValidity } from '../redocly/redocly-client-types';
 export declare function loadConfig(options?: {
     configPath?: string;
@@ -14,6 +14,7 @@ export declare function getConfig(configPath?: string | undefined, processRawCon
 declare type CreateConfigOptions = {
     extends?: string[];
     tokens?: RegionalTokenWithValidity[];
+    configPath?: string;
 };
-export declare function createConfig(config: string | RawConfig, options?: CreateConfigOptions): Promise<Config>;
+export declare function createConfig(config: string | RawUniversalConfig, options?: CreateConfigOptions): Promise<Config>;
 export {};

package/lib/config/load.js

@@ -82,8 +82,8 @@ function findConfig(dir) {
     const existingConfigFiles = exports.CONFIG_FILE_NAMES.map((name) => dir ? path.resolve(dir, name) : name).filter(fs.existsSync);
     if (existingConfigFiles.length > 1) {
         throw new Error(`
-      Multiple configuration files are not allowed. 
-      Found the following files: ${existingConfigFiles.join(', ')}. 
+      Multiple configuration files are not allowed.
+      Found the following files: ${existingConfigFiles.join(', ')}.
       Please use 'redocly.yaml' instead.
     `);
     }

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;
@@ -128,6 +134,7 @@ export declare type RawConfig = {
     files?: string[];
     telemetry?: Telemetry;
 } & ThemeConfig;
+export declare type RawUniversalConfig = Omit<RawConfig, 'styleguide'> & StyleguideRawConfig;
 export declare type FlatApi = Omit<Api, 'styleguide'> & Omit<ApiStyleguideRawConfig, 'doNotResolveExamples'>;
 export declare type FlatRawConfig = Omit<RawConfig, 'styleguide' | 'resolve' | 'apis'> & Omit<StyleguideRawConfig, 'doNotResolveExamples'> & {
     resolve?: RawResolveConfig;

package/lib/index.d.ts

@@ -2,21 +2,22 @@ export { BundleOutputFormat, readFileFromUrl, slash, doesYamlFileExist, isTruthy
 export { Oas3_1Types } from './types/oas3_1';
 export { Oas3Types } from './types/oas3';
 export { Oas2Types } from './types/oas2';
+export { AsyncApi2Types } from './types/asyncapi';
 export { ConfigTypes } from './types/redocly-yaml';
 export type { Oas3Definition, Oas3_1Definition, Oas3Components, Oas3PathItem, Oas3Paths, Oas3ComponentName, Oas3Schema, Oas3_1Schema, Oas3Tag, Oas3_1Webhooks, Referenced, OasRef, } from './typings/openapi';
 export type { Oas2Definition } from './typings/swagger';
 export type { StatsAccumulator, StatsName } from './typings/common';
 export { normalizeTypes } from './types';
 export { Stats } from './rules/other/stats';
-export { Config, StyleguideConfig, RawConfig, IGNORE_FILE, Region, getMergedConfig, transformConfig, loadConfig, getConfig, findConfig, CONFIG_FILE_NAMES, RuleSeverity, createConfig, ResolvedApi, } from './config';
+export { Config, StyleguideConfig, RawConfig, RawUniversalConfig, IGNORE_FILE, Region, getMergedConfig, transformConfig, loadConfig, getConfig, findConfig, CONFIG_FILE_NAMES, RuleSeverity, createConfig, ResolvedApi, } from './config';
 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';
 export { formatProblems, OutputFormat, getTotals, Totals } from './format/format';
 export { lint, lint as validate, lintDocument, lintFromString, lintConfig } from './lint';
-export { bundle, bundleDocument, mapTypeToComponent } from './bundle';
+export { bundle, bundleDocument, mapTypeToComponent, bundleFromString } from './bundle';

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.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.AsyncApi2Types = exports.Oas2Types = exports.Oas3Types = exports.Oas3_1Types = exports.isTruthy = exports.doesYamlFileExist = exports.slash = exports.readFileFromUrl = void 0;
+exports.bundleFromString = exports.mapTypeToComponent = exports.bundleDocument = exports.bundle = 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; } });
@@ -13,6 +13,8 @@ var oas3_1 = require("./types/oas3");
 Object.defineProperty(exports, "Oas3Types", { enumerable: true, get: function () { return oas3_1.Oas3Types; } });
 var oas2_1 = require("./types/oas2");
 Object.defineProperty(exports, "Oas2Types", { enumerable: true, get: function () { return oas2_1.Oas2Types; } });
+var asyncapi_1 = require("./types/asyncapi");
+Object.defineProperty(exports, "AsyncApi2Types", { enumerable: true, get: function () { return asyncapi_1.AsyncApi2Types; } });
 var redocly_yaml_1 = require("./types/redocly-yaml");
 Object.defineProperty(exports, "ConfigTypes", { enumerable: true, get: function () { return redocly_yaml_1.ConfigTypes; } });
 var types_1 = require("./types");
@@ -48,10 +50,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");
@@ -72,3 +75,4 @@ var bundle_1 = require("./bundle");
 Object.defineProperty(exports, "bundle", { enumerable: true, get: function () { return bundle_1.bundle; } });
 Object.defineProperty(exports, "bundleDocument", { enumerable: true, get: function () { return bundle_1.bundleDocument; } });
 Object.defineProperty(exports, "mapTypeToComponent", { enumerable: true, get: function () { return bundle_1.mapTypeToComponent; } });
+Object.defineProperty(exports, "bundleFromString", { enumerable: true, get: function () { return bundle_1.bundleFromString; } });

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>;

package/lib/oas-types.js

@@ -1,45 +1,71 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.openAPIMajor = exports.detectOpenAPI = exports.OasMajorVersion = exports.OasVersion = void 0;
-var OasVersion;
-(function (OasVersion) {
-    OasVersion["Version2"] = "oas2";
-    OasVersion["Version3_0"] = "oas3_0";
-    OasVersion["Version3_1"] = "oas3_1";
-})(OasVersion = exports.OasVersion || (exports.OasVersion = {}));
-var OasMajorVersion;
-(function (OasMajorVersion) {
-    OasMajorVersion["Version2"] = "oas2";
-    OasMajorVersion["Version3"] = "oas3";
-})(OasMajorVersion = exports.OasMajorVersion || (exports.OasMajorVersion = {}));
-function detectOpenAPI(root) {
+exports.getTypes = exports.getMajorSpecVersion = exports.detectSpec = exports.SpecMajorVersion = exports.SpecVersion = void 0;
+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");
+var SpecVersion;
+(function (SpecVersion) {
+    SpecVersion["OAS2"] = "oas2";
+    SpecVersion["OAS3_0"] = "oas3_0";
+    SpecVersion["OAS3_1"] = "oas3_1";
+    SpecVersion["Async2"] = "async2";
+})(SpecVersion = exports.SpecVersion || (exports.SpecVersion = {}));
+var SpecMajorVersion;
+(function (SpecMajorVersion) {
+    SpecMajorVersion["OAS2"] = "oas2";
+    SpecMajorVersion["OAS3"] = "oas3";
+    SpecMajorVersion["Async2"] = "async2";
+})(SpecMajorVersion = exports.SpecMajorVersion || (exports.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,
+};
+function detectSpec(root) {
     if (typeof root !== 'object') {
         throw new Error(`Document must be JSON object, got ${typeof root}`);
     }
-    if (!(root.openapi || root.swagger)) {
-        throw new Error('This doesn’t look like an OpenAPI document.\n');
-    }
     if (root.openapi && typeof root.openapi !== 'string') {
         throw new Error(`Invalid OpenAPI version: should be a string but got "${typeof root.openapi}"`);
     }
     if (root.openapi && root.openapi.startsWith('3.0')) {
-        return OasVersion.Version3_0;
+        return SpecVersion.OAS3_0;
     }
     if (root.openapi && root.openapi.startsWith('3.1')) {
-        return OasVersion.Version3_1;
+        return SpecVersion.OAS3_1;
     }
     if (root.swagger && root.swagger === '2.0') {
-        return OasVersion.Version2;
+        return SpecVersion.OAS2;
+    }
+    // if not detected yet
+    if (root.openapi || root.swagger) {
+        throw new Error(`Unsupported OpenAPI version: ${root.openapi || root.swagger}`);
+    }
+    if (root.asyncapi && root.asyncapi.startsWith('2.')) {
+        return SpecVersion.Async2;
     }
-    throw new Error(`Unsupported OpenAPI Version: ${root.openapi || root.swagger}`);
+    if (root.asyncapi) {
+        throw new Error(`Unsupported AsyncAPI version: ${root.asyncapi}`);
+    }
+    throw new Error(`Unsupported specification`);
 }
-exports.detectOpenAPI = detectOpenAPI;
-function openAPIMajor(version) {
-    if (version === OasVersion.Version2) {
-        return OasMajorVersion.Version2;
+exports.detectSpec = detectSpec;
+function getMajorSpecVersion(version) {
+    if (version === SpecVersion.OAS2) {
+        return SpecMajorVersion.OAS2;
+    }
+    else if (version === SpecVersion.Async2) {
+        return SpecMajorVersion.Async2;
     }
     else {
-        return OasMajorVersion.Version3;
+        return SpecMajorVersion.OAS3;
     }
 }
-exports.openAPIMajor = openAPIMajor;
+exports.getMajorSpecVersion = getMajorSpecVersion;
+function getTypes(spec) {
+    return typesMap[spec];
+}
+exports.getTypes = getTypes;

package/lib/rules/async2/channels-kebab-case.d.ts

@@ -0,0 +1,2 @@
+import { Async2Rule } from '../../visitors';
+export declare const ChannelsKebabCase: Async2Rule;

package/lib/rules/async2/channels-kebab-case.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChannelsKebabCase = void 0;
+const ChannelsKebabCase = () => {
+    return {
+        Channel(_channel, { report, key }) {
+            const segments = key
+                .split(/[/.:]/) // split on / or : as likely channel namespacers
+                .filter((s) => s !== ''); // filter out empty segments
+            if (!segments.every((segment) => /^{.+}$/.test(segment) || /^[a-z0-9-.]+$/.test(segment))) {
+                report({
+                    message: `\`${key}\` does not use kebab-case.`,
+                    location: { reportOnKey: true },
+                });
+            }
+        },
+    };
+};
+exports.ChannelsKebabCase = ChannelsKebabCase;

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

@@ -0,0 +1,12 @@
+import { Async2Rule } from '../../visitors';
+export declare const rules: {
+    spec: Async2Rule;
+    assertions: (opts: Record<string, import("../common/assertions").Assertion>) => (import("../../visitors").Oas3Visitor | import("../../visitors").Oas2Visitor)[];
+    'info-contact': import("../../visitors").Oas3Rule | import("../../visitors").Oas2Rule;
+    'operation-operationId': import("../../visitors").Oas3Rule | import("../../visitors").Oas2Rule;
+    'channels-kebab-case': Async2Rule;
+    'no-channel-trailing-slash': Async2Rule;
+    'tag-description': import("../../visitors").Oas3Rule | import("../../visitors").Oas2Rule;
+    'tags-alphabetical': import("../../visitors").Oas3Rule | import("../../visitors").Oas2Rule;
+};
+export declare const preprocessors: {};

package/lib/rules/async2/index.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.preprocessors = exports.rules = void 0;
+const assertions_1 = require("../common/assertions");
+const spec_1 = require("../common/spec");
+const info_contact_1 = require("../common/info-contact");
+const operation_operationId_1 = require("../common/operation-operationId");
+const tag_description_1 = require("../common/tag-description");
+const tags_alphabetical_1 = require("../common/tags-alphabetical");
+const channels_kebab_case_1 = require("./channels-kebab-case");
+const no_channel_trailing_slash_1 = require("./no-channel-trailing-slash");
+exports.rules = {
+    spec: spec_1.Spec,
+    assertions: assertions_1.Assertions,
+    'info-contact': info_contact_1.InfoContact,
+    'operation-operationId': operation_operationId_1.OperationOperationId,
+    'channels-kebab-case': channels_kebab_case_1.ChannelsKebabCase,
+    'no-channel-trailing-slash': no_channel_trailing_slash_1.NoChannelTrailingSlash,
+    'tag-description': tag_description_1.TagDescription,
+    'tags-alphabetical': tags_alphabetical_1.TagsAlphabetical,
+};
+exports.preprocessors = {};

package/lib/rules/async2/no-channel-trailing-slash.d.ts

@@ -0,0 +1,2 @@
+import { Async2Rule } from '../../visitors';
+export declare const NoChannelTrailingSlash: Async2Rule;

package/lib/rules/async2/no-channel-trailing-slash.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NoChannelTrailingSlash = void 0;
+const NoChannelTrailingSlash = () => {
+    return {
+        Channel(_channel, { report, key, location }) {
+            if (key.endsWith('/') && key !== '/') {
+                report({
+                    message: `\`${key}\` should not have a trailing slash.`,
+                    location: location.key(),
+                });
+            }
+        },
+    };
+};
+exports.NoChannelTrailingSlash = NoChannelTrailingSlash;

package/lib/rules/common/assertions/asserts.js

@@ -35,7 +35,7 @@ exports.runOnValuesSet = new Set([
     'const',
 ]);
 exports.asserts = {
-    pattern: (value, condition, { baseLocation }) => {
+    pattern: (value, condition, { baseLocation, rawValue }) => {
         if (typeof value === 'undefined' || utils_1.isPlainObject(value))
             return []; // property doesn't exist or is an object, no need to lint it with this assert
         const values = Array.isArray(value) ? value : [value];
@@ -43,11 +43,15 @@ exports.asserts = {
         return values
             .map((_val) => !(regex === null || regex === void 0 ? void 0 : regex.test(_val)) && {
             message: `"${_val}" should match a regex ${condition}`,
-            location: utils_1.isString(value) ? baseLocation : baseLocation.key(),
+            location: utils_1.isString(value)
+                ? baseLocation
+                : utils_1.isPlainObject(rawValue)
+                    ? baseLocation.child(_val).key()
+                    : baseLocation.key(),
         })
             .filter(utils_1.isTruthy);
     },
-    notPattern: (value, condition, { baseLocation }) => {
+    notPattern: (value, condition, { baseLocation, rawValue }) => {
         if (typeof value === 'undefined' || utils_1.isPlainObject(value))
             return []; // property doesn't exist or is an object, no need to lint it with this assert
         const values = Array.isArray(value) ? value : [value];
@@ -55,7 +59,11 @@ exports.asserts = {
         return values
             .map((_val) => (regex === null || regex === void 0 ? void 0 : regex.test(_val)) && {
             message: `"${_val}" should not match a regex ${condition}`,
-            location: utils_1.isString(value) ? baseLocation : baseLocation.key(),
+            location: utils_1.isString(value)
+                ? baseLocation
+                : utils_1.isPlainObject(rawValue)
+                    ? baseLocation.child(_val).key()
+                    : baseLocation.key(),
         })
             .filter(utils_1.isTruthy);
     },

package/lib/rules/common/scalar-property-missing-example.js

@@ -14,7 +14,7 @@ const ScalarPropertyMissingExample = () => {
                 if (propSchema.example === undefined &&
                     propSchema.examples === undefined) {
                     report({
-                        message: `Scalar property should have "example"${oasVersion === oas_types_1.OasVersion.Version3_1 ? ' or "examples"' : ''} defined.`,
+                        message: `Scalar property should have "example"${oasVersion === oas_types_1.SpecVersion.OAS3_1 ? ' or "examples"' : ''} defined.`,
                         location: location.child(propName).key(),
                     });
                 }

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

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