@mblaney/holster 2.3.1 → 2.3.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mblaney/holster",
-  "version": "2.3.1",
+  "version": "2.3.3",
   "description": "Holster is a service that allows synchronising data between devices using Node, Deno, Bun or the browser.",
   "type": "module",
   "main": "index.js",

package/src/holster.js

@@ -416,10 +416,10 @@ const Holster = opt => {
           return
         }
 
-        // lex requires a callback as it's not included in the chain below.
+        // lex isn't part of the chain below, so without a callback the
+        // result is returned as a promise instead.
         if (lex && typeof cb !== "function") {
-          console.log("error lex requires a callback function")
-          return
+          return new Promise(resolve => api(ctxid).get(key, lex, resolve, _opt))
         }
 
         // Top level keys are added to a root node so their values don't need
@@ -462,10 +462,12 @@ const Holster = opt => {
           return
         }
 
-        // lex requires a callback as it's not included in the chain below.
+        // lex isn't part of the chain below, so without a callback the
+        // result is returned as a promise instead.
         if (lex && typeof cb !== "function") {
-          console.log("error lex requires a callback function")
-          return
+          return new Promise(resolve =>
+            api(ctxid).next(key, lex, resolve, _opt),
+          )
         }
 
         const ctx = allctx.get(ctxid)
