@redocly/config 0.47.0 → 0.48.1

package/lib-esm/root-config-schema.js

@@ -1,584 +0,0 @@
-import { DEFAULT_TEAM_CLAIM_NAME, AuthProviderType, ApigeeDevOnboardingIntegrationAuthType, } from './constants/shared';
-import { CONFIG_NODE_TYPE_NAMES } from './constants/config';
-import { themeConfigSchema } from './default-theme-config-schema';
-import { feedbackConfigSchema } from './feedback-config-schema';
-import { graphqlConfigSchema } from './graphql-config-schema';
-import { removePropertyRecursively } from './remove-property-recursively';
-import { reuniteConfigSchema } from './reunite-config-schema';
-import { analyticsConfigSchema, breadcrumbsConfigSchema, catalogsConfigSchema, codeSnippetConfigSchema, colorModeConfigSchema, paletteConfigSchema, footerConfigSchema, linksConfigSchema, logoConfigSchema, markdownConfigSchema, navbarConfigSchema, navigationConfigSchema, openapiConfigSchema, productsConfigSchema, scorecardConfigSchema, scriptsConfigSchema, searchConfigSchema, aiAssistantSchema, sidebarConfigSchema, userMenuConfigSchema, versionPickerConfigSchema, } from './ex-theme-config-schemas';
-import { entitiesCatalogConfigSchema } from './entities-catalog-config-schema';
-import { scorecardsConfigSchema } from './scorecards-config-schema';
-import { configGovernanceSchema } from './common';
-export 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,
-};
-export const oidcProviderConfigSchema = {
-    type: 'object',
-    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: 0 },
-        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' } },
-        introspectEndpoint: { type: 'string' },
-        tokenRequestCustomParams: { type: 'object', additionalProperties: { type: 'string' } },
-        audience: { type: 'array', items: { type: 'string' } },
-    },
-    required: ['type', 'clientId'],
-    oneOf: [{ required: ['configurationUrl'] }, { required: ['configuration'] }],
-    additionalProperties: false,
-};
-export const saml2ProviderConfigSchema = {
-    type: 'object',
-    properties: {
-        type: { type: 'string', const: AuthProviderType.SAML2 },
-        title: { type: 'string' },
-        issuerId: { type: 'string' },
-        entityId: { type: 'string' },
-        ssoUrl: { type: 'string' },
-        x509PublicCert: { type: 'string' },
-        teamsAttributeName: { type: 'string', default: DEFAULT_TEAM_CLAIM_NAME },
-        teamsAttributeMap: { type: 'object', additionalProperties: { type: 'string' } },
-        defaultTeams: { type: 'array', items: { type: 'string' } },
-    },
-    additionalProperties: false,
-    required: ['type', 'issuerId', 'ssoUrl', 'x509PublicCert'],
-};
-export const authProviderConfigSchema = {
-    oneOf: [oidcProviderConfigSchema, saml2ProviderConfigSchema],
-    discriminator: { propertyName: 'type' },
-};
-export const ssoDirectConfigSchema = {
-    type: 'object',
-    additionalProperties: authProviderConfigSchema,
-};
-export const ssoConfigSchema = {
-    oneOf: [
-        {
-            type: 'array',
-            items: {
-                type: 'string',
-                enum: ['REDOCLY', 'CORPORATE', 'GUEST'],
-            },
-            uniqueItems: true,
-        },
-        {
-            type: 'string',
-            enum: ['REDOCLY', 'CORPORATE', 'GUEST'],
-        },
-    ],
-};
-const requiresLoginSchema = { type: 'boolean' };
-const logoutReturnUrlSchema = { type: 'string', pattern: '^https?://.*' };
-const residencySchema = { type: 'string', pattern: '^https?://.*' };
-export const redirectConfigSchema = {
-    type: 'object',
-    properties: {
-        to: { type: 'string' },
-        type: { type: 'number', default: 301 },
-    },
-    additionalProperties: false,
-    nodeTypeName: CONFIG_NODE_TYPE_NAMES.RedirectSource,
-    description: 'Source is an absolute path that must start with a forward slash.',
-    documentationLink: 'https://redocly.com/docs/realm/config/redirects#sources-map',
-};
-export const redirectsConfigSchema = {
-    type: 'object',
-    additionalProperties: redirectConfigSchema,
-    default: {},
-    nodeTypeName: CONFIG_NODE_TYPE_NAMES.Redirects,
-    description: 'Use redirects to change which resource a URL points to, maintaining working links when you move, rename, or restructure content.',
-    documentationLink: 'https://redocly.com/docs/realm/config/redirects',
-};
-export const bannerColorSchema = {
-    type: 'string',
-    enum: ['info', 'success', 'warning', 'error'],
-    default: 'info',
-};
-export const rbacScopeItemsSchema = {
-    type: 'object',
-    additionalProperties: { type: 'string' },
-};
-export const bannerConfigSchema = {
-    type: 'object',
-    properties: {
-        content: { type: 'string' },
-        dismissible: { type: 'boolean', default: false },
-        target: { type: 'string' },
-        color: bannerColorSchema,
-        rbac: rbacScopeItemsSchema,
-    },
-    required: ['content'],
-    additionalProperties: false,
-};
-export const bannersConfigSchema = {
-    type: 'array',
-    items: bannerConfigSchema,
-    default: [],
-};
-export const apiConfigSchema = {
-    type: 'object',
-    properties: Object.assign({ root: { type: 'string' }, output: { type: 'string', pattern: '(.ya?ml|.json)$' }, rbac: rbacScopeItemsSchema, openapi: openapiConfigSchema, graphql: graphqlConfigSchema, 
-        /**
-         * @deprecated left for backwards compatibility
-         */
-        theme: {
-            type: 'object',
-            properties: {
-                openapi: openapiConfigSchema,
-                graphql: graphqlConfigSchema,
-            },
-            additionalProperties: false,
-        }, title: { type: 'string' }, metadata: { type: 'object', additionalProperties: true } }, configGovernanceSchema),
-    required: ['root'],
-};
-const metadataConfigSchema = {
-    type: 'object',
-    additionalProperties: true,
-};
-const metadataGlobsConfigSchema = {
-    type: 'object',
-    additionalProperties: {
-        type: 'object',
-        additionalProperties: true,
-    },
-};
-const llmstxtConfigSchema = {
-    type: 'object',
-    properties: {
-        hide: {
-            type: 'boolean',
-            default: false,
-        },
-        title: {
-            type: 'string',
-        },
-        description: {
-            type: 'string',
-        },
-        details: {
-            type: 'object',
-            properties: {
-                path: {
-                    type: 'string',
-                },
-                content: {
-                    type: 'string',
-                },
-            },
-            additionalProperties: false,
-        },
-        excludeFiles: {
-            type: 'array',
-            items: { type: 'string' },
-            default: [],
-        },
-        sections: {
-            type: 'array',
-            items: {
-                type: 'object',
-                properties: {
-                    title: { type: 'string' },
-                    description: { type: 'string' },
-                    includeFiles: {
-                        type: 'array',
-                        items: { type: 'string' },
-                        default: [],
-                    },
-                    excludeFiles: {
-                        type: 'array',
-                        items: { type: 'string' },
-                        default: [],
-                    },
-                },
-                required: ['title'],
-                additionalProperties: false,
-            },
-        },
-    },
-    default: {
-        hide: false,
-        title: undefined,
-        description: undefined,
-        details: undefined,
-        sections: [
-            {
-                title: 'Table of contents',
-                includeFiles: ['**/*'],
-                excludeFiles: [],
-            },
-        ],
-    },
-    additionalProperties: false,
-};
-export const seoConfigSchema = {
-    type: 'object',
-    properties: {
-        title: { type: 'string' },
-        projectTitle: { type: 'string' },
-        description: { type: 'string' },
-        siteUrl: { type: 'string' },
-        image: { type: 'string' },
-        keywords: {
-            oneOf: [{ type: 'array', items: { type: 'string' } }, { 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,
-            },
-        },
-        llmstxt: llmstxtConfigSchema,
-    },
-    default: {
-        llmstxt: llmstxtConfigSchema.default,
-    },
-    additionalProperties: false,
-};
-export const apiFunctionsConfigSchema = {
-    type: 'object',
-    properties: {
-        folders: { type: 'array', items: { type: 'string' } },
-    },
-    additionalProperties: false,
-};
-export const rbacEntitiesCatalogConfigSchema = {
-    type: 'object',
-    properties: {
-        catalogs: {
-            type: 'object',
-            properties: {
-                all: rbacScopeItemsSchema,
-                services: rbacScopeItemsSchema,
-                domains: rbacScopeItemsSchema,
-                teams: rbacScopeItemsSchema,
-                users: rbacScopeItemsSchema,
-                apiDescriptions: rbacScopeItemsSchema,
-                dataSchemas: rbacScopeItemsSchema,
-                apiOperations: rbacScopeItemsSchema,
-            },
-            additionalProperties: rbacScopeItemsSchema,
-        },
-        entitiesTypes: {
-            type: 'object',
-            properties: {
-                service: rbacScopeItemsSchema,
-                domain: rbacScopeItemsSchema,
-                team: rbacScopeItemsSchema,
-                user: rbacScopeItemsSchema,
-                apiDescription: rbacScopeItemsSchema,
-                apiOperation: rbacScopeItemsSchema,
-                dataSchema: rbacScopeItemsSchema,
-            },
-            additionalProperties: rbacScopeItemsSchema,
-        },
-        entitiesGroups: {
-            type: 'array',
-            items: {
-                type: 'object',
-                properties: {
-                    entities: { type: 'array', items: { type: 'string' } },
-                    config: rbacScopeItemsSchema,
-                },
-                additionalProperties: false,
-            },
-        },
-        entities: {
-            type: 'object',
-            properties: {
-                '**': rbacScopeItemsSchema,
-            },
-            additionalProperties: rbacScopeItemsSchema,
-        },
-    },
-    additionalProperties: false,
-};
-export const rbacConfigSchema = {
-    type: 'object',
-    properties: {
-        teamNamePatterns: { type: 'array', items: { type: 'string' } },
-        teamFolders: { type: 'array', items: { type: 'string' } },
-        teamFoldersBaseRoles: rbacScopeItemsSchema,
-        cms: rbacScopeItemsSchema, // deprecated in favor of reunite
-        reunite: rbacScopeItemsSchema,
-        features: {
-            type: 'object',
-            properties: {
-                aiSearch: rbacScopeItemsSchema,
-            },
-            additionalProperties: false,
-        },
-        content: {
-            type: 'object',
-            properties: {
-                '**': rbacScopeItemsSchema,
-            },
-            additionalProperties: rbacScopeItemsSchema,
-        },
-        entitiesCatalog: rbacEntitiesCatalogConfigSchema,
-    },
-    additionalProperties: rbacScopeItemsSchema,
-};
-export const graviteeAdapterAuthStaticSchema = {
-    type: 'object',
-    properties: { static: { type: 'string' } },
-    additionalProperties: false,
-    required: ['static'],
-};
-export const graviteeAdapterAuthIdpSchema = {
-    type: 'object',
-    properties: { idp: { type: 'string' } },
-    additionalProperties: false,
-    required: ['idp'],
-};
-export 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: {
-            oneOf: [graviteeAdapterAuthStaticSchema, graviteeAdapterAuthIdpSchema],
-        },
-    },
-    additionalProperties: false,
-    required: ['type', 'apiBaseUrl'],
-};
-export const apigeeAdapterAuthOauth2Schema = {
-    type: 'object',
-    properties: {
-        type: { type: 'string', const: ApigeeDevOnboardingIntegrationAuthType.OAUTH2 },
-        tokenEndpoint: { type: 'string' },
-        clientId: { type: 'string' },
-        clientSecret: { type: 'string' },
-    },
-    additionalProperties: false,
-    required: ['type', 'tokenEndpoint', 'clientId', 'clientSecret'],
-};
-export const apigeeAdapterAuthServiceAccountSchema = {
-    type: 'object',
-    properties: {
-        type: { type: 'string', const: ApigeeDevOnboardingIntegrationAuthType.SERVICE_ACCOUNT },
-        serviceAccountEmail: { type: 'string' },
-        serviceAccountPrivateKey: { type: 'string' },
-    },
-    additionalProperties: false,
-    required: ['type', 'serviceAccountEmail', 'serviceAccountPrivateKey'],
-};
-export 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'],
-};
-export const apigeeEdgeAdapterConfigSchema = Object.assign(Object.assign({}, apigeeXAdapterConfigSchema), { properties: Object.assign(Object.assign({}, apigeeXAdapterConfigSchema.properties), { type: { type: 'string', const: 'APIGEE_EDGE' } }) });
-export 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,
-        },
-    },
-};
-export const l10nConfigSchema = {
-    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'],
-};
-const responseHeaderSchema = {
-    type: 'object',
-    properties: {
-        name: { type: 'string' },
-        value: { type: 'string' },
-    },
-    additionalProperties: false,
-    required: ['name', 'value'],
-};
-const mcpConfigSchema = {
-    type: 'object',
-    properties: {
-        hide: { type: 'boolean', default: false },
-        docs: {
-            type: 'object',
-            properties: {
-                hide: { type: 'boolean', default: false },
-                name: { type: 'string', default: 'Docs MCP server' },
-                ignore: {
-                    type: 'array',
-                    items: { type: 'string' },
-                    default: [],
-                },
-            },
-            additionalProperties: false,
-        },
-    },
-    additionalProperties: false,
-    default: {
-        hide: false,
-        docs: {
-            hide: false,
-            name: 'MCP server',
-            ignore: [],
-        },
-    },
-};
-export const accessConfigSchema = {
-    type: 'object',
-    properties: {
-        requiresLogin: requiresLoginSchema,
-        logoutReturnUrl: logoutReturnUrlSchema,
-        residency: residencySchema,
-        sso: ssoConfigSchema,
-        rbac: rbacConfigSchema,
-    },
-    additionalProperties: false,
-};
-export const redoclyConfigSchema = {
-    type: 'object',
-    properties: Object.assign(Object.assign({ 
-        /**
-         * @deprecated Should use `plugins` instead
-         */
-        imports: {
-            type: 'array',
-            items: { type: 'string' },
-        }, licenseKey: { type: 'string' }, redirects: redirectsConfigSchema, seo: seoConfigSchema, 
-        /**
-         * @deprecated Should use `access.rbac` instead
-         */
-        rbac: rbacConfigSchema, apiFunctions: apiFunctionsConfigSchema, 
-        /**
-         * @deprecated Should use `access.requiresLogin` instead
-         */
-        requiresLogin: requiresLoginSchema, 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: apiConfigSchema,
-        } }, configGovernanceSchema), { ssoDirect: ssoDirectConfigSchema, 
-        /**
-         * @deprecated Should use `access.sso` instead
-         */
-        sso: ssoConfigSchema, 
-        /**
-         * @deprecated Should use `access.residency` instead
-         */
-        residency: residencySchema, 
-        /**
-         * @deprecated Should use `access.logoutReturnUrl` instead
-         */
-        logoutReturnUrl: logoutReturnUrlSchema, access: accessConfigSchema, developerOnboarding: devOnboardingConfigSchema, removeAttribution: { type: 'boolean' }, i18n: l10nConfigSchema, l10n: l10nConfigSchema, metadata: metadataConfigSchema, metadataGlobs: metadataGlobsConfigSchema, ignore: { type: 'array', items: { type: 'string' } }, 
-        /**
-         * @deprecated properties moved to the root of the config
-         */
-        theme: themeConfigSchema, reunite: reuniteConfigSchema, 
-        // Ex theme properties
-        logo: logoConfigSchema, navbar: navbarConfigSchema, products: productsConfigSchema, footer: footerConfigSchema, sidebar: sidebarConfigSchema, scripts: scriptsConfigSchema, links: linksConfigSchema, feedback: feedbackConfigSchema, search: searchConfigSchema, aiAssistant: aiAssistantSchema, colorMode: colorModeConfigSchema, palette: paletteConfigSchema, navigation: navigationConfigSchema, codeSnippet: codeSnippetConfigSchema, markdown: markdownConfigSchema, openapi: openapiConfigSchema, graphql: graphqlConfigSchema, analytics: analyticsConfigSchema, userMenu: userMenuConfigSchema, versionPicker: versionPickerConfigSchema, breadcrumbs: breadcrumbsConfigSchema, 
-        /**
-         * @deprecated Should use `catalogClassic` instead
-         */
-        catalog: catalogsConfigSchema, entitiesCatalog: entitiesCatalogConfigSchema, catalogClassic: catalogsConfigSchema, 
-        /**
-         * @deprecated Should use `scorecardClassic` instead
-         */
-        scorecard: scorecardConfigSchema, scorecardClassic: scorecardConfigSchema, scorecards: scorecardsConfigSchema, mcp: mcpConfigSchema, corsProxy: {
-            type: 'object',
-            properties: {
-                allowedTargets: {
-                    type: 'array',
-                    items: { type: 'string' },
-                },
-            },
-            additionalProperties: false,
-        }, banner: bannersConfigSchema }),
-    default: { redirects: {}, seo: seoConfigSchema.default },
-    additionalProperties: true,
-};
-const environmentSchema = Object.assign(Object.assign({}, removePropertyRecursively(redoclyConfigSchema, 'default')), { additionalProperties: false });
-export const rootRedoclyConfigSchema = Object.assign(Object.assign({ $id: 'root-redocly-config' }, redoclyConfigSchema), { properties: Object.assign(Object.assign({ plugins: {
-            type: 'array',
-            items: { type: 'string' },
-        } }, redoclyConfigSchema.properties), { env: {
-            type: 'object',
-            additionalProperties: environmentSchema, // TODO: if we want full validation we need to override apis, theme and the root
-        } }), default: {}, additionalProperties: false });
-//# sourceMappingURL=root-config-schema.js.map