@genesislcap/foundation-shell 14.408.0 → 14.409.0

package/docs/api/foundation-shell.appregister.registerelementstarget.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; [registerElementsTarget](./foundation-shell.appregister.registerelementstarget.md)
-
-## AppRegister.registerElementsTarget property
-
-API for Application and Seed authors to define dynamic [AppElement](./foundation-shell.appelement.md) integration points.
-
-**Signature:**
-
-```typescript
-registerElementsTarget: RegisterElementsTarget;
-```

package/docs/api/foundation-shell.appregister.registerroute.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; [registerRoute](./foundation-shell.appregister.registerroute.md)
-
-## AppRegister.registerRoute() method
-
-API for developers to register [AppRoutes](./foundation-shell.approute.md) lazily.
-
-**Signature:**
-
-```typescript
-registerRoute(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 register.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-
-## Example
-
-
-```ts
-getApp().registerRoute(someAppRoute);
-```
-

package/docs/api/foundation-shell.appregister.registerroutecollection.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; [registerRouteCollection](./foundation-shell.appregister.registerroutecollection.md)
-
-## AppRegister.registerRouteCollection property
-
-API for Application and Seed authors to register the main .
-
-**Signature:**
-
-```typescript
-registerRouteCollection: RegisterRouteCollection;
-```

package/docs/api/foundation-shell.appregister.registerstore.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; [registerStore](./foundation-shell.appregister.registerstore.md)
-
-## AppRegister.registerStore() method
-
-API for developers to register [AppStores](./foundation-shell.appstore.md) lazily.
-
-**Signature:**
-
-```typescript
-registerStore(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 register.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-
-## Example
-
-
-```ts
-getApp().registerStore(someAppStore);
-```
-

package/docs/api/foundation-shell.appregister.registerstoreroot.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; [registerStoreRoot](./foundation-shell.appregister.registerstoreroot.md)
-
-## AppRegister.registerStoreRoot property
-
-API for Application and Seed authors to register the .
-
-**Signature:**
-
-```typescript
-registerStoreRoot: RegisterStoreRoot;
-```

package/docs/api/foundation-shell.appregister.registerstyle.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; [registerStyle](./foundation-shell.appregister.registerstyle.md)
-
-## AppRegister.registerStyle() method
-
-API for developers to register [AppStyles](./foundation-shell.appstyle.md) lazily.
-
-**Signature:**
-
-```typescript
-registerStyle(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 register.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-
-## Example
-
-
-```ts
-getApp().registerStyle(someAppStyle);
-```
-

package/docs/api/foundation-shell.appregister.registerstylestarget.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; [registerStylesTarget](./foundation-shell.appregister.registerstylestarget.md)
-
-## AppRegister.registerStylesTarget property
-
-API for Application and Seed authors to define dynamic [AppStyle](./foundation-shell.appstyle.md) integration points.
-
-**Signature:**
-
-```typescript
-registerStylesTarget: RegisterStylesTarget;
-```

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

@@ -1,57 +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; [AppRegistration](./foundation-shell.appregistration.md)
-
-## AppRegistration type
-
-**Signature:**
-
-```typescript
-export type AppRegistration = (context: AppRegistrationContext) => void;
-```
-**References:** [AppRegistrationContext](./foundation-shell.appregistrationcontext.md)
-
-## Example 1
-
-Simple registration function to include a component and avoid it being tree-shaken out of the build.
-
-```ts
-// src/pbc/notify/registrations.ts
-
-export function registerAlerts() {
-  FoundationAlerts;
-}
-```
-
-## Example 2
-
-Combined registration function.
-
-```ts
-// src/pbc/notify/registrations.ts
-
-export function register() {
-  FoundationAlerts;
-  FoundationInbox;
-  ...
-}
-```
-
-## Example 3
-
-Using the host application's registration context to register with the design system and import from it if needed.
-
-```ts
-// src/pbc/notify/registrations.ts
-
-export async function registerAlerts(context: AppRegistrationContext) {
-  try {
-    const { provideDesignSystem, tokenX } = context.designSystem;
-    provideDesignSystem().register(foundationAlerts, tokenX);
-  } catch (e) {
-    console.error('Error registering alerts', e);
-  }
-}
-```
-When defining `AppRegistration` functions in a PBC context, consider defining separate register functions if various subcomponents may be conditionally included based on user preferences or runtime predicates.
-

package/docs/api/foundation-shell.appregistrationcontext.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; [AppRegistrationContext](./foundation-shell.appregistrationcontext.md)
-
-## AppRegistrationContext type
-
-Context used during component registration.
-
-**Signature:**
-
-```typescript
-export type AppRegistrationContext = {
-    designSystem: DesignSystemModule;
-};
-```

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

@@ -1,49 +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; [AppRoute](./foundation-shell.approute.md)
-
-## AppRoute type
-
-**Signature:**
-
-```typescript
-export type AppRoute = FoundationRoute & HasTitle & HasElement & HasPredicate;
-```
-**References:** [HasPredicate](./foundation-shell.haspredicate.md)
-
-## Example 1
-
-AppRoute definition example.
-
-```ts
-export const reporting: AppRoute = {
-  title: 'Reporting',
-  path: 'reporting',
-  name: 'reporting',
-  element: async () => (await import('@genesislcap/pbc-reporting')).Reporting,
-  navItems: [
-    {
-      navId: 'header',
-      title: 'Reporting',
-      icon: {
-        name: 'file-csv',
-        variant: 'solid',
-      },
-      placementIndex: 15,
-    },
-  ],
-};
-```
-
-## Example 2
-
-Optional runtime [AssetPredicate](./foundation-shell.assetpredicate.md) function to determine if the asset should be used.
-
-```ts
-export const reportingAdmin: AppRoute = {
-  path: 'reporting-admin',
-  predicate: (context: AppContext) => context.user.isAdmin(),
-  ...
-}
-```
-

package/docs/api/foundation-shell.approutepredicate.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; [AppRoutePredicate](./foundation-shell.approutepredicate.md)
-
-## AppRoutePredicate type
-
-Determine if the [AppRoute](./foundation-shell.approute.md) should be integrated.
-
-Provides app, micro frontend, and seed author fine-grained control over what assets they will accept in their target integration points.
-
-**Signature:**
-
-```typescript
-export type AppRoutePredicate = (route: AppRoute, context?: AppContext) => boolean;
-```
-**References:** [AppRoute](./foundation-shell.approute.md)<!-- -->, [AppContext](./foundation-shell.appcontext.md)
-

package/docs/api/foundation-shell.appstore.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; [AppStore](./foundation-shell.appstore.md)
-
-## AppStore type
-
-**Signature:**
-
-```typescript
-export type AppStore<S = any> = HasPredicate & {
-    store: S;
-};
-```
-**References:** [HasPredicate](./foundation-shell.haspredicate.md)
-
-## Example 1
-
-AppStore definition example.
-
-```ts
-// src/pbc/notify/stores.ts
-
-// Setup the foundation stores your PBC needs to function, then include the following for each:
-
-export function getNotifyStore(): NotifyStore {
-  return DI.getOrCreateDOMContainer().get(NotifyStore) as NotifyStore;
-}
-
-// The actual `AppStore` definition
-export const notifyAppStore: AppStore<NotifyStore> = {
-  store: getNotifyStore(),
-};
-```
-
-## Example 2
-
-Optional runtime [AssetPredicate](./foundation-shell.assetpredicate.md) function to determine if the asset should be used.
-
-```ts
-export const notifyAppStore: AppStore<NotifyStore> = {
-  store: getNotifyStore(),
-  predicate: (context: AppContext) => true, // < assess the user, permissions, env, domain, etc.
-};
-```
-

package/docs/api/foundation-shell.appstorepredicate.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; [AppStorePredicate](./foundation-shell.appstorepredicate.md)
-
-## AppStorePredicate type
-
-Determine if [AppStore](./foundation-shell.appstore.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.
-
-**Signature:**
-
-```typescript
-export type AppStorePredicate = (store: AppStore, context?: AppContext) => boolean;
-```
-**References:** [AppStore](./foundation-shell.appstore.md)<!-- -->, [AppContext](./foundation-shell.appcontext.md)
-

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

@@ -1,48 +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; [AppStyle](./foundation-shell.appstyle.md)
-
-## AppStyle type
-
-**Signature:**
-
-```typescript
-export type AppStyle<T = string> = HasTarget<T> & HasPredicate & {
-    styles: ComposableStyles | ComposableStyles[];
-};
-```
-**References:** [HasTarget](./foundation-shell.hastarget.md)<!-- -->, [HasPredicate](./foundation-shell.haspredicate.md)
-
-## Example 1
-
-AppStyle definition example.
-
-```ts
-export const alerts: AppStyle = {
-  targetId: 'layout',
-  styles: css`
-    foundation-alerts {
-      --design-unit: 2.5;
-      --stroke-width: 1;
-    }
-
-    foundation-alerts::part(filter-button) {
-      --design-unit: 4;
-    }
-  `,
-};
-```
-
-## Example 2
-
-Optional runtime [AssetPredicate](./foundation-shell.assetpredicate.md) function to determine if the asset should be used.
-
-```ts
-export const alerts: AppStyle = {
-  targetId: 'layout',
-  predicate: (context: AppContext) => context.user.isAdmin(),
-  styles: css``,
-  ...
-}
-```
-

package/docs/api/foundation-shell.appstylepredicate.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; [AppStylePredicate](./foundation-shell.appstylepredicate.md)
-
-## AppStylePredicate type
-
-Determine if [AppStyle](./foundation-shell.appstyle.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.
-
-**Signature:**
-
-```typescript
-export type AppStylePredicate = (style: AppStyle, context?: AppContext) => boolean;
-```
-**References:** [AppStyle](./foundation-shell.appstyle.md)<!-- -->, [AppContext](./foundation-shell.appcontext.md)
-

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

@@ -1,43 +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; [AppTargetId](./foundation-shell.apptargetid.md)
-
-## AppTargetId type
-
-A targetId string or an array of targetId strings.
-
-Apps and micro frontends will predefine integration targets that dynamic app assets can target using a `targetId` property. This creates a pull-like effect where the host can live reload itself should any matching asset be lazily added, removed, or customised.
-
-**Signature:**
-
-```typescript
-export type AppTargetId<TTarget = string> = TTarget | TTarget[];
-```
-
-## Example
-
-Foundation-header example.
-
-```ts
-// src/main/targetId.ts
-
-export type NavTargetId = 'nav-start' | 'nav' | 'nav-end';
-export type SideNavTargetId = 'side-nav-start' | 'side-nav' | 'side-nav-end';
-export type ElementTargetId = HeaderTargetId | NavTargetId | SideNavTargetId;
-export type StyleTargetId = 'header';
-
-// src/main/main.template.ts
-
-export const NavTemplate = html<Navigation>`
-   ...
-   ${app.registerElementsTarget<NavTargetId>('nav-start')}
-   ...
-`
-
-// src/main/main.styles.ts
-
-export const MainStyles = css`
-   ...
-`.withBehaviors(getApp().registerStylesTarget<StyleTargetId>('header'));
-```
-

package/docs/api/foundation-shell.apptokentypepredicate.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; [AppTokenTypePredicate](./foundation-shell.apptokentypepredicate.md)
-
-## AppTokenTypePredicate type
-
-Determine if export token should be included in the import all glob.
-
-**Signature:**
-
-```typescript
-export type AppTokenTypePredicate = (token: unknown) => boolean;
-```

package/docs/api/foundation-shell.appvalidity.isvalid.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; [AppValidity](./foundation-shell.appvalidity.md) &gt; [isValid](./foundation-shell.appvalidity.isvalid.md)
-
-## AppValidity.isValid() method
-
-Monitors metadata and other data points as assets are registered and deregistered for app validity.
-
-**Signature:**
-
-```typescript
-isValid(context: AppValidityContext): boolean;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-context
-
-
-</td><td>
-
-[AppValidityContext](./foundation-shell.appvaliditycontext.md)
-
-
-</td><td>
-
-[AppValidityContext](./foundation-shell.appvaliditycontext.md)<!-- -->.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-boolean
-
-A boolean to indicate app validity.
-

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

@@ -1,40 +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; [AppValidity](./foundation-shell.appvalidity.md)
-
-## AppValidity interface
-
-APIs to check app validity.
-
-**Signature:**
-
-```typescript
-export interface AppValidity 
-```
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[isValid(context)](./foundation-shell.appvalidity.isvalid.md)
-
-
-</td><td>
-
-Monitors metadata and other data points as assets are registered and deregistered for app validity.
-
-
-</td></tr>
-</tbody></table>
-

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

@@ -1,18 +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; [AppValidityContext](./foundation-shell.appvaliditycontext.md)
-
-## AppValidityContext type
-
-Context used to assess app validity.
-
-**Signature:**
-
-```typescript
-export type AppValidityContext = {
-    dependencies?: AppDependencies;
-    prerequisites?: AppDependencyPrerequisites;
-};
-```
-**References:** [AppDependencies](./foundation-shell.appdependencies.md)<!-- -->, [AppDependencyPrerequisites](./foundation-shell.appdependencyprerequisites.md)
-