@genesislcap/foundation-shell 14.408.0 → 14.409.0

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

@@ -1,33 +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; [RegisterStoreRoot](./foundation-shell.registerstoreroot.md)
-
-## RegisterStoreRoot type
-
-API for Application and Seed authors to register the .
-
-**Signature:**
-
-```typescript
-export type RegisterStoreRoot = (storeRoot: StoreRoot, predicate?: AppStorePredicate) => (source: unknown) => void;
-```
-**References:** [AppStorePredicate](./foundation-shell.appstorepredicate.md)
-
-## Example
-
-
-```ts
-// src/store/store.ts
-
-class DefaultStore extends AbstractStoreRoot<Store, StoreEventDetailMap> implements Store {
-  ...
-  constructor() {
-    super();
-
-    // Register the store root
-    getApp().registerStoreRoot(this);
-  }
-  ...
-}
-```
-

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

@@ -1,27 +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; [RegisterStylesTarget](./foundation-shell.registerstylestarget.md)
-
-## RegisterStylesTarget type
-
-API for Application and Seed authors to define dynamic [AppStyle](./foundation-shell.appstyle.md) integration points.
-
-**Signature:**
-
-```typescript
-export type RegisterStylesTarget = <T = string>(targetId: AppTargetId<T>, predicate?: AppStylePredicate) => Behavior;
-```
-**References:** [AppTargetId](./foundation-shell.apptargetid.md)<!-- -->, [AppStylePredicate](./foundation-shell.appstylepredicate.md)
-
-## Example
-
-Register styles targets as a  on a  definition.
-
-```ts
-export const MainStyles = css`
-  :host {
-    contain: content;
-  }
-`.withBehaviors(getApp().registerStylesTarget('main'));
-```
-

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

@@ -1,79 +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; [registrationPredicate](./foundation-shell.registrationpredicate.md)
-
-## registrationPredicate() function
-
-
-**Signature:**
-
-```typescript
-registrationPredicate: <A, P>(asset: A, predicate: P, context: AppContext) => boolean
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-asset
-
-
-</td><td>
-
-A
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-predicate
-
-
-</td><td>
-
-P
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-context
-
-
-</td><td>
-
-[AppContext](./foundation-shell.appcontext.md)
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-boolean
-

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

@@ -1,65 +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; [targetIdPredicate](./foundation-shell.targetidpredicate.md)
-
-## targetIdPredicate() function
-
-
-**Signature:**
-
-```typescript
-targetIdPredicate: (asset: HasTarget, targetId: AppTargetId) => boolean
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-asset
-
-
-</td><td>
-
-[HasTarget](./foundation-shell.hastarget.md)
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-targetId
-
-
-</td><td>
-
-[AppTargetId](./foundation-shell.apptargetid.md)
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-boolean
-

package/docs/api/index.md

@@ -1,30 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md)
-
-## API Reference
-
-## Packages
-
-<table><thead><tr><th>
-
-Package
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[@genesislcap/foundation-shell](./foundation-shell.md)
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api-report.md.api.md

