@metadev/daga 1.2.0 → 1.3.1

package/lib/util/grid.d.ts

@@ -1,19 +1,62 @@
 import { Point } from './canvas-util';
+/**
+ * A two dimensional array of elements of the given class that can extend infinitely in any direction, both positive and negative.
+ * @private
+ */
 export declare class Grid<T> {
-    grid: (T | undefined)[][];
-    offsetX: number;
-    offsetY: number;
+    private grid;
+    private offsetX;
+    private offsetY;
+    /**
+     * Get the minimum x coordinate among the elements in the grid.
+     */
     minX(): number;
+    /**
+     * Get the maximum x coordinate among the elements in the grid.
+     */
     maxX(): number;
+    /**
+     * Get the minimum y coordinate among the elements in the grid.
+     */
     minY(): number;
+    /**
+     * Get the maximum y coordinate among the elements in the grid.
+     */
     maxY(): number;
+    /**
+     * Get the total extension of the grid along the x axis.
+     */
     width(): number;
+    /**
+     * Get the total extension of the grid along the y axis.
+     */
     height(): number;
+    /**
+     * Add a new column at the start of the x axis.
+     */
     addColumnLeft(): void;
+    /**
+     * Add a new column at the end of the x axis.
+     */
     addColumnRight(): void;
+    /**
+     * Add a new row at the start of the y axis.
+     */
     addRowTop(): void;
+    /**
+     * Add a new row at the end of the y axis.
+     */
     addRowBottom(): void;
+    /**
+     * Get the element at the given coordinates or undefined if there is no element at the given coordinates.
+     */
     get(coords: Point): T | undefined;
+    /**
+     * Set the element at the given coordinates to the given element.
+     */
     set(coords: Point, value: T | undefined): void;
-    getClosestEmptyCoordinate(coords: Point): [number, number];
+    /**
+     * Get the closest coordinates to the given coordinates that are not set to an element.
+     */
+    getClosestEmptyCoordinate(coords: Point): Point;
 }

package/lib/util/line.d.ts

@@ -1,15 +1,59 @@
 import { Point } from './canvas-util';
 import { Side } from './svg-util';
+/**
+ * An enumeration of the possible shapes of a line.
+ * @public
+ */
 export declare enum LineShape {
+    /**
+     * A line that goes between its points taking the shortest euclidean distance.
+     * @public
+     */
     Straight = "straight",
+    /**
+     * A line that goes between its points using bezier splines.
+     * @public
+     */
     Bezier = "bezier",
+    /**
+     * A line that goes between its points moving parallel to the axes of coordinates.
+     * @public
+     */
     Square = "square"
 }
+/**
+ * An enumeration of the possible styles of a line.
+ * @public
+ */
 export declare enum LineStyle {
+    /**
+     * A solid uninterrupted line.
+     * @public
+     */
     Solid = "solid",
+    /**
+     * A dashed line with little separation between the dashes.
+     * @public
+     */
     Dashed = "dashed",
+    /**
+     * A dashed line with wide gaps between the dashes.
+     * @public
+     */
     GappedDashes = "gapped-dashes",
+    /**
+     * A dotted line.
+     * @public
+     */
     Dotted = "dotted"
 }
+/**
+ * Calculates the path of an SVG line with the given parameters.
+ * @private
+ */
 export declare const linePath: (shape: LineShape, points: Point[], startDirection?: Side | undefined, endDirection?: Side | undefined, minimumDistanceBeforeTurn?: number) => string;
+/**
+ * Calculates the dasharray property of an SVG line corresponding to the given line style and width.
+ * @private
+ */
 export declare const lineStyleDasharray: (style: LineStyle, width: number) => string;

package/lib/util/list-util.d.ts

@@ -1,2 +1,16 @@
+/**
+ * Removes the given element from the array if it exists within the array.
+ * @private
+ * @param arr An array.
+ * @param obj An element to remove from the array.
+ * @returns The given array without the given element removed if it was found; otherwise the array without modifications.
+ */
 export declare const removeIfExists: <T>(arr: T[], obj: T) => T[];
+/**
+ * Adds the given element to the array if it doesn't exist within the array.
+ * @private
+ * @param arr An array.
+ * @param obj An element to add to the array.
+ * @returns The given array with the given element added it was not found; otherwise the array without modifications.
+ */
 export declare const addIfNotExists: <T>(arr: T[], obj: T) => T[];

package/lib/util/shape.d.ts

@@ -1,23 +1,121 @@
+/**
+ * An enumeration of possible closed shapes.
+ * @public
+ */
 export declare enum ClosedShape {
+    /**
+     * An ellipse shape.
+     * @public
+     */
     Ellipse = "ellipse",
+    /**
+     * A nonexistent shape.
+     * @public
+     */
     Empty = "empty",
+    /**
+     * A folder-like shape.
+     * @public
+     */
     Folder = "folder",
+    /**
+     * An hexagon shape.
+     * @public
+     */
     Hexagon = "hexagon",
+    /**
+     * An octagon shape.
+     * @public
+     */
     Octagon = "octagon",
+    /**
+     * A shape delimited by curves with a fixed radius, with differences in dimensions supplemented by straight lines.
+     * @public
+     */
     Pill = "pill",
+    /**
+     * A rectangle shape.
+     * @public
+     */
     Rectangle = "rectangle",
+    /**
+     * A rhombus shape.
+     * @public
+     */
     Rhombus = "rhombus",
+    /**
+     * A rectangle shape with rounded corners.
+     * @public
+     */
     RoundedRectangle = "rounded-rectangle",
+    /**
+     * A sticky note-like shape.
+     * @public
+     */
     StickyNote = "sticky-note"
 }
