flowscale 1.0.13 → 1.0.14

package/README.md

@@ -165,6 +165,51 @@ console.log('Workflow Result:', result);
 
 ---
 
+### 3.1 `executeWorkflowAsync(workflowId, data, groupId?, pollIntervalMs?, timeoutMs?)`
+
+**Description:**
+Execute a workflow and automatically wait for the result by polling the output. This is a convenience method that combines `executeWorkflow` and `getOutput` with automatic polling.
+
+**Parameters:**
+- `workflowId` *(string)*: The unique ID of the workflow.
+- `data` *(object)*: Input parameters for the workflow.
+- `groupId` *(string, optional)*: A custom identifier for grouping runs.
+- `pollIntervalMs` *(number, optional)*: Polling interval in milliseconds (default: 1000).
+- `timeoutMs` *(number, optional)*: Maximum time to wait for results in milliseconds (default: 300000 - 5 minutes).
+
+**Usage:**
+```javascript
+const workflowId = "bncu0a1kipv";
+const inputs = {
+   "text_51536": "Prompt test",
+   "image_1234": { /* File or Blob of image */ }
+};
+
+try {
+  const result = await flowscale.executeWorkflowAsync(workflowId, inputs);
+  console.log('Workflow Result:', result);
+} catch (error) {
+  if (error.message.includes('timed out')) {
+    console.error('Workflow took too long to complete');
+  } else {
+    console.error('Workflow error:', error);
+  }
+}
+```
+
+**Response Example:**
+```json
+{
+  "status": "success",
+  "data": {
+    "download_url": "https://runs.s3.amazonaws.com/generations/...",
+    "generation_status": "success"
+  }
+}
+```
+
+---
+
 ### 4. `getOutput(filename)`
 
 **Description:**

package/dist/index.d.ts

@@ -21,6 +21,17 @@ export declare class FlowscaleAPI {
     executeWorkflow(workflowId: string, data: {
         [key: string]: any;
     }, groupId?: string): Promise<ExecuteWorkflowResponse>;
+    /**
+     * Executes a workflow and waits for the output by polling.
+     * @param workflowId - The ID of the workflow to execute.
+     * @param data - Form data including text fields and file uploads.
+     * @param groupId - Optional group ID.
+     * @param pollIntervalMs - Optional polling interval in milliseconds (default: 1000)
+     * @param timeoutMs - Optional timeout in milliseconds (default: 300000 - 5 minutes)
+     */
+    executeWorkflowAsync(workflowId: string, data: {
+        [key: string]: any;
+    }, groupId?: string, pollIntervalMs?: number, timeoutMs?: number): Promise<GetOutputResponse>;
     /**
      * Retrieves the output of a specific run by providing the filename.
      * @param filename - The filename of the output to retrieve.

package/dist/index.js

@@ -167,6 +167,55 @@ var FlowscaleAPI = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Executes a workflow and waits for the output by polling.
+     * @param workflowId - The ID of the workflow to execute.
+     * @param data - Form data including text fields and file uploads.
+     * @param groupId - Optional group ID.
+     * @param pollIntervalMs - Optional polling interval in milliseconds (default: 1000)
+     * @param timeoutMs - Optional timeout in milliseconds (default: 300000 - 5 minutes)
+     */
+    FlowscaleAPI.prototype.executeWorkflowAsync = function (workflowId_1, data_1, groupId_1) {
+        return __awaiter(this, arguments, void 0, function (workflowId, data, groupId, pollIntervalMs, timeoutMs) {
+            var startTime, executeResponse, outputName, output;
+            var _a, _b;
+            if (pollIntervalMs === void 0) { pollIntervalMs = 1000; }
+            if (timeoutMs === void 0) { timeoutMs = 300000; }
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        startTime = Date.now();
+                        return [4 /*yield*/, this.executeWorkflow(workflowId, data, groupId)];
+                    case 1:
+                        executeResponse = _c.sent();
+                        // If there are no output names, throw an error
+                        if (!((_b = (_a = executeResponse === null || executeResponse === void 0 ? void 0 : executeResponse.data) === null || _a === void 0 ? void 0 : _a.output_names) === null || _b === void 0 ? void 0 : _b.length)) {
+                            throw new Error('No output names returned from workflow execution');
+                        }
+                        outputName = executeResponse.data.output_names[0];
+                        _c.label = 2;
+                    case 2:
+                        if (!true) return [3 /*break*/, 5];
+                        if (Date.now() - startTime > timeoutMs) {
+                            throw new Error("Workflow execution timed out after ".concat(timeoutMs, "ms"));
+                        }
+                        return [4 /*yield*/, this.getOutput(outputName)];
+                    case 3:
+                        output = _c.sent();
+                        if (output !== null) {
+                            return [2 /*return*/, output];
+                        }
+                        // Wait for the polling interval
+                        return [4 /*yield*/, new Promise(function (resolve) { return setTimeout(resolve, pollIntervalMs); })];
+                    case 4:
+                        // Wait for the polling interval
+                        _c.sent();
+                        return [3 /*break*/, 2];
+                    case 5: return [2 /*return*/];
+                }
+            });
+        });
+    };
     /**
      * Retrieves the output of a specific run by providing the filename.
      * @param filename - The filename of the output to retrieve.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flowscale",
-  "version": "1.0.13",
+  "version": "1.0.14",
   "description": "An NPM library for communicating with the Flowscale APIs",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",