@redocly/openapi-core 1.9.0 → 1.9.1

package/src/types/portal-config-schema.ts

@@ -3,8 +3,10 @@ import {
   AuthProviderType,
   DEFAULT_TEAM_CLAIM_NAME,
 } from '../config';
+import { themeConfigSchema } from './theme-config';
 
-import type { NodeType } from '.';
+import type { FromSchema } from 'json-schema-to-ts';
+import type { ThemeConfig } from './theme-config';
 
 const oidcIssuerMetadataSchema = {
   type: 'object',
@@ -23,10 +25,11 @@ const oidcProviderConfigSchema = {
   properties: {
     type: { type: 'string', const: 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' } },
@@ -36,7 +39,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,
 } as const;
@@ -87,11 +90,27 @@ const authProviderConfigSchema = {
   discriminator: { propertyName: 'type' },
 } as const;
 
-export const ssoConfigSchema = {
+const ssoOnPremConfigSchema = {
   type: 'object',
-  properties: {},
   additionalProperties: authProviderConfigSchema,
-} as NodeType;
+} as const;
+
+const ssoConfigSchema = {
+  oneOf: [
+    {
+      type: 'array',
+      items: {
+        type: 'string',
+        enum: ['REDOCLY', 'CORPORATE', 'GUEST'],
+      },
+      uniqueItems: true,
+    },
+    {
+      type: 'string',
+      enum: ['REDOCLY', 'CORPORATE', 'GUEST'],
+    },
+  ],
+} as const;
 
 const redirectConfigSchema = {
   type: 'object',
@@ -99,32 +118,34 @@ const redirectConfigSchema = {
     to: { type: 'string' },
     type: { type: 'number', default: 301 },
   },
-  required: ['to'],
-} as NodeType;
+  additionalProperties: false,
+} as const;
 
 const redirectsConfigSchema = {
   type: 'object',
-  properties: {},
-  additionalProperties: 'redirectConfigSchema',
+  additionalProperties: redirectConfigSchema,
   default: {},
-} as NodeType;
+} as const;
 
-export const 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: themeConfigSchema.properties.openapi,
+        graphql: 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'],
 } as const;
 
@@ -140,7 +161,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: {
@@ -156,21 +179,25 @@ const seoConfigSchema = {
       },
     },
   },
+  additionalProperties: false,
 } as const;
 
-const rbacScopeItemsSchema = {
-  type: 'object',
-  properties: {},
-  additionalProperties: { type: 'string' },
-} as NodeType;
+const rbacScopeItemsSchema = { type: 'object', additionalProperties: { type: 'string' } } as const;
 
 const rbacConfigSchema = {
   type: 'object',
   properties: {
-    defaults: 'rbacScopeItemsSchema',
+    cms: rbacScopeItemsSchema,
+    content: {
+      type: 'object',
+      properties: {
+        '**': rbacScopeItemsSchema,
+      },
+      additionalProperties: rbacScopeItemsSchema,
+    },
   },
   additionalProperties: rbacScopeItemsSchema,
-} as NodeType;
+} as const;
 
 const graviteeAdapterConfigSchema = {
   type: 'object',
@@ -246,13 +273,14 @@ const devOnboardingAdapterConfigSchema = {
 const devOnboardingConfigSchema = {
   type: 'object',
   required: ['adapters'],
+  additionalProperties: false,
   properties: {
     adapters: {
       type: 'array',
       items: devOnboardingAdapterConfigSchema,
     },
   },
-} as NodeType;
+} as const;
 
 const i18ConfigSchema = {
   type: 'object',
@@ -276,8 +304,9 @@ const i18ConfigSchema = {
       },
     },
   },
