@streamotter/client 0.1.0-rc.2 → 0.1.0-rc.3
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 +6 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
<p align="center"><img src="https://raw.githubusercontent.com/jfricano/StreamOtter/main/docs/assets/streamotter-logo.png" alt="StreamOtter" width="300"></p>
|
|
2
|
+
|
|
1
3
|
# @streamotter/client
|
|
2
4
|
|
|
3
5
|
The StreamOtter browser SDK. Subscribe to a **state channel** served by a [StreamOtter gateway](https://www.npmjs.com/package/@streamotter/gateway): each subscription gets an authoritative snapshot, then full-state updates in revision order. It also reports whether the view is verifiably current (`live`) or not (`stale`), so a screen is never silently wrong.
|
|
@@ -8,6 +10,8 @@ The StreamOtter browser SDK. Subscribe to a **state channel** served by a [Strea
|
|
|
8
10
|
npm install @streamotter/client
|
|
9
11
|
```
|
|
10
12
|
|
|
13
|
+
Using the all-in-one [`streamotter`](https://www.npmjs.com/package/streamotter) package instead? Import from `streamotter/client`; everything on this page applies unchanged.
|
|
14
|
+
|
|
11
15
|
Transport: Socket.IO 4.8.3 over WebSocket only. Targets current evergreen browsers. ESM only, with TypeScript declarations included.
|
|
12
16
|
|
|
13
17
|
## Subscribe
|
|
@@ -125,12 +129,13 @@ Pass a stable `getToken` (for example from `useCallback`) so the client is not r
|
|
|
125
129
|
|
|
126
130
|
| Package | |
|
|
127
131
|
| --- | --- |
|
|
132
|
+
| [`streamotter`](https://www.npmjs.com/package/streamotter) | Everything below in one install, with the `streamotter` command |
|
|
128
133
|
| [`@streamotter/cli`](https://www.npmjs.com/package/@streamotter/cli) | Scaffold, validate, generate types, develop with the workbench, and run the production gateway |
|
|
129
134
|
| [`@streamotter/client`](https://www.npmjs.com/package/@streamotter/client) | **This package.** The browser SDK: subscribe, render `live` and `stale`, and clean up |
|
|
130
135
|
| [`@streamotter/gateway`](https://www.npmjs.com/package/@streamotter/gateway) | Handler types, and running the gateway from your own Node.js code |
|
|
131
136
|
| [`@streamotter/contracts`](https://www.npmjs.com/package/@streamotter/contracts) | Shared types and configuration validation, for tooling authors |
|
|
132
137
|
| [`@streamotter/workbench`](https://www.npmjs.com/package/@streamotter/workbench) | The local workbench's assets, installed by the CLI |
|
|
133
138
|
|
|
134
|
-
All
|
|
139
|
+
All six are released together with the same version ([changelog](https://github.com/jfricano/StreamOtter/blob/main/CHANGELOG.md)).
|
|
135
140
|
|
|
136
141
|
MIT License © 2026 Orca Solutions
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@streamotter/client",
|
|
3
|
-
"version": "0.1.0-rc.
|
|
3
|
+
"version": "0.1.0-rc.3",
|
|
4
4
|
"description": "StreamOtter browser SDK: subscribe to state channels with authoritative snapshots, revision-ordered updates, and explicit live/stale states over Socket.IO.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"streamotter",
|
|
@@ -43,6 +43,6 @@
|
|
|
43
43
|
},
|
|
44
44
|
"dependencies": {
|
|
45
45
|
"socket.io-client": "4.8.3",
|
|
46
|
-
"@streamotter/contracts": "0.1.0-rc.
|
|
46
|
+
"@streamotter/contracts": "0.1.0-rc.3"
|
|
47
47
|
}
|
|
48
48
|
}
|