Skip to content

fix(types): unwrap refs in mapWritableState for setup stores #2805

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

Merged
merged 3 commits into from
Nov 28, 2024
Merged

fix(types): unwrap refs in mapWritableState for setup stores #2805

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fe6f21b
fix(types): unwrap refs in `mapWritableState` for setup stores
jh-leong Oct 25, 2024
c8cbfae
Merge branch 'v2' into fix/2804
posva Nov 28, 2024
61b47e8
refactor: simplify types
posva Nov 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 4 additions & 7 deletions packages/pinia/src/mapHelpers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -465,10 +465,11 @@ export function mapWritableState<
G extends _GettersTree<S>,
A,
KeyMapper extends Record<string, keyof S>,
SS extends StateTree = Store<Id, S, G, A>,
>(
useStore: StoreDefinition<Id, S, G, A>,
keyMapper: KeyMapper
): _MapWritableStateObjectReturn<S, KeyMapper>
): Pick<_MapWritableStateObjectReturn<SS, KeyMapper>, keyof KeyMapper>
/**
* Allows using state and getters from one store without using the composition
* API (`setup()`) by generating an object to be spread in the `computed` field
Expand All @@ -483,15 +484,11 @@ export function mapWritableState<
G extends _GettersTree<S>,
A,
Keys extends keyof S,
SS extends StateTree = Store<Id, S, G, A>,
>(
useStore: StoreDefinition<Id, S, G, A>,
keys: readonly Keys[]
): {
[K in Keys]: {
get: () => S[K]
set: (value: S[K]) => any
}
}
): Pick<_MapWritableStateReturn<SS>, Keys>
/**
* Allows using state and getters from one store without using the composition
* API (`setup()`) by generating an object to be spread in the `computed` field
Expand Down
2 changes: 1 addition & 1 deletion packages/pinia/src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import { Pinia } from './rootStore'
/**
* Generic state of a Store
*/
export type StateTree = Record<string | number | symbol, any>
export type StateTree = Record<PropertyKey, any>

export function isPlainObject<S extends StateTree>(
value: S | unknown
Expand Down
14 changes: 14 additions & 0 deletions packages/pinia/test-dts/mapHelpers.test-d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,20 @@ mapWritableState(useOptionsStore, ['upper'])
// @ts-expect-error: cannot use a getter
mapWritableState(useOptionsStore, { up: 'upper' })

expectType<{
foo: {
get: () => 'on' | 'off'
set: (v: 'on' | 'off') => any
}
}>(mapWritableState(useSetupStore, { foo: 'a' }))

expectType<{
a: {
get: () => 'on' | 'off'
set: (v: 'on' | 'off') => any
}
}>(mapWritableState(useSetupStore, ['a']))

const setupStoreWithState = mapState(useSetupStore, ['a'])

// store with no getters
Expand Down