npm - @genesislcap/foundation-shell - Versions diffs - 14.408.0 → 14.409.0 - Mend

@genesislcap/foundation-shell 14.408.0 → 14.409.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (106) hide show

package/docs/api/foundation-shell.md DELETED Viewed

@@ -1,617 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md)
-## foundation-shell package
-## Classes
-<table><thead><tr><th>
-Class
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[DefaultApp](./foundation-shell.defaultapp.md)
-</td><td>
-Default App implementation.
-</td></tr>
-<tr><td>
-[MainApplication](./foundation-shell.mainapplication.md)
-</td><td>
-</td></tr>
-</tbody></table>
-## Functions
-<table><thead><tr><th>
-Function
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[assetPredicate(asset, context)](./foundation-shell.assetpredicate.md)
-</td><td>
-</td></tr>
-<tr><td>
-[getApp()](./foundation-shell.getapp.md)
-</td><td>
-Gets App from the DI container.
-</td></tr>
-<tr><td>
-[getQualifiedModuleTokens(module, predicate)](./foundation-shell.getqualifiedmoduletokens.md)
-</td><td>
-</td></tr>
-<tr><td>
-[importPBCAssets()](./foundation-shell.importpbcassets.md)
-</td><td>
-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.
-</td></tr>
-<tr><td>
-[isAppElement(token)](./foundation-shell.isappelement.md)
-</td><td>
-</td></tr>
-<tr><td>
-[isAppMetadata(token)](./foundation-shell.isappmetadata.md)
-</td><td>
-</td></tr>
-<tr><td>
-[isAppRegistration(token)](./foundation-shell.isappregistration.md)
-</td><td>
-</td></tr>
-<tr><td>
-[isAppRoute(token)](./foundation-shell.isapproute.md)
-</td><td>
-</td></tr>
-<tr><td>
-[isAppStore(token)](./foundation-shell.isappstore.md)
-</td><td>
-</td></tr>
-<tr><td>
-[isAppStyle(token)](./foundation-shell.isappstyle.md)
-</td><td>
-</td></tr>
-<tr><td>
-[isComposableStyles(token)](./foundation-shell.iscomposablestyles.md)
-</td><td>
-</td></tr>
-<tr><td>
-[isViewTemplate(token)](./foundation-shell.isviewtemplate.md)
-</td><td>
-</td></tr>
-<tr><td>
-[registrationPredicate(asset, predicate, context)](./foundation-shell.registrationpredicate.md)
-</td><td>
-</td></tr>
-<tr><td>
-[targetIdPredicate(asset, targetId)](./foundation-shell.targetidpredicate.md)
-</td><td>
-</td></tr>
-</tbody></table>
-## Interfaces
-<table><thead><tr><th>
-Interface
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[App](./foundation-shell.app.md)
-</td><td>
-`App` provides APIs to register integration targets for PBCs and other actors to register their assets in bulk via token exports. It also provides specific APIs to add single assets to the application itself, like routes, elements, styles, store fragments etc.
-</td></tr>
-<tr><td>
-[AppAssets](./foundation-shell.appassets.md)
-</td><td>
-Dynamically registered assets.
-</td></tr>
-<tr><td>
-[AppConfig](./foundation-shell.appconfig.md)
-</td><td>
-AppConfig DI interface.
-</td></tr>
-<tr><td>
-[AppRegister](./foundation-shell.appregister.md)
-</td><td>
-APIs to register asset targets and assets. These can be lazily registered and deregistered.
-</td></tr>
-<tr><td>
-[AppValidity](./foundation-shell.appvalidity.md)
-</td><td>
-APIs to check app validity.
-</td></tr>
-</tbody></table>
-## Variables
-<table><thead><tr><th>
-Variable
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[defaultAppConfig](./foundation-shell.defaultappconfig.md)
-</td><td>
-Default AppConfig DI implementation.
-</td></tr>
-<tr><td>
-[DynamicTemplate](./foundation-shell.dynamictemplate.md)
-</td><td>
-</td></tr>
-<tr><td>
-[LoadingTemplate](./foundation-shell.loadingtemplate.md)
-</td><td>
-</td></tr>
-<tr><td>
-[logger](./foundation-shell.logger.md)
-</td><td>
-Logger for the foundation-shell package
-</td></tr>
-<tr><td>
-[MainTemplate](./foundation-shell.maintemplate.md)
-</td><td>
-</td></tr>
-</tbody></table>
-## Type Aliases
-<table><thead><tr><th>
-Type Alias
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[AppContext](./foundation-shell.appcontext.md)
-</td><td>
-Context passed to predicate functions and other utilities.
-</td></tr>
-<tr><td>
-[AppDependencies](./foundation-shell.appdependencies.md)
-</td><td>
-A record of app dependencies.
-</td></tr>
-<tr><td>
-[AppDependencyPrerequisites](./foundation-shell.appdependencyprerequisites.md)
-</td><td>
-A record of app dependency prerequisites.
-</td></tr>
-<tr><td>
-[AppElement](./foundation-shell.appelement.md)
-</td><td>
-</td></tr>
-<tr><td>
-[AppElementPredicate](./foundation-shell.appelementpredicate.md)
-</td><td>
-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.
-</td></tr>
-<tr><td>
-[AppMetadata](./foundation-shell.appmetadata.md)
-</td><td>
-</td></tr>
-<tr><td>
-[AppRegistration](./foundation-shell.appregistration.md)
-</td><td>
-</td></tr>
-<tr><td>
-[AppRegistrationContext](./foundation-shell.appregistrationcontext.md)
-</td><td>
-Context used during component registration.
-</td></tr>
-<tr><td>
-[AppRoute](./foundation-shell.approute.md)
-</td><td>
-</td></tr>
-<tr><td>
-[AppRoutePredicate](./foundation-shell.approutepredicate.md)
-</td><td>
-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.
-</td></tr>
-<tr><td>
-[AppStore](./foundation-shell.appstore.md)
-</td><td>
-</td></tr>
-<tr><td>
-[AppStorePredicate](./foundation-shell.appstorepredicate.md)
-</td><td>
-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.
-</td></tr>
-<tr><td>
-[AppStyle](./foundation-shell.appstyle.md)
-</td><td>
-</td></tr>
-<tr><td>
-[AppStylePredicate](./foundation-shell.appstylepredicate.md)
-</td><td>
-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.
-</td></tr>
-<tr><td>
-[AppTargetId](./foundation-shell.apptargetid.md)
-</td><td>
-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.
-</td></tr>
-<tr><td>
-[AppTokenTypePredicate](./foundation-shell.apptokentypepredicate.md)
-</td><td>
-Determine if export token should be included in the import all glob.
-</td></tr>
-<tr><td>
-[AppValidityContext](./foundation-shell.appvaliditycontext.md)
-</td><td>
-Context used to assess app validity.
-</td></tr>
-<tr><td>
-[AssetPredicate](./foundation-shell.assetpredicate.md)
-</td><td>
-Asset runtime predicate function.
-</td></tr>
-<tr><td>
-[HasPredicate](./foundation-shell.haspredicate.md)
-</td><td>
-Interface that includes `predicate` function.
-</td></tr>
-<tr><td>
-[HasTarget](./foundation-shell.hastarget.md)
-</td><td>
-Interface that includes `targetId`<!-- -->.
-</td></tr>
-<tr><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.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.registerroutecollection.md)
-</td><td>
-API for Application and Seed authors to register the main .
-</td></tr>
-<tr><td>
-[RegisterStoreRoot](./foundation-shell.registerstoreroot.md)
-</td><td>
-API for Application and Seed authors to register the .
-</td></tr>
-<tr><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>

