lucid-extension-sdk 0.0.156 → 0.0.157

package/commandtypes.d.ts

@@ -120,6 +120,7 @@ export declare const enum CommandName {
     UnhookSelection = "us",
     UnhookTextEdit = "ute",
     WithMutex = "wm",
+    WithSilentActions = "wsa",
     ZOrder = "z"
 }
 /** @ignore */
@@ -530,6 +531,10 @@ export declare type CommandArgs = {
         query: WithMutexQuery;
         result: WithMutexResult;
     };
+    [CommandName.WithSilentActions]: {
+        query: WithSilentActionsQuery;
+        result: WithSilentActionsResult;
+    };
     [CommandName.ZOrder]: {
         query: ZOrderQuery;
         result: ZOrderResult;
@@ -1294,6 +1299,11 @@ export declare type WithMutexQuery = {
 };
 /** Resolves true if operation succeeded, or false if the mutex was held by someone else */
 export declare type WithMutexResult = Promise<boolean>;
+export declare type WithSilentActionsQuery = {
+    /** Name of the synchronous action to run with undo/redo history suppressed */
+    'a': string;
+};
+export declare type WithSilentActionsResult = void;
 export declare enum ZOrderOperation {
     UP = 1,
     TOP = 2,

package/commandtypes.js

@@ -100,6 +100,7 @@ exports.commandTitles = new Map([
     ["us" /* CommandName.UnhookSelection */, 'UnhookSelection'],
     ["ute" /* CommandName.UnhookTextEdit */, 'UnhookTextEdit'],
     ["wm" /* CommandName.WithMutex */, 'WithMutex'],
+    ["wsa" /* CommandName.WithSilentActions */, 'WithSilentActions'],
     ["z" /* CommandName.ZOrder */, 'ZOrder'],
 ]);
 var GetItemsAtSearchType;

package/editorclient.d.ts

@@ -325,5 +325,12 @@ export declare class EditorClient {
      * @returns A promise resolving to a boolean indicating whether the mutex was successfully locked
      */
     withIntraDocumentMutex(name: string, callback: () => void | Promise<void>): Promise<boolean>;
+    /**
+     * @param callback Callback that will be executed with the user's local undo/redo history suppressed. This is
+     * useful when you want to make changes to a document that will not be erased if the user uses undo or redo,
+     * for example adding shape data onto shapes as a result of a background process that collects data from a
+     * remote API.
+     */
+    withSilentActions(callback: () => void): void;
     constructor();
 }

package/editorclient.js

@@ -545,7 +545,28 @@ class EditorClient {
             return await this.sendCommand("wm" /* CommandName.WithMutex */, { 'n': name, 'a': action });
         }
         finally {
-            this.deleteAction(name);
+            this.deleteAction(action);
+        }
+    }
+    /**
+     * @param callback Callback that will be executed with the user's local undo/redo history suppressed. This is
+     * useful when you want to make changes to a document that will not be erased if the user uses undo or redo,
+     * for example adding shape data onto shapes as a result of a background process that collects data from a
+     * remote API.
+     */
+    withSilentActions(callback) {
+        const action = this.getUniqueActionName();
+        this.registerAction(action, () => {
+            const result = callback();
+            if ((0, checks_1.isPromise)(result)) {
+                throw new Error('withSilentActions cannot be used with an async callback');
+            }
+        });
+        try {
+            this.sendCommand("wsa" /* CommandName.WithSilentActions */, { 'a': action });
+        }
+        finally {
+            this.deleteAction(action);
         }
     }
 }

package/package.json

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