@redocly/config - npm Package Compare versions

Comparing version 0.0.0-beta-20240318165323 to 0.0.0-beta-20240328173619

CHANGELOG.md

 # @redocly/config
 
-## 0.0.0-beta-20240318165323
+## 0.0.0-beta-20240328173619
 
 ### Patch Changes
 
-- 315e55a996: fix: Added a license for the config package.
+- 831d11b805: fix: Improve pattern-based RBAC support across pages, search and navigation data.
 
+## 0.1.5
+
+### Patch Changes
+
+- b940a4664: feat: Added support for pattern-based team access rules in RBAC config.
+
+## 0.1.4
+
+### Patch Changes
+
+- 315e55a99: fix: Added a license for the config package.
+
 ## 0.1.3
@@ -10,0 +22,0 @@

lib-esm/constants.d.ts

@@ -12,2 +12,3 @@ export declare const DEFAULT_TEAM_CLAIM_NAME = "https://redocly.com/sso/teams";
 export declare const REDOCLY_TEAMS_RBAC = "redocly::teams-rbac";
+export declare const REDOCLY_ROUTE_RBAC = "redocly::route-rbac";
 export declare enum LayoutVariant {
@@ -14,0 +15,0 @@ STACKED = "stacked",

lib-esm/constants.js

@@ -14,2 +14,3 @@ export const DEFAULT_TEAM_CLAIM_NAME = 'https://redocly.com/sso/teams';
 export const REDOCLY_TEAMS_RBAC = 'redocly::teams-rbac';
+export const REDOCLY_ROUTE_RBAC = 'redocly::route-rbac';
 export var LayoutVariant;
@@ -16,0 +17,0 @@ (function (LayoutVariant) {

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

@@ -510,3 +510,3 @@ const logoConfigSchema = {
                     type: 'object',
-                    properties: Object.assign({ text: { type: 'string', default: 'Next to {{label}}' } }, hideConfigSchema.properties),
+                    properties: Object.assign({ text: { type: 'string', default: 'Next page' } }, hideConfigSchema.properties),
                     additionalProperties: false,
@@ -517,3 +517,3 @@ default: {},
                     type: 'object',
-                    properties: Object.assign({ text: { type: 'string', default: 'Back to {{label}}' } }, hideConfigSchema.properties),
+                    properties: Object.assign({ text: { type: 'string', default: 'Previous page' } }, hideConfigSchema.properties),
                     additionalProperties: false,
@@ -520,0 +520,0 @@ default: {},

lib-esm/index.d.ts

@@ -5,2 +5,2 @@ export { rbacConfigSchema, rootRedoclyConfigSchema } from './root-config-schema';
 export * from './portal-shared-types';
-export { ApigeeDevOnboardingIntegrationAuthType, AuthProviderType, LayoutVariant, REDOCLY_TEAMS_RBAC, } from './constants';
+export { ApigeeDevOnboardingIntegrationAuthType, AuthProviderType, LayoutVariant, REDOCLY_TEAMS_RBAC, REDOCLY_ROUTE_RBAC, } from './constants';

lib-esm/index.js

@@ -5,3 +5,3 @@ export { rbacConfigSchema, rootRedoclyConfigSchema } from './root-config-schema';
 export * from './portal-shared-types';
-export { ApigeeDevOnboardingIntegrationAuthType, AuthProviderType, LayoutVariant, REDOCLY_TEAMS_RBAC, } from './constants';
+export { ApigeeDevOnboardingIntegrationAuthType, AuthProviderType, LayoutVariant, REDOCLY_TEAMS_RBAC, REDOCLY_ROUTE_RBAC, } from './constants';
 //# sourceMappingURL=index.js.map

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

 import type { Node } from '@markdoc/markdoc/dist/src/types';
-import type { LayoutVariant, REDOCLY_TEAMS_RBAC } from './constants';
+import type { LayoutVariant, REDOCLY_ROUTE_RBAC, REDOCLY_TEAMS_RBAC } from './constants';
 import type { ProductConfig, ProductGoogleAnalyticsConfig, RbacScopeItems, SeoConfig, ThemeConfig } from './types';
@@ -41,2 +41,3 @@ export type ThemeUIConfig = ThemeConfig & {
     separatorLine?: boolean;
+    linePosition?: 'top' | 'bottom';
     routeSlug?: string;
@@ -47,2 +48,6 @@ active?: boolean;
     [REDOCLY_TEAMS_RBAC]?: RbacScopeItems;
+    [REDOCLY_ROUTE_RBAC]?: {
+        slug?: string;
+        fsPath?: string;
+    };
     linkedSidebars?: string[];
@@ -69,2 +74,3 @@ languageInsensitive?: boolean;
     separatorLine?: boolean;
+    linePosition?: 'top' | 'bottom';
     routeSlug?: string;
@@ -75,2 +81,6 @@ active?: boolean;
     [REDOCLY_TEAMS_RBAC]?: RbacScopeItems;
+    [REDOCLY_ROUTE_RBAC]?: {
+        slug?: string;
+        fsPath?: string;
+    };
     linkedSidebars?: string[];
@@ -89,2 +99,3 @@ languageInsensitive?: boolean;
     versionFolderId?: string;
+    variant?: 'primary' | 'secondary';
     separatorLine?: boolean;
@@ -98,4 +109,8 @@ linePosition?: 'top' | 'bottom';
     srcSet?: string;
+    languageInsensitive?: boolean;
     [REDOCLY_TEAMS_RBAC]?: RbacScopeItems;
-    languageInsensitive?: boolean;
+    [REDOCLY_ROUTE_RBAC]?: {
+        slug?: string;
+        fsPath?: string;
+    };
 } | {
@@ -115,6 +130,10 @@ type: 'error';
     linkedSidebars?: string[];
-    [REDOCLY_TEAMS_RBAC]?: RbacScopeItems;
     icon?: string;
     srcSet?: string;
     languageInsensitive?: boolean;
+    [REDOCLY_TEAMS_RBAC]?: RbacScopeItems;
+    [REDOCLY_ROUTE_RBAC]?: {
+        slug?: string;
+        fsPath?: string;
+    };
 };
@@ -160,2 +179,3 @@ export type ResolvedNavItemWithLink = (ResolvedNavLinkItem | ResolvedNavGroupItem) & {
     name: string;
+    email?: string;
     picture: string;
@@ -216,2 +236,6 @@ logoutDisabled?: boolean;
     [REDOCLY_TEAMS_RBAC]?: RbacScopeItems;
+    [REDOCLY_ROUTE_RBAC]?: {
+        slug?: string;
+        fsPath?: string;
+    };
 };
@@ -258,3 +282,6 @@ export type VersionConfigItem = {
     };
+    [REDOCLY_ROUTE_RBAC]?: {
+        [key: string]: string;
+    };
     themeOverride?: ProductThemeOverrideConfig;
 };

lib-esm/root-config-schema.js

@@ -173,2 +173,5 @@ import { DEFAULT_TEAM_CLAIM_NAME, AuthProviderType, ApigeeDevOnboardingIntegrationAuthType, } from './constants';
     properties: {
+        teamNamePatterns: { type: 'array', items: { type: 'string' } },
+        teamFolders: { type: 'array', items: { type: 'string' } },
+        teamFoldersBaseRoles: rbacScopeItemsSchema,
         cms: rbacScopeItemsSchema,
@@ -175,0 +178,0 @@ reunite: rbacScopeItemsSchema,

lib/constants.d.ts

@@ -12,2 +12,3 @@ export declare const DEFAULT_TEAM_CLAIM_NAME = "https://redocly.com/sso/teams";
 export declare const REDOCLY_TEAMS_RBAC = "redocly::teams-rbac";
+export declare const REDOCLY_ROUTE_RBAC = "redocly::route-rbac";
 export declare enum LayoutVariant {
@@ -14,0 +15,0 @@ STACKED = "stacked",

lib/constants.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LayoutVariant = exports.REDOCLY_TEAMS_RBAC = exports.ApigeeDevOnboardingIntegrationAuthType = exports.AuthProviderType = exports.DEFAULT_TEAM_CLAIM_NAME = void 0;
+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';
@@ -17,2 +17,3 @@ var AuthProviderType;
 exports.REDOCLY_TEAMS_RBAC = 'redocly::teams-rbac';
+exports.REDOCLY_ROUTE_RBAC = 'redocly::route-rbac';
 var LayoutVariant;
@@ -19,0 +20,0 @@ (function (LayoutVariant) {

lib/default-theme-config-schema.js

@@ -513,3 +513,3 @@ "use strict";
                     type: 'object',
-                    properties: Object.assign({ text: { type: 'string', default: 'Next to {{label}}' } }, hideConfigSchema.properties),
+                    properties: Object.assign({ text: { type: 'string', default: 'Next page' } }, hideConfigSchema.properties),
                     additionalProperties: false,
@@ -520,3 +520,3 @@ default: {},
                     type: 'object',
-                    properties: Object.assign({ text: { type: 'string', default: 'Back to {{label}}' } }, hideConfigSchema.properties),
+                    properties: Object.assign({ text: { type: 'string', default: 'Previous page' } }, hideConfigSchema.properties),
                     additionalProperties: false,
@@ -523,0 +523,0 @@ default: {},

lib/index.d.ts

@@ -5,2 +5,2 @@ export { rbacConfigSchema, rootRedoclyConfigSchema } from './root-config-schema';
 export * from './portal-shared-types';
-export { ApigeeDevOnboardingIntegrationAuthType, AuthProviderType, LayoutVariant, REDOCLY_TEAMS_RBAC, } from './constants';
+export { ApigeeDevOnboardingIntegrationAuthType, AuthProviderType, LayoutVariant, REDOCLY_TEAMS_RBAC, REDOCLY_ROUTE_RBAC, } from './constants';

lib/index.js

@@ -17,3 +17,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.REDOCLY_TEAMS_RBAC = exports.LayoutVariant = exports.AuthProviderType = exports.ApigeeDevOnboardingIntegrationAuthType = exports.productConfigOverrideSchema = exports.productThemeOverrideSchema = exports.rootRedoclyConfigSchema = exports.rbacConfigSchema = void 0;
+exports.REDOCLY_ROUTE_RBAC = exports.REDOCLY_TEAMS_RBAC = exports.LayoutVariant = exports.AuthProviderType = exports.ApigeeDevOnboardingIntegrationAuthType = exports.productConfigOverrideSchema = exports.productThemeOverrideSchema = exports.rootRedoclyConfigSchema = exports.rbacConfigSchema = void 0;
 var root_config_schema_1 = require("./root-config-schema");
@@ -32,2 +32,3 @@ Object.defineProperty(exports, "rbacConfigSchema", { enumerable: true, get: function () { return root_config_schema_1.rbacConfigSchema; } });
 Object.defineProperty(exports, "REDOCLY_TEAMS_RBAC", { enumerable: true, get: function () { return constants_1.REDOCLY_TEAMS_RBAC; } });
+Object.defineProperty(exports, "REDOCLY_ROUTE_RBAC", { enumerable: true, get: function () { return constants_1.REDOCLY_ROUTE_RBAC; } });
 //# sourceMappingURL=index.js.map

lib/portal-shared-types.d.ts

 import type { Node } from '@markdoc/markdoc/dist/src/types';
-import type { LayoutVariant, REDOCLY_TEAMS_RBAC } from './constants';
+import type { LayoutVariant, REDOCLY_ROUTE_RBAC, REDOCLY_TEAMS_RBAC } from './constants';
 import type { ProductConfig, ProductGoogleAnalyticsConfig, RbacScopeItems, SeoConfig, ThemeConfig } from './types';
@@ -41,2 +41,3 @@ export type ThemeUIConfig = ThemeConfig & {
     separatorLine?: boolean;
+    linePosition?: 'top' | 'bottom';
     routeSlug?: string;
@@ -47,2 +48,6 @@ active?: boolean;
     [REDOCLY_TEAMS_RBAC]?: RbacScopeItems;
+    [REDOCLY_ROUTE_RBAC]?: {
+        slug?: string;
+        fsPath?: string;
+    };
     linkedSidebars?: string[];
@@ -69,2 +74,3 @@ languageInsensitive?: boolean;
     separatorLine?: boolean;
+    linePosition?: 'top' | 'bottom';
     routeSlug?: string;
@@ -75,2 +81,6 @@ active?: boolean;
     [REDOCLY_TEAMS_RBAC]?: RbacScopeItems;
+    [REDOCLY_ROUTE_RBAC]?: {
+        slug?: string;
+        fsPath?: string;
+    };
     linkedSidebars?: string[];
@@ -89,2 +99,3 @@ languageInsensitive?: boolean;
     versionFolderId?: string;
+    variant?: 'primary' | 'secondary';
     separatorLine?: boolean;
@@ -98,4 +109,8 @@ linePosition?: 'top' | 'bottom';
     srcSet?: string;
+    languageInsensitive?: boolean;
     [REDOCLY_TEAMS_RBAC]?: RbacScopeItems;
-    languageInsensitive?: boolean;
+    [REDOCLY_ROUTE_RBAC]?: {
+        slug?: string;
+        fsPath?: string;
+    };
 } | {
@@ -115,6 +130,10 @@ type: 'error';
     linkedSidebars?: string[];
-    [REDOCLY_TEAMS_RBAC]?: RbacScopeItems;
     icon?: string;
     srcSet?: string;
     languageInsensitive?: boolean;
+    [REDOCLY_TEAMS_RBAC]?: RbacScopeItems;
+    [REDOCLY_ROUTE_RBAC]?: {
+        slug?: string;
+        fsPath?: string;
+    };
 };
@@ -160,2 +179,3 @@ export type ResolvedNavItemWithLink = (ResolvedNavLinkItem | ResolvedNavGroupItem) & {
     name: string;
+    email?: string;
     picture: string;
@@ -216,2 +236,6 @@ logoutDisabled?: boolean;
     [REDOCLY_TEAMS_RBAC]?: RbacScopeItems;
+    [REDOCLY_ROUTE_RBAC]?: {
+        slug?: string;
+        fsPath?: string;
+    };
 };
@@ -258,3 +282,6 @@ export type VersionConfigItem = {
     };
+    [REDOCLY_ROUTE_RBAC]?: {
+        [key: string]: string;
+    };
     themeOverride?: ProductThemeOverrideConfig;
 };

lib/root-config-schema.js

@@ -176,2 +176,5 @@ "use strict";
     properties: {
+        teamNamePatterns: { type: 'array', items: { type: 'string' } },
+        teamFolders: { type: 'array', items: { type: 'string' } },
+        teamFoldersBaseRoles: exports.rbacScopeItemsSchema,
         cms: exports.rbacScopeItemsSchema,
@@ -178,0 +181,0 @@ reunite: exports.rbacScopeItemsSchema,

package.json

 {
   "name": "@redocly/config",
-  "version": "0.0.0-beta-20240318165323",
+  "version": "0.0.0-beta-20240328173619",
   "license": "MIT",
@@ -5,0 +5,0 @@ "main": "./lib/index.js",

src/constants.ts

@@ -13,2 +13,3 @@ export const DEFAULT_TEAM_CLAIM_NAME = 'https://redocly.com/sso/teams';
 export const REDOCLY_TEAMS_RBAC = 'redocly::teams-rbac';
+export const REDOCLY_ROUTE_RBAC = 'redocly::route-rbac';
 
@@ -15,0 +16,0 @@ export enum LayoutVariant {

src/default-theme-config-schema.ts

@@ -581,3 +581,3 @@ const logoConfigSchema = {
           properties: {
-            text: { type: 'string', default: 'Next to {{label}}' },
+            text: { type: 'string', default: 'Next page' },
             ...hideConfigSchema.properties,
@@ -591,3 +591,3 @@ },
           properties: {
-            text: { type: 'string', default: 'Back to {{label}}' },
+            text: { type: 'string', default: 'Previous page' },
             ...hideConfigSchema.properties,
@@ -594,0 +594,0 @@ },

src/index.ts

@@ -13,2 +13,3 @@ export { rbacConfigSchema, rootRedoclyConfigSchema } from './root-config-schema';
   REDOCLY_TEAMS_RBAC,
+  REDOCLY_ROUTE_RBAC,
 } from './constants';

src/portal-shared-types.ts

 import type { Node } from '@markdoc/markdoc/dist/src/types';
-import type { LayoutVariant, REDOCLY_TEAMS_RBAC } from './constants';
+import type { LayoutVariant, REDOCLY_ROUTE_RBAC, REDOCLY_TEAMS_RBAC } from './constants';
 import type {
@@ -52,2 +52,3 @@ ProductConfig,
   separatorLine?: boolean;
+  linePosition?: 'top' | 'bottom';
   routeSlug?: string;
@@ -58,2 +59,6 @@ active?: boolean;
   [REDOCLY_TEAMS_RBAC]?: RbacScopeItems;
+  [REDOCLY_ROUTE_RBAC]?: {
+    slug?: string;
+    fsPath?: string;
+  };
 
@@ -84,2 +89,3 @@ linkedSidebars?: string[];
   separatorLine?: boolean;
+  linePosition?: 'top' | 'bottom';
   routeSlug?: string;
@@ -90,2 +96,6 @@ active?: boolean;
   [REDOCLY_TEAMS_RBAC]?: RbacScopeItems;
+  [REDOCLY_ROUTE_RBAC]?: {
+    slug?: string;
+    fsPath?: string;
+  };
 
@@ -111,2 +121,3 @@ linkedSidebars?: string[];
 
+      variant?: 'primary' | 'secondary';
       separatorLine?: boolean;
@@ -118,7 +129,10 @@ linePosition?: 'top' | 'bottom';
       linkedSidebars?: string[]; // for typescript
-      icon?: string;
-      srcSet?: string;
+      icon?: string; // for typescript
+      srcSet?: string; // for typescript
+      languageInsensitive?: boolean; // for typescript
       [REDOCLY_TEAMS_RBAC]?: RbacScopeItems;
-
-      languageInsensitive?: boolean;
+      [REDOCLY_ROUTE_RBAC]?: {
+        slug?: string;
+        fsPath?: string;
+      };
     }
@@ -141,7 +155,10 @@ | {
       linkedSidebars?: string[]; // for typescript
+      icon?: string; // for typescript
+      srcSet?: string; // for typescript
+      languageInsensitive?: boolean; // for typescript
       [REDOCLY_TEAMS_RBAC]?: RbacScopeItems;
-
-      icon?: string; // for typescript
-      srcSet?: string;
-      languageInsensitive?: boolean;
+      [REDOCLY_ROUTE_RBAC]?: {
+        slug?: string;
+        fsPath?: string;
+      };
     };
@@ -193,2 +210,3 @@
   name: string;
+  email?: string;
   picture: string;
@@ -251,2 +269,6 @@ logoutDisabled?: boolean;
   [REDOCLY_TEAMS_RBAC]?: RbacScopeItems;
+  [REDOCLY_ROUTE_RBAC]?: {
+    slug?: string;
+    fsPath?: string;
+  };
 };
@@ -305,3 +327,4 @@
   [REDOCLY_TEAMS_RBAC]?: { [key: string]: string };
+  [REDOCLY_ROUTE_RBAC]?: { [key: string]: string };
   themeOverride?: ProductThemeOverrideConfig;
 };

src/root-config-schema.ts

@@ -191,2 +191,5 @@ import {
   properties: {
+    teamNamePatterns: { type: 'array', items: { type: 'string' } },
+    teamFolders: { type: 'array', items: { type: 'string' } },
+    teamFoldersBaseRoles: rbacScopeItemsSchema,
     cms: rbacScopeItemsSchema, // deprecated in favor of reunite
@@ -193,0 +196,0 @@ reunite: rbacScopeItemsSchema,

Fixed alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1434504

increased by0.65%

Lines of code

27144

increased by0.89%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes