@genesislcap/foundation-shell 14.408.0 → 14.409.0

package/docs/api/foundation-shell.appdependencies.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; [AppDependencies](./foundation-shell.appdependencies.md)
-
-## AppDependencies type
-
-A record of app dependencies.
-
-**Signature:**
-
-```typescript
-export type AppDependencies = {
-    [key: string]: string;
-};
-```

package/docs/api/foundation-shell.appdependencyprerequisites.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; [AppDependencyPrerequisites](./foundation-shell.appdependencyprerequisites.md)
-
-## AppDependencyPrerequisites type
-
-A record of app dependency prerequisites.
-
-**Signature:**
-
-```typescript
-export type AppDependencyPrerequisites = {
-    [key: string]: string;
-};
-```

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

@@ -1,56 +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; [AppElement](./foundation-shell.appelement.md)
-
-## AppElement type
-
-**Signature:**
-
-```typescript
-export type AppElement<TSource = any, TParent = any, TTarget = string> = HasTarget<TTarget> & HasPredicate & {
-    elements: ViewTemplate<TSource, TParent>;
-    placementIndex?: number;
-    slotId?: string;
-    [key: string]: any;
-};
-```
-**References:** [HasTarget](./foundation-shell.hastarget.md)<!-- -->, [HasPredicate](./foundation-shell.haspredicate.md)
-
-## Example 1
-
-AppElement definition example.
-
-```ts
-const store = getNotifyStore();
-...
-export const inboxFlyout: AppElement = {
-  targetId: 'layout',
-  elements: html`
-    <zero-flyout
-      position="right"
-      @closed=${(x, c) => c.parent.$emit('change-inbox-display', false)}
-      ?closed=${() => !store.inboxDisplayState}
-      displayHeader=${false}
-      data-pbc-asset-id="inbox-flyout"
-    >
-      <foundation-inbox
-        @close=${(x, c) => (<Flyout>(<HTMLElement>c.event.target).parentNode).closeFlyout()}
-      ></foundation-inbox>
-    </zero-flyout>
-  `,
-};
-```
-Note that bindings may need to use `c.parent` to `$emit` or reference properties of the target integration point. The inclusion of a `data-pbc-asset-id` is not a hard requirement, but should be considered for future operations.
-
-## Example 2
-
-Optional runtime [AssetPredicate](./foundation-shell.assetpredicate.md) function to determine if the asset should be used.
-
-```ts
-export const inboxFlyout: AppElement = {
-  targetId: 'layout',
-  predicate: (context: AppContext) => true, // < assess the user, permissions, env, domain, etc.
-  elements: html``,
-}
-```
-

package/docs/api/foundation-shell.appelementpredicate.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; [AppElementPredicate](./foundation-shell.appelementpredicate.md)
-
-## AppElementPredicate type
-
-Determine if [AppElement](./foundation-shell.appelement.md) should be included during runtime integration.
-
-Provides app, micro frontend, and seed author fine-grained control over what assets they will accept in their target integration points. This is a similar concept to  which may be applied to slotted content. For example the accordion accepts slotted accordionItems only.
-
-**Signature:**
-
-```typescript
-export type AppElementPredicate = (element: AppElement, context?: AppContext) => boolean;
-```
-**References:** [AppElement](./foundation-shell.appelement.md)<!-- -->, [AppContext](./foundation-shell.appcontext.md)
-

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

@@ -1,45 +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; [AppMetadata](./foundation-shell.appmetadata.md)
-
-## AppMetadata type
-
-**Signature:**
-
-```typescript
-export type AppMetadata = {
-    name: string;
-    version: string;
-    description?: string;
-    dependencies?: AppDependencies;
-    prerequisites?: AppDependencyPrerequisites;
-};
-```
-**References:** [AppDependencies](./foundation-shell.appdependencies.md)<!-- -->, [AppDependencyPrerequisites](./foundation-shell.appdependencyprerequisites.md)
-
-## Remarks
-
-It is not a hard requirement to have a `metadata.ts` file or a `AppMetadata` export token.
-
-## Example
-
-AppMetadata definition example.
-
-```ts
-// src/pbc/reporting/metadata.ts
-
-export const metadata: AppMetadata = {
-  name: '@genesiscommunitysuccess/pbc-reporting',
-  description: 'Genesis Reporting PBC',
-  version: '1.0.0',
-  prerequisites: {
-    '@genesislcap/foundation-ui': '14.0.0',
-    gsf: '7.1.0-SNAPSHOT',
-  },
-  dependencies: {
-    '@genesislcap/pbc-reporting': '1.0.0',
-    serverDepId: '7.1.0-SNAPSHOT',
-  },
-};
-```
-

package/docs/api/foundation-shell.appregister.deregisterelement.md

@@ -1,61 +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; [AppRegister](./foundation-shell.appregister.md) &gt; [deregisterElement](./foundation-shell.appregister.deregisterelement.md)
-
-## AppRegister.deregisterElement() method
-
-API for developers to deregister [AppElements](./foundation-shell.appelement.md)<!-- -->.
-
-**Signature:**
-
-```typescript
-deregisterElement(element: AppElement): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-element
-
-
-</td><td>
-
-[AppElement](./foundation-shell.appelement.md)
-
-
-</td><td>
-
-The [AppElement](./foundation-shell.appelement.md) to deregister.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-
-## Example
-
-
-```ts
-getApp().deregisterElement(someAppElement);
-```
-

package/docs/api/foundation-shell.appregister.deregisterroute.md

@@ -1,61 +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; [AppRegister](./foundation-shell.appregister.md) &gt; [deregisterRoute](./foundation-shell.appregister.deregisterroute.md)
-
-## AppRegister.deregisterRoute() method
-
-API for developers to deregister [AppRoutes](./foundation-shell.approute.md)<!-- -->.
-
-**Signature:**
-
-```typescript
-deregisterRoute(route: AppRoute): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-route
-
-
-</td><td>
-
-[AppRoute](./foundation-shell.approute.md)
-
-
-</td><td>
-
-The [AppRoute](./foundation-shell.approute.md) to deregister.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-
-## Example
-
-
-```ts
-getApp().deregisterRoute(someAppRoute);
-```
-

package/docs/api/foundation-shell.appregister.deregisterstore.md

@@ -1,61 +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; [AppRegister](./foundation-shell.appregister.md) &gt; [deregisterStore](./foundation-shell.appregister.deregisterstore.md)
-
-## AppRegister.deregisterStore() method
-
-API for developers to deregister [AppStores](./foundation-shell.appstore.md)<!-- -->.
-
-**Signature:**
-
-```typescript
-deregisterStore(store: AppStore): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-store
-
-
-</td><td>
-
-[AppStore](./foundation-shell.appstore.md)
-
-
-</td><td>
-
-The [AppStore](./foundation-shell.appstore.md) to deregister.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-
-## Example
-
-
-```ts
-getApp().deregisterStore(someAppStore);
-```
-

package/docs/api/foundation-shell.appregister.deregisterstyle.md

@@ -1,61 +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; [AppRegister](./foundation-shell.appregister.md) &gt; [deregisterStyle](./foundation-shell.appregister.deregisterstyle.md)
-
-## AppRegister.deregisterStyle() method
-
-API for developers to deregister [AppStyles](./foundation-shell.appstyle.md)<!-- -->.
-
-**Signature:**
-
-```typescript
-deregisterStyle(style: AppStyle): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-style
-
-
-</td><td>
-
-[AppStyle](./foundation-shell.appstyle.md)
-
-
-</td><td>
-
-The [AppStyle](./foundation-shell.appstyle.md) to deregister.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-
-## Example
-
-
-```ts
-getApp().deregisterStyle(someAppStyle);
-```
-

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

