@genesislcap/foundation-shell 14.131.0 → 14.132.0

package/dist/dts/app/app.d.ts

@@ -0,0 +1,159 @@
+import { AppStylesTargetBehavior } from './behaviors';
+import { AppConfig } from './config';
+import type { AppAssets, AppElement, AppMetadata, AppRegister, AppRegistration, AppRoute, AppStore, AppStyle, AppValidity } from './types';
+/**
+ * `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.
+ *
+ * @example
+ * App reference via DI.
+ * ```ts
+ * import { App } from '@genesislcap/foundation-shell/app';
+ * ...
+ * @App private app: App;
+ * ```
+ *
+ * @example
+ * App reference via getApp util.
+ * ```ts
+ * import { getApp } from '@genesislcap/foundation-shell/app';
+ * ...
+ * const app = getApp();
+ * ```
+ *
+ * @public
+ */
+export interface App extends AppAssets, AppRegister, AppValidity {
+    /**
+     * High-level app configuration.
+     */
+    readonly config: AppConfig;
+    /**
+     * Register assets from either a globed dynamic import or some predefined AppAssets instance. This is a one time
+     * operation. Assets had be subsequently registered and deregistered using their individual APIs.
+     *
+     * @example
+     * Manual `AppAssets` registration.
+     * ```ts
+     * app.registerAssets({
+     *   // with or without pbcAssets
+     *   elements: [...],
+     *   metadata: [...],
+     *   registrations: [...],
+     *   routes: [...],
+     *   styles: [...],
+     *   stores: [...],
+     * });
+     * ```
+     *
+     * @example
+     * PBC `AppAssets` registration.
+     * ```ts
+     * import { importPBCAssets } from '@genesislcap/foundation-shell/pbc';
+     * ...
+     * const pbcAssets = await importPBCAssets();
+     * ...
+     * app.registerAssets(pbcAssets);
+     * ```
+     *
+     * @param assets - {@link AppAssets}.
+     */
+    registerAssets(assets: Partial<AppAssets>): void;
+    /**
+     * Deregister assets.
+     */
+    deregisterAssets(): void;
+    /**
+     * Check if the App has registered assets.
+     */
+    hasAssets(): boolean;
+}
+/**
+ * Default App implementation.
+ * @public
+ */
+export declare class DefaultApp implements App {
+    /**
+     * {@inheritDoc App.config}
+     * @internal
+     */
+    config: AppConfig;
+    /** {@inheritDoc AppAssets.elements} */
+    elements: AppElement[];
+    /** {@inheritDoc AppAssets.metadata} */
+    metadata: AppMetadata[];
+    /** {@inheritDoc AppAssets.registrations} */
+    registrations: AppRegistration[];
+    /** {@inheritDoc AppAssets.routes} */
+    routes: AppRoute[];
+    /** {@inheritDoc AppAssets.styles} */
+    styles: AppStyle[];
+    /** {@inheritDoc AppAssets.stores} */
+    stores: AppStore[];
+    /** {@inheritDoc AppRegister.registerElementsTarget} */
+    registerElementsTarget(targetId: any, predicate: any, repeatOptions?: import("@microsoft/fast-element").RepeatOptions): import("@microsoft/fast-element").ViewTemplate<any, any>;
+    /** {@inheritDoc AppRegister.registerElement} */
+    registerElement(element: any): void;
+    /** {@inheritDoc AppRegister.deregisterElement} */
+    deregisterElement(element: any): void;
+    /** {@inheritDoc AppRegister.registerRouteCollection} */
+    registerRouteCollection(routeCollection: any, predicate: any): any;
+    /** {@inheritDoc AppRegister.registerRoute} */
+    registerRoute(route: any): void;
+    /** {@inheritDoc AppRegister.deregisterRoute} */
+    deregisterRoute(route: any): void;
+    /** {@inheritDoc AppRegister.registerStoreRoot} */
+    registerStoreRoot(storeRoot: any, predicate: any): () => void;
+    /** {@inheritDoc AppRegister.registerStore} */
+    registerStore(store: any): void;
+    /** {@inheritDoc AppRegister.deregisterStore} */
+    deregisterStore(store: any): void;
+    /** {@inheritDoc AppRegister.registerStylesTarget} */
+    registerStylesTarget(targetId: any, predicate: any): AppStylesTargetBehavior;
+    /** {@inheritDoc AppRegister.registerStyle} */
+    registerStyle(style: any): void;
+    /** {@inheritDoc AppRegister.deregisterStyle} */
+    deregisterStyle(style: any): void;
+    /** {@inheritDoc AppRegister.registerComponents} */
+    registerComponents(context: any): void;
+    /**
+     * {@inheritDoc AppValidity.isValid}
+     *
+     * @privateRemarks
+     * This is a placeholder to potentially monitor metadata etc. as assets are registered and deregistered.
+     */
+    isValid(context: any): boolean;
+    /** {@inheritDoc App.registerAssets} */
+    registerAssets(assets: any): void;
+    /** {@inheritDoc App.deregisterAssets} */
+    deregisterAssets(): void;
+    /** {@inheritDoc App.hasAssets} */
+    hasAssets(): boolean;
+}
+/**
+ * App DI key.
+ *
+ * @privateRemarks
+ * Marked as internal to stop api-extractor becoming confused cross-linking tokens with the same name.
+ *
+ * @internal
+ */
+export declare const App: import("@microsoft/fast-foundation").InterfaceSymbol<App>;
+/**
+ * Gets App from the DI container.
+ *
+ * @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();
+ * ```
+ *
+ * @public
+ */
+export declare function getApp(): App;
+//# sourceMappingURL=app.d.ts.map

