lucid-extension-sdk 0.0.144 → 0.0.146

package/commandtypes.d.ts

@@ -55,6 +55,7 @@ export declare const enum CommandName {
     GetDataItemField = "gdif",
     GetElementType = "get",
     GetItemPageId = "gip",
+    GetItemsAt = "gia",
     GetPackageSettings = "gps",
     GetProduct = "gpr",
     GetProperty = "gp",
@@ -115,7 +116,8 @@ export declare const enum CommandName {
     UnhookCreateItems = "uci",
     UnhookDeleteItems = "udi",
     UnhookSelection = "us",
-    UnhookTextEdit = "ute"
+    UnhookTextEdit = "ute",
+    ZOrder = "z"
 }
 /** @ignore */
 export declare const commandTitles: Map<CommandName, string>;
@@ -265,6 +267,10 @@ export declare type CommandArgs = {
         query: GetItemPageIdQuery;
         result: GetItemPageIdResult;
     };
+    [CommandName.GetItemsAt]: {
+        query: GetItemsAtQuery;
+        result: GetItemsAtResult;
+    };
     [CommandName.GetPackageSettings]: {
         query: GetPackageSettingsQuery;
         result: GetPackageSettingsResult;
@@ -509,6 +515,10 @@ export declare type CommandArgs = {
         query: UnhookTextEditQuery;
         result: UnhookTextEditResult;
     };
+    [CommandName.ZOrder]: {
+        query: ZOrderQuery;
+        result: ZOrderResult;
+    };
 };
 export declare type AddCardIntegrationQuery = {
     /** Title/name */
@@ -857,6 +867,21 @@ export declare type GetDataItemFieldQuery = {
 export declare type GetDataItemFieldResult = SerializedFieldType;
 export declare type GetItemPageIdQuery = string;
 export declare type GetItemPageIdResult = string;
+export declare enum GetItemsAtSearchType {
+    PossiblyOverlapping = 0,
+    Overlapping = 1,
+    Contained = 2
+}
+export declare type GetItemsAtQuery = {
+    /** Page ID to search */
+    'p': string;
+    /** Bounding box to search */
+    'bb': Box;
+    /** Search type */
+    's': GetItemsAtSearchType;
+};
+/** IDs of the items found */
+export declare type GetItemsAtResult = string[];
 export declare type GetReferenceKeyQuery = {
     /** ID of the LucidElement to read a reference key from, or undefined to read from the LucidDocument */
     'id'?: string | undefined;
@@ -1242,3 +1267,16 @@ export declare type UnhookTextEditQuery = {
     'n': string;
 };
 export declare type UnhookTextEditResult = undefined;
+export declare enum ZOrderOperation {
+    UP = 1,
+    TOP = 2,
+    DOWN = 3,
+    BOTTOM = 4
+}
+export declare type ZOrderQuery = {
+    /** IDs of the items to adjust Z order */
+    'i': string[];
+    /** Operation to perform on these items */
+    'o': ZOrderOperation;
+};
+export declare type ZOrderResult = undefined;

package/commandtypes.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isRawSendXHRResponse = exports.commandTitles = void 0;
+exports.ZOrderOperation = exports.isRawSendXHRResponse = exports.GetItemsAtSearchType = exports.commandTitles = void 0;
 const checks_1 = require("./core/checks");
 /** @ignore */
 exports.commandTitles = new Map([
@@ -37,6 +37,7 @@ exports.commandTitles = new Map([
     ["gdif" /* CommandName.GetDataItemField */, 'GetDataItemField'],
     ["get" /* CommandName.GetElementType */, 'GetElementType'],
     ["gip" /* CommandName.GetItemPageId */, 'GetItemPageId'],
+    ["gia" /* CommandName.GetItemsAt */, 'GetItemsAt'],
     ["gps" /* CommandName.GetPackageSettings */, 'GetPackageSettings'],
     ["gpr" /* CommandName.GetProduct */, 'GetProduct'],
     ["gp" /* CommandName.GetProperty */, 'GetProperty'],
@@ -96,8 +97,22 @@ exports.commandTitles = new Map([
     ["udi" /* CommandName.UnhookDeleteItems */, 'UnhookDeleteItems'],
     ["us" /* CommandName.UnhookSelection */, 'UnhookSelection'],
     ["ute" /* CommandName.UnhookTextEdit */, 'UnhookTextEdit'],
+    ["z" /* CommandName.ZOrder */, 'ZOrder'],
 ]);
+var GetItemsAtSearchType;
+(function (GetItemsAtSearchType) {
+    GetItemsAtSearchType[GetItemsAtSearchType["PossiblyOverlapping"] = 0] = "PossiblyOverlapping";
+    GetItemsAtSearchType[GetItemsAtSearchType["Overlapping"] = 1] = "Overlapping";
+    GetItemsAtSearchType[GetItemsAtSearchType["Contained"] = 2] = "Contained";
+})(GetItemsAtSearchType = exports.GetItemsAtSearchType || (exports.GetItemsAtSearchType = {}));
 function isRawSendXHRResponse(val) {
     return (0, checks_1.isString)(val['url']) && (0, checks_1.isString)(val['t']) && (0, checks_1.isNumber)(val['s']) && (0, checks_1.isObject)(val['h']);
 }
 exports.isRawSendXHRResponse = isRawSendXHRResponse;
+var ZOrderOperation;
+(function (ZOrderOperation) {
+    ZOrderOperation[ZOrderOperation["UP"] = 1] = "UP";
+    ZOrderOperation[ZOrderOperation["TOP"] = 2] = "TOP";
+    ZOrderOperation[ZOrderOperation["DOWN"] = 3] = "DOWN";
+    ZOrderOperation[ZOrderOperation["BOTTOM"] = 4] = "BOTTOM";
+})(ZOrderOperation = exports.ZOrderOperation || (exports.ZOrderOperation = {}));

package/core/cardintegration/cardfielddisplaysettings.d.ts

@@ -91,7 +91,7 @@ export interface StencilConfig {
     /**
      * If specified, the result of this formula (executed in the context of the data item
      * associated with this card) will be used instead of the raw field value when
-     * creating the data graphic. This can be useful if, for example, you see to convert
+     * creating the data graphic. This can be useful if, for example, you want to convert
      * an ID into a URL.
      */
     valueFormula?: string;

package/document/blockclasses/blockproxyregistry.js

@@ -5,6 +5,7 @@ const cardblockproxy_1 = require("./cardblockproxy");
 const customblockproxy_1 = require("./customblockproxy");
 const erdblockproxy_1 = require("./erdblockproxy");
 const linkunfurlblockproxy_1 = require("./linkunfurlblockproxy");
+const swimlaneblockproxy_1 = require("./swimlaneblockproxy");
 const tableblockproxy_1 = require("./tableblockproxy");
 const allProxyClasses = [
     erdblockproxy_1.ERDBlockProxy,
@@ -12,6 +13,7 @@ const allProxyClasses = [
     linkunfurlblockproxy_1.LinkUnfurlBlockProxy,
     cardblockproxy_1.CardBlockProxy,
     tableblockproxy_1.TableBlockProxy,
+    swimlaneblockproxy_1.SwimLaneBlockProxy,
 ];
 function findProxyClass(className) {
     return allProxyClasses.find((proxy) => proxy.classNameRegex.test(className));

package/document/blockclasses/swimlaneblockproxy.d.ts

@@ -0,0 +1,39 @@
+import { SimpleFillStyle } from '../../core/properties/fillcolor';
+import { Box } from '../../math';
+import { BlockProxy } from '../blockproxy';
+export declare class SwimLanePrimaryLaneProxy {
+    readonly swimlane: SwimLaneBlockProxy;
+    readonly index: number;
+    constructor(swimlane: SwimLaneBlockProxy, index: number);
+    /**
+     * For horizontal lanes, the lane height.
+     * For vertical lanes, the lane width.
+     */
+    getSize(): number;
+    getBoundingBox(): {
+        x: number;
+        y: number;
+        w: number;
+        h: number;
+    };
+    private getTitleTextAreaId;
+    getTitle(): string;
+    setTitle(title: string): undefined;
+    setFill(fill: SimpleFillStyle): void;
+}
+export declare class SwimLaneBlockProxy extends BlockProxy {
+    static classNameRegex: RegExp;
+    getPrimaryLaneSizes(): number[];
+    setPrimaryLaneSizes(sizes: number[]): void;
+    getPrimaryLanes(): SwimLanePrimaryLaneProxy[];
+    getPrimaryLanesVertical(): boolean;
+    getMagnetized(): boolean;
+    setMagnetized(magnetize: boolean): void;
+    /** @ignore */
+    updateTextAreaNames(): void;
+    /**
+     * Swim lanes only use the normal BoundingBox property for location.
+     * For size, it uses the PrimaryLane and SecondaryLane properties.
+     */
+    setBoundingBox(bb: Box): void;
+}

package/document/blockclasses/swimlaneblockproxy.js

@@ -0,0 +1,124 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SwimLaneBlockProxy = exports.SwimLanePrimaryLaneProxy = void 0;
+const fillcolor_1 = require("../../core/properties/fillcolor");
+const blockproxy_1 = require("../blockproxy");
+class SwimLanePrimaryLaneProxy {
+    constructor(swimlane, index) {
+        this.swimlane = swimlane;
+        this.index = index;
+    }
+    /**
+     * For horizontal lanes, the lane height.
+     * For vertical lanes, the lane width.
+     */
+    getSize() {
+        return this.swimlane.getPrimaryLaneSizes()[this.index];
+    }
+    getBoundingBox() {
+        const bb = this.swimlane.getBoundingBox();
+        const sizes = this.swimlane.getPrimaryLaneSizes();
+        if (this.swimlane.getPrimaryLanesVertical()) {
+            return {
+                x: bb.x + sizes.slice(0, this.index).reduce((a, b) => a + b, 0),
+                y: bb.y,
+                w: sizes[this.index],
+                h: bb.h,
+            };
+        }
+        else {
+            return {
+                x: bb.x,
+                y: bb.y + sizes.slice(0, this.index).reduce((a, b) => a + b, 0),
+                w: bb.w,
+                h: sizes[this.index],
+            };
+        }
+    }
+    getTitleTextAreaId() {
+        const existing = this.swimlane.properties.get('PrimaryLaneTextAreaIds')[this.index];
+        if (existing) {
+            return existing;
+        }
+        this.swimlane.updateTextAreaNames();
+        return this.swimlane.properties.get('PrimaryLaneTextAreaIds')[this.index];
+    }
+    getTitle() {
+        return this.swimlane.textAreas.get(this.getTitleTextAreaId());
+    }
+    setTitle(title) {
+        return this.swimlane.textAreas.set(this.getTitleTextAreaId(), title);
+    }
+    setFill(fill) {
+        this.swimlane.properties.set(`CellFill_0,${this.index}`, (0, fillcolor_1.serializeSimpleFill)(fill));
+    }
+}
+exports.SwimLanePrimaryLaneProxy = SwimLanePrimaryLaneProxy;
+class SwimLaneBlockProxy extends blockproxy_1.BlockProxy {
+    getPrimaryLaneSizes() {
+        return this.properties.get('PrimaryLane');
+    }
+    setPrimaryLaneSizes(sizes) {
+        this.properties.set('PrimaryLane', sizes);
+        this.updateTextAreaNames();
+    }
+    getPrimaryLanes() {
+        return this.getPrimaryLaneSizes().map((size, index) => new SwimLanePrimaryLaneProxy(this, index));
+    }
+    getPrimaryLanesVertical() {
+        return this.properties.get('IsPrimaryLaneVertical');
+    }
+    getMagnetized() {
+        return this.properties.get('Magnetize');
+    }
+    setMagnetized(magnetize) {
+        this.properties.set('Magnetize', magnetize);
+    }
+    /** @ignore */
+    updateTextAreaNames() {
+        this.properties.set('PrimaryLaneTextAreaIds', this.getPrimaryLaneSizes().map((_, index) => 'Primary_' + index));
+    }
+    /**
+     * Swim lanes only use the normal BoundingBox property for location.
+     * For size, it uses the PrimaryLane and SecondaryLane properties.
+     */
+    setBoundingBox(bb) {
+        super.setBoundingBox(bb); //To get position correct
+        const minLaneSize = 40;
+        const oldBB = this.getBoundingBox();
+        const primarySizes = this.getPrimaryLaneSizes();
+        const secondarySizes = this.properties.get('SecondaryLane');
+        const adjustLanesByDelta = (lanes, delta, laneIndex = lanes.length - 1) => {
+            if (laneIndex >= 0 && laneIndex < lanes.length) {
+                lanes[laneIndex] += delta;
+                if (lanes[laneIndex] < minLaneSize) {
+                    const deltaLeft = minLaneSize - lanes[laneIndex];
+                    lanes[laneIndex] = minLaneSize;
+                    adjustLanesByDelta(lanes, deltaLeft, laneIndex - 1);
+                }
+            }
+        };
+        if (bb.w != oldBB.w) {
+            if (this.getPrimaryLanesVertical()) {
+                adjustLanesByDelta(primarySizes, bb.w - oldBB.w);
+                this.setPrimaryLaneSizes(primarySizes);
+            }
+            else {
+                adjustLanesByDelta(secondarySizes, bb.w - oldBB.w);
+                this.properties.set('SecondaryLane', secondarySizes);
+            }
+        }
+        if (bb.h != oldBB.h) {
+            if (this.getPrimaryLanesVertical()) {
+                adjustLanesByDelta(secondarySizes, bb.h - oldBB.h);
+                this.properties.set('SecondaryLane', secondarySizes);
+            }
+            else {
+                adjustLanesByDelta(primarySizes, bb.h - oldBB.h);
+                this.setPrimaryLaneSizes(primarySizes);
+            }
+        }
+    }
+}
+exports.SwimLaneBlockProxy = SwimLaneBlockProxy;
+SwimLaneBlockProxy.classNameRegex = /^AdvancedSwimLaneBlock$/;

package/document/blockclasses/tableblockproxy.d.ts

@@ -1,4 +1,5 @@
 import { SimpleFillStyle } from '../../core/properties/fillcolor';
+import { Box } from '../../math';
 import { BlockProxy } from '../blockproxy';
 import { TextStyle } from '../text/textstyle';
 export declare class TableCellProxy {
@@ -43,6 +44,7 @@ export declare class TableCellProxy {
      * @returns the pixel height of the cell, including any cells it is merged with.
      */
     getHeight(): number;
+    getBoundingBox(): Box;
 }
 export declare class TableRowProxy {
     readonly table: TableBlockProxy;

package/document/blockclasses/tableblockproxy.js

@@ -65,6 +65,20 @@ class TableCellProxy {
             .slice(this.row, this.row + this.getMergedCellSize().h)
             .reduce((a, b) => a + b, 0);
     }
+    getBoundingBox() {
+        const tableBB = this.table.getBoundingBox();
+        const x = tableBB.x +
+            this.table
+                .getColumnWidths()
+                .slice(0, this.column)
+                .reduce((a, b) => a + b, 0);
+        const y = tableBB.y +
+            this.table
+                .getRowHeights()
+                .slice(0, this.row)
+                .reduce((a, b) => a + b, 0);
+        return { x, y, w: this.getWidth(), h: this.getHeight() };
+    }
 }
 exports.TableCellProxy = TableCellProxy;
 class TableRowProxy {

package/document/itemproxy.d.ts

@@ -1,3 +1,4 @@
+import { ZOrderOperation } from '../commandtypes';
 import { LinearOffsetType } from '../core/offsettype';
 import { EditorClient } from '../editorclient';
 import { Box, Point } from '../math';
@@ -71,4 +72,8 @@ export declare class ItemProxy extends ElementProxy {
      * @returns An array of blocks whose bounding boxes contain this item's upper-left corner
      */
     getContainers(): import("./blockproxy").BlockProxy[];
+    /**
+     * @param operation How to adjust the Z order of this item relative to the other items it overlaps on the page
+     */
+    changeZOrder(operation: ZOrderOperation): void;
 }

package/document/itemproxy.js

@@ -115,5 +115,11 @@ class ItemProxy extends elementproxy_1.ElementProxy {
         const containers = this.executeFormula('LABEL(CONTAINEDBY)');
         return containers.map((id) => this.client.getBlockProxy(id));
     }
+    /**
+     * @param operation How to adjust the Z order of this item relative to the other items it overlaps on the page
+     */
+    changeZOrder(operation) {
+        this.client.sendCommand("z" /* CommandName.ZOrder */, { 'i': [this.id], 'o': operation });
+    }
 }
 exports.ItemProxy = ItemProxy;

package/document/lineproxy.d.ts

@@ -3,6 +3,11 @@ import { BlockProxy } from './blockproxy';
 import { ItemProxy } from './itemproxy';
 import { EndpointDefinition } from './linedefinition';
 import { LineTextAreaPositioning } from './linetextareapositioning';
+export declare enum LineShape {
+    Curve = "curve",
+    Elbow = "elbow",
+    Straight = "straight"
+}
 /**
  * A line on the current Lucid document
  */
@@ -78,4 +83,6 @@ export declare class LineProxy extends ItemProxy {
      * @param name
      */
     deleteTextArea(name: string): void;
+    getShape(): LineShape;
+    setShape(shape: LineShape): void;
 }

package/document/lineproxy.js

@@ -1,10 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LineProxy = void 0;
+exports.LineProxy = exports.LineShape = void 0;
 const checks_1 = require("../core/checks");
 const blockproxy_1 = require("./blockproxy");
 const itemproxy_1 = require("./itemproxy");
 const linetextareapositioning_1 = require("./linetextareapositioning");
+var LineShape;
+(function (LineShape) {
+    LineShape["Curve"] = "curve";
+    LineShape["Elbow"] = "elbow";
+    LineShape["Straight"] = "straight";
+})(LineShape = exports.LineShape || (exports.LineShape = {}));
 /**
  * A line on the current Lucid document
  */
@@ -182,5 +188,11 @@ class LineProxy extends itemproxy_1.ItemProxy {
     deleteTextArea(name) {
         this.properties.set('TextAreas', { [name]: null });
     }
+    getShape() {
+        return this.properties.get('Shape');
+    }
+    setShape(shape) {
+        this.properties.set('Shape', shape);
+    }
 }
 exports.LineProxy = LineProxy;

package/document/pageproxy.d.ts

@@ -1,4 +1,6 @@
+import { GetItemsAtSearchType } from '../commandtypes';
 import { EditorClient } from '../editorclient';
+import { Box } from '../math';
 import { BlockDefinition } from './blockdefinition';
 import { BlockProxy } from './blockproxy';
 import { ElementProxy } from './elementproxy';
@@ -70,4 +72,11 @@ export declare class PageProxy extends ElementProxy {
      * Delete this page from the document if possible
      */
     delete(): void;
+    /**
+     *
+     * @param boundingBox An area of this page to search for blocks, lines, and groups
+     * @param searchType
+     * @returns Items in the given bounding box, based on the search type
+     */
+    findItems(boundingBox: Box, searchType: GetItemsAtSearchType): (BlockProxy | LineProxy | GroupProxy)[];
 }

package/document/pageproxy.js

@@ -105,5 +105,16 @@ class PageProxy extends elementproxy_1.ElementProxy {
     delete() {
         this.client.sendCommand("dp" /* CommandName.DeletePage */, this.id);
     }
+    /**
+     *
+     * @param boundingBox An area of this page to search for blocks, lines, and groups
+     * @param searchType
+     * @returns Items in the given bounding box, based on the search type
+     */
+    findItems(boundingBox, searchType) {
+        return this.client
+            .sendCommand("gia" /* CommandName.GetItemsAt */, { 'p': this.id, 'bb': boundingBox, 's': searchType })
+            .map((id) => this.client.getItemProxy(id));
+    }
 }
 exports.PageProxy = PageProxy;

package/index.d.ts

@@ -77,6 +77,8 @@ export * from './document/blockclasses/cardblockproxy';
 export * from './document/blockclasses/customblockproxy';
 export * from './document/blockclasses/erdblockproxy';
 export * from './document/blockclasses/linkunfurlblockproxy';
+export * from './document/blockclasses/swimlaneblockproxy';
+export * from './document/blockclasses/tableblockproxy';
 export * from './document/blockdefinition';
 export * from './document/blockproxy';
 export * from './document/documentproxy';

package/index.js

@@ -93,6 +93,8 @@ __exportStar(require("./document/blockclasses/cardblockproxy"), exports);
 __exportStar(require("./document/blockclasses/customblockproxy"), exports);
 __exportStar(require("./document/blockclasses/erdblockproxy"), exports);
 __exportStar(require("./document/blockclasses/linkunfurlblockproxy"), exports);
+__exportStar(require("./document/blockclasses/swimlaneblockproxy"), exports);
+__exportStar(require("./document/blockclasses/tableblockproxy"), exports);
 __exportStar(require("./document/blockdefinition"), exports);
 __exportStar(require("./document/blockproxy"), exports);
 __exportStar(require("./document/documentproxy"), exports);

package/math.d.ts

@@ -11,3 +11,23 @@ export declare type Box = {
 export declare function combinedBoundingBox(boxes: [Box, ...Box[]]): Box;
 export declare function combinedBoundingBox(boxes: Box[]): Box | undefined;
 export declare function padBox(box: Box, padding: number): Box;
+/**
+ * Is box a completely within box b?
+ */
+export declare function isBoxWithin(a: Box, b: Box): boolean;
+/**
+ * Do two boxes overlap?
+ */
+export declare function boxesOverlap(a: Box, b: Box): boolean;
+/**
+ * return the percentage of a that overlaps with b.
+ * if a is entirely within b, it returns 1 (or a number a little less than 1
+ * (e.g., 0.99999999999) due to numerical inaccuracy); if a is entirely
+ * outside b, it returns 0.
+ */
+export declare function percentBoxesOverlap(a: Box, b: Box): number;
+/**
+ * Gets the intersection of two boxes
+ * @return a clipped to b
+ */
+export declare function clip(a: Box, b: Box): Box;

package/math.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.padBox = exports.combinedBoundingBox = void 0;
+exports.clip = exports.percentBoxesOverlap = exports.boxesOverlap = exports.isBoxWithin = exports.padBox = exports.combinedBoundingBox = void 0;
 function combinedBoundingBox(boxes) {
     if (boxes.length == 0) {
         return undefined;
@@ -22,3 +22,45 @@ function padBox(box, padding) {
     return { x: box.x - padding, y: box.y - padding, w: box.w + padding * 2, h: box.h + padding * 2 };
 }
 exports.padBox = padBox;
+/**
+ * Is box a completely within box b?
+ */
+function isBoxWithin(a, b) {
+    return a.x >= b.x && a.y >= b.y && a.x + a.w <= b.x + b.w && a.y + a.h <= b.y + b.h;
+}
+exports.isBoxWithin = isBoxWithin;
+/**
+ * Do two boxes overlap?
+ */
+function boxesOverlap(a, b) {
+    return a.x + a.w >= b.x && a.y + a.h >= b.y && b.x + b.w >= a.x && b.y + b.h >= a.y;
+}
+exports.boxesOverlap = boxesOverlap;
+/**
+ * return the percentage of a that overlaps with b.
+ * if a is entirely within b, it returns 1 (or a number a little less than 1
+ * (e.g., 0.99999999999) due to numerical inaccuracy); if a is entirely
+ * outside b, it returns 0.
+ */
+function percentBoxesOverlap(a, b) {
+    const intersection = clip(a, b);
+    // if either dimension is negative return zero
+    if (intersection.w <= 0 || intersection.h <= 0) {
+        return 0;
+    }
+    const area = intersection.w * intersection.h;
+    return area / (a.w * a.h);
+}
+exports.percentBoxesOverlap = percentBoxesOverlap;
+/**
+ * Gets the intersection of two boxes
+ * @return a clipped to b
+ */
+function clip(a, b) {
+    const x = Math.max(a.x, b.x);
+    const y = Math.max(a.y, b.y);
+    const w = Math.min(a.x + a.w, b.x + b.w) - x;
+    const h = Math.min(a.y + a.h, b.y + b.h) - y;
+    return { x, y, w, h };
+}
+exports.clip = clip;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "lucid-extension-sdk",
-    "version": "0.0.144",
+    "version": "0.0.146",
     "description": "Utility classes for writing Lucid Software editor extensions",
     "main": "index.js",
     "types": "index.d.ts",