lucid-extension-sdk 0.0.172 → 0.0.174

package/commandtypes.d.ts

@@ -98,6 +98,7 @@ export declare const enum CommandName {
     OffsetItems = "oi",
     PatchDataItems = "pdi",
     Prompt = "p",
+    RegisterLinkImporter = "rli",
     RegisterPanel = "rp",
     RegisterUnfurl = "ru",
     ReloadExtension = "r",
@@ -449,6 +450,10 @@ export declare type CommandArgs = {
         query: PromptQuery;
         result: PromptResult;
     };
+    [CommandName.RegisterLinkImporter]: {
+        query: RegisterLinkImporterQuery;
+        result: RegisterLinkImporterResult;
+    };
     [CommandName.RegisterPanel]: {
         query: RegisterPanelQuery;
         result: RegisterPanelResult;
@@ -1127,6 +1132,17 @@ export declare type PromptQuery = {
     'b': string;
 };
 export declare type PromptResult = Promise<string | undefined>;
+export declare 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 declare type RegisterLinkImporterResult = void;
 export declare type RegisterPanelQuery = {
     /** Name of the panel's action for receiving events; generated automatically by Panel base class */
     'n': string;
@@ -1137,7 +1153,9 @@ export declare type RegisterPanelQuery = {
     /** Named action that returns whether the button to open the panel should be visible */
     'v'?: string | undefined;
     /** Content to display in the panel; full HTML page preferred */
-    'c': string;
+    'c'?: string | undefined;
+    /** URL to display in the panel (this or c is required). Can be relative to /public directory in the package */
+    'u'?: string | undefined;
     /** Icon URL, preferably a base64-encoded URL */
     'i': string;
     /** tooltip */
@@ -1287,7 +1305,9 @@ export declare type ShowModalQuery = {
     /** TransparentBackground or not */
     'tb'?: boolean | undefined;
     /** Content to display in the modal; full HTML page preferred */
-    'c': string;
+    'c'?: string | undefined;
+    /** URL to display in the modal (this or c is required). Can be relative to /public directory in the package */
+    'u'?: string | undefined;
 };
 export declare type ShowModalResult = undefined;
 export declare type ShowPackageSettingsModalQuery = undefined;

package/commandtypes.js

@@ -79,6 +79,7 @@ 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'],

package/core/linkimporter/linkimporter.d.ts

@@ -0,0 +1,16 @@
+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

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

package/editorclient.d.ts

@@ -1,5 +1,6 @@
 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';
@@ -179,6 +180,11 @@ 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

@@ -305,6 +305,20 @@ 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.172",
+    "version": "0.0.174",
     "description": "Utility classes for writing Lucid Software editor extensions",
     "main": "index.js",
     "types": "index.d.ts",

package/ui/modal.d.ts

@@ -3,10 +3,17 @@ import { IframeUI } from './iframeui';
 /**
  * Configuration required to display a [Modal](#classes_ui_modal-Modal).
  */
-export declare type ModalConfig = {
+export declare type ModalConfig = ({
     /** Content to display in the modal's iframe. This is set as the srcdoc on a sandboxed iframe. */
     content: string;
-} & ({
+    /** URL to load in the iframe. Can be either an absolute URL or one relative to the /public directory in this package */
+    url?: never;
+} | {
+    /** Content to display in the modal's iframe. This is set as the srcdoc on a sandboxed iframe. */
+    content?: never;
+    /** URL to load in the iframe. Can be either an absolute URL or one relative to the /public directory in this package */
+    url: string;
+}) & ({
     /** Title to display in the header bar of the modal. */
     title: string;
     /** If true, the header bar won't display (and no title is needed). */

package/ui/modal.js

@@ -33,6 +33,7 @@ class Modal extends iframeui_1.IframeUI {
                 'fs': this.config.fullScreen,
                 'tb': this.config.transparentBackground,
                 'c': this.config.content,
+                'u': this.config.url,
             });
             this.visible = true;
         }

package/ui/panel.d.ts

@@ -11,11 +11,9 @@ export declare enum PanelLocation {
     /** In Lucidspark, add a new tab to the image search callout component */
     ImageSearchTab = 3
 }
-export interface PanelConfig {
+export declare type PanelConfig = {
     /** Title to display at the top of the panel */
     title: string;
-    /** Content to display in the panel's iframe. This is set as the srcdoc on a sandboxed iframe. */
-    content: string;
     /** Location to display the panel */
     location: PanelLocation;
     /** If specified, what action's return value should determine if the button to toggle this panel is visible? */
@@ -26,7 +24,17 @@ export interface PanelConfig {
     toolTip?: string;
     /** If set true, we will persist the panel's iframe in the background if it's not currently active*/
     persist?: boolean;
-}
+} & ({
+    /** Content to display in the panel's iframe. This is set as the srcdoc on a sandboxed iframe. */
+    content: string;
+    /** URL to load in the iframe. Can be either an absolute URL or one relative to the /public directory in this package */
+    url?: never;
+} | {
+    /** Content to display in the panel's iframe. This is set as the srcdoc on a sandboxed iframe. */
+    content?: never;
+    /** URL to load in the iframe. Can be either an absolute URL or one relative to the /public directory in this package */
+    url: string;
+});
 /**
  * Extend this class to show a custom panel to the user, whose contents are displayed in a sandboxed
  * iframe controlled by your extension.

package/ui/panel.js

@@ -34,6 +34,7 @@ class Panel extends iframeui_1.IframeUI {
             't': this.config.title,
             'l': this.config.location,
             'c': this.config.content,
+            'u': this.config.url,
             'v': this.config.visibleAction,
             'i': this.config.iconUrl,
             'to': this.config.toolTip,