@tanstack/store 0.8.1 → 0.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (64) hide show
  1. package/dist/cjs/alien.cjs +345 -0
  2. package/dist/cjs/alien.cjs.map +1 -0
  3. package/dist/cjs/alien.d.cts +57 -0
  4. package/dist/cjs/atom.cjs +222 -0
  5. package/dist/cjs/atom.cjs.map +1 -0
  6. package/dist/cjs/atom.d.cts +16 -0
  7. package/dist/cjs/batch.cjs +15 -0
  8. package/dist/cjs/batch.cjs.map +1 -0
  9. package/dist/cjs/batch.d.cts +1 -0
  10. package/dist/cjs/index.cjs +8 -12
  11. package/dist/cjs/index.cjs.map +1 -1
  12. package/dist/cjs/index.d.cts +3 -4
  13. package/dist/cjs/store.cjs +22 -29
  14. package/dist/cjs/store.cjs.map +1 -1
  15. package/dist/cjs/store.d.cts +11 -30
  16. package/dist/cjs/types.d.cts +47 -20
  17. package/dist/esm/alien.d.ts +57 -0
  18. package/dist/esm/alien.js +345 -0
  19. package/dist/esm/alien.js.map +1 -0
  20. package/dist/esm/atom.d.ts +16 -0
  21. package/dist/esm/atom.js +222 -0
  22. package/dist/esm/atom.js.map +1 -0
  23. package/dist/esm/batch.d.ts +1 -0
  24. package/dist/esm/batch.js +15 -0
  25. package/dist/esm/batch.js.map +1 -0
  26. package/dist/esm/index.d.ts +3 -4
  27. package/dist/esm/index.js +8 -12
  28. package/dist/esm/index.js.map +1 -1
  29. package/dist/esm/store.d.ts +11 -30
  30. package/dist/esm/store.js +23 -30
  31. package/dist/esm/store.js.map +1 -1
  32. package/dist/esm/types.d.ts +47 -20
  33. package/package.json +6 -7
  34. package/src/alien.ts +654 -0
  35. package/src/atom.ts +298 -0
  36. package/src/batch.ts +12 -0
  37. package/src/index.ts +3 -4
  38. package/src/store.ts +33 -72
  39. package/src/types.ts +60 -24
  40. package/dist/cjs/derived.cjs +0 -117
  41. package/dist/cjs/derived.cjs.map +0 -1
  42. package/dist/cjs/derived.d.cts +0 -50
  43. package/dist/cjs/effect.cjs +0 -24
  44. package/dist/cjs/effect.cjs.map +0 -1
  45. package/dist/cjs/effect.d.cts +0 -18
  46. package/dist/cjs/scheduler.cjs +0 -109
  47. package/dist/cjs/scheduler.cjs.map +0 -1
  48. package/dist/cjs/scheduler.d.cts +0 -27
  49. package/dist/cjs/types.cjs +0 -7
  50. package/dist/cjs/types.cjs.map +0 -1
  51. package/dist/esm/derived.d.ts +0 -50
  52. package/dist/esm/derived.js +0 -117
  53. package/dist/esm/derived.js.map +0 -1
  54. package/dist/esm/effect.d.ts +0 -18
  55. package/dist/esm/effect.js +0 -24
  56. package/dist/esm/effect.js.map +0 -1
  57. package/dist/esm/scheduler.d.ts +0 -27
  58. package/dist/esm/scheduler.js +0 -109
  59. package/dist/esm/scheduler.js.map +0 -1
  60. package/dist/esm/types.js +0 -7
  61. package/dist/esm/types.js.map +0 -1
  62. package/src/derived.ts +0 -203
  63. package/src/effect.ts +0 -42
  64. package/src/scheduler.ts +0 -155
