@redocly/config 0.43.0 → 0.44.0

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

@@ -1,4 +1,5 @@
-import { DEFAULT_TEAM_CLAIM_NAME, AuthProviderType, ApigeeDevOnboardingIntegrationAuthType, } from './constants';
+import { DEFAULT_TEAM_CLAIM_NAME, AuthProviderType, ApigeeDevOnboardingIntegrationAuthType, } from './constants/shared';
+import { CONFIG_NODE_TYPE_NAMES } from './constants/config';
 import { themeConfigSchema } from './default-theme-config-schema';
 import { feedbackConfigSchema } from './feedback-config-schema';
 import { graphqlConfigSchema } from './graphql-config-schema';
@@ -7,7 +8,7 @@ import { reuniteConfigSchema } from './reunite-config-schema';
 import { analyticsConfigSchema, breadcrumbsConfigSchema, catalogsConfigSchema, codeSnippetConfigSchema, colorModeConfigSchema, footerConfigSchema, linksConfigSchema, logoConfigSchema, markdownConfigSchema, navbarConfigSchema, navigationConfigSchema, openapiConfigSchema, productsConfigSchema, scorecardConfigSchema, scriptsConfigSchema, searchConfigSchema, aiAssistantSchema, sidebarConfigSchema, userMenuConfigSchema, versionPickerConfigSchema, } from './ex-theme-config-schemas';
 import { entitiesCatalogConfigSchema } from './entities-catalog-config-schema';
 import { scorecardsConfigSchema } from './scorecards-config-schema';
