add action to inset() for use in the filter settings.

Author: Garefild

projects/angular-redux2/undo/src/components/undo-state.component.spec.ts

@@ -14,7 +14,7 @@ describe('NgUndoStateActions', () => {
             };
 
             const snapshot = 'new snapshot';
-            const nextState = undoStateActions.insert(currentState, snapshot);
+            const nextState = undoStateActions.insert({}, currentState, snapshot);
 
             expect(nextState).not.toBe(currentState);
             expect(nextState.data).toBe(currentState.data);
@@ -29,7 +29,7 @@ describe('NgUndoStateActions', () => {
             };
 
             const snapshot = undefined;
-            const nextState = undoStateActions.insert(currentState, snapshot);
+            const nextState = undoStateActions.insert({}, currentState, snapshot);
 
             expect(nextState).toBe(currentState); // Ensure the current state is returned
         });
@@ -45,7 +45,7 @@ describe('NgUndoStateActions', () => {
             const currentState = { [HISTORY_STATE_KEY]: { [key]: { past: [] } } };
             const snapshot = undefined;
             const actions = new NgUndoStateActions(key, settings);
-            const result = actions.insert(currentState, snapshot);
+            const result = actions.insert({}, currentState, snapshot);
 
 
             expect(result).toBe(currentState);
@@ -61,7 +61,7 @@ describe('NgUndoStateActions', () => {
             const currentState = { [HISTORY_STATE_KEY]: { [key]: { past: [] } } };
             const snapshot = 'snapshot';
             const actions = new NgUndoStateActions(key, settings);
-            const result = actions.insert(currentState, snapshot);
+            const result = actions.insert({}, currentState, snapshot);
 
             expect(result).toBe(currentState);
         });
@@ -85,7 +85,7 @@ describe('NgUndoStateActions', () => {
             };
 
             const actions = new NgUndoStateActions(key, settings);
-            const result = actions.insert(currentState, snapshot);
+            const result = actions.insert({}, currentState, snapshot);
 
             expect(result).toEqual(expectedState);
         });
@@ -113,7 +113,7 @@ describe('NgUndoStateActions', () => {
             };
 
             const actions = new NgUndoStateActions(key, settings);
-            const result = actions.insert(currentState, snapshot);
+            const result = actions.insert({}, currentState, snapshot);
 
             expect(result).toEqual(expectedState);
         });

projects/angular-redux2/undo/src/components/undo-state.component.ts

@@ -31,12 +31,11 @@ export class NgUndoStateActions {
     protected key: string;
 
     /**
-     *
-     * @protected
+     * Represents the settings for an undo action.
      */
 
     protected settings: {
-        filter: () => boolean;
+        filter: (action: any, currentState: any, snapshot: any) => boolean;
         path: Array<string | number>
         limit: number;
     };
@@ -71,13 +70,14 @@ export class NgUndoStateActions {
      * It adds the given snapshot to the past states of the history.
      * If the snapshot is undefined, it returns the current state unchanged.
      *
+     * @param {NgUndoAction} action - The dispatched undo action object.
      * @param {any} currentState - The current state object.
      * @param {any} snapshot - The snapshot to insert into the history.
      * @returns {any} - The state object with the snapshot inserted into the history.
      */
 
-    insert(currentState: any, snapshot: any): any {
-        if (snapshot === undefined || !this.settings.filter()) {
+    insert(action: any, currentState: any, snapshot: any): any {
+        if (snapshot === undefined || !this.settings.filter(action, currentState, snapshot)) {
             return currentState;
         }
 

projects/angular-redux2/undo/src/interfaces/undo.interface.ts

@@ -112,7 +112,7 @@ export interface NgUndoAction {
 export interface StateWatchMap {
     [key: string]: {
         path: string;
-        filter?: () => boolean;
+        filter?: (action: any, currentState: any, snapshot: any) => boolean;
         limit?: number;
     }
 }

projects/angular-redux2/undo/src/services/undo.service.spec.ts

@@ -4,7 +4,6 @@
 
 import { ngUndoMiddleware, UndoService } from './undo.service';
 import { UNDO_REDUCER_PREFIX, UndoActions } from '../interfaces/undo.interface';
-import { NgUndoStateActions } from '../components/undo-state.component';
 
 jest.mock('@angular-redux2/store', () => ({
     get: jest.fn()
@@ -26,11 +25,15 @@ describe('UndoService', () => {
     });
 
     describe('watcherState', () => {
+        const next = jest.fn();
+
+        afterEach(() => {
+            jest.resetAllMocks();
+        });
+
         test('should call watcherAction and detectChange methods', () => {
             const state = { /* mock state object */ };
             const action = { type: UNDO_REDUCER_PREFIX };
-            const next = jest.fn();
-
             const undoService = new UndoService({});
 
             (undoService as any).watcherAction = jest.fn().mockReturnValue(state);
@@ -39,7 +42,7 @@ describe('UndoService', () => {
             const updatedState = undoService.watcherState(state, action, next);
 
             expect((undoService as any).watcherAction).toHaveBeenCalledWith(state, action);
-            expect((undoService as any).detectChange).toHaveBeenCalledWith(state, next(state, action));
+            expect((undoService as any).detectChange).toHaveBeenCalledWith(action, state, next(state, action));
             expect(updatedState).toBe(state);
             expect(next).toHaveBeenCalledWith(state, action);
         });
@@ -48,8 +51,6 @@ describe('UndoService', () => {
             // Mock input data
             const state = { /* mock state object */ };
             const action = { type: 'SOME_OTHER_ACTION' };
-            const next = jest.fn();
-
             const undoService = new UndoService({});
 
             (undoService as any).watcherAction = jest.fn().mockReturnValue(state);
@@ -58,7 +59,7 @@ describe('UndoService', () => {
             const updatedState = undoService.watcherState(state, action, next);
 
             expect((undoService as any).watcherAction).not.toHaveBeenCalled();
-            expect((undoService as any).detectChange).toHaveBeenCalledWith(state, next(state, action));
+            expect((undoService as any).detectChange).toHaveBeenCalledWith(action, state, next(state, action));
             expect(updatedState).toBe(state);
             expect(next).toHaveBeenCalledWith(state, action);
         });

projects/angular-redux2/undo/src/services/undo.service.ts

@@ -66,7 +66,7 @@ export class UndoService {
             state = this.watcherAction(state, action);
         }
 
-        return this.detectChange(state, next(state, action));
+        return this.detectChange(action, state, next(state, action));
     }
 
     /**
@@ -108,20 +108,21 @@ export class UndoService {
      * Detects changes in the state and inserts snapshots into the undo history when necessary.
      *
      * @protected
+     * @param {any} action - The dispatched action object.
      * @param {any} state - The current state object.
      * @param {any} newState - The updated state object.
      * @returns {any} - The updated state with inserted snapshots.
      */
 
-    protected detectChange(state: any, newState: any): any {
+    protected detectChange(action: any, state: any, newState: any): any {
         for (const propertyName in this.watchStateMap) {
             const undoAction = this.watchStateMap[propertyName];
 
             const sliceState = get(state, undoAction.path);
             const sliceNewState = get(newState, undoAction.path);
 
             if (sliceNewState !== sliceState) {
-                newState = undoAction.insert(newState, sliceState);
+                newState = undoAction.insert(action, newState, sliceState);
             }
         }