@metadev/daga 1.5.6 → 2.0.2

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

@@ -1,5 +1,5 @@
 import * as d3 from 'd3';
-import { CollabTimestamp } from './collab/primitives';
+import { CollabTimestamp } from '../collab/primitives';
 import { DiagramEntity, DiagramEntitySet } from './diagram-entity';
 import { DiagramModel } from './diagram-model';
 /**
@@ -18,19 +18,18 @@ export declare abstract class DiagramElement implements DiagramEntity {
      * Diagram model this diagram element is part of.
      * @private
      */
-    model: DiagramModel;
+    readonly model: DiagramModel;
     private _id;
     get id(): string;
     /**
-     * Whether this diagram element is currently highlighted by the user.
+     * Whether this diagram element is currently in the user highlight.
      * @private
      */
-    highlighted: boolean;
+    get highlighted(): boolean;
     /**
-     * Whether this diagram element is currently selected by the user.
-     * @private
+     * Whether this diagram element is currently in the user selection.
      */
-    selected: boolean;
+    get selected(): boolean;
     /**
      * Whether this diagram element has itself been explicitly removed.
      *
@@ -83,10 +82,7 @@ export declare class DiagramElementSet<E extends DiagramElement> extends Diagram
     find(predicate: (value: E, index: number, array: E[]) => unknown, includeRemoved?: boolean): E | undefined;
     get(id: string, includeRemoved?: boolean): E | undefined;
     map<R>(callback: (value: E, index: number, array: E[]) => R, includeRemoved?: boolean): R[];
-    /**
-     * Gets the number of entities in this set.
-     * @public
-     */
+    remove(id: string): void;
     size(includeRemoved?: boolean): number;
     [Symbol.iterator](includeRemoved?: boolean): Iterator<E>;
 }

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

@@ -21,12 +21,12 @@ export declare class DiagramEntitySet<E extends DiagramEntity> implements Iterab
      * The list of entities contained in this set.
      * @private
      */
-    protected entities: E[];
+    protected readonly entities: E[];
     /**
      * A mapping of entity ids to their corresponding entity in this set for quickly fetching entities based on their id.
      * @private
      */
