@genesislcap/foundation-header 14.178.0 → 14.180.0

package/docs/api/foundation-header.foundationheader.md

@@ -0,0 +1,27 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-header](./foundation-header.md) &gt; [FoundationHeader](./foundation-header.foundationheader.md)
+
+## FoundationHeader class
+
+FoundationHeader.
+
+**Signature:**
+
+```typescript
+export declare class FoundationHeader extends Navigation 
+```
+**Extends:** [Navigation](./foundation-header.navigation.md)
+
+## Remarks
+
+Base MF export used by host application `configure` calls. It does not set up a design system or components. Both are expected to be registered in the host application, which should provide the details of which to the MF via TemplateOptions.
+
+See the [configure()](./foundation-header.configure.md) hook for more information on how to set up and use this micro frontend in your application.
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [loadRemotes()](./foundation-header.foundationheader.loadremotes.md) |  |  |
+

package/docs/api/foundation-header.headerconfig.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-header](./foundation-header.md) &gt; [HeaderConfig](./foundation-header.headerconfig.md)
+
+## HeaderConfig interface
+
+HeaderConfig DI interface.
+
+**Signature:**
+
+```typescript
+export interface HeaderConfig extends PartialFASTElementDefinition 
+```
+**Extends:** PartialFASTElementDefinition
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [templateOptions](./foundation-header.headerconfig.templateoptions.md) |  | TemplateOptions | Template options. |
+

package/docs/api/foundation-header.headerconfig.templateoptions.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-header](./foundation-header.md) &gt; [HeaderConfig](./foundation-header.headerconfig.md) &gt; [templateOptions](./foundation-header.headerconfig.templateoptions.md)
+
+## HeaderConfig.templateOptions property
+
+Template options.
+
+**Signature:**
+
+```typescript
+templateOptions: TemplateOptions;
+```
+
+## Remarks
+
+Used by host applications to assign MF template options and subcomponent tags to align with the host design system.
+

package/docs/api/foundation-header.md

@@ -8,12 +8,27 @@
 
 |  Class | Description |
 |  --- | --- |
+|  [FoundationHeader](./foundation-header.foundationheader.md) | FoundationHeader. |
 |  [Navigation](./foundation-header.navigation.md) | Navigation micro-frontend includes navigation bar and flyout menu |
+|  [ZeroHeader](./foundation-header.zeroheader.md) | ZeroHeader is a zero version of the header micro-frontend. |
+
+## Functions
+
+|  Function | Description |
+|  --- | --- |
+|  [configure(config)](./foundation-header.configure.md) | A function that allows configuring the header micro-frontend with name and templateOptions. |
+
+## Interfaces
+
+|  Interface | Description |
+|  --- | --- |
+|  [HeaderConfig](./foundation-header.headerconfig.md) | HeaderConfig DI interface. |
 
 ## Variables
 
 |  Variable | Description |
 |  --- | --- |
+|  [defaultHeaderConfig](./foundation-header.defaultheaderconfig.md) | Default HeaderConfig DI implementation. |
 |  [MainStyles](./foundation-header.mainstyles.md) | Base styles for the foundation-header |
 |  [NavTemplate](./foundation-header.navtemplate.md) | Template for Navigation class |
 

package/docs/api/foundation-header.navigation.headerconfig.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-header](./foundation-header.md) &gt; [Navigation](./foundation-header.navigation.md) &gt; [headerConfig](./foundation-header.navigation.headerconfig.md)
+
+## Navigation.headerConfig property
+
+**Signature:**
+
+```typescript
+headerConfig: HeaderConfig;
+```

package/docs/api/foundation-header.navigation.md

@@ -23,6 +23,7 @@ export declare class Navigation extends Navigation_base
 |  --- | --- | --- | --- |
 |  [auth](./foundation-header.navigation.auth.md) |  | Auth |  |
 |  [credentialManager](./foundation-header.navigation.credentialmanager.md) |  | CredentialManager |  |
+|  [headerConfig](./foundation-header.navigation.headerconfig.md) |  | [HeaderConfig](./foundation-header.headerconfig.md) |  |
 |  [hideSideBar](./foundation-header.navigation.hidesidebar.md) |  | boolean | Boolean attribute which controls whether to include the sideNav component Control via<code>hide-side-bar</code> |
 |  [i18next](./foundation-header.navigation.i18next.md) |  | I18next |  |
 |  [languageOptions](./foundation-header.navigation.languageoptions.md) |  | [LanguageOptions](./foundation-header.languageoptions.md) |  |

package/docs/api/foundation-header.zeroheader.md

