@redocly/config 0.43.0 → 0.44.1

package/lib/root-config-schema.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.rootRedoclyConfigSchema = exports.redoclyConfigSchema = exports.accessConfigSchema = exports.l10nConfigSchema = exports.devOnboardingAdapterConfigSchema = exports.apigeeEdgeAdapterConfigSchema = exports.apigeeXAdapterConfigSchema = exports.apigeeAdapterAuthServiceAccountSchema = exports.apigeeAdapterAuthOauth2Schema = exports.graviteeAdapterConfigSchema = exports.graviteeAdapterAuthIdpSchema = exports.graviteeAdapterAuthStaticSchema = exports.rbacConfigSchema = exports.rbacEntitiesCatalogConfigSchema = exports.apiFunctionsConfigSchema = exports.seoConfigSchema = exports.apiConfigSchema = exports.bannersConfigSchema = exports.bannerConfigSchema = exports.rbacScopeItemsSchema = exports.bannerColorSchema = exports.redirectsConfigSchema = exports.redirectConfigSchema = exports.ssoConfigSchema = exports.ssoDirectConfigSchema = exports.authProviderConfigSchema = exports.saml2ProviderConfigSchema = exports.oidcProviderConfigSchema = exports.oidcIssuerMetadataSchema = void 0;
-const constants_1 = require("./constants");
+const shared_1 = require("./constants/shared");
+const config_1 = require("./constants/config");
 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");