-  required: ['defaultLocale', 'locales'],
-} as NodeType;
+  additionalProperties: false,
+  required: ['defaultLocale'],
+} as const;
 
 const responseHeaderSchema = {
   type: 'object',
@@ -289,25 +318,13 @@ const responseHeaderSchema = {
   required: ['name', 'value'],
 } as const;
 
-export const PortalConfigNodeTypes: Record<string, NodeType> = {
-  seoConfigSchema,
-  rbacConfigSchema,
-  rbacScopeItemsSchema,
-  ssoConfigSchema,
-  devOnboardingConfigSchema,
-  i18ConfigSchema,
-  redirectsConfigSchema,
-  redirectConfigSchema,
-  // TODO: Extract other types that need to be linted in the config
-};
-
-export const 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: {
@@ -329,38 +346,71 @@ export const redoclyConfigSchema = {
       type: 'object',
       additionalProperties: apiConfigSchema,
     },
-    sso: 'ssoConfigSchema',
-    developerOnboarding: 'devOnboardingConfigSchema',
-    i18n: 'i18ConfigSchema',
+    ssoOnPrem: ssoOnPremConfigSchema,
+    sso: ssoConfigSchema,
+    residency: { type: 'string' },
+    developerOnboarding: devOnboardingConfigSchema,
+    i18n: i18ConfigSchema,
     metadata: metadataConfigSchema,
-  },
-  default: {},
-} as NodeType;
-
-export const environmentSchema = {
-  oneOf: [
-    { ...redoclyConfigSchema, additionalProperties: false },
-    {
-      type: 'object',
-      properties: {
-        $ref: { type: 'string' },
+    ignore: {
+      type: 'array',
+      items: {
+        type: 'string',
       },
-      required: ['$ref'],
-      additionalProperties: false,
     },
-  ],
+    theme: themeConfigSchema,
+  },
+  default: { redirects: {} },
+  additionalProperties: true,
+} as const;
+
+const environmentSchema = {
+  ...redoclyConfigSchema,
+  additionalProperties: false,
 } as const;
 
 export const rootRedoclyConfigSchema = {
   ...redoclyConfigSchema,
   properties: {
+    plugins: {
+      type: 'array',
+      items: { type: 'string' },
+    },
     ...redoclyConfigSchema.properties,
     env: {
       type: 'object',
-      properties: {},
-      additionalProperties: environmentSchema,
+      additionalProperties: environmentSchema, // TODO: if we want full validation we need to override apis, theme and the root
     },
   },
   default: {},
-  required: ['redirects'],
+  additionalProperties: false,
 } as const;
+
+export type RedoclyConfig<T = ThemeConfig> = FromSchema<typeof rootRedoclyConfigSchema> & {
+  theme?: T;
+};
+export type RedirectConfig = FromSchema<typeof redirectConfigSchema>;
+export type RedirectsConfig = FromSchema<typeof redirectsConfigSchema>;
+
+export type AuthProviderConfig = FromSchema<typeof authProviderConfigSchema>;
+export type BasicAuthProviderConfig = FromSchema<typeof basicAuthProviderConfigSchema>;
+export type OidcProviderConfig = FromSchema<typeof oidcProviderConfigSchema>;
+export type Saml2ProviderConfig = FromSchema<typeof saml2ProviderConfigSchema>;
+export type SeoConfig = FromSchema<typeof seoConfigSchema>;
+export type RbacConfig = FromSchema<typeof rbacConfigSchema>;
+export type RbacScopeItems = FromSchema<typeof rbacScopeItemsSchema>;
+export type OidcIssuerMetadata = FromSchema<typeof oidcIssuerMetadataSchema>;
+
+export type DevOnboardingAdapterConfig = FromSchema<typeof devOnboardingAdapterConfigSchema>;
+export type GraviteeAdapterConfig = FromSchema<typeof graviteeAdapterConfigSchema>;
+export type ApigeeAdapterConfig = FromSchema<
+  typeof apigeeXAdapterConfigSchema | typeof apigeeEdgeAdapterConfigSchema
+>;
+export type ApigeeAdapterAuthOauth2 = FromSchema<typeof apigeeAdapterAuthOauth2Schema>;
+export type ApigeeAdapterAuthServiceAccount = FromSchema<
+  typeof apigeeAdapterAuthServiceAccountSchema
+>;
+export type SsoConfig = FromSchema<typeof ssoOnPremConfigSchema>;
+export type I18nConfig = FromSchema<typeof i18ConfigSchema>;
+
+export type ApiConfig = FromSchema<typeof apiConfigSchema>;

package/src/types/redocly-yaml.ts

@@ -1,8 +1,10 @@
-import { rootRedoclyConfigSchema, apiConfigSchema } from './portal-config-schema';
-import { themeConfigSchema } from './theme-config';
-import { NodeType, listOf } from '.';
+import { rootRedoclyConfigSchema } from './portal-config-schema';
+import { listOf } from '.';
 import { omitObjectProps, pickObjectProps, isCustomRuleId } from '../utils';
-import { PortalConfigNodeTypes } from './portal-config-schema';
+import { getNodeTypesFromJSONSchema } from './json-schema-adapter';
+
+import type { NodeType } from '.';
+import type { JSONSchema } from 'json-schema-to-ts';
 
 const builtInCommonRules = [
   'spec',
@@ -97,8 +99,49 @@ const builtInRules = [
 
 type BuiltInRuleId = typeof builtInRules[number];
 
-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',
+] as const;
+
+export type Oas2NodeType = typeof oas2NodeTypesList[number];
+
+const oas3NodeTypesList = [
   'Root',
   'Tag',
   'TagList',
@@ -153,12 +196,33 @@ const nodeTypesList = [
   'AuthorizationCode',
   'OAuth2Flows',
   'SecurityScheme',
+  'TagGroup',
+  'TagGroups',
+  'EnumDescriptions',
+  'Logo',
   'XCodeSample',
   'XCodeSampleList',
+  'XUsePkce',
   'WebhooksMap',
-  'SpecExtension',
-  'Message',
-];
+] as const;
+
+export type Oas3NodeType = typeof oas3NodeTypesList[number];
+
+const oas3_1NodeTypesList = [
+  'Root',
+  'Schema',
+  'SchemaProperties',
+  'Info',
+  'License',
+  'Components',
+  'NamedPathItems',
+  'SecurityScheme',
+  'Operation',
+] as const;
+
+export type Oas3_1NodeType = typeof oas3_1NodeTypesList[number];
+
+const asyncNodeTypesList = ['Message'] as const;
 
 const ConfigStyleguide: NodeType = {
   properties: {
@@ -186,22 +250,13 @@ const ConfigStyleguide: NodeType = {
   },
 };
 
-const RootConfigStyleguide: NodeType = {
+const createConfigRoot = (nodeTypes: Record<string, NodeType>): NodeType => ({
+  ...nodeTypes.rootRedoclyConfigSchema,
   properties: {
-    plugins: {
-      type: 'array',
-      items: { type: 'string' },
-    },
+    ...nodeTypes.rootRedoclyConfigSchema.properties,
     ...ConfigStyleguide.properties,
-  },
-};
-
-const ConfigRoot: NodeType = {
-  properties: {
-    ...rootRedoclyConfigSchema.properties,
-    ...RootConfigStyleguide.properties,
-    apis: 'ConfigApis',
-    theme: 'ConfigRootTheme',
+    apis: 'ConfigApis', // Override apis with internal format
+    theme: 'ConfigRootTheme', // Override theme with internal format
     'features.openapi': 'ConfigReferenceDocs', // deprecated
     'features.mockServer': 'ConfigMockServer', // deprecated
     organization: { type: 'string' },
@@ -220,17 +275,17 @@ const ConfigRoot: NodeType = {
       },
     },
   },
-};
+});
 
 const ConfigApis: NodeType = {
   properties: {},
   additionalProperties: 'ConfigApisProperties',
 };
 
-const ConfigApisProperties: NodeType = {
+const createConfigApisProperties = (nodeTypes: Record<string, NodeType>): NodeType => ({
+  ...nodeTypes['rootRedoclyConfigSchema.apis_additionalProperties'],
   properties: {
-    ...apiConfigSchema.properties,
-    root: { type: 'string' },
+    ...nodeTypes['rootRedoclyConfigSchema.apis_additionalProperties']?.properties,
     labels: {
       type: 'array',
       items: {
@@ -240,7 +295,6 @@ const ConfigApisProperties: NodeType = {
     ...ConfigStyleguide.properties,
     'features.openapi': 'ConfigReferenceDocs', // deprecated
     'features.mockServer': 'ConfigMockServer', // deprecated
-    theme: 'ConfigRootTheme',
     files: {
       type: 'array',
       items: {
@@ -248,8 +302,7 @@ const ConfigApisProperties: NodeType = {
       },
     },
   },
-  required: ['root'],
-};
+});
 
 const ConfigHTTP: NodeType = {
   properties: {
@@ -262,13 +315,13 @@ const ConfigHTTP: NodeType = {
   },
 };
 
-const ConfigRootTheme: NodeType = {
+const createConfigRootTheme = (nodeTypes: Record<string, NodeType>): NodeType => ({
+  ...nodeTypes['rootRedoclyConfigSchema.theme'],
   properties: {
-    ...themeConfigSchema.properties,
-    openapi: 'ConfigReferenceDocs',
-    mockServer: 'ConfigMockServer',
+    ...nodeTypes['rootRedoclyConfigSchema.theme']?.properties,
+    openapi: 'ConfigReferenceDocs', // Override theme.openapi with internal format
   },
-};
+});
 
 const Rules: NodeType = {
   properties: {},
@@ -302,7 +355,18 @@ const ObjectRule: NodeType = {
 
 const AssertionDefinitionSubject: NodeType = {
   properties: {
-    type: { enum: nodeTypesList },
+    type: {
+      enum: [
+        ...new Set([
+          'any',
+          ...oas2NodeTypesList,
+          ...oas3NodeTypesList,
+          ...oas3_1NodeTypesList,
+          ...asyncNodeTypesList,
+          'SpecExtension',
+        ]),
+      ],
+    },
     property: (value: unknown) => {
       if (Array.isArray(value)) {
         return { type: 'array', items: { type: 'string' } };
@@ -863,8 +927,9 @@ const GenerateCodeSamples: NodeType = {
 };
 
 const ConfigReferenceDocs: NodeType = {
+  // TODO: partially invalid @Viacheslav
   properties: {
-    theme: 'ConfigTheme',
+    theme: 'ConfigTheme', // TODO: deprecated @Viacheslav
     corsProxyUrl: { type: 'string' },
     ctrlFHijack: { type: 'boolean' },
     defaultSampleLanguage: { type: 'string' },
@@ -995,12 +1060,22 @@ const ConfigMockServer: NodeType = {
   },
 };
 
-export const ConfigTypes: Record<string, NodeType> = {
+export const createConfigTypes = (extraSchemas: JSONSchema) => {
+  // Create types based on external schemas
+  const nodeTypes = getNodeTypesFromJSONSchema('rootRedoclyConfigSchema', extraSchemas);
+
+  return {
+    ...CoreConfigTypes,
+    ConfigRoot: createConfigRoot(nodeTypes),
+    ConfigApisProperties: createConfigApisProperties(nodeTypes),
+    ConfigRootTheme: createConfigRootTheme(nodeTypes),
+    ...nodeTypes,
+  };
+};
+
+const CoreConfigTypes: Record<string, NodeType> = {
   Assert,
-  ConfigRoot,
   ConfigApis,
-  ConfigApisProperties,
-  RootConfigStyleguide,
   ConfigStyleguide,
   ConfigReferenceDocs,
   ConfigMockServer,
@@ -1010,7 +1085,6 @@ export const ConfigTypes: Record<string, NodeType> = {
   ConfigSidebarLinks,
   CommonConfigSidebarLinks,
   ConfigTheme,
-  ConfigRootTheme,
   AssertDefinition,
   ThemeColors,
   CommonThemeColors,
@@ -1060,5 +1134,6 @@ export const ConfigTypes: Record<string, NodeType> = {
   Typography,
   AssertionDefinitionAssertions,
   AssertionDefinitionSubject,
-  ...PortalConfigNodeTypes,
 };
+
+export const ConfigTypes: Record<string, NodeType> = createConfigTypes(rootRedoclyConfigSchema);