@plurid/plurid-react 0.0.0-26 → 0.0.0-27

package/distribution/containers/Application/index.d.ts

@@ -0,0 +1,18 @@
+import React, { Component } from 'react';
+import { PluridApplication as PluridApplicationProperties } from '@plurid/plurid-data';
+import { PluridReactComponent } from "../../data/interfaces";
+import PluridProviderContext from "../Provider/context";
+declare class PluridApplication extends Component<PluridApplicationProperties<PluridReactComponent>, {}> {
+    static contextType: React.Context<import("@plurid/plurid-data").PluridMetastate | undefined>;
+    context: React.ContextType<typeof PluridProviderContext>;
+    private store;
+    private storeUnubscriber;
+    private storeID;
+    constructor(properties: PluridApplicationProperties<PluridReactComponent>, context: React.ContextType<typeof PluridProviderContext>);
+    componentDidUpdate(): void;
+    componentWillUnmount(): void;
+    render(): JSX.Element;
+    private computeStore;
+    private subscribeStore;
+}
+export default PluridApplication;

package/distribution/containers/Provider/context.d.ts

@@ -0,0 +1,4 @@
+import React from 'react';
+import { PluridMetastate } from '@plurid/plurid-data';
+declare const PluridContext: React.Context<PluridMetastate | undefined>;
+export default PluridContext;

package/distribution/containers/Provider/index.d.ts

@@ -0,0 +1,12 @@
+import React, { Component } from 'react';
+import { PluridMetastate } from '@plurid/plurid-data';
+export interface PluridProviderProperties {
+    metastate: PluridMetastate | undefined;
+}
+declare class PluridProvider extends Component<React.PropsWithChildren<PluridProviderProperties>> {
+    static displayName: string;
+    private properties;
+    constructor(properties: React.PropsWithChildren<PluridProviderProperties>);
+    render(): JSX.Element;
+}
+export default PluridProvider;

package/distribution/containers/RouterBrowser/index.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+import { 
+/** interfaces */
+PluridRouterProperties as PluridRouterBrowserOwnProperties } from '@plurid/plurid-data';
+import { PluridReactComponent } from "../../data/interfaces";
+declare const PluridRouterBrowser: (properties: PluridRouterBrowserOwnProperties<PluridReactComponent>) => JSX.Element;
+export default PluridRouterBrowser;

package/distribution/containers/RouterBrowser/styled.d.ts

@@ -0,0 +1 @@
+export declare const PluridScrollTop: import("styled-components").StyledComponent<"div", any, {}, never>;

package/distribution/containers/RouterStatic/index.d.ts

@@ -0,0 +1,18 @@
+/// <reference types="react" />
+import { PluridRoute, PluridRoutePlane } from '@plurid/plurid-data';
+import { PluridReactComponent } from "../../data/interfaces";
+export interface PluridRouterStaticOwnProperties {
+    path: string;
+    directPlane?: string;
+    exterior?: PluridReactComponent;
+    shell?: PluridReactComponent;
+    routes: PluridRoute<PluridReactComponent>[];
+    planes: PluridRoutePlane<PluridReactComponent>[];
+    protocol?: string;
+    hostname?: string;
+    gateway?: boolean;
+    gatewayQuery?: string;
+    gatewayEndpoint?: string;
+}
+declare const PluridRouterStatic: (properties: PluridRouterStaticOwnProperties) => JSX.Element;
+export default PluridRouterStatic;

package/distribution/data/constants/index.d.ts

@@ -0,0 +1,3 @@
+import { PluridLinkCoordinates } from "../interfaces";
+export declare const DEFAULT_ROUTER_LINK_AS_ANCHOR = true;
+export declare const defaultLinkCoordinates: PluridLinkCoordinates;

package/distribution/data/interfaces/index.d.ts

