lucid-extension-sdk 0.0.33 → 0.0.34

package/package.json

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

package/sdk/commandtypes.d.ts

@@ -31,6 +31,7 @@ export declare const enum CommandName {
     CreateDataSource = "cds",
     CreateLine = "cl",
     CreatePage = "cp",
+    CreateUserImage = "cui",
     DataAction = "da",
     DataItemExists = "die",
     DeleteItem = "di",
@@ -154,6 +155,10 @@ export declare type CommandArgs = {
         query: CreatePageQuery;
         result: CreatePageResult;
     };
+    [CommandName.CreateUserImage]: {
+        query: CreateUserImageQuery;
+        result: CreateUserImageResult;
+    };
     [CommandName.DataAction]: {
         query: DataActionQuery;
         result: DataActionResult;
@@ -531,6 +536,17 @@ export declare type CreateLineQuery = {
 export declare type CreateLineResult = string;
 export declare type CreatePageQuery = void;
 export declare type CreatePageResult = string;
+export declare type CreateUserImageQuery = {
+    /** media type */
+    't': string;
+    /** base64-encoded image data */
+    'd': string;
+};
+export declare type RawCreateUserImageResult = {
+    /** The resulting image URL */
+    'u': string;
+};
+export declare type CreateUserImageResult = Promise<RawCreateUserImageResult>;
 export declare type DataActionQuery = {
     /** Flow Name */
     'fn': string;

package/sdk/core/base64.d.ts

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

package/sdk/core/base64.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.decodeBase64 = void 0;
+exports.encodeBase64 = exports.decodeBase64 = void 0;
 const alphabet = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=';
 //This gives a ~8x speedup vs. using alphabet.indexOf() in the main decode loop.
 const charCodeToEncodedInt = [];
@@ -43,3 +43,40 @@ function decodeBase64(base64String) {
     return output;
 }
 exports.decodeBase64 = decodeBase64;
+function encodeBase64(byteArray) {
+    // 3 bytes of input become 4 chars of output
+    // i.e. every 6 bits of input becomes 1 char of output
+    const fullByteChunkCount = Math.floor(byteArray.length / 3);
+    const outputLength = Math.ceil(byteArray.length / 3) * 4;
+    const output = new Array(outputLength);
+    let inputIndex = 0;
+    let outputIndex = 0;
+    for (let byteChunkIndex = 0; byteChunkIndex < fullByteChunkCount; byteChunkIndex++) {
+        const byte1 = byteArray[inputIndex++];
+        const byte2 = byteArray[inputIndex++];
+        const byte3 = byteArray[inputIndex++];
+        const enc1 = byte1 >> 2; // first 6 bits of byte1
+        const enc2 = ((byte1 & 3) << 4) | (byte2 >> 4); // last 2 bits of byte1 and first 4 bits of byte2
+        const enc3 = ((byte2 & 15) << 2) | (byte3 >> 6); // last 4 bits of byte2 and first 2 bits of byte3
+        const enc4 = byte3 & 63; // last 6 bits of byte3
+        output[outputIndex++] = alphabet[enc1];
+        output[outputIndex++] = alphabet[enc2];
+        output[outputIndex++] = alphabet[enc3];
+        output[outputIndex++] = alphabet[enc4];
+    }
+    // handle remainder, i.e. trailing one or two bytes
+    if (inputIndex < byteArray.length) {
+        const byte1 = byteArray[inputIndex++];
+        const hasSecondByte = inputIndex < byteArray.length;
+        const byte2 = hasSecondByte ? byteArray[inputIndex++] : 0;
+        const enc1 = byte1 >> 2; // first 6 bits of byte1
+        const enc2 = ((byte1 & 3) << 4) | (byte2 >> 4); // last 2 bits of byte1 and first 4 bits of byte2
+        const enc3 = hasSecondByte ? (byte2 & 15) << 2 : 64; // last 4 bits of byte2
+        output[outputIndex++] = alphabet[enc1];
+        output[outputIndex++] = alphabet[enc2];
+        output[outputIndex++] = alphabet[enc3];
+        output[outputIndex++] = '=';
+    }
+    return output.join('');
+}
+exports.encodeBase64 = encodeBase64;

package/sdk/editorclient.d.ts

@@ -65,6 +65,16 @@ 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;
+    /**
+     * Upload an image and return a URL that can be used for displaying that image on the canvas. Note: the URL is
+     * public - anyone with the URL can access the image.
+     * @param data The binary image contents, or a base64-encoded string
+     * @param mediaType The media type, e.g. 'image/png'
+     * @returns A promise that resolves with the URL of the created image.
+     *
+     * @ignore
+     */
+    experimentalCreateUserImage(mediaType: string, data: Uint8Array | string): Promise<string>;
     /**
      *
      * @param flowName

package/sdk/editorclient.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.EditorClient = void 0;
 const commandtypes_1 = require("./commandtypes");
 const base64_1 = require("./core/base64");
+const checks_1 = require("./core/checks");
 const blockproxyregistry_1 = require("./document/blockclasses/blockproxyregistry");
 const blockproxy_1 = require("./document/blockproxy");
 const documentproxy_1 = require("./document/documentproxy");
@@ -49,6 +50,22 @@ class EditorClient {
             'b64': base64,
         });
     }
+    /**
+     * Upload an image and return a URL that can be used for displaying that image on the canvas. Note: the URL is
+     * public - anyone with the URL can access the image.
+     * @param data The binary image contents, or a base64-encoded string
+     * @param mediaType The media type, e.g. 'image/png'
+     * @returns A promise that resolves with the URL of the created image.
+     *
+     * @ignore
+     */
+    async experimentalCreateUserImage(mediaType, data) {
+        const result = await this.sendCommand("cui" /* CreateUserImage */, {
+            't': mediaType,
+            'd': (0, checks_1.isString)(data) ? data : (0, base64_1.encodeBase64)(data),
+        });
+        return result['u'];
+    }
     /**
      *
      * @param flowName