@redocly/config 0.8.2 → 0.10.0

package/lib/root-config-schema.js

@@ -1,10 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.rootRedoclyConfigSchema = exports.redoclyConfigSchema = exports.i18ConfigSchema = exports.devOnboardingAdapterConfigSchema = exports.apigeeEdgeAdapterConfigSchema = exports.apigeeXAdapterConfigSchema = exports.apigeeAdapterAuthServiceAccountSchema = exports.apigeeAdapterAuthOauth2Schema = exports.graviteeAdapterConfigSchema = exports.graviteeAdapterAuthIdpSchema = exports.graviteeAdapterAuthStaticSchema = exports.rbacConfigSchema = exports.rbacScopeItemsSchema = exports.seoConfigSchema = exports.apiConfigSchema = exports.redirectsConfigSchema = exports.redirectConfigSchema = exports.ssoConfigSchema = exports.ssoOnPremConfigSchema = exports.authProviderConfigSchema = exports.saml2ProviderConfigSchema = exports.oidcProviderConfigSchema = exports.oidcIssuerMetadataSchema = void 0;
+exports.rootRedoclyConfigSchema = exports.redoclyConfigSchema = exports.l10nConfigSchema = exports.devOnboardingAdapterConfigSchema = exports.apigeeEdgeAdapterConfigSchema = exports.apigeeXAdapterConfigSchema = exports.apigeeAdapterAuthServiceAccountSchema = exports.apigeeAdapterAuthOauth2Schema = exports.graviteeAdapterConfigSchema = exports.graviteeAdapterAuthIdpSchema = exports.graviteeAdapterAuthStaticSchema = exports.rbacConfigSchema = exports.rbacScopeItemsSchema = exports.seoConfigSchema = exports.apiConfigSchema = exports.redirectsConfigSchema = exports.redirectConfigSchema = exports.ssoConfigSchema = exports.ssoOnPremConfigSchema = exports.authProviderConfigSchema = exports.saml2ProviderConfigSchema = exports.oidcProviderConfigSchema = exports.oidcIssuerMetadataSchema = void 0;
 const constants_1 = require("./constants");
 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");
 exports.oidcIssuerMetadataSchema = {
     type: 'object',
     properties: {
@@ -104,11 +107,16 @@ exports.apiConfigSchema = {
         root: { type: 'string' },
         output: { type: 'string', pattern: '(.ya?ml|.json)$' },
         rbac: { type: 'object', additionalProperties: true },
+        openapi: ex_theme_config_schemas_1.openapiConfigSchema,
+        graphql: graphql_config_schema_1.graphqlConfigSchema,
+        /**
+         * @deprecated left for backwards compatibility
+         */
         theme: {
             type: 'object',
             properties: {
-                openapi: default_theme_config_schema_1.themeConfigSchema.properties.openapi,
-                graphql: default_theme_config_schema_1.themeConfigSchema.properties.graphql,
+                openapi: ex_theme_config_schemas_1.openapiConfigSchema,
+                graphql: graphql_config_schema_1.graphqlConfigSchema,
             },
             additionalProperties: false,
         },
@@ -256,7 +264,7 @@ const devOnboardingConfigSchema = {
         },
     },
 };
-exports.i18ConfigSchema = {
+exports.l10nConfigSchema = {
     type: 'object',
     properties: {
         defaultLocale: {
@@ -293,6 +301,13 @@ const responseHeaderSchema = {
 exports.redoclyConfigSchema = {
     type: 'object',
     properties: {
+        /**
+         * @deprecated Should use `plugins` instead
+         */
+        imports: {
+            type: 'array',
+            items: { type: 'string' },
+        },
         licenseKey: { type: 'string' },
         redirects: exports.redirectsConfigSchema,
         seo: exports.seoConfigSchema,
@@ -327,7 +342,8 @@ exports.redoclyConfigSchema = {
         residency: { type: 'string' },
         developerOnboarding: devOnboardingConfigSchema,
         removeAttribution: { type: 'boolean' },
-        i18n: exports.i18ConfigSchema,
+        i18n: exports.l10nConfigSchema,
+        l10n: exports.l10nConfigSchema,
         metadata: metadataConfigSchema,
         ignore: {
             type: 'array',
@@ -335,8 +351,33 @@ exports.redoclyConfigSchema = {
                 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,
+        colorMode: ex_theme_config_schemas_1.colorModeConfigSchema,
+        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,
+        catalog: ex_theme_config_schemas_1.catalogsConfigSchema,
+        scorecard: ex_theme_config_schemas_1.scorecardConfigSchema,
     },
     default: { redirects: {} },
     additionalProperties: true,

package/lib/types.d.ts

@@ -1,10 +1,11 @@
 import type { FromSchema } from 'json-schema-to-ts';
-import type { amplitudeAnalyticsConfigSchema, catalogFilterSchema, catalogSchema, googleAnalyticsConfigSchema, gtmAnalyticsConfigSchema, markdownConfigSchema, productConfigSchema, productGoogleAnalyticsConfigSchema, rudderstackAnalyticsConfigSchema, scorecardConfigSchema, segmentAnalyticsConfigSchema, closedThemeConfigSchema as themeConfigSchema } from './default-theme-config-schema';
-import type { apiConfigSchema, apigeeAdapterAuthOauth2Schema, apigeeAdapterAuthServiceAccountSchema, apigeeEdgeAdapterConfigSchema, apigeeXAdapterConfigSchema, authProviderConfigSchema, devOnboardingAdapterConfigSchema, graviteeAdapterConfigSchema, i18ConfigSchema, oidcIssuerMetadataSchema, oidcProviderConfigSchema, rbacConfigSchema, rbacScopeItemsSchema, redirectConfigSchema, redirectsConfigSchema, rootRedoclyConfigSchema, saml2ProviderConfigSchema, seoConfigSchema, ssoOnPremConfigSchema } from './root-config-schema';
+import type { productConfigOverrideSchema, themeConfigSchema } from './default-theme-config-schema';
+import type { apiConfigSchema, apigeeAdapterAuthOauth2Schema, apigeeAdapterAuthServiceAccountSchema, apigeeEdgeAdapterConfigSchema, apigeeXAdapterConfigSchema, authProviderConfigSchema, devOnboardingAdapterConfigSchema, graviteeAdapterConfigSchema, l10nConfigSchema, oidcIssuerMetadataSchema, oidcProviderConfigSchema, rbacConfigSchema, rbacScopeItemsSchema, redirectConfigSchema, redirectsConfigSchema, rootRedoclyConfigSchema, saml2ProviderConfigSchema, seoConfigSchema, ssoOnPremConfigSchema } from './root-config-schema';
 import type { RedocConfigTypes } from './redoc-types';
 import type { GraphQLConfigTypes } from './graphql-types';
+import type { productConfigSchema, productGoogleAnalyticsConfigSchema, markdownConfigSchema, amplitudeAnalyticsConfigSchema, rudderstackAnalyticsConfigSchema, segmentAnalyticsConfigSchema, gtmAnalyticsConfigSchema, googleAnalyticsConfigSchema, scorecardConfigSchema, catalogFilterSchema, catalogSchema } from './ex-theme-config-schemas';
 /**
- * Theme
+ * @deprecated left for backwards compatibility. To be removed in Realm 1.0
  */
 export type ThemeConfig = Omit<FromSchema<typeof themeConfigSchema>, 'openapi'> & {
     openapi?: RedocConfigTypes;
@@ -22,11 +23,11 @@ export type GoogleAnalyticsConfig = FromSchema<typeof googleAnalyticsConfigSchem
 export type CatalogConfig = FromSchema<typeof catalogSchema>;
 export type CatalogFilterConfig = FromSchema<typeof catalogFilterSchema>;
 export type ScorecardConfig = FromSchema<typeof scorecardConfigSchema>;
-/**
- * Root
- */
-export type RedoclyConfig<T = ThemeConfig> = Omit<FromSchema<typeof rootRedoclyConfigSchema>, 'theme' | 'apis'> & {
-    theme?: T;
+export type RedoclyConfig = Omit<FromSchema<typeof rootRedoclyConfigSchema>, 'theme' | 'apis'> & {
+    /**
+     * @deprecated properties moved to the root of the config
+     */
+    theme?: any;
     apis?: Record<string, ApiConfig>;
 };
 export type RedirectConfig = FromSchema<typeof redirectConfigSchema>;
@@ -44,12 +45,16 @@ export type ApigeeAdapterConfig = FromSchema<typeof apigeeXAdapterConfigSchema |
 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 L10nConfig = FromSchema<typeof l10nConfigSchema>;
 type BasicApiConfig = FromSchema<typeof apiConfigSchema>;
 export type ApiConfig = BasicApiConfig & {
+    /**
+     * @deprecated left for backwards compatibility
+     */
     theme?: {
         openapi?: RedocConfig;
         graphql?: GraphQLConfig;
     };
 };
+export type ProductConfigOverride = FromSchema<typeof productConfigOverrideSchema>;
 export {};