piral-core 1.6.0-beta.7240 → 1.6.0-beta.7244

package/esm/tools/emulator.d.ts

@@ -1,4 +0,0 @@
-import { LoadPiletsOptions } from 'piral-base';
-import { DebuggerExtensionOptions } from 'piral-debug-utils';
-import { GlobalStateContext } from '../types';
-export declare function integrateEmulator(context: GlobalStateContext, options: LoadPiletsOptions, debug?: DebuggerExtensionOptions): void;

package/esm/tools/emulator.js

@@ -1,12 +0,0 @@
-import { installPiletEmulator } from 'piral-debug-utils';
-export function integrateEmulator(context, options, debug = {}) {
-    installPiletEmulator(options.fetchPilets, {
-        defaultFeedUrl: debug.defaultFeedUrl,
-        addPilet: context.addPilet,
-        removePilet: context.removePilet,
-        integrate(requester) {
-            options.fetchPilets = requester;
-        },
-    });
-}
-//# sourceMappingURL=emulator.js.map

package/esm/tools/emulator.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"emulator.js","sourceRoot":"","sources":["../../src/tools/emulator.ts"],"names":[],"mappings":"AACA,OAAO,EAA4B,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAGnF,MAAM,UAAU,iBAAiB,CAAC,OAA2B,EAAE,OAA0B,EAAE,QAAkC,EAAE;IAC7H,oBAAoB,CAAC,OAAO,CAAC,WAAW,EAAE;QACxC,cAAc,EAAE,KAAK,CAAC,cAAc;QACpC,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,SAAS,CAAC,SAAS;YACjB,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC;QAClC,CAAC;KACF,CAAC,CAAC;AACL,CAAC"}

package/esm/types/api.d.ts

