Skip to content

Commit de1c8b5

Browse files
revert(signals,solid): drop the complete-seed requirement on derived stores (#3258)
Derived createStore/createProjection/createOptimisticStore accept Partial<T> seeds again. #3258 merged without maintainer review; on review the ruling is that the requirement's ergonomic cost exceeds what it fixes: any async object store reconciling on a non-'id' key needs the options slot and therefore the seed slot, and there the seed is pure ceremony — reads pend until the first resolution, so a fabricated complete T is never observable (verified: an uninitialized derived read throws NotReadyError; the seed never leaks). The type-honesty gain is real only for sync draft-reading callbacks and is better served by the #3194 seedless-callback direction. #3260's overload alignment (slot order, shallow in options, Refreshable derived returns, NoFn on plain roots) stays. Since #3258 never shipped, its pending changeset is dropped; the API is unchanged from 2.0.0-rc.6. Co-authored-by: Cursor <[email protected]>
1 parent 215de3b commit de1c8b5

10 files changed

Lines changed: 58 additions & 50 deletions

File tree

‎.changeset/require-complete-store-seeds.md‎

Lines changed: 0 additions & 6 deletions
This file was deleted.
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
"@solidjs/signals": patch
3+
"solid-js": patch
4+
---
5+
6+
Revert the complete-seed requirement on derived store forms (#3258). Derived `createStore`, `createProjection`, and derived `createOptimisticStore` accept `Partial<T>` seeds again, on maintainer review: requiring a full `T` forces callers to fabricate a throwaway complete object in the common async case — any object store reconciling on a non-`id` key needs the options slot, hence the seed slot — while the seed is never observable there (reads pend until the first resolution). The type-honesty concern it addressed is real only for sync draft-reading callbacks and is better served by the seedless-callback direction discussed in #3194. Since #3258 never shipped in a release, its pending changeset is dropped rather than superseded; the API is unchanged from 2.0.0-rc.6. The #3260 overload alignment (slot order, `shallow` in options, `Refreshable` derived returns) is unaffected.

‎packages/signals/src/store/index.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ export function createStore<T extends object = {}>(
3636
): [get: Store<T>, set: StoreSetter<T>];
3737
export function createStore<T extends object = {}>(
3838
fn: (draft: T) => void | T | Promise<void | T> | AsyncIterable<void | T>,
39-
seed: NoFn<T> | Store<NoFn<T>>,
39+
seed: Partial<T> | Store<NoFn<T>>,
4040
options?: ProjectionOptions
4141
): [get: Refreshable<Store<T>>, set: StoreSetter<T>];
4242
export function createStore(first: any, second?: any, third?: any): any {

‎packages/signals/src/store/next/optimistic.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -184,12 +184,12 @@ export function createOptimisticStoreNext<T extends object = {}>(
184184
): [get: Store<T>, set: StoreSetter<T>];
185185
export function createOptimisticStoreNext<T extends object = {}>(
186186
fn: (draft: T) => void | T | Promise<void | T> | AsyncIterable<void | T>,
187-
seed: NoFn<T> | Store<NoFn<T>>,
187+
seed: Partial<T> | Store<NoFn<T>>,
188188
options?: ProjectionOptions
189189
): [get: Refreshable<Store<T>>, set: StoreSetter<T>];
190190
export function createOptimisticStoreNext<T extends object = {}>(
191191
first: T | ((store: T) => void | T | Promise<void | T> | AsyncIterable<void | T>),
192-
second?: NoFn<T> | Store<NoFn<T>> | StoreOptions,
192+
second?: Partial<T> | NoFn<T> | Store<NoFn<T>> | StoreOptions,
193193
third?: ProjectionOptions
194194
): [get: Store<T>, set: StoreSetter<T>] {
195195
// Engine first (armed nodes need optimisticWrite installed before any

‎packages/signals/src/store/next/projection.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ function wrapDraft(
177177

178178
function createProjectionNextInternal<T extends object = {}>(
179179
fn: (draft: T) => void | T | Promise<void | T> | AsyncIterable<void | T>,
180-
seed: T,
180+
seed: Partial<T>,
181181
options?: ProjectionOptions
182182
) {
183183
const fam: StoreNextFamily = {
@@ -211,7 +211,7 @@ function createProjectionNextInternal<T extends object = {}>(
211211

212212
export function createProjectionNext<T extends object = {}>(
213213
fn: (draft: T) => void | T | Promise<void | T> | AsyncIterable<void | T>,
214-
seed: NoFn<T> | Store<NoFn<T>>,
214+
seed: Partial<T> | Store<NoFn<T>>,
215215
options?: ProjectionOptions
216216
): Refreshable<Store<T>> {
217217
return createProjectionNextInternal(fn, seed, options).store;
@@ -222,7 +222,7 @@ export function createProjectionNext<T extends object = {}>(
222222
* same-flush dependency change). */
223223
export function createStoreDerivedNext<T extends object = {}>(
224224
fn: (draft: T) => void | T | Promise<void | T> | AsyncIterable<void | T>,
225-
seed: NoFn<T> | Store<NoFn<T>>,
225+
seed: Partial<T> | Store<NoFn<T>>,
226226
options?: ProjectionOptions
227227
): [Refreshable<Store<T>>, (f: (draft: T) => T | void) => void] {
228228
const { store, node } = createProjectionNextInternal(fn, seed, options);

‎packages/signals/tests/store/createProjection.test.ts‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -518,7 +518,7 @@ describe("projection over a store — chained backing (#2941)", () => {
518518
proj = createProjection(() => {
519519
derive();
520520
return store;
521-
}, {} as any) as { a: number };
521+
}, {}) as { a: number };
522522
createEffect(
523523
() => proj.a,
524524
v => {
@@ -547,7 +547,7 @@ describe("projection over a store — chained backing (#2941)", () => {
547547
const dispose = createRoot(dispose => {
548548
const [store, set] = createStore({ top: "t1", nest: { deep: "d1" } });
549549
setStore = set;
550-
const proj = createProjection(() => store, {} as any) as typeof store;
550+
const proj = createProjection(() => store, {}) as typeof store;
551551
createEffect(
552552
() => proj.top,
553553
v => {
@@ -587,7 +587,7 @@ describe("projection over a store — chained backing (#2941)", () => {
587587
const proj = createProjection(() => {
588588
const m = mode();
589589
return m === "a" ? a : m === "b" ? b : { v: "plain" };
590-
}, {} as any) as { v: string };
590+
}, {}) as { v: string };
591591
createEffect(
592592
() => proj.v,
593593
v => {
@@ -676,7 +676,7 @@ describe("projection over a store — chained backing (#2941)", () => {
676676
const dispose = createRoot(dispose => {
677677
const [store, set] = createStore({ a: 1, nest: { b: 2 } });
678678
setStore = set;
679-
proj = createProjection(() => store, {} as any);
679+
proj = createProjection(() => store, {});
680680
return dispose;
681681
});
682682
flush();
@@ -697,7 +697,7 @@ describe("projection over a store — chained backing (#2941)", () => {
697697
const dispose = createRoot(dispose => {
698698
const [store, set] = createStore<Record<string, number>>({ a: 1 });
699699
setStore = set;
700-
const proj = createProjection(() => store, {} as any) as Record<string, number>;
700+
const proj = createProjection(() => store, {}) as Record<string, number>;
701701
createEffect(
702702
() => Object.keys(proj).join(","),
703703
v => {

‎packages/signals/tests/store/store.type-tests.ts‎

Lines changed: 32 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -33,29 +33,24 @@ import {
3333
store.count satisfies number;
3434
}
3535

36-
// ── projection seeds must be complete ────────────────────────────────
36+
// ── createStore (projection) — partial seed ───────────────────────────
3737

38-
type UserState = { user: { name: string }; ready: boolean };
39-
40-
// @ts-expect-error An inferred seed cannot omit required properties.
41-
createStore(() => ({ user: { name: "Ada" }, ready: true }), { ready: false });
42-
43-
// @ts-expect-error An explicit type argument cannot opt back into a partial seed.
44-
createStore<UserState>(() => ({ user: { name: "Ada" }, ready: true }), {});
45-
46-
// ── callable store roots are rejected ────────────────────────────────
47-
48-
type CallableState = (() => void) & { count: number };
49-
const callableState = Object.assign(() => {}, { count: 0 });
50-
51-
// @ts-expect-error A projection draft cannot represent a callable root.
52-
createStore<CallableState>(() => callableState, callableState);
38+
{
39+
const [store] = createStore(() => ({ foo: true }), {});
40+
store.foo satisfies boolean;
41+
}
5342

54-
// @ts-expect-error A projection draft cannot represent a callable root.
55-
createProjection<CallableState>(() => callableState, callableState);
43+
{
44+
const [store] = createStore(() => ({ a: 1, b: "hello" }), {});
45+
store.a satisfies number;
46+
store.b satisfies string;
47+
}
5648

57-
// @ts-expect-error A projection draft cannot represent a callable root.
58-
createOptimisticStore<CallableState>(() => callableState, callableState);
49+
{
50+
const [store] = createStore(() => ({ a: 1, b: "hello" }), { a: 0 });
51+
store.a satisfies number;
52+
store.b satisfies string;
53+
}
5954

6055
// ── createProjection — mutation only (void return, T from seed) ───────
6156

@@ -81,8 +76,17 @@ createOptimisticStore<CallableState>(() => callableState, callableState);
8176
store.active satisfies boolean;
8277
}
8378

84-
// @ts-expect-error createProjection also requires a complete seed.
85-
createProjection(() => ({ user: { name: "Ada" }, ready: true }), { ready: false });
79+
// ── createProjection — partial seed ───────────────────────────────────
80+
81+
{
82+
const store = createProjection(() => ({ foo: true }), {});
83+
store.foo satisfies boolean;
84+
}
85+
86+
{
87+
const store = createProjection(() => ({ nested: { x: 1 } }), {});
88+
store.nested.x satisfies number;
89+
}
8690

8791
// ── createProjection — empty array seed ───────────────────────────────
8892

@@ -110,8 +114,12 @@ createProjection(() => ({ user: { name: "Ada" }, ready: true }), { ready: false
110114
proj.count satisfies number;
111115
}
112116

113-
// @ts-expect-error createOptimisticStore also requires a complete seed.
114-
createOptimisticStore(() => ({ user: { name: "Ada" }, ready: true }), { ready: false });
117+
// ── createOptimisticStore (projection) — partial seed ─────────────────
118+
119+
{
120+
const [store] = createOptimisticStore(() => ({ foo: true }), {});
121+
store.foo satisfies boolean;
122+
}
115123

116124
// ── createOptimisticStore (projection) — seed matches return type ─────
117125

‎packages/solid/src/client/hydration.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1593,7 +1593,7 @@ export const createOptimistic: {
15931593
*/
15941594
export const createProjection: <T extends object = {}>(
15951595
fn: (draft: T) => void | T | Promise<void | T> | AsyncIterable<void | T>,
1596-
seed: NoFn<T> | Store<NoFn<T>>,
1596+
seed: Partial<T> | Store<NoFn<T>>,
15971597
options?: HydrationProjectionOptions
15981598
) => Refreshable<Store<T>> = ((...args: any[]) => {
15991599
// `hydrating` can only be true once enableHydration() installed the
@@ -1672,7 +1672,7 @@ export const createStore: {
16721672
): [get: Store<T>, set: StoreSetter<T>];
16731673
<T extends object = {}>(
16741674
fn: (draft: T) => void | T | Promise<void | T> | AsyncIterable<void | T>,
1675-
seed: NoFn<T> | Store<NoFn<T>>,
1675+
seed: Partial<T> | Store<NoFn<T>>,
16761676
options?: HydrationProjectionOptions
16771677
): [get: Refreshable<Store<T>>, set: StoreSetter<T>];
16781678
} = ((...args: any[]) => {
@@ -1736,7 +1736,7 @@ export const createOptimisticStore: {
17361736
): [get: Store<T>, set: StoreSetter<T>];
17371737
<T extends object = {}>(
17381738
fn: (draft: T) => void | T | Promise<void | T> | AsyncIterable<void | T>,
1739-
seed: NoFn<T> | Store<NoFn<T>>,
1739+
seed: Partial<T> | Store<NoFn<T>>,
17401740
options?: HydrationProjectionOptions
17411741
): [get: Refreshable<Store<T>>, set: StoreSetter<T>];
17421742
} = ((...args: any[]) => {

‎packages/solid/src/server/signals.ts‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1781,7 +1781,7 @@ export function createStore<T extends object = {}>(
17811781
): [get: Store<T>, set: StoreSetter<T>];
17821782
export function createStore<T extends object = {}>(
17831783
fn: (draft: T) => void | T | Promise<void | T> | AsyncIterable<void | T>,
1784-
seed: NoFn<T> | Store<NoFn<T>>,
1784+
seed: Partial<T> | Store<NoFn<T>>,
17851785
options?: ServerProjectionOptions
17861786
): [get: Refreshable<Store<T>>, set: StoreSetter<T>];
17871787
export function createStore<T extends object = {}>(
@@ -1796,7 +1796,7 @@ export function createStore<T extends object = {}>(
17961796
// The impl signature stays loose; the public overload above enforces the
17971797
// client/seedLoadingValue pairing, and createProjection re-checks at
17981798
// runtime.
1799-
const store = createProjection(first as any, second as NoFn<T>, third as any);
1799+
const store = createProjection(first as any, second as Partial<T>, third as any);
18001800
return [store as Store<T>, storeSetter(store as T)];
18011801
}
18021802
const state = first as T;
@@ -1826,7 +1826,7 @@ export function createOptimisticStore<T extends object = {}>(
18261826
): [get: Store<T>, set: StoreSetter<T>];
18271827
export function createOptimisticStore<T extends object = {}>(
18281828
fn: (draft: T) => void | T | Promise<void | T> | AsyncIterable<void | T>,
1829-
seed: NoFn<T> | Store<NoFn<T>>,
1829+
seed: Partial<T> | Store<NoFn<T>>,
18301830
options?: ServerProjectionOptions
18311831
): [get: Refreshable<Store<T>>, set: StoreSetter<T>];
18321832
export function createOptimisticStore<T extends object = {}>(
@@ -1967,12 +1967,12 @@ function replaceState<T extends object>(target: T, next: T): void {
19671967

19681968
export function createProjection<T extends object = {}>(
19691969
fn: (draft: T) => void | T | Promise<void | T> | AsyncIterable<void | T>,
1970-
seed: NoFn<T> | Store<NoFn<T>>,
1970+
seed: Partial<T> | Store<NoFn<T>>,
19711971
options?: ServerProjectionOptions
19721972
): Refreshable<Store<T>>;
19731973
export function createProjection<T extends object = {}>(
19741974
fn: (draft: T) => void | T | Promise<void | T> | AsyncIterable<void | T>,
1975-
seed: NoFn<T> | Store<NoFn<T>>,
1975+
seed: Partial<T> | Store<NoFn<T>>,
19761976
options?: ServerProjectionOptions
19771977
): Store<T> {
19781978
const ctx = sharedConfig.context;

‎packages/solid/test/server/ssr-async.spec.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1593,7 +1593,7 @@ describe("Stream Blocking / deferStream", () => {
15931593

15941594
createRoot(
15951595
() => {
1596-
createProjection(() => d.promise, {} as any);
1596+
createProjection(() => d.promise, {} as { name?: string });
15971597
},
15981598
{ id: "t" }
15991599
);

0 commit comments

Comments
 (0)