lucid-extension-sdk 0.0.224 → 0.0.226

package/commandtypes.d.ts

@@ -1223,6 +1223,8 @@ export type HookSelectionResult = undefined;
 export type HookTextEditQuery = {
     /** Name of the action for receiving these events */
     'n': string;
+    /** Whether to trigger the text hook callback eagerly during text edit */
+    'e'?: boolean | undefined;
 };
 export type HookTextEditResult = undefined;
 /** Name of the card integration registered by this extension to show the import dialog for */
@@ -1424,6 +1426,12 @@ export type SendXHRQuery = {
      * - If 'binary', the response body will be returned as a Uint8Array.
      */
     'f'?: SendXHRResponseFormat | undefined;
+    /**
+     * If set, a callback to call with chunks of the response as they arrive.
+     * Only valid for utf8 (text) requests, and only called on successful responses.
+     * The full final response will still be returned as normal.
+     */
+    's'?: string | undefined;
 };
 export type RawSendXHRResponse = {
     /** URL of the response after any redirects */

package/core/xhr.d.ts

@@ -20,6 +20,10 @@ export interface XHRRequest {
      * - If 'binary', the response body will be returned as a Uint8Array.
      */
     responseFormat?: SendXHRResponseFormat;
+    /**
+     * For utf8 responses, you can have the result streamed to you for endpoints that support it.
+     */
+    streamCallback?: (chunk: string) => void;
 }
 export interface OAuthXHRRequest extends XHRRequest {
     /**

package/document/blockclasses/tableblockproxy.d.ts

@@ -84,6 +84,11 @@ export declare class TableBlockProxy extends BlockProxy {
      * @param row The index of the row to delete.
      */
     deleteRow(row: number): void;
+    /**
+     * @param textAreaKey The text area key of a cell in the table
+     * @returns The TableCellProxy represented by the text area key, or undefined if the text area key does not exist in the table.
+     */
+    getCellByTextAreaKey(textAreaKey: string): TableCellProxy | undefined;
     getRowCount(): number;
     getColumnCount(): number;
     getRows(): TableRowProxy[];

package/document/blockclasses/tableblockproxy.js

@@ -152,6 +152,19 @@ class TableBlockProxy extends blockproxy_1.BlockProxy {
     deleteRow(row) {
         return this.client.sendCommand("dtr" /* CommandName.DeleteTableRow */, { 'id': this.id, 'i': row });
     }
+    /**
+     * @param textAreaKey The text area key of a cell in the table
+     * @returns The TableCellProxy represented by the text area key, or undefined if the text area key does not exist in the table.
+     */
+    getCellByTextAreaKey(textAreaKey) {
+        const value = textAreaKey.match(/(\d+)/g);
+        if (value && value.length === 2) {
+            const row = +value[0];
+            const column = +value[1];
+            return new TableCellProxy(this, row, column);
+        }
+        return undefined;
+    }
     getRowCount() {
         return this.getRowHeights().length;
     }

package/editorclient.js

@@ -182,6 +182,11 @@ class EditorClient {
         });
     }
     xhr(request) {
+        let streamCallback;
+        if (request.streamCallback) {
+            streamCallback = this.getUniqueActionName();
+            this.registerAction(streamCallback, (msg) => { var _a; return (_a = request.streamCallback) === null || _a === void 0 ? void 0 : _a.call(request, msg['d']); });
+        }
         const responseFormat = request.responseFormat || 'utf8';
         return this.sendCommand("xhr" /* CommandName.SendXHR */, {
             'url': request.url,
@@ -190,6 +195,7 @@ class EditorClient {
             'h': request.headers,
             'ms': request.timeoutMs,
             'f': responseFormat,
+            's': streamCallback,
         })
             .then((raw) => {
             return parseRawXHRResponse(responseFormat, raw);
@@ -197,6 +203,11 @@ class EditorClient {
             .catch((error) => {
             const raw = (0, commandtypes_1.isRawSendXHRResponse)(error) ? error : undefined;
             throw parseRawXHRResponse(responseFormat, raw);
+        })
+            .finally(() => {
+            if (streamCallback) {
+                this.deleteAction(streamCallback);
+            }
         });
     }
     asyncOAuthXhr(providerName, request) {

package/package.json

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

package/ui/viewport.d.ts

@@ -60,21 +60,23 @@ export declare class Viewport {
      */
     focusCameraOnItems(items: ItemProxy[]): void;
     /**
-     * If `callback` returns false, text editing is prevented.
-     * If `callback` returns true, text editing continues as normal.
+     * If {@link callback} returns false, text editing is prevented.
+     * If {@link callback} returns true, text editing continues as normal.
+     *
+     * If {@link callback} returns a {@link TextEditCompletionCallback}(/extension-sdk/#modules_ui_viewport_texteditcompletioncallback),
+     * then text editing is allowed, but that completion callback is called.
      *
-     * If `callback` returns a [TextEditCompletionCallback](/extension-sdk/#modules_ui_viewport_texteditcompletioncallback), then text editing
-     * is allowed, but that completion callback is called
      * when the user finishes editing that text. That completion callback may return true or false to allow or deny the edit, or
      * also may return a replacement string to use instead of the text the user actually typed. If replacement text is provided,
      * it will be styled as close to the original as possible, but styles that apply to only parts of the original text will be
      * discarded.
      *
      * @param callback Called just before the user starts editing text.
+     * @param eager Whether to trigger the callback eagerly during text edit
      *
      * @returns A handle representing this hook, which can be passed to unhookTextEdit to remove this hook.
      */
-    hookTextEdit(callback: (item: ItemProxy, textAreaKey: string) => boolean | TextEditCompletionCallback | Promise<boolean | TextEditCompletionCallback>): string;
+    hookTextEdit(callback: (item: ItemProxy, textAreaKey: string, text?: string) => boolean | TextEditCompletionCallback | Promise<boolean | TextEditCompletionCallback>, eager?: boolean): string;
     /**
      * Remove a hook set by hookTextEdit.
      *

package/ui/viewport.js

@@ -83,26 +83,28 @@ class Viewport {
         }
     }
     /**
-     * If `callback` returns false, text editing is prevented.
-     * If `callback` returns true, text editing continues as normal.
+     * If {@link callback} returns false, text editing is prevented.
+     * If {@link callback} returns true, text editing continues as normal.
+     *
+     * If {@link callback} returns a {@link TextEditCompletionCallback}(/extension-sdk/#modules_ui_viewport_texteditcompletioncallback),
+     * then text editing is allowed, but that completion callback is called.
      *
-     * If `callback` returns a [TextEditCompletionCallback](/extension-sdk/#modules_ui_viewport_texteditcompletioncallback), then text editing
-     * is allowed, but that completion callback is called
      * when the user finishes editing that text. That completion callback may return true or false to allow or deny the edit, or
      * also may return a replacement string to use instead of the text the user actually typed. If replacement text is provided,
      * it will be styled as close to the original as possible, but styles that apply to only parts of the original text will be
      * discarded.
      *
      * @param callback Called just before the user starts editing text.
+     * @param eager Whether to trigger the callback eagerly during text edit
      *
      * @returns A handle representing this hook, which can be passed to unhookTextEdit to remove this hook.
      */
-    hookTextEdit(callback) {
+    hookTextEdit(callback, eager) {
         const actionName = Viewport.nextHookName();
         this.client.registerAction(actionName, async (textHookParam) => {
             const element = this.client.getElementProxy(textHookParam['i']);
             if (element instanceof itemproxy_1.ItemProxy) {
-                const result = await callback(element, textHookParam['t']);
+                const result = await callback(element, textHookParam['t'], textHookParam['v']);
                 if ((0, checks_1.isBoolean)(result)) {
                     return result;
                 }
@@ -120,7 +122,7 @@ class Viewport {
                 return true;
             }
         });
-        this.client.sendCommand("hte" /* CommandName.HookTextEdit */, { 'n': actionName });
+        this.client.sendCommand("hte" /* CommandName.HookTextEdit */, { 'n': actionName, 'e': !!eager });
         return actionName;
     }
     /**