@laboverwire/stitch-wasm 0.2.0 → 0.2.2

package/README.md

@@ -38,6 +38,21 @@ await store.replaceScope("p1");
 `remote.url` is a `ws://`/`wss://` MQTT endpoint; `remote.ticket` is a JWT used
 for MQTT v5 enhanced-auth.
 
+### Config fields
+
+Only `entities` and `scope` are required. The rest are optional overrides; an
+omitted field keeps its default:
+
+| Field | Default | Purpose |
+| --- | --- | --- |
+| `syncTopicPrefix` | `"$DB"` | Root of the sync topic namespace. |
+| `responseTopicPrefix` | `"$DB/clients"` | Root of the per-request RPC response inbox (`{prefix}/{clientId}/{requestId}`). Override it when the default would collide with a namespace the broker reserves — e.g. set `"_rpc/responses"` for an MQDB broker, which owns `$DB`. |
+| `versionField` | `"version"` | Record field holding the LWW version. |
+| `updatedAtField` | `"updatedAt"` | Record field holding the update timestamp. |
+| `userScopeField` | _unset_ | Record field that scopes offline writes to the authenticated user. |
+| `topLevelEntities` | `[]` | Entities synced outside any scope, each `{ entity, subscriptionPattern }`. |
+| `localOnlyEntities` | `{}` | Entities persisted locally but never synced, same shape as `entities`. |
+
 ## API surface
 
 The `Store` mirrors the TS core:

package/package.json

@@ -5,7 +5,7 @@
     "LabOverWire"
   ],
   "description": "Browser (wasm-bindgen) bindings for the stitch reactive state-sync store.",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
@@ -31,4 +31,4 @@
     "reactive",
     "store"
   ]
-}
+}

package/stitch_wasm.d.ts

