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

package/esm/types/extension.d.ts

@@ -1,61 +0,0 @@
-import type { ReactNode, ReactElement } from 'react';
-import type { PiralCustomExtensionSlotMap } from './custom';
-import type { ExtensionRegistration } from './state';
-/**
- * The mapping of the existing (known) extension slots.
- */
-export interface PiralExtensionSlotMap extends PiralCustomExtensionSlotMap {
-}
-/**
- * The basic props for defining an extension slot.
- */
-export interface BaseExtensionSlotProps<TName, TParams> {
-    /**
-     * The children to transport, if any.
-     */
-    children?: ReactNode;
-    /**
-     * Defines what should be rendered when no components are available
-     * for the specified extension.
-     */
-    empty?(props: TParams): ReactNode;
-    /**
-     * Determines if the `render` function should be called in case no
-     * components are available for the specified extension.
-     *
-     * If true, `empty` will be called and returned from the slot.
-     * If false, `render` will be called with the result of calling `empty`.
-     * The result of calling `render` will then be returned from the slot.
-     */
-    emptySkipsRender?: boolean;
-    /**
-     * Defines the order of the components to render.
-     * May be more convient than using `render` w.r.t. ordering extensions
-     * by their supplied metadata.
-     * @param extensions The registered extensions.
-     * @returns The ordered extensions.
-     */
-    order?(extensions: Array<ExtensionRegistration>): Array<ExtensionRegistration>;
-    /**
-     * Defines how the provided nodes should be rendered.
-     * @param nodes The rendered extension nodes.
-     * @returns The rendered nodes, i.e., an ReactElement.
-     */
-    render?(nodes: Array<ReactNode>): ReactElement<any, any> | null;
-    /**
-     * The custom parameters for the given extension.
-     */
-    params?: TParams;
-    /**
-     * The name of the extension to render.
-     */
-    name: TName;
-}
-/**
- * Gives the extension params shape for the given extension slot name.
- */
-export type ExtensionParams<TName> = TName extends keyof PiralExtensionSlotMap ? PiralExtensionSlotMap[TName] : TName extends string ? any : TName;
-/**
- * The props for defining an extension slot.
- */
-export type ExtensionSlotProps<TName = string> = BaseExtensionSlotProps<TName extends string ? TName : string, ExtensionParams<TName>>;

package/esm/types/extension.js

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

package/esm/types/extension.js.map

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

package/esm/types/index.d.ts

@@ -1,14 +0,0 @@
-export * from './api';
-export * from './common';
-export * from './components';
-export * from './config';
-export * from './custom';
-export * from './data';
-export * from './extension';
-export * from './instance';
-export * from './layout';
-export * from './navigation';
-export * from './plugin';
-export * from './state';
-export * from './utils';
-export * from './web';

package/esm/types/index.js

@@ -1,15 +0,0 @@
-export * from './api';
-export * from './common';
-export * from './components';
-export * from './config';
-export * from './custom';
-export * from './data';
-export * from './extension';
-export * from './instance';
-export * from './layout';
-export * from './navigation';
-export * from './plugin';
-export * from './state';
-export * from './utils';
-export * from './web';
-//# sourceMappingURL=index.js.map

package/esm/types/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,OAAO,CAAC;AACtB,cAAc,UAAU,CAAC;AACzB,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,OAAO,CAAC"}

package/esm/types/instance.d.ts

@@ -1,60 +0,0 @@
-import type { ReactNode } from 'react';
-import type { PiletApi, PiletApiCreator, LoadPiletsOptions, EventEmitter } from 'piral-base';
-import type { GlobalStateContext } from './state';
-import type { LayoutBreakpoints } from './layout';
-import type { PiralConfiguration } from './config';
-/**
- * The props of the Piral context.
- */
-export interface PiralContextProps {
-    /**
-     * The specific Piral instance to be used.
-     */
-    instance?: PiralInstance;
-    children?: ReactNode;
-}
-/**
- * The props of the Piral component.
- */
-export interface PiralProps extends PiralContextProps {
-    /**
-     * The custom breakpoints for the different layout modi.
-     */
-    breakpoints?: LayoutBreakpoints;
-}
-/**
- * The options for creating a new PiralInstance object.
- */
-export interface PiralInstanceOptions extends PiralConfiguration {
-    /**
-     * Defines the id of this instance. Used in case of multiple instances.
-     */
-    id?: string;
-}
-/**
- * The PiralInstance object, which is an event emitter with some other
- * utilities and helper. This object is the source for the React
- * functional component (`Piral`).
- */
-export interface PiralInstance extends EventEmitter {
-    /**
-     * The id of the Piral instance.
-     */
-    id: string;
-    /**
-     * The global state context instance.
-     */
-    context: GlobalStateContext;
-    /**
-     * The pilet API creator callback.
-     */
-    createApi: PiletApiCreator;
-    /**
-     * The used options for loading pilets.
-     */
-    options: LoadPiletsOptions;
-    /**
-     * The root pilet for using the pilet API within the Piral instance.
-     */
-    root: PiletApi;
-}

