datahike 0.8.1864 → 0.8.1866

package/README.md

@@ -89,6 +89,85 @@ initial level (for example, `DATAHIKE_LOG_LEVEL=off node app.js`).
 
 ## Documentation
 
+### Replicated browser client (Kabel + IndexedDB)
+
+Use the opt-in `datahike/kabel` entry when the browser should keep a local
+queryable replica and send writes to a Datahike server over Kabel. The store ID
+must identify the same database on the client and server.
+
+```typescript
+import * as d from 'datahike/kabel';
+
+const storeId = d.uuid('550e8400-e29b-41d4-a716-446655440000');
+const serverId = d.uuid('aaaaaaaa-0000-0000-0000-000000000001');
+const peer = d.createKabelPeer(d.randomUuid(), { token: accessToken });
+
+await d.connectKabelPeer(peer, 'wss://data.example.com');
+
+const conn = await d.connect({
+  store: {
+    backend: ':tiered',
+    id: storeId,
+    'frontend-config': { backend: ':memory', id: storeId },
+    'backend-config': {
+      backend: ':indexeddb',
+      id: storeId,
+      name: 'my-app'
+    },
+    'write-policy': ':write-through'
+  },
+  writer: {
+    backend: ':kabel',
+    'peer-id': serverId,
+    'local-peer': peer
+  }
+}, { 'sync?': false });
+```
+
+The matching standalone-server configuration is:
+
+```clojure
+{:kabel {:host "127.0.0.1"
+         :port 47296
+         :peer-id #uuid "aaaaaaaa-0000-0000-0000-000000000001"
+         :jwt {:alg :HS256
+               :secret "application-jwt-secret"
+               :required-claims {:iss "my-app" :aud "datahike"}}
+         :store {:backend :file :path "/var/lib/datahike/browser-databases"}}}
+```
+
+The application issues the JWT. Datahike validates it but does not provide a
+user database or login flow. What an authenticated subject may do is decided
+by the same permissions the HTTP routes enforce (the server's `:system-db`
+relationships): a transaction is a `:transact` on its database, a store
+subscription a `:read`, database creation and deletion their own operations.
+A server without a permissions database admits every authenticated subject.
+
+`token` may be a function returning the current token, or a promise of one;
+it is read at every connection and again to refresh the token before it
+expires. `maintainKabelPeer` keeps the peer connected across drops and reports
+`connecting`, `connected`, `authenticated`, `disconnected`, `failed` and
+`stopped` to `onStatus`. `invokeRemote` calls a function the server serves,
+`registerRemoteFn` serves one from the page.
+
+Who may read, write, create or delete a database is decided by the server's
+permissions, managed over its HTTP API. The whole setup, server container to
+first query, permissions and your own server functions, is in
+[Browser replicas](https://github.com/replikativ/datahike/blob/main/doc/browser-replicas.md),
+including what is not there yet: no durable offline write queue, no multi-tab
+coordination, and a store subscription has to be remade after a reconnection.
+
+This follows the ClojureScript API directly: asynchronous browser and remote
+stores use `{ 'sync?': false }`; an in-memory database can continue to use
+`{ 'sync?': true }`. Applications can put a domain API in front of Datahike
+instead when they do not need database queries in the browser.
+
+Writes issued while disconnected wait for the connection in memory and are
+lost on a page reload; there is no durable offline write queue yet, and tabs
+do not coordinate.
+Restoring a connection across a page reload and coordinating one replica among
+multiple tabs or Web Workers are not yet part of the supported lifecycle.
+
 ### S3-compatible storage in browsers
 
 Import the opt-in build when a browser should persist Datahike directly to

package/boring.data.js

@@ -3,6 +3,6 @@ var window=global;var $CLJS=require("./cljs_env.js");require("./cljs.core.js");
 $CLJS.FB=new $CLJS.H("boring","max-depth-exceeded","boring/max-depth-exceeded",1648120233);$CLJS.GB=new $CLJS.H(null,"numerator","numerator",-160761104);$CLJS.HB=new $CLJS.H(null,"max-depth","max-depth",127060793);$CLJS.IB=new $CLJS.H(null,"max-items","max-items",-1969244147);$CLJS.JB=new $CLJS.H(null,"fallback","fallback",761637929);$CLJS.KB=new $CLJS.H(null,"denominator","denominator",-804365096);$CLJS.LB=new $CLJS.H("boring","handler-failed","boring/handler-failed",1798888153);
 $CLJS.MB=new $CLJS.H(null,"n","n",562130025);$CLJS.m=$CLJS.AB.prototype;$CLJS.m.aa=function(a,b){return this.G(null,b,null)};$CLJS.m.G=function(a,b,c){switch(b instanceof $CLJS.H?b.D:null){case "n":return this.n;default:return $CLJS.of(this.j,b,c)}};$CLJS.m.ja=function(a,b,c){return $CLJS.ec(function(d,e){var f=$CLJS.B(e,0,null);e=$CLJS.B(e,1,null);return b.i?b.i(d,f,e):b.call(null,d,f,e)},c,this)};
 $CLJS.m.P=function(a,b,c){return $CLJS.Qk(b,function(d){return $CLJS.Qk(b,$CLJS.Tk,""," ","",c,d)},"#boring.data.SimpleValue{",", ","}",c,$CLJS.ei.h(new $CLJS.N(null,1,5,$CLJS.O,[new $CLJS.N(null,2,5,$CLJS.O,[$CLJS.MB,this.n],null)],null),this.j))};$CLJS.m.fa=function(){return new $CLJS.fj(this,1,new $CLJS.N(null,1,5,$CLJS.O,[$CLJS.MB],null),$CLJS.u(this.j)?$CLJS.Nd(this.j):$CLJS.jh())};$CLJS.m.O=function(){return this.u};$CLJS.m.X=function(){return 1+$CLJS.Ve(this.j)};
-$CLJS.m.Z=function(){var a=this.A;return a!=null?a:this.A=a=1404098260^$CLJS.ye(this)};$CLJS.m.U=function(a,b){return b!=null&&this.constructor===b.constructor&&$CLJS.A.h(this.n,b.n)&&$CLJS.A.h(this.j,b.j)};$CLJS.m.ia=function(a,b){return $CLJS.Vf(new $CLJS.uk(null,new $CLJS.S(null,1,[$CLJS.MB,null],null),null),b)?$CLJS.No.h($CLJS.Wc($CLJS.mj.h($CLJS.bh,this),this.u),b):new $CLJS.AB(this.n,this.u,$CLJS.hh($CLJS.No.h(this.j,b)),null)};
+$CLJS.m.Z=function(){var a=this.A;return a!=null?a:this.A=a=1404098260^$CLJS.ye(this)};$CLJS.m.U=function(a,b){return b!=null&&this.constructor===b.constructor&&$CLJS.A.h(this.n,b.n)&&$CLJS.A.h(this.j,b.j)};$CLJS.m.ia=function(a,b){return $CLJS.Vf(new $CLJS.uk(null,new $CLJS.S(null,1,[$CLJS.MB,null],null),null),b)?$CLJS.To.h($CLJS.Wc($CLJS.mj.h($CLJS.bh,this),this.u),b):new $CLJS.AB(this.n,this.u,$CLJS.hh($CLJS.To.h(this.j,b)),null)};
 $CLJS.m.ea=function(a,b){switch(b instanceof $CLJS.H?b.D:null){case "n":return!0;default:return $CLJS.Vf(this.j,b)}};$CLJS.m.K=function(a,b,c){return $CLJS.u($CLJS.M.h?$CLJS.M.h($CLJS.MB,b):$CLJS.M.call(null,$CLJS.MB,b))?new $CLJS.AB(c,this.u,this.j,null):new $CLJS.AB(this.n,this.u,$CLJS.ek.i(this.j,b,c),null)};$CLJS.m.V=function(){return $CLJS.y($CLJS.ei.h(new $CLJS.N(null,1,5,$CLJS.O,[new $CLJS.ij($CLJS.MB,this.n,null)],null),this.j))};
 $CLJS.m.S=function(a,b){return new $CLJS.AB(this.n,b,this.j,this.A)};$CLJS.m.ba=function(a,b){return $CLJS.Lf(b)?this.K(null,$CLJS.lf(b,0),$CLJS.lf(b,1)):$CLJS.ec($CLJS.mc,this,b)};$CLJS.NB=new $CLJS.AB(23,null,null,null);

package/boring.options.js

@@ -9,10 +9,10 @@ Hla=new $CLJS.H(null,"chunk-size","chunk-size",-205934374);$CLJS.pC=new $CLJS.H(
 null);
 $CLJS.sC=new $CLJS.S(null,5,[$CLJS.hC,new $CLJS.uk(null,new $CLJS.S(null,2,[$CLJS.jC,null,$CLJS.qC,null],null),null),sla,new $CLJS.uk(null,new $CLJS.S(null,4,[$CLJS.cC,null,$CLJS.jC,null,$CLJS.qC,null,$CLJS.dC,null],null),null),xla,new $CLJS.uk(null,new $CLJS.S(null,5,[$CLJS.cC,null,$CLJS.iC,null,$CLJS.jC,null,$CLJS.qC,null,$CLJS.dC,null],null),null),$CLJS.qC,new $CLJS.uk(null,new $CLJS.S(null,5,[$CLJS.cC,null,$CLJS.iC,null,$CLJS.jC,null,$CLJS.qC,null,$CLJS.dC,null],null),null),Cla,new $CLJS.uk(null,new $CLJS.S(null,
 5,[$CLJS.cC,null,$CLJS.iC,null,$CLJS.jC,null,$CLJS.qC,null,$CLJS.dC,null],null),null)],null);$CLJS.Mla=new $CLJS.S(null,1,[$CLJS.vla,!0],null);$CLJS.Nla=$CLJS.wf($CLJS.hC.g($CLJS.rC),$CLJS.Mla);
-$CLJS.tC=$CLJS.Wj([zla,$CLJS.Ila,$CLJS.cC,$CLJS.lC,$CLJS.tla,$CLJS.ln,$CLJS.mla,$CLJS.ula,$CLJS.Pn,$CLJS.IB,$CLJS.iC,$CLJS.jC,$CLJS.qla,$CLJS.kla,$CLJS.qC,Lla,$CLJS.HB,Hla,$CLJS.lla,$CLJS.Kla,$CLJS.Gla,$CLJS.kC,$CLJS.dC],[new $CLJS.S(null,2,[$CLJS.Mm,new $CLJS.uk(null,new $CLJS.S(null,2,[nla,null,Fla,null],null),null),$CLJS.oC,":local-date or :sql-date"],null),new $CLJS.S(null,2,[$CLJS.Mm,function(a){return $B(a,0,2147483647)},$CLJS.oC,"a non-negative integer no greater than "+$CLJS.T.g(2147483647)],
-null),new $CLJS.S(null,2,[$CLJS.Mm,aC,$CLJS.oC,"true or false"],null),new $CLJS.S(null,2,[$CLJS.Mm,aC,$CLJS.oC,"true or false"],null),new $CLJS.S(null,2,[$CLJS.Mm,function(a){var b=new $CLJS.uk(null,new $CLJS.S(null,2,[$CLJS.JB,null,$CLJS.go,null],null),null);b=b.g?b.g(a):b.call(null,a);return $CLJS.u(b)?b:jla(a)},$CLJS.oC,":fallback, :error, or a function of [name payload]"],null),new $CLJS.S(null,2,[$CLJS.Mm,function(a){return $B(a,0,2147483647)},$CLJS.oC,"a non-negative integer no greater than "+
-$CLJS.T.g(2147483647)+" (0 turns indexing off)"],null),new $CLJS.S(null,2,[$CLJS.Mm,aC,$CLJS.oC,"true or false"],null),new $CLJS.S(null,2,[$CLJS.Mm,aC,$CLJS.oC,"true or false"],null),new $CLJS.S(null,2,[$CLJS.Mm,function(a){return a==null||$CLJS.Jf(a)},$CLJS.oC,"a registry map from boring/tag-registry"],null),new $CLJS.S(null,2,[$CLJS.Mm,function(a){return $B(a,0,Number.MAX_SAFE_INTEGER)},$CLJS.oC,"a non-negative integer (0 means unlimited)"],null),new $CLJS.S(null,2,[$CLJS.Mm,new $CLJS.uk(null,new $CLJS.S(null,
-2,[fC,null,$CLJS.nC,null],null),null),$CLJS.oC,":preserve-width or :shortest"],null),new $CLJS.S(null,2,[$CLJS.Mm,new $CLJS.uk(null,new $CLJS.S(null,2,[mC,null,$CLJS.gC,null],null),null),$CLJS.oC,":rfc8949 or :rfc7049"],null),new $CLJS.S(null,2,[$CLJS.Mm,aC,$CLJS.oC,"true or false"],null),new $CLJS.S(null,2,[$CLJS.Mm,aC,$CLJS.oC,"true or false"],null),new $CLJS.S(null,2,[$CLJS.Mm,aC,$CLJS.oC,"true or false"],null),new $CLJS.S(null,2,[$CLJS.Mm,new $CLJS.uk(null,new $CLJS.S(null,2,[Ela,null,Bla,null],
-null),null),$CLJS.oC,":trusted or :ignore"],null),new $CLJS.S(null,2,[$CLJS.Mm,function(a){return $B(a,1,2048)},$CLJS.oC,"a positive integer no greater than "+$CLJS.T.g(2048)+" (the decoder recurses per level, and a limit the host stack cannot honour is not a limit)"],null),new $CLJS.S(null,2,[$CLJS.Mm,function(a){return $B(a,1,2147483647)},$CLJS.oC,"a positive integer"],null),new $CLJS.S(null,2,[$CLJS.Mm,aC,$CLJS.oC,"true or false"],null),new $CLJS.S(null,2,[$CLJS.Mm,function(a){var b=new $CLJS.uk(null,
-new $CLJS.S(null,2,[Dla,null,ola,null],null),null);b=b.g?b.g(a):b.call(null,a);return $CLJS.u(b)?b:$CLJS.uf(a)},$CLJS.oC,":date, :instant, or a function of epoch millis"],null),new $CLJS.S(null,2,[$CLJS.Mm,function(a){return a==null||$CLJS.A.h($CLJS.pla,a)||jla(a)},$CLJS.oC,"nil, :placeholder, or a function"],null),new $CLJS.S(null,3,[$CLJS.Mm,function(a){return $CLJS.Vf($CLJS.rC,a)},$CLJS.tm,$CLJS.wla,$CLJS.oC,"one of :clojure, :interop, :archival, :canonical, :canonical-rfc7049"],null),new $CLJS.S(null,
-2,[$CLJS.Mm,aC,$CLJS.oC,"true or false"],null)]);$CLJS.Ola=$CLJS.Og($CLJS.jg(function(a,b,c){return $CLJS.oj.i(a,b,$CLJS.Mm.g(c))},$CLJS.pd($CLJS.bh),$CLJS.tC));
+$CLJS.tC=$CLJS.Wj([zla,$CLJS.Ila,$CLJS.cC,$CLJS.lC,$CLJS.tla,$CLJS.pn,$CLJS.mla,$CLJS.ula,$CLJS.Vn,$CLJS.IB,$CLJS.iC,$CLJS.jC,$CLJS.qla,$CLJS.kla,$CLJS.qC,Lla,$CLJS.HB,Hla,$CLJS.lla,$CLJS.Kla,$CLJS.Gla,$CLJS.kC,$CLJS.dC],[new $CLJS.S(null,2,[$CLJS.Om,new $CLJS.uk(null,new $CLJS.S(null,2,[nla,null,Fla,null],null),null),$CLJS.oC,":local-date or :sql-date"],null),new $CLJS.S(null,2,[$CLJS.Om,function(a){return $B(a,0,2147483647)},$CLJS.oC,"a non-negative integer no greater than "+$CLJS.T.g(2147483647)],
+null),new $CLJS.S(null,2,[$CLJS.Om,aC,$CLJS.oC,"true or false"],null),new $CLJS.S(null,2,[$CLJS.Om,aC,$CLJS.oC,"true or false"],null),new $CLJS.S(null,2,[$CLJS.Om,function(a){var b=new $CLJS.uk(null,new $CLJS.S(null,2,[$CLJS.JB,null,$CLJS.yo,null],null),null);b=b.g?b.g(a):b.call(null,a);return $CLJS.u(b)?b:jla(a)},$CLJS.oC,":fallback, :error, or a function of [name payload]"],null),new $CLJS.S(null,2,[$CLJS.Om,function(a){return $B(a,0,2147483647)},$CLJS.oC,"a non-negative integer no greater than "+
+$CLJS.T.g(2147483647)+" (0 turns indexing off)"],null),new $CLJS.S(null,2,[$CLJS.Om,aC,$CLJS.oC,"true or false"],null),new $CLJS.S(null,2,[$CLJS.Om,aC,$CLJS.oC,"true or false"],null),new $CLJS.S(null,2,[$CLJS.Om,function(a){return a==null||$CLJS.Jf(a)},$CLJS.oC,"a registry map from boring/tag-registry"],null),new $CLJS.S(null,2,[$CLJS.Om,function(a){return $B(a,0,Number.MAX_SAFE_INTEGER)},$CLJS.oC,"a non-negative integer (0 means unlimited)"],null),new $CLJS.S(null,2,[$CLJS.Om,new $CLJS.uk(null,new $CLJS.S(null,
+2,[fC,null,$CLJS.nC,null],null),null),$CLJS.oC,":preserve-width or :shortest"],null),new $CLJS.S(null,2,[$CLJS.Om,new $CLJS.uk(null,new $CLJS.S(null,2,[mC,null,$CLJS.gC,null],null),null),$CLJS.oC,":rfc8949 or :rfc7049"],null),new $CLJS.S(null,2,[$CLJS.Om,aC,$CLJS.oC,"true or false"],null),new $CLJS.S(null,2,[$CLJS.Om,aC,$CLJS.oC,"true or false"],null),new $CLJS.S(null,2,[$CLJS.Om,aC,$CLJS.oC,"true or false"],null),new $CLJS.S(null,2,[$CLJS.Om,new $CLJS.uk(null,new $CLJS.S(null,2,[Ela,null,Bla,null],
+null),null),$CLJS.oC,":trusted or :ignore"],null),new $CLJS.S(null,2,[$CLJS.Om,function(a){return $B(a,1,2048)},$CLJS.oC,"a positive integer no greater than "+$CLJS.T.g(2048)+" (the decoder recurses per level, and a limit the host stack cannot honour is not a limit)"],null),new $CLJS.S(null,2,[$CLJS.Om,function(a){return $B(a,1,2147483647)},$CLJS.oC,"a positive integer"],null),new $CLJS.S(null,2,[$CLJS.Om,aC,$CLJS.oC,"true or false"],null),new $CLJS.S(null,2,[$CLJS.Om,function(a){var b=new $CLJS.uk(null,
+new $CLJS.S(null,2,[Dla,null,ola,null],null),null);b=b.g?b.g(a):b.call(null,a);return $CLJS.u(b)?b:$CLJS.uf(a)},$CLJS.oC,":date, :instant, or a function of epoch millis"],null),new $CLJS.S(null,2,[$CLJS.Om,function(a){return a==null||$CLJS.A.h($CLJS.pla,a)||jla(a)},$CLJS.oC,"nil, :placeholder, or a function"],null),new $CLJS.S(null,3,[$CLJS.Om,function(a){return $CLJS.Vf($CLJS.rC,a)},$CLJS.vm,$CLJS.wla,$CLJS.oC,"one of :clojure, :interop, :archival, :canonical, :canonical-rfc7049"],null),new $CLJS.S(null,
+2,[$CLJS.Om,aC,$CLJS.oC,"true or false"],null)]);$CLJS.Ola=$CLJS.Og($CLJS.jg(function(a,b,c){return $CLJS.oj.i(a,b,$CLJS.Om.g(c))},$CLJS.pd($CLJS.bh),$CLJS.tC));