@@ -0,0 +1,20 @@
+import React from 'react';
+import { ComponentWithPlurid, PluridPlane, PluridRoute, PluridRoutePlane, PluridPlaneComponentProperty, PluridRouteComponentProperty, IsoMatcherRouteResult } from '@plurid/plurid-data';
+export interface ElementQLComponent {
+    name: ElementQLComponentName;
+    url?: string;
+}
+export declare type ElementQLComponentName = string;
+export declare type PluridReactFunctionalComponent<T = any, W = PluridPlaneComponentProperty | PluridRouteComponentProperty> = React.FC<ComponentWithPlurid<T, W>>;
+export declare type PluridReactComponent<T = any, W = PluridPlaneComponentProperty | PluridRouteComponentProperty> = PluridReactFunctionalComponent<T, W> | ElementQLComponent | ElementQLComponentName;
+export declare type PluridReactPlaneComponent<T = any> = PluridReactFunctionalComponent<T, PluridPlaneComponentProperty>;
+export declare type PluridReactRouteComponent<T = any> = PluridReactFunctionalComponent<T, PluridRouteComponentProperty>;
+export declare type PluridReactPlane = PluridPlane<PluridReactComponent>;
+export declare type PluridReactRoute<G = any> = PluridRoute<PluridReactComponent, G>;
+export declare type PluridReactRoutePlane = PluridRoutePlane<PluridReactComponent>;
+export interface PluridLinkCoordinates {
+    x: number;
+    y: number;
+}
+export declare type PluridRouteMatch = IsoMatcherRouteResult<PluridReactComponent>;
+export * from './utility';

package/distribution/data/interfaces/utility.d.ts

@@ -0,0 +1,3 @@
+import { ActionCreatorWithPayload, ActionCreatorWithoutPayload } from '@reduxjs/toolkit';
+export declare type DispatchAction<A> = A extends ActionCreatorWithPayload<infer P, infer T> ? (payload: P) => ReturnType<ActionCreatorWithPayload<P, T>> : void;
+export declare type DispatchActionWithoutPayload<A> = A extends ActionCreatorWithoutPayload<infer T> ? () => ReturnType<ActionCreatorWithoutPayload<T>> : void;

package/distribution/index.d.ts

