@metadev/daga 2.0.2 → 3.1.0

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

@@ -6,7 +6,7 @@ import { DiagramConnection } from './diagram-connection';
 import { DiagramDecorator } from './diagram-decorator';
 import { DiagramElement, DiagramElementSet } from './diagram-element';
 import { DiagramEntity, DiagramEntitySet } from './diagram-entity';
-import { DiagramField } from './diagram-field';
+import { DiagramField, LabeledElement } from './diagram-field';
 import { DiagramModel } from './diagram-model';
 import { DiagramPort } from './diagram-port';
 import { PropertySet, ValueSet } from './diagram-property';
@@ -30,11 +30,14 @@ export declare const DIAGRAM_NODE_TYPE_DEFAULTS: {
     minHeight: number;
     resizableX: boolean;
     resizableY: boolean;
+    padding: number;
     label: null;
     ports: never[];
     sectionGrid: null;
     look: NodeShapedLook;
     isUnique: boolean;
+    canBeParentless: boolean;
+    childrenTypes: never[];
     priority: number;
     properties: never[];
 };
@@ -45,6 +48,9 @@ export type DiagramNodeGeometry = {
     readonly sections: {
         [sectionId: string]: DiagramSectionGeometry;
     };
+    readonly children: {
+        [childId: string]: DiagramNodeGeometry;
+    };
 };
 /**
  * A node type, which holds properties that nodes of this type share in common.
@@ -60,11 +66,17 @@ export declare class DiagramNodeType implements DiagramEntity {
     minHeight: number;
     resizableX: boolean;
     resizableY: boolean;
+    bottomPadding: number;
+    leftPadding: number;
+    rightPadding: number;
+    topPadding: number;
     label: FieldConfig | null;
     ports: PortConfig[];
     sectionGrid: SectionGridConfig | null;
     look: NodeShapedLook | NodeImageLook | NodeStretchableImageLook;
     isUnique: boolean;
+    canBeParentless: boolean;
+    childrenTypes: string[];
     priority: number;
     propertySet: PropertySet;
     constructor(options: NodeTypeConfig);
@@ -76,7 +88,7 @@ export declare class DiagramNodeType implements DiagramEntity {
  * @see DiagramPort
  * @see DiagramSection
  */
