lucid-extension-sdk 0.0.121 → 0.0.123

package/package.json

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

package/sdk/commandtypes.d.ts

@@ -24,6 +24,7 @@ export declare const enum CommandName {
     AddLineTextArea = "alta",
     AddMenuItem = "ami",
     AddShapeData = "asd",
+    AddSpreadsheetIntegration = "asi",
     Alert = "a",
     AnimateViewport = "av",
     AwaitImport = "ai",
@@ -136,6 +137,10 @@ export declare type CommandArgs = {
         query: AddShapeDataQuery;
         result: AddShapeDataResult;
     };
+    [CommandName.AddSpreadsheetIntegration]: {
+        query: AddSpreadsheetIntegrationQuery;
+        result: AddSpreadsheetIntegrationResult;
+    };
     [CommandName.Alert]: {
         query: AlertQuery;
         result: AlertResult;
@@ -576,6 +581,25 @@ export declare type AddShapeDataQuery = {
     'v'?: SerializedFieldType;
 };
 export declare type AddShapeDataResult = undefined;
+/** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
+export declare type AddSpreadsheetIntegrationQuery = {
+    /** name */
+    'n': string;
+    /** label */
+    'l': string;
+    /** iconUrl */
+    'iu': string;
+    /** getSpreadsheetToImportDetails */
+    'gd': string;
+    /** getSpreadsheetSheetIdsAndNames */
+    'gs': string;
+    /** getPreviewData */
+    'gp': string;
+    /** importSheets */
+    'i': string;
+};
+/** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
+export declare type AddSpreadsheetIntegrationResult = undefined;
 export declare type AlertQuery = {
     /** Title; defaults to extension title */
     't'?: string | undefined;

package/sdk/commandtypes.js

@@ -8,6 +8,7 @@ exports.commandTitles = new Map([
     ["alta" /* CommandName.AddLineTextArea */, 'AddLineTextArea'],
     ["ami" /* CommandName.AddMenuItem */, 'AddMenuItem'],
     ["asd" /* CommandName.AddShapeData */, 'AddShapeData'],
+    ["asi" /* CommandName.AddSpreadsheetIntegration */, 'AddSpreadsheetIntegration'],
     ["a" /* CommandName.Alert */, 'Alert'],
     ["av" /* CommandName.AnimateViewport */, 'AnimateViewport'],
     ["ai" /* CommandName.AwaitImport */, 'AwaitImport'],

package/sdk/core/base64.js

@@ -30,6 +30,9 @@ function decodeBase64(base64String) {
         const enc2 = charCodeToEncodedInt[base64String.charCodeAt(inputIndex++)];
         const enc3 = charCodeToEncodedInt[base64String.charCodeAt(inputIndex++)];
         const enc4 = charCodeToEncodedInt[base64String.charCodeAt(inputIndex++)];
+        if (enc1 === undefined || enc2 === undefined || enc3 === undefined || enc4 === undefined) {
+            throw new Error('char code to encoded int contains an undefined index');
+        }
         //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);
@@ -55,6 +58,9 @@ function encodeBase64(byteArray) {
         const byte1 = byteArray[inputIndex++];
         const byte2 = byteArray[inputIndex++];
         const byte3 = byteArray[inputIndex++];
+        if (byte1 === undefined || byte2 === undefined || byte3 === undefined) {
+            throw new Error('byteArray contains undefined indexes');
+        }
         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

package/sdk/core/checks.d.ts

@@ -17,6 +17,12 @@ export declare function isNull(val: unknown): val is null;
  * @return Whether variable is undefined.
  */
 export declare function isUndefined(val: unknown): val is undefined;
+/**
+ * Returns true if the specified value is undefined.
+ * @param val Variable to test.
+ * @return Whether variable is undefined.
+ */
+export declare function isVoid(x: unknown): x is void;
 /**
  * Returns true if the specified value is defined and not null.
  * @param val Variable to test.

package/sdk/core/checks.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isInstanceOf = exports.isLiteral = exports.isPromise = exports.isUnknown = exports.isAny = exports.isEmptyOrNullishObject = exports.isTypedArray = exports.isArray = exports.isRecord = exports.isObject = exports.isFunction = exports.isInfinite = exports.isInt = exports.isNumber = exports.isBoolean = exports.isString = exports.isNullish = exports.isDefAndNotNull = exports.isUndefined = exports.isNull = exports.isDef = void 0;
+exports.isInstanceOf = exports.isLiteral = exports.isPromise = exports.isUnknown = exports.isAny = exports.isEmptyOrNullishObject = exports.isTypedArray = exports.isArray = exports.isRecord = exports.isObject = exports.isFunction = exports.isInfinite = exports.isInt = exports.isNumber = exports.isBoolean = exports.isString = exports.isNullish = exports.isDefAndNotNull = exports.isVoid = exports.isUndefined = exports.isNull = exports.isDef = void 0;
 /**
  * Returns true if the specified value is not undefined.
  *
@@ -29,6 +29,15 @@ function isUndefined(val) {
     return val === undefined;
 }
 exports.isUndefined = isUndefined;
+/**
+ * Returns true if the specified value is undefined.
+ * @param val Variable to test.
+ * @return Whether variable is undefined.
+ */
+function isVoid(x) {
+    return x === undefined;
+}
+exports.isVoid = isVoid;
 /**
  * Returns true if the specified value is defined and not null.
  * @param val Variable to test.

package/sdk/core/data/datasource/datasourcetype.d.ts

@@ -1,4 +1,4 @@
-/** @ignore until spreadsheet integration is ready for launch */
+/** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
 export declare enum DataSourceType {
     GoogleSheets = 0,
     CSV = 1,

package/sdk/core/data/datasource/datasourcetype.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DataSourceType = void 0;
-/** @ignore until spreadsheet integration is ready for launch */
+/** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
 var DataSourceType;
 (function (DataSourceType) {
     DataSourceType[DataSourceType["GoogleSheets"] = 0] = "GoogleSheets";

package/sdk/core/data/datasource/metadatatypes.d.ts

@@ -1,4 +1,4 @@
-/** @ignore until spreadsheet integration is ready for launch */
+/** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
 export declare enum MetadataTypes {
     Format = "Format",
     FillColor = "FillColor",

package/sdk/core/data/datasource/metadatatypes.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.MetadataTypes = void 0;
 // Google Sheets has both notes and comments, we store notes in the comment metadata collection. Comments are not
 // meant to be permanent in Google Sheets whereas they are in Excel, resulting in some confusion with our naming.
-/** @ignore until spreadsheet integration is ready for launch */
+/** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
 var MetadataTypes;
 (function (MetadataTypes) {
     MetadataTypes["Format"] = "Format";

package/sdk/core/data/datasource/serializeddatasourceproperties.d.ts

@@ -1,5 +1,5 @@
 import { SerializedUpstreamConfig } from './serializedupstreamconfig';
-/** @ignore until spreadsheet integration is ready for launch */
+/** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
 export interface SerializedDataSourceProperties {
     'Name': string;
     'UpstreamConfig'?: SerializedUpstreamConfig | null | undefined;

package/sdk/core/data/datasource/serializedimporteddatasource.d.ts

@@ -1,13 +1,13 @@
 import { SerializedDataItems } from '../serializedfield/serializeddataitems';
 import { SerializedSchema } from '../serializedfield/serializedschema';
 import { SerializedDataSourceProperties } from './serializeddatasourceproperties';
-/** @ignore until spreadsheet integration is ready for launch */
+/** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
 export interface SerializedImportedMetadataCollection {
     'Name': string;
     'Schema': SerializedSchema;
     'Items': SerializedDataItems;
 }
-/** @ignore until spreadsheet integration is ready for launch */
+/** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
 export interface SerializedImportedCollection {
     'Name': string;
     'Schema': SerializedSchema;
@@ -19,7 +19,7 @@ export interface SerializedImportedCollection {
         [key: string]: SerializedImportedMetadataCollection;
     };
 }
-/** @ignore until spreadsheet integration is ready for launch */
+/** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
 export interface SerializedImportedDataSource {
     'Properties': SerializedDataSourceProperties;
     'Collections': SerializedImportedCollection[];

package/sdk/core/data/datasource/serializedupstreamconfig.d.ts

@@ -1,7 +1,7 @@
 import { DataSourceType } from './datasourcetype';
 import { UpstreamPatchType } from './upstreampatchtype';
 import { UpstreamUpdateType } from './upstreamupdatetype';
-/** @ignore until spreadsheet integration is ready for launch */
+/** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
 export interface SerializedUpstreamConfig {
     'SourceType': DataSourceType;
     'UpdateType': UpstreamUpdateType;

package/sdk/core/data/datasource/upstreampatchtype.d.ts

@@ -1,4 +1,4 @@
-/** @ignore until spreadsheet integration is ready for launch */
+/** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
 export declare enum UpstreamPatchType {
     NONE = 0,
     MANUAL = 2,

package/sdk/core/data/datasource/upstreampatchtype.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UpstreamPatchType = void 0;
-/** @ignore until spreadsheet integration is ready for launch */
+/** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
 var UpstreamPatchType;
 (function (UpstreamPatchType) {
     UpstreamPatchType[UpstreamPatchType["NONE"] = 0] = "NONE";

package/sdk/core/data/datasource/upstreamupdatetype.d.ts

@@ -1,4 +1,4 @@
-/** @ignore until spreadsheet integration is ready for launch */
+/** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
 export declare enum UpstreamUpdateType {
     NONE = 0,
     PULL = 1,

package/sdk/core/data/datasource/upstreamupdatetype.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UpstreamUpdateType = void 0;
-/** @ignore until spreadsheet integration is ready for launch */
+/** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
 var UpstreamUpdateType;
 (function (UpstreamUpdateType) {
     UpstreamUpdateType[UpstreamUpdateType["NONE"] = 0] = "NONE";

package/sdk/core/data/fieldspecification.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FormattedPrimaryKey = exports.declareSchema = void 0;
-const object_1 = require("../object");
 function isArrayAndAssertReadonly(val) {
     return Array.isArray(val);
 }
@@ -18,7 +17,7 @@ function declareSchema({ primaryKey, fields }) {
     const primaryKeyObj = new FormattedPrimaryKey(...primaryKey);
     return {
         example: fields,
-        array: (0, object_1.entries)(fields).map(([name, { type, constraints, mapping }]) => {
+        array: Object.entries(fields).map(([name, { type, constraints, mapping }]) => {
             return {
                 'name': name,
                 'type': isArrayAndAssertReadonly(type) ? type.slice() : type,

package/sdk/core/object.d.ts

@@ -2,9 +2,6 @@ export declare function objectEvery<T, O extends {
     [key: string]: any;
 }>(obj: O, f: (this: T | undefined, _0: O[typeof _1], _1: string & keyof O, _2: O) => any, opt_this?: T): boolean;
 export declare function flatten<T>(a: T[][]): T[];
-export declare function entries<T>(obj: {
-    [key: string]: T;
-}): [string, T][];
 export declare function fromEntries<K extends PropertyKey, T>(entries: Iterable<readonly [K, T]>): {
     [key in K]: T;
 };

package/sdk/core/object.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fromEntries = exports.entries = exports.flatten = exports.objectEvery = void 0;
+exports.fromEntries = exports.flatten = exports.objectEvery = void 0;
 function objectEvery(obj, f, opt_this) {
     for (const key in obj) {
         if (!f.call(opt_this, obj[key], key, obj)) {
@@ -18,11 +18,6 @@ function flatten(a) {
     return result;
 }
 exports.flatten = flatten;
-// TODO: Placeholder until we adopt ES8 and can use Object.entries(obj)
-function entries(obj) {
-    return Object.keys(obj).map((key) => [key, obj[key]]);
-}
-exports.entries = entries;
 // TODO: Placeholder until we adopt ES8 and can use Object.fromEntries(obj)
 function fromEntries(entries) {
     const result = {};

package/sdk/core/spreadsheetintegration/lucidspreadsheetintegration.d.ts

@@ -0,0 +1,20 @@
+import { CollectionProxy } from '../../data/collectionproxy';
+import { SerializedImportedDataSource } from '../data/datasource/serializedimporteddatasource';
+/** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
+export declare enum LucidSpreadsheetIntegrationFailureType {
+    AuthorizationFailure = "AuthorizationFailure",
+    GenericFailure = "GenericFailure",
+    UserCancelled = "UserCanceled"
+}
+/** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
+export declare const lucidSpreadsheetIntegrationFailureTypeValidator: (x: unknown) => x is LucidSpreadsheetIntegrationFailureType;
+/** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
+export declare abstract class LucidSpreadsheetIntegration<CONFIG, SHEET> {
+    abstract name: string;
+    abstract label: string;
+    abstract iconUrl: string;
+    abstract getSpreadsheetToImportDetails: () => Promise<CONFIG | LucidSpreadsheetIntegrationFailureType>;
+    abstract getSpreadsheetSheetIdsAndNames(spreadsheetDetails: CONFIG): Promise<Map<SHEET, string> | LucidSpreadsheetIntegrationFailureType>;
+    abstract getPreviewData(spreadsheetDetails: CONFIG, sheetIdsToPreview: SHEET[]): Promise<SerializedImportedDataSource | LucidSpreadsheetIntegrationFailureType>;
+    abstract importSheets(spreadsheetDetails: CONFIG, sheetIdsToImport: SHEET[]): Promise<CollectionProxy[] | LucidSpreadsheetIntegrationFailureType>;
+}

package/sdk/core/spreadsheetintegration/lucidspreadsheetintegration.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LucidSpreadsheetIntegration = exports.lucidSpreadsheetIntegrationFailureTypeValidator = exports.LucidSpreadsheetIntegrationFailureType = void 0;
+const validators_1 = require("../validators/validators");
+/** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
+var LucidSpreadsheetIntegrationFailureType;
+(function (LucidSpreadsheetIntegrationFailureType) {
+    LucidSpreadsheetIntegrationFailureType["AuthorizationFailure"] = "AuthorizationFailure";
+    LucidSpreadsheetIntegrationFailureType["GenericFailure"] = "GenericFailure";
+    LucidSpreadsheetIntegrationFailureType["UserCancelled"] = "UserCanceled";
+})(LucidSpreadsheetIntegrationFailureType = exports.LucidSpreadsheetIntegrationFailureType || (exports.LucidSpreadsheetIntegrationFailureType = {}));
+/** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
+exports.lucidSpreadsheetIntegrationFailureTypeValidator = (0, validators_1.stringEnumValidator)(LucidSpreadsheetIntegrationFailureType);
+/** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
+class LucidSpreadsheetIntegration {
+}
+exports.LucidSpreadsheetIntegration = LucidSpreadsheetIntegration;

package/sdk/core/spreadsheetintegration/lucidspreadsheetintegrationregistry.d.ts

@@ -0,0 +1,11 @@
+import { EditorClient } from '../../editorclient';
+import { LucidSpreadsheetIntegration } from './lucidspreadsheetintegration';
+/** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
+export declare class LucidSpreadsheetIntegrationRegistry {
+    private static nextHookId;
+    private static nextHookName;
+    /**
+     * Register a spreadsheet integration.
+     */
+    static addSpreadsheetIntegration<CONFIG, SHEET>(client: EditorClient, spreadsheetIntegration: LucidSpreadsheetIntegration<CONFIG, SHEET>): void;
+}

package/sdk/core/spreadsheetintegration/lucidspreadsheetintegrationregistry.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LucidSpreadsheetIntegrationRegistry = void 0;
+const lucidspreadsheetintegration_1 = require("./lucidspreadsheetintegration");
+/** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
+class LucidSpreadsheetIntegrationRegistry {
+    static nextHookName() {
+        return '__lucidspreadsheet__hook' + this.nextHookId++;
+    }
+    /**
+     * Register a spreadsheet integration.
+     */
+    static addSpreadsheetIntegration(client, spreadsheetIntegration) {
+        const getSpreadsheetToImportDetailsActionName = LucidSpreadsheetIntegrationRegistry.nextHookName();
+        client.registerAction(getSpreadsheetToImportDetailsActionName, async () => {
+            const result = await spreadsheetIntegration.getSpreadsheetToImportDetails();
+            return result;
+        });
+        const getSpreadsheetSheetIdsAndNamesActionName = LucidSpreadsheetIntegrationRegistry.nextHookName();
+        client.registerAction(getSpreadsheetSheetIdsAndNamesActionName, async (message) => {
+            const result = await spreadsheetIntegration.getSpreadsheetSheetIdsAndNames(message['dataDetails']);
+            if ((0, lucidspreadsheetintegration_1.lucidSpreadsheetIntegrationFailureTypeValidator)(result)) {
+                return result;
+            }
+            else {
+                // Serialize the Map
+                return Array.from(result);
+            }
+        });
+        const getPreviewDataActionName = LucidSpreadsheetIntegrationRegistry.nextHookName();
+        client.registerAction(getPreviewDataActionName, async (message) => {
+            const result = await spreadsheetIntegration.getPreviewData(message['dataDetails'], message['sheetIds']);
+            return result;
+        });
+        const importSheetsActionName = LucidSpreadsheetIntegrationRegistry.nextHookName();
+        client.registerAction(importSheetsActionName, async (message) => {
+            const result = await spreadsheetIntegration.importSheets(message['dataDetails'], message['sheetIds']);
+            return result;
+        });
+        const serialized = {
+            'n': spreadsheetIntegration.name,
+            'l': spreadsheetIntegration.label,
+            'iu': spreadsheetIntegration.iconUrl,
+            'gd': getSpreadsheetToImportDetailsActionName,
+            'gs': getSpreadsheetSheetIdsAndNamesActionName,
+            'gp': getPreviewDataActionName,
+            'i': importSheetsActionName,
+        };
+        client.sendCommand("asi" /* CommandName.AddSpreadsheetIntegration */, serialized);
+    }
+}
+exports.LucidSpreadsheetIntegrationRegistry = LucidSpreadsheetIntegrationRegistry;
+LucidSpreadsheetIntegrationRegistry.nextHookId = 0;

package/sdk/dataconnector/debugserver.js

@@ -32,12 +32,12 @@ function routeDebugServer(dataConnector, options) {
                     const { body, status, headers } = await route({
                         body: req.body.toString(),
                         headers: reqHeaders,
-                        query: (0, object_1.fromEntries)((0, object_1.entries)(req.query).map(([key, value]) => [
+                        query: (0, object_1.fromEntries)(Object.entries(req.query).map(([key, value]) => [
                             key,
                             typeof value === 'string' ? value : undefined,
                         ])),
                     });
-                    for (const [name, value] of (0, object_1.entries)(headers !== null && headers !== void 0 ? headers : {})) {
+                    for (const [name, value] of Object.entries(headers !== null && headers !== void 0 ? headers : {})) {
                         if (typeof value === 'string') {
                             res.setHeader(name, value);
                         }

package/sdk/editorclient.js

@@ -4,7 +4,6 @@ exports.EditorClient = void 0;
 const commandtypes_1 = require("./commandtypes");
 const base64_1 = require("./core/base64");
 const checks_1 = require("./core/checks");
-const object_1 = require("./core/object");
 const unfurlcallbacks_1 = require("./core/unfurl/unfurlcallbacks");
 const unfurldetails_1 = require("./core/unfurl/unfurldetails");
 const unfurlrefresherrortype_1 = require("./core/unfurl/unfurlrefresherrortype");
@@ -148,7 +147,7 @@ class EditorClient {
      * @returns A promise that resolves to a map of setting names to current setting values
      */
     async getPackageSettings() {
-        return new Map((0, object_1.entries)(await this.sendCommand("gps" /* CommandName.GetPackageSettings */, undefined)));
+        return new Map(Object.entries(await this.sendCommand("gps" /* CommandName.GetPackageSettings */, undefined)));
     }
     /**
      * @returns True if the current user is allowed to edit package settings on this installation

package/sdk/index.d.ts

@@ -43,6 +43,8 @@ export * from './core/properties/fillcolor';
 export * from './core/properties/shadow';
 export * from './core/serializeddataerror';
 export * from './core/shapedatainheritance';
+export * from './core/spreadsheetintegration/lucidspreadsheetintegration';
+export * from './core/spreadsheetintegration/lucidspreadsheetintegrationregistry';
 export * from './core/unfurl/unfurlcallbacks';
 export * from './core/unfurl/unfurldetails';
 export * from './core/unfurl/unfurliframe';

package/sdk/index.js

@@ -59,6 +59,8 @@ __exportStar(require("./core/properties/fillcolor"), exports);
 __exportStar(require("./core/properties/shadow"), exports);
 __exportStar(require("./core/serializeddataerror"), exports);
 __exportStar(require("./core/shapedatainheritance"), exports);
+__exportStar(require("./core/spreadsheetintegration/lucidspreadsheetintegration"), exports);
+__exportStar(require("./core/spreadsheetintegration/lucidspreadsheetintegrationregistry"), exports);
 __exportStar(require("./core/unfurl/unfurlcallbacks"), exports);
 __exportStar(require("./core/unfurl/unfurldetails"), exports);
 __exportStar(require("./core/unfurl/unfurliframe"), exports);

package/sdk/ui/viewport.js

@@ -44,7 +44,7 @@ class Viewport {
      */
     focusCameraOnItems(items) {
         const bb = (0, math_1.combinedBoundingBox)(items.map((e) => e.getBoundingBox()));
-        if (bb) {
+        if (bb && items[0]) {
             //TODO: A reasonable max zoom level (e.g. 200%)
             this.client.sendCommand("av" /* CommandName.AnimateViewport */, {
                 'bb': (0, math_1.padBox)(bb, 80),