@redocly/openapi-core 0.0.0-snapshot.1740665575 → 0.0.0-snapshot.1742384755

package/lib/config/types.d.ts

@@ -1,6 +1,6 @@
 import type { Location } from '../ref-utils';
 import type { ProblemSeverity, UserContext } from '../walk';
-import type { Oas3PreprocessorsSet, SpecMajorVersion, Oas3DecoratorsSet, Oas2RuleSet, Oas2PreprocessorsSet, Oas2DecoratorsSet, Oas3RuleSet, SpecVersion, Async2PreprocessorsSet, Async2DecoratorsSet, Async2RuleSet, Async3PreprocessorsSet, Async3DecoratorsSet, Async3RuleSet, Arazzo1RuleSet, Arazzo1PreprocessorsSet, Arazzo1DecoratorsSet, RuleMap } from '../oas-types';
+import type { Oas3PreprocessorsSet, SpecMajorVersion, Oas3DecoratorsSet, Oas2RuleSet, Oas2PreprocessorsSet, Oas2DecoratorsSet, Oas3RuleSet, SpecVersion, Async2PreprocessorsSet, Async2DecoratorsSet, Async2RuleSet, Async3PreprocessorsSet, Async3DecoratorsSet, Async3RuleSet, Arazzo1RuleSet, Arazzo1PreprocessorsSet, Arazzo1DecoratorsSet, RuleMap, Overlay1PreprocessorsSet, Overlay1DecoratorsSet, Overlay1RuleSet } from '../oas-types';
 import type { NodeType } from '../types';
 import type { SkipFunctionContext } from '../visitors';
 import type { JSONSchema } from 'json-schema-to-ts';