@@ -1,141 +0,0 @@
-import type { ReactElement, ReactNode } from 'react';
-import type { RouteComponentProps } from 'react-router';
-import type { PiletApi, Pilet, PiletEntry, PiletEntries, PiletMetadata, EventEmitter, PiletLoader, PiletLoadingStrategy } from 'piral-base';
-import type { PiletCustomApi } from './custom';
-import type { AnyComponent, PiralPageMeta } from './components';
-import type { ExtensionParams, ExtensionSlotProps, PiralExtensionSlotMap } from './extension';
-import type { SharedData, DataStoreOptions } from './data';
-import type { Disposable } from './utils';
-export { PiletApi, Pilet, PiletMetadata, EventEmitter, PiletEntry, PiletEntries, PiletLoader, PiletLoadingStrategy };
-/**
- * The props that every registered component obtains.
- */
-export interface BaseComponentProps {
-    /**
-     * The currently used pilet API.
-     */
-    piral: PiletApi;
-}
-/**
- * The shape of an implicit unregister function.
- */
-export interface RegistrationDisposer {
-    /**
-     * Cleans up the previous registration.
-     */
-    (): void;
-}
-/**
- * The props of an extension component.
- */
-export interface ExtensionComponentProps<T> extends BaseComponentProps {
-    /**
-     * The provided parameters for showing the extension.
-     */
-    params: T extends keyof PiralExtensionSlotMap ? PiralExtensionSlotMap[T] : T extends string ? any : T;
-    /**
-     * The optional children to receive, if any.
-     */
-    children?: ReactNode;
-}
-/**
- * The props that every registered page component obtains.
- */
-export interface RouteBaseProps<UrlParams extends {
-    [K in keyof UrlParams]?: string;
-} = {}, UrlState = any> extends RouteComponentProps<UrlParams, {}, UrlState>, BaseComponentProps {
-}
-/**
- * The props used by a page component.
- */
-export interface PageComponentProps<T extends {
-    [K in keyof T]?: string;
-} = {}, S = any> extends RouteBaseProps<T, S> {
-    /**
-     * The meta data registered with the page.
-     */
-    meta: PiralPageMeta;
-    /**
-     * The children of the page.
-     */
-    children: ReactNode;
-}
-/**
- * Shorthand for the definition of an extension component.
- */
-export type AnyExtensionComponent<TName> = TName extends keyof PiralExtensionSlotMap ? AnyComponent<ExtensionComponentProps<TName>> : TName extends string ? AnyComponent<ExtensionComponentProps<any>> : AnyComponent<ExtensionComponentProps<TName>>;
-/**
- * Defines the Pilet API from piral-core.
- * This interface will be consumed by pilet developers so that their pilet can interact with the piral instance.
- */
-export interface PiletCoreApi {
-    /**
-     * Gets a shared data value.
-     * @param name The name of the data to retrieve.
-     */
-    getData<TKey extends string>(name: TKey): SharedData[TKey];
-    /**
-     * Sets the data using a given name. The name needs to be used exclusively by the current pilet.
-     * Using the name occupied by another pilet will result in no change.
-     * @param name The name of the data to store.
-     * @param value The value of the data to store.
-     * @param options The optional configuration for storing this piece of data.
-     * @returns True if the data could be set, otherwise false.
-     */
-    setData<TKey extends string>(name: TKey, value: SharedData[TKey], options?: DataStoreOptions): boolean;
-    /**
-     * Registers a route for predefined page component.
-     * The route needs to be unique and can contain params.
-     * Params are following the path-to-regexp notation, e.g., :id for an id parameter.
-     * @param route The route to register.
-     * @param Component The component to render the page.
-     * @param meta The optional metadata to use.
-     */
-    registerPage(route: string, Component: AnyComponent<PageComponentProps>, meta?: PiralPageMeta): RegistrationDisposer;
-    /**
-     * Unregisters the page identified by the given route.
-     * @param route The route that was previously registered.
-     */
-    unregisterPage(route: string): void;
-    /**
-     * Registers an extension component with a predefined extension component.
-     * The name must refer to the extension slot.
-     * @param name The global name of the extension slot.
-     * @param Component The component to be rendered.
-     * @param defaults Optionally, sets the default values for the expected data.
-     */
-    registerExtension<TName>(name: TName extends string ? TName : string, Component: AnyExtensionComponent<TName>, defaults?: Partial<ExtensionParams<TName>>): RegistrationDisposer;
-    /**
-     * Unregisters a global extension component.
-     * Only previously registered extension components can be unregistered.
-     * @param name The name of the extension slot to unregister from.
-     * @param Component The registered extension component to unregister.
-     */
-    unregisterExtension<TName>(name: TName extends string ? TName : string, Component: AnyExtensionComponent<TName>): void;
-    /**
-     * React component for displaying extensions for a given name.
-     * @param props The extension's rendering props.
-     * @return The created React element.
-     */
-    Extension<TName>(props: ExtensionSlotProps<TName>): ReactElement | null;
-    /**
-     * Renders an extension in a plain DOM component.
-     * @param element The DOM element or shadow root as a container for rendering the extension.
-     * @param props The extension's rendering props.
-     * @return The disposer to clear the extension.
-     */
-    renderHtmlExtension<TName>(element: HTMLElement | ShadowRoot, props: ExtensionSlotProps<TName>): Disposable;
-}
-declare module 'piral-base/lib/types/runtime' {
-    interface PiletApi extends PiletCustomApi, PiletCoreApi {
-    }
-}
-/**
- * Represents the dictionary of the loaded pilets and their APIs.
- */
-export interface PiletsBag {
-    /**
-     * Gets the API of the respective pilet name.
-     */
-    [name: string]: PiletApi;
-}

package/esm/types/api.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=api.js.map

package/esm/types/api.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"api.js","sourceRoot":"","sources":["../../src/types/api.ts"],"names":[],"mappings":""}

package/esm/types/common.d.ts

@@ -1,21 +0,0 @@
-export type ValuesOf<T> = T extends {
-    [_ in keyof T]: infer U;
-} ? U : never;
-export type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
-export type RemainingArgs<T> = T extends (_: any, ...args: infer U) => any ? U : never;
-export type DeepPartial<T> = {
-    [P in keyof T]?: T[P] extends Array<infer U> ? Array<DeepPartial<U>> : T[P] extends {} ? DeepPartial<T[P]> : T[P];
-};
-export type NestedPartial<T> = {
-    [P in keyof T]?: T[P] extends Array<infer U> ? Array<Partial<U>> : T[P] extends {} ? Partial<T[P]> : T[P];
-};
-export type Dict<T> = Record<string, T>;
-export type Without<T, K> = Pick<T, Exclude<keyof T, K>>;
-export type FirstParameter<T extends (arg: any) => any> = T extends (arg: infer P) => any ? P : never;
-export type FirstParametersOf<T> = {
-    [K in keyof T]: T[K] extends (arg: any) => any ? FirstParameter<T[K]> : never;
-}[keyof T];
-export type UnionOf<T> = {
-    [K in keyof T]: T[K];
-}[keyof T];
-export type MaybeAsync<T> = T | (() => Promise<T>);

