@ironflow/browser 0.26.0 → 0.27.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +10 -10
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -119,7 +119,7 @@ Register a global handler that fires for all subscription errors:
119
119
 
120
120
  ```typescript
121
121
  const unsubscribe = ironflow.onError((error) => {
122
- // error: { message: string; code: string; retryable?: boolean }
122
+ // error: { subscriptionId?: string; code: string; message: string; retrying?: boolean }
123
123
  console.error('Ironflow error:', error.message, error.code);
124
124
  });
125
125
  ```
@@ -204,7 +204,7 @@ sub.unsubscribe();
204
204
 
205
205
  ### Pattern Helpers
206
206
 
207
- Use the `patterns` utility to build subscription patterns. Available as a static property on the client class and as a direct import:
207
+ Use the `patterns` utility to build subscription patterns. Import it directly:
208
208
 
209
209
  ```typescript
210
210
  import { ironflow, patterns } from '@ironflow/browser';
@@ -273,9 +273,9 @@ const sub = await ironflow.joinConsumerGroup(
273
273
  );
274
274
 
275
275
  // Returns AckableSubscription
276
- sub.ack(eventId); // Acknowledge successful processing
277
- sub.nak(eventId, 5000); // Negative ack with optional redelivery delay (ms)
278
- sub.term(eventId); // Terminate - do not redeliver
276
+ await sub.ack(eventId); // Acknowledge successful processing
277
+ await sub.nak(eventId, 5000); // Negative ack with optional redelivery delay (ms)
278
+ await sub.term(eventId); // Terminate - do not redeliver
279
279
 
280
280
  sub.unsubscribe();
281
281
  ```
@@ -291,7 +291,7 @@ const sub = await ironflow.subscribe('events:order.created', {
291
291
 
292
292
  // sub is AckableSubscription when ackMode is 'manual'
293
293
  const ackableSub = sub as AckableSubscription;
294
- ackableSub.ack(eventId);
294
+ await ackableSub.ack(eventId);
295
295
  ```
296
296
 
297
297
  ## Emitting Events
@@ -481,7 +481,7 @@ Errors:
481
481
  | `RunFailedError` | `system.run.{runId}.failed` |
482
482
  | `RunCancelledError` | `system.run.{runId}.cancelled` |
483
483
 
484
- ### `agents.subscribe(runId, callbacks)`
484
+ ### `agents.subscribe(runId, callbacks, opts?)`
485
485
 
486
486
  Typed wrapper over the broader `subscribe(pattern)` API. Dispatches by topic.
487
487
 
@@ -1302,13 +1302,13 @@ The package re-exports the following types from `@ironflow/core` for convenience
1302
1302
 
1303
1303
  **KV types:** `KVBucketConfig`, `KVBucketInfo`, `KVEntry`, `KVPutResult`, `KVListKeysResult`, `KVListBucketsResult`, `KVWatchEvent`, `KVWatchCallbacks`, `KVWatchOptions`, `KVWatcher`
1304
1304
 
1305
- **Config types:** `ConfigResponse`, `ConfigEntry`, `ConfigSetResult`, `ConfigWatchCallbacks`
1305
+ **Config types:** `ConfigResponse`, `ConfigEntry`, `ConfigSetResult`, `ConfigWatchCallbacks`, `ConfigWatchEvent`
1306
1306
 
1307
1307
  **Browser-specific types:** `IronflowConfig`, `IronflowConfigOptions`, `ReconnectConfig`, `VisibilityConfig`, `AuthConfig`, `BrowserSubscribeOptions`, `SubscriptionGroup`, `Transport`, `TransportCallbacks`, `TransportFactory`, `TransportOptions`
1308
1308
 
1309
- **Utilities:** `patterns`, `DEFAULT_SERVER_URL`, `DEFAULT_WS_URL`, `DEFAULT_TIMEOUTS`, `getServerUrl`, `getWebSocketUrl`
1309
+ **Utilities:** `patterns`, `DEFAULT_SERVER_URL`, `DEFAULT_WS_URL`, `DEFAULT_TIMEOUTS`, `getServerUrl`, `getWebSocketUrl`, `DEFAULT_CONFIG`, `mergeConfig`
1310
1310
 
1311
- **Classes:** `BrowserKVClient`, `BrowserKVBucketHandle`, `BrowserConfigClient`
1311
+ **Classes:** `BrowserKVClient`, `BrowserKVBucketHandle`, `BrowserConfigClient`, `SubscriptionManager`
1312
1312
 
1313
1313
  ## Links
1314
1314
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ironflow/browser",
3
- "version": "0.26.0",
3
+ "version": "0.27.0",
4
4
  "description": "Browser client for Ironflow event-driven backend platform - real-time subscriptions, workflow triggers, and event emission",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",
@@ -22,7 +22,7 @@
22
22
  "@connectrpc/connect": "^2.1.2",
23
23
  "@connectrpc/connect-web": "^2.1.2",
24
24
  "zod": "^4.4.3",
25
- "@ironflow/core": "^0.26.0"
25
+ "@ironflow/core": "^0.27.0"
26
26
  },
27
27
  "devDependencies": {
28
28
  "@types/node": "^22.20.1",
@@ -54,7 +54,7 @@
54
54
  "license": "LicenseRef-Ironflow-EULA",
55
55
  "homepage": "https://ironflow.run",
56
56
  "bugs": {
57
- "url": "https://github.com/sahina/ironflow-js/issues"
57
+ "url": "https://github.com/sahina/ironflow-issues/issues"
58
58
  },
59
59
  "repository": {
60
60
  "type": "git",