@data-client/core 0.14.0 → 0.14.2

package/src/manager/DevtoolsManager.ts

@@ -37,6 +37,18 @@ if (process.env.NODE_ENV !== 'production') {
   DEFAULT_CONFIG = {
     name: `Data Client: ${globalThis.document?.title}`,
     autoPause: true,
+    features: {
+      pause: true, // start/pause recording of dispatched actions
+      lock: true, // lock/unlock dispatching actions and side effects
+      persist: false, // persist states on page reloading
+      export: true, // export history of actions in a file
+      import: 'custom', // import history of actions from a file
+      jump: true, // jump back and forth (time travelling)
+      skip: true, // skip (cancel) actions
+      reorder: true, // drag and drop actions in the history list
+      dispatch: false, // dispatch custom actions or action creators
+      test: false, // generate tests for the selected actions
+    },
     actionSanitizer: (action: ActionTypes) => {
       if (!('endpoint' in action)) return action;
       return {
@@ -131,6 +143,7 @@ export default class DevToolsManager implements Manager {
         const reducer = createReducer(controller as any);
         let state = controller.getState();
         return next => action => {
+          const shouldSkip = skipLogging?.(action);
           const ret = next(action);
           if (this.started) {
             // we track state changes here since getState() will only update after a batch commit
@@ -139,7 +152,7 @@ export default class DevToolsManager implements Manager {
             state = controller.getState();
           }
           ret.then(() => {
-            if (skipLogging?.(action)) return;
+            if (shouldSkip) return;
             this.handleAction(action, state.optimistic.reduce(reducer, state));
           });
           return ret;

package/src/manager/__tests__/applyManager.ts

@@ -0,0 +1,38 @@
+import Controller from '../../controller/Controller';
+import applyManager from '../applyManager';
+import NetworkManager from '../NetworkManager';
+
+function onError(e: any) {
+  e.preventDefault();
+}
+beforeEach(() => {
+  if (typeof addEventListener === 'function')
+    addEventListener('error', onError);
+});
+afterEach(() => {
+  if (typeof removeEventListener === 'function')
+    removeEventListener('error', onError);
+});
+
+it('applyManagers should console.warn() when no NetworkManager is provided', () => {
+  const warnspy = jest
+    .spyOn(global.console, 'warn')
+    .mockImplementation(() => {});
+  try {
+    applyManager([], new Controller());
+    expect(warnspy.mock.calls.length).toBe(2);
+  } finally {
+    warnspy.mockRestore();
+  }
+});
+it('applyManagers should not console.warn() when NetworkManager is provided', () => {
+  const warnspy = jest
+    .spyOn(global.console, 'warn')
+    .mockImplementation(() => {});
+  try {
+    applyManager([new NetworkManager()], new Controller());
+    expect(warnspy.mock.calls.length).toBe(0);
+  } finally {
+    warnspy.mockRestore();
+  }
+});

package/src/manager/applyManager.ts

@@ -1,3 +1,4 @@
+import NetworkManager from './NetworkManager.js';
 import type Controller from '../controller/Controller.js';
 import type { Reducer, Dispatch, ReducerState } from '../middlewareTypes.js';
 import { Manager } from '../types.js';
@@ -6,11 +7,23 @@ export default function applyManager(
   managers: Manager[],
   controller: Controller,
 ): Middleware[] {
-  return managers.map(manager => {
+  /* istanbul ignore next */
+  if (
+    process.env.NODE_ENV !== 'production' &&
+    !managers.find(mgr => mgr instanceof NetworkManager)
+  ) {
+    console.warn('NetworkManager not found; this is a required manager.');
+    console.warn(
+      'See https://dataclient.io/docs/guides/redux for hooking up redux',
+    );
+  }
+  return managers.map((manager, i) => {
     const middleware = manager.getMiddleware();
     return ({ dispatch, getState }) => {
-      (controller as any).dispatch = dispatch;
-      (controller as any).getState = getState;
+      if (i === 0) {
+        (controller as any).dispatch = dispatch;
+        (controller as any).getState = getState;
+      }
       // controller is a superset of the middleware API
       return middleware(controller as Controller<any>);
     };

package/src/manager/devtoolsTypes.ts

@@ -1,4 +1,7 @@
-type Action = any;
+import { ActionTypes } from '../actions.js';
+import { State } from '../types.js';
+
+type Action = ActionTypes;
 type ActionCreator<T> = any;
 
 // taken from https://github.com/reduxjs/redux-devtools/blob/main/packages/redux-devtools-extension/src/index.ts
@@ -78,7 +81,7 @@ export interface EnhancerOptions {
   /**
    * function which takes `state` object and index as arguments, and should return `state` object back.
    */
-  stateSanitizer?: <S>(state: S, index: number) => S;
+  stateSanitizer?: <S extends State<unknown>>(state: S, index: number) => S;
   /**
    * *string or array of strings as regex* - actions types to be hidden / shown in the monitors (while passed to the reducers).
    * If `actionsWhitelist` specified, `actionsBlacklist` is ignored.
@@ -105,7 +108,10 @@ export interface EnhancerOptions {
    * called for every action before sending, takes `state` and `action` object, and returns `true` in case it allows sending the current data to the monitor.
    * Use it as a more advanced version of `actionsDenylist`/`actionsAllowlist` parameters.
    */
-  predicate?: <S, A extends Action>(state: S, action: A) => boolean;
+  predicate?: <S extends State<unknown>, A extends Action>(
+    state: S,
+    action: A,
+  ) => boolean;
   /**
    * if specified as `false`, it will not record the changes till clicking on `Start recording` button.
    * Available only for Redux enhancer, for others use `autoPause`.

package/src/state/__tests__/reducer.ts

@@ -595,7 +595,7 @@ describe('reducer', () => {
     const newState = reducer(iniState, action);
     expect(newState.entities).toBe(iniState.entities);
   });
-  it('rdc/fetch should console.warn()', () => {
+  it('rdc/fetch should not console.warn()', () => {
     const warnspy = jest
       .spyOn(global.console, 'warn')
       .mockImplementation(() => {});
@@ -618,7 +618,8 @@ describe('reducer', () => {
       };
       const newState = reducer(iniState, action);
       expect(newState).toBe(iniState);
-      expect(warnspy.mock.calls.length).toBe(2);
+      // moved warns to applyManager() vv
+      expect(warnspy.mock.calls.length).toBe(0);
     } finally {
       warnspy.mockRestore();
     }

package/src/state/reducer/fetchReducer.ts

@@ -12,18 +12,6 @@ export function fetchReducer(state: State<unknown>, action: FetchAction) {
       ...state,
       optimistic: [...state.optimistic, setAction],
     };
-  } else {
-    // If 'fetch' action reaches the reducer there are no middlewares installed to handle it
-    /* istanbul ignore next */
-    if (process.env.NODE_ENV !== 'production') {
-      console.warn(
-        'Fetch appears unhandled - you are likely missing the NetworkManager middleware',
-      );
-      console.warn(
-        'See https://dataclient.io/docs/guides/redux for hooking up redux',
-      );
-    }
-
-    return state;
   }
+  return state;
 }

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

@@ -1,4 +1,6 @@
-type Action = any;
+import { ActionTypes } from '../actions.js';
+import { State } from '../types.js';
+type Action = ActionTypes;
 type ActionCreator<T> = any;
 export interface EnhancerOptions {
     /**
@@ -72,7 +74,7 @@ export interface EnhancerOptions {
     /**
      * function which takes `state` object and index as arguments, and should return `state` object back.
      */
-    stateSanitizer?: <S>(state: S, index: number) => S;
+    stateSanitizer?: <S extends State<unknown>>(state: S, index: number) => S;
     /**
      * *string or array of strings as regex* - actions types to be hidden / shown in the monitors (while passed to the reducers).
      * If `actionsWhitelist` specified, `actionsBlacklist` is ignored.
@@ -99,7 +101,7 @@ export interface EnhancerOptions {
      * called for every action before sending, takes `state` and `action` object, and returns `true` in case it allows sending the current data to the monitor.
      * Use it as a more advanced version of `actionsDenylist`/`actionsAllowlist` parameters.
      */
-    predicate?: <S, A extends Action>(state: S, action: A) => boolean;
+    predicate?: <S extends State<unknown>, A extends Action>(state: S, action: A) => boolean;
     /**
      * if specified as `false`, it will not record the changes till clicking on `Start recording` button.
      * Available only for Redux enhancer, for others use `autoPause`.

package/ts3.4/state/reducer/setReducer.d.ts

@@ -1,4 +1,29 @@
 import Controller from '../../controller/Controller.js';
 import { State, SetAction } from '../../types.js';
-export declare function setReducer(state: State<unknown>, action: SetAction, controller: Controller): State<unknown>;
+export declare function setReducer(state: State<unknown>, action: SetAction, controller: Controller): State<unknown> | {
+    entities: {
+        [x: string]: any;
+    };
+    indexes: import("@data-client/normalizr").NormalizedIndex;
+    endpoints: {
+        readonly [key: string]: unknown;
+    };
+    entityMeta: import("packages/normalizr/lib/types.js").EntitiesToMeta<{
+        [x: string]: any;
+    }>;
+    meta: {
+        readonly [key: string]: {
+            readonly date: number;
+            readonly expiresAt: number;
+            readonly prevExpiresAt?: number;
+            readonly error?: import("@data-client/normalizr").ErrorTypes;
+            readonly invalidated?: boolean;
+            readonly errorPolicy?: "hard" | "soft" | undefined;
+        };
+    };
+    optimistic: (import("../../actions.js").SetResponseAction | import("../../actions.js").OptimisticAction<import("@data-client/normalizr").EndpointInterface<import("@data-client/normalizr").FetchFunction, import("@data-client/normalizr").Schema | undefined, boolean | undefined> & {
+        update?: import("../../index.js").EndpointUpdateFunction<import("@data-client/normalizr").EndpointInterface>;
+    }>)[];
+    lastReset: number;
+};
 //# sourceMappingURL=setReducer.d.ts.map

package/ts3.4/state/reducer/setResponseReducer.d.ts

@@ -1,4 +1,31 @@
 import Controller from '../../controller/Controller.js';
 import { State, SetResponseAction, OptimisticAction } from '../../types.js';
-export declare function setResponseReducer(state: State<unknown>, action: OptimisticAction | SetResponseAction, controller: Controller): State<unknown>;
+export declare function setResponseReducer(state: State<unknown>, action: OptimisticAction | SetResponseAction, controller: Controller): State<unknown> | {
+    entities: {
+        [x: string]: any;
+    };
+    indexes: import("@data-client/normalizr").NormalizedIndex;
+    endpoints: Record<string, unknown>;
+    entityMeta: import("packages/normalizr/lib/types.js").EntitiesToMeta<{
+        [x: string]: any;
+    }>;
+    meta: {
+        [x: string]: {
+            readonly date: number;
+            readonly expiresAt: number;
+            readonly prevExpiresAt?: number;
+            readonly error?: import("@data-client/normalizr").ErrorTypes;
+            readonly invalidated?: boolean;
+            readonly errorPolicy?: "hard" | "soft" | undefined;
+        } | {
+            date: number;
+            expiresAt: number;
+            prevExpiresAt: number;
+        };
+    };
+    optimistic: (SetResponseAction | OptimisticAction<import("@data-client/normalizr").EndpointInterface<import("@data-client/normalizr").FetchFunction, import("@data-client/normalizr").Schema | undefined, boolean | undefined> & {
+        update?: import("../../index.js").EndpointUpdateFunction<import("@data-client/normalizr").EndpointInterface>;
+    }>)[];
+    lastReset: number;
+};
 //# sourceMappingURL=setResponseReducer.d.ts.map