package/esm/types/common.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=common.js.map

package/esm/types/common.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"common.js","sourceRoot":"","sources":["../../src/types/common.ts"],"names":[],"mappings":""}

package/esm/types/components.d.ts

@@ -1,250 +0,0 @@
-import type { ComponentType, ReactNode } from 'react';
-import type { RouteComponentProps, SwitchProps } from 'react-router';
-import type { FirstParametersOf, UnionOf } from './common';
-import type { PiralCustomErrors, PiralCustomComponentConverters, PiralCustomPageMeta } from './custom';
-import type { NavigationApi } from './navigation';
-import type { LayoutType } from './layout';
-/**
- * Mapping of available component converters.
- */
-export interface ComponentConverters<TProps> extends PiralCustomComponentConverters<TProps> {
-    /**
-     * Converts the HTML component to a framework-independent component.
-     * @param component The vanilla JavaScript component to be converted.
-     */
-    html(component: HtmlComponent<TProps>): ForeignComponent<TProps>;
-}
-/**
- * Definition of a vanilla JavaScript component.
- */
-export interface HtmlComponent<TProps> {
-    /**
-     * Renders a component into the provided element using the given props and context.
-     */
-    component: ForeignComponent<TProps>;
-    /**
-     * The type of the HTML component.
-     */
-    type: 'html';
-}
-/**
- * The context to be transported into the generic components.
- */
-export interface ComponentContext {
-    /**
-     * The router-independent navigation API.
-     */
-    navigation: NavigationApi;
-    /**
-     * The internal router object.
-     * @deprecated Exposes internals that can change at any time.
-     */
-    router: any;
-    /**
-     * The public path of the application.
-     */
-    publicPath: string;
-}
-/**
- * Generic definition of a framework-independent component.
- */
-export interface ForeignComponent<TProps> {
-    /**
-     * Called when the component is mounted.
-     * @param element The container hosting the element.
-     * @param props The props to transport.
-     * @param ctx The associated context.
-     * @param locals The local state of this component instance.
-     */
-    mount(element: HTMLElement, props: TProps, ctx: ComponentContext, locals: Record<string, any>): void;
-    /**
-     * Called when the component should be updated.
-     * @param element The container hosting the element.
-     * @param props The props to transport.
-     * @param ctx The associated context.
-     * @param locals The local state of this component instance.
-     */
-    update?(element: HTMLElement, props: TProps, ctx: ComponentContext, locals: Record<string, any>): void;
-    /**
-     * Called when a component is unmounted.
-     * @param element The container that was hosting the element.
-     * @param locals The local state of this component instance.
-     */
-    unmount?(element: HTMLElement, locals: Record<string, any>): void;
-}
-/**
- * Possible shapes for a component.
- */
-export type AnyComponent<T> = ComponentType<T> | FirstParametersOf<ComponentConverters<T>>;
-/**
- * The error used when a route cannot be resolved.
- */
-export interface NotFoundErrorInfoProps extends RouteComponentProps {
-    /**
-     * The type of the error.
-     */
-    type: 'not_found';
-}
-/**
- * The error used when a registered page component crashes.
- */
-export interface PageErrorInfoProps extends RouteComponentProps {
-    /**
-     * The type of the error.
-     */
-    type: 'page';
-    /**
-     * The provided error details.
-     */
-    error: any;
-    /**
-     * The name of the pilet emitting the error.
-     */
-    pilet?: string;
-}
-/**
- * The error used when the app could not be loaded.
- */
-export interface LoadingErrorInfoProps {
-    /**
-     * The type of the error.
-     */
-    type: 'loading';
-    /**
-     * The provided error details.
-     */
-    error: any;
-}
-/**
- * The error used when a registered extension component crashed.
- */
-export interface ExtensionErrorInfoProps {
-    /**
-     * The type of the error.
-     */
-    type: 'extension';
-    /**
-     * The provided error details.
-     */
-    error: any;
-    /**
-     * The name of the pilet emitting the error.
-     */
-    pilet?: string;
-}
-/**
- * The error used when the exact type is unknown.
- */
-export interface UnknownErrorInfoProps {
-    /**
-     * The type of the error.
-     */
-    type: 'unknown';
-    /**
-     * The provided error details.
-     */
-    error: any;
-    /**
-     * The name of the pilet emitting the error.
-     */
-    pilet?: string;
-}
-/**
- * Map of all error types to their respective props.
- */
-export interface Errors extends PiralCustomErrors {
-    /**
-     * 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;
-}
-/**
- * The props for the ErrorInfo component.
- */
-export type ErrorInfoProps = UnionOf<Errors>;
-/**
- * The props of a Loading indicator component.
- */
-export interface LoadingIndicatorProps {
-}
-/**
- * The props of a Layout component.
- */
-export interface LayoutProps {
-    /**
-     * The currently selected layout type.
-     */
-    currentLayout: LayoutType;
-    /**
-     * The page's content.
-     */
-    children: ReactNode;
-}
-/**
- * The props of a Router component.
- */
-export interface RouterProps {
-    /**
-     * The content to be rendered inside the router.
-     */
-    children?: ReactNode;
-    /**
-     * The public path to use.
-     */
-    publicPath: string;
-}
-/**
- * The meta data registered for a page.
- */
-export interface PiralPageMeta extends PiralCustomPageMeta {
-}
-/**
- * Represents a path in the app registration.
- */
-export interface AppPath {
-    /**
-     * The exact path to use.
-     */
-    path: string;
-    /**
-     * The associated route matcher.
-     */
-    matcher: RegExp;
-    /**
-     * The page metadata.
-     */
-    meta: PiralPageMeta;
-    /**
-     * The component to register for this path.
-     */
-    Component: ComponentType<RouteComponentProps>;
-}
-/**
- * The props of the RouteSwitch component.
- */
-export interface RouteSwitchProps extends SwitchProps {
-    /**
-     * The component that should be used in case nothing was found.
-     */
-    NotFound: ComponentType<RouteComponentProps>;
-    /**
-     * The component to register for the different paths.
-     */
-    paths: Array<AppPath>;
-}

package/esm/types/components.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=components.js.map

package/esm/types/components.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"components.js","sourceRoot":"","sources":["../../src/types/components.ts"],"names":[],"mappings":""}

