@metadev/daga 1.1.0 → 1.3.0

package/index.d.ts

@@ -7,16 +7,17 @@ export { DagaImporter } from './lib/diagram-editor/diagram/converters/daga-impor
 export { DagaModel } from './lib/diagram-editor/diagram/converters/daga-model';
 export { DiagramModelExporter } from './lib/diagram-editor/diagram/converters/diagram-model-exporter';
 export { DiagramModelImporter } from './lib/diagram-editor/diagram/converters/diagram-model-importer';
-export { ActionQueue, AddConnectionAction, AddNodeAction, DiagramAction, EditFieldAction, MoveNodeAction, RemoveAction, StretchNodeAction, UpdateValuesAction } from './lib/diagram-editor/diagram/diagram-action';
+export { ActionQueue, AddConnectionAction, AddNodeAction, DiagramAction, DiagramActions, EditFieldAction, MoveNodeAction, RemoveAction, StretchNodeAction, UpdateValuesAction } from './lib/diagram-editor/diagram/diagram-action';
 export { ACTION_QUEUE_SIZE, DiagramCanvas } from './lib/diagram-editor/diagram/diagram-canvas';
-export { DiagramConfig } from './lib/diagram-editor/diagram/diagram-config';
-export { DiagramConnection, DiagramConnectionType } from './lib/diagram-editor/diagram/diagram-connection';
-export { DiagramElement, DiagramEntity } from './lib/diagram-editor/diagram/diagram-element';
-export { DiagramField } from './lib/diagram-editor/diagram/diagram-field';
+export { ConnectionMarkerLook, ConnectionTemplateConfig, ConnectionTypeConfig, DiagramConfig, FieldConfig, NodeImageLook, NodeShapedLook, NodeStretchableImageLook, NodeTemplateConfig, NodeTypeConfig, PaletteConfig, PortConfig, SectionConfig } from './lib/diagram-editor/diagram/diagram-config';
+export { DiagramConnection, DiagramConnectionSet, DiagramConnectionType } from './lib/diagram-editor/diagram/diagram-connection';
+export { DiagramElement, DiagramEntity, DiagramEntitySet } from './lib/diagram-editor/diagram/diagram-element';
+export { DiagramField, DiagramFieldSet } from './lib/diagram-editor/diagram/diagram-field';
 export { DiagramModel } from './lib/diagram-editor/diagram/diagram-model';
-export { DiagramNode, DiagramNodeType } from './lib/diagram-editor/diagram/diagram-node';
-export { DiagramPort } from './lib/diagram-editor/diagram/diagram-port';
+export { DiagramNode, DiagramNodeSet, DiagramNodeType } from './lib/diagram-editor/diagram/diagram-node';
+export { DiagramPort, DiagramPortSet } from './lib/diagram-editor/diagram/diagram-port';
 export { Property, PropertySet, Type, ValueSet } from './lib/diagram-editor/diagram/diagram-property';
+export { DiagramSection, DiagramSectionSet } from './lib/diagram-editor/diagram/diagram-section';
 export { AdjacencyLayout } from './lib/diagram-editor/diagram/layout/adjacency-layout';
 export { BreadthAdjacencyLayout } from './lib/diagram-editor/diagram/layout/breadth-adjacency-layout';
 export { BreadthLayout } from './lib/diagram-editor/diagram/layout/breadth-layout';
@@ -30,6 +31,10 @@ export { DiagramError } from './lib/errors/diagram-error';
 export { DiagramValidator } from './lib/errors/diagram-validator';
 export { ErrorsComponent } from './lib/errors/errors.component';
 export { Canvas } from './lib/interfaces/canvas';
+export { DiagramButtons } from './lib/interfaces/diagram-buttons';
+export { DiagramEditor } from './lib/interfaces/diagram-editor';
+export { Palette } from './lib/interfaces/palette';
+export { PropertyEditor } from './lib/interfaces/property-editor';
 export { ObjectEditorComponent } from './lib/object-editor/object-editor.component';
 export { PaletteComponent } from './lib/palette/palette.component';
 export { PropertyEditorComponent } from './lib/property-editor/property-editor.component';
@@ -37,3 +42,7 @@ export { CanvasProviderService } from './lib/services/canvas-provider.service';
 export { DagaConfigurationService } from './lib/services/daga-configuration.service';
 export { TextListEditorComponent } from './lib/text-list-editor/text-list-editor.component';
 export { TextMapEditorComponent } from './lib/text-map-editor/text-map-editor.component';
