@redocly/config - npm Package Compare versions

Comparing version 0.6.2 to 0.6.3

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

@@ -636,2 +636,3 @@ import { redocConfigSchema } from './redoc-config-schema';
 };
+export const closedThemeConfigSchema = Object.assign(Object.assign({}, themeConfigSchema), { additionalProperties: false });
 export const productThemeOverrideSchema = {
@@ -638,0 +639,0 @@ type: 'object',

lib-esm/redoc-config-schema.js

 import { feedbackConfigSchema } from './feedback-config-schema';
+import { deprecatedRefDocsSchema } from './reference-docs-config-schema';
 const codeSamplesConfigSchema = {
@@ -68,18 +69,3 @@ type: 'object',
     type: 'object',
-    properties: {
-        licenseKey: { type: 'string' },
-        hideLoading: { type: 'boolean' },
-        disableRouter: { type: 'boolean' },
-        hideSidebar: { type: 'boolean' },
-        feedback: feedbackConfigSchema,
-        hideReplay: { type: 'boolean' },
-        oAuth2RedirectURI: { type: 'string', nullable: true },
-        corsProxyUrl: { type: 'string' },
-        sortRequiredPropsFirst: { type: 'boolean' },
-        sanitize: { type: 'boolean' },
-        hideDownloadButtons: { type: 'boolean' },
-        downloadUrls: downloadUrlsSchema,
-        onlyRequiredInSamples: { type: 'boolean' },
-        generatedSamplesMaxDepth: { oneOf: [{ type: 'number' }, { type: 'string' }] },
-        showExtensions: {
+    properties: Object.assign(Object.assign({}, deprecatedRefDocsSchema.properties), { licenseKey: { type: 'string' }, hideLoading: { type: 'boolean' }, disableRouter: { type: 'boolean' }, hideSidebar: { type: 'boolean' }, feedback: feedbackConfigSchema, hideReplay: { type: 'boolean' }, oAuth2RedirectURI: { type: 'string', nullable: true }, corsProxyUrl: { type: 'string' }, sortRequiredPropsFirst: { type: 'boolean' }, sanitize: { type: 'boolean' }, hideDownloadButtons: { type: 'boolean' }, downloadUrls: downloadUrlsSchema, onlyRequiredInSamples: { type: 'boolean' }, generatedSamplesMaxDepth: { oneOf: [{ type: 'number' }, { type: 'string' }] }, showExtensions: {
             oneOf: [
@@ -90,30 +76,14 @@ { type: 'boolean' },
             ],
-        },
-        hideSchemaTitles: { type: 'boolean' },
-        jsonSamplesExpandLevel: { oneOf: [{ type: 'number' }, { type: 'string' }] },
-        schemasExpansionLevel: { oneOf: [{ type: 'number' }, { type: 'string' }] },
-        mockServer: {
+        }, hideSchemaTitles: { type: 'boolean' }, jsonSamplesExpandLevel: { oneOf: [{ type: 'number' }, { type: 'string' }] }, schemasExpansionLevel: { oneOf: [{ type: 'number' }, { type: 'string' }] }, mockServer: {
             type: 'object',
             properties: {
                 url: { type: 'string' },
-                position: { enum: ['first', 'last', 'replace', 'off'] },
+                position: { type: 'string', enum: ['first', 'last', 'replace', 'off'] },
                 description: { type: 'string' },
             },
-        },
-        maxDisplayedEnumValues: { type: 'number' },
-        schemaDefinitionsTagName: { type: 'string' },
-        layout: { type: 'string', enum: ['stacked', 'three-panel'] },
-        hideInfoMetadata: { type: 'boolean' },
-        events: { type: 'object' },
-        skipBundle: { type: 'boolean' },
-        routingBasePath: { type: 'string' },
-        codeSamples: codeSamplesConfigSchema,
-        ignoreNamedSchemas: {
+        }, maxDisplayedEnumValues: { type: 'number' }, schemaDefinitionsTagName: { type: 'string' }, layout: { type: 'string', enum: ['stacked', 'three-panel'] }, hideInfoMetadata: { type: 'boolean' }, events: { type: 'object' }, skipBundle: { type: 'boolean' }, routingBasePath: { type: 'string' }, codeSamples: codeSamplesConfigSchema, ignoreNamedSchemas: {
             oneOf: [{ type: 'array', items: { type: 'string' } }, { type: 'string' }],
-        },
-        hidePropertiesPrefix: { type: 'boolean' },
-        excludeFromSearch: { type: 'boolean' },
-    },
+        }, hidePropertiesPrefix: { type: 'boolean' }, excludeFromSearch: { type: 'boolean' } }),
     additionalProperties: false,
 };
 //# sourceMappingURL=redoc-config-schema.js.map

lib-esm/redoc-types.d.ts

@@ -5,3 +5,4 @@ import type { ReactElement, ComponentType } from 'react';
 import type { redocConfigSchema } from './redoc-config-schema';
-export type RedocConfigTypes = FromSchema<typeof redocConfigSchema> & {
+import type { DeprecatedRefDocsConfig } from './reference-docs-config-schema';
+export type RedocConfigTypes = Omit<FromSchema<typeof redocConfigSchema>, keyof DeprecatedRefDocsConfig> & {
     markdocOptions?: {
@@ -8,0 +9,0 @@ tags: Record<string, Schema>;

lib-esm/types.d.ts

 import type { FromSchema } from 'json-schema-to-ts';
-import type { amplitudeAnalyticsConfigSchema, catalogFilterSchema, catalogSchema, googleAnalyticsConfigSchema, gtmAnalyticsConfigSchema, markdownConfigSchema, productConfigSchema, productGoogleAnalyticsConfigSchema, rudderstackAnalyticsConfigSchema, scorecardConfigSchema, segmentAnalyticsConfigSchema, themeConfigSchema } from './default-theme-config-schema';
+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, basicAuthProviderConfigSchema, devOnboardingAdapterConfigSchema, graviteeAdapterConfigSchema, i18ConfigSchema, oidcIssuerMetadataSchema, oidcProviderConfigSchema, rbacConfigSchema, rbacScopeItemsSchema, redirectConfigSchema, redirectsConfigSchema, rootRedoclyConfigSchema, saml2ProviderConfigSchema, seoConfigSchema, ssoOnPremConfigSchema } from './root-config-schema';
@@ -9,3 +9,5 @@ import type { RedocConfigTypes } from './redoc-types';
  */
-export type ThemeConfig = FromSchema<typeof themeConfigSchema>;
+export type ThemeConfig = Omit<FromSchema<typeof themeConfigSchema>, 'openapi'> & {
+    openapi?: RedocConfigTypes;
+};
 export type RedocConfig = RedocConfigTypes;
@@ -27,4 +29,5 @@ export type GraphQLConfig = GraphQLConfigTypes;
  */
-export type RedoclyConfig<T = ThemeConfig> = FromSchema<typeof rootRedoclyConfigSchema> & {
+export type RedoclyConfig<T = ThemeConfig> = Omit<FromSchema<typeof rootRedoclyConfigSchema>, 'theme' | 'apis'> & {
     theme?: T;
+    apis?: Record<string, ApiConfig>;
 };
@@ -48,2 +51,9 @@ export type RedirectConfig = FromSchema<typeof redirectConfigSchema>;
 export type I18nConfig = FromSchema<typeof i18ConfigSchema>;
-export type ApiConfig = FromSchema<typeof apiConfigSchema>;
+type BasicApiConfig = FromSchema<typeof apiConfigSchema>;
+export type ApiConfig = BasicApiConfig & {
+    theme?: {
+        openapi?: RedocConfig;
+        graphql?: GraphQLConfig;
+    };
+};
+export {};

lib/default-theme-config-schema.js

 "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;
+exports.productConfigOverrideSchema = exports.productThemeOverrideSchema = exports.closedThemeConfigSchema = 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 redoc_config_schema_1 = require("./redoc-config-schema");
@@ -639,2 +639,3 @@ const graphql_config_schema_1 = require("./graphql-config-schema");
 };
+exports.closedThemeConfigSchema = Object.assign(Object.assign({}, exports.themeConfigSchema), { additionalProperties: false });
 exports.productThemeOverrideSchema = {
@@ -641,0 +642,0 @@ type: 'object',

lib/redoc-config-schema.js

@@ -5,2 +5,3 @@ "use strict";
 const feedback_config_schema_1 = require("./feedback-config-schema");
+const reference_docs_config_schema_1 = require("./reference-docs-config-schema");
 const codeSamplesConfigSchema = {
@@ -72,18 +73,3 @@ type: 'object',
     type: 'object',
-    properties: {
-        licenseKey: { type: 'string' },
-        hideLoading: { type: 'boolean' },
-        disableRouter: { type: 'boolean' },
-        hideSidebar: { type: 'boolean' },
-        feedback: feedback_config_schema_1.feedbackConfigSchema,
-        hideReplay: { type: 'boolean' },
-        oAuth2RedirectURI: { type: 'string', nullable: true },
-        corsProxyUrl: { type: 'string' },
-        sortRequiredPropsFirst: { type: 'boolean' },
-        sanitize: { type: 'boolean' },
-        hideDownloadButtons: { type: 'boolean' },
-        downloadUrls: downloadUrlsSchema,
-        onlyRequiredInSamples: { type: 'boolean' },
-        generatedSamplesMaxDepth: { oneOf: [{ type: 'number' }, { type: 'string' }] },
-        showExtensions: {
+    properties: Object.assign(Object.assign({}, reference_docs_config_schema_1.deprecatedRefDocsSchema.properties), { licenseKey: { type: 'string' }, hideLoading: { type: 'boolean' }, disableRouter: { type: 'boolean' }, hideSidebar: { type: 'boolean' }, feedback: feedback_config_schema_1.feedbackConfigSchema, hideReplay: { type: 'boolean' }, oAuth2RedirectURI: { type: 'string', nullable: true }, corsProxyUrl: { type: 'string' }, sortRequiredPropsFirst: { type: 'boolean' }, sanitize: { type: 'boolean' }, hideDownloadButtons: { type: 'boolean' }, downloadUrls: downloadUrlsSchema, onlyRequiredInSamples: { type: 'boolean' }, generatedSamplesMaxDepth: { oneOf: [{ type: 'number' }, { type: 'string' }] }, showExtensions: {
             oneOf: [
@@ -94,30 +80,14 @@ { type: 'boolean' },
             ],
-        },
-        hideSchemaTitles: { type: 'boolean' },
-        jsonSamplesExpandLevel: { oneOf: [{ type: 'number' }, { type: 'string' }] },
-        schemasExpansionLevel: { oneOf: [{ type: 'number' }, { type: 'string' }] },
-        mockServer: {
+        }, hideSchemaTitles: { type: 'boolean' }, jsonSamplesExpandLevel: { oneOf: [{ type: 'number' }, { type: 'string' }] }, schemasExpansionLevel: { oneOf: [{ type: 'number' }, { type: 'string' }] }, mockServer: {
             type: 'object',
             properties: {
                 url: { type: 'string' },
-                position: { enum: ['first', 'last', 'replace', 'off'] },
+                position: { type: 'string', enum: ['first', 'last', 'replace', 'off'] },
                 description: { type: 'string' },
             },
-        },
-        maxDisplayedEnumValues: { type: 'number' },
-        schemaDefinitionsTagName: { type: 'string' },
-        layout: { type: 'string', enum: ['stacked', 'three-panel'] },
-        hideInfoMetadata: { type: 'boolean' },
-        events: { type: 'object' },
-        skipBundle: { type: 'boolean' },
-        routingBasePath: { type: 'string' },
-        codeSamples: codeSamplesConfigSchema,
-        ignoreNamedSchemas: {
+        }, maxDisplayedEnumValues: { type: 'number' }, schemaDefinitionsTagName: { type: 'string' }, layout: { type: 'string', enum: ['stacked', 'three-panel'] }, hideInfoMetadata: { type: 'boolean' }, events: { type: 'object' }, skipBundle: { type: 'boolean' }, routingBasePath: { type: 'string' }, codeSamples: codeSamplesConfigSchema, ignoreNamedSchemas: {
             oneOf: [{ type: 'array', items: { type: 'string' } }, { type: 'string' }],
-        },
-        hidePropertiesPrefix: { type: 'boolean' },
-        excludeFromSearch: { type: 'boolean' },
-    },
+        }, hidePropertiesPrefix: { type: 'boolean' }, excludeFromSearch: { type: 'boolean' } }),
     additionalProperties: false,
 };
 //# sourceMappingURL=redoc-config-schema.js.map

lib/redoc-types.d.ts

@@ -5,3 +5,4 @@ import type { ReactElement, ComponentType } from 'react';
 import type { redocConfigSchema } from './redoc-config-schema';
-export type RedocConfigTypes = FromSchema<typeof redocConfigSchema> & {
+import type { DeprecatedRefDocsConfig } from './reference-docs-config-schema';
+export type RedocConfigTypes = Omit<FromSchema<typeof redocConfigSchema>, keyof DeprecatedRefDocsConfig> & {
     markdocOptions?: {
@@ -8,0 +9,0 @@ tags: Record<string, Schema>;

lib/types.d.ts

 import type { FromSchema } from 'json-schema-to-ts';
-import type { amplitudeAnalyticsConfigSchema, catalogFilterSchema, catalogSchema, googleAnalyticsConfigSchema, gtmAnalyticsConfigSchema, markdownConfigSchema, productConfigSchema, productGoogleAnalyticsConfigSchema, rudderstackAnalyticsConfigSchema, scorecardConfigSchema, segmentAnalyticsConfigSchema, themeConfigSchema } from './default-theme-config-schema';
+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, basicAuthProviderConfigSchema, devOnboardingAdapterConfigSchema, graviteeAdapterConfigSchema, i18ConfigSchema, oidcIssuerMetadataSchema, oidcProviderConfigSchema, rbacConfigSchema, rbacScopeItemsSchema, redirectConfigSchema, redirectsConfigSchema, rootRedoclyConfigSchema, saml2ProviderConfigSchema, seoConfigSchema, ssoOnPremConfigSchema } from './root-config-schema';
@@ -9,3 +9,5 @@ import type { RedocConfigTypes } from './redoc-types';
  */
-export type ThemeConfig = FromSchema<typeof themeConfigSchema>;
+export type ThemeConfig = Omit<FromSchema<typeof themeConfigSchema>, 'openapi'> & {
+    openapi?: RedocConfigTypes;
+};
 export type RedocConfig = RedocConfigTypes;
@@ -27,4 +29,5 @@ export type GraphQLConfig = GraphQLConfigTypes;
  */
-export type RedoclyConfig<T = ThemeConfig> = FromSchema<typeof rootRedoclyConfigSchema> & {
+export type RedoclyConfig<T = ThemeConfig> = Omit<FromSchema<typeof rootRedoclyConfigSchema>, 'theme' | 'apis'> & {
     theme?: T;
+    apis?: Record<string, ApiConfig>;
 };
@@ -48,2 +51,9 @@ export type RedirectConfig = FromSchema<typeof redirectConfigSchema>;
 export type I18nConfig = FromSchema<typeof i18ConfigSchema>;
-export type ApiConfig = FromSchema<typeof apiConfigSchema>;
+type BasicApiConfig = FromSchema<typeof apiConfigSchema>;
+export type ApiConfig = BasicApiConfig & {
+    theme?: {
+        openapi?: RedocConfig;
+        graphql?: GraphQLConfig;
+    };
+};
+export {};

package.json

 {
   "name": "@redocly/config",
-  "version": "0.6.2",
+  "version": "0.6.3",
   "license": "MIT",
@@ -5,0 +5,0 @@ "main": "./lib/index.js",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

3795583

increased by109.83%

Number of package files

59

increased by7.27%

Lines of code

71276

increased by95.59%

No dependency changes