@rstreamlabs/tunnels 3.2.1 → 3.4.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.
package/README.md CHANGED
@@ -112,7 +112,7 @@ await watch.connect();
112
112
  ```
113
113
 
114
114
  URL-based watch authentication requires a short-lived token with bounded
115
- lifetime and watch-only tunnel list resources.
115
+ lifetime, explicit read-only watch permissions, and list-only tunnel resources.
116
116
 
117
117
  Browser integrations should provide `auth` as a function that calls a backend
118
118
  token route and returns a fresh watch token for each connection attempt. Do not
@@ -236,6 +236,22 @@ export async function receiveWebhook(request: Request) {
236
236
  }
237
237
  ```
238
238
 
239
+ ## Project Log Events
240
+
241
+ Use `streamSummarySchema` for connection log entries returned by the Engine API.
242
+ The `request.entry.kind` field distinguishes published access from private
243
+ rstream dials; `formatStreamAccessPath` returns the dashboard-safe label for
244
+ that value.
245
+
246
+ ```ts
247
+ import { formatStreamAccessPath } from "@rstreamlabs/tunnels";
248
+ import { streamSummarySchema } from "@rstreamlabs/tunnels";
249
+
250
+ const summary = streamSummarySchema.parse(payload);
251
+
252
+ console.log(formatStreamAccessPath(summary.request.entry));
253
+ ```
254
+
239
255
  For local receiver tests, the SDK exposes the same signing primitives used by
240
256
  the CLI and Engine dispatcher:
241
257