lucid-extension-sdk 0.0.13 → 0.0.15

package/package.json

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

package/sdk/commandtypes.d.ts

@@ -20,8 +20,10 @@ export declare const enum CommandName {
     AddLineTextArea = "alta",
     AddMenuItem = "ami",
     AddShapeData = "asd",
+    Alert = "a",
     AnimateViewport = "av",
     Bootstrap = "b",
+    Confirm = "c",
     CreateBlock = "cb",
     CreateCollection = "cc",
     CreateDataSource = "cds",
@@ -100,6 +102,10 @@ export declare type CommandArgs = {
         query: AddShapeDataQuery;
         result: AddShapeDataResult;
     };
+    [CommandName.Alert]: {
+        query: AlertQuery;
+        result: AlertResult;
+    };
     [CommandName.AnimateViewport]: {
         query: AnimateViewportQuery;
         result: AnimateViewportResult;
@@ -108,6 +114,10 @@ export declare type CommandArgs = {
         query: BootstrapQuery;
         result: BootstrapResult;
     };
+    [CommandName.Confirm]: {
+        query: ConfirmQuery;
+        result: ConfirmResult;
+    };
     [CommandName.CreateBlock]: {
         query: CreateBlockQuery;
         result: CreateBlockResult;
@@ -361,7 +371,7 @@ export declare type AddMenuItemQuery = {
     /** Label to display on the menu item */
     'l': string;
     /** Named action to run when the menu item is clicked */
-    'a': string;
+    'a'?: string;
     /** Named action that returns whether the menu item should be visible */
     'v'?: string;
     /** Named action that returns whether the menu item should be disabled */
@@ -370,6 +380,17 @@ export declare type AddMenuItemQuery = {
     't': MenuType;
     /** If specified, where to place the menu item; defaults to MenuLocation.Extension */
     'loc'?: MenuLocation;
+    /** If specified, this menu item should launch a file picker */
+    'f'?: {
+        /** Action to call when files are selected */
+        'a': string;
+        /** File types to accept */
+        'ac': string;
+        /** Single file only */
+        's'?: boolean;
+        /** Return content in a binary ArrayBuffer instead of as text */
+        'b'?: boolean;
+    };
 };
 export declare type AddMenuItemResult = undefined;
 export declare type AddShapeDataQuery = {
@@ -383,6 +404,16 @@ export declare type AddShapeDataQuery = {
     'v'?: SerializedFieldType;
 };
 export declare type AddShapeDataResult = undefined;
+export declare type AlertQuery = {
+    /** Title; defaults to extension title */
+    't'?: string;
+    /** Body text */
+    'b': string;
+    /** Button text; defaults to i18n'ed "OK" */
+    'bt'?: string;
+};
+/** True if they click OK, false otherwise */
+export declare type AlertResult = Promise<boolean>;
 export declare type BootstrapQuery = {
     /**
      * Named action that accepts the bootstrap data, and which may return a Promise or void. After awaiting\
@@ -391,6 +422,18 @@ export declare type BootstrapQuery = {
     'c': string;
 };
 export declare type BootstrapResult = Promise<void>;
+export declare type ConfirmQuery = {
+    /** Title; defaults to extension title */
+    't'?: string;
+    /** Body text */
+    'b': string;
+    /** OK button text; defaults to i18n'ed "OK" */
+    'o'?: string;
+    /** Cancel button text; defaults to i18n'ed "Cancel" */
+    'c'?: string;
+};
+/** True if they click OK, false otherwise */
+export declare type ConfirmResult = Promise<boolean>;
 export declare type CreateBlockQuery = {
     /**
      * By default, we add the block to the current page & currently active group. If specified, the

package/sdk/core/base64.d.ts

@@ -0,0 +1 @@
+export declare function decodeBase64(base64String: string): Uint8Array;

package/sdk/core/base64.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.decodeBase64 = void 0;
+const alphabet = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=';
+//This gives a ~8x speedup vs. using alphabet.indexOf() in the main decode loop.
+const charCodeToEncodedInt = [];
+for (let i = 0; i < alphabet.length; i++) {
+    charCodeToEncodedInt[alphabet.charCodeAt(i)] = i;
+}
+function decodeBase64(base64String) {
+    //Filter out whitespace, etc
+    base64String = base64String.replace(/[^A-Za-z0-9\+\/\=]/g, '');
+    if (base64String.length % 4 !== 0) {
+        throw new Error('Invalid base64 input; length must be a multiple of 4');
+    }
+    //4 characters of input turns into 3 bytes of output
+    let bytes = (base64String.length / 4) * 3;
+    //But each trailing = (up to 2) is one fewer byte of output
+    if (base64String.endsWith('==')) {
+        bytes -= 2;
+    }
+    else if (base64String.endsWith('=')) {
+        bytes -= 1;
+    }
+    const output = new Uint8Array(bytes);
+    let inputIndex = 0;
+    for (let outputIndex = 0; outputIndex < bytes; outputIndex += 3) {
+        //Get the 4 numbers 0-63 encoded in the next 4 characters
+        const enc1 = charCodeToEncodedInt[base64String.charCodeAt(inputIndex++)];
+        const enc2 = charCodeToEncodedInt[base64String.charCodeAt(inputIndex++)];
+        const enc3 = charCodeToEncodedInt[base64String.charCodeAt(inputIndex++)];
+        const enc4 = charCodeToEncodedInt[base64String.charCodeAt(inputIndex++)];
+        //Read 8 total bits into each of the output values. Skip one byte
+        //for each padding = at the end of the string
+        output[outputIndex] = (enc1 << 2) | (enc2 >> 4);
+        if (enc3 != 64) {
+            output[outputIndex + 1] = ((enc2 & 15) << 4) | (enc3 >> 2);
+        }
+        if (enc4 != 64) {
+            output[outputIndex + 2] = ((enc3 & 3) << 6) | enc4;
+        }
+    }
+    return output;
+}
+exports.decodeBase64 = decodeBase64;

package/sdk/data/datasourceproxy.js

@@ -35,7 +35,9 @@ class DataSourceProxy extends propertystoreproxy_1.PropertyStoreProxy {
         return new collectionproxy_1.CollectionProxy(this.client.sendCommand("cc" /* CreateCollection */, {
             's': this.id,
             'n': name,
-            'f': schema.fields.map((field) => ({ 'n': field.name, 't': (0, fieldtypedefinition_1.serializeFieldTypeDefinition)(field.type) })),
+            'f': schema.fields.map((field) => {
+                return { 'n': field.name, 't': (0, fieldtypedefinition_1.serializeFieldTypeDefinition)(field.type) };
+            }),
             'p': schema.primaryKey,
         }), this.client);
     }

package/sdk/data/schemadefinition.js

@@ -5,10 +5,12 @@ const fieldtypedefinition_1 = require("../core/data/fieldtypedefinition/fieldtyp
 /** @ignore */
 function serializeSchemaDefinition(def) {
     return {
-        'Fields': def.fields.map((field) => ({
-            'Name': field.name,
-            'Type': (0, fieldtypedefinition_1.serializeFieldTypeDefinition)(field.type),
-        })),
+        'Fields': def.fields.map((field) => {
+            return {
+                'Name': field.name,
+                'Type': (0, fieldtypedefinition_1.serializeFieldTypeDefinition)(field.type),
+            };
+        }),
         'PrimaryKey': def.primaryKey,
     };
 }
@@ -16,10 +18,12 @@ exports.serializeSchemaDefinition = serializeSchemaDefinition;
 /** @ignore */
 function parseSchemaDefinition(def) {
     return {
-        fields: def['Fields'].map((field) => ({
-            name: field['Name'],
-            type: (0, fieldtypedefinition_1.deserializeFieldTypeDefinition)(field['Type']),
-        })),
+        fields: def['Fields'].map((field) => {
+            return {
+                name: field['Name'],
+                type: (0, fieldtypedefinition_1.deserializeFieldTypeDefinition)(field['Type']),
+            };
+        }),
         primaryKey: def['PrimaryKey'],
     };
 }

package/sdk/editorclient.d.ts

@@ -6,6 +6,7 @@ import { ElementProxy } from './document/elementproxy';
 import { GroupProxy } from './document/groupproxy';
 import { LineProxy } from './document/lineproxy';
 import { PageProxy } from './document/pageproxy';
+import { FileUploadData } from './ui/menu';
 export interface XHRRequest {
     /** URL to request */
     url: string;
@@ -77,6 +78,13 @@ export declare class EditorClient {
      * @param callback function to execute when this action is invoked
      */
     registerAction(name: string, callback: (value: any) => JsonSerializable | void | Promise<any>): void;
+    /**
+     * Register a named action that receives file upload data. These callbacks can be used in
+     * Menu.addMenuItem as the file action.
+     * @param name The name of the action
+     * @param callback Function to execute when this action is invoked
+     */
+    registerFileUploadAction(name: string, callback: (files: FileUploadData[]) => void): void;
     /**
      * Remove the callback for a given action. If the action is later invoked, nothing will happen.
      * @param name name of the action to unregister
@@ -179,5 +187,22 @@ export declare class EditorClient {
      * @hidden
      */
     protected listenToEditor(): void;
+    /**
+     * Display an alert modal to the user
+     * @param text Body text to display in the alert modal
+     * @param title Title of the alert modal; defaults to the extension title specified in manifest.json
+     * @param buttonText Text for the OK button; defaults to "OK" (or a translation)
+     * @returns a Promise that resolves true if the user clicks OK, false if they otherwise dismiss the modal
+     */
+    alert(text: string, title?: string, buttonText?: string): import("./commandtypes").AlertResult;
+    /**
+     * Display a confirm modal to the user
+     * @param text Body text to display in the alert modal
+     * @param title Title of the alert modal; defaults to the extension title specified in manifest.json
+     * @param okText Text for the OK button; defaults to "OK" (or a translation)
+     * @param cancelText Text for the Cancel button; defaults to "Cancel" (or a translation)
+     * @returns a Promise that resolves true if the user clicks OK, false if they click Cancel or otherwise dismiss the modal
+     */
+    confirm(text: string, title?: string, okText?: string, cancelText?: string): import("./commandtypes").ConfirmResult;
     constructor();
 }

package/sdk/editorclient.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EditorClient = void 0;
 const commandtypes_1 = require("./commandtypes");
+const base64_1 = require("./core/base64");
 const blockproxyregistry_1 = require("./document/blockclasses/blockproxyregistry");
 const blockproxy_1 = require("./document/blockproxy");
 const documentproxy_1 = require("./document/documentproxy");
@@ -131,6 +132,24 @@ class EditorClient {
         }
         this.callbacks.set(name, callback);
     }
+    /**
+     * Register a named action that receives file upload data. These callbacks can be used in
+     * Menu.addMenuItem as the file action.
+     * @param name The name of the action
+     * @param callback Function to execute when this action is invoked
+     */
+    registerFileUploadAction(name, callback) {
+        this.registerAction(name, (msg) => {
+            callback(msg['f'].map((rawFile) => {
+                if (rawFile['b']) {
+                    return { fileName: rawFile['n'], text: rawFile['t'], binary: (0, base64_1.decodeBase64)(rawFile['b']) };
+                }
+                else {
+                    return { fileName: rawFile['n'], text: rawFile['t'] };
+                }
+            }));
+        });
+    }
     /**
      * Remove the callback for a given action. If the action is later invoked, nothing will happen.
      * @param name name of the action to unregister
@@ -310,5 +329,26 @@ class EditorClient {
             return (_a = this.callbacks.get(msg['id'])) === null || _a === void 0 ? void 0 : _a(msg);
         });
     }
+    /**
+     * Display an alert modal to the user
+     * @param text Body text to display in the alert modal
+     * @param title Title of the alert modal; defaults to the extension title specified in manifest.json
+     * @param buttonText Text for the OK button; defaults to "OK" (or a translation)
+     * @returns a Promise that resolves true if the user clicks OK, false if they otherwise dismiss the modal
+     */
+    alert(text, title, buttonText) {
+        return this.sendCommand("a" /* Alert */, { 't': title, 'b': text, 'bt': buttonText });
+    }
+    /**
+     * Display a confirm modal to the user
+     * @param text Body text to display in the alert modal
+     * @param title Title of the alert modal; defaults to the extension title specified in manifest.json
+     * @param okText Text for the OK button; defaults to "OK" (or a translation)
+     * @param cancelText Text for the Cancel button; defaults to "Cancel" (or a translation)
+     * @returns a Promise that resolves true if the user clicks OK, false if they click Cancel or otherwise dismiss the modal
+     */
+    confirm(text, title, okText, cancelText) {
+        return this.sendCommand("c" /* Confirm */, { 't': title, 'b': text, 'o': okText, 'c': cancelText });
+    }
 }
 exports.EditorClient = EditorClient;

package/sdk/ui/menu.d.ts

@@ -20,7 +20,7 @@ export interface CustomMenuItem {
     /** The text to display on the menu item */
     label: string;
     /** The registered action to run when the menu item is clicked */
-    action: string;
+    action?: string;
     /** If specified, what action's return value should determine if this menu item is visible? */
     visibleAction?: string;
     /** If specified, what action's return value should determine if this menu item is disabled? */
@@ -29,13 +29,30 @@ export interface CustomMenuItem {
     menuType: MenuType;
     /** Where in that menu to display this item */
     location?: MenuLocation;
+    /** If specified, this menu item should launch a file picker */
+    file?: {
+        /** An action registered with EditorClient.registerFileUploadAction */
+        action: string;
+        /** An [accept string](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#accept) as specified for HTML file inputs */
+        accept: string;
+        /** If true, only allow a single file to be selected for upload */
+        singleFileOnly?: boolean;
+        /** If true, send the file contents to the callback action as a Uint8Array as well as a plain text string */
+        binary?: boolean;
+    };
+}
+export interface FileUploadData {
+    fileName: string;
+    text: string;
+    binary?: Uint8Array;
 }
 export declare class Menu {
     private readonly client;
     constructor(client: EditorClient);
     /**
      * Add a new menu item to execute custom code. The action must be registered with
-     * EditorClient.registerAction prior to using it in the menu.
+     * [EditorClient.registerAction](/extension-sdk/#classes_editorclient-EditorClient_registeraction)
+     * prior to using it in the menu.
      *
      * @param item The definition of the new menu item
      */

package/sdk/ui/menu.js

@@ -26,12 +26,13 @@ class Menu {
     }
     /**
      * Add a new menu item to execute custom code. The action must be registered with
-     * EditorClient.registerAction prior to using it in the menu.
+     * [EditorClient.registerAction](/extension-sdk/#classes_editorclient-EditorClient_registeraction)
+     * prior to using it in the menu.
      *
      * @param item The definition of the new menu item
      */
     addMenuItem(item) {
-        if (!this.client.actionExists(item.action)) {
+        if (item.action && !this.client.actionExists(item.action)) {
             throw new Error('Unregistered action: ' + item.action);
         }
         if (item.visibleAction && !this.client.actionExists(item.visibleAction)) {
@@ -47,6 +48,14 @@ class Menu {
             'd': item.disabledAction,
             't': item.menuType,
             'loc': item.location,
+            'f': item.file
+                ? {
+                    'a': item.file.action,
+                    'ac': item.file.accept,
+                    's': item.file.singleFileOnly,
+                    'b': item.file.binary,
+                }
+                : undefined,
         });
     }
 }