@muhkoo/connect 0.6.0-alpha.11 → 0.7.0-alpha.4

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
@@ -142,9 +142,10 @@ const client = new Client({
142
142
  const user = await client.auth.zk.login("alice", "correct horse battery staple");
143
143
  // └ { username, commitment }
144
144
 
145
- // Storage — per-user persistent KV (collection + id), encrypted at rest.
146
- await client.storage.set("todos", "t1", { title: "Buy groceries", completed: false });
147
- const todo = await client.storage.get("todos", "t1");
145
+ // KV — per-user persistent key/value (collection + id); client-side encrypted,
146
+ // the server stores only ciphertext.
147
+ await client.kv.set("todos", "t1", { title: "Buy groceries", completed: false });
148
+ const todo = await client.kv.get("todos", "t1");
148
149
  const ids = await client.storage.list("todos");
149
150
  await client.storage.delete("todos", "t1");
150
151
 
@@ -169,9 +170,12 @@ online).
169
170
  message once with a shared group key so the server can persist + replay it.
170
171
  `createChannel(name)` mints + registers a channel (you become its first
171
172
  key-holder); `joinChannel(name)` resolves an existing one and is admitted by the
172
- app's **keeper** — a trusted, always-available member that re-issues the group
173
- key — so a channel is joinable even when no one else is online. The relay stays
174
- blind (it only ever sees opaque, ECIES-wrapped key blobs). The space handle was
173
+ app's **keeper** — a server-side process (the app's Durable Object) that holds
174
+ the channel's group key and re-issues it to newcomers — so a channel is joinable
175
+ even when no human member is online. The message **relay** stays blind (it only
176
+ ever sees opaque, ECIES-wrapped key blobs); the **keeper** does hold group keys,
177
+ so channels are *relay-blind*, not fully server-blind. (Enabling a server-side
178
+ agent on a channel likewise gives that agent the group key.) The space handle was
175
179
  once `Room`; that name is still exported as an alias, and `client.message.room()`
176
180
  returns the same handle.
177
181
 
@@ -459,12 +463,6 @@ yarn lint # eslint ./src
459
463
  (true for all of the above; on CF Workers, pre-compile via wrangler's
460
464
  `.wasm` import if you want to skip startup cost).
461
465
 
462
- ## Related
463
-
464
- - [`muhkoo/accelerator`](https://github.com/muhkoo/accelerator) — the CF
465
- Workers + DOs backend this SDK targets, including the personal-space DO,
466
- message-bus DO, and the bn128.wasm-driven `verifyZkAuthProof`.
467
-
468
466
  ## License
469
467
 
470
- GPL-3.0 — see `LICENSE`.
468
+ MIT — see `LICENSE`.