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

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

@@ -1,217 +0,0 @@
-import { Theme, ThemeName } from '@plurid/plurid-themes';
-import { SIZES, TRANSFORM_MODES, TRANSFORM_TOUCHES, TOOLBAR_DRAWERS } from "../../../enumerations/index";
-import { RecursivePartial } from "../../helpers";
-import { PluridLayout } from '../layout';
-import { InternationalizationLanguageType } from '../internationalization';
-export declare type PluridPartialConfiguration = RecursivePartial<PluridConfiguration>;
-export interface PluridConfiguration {
-    global: PluridConfigurationGlobal;
-    elements: PluridConfigurationElements;
-    space: PluridConfigurationSpace;
-    network: PluridConfigurationNetwork;
-    development: PluridConfigurationDevelopment;
-}
-export interface PluridConfigurationGlobal {
-    /**
-     * Renders the application without any elements
-     * (toolbar, viewcube, plane controls, switch, etc.).
-     */
-    micro: boolean;
-    /**
-     * 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: ThemeName | PluridConfigurationTheme;
-    /**
-     * Supported languages:
-     *
-     * + `chinese`
-     * + `english`
-     * + `french`
-     * + `german`
-     * + `hindi`
-     * + `italian`
-     * + `japanese`
-     * + `romanian`
-     * + `russian`
-     * + `spanish`
-     *
-     */
-    language: InternationalizationLanguageType;
-    /**
-     * Render the elements transparent.
-     *
-     * Default: `false`.
-     */
-    transparentUI: boolean;
-    /**
-     * Render the view as a `plurid` space, or as a `legacy` web page.
-     *
-     * When setting to `legacy`, the `switch` configuration element (`elements.switch.show`)
-     * should also be set to `true`, allowing the user to switch from rendering types
-     * through the interface.
-     *
-     * Default: `plurid`.
-     */
-    render: 'plurid' | 'legacy';
-}
-export interface PluridConfigurationTheme {
-    general: ThemeName | Theme;
-    interaction: ThemeName | Theme;
-}
-export interface PluridConfigurationSpace {
-    layout: PluridLayout;
-    /**
-     * Perspective value. Recommended between 1300 and 2000.
-     *
-     * Default `2000`.
-     */
-    perspective: number;
-    /**
-     * Make the background of the `Plurid Space` opaque.
-     *
-     * Default `true`.
-     */
-    opaque: boolean;
-    /**
-     * ID of the `Plurid Root` on which to point the camera at.
-     */
-    camera?: string;
-    /**
-     * Centers the camera on the first `Plurid Root Page`,
-     * or, if camera is set, on the Root indicated by the camera.
-     */
-    center: boolean;
-    transformOrigin: PluridConfigurationSpaceTransformOrigin;
-    transformLocks: PluridConfigurationSpaceTransformLocks;
-    /**
-     * Allow only one type of transformation, or all of them.
-     */
-    transformMode: keyof typeof TRANSFORM_MODES;
-    /**
-     * Allow multiple types of transformations.
-     */
-    transformMultimode: boolean;
-    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;
-    size: keyof typeof SIZES;
-}
-export interface PluridConfigurationSpaceTransformLocks {
-    rotationX: boolean;
-    rotationY: boolean;
-    translationY: boolean;
-    translationX: boolean;
-    translationZ: boolean;
-    scale: boolean;
-}
-export interface PluridConfigurationElements {
-    toolbar: PluridConfigurationElementsToolbar;
-    viewcube: PluridConfigurationElementsViewcube;
-    plane: PluridConfigurationElementsPlane;
-    link: PluridConfigurationElementsLink;
-    switch: PluridConfigurationElementsSwitch;
-}
-export interface PluridConfigurationElementsToolbar {
-    show: boolean;
-    opaque: boolean;
-    conceal: boolean;
-    transformIcons: boolean;
-    transformButtons: boolean;
-    drawers: (keyof typeof TOOLBAR_DRAWERS)[];
-    toggledDrawers: (keyof typeof TOOLBAR_DRAWERS)[];
-}
-export interface PluridConfigurationElementsViewcube {
-    show: boolean;
-    opaque: boolean;
-    conceal: boolean;
-    /**
-     * Show the rotation arrow buttons, and the other buttons for translation, scale, and fit view.
-     */
-    buttons: boolean;
-}
-export interface PluridConfigurationElementsPlane {
-    /**
-     * Value between `0.00` and `x.00` (floating numbers) or between `0` and `x00` (integers).
-     *
-     * The value is based on the current width of the screen and cannot be negative.
-     *
-     * `1` and `1.00` are based on screen width.
-     */
-    width: number;
-    /**
-     * Value between `0.00` and `1.00` (floating numbers).
-     *
-     * Default `1.00`.
-     */
-    opacity: number;
-    controls: PluridConfigurationElementsPlaneControls;
-}
-export interface PluridConfigurationElementsPlaneControls {
-    show: boolean;
-    /**
-     * Show plane title.
-     */
-    title: boolean;
-    pathbar: PluridConfigurationElementsPlaneControlsPathbar;
-}
-export interface PluridConfigurationElementsPlaneControlsPathbar {
-    /**
-     * If true, renders the page path in the controls as a domain URL.
-     */
-    domainURL: boolean;
-    /**
-     * Executed when the pathbar from the controls has an `change` event.
-     */
-    onChange?: (event: any, pageID: string) => void;
-    /**
-     * Executed when the pathbar from the controls has an `keyDown` event.
-     */
-    onKeyDown?: (event: any, pageID: string) => void;
-}
-export interface PluridConfigurationElementsLink {
-    suffix: string;
-    preview: {
-        show: boolean;
-        fadeIn: number;
-        fadeOut: number;
-        offsetX: number;
-        offsetY: number;
-    };
-}
-export interface PluridConfigurationElementsSwitch {
-    /**
-     * Default: `false`.
-     */
-    show: boolean;
-}
-export interface PluridConfigurationNetwork {
-    /**
-     * Default `'https'`.
-     */
-    protocol: 'http' | 'https';
-    /**
-     * Defaults to the host serving the application (`window.location.host`)
-     * for the browser environment, and to `'originhost'` for server environments.
-     */
-    host: string;
-}
-export interface PluridConfigurationDevelopment {
-    /**
-     * Show debugging information for each plane.
-     */
-    planeDebugger: boolean;
-    /**
-     * Show debugging information for the space.
-     */
-    spaceDebugger: boolean;
-}

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

@@ -1,11 +0,0 @@
-import { PluridPubSub } from '../pubsub';
-export interface PluridApplicationConfiguratorProperties {
-    /**
-     * Publish/Subscribe bus based on `@plurid/plurid-pubsub`.
-     */
-    pubsub?: PluridPubSub;
-}
-export interface PluridPlaneConfiguratorProperties<S> {
-    theme: string;
-    style: S;
-}

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

@@ -1,17 +0,0 @@
-export * from './application';
-export * from './compare';
-export * from './component';
-export * from './configuration';
-export * from './internationalization';
-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/internationalization/index.d.ts

@@ -1,15 +0,0 @@
-import internationalizationFields from "../../../constants/internationalization/fields";
-export declare type InternationalizationChinese = 'chinese';
-export declare type InternationalizationEnglish = 'english';
-export declare type InternationalizationFrench = 'french';
-export declare type InternationalizationGerman = 'german';
-export declare type InternationalizationHindi = 'hindi';
-export declare type InternationalizationItalian = 'italian';
-export declare type InternationalizationJapanese = 'japanese';
-export declare type InternationalizationRomanian = 'romanian';
-export declare type InternationalizationRussian = 'russian';
-export declare type InternationalizationSpanish = 'spanish';
-export declare type InternationalizationLanguageType = InternationalizationChinese | InternationalizationEnglish | InternationalizationFrench | InternationalizationGerman | InternationalizationHindi | InternationalizationItalian | InternationalizationJapanese | InternationalizationRomanian | InternationalizationRussian | InternationalizationSpanish;
-export declare type InternationalizationFields = typeof internationalizationFields;
-export declare type InternationalizationFieldType = keyof InternationalizationFields;
-export declare type Internationalization = Record<InternationalizationFieldType, string>;

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

@@ -1 +0,0 @@
-export declare type KeyModifiers = 'SHIFT' | 'ALT' | 'CTRL' | 'META' | 'CTRLMETA';

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

@@ -1,159 +0,0 @@
-import { LAYOUT_TYPES } from "../../../enumerations/index";
-export interface Layout {
-    type: keyof typeof LAYOUT_TYPES;
-}
-export interface LayoutMeta extends Layout {
-    type: LAYOUT_TYPES.META;
-    layouts: LayoutMetaLayout[];
-}
-export interface LayoutMetaLayout {
-    size?: number;
-    pages?: string[];
-    layout: LayoutColumns | LayoutRows | LayoutFaceToFace | LayoutZigZag | LayoutSheaves;
-}
-export interface LayoutColumns extends Layout {
-    /**
-     * Layout Top View
-     *
-     * ‾1‾ ‾4‾
-     * ‾2‾ ‾5‾
-     * ‾3‾
-     *
-     */
-    type: LAYOUT_TYPES.COLUMNS;
-    /**
-     * Integer value indicating the number of columns.
-     *
-     * If the number of pages is greater than the number of columns,
-     * the pages will overflow onto the next row.
-     */
-    columns?: number;
-    /**
-     * Number of planes per column.
-     */
-    columnLength?: number;
-    /**
-     * Distance between columns.
-     *
-     * Value between `0.00` and `x.00` (floating numbers) indicating percent of view width
-     * or between `0` and `x0...0` (integers) indicating pixel values.
-     *
-     * For example:
-     * `0.5` is 50% of view width,
-     * `5` is five pixels,
-     * `1.00` is 100% of view width,
-     * `1` is one pixels,
-     * `1.35` is 135% of view width,
-     * `135` is 135 pixels.
-     */
-    gap?: number;
-}
-export interface LayoutRows extends Layout {
-    /**
-     * Layout Top View
-     *
-     * ‾1‾ ‾2‾
-     * ‾3‾ ‾4‾
-     * ‾5‾
-     *
-     */
-    type: LAYOUT_TYPES.ROWS;
-    /**
-     * Integer value indicating the number of rows.
-     *
-     * If the number of pages is greater than the number of rows,
-     * the pages will overflow onto the next column.
-     */
-    rows?: number;
-    /**
-     * Number of planes per row.
-     */
-    rowLength?: number;
-    /**
-     * Distance between rows.
-     *
-     * Value between `0.00` and `x.00` (floating numbers) indicating percent of view width
-     * or between `0` and `x0...0` (integers) indicating pixel values.
-     *
-     * For example:
-     * `0.5` is 50% of view width,
-     * `5` is five pixels,
-     * `1.00` is 100% of view width,
-     * `1` is one pixels,
-     * `1.35` is 135% of view width,
-     * `135` is 135 pixels.
-     */
-    gap?: number;
-}
-export interface LayoutFaceToFace extends Layout {
-    /**
-     * Layout Top View
-     *
-     * ╱ ‾‾ ╲
-     *
-     * ╱    first plane
-     *
-     * —    (optional) middle plane(s)
-     *
-     * ╲    last plane
-     */
-    type: LAYOUT_TYPES.FACE_TO_FACE;
-    /**
-     * Angle between the first plane and the last plane of a row.
-     *
-     * Value between `0.00` and `360.00`. Recommended between `0` and `180`.
-     *
-     * Default is `90`.
-     */
-    angle?: number;
-    /**
-     * Distance between columns.
-     *
-     * Value between `0.00` and `x.00` (floating numbers) indicating percent of view width
-     * or between `0` and `x0...0` (integers) indicating pixel values.
-     *
-     * For example:
-     * `0.5` is 50% of view width,
-     * `5` is five pixels,
-     * `1.00` is 100% of view width,
-     * `1` is one pixels,
-     * `1.35` is 135% of view width,
-     * `135` is 135 pixels.
-     */
-    gap?: number;
-    /**
-     * Integer value indicating the number of planes (columns) to be inserted in the middle.
-     *
-     * Default is `0`.
-     */
-    middle?: number;
-}
-export interface LayoutZigZag extends Layout {
-    type: LAYOUT_TYPES.ZIG_ZAG;
-    /**
-     * Value between `0.00` and `360.00` and can be negative.
-     */
-    angle?: number;
-}
-export interface LayoutSheaves extends Layout {
-    type: LAYOUT_TYPES.SHEAVES;
-    /**
-     * Value between `0.00` and `x.00` (floating numbers) or between `0` and `x00` (integers).
-     *
-     * The value is based on the current width of the screen and can be negative.
-     */
-    depth?: number;
-    /**
-     * Value between `0.00` and `x.00` (floating numbers) or between `0` and `x00` (integers).
-     *
-     * The value is based on the current width of the screen and can be negative.
-     */
-    offsetX?: number;
-    /**
-     * Value between `0.00` and `x.00` (floating numbers) or between `0` and `x00` (integers).
-     *
-     * The value is based on the current height of the screen and can be negative.
-     */
-    offsetY?: number;
-}
-export declare type PluridLayout = LayoutColumns | LayoutRows | LayoutZigZag | LayoutFaceToFace | LayoutSheaves | LayoutMeta;

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

