@genesislcap/foundation-shell 14.131.0 → 14.133.0

package/docs/api/foundation-shell.defaultapp.registerassets.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [DefaultApp](./foundation-shell.defaultapp.md) &gt; [registerAssets](./foundation-shell.defaultapp.registerassets.md)
+
+## DefaultApp.registerAssets() method
+
+Register assets from either a globed dynamic import or some predefined AppAssets instance. This is a one time operation. Assets had be subsequently registered and deregistered using their individual APIs.
+
+**Signature:**
+
+```typescript
+registerAssets(assets: any): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  assets | any | [AppAssets](./foundation-shell.appassets.md)<!-- -->. |
+
+**Returns:**
+
+void
+

package/docs/api/foundation-shell.defaultapp.registercomponents.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [DefaultApp](./foundation-shell.defaultapp.md) &gt; [registerComponents](./foundation-shell.defaultapp.registercomponents.md)
+
+## DefaultApp.registerComponents() method
+
+API for Application and Seed authors to register dynamic components.
+
+**Signature:**
+
+```typescript
+registerComponents(context: any): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  context | any |  |
+
+**Returns:**
+
+void
+

package/docs/api/foundation-shell.defaultapp.registerelement.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [DefaultApp](./foundation-shell.defaultapp.md) &gt; [registerElement](./foundation-shell.defaultapp.registerelement.md)
+
+## DefaultApp.registerElement() method
+
+API for developers to register [AppElements](./foundation-shell.appelement.md) lazily.
+
+**Signature:**
+
+```typescript
+registerElement(element: any): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  element | any | The [AppElement](./foundation-shell.appelement.md) to register. |
+
+**Returns:**
+
+void
+

package/docs/api/foundation-shell.defaultapp.registerelementstarget.md

@@ -0,0 +1,28 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [DefaultApp](./foundation-shell.defaultapp.md) &gt; [registerElementsTarget](./foundation-shell.defaultapp.registerelementstarget.md)
+
+## DefaultApp.registerElementsTarget() method
+
+API for Application and Seed authors to define dynamic [AppElement](./foundation-shell.appelement.md) integration points.
+
+**Signature:**
+
+```typescript
+registerElementsTarget(targetId: any, predicate: any, repeatOptions?: import("@microsoft/fast-element").RepeatOptions): import("@microsoft/fast-element").ViewTemplate<any, any>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  targetId | any | [AppTargetId](./foundation-shell.apptargetid.md)<!-- -->. |
+|  predicate | any | Optional [AppElementPredicate](./foundation-shell.appelementpredicate.md)<!-- -->. |
+|  repeatOptions | import("@microsoft/fast-element").RepeatOptions | _(Optional)_ |
+
+**Returns:**
+
+import("@microsoft/fast-element").ViewTemplate&lt;any, any&gt;
+
+A  fragment that will stay in sync as elements are registered and deregistered.
+

package/docs/api/foundation-shell.defaultapp.registerroute.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [DefaultApp](./foundation-shell.defaultapp.md) &gt; [registerRoute](./foundation-shell.defaultapp.registerroute.md)
+
+## DefaultApp.registerRoute() method
+
+API for developers to register [AppRoutes](./foundation-shell.approute.md) lazily.
+
+**Signature:**
+
+```typescript
+registerRoute(route: any): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  route | any | The [AppRoute](./foundation-shell.approute.md) to register. |
+
+**Returns:**
+
+void
+

package/docs/api/foundation-shell.defaultapp.registerroutecollection.md

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [DefaultApp](./foundation-shell.defaultapp.md) &gt; [registerRouteCollection](./foundation-shell.defaultapp.registerroutecollection.md)
+
+## DefaultApp.registerRouteCollection() method
+
+API for Application and Seed authors to register the main .
+
+**Signature:**
+
+```typescript
+registerRouteCollection(routeCollection: any, predicate: any): any;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  routeCollection | any | The route collection to register [AppRoutes](./foundation-shell.approute.md) to. |
+|  predicate | any | Optional [AppRoutePredicate](./foundation-shell.approutepredicate.md)<!-- -->. |
+
+**Returns:**
+
+any
+

