Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Patch methods do not correctly resolve generic collection names withEntities #4638

Open
1 of 2 tasks
ivashikhmin opened this issue Dec 20, 2024 · 4 comments · May be fixed by #4646
Open
1 of 2 tasks

Patch methods do not correctly resolve generic collection names withEntities #4638

ivashikhmin opened this issue Dec 20, 2024 · 4 comments · May be fixed by #4646
Labels
Project: Signals

Comments

@ivashikhmin
Copy link

Which @ngrx/* package(s) are the source of the bug?

signals

Minimal reproduction of the bug/regression with instructions

A TypeScript error occurs when attempting to use the patchState function with addEntity on a store with withEntities. The error indicates a type mismatch between PartialStateUpdater<NamedEntityState<E, Collection>> and the expected parameter type.

import {
  patchState,
  signalStoreFeature,
  type,
  withMethods,
} from '@ngrx/signals';
import { addEntity, EntityId, withEntities } from '@ngrx/signals/entities';

function withFeature<E extends { id: EntityId }, Collection extends string>(
  collection: Collection
  // collection: string,  //this removes the errors
) {
  const config = {
    collection: collection,
    entity: type<E>(),
  };
  return signalStoreFeature(
    withEntities(config),
    withMethods((store) => ({
      add: (entity: E) =>
        patchState(
          store,
          addEntity(entity, { collection })
        ),
    }))
  );
}
X [ERROR] TS2345: Argument of type 'PartialStateUpdater<NamedEntityState<E, Collection>>' is not assignable to parameter of type 'Partial<{ [
K in keyof { [K in keyof NamedEntityState<E, Collection>]: NamedEntityState<E, Collection>[K]; }]: { [K in keyof NamedEntityState<E, Collection>]: NamedEntityState<...>[K]; }[K]; }> | PartialStateUpdater<...>'.
  Type 'PartialStateUpdater<NamedEntityState<E, Collection>>' is not assignable to type 'PartialStateUpdater<{ [K in keyof { [K in keyof Name
dEntityState<E, Collection>]: NamedEntityState<E, Collection>[K]; }]: { [K in keyof NamedEntityState<E, Collection>]: NamedEntityState<...>[K]; }[K]; }>'.
    Types of parameters 'state' and 'state' are incompatible.
      Type '{ [K in keyof { [K in keyof NamedEntityState<E, Collection>]: NamedEntityState<E, Collection>[K]; }]: { [K in keyof NamedEntityState<E, Collection>]: NamedEntityState<...>[K]; }[K]; }' is not assignable to type 'NamedEntityState<E, Collection>'.
        Type 'string' is not assignable to type 'keyof NamedEntityState<E, Collection>'.
          Type 'string' is not assignable to type 'keyof NamedEntityState<E, Collection>'.
            Type '"entityMap"' is not assignable to type '`${Collection}${Capitalize<K>}` | `${Collection}EntityMap` | `${Collection}Ids`'. [plugin angular-compiler]

https://stackblitz.com/edit/vitejs-vite-nuijcczs?file=src%2Fmain.ts

Expected behavior

Collection extends string generic could be used to make this feature type-safe and allow method naming like in
ngrx-toolkit withDataService

Versions of NgRx, Angular, Node, affected browser(s) and operating system(s)

"@ngrx/signals": "^19.0.0",

Other information

No response

I would be willing to submit a PR to fix this issue

  • Yes
  • No
@markostanimirovic
Copy link
Member

Note: This is not a regression, the same behavior is present in NgRx Signals v18.

@g4sp40nr0cks
Copy link

I wonder if it is the same issue as me, or similar ? If it is, I'll mark it as duplicate.

@ivashikhmin
Copy link
Author

I wonder if it is the same issue as me, or similar ? If it is, I'll mark it as duplicate.

No, this issue is specifically about named collections of entities and their types. So this is compile time issue rather than runtime.

@ivashikhmin
Copy link
Author

So far nailed this to this small example:

      const state : NamedEntityState<User, Collection> = undefined as any;
      const partialState : Partial<NamedEntityState<User, Collection>> = state;

with error:

TS2322: Type NamedEntityState<User, Collection> is not assignable to type Partial<NamedEntityState<User, Collection>>
Type keyof NamedEntityState<User, Collection> is not assignable to type keyof EntityState<Entity>
Type `${Collection}EntityMap` | `${Collection}Ids` is not assignable to type keyof EntityState<Entity>
Type `${Collection}EntityMap` is not assignable to type keyof EntityState<Entity>
Type `${string}EntityMap` is not assignable to type keyof EntityState<Entity>

ivashikhmin added a commit to ivashikhmin/ngrx-platform that referenced this issue Dec 29, 2024
@ivashikhmin
fix(signals): patch state methods do not correctly resolve generic co…
4f7181f 
…llection names withEntities

Ensures type-safety of named entity collections with patchState helpers

fixes ngrx#4638
@ivashikhmin ivashikhmin linked a pull request Dec 29, 2024 that will close this issue
Open
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Project: Signals
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix(signals): patch state methods do not correctly resolve generic co… ivashikhmin/ngrx-platform
3 participants
@markostanimirovic @ivashikhmin @g4sp40nr0cks