lucid-extension-sdk 0.0.205 → 0.0.206

package/core/defer.d.ts

@@ -0,0 +1,6 @@
+export interface DeferredPromise<T> extends Promise<T> {
+    resolve: (p1: T) => any;
+    reject: (p1?: any) => any;
+    promise: Promise<T>;
+}
+export declare function defer<T = void>(): DeferredPromise<T>;

package/core/defer.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defer = void 0;
+function checkPromiseExists() {
+    if (typeof Promise !== 'function') {
+        throw new Error('No promise library available');
+    }
+}
+function defer() {
+    checkPromiseExists();
+    let resolve = undefined;
+    let reject = undefined;
+    const promise = new Promise((resolveLocal, rejectLocal) => {
+        resolve = resolveLocal;
+        reject = rejectLocal;
+    });
+    if (!resolve || !reject) {
+        throw new Error('Promise constructor does not provide proper arguments to callback');
+    }
+    return {
+        resolve: resolve,
+        reject: reject,
+        promise: promise,
+        then: promise.then.bind(promise),
+        catch: promise.catch.bind(promise),
+        finally: promise.finally.bind(promise),
+        [Symbol.toStringTag]: promise[Symbol.toStringTag],
+    };
+}
+exports.defer = defer;

package/package.json

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

package/ui/iframeui.d.ts

@@ -25,6 +25,7 @@ export declare abstract class IframeUI {
     protected messageActionName: string;
     /** True after the iframe has fired an onload event (not all scripts are necessarily finished executing) */
     protected loaded: boolean;
+    private frameLoadedPromise;
     /**
      * The location of this frame within the top-level browser window. This is always updated immediately before
      * `messageFromFrame` is called.
@@ -52,7 +53,7 @@ export declare abstract class IframeUI {
      * Send a message to this UI component's iframe via window.postMessage.
      * @param data Data to send to the iframe
      */
-    sendMessage(data: JsonSerializable): void;
+    sendMessage(data: JsonSerializable): Promise<void>;
     /**
      * Receives messages sent from the iframe via parent.postMessage(<data>, '*')
      * @param message data sent from the iframe

package/ui/iframeui.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IframeUI = exports.IncomingUIMessageType = void 0;
+const defer_1 = require("../core/defer");
 /** @ignore */
 var IncomingUIMessageType;
 (function (IncomingUIMessageType) {
@@ -20,6 +21,7 @@ class IframeUI {
         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;
+        this.frameLoadedPromise = (0, defer_1.defer)();
         /**
          * The location of this frame within the top-level browser window. This is always updated immediately before
          * `messageFromFrame` is called.
@@ -50,6 +52,7 @@ class IframeUI {
                     break;
                 case IncomingUIMessageType.FrameLoaded:
                     this.loaded = true;
+                    this.frameLoadedPromise.resolve();
                     this.frameLoaded();
                     break;
             }
@@ -65,13 +68,12 @@ class IframeUI {
      * Send a message to this UI component's iframe via window.postMessage.
      * @param data Data to send to the iframe
      */
-    sendMessage(data) {
-        if (this.loaded) {
-            this.client.sendCommand("suim" /* CommandName.SendUIMessage */, {
-                'n': this.messageActionName,
-                'd': data,
-            });
-        }
+    async sendMessage(data) {
+        await this.frameLoadedPromise;
+        this.client.sendCommand("suim" /* CommandName.SendUIMessage */, {
+            'n': this.messageActionName,
+            'd': data,
+        });
     }
     /**
      * Receives messages sent from the iframe via parent.postMessage(<data>, '*')