@redocly/config 0.6.2 → 0.7.0

package/lib/root-config-schema.js

@@ -1,6 +1,6 @@
 "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.rbacConfigSchema = exports.rbacScopeItemsSchema = exports.seoConfigSchema = exports.apiConfigSchema = exports.redirectsConfigSchema = exports.redirectConfigSchema = exports.ssoConfigSchema = exports.ssoOnPremConfigSchema = exports.authProviderConfigSchema = exports.basicAuthProviderConfigSchema = exports.saml2ProviderConfigSchema = exports.oidcProviderConfigSchema = exports.oidcIssuerMetadataSchema = void 0;
+exports.rootRedoclyConfigSchema = exports.redoclyConfigSchema = exports.i18ConfigSchema = exports.devOnboardingAdapterConfigSchema = exports.apigeeEdgeAdapterConfigSchema = exports.apigeeXAdapterConfigSchema = exports.apigeeAdapterAuthServiceAccountSchema = exports.apigeeAdapterAuthOauth2Schema = exports.graviteeAdapterConfigSchema = 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 remove_property_recursively_1 = require("./remove-property-recursively");
@@ -55,31 +55,8 @@ exports.saml2ProviderConfigSchema = {
     additionalProperties: false,
     required: ['type', 'issuerId', 'ssoUrl', 'x509PublicCert'],
 };
-exports.basicAuthProviderConfigSchema = {
-    type: 'object',
-    properties: {
-        type: { type: 'string', const: constants_1.AuthProviderType.BASIC },
-        title: { type: 'string' },
-        credentials: {
-            type: 'array',
-            items: {
-                type: 'object',
-                properties: {
-                    username: { type: 'string' },
-                    password: { type: 'string' },
-                    passwordHash: { type: 'string' },
-                    teams: { type: 'array', items: { type: 'string' } },
-                },
-                required: ['username'],
-                additionalProperties: false,
-            },
-        },
-    },
-    required: ['type', 'credentials'],
-    additionalProperties: false,
-};
 exports.authProviderConfigSchema = {
-    oneOf: [exports.oidcProviderConfigSchema, exports.saml2ProviderConfigSchema, exports.basicAuthProviderConfigSchema],
+    oneOf: [exports.oidcProviderConfigSchema, exports.saml2ProviderConfigSchema],
     discriminator: { propertyName: 'type' },
 };
 exports.ssoOnPremConfigSchema = {

package/lib/types.d.ts

@@ -1,12 +1,14 @@
 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 { apiConfigSchema, apigeeAdapterAuthOauth2Schema, apigeeAdapterAuthServiceAccountSchema, apigeeEdgeAdapterConfigSchema, apigeeXAdapterConfigSchema, authProviderConfigSchema, basicAuthProviderConfigSchema, devOnboardingAdapterConfigSchema, graviteeAdapterConfigSchema, i18ConfigSchema, oidcIssuerMetadataSchema, oidcProviderConfigSchema, rbacConfigSchema, rbacScopeItemsSchema, redirectConfigSchema, redirectsConfigSchema, rootRedoclyConfigSchema, saml2ProviderConfigSchema, seoConfigSchema, ssoOnPremConfigSchema } from './root-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, devOnboardingAdapterConfigSchema, graviteeAdapterConfigSchema, i18ConfigSchema, 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';
 /**
  * Theme
  */
-export type ThemeConfig = FromSchema<typeof themeConfigSchema>;
+export type ThemeConfig = Omit<FromSchema<typeof themeConfigSchema>, 'openapi'> & {
+    openapi?: RedocConfigTypes;
+};
 export type RedocConfig = RedocConfigTypes;
 export type GraphQLConfig = GraphQLConfigTypes;
 export type ProductConfig = FromSchema<typeof productConfigSchema>;
@@ -23,13 +25,13 @@ export type ScorecardConfig = FromSchema<typeof scorecardConfigSchema>;
 /**
  * Root
  */
-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>;
 };
 export type RedirectConfig = FromSchema<typeof redirectConfigSchema>;
 export type RedirectsConfig = FromSchema<typeof redirectsConfigSchema>;
 export type AuthProviderConfig = FromSchema<typeof authProviderConfigSchema>;
-export type BasicAuthProviderConfig = FromSchema<typeof basicAuthProviderConfigSchema>;
 export type OidcProviderConfig = FromSchema<typeof oidcProviderConfigSchema>;
 export type Saml2ProviderConfig = FromSchema<typeof saml2ProviderConfigSchema>;
 export type SeoConfig = FromSchema<typeof seoConfigSchema>;
@@ -43,4 +45,11 @@ export type ApigeeAdapterAuthOauth2 = FromSchema<typeof apigeeAdapterAuthOauth2S
 export type ApigeeAdapterAuthServiceAccount = FromSchema<typeof apigeeAdapterAuthServiceAccountSchema>;
 export type SsoConfig = FromSchema<typeof ssoOnPremConfigSchema>;
 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/lib-esm/constants.d.ts

@@ -1,8 +1,7 @@
 export declare const DEFAULT_TEAM_CLAIM_NAME = "https://redocly.com/sso/teams";
 export declare enum AuthProviderType {
     OIDC = "OIDC",
-    SAML2 = "SAML2",
-    BASIC = "BASIC"
+    SAML2 = "SAML2"
 }
 export declare enum ApigeeDevOnboardingIntegrationAuthType {
     SERVICE_ACCOUNT = "SERVICE_ACCOUNT",

package/lib-esm/constants.js

@@ -3,7 +3,6 @@ export var AuthProviderType;
 (function (AuthProviderType) {
     AuthProviderType["OIDC"] = "OIDC";
     AuthProviderType["SAML2"] = "SAML2";
-    AuthProviderType["BASIC"] = "BASIC";
 })(AuthProviderType || (AuthProviderType = {}));
 export var ApigeeDevOnboardingIntegrationAuthType;
 (function (ApigeeDevOnboardingIntegrationAuthType) {