lucid-extension-sdk 0.0.4 → 0.0.8

package/package.json

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

package/sdk/commandtypes.d.ts

@@ -11,6 +11,7 @@ export declare const enum CommandName {
     AddMenuItem = "ami",
     AddShapeData = "asd",
     AnimateViewport = "av",
+    Bootstrap = "b",
     CreateBlock = "cb",
     CreateCollection = "cc",
     CreateDataSource = "cds",
@@ -52,13 +53,15 @@ export declare const enum CommandName {
     OffsetItems = "oi",
     PatchDataItems = "pdi",
     ReloadExtension = "r",
+    SendOAuthRequest = "oauth",
     SendUIMessage = "suim",
     SendXHR = "xhr",
     SetCurrentPage = "scp",
     SetProperty = "sp",
     SetReferenceKey = "srk",
     SetShapeData = "ssd",
-    ShowModal = "sm"
+    ShowModal = "sm",
+    SleepForTestCase = "sleep"
 }
 export declare type CommandArgs = {
     [CommandName.AnimateViewport]: {
@@ -73,6 +76,10 @@ export declare type CommandArgs = {
         query: AddShapeDataQuery;
         result: AddShapeDataResult;
     };
+    [CommandName.Bootstrap]: {
+        query: BootstrapQuery;
+        result: BootstrapResult;
+    };
     [CommandName.CreateBlock]: {
         query: CreateBlockQuery;
         result: CreateBlockResult;
@@ -237,6 +244,10 @@ export declare type CommandArgs = {
         query: ReloadExtensionQuery;
         result: ReloadExtensionResult;
     };
+    [CommandName.SendOAuthRequest]: {
+        query: SendOAuthRequestQuery;
+        result: SendOAuthRequestResponse;
+    };
     [CommandName.SendUIMessage]: {
         query: SendUIMessageQuery;
         result: SendUIMessageResult;
@@ -265,6 +276,10 @@ export declare type CommandArgs = {
         query: ShowModalQuery;
         result: ShowModalResult;
     };
+    [CommandName.SleepForTestCase]: {
+        query: SleepForTestCaseQuery;
+        result: SleepForTestCaseResult;
+    };
 };
 export declare type UnionToIntersection<T> = (T extends any ? (x: T) => unknown : never) extends (x: infer R) => unknown ? R : never;
 export declare type AddMenuItemQuery = {
@@ -283,6 +298,14 @@ export declare type AddShapeDataQuery = {
     'v'?: SerializedFieldType;
 };
 export declare type AddShapeDataResult = undefined;
+export declare type BootstrapQuery = {
+    /**
+     * Named action that accepts the bootstrap data, and which may return a Promise or void. After awaiting\
+     * the result of the callback, the bootstrap data is cleared.
+     */
+    'c': string;
+};
+export declare type BootstrapResult = Promise<void>;
 export declare type CreateBlockQuery = {
     'p'?: string;
     'c': string;
@@ -451,6 +474,10 @@ export declare type PatchDataItemsQuery = {
 export declare type PatchDataItemsResult = undefined;
 export declare type ReloadExtensionQuery = void;
 export declare type ReloadExtensionResult = undefined;
+export declare type SendOAuthRequestQuery = SendXHRQuery & {
+    'p': string;
+};
+export declare type SendOAuthRequestResponse = SendXHRResponse;
 export declare type SendUIMessageQuery = {
     'n': string;
     'd'?: JsonSerializable;
@@ -511,3 +538,5 @@ export declare type ShowModalQuery = {
     'c': string;
 };
 export declare type ShowModalResult = undefined;
+export declare type SleepForTestCaseQuery = number;
+export declare type SleepForTestCaseResult = Promise<void>;

package/sdk/document/blockdefinition.d.ts

@@ -15,7 +15,7 @@ export interface BlockDefinition {
     /**
      * Additional properties to set on the block immediately after creation
      */
-    properties: JsonObject;
+    properties?: JsonObject;
     /**
      * If specified, the stencil to use for a custom shape. This is not typically set directly; use
      * PageProxy.getCustomShapeDefinition().

package/sdk/document/documentproxy.d.ts

@@ -18,4 +18,13 @@ export declare class DocumentProxy extends ElementProxy {
      * @returns the created page
      */
     addPage(def: PageDefinition): PageProxy;
+    /**
+     * Updates the title of this document
+     * @param title The new title for this document
+     */
+    setTitle(title: string): void;
+    /**
+     * @returns the title of this document
+     */
+    getTitle(): string;
 }

package/sdk/document/documentproxy.js

@@ -26,5 +26,18 @@ class DocumentProxy extends elementproxy_1.ElementProxy {
         page.setTitle(def.title);
         return page;
     }
+    /**
+     * Updates the title of this document
+     * @param title The new title for this document
+     */
+    setTitle(title) {
+        this.properties.set('Title', title);
+    }
+    /**
+     * @returns the title of this document
+     */
+    getTitle() {
+        return this.properties.get('Title');
+    }
 }
 exports.DocumentProxy = DocumentProxy;

package/sdk/document/pageproxy.js

@@ -59,8 +59,10 @@ class PageProxy extends elementproxy_1.ElementProxy {
         });
         const block = this.client.getBlockProxy(id);
         block.setBoundingBox(def.boundingBox);
-        for (const key in def.properties) {
-            block.properties.set(key, def.properties[key]);
+        if (def.properties) {
+            for (const key in def.properties) {
+                block.properties.set(key, def.properties[key]);
+            }
         }
         return block;
     }

package/sdk/editorclient.d.ts

@@ -36,6 +36,7 @@ export interface XHRResponse {
 export declare class EditorClient {
     private nextId;
     private readonly callbacks;
+    private getUniqueActionName;
     /**
      * Unload this extension immediately, removing any custom menu items etc., until the user refreshes the browser tab.
      */
@@ -59,6 +60,7 @@ export declare class EditorClient {
      *   code is not 2xx, the promise will reject.
      */
     xhr(request: XHRRequest): Promise<XHRResponse>;
+    oauthXhr(providerName: string, request: XHRRequest): Promise<XHRResponse>;
     /**
      * Register a named action. These actions can be triggered from custom UI, for example as the action of a
      * custom menu item.
@@ -142,6 +144,17 @@ export declare class EditorClient {
      * @returns
      */
     getCustomShapeDefinition(library: string, shape: string): Promise<BlockDefinition | undefined>;
+    /**
+     * @param callback A callback that processes the bootstrap data, if any, stored on the document and
+     * associated with this editor extension. If this callback is async (returns a promise), then the
+     * bootstrap data is not cleared off of the document until that promise resolves.
+     *
+     * @return a promise that resolves immediately if there is no available bootstrap data, or else after
+     * the callback successfully completes. This promise will reject/throw if the callback throws or
+     * returns a promise that rejects, or if there is another editor session processing the same bootstrap
+     * data at the same time.
+     */
+    processAndClearBootstrapData(callback: (data: JsonSerializable) => void | Promise<void>): Promise<void>;
     /**
      * @param id ID of the line to create a proxy for
      * @returns the given line

package/sdk/editorclient.js

@@ -15,6 +15,12 @@ class EditorClient {
         this.callbacks = new Map();
         this.listenToEditor();
     }
+    getUniqueActionName() {
+        while (this.actionExists('a' + this.nextId)) {
+            this.nextId++;
+        }
+        return 'a' + this.nextId;
+    }
     /**
      * Unload this extension immediately, removing any custom menu items etc., until the user refreshes the browser tab.
      */
@@ -75,6 +81,34 @@ class EditorClient {
             };
         });
     }
+    oauthXhr(providerName, request) {
+        return this.sendCommand("oauth" /* SendOAuthRequest */, {
+            'url': request.url,
+            'm': request.method,
+            'd': request.data,
+            'h': request.headers,
+            'ms': request.timeoutMs,
+            'p': providerName,
+        })
+            .then((raw) => {
+            return {
+                url: raw['url'],
+                responseText: raw['t'],
+                status: raw['s'],
+                headers: raw['h'],
+                timeout: raw['to'],
+            };
+        })
+            .catch((raw) => {
+            throw {
+                url: raw['url'],
+                responseText: raw['t'],
+                status: raw['s'],
+                headers: raw['h'],
+                timeout: raw['to'],
+            };
+        });
+    }
     /**
      * Register a named action. These actions can be triggered from custom UI, for example as the action of a
      * custom menu item.
@@ -196,6 +230,24 @@ class EditorClient {
         }
         return undefined;
     }
+    /**
+     * @param callback A callback that processes the bootstrap data, if any, stored on the document and
+     * associated with this editor extension. If this callback is async (returns a promise), then the
+     * bootstrap data is not cleared off of the document until that promise resolves.
+     *
+     * @return a promise that resolves immediately if there is no available bootstrap data, or else after
+     * the callback successfully completes. This promise will reject/throw if the callback throws or
+     * returns a promise that rejects, or if there is another editor session processing the same bootstrap
+     * data at the same time.
+     */
+    async processAndClearBootstrapData(callback) {
+        const name = this.getUniqueActionName();
+        this.registerAction(name, (msg) => {
+            return callback(msg['d']);
+        });
+        await this.sendCommand("b" /* Bootstrap */, { 'c': name });
+        this.deleteAction(name);
+    }
     /**
      * @param id ID of the line to create a proxy for
      * @returns the given line