package/dist/dts/app/app.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../../../src/app/app.ts"],"names":[],"mappings":"AAEA,OAAO,EAAwC,uBAAuB,EAAE,MAAM,aAAa,CAAC;AAC5F,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AACrC,OAAO,KAAK,EACV,SAAS,EACT,UAAU,EAEV,WAAW,EACX,WAAW,EACX,eAAe,EACf,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,WAAW,EACZ,MAAM,SAAS,CAAC;AAGjB;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,WAAW,GAAI,SAAQ,SAAS,EAAE,WAAW,EAAE,WAAW;IAC9D;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC;IAC3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,cAAc,CAAC,MAAM,EAAE,OAAO,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;IAEjD;;OAEG;IACH,gBAAgB,IAAI,IAAI,CAAC;IAEzB;;OAEG;IACH,SAAS,IAAI,OAAO,CAAC;CACtB;AAED;;;GAGG;AACH,qBAAa,UAAW,YAAW,GAAG;IACpC;;;OAGG;IACQ,MAAM,EAAE,SAAS,CAAC;IAE7B,uCAAuC;IAC3B,QAAQ,EAAE,UAAU,EAAE,CAAM;IAExC,uCAAuC;IAC3B,QAAQ,EAAE,WAAW,EAAE,CAAM;IAEzC,4CAA4C;IAChC,aAAa,EAAE,eAAe,EAAE,CAAM;IAElD,qCAAqC;IACzB,MAAM,EAAE,QAAQ,EAAE,CAAM;IAEpC,qCAAqC;IACzB,MAAM,EAAE,QAAQ,EAAE,CAAM;IAEpC,qCAAqC;IACzB,MAAM,EAAE,QAAQ,EAAE,CAAM;IAEpC,uDAAuD;IACvD,sBAAsB,CACpB,QAAQ,KAAA,EACR,SAAS,KAAA,EACT,aAAa,kDAA0C;IAyBzD,gDAAgD;IAChD,eAAe,CAAC,OAAO,KAAA;IAIvB,kDAAkD;IAClD,iBAAiB,CAAC,OAAO,KAAA;IAOzB,wDAAwD;IACxD,uBAAuB,CAAC,eAAe,KAAA,EAAE,SAAS,KAAA;IAMlD,8CAA8C;IAC9C,aAAa,CAAC,KAAK,KAAA;IAInB,gDAAgD;IAChD,eAAe,CAAC,KAAK,KAAA;IAOrB,kDAAkD;IAClD,iBAAiB,CAAC,SAAS,KAAA,EAAE,SAAS,KAAA;IAMtC,8CAA8C;IAC9C,aAAa,CAAC,KAAK,KAAA;IAInB,gDAAgD;IAChD,eAAe,CAAC,KAAK,KAAA;IAOrB,qDAAqD;IACrD,oBAAoB,CAAC,QAAQ,KAAA,EAAE,SAAS,KAAA;IAIxC,8CAA8C;IAC9C,aAAa,CAAC,KAAK,KAAA;IAInB,gDAAgD;IAChD,eAAe,CAAC,KAAK,KAAA;IAOrB,mDAAmD;IACnD,kBAAkB,CAAC,OAAO,KAAA;IAQ1B;;;;;OAKG;IACH,OAAO,CAAC,OAAO,KAAA;IAIf,uCAAuC;IACvC,cAAc,CAAC,MAAM,KAAA;IAcrB,yCAAyC;IACzC,gBAAgB;IAShB,kCAAkC;IAClC,SAAS;CAUV;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,GAAG,2DAA0D,CAAC;AAE3E;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,MAAM,IAAI,GAAG,CAE5B"}

