lucid-extension-sdk 0.0.15 → 0.0.16

package/package.json

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

package/sdk/commandtypes.d.ts

@@ -29,6 +29,7 @@ export declare const enum CommandName {
     CreateDataSource = "cds",
     CreateLine = "cl",
     CreatePage = "cp",
+    DataAction = "da",
     DeleteItem = "di",
     DeletePage = "dp",
     DeleteShapeData = "dsd",
@@ -138,6 +139,10 @@ export declare type CommandArgs = {
         query: CreatePageQuery;
         result: CreatePageResult;
     };
+    [CommandName.DataAction]: {
+        query: DataActionQuery;
+        result: DataActionResult;
+    };
     [CommandName.DeleteItem]: {
         query: DeleteItemQuery;
         result: DeleteItemResult;
@@ -482,6 +487,29 @@ export declare type CreateLineQuery = {
 export declare type CreateLineResult = string;
 export declare type CreatePageQuery = void;
 export declare type CreatePageResult = string;
+export declare type DataActionQuery = {
+    /** Flow Name */
+    'fn': string;
+    /** Is Async */
+    'a': boolean;
+    /** Flow Data */
+    'fd'?: unknown;
+    /** Sync data source ID */
+    's': string;
+    /** Data Connector Name */
+    'n': string;
+};
+export declare type RawDataActionResult = {
+    /** The external service responded with this code */
+    'c': number;
+} & ({
+    /** And this text */
+    't': string;
+} | {
+    /** Or this JSON */
+    'j': unknown;
+});
+export declare type DataActionResult = Promise<RawDataActionResult>;
 export declare type DeleteItemQuery = string;
 export declare type DeleteItemResult = boolean;
 export declare type DeletePageQuery = string;

package/sdk/editorclient.d.ts

@@ -35,6 +35,16 @@ export interface XHRResponse {
     /** True if this request failed due to a timeout */
     timeout?: boolean;
 }
+export declare type DataActionResult = {
+    /** The HTTP Status Code from the Extension Data Sync endpoint */
+    'status': number;
+} & ({
+    /** The body of the HTTP Response (if Content-Type: application/json) */
+    'json': unknown;
+} | {
+    /** The body of the HTTP Response (otherwise) */
+    'text': string;
+});
 export declare class EditorClient {
     private nextId;
     private readonly callbacks;
@@ -55,6 +65,17 @@ export declare class EditorClient {
      * @param base64 If true, base64 decode the data before downloading it
      */
     download(filename: string, data: string, mime: string, base64: boolean): void;
+    /**
+     *
+     * @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: string, flowData?: unknown, async?: boolean): Promise<DataActionResult>;
     /**
      * Make a network request
      * @param request Settings for the network request

package/sdk/editorclient.js

@@ -49,6 +49,35 @@ class EditorClient {
             'b64': base64,
         });
     }
+    /**
+     *
+     * @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, flowData = undefined, async = true) {
+        const result = await this.sendCommand("da" /* DataAction */, {
+            'fn': flowName,
+            'a': async,
+            's': syncDataSourceId,
+            'fd': flowData,
+            'n': dataConnectorName,
+        });
+        if ('t' in result) {
+            return {
+                'status': result['c'],
+                'text': result['t'],
+            };
+        }
+        return {
+            'status': result['c'],
+            'json': result['j'],
+        };
+    }
     /**
      * Make a network request
      * @param request Settings for the network request