@plurid/plurid-data 0.0.0-20 → 0.0.0-21

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

@@ -1,171 +0,0 @@
-import { PluridPartialConfiguration } from "../../configuration";
-import { CompareType } from "../../compare";
-import { PluridRouteMultispace } from '../multispace';
-export declare type PluridRouteResolver<C> = Omit<PluridRoute<C>, 'value' | 'resolver'>;
-/**
- * A route can be `plurid space` or `exterior`-based.
- */
-export interface PluridRoute<C, G = any> {
-    /**
-     * The route `value` can:
-     * + be a simple string, e.g. `'/route/to/page'`;
-     * + be a parametric location, e.g. `'/route/to/:page'`, where `:page` is the parameter name;
-     * + receive query `key=value` pairs,
-     * e.g. `'/route/to/page?id=1&show=true'`, where `id=1` and `show=true` are `key=value` pairs;
-     */
-    value: string;
-    parameters?: Record<string, PluridRouteParameter>;
-    /**
-     * Accepts a component which will be rendered outside of the `spaces`.
-     */
-    exterior?: C;
-    /**
-     * A route can have planes and/or spaces.
-     */
-    planes?: PluridRoutePlane<C>[];
-    view?: string[];
-    /**
-     * A route can have planes and/or spaces.
-     */
-    spaces?: PluridRouteSpace<C>[];
-    /**
-     * Pass the rendered `spaces[]` components as a property to the `exterior` component
-     * to be rendered in particular slots.
-     */
-    slotted?: boolean;
-    multispace?: PluridRouteMultispace<C>;
-    defaultConfiguration?: PluridPartialConfiguration;
-    /**
-     * Resolve the route at request time.
-     *
-     * Receives the `globals` from the preserve, if any.
-     */
-    resolver?: (globals: G | undefined) => PluridRouteResolver<C> | Promise<PluridRouteResolver<C>>;
-}
-export interface PluridRouteParameter {
-    /**
-     * Constrain the route parameter to be of a certain length.
-     */
-    length?: number;
-    /**
-     * Ensure that the `length` of the route parameter is of a certain type:
-     *
-     * * `'=='`     - equal,
-     * * `'<='`     - equal or less than,
-     * * `'<'`      - less than,
-     * * `'>='`     - equal or greater than,
-     * * `'>'`      - greater than.
-     *
-     * Default `'<='`, if a `length` is provided.
-     */
-    lengthType?: CompareType;
-    startsWith?: string;
-    endsWith?: string;
-    includes?: string[];
-}
-export interface PluridRouteSpace<C> {
-    value: string;
-    /**
-     * Accepts a component which will be rendered outside of the `space`.
-     */
-    exterior?: C;
-    /**
-     * A space can have planes and/or universes.
-     */
-    planes?: PluridRoutePlane<C>[];
-    view?: string[];
-    /**
-     * A space can have planes and/or universes.
-     */
-    universes?: PluridRouteUniverse<C>[];
-    configuration?: PluridPartialConfiguration;
-}
-export interface PluridRouteUniverse<C> {
-    value: string;
-    planes?: PluridRoutePlane<C>[];
-    view?: string[];
-    /**
-     * By default, the order the documents are shown in is based on their index in the `documents[]`.
-     * The ordinal can be used to overrule the default order.
-     * If not unique, the documents with equal `ordinal` will be ordered by index.
-     *
-     * 0-based.
-     */
-    ordinal?: number;
-    /**
-     * Set the document as active. By default the first document is active.
-     *
-     * Only one document can be active at a time.
-     */
-    active?: boolean;
-}
-export interface PluridRoutePlaneOptions {
-    /**
-     * Map a direct link for a specific plane.
-     *
-     * e.g. `/plane-one` will route in browser the path `protocol://host/plane-one`
-     *
-     * Default composed from route and plane value, `/<route.value/<plane.value>`
-     */
-    link?: string;
-    /**
-     * On direct link access (from the browser), show the plane in a `plurid` space,
-     * or as the legacy view of an web page.
-     *
-     * Default `'plurid'`
-     */
-    linkView?: 'legacy' | 'plurid';
-    /**
-     * Injectable into other `plurid` spaces.
-     *
-     * Default `true`
-     */
-    injectable?: boolean;
-    /**
-     * Direct access to the plane from the browser.
-     *
-     * Default plane link composed from route and plane value, `/<route.value/<plane.value>`;
-     * changeable through the `link` property.
-     *
-     * Default `true`
-     */
-    urlable?: boolean;
-    /**
-     * Access to the plane through the `gateway` path.
-     *
-     * Default `true`
-     */
-    gateable?: boolean;
-    /**
-     * Render route exterior when directly accessed.
-     *
-     * Default `true`
-     */
-    directExterior?: boolean;
-    /**
-     * Render route exterior when injected into other `plurid` space.
-     *
-     * Default `false`
-     */
-    injectExterior?: boolean;
-    /**
-     * Constraints for the parameters.
-     */
-    parameters?: Record<string, PluridRouteParameter>;
-}
-export interface PluridRoutePlaneObject<C> extends PluridRoutePlaneOptions {
-    value: string;
-    component: C;
-}
-export declare type PluridRoutePlaneTuple<C> = [
-    /**
-     * See `PluridRoutePlaneObject<C>.value`.
-     */
-    value: string,
-    /**
-     * See `PluridRoutePlaneObject<C>.component`.
-     */
-    component: C,
-    options?: PluridRoutePlaneOptions
-];
-export declare type PluridRoutePlane<C> = PluridRoutePlaneObject<C> | PluridRoutePlaneTuple<C>;

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

