@redocly/config 0.8.2 → 0.10.0

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

@@ -1,7 +1,10 @@
 import { DEFAULT_TEAM_CLAIM_NAME, AuthProviderType, ApigeeDevOnboardingIntegrationAuthType, } from './constants';
 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, footerConfigSchema, linksConfigSchema, logoConfigSchema, markdownConfigSchema, navbarConfigSchema, navigationConfigSchema, openapiConfigSchema, productsConfigSchema, scorecardConfigSchema, scriptsConfigSchema, searchConfigSchema, sidebarConfigSchema, userMenuConfigSchema, versionPickerConfigSchema, } from './ex-theme-config-schemas';
 export const oidcIssuerMetadataSchema = {
     type: 'object',
     properties: {
@@ -101,11 +104,16 @@ export const apiConfigSchema = {
         root: { type: 'string' },
         output: { type: 'string', pattern: '(.ya?ml|.json)$' },
         rbac: { type: 'object', additionalProperties: true },
+        openapi: openapiConfigSchema,
+        graphql: graphqlConfigSchema,
+        /**
+         * @deprecated left for backwards compatibility
+         */
         theme: {
             type: 'object',
             properties: {
-                openapi: themeConfigSchema.properties.openapi,
-                graphql: themeConfigSchema.properties.graphql,
+                openapi: openapiConfigSchema,
+                graphql: graphqlConfigSchema,
             },
             additionalProperties: false,
         },
@@ -253,7 +261,7 @@ const devOnboardingConfigSchema = {
         },
     },
 };
-export const i18ConfigSchema = {
+export const l10nConfigSchema = {
     type: 'object',
     properties: {
         defaultLocale: {
@@ -290,6 +298,13 @@ const responseHeaderSchema = {
 export const redoclyConfigSchema = {
     type: 'object',
     properties: {
+        /**
+         * @deprecated Should use `plugins` instead
+         */
+        imports: {
+            type: 'array',
+            items: { type: 'string' },
+        },
         licenseKey: { type: 'string' },
         redirects: redirectsConfigSchema,
         seo: seoConfigSchema,
@@ -324,7 +339,8 @@ export const redoclyConfigSchema = {
         residency: { type: 'string' },
         developerOnboarding: devOnboardingConfigSchema,
         removeAttribution: { type: 'boolean' },
-        i18n: i18ConfigSchema,
+        i18n: l10nConfigSchema,
+        l10n: l10nConfigSchema,
         metadata: metadataConfigSchema,
         ignore: {
             type: 'array',
@@ -332,8 +348,33 @@ export const redoclyConfigSchema = {
                 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,
+        colorMode: colorModeConfigSchema,
+        navigation: navigationConfigSchema,
+        codeSnippet: codeSnippetConfigSchema,
+        markdown: markdownConfigSchema,
+        openapi: openapiConfigSchema,
+        graphql: graphqlConfigSchema,
+        analytics: analyticsConfigSchema,
+        userMenu: userMenuConfigSchema,
+        versionPicker: versionPickerConfigSchema,
+        breadcrumbs: breadcrumbsConfigSchema,
+        catalog: catalogsConfigSchema,
+        scorecard: scorecardConfigSchema,
     },
     default: { redirects: {} },
     additionalProperties: true,

package/lib-esm/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 {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/config",
-  "version": "0.8.2",
+  "version": "0.10.0",
   "license": "MIT",
   "main": "./lib/index.js",
   "module": "./lib-esm/index.js",