lucid-extension-sdk 0.0.216 → 0.0.218

package/commandtypes.d.ts

@@ -28,6 +28,8 @@ export declare const enum CommandName {
     AddMenuItem = "ami",
     AddShapeData = "asd",
     AddSpreadsheetIntegration = "asi",
+    AddTableColumn = "atc",
+    AddTableRow = "atr",
     Alert = "a",
     AnimateViewport = "av",
     AwaitDataSourceImport = "adi",
@@ -50,6 +52,8 @@ export declare const enum CommandName {
     DeleteItem = "di",
     DeletePage = "dp",
     DeleteShapeData = "dsd",
+    DeleteTableColumn = "dtc",
+    DeleteTableRow = "dtr",
     Download = "d",
     DragPointerMove = "dpm",
     DragPointerUp = "dpu",
@@ -174,6 +178,14 @@ export type CommandArgs = {
         query: AddSpreadsheetIntegrationQuery;
         result: AddSpreadsheetIntegrationResult;
     };
+    [CommandName.AddTableColumn]: {
+        query: AddTableColumnQuery;
+        result: AddTableColumnResult;
+    };
+    [CommandName.AddTableRow]: {
+        query: AddTableRowQuery;
+        result: AddTableRowResult;
+    };
     [CommandName.Alert]: {
         query: AlertQuery;
         result: AlertResult;
@@ -262,6 +274,14 @@ export type CommandArgs = {
         query: DeleteShapeDataQuery;
         result: DeleteShapeDataResult;
     };
+    [CommandName.DeleteTableColumn]: {
+        query: DeleteTableColumnQuery;
+        result: DeleteTableColumnResult;
+    };
+    [CommandName.DeleteTableRow]: {
+        query: DeleteTableRowQuery;
+        result: DeleteTableRowResult;
+    };
     [CommandName.Download]: {
         query: DownloadQuery;
         result: DownloadResult;
@@ -747,6 +767,30 @@ export type AddSpreadsheetIntegrationQuery = {
 };
 /** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
 export type AddSpreadsheetIntegrationResult = undefined;
+export type AddTableColumnQuery = {
+    /** ID of the table to add this column to */
+    'id': string;
+    /** Row of the reference cell that the column should be added next to */
+    'r': number;
+    /** Column of the reference cell that the column should be added next to */
+    'c': number;
+    /** True if the column should be added before the reference cell */
+    'b': boolean;
+};
+/** The index of the newly created column */
+export type AddTableColumnResult = number;
+export type AddTableRowQuery = {
+    /** ID of the table to add this row to */
+    'id': string;
+    /** Row of the reference cell that the row should be added next to */
+    'r': number;
+    /** Column of the reference cell that the row should be added next to */
+    'c': number;
+    /** True if the row should be added before the reference cell */
+    'b': boolean;
+};
+/** The index of the newly created row */
+export type AddTableRowResult = number;
 export type AlertQuery = {
     /** Title; defaults to extension title */
     't'?: string | undefined;
@@ -926,6 +970,20 @@ export type DeleteShapeDataQuery = {
     'n': string;
 };
 export type DeleteShapeDataResult = undefined;
+export type DeleteTableColumnQuery = {
+    /** ID of the table to delete this column from */
+    'id': string;
+    /** Index of the column to delete */
+    'i': number;
+};
+export type DeleteTableColumnResult = void;
+export type DeleteTableRowQuery = {
+    /** ID of the table to delete this row from */
+    'id': string;
+    /** Index of the row to delete */
+    'i': number;
+};
+export type DeleteTableRowResult = void;
 export type DownloadQuery = {
     /** Filename of the download */
     'f': string;
@@ -1038,11 +1096,19 @@ export type GetItemsAtQuery = {
 };
 /** IDs of the items found */
 export type GetItemsAtResult = string[];
+export declare enum GetLLMContextType {
+    /** Get context in a format for LLMs where relationships among connected and contained items is preserved */
+    Relational = 1,
+    /** Get context containing only plain text displayed on the given items, more suitable for embeddings */
+    PlainText = 2
+}
 export type GetLLMContextFromItemsQuery = {
     /** Page ID to find closely-related items */
     'p': string;
     /** List of item IDs to return LLM-readable context for */
     'i': string[];
+    /** Type of context to get */
+    't'?: GetLLMContextType | undefined;
 };
 export type GetLLMContextFromItemsResult = {
     /**

package/commandtypes.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ZOrderOperation = exports.isRawSendXHRResponse = exports.GetItemsAtSearchType = exports.HashAlgorithmEnum = exports.commandTitles = void 0;
+exports.ZOrderOperation = exports.isRawSendXHRResponse = exports.GetLLMContextType = exports.GetItemsAtSearchType = exports.HashAlgorithmEnum = exports.commandTitles = void 0;
 const checks_1 = require("./core/checks");
 /** @ignore */
 exports.commandTitles = new Map([
@@ -9,6 +9,8 @@ exports.commandTitles = new Map([
     ["ami" /* CommandName.AddMenuItem */, 'AddMenuItem'],
     ["asd" /* CommandName.AddShapeData */, 'AddShapeData'],
     ["asi" /* CommandName.AddSpreadsheetIntegration */, 'AddSpreadsheetIntegration'],
+    ["atc" /* CommandName.AddTableColumn */, 'AddTableColumn'],
+    ["atr" /* CommandName.AddTableRow */, 'AddTableRow'],
     ["a" /* CommandName.Alert */, 'Alert'],
     ["av" /* CommandName.AnimateViewport */, 'AnimateViewport'],
     ["adi" /* CommandName.AwaitDataSourceImport */, 'AwaitDataSourceImport'],
@@ -28,6 +30,8 @@ exports.commandTitles = new Map([
     ["di" /* CommandName.DeleteItem */, 'DeleteItem'],
     ["dp" /* CommandName.DeletePage */, 'DeletePage'],
     ["dsd" /* CommandName.DeleteShapeData */, 'DeleteShapeData'],
+    ["dtc" /* CommandName.DeleteTableColumn */, 'DeleteTableColumn'],
+    ["dtr" /* CommandName.DeleteTableRow */, 'DeleteTableRow'],
     ["d" /* CommandName.Download */, 'Download'],
     ["dpm" /* CommandName.DragPointerMove */, 'DragPointerMove'],
     ["dpu" /* CommandName.DragPointerUp */, 'DragPointerUp'],
@@ -131,6 +135,13 @@ var GetItemsAtSearchType;
     GetItemsAtSearchType[GetItemsAtSearchType["Overlapping"] = 1] = "Overlapping";
     GetItemsAtSearchType[GetItemsAtSearchType["Contained"] = 2] = "Contained";
 })(GetItemsAtSearchType = exports.GetItemsAtSearchType || (exports.GetItemsAtSearchType = {}));
+var GetLLMContextType;
+(function (GetLLMContextType) {
+    /** Get context in a format for LLMs where relationships among connected and contained items is preserved */
+    GetLLMContextType[GetLLMContextType["Relational"] = 1] = "Relational";
+    /** Get context containing only plain text displayed on the given items, more suitable for embeddings */
+    GetLLMContextType[GetLLMContextType["PlainText"] = 2] = "PlainText";
+})(GetLLMContextType = exports.GetLLMContextType || (exports.GetLLMContextType = {}));
 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']);
 }

package/document/blockclasses/tableblockproxy.d.ts

@@ -53,8 +53,37 @@ export declare class TableRowProxy {
     getCells(): TableCellProxy[];
     getHeight(): number;
 }
+export declare class TableColumnProxy {
+    readonly table: TableBlockProxy;
+    readonly col: number;
+    constructor(table: TableBlockProxy, col: number);
+    getCells(): TableCellProxy[];
+    getWidth(): number;
+}
 export declare class TableBlockProxy extends BlockProxy {
     static classNameRegex: RegExp;
+    /**
+     *
+     * @param referenceCell The cell to add the new column before or after.
+     * @param before If true, the new column will be added before the reference cell, otherwise it will be added after.
+     * @returns The TableColumnProxy for the newly added column.
+     */
+    addColumn(referenceCell: TableCellProxy, before?: boolean): TableColumnProxy;
+    /**
+     *
+     * @param referenceCell The cell to add the new row before or after.
+     * @param before If true, the new row will be added before the reference cell, otherwise it will be added after.
+     * @returns The TableRowProxy for the newly added row.
+     */
+    addRow(referenceCell: TableCellProxy, before?: boolean): TableRowProxy;
+    /**
+     * @param column The index of the column to delete.
+     */
+    deleteColumn(column: number): void;
+    /**
+     * @param row The index of the row to delete.
+     */
+    deleteRow(row: number): void;
     getRowCount(): number;
     getColumnCount(): number;
     getRows(): TableRowProxy[];

package/document/blockclasses/tableblockproxy.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TableBlockProxy = exports.TableRowProxy = exports.TableCellProxy = void 0;
+exports.TableBlockProxy = exports.TableColumnProxy = exports.TableRowProxy = exports.TableCellProxy = void 0;
 const fillcolor_1 = require("../../core/properties/fillcolor");
 const blockproxy_1 = require("../blockproxy");
 class TableCellProxy {
@@ -95,7 +95,63 @@ class TableRowProxy {
     }
 }
 exports.TableRowProxy = TableRowProxy;
+class TableColumnProxy {
+    constructor(table, col) {
+        this.table = table;
+        this.col = col;
+    }
+    getCells() {
+        return this.table.getRowHeights().map((_, index) => new TableCellProxy(this.table, this.col, index));
+    }
+    getWidth() {
+        var _a;
+        return (_a = this.table.getColumnWidths()[this.col]) !== null && _a !== void 0 ? _a : 1;
+    }
+}
+exports.TableColumnProxy = TableColumnProxy;
 class TableBlockProxy extends blockproxy_1.BlockProxy {
+    /**
+     *
+     * @param referenceCell The cell to add the new column before or after.
+     * @param before If true, the new column will be added before the reference cell, otherwise it will be added after.
+     * @returns The TableColumnProxy for the newly added column.
+     */
+    addColumn(referenceCell, before = false) {
+        const col = this.client.sendCommand("atc" /* CommandName.AddTableColumn */, {
+            'id': this.id,
+            'r': referenceCell.row,
+            'c': referenceCell.column,
+            'b': before,
+        });
+        return new TableColumnProxy(this, col);
+    }
+    /**
+     *
+     * @param referenceCell The cell to add the new row before or after.
+     * @param before If true, the new row will be added before the reference cell, otherwise it will be added after.
+     * @returns The TableRowProxy for the newly added row.
+     */
+    addRow(referenceCell, before = false) {
+        const row = this.client.sendCommand("atr" /* CommandName.AddTableRow */, {
+            'id': this.id,
+            'r': referenceCell.row,
+            'c': referenceCell.column,
+            'b': before,
+        });
+        return new TableRowProxy(this, row);
+    }
+    /**
+     * @param column The index of the column to delete.
+     */
+    deleteColumn(column) {
+        return this.client.sendCommand("dtc" /* CommandName.DeleteTableColumn */, { 'id': this.id, 'i': column });
+    }
+    /**
+     * @param row The index of the row to delete.
+     */
+    deleteRow(row) {
+        return this.client.sendCommand("dtr" /* CommandName.DeleteTableRow */, { 'id': this.id, 'i': row });
+    }
     getRowCount() {
         return this.getRowHeights().length;
     }

package/document/blockproxy.d.ts

@@ -19,6 +19,10 @@ export declare class BlockProxy extends ItemProxy {
      * @returns The amount this block is rotated around its own center, in radians.
      */
     getRotation(): number;
+    /**
+     * @returns An axis-aligned bounding box containing this full item after any rotation it might have
+     */
+    getRotatedBoundingBox(): import("../math").Box;
     /**
      * @param radians Angle the block should be rotated
      */

package/document/blockproxy.js

@@ -5,6 +5,7 @@ const badgeposition_1 = require("../core/properties/datagraphic/badgeposition");
 const staticdatagraphicsettings_1 = require("../core/properties/datagraphic/staticdatagraphicsettings");
 const fillcolor_1 = require("../core/properties/fillcolor");
 const shadow_1 = require("../core/properties/shadow");
+const math_1 = require("../math");
 const itemproxy_1 = require("./itemproxy");
 /**
  * A block is a single shape on the document. A BlockProxy provides an interface to
@@ -26,6 +27,12 @@ class BlockProxy extends itemproxy_1.ItemProxy {
     getRotation() {
         return this.properties.get('Rotation');
     }
+    /**
+     * @returns An axis-aligned bounding box containing this full item after any rotation it might have
+     */
+    getRotatedBoundingBox() {
+        return (0, math_1.rotatedBoundingBox)(this.getBoundingBox(), this.getRotation());
+    }
     /**
      * @param radians Angle the block should be rotated
      */

package/document/pageproxy.d.ts

@@ -1,4 +1,4 @@
-import { GetItemsAtSearchType } from '../commandtypes';
+import { GetItemsAtSearchType, GetLLMContextType } from '../commandtypes';
 import { EditorClient } from '../editorclient';
 import { Box } from '../math';
 import { BlockDefinition } from './blockdefinition';
@@ -114,7 +114,7 @@ export declare class PageProxy extends ElementProxy {
      * necessary, in a format that is easily understandable by LLMs like ChatGPT. Also a map of IDs, from the shortened
      * IDs provided for the items in the context to the actual Lucid item IDs.
      */
-    getLLMContextForItems(items: ItemProxy[]): {
+    getLLMContextForItems(items: ItemProxy[], contextType?: GetLLMContextType): {
         prompt: string;
         idToLucidId: Map<string, string>;
     };

package/document/pageproxy.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PageProxy = void 0;
+const commandtypes_1 = require("../commandtypes");
 const ruleproxy_1 = require("./documentelement/ruleproxy");
 const elementproxy_1 = require("./elementproxy");
 const groupproxy_1 = require("./groupproxy");
@@ -180,12 +181,13 @@ class PageProxy extends elementproxy_1.ElementProxy {
      * necessary, in a format that is easily understandable by LLMs like ChatGPT. Also a map of IDs, from the shortened
      * IDs provided for the items in the context to the actual Lucid item IDs.
      */
-    getLLMContextForItems(items) {
+    getLLMContextForItems(items, contextType = commandtypes_1.GetLLMContextType.Relational) {
         //We don't check that the items are on this page here; that is done in the implementation
         //of the API command. It would be a lot of extra API calls for no benefit.
         const result = this.client.sendCommand("llm" /* CommandName.GetLLMContextFromItems */, {
             'p': this.id,
             'i': items.map((item) => item.id),
+            't': contextType,
         });
         return {
             prompt: result['p'],

package/math.d.ts

@@ -31,3 +31,16 @@ export declare function percentBoxesOverlap(a: Box, b: Box): number;
  * @return a clipped to b
  */
 export declare function clip(a: Box, b: Box): Box;
+export declare function boxCenter(b: Box): {
+    x: number;
+    y: number;
+};
+/**
+ * Returns the bounding box that would surround the given
+ * box when rotated the given amount.
+ */
+export declare function rotatedBoundingBox(b: Box, angle: number, center?: Point): Box;
+export declare function rotateBox(b: Box, angle: number, center?: Point): [Point, Point, Point, Point];
+export declare function boxFrom4Points(a: Point, b: Point, c: Point, d: Point): Box;
+export declare function toCornersAsArray(box: Box): [Point, Point, Point, Point];
+export declare function rotateAroundFn(anchor: Point, angle: number): (p1: Point) => Point;

package/math.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.clip = exports.percentBoxesOverlap = exports.boxesOverlap = exports.isBoxWithin = exports.padBox = exports.combinedBoundingBox = void 0;
+exports.rotateAroundFn = exports.toCornersAsArray = exports.boxFrom4Points = exports.rotateBox = exports.rotatedBoundingBox = exports.boxCenter = exports.clip = exports.percentBoxesOverlap = exports.boxesOverlap = exports.isBoxWithin = exports.padBox = exports.combinedBoundingBox = void 0;
 function combinedBoundingBox(boxes) {
     if (boxes.length == 0) {
         return undefined;
@@ -64,3 +64,57 @@ function clip(a, b) {
     return { x, y, w, h };
 }
 exports.clip = clip;
+function boxCenter(b) {
+    return { x: b.x + b.w / 2, y: b.y + b.h / 2 };
+}
+exports.boxCenter = boxCenter;
+/**
+ * Returns the bounding box that would surround the given
+ * box when rotated the given amount.
+ */
+function rotatedBoundingBox(b, angle, center) {
+    if (!angle) {
+        return b;
+    }
+    center = center || boxCenter(b);
+    return boxFrom4Points.apply(null, rotateBox(b, angle, center));
+}
+exports.rotatedBoundingBox = rotatedBoundingBox;
+function rotateBox(b, angle, center) {
+    const ret = toCornersAsArray(b);
+    center = center || boxCenter(b);
+    if (angle != 0) {
+        return ret.map(rotateAroundFn(center, angle));
+    }
+    return ret;
+}
+exports.rotateBox = rotateBox;
+function boxFrom4Points(a, b, c, d) {
+    const xMin = Math.min(a.x, b.x, c.x, d.x);
+    const xMax = Math.max(a.x, b.x, c.x, d.x);
+    const yMin = Math.min(a.y, b.y, c.y, d.y);
+    const yMax = Math.max(a.y, b.y, c.y, d.y);
+    return { x: xMin, y: yMin, w: xMax - xMin, h: yMax - yMin };
+}
+exports.boxFrom4Points = boxFrom4Points;
+function toCornersAsArray(box) {
+    return [
+        { x: box.x, y: box.y },
+        { x: box.x + box.w, y: box.y },
+        { x: box.x + box.w, y: box.y + box.h },
+        { x: box.x, y: box.y + box.h },
+    ];
+}
+exports.toCornersAsArray = toCornersAsArray;
+function rotateAroundFn(anchor, angle) {
+    const cos = Math.cos(angle);
+    const sin = Math.sin(angle);
+    return (p) => {
+        const anchorX = anchor.x;
+        const anchorY = anchor.y;
+        const x = p.x - anchorX;
+        const y = p.y - anchorY;
+        return { x: x * cos - y * sin + anchorX, y: y * cos + x * sin + anchorY };
+    };
+}
+exports.rotateAroundFn = rotateAroundFn;

package/package.json

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