@@ -1,58 +0,0 @@
-import { PluridRoute, PluridRoutePlane, PluridRoutePlaneObject, PluridRouteFragments } from '../router';
-import { PluridPlane, PluridPlaneObject } from '../plane';
-export interface IsoMatcherData<C> {
-    routes?: PluridRoute<C>[];
-    routePlanes?: PluridRoutePlane<C>[];
-    planes?: PluridPlane<C>[];
-}
-export declare type IsoMatcherContext = 'route' | 'plane';
-export interface IsoMatcherResultBase {
-    value: string;
-    parameters: Record<string, string>;
-    query: Record<string, string>;
-}
-export interface IsoMatcherRouteResultBase {
-    match: IsoMatcherResultBase;
-}
-export interface IsoMatcherRouteResultRoute<C> extends IsoMatcherRouteResultBase {
-    kind: 'Route';
-    data: PluridRoute<C>;
-}
-export interface IsoMatcherRouteResultRoutePlane<C> extends IsoMatcherRouteResultBase {
-    kind: 'RoutePlane';
-    data: PluridRoutePlaneObject<C>;
-}
-export declare type IsoMatcherRouteResult<C> = IsoMatcherRouteResultRoute<C> | IsoMatcherRouteResultRoutePlane<C>;
-export interface IsoMatcherIndexedRoute<C> {
-    data: PluridRoute<C>;
-}
-export declare type IsoMatcherPlaneType = 'Plane' | 'RoutePlane';
-export interface IsoMatcherPlaneResultMatch extends IsoMatcherResultBase {
-    fragments: PluridRouteFragments;
-}
-export interface IsoMatcherPlaneResultBase<C> {
-    parent?: string;
-    match: IsoMatcherPlaneResultMatch;
-}
-export interface IsoMatcherPlaneResultPlane<C> extends IsoMatcherPlaneResultBase<C> {
-    kind: 'Plane';
-    data: PluridPlaneObject<C>;
-}
-export interface IsoMatcherPlaneResultRoutePlane<C> extends IsoMatcherPlaneResultBase<C> {
-    kind: 'RoutePlane';
-    data: PluridRoutePlaneObject<C>;
-}
-export declare type IsoMatcherPlaneResult<C> = IsoMatcherPlaneResultPlane<C> | IsoMatcherPlaneResultRoutePlane<C>;
-export declare type IsoMatcherResult<C> = IsoMatcherRouteResult<C> | IsoMatcherPlaneResult<C>;
-export interface IsoMatcherIndexedPlaneBase<C> {
-    parent?: string;
-}
-export interface IsoMatcherIndexedPlanePlane<C> extends IsoMatcherIndexedPlaneBase<C> {
-    kind: 'Plane';
-    data: PluridPlaneObject<C>;
-}
-export interface IsoMatcherIndexedPlaneRoutePlane<C> extends IsoMatcherIndexedPlaneBase<C> {
-    kind: 'RoutePlane';
-    data: PluridRoutePlaneObject<C>;
-}
-export declare type IsoMatcherIndexedPlane<C> = IsoMatcherIndexedPlanePlane<C> | IsoMatcherIndexedPlaneRoutePlane<C>;

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

