@redocly/config 0.41.4 → 0.43.0

package/lib/root-config-schema.js

@@ -1,6 +1,6 @@
 "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.rbacScopeItemsSchema = exports.apiFunctionsConfigSchema = exports.seoConfigSchema = exports.apiConfigSchema = exports.bannersConfigSchema = exports.bannerConfigSchema = exports.bannerColorSchema = exports.redirectsConfigSchema = exports.redirectConfigSchema = exports.ssoConfigSchema = exports.ssoDirectConfigSchema = exports.authProviderConfigSchema = exports.saml2ProviderConfigSchema = exports.oidcProviderConfigSchema = exports.oidcIssuerMetadataSchema = void 0;
+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 default_theme_config_schema_1 = require("./default-theme-config-schema");
 const feedback_config_schema_1 = require("./feedback-config-schema");
@@ -107,6 +107,10 @@ exports.bannerColorSchema = {
     enum: ['info', 'success', 'warning', 'error'],
     default: 'info',
 };
+exports.rbacScopeItemsSchema = {
+    type: 'object',
+    additionalProperties: { type: 'string' },
+};
 exports.bannerConfigSchema = {
     type: 'object',
     properties: {
@@ -114,6 +118,7 @@ exports.bannerConfigSchema = {
         dismissible: { type: 'boolean', default: false },
         target: { type: 'string' },
         color: exports.bannerColorSchema,
+        rbac: exports.rbacScopeItemsSchema,
     },
     required: ['content'],
     additionalProperties: false,
@@ -257,9 +262,56 @@ exports.apiFunctionsConfigSchema = {
     },
     additionalProperties: false,
 };
-exports.rbacScopeItemsSchema = {
+exports.rbacEntitiesCatalogConfigSchema = {
     type: 'object',
-    additionalProperties: { type: 'string' },
+    properties: {
+        catalogs: {
+            type: 'object',
+            properties: {
+                all: exports.rbacScopeItemsSchema,
+                services: exports.rbacScopeItemsSchema,
+                domains: exports.rbacScopeItemsSchema,
+                teams: exports.rbacScopeItemsSchema,
+                users: exports.rbacScopeItemsSchema,
+                apiDescriptions: exports.rbacScopeItemsSchema,
+                dataSchemas: exports.rbacScopeItemsSchema,
+                apiOperations: exports.rbacScopeItemsSchema,
+            },
+            additionalProperties: exports.rbacScopeItemsSchema,
+        },
+        entitiesTypes: {
+            type: 'object',
+            properties: {
+                service: exports.rbacScopeItemsSchema,
+                domain: exports.rbacScopeItemsSchema,
+                team: exports.rbacScopeItemsSchema,
+                user: exports.rbacScopeItemsSchema,
+                apiDescription: exports.rbacScopeItemsSchema,
+                apiOperation: exports.rbacScopeItemsSchema,
+                dataSchema: exports.rbacScopeItemsSchema,
+            },
+            additionalProperties: exports.rbacScopeItemsSchema,
+        },
+        entitiesGroups: {
+            type: 'array',
+            items: {
+                type: 'object',
+                properties: {
+                    entities: { type: 'array', items: { type: 'string' } },
+                    config: exports.rbacScopeItemsSchema,
+                },
+                additionalProperties: false,
+            },
+        },
+        entities: {
+            type: 'object',
+            properties: {
+                '**': exports.rbacScopeItemsSchema,
+            },
+            additionalProperties: exports.rbacScopeItemsSchema,
+        },
+    },
+    additionalProperties: false,
 };
 exports.rbacConfigSchema = {
     type: 'object',
@@ -283,6 +335,7 @@ exports.rbacConfigSchema = {
             },
             additionalProperties: exports.rbacScopeItemsSchema,
         },
+        entitiesCatalog: exports.rbacEntitiesCatalogConfigSchema,
     },
     additionalProperties: exports.rbacScopeItemsSchema,
 };

package/lib/types/catalog-entity-types.d.ts

@@ -53,8 +53,8 @@ export type EntityContactFileSchema = FromSchema<typeof entityContactFileSchema>
 export type EntityLinkFileSchema = FromSchema<typeof entityLinkFileSchema>;
 export type EntityRelationFileSchema = FromSchema<typeof entityRelationFileSchema>;
 export type EntityBaseFileSchema = {
+    type: string;
     version?: string | null;
-    revision?: string;
     key: string;
     title: string;
     summary?: string | null;
@@ -63,7 +63,6 @@ export type EntityBaseFileSchema = {
     contact?: EntityContactFileSchema | null;
     links?: EntityLinkFileSchema[] | null;
     relations?: EntityRelationFileSchema[] | null;
-    type: string;
     metadata?: DefaultMetadataSchema | null;
 };
 export type EntityFileSchema = (Omit<EntityBaseFileSchema, 'type'> & {

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

@@ -60,6 +60,7 @@ export type ItemBadge = {
     name: string;
     color?: string;
     position?: 'before' | 'after';
+    icon?: string;
 };
 export type ResolvedNavGroupItem = {
     type: 'group';
@@ -81,6 +82,7 @@ export type ResolvedNavGroupItem = {
     separatorLine?: boolean;
     linePosition?: 'top' | 'bottom';
     routeSlug?: string;
+    badges?: ItemBadge[];
     active?: boolean;
     icon?: string;
     srcSet?: string;
@@ -258,6 +260,7 @@ export type NavItem = {
     $ref?: string;
     disconnect?: boolean;
     additionalProps?: Record<string, unknown>;
+    badges?: ItemBadge[];
 };
 export interface LogoConfig {
     image?: string;