@@ -769,6 +771,9 @@ const Holster = opt => {
         // same listener. Scoped to this one on() call's closure, so concurrent
         // subscriptions (even on the same key) can each track their own.
         let listenedSoul = soul
+        // Each update starts its own async read, and an earlier one can finish
+        // last - only the newest is delivered, so stale data can't follow it.
+        let latestRun = 0
 
         map.set(cb, () => {
           // Bail out if off() has already cleaned up this context. The mapped
@@ -781,6 +786,12 @@ const Holster = opt => {
           // have an update and should not call cb twice.
           clearTimeout(retryTimer)
           retryTimer = null
+          const run = ++latestRun
+          const deliver = data => {
+            if (run !== latestRun) return
+            retryTimer = null
+            cb(data)
+          }
 
           // Resolves {soul, item} to a genuine value, following a rel to its
           // target if the property turns out to be one. This is checked on
@@ -796,6 +807,7 @@ const Holster = opt => {
           // way the rel branch below already retries on a null target
           // read.
           const resolveValue = (retries, node, value) => {
+            if (run !== latestRun) return
             const id = utils.rel.is(value)
             if (id) {
               if (listenedSoul !== id) {
@@ -803,21 +815,16 @@ const Holster = opt => {
                 wire.on({"#": id, ".": null}, map.get(cb), false, _opt)
                 listenedSoul = id
               }
-              readRelTarget(id, ctx ? ctx.user : null, _opt).then(data => {
-                retryTimer = null
-                cb(data)
-              })
+              readRelTarget(id, ctx ? ctx.user : null, _opt).then(deliver)
               return
             }
 
             if (value !== undefined && value !== null) {
-              retryTimer = null
-              cb(value)
+              deliver(value)
               return
             }
             if (retries >= maxRetries) {
-              retryTimer = null
-              cb(value !== undefined ? value : null)
+              deliver(value !== undefined ? value : null)
               return
             }
             // Fast once the parent node already exists (a value is likely
@@ -977,10 +984,10 @@ const Holster = opt => {
               return
             }
 
-            // lex requires a callback as it's not included in the chain below.
+            // lex isn't part of the chain below, so without a callback the
+            // result is returned as a promise instead.
             if (lex && !cb) {
-              console.log("error lex requires a callback function")
-              return
+              return new Promise(resolve => user.get(keys, lex, resolve, _opt))
             }
 
             ctxid = utils.text.random()

package/ts/src/holster.ts

@@ -37,11 +37,8 @@ export interface HolsterAPI {
       cb: (data: unknown) => void,
       _opt?: WireOptions,
     ): HolsterAPI
-    (
-      key: string | null,
-      lex?: LexWithDot,
-      _opt?: WireOptions,
-    ): AwaitableHolsterAPI
+    (key: string | null, lex: LexWithDot, _opt?: WireOptions): Promise<unknown>
+    (key: string | null, lex?: null, _opt?: WireOptions): AwaitableHolsterAPI
   }
   next: {
     (
@@ -55,11 +52,8 @@ export interface HolsterAPI {
       cb: (data: unknown) => void,
       _opt?: WireOptions,
     ): HolsterAPI
-    (
-      key: string | null,
-      lex?: LexWithDot,
-      _opt?: WireOptions,
-    ): AwaitableHolsterAPI
+    (key: string | null, lex: LexWithDot, _opt?: WireOptions): Promise<unknown>
+    (key: string | null, lex?: null, _opt?: WireOptions): AwaitableHolsterAPI
   }
   put: {
     (
@@ -601,9 +595,12 @@ const Holster = (opt?: HolsterOptions | string | string[]): HolsterAPI => {
           return this
         }
 
+        // lex isn't part of the chain below, so without a callback the
+        // result is returned as a promise instead.
         if (lexFilter && typeof callback !== "function") {
-          console.log("error lex requires a callback function")
-          return this
+          return new Promise(resolve =>
+            api(ctxid).get(key, lexFilter, resolve, opts),
+          ) as never
         }
 
         ctxid = utils.text.random()
@@ -662,9 +659,12 @@ const Holster = (opt?: HolsterOptions | string | string[]): HolsterAPI => {
           return this
         }
 
+        // lex isn't part of the chain below, so without a callback the
+        // result is returned as a promise instead.
         if (lexFilter && typeof callback !== "function") {
-          console.log("error lex requires a callback function")
-          return this
+          return new Promise(resolve =>
+            api(ctxid).next(key, lexFilter, resolve, opts),
+          ) as never
         }
 
         const ctx = allctx.get(ctxid)
@@ -1020,6 +1020,9 @@ const Holster = (opt?: HolsterOptions | string | string[]): HolsterAPI => {
         // on() call's closure, so concurrent subscriptions (even on the
         // same key) each track their own independently.
         let listenedSoul = soul
+        // Each update starts its own async read, and an earlier one can finish
+        // last - only the newest is delivered, so stale data can't follow it.
+        let latestRun = 0
 
         map.set(callback, () => {
           // Bail out if off() has already cleaned up this context — the mapped
@@ -1031,6 +1034,12 @@ const Holster = (opt?: HolsterOptions | string | string[]): HolsterAPI => {
           // have an update and should not call callback twice.
           clearTimeout(retryTimer!)
           retryTimer = null
+          const run = ++latestRun
+          const deliver = (data: unknown) => {
+            if (run !== latestRun) return
+            retryTimer = null
+            callback(data)
+          }
 
           // Resolves {soul, item} to a genuine value, following a rel to its
           // target if the property turns out to be one - checked fresh on
@@ -1051,6 +1060,7 @@ const Holster = (opt?: HolsterOptions | string | string[]): HolsterAPI => {
             node: Record<string, GraphValue> | null | undefined,
             value: unknown,
           ): void => {
+            if (run !== latestRun) return
             const id = utils.rel.is(value as GraphValue)
             if (id) {
               if (listenedSoul !== id) {
@@ -1063,21 +1073,16 @@ const Holster = (opt?: HolsterOptions | string | string[]): HolsterAPI => {
                 )
                 listenedSoul = id
               }
-              readRelTarget(id, ctx ? ctx.user : null, opts).then(data => {
-                retryTimer = null
-                callback(data)
-              })
+              readRelTarget(id, ctx ? ctx.user : null, opts).then(deliver)
               return
             }
 
             if (value !== undefined && value !== null) {
-              retryTimer = null
-              callback(value)
+              deliver(value)
               return
             }
             if (retries >= maxRetries) {
-              retryTimer = null
-              callback(value !== undefined ? value : null)
+              deliver(value !== undefined ? value : null)
               return
             }
             // Fast once the parent node already exists (a value is likely
@@ -1261,9 +1266,12 @@ const Holster = (opt?: HolsterOptions | string | string[]): HolsterAPI => {
               return this
             }
 
+            // lex isn't part of the chain below, so without a callback the
+            // result is returned as a promise instead.
             if (lexFilter && !callback) {
-              console.log("error lex requires a callback function")
-              return this
+              return new Promise(resolve =>
+                user.get!(keys, lexFilter, resolve, opts),
+              ) as never
             }
 
             ctxid = utils.text.random()

package/ts/src/user.ts

@@ -9,7 +9,7 @@ import SEA from "./sea.ts"
 import type {
   UserIdentity,
   HolsterOptions,
-  LexFilter,
+  LexWithDot,
   WireOptions,
 } from "./schemas.ts"
 import type {HolsterAPI, AwaitableHolsterAPI} from "./holster.ts"
@@ -45,7 +45,7 @@ export interface UserInterface {
   get?: {
     (
       keys: string | string[],
-      lex: LexFilter,
+      lex: LexWithDot,
       cb: (data: unknown) => void,
       _opt?: WireOptions,
     ): HolsterAPI
@@ -56,7 +56,12 @@ export interface UserInterface {
     ): HolsterAPI
     (
       keys: string | string[],
-      lex?: LexFilter,
+      lex: LexWithDot,
+      _opt?: WireOptions,
+    ): Promise<unknown>
+    (
+      keys: string | string[],
+      lex?: null,
       _opt?: WireOptions,
     ): AwaitableHolsterAPI
   }