lucid-extension-sdk 0.0.123 → 0.0.124

package/package.json

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

package/sdk/editorclient.d.ts

@@ -20,6 +20,13 @@ export declare type DataActionResponse = {
     /** The body of the HTTP Response (otherwise) */
     'text': string;
 });
+export declare type DataActionOptions = {
+    dataConnectorName: string;
+    actionName: string;
+    actionData?: unknown;
+    syncDataSourceIdNonce?: string;
+    asynchronous?: boolean;
+};
 export declare class EditorClient {
     private nextId;
     private readonly callbacks;
@@ -58,17 +65,7 @@ export declare class EditorClient {
      * @deprecated Use createUserImage instead.
      */
     experimentalCreateUserImage(mediaType: string, data: Uint8Array | string): Promise<string>;
-    /**
-     *
-     * @param flowName
-     * @param dataConnectorName
-     * @param syncDataSourceId
-     * @param flowData
-     * @param async
-     * @returns
-     * @throws A string with an error from the data sync server
-     */
-    performDataAction(flowName: string, dataConnectorName: string, syncDataSourceId?: undefined | string, flowData?: unknown, async?: boolean): Promise<DataActionResponse>;
+    performDataAction(options: DataActionOptions): Promise<DataActionResponse>;
     /**
      * If the extension package containing this editor extension has configurable settings,
      * show a standard modal allowing the user to view or change those settings.

package/sdk/editorclient.js

@@ -96,23 +96,16 @@ class EditorClient {
     experimentalCreateUserImage(mediaType, data) {
         return this.createUserImage(mediaType, data);
     }
-    /**
-     *
-     * @param flowName
-     * @param dataConnectorName
-     * @param syncDataSourceId
-     * @param flowData
-     * @param async
-     * @returns
-     * @throws A string with an error from the data sync server
-     */
-    async performDataAction(flowName, dataConnectorName, syncDataSourceId = undefined, flowData = undefined, async = true) {
+    async performDataAction(options) {
+        if (options.asynchronous === undefined) {
+            options.asynchronous = true;
+        }
         const result = await this.sendCommand("da" /* CommandName.DataAction */, {
-            'fn': flowName,
-            'a': async,
-            's': syncDataSourceId,
-            'fd': flowData,
-            'n': dataConnectorName,
+            'fn': options.actionName,
+            'a': options.asynchronous,
+            's': options.syncDataSourceIdNonce,
+            'fd': options.actionData,
+            'n': options.dataConnectorName,
         });
         if ('t' in result) {
             return {