ecabs-components 1.2.0 → 1.2.1

package/lib/base/models/sidebar.models.d.ts

@@ -3,21 +3,19 @@ export interface SidebarMenuItem<TEnv = unknown, TRole = unknown> {
     icon?: string;
     url?: string;
     expand?: boolean;
-    subItems?: SidebarMenuItem[];
-    permissions?: PermissionValueEnum<string>[];
+    subItems?: SidebarMenuItem<TEnv, TRole>[];
+    permissions?: string[];
     iconResource?: SidebarIconResource;
     badge?: string;
     isVisible?: (context: MenuItemVisibilityContext<TEnv, TRole>) => boolean;
+    isBadgeVisible?: (context: MenuItemVisibilityContext<TEnv, TRole>) => boolean;
 }
 export interface MenuItemVisibilityContext<TEnv, TRole> {
     environment: TEnv;
-    role: TRole;
+    role?: TRole;
+    tenantFeatures?: string[];
 }
 export interface SidebarIconResource {
     path: string;
     name: string;
 }
-interface PermissionValueEnum<T extends string> {
-    values: Record<T, string>;
-}
-export {};

package/lib/base/utils/menu-utils.d.ts

@@ -1,2 +1,11 @@
-import { SidebarMenuItem } from '../models/sidebar.models';
+import { MenuItemVisibilityContext, SidebarMenuItem } from '../models/sidebar.models';
 export declare function matchMenuToUrl(url: string, menu: SidebarMenuItem[]): SidebarMenuItem;
+/**
+ * Returns copies of the menu items the user should see, never changing `menu`.
+ *
+ * Permissions are checked only when `permissions` is given: `undefined` skips the
+ * check, while `[]` checks against a user with no claims. An item shows when it has
+ * no `permissions`, includes `'allow'`, or the user holds any one of them.
+ * Then each item's `isVisible` and `isBadgeVisible` run, and groups left empty are removed.
+ */
+export declare function filterMenuItems<TEnv, TRole>(menu: SidebarMenuItem<TEnv, TRole>[], context: MenuItemVisibilityContext<TEnv, TRole>, permissions?: string[]): SidebarMenuItem<TEnv, TRole>[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ecabs-components",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "peerDependencies": {
     "@angular/animations": "^16.2.12",
     "@angular/common": "^16.2.12",

package/public-api.d.ts

@@ -149,6 +149,7 @@ export * from './lib/base/utils/object-utils';
 export * from './lib/base/utils/phone-number.utils';
 export * from './lib/base/utils/icon.utils';
 export * from './lib/base/utils/select.utils';
+export * from './lib/base/utils/menu-utils';
 export * from './lib/base/consts/badge.consts';
 export * from './lib/base/consts/status-badge.consts';
 export * from './lib/base/consts/icon.consts';