package/dist/esm/types.js DELETED
@@ -1,7 +0,0 @@
1
- function isUpdaterFunction(updater) {
2
- return typeof updater === "function";
3
- }
4
- export {
5
- isUpdaterFunction
6
- };
7
- //# sourceMappingURL=types.js.map
package/dist/esm/types.js.map DELETED
@@ -1 +0,0 @@
1
- {"version":3,"file":"types.js","sources":["../../src/types.ts"],"sourcesContent":["/**\n * @private\n */\nexport type AnyUpdater = (prev: any) => any\n\n/**\n * Type-safe updater that can be either a function or direct value\n */\nexport type Updater<T> = ((prev: T) => T) | T\n\n/**\n * @private\n */\nexport interface ListenerValue<T> {\n readonly prevVal: T\n readonly currentVal: T\n}\n\n/**\n * @private\n */\nexport type Listener<T> = (value: ListenerValue<T>) => void\n\n/**\n * Type guard to check if updater is a function\n */\nexport function isUpdaterFunction<T>(\n updater: Updater<T>,\n): updater is (prev: T) => T {\n return typeof updater === 'function'\n}\n"],"names":[],"mappings":"AA0BO,SAAS,kBACd,SAC2B;AAC3B,SAAO,OAAO,YAAY;AAC5B;"}
package/src/derived.ts DELETED
@@ -1,203 +0,0 @@
1
- import { Store } from './store'
2
- import { __derivedToStore, __storeToDerived } from './scheduler'
3
- import type { Listener } from './types'
4
-
5
- export type UnwrapDerivedOrStore<T> =
6
- T extends Derived<infer InnerD>
7
- ? InnerD
8
- : T extends Store<infer InnerS>
9
- ? InnerS
10
- : never
11
-
12
- type UnwrapReadonlyDerivedOrStoreArray<
13
- TArr extends ReadonlyArray<Derived<any> | Store<any>>,
14
- > = TArr extends readonly []
15
- ? []
16
- : TArr extends readonly [infer Head, ...infer Tail]
17
- ? Head extends Derived<any> | Store<any>
18
- ? Tail extends ReadonlyArray<Derived<any> | Store<any>>
19
- ? [
20
- UnwrapDerivedOrStore<Head>,
21
- ...UnwrapReadonlyDerivedOrStoreArray<Tail>,
22
- ]
23
- : [UnwrapDerivedOrStore<Head>]
24
- : []
25
- : TArr extends ReadonlyArray<Derived<any> | Store<any>>
26
- ? Array<UnwrapDerivedOrStore<TArr[number]>>
27
- : []
28
-
29
- // Can't have currVal, as it's being evaluated from the current derived fn
30
- export interface DerivedFnProps<
31
- TArr extends ReadonlyArray<Derived<any> | Store<any>> = ReadonlyArray<any>,
32
- TUnwrappedArr extends
33
- UnwrapReadonlyDerivedOrStoreArray<TArr> = UnwrapReadonlyDerivedOrStoreArray<TArr>,
34
- > {
35
- // `undefined` if it's the first run
36
- /**
37
- * `undefined` if it's the first run
38
- * @privateRemarks this also cannot be typed as TState, as it breaks the inferencing of the function's return type when an argument is used - even with `NoInfer` usage
39
- */
40
- prevVal: unknown | undefined
41
- prevDepVals: TUnwrappedArr | undefined
42
- currDepVals: TUnwrappedArr
43
- }
44
-
45
- export interface DerivedOptions<
46
- TState,
47
- TArr extends ReadonlyArray<Derived<any> | Store<any>> = ReadonlyArray<any>,
48
- > {
49
- onSubscribe?: (
50
- listener: Listener<TState>,
51
- derived: Derived<TState>,
52
- ) => () => void
53
- onUpdate?: () => void
54
- deps: TArr
55
- /**
56
- * Values of the `deps` from before and after the current invocation of `fn`
57
- */
58
- fn: (props: DerivedFnProps<TArr>) => TState
59
- }
60
-
61
- export class Derived<
62
- TState,
63
- const TArr extends ReadonlyArray<
64
- Derived<any> | Store<any>
65
- > = ReadonlyArray<any>,
66
- > {
67
- listeners = new Set<Listener<TState>>()
68
- state: TState
69
- prevState: TState | undefined
70
- options: DerivedOptions<TState, TArr>
71
-
72
- /**
73
- * Functions representing the subscriptions. Call a function to cleanup
74
- * @private
75
- */
76
- _subscriptions: Array<() => void> = []
77
-
78
- lastSeenDepValues: Array<unknown> = []
79
- getDepVals = () => {
80
- const l = this.options.deps.length
81
- const prevDepVals = new Array<unknown>(l)
82
- const currDepVals = new Array<unknown>(l)
83
- for (let i = 0; i < l; i++) {
84
- const dep = this.options.deps[i]!
85
- prevDepVals[i] = dep.prevState
86
- currDepVals[i] = dep.state
87
- }
88
- this.lastSeenDepValues = currDepVals
89
- return {
90
- prevDepVals,
91
- currDepVals,
92
- prevVal: this.prevState ?? undefined,
93
- }
94
- }
95
-
96
- constructor(options: DerivedOptions<TState, TArr>) {
97
- this.options = options
98
- this.state = options.fn({
99
- prevDepVals: undefined,
100
- prevVal: undefined,
101
- currDepVals: this.getDepVals().currDepVals as never,
102
- })
103
- }
104
-
105
- registerOnGraph(
106
- deps: ReadonlyArray<Derived<any> | Store<any>> = this.options.deps,
107
- ) {
108
- for (const dep of deps) {
109
- if (dep instanceof Derived) {
110
- // First register the intermediate derived value if it's not already registered
111
- dep.registerOnGraph()
112
- // Then register this derived with the dep's underlying stores
113
- this.registerOnGraph(dep.options.deps)
114
- } else if (dep instanceof Store) {
115
- // Register the derived as related derived to the store
116
- let relatedLinkedDerivedVals = __storeToDerived.get(dep)
117
- if (!relatedLinkedDerivedVals) {
118
- relatedLinkedDerivedVals = new Set()
119
- __storeToDerived.set(dep, relatedLinkedDerivedVals)
120
- }
121
- relatedLinkedDerivedVals.add(this as never)
122
-
123
- // Register the store as a related store to this derived
124
- let relatedStores = __derivedToStore.get(this as never)
125
- if (!relatedStores) {
126
- relatedStores = new Set()
127
- __derivedToStore.set(this as never, relatedStores)
128
- }
129
- relatedStores.add(dep)
130
- }
131
- }
132
- }
133
-
134
- unregisterFromGraph(
135
- deps: ReadonlyArray<Derived<any> | Store<any>> = this.options.deps,
136
- ) {
137
- for (const dep of deps) {
138
- if (dep instanceof Derived) {
139
- this.unregisterFromGraph(dep.options.deps)
140
- } else if (dep instanceof Store) {
141
- const relatedLinkedDerivedVals = __storeToDerived.get(dep)
142
- if (relatedLinkedDerivedVals) {
143
- relatedLinkedDerivedVals.delete(this as never)
144
- }
145
-
146
- const relatedStores = __derivedToStore.get(this as never)
147
- if (relatedStores) {
148
- relatedStores.delete(dep)
149
- }
150
- }
151
- }
152
- }
153
-
154
- recompute = () => {
155
- this.prevState = this.state
156
- const depVals = this.getDepVals()
157
- this.state = this.options.fn(depVals as never)
158
-
159
- this.options.onUpdate?.()
160
- }
161
-
162
- checkIfRecalculationNeededDeeply = () => {
163
- for (const dep of this.options.deps) {
164
- if (dep instanceof Derived) {
165
- dep.checkIfRecalculationNeededDeeply()
166
- }
167
- }
168
- let shouldRecompute = false
169
- const lastSeenDepValues = this.lastSeenDepValues
170
- const { currDepVals } = this.getDepVals()
171
- for (let i = 0; i < currDepVals.length; i++) {
172
- if (currDepVals[i] !== lastSeenDepValues[i]) {
173
- shouldRecompute = true
174
- break
175
- }
176
- }
177
-
178
- if (shouldRecompute) {
179
- this.recompute()
180
- }
181
- }
182
-
183
- mount = () => {
184
- this.registerOnGraph()
185
- this.checkIfRecalculationNeededDeeply()
186
-
187
- return () => {
188
- this.unregisterFromGraph()
189
- for (const cleanup of this._subscriptions) {
190
- cleanup()
191
- }
192
- }
193
- }
194
-
195
- subscribe = (listener: Listener<TState>) => {
196
- this.listeners.add(listener)
197
- const unsub = this.options.onSubscribe?.(listener, this)
198
- return () => {
199
- this.listeners.delete(listener)
200
- unsub?.()
201
- }
202
- }
203
- }
package/src/effect.ts DELETED
@@ -1,42 +0,0 @@
1
- import { Derived } from './derived'
2
- import type { DerivedOptions } from './derived'
3
-
4
- interface EffectOptions
5
- extends Omit<
6
- DerivedOptions<unknown>,
7
- 'onUpdate' | 'onSubscribe' | 'lazy' | 'fn'
8
- > {
9
- /**
10
- * Should the effect trigger immediately?
11
- * @default false
12
- */
13
- eager?: boolean
14
- fn: () => void
15
- }
16
-
17
- export class Effect {
18
- /**
19
- * @private
20
- */
21
- _derived: Derived<void>
22
-
23
- constructor(opts: EffectOptions) {
24
- const { eager, fn, ...derivedProps } = opts
25
-
26
- this._derived = new Derived({
27
- ...derivedProps,
28
- fn: () => {},
29
- onUpdate() {
30
- fn()
31
- },
32
- })
33
-
34
- if (eager) {
35
- fn()
36
- }
37
- }
38
-
39
- mount() {
40
- return this._derived.mount()
41
- }
42
- }
package/src/scheduler.ts DELETED
@@ -1,155 +0,0 @@
1
- import { Derived } from './derived'
2
- import type { Store } from './store'
3
-
4
- /**
5
- * This is here to solve the pyramid dependency problem where:
6
- * A
7
- * / \
8
- * B C
9
- * \ /
10
- * D
11
- *
12
- * Where we deeply traverse this tree, how do we avoid D being recomputed twice; once when B is updated, once when C is.
13
- *
14
- * To solve this, we create linkedDeps that allows us to sync avoid writes to the state until all of the deps have been
15
- * resolved.
16
- *
17
- * This is a record of stores, because derived stores are not able to write values to, but stores are
18
- */
19
- export const __storeToDerived = new WeakMap<
20
- Store<unknown>,
21
- Set<Derived<unknown>>
22
- >()
23
- export const __derivedToStore = new WeakMap<
24
- Derived<unknown>,
25
- Set<Store<unknown>>
26
- >()
27
-
28
- export const __depsThatHaveWrittenThisTick = {
29
- current: [] as Array<Derived<unknown> | Store<unknown>>,
30
- }
31
-
32
- let __isFlushing = false
33
- let __batchDepth = 0
34
- const __pendingUpdates = new Set<Store<unknown>>()
35
- // Add a map to store initial values before batch
36
- const __initialBatchValues = new Map<Store<unknown>, unknown>()
37
-
38
- function __flush_internals(relatedVals: Set<Derived<unknown>>) {
39
- // First sort deriveds by dependency order
40
- const sorted = Array.from(relatedVals).sort((a, b) => {
41
- // If a depends on b, b should go first
42
- if (a instanceof Derived && a.options.deps.includes(b)) return 1
43
- // If b depends on a, a should go first
44
- if (b instanceof Derived && b.options.deps.includes(a)) return -1
45
- return 0
46
- })
47
-
48
- for (const derived of sorted) {
49
- if (__depsThatHaveWrittenThisTick.current.includes(derived)) {
50
- continue
51
- }
52
-
53
- __depsThatHaveWrittenThisTick.current.push(derived)
54
- derived.recompute()
55
-
56
- const stores = __derivedToStore.get(derived)
57
- if (stores) {
58
- for (const store of stores) {
59
- const relatedLinkedDerivedVals = __storeToDerived.get(store)
60
- if (!relatedLinkedDerivedVals) continue
61
- __flush_internals(relatedLinkedDerivedVals)
62
- }
63
- }
64
- }
65
- }
66
-
67
- function __notifyListeners(store: Store<unknown>) {
68
- const value = {
69
- prevVal: store.prevState as never,
70
- currentVal: store.state as never,
71
- }
72
- for (const listener of store.listeners) {
73
- listener(value)
74
- }
75
- }
76
-
77
- function __notifyDerivedListeners(derived: Derived<unknown>) {
78
- const value = {
79
- prevVal: derived.prevState as never,
80
- currentVal: derived.state as never,
81
- }
82
- for (const listener of derived.listeners) {
83
- listener(value)
84
- }
85
- }
86
-
87
- /**
88
- * @private only to be called from `Store` on write
89
- */
90
- export function __flush(store: Store<unknown>) {
91
- // If we're starting a batch, store the initial values
92
- if (__batchDepth > 0 && !__initialBatchValues.has(store)) {
93
- __initialBatchValues.set(store, store.prevState)
94
- }
95
-
96
- __pendingUpdates.add(store)
97
-
98
- if (__batchDepth > 0) return
99
- if (__isFlushing) return
100
-
101
- try {
102
- __isFlushing = true
103
-
104
- while (__pendingUpdates.size > 0) {
105
- const stores = Array.from(__pendingUpdates)
106
- __pendingUpdates.clear()
107
-
108
- // First notify listeners with updated values
109
- for (const store of stores) {
110
- // Use initial batch values for prevState if we have them
111
- const prevState = __initialBatchValues.get(store) ?? store.prevState
112
- store.prevState = prevState
113
- __notifyListeners(store)
114
- }
115
-
116
- // Then update all derived values
117
- for (const store of stores) {
118
- const derivedVals = __storeToDerived.get(store)
119
- if (!derivedVals) continue
120
-
121
- __depsThatHaveWrittenThisTick.current.push(store)
122
- __flush_internals(derivedVals)
123
- }
124
-
125
- // Notify derived listeners after recomputing
126
- for (const store of stores) {
127
- const derivedVals = __storeToDerived.get(store)
128
- if (!derivedVals) continue
129
-
130
- for (const derived of derivedVals) {
131
- __notifyDerivedListeners(derived)
132
- }
133
- }
134
- }
135
- } finally {
136
- __isFlushing = false
137
- __depsThatHaveWrittenThisTick.current = []
138
- __initialBatchValues.clear()
139
- }
140
- }
141
-
142
- export function batch(fn: () => void) {
143
- __batchDepth++
144
- try {
145
- fn()
146
- } finally {
147
- __batchDepth--
148
- if (__batchDepth === 0) {
149
- const pendingUpdateToFlush = __pendingUpdates.values().next().value
150
- if (pendingUpdateToFlush) {
151
- __flush(pendingUpdateToFlush) // Trigger flush of all pending updates
152
- }
153
- }
154
- }
155
- }