@genesislcap/foundation-ui 14.127.6 → 14.128.0

package/dist/dts/icon/icon.d.ts

@@ -1,5 +1,6 @@
 import { IconName, IconStyle } from '@fortawesome/fontawesome-svg-core';
 import { FoundationElement } from '@microsoft/fast-foundation';
+export { IconName, IconStyle };
 export declare const foundationIconShadowOptions: ShadowRootInit;
 export declare const defaultIconConfig: {};
 export declare enum FaPrefixFromStyle {

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

@@ -1 +1 @@
-{"version":3,"file":"icon.d.ts","sourceRoot":"","sources":["../../../src/icon/icon.ts"],"names":[],"mappings":"AAAA,OAAO,EAA4B,QAAQ,EAAE,SAAS,EAAE,MAAM,mCAAmC,CAAC;AAElG,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAK/D,eAAO,MAAM,2BAA2B,EAAE,cAGzC,CAAC;AAEF,eAAO,MAAM,iBAAiB,IAAK,CAAC;AAEpC,oBAAY,iBAAiB;IAC3B,KAAK,QAAQ;IACb,OAAO,QAAQ;IACf,KAAK,QAAQ;CACd;AAED,MAAM,MAAM,MAAM,GACd,KAAK,GACL,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,KAAK,GACL,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,KAAK,CAAC;AAEV;;GAEG;AACH,qBAAa,IAAK,SAAQ,iBAAiB;IAC7B,QAAQ,EAAE,WAAW,CAAC;IAE5B,IAAI,EAAE,QAAQ,CAAC;IACrB,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;IAIxC,IAAI,EAAE,MAAM,CAAQ;IAC1B,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;IAIxC,OAAO,EAAE,SAAS,CAAW;IACnC,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;IAIjD,iBAAiB;IAKjB,oBAAoB;IAKb,QAAQ;CAgBhB;AAED;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,oTAMzB,CAAC"}
+{"version":3,"file":"icon.d.ts","sourceRoot":"","sources":["../../../src/icon/icon.ts"],"names":[],"mappings":"AAAA,OAAO,EAA4B,QAAQ,EAAE,SAAS,EAAE,MAAM,mCAAmC,CAAC;AAElG,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAI/D,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC;AAG/B,eAAO,MAAM,2BAA2B,EAAE,cAGzC,CAAC;AAEF,eAAO,MAAM,iBAAiB,IAAK,CAAC;AAEpC,oBAAY,iBAAiB;IAC3B,KAAK,QAAQ;IACb,OAAO,QAAQ;IACf,KAAK,QAAQ;CACd;AAED,MAAM,MAAM,MAAM,GACd,KAAK,GACL,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,KAAK,GACL,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,KAAK,CAAC;AAEV;;GAEG;AACH,qBAAa,IAAK,SAAQ,iBAAiB;IAC7B,QAAQ,EAAE,WAAW,CAAC;IAE5B,IAAI,EAAE,QAAQ,CAAC;IACrB,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;IAIxC,IAAI,EAAE,MAAM,CAAQ;IAC1B,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;IAIxC,OAAO,EAAE,SAAS,CAAW;IACnC,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;IAIjD,iBAAiB;IAKjB,oBAAoB;IAKb,QAAQ;CAgBhB;AAED;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,oTAMzB,CAAC"}

package/dist/dts/router/index.d.ts

@@ -1,2 +1,3 @@
+export * from './navItems';
 export * from './router';
 //# sourceMappingURL=index.d.ts.map

package/dist/dts/router/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/router/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/router/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC"}

package/dist/dts/router/navItems.d.ts

@@ -0,0 +1,51 @@
+import type { FaSize, IconName, IconStyle } from '../icon';
+import type { FoundationRoute } from './router';
+/**
+ * FoundationRouteNavItem
+ * @remarks
+ * Many of the properties are dynamically assigned if not set explicitly.
+ * @beta
+ */
+export type FoundationRouteNavItem = {
+    title: string;
+    icon?: {
+        name: IconName;
+        size?: FaSize;
+        variant?: IconStyle;
+    };
+    /**
+     * @remarks
+     * Defaults to 'header'.
+     */
+    navId?: string;
+    /**
+     * @remarks
+     * Lower numbers move items earlier in navs. If not explicitly assigned, this value defaults to the route mapping
+     * order and has automatic index padding applied which defaults to 10. Results in, 10, 20, 30...
+     */
+    placementIndex?: number;
+    /**
+     * @remarks
+     * Defaults to the route details, but can be set to target elsewhere.
+     */
+    routePath?: string;
+    routeName?: string;
+};
+/**
+ * @beta
+ */
+export type NavItemPredicate = (item: FoundationRouteNavItem) => boolean;
+/**
+ * @beta
+ */
+export declare const defaultNavItemPredicate: NavItemPredicate;
+/**
+ * @beta
+ */
+export declare const defaultPlacementIndexPadding = 10;
+/**
+ * Get navigation items from routes.
+ * @beta
+ */
+export declare function getNavItems(routes: FoundationRoute[], predicate?: NavItemPredicate, placementIndexPadding?: number): FoundationRouteNavItem[];
+//# sourceMappingURL=navItems.d.ts.map

package/dist/dts/router/navItems.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"navItems.d.ts","sourceRoot":"","sources":["../../../src/router/navItems.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAC3D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAEhD;;;;;GAKG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE;QACL,IAAI,EAAE,QAAQ,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,OAAO,CAAC,EAAE,SAAS,CAAC;KACrB,CAAC;IACF;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,IAAI,EAAE,sBAAsB,KAAK,OAAO,CAAC;AAEzE;;GAEG;AACH,eAAO,MAAM,uBAAuB,EAAE,gBACE,CAAC;AAEzC;;GAEG;AACH,eAAO,MAAM,4BAA4B,KAAK,CAAC;AAE/C;;;GAGG;AACH,wBAAgB,WAAW,CACzB,MAAM,EAAE,eAAe,EAAE,EACzB,SAAS,mBAA0B,EACnC,qBAAqB,SAA+B,GACnD,sBAAsB,EAAE,CA8B1B"}

package/dist/dts/router/router.d.ts

@@ -1,5 +1,8 @@
-import { FASTElement } from '@microsoft/fast-element';
-import { RouterElement } from '@microsoft/fast-router';
+import { FoundationAnalytics } from '@genesislcap/foundation-comms';
+import { Constructable, FASTElement } from '@microsoft/fast-element';
+import { Container } from '@microsoft/fast-foundation';
+import { MappableRouteDefinition, RouteCollection, RouterConfiguration, RouterElement } from '@microsoft/fast-router';
+import type { FoundationRouteNavItem, NavItemPredicate } from './navItems';
 declare const FoundationRouter_base: new () => FASTElement & RouterElement;
 /**
  * @beta
@@ -8,7 +11,40 @@ declare const FoundationRouter_base: new () => FASTElement & RouterElement;
  * how much we build on this, we may want to promote it to its own package.
  */
 export declare class FoundationRouter extends FoundationRouter_base {
+    config: FoundationRouterConfiguration | null;
     connectedCallback(): void;
 }
+/**
+ * @beta
+ */
+export type FoundationRoute<TSettings = any> = MappableRouteDefinition<TSettings> & {
+    navItems?: FoundationRouteNavItem[];
+};
+/**
+ * @beta
+ */
+export declare class FoundationRouteCollection<TSettings = any> extends RouteCollection<TSettings> {
+    definitions: FoundationRoute<TSettings>[];
+    map(...routes: FoundationRoute<TSettings>[]): void;
+}
+/**
+ * @beta
+ */
+export declare abstract class FoundationRouterConfiguration<TSettings = any> extends RouterConfiguration<TSettings> {
+    protected container: Container;
+    protected analytics: FoundationAnalytics;
+    readonly routes: FoundationRouteCollection<TSettings>;
+    /**
+     * @remarks
+     * Get navigation items from the route definitions.
+     */
+    getNavItems(predicate?: NavItemPredicate): FoundationRouteNavItem[];
+    /**
+     * @remarks
+     * Applies the analytics service to the navigate phase.
+     */
+    configureAnalytics(): void;
+    construct<T>(Type: Constructable<T>): T;
+}
 export {};
 //# sourceMappingURL=router.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"router.d.ts","sourceRoot":"","sources":["../../../src/router/router.ts"],"names":[],"mappings":"AAAA,OAAO,EAAsB,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAC1E,OAAO,EAAU,aAAa,EAAE,MAAM,wBAAwB,CAAC;+CAcrD,WAAW,GAAG,aAAa;AAVrC;;;;;GAKG;AACH,qBAGa,gBAAiB,SAAQ,qBAEpC;IACA,iBAAiB;CAYlB"}
+{"version":3,"file":"router.d.ts","sourceRoot":"","sources":["../../../src/router/router.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,mBAAmB,EAGpB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EACL,aAAa,EAGb,WAAW,EAEZ,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AACvD,OAAO,EACL,uBAAuB,EACvB,eAAe,EAEf,mBAAmB,EACnB,aAAa,EACd,MAAM,wBAAwB,CAAC;AAChC,OAAO,KAAK,EAAE,sBAAsB,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;+CAkBjE,WAAW,GAAG,aAAa;AAVrC;;;;;GAKG;AACH,qBAGa,gBAAiB,SAAQ,qBAEpC;IACA,MAAM,EAAE,6BAA6B,GAAG,IAAI,CAAC;IAE7C,iBAAiB;CAYlB;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,CAAC,SAAS,GAAG,GAAG,IAAI,uBAAuB,CAAC,SAAS,CAAC,GAAG;IAClF,QAAQ,CAAC,EAAE,sBAAsB,EAAE,CAAC;CACrC,CAAC;AAEF;;GAEG;AACH,qBAAa,yBAAyB,CAAC,SAAS,GAAG,GAAG,CAAE,SAAQ,eAAe,CAAC,SAAS,CAAC;IAC5E,WAAW,EAAE,eAAe,CAAC,SAAS,CAAC,EAAE,CAAM;IAC3D,GAAG,CAAC,GAAG,MAAM,EAAE,eAAe,CAAC,SAAS,CAAC,EAAE;CAI5C;AAED;;GAEG;AACH,8BAAsB,6BAA6B,CACjD,SAAS,GAAG,GAAG,CACf,SAAQ,mBAAmB,CAAC,SAAS,CAAC;IAC3B,SAAS,CAAC,SAAS,EAAE,SAAS,CAAC;IACrB,SAAS,CAAC,SAAS,EAAE,mBAAmB,CAAC;IAE9D,SAAgB,MAAM,EAAE,yBAAyB,CAAC,SAAS,CAAC,CACX;IAEjD;;;OAGG;IACH,WAAW,CAAC,SAAS,GAAE,gBAA0C,GAAG,sBAAsB,EAAE;IAI5F;;;OAGG;IACH,kBAAkB;IAYlB,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC,CAAC,GAAG,CAAC;CAGxC"}

package/dist/esm/router/index.js

@@ -1 +1,2 @@
+export * from './navItems';
 export * from './router';

package/dist/esm/router/navItems.js

@@ -0,0 +1,37 @@
+/**
+ * @beta
+ */
+export const defaultNavItemPredicate = (item) => !item.navId || item.navId === 'header';
+/**
+ * @beta
+ */
+export const defaultPlacementIndexPadding = 10;
+/**
+ * Get navigation items from routes.
+ * @beta
+ */
+export function getNavItems(routes, predicate = defaultNavItemPredicate, placementIndexPadding = defaultPlacementIndexPadding) {
+    const items = [];
+    routes
+        .filter((route) => route.navItems && route.navItems.some(predicate))
+        .forEach((route, routeIndex) => {
+        route.navItems
+            .filter(predicate)
+            .map((item, navItemIndex) => {
+            var _a, _b, _c, _d;
+            /**
+             * Best guess placementIndex
+             */
+            const placementIndex = (_a = item.placementIndex) !== null && _a !== void 0 ? _a : routeIndex * placementIndexPadding + navItemIndex;
+            /**
+             * Map metadata not explicitly set
+             */
+            return Object.assign(Object.assign({}, item), { navId: (_b = item.navId) !== null && _b !== void 0 ? _b : 'header', placementIndex, routePath: (_c = item.routePath) !== null && _c !== void 0 ? _c : route.path, routeName: (_d = item.routeName) !== null && _d !== void 0 ? _d : route.name });
+        })
+            .forEach((item) => items.push(item));
+    });
+    /**
+     * Returned sorted items based on placementIndex
+     */
+    return items.sort((a, b) => a.placementIndex - b.placementIndex);
+}

package/dist/esm/router/router.js

@@ -1,6 +1,12 @@
 import { __awaiter, __decorate } from "tslib";
-import { customElement, DOM, FASTElement } from '@microsoft/fast-element';
-import { Router } from '@microsoft/fast-router';
+import { FoundationAnalytics, FoundationAnalyticsEventType, } from '@genesislcap/foundation-comms';
+import { customElement, DOM, FASTElement, observable, } from '@microsoft/fast-element';
+import { Container } from '@microsoft/fast-foundation';
+import { RouteCollection, Router, RouterConfiguration, } from '@microsoft/fast-router';
+import { defaultNavItemPredicate, getNavItems } from './navItems';
+/**
+ * @internal
+ */
 const routerProperty = '$router';
 /**
  * @beta
@@ -28,3 +34,57 @@ FoundationRouter = __decorate([
     })
 ], FoundationRouter);
 export { FoundationRouter };
+/**
+ * @beta
+ */
+export class FoundationRouteCollection extends RouteCollection {
+    constructor() {
+        super(...arguments);
+        this.definitions = [];
+    }
+    map(...routes) {
+        this.definitions = [...this.definitions, ...routes];
+        super.map(...routes);
+    }
+}
+__decorate([
+    observable
+], FoundationRouteCollection.prototype, "definitions", void 0);
+/**
+ * @beta
+ */
+export class FoundationRouterConfiguration extends RouterConfiguration {
+    constructor() {
+        super(...arguments);
+        this.routes = new FoundationRouteCollection(this);
+    }
+    /**
+     * @remarks
+     * Get navigation items from the route definitions.
+     */
+    getNavItems(predicate = defaultNavItemPredicate) {
+        return getNavItems(this.routes.definitions, predicate);
+    }
+    /**
+     * @remarks
+     * Applies the analytics service to the navigate phase.
+     */
+    configureAnalytics() {
+        this.contributors.push({
+            navigate: (phase) => __awaiter(this, void 0, void 0, function* () {
+                this.analytics.trackEvent(FoundationAnalyticsEventType.routeChanged, {
+                    path: phase.route.endpoint.path,
+                });
+            }),
+        });
+    }
+    construct(Type) {
+        return this.container.get(Type);
+    }
+}
+__decorate([
+    Container
+], FoundationRouterConfiguration.prototype, "container", void 0);
+__decorate([
+    FoundationAnalytics
+], FoundationRouterConfiguration.prototype, "analytics", void 0);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-ui",
   "description": "Genesis Foundation UI",
-  "version": "14.127.6",
+  "version": "14.128.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -74,8 +74,8 @@
     "test:debug": "genx test --debug"
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.127.6",
-    "@genesislcap/genx": "14.127.6",
+    "@genesislcap/foundation-testing": "14.128.0",
+    "@genesislcap/genx": "14.128.0",
     "copyfiles": "^2.4.1",
     "rimraf": "^3.0.2",
     "rxjs": "^7.5.4"
@@ -86,12 +86,12 @@
     "@fortawesome/free-regular-svg-icons": "^6.2.1",
     "@fortawesome/free-solid-svg-icons": "^6.2.1",
     "@genesiscommunitysuccess/analyzer-import-alias-plugin": "^4.0.0",
-    "@genesislcap/foundation-comms": "14.127.6",
-    "@genesislcap/foundation-criteria": "14.127.6",
-    "@genesislcap/foundation-errors": "14.127.6",
-    "@genesislcap/foundation-logger": "14.127.6",
-    "@genesislcap/foundation-notifications": "14.127.6",
-    "@genesislcap/foundation-utils": "14.127.6",
+    "@genesislcap/foundation-comms": "14.128.0",
+    "@genesislcap/foundation-criteria": "14.128.0",
+    "@genesislcap/foundation-errors": "14.128.0",
+    "@genesislcap/foundation-logger": "14.128.0",
+    "@genesislcap/foundation-notifications": "14.128.0",
+    "@genesislcap/foundation-utils": "14.128.0",
     "@microsoft/fast-colors": "^5.3.1",
     "@microsoft/fast-components": "^2.30.6",
     "@microsoft/fast-element": "^1.12.0",
@@ -113,5 +113,5 @@
     "access": "public"
   },
   "customElements": "dist/custom-elements.json",
-  "gitHead": "bee68a5b13b648123943e49d547c27da5a7ff6ed"
+  "gitHead": "5fc8cef3a47b0b518e28d67f03b3ac7f4df99b38"
 }