@redocly/openapi-core 1.18.0 → 1.19.0

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

@@ -8,14 +8,16 @@ export type BuiltInOAS2RuleId = typeof builtInOAS2Rules[number];
 declare const builtInOAS3Rules: readonly ["boolean-parameter-prefixes", "component-name-unique", "no-empty-servers", "no-example-value-and-externalValue", "no-invalid-media-type-examples", "no-server-example.com", "no-server-trailing-slash", "no-server-variables-empty-enum", "no-undefined-server-variable", "no-unused-components", "operation-4xx-problem-details-rfc7807", "request-mime-type", "response-contains-property", "response-mime-type", "spec-components-invalid-map-name", "array-parameter-serialization"];
 export type BuiltInOAS3RuleId = typeof builtInOAS3Rules[number];
 declare const builtInAsync2Rules: readonly ["spec", "info-contact", "operation-operationId", "tag-description", "tags-alphabetical", "channels-kebab-case", "no-channel-trailing-slash"];
+declare const builtInAsync3Rules: readonly ["spec", "info-contact", "operation-operationId", "tag-description", "tags-alphabetical", "channels-kebab-case", "no-channel-trailing-slash"];
 export type BuiltInAsync2RuleId = typeof builtInAsync2Rules[number];
+export type BuiltInAsync3RuleId = typeof builtInAsync3Rules[number];
 declare const builtInArazzoRules: readonly ["spec"];
 export type BuiltInArazzoRuleId = typeof builtInArazzoRules[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"];
 export type Oas3NodeType = typeof oas3NodeTypesList[number];
-declare const oas3_1NodeTypesList: readonly ["Root", "Schema", "SchemaProperties", "Info", "License", "Components", "NamedPathItems", "SecurityScheme", "Operation", "DependentRequired"];
+declare const oas3_1NodeTypesList: readonly ["Root", "Schema", "SchemaProperties", "PatternProperties", "Info", "License", "Components", "NamedPathItems", "SecurityScheme", "Operation", "DependentRequired"];
 export type Oas3_1NodeType = typeof oas3_1NodeTypesList[number];
 export declare function createConfigTypes(extraSchemas: JSONSchema, config?: Config): {
     ConfigRoot: NodeType;

package/lib/types/redocly-yaml.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConfigTypes = exports.createConfigTypes = void 0;
+exports.ConfigTypes = void 0;
+exports.createConfigTypes = createConfigTypes;
 const config_1 = require("@redocly/config");
 const _1 = require(".");
 const utils_1 = require("../utils");
@@ -80,12 +81,22 @@ const builtInAsync2Rules = [
     'channels-kebab-case',
     'no-channel-trailing-slash',
 ];
+const builtInAsync3Rules = [
+    'spec',
+    'info-contact',
+    'operation-operationId',
+    'tag-description',
+    'tags-alphabetical',
+    'channels-kebab-case',
+    'no-channel-trailing-slash',
+];
 const builtInArazzoRules = ['spec'];
 const builtInRules = [
     ...builtInCommonOASRules,
     ...builtInOAS2Rules,
     ...builtInOAS3Rules,
     ...builtInAsync2Rules,
+    ...builtInAsync3Rules,
     ...builtInArazzoRules,
 ];
 const oas2NodeTypesList = [
@@ -195,6 +206,7 @@ const oas3_1NodeTypesList = [
     'Root',
     'Schema',
     'SchemaProperties',
+    'PatternProperties',
     'Info',
     'License',
     'Components',
@@ -231,35 +243,56 @@ const ConfigStyleguide = {
         arazzoDecorators: { type: 'object' },
     },
 };
-const createConfigRoot = (nodeTypes) => (Object.assign(Object.assign({}, nodeTypes.rootRedoclyConfigSchema), { properties: Object.assign(Object.assign(Object.assign({}, nodeTypes.rootRedoclyConfigSchema.properties), ConfigStyleguide.properties), { apis: 'ConfigApis', 'features.openapi': 'ConfigReferenceDocs', 'features.mockServer': 'ConfigMockServer', organization: { type: 'string' }, region: { enum: ['us', 'eu'] }, telemetry: { enum: ['on', 'off'] }, resolve: {
+const createConfigRoot = (nodeTypes) => ({
+    ...nodeTypes.rootRedoclyConfigSchema,
+    properties: {
+        ...nodeTypes.rootRedoclyConfigSchema.properties,
+        ...ConfigStyleguide.properties,
+        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: {
                 http: 'ConfigHTTP',
                 doNotResolveExamples: { type: 'boolean' },
             },
-        }, files: {
+        },
+        files: {
             type: 'array',
             items: {
                 type: 'string',
             },
-        } }) }));
+        },
+    },
+});
 const ConfigApis = {
     properties: {},
     additionalProperties: 'ConfigApisProperties',
 };
-const createConfigApisProperties = (nodeTypes) => {
-    var _a;
-    return (Object.assign(Object.assign({}, nodeTypes['rootRedoclyConfigSchema.apis_additionalProperties']), { properties: Object.assign(Object.assign(Object.assign(Object.assign({}, (_a = nodeTypes['rootRedoclyConfigSchema.apis_additionalProperties']) === null || _a === void 0 ? void 0 : _a.properties), { labels: {
-                type: 'array',
-                items: {
-                    type: 'string',
-                },
-            } }), ConfigStyleguide.properties), { 'features.openapi': 'ConfigReferenceDocs', 'features.mockServer': 'ConfigMockServer', files: {
-                type: 'array',
-                items: {
-                    type: 'string',
-                },
-            } }) }));
-};
+const createConfigApisProperties = (nodeTypes) => ({
+    ...nodeTypes['rootRedoclyConfigSchema.apis_additionalProperties'],
+    properties: {
+        ...nodeTypes['rootRedoclyConfigSchema.apis_additionalProperties']?.properties,
+        labels: {
+            type: 'array',
+            items: {
+                type: 'string',
+            },
+        },
+        ...ConfigStyleguide.properties,
+        'features.openapi': 'ConfigReferenceDocs', // deprecated
+        'features.mockServer': 'ConfigMockServer', // deprecated
+        files: {
+            type: 'array',
+            items: {
+                type: 'string',
+            },
+        },
+    },
+});
 const ConfigHTTP = {
     properties: {
         headers: {
@@ -539,7 +572,14 @@ const FontConfig = {
     },
 };
 const ButtonsConfig = {
-    properties: Object.assign(Object.assign({}, (0, utils_1.omitObjectProps)(FontConfig.properties, ['fontSize', 'lineHeight'])), { borderRadius: { type: 'string' }, hoverStyle: { type: 'string' }, boxShadow: { type: 'string' }, hoverBoxShadow: { type: 'string' }, sizes: 'Sizes' }),
+    properties: {
+        ...(0, utils_1.omitObjectProps)(FontConfig.properties, ['fontSize', 'lineHeight']),
+        borderRadius: { type: 'string' },
+        hoverStyle: { type: 'string' },
+        boxShadow: { type: 'string' },
+        hoverBoxShadow: { type: 'string' },
+        sizes: 'Sizes',
+    },
 };
 const BadgeFontConfig = {
     properties: (0, utils_1.pickObjectProps)(FontConfig.properties, ['fontSize', 'lineHeight']),
@@ -551,7 +591,12 @@ const BadgeSizes = {
     },
 };
 const HttpBadgesConfig = {
-    properties: Object.assign(Object.assign({}, (0, utils_1.omitObjectProps)(FontConfig.properties, ['fontSize', 'lineHeight'])), { borderRadius: { type: 'string' }, color: { type: 'string' }, sizes: 'BadgeSizes' }),
+    properties: {
+        ...(0, utils_1.omitObjectProps)(FontConfig.properties, ['fontSize', 'lineHeight']),
+        borderRadius: { type: 'string' },
+        color: { type: 'string' },
+        sizes: 'BadgeSizes',
+    },
 };
 const LabelControls = {
     properties: {
@@ -650,13 +695,38 @@ const SpacingConfig = {
     },
 };
 const Sidebar = {
-    properties: Object.assign(Object.assign({}, (0, utils_1.omitObjectProps)(FontConfig.properties, ['fontWeight', 'lineHeight'])), { activeBgColor: { type: 'string' }, activeTextColor: { type: 'string' }, backgroundColor: { type: 'string' }, borderRadius: { type: 'string' }, breakPath: { type: 'boolean' }, caretColor: { type: 'string' }, caretSize: { type: 'string' }, groupItems: 'GroupItemsConfig', level1items: 'Level1Items', rightLineColor: { type: 'string' }, separatorLabelColor: { type: 'string' }, showAtBreakpoint: { type: 'string' }, spacing: 'SpacingConfig', textColor: { type: 'string' }, width: { type: 'string' } }),
+    properties: {
+        ...(0, utils_1.omitObjectProps)(FontConfig.properties, ['fontWeight', 'lineHeight']),
+        activeBgColor: { type: 'string' },
+        activeTextColor: { type: 'string' },
+        backgroundColor: { type: 'string' },
+        borderRadius: { type: 'string' },
+        breakPath: { type: 'boolean' },
+        caretColor: { type: 'string' },
+        caretSize: { type: 'string' },
+        groupItems: 'GroupItemsConfig',
+        level1items: 'Level1Items',
+        rightLineColor: { type: 'string' },
+        separatorLabelColor: { type: 'string' },
+        showAtBreakpoint: { type: 'string' },
+        spacing: 'SpacingConfig',
+        textColor: { type: 'string' },
+        width: { type: 'string' },
+    },
 };
 const Heading = {
-    properties: Object.assign(Object.assign({}, FontConfig.properties), { color: { type: 'string' }, transform: { type: 'string' } }),
+    properties: {
+        ...FontConfig.properties,
+        color: { type: 'string' },
+        transform: { type: 'string' },
+    },
 };
 const CodeConfig = {
-    properties: Object.assign(Object.assign({}, FontConfig.properties), { backgroundColor: { type: 'string' }, color: { type: 'string' }, wordBreak: {
+    properties: {
+        ...FontConfig.properties,
+        backgroundColor: { type: 'string' },
+        color: { type: 'string' },
+        wordBreak: {
             enum: [
                 'break-all',
                 'break-word',
@@ -667,7 +737,9 @@ const CodeConfig = {
                 'inherit',
                 'initial',
             ],
-        }, wrap: { type: 'boolean' } }),
+        },
+        wrap: { type: 'boolean' },
+    },
 };
 const HeadingsConfig = {
     properties: (0, utils_1.omitObjectProps)(FontConfig.properties, ['fontSize']),
@@ -682,10 +754,29 @@ const LinksConfig = {
     },
 };
 const Typography = {
-    properties: Object.assign(Object.assign({ code: 'CodeConfig', fieldName: 'FontConfig' }, (0, utils_1.pickObjectProps)(FontConfig.properties, ['fontSize', 'fontFamily'])), { fontWeightBold: { type: 'string' }, fontWeightLight: { type: 'string' }, fontWeightRegular: { type: 'string' }, heading1: 'Heading', heading2: 'Heading', heading3: 'Heading', headings: 'HeadingsConfig', lineHeight: { type: 'string' }, links: 'LinksConfig', optimizeSpeed: { type: 'boolean' }, rightPanelHeading: 'Heading', smoothing: { enum: ['auto', 'none', 'antialiased', 'subpixel-antialiased', 'grayscale'] } }),
+    properties: {
+        code: 'CodeConfig',
+        fieldName: 'FontConfig',
+        ...(0, utils_1.pickObjectProps)(FontConfig.properties, ['fontSize', 'fontFamily']),
+        fontWeightBold: { type: 'string' },
+        fontWeightLight: { type: 'string' },
+        fontWeightRegular: { type: 'string' },
+        heading1: 'Heading',
+        heading2: 'Heading',
+        heading3: 'Heading',
+        headings: 'HeadingsConfig',
+        lineHeight: { type: 'string' },
+        links: 'LinksConfig',
+        optimizeSpeed: { type: 'boolean' },
+        rightPanelHeading: 'Heading',
+        smoothing: { enum: ['auto', 'none', 'antialiased', 'subpixel-antialiased', 'grayscale'] },
+    },
 };
 const TokenProps = {
-    properties: Object.assign({ color: { type: 'string' } }, (0, utils_1.omitObjectProps)(FontConfig.properties, ['fontWeight'])),
+    properties: {
+        color: { type: 'string' },
+        ...(0, utils_1.omitObjectProps)(FontConfig.properties, ['fontWeight']),
+    },
 };
 const CodeBlock = {
     properties: {
@@ -754,7 +845,7 @@ const ConfigTheme = {
         sidebar: 'Sidebar',
         spacing: 'ThemeSpacing',
         typography: 'Typography',
-        links: { properties: { color: { type: 'string' } } },
+        links: { properties: { color: { type: 'string' } } }, // deprecated
         codeSample: { properties: { backgroundColor: { type: 'string' } } }, // deprecated
     },
 };
@@ -812,7 +903,7 @@ const ConfigReferenceDocs = {
         maxDisplayedEnumValues: { type: 'number' },
         menuToggle: { type: 'boolean' },
         nativeScrollbars: { type: 'boolean' },
-        noAutoAuth: { type: 'boolean' },
+        noAutoAuth: { type: 'boolean' }, // deprecated
         oAuth2RedirectURI: { type: 'string' },
         onDeepLinkClick: { type: 'object' },
         onlyRequiredInSamples: { type: 'boolean' },
@@ -822,7 +913,7 @@ const ConfigReferenceDocs = {
         requestInterceptor: { type: 'object' },
         requiredPropsFirst: { type: 'boolean' },
         routingBasePath: { type: 'string' },
-        routingStrategy: { type: 'string' },
+        routingStrategy: { type: 'string' }, // deprecated
         samplesTabsMaxCount: { type: 'number' },
         schemaExpansionLevel: (value) => {
             if (typeof value === 'number') {
@@ -851,7 +942,7 @@ const ConfigReferenceDocs = {
         searchTagTitleBoost: { type: 'number' },
         sendXUserAgentInTryIt: { type: 'boolean' },
         showChangeLayoutButton: { type: 'boolean' },
-        showConsole: { type: 'boolean' },
+        showConsole: { type: 'boolean' }, // deprecated
         showExtensions: (value) => {
             if (typeof value === 'boolean') {
                 return { type: 'boolean' };
@@ -878,8 +969,8 @@ const ConfigReferenceDocs = {
         sortOperationsAlphabetically: { type: 'boolean' },
         sortPropsAlphabetically: { type: 'boolean' },
         sortTagsAlphabetically: { type: 'boolean' },
-        suppressWarnings: { type: 'boolean' },
-        unstable_externalDescription: { type: 'boolean' },
+        suppressWarnings: { type: 'boolean' }, // deprecated
+        unstable_externalDescription: { type: 'boolean' }, // deprecated
         unstable_ignoreMimeParameters: { type: 'boolean' },
         untrustedDefinition: { type: 'boolean' },
         mockServer: {
@@ -903,16 +994,21 @@ const ConfigMockServer = {
 };
 function createConfigTypes(extraSchemas, config) {
     const nodeNames = Object.values(oas_types_1.SpecVersion).flatMap((version) => {
-        const types = (config === null || config === void 0 ? void 0 : config.styleguide)
+        const types = config?.styleguide
             ? config.styleguide.extendTypes((0, oas_types_1.getTypes)(version), version)
             : (0, oas_types_1.getTypes)(version);
         return Object.keys(types);
     });
     // Create types based on external schemas
     const nodeTypes = (0, json_schema_adapter_1.getNodeTypesFromJSONSchema)('rootRedoclyConfigSchema', extraSchemas);
-    return Object.assign(Object.assign(Object.assign({}, CoreConfigTypes), { ConfigRoot: createConfigRoot(nodeTypes), ConfigApisProperties: createConfigApisProperties(nodeTypes), AssertionDefinitionSubject: createAssertionDefinitionSubject(nodeNames) }), nodeTypes);
+    return {
+        ...CoreConfigTypes,
+        ConfigRoot: createConfigRoot(nodeTypes), // This is the REAL config root type
+        ConfigApisProperties: createConfigApisProperties(nodeTypes),
+        AssertionDefinitionSubject: createAssertionDefinitionSubject(nodeNames),
+        ...nodeTypes,
+    };
 }
-exports.createConfigTypes = createConfigTypes;
 const CoreConfigTypes = {
     Assert,
     ConfigApis,

package/lib/typings/arazzo.d.ts

@@ -1,3 +1,30 @@
 import type { FromSchema } from 'json-schema-to-ts';
-import type { arazzoSchema } from '../types/arazzo';
+import type { arazzoSchema, parameter, operationMethod, expectSchema, sourceDescriptionSchema, infoObject, requestBody, replacement, inherit, criteriaObject, step, workflow } from '../types/arazzo';
 export type ArazzoDefinition = FromSchema<typeof arazzoSchema>;
+export type OperationMethod = FromSchema<typeof operationMethod>;
+export type ResponseContext = {
+    statusCode: number;
+    body: any;
+    headers: Headers;
+    mimeType: string;
+} & Record<string, any>;
+export type Expect = FromSchema<typeof expectSchema>;
+export type SourceDescription = FromSchema<typeof sourceDescriptionSchema>;
+export type Parameter = FromSchema<typeof parameter>;
+export type InfoObject = FromSchema<typeof infoObject>;
+export type RequestBody = FromSchema<typeof requestBody>;
+export type Replacement = FromSchema<typeof replacement>;
+export type Inherit = FromSchema<typeof inherit>;
+export type CriteriaObject = FromSchema<typeof criteriaObject>;
+export type VerboseLog = {
+    method: OperationMethod;
+    path: string;
+    host: string;
+    body?: any;
+    headerParams?: Record<string, string>;
+    statusCode?: number;
+};
+export type Step = FromSchema<typeof step>;
+export type Workflow = FromSchema<typeof workflow> & {
+    steps: Step[];
+};

package/lib/typings/asyncapi3.d.ts

@@ -0,0 +1,53 @@
+export interface Async3Definition {
+    asyncapi: string;
+    servers?: Record<string, any>;
+    info: Async3Info;
+    channels?: Record<string, Channel>;
+    components?: Record<string, any>;
+    operations?: Record<string, any>;
+    defaultContentType?: string;
+}
+export interface Async3Info {
+    title: string;
+    version: string;
+    description?: string;
+    termsOfService?: string;
+    contact?: Async3Contact;
+    license?: Async3License;
+    tags?: Tag[];
+    externalDocs?: ExternalDoc;
+}
+export interface Async3Contact {
+    name?: string;
+    url?: string;
+    email?: string;
+}
+export interface Async3License {
+    name: string;
+    url?: string;
+}
+export interface Tag {
+    name: string;
+    description?: string;
+    externalDocs?: ExternalDoc;
+}
+export interface ExternalDoc {
+    url: string;
+    description?: string;
+}
+export interface Channel {
+    address?: string | null;
+    messages?: Record<string, any>;
+    title?: string;
+    summary?: string;
+    description?: string;
+    servers?: Record<string, any>[];
+    parameters?: Record<string, any>;
+    tags?: Record<string, any>;
+    externalDocs?: ExternalDocumentation;
+    bindings?: Record<string, any>;
+}
+export interface ExternalDocumentation {
+    url: string;
+    description?: string;
+}

package/lib/typings/asyncapi3.js

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

package/lib/utils.d.ts

@@ -1,6 +1,6 @@
-import { UserContext } from './walk';
-import { HttpResolveConfig } from './config';
 import { HttpsProxyAgent } from 'https-proxy-agent';
+import type { HttpResolveConfig } from './config';
+import type { UserContext } from './walk';
 export { parseYaml, stringifyYaml } from './js-yaml';
 export type StackFrame<T> = {
     prev: StackFrame<T> | null;
@@ -16,9 +16,9 @@ export declare function popStack<T, P extends Stack<T>>(head: P): StackFrame<T>
 export type BundleOutputFormat = 'json' | 'yml' | 'yaml';
 export declare function loadYaml<T>(filename: string): Promise<T>;
 export declare function isDefined<T>(x: T | undefined): x is T;
-export declare function isPlainObject(value: any): value is Record<string, unknown>;
-export declare function isEmptyObject(value: any): value is Record<string, unknown>;
-export declare function isEmptyArray(value: any): boolean;
+export declare function isPlainObject(value: unknown): value is Record<string, unknown>;
+export declare function isEmptyObject(value: unknown): value is Record<string, unknown>;
+export declare function isEmptyArray(value: unknown): boolean;
 export declare function readFileFromUrl(url: string, config: HttpResolveConfig): Promise<{
     body: any;
     mimeType: any;
@@ -28,7 +28,6 @@ export declare function omitObjectProps<T extends Record<string, unknown>>(objec
 export declare function splitCamelCaseIntoWords(str: string): Set<string>;
 export declare function validateMimeType({ type, value }: any, { report, location }: UserContext, allowedValues: string[]): void;
 export declare function validateMimeTypeOAS3({ type, value }: any, { report, location }: UserContext, allowedValues: string[]): void;
-export declare function isSingular(path: string): boolean;
 export declare function readFileAsStringSync(filePath: string): string;
 export declare function yamlAndJsonSyncReader<T>(filePath: string): T;
 export declare function isPathParameter(pathSegment: string): boolean;
@@ -50,6 +49,12 @@ export declare function isTruthy<Truthy>(value: Truthy | Falsy): value is Truthy
 export declare function identity<T>(value: T): T;
 export declare function keysOf<T>(obj: T): (keyof T)[];
 export declare function pickDefined<T extends Record<string, unknown>>(obj?: T): Record<string, unknown> | undefined;
-export declare function nextTick(): void;
+export declare function nextTick(): Promise<unknown>;
 export declare function pause(ms: number): Promise<void>;
 export declare function getProxyAgent(): HttpsProxyAgent<string> | undefined;
+/**
+ * Checks if two objects are deeply equal.
+ * Borrowed the source code from https://github.com/lukeed/dequal.
+ */
+export declare function dequal(foo: any, bar: any): boolean;
+export type CollectFn = (value: unknown) => void;