@metadev/daga 1.2.0 → 1.3.1

package/lib/collapse-button/collapse-button.component.d.ts

@@ -1,6 +1,10 @@
 import { ElementRef } from '@angular/core';
 import { Side } from '../util/svg-util';
 import * as i0 from "@angular/core";
+/**
+ * Button used to collapse components that implement it.
+ * @private
+ */
 export declare class CollapseButtonComponent {
     collapsableSelector: string | ElementRef | HTMLElement;
     collapsableAdditionalSelector: string;

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

@@ -6,6 +6,7 @@ import * as i0 from "@angular/core";
 /**
  * The context of a diagram. Every separate diagram must be contained within its own {@link DiagramComponent} and every {@link DiagramComponent} must contain its own {@link DiagramEditorComponent}.
  * This component defines a {@link DagaConfigurationService} and a {@link CanvasProviderService}, which is shared by all the components within and allows accessing the configuration and the canvas of this component's diagram, respectively.
+ * @public
  */
 export declare class DiagramComponent implements OnInit {
     private configurationService;

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

@@ -3,6 +3,10 @@ import { Canvas } from '../interfaces/canvas';
 import { DiagramButtons } from '../interfaces/diagram-buttons';
 import { CanvasProviderService } from '../services/canvas-provider.service';
 import * as i0 from "@angular/core";
+/**
+ * Buttons used to trigger diagram functionalities by the user.
+ * @private
+ */
 export declare class DiagramButtonsComponent implements DiagramButtons {
     private canvasProvider;
     get canvas(): Canvas;

package/lib/diagram-editor/diagram/converters/daga-exporter.d.ts

@@ -1,6 +1,10 @@
 import { DiagramModel } from '../diagram-model';
 import { DagaModel } from './daga-model';
 import { DiagramModelExporter } from './diagram-model-exporter';
+/**
+ * Importer which exports a diagram to its daga model representation.
+ * @public
+ */
 export declare class DagaExporter implements DiagramModelExporter<DagaModel> {
     export(model: DiagramModel): DagaModel;
 }

package/lib/diagram-editor/diagram/converters/daga-importer.d.ts

@@ -1,6 +1,10 @@
 import { DiagramModel } from '../diagram-model';
 import { DagaModel } from './daga-model';
 import { DiagramModelImporter } from './diagram-model-importer';
+/**
+ * Importer which imports a diagram from its daga model representation.
+ * @public
+ */
 export declare class DagaImporter implements DiagramModelImporter<DagaModel> {
     import(model: DiagramModel, data: DagaModel): DiagramModel;
 }

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

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

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

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

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

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

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

@@ -8,29 +8,56 @@ import { DiagramNode, DiagramNodeType } from './diagram-node';
 import { DiagramPort } from './diagram-port';
 import { ValueSet } from './diagram-property';
 import { DiagramSection } from './diagram-section';
+/**
+ * A queue of recent actions taken by the user that can be undone and redone.
+ * @private
+ */
 export declare class ActionQueue {
+    /**
+     * Maximum number of actions that can be recorded simultaneously.
+     * When new actions are added past this limit, older actions are removed.
+     * @private
+     */
     maximum: number;
+    /**
+     * List of recorded actions, from oldest to newest.
+     * @private
+     */
     history: DiagramAction[];
-    /** Index of the last action not counting undone actions. One-indexed. Zero if all actions are undone. */
+    /**
+     * Index of the last action not counting undone actions. One-indexed. Zero if all actions are undone.
+     * @private
+     */
     index: number;
     constructor(maximum: number);
     /**
      * Adds an action to the history.
+     * @private
      */
     add(action: DiagramAction): void;
     /**
      * Undoes the last action in the history, not counting undone actions.
+     * @private
      */
     undo(): void;
     /**
      * Redoes the last undone action in the history.
+     * @private
      */
     redo(): void;
 }
+/**
+ * An action taken by the user that can be undone and redone.
+ * @private
+ */
 export interface DiagramAction {
     undo(): void;
     redo(): void;
 }
+/**
+ * Enum listing the actions that can be taken by the user.
+ * @private
+ */
 export declare enum DiagramActions {
     AddConnectionAction = "add-connection",
     AddNodeAction = "add-node",
@@ -41,6 +68,11 @@ export declare enum DiagramActions {
     StretchSectionAction = "stretch-section",
     UpdateValuesAction = "update-values"
 }
+/**
+ * Action which consists of adding a node.
+ * @see DiagramNode
+ * @private
+ */
 export declare class AddNodeAction implements DiagramAction {
     canvas: Canvas;
     type: DiagramNodeType;
@@ -62,6 +94,11 @@ export declare class AddNodeAction implements DiagramAction {
     undo(): void;
     redo(): void;
 }
+/**
+ * Action which consists of moving a node.
+ * @see DiagramNode
+ * @private
+ */
 export declare class MoveNodeAction implements DiagramAction {
     canvas: Canvas;
     nodeId: string;
@@ -71,6 +108,11 @@ export declare class MoveNodeAction implements DiagramAction {
     undo(): void;
     redo(): void;
 }
+/**
+ * Action which consists of changing the dimensions of a node in a given direction.
+ * @see DiagramNode
+ * @private
+ */
 export declare class StretchNodeAction implements DiagramAction {
     canvas: Canvas;
     nodeId: string;
@@ -81,6 +123,11 @@ export declare class StretchNodeAction implements DiagramAction {
     undo(): void;
     redo(): void;
 }
+/**
+ * Action which consists of changing the dimensions of a section in a given direction.
+ * @see DiagramSection
+ * @private
+ */
 export declare class StretchSectionAction implements DiagramAction {
     canvas: Canvas;
     sectionId: string;
@@ -91,6 +138,11 @@ export declare class StretchSectionAction implements DiagramAction {
     undo(): void;
     redo(): void;
 }
+/**
+ * Action which consists of adding a connection.
+ * @see DiagramConnection
+ * @private
+ */
 export declare class AddConnectionAction implements DiagramAction {
     canvas: Canvas;
     type: DiagramConnectionType;
@@ -101,6 +153,11 @@ export declare class AddConnectionAction implements DiagramAction {
     undo(): void;
     redo(): void;
 }
+/**
+ * Action which consists of editing the text of a field.
+ * @see DiagramField
+ * @private
+ */
 export declare class EditFieldAction implements DiagramAction {
     canvas: Canvas;
     fieldId: string;
@@ -110,6 +167,11 @@ export declare class EditFieldAction implements DiagramAction {
     undo(): void;
     redo(): void;
 }
+/**
+ * Action which consists of editing the values of a value set.
+ * @see ValueSet
+ * @private
+ */
 export declare class UpdateValuesAction implements DiagramAction {
     model: DiagramModel;
     id: string | undefined;
@@ -128,6 +190,10 @@ export declare class UpdateValuesAction implements DiagramAction {
     undo(): void;
     redo(): void;
 }
+/**
+ * Action which consists of removing elements from a diagram.
+ * @private
+ */
 export declare class RemoveAction implements DiagramAction {
     model: DiagramModel;
     nodes: DiagramNode[];

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

@@ -13,20 +13,24 @@ import { DiagramPort } from './diagram-port';
 import { ValueSet } from './diagram-property';
 /**
  * Thickness of the invisible path around a connection used to make it easier to click on, in pixels.
+ * @private
  */
 export declare const CONNECTION_PATH_BOX_THICKNESS = 12;
 /**
  * Thickness of the resizer line used to resize nodes and sections on drag, in pixels.
+ * @private
  */
 export declare const RESIZER_THICKNESS = 6;
 /**
  * Text to display as the title of the property editor when editing this diagram's properties.
  * @see PropertyEditorComponent
+ * @private
  */
 export declare const DIAGRAM_PROPERTIES_TEXT = "Diagram properties";
 /**
  * Maximum number of user actions that can be recorded in the user action queue.
  * @see ActionQueue
+ * @private
  */
 export declare const ACTION_QUEUE_SIZE = 25;
 export declare class DiagramCanvas implements Canvas {

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

@@ -6,6 +6,7 @@ import { DiagramActions } from './diagram-action';
 import { Property } from './diagram-property';
 /**
  * The configuration for a diagram.
+ * @public
  */
 export interface DiagramConfig {
     /**
@@ -63,9 +64,7 @@ export interface DiagramConfig {
      * Mapping of user actions to a boolean indicating whether the user can perform those actions. Absent values are assumed to be `true`.
      * @default {}
      */
-    userActions?: {
-        [key in DiagramActions]?: boolean;
-    };
+    userActions?: UserActionConfig;
     /**
      * Configuration for the palettes of this diagram. Each configuration provided will configure one palette, which will be displayed as one of the tabs in the palette component.
      * @see PaletteComponent
@@ -99,9 +98,17 @@ export interface DiagramConfig {
      */
     properties?: Property[];
 }
+/**
+ * Configuration for which user actions are allowed in a diagram.
+ * @public
+ */
+export type UserActionConfig = {
+    [key in DiagramActions]?: boolean;
+};
 /**
  * Configuration for a palette.
  * @see PaletteComponent
+ * @public
  */
 export interface PaletteConfig {
     /**
@@ -122,6 +129,7 @@ export interface PaletteConfig {
 /**
  * Configuration for a template of a node in a palette.
  * @see PaletteComponent
+ * @public
  */
 export interface NodeTemplateConfig {
     /**
@@ -146,6 +154,7 @@ export interface NodeTemplateConfig {
 /**
  * Configuration for a template of a connection in a palette.
  * @see PaletteComponent
+ * @public
  */
 export interface ConnectionTemplateConfig {
     /**
@@ -180,6 +189,7 @@ export interface ConnectionTemplateConfig {
 /**
  * Configuration for a type of node.
  * @see DiagramNodeType
+ * @public
  */
 export interface NodeTypeConfig {
     /**
@@ -260,6 +270,7 @@ export interface NodeTypeConfig {
 /**
  * Configuration for a field that is part of another element.
  * @see DiagramField
+ * @public
  */
 export interface FieldConfig {
     /**
@@ -312,6 +323,7 @@ export interface FieldConfig {
 /**
  * Configuration for a port that is part of another element.
  * @see DiagramPort
+ * @public
  */
 export interface PortConfig {
     /**
@@ -331,6 +343,7 @@ export interface PortConfig {
 /**
  * Configuration for the sections of a node.
  * @see DiagramSection
+ * @public
  */
 export interface SectionConfig {
     /**
@@ -376,6 +389,7 @@ export interface SectionConfig {
 }
 /**
  * Configuration for the look of a node given by shape and color.
+ * @public
  */
 export interface NodeShapedLook {
     /**
@@ -405,6 +419,7 @@ export interface NodeShapedLook {
 }
 /**
  * Configuration for the look of a node given by an image.
+ * @public
  */
 export interface NodeImageLook {
     /**
@@ -422,6 +437,7 @@ export interface NodeImageLook {
 }
 /**
  * Configuration for the look of a node given by fixed size images in the corners and stretchable images in the middle.
+ * @public
  */
 export interface NodeStretchableImageLook {
     /**
@@ -520,6 +536,7 @@ export interface NodeStretchableImageLook {
 /**
  * Configuration for a type of connection.
  * @see DiagramConnectionType
+ * @public
  */
 export interface ConnectionTypeConfig {
     /**
@@ -588,6 +605,7 @@ export interface ConnectionTypeConfig {
 }
 /**
  * Configuration for the look of the markers at the start and end of a connection.
+ * @public
  */
 export interface ConnectionMarkerLook {
     /**

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

@@ -6,6 +6,11 @@ import { DiagramElement, DiagramEntity, DiagramEntitySet } from './diagram-eleme
 import { DiagramModel } from './diagram-model';
 import { DiagramPort } from './diagram-port';
 import { PropertySet, ValueSet } from './diagram-property';
+/**
+ * Default values of the parameters of a diagram connection.
+ * @see DiagramConnection
+ * @private
+ */
 export declare const DIAGRAM_CONNECTION_TYPE_DEFAULTS: {
     name: string;
     width: number;
@@ -20,6 +25,11 @@ export declare const DIAGRAM_CONNECTION_TYPE_DEFAULTS: {
     selectedColor: string;
     properties: never[];
 };
+/**
+ * A connection type, which holds properties that connections of this type share in common.
+ * @see ConnectionTypeConfig
+ * @public
+ */
 export declare class DiagramConnectionType implements DiagramEntity {
     id: string;
     name: string;
@@ -38,22 +48,87 @@ export declare class DiagramConnectionType implements DiagramEntity {
     canStartFromType(type: string): boolean;
     canFinishOnType(type: string): boolean;
 }
+/**
+ * A connection which goes from one port to another.
+ * @see DiagramPort
+ * @public
+ */
 export declare class DiagramConnection extends DiagramElement {
     type: DiagramConnectionType;
+    /**
+     * Additional properties of this connection.
+     * @public
+     */
     valueSet: ValueSet;
+    /**
+     * Variable used to preserve the original data of a connection when importing from a different format.
+     * @public
+     */
     originalData: unknown;
+    /**
+     * Port that this connection starts from.
+     * @public
+     */
     start?: DiagramPort;
+    /**
+     * Direction that this connection follows at its start.
+     * @public
+     */
     startDirection?: Side;
+    /**
+     * Coordinates of the start point of this connection.
+     * @public
+     */
     startCoords: Point;
+    /**
+     * Look of the marker of this connection at the start, or `null` if the connection has no start marker.
+     * @public
+     */
     startMarkerLook: ConnectionMarkerLook | null;
+    /**
+     * Port that this connection ends at.
+     * @public
+     */
     end?: DiagramPort;
+    /**
+     * Direction that this connection follows at its end.
+     * @public
+     */
     endDirection?: Side;
+    /**
+     * Coordinates of the end point of this connection.
+     * @public
+     */
     endCoords: Point;
+    /**
+     * Look of the marker of this connection at the end, or `null` if the connection has no end marker.
+     * @public
+     */
     endMarkerLook: ConnectionMarkerLook | null;
+    /**
+     * Text at the start of this connection, or `''` if no text.
+     * @public
+     */
     startLabel: string;
+    /**
+     * Text at the middle of this connection, or `''` if no text.
+     * @public
+     */
     middleLabel: string;
+    /**
+     * Text at the end of this connection, or `''` if no text.
+     * @public
+     */
     endLabel: string;
+    /**
+     * Points that this connection passes through.
+     * @public
+     */
     points: Point[];
+    /**
+     * Name of this connection. Alias for this connection's middle label.
+     * @public
+     */
     get name(): string;
     set name(name: string);
     constructor(model: DiagramModel, type: DiagramConnectionType, start?: DiagramPort, end?: DiagramPort, id?: string);

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

@@ -2,92 +2,129 @@ import * as d3 from 'd3';
 import { DiagramModel } from './diagram-model';
 /**
  * Represents an object which exists as part of a diagram model.
+ * @public
  * @see DiagramModel
  */
 export interface DiagramEntity {
+    /**
+     * Identifier that uniquely identifies this entity within its diagram model.
+     * @public
+     */
     get id(): string;
-    set id(value: string);
 }
 /**
  * Represents an object which exists as part of a specific diagram model and has a visual representation in a diagram canvas.
+ * @public
  * @see DiagramModel
  * @see DiagramCanvas
  */
 export declare abstract class DiagramElement implements DiagramEntity {
+    /**
+     * Diagram model this diagram element is part of.
+     * @private
+     */
     model: DiagramModel;
-    _id: string;
+    private _id;
     get id(): string;
-    set id(value: string);
+    /**
+     * Whether this diagram element is currently highlighted by the user.
+     * @private
+     */
     highlighted: boolean;
+    /**
+     * Whether this diagram element is currently selected by the user.
+     * @private
+     */
     selected: boolean;
     constructor(model: DiagramModel, id: string);
+    /**
+     * Update the view of the canvas to show the current state of this element.
+     * @public
+     */
     abstract updateInView(): void;
     /**
      * Obtain the selection of this element.
+     * @private
      */
     select(): d3.Selection<SVGGElement, unknown, null, unknown> | undefined;
 }
 /**
  * Represents a collection of diagram entities of a type that exists as part of a diagram model.
+ * @public
  * @see DiagramEntity
  * @see DiagramModel
  */
 export declare class DiagramEntitySet<E extends DiagramEntity> implements Iterable<E> {
     /**
      * The list of entities contained in this set.
+     * @private
      */
     protected 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: {
         [id: string]: E;
     };
     /**
      * The number of entities of this set.
+     * @public
      */
     get length(): number;
     /**
      * Gets all of the entities of this set.
+     * @public
      * @returns An array containing all of the entities of this set.
      */
     all(): E[];
     /**
      * Adds an entity to this set if there are no entities with the same id. Has no effect if there already exists an entity with the same id as the given entity.
      * For creating entities with relationships with other entities, the new() method should be used instead. The add() method adds an entity but doesn't take care of setting that entity's relationships with other entities.
+     * @private
      * @param entity An entity to be added to this set.
      */
     add(entity: E): void;
     /**
      * Removes all the entities in this set.
+     * @public
      */
     clear(): void;
     /**
      * Checks if this set contains an entity with the given id.
+     * @public
      * @param id An id.
      * @returns `true` if this set contains an entity with the given id, `false` otherwise.
      */
     contains(id: string): boolean;
     /**
      * Gets all of the entities of this set filtered following given criteria.
+     * @public
      * @returns An array containing the entities of this set that meet the given criteria.
      */
     filter(): E[];
     /**
      * Gets an entity of this set matching specific criteria.
+     * @public
      * @returns An entity of this set.
      */
     find(): E | undefined;
     /**
      * Gets an entity from this set.
+     * @public
      * @param id An id.
      * @returns An entity with the given id, or `undefined` if there are no entities with the given id.
      */
     get(id: string): E | undefined;
     /**
      * Attempts to find and remove an entity with the given id. Has no effect if there are no entities with the given id.
+     * @public
      * @param id An id.
      */
     remove(id: string): void;
+    /**
+     * Iterator to iterate over the entities of this set.
+     * @public
+     */
     [Symbol.iterator](): Iterator<E>;
 }