@data-client/core 0.15.3 → 0.15.7

package/src/controller/Controller.ts

@@ -40,7 +40,7 @@ import type { GCInterface } from '../state/GCPolicy.js';
 import { ImmortalGCPolicy } from '../state/GCPolicy.js';
 import { initialState } from '../state/reducer/createReducer.js';
 import selectMeta from '../state/selectMeta.js';
-import type { ActionTypes, Dispatch, State } from '../types.js';
+import type { ActionTypes, State } from '../types.js';
 
 export type GenericDispatch = (value: any) => Promise<void>;
 export type DataClientDispatch = (value: ActionTypes) => Promise<void>;
@@ -496,12 +496,7 @@ export default class Controller<
     expiresAt: number;
     countRef: () => () => void;
   } {
-    const state = rest[rest.length - 1] as State<unknown>;
-    // this is typescript generics breaking
-    const args: any = rest
-      .slice(0, rest.length - 1)
-      // handle FormData
-      .map(ensurePojo);
+    const [state, args] = extractStateAndArgs(rest);
     const isActive = args.length !== 1 || args[0] !== null;
     const key = isActive ? endpoint.key(...args) : '';
     const cacheEndpoints = isActive ? state.endpoints[key] : undefined;
@@ -581,11 +576,7 @@ export default class Controller<
       Pick<State<unknown>, 'entities' | 'indexes'>,
     ]
   ): DenormalizeNullable<S> | undefined {
-    const state = rest[rest.length - 1] as State<any>;
-    // this is typescript generics breaking
-    const args: any = rest
-      .slice(0, rest.length - 1)
-      .map(ensurePojo) as SchemaArgs<S>;
+    const [state, args] = extractStateAndArgs(rest);
 
     const { data } = this.memo.query(schema, args, state);
     return typeof data === 'symbol' ? undefined : data;
@@ -605,11 +596,7 @@ export default class Controller<
     data: DenormalizeNullable<S> | undefined;
     countRef: () => () => void;
   } {
-    const state = rest[rest.length - 1] as State<any>;
-    // this is typescript generics breaking
-    const args: any = rest
-      .slice(0, rest.length - 1)
-      .map(ensurePojo) as SchemaArgs<S>;
+    const [state, args] = extractStateAndArgs(rest);
 
     const { data, paths } = this.memo.query(schema, args, state);
 
@@ -823,3 +810,15 @@ class Snapshot<T = unknown> implements SnapshotInterface {
     return this.controller.getQueryMeta(schema, ...args, this.state);
   }
 }
+
+/** Extract state and args from rest params, applying ensurePojo to args */
+function extractStateAndArgs(rest: readonly unknown[]): [State<any>, any[]] {
+  const l = rest.length;
+  const args: any = new Array(l - 1);
+  for (let i = 0; i < l - 1; i++) {
+    // handle FormData
+    args[i] = ensurePojo(rest[i]);
+  }
+  // this is typescript generics breaking
+  return [rest[l - 1] as State<any>, args];
+}

package/src/controller/__tests__/get.ts

@@ -1,4 +1,4 @@
-import { Entity, schema } from '@data-client/endpoint';
+import { Entity, Collection, All, Query, Union } from '@data-client/endpoint';
 
 import { initialState } from '../../state/reducer/createReducer';
 import { State } from '../../types';
@@ -8,7 +8,7 @@ class Tacos extends Entity {
   type = '';
   id = '';
 }
