Skip to content

Commit f474f35

Browse files
GabbeVryansolid
authored andcommitted
fix(signals): align store overloads
1 parent 64b8434 commit f474f35

8 files changed

Lines changed: 106 additions & 74 deletions

File tree

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+
Align store overloads across the signals, client, and server entry points. Plain stores share `StoreOptions`, projection forms share `ProjectionOptions`, plain optimistic stores expose their existing options argument, and derived optimistic stores are typed as refreshable.

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,15 @@ export { createProjectionNext as createProjection } from "./next/projection.js";
2828
export { storeIsShallow, storeHasFamily, storeHasOptimisticFamily } from "./next/store.js";
2929
export { createOptimisticStoreNext as createOptimisticStore } from "./next/optimistic.js";
3030

31-
/** Public createStore: plain form `(init, options?)` and derived writable
31+
/** Public createStore: plain form `(initialValue, options?)` and derived writable
3232
* form `(fn, seed, options?)`. */
3333
export function createStore<T extends object = {}>(
34-
store: NoFn<T> | Store<NoFn<T>>,
35-
options?: StoreOptions & { shallow?: boolean }
34+
initialValue: NoFn<T> | Store<NoFn<T>>,
35+
options?: StoreOptions
3636
): [get: Store<T>, set: StoreSetter<T>];
3737
export function createStore<T extends object = {}>(
38-
fn: (store: T) => void | T | Promise<void | T> | AsyncIterable<void | T>,
39-
store: NoFn<T> | Store<NoFn<T>>,
38+
fn: (draft: T) => void | T | Promise<void | T> | AsyncIterable<void | T>,
39+
seed: NoFn<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: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ import {
3737
isEqual,
3838
setSignal,
3939
type Computed,
40+
type Refreshable,
4041
type Signal
4142
} from "../../core/index.js";
4243
import {
@@ -56,6 +57,7 @@ import {
5657
type NoFn,
5758
type ProjectionOptions,
5859
type Store,
60+
type StoreOptions,
5961
type StoreSetter
6062
} from "../store.js";
6163
import { runProjectionComputedNext } from "./projection.js";
@@ -177,25 +179,26 @@ function familyHasLiveOverrides(fam: { overlaid?: Set<any> }): boolean {
177179
}
178180

179181
export function createOptimisticStoreNext<T extends object = {}>(
180-
store: NoFn<T> | Store<NoFn<T>>
182+
initialValue: NoFn<T> | Store<NoFn<T>>,
183+
options?: StoreOptions
181184
): [get: Store<T>, set: StoreSetter<T>];
182185
export function createOptimisticStoreNext<T extends object = {}>(
183-
fn: (store: T) => void | T | Promise<void | T> | AsyncIterable<void | T>,
184-
store: NoFn<T> | Store<NoFn<T>>,
186+
fn: (draft: T) => void | T | Promise<void | T> | AsyncIterable<void | T>,
187+
seed: NoFn<T> | Store<NoFn<T>>,
185188
options?: ProjectionOptions
186-
): [get: Store<T>, set: StoreSetter<T>];
189+
): [get: Refreshable<Store<T>>, set: StoreSetter<T>];
187190
export function createOptimisticStoreNext<T extends object = {}>(
188191
first: T | ((store: T) => void | T | Promise<void | T> | AsyncIterable<void | T>),
189-
second?: NoFn<T> | Store<NoFn<T>>,
190-
options?: ProjectionOptions
192+
second?: NoFn<T> | Store<NoFn<T>> | StoreOptions,
193+
third?: ProjectionOptions
191194
): [get: Store<T>, set: StoreSetter<T>] {
192195
// Engine first (armed nodes need optimisticWrite installed before any
193196
// node exists), then the next-shape hooks.
194197
installOptimisticEngine();
195198
installNextBlockedHalf();
196199

197200
const derived = typeof first === "function";
198-
if (!derived && options === undefined) options = second as ProjectionOptions | undefined;
201+
const options = (derived ? third : second) as ProjectionOptions | undefined;
199202
const initialValue = (derived ? second : first) as T;
200203

201204
const fam: StoreNextFamily = {

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1908,22 +1908,22 @@ setNextAffectsNodeResolver((t: StoreNextTarget, key: PropertyKey) =>
19081908
);
19091909

19101910
export function createStoreNext<T extends Record<PropertyKey, any>>(
1911-
init: T,
1911+
initialValue: T,
19121912
shallow = false
19131913
): [T, SetStoreNextFunction<T>] {
19141914
if (shallow && __DEV__) {
19151915
// Never both deep-wrapped and raw (R41/R44): a value already tracked as
19161916
// a DEEP store cannot be ingested shallow.
1917-
const existing = storeNextLookup.get(init);
1917+
const existing = storeNextLookup.get(initialValue);
19181918
if (existing !== undefined && !(existing as any).s)
19191919
throw new Error("createStore({ shallow }): value is already tracked as a deep store");
1920-
if ((init as any)[$TARGET])
1920+
if ((initialValue as any)[$TARGET])
19211921
throw new Error("createStore({ shallow }): value is already a store proxy");
19221922
}
1923-
const proxy = wrapNext(init);
1923+
const proxy = wrapNext(initialValue);
19241924
if (shallow) {
19251925
((proxy as any)[$TARGET] as StoreNextTarget).s = true;
1926-
markRawIngest(init);
1926+
markRawIngest(initialValue);
19271927
}
19281928
if (__DEV__) registerGraph(proxy, getOwner());
19291929
const setter: SetStoreNextFunction<T> = fn => storeSetterNext(proxy, fn);

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

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,25 +18,30 @@ export type Store<T> = Readonly<T>;
1818
*
1919
* The setter does **not** perform keyed reconciliation. If you need surviving
2020
* items to keep their store identity across full-array replacement, use the
21-
* projection form — `createStore(fn, seed, { key })` or `createProjection` —
22-
* whose derive function reconciles its return by `options.key`.
21+
* projection form — `createStore(fn, seed, { key })` or
22+
* `createProjection(fn, seed, { key })` — whose derive function reconciles
23+
* its return by `options.key`.
2324
*/
2425
export type StoreSetter<T> = (fn: (state: T) => T | void) => void;
25-
/** Tuple returned by the plain `createStore(initialValue)` form. */
26+
/** Tuple returned by the plain `createStore(initialValue, options?)` form. */
2627
export type StoreReturn<T> = [get: Store<T>, set: StoreSetter<T>];
2728
/** Tuple returned by the derived `createStore(fn, seed, options?)` form. */
2829
export type ProjectionStoreReturn<T> = [get: Refreshable<Store<T>>, set: StoreSetter<T>];
29-
/** Base options for store primitives. */
30+
/** Options shared by all store primitives. */
3031
export interface StoreOptions {
3132
/** Debug name (dev mode only) */
3233
name?: string;
34+
/** Single-layer store: root keys reactive, values raw records replaced by reference */
35+
shallow?: boolean;
3336
}
34-
/** Options for derived/projected stores created with `createStore(fn)`, `createProjection`, or `createOptimisticStore(fn)`. */
37+
/**
38+
* Options for derived/projected stores created with
39+
* `createStore(fn, seed, options?)`, `createProjection(fn, seed, options?)`,
40+
* or `createOptimisticStore(fn, seed, options?)`.
41+
*/
3542
export interface ProjectionOptions extends StoreOptions {
3643
/** Key property name or function for reconciliation identity; `null` merges positionally */
3744
key?: string | ((item: NonNullable<any>) => any) | null;
38-
/** Single-layer store: root keys reactive, values raw records replaced by reference */
39-
shallow?: boolean;
4045
/**
4146
* Treat the seed as commit #0: the store is born committed with the seed's
4247
* contents, shown until the derive's first real answer lands. While that

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import {
22
createStore,
33
createProjection,
44
createOptimisticStore,
5+
refresh,
56
type Store
67
} from "../../src/index.js";
78

@@ -122,4 +123,15 @@ createOptimisticStore(() => ({ user: { name: "Ada" }, ready: true }), { ready: f
122123
{ value: 0 }
123124
);
124125
store.value satisfies number;
126+
void refresh(store);
125127
}
128+
129+
// ── createOptimisticStore (plain) — options preserve inference ───────
130+
131+
{
132+
const [store] = createOptimisticStore([{ id: 1, value: "one" }], { shallow: true });
133+
store[0].value satisfies string;
134+
}
135+
136+
// @ts-expect-error Plain optimistic stores do not reconcile snapshots by key.
137+
createOptimisticStore({ id: 1 }, { key: "id" });

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

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ import {
3333
type SignalOptions,
3434
type SourceAccessor,
3535
type Store,
36+
type StoreOptions,
3637
type StoreSetter,
3738
type RevealOrder,
3839
createOwner,
@@ -1592,7 +1593,7 @@ export const createOptimistic: {
15921593
*/
15931594
export const createProjection: <T extends object = {}>(
15941595
fn: (draft: T) => void | T | Promise<void | T> | AsyncIterable<void | T>,
1595-
initialValue: NoFn<T> | Store<NoFn<T>>,
1596+
seed: NoFn<T> | Store<NoFn<T>>,
15961597
options?: HydrationProjectionOptions
15971598
) => Refreshable<Store<T>> = ((...args: any[]) => {
15981599
// `hydrating` can only be true once enableHydration() installed the
@@ -1625,7 +1626,7 @@ type NoFn<T> = T extends Function ? never : T;
16251626
* `filter`. The setter does **not** do keyed reconciliation; for
16261627
* that, use the derived/projection form (or `createProjection`).
16271628
*
1628-
* - **Plain form** — `createStore(initialValue)`: wraps a value in a
1629+
* - **Plain form** — `createStore(initialValue, options?)`: wraps a value in a
16291630
* reactive proxy.
16301631
* - **Derived form** — `createStore(fn, seed, options?)`: a
16311632
* *projection store* whose contents are computed by `fn(draft)`.
@@ -1666,12 +1667,12 @@ type NoFn<T> = T extends Function ? never : T;
16661667
*/
16671668
export const createStore: {
16681669
<T extends object = {}>(
1669-
store: NoFn<T> | Store<NoFn<T>>,
1670-
options?: { name?: string; shallow?: boolean }
1670+
initialValue: NoFn<T> | Store<NoFn<T>>,
1671+
options?: StoreOptions
16711672
): [get: Store<T>, set: StoreSetter<T>];
16721673
<T extends object = {}>(
1673-
fn: (store: T) => void | T | Promise<void | T> | AsyncIterable<void | T>,
1674-
store: NoFn<T> | Store<NoFn<T>>,
1674+
fn: (draft: T) => void | T | Promise<void | T> | AsyncIterable<void | T>,
1675+
seed: NoFn<T> | Store<NoFn<T>>,
16751676
options?: HydrationProjectionOptions
16761677
): [get: Refreshable<Store<T>>, set: StoreSetter<T>];
16771678
} = ((...args: any[]) => {
@@ -1691,12 +1692,12 @@ export const createStore: {
16911692
* Use this for optimistic UI on collection-shaped data. For
16921693
* single-value optimistic state, prefer `createOptimistic`.
16931694
*
1694-
* - **Plain form** — `createOptimisticStore(initialValue)`.
1695+
* - **Plain form** — `createOptimisticStore(initialValue, options?)`.
16951696
* - **Derived form** — `createOptimisticStore(fn, seed, options?)`:
16961697
* a projection store whose authoritative value is recomputed by
16971698
* `fn` and whose optimistic overlay reverts after each transition.
16981699
*
1699-
* `options.key` defaults to `"id"`; specify it only when your data
1700+
* In the derived form, `options.key` defaults to `"id"`; specify it only when your data
17001701
* uses a different identity field (e.g. `{ key: "uuid" }` or
17011702
* `{ key: t => t.slug }`). Restating the default just adds noise.
17021703
*
@@ -1729,10 +1730,13 @@ export const createStore: {
17291730
* @returns `[store: Store<T>, setStore: StoreSetter<T>]`
17301731
*/
17311732
export const createOptimisticStore: {
1732-
<T extends object = {}>(store: NoFn<T> | Store<NoFn<T>>): [get: Store<T>, set: StoreSetter<T>];
17331733
<T extends object = {}>(
1734-
fn: (store: T) => void | T | Promise<void | T> | AsyncIterable<void | T>,
1735-
store: NoFn<T> | Store<NoFn<T>>,
1734+
initialValue: NoFn<T> | Store<NoFn<T>>,
1735+
options?: StoreOptions
1736+
): [get: Store<T>, set: StoreSetter<T>];
1737+
<T extends object = {}>(
1738+
fn: (draft: T) => void | T | Promise<void | T> | AsyncIterable<void | T>,
1739+
seed: NoFn<T> | Store<NoFn<T>>,
17361740
options?: HydrationProjectionOptions
17371741
): [get: Refreshable<Store<T>>, set: StoreSetter<T>];
17381742
} = ((...args: any[]) => {

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

Lines changed: 41 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,12 @@ export { snapshot, omit, storePath, $PROXY, $TRACK } from "@solidjs/signals";
3131

3232
// === Type re-exports ===
3333

34-
import type { Accessor as SignalAccessor, Refreshable } from "@solidjs/signals";
34+
import type {
35+
Accessor as SignalAccessor,
36+
ProjectionOptions,
37+
Refreshable,
38+
StoreOptions
39+
} from "@solidjs/signals";
3540

3641
export type SourceAccessor<T> = Refreshable<SignalAccessor<T>>;
3742

@@ -472,17 +477,10 @@ interface ServerComputation<T = any> {
472477
const LIVE_SOURCE = Symbol.for("solid.LiveSource");
473478

474479
type SsrSourceMode = "server" | "hybrid" | "client";
475-
type ServerSsrOptions = {
480+
interface ServerProjectionOptions extends ProjectionOptions {
476481
deferStream?: boolean;
477482
ssrSource?: SsrSourceMode;
478-
/**
479-
* Commit #0 for derived stores: serve the seed instead of suspending. The
480-
* markup flushes with the seed (locked for the whole response — the
481-
* first-value lock at commit #0) and the landing streams as data for the
482-
* client, whose store is born committed with the same seed.
483-
*/
484-
seedLoadingValue?: boolean;
485-
};
483+
}
486484
type ServerMemoOptions<T> = MemoOptions<T> & {
487485
/**
488486
* Keep this value out of the hydration payload. The subtree still hydrates;
@@ -494,7 +492,6 @@ type ServerMemoOptions<T> = MemoOptions<T> & {
494492
serialize?: false;
495493
};
496494
type ServerSignalOptions<T> = SignalOptions<T>;
497-
type ServerStoreOptions = ServerSsrOptions;
498495
type NoFn<T> = T extends Function ? never : T;
499496

500497
/**
@@ -1778,19 +1775,19 @@ function setProperty(state: any, property: PropertyKey, value: any) {
17781775
} else state[property] = value;
17791776
}
17801777

1781-
export function createStore<T extends object>(
1782-
store: NoFn<T> | Store<NoFn<T>>,
1783-
options?: { name?: string; shallow?: boolean }
1784-
): [get: Store<T>, set: StoreSetter<T>];
1785-
export function createStore<T extends object>(
1786-
fn: (store: T) => void | T | Promise<void | T>,
1787-
store: NoFn<T> | Store<NoFn<T>>,
1788-
options?: ServerStoreOptions & { name?: string; shallow?: boolean }
1778+
export function createStore<T extends object = {}>(
1779+
initialValue: NoFn<T> | Store<NoFn<T>>,
1780+
options?: StoreOptions
17891781
): [get: Store<T>, set: StoreSetter<T>];
1790-
export function createStore<T extends object>(
1791-
first: T | Store<T> | ((store: T) => void | T | Promise<void | T>),
1782+
export function createStore<T extends object = {}>(
1783+
fn: (draft: T) => void | T | Promise<void | T> | AsyncIterable<void | T>,
1784+
seed: NoFn<T> | Store<NoFn<T>>,
1785+
options?: ServerProjectionOptions
1786+
): [get: Refreshable<Store<T>>, set: StoreSetter<T>];
1787+
export function createStore<T extends object = {}>(
1788+
first: T | Store<T> | ((store: T) => void | T | Promise<void | T> | AsyncIterable<void | T>),
17921789
second?: T | Store<T>,
1793-
options?: ServerSsrOptions & { name?: string; shallow?: boolean }
1790+
third?: ServerProjectionOptions
17941791
): [get: Store<T>, set: StoreSetter<T>] {
17951792
if (typeof first === "function") {
17961793
// Forward options: dropping them made ssrSource inert for derived stores —
@@ -1799,7 +1796,7 @@ export function createStore<T extends object>(
17991796
// The impl signature stays loose; the public overload above enforces the
18001797
// client/seedLoadingValue pairing, and createProjection re-checks at
18011798
// runtime.
1802-
const store = createProjection(first as any, second as NoFn<T>, options as any);
1799+
const store = createProjection(first as any, second as NoFn<T>, third as any);
18031800
return [store as Store<T>, storeSetter(store as T)];
18041801
}
18051802
const state = first as T;
@@ -1823,25 +1820,25 @@ function storeSetter<T extends object>(state: T): StoreSetter<T> {
18231820
}) as StoreSetter<T>;
18241821
}
18251822

1826-
export function createOptimisticStore<T extends object>(
1827-
store: NoFn<T> | Store<NoFn<T>>,
1828-
options?: { name?: string; shallow?: boolean }
1829-
): [get: Store<T>, set: StoreSetter<T>];
1830-
export function createOptimisticStore<T extends object>(
1831-
fn: (store: T) => void | T | Promise<void | T>,
1832-
store: NoFn<T> | Store<NoFn<T>>,
1833-
options?: ServerStoreOptions & { name?: string; shallow?: boolean }
1823+
export function createOptimisticStore<T extends object = {}>(
1824+
initialValue: NoFn<T> | Store<NoFn<T>>,
1825+
options?: StoreOptions
18341826
): [get: Store<T>, set: StoreSetter<T>];
1835-
export function createOptimisticStore<T extends object>(
1836-
first: T | Store<T> | ((store: T) => void | T | Promise<void | T>),
1827+
export function createOptimisticStore<T extends object = {}>(
1828+
fn: (draft: T) => void | T | Promise<void | T> | AsyncIterable<void | T>,
1829+
seed: NoFn<T> | Store<NoFn<T>>,
1830+
options?: ServerProjectionOptions
1831+
): [get: Refreshable<Store<T>>, set: StoreSetter<T>];
1832+
export function createOptimisticStore<T extends object = {}>(
1833+
first: T | Store<T> | ((store: T) => void | T | Promise<void | T> | AsyncIterable<void | T>),
18371834
second?: T | Store<T>,
1838-
options?: ServerSsrOptions & { name?: string; shallow?: boolean }
1835+
third?: ServerProjectionOptions
18391836
): [get: Store<T>, set: StoreSetter<T>] {
18401837
// Same no-op rationale as createOptimistic above: optimistic writes are
18411838
// masks that revert at settle, and server output is settled state. The
18421839
// setter never invokes its function — a draft mutation here would be a
18431840
// literal (permanent) mutation, the opposite of optimistic.
1844-
const [store] = (createStore as Function)(first, second, options) as [Store<T>, StoreSetter<T>];
1841+
const [store] = (createStore as Function)(first, second, third) as [Store<T>, StoreSetter<T>];
18451842
return [store, (() => warnServerWrite("optimistic")) as StoreSetter<T>];
18461843
}
18471844

@@ -1968,10 +1965,15 @@ function replaceState<T extends object>(target: T, next: T): void {
19681965
Object.assign(target, next);
19691966
}
19701967

1971-
export function createProjection<T extends object>(
1968+
export function createProjection<T extends object = {}>(
19721969
fn: (draft: T) => void | T | Promise<void | T> | AsyncIterable<void | T>,
1973-
initialValue: NoFn<T> | Store<NoFn<T>>,
1974-
options?: ServerStoreOptions
1970+
seed: NoFn<T> | Store<NoFn<T>>,
1971+
options?: ServerProjectionOptions
1972+
): Refreshable<Store<T>>;
1973+
export function createProjection<T extends object = {}>(
1974+
fn: (draft: T) => void | T | Promise<void | T> | AsyncIterable<void | T>,
1975+
seed: NoFn<T> | Store<NoFn<T>>,
1976+
options?: ServerProjectionOptions
19751977
): Store<T> {
19761978
const ctx = sharedConfig.context;
19771979
const owner = createOwner();
@@ -2000,7 +2002,7 @@ export function createProjection<T extends object>(
20002002
if (slots) slots[slotId!] = proxy;
20012003
return proxy;
20022004
};
2003-
const [state] = createStore(initialValue as NoFn<T>);
2005+
const [state] = createStore(seed as NoFn<T>);
20042006

20052007
if (options?.ssrSource === "client") {
20062008
// seedLoadingValue = declared commit #0: the seed renders. Bare = the

0 commit comments

Comments
 (0)