package/esm/types/instance.js

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

package/esm/types/instance.js.map

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

package/esm/types/layout.d.ts

@@ -1,12 +0,0 @@
-/**
- * The mapping of breakpoints to layout type index.
- */
-export type LayoutBreakpoints = [string, string, string];
-/**
- * The different known layout types.
- */
-export type LayoutType = 'mobile' | 'tablet' | 'desktop';
-/**
- * The mapping of the layout types to breakpoint index.
- */
-export type LayoutTypes = [LayoutType, LayoutType, LayoutType];

package/esm/types/layout.js

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

package/esm/types/layout.js.map

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

package/esm/types/navigation.d.ts

@@ -1,98 +0,0 @@
-import type { Disposable } from './utils';
-export type NavigationAction = 'POP' | 'PUSH' | 'REPLACE';
-export interface NavigationLocation {
-    /**
-     * The fully qualified URL incl. the origin and base path.
-     */
-    href: string;
-    /**
-     * The location.pathname property is a string that contains an initial "/"
-     * followed by the remainder of the URL up to the ?.
-     */
-    pathname: string;
-    /**
-     * The location.search property is a string that contains an initial "?"
-     * followed by the key=value pairs in the query string. If there are no
-     * parameters, this value may be the empty string (i.e. '').
-     */
-    search: string;
-    /**
-     * The location.hash property is a string that contains an initial "#"
-     * followed by fragment identifier of the URL. If there is no fragment
-     * identifier, this value may be the empty string (i.e. '').
-     */
-    hash: string;
-    /**
-     * The location.state property is a user-supplied State object that is
-     * associated with this location. This can be a useful place to store
-     * any information you do not want to put in the URL, e.g. session-specific
-     * data.
-     */
-    state: unknown;
-    /**
-     * The location.key property is a unique string associated with this location.
-     * On the initial location, this will be the string default. On all subsequent
-     * locations, this string will be a unique identifier.
-     */
-    key?: string;
-}
-export interface NavigationListener {
-    (update: NavigationUpdate): void;
-}
-export interface NavigationBlocker {
-    (tx: NavigationTransition): void;
-}
-export interface NavigationUpdate {
-    action: NavigationAction;
-    location: NavigationLocation;
-}
-export interface NavigationTransition extends NavigationUpdate {
-    retry?(): void;
-}
-export interface NavigationApi {
-    /**
-     * Pushes a new location onto the history stack.
-     */
-    push(target: string, state?: any): void;
-    /**
-     * Replaces the current location with another.
-     */
-    replace(target: string, state?: any): void;
-    /**
-     * Changes the current index in the history stack by a given delta.
-     */
-    go(n: number): void;
-    /**
-     * Prevents changes to the history stack from happening.
-     * This is useful when you want to prevent the user navigating
-     * away from the current page, for example when they have some
-     * unsaved data on the current page.
-     * @param blocker The function being called with a transition request.
-     * @returns The disposable for stopping the block.
-     */
-    block(blocker: NavigationBlocker): Disposable;
-    /**
-     * Starts listening for location changes and calls the given
-     * callback with an Update when it does.
-     * @param listener The function being called when the route changes.
-     * @returns The disposable for stopping the block.
-     */
-    listen(listener: NavigationListener): Disposable;
-    /**
-     * Gets the current navigation / application path.
-     */
-    path: string;
-    /**
-     * Gets the current navigation path incl. search and hash parts.
-     */
-    url: string;
-    /**
-     * The original router behind the navigation. Don't depend on this
-     * as the implementation is router specific and may change over time.
-     */
-    router: any;
-    /**
-     * Gets the public path of the application.
-     */
-    publicPath: string;
-}

package/esm/types/navigation.js

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

package/esm/types/navigation.js.map

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

package/esm/types/plugin.d.ts

