lucid-extension-sdk 0.0.100 → 0.0.101

package/package.json

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

package/sdk/commandtypes.d.ts

@@ -62,6 +62,7 @@ export declare const enum CommandName {
     HideModal = "hm",
     HidePanel = "hp",
     HookCreateItems = "hci",
+    HookDeleteItems = "hdi",
     HookSelection = "hs",
     HookTextEdit = "hte",
     ImportCards = "ic",
@@ -103,6 +104,7 @@ export declare const enum CommandName {
     StartPDFUploadRequest = "pdf",
     ThrowForTestCase = "throw",
     UnhookCreateItems = "uci",
+    UnhookDeleteItems = "udi",
     UnhookSelection = "us",
     UnhookTextEdit = "ute"
 }
@@ -286,6 +288,10 @@ export declare type CommandArgs = {
         query: HookCreateItemsQuery;
         result: HookCreateItemsResult;
     };
+    [CommandName.HookDeleteItems]: {
+        query: HookDeleteItemsQuery;
+        result: HookDeleteItemsResult;
+    };
     [CommandName.HookSelection]: {
         query: HookSelectionQuery;
         result: HookSelectionResult;
@@ -450,6 +456,10 @@ export declare type CommandArgs = {
         query: UnhookCreateItemsQuery;
         result: UnhookCreateItemsResult;
     };
+    [CommandName.UnhookDeleteItems]: {
+        query: UnhookDeleteItemsQuery;
+        result: UnhookDeleteItemsResult;
+    };
     [CommandName.UnhookSelection]: {
         query: UnhookSelectionQuery;
         result: UnhookSelectionResult;
@@ -824,6 +834,11 @@ export declare type HookCreateItemsQuery = {
     'n': string;
 };
 export declare type HookCreateItemsResult = undefined;
+export declare type HookDeleteItemsQuery = {
+    /** Name of the action for receiving events. Will be called with an array of strings of all recently deleted item IDs. */
+    'n': string;
+};
+export declare type HookDeleteItemsResult = undefined;
 export declare type HookSelectionQuery = {
     /** Name of the action for receiving events. Will be called with an array of strings of all selected item IDs. */
     'n': string;
@@ -1092,6 +1107,11 @@ export declare type UnhookCreateItemsQuery = {
     'n': string;
 };
 export declare type UnhookCreateItemsResult = undefined;
+export declare type UnhookDeleteItemsQuery = {
+    /** Name of the action passed to HookDeleteItems */
+    'n': string;
+};
+export declare type UnhookDeleteItemsResult = undefined;
 export declare type UnhookSelectionQuery = {
     /** Name of the action for receiving these events */
     'n': string;

package/sdk/commandtypes.js

@@ -45,6 +45,7 @@ exports.commandTitles = new Map([
     ["hm" /* CommandName.HideModal */, 'HideModal'],
     ["hp" /* CommandName.HidePanel */, 'HidePanel'],
     ["hci" /* CommandName.HookCreateItems */, 'HookCreateItems'],
+    ["hdi" /* CommandName.HookDeleteItems */, 'HookDeleteItems'],
     ["hs" /* CommandName.HookSelection */, 'HookSelection'],
     ["hte" /* CommandName.HookTextEdit */, 'HookTextEdit'],
     ["ic" /* CommandName.ImportCards */, 'ImportCards'],
@@ -84,6 +85,7 @@ exports.commandTitles = new Map([
     ["pdf" /* CommandName.StartPDFUploadRequest */, 'StartPDFUploadRequest'],
     ["throw" /* CommandName.ThrowForTestCase */, 'ThrowForTestCase'],
     ["uci" /* CommandName.UnhookCreateItems */, 'UnhookCreateItems'],
+    ["udi" /* CommandName.UnhookDeleteItems */, 'UnhookDeleteItems'],
     ["us" /* CommandName.UnhookSelection */, 'UnhookSelection'],
     ["ute" /* CommandName.UnhookTextEdit */, 'UnhookTextEdit'],
 ]);

package/sdk/document/documentproxy.d.ts

@@ -41,7 +41,6 @@ export declare class DocumentProxy extends ElementProxy {
      * created
      *
      *  - As part of a generated diagram, e.g. org chart
-     *  - As a result of undo or redo
      *  - By another user on the same document
      *
      * @param callback
@@ -53,4 +52,20 @@ export declare class DocumentProxy extends ElementProxy {
      */
     unhookCreateItems(handle: string): void;
     readonly cardIntegrationConfigs: MapProxy<string, CardConfigProxy>;
+    /**
+     * Watch for new blocks, lines, or groups deleted from this document. The callback will
+     * be called with items deleted by the current user, but will not be called with items
+     * deleted
+     *
+     *  - As part of a generated diagram, e.g. org chart
+     *  - By another user on the same document
+     *
+     * @param callback
+     * @returns A handle that can be passed to `unhookDeleteItems`
+     */
+    hookDeleteItems(callback: (itemIds: string[]) => void): string;
+    /**
+     * @param handle Return value from `hookDeleteItems`
+     */
+    unhookDeleteItems(handle: string): void;
 }

package/sdk/document/documentproxy.js

@@ -61,7 +61,6 @@ class DocumentProxy extends elementproxy_1.ElementProxy {
      * created
      *
      *  - As part of a generated diagram, e.g. org chart
-     *  - As a result of undo or redo
      *  - By another user on the same document
      *
      * @param callback
@@ -82,6 +81,32 @@ class DocumentProxy extends elementproxy_1.ElementProxy {
         this.client.deleteAction(handle);
         this.client.sendCommand("uci" /* CommandName.UnhookCreateItems */, { 'n': handle });
     }
+    /**
+     * Watch for new blocks, lines, or groups deleted from this document. The callback will
+     * be called with items deleted by the current user, but will not be called with items
+     * deleted
+     *
+     *  - As part of a generated diagram, e.g. org chart
+     *  - By another user on the same document
+     *
+     * @param callback
+     * @returns A handle that can be passed to `unhookDeleteItems`
+     */
+    hookDeleteItems(callback) {
+        const actionName = DocumentProxy.getNextHookName();
+        this.client.registerAction(actionName, (msg) => {
+            callback(msg['ids']);
+        });
+        this.client.sendCommand("hdi" /* CommandName.HookDeleteItems */, { 'n': actionName });
+        return actionName;
+    }
+    /**
+     * @param handle Return value from `hookDeleteItems`
+     */
+    unhookDeleteItems(handle) {
+        this.client.deleteAction(handle);
+        this.client.sendCommand("udi" /* CommandName.UnhookDeleteItems */, { 'n': handle });
+    }
 }
 exports.DocumentProxy = DocumentProxy;
 DocumentProxy.nextHookId = 0;