lucid-extension-sdk 0.0.83 → 0.0.85

package/package.json

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

package/sdk/commandtypes.d.ts

@@ -2,6 +2,7 @@ import { SerializedFieldTypeDefinition } from './core/data/fieldtypedefinition/f
 import { SerializedReferenceKeyType } from './core/data/referencekeys/serializedreferencekey';
 import { SerializedFieldType } from './core/data/serializedfield/serializedfields';
 import { JsonObject, JsonSerializable } from './core/jsonserializable';
+import { LucidProduct } from './core/lucidproduct';
 import { LinearOffsetType } from './core/offsettype';
 import { SerializedDataError } from './core/serializeddataerror';
 import { ShapeDataInheritance } from './core/shapedatainheritance';
@@ -27,6 +28,7 @@ export declare const enum CommandName {
     AwaitImport = "ai",
     Bootstrap = "b",
     CancelDragBlockToCanvas = "cdc",
+    CanEditPackageSettings = "ceps",
     Confirm = "c",
     CreateBlock = "cb",
     CreateCollection = "cc",
@@ -50,6 +52,8 @@ export declare const enum CommandName {
     GetDataItemField = "gdif",
     GetElementType = "get",
     GetItemPageId = "gip",
+    GetPackageSettings = "gps",
+    GetProduct = "gpr",
     GetProperty = "gp",
     GetReferenceKey = "grk",
     GetRelativeLinePosition = "grlp",
@@ -93,6 +97,7 @@ export declare const enum CommandName {
     SetText = "st",
     ShowModal = "sm",
     ShowPanel = "spn",
+    ShowPackageSettingsModal = "spsm",
     SleepForTestCase = "sleep",
     StartDragBlockToCanvas = "sdc",
     StartPDFUploadRequest = "pdf",
@@ -141,6 +146,10 @@ export declare type CommandArgs = {
         query: BootstrapQuery;
         result: BootstrapResult;
     };
+    [CommandName.CanEditPackageSettings]: {
+        query: CanEditPackageSettingsQuery;
+        result: CanEditPackageSettingsResult;
+    };
     [CommandName.CancelDragBlockToCanvas]: {
         query: CancelDragBlockToCanvasQuery;
         result: CancelDragBlockToCanvasResult;
@@ -237,6 +246,14 @@ export declare type CommandArgs = {
         query: GetItemPageIdQuery;
         result: GetItemPageIdResult;
     };
+    [CommandName.GetPackageSettings]: {
+        query: GetPackageSettingsQuery;
+        result: GetPackageSettingsResult;
+    };
+    [CommandName.GetProduct]: {
+        query: GetProductQuery;
+        result: GetProductResult;
+    };
     [CommandName.GetProperty]: {
         query: GetPropertyQuery;
         result: GetPropertyResult;
@@ -405,6 +422,10 @@ export declare type CommandArgs = {
         query: ShowModalQuery;
         result: ShowModalResult;
     };
+    [CommandName.ShowPackageSettingsModal]: {
+        query: ShowPackageSettingsModalQuery;
+        result: ShowPackageSettingsModalResult;
+    };
     [CommandName.ShowPanel]: {
         query: ShowPanelQuery;
         result: ShowPanelResult;
@@ -563,6 +584,8 @@ export declare type BootstrapQuery = {
     'm'?: boolean;
 };
 export declare type BootstrapResult = Promise<void>;
+export declare type CanEditPackageSettingsQuery = undefined;
+export declare type CanEditPackageSettingsResult = Promise<boolean>;
 export declare type CancelDragBlockToCanvasQuery = void;
 export declare type CancelDragBlockToCanvasResult = undefined;
 export declare type ConfirmQuery = {
@@ -756,6 +779,8 @@ export declare type GetReferenceKeyQuery = {
     'k': number | string;
 };
 export declare type GetReferenceKeyResult = SerializedReferenceKeyType;
+export declare type GetProductQuery = undefined;
+export declare type GetProductResult = LucidProduct;
 export declare type GetPropertyQuery = {
     /** ID of the LucidElement to read a property from, or undefined to read from the LucidDocument */
     'id'?: string | undefined;
@@ -763,6 +788,8 @@ export declare type GetPropertyQuery = {
     'p': string;
 };
 export declare type GetPropertyResult = JsonSerializable;
+export declare type GetPackageSettingsQuery = undefined;
+export declare type GetPackageSettingsResult = Promise<Record<string, JsonSerializable>>;
 export declare type GetRelativeLinePositionQuery = {
     /** Block or line ID to check the connections on */
     'id': string;
@@ -1026,6 +1053,8 @@ export declare type ShowModalQuery = {
     'c': string;
 };
 export declare type ShowModalResult = undefined;
+export declare type ShowPackageSettingsModalQuery = undefined;
+export declare type ShowPackageSettingsModalResult = Promise<void>;
 export declare type ShowPanelQuery = {
     /** Name of the panel's action for receiving events, i.e. RegisterPanelQuery['n'] */
     'n': string;

package/sdk/commandtypes.js

@@ -12,6 +12,7 @@ exports.commandTitles = new Map([
     ["av" /* CommandName.AnimateViewport */, 'AnimateViewport'],
     ["ai" /* CommandName.AwaitImport */, 'AwaitImport'],
     ["b" /* CommandName.Bootstrap */, 'Bootstrap'],
+    ["ceps" /* CommandName.CanEditPackageSettings */, 'CanEditPackageSettings'],
     ["cdc" /* CommandName.CancelDragBlockToCanvas */, 'CancelDragBlockToCanvas'],
     ["c" /* CommandName.Confirm */, 'Confirm'],
     ["cb" /* CommandName.CreateBlock */, 'CreateBlock'],
@@ -34,6 +35,8 @@ exports.commandTitles = new Map([
     ["gdif" /* CommandName.GetDataItemField */, 'GetDataItemField'],
     ["get" /* CommandName.GetElementType */, 'GetElementType'],
     ["gip" /* CommandName.GetItemPageId */, 'GetItemPageId'],
+    ["gps" /* CommandName.GetPackageSettings */, 'GetPackageSettings'],
+    ["gpr" /* CommandName.GetProduct */, 'GetProduct'],
     ["gp" /* CommandName.GetProperty */, 'GetProperty'],
     ["grk" /* CommandName.GetReferenceKey */, 'GetReferenceKey'],
     ["grlp" /* CommandName.GetRelativeLinePosition */, 'GetRelativeLinePosition'],
@@ -74,6 +77,7 @@ exports.commandTitles = new Map([
     ["srk" /* CommandName.SetReferenceKey */, 'SetReferenceKey'],
     ["ssd" /* CommandName.SetShapeData */, 'SetShapeData'],
     ["sm" /* CommandName.ShowModal */, 'ShowModal'],
+    ["spsm" /* CommandName.ShowPackageSettingsModal */, 'ShowPackageSettingsModal'],
     ["spn" /* CommandName.ShowPanel */, 'ShowPanel'],
     ["sleep" /* CommandName.SleepForTestCase */, 'SleepForTestCase'],
     ["sdc" /* CommandName.StartDragBlockToCanvas */, 'StartDragBlockToCanvas'],

package/sdk/core/lucidproduct.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Lucid products supporting the extension API
+ */
+export declare enum LucidProduct {
+    Chart = "chart",
+    Spark = "spark"
+}

package/sdk/core/lucidproduct.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LucidProduct = void 0;
+/**
+ * Lucid products supporting the extension API
+ */
+var LucidProduct;
+(function (LucidProduct) {
+    LucidProduct["Chart"] = "chart";
+    LucidProduct["Spark"] = "spark";
+})(LucidProduct = exports.LucidProduct || (exports.LucidProduct = {}));

package/sdk/core/object.d.ts

@@ -1,3 +1,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 entries<T>(obj: {
+    [key: string]: T;
+}): [string, T][];

package/sdk/core/object.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.objectEvery = void 0;
+exports.entries = exports.objectEvery = void 0;
 function objectEvery(obj, f, opt_this) {
     for (const key in obj) {
         if (!f.call(opt_this, obj[key], key, obj)) {
@@ -10,3 +10,8 @@ function objectEvery(obj, f, opt_this) {
     return true;
 }
 exports.objectEvery = objectEvery;
+// 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;

package/sdk/editorclient.d.ts

@@ -24,6 +24,10 @@ export declare class EditorClient {
     private nextId;
     private readonly callbacks;
     private getUniqueActionName;
+    /**
+     * Get which Lucid product this editor extension has been loaded in.
+     */
+    getProduct(): import(".").LucidProduct;
     /**
      * Unload this extension immediately, removing any custom menu items etc., until the user refreshes the browser tab.
      */
@@ -61,6 +65,31 @@ export declare class EditorClient {
      * @throws A string with an error from the data sync server
      */
     performDataAction(flowName: string, dataConnectorName: string, syncDataSourceId?: undefined | string, flowData?: unknown, async?: boolean): Promise<DataActionResponse>;
+    /**
+     * If the extension package containing this editor extension has configurable settings,
+     * show a standard modal allowing the user to view or change those settings.
+     *
+     * If the user does not have permission to change settings on this installation of this
+     * extension, or if no settings exist, an error is thrown.
+     *
+     * @returns A promise that resolves when the user closes the settings modal.
+     */
+    showPackageSettingsModal(): Promise<void>;
+    /**
+     * If the extension package containing this editor extension has configurable settings,
+     * fetch the current values of those settings for this installation of this extension.
+     *
+     * Only settings that have been set by the installing user will have a value in the map,
+     * other settings will be missing.
+     *
+     * @returns A promise that resolves to a map of setting names to current setting values
+     */
+    getPackageSettings(): Promise<Map<string, JsonSerializable>>;
+    /**
+     * @returns True if the current user is allowed to edit package settings on this installation
+     * of this extension (if any settings exist), or false otherwise.
+     */
+    canEditPackageSettings(): Promise<boolean>;
     awaitDataImport(dataConnectorName: string, syncDataSourceId: undefined | string, syncCollectionId: string, primaryKeys: string[], timeout?: number): Promise<CollectionProxy>;
     /**
      * Make a network request

package/sdk/editorclient.js

@@ -4,6 +4,7 @@ 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");
@@ -41,6 +42,12 @@ class EditorClient {
         }
         return 'a' + this.nextId;
     }
+    /**
+     * Get which Lucid product this editor extension has been loaded in.
+     */
+    getProduct() {
+        return this.sendCommand("gpr" /* CommandName.GetProduct */, undefined);
+    }
     /**
      * Unload this extension immediately, removing any custom menu items etc., until the user refreshes the browser tab.
      */
@@ -113,6 +120,37 @@ class EditorClient {
             'json': result['j'],
         };
     }
+    /**
+     * If the extension package containing this editor extension has configurable settings,
+     * show a standard modal allowing the user to view or change those settings.
+     *
+     * If the user does not have permission to change settings on this installation of this
+     * extension, or if no settings exist, an error is thrown.
+     *
+     * @returns A promise that resolves when the user closes the settings modal.
+     */
+    async showPackageSettingsModal() {
+        return this.sendCommand("spsm" /* CommandName.ShowPackageSettingsModal */, undefined);
+    }
+    /**
+     * If the extension package containing this editor extension has configurable settings,
+     * fetch the current values of those settings for this installation of this extension.
+     *
+     * Only settings that have been set by the installing user will have a value in the map,
+     * other settings will be missing.
+     *
+     * @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)));
+    }
+    /**
+     * @returns True if the current user is allowed to edit package settings on this installation
+     * of this extension (if any settings exist), or false otherwise.
+     */
+    async canEditPackageSettings() {
+        return this.sendCommand("ceps" /* CommandName.CanEditPackageSettings */, undefined);
+    }
     async awaitDataImport(dataConnectorName, syncDataSourceId, syncCollectionId, primaryKeys, timeout = 30000) {
         return new collectionproxy_1.CollectionProxy(await this.sendCommand("ai" /* CommandName.AwaitImport */, {
             'n': dataConnectorName,

package/sdk/index.d.ts

@@ -23,6 +23,7 @@ export * from './core/dataerrortype';
 export * from './core/guards';
 export * from './core/iframe/iframeutils';
 export * from './core/jsonserializable';
+export * from './core/lucidproduct';
 export * from './core/object';
 export * from './core/offsettype';
 export * from './core/optionalkey';

package/sdk/index.js

@@ -39,6 +39,7 @@ __exportStar(require("./core/dataerrortype"), exports);
 __exportStar(require("./core/guards"), exports);
 __exportStar(require("./core/iframe/iframeutils"), exports);
 __exportStar(require("./core/jsonserializable"), exports);
+__exportStar(require("./core/lucidproduct"), exports);
 __exportStar(require("./core/object"), exports);
 __exportStar(require("./core/offsettype"), exports);
 __exportStar(require("./core/optionalkey"), exports);