@metadev/daga 5.1.1 → 5.1.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metadev/daga",
-  "version": "5.1.1",
+  "version": "5.1.3",
   "license": "SEE LICENSE IN LICENSE.md",
   "dependencies": {},
   "peerDependencies": {

package/src/lib/diagram/canvas/diagram-canvas-util.d.ts

@@ -10,12 +10,18 @@ import { DiagramPort } from '../model/diagram-port';
 import { DiagramSection } from '../model/diagram-section';
 import { DiagramCanvas } from './diagram-canvas';
 /**
- * Checks if the given mouse event was produced with a secondary button press.
+ * Checks if the given pointer event was produced with a secondary button press.
  * @private
- * @param event A mouse event.
- * @returns `true` if the given mouse event was produced with a secondary button press, `false` otherwise.
+ * @param event A pointer event.
+ * @returns `true` if the given pointer event was produced with a secondary button press, `false` otherwise.
  */
 export declare const isSecondaryButton: (event: MouseEvent) => boolean;
+/**
+ * Obtain the pointer event which is valid for passing to the `d3.pointer()` function.
+ * @param event A pointer event.
+ * @returns A pointer event which can be passed to the `d3.pointer()` function.
+ */
+export declare const getEventHoldingCoordinates: (event: MouseEvent | d3.D3DragEvent<Element, unknown, unknown>) => unknown;
 /**
  * Get the SVG path of a diagram connection.
  * @private

package/src/lib/diagram/canvas/diagram-canvas.d.ts

@@ -11,6 +11,7 @@ import { ActionStack, DiagramAction, DiagramActionMethod, DiagramActions } from
 import { DiagramEvent } from '../diagram-event';
 import { DiagramConnectionType } from '../model/diagram-connection';
 import { DiagramModel } from '../model/diagram-model';
+import { DiagramNode } from '../model/diagram-node';
 import { DiagramContextMenu } from './diagram-context-menu';
 import { DiagramUserHighlight } from './diagram-user-highlight';
 import { DiagramUserSelection } from './diagram-user-selection';
@@ -26,9 +27,8 @@ export declare const CONNECTION_PATH_BOX_THICKNESS = 12;
  */
 export declare const ACTION_STACK_SIZE = 25;
 export declare class DiagramCanvas implements Canvas {
-    private static canvasCount;
+    #private;
     readonly parentComponent: DiagramEditor;
-    private diagramRoot;
     readonly model: DiagramModel;
     readonly userSelection: DiagramUserSelection;
     readonly userHighlight: DiagramUserHighlight;
@@ -41,7 +41,6 @@ export declare class DiagramCanvas implements Canvas {
     zoomFactor: number;
     panRate: number;
     inferConnectionType: boolean;
-    private _connectionType?;
     get connectionType(): DiagramConnectionType | undefined;
     set connectionType(value: DiagramConnectionType | undefined);
     autoTightenConnections: boolean;
@@ -56,24 +55,6 @@ export declare class DiagramCanvas implements Canvas {
     userActions: {
         [key in DiagramActions]?: boolean;
     };
-    private readonly gridPatternId;
-    private readonly ancillaryGridPatternIds;
-    private zoomBehavior;
-    private zoomTransform;
-    private priorityThreshold?;
-    private priorityThresholds;
-    private unfinishedConnection?;
-    /**
-     * Invisible path followed by an unfinished connection. Used for making unfinished connections stop before the cursor rather than stopping right at the cursor.
-     */
-    private unfinishedConnectionTracer?;
-    private unfinishedConnectionPort?;
-    private inputFieldContainer?;
-    private multipleSelectionContainer?;
-    private draggingFrom;
-    private dragging;
-    private secondaryButton;
-    private currentAction?;
     readonly validatorChange$: Subject<void>;
     readonly diagramChange$: Subject<{
         action: DiagramAction;
@@ -104,11 +85,10 @@ export declare class DiagramCanvas implements Canvas {
     center(nodeIds?: string[], maxZoomLevel?: number, duration?: number): void;
     getClosestGridPoint(point: Point): Point;
     getCoordinatesOnScreen(): [Point, Point];
-    private getEventHoldingCoordinates;
-    getPointerLocationRelativeToCanvas(event: MouseEvent): Point;
-    getPointerLocationRelativeToRoot(event: MouseEvent): Point;
-    getPointerLocationRelativeToBody(event: MouseEvent): Point;
-    getPointerLocationRelativeToScreen(event: MouseEvent): Point;
+    getPointerLocationRelativeToCanvas(event: MouseEvent | d3.D3DragEvent<Element, unknown, unknown>): Point;
+    getPointerLocationRelativeToRoot(event: MouseEvent | d3.D3DragEvent<Element, unknown, unknown>): Point;
+    getPointerLocationRelativeToBody(event: MouseEvent | d3.D3DragEvent<Element, unknown, unknown>): Point;
+    getPointerLocationRelativeToScreen(event: MouseEvent | d3.D3DragEvent<Element, unknown, unknown>): Point;
     updateModelInView(): void;
     updateNodesInView(...ids: string[]): void;
     updateSectionsInView(...ids: string[]): void;
@@ -117,8 +97,8 @@ export declare class DiagramCanvas implements Canvas {
     updateFieldsInView(...ids: string[]): void;
     updateObjectsInView(...ids: string[]): void;
     updateDecoratorsInView(...ids: string[]): void;
-    private updateConnectionLabelsInView;
-    private updateConnectionMarkersInView;
+    bringToFront(node: DiagramNode): void;
+    sendToBack(node: DiagramNode): void;
     fieldRootFitsInView(id: string): boolean;
     fitFieldRootInView(id: string, shrink?: boolean): void;
     fitNodeInView(id: string, shrink?: boolean): void;
@@ -126,30 +106,7 @@ export declare class DiagramCanvas implements Canvas {
     selectSVGElement(): d3.Selection<SVGElement, unknown, null, unknown>;
     selectCanvasView(): d3.Selection<SVGGElement, unknown, null, unknown>;
     selectCanvasElements(): d3.Selection<SVGGElement, unknown, null, unknown>;
-    private startConnection;
-    private finishConnection;
-    private dropConnection;
     cancelAllUserActions(): void;
     canUserPerformAction(action: DiagramActions): boolean;
     openTextInput(id: string): void;
-    private createInputField;
-    private removeInputField;
-    private minimumSizeOfField;
-    private setFieldTextAndWrap;
-    private setFieldText;
-    /**
-     * Method to call to start the moving of a node triggered by a user drag event.
-     */
-    private startMovingNode;
-    /**
-     * Method to call to continue the moving of a node triggered by a user drag event.
-     */
-    private continueMovingNode;
-    /**
-     * Method to call to finish the moving of a node triggered by a user drag event.
-     */
-    private finishMovingNode;
-    private startMultipleSelection;
-    private continueMultipleSelection;
-    private finishMultipleSelection;
 }

package/src/lib/diagram/canvas/diagram-context-menu.d.ts

@@ -9,9 +9,7 @@ export declare const CONTEXT_MENU_DEFAULTS: {
  * @see DiagramCanvas
  */
 export declare class DiagramContextMenu {
-    private readonly canvas;
-    private config;
-    private contextMenuContainer?;
+    #private;
     /**
      * Constructs a context menu object.
      * @public

package/src/lib/diagram/canvas/diagram-user-highlight.d.ts

@@ -6,12 +6,7 @@ import { DiagramElement, DiagramElementSet } from '../model/diagram-element';
  * @see DiagramCanvas
  */
 export declare class DiagramUserHighlight extends DiagramElementSet<DiagramElement> {
-    private readonly canvas;
-    private focus?;
-    /**
-     * Whether sections can be highlighted individually or the whole node must be highlighted when highlighting a section.
-     */
-    private highlightSections;
+    #private;
     /**
      * Constructs a user highlight object.
      * @public

package/src/lib/diagram/canvas/diagram-user-selection.d.ts

@@ -16,10 +16,7 @@ export declare const DIAGRAM_PROPERTIES_DEFAULT_TEXT = "Diagram properties";
  * @see DiagramCanvas
  */
 export declare class DiagramUserSelection extends DiagramElementSet<DiagramElement> {
-    private readonly canvas;
-    private readonly diagramPropertiesText;
-    private propertyEditorSelection?;
-    private propertyEditorValues?;
+    #private;
     /**
      * Constructs a user selection object.
      * @public
@@ -73,5 +70,4 @@ export declare class DiagramUserSelection extends DiagramElementSet<DiagramEleme
     openInPropertyEditor(selection?: {
         valueSet: ValueSet;
     } & (DiagramElement | DiagramModel), makeUpdateValuesAction?: boolean): void;
-    private makeUpdateValuesAction;
 }

package/src/lib/diagram/collab/collab-action.d.ts

@@ -307,6 +307,7 @@ export type SetSelfRemovedSerialized = {
  * @see RemoveAction
  */
 export declare class SetSelfRemovedCollabAction implements CollabAction {
+    #private;
     readonly canvas: Canvas;
     readonly nodeIds: string[];
     readonly sectionIds: string[];
@@ -316,7 +317,6 @@ export declare class SetSelfRemovedCollabAction implements CollabAction {
     readonly selfRemoved: boolean;
     readonly timestamp: CollabTimestamp;
     constructor(canvas: Canvas, nodeIds: string[], sectionIds: string[], portIds: string[], connectionIds: string[], fieldIds: string[], selfRemoved: boolean, timestamp: CollabTimestamp);
-    private doOne;
     do(): void;
     serialize(): CollabActionSerialized;
     static deserialize(canvas: Canvas, serialized: SetSelfRemovedSerialized): SetSelfRemovedCollabAction;

package/src/lib/diagram/collab/collab-client.d.ts

@@ -6,35 +6,14 @@ import { Canvas } from '../../interfaces/canvas';
  * @public
  */
 export declare class CollabClient {
+    #private;
     /**
      * The WebSocket URL of the daga-server.
      */
     readonly dagaServer: string;
     readonly userId: string;
     readonly clientId: string;
-    private readonly ws;
-    private sendQueue;
-    /**
-     * Joined sessions by locator.
-     */
-    private sessions;
-    /**
-     * Created but unacked sessions by refId.
-     */
-    private pendingSessions;
     constructor(dagaServer: string, userId: string);
-    private onOpen;
-    private onMessage;
-    private onClose;
-    private onError;
-    /**
-     * Internal send method. Use instead of calling ws.send directly.
-     */
-    private send;
-    /**
-     * Internal receive method. Use instead of handling ws receive events directly.
-     */
-    private receive;
     /**
      * Creates and joins a room. The given canvas becomes collaborative, starting
      * with its current model.
@@ -53,5 +32,4 @@ export declare class CollabClient {
      * @public
      */
     joinRoom(canvas: Canvas, locator: string): Promise<void>;
-    private startSyncing;
 }

package/src/lib/diagram/config/diagram-config.d.ts

@@ -170,6 +170,11 @@ export interface NodeTypeConfig {
      * @default 1
      */
     minHeight?: number;
+    /**
+     * The default z coordinate of nodes of this type when rendering them in order relative to other diagram elements.
+     * @default 0
+     */
+    defaultZ?: number;
     /**
      * Whether the user can resize nodes of this type horizontally.
      * @default false

package/src/lib/diagram/diagram-action.d.ts

@@ -8,11 +8,7 @@ import { DiagramNodeGeometry, DiagramNodeType } from './model/diagram-node';
  * @private
  */
 export declare class ActionStack {
-    /**
-     * Canvas that this action stack belongs to.
-     * @private
-     */
-    private readonly canvas;
+    #private;
     /**
      * Maximum number of actions that can be recorded simultaneously.
      * When new actions are added past this limit, older actions are removed.
@@ -28,7 +24,7 @@ export declare class ActionStack {
      * Index of the last action not counting undone actions. One-indexed. Zero if all actions are undone.
      * @private
      */
-    private index;
+    index: number;
     constructor(canvas: Canvas, maximum: number);
     /**
      * Adds an action to the history.

package/src/lib/diagram/model/diagram-connection.d.ts

@@ -76,7 +76,7 @@ export declare class DiagramConnectionType implements DiagramEntity {
  * @see DiagramPort
  */
 export declare class DiagramConnection extends DiagramElement {
-    private _type;
+    #private;
     get type(): DiagramConnectionType;
     set type(type: DiagramConnectionType);
     get typeString(): string;
@@ -252,12 +252,12 @@ export declare class DiagramConnection extends DiagramElement {
     getPriority(): number;
 }
 export declare class DiagramConnectionSet extends DiagramElementSet<DiagramConnection> {
-    private model;
+    #private;
     /**
      * Set of the possible types of connection that the connections of this set can have.
      * @public
      */
-    types: DiagramEntitySet<DiagramConnectionType>;
+    readonly types: DiagramEntitySet<DiagramConnectionType>;
     /**
      * Instance a set of connections for the given model. This method is used internally.
      * @private

package/src/lib/diagram/model/diagram-decorator.d.ts

@@ -58,7 +58,7 @@ export declare class DiagramDecorator extends DiagramElement {
     getPriority(): number;
 }
 export declare class DiagramDecoratorSet extends DiagramElementSet<DiagramDecorator> {
-    private model;
+    #private;
     /**
      * Instance a set of decorators for the given model. This method is used internally.
      * @private

package/src/lib/diagram/model/diagram-element.d.ts

@@ -14,12 +14,12 @@ export declare const DEFAULT_PRIORITY = 0;
  * @see DiagramCanvas
  */
 export declare abstract class DiagramElement implements DiagramEntity {
+    #private;
     /**
      * Diagram model this diagram element is part of.
      * @private
      */
     readonly model: DiagramModel;
-    private _id;
     /**
      * Identifier that uniquely identifies this element within its diagram model. Cannot be an empty string.
      * @public

package/src/lib/diagram/model/diagram-field.d.ts

@@ -39,6 +39,7 @@ export interface LabeledElement {
  * @see DiagramSection
  */
 export declare class DiagramField extends DiagramElement {
+    #private;
     /**
      * Element that this field belongs to.
      * @public
@@ -79,7 +80,6 @@ export declare class DiagramField extends DiagramElement {
      * @public
      */
     multiline: boolean;
-    private _text;
     /**
      * Default text that this field's text resets to when empty.
      * @public
@@ -133,7 +133,7 @@ export declare class DiagramField extends DiagramElement {
     getPriority(): number;
 }
 export declare class DiagramFieldSet extends DiagramElementSet<DiagramField> {
-    private model;
+    #private;
     /**
      * Instance a set of fields for the given model. This method is used internally.
      * @private

package/src/lib/diagram/model/diagram-node.d.ts

@@ -31,6 +31,7 @@ export declare const DIAGRAM_NODE_TYPE_DEFAULTS: {
     defaultHeight: number;
     minWidth: number;
     minHeight: number;
+    defaultZ: number;
     resizableX: boolean;
     resizableY: boolean;
     snapToGridOffset: [number, number, number, number];
@@ -48,6 +49,7 @@ export declare const DIAGRAM_NODE_TYPE_DEFAULTS: {
 };
 export type DiagramNodeGeometry = {
     readonly coords: Point;
+    readonly z: number;
     readonly width: number;
     readonly height: number;
     readonly sections: {
@@ -76,6 +78,7 @@ export declare class DiagramNodeType implements DiagramEntity {
     defaultHeight: number;
     minWidth: number;
     minHeight: number;
+    defaultZ: number;
     resizerX: DiagramResizer;
     resizerY: DiagramResizer;
     resizerXY: DiagramResizer;
@@ -107,7 +110,7 @@ export declare class DiagramNodeType implements DiagramEntity {
  * @see DiagramSection
  */
 export declare class DiagramNode extends DiagramElement implements LabeledElement {
-    private _type;
+    #private;
     get type(): DiagramNodeType;
     set type(type: DiagramNodeType);
     get typeString(): string;
@@ -172,6 +175,11 @@ export declare class DiagramNode extends DiagramElement implements LabeledElemen
      * @public
      */
     height: number;
+    /**
+     * The relative z coordinate of this node. Used to render this node below nodes with a higher z coordinate.
+     * @public
+     */
+    z: number;
     /**
      * Name of this node. Alias for this node's label's text.
      * @public
@@ -208,6 +216,10 @@ export declare class DiagramNode extends DiagramElement implements LabeledElemen
     get removed(): boolean;
     updateInView(): void;
     raise(): void;
+    /**
+     * Put this element above other elements in the view if they have a lower z coordinate.
+     */
+    raiseWithZ(): void;
     getPriority(): number;
     /**
      * Returns the horizontal resizer of this node.
@@ -343,12 +355,12 @@ export declare class DiagramNode extends DiagramElement implements LabeledElemen
     copySectionRow(rowIndex: number): void;
 }
 export declare class DiagramNodeSet extends DiagramElementSet<DiagramNode> {
-    private model;
+    #private;
     /**
      * Set of the possible types of node that the nodes of this set can have.
      * @public
      */
-    types: DiagramEntitySet<DiagramNodeType>;
+    readonly types: DiagramEntitySet<DiagramNodeType>;
     /**
      * Instance a set of nodes for the given model. This method is used internally.
      * @private

package/src/lib/diagram/model/diagram-object.d.ts

@@ -37,7 +37,7 @@ export declare class DiagramObject extends DiagramElement {
     getPriority(): number;
 }
 export declare class DiagramObjectSet extends DiagramElementSet<DiagramObject> {
-    private model;
+    #private;
     /**
      * Instance a set of objects for the given model. This method is used internally.
      * @private

package/src/lib/diagram/model/diagram-port.d.ts

@@ -70,7 +70,7 @@ export declare class DiagramPortType implements DiagramEntity {
  * @see DiagramSection
  */
 export declare class DiagramPort extends DiagramElement implements LabeledElement {
-    private _type;
+    #private;
     get type(): DiagramPortType | undefined;
     set type(type: DiagramPortType | undefined);
     get typeString(): string | undefined;
@@ -202,12 +202,12 @@ export declare class DiagramPort extends DiagramElement implements LabeledElemen
     distanceTo(coords: Point): number;
 }
 export declare class DiagramPortSet extends DiagramElementSet<DiagramPort> {
-    private model;
+    #private;
     /**
      * Set of the possible types of port that the ports of this set can have.
      * @public
      */
-    types: DiagramEntitySet<DiagramPortType>;
+    readonly types: DiagramEntitySet<DiagramPortType>;
     /**
      * Instance a set of ports for the given model. This method is used internally.
      * @private

package/src/lib/diagram/model/diagram-section.d.ts

@@ -243,7 +243,7 @@ export declare class DiagramSection extends DiagramElement implements LabeledEle
     setGeometry(geometry: DiagramSectionGeometry): void;
 }
 export declare class DiagramSectionSet extends DiagramElementSet<DiagramSection> {
-    private model;
+    #private;
     /**
      * Instance a set of sections for the given model. This method is used internally.
      * @private

package/src/lib/diagram/property/value.d.ts

@@ -6,21 +6,13 @@ import { Property, PropertySet } from './property';
  * @see PropertySet
  */
 export declare class ValueSet {
+    #private;
     rootElement: {
         [key: string]: unknown;
     };
     propertySet: PropertySet;
     displayedProperties: Property[];
     hiddenProperties: Property[];
-    private values;
-    private valueSets;
-    /**
-     * Collaborative timestamps for all keys in this.values that have ever been set,
-     * even if since they've since been set to the default value.
-     *
-     * Object values (in this.valueSets) store their own timestamps separately.
-     */
-    private ownTimestamps;
     constructor(propertySet: PropertySet, rootElement: unknown);
     /**
      * Gets the value of the root element attribute under the given keys.
@@ -134,13 +126,6 @@ export declare class ValueSet {
      * @private
      */
     resetValues(): void;
-    /**
-     * Constructs a ValueSet with its corresponding PropertySet representing the values of the object.
-     * @private
-     * @param key Key that the ValueSet is under.
-     * @returns The constructed ValueSet.
-     */
-    private constructSubValueSet;
     /**
      * Gets the ValueSet under the given key when there are nested ValueSets.
      * @private

package/src/lib/interfaces/canvas.d.ts

@@ -9,6 +9,7 @@ import { ActionStack, DiagramAction, DiagramActionMethod, DiagramActions } from
 import { DiagramEvent } from '../diagram/diagram-event';
 import { DiagramConnectionType } from '../diagram/model/diagram-connection';
 import { DiagramModel } from '../diagram/model/diagram-model';
+import { DiagramNode } from '../diagram/model/diagram-node';
 import { DiagramValidator } from '../errors/diagram-validator';
 import { Point } from '../util/canvas-util';
 import { DiagramEditor } from './diagram-editor';
@@ -233,25 +234,25 @@ export interface Canvas {
      * @private
      * @param event A MouseEvent.
      */
-    getPointerLocationRelativeToCanvas(event: MouseEvent): Point;
+    getPointerLocationRelativeToCanvas(event: MouseEvent | d3.D3DragEvent<Element, unknown, unknown>): Point;
     /**
      * Get the location of the pointer in the given event relative to the svg element.
      * @private
      * @param event A MouseEvent.
      */
-    getPointerLocationRelativeToRoot(event: MouseEvent): Point;
+    getPointerLocationRelativeToRoot(event: MouseEvent | d3.D3DragEvent<Element, unknown, unknown>): Point;
     /**
      * Get the location of the pointer in the given event relative to the body.
      * @private
      * @param event A MouseEvent.
      */
-    getPointerLocationRelativeToBody(event: MouseEvent): Point;
+    getPointerLocationRelativeToBody(event: MouseEvent | d3.D3DragEvent<Element, unknown, unknown>): Point;
     /**
      * Get the location of the pointer in the given event relative to the screen.
      * @private
      * @param event A MouseEvent.
      */
-    getPointerLocationRelativeToScreen(event: MouseEvent): Point;
+    getPointerLocationRelativeToScreen(event: MouseEvent | d3.D3DragEvent<Element, unknown, unknown>): Point;
     /**
      * Adds a validator to the list of validators of the diagram.
      * @public
@@ -318,6 +319,16 @@ export interface Canvas {
      * @public
      */
     updateDecoratorsInView(...ids: string[]): void;
+    /**
+     * Update the z coordinate of a node to be higher than any node that overlaps with it.
+     * @public
+     */
+    bringToFront(node: DiagramNode): void;
+    /**
+     * Update the z coordinate of a node to be lower than any node that overlaps with it.
+     * @public
+     */
+    sendToBack(node: DiagramNode): void;
     /**
      * Checks whether the root of a diagram field encompasses the totality of the field.
      * @param id The id of a diagram field

package/src/lib/util/grid.d.ts

@@ -4,9 +4,7 @@ import { Point } from './canvas-util';
  * @private
  */
 export declare class Grid<T> {
-    private grid;
-    private offsetX;
-    private offsetY;
+    #private;
     /**
      * Get the minimum x coordinate among the elements in the grid.
      */