lucid-extension-sdk 0.0.209 → 0.0.210

package/commandtypes.d.ts

@@ -122,6 +122,7 @@ export declare const enum CommandName {
     SetPackageSettings = "sps",
     SetProperty = "sp",
     SetReferenceKey = "srk",
+    SetSelection = "ss",
     SetShapeData = "ssd",
     SetText = "st",
     SetTextStyle = "sts",
@@ -548,6 +549,10 @@ export type CommandArgs = {
         query: SetReferenceKeyQuery;
         result: SetReferenceKeyResult;
     };
+    [CommandName.SetSelection]: {
+        query: SetSelectionQuery;
+        result: SetSelectionResult;
+    };
     [CommandName.SetShapeData]: {
         query: SetShapeDataQuery;
         result: SetShapeDataResult;
@@ -1034,11 +1039,17 @@ export type GetLLMContextFromItemsQuery = {
     /** List of item IDs to return LLM-readable context for */
     'i': string[];
 };
-/**
- * A string in a format that LLMs like ChatGPT can easily understand, representing the content
- * of the items specified as well as their immediate context if necessary
- */
-export type GetLLMContextFromItemsResult = string;
+export type GetLLMContextFromItemsResult = {
+    /**
+     * A string in a format that LLMs like ChatGPT can easily understand, representing the content
+     * of the items specified as well as their immediate context if necessary
+     */
+    'p': string;
+    /**
+     * A map from IDs specified in the prompt string to actual Lucid item IDs
+     */
+    'id': Record<string, string>;
+};
 export type GetReferenceKeyQuery = {
     /** ID of the LucidElement to read a reference key from, or undefined to read from the LucidDocument */
     'id'?: string | undefined;
@@ -1370,6 +1381,11 @@ export type SetReferenceKeyQuery = {
     'v'?: SerializedReferenceKeyType | undefined;
 };
 export type SetReferenceKeyResult = undefined;
+export type SetSelectionQuery = {
+    /** IDs of the elements to select */
+    'i': string[];
+};
+export type SetSelectionResult = undefined;
 export type SetShapeDataQuery = {
     /** ID of the element to set this shape data on */
     'id'?: string | undefined;

package/commandtypes.js

@@ -99,6 +99,7 @@ exports.commandTitles = new Map([
     ["sps" /* CommandName.SetPackageSettings */, 'SetPackageSettings'],
     ["sp" /* CommandName.SetProperty */, 'SetProperty'],
     ["srk" /* CommandName.SetReferenceKey */, 'SetReferenceKey'],
+    ["ss" /* CommandName.SetSelection */, 'SetSelection'],
     ["ssd" /* CommandName.SetShapeData */, 'SetShapeData'],
     ["sts" /* CommandName.SetTextStyle */, 'SetTextStyle'],
     ["sm" /* CommandName.ShowModal */, 'ShowModal'],

package/document/pageproxy.d.ts

@@ -111,7 +111,11 @@ export declare class PageProxy extends ElementProxy {
     /**
      * @param items
      * @returns A string representing the content of the items provided, including immediate surrounding context if
-     * necessary, in a format that is easily understandable by LLMs like ChatGPT.
+     * 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[]): string;
+    getLLMContextForItems(items: ItemProxy[]): {
+        prompt: string;
+        idToLucidId: Map<string, string>;
+    };
 }

package/document/pageproxy.js

@@ -177,15 +177,20 @@ class PageProxy extends elementproxy_1.ElementProxy {
     /**
      * @param items
      * @returns A string representing the content of the items provided, including immediate surrounding context if
-     * necessary, in a format that is easily understandable by LLMs like ChatGPT.
+     * 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) {
         //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.
-        return this.client.sendCommand("llm" /* CommandName.GetLLMContextFromItems */, {
+        const result = this.client.sendCommand("llm" /* CommandName.GetLLMContextFromItems */, {
             'p': this.id,
             'i': items.map((item) => item.id),
         });
+        return {
+            prompt: result['p'],
+            idToLucidId: new Map(Object.entries(result['id'])),
+        };
     }
 }
 exports.PageProxy = PageProxy;

package/editorclient.d.ts

@@ -317,6 +317,11 @@ export declare class EditorClient {
      * @returns the given item
      */
     getItemProxy(id: string): BlockProxy | LineProxy | GroupProxy;
+    /**
+     * @param id ID of the item to create a proxy for
+     * @returns the given item, or undefined if the item does not exist or an error occurs
+     */
+    tryGetItemProxy(id: string): BlockProxy | LineProxy | GroupProxy | undefined;
     /**
      * @param id ID of the element to create a proxy for
      * @returns the given element

package/editorclient.js

@@ -516,6 +516,20 @@ class EditorClient {
                 throw new Error('Element ' + id + ' is not an Item; type found is ' + type);
         }
     }
+    /**
+     * @param id ID of the item to create a proxy for
+     * @returns the given item, or undefined if the item does not exist or an error occurs
+     */
+    tryGetItemProxy(id) {
+        try {
+            const item = this.getItemProxy(id);
+            if (item.exists()) {
+                return item;
+            }
+        }
+        catch (_a) { }
+        return undefined;
+    }
     /**
      * @param id ID of the element to create a proxy for
      * @returns the given element

package/package.json

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

package/ui/viewport.d.ts

@@ -21,6 +21,12 @@ export declare class Viewport {
      * @returns An array of currently-selected items on the currently-visible page
      */
     getSelectedItems(deep?: boolean): ItemProxy[];
+    /**
+     * Unselect all currently-selected items, and select the subset of the given items that exist on
+     * the currently-visible page.
+     * @param items
+     */
+    setSelectedItems(items: ItemProxy[]): void;
     /**
      * Find available space on the current page for adding new content.
      * @param width

package/ui/viewport.js

@@ -23,6 +23,14 @@ class Viewport {
             .map((id) => this.client.getElementProxy(id))
             .filter((proxy) => proxy instanceof itemproxy_1.ItemProxy);
     }
+    /**
+     * Unselect all currently-selected items, and select the subset of the given items that exist on
+     * the currently-visible page.
+     * @param items
+     */
+    setSelectedItems(items) {
+        this.client.sendCommand("ss" /* CommandName.SetSelection */, { 'i': items.map((i) => i.id) });
+    }
     /**
      * Find available space on the current page for adding new content.
      * @param width