@nxtedition/deepstream.io-client-js 32.0.6 → 32.0.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nxtedition/deepstream.io-client-js",
-  "version": "32.0.6",
+  "version": "32.0.8",
   "description": "the javascript client for deepstream.io",
   "homepage": "http://deepstream.io",
   "type": "module",
@@ -41,6 +41,7 @@
     "component-emitter2": "^1.3.5",
     "invariant": "^2.2.4",
     "lodash.clonedeep": "^4.5.0",
+    "type-fest": "^5.4.1",
     "utf-8-validate": "^6.0.6",
     "varint": "^6.0.0",
     "ws": "^8.19.0",
@@ -63,7 +64,6 @@
     "prettier": "^3.8.1",
     "rxjs": "^7.8.1",
     "tsd": "^0.33.0",
-    "type-fest": "^5.4.1",
     "typescript": "^5.6.3",
     "typescript-eslint": "^8.53.1"
   },

package/src/client.d.ts

@@ -87,11 +87,12 @@ export interface DeepstreamClient<
   rpc: RpcHandler<Methods>
   record: RecordHandler<Records>
   user: string | null
-  on: (evt: EventName, callback: (...args: unknown[]) => void) => void
-  off: (evt: EventName, callback: (...args: unknown[]) => void) => void
+  on: (evt: EventName, callback: (...args: unknown[]) => void) => this
+  off: (evt: EventName, callback: (...args: unknown[]) => void) => this
   getConnectionState: () => ConnectionStateName
   close: () => void
-  login: unknown
+  login(callback: (success: boolean, authData: unknown) => void): this
+  login(authParams: object, callback: (success: boolean, authData: unknown) => void): this
   stats: {
     record: RecordStats
     rpc: RpcStats

package/src/client.test-d.ts

@@ -2,6 +2,7 @@
 import make, { type DeepstreamClient } from './client.js'
 import { expectAssignable, expectError, expectType } from 'tsd'
 import type { Observable } from 'rxjs'
+import type { EmptyObject } from 'type-fest'
 
 interface Records extends Record<string, unknown> {
   o: {
@@ -22,6 +23,11 @@ interface Records extends Record<string, unknown> {
       }
     }
   }
+  possiblyEmpty:
+    | {
+        pe1: string
+      }
+    | EmptyObject
   c: Circular
   m: {
     m1: string
@@ -62,7 +68,7 @@ expectAssignable<{ n0?: { n1: { n2: { n3: string } } } } | undefined>(await ds.r
 expectAssignable<{ n1: { n2: { n3: string } } } | undefined>(await ds.record.get('n', 'n0'))
 
 // set withouth path
-ds.record.set('n', {}) // empty should always work
+ds.record.set('possiblyEmpty', {}) // empty should always work
 ds.record.set('n', { n0: { n1: { n2: { n3: 'test' } } } })
 expectError(ds.record.set('n', { n0: {} })) // nested props are required
 

package/src/record/record-handler.d.ts

@@ -1,12 +1,6 @@
 import type { Observable } from 'rxjs'
 import type DsRecord from './record.js'
-import type {
-  EmptyObject,
-  Get,
-  UpdateOptions,
-  ObserveOptions,
-  ObserveOptionsWithPath,
-} from './record.js'
+import type { Get, UpdateOptions, ObserveOptions, ObserveOptionsWithPath } from './record.js'
 
 type Lookup<Table, Name> = Name extends keyof Table ? Table[Name] : unknown
 
@@ -32,8 +26,8 @@ export default class RecordHandler<Records = Record<string, unknown>> {
   }
 
   JSON: {
-    EMPTY: EmptyObject
-    EMPTY_OBJ: EmptyObject
+    EMPTY: Record<string, unknown>
+    EMPTY_OBJ: Record<string, unknown>
     EMPTY_ARR: []
   }
 
@@ -52,7 +46,7 @@ export default class RecordHandler<Records = Record<string, unknown>> {
 
   set: {
     // without path:
-    <Name extends string>(name: Name, data: Lookup<Records, Name> | EmptyObject): void
+    <Name extends string>(name: Name, data: Lookup<Records, Name>): void
 
     // with path:
     <Name extends string, Path extends string | string[]>(
@@ -67,7 +61,7 @@ export default class RecordHandler<Records = Record<string, unknown>> {
   update: {
     <Name extends string>(
       name: Name,
-      updater: (data: Lookup<Records, Name>) => Lookup<Records, Name> | EmptyObject,
+      updater: (data: Lookup<Records, Name>) => Lookup<Records, Name>,
       options?: UpdateOptions,
     ): Promise<void>
 

package/src/record/record.d.ts

@@ -1,36 +1,6 @@
 import type RecordHandler from './record-handler.js'
-import type { Get, EmptyObject, SingleKeyObject } from 'type-fest'
-export type { Get, Paths, EmptyObject } from 'type-fest'
-
-// When getting, for convenience, we say the data might be partial under some
-// circumstances.
-//
-// When you e.g. do record.get or record.update, there is always a possibility
-// that the data object is empty. The naive correct type for that would be
-// `Data | EmptyObject`. However, that forces the user to always type guard
-// against the empty object case. This type tries to allow the user to skip
-// that check in some cases, where it should be safe to do so.
-export type GettablePossibleEmpty<Data> = keyof Data extends never
-  ? EmptyObject // If there are no keys at all
-  : Partial<Data> extends Data
-    ? // All properties in Data are already optional, so we can safely return it
-      // as is. The user just need to check the properties themselves instead.
-      Data
-    : SingleKeyObject<Data> extends never
-      ? // There are more than one property in Data, and some of them are
-          // required. That means that the user must always check for the empty
-          // object case.
-          Data | EmptyObject
-      : // There is exactly one property in Data, and it is required. In this
-        // particular case, we can safely use Data as the "empty" type, but
-        // with the single property turned optional.
-        {
-          [K in keyof Data]+?: Data[K]
-        }
-
-// When setting the data must fully adhere to the Data type, or exactly an
-// empty object.
-export type SettablePossibleEmpty<Data> = Data | EmptyObject
+import type { Get } from 'type-fest'
+export type { Get, Paths } from 'type-fest'
 
 export interface WhenOptions {
   signal?: AbortSignal
@@ -86,7 +56,7 @@ export default class Record<Data = unknown> {
       dataAtPath: unknown extends Get<Data, P> ? never : Get<Data, P>,
     ): void
     // without path
-    (data: SettablePossibleEmpty<Data>): void
+    (data: Data): void
   }
 
   when: {
@@ -97,10 +67,7 @@ export default class Record<Data = unknown> {
 
   update: {
     // without path
-    (
-      updater: (data: Readonly<Data>) => SettablePossibleEmpty<Data>,
-      options?: UpdateOptions,
-    ): Promise<void>
+    (updater: (data: Readonly<Data>) => Data, options?: UpdateOptions): Promise<void>
     // with path
     <P extends string | string[]>(
       path: P,

package/src/utils/legacy-listener.js

@@ -6,6 +6,7 @@ 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
@@ -54,6 +55,11 @@ 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,6 +37,7 @@ 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
@@ -69,6 +70,11 @@ 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)