package/docs/api/foundation-shell.registercomponents.md DELETED Viewed

@@ -1,34 +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; [RegisterComponents](./foundation-shell.registercomponents.md)
-## RegisterComponents type
-API for Application and Seed authors to register dynamic components.
-**Signature:**
-```typescript
-export type RegisterComponents = AppRegistration;
-```
-**References:** [AppRegistration](./foundation-shell.appregistration.md)
-## Example
-Register components.
-```ts
-export async function registerComponents() {
-  const designSystem = await designSystemImport();
-  const { provideDesignSystem, baseComponents } = designSystem;
-  ...
-  // Register any pbc components with the design system
-  getApp().registerComponents({
-    designSystem,
-  });
-  ...
-  provideDesignSystem().register(...);
-}
-```
-PBCs or other application assets may need to register components with the design system of the application, or simply to ensure they are referenced, so they can be used in template literals without the risk of them being tree-shaken out by the application's build process.

package/docs/api/foundation-shell.registerelementstarget.md DELETED Viewed

@@ -1,39 +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; [RegisterElementsTarget](./foundation-shell.registerelementstarget.md)
-## RegisterElementsTarget type
-API for Application and Seed authors to define dynamic [AppElement](./foundation-shell.appelement.md) integration points.
-**Signature:**
-```typescript
-export type RegisterElementsTarget = <T = string>(targetId: AppTargetId<T>, predicate?: AppElementPredicate, repeatOptions?: RepeatOptions) => ViewTemplate;
-```
-**References:** [AppTargetId](./foundation-shell.apptargetid.md)<!-- -->, [AppElementPredicate](./foundation-shell.appelementpredicate.md)
-## Example 1
-Register elements targets within a  template literal. An array can be used to integrate assets targeting N number of targets to the one integration location, ie. `['layout', 'layout-end']`<!-- -->.
-```ts
-html`
- ${app.registerElementsTarget('layout-start')}
- ...
- ${app.registerElementsTarget(['layout', 'layout-end'])}
-`
-```
-## Example 2
-Providing a predicate function to filter what elements you will allow.
-```ts
-html`
- ${app.registerElementsTarget('admin-tools', (element: AppElement, context: AppContext) => {
-   return context.user.isAdmin();
- })}
-`
-```

package/docs/api/foundation-shell.registerroutecollection.md DELETED Viewed

@@ -1,24 +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; [RegisterRouteCollection](./foundation-shell.registerroutecollection.md)
-## RegisterRouteCollection type
-API for Application and Seed authors to register the main .
-**Signature:**
-```typescript
-export type RegisterRouteCollection = (routeCollection: FoundationRouteCollection, predicate?: AppRoutePredicate) => (source: unknown) => void;
-```
-**References:** [AppRoutePredicate](./foundation-shell.approutepredicate.md)
-## Example
-```ts
-// src/main/main.ts
-...
-getApp().registerRouteCollection(this.config.routes);
-```