@redocly/openapi-core 1.0.0-beta.99 → 1.0.0-rc.2

package/lib/types/redocly-yaml.js

@@ -1,27 +1,184 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConfigTypes = void 0;
+const config_external_schemas_1 = require("./config-external-schemas");
 const _1 = require(".");
 const utils_1 = require("../utils");
-const ConfigRoot = {
+const builtInRulesList = [
+    'spec',
+    'info-contact',
+    'info-license',
+    'info-license-url',
+    'operation-2xx-response',
+    'operation-4xx-response',
+    'operation-4xx-problem-details-rfc7807',
+    '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',
+    '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-server-variables-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',
+    'spec-components-invalid-map-name',
+    'required-string-property-missing-min-length',
+    'spec-strict-refs',
+    'component-name-unique',
+];
+const nodeTypesList = [
+    'any',
+    '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',
+    'XCodeSample',
+    'XCodeSampleList',
+    'WebhooksMap',
+    'SpecExtension',
+];
+const ConfigStyleguide = {
     properties: {
-        organization: { type: 'string' },
-        apis: 'ConfigApis',
-        lint: 'RootConfigLint',
-        'features.openapi': 'ConfigReferenceDocs',
-        'features.mockServer': 'ConfigMockServer',
+        extends: {
+            type: 'array',
+            items: {
+                type: 'string',
+            },
+        },
+        rules: 'Rules',
+        oas2Rules: 'Rules',
+        oas3_0Rules: 'Rules',
+        oas3_1Rules: 'Rules',
+        preprocessors: { type: 'object' },
+        oas2Preprocessors: { type: 'object' },
+        oas3_0Preprocessors: { type: 'object' },
+        oas3_1Preprocessors: { type: 'object' },
+        decorators: { type: 'object' },
+        oas2Decorators: { type: 'object' },
+        oas3_0Decorators: { type: 'object' },
+        oas3_1Decorators: { type: 'object' },
     },
 };
+const RootConfigStyleguide = {
+    properties: Object.assign({ plugins: {
+            type: 'array',
+            items: { type: 'string' },
+        } }, ConfigStyleguide.properties),
+};
+const ConfigRoot = {
+    properties: Object.assign(Object.assign({ organization: { type: 'string' }, apis: 'ConfigApis' }, RootConfigStyleguide.properties), { theme: 'ConfigRootTheme', 'features.openapi': 'ConfigReferenceDocs', 'features.mockServer': 'ConfigMockServer', region: { enum: ['us', 'eu'] }, telemetry: { enum: ['on', 'off'] }, resolve: {
+            properties: {
+                http: 'ConfigHTTP',
+                doNotResolveExamples: { type: 'boolean' },
+            },
+        }, files: {
+            type: 'array',
+            items: {
+                type: 'string',
+            },
+        }, redirects: { type: 'object', additionalProperties: config_external_schemas_1.redirectConfigSchema }, licenseKey: { type: 'string' }, seo: config_external_schemas_1.seoConfigSchema, rbac: config_external_schemas_1.rbacConfigSchema, responseHeaders: config_external_schemas_1.responseHeaderSchema, mockServer: config_external_schemas_1.mockServerConfigSchema, sso: config_external_schemas_1.ssoConfigSchema, developerOnboarding: config_external_schemas_1.devOnboardingConfigSchema, i18n: config_external_schemas_1.i18nConfigSchema }),
+};
 const ConfigApis = {
     properties: {},
     additionalProperties: 'ConfigApisProperties',
 };
 const ConfigApisProperties = {
-    properties: {
-        root: { type: 'string' },
-        lint: 'ConfigLint',
-        'features.openapi': 'ConfigReferenceDocs',
-    },
+    properties: Object.assign(Object.assign({ root: { type: 'string' }, labels: {
+            type: 'array',
+            items: {
+                type: 'string',
+            },
+        }, lint: 'ConfigStyleguide', styleguide: 'ConfigStyleguide' }, ConfigStyleguide.properties), { 'features.openapi': 'ConfigReferenceDocs', 'features.mockServer': 'ConfigMockServer', theme: 'ConfigRootTheme', files: {
+            type: 'array',
+            items: {
+                type: 'string',
+            },
+        }, title: { type: 'string' }, rbac: { type: 'object' }, metadata: { type: 'object' } }),
+    required: ['root'],
 };
 const ConfigHTTP = {
     properties: {
@@ -33,45 +190,144 @@ const ConfigHTTP = {
         },
     },
 };
-const ConfigLint = {
-    properties: {
-        extends: {
-            type: 'array',
-            items: {
-                type: 'string',
-            },
+const ConfigRootTheme = {
+    properties: Object.assign(Object.assign({}, config_external_schemas_1.themeConfigSchema.properties), { openapi: 'ConfigReferenceDocs', mockServer: 'ConfigMockServer' }),
+};
+const Rules = {
+    properties: {},
+    additionalProperties: (value, key) => {
+        if (key.startsWith('rule/')) {
+            return 'Assert';
+        }
+        else if (key.startsWith('assert/')) {
+            // keep the old assert/ prefix as an alias
+            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 AssertionDefinitionSubject = {
+    properties: {
+        type: { enum: nodeTypesList },
+        property: (value) => {
+            if (Array.isArray(value)) {
+                return { type: 'array', items: { type: 'string' } };
+            }
+            else if (value === null) {
+                return null;
+            }
+            else {
+                return { type: 'string' };
+            }
         },
-        doNotResolveExamples: { type: 'boolean' },
-        rules: { type: 'object' },
-        oas2Rules: { type: 'object' },
-        oas3_0Rules: { type: 'object' },
-        oas3_1Rules: { type: 'object' },
-        preprocessors: { type: 'object' },
-        oas2Preprocessors: { type: 'object' },
-        oas3_0Preprocessors: { type: 'object' },
-        oas3_1Preprocessors: { type: 'object' },
-        decorators: { type: 'object' },
-        oas2Decorators: { type: 'object' },
-        oas3_0Decorators: { type: 'object' },
-        oas3_1Decorators: { type: 'object' },
-        resolve: {
-            properties: {
-                http: 'ConfigHTTP',
-            },
+        filterInParentKeys: { type: 'array', items: { type: 'string' } },
+        filterOutParentKeys: { type: 'array', items: { type: 'string' } },
+        matchParentKeys: { type: 'string' },
+    },
+    required: ['type'],
+};
+const AssertionDefinitionAssertions = {
+    properties: {
+        enum: { type: 'array', items: { type: 'string' } },
+        pattern: { type: 'string' },
+        notPattern: { 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' }, // TODO: Remove `undefined` assertion from codebase overall
+        nonEmpty: { type: 'boolean' },
+        minLength: { type: 'integer' },
+        maxLength: { type: 'integer' },
+        ref: (value) => typeof value === 'string' ? { type: 'string' } : { type: 'boolean' },
+        const: (value) => {
+            if (typeof value === 'string') {
+                return { type: 'string' };
+            }
+            if (typeof value === 'number') {
+                return { type: 'number' };
+            }
+            if (typeof value === 'boolean') {
+                return { type: 'boolean' };
+            }
+            else {
+                return;
+            }
+        },
+    },
+    additionalProperties: (_value, key) => {
+        if (/^\w+\/\w+$/.test(key))
+            return { type: 'object' };
+        return;
     },
 };
-const RootConfigLint = {
-    properties: Object.assign({ plugins: {
-            type: 'array',
-            items: { type: 'string' },
-        } }, ConfigLint.properties),
+const AssertDefinition = {
+    properties: {
+        subject: 'AssertionDefinitionSubject',
+        assertions: 'AssertionDefinitionAssertions',
+    },
+    required: ['subject', 'assertions'],
+};
+const Assert = {
+    properties: {
+        subject: 'AssertionDefinitionSubject',
+        assertions: 'AssertionDefinitionAssertions',
+        where: _1.listOf('AssertDefinition'),
+        message: { type: 'string' },
+        suggest: { type: 'array', items: { type: 'string' } },
+        severity: { enum: ['error', 'warn', 'off'] },
+    },
+    required: ['subject', 'assertions'],
 };
 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 +349,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 +395,7 @@ const HttpColors = {
 };
 const ResponseColors = {
     properties: {
-        errors: 'CommonColorProps',
+        error: 'CommonColorProps',
         info: 'CommonColorProps',
         redirect: 'CommonColorProps',
         success: 'CommonColorProps',
@@ -205,11 +467,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 +507,7 @@ const StackedConfig = {
 const ThreePanelConfig = {
     properties: {
         maxWidth: 'Breakpoints',
+        middlePanelMaxWidth: 'Breakpoints',
     },
 };
 const Layout = {
@@ -301,7 +567,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 +593,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 +612,12 @@ const Logo = {
         maxWidth: { type: 'string' },
     },
 };
+const Fab = {
+    properties: {
+        backgroundColor: { type: 'string' },
+        color: { type: 'string' },
+    },
+};
 const ButtonOverrides = {
     properties: {
         custom: { type: 'string' },
@@ -374,6 +657,7 @@ const ConfigTheme = {
         components: 'Components',
         layout: 'Layout',
         logo: 'Logo',
+        fab: 'Fab',
         overrides: 'Overrides',
         rightPanel: 'RightPanel',
         schema: 'Schema',
@@ -382,7 +666,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 +674,7 @@ const GenerateCodeSamples = {
         skipOptionalParameters: { type: 'boolean' },
         languages: _1.listOf('ConfigLanguage'),
     },
+    required: ['languages'],
 };
 const ConfigReferenceDocs = {
     properties: {
@@ -415,16 +700,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,39 +726,82 @@ 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' },
         showWebhookVerb: { type: 'boolean' },
         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' },
+        mockServer: {
+            properties: {
+                url: { type: 'string' },
+                position: { enum: ['first', 'last', 'replace', 'off'] },
+                description: { type: 'string' },
+            },
+        },
+        showAccessMode: { type: 'boolean' },
+        preserveOriginalExtensionsName: { type: 'boolean' },
+        markdownHeadingsAnchorLevel: { type: 'number' },
     },
     additionalProperties: { type: 'string' },
 };
@@ -475,18 +812,22 @@ const ConfigMockServer = {
     },
 };
 exports.ConfigTypes = {
+    Assert,
     ConfigRoot,
     ConfigApis,
     ConfigApisProperties,
-    RootConfigLint,
-    ConfigLint,
+    RootConfigStyleguide,
+    ConfigStyleguide,
     ConfigReferenceDocs,
     ConfigMockServer,
     ConfigHTTP,
     ConfigLanguage,
     ConfigLabels,
     ConfigSidebarLinks,
+    CommonConfigSidebarLinks,
     ConfigTheme,
+    ConfigRootTheme,
+    AssertDefinition,
     ThemeColors,
     CommonThemeColors,
     BorderThemeColors,
@@ -517,9 +858,12 @@ exports.ConfigTypes = {
     TokenProps,
     CodeBlock,
     Logo,
+    Fab,
     ButtonOverrides,
     Overrides,
+    ObjectRule,
     RightPanel,
+    Rules,
     Shape,
     ThemeSpacing,
     GenerateCodeSamples,
@@ -530,4 +874,6 @@ exports.ConfigTypes = {
     Sidebar,
     Heading,
     Typography,
+    AssertionDefinitionAssertions,
+    AssertionDefinitionSubject,
 };