+export { Line, Point, Rectangle } from './lib/util/canvas-util';
+export { LineShape, LineStyle } from './lib/util/line';
+export { ClosedShape } from './lib/util/shape';
+export { Corner, HorizontalAlign, Side, VerticalAlign } from './lib/util/svg-util';

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;
@@ -12,6 +16,7 @@ export declare class CollapseButtonComponent {
     visibleValue: string;
     Side: typeof Side;
     toggleCollapse(): void;
+    getClass(): string;
     static ɵfac: i0.ɵɵFactoryDeclaration<CollapseButtonComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<CollapseButtonComponent, "daga-collapse-button", never, { "collapsableSelector": { "alias": "collapsableSelector"; "required": false; }; "collapsableAdditionalSelector": { "alias": "collapsableAdditionalSelector"; "required": false; }; "collapsed": { "alias": "collapsed"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "direction": { "alias": "direction"; "required": false; }; "rule": { "alias": "rule"; "required": false; }; "collapsedValue": { "alias": "collapsedValue"; "required": false; }; "visibleValue": { "alias": "visibleValue"; "required": false; }; }, {}, never, never, true, never>;
 }

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,71 @@ 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",
+    EditFieldAction = "edit-field",
+    MoveNodeAction = "move-node",
+    RemoveAction = "remove",
+    StretchNodeAction = "stretch-node",
+    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;
@@ -52,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;
@@ -61,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;
@@ -71,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;
@@ -81,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;
@@ -91,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;
@@ -100,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;
@@ -118,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[];
@@ -134,4 +210,3 @@ export declare class RemoveAction implements DiagramAction {
     undo(): void;
     redo(): void;
 }
-export declare const clone: <T extends object | null | undefined>(obj: T) => T;

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

@@ -4,7 +4,7 @@ import { DiagramValidator } from '../../errors/diagram-validator';
 import { Canvas } from '../../interfaces/canvas';
 import { DiagramEditor } from '../../interfaces/diagram-editor';
 import { Point } from '../../util/canvas-util';
-import { ActionQueue } from './diagram-action';
+import { ActionQueue, DiagramActions } from './diagram-action';
 import { DiagramConfig } from './diagram-config';
 import { DiagramConnection, DiagramConnectionType } from './diagram-connection';
 import { DiagramElement } from './diagram-element';
@@ -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 {
@@ -42,6 +46,9 @@ export declare class DiagramCanvas implements Canvas {
     priorityThresholds: number[];
     validators: DiagramValidator[];
     layoutFormat?: string;
+    userActions: {
+        [key in DiagramActions]?: boolean;
+    };
     actionQueue: ActionQueue;
     private static canvasCount;
     private backgroundPatternId;

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

@@ -2,9 +2,11 @@ import { Point } from '../../util/canvas-util';
 import { LineShape, LineStyle } from '../../util/line';
 import { ClosedShape } from '../../util/shape';
 import { HorizontalAlign, Side, VerticalAlign } from '../../util/svg-util';
+import { DiagramActions } from './diagram-action';
 import { Property } from './diagram-property';
 /**
  * The configuration for a diagram.
+ * @public
  */
 export interface DiagramConfig {
     /**
@@ -58,6 +60,11 @@ export interface DiagramConfig {
      * @default undefined
      */
     layoutFormat?: string;
+    /**
+     * Mapping of user actions to a boolean indicating whether the user can perform those actions. Absent values are assumed to be `true`.
+     * @default {}
+     */
+    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
@@ -91,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 {
     /**
@@ -114,6 +129,7 @@ export interface PaletteConfig {
 /**
  * Configuration for a template of a node in a palette.
  * @see PaletteComponent
+ * @public
  */
 export interface NodeTemplateConfig {
     /**
@@ -138,6 +154,7 @@ export interface NodeTemplateConfig {
 /**
  * Configuration for a template of a connection in a palette.
  * @see PaletteComponent
+ * @public
  */
 export interface ConnectionTemplateConfig {
     /**
@@ -172,6 +189,7 @@ export interface ConnectionTemplateConfig {
 /**
  * Configuration for a type of node.
  * @see DiagramNodeType
+ * @public
  */
 export interface NodeTypeConfig {
     /**
@@ -252,6 +270,7 @@ export interface NodeTypeConfig {
 /**
  * Configuration for a field that is part of another element.
  * @see DiagramField
+ * @public
  */
 export interface FieldConfig {
     /**
@@ -304,6 +323,7 @@ export interface FieldConfig {
 /**
  * Configuration for a port that is part of another element.
  * @see DiagramPort
+ * @public
  */
 export interface PortConfig {
     /**
@@ -323,6 +343,7 @@ export interface PortConfig {
 /**
  * Configuration for the sections of a node.
  * @see DiagramSection
+ * @public
  */
 export interface SectionConfig {
     /**
@@ -368,6 +389,7 @@ export interface SectionConfig {
 }
 /**
  * Configuration for the look of a node given by shape and color.
+ * @public
  */
 export interface NodeShapedLook {
     /**
@@ -397,6 +419,7 @@ export interface NodeShapedLook {
 }
 /**
  * Configuration for the look of a node given by an image.
+ * @public
  */
 export interface NodeImageLook {
     /**
@@ -414,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 {
     /**
@@ -512,6 +536,7 @@ export interface NodeStretchableImageLook {
 /**
  * Configuration for a type of connection.
  * @see DiagramConnectionType
+ * @public
  */
 export interface ConnectionTypeConfig {
     /**
@@ -580,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);