lucid-extension-sdk 0.0.15 → 0.0.20

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "lucid-extension-sdk",
-    "version": "0.0.15",
+    "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

@@ -29,6 +29,7 @@ export declare const enum CommandName {
     CreateDataSource = "cds",
     CreateLine = "cl",
     CreatePage = "cp",
+    DataAction = "da",
     DeleteItem = "di",
     DeletePage = "dp",
     DeleteShapeData = "dsd",
@@ -80,10 +81,13 @@ export declare const enum CommandName {
     ShowModal = "sm",
     ShowPanel = "spn",
     SleepForTestCase = "sleep",
+    ThrowForTestCase = "throw",
     UnhookCreateItems = "uci",
     UnhookSelection = "us",
     UnhookTextEdit = "ute"
 }
+/** @ignore */
+export declare const commandTitles: Map<CommandName, string>;
 /**
  * This is a type declaration whose purpose is to allow TypeScript to enforce the correct parameter and
  * return types from [EditorClient.sendCommand](#classes_editorclient-EditorClient_sendcommand) based on
@@ -138,6 +142,10 @@ export declare type CommandArgs = {
         query: CreatePageQuery;
         result: CreatePageResult;
     };
+    [CommandName.DataAction]: {
+        query: DataActionQuery;
+        result: DataActionResult;
+    };
     [CommandName.DeleteItem]: {
         query: DeleteItemQuery;
         result: DeleteItemResult;
@@ -342,6 +350,10 @@ export declare type CommandArgs = {
         query: SleepForTestCaseQuery;
         result: SleepForTestCaseResult;
     };
+    [CommandName.ThrowForTestCase]: {
+        query: ThrowForTestCaseQuery;
+        result: ThrowForTestCaseResult;
+    };
     [CommandName.UnhookCreateItems]: {
         query: UnhookCreateItemsQuery;
         result: UnhookCreateItemsResult;
@@ -420,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 = {
@@ -482,6 +498,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 Nonce */
+    '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;
@@ -795,6 +834,8 @@ export declare type ShowPanelQuery = {
 export declare type ShowPanelResult = undefined;
 export declare type SleepForTestCaseQuery = number;
 export declare type SleepForTestCaseResult = Promise<void>;
+export declare type ThrowForTestCaseQuery = number;
+export declare type ThrowForTestCaseResult = undefined | Promise<void>;
 export declare type UnhookCreateItemsQuery = {
     /** Name of the action passed to HookCreateItems */
     'n': string;

package/sdk/commandtypes.js

@@ -1,7 +1,77 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isRawSendXHRResponse = void 0;
+exports.isRawSendXHRResponse = exports.commandTitles = void 0;
 const checks_1 = require("./core/checks");
+/** @ignore */
+exports.commandTitles = new Map([
+    ["alta" /* AddLineTextArea */, 'AddLineTextArea'],
+    ["ami" /* AddMenuItem */, 'AddMenuItem'],
+    ["asd" /* AddShapeData */, 'AddShapeData'],
+    ["a" /* Alert */, 'Alert'],
+    ["av" /* AnimateViewport */, 'AnimateViewport'],
+    ["b" /* Bootstrap */, 'Bootstrap'],
+    ["c" /* Confirm */, 'Confirm'],
+    ["cb" /* CreateBlock */, 'CreateBlock'],
+    ["cc" /* CreateCollection */, 'CreateCollection'],
+    ["cds" /* CreateDataSource */, 'CreateDataSource'],
+    ["cl" /* CreateLine */, 'CreateLine'],
+    ["cp" /* CreatePage */, 'CreatePage'],
+    ["di" /* DeleteItem */, 'DeleteItem'],
+    ["dp" /* DeletePage */, 'DeletePage'],
+    ["dsd" /* DeleteShapeData */, 'DeleteShapeData'],
+    ["d" /* Download */, 'Download'],
+    ["ee" /* ElementExists */, 'ElementExists'],
+    ["ef" /* ExecuteFormula */, 'ExecuteFormula'],
+    ["gcl" /* GetConnectedLines */, 'GetConnectedLines'],
+    ["gcp" /* GetCurrentPage */, 'GetCurrentPage'],
+    ["gcs" /* GetCustomShape */, 'GetCustomShape'],
+    ["gdif" /* GetDataItemField */, 'GetDataItemField'],
+    ["get" /* GetElementType */, 'GetElementType'],
+    ["gip" /* GetItemPageId */, 'GetItemPageId'],
+    ["gp" /* GetProperty */, 'GetProperty'],
+    ["grk" /* GetReferenceKey */, 'GetReferenceKey'],
+    ["grlp" /* GetRelativeLinePosition */, 'GetRelativeLinePosition'],
+    ["gs" /* GetSelection */, 'GetSelection'],
+    ["gsd" /* GetShapeData */, 'GetShapeData'],
+    ["hm" /* HideModal */, 'HideModal'],
+    ["hp" /* HidePanel */, 'HidePanel'],
+    ["hci" /* HookCreateItems */, 'HookCreateItems'],
+    ["hs" /* HookSelection */, 'HookSelection'],
+    ["hte" /* HookTextEdit */, 'HookTextEdit'],
+    ["k" /* KillExtension */, 'KillExtension'],
+    ["lb" /* ListBlocks */, 'ListBlocks'],
+    ["lcf" /* ListCollectionFields */, 'ListCollectionFields'],
+    ["lc" /* ListCollections */, 'ListCollections'],
+    ["ldi" /* ListDataItems */, 'ListDataItems'],
+    ["lds" /* ListDataSources */, 'ListDataSources'],
+    ["lg" /* ListGroups */, 'ListGroups'],
+    ["ll" /* ListLines */, 'ListLines'],
+    ["lp" /* ListPages */, 'ListPages'],
+    ["lpr" /* ListProperties */, 'ListProperties'],
+    ["lrk" /* ListReferenceKeys */, 'ListReferenceKeys'],
+    ["lsd" /* ListShapeData */, 'ListShapeData'],
+    ["lta" /* ListTextAreas */, 'ListTextAreas'],
+    ["lbc" /* LoadBlockClasses */, 'LoadBlockClasses'],
+    ["log" /* LogForTestCase */, 'LogForTestCase'],
+    ["oi" /* OffsetItems */, 'OffsetItems'],
+    ["pdi" /* PatchDataItems */, 'PatchDataItems'],
+    ["rp" /* RegisterPanel */, 'RegisterPanel'],
+    ["r" /* ReloadExtension */, 'ReloadExtension'],
+    ["oauth" /* SendOAuthRequest */, 'SendOAuthRequest'],
+    ["suim" /* SendUIMessage */, 'SendUIMessage'],
+    ["xhr" /* SendXHR */, 'SendXHR'],
+    ["scp" /* SetCurrentPage */, 'SetCurrentPage'],
+    ["sp" /* SetProperty */, 'SetProperty'],
+    ["srk" /* SetReferenceKey */, 'SetReferenceKey'],
+    ["ssd" /* SetShapeData */, 'SetShapeData'],
+    ["sm" /* ShowModal */, 'ShowModal'],
+    ["spn" /* ShowPanel */, 'ShowPanel'],
+    ["sleep" /* SleepForTestCase */, 'SleepForTestCase'],
+    ["throw" /* ThrowForTestCase */, 'ThrowForTestCase'],
+    ["uci" /* UnhookCreateItems */, 'UnhookCreateItems'],
+    ["us" /* UnhookSelection */, 'UnhookSelection'],
+    ["ute" /* UnhookTextEdit */, 'UnhookTextEdit'],
+]);
 function isRawSendXHRResponse(val) {
     return (0, checks_1.isString)(val['url']) && (0, checks_1.isString)(val['t']) && (0, checks_1.isNumber)(val['s']) && (0, checks_1.isObject)(val['h']);
 }

package/sdk/core/data/serializedfield/serializedfielddefinition.d.ts

@@ -11,7 +11,8 @@ export declare enum FieldConstraintType {
     LOCKED = "locked",
     MIN_VALUE = "minValue",
     MAX_VALUE = "maxValue",
-    SINGLE_LINE_ONLY = "singleLineOnly"
+    SINGLE_LINE_ONLY = "singleLineOnly",
+    NO_WHITESPACE = "noWhitespace"
 }
 export declare type SerializedFieldConstraint = {
     'Type': FieldConstraintType;

package/sdk/core/data/serializedfield/serializedfielddefinition.js

@@ -9,4 +9,5 @@ var FieldConstraintType;
     FieldConstraintType["MIN_VALUE"] = "minValue";
     FieldConstraintType["MAX_VALUE"] = "maxValue";
     FieldConstraintType["SINGLE_LINE_ONLY"] = "singleLineOnly";
+    FieldConstraintType["NO_WHITESPACE"] = "noWhitespace";
 })(FieldConstraintType = exports.FieldConstraintType || (exports.FieldConstraintType = {}));

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?: undefined | string, flowData?: unknown, async?: boolean): Promise<DataActionResult>;
     /**
      * Make a network request
      * @param request Settings for the network request
@@ -157,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

@@ -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 = undefined, 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
@@ -255,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);
     }
     /**