@@ -746,6 +746,13 @@ export class WillMessage {
  * Build an unopened [`Store`] from a config object
  * (`{ entities, scope: { rootEntity, childEntities, scopeField } }`).
  *
+ * The config also accepts optional overrides that otherwise fall back to their
+ * defaults: `syncTopicPrefix` (`"$DB"`), `responseTopicPrefix` (`"$DB/clients"`),
+ * `versionField` (`"version"`), `updatedAtField` (`"updatedAt"`),
+ * `userScopeField` (unset), `topLevelEntities`
+ * (`[{ entity, subscriptionPattern }]`), and `localOnlyEntities` (same shape as
+ * `entities`).
+ *
  * Pass an optional second argument to enable durable IndexedDB persistence
  * and/or remote MQTT-over-WebSocket sync:
  * `{ persistence: { dbName, passphrase? }, remote: { url, clientId?, ticket?, username?, password? } }`.

package/stitch_wasm_bg.js

@@ -2494,6 +2494,13 @@ if (Symbol.dispose) WillMessage.prototype[Symbol.dispose] = WillMessage.prototyp
  * Build an unopened [`Store`] from a config object
  * (`{ entities, scope: { rootEntity, childEntities, scopeField } }`).
  *
+ * The config also accepts optional overrides that otherwise fall back to their
+ * defaults: `syncTopicPrefix` (`"$DB"`), `responseTopicPrefix` (`"$DB/clients"`),
+ * `versionField` (`"version"`), `updatedAtField` (`"updatedAt"`),
+ * `userScopeField` (unset), `topLevelEntities`
+ * (`[{ entity, subscriptionPattern }]`), and `localOnlyEntities` (same shape as
+ * `entities`).
+ *
  * Pass an optional second argument to enable durable IndexedDB persistence
  * and/or remote MQTT-over-WebSocket sync:
  * `{ persistence: { dbName, passphrase? }, remote: { url, clientId?, ticket?, username?, password? } }`.
@@ -3117,47 +3124,47 @@ export function __wbg_warn_b1370d804fa3e259(arg0) {
     console.warn(arg0);
 }
 export function __wbindgen_cast_0000000000000001(arg0, arg1) {
-    // Cast intrinsic for `Closure(Closure { owned: true, function: Function { arguments: [Externref], shim_idx: 1019, ret: Result(Unit), inner_ret: Some(Result(Unit)) }, mutable: true }) -> Externref`.
+    // Cast intrinsic for `Closure(Closure { owned: true, function: Function { arguments: [Externref], shim_idx: 1021, ret: Result(Unit), inner_ret: Some(Result(Unit)) }, mutable: true }) -> Externref`.
     const ret = makeMutClosure(arg0, arg1, wasm_bindgen_731b86b8850671e1___convert__closures_____invoke___wasm_bindgen_731b86b8850671e1___JsValue__core_7d5f0a2ba6a62c33___result__Result_____wasm_bindgen_731b86b8850671e1___JsError___true_);
     return ret;
 }
 export function __wbindgen_cast_0000000000000002(arg0, arg1) {
-    // Cast intrinsic for `Closure(Closure { owned: true, function: Function { arguments: [Externref], shim_idx: 537, ret: Unit, inner_ret: Some(Unit) }, mutable: true }) -> Externref`.
+    // Cast intrinsic for `Closure(Closure { owned: true, function: Function { arguments: [Externref], shim_idx: 539, ret: Unit, inner_ret: Some(Unit) }, mutable: true }) -> Externref`.
     const ret = makeMutClosure(arg0, arg1, wasm_bindgen_731b86b8850671e1___convert__closures_____invoke___wasm_bindgen_731b86b8850671e1___JsValue______true_);
     return ret;
 }
 export function __wbindgen_cast_0000000000000003(arg0, arg1) {
-    // Cast intrinsic for `Closure(Closure { owned: true, function: Function { arguments: [NamedExternref("CloseEvent")], shim_idx: 537, ret: Unit, inner_ret: Some(Unit) }, mutable: true }) -> Externref`.
+    // Cast intrinsic for `Closure(Closure { owned: true, function: Function { arguments: [NamedExternref("CloseEvent")], shim_idx: 539, ret: Unit, inner_ret: Some(Unit) }, mutable: true }) -> Externref`.
     const ret = makeMutClosure(arg0, arg1, wasm_bindgen_731b86b8850671e1___convert__closures_____invoke___wasm_bindgen_731b86b8850671e1___JsValue______true__2);
     return ret;
 }
 export function __wbindgen_cast_0000000000000004(arg0, arg1) {
-    // Cast intrinsic for `Closure(Closure { owned: true, function: Function { arguments: [NamedExternref("ErrorEvent")], shim_idx: 537, ret: Unit, inner_ret: Some(Unit) }, mutable: true }) -> Externref`.
+    // Cast intrinsic for `Closure(Closure { owned: true, function: Function { arguments: [NamedExternref("ErrorEvent")], shim_idx: 539, ret: Unit, inner_ret: Some(Unit) }, mutable: true }) -> Externref`.
     const ret = makeMutClosure(arg0, arg1, wasm_bindgen_731b86b8850671e1___convert__closures_____invoke___wasm_bindgen_731b86b8850671e1___JsValue______true__3);
     return ret;
 }
 export function __wbindgen_cast_0000000000000005(arg0, arg1) {
-    // Cast intrinsic for `Closure(Closure { owned: true, function: Function { arguments: [NamedExternref("Event")], shim_idx: 994, ret: Unit, inner_ret: Some(Unit) }, mutable: true }) -> Externref`.
+    // Cast intrinsic for `Closure(Closure { owned: true, function: Function { arguments: [NamedExternref("Event")], shim_idx: 996, ret: Unit, inner_ret: Some(Unit) }, mutable: true }) -> Externref`.
     const ret = makeMutClosure(arg0, arg1, wasm_bindgen_731b86b8850671e1___convert__closures_____invoke___web_sys_946f3154f354a90d___features__gen_IdbVersionChangeEvent__IdbVersionChangeEvent______true_);
     return ret;
 }
 export function __wbindgen_cast_0000000000000006(arg0, arg1) {
-    // Cast intrinsic for `Closure(Closure { owned: true, function: Function { arguments: [NamedExternref("IDBVersionChangeEvent")], shim_idx: 994, ret: Unit, inner_ret: Some(Unit) }, mutable: true }) -> Externref`.
+    // Cast intrinsic for `Closure(Closure { owned: true, function: Function { arguments: [NamedExternref("IDBVersionChangeEvent")], shim_idx: 996, ret: Unit, inner_ret: Some(Unit) }, mutable: true }) -> Externref`.
     const ret = makeMutClosure(arg0, arg1, wasm_bindgen_731b86b8850671e1___convert__closures_____invoke___web_sys_946f3154f354a90d___features__gen_IdbVersionChangeEvent__IdbVersionChangeEvent______true__5);
     return ret;
 }
 export function __wbindgen_cast_0000000000000007(arg0, arg1) {
-    // Cast intrinsic for `Closure(Closure { owned: true, function: Function { arguments: [NamedExternref("MessageEvent")], shim_idx: 537, ret: Unit, inner_ret: Some(Unit) }, mutable: true }) -> Externref`.
+    // Cast intrinsic for `Closure(Closure { owned: true, function: Function { arguments: [NamedExternref("MessageEvent")], shim_idx: 539, ret: Unit, inner_ret: Some(Unit) }, mutable: true }) -> Externref`.
     const ret = makeMutClosure(arg0, arg1, wasm_bindgen_731b86b8850671e1___convert__closures_____invoke___wasm_bindgen_731b86b8850671e1___JsValue______true__6);
     return ret;
 }
 export function __wbindgen_cast_0000000000000008(arg0, arg1) {
-    // Cast intrinsic for `Closure(Closure { owned: true, function: Function { arguments: [], shim_idx: 528, ret: Unit, inner_ret: Some(Unit) }, mutable: true }) -> Externref`.
+    // Cast intrinsic for `Closure(Closure { owned: true, function: Function { arguments: [], shim_idx: 530, ret: Unit, inner_ret: Some(Unit) }, mutable: true }) -> Externref`.
     const ret = makeMutClosure(arg0, arg1, wasm_bindgen_731b86b8850671e1___convert__closures_____invoke_______true_);
     return ret;
 }
 export function __wbindgen_cast_0000000000000009(arg0, arg1) {
-    // Cast intrinsic for `Closure(Closure { owned: true, function: Function { arguments: [], shim_idx: 542, ret: Unit, inner_ret: Some(Unit) }, mutable: true }) -> Externref`.
+    // Cast intrinsic for `Closure(Closure { owned: true, function: Function { arguments: [], shim_idx: 544, ret: Unit, inner_ret: Some(Unit) }, mutable: true }) -> Externref`.
     const ret = makeMutClosure(arg0, arg1, wasm_bindgen_731b86b8850671e1___convert__closures_____invoke_______true__1_);
     return ret;
 }