package/docs/api/foundation-shell.defaultapp.registerstore.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [DefaultApp](./foundation-shell.defaultapp.md) &gt; [registerStore](./foundation-shell.defaultapp.registerstore.md)
+
+## DefaultApp.registerStore() method
+
+API for developers to register [AppStores](./foundation-shell.appstore.md) lazily.
+
+**Signature:**
+
+```typescript
+registerStore(store: any): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  store | any | The [AppStore](./foundation-shell.appstore.md) to register. |
+
+**Returns:**
+
+void
+

package/docs/api/foundation-shell.defaultapp.registerstoreroot.md

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [DefaultApp](./foundation-shell.defaultapp.md) &gt; [registerStoreRoot](./foundation-shell.defaultapp.registerstoreroot.md)
+
+## DefaultApp.registerStoreRoot() method
+
+API for Application and Seed authors to register the .
+
+**Signature:**
+
+```typescript
+registerStoreRoot(storeRoot: any, predicate: any): () => void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  storeRoot | any | The store root to register [AppStores](./foundation-shell.appstore.md) to. |
+|  predicate | any | Optional [AppStorePredicate](./foundation-shell.appstorepredicate.md)<!-- -->. |
+
+**Returns:**
+
+() =&gt; void
+

package/docs/api/foundation-shell.defaultapp.registerstyle.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [DefaultApp](./foundation-shell.defaultapp.md) &gt; [registerStyle](./foundation-shell.defaultapp.registerstyle.md)
+
+## DefaultApp.registerStyle() method
+
+API for developers to register [AppStyles](./foundation-shell.appstyle.md) lazily.
+
+**Signature:**
+
+```typescript
+registerStyle(style: any): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  style | any | The [AppStyle](./foundation-shell.appstyle.md) to register. |
+
+**Returns:**
+
+void
+

package/docs/api/foundation-shell.defaultapp.registerstylestarget.md

@@ -0,0 +1,27 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [DefaultApp](./foundation-shell.defaultapp.md) &gt; [registerStylesTarget](./foundation-shell.defaultapp.registerstylestarget.md)
+
+## DefaultApp.registerStylesTarget() method
+
+API for Application and Seed authors to define dynamic [AppStyle](./foundation-shell.appstyle.md) integration points.
+
+**Signature:**
+
+```typescript
+registerStylesTarget(targetId: any, predicate: any): AppStylesTargetBehavior;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  targetId | any | [AppTargetId](./foundation-shell.apptargetid.md)<!-- -->. |
+|  predicate | any | Optional [AppStylePredicate](./foundation-shell.appstylepredicate.md)<!-- -->. |
+
+**Returns:**
+
+AppStylesTargetBehavior
+
+A  that will stay in sync as styles are registered and deregistered.
+

package/docs/api/foundation-shell.defaultapp.registrations.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [DefaultApp](./foundation-shell.defaultapp.md) &gt; [registrations](./foundation-shell.defaultapp.registrations.md)
+
+## DefaultApp.registrations property
+
+All [AppRegistration](./foundation-shell.appregistration.md) tokens.
+
+**Signature:**
+
+```typescript
+registrations: AppRegistration[];
+```

package/docs/api/foundation-shell.defaultapp.routes.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [DefaultApp](./foundation-shell.defaultapp.md) &gt; [routes](./foundation-shell.defaultapp.routes.md)
+
+## DefaultApp.routes property
+
+All [AppRoute](./foundation-shell.approute.md) tokens.
+
+**Signature:**
+
+```typescript
+routes: AppRoute[];
+```

package/docs/api/foundation-shell.defaultapp.stores.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [DefaultApp](./foundation-shell.defaultapp.md) &gt; [stores](./foundation-shell.defaultapp.stores.md)
+
+## DefaultApp.stores property
+
+All [AppStore](./foundation-shell.appstore.md) tokens.
+
+**Signature:**
+
+```typescript
+stores: AppStore[];
+```

