lucid-extension-sdk 0.0.81 → 0.0.84

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "lucid-extension-sdk",
-    "version": "0.0.81",
+    "version": "0.0.84",
     "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';
@@ -50,6 +51,7 @@ export declare const enum CommandName {
     GetDataItemField = "gdif",
     GetElementType = "get",
     GetItemPageId = "gip",
+    GetProduct = "gpr",
     GetProperty = "gp",
     GetReferenceKey = "grk",
     GetRelativeLinePosition = "grlp",
@@ -237,6 +239,10 @@ export declare type CommandArgs = {
         query: GetItemPageIdQuery;
         result: GetItemPageIdResult;
     };
+    [CommandName.GetProduct]: {
+        query: GetProductQuery;
+        result: GetProductResult;
+    };
     [CommandName.GetProperty]: {
         query: GetPropertyQuery;
         result: GetPropertyResult;
@@ -756,6 +762,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;

package/sdk/commandtypes.js

@@ -34,6 +34,7 @@ exports.commandTitles = new Map([
     ["gdif" /* CommandName.GetDataItemField */, 'GetDataItemField'],
     ["get" /* CommandName.GetElementType */, 'GetElementType'],
     ["gip" /* CommandName.GetItemPageId */, 'GetItemPageId'],
+    ["gpr" /* CommandName.GetProduct */, 'GetProduct'],
     ["gp" /* CommandName.GetProperty */, 'GetProperty'],
     ["grk" /* CommandName.GetReferenceKey */, 'GetReferenceKey'],
     ["grlp" /* CommandName.GetRelativeLinePosition */, 'GetRelativeLinePosition'],

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/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.
      */

package/sdk/editorclient.js

@@ -41,6 +41,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.
      */

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);

package/sdk/ui/panel.d.ts

@@ -7,7 +7,9 @@ export declare enum PanelLocation {
     /** In Lucidchart, create a sibling to the Contextual Panel */
     RightDock = 1,
     /** In Lucidchart, create a sibling to the shape toolbox */
-    ContentDock = 2
+    ContentDock = 2,
+    /** In Lucidspark, add a new tab to the image search callout component */
+    ImageSearchTab = 3
 }
 export interface PanelConfig {
     /** Title to display at the top of the panel */
@@ -20,6 +22,8 @@ export interface PanelConfig {
     visibleAction?: string;
     /** The URL for an icon to represent the panel, preferably base64-encoded. Will be displayed at 24x24 CSS pixels in size. */
     iconUrl: string;
+    /** A tool tip to be displayed when hovering over the activation icon. */
+    toolTip?: string;
 }
 /**
  * Extend this class to show a custom panel to the user, whose contents are displayed in a sandboxed

package/sdk/ui/panel.js

@@ -11,6 +11,8 @@ var PanelLocation;
     PanelLocation[PanelLocation["RightDock"] = 1] = "RightDock";
     /** In Lucidchart, create a sibling to the shape toolbox */
     PanelLocation[PanelLocation["ContentDock"] = 2] = "ContentDock";
+    /** In Lucidspark, add a new tab to the image search callout component */
+    PanelLocation[PanelLocation["ImageSearchTab"] = 3] = "ImageSearchTab";
 })(PanelLocation = exports.PanelLocation || (exports.PanelLocation = {}));
 /**
  * Extend this class to show a custom panel to the user, whose contents are displayed in a sandboxed
@@ -34,6 +36,7 @@ class Panel extends iframeui_1.IframeUI {
             'c': this.config.content,
             'v': this.config.visibleAction,
             'i': this.config.iconUrl,
+            'to': this.config.toolTip,
         });
     }
     /**