@@ -1,131 +0,0 @@
-export interface PluridLink<C, S, M> {
-    /**
-     * The route of the plane.
-     *
-     * If IDs are provided to the planes, the id of the plane.
-     *
-     * The route path can:
-     *
-     * * be a simple string,
-     * e.g. `'/route/to/plane'` or `'/d71b21673037485a'`,
-     * where `d71b21673037485a` is a generated plane ID;
-     *
-     * * be a parametric route,
-     * e.g. `'/route/to/:plane'`, where `:plane` is the parameter value
-     * for the parameter defined in the `PluridPage[]`;
-     *
-     * * receive query `key=value` pairs,
-     * e.g. `'/route/to/plane?id=1&show=true'`, where `id=1` and `show=true` are `key=value` pairs
-     *
-     * * specify a text fragment,
-     * e.g. `'/route/to/plane#:~:text=A%20door,is%20opened.,[0]'`,
-     * where the fragment `#:~:text=A%20door,is%20opened.,[0]`
-     * is loosely based on the https://github.com/WICG/ScrollToTextFragment specification,
-     * and indicates the link to bring into view the first occurence `[0]`, if any,
-     * of the text fragment starting with `A door` and ending with `is opened.`.
-     *
-     * * specify a page element,
-     * e.g. `'/route/to/plane#:~:element=123,[1]'`,
-     * where the fragment `#:~:element=123,[1]`
-     * indicates the link to bring into view the second occurence `[1]`, if any,
-     * of the element with the attribute `data-plurid-element=123`.
-     *
-     *
-     * ### Larger Syntax Structure
-     *
-     * The syntax `/plane` is used to reference only the plurid planes within the same plurid space.
-     *
-     * In order to reference
-     *
-     * + planes within other clusters,
-     * + planes within other universes,
-     * + planes within other spaces of the same route,
-     * + planes within other spaces of a different route,
-     * + planes within other spaces of a different, controlled origin,
-     * + planes within other spaces of a different, foreign origins,
-     *
-     * the syntax `://` has to be used.
-     *
-     *
-     * A plurid link in the same space, same universe, same cluster.
-     *
-     * `://plane`
-     *
-     * example: `://dashboard`
-     *
-     *
-     * A plurid link to another cluster in the same universe, in the same space.
-     *
-     * `://cluster://plane`
-     *
-     * example: `://two://dashboard`
-     *
-     *
-     * A plurid link to another universe in the same space.
-     *
-     * `://universe://cluster://page`
-     *
-     * example: `://one://two://dashboard`
-     *
-     *
-     * A plurid link to a different space within the same route
-     *
-     * `://space://universe://cluster://plane`
-     *
-     * example: `://user123://dashboard`
-     *
-     *
-     * A plurid link to a different space within an another route.
-     *
-     * `://route://space://universe://cluster://plane`
-     *
-     * example: `://payment://user123://dashboard`
-     *
-     *
-     * A plurid link to a different space within a controlled origin.
-     *
-     * `https://controlled-origin://route://space://universe://cluster://plane`
-     *
-     * example: `https://example-c.com://payment://user123://dashboard`
-     *
-     *
-     * A plurid link to a different space within a foreign origin.
-     *
-     * `https://foreign-origin://route://space://universe://cluster://plane`
-     *
-     * example: `https://example-f.com://payment://user123://dashboard`
-     *
-     *
-     * To handle clusters of clusters use the `|>` syntax, which shows a nesting of clusters,
-     * e.g. `://clusterC|>clusterB|>clusterA`,
-     * denotes that Cluster C includes Cluster B which includes Cluster A.
-     *
-     */
-    route: string;
-    /**
-     * Format the link as a simple anchor element. Default `false`.
-     */
-    devisible?: boolean;
-    /**
-     * String character to be added inline after the PluridLink content. The default is `'`.
-     *
-     * If `devisible` the suffix is disabled.
-     */
-    suffix?: string;
-    /**
-     * Execute function at click (onClick Event).
-     */
-    atClick?: (event?: MouseEvent | M) => void;
-    /**
-     * Show or not the default Not Found component, or pass a custom component
-     */
-    notFound?: boolean | C;
-    preview?: boolean;
-    previewFadeIn?: number;
-    previewFadeOut?: number;
-    previewOffsetX?: number;
-    previewOffsetY?: number;
-    previewComponent?: C;
-    style?: S;
-    className?: string;
-}

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

