@genesislcap/foundation-shell 14.408.0 → 14.409.0

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

@@ -1,70 +0,0 @@
-<!-- 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): () => void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-routeCollection
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-The route collection to register [AppRoutes](./foundation-shell.approute.md) to.
-
-
-</td></tr>
-<tr><td>
-
-predicate
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-Optional [AppRoutePredicate](./foundation-shell.approutepredicate.md)<!-- -->.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-() =&gt; void
-

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

@@ -1,54 +0,0 @@
-<!-- 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
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-store
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-The [AppStore](./foundation-shell.appstore.md) to register.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-

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

@@ -1,70 +0,0 @@
-<!-- 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
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-storeRoot
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-The store root to register [AppStores](./foundation-shell.appstore.md) to.
-
-
-</td></tr>
-<tr><td>
-
-predicate
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-Optional [AppStorePredicate](./foundation-shell.appstorepredicate.md)<!-- -->.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-() =&gt; void
-

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

@@ -1,54 +0,0 @@
-<!-- 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
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-style
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-The [AppStyle](./foundation-shell.appstyle.md) to register.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-

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

@@ -1,72 +0,0 @@
-<!-- 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
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-targetId
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-[AppTargetId](./foundation-shell.apptargetid.md)<!-- -->.
-
-
-</td></tr>
-<tr><td>
-
-predicate
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-Optional [AppStylePredicate](./foundation-shell.appstylepredicate.md)<!-- -->.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-AppStylesTargetBehavior
-
-A  that will stay in sync as styles are registered and deregistered.
-

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

@@ -1,13 +0,0 @@
-<!-- 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

@@ -1,13 +0,0 @@
-<!-- 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

@@ -1,13 +0,0 @@
-<!-- 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

@@ -1,13 +0,0 @@
-<!-- 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

@@ -1,13 +0,0 @@
-<!-- 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

@@ -1,12 +0,0 @@
-<!-- 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: import("@microsoft/fast-element").ViewTemplate<MainApplication, any>
-```

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

@@ -1,30 +0,0 @@
-<!-- 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

@@ -1,68 +0,0 @@
-<!-- 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() function
-
-**Signature:**
-
-```typescript
-getQualifiedModuleTokens: <T extends any>(module: any, predicate: AppTokenTypePredicate) => T[]
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-module
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-An imported module.
-
-
-</td></tr>
-<tr><td>
-
-predicate
-
-
-</td><td>
-
-[AppTokenTypePredicate](./foundation-shell.apptokentypepredicate.md)
-
-
-</td><td>
-
-Token type predicate.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-T\[\]
-

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

@@ -1,17 +0,0 @@
-<!-- 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

@@ -1,15 +0,0 @@
-<!-- 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

@@ -1,75 +0,0 @@
-<!-- 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

@@ -1,52 +0,0 @@
-<!-- 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
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-token
-
-
-</td><td>
-
-unknown
-
-
-</td><td>
-
-A module export token.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-token is [AppElement](./foundation-shell.appelement.md)
-