@metadev/daga 3.1.4 → 4.0.0

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

@@ -1,21 +1,67 @@
 import { Point } from '../../util/canvas-util';
 import { Side } from '../../util/svg-util';
+import { FieldConfig, PortTypeConfig } from '../config/diagram-config';
+import { ImageLook, ImageLookConfig, ShapedLook, ShapedLookConfig } from '../config/diagram-look';
 import { DiagramConnection } from './diagram-connection';
 import { DiagramElement, DiagramElementSet } from './diagram-element';
+import { DiagramEntity, DiagramEntitySet } from './diagram-entity';
 import { DiagramField, LabeledElement } from './diagram-field';
 import { DiagramModel } from './diagram-model';
 import { DiagramNode } from './diagram-node';
 import { DiagramSection } from './diagram-section';
+/**
+ * Default values of the look of a diagram port.
+ * @private
+ * @see DIAGRAM_NODE_TYPE_DEFAULTS
+ */
+export declare const DIAGRAM_PORT_LOOK_DEFAULTS: ShapedLookConfig;
 /**
  * Default values of the parameters of a diagram port.
  * @private
  * @see DiagramPort
  */
-export declare const DIAGRAM_PORT_DEFAULTS: {
-    radius: number;
-    highlightedColor: string;
-    selectedColor: string;
+export declare const DIAGRAM_PORT_TYPE_DEFAULTS: {
+    name: string;
+    label: null;
+    allowsOutgoing: boolean;
+    allowsIncoming: boolean;
+    width: number;
+    look: ShapedLookConfig;
 };
+/**
+ * The types allowed for the look of a port.
+ * @public
+ * @see Look
+ * @see DiagramPort
+ */
+export type PortLook = ShapedLook | ImageLook;
+/**
+ * A port type, which holds properties that ports of this type share in common.
+ * @public
+ * @see PortTypeConfig
+ */
+export declare class DiagramPortType implements DiagramEntity {
+    readonly id: string;
+    name: string;
+    label: FieldConfig | null;
+    /**
+     * Whether ports of this type can be used as a connection start point.
+     */
+    allowsOutgoing: boolean;
+    /**
+     * Whether ports of this type can be used as a connection end point.
+     */
+    allowsIncoming: boolean;
+    /**
+     * Width of ports of this type in diagram units.
+     */
+    width: number;
+    defaultLook: PortLook;
+    selectedLook: PortLook;
+    highlightedLook: PortLook;
+    selectedAndHighlightedLook: PortLook;
+    constructor(options: PortTypeConfig);
+}
 /**
  * A port which is part of a node or section and at which connections can start or end.
  * @public
@@ -24,6 +70,11 @@ export declare const DIAGRAM_PORT_DEFAULTS: {
  * @see DiagramSection
  */
 export declare class DiagramPort extends DiagramElement implements LabeledElement {
+    private _type;
+    get type(): DiagramPortType | undefined;
+    set type(type: DiagramPortType | undefined);
+    get typeString(): string | undefined;
+    set typeString(typeString: string | undefined);
     /**
      * Element that this port belongs to.
      * @public
@@ -34,16 +85,29 @@ export declare class DiagramPort extends DiagramElement implements LabeledElemen
      * @public
      */
     label?: DiagramField;
+    /**
+     * Coordinates of this port.
+     * @public
+     */
+    coords: Point;
+    /**
+     * Coordinates of the point where connections end and start from this port.
+     * @public
+     */
+    connectionPoint: Point;
     /**
      * Direction of the connections of this port at the coordinates of this port.
      * @public
      */
     direction: Side;
     /**
-     * Coordinates of this port.
-     * @public
+     * Whether this port can be used as a connection start point.
      */
-    coords: Point;
+    get allowsOutgoing(): boolean;
+    /**
+     * Whether this port can be used as a connection end point.
+     */
+    get allowsIncoming(): boolean;
     /**
      * Connections that start at this port.
      * @public
@@ -54,7 +118,38 @@ export declare class DiagramPort extends DiagramElement implements LabeledElemen
      * @public
      */
     incomingConnections: DiagramConnection[];
-    constructor(model: DiagramModel, rootElement: DiagramNode | DiagramSection | undefined, coords: Point, direction: Side, id: string);
+    /**
+     * Name of this port. Alias for this port's label's text.
+     * @public
+     */
+    get name(): string;
+    set name(name: string);
+    private _defaultLook?;
+    private _selectedLook?;
+    private _highlightedLook?;
+    private _selectedAndHighlightedLook?;
+    /**
+     * Current look of this port.
+     * @private
+     */
+    get look(): PortLook;
+    /**
+     * Sets the look configuration of the look to override the one determined by the type.
+     * `undefined` resets it to the one determined by the type.
+     * @private
+     */
+    set look(look: ShapedLookConfig | ImageLookConfig | undefined);
+    /**
+     * Current width of this port.
+     * @private
+     */
+    get width(): number;
+    /**
+     * Current height of this port. Same as the width.
+     * @private
+     */
+    get height(): number;
+    constructor(model: DiagramModel, type: DiagramPortType | undefined, rootElement: DiagramNode | DiagramSection | undefined, coords: Point, connectionPoint: Point | undefined, direction: Side, id: string);
     get removed(): boolean;
     updateInView(): void;
     raise(): void;
@@ -87,6 +182,11 @@ export declare class DiagramPort extends DiagramElement implements LabeledElemen
 }
 export declare class DiagramPortSet extends DiagramElementSet<DiagramPort> {
     private model;
+    /**
+     * Set of the possible types of port that the ports of this set can have.
+     * @public
+     */
+    types: DiagramEntitySet<DiagramPortType>;
     /**
      * Instance a set of ports for the given model. This method is used internally.
      * @private
@@ -96,6 +196,6 @@ export declare class DiagramPortSet extends DiagramElementSet<DiagramPort> {
      * Instance a new port and add it to this set. This method is normally called when instancing an element with a port and it is rarely called by itself.
      * @private
      */
-    new(rootElement: DiagramNode | DiagramSection | undefined, coords: Point, direction: Side, id: string): DiagramPort;
+    new(type: DiagramPortType | undefined, rootElement: DiagramNode | DiagramSection | undefined, coords: Point, connectionPoint: Point | undefined, direction: Side, id: string): DiagramPort;
     remove(id: string): void;
 }

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

@@ -157,9 +157,7 @@ export declare class ValueSet {
     propertySet: PropertySet;
     displayedProperties: Property[];
     hiddenProperties: Property[];
-    values: {
-        [key: string]: unknown;
-    };
+    private values;
     private valueSets;
     /**
      * Collaborative timestamps for all keys in this.values that have ever been set,
@@ -344,6 +342,23 @@ export declare const diff: (a: {
 }, {
     [key: string]: unknown;
 }];
+/**
+ * Calculates the differences between the two given values of a valueset and returns two objects containing the differences in each relative to the other.
+ *
+ * @param a An object.
+ * @param b An object.
+ * @param valueSet A ValueSet to use as reference for the keys and types of each property.
+ * @returns A tuple of two objects with each containing the keys that have a different value in the corresponding argument compared to the other argument.
+ */
+export declare const diffProperties: (a: {
+    [key: string]: unknown;
+}, b: {
+    [key: string]: unknown;
+}, valueSet: ValueSet) => [{
+    [key: string]: unknown;
+}, {
+    [key: string]: unknown;
+}];
 /**
  * Checks if the given value is an object.
  * @public

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

@@ -1,30 +1,14 @@
 import { Point } from '../../util/canvas-util';
 import { Side } from '../../util/svg-util';
-import { NodeShapedLook, SectionConfig } from '../diagram-config';
+import { FieldConfig, PortConfig, SectionConfig, SectionGridConfig } from '../config/diagram-config';
+import { ImageLookConfig, ShapedLookConfig, StretchableImageLookConfig } from '../config/diagram-look';
 import { DiagramConnection } from './diagram-connection';
 import { DiagramDecorator } from './diagram-decorator';
 import { DiagramElement, DiagramElementSet } from './diagram-element';
 import { DiagramField, LabeledElement } from './diagram-field';
 import { DiagramModel } from './diagram-model';
-import { DiagramNode } from './diagram-node';
+import { DiagramNode, NodeLook } from './diagram-node';
 import { DiagramPort } from './diagram-port';
-/**
- * Default values of the look of a diagram section.
- * @private
- * @see DIAGRAM_SECTION_DEFAULTS
- */
-export declare const DIAGRAM_SECTION_LOOK_DEFAULTS: NodeShapedLook;
-/**
- * Default values of the parameters of a diagram section.
- * @private
- * @see DiagramSection
- */
-export declare const DIAGRAM_SECTION_DEFAULTS: {
-    label: null;
-    ports: never[];
-    look: NodeShapedLook;
-    priority: number;
-};
 /**
  * Default value of the default width of a diagram section.
  * @private
@@ -54,6 +38,31 @@ export type DiagramSectionGeometry = {
     readonly width: number;
     readonly height: number;
 };
+/**
+ * A grid of sections which a node has.
+ * @public
+ * @see DiagramNode
+ * @see SectionGridConfig
+ */
+export declare class DiagramSectionGrid {
+    defaultWidths: number[] | null;
+    defaultHeights: number[] | null;
+    minWidths: number[] | null;
+    minHeights: number[] | null;
+    margin: number;
+    sections: DiagramSectionType[][];
+    constructor(options: SectionGridConfig);
+}
+export declare class DiagramSectionType {
+    label: FieldConfig | null;
+    ports: PortConfig[];
+    defaultLook: NodeLook;
+    selectedLook: NodeLook;
+    highlightedLook: NodeLook;
+    selectedAndHighlightedLook: NodeLook;
+    priority: number;
+    constructor(options: SectionConfig);
+}
 /**
  * A section of a node which can have connections and display a property of the node.
  * @public
@@ -111,11 +120,26 @@ export declare class DiagramSection extends DiagramElement implements LabeledEle
      */
     get name(): string;
     set name(name: string);
+    private _defaultLook?;
+    private _selectedLook?;
+    private _highlightedLook?;
+    private _selectedAndHighlightedLook?;
+    /**
+     * Current look of this port.
+     * @private
+     */
+    get look(): NodeLook;
+    /**
+     * Sets the look configuration of the look to override the one determined by the type.
+     * `undefined` resets it to the one determined by the type.
+     * @private
+     */
+    set look(look: ShapedLookConfig | ImageLookConfig | StretchableImageLookConfig | undefined);
     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;
+    get type(): DiagramSectionType | undefined;
     getMinWidth(): number;
     getMinHeight(): number;
     getPriority(): number;

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

@@ -4,7 +4,7 @@ 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, DiagramAction, DiagramActionMethod, DiagramActions } from '../diagram/diagram-action';
-import { UserActionConfig } from '../diagram/diagram-config';
+import { UserActionConfig } from '../diagram/config/diagram-config';
 import { DiagramEvent } from '../diagram/diagram-event';
 import { DiagramConnectionType } from '../diagram/model/diagram-connection';
 import { DiagramModel } from '../diagram/model/diagram-model';

package/src/lib/util/test-util.d.ts

@@ -1,4 +1,4 @@
-import { DiagramConfig } from '../diagram/diagram-config';
+import { DiagramConfig } from '../diagram/config/diagram-config';
 /**
  * Creates the structuredClone function if it doesn't exist.
  * @private