Skip to content

Commit 0106e93

Browse files
markostanimirovicmarkostanimirovic
authoredJul 1, 2024··
fix(signals): allow modifying entity id on update (#4404)
·
signals-18.0.018.0.2
1 parent 1b1cf5b commit 0106e93

File tree

8 files changed

+591
-52
lines changed

8 files changed

+591
-52
lines changed
 

‎modules/signals/entities/spec/updaters/update-all-entities.spec.ts

+12-3
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,10 @@ describe('updateAllEntities', () => {
5151

5252
patchState(
5353
store,
54-
updateAllEntities({ text: '' }),
55-
updateAllEntities((todo) => ({ completed: !todo.completed }))
54+
updateAllEntities({ text: '' }, { selectId: (todo) => todo._id }),
55+
updateAllEntities((todo) => ({ completed: !todo.completed }), {
56+
selectId: (todo) => todo._id,
57+
})
5658
);
5759

5860
expect(store.entityMap()).toBe(entityMap);
@@ -79,7 +81,13 @@ describe('updateAllEntities', () => {
7981
collection: 'todo',
8082
selectId: selectTodoId,
8183
}),
82-
updateAllEntities({ completed: false }, { collection: 'todo' })
84+
updateAllEntities(
85+
{ completed: false },
86+
{
87+
collection: 'todo',
88+
selectId: (todo) => todo._id,
89+
}
90+
)
8391
);
8492

8593
expect(store.todoEntityMap()).toEqual({
@@ -98,6 +106,7 @@ describe('updateAllEntities', () => {
98106
store,
99107
updateAllEntities(({ completed }) => ({ completed: !completed }), {
100108
collection: 'todo',
109+
selectId: (todo) => todo._id,
101110
})
102111
);
103112

‎modules/signals/entities/spec/updaters/update-entities.spec.ts

+239-8
Original file line numberDiff line numberDiff line change
@@ -50,14 +50,20 @@ describe('updateEntities', () => {
5050

5151
patchState(
5252
store,
53-
updateEntities({
54-
predicate: (todo) => todo.text.startsWith('Buy'),
55-
changes: { completed: false },
56-
}),
57-
updateEntities({
58-
predicate: ({ completed }) => !completed,
59-
changes: ({ text }) => ({ text: `Don't ${text}` }),
60-
})
53+
updateEntities(
54+
{
55+
predicate: (todo) => todo.text.startsWith('Buy'),
56+
changes: { completed: false },
57+
},
58+
{ selectId: (todo) => todo._id }
59+
),
60+
updateEntities(
61+
{
62+
predicate: ({ completed }) => !completed,
63+
changes: ({ text }) => ({ text: `Don't ${text}` }),
64+
},
65+
{ selectId: (todo) => todo._id }
66+
)
6167
);
6268

6369
expect(store.entityMap()).toEqual({
@@ -228,4 +234,229 @@ describe('updateEntities', () => {
228234
expect(store.todoIds()).toEqual(['x', 'y', 'z']);
229235
expect(store.todoEntities()).toEqual([todo1, todo2, todo3]);
230236
});
237+
238+
it('updates entity ids', () => {
239+
const Store = signalStore(withEntities<User>());
240+
const store = new Store();
241+
242+
patchState(
243+
store,
244+
addEntities([user1, user2, user3]),
245+
updateEntities({
246+
ids: [user1.id, user2.id],
247+
changes: ({ id }) => ({ id: id + 10, firstName: `Jimmy${id}` }),
248+
}),
249+
updateEntities({
250+
ids: [user3.id],
251+
changes: { id: 303, lastName: 'Hendrix' },
252+
})
253+
);
254+
255+
expect(store.entityMap()).toEqual({
256+
11: { ...user1, id: 11, firstName: 'Jimmy1' },
257+
12: { ...user2, id: 12, firstName: 'Jimmy2' },
258+
303: { ...user3, id: 303, lastName: 'Hendrix' },
259+
});
260+
expect(store.ids()).toEqual([11, 12, 303]);
261+
262+
patchState(
263+
store,
264+
updateEntities({
265+
predicate: ({ id }) => id > 300,
266+
changes: ({ id }) => ({ id: id - 300 }),
267+
}),
268+
updateEntities({
269+
predicate: ({ firstName }) => firstName === 'Jimmy1',
270+
changes: { id: 1, firstName: 'Jimmy' },
271+
})
272+
);
273+
274+
expect(store.entityMap()).toEqual({
275+
1: { ...user1, id: 1, firstName: 'Jimmy' },
276+
12: { ...user2, id: 12, firstName: 'Jimmy2' },
277+
3: { ...user3, id: 3, lastName: 'Hendrix' },
278+
});
279+
expect(store.ids()).toEqual([1, 12, 3]);
280+
});
281+
282+
it('updates custom entity ids', () => {
283+
const Store = signalStore(withEntities<Todo>());
284+
const store = new Store();
285+
286+
patchState(
287+
store,
288+
addEntities([todo1, todo2, todo3], { selectId: (todo) => todo._id }),
289+
updateEntities(
290+
{
291+
ids: [todo1._id, todo2._id],
292+
changes: ({ _id }) => ({ _id: _id + 10, text: `Todo ${_id}` }),
293+
},
294+
{ selectId: (todo) => todo._id }
295+
),
296+
updateEntities(
297+
{
298+
ids: [todo3._id],
299+
changes: { _id: 'z30' },
300+
},
301+
{ selectId: (todo) => todo._id }
302+
)
303+
);
304+
305+
expect(store.entityMap()).toEqual({
306+
x10: { ...todo1, _id: 'x10', text: 'Todo x' },
307+
y10: { ...todo2, _id: 'y10', text: 'Todo y' },
308+
z30: { ...todo3, _id: 'z30' },
309+
});
310+
expect(store.ids()).toEqual(['x10', 'y10', 'z30']);
311+
312+
patchState(
313+
store,
314+
updateEntities(
315+
{
316+
predicate: ({ text }) => text.startsWith('Todo '),
317+
changes: ({ _id }) => ({ _id: `${_id}0` }),
318+
},
319+
{ selectId: (todo) => todo._id }
320+
),
321+
updateEntities(
322+
{
323+
predicate: ({ _id }) => _id === 'z30',
324+
changes: { _id: 'z' },
325+
},
326+
{ selectId: (todo) => todo._id }
327+
)
328+
);
329+
330+
expect(store.entityMap()).toEqual({
331+
x100: { ...todo1, _id: 'x100', text: 'Todo x' },
332+
y100: { ...todo2, _id: 'y100', text: 'Todo y' },
333+
z: { ...todo3, _id: 'z' },
334+
});
335+
expect(store.ids()).toEqual(['x100', 'y100', 'z']);
336+
});
337+
338+
it('updates entity ids from specified collection', () => {
339+
const Store = signalStore(
340+
withEntities({
341+
entity: type<User>(),
342+
collection: 'user',
343+
})
344+
);
345+
const store = new Store();
346+
347+
patchState(
348+
store,
349+
addEntities([user1, user2, user3], { collection: 'user' }),
350+
updateEntities(
351+
{
352+
ids: [user1.id, user2.id],
353+
changes: ({ id }) => ({ id: id + 100, firstName: `Jimmy${id}` }),
354+
},
355+
{ collection: 'user' }
356+
),
357+
updateEntities(
358+
{
359+
ids: [user3.id],
360+
changes: { id: 303, lastName: 'Hendrix' },
361+
},
362+
{ collection: 'user' }
363+
)
364+
);
365+
366+
expect(store.userEntityMap()).toEqual({
367+
101: { ...user1, id: 101, firstName: 'Jimmy1' },
368+
102: { ...user2, id: 102, firstName: 'Jimmy2' },
369+
303: { ...user3, id: 303, lastName: 'Hendrix' },
370+
});
371+
expect(store.userIds()).toEqual([101, 102, 303]);
372+
373+
patchState(
374+
store,
375+
updateEntities(
376+
{
377+
predicate: ({ id }) => id > 300,
378+
changes: ({ id }) => ({ id: id - 300 }),
379+
},
380+
{ collection: 'user' }
381+
),
382+
updateEntities(
383+
{
384+
predicate: ({ firstName }) => firstName === 'Jimmy1',
385+
changes: { id: 1, firstName: 'Jimmy' },
386+
},
387+
{ collection: 'user' }
388+
)
389+
);
390+
391+
expect(store.userEntityMap()).toEqual({
392+
1: { ...user1, id: 1, firstName: 'Jimmy' },
393+
102: { ...user2, id: 102, firstName: 'Jimmy2' },
394+
3: { ...user3, id: 3, lastName: 'Hendrix' },
395+
});
396+
expect(store.userIds()).toEqual([1, 102, 3]);
397+
});
398+
399+
it('updates custom entity ids from specified collection', () => {
400+
const Store = signalStore(
401+
withEntities({
402+
entity: type<Todo>(),
403+
collection: 'todo',
404+
})
405+
);
406+
const store = new Store();
407+
408+
patchState(
409+
store,
410+
addEntities([todo1, todo2, todo3], {
411+
collection: 'todo',
412+
selectId: (todo) => todo._id,
413+
}),
414+
updateEntities(
415+
{
416+
ids: [todo1._id, todo2._id],
417+
changes: ({ _id }) => ({ _id: _id + 10, text: `Todo ${_id}` }),
418+
},
419+
{ collection: 'todo', selectId: (todo) => todo._id }
420+
),
421+
updateEntities(
422+
{
423+
ids: [todo3._id],
424+
changes: { _id: 'z30' },
425+
},
426+
{ collection: 'todo', selectId: (todo) => todo._id }
427+
)
428+
);
429+
430+
expect(store.todoEntityMap()).toEqual({
431+
x10: { ...todo1, _id: 'x10', text: 'Todo x' },
432+
y10: { ...todo2, _id: 'y10', text: 'Todo y' },
433+
z30: { ...todo3, _id: 'z30' },
434+
});
435+
expect(store.todoIds()).toEqual(['x10', 'y10', 'z30']);
436+
437+
patchState(
438+
store,
439+
updateEntities(
440+
{
441+
predicate: ({ text }) => text.startsWith('Todo '),
442+
changes: ({ _id }) => ({ _id: `${_id}0` }),
443+
},
444+
{ collection: 'todo', selectId: (todo) => todo._id }
445+
),
446+
updateEntities(
447+
{
448+
predicate: ({ _id }) => _id === 'z30',
449+
changes: { _id: 'z' },
450+
},
451+
{ collection: 'todo', selectId: (todo) => todo._id }
452+
)
453+
);
454+
455+
expect(store.todoEntityMap()).toEqual({
456+
x100: { ...todo1, _id: 'x100', text: 'Todo x' },
457+
y100: { ...todo2, _id: 'y100', text: 'Todo y' },
458+
z: { ...todo3, _id: 'z' },
459+
});
460+
expect(store.todoIds()).toEqual(['x100', 'y100', 'z']);
461+
});
231462
});

‎modules/signals/entities/spec/updaters/update-entity.spec.ts

+165-10
Original file line numberDiff line numberDiff line change
@@ -76,14 +76,20 @@ describe('updateEntity', () => {
7676

7777
patchState(
7878
store,
79-
updateEntity({
80-
id: todo1._id,
81-
changes: { text: '' },
82-
}),
83-
updateEntity({
84-
id: 'a',
85-
changes: ({ completed }) => ({ completed: !completed }),
86-
})
79+
updateEntity(
80+
{
81+
id: todo1._id,
82+
changes: { text: '' },
83+
},
84+
todoConfig
85+
),
86+
updateEntity(
87+
{
88+
id: 'a',
89+
changes: ({ completed }) => ({ completed: !completed }),
90+
},
91+
todoConfig
92+
)
8793
);
8894

8995
expect(store.entityMap()).toBe(entityMap);
@@ -112,14 +118,14 @@ describe('updateEntity', () => {
112118
}),
113119
updateEntity(
114120
{ id: todo1._id, changes: { text: '' } },
115-
{ collection: 'todo' }
121+
{ collection: 'todo', selectId: selectTodoId }
116122
),
117123
updateEntity(
118124
{
119125
id: todo2._id,
120126
changes: ({ completed }) => ({ completed: !completed }),
121127
},
122-
{ collection: 'todo' }
128+
{ collection: 'todo', selectId: (todo) => todo._id }
123129
)
124130
);
125131

@@ -172,4 +178,153 @@ describe('updateEntity', () => {
172178
expect(store.userIds()).toEqual([1, 2, 3]);
173179
expect(store.userEntities()).toEqual([user1, user2, user3]);
174180
});
181+
182+
it('updates an entity id', () => {
183+
const Store = signalStore(withEntities<User>());
184+
const store = new Store();
185+
186+
patchState(
187+
store,
188+
addEntities([user1, user2, user3]),
189+
updateEntity({
190+
id: user1.id,
191+
changes: ({ id }) => ({ id: id + 10 }),
192+
})
193+
);
194+
195+
expect(store.entityMap()).toEqual({
196+
11: { ...user1, id: 11 },
197+
2: user2,
198+
3: user3,
199+
});
200+
expect(store.ids()).toEqual([11, 2, 3]);
201+
expect(store.entities()).toEqual([{ ...user1, id: 11 }, user2, user3]);
202+
203+
patchState(
204+
store,
205+
updateEntity({
206+
id: 11,
207+
changes: { id: 101, firstName: 'Jimmy1' },
208+
}),
209+
updateEntity({
210+
id: user3.id,
211+
changes: ({ id }) => ({ id: 303, firstName: `Stevie${id}` }),
212+
})
213+
);
214+
215+
expect(store.entityMap()).toEqual({
216+
101: { ...user1, id: 101, firstName: 'Jimmy1' },
217+
2: user2,
218+
303: { ...user3, id: 303, firstName: 'Stevie3' },
219+
});
220+
expect(store.ids()).toEqual([101, 2, 303]);
221+
});
222+
223+
it('updates a custom entity id', () => {
224+
const Store = signalStore(withEntities<Todo>());
225+
const store = new Store();
226+
227+
patchState(
228+
store,
229+
addEntities([todo1, todo2, todo3], {
230+
selectId: (todo) => todo._id,
231+
}),
232+
updateEntity(
233+
{
234+
id: todo2._id,
235+
changes: ({ _id, text }) => ({ _id: _id + 200, text: `${text} 200` }),
236+
},
237+
{ selectId: (todo) => todo._id }
238+
),
239+
updateEntity(
240+
{
241+
id: todo3._id,
242+
changes: { _id: 'z300', text: 'Todo 300' },
243+
},
244+
{ selectId: (todo) => todo._id }
245+
)
246+
);
247+
248+
expect(store.entityMap()).toEqual({
249+
x: todo1,
250+
y200: { ...todo2, _id: 'y200', text: 'Buy eggs 200' },
251+
z300: { ...todo3, _id: 'z300', text: 'Todo 300' },
252+
});
253+
expect(store.ids()).toEqual(['x', 'y200', 'z300']);
254+
});
255+
256+
it('updates an entity id from specified entity collection', () => {
257+
const Store = signalStore(
258+
withEntities({
259+
entity: type<User>(),
260+
collection: 'user',
261+
})
262+
);
263+
const store = new Store();
264+
265+
patchState(
266+
store,
267+
addEntities([user1, user2, user3], { collection: 'user' }),
268+
updateEntity(
269+
{
270+
id: user1.id,
271+
changes: ({ id }) => ({ id: id + 100, firstName: 'Jimi' }),
272+
},
273+
{ collection: 'user' }
274+
),
275+
updateEntity(
276+
{
277+
id: user2.id,
278+
changes: { id: 202, lastName: 'Hendrix' },
279+
},
280+
{ collection: 'user' }
281+
)
282+
);
283+
284+
expect(store.userEntityMap()).toEqual({
285+
101: { ...user1, id: 101, firstName: 'Jimi' },
286+
202: { ...user2, id: 202, lastName: 'Hendrix' },
287+
3: user3,
288+
});
289+
expect(store.userIds()).toEqual([101, 202, 3]);
290+
});
291+
292+
it('updates a custom entity id from specified entity collection', () => {
293+
const Store = signalStore(
294+
withEntities({
295+
entity: type<Todo>(),
296+
collection: 'todo',
297+
})
298+
);
299+
const store = new Store();
300+
301+
patchState(
302+
store,
303+
addEntities([todo1, todo2, todo3], {
304+
collection: 'todo',
305+
selectId: (todo) => todo._id,
306+
}),
307+
updateEntity(
308+
{
309+
id: todo2._id,
310+
changes: ({ _id }) => ({ _id: `${_id}200`, text: 'Todo 200' }),
311+
},
312+
{ collection: 'todo', selectId: (todo) => todo._id }
313+
),
314+
updateEntity(
315+
{
316+
id: todo3._id,
317+
changes: { _id: '303' },
318+
},
319+
{ collection: 'todo', selectId: (todo) => todo._id }
320+
)
321+
);
322+
323+
expect(store.todoEntityMap()).toEqual({
324+
x: todo1,
325+
y200: { ...todo2, _id: 'y200', text: 'Todo 200' },
326+
303: { ...todo3, _id: '303' },
327+
});
328+
expect(store.todoIds()).toEqual(['x', 'y200', '303']);
329+
});
175330
});

‎modules/signals/entities/src/helpers.ts

+28-1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ import {
77
SelectEntityId,
88
} from './models';
99

10+
declare const ngDevMode: unknown;
1011
const defaultSelectId: SelectEntityId<{ id: EntityId }> = (entity) => entity.id;
1112

1213
export function getEntityIdSelector(config?: {
@@ -166,11 +167,13 @@ export function removeEntitiesMutably(
166167
export function updateEntitiesMutably(
167168
state: EntityState<any>,
168169
idsOrPredicate: EntityId[] | EntityPredicate<any>,
169-
changes: EntityChanges<any>
170+
changes: EntityChanges<any>,
171+
selectId: SelectEntityId<any>
170172
): DidMutate {
171173
const ids = Array.isArray(idsOrPredicate)
172174
? idsOrPredicate
173175
: state.ids.filter((id) => idsOrPredicate(state.entityMap[id]));
176+
let newIds: Record<EntityId, EntityId> | undefined = undefined;
174177
let didMutate = DidMutate.None;
175178

176179
for (const id of ids) {
@@ -181,8 +184,32 @@ export function updateEntitiesMutably(
181184
typeof changes === 'function' ? changes(entity) : changes;
182185
state.entityMap[id] = { ...entity, ...changesRecord };
183186
didMutate = DidMutate.Entities;
187+
188+
const newId = selectId(state.entityMap[id]);
189+
if (newId !== id) {
190+
state.entityMap[newId] = state.entityMap[id];
191+
delete state.entityMap[id];
192+
193+
newIds = newIds || {};
194+
newIds[id] = newId;
195+
}
184196
}
185197
}
186198

199+
if (newIds) {
200+
state.ids = state.ids.map((id) => newIds[id] ?? id);
201+
didMutate = DidMutate.Both;
202+
}
203+
204+
if (ngDevMode && state.ids.length !== Object.keys(state.entityMap).length) {
205+
console.warn(
206+
'@ngrx/signals/entities: Entities with IDs:',
207+
ids,
208+
'are not updated correctly.',
209+
'Make sure to apply valid changes when using `updateEntity`,',
210+
'`updateEntities`, and `updateAllEntities` updaters.'
211+
);
212+
}
213+
187214
return didMutate;
188215
}

‎modules/signals/entities/src/updaters/update-all-entities.ts

+36-7
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,64 @@
11
import { PartialStateUpdater } from '@ngrx/signals';
2-
import { EntityChanges, EntityState, NamedEntityState } from '../models';
2+
import {
3+
EntityChanges,
4+
EntityId,
5+
EntityState,
6+
NamedEntityState,
7+
SelectEntityId,
8+
} from '../models';
39
import {
410
cloneEntityState,
11+
getEntityIdSelector,
512
getEntityStateKeys,
613
getEntityUpdaterResult,
714
updateEntitiesMutably,
815
} from '../helpers';
916

10-
export function updateAllEntities<Entity>(
11-
changes: EntityChanges<Entity & {}>
12-
): PartialStateUpdater<EntityState<Entity>>;
1317
export function updateAllEntities<
1418
Collection extends string,
1519
State extends NamedEntityState<any, Collection>,
1620
Entity = State extends NamedEntityState<infer E, Collection> ? E : never
1721
>(
18-
changes: EntityChanges<Entity & {}>,
22+
changes: EntityChanges<NoInfer<Entity>>,
23+
config: {
24+
collection: Collection;
25+
selectId: SelectEntityId<NoInfer<Entity>>;
26+
}
27+
): PartialStateUpdater<State>;
28+
export function updateAllEntities<
29+
Collection extends string,
30+
State extends NamedEntityState<any, Collection>,
31+
Entity = State extends NamedEntityState<
32+
infer E extends { id: EntityId },
33+
Collection
34+
>
35+
? E
36+
: never
37+
>(
38+
changes: EntityChanges<NoInfer<Entity>>,
1939
config: { collection: Collection }
2040
): PartialStateUpdater<State>;
41+
export function updateAllEntities<Entity>(
42+
changes: EntityChanges<NoInfer<Entity>>,
43+
config: { selectId: SelectEntityId<NoInfer<Entity>> }
44+
): PartialStateUpdater<EntityState<Entity>>;
45+
export function updateAllEntities<Entity extends { id: EntityId }>(
46+
changes: EntityChanges<NoInfer<Entity>>
47+
): PartialStateUpdater<EntityState<Entity>>;
2148
export function updateAllEntities(
2249
changes: EntityChanges<any>,
23-
config?: { collection?: string }
50+
config?: { collection?: string; selectId?: SelectEntityId<any> }
2451
): PartialStateUpdater<EntityState<any> | NamedEntityState<any, string>> {
52+
const selectId = getEntityIdSelector(config);
2553
const stateKeys = getEntityStateKeys(config);
2654

2755
return (state) => {
2856
const clonedState = cloneEntityState(state, stateKeys);
2957
const didMutate = updateEntitiesMutably(
3058
clonedState,
3159
(state as Record<string, any>)[stateKeys.idsKey],
32-
changes
60+
changes,
61+
selectId
3362
);
3463

3564
return getEntityUpdaterResult(clonedState, stateKeys, didMutate);

‎modules/signals/entities/src/updaters/update-entities.ts

+69-13
Original file line numberDiff line numberDiff line change
@@ -5,32 +5,29 @@ import {
55
EntityPredicate,
66
EntityState,
77
NamedEntityState,
8+
SelectEntityId,
89
} from '../models';
910
import {
1011
cloneEntityState,
12+
getEntityIdSelector,
1113
getEntityStateKeys,
1214
getEntityUpdaterResult,
1315
updateEntitiesMutably,
1416
} from '../helpers';
1517

16-
export function updateEntities<Entity>(update: {
17-
ids: EntityId[];
18-
changes: EntityChanges<Entity & {}>;
19-
}): PartialStateUpdater<EntityState<Entity>>;
20-
export function updateEntities<Entity>(update: {
21-
predicate: EntityPredicate<Entity>;
22-
changes: EntityChanges<Entity & {}>;
23-
}): PartialStateUpdater<EntityState<Entity>>;
2418
export function updateEntities<
2519
Collection extends string,
2620
State extends NamedEntityState<any, Collection>,
2721
Entity = State extends NamedEntityState<infer E, Collection> ? E : never
2822
>(
2923
update: {
3024
ids: EntityId[];
31-
changes: EntityChanges<Entity & {}>;
25+
changes: EntityChanges<NoInfer<Entity>>;
3226
},
33-
config: { collection: Collection }
27+
config: {
28+
collection: Collection;
29+
selectId: SelectEntityId<NoInfer<Entity>>;
30+
}
3431
): PartialStateUpdater<State>;
3532
export function updateEntities<
3633
Collection extends string,
@@ -39,16 +36,74 @@ export function updateEntities<
3936
>(
4037
update: {
4138
predicate: EntityPredicate<Entity>;
42-
changes: EntityChanges<Entity & {}>;
39+
changes: EntityChanges<NoInfer<Entity>>;
40+
},
41+
config: {
42+
collection: Collection;
43+
selectId: SelectEntityId<NoInfer<Entity>>;
44+
}
45+
): PartialStateUpdater<State>;
46+
export function updateEntities<
47+
Collection extends string,
48+
State extends NamedEntityState<any, Collection>,
49+
Entity = State extends NamedEntityState<
50+
infer E extends { id: EntityId },
51+
Collection
52+
>
53+
? E
54+
: never
55+
>(
56+
update: {
57+
ids: EntityId[];
58+
changes: EntityChanges<NoInfer<Entity>>;
59+
},
60+
config: { collection: Collection }
61+
): PartialStateUpdater<State>;
62+
export function updateEntities<
63+
Collection extends string,
64+
State extends NamedEntityState<any, Collection>,
65+
Entity = State extends NamedEntityState<
66+
infer E extends { id: EntityId },
67+
Collection
68+
>
69+
? E
70+
: never
71+
>(
72+
update: {
73+
predicate: EntityPredicate<Entity>;
74+
changes: EntityChanges<NoInfer<Entity>>;
4375
},
4476
config: { collection: Collection }
4577
): PartialStateUpdater<State>;
78+
export function updateEntities<Entity>(
79+
update: {
80+
ids: EntityId[];
81+
changes: EntityChanges<NoInfer<Entity>>;
82+
},
83+
config: { selectId: SelectEntityId<NoInfer<Entity>> }
84+
): PartialStateUpdater<EntityState<Entity>>;
85+
export function updateEntities<Entity>(
86+
update: {
87+
predicate: EntityPredicate<Entity>;
88+
changes: EntityChanges<NoInfer<Entity>>;
89+
},
90+
config: { selectId: SelectEntityId<NoInfer<Entity>> }
91+
): PartialStateUpdater<EntityState<Entity>>;
92+
export function updateEntities<Entity extends { id: EntityId }>(update: {
93+
ids: EntityId[];
94+
changes: EntityChanges<NoInfer<Entity>>;
95+
}): PartialStateUpdater<EntityState<Entity>>;
96+
export function updateEntities<Entity extends { id: EntityId }>(update: {
97+
predicate: EntityPredicate<Entity>;
98+
changes: EntityChanges<NoInfer<Entity>>;
99+
}): PartialStateUpdater<EntityState<Entity>>;
46100
export function updateEntities(
47101
update: ({ ids: EntityId[] } | { predicate: EntityPredicate<any> }) & {
48102
changes: EntityChanges<any>;
49103
},
50-
config?: { collection?: string }
104+
config?: { collection?: string; selectId?: SelectEntityId<any> }
51105
): PartialStateUpdater<EntityState<any> | NamedEntityState<any, string>> {
106+
const selectId = getEntityIdSelector(config);
52107
const stateKeys = getEntityStateKeys(config);
53108
const idsOrPredicate = 'ids' in update ? update.ids : update.predicate;
54109

@@ -57,7 +112,8 @@ export function updateEntities(
57112
const didMutate = updateEntitiesMutably(
58113
clonedState,
59114
idsOrPredicate,
60-
update.changes
115+
update.changes,
116+
selectId
61117
);
62118

63119
return getEntityUpdaterResult(clonedState, stateKeys, didMutate);

‎modules/signals/entities/src/updaters/update-entity.ts

+37-7
Original file line numberDiff line numberDiff line change
@@ -4,44 +4,74 @@ import {
44
EntityId,
55
EntityState,
66
NamedEntityState,
7+
SelectEntityId,
78
} from '../models';
89
import {
910
cloneEntityState,
11+
getEntityIdSelector,
1012
getEntityStateKeys,
1113
getEntityUpdaterResult,
1214
updateEntitiesMutably,
1315
} from '../helpers';
1416

15-
export function updateEntity<Entity>(update: {
16-
id: EntityId;
17-
changes: EntityChanges<Entity & {}>;
18-
}): PartialStateUpdater<EntityState<Entity>>;
1917
export function updateEntity<
2018
Collection extends string,
2119
State extends NamedEntityState<any, Collection>,
2220
Entity = State extends NamedEntityState<infer E, Collection> ? E : never
2321
>(
2422
update: {
2523
id: EntityId;
26-
changes: EntityChanges<Entity & {}>;
24+
changes: EntityChanges<NoInfer<Entity>>;
25+
},
26+
config: {
27+
collection: Collection;
28+
selectId: SelectEntityId<NoInfer<Entity>>;
29+
}
30+
): PartialStateUpdater<State>;
31+
export function updateEntity<
32+
Collection extends string,
33+
State extends NamedEntityState<any, Collection>,
34+
Entity = State extends NamedEntityState<
35+
infer E extends { id: EntityId },
36+
Collection
37+
>
38+
? E
39+
: never
40+
>(
41+
update: {
42+
id: EntityId;
43+
changes: EntityChanges<NoInfer<Entity>>;
2744
},
2845
config: { collection: Collection }
2946
): PartialStateUpdater<State>;
47+
export function updateEntity<Entity>(
48+
update: {
49+
id: EntityId;
50+
changes: EntityChanges<NoInfer<Entity>>;
51+
},
52+
config: { selectId: SelectEntityId<NoInfer<Entity>> }
53+
): PartialStateUpdater<EntityState<Entity>>;
54+
export function updateEntity<Entity extends { id: EntityId }>(update: {
55+
id: EntityId;
56+
changes: EntityChanges<NoInfer<Entity>>;
57+
}): PartialStateUpdater<EntityState<Entity>>;
3058
export function updateEntity(
3159
update: {
3260
id: EntityId;
3361
changes: EntityChanges<any>;
3462
},
35-
config?: { collection?: string }
63+
config?: { collection?: string; selectId?: SelectEntityId<any> }
3664
): PartialStateUpdater<EntityState<any> | NamedEntityState<any, string>> {
65+
const selectId = getEntityIdSelector(config);
3766
const stateKeys = getEntityStateKeys(config);
3867

3968
return (state) => {
4069
const clonedState = cloneEntityState(state, stateKeys);
4170
const didMutate = updateEntitiesMutably(
4271
clonedState,
4372
[update.id],
44-
update.changes
73+
update.changes,
74+
selectId
4575
);
4676

4777
return getEntityUpdaterResult(clonedState, stateKeys, didMutate);

‎projects/ngrx.io/content/guide/signals/signal-store/entity-management.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -217,9 +217,9 @@ patchState(this.todoStore, removeEntities([2, 4]));
217217

218218
The default property name for an identifier is `id` and is of type `string` or `number`.
219219

220-
It is possible to specify a custom ID selector, but the return type must still be a `string` or `number`. Custom ID selectors should be provided when adding or setting an entity. It is not possible to define it via `withEntities`.
220+
It is possible to specify a custom ID selector, but the return type must still be a `string` or `number`. Custom ID selectors should be provided when adding, setting, or updating an entity. It is not possible to define it via `withEntities`.
221221

222-
Therefore, all variations of the `add*` and `set*` functions have an optional (last) parameter, which is an object literal that allows to specify the `selectId` function.
222+
Therefore, all variations of the `add*`, `set*`, and `update*` functions have an optional (last) parameter, which is a config object that allows to specify the `selectId` function.
223223

224224
For example:
225225

@@ -244,9 +244,11 @@ patchState(
244244
);
245245

246246
patchState(this.todoStore, setEntity({ key: 4, name: 'Dog Feeding', finished: false }, { selectId }));
247+
248+
patchState(this.todoStore, updateAllEntities({ finished: true }, { selectId }));
247249
```
248250

249-
The `update*` and `remove*` methods, which expect an id value, automatically pick the right one. That is possible because every entity belongs to a map with its id as the key.
251+
The `remove*` methods, which expect an id value, automatically pick the right one. That is possible because every entity belongs to a map with its id as the key.
250252

251253
Theoretically, adding the same entity twice with different id names would be possible. For obvious reasons, we discourage you from doing that.
252254

0 commit comments

Comments
 (0)
Please sign in to comment.