@genesislcap/foundation-header 14.186.1 → 14.187.0

package/dist/custom-elements.json

@@ -31,6 +31,27 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/components/zero-components.ts",
+      "declarations": [
+        {
+          "kind": "function",
+          "name": "registerCommonZeroComponents",
+          "privacy": "public"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "registerCommonZeroComponents",
+          "declaration": {
+            "name": "registerCommonZeroComponents",
+            "module": "src/components/zero-components.ts"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "src/config/config.ts",
@@ -151,27 +172,6 @@
         }
       ]
     },
-    {
-      "kind": "javascript-module",
-      "path": "src/components/zero-components.ts",
-      "declarations": [
-        {
-          "kind": "function",
-          "name": "registerCommonZeroComponents",
-          "privacy": "public"
-        }
-      ],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "registerCommonZeroComponents",
-          "declaration": {
-            "name": "registerCommonZeroComponents",
-            "module": "src/components/zero-components.ts"
-          }
-        }
-      ]
-    },
     {
       "kind": "javascript-module",
       "path": "src/main/index.ts",

package/dist/dts/main/main.d.ts

@@ -198,16 +198,6 @@ declare const Navigation_base: abstract new (...args: any[]) => {
     ariaRowIndexText: string;
     ariaRowSpan: string;
     ariaSelected: string;
-    /**
-     * Emits the event corresponding to the miscellaneous icon being clicked
-     *
-     * @remarks
-     *
-     * Activated when the user clicks on the menu icon on the navigation
-     * bar right hand side
-     *
-     * @internal
-     */
     ariaSetSize: string;
     ariaSort: string;
     ariaValueMax: string;
@@ -216,7 +206,12 @@ declare const Navigation_base: abstract new (...args: any[]) => {
     ariaValueText: string;
     role: string;
     animate(keyframes: PropertyIndexedKeyframes | Keyframe[], options?: number | KeyframeAnimationOptions): Animation;
-    /**
+    getAnimations(options?: GetAnimationsOptions): Animation[];
+    after(...nodes: (string | Node)[]): void;
+    before(...nodes: (string | Node)[]): void;
+    remove(): void;
+    replaceWith(...nodes: (string | Node)[]): void;
+    innerHTML: string; /**
      * Emits the event corresponding to the notification icon being clicked
      *
      * @remarks
@@ -226,12 +221,6 @@ declare const Navigation_base: abstract new (...args: any[]) => {
      *
      * @internal
      */
-    getAnimations(options?: GetAnimationsOptions): Animation[];
-    after(...nodes: (string | Node)[]): void;
-    before(...nodes: (string | Node)[]): void;
-    remove(): void;
-    replaceWith(...nodes: (string | Node)[]): void;
-    innerHTML: string;
     readonly nextElementSibling: Element;
     readonly previousElementSibling: Element;
     readonly childElementCount: number;
@@ -522,6 +511,13 @@ export declare class Navigation extends Navigation_base {
      * @public
      */
     navigateTo(path: string): void;
+    /**
+     * @remarks
+     * Allows nav items to appear conditionally based on the permissions held by the current user.
+     *
+     * @internal
+     */
+    isUserPermitted(permission: string): boolean;
     /**
      * Opens the flyout menu on the left hand side
      *

package/dist/dts/main/main.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../../src/main/main.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,iBAAiB,EAAgB,MAAM,+BAA+B,CAAC;AAEtF,OAAO,EAAE,OAAO,EAAE,MAAM,8BAA8B,CAAC;AACvD,OAAO,KAAK,EAAE,sBAAsB,EAAuB,MAAM,4BAA4B,CAAC;AAI9F,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAKhD;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,wBAAwB,EAAE,IAAI,CAAC;IAC/B,mBAAmB,EAAE,IAAI,CAAC;IAC1B,2BAA2B,EAAE,IAAI,CAAC;IAClC,kBAAkB,EAAE,IAAI,CAAC;CAC1B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,kBAAkB,EAAE,MAAM,EAAE,CAAC;IAC7B,gBAAgB,EAAE,MAAM,CAAC;CAC1B,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAgHA;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAyKH;;;;;;;;;OASG;;;;;;;;;IAKH;;;;;;;;;OASG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA7SL;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,qBAKa,UAAW,SAAQ,eAAmC;IAC3D,IAAI,EAAG,IAAI,CAAC;IACC,iBAAiB,EAAG,iBAAiB,CAAC;IAChD,OAAO,EAAG,OAAO,CAAC;IACb,YAAY,EAAG,YAAY,CAAC;IAE9B,KAAK,EAAE,OAAO,CAAS;IAEnC;;OAEG;IACgB,QAAQ,EAAE,MAAM,CAAC;IAExB,WAAW,UAAS;IAEnB,iBAAiB;IAU9B;;;;;;;OAOG;IAC8B,OAAO,EAAE,GAAG,CAAQ;IAErD;;;;;;;OAOG;IAEH,yBAAyB,EAAE,OAAO,CAAC;IAEnC;;;;;;;OAOG;IAC8D,oBAAoB,EAAE,OAAO,CAAC;IAE/F;;;;;;;;;OASG;IAEH,uBAAuB,EAAE,OAAO,CAAC;IAEjC;;OAEG;IACH,8BAA8B;IAI9B;;;;OAIG;IAEH,uBAAuB,EAAE,OAAO,CAAQ;IAExC;;;;;;;;OAQG;IAEH,oBAAoB,EAAE,OAAO,CAAS;IAE1B,eAAe,EAAE,eAAe,CAG1C;IAEF;;;;OAIG;IAEH,WAAW,EAAE,OAAO,CAAC;IAErB;;;;OAIG;IACS,YAAY,EAAE,KAAK,CAAC;QAC9B,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC,CAAC;IAEH;;OAEG;IACH,mBAAmB;IAiBnB;;OAEG;IACS,aAAa,EAAE,sBAAsB,EAAE,CAAC;IAEpD;;;;;;;;OAQG;IACG,WAAW;IAMjB,cAAc;IAId;;;;;;;;;OASG;IACU,MAAM;IAgBnB;;;;;;;;;;OAUG;IACI,UAAU,CAAC,IAAI,EAAE,MAAM;IAS9B;;;;;;;;;OASG;IACH,mBAAmB;IAInB;;;;;;;;;OASG;IACH,kBAAkB;IAIlB;;;;;;;;;OASG;IACH,aAAa;IAIb;;;;;;;;;OASG;IACH,qBAAqB;IAIrB;;;;;;;;OAQG;IACH,cAAc,CAAC,CAAC,EAAE,WAAW;IAK7B;;;;;;;;OAQG;IACH,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;CAKtC;AAED;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,gBAAiB,SAAQ,UAAU;IACxC,WAAW;CAGlB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,qBAKa,UAAW,SAAQ,UAAU;CAAG"}
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../../src/main/main.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,iBAAiB,EAAgB,MAAM,+BAA+B,CAAC;AAEtF,OAAO,EAAE,OAAO,EAAE,MAAM,8BAA8B,CAAC;AACvD,OAAO,KAAK,EAAE,sBAAsB,EAAuB,MAAM,4BAA4B,CAAC;AAI9F,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAKhD;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,wBAAwB,EAAE,IAAI,CAAC;IAC/B,mBAAmB,EAAE,IAAI,CAAC;IAC1B,2BAA2B,EAAE,IAAI,CAAC;IAClC,kBAAkB,EAAE,IAAI,CAAC;CAC1B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,kBAAkB,EAAE,MAAM,EAAE,CAAC;IAC7B,gBAAgB,EAAE,MAAM,CAAC;CAC1B,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAgHA;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;uBAiMH;;;;;;;;;OASG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAvTL;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,qBAKa,UAAW,SAAQ,eAAmC;IAC3D,IAAI,EAAG,IAAI,CAAC;IACC,iBAAiB,EAAG,iBAAiB,CAAC;IAChD,OAAO,EAAG,OAAO,CAAC;IACb,YAAY,EAAG,YAAY,CAAC;IAE9B,KAAK,EAAE,OAAO,CAAS;IAEnC;;OAEG;IACgB,QAAQ,EAAE,MAAM,CAAC;IAExB,WAAW,UAAS;IAEnB,iBAAiB;IAU9B;;;;;;;OAOG;IAC8B,OAAO,EAAE,GAAG,CAAQ;IAErD;;;;;;;OAOG;IAEH,yBAAyB,EAAE,OAAO,CAAC;IAEnC;;;;;;;OAOG;IAC8D,oBAAoB,EAAE,OAAO,CAAC;IAE/F;;;;;;;;;OASG;IAEH,uBAAuB,EAAE,OAAO,CAAC;IAEjC;;OAEG;IACH,8BAA8B;IAI9B;;;;OAIG;IAEH,uBAAuB,EAAE,OAAO,CAAQ;IAExC;;;;;;;;OAQG;IAEH,oBAAoB,EAAE,OAAO,CAAS;IAE1B,eAAe,EAAE,eAAe,CAG1C;IAEF;;;;OAIG;IAEH,WAAW,EAAE,OAAO,CAAC;IAErB;;;;OAIG;IACS,YAAY,EAAE,KAAK,CAAC;QAC9B,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC,CAAC;IAEH;;OAEG;IACH,mBAAmB;IAiBnB;;OAEG;IACS,aAAa,EAAE,sBAAsB,EAAE,CAAC;IAEpD;;;;;;;;OAQG;IACG,WAAW;IAMjB,cAAc;IAId;;;;;;;;;OASG;IACU,MAAM;IAgBnB;;;;;;;;;;OAUG;IACI,UAAU,CAAC,IAAI,EAAE,MAAM;IAS9B;;;;;OAKG;IACH,eAAe,CAAC,UAAU,EAAE,MAAM;IAIlC;;;;;;;;;OASG;IACH,mBAAmB;IAInB;;;;;;;;;OASG;IACH,kBAAkB;IAIlB;;;;;;;;;OASG;IACH,aAAa;IAIb;;;;;;;;;OASG;IACH,qBAAqB;IAIrB;;;;;;;;OAQG;IACH,cAAc,CAAC,CAAC,EAAE,WAAW;IAK7B;;;;;;;;OAQG;IACH,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;CAKtC;AAED;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,gBAAiB,SAAQ,UAAU;IACxC,WAAW;CAGlB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,qBAKa,UAAW,SAAQ,UAAU;CAAG"}

package/dist/dts/main/main.template.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"main.template.d.ts","sourceRoot":"","sources":["../../../src/main/main.template.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAW5D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AA6EzC;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,WAAW,+BA6FvB,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,eAAe,EAAE,YAAY,CAAC,UAAU,CAIpD,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,eAAe,EAAE,YAAY,CAAC,UAAU,CAEpD,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,YAAY,EAAE,YAAY,CAAC,UAAU,CAEjD,CAAC"}
+{"version":3,"file":"main.template.d.ts","sourceRoot":"","sources":["../../../src/main/main.template.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAW5D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAiFzC;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,WAAW,+BA6FvB,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,eAAe,EAAE,YAAY,CAAC,UAAU,CAIpD,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,eAAe,EAAE,YAAY,CAAC,UAAU,CAEpD,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,YAAY,EAAE,YAAY,CAAC,UAAU,CAEjD,CAAC"}

package/dist/esm/main/main.js

@@ -183,6 +183,15 @@ let Navigation = class Navigation extends EventEmitter(FASTElement) {
             logger.error(`Error: ${err.message}`);
         }
     }
+    /**
+     * @remarks
+     * Allows nav items to appear conditionally based on the permissions held by the current user.
+     *
+     * @internal
+     */
+    isUserPermitted(permission) {
+        return this.auth.currentUser.hasPermission(permission);
+    }
     /**
      * Opens the flyout menu on the left hand side
      *

package/dist/esm/main/main.template.js

@@ -47,22 +47,23 @@ const defaultRouteNavItemsTemplate = html `
 const routeNavItemsTemplate = html `
   <template>
     ${repeat((x) => x.routeNavItems, html `
-        <${buttonTag}
-          appearance="neutral-grey"
-          class="nav-button"
-          slot="routes"
-          @click=${(x, c) => c.parent.navigateTo(x.routePath)}
-          data-test-id="${(x) => `${x.routePath}-button`}"
-        >
-          ${when((x) => x.icon, html `
-              <${iconTag}
-                name="${(x) => x.icon.name}"
-                variant="${(x) => x.icon.variant}"
-                size="${(x) => x.icon.size}"
-              ></${iconTag}>
-            `)}
-          ${(x, c) => c.parent.toLocalisedText(x.title)}
-        </${buttonTag}>
+        ${when((x, c) => !x.permission || (x.permission && c.parent.isUserPermitted(x.permission)), html `        
+            <${buttonTag}
+              appearance="neutral-grey"
+              class="nav-button"
+              slot="routes"
+              @click=${(x, c) => c.parent.navigateTo(x.routePath)}
+              data-test-id="${(x) => `${x.routePath}-button`}"
+            >
+              ${when((x) => x.icon, html `
+                  <${iconTag}
+                    name="${(x) => x.icon.name}"
+                    variant="${(x) => x.icon.variant}"
+                    size="${(x) => x.icon.size}"
+                  ></${iconTag}>
+                `)}
+              ${(x, c) => c.parent.toLocalisedText(x.title)}
+            </${buttonTag}>`)}
       `)}
   </template>
 `;

package/dist/foundation-header.d.ts

@@ -342,6 +342,13 @@ export declare class Navigation extends Navigation_base {
      * @public
      */
     navigateTo(path: string): void;
+    /**
+     * @remarks
+     * Allows nav items to appear conditionally based on the permissions held by the current user.
+     *
+     * @internal
+     */
+    isUserPermitted(permission: string): boolean;
     /**
      * Opens the flyout menu on the left hand side
      *
@@ -586,16 +593,6 @@ declare const Navigation_base: abstract new (...args: any[]) => {
     ariaRowIndexText: string;
     ariaRowSpan: string;
     ariaSelected: string;
-    /**
-     * Emits the event corresponding to the miscellaneous icon being clicked
-     *
-     * @remarks
-     *
-     * Activated when the user clicks on the menu icon on the navigation
-     * bar right hand side
-     *
-     * @internal
-     */
     ariaSetSize: string;
     ariaSort: string;
     ariaValueMax: string;
@@ -604,22 +601,21 @@ declare const Navigation_base: abstract new (...args: any[]) => {
     ariaValueText: string;
     role: string;
     animate(keyframes: PropertyIndexedKeyframes | Keyframe[], options?: number | KeyframeAnimationOptions): Animation;
-    /**
-     * Emits the event corresponding to the notification icon being clicked
-     *
-     * @remarks
-     *
-     * Activated when the user clicks on the bell icon on the navigation
-     * bar right hand side
-     *
-     * @internal
-     */
     getAnimations(options?: GetAnimationsOptions): Animation[];
     after(...nodes: (string | Node)[]): void;
     before(...nodes: (string | Node)[]): void;
     remove(): void;
     replaceWith(...nodes: (string | Node)[]): void;
-    innerHTML: string;
+    innerHTML: string; /**
+    * Emits the event corresponding to the notification icon being clicked
+    *
+    * @remarks
+    *
+    * Activated when the user clicks on the bell icon on the navigation
+    * bar right hand side
+    *
+    * @internal
+    */
     readonly nextElementSibling: Element;
     readonly previousElementSibling: Element;
     readonly childElementCount: number;

package/docs/api-report.md

@@ -95,6 +95,8 @@ export class Navigation extends Navigation_base {
     hideSideBar: boolean;
     // (undocumented)
     i18next: I18next;
+    // @internal (undocumented)
+    isUserPermitted(permission: string): boolean;
     // (undocumented)
     languageOptions: LanguageOptions;
     // @internal

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-header",
   "description": "Genesis Foundation Header",
-  "version": "14.186.1",
+  "version": "14.187.0",
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
   "types": "dist/foundation-header.d.ts",
@@ -76,24 +76,24 @@
     }
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.186.1",
-    "@genesislcap/genx": "14.186.1",
-    "@genesislcap/rollup-builder": "14.186.1",
-    "@genesislcap/ts-builder": "14.186.1",
-    "@genesislcap/uvu-playwright-builder": "14.186.1",
-    "@genesislcap/vite-builder": "14.186.1",
-    "@genesislcap/webpack-builder": "14.186.1",
+    "@genesislcap/foundation-testing": "14.187.0",
+    "@genesislcap/genx": "14.187.0",
+    "@genesislcap/rollup-builder": "14.187.0",
+    "@genesislcap/ts-builder": "14.187.0",
+    "@genesislcap/uvu-playwright-builder": "14.187.0",
+    "@genesislcap/vite-builder": "14.187.0",
+    "@genesislcap/webpack-builder": "14.187.0",
     "rimraf": "^5.0.0"
   },
   "dependencies": {
-    "@genesislcap/foundation-comms": "14.186.1",
-    "@genesislcap/foundation-events": "14.186.1",
-    "@genesislcap/foundation-i18n": "14.186.1",
-    "@genesislcap/foundation-logger": "14.186.1",
-    "@genesislcap/foundation-shell": "14.186.1",
-    "@genesislcap/foundation-ui": "14.186.1",
-    "@genesislcap/foundation-utils": "14.186.1",
-    "@genesislcap/foundation-zero": "14.186.1",
+    "@genesislcap/foundation-comms": "14.187.0",
+    "@genesislcap/foundation-events": "14.187.0",
+    "@genesislcap/foundation-i18n": "14.187.0",
+    "@genesislcap/foundation-logger": "14.187.0",
+    "@genesislcap/foundation-shell": "14.187.0",
+    "@genesislcap/foundation-ui": "14.187.0",
+    "@genesislcap/foundation-utils": "14.187.0",
+    "@genesislcap/foundation-zero": "14.187.0",
     "@microsoft/fast-colors": "^5.3.1",
     "@microsoft/fast-element": "^1.12.0",
     "@microsoft/fast-foundation": "^2.49.4",
@@ -109,5 +109,5 @@
     "access": "public"
   },
   "customElements": "dist/custom-elements.json",
-  "gitHead": "d08325d1640fd14e5c6ecb86d75612c90ac49ef9"
+  "gitHead": "a1fbc41e29012ff3bc2c28616ef3908de7e626fe"
 }