@@ -1,296 +0,0 @@
-## API Report File for "@genesislcap/foundation-shell"
-
-> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
-
-```ts
-
-import { Behavior } from '@genesislcap/web-core';
-import { ComposableStyles } from '@genesislcap/web-core';
-import type { DesignSystemModule } from '@genesislcap/foundation-utils';
-import { ElementStyles } from '@genesislcap/web-core';
-import { FASTElement } from '@genesislcap/web-core';
-import type { FoundationAppContext } from '@genesislcap/foundation-ui';
-import type { FoundationRoute } from '@genesislcap/foundation-ui';
-import type { FoundationRouteCollection } from '@genesislcap/foundation-ui';
-import type { HasElement } from '@genesislcap/web-core';
-import type { HasTitle } from '@genesislcap/web-core';
-import { InterfaceSymbol } from '@microsoft/fast-foundation';
-import { Logger } from '@genesislcap/foundation-logger';
-import { RepeatOptions } from '@genesislcap/web-core';
-import { RepeatOptions as RepeatOptions_2 } from '@microsoft/fast-element';
-import type { StoreRoot } from '@genesislcap/foundation-store';
-import { ViewTemplate } from '@microsoft/fast-element';
-import { ViewTemplate as ViewTemplate_2 } from '@genesislcap/web-core';
-
-// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "App" because one of its declarations is marked as @internal
-//
-// @public
-export interface App extends AppAssets, AppRegister, AppValidity {
-    readonly config: AppConfig;
-    deregisterAssets(): void;
-    hasAssets(): boolean;
-    registerAssets(assets: Partial<AppAssets>): void;
-}
-
-// @internal
-export const App: InterfaceSymbol<App>;
-
-// @public
-export interface AppAssets {
-    readonly elements: AppElement[];
-    readonly metadata: AppMetadata[];
-    readonly registrations: AppRegistration[];
-    readonly routes: AppRoute[];
-    readonly stores: AppStore[];
-    readonly styles: AppStyle[];
-}
-
-// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "AppConfig" because one of its declarations is marked as @internal
-//
-// @public
-export interface AppConfig {
-    // (undocumented)
-    context?: AppContext;
-    // (undocumented)
-    defaultElementRepeatOptions?: RepeatOptions;
-}
-
-// @internal
-export const AppConfig: InterfaceSymbol<AppConfig>;
-
-// @public
-export type AppContext = FoundationAppContext;
-
-// @public
-export type AppDependencies = {
-    [key: string]: string;
-};
-
-// @public
-export type AppDependencyPrerequisites = {
-    [key: string]: string;
-};
-
-// @public (undocumented)
-export type AppElement<TSource = any, TParent = any, TTarget = string> = HasTarget<TTarget> & HasPredicate & {
-    elements: ViewTemplate_2<TSource, TParent>;
-    placementIndex?: number;
-    slotId?: string;
-    [key: string]: any;
-};
-
-// @public
-export type AppElementPredicate = (element: AppElement, context?: AppContext) => boolean;
-
-// @public (undocumented)
-export type AppMetadata = {
-    name: string;
-    version: string;
-    description?: string;
-    dependencies?: AppDependencies;
-    prerequisites?: AppDependencyPrerequisites;
-};
-
-// @public
-export interface AppRegister {
-    deregisterElement(element: AppElement): void;
-    deregisterRoute(route: AppRoute): void;
-    deregisterStore(store: AppStore): void;
-    deregisterStyle(style: AppStyle): void;
-    registerComponents: RegisterComponents;
-    registerElement(element: AppElement): void;
-    registerElementsTarget: RegisterElementsTarget;
-    registerRoute(route: AppRoute): void;
-    registerRouteCollection: RegisterRouteCollection;
-    registerStore(store: AppStore): void;
-    registerStoreRoot: RegisterStoreRoot;
-    registerStyle(style: AppStyle): void;
-    registerStylesTarget: RegisterStylesTarget;
-}
-
-// @public (undocumented)
-export type AppRegistration = (context: AppRegistrationContext) => void;
-
-// @public
-export type AppRegistrationContext = {
-    designSystem: DesignSystemModule;
-};
-
-// @public (undocumented)
-export type AppRoute = FoundationRoute & HasTitle & HasElement & HasPredicate;
-
-// @public
-export type AppRoutePredicate = (route: AppRoute, context?: AppContext) => boolean;
-
-// @public (undocumented)
-export type AppStore<S = any> = HasPredicate & {
-    store: S;
-};
-
-// @public
-export type AppStorePredicate = (store: AppStore, context?: AppContext) => boolean;
-
-// @public (undocumented)
-export type AppStyle<T = string> = HasTarget<T> & HasPredicate & {
-    styles: ComposableStyles | ComposableStyles[];
-};
-
-// @public
-export type AppStylePredicate = (style: AppStyle, context?: AppContext) => boolean;
-
-// @public
-export type AppTargetId<TTarget = string> = TTarget | TTarget[];
-
-// @public
-export type AppTokenTypePredicate = (token: unknown) => boolean;
-
-// @public
-export interface AppValidity {
-    isValid(context: AppValidityContext): boolean;
-}
-
-// @public
-export type AppValidityContext = {
-    dependencies?: AppDependencies;
-    prerequisites?: AppDependencyPrerequisites;
-};
-
-// @public
-export type AssetPredicate = (context?: AppContext) => boolean;
-
-// @public (undocumented)
-export const assetPredicate: (asset: HasPredicate, context: AppContext) => boolean;
-
-// @public
-export class DefaultApp implements App {
-    // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "App" has more than one declaration; you need to add a TSDoc member reference selector
-    //
-    // @internal (undocumented)
-    config: AppConfig;
-    // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "App" has more than one declaration; you need to add a TSDoc member reference selector
-    //
-    // (undocumented)
-    deregisterAssets(): void;
-    deregisterElement(element: any): void;
-    deregisterRoute(route: any): void;
-    deregisterStore(store: any): void;
-    deregisterStyle(style: any): void;
-    elements: AppElement[];
-    // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "App" has more than one declaration; you need to add a TSDoc member reference selector
-    //
-    // (undocumented)
-    hasAssets(): boolean;
-    isValid(context: any): boolean;
-    metadata: AppMetadata[];
-    // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "App" has more than one declaration; you need to add a TSDoc member reference selector
-    //
-    // (undocumented)
-    registerAssets(assets: any): void;
-    registerComponents(context: any): void;
-    registerElement(element: any): void;
-    registerElementsTarget(targetId: any, predicate: any, repeatOptions?: RepeatOptions_2): ViewTemplate<any, any>;
-    registerRoute(route: any): void;
-    registerRouteCollection(routeCollection: any, predicate: any): () => void;
-    registerStore(store: any): void;
-    registerStoreRoot(storeRoot: any, predicate: any): () => void;
-    registerStyle(style: any): void;
-    // Warning: (ae-forgotten-export) The symbol "AppStylesTargetBehavior" needs to be exported by the entry point index.docs.d.ts
-    registerStylesTarget(targetId: any, predicate: any): AppStylesTargetBehavior;
-    registrations: AppRegistration[];
-    routes: AppRoute[];
-    stores: AppStore[];
-    styles: AppStyle[];
-}
-
-// @public
-export const defaultAppConfig: AppConfig;
-
-// @public (undocumented)
-export const DynamicTemplate: ViewTemplate<MainApplication, any>;
-
-// @public
-export function getApp(): App;
-
-// @public (undocumented)
-export const getQualifiedModuleTokens: <T extends any>(module: any, predicate: AppTokenTypePredicate) => T[];
-
-// @public
-export type HasPredicate = {
-    predicate?: AssetPredicate;
-};
-
-// @public
-export type HasTarget<TTarget = string> = {
-    targetId: TTarget;
-};
-
-// @public
-export function importPBCAssets(): Promise<AppAssets>;
-
-// @public (undocumented)
-export function isAppElement(token: unknown): token is AppElement;
-
-// @public (undocumented)
-export function isAppMetadata(token: unknown): token is AppMetadata;
-
-// @public (undocumented)
-export function isAppRegistration(token: unknown): token is AppRegistration;
-
-// @public (undocumented)
-export function isAppRoute(token: unknown): token is AppRoute;
-
-// @public (undocumented)
-export function isAppStore(token: unknown): token is AppStore;
-
-// @public (undocumented)
-export function isAppStyle(token: unknown): token is AppStyle;
-
-// @public (undocumented)
-export function isComposableStyles(token: unknown): token is ComposableStyles;
-
-// @public (undocumented)
-export function isViewTemplate(token: unknown): token is ViewTemplate_2;
-
-// @public (undocumented)
-export const LoadingTemplate: ViewTemplate<MainApplication, any>;
-
-// @public
-export const logger: Logger;
-
-// @public (undocumented)
-export class MainApplication extends FASTElement {
-    // (undocumented)
-    connectedCallback(): void;
-    // (undocumented)
-    ready: boolean;
-    // (undocumented)
-    selectTemplate(): ViewTemplate<MainApplication, any>;
-}
-
-// @public (undocumented)
-export const MainTemplate: ViewTemplate<MainApplication, any>;
-
-// @public
-export type RegisterComponents = AppRegistration;
-
-// @public
-export type RegisterElementsTarget = <T = string>(targetId: AppTargetId<T>, predicate?: AppElementPredicate, repeatOptions?: RepeatOptions) => ViewTemplate_2;
-
-// @public
-export type RegisterRouteCollection = (routeCollection: FoundationRouteCollection, predicate?: AppRoutePredicate) => (source: unknown) => void;
-
-// @public
-export type RegisterStoreRoot = (storeRoot: StoreRoot, predicate?: AppStorePredicate) => (source: unknown) => void;
-
-// @public
-export type RegisterStylesTarget = <T = string>(targetId: AppTargetId<T>, predicate?: AppStylePredicate) => Behavior;
-
-// @public (undocumented)
-export const registrationPredicate: <A, P>(asset: A, predicate: P, context: AppContext) => boolean;
-
-// @public (undocumented)
-export const targetIdPredicate: (asset: HasTarget, targetId: AppTargetId) => boolean;
-
-// (No @packageDocumentation comment for this package)
-
-```