@nxtedition/deepstream.io-client-js 32.0.12 → 32.0.14

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nxtedition/deepstream.io-client-js",
-  "version": "32.0.12",
+  "version": "32.0.14",
   "description": "the javascript client for deepstream.io",
   "homepage": "http://deepstream.io",
   "type": "module",
@@ -41,31 +41,32 @@
     "component-emitter2": "^1.3.5",
     "invariant": "^2.2.4",
     "lodash.clonedeep": "^4.5.0",
-    "type-fest": "^5.4.1",
+    "type-fest": "^5.5.0",
     "utf-8-validate": "^6.0.6",
     "varint": "^6.0.0",
-    "ws": "^8.19.0",
+    "ws": "^8.20.0",
     "xuid": "^4.1.3",
     "xxhash-wasm": "^1.0.2"
   },
   "devDependencies": {
-    "@types/node": "^25.0.10",
-    "eslint": "^9.39.2",
+    "@eslint/js": "^10.0.1",
+    "@types/node": "^25.5.0",
+    "eslint": "^10.1.0",
     "eslint-config-prettier": "^10.1.8",
     "eslint-config-standard": "^17.1.0",
     "eslint-plugin-import": "^2.31.0",
-    "eslint-plugin-n": "^17.23.2",
+    "eslint-plugin-n": "^17.24.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^7.1.0",
     "husky": "^9.1.6",
-    "lint-staged": "^16.2.7",
+    "lint-staged": "^16.4.0",
     "mitata": "^1.0.10",
     "pinst": "^3.0.0",
     "prettier": "^3.8.1",
     "rxjs": "^7.8.1",
     "tsd": "^0.33.0",
-    "typescript": "^5.6.3",
-    "typescript-eslint": "^8.53.1"
+    "typescript": "^6.0.2",
+    "typescript-eslint": "^8.57.2"
   },
   "peerDependencies": {
     "rxjs": ">=6.x"

package/src/client.d.ts

@@ -33,6 +33,8 @@ export type {
   SyncOptions,
   Paths,
   Get,
+  ConnectionStateName,
+  DeepstreamErrorEventName,
 }
 
 type RecordStateConstants = Readonly<{
@@ -99,6 +101,26 @@ export interface DeepstreamError extends Error {
   data?: unknown
 }
 
+export interface DeepstreamMessage {
+  raw: string | null
+  topic: string | null
+  action: string | null
+  data: string[]
+}
+
+export interface DeepstreamClientEventMap {
+  connectionStateChanged: (state: ConnectionStateName) => void
+  connected: (connected: boolean) => void
+  MAX_RECONNECTION_ATTEMPTS_REACHED: (attempt: number) => void
+  error: (error: DeepstreamError) => void
+  recv: (message: DeepstreamMessage) => void
+  send: (message: DeepstreamMessage) => void
+}
+
+type DeepstreamErrorEventMap = {
+  [K in DeepstreamErrorEventName]: (error: DeepstreamError) => void
+}
+
 export interface DeepstreamClient<
   Records extends Record<string, unknown> = Record<string, unknown>,
   Methods extends Record<string, RpcMethodDef> = Record<string, RpcMethodDef>,
@@ -108,18 +130,21 @@ export interface DeepstreamClient<
   rpc: RpcHandler<Methods>
   record: RecordHandler<Records>
   user: string | null
-  on(evt: 'connectionStateChanged', callback: (state: ConnectionStateName) => void): this
-  on(evt: 'connected', callback: (connected: boolean) => void): this
-  on(evt: 'MAX_RECONNECTION_ATTEMPTS_REACHED', callback: (attempt: number) => void): this
-  on(evt: 'error' | DeepstreamErrorEventName, callback: (error: DeepstreamError) => void): this
-  off(evt: 'connectionStateChanged', callback: (state: ConnectionStateName) => void): this
-  off(evt: 'connected', callback: (connected: boolean) => void): this
-  off(evt: 'MAX_RECONNECTION_ATTEMPTS_REACHED', callback: (attempt: number) => void): this
-  off(evt: 'error' | DeepstreamErrorEventName, callback: (error: DeepstreamError) => void): this
+  on<K extends keyof (DeepstreamClientEventMap & DeepstreamErrorEventMap)>(
+    evt: K,
+    callback: (DeepstreamClientEventMap & DeepstreamErrorEventMap)[K],
+  ): this
+  off<K extends keyof (DeepstreamClientEventMap & DeepstreamErrorEventMap)>(
+    evt: K,
+    callback: (DeepstreamClientEventMap & DeepstreamErrorEventMap)[K],
+  ): this
   getConnectionState: () => ConnectionStateName
   close: () => void
   login(callback: (success: boolean, authData: unknown) => void): this
-  login(authParams: object, callback: (success: boolean, authData: unknown) => void): this
+  login(
+    authParams: Record<string, unknown>,
+    callback: (success: boolean, authData: unknown) => void,
+  ): this
   stats: {
     record: RecordStats
     rpc: RpcStats

package/src/event/event-handler.js

@@ -78,7 +78,7 @@ EventHandler.on = function (name, callback) {
 
 EventHandler.once = function (name, callback) {
   const fn = (...args) => {
-    this.unsubscribe(fn)
+    this.unsubscribe(name, fn)
     callback(...args)
   }
   this.subscribe(name, fn)

package/src/record/record-handler.js

@@ -44,10 +44,13 @@ function onUpdate(record, subscription) {
   }
 
   if (!subscription.synced || subscription.record.state < subscription.state) {
+    if (subscription.timeoutValue > 0 && !subscription.timeout) {
+      subscription.timeout = timers.setTimeout(onTimeout, subscription.timeoutValue, subscription)
+    }
     return
   }
 
-  if (subscription.timeout != null) {
+  if (subscription.timeout) {
     timers.clearTimeout(subscription.timeout)
     subscription.timeout = null
   }
@@ -94,36 +97,6 @@ function onTimeout(subscription) {
   )
 }
 
-class Subscription {
-  /** @type {unknown} */
-  key = null
-  /** @type {unknown} */
-  subscriber = null
-  /** @type {unknown} */
-  path = null
-  /** @type {number} */
-  state = 0
-  /** @type {AbortSignal|null} */
-  signal = null
-  /** @type {boolean} */
-  dataOnly = false
-
-  /** @type {Record|null} */
-  record = null
-  /** @type {Timeout|null} */
-  timeout = null
-  /** @type {Function?} */
-  abort = null
-  /** @type {object|Array} */
-  data = kEmpty
-  /** @type {boolean} */
-  synced = false
-
-  index = -1
-
-  onUpdate = onUpdate
-}
-
 class RecordHandler {
   constructor(options, connection, client) {
     this.JSON = jsonPath
@@ -142,12 +115,8 @@ class RecordHandler {
 
     this._connected = 0
     this._stats = {
-      updating: 0,
       created: 0,
       destroyed: 0,
-      records: 0,
-      pruning: 0,
-      patching: 0,
     }
 
     this._syncQueue = []
@@ -169,23 +138,11 @@ class RecordHandler {
       this._pruning = new Set()
 
       for (const rec of pruning) {
-        try {
-          rec._$dispose()
-          if (!this._records.delete(rec.name)) {
-            this._client._$onError(
-              C.TOPIC.RECORD,
-              C.EVENT.INTERNAL_ERROR,
-              `failed to delete pruned record: ${rec.name}`,
-            )
-          }
-        } catch (err) {
-          this._client._$onError(C.TOPIC.RECORD, C.EVENT.INTERNAL_ERROR, err)
-        }
+        rec._$dispose()
+        this._records.delete(rec.name)
       }
 
       this._stats.destroyed += pruning.size
-      this._stats.pruning = this._pruning.size
-      this._stats.records = this._records.size
 
       this._pruningTimeout.refresh()
     }
@@ -199,7 +156,6 @@ class RecordHandler {
     } else {
       this._pruning.delete(rec)
     }
-    this._stats.pruning = this._pruning.size
   }
 
   _onUpdating(rec, value) {
@@ -207,12 +163,9 @@ class RecordHandler {
 
     if (value) {
       invariant(!callbacks, 'updating callbacks must not exist')
-      this._stats.updating += 1
       this._updating.set(rec, [])
     } else {
       invariant(callbacks, 'updating callbacks must exist')
-
-      this._stats.updating -= 1
       this._updating.delete(rec)
       for (const callback of callbacks) {
         callback()
@@ -230,7 +183,6 @@ class RecordHandler {
         callback()
       }
     }
-    this._stats.patching = this._patching.size
   }
 
   get connected() {
@@ -246,6 +198,10 @@ class RecordHandler {
     return {
       ...this._stats,
       subscriptions,
+      updating: this._updating.size,
+      patching: this._patching.size,
+      putting: this._putting.size,
+      pruning: this._pruning.size,
     }
   }
 
@@ -268,16 +224,14 @@ class RecordHandler {
     }
 
     let record = this._records.get(name)
+
     if (!record) {
       record = new Record(name, this)
-      this._records.set(name, record)
       this._stats.created += 1
-      this._stats.records = this._records.size
-    } else {
-      record.ref()
+      this._records.set(name, record)
     }
 
-    return record
+    return record.ref()
   }
 
   provide(pattern, callback, options) {
@@ -599,7 +553,6 @@ class RecordHandler {
     let timeout = defaults?.timeout ?? 0
     let dataOnly = defaults?.dataOnly ?? false
     let sync = defaults?.sync ?? false
-    let key
 
     let idx = 0
 
@@ -618,7 +571,7 @@ class RecordHandler {
     }
 
     if (idx < args.length && (args[idx] == null || typeof args[idx] === 'object')) {
-      const options = args[idx++] || {}
+      const options = args[idx] ?? {}
 
       if (options.signal !== undefined) {
         signal = options.signal
@@ -643,10 +596,6 @@ class RecordHandler {
       if (options.sync !== undefined) {
         sync = options.sync
       }
-
-      if (options.key !== undefined) {
-        key = options.key
-      }
     }
 
     if (typeof state === 'string') {
@@ -675,14 +624,35 @@ class RecordHandler {
         return
       }
 
-      const subscription = new Subscription()
-
-      subscription.key = key
-      subscription.subscriber = subscriber
-      subscription.path = path
-      subscription.state = state
-      subscription.signal = signal
-      subscription.dataOnly = dataOnly
+      // TODO (perf): Make a class
+      const subscription = {
+        /** @readonly @type {unknown} */
+        subscriber,
+        /** @readonly @type {unknown} */
+        path,
+        /** @readonly @type {number} */
+        state,
+        /** @type {AbortSignal|null} */
+        signal,
+        /** @readonly @type {boolean} */
+        dataOnly,
+        /** @readonly @type {number} */
+        timeoutValue: timeout,
+
+        /** @type {Record|null} */
+        record: null,
+        /** @type {Timeout|null} */
+        timeout: null,
+        /** @type {Function?} */
+        abort: null,
+        /** @type {object|Array} */
+        data: kEmpty,
+        /** @type {boolean} */
+        synced: false,
+
+        index: -1,
+        onUpdate,
+      }
 
       subscriber.add(() => {
         if (subscription.timeout) {
@@ -716,10 +686,6 @@ class RecordHandler {
       } else {
         onSync(subscription)
       }
-
-      if (timeout > 0 && (!subscription.synced || subscription.record.state < subscription.state)) {
-        subscription.timeout = timers.setTimeout(onTimeout, timeout, subscription)
-      }
     })
   }
 

package/src/record/record.js

@@ -18,18 +18,15 @@ class Record {
     this._version = ''
     this._data = jsonPath.EMPTY_OBJ
     this._state = C.RECORD_STATE.VOID
-    this._refs = 1
-
-    /** @type {Array|null} */
-    this._subscriptions = null
+    this._refs = 0
+    this._subscriptions = []
 
     /** @type {Array|null} */
     this._emittingArr = null
     /** @type {number} */
     this._emittingIndex = -1
 
-    /** @type {Array|null} */
-    this._observers = null
+    this._observers = []
 
     /** @type Map? */ this._updating = null
     /** @type Array? */ this._patching = null
@@ -97,8 +94,6 @@ class Record {
    * @returns {Record}
    */
   subscribe(fn, opaque = null) {
-    this._subscriptions ??= []
-
     if (this._emittingArr == this._subscriptions) {
       this._subscriptions = this._subscriptions.slice()
     }
@@ -115,10 +110,6 @@ class Record {
    * @returns {Record}
    */
   unsubscribe(fn, opaque = null) {
-    if (!this._subscriptions) {
-      return this
-    }
-
     if (this._emittingArr == this._subscriptions) {
       this._subscriptions = this._subscriptions.slice()
     }
@@ -146,17 +137,10 @@ class Record {
    * @param {{ index: number, onUpdate: (Record) => void}} subscription
    */
   _observe(subscription) {
-    this._observers ??= []
-
     if (subscription.index != null && subscription.index !== -1) {
       throw new Error('already observing')
     }
 
-    if (this._emittingArr === this._observers) {
-      // TODO (perf): Shift from start if emitting?
-      this._observers = this._observers.slice()
-    }
-
     subscription.index = this._observers.push(subscription) - 1
   }
 
@@ -164,10 +148,6 @@ class Record {
    * @param {{ index: number, onUpdate: (Record) => void}} subscription
    */
   _unobserve(subscription) {
-    if (!this._observers) {
-      return this
-    }
-
     if (subscription.index == null || subscription.index === -1) {
       throw new Error('not observing')
     }
@@ -249,7 +229,7 @@ class Record {
   when(stateOrNil, optionsOrNil) {
     invariant(this._refs > 0, 'missing refs')
 
-    if (stateOrNil != null && stateOrNil === 'object') {
+    if (stateOrNil != null && typeof stateOrNil === 'object') {
       optionsOrNil = stateOrNil
       stateOrNil = optionsOrNil?.state
     }
@@ -257,7 +237,6 @@ class Record {
     const signal = optionsOrNil?.signal
     const state = stateOrNil ?? C.RECORD_STATE.SERVER
     const timeout = optionsOrNil?.timeout ?? 2 * 60e3
-    const key = optionsOrNil?.key ?? 'when'
 
     if (signal?.aborted) {
       return Promise.reject(signal.reason || new utils.AbortError())
@@ -273,33 +252,14 @@ class Record {
         return
       }
 
-      const subscription = {
-        key,
-        /** @type {timers.Timeout|NodeJS.Timeout|null} */
-        timeout: null,
-        /** @type {AbortSignal|null} */
-        signal: null,
-        done: false,
-
-        state,
-        index: -1,
-        onUpdate(record, subscription) {
-          if (record._state >= subscription.state) {
-            onDone(null)
-          }
-        },
-      }
-
-      const onAbort = (e) => {
-        onDone(signal.reason ?? new utils.AbortError())
-      }
+      let timeoutHandle
+      let done = false
 
       const onDone = (err) => {
-        if (subscription.done) {
+        if (done) {
           return
         }
-
-        subscription.done = true
+        done = true
 
         if (err) {
           reject(err)
@@ -308,21 +268,30 @@ class Record {
         }
 
         this.unref()
-        this._unobserve(subscription)
+        this.unsubscribe(onUpdate)
 
-        if (subscription.timeout != null) {
-          timers.clearTimeout(subscription.timeout)
-          subscription.timeout = null
+        if (timeoutHandle) {
+          timers.clearTimeout(timeoutHandle)
+          timeoutHandle = null
         }
 
-        if (subscription.signal != null) {
-          subscription.signal.removeEventListener('abort', onAbort)
-          subscription.signal = null
+        signal?.removeEventListener('abort', onAbort)
+      }
+
+      const onUpdate = () => {
+        if (this._state >= state) {
+          onDone(null)
         }
       }
 
+      const onAbort = signal
+        ? () => {
+            onDone(signal.reason ?? new utils.AbortError())
+          }
+        : null
+
       if (timeout > 0) {
-        subscription.timeout = timers.setTimeout(() => {
+        timeoutHandle = timers.setTimeout(() => {
           const expected = C.RECORD_STATE_NAME[state]
           const current = C.RECORD_STATE_NAME[this._state]
 
@@ -334,13 +303,10 @@ class Record {
         }, timeout)
       }
 
-      if (signal) {
-        subscription.signal = signal
-        signal?.addEventListener('abort', onAbort)
-      }
+      signal?.addEventListener('abort', onAbort)
 
       this.ref()
-      this._observe(subscription)
+      this.subscribe(onUpdate)
     })
   }
 
@@ -598,38 +564,34 @@ class Record {
       throw new Error('cannot reenter emitUpdate')
     }
 
-    if (this._subscriptions != null) {
-      try {
-        const arr = this._subscriptions
-        const len = arr.length
-
-        this._emittingArr = arr
-        for (let n = 0; n < len; n += 2) {
-          this._emittingIndex = n
-          // TODO (fix): What if this throws?
-          arr[n + 0](this, arr[n + 1])
-        }
-      } finally {
-        this._emittingArr = null
-        this._emittingIndex = -1
+    try {
+      const arr = this._subscriptions
+      const len = arr.length
+
+      this._emittingArr = arr
+      for (let n = 0; n < len; n += 2) {
+        this._emittingIndex = n
+        // TODO (fix): What if this throws?
+        arr[n + 0](this, arr[n + 1])
       }
+    } finally {
+      this._emittingArr = null
+      this._emittingIndex = -1
     }
 
-    if (this._observers != null) {
-      try {
-        const arr = this._observers
-        const len = arr.length
-
-        this._emittingArr = arr
-        for (let n = 0; n < len; n++) {
-          this._emittingIndex = n
-          // TODO (fix): What if this throws?
-          arr[n].onUpdate(this, arr[n])
-        }
-      } finally {
-        this._emittingArr = null
-        this._emittingIndex = -1
+    try {
+      const arr = this._observers
+      const len = arr.length
+
+      this._emittingArr = arr
+      for (let n = 0; n < len; n++) {
+        this._emittingIndex = n
+        // TODO (fix): What if this throws?
+        arr[n].onUpdate(this, arr[n])
       }
+    } finally {
+      this._emittingArr = null
+      this._emittingIndex = -1
     }
 
     this._handler._client.emit('recordUpdated', this)

package/src/utils/legacy-listener.js

@@ -6,7 +6,6 @@ export default class Listener {
   constructor(topic, pattern, callback, handler, { recursive = false, stringify = null } = {}) {
     this._topic = topic
     this._pattern = pattern
-    this._expr = new RegExp(pattern)
     this._callback = callback
     this._handler = handler
     this._client = this._handler._client
@@ -55,11 +54,6 @@ export default class Listener {
         return
       }
 
-      if (!this._expr.test(name)) {
-        this._error(name, 'invalid add: name does not match pattern')
-        return
-      }
-
       // TODO (refactor): Move to class
       const provider = {
         name,

package/src/utils/unicast-listener.js

@@ -37,7 +37,6 @@ export default class Listener {
 
     this._topic = topic
     this._pattern = pattern
-    this._expr = new RegExp(pattern)
     this._callback = callback
     this._handler = handler
     this._client = this._handler._client
@@ -70,11 +69,6 @@ export default class Listener {
         return
       }
 
-      if (!this._expr.test(name)) {
-        this._error(name, 'invalid accept: name does not match pattern')
-        return
-      }
-
       let value$
       try {
         value$ = this._callback(name)

package/src/utils/utils.js

@@ -85,7 +85,7 @@ export function setTimeout(callback, timeoutDuration) {
 
 export function setInterval(callback, intervalDuration) {
   if (intervalDuration !== null) {
-    return setInterval(callback, intervalDuration)
+    return globalThis.setInterval(callback, intervalDuration)
   } else {
     return -1
   }

package/.claude/settings.local.json

@@ -1,9 +0,0 @@
-{
-  "permissions": {
-    "allow": [
-      "Bash(npm run test:types:*)"
-    ],
-    "deny": [],
-    "ask": []
-  }
-}