lucid-extension-sdk 0.0.186 → 0.0.188

package/commandtypes.d.ts

@@ -83,6 +83,7 @@ export declare const enum CommandName {
     HookSelection = "hs",
     HookTextEdit = "hte",
     ImportCards = "ic",
+    ImportLinks = "il",
     ImportPage = "imp",
     KillExtension = "k",
     ListBlocks = "lb",
@@ -103,7 +104,6 @@ export declare const enum CommandName {
     OffsetItems = "oi",
     PatchDataItems = "pdi",
     Prompt = "p",
-    RegisterLinkImporter = "rli",
     RegisterPanel = "rp",
     RegisterUnfurl = "ru",
     ReloadExtension = "r",
@@ -113,6 +113,7 @@ export declare const enum CommandName {
     SendUIMessage = "suim",
     SendXHR = "xhr",
     SetCurrentPage = "scp",
+    SetPackageSettings = "sps",
     SetProperty = "sp",
     SetReferenceKey = "srk",
     SetShapeData = "ssd",
@@ -395,6 +396,10 @@ export type CommandArgs = {
         query: ImportCardsQuery;
         result: ImportCardsResult;
     };
+    [CommandName.ImportLinks]: {
+        query: ImportLinksQuery;
+        result: ImportLinksResult;
+    };
     [CommandName.ImportPage]: {
         query: ImportPageQuery;
         result: ImportPageResult;
@@ -471,10 +476,6 @@ export type CommandArgs = {
         query: PromptQuery;
         result: PromptResult;
     };
-    [CommandName.RegisterLinkImporter]: {
-        query: RegisterLinkImporterQuery;
-        result: RegisterLinkImporterResult;
-    };
     [CommandName.RegisterPanel]: {
         query: RegisterPanelQuery;
         result: RegisterPanelResult;
@@ -511,6 +512,10 @@ export type CommandArgs = {
         query: SetCurrentPageQuery;
         result: SetCurrentPageResult;
     };
+    [CommandName.SetPackageSettings]: {
+        query: SetPackageSettingsQuery;
+        result: SetPackageSettingsResult;
+    };
     [CommandName.SetProperty]: {
         query: SetPropertyQuery;
         result: SetPropertyResult;
@@ -657,6 +662,8 @@ export type UnionToIntersection<T> = (T extends any ? (x: T) => unknown : never)
 export type AddMenuItemQuery = {
     /** Label to display on the menu item */
     'l': string;
+    /** Url of the Icon to display on the menu item */
+    'i'?: string | undefined;
     /** Named action to run when the menu item is clicked */
     'a'?: string | undefined;
     /** Named action that returns whether the menu item should be visible */
@@ -1091,6 +1098,15 @@ export type HookTextEditResult = undefined;
 export type ImportCardsQuery = string;
 /** Resolves when the import dialog is closed */
 export type ImportCardsResult = Promise<void>;
+export type ImportLinksQuery = {
+    /**
+     * By default, we import the links onto the current page. If specified, the links will instead be imported onto the given page.
+     */
+    'p'?: string | undefined;
+    /** Links to be imported onto the canvas as link unfurl blocks*/
+    'l': string[];
+};
+export type ImportLinksResult = void;
 export type ImportPageQuery = {
     /** The ID of the document or template to import */
     'id': string;
@@ -1179,17 +1195,6 @@ export type PromptQuery = {
     'b': string;
 };
 export type PromptResult = Promise<string | undefined>;
-export type RegisterLinkImporterQuery = {
-    /** ID of the link importer*/
-    'id': string;
-    /** Action to call to get links for bulk import */
-    'a': string;
-    /** Label for the menu item */
-    'l': string;
-    /** Icon URL of the menu item, preferably a base64-encoded URL */
-    'i': string;
-};
-export type RegisterLinkImporterResult = void;
 export type RegisterPanelQuery = {
     /** Name of the panel's action for receiving events; generated automatically by Panel base class */
     'n': string;
@@ -1293,6 +1298,8 @@ export type SendXHRResponse = Promise<RawSendXHRResponse>;
 export declare function isRawSendXHRResponse(val: any): val is RawSendXHRResponse;
 export type SetCurrentPageQuery = string;
 export type SetCurrentPageResult = Promise<void>;
+export type SetPackageSettingsQuery = Record<string, string>;
+export type SetPackageSettingsResult = Promise<undefined>;
 export type SetPropertyQuery = {
     /** ID of the element to change */
     'id'?: string | undefined;

package/commandtypes.js

@@ -63,6 +63,7 @@ exports.commandTitles = new Map([
     ["hs" /* CommandName.HookSelection */, 'HookSelection'],
     ["hte" /* CommandName.HookTextEdit */, 'HookTextEdit'],
     ["ic" /* CommandName.ImportCards */, 'ImportCards'],
+    ["il" /* CommandName.ImportLinks */, 'ImportLinks'],
     ["imp" /* CommandName.ImportPage */, 'ImportPage'],
     ["k" /* CommandName.KillExtension */, 'KillExtension'],
     ["lb" /* CommandName.ListBlocks */, 'ListBlocks'],
@@ -83,7 +84,6 @@ exports.commandTitles = new Map([
     ["oi" /* CommandName.OffsetItems */, 'OffsetItems'],
     ["pdi" /* CommandName.PatchDataItems */, 'PatchDataItems'],
     ["p" /* CommandName.Prompt */, 'Prompt'],
-    ["rli" /* CommandName.RegisterLinkImporter */, 'RegisterLinkImporter'],
     ["rp" /* CommandName.RegisterPanel */, 'RegisterPanel'],
     ["ru" /* CommandName.RegisterUnfurl */, 'RegisterUnfurl'],
     ["r" /* CommandName.ReloadExtension */, 'ReloadExtension'],
@@ -92,6 +92,7 @@ exports.commandTitles = new Map([
     ["suim" /* CommandName.SendUIMessage */, 'SendUIMessage'],
     ["xhr" /* CommandName.SendXHR */, 'SendXHR'],
     ["scp" /* CommandName.SetCurrentPage */, 'SetCurrentPage'],
+    ["sps" /* CommandName.SetPackageSettings */, 'SetPackageSettings'],
     ["sp" /* CommandName.SetProperty */, 'SetProperty'],
     ["srk" /* CommandName.SetReferenceKey */, 'SetReferenceKey'],
     ["ssd" /* CommandName.SetShapeData */, 'SetShapeData'],

package/document/pageproxy.d.ts

@@ -92,4 +92,12 @@ export declare class PageProxy extends ElementProxy {
      * @returns Items in the given bounding box, based on the search type
      */
     findItems(boundingBox: Box, searchType: GetItemsAtSearchType): (BlockProxy | LineProxy | GroupProxy)[];
+    /**
+     * Import links onto this page as link unfurl blocks
+     *
+     * NOTE: links will be unfurled by Lucid based on extensions installed by user
+     *
+     * @param links links to be imported onto the canvas as link unfurl blocks
+     */
+    importLinks(links: string[]): Promise<void>;
 }

package/document/pageproxy.js

@@ -143,5 +143,15 @@ class PageProxy extends elementproxy_1.ElementProxy {
             .sendCommand("gia" /* CommandName.GetItemsAt */, { 'p': this.id, 'bb': boundingBox, 's': searchType })
             .map((id) => this.client.getItemProxy(id));
     }
+    /**
+     * Import links onto this page as link unfurl blocks
+     *
+     * NOTE: links will be unfurled by Lucid based on extensions installed by user
+     *
+     * @param links links to be imported onto the canvas as link unfurl blocks
+     */
+    async importLinks(links) {
+        return await this.client.sendCommand("il" /* CommandName.ImportLinks */, { 'p': this.id, 'l': links });
+    }
 }
 exports.PageProxy = PageProxy;

package/editorclient.d.ts

@@ -1,6 +1,5 @@
 import { CommandArgs, CommandName, HashAlgorithmEnum, TriggerAuthFlowResult, UnionToIntersection } from './commandtypes';
 import { JsonSerializable } from './core/jsonserializable';
-import { LinkImporter } from './core/linkimporter/linkimporter';
 import { UnfurlCallbacks } from './core/unfurl/unfurlcallbacks';
 import { BinaryXHRResponse, OAuthXHRRequest, TextXHRResponse, XHRRequest, XHRResponse } from './core/xhr';
 import { CollectionProxy } from './data/collectionproxy';
@@ -77,6 +76,15 @@ export declare class EditorClient {
      * @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, set the
+     * value of those settings for this installation of this extension. A subset of setting values
+     * can be provided to update those values while leaving others unchanged.
+     *
+     * 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.
+     */
+    setPackageSettings(settings: Record<string, string> | Map<string, string>): Promise<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.
@@ -194,11 +202,6 @@ export declare class EditorClient {
      * @param callbacks The callbacks to call when a link matching the domain is pasted.
      */
     registerUnfurlHandler(domain: string, callbacks: UnfurlCallbacks): void;
-    /**
-     * Registers a menu item for bulk importing links.
-     * @param linkImporter The importer for getting URLs that will be imported onto the canvas as link unfurl blocks
-     */
-    registerLinkImporter(linkImporter: LinkImporter): void;
     /**
      * @ignore
      * @deprecated Use registerUnfurlHandler instead.

package/editorclient.js

@@ -126,6 +126,26 @@ class EditorClient {
     async showPackageSettingsModal() {
         return this.sendCommand("spsm" /* CommandName.ShowPackageSettingsModal */, undefined);
     }
+    /**
+     * If the extension package containing this editor extension has configurable settings, set the
+     * value of those settings for this installation of this extension. A subset of setting values
+     * can be provided to update those values while leaving others unchanged.
+     *
+     * 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.
+     */
+    async setPackageSettings(settings) {
+        let settingsAsRecord = {};
+        if (settings instanceof Map) {
+            for (const [key, value] of settings.entries()) {
+                settingsAsRecord[key] = value;
+            }
+        }
+        else {
+            settingsAsRecord = settings;
+        }
+        return this.sendCommand("sps" /* CommandName.SetPackageSettings */, settingsAsRecord);
+    }
     /**
      * If the extension package containing this editor extension has configurable settings,
      * fetch the current values of those settings for this installation of this extension.
@@ -318,20 +338,6 @@ class EditorClient {
         });
         this.sendCommand("ru" /* CommandName.RegisterUnfurl */, { 'd': domain, 'a': action });
     }
-    /**
-     * Registers a menu item for bulk importing links.
-     * @param linkImporter The importer for getting URLs that will be imported onto the canvas as link unfurl blocks
-     */
-    registerLinkImporter(linkImporter) {
-        const action = this.getUniqueActionName();
-        this.registerAction(action, async () => { var _a; return (_a = (await linkImporter.getLinksForBulkImport())) !== null && _a !== void 0 ? _a : []; });
-        this.sendCommand("rli" /* CommandName.RegisterLinkImporter */, {
-            'id': linkImporter.id,
-            'a': action,
-            'l': linkImporter.label,
-            'i': linkImporter.iconUrl,
-        });
-    }
     /**
      * @ignore
      * @deprecated Use registerUnfurlHandler instead.

package/package.json

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

package/ui/menu.d.ts

@@ -2,7 +2,8 @@ import { EditorClient } from '../editorclient';
 export declare enum MenuType {
     Main = 1,
     /** The context menu that appears when the user right-clicks the canvas. */
-    Context = 2
+    Context = 2,
+    ContentDock = 3
 }
 /**
  * Semantic locations to place a new menu item.
@@ -19,6 +20,13 @@ export declare enum MenuLocation {
 export interface CustomMenuItem {
     /** The text to display on the menu item */
     label: string;
+    /** The icon to display on the menu item.
+     * A URL (a data URI is fine) pointing to an icon representing the integration.
+     * This will be displayed at up to 32x32 CSS pixels in size.
+     *
+     * NOTE: Not all menuTypes support displaying an icon
+     */
+    iconUrl?: string;
     /** The registered action to run when the menu item is clicked */
     action?: string;
     /** If specified, what action's return value should determine if this menu item is visible? */

package/ui/menu.js

@@ -6,6 +6,7 @@ var MenuType;
     MenuType[MenuType["Main"] = 1] = "Main";
     /** The context menu that appears when the user right-clicks the canvas. */
     MenuType[MenuType["Context"] = 2] = "Context";
+    MenuType[MenuType["ContentDock"] = 3] = "ContentDock";
 })(MenuType = exports.MenuType || (exports.MenuType = {}));
 /**
  * Semantic locations to place a new menu item.
@@ -41,8 +42,15 @@ class Menu {
         if (item.disabledAction && !this.client.actionExists(item.disabledAction)) {
             throw new Error('Unregistered action: ' + item.disabledAction);
         }
+        if (item.menuType == MenuType.ContentDock && !item.iconUrl) {
+            throw new Error('MenuType.ContentDock requires icon url');
+        }
+        if (item.menuType == MenuType.ContentDock && !item.action) {
+            throw new Error('MenuType.ContentDock requires action');
+        }
         this.client.sendCommand("ami" /* CommandName.AddMenuItem */, {
             'l': item.label,
+            'i': item.iconUrl,
             'a': item.action,
             'v': item.visibleAction,
             'd': item.disabledAction,

package/core/linkimporter/linkimporter.d.ts

@@ -1,16 +0,0 @@
-export interface LinkImporter {
-    /** The id for this link importer */
-    id: string;
-    /** The text to display on the menu item */
-    label: string;
-    /** The icon to display on the menu item.
-     * A URL (a data URI is fine) pointing to an icon representing the integration.
-     * This will be displayed at up to 32x32 CSS pixels in size. */
-    iconUrl: string;
-    /** A method for getting URLs that will be imported onto the canvas as link unfurl blocks.
-     * For example, this method could display a file picker, and return URLs for all of the selected files
-     *
-     * @return an array of urls for import
-     * */
-    getLinksForBulkImport: () => Promise<string[]>;
-}

package/core/linkimporter/linkimporter.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });