lucid-extension-sdk 0.0.79 → 0.0.81

package/package.json

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

package/sdk/commandtypes.d.ts

@@ -40,6 +40,8 @@ export declare const enum CommandName {
     DeletePage = "dp",
     DeleteShapeData = "dsd",
     Download = "d",
+    DragPointerMove = "dpm",
+    DragPointerUp = "dpu",
     ElementExists = "ee",
     ExecuteFormula = "ef",
     GetConnectedLines = "gcl",
@@ -195,6 +197,14 @@ export declare type CommandArgs = {
         query: DownloadQuery;
         result: DownloadResult;
     };
+    [CommandName.DragPointerMove]: {
+        query: DragPointerMoveQuery;
+        result: DragPointerMoveResult;
+    };
+    [CommandName.DragPointerUp]: {
+        query: DragPointerUpQuery;
+        result: DragPointerUpResult;
+    };
     [CommandName.ElementExists]: {
         query: ElementExistsQuery;
         result: ElementExistsResult;
@@ -678,6 +688,16 @@ export declare type DownloadQuery = {
     'b64': boolean;
 };
 export declare type DownloadResult = undefined;
+export declare type DragPointerMoveQuery = {
+    'x': number;
+    'y': number;
+};
+export declare type DragPointerMoveResult = undefined;
+export declare type DragPointerUpQuery = {
+    'x': number;
+    'y': number;
+};
+export declare type DragPointerUpResult = undefined;
 export declare type ElementExistsQuery = {
     'id'?: string | undefined;
 };

package/sdk/commandtypes.js

@@ -24,6 +24,8 @@ exports.commandTitles = new Map([
     ["dp" /* CommandName.DeletePage */, 'DeletePage'],
     ["dsd" /* CommandName.DeleteShapeData */, 'DeleteShapeData'],
     ["d" /* CommandName.Download */, 'Download'],
+    ["dpm" /* CommandName.DragPointerMove */, 'DragPointerMove'],
+    ["dpu" /* CommandName.DragPointerUp */, 'DragPointerUp'],
     ["ee" /* CommandName.ElementExists */, 'ElementExists'],
     ["ef" /* CommandName.ExecuteFormula */, 'ExecuteFormula'],
     ["gcl" /* CommandName.GetConnectedLines */, 'GetConnectedLines'],

package/sdk/core/cardintegration/cardfielddisplaysettings.d.ts

@@ -32,7 +32,11 @@ export declare enum FieldDisplayType {
      * Given a date, display a small calendar icon alongside a very short version of the date
      * as a string, e.g. "Sep 9"
      */
-    DateBadge = "DateBadge"
+    DateBadge = "DateBadge",
+    /** Given an object containing iconUrl (optional) and name (optional), determine whether
+     * to display as an ImageBadge or InitializedString (or nothing, if neither is present).
+     */
+    UserProfile = "UserProfile"
 }
 export declare const isFieldDisplayType: (x: unknown) => x is FieldDisplayType;
 /**

package/sdk/core/cardintegration/cardfielddisplaysettings.js

@@ -37,6 +37,10 @@ var FieldDisplayType;
      * as a string, e.g. "Sep 9"
      */
     FieldDisplayType["DateBadge"] = "DateBadge";
+    /** Given an object containing iconUrl (optional) and name (optional), determine whether
+     * to display as an ImageBadge or InitializedString (or nothing, if neither is present).
+     */
+    FieldDisplayType["UserProfile"] = "UserProfile";
 })(FieldDisplayType = exports.FieldDisplayType || (exports.FieldDisplayType = {}));
 exports.isFieldDisplayType = (0, validators_1.enumValidator)(FieldDisplayType);
 /**

package/sdk/ui/iframeui.d.ts

@@ -4,7 +4,8 @@ import { EditorClient } from '../editorclient';
 export declare enum IncomingUIMessageType {
     Closed = 1,
     PostMessageFromFrame = 2,
-    FrameLoaded = 3
+    FrameLoaded = 3,
+    FramePosition = 4
 }
 /** @ignore */
 export interface IncomingUIMessage {
@@ -22,7 +23,18 @@ export declare abstract class IframeUI {
     private id;
     private static uiMessageActionNamePrefix;
     protected messageActionName: string;
+    /** True after the iframe has fired an onload event (not all scripts are necessarily finished executing) */
     protected loaded: boolean;
+    /**
+     * The location of this frame within the top-level browser window. This is always updated immediately before
+     * `messageFromFrame` is called.
+     */
+    protected framePosition: {
+        x: number;
+        y: number;
+        w: number;
+        h: number;
+    };
     constructor(client: EditorClient);
     /** @ignore */
     static isUIMessageActionName(name: string): boolean;

package/sdk/ui/iframeui.js

@@ -7,6 +7,7 @@ var IncomingUIMessageType;
     IncomingUIMessageType[IncomingUIMessageType["Closed"] = 1] = "Closed";
     IncomingUIMessageType[IncomingUIMessageType["PostMessageFromFrame"] = 2] = "PostMessageFromFrame";
     IncomingUIMessageType[IncomingUIMessageType["FrameLoaded"] = 3] = "FrameLoaded";
+    IncomingUIMessageType[IncomingUIMessageType["FramePosition"] = 4] = "FramePosition";
 })(IncomingUIMessageType = exports.IncomingUIMessageType || (exports.IncomingUIMessageType = {}));
 /**
  * Base class for defining and interacting with custom UI elements whose contents are displayed
@@ -17,7 +18,13 @@ class IframeUI {
         this.client = client;
         this.id = ++IframeUI.nextId;
         this.messageActionName = IframeUI.uiMessageActionNamePrefix + this.id;
+        /** True after the iframe has fired an onload event (not all scripts are necessarily finished executing) */
         this.loaded = false;
+        /**
+         * The location of this frame within the top-level browser window. This is always updated immediately before
+         * `messageFromFrame` is called.
+         */
+        this.framePosition = { x: 0, y: 0, w: 1, h: 1 };
     }
     /** @ignore */
     static isUIMessageActionName(name) {
@@ -38,6 +45,9 @@ class IframeUI {
                 case IncomingUIMessageType.PostMessageFromFrame:
                     this.messageFromFrame(message['data']);
                     break;
+                case IncomingUIMessageType.FramePosition:
+                    this.framePosition = message['data'];
+                    break;
                 case IncomingUIMessageType.FrameLoaded:
                     this.loaded = true;
                     this.frameLoaded();

package/sdk/ui/viewport.d.ts

@@ -85,4 +85,24 @@ export declare class Viewport {
      * cancel that interaction.
      */
     cancelDraggingNewBlock(): void;
+    /**
+     * After calling startDraggingNewBlock, call this to simulate the user moving the mouse at the
+     * given location within the top-level browser window.
+     *
+     * This has no effect if the drag-new-block interaction is not active.
+     *
+     * To convert a position in a Panel's iframe to a position in the top-level browser window,
+     * add the IframeUI.framePosition.
+     */
+    dragPointerMove(x: number, y: number): void;
+    /**
+     * After calling startDraggingNewBlock, call this to simulate the user releasing the mouse
+     * button at the given location within the top-level browser window.
+     *
+     * This has no effect if the drag-new-block interaction is not active.
+     *
+     * To convert a position in a Panel's iframe to a position in the top-level browser window,
+     * add the IframeUI.framePosition.
+     */
+    dragPointerUp(x: number, y: number): void;
 }

package/sdk/ui/viewport.js

@@ -163,6 +163,30 @@ class Viewport {
     cancelDraggingNewBlock() {
         this.client.sendCommand("cdc" /* CommandName.CancelDragBlockToCanvas */, undefined);
     }
+    /**
+     * After calling startDraggingNewBlock, call this to simulate the user moving the mouse at the
+     * given location within the top-level browser window.
+     *
+     * This has no effect if the drag-new-block interaction is not active.
+     *
+     * To convert a position in a Panel's iframe to a position in the top-level browser window,
+     * add the IframeUI.framePosition.
+     */
+    dragPointerMove(x, y) {
+        this.client.sendCommand("dpm" /* CommandName.DragPointerMove */, { x, y });
+    }
+    /**
+     * After calling startDraggingNewBlock, call this to simulate the user releasing the mouse
+     * button at the given location within the top-level browser window.
+     *
+     * This has no effect if the drag-new-block interaction is not active.
+     *
+     * To convert a position in a Panel's iframe to a position in the top-level browser window,
+     * add the IframeUI.framePosition.
+     */
+    dragPointerUp(x, y) {
+        this.client.sendCommand("dpu" /* CommandName.DragPointerUp */, { x, y });
+    }
 }
 exports.Viewport = Viewport;
 Viewport.nextHookId = 0;