-    protected entityMap: {
+    protected readonly entityMap: {
         [id: string]: E;
     };
     /**

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

@@ -1,7 +1,7 @@
 import { Point } from '../../util/canvas-util';
 import { HorizontalAlign, VerticalAlign } from '../../util/svg-util';
-import { CollabTimestamp } from './collab/primitives';
-import { FieldConfig } from './diagram-config';
+import { CollabTimestamp } from '../collab/primitives';
+import { FieldConfig } from '../diagram-config';
 import { DiagramElement, DiagramElementSet } from './diagram-element';
 import { DiagramModel } from './diagram-model';
 import { DiagramNode } from './diagram-node';
@@ -9,8 +9,8 @@ import { DiagramPort } from './diagram-port';
 import { DiagramSection } from './diagram-section';
 /**
  * Default values of the parameters of a diagram field.
- * @see DiagramField
  * @private
+ * @see DiagramField
  */
 export declare const DIAGRAM_FIELD_DEFAULTS: {
     editable: boolean;
@@ -26,10 +26,10 @@ export declare const DIAGRAM_FIELD_DEFAULTS: {
 };
 /**
  * A field which displays text and is part of a diagram element.
+ * @public
  * @see DiagramNode
  * @see DiagramPort
  * @see DiagramSection
- * @public
  */
 export declare class DiagramField extends DiagramElement {
     /**

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

@@ -17,49 +17,49 @@ export declare class DiagramModel {
      * The canvas where this model's data is being rendered.
      * @private
      */
-    canvas?: Canvas;
+    readonly canvas?: Canvas;
     /**
      * Nodes of this model.
-     * @see DiagramNode
      * @public
+     * @see DiagramNode
      */
-    nodes: DiagramNodeSet;
+    readonly nodes: DiagramNodeSet;
     /**
      * Sections of this model.
-     * @see DiagramSection
      * @public
+     * @see DiagramSection
      */
-    sections: DiagramSectionSet;
+    readonly sections: DiagramSectionSet;
     /**
      * Ports of this model.
-     * @see DiagramPort
      * @public
+     * @see DiagramPort
      */
-    ports: DiagramPortSet;
+    readonly ports: DiagramPortSet;
     /**
      * Connections of this model.
-     * @see DiagramConnection
      * @public
+     * @see DiagramConnection
      */
-    connections: DiagramConnectionSet;
+    readonly connections: DiagramConnectionSet;
     /**
      * Fields of this model.
-     * @see DiagramField
      * @public
+     * @see DiagramField
      */
-    fields: DiagramFieldSet;
+    readonly fields: DiagramFieldSet;
     /**
      * Objects of this model.
-     * @see DiagramObject
      * @public
+     * @see DiagramObject
      */
-    objects: DiagramObjectSet;
+    readonly objects: DiagramObjectSet;
     /**
      * Decorators of this model.
-     * @see DiagramDecorator
      * @public
+     * @see DiagramDecorator
      */
-    decorators: DiagramDecoratorSet;
+    readonly decorators: DiagramDecoratorSet;
     /**
      * Identifier of this diagram. Set by the consumer of the diagram.
      * @public

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

@@ -1,7 +1,7 @@
 import { Point } from '../../util/canvas-util';
 import { Side } from '../../util/svg-util';
-import { CollabTimestamp } from './collab/primitives';
-import { FieldConfig, NodeImageLook, NodeShapedLook, NodeStretchableImageLook, NodeTypeConfig, PortConfig, SectionGridConfig } from './diagram-config';
+import { CollabTimestamp } from '../collab/primitives';
+import { FieldConfig, NodeImageLook, NodeShapedLook, NodeStretchableImageLook, NodeTypeConfig, PortConfig, SectionGridConfig } from '../diagram-config';
 import { DiagramConnection } from './diagram-connection';
 import { DiagramDecorator } from './diagram-decorator';
 import { DiagramElement, DiagramElementSet } from './diagram-element';
@@ -13,14 +13,14 @@ import { PropertySet, ValueSet } from './diagram-property';
 import { DiagramSection, DiagramSectionGeometry } from './diagram-section';
 /**
  * Default values of the look of a diagram node.
- * @see DIAGRAM_NODE_TYPE_DEFAULTS
  * @private
+ * @see DIAGRAM_NODE_TYPE_DEFAULTS
  */
 export declare const DIAGRAM_NODE_LOOK_DEFAULTS: NodeShapedLook;
 /**
  * Default values of the parameters of a diagram node.
- * @see DiagramNode
  * @private
+ * @see DiagramNode
  */
 export declare const DIAGRAM_NODE_TYPE_DEFAULTS: {
     name: string;
@@ -48,11 +48,11 @@ export type DiagramNodeGeometry = {
 };
 /**
  * A node type, which holds properties that nodes of this type share in common.
- * @see NodeTypeConfig
  * @public
+ * @see NodeTypeConfig
  */
 export declare class DiagramNodeType implements DiagramEntity {
-    id: string;
+    readonly id: string;
     name: string;
     defaultWidth: number;
     defaultHeight: number;
@@ -71,10 +71,10 @@ export declare class DiagramNodeType implements DiagramEntity {
 }
 /**
  * A node, the most basic element of a diagram, which can have connections to other nodes through its ports or be divided into sections.
+ * @public
  * @see DiagramConnection
  * @see DiagramPort
  * @see DiagramSection
- * @public
  */
 export declare class DiagramNode extends DiagramElement {
     type: DiagramNodeType;

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

@@ -1,9 +1,9 @@
-import { CollabTimestamp, CollabTimestampSet } from './collab/primitives';
+import { CollabTimestamp, CollabTimestampSet } from '../collab/primitives';
 /**
  * A property which is part of a property set and defines what values a value in a value set can take.
+ * @public
  * @see PropertySet
  * @see ValueSet
- * @private
  */
 export declare class Property {
     /**
@@ -29,17 +29,19 @@ export declare class Property {
      */
     editable: boolean;
     /**
-     * Which attribute of the parent component the value of this property is linked to. `undefined` if none.
+     * Which attribute of the parent component the value of this property is linked to. By default, it is not linked to any.
      * @default undefined
      */
     rootAttribute?: string[] | string;
     /**
-     * The list of possible values if the value of the property is chosen from a set of possible values. Undefined otherwise.
+     * The list of possible values if the value of the property is chosen from a set of possible values.
+     * Should be set if the type of this property is `'option'` or 'option-list'. Otherwise, it should not be set.
      * @default undefined
      */
     options?: Option<unknown>[];
     /**
-     * The list of properties that are part of this property if the type of this property is `'object'`.
+     * The list of properties that are part of this property if this property is composed of other properties.
+     * Should be set if the type of this property is `'object'`. Otherwise, it should not be set.
      * @default undefined
      */
     properties?: Property[];
@@ -56,8 +58,8 @@ export interface Option<T> {
 }
 /**
  * The type that a property can have.
+ * @public
  * @see Property
- * @private
  */
 export declare enum Type {
     /**
@@ -129,9 +131,9 @@ export declare enum Type {
 }
 /**
  * A set of properties based on which a set of values of those properties can be created.
+ * @public
  * @see Property
  * @see ValueSet
- * @private
  */
 export declare class PropertySet {
     propertyMap: {
@@ -145,8 +147,8 @@ export declare class PropertySet {
 }
 /**
  * A set of values corresponding to a set of properties.
+ * @public
  * @see PropertySet
- * @private
  */
 export declare class ValueSet {
     rootElement: {
@@ -166,15 +168,15 @@ export declare class ValueSet {
     private ownTimestamps;
     constructor(propertySet: PropertySet, rootElement: unknown);
     /**
-     * Get the value of the root element attribute under the given keys.
+     * Gets the value of the root element attribute under the given keys.
      * If given an array of keys, the value is found under repeated lookups to enable obtaining nested values.
-     * @private
+     * @public
      * @param rootAttribute A key or array of keys to look up in the root element.
      * @returns The value if it could be found, `undefined` if nothing could be found.
      */
     getRootElementValue(rootAttribute: string[] | string | null): unknown;
     /**
-     * Set the value of the root element's attribute under the given keys.
+     * Sets the value of the root element's attribute under the given keys.
      * If given an array of keys, the value is found under repeated lookups to enable setting nested values.
      * If the root element has a function `updateInView()`, it is called upon successful setting of the value.
      * If the root element's attribute doesn't exist, it does nothing.
@@ -184,14 +186,14 @@ export declare class ValueSet {
      */
     setRootElementValue(rootAttribute: string[] | string | null, value: unknown): void;
     /**
-     * Obtain the value under the given key.
+     * Obtains the value under the given key.
      * @private
      * @param key A key.
      * @returns The value under the given key.
      */
     getValue(key: string): any;
     /**
-     * Obtain all the values in the set.
+     * Obtains all the values in the set.
      * @private
      * @returns An object containing all the values in the set.
      */
@@ -200,7 +202,6 @@ export declare class ValueSet {
     };
     /**
      * Returns the values for all keys present in the given object, including keys in sub-objects.
-     *
      * @private
      * @param values An object containing all values for keys present in the given object.
      */
@@ -210,40 +211,40 @@ export declare class ValueSet {
         [key: string]: unknown;
     };
     /**
-     * Obtain all CollabTimestamps in the set, including those corresponding to nested keys.
+     * Obtains all CollabTimestamps in the set, including those corresponding to nested keys.
      * @private
      * @returns An object containing all the CollabTimestamps in the set.
      */
     getTimestamps(): CollabTimestampSet;
     /**
-     * Check if the value under the key is not empty.
+     * Checks if the value under the key is not empty.
      * @private
      * @param key A key.
      * @returns `true` if the value under the key is empty, `false` otherwise.
      */
     hasValue(key: string): boolean;
     /**
-     * Check if the value under the key is not empty or the default value.
+     * Checks if the value under the key is not empty or the default value.
      * @private
      * @param key A key.
      * @returns `true` if the value under the key is not empty or the default value, `false` otherwise.
      */
     hasSetValue(key: string): boolean;
     /**
-     * Check if any of the values in the set are not empty or the default value.
+     * Checks if any of the values in the set are not empty or the default value.
      * @private
      * @returns `true` if any of the values in the set are not empty or the default value, `false` otherwise.
      */
     hasAnySetValue(): boolean;
     /**
-     * Set the value under the given key.
+     * Sets the value under the given key.
      * @private
      * @param key A key.
      * @param value A value.
      */
     setValue(key: string, value: unknown): void;
     /**
-     * Reset all values and then set them to the given values.
+     * Resets all values and then set them to the given values.
      * @private
      * @param values An object containing all values to set the values to.
      */
@@ -251,7 +252,7 @@ export declare class ValueSet {
         [key: string]: unknown;
     }): void;
     /**
-     * Reset all timestamps and then set them to the given timestamps.
+     * Resets all timestamps and then set them to the given timestamps.
      * @private
      * @param values An object containing all the CollabTimestamps in the set.
      */
@@ -265,7 +266,7 @@ export declare class ValueSet {
         [key: string]: unknown;
     }): void;
     /**
-     * Variant of overwriteValues that applies last-writer-wins to each key, updating timestamps if appropriate.
+     * Variant of `overwriteValues` that applies last-writer-wins to each key, updating timestamps if appropriate.
      * @private
      * @param values An object containing all values to set the values to.
      */
@@ -273,7 +274,7 @@ export declare class ValueSet {
         [key: string]: unknown;
     }, timestamp: CollabTimestamp): void;
     /**
-     * Set all the values of this set to the defaults.
+     * Sets all the values of this set to the defaults.
      * If this set has a root element and any of its properties have root attributes, the root element's attributes are also set to the property's default value if one is provided.
      * @private
      */
@@ -286,42 +287,50 @@ export declare class ValueSet {
      */
     private constructSubValueSet;
     /**
-     * Get the ValueSet under the given key when there are nested ValueSets.
+     * Gets the ValueSet under the given key when there are nested ValueSets.
      * @private
      * @param key A key.
      * @returns A ValueSet.
      */
     getSubValueSet(key: string): ValueSet;
     /**
-     * Move the given property to the list of displayed properties.
+     * Moves the given property to the list of displayed properties.
      * @private
      * @param property A property.
      */
     displayProperty(property: Property): void;
     /**
-     * Move the given property to the list of hidden properties.
+     * Moves the given property to the list of hidden properties.
      * @private
      * @param property A property.
      */
     hideProperty(property: Property): void;
 }
 /**
- * Check if the given value is not empty.
+ * Checks if the given value is not empty.
+ * @private
  * @param a A value.
  * @returns `true` if the given value is not `undefined`, `null`, `''`, `[]` or `{}`; `false` otherwise.
  */
 export declare const empty: (a: unknown) => boolean;
 /**
- * Check whether the given values are equal.
+ * Checks whether the given values are equal.
+ * @public
  * @param a A value.
  * @param b A value.
  * @returns `true` if the given values are equal, `false` otherwise.
  */
 export declare const equals: (a: unknown, b: unknown) => boolean;
 /**
- * Calculate the differences between the given objects and return two objects, each containing the keys for which the values are different in each argument, containing the different values.
- * @param a A dictionary.
- * @param b A dictionary.
+ * Calculates the differences between the two given objects and returns two objects containing the differences in each relative to the other.
+ *
+ * For each key that holds a different value in the two objects, the resulting objects will contain the differences in the values under that key.
+ *
+ * This function is recursive, that is, if the value under the key is an object, the function will be applied to that value recursively.
+ *
+ * @public
+ * @param a An object.
+ * @param b An object.
  * @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 diff: (a: {
@@ -333,4 +342,10 @@ export declare const diff: (a: {
 }, {
     [key: string]: unknown;
 }];
+/**
+ * Checks if the given value is an object.
+ * @public
+ * @param x A value.
+ * @returns `true` if the given value is an object, `false` otherwise.
+ */
 export declare const isObject: (x: unknown) => boolean;

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

@@ -1,6 +1,6 @@
 import { Point } from '../../util/canvas-util';
 import { Side } from '../../util/svg-util';
-import { NodeShapedLook, SectionConfig } from './diagram-config';
+import { NodeShapedLook, SectionConfig } from '../diagram-config';
 import { DiagramConnection } from './diagram-connection';
 import { DiagramDecorator } from './diagram-decorator';
 import { DiagramElement, DiagramElementSet } from './diagram-element';
@@ -10,14 +10,14 @@ import { DiagramNode } from './diagram-node';
 import { DiagramPort } from './diagram-port';
 /**
  * Default values of the look of a diagram section.
- * @see DIAGRAM_SECTION_DEFAULTS
  * @private
+ * @see DIAGRAM_SECTION_DEFAULTS
  */
 export declare const DIAGRAM_SECTION_LOOK_DEFAULTS: NodeShapedLook;
 /**
  * Default values of the parameters of a diagram section.
- * @see DiagramSection
  * @private
+ * @see DiagramSection
  */
 export declare const DIAGRAM_SECTION_DEFAULTS: {
     label: null;
@@ -27,26 +27,26 @@ export declare const DIAGRAM_SECTION_DEFAULTS: {
 };
 /**
  * Default value of the default width of a diagram section.
- * @see DiagramSection
  * @private
+ * @see DiagramSection
  */
 export declare const DIAGRAM_SECTION_DEFAULT_WIDTH = 1;
 /**
  * Default value of the default height of a diagram section.
- * @see DiagramSection
  * @private
+ * @see DiagramSection
  */
 export declare const DIAGRAM_SECTION_DEFAULT_HEIGHT = 1;
 /**
  * Default value of the minimum width of a diagram section.
- * @see DiagramSection
  * @private
+ * @see DiagramSection
  */
 export declare const DIAGRAM_SECTION_MIN_WIDTH = 1;
 /**
  * Default value of the minimum height of a diagram section.
- * @see DiagramSection
  * @private
+ * @see DiagramSection
  */
 export declare const DIAGRAM_SECTION_MIN_HEIGHT = 1;
 export type DiagramSectionGeometry = {
@@ -56,10 +56,10 @@ export type DiagramSectionGeometry = {
 };
 /**
  * A section of a node which can have connections and display a property of the node.
+ * @public
  * @see DiagramConnection
  * @see DiagramNode
  * @see DiagramPort
- * @public
  */
 export declare class DiagramSection extends DiagramElement {
     /**

package/{lib → src/lib}/errors/diagram-validator.d.ts

@@ -1,4 +1,4 @@
-import { DiagramModel } from '../diagram-editor/diagram/diagram-model';
+import { DiagramModel } from '../diagram/model/diagram-model';
 import { DiagramError } from './diagram-error';
 /**
  * A validator that checks for specific types of errors in a diagram.