lucid-extension-sdk 0.0.187 → 0.0.189

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",
@@ -396,6 +396,10 @@ export type CommandArgs = {
         query: ImportCardsQuery;
         result: ImportCardsResult;
     };
+    [CommandName.ImportLinks]: {
+        query: ImportLinksQuery;
+        result: ImportLinksResult;
+    };
     [CommandName.ImportPage]: {
         query: ImportPageQuery;
         result: ImportPageResult;
@@ -472,10 +476,6 @@ export type CommandArgs = {
         query: PromptQuery;
         result: PromptResult;
     };
-    [CommandName.RegisterLinkImporter]: {
-        query: RegisterLinkImporterQuery;
-        result: RegisterLinkImporterResult;
-    };
     [CommandName.RegisterPanel]: {
         query: RegisterPanelQuery;
         result: RegisterPanelResult;
@@ -662,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 */
@@ -708,10 +710,6 @@ export type AddSpreadsheetIntegrationQuery = {
     'gs': string;
     /** getMultipleSheetsForSpreadsheetDetails */
     'gm': string;
-    /** getSpreadsheetData */
-    'gd': string;
-    /** importIsComplete */
-    'ic': string;
 };
 /** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
 export type AddSpreadsheetIntegrationResult = undefined;
@@ -1096,6 +1094,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;
@@ -1184,17 +1191,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;

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'],

package/core/data/datasource/previewdatatypes.d.ts

@@ -0,0 +1,10 @@
+/** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
+export interface SerializedPreviewDataPayload<CONFIG, SHEET> {
+    'SpreadsheetDetails': CONFIG;
+    'Sheets': [SHEET, string][];
+}
+/** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
+export declare function isSerializedPreviewDataPayload<CONFIG, SHEET>(configValidator: (x: unknown) => x is CONFIG, sheetValidator: (x: unknown) => x is SHEET): (subject: unknown) => subject is import("../../guards").DestructureGuardedTypeObj<{
+    SpreadsheetDetails: (x: unknown) => x is CONFIG;
+    Sheets: (p1: unknown) => p1 is [SHEET, string][];
+}>;

package/core/data/datasource/previewdatatypes.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isSerializedPreviewDataPayload = void 0;
+const checks_1 = require("../../checks");
+const validators_1 = require("../../validators/validators");
+/** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
+function isSerializedPreviewDataPayload(configValidator, sheetValidator) {
+    return (0, validators_1.strictObjectValidator)({
+        'SpreadsheetDetails': configValidator,
+        'Sheets': (0, validators_1.arrayValidator)((0, validators_1.tupleValidator)(sheetValidator, checks_1.isString)),
+    });
+}
+exports.isSerializedPreviewDataPayload = isSerializedPreviewDataPayload;

package/core/spreadsheetintegration/lucidspreadsheetintegration.d.ts

@@ -1,4 +1,3 @@
-import { SerializedImportedDataSource } from '../data/datasource/serializedimporteddatasource';
 import { SerializedUpstreamConfig } from '../data/datasource/serializedupstreamconfig';
 import { SerializedSchema } from '../data/serializedfield/serializedschema';
 import { JsonSerializable } from '../jsonserializable';
@@ -30,6 +29,4 @@ export declare abstract class LucidSpreadsheetIntegration<CONFIG extends JsonSer
     abstract dataConnectorName: string;
     abstract getSpreadsheetDetailsToImport(): Promise<CONFIG | LucidSpreadsheetIntegrationFailureType>;
     abstract getMultipleSheetsForSpreadsheetDetails(spreadsheetDetails: CONFIG): Promise<Map<SHEET, string> | LucidSpreadsheetIntegrationFailureType>;
-    abstract getSpreadsheetData(spreadsheetDetails: CONFIG, sheets: SHEET[]): Promise<SerializedImportedDataSource | LucidSpreadsheetIntegrationFailureType>;
-    abstract importIsComplete(syncDataSourceIdNonce: string, importedResults: ImportedResults): void;
 }

package/core/spreadsheetintegration/lucidspreadsheetintegrationregistry.js

@@ -34,26 +34,12 @@ class LucidSpreadsheetIntegrationRegistry {
             catch (error) { }
             return lucidspreadsheetintegration_1.LucidSpreadsheetIntegrationFailureType.GenericFailure;
         });
-        const getSpreadsheetDataActionName = LucidSpreadsheetIntegrationRegistry.nextHookName();
-        client.registerAction(getSpreadsheetDataActionName, async (message) => {
-            try {
-                return await spreadsheetIntegration.getSpreadsheetData(message['spreadsheetDetails'], message['sheets']);
-            }
-            catch (error) { }
-            return lucidspreadsheetintegration_1.LucidSpreadsheetIntegrationFailureType.GenericFailure;
-        });
-        const importIsCompleteActionName = LucidSpreadsheetIntegrationRegistry.nextHookName();
-        client.registerAction(importIsCompleteActionName, async (message) => {
-            spreadsheetIntegration.importIsComplete(message['SyncDataSourceIdNonce'], message['ImportedResults']);
-        });
         const serialized = {
             'ld': spreadsheetIntegration.labelDescription,
             'li': spreadsheetIntegration.labelIconUrl,
             'dc': spreadsheetIntegration.dataConnectorName,
             'gs': getSpreadsheetDetailsToImportActionName,
             'gm': getMultipleSheetsForSpreadsheetDetailsActionName,
-            'gd': getSpreadsheetDataActionName,
-            'ic': importIsCompleteActionName,
         };
         client.sendCommand("asi" /* CommandName.AddSpreadsheetIntegration */, serialized);
     }

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';
@@ -203,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

@@ -338,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.187",
+    "version": "0.0.189",
     "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 });