sample-cross-fx 0.14.28 → 0.15.0-beta.4465

package/app/index.d.ts

@@ -7,7 +7,6 @@ import * as Riot from 'riot';
 import * as SolidJs from 'solid-js';
 import * as ReactRouter from 'react-router';
 import * as AngularCore from '@angular/core';
-import * as LibreAtom from '@libre/atom';
 
 declare module "sample-cross-fx" {
   /**
@@ -113,9 +112,47 @@ declare module "sample-cross-fx" {
   }
 
   /**
-   * Describes the metadata transported by a pilet.
+   * Describes the metadata of a pilet available in its API.
    */
-  export type PiletMetadata = (SinglePiletMetadata | MultiPiletMetadata) & PiletRuntimeMetadata;
+  export interface PiletMetadata {
+    /**
+     * The name of the pilet, i.e., the package id.
+     */
+    name: string;
+    /**
+     * The version of the pilet. Should be semantically versioned.
+     */
+    version: string;
+    /**
+     * Provides the version of the specification for this pilet.
+     */
+    spec: string;
+    /**
+     * Provides some custom metadata for the pilet.
+     */
+    custom?: any;
+    /**
+     * Optionally indicates the global require reference, if any.
+     */
+    requireRef?: string;
+    /**
+     * Additional shared dependencies from the pilet.
+     */
+    dependencies: Record<string, string>;
+    /**
+     * Provides some configuration to be used in the pilet.
+     */
+    config: Record<string, any>;
+    /**
+     * The URL of the main script of the pilet.
+     */
+    link: string;
+    /**
+     * The base path to the pilet. Can be used to make resource requests
+     * and override the public path.
+     */
+    basePath: string;
+  }
 
   /**
    * Listener for Piral app shell events.
@@ -458,7 +495,7 @@ declare module "sample-cross-fx" {
   /**
    * The meta data registered for a page.
    */
-  export interface PiralPageMeta extends PiralCustomPageMeta {}
+  export interface PiralPageMeta extends PiralCustomPageMeta, PiralCustomPageMeta {}
 
   /**
    * The shape of an implicit unregister function.
@@ -489,23 +526,6 @@ declare module "sample-cross-fx" {
     (): void;
   }
 
-  /**
-   * The metadata response for a single pilet.
-   */
-  export type SinglePiletMetadata = PiletMetadataV0 | PiletMetadataV1 | PiletMetadataV2 | PiletMetadataVx;
-
-  /**
-   * The metadata response for a multi pilet.
-   */
-  export type MultiPiletMetadata = PiletMetadataBundle;
-
-  /**
-   * Additional metadata that may be added to the runtime information.
-   */
-  export interface PiletRuntimeMetadata {
-    basePath?: string;
-  }
-
   /**
    * Custom events defined outside of piral-core.
    */
@@ -939,158 +959,6 @@ declare module "sample-cross-fx" {
     name: TName;
   }
 
-  /**
-   * Metadata for pilets using the v0 schema.
-   */
-  export type PiletMetadataV0 = PiletMetadataV0Content | PiletMetadataV0Link;
-
-  /**
-   * Metadata for pilets using the v1 schema.
-   */
-  export interface PiletMetadataV1 {
-    /**
-     * The name of the pilet, i.e., the package id.
-     */
-    name: string;
-    /**
-     * The version of the pilet. Should be semantically versioned.
-     */
-    version: string;
-    /**
-     * Optionally provides the version of the specification for this pilet.
-     */
-    spec?: "v1";
-    /**
-     * The link for retrieving the content of the pilet.
-     */
-    link: string;
-    /**
-     * The reference name for the global require.
-     */
-    requireRef: string;
-    /**
-     * The computed integrity of the pilet. Will be used to set the
-     * integrity value of the script.
-     */
-    integrity?: string;
-    /**
-     * Optionally provides some custom metadata for the pilet.
-     */
-    custom?: any;
-    /**
-     * Optionally provides some configuration to be used in the pilet.
-     */
-    config?: Record<string, any>;
-    /**
-     * Additional shared dependency script files.
-     */
-    dependencies?: Record<string, string>;
-  }
-
-  /**
-   * Metadata for pilets using the v2 schema.
-   */
-  export interface PiletMetadataV2 {
-    /**
-     * The name of the pilet, i.e., the package id.
-     */
-    name: string;
-    /**
-     * The version of the pilet. Should be semantically versioned.
-     */
-    version: string;
-    /**
-     * Provides the version of the specification for this pilet.
-     */
-    spec: "v2";
-    /**
-     * The reference name for the global require.
-     */
-    requireRef: string;
-    /**
-     * The computed integrity of the pilet.
-     */
-    integrity?: string;
-    /**
-     * The link for retrieving the content of the pilet.
-     */
-    link: string;
-    /**
-     * Optionally provides some custom metadata for the pilet.
-     */
-    custom?: any;
-    /**
-     * Optionally provides some configuration to be used in the pilet.
-     */
-    config?: Record<string, any>;
-    /**
-     * Additional shared dependency script files.
-     */
-    dependencies?: Record<string, string>;
-  }
-
-  export interface PiletMetadataVx {
-    /**
-     * The name of the pilet, i.e., the package id.
-     */
-    name: string;
-    /**
-     * The version of the pilet. Should be semantically versioned.
-     */
-    version: string;
-    /**
-     * Provides an identifier for the custom specification.
-     */
-    spec: string;
-    /**
-     * Optionally provides some custom metadata for the pilet.
-     */
-    custom?: any;
-    /**
-     * Optionally provides some configuration to be used in the pilet.
-     */
-    config?: Record<string, any>;
-    /**
-     * Additional shared dependency script files.
-     */
-    dependencies?: Record<string, string>;
-  }
-
-  /**
-   * Metadata for pilets using the bundle schema.
-   */
-  export interface PiletMetadataBundle {
-    /**
-     * The name of the bundle pilet, i.e., the package id.
-     */
-    name?: string;
-    /**
-     * Optionally provides the version of the specification for this pilet.
-     */
-    spec?: "v1";
-    /**
-     * The link for retrieving the bundle content of the pilet.
-     */
-    link: string;
-    /**
-     * The reference name for the global bundle-shared require.
-     */
-    bundle: string;
-    /**
-     * The computed integrity of the pilet. Will be used to set the
-     * integrity value of the script.
-     */
-    integrity?: string;
-    /**
-     * Optionally provides some custom metadata for the pilet.
-     */
-    custom?: any;
-    /**
-     * Additional shared dependency script files.
-     */
-    dependencies?: Record<string, string>;
-  }
-
   /**
    * Options passed through to Angular `bootstrapModule`.
    * 
@@ -1232,40 +1100,11 @@ declare module "sample-cross-fx" {
     defaults: any;
   }
 
-  /**
-   * Metadata for pilets using the v0 schema with a content.
-   */
-  export interface PiletMetadataV0Content extends PiletMetadataV0Base {
-    /**
-     * The content of the pilet. If the content is not available
-     * the link will be used (unless caching has been activated).
-     */
-    content: string;
-    /**
-     * If available indicates that the pilet should not be cached.
-     * In case of a string this is interpreted as the expiration time
-     * of the cache. In case of an accurate hash this should not be
-     * required or set.
-     */
-    noCache?: boolean | string;
-  }
-
-  /**
-   * Metadata for pilets using the v0 schema with a link.
-   */
-  export interface PiletMetadataV0Link extends PiletMetadataV0Base {
-    /**
-     * The link for retrieving the content of the pilet.
-     */
-    link: string;
-  }
-
   /**
    * The context to be transported into the generic components.
    */
   export interface ComponentContext {
     router: ReactRouter.RouteComponentProps;
-    state: LibreAtom.Atom<GlobalState>;
     readState: PiralActions["readState"];
   }
 
@@ -1279,117 +1118,52 @@ declare module "sample-cross-fx" {
     pilet: string;
   }
 
-  export type WrappedComponent<TProps> = React.ComponentType<Without<TProps, keyof BaseComponentProps>>;
+  export type WrappedComponent<TProps> = React.ComponentType<React.PropsWithChildren<Without<TProps, keyof BaseComponentProps>>>;
 
   /**
-   * Basic metadata for pilets using the v0 schema.
+   * The globally defined actions.
    */
-  export interface PiletMetadataV0Base {
-    /**
-     * The name of the pilet, i.e., the package id.
-     */
-    name: string;
+  export interface PiralActions extends PiralCustomActions {
     /**
-     * The version of the pilet. Should be semantically versioned.
+     * Initializes the application shell.
+     * @param loading The current loading state.
+     * @param error The application error, if any.
+     * @param modules The loaded pilets.
      */
-    version: string;
+    initialize(loading: boolean, error: Error | undefined, modules: Array<Pilet>): void;
     /**
-     * Optionally provides the version of the specification for this pilet.
+     * Injects an evaluated pilet at runtime - removes the pilet from registry first if available.
+     * @param pilet The pilet to be injected.
+     * @returns The injected pilet.
      */
-    spec?: "v0";
+    injectPilet(pilet: Pilet): Pilet;
     /**
-     * The computed hash value of the pilet's content. Should be
-     * accurate to allow caching.
+     * Adds a pilet at runtime by loading it, evaluating it, and then injecting it.
+     * @param pilet The pilet to be added.
+     * @returns The promise indicating when the pilet was fully added.
      */
-    hash: string;
+    addPilet(pilet: PiletEntry): Promise<void>;
     /**
-     * Optionally provides some custom metadata for the pilet.
+     * Removes a pilet by unloading it and deleting all component registrations.
+     * @param name The name of the pilet to remove.
      */
-    custom?: any;
+    removePilet(name: string): Promise<void>;
     /**
-     * Optionally provides some configuration to be used in the pilet.
+     * Defines a single action for Piral.
+     * @param actionName The name of the action to define.
+     * @param action The action to include.
      */
-    config?: Record<string, any>;
+    defineAction<T extends keyof PiralActions>(actionName: T, action: PiralAction<PiralActions[T]>): void;
     /**
-     * Additional shared dependency script files.
+     * Defines a set of actions for Piral.
+     * @param actions The actions to define.
      */
-    dependencies?: Record<string, string>;
-  }
-
-  /**
-   * The Piral global app state container.
-   */
-  export interface GlobalState extends PiralCustomState {
+    defineActions(actions: PiralDefineActions): void;
     /**
-     * The relevant state for the app itself.
+     * Reads the value of a shared data item.
+     * @param name The name of the shared item.
      */
-    app: AppState;
-    /**
-     * The relevant state for rendering errors of the app.
-     */
-    errorComponents: ErrorComponentsState;
-    /**
-     * The relevant state for rendering parts of the app.
-     */
-    components: ComponentsState;
-    /**
-     * The relevant state for the registered components.
-     */
-    registry: RegistryState;
-    /**
-     * Gets the loaded modules.
-     */
-    modules: Array<PiletMetadata>;
-    /**
-     * The foreign component portals to render.
-     */
-    portals: Record<string, Array<React.ReactPortal>>;
-    /**
-     * The application's shared data.
-     */
-    data: Dict<SharedDataItem>;
-    /**
-     * The used (exact) application routes.
-     */
-    routes: Dict<React.ComponentType<ReactRouter.RouteComponentProps<any>>>;
-    /**
-     * The current provider.
-     */
-    provider?: React.ComponentType;
-  }
-
-  /**
-   * The globally defined actions.
-   */
-  export interface PiralActions extends PiralCustomActions {
-    /**
-     * Initializes the application shell.
-     * @param loading The current loading state.
-     * @param error The application error, if any.
-     * @param modules The loaded pilets.
-     */
-    initialize(loading: boolean, error: Error | undefined, modules: Array<Pilet>): void;
-    /**
-     * Injects a pilet at runtime - removes the pilet from registry first if available.
-     * @param pilet The pilet to be injected.
-     */
-    injectPilet(pilet: Pilet): void;
-    /**
-     * Defines a single action for Piral.
-     * @param actionName The name of the action to define.
-     * @param action The action to include.
-     */
-    defineAction<T extends keyof PiralActions>(actionName: T, action: PiralAction<PiralActions[T]>): void;
-    /**
-     * Defines a set of actions for Piral.
-     * @param actions The actions to define.
-     */
-    defineActions(actions: PiralDefineActions): void;
-    /**
-     * Reads the value of a shared data item.
-     * @param name The name of the shared item.
-     */
-    readDataValue(name: string): any;
+    readDataValue(name: string): any;
     /**
      * Tries to write a shared data item. The write access is only
      * possible if the name belongs to the provided owner or has not
@@ -1402,11 +1176,6 @@ declare module "sample-cross-fx" {
      * @param expiration The time for when to dispose the shared item.
      */
     tryWriteDataItem(name: string, value: any, owner: string, target: DataStoreTarget, expiration: number): boolean;
-    /**
-     * Performs a layout change.
-     * @param current The layout to take.
-     */
-    changeLayout(current: LayoutType): void;
     /**
      * Registers a new route to be resolved.
      * @param route The route to register.
@@ -1488,43 +1257,71 @@ declare module "sample-cross-fx" {
      * @returns The desired part.
      */
     readState<S>(select: (state: GlobalState) => S): S;
+    /**
+     * Performs a navigation.
+     * @param path The path to navigate to.
+     * @param state The optional state for the navigation.
+     */
+    navigate(path: string, state?: any): void;
   }
 
   export type Without<T, K> = Pick<T, Exclude<keyof T, K>>;
 
   /**
-   * Custom state extensions defined outside of piral-core.
-   */
-  export interface PiralCustomState {}
-
-  /**
-   * The Piral global app sub-state container for app information.
+   * Custom actions defined outside of piral-core.
    */
-  export interface AppState {
+  export interface PiralCustomActions {
     /**
-     * Information for the layout computation.
+     * Registers a new tile.
+     * @param name The name of the tile.
+     * @param value The tile registration.
      */
-    layout: LayoutType;
+    registerTile(name: string, value: TileRegistration): void;
     /**
-     * Gets if the application is currently performing a background loading
-     * activity, e.g., for loading modules asynchronously or fetching
-     * translations.
+     * Unregisters an existing tile.
+     * @param name The name of the tile to be removed.
      */
-    loading: boolean;
+    unregisterTile(name: string): void;
+  }
+
+  /**
+   * An evaluated pilet, i.e., a full pilet: functionality and metadata.
+   */
+  export type Pilet = SinglePilet | MultiPilet;
+
+  /**
+   * Pilet entry representing part of a response from the feed service.
+   */
+  export type PiletEntry = MultiPiletEntry | SinglePiletEntry;
+
+  /**
+   * The shape of an app action in Piral.
+   */
+  export interface PiralAction<T extends (...args: any) => any> {
+    (ctx: GlobalStateContext, ...args: Parameters<T>): ReturnType<T>;
+  }
+
+  /**
+   * A subset of the available app actions in Piral.
+   */
+  export type PiralDefineActions = Partial<{
+    [P in keyof PiralActions]: PiralAction<PiralActions[P]>;
+  }>;
+
+  /**
+   * The interface modeling the registration of a pilet page component.
+   */
+  export interface PageRegistration extends BaseRegistration {
     /**
-     * Gets an unrecoverable application error, if any.
+     * The registered page component.
      */
-    error: Error | undefined;
+    component: WrappedComponent<PageComponentProps>;
     /**
-     * Gets the public path of the application.
+     * The page's associated metadata.
      */
-    publicPath: string;
+    meta: PiralPageMeta;
   }
 
-  export type ErrorComponentsState = {
-    [P in keyof Errors]?: React.ComponentType<Errors[P]>;
-  };
-
   /**
    * The Piral global app sub-state container for shared components.
    */
@@ -1555,127 +1352,98 @@ declare module "sample-cross-fx" {
     Debug?: React.ComponentType;
   }
 
+  export type ErrorComponentsState = {
+    [P in keyof Errors]?: React.ComponentType<Errors[P]>;
+  };
+
   /**
-   * The Piral global app sub-state container for component registrations.
+   * The Piral global app state container.
    */
-  export interface RegistryState extends PiralCustomRegistryState {
+  export interface GlobalState extends PiralCustomState {
     /**
-     * The registered page components for the router.
+     * The relevant state for the app itself.
      */
-    pages: Dict<PageRegistration>;
+    app: AppState;
     /**
-     * The registered extension components for extension slots.
+     * The relevant state for rendering errors of the app.
      */
-    extensions: Dict<Array<ExtensionRegistration>>;
+    errorComponents: ErrorComponentsState;
     /**
-     * The registered wrappers for any component.
+     * The relevant state for rendering parts of the app.
      */
-    wrappers: Dict<React.ComponentType<any>>;
-  }
-
-  export type Dict<T> = Record<string, T>;
-
-  /**
-   * Defines the shape of a shared data item.
-   */
-  export interface SharedDataItem<TValue = any> {
+    components: ComponentsState;
     /**
-     * Gets the associated value.
+     * The relevant state for the registered components.
      */
-    value: TValue;
+    registry: RegistryState;
     /**
-     * Gets the owner of the item.
+     * Gets the loaded modules.
      */
-    owner: string;
+    modules: Array<Pilet>;
     /**
-     * Gets the storage location.
+     * The foreign component portals to render.
      */
-    target: DataStoreTarget;
+    portals: Record<string, Array<React.ReactPortal>>;
     /**
-     * Gets the expiration of the item.
+     * The application's shared data.
      */
-    expires: number;
-  }
-
-  /**
-   * Custom actions defined outside of piral-core.
-   */
-  export interface PiralCustomActions {
+    data: Dict<SharedDataItem>;
     /**
-     * Registers a new tile.
-     * @param name The name of the tile.
-     * @param value The tile registration.
+     * The used (exact) application routes.
      */
-    registerTile(name: string, value: TileRegistration): void;
+    routes: Dict<React.ComponentType<ReactRouter.RouteComponentProps<any>>>;
     /**
-     * Unregisters an existing tile.
-     * @param name The name of the tile to be removed.
+     * The current provider.
      */
-    unregisterTile(name: string): void;
+    provider?: React.ComponentType;
   }
 
-  /**
-   * An evaluated pilet, i.e., a full pilet: functionality and metadata.
-   */
-  export type Pilet = SinglePilet | MultiPilet;
+  export interface TileRegistration extends BaseRegistration {
+    component: WrappedComponent<TileComponentProps>;
+    preferences: TilePreferences;
+  }
 
   /**
-   * The shape of an app action in Piral.
+   * An evaluated single pilet.
    */
-  export interface PiralAction<T extends (...args: any) => any> {
-    (ctx: GlobalStateContext, ...args: Parameters<T>): ReturnType<T>;
-  }
+  export type SinglePilet = SinglePiletApp & PiletMetadata;
 
   /**
-   * A subset of the available app actions in Piral.
+   * An evaluated multi pilet.
    */
-  export type PiralDefineActions = Partial<{
-    [P in keyof PiralActions]: PiralAction<PiralActions[P]>;
-  }>;
+  export type MultiPilet = MultiPiletApp & PiletMetadata;
 
   /**
-   * The different known layout types.
+   * The metadata response for a multi pilet.
    */
-  export type LayoutType = "mobile" | "tablet" | "desktop";
+  export type MultiPiletEntry = PiletBundleEntry;
 
   /**
-   * The interface modeling the registration of a pilet page component.
+   * The metadata response for a single pilet.
    */
-  export interface PageRegistration extends BaseRegistration {
-    /**
-     * The registered page component.
-     */
-    component: WrappedComponent<PageComponentProps>;
-    /**
-     * The page's associated metadata.
-     */
-    meta: PiralPageMeta;
-  }
+  export type SinglePiletEntry = PiletV0Entry | PiletV1Entry | PiletV2Entry | PiletVxEntry;
 
   /**
-   * Map of all error types to their respective props.
+   * The Piral app instance context.
    */
-  export interface Errors extends PiralCustomErrors {
-    /**
-     * The props type for an extension error.
-     */
-    extension: ExtensionErrorInfoProps;
+  export interface GlobalStateContext extends PiralActions, EventEmitter {
     /**
-     * The props type for a loading error.
+     * The global state context atom.
+     * Changes to the state should always be dispatched via the `dispatch` action.
      */
-    loading: LoadingErrorInfoProps;
+    state: UseBoundStore<GlobalState>;
     /**
-     * The props type for a page error.
+     * The API objects created for the loaded pilets.
      */
-    page: PageErrorInfoProps;
+    apis: PiletsBag;
     /**
-     * The props type for a not found error.
+     * The available component converters.
      */
-    not_found: NotFoundErrorInfoProps;
+    converters: ComponentConverters<any>;
     /**
-     * The props type for an unknown error.
+     * The initial options.
      */
-    unknown: UnknownErrorInfoProps;
+    options: LoadPiletsOptions;
   }
 
   /**
@@ -1705,7 +1473,12 @@ declare module "sample-cross-fx" {
   /**
    * The props of a Router component.
    */
-  export interface RouterProps {}
+  export interface RouterProps {
+    /**
+     * The content to be rendered inside the router.
+     */
+    children?: React.ReactNode;
+  }
 
   /**
    * The props of a Layout component.
@@ -1715,6 +1488,10 @@ declare module "sample-cross-fx" {
      * The currently selected layout type.
      */
     currentLayout: LayoutType;
+    /**
+     * The page's content.
+     */
+    children: React.ReactNode;
   }
 
   /**
@@ -1728,64 +1505,389 @@ declare module "sample-cross-fx" {
     /**
      * The component to register for the different paths.
      */
-    paths: Array<{
-      /**
-       * The exact path to use.
-       */
-      path: string;
-      /**
-       * The component to register for this path.
-       */
-      Component: React.ComponentType<ReactRouter.RouteComponentProps>;
-    }>;
+    paths: Array<AppPath>;
   }
 
   /**
-   * Custom parts of the global registry state defined outside of piral-core.
+   * Map of all error types to their respective props.
    */
-  export interface PiralCustomRegistryState {
+  export interface Errors extends PiralCustomErrors {
     /**
-     * The registered tile components for a dashboard.
+     * The props type for an extension error.
+     */
+    extension: ExtensionErrorInfoProps;
+    /**
+     * The props type for a loading error.
+     */
+    loading: LoadingErrorInfoProps;
+    /**
+     * The props type for a page error.
+     */
+    page: PageErrorInfoProps;
+    /**
+     * The props type for a not found error.
+     */
+    not_found: NotFoundErrorInfoProps;
+    /**
+     * The props type for an unknown error.
+     */
+    unknown: UnknownErrorInfoProps;
+  }
+
+  /**
+   * Custom state extensions defined outside of piral-core.
+   */
+  export interface PiralCustomState {}
+
+  /**
+   * The Piral global app sub-state container for app information.
+   */
+  export interface AppState {
+    /**
+     * Gets if the application is currently performing a background loading
+     * activity, e.g., for loading modules asynchronously or fetching
+     * translations.
+     */
+    loading: boolean;
+    /**
+     * Gets an unrecoverable application error, if any.
+     */
+    error: Error | undefined;
+    /**
+     * Gets the public path of the application.
+     */
+    publicPath: string;
+  }
+
+  /**
+   * The Piral global app sub-state container for component registrations.
+   */
+  export interface RegistryState extends PiralCustomRegistryState {
+    /**
+     * The registered page components for the router.
+     */
+    pages: Dict<PageRegistration>;
+    /**
+     * The registered extension components for extension slots.
+     */
+    extensions: Dict<Array<ExtensionRegistration>>;
+    /**
+     * The registered wrappers for any component.
+     */
+    wrappers: Dict<React.ComponentType<any>>;
+  }
+
+  export type Dict<T> = Record<string, T>;
+
+  /**
+   * Defines the shape of a shared data item.
+   */
+  export interface SharedDataItem<TValue = any> {
+    /**
+     * Gets the associated value.
+     */
+    value: TValue;
+    /**
+     * Gets the owner of the item.
+     */
+    owner: string;
+    /**
+     * Gets the storage location.
+     */
+    target: DataStoreTarget;
+    /**
+     * Gets the expiration of the item.
+     */
+    expires: number;
+  }
+
+  /**
+   * The pilet app, i.e., the functional exports.
+   */
+  export interface SinglePiletApp {
+    /**
+     * Integrates the evaluated pilet into the application.
+     * @param api The API to access the application.
+     */
+    setup(api: PiletApi): void | Promise<void>;
+    /**
+     * Optional function for cleanup.
+     * @param api The API to access the application.
+     */
+    teardown?(api: PiletApi): void;
+  }
+
+  /**
+   * The pilet app, i.e., the functional exports.
+   */
+  export interface MultiPiletApp {
+    /**
+     * Integrates the evaluated pilet into the application.
+     * @param api The API to access the application.
+     */
+    setup(apiFactory: PiletApiCreator): void | Promise<void>;
+  }
+
+  /**
+   * Metadata for pilets using the bundle schema.
+   */
+  export interface PiletBundleEntry {
+    /**
+     * The name of the bundle pilet, i.e., the package id.
+     */
+    name?: string;
+    /**
+     * Optionally provides the version of the specification for this pilet.
+     */
+    spec?: "v1";
+    /**
+     * The link for retrieving the bundle content of the pilet.
+     */
+    link: string;
+    /**
+     * The reference name for the global bundle-shared require.
+     */
+    bundle: string;
+    /**
+     * The computed integrity of the pilet. Will be used to set the
+     * integrity value of the script.
+     */
+    integrity?: string;
+    /**
+     * Optionally provides some custom metadata for the pilet.
+     */
+    custom?: any;
+    /**
+     * Additional shared dependency script files.
+     */
+    dependencies?: Record<string, string>;
+  }
+
+  /**
+   * Metadata for pilets using the v0 schema.
+   */
+  export type PiletV0Entry = PiletV0ContentEntry | PiletV0LinkEntry;
+
+  /**
+   * Metadata for pilets using the v1 schema.
+   */
+  export interface PiletV1Entry {
+    /**
+     * The name of the pilet, i.e., the package id.
+     */
+    name: string;
+    /**
+     * The version of the pilet. Should be semantically versioned.
+     */
+    version: string;
+    /**
+     * Optionally provides the version of the specification for this pilet.
+     */
+    spec?: "v1";
+    /**
+     * The link for retrieving the content of the pilet.
+     */
+    link: string;
+    /**
+     * The reference name for the global require.
+     */
+    requireRef: string;
+    /**
+     * The computed integrity of the pilet. Will be used to set the
+     * integrity value of the script.
+     */
+    integrity?: string;
+    /**
+     * Optionally provides some custom metadata for the pilet.
+     */
+    custom?: any;
+    /**
+     * Optionally provides some configuration to be used in the pilet.
+     */
+    config?: Record<string, any>;
+    /**
+     * Additional shared dependency script files.
+     */
+    dependencies?: Record<string, string>;
+  }
+
+  /**
+   * Metadata for pilets using the v2 schema.
+   */
+  export interface PiletV2Entry {
+    /**
+     * The name of the pilet, i.e., the package id.
+     */
+    name: string;
+    /**
+     * The version of the pilet. Should be semantically versioned.
+     */
+    version: string;
+    /**
+     * Provides the version of the specification for this pilet.
+     */
+    spec: "v2";
+    /**
+     * The reference name for the global require.
+     */
+    requireRef: string;
+    /**
+     * The computed integrity of the pilet.
+     */
+    integrity?: string;
+    /**
+     * The link for retrieving the content of the pilet.
+     */
+    link: string;
+    /**
+     * Optionally provides some custom metadata for the pilet.
+     */
+    custom?: any;
+    /**
+     * Optionally provides some configuration to be used in the pilet.
+     */
+    config?: Record<string, any>;
+    /**
+     * Additional shared dependency script files.
+     */
+    dependencies?: Record<string, string>;
+  }
+
+  export interface PiletVxEntry {
+    /**
+     * The name of the pilet, i.e., the package id.
+     */
+    name: string;
+    /**
+     * The version of the pilet. Should be semantically versioned.
+     */
+    version: string;
+    /**
+     * Provides an identifier for the custom specification.
+     */
+    spec: string;
+    /**
+     * Optionally provides some custom metadata for the pilet.
+     */
+    custom?: any;
+    /**
+     * Optionally provides some configuration to be used in the pilet.
+     */
+    config?: Record<string, any>;
+    /**
+     * Additional shared dependency script files.
+     */
+    dependencies?: Record<string, string>;
+  }
+
+  export type UseBoundStore<T extends State, CustomStoreApi extends StoreApi<T> = StoreApi<T>> = {
+    (): T;
+    <U>(selector: StateSelector<T, U>, equalityFn?: EqualityChecker<U>): U;
+  } & CustomStoreApi;
+
+  /**
+   * Represents the dictionary of the loaded pilets and their APIs.
+   */
+  export interface PiletsBag {
+    [name: string]: PiletApi;
+  }
+
+  /**
+   * The options for loading pilets.
+   */
+  export interface LoadPiletsOptions {
+    /**
+     * The callback function for creating an API object.
+     * The API object is passed on to a specific pilet.
+     */
+    createApi: PiletApiCreator;
+    /**
+     * The callback for fetching the dynamic pilets.
+     */
+    fetchPilets: PiletRequester;
+    /**
+     * Optionally, some already existing evaluated pilets, e.g.,
+     * helpful when debugging or in SSR scenarios.
+     */
+    pilets?: Array<Pilet>;
+    /**
+     * Optionally, configures the default loader.
+     */
+    config?: DefaultLoaderConfig;
+    /**
+     * Optionally, defines the default way how to load a pilet.
+     */
+    loadPilet?: PiletLoader;
+    /**
+     * Optionally, defines loaders for custom specifications.
+     */
+    loaders?: CustomSpecLoaders;
+    /**
+     * Optionally, defines a set of loading hooks to be used.
+     */
+    hooks?: PiletLifecycleHooks;
+    /**
+     * Gets the map of globally available dependencies with their names
+     * as keys and their evaluated pilet content as value.
+     */
+    dependencies?: AvailableDependencies;
+    /**
+     * Optionally, defines the loading strategy to use.
+     */
+    strategy?: PiletLoadingStrategy;
+  }
+
+  export interface DashboardContainerProps extends ReactRouter.RouteComponentProps {
+    /**
+     * The tiles to display.
      */
-    tiles: Dict<TileRegistration>;
+    children?: React.ReactNode;
   }
 
-  export interface TileRegistration extends BaseRegistration {
-    component: WrappedComponent<TileComponentProps>;
-    preferences: TilePreferences;
+  export interface DashboardTileProps {
+    /**
+     * The currently used number of columns.
+     */
+    columns: number;
+    /**
+     * The currently used number of rows.
+     */
+    rows: number;
+    /**
+     * The resizable status.
+     */
+    resizable: boolean;
+    /**
+     * The provided tile preferences.
+     */
+    meta: TilePreferences;
+    /**
+     * The content of the tile to display.
+     */
+    children?: React.ReactNode;
   }
 
-  /**
-   * An evaluated single pilet.
-   */
-  export type SinglePilet = SinglePiletApp & SinglePiletMetadata;
+  export type UnionOf<T> = {
+    [K in keyof T]: T[K];
+  }[keyof T];
 
   /**
-   * An evaluated multi pilet.
+   * The different known layout types.
    */
-  export type MultiPilet = MultiPiletApp & MultiPiletMetadata;
+  export type LayoutType = "mobile" | "tablet" | "desktop";
 
   /**
-   * The Piral app instance context.
+   * Represents a path in the app registration.
    */
-  export interface GlobalStateContext extends PiralActions, EventEmitter {
-    /**
-     * The global state context atom.
-     * Changes to the state should always be dispatched via the `dispatch` action.
-     */
-    state: LibreAtom.Atom<GlobalState>;
-    /**
-     * The API objects created for the loaded pilets.
-     */
-    apis: PiletsBag;
+  export interface AppPath {
     /**
-     * The available component converters.
+     * The exact path to use.
      */
-    converters: ComponentConverters<any>;
+    path: string;
     /**
-     * The initial options.
+     * The component to register for this path.
      */
-    options: LoadPiletsOptions;
+    Component: React.ComponentType<ReactRouter.RouteComponentProps>;
   }
 
   /**
@@ -1873,104 +1975,125 @@ declare module "sample-cross-fx" {
     pilet?: string;
   }
 
-  export interface DashboardContainerProps extends ReactRouter.RouteComponentProps {}
-
-  export interface DashboardTileProps {
-    /**
-     * The currently used number of columns.
-     */
-    columns: number;
-    /**
-     * The currently used number of rows.
-     */
-    rows: number;
-    /**
-     * The resizable status.
-     */
-    resizable: boolean;
+  /**
+   * Custom parts of the global registry state defined outside of piral-core.
+   */
+  export interface PiralCustomRegistryState {
     /**
-     * The provided tile preferences.
+     * The registered tile components for a dashboard.
      */
-    meta: TilePreferences;
+    tiles: Dict<TileRegistration>;
   }
 
-  export type UnionOf<T> = {
-    [K in keyof T]: T[K];
-  }[keyof T];
+  /**
+   * The creator function for the pilet API.
+   */
+  export interface PiletApiCreator {
+    (target: PiletMetadata): PiletApi;
+  }
 
   /**
-   * The pilet app, i.e., the functional exports.
+   * Metadata for pilets using the v0 schema with a content.
    */
-  export interface SinglePiletApp {
+  export interface PiletV0ContentEntry extends PiletV0BaseEntry {
     /**
-     * Integrates the evaluated pilet into the application.
-     * @param api The API to access the application.
+     * The content of the pilet. If the content is not available
+     * the link will be used (unless caching has been activated).
      */
-    setup(api: PiletApi): void | Promise<void>;
+    content: string;
     /**
-     * Optional function for cleanup.
-     * @param api The API to access the application.
+     * If available indicates that the pilet should not be cached.
+     * In case of a string this is interpreted as the expiration time
+     * of the cache. In case of an accurate hash this should not be
+     * required or set.
      */
-    teardown?(api: PiletApi): void;
+    noCache?: boolean | string;
   }
 
   /**
-   * The pilet app, i.e., the functional exports.
+   * Metadata for pilets using the v0 schema with a link.
    */
-  export interface MultiPiletApp {
+  export interface PiletV0LinkEntry extends PiletV0BaseEntry {
     /**
-     * Integrates the evaluated pilet into the application.
-     * @param api The API to access the application.
+     * The link for retrieving the content of the pilet.
      */
-    setup(apiFactory: PiletApiCreator): void | Promise<void>;
+    link: string;
   }
 
+  export type StateSelector<T extends State, U> = (state: T) => U;
+
+  export type EqualityChecker<T> = (state: T, newState: T) => boolean;
+
+  export type State = object;
+
+  export type StoreApi<T extends State> = {
+    setState: SetState<T>;
+    getState: GetState<T>;
+    subscribe: Subscribe<T>;
+    destroy: Destroy;
+  };
+
   /**
-   * Represents the dictionary of the loaded pilets and their APIs.
+   * The interface describing a function capable of fetching pilets.
    */
-  export interface PiletsBag {
-    [name: string]: PiletApi;
+  export interface PiletRequester {
+    (): Promise<PiletEntries>;
   }
 
   /**
-   * The options for loading pilets.
+   * Additional configuration options for the default loader.
    */
-  export interface LoadPiletsOptions {
-    /**
-     * The callback function for creating an API object.
-     * The API object is passed on to a specific pilet.
-     */
-    createApi: PiletApiCreator;
-    /**
-     * The callback for fetching the dynamic pilets.
-     */
-    fetchPilets: PiletRequester;
-    /**
-     * Optionally, some already existing evaluated pilets, e.g.,
-     * helpful when debugging or in SSR scenarios.
-     */
-    pilets?: Array<Pilet>;
-    /**
-     * Optionally, configures the default loader.
-     */
-    config?: DefaultLoaderConfig;
+  export interface DefaultLoaderConfig {
     /**
-     * Optionally, defines the default way how to load a pilet.
+     * Sets the cross-origin attribute of potential script tags.
+     * For pilets v1 this may be useful. Otherwise, only pilets that
+     * have an integrity defined will be set to "anonymous".
      */
-    loadPilet?: PiletLoader;
+    crossOrigin?: string;
+  }
+
+  /**
+   * The callback to be used to load a single pilet.
+   */
+  export interface PiletLoader {
+    (entry: PiletEntry): Promise<Pilet>;
+  }
+
+  /**
+   * Defines the spec identifiers for custom loading.
+   */
+  export type CustomSpecLoaders = Record<string, PiletLoader>;
+
+  /**
+   * A set of pipeline hooks used by the Piral loading orchestrator.
+   */
+  export interface PiletLifecycleHooks {
     /**
-     * Optionally, defines loaders for custom specifications.
+     * Hook fired before a pilet is loaded.
      */
-    loaders?: CustomSpecLoaders;
+    loadPilet?(pilet: PiletMetadata): void;
     /**
-     * Gets the map of globally available dependencies with their names
-     * as keys and their evaluated pilet content as value.
+     * Hook fired before a pilet is being set up.
      */
-    dependencies?: AvailableDependencies;
+    setupPilet?(pilet: Pilet): void;
     /**
-     * Optionally, defines the loading strategy to use.
+     * Hook fired before a pilet is being cleaned up.
      */
-    strategy?: PiletLoadingStrategy;
+    cleanupPilet?(pilet: Pilet): void;
+  }
+
+  /**
+   * The record containing all available dependencies.
+   */
+  export interface AvailableDependencies {
+    [name: string]: any;
+  }
+
+  /**
+   * The strategy for how pilets are loaded at runtime.
+   */
+  export interface PiletLoadingStrategy {
+    (options: LoadPiletsOptions, pilets: PiletsLoaded): PromiseLike<void>;
   }
 
   export interface TileErrorInfoProps {
@@ -1997,61 +2120,76 @@ declare module "sample-cross-fx" {
   }
 
   /**
-   * The creator function for the pilet API.
-   */
-  export interface PiletApiCreator {
-    (target: PiletMetadata): PiletApi;
-  }
-
-  /**
-   * The interface describing a function capable of fetching pilets.
-   */
-  export interface PiletRequester {
-    (): Promise<Array<PiletMetadata>>;
-  }
-
-  /**
-   * Additional configuration options for the default loader.
+   * Basic metadata for pilets using the v0 schema.
    */
-  export interface DefaultLoaderConfig {
+  export interface PiletV0BaseEntry {
     /**
-     * Sets the cross-origin attribute of potential script tags.
-     * For pilets v1 this may be useful. Otherwise, only pilets that
-     * have an integrity defined will be set to "anonymous".
+     * The name of the pilet, i.e., the package id.
      */
-    crossOrigin?: string;
+    name: string;
+    /**
+     * The version of the pilet. Should be semantically versioned.
+     */
+    version: string;
+    /**
+     * Optionally provides the version of the specification for this pilet.
+     */
+    spec?: "v0";
+    /**
+     * The computed hash value of the pilet's content. Should be
+     * accurate to allow caching.
+     */
+    hash: string;
+    /**
+     * Optionally provides some custom metadata for the pilet.
+     */
+    custom?: any;
+    /**
+     * Optionally provides some configuration to be used in the pilet.
+     */
+    config?: Record<string, any>;
+    /**
+     * Additional shared dependency script files.
+     */
+    dependencies?: Record<string, string>;
   }
 
-  /**
-   * The callback to be used to load a single pilet.
-   */
-  export interface PiletLoader {
-    (meta: PiletMetadata): Promise<Pilet>;
-  }
+  export type SetState<T extends State> = {
+    <K1 extends keyof T, K2 extends keyof T = K1, K3 extends keyof T = K2, K4 extends keyof T = K3>(partial: PartialState<T, K1, K2, K3, K4>, replace?: boolean): void;
+  };
+
+  export type GetState<T extends State> = () => T;
+
+  export type Subscribe<T extends State> = {
+    (listener: StateListener<T>): () => void;
+    <StateSlice>(listener: StateSliceListener<StateSlice>, selector?: StateSelector<T, StateSlice>, equalityFn?: EqualityChecker<StateSlice>): () => void;
+  };
+
+  export type Destroy = () => void;
 
   /**
-   * Defines the spec identifiers for custom loading.
+   * The entries representing pilets from a feed service response.
    */
-  export type CustomSpecLoaders = Record<string, PiletLoader>;
+  export type PiletEntries = Array<PiletEntry>;
 
   /**
-   * The record containing all available dependencies.
+   * The callback to be used when pilets have been loaded.
    */
-  export interface AvailableDependencies {
-    [name: string]: any;
+  export interface PiletsLoaded {
+    (error: Error | undefined, pilets: Array<Pilet>): void;
   }
 
   /**
-   * The strategy for how pilets are loaded at runtime.
+   * @deprecated Use the builtin `Partial<T>` instead of `PartialState<T>`.
+   * Additionally turn on `--exactOptionalPropertyTypes` tsc flag.
+   * `PartialState` will be removed in next major
    */
-  export interface PiletLoadingStrategy {
-    (options: LoadPiletsOptions, pilets: PiletsLoaded): PromiseLike<void>;
-  }
+  export type PartialState<T extends State, K1 extends keyof T = keyof T, K2 extends keyof T = K1, K3 extends keyof T = K2, K4 extends keyof T = K3> = (Pick<T, K1> | Pick<T, K2> | Pick<T, K3> | Pick<T, K4> | T) | ((state: T) => Pick<T, K1> | Pick<T, K2> | Pick<T, K3> | Pick<T, K4> | T);
+
+  export type StateListener<T> = (state: T, previousState: T) => void;
 
   /**
-   * The callback to be used when pilets have been loaded.
+   * @deprecated Use `StateListener<T>` instead of `StateSliceListener<T>`.
    */
-  export interface PiletsLoaded {
-    (error: Error | undefined, pilets: Array<Pilet>): void;
-  }
+  export type StateSliceListener<T> = (slice: T, previousSlice: T) => void;
 }