package/dist/dts/app/behaviors.d.ts

@@ -0,0 +1,53 @@
+import type { StoreRoot } from '@genesislcap/foundation-store';
+import type { FoundationRouteCollection } from '@genesislcap/foundation-ui';
+import { Behavior } from '@microsoft/fast-element';
+import type { ElementStyles, FASTElement } from '@microsoft/fast-element';
+import type { App } from './app';
+import type { AppRoute, AppRoutePredicate, AppStore, AppStorePredicate, AppStylePredicate, AppTargetId } from './types';
+/**
+ * @internal
+ */
+export declare class AppStylesTargetBehavior implements Behavior {
+    protected app: App;
+    protected targetId: AppTargetId;
+    protected predicate?: AppStylePredicate;
+    protected targetElement: FASTElement;
+    protected prevTargetStyles: ElementStyles;
+    protected nextTargetStyles: ElementStyles;
+    constructor(app: App, targetId: AppTargetId, predicate?: AppStylePredicate);
+    bind(elementInstance: FASTElement): void;
+    unbind(): void;
+    handleChange(): void;
+    protected updateTargetStyles(): void;
+}
+/**
+ * @internal
+ */
+export declare class AppRoutesBehavior implements Behavior {
+    protected app: App;
+    protected routeCollection: FoundationRouteCollection;
+    protected predicate?: AppRoutePredicate;
+    protected prevRoutes: AppRoute[];
+    protected nextRoutes: AppRoute[];
+    constructor(app: App, routeCollection: FoundationRouteCollection, predicate?: AppRoutePredicate);
+    bind(): void;
+    unbind(): void;
+    handleChange(): void;
+    protected updateTargetRoutes(): void;
+}
+/**
+ * @internal
+ */
+export declare class AppStoresBehavior implements Behavior {
+    protected app: App;
+    protected storeRoot: StoreRoot;
+    protected predicate?: AppStorePredicate;
+    protected prevStores: AppStore[];
+    protected nextStores: AppStore[];
+    constructor(app: App, storeRoot: StoreRoot, predicate?: AppStorePredicate);
+    bind(): void;
+    unbind(): void;
+    handleChange(): void;
+    protected updateTargetStores(): void;
+}
+//# sourceMappingURL=behaviors.d.ts.map

