browser-use-sdk 2.0.6 → 2.0.8

package/dist/esm/wrapper/lib/parse.mjs

@@ -82,6 +82,8 @@ export function wrapCreateTaskResponse(client, response, schema) {
                 switch (res.status) {
                     case "finished":
                     case "stopped":
+                        break poll;
+                    case "created":
                     case "started":
                         yield __await(new Promise((resolve) => setTimeout(resolve, intervalMs)));
                         break;
@@ -158,13 +160,14 @@ export function wrapCreateTaskResponse(client, response, schema) {
                     _c = _f.value;
                     _d = false;
                     const msg = _c;
-                    switch (msg.data.status) {
-                        case "finished":
-                        case "stopped":
-                        case "started":
-                            break;
-                        // default:
-                        // throw new ExhaustiveSwitchCheck(msg.data.status as never);
+                    // Return on terminal statuses
+                    if (msg.data.status === "finished" || msg.data.status === "stopped") {
+                        if (schema != null) {
+                            return parseStructuredTaskOutput(msg.data, schema);
+                        }
+                        else {
+                            return msg.data;
+                        }
                     }
                 }
             }

package/dist/esm/wrapper/lib/webhooks.d.mts

@@ -85,8 +85,8 @@ export declare function verifyWebhookEventSignature(evt: {
 /**
  * Creates a webhook signature for the given payload, timestamp, and secret.
  */
-export declare function createWebhookSignature({ payload, timestamp, secret, }: {
-    payload: unknown;
+export declare function createWebhookSignature({ body, timestamp, secret, }: {
+    body: unknown;
     timestamp: string;
     secret: string;
 }): string;

package/dist/esm/wrapper/lib/webhooks.mjs

@@ -61,7 +61,7 @@ export function verifyWebhookEventSignature(evt, cfg) {
                 return { ok: false };
             }
             const signature = createWebhookSignature({
-                payload: event.data.payload,
+                body: event.data, // NOTE: We need to encrypt the entire body, not just the payload
                 timestamp: evt.timestamp,
                 secret: cfg.secret,
             });
@@ -80,8 +80,8 @@ export function verifyWebhookEventSignature(evt, cfg) {
 /**
  * Creates a webhook signature for the given payload, timestamp, and secret.
  */
-export function createWebhookSignature({ payload, timestamp, secret, }) {
-    const dump = stringify(payload);
+export function createWebhookSignature({ body, timestamp, secret, }) {
+    const dump = stringify(body);
     const message = `${timestamp}.${dump}`;
     const hmac = createHmac("sha256", secret);
     hmac.update(message);

package/package.json

@@ -1,85 +1,84 @@
 {
-    "name": "browser-use-sdk",
-    "version": "2.0.6",
-    "private": false,
-    "repository": "github:browser-use/browser-use-node",
-    "type": "commonjs",
-    "main": "./dist/cjs/index.js",
-    "module": "./dist/esm/index.mjs",
-    "types": "./dist/cjs/index.d.ts",
-    "exports": {
-        ".": {
-            "types": "./dist/cjs/index.d.ts",
-            "import": {
-                "types": "./dist/esm/index.d.mts",
-                "default": "./dist/esm/index.mjs"
-            },
-            "require": {
-                "types": "./dist/cjs/index.d.ts",
-                "default": "./dist/cjs/index.js"
-            },
-            "default": "./dist/cjs/index.js"
-        },
-        "./package.json": "./package.json"
+  "name": "browser-use-sdk",
+  "version": "2.0.8",
+  "private": false,
+  "repository": "github:browser-use/browser-use-node",
+  "type": "commonjs",
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.mjs",
+  "types": "./dist/cjs/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/cjs/index.d.ts",
+      "import": {
+        "types": "./dist/esm/index.d.mts",
+        "default": "./dist/esm/index.mjs"
+      },
+      "require": {
+        "types": "./dist/cjs/index.d.ts",
+        "default": "./dist/cjs/index.js"
+      },
+      "default": "./dist/cjs/index.js"
     },
-    "files": [
-        "dist",
-        "reference.md",
-        "README.md",
-        "LICENSE"
-    ],
-    "scripts": {
-        "format": "biome format --write --skip-parse-errors --no-errors-on-unmatched --max-diagnostics=none",
-        "format:check": "biome format --skip-parse-errors --no-errors-on-unmatched --max-diagnostics=none",
-        "lint": "biome lint --skip-parse-errors --no-errors-on-unmatched --max-diagnostics=none",
-        "lint:fix": "biome lint --fix --unsafe --skip-parse-errors --no-errors-on-unmatched --max-diagnostics=none",
-        "check": "biome check --skip-parse-errors --no-errors-on-unmatched --max-diagnostics=none",
-        "check:fix": "biome check --fix --unsafe --skip-parse-errors --no-errors-on-unmatched --max-diagnostics=none",
-        "build": "pnpm build:cjs && pnpm build:esm",
-        "build:cjs": "tsc --project ./tsconfig.cjs.json",
-        "build:esm": "tsc --project ./tsconfig.esm.json && node scripts/rename-to-esm-files.js dist/esm",
-        "test": "vitest",
-        "test:unit": "vitest --project unit",
-        "test:wire": "vitest --project wire",
-        "tsn": "ts-node -r tsconfig-paths/register"
-    },
-    "dependencies": {
-        "fast-json-stable-stringify": "^2.1.0"
-    },
-    "peerDependencies": {
-        "react": "^18 || ^19",
-        "zod": "^4"
-    },
-    "devDependencies": {
-        "webpack": "^5.97.1",
-        "ts-loader": "^9.5.1",
-        "vitest": "^3.2.4",
-        "msw": "2.11.2",
-        "@types/node": "^18.19.70",
-        "typescript": "~5.7.2",
-        "@biomejs/biome": "2.3.1",
-        "@dotenvx/dotenvx": "^1.49.0",
-        "react": "^19.1.1",
-        "react-dom": "^19.1.1",
-        "tsconfig-paths": "^4.2.0",
-        "ts-node": "^10.5.0",
-        "zod": "^4"
-    },
-    "browser": {
-        "fs": false,
-        "os": false,
-        "path": false,
-        "stream": false
-    },
-    "packageManager": "pnpm@10.20.0",
-    "engines": {
-        "node": ">=18.0.0"
-    },
-    "sideEffects": false,
-    "description": "The official TypeScript library for the Browser Use API",
-    "author": {
-        "name": "Browser Use",
-        "url": "https://browser-use.com",
-        "email": "support@browser-use.com"
-    }
-}
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "reference.md",
+    "README.md",
+    "LICENSE"
+  ],
+  "dependencies": {
+    "fast-json-stable-stringify": "^2.1.0"
+  },
+  "peerDependencies": {
+    "react": "^18 || ^19",
+    "zod": "^4"
+  },
+  "devDependencies": {
+    "webpack": "^5.97.1",
+    "ts-loader": "^9.5.1",
+    "vitest": "^3.2.4",
+    "msw": "2.11.2",
+    "@types/node": "^18.19.70",
+    "typescript": "~5.7.2",
+    "@biomejs/biome": "2.3.1",
+    "@dotenvx/dotenvx": "^1.49.0",
+    "react": "^19.1.1",
+    "react-dom": "^19.1.1",
+    "tsconfig-paths": "^4.2.0",
+    "ts-node": "^10.5.0",
+    "zod": "^4"
+  },
+  "browser": {
+    "fs": false,
+    "os": false,
+    "path": false,
+    "stream": false
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "sideEffects": false,
+  "description": "The official TypeScript library for the Browser Use API",
+  "author": {
+    "name": "Browser Use",
+    "url": "https://browser-use.com",
+    "email": "support@browser-use.com"
+  },
+  "scripts": {
+    "format": "biome format --write --skip-parse-errors --no-errors-on-unmatched --max-diagnostics=none",
+    "format:check": "biome format --skip-parse-errors --no-errors-on-unmatched --max-diagnostics=none",
+    "lint": "biome lint --skip-parse-errors --no-errors-on-unmatched --max-diagnostics=none",
+    "lint:fix": "biome lint --fix --unsafe --skip-parse-errors --no-errors-on-unmatched --max-diagnostics=none",
+    "check": "biome check --skip-parse-errors --no-errors-on-unmatched --max-diagnostics=none",
+    "check:fix": "biome check --fix --unsafe --skip-parse-errors --no-errors-on-unmatched --max-diagnostics=none",
+    "build": "pnpm build:cjs && pnpm build:esm",
+    "build:cjs": "tsc --project ./tsconfig.cjs.json",
+    "build:esm": "tsc --project ./tsconfig.esm.json && node scripts/rename-to-esm-files.js dist/esm",
+    "test": "vitest",
+    "test:unit": "vitest --project unit",
+    "test:wire": "vitest --project wire",
+    "tsn": "ts-node -r tsconfig-paths/register"
+  }
+}

package/reference.md

@@ -570,6 +570,71 @@ await client.sessions.getSession({
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">deleteSession</a>({ ...params }) -> void</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Delete a session with all its tasks.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.sessions.deleteSession({
+    session_id: "session_id"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `BrowserUse.DeleteSessionSessionsSessionIdDeleteRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Sessions.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -1960,6 +2025,75 @@ await client.workflows.updateWorkflow({
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.workflows.<a href="/src/api/resources/workflows/client/Client.ts">getWorkflowGenerationState</a>({ ...params }) -> BrowserUse.WorkflowGenerationStateView</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Get workflow generation state with live browser URL for polling.
+
+This endpoint returns the current state of workflow generation including
+the live browser URL (if available). It's designed to be polled every 2 seconds
+during generation to show real-time browser activity in the frontend.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.workflows.getWorkflowGenerationState({
+    workflow_id: "workflow_id"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `BrowserUse.GetWorkflowGenerationStateWorkflowsWorkflowIdGenerationStateGetRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Workflows.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -2033,7 +2167,7 @@ await client.workflows.getWorkflowYamlPresignedUrl({
 </dl>
 </details>
 
-<details><summary><code>client.workflows.<a href="/src/api/resources/workflows/client/Client.ts">executeWorkflow</a>({ ...params }) -> BrowserUse.ExecuteWorkflowWorkflowsWorkflowIdExecutePostResponse</code></summary>
+<details><summary><code>client.workflows.<a href="/src/api/resources/workflows/client/Client.ts">runWorkflow</a>({ ...params }) -> BrowserUse.WorkflowExecutionCreatedResponse</code></summary>
 <dl>
 <dd>
 
@@ -2045,10 +2179,10 @@ await client.workflows.getWorkflowYamlPresignedUrl({
 <dl>
 <dd>
 
-Execute a workflow either synchronously or asynchronously.
+Execute a workflow asynchronously.
 
-- ASYNC mode: Returns execution ID immediately and processes in background via Lambda
-- SYNC mode: Waits for execution to complete and returns results inline (max 5 min timeout)
+Returns execution ID immediately and processes in background via Inngest.
+Use the GET /workflows/executions/{execution_id} endpoint to check status and retrieve results.
 </dd>
 </dl>
 </dd>
@@ -2063,7 +2197,7 @@ Execute a workflow either synchronously or asynchronously.
 <dd>
 
 ```typescript
-await client.workflows.executeWorkflow({
+await client.workflows.runWorkflow({
     workflow_id: "workflow_id"
 });
 
@@ -2494,6 +2628,144 @@ await client.workflows.getExecutionLogs({
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.workflows.<a href="/src/api/resources/workflows/client/Client.ts">getExecutionState</a>({ ...params }) -> BrowserUse.WorkflowExecutionStateView</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Get workflow execution state with steps for live UI polling.
+
+This endpoint returns the current state of a workflow execution including all steps
+with their details. It's designed to be polled every 2 seconds during execution
+to show real-time progress in the frontend.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.workflows.getExecutionState({
+    execution_id: "execution_id"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `BrowserUse.GetExecutionStateWorkflowsExecutionsExecutionIdStateGetRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Workflows.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.workflows.<a href="/src/api/resources/workflows/client/Client.ts">getExecutionMedia</a>({ ...params }) -> BrowserUse.WorkflowExecutionMediaView</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Get workflow execution media (screenshots) with presigned URLs.
+
+This endpoint returns media URLs for completed executions. Screenshots
+are returned with presigned S3 URLs for direct access from the frontend.
+Should be called when execution status is 'completed', 'failed', or 'cancelled'.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.workflows.getExecutionMedia({
+    execution_id: "execution_id"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `BrowserUse.GetExecutionMediaWorkflowsExecutionsExecutionIdMediaGetRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Workflows.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>