@@ -27,6 +27,7 @@ export type StyleguideRawConfig<T = undefined> = {
     async2Rules?: RuleMap<string, RuleConfig, T>;
     async3Rules?: RuleMap<string, RuleConfig, T>;
     arazzo1Rules?: RuleMap<string, RuleConfig, T>;
+    overlay1Rules?: RuleMap<string, RuleConfig, T>;
     preprocessors?: Record<string, PreprocessorConfig>;
     oas2Preprocessors?: Record<string, PreprocessorConfig>;
     oas3_0Preprocessors?: Record<string, PreprocessorConfig>;
@@ -34,6 +35,7 @@ export type StyleguideRawConfig<T = undefined> = {
     async2Preprocessors?: Record<string, PreprocessorConfig>;
     async3Preprocessors?: Record<string, PreprocessorConfig>;
     arazzo1Preprocessors?: Record<string, PreprocessorConfig>;
+    overlay1Preprocessors?: Record<string, PreprocessorConfig>;
     decorators?: Record<string, DecoratorConfig>;
     oas2Decorators?: Record<string, DecoratorConfig>;
     oas3_0Decorators?: Record<string, DecoratorConfig>;
@@ -41,6 +43,7 @@ export type StyleguideRawConfig<T = undefined> = {
     async2Decorators?: Record<string, DecoratorConfig>;
     async3Decorators?: Record<string, DecoratorConfig>;
     arazzo1Decorators?: Record<string, DecoratorConfig>;
+    overlay1Decorators?: Record<string, DecoratorConfig>;
 };
 export type ApiStyleguideRawConfig = Omit<StyleguideRawConfig, 'plugins'>;
 export type ResolvedStyleguideConfig = PluginStyleguideConfig & {
@@ -56,6 +59,7 @@ export type PreprocessorsConfig = {
     async2?: Async2PreprocessorsSet;
     async3?: Async3PreprocessorsSet;
     arazzo1?: Arazzo1PreprocessorsSet;
+    overlay1?: Overlay1PreprocessorsSet;
 };
 export type DecoratorsConfig = {
     oas3?: Oas3DecoratorsSet;
@@ -63,6 +67,7 @@ export type DecoratorsConfig = {
     async2?: Async2DecoratorsSet;
     async3?: Async3DecoratorsSet;
     arazzo1?: Arazzo1DecoratorsSet;
+    overlay1?: Overlay1DecoratorsSet;
 };
 export type TypesExtensionFn = (types: Record<string, NodeType>, oasVersion: SpecVersion) => Record<string, NodeType>;
 export type TypeExtensionsConfig = Partial<Record<SpecMajorVersion, TypesExtensionFn>>;
@@ -72,6 +77,7 @@ export type RulesConfig<T> = {
     async2?: Async2RuleSet<T>;
     async3?: Async3RuleSet<T>;
     arazzo1?: Arazzo1RuleSet<T>;
+    overlay1?: Overlay1RuleSet<T>;
 };
 export type CustomRulesConfig = RulesConfig<undefined>;
 export type AssertionContext = Partial<UserContext> & SkipFunctionContext & {
@@ -131,11 +137,7 @@ export type HttpResolveConfig = {
 export type ResolveConfig = {
     http: HttpResolveConfig;
 };
-export type Region = 'us' | 'eu';
 export type Telemetry = 'on' | 'off';
-export type AccessTokens = {
-    [region in Region]?: string;
-};
 export type DeprecatedInRawConfig = {
     apiDefinitions?: Record<string, string>;
     lint?: StyleguideRawConfig;
@@ -153,15 +155,11 @@ export type DeprecatedInApi = {
 } & DeprecatedFeaturesConfig;
 export type ResolvedApi = Omit<Api, 'styleguide'> & {
     styleguide: ResolvedStyleguideConfig;
-    files?: string[];
 };
 export type RawConfig = {
     apis?: Record<string, Api>;
     styleguide?: StyleguideRawConfig;
     resolve?: RawResolveConfig;
-    region?: Region;
-    organization?: string;
-    files?: string[];
     telemetry?: Telemetry;
 } & ThemeConfig;
 export type RawUniversalConfig = Omit<RawConfig, 'styleguide'> & StyleguideRawConfig;
@@ -185,5 +183,5 @@ export type ThemeRawConfig = {
     openapi?: Record<string, any>;
     mockServer?: Record<string, any>;
 };
-export type RulesFields = 'rules' | 'oas2Rules' | 'oas3_0Rules' | 'oas3_1Rules' | 'async2Rules' | 'async3Rules' | 'arazzo1Rules' | 'preprocessors' | 'oas2Preprocessors' | 'oas3_0Preprocessors' | 'oas3_1Preprocessors' | 'async2Preprocessors' | 'async3Preprocessors' | 'arazzo1Preprocessors' | 'decorators' | 'oas2Decorators' | 'oas3_0Decorators' | 'oas3_1Decorators' | 'async2Decorators' | 'async3Decorators' | 'arazzo1Decorators';
+export type RulesFields = 'rules' | 'oas2Rules' | 'oas3_0Rules' | 'oas3_1Rules' | 'async2Rules' | 'async3Rules' | 'arazzo1Rules' | 'overlay1Rules' | 'preprocessors' | 'oas2Preprocessors' | 'oas3_0Preprocessors' | 'oas3_1Preprocessors' | 'async2Preprocessors' | 'async3Preprocessors' | 'arazzo1Preprocessors' | 'overlay1Preprocessors' | 'decorators' | 'oas2Decorators' | 'oas3_0Decorators' | 'oas3_1Decorators' | 'async2Decorators' | 'async3Decorators' | 'arazzo1Decorators' | 'overlay1Decorators';
 export {};

package/lib/config/utils.js

@@ -34,7 +34,7 @@ function transformApiDefinitionsToApis(apiDefinitions) {
     }
     return apis;
 }
-function extractFlatConfig({ plugins, extends: _extends, rules, oas2Rules, oas3_0Rules, oas3_1Rules, async2Rules, async3Rules, arazzo1Rules, preprocessors, oas2Preprocessors, oas3_0Preprocessors, oas3_1Preprocessors, async2Preprocessors, async3Preprocessors, arazzo1Preprocessors, decorators, oas2Decorators, oas3_0Decorators, oas3_1Decorators, async2Decorators, async3Decorators, arazzo1Decorators, ...rawConfigRest }) {
+function extractFlatConfig({ plugins, extends: _extends, rules, oas2Rules, oas3_0Rules, oas3_1Rules, async2Rules, async3Rules, arazzo1Rules, overlay1Rules, preprocessors, oas2Preprocessors, oas3_0Preprocessors, oas3_1Preprocessors, async2Preprocessors, async3Preprocessors, arazzo1Preprocessors, overlay1Preprocessors, decorators, oas2Decorators, oas3_0Decorators, oas3_1Decorators, async2Decorators, async3Decorators, arazzo1Decorators, overlay1Decorators, ...rawConfigRest }) {
     const styleguideConfig = {
         plugins,
         extends: _extends,
@@ -45,6 +45,7 @@ function extractFlatConfig({ plugins, extends: _extends, rules, oas2Rules, oas3_
         async2Rules,
         async3Rules,
         arazzo1Rules,
+        overlay1Rules,
         preprocessors,
         oas2Preprocessors,
         oas3_0Preprocessors,
@@ -52,6 +53,7 @@ function extractFlatConfig({ plugins, extends: _extends, rules, oas2Rules, oas3_
         async2Preprocessors,
         async3Preprocessors,
         arazzo1Preprocessors,
+        overlay1Preprocessors,
         decorators,
         oas2Decorators,
         oas3_0Decorators,
@@ -59,6 +61,7 @@ function extractFlatConfig({ plugins, extends: _extends, rules, oas2Rules, oas3_
         async2Decorators,
         async3Decorators,
         arazzo1Decorators,
+        overlay1Decorators,
         doNotResolveExamples: rawConfigRest.resolve?.doNotResolveExamples,
     };
     if ((rawConfigRest.lint && rawConfigRest.styleguide) ||
@@ -104,6 +107,7 @@ function mergeExtends(rulesConfList) {
         async2Rules: {},
         async3Rules: {},
         arazzo1Rules: {},
+        overlay1Rules: {},
         preprocessors: {},
         oas2Preprocessors: {},
         oas3_0Preprocessors: {},
@@ -111,6 +115,7 @@ function mergeExtends(rulesConfList) {
         async2Preprocessors: {},
         async3Preprocessors: {},
         arazzo1Preprocessors: {},
+        overlay1Preprocessors: {},
         decorators: {},
         oas2Decorators: {},
         oas3_0Decorators: {},
@@ -118,6 +123,7 @@ function mergeExtends(rulesConfList) {
         async2Decorators: {},
         async3Decorators: {},
         arazzo1Decorators: {},
+        overlay1Decorators: {},
         plugins: [],
         pluginPaths: [],
         extendPaths: [],
@@ -139,6 +145,8 @@ function mergeExtends(rulesConfList) {
         (0, utils_1.assignOnlyExistingConfig)(result.async3Rules, rulesConf.rules);
         (0, utils_1.assignConfig)(result.arazzo1Rules, rulesConf.arazzo1Rules);
         (0, utils_1.assignOnlyExistingConfig)(result.arazzo1Rules, rulesConf.rules);
+        (0, utils_1.assignConfig)(result.overlay1Rules, rulesConf.overlay1Rules);
+        (0, utils_1.assignOnlyExistingConfig)(result.overlay1Rules, rulesConf.rules);
         (0, utils_1.assignConfig)(result.preprocessors, rulesConf.preprocessors);
         (0, utils_1.assignConfig)(result.oas2Preprocessors, rulesConf.oas2Preprocessors);
         (0, utils_1.assignOnlyExistingConfig)(result.oas2Preprocessors, rulesConf.preprocessors);
@@ -152,6 +160,8 @@ function mergeExtends(rulesConfList) {
         (0, utils_1.assignOnlyExistingConfig)(result.async3Preprocessors, rulesConf.preprocessors);
         (0, utils_1.assignConfig)(result.arazzo1Preprocessors, rulesConf.arazzo1Preprocessors);
         (0, utils_1.assignOnlyExistingConfig)(result.arazzo1Preprocessors, rulesConf.preprocessors);
+        (0, utils_1.assignConfig)(result.overlay1Preprocessors, rulesConf.overlay1Preprocessors);
+        (0, utils_1.assignOnlyExistingConfig)(result.overlay1Preprocessors, rulesConf.preprocessors);
         (0, utils_1.assignConfig)(result.decorators, rulesConf.decorators);
         (0, utils_1.assignConfig)(result.oas2Decorators, rulesConf.oas2Decorators);
         (0, utils_1.assignOnlyExistingConfig)(result.oas2Decorators, rulesConf.decorators);
@@ -165,6 +175,8 @@ function mergeExtends(rulesConfList) {
         (0, utils_1.assignOnlyExistingConfig)(result.async3Decorators, rulesConf.decorators);
         (0, utils_1.assignConfig)(result.arazzo1Decorators, rulesConf.arazzo1Decorators);
         (0, utils_1.assignOnlyExistingConfig)(result.arazzo1Decorators, rulesConf.decorators);
+        (0, utils_1.assignConfig)(result.overlay1Decorators, rulesConf.overlay1Decorators);
+        (0, utils_1.assignOnlyExistingConfig)(result.overlay1Decorators, rulesConf.decorators);
         result.plugins.push(...(rulesConf.plugins || []));
         result.pluginPaths.push(...(rulesConf.pluginPaths || []));
         result.extendPaths.push(...new Set(rulesConf.extendPaths));
@@ -194,11 +206,11 @@ function getMergedConfig(config, apiName) {
                 extendPaths,
                 pluginPaths,
             },
+            // FIXME: theme is deprecated
             theme: {
                 ...config.rawConfig.theme,
                 ...config.apis[apiName]?.theme,
             },
-            files: [...config.files, ...(config.apis?.[apiName]?.files ?? [])],
             // TODO: merge everything else here
         }, config.configFile)
         : config;
@@ -243,6 +255,7 @@ function transformConfig(rawConfig) {
     const { apis, apiDefinitions, referenceDocs, lint, ...rest } = rawConfig;
     const { styleguideConfig, rawConfigRest } = extractFlatConfig(rest);
     const transformedConfig = {
+        // FIXME: ? theme is deprecated
         theme: {
             openapi: {
                 ...referenceDocs,

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

@@ -1,6 +1,5 @@
 import type { Oas2Decorator } from '../../visitors';
 export declare const decorators: {
-    'registry-dependencies': Oas2Decorator;
     'operation-description-override': Oas2Decorator;
     'tag-description-override': Oas2Decorator;
     'info-description-override': Oas2Decorator;

package/lib/decorators/oas2/index.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.decorators = void 0;
-const registry_dependencies_1 = require("../common/registry-dependencies");
 const operation_description_override_1 = require("../common/operation-description-override");
 const tag_description_override_1 = require("../common/tag-description-override");
 const info_description_override_1 = require("../common/info-description-override");
@@ -10,7 +9,6 @@ const remove_x_internal_1 = require("../common/remove-x-internal");
 const filter_in_1 = require("../common/filters/filter-in");
 const filter_out_1 = require("../common/filters/filter-out");
 exports.decorators = {
-    'registry-dependencies': registry_dependencies_1.RegistryDependencies,
     'operation-description-override': operation_description_override_1.OperationDescriptionOverride,
     'tag-description-override': tag_description_override_1.TagDescriptionOverride,
     'info-description-override': info_description_override_1.InfoDescriptionOverride,

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

@@ -1,6 +1,5 @@
 import type { Oas3Decorator } from '../../visitors';
 export declare const decorators: {
-    'registry-dependencies': Oas3Decorator;
     'operation-description-override': Oas3Decorator;
     'tag-description-override': Oas3Decorator;
     'info-description-override': Oas3Decorator;

package/lib/decorators/oas3/index.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.decorators = void 0;
-const registry_dependencies_1 = require("../common/registry-dependencies");
 const operation_description_override_1 = require("../common/operation-description-override");
 const tag_description_override_1 = require("../common/tag-description-override");
 const info_description_override_1 = require("../common/info-description-override");
@@ -11,7 +10,6 @@ const filter_in_1 = require("../common/filters/filter-in");
 const filter_out_1 = require("../common/filters/filter-out");
 const media_type_examples_override_1 = require("../common/media-type-examples-override");
 exports.decorators = {
-    'registry-dependencies': registry_dependencies_1.RegistryDependencies,
     'operation-description-override': operation_description_override_1.OperationDescriptionOverride,
     'tag-description-override': tag_description_override_1.TagDescriptionOverride,
     'info-description-override': info_description_override_1.InfoDescriptionOverride,

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

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

package/lib/{redocly/redocly-client-types.js → decorators/overlay1/index.js}

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

package/lib/index.d.ts

@@ -11,9 +11,7 @@ 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, RawUniversalConfig, IGNORE_FILE, Region, getMergedConfig, transformConfig, loadConfig, getConfig, findConfig, CONFIG_FILE_NAMES, RuleSeverity, createConfig, ResolvedApi, } from './config';
-export { RedoclyClient } from './redocly';
-export * from './redocly/domains';
+export { Config, StyleguideConfig, RawConfig, RawUniversalConfig, IGNORE_FILE, getMergedConfig, transformConfig, loadConfig, getConfig, findConfig, CONFIG_FILE_NAMES, RuleSeverity, createConfig, ResolvedApi, } from './config';
 export { Source, BaseResolver, Document, resolveDocument, ResolveError, YamlParseError, makeDocumentFromString, } from './resolve';
 export { parseYaml, stringifyYaml } from './js-yaml';
 export { unescapePointer, isRef, isAbsoluteUrl } from './ref-utils';

package/lib/index.js

@@ -1,21 +1,7 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validate = exports.lint = exports.getTotals = exports.formatProblems = exports.getLineColLocation = exports.getAstNodeByPointer = exports.walkDocument = exports.normalizeVisitors = exports.getTypes = exports.detectSpec = exports.SpecVersion = exports.getMajorSpecVersion = exports.SpecMajorVersion = exports.isAbsoluteUrl = exports.isRef = exports.unescapePointer = exports.stringifyYaml = exports.parseYaml = exports.makeDocumentFromString = exports.YamlParseError = exports.ResolveError = exports.resolveDocument = exports.BaseResolver = exports.Source = exports.RedoclyClient = exports.createConfig = exports.CONFIG_FILE_NAMES = exports.findConfig = exports.getConfig = exports.loadConfig = exports.transformConfig = exports.getMergedConfig = exports.IGNORE_FILE = exports.StyleguideConfig = exports.Config = exports.Stats = exports.normalizeTypes = exports.ConfigTypes = exports.AsyncApi3Types = exports.AsyncApi2Types = exports.Oas2Types = exports.Oas3Types = exports.Arazzo1Types = exports.Oas3_1Types = exports.pause = exports.getProxyAgent = exports.isTruthy = exports.doesYamlFileExist = exports.slash = exports.readFileFromUrl = void 0;
-exports.bundleFromString = exports.mapTypeToComponent = exports.bundleDocument = exports.bundle = exports.lintConfig = exports.lintFromString = exports.lintDocument = void 0;
+exports.lintDocument = exports.validate = exports.lint = exports.getTotals = exports.formatProblems = exports.getLineColLocation = exports.getAstNodeByPointer = exports.walkDocument = exports.normalizeVisitors = exports.getTypes = exports.detectSpec = exports.SpecVersion = exports.getMajorSpecVersion = exports.SpecMajorVersion = exports.isAbsoluteUrl = exports.isRef = exports.unescapePointer = exports.stringifyYaml = exports.parseYaml = exports.makeDocumentFromString = exports.YamlParseError = exports.ResolveError = exports.resolveDocument = exports.BaseResolver = exports.Source = exports.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.AsyncApi3Types = exports.AsyncApi2Types = exports.Oas2Types = exports.Oas3Types = exports.Arazzo1Types = exports.Oas3_1Types = exports.pause = exports.getProxyAgent = exports.isTruthy = exports.doesYamlFileExist = exports.slash = exports.readFileFromUrl = void 0;
+exports.bundleFromString = exports.mapTypeToComponent = exports.bundleDocument = exports.bundle = exports.lintConfig = exports.lintFromString = void 0;
 var utils_1 = require("./utils");
 Object.defineProperty(exports, "readFileFromUrl", { enumerable: true, get: function () { return utils_1.readFileFromUrl; } });
 Object.defineProperty(exports, "slash", { enumerable: true, get: function () { return utils_1.slash; } });
@@ -52,9 +38,6 @@ Object.defineProperty(exports, "getConfig", { enumerable: true, get: function ()
 Object.defineProperty(exports, "findConfig", { enumerable: true, get: function () { return config_1.findConfig; } });
 Object.defineProperty(exports, "CONFIG_FILE_NAMES", { enumerable: true, get: function () { return config_1.CONFIG_FILE_NAMES; } });
 Object.defineProperty(exports, "createConfig", { enumerable: true, get: function () { return config_1.createConfig; } });
-var redocly_1 = require("./redocly");
-Object.defineProperty(exports, "RedoclyClient", { enumerable: true, get: function () { return redocly_1.RedoclyClient; } });
-__exportStar(require("./redocly/domains"), exports);
 var resolve_1 = require("./resolve");
 Object.defineProperty(exports, "Source", { enumerable: true, get: function () { return resolve_1.Source; } });
 Object.defineProperty(exports, "BaseResolver", { enumerable: true, get: function () { return resolve_1.BaseResolver; } });

package/lib/oas-types.d.ts

@@ -1,19 +1,21 @@
-import type { BuiltInAsync2RuleId, BuiltInAsync3RuleId, BuiltInArazzo1RuleId, BuiltInOAS2RuleId, BuiltInOAS3RuleId } from './types/redocly-yaml';
-import type { Oas3Rule, Oas3Preprocessor, Oas2Rule, Oas2Preprocessor, Async2Preprocessor, Async2Rule, Async3Preprocessor, Async3Rule, Arazzo1Preprocessor, Arazzo1Rule } from './visitors';
+import type { BuiltInAsync2RuleId, BuiltInAsync3RuleId, BuiltInArazzo1RuleId, BuiltInOAS2RuleId, BuiltInOAS3RuleId, BuiltInOverlay1RuleId } from './types/redocly-yaml';
+import type { Oas3Rule, Oas3Preprocessor, Oas2Rule, Oas2Preprocessor, Async2Preprocessor, Async2Rule, Async3Preprocessor, Async3Rule, Arazzo1Preprocessor, Arazzo1Rule, Overlay1Preprocessor, Overlay1Rule } from './visitors';
 export declare enum SpecVersion {
     OAS2 = "oas2",
     OAS3_0 = "oas3_0",
     OAS3_1 = "oas3_1",
     Async2 = "async2",
     Async3 = "async3",
-    Arazzo1 = "arazzo1"
+    Arazzo1 = "arazzo1",
+    Overlay1 = "overlay1"
 }
 export declare enum SpecMajorVersion {
     OAS2 = "oas2",
     OAS3 = "oas3",
     Async2 = "async2",
     Async3 = "async3",
-    Arazzo1 = "arazzo1"
+    Arazzo1 = "arazzo1",
+    Overlay1 = "overlay1"
 }
 export type RuleMap<Key extends string, RuleConfig, T> = Record<T extends 'built-in' ? Key : string, RuleConfig>;
 export type Oas3RuleSet<T = undefined> = RuleMap<BuiltInOAS3RuleId | 'struct' | 'assertions', Oas3Rule, T>;
@@ -21,16 +23,19 @@ export type Oas2RuleSet<T = undefined> = RuleMap<BuiltInOAS2RuleId | 'struct' |
 export type Async2RuleSet<T = undefined> = RuleMap<BuiltInAsync2RuleId | 'struct' | 'assertions', Async2Rule, T>;
 export type Async3RuleSet<T = undefined> = RuleMap<BuiltInAsync3RuleId | 'struct' | 'assertions', Async3Rule, T>;
 export type Arazzo1RuleSet<T = undefined> = RuleMap<BuiltInArazzo1RuleId | 'struct' | 'assertions', Arazzo1Rule, T>;
+export type Overlay1RuleSet<T = undefined> = RuleMap<BuiltInOverlay1RuleId | 'struct' | 'assertions', Overlay1Rule, T>;
 export type Oas3PreprocessorsSet = Record<string, Oas3Preprocessor>;
 export type Oas2PreprocessorsSet = Record<string, Oas2Preprocessor>;
 export type Async2PreprocessorsSet = Record<string, Async2Preprocessor>;
 export type Async3PreprocessorsSet = Record<string, Async3Preprocessor>;
 export type Arazzo1PreprocessorsSet = Record<string, Arazzo1Preprocessor>;
+export type Overlay1PreprocessorsSet = Record<string, Overlay1Preprocessor>;
 export type Oas3DecoratorsSet = Record<string, Oas3Preprocessor>;
 export type Oas2DecoratorsSet = Record<string, Oas2Preprocessor>;
 export type Async2DecoratorsSet = Record<string, Async2Preprocessor>;
 export type Async3DecoratorsSet = Record<string, Async3Preprocessor>;
 export type Arazzo1DecoratorsSet = Record<string, Arazzo1Preprocessor>;
+export type Overlay1DecoratorsSet = Record<string, Overlay1Preprocessor>;
 export declare function detectSpec(root: unknown): SpecVersion;
 export declare function getMajorSpecVersion(version: SpecVersion): SpecMajorVersion;
 export declare function getTypes(spec: SpecVersion): Record<string, import("./types").NodeType> | Record<"Root" | "Tag" | "TagList" | "ExternalDocs" | "SecurityRequirement" | "SecurityRequirementList" | "Info" | "Contact" | "License" | "Paths" | "PathItem" | "Parameter" | "ParameterList" | "ParameterItems" | "Operation" | "Example" | "ExamplesMap" | "Examples" | "Header" | "Responses" | "Response" | "Schema" | "Xml" | "SchemaProperties" | "NamedSchemas" | "NamedResponses" | "NamedParameters" | "NamedSecuritySchemes" | "SecurityScheme" | "TagGroup" | "TagGroups" | "EnumDescriptions" | "Logo" | "XCodeSample" | "XCodeSampleList" | "XServer" | "XServerList", import("./types").NodeType> | Record<"Root" | "Tag" | "TagList" | "ExternalDocs" | "SecurityRequirement" | "SecurityRequirementList" | "Info" | "Contact" | "License" | "Paths" | "PathItem" | "Parameter" | "ParameterList" | "Operation" | "Example" | "ExamplesMap" | "Header" | "Responses" | "Response" | "Schema" | "Xml" | "SchemaProperties" | "NamedSchemas" | "NamedResponses" | "NamedParameters" | "NamedSecuritySchemes" | "SecurityScheme" | "TagGroup" | "TagGroups" | "EnumDescriptions" | "Logo" | "XCodeSample" | "XCodeSampleList" | "Server" | "ServerList" | "ServerVariable" | "ServerVariablesMap" | "Callback" | "CallbacksMap" | "RequestBody" | "MediaTypesMap" | "MediaType" | "Encoding" | "EncodingMap" | "HeadersMap" | "Link" | "LinksMap" | "DiscriminatorMapping" | "Discriminator" | "Components" | "NamedExamples" | "NamedRequestBodies" | "NamedHeaders" | "NamedLinks" | "NamedCallbacks" | "ImplicitFlow" | "PasswordFlow" | "ClientCredentials" | "AuthorizationCode" | "OAuth2Flows" | "XUsePkce" | "WebhooksMap", import("./types").NodeType> | Record<"Root" | "Info" | "License" | "Operation" | "Schema" | "SchemaProperties" | "SecurityScheme" | "Components" | "PatternProperties" | "NamedPathItems" | "DependentRequired", import("./types").NodeType>;

package/lib/oas-types.js

@@ -10,6 +10,7 @@ const oas3_1_1 = require("./types/oas3_1");
 const asyncapi2_1 = require("./types/asyncapi2");
 const asyncapi3_1 = require("./types/asyncapi3");
 const arazzo_1 = require("./types/arazzo");
+const overlay_1 = require("./types/overlay");
 const utils_1 = require("./utils");
 const arazzo_2 = require("./typings/arazzo");
 var SpecVersion;
@@ -20,6 +21,7 @@ var SpecVersion;
     SpecVersion["Async2"] = "async2";
     SpecVersion["Async3"] = "async3";
     SpecVersion["Arazzo1"] = "arazzo1";
+    SpecVersion["Overlay1"] = "overlay1";
 })(SpecVersion || (exports.SpecVersion = SpecVersion = {}));
 var SpecMajorVersion;
 (function (SpecMajorVersion) {
@@ -28,6 +30,7 @@ var SpecMajorVersion;
     SpecMajorVersion["Async2"] = "async2";
     SpecMajorVersion["Async3"] = "async3";
     SpecMajorVersion["Arazzo1"] = "arazzo1";
+    SpecMajorVersion["Overlay1"] = "overlay1";
 })(SpecMajorVersion || (exports.SpecMajorVersion = SpecMajorVersion = {}));
 const typesMap = {
     [SpecVersion.OAS2]: oas2_1.Oas2Types,
@@ -36,6 +39,7 @@ const typesMap = {
     [SpecVersion.Async2]: asyncapi2_1.AsyncApi2Types,
     [SpecVersion.Async3]: asyncapi3_1.AsyncApi3Types,
     [SpecVersion.Arazzo1]: arazzo_1.Arazzo1Types,
+    [SpecVersion.Overlay1]: overlay_1.Overlay1Types,
 };
 function detectSpec(root) {
     if (!(0, utils_1.isPlainObject)(root)) {
@@ -68,6 +72,9 @@ function detectSpec(root) {
     if (typeof root.arazzo === 'string' && arazzo_2.VERSION_PATTERN.test(root.arazzo)) {
         return SpecVersion.Arazzo1;
     }
+    if (typeof root.overlay === 'string' && arazzo_2.VERSION_PATTERN.test(root.overlay)) {
+        return SpecVersion.Overlay1;
+    }
     throw new Error(`Unsupported specification`);
 }
 function getMajorSpecVersion(version) {
@@ -83,6 +90,9 @@ function getMajorSpecVersion(version) {
     else if (version === SpecVersion.Arazzo1) {
         return SpecMajorVersion.Arazzo1;
     }
+    else if (version === SpecVersion.Overlay1) {
+        return SpecMajorVersion.Overlay1;
+    }
     else {
         return SpecMajorVersion.OAS3;
     }

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

@@ -4,7 +4,7 @@ exports.NoChannelTrailingSlash = void 0;
 const NoChannelTrailingSlash = () => {
     return {
         Channel(channel, { report, location }) {
-            if (channel.address.endsWith('/') && channel.address !== '/') {
+            if (channel?.address?.endsWith('/') && channel?.address !== '/') {
                 report({
                     message: `\`${channel.address}\` should not have a trailing slash.`,
                     location: location.key(),

package/lib/rules/common/assertions/index.d.ts

@@ -1,5 +1,5 @@
 import type { asserts, AssertionFn } from './asserts';
-import type { Arazzo1Visitor, Async2Visitor, Async3Visitor, Oas2Visitor, Oas3Visitor } from '../../../visitors';
+import type { Arazzo1Visitor, Async2Visitor, Async3Visitor, Oas2Visitor, Oas3Visitor, Overlay1Visitor } from '../../../visitors';
 import type { RuleSeverity } from '../../../config';
 export type AssertionLocators = {
     filterInParentKeys?: (string | number)[];
@@ -24,4 +24,4 @@ export type RawAssertion = AssertionDefinition & {
 export type Assertion = RawAssertion & {
     assertionId: string;
 };
-export declare const Assertions: (opts: Record<string, Assertion>) => (Oas3Visitor | Oas2Visitor | Async2Visitor | Async3Visitor | Arazzo1Visitor)[];
+export declare const Assertions: (opts: Record<string, Assertion>) => (Oas3Visitor | Oas2Visitor | Async2Visitor | Async3Visitor | Arazzo1Visitor | Overlay1Visitor)[];

package/lib/rules/common/no-invalid-schema-examples.d.ts

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

package/lib/rules/common/no-invalid-schema-examples.js

@@ -7,12 +7,19 @@ const NoInvalidSchemaExamples = (opts) => {
     return {
         Schema: {
             leave(schema, ctx) {
-                if (schema.examples) {
-                    for (const example of schema.examples) {
-                        (0, utils_1.validateExample)(example, schema, ctx.location.child(['examples', schema.examples.indexOf(example)]), ctx, allowAdditionalProperties);
+                const examples = schema.examples;
+                if (examples) {
+                    for (const example of examples) {
+                        (0, utils_1.validateExample)(example, schema, ctx.location.child(['examples', examples.indexOf(example)]), ctx, allowAdditionalProperties);
                     }
                 }
                 if (schema.example !== undefined) {
+                    // Handle nullable example for OAS3
+                    if (schema.nullable === true &&
+                        schema.example === null &&
+                        schema.type !== undefined) {
+                        return;
+                    }
                     (0, utils_1.validateExample)(schema.example, schema, ctx.location.child('example'), ctx, true);
                 }
             },

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

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

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

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

package/lib/rules/overlay1/index.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.preprocessors = exports.rules = void 0;
+const assertions_1 = require("../common/assertions");
+const info_contact_1 = require("../common/info-contact");
+const struct_1 = require("../common/struct");
+exports.rules = {
+    'info-contact': info_contact_1.InfoContact,
+    struct: struct_1.Struct,
+    assertions: assertions_1.Assertions,
+};
+exports.preprocessors = {};

package/lib/rules/respect/respect-supported-versions.js

@@ -10,7 +10,7 @@ const RespectSupportedVersions = () => {
             enter(root, { report, location }) {
                 if (!arazzo_1.ARAZZO_VERSIONS_SUPPORTED_BY_RESPECT.includes(root.arazzo)) {
                     report({
-                        message: `Only ${supportedVersions} Arazzo ${(0, utils_1.pluralize)('version is', arazzo_1.ARAZZO_VERSIONS_SUPPORTED_BY_RESPECT.length)} supported by Respect.`,
+                        message: `Only ${supportedVersions} Arazzo ${(0, utils_1.pluralize)('version is', arazzo_1.ARAZZO_VERSIONS_SUPPORTED_BY_RESPECT.length)} fully supported by Respect.`,
                         location: location.child('arazzo'),
                     });
                 }

package/lib/types/oas2.js

@@ -151,7 +151,7 @@ const Parameter = {
         uniqueItems: { type: 'boolean' },
         enum: { type: 'array' },
         multipleOf: { type: 'number' },
-        'x-example': 'Example',
+        'x-example': {}, // any
         'x-examples': 'ExamplesMap',
     },
     required(value) {

package/lib/types/oas3.js

@@ -301,7 +301,7 @@ const Schema = {
         required: { type: 'array', items: { type: 'string' } },
         enum: { type: 'array' },
         type: {
-            enum: ['object', 'array', 'string', 'number', 'integer', 'boolean', 'null'],
+            enum: ['object', 'array', 'string', 'number', 'integer', 'boolean'],
         },
         allOf: (0, _1.listOf)('Schema'),
         anyOf: (0, _1.listOf)('Schema'),

package/lib/types/redocly-yaml.d.ts

@@ -11,6 +11,8 @@ export type BuiltInAsync2RuleId = typeof builtInAsync2Rules[number];
 export type BuiltInAsync3RuleId = typeof builtInAsync3Rules[number];
 declare const builtInArazzo1Rules: readonly ["sourceDescription-type", "workflowId-unique", "stepId-unique", "sourceDescription-name-unique", "sourceDescriptions-not-empty", "workflow-dependsOn", "parameters-unique", "step-onSuccess-unique", "step-onFailure-unique", "respect-supported-versions", "requestBody-replacements-unique", "no-criteria-xpath", "criteria-unique"];
 export type BuiltInArazzo1RuleId = typeof builtInArazzo1Rules[number];
+declare const builtInOverlay1Rules: readonly ["info-contact"];
+export type BuiltInOverlay1RuleId = typeof builtInOverlay1Rules[number];
 declare const oas2NodeTypesList: readonly ["Root", "Tag", "TagList", "ExternalDocs", "SecurityRequirement", "SecurityRequirementList", "Info", "Contact", "License", "Paths", "PathItem", "Parameter", "ParameterList", "ParameterItems", "Operation", "Example", "ExamplesMap", "Examples", "Header", "Responses", "Response", "Schema", "Xml", "SchemaProperties", "NamedSchemas", "NamedResponses", "NamedParameters", "NamedSecuritySchemes", "SecurityScheme", "TagGroup", "TagGroups", "EnumDescriptions", "Logo", "XCodeSample", "XCodeSampleList", "XServer", "XServerList"];
 export type Oas2NodeType = typeof oas2NodeTypesList[number];
 declare const oas3NodeTypesList: readonly ["Root", "Tag", "TagList", "ExternalDocs", "Server", "ServerList", "ServerVariable", "ServerVariablesMap", "SecurityRequirement", "SecurityRequirementList", "Info", "Contact", "License", "Paths", "PathItem", "Parameter", "ParameterList", "Operation", "Callback", "CallbacksMap", "RequestBody", "MediaTypesMap", "MediaType", "Example", "ExamplesMap", "Encoding", "EncodingMap", "Header", "HeadersMap", "Responses", "Response", "Link", "LinksMap", "Schema", "Xml", "SchemaProperties", "DiscriminatorMapping", "Discriminator", "Components", "NamedSchemas", "NamedResponses", "NamedParameters", "NamedExamples", "NamedRequestBodies", "NamedHeaders", "NamedSecuritySchemes", "NamedLinks", "NamedCallbacks", "ImplicitFlow", "PasswordFlow", "ClientCredentials", "AuthorizationCode", "OAuth2Flows", "SecurityScheme", "TagGroup", "TagGroups", "EnumDescriptions", "Logo", "XCodeSample", "XCodeSampleList", "XUsePkce", "WebhooksMap"];

package/lib/types/redocly-yaml.js

@@ -144,12 +144,14 @@ const builtInArazzo1Rules = [
     'no-criteria-xpath',
     'criteria-unique',
 ];
+const builtInOverlay1Rules = ['info-contact'];
 const builtInRules = [
     ...builtInOAS2Rules,
     ...builtInOAS3Rules,
     ...builtInAsync2Rules,
     ...builtInAsync3Rules,
     ...builtInArazzo1Rules,
+    ...builtInOverlay1Rules,
     'spec', // TODO: depricated in favor of struct
     'struct',
 ];
@@ -305,8 +307,6 @@ const createConfigRoot = (nodeTypes) => ({
         apis: 'ConfigApis', // Override apis with internal format
         'features.openapi': 'ConfigReferenceDocs', // deprecated
         'features.mockServer': 'ConfigMockServer', // deprecated
-        organization: { type: 'string' },
-        region: { enum: ['us', 'eu'] },
         telemetry: { enum: ['on', 'off'] },
         resolve: {
             properties: {
@@ -314,12 +314,6 @@ const createConfigRoot = (nodeTypes) => ({
                 doNotResolveExamples: { type: 'boolean' },
             },
         },
-        files: {
-            type: 'array',
-            items: {
-                type: 'string',
-            },
-        },
     },
 });
 const ConfigApis = {
@@ -339,12 +333,6 @@ const createConfigApisProperties = (nodeTypes) => ({
         ...ConfigStyleguide.properties,
         'features.openapi': 'ConfigReferenceDocs', // deprecated
         'features.mockServer': 'ConfigMockServer', // deprecated
-        files: {
-            type: 'array',
-            items: {
-                type: 'string',
-            },
-        },
     },
 });
 const ConfigHTTP = {
@@ -472,7 +460,7 @@ const AssertionDefinitionAssertions = {
     },
     additionalProperties: (_value, key) => {
         if (/^\w+\/\w+$/.test(key))
-            return { type: 'object' };
+            return {};
         return;
     },
 };
@@ -923,7 +911,7 @@ const GenerateCodeSamples = {
 // TODO: deprecated
 const ConfigReferenceDocs = {
     properties: {
-        theme: 'ConfigTheme',
+        theme: 'ConfigTheme', // FIXME: ? theme is deprecated
         corsProxyUrl: { type: 'string' },
         ctrlFHijack: { type: 'boolean' },
         defaultSampleLanguage: { type: 'string' },

package/lib/typings/openapi.d.ts

@@ -303,12 +303,12 @@ export interface Oas3SecurityRequirement {
     [name: string]: string[];
 }
 export interface Oas3SecurityScheme {
-    type: 'apiKey' | 'http' | 'oauth2' | 'openIdConnect';
+    type: 'apiKey' | 'http' | 'oauth2' | 'openIdConnect' | 'mutualTLS';
     description?: string;
     name?: string;
     in?: 'query' | 'header' | 'cookie';
     scheme?: string;
-    bearerFormat: string;
+    bearerFormat?: string;
     flows: {
         implicit?: {
             refreshUrl?: string;