package/dist/dts/app/behaviors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"behaviors.d.ts","sourceRoot":"","sources":["../../../src/app/behaviors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,+BAA+B,CAAC;AAC/D,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAC;AAE5E,OAAO,EAAE,QAAQ,EAAc,MAAM,yBAAyB,CAAC;AAC/D,OAAO,KAAK,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAC1E,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AACjC,OAAO,KAAK,EACV,QAAQ,EACR,iBAAiB,EACjB,QAAQ,EACR,iBAAiB,EAEjB,iBAAiB,EACjB,WAAW,EACZ,MAAM,SAAS,CAAC;AAGjB;;GAEG;AACH,qBAAa,uBAAwB,YAAW,QAAQ;IAMpD,SAAS,CAAC,GAAG,EAAE,GAAG;IAClB,SAAS,CAAC,QAAQ,EAAE,WAAW;IAC/B,SAAS,CAAC,SAAS,CAAC,EAAE,iBAAiB;IAPzC,SAAS,CAAC,aAAa,EAAE,WAAW,CAAC;IACrC,SAAS,CAAC,gBAAgB,EAAE,aAAa,CAAC;IAC1C,SAAS,CAAC,gBAAgB,EAAE,aAAa,CAAC;gBAG9B,GAAG,EAAE,GAAG,EACR,QAAQ,EAAE,WAAW,EACrB,SAAS,CAAC,EAAE,iBAAiB;IAGzC,IAAI,CAAC,eAAe,EAAE,WAAW;IAMjC,MAAM;IAKN,YAAY;IAQZ,SAAS,CAAC,kBAAkB;CAkB7B;AAQD;;GAEG;AACH,qBAAa,iBAAkB,YAAW,QAAQ;IAK9C,SAAS,CAAC,GAAG,EAAE,GAAG;IAClB,SAAS,CAAC,eAAe,EAAE,yBAAyB;IACpD,SAAS,CAAC,SAAS,CAAC,EAAE,iBAAiB;IANzC,SAAS,CAAC,UAAU,EAAE,QAAQ,EAAE,CAAM;IACtC,SAAS,CAAC,UAAU,EAAE,QAAQ,EAAE,CAAM;gBAG1B,GAAG,EAAE,GAAG,EACR,eAAe,EAAE,yBAAyB,EAC1C,SAAS,CAAC,EAAE,iBAAiB;IAGzC,IAAI;IAKJ,MAAM;IAIN,YAAY;IAoBZ,SAAS,CAAC,kBAAkB;CAY7B;AAED;;GAEG;AACH,qBAAa,iBAAkB,YAAW,QAAQ;IAK9C,SAAS,CAAC,GAAG,EAAE,GAAG;IAClB,SAAS,CAAC,SAAS,EAAE,SAAS;IAC9B,SAAS,CAAC,SAAS,CAAC,EAAE,iBAAiB;IANzC,SAAS,CAAC,UAAU,EAAE,QAAQ,EAAE,CAAM;IACtC,SAAS,CAAC,UAAU,EAAE,QAAQ,EAAE,CAAM;gBAG1B,GAAG,EAAE,GAAG,EACR,SAAS,EAAE,SAAS,EACpB,SAAS,CAAC,EAAE,iBAAiB;IAGzC,IAAI;IAKJ,MAAM;IAIN,YAAY;IAeZ,SAAS,CAAC,kBAAkB;CAY7B"}

package/dist/dts/app/config.d.ts

@@ -0,0 +1,25 @@
+import type { RepeatOptions } from '@microsoft/fast-element';
+import type { AppContext } from './types';
+/**
+ * AppConfig DI interface.
+ *
+ * @public
+ */
+export interface AppConfig {
+    context?: AppContext;
+    defaultElementRepeatOptions?: RepeatOptions;
+}
+/**
+ * Default AppConfig DI implementation.
+ * @public
+ */
+export declare const defaultAppConfig: AppConfig;
+/**
+ * AppConfig DI key.
+ *
+ * @internal
+ * @privateRemarks
+ * Marked as internal to stop api-extractor becoming confused cross-linking tokens with the same name.
+ */
+export declare const AppConfig: import("@microsoft/fast-foundation").InterfaceSymbol<AppConfig>;
+//# sourceMappingURL=config.d.ts.map

package/dist/dts/app/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../../src/app/config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAE7D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAE1C;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB,2BAA2B,CAAC,EAAE,aAAa,CAAC;CAC7C;AAED;;;GAGG;AACH,eAAO,MAAM,gBAAgB,EAAE,SAc9B,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,SAAS,iEAAqE,CAAC"}

package/dist/dts/app/index.d.ts

@@ -0,0 +1,5 @@
+export * from './app';
+export * from './config';
+export * from './types';
+export * from './utils';
+//# sourceMappingURL=index.d.ts.map

package/dist/dts/app/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/app/index.ts"],"names":[],"mappings":"AAAA,cAAc,OAAO,CAAC;AACtB,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC"}