@plurid/plurid-data 0.0.0-1 → 0.0.0-10

package/distribution/interfaces/external/application/index.d.ts

@@ -1,19 +1,19 @@
-import { PluridState } from "../../internal/state/index";
-import { PluridPlane, PluridPlaneContext } from "../plane/index";
-import { PluridComponent } from "../component/index";
-import { PluridView } from "../view/index";
-import { PluridPartialConfiguration } from "../configuration/index";
-import { IndexedPluridPlane } from "../plane/index";
-import { PluridPubSub } from "../pubsub/index";
-import { PluridPlanesRegistrar } from "../registrar/index";
-export interface PluridApplication {
+import { PluridState } from '../../internal/state';
+import { PluridPlane, PluridPlaneContext } from '../plane';
+import { PluridView } from '../view';
+import { PluridPartialConfiguration } from '../configuration';
+import { IndexedPluridPlane } from '../plane';
+import { PluridPubSub } from '../pubsub';
+import { PluridPlanesRegistrar } from '../registrar';
+import { IsoMatcherRouteResult } from '../routing';
+export interface PluridApplication<C> {
     id?: string;
-    indexedPlanes?: Map<string, IndexedPluridPlane>;
+    indexedPlanes?: Map<string, IndexedPluridPlane<C>>;
     planesProperties?: Map<string, any>;
     /**
      * The planes which will be rendered by the `PluridApplication`.
      */
-    planes?: PluridPlane[];
+    planes?: PluridPlane<C>[];
     /**
      * Optional context for the plane to have access to.
      */
@@ -28,9 +28,17 @@ export interface PluridApplication {
     view: PluridApplicationView;
     /**
      * Show or not the default Plane Not Found component, or pass a custom component.
+     *
+     * Default `true`.
+     */
+    planeNotFound?: boolean | C;
+    /**
+     * Use or not Plurid Plane Error Boundary and show the default Plurid Plane Render Error component,
+     * or pass a custom component.
+     *
      * Default `true`.
      */
-    notFound?: boolean | PluridComponent;
+    planeRenderError?: boolean | C;
     /**
      * Application-wide partial configuration.
      */
@@ -44,14 +52,26 @@ export interface PluridApplication {
      */
     static?: boolean;
     precomputedState?: Partial<PluridState>;
-    planesRegistrar?: PluridPlanesRegistrar;
+    planesRegistrar?: PluridPlanesRegistrar<C>;
     /**
      * Save plurid application state to local storage,
      * and load from local storage at startup.
      *
      * If multiple plurid applications run on the same origin,
      * use the `id` property to differentiate between states.
+     *
+     * `LocalStorageUsage` differentiates between multiple local storages:
+     * for view, for user interface configuration.
      */
     useLocalStorage?: boolean;
+    /**
+     * Replace the internal plurid plane with a custom implementation.
+     */
+    customPlane?: C;
+    matchedRoute: IsoMatcherRouteResult<C>;
+}
+export declare type PluridApplicationView = (string | PluridView)[];
+export interface LocalStorageUsage {
+    view: boolean;
+    ui: boolean;
 }
-export declare type PluridApplicationView = string[] | PluridView[];

package/distribution/interfaces/external/cluster/index.d.ts

@@ -1,9 +1,9 @@
-import { PluridPlane } from "../plane/index";
-import { PluridLayout } from "../layout/index";
-export interface PluridCluster {
+import { PluridPlane } from '../plane';
+import { PluridLayout } from '../layout';
+export interface PluridCluster<C> {
     id: string;
     name?: string;
-    planes?: PluridPlane[];
-    clusters?: PluridCluster[];
+    planes?: PluridPlane<C>[];
+    clusters?: PluridCluster<C>[];
     layout?: PluridLayout;
 }

package/distribution/interfaces/external/component/index.d.ts

@@ -1,45 +1,24 @@
-import React from 'react';
-import { RouteHostDivision, RouteDivision, RouteHostProtocol, RoutePlaneDivision } from "../../internal/tree/index";
-export interface PluridComponentBase {
-    kind: PluridComponentKind;
-    /**
-     * The `properties` will be passed to the `element` at runtime.
-     */
-    properties?: Record<string, any>;
+import { PluridRouteFragments } from '../router';
+export declare type ComponentWithPlurid<T, W> = T & WithPluridComponentProperty<W>;
+export interface WithPluridComponentProperty<W> {
+    plurid: W;
 }
-export declare type PluridComponentKind = 'elementql' | 'react';
-export interface PluridComponentElementQL extends PluridComponentBase {
-    kind: 'elementql';
-    endpoint: string;
-    element: string;
+export declare type PlaneComponentWithPluridProperty<T> = ComponentWithPlurid<T, PluridPlaneComponentProperty>;
+export declare type RouteComponentWithPluridProperty<T> = ComponentWithPlurid<T, PluridRouteComponentProperty>;
+export interface PluridPlaneComponentProperty {
+    route: PluridRouteComponentProperty;
+    plane: PluridPlaneComponentPropertyPlane;
 }
-export interface PluridComponentReact extends PluridComponentBase {
-    kind: 'react';
-    /**
-     * The `element` will receive the properties, if any,
-     * and the `plurid` property.
-     */
-    element: React.FC<ReactComponentWithPlurid<any>>;
-}
-export declare type ReactComponentWithPlurid<T> = T & WithPluridComponentProperty;
-export interface WithPluridComponentProperty {
-    plurid: PluridComponentProperty;
-}
-export interface PluridComponentProperty {
-    metadata: PluridComponentPropertyMetadata;
-    route: PluridComponentPropertyRoute;
-}
-export interface PluridComponentPropertyMetadata {
+export interface PluridPlaneComponentPropertyPlane {
+    value: string;
+    parameters: Record<string, string>;
+    query: Record<string, string>;
+    fragments: PluridRouteFragments;
     planeID: string;
     parentPlaneID?: string;
 }
-export interface PluridComponentPropertyRoute {
-    protocol: RouteHostProtocol;
-    host: RouteHostDivision;
-    path: RouteDivision;
-    space: RouteDivision;
-    universe: RouteDivision;
-    cluster: RouteDivision;
-    plane: RoutePlaneDivision;
+export interface PluridRouteComponentProperty {
+    value: string;
+    parameters: Record<string, string>;
+    query: Record<string, string>;
 }
-export declare type PluridComponent = PluridComponentElementQL | PluridComponentReact;

package/distribution/interfaces/external/configuration/index.d.ts

@@ -1,8 +1,8 @@
-import themes, { Theme } from '@plurid/plurid-themes';
-import { SIZES, TRANSFORM_MODES, TRANSFORM_TOUCHES, TOOLBAR_DRAWERS } from "../../../enumerations/index";
-import { RecursivePartial } from "../../helpers/index";
-import { PluridLayout } from "../layout/index";
-import { InternationalizationLanguageType } from "../../internal/internationalization/index";
+import { Theme, ThemeName } from '@plurid/plurid-themes';
+import { SIZES, TRANSFORM_MODES, TRANSFORM_TOUCHES, TOOLBAR_DRAWERS } from '../../../enumerations';
+import { RecursivePartial } from '../../helpers';
+import { PluridLayout } from '../layout';
+import { InternationalizationLanguageType } from '../../internal/internationalization';
 export declare type PluridPartialConfiguration = RecursivePartial<PluridConfiguration>;
 export interface PluridConfiguration {
     global: PluridConfigurationGlobal;
@@ -21,7 +21,7 @@ export interface PluridConfigurationGlobal {
      * A theme name based on plurid themes, https://meta.plurid.com/themes,
      * or specific theme names/objects for `general` and for the `interaction` elements.
      */
-    theme: keyof typeof themes | PluridConfigurationTheme;
+    theme: ThemeName | PluridConfigurationTheme;
     /**
      * Supported languages:
      *
@@ -56,8 +56,8 @@ export interface PluridConfigurationGlobal {
     render: 'plurid' | 'legacy';
 }
 export interface PluridConfigurationTheme {
-    general: keyof typeof themes | Theme;
-    interaction: keyof typeof themes | Theme;
+    general: ThemeName | Theme;
+    interaction: ThemeName | Theme;
 }
 export interface PluridConfigurationSpace {
     layout: PluridLayout;
@@ -95,6 +95,12 @@ export interface PluridConfigurationSpace {
     transformTouch: keyof typeof TRANSFORM_TOUCHES;
     firstPerson: boolean;
     cullingDistance: number;
+    /**
+     * Time for the planes to fade in, in milliseconds.
+     *
+     * Default 1500
+     */
+    fadeInTime: number;
 }
 export interface PluridConfigurationSpaceTransformOrigin {
     show: boolean;
@@ -121,7 +127,8 @@ export interface PluridConfigurationElementsToolbar {
     conceal: boolean;
     transformIcons: boolean;
     transformButtons: boolean;
-    toggledDrawers: (keyof typeof TOOLBAR_DRAWERS | undefined)[];
+    drawers: (keyof typeof TOOLBAR_DRAWERS)[];
+    toggledDrawers: (keyof typeof TOOLBAR_DRAWERS)[];
 }
 export interface PluridConfigurationElementsViewcube {
     show: boolean;

package/distribution/interfaces/external/configurator/index.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="react" />
-import PluridPubSub from '@plurid/plurid-pubsub';
+import { PluridPubSub } from '../pubsub';
 export interface PluridApplicationConfiguratorProperties {
     /**
      * Publish/Subscribe bus based on `@plurid/plurid-pubsub`.

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

@@ -1,16 +1,17 @@
-export * from "./application/index";
-export * from "./cluster/index";
-export * from "./compare/index";
-export * from "./component/index";
-export * from "./configuration/index";
-export * from "./keys/index";
-export * from "./layout/index";
-export * from "./link/index";
-export * from "./metastate/index";
-export * from "./plane/index";
-export * from "./pubsub/index";
-export * from "./registrar/index";
-export * from "./router/index";
-export * from "./universe/index";
-export * from "./view/index";
-export * from "./window/index";
+export * from './application';
+export * from './cluster';
+export * from './compare';
+export * from './component';
+export * from './configuration';
+export * from './keys';
+export * from './layout';
+export * from './link';
+export * from './metastate';
+export * from './plane';
+export * from './pubsub';
+export * from './registrar';
+export * from './router';
+export * from './routing';
+export * from './universe';
+export * from './view';
+export * from './window';

package/distribution/interfaces/external/layout/index.d.ts

@@ -1,4 +1,4 @@
-import { LAYOUT_TYPES } from "../../../enumerations/index";
+import { LAYOUT_TYPES } from '../../../enumerations';
 export interface Layout {
     type: keyof typeof LAYOUT_TYPES;
 }

package/distribution/interfaces/external/link/index.d.ts

@@ -1,6 +1,5 @@
 /// <reference types="react" />
-import { PluridComponent } from "../component/index";
-export interface PluridLink {
+export interface PluridLink<C> {
     /**
      * The route of the plane.
      *
@@ -121,13 +120,13 @@ export interface PluridLink {
     /**
      * Show or not the default Not Found component, or pass a custom component
      */
-    notFound?: boolean | PluridComponent;
+    notFound?: boolean | C;
     preview?: boolean;
     previewFadeIn?: number;
     previewFadeOut?: number;
     previewOffsetX?: number;
     previewOffsetY?: number;
-    previewComponent?: PluridComponent;
+    previewComponent?: C;
     style?: React.CSSProperties;
     className?: string;
 }

package/distribution/interfaces/external/metastate/index.d.ts

@@ -1,4 +1,4 @@
-import { PluridState } from "../../internal/state/index";
+import { PluridState } from '../../internal/state';
 export declare type PluridMetastateState = Pick<PluridState, 'configuration' | 'space' | 'ui'>;
 export interface PluridMetastate {
     states: Record<string, PluridMetastateState>;

package/distribution/interfaces/external/plane/index.d.ts

@@ -1,10 +1,12 @@
 /// <reference types="react" />
-import { PluridComponent } from "../component/index";
-export interface PluridPlane {
+import { PluridRouteParameter, PluridRouteFragments } from '../router';
+export interface PluridPlaneOptions {
     /**
-     * Custom HTML, React, Vue, or Angular component to be rendered in the PluridPlane.
+     * Constraints for the parameters.
      */
-    component: PluridComponent;
+    parameters?: Record<string, PluridRouteParameter>;
+}
+export interface PluridPlaneObject<C> extends PluridPlaneOptions {
     /**
      * Route to the plane, e.g. `/plane-1`. By convention, it starts with an '/'.
      *
@@ -33,9 +35,28 @@ export interface PluridPlane {
      *
      */
     route: string;
+    /**
+     * Component to be rendered in the PluridPlane.
+     */
+    component: C;
 }
+export declare type PluridPlaneTuple<C> = [
+    /**
+     * See `PluridPlaneObject<C>.route`.
+     */
+    route: string,
+    /**
+     * See `PluridPlaneObject<C>.component`.
+     */
+    component: C,
+    /**
+     * See `PluridPlaneOptions`.
+     */
+    options?: PluridPlaneOptions
+];
+export declare type PluridPlane<C> = PluridPlaneObject<C> | PluridPlaneTuple<C>;
 export declare type PluridPlaneContext<T> = React.Context<T>;
-export interface IndexedPluridPlane {
+export interface IndexedPluridPlane<C> {
     protocol: string;
     host: string;
     path: string;
@@ -44,21 +65,17 @@ export interface IndexedPluridPlane {
     cluster: string;
     plane: string;
     route: string;
-    component: PluridComponent;
+    component: C;
 }
 export interface RouteSegment {
     [key: string]: any;
 }
-export interface RegisteredPluridPlane {
+export interface RegisteredPluridPlane<C> {
     route: {
-        protocol: RouteSegment;
-        host: RouteSegment;
-        path: RouteSegment;
-        space: RouteSegment;
-        universe: RouteSegment;
-        cluster: RouteSegment;
-        plane: RouteSegment;
         absolute: string;
+        fragments: PluridRouteFragments;
+        parameters: Record<string, string>;
+        query: Record<string, string>;
     };
-    component: PluridComponent;
+    component: C;
 }

package/distribution/interfaces/external/pubsub/index.d.ts

@@ -1,11 +1,11 @@
-import { PluridPubSubTopic } from "../../../constants/pubsub/index";
-import { PluridPubSubPublishMessage, PluridPubSubSubscribeMessage } from "./message";
-export * from "./message";
+import { PluridPubSubTopicKeysType } from "../../../constants/pubsub";
+import { PluridPubSubPublishMessage, PluridPubSubSubscribeMessage } from './message';
+export * from './message';
 export interface PluridPubSubOptions {
     debug?: boolean;
 }
 export interface PluridPubSub {
     publish(message: PluridPubSubPublishMessage): void;
     subscribe(message: PluridPubSubSubscribeMessage): number;
-    unsubscribe(index: number, topic: PluridPubSubTopic): boolean;
+    unsubscribe(index: number, topic: PluridPubSubTopicKeysType): boolean;
 }

package/distribution/interfaces/external/pubsub/message.d.ts

@@ -1,4 +1,5 @@
-import { PLURID_PUBSUB_TOPIC } from "../../../constants/pubsub/index";
+import { PLURID_PUBSUB_TOPIC } from "../../../constants/pubsub";
+import { PluridPartialConfiguration } from "../configuration";
 export declare type PluridPubSubCallback<D = any> = (data: D) => void;
 export interface PluridPubSubDataValueNumber {
     value: number;
@@ -8,11 +9,11 @@ export interface PluridPubSubDataValueString {
 }
 export interface PluridPubSubPublishMessageConfiguration {
     topic: typeof PLURID_PUBSUB_TOPIC.CONFIGURATION;
-    data: any;
+    data: PluridPartialConfiguration;
 }
 export interface PluridPubSubSubscribeMessageConfiguration {
     topic: typeof PLURID_PUBSUB_TOPIC.CONFIGURATION;
-    callback: PluridPubSubCallback<any>;
+    callback: PluridPubSubCallback<PluridPartialConfiguration>;
 }
 export interface PluridPubSubPublishMessageSpaceAnimatedTransform {
     topic: typeof PLURID_PUBSUB_TOPIC.SPACE_ANIMATED_TRANSFORM;

package/distribution/interfaces/external/registrar/index.d.ts

@@ -1,7 +1,7 @@
-import { PluridPlane, RegisteredPluridPlane } from "../plane/index";
-export interface PluridPlanesRegistrar {
-    register(planes: PluridPlane[]): void;
+import { PluridPlane, RegisteredPluridPlane } from '../plane';
+export interface PluridPlanesRegistrar<C> {
+    register(planes: PluridPlane<C>[]): void;
     identify(): string[];
-    get(route: string): RegisteredPluridPlane | undefined;
-    getAll(): Map<string, RegisteredPluridPlane>;
+    get(route: string): RegisteredPluridPlane<C> | undefined;
+    getAll(): Map<string, RegisteredPluridPlane<C>>;
 }

package/distribution/interfaces/external/router/fragment/index.d.ts

@@ -0,0 +1,18 @@
+export interface PluridRouteFragments {
+    texts: PluridRouteFragmentText[];
+    elements: PluridRouteFragmentElement[];
+}
+export interface PluridRouteFragment {
+    type: string;
+}
+export interface PluridRouteFragmentText extends PluridRouteFragment {
+    type: 'text';
+    start: string;
+    end: string;
+    occurence: number;
+}
+export interface PluridRouteFragmentElement extends PluridRouteFragment {
+    type: 'element';
+    id: string;
+    occurence: number;
+}