@api.global/typedsocket 5.1.2 → 6.0.0

package/readme.hints.md

@@ -1,21 +1,37 @@
 # TypedSocket Hints
 
-## SmartServe Integration (Added v3.1.0)
+## TypedSocket 6 Integration
 
-TypedSocket now supports SmartServe as an alternative WebSocket backend via `TypedSocket.fromSmartServe()`.
+TypedSocket 6 requires SmartServe 4.2.1 and TypedRequest 5.2.1. Compose the
+TypedSocket server before constructing SmartServe so `webSocketTransportOwner`
+is selected for the physical peer at upgrade time.
 
-### Key Differences from Smartsocket Mode
+### Authority Rules
 
-1. **Tag System**: SmartServe uses `Set<string>` for tags, while Smartsocket uses `{id, payload}`. The wrapper stores payloads in `peer.data` with `__typedsocket_tag__` prefix.
+1. **Peer identity**: Incoming server handlers call
+   `getServerConnectionForRequest(typedTools)` to obtain the exact typed transport
+   connection without assertions. Tag validators receive opaque `connectionId`
+   and `routingSurfaceId` identities instead of mutable peer/router objects.
 
-2. **Request/Response**: Uses TypedRouter's `fireEventInterestMap` for async correlation when sending server-initiated requests.
+2. **Tags**: Client tags are default-deny exact rules. Authentication, roles,
+   registration, and reserved names are assigned only with `setServerTag()`.
 
-3. **Lifecycle**: SmartServe manages WebSocket lifecycle. `typedSocket.stop()` only clears internal state.
+3. **Bytes**: Generic legacy VirtualStreams are always denied. Exact native-byte
+   facades require fixed manifests, principal/revision authority, and durable
+   confirmation.
 
-4. **eventSubject**: Not fully supported in SmartServe mode - use SmartServe's `onConnectionOpen`/`onConnectionClose` hooks instead.
+4. **Lifecycle**: Client text work, native frames, callbacks, pending requests,
+   tag mutations, and server request interests have fixed resource ceilings and
+   generation fencing. SmartServe settlements authorize only the exact frame
+   object returned by `pullBinaryFrame()`.
 
-### Files Modified for SmartServe Support
+5. **Restoration**: `restoreConnection(context)` runs after capability
+   negotiation and before desired tags or `connected`. Use
+   `context.createTypedRequest()` for authenticated restoration RPCs; it inherits
+   the restoration deadline and abort signal and becomes invalid afterward.
 
-- `ts/typedsocket.classes.typedsocket.ts` - Main implementation
-- `ts/typedsocket.plugins.ts` - Type imports
-- `package.json` - Optional peer dependency
+### Release Artifact
+
+Only compiled `dist_ts` JavaScript/declarations, package metadata, documentation,
+and the license are published. `pnpm run verify:package` performs the deterministic
+two-pack entry, hash, metadata, and smoke-import gate.