@redocly/openapi-core 1.0.2 → 1.2.0

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

@@ -0,0 +1,304 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.rootRedoclyConfigSchema = exports.environmentSchema = exports.redoclyConfigSchema = exports.apiConfigSchema = exports.ssoConfigSchema = void 0;
+const config_1 = require("../config");
+const oidcIssuerMetadataSchema = {
+    type: 'object',
+    properties: {
+        end_session_endpoint: { type: 'string' },
+        token_endpoint: { type: 'string' },
+        authorization_endpoint: { type: 'string' },
+        jwks_uri: { type: 'string' },
+    },
+    required: ['token_endpoint', 'authorization_endpoint'],
+    additionalProperties: true,
+};
+const oidcProviderConfigSchema = {
+    type: 'object',
+    properties: {
+        type: { type: 'string', const: config_1.AuthProviderType.OIDC },
+        title: { type: 'string' },
+        configurationUrl: { type: 'string', minLength: 1 },
+        configuration: oidcIssuerMetadataSchema,
+        clientId: { type: 'string', minLength: 1 },
+        clientSecret: { type: 'string', minLength: 1 },
+        teamsClaimName: { type: 'string' },
+        teamsClaimMap: { type: 'object', additionalProperties: { type: 'string' } },
+        defaultTeams: { type: 'array', items: { type: 'string' } },
+        scopes: { type: 'array', items: { type: 'string' } },
+        tokenExpirationTime: { type: 'number' },
+        authorizationRequestCustomParams: { type: 'object', additionalProperties: { type: 'string' } },
+        tokenRequestCustomParams: { type: 'object', additionalProperties: { type: 'string' } },
+        audience: { type: 'array', items: { type: 'string' } },
+    },
+    required: ['type', 'clientId', 'clientSecret'],
+    oneOf: [{ required: ['configurationUrl'] }, { required: ['configuration'] }],
+    additionalProperties: false,
+};
+const saml2ProviderConfigSchema = {
+    type: 'object',
+    properties: {
+        type: { type: 'string', const: config_1.AuthProviderType.SAML2 },
+        title: { type: 'string' },
+        issuerId: { type: 'string' },
+        entityId: { type: 'string' },
+        ssoUrl: { type: 'string' },
+        x509PublicCert: { type: 'string' },
+        teamsAttributeName: { type: 'string', default: config_1.DEFAULT_TEAM_CLAIM_NAME },
+        teamsAttributeMap: { type: 'object', additionalProperties: { type: 'string' } },
+        defaultTeams: { type: 'array', items: { type: 'string' } },
+    },
+    additionalProperties: false,
+    required: ['type', 'issuerId', 'ssoUrl', 'x509PublicCert'],
+};
+const basicAuthProviderConfigSchema = {
+    type: 'object',
+    properties: {
+        type: { type: 'string', const: config_1.AuthProviderType.BASIC },
+        title: { type: 'string' },
+        credentials: {
+            type: 'array',
+            items: {
+                type: 'object',
+                properties: {
+                    username: { type: 'string' },
+                    password: { type: 'string' },
+                    passwordHash: { type: 'string' },
+                    teams: { type: 'array', items: { type: 'string' } },
+                },
+                required: ['username'],
+                additionalProperties: false,
+            },
+        },
+    },
+    required: ['type', 'credentials'],
+    additionalProperties: false,
+};
+const authProviderConfigSchema = {
+    oneOf: [oidcProviderConfigSchema, saml2ProviderConfigSchema, basicAuthProviderConfigSchema],
+    discriminator: { propertyName: 'type' },
+};
+exports.ssoConfigSchema = {
+    type: 'object',
+    additionalProperties: authProviderConfigSchema,
+};
+const redirectConfigSchema = {
+    type: 'object',
+    properties: {
+        to: { type: 'string' },
+        type: { type: 'number', default: 301 },
+    },
+    required: ['to'],
+    additionalProperties: false,
+};
+exports.apiConfigSchema = {
+    type: 'object',
+    properties: {
+        root: { type: 'string' },
+        rbac: { type: 'object', additionalProperties: true },
+        theme: {
+            type: 'object',
+            properties: {
+                openapi: { type: 'object', additionalProperties: true },
+            },
+            additionalProperties: false,
+        },
+        title: { type: 'string' },
+        metadata: { type: 'object', additionalProperties: true },
+    },
+    additionalProperties: true,
+    required: ['root'],
+};
+const metadataConfigSchema = {
+    type: 'object',
+    additionalProperties: true,
+};
+const seoConfigSchema = {
+    type: 'object',
+    properties: {
+        title: { type: 'string' },
+        description: { type: 'string' },
+        siteUrl: { type: 'string' },
+        image: { type: 'string' },
+        keywords: { type: 'array', items: { type: 'string' } },
+        lang: { type: 'string' },
+        jsonLd: { type: 'object' },
+        meta: {
+            type: 'array',
+            items: {
+                type: 'object',
+                properties: {
+                    name: { type: 'string' },
+                    content: { type: 'string' },
+                },
+                required: ['name', 'content'],
+                additionalProperties: false,
+            },
+        },
+    },
+    additionalProperties: false,
+};
+const rbacScopeItemsSchema = { type: 'object', additionalProperties: { type: 'string' } };
+const rbacConfigSchema = {
+    type: 'object',
+    properties: {
+        defaults: rbacScopeItemsSchema,
+    },
+    additionalProperties: rbacScopeItemsSchema,
+};
+const graviteeAdapterConfigSchema = {
+    type: 'object',
+    properties: {
+        type: { type: 'string', const: 'GRAVITEE' },
+        apiBaseUrl: { type: 'string' },
+        env: { type: 'string' },
+        allowApiProductsOutsideCatalog: { type: 'boolean', default: false },
+        stage: { type: 'string', default: 'non-production' },
+        auth: { type: 'object', properties: { static: { type: 'string' } } },
+    },
+    additionalProperties: false,
+    required: ['type', 'apiBaseUrl'],
+};
+const apigeeAdapterAuthOauth2Schema = {
+    type: 'object',
+    properties: {
+        type: { type: 'string', const: config_1.ApigeeDevOnboardingIntegrationAuthType.OAUTH2 },
+        tokenEndpoint: { type: 'string' },
+        clientId: { type: 'string' },
+        clientSecret: { type: 'string' },
+    },
+    additionalProperties: false,
+    required: ['type', 'tokenEndpoint', 'clientId', 'clientSecret'],
+};
+const apigeeAdapterAuthServiceAccountSchema = {
+    type: 'object',
+    properties: {
+        type: { type: 'string', const: config_1.ApigeeDevOnboardingIntegrationAuthType.SERVICE_ACCOUNT },
+        serviceAccountEmail: { type: 'string' },
+        serviceAccountPrivateKey: { type: 'string' },
+    },
+    additionalProperties: false,
+    required: ['type', 'serviceAccountEmail', 'serviceAccountPrivateKey'],
+};
+const apigeeXAdapterConfigSchema = {
+    type: 'object',
+    properties: {
+        type: { type: 'string', const: 'APIGEE_X' },
+        apiUrl: { type: 'string' },
+        stage: { type: 'string', default: 'non-production' },
+        organizationName: { type: 'string' },
+        ignoreApiProducts: { type: 'array', items: { type: 'string' } },
+        allowApiProductsOutsideCatalog: { type: 'boolean', default: false },
+        auth: {
+            type: 'object',
+            oneOf: [apigeeAdapterAuthOauth2Schema, apigeeAdapterAuthServiceAccountSchema],
+            discriminator: { propertyName: 'type' },
+        },
+    },
+    additionalProperties: false,
+    required: ['type', 'organizationName', 'auth'],
+};
+const apigeeEdgeAdapterConfigSchema = Object.assign(Object.assign({}, apigeeXAdapterConfigSchema), { properties: Object.assign(Object.assign({}, apigeeXAdapterConfigSchema.properties), { type: { type: 'string', const: 'APIGEE_EDGE' } }) });
+const devOnboardingAdapterConfigSchema = {
+    type: 'object',
+    oneOf: [apigeeXAdapterConfigSchema, apigeeEdgeAdapterConfigSchema, graviteeAdapterConfigSchema],
+    discriminator: { propertyName: 'type' },
+};
+const devOnboardingConfigSchema = {
+    type: 'object',
+    required: ['adapters'],
+    additionalProperties: false,
+    properties: {
+        adapters: {
+            type: 'array',
+            items: devOnboardingAdapterConfigSchema,
+        },
+    },
+};
+const responseHeaderSchema = {
+    type: 'object',
+    properties: {
+        name: { type: 'string' },
+        value: { type: 'string' },
+    },
+    additionalProperties: false,
+    required: ['name', 'value'],
+};
+exports.redoclyConfigSchema = {
+    type: 'object',
+    properties: {
+        licenseKey: { type: 'string' },
+        theme: { type: 'object', default: {} },
+        redirects: { type: 'object', additionalProperties: redirectConfigSchema, default: {} },
+        seo: seoConfigSchema,
+        rbac: rbacConfigSchema,
+        responseHeaders: {
+            type: 'object',
+            additionalProperties: {
+                type: 'array',
+                items: responseHeaderSchema,
+            },
+        },
+        mockServer: {
+            type: 'object',
+            properties: {
+                off: { type: 'boolean', default: false },
+                position: { type: 'string', enum: ['first', 'last', 'replace', 'off'], default: 'first' },
+                strictExamples: { type: 'boolean', default: false },
+                errorIfForcedExampleNotFound: { type: 'boolean', default: false },
+                description: { type: 'string' },
+            },
+        },
+        apis: {
+            type: 'object',
+            additionalProperties: exports.apiConfigSchema,
+        },
+        sso: exports.ssoConfigSchema,
+        developerOnboarding: devOnboardingConfigSchema,
+        i18n: {
+            type: 'object',
+            properties: {
+                defaultLocale: {
+                    type: 'string',
+                },
+                locales: {
+                    type: 'array',
+                    items: {
+                        type: 'object',
+                        properties: {
+                            code: {
+                                type: 'string',
+                            },
+                            name: {
+                                type: 'string',
+                            },
+                        },
+                        required: ['code'],
+                    },
+                },
+            },
+            additionalProperties: false,
+            required: ['defaultLocale', 'locales'],
+        },
+        metadata: metadataConfigSchema,
+    },
+    default: {},
+    additionalProperties: true,
+};
+exports.environmentSchema = {
+    oneOf: [
+        Object.assign(Object.assign({}, exports.redoclyConfigSchema), { additionalProperties: false }),
+        {
+            type: 'object',
+            properties: {
+                $ref: { type: 'string' },
+            },
+            required: ['$ref'],
+            additionalProperties: false,
+        },
+    ],
+};
+exports.rootRedoclyConfigSchema = Object.assign(Object.assign({}, exports.redoclyConfigSchema), { properties: Object.assign(Object.assign({}, exports.redoclyConfigSchema.properties), { env: {
+            type: 'object',
+            additionalProperties: exports.environmentSchema,
+        } }), default: {}, required: ['redirects'] });

