@ersbeth/picoflow 1.1.2 → 2.0.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.
- package/.vscode/settings.json +3 -3
- package/CHANGELOG.md +43 -0
- package/README.md +2 -18
- package/biome.json +45 -35
- package/dist/picoflow.js +856 -1530
- package/dist/types/api/base/flowDisposable.d.ts +41 -0
- package/dist/types/api/base/flowDisposable.d.ts.map +1 -0
- package/dist/types/api/base/flowObservable.d.ts +27 -0
- package/dist/types/api/base/flowObservable.d.ts.map +1 -0
- package/dist/types/api/base/flowSubscribable.d.ts +79 -0
- package/dist/types/api/base/flowSubscribable.d.ts.map +1 -0
- package/dist/types/api/base/flowTracker.d.ts +8 -0
- package/dist/types/api/base/flowTracker.d.ts.map +1 -0
- package/dist/types/api/base/index.d.ts +5 -0
- package/dist/types/api/base/index.d.ts.map +1 -0
- package/dist/types/api/index.d.ts +3 -0
- package/dist/types/api/index.d.ts.map +1 -0
- package/dist/types/api/nodes/async/flowConstantAsync.d.ts +31 -0
- package/dist/types/api/nodes/async/flowConstantAsync.d.ts.map +1 -0
- package/dist/types/api/nodes/async/flowDerivationAsync.d.ts +37 -0
- package/dist/types/api/nodes/async/flowDerivationAsync.d.ts.map +1 -0
- package/dist/types/api/nodes/async/flowStateAsync.d.ts +41 -0
- package/dist/types/api/nodes/async/flowStateAsync.d.ts.map +1 -0
- package/dist/types/api/nodes/async/flowWritableDerivationAsync.d.ts +30 -0
- package/dist/types/api/nodes/async/flowWritableDerivationAsync.d.ts.map +1 -0
- package/dist/types/{flow → api}/nodes/async/index.d.ts +1 -2
- package/dist/types/api/nodes/async/index.d.ts.map +1 -0
- package/dist/types/api/nodes/collections/flowArray.d.ts +134 -0
- package/dist/types/api/nodes/collections/flowArray.d.ts.map +1 -0
- package/dist/types/api/nodes/collections/flowMap.d.ts +98 -0
- package/dist/types/api/nodes/collections/flowMap.d.ts.map +1 -0
- package/dist/types/api/nodes/collections/index.d.ts.map +1 -0
- package/dist/types/api/nodes/flowEffect.d.ts +28 -0
- package/dist/types/api/nodes/flowEffect.d.ts.map +1 -0
- package/dist/types/api/nodes/flowSignal.d.ts +25 -0
- package/dist/types/api/nodes/flowSignal.d.ts.map +1 -0
- package/dist/types/api/nodes/flowValue.d.ts +35 -0
- package/dist/types/api/nodes/flowValue.d.ts.map +1 -0
- package/dist/types/api/nodes/index.d.ts +8 -0
- package/dist/types/api/nodes/index.d.ts.map +1 -0
- package/dist/types/api/nodes/sync/flowConstant.d.ts +29 -0
- package/dist/types/api/nodes/sync/flowConstant.d.ts.map +1 -0
- package/dist/types/api/nodes/sync/flowDerivation.d.ts +36 -0
- package/dist/types/api/nodes/sync/flowDerivation.d.ts.map +1 -0
- package/dist/types/api/nodes/sync/flowState.d.ts +39 -0
- package/dist/types/api/nodes/sync/flowState.d.ts.map +1 -0
- package/dist/types/api/nodes/sync/flowWritableDerivation.d.ts +28 -0
- package/dist/types/api/nodes/sync/flowWritableDerivation.d.ts.map +1 -0
- package/dist/types/{flow → api}/nodes/sync/index.d.ts +1 -2
- package/dist/types/api/nodes/sync/index.d.ts.map +1 -0
- package/dist/types/api/nodes/utils.d.ts +22 -0
- package/dist/types/api/nodes/utils.d.ts.map +1 -0
- package/dist/types/base/disposable.d.ts +11 -0
- package/dist/types/base/disposable.d.ts.map +1 -0
- package/dist/types/base/executionStack.d.ts +14 -0
- package/dist/types/base/executionStack.d.ts.map +1 -0
- package/dist/types/base/index.d.ts +6 -0
- package/dist/types/base/index.d.ts.map +1 -0
- package/dist/types/base/node.d.ts +27 -0
- package/dist/types/base/node.d.ts.map +1 -0
- package/dist/types/base/observable.d.ts +37 -0
- package/dist/types/base/observable.d.ts.map +1 -0
- package/dist/types/base/observer.d.ts +25 -0
- package/dist/types/base/observer.d.ts.map +1 -0
- package/dist/types/converters/index.d.ts +2 -0
- package/dist/types/converters/index.d.ts.map +1 -0
- package/dist/types/converters/solid.d.ts +46 -0
- package/dist/types/converters/solid.d.ts.map +1 -0
- package/dist/types/index.d.ts +2 -63
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/nodes/arrayNode.d.ts +2 -0
- package/dist/types/nodes/arrayNode.d.ts.map +1 -0
- package/dist/types/nodes/effectNode.d.ts +2 -0
- package/dist/types/nodes/effectNode.d.ts.map +1 -0
- package/dist/types/nodes/index.d.ts +9 -0
- package/dist/types/nodes/index.d.ts.map +1 -0
- package/dist/types/nodes/mapNode.d.ts +2 -0
- package/dist/types/nodes/mapNode.d.ts.map +1 -0
- package/dist/types/nodes/signalNode.d.ts +2 -0
- package/dist/types/nodes/signalNode.d.ts.map +1 -0
- package/dist/types/nodes/valueAsyncNode.d.ts +2 -0
- package/dist/types/nodes/valueAsyncNode.d.ts.map +1 -0
- package/dist/types/nodes/valueNode.d.ts +2 -0
- package/dist/types/nodes/valueNode.d.ts.map +1 -0
- package/dist/types/nodes/valueSyncNode.d.ts +2 -0
- package/dist/types/nodes/valueSyncNode.d.ts.map +1 -0
- package/dist/types/schedulers/asyncResolver.d.ts +2 -0
- package/dist/types/schedulers/asyncResolver.d.ts.map +1 -0
- package/dist/types/schedulers/asyncScheduler.d.ts +2 -0
- package/dist/types/schedulers/asyncScheduler.d.ts.map +1 -0
- package/dist/types/schedulers/index.d.ts +5 -0
- package/dist/types/schedulers/index.d.ts.map +1 -0
- package/dist/types/schedulers/pendingError.d.ts +2 -0
- package/dist/types/schedulers/pendingError.d.ts.map +1 -0
- package/dist/types/schedulers/scheduler.d.ts +2 -0
- package/dist/types/schedulers/scheduler.d.ts.map +1 -0
- package/dist/types/schedulers/syncResolver.d.ts +2 -0
- package/dist/types/schedulers/syncResolver.d.ts.map +1 -0
- package/dist/types/schedulers/syncScheduler.d.ts +2 -0
- package/dist/types/schedulers/syncScheduler.d.ts.map +1 -0
- package/docs/.vitepress/config.mts +128 -93
- package/docs/api/functions/array.md +14 -37
- package/docs/api/functions/constant.md +13 -25
- package/docs/api/functions/constantAsync.md +69 -0
- package/docs/api/functions/derivation.md +14 -33
- package/docs/api/functions/derivationAsync.md +34 -0
- package/docs/api/functions/from.md +62 -153
- package/docs/api/functions/isDisposable.md +8 -30
- package/docs/api/functions/map.md +15 -36
- package/docs/api/functions/signal.md +8 -23
- package/docs/api/functions/state.md +43 -23
- package/docs/api/functions/stateAsync.md +69 -0
- package/docs/api/functions/subscribe.md +40 -0
- package/docs/api/functions/writableDerivation.md +33 -0
- package/docs/api/functions/writableDerivationAsync.md +34 -0
- package/docs/api/index.md +45 -102
- package/docs/api/interfaces/FlowArray.md +439 -0
- package/docs/api/interfaces/FlowConstant.md +220 -0
- package/docs/api/interfaces/FlowConstantAsync.md +221 -0
- package/docs/api/interfaces/FlowDerivation.md +241 -0
- package/docs/api/interfaces/FlowDerivationAsync.md +242 -0
- package/docs/api/interfaces/FlowDisposable.md +32 -38
- package/docs/api/interfaces/FlowEffect.md +64 -0
- package/docs/api/interfaces/FlowMap.md +374 -0
- package/docs/api/interfaces/FlowObservable.md +155 -0
- package/docs/api/interfaces/FlowSignal.md +156 -0
- package/docs/api/interfaces/FlowState.md +269 -0
- package/docs/api/interfaces/FlowStateAsync.md +268 -0
- package/docs/api/interfaces/FlowSubscribable.md +55 -0
- package/docs/api/interfaces/FlowTracker.md +61 -0
- package/docs/api/interfaces/FlowValue.md +222 -0
- package/docs/api/interfaces/FlowWritableDerivation.md +292 -0
- package/docs/api/interfaces/FlowWritableDerivationAsync.md +293 -0
- package/docs/api/type-aliases/DerivationFunction.md +28 -0
- package/docs/api/type-aliases/DerivationFunctionAsync.md +28 -0
- package/docs/api/type-aliases/FlowArrayAction.md +19 -8
- package/docs/api/type-aliases/FlowDataTracker.md +33 -0
- package/docs/api/type-aliases/FlowMapAction.md +48 -0
- package/docs/api/type-aliases/FlowOnDataListener.md +33 -0
- package/docs/api/type-aliases/FlowOnErrorListener.md +27 -0
- package/docs/api/type-aliases/FlowOnPendingListener.md +21 -0
- package/docs/api/type-aliases/FlowReadonly.md +22 -0
- package/docs/api/type-aliases/InitFunction.md +21 -0
- package/docs/api/type-aliases/InitFunctionAsync.md +21 -0
- package/docs/api/type-aliases/NotPromise.md +6 -3
- package/docs/api/type-aliases/UpdateFunction.md +27 -0
- package/docs/api/type-aliases/UpdateFunctionAsync.md +27 -0
- package/docs/api/typedoc-sidebar.json +1 -81
- package/docs/examples/examples.md +0 -2
- package/docs/guide/advanced/architecture.md +1234 -0
- package/docs/guide/advanced/migration-v2.md +204 -0
- package/docs/guide/advanced/solidjs.md +2 -88
- package/docs/guide/introduction/concepts.md +4 -3
- package/docs/guide/introduction/conventions.md +2 -33
- package/docs/guide/introduction/getting-started.md +28 -23
- package/docs/guide/introduction/lifecycle.md +16 -19
- package/docs/guide/primitives/array.md +102 -216
- package/docs/guide/primitives/constant.md +39 -212
- package/docs/guide/primitives/derivations.md +55 -122
- package/docs/guide/primitives/effects.md +155 -241
- package/docs/guide/primitives/map.md +64 -186
- package/docs/guide/primitives/overview.md +45 -128
- package/docs/guide/primitives/signal.md +51 -88
- package/docs/guide/primitives/state.md +34 -130
- package/package.json +56 -60
- package/src/api/base/flowDisposable.ts +44 -0
- package/src/api/base/flowObservable.ts +28 -0
- package/src/api/base/flowSubscribable.ts +87 -0
- package/src/api/base/flowTracker.ts +7 -0
- package/src/api/base/index.ts +4 -0
- package/src/{flow → api}/index.ts +0 -1
- package/src/api/nodes/async/flowConstantAsync.ts +36 -0
- package/src/api/nodes/async/flowDerivationAsync.ts +42 -0
- package/src/api/nodes/async/flowStateAsync.ts +47 -0
- package/src/api/nodes/async/flowWritableDerivationAsync.ts +33 -0
- package/src/{flow → api}/nodes/async/index.ts +1 -2
- package/src/api/nodes/collections/flowArray.ts +155 -0
- package/src/api/nodes/collections/flowMap.ts +115 -0
- package/src/api/nodes/flowEffect.ts +42 -0
- package/src/api/nodes/flowSignal.ts +28 -0
- package/src/api/nodes/flowValue.ts +36 -0
- package/src/api/nodes/index.ts +7 -0
- package/src/api/nodes/sync/flowConstant.ts +33 -0
- package/src/api/nodes/sync/flowDerivation.ts +41 -0
- package/src/api/nodes/sync/flowState.ts +45 -0
- package/src/api/nodes/sync/flowWritableDerivation.ts +31 -0
- package/src/{flow → api}/nodes/sync/index.ts +1 -2
- package/src/api/nodes/utils.ts +22 -0
- package/src/base/disposable.ts +18 -0
- package/src/base/executionStack.ts +42 -0
- package/src/base/index.ts +5 -0
- package/src/base/node.ts +98 -0
- package/src/base/observable.ts +87 -0
- package/src/base/observer.ts +51 -0
- package/src/converters/index.ts +1 -0
- package/src/converters/solid.ts +109 -0
- package/src/index.ts +2 -64
- package/src/nodes/arrayNode.ts +172 -0
- package/src/nodes/effectNode.ts +59 -0
- package/src/nodes/index.ts +8 -0
- package/src/nodes/mapNode.ts +127 -0
- package/src/nodes/signalNode.ts +21 -0
- package/src/nodes/valueAsyncNode.ts +88 -0
- package/src/nodes/valueNode.ts +144 -0
- package/src/nodes/valueSyncNode.ts +128 -0
- package/src/schedulers/asyncResolver.ts +78 -0
- package/src/schedulers/asyncScheduler.ts +66 -0
- package/src/schedulers/index.ts +4 -0
- package/src/schedulers/pendingError.ts +13 -0
- package/src/schedulers/scheduler.ts +9 -0
- package/src/schedulers/syncResolver.ts +69 -0
- package/src/schedulers/syncScheduler.ts +55 -0
- package/test/base/pendingError.test.ts +67 -0
- package/test/converters/solid.derivation.browser.test.tsx +69 -0
- package/test/converters/solid.node.test.ts +654 -0
- package/test/converters/solid.state.browser.test.tsx +1592 -0
- package/test/reactivity/flowSignal.test.ts +226 -0
- package/test/reactivity/nodes/async/asyncScheduler/asyncResolver.test.ts +593 -0
- package/test/reactivity/nodes/async/asyncScheduler/asyncScheduler.test.ts +317 -0
- package/test/reactivity/nodes/async/flowConstantAsync.test.ts +652 -0
- package/test/reactivity/nodes/async/flowDerivation.test.ts +898 -0
- package/test/reactivity/nodes/async/flowDerivationAsync.test.ts +1716 -0
- package/test/reactivity/nodes/async/flowStateAsync.test.ts +708 -0
- package/test/reactivity/nodes/async/flowWritableDerivationAsync.test.ts +614 -0
- package/test/reactivity/nodes/collections/flowArray.asyncStates.test.ts +1289 -0
- package/test/reactivity/nodes/collections/flowArray.scalars.test.ts +961 -0
- package/test/reactivity/nodes/collections/flowArray.states.test.ts +1035 -0
- package/test/reactivity/nodes/collections/flowMap.asyncStates.test.ts +960 -0
- package/test/reactivity/nodes/collections/flowMap.scalars.test.ts +775 -0
- package/test/reactivity/nodes/collections/flowMap.states.test.ts +958 -0
- package/test/reactivity/nodes/sync/flowConstant.test.ts +377 -0
- package/test/reactivity/nodes/sync/flowDerivation.test.ts +896 -0
- package/test/reactivity/nodes/sync/flowState.test.ts +341 -0
- package/test/reactivity/nodes/sync/flowWritableDerivation.test.ts +603 -0
- package/test/vitest.d.ts +10 -0
- package/tsconfig.json +31 -20
- package/typedoc.json +35 -35
- package/vite.config.ts +25 -23
- package/vitest.browser.config.ts +21 -0
- package/vitest.config.ts +12 -12
- package/.cursor/plans/unifier-flowresource-avec-flowderivation-c9506e24.plan.md +0 -372
- package/.cursor/plans/update-js-e795d61b.plan.md +0 -567
- package/dist/types/flow/base/flowDisposable.d.ts +0 -67
- package/dist/types/flow/base/flowDisposable.d.ts.map +0 -1
- package/dist/types/flow/base/flowEffect.d.ts +0 -127
- package/dist/types/flow/base/flowEffect.d.ts.map +0 -1
- package/dist/types/flow/base/flowGraph.d.ts +0 -97
- package/dist/types/flow/base/flowGraph.d.ts.map +0 -1
- package/dist/types/flow/base/flowSignal.d.ts +0 -134
- package/dist/types/flow/base/flowSignal.d.ts.map +0 -1
- package/dist/types/flow/base/flowTracker.d.ts +0 -15
- package/dist/types/flow/base/flowTracker.d.ts.map +0 -1
- package/dist/types/flow/base/index.d.ts +0 -7
- package/dist/types/flow/base/index.d.ts.map +0 -1
- package/dist/types/flow/base/utils.d.ts +0 -20
- package/dist/types/flow/base/utils.d.ts.map +0 -1
- package/dist/types/flow/collections/flowArray.d.ts +0 -148
- package/dist/types/flow/collections/flowArray.d.ts.map +0 -1
- package/dist/types/flow/collections/flowMap.d.ts +0 -224
- package/dist/types/flow/collections/flowMap.d.ts.map +0 -1
- package/dist/types/flow/collections/index.d.ts.map +0 -1
- package/dist/types/flow/index.d.ts +0 -4
- package/dist/types/flow/index.d.ts.map +0 -1
- package/dist/types/flow/nodes/async/flowConstantAsync.d.ts +0 -137
- package/dist/types/flow/nodes/async/flowConstantAsync.d.ts.map +0 -1
- package/dist/types/flow/nodes/async/flowDerivationAsync.d.ts +0 -137
- package/dist/types/flow/nodes/async/flowDerivationAsync.d.ts.map +0 -1
- package/dist/types/flow/nodes/async/flowNodeAsync.d.ts +0 -343
- package/dist/types/flow/nodes/async/flowNodeAsync.d.ts.map +0 -1
- package/dist/types/flow/nodes/async/flowReadonlyAsync.d.ts +0 -81
- package/dist/types/flow/nodes/async/flowReadonlyAsync.d.ts.map +0 -1
- package/dist/types/flow/nodes/async/flowStateAsync.d.ts +0 -111
- package/dist/types/flow/nodes/async/flowStateAsync.d.ts.map +0 -1
- package/dist/types/flow/nodes/async/index.d.ts.map +0 -1
- package/dist/types/flow/nodes/index.d.ts +0 -3
- package/dist/types/flow/nodes/index.d.ts.map +0 -1
- package/dist/types/flow/nodes/sync/flowConstant.d.ts +0 -108
- package/dist/types/flow/nodes/sync/flowConstant.d.ts.map +0 -1
- package/dist/types/flow/nodes/sync/flowDerivation.d.ts +0 -100
- package/dist/types/flow/nodes/sync/flowDerivation.d.ts.map +0 -1
- package/dist/types/flow/nodes/sync/flowNode.d.ts +0 -314
- package/dist/types/flow/nodes/sync/flowNode.d.ts.map +0 -1
- package/dist/types/flow/nodes/sync/flowReadonly.d.ts +0 -57
- package/dist/types/flow/nodes/sync/flowReadonly.d.ts.map +0 -1
- package/dist/types/flow/nodes/sync/flowState.d.ts +0 -96
- package/dist/types/flow/nodes/sync/flowState.d.ts.map +0 -1
- package/dist/types/flow/nodes/sync/index.d.ts.map +0 -1
- package/dist/types/solid/converters.d.ts +0 -57
- package/dist/types/solid/converters.d.ts.map +0 -1
- package/dist/types/solid/index.d.ts +0 -3
- package/dist/types/solid/index.d.ts.map +0 -1
- package/dist/types/solid/primitives.d.ts +0 -181
- package/dist/types/solid/primitives.d.ts.map +0 -1
- package/docs/api/classes/FlowArray.md +0 -489
- package/docs/api/classes/FlowConstant.md +0 -350
- package/docs/api/classes/FlowDerivation.md +0 -334
- package/docs/api/classes/FlowEffect.md +0 -100
- package/docs/api/classes/FlowMap.md +0 -512
- package/docs/api/classes/FlowObservable.md +0 -306
- package/docs/api/classes/FlowResource.md +0 -380
- package/docs/api/classes/FlowResourceAsync.md +0 -362
- package/docs/api/classes/FlowSignal.md +0 -160
- package/docs/api/classes/FlowState.md +0 -368
- package/docs/api/classes/FlowStream.md +0 -367
- package/docs/api/classes/FlowStreamAsync.md +0 -364
- package/docs/api/classes/SolidDerivation.md +0 -75
- package/docs/api/classes/SolidResource.md +0 -91
- package/docs/api/classes/SolidState.md +0 -71
- package/docs/api/classes/TrackingContext.md +0 -33
- package/docs/api/functions/effect.md +0 -49
- package/docs/api/functions/resource.md +0 -52
- package/docs/api/functions/resourceAsync.md +0 -50
- package/docs/api/functions/stream.md +0 -53
- package/docs/api/functions/streamAsync.md +0 -50
- package/docs/api/interfaces/SolidObservable.md +0 -19
- package/docs/api/type-aliases/FlowStreamDisposer.md +0 -15
- package/docs/api/type-aliases/FlowStreamSetter.md +0 -27
- package/docs/api/type-aliases/FlowStreamUpdater.md +0 -32
- package/docs/api/type-aliases/SolidGetter.md +0 -17
- package/docs/guide/primitives/resources.md +0 -858
- package/docs/guide/primitives/streams.md +0 -931
- package/src/flow/base/flowDisposable.ts +0 -71
- package/src/flow/base/flowEffect.ts +0 -171
- package/src/flow/base/flowGraph.ts +0 -288
- package/src/flow/base/flowSignal.ts +0 -207
- package/src/flow/base/flowTracker.ts +0 -17
- package/src/flow/base/index.ts +0 -6
- package/src/flow/base/utils.ts +0 -19
- package/src/flow/collections/flowArray.ts +0 -409
- package/src/flow/collections/flowMap.ts +0 -398
- package/src/flow/nodes/async/flowConstantAsync.ts +0 -142
- package/src/flow/nodes/async/flowDerivationAsync.ts +0 -143
- package/src/flow/nodes/async/flowNodeAsync.ts +0 -474
- package/src/flow/nodes/async/flowReadonlyAsync.ts +0 -81
- package/src/flow/nodes/async/flowStateAsync.ts +0 -116
- package/src/flow/nodes/await/advanced/index.ts +0 -5
- package/src/flow/nodes/await/advanced/resource.ts +0 -134
- package/src/flow/nodes/await/advanced/resourceAsync.ts +0 -109
- package/src/flow/nodes/await/advanced/stream.ts +0 -188
- package/src/flow/nodes/await/advanced/streamAsync.ts +0 -176
- package/src/flow/nodes/await/flowConstantAwait.ts +0 -154
- package/src/flow/nodes/await/flowDerivationAwait.ts +0 -154
- package/src/flow/nodes/await/flowNodeAwait.ts +0 -508
- package/src/flow/nodes/await/flowReadonlyAwait.ts +0 -89
- package/src/flow/nodes/await/flowStateAwait.ts +0 -130
- package/src/flow/nodes/await/index.ts +0 -5
- package/src/flow/nodes/index.ts +0 -3
- package/src/flow/nodes/sync/flowConstant.ts +0 -111
- package/src/flow/nodes/sync/flowDerivation.ts +0 -105
- package/src/flow/nodes/sync/flowNode.ts +0 -439
- package/src/flow/nodes/sync/flowReadonly.ts +0 -57
- package/src/flow/nodes/sync/flowState.ts +0 -101
- package/src/solid/converters.ts +0 -148
- package/src/solid/index.ts +0 -2
- package/src/solid/primitives.ts +0 -215
- package/test/base/flowEffect.test.ts +0 -108
- package/test/base/flowGraph.test.ts +0 -485
- package/test/base/flowSignal.test.ts +0 -372
- package/test/collections/flowArray.asyncStates.test.ts +0 -1553
- package/test/collections/flowArray.scalars.test.ts +0 -1129
- package/test/collections/flowArray.states.test.ts +0 -1365
- package/test/collections/flowMap.asyncStates.test.ts +0 -1105
- package/test/collections/flowMap.scalars.test.ts +0 -877
- package/test/collections/flowMap.states.test.ts +0 -1097
- package/test/nodes/async/flowConstantAsync.test.ts +0 -860
- package/test/nodes/async/flowDerivationAsync.test.ts +0 -1517
- package/test/nodes/async/flowStateAsync.test.ts +0 -1387
- package/test/nodes/await/advanced/resource.test.ts +0 -129
- package/test/nodes/await/advanced/resourceAsync.test.ts +0 -108
- package/test/nodes/await/advanced/stream.test.ts +0 -198
- package/test/nodes/await/advanced/streamAsync.test.ts +0 -196
- package/test/nodes/await/flowConstantAwait.test.ts +0 -643
- package/test/nodes/await/flowDerivationAwait.test.ts +0 -1583
- package/test/nodes/await/flowStateAwait.test.ts +0 -999
- package/test/nodes/mixed/derivation.test.ts +0 -1527
- package/test/nodes/sync/flowConstant.test.ts +0 -620
- package/test/nodes/sync/flowDerivation.test.ts +0 -1373
- package/test/nodes/sync/flowState.test.ts +0 -945
- package/test/solid/converters.test.ts +0 -721
- package/test/solid/primitives.test.ts +0 -1031
- /package/dist/types/{flow → api/nodes}/collections/index.d.ts +0 -0
- /package/docs/guide/advanced/{upgrading.md → migration-v1.md} +0 -0
- /package/src/{flow → api/nodes}/collections/index.ts +0 -0
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import type { FlowObservable } from "~/api/base";
|
|
2
|
+
import { SignalNode } from "~/nodes";
|
|
3
|
+
|
|
4
|
+
/**
|
|
5
|
+
* Manual trigger that notifies subscribers without carrying data.
|
|
6
|
+
*
|
|
7
|
+
* Unlike reactive state or derivations, signals don't hold values. They serve as event emitters
|
|
8
|
+
* that notify dependents when explicitly triggered. Use signals for side effects that should run
|
|
9
|
+
* in response to manual actions rather than data changes.
|
|
10
|
+
*
|
|
11
|
+
* @public
|
|
12
|
+
*/
|
|
13
|
+
export interface FlowSignal extends FlowObservable<void> {}
|
|
14
|
+
|
|
15
|
+
/**
|
|
16
|
+
* Creates a signal that can be manually triggered to notify dependents.
|
|
17
|
+
*
|
|
18
|
+
* Signals act as event emitters in the reactive graph. Call `trigger()` to notify all subscribers
|
|
19
|
+
* and reactive computations that depend on the signal. Unlike state or derivations, signals don't
|
|
20
|
+
* carry data values - they simply represent that an event occurred.
|
|
21
|
+
*
|
|
22
|
+
* @returns A FlowSignal that can be triggered manually and subscribed to
|
|
23
|
+
*
|
|
24
|
+
* @public
|
|
25
|
+
*/
|
|
26
|
+
export function signal(): FlowSignal {
|
|
27
|
+
return new SignalNode();
|
|
28
|
+
}
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import type { FlowObservable, FlowTracker } from "~/api/base";
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Base interface for reactive values that can be read synchronously or asynchronously.
|
|
5
|
+
*
|
|
6
|
+
* FlowValue extends FlowObservable with methods to access the current value. Use `get()` to read
|
|
7
|
+
* the value reactively (establishing a dependency), or `pick()` to read it non-reactively. All
|
|
8
|
+
* value-based primitives (state, derivation, constant, and their async variants) implement this
|
|
9
|
+
* interface, providing a consistent API for value access across the reactive system.
|
|
10
|
+
*
|
|
11
|
+
* @public
|
|
12
|
+
*/
|
|
13
|
+
export interface FlowValue<T> extends FlowObservable<T> {
|
|
14
|
+
/**
|
|
15
|
+
* Gets the current value and establishes a reactive dependency.
|
|
16
|
+
*
|
|
17
|
+
* When called from within a reactive computation, this method registers the value as a dependency,
|
|
18
|
+
* ensuring the computation re-executes when the value changes. The value is computed on first access
|
|
19
|
+
* (if lazy) and then cached. For async values, throws PendingError while the value is resolving.
|
|
20
|
+
*
|
|
21
|
+
* @param tracker - Tracker that records this value as a dependency
|
|
22
|
+
* @returns The current value
|
|
23
|
+
*/
|
|
24
|
+
get(tracker: FlowTracker): T;
|
|
25
|
+
|
|
26
|
+
/**
|
|
27
|
+
* Asynchronously gets the current value without establishing a reactive dependency.
|
|
28
|
+
*
|
|
29
|
+
* This method reads the value non-reactively, meaning it won't trigger re-execution of the calling
|
|
30
|
+
* computation when the value changes. The value is computed on first access (if lazy) and then cached.
|
|
31
|
+
* For async values, the promise resolves once the value is available.
|
|
32
|
+
*
|
|
33
|
+
* @returns Promise that resolves with the current value
|
|
34
|
+
*/
|
|
35
|
+
pick(): Promise<T>;
|
|
36
|
+
}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import { ValueSyncNode } from "~/nodes";
|
|
2
|
+
import type { FlowValue } from "../flowValue";
|
|
3
|
+
import type { NotPromise } from "../utils";
|
|
4
|
+
|
|
5
|
+
/** Function that initializes a value. */
|
|
6
|
+
export type InitFunction<T> = () => NotPromise<T>;
|
|
7
|
+
|
|
8
|
+
/**
|
|
9
|
+
* Read-only reactive value that computes once on initialization and never changes.
|
|
10
|
+
*
|
|
11
|
+
* Constants provide lazy initialization - the value isn't computed until first accessed via `get()` or `pick()`.
|
|
12
|
+
* Once computed, the value is cached forever. Use constants for expensive computations that only need to run once,
|
|
13
|
+
* such as loading configuration, computing static lookups, or initializing resources.
|
|
14
|
+
*
|
|
15
|
+
* @public
|
|
16
|
+
*/
|
|
17
|
+
export interface FlowConstant<T> extends FlowValue<T> {}
|
|
18
|
+
|
|
19
|
+
/**
|
|
20
|
+
* Creates a constant reactive value that initializes lazily and never recomputes.
|
|
21
|
+
*
|
|
22
|
+
* The initializer function runs once on first access, and the result is cached permanently.
|
|
23
|
+
* Unlike state or derivations, constants never react to changes - they represent immutable values
|
|
24
|
+
* in the reactive graph. Useful for expensive one-time computations or static configuration.
|
|
25
|
+
*
|
|
26
|
+
* @param initializer - Function that computes the constant value on first access
|
|
27
|
+
* @returns A FlowConstant that provides read-only access to the cached value
|
|
28
|
+
*
|
|
29
|
+
* @public
|
|
30
|
+
*/
|
|
31
|
+
export function constant<T>(initializer: InitFunction<T>): FlowConstant<T> {
|
|
32
|
+
return new ValueSyncNode(initializer);
|
|
33
|
+
}
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import { ValueSyncNode } from "~/nodes";
|
|
2
|
+
import type { FlowTracker } from "../../base";
|
|
3
|
+
import type { FlowValue } from "../flowValue";
|
|
4
|
+
import type { NotPromise } from "../utils";
|
|
5
|
+
|
|
6
|
+
/** Function that derives a value from dependencies and optionally the previous value. */
|
|
7
|
+
export type DerivationFunction<T> = (tracker: FlowTracker, previous?: NotPromise<T> | undefined) => NotPromise<T>;
|
|
8
|
+
|
|
9
|
+
/**
|
|
10
|
+
* Read-only reactive value that recomputes automatically when dependencies change.
|
|
11
|
+
*
|
|
12
|
+
* Derivations track reactive values accessed during computation and automatically recompute when any
|
|
13
|
+
* tracked dependency changes. The computed value is cached until dependencies change, avoiding unnecessary
|
|
14
|
+
* recomputations. Use derivations for values derived from other reactive state, such as filtered lists,
|
|
15
|
+
* computed properties, or aggregated data.
|
|
16
|
+
*
|
|
17
|
+
* @public
|
|
18
|
+
*/
|
|
19
|
+
export interface FlowDerivation<T> extends FlowValue<T> {
|
|
20
|
+
/**
|
|
21
|
+
* Forces the derivation to recompute even if dependencies haven't changed.
|
|
22
|
+
*/
|
|
23
|
+
refresh(): void;
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
/**
|
|
27
|
+
* Creates a derived reactive value that automatically recomputes when dependencies change.
|
|
28
|
+
*
|
|
29
|
+
* The compute function runs when any tracked dependency changes, and the result is cached until the next change.
|
|
30
|
+
* Access reactive values within the compute function to establish dependencies automatically. The derivation
|
|
31
|
+
* computes lazily on first access and then reactively thereafter. Use for derived data that should stay
|
|
32
|
+
* synchronized with source state.
|
|
33
|
+
*
|
|
34
|
+
* @param compute - Function that accesses dependencies and computes the derived value
|
|
35
|
+
* @returns A FlowDerivation that provides read-only access to the computed value
|
|
36
|
+
*
|
|
37
|
+
* @public
|
|
38
|
+
*/
|
|
39
|
+
export function derivation<T>(compute: DerivationFunction<T>): FlowDerivation<T> {
|
|
40
|
+
return new ValueSyncNode(compute);
|
|
41
|
+
}
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
import { ValueSyncNode } from "~/nodes";
|
|
2
|
+
import type { FlowValue } from "../flowValue";
|
|
3
|
+
import type { NotPromise } from "../utils";
|
|
4
|
+
import type { InitFunction } from "./flowConstant";
|
|
5
|
+
|
|
6
|
+
/** Function that updates a value based on the previous value. */
|
|
7
|
+
export type UpdateFunction<T> = (previous: NotPromise<T> | undefined) => NotPromise<T>;
|
|
8
|
+
|
|
9
|
+
/**
|
|
10
|
+
* Writable reactive value that can be updated manually and notifies dependents on changes.
|
|
11
|
+
*
|
|
12
|
+
* State is the simplest writable reactive primitive. Unlike derivations, it has no dependencies and never
|
|
13
|
+
* recomputes automatically - changes only occur when you explicitly call `set()`. Use state for user input,
|
|
14
|
+
* application state, or any data that changes imperatively. Changes propagate automatically to all dependents.
|
|
15
|
+
*
|
|
16
|
+
* @public
|
|
17
|
+
*/
|
|
18
|
+
export interface FlowState<T> extends FlowValue<T> {
|
|
19
|
+
/**
|
|
20
|
+
* Updates the state with a new value or via an updater function.
|
|
21
|
+
* Notifies all dependents after the update.
|
|
22
|
+
*
|
|
23
|
+
* @param value - New value to set, or function that receives current value and returns new value
|
|
24
|
+
*/
|
|
25
|
+
set(value: NotPromise<T>): void;
|
|
26
|
+
set(updater: UpdateFunction<T>): void;
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
/**
|
|
30
|
+
* Creates a mutable reactive state that can be read and updated imperatively.
|
|
31
|
+
*
|
|
32
|
+
* State can be initialized with a direct value or a lazy initializer function. Changes propagate
|
|
33
|
+
* automatically to all reactive computations that depend on this state. Use state for data that
|
|
34
|
+
* changes through user actions, external events, or application logic rather than derived computations.
|
|
35
|
+
*
|
|
36
|
+
* @param value - Initial value for the state, or lazy initializer function
|
|
37
|
+
* @returns A FlowState that can be read and modified
|
|
38
|
+
*
|
|
39
|
+
* @public
|
|
40
|
+
*/
|
|
41
|
+
export function state<T>(value: NotPromise<T>): FlowState<T>;
|
|
42
|
+
export function state<T>(initializer: InitFunction<T>): FlowState<T>;
|
|
43
|
+
export function state<T>(valueOrInitializer: NotPromise<T> | InitFunction<T>): FlowState<T> {
|
|
44
|
+
return new ValueSyncNode(valueOrInitializer);
|
|
45
|
+
}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import { ValueSyncNode } from "~/nodes";
|
|
2
|
+
import type { DerivationFunction, FlowDerivation } from "./flowDerivation";
|
|
3
|
+
import type { FlowState } from "./flowState";
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* Writable reactive value that recomputes automatically when dependencies change, but can be manually overridden.
|
|
7
|
+
*
|
|
8
|
+
* Writable derivations combine reactive computation with manual control. They track dependencies and recompute
|
|
9
|
+
* like regular derivations, but you can also call `set()` to override the computed value temporarily. Use this
|
|
10
|
+
* for computed values that users can edit, such as formatted fields, calculated totals that can be adjusted,
|
|
11
|
+
* or any value that is usually derived but sometimes needs manual correction.
|
|
12
|
+
*
|
|
13
|
+
* @public
|
|
14
|
+
*/
|
|
15
|
+
export interface FlowWritableDerivation<T> extends FlowState<T>, FlowDerivation<T> {}
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
* Creates a derived value that recomputes automatically but can also be manually overridden.
|
|
19
|
+
*
|
|
20
|
+
* The compute function tracks dependencies and recomputes when they change, just like a regular derivation.
|
|
21
|
+
* However, you can also call `set()` to override the computed value. Use this for values that are normally
|
|
22
|
+
* derived but need occasional manual adjustments, such as editable calculated fields or user-correctable totals.
|
|
23
|
+
*
|
|
24
|
+
* @param compute - Function that accesses dependencies and computes the derived value
|
|
25
|
+
* @returns A FlowWritableDerivation that provides both reactive computation and manual control
|
|
26
|
+
*
|
|
27
|
+
* @public
|
|
28
|
+
*/
|
|
29
|
+
export function writableDerivation<T>(compute: DerivationFunction<T>): FlowWritableDerivation<T> {
|
|
30
|
+
return new ValueSyncNode(compute);
|
|
31
|
+
}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Type that excludes Promise values from a type union.
|
|
3
|
+
*
|
|
4
|
+
* This utility type ensures that synchronous reactive primitives (like `state`, `constant`, `derivation`)
|
|
5
|
+
* only accept non-Promise values. Use this to prevent accidental mixing of sync and async values, which
|
|
6
|
+
* would cause runtime errors. For async values, use the async variants (like `stateAsync`, `constantAsync`).
|
|
7
|
+
*
|
|
8
|
+
* @public
|
|
9
|
+
*/
|
|
10
|
+
export type NotPromise<T> = T extends Promise<unknown> ? never : T;
|
|
11
|
+
|
|
12
|
+
/**
|
|
13
|
+
* Type that restricts mutation methods to create read-only versions of reactive primitives.
|
|
14
|
+
*
|
|
15
|
+
* This utility type removes mutation methods (`set`, `refresh`, `trigger`) from a reactive primitive,
|
|
16
|
+
* creating a read-only interface. Use this when you want to expose reactive values to consumers who
|
|
17
|
+
* should observe but not modify them, such as passing state to child components or external modules
|
|
18
|
+
* while maintaining encapsulation of write access.
|
|
19
|
+
*
|
|
20
|
+
* @public
|
|
21
|
+
*/
|
|
22
|
+
export type FlowReadonly<T> = Omit<T, "set" | "refresh" | "trigger">;
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import type { FlowDisposable } from "~/api/base/flowDisposable";
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Base implementation of the disposable pattern for reactive primitives.
|
|
5
|
+
* Throws an error if disposed multiple times.
|
|
6
|
+
*/
|
|
7
|
+
export class Disposable implements FlowDisposable {
|
|
8
|
+
protected _disposed = false;
|
|
9
|
+
|
|
10
|
+
get disposed(): boolean {
|
|
11
|
+
return this._disposed;
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
dispose(): void {
|
|
15
|
+
if (this._disposed) throw new Error("[PicoFlow] Primitive is disposed");
|
|
16
|
+
this._disposed = true;
|
|
17
|
+
}
|
|
18
|
+
}
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
import type { IObserver } from "./observer";
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Global scheduler that batches and executes reactive computations asynchronously.
|
|
5
|
+
*/
|
|
6
|
+
export class ExecutionStack {
|
|
7
|
+
private static readonly _pendingQueue: IObserver[] = [];
|
|
8
|
+
private static readonly _effectQueue: IObserver[] = [];
|
|
9
|
+
private static _executionScheduled?: Promise<void>;
|
|
10
|
+
|
|
11
|
+
static pushPending(node: IObserver): void {
|
|
12
|
+
ExecutionStack._scheduleExecution();
|
|
13
|
+
ExecutionStack._pendingQueue.push(node);
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
static pushEffect(effect: IObserver): void {
|
|
17
|
+
ExecutionStack._scheduleExecution();
|
|
18
|
+
ExecutionStack._effectQueue.push(effect);
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
private static _scheduleExecution(): void {
|
|
22
|
+
if (ExecutionStack._executionScheduled) return;
|
|
23
|
+
ExecutionStack._executionScheduled = new Promise((resolve) => {
|
|
24
|
+
setTimeout(() => {
|
|
25
|
+
ExecutionStack._executionScheduled = undefined;
|
|
26
|
+
ExecutionStack._execute();
|
|
27
|
+
resolve();
|
|
28
|
+
}, 0);
|
|
29
|
+
});
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
private static _execute(): void {
|
|
33
|
+
ExecutionStack._pendingQueue.forEach((node) => {
|
|
34
|
+
node.execute();
|
|
35
|
+
});
|
|
36
|
+
ExecutionStack._pendingQueue.length = 0;
|
|
37
|
+
ExecutionStack._effectQueue.forEach((effect) => {
|
|
38
|
+
effect.execute();
|
|
39
|
+
});
|
|
40
|
+
ExecutionStack._effectQueue.length = 0;
|
|
41
|
+
}
|
|
42
|
+
}
|
package/src/base/node.ts
ADDED
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
import type { FlowEffect, FlowOnDataListener, FlowOnErrorListener, FlowOnPendingListener, FlowTracker } from "~/api";
|
|
2
|
+
import { Disposable } from "./disposable";
|
|
3
|
+
import type { IObservable, ObservableStatus } from "./observable";
|
|
4
|
+
import type { IObserver } from "./observer";
|
|
5
|
+
|
|
6
|
+
/**
|
|
7
|
+
* Base implementation for reactive nodes that propagate changes through the dependency graph.
|
|
8
|
+
*/
|
|
9
|
+
export abstract class Node<T> extends Disposable implements IObservable<T>, IObserver {
|
|
10
|
+
private _dependencies = new Set<IObservable<unknown>>();
|
|
11
|
+
private _dependents = new Set<IObserver>();
|
|
12
|
+
protected _status: ObservableStatus = "resolved";
|
|
13
|
+
|
|
14
|
+
get status(): ObservableStatus {
|
|
15
|
+
if (this.disposed) throw new Error("[PicoFlow] Primitive is disposed");
|
|
16
|
+
return this._status;
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
set status(status: ObservableStatus) {
|
|
20
|
+
if (this.disposed) throw new Error("[PicoFlow] Primitive is disposed");
|
|
21
|
+
this._status = status;
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
registerDependency(dependency: IObservable<unknown>): void {
|
|
25
|
+
if (this._disposed) throw new Error("[PicoFlow] Primitive is disposed");
|
|
26
|
+
this._dependencies.add(dependency);
|
|
27
|
+
dependency.registerDependent(this);
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
unregisterDependency(dependency: IObservable<unknown>): void {
|
|
31
|
+
if (this._disposed) throw new Error("[PicoFlow] Primitive is disposed");
|
|
32
|
+
this._dependencies.delete(dependency);
|
|
33
|
+
dependency.unregisterDependent(this);
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
clearDependencies(): void {
|
|
37
|
+
if (this.disposed) throw new Error("[PicoFlow] Primitive is disposed");
|
|
38
|
+
this._dependencies.forEach((dependency) => {
|
|
39
|
+
dependency.unregisterDependent(this);
|
|
40
|
+
});
|
|
41
|
+
this._dependencies.clear();
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
registerDependent(dependent: IObserver): void {
|
|
45
|
+
if (this.disposed) throw new Error("[PicoFlow] Primitive is disposed");
|
|
46
|
+
this._dependents.add(dependent);
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
unregisterDependent(dependent: IObserver): void {
|
|
50
|
+
if (this.disposed) throw new Error("[PicoFlow] Primitive is disposed");
|
|
51
|
+
this._dependents.delete(dependent);
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
notifyDependents(): void {
|
|
55
|
+
if (this.disposed) return;
|
|
56
|
+
this._dependents.forEach((dependent) => {
|
|
57
|
+
dependent.notify();
|
|
58
|
+
});
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
watch(tracker: FlowTracker): void {
|
|
62
|
+
if (this.disposed) throw new Error("[PicoFlow] Primitive is disposed");
|
|
63
|
+
(tracker as unknown as IObserver).registerDependency(this);
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
trigger(): void {
|
|
67
|
+
if (this.disposed) throw new Error("[PicoFlow] Primitive is disposed");
|
|
68
|
+
this.notifyDependents();
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
notify(): void {
|
|
72
|
+
if (this.disposed) throw new Error("[PicoFlow] Primitive is disposed");
|
|
73
|
+
if (this.status === "dirty") return;
|
|
74
|
+
this.status = "dirty";
|
|
75
|
+
this.notifyDependents();
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
override dispose(): void {
|
|
79
|
+
if (this._disposed) throw new Error("[PicoFlow] Primitive is disposed");
|
|
80
|
+
Array.from(this._dependents).forEach((dependant) => {
|
|
81
|
+
dependant.unregisterDependency(this);
|
|
82
|
+
this.unregisterDependent(dependant);
|
|
83
|
+
});
|
|
84
|
+
Array.from(this._dependencies).forEach((dependency) => {
|
|
85
|
+
this.unregisterDependency(dependency);
|
|
86
|
+
});
|
|
87
|
+
|
|
88
|
+
this._disposed = true;
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
abstract execute(): void;
|
|
92
|
+
|
|
93
|
+
abstract subscribe(
|
|
94
|
+
onValue: FlowOnDataListener<T>,
|
|
95
|
+
onError?: FlowOnErrorListener,
|
|
96
|
+
onPending?: FlowOnPendingListener,
|
|
97
|
+
): FlowEffect;
|
|
98
|
+
}
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
import type { FlowEffect, FlowTracker } from "~/api";
|
|
2
|
+
import type { FlowObservable } from "~/api/base/flowObservable";
|
|
3
|
+
import type { FlowOnDataListener, FlowOnErrorListener, FlowOnPendingListener } from "~/api/base/flowSubscribable";
|
|
4
|
+
import { Disposable } from "./disposable";
|
|
5
|
+
import type { IObserver } from "./observer";
|
|
6
|
+
|
|
7
|
+
/**
|
|
8
|
+
* Status of an observable: resolved (has value), pending (async in progress), error (failed), or dirty (needs recomputation).
|
|
9
|
+
*/
|
|
10
|
+
export type ObservableStatus = "resolved" | "pending" | "error" | "dirty";
|
|
11
|
+
|
|
12
|
+
/**
|
|
13
|
+
* Internal interface extending FlowObservable with dependency graph management methods.
|
|
14
|
+
*/
|
|
15
|
+
export interface IObservable<T> extends FlowObservable<T> {
|
|
16
|
+
get status(): ObservableStatus;
|
|
17
|
+
set status(status: ObservableStatus);
|
|
18
|
+
registerDependent(dependent: IObserver): void;
|
|
19
|
+
unregisterDependent(dependent: IObserver): void;
|
|
20
|
+
notifyDependents(): void;
|
|
21
|
+
subscribe(
|
|
22
|
+
onValue: FlowOnDataListener<T>,
|
|
23
|
+
onError?: FlowOnErrorListener,
|
|
24
|
+
onPending?: FlowOnPendingListener,
|
|
25
|
+
): FlowEffect;
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
/**
|
|
29
|
+
* Base implementation managing the dependency graph for reactive observables.
|
|
30
|
+
*/
|
|
31
|
+
export abstract class Observable<T> extends Disposable implements IObservable<T> {
|
|
32
|
+
private _dependents = new Set<IObserver>();
|
|
33
|
+
protected _status: ObservableStatus = "resolved";
|
|
34
|
+
|
|
35
|
+
get status(): ObservableStatus {
|
|
36
|
+
if (this.disposed) throw new Error("[PicoFlow] Primitive is disposed");
|
|
37
|
+
return this._status;
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
set status(status: ObservableStatus) {
|
|
41
|
+
if (this.disposed) throw new Error("[PicoFlow] Primitive is disposed");
|
|
42
|
+
this._status = status;
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
registerDependent(dependent: IObserver): void {
|
|
46
|
+
if (this.disposed) throw new Error("[PicoFlow] Primitive is disposed");
|
|
47
|
+
this._dependents.add(dependent);
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
unregisterDependent(dependent: IObserver): void {
|
|
51
|
+
if (this.disposed) throw new Error("[PicoFlow] Primitive is disposed");
|
|
52
|
+
this._dependents.delete(dependent);
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
notifyDependents(): void {
|
|
56
|
+
if (this.disposed) return; //throw new Error("[PicoFlow] Primitive is disposed");
|
|
57
|
+
this._dependents.forEach((dependent) => {
|
|
58
|
+
dependent.notify();
|
|
59
|
+
});
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
watch(tracker: FlowTracker): void {
|
|
63
|
+
if (this.disposed) throw new Error("[PicoFlow] Primitive is disposed");
|
|
64
|
+
(tracker as unknown as IObserver).registerDependency(this);
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
trigger(): void {
|
|
68
|
+
if (this.disposed) throw new Error("[PicoFlow] Primitive is disposed");
|
|
69
|
+
this.notifyDependents();
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
override dispose(): void {
|
|
73
|
+
if (this._disposed) throw new Error("[PicoFlow] Primitive is disposed");
|
|
74
|
+
Array.from(this._dependents).forEach((dependant) => {
|
|
75
|
+
dependant.unregisterDependency(this);
|
|
76
|
+
this.unregisterDependent(dependant);
|
|
77
|
+
});
|
|
78
|
+
|
|
79
|
+
this._disposed = true;
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
abstract subscribe(
|
|
83
|
+
onValue: FlowOnDataListener<T>,
|
|
84
|
+
onError?: FlowOnErrorListener,
|
|
85
|
+
onPending?: FlowOnPendingListener,
|
|
86
|
+
): FlowEffect;
|
|
87
|
+
}
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
import { Disposable } from "./disposable";
|
|
2
|
+
import type { IObservable } from "./observable";
|
|
3
|
+
|
|
4
|
+
/**
|
|
5
|
+
* Internal interface for reactive computations that track dependencies and respond to changes.
|
|
6
|
+
*/
|
|
7
|
+
export interface IObserver {
|
|
8
|
+
registerDependency(dependency: IObservable<unknown>): void;
|
|
9
|
+
unregisterDependency(dependency: IObservable<unknown>): void;
|
|
10
|
+
clearDependencies(): void;
|
|
11
|
+
notify(): void;
|
|
12
|
+
execute(): void;
|
|
13
|
+
}
|
|
14
|
+
|
|
15
|
+
/**
|
|
16
|
+
* Base implementation managing dependency tracking for reactive observers.
|
|
17
|
+
*/
|
|
18
|
+
export abstract class Observer extends Disposable implements IObserver {
|
|
19
|
+
private _dependencies = new Set<IObservable<unknown>>();
|
|
20
|
+
|
|
21
|
+
registerDependency(dependency: IObservable<unknown>): void {
|
|
22
|
+
if (this._disposed) throw new Error("[PicoFlow] Primitive is disposed");
|
|
23
|
+
this._dependencies.add(dependency);
|
|
24
|
+
dependency.registerDependent(this);
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
unregisterDependency(dependency: IObservable<unknown>): void {
|
|
28
|
+
if (this._disposed) throw new Error("[PicoFlow] Primitive is disposed");
|
|
29
|
+
this._dependencies.delete(dependency);
|
|
30
|
+
dependency.unregisterDependent(this);
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
clearDependencies(): void {
|
|
34
|
+
if (this.disposed) throw new Error("[PicoFlow] Primitive is disposed");
|
|
35
|
+
this._dependencies.forEach((dependency) => {
|
|
36
|
+
dependency.unregisterDependent(this);
|
|
37
|
+
});
|
|
38
|
+
this._dependencies.clear();
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
override dispose(): void {
|
|
42
|
+
if (this._disposed) throw new Error("[PicoFlow] Primitive is disposed");
|
|
43
|
+
Array.from(this._dependencies).forEach((dependency) => {
|
|
44
|
+
this.unregisterDependency(dependency);
|
|
45
|
+
});
|
|
46
|
+
this._disposed = true;
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
abstract notify(): void;
|
|
50
|
+
abstract execute(): void;
|
|
51
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./solid";
|
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
import { createEffect, createResource, onCleanup, onMount, type Resource, resetErrorBoundaries } from "solid-js";
|
|
2
|
+
import { type FlowEffect, type FlowObservable, type FlowTracker, type NotPromise, subscribe } from "~/api";
|
|
3
|
+
import { ValueAsyncNode, ValueSyncNode } from "~/nodes";
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* Internal helper that converts a PicoFlow node into a SolidJS resource.
|
|
7
|
+
* @internal
|
|
8
|
+
*/
|
|
9
|
+
function fromNode<T>(node: ValueAsyncNode<T> | ValueSyncNode<T>): Resource<T> {
|
|
10
|
+
const [resource, { refetch }] = createResource(() => node.pick());
|
|
11
|
+
|
|
12
|
+
let fx: FlowEffect;
|
|
13
|
+
|
|
14
|
+
onMount(() => {
|
|
15
|
+
fx = subscribe(
|
|
16
|
+
// data
|
|
17
|
+
(t) => node.get(t),
|
|
18
|
+
// onData
|
|
19
|
+
() => {
|
|
20
|
+
refetch(); // Force createResource to refetch
|
|
21
|
+
},
|
|
22
|
+
// onError
|
|
23
|
+
() => {
|
|
24
|
+
refetch(); // Force createResource to refetch
|
|
25
|
+
},
|
|
26
|
+
// onPending
|
|
27
|
+
() => {
|
|
28
|
+
refetch(); // Force createResource to refetch
|
|
29
|
+
},
|
|
30
|
+
);
|
|
31
|
+
});
|
|
32
|
+
|
|
33
|
+
createEffect(() => {
|
|
34
|
+
// reset error boundaries when error state changes
|
|
35
|
+
resource.error ?? resource();
|
|
36
|
+
resetErrorBoundaries();
|
|
37
|
+
});
|
|
38
|
+
|
|
39
|
+
onCleanup(() => fx.dispose());
|
|
40
|
+
|
|
41
|
+
return resource;
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
/**
|
|
45
|
+
* Internal helper that wraps a getter function in a PicoFlow node and converts it to a SolidJS resource.
|
|
46
|
+
* @internal
|
|
47
|
+
*/
|
|
48
|
+
function fromGetter<T>(getter: (t: FlowTracker) => NotPromise<T>): Resource<T> {
|
|
49
|
+
const derivation = new ValueSyncNode<T>((t) => {
|
|
50
|
+
return getter(t);
|
|
51
|
+
});
|
|
52
|
+
|
|
53
|
+
return fromNode(derivation);
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
/**
|
|
57
|
+
* Converts a PicoFlow observable or getter function into a SolidJS resource.
|
|
58
|
+
*
|
|
59
|
+
* @param flow - The FlowObservable or getter function to convert.
|
|
60
|
+
* @returns A SolidJS Resource that wraps the value or computation.
|
|
61
|
+
*
|
|
62
|
+
* @remarks
|
|
63
|
+
* This function bridges PicoFlow's reactive system with SolidJS, allowing you to use
|
|
64
|
+
* PicoFlow primitives and computations within Solid components. All conversions return a
|
|
65
|
+
* SolidJS Resource, which can handle both synchronous and asynchronous values seamlessly.
|
|
66
|
+
*
|
|
67
|
+
* The conversion works with:
|
|
68
|
+
* - **FlowObservable**: Any PicoFlow reactive primitive (e.g., from `state()`, `derivation()`, `stateAsync()`, `derivationAsync()`)
|
|
69
|
+
* - **Getter functions**: Computation functions that use a FlowTracker to access reactive values
|
|
70
|
+
*
|
|
71
|
+
* The created Resource automatically subscribes to the PicoFlow observables and updates
|
|
72
|
+
* when their values change. The subscription is properly cleaned up when the Solid
|
|
73
|
+
* component unmounts.
|
|
74
|
+
*
|
|
75
|
+
* @example
|
|
76
|
+
* ```typescript
|
|
77
|
+
* import { from } from 'picoflow/solid';
|
|
78
|
+
* import { state, derivation } from 'picoflow';
|
|
79
|
+
*
|
|
80
|
+
* // Convert a PicoFlow state to a Solid resource
|
|
81
|
+
* const $count = state(0);
|
|
82
|
+
* const solidCount = from($count);
|
|
83
|
+
*
|
|
84
|
+
* // Use in a Solid component
|
|
85
|
+
* function Counter() {
|
|
86
|
+
* return <div>Count: {solidCount()}</div>;
|
|
87
|
+
* }
|
|
88
|
+
*
|
|
89
|
+
* // Or convert a computation function
|
|
90
|
+
* const solidDerived = from((t) => {
|
|
91
|
+
* return $count.get(t) * 2;
|
|
92
|
+
* });
|
|
93
|
+
* ```
|
|
94
|
+
*
|
|
95
|
+
* @public
|
|
96
|
+
*/
|
|
97
|
+
export function from<T>(flow: FlowObservable<T>): Resource<T>;
|
|
98
|
+
export function from<T>(flow: (t: FlowTracker) => NotPromise<T>): Resource<T>;
|
|
99
|
+
export function from<T>(flow: FlowObservable<T> | ((t: FlowTracker) => NotPromise<T>)): Resource<T> {
|
|
100
|
+
if (flow instanceof ValueAsyncNode || flow instanceof ValueSyncNode) {
|
|
101
|
+
return fromNode(flow);
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
if (typeof flow === "function") {
|
|
105
|
+
return fromGetter(flow);
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
throw new Error("Invalid flow type");
|
|
109
|
+
}
|