lucid-extension-sdk 0.0.223 → 0.0.225

package/commandtypes.d.ts

@@ -1424,6 +1424,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/dataconnector/debugserver.d.ts

@@ -22,7 +22,11 @@ export type ExpressAppLike = {
             end: () => unknown;
         };
     }) => Promise<void>) => unknown;
-    listen: (port: number | string, x: () => unknown) => unknown;
+    listen: (port: number, x: () => unknown) => {
+        address: () => {
+            port: number;
+        } | string | null;
+    };
 };
 /**
  * Options for how to run the debug server

package/dataconnector/debugserver.js

@@ -70,7 +70,9 @@ exports.routeDebugServer = routeDebugServer;
 function runDebugServer(dataConnector, options) {
     var _a;
     const port = (_a = options.port) !== null && _a !== void 0 ? _a : 3001;
-    routeDebugServer(dataConnector, options).listen(port, () => {
+    const server = routeDebugServer(dataConnector, options).listen(port, () => {
+        const address = server.address();
+        const port = typeof address === 'string' ? address : address === null || address === void 0 ? void 0 : address.port;
         console.log(`Listening on port ${port}`);
     });
 }

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