@@ -1,237 +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; [AppRegister](./foundation-shell.appregister.md)
-
-## AppRegister interface
-
-APIs to register asset targets and assets. These can be lazily registered and deregistered.
-
-**Signature:**
-
-```typescript
-export interface AppRegister 
-```
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[registerComponents](./foundation-shell.appregister.registercomponents.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[RegisterComponents](./foundation-shell.registercomponents.md)
-
-
-</td><td>
-
-API for Application and Seed authors to register dynamic components.
-
-
-</td></tr>
-<tr><td>
-
-[registerElementsTarget](./foundation-shell.appregister.registerelementstarget.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[RegisterElementsTarget](./foundation-shell.registerelementstarget.md)
-
-
-</td><td>
-
-API for Application and Seed authors to define dynamic [AppElement](./foundation-shell.appelement.md) integration points.
-
-
-</td></tr>
-<tr><td>
-
-[registerRouteCollection](./foundation-shell.appregister.registerroutecollection.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[RegisterRouteCollection](./foundation-shell.registerroutecollection.md)
-
-
-</td><td>
-
-API for Application and Seed authors to register the main .
-
-
-</td></tr>
-<tr><td>
-
-[registerStoreRoot](./foundation-shell.appregister.registerstoreroot.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[RegisterStoreRoot](./foundation-shell.registerstoreroot.md)
-
-
-</td><td>
-
-API for Application and Seed authors to register the .
-
-
-</td></tr>
-<tr><td>
-
-[registerStylesTarget](./foundation-shell.appregister.registerstylestarget.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[RegisterStylesTarget](./foundation-shell.registerstylestarget.md)
-
-
-</td><td>
-
-API for Application and Seed authors to define dynamic [AppStyle](./foundation-shell.appstyle.md) integration points.
-
-
-</td></tr>
-</tbody></table>
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[deregisterElement(element)](./foundation-shell.appregister.deregisterelement.md)
-
-
-</td><td>
-
-API for developers to deregister [AppElements](./foundation-shell.appelement.md)<!-- -->.
-
-
-</td></tr>
-<tr><td>
-
-[deregisterRoute(route)](./foundation-shell.appregister.deregisterroute.md)
-
-
-</td><td>
-
-API for developers to deregister [AppRoutes](./foundation-shell.approute.md)<!-- -->.
-
-
-</td></tr>
-<tr><td>
-
-[deregisterStore(store)](./foundation-shell.appregister.deregisterstore.md)
-
-
-</td><td>
-
-API for developers to deregister [AppStores](./foundation-shell.appstore.md)<!-- -->.
-
-
-</td></tr>
-<tr><td>
-
-[deregisterStyle(style)](./foundation-shell.appregister.deregisterstyle.md)
-
-
-</td><td>
-
-API for developers to deregister [AppStyles](./foundation-shell.appstyle.md)<!-- -->.
-
-
-</td></tr>
-<tr><td>
-
-[registerElement(element)](./foundation-shell.appregister.registerelement.md)
-
-
-</td><td>
-
-API for developers to register [AppElements](./foundation-shell.appelement.md) lazily.
-
-
-</td></tr>
-<tr><td>
-
-[registerRoute(route)](./foundation-shell.appregister.registerroute.md)
-
-
-</td><td>
-
-API for developers to register [AppRoutes](./foundation-shell.approute.md) lazily.
-
-
-</td></tr>
-<tr><td>
-
-[registerStore(store)](./foundation-shell.appregister.registerstore.md)
-
-
-</td><td>
-
-API for developers to register [AppStores](./foundation-shell.appstore.md) lazily.
-
-
-</td></tr>
-<tr><td>
-
-[registerStyle(style)](./foundation-shell.appregister.registerstyle.md)
-
-
-</td><td>
-
-API for developers to register [AppStyles](./foundation-shell.appstyle.md) lazily.
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/foundation-shell.appregister.registercomponents.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; [AppRegister](./foundation-shell.appregister.md) &gt; [registerComponents](./foundation-shell.appregister.registercomponents.md)
-
-## AppRegister.registerComponents property
-
-API for Application and Seed authors to register dynamic components.
-
-**Signature:**
-
-```typescript
-registerComponents: RegisterComponents;
-```

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

@@ -1,61 +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; [AppRegister](./foundation-shell.appregister.md) &gt; [registerElement](./foundation-shell.appregister.registerelement.md)
-
-## AppRegister.registerElement() method
-
-API for developers to register [AppElements](./foundation-shell.appelement.md) lazily.
-
-**Signature:**
-
-```typescript
-registerElement(element: AppElement): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-element
-
-
-</td><td>
-
-[AppElement](./foundation-shell.appelement.md)
-
-
-</td><td>
-
-The [AppElement](./foundation-shell.appelement.md) to register.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-
-## Example
-
-
-```ts
-getApp().registerElement(someAppElement);
-```
-