+/**
+ * Get the SVG path of the correspondign closed shape, starting at the given x and y coordinates, with the given width and height.
+ * @private
+ */
 export declare const generalClosedPath: (shape: ClosedShape, x: number, y: number, width: number, height: number) => string;
+/**
+ * Generates an ellipse SVG path.
+ * @see ClosedShape
+ * @private
+ */
 export declare const ellipsePath: (x: number, y: number, width: number, height: number) => string;
+/**
+ * Generates an empty SVG path.
+ * @see ClosedShape
+ * @private
+ */
 export declare const emptyPath: () => string;
+/**
+ * Generates a folder SVG path.
+ * @see ClosedShape
+ * @private
+ */
 export declare const folderPath: (x: number, y: number, width: number, height: number) => string;
+/**
+ * Generates an hexagon SVG path.
+ * @see ClosedShape
+ * @private
+ */
 export declare const hexagonPath: (x: number, y: number, width: number, height: number) => string;
+/**
+ * Generates an octagon SVG path.
+ * @see ClosedShape
+ * @private
+ */
 export declare const octagonPath: (x: number, y: number, width: number, height: number) => string;
+/**
+ * Generates a pill SVG path.
+ * @see ClosedShape
+ * @private
+ */
 export declare const pillPath: (x: number, y: number, width: number, height: number) => string;
+/**
+ * Generates a rectangle SVG path.
+ * @see ClosedShape
+ * @private
+ */
 export declare const rectanglePath: (x: number, y: number, width: number, height: number) => string;
+/**
+ * Generates a rhombus SVG path.
+ * @see ClosedShape
+ * @private
+ */
 export declare const rhombusPath: (x: number, y: number, width: number, height: number) => string;
+/**
+ * Generates a rounded rectangle SVG path.
+ * @see ClosedShape
+ * @private
+ */
 export declare const roundedRectanglePath: (x: number, y: number, width: number, height: number) => string;
+/**
+ * Generates a sticky note SVG path.
+ * @see ClosedShape
+ * @private
+ */
 export declare const stickyNotePath: (x: number, y: number, width: number, height: number) => string;

package/lib/util/svg-util.d.ts

@@ -1,22 +1,94 @@
+/**
+ * An enumeration of the possible sides of a rectangle and directions parallel to the axes of coordinates.
+ * @public
+ */
 export declare enum Side {
+    /**
+     * Bottom side or direction.
+     * @public
+     */
     Bottom = "bottom",
+    /**
+     * Left side or direction.
+     * @public
+     */
     Left = "left",
+    /**
+     * Right side or direction.
+     * @public
+     */
     Right = "right",
+    /**
+     * Top side or direction.
+     * @public
+     */
     Top = "top"
 }
+/**
+ * An enumeration of the possible corners of a rectangle.
+ * @public
+ */
 export declare enum Corner {
+    /**
+     * Bottom left corner.
+     * @public
+     */
     BottomLeft = "bottom-left",
+    /**
+     * Bottom right corner.
+     * @public
+     */
     BottomRight = "bottom-right",
+    /**
+     * Top left corner.
+     * @public
+     */
     TopLeft = "top-left",
+    /**
+     * Top right corner.
+     * @public
+     */
     TopRight = "top-right"
 }
-export declare enum VerticalAlign {
-    Top = "top",
-    Center = "center",
-    Bottom = "bottom"
-}
+/**
+ * An enumeration of the possible horizontal alignments within a horizontal range of coordinates.
+ * @public
+ */
 export declare enum HorizontalAlign {
+    /**
+     * Start of an horizontal range of coordinates.
+     * @public
+     */
     Left = "left",
+    /**
+     * Middle of an horizontal range of coordinates.
+     * @public
+     */
     Center = "center",
+    /**
+     * End of an horizontal range of coordinates.
+     * @public
+     */
     Right = "right"
 }
+/**
+ * An enumeration of the possible vertical alignments within a vertical range of coordinates.
+ * @public
+ */
+export declare enum VerticalAlign {
+    /**
+     * Start of a vertical range of coordinates.
+     * @public
+     */
+    Top = "top",
+    /**
+     * Middle of a vertical range of coordinates.
+     * @public
+     */
+    Center = "center",
+    /**
+     * End of a vertical range of coordinates.
+     * @public
+     */
+    Bottom = "bottom"
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@metadev/daga",
   "description": "Diagramming engine for editing models on the Web. Made by Metadev.",
-  "version": "1.2.0",
+  "version": "1.3.1",
   "author": "Metadev (https://metadev.pro)",
   "license": "SEE LICENSE IN LICENSE.md",
   "repository": "git+https://github.com/metadevpro/daga-tutorial.git",