lucid-extension-sdk 0.0.5 → 0.0.6

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "lucid-extension-sdk",
-    "version": "0.0.5",
+    "version": "0.0.6",
     "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",
@@ -58,7 +59,8 @@ export declare const enum CommandName {
     SetProperty = "sp",
     SetReferenceKey = "srk",
     SetShapeData = "ssd",
-    ShowModal = "sm"
+    ShowModal = "sm",
+    SleepForTestCase = "sleep"
 }
 export declare type CommandArgs = {
     [CommandName.AnimateViewport]: {
@@ -73,6 +75,10 @@ export declare type CommandArgs = {
         query: AddShapeDataQuery;
         result: AddShapeDataResult;
     };
+    [CommandName.Bootstrap]: {
+        query: BootstrapQuery;
+        result: BootstrapResult;
+    };
     [CommandName.CreateBlock]: {
         query: CreateBlockQuery;
         result: CreateBlockResult;
@@ -265,6 +271,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 +293,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;
@@ -511,3 +529,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/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/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.
      */
@@ -142,6 +143,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.
      */
@@ -196,6 +202,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