@@ -1,14 +0,0 @@
-import type { PiletApiExtender } from 'piral-base';
-import type { PiletApi } from './api';
-import type { GlobalStateContext } from './state';
-/**
- * Shape to be used by a plugin used in the Piral instance.
- */
-export interface PiralPlugin<T = Partial<PiletApi>> {
-    /**
-     * Extends the base API with a custom set of functionality to be used by modules.
-     * @param context The global state context to be used.
-     * @returns The extended API or a function to create the extended API for a specific target.
-     */
-    (context: GlobalStateContext): T | PiletApiExtender<T>;
-}

package/esm/types/plugin.js

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

package/esm/types/plugin.js.map

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

package/esm/types/state.d.ts

@@ -1,346 +0,0 @@
-import type { ComponentType, ReactPortal, PropsWithChildren } from 'react';
-import type { RouteComponentProps } from 'react-router';
-import type { LoadPiletsOptions } from 'piral-base';
-import type { UseBoundStore } from 'zustand';
-import type { Dict, Without } from './common';
-import type { NavigationApi } from './navigation';
-import type { SharedDataItem, DataStoreTarget } from './data';
-import type { PiralCustomActions, PiralCustomState, PiralCustomRegistryState, PiralCustomComponentsState } from './custom';
-import type { EventEmitter, Pilet, BaseComponentProps, PageComponentProps, ExtensionComponentProps, PiletsBag, PiletEntry } from './api';
-import type { PiralPageMeta, ComponentConverters, LoadingIndicatorProps, ErrorInfoProps, RouterProps, LayoutProps, Errors, RouteSwitchProps } from './components';
-export interface StateDispatcher<TState> {
-    (state: TState): Partial<TState>;
-}
-export type WrappedComponent<TProps> = ComponentType<PropsWithChildren<Without<TProps, keyof BaseComponentProps>>>;
-/**
- * The base type for pilet component registration in the global state context.
- */
-export interface BaseRegistration {
-    /**
-     * The pilet registering the component.
-     */
-    pilet: string;
-}
-/**
- * The interface modeling the registration of a pilet page component.
- */
-export interface PageRegistration extends BaseRegistration {
-    /**
-     * The registered page component.
-     */
-    component: WrappedComponent<PageComponentProps>;
-    /**
-     * The page's associated metadata.
-     */
-    meta: PiralPageMeta;
-}
-/**
- * The interface modeling the registration of a pilet extension component.
- */
-export interface ExtensionRegistration extends BaseRegistration {
-    /**
-     * The wrapped registered extension component.
-     */
-    component: WrappedComponent<ExtensionComponentProps<string>>;
-    /**
-     * The original extension component that has been registered.
-     */
-    reference: any;
-    /**
-     * The default params (i.e., meta) of the extension.
-     */
-    defaults: any;
-}
-/**
- * The Piral global app sub-state container for shared components.
- */
-export interface ComponentsState extends PiralCustomComponentsState {
-    /**
-     * The loading indicator renderer.
-     */
-    LoadingIndicator: ComponentType<LoadingIndicatorProps>;
-    /**
-     * The error renderer.
-     */
-    ErrorInfo: ComponentType<ErrorInfoProps>;
-    /**
-     * The router context.
-     */
-    Router: ComponentType<RouterProps>;
-    /**
-     * The layout used for pages.
-     */
-    Layout: ComponentType<LayoutProps>;
-    /**
-     * The route switch used for determining the route registration.
-     */
-    RouteSwitch: ComponentType<RouteSwitchProps>;
-    /**
-     * A component that can be used for debugging purposes.
-     */
-    Debug?: ComponentType;
-}
-/**
- * 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 if the components from the micro frontends should be wrapped
-     * in a piral-component element.
-     */
-    wrap: boolean;
-}
-/**
- * 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<ComponentType<any>>;
-}
-export type ErrorComponentsState = {
-    [P in keyof Errors]?: ComponentType<Errors[P]>;
-};
-/**
- * The Piral global app state container.
- */
-export interface GlobalState extends PiralCustomState {
-    /**
-     * The relevant state for the app itself.
-     */
-    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<Pilet>;
-    /**
-     * The foreign component portals to render.
-     */
-    portals: Record<string, Array<ReactPortal>>;
-    /**
-     * The application's shared data.
-     */
-    data: Dict<SharedDataItem>;
-    /**
-     * The used (exact) application routes.
-     */
-    routes: Dict<ComponentType<RouteComponentProps<any>> & {
-        /**
-         * The optional meta data registered with the page.
-         */
-        meta?: PiralPageMeta;
-    }>;
-    /**
-     * The current provider.
-     */
-    provider?: ComponentType;
-}
-/**
- * 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 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 an evaluated pilet at runtime - removes the pilet from registry first if available.
-     * @param pilet The pilet to be injected.
-     * @returns The injected pilet.
-     */
-    injectPilet(pilet: Pilet): Pilet;
-    /**
-     * 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.
-     */
-    addPilet(pilet: PiletEntry): Promise<void>;
-    /**
-     * Removes a pilet by unloading it and deleting all component registrations.
-     * @param name The name of the pilet to remove.
-     */
-    removePilet(name: string): Promise<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;
-    /**
-     * Tries to write a shared data item. The write access is only
-     * possible if the name belongs to the provided owner or has not
-     * been taken yet.
-     * Setting the value to null will release it.
-     * @param name The name of the shared data item.
-     * @param value The value of the shared data item.
-     * @param owner The owner of the shared data item.
-     * @param target The target storage locatation.
-     * @param expiration The time for when to dispose the shared item.
-     */
-    tryWriteDataItem(name: string, value: any, owner: string, target: DataStoreTarget, expiration: number): boolean;
-    /**
-     * Registers a new route to be resolved.
-     * @param route The route to register.
-     * @param value The page to be rendered on the route.
-     */
-    registerPage(route: string, value: PageRegistration): void;
-    /**
-     * Unregisters an existing route.
-     * @param route The route to be removed.
-     */
-    unregisterPage(route: string): void;
-    /**
-     * Registers a new extension.
-     * @param name The name of the extension category.
-     * @param value The extension registration.
-     */
-    registerExtension(name: string, value: ExtensionRegistration): void;
-    /**
-     * Unregisters an existing extension.
-     * @param name The name of the extension category.
-     * @param value The extension that will be removed.
-     */
-    unregisterExtension(name: string, reference: any): void;
-    /**
-     * Sets the common component to render.
-     * @param name The name of the component.
-     * @param component The component to use for rendering.
-     */
-    setComponent<TKey extends keyof ComponentsState>(name: TKey, component: ComponentsState[TKey]): void;
-    /**
-     * Sets the error component to render.
-     * @param type The type of the error.
-     * @param component The component to use for rendering.
-     */
-    setErrorComponent<TKey extends keyof ErrorComponentsState>(type: TKey, component: ErrorComponentsState[TKey]): void;
-    /**
-     * Sets the common routes to render.
-     * @param path The name of the component.
-     * @param component The component to use for rendering.
-     */
-    setRoute<T extends {
-        [K in keyof T]?: string;
-    } = {}>(path: string, component: ComponentType<RouteComponentProps<T>>): void;
-    /**
-     * Includes a new provider as a sub-provider to the current provider.
-     * @param provider The provider to include.
-     */
-    includeProvider(provider: JSX.Element): void;
-    /**
-     * Destroys (i.e., resets) the given portal instance.
-     * @param id The id of the portal to destroy.
-     */
-    destroyPortal(id: string): void;
-    /**
-     * Includes the provided portal in the rendering pipeline.
-     * @param id The id of the portal to use.
-     * @param entry The child to render.
-     */
-    showPortal(id: string, entry: ReactPortal): void;
-    /**
-     * Hides the provided portal in the rendering pipeline.
-     * @param id The id of the portal to use.
-     * @param entry The child to remove.
-     */
-    hidePortal(id: string, entry: ReactPortal): void;
-    /**
-     * Updates the provided portal in the rendering pipeline.
-     * @param id The id of the portal to use.
-     * @param current The currently displayed child.
-     * @param next The updated child that should be displayed.
-     */
-    updatePortal(id: string, current: ReactPortal, next: ReactPortal): void;
-    /**
-     * Dispatches a state change.
-     * @param update The update function creating a new state.
-     */
-    dispatch(update: (state: GlobalState) => GlobalState): void;
-    /**
-     * Reads the selected part of the global state.
-     * @param select The selector for getting the desired part.
-     * @returns The desired part.
-     */
-    readState<S>(select: (state: GlobalState) => S): S;
-}
-/**
- * The Piral app instance context.
- */
-export interface GlobalStateContext extends PiralActions, EventEmitter {
-    /**
-     * The global state context atom.
-     * Changes to the state should always be dispatched via the `dispatch` action.
-     */
-    state: UseBoundStore<GlobalState>;
-    /**
-     * The API objects created for the loaded pilets.
-     */
-    apis: PiletsBag;
-    /**
-     * The available component converters.
-     */
-    converters: ComponentConverters<any>;
-    /**
-     * The navigation manager for the whole instance.
-     */
-    navigation: NavigationApi;
-    /**
-     * The initial options.
-     */
-    options: LoadPiletsOptions;
-}

package/esm/types/state.js

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

package/esm/types/state.js.map

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