lucid-extension-sdk 0.0.140 → 0.0.141

package/commandtypes.d.ts

@@ -89,6 +89,7 @@ export declare const enum CommandName {
     LogForTestCase = "log",
     OffsetItems = "oi",
     PatchDataItems = "pdi",
+    Prompt = "p",
     RegisterPanel = "rp",
     RegisterUnfurl = "ru",
     ReloadExtension = "r",
@@ -400,6 +401,10 @@ export declare type CommandArgs = {
         query: PatchDataItemsQuery;
         result: PatchDataItemsResult;
     };
+    [CommandName.Prompt]: {
+        query: PromptQuery;
+        result: PromptResult;
+    };
     [CommandName.RegisterPanel]: {
         query: RegisterPanelQuery;
         result: RegisterPanelResult;
@@ -1005,6 +1010,13 @@ export declare type PatchDataItemsQuery = {
 };
 /** Primary keys inserted, if any */
 export declare type PatchDataItemsResult = string[];
+export declare type PromptQuery = {
+    /** Title; defaults to extension title */
+    't'?: string | undefined;
+    /** Body text */
+    'b': string;
+};
+export declare type PromptResult = Promise<string | undefined>;
 export declare type RegisterPanelQuery = {
     /** Name of the panel's action for receiving events; generated automatically by Panel base class */
     'n': string;

package/commandtypes.js

@@ -71,6 +71,7 @@ exports.commandTitles = new Map([
     ["log" /* CommandName.LogForTestCase */, 'LogForTestCase'],
     ["oi" /* CommandName.OffsetItems */, 'OffsetItems'],
     ["pdi" /* CommandName.PatchDataItems */, 'PatchDataItems'],
+    ["p" /* CommandName.Prompt */, 'Prompt'],
     ["rp" /* CommandName.RegisterPanel */, 'RegisterPanel'],
     ["ru" /* CommandName.RegisterUnfurl */, 'RegisterUnfurl'],
     ["r" /* CommandName.ReloadExtension */, 'ReloadExtension'],

package/editorclient.d.ts

@@ -308,5 +308,12 @@ export declare class EditorClient {
      * @returns a Promise that resolves true if the user clicks OK, false if they click Cancel or otherwise dismiss the modal
      */
     confirm(text: string, title?: string, okText?: string, cancelText?: string): import("./commandtypes").ConfirmResult;
+    /**
+     * Display a prompt modal to the user
+     * @param text Body text to display in the alert modal
+     * @param title Title of the alert modal; defaults to the extension title specified in manifest.json
+     * @returns a Promise that resolves to a string if a user enters one, or undefined if they cancel
+     */
+    prompt(text: string, title?: string): import("./commandtypes").PromptResult;
     constructor();
 }

package/editorclient.js

@@ -520,5 +520,14 @@ class EditorClient {
     confirm(text, title, okText, cancelText) {
         return this.sendCommand("c" /* CommandName.Confirm */, { 't': title, 'b': text, 'o': okText, 'c': cancelText });
     }
+    /**
+     * Display a prompt modal to the user
+     * @param text Body text to display in the alert modal
+     * @param title Title of the alert modal; defaults to the extension title specified in manifest.json
+     * @returns a Promise that resolves to a string if a user enters one, or undefined if they cancel
+     */
+    prompt(text, title) {
+        return this.sendCommand("p" /* CommandName.Prompt */, { 't': title, 'b': text });
+    }
 }
 exports.EditorClient = EditorClient;

package/math.d.ts

@@ -8,5 +8,6 @@ export declare type Box = {
     w: number;
     h: number;
 };
+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;

package/package.json

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