package/docs/api/foundation-shell.defaultapp.styles.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [DefaultApp](./foundation-shell.defaultapp.md) &gt; [styles](./foundation-shell.defaultapp.styles.md)
+
+## DefaultApp.styles property
+
+All [AppStyle](./foundation-shell.appstyle.md) tokens.
+
+**Signature:**
+
+```typescript
+styles: AppStyle[];
+```

package/docs/api/foundation-shell.defaultappconfig.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [defaultAppConfig](./foundation-shell.defaultappconfig.md)
+
+## defaultAppConfig variable
+
+Default AppConfig DI implementation.
+
+**Signature:**
+
+```typescript
+defaultAppConfig: AppConfig
+```

package/docs/api/foundation-shell.dynamictemplate.md

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [DynamicTemplate](./foundation-shell.dynamictemplate.md)
+
+## DynamicTemplate variable
+
+
+**Signature:**
+
+```typescript
+DynamicTemplate: ViewTemplate<MainApplication>
+```

package/docs/api/foundation-shell.getapp.md

@@ -0,0 +1,30 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [getApp](./foundation-shell.getapp.md)
+
+## getApp() function
+
+Gets App from the DI container.
+
+**Signature:**
+
+```typescript
+export declare function getApp(): App;
+```
+**Returns:**
+
+[App](./foundation-shell.app.md)
+
+## Remarks
+
+A utility method for host applications that are not using decorators or the DI container.
+
+## Example
+
+
+```ts
+import { getApp } from '@genesislcap/foundation-shell/app';
+...
+private user = getApp();
+```
+

package/docs/api/foundation-shell.getqualifiedmoduletokens.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [getQualifiedModuleTokens](./foundation-shell.getqualifiedmoduletokens.md)
+
+## getQualifiedModuleTokens variable
+
+**Signature:**
+
+```typescript
+getQualifiedModuleTokens: <T extends unknown>(module: any, predicate: AppTokenTypePredicate) => T[]
+```

package/docs/api/foundation-shell.haspredicate.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [HasPredicate](./foundation-shell.haspredicate.md)
+
+## HasPredicate type
+
+Interface that includes `predicate` function.
+
+**Signature:**
+
+```typescript
+export type HasPredicate = {
+    predicate?: AssetPredicate;
+};
+```
+**References:** [AssetPredicate](./foundation-shell.assetpredicate.md)
+

package/docs/api/foundation-shell.hastarget.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [HasTarget](./foundation-shell.hastarget.md)
+
+## HasTarget type
+
+Interface that includes `targetId`<!-- -->.
+
+**Signature:**
+
+```typescript
+export type HasTarget<TTarget = string> = {
+    targetId: TTarget;
+};
+```

package/docs/api/foundation-shell.importpbcassets.md

