@redocly/openapi-core 1.18.1 → 1.19.0

package/lib/config/load.js

@@ -1,15 +1,10 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createConfig = exports.getConfig = exports.findConfig = exports.CONFIG_FILE_NAMES = exports.loadConfig = void 0;
+exports.CONFIG_FILE_NAMES = void 0;
+exports.loadConfig = loadConfig;
+exports.findConfig = findConfig;
+exports.getConfig = getConfig;
+exports.createConfig = createConfig;
 const fs = require("fs");
 const path = require("path");
 const redocly_1 = require("../redocly");
@@ -21,92 +16,89 @@ const bundle_1 = require("../bundle");
 const resolve_1 = require("../resolve");
 const env_1 = require("../env");
 const domains_1 = require("../redocly/domains");
-function addConfigMetadata({ rawConfig, customExtends, configPath, tokens, files, region, externalRefResolver, }) {
-    var _a;
-    return __awaiter(this, void 0, void 0, function* () {
-        if (customExtends !== undefined) {
-            rawConfig.styleguide = rawConfig.styleguide || {};
-            rawConfig.styleguide.extends = customExtends;
-        }
-        else if ((0, utils_1.isEmptyObject)(rawConfig)) {
-            rawConfig.styleguide = { extends: ['recommended'], recommendedFallback: true };
-        }
-        if (tokens === null || tokens === void 0 ? void 0 : tokens.length) {
-            if (!rawConfig.resolve)
-                rawConfig.resolve = {};
-            if (!rawConfig.resolve.http)
-                rawConfig.resolve.http = {};
-            rawConfig.resolve.http.headers = [...((_a = rawConfig.resolve.http.headers) !== null && _a !== void 0 ? _a : [])];
-            for (const item of tokens) {
-                const domain = domains_1.DOMAINS[item.region];
-                rawConfig.resolve.http.headers.push({
-                    matches: `https://api.${domain}/registry/**`,
-                    name: 'Authorization',
-                    envVariable: undefined,
-                    value: item.token,
-                }, 
-                //support redocly.com domain for future compatibility
-                ...(item.region === 'us'
-                    ? [
-                        {
-                            matches: `https://api.redoc.ly/registry/**`,
-                            name: 'Authorization',
-                            envVariable: undefined,
-                            value: item.token,
-                        },
-                    ]
-                    : []));
-            }
+async function addConfigMetadata({ rawConfig, customExtends, configPath, tokens, files, region, externalRefResolver, }) {
+    if (customExtends !== undefined) {
+        rawConfig.styleguide = rawConfig.styleguide || {};
+        rawConfig.styleguide.extends = customExtends;
+    }
+    else if ((0, utils_1.isEmptyObject)(rawConfig)) {
+        rawConfig.styleguide = { extends: ['recommended'], recommendedFallback: true };
+    }
+    if (tokens?.length) {
+        if (!rawConfig.resolve)
+            rawConfig.resolve = {};
+        if (!rawConfig.resolve.http)
+            rawConfig.resolve.http = {};
+        rawConfig.resolve.http.headers = [...(rawConfig.resolve.http.headers ?? [])];
+        for (const item of tokens) {
+            const domain = domains_1.DOMAINS[item.region];
+            rawConfig.resolve.http.headers.push({
+                matches: `https://api.${domain}/registry/**`,
+                name: 'Authorization',
+                envVariable: undefined,
+                value: item.token,
+            }, 
+            //support redocly.com domain for future compatibility
+            ...(item.region === 'us'
+                ? [
+                    {
+                        matches: `https://api.redoc.ly/registry/**`,
+                        name: 'Authorization',
+                        envVariable: undefined,
+                        value: item.token,
+                    },
+                ]
+                : []));
         }
-        return (0, config_resolvers_1.resolveConfig)({
-            rawConfig: Object.assign(Object.assign({}, rawConfig), { files: files !== null && files !== void 0 ? files : rawConfig.files, region: region !== null && region !== void 0 ? region : rawConfig.region }),
-            configPath,
-            externalRefResolver,
-        });
+    }
+    return (0, config_resolvers_1.resolveConfig)({
+        rawConfig: {
+            ...rawConfig,
+            files: files ?? rawConfig.files,
+            region: region ?? rawConfig.region,
+        },
+        configPath,
+        externalRefResolver,
     });
 }
-function loadConfig(options = {}) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const { configPath = findConfig(), customExtends, processRawConfig, files, region, externalRefResolver, } = options;
-        const { rawConfig, document, parsed, resolvedRefMap } = yield getConfig({
-            configPath,
-            externalRefResolver,
-        });
-        const redoclyClient = env_1.isBrowser ? undefined : new redocly_1.RedoclyClient();
-        const tokens = redoclyClient && redoclyClient.hasTokens() ? redoclyClient.getAllTokens() : [];
-        const config = yield addConfigMetadata({
-            rawConfig,
-            customExtends,
-            configPath,
-            tokens,
-            files,
-            region,
-            externalRefResolver,
-        });
-        if (document && parsed && resolvedRefMap && typeof processRawConfig === 'function') {
-            try {
-                yield processRawConfig({
-                    document,
-                    resolvedRefMap,
-                    config,
-                    parsed,
-                });
-            }
-            catch (e) {
-                if (e instanceof utils_2.ConfigValidationError) {
-                    throw e;
-                }
-                throw new Error(`Error parsing config file at '${configPath}': ${e.message}`);
+async function loadConfig(options = {}) {
+    const { configPath = findConfig(), customExtends, processRawConfig, files, region, externalRefResolver, } = options;
+    const { rawConfig, document, parsed, resolvedRefMap } = await getConfig({
+        configPath,
+        externalRefResolver,
+    });
+    const redoclyClient = env_1.isBrowser ? undefined : new redocly_1.RedoclyClient();
+    const tokens = redoclyClient && redoclyClient.hasTokens() ? redoclyClient.getAllTokens() : [];
+    const config = await addConfigMetadata({
+        rawConfig,
+        customExtends,
+        configPath,
+        tokens,
+        files,
+        region,
+        externalRefResolver,
+    });
+    if (document && parsed && resolvedRefMap && typeof processRawConfig === 'function') {
+        try {
+            await processRawConfig({
+                document,
+                resolvedRefMap,
+                config,
+                parsed,
+            });
+        }
+        catch (e) {
+            if (e instanceof utils_2.ConfigValidationError) {
+                throw e;
             }
+            throw new Error(`Error parsing config file at '${configPath}': ${e.message}`);
         }
-        return config;
-    });
+    }
+    return config;
 }
-exports.loadConfig = loadConfig;
 exports.CONFIG_FILE_NAMES = ['redocly.yaml', 'redocly.yml', '.redocly.yaml', '.redocly.yml'];
 function findConfig(dir) {
-    var _a;
-    if (!((_a = fs === null || fs === void 0 ? void 0 : fs.hasOwnProperty) === null || _a === void 0 ? void 0 : _a.call(fs, 'existsSync')))
+    if (!fs?.hasOwnProperty?.('existsSync'))
         return;
     const existingConfigFiles = exports.CONFIG_FILE_NAMES.map((name) => dir ? path.resolve(dir, name) : name).filter(fs.existsSync);
     if (existingConfigFiles.length > 1) {
@@ -118,35 +110,31 @@ function findConfig(dir) {
     }
     return existingConfigFiles[0];
 }
-exports.findConfig = findConfig;
-function getConfig(options = {}) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const { configPath = findConfig(), externalRefResolver = new resolve_1.BaseResolver() } = options;
-        if (!configPath)
-            return { rawConfig: {} };
-        try {
-            const { document, resolvedRefMap } = yield (0, config_resolvers_1.resolveConfigFileAndRefs)({
-                configPath,
-                externalRefResolver,
-            });
-            const bundledRefMap = (0, utils_2.deepCloneMapWithJSON)(resolvedRefMap);
-            const parsed = yield (0, bundle_1.bundleConfig)(JSON.parse(JSON.stringify(document)), bundledRefMap);
-            return {
-                rawConfig: (0, utils_2.transformConfig)(parsed),
-                document,
-                parsed,
-                resolvedRefMap,
-            };
-        }
-        catch (e) {
-            throw new Error(`Error parsing config file at '${configPath}': ${e.message}`);
-        }
-    });
+async function getConfig(options = {}) {
+    const { configPath = findConfig(), externalRefResolver = new resolve_1.BaseResolver() } = options;
+    if (!configPath)
+        return { rawConfig: {} };
+    try {
+        const { document, resolvedRefMap } = await (0, config_resolvers_1.resolveConfigFileAndRefs)({
+            configPath,
+            externalRefResolver,
+        });
+        const bundledRefMap = (0, utils_2.deepCloneMapWithJSON)(resolvedRefMap);
+        const parsed = await (0, bundle_1.bundleConfig)(JSON.parse(JSON.stringify(document)), bundledRefMap);
+        return {
+            rawConfig: (0, utils_2.transformConfig)(parsed),
+            document,
+            parsed,
+            resolvedRefMap,
+        };
+    }
+    catch (e) {
+        throw new Error(`Error parsing config file at '${configPath}': ${e.message}`);
+    }
 }
-exports.getConfig = getConfig;
-function createConfig(config, options) {
-    return __awaiter(this, void 0, void 0, function* () {
-        return addConfigMetadata(Object.assign({ rawConfig: (0, utils_2.transformConfig)(typeof config === 'string' ? (0, js_yaml_1.parseYaml)(config) : config) }, options));
+async function createConfig(config, options) {
+    return addConfigMetadata({
+        rawConfig: (0, utils_2.transformConfig)(typeof config === 'string' ? (0, js_yaml_1.parseYaml)(config) : config),
+        ...options,
     });
 }
-exports.createConfig = createConfig;

package/lib/config/minimal.js

@@ -96,6 +96,15 @@ const minimal = {
         'channels-kebab-case': 'off',
         'no-channel-trailing-slash': 'off',
     },
+    async3Rules: {
+        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',
     },

package/lib/config/recommended-strict.js

@@ -96,6 +96,15 @@ const recommendedStrict = {
         'channels-kebab-case': 'off',
         'no-channel-trailing-slash': 'off',
     },
+    async3Rules: {
+        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',
     },

package/lib/config/recommended.js

@@ -96,6 +96,15 @@ const recommended = {
         'channels-kebab-case': 'off',
         'no-channel-trailing-slash': 'off',
     },
+    async3Rules: {
+        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',
     },

package/lib/config/rules.d.ts

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

package/lib/config/rules.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.initRules = void 0;
+exports.initRules = initRules;
 const utils_1 = require("../utils");
 function initRules(rules, config, type, oasVersion) {
     return rules
@@ -32,4 +32,3 @@ function initRules(rules, config, type, oasVersion) {
         .flatMap((visitor) => visitor)
         .filter(utils_1.isDefined);
 }
-exports.initRules = initRules;

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, ArazzoRuleSet, ArazzoPreprocessorsSet, ArazzoDecoratorsSet, RuleMap } from '../oas-types';
+import type { Oas3PreprocessorsSet, SpecMajorVersion, Oas3DecoratorsSet, Oas2RuleSet, Oas2PreprocessorsSet, Oas2DecoratorsSet, Oas3RuleSet, SpecVersion, Async2PreprocessorsSet, Async2DecoratorsSet, Async2RuleSet, Async3PreprocessorsSet, Async3DecoratorsSet, Async3RuleSet, 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, BuiltInOAS2RuleId, BuiltInOAS3RuleId, BuiltInArazzoRuleId } from '../types/redocly-yaml';
+import { BuiltInAsync2RuleId, BuiltInAsync3RuleId, BuiltInCommonOASRuleId, BuiltInOAS2RuleId, BuiltInOAS3RuleId, BuiltInArazzoRuleId } from '../types/redocly-yaml';
 export type RuleSeverity = ProblemSeverity | 'off';
 export type RuleSettings = {
     severity: RuleSeverity;
@@ -26,18 +26,21 @@ export type StyleguideRawConfig<T = undefined> = {
     oas3_0Rules?: RuleMap<BuiltInOAS3RuleId, RuleConfig, T>;
     oas3_1Rules?: RuleMap<BuiltInOAS3RuleId, RuleConfig, T>;
     async2Rules?: RuleMap<BuiltInAsync2RuleId, RuleConfig, T>;
+    async3Rules?: RuleMap<BuiltInAsync3RuleId, 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>;
+    async3Preprocessors?: 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>;
+    async3Decorators?: Record<string, DecoratorConfig>;
     arazzoDecorators?: Record<string, DecoratorConfig>;
 };
 export type ApiStyleguideRawConfig = Omit<StyleguideRawConfig, 'plugins'>;
@@ -52,12 +55,14 @@ export type PreprocessorsConfig = {
     oas3?: Oas3PreprocessorsSet;
     oas2?: Oas2PreprocessorsSet;
     async2?: Async2PreprocessorsSet;
+    async3?: Async3PreprocessorsSet;
     arazzo?: ArazzoPreprocessorsSet;
 };
 export type DecoratorsConfig = {
     oas3?: Oas3DecoratorsSet;
     oas2?: Oas2DecoratorsSet;
     async2?: Async2DecoratorsSet;
+    async3?: Async3DecoratorsSet;
     arazzo?: ArazzoDecoratorsSet;
 };
 export type TypesExtensionFn = (types: Record<string, NodeType>, oasVersion: SpecVersion) => Record<string, NodeType>;
@@ -66,6 +71,7 @@ export type CustomRulesConfig = {
     oas3?: Oas3RuleSet;
     oas2?: Oas2RuleSet;
     async2?: Async2RuleSet;
+    async3?: Async3RuleSet;
     arazzo?: ArazzoRuleSet;
 };
 export type AssertionContext = Partial<UserContext> & SkipFunctionContext & {
@@ -162,5 +168,5 @@ export type ThemeRawConfig = {
     openapi?: Record<string, any>;
     mockServer?: Record<string, any>;
 };
-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 type RulesFields = 'rules' | 'oas2Rules' | 'oas3_0Rules' | 'oas3_1Rules' | 'async2Rules' | 'async3Rules' | 'arazzoRules' | 'preprocessors' | 'oas2Preprocessors' | 'oas3_0Preprocessors' | 'oas3_1Preprocessors' | 'async2Preprocessors' | 'async3Preprocessors' | 'arazzoPreprocessors' | 'decorators' | 'oas2Decorators' | 'oas3_0Decorators' | 'oas3_1Decorators' | 'async2Decorators' | 'async3Decorators' | 'arazzoDecorators';
 export {};