@digitaldefiance/express-suite-react-components 5.0.1 → 5.0.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digitaldefiance/express-suite-react-components",
-  "version": "5.0.1",
+  "version": "5.0.3",
   "homepage": "https://github.com/Digital-Defiance/react-components",
   "description": "React MUI components for Digital Defiance Express Suite",
   "repository": {
@@ -24,7 +24,7 @@
     "prettier:fix": "prettier --write 'src/**/*.{ts,tsx}'",
     "format": "npx nx format:write --projects=digitaldefiance-express-suite-react-components",
     "format:check": "npx nx format:check --projects=digitaldefiance-express-suite-react-components",
-    "prepublishOnly": "npx nx build digitaldefiance-express-suite-react-components",
+    "prepublishOnly": "node -e \"if(!require('fs').existsSync('src/index.js')){console.error('Do not publish from the source package. Run: nx build digitaldefiance-express-suite-react-components, then npm publish from dist/packages/digitaldefiance-express-suite-react-components');process.exit(1)}\"",
     "publish:public": "npm publish --access public"
   },
   "peerDependencies": {

package/src/contexts/MenuContext.d.ts

@@ -6,6 +6,14 @@ interface MenuProviderProps {
     children: ReactNode;
     menuConfigs?: IMenuConfig[];
     enableBackupCodes?: boolean;
+    /**
+     * IDs of menu options to suppress from every menu. Matches both the built-in
+     * options (e.g. 'change-password', 'user-settings', 'logout') and any option
+     * registered via `menuConfigs`. Dividers left orphaned by the removal are
+     * cleaned up automatically. Defaults to none hidden, so existing consumers are
+     * unaffected.
+     */
+    hiddenMenuIds?: readonly string[];
 }
 interface MenuContextType {
     menuOptions: IMenuOption[];

package/src/contexts/MenuContext.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"MenuContext.d.ts","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-express-suite-react-components/src/contexts/MenuContext.tsx"],"names":[],"mappings":"AAqBA,OAAO,EACL,EAAE,EACF,SAAS,EAQV,MAAM,OAAO,CAAC;AAEf,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAExD,OAAO,EAAE,QAAQ,EAAa,MAAM,mBAAmB,CAAC;AAMxD,UAAU,iBAAiB;IACzB,QAAQ,EAAE,SAAS,CAAC;IACpB,WAAW,CAAC,EAAE,WAAW,EAAE,CAAC;IAC5B,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED,UAAU,eAAe;IACvB,WAAW,EAAE,WAAW,EAAE,CAAC;IAC3B,cAAc,EAAE,CACd,QAAQ,EAAE,QAAQ,EAClB,eAAe,EAAE,OAAO,KACrB,WAAW,EAAE,CAAC;IACnB,kBAAkB,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,MAAM,IAAI,CAAC;IACxD,mBAAmB,EAAE,CAAC,OAAO,EAAE,WAAW,EAAE,KAAK,MAAM,IAAI,CAAC;IAC5D,WAAW,EAAE,MAAM,KAAK,CAAC,WAAW,CAAC,CAAC;CACvC;AAID,eAAO,MAAM,YAAY,EAAE,EAAE,CAAC,iBAAiB,CA4U9C,CAAC;AAEF,eAAO,MAAM,OAAO,QAAO,eAM1B,CAAC"}
+{"version":3,"file":"MenuContext.d.ts","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-express-suite-react-components/src/contexts/MenuContext.tsx"],"names":[],"mappings":"AAqBA,OAAO,EACL,EAAE,EACF,SAAS,EAQV,MAAM,OAAO,CAAC;AAEf,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAExD,OAAO,EAAE,QAAQ,EAAa,MAAM,mBAAmB,CAAC;AAMxD,UAAU,iBAAiB;IACzB,QAAQ,EAAE,SAAS,CAAC;IACpB,WAAW,CAAC,EAAE,WAAW,EAAE,CAAC;IAC5B,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CACnC;AAED,UAAU,eAAe;IACvB,WAAW,EAAE,WAAW,EAAE,CAAC;IAC3B,cAAc,EAAE,CACd,QAAQ,EAAE,QAAQ,EAClB,eAAe,EAAE,OAAO,KACrB,WAAW,EAAE,CAAC;IACnB,kBAAkB,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,MAAM,IAAI,CAAC;IACxD,mBAAmB,EAAE,CAAC,OAAO,EAAE,WAAW,EAAE,KAAK,MAAM,IAAI,CAAC;IAC5D,WAAW,EAAE,MAAM,KAAK,CAAC,WAAW,CAAC,CAAC;CACvC;AAID,eAAO,MAAM,YAAY,EAAE,EAAE,CAAC,iBAAiB,CA4V9C,CAAC;AAEF,eAAO,MAAM,OAAO,QAAO,eAM1B,CAAC"}

package/src/contexts/MenuContext.js

@@ -14,7 +14,7 @@ const I18nProvider_1 = require("./I18nProvider");
 const SuiteConfigProvider_1 = require("./SuiteConfigProvider");
 const ThemeProvider_1 = require("./ThemeProvider");
 const MenuContext = (0, react_1.createContext)(undefined);
-const MenuProvider = ({ children, menuConfigs = [], enableBackupCodes = true, }) => {
+const MenuProvider = ({ children, menuConfigs = [], enableBackupCodes = true, hiddenMenuIds = [], }) => {
     const { userData: user, isAuthenticated, admin: isGlobalAdmin, mnemonic, clearMnemonic, wallet, clearWallet, } = (0, AuthProvider_1.useAuth)();
     const { mode: colorMode } = (0, ThemeProvider_1.useTheme)();
     const registeredMenuOptions = (0, react_1.useRef)(new Set());
@@ -210,7 +210,11 @@ const MenuProvider = ({ children, menuConfigs = [], enableBackupCodes = true, })
         enableBackupCodes,
     ]);
     const getMenuOptions = (0, react_1.useCallback)((menuType, includeDividers) => {
+        const hidden = new Set(hiddenMenuIds);
         const MenuFilter = (o) => {
+            // Suppress any option whose id the consumer asked to hide.
+            if (hidden.has(o.id))
+                return false;
             // Apply the custom filter first
             let customFilterPasses = true;
             if (o.filter !== undefined) {
@@ -225,8 +229,21 @@ const MenuProvider = ({ children, menuConfigs = [], enableBackupCodes = true, })
             return (o.includeOnMenus.includes(menuType) &&
                 (o.requiresAuth === undefined || o.requiresAuth === isAuthenticated));
         };
-        return menuOptions.filter(MenuFilter);
-    }, [isAuthenticated, isGlobalAdmin, menuOptions]);
+        const filtered = menuOptions.filter(MenuFilter);
+        // Drop dividers left orphaned once hidden items are removed: a divider at
+        // the start or end of the list, or immediately following another divider,
+        // carries no meaning and would show as a stray separator.
+        return filtered.filter((o, i) => {
+            if (o.divider !== true)
+                return true;
+            const prev = filtered[i - 1];
+            if (prev === undefined || prev.divider === true)
+                return false;
+            if (i === filtered.length - 1)
+                return false;
+            return true;
+        });
+    }, [hiddenMenuIds, isAuthenticated, isGlobalAdmin, menuOptions]);
     (0, react_1.useEffect)(() => {
         if (menuConfigs.length > 0) {
             return registerMenuOptions(menuConfigs.flatMap((config) => config.options));