lucid-extension-sdk 0.0.202 → 0.0.204

package/commandtypes.d.ts

@@ -56,6 +56,7 @@ export declare const enum CommandName {
     ElementExists = "ee",
     ExecuteFormula = "ef",
     FindAvailableSpace = "fas",
+    FireBeaconEvent = "fbe",
     GetOAuthClientId = "goci",
     GetConnectedLines = "gcl",
     GetCurrentPage = "gcp",
@@ -67,6 +68,7 @@ export declare const enum CommandName {
     GetEnvironmentConfig = "gec",
     GetItemPageId = "gip",
     GetItemsAt = "gia",
+    GetLLMContextFromItems = "llm",
     GetOAuthToken = "got",
     GetPackageSettings = "gps",
     GetProduct = "gpr",
@@ -282,6 +284,10 @@ export type CommandArgs = {
         query: FindAvailableSpaceQuery;
         result: FindAvailableSpaceResult;
     };
+    [CommandName.FireBeaconEvent]: {
+        query: FireBeaconEventQuery;
+        result: FireBeaconEventResult;
+    };
     [CommandName.GetOAuthClientId]: {
         query: GetOAuthClientIdQuery;
         result: GetOAuthClientIdResult;
@@ -326,6 +332,10 @@ export type CommandArgs = {
         query: GetItemsAtQuery;
         result: GetItemsAtResult;
     };
+    [CommandName.GetLLMContextFromItems]: {
+        query: GetLLMContextFromItemsQuery;
+        result: GetLLMContextFromItemsResult;
+    };
     [CommandName.GetOAuthToken]: {
         query: GetOAuthTokenQuery;
         result: GetOAuthTokenResult;
@@ -952,6 +962,11 @@ export type FindAvailableSpaceResult = {
     /** Origin of the rectangle of empty space */
     'y': number;
 };
+export type FireBeaconEventQuery = {
+    /** the beacon event to be sent */
+    'e': string;
+};
+export type FireBeaconEventResult = void;
 export type AnimateViewportQuery = {
     /** ID of the page to view */
     'p': string;
@@ -1013,6 +1028,17 @@ export type GetItemsAtQuery = {
 };
 /** IDs of the items found */
 export type GetItemsAtResult = string[];
+export type GetLLMContextFromItemsQuery = {
+    /** Page ID to find closely-related items */
+    'p': string;
+    /** 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 GetReferenceKeyQuery = {
     /** ID of the LucidElement to read a reference key from, or undefined to read from the LucidDocument */
     'id'?: string | undefined;

package/commandtypes.js

@@ -34,6 +34,7 @@ exports.commandTitles = new Map([
     ["ee" /* CommandName.ElementExists */, 'ElementExists'],
     ["ef" /* CommandName.ExecuteFormula */, 'ExecuteFormula'],
     ["fas" /* CommandName.FindAvailableSpace */, 'FindAvailableSpace'],
+    ["fbe" /* CommandName.FireBeaconEvent */, 'FireBeaconEvent'],
     ["goci" /* CommandName.GetOAuthClientId */, 'GetOAuthClientId'],
     ["gcl" /* CommandName.GetConnectedLines */, 'GetConnectedLines'],
     ["gcp" /* CommandName.GetCurrentPage */, 'GetCurrentPage'],
@@ -45,6 +46,7 @@ exports.commandTitles = new Map([
     ["gec" /* CommandName.GetEnvironmentConfig */, 'GetEnvironmentConfig'],
     ["gip" /* CommandName.GetItemPageId */, 'GetItemPageId'],
     ["gia" /* CommandName.GetItemsAt */, 'GetItemsAt'],
+    ["llm" /* CommandName.GetLLMContextFromItems */, 'GetLLMContextFromItems'],
     ["got" /* CommandName.GetOAuthToken */, 'GetOAuthToken'],
     ["gps" /* CommandName.GetPackageSettings */, 'GetPackageSettings'],
     ["gpr" /* CommandName.GetProduct */, 'GetProduct'],

package/document/pageproxy.d.ts

@@ -7,6 +7,7 @@ import { RuleProxy } from './documentelement/ruleproxy';
 import { ElementProxy } from './elementproxy';
 import { GroupProxy } from './groupproxy';
 import { ImageDefinition } from './imagedefinition';
+import { ItemProxy } from './itemproxy';
 import { LineDefinition } from './linedefinition';
 import { LineProxy } from './lineproxy';
 import { MapProxy } from './mapproxy';
@@ -107,4 +108,10 @@ export declare class PageProxy extends ElementProxy {
      * @param links links to be imported onto the canvas as link unfurl blocks
      */
     importLinks(links: string[]): Promise<void>;
+    /**
+     * @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.
+     */
+    getLLMContextForItems(items: ItemProxy[]): string;
 }

package/document/pageproxy.js

@@ -162,5 +162,18 @@ class PageProxy extends elementproxy_1.ElementProxy {
     async importLinks(links) {
         return await this.client.sendCommand("il" /* CommandName.ImportLinks */, { 'p': this.id, 'l': links });
     }
+    /**
+     * @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.
+     */
+    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 */, {
+            'p': this.id,
+            'i': items.map((item) => item.id),
+        });
+    }
 }
 exports.PageProxy = PageProxy;

package/package.json

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