@@ -1,20 +0,0 @@
-import { PluridPlane } from '../plane';
-export interface PluridUniverse<C> {
-    value: string;
-    planes?: PluridPlane<C>[];
-    view?: string[];
-    /**
-     * By default, the order the documents are shown in is based on their index in the `documents[]`.
-     * The ordinal can be used to overrule the default order.
-     * If not unique, the documents with equal `ordinal` will be ordered by index.
-     *
-     * 0-based.
-     */
-    ordinal?: number;
-    /**
-     * Set the document as active. By default the first document is active.
-     *
-     * Only one document can be active at a time.
-     */
-    active?: boolean;
-}

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

@@ -1,18 +0,0 @@
-export interface PluridView {
-    /**
-     * Route to a `PluridPlane`.
-     *
-     * The route can be URL-like, e.g. `'/plane/one?query=true'`,
-     * for a plane in the same space, or fully defined,
-     * e.g. `'protocol://host://path://space://universe://cluster://plane`.
-     */
-    plane: string;
-    /**
-     * By default, the order the planes are shown in is based on their index in the `view[]`.
-     * The ordinal can be used to overrule the default order.
-     * If not unique, the planes with equal `ordinal` will be ordered by index.
-     *
-     * 0-based.
-     */
-    ordinal?: number;
-}

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

@@ -1,4 +0,0 @@
-import { PluridPlanesRegistrar } from '../registrar';
-export declare type PluridalWindow<C> = typeof window & {
-    __pluridPlanesRegistrar__: PluridPlanesRegistrar<C>;
-};

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

@@ -1,10 +0,0 @@
-export interface Indexed<T> {
-    [key: string]: T;
-}
-export interface WithID {
-    id: string;
-}
-export declare type Identified<T> = T & WithID;
-export declare type RecursivePartial<T> = {
-    [P in keyof T]?: RecursivePartial<T[P]>;
-};

package/distribution/interfaces/index.d.ts

@@ -1,3 +0,0 @@
-export * from './external';
-export * from './internal';
-export * from './helpers';

package/distribution/interfaces/internal/context/index.d.ts

@@ -1,16 +0,0 @@
-import { PluridPlaneContext } from "../../external/plane";
-import { PluridPlanesRegistrar } from "../../external/registrar";
-import { IsoMatcherRouteResult } from "../../external/routing";
-import { PluridPubSub } from "../../external/pubsub";
-export interface PluridContext<C> {
-    planesRegistrar?: PluridPlanesRegistrar<C>;
-    planeContext?: PluridPlaneContext<any>;
-    planeContextValue?: any;
-    customPlane?: C;
-    planeNotFound?: boolean | C;
-    planeRenderError?: boolean | C;
-    matchedRoute?: IsoMatcherRouteResult<C> | undefined;
-    hostname?: string;
-    defaultPubSub: PluridPubSub;
-    registerPubSub: (pubsub: PluridPubSub) => void;
-}

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

@@ -1,5 +0,0 @@
-export * from './context';
-export * from './shortcuts';
-export * from './state';
-export * from './transform';
-export * from './tree';

package/distribution/interfaces/internal/shortcuts/index.d.ts

@@ -1,10 +0,0 @@
-import { SHORTCUTS } from "../../../enumerations/index";
-import { InternationalizationFieldType } from "../../external/internationalization";
-export interface ShortcutName {
-    name: InternationalizationFieldType;
-    internationalizedKey?: boolean;
-    key: string;
-    modifier?: string | string[];
-}
-export declare type ShortcutNamesTypes = keyof typeof SHORTCUTS;
-export declare type ShortcutNames = Record<ShortcutNamesTypes, ShortcutName>;

package/distribution/interfaces/internal/state/index.d.ts