package/esm/types/config.d.ts

@@ -1,94 +0,0 @@
-import type { PiletRequester, PiletLoadingStrategy, PiletLoader, Pilet, AvailableDependencies, CustomSpecLoaders, DefaultLoaderConfig, PiletApiCreator } from 'piral-base';
-import { DebuggerExtensionOptions } from 'piral-debug-utils';
-import type { NestedPartial } from './common';
-import type { PiralPlugin } from './plugin';
-import type { GlobalState, GlobalStateContext, PiralDefineActions } from './state';
-export { PiletLoadingStrategy, PiletRequester, AvailableDependencies };
-/**
- * Definition for customizing the shared dependencies.
- */
-export interface DependencySelector {
-    /**
-     * Selects the dependencies to share from the currently available dependencies.
-     * @param currentDependencies The currently available dependencies.
-     * @default currentDependencies All current dependencies are shared
-     * @returns The dependencies selected to be shared.
-     */
-    (currentDependencies: AvailableDependencies): AvailableDependencies;
-}
-/**
- * The configuration for loading the pilets of the Piral instance.
- */
-export interface PiralPiletConfiguration {
-    /**
-     * Function to load the modules asynchronously, e.g., from a server 🚚.
-     */
-    requestPilets?: PiletRequester;
-    /**
-     * Function to define how to load a pilet given its metadata.
-     */
-    loadPilet?: PiletLoader;
-    /**
-     * Optionally, defines loaders for custom specifications.
-     */
-    loaders?: CustomSpecLoaders;
-    /**
-     * Optionally, configures the default loader.
-     */
-    loaderConfig?: DefaultLoaderConfig;
-    /**
-     * Optionally, configures explicitly what dependencies are shared.
-     */
-    shareDependencies?: DependencySelector;
-    /**
-     * Determines that pilets are loaded asynchronously, essentially showing the
-     * app right away without waiting for the pilets to load and evaluate.
-     */
-    async?: boolean | PiletLoadingStrategy;
-    /**
-     * Determines the modules, which are available already from the start 🚀.
-     * The given modules are all already evaluated.
-     * This can be used for customization or for debugging purposes.
-     */
-    availablePilets?: Array<Pilet>;
-    /**
-     * Extends the Piral instance with additional capabilities.
-     */
-    plugins?: PiralPlugin | Array<PiralPlugin>;
-    /**
-     * Optionally overrides the API factory. By default the `defaultApiFactory`
-     * function is used.
-     */
-    apiFactory?: PiletApiFactory;
-}
-/**
- * Defines an API creation factory.
- */
-export interface PiletApiFactory {
-    /**
-     * @param context The global state context.
-     * @param apis The different APIs to consider.
-     */
-    (context: GlobalStateContext, apis: Array<PiralPlugin>): PiletApiCreator;
-}
-/**
- * The initial configuration of Piral's state container.
- */
-export interface PiralStateConfiguration {
-    /**
-     * Optionally, sets up the initial state of the application 📦.
-     */
-    state?: NestedPartial<GlobalState>;
-    /**
-     * Optionally, sets up some initial custom actions ⚡️.
-     */
-    actions?: PiralDefineActions;
-    /**
-     * Optionally, sets up additional configuration for the debug tooling 🤖.
-     */
-    debug?: DebuggerExtensionOptions;
-}
-/**
- * The configuration to be used in the Piral instance.
- */
-export type PiralConfiguration = PiralPiletConfiguration & PiralStateConfiguration;

