feat(entity): add support for predicate to updateMany (#907)

Author: timdeschryver

modules/entity/spec/sorted_state_adapter.spec.ts

@@ -280,7 +280,7 @@ describe('Sorted State Adapter', () => {
     });
   });
 
-  it('should let you update many entities in the state', () => {
+  it('should let you update many entities by id in the state', () => {
     const firstChange = { title: 'Zack' };
     const secondChange = { title: 'Aaron' };
     const withMany = adapter.addAll([TheGreatGatsby, AClockworkOrange], state);
@@ -308,6 +308,41 @@ describe('Sorted State Adapter', () => {
     });
   });
 
+  it('should let you map over entities in the state', () => {
+    const firstChange = { ...TheGreatGatsby, title: 'First change' };
+    const secondChange = { ...AClockworkOrange, title: 'Second change' };
+
+    const withMany = adapter.addAll(
+      [TheGreatGatsby, AClockworkOrange, AnimalFarm],
+      state
+    );
+
+    const withUpdates = adapter.map(
+      book =>
+        book.title === TheGreatGatsby.title
+          ? firstChange
+          : book.title === AClockworkOrange.title
+            ? secondChange
+            : book,
+      withMany
+    );
+
+    expect(withUpdates).toEqual({
+      ids: [AnimalFarm.id, TheGreatGatsby.id, AClockworkOrange.id],
+      entities: {
+        [AnimalFarm.id]: AnimalFarm,
+        [TheGreatGatsby.id]: {
+          ...TheGreatGatsby,
+          ...firstChange,
+        },
+        [AClockworkOrange.id]: {
+          ...AClockworkOrange,
+          ...secondChange,
+        },
+      },
+    });
+  });
+
   it('should let you add one entity to the state with upsert()', () => {
     const withOneEntity = adapter.upsertOne(TheGreatGatsby, state);
     expect(withOneEntity).toEqual({

modules/entity/spec/unsorted_state_adapter.spec.ts

@@ -220,7 +220,7 @@ describe('Unsorted State Adapter', () => {
     });
   });
 
-  it('should let you update many entities in the state', () => {
+  it('should let you update many entities by id in the state', () => {
     const firstChange = { title: 'First Change' };
     const secondChange = { title: 'Second Change' };
     const withMany = adapter.addAll([TheGreatGatsby, AClockworkOrange], state);
@@ -248,6 +248,41 @@ describe('Unsorted State Adapter', () => {
     });
   });
 
+  it('should let you map over entities in the state', () => {
+    const firstChange = { ...TheGreatGatsby, title: 'First change' };
+    const secondChange = { ...AClockworkOrange, title: 'Second change' };
+
+    const withMany = adapter.addAll(
+      [TheGreatGatsby, AClockworkOrange, AnimalFarm],
+      state
+    );
+
+    const withUpdates = adapter.map(
+      book =>
+        book.title === TheGreatGatsby.title
+          ? firstChange
+          : book.title === AClockworkOrange.title
+            ? secondChange
+            : book,
+      withMany
+    );
+
+    expect(withUpdates).toEqual({
+      ids: [TheGreatGatsby.id, AClockworkOrange.id, AnimalFarm.id],
+      entities: {
+        [TheGreatGatsby.id]: {
+          ...TheGreatGatsby,
+          ...firstChange,
+        },
+        [AClockworkOrange.id]: {
+          ...AClockworkOrange,
+          ...secondChange,
+        },
+        [AnimalFarm.id]: AnimalFarm,
+      },
+    });
+  });
+
   it('should let you add one entity to the state with upsert()', () => {
     const withOneEntity = adapter.upsertOne(TheGreatGatsby, state);
     expect(withOneEntity).toEqual({

modules/entity/src/index.ts

@@ -1,2 +1,9 @@
 export { createEntityAdapter } from './create_adapter';
-export { Dictionary, EntityState, EntityAdapter, Update } from './models';
+export {
+  Dictionary,
+  EntityState,
+  EntityAdapter,
+  Update,
+  EntityMap,
+  Predicate,
+} from './models';

modules/entity/src/models.ts

@@ -30,6 +30,8 @@ export type Update<T> = UpdateStr<T> | UpdateNum<T>;
 
 export type Predicate<T> = (entity: T) => boolean;
 
+export type EntityMap<T> = (entity: T) => T;
+
 export interface EntityState<T> {
   ids: string[] | number[];
   entities: Dictionary<T>;
@@ -59,6 +61,8 @@ export interface EntityStateAdapter<T> {
 
   upsertOne<S extends EntityState<T>>(entity: T, state: S): S;
   upsertMany<S extends EntityState<T>>(entities: T[], state: S): S;
+
+  map<S extends EntityState<T>>(map: EntityMap<T>, state: S): S;
 }
 
 export interface EntitySelectors<T, V> {

modules/entity/src/sorted_state_adapter.ts

@@ -2,9 +2,9 @@ import {
   EntityState,
   IdSelector,
   Comparer,
-  Dictionary,
   EntityStateAdapter,
   Update,
+  EntityMap,
 } from './models';
 import { createStateOperator, DidMutate } from './state_adapter';
 import { createUnsortedStateAdapter } from './unsorted_state_adapter';
@@ -107,6 +107,22 @@ export function createSortedStateAdapter<T>(selectId: any, sort: any): any {
     }
   }
 
+  function mapMutably(map: EntityMap<T>, state: R): DidMutate;
+  function mapMutably(updatesOrMap: any, state: any): DidMutate {
+    const updates: Update<T>[] = state.ids.reduce(
+      (changes: any[], id: string | number) => {
+        const change = updatesOrMap(state.entities[id]);
+        if (change !== state.entities[id]) {
+          changes.push({ id, changes: change });
+        }
+        return changes;
+      },
+      []
+    );
+
+    return updateManyMutably(updates, state);
+  }
+
   function upsertOneMutably(entity: T, state: R): DidMutate;
   function upsertOneMutably(entity: any, state: any): DidMutate {
     return upsertManyMutably([entity], state);
@@ -187,5 +203,6 @@ export function createSortedStateAdapter<T>(selectId: any, sort: any): any {
     addMany: createStateOperator(addManyMutably),
     updateMany: createStateOperator(updateManyMutably),
     upsertMany: createStateOperator(upsertManyMutably),
+    map: createStateOperator(mapMutably),
   };
 }

modules/entity/src/state_adapter.ts

@@ -1,4 +1,4 @@
-import { EntityState, EntityStateAdapter } from './models';
+import { EntityState } from './models';
 
 export enum DidMutate {
   EntitiesOnly,

modules/entity/src/unsorted_state_adapter.ts

@@ -4,6 +4,7 @@ import {
   IdSelector,
   Update,
   Predicate,
+  EntityMap,
 } from './models';
 import { createStateOperator, DidMutate } from './state_adapter';
 import { selectIdValue } from './utils';
@@ -138,6 +139,23 @@ export function createUnsortedStateAdapter<T>(selectId: IdSelector<T>): any {
     return DidMutate.None;
   }
 
+  function mapMutably(map: EntityMap<T>, state: R): DidMutate;
+  function mapMutably(map: any, state: any): DidMutate {
+    const changes: Update<T>[] = state.ids.reduce(
+      (changes: any[], id: string | number) => {
+        const change = map(state.entities[id]);
+        if (change !== state.entities[id]) {
+          changes.push({ id, changes: change });
+        }
+        return changes;
+      },
+      []
+    );
+    const updates = changes.filter(({ id }) => id in state.entities);
+
+    return updateManyMutably(updates, state);
+  }
+
   function upsertOneMutably(entity: T, state: R): DidMutate;
   function upsertOneMutably(entity: any, state: any): DidMutate {
     return upsertManyMutably([entity], state);
@@ -183,5 +201,6 @@ export function createUnsortedStateAdapter<T>(selectId: IdSelector<T>): any {
     upsertMany: createStateOperator(upsertManyMutably),
     removeOne: createStateOperator(removeOneMutably),
     removeMany: createStateOperator(removeManyMutably),
+    map: createStateOperator(mapMutably),
   };
 }