-export declare class DiagramNode extends DiagramElement {
+export declare class DiagramNode extends DiagramElement implements LabeledElement {
     type: DiagramNodeType;
     /**
      * Additional properties of this node.
@@ -93,6 +105,16 @@ export declare class DiagramNode extends DiagramElement {
      * @public
      */
     label?: DiagramField;
+    /**
+     * Parent of this node.
+     * @public
+     */
+    parent?: DiagramNode;
+    /**
+     * Nodes contained within this node.
+     * @public
+     */
+    children: DiagramNode[];
     /**
      * Sections of this node.
      * @public
@@ -114,7 +136,7 @@ export declare class DiagramNode extends DiagramElement {
      */
     coords: Point;
     /**
-     * Collaborative timestamp for SetGeometryCollabActions.
+     * Collaborative timestamp for MoveCollabAction, SetGeometryCollabAction and SetParentCollabAction.
      * @public
      */
     geometryTimestamp: CollabTimestamp | null;
@@ -137,6 +159,7 @@ export declare class DiagramNode extends DiagramElement {
     constructor(model: DiagramModel, type: DiagramNodeType, coords: Point | undefined, id: string);
     get removed(): boolean;
     updateInView(): void;
+    raise(): void;
     getPriority(): number;
     /**
      * Get the port of this node which is closest to the given coordinates.
@@ -168,6 +191,26 @@ export declare class DiagramNode extends DiagramElement {
      * @returns A list of nodes.
      */
     getAdjacentNodes(includeRemoved?: boolean): DiagramNode[];
+    /**
+     * Return the ancestor of this node which has no ancestors. If this node has no ancestors, returns itself.
+     * @returns The ancestor of this node which has no ancestors.
+     */
+    getLastAncestor(): DiagramNode;
+    /**
+     * Return true if this node is among the ancestors of the given node.
+     * @param child A node.
+     * @returns `true` if this node is among the ancestors of the given node, `false` otherwise.
+     */
+    isAncestorOf(child: DiagramNode): boolean;
+    /**
+     * Return true if the given node is among the ancestors of this node.
+     * @param child A node.
+     * @returns `true` if the given node is among the ancestors of this node, `false` otherwise.
+     */
+    isDescendantOf(child: DiagramNode): boolean;
+    addChild(child: DiagramNode): void;
+    removeChild(child: DiagramNode): void;
+    fitToChild(child: DiagramNode): void;
     /**
      * Change the coordinates of this node to the given coordinates and move its sections, ports and labels correspondingly.
      * @public
@@ -194,7 +237,7 @@ export declare class DiagramNode extends DiagramElement {
      * Returns the current values of all geometric properties (coordinates and dimensions) of this node and its sections.
      * @public
      */
-    getGeometry(): DiagramNodeGeometry;
+    getGeometry(excludeId?: string): DiagramNodeGeometry;
     /**
      * Sets all geometric properties (coordinates and dimensions) of this node and its sections.
      * @public
@@ -223,4 +266,28 @@ export declare class DiagramNodeSet extends DiagramElementSet<DiagramNode> {
      */
     new(type: DiagramNodeType | string, coords: Point, id: string): DiagramNode;
     remove(id: string): void;
+    /**
+     * Gets all the nodes that overlap with the given coordinates.
+     * @public
+     * @param x A coordinate along the x axis.
+     * @param y A coordinate along the y axis.
+     * @returns All the nodes that overlap with the given coordinates.
+     */
+    getAtCoordinates(x: number, y: number): DiagramNode[];
 }
+/**
+ * Removes any nodes from the given list which are a descendant of another node in the list.
+ * @param nodes A list of nodes.
+ * @returns The given list of nodes minus any node that is a descendant of another node in the list.
+ */
+export declare const filterByOnlyAncestors: (nodes: DiagramNode[]) => DiagramNode[];
+/**
+ * Removes any nodes from the given list which are an ancestor of another node in the list.
+ * @param nodes A list of nodes.
+ * @returns The given list of nodes minus any node that is an ancestor of another node in the list.
+ */
+export declare const filterByOnlyDescendants: (nodes: DiagramNode[]) => DiagramNode[];
+export declare const getBottomPadding: (config?: NodeTypeConfig | null) => number;
+export declare const getLeftPadding: (config?: NodeTypeConfig | null) => number;
+export declare const getRightPadding: (config?: NodeTypeConfig | null) => number;
+export declare const getTopPadding: (config?: NodeTypeConfig | null) => number;

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

@@ -28,6 +28,7 @@ export declare class DiagramObject extends DiagramElement {
     select(): d3.Selection<SVGGElement, unknown, null, unknown> | undefined;
     get removed(): boolean;
     updateInView(): void;
+    raise(): void;
     /**
      * Change the coordinates of this object to the given coordinates.
      * @public

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

@@ -2,7 +2,7 @@ import { Point } from '../../util/canvas-util';
 import { Side } from '../../util/svg-util';
 import { DiagramConnection } from './diagram-connection';
 import { DiagramElement, DiagramElementSet } from './diagram-element';
-import { DiagramField } from './diagram-field';
+import { DiagramField, LabeledElement } from './diagram-field';
 import { DiagramModel } from './diagram-model';
 import { DiagramNode } from './diagram-node';
 import { DiagramSection } from './diagram-section';
@@ -23,7 +23,7 @@ export declare const DIAGRAM_PORT_DEFAULTS: {
  * @see DiagramNode
  * @see DiagramSection
  */
-export declare class DiagramPort extends DiagramElement {
+export declare class DiagramPort extends DiagramElement implements LabeledElement {
     /**
      * Element that this port belongs to.
      * @public
@@ -57,6 +57,7 @@ export declare class DiagramPort extends DiagramElement {
     constructor(model: DiagramModel, rootElement: DiagramNode | DiagramSection | undefined, coords: Point, direction: Side, id: string);
     get removed(): boolean;
     updateInView(): void;
+    raise(): void;
     /**
      * Add a connection to this port's list of outgoing connections.
      * @public

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

@@ -157,7 +157,9 @@ export declare class ValueSet {
     propertySet: PropertySet;
     displayedProperties: Property[];
     hiddenProperties: Property[];
-    private values;
+    values: {
+        [key: string]: unknown;
+    };
     private valueSets;
     /**
      * Collaborative timestamps for all keys in this.values that have ever been set,

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

@@ -4,7 +4,7 @@ import { NodeShapedLook, SectionConfig } from '../diagram-config';
 import { DiagramConnection } from './diagram-connection';
 import { DiagramDecorator } from './diagram-decorator';
 import { DiagramElement, DiagramElementSet } from './diagram-element';
-import { DiagramField } from './diagram-field';
+import { DiagramField, LabeledElement } from './diagram-field';
 import { DiagramModel } from './diagram-model';
 import { DiagramNode } from './diagram-node';
 import { DiagramPort } from './diagram-port';
@@ -61,7 +61,7 @@ export type DiagramSectionGeometry = {
  * @see DiagramNode
  * @see DiagramPort
  */
-export declare class DiagramSection extends DiagramElement {
+export declare class DiagramSection extends DiagramElement implements LabeledElement {
     /**
      * Node that this section belongs to.
      * @public
@@ -114,6 +114,7 @@ export declare class DiagramSection extends DiagramElement {
     constructor(model: DiagramModel, node: DiagramNode | undefined, indexXInNode: number, indexYInNode: number, coords: Point, width: number, height: number, id: string);
     get removed(): boolean;
     updateInView(): void;
+    raise(): void;
     getConfig(): SectionConfig | undefined;
     getMinWidth(): number;
     getMinHeight(): number;

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

@@ -3,7 +3,7 @@ import { DiagramContextMenu } from '../diagram/canvas/diagram-context-menu';
 import { DiagramUserHighlight } from '../diagram/canvas/diagram-user-highlight';
 import { DiagramUserSelection } from '../diagram/canvas/diagram-user-selection';
 import { CollabEngine } from '../diagram/collab/collab-engine';
-import { ActionStack, DiagramActions } from '../diagram/diagram-action';
+import { ActionStack, DiagramAction, DiagramActionMethod, DiagramActions } from '../diagram/diagram-action';
 import { UserActionConfig } from '../diagram/diagram-config';
 import { DiagramEvent } from '../diagram/diagram-event';
 import { DiagramConnectionType } from '../diagram/model/diagram-connection';
@@ -127,28 +127,25 @@ export interface Canvas {
      */
     readonly validatorChange$: Subject<void>;
     /**
-     * Subject for tracking changes in the diagram.
+     * Subject for tracking changes in the diagram which affect the diagram's model.
      * Used to detect if there have been changes over a period of time.
      * Values are sent when the user performs changes on the diagram, but not when the changes are performed programmatically.
      * @public
      */
-    readonly diagramChange$: Subject<void>;
+    readonly diagramChange$: Subject<{
+        action: DiagramAction;
+        method: DiagramActionMethod;
+    }>;
     /**
-     * Subject for tracking the presence of important changes in the diagram.
-     * Used to detect if there are any changes that require immediate handling.
+     * Subject for tracking user events in the diagram which do not affect the diagram's model.
      * @public
      */
-    readonly diagramImportantChange$: Subject<void>;
+    readonly diagramEvent$: Subject<DiagramEvent>;
     /**
      * Subject for tracking changes in the property editor.
      * @public
      */
     readonly propertyEditorChanges$: Subject<void>;
-    /**
-     * Subject for tracking user events in the diagram.
-     * @public
-     */
-    readonly diagramEvent$: Subject<DiagramEvent>;
     /**
      * Initializes the view of the diagram.
      * @private

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

@@ -15,6 +15,8 @@ export declare enum Events {
     KeyDown = "keydown",
     KeyUp = "keyup",
     MouseDown = "mousedown",
+    MouseEnter = "mouseenter",
+    MouseLeave = "mouseleave",
     MouseMove = "mousemove",
     MouseOut = "mouseout",
     MouseOver = "mouseover",

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

@@ -47,11 +47,16 @@ export declare enum LineStyle {
      */
     Dotted = "dotted"
 }
+/**
+ * A function that returns the `d` attribute for a SVG path that passes by the given points in order with the given direction at the start and end.
+ * @public
+ */
+export type LineFunction = (points: Point[], startDirection?: Side | undefined, endDirection?: Side | undefined, minimumDistanceBeforeTurn?: number) => string;
 /**
  * Calculates the path of an SVG line with the given parameters.
  * @private
  */
-export declare const linePath: (shape: LineShape, points: Point[], startDirection?: Side | undefined, endDirection?: Side | undefined, minimumDistanceBeforeTurn?: number) => string;
+export declare const linePath: (shape: LineShape | LineFunction, points: Point[], startDirection?: Side | undefined, endDirection?: Side | undefined, minimumDistanceBeforeTurn?: number) => string;
 /**
  * Calculates the dasharray property of an SVG line corresponding to the given line style and width.
  * @private

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

@@ -54,11 +54,16 @@ export declare enum ClosedShape {
      */
     StickyNote = "sticky-note"
 }
+/**
+ * A function that returns the `d` attribute for a SVG path that starting at the given `x` and `y` coordinates describes a shape of the given `width` and `height`.
+ * @public
+ */
+export type ShapeFunction = (x: number, y: number, width: number, height: number) => string;
 /**
  * Get the SVG path of the correspondign closed shape, starting at the given x and y coordinates, with the given width and height.
  * @private
  */
-export declare const generalClosedPath: (shape: ClosedShape, x: number, y: number, width: number, height: number) => string;
+export declare const generalClosedPath: (shape: ClosedShape | ShapeFunction, x: number, y: number, width: number, height: number) => string;
 /**
  * Generates an ellipse SVG path.
  * @private