@metadev/daga 1.2.0 → 1.3.0

package/lib/diagram-editor/diagram/diagram-field.d.ts

@@ -5,6 +5,11 @@ import { DiagramModel } from './diagram-model';
 import { DiagramNode } from './diagram-node';
 import { DiagramPort } from './diagram-port';
 import { DiagramSection } from './diagram-section';
+/**
+ * Default values of the parameters of a diagram field.
+ * @see DiagramField
+ * @private
+ */
 export declare const DIAGRAM_FIELD_DEFAULTS: {
     editable: boolean;
     fontSize: number;
@@ -16,21 +21,80 @@ export declare const DIAGRAM_FIELD_DEFAULTS: {
     horizontalAlign: HorizontalAlign;
     verticalAlign: VerticalAlign;
 };
+/**
+ * A field which displays text and is part of a diagram element.
+ * @see DiagramNode
+ * @see DiagramPort
+ * @see DiagramSection
+ * @public
+ */
 export declare class DiagramField extends DiagramElement {
+    /**
+     * Element that this field belongs to.
+     * @public
+     */
     rootElement?: DiagramNode | DiagramSection | DiagramPort;
+    /**
+     * Coordinates of this field.
+     * @public
+     */
     coords: Point;
+    /**
+     * Dimension of this field along the x axis.
+     * @public
+     */
     width: number;
+    /**
+     * Dimension of this field along the y axis.
+     * @public
+     */
     height: number;
+    /**
+     * Font size of this field.
+     * @public
+     */
     fontSize: number;
+    /**
+     * Font family of this field. `null` for the default one.
+     * @public
+     */
     fontFamily: string | null;
+    /**
+     * Font color of this field.
+     * @public
+     */
     color: string;
+    /**
+     * Font color of this field when selected.
+     * @public
+     */
     selectedColor: string;
+    /**
+     * Horizontal alignment of the text of this field.
+     * @public
+     */
     horizontalAlign: HorizontalAlign;
+    /**
+     * Vertical alignment of the text of this field.
+     * @public
+     */
     verticalAlign: VerticalAlign;
     private _text;
+    /**
+     * Default text that this field's text resets to when empty.
+     * @public
+     */
     defaultText: string;
+    /**
+     * Text contents of this field.
+     * @public
+     */
     get text(): string;
     set text(value: string);
+    /**
+     * Whether this field's text can be edited by the user.
+     * @public
+     */
     editable: boolean;
     constructor(model: DiagramModel, rootElement: DiagramNode | DiagramSection | DiagramPort | undefined, coords: Point, width: number, height: number, fontSize: number, fontFamily: string | null, color: string, selectedColor: string, horizontalAlign: HorizontalAlign, verticalAlign: VerticalAlign, text: string, editable: boolean, id?: string);
     updateInView(): void;

package/lib/diagram-editor/diagram/diagram-model.d.ts

@@ -5,28 +5,101 @@ import { DiagramNodeSet } from './diagram-node';
 import { DiagramPortSet } from './diagram-port';
 import { Property, ValueSet } from './diagram-property';
 import { DiagramSectionSet } from './diagram-section';
+/**
+ * Stores the data of a diagram.
+ * @public
+ */
 export declare class DiagramModel {
+    /**
+     * The canvas where this model's data is being rendered.
+     * @private
+     */
     canvas?: Canvas;
+    /**
+     * Whether changes to this model are updated in the canvas in real time.
+     * @private
+     */
     renderToCanvas: boolean;
+    /**
+     * Nodes of this model.
+     * @see DiagramNode
+     * @public
+     */
     nodes: DiagramNodeSet;
+    /**
+     * Sections of this model.
+     * @see DiagramSection
+     * @public
+     */
     sections: DiagramSectionSet;
+    /**
+     * Ports of this model.
+     * @see DiagramPort
+     * @public
+     */
     ports: DiagramPortSet;
+    /**
+     * Connections of this model.
+     * @see DiagramConnection
+     * @public
+     */
     connections: DiagramConnectionSet;
+    /**
+     * Fields of this model.
+     * @see DiagramField
+     * @public
+     */
     fields: DiagramFieldSet;
+    /**
+     * Identifier of this diagram. Set by the consumer of the diagram.
+     * @public
+     */
     id: string | undefined;
+    /**
+     * Name of this diagram. Set by the consumer of the diagram.
+     * @public
+     */
     name: string;
+    /**
+     * Description of this diagram. Set by the consumer of the diagram.
+     * @public
+     */
     description?: string;
+    /**
+     * Type of this diagram. Set by the consumer of the diagram.
+     * @public
+     */
     type: string;
+    /**
+     * Date of creation of this diagram. Set at the creation of the diagram.
+     * @public
+     */
     createdAt: Date;
+    /**
+     * Date of last changes of this diagram. Set by the consumer of the diagram.
+     * @public
+     */
     updatedAt: Date;
+    /**
+     * Additional properties of this diagram.
+     * @public
+     */
     valueSet: ValueSet;
-    get layoutFormat(): string | undefined;
-    set layoutFormat(value: string | undefined);
     constructor(canvas: Canvas | undefined, id: string | undefined, name: string, description: string | undefined, type: string, properties?: Property[]);
+    /**
+     * Enables rendering to canvas in real time and updates the view of this model in the canvas.
+     * @public
+     */
     enableRenderToCanvas(): void;
+    /**
+     * Disables rendering to canvas in real time.
+     * Used to perform batches of changes to the model without the computational cost of rendering each change to the canvas individually.
+     * @public
+     */
     disableRenderToCanvas(): void;
     /**
      * Deletes everything in this diagram.
+     * @public
      */
     clear(): void;
 }

package/lib/diagram-editor/diagram/diagram-node.d.ts

@@ -8,7 +8,17 @@ import { DiagramModel } from './diagram-model';
 import { DiagramPort } from './diagram-port';
 import { PropertySet, ValueSet } from './diagram-property';
 import { DiagramSection } from './diagram-section';
+/**
+ * Default values of the look of a diagram node.
+ * @see DIAGRAM_NODE_TYPE_DEFAULTS
+ * @private
+ */
 export declare const DIAGRAM_NODE_LOOK_DEFAULTS: NodeShapedLook;
+/**
+ * Default values of the parameters of a diagram node.
+ * @see DiagramNode
+ * @private
+ */
 export declare const DIAGRAM_NODE_TYPE_DEFAULTS: {
     name: string;
     defaultWidth: number;
@@ -25,6 +35,11 @@ export declare const DIAGRAM_NODE_TYPE_DEFAULTS: {
     priority: number;
     properties: never[];
 };
+/**
+ * A node type, which holds properties that nodes of this type share in common.
+ * @see NodeTypeConfig
+ * @public
+ */
 export declare class DiagramNodeType implements DiagramEntity {
     id: string;
     name: string;
@@ -43,16 +58,59 @@ export declare class DiagramNodeType implements DiagramEntity {
     propertySet: PropertySet;
     constructor(options: NodeTypeConfig);
 }
+/**
+ * A node, the most basic element of a diagram, which can have connections to other nodes through its ports or be divided into sections.
+ * @see DiagramConnection
+ * @see DiagramPort
+ * @see DiagramSection
+ * @public
+ */
 export declare class DiagramNode extends DiagramElement {
     type: DiagramNodeType;
+    /**
+     * Additional properties of this node.
+     * @public
+     */
     valueSet: ValueSet;
+    /**
+     * Variable used to preserve the original data of a node when importing from a different format.
+     * @public
+     */
     originalData: unknown;
+    /**
+     * Label of this node.
+     * @public
+     */
     label?: DiagramField;
+    /**
+     * Sections of this node.
+     * @public
+     */
     sections: DiagramSection[];
+    /**
+     * Ports of this node.
+     * @public
+     */
     ports: DiagramPort[];
+    /**
+     * Coordinates of the top left corner of this node.
+     * @public
+     */
     coords: Point;
+    /**
+     * Dimension of this node along the x axis.
+     * @public
+     */
     width: number;
+    /**
+     * Dimension of this node along the y axis.
+     * @public
+     */
     height: number;
+    /**
+     * Name of this node. Alias for this node's label's text.
+     * @public
+     */
     get name(): string;
     set name(name: string);
     constructor(model: DiagramModel, type: DiagramNodeType, coords?: Point, id?: string);

package/lib/diagram-editor/diagram/diagram-port.d.ts

@@ -6,17 +6,53 @@ import { DiagramField } from './diagram-field';
 import { DiagramModel } from './diagram-model';
 import { DiagramNode } from './diagram-node';
 import { DiagramSection } from './diagram-section';
+/**
+ * Default values of the parameters of a diagram port.
+ * @see DiagramPort
+ * @private
+ */
 export declare const DIAGRAM_PORT_DEFAULTS: {
     radius: number;
     highlightedColor: string;
     selectedColor: string;
 };
+/**
+ * A port which is part of a node or section and at which connections can start or end.
+ * @see DiagramConnection
+ * @see DiagramNode
+ * @see DiagramSection
+ * @public
+ */
 export declare class DiagramPort extends DiagramElement {
+    /**
+     * Element that this port belongs to.
+     * @public
+     */
     rootElement?: DiagramNode | DiagramSection;
+    /**
+     * Label of this port.
+     * @public
+     */
     label?: DiagramField;
+    /**
+     * Direction of the connections of this port at the coordinates of this port.
+     * @public
+     */
     direction: Side;
+    /**
+     * Coordinates of this port.
+     * @public
+     */
     coords: Point;
+    /**
+     * Connections that start at this port.
+     * @public
+     */
     outgoingConnections: DiagramConnection[];
+    /**
+     * Connections that end at this port.
+     * @public
+     */
     incomingConnections: DiagramConnection[];
     constructor(model: DiagramModel, rootElement: DiagramNode | DiagramSection | undefined, coords: Point, direction: Side, id?: string);
     updateInView(): void;

package/lib/diagram-editor/diagram/diagram-property.d.ts

@@ -1,4 +1,10 @@
 import { DataSource } from '@metadev/lux';
+/**
+ * A property which is part of a property set and defines what values a value in a value set can take.
+ * @see PropertySet
+ * @see ValueSet
+ * @private
+ */
 export declare class Property {
     /**
      * The name of this property. Used to distinguish this property from others.
@@ -29,13 +35,18 @@ export declare class Property {
      * The list of possible values if the value of the property is chosen from a set of possible values. Undefined otherwise.
      * @default undefined
      */
-    options?: DataSource<string, string>;
+    options?: DataSource<unknown, string>;
     /**
      * The list of properties that are part of this property if the type of this property is 'object'.
      */
     properties?: Property[];
     constructor(name: string, type: Type, defaultValue: unknown, basic: boolean, editable: boolean, rootAttribute: string[] | string | null);
 }
+/**
+ * The type that a property can hvae..
+ * @see Property
+ * @private
+ */
 export declare enum Type {
     /**
      * A type whose value must be a boolean.
@@ -90,6 +101,12 @@ export declare enum Type {
      */
     Url = "url"
 }
+/**
+ * A set of properties based on which a set of values of those properties can be created.
+ * @see Property
+ * @see ValueSet
+ * @private
+ */
 export declare class PropertySet {
     propertyMap: {
         [key: string]: Property;
@@ -99,6 +116,11 @@ export declare class PropertySet {
     getProperty(key: string): Property;
     hasProperties(): boolean;
 }
+/**
+ * A set of values corresponding to a set of properties.
+ * @see PropertySet
+ * @private
+ */
 export declare class ValueSet {
     rootElement: {
         [key: string]: unknown;
@@ -137,5 +159,4 @@ export declare class ValueSet {
     constructSubValueSet(key: string): ValueSet;
     getSubValueSet(key: string): ValueSet;
 }
-export declare const empty: (a: unknown) => boolean;
 export declare const equals: (a: unknown, b: unknown) => boolean;

package/lib/diagram-editor/diagram/diagram-section.d.ts

@@ -7,7 +7,17 @@ import { DiagramField } from './diagram-field';
 import { DiagramModel } from './diagram-model';
 import { DiagramNode } from './diagram-node';
 import { DiagramPort } from './diagram-port';
+/**
+ * Default values of the look of a diagram section.
+ * @see DIAGRAM_SECTION_DEFAULTS
+ * @private
+ */
 export declare const DIAGRAM_SECTION_LOOK_DEFAULTS: NodeShapedLook;
+/**
+ * Default values of the parameters of a diagram section.
+ * @see DiagramSection
+ * @private
+ */
 export declare const DIAGRAM_SECTION_DEFAULTS: {
     sectionsX: number;
     sectionsY: number;
@@ -18,13 +28,48 @@ export declare const DIAGRAM_SECTION_DEFAULTS: {
     ports: never[];
     look: NodeShapedLook;
 };
+/**
+ * A section of a node which can have connections and display a property of the node.
+ * @see DiagramConnection
+ * @see DiagramNode
+ * @see DiagramPort
+ * @public
+ */
 export declare class DiagramSection extends DiagramElement {
+    /**
+     * Node that this section belongs to.
+     * @public
+     */
     node?: DiagramNode;
+    /**
+     * Label of this section.
+     * @public
+     */
     label?: DiagramField;
+    /**
+     * Ports of this section.
+     * @public
+     */
     ports: DiagramPort[];
+    /**
+     * Coordinates of the top left corner of this section.
+     * @public
+     */
     coords: Point;
+    /**
+     * Dimension of this section along the x axis.
+     * @public
+     */
     width: number;
+    /**
+     * Dimension of this section along the y axis.
+     * @public
+     */
     height: number;
+    /**
+     * Name of this section. Alias for this section's label's text.
+     * @public
+     */
     get name(): string;
     set name(name: string);
     constructor(model: DiagramModel, node: DiagramNode | undefined, coords: Point, width: number, height: number, id?: string);

package/lib/diagram-editor/diagram/layout/adjacency-layout.d.ts

@@ -2,6 +2,7 @@ import { DiagramModel } from '../diagram-model';
 import { DiagramLayout } from './diagram-layout';
 /**
  * A layout which places adjacent nodes close by, placing nodes in order according to depth first search.
+ * @public
  */
 export declare class AdjacencyLayout implements DiagramLayout {
     apply(model: DiagramModel): DiagramModel;

package/lib/diagram-editor/diagram/layout/breadth-adjacency-layout.d.ts

@@ -2,6 +2,7 @@ import { DiagramModel } from '../diagram-model';
 import { DiagramLayout } from './diagram-layout';
 /**
  * A layout which places adjacent nodes close by, placing nodes in order according to breadth first search.
+ * @public
  */
 export declare class BreadthAdjacencyLayout implements DiagramLayout {
     apply(model: DiagramModel): DiagramModel;

package/lib/diagram-editor/diagram/layout/breadth-layout.d.ts

@@ -1,8 +1,8 @@
 import { DiagramModel } from '../diagram-model';
 import { DiagramLayout } from './diagram-layout';
 /**
- * A layout which arranges the nodes by a breadth first search system,
- * according to their distance to the first node in the list.
+ * A layout which arranges the nodes by a breadth first search system according to their distance to the first node in the list.
+ * @public
  */
 export declare class BreadthLayout implements DiagramLayout {
     apply(model: DiagramModel): DiagramModel;

package/lib/diagram-editor/diagram/layout/diagram-layout.d.ts

@@ -1,10 +1,18 @@
 import { DiagramModel } from '../diagram-model';
+/**
+ * A layout algorithm that can be applied to a diagram.
+ * @public
+ */
 export interface DiagramLayout {
     /**
      * Rearranges the diagram elements of the given model according to a layout algorithm.
+     * @public
      */
     apply(model: DiagramModel): DiagramModel;
 }
+/**
+ * Mapping of available layout algorithms.
+ */
 export declare const layouts: {
     [key: string]: DiagramLayout;
 };

package/lib/diagram-editor/diagram/layout/force-layout.d.ts

@@ -2,6 +2,7 @@ import { DiagramModel } from '../diagram-model';
 import { DiagramLayout } from './diagram-layout';
 /**
  * A layout which attracts connected nodes and repels unconnected nodes.
+ * @public
  */
 export declare class ForceLayout implements DiagramLayout {
     apply(model: DiagramModel): DiagramModel;

package/lib/diagram-editor/diagram/layout/horizontal-layout.d.ts

@@ -2,6 +2,7 @@ import { DiagramModel } from '../diagram-model';
 import { DiagramLayout } from './diagram-layout';
 /**
  * A layout which arranges all the nodes in a horizontal line.
+ * @public
  */
 export declare class HorizontalLayout implements DiagramLayout {
     apply(model: DiagramModel): DiagramModel;

package/lib/diagram-editor/diagram/layout/priority-layout.d.ts

@@ -2,6 +2,7 @@ import { DiagramModel } from '../diagram-model';
 import { DiagramLayout } from './diagram-layout';
 /**
  * A layout which arranges the nodes by their priority first.
+ * @public
  */
 export declare class PriorityLayout implements DiagramLayout {
     apply(model: DiagramModel): DiagramModel;

package/lib/diagram-editor/diagram/layout/vertical-layout.d.ts

@@ -2,6 +2,7 @@ import { DiagramModel } from '../diagram-model';
 import { DiagramLayout } from './diagram-layout';
 /**
  * A layout which arranges all the nodes in a vertical line.
+ * @public
  */
 export declare class VerticalLayout implements DiagramLayout {
     apply(model: DiagramModel): DiagramModel;

package/lib/diagram-editor/diagram-editor.component.d.ts

@@ -9,6 +9,10 @@ import { CanvasProviderService } from '../services/canvas-provider.service';
 import { DagaConfigurationService } from '../services/daga-configuration.service';
 import { Corner } from '../util/svg-util';
 import * as i0 from "@angular/core";
+/**
+ * A diagram's user interface editor.
+ * @private
+ */
 export declare class DiagramEditorComponent implements AfterViewInit, DiagramEditor, OnInit {
     private configurationService;
     private canvasProvider;

package/lib/errors/diagram-error.d.ts

@@ -1,5 +1,24 @@
+/**
+ * An error in a diagram detected by a diagram validator.
+ * @see DiagramValidator
+ * @public
+ */
 export interface DiagramError {
+    /**
+     * Error message to be displayed to the user.
+     * @public
+     */
     message: string;
+    /**
+     * If applicable, id of the diagram element which contains this error.
+     * @see DiagramElement
+     * @public
+     */
     elementId?: string;
+    /**
+     * If applicable, list of keys under which to find the property which contains this error in the value set which contains this error.
+     * @see ValueSet
+     * @public
+     */
     propertyNames?: string[];
 }

package/lib/errors/diagram-validator.d.ts

@@ -1,8 +1,13 @@
 import { DiagramModel } from '../diagram-editor/diagram/diagram-model';
 import { DiagramError } from './diagram-error';
+/**
+ * A validator that checks for specific types of errors in a diagram.
+ * @public
+ */
 export interface DiagramValidator {
     /**
-     * Checks the model and returns any list of errors the diagram has.
+     * Checks a diagram model and returns the list of errors detected.
+     * @public
      */
     validate(model: DiagramModel): DiagramError[];
 }

package/lib/errors/errors.component.d.ts

@@ -5,6 +5,11 @@ import { CanvasProviderService } from '../services/canvas-provider.service';
 import { Side } from '../util/svg-util';
 import { DiagramError } from './diagram-error';
 import * as i0 from "@angular/core";
+/**
+ * Displays the errors detected by a diagram's validators.
+ * @see DiagramValidator
+ * @private
+ */
 export declare class ErrorsComponent implements AfterViewInit {
     private canvasProvider;
     get canvas(): Canvas;