lucid-extension-sdk 0.0.217 → 0.0.218

package/commandtypes.d.ts

@@ -1096,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([
@@ -135,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/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.217",
+    "version": "0.0.218",
     "description": "Utility classes for writing Lucid Software editor extensions",
     "main": "index.js",
     "types": "index.d.ts",