@redocly/config 0.0.0-beta-20240318165323

package/lib/default-theme-config-schema.js

@@ -0,0 +1,657 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.productConfigOverrideSchema = exports.productThemeOverrideSchema = exports.themeConfigSchema = exports.catalogSchema = exports.scorecardConfigSchema = exports.catalogFilterSchema = exports.productConfigSchema = exports.googleAnalyticsConfigSchema = exports.productGoogleAnalyticsConfigSchema = exports.gtmAnalyticsConfigSchema = exports.segmentAnalyticsConfigSchema = exports.rudderstackAnalyticsConfigSchema = exports.heapAnalyticsConfigSchema = exports.fullstoryAnalyticsConfigSchema = exports.amplitudeAnalyticsConfigSchema = exports.markdownConfigSchema = void 0;
+const logoConfigSchema = {
+    type: 'object',
+    properties: {
+        image: { type: 'string' },
+        srcSet: { type: 'string' },
+        altText: { type: 'string' },
+        link: { type: 'string' },
+        favicon: { type: 'string' },
+    },
+    additionalProperties: false,
+};
+const hideConfigSchema = {
+    type: 'object',
+    properties: {
+        hide: { type: 'boolean' },
+    },
+    additionalProperties: false,
+};
+const scriptConfigSchema = {
+    type: 'object',
+    properties: {
+        src: { type: 'string' },
+        async: { type: 'boolean' },
+        crossorigin: { type: 'string' },
+        defer: { type: 'boolean' },
+        fetchpriority: { type: 'string' },
+        integrity: { type: 'string' },
+        module: { type: 'boolean' },
+        nomodule: { type: 'boolean' },
+        nonce: { type: 'string' },
+        referrerpolicy: { type: 'string' },
+        type: { type: 'string' },
+    },
+    required: ['src'],
+    additionalProperties: true,
+};
+const linksConfigSchema = {
+    type: 'object',
+    properties: {
+        href: { type: 'string' },
+        as: { type: 'string' },
+        crossorigin: { type: 'string' },
+        fetchpriority: { type: 'string' },
+        hreflang: { type: 'string' },
+        imagesizes: { type: 'string' },
+        imagesrcset: { type: 'string' },
+        integrity: { type: 'string' },
+        media: { type: 'string' },
+        prefetch: { type: 'string' },
+        referrerpolicy: { type: 'string' },
+        rel: { type: 'string' },
+        sizes: { type: 'string' },
+        title: { type: 'string' },
+        type: { type: 'string' },
+    },
+    required: ['href'],
+    additionalProperties: true,
+};
+exports.markdownConfigSchema = {
+    type: 'object',
+    properties: {
+        frontMatterKeysToResolve: {
+            type: 'array',
+            items: { type: 'string' },
+            default: ['image', 'links'],
+        },
+        partialsFolders: {
+            type: 'array',
+            items: { type: 'string' },
+            default: ['_partials'],
+        },
+        lastUpdatedBlock: {
+            type: 'object',
+            properties: Object.assign({ format: {
+                    type: 'string',
+                    enum: ['timeago', 'iso', 'long', 'short'],
+                    default: 'timeago',
+                }, locale: { type: 'string' } }, hideConfigSchema.properties),
+            additionalProperties: false,
+            default: {},
+        },
+        toc: {
+            type: 'object',
+            properties: Object.assign({ header: { type: 'string', default: 'On this page' }, depth: { type: 'integer', default: 3, minimum: 1 } }, hideConfigSchema.properties),
+            additionalProperties: false,
+            default: {},
+        },
+        editPage: {
+            type: 'object',
+            properties: Object.assign({ baseUrl: { type: 'string' } }, hideConfigSchema.properties),
+            additionalProperties: false,
+            default: {},
+        },
+    },
+    additionalProperties: false,
+    default: {},
+};
+exports.amplitudeAnalyticsConfigSchema = {
+    type: 'object',
+    properties: {
+        includeInDevelopment: { type: 'boolean' },
+        apiKey: { type: 'string' },
+        head: { type: 'boolean' },
+        respectDNT: { type: 'boolean' },
+        exclude: { type: 'array', items: { type: 'string' } },
+        outboundClickEventName: { type: 'string' },
+        pageViewEventName: { type: 'string' },
+        amplitudeConfig: { type: 'object', additionalProperties: true },
+    },
+    additionalProperties: false,
+    required: ['apiKey'],
+};
+exports.fullstoryAnalyticsConfigSchema = {
+    type: 'object',
+    properties: {
+        includeInDevelopment: { type: 'boolean' },
+        orgId: { type: 'string' },
+    },
+    additionalProperties: false,
+    required: ['orgId'],
+};
+exports.heapAnalyticsConfigSchema = {
+    type: 'object',
+    properties: {
+        includeInDevelopment: { type: 'boolean' },
+        appId: { type: 'string' },
+    },
+    additionalProperties: false,
+    required: ['appId'],
+};
+exports.rudderstackAnalyticsConfigSchema = {
+    type: 'object',
+    properties: {
+        includeInDevelopment: { type: 'boolean' },
+        writeKey: { type: 'string', minLength: 10 },
+        trackPage: { type: 'boolean' },
+        dataPlaneUrl: { type: 'string' },
+        controlPlaneUrl: { type: 'string' },
+        sdkUrl: { type: 'string' },
+        loadOptions: { type: 'object', additionalProperties: true },
+    },
+    additionalProperties: false,
+    required: ['writeKey'],
+};
+exports.segmentAnalyticsConfigSchema = {
+    type: 'object',
+    properties: {
+        includeInDevelopment: { type: 'boolean' },
+        writeKey: { type: 'string', minLength: 10 },
+        trackPage: { type: 'boolean' },
+        includeTitleInPageCall: { type: 'boolean' },
+        host: { type: 'string' },
+    },
+    additionalProperties: false,
+    required: ['writeKey'],
+};
+exports.gtmAnalyticsConfigSchema = {
+    type: 'object',
+    properties: {
+        includeInDevelopment: { type: 'boolean' },
+        trackingId: { type: 'string' },
+        gtmAuth: { type: 'string' },
+        gtmPreview: { type: 'string' },
+        defaultDataLayer: {},
+        dataLayerName: { type: 'string' },
+        enableWebVitalsTracking: { type: 'boolean' },
+        selfHostedOrigin: { type: 'string' },
+        pageViewEventName: { type: 'string' },
+    },
+    additionalProperties: false,
+    required: ['trackingId'],
+};
+exports.productGoogleAnalyticsConfigSchema = {
+    type: 'object',
+    properties: {
+        includeInDevelopment: { type: 'boolean' },
+        trackingId: { type: 'string' },
+        conversionId: { type: 'string' },
+        floodlightId: { type: 'string' },
+        optimizeId: { type: 'string' },
+        exclude: { type: 'array', items: { type: 'string' } },
+    },
+    additionalProperties: false,
+    required: ['trackingId'],
+};
+exports.googleAnalyticsConfigSchema = {
+    type: 'object',
+    properties: {
+        includeInDevelopment: { type: 'boolean' },
+        trackingId: { type: 'string' },
+        conversionId: { type: 'string' },
+        floodlightId: { type: 'string' },
+        head: { type: 'boolean' },
+        respectDNT: { type: 'boolean' },
+        exclude: { type: 'array', items: { type: 'string' } },
+        optimizeId: { type: 'string' },
+        anonymizeIp: { type: 'boolean' },
+        cookieExpires: { type: 'number' },
+        // All enabled tracking configs
+        trackers: {
+            type: 'object',
+            additionalProperties: exports.productGoogleAnalyticsConfigSchema,
+        },
+    },
+    additionalProperties: false,
+    required: ['trackingId'],
+};
+const adobeAnalyticsConfigSchema = {
+    type: 'object',
+    properties: {
+        includeInDevelopment: { type: 'boolean' },
+        scriptUrl: { type: 'string' },
+        pageViewEventName: { type: 'string' },
+    },
+    additionalProperties: false,
+    required: ['scriptUrl'],
+};
+const navItemSchema = {
+    type: 'object',
+    properties: {
+        page: { type: 'string' },
+        directory: { type: 'string' },
+        disconnect: { type: 'boolean', default: false },
+        group: { type: 'string' },
+        label: { type: 'string' },
+        href: { type: 'string' },
+        external: { type: 'boolean' },
+        labelTranslationKey: { type: 'string' },
+        groupTranslationKey: { type: 'string' },
+        icon: {
+            oneOf: [
+                { type: 'string' },
+                { type: 'object', properties: { srcSet: { type: 'string' } }, required: ['srcSet'] },
+            ],
+        },
+        separator: { type: 'string' },
+        separatorLine: { type: 'boolean' },
+        linePosition: {
+            type: 'string',
+            enum: ['top', 'bottom'],
+            default: 'top',
+        },
+        version: { type: 'string' },
+        menuStyle: { type: 'string', enum: ['drilldown'] },
+        expanded: { type: 'string', const: 'always' },
+        selectFirstItemOnExpand: { type: 'boolean' },
+        flatten: { type: 'boolean' },
+        linkedSidebars: {
+            type: 'array',
+            items: { type: 'string' },
+        },
+        // Allow users to eject the navbar and implement additional levels of nesting
+        items: { type: 'array', items: { type: 'object', additionalProperties: true } },
+    },
+};
+const navItemsSchema = {
+    type: 'array',
+    items: Object.assign(Object.assign({}, navItemSchema), { properties: Object.assign(Object.assign({}, navItemSchema.properties), { items: { type: 'array', items: navItemSchema } }) }),
+};
+exports.productConfigSchema = {
+    type: 'object',
+    properties: {
+        name: { type: 'string' },
+        icon: { type: 'string' },
+        folder: { type: 'string' },
+    },
+    additionalProperties: false,
+    required: ['name', 'folder'],
+};
+const suggestedPageSchema = {
+    type: 'object',
+    properties: {
+        page: { type: 'string' },
+        label: { type: 'string' },
+        labelTranslationKey: { type: 'string' },
+    },
+    required: ['page'],
+};
+exports.catalogFilterSchema = {
+    type: 'object',
+    additionalProperties: false,
+    required: ['title', 'property'],
+    properties: {
+        type: { type: 'string', enum: ['select', 'checkboxes', 'date-range'] },
+        title: { type: 'string' },
+        titleTranslationKey: { type: 'string' },
+        property: { type: 'string' },
+        parentFilter: { type: 'string' },
+        valuesMapping: { type: 'object', additionalProperties: { type: 'string' } },
+        missingCategoryName: { type: 'string' },
+        missingCategoryNameTranslationKey: { type: 'string' },
+        options: { type: 'array', items: { type: 'string' } },
+    },
+};
+exports.scorecardConfigSchema = {
+    type: 'object',
+    additionalProperties: true,
+    required: [],
+    properties: {
+        ignoreNonCompliant: { type: 'boolean', default: false },
+        teamMetadataProperty: {
+            type: 'object',
+            properties: {
+                property: { type: 'string' },
+                label: { type: 'string' },
+                default: { type: 'string' },
+            },
+        },
+        levels: {
+            type: 'array',
+            items: {
+                type: 'object',
+                required: ['name'],
+                properties: {
+                    name: { type: 'string' },
+                    color: { type: 'string' },
+                    extends: { type: 'array', items: { type: 'string' } },
+                    rules: {
+                        type: 'object',
+                        additionalProperties: {
+                            oneOf: [{ type: 'string' }, { type: 'object' }],
+                        },
+                    },
+                },
+                additionalProperties: false,
+            },
+        },
+        targets: {
+            type: 'array',
+            items: {
+                type: 'object',
+                required: ['where'],
+                properties: {
+                    minimumLevel: { type: 'string' },
+                    where: {
+                        type: 'object',
+                        required: ['metadata'],
+                        properties: {
+                            metadata: { type: 'object', additionalProperties: { type: 'string' } },
+                        },
+                        additionalProperties: false,
+                    },
+                },
+                additionalProperties: false,
+            },
+        },
+    },
+};
+exports.catalogSchema = {
+    type: 'object',
+    additionalProperties: true,
+    required: ['slug', 'items'],
+    properties: {
+        slug: { type: 'string' },
+        filters: { type: 'array', items: exports.catalogFilterSchema },
+        groupByFirstFilter: { type: 'boolean' },
+        filterValuesCasing: {
+            type: 'string',
+            enum: ['sentence', 'original', 'lowercase', 'uppercase'],
+        },
+        items: navItemsSchema,
+        requiredPermission: { type: 'string' },
+        separateVersions: { type: 'boolean' },
+        title: { type: 'string' },
+        titleTranslationKey: { type: 'string' },
+        description: { type: 'string' },
+        descriptionTranslationKey: { type: 'string' },
+    },
+};
+const catalogsConfigSchema = {
+    type: 'object',
+    patternProperties: {
+        '.*': exports.catalogSchema,
+    },
+};
+exports.themeConfigSchema = {
+    type: 'object',
+    properties: {
+        imports: {
+            type: 'array',
+            items: { type: 'string' },
+            default: [],
+        },
+        logo: logoConfigSchema,
+        navbar: {
+            type: 'object',
+            properties: Object.assign({ items: navItemsSchema }, hideConfigSchema.properties),
+            additionalProperties: false,
+        },
+        products: {
+            type: 'object',
+            additionalProperties: exports.productConfigSchema,
+        },
+        footer: {
+            type: 'object',
+            properties: Object.assign({ items: navItemsSchema, copyrightText: { type: 'string' }, logo: hideConfigSchema }, hideConfigSchema.properties),
+            additionalProperties: false,
+        },
+        sidebar: {
+            type: 'object',
+            properties: Object.assign({ separatorLine: { type: 'boolean' }, linePosition: {
+                    type: 'string',
+                    enum: ['top', 'bottom'],
+                    default: 'bottom',
+                } }, hideConfigSchema.properties),
+            additionalProperties: false,
+        },
+        scripts: {
+            type: 'object',
+            properties: {
+                head: { type: 'array', items: scriptConfigSchema },
+                body: { type: 'array', items: scriptConfigSchema },
+            },
+            additionalProperties: false,
+        },
+        links: { type: 'array', items: linksConfigSchema },
+        feedback: {
+            type: 'object',
+            properties: {
+                hide: {
+                    type: 'boolean',
+                    default: false,
+                },
+                type: {
+                    type: 'string',
+                    enum: ['rating', 'sentiment', 'comment', 'reasons', 'mood', 'scale'],
+                    default: 'sentiment',
+                },
+                settings: Object.assign({ type: 'object', properties: {
+                        label: { type: 'string' },
+                        submitText: { type: 'string' },
+                        buttonText: { type: 'string' },
+                        component: {
+                            type: 'string',
+                            enum: ['radio', 'checkbox'],
+                            default: 'checkbox',
+                        },
+                        items: { type: 'array', items: { type: 'string' }, minItems: 1 },
+                        leftScaleLabel: { type: 'string' },
+                        rightScaleLabel: { type: 'string' },
+                        reasons: {
+                            type: 'object',
+                            properties: {
+                                hide: {
+                                    type: 'boolean',
+                                    default: false,
+                                },
+                                component: {
+                                    type: 'string',
+                                    enum: ['radio', 'checkbox'],
+                                    default: 'checkbox',
+                                },
+                                label: { type: 'string' },
+                                items: { type: 'array', items: { type: 'string' } },
+                            },
+                            additionalProperties: false,
+                        },
+                        comment: {
+                            type: 'object',
+                            properties: {
+                                hide: {
+                                    type: 'boolean',
+                                    default: false,
+                                },
+                                label: { type: 'string' },
+                                likeLabel: { type: 'string' },
+                                dislikeLabel: { type: 'string' },
+                                satisfiedLabel: { type: 'string' },
+                                neutralLabel: { type: 'string' },
+                                dissatisfiedLabel: { type: 'string' },
+                            },
+                            additionalProperties: false,
+                        },
+                    }, additionalProperties: false }, hideConfigSchema.properties),
+            },
+            additionalProperties: false,
+            default: {},
+        },
+        search: {
+            type: 'object',
+            properties: Object.assign({ placement: {
+                    type: 'string',
+                    default: 'navbar',
+                }, shortcuts: {
+                    type: 'array',
+                    items: { type: 'string' },
+                    default: ['/'],
+                }, suggestedPages: {
+                    type: 'array',
+                    items: suggestedPageSchema,
+                } }, hideConfigSchema.properties),
+            additionalProperties: false,
+            default: {},
+        },
+        colorMode: {
+            type: 'object',
+            properties: Object.assign({ ignoreDetection: { type: 'boolean' }, modes: {
+                    type: 'array',
+                    items: { type: 'string' },
+                    default: ['light', 'dark'],
+                } }, hideConfigSchema.properties),
+            additionalProperties: false,
+            default: {},
+        },
+        navigation: {
+            type: 'object',
+            properties: {
+                nextButton: {
+                    type: 'object',
+                    properties: Object.assign({ text: { type: 'string', default: 'Next to {{label}}' } }, hideConfigSchema.properties),
+                    additionalProperties: false,
+                    default: {},
+                },
+                previousButton: {
+                    type: 'object',
+                    properties: Object.assign({ text: { type: 'string', default: 'Back to {{label}}' } }, hideConfigSchema.properties),
+                    additionalProperties: false,
+                    default: {},
+                },
+            },
+            additionalProperties: false,
+            default: {},
+        },
+        codeSnippet: {
+            type: 'object',
+            properties: {
+                elementFormat: { type: 'string', default: 'icon' },
+                copy: {
+                    type: 'object',
+                    properties: Object.assign({}, hideConfigSchema.properties),
+                    additionalProperties: false,
+                    default: { hide: false },
+                },
+                report: {
+                    type: 'object',
+                    properties: Object.assign({ tooltipText: { type: 'string' }, buttonText: { type: 'string' }, label: { type: 'string' } }, hideConfigSchema.properties),
+                    additionalProperties: false,
+                    default: { hide: false },
+                },
+                expand: {
+                    type: 'object',
+                    properties: Object.assign({}, hideConfigSchema.properties),
+                    additionalProperties: false,
+                    default: { hide: false },
+                },
+                collapse: {
+                    type: 'object',
+                    properties: Object.assign({}, hideConfigSchema.properties),
+                    additionalProperties: false,
+                    default: { hide: false },
+                },
+            },
+            additionalProperties: false,
+            default: {},
+        },
+        markdown: exports.markdownConfigSchema,
+        openapi: { type: 'object', additionalProperties: true },
+        graphql: { type: 'object', additionalProperties: true },
+        analytics: {
+            type: 'object',
+            properties: {
+                adobe: adobeAnalyticsConfigSchema,
+                amplitude: exports.amplitudeAnalyticsConfigSchema,
+                fullstory: exports.fullstoryAnalyticsConfigSchema,
+                heap: exports.heapAnalyticsConfigSchema,
+                rudderstack: exports.rudderstackAnalyticsConfigSchema,
+                segment: exports.segmentAnalyticsConfigSchema,
+                gtm: exports.gtmAnalyticsConfigSchema,
+                ga: exports.googleAnalyticsConfigSchema,
+            },
+        },
+        userMenu: {
+            type: 'object',
+            properties: Object.assign({ items: {
+                    type: 'array',
+                    items: {
+                        type: 'object',
+                        properties: {
+                            label: { type: 'string' },
+                            external: { type: 'boolean' },
+                            link: { type: 'string' },
+                            separatorLine: { type: 'boolean' },
+                        },
+                        additionalProperties: true,
+                    },
+                    default: [],
+                } }, hideConfigSchema.properties),
+            additionalProperties: false,
+            default: {},
+        },
+        versionPicker: {
+            type: 'object',
+            properties: {
+                hide: { type: 'boolean' },
+                showForUnversioned: {
+                    type: 'boolean',
+                },
+            },
+        },
+        breadcrumbs: {
+            type: 'object',
+            properties: {
+                hide: { type: 'boolean' },
+                prefixItems: {
+                    type: 'array',
+                    items: {
+                        type: 'object',
+                        properties: {
+                            label: { type: 'string' },
+                            labelTranslationKey: { type: 'string' },
+                            page: { type: 'string' },
+                        },
+                        additionalProperties: false,
+                        default: {},
+                    },
+                },
+            },
+            additionalProperties: false,
+            default: {},
+        },
+        catalog: catalogsConfigSchema,
+        scorecard: exports.scorecardConfigSchema,
+    },
+    additionalProperties: true,
+    default: {},
+};
+exports.productThemeOverrideSchema = {
+    type: 'object',
+    properties: {
+        logo: exports.themeConfigSchema.properties.logo,
+        navbar: exports.themeConfigSchema.properties.navbar,
+        footer: exports.themeConfigSchema.properties.footer,
+        sidebar: exports.themeConfigSchema.properties.sidebar,
+        search: exports.themeConfigSchema.properties.search,
+        codeSnippet: exports.themeConfigSchema.properties.codeSnippet,
+        breadcrumbs: exports.themeConfigSchema.properties.breadcrumbs,
+        analytics: {
+            type: 'object',
+            properties: {
+                ga: exports.productGoogleAnalyticsConfigSchema,
+            },
+        },
+    },
+    additionalProperties: true,
+    default: {},
+};
+exports.productConfigOverrideSchema = {
+    type: 'object',
+    properties: {
+        theme: exports.productThemeOverrideSchema,
+    },
+    additionalProperties: false,
+};
+//# sourceMappingURL=default-theme-config-schema.js.map