package/lib/types/redocly-yaml.js

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConfigTypes = void 0;
-const config_external_schemas_1 = require("./config-external-schemas");
+const portal_config_schema_1 = require("./portal-config-schema");
+const theme_config_1 = require("./theme-config");
 const _1 = require(".");
+const oas3_1_1 = require("./oas3_1");
 const utils_1 = require("../utils");
 const builtInRulesList = [
     'spec',
@@ -59,6 +61,8 @@ const builtInRulesList = [
     'required-string-property-missing-min-length',
     'spec-strict-refs',
     'component-name-unique',
+    'channels-kebab-case',
+    'no-channel-trailing-slash',
 ];
 const nodeTypesList = [
     'any',
@@ -120,6 +124,7 @@ const nodeTypesList = [
     'XCodeSampleList',
     'WebhooksMap',
     'SpecExtension',
+    'Message',
 ];
 const ConfigStyleguide = {
     properties: {
@@ -150,7 +155,7 @@ const RootConfigStyleguide = {
         } }, 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: 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: {
             properties: {
                 http: 'ConfigHTTP',
                 doNotResolveExamples: { type: 'boolean' },
@@ -160,24 +165,24 @@ const ConfigRoot = {
             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: Object.assign(Object.assign({ root: { type: 'string' }, labels: {
+    properties: Object.assign(Object.assign(Object.assign(Object.assign({}, portal_config_schema_1.apiConfigSchema.properties), { root: { type: 'string' }, labels: {
             type: 'array',
             items: {
                 type: 'string',
             },
-        }, lint: 'ConfigStyleguide', styleguide: 'ConfigStyleguide' }, ConfigStyleguide.properties), { 'features.openapi': 'ConfigReferenceDocs', 'features.mockServer': 'ConfigMockServer', theme: 'ConfigRootTheme', files: {
+        }, 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 = {
@@ -191,7 +196,7 @@ const ConfigHTTP = {
     },
 };
 const ConfigRootTheme = {
-    properties: Object.assign(Object.assign({}, config_external_schemas_1.themeConfigSchema.properties), { openapi: 'ConfigReferenceDocs', mockServer: 'ConfigMockServer' }),
+    properties: Object.assign(Object.assign({}, theme_config_1.themeConfigSchema.properties), { openapi: 'ConfigReferenceDocs', mockServer: 'ConfigMockServer' }),
 };
 const Rules = {
     properties: {},
@@ -211,6 +216,9 @@ const Rules = {
                 return 'ObjectRule';
             }
         }
+        else if (key === 'metadata-schema' || key === 'custom-fields-schema') {
+            return 'Schema';
+        }
         // Otherwise is considered as invalid
         return;
     },
@@ -482,7 +490,7 @@ const TryItButton = {
         fullWidth: { type: 'boolean' },
     },
 };
-const Components = {
+const ConfigThemeComponents = {
     properties: {
         buttons: 'ButtonsConfig',
         httpBadges: 'HttpBadgesConfig',
@@ -523,7 +531,7 @@ const SchemaColorsConfig = {
         border: { type: 'string' },
     },
 };
-const Schema = {
+const ConfigThemeSchema = {
     properties: {
         breakFieldNames: { type: 'boolean' },
         caretColor: { type: 'string' },
@@ -605,7 +613,7 @@ const CodeBlock = {
         tokens: 'TokenProps',
     },
 };
-const Logo = {
+const ConfigThemeLogo = {
     properties: {
         gutter: { type: 'string' },
         maxHeight: { type: 'string' },
@@ -654,13 +662,13 @@ const ConfigTheme = {
         breakpoints: 'Breakpoints',
         codeBlock: 'CodeBlock',
         colors: 'ThemeColors',
-        components: 'Components',
+        components: 'ConfigThemeComponents',
         layout: 'Layout',
-        logo: 'Logo',
+        logo: 'ConfigThemeLogo',
         fab: 'Fab',
         overrides: 'Overrides',
         rightPanel: 'RightPanel',
-        schema: 'Schema',
+        schema: 'ConfigThemeSchema',
         shape: 'Shape',
         sidebar: 'Sidebar',
         spacing: 'ThemeSpacing',
@@ -811,8 +819,7 @@ const ConfigMockServer = {
         errorIfForcedExampleNotFound: { type: 'boolean' },
     },
 };
-exports.ConfigTypes = {
-    Assert,
+exports.ConfigTypes = Object.assign(Object.assign({}, oas3_1_1.Oas3_1Types), { Assert,
     ConfigRoot,
     ConfigApis,
     ConfigApisProperties,
@@ -857,7 +864,7 @@ exports.ConfigTypes = {
     LinksConfig,
     TokenProps,
     CodeBlock,
-    Logo,
+    ConfigThemeLogo,
     Fab,
     ButtonOverrides,
     Overrides,
@@ -868,12 +875,11 @@ exports.ConfigTypes = {
     ThemeSpacing,
     GenerateCodeSamples,
     GroupItemsConfig,
-    Components,
+    ConfigThemeComponents,
     Layout,
-    Schema,
+    ConfigThemeSchema,
     Sidebar,
     Heading,
     Typography,
     AssertionDefinitionAssertions,
-    AssertionDefinitionSubject,
-};
+    AssertionDefinitionSubject });