@@ -0,0 +1,37 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-header](./foundation-header.md) &gt; [ZeroHeader](./foundation-header.zeroheader.md)
+
+## ZeroHeader class
+
+ZeroHeader is a zero version of the header micro-frontend.
+
+**Signature:**
+
+```typescript
+export declare class ZeroHeader extends Navigation 
+```
+**Extends:** [Navigation](./foundation-header.navigation.md)
+
+## Remarks
+
+A zero version that pre-registers zero components and uses the zero design system so that it can run standalone. Generally this is used for development purposes, but can be deployed as a standalone application if required or be used by a host application that is already using zero. ZeroHeader and its components won't bloat the core bundle as these are only loaded on-demand when in use.
+
+## Example 1
+
+
+```ts
+import { ZeroHeader } from '@genesislcap/foundation-header';
+...
+ZeroHeader
+```
+
+## Example 2
+
+Load the micro frontend on-demand
+
+```ts
+  const { ZeroHeader } = await import('@genesislcap/foundation-header');
+},
+```
+

package/docs/api-report.md

@@ -12,11 +12,43 @@ import { EmitOptions } from '@genesislcap/foundation-events';
 import { EmitReturn } from '@genesislcap/foundation-events';
 import type { FoundationRouteNavItem } from '@genesislcap/foundation-ui';
 import { I18next } from '@genesislcap/foundation-i18n';
+import { InterfaceSymbol } from '@microsoft/fast-foundation';
+import { PartialFASTElementDefinition } from '@microsoft/fast-element';
+import { SyntheticViewTemplate } from '@microsoft/fast-element';
+import { TemplateElementDependency } from '@genesislcap/foundation-ui';
 import { ViewTemplate } from '@microsoft/fast-element';
 
+// @public
+export function configure(config: Partial<HeaderConfig>): Promise<Navigation>;
+
+// @public
+export const defaultHeaderConfig: HeaderConfig;
+
+// Warning: (ae-internal-missing-underscore) The name "DynamicTemplate" should be prefixed with an underscore because the declaration is marked as @internal
+//
+// @internal
+export const DynamicTemplate: ViewTemplate<Navigation>;
+
 // @public
 export type ElementTargetId = HeaderTargetId | NavTargetId | SideNavTargetId;
 
+// @public
+export class FoundationHeader extends Navigation {
+    // (undocumented)
+    loadRemotes(): Promise<void>;
+}
+
+// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "HeaderConfig" because one of its declarations is marked as @internal
+//
+// @public
+export interface HeaderConfig extends PartialFASTElementDefinition {
+    // Warning: (ae-forgotten-export) The symbol "TemplateOptions" needs to be exported by the entry point index.d.ts
+    templateOptions: TemplateOptions;
+}
+
+// @internal
+export const HeaderConfig: InterfaceSymbol<HeaderConfig>;
+
 // @public
 export type HeaderTargetId = 'header-start' | 'header' | 'header-end';
 
@@ -26,9 +58,19 @@ export type LanguageOptions = {
     selectedLanguage: string;
 };
 
+// Warning: (ae-internal-missing-underscore) The name "LoadingTemplate" should be prefixed with an underscore because the declaration is marked as @internal
+//
+// @internal
+export const LoadingTemplate: ViewTemplate<Navigation>;
+
 // @public
 export const MainStyles: ElementStyles;
 