package/esm/types/config.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=config.js.map

package/esm/types/config.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/types/config.ts"],"names":[],"mappings":""}

package/esm/types/custom.d.ts

@@ -1,50 +0,0 @@
-/**
- * Custom Pilet API parts defined outside of piral-core.
- */
-export interface PiletCustomApi {
-}
-/**
- * Custom meta data to include for pages.
- */
-export interface PiralCustomPageMeta {
-}
-/**
- * Custom state extensions defined outside of piral-core.
- */
-export interface PiralCustomState {
-}
-/**
- * Custom errors defined outside of piral-core.
- */
-export interface PiralCustomErrors {
-}
-/**
- * Custom actions defined outside of piral-core.
- */
-export interface PiralCustomActions {
-}
-/**
- * Custom events defined outside of piral-core.
- */
-export interface PiralCustomEventMap {
-}
-/**
- * Custom extension slots outside of piral-core.
- */
-export interface PiralCustomExtensionSlotMap {
-}
-/**
- * Custom parts of the global registry state defined outside of piral-core.
- */
-export interface PiralCustomRegistryState {
-}
-/**
- * Custom component converters defined outside of piral-core.
- */
-export interface PiralCustomComponentConverters<TProps> {
-}
-/**
- * Custom parts of the global custom component state defined outside of piral-core.
- */
-export interface PiralCustomComponentsState {
-}

package/esm/types/custom.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=custom.js.map

package/esm/types/custom.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"custom.js","sourceRoot":"","sources":["../../src/types/custom.ts"],"names":[],"mappings":""}

package/esm/types/data.d.ts

@@ -1,51 +0,0 @@
-/**
- * Defines the shape of the data store for storing shared data.
- */
-export interface SharedData<TValue = any> {
-    /**
-     * Access a shared value by its name.
-     */
-    readonly [key: string]: TValue;
-}
-/**
- * Defines the potential targets when storing data.
- */
-export type DataStoreTarget = 'memory' | 'local' | 'remote';
-/**
- * Defines the custom options for storing data.
- */
-export interface CustomDataStoreOptions {
-    /**
-     * The target data store. By default the data is only stored in memory.
-     */
-    target?: DataStoreTarget;
-    /**
-     * Optionally determines when the data expires.
-     */
-    expires?: 'never' | Date | number;
-}
-/**
- * Defines the options to be used for storing data.
- */
-export type DataStoreOptions = DataStoreTarget | CustomDataStoreOptions;
-/**
- * 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;
-}

package/esm/types/data.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=data.js.map

package/esm/types/data.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"data.js","sourceRoot":"","sources":["../../src/types/data.ts"],"names":[],"mappings":""}