@@ -1,5 +0,0 @@
-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,69 +0,0 @@
-import { PluridRouteParameter, PluridRouteFragments } from '../router';
-export interface PluridPlaneOptions {
-    /**
-     * Constraints for the parameters.
-     */
-    parameters?: Record<string, PluridRouteParameter>;
-}
-export interface PluridPlaneObject<C> extends PluridPlaneOptions {
-    /**
-     * Route to the plane, e.g. `/plane-1`. By convention, it starts with an '/'.
-     *
-     * The `route` can be
-     * + unassigned,
-     * + assigned,
-     * + absolute.
-     *
-     * The unassigned route respects the format
-     * `/plane` and will be automatically assigned
-     * to the `default` space, `default` universe, `default` cluster.
-     *
-     * The assigned path respects the format
-     * `/path://space://universe://cluster://plane`
-     * and it presupposes the given `protocol` and `host`.
-     *
-     * The absolute path respects the format
-     * `protocol://host://path://space://universe://cluster://plane`
-     * and is useful for cross-origins requests.
-     *
-     * The route can have parameters, e.g. `/plane/:id`.
-     *
-     * The parameter, in the example `id`,
-     * will be passed in the property `plurid.parameters` to the component,
-     * e.g. `componentProperties.plurid.route.plane.parameters.id`.
-     *
-     */
-    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> = any;
-export interface RouteSegment {
-    [key: string]: any;
-}
-export interface RegisteredPluridPlane<C> {
-    route: {
-        absolute: string;
-        fragments: PluridRouteFragments;
-        parameters: Record<string, string>;
-        query: Record<string, string>;
-    };
-    component: C;
-}

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

@@ -1,10 +0,0 @@
-import { PluridPubSubPublishMessage, PluridPubSubSubscribeMessage } from './message';
-export * from './message';
-export interface PluridPubSubOptions {
-    debug?: boolean;
-}
-export interface PluridPubSub {
-    publish(message: PluridPubSubPublishMessage): void;
-    subscribe(message: PluridPubSubSubscribeMessage): string;
-    unsubscribe(selector: string): boolean;
-}