@@ -1,45 +0,0 @@
-import { Theme } from '@plurid/plurid-themes';
-import { PluridApplicationView } from '../../external/application';
-import { PluridConfiguration } from '../../external/configuration';
-import { TreePlane } from '../tree';
-import { Coordinates, ViewSize, SpaceSize } from '../utilities';
-export interface PluridState {
-    configuration: PluridConfiguration;
-    shortcuts: PluridStateShortcuts;
-    space: PluridStateSpace;
-    themes: PluridStateThemes;
-    ui: PluridStateUI;
-}
-export interface PluridStateShortcuts {
-    global: boolean;
-}
-export interface PluridStateSpace {
-    loading: boolean;
-    resolvedLayout: boolean;
-    animatedTransform: boolean;
-    transformTime: number;
-    scale: number;
-    rotationX: number;
-    rotationY: number;
-    translationX: number;
-    translationY: number;
-    translationZ: number;
-    transform: string;
-    tree: TreePlane[];
-    activeUniverseID: string;
-    camera: Coordinates;
-    viewSize: ViewSize;
-    spaceSize: SpaceSize;
-    view: PluridApplicationView;
-    culledView: PluridApplicationView;
-    activePlaneID: string;
-    isolatePlane: string;
-    lastClosedPlane: string;
-}
-export interface PluridStateThemes {
-    general: Theme;
-    interaction: Theme;
-}
-export interface PluridStateUI {
-    toolbarScrollPosition: number;
-}

package/distribution/interfaces/internal/transform/index.d.ts

@@ -1,9 +0,0 @@
-export interface WheelDeltas {
-    deltaX: number;
-    deltaY: number;
-}
-export interface TransformModes {
-    rotation: boolean;
-    translation: boolean;
-    scale: boolean;
-}

package/distribution/interfaces/internal/tree/index.d.ts

@@ -1,106 +0,0 @@
-import { PluridRouteFragments } from '../../external/router';
-export interface TreePlane {
-    /**
-     * The application defined plane ID that is the source
-     */
-    sourceID: string;
-    planeID: string;
-    parentPlaneID?: string;
-    /**
-     * The full route string, adequately formatted
-     * <protocol>://<host>://<path>://<space>://universe://cluster://<plane>
-     */
-    route: string;
-    routeDivisions: RouteDivisions;
-    linkCoordinates?: LinkCoordinates;
-    height: number;
-    width: number;
-    location: TreePlaneLocation;
-    show: boolean;
-    children?: TreePlane[];
-    bridgeLength?: number;
-    planeAngle?: number;
-}
-export interface RouteDivisions {
-    protocol: RouteHostProtocol;
-    host: RouteHostDivision;
-    path: RoutePathDivision;
-    space: RouteSpaceDivision;
-    universe: RouteUniverseDivision;
-    cluster: RouteClusterDivision;
-    plane: RoutePlaneDivision;
-    valid: boolean;
-}
-export interface RouteDivision {
-    value: string;
-    parameters: Record<string, string>;
-    query: Record<string, string>;
-}
-export interface RouteHostProtocol {
-    value: string;
-    secure: boolean;
-}
-export interface RouteHostDivision {
-    value: string;
-    controlled: boolean;
-}
-export interface RoutePathDivision {
-    value: string;
-    parameters: Record<string, string>;
-    query: Record<string, string>;
-}
-export interface RouteSpaceDivision {
-    value: string;
-    parameters: Record<string, string>;
-    query: Record<string, string>;
-}
-export interface RouteUniverseDivision {
-    value: string;
-    parameters: Record<string, string>;
-    query: Record<string, string>;
-}
-export interface RouteClusterDivision {
-    value: string;
-    parameters: Record<string, string>;
-    query: Record<string, string>;
-}
-export interface RoutePlaneDivision {
-    value: string;
-    parameters: Record<string, string>;
-    query: Record<string, string>;
-    fragments: PluridRouteFragments;
-}
-export interface PathParameters {
-    [key: string]: string;
-}
-export interface PathQuery {
-    [key: string]: string;
-}
-export interface TreePlaneLocation {
-    translateX: number;
-    translateY: number;
-    translateZ: number;
-    rotateX: number;
-    rotateY: number;
-}
-export interface SpaceLocation {
-    translationX: number;
-    translationY: number;
-    translationZ: number;
-    rotationX: number;
-    rotationY: number;
-    scale: number;
-}
-export interface LocationCoordinates {
-    x: number;
-    y: number;
-    z: number;
-}
-export interface LinkCoordinates {
-    x: number;
-    y: number;
-}
-export interface TopPlanePoint {
-    x: number;
-    z: number;
-}

package/distribution/interfaces/internal/utilities/index.d.ts

@@ -1,19 +0,0 @@
-export interface Coordinates {
-    x: number;
-    y: number;
-    z: number;
-}
-export interface ViewSize {
-    width: number;
-    height: number;
-}
-export interface SpaceSize {
-    width: number;
-    height: number;
-    depth: number;
-    topCorner: {
-        x: number;
-        y: number;
-        z: number;
-    };
-}