+// Warning: (ae-internal-missing-underscore) The name "MainTemplate" should be prefixed with an underscore because the declaration is marked as @internal
+//
+// @internal
+export const MainTemplate: ViewTemplate<Navigation>;
+
 // @public
 export type NavEventDetailMap = {
     'luminance-icon-clicked': void;
@@ -48,6 +90,8 @@ export class Navigation extends Navigation_base {
     connectedCallback(): Promise<void>;
     // (undocumented)
     credentialManager: CredentialManager;
+    // (undocumented)
+    headerConfig: HeaderConfig;
     hideSideBar: boolean;
     // (undocumented)
     i18next: I18next;
@@ -107,6 +151,10 @@ export type SideNavTargetId = 'side-nav-start' | 'side-nav' | 'side-nav-end';
 // @public
 export type StyleTargetId = 'header';
 
+// @public
+export class ZeroHeader extends Navigation {
+}
+
 // (No @packageDocumentation comment for this package)
 
 ```

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-header",
   "description": "Genesis Foundation Header",
-  "version": "14.178.0",
+  "version": "14.180.0",
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
   "types": "dist/foundation-header.d.ts",
@@ -28,7 +28,7 @@
     },
     "./config": {
       "types": "./dist/dts/config/index.d.ts",
-      "default": "./dist/esm/esm/config/index.js"
+      "default": "./dist/esm/config/index.js"
     },
     "./e2e": {
       "default": "./test/e2e/index.ts"
@@ -68,27 +68,27 @@
     "test:debug": "genx test --debug"
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.178.0",
-    "@genesislcap/genx": "14.178.0",
-    "@genesislcap/rollup-builder": "14.178.0",
-    "@genesislcap/ts-builder": "14.178.0",
-    "@genesislcap/uvu-playwright-builder": "14.178.0",
-    "@genesislcap/vite-builder": "14.178.0",
-    "@genesislcap/webpack-builder": "14.178.0",
+    "@genesislcap/foundation-testing": "14.180.0",
+    "@genesislcap/genx": "14.180.0",
+    "@genesislcap/rollup-builder": "14.180.0",
+    "@genesislcap/ts-builder": "14.180.0",
+    "@genesislcap/uvu-playwright-builder": "14.180.0",
+    "@genesislcap/vite-builder": "14.180.0",
+    "@genesislcap/webpack-builder": "14.180.0",
     "rimraf": "^3.0.2"
   },
   "dependencies": {
-    "@genesislcap/foundation-comms": "14.178.0",
-    "@genesislcap/foundation-events": "14.178.0",
-    "@genesislcap/foundation-i18n": "14.178.0",
-    "@genesislcap/foundation-logger": "14.178.0",
-    "@genesislcap/foundation-shell": "14.178.0",
-    "@genesislcap/foundation-ui": "14.178.0",
-    "@genesislcap/foundation-utils": "14.178.0",
-    "@genesislcap/foundation-zero": "14.178.0",
+    "@genesislcap/foundation-comms": "14.180.0",
+    "@genesislcap/foundation-events": "14.180.0",
+    "@genesislcap/foundation-i18n": "14.180.0",
+    "@genesislcap/foundation-logger": "14.180.0",
+    "@genesislcap/foundation-shell": "14.180.0",
+    "@genesislcap/foundation-ui": "14.180.0",
+    "@genesislcap/foundation-utils": "14.180.0",
+    "@genesislcap/foundation-zero": "14.180.0",
     "@microsoft/fast-colors": "^5.3.1",
-    "@microsoft/fast-components": "^2.30.6",
     "@microsoft/fast-element": "^1.12.0",
+    "@microsoft/fast-foundation": "^2.49.4",
     "@microsoft/fast-router": "^0.4.8",
     "tslib": "^2.3.1"
   },
@@ -101,5 +101,5 @@
     "access": "public"
   },
   "customElements": "dist/custom-elements.json",
-  "gitHead": "fd55a5cd2e3b0fa048377835c73186df1e75b849"
+  "gitHead": "24ddbaf4c43ccfe2c323ec1178b1829451b1721a"
 }

package/dist/dts/components/components.d.ts

@@ -1,9 +0,0 @@
-export declare const loadZeroDesignSystem: () => Promise<any>;
-/**
- * Load the wp5 module federation remote versions, or fallback to code split bundled versions.
- * You would really be targeting the client's design system, components etc here. For now just targeting zero.
- */
-export declare const loadRemotes: () => Promise<{
-    ZeroDesignSystem: any;
-}>;
-//# sourceMappingURL=components.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"components.d.ts","sourceRoot":"","sources":["../../../src/components/components.ts"],"names":[],"mappings":"AAqBA,eAAO,MAAM,oBAAoB,oBAWhC,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,WAAW;;EAKvB,CAAC"}

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

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

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC"}

package/dist/esm/components/components.js

@@ -1,42 +0,0 @@
-import { __awaiter } from "tslib";
-/**
- * These DS / Component imports will be replaced with an import from the local alpha design system.
- * We're just fixing something on our side to allow you to extend zero.
- */
-import { allComponents, provideFASTDesignSystem } from '@microsoft/fast-components';
-import { logger } from '../utils';
-provideFASTDesignSystem().register(allComponents);
-var ResourceType;
-(function (ResourceType) {
-    ResourceType["local"] = "local";
-    ResourceType["remote"] = "remote";
-})(ResourceType || (ResourceType = {}));
-function loadZeroFallback() {
-    return import(
-    /* webpackMode: "lazy" */
-    '@genesislcap/foundation-zero');
-}
-export const loadZeroDesignSystem = () => __awaiter(void 0, void 0, void 0, function* () {
-    let type = ResourceType.remote;
-    try {
-        // @ts-ignore
-        return yield import('foundationZero/ZeroDesignSystem');
-    }
-    catch (e) {
-        type = ResourceType.local;
-        return yield loadZeroFallback();
-    }
-    finally {
-        logger.debug(`Using '${type}' version of foundationZero/DesignSystem`);
-    }
-});
-/**
- * Load the wp5 module federation remote versions, or fallback to code split bundled versions.
- * You would really be targeting the client's design system, components etc here. For now just targeting zero.
- */
-export const loadRemotes = () => __awaiter(void 0, void 0, void 0, function* () {
-    const { registerZeroDesignSystem } = yield loadZeroDesignSystem();
-    return {
-        ZeroDesignSystem: registerZeroDesignSystem(),
-    };
-});

package/dist/esm/components/index.js

@@ -1 +0,0 @@
-export * from './components';