lucid-extension-sdk 0.0.19 → 0.0.20

package/package.json

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

package/sdk/commandtypes.d.ts

@@ -432,6 +432,10 @@ export declare type BootstrapQuery = {
      * the result of the callback, the bootstrap data is cleared.
      */
     'c': string;
+    /**
+     * Marks a document as requiring the editor extension.
+     */
+    'm'?: boolean;
 };
 export declare type BootstrapResult = Promise<void>;
 export declare type ConfirmQuery = {

package/sdk/editorclient.d.ts

@@ -178,12 +178,17 @@ export declare class EditorClient {
      * 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.
      *
+     * @param markExtensionAsRequired If bootstrap data is available for this editor extension, this will mark the
+     * document as requiring the extension. Once marked, if the extension is not installed the user will be
+     * notified about the extension being required on document load. The minimum extension version required by the
+     * document is the version provided in the request body when creating the document.
+     *
      * @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>;
+    processAndClearBootstrapData(callback: (data: JsonSerializable) => void | Promise<void>, markExtensionAsRequired?: boolean): Promise<void>;
     /**
      * @param id ID of the line to create a proxy for
      * @returns the given line

package/sdk/editorclient.js

@@ -284,17 +284,22 @@ class EditorClient {
      * 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.
      *
+     * @param markExtensionAsRequired If bootstrap data is available for this editor extension, this will mark the
+     * document as requiring the extension. Once marked, if the extension is not installed the user will be
+     * notified about the extension being required on document load. The minimum extension version required by the
+     * document is the version provided in the request body when creating the document.
+     *
      * @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) {
+    async processAndClearBootstrapData(callback, markExtensionAsRequired) {
         const name = this.getUniqueActionName();
         this.registerAction(name, (msg) => {
             return callback(msg['d']);
         });
-        await this.sendCommand("b" /* Bootstrap */, { 'c': name });
+        await this.sendCommand("b" /* Bootstrap */, { 'c': name, 'm': markExtensionAsRequired });
         this.deleteAction(name);
     }
     /**