@@ -25,7 +26,7 @@ exports.oidcIssuerMetadataSchema = {
 exports.oidcProviderConfigSchema = {
     type: 'object',
     properties: {
-        type: { type: 'string', const: constants_1.AuthProviderType.OIDC },
+        type: { type: 'string', const: shared_1.AuthProviderType.OIDC },
         title: { type: 'string' },
         pkce: { type: 'boolean', default: false },
         configurationUrl: { type: 'string', minLength: 1 },
@@ -49,13 +50,13 @@ exports.oidcProviderConfigSchema = {
 exports.saml2ProviderConfigSchema = {
     type: 'object',
     properties: {
-        type: { type: 'string', const: constants_1.AuthProviderType.SAML2 },
+        type: { type: 'string', const: shared_1.AuthProviderType.SAML2 },
         title: { type: 'string' },
         issuerId: { type: 'string' },
         entityId: { type: 'string' },
         ssoUrl: { type: 'string' },
         x509PublicCert: { type: 'string' },
-        teamsAttributeName: { type: 'string', default: constants_1.DEFAULT_TEAM_CLAIM_NAME },
+        teamsAttributeName: { type: 'string', default: shared_1.DEFAULT_TEAM_CLAIM_NAME },
         teamsAttributeMap: { type: 'object', additionalProperties: { type: 'string' } },
         defaultTeams: { type: 'array', items: { type: 'string' } },
     },
@@ -96,11 +97,17 @@ exports.redirectConfigSchema = {
         type: { type: 'number', default: 301 },
     },
     additionalProperties: false,
+    nodeTypeName: config_1.CONFIG_NODE_TYPE_NAMES.RedirectSource,
+    description: 'Source is an absolute path that must start with a forward slash.',
+    documentationLink: 'https://redocly.com/docs/realm/config/redirects#sources-map',
 };
 exports.redirectsConfigSchema = {
     type: 'object',
     additionalProperties: exports.redirectConfigSchema,
     default: {},
+    nodeTypeName: config_1.CONFIG_NODE_TYPE_NAMES.Redirects,
+    description: 'Use redirects to change which resource a URL points to, maintaining working links when you move, rename, or restructure content.',
+    documentationLink: 'https://redocly.com/docs/realm/config/redirects',
 };
 exports.bannerColorSchema = {
     type: 'string',
@@ -130,7 +137,7 @@ exports.bannersConfigSchema = {
 };
 exports.apiConfigSchema = {
     type: 'object',
-    properties: Object.assign(Object.assign(Object.assign(Object.assign({ 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, 
+    properties: Object.assign({ 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
          */
@@ -141,7 +148,7 @@ exports.apiConfigSchema = {
                 graphql: graphql_config_schema_1.graphqlConfigSchema,
             },
             additionalProperties: false,
-        }, title: { type: 'string' }, metadata: { type: 'object', additionalProperties: true } }, common_1.ruleSchemas), common_1.preprocessorSchemas), common_1.decoratorsSchemas), { extends: { type: 'array', items: { type: 'string' } } }),
+        }, title: { type: 'string' }, metadata: { type: 'object', additionalProperties: true } }, common_1.configGovernanceSchema),
     required: ['root'],
 };
 const metadataConfigSchema = {
@@ -369,7 +376,7 @@ exports.graviteeAdapterConfigSchema = {
 exports.apigeeAdapterAuthOauth2Schema = {
     type: 'object',
     properties: {
-        type: { type: 'string', const: constants_1.ApigeeDevOnboardingIntegrationAuthType.OAUTH2 },
+        type: { type: 'string', const: shared_1.ApigeeDevOnboardingIntegrationAuthType.OAUTH2 },
         tokenEndpoint: { type: 'string' },
         clientId: { type: 'string' },
         clientSecret: { type: 'string' },
@@ -380,7 +387,7 @@ exports.apigeeAdapterAuthOauth2Schema = {
 exports.apigeeAdapterAuthServiceAccountSchema = {
     type: 'object',
     properties: {
-        type: { type: 'string', const: constants_1.ApigeeDevOnboardingIntegrationAuthType.SERVICE_ACCOUNT },
+        type: { type: 'string', const: shared_1.ApigeeDevOnboardingIntegrationAuthType.SERVICE_ACCOUNT },
         serviceAccountEmail: { type: 'string' },
         serviceAccountPrivateKey: { type: 'string' },
     },
@@ -497,7 +504,7 @@ exports.accessConfigSchema = {
 };
 exports.redoclyConfigSchema = {
     type: 'object',
-    properties: Object.assign(Object.assign(Object.assign(Object.assign({ 
+    properties: Object.assign(Object.assign({ 
         /**
          * @deprecated Should use `plugins` instead
          */
@@ -522,7 +529,7 @@ exports.redoclyConfigSchema = {
         }, apis: {
             type: 'object',
             additionalProperties: exports.apiConfigSchema,
-        }, extends: { type: 'array', items: { type: 'string' } } }, common_1.ruleSchemas), common_1.decoratorsSchemas), common_1.preprocessorSchemas), { ssoDirect: exports.ssoDirectConfigSchema, sso: exports.ssoConfigSchema, residency: residencySchema, logoutReturnUrl: logoutReturnUrlSchema, access: exports.accessConfigSchema, developerOnboarding: devOnboardingConfigSchema, removeAttribution: { type: 'boolean' }, i18n: exports.l10nConfigSchema, l10n: exports.l10nConfigSchema, metadata: metadataConfigSchema, metadataGlobs: metadataGlobsConfigSchema, ignore: { type: 'array', items: { type: 'string' } }, 
+        } }, common_1.configGovernanceSchema), { ssoDirect: exports.ssoDirectConfigSchema, sso: exports.ssoConfigSchema, residency: residencySchema, logoutReturnUrl: logoutReturnUrlSchema, access: exports.accessConfigSchema, developerOnboarding: devOnboardingConfigSchema, removeAttribution: { type: 'boolean' }, i18n: exports.l10nConfigSchema, l10n: exports.l10nConfigSchema, metadata: metadataConfigSchema, metadataGlobs: metadataGlobsConfigSchema, ignore: { type: 'array', items: { type: 'string' } }, 
         /**
          * @deprecated properties moved to the root of the config
          */
@@ -536,7 +543,7 @@ exports.redoclyConfigSchema = {
         /**
          * @deprecated Should use `scorecardClassic` instead
          */
-        scorecard: ex_theme_config_schemas_1.scorecardConfigSchema, scorecards: scorecards_config_schema_1.scorecardsConfigSchema, scorecardClassic: ex_theme_config_schemas_1.scorecardConfigSchema, mcp: mcpConfigSchema, banner: exports.bannersConfigSchema }),
+        scorecard: ex_theme_config_schemas_1.scorecardConfigSchema, scorecardClassic: ex_theme_config_schemas_1.scorecardConfigSchema, scorecards: scorecards_config_schema_1.scorecardsConfigSchema, mcp: mcpConfigSchema, banner: exports.bannersConfigSchema }),
     default: { redirects: {}, seo: exports.seoConfigSchema.default },
     additionalProperties: true,
 };

package/lib/scorecards-config-schema.d.ts

@@ -415,10 +415,13 @@ export declare const scorecardSchema: {
                         readonly type: "string";
                     };
                     readonly extends: {
+                        readonly nodeTypeName: undefined;
                         readonly type: "array";
                         readonly items: {
                             readonly type: "string";
                         };
+                        readonly description: "Use extends to inherit rules and their configurations from other rulesets.";
+                        readonly documentationLink: "https://redocly.com/docs/cli/configuration/reference/extends";
                     };
                     readonly rules: {
                         readonly type: "object";
@@ -1006,10 +1009,13 @@ export declare const scorecardsConfigSchema: {
                             readonly type: "string";
                         };
                         readonly extends: {
+                            readonly nodeTypeName: undefined;
                             readonly type: "array";
                             readonly items: {
                                 readonly type: "string";
                             };
+                            readonly description: "Use extends to inherit rules and their configurations from other rulesets.";
+                            readonly documentationLink: "https://redocly.com/docs/cli/configuration/reference/extends";
                         };
                         readonly rules: {
                             readonly type: "object";

package/lib/scorecards-config-schema.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.scorecardsConfigSchema = exports.scorecardSchema = void 0;
+const common_1 = require("./common");
 const comparisonOperatorSchema = {
     type: 'string',
     enum: [
@@ -178,10 +179,7 @@ const levelSchema = {
     type: 'object',
     properties: {
         name: { type: 'string' },
-        extends: {
-            type: 'array',
-            items: { type: 'string' },
-        },
+        extends: common_1.configGovernanceSchema.extends,
         rules: levelRulesSchema,
     },
     required: ['name'],

package/lib/types/asyncapi-types.d.ts

@@ -0,0 +1,14 @@
+import type { ComponentType } from 'react';
+import type { FromSchema } from 'json-schema-to-ts';
+import type { Schema, ConfigFunction } from '@markdoc/markdoc/dist/src/types';
+import type { asyncapiConfigSchema } from '../asyncapi-config-schema';
+export type AsyncApiConfigTypes = FromSchema<typeof asyncapiConfigSchema> & {
+    markdocOptions?: {
+        tags: Record<string, Schema>;
+        nodes: Record<string, Schema>;
+        components: Record<string, ComponentType>;
+        variables?: Record<string, any>;
+        partials?: Record<string, any>;
+        functions?: Record<string, ConfigFunction>;
+    };
+};

package/lib/types/asyncapi-types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=asyncapi-types.js.map

package/lib/types/config-types.d.ts

@@ -8,6 +8,7 @@ import type { productConfigSchema, productGoogleAnalyticsConfigSchema, markdownC
 import type { scorecardsConfigSchema } from '../scorecards-config-schema';
 import type { reuniteConfigSchema } from '../reunite-config-schema';
 import type { optionalEmailSettings, reasonsSettings } from '../feedback-config-schema';
+import type { AsyncApiConfigTypes } from './asyncapi-types';
 /**
  * @deprecated left for backwards compatibility. To be removed in Realm 1.0
  */
@@ -16,6 +17,7 @@ export type ThemeConfig = Omit<FromSchema<typeof themeConfigSchema>, 'openapi'>
 };
 export type RedocConfig = RedocConfigTypes;
 export type GraphQLConfig = GraphQLConfigTypes;
+export type AsyncApiConfig = AsyncApiConfigTypes;
 export type ProductConfig = FromSchema<typeof productConfigSchema>;
 export type ProductGoogleAnalyticsConfig = FromSchema<typeof productGoogleAnalyticsConfigSchema>;
 export type MarkdownConfig = FromSchema<typeof markdownConfigSchema>;

package/lib/types/portal-shared-types.d.ts

@@ -1,5 +1,5 @@
 import type { Node } from '@markdoc/markdoc/dist/src/types';
-import type { LayoutVariant, REDOCLY_ROUTE_RBAC, REDOCLY_TEAMS_RBAC } from '../constants';
+import type { LayoutVariant, REDOCLY_ROUTE_RBAC, REDOCLY_TEAMS_RBAC } from '../constants/shared';
 import type { ProductConfig, ProductGoogleAnalyticsConfig, RbacScopeItems, RedoclyConfig, SeoConfig } from './config-types';
 import type { CatalogEntityConfig } from './catalog-entity-types';
 export * from './code-walkthrough-types';

package/lib-esm/asyncapi-config-schema.d.ts

@@ -0,0 +1,300 @@
+export declare const asyncapiConfigSchema: {
+    readonly type: "object";
+    readonly properties: {
+        readonly downloadUrls: {
+            readonly type: "array";
+            readonly items: {
+                readonly type: "object";
+                readonly properties: {
+                    readonly title: {
+                        readonly type: "string";
+                    };
+                    readonly url: {
+                        readonly type: "string";
+                    };
+                };
+                readonly required: readonly ["url"];
+                readonly additionalProperties: false;
+            };
+        };
+        readonly apiLogo: {
+            readonly type: "object";
+            readonly properties: {
+                readonly imageUrl: {
+                    readonly type: "string";
+                };
+                readonly href: {
+                    readonly type: "string";
+                };
+                readonly altText: {
+                    readonly type: "string";
+                };
+                readonly backgroundColor: {
+                    readonly type: "string";
+                };
+            };
+        };
+        readonly jsonSamplesDepth: {
+            readonly type: "number";
+        };
+        readonly samplesMaxInlineArgs: {
+            readonly type: "number";
+        };
+        readonly fieldExpandLevel: {
+            readonly type: "number";
+        };
+        readonly baseUrlPath: {
+            readonly type: "string";
+        };
+        readonly metadata: {
+            readonly type: "object";
+            readonly properties: {
+                readonly apiId: {
+                    readonly type: "string";
+                };
+            };
+            readonly additionalProperties: true;
+        };
+        readonly feedback: {
+            readonly type: "object";
+            readonly properties: {
+                readonly hide: {
+                    readonly type: "boolean";
+                    readonly default: false;
+                };
+                readonly type: {
+                    readonly type: "string";
+                    readonly enum: readonly ["rating", "sentiment", "comment", "reasons", "mood", "scale"];
+                    readonly default: "sentiment";
+                };
+                readonly settings: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly label: {
+                            readonly type: "string";
+                        };
+                        readonly submitText: {
+                            readonly type: "string";
+                        };
+                        readonly buttonText: {
+                            readonly type: "string";
+                        };
+                        readonly component: {
+                            readonly type: "string";
+                            readonly enum: readonly ["radio", "checkbox"];
+                            readonly default: "checkbox";
+                        };
+                        readonly items: {
+                            readonly type: "array";
+                            readonly items: {
+                                readonly type: "string";
+                            };
+                            readonly minItems: 1;
+                        };
+                        readonly leftScaleLabel: {
+                            readonly type: "string";
+                        };
+                        readonly rightScaleLabel: {
+                            readonly type: "string";
+                        };
+                        readonly reasons: {
+                            readonly type: "object";
+                            readonly properties: {
+                                readonly like: {
+                                    readonly type: "object";
+                                    readonly properties: {
+                                        readonly hide: {
+                                            readonly type: "boolean";
+                                            readonly default: false;
+                                        };
+                                        readonly component: {
+                                            readonly type: "string";
+                                            readonly enum: readonly ["radio", "checkbox"];
+                                            readonly default: "checkbox";
+                                        };
+                                        readonly label: {
+                                            readonly type: "string";
+                                        };
+                                        readonly items: {
+                                            readonly type: "array";
+                                            readonly items: {
+                                                readonly type: "string";
+                                            };
+                                        };
+                                    };
+                                    readonly additionalProperties: false;
+                                };
+                                readonly dislike: {
+                                    readonly type: "object";
+                                    readonly properties: {
+                                        readonly hide: {
+                                            readonly type: "boolean";
+                                            readonly default: false;
+                                        };
+                                        readonly component: {
+                                            readonly type: "string";
+                                            readonly enum: readonly ["radio", "checkbox"];
+                                            readonly default: "checkbox";
+                                        };
+                                        readonly label: {
+                                            readonly type: "string";
+                                        };
+                                        readonly items: {
+                                            readonly type: "array";
+                                            readonly items: {
+                                                readonly type: "string";
+                                            };
+                                        };
+                                    };
+                                    readonly additionalProperties: false;
+                                };
+                                readonly satisfied: {
+                                    readonly type: "object";
+                                    readonly properties: {
+                                        readonly hide: {
+                                            readonly type: "boolean";
+                                            readonly default: false;
+                                        };
+                                        readonly component: {
+                                            readonly type: "string";
+                                            readonly enum: readonly ["radio", "checkbox"];
+                                            readonly default: "checkbox";
+                                        };
+                                        readonly label: {
+                                            readonly type: "string";
+                                        };
+                                        readonly items: {
+                                            readonly type: "array";
+                                            readonly items: {
+                                                readonly type: "string";
+                                            };
+                                        };
+                                    };
+                                    readonly additionalProperties: false;
+                                };
+                                readonly neutral: {
+                                    readonly type: "object";
+                                    readonly properties: {
+                                        readonly hide: {
+                                            readonly type: "boolean";
+                                            readonly default: false;
+                                        };
+                                        readonly component: {
+                                            readonly type: "string";
+                                            readonly enum: readonly ["radio", "checkbox"];
+                                            readonly default: "checkbox";
+                                        };
+                                        readonly label: {
+                                            readonly type: "string";
+                                        };
+                                        readonly items: {
+                                            readonly type: "array";
+                                            readonly items: {
+                                                readonly type: "string";
+                                            };
+                                        };
+                                    };
+                                    readonly additionalProperties: false;
+                                };
+                                readonly dissatisfied: {
+                                    readonly type: "object";
+                                    readonly properties: {
+                                        readonly hide: {
+                                            readonly type: "boolean";
+                                            readonly default: false;
+                                        };
+                                        readonly component: {
+                                            readonly type: "string";
+                                            readonly enum: readonly ["radio", "checkbox"];
+                                            readonly default: "checkbox";
+                                        };
+                                        readonly label: {
+                                            readonly type: "string";
+                                        };
+                                        readonly items: {
+                                            readonly type: "array";
+                                            readonly items: {
+                                                readonly type: "string";
+                                            };
+                                        };
+                                    };
+                                    readonly additionalProperties: false;
+                                };
+                                readonly hide: {
+                                    readonly type: "boolean";
+                                    readonly default: false;
+                                };
+                                readonly component: {
+                                    readonly type: "string";
+                                    readonly enum: readonly ["radio", "checkbox"];
+                                    readonly default: "checkbox";
+                                };
+                                readonly label: {
+                                    readonly type: "string";
+                                };
+                                readonly items: {
+                                    readonly type: "array";
+                                    readonly items: {
+                                        readonly type: "string";
+                                    };
+                                };
+                            };
+                            readonly additionalProperties: false;
+                        };
+                        readonly comment: {
+                            readonly type: "object";
+                            readonly properties: {
+                                readonly hide: {
+                                    readonly type: "boolean";
+                                    readonly default: false;
+                                };
+                                readonly label: {
+                                    readonly type: "string";
+                                };
+                                readonly likeLabel: {
+                                    readonly type: "string";
+                                };
+                                readonly dislikeLabel: {
+                                    readonly type: "string";
+                                };
+                                readonly satisfiedLabel: {
+                                    readonly type: "string";
+                                };
+                                readonly neutralLabel: {
+                                    readonly type: "string";
+                                };
+                                readonly dissatisfiedLabel: {
+                                    readonly type: "string";
+                                };
+                            };
+                            readonly additionalProperties: false;
+                        };
+                        readonly optionalEmail: {
+                            readonly type: "object";
+                            readonly properties: {
+                                readonly hide: {
+                                    readonly type: "boolean";
+                                    readonly default: false;
+                                };
+                                readonly label: {
+                                    readonly type: "string";
+                                };
+                                readonly placeholder: {
+                                    readonly type: "string";
+                                };
+                            };
+                            readonly additionalProperties: false;
+                        };
+                    };
+                    readonly additionalProperties: false;
+                };
+            };
+            readonly additionalProperties: false;
+        };
+        readonly layout: {
+            readonly type: "string";
+            readonly enum: readonly ["stacked", "three-panel"];
+        };
+    };
+    readonly additionalProperties: false;
+};

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

@@ -0,0 +1,50 @@
+import { feedbackConfigSchema } from './feedback-config-schema';
+import { downloadUrlsSchema } from './redoc-config-schema';
+export const asyncapiConfigSchema = {
+    type: 'object',
+    properties: {
+        downloadUrls: downloadUrlsSchema,
+        apiLogo: {
+            type: 'object',
+            properties: {
+                imageUrl: {
+                    type: 'string',
+                },
+                href: {
+                    type: 'string',
+                },
+                altText: {
+                    type: 'string',
+                },
+                backgroundColor: {
+                    type: 'string',
+                },
+            },
+        },
+        jsonSamplesDepth: {
+            type: 'number',
+        },
+        samplesMaxInlineArgs: {
+            type: 'number',
+        },
+        fieldExpandLevel: {
+            type: 'number',
+        },
+        baseUrlPath: {
+            type: 'string',
+        },
+        metadata: {
+            type: 'object',
+            properties: {
+                apiId: {
+                    type: 'string',
+                },
+            },
+            additionalProperties: true,
+        },
+        feedback: feedbackConfigSchema,
+        layout: { type: 'string', enum: ['stacked', 'three-panel'] },
+    },
+    additionalProperties: false,
+};
+//# sourceMappingURL=asyncapi-config-schema.js.map