lucid-extension-sdk 0.0.246 → 0.0.248

package/commandtypes.d.ts

@@ -70,6 +70,7 @@ export declare const enum CommandName {
     GetCustomShape = "gcs",
     GetDataItemField = "gdif",
     GetDocumentAccessPermission = "gdap",
+    GetDocumentChunks = "gdc",
     GetDocumentId = "gdid",
     GetElementType = "get",
     GetEnvironmentConfig = "gec",
@@ -342,6 +343,10 @@ export type CommandArgs = {
         query: GetDocumentAccessPermissionQuery;
         result: GetDocumentAccessPermissionResult;
     };
+    [CommandName.GetDocumentChunks]: {
+        query: GetDocumentChunksQuery;
+        result: GetDocumentChunksResult;
+    };
     [CommandName.GetDocumentId]: {
         query: GetDocumentIdQuery;
         result: GetDocumentIdResult;
@@ -1112,6 +1117,29 @@ export type GetDataItemFieldQuery = {
 export type GetDataItemFieldResult = SerializedFieldType;
 export type GetDocumentAccessPermissionQuery = void;
 export type GetDocumentAccessPermissionResult = DocumentAccessPermission;
+export declare enum GetDocumentChunksType {
+    /**
+     * Breaks up a document into chunks geographically
+     */
+    Geographic = 0,
+    /**
+     * Breaks up a document into chunks by finding containing blocks
+     */
+    Container = 1
+}
+export type GetDocumentChunksQuery = {
+    't': GetDocumentChunksType[];
+};
+export type GetDocumentChunksResult = SerializedDocumentChunk[];
+type SerializedDocumentChunk = {
+    /** Bounding box of all items combined */
+    'bb': Box;
+    /** Ids of the items included in the chunk */
+    'i': string[];
+    't': string;
+    /** Very brief description that helps describe the chunk */
+    'd': string;
+};
 export type GetDocumentIdQuery = void;
 export type GetDocumentIdResult = string;
 export type GetItemPageIdQuery = string;
@@ -1429,8 +1457,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;
@@ -1678,3 +1712,4 @@ export type ZOrderQuery = {
     'o': ZOrderOperation;
 };
 export type ZOrderResult = undefined;
+export {};

package/commandtypes.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ZOrderOperation = exports.isRawSendXHRResponse = exports.MermaidDiagramType = exports.GetLLMContextType = exports.GetItemsAtSearchType = exports.HashAlgorithmEnum = exports.commandTitles = void 0;
+exports.ZOrderOperation = exports.isRawSendXHRResponse = exports.MermaidDiagramType = exports.GetLLMContextType = exports.GetItemsAtSearchType = exports.GetDocumentChunksType = exports.HashAlgorithmEnum = exports.commandTitles = void 0;
 const checks_1 = require("./core/checks");
 /** @ignore */
 exports.commandTitles = new Map([
@@ -46,6 +46,7 @@ exports.commandTitles = new Map([
     ["gcs" /* CommandName.GetCustomShape */, 'GetCustomShape'],
     ["gdif" /* CommandName.GetDataItemField */, 'GetDataItemField'],
     ["gdap" /* CommandName.GetDocumentAccessPermission */, 'GetDocumentAccessPermission'],
+    ["gdc" /* CommandName.GetDocumentChunks */, 'GetDocumentChunks'],
     ["gdid" /* CommandName.GetDocumentId */, 'GetDocumentId'],
     ["get" /* CommandName.GetElementType */, 'GetElementType'],
     ["gec" /* CommandName.GetEnvironmentConfig */, 'GetEnvironmentConfig'],
@@ -131,6 +132,17 @@ var HashAlgorithmEnum;
     /** Use the SHA 256 hashing algorithm */
     HashAlgorithmEnum["sha256"] = "SHA256";
 })(HashAlgorithmEnum || (exports.HashAlgorithmEnum = HashAlgorithmEnum = {}));
+var GetDocumentChunksType;
+(function (GetDocumentChunksType) {
+    /**
+     * Breaks up a document into chunks geographically
+     */
+    GetDocumentChunksType[GetDocumentChunksType["Geographic"] = 0] = "Geographic";
+    /**
+     * Breaks up a document into chunks by finding containing blocks
+     */
+    GetDocumentChunksType[GetDocumentChunksType["Container"] = 1] = "Container";
+})(GetDocumentChunksType || (exports.GetDocumentChunksType = GetDocumentChunksType = {}));
 var GetItemsAtSearchType;
 (function (GetItemsAtSearchType) {
     GetItemsAtSearchType[GetItemsAtSearchType["PossiblyOverlapping"] = 0] = "PossiblyOverlapping";

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/documentchunk.d.ts

@@ -0,0 +1,25 @@
+import { Box } from '../math';
+import { ItemProxy } from './itemproxy';
+/**
+ * @ignore
+ * A representation of separated portions of the document
+ */
+export interface DocumentChunk {
+    /**
+     * THe bounding box of all items combined
+     */
+    boundingBox: Box;
+    /**
+     * Items included in the chunk
+     */
+    items: ItemProxy[];
+    /**
+     * All displayed text in the chunk
+     */
+    text: string;
+    /**
+     * Very brief description that helps describe the chunk. This will be used
+     * as part of the page name when writing to pages.
+     */
+    description: string;
+}

package/document/documentchunk.js

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

package/document/documentproxy.d.ts

@@ -1,4 +1,6 @@
+import { GetDocumentChunksType } from '../commandtypes';
 import { EditorClient } from '../editorclient';
+import { DocumentChunk } from './documentchunk';
 import { CardConfigProxy } from './documentelement/cardconfigproxy';
 import { RuleProxy } from './documentelement/ruleproxy';
 import { ElementProxy } from './elementproxy';
@@ -41,6 +43,8 @@ export declare class DocumentProxy extends ElementProxy {
      * @returns The title of this document
      */
     getTitle(): string;
+    /** @ignore */
+    getDocumentChunks(types: GetDocumentChunksType[]): DocumentChunk[];
     /**
      * Infrequently, you may need to watch for *any* changes to the document. These changes may be
      * the local user adding content, or a data integration sending updated records to a data collection,

package/document/documentproxy.js

@@ -5,6 +5,7 @@ const cardconfigproxy_1 = require("./documentelement/cardconfigproxy");
 const documentelementtype_1 = require("./documentelement/documentelementtype");
 const ruleproxy_1 = require("./documentelement/ruleproxy");
 const elementproxy_1 = require("./elementproxy");
+const itemproxy_1 = require("./itemproxy");
 const mapproxy_1 = require("./mapproxy");
 const pageproxy_1 = require("./pageproxy");
 /**
@@ -70,6 +71,20 @@ class DocumentProxy extends elementproxy_1.ElementProxy {
     getTitle() {
         return this.properties.get('Title');
     }
+    /** @ignore */
+    getDocumentChunks(types) {
+        const chunks = this.client.sendCommand("gdc" /* CommandName.GetDocumentChunks */, { 't': types });
+        return chunks.map((chunk) => {
+            return {
+                boundingBox: chunk['bb'],
+                items: chunk['i']
+                    .map((id) => this.client.getElementProxy(id))
+                    .filter((element) => element instanceof itemproxy_1.ItemProxy),
+                text: chunk['t'],
+                description: chunk['d'],
+            };
+        });
+    }
     /**
      * Infrequently, you may need to watch for *any* changes to the document. These changes may be
      * the local user adding content, or a data integration sending updated records to a data collection,

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.246",
+    "version": "0.0.248",
     "description": "Utility classes for writing Lucid Software editor extensions",
     "main": "index.js",
     "types": "index.d.ts",