@redocly/config 0.47.0 → 0.48.1

package/lib/root-config-schema.js

@@ -1,587 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.rootRedoclyConfigSchema = exports.redoclyConfigSchema = exports.accessConfigSchema = exports.l10nConfigSchema = exports.devOnboardingAdapterConfigSchema = exports.apigeeEdgeAdapterConfigSchema = exports.apigeeXAdapterConfigSchema = exports.apigeeAdapterAuthServiceAccountSchema = exports.apigeeAdapterAuthOauth2Schema = exports.graviteeAdapterConfigSchema = exports.graviteeAdapterAuthIdpSchema = exports.graviteeAdapterAuthStaticSchema = exports.rbacConfigSchema = exports.rbacEntitiesCatalogConfigSchema = exports.apiFunctionsConfigSchema = exports.seoConfigSchema = exports.apiConfigSchema = exports.bannersConfigSchema = exports.bannerConfigSchema = exports.rbacScopeItemsSchema = exports.bannerColorSchema = exports.redirectsConfigSchema = exports.redirectConfigSchema = exports.ssoConfigSchema = exports.ssoDirectConfigSchema = exports.authProviderConfigSchema = exports.saml2ProviderConfigSchema = exports.oidcProviderConfigSchema = exports.oidcIssuerMetadataSchema = void 0;
-const shared_1 = require("./constants/shared");
-const config_1 = require("./constants/config");
-const default_theme_config_schema_1 = require("./default-theme-config-schema");
-const feedback_config_schema_1 = require("./feedback-config-schema");
-const graphql_config_schema_1 = require("./graphql-config-schema");
-const remove_property_recursively_1 = require("./remove-property-recursively");
-const reunite_config_schema_1 = require("./reunite-config-schema");
-const ex_theme_config_schemas_1 = require("./ex-theme-config-schemas");
-const entities_catalog_config_schema_1 = require("./entities-catalog-config-schema");
-const scorecards_config_schema_1 = require("./scorecards-config-schema");
-const common_1 = require("./common");
-exports.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,
-};
-exports.oidcProviderConfigSchema = {
-    type: 'object',
-    properties: {
-        type: { type: 'string', const: shared_1.AuthProviderType.OIDC },
-        title: { type: 'string' },
-        pkce: { type: 'boolean', default: false },
-        configurationUrl: { type: 'string', minLength: 1 },
-        configuration: exports.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,
-};
-exports.saml2ProviderConfigSchema = {
-    type: 'object',
-    properties: {
-        type: { type: 'string', const: shared_1.AuthProviderType.SAML2 },
-        title: { type: 'string' },
-        issuerId: { type: 'string' },
-        entityId: { type: 'string' },
-        ssoUrl: { type: 'string' },
-        x509PublicCert: { type: 'string' },
-        teamsAttributeName: { type: 'string', default: shared_1.DEFAULT_TEAM_CLAIM_NAME },
-        teamsAttributeMap: { type: 'object', additionalProperties: { type: 'string' } },
-        defaultTeams: { type: 'array', items: { type: 'string' } },
-    },
-    additionalProperties: false,
-    required: ['type', 'issuerId', 'ssoUrl', 'x509PublicCert'],
-};
-exports.authProviderConfigSchema = {
-    oneOf: [exports.oidcProviderConfigSchema, exports.saml2ProviderConfigSchema],
-    discriminator: { propertyName: 'type' },
-};
-exports.ssoDirectConfigSchema = {
-    type: 'object',
-    additionalProperties: exports.authProviderConfigSchema,
-};
-exports.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?://.*' };
-exports.redirectConfigSchema = {
-    type: 'object',
-    properties: {
-        to: { type: 'string' },
-        type: { type: 'number', default: 301 },
-    },
-    additionalProperties: false,
-    nodeTypeName: config_1.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',
-};
-exports.redirectsConfigSchema = {
-    type: 'object',
-    additionalProperties: exports.redirectConfigSchema,
-    default: {},
-    nodeTypeName: config_1.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',
-};
-exports.bannerColorSchema = {
-    type: 'string',
-    enum: ['info', 'success', 'warning', 'error'],
-    default: 'info',
-};
-exports.rbacScopeItemsSchema = {
-    type: 'object',
-    additionalProperties: { type: 'string' },
-};
-exports.bannerConfigSchema = {
-    type: 'object',
-    properties: {
-        content: { type: 'string' },
-        dismissible: { type: 'boolean', default: false },
-        target: { type: 'string' },
-        color: exports.bannerColorSchema,
-        rbac: exports.rbacScopeItemsSchema,
-    },
-    required: ['content'],
-    additionalProperties: false,
-};
-exports.bannersConfigSchema = {
-    type: 'array',
-    items: exports.bannerConfigSchema,
-    default: [],
-};
-exports.apiConfigSchema = {
-    type: 'object',
-    properties: Object.assign({ root: { type: 'string' }, output: { type: 'string', pattern: '(.ya?ml|.json)$' }, rbac: exports.rbacScopeItemsSchema, openapi: ex_theme_config_schemas_1.openapiConfigSchema, graphql: graphql_config_schema_1.graphqlConfigSchema, 
-        /**
-         * @deprecated left for backwards compatibility
-         */
-        theme: {
-            type: 'object',
-            properties: {
-                openapi: ex_theme_config_schemas_1.openapiConfigSchema,
-                graphql: graphql_config_schema_1.graphqlConfigSchema,
-            },
-            additionalProperties: false,
-        }, title: { type: 'string' }, metadata: { type: 'object', additionalProperties: true } }, common_1.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,
-};
-exports.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,
-};
-exports.apiFunctionsConfigSchema = {
-    type: 'object',
-    properties: {
-        folders: { type: 'array', items: { type: 'string' } },
-    },
-    additionalProperties: false,
-};
-exports.rbacEntitiesCatalogConfigSchema = {
-    type: 'object',
-    properties: {
-        catalogs: {
-            type: 'object',
-            properties: {
-                all: exports.rbacScopeItemsSchema,
-                services: exports.rbacScopeItemsSchema,
-                domains: exports.rbacScopeItemsSchema,
-                teams: exports.rbacScopeItemsSchema,
-                users: exports.rbacScopeItemsSchema,
-                apiDescriptions: exports.rbacScopeItemsSchema,
-                dataSchemas: exports.rbacScopeItemsSchema,
-                apiOperations: exports.rbacScopeItemsSchema,
-            },
-            additionalProperties: exports.rbacScopeItemsSchema,
-        },
-        entitiesTypes: {
-            type: 'object',
-            properties: {
-                service: exports.rbacScopeItemsSchema,
-                domain: exports.rbacScopeItemsSchema,
-                team: exports.rbacScopeItemsSchema,
-                user: exports.rbacScopeItemsSchema,
-                apiDescription: exports.rbacScopeItemsSchema,
-                apiOperation: exports.rbacScopeItemsSchema,
-                dataSchema: exports.rbacScopeItemsSchema,
-            },
-            additionalProperties: exports.rbacScopeItemsSchema,
-        },
-        entitiesGroups: {
-            type: 'array',
-            items: {
-                type: 'object',
-                properties: {
-                    entities: { type: 'array', items: { type: 'string' } },
-                    config: exports.rbacScopeItemsSchema,
-                },
-                additionalProperties: false,
-            },
-        },
-        entities: {
-            type: 'object',
-            properties: {
-                '**': exports.rbacScopeItemsSchema,
-            },
-            additionalProperties: exports.rbacScopeItemsSchema,
-        },
-    },
-    additionalProperties: false,
-};
-exports.rbacConfigSchema = {
-    type: 'object',
-    properties: {
-        teamNamePatterns: { type: 'array', items: { type: 'string' } },
-        teamFolders: { type: 'array', items: { type: 'string' } },
-        teamFoldersBaseRoles: exports.rbacScopeItemsSchema,
-        cms: exports.rbacScopeItemsSchema, // deprecated in favor of reunite
-        reunite: exports.rbacScopeItemsSchema,
-        features: {
-            type: 'object',
-            properties: {
-                aiSearch: exports.rbacScopeItemsSchema,
-            },
-            additionalProperties: false,
-        },
-        content: {
-            type: 'object',
-            properties: {
-                '**': exports.rbacScopeItemsSchema,
-            },
-            additionalProperties: exports.rbacScopeItemsSchema,
-        },
-        entitiesCatalog: exports.rbacEntitiesCatalogConfigSchema,
-    },
-    additionalProperties: exports.rbacScopeItemsSchema,
-};
-exports.graviteeAdapterAuthStaticSchema = {
-    type: 'object',
-    properties: { static: { type: 'string' } },
-    additionalProperties: false,
-    required: ['static'],
-};
-exports.graviteeAdapterAuthIdpSchema = {
-    type: 'object',
-    properties: { idp: { type: 'string' } },
-    additionalProperties: false,
-    required: ['idp'],
-};
-exports.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: [exports.graviteeAdapterAuthStaticSchema, exports.graviteeAdapterAuthIdpSchema],
-        },
-    },
-    additionalProperties: false,
-    required: ['type', 'apiBaseUrl'],
-};
-exports.apigeeAdapterAuthOauth2Schema = {
-    type: 'object',
-    properties: {
-        type: { type: 'string', const: shared_1.ApigeeDevOnboardingIntegrationAuthType.OAUTH2 },
-        tokenEndpoint: { type: 'string' },
-        clientId: { type: 'string' },
-        clientSecret: { type: 'string' },
-    },
-    additionalProperties: false,
-    required: ['type', 'tokenEndpoint', 'clientId', 'clientSecret'],
-};
-exports.apigeeAdapterAuthServiceAccountSchema = {
-    type: 'object',
-    properties: {
-        type: { type: 'string', const: shared_1.ApigeeDevOnboardingIntegrationAuthType.SERVICE_ACCOUNT },
-        serviceAccountEmail: { type: 'string' },
-        serviceAccountPrivateKey: { type: 'string' },
-    },
-    additionalProperties: false,
-    required: ['type', 'serviceAccountEmail', 'serviceAccountPrivateKey'],
-};
-exports.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: [exports.apigeeAdapterAuthOauth2Schema, exports.apigeeAdapterAuthServiceAccountSchema],
-            discriminator: { propertyName: 'type' },
-        },
-    },
-    additionalProperties: false,
-    required: ['type', 'organizationName', 'auth'],
-};
-exports.apigeeEdgeAdapterConfigSchema = Object.assign(Object.assign({}, exports.apigeeXAdapterConfigSchema), { properties: Object.assign(Object.assign({}, exports.apigeeXAdapterConfigSchema.properties), { type: { type: 'string', const: 'APIGEE_EDGE' } }) });
-exports.devOnboardingAdapterConfigSchema = {
-    type: 'object',
-    oneOf: [exports.apigeeXAdapterConfigSchema, exports.apigeeEdgeAdapterConfigSchema, exports.graviteeAdapterConfigSchema],
-    discriminator: { propertyName: 'type' },
-};
-const devOnboardingConfigSchema = {
-    type: 'object',
-    required: ['adapters'],
-    additionalProperties: false,
-    properties: {
-        adapters: {
-            type: 'array',
-            items: exports.devOnboardingAdapterConfigSchema,
-        },
-    },
-};
-exports.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: [],
-        },
-    },
-};
-exports.accessConfigSchema = {
-    type: 'object',
-    properties: {
-        requiresLogin: requiresLoginSchema,
-        logoutReturnUrl: logoutReturnUrlSchema,
-        residency: residencySchema,
-        sso: exports.ssoConfigSchema,
-        rbac: exports.rbacConfigSchema,
-    },
-    additionalProperties: false,
-};
-exports.redoclyConfigSchema = {
-    type: 'object',
-    properties: Object.assign(Object.assign({ 
-        /**
-         * @deprecated Should use `plugins` instead
-         */
-        imports: {
-            type: 'array',
-            items: { type: 'string' },
-        }, licenseKey: { type: 'string' }, redirects: exports.redirectsConfigSchema, seo: exports.seoConfigSchema, 
-        /**
-         * @deprecated Should use `access.rbac` instead
-         */
-        rbac: exports.rbacConfigSchema, apiFunctions: exports.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: exports.apiConfigSchema,
-        } }, common_1.configGovernanceSchema), { ssoDirect: exports.ssoDirectConfigSchema, 
-        /**
-         * @deprecated Should use `access.sso` instead
-         */
-        sso: exports.ssoConfigSchema, 
-        /**
-         * @deprecated Should use `access.residency` instead
-         */
-        residency: residencySchema, 
-        /**
-         * @deprecated Should use `access.logoutReturnUrl` instead
-         */
-        logoutReturnUrl: logoutReturnUrlSchema, access: exports.accessConfigSchema, developerOnboarding: devOnboardingConfigSchema, removeAttribution: { type: 'boolean' }, i18n: exports.l10nConfigSchema, l10n: exports.l10nConfigSchema, metadata: metadataConfigSchema, metadataGlobs: metadataGlobsConfigSchema, ignore: { type: 'array', items: { type: 'string' } }, 
-        /**
-         * @deprecated properties moved to the root of the config
-         */
-        theme: default_theme_config_schema_1.themeConfigSchema, reunite: reunite_config_schema_1.reuniteConfigSchema, 
-        // Ex theme properties
-        logo: ex_theme_config_schemas_1.logoConfigSchema, navbar: ex_theme_config_schemas_1.navbarConfigSchema, products: ex_theme_config_schemas_1.productsConfigSchema, footer: ex_theme_config_schemas_1.footerConfigSchema, sidebar: ex_theme_config_schemas_1.sidebarConfigSchema, scripts: ex_theme_config_schemas_1.scriptsConfigSchema, links: ex_theme_config_schemas_1.linksConfigSchema, feedback: feedback_config_schema_1.feedbackConfigSchema, search: ex_theme_config_schemas_1.searchConfigSchema, aiAssistant: ex_theme_config_schemas_1.aiAssistantSchema, colorMode: ex_theme_config_schemas_1.colorModeConfigSchema, palette: ex_theme_config_schemas_1.paletteConfigSchema, navigation: ex_theme_config_schemas_1.navigationConfigSchema, codeSnippet: ex_theme_config_schemas_1.codeSnippetConfigSchema, markdown: ex_theme_config_schemas_1.markdownConfigSchema, openapi: ex_theme_config_schemas_1.openapiConfigSchema, graphql: graphql_config_schema_1.graphqlConfigSchema, analytics: ex_theme_config_schemas_1.analyticsConfigSchema, userMenu: ex_theme_config_schemas_1.userMenuConfigSchema, versionPicker: ex_theme_config_schemas_1.versionPickerConfigSchema, breadcrumbs: ex_theme_config_schemas_1.breadcrumbsConfigSchema, 
-        /**
-         * @deprecated Should use `catalogClassic` instead
-         */
-        catalog: ex_theme_config_schemas_1.catalogsConfigSchema, entitiesCatalog: entities_catalog_config_schema_1.entitiesCatalogConfigSchema, catalogClassic: ex_theme_config_schemas_1.catalogsConfigSchema, 
-        /**
-         * @deprecated Should use `scorecardClassic` instead
-         */
-        scorecard: ex_theme_config_schemas_1.scorecardConfigSchema, scorecardClassic: ex_theme_config_schemas_1.scorecardConfigSchema, scorecards: scorecards_config_schema_1.scorecardsConfigSchema, mcp: mcpConfigSchema, corsProxy: {
-            type: 'object',
-            properties: {
-                allowedTargets: {
-                    type: 'array',
-                    items: { type: 'string' },
-                },
-            },
-            additionalProperties: false,
-        }, banner: exports.bannersConfigSchema }),
-    default: { redirects: {}, seo: exports.seoConfigSchema.default },
-    additionalProperties: true,
-};
-const environmentSchema = Object.assign(Object.assign({}, (0, remove_property_recursively_1.removePropertyRecursively)(exports.redoclyConfigSchema, 'default')), { additionalProperties: false });
-exports.rootRedoclyConfigSchema = Object.assign(Object.assign({ $id: 'root-redocly-config' }, exports.redoclyConfigSchema), { properties: Object.assign(Object.assign({ plugins: {
-            type: 'array',
-            items: { type: 'string' },
-        } }, exports.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