@@ -0,0 +1,117 @@
+/// <reference types="react" />
+import { Theme } from '@plurid/plurid-themes';
+import { PLURID_PUBSUB_TOPIC, PluridPlane, PluridView, PluridUniverse, PluridConfiguration, PluridPartialConfiguration, RecursivePartial, PluridRoute, PluridRouteSpace, PluridRouteUniverse, PluridRoutePlane, ComponentWithPlurid, PluridPlaneComponentProperty, PluridRouteComponentProperty, PluridPreserve, PluridPreserveTransmission, PluridPubSubPublishMessage, PluridPubSubSubscribeMessage, LAYOUT_TYPES as SPACE_LAYOUT, SIZES, TRANSFORM_MODES, TRANSFORM_TOUCHES, PLURID_ROUTER_LOCATION_CHANGED, PLURID_ROUTER_LOCATION_STORED } from '@plurid/plurid-data';
+import { routing, pluridRouterNavigate } from '@plurid/plurid-engine';
+import PluridPubSub from '@plurid/plurid-pubsub';
+import { PluridReactComponent, PluridReactPlaneComponent, PluridReactRouteComponent, PluridReactPlane, PluridReactRoute, PluridReactRoutePlane, PluridRouteMatch } from './data/interfaces';
+import PluridApplication from './containers/Application';
+import PluridRouterBrowser from './containers/RouterBrowser';
+import PluridRouterStatic from './containers/RouterStatic';
+import PluridProvider from './containers/Provider';
+import PluridLink from './components/links/Link';
+import PluridRouterLink from './components/links/RouterLink';
+import PluridApplicationConfigurator from './components/utilities/ApplicationConfigurator';
+import PluridPlaneConfigurator from './components/utilities/PlaneConfigurator';
+import PluridExternalPlane from './components/planes/ExternalPlane';
+import PluridIframePlane from './components/planes/IframePlane';
+import PluridVirtualList from './components/virtuals/List';
+import pluridStateModules from './services/state/modules';
+import { serverComputeMetastate } from './services/logic/server';
+import { getDirectPlaneMatch } from './services/logic/router';
+import { usePluridRouter } from './services/hooks';
+declare const PluridIsoMatcher: typeof routing.IsoMatcher, PluridRouteParser: typeof routing.RouteParser;
+declare const internals: {
+    PluridPlaneBridge: import("react-redux").ConnectedComponent<import("react").FC<import("./components/structural/Plane/components/PlaneBridge").PluridPlaneBridgeProperties>, Omit<import("./components/structural/Plane/components/PlaneBridge").PluridPlaneBridgeProperties, "stateGeneralTheme" | "stateConfiguration"> & import("react-redux").ConnectProps>;
+    PluridPlaneContent: import("react").FC<import("./components/structural/Plane/components/PlaneContent").PluridPlaneContentOwnProperties>;
+    PluridPlaneControls: import("react-redux").ConnectedComponent<import("react").FC<import("./components/structural/Plane/components/PlaneControls").PluridPlaneControlsProperties>, Omit<import("./components/structural/Plane/components/PlaneControls").PluridPlaneControlsProperties, "configuration" | "dispatch" | "stateGeneralTheme" | "stateInteractionTheme" | "stateIsolatePlane"> & import("react-redux").ConnectProps>;
+    PluridPlaneDebugger: import("react-redux").ConnectedComponent<import("react").FC<import("./components/structural/Plane/components/PlaneDebugger").PluridPlaneDebuggerOwnProperties & import("./components/structural/Plane/components/PlaneDebugger").PluridPlaneDebuggerStateProperties & import("./components/structural/Plane/components/PlaneDebugger").PluridPlaneDebuggerDispatchProperties>, Omit<import("./components/structural/Plane/components/PlaneDebugger").PluridPlaneDebuggerOwnProperties & import("./components/structural/Plane/components/PlaneDebugger").PluridPlaneDebuggerStateProperties & import("./components/structural/Plane/components/PlaneDebugger").PluridPlaneDebuggerDispatchProperties, "stateGeneralTheme" | "stateInteractionTheme"> & import("react-redux").ConnectProps>;
+    PluridSpaceDebugger: import("react-redux").ConnectedComponent<import("react").FC<import("./components/structural/Space/components/SpaceDebugger").PluridSpaceDebuggerProperties>, Omit<import("./components/structural/Space/components/SpaceDebugger").PluridSpaceDebuggerProperties, "stateGeneralTheme" | "stateInteractionTheme"> & import("react-redux").ConnectProps>;
+};
+/**
+ * Components and utilities.
+ */
+declare const Plurid: {
+    Application: typeof PluridApplication;
+    RouterStatic: (properties: import("./containers/RouterStatic").PluridRouterStaticOwnProperties) => JSX.Element;
+    RouterBrowser: (properties: import("@plurid/plurid-data").PluridRouterProperties<PluridReactComponent<any, PluridPlaneComponentProperty | PluridRouteComponentProperty>>) => JSX.Element;
+    Provider: typeof PluridProvider;
+    Link: import("react-redux").ConnectedComponent<import("react").FC<import("react").PropsWithChildren<import("./components/links/Link").PluridLinkProperties>>, Omit<import("react").PropsWithChildren<import("./components/links/Link").PluridLinkProperties>, "dispatch" | "stateGeneralTheme" | "stateConfiguration" | "stateTree" | "stateViewSize" | "dispatchSetSpaceField" | "dispatchSetTree" | "stateLastClosedPlane" | "dispatchUpdateSpaceLinkCoordinates"> & import("react-redux").ConnectProps>;
+    RouterLink: import("react").FC<import("./components/links/RouterLink").PluridRouterLinkOwnProperties>;
+    ApplicationConfigurator: import("react-redux").ConnectedComponent<import("react").FC<import("react").PropsWithChildren<import("./components/utilities/ApplicationConfigurator").PluridApplicationConfiguratorProperties>>, Omit<import("react").PropsWithChildren<import("./components/utilities/ApplicationConfigurator").PluridApplicationConfiguratorProperties>, "stateConfiguration" | "dispatchSetConfiguration"> & import("react-redux").ConnectProps>;
+    PlaneConfigurator: import("react-redux").ConnectedComponent<import("react").FC<import("react").PropsWithChildren<import("./components/utilities/PlaneConfigurator").PluridPlaneConfiguratorProperties>>, Omit<import("react").PropsWithChildren<import("./components/utilities/PlaneConfigurator").PluridPlaneConfiguratorProperties>, never> & import("react-redux").ConnectProps>;
+    ExternalPlane: import("react-redux").ConnectedComponent<import("./data/interfaces").PluridReactFunctionalComponent<import("./components/planes/ExternalPlane").ExternalPlaneProperties, PluridRouteComponentProperty>, Omit<ComponentWithPlurid<import("./components/planes/ExternalPlane").ExternalPlaneProperties, PluridRouteComponentProperty>, "stateGeneralTheme" | "stateInteractionTheme"> & import("react-redux").ConnectProps>;
+    IframePlane: import("react-redux").ConnectedComponent<import("./data/interfaces").PluridReactFunctionalComponent<import("./components/planes/IframePlane").IframePlaneProperties, PluridRouteComponentProperty>, Omit<ComponentWithPlurid<import("./components/planes/IframePlane").IframePlaneProperties, PluridRouteComponentProperty>, "stateGeneralTheme" | "stateInteractionTheme"> & import("react-redux").ConnectProps>;
+    VirtualList: import("react-redux").ConnectedComponent<import("react").FC<import("./components/virtuals/List").PluridVirtualListProperties>, Omit<import("./components/virtuals/List").PluridVirtualListProperties, "translationY" | "viewSize"> & import("react-redux").ConnectProps>;
+    /** Enumerations */
+    SPACE_LAYOUT: typeof SPACE_LAYOUT;
+    SIZES: typeof SIZES;
+    TRANSFORM_MODES: typeof TRANSFORM_MODES;
+    TRANSFORM_TOUCHES: typeof TRANSFORM_TOUCHES;
+    /** PubSub */
+    PubSub: typeof PluridPubSub;
+    PUBSUB_TOPIC: {
+        readonly CONFIGURATION: "configuration";
+        readonly SPACE_ANIMATED_TRANSFORM: "space.animatedTransform";
+        readonly SPACE_ROTATE_UP: "space.rotateUp";
+        readonly SPACE_ROTATE_DOWN: "space.rotateDown";
+        readonly SPACE_ROTATE_LEFT: "space.rotateLeft";
+        readonly SPACE_ROTATE_RIGHT: "space.rotateRight";
+        readonly SPACE_ROTATE_X_WITH: "space.rotateXWith";
+        readonly SPACE_ROTATE_Y_WITH: "space.rotateYWith";
+        readonly SPACE_ROTATE_X_TO: "space.rotateXTo";
+        readonly SPACE_ROTATE_Y_TO: "space.rotateYTo";
+        readonly SPACE_TRANSLATE_UP: "space.translateUp";
+        readonly SPACE_TRANSLATE_DOWN: "space.translateDown";
+        readonly SPACE_TRANSLATE_LEFT: "space.translateLeft";
+        readonly SPACE_TRANSLATE_RIGHT: "space.translateRight";
+        readonly SPACE_TRANSLATE_X_WITH: "space.translateXWith";
+        readonly SPACE_TRANSLATE_Y_WITH: "space.translateYWith";
+        readonly SPACE_TRANSLATE_Z_WITH: "space.translateZWith";
+        readonly SPACE_TRANSLATE_X_TO: "space.translateXTo";
+        readonly SPACE_TRANSLATE_Y_TO: "space.translateYTo";
+        readonly SPACE_TRANSLATE_Z_TO: "space.translateZTo";
+        readonly SPACE_SCALE_UP: "space.scaleUp";
+        readonly SPACE_SCALE_DOWN: "space.scaleDown";
+        readonly SPACE_SCALE_WITH: "space.scaleWith";
+        readonly SPACE_TRANSFORM: "space.transform";
+        readonly VIEW_ADD_PLANE: "view.addPlane";
+        readonly VIEW_SET_PLANES: "view.setPlanes";
+        readonly VIEW_REMOVE_PLANE: "view.removePlane";
+        readonly NAVIGATE_TO_PLANE: "space.navigateToPlane";
+        readonly REFRESH_PLANE: "space.refreshPlane";
+        readonly ISOLATE_PLANE: "space.isolatePlane";
+        readonly OPEN_CLOSED_PLANE: "space.openClosedPlane";
+        readonly CLOSE_PLANE: "space.closePlane";
+        readonly PREVIOUS_ROOT: "space.previousRoot";
+        readonly NEXT_ROOT: "space.nextRoot";
+        readonly NAVIGATE_TO_ROOT: "space.navigateToRoot";
+    };
+    /** Server */
+    serverComputeMetastate: (isoMatch: PluridRouteMatch, paths: PluridRoute<PluridReactComponent<any, PluridPlaneComponentProperty | PluridRouteComponentProperty>, any>[], globals: Record<string, string> | undefined) => Promise<import("@plurid/plurid-data").PluridMetastate>;
+    /** Router */
+    IsoMatcher: typeof routing.IsoMatcher;
+    routerNavigate: (path: string) => void;
+    internals: {
+        PluridPlaneBridge: import("react-redux").ConnectedComponent<import("react").FC<import("./components/structural/Plane/components/PlaneBridge").PluridPlaneBridgeProperties>, Omit<import("./components/structural/Plane/components/PlaneBridge").PluridPlaneBridgeProperties, "stateGeneralTheme" | "stateConfiguration"> & import("react-redux").ConnectProps>;
+        PluridPlaneContent: import("react").FC<import("./components/structural/Plane/components/PlaneContent").PluridPlaneContentOwnProperties>;
+        PluridPlaneControls: import("react-redux").ConnectedComponent<import("react").FC<import("./components/structural/Plane/components/PlaneControls").PluridPlaneControlsProperties>, Omit<import("./components/structural/Plane/components/PlaneControls").PluridPlaneControlsProperties, "configuration" | "dispatch" | "stateGeneralTheme" | "stateInteractionTheme" | "stateIsolatePlane"> & import("react-redux").ConnectProps>;
+        PluridPlaneDebugger: import("react-redux").ConnectedComponent<import("react").FC<import("./components/structural/Plane/components/PlaneDebugger").PluridPlaneDebuggerOwnProperties & import("./components/structural/Plane/components/PlaneDebugger").PluridPlaneDebuggerStateProperties & import("./components/structural/Plane/components/PlaneDebugger").PluridPlaneDebuggerDispatchProperties>, Omit<import("./components/structural/Plane/components/PlaneDebugger").PluridPlaneDebuggerOwnProperties & import("./components/structural/Plane/components/PlaneDebugger").PluridPlaneDebuggerStateProperties & import("./components/structural/Plane/components/PlaneDebugger").PluridPlaneDebuggerDispatchProperties, "stateGeneralTheme" | "stateInteractionTheme"> & import("react-redux").ConnectProps>;
+        PluridSpaceDebugger: import("react-redux").ConnectedComponent<import("react").FC<import("./components/structural/Space/components/SpaceDebugger").PluridSpaceDebuggerProperties>, Omit<import("./components/structural/Space/components/SpaceDebugger").PluridSpaceDebuggerProperties, "stateGeneralTheme" | "stateInteractionTheme"> & import("react-redux").ConnectProps>;
+    };
+};
+export { PluridApplication, PluridRouterBrowser, PluridRouterStatic, PluridProvider, PluridLink, PluridRouterLink, PluridApplicationConfigurator, PluridPlaneConfigurator, PluridExternalPlane, PluridIframePlane, PluridVirtualList, 
+/** Interfaces */
+Theme, PluridPlane, PluridView, PluridUniverse, PluridRoute, PluridRouteSpace, PluridRouteUniverse, PluridRoutePlane, ComponentWithPlurid, PluridPlaneComponentProperty, PluridRouteComponentProperty, PluridReactComponent, PluridReactPlane, PluridReactPlaneComponent, PluridReactRouteComponent, PluridReactRoute, PluridReactRoutePlane, PluridRouteMatch, PluridPreserve, PluridPreserveTransmission, PluridPubSubPublishMessage, PluridPubSubSubscribeMessage, PluridConfiguration, PluridPartialConfiguration, RecursivePartial, 
+/** Enumerations */
+SPACE_LAYOUT, SIZES, TRANSFORM_MODES, TRANSFORM_TOUCHES, PLURID_ROUTER_LOCATION_CHANGED, PLURID_ROUTER_LOCATION_STORED, 
+/** Engine */
+PluridIsoMatcher, PluridRouteParser, 
+/** PubSub */
+PluridPubSub, PLURID_PUBSUB_TOPIC, 
+/** Server */
+serverComputeMetastate, 
+/** Router */
+pluridRouterNavigate, usePluridRouter, getDirectPlaneMatch, 
+/** state */
+pluridStateModules, internals, };
+export default Plurid;