-import { ruleSchemas, preprocessorSchemas, decoratorsSchemas } from './common';
+import { configGovernanceSchema } from './common';
 export const oidcIssuerMetadataSchema = {
     type: 'object',
     properties: {
@@ -93,11 +94,17 @@ export const redirectConfigSchema = {
         type: { type: 'number', default: 301 },
     },
     additionalProperties: false,
+    nodeTypeName: 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',
 };
 export const redirectsConfigSchema = {
     type: 'object',
     additionalProperties: redirectConfigSchema,
     default: {},
+    nodeTypeName: 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',
 };
 export const bannerColorSchema = {
     type: 'string',
@@ -127,7 +134,7 @@ export const bannersConfigSchema = {
 };
 export const 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: openapiConfigSchema, graphql: graphqlConfigSchema, 
+    properties: Object.assign({ root: { type: 'string' }, output: { type: 'string', pattern: '(.ya?ml|.json)$' }, rbac: { type: 'object', additionalProperties: true }, openapi: openapiConfigSchema, graphql: graphqlConfigSchema, 
         /**
          * @deprecated left for backwards compatibility
          */
@@ -138,7 +145,7 @@ export const apiConfigSchema = {
                 graphql: graphqlConfigSchema,
             },
             additionalProperties: false,
-        }, title: { type: 'string' }, metadata: { type: 'object', additionalProperties: true } }, ruleSchemas), preprocessorSchemas), decoratorsSchemas), { extends: { type: 'array', items: { type: 'string' } } }),
+        }, title: { type: 'string' }, metadata: { type: 'object', additionalProperties: true } }, configGovernanceSchema),
     required: ['root'],
 };
 const metadataConfigSchema = {
@@ -494,7 +501,7 @@ export const accessConfigSchema = {
 };
 export const redoclyConfigSchema = {
     type: 'object',
-    properties: Object.assign(Object.assign(Object.assign(Object.assign({ 
+    properties: Object.assign(Object.assign({ 
         /**
          * @deprecated Should use `plugins` instead
          */
@@ -519,7 +526,7 @@ export const redoclyConfigSchema = {
         }, apis: {
             type: 'object',
             additionalProperties: apiConfigSchema,
-        }, extends: { type: 'array', items: { type: 'string' } } }, ruleSchemas), decoratorsSchemas), preprocessorSchemas), { ssoDirect: ssoDirectConfigSchema, sso: ssoConfigSchema, residency: residencySchema, logoutReturnUrl: logoutReturnUrlSchema, access: accessConfigSchema, developerOnboarding: devOnboardingConfigSchema, removeAttribution: { type: 'boolean' }, i18n: l10nConfigSchema, l10n: l10nConfigSchema, metadata: metadataConfigSchema, metadataGlobs: metadataGlobsConfigSchema, ignore: { type: 'array', items: { type: 'string' } }, 
+        } }, configGovernanceSchema), { ssoDirect: ssoDirectConfigSchema, sso: ssoConfigSchema, residency: residencySchema, logoutReturnUrl: logoutReturnUrlSchema, access: accessConfigSchema, developerOnboarding: devOnboardingConfigSchema, removeAttribution: { type: 'boolean' }, i18n: l10nConfigSchema, l10n: l10nConfigSchema, metadata: metadataConfigSchema, metadataGlobs: metadataGlobsConfigSchema, ignore: { type: 'array', items: { type: 'string' } }, 
         /**
          * @deprecated properties moved to the root of the config
          */
@@ -533,7 +540,7 @@ export const redoclyConfigSchema = {
         /**
          * @deprecated Should use `scorecardClassic` instead
          */
-        scorecard: scorecardConfigSchema, scorecards: scorecardsConfigSchema, scorecardClassic: scorecardConfigSchema, mcp: mcpConfigSchema, banner: bannersConfigSchema }),
+        scorecard: scorecardConfigSchema, scorecardClassic: scorecardConfigSchema, scorecards: scorecardsConfigSchema, mcp: mcpConfigSchema, banner: bannersConfigSchema }),
     default: { redirects: {}, seo: seoConfigSchema.default },
     additionalProperties: true,
 };

package/lib-esm/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-esm/scorecards-config-schema.js

@@ -1,3 +1,4 @@
+import { configGovernanceSchema } from './common';
 const comparisonOperatorSchema = {
     type: 'string',
     enum: [
@@ -175,10 +176,7 @@ const levelSchema = {
     type: 'object',
     properties: {
         name: { type: 'string' },
-        extends: {
-            type: 'array',
-            items: { type: 'string' },
-        },
+        extends: configGovernanceSchema.extends,
         rules: levelRulesSchema,
     },
     required: ['name'],

package/lib-esm/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/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@redocly/config",
-  "version": "0.43.0",
+  "version": "0.44.0",
   "license": "MIT",
   "main": "./lib/index.js",
   "module": "./lib-esm/index.js",
   "types": "./lib/index.d.ts",
   "devDependencies": {
     "@markdoc/markdoc": "0.5.2",
-    "@redocly/openapi-core": "2.17.0",
+    "@redocly/openapi-core": "2.19.2",
     "@types/node": "22.18.13",
     "@types/react": "^19.2.7",
     "@vitest/coverage-v8": "4.0.10",

package/lib/constants.d.ts

@@ -1,38 +0,0 @@
-export declare const DEFAULT_TEAM_CLAIM_NAME = "https://redocly.com/sso/teams";
-export declare enum AuthProviderType {
-    OIDC = "OIDC",
-    SAML2 = "SAML2"
-}
-export declare enum ApigeeDevOnboardingIntegrationAuthType {
-    SERVICE_ACCOUNT = "SERVICE_ACCOUNT",
-    OAUTH2 = "OAUTH2"
-}
-export declare const REDOCLY_TEAMS_RBAC = "redocly::teams-rbac";
-export declare const REDOCLY_ROUTE_RBAC = "redocly::route-rbac";
-export declare enum LayoutVariant {
-    STACKED = "stacked",
-    THREE_PANEL = "three-panel"
-}
-export declare const ENTITY_RELATION_TYPES: readonly ["partOf", "hasParts", "creates", "createdBy", "owns", "ownedBy", "implements", "implementedBy", "dependsOn", "dependencyOf", "uses", "usedBy", "produces", "consumes", "linksTo", "supersedes", "supersededBy", "compatibleWith", "extends", "extendedBy", "relatesTo", "hasMember", "memberOf", "triggers", "triggeredBy", "returns", "returnedBy"];
-export declare const NODE_TYPE_NAMES: {
-    readonly USER_ENTITY: "UserEntity";
-    readonly USER_ENTITY_METADATA: "UserEntityMetadata";
-    readonly API_DESCRIPTION_ENTITY: "ApiDescriptionEntity";
-    readonly API_DESCRIPTION_METADATA: "ApiDescriptionEntityMetadata";
-    readonly API_OPERATION_ENTITY: "ApiOperationEntity";
-    readonly API_OPERATION_METADATA: "ApiOperationEntityMetadata";
-    readonly DATA_SCHEMA_ENTITY: "DataSchemaEntity";
-    readonly DATA_SCHEMA_METADATA: "DataSchemaEntityMetadata";
-    readonly SERVICE_ENTITY: "ServiceEntity";
-    readonly DOMAIN_ENTITY: "DomainEntity";
-    readonly TEAM_ENTITY: "TeamEntity";
-    readonly ENTITY: "Entity";
-    readonly ENTITY_METADATA: "EntityMetadata";
-    readonly ENTITY_LINK_LIST: "EntityLinkList";
-    readonly ENTITY_LINK: "EntityLink";
-    readonly ENTITY_RELATION: "EntityRelation";
-    readonly ENTITY_RELATION_LIST: "EntityRelationList";
-    readonly ENTITY_CONTACT: "EntityContact";
-    readonly SLACK_CONTACT: "EntitySlackContact";
-    readonly SLACK_CHANNEL: "EntitySlackChannel";
-};

package/lib/constants.js

@@ -1,73 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.NODE_TYPE_NAMES = exports.ENTITY_RELATION_TYPES = exports.LayoutVariant = exports.REDOCLY_ROUTE_RBAC = exports.REDOCLY_TEAMS_RBAC = exports.ApigeeDevOnboardingIntegrationAuthType = exports.AuthProviderType = exports.DEFAULT_TEAM_CLAIM_NAME = void 0;
-exports.DEFAULT_TEAM_CLAIM_NAME = 'https://redocly.com/sso/teams';
-var AuthProviderType;
-(function (AuthProviderType) {
-    AuthProviderType["OIDC"] = "OIDC";
-    AuthProviderType["SAML2"] = "SAML2";
-})(AuthProviderType || (exports.AuthProviderType = AuthProviderType = {}));
-var ApigeeDevOnboardingIntegrationAuthType;
-(function (ApigeeDevOnboardingIntegrationAuthType) {
-    ApigeeDevOnboardingIntegrationAuthType["SERVICE_ACCOUNT"] = "SERVICE_ACCOUNT";
-    ApigeeDevOnboardingIntegrationAuthType["OAUTH2"] = "OAUTH2";
-})(ApigeeDevOnboardingIntegrationAuthType || (exports.ApigeeDevOnboardingIntegrationAuthType = ApigeeDevOnboardingIntegrationAuthType = {}));
-exports.REDOCLY_TEAMS_RBAC = 'redocly::teams-rbac';
-exports.REDOCLY_ROUTE_RBAC = 'redocly::route-rbac';
-var LayoutVariant;
-(function (LayoutVariant) {
-    LayoutVariant["STACKED"] = "stacked";
-    LayoutVariant["THREE_PANEL"] = "three-panel";
-})(LayoutVariant || (exports.LayoutVariant = LayoutVariant = {}));
-exports.ENTITY_RELATION_TYPES = [
-    'partOf',
-    'hasParts',
-    'creates',
-    'createdBy',
-    'owns',
-    'ownedBy',
-    'implements',
-    'implementedBy',
-    'dependsOn',
-    'dependencyOf',
-    'uses',
-    'usedBy',
-    'produces',
-    'consumes',
-    'linksTo',
-    'supersedes',
-    'supersededBy',
-    'compatibleWith',
-    'extends',
-    'extendedBy',
-    'relatesTo',
-    'hasMember',
-    'memberOf',
-    'triggers',
-    'triggeredBy',
-    'returns',
-    'returnedBy',
-];
-exports.NODE_TYPE_NAMES = {
-    USER_ENTITY: 'UserEntity',
-    USER_ENTITY_METADATA: 'UserEntityMetadata',
-    API_DESCRIPTION_ENTITY: 'ApiDescriptionEntity',
-    API_DESCRIPTION_METADATA: 'ApiDescriptionEntityMetadata',
-    API_OPERATION_ENTITY: 'ApiOperationEntity',
-    API_OPERATION_METADATA: 'ApiOperationEntityMetadata',
-    DATA_SCHEMA_ENTITY: 'DataSchemaEntity',
-    DATA_SCHEMA_METADATA: 'DataSchemaEntityMetadata',
-    SERVICE_ENTITY: 'ServiceEntity',
-    DOMAIN_ENTITY: 'DomainEntity',
-    TEAM_ENTITY: 'TeamEntity',
-    ENTITY: 'Entity',
-    ENTITY_METADATA: 'EntityMetadata',
-    ENTITY_LINK_LIST: 'EntityLinkList',
-    ENTITY_LINK: 'EntityLink',
-    ENTITY_RELATION: 'EntityRelation',
-    ENTITY_RELATION_LIST: 'EntityRelationList',
-    ENTITY_CONTACT: 'EntityContact',
-    SLACK_CONTACT: 'EntitySlackContact',
-    SLACK_CHANNEL: 'EntitySlackChannel',
-};
-//# sourceMappingURL=constants.js.map

package/lib-esm/constants.d.ts

@@ -1,38 +0,0 @@
-export declare const DEFAULT_TEAM_CLAIM_NAME = "https://redocly.com/sso/teams";
-export declare enum AuthProviderType {
-    OIDC = "OIDC",
-    SAML2 = "SAML2"
-}
-export declare enum ApigeeDevOnboardingIntegrationAuthType {
-    SERVICE_ACCOUNT = "SERVICE_ACCOUNT",
-    OAUTH2 = "OAUTH2"
-}
-export declare const REDOCLY_TEAMS_RBAC = "redocly::teams-rbac";
-export declare const REDOCLY_ROUTE_RBAC = "redocly::route-rbac";
-export declare enum LayoutVariant {
-    STACKED = "stacked",
-    THREE_PANEL = "three-panel"
-}
-export declare const ENTITY_RELATION_TYPES: readonly ["partOf", "hasParts", "creates", "createdBy", "owns", "ownedBy", "implements", "implementedBy", "dependsOn", "dependencyOf", "uses", "usedBy", "produces", "consumes", "linksTo", "supersedes", "supersededBy", "compatibleWith", "extends", "extendedBy", "relatesTo", "hasMember", "memberOf", "triggers", "triggeredBy", "returns", "returnedBy"];
-export declare const NODE_TYPE_NAMES: {
-    readonly USER_ENTITY: "UserEntity";
-    readonly USER_ENTITY_METADATA: "UserEntityMetadata";
-    readonly API_DESCRIPTION_ENTITY: "ApiDescriptionEntity";
-    readonly API_DESCRIPTION_METADATA: "ApiDescriptionEntityMetadata";
-    readonly API_OPERATION_ENTITY: "ApiOperationEntity";
-    readonly API_OPERATION_METADATA: "ApiOperationEntityMetadata";
-    readonly DATA_SCHEMA_ENTITY: "DataSchemaEntity";
-    readonly DATA_SCHEMA_METADATA: "DataSchemaEntityMetadata";
-    readonly SERVICE_ENTITY: "ServiceEntity";
-    readonly DOMAIN_ENTITY: "DomainEntity";
-    readonly TEAM_ENTITY: "TeamEntity";
-    readonly ENTITY: "Entity";
-    readonly ENTITY_METADATA: "EntityMetadata";
-    readonly ENTITY_LINK_LIST: "EntityLinkList";
-    readonly ENTITY_LINK: "EntityLink";
-    readonly ENTITY_RELATION: "EntityRelation";
-    readonly ENTITY_RELATION_LIST: "EntityRelationList";
-    readonly ENTITY_CONTACT: "EntityContact";
-    readonly SLACK_CONTACT: "EntitySlackContact";
-    readonly SLACK_CHANNEL: "EntitySlackChannel";
-};

package/lib-esm/constants.js

@@ -1,70 +0,0 @@
-export const DEFAULT_TEAM_CLAIM_NAME = 'https://redocly.com/sso/teams';
-export var AuthProviderType;
-(function (AuthProviderType) {
-    AuthProviderType["OIDC"] = "OIDC";
-    AuthProviderType["SAML2"] = "SAML2";
-})(AuthProviderType || (AuthProviderType = {}));
-export var ApigeeDevOnboardingIntegrationAuthType;
-(function (ApigeeDevOnboardingIntegrationAuthType) {
-    ApigeeDevOnboardingIntegrationAuthType["SERVICE_ACCOUNT"] = "SERVICE_ACCOUNT";
-    ApigeeDevOnboardingIntegrationAuthType["OAUTH2"] = "OAUTH2";
-})(ApigeeDevOnboardingIntegrationAuthType || (ApigeeDevOnboardingIntegrationAuthType = {}));
-export const REDOCLY_TEAMS_RBAC = 'redocly::teams-rbac';
-export const REDOCLY_ROUTE_RBAC = 'redocly::route-rbac';
-export var LayoutVariant;
-(function (LayoutVariant) {
-    LayoutVariant["STACKED"] = "stacked";
-    LayoutVariant["THREE_PANEL"] = "three-panel";
-})(LayoutVariant || (LayoutVariant = {}));
-export const ENTITY_RELATION_TYPES = [
-    'partOf',
-    'hasParts',
-    'creates',
-    'createdBy',
-    'owns',
-    'ownedBy',
-    'implements',
-    'implementedBy',
-    'dependsOn',
-    'dependencyOf',
-    'uses',
-    'usedBy',
-    'produces',
-    'consumes',
-    'linksTo',
-    'supersedes',
-    'supersededBy',
-    'compatibleWith',
-    'extends',
-    'extendedBy',
-    'relatesTo',
-    'hasMember',
-    'memberOf',
-    'triggers',
-    'triggeredBy',
-    'returns',
-    'returnedBy',
-];
-export const NODE_TYPE_NAMES = {
-    USER_ENTITY: 'UserEntity',
-    USER_ENTITY_METADATA: 'UserEntityMetadata',
-    API_DESCRIPTION_ENTITY: 'ApiDescriptionEntity',
-    API_DESCRIPTION_METADATA: 'ApiDescriptionEntityMetadata',
-    API_OPERATION_ENTITY: 'ApiOperationEntity',
-    API_OPERATION_METADATA: 'ApiOperationEntityMetadata',
-    DATA_SCHEMA_ENTITY: 'DataSchemaEntity',
-    DATA_SCHEMA_METADATA: 'DataSchemaEntityMetadata',
-    SERVICE_ENTITY: 'ServiceEntity',
-    DOMAIN_ENTITY: 'DomainEntity',
-    TEAM_ENTITY: 'TeamEntity',
-    ENTITY: 'Entity',
-    ENTITY_METADATA: 'EntityMetadata',
-    ENTITY_LINK_LIST: 'EntityLinkList',
-    ENTITY_LINK: 'EntityLink',
-    ENTITY_RELATION: 'EntityRelation',
-    ENTITY_RELATION_LIST: 'EntityRelationList',
-    ENTITY_CONTACT: 'EntityContact',
-    SLACK_CONTACT: 'EntitySlackContact',
-    SLACK_CHANNEL: 'EntitySlackChannel',
-};
-//# sourceMappingURL=constants.js.map