lucid-extension-sdk 0.0.245 → 0.0.247

package/commandtypes.d.ts

@@ -45,6 +45,7 @@ export declare const enum CommandName {
     CreateCollection = "cc",
     CreateDataSource = "cds",
     CreateDocumentElement = "cde",
+    CreateGroup = "cg",
     CreateLine = "cl",
     CreatePage = "cp",
     CreateUserImage = "cui",
@@ -241,6 +242,10 @@ export type CommandArgs = {
         query: CreateDocumentElementQuery;
         result: CreateDocumentElementResult;
     };
+    [CommandName.CreateGroup]: {
+        query: CreateGroupQuery;
+        result: CreateGroupResult;
+    };
     [CommandName.CreateLine]: {
         query: CreateLineQuery;
         result: CreateLineResult;
@@ -886,6 +891,16 @@ export type CreateBlockQuery = {
     's'?: JsonSerializable | undefined;
 };
 export type CreateBlockResult = string;
+export type CreateGroupQuery = {
+    /**
+     * By default, we add the group to the current page & currently active group. If specified, the
+     * group will instead be created as a direct child of the given page.
+     */
+    'p'?: string | undefined;
+    /** List of item IDs to group */
+    'i': string[];
+};
+export type CreateGroupResult = string;
 export type CreateCollectionFieldDefinition = {
     /** Name of the field */
     'n': string;
@@ -1414,8 +1429,14 @@ export type RegisterPanelResult = undefined;
 export type RegisterUnfurlQuery = {
     /** Domain to unfurl, e.g. www.google.com */
     'd': string;
-    /** Action to call to configure the unfurl */
-    'a': string;
+    /** For backwards compatility */
+    'a'?: string | undefined;
+    /** Unfurl Action name for the unfurl handler */
+    'ua'?: string | undefined;
+    /** After Unfurl Action name for the unfurl handler */
+    'aua'?: string | undefined;
+    /** Expand Callback Action name for the unfurl handler */
+    'e'?: string | undefined;
 };
 export type RegisterUnfurlResult = boolean;
 export type ReloadExtensionQuery = void;

package/commandtypes.js

@@ -23,6 +23,7 @@ exports.commandTitles = new Map([
     ["cc" /* CommandName.CreateCollection */, 'CreateCollection'],
     ["cds" /* CommandName.CreateDataSource */, 'CreateDataSource'],
     ["cde" /* CommandName.CreateDocumentElement */, 'CreateDocumentElement'],
+    ["cg" /* CommandName.CreateGroup */, 'CreateGroup'],
     ["cl" /* CommandName.CreateLine */, 'CreateLine'],
     ["cp" /* CommandName.CreatePage */, 'CreatePage'],
     ["die" /* CommandName.DataItemExists */, 'DataItemExists'],

package/core/unfurl/unfurlcallbacks.d.ts

@@ -3,7 +3,8 @@ import { UnfurlDetails } from './unfurldetails';
 import { UnfurlRefreshErrorType } from './unfurlrefresherrortype';
 export declare enum UnfurlCallbackType {
     Unfurl = "u",
-    AfterUnfurl = "a"
+    AfterUnfurl = "a",
+    ExpandCallback = "e"
 }
 /**
  * The callbacks that handle unfurls and refreshing.
@@ -33,4 +34,12 @@ export interface UnfurlCallbacks {
      * @param blockProxy The block proxy of the unfurl block
      */
     afterUnfurlCallback?: (blockProxy: LinkUnfurlBlockProxy, url: string) => Promise<void>;
+    /**
+     * Callback upon clicking expand button.
+     * Occurs before attempting to expand iframe.
+     *
+     * @param blockProxy The block proxy of the unfurl block
+     * @param url The url to unfurl
+     */
+    expandCallback?: (blockProxy: LinkUnfurlBlockProxy, url: string) => Promise<void>;
 }

package/core/unfurl/unfurlcallbacks.js

@@ -5,4 +5,5 @@ var UnfurlCallbackType;
 (function (UnfurlCallbackType) {
     UnfurlCallbackType["Unfurl"] = "u";
     UnfurlCallbackType["AfterUnfurl"] = "a";
+    UnfurlCallbackType["ExpandCallback"] = "e";
 })(UnfurlCallbackType || (exports.UnfurlCallbackType = UnfurlCallbackType = {}));

package/document/blockclasses/linkunfurlblockproxy.d.ts

@@ -39,6 +39,10 @@ export declare class LinkUnfurlBlockProxy extends BlockProxy {
      * Sets the URL to be loaded in an iframe when the user clicks the "Expand" action on the block.
      */
     setIframe(unfurlIframe: UnfurlIframe): void;
+    /**
+     * Returns true if there is an iframe URL already set for this unfurl block
+     */
+    hasIframe(): boolean;
     /**
      * Sets the main thumbnail on the block
      */

package/document/blockclasses/linkunfurlblockproxy.js

@@ -60,6 +60,12 @@ class LinkUnfurlBlockProxy extends blockproxy_1.BlockProxy {
         this.properties.set('LinkUnfurlIframeHeight', iframeAttributes.height);
         this.properties.set('LinkUnfurlIframeWidth', iframeAttributes.width);
     }
+    /**
+     * Returns true if there is an iframe URL already set for this unfurl block
+     */
+    hasIframe() {
+        return !!this.properties.get('LinkUnfurlIframeHtml');
+    }
     /**
      * Sets the main thumbnail on the block
      */

package/document/pageproxy.d.ts

@@ -86,6 +86,13 @@ export declare class PageProxy extends ElementProxy {
      * @returns The added block
      */
     addBlock(def: BlockDefinition): BlockProxy;
+    /**
+     * Creates a new group from a list of items.
+     *
+     * @param blocks A non-empty array of items to group
+     * @returns The added group
+     */
+    groupBlocks(blocks: BlockProxy[]): GroupProxy;
     /**
      * Add a new line to this page.
      * @param def The definition of the new line to add

package/document/pageproxy.js

@@ -128,6 +128,19 @@ class PageProxy extends elementproxy_1.ElementProxy {
         }
         return block;
     }
+    /**
+     * Creates a new group from a list of items.
+     *
+     * @param blocks A non-empty array of items to group
+     * @returns The added group
+     */
+    groupBlocks(blocks) {
+        const id = this.client.sendCommand("cg" /* CommandName.CreateGroup */, {
+            'p': this.id,
+            'i': blocks.map((block) => block.id),
+        });
+        return new groupproxy_1.GroupProxy(id, this.client);
+    }
     /**
      * Add a new line to this page.
      * @param def The definition of the new line to add

package/editorclient.js

@@ -4,7 +4,6 @@ exports.EditorClient = void 0;
 const commandtypes_1 = require("./commandtypes");
 const base64_1 = require("./core/base64");
 const checks_1 = require("./core/checks");
-const unfurlcallbacks_1 = require("./core/unfurl/unfurlcallbacks");
 const unfurldetails_1 = require("./core/unfurl/unfurldetails");
 const unfurlrefresherrortype_1 = require("./core/unfurl/unfurlrefresherrortype");
 const collectionproxy_1 = require("./data/collectionproxy");
@@ -318,36 +317,55 @@ class EditorClient {
      * @param callbacks The callbacks to call when a link matching the domain is pasted.
      */
     registerUnfurlHandler(domain, callbacks) {
-        const action = this.getUniqueActionName();
-        this.registerAction(action, async (rawMsg) => {
-            var _a;
+        const unfurlAction = this.getUniqueActionName();
+        let afterUnfurlAction = undefined;
+        let expandAction = undefined;
+        this.registerAction(unfurlAction, async (rawMsg) => {
             const msg = (0, unfurleventmessage_1.deserializeUnfurlEventMessage)(rawMsg);
-            switch (msg.unfurlCallbackType) {
-                case unfurlcallbacks_1.UnfurlCallbackType.Unfurl: {
-                    try {
-                        const result = await callbacks.unfurlCallback(msg.url);
-                        if (result && !(0, unfurlrefresherrortype_1.unfurlRefreshErrorTypeValidator)(result)) {
-                            return (0, unfurldetails_1.serializeUnfurlDetails)(result);
-                        }
-                    }
-                    catch (err) {
-                        return unfurlrefresherrortype_1.UnfurlRefreshErrorType.GenericFailure;
+            try {
+                const result = await callbacks.unfurlCallback(msg.url);
+                if (result && !(0, unfurlrefresherrortype_1.unfurlRefreshErrorTypeValidator)(result)) {
+                    return (0, unfurldetails_1.serializeUnfurlDetails)(result);
+                }
+            }
+            catch (err) {
+                return unfurlrefresherrortype_1.UnfurlRefreshErrorType.GenericFailure;
+            }
+            return undefined;
+        });
+        if (callbacks.afterUnfurlCallback) {
+            afterUnfurlAction = this.getUniqueActionName();
+            this.registerAction(afterUnfurlAction, async (rawMsg) => {
+                var _a;
+                const msg = (0, unfurleventmessage_1.deserializeUnfurlEventMessage)(rawMsg);
+                if (msg.blockId) {
+                    const proxy = this.getBlockProxy(msg.blockId);
+                    if (proxy instanceof linkunfurlblockproxy_1.LinkUnfurlBlockProxy) {
+                        await ((_a = callbacks.afterUnfurlCallback) === null || _a === void 0 ? void 0 : _a.call(callbacks, proxy, msg.url));
                     }
-                    break;
                 }
-                case unfurlcallbacks_1.UnfurlCallbackType.AfterUnfurl: {
-                    if (msg.blockId) {
-                        const proxy = this.getBlockProxy(msg.blockId);
-                        if (proxy instanceof linkunfurlblockproxy_1.LinkUnfurlBlockProxy) {
-                            await ((_a = callbacks.afterUnfurlCallback) === null || _a === void 0 ? void 0 : _a.call(callbacks, proxy, msg.url));
-                        }
+                return undefined;
+            });
+        }
+        if (callbacks.expandCallback) {
+            expandAction = this.getUniqueActionName();
+            this.registerAction(expandAction, async (rawMsg) => {
+                var _a;
+                const msg = (0, unfurleventmessage_1.deserializeUnfurlEventMessage)(rawMsg);
+                if (msg.blockId) {
+                    const proxy = this.getBlockProxy(msg.blockId);
+                    if (proxy instanceof linkunfurlblockproxy_1.LinkUnfurlBlockProxy) {
+                        await ((_a = callbacks.expandCallback) === null || _a === void 0 ? void 0 : _a.call(callbacks, proxy, msg.url));
                     }
-                    break;
                 }
-            }
-            return undefined;
+            });
+        }
+        this.sendCommand("ru" /* CommandName.RegisterUnfurl */, {
+            'd': domain,
+            'ua': unfurlAction,
+            'aua': afterUnfurlAction,
+            'e': expandAction,
         });
-        this.sendCommand("ru" /* CommandName.RegisterUnfurl */, { 'd': domain, 'a': action });
     }
     /**
      * @ignore

package/package.json

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