@redocly/openapi-core 1.0.0-beta.102 → 1.0.0-beta.105

package/lib/types/redocly-yaml.js

@@ -3,13 +3,125 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConfigTypes = void 0;
 const _1 = require(".");
 const utils_1 = require("../utils");
+const builtInRulesList = [
+    'spec',
+    'info-description',
+    'info-contact',
+    'info-license',
+    'info-license-url',
+    'operation-2xx-response',
+    'operation-4xx-response',
+    'assertions',
+    'operation-operationId-unique',
+    'operation-parameters-unique',
+    'path-parameters-defined',
+    'operation-tag-defined',
+    'no-example-value-and-externalValue',
+    'no-enum-type-mismatch',
+    'no-path-trailing-slash',
+    'no-empty-servers',
+    'path-declaration-must-exist',
+    'operation-operationId-url-safe',
+    'operation-operationId',
+    'operation-summary',
+    'tags-alphabetical',
+    'no-server-example.com',
+    'no-server-trailing-slash',
+    'tag-description',
+    'operation-description',
+    'no-unused-components',
+    'path-not-include-query',
+    'path-params-defined',
+    'parameter-description',
+    'operation-singular-tag',
+    'operation-security-defined',
+    'no-unresolved-refs',
+    'paths-kebab-case',
+    'boolean-parameter-prefixes',
+    'path-http-verbs-order',
+    'no-invalid-media-type-examples',
+    'no-identical-paths',
+    'no-ambiguous-paths',
+    'no-undefined-server-variable',
+    'no-servers-empty-enum',
+    'no-http-verbs-in-paths',
+    'path-excludes-patterns',
+    'request-mime-type',
+    'response-mime-type',
+    'path-segment-plural',
+    'no-invalid-schema-examples',
+    'no-invalid-parameter-examples',
+    'response-contains-header',
+    'response-contains-property',
+    'scalar-property-missing-example',
+];
+const nodeTypesList = [
+    'DefinitionRoot',
+    'Tag',
+    'ExternalDocs',
+    'Server',
+    'ServerVariable',
+    'SecurityRequirement',
+    'Info',
+    'Contact',
+    'License',
+    'PathMap',
+    'PathItem',
+    'Parameter',
+    'Operation',
+    'Callback',
+    'RequestBody',
+    'MediaTypeMap',
+    'MediaType',
+    'Example',
+    'Encoding',
+    'Header',
+    'ResponsesMap',
+    'Response',
+    'Link',
+    'Schema',
+    'Xml',
+    'SchemaProperties',
+    'DiscriminatorMapping',
+    'Discriminator',
+    'Components',
+    'NamedSchemas',
+    'NamedResponses',
+    'NamedParameters',
+    'NamedExamples',
+    'NamedRequestBodies',
+    'NamedHeaders',
+    'NamedSecuritySchemes',
+    'NamedLinks',
+    'NamedCallbacks',
+    'ImplicitFlow',
+    'PasswordFlow',
+    'ClientCredentials',
+    'AuthorizationCode',
+    'SecuritySchemeFlows',
+    'SecurityScheme',
+    'XCodeSample',
+    'WebhooksMap',
+];
 const ConfigRoot = {
     properties: {
         organization: { type: 'string' },
         apis: 'ConfigApis',
+        apiDefinitions: {
+            type: 'object',
+            properties: {},
+            additionalProperties: { properties: { type: 'string' } },
+        },
         lint: 'RootConfigLint',
         'features.openapi': 'ConfigReferenceDocs',
+        referenceDocs: 'ConfigReferenceDocs',
         'features.mockServer': 'ConfigMockServer',
+        region: { enum: ['us', 'eu'] },
+        resolve: {
+            properties: {
+                http: 'ConfigHTTP',
+            },
+        },
     },
 };
 const ConfigApis = {
@@ -19,9 +131,17 @@ const ConfigApis = {
 const ConfigApisProperties = {
     properties: {
         root: { type: 'string' },
+        labels: {
+            type: 'array',
+            items: {
+                type: 'string',
+            },
+        },
         lint: 'ConfigLint',
         'features.openapi': 'ConfigReferenceDocs',
+        'features.mockServer': 'ConfigMockServer',
     },
+    required: ['root'],
 };
 const ConfigHTTP = {
     properties: {
@@ -42,10 +162,10 @@ const ConfigLint = {
             },
         },
         doNotResolveExamples: { type: 'boolean' },
-        rules: { type: 'object' },
-        oas2Rules: { type: 'object' },
-        oas3_0Rules: { type: 'object' },
-        oas3_1Rules: { type: 'object' },
+        rules: 'Rules',
+        oas2Rules: 'Rules',
+        oas3_0Rules: 'Rules',
+        oas3_1Rules: 'Rules',
         preprocessors: { type: 'object' },
         oas2Preprocessors: { type: 'object' },
         oas3_0Preprocessors: { type: 'object' },
@@ -54,11 +174,6 @@ const ConfigLint = {
         oas2Decorators: { type: 'object' },
         oas3_0Decorators: { type: 'object' },
         oas3_1Decorators: { type: 'object' },
-        resolve: {
-            properties: {
-                http: 'ConfigHTTP',
-            },
-        },
     },
 };
 const RootConfigLint = {
@@ -67,11 +182,111 @@ const RootConfigLint = {
             items: { type: 'string' },
         } }, ConfigLint.properties),
 };
+const Rules = {
+    properties: {},
+    additionalProperties: (value, key) => {
+        if (key.startsWith('assert/')) {
+            return 'Assert';
+        }
+        else if (builtInRulesList.includes(key) || utils_1.isCustomRuleId(key)) {
+            if (typeof value === 'string') {
+                return { enum: ['error', 'warn', 'off'] };
+            }
+            else {
+                return 'ObjectRule';
+            }
+        }
+        // Otherwise is considered as invalid
+        return;
+    },
+};
+const ObjectRule = {
+    properties: {
+        severity: { enum: ['error', 'warn', 'off'] },
+    },
+    additionalProperties: {},
+    required: ['severity'],
+};
+const Assert = {
+    properties: {
+        subject: (value) => {
+            if (Array.isArray(value)) {
+                return { type: 'array', items: { enum: nodeTypesList } };
+            }
+            else {
+                return { enum: nodeTypesList };
+            }
+        },
+        property: (value) => {
+            if (Array.isArray(value)) {
+                return { type: 'array', items: { type: 'string' } };
+            }
+            else if (value === null) {
+                return null;
+            }
+            else {
+                return { type: 'string' };
+            }
+        },
+        context: _1.listOf('Context'),
+        message: { type: 'string' },
+        suggest: { type: 'array', items: { type: 'string' } },
+        severity: { enum: ['error', 'warn', 'off'] },
+        enum: { type: 'array', items: { type: 'string' } },
+        pattern: { type: 'string' },
+        casing: {
+            enum: [
+                'camelCase',
+                'kebab-case',
+                'snake_case',
+                'PascalCase',
+                'MACRO_CASE',
+                'COBOL-CASE',
+                'flatcase',
+            ],
+        },
+        mutuallyExclusive: { type: 'array', items: { type: 'string' } },
+        mutuallyRequired: { type: 'array', items: { type: 'string' } },
+        required: { type: 'array', items: { type: 'string' } },
+        requireAny: { type: 'array', items: { type: 'string' } },
+        disallowed: { type: 'array', items: { type: 'string' } },
+        defined: { type: 'boolean' },
+        undefined: { type: 'boolean' },
+        nonEmpty: { type: 'boolean' },
+        minLength: { type: 'integer' },
+        maxLength: { type: 'integer' },
+        ref: (value) => typeof value === 'string' ? { type: 'string' } : { type: 'boolean' },
+    },
+    required: ['subject'],
+};
+const Context = {
+    properties: {
+        type: { enum: nodeTypesList },
+        matchParentKeys: { type: 'array', items: { type: 'string' } },
+        excludeParentKeys: { type: 'array', items: { type: 'string' } },
+    },
+    required: ['type'],
+};
 const ConfigLanguage = {
     properties: {
         label: { type: 'string' },
-        lang: { type: 'string' },
+        lang: {
+            enum: [
+                'curl',
+                'C#',
+                'Go',
+                'Java',
+                'Java8+Apache',
+                'JavaScript',
+                'Node.js',
+                'PHP',
+                'Python',
+                'R',
+                'Ruby',
+            ],
+        },
     },
+    required: ['lang'],
 };
 const ConfigLabels = {
     properties: {
@@ -93,11 +308,17 @@ const ConfigLabels = {
 };
 const ConfigSidebarLinks = {
     properties: {
-        placement: { type: 'string' },
+        beforeInfo: _1.listOf('CommonConfigSidebarLinks'),
+        end: _1.listOf('CommonConfigSidebarLinks'),
+    },
+};
+const CommonConfigSidebarLinks = {
+    properties: {
         label: { type: 'string' },
         link: { type: 'string' },
         target: { type: 'string' },
     },
+    required: ['label', 'link'],
 };
 const CommonThemeColors = {
     properties: {
@@ -133,7 +354,7 @@ const HttpColors = {
 };
 const ResponseColors = {
     properties: {
-        errors: 'CommonColorProps',
+        error: 'CommonColorProps',
         info: 'CommonColorProps',
         redirect: 'CommonColorProps',
         success: 'CommonColorProps',
@@ -205,11 +426,14 @@ const HttpBadgesConfig = {
 const LabelControls = {
     properties: {
         top: { type: 'string' },
+        width: { type: 'string' },
+        height: { type: 'string' },
     },
 };
 const Panels = {
     properties: {
         borderRadius: { type: 'string' },
+        backgroundColor: { type: 'string' },
     },
 };
 const TryItButton = {
@@ -242,6 +466,7 @@ const StackedConfig = {
 const ThreePanelConfig = {
     properties: {
         maxWidth: 'Breakpoints',
+        middlePanelMaxWidth: 'Breakpoints',
     },
 };
 const Layout = {
@@ -301,7 +526,18 @@ const Heading = {
     properties: Object.assign(Object.assign({}, FontConfig.properties), { color: { type: 'string' }, transform: { type: 'string' } }),
 };
 const CodeConfig = {
-    properties: Object.assign(Object.assign({}, FontConfig.properties), { backgroundColor: { type: 'string' }, color: { type: 'string' }, wordBreak: { type: 'string' }, wrap: { type: 'boolean' } }),
+    properties: Object.assign(Object.assign({}, FontConfig.properties), { backgroundColor: { type: 'string' }, color: { type: 'string' }, wordBreak: {
+            enum: [
+                'break-all',
+                'break-word',
+                'keep-all',
+                'normal',
+                'revert',
+                'unset',
+                'inherit',
+                'initial',
+            ],
+        }, wrap: { type: 'boolean' } }),
 };
 const HeadingsConfig = {
     properties: utils_1.omitObjectProps(FontConfig.properties, ['fontSize']),
@@ -316,7 +552,7 @@ const LinksConfig = {
     },
 };
 const Typography = {
-    properties: Object.assign(Object.assign({ code: 'CodeConfig', fieldName: 'FontConfig' }, 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: { type: 'string' } }),
+    properties: Object.assign(Object.assign({ code: 'CodeConfig', fieldName: 'FontConfig' }, 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' } }, utils_1.omitObjectProps(FontConfig.properties, ['fontWeight'])),
@@ -335,6 +571,12 @@ const Logo = {
         maxWidth: { type: 'string' },
     },
 };
+const Fab = {
+    properties: {
+        backgroundColor: { type: 'string' },
+        color: { type: 'string' },
+    },
+};
 const ButtonOverrides = {
     properties: {
         custom: { type: 'string' },
@@ -374,6 +616,7 @@ const ConfigTheme = {
         components: 'Components',
         layout: 'Layout',
         logo: 'Logo',
+        fab: 'Fab',
         overrides: 'Overrides',
         rightPanel: 'RightPanel',
         schema: 'Schema',
@@ -382,7 +625,7 @@ const ConfigTheme = {
         spacing: 'ThemeSpacing',
         typography: 'Typography',
         links: { properties: { color: { type: 'string' } } },
-        codeSample: { properties: { backgroundColor: { type: 'string' } } },
+        codeSample: { properties: { backgroundColor: { type: 'string' } } }, // deprecated
     },
 };
 const GenerateCodeSamples = {
@@ -390,6 +633,7 @@ const GenerateCodeSamples = {
         skipOptionalParameters: { type: 'boolean' },
         languages: _1.listOf('ConfigLanguage'),
     },
+    required: ['languages'],
 };
 const ConfigReferenceDocs = {
     properties: {
@@ -415,16 +659,25 @@ const ConfigReferenceDocs = {
         hideLoading: { type: 'boolean' },
         hideLogo: { type: 'boolean' },
         hideRequestPayloadSample: { type: 'boolean' },
+        hideRightPanel: { type: 'boolean' },
         hideSchemaPattern: { type: 'boolean' },
         hideSchemaTitles: { type: 'boolean' },
         hideSingleRequestSampleTab: { type: 'boolean' },
+        hideSecuritySection: { type: 'boolean' },
         hideTryItPanel: { type: 'boolean' },
         hideFab: { type: 'boolean' },
         hideOneOfDescription: { type: 'boolean' },
         htmlTemplate: { type: 'string' },
-        jsonSampleExpandLevel: { type: 'string' },
+        jsonSampleExpandLevel: (value) => {
+            if (typeof value === 'number') {
+                return { type: 'number', minimum: 1 };
+            }
+            else {
+                return { type: 'string' };
+            }
+        },
         labels: 'ConfigLabels',
-        layout: { type: 'string' },
+        layout: { enum: ['stacked', 'three-panel'] },
         maxDisplayedEnumValues: { type: 'number' },
         menuToggle: { type: 'boolean' },
         nativeScrollbars: { type: 'boolean' },
@@ -432,26 +685,55 @@ const ConfigReferenceDocs = {
         oAuth2RedirectURI: { type: 'string' },
         onDeepLinkClick: { type: 'object' },
         onlyRequiredInSamples: { type: 'boolean' },
-        pagination: { type: 'string' },
+        pagination: { enum: ['none', 'section', 'item'] },
         pathInMiddlePanel: { type: 'boolean' },
-        payloadSampleIdx: { type: 'number' },
+        payloadSampleIdx: { type: 'number', minimum: 0 },
         requestInterceptor: { type: 'object' },
         requiredPropsFirst: { type: 'boolean' },
         routingBasePath: { type: 'string' },
+        routingStrategy: { type: 'string' },
         samplesTabsMaxCount: { type: 'number' },
-        schemaExpansionLevel: { type: 'string' },
+        schemaExpansionLevel: (value) => {
+            if (typeof value === 'number') {
+                return { type: 'number', minimum: 0 };
+            }
+            else {
+                return { type: 'string' };
+            }
+        },
         schemaDefinitionsTagName: { type: 'string' },
-        minCharacterLengthToInitSearch: { type: 'number' },
-        maxResponseHeadersToShowInTryIt: { type: 'number' },
-        scrollYOffset: { type: 'string' },
+        minCharacterLengthToInitSearch: { type: 'number', minimum: 1 },
+        maxResponseHeadersToShowInTryIt: { type: 'number', minimum: 0 },
+        scrollYOffset: (value) => {
+            if (typeof value === 'number') {
+                return { type: 'number' };
+            }
+            else {
+                return { type: 'string' };
+            }
+        },
         searchAutoExpand: { type: 'boolean' },
-        searchFieldLevelBoost: { type: 'number' },
-        searchMode: { type: 'string' },
+        searchFieldLevelBoost: { type: 'number', minimum: 0 },
+        searchMaxDepth: { type: 'number', minimum: 1 },
+        searchMode: { enum: ['default', 'path-only'] },
         searchOperationTitleBoost: { type: 'number' },
         searchTagTitleBoost: { type: 'number' },
+        sendXUserAgentInTryIt: { type: 'boolean' },
         showChangeLayoutButton: { type: 'boolean' },
         showConsole: { type: 'boolean' },
-        showExtensions: { type: 'boolean' },
+        showExtensions: (value) => {
+            if (typeof value === 'boolean') {
+                return { type: 'boolean' };
+            }
+            else {
+                return {
+                    type: 'array',
+                    items: {
+                        type: 'string',
+                    },
+                };
+            }
+        },
         showNextButton: { type: 'boolean' },
         showRightPanelToggle: { type: 'boolean' },
         showSecuritySchemeType: { type: 'boolean' },
@@ -459,12 +741,14 @@ const ConfigReferenceDocs = {
         showObjectSchemaExamples: { type: 'boolean' },
         disableTryItRequestUrlEncoding: { type: 'boolean' },
         sidebarLinks: 'ConfigSidebarLinks',
-        sideNavStyle: { type: 'string' },
+        sideNavStyle: { enum: ['summary-only', 'path-first', 'id-only'] },
         simpleOneOfTypeLabel: { type: 'boolean' },
         sortEnumValuesAlphabetically: { type: 'boolean' },
         sortOperationsAlphabetically: { type: 'boolean' },
         sortPropsAlphabetically: { type: 'boolean' },
         sortTagsAlphabetically: { type: 'boolean' },
+        suppressWarnings: { type: 'boolean' },
+        unstable_externalDescription: { type: 'boolean' },
         unstable_ignoreMimeParameters: { type: 'boolean' },
         untrustedDefinition: { type: 'boolean' },
     },
@@ -477,6 +761,7 @@ const ConfigMockServer = {
     },
 };
 exports.ConfigTypes = {
+    Assert,
     ConfigRoot,
     ConfigApis,
     ConfigApisProperties,
@@ -488,7 +773,9 @@ exports.ConfigTypes = {
     ConfigLanguage,
     ConfigLabels,
     ConfigSidebarLinks,
+    CommonConfigSidebarLinks,
     ConfigTheme,
+    Context,
     ThemeColors,
     CommonThemeColors,
     BorderThemeColors,
@@ -519,9 +806,12 @@ exports.ConfigTypes = {
     TokenProps,
     CodeBlock,
     Logo,
+    Fab,
     ButtonOverrides,
     Overrides,
+    ObjectRule,
     RightPanel,
+    Rules,
     Shape,
     ThemeSpacing,
     GenerateCodeSamples,

package/lib/utils.d.ts

@@ -1,5 +1,5 @@
 import { UserContext } from './walk';
-import type { HttpResolveConfig } from './config';
+import { HttpResolveConfig } from './config';
 export { parseYaml, stringifyYaml } from './js-yaml';
 export declare type StackFrame<T> = {
     prev: StackFrame<T> | null;
@@ -13,7 +13,7 @@ export declare function pushStack<T, P extends Stack<T> = Stack<T>>(head: P, val
 };
 export declare function popStack<T, P extends Stack<T>>(head: P): StackFrame<T> | null;
 export declare type BundleOutputFormat = 'json' | 'yml' | 'yaml';
-export declare function loadYaml(filename: string): Promise<unknown>;
+export declare function loadYaml<T>(filename: string): Promise<T>;
 export declare function notUndefined<T>(x: T | undefined): x is T;
 export declare function isPlainObject(value: any): value is object;
 export declare function isEmptyObject(value: any): value is object;
@@ -38,4 +38,6 @@ export declare function isNotEmptyObject(obj: any): boolean;
 export declare function isString(value: unknown): value is string;
 export declare function isNotString<T>(value: string | T): value is T;
 export declare function assignExisting<T>(target: Record<string, T>, obj: Record<string, T>): void;
-export declare const getMatchingStatusCodeRange: (code: number | string) => string;
+export declare function getMatchingStatusCodeRange(code: number | string): string;
+export declare function isCustomRuleId(id: string): boolean;
+export declare function doesYamlFileExist(filePath: string): boolean;

package/lib/utils.js

@@ -9,8 +9,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getMatchingStatusCodeRange = exports.assignExisting = exports.isNotString = exports.isString = exports.isNotEmptyObject = exports.slash = exports.isPathParameter = exports.readFileAsStringSync = exports.isSingular = exports.validateMimeTypeOAS3 = exports.validateMimeType = exports.splitCamelCaseIntoWords = exports.omitObjectProps = exports.pickObjectProps = exports.readFileFromUrl = exports.isEmptyArray = exports.isEmptyObject = exports.isPlainObject = exports.notUndefined = exports.loadYaml = exports.popStack = exports.pushStack = exports.stringifyYaml = exports.parseYaml = void 0;
+exports.doesYamlFileExist = exports.isCustomRuleId = exports.getMatchingStatusCodeRange = exports.assignExisting = exports.isNotString = exports.isString = exports.isNotEmptyObject = exports.slash = exports.isPathParameter = exports.readFileAsStringSync = exports.isSingular = exports.validateMimeTypeOAS3 = exports.validateMimeType = exports.splitCamelCaseIntoWords = exports.omitObjectProps = exports.pickObjectProps = exports.readFileFromUrl = exports.isEmptyArray = exports.isEmptyObject = exports.isPlainObject = exports.notUndefined = exports.loadYaml = exports.popStack = exports.pushStack = exports.stringifyYaml = exports.parseYaml = void 0;
 const fs = require("fs");
+const path_1 = require("path");
 const minimatch = require("minimatch");
 const node_fetch_1 = require("node-fetch");
 const pluralize = require("pluralize");
@@ -173,5 +174,17 @@ function assignExisting(target, obj) {
     }
 }
 exports.assignExisting = assignExisting;
-const getMatchingStatusCodeRange = (code) => `${code}`.replace(/^(\d)\d\d$/, (_, firstDigit) => `${firstDigit}XX`);
+function getMatchingStatusCodeRange(code) {
+    return `${code}`.replace(/^(\d)\d\d$/, (_, firstDigit) => `${firstDigit}XX`);
+}
 exports.getMatchingStatusCodeRange = getMatchingStatusCodeRange;
+function isCustomRuleId(id) {
+    return id.includes('/');
+}
+exports.isCustomRuleId = isCustomRuleId;
+function doesYamlFileExist(filePath) {
+    return ((path_1.extname(filePath) === '.yaml' || path_1.extname(filePath) === '.yml') &&
+        fs.hasOwnProperty('existsSync') &&
+        fs.existsSync(filePath));
+}
+exports.doesYamlFileExist = doesYamlFileExist;

package/lib/walk.d.ts

@@ -14,23 +14,13 @@ export declare type ResolveResult<T extends NonUndefined> = {
     location: undefined;
     error?: ResolveError | YamlParseError;
 };
-export declare type ResolveFn<T> = (node: Referenced<T>, from?: string) => {
-    location: Location;
-    node: T;
-} | {
-    location: undefined;
-    node: undefined;
-};
+export declare type ResolveFn = <T>(node: Referenced<T>, from?: string) => ResolveResult<T>;
 export declare type UserContext = {
     report(problem: Problem): void;
     location: Location;
-    resolve<T>(node: Referenced<T>): {
-        location: Location;
-        node: T;
-    } | {
-        location: undefined;
-        node: undefined;
-    };
+    rawNode: any;
+    rawLocation: Location;
+    resolve: ResolveFn;
     parentLocations: Record<string, Location>;
     type: NormalizedNodeType;
     key: string | number;