@metadev/daga 1.5.7 → 3.0.0

package/{lib/diagram-editor → src/lib}/diagram/converters/daga-importer.d.ts

@@ -1,6 +1,8 @@
 import { CollabTimestamp } from '../collab/primitives';
-import { DiagramField } from '../diagram-field';
-import { DiagramModel } from '../diagram-model';
+import { DiagramConnection } from '../model/diagram-connection';
+import { DiagramField } from '../model/diagram-field';
+import { DiagramModel } from '../model/diagram-model';
+import { DiagramNode } from '../model/diagram-node';
 import { DagaConnection, DagaModel, DagaNode } from './daga-model';
 import { DiagramModelImporter } from './diagram-model-importer';
 /**
@@ -9,8 +11,8 @@ import { DiagramModelImporter } from './diagram-model-importer';
  */
 export declare class DagaImporter implements DiagramModelImporter<DagaModel> {
     import(model: DiagramModel, data: DagaModel): DiagramModel;
-    importNode(model: DiagramModel, node: DagaNode): DiagramModel;
-    importConnection(model: DiagramModel, connection: DagaConnection): DiagramModel;
+    importNode(model: DiagramModel, node: DagaNode): DiagramNode | undefined;
+    importConnection(model: DiagramModel, connection: DagaConnection): DiagramConnection | undefined;
     importLabelCollabMeta(newLabel?: DiagramField, labelCollabMeta?: {
         selfRemoved: boolean;
         selfRemovedTimestamp: CollabTimestamp | null;

package/{lib/diagram-editor → src/lib}/diagram/converters/daga-model.d.ts

@@ -1,11 +1,11 @@
-import { Point } from '../../../util/canvas-util';
-import { Side } from '../../../util/svg-util';
+import { Point } from '../../util/canvas-util';
+import { Side } from '../../util/svg-util';
 import { CollabTimestamp, CollabTimestampSet } from '../collab/primitives';
 export declare const DAGA_FILE_VERSION = 1;
 /**
  * Representation of a diagram model in a serialized format.
- * @see DiagramModel
  * @public
+ * @see DiagramModel
  */
 export interface DagaModel {
     id?: string;

package/{lib/diagram-editor → src/lib}/diagram/converters/diagram-model-exporter.d.ts

@@ -1,9 +1,9 @@
-import { DiagramModel } from '../diagram-model';
+import { DiagramModel } from '../model/diagram-model';
 /**
  * A diagram exporter which given a diagram model returns a representation of the diagram in some other form.
+ * @public
  * @see DiagramModel
  * @see DiagramModelImporter
- * @public
  */
 export interface DiagramModelExporter<T> {
     /**

package/{lib/diagram-editor → src/lib}/diagram/converters/diagram-model-importer.d.ts

@@ -1,9 +1,9 @@
-import { DiagramModel } from '../diagram-model';
+import { DiagramModel } from '../model/diagram-model';
 /**
  * A diagram importer which given a diagram's representation in some other form imports the diagram into a given diagram model.
+ * @public
  * @see DiagramModel
  * @see DiagramModelExporter
- * @public
  */
 export interface DiagramModelImporter<T> {
     /**

package/{lib/diagram-editor → src/lib}/diagram/diagram-action.d.ts

@@ -1,18 +1,18 @@
-import { Canvas } from '../../interfaces/canvas';
-import { Point } from '../../util/canvas-util';
+import { Canvas } from '../interfaces/canvas';
+import { Point } from '../util/canvas-util';
 import { DagaConnection, DagaNode } from './converters/daga-model';
-import { DiagramConnectionType } from './diagram-connection';
-import { DiagramNodeGeometry, DiagramNodeType } from './diagram-node';
+import { DiagramConnectionType } from './model/diagram-connection';
+import { DiagramNodeGeometry, DiagramNodeType } from './model/diagram-node';
 /**
- * A queue of recent actions taken by the user that can be undone and redone.
+ * A stack of recent actions taken by the user that can be undone and redone.
  * @private
  */
-export declare class ActionQueue {
+export declare class ActionStack {
     /**
-     * Canvas that this action queue belongs to.
+     * Canvas that this action stack belongs to.
      * @private
      */
-    canvas: Canvas;
+    private readonly canvas;
     /**
      * Maximum number of actions that can be recorded simultaneously.
      * When new actions are added past this limit, older actions are removed.
@@ -28,7 +28,7 @@ export declare class ActionQueue {
      * Index of the last action not counting undone actions. One-indexed. Zero if all actions are undone.
      * @private
      */
-    index: number;
+    private index;
     constructor(canvas: Canvas, maximum: number);
     /**
      * Adds an action to the history.
@@ -54,36 +54,42 @@ export interface DiagramAction {
     /**
      * Perform this action on the diagram for the first time.
      * Performing the same action with the same parameters on a diagram with the same state should always result in the same changes to the state of the diagram.
+     *
+     * @returns `true` if doing the action had an effect on non-removed elements of the model, `false` otherwise.
      */
-    do(): void;
+    do(): boolean;
     /**
      * Undo the changes in the diagram caused by this action.
      * After having called `do()` followed by `undo()`, calling `redo()` followed by `undo()` any number of times should always result in no net changes to the state of the diagram.
+     *
+     * @returns `true` if undoing the action had an effect on non-removed elements of the model, `false` otherwise.
      */
-    undo(): void;
+    undo(): boolean;
     /**
      * Redo the changes in the diagram caused by this action.
      * After having called `do()`, calling `undo()` followed by `redo()` any number of times should always result in no net changes to the state of the diagram.
      * `redo()` is usually equivalent to `do()`, but not always.
+     *
+     * @returns `true` if redoing the action had an effect on non-removed elements of the model, `false` otherwise.
      */
-    redo(): void;
+    redo(): boolean;
 }
 /**
  * Enum listing the actions that can be taken by the user.
- * The actions can correspond to a DiagramAction that can be recorded in the action queue of a diagram or they may not correspond to any DiagramAction implementations.
+ * The actions can correspond to a DiagramAction that can be recorded in the action stack of a diagram or they may not correspond to any DiagramAction implementations.
  * @public
  */
 export declare enum DiagramActions {
     /**
      * Action that corresponds to the addition of a connection.
-     * @see AddConnectionAction
      * @public
+     * @see AddConnectionAction
      */
     AddConnection = "add-connection",
     /**
      * Action that corresponds to the addition of a node.
-     * @see AddNodeAction
      * @public
+     * @see AddNodeAction
      */
     AddNode = "add-node",
     /**
@@ -98,44 +104,45 @@ export declare enum DiagramActions {
     ContextMenu = "context-menu",
     /**
      * Action that corresponds to the edition of a field's text content.
-     * @see EditFieldAction
      * @public
+     * @see EditFieldAction
      */
     EditField = "edit-field",
     /**
      * Action that corresponds to moving a node.
-     * @see SetGeometryAction
      * @public
+     * @see MoveAction
+     * @see SetGeometryAction
      */
     MoveNode = "move-node",
     /**
      * Action that corresponds to pasting diagram elements from the clipboard.
-     * @see PasteAction
      * @public
+     * @see PasteAction
      */
     Paste = "paste",
     /**
      * Action that corresponds to removing elements.
-     * @see RemoveAction
      * @public
+     * @see RemoveAction
      */
     Remove = "remove",
     /**
      * Action that corresponds to altering a node's dimensions.
-     * @see SetGeometryActionAction
      * @public
+     * @see SetGeometryAction
      */
     StretchNode = "stretch-node",
     /**
      * Action that corresponds to altering a sections's dimensions.
-     * @see SetGeometryAction
      * @public
+     * @see SetGeometryAction
      */
     StretchSection = "stretch-section",
     /**
      * Action that corresponds to changing the values of a value set.
-     * @see UpdateValuesAction
      * @public
+     * @see UpdateValuesAction
      */
     UpdateValues = "update-values",
     /**
@@ -146,11 +153,11 @@ export declare enum DiagramActions {
 }
 /**
  * Action which consists of adding a node.
- * @see DiagramNode
  * @private
+ * @see DiagramNode
  */
 export declare class AddNodeAction implements DiagramAction {
-    canvas: Canvas;
+    readonly canvas: Canvas;
     type: DiagramNodeType;
     coords: Point;
     label?: string;
@@ -161,64 +168,77 @@ export declare class AddNodeAction implements DiagramAction {
     constructor(canvas: Canvas, type: DiagramNodeType, coords: Point, label?: string, values?: {
         [key: string]: unknown;
     });
-    do(): void;
-    undo(): void;
-    redo(): void;
+    do(): boolean;
+    undo(): boolean;
+    redo(): boolean;
+}
+/**
+ * Action which consists of changing the coordinates of diagram elements by a fixed amount.
+ * @private
+ */
+export declare class MoveAction implements DiagramAction {
+    readonly canvas: Canvas;
+    nodeIds: string[];
+    delta: Point;
+    constructor(canvas: Canvas, nodeIds: string[], delta: Point);
+    do(): boolean;
+    undo(): boolean;
+    redo(): boolean;
 }
 /**
  * Action which consists of changing a node's geometry: moving, stretching, or stretching sections.
- * @see DiagramNode
  * @private
+ * @see DiagramNode
  */
 export declare class SetGeometryAction implements DiagramAction {
-    canvas: Canvas;
+    readonly canvas: Canvas;
     intent: DiagramActions.MoveNode | DiagramActions.StretchNode | DiagramActions.StretchSection;
     nodeId: string;
     from: DiagramNodeGeometry;
     to: DiagramNodeGeometry;
     constructor(canvas: Canvas, intent: DiagramActions.MoveNode | DiagramActions.StretchNode | DiagramActions.StretchSection, nodeId: string, from: DiagramNodeGeometry, to: DiagramNodeGeometry);
-    do(): void;
-    undo(): void;
-    redo(): void;
+    do(): boolean;
+    undo(): boolean;
+    redo(): boolean;
 }
 /**
  * Action which consists of adding a connection.
- * @see DiagramConnection
  * @private
+ * @see DiagramConnection
  */
 export declare class AddConnectionAction implements DiagramAction {
-    canvas: Canvas;
+    readonly canvas: Canvas;
     type: DiagramConnectionType;
     startId: string;
     endId: string;
     id: string;
     constructor(canvas: Canvas, type: DiagramConnectionType, startId: string, endId: string);
-    do(): void;
-    undo(): void;
-    redo(): void;
+    do(): boolean;
+    undo(): boolean;
+    redo(): boolean;
 }
 /**
  * Action which consists of editing the text of a field.
- * @see DiagramField
  * @private
+ * @see DiagramField
  */
 export declare class EditFieldAction implements DiagramAction {
-    canvas: Canvas;
+    readonly canvas: Canvas;
     fieldId: string;
     from: string;
     to: string;
     constructor(canvas: Canvas, fieldId: string, from: string, to: string);
-    do(): void;
-    undo(): void;
-    redo(): void;
+    do(): boolean;
+    undo(): boolean;
+    redo(): boolean;
 }
 /**
  * Action which consists of editing the values of a value set.
- * @see ValueSet
  * @private
+ * @see ValueSet
  */
 export declare class UpdateValuesAction implements DiagramAction {
-    canvas: Canvas;
+    readonly canvas: Canvas;
     id: string | undefined;
     from: {
         [key: string]: unknown;
@@ -231,9 +251,9 @@ export declare class UpdateValuesAction implements DiagramAction {
     }, to: {
         [key: string]: unknown;
     });
-    do(): void;
-    undo(): void;
-    redo(): void;
+    do(): boolean;
+    undo(): boolean;
+    redo(): boolean;
 }
 /**
  * Action which consists of removing elements from a diagram.
@@ -247,16 +267,16 @@ export declare class UpdateValuesAction implements DiagramAction {
  * @private
  */
 export declare class RemoveAction implements DiagramAction {
-    canvas: Canvas;
+    readonly canvas: Canvas;
     nodeIds: string[];
     sectionIds: string[];
     portIds: string[];
     connectionIds: string[];
     fieldIds: string[];
     constructor(canvas: Canvas, nodeIds: string[], sectionIds: string[], portIds: string[], connectionIds: string[], fieldIds: string[]);
-    do(): void;
-    undo(): void;
-    redo(): void;
+    do(): boolean;
+    undo(): boolean;
+    redo(): boolean;
 }
 /**
  * Action which consists of pasting elements from an external source into a diagram.
@@ -264,12 +284,12 @@ export declare class RemoveAction implements DiagramAction {
  * @private
  */
 export declare class PasteAction implements DiagramAction {
-    canvas: Canvas;
+    readonly canvas: Canvas;
     nodes: DagaNode[];
     connections: DagaConnection[];
     coords?: Point;
     constructor(canvas: Canvas, nodes: DagaNode[], connections: DagaConnection[], coords?: Point);
-    do(): void;
-    undo(): void;
-    redo(): void;
+    do(): boolean;
+    undo(): boolean;
+    redo(): boolean;
 }