@redocly/openapi-core 1.9.0 → 1.10.0

package/lib/types/portal-config-schema.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.rootRedoclyConfigSchema = exports.environmentSchema = exports.redoclyConfigSchema = exports.PortalConfigNodeTypes = exports.apiConfigSchema = exports.ssoConfigSchema = void 0;
+exports.rootRedoclyConfigSchema = void 0;
 const config_1 = require("../config");
+const theme_config_1 = require("./theme-config");
 const oidcIssuerMetadataSchema = {
     type: 'object',
     properties: {
@@ -18,10 +19,11 @@ const oidcProviderConfigSchema = {
     properties: {
         type: { type: 'string', const: config_1.AuthProviderType.OIDC },
         title: { type: 'string' },
+        pkce: { type: 'boolean', default: false },
         configurationUrl: { type: 'string', minLength: 1 },
         configuration: oidcIssuerMetadataSchema,
         clientId: { type: 'string', minLength: 1 },
-        clientSecret: { type: 'string', minLength: 1 },
+        clientSecret: { type: 'string', minLength: 0 },
         teamsClaimName: { type: 'string' },
         teamsClaimMap: { type: 'object', additionalProperties: { type: 'string' } },
         defaultTeams: { type: 'array', items: { type: 'string' } },
@@ -31,7 +33,7 @@ const oidcProviderConfigSchema = {
         tokenRequestCustomParams: { type: 'object', additionalProperties: { type: 'string' } },
         audience: { type: 'array', items: { type: 'string' } },
     },
-    required: ['type', 'clientId', 'clientSecret'],
+    required: ['type', 'clientId'],
     oneOf: [{ required: ['configurationUrl'] }, { required: ['configuration'] }],
     additionalProperties: false,
 };
@@ -78,41 +80,58 @@ const authProviderConfigSchema = {
     oneOf: [oidcProviderConfigSchema, saml2ProviderConfigSchema, basicAuthProviderConfigSchema],
     discriminator: { propertyName: 'type' },
 };
-exports.ssoConfigSchema = {
+const ssoOnPremConfigSchema = {
     type: 'object',
-    properties: {},
     additionalProperties: authProviderConfigSchema,
 };
+const ssoConfigSchema = {
+    oneOf: [
+        {
+            type: 'array',
+            items: {
+                type: 'string',
+                enum: ['REDOCLY', 'CORPORATE', 'GUEST'],
+            },
+            uniqueItems: true,
+        },
+        {
+            type: 'string',
+            enum: ['REDOCLY', 'CORPORATE', 'GUEST'],
+        },
+    ],
+};
 const redirectConfigSchema = {
     type: 'object',
     properties: {
         to: { type: 'string' },
         type: { type: 'number', default: 301 },
     },
-    required: ['to'],
+    additionalProperties: false,
 };
 const redirectsConfigSchema = {
     type: 'object',
-    properties: {},
-    additionalProperties: 'redirectConfigSchema',
+    additionalProperties: redirectConfigSchema,
     default: {},
 };
-exports.apiConfigSchema = {
+const apiConfigSchema = {
     type: 'object',
     properties: {
         root: { type: 'string' },
+        output: { type: 'string', pattern: '(.ya?ml|.json)$' },
         rbac: { type: 'object', additionalProperties: true },
         theme: {
             type: 'object',
             properties: {
-                openapi: { type: 'object', additionalProperties: true },
+                openapi: theme_config_1.themeConfigSchema.properties.openapi,
+                graphql: theme_config_1.themeConfigSchema.properties.graphql,
             },
             additionalProperties: false,
         },
         title: { type: 'string' },
         metadata: { type: 'object', additionalProperties: true },
+        rules: { type: 'object', additionalProperties: true },
+        decorators: { type: 'object', additionalProperties: true },
     },
-    additionalProperties: true,
     required: ['root'],
 };
 const metadataConfigSchema = {
@@ -126,7 +145,9 @@ const seoConfigSchema = {
         description: { type: 'string' },
         siteUrl: { type: 'string' },
         image: { type: 'string' },
-        keywords: { type: 'array', items: { type: 'string' } },
+        keywords: {
+            oneOf: [{ type: 'array', items: { type: 'string' } }, { type: 'string' }],
+        },
         lang: { type: 'string' },
         jsonLd: { type: 'object' },
         meta: {
@@ -142,16 +163,20 @@ const seoConfigSchema = {
             },
         },
     },
+    additionalProperties: false,
 };
-const rbacScopeItemsSchema = {
-    type: 'object',
-    properties: {},
-    additionalProperties: { type: 'string' },
-};
+const rbacScopeItemsSchema = { type: 'object', additionalProperties: { type: 'string' } };
 const rbacConfigSchema = {
     type: 'object',
     properties: {
-        defaults: 'rbacScopeItemsSchema',
+        cms: rbacScopeItemsSchema,
+        content: {
+            type: 'object',
+            properties: {
+                '**': rbacScopeItemsSchema,
+            },
+            additionalProperties: rbacScopeItemsSchema,
+        },
     },
     additionalProperties: rbacScopeItemsSchema,
 };
@@ -216,6 +241,7 @@ const devOnboardingAdapterConfigSchema = {
 const devOnboardingConfigSchema = {
     type: 'object',
     required: ['adapters'],
+    additionalProperties: false,
     properties: {
         adapters: {
             type: 'array',
@@ -245,7 +271,8 @@ const i18ConfigSchema = {
             },
         },
     },
-    required: ['defaultLocale', 'locales'],
+    additionalProperties: false,
+    required: ['defaultLocale'],
 };
 const responseHeaderSchema = {
     type: 'object',
@@ -256,24 +283,13 @@ const responseHeaderSchema = {
     additionalProperties: false,
     required: ['name', 'value'],
 };
-exports.PortalConfigNodeTypes = {
-    seoConfigSchema,
-    rbacConfigSchema,
-    rbacScopeItemsSchema,
-    ssoConfigSchema: exports.ssoConfigSchema,
-    devOnboardingConfigSchema,
-    i18ConfigSchema,
-    redirectsConfigSchema,
-    redirectConfigSchema,
-    // TODO: Extract other types that need to be linted in the config
-};
-exports.redoclyConfigSchema = {
+const redoclyConfigSchema = {
     type: 'object',
     properties: {
         licenseKey: { type: 'string' },
-        redirects: 'redirectsConfigSchema',
-        seo: 'seoConfigSchema',
-        rbac: 'rbacConfigSchema',
+        redirects: redirectsConfigSchema,
+        seo: seoConfigSchema,
+        rbac: rbacConfigSchema,
         responseHeaders: {
             type: 'object',
             additionalProperties: {
@@ -293,30 +309,30 @@ exports.redoclyConfigSchema = {
         },
         apis: {
             type: 'object',
-            additionalProperties: exports.apiConfigSchema,
+            additionalProperties: apiConfigSchema,
         },
-        sso: 'ssoConfigSchema',
-        developerOnboarding: 'devOnboardingConfigSchema',
-        i18n: 'i18ConfigSchema',
+        ssoOnPrem: ssoOnPremConfigSchema,
+        sso: ssoConfigSchema,
+        residency: { type: 'string' },
+        developerOnboarding: devOnboardingConfigSchema,
+        i18n: i18ConfigSchema,
         metadata: metadataConfigSchema,
-    },
-    default: {},
-};
-exports.environmentSchema = {
-    oneOf: [
-        Object.assign(Object.assign({}, exports.redoclyConfigSchema), { additionalProperties: false }),
-        {
-            type: 'object',
-            properties: {
-                $ref: { type: 'string' },
+        ignore: {
+            type: 'array',
+            items: {
+                type: 'string',
             },
-            required: ['$ref'],
-            additionalProperties: false,
         },
-    ],
+        theme: theme_config_1.themeConfigSchema,
+    },
+    default: { redirects: {} },
+    additionalProperties: true,
 };
-exports.rootRedoclyConfigSchema = Object.assign(Object.assign({}, exports.redoclyConfigSchema), { properties: Object.assign(Object.assign({}, exports.redoclyConfigSchema.properties), { env: {
+const environmentSchema = Object.assign(Object.assign({}, redoclyConfigSchema), { additionalProperties: false });
+exports.rootRedoclyConfigSchema = Object.assign(Object.assign({}, redoclyConfigSchema), { properties: Object.assign(Object.assign({ plugins: {
+            type: 'array',
+            items: { type: 'string' },
+        } }, redoclyConfigSchema.properties), { env: {
             type: 'object',
-            properties: {},
-            additionalProperties: exports.environmentSchema,
-        } }), default: {}, required: ['redirects'] });
+            additionalProperties: environmentSchema, // TODO: if we want full validation we need to override apis, theme and the root
+        } }), default: {}, additionalProperties: false });

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

@@ -1,4 +1,5 @@
-import { NodeType } from '.';
+import type { NodeType } from '.';
+import type { JSONSchema } from 'json-schema-to-ts';
 declare const builtInCommonRules: readonly ["spec", "info-contact", "operation-operationId", "tag-description", "tags-alphabetical"];
 export type BuiltInCommonRuleId = typeof builtInCommonRules[number];
 declare const builtInCommonOASRules: readonly ["info-license-url", "info-license", "no-ambiguous-paths", "no-enum-type-mismatch", "no-http-verbs-in-paths", "no-identical-paths", "no-invalid-parameter-examples", "no-invalid-schema-examples", "no-path-trailing-slash", "operation-2xx-response", "operation-4xx-response", "operation-description", "operation-operationId-unique", "operation-operationId-url-safe", "operation-parameters-unique", "operation-singular-tag", "operation-summary", "operation-tag-defined", "parameter-description", "path-declaration-must-exist", "path-excludes-patterns", "path-http-verbs-order", "path-not-include-query", "path-params-defined", "path-parameters-defined", "path-segment-plural", "paths-kebab-case", "required-string-property-missing-min-length", "response-contains-header", "scalar-property-missing-example", "security-defined", "spec-strict-refs", "no-unresolved-refs", "no-required-schema-properties-undefined"];
@@ -9,5 +10,16 @@ declare const builtInOAS3Rules: readonly ["boolean-parameter-prefixes", "compone
 export type BuiltInOAS3RuleId = typeof builtInOAS3Rules[number];
 declare const builtInAsync2Rules: readonly ["channels-kebab-case", "no-channel-trailing-slash"];
 export type BuiltInAsync2RuleId = typeof builtInAsync2Rules[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"];
+export type Oas3_1NodeType = typeof oas3_1NodeTypesList[number];
+export declare const createConfigTypes: (extraSchemas: JSONSchema) => {
+    ConfigRoot: NodeType;
+    ConfigApisProperties: NodeType;
+    ConfigRootTheme: NodeType;
+};
 export declare const ConfigTypes: Record<string, NodeType>;
 export {};

package/lib/types/redocly-yaml.js

@@ -1,11 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConfigTypes = void 0;
+exports.ConfigTypes = exports.createConfigTypes = void 0;
 const portal_config_schema_1 = require("./portal-config-schema");
-const theme_config_1 = require("./theme-config");
 const _1 = require(".");
 const utils_1 = require("../utils");
-const portal_config_schema_2 = require("./portal-config-schema");
+const json_schema_adapter_1 = require("./json-schema-adapter");
 const builtInCommonRules = [
     'spec',
     'info-contact',
@@ -81,8 +80,46 @@ const builtInRules = [
     ...builtInOAS3Rules,
     ...builtInAsync2Rules,
 ];
-const nodeTypesList = [
-    'any',
+const oas2NodeTypesList = [
+    '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',
+];
+const oas3NodeTypesList = [
     'Root',
     'Tag',
     'TagList',
@@ -137,12 +174,27 @@ const nodeTypesList = [
     'AuthorizationCode',
     'OAuth2Flows',
     'SecurityScheme',
+    'TagGroup',
+    'TagGroups',
+    'EnumDescriptions',
+    'Logo',
     'XCodeSample',
     'XCodeSampleList',
+    'XUsePkce',
     'WebhooksMap',
-    'SpecExtension',
-    'Message',
 ];
+const oas3_1NodeTypesList = [
+    'Root',
+    'Schema',
+    'SchemaProperties',
+    'Info',
+    'License',
+    'Components',
+    'NamedPathItems',
+    'SecurityScheme',
+    'Operation',
+];
+const asyncNodeTypesList = ['Message'];
 const ConfigStyleguide = {
     properties: {
         extends: {
@@ -168,14 +220,7 @@ const ConfigStyleguide = {
         async2Decorators: { type: 'object' },
     },
 };
-const RootConfigStyleguide = {
-    properties: Object.assign({ plugins: {
-            type: 'array',
-            items: { type: 'string' },
-        } }, ConfigStyleguide.properties),
-};
-const ConfigRoot = {
-    properties: Object.assign(Object.assign(Object.assign({}, portal_config_schema_1.rootRedoclyConfigSchema.properties), RootConfigStyleguide.properties), { apis: 'ConfigApis', theme: 'ConfigRootTheme', 'features.openapi': 'ConfigReferenceDocs', 'features.mockServer': 'ConfigMockServer', organization: { type: 'string' }, region: { enum: ['us', 'eu'] }, telemetry: { enum: ['on', 'off'] }, resolve: {
+const createConfigRoot = (nodeTypes) => (Object.assign(Object.assign({}, nodeTypes.rootRedoclyConfigSchema), { properties: Object.assign(Object.assign(Object.assign({}, nodeTypes.rootRedoclyConfigSchema.properties), ConfigStyleguide.properties), { apis: 'ConfigApis', theme: 'ConfigRootTheme', 'features.openapi': 'ConfigReferenceDocs', 'features.mockServer': 'ConfigMockServer', organization: { type: 'string' }, region: { enum: ['us', 'eu'] }, telemetry: { enum: ['on', 'off'] }, resolve: {
             properties: {
                 http: 'ConfigHTTP',
                 doNotResolveExamples: { type: 'boolean' },
@@ -185,25 +230,24 @@ const ConfigRoot = {
             items: {
                 type: 'string',
             },
-        } }),
-};
+        } }) }));
 const ConfigApis = {
     properties: {},
     additionalProperties: 'ConfigApisProperties',
 };
-const ConfigApisProperties = {
-    properties: Object.assign(Object.assign(Object.assign(Object.assign({}, portal_config_schema_1.apiConfigSchema.properties), { root: { type: 'string' }, labels: {
-            type: 'array',
-            items: {
-                type: 'string',
-            },
-        } }), ConfigStyleguide.properties), { 'features.openapi': 'ConfigReferenceDocs', 'features.mockServer': 'ConfigMockServer', theme: 'ConfigRootTheme', files: {
-            type: 'array',
-            items: {
-                type: 'string',
-            },
-        } }),
-    required: ['root'],
+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 ConfigHTTP = {
     properties: {
@@ -215,8 +259,9 @@ const ConfigHTTP = {
         },
     },
 };
-const ConfigRootTheme = {
-    properties: Object.assign(Object.assign({}, theme_config_1.themeConfigSchema.properties), { openapi: 'ConfigReferenceDocs', mockServer: 'ConfigMockServer' }),
+const createConfigRootTheme = (nodeTypes) => {
+    var _a;
+    return (Object.assign(Object.assign({}, nodeTypes['rootRedoclyConfigSchema.theme']), { properties: Object.assign(Object.assign({}, (_a = nodeTypes['rootRedoclyConfigSchema.theme']) === null || _a === void 0 ? void 0 : _a.properties), { openapi: 'ConfigReferenceDocs' }) }));
 };
 const Rules = {
     properties: {},
@@ -252,7 +297,18 @@ const ObjectRule = {
 };
 const AssertionDefinitionSubject = {
     properties: {
-        type: { enum: nodeTypesList },
+        type: {
+            enum: [
+                ...new Set([
+                    'any',
+                    ...oas2NodeTypesList,
+                    ...oas3NodeTypesList,
+                    ...oas3_1NodeTypesList,
+                    ...asyncNodeTypesList,
+                    'SpecExtension',
+                ]),
+            ],
+        },
         property: (value) => {
             if (Array.isArray(value)) {
                 return { type: 'array', items: { type: 'string' } };
@@ -705,6 +761,7 @@ const GenerateCodeSamples = {
     required: ['languages'],
 };
 const ConfigReferenceDocs = {
+    // TODO: partially invalid @Viacheslav
     properties: {
         theme: 'ConfigTheme',
         corsProxyUrl: { type: 'string' },
@@ -839,11 +896,15 @@ const ConfigMockServer = {
         errorIfForcedExampleNotFound: { type: 'boolean' },
     },
 };
-exports.ConfigTypes = Object.assign({ Assert,
-    ConfigRoot,
+const createConfigTypes = (extraSchemas) => {
+    // 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), ConfigRootTheme: createConfigRootTheme(nodeTypes) }), nodeTypes);
+};
+exports.createConfigTypes = createConfigTypes;
+const CoreConfigTypes = {
+    Assert,
     ConfigApis,
-    ConfigApisProperties,
-    RootConfigStyleguide,
     ConfigStyleguide,
     ConfigReferenceDocs,
     ConfigMockServer,
@@ -853,7 +914,6 @@ exports.ConfigTypes = Object.assign({ Assert,
     ConfigSidebarLinks,
     CommonConfigSidebarLinks,
     ConfigTheme,
-    ConfigRootTheme,
     AssertDefinition,
     ThemeColors,
     CommonThemeColors,
@@ -902,4 +962,6 @@ exports.ConfigTypes = Object.assign({ Assert,
     Heading,
     Typography,
     AssertionDefinitionAssertions,
-    AssertionDefinitionSubject }, portal_config_schema_2.PortalConfigNodeTypes);
+    AssertionDefinitionSubject,
+};
+exports.ConfigTypes = (0, exports.createConfigTypes)(portal_config_schema_1.rootRedoclyConfigSchema);