@@ -0,0 +1,75 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [importPBCAssets](./foundation-shell.importpbcassets.md)
+
+## importPBCAssets() function
+
+A utility for importing PBC assets that have been added to the application's src/pbc directory via genx add.
+
+The `genx` builder (webpack or vite) will attempt to dynamically load all PBC assets from the application's `src/pbc` directory by default. The returned AppAssets can then be applied to the App. Please note that `app.registerAssets` is a one-time operation, intended for upfront bulk registration. After this point, you must use the single asset APIs of the `App` for lazy asset registration or deregistration.
+
+**Signature:**
+
+```typescript
+export declare function importPBCAssets(): Promise<AppAssets>;
+```
+**Returns:**
+
+Promise&lt;[AppAssets](./foundation-shell.appassets.md)<!-- -->&gt;
+
+## Example 1
+
+
+```ts
+import { importPBCAssets } from '@genesislcap/foundation-shell/pbc';
+...
+const assets = await importPBCAssets();
+...
+app.registerAssets(assets);
+```
+
+## Example 2
+
+A typical app setup that makes use of PBC imports might look like this.
+
+```ts
+// src/main/main.ts
+
+@App app: App;
+
+async connectedCallback() {
+  ...
+  await this.loadPBCs();
+  ...
+}
+
+async loadPBCs() {
+  // Import PBC assets that may have been added to the ./pbc directory by genx or by hand
+  const pbcAssets = await importPBCAssets();
+
+  // Register bulk assets
+  this.app.registerAssets(pbcAssets);
+
+  // Register the top-level route collection
+  this.app.registerRouteCollection(this.config.routes);
+}
+```
+The rest of the PBC setup is handled by the system automatically, however, you will still need to register application asset integration points.
+
+## Example 3
+
+A typical PBC directory structure may look like this.
+
+```markdown
+├── reporting
+│   ├── elements.ts
+│   ├── metadata.ts
+│   ├── registrations.ts
+│   ├── routes.ts
+│   ├── stores.ts
+│   └── styles.ts
+```
+Each file is dynamically loaded and processed as part of the overall PBC set the application contains. PBCs do not need to include `index.ts` files, and export token naming does not matter within any of these files. For example, `foo` here `export const foo: AppElement = {...}` has no impact on PBC integration.
+
+The answers generated from the `genx add` cli flows can be used to tailor what PBC assets are included at build-time.
+

package/docs/api/foundation-shell.isappelement.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [isAppElement](./foundation-shell.isappelement.md)
+
+## isAppElement() function
+
+**Signature:**
+
+```typescript
+export declare function isAppElement(token: unknown): token is AppElement;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  token | unknown | A module export token. |
+
+**Returns:**
+
+token is [AppElement](./foundation-shell.appelement.md)
+

package/docs/api/foundation-shell.isappmetadata.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [isAppMetadata](./foundation-shell.isappmetadata.md)
+
+## isAppMetadata() function
+
+**Signature:**
+
+```typescript
+export declare function isAppMetadata(token: unknown): token is AppMetadata;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  token | unknown | A module export token. |
+
+**Returns:**
+
+token is [AppMetadata](./foundation-shell.appmetadata.md)
+

package/docs/api/foundation-shell.isappregistration.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [isAppRegistration](./foundation-shell.isappregistration.md)
+
+## isAppRegistration() function
+
+**Signature:**
+
+```typescript
+export declare function isAppRegistration(token: unknown): token is AppRegistration;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  token | unknown | A module export token. |
+
+**Returns:**
+
+token is [AppRegistration](./foundation-shell.appregistration.md)
+

package/docs/api/foundation-shell.isapproute.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [isAppRoute](./foundation-shell.isapproute.md)
+
+## isAppRoute() function
+
+**Signature:**
+
+```typescript
+export declare function isAppRoute(token: unknown): token is AppRoute;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  token | unknown | A module export token. |
+
+**Returns:**
+
+token is [AppRoute](./foundation-shell.approute.md)
+

package/docs/api/foundation-shell.isappstore.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [isAppStore](./foundation-shell.isappstore.md)
+
+## isAppStore() function
+
+**Signature:**
+
+```typescript
+export declare function isAppStore(token: unknown): token is AppStore;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  token | unknown | A module export token. |
+
+**Returns:**
+
+token is [AppStore](./foundation-shell.appstore.md)
+

package/docs/api/foundation-shell.isappstyle.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [isAppStyle](./foundation-shell.isappstyle.md)
+
+## isAppStyle() function
+
+**Signature:**
+
+```typescript
+export declare function isAppStyle(token: unknown): token is AppStyle;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  token | unknown | A module export token. |
+
+**Returns:**
+
+token is [AppStyle](./foundation-shell.appstyle.md)
+

package/docs/api/foundation-shell.iscomposablestyles.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [isComposableStyles](./foundation-shell.iscomposablestyles.md)
+
+## isComposableStyles() function
+
+**Signature:**
+
+```typescript
+export declare function isComposableStyles(token: unknown): token is ComposableStyles;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  token | unknown | A module export token / styles candidate. |
+
+**Returns:**
+
+token is ComposableStyles
+