-const TacoList = new schema.Collection([Tacos]);
+const TacoList = new Collection([Tacos]);
 const entities = {
   Tacos: {
     1: { id: '1', type: 'foo' },
@@ -188,7 +188,7 @@ describe('Controller.get()', () => {
       ...initialState,
       entities,
     };
-    const AllTacos = new schema.All(Tacos);
+    const AllTacos = new All(Tacos);
 
     it('should get all entities', () => {
       const allTacos = controller.get(AllTacos, state);
@@ -229,8 +229,8 @@ describe('Controller.get()', () => {
       ...initialState,
       entities,
     };
-    const queryTacos = new schema.Query(
-      new schema.All(Tacos),
+    const queryTacos = new Query(
+      new All(Tacos),
       (tacos, { type }: { type?: string } = {}) => {
         if (!type) return tacos;
         return tacos.filter(taco => taco.type === type);
@@ -281,7 +281,7 @@ describe('Controller.get()', () => {
       ...initialState,
       entities,
     };
-    const tacoCount = new schema.Query(TacoList, tacos => {
+    const tacoCount = new Query(TacoList, tacos => {
       return tacos.length ?? 0;
     });
 
@@ -303,7 +303,7 @@ describe('Controller.get()', () => {
       groupname: string = '';
       memberCount = 0;
     }
-    const queryPerson = new schema.Union(
+    const queryPerson = new Union(
       {
         users: User,
         groups: Group,
@@ -363,7 +363,7 @@ describe('Controller.get()', () => {
       groupname: string = '';
       memberCount = 0;
     }
-    const queryPerson = new schema.Union(
+    const queryPerson = new Union(
       {
         users: User,
         groups: Group,

package/src/controller/actions/createOptimistic.ts

@@ -3,6 +3,7 @@ import type { EndpointInterface } from '@data-client/normalizr';
 import { createMeta } from './createMeta.js';
 import { OPTIMISTIC } from '../../actionTypes.js';
 import type { OptimisticAction } from '../../types.js';
+import ensurePojo from '../ensurePojo.js';
 import type { EndpointUpdateFunction } from '../types.js';
 
 export function createOptimistic<
@@ -25,7 +26,7 @@ export function createOptimistic<
   return {
     type: OPTIMISTIC,
     key: endpoint.key(...args),
-    args,
+    args: args.map(ensurePojo),
     endpoint,
     meta: createMeta(endpoint.dataExpiryLength ?? 60000, fetchedAt),
   };

package/src/manager/ConnectionListener.ts

@@ -1,7 +1,19 @@
+/** Listens to online/offline events for triggering re-fetches on reconnect.
+ *
+ * Implement this interface to provide custom connectivity detection
+ * (e.g., for React Native or Node.js environments).
+ *
+ * @see https://dataclient.io/docs/api/PollingSubscription
+ */
 export default interface ConnectionListener {
+  /** Returns whether the client is currently connected to the network. */
   isOnline: () => boolean;
+  /** Register a handler to be called when the client comes back online. */
   addOnlineListener: (handler: () => void) => void;
+  /** Remove a previously registered online handler. */
   removeOnlineListener: (handler: () => void) => void;
+  /** Register a handler to be called when the client goes offline. */
   addOfflineListener: (handler: () => void) => void;
+  /** Remove a previously registered offline handler. */
   removeOfflineListener: (handler: () => void) => void;
 }

package/src/manager/NetworkManager.ts

@@ -251,7 +251,7 @@ export default class NetworkManager implements Manager {
    * create a new promise and call fetch.
    *
    * Note: The new promise is not actually tied to fetch at all,
-   * but is resolved when the expected 'recieve' action is processed.
+   * but is resolved when the expected 'receive' action is processed.
    * This ensures promises are resolved only once their data is processed
    * by the reducer.
    */

package/src/state/reducer/setResponseReducer.ts

@@ -62,9 +62,7 @@ export function setResponseReducer(
       // no reason to completely fail because of user-code error
       // integrity of this state update is still guaranteed
     } catch (error) {
-      console.error(
-        `The following error occured during Endpoint.update() for ${action.key}`,
-      );
+      console.error(`Endpoint.update() error: ${action.key}`);
       console.error(error);
     }
     return {

package/ts3.4/manager/ConnectionListener.d.ts

@@ -1,8 +1,20 @@
+/** Listens to online/offline events for triggering re-fetches on reconnect.
+ *
+ * Implement this interface to provide custom connectivity detection
+ * (e.g., for React Native or Node.js environments).
+ *
+ * @see https://dataclient.io/docs/api/PollingSubscription
+ */
 export default interface ConnectionListener {
+    /** Returns whether the client is currently connected to the network. */
     isOnline: () => boolean;
+    /** Register a handler to be called when the client comes back online. */
     addOnlineListener: (handler: () => void) => void;
+    /** Remove a previously registered online handler. */
     removeOnlineListener: (handler: () => void) => void;
+    /** Register a handler to be called when the client goes offline. */
     addOfflineListener: (handler: () => void) => void;
+    /** Remove a previously registered offline handler. */
     removeOfflineListener: (handler: () => void) => void;
 }
 //# sourceMappingURL=ConnectionListener.d.ts.map

package/ts3.4/manager/NetworkManager.d.ts

@@ -62,7 +62,7 @@ export default class NetworkManager implements Manager {
      * create a new promise and call fetch.
      *
      * Note: The new promise is not actually tied to fetch at all,
-     * but is resolved when the expected 'recieve' action is processed.
+     * but is resolved when the expected 'receive' action is processed.
      * This ensures promises are resolved only once their data is processed
      * by the reducer.
      */