@ersbeth/picoflow 1.1.2 → 2.0.1

package/docs/api/interfaces/FlowArray.md

@@ -0,0 +1,439 @@
+[@ersbeth/picoflow](/api/index.md) / FlowArray
+
+# Interface: FlowArray\<T\>
+
+Defined in: [api/nodes/collections/flowArray.ts:65](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/collections/flowArray.ts#L65)
+
+Reactive array with standard mutation methods and fine-grained change tracking.
+
+FlowArray behaves like a regular array but notifies dependents on mutations. It provides all standard
+array mutation methods (push, pop, splice, etc.) and tracks each operation via the `$lastAction` signal.
+This enables both coarse-grained reactivity (reacting to any change) and fine-grained reactivity (reacting
+only to specific mutations). Use for lists that need reactive updates, such as todo lists, data tables,
+or any collection that changes over time.
+
+## Extends
+
+- [`FlowState`](/api/interfaces/FlowState.md)\<`T`[]\>
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` |
+
+## Properties
+
+| Property | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="lastaction"></a> `$lastAction` | [`FlowState`](/api/interfaces/FlowState.md)\<[`FlowArrayAction`](/api/type-aliases/FlowArrayAction.md)\<`T`\>\> | Reactive state containing the last mutation operation performed on the array. Subscribe to this for fine-grained reactivity to specific mutation types. | [api/nodes/collections/flowArray.ts:136](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/collections/flowArray.ts#L136) |
+| <a id="length"></a> `length` | `number` | The current length of the array. | [api/nodes/collections/flowArray.ts:130](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/collections/flowArray.ts#L130) |
+
+## Accessors
+
+### disposed
+
+#### Get Signature
+
+```ts
+get disposed(): boolean;
+```
+
+Defined in: [api/base/flowDisposable.ts:17](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/base/flowDisposable.ts#L17)
+
+Indicates whether this resource has been disposed.
+
+Returns `true` if `dispose()` has been called, `false` otherwise. Once disposed,
+the resource is no longer usable and any operations on it will throw errors.
+
+##### Returns
+
+`boolean`
+
+#### Inherited from
+
+[`FlowState`](/api/interfaces/FlowState.md).[`disposed`](/api/interfaces/FlowState.md#disposed)
+
+## Methods
+
+### clear()
+
+```ts
+clear(): T[];
+```
+
+Defined in: [api/nodes/collections/flowArray.ts:125](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/collections/flowArray.ts#L125)
+
+Removes all items from the array.
+Emits a "clear" action to $lastAction.
+
+#### Returns
+
+`T`[]
+
+Array of all removed items
+
+***
+
+### dispose()
+
+```ts
+dispose(): void;
+```
+
+Defined in: [api/base/flowDisposable.ts:27](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/base/flowDisposable.ts#L27)
+
+Releases all resources held by this disposable object.
+
+Cleans up all subscriptions, dependencies, and internal state. After calling this method,
+the resource enters a disposed state and cannot be reused. Any subsequent operations will
+throw errors. This method should be called when you no longer need the reactive primitive
+to prevent memory leaks.
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`FlowState`](/api/interfaces/FlowState.md).[`dispose`](/api/interfaces/FlowState.md#dispose)
+
+***
+
+### get()
+
+```ts
+get(tracker): T[];
+```
+
+Defined in: [api/nodes/flowValue.ts:24](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/flowValue.ts#L24)
+
+Gets the current value and establishes a reactive dependency.
+
+When called from within a reactive computation, this method registers the value as a dependency,
+ensuring the computation re-executes when the value changes. The value is computed on first access
+(if lazy) and then cached. For async values, throws PendingError while the value is resolving.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `tracker` | [`FlowTracker`](/api/interfaces/FlowTracker.md) | Tracker that records this value as a dependency |
+
+#### Returns
+
+`T`[]
+
+The current value
+
+#### Inherited from
+
+[`FlowState`](/api/interfaces/FlowState.md).[`get`](/api/interfaces/FlowState.md#get)
+
+***
+
+### pick()
+
+```ts
+pick(): Promise<T[]>;
+```
+
+Defined in: [api/nodes/flowValue.ts:35](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/flowValue.ts#L35)
+
+Asynchronously gets the current value without establishing a reactive dependency.
+
+This method reads the value non-reactively, meaning it won't trigger re-execution of the calling
+computation when the value changes. The value is computed on first access (if lazy) and then cached.
+For async values, the promise resolves once the value is available.
+
+#### Returns
+
+`Promise`\<`T`[]\>
+
+Promise that resolves with the current value
+
+#### Inherited from
+
+[`FlowState`](/api/interfaces/FlowState.md).[`pick`](/api/interfaces/FlowState.md#pick)
+
+***
+
+### pop()
+
+```ts
+pop(): T | undefined;
+```
+
+Defined in: [api/nodes/collections/flowArray.ts:90](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/collections/flowArray.ts#L90)
+
+Removes and returns the last item from the array.
+Emits a "pop" action to $lastAction.
+
+#### Returns
+
+`T` \| `undefined`
+
+The removed item, or undefined if the array was empty
+
+***
+
+### push()
+
+```ts
+push(item): void;
+```
+
+Defined in: [api/nodes/collections/flowArray.ts:82](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/collections/flowArray.ts#L82)
+
+Appends an item to the end of the array.
+Emits a "push" action to $lastAction.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `item` | `T` | The item to append |
+
+#### Returns
+
+`void`
+
+***
+
+### set()
+
+#### Call Signature
+
+```ts
+set(value): void;
+```
+
+Defined in: [api/nodes/sync/flowState.ts:25](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/sync/flowState.ts#L25)
+
+Updates the state with a new value or via an updater function.
+Notifies all dependents after the update.
+
+##### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `T`[] | New value to set, or function that receives current value and returns new value |
+
+##### Returns
+
+`void`
+
+##### Inherited from
+
+[`FlowState`](/api/interfaces/FlowState.md).[`set`](/api/interfaces/FlowState.md#set)
+
+#### Call Signature
+
+```ts
+set(updater): void;
+```
+
+Defined in: [api/nodes/sync/flowState.ts:26](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/sync/flowState.ts#L26)
+
+##### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `updater` | [`UpdateFunction`](/api/type-aliases/UpdateFunction.md)\<`T`[]\> |
+
+##### Returns
+
+`void`
+
+##### Inherited from
+
+[`FlowState`](/api/interfaces/FlowState.md).[`set`](/api/interfaces/FlowState.md#set)
+
+***
+
+### shift()
+
+```ts
+shift(): T | undefined;
+```
+
+Defined in: [api/nodes/collections/flowArray.ts:106](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/collections/flowArray.ts#L106)
+
+Removes and returns the first item from the array.
+Emits a "shift" action to $lastAction.
+
+#### Returns
+
+`T` \| `undefined`
+
+The removed item, or undefined if the array was empty
+
+***
+
+### splice()
+
+```ts
+splice(
+   start, 
+   deleteCount, ...
+   newItems): T[];
+```
+
+Defined in: [api/nodes/collections/flowArray.ts:117](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/collections/flowArray.ts#L117)
+
+Changes the content of the array by removing, replacing, or adding items.
+Emits a "splice" action to $lastAction.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `start` | `number` | The starting index |
+| `deleteCount` | `number` | Number of items to remove |
+| ...`newItems` | `T`[] | New items to add at the start position |
+
+#### Returns
+
+`T`[]
+
+Array of removed items
+
+***
+
+### subscribe()
+
+```ts
+subscribe(
+   onData, 
+   onError?, 
+   onPending?): FlowEffect;
+```
+
+Defined in: [api/base/flowSubscribable.ts:82](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/base/flowSubscribable.ts#L82)
+
+Subscribes to this observable with lifecycle callbacks.
+
+Creates an active subscription that executes immediately and then re-executes whenever
+the observable's dependencies change. The subscription remains active until the returned
+disposal function is called. The `onData` callback receives the computed value, while
+`onError` handles errors and `onPending` signals async operations in progress.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `onData` | [`FlowOnDataListener`](/api/type-aliases/FlowOnDataListener.md)\<`T`[]\> | Callback invoked with the computed data on each execution |
+| `onError?` | [`FlowOnErrorListener`](/api/type-aliases/FlowOnErrorListener.md) | Optional callback for handling errors during execution |
+| `onPending?` | [`FlowOnPendingListener`](/api/type-aliases/FlowOnPendingListener.md) | Optional callback invoked when async dependencies are pending |
+
+#### Returns
+
+[`FlowEffect`](/api/interfaces/FlowEffect.md)
+
+A function to dispose the subscription and stop receiving updates
+
+#### Inherited from
+
+[`FlowState`](/api/interfaces/FlowState.md).[`subscribe`](/api/interfaces/FlowState.md#subscribe)
+
+***
+
+### trigger()
+
+```ts
+trigger(): void;
+```
+
+Defined in: [api/base/flowObservable.ts:27](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/base/flowObservable.ts#L27)
+
+Manually triggers notifications to all dependents.
+
+Forces all dependents of this observable to be notified and re-executed, even if the
+value hasn't actually changed. Useful for imperatively triggering updates when the
+reactive system cannot detect changes automatically.
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`FlowState`](/api/interfaces/FlowState.md).[`trigger`](/api/interfaces/FlowState.md#trigger)
+
+***
+
+### unshift()
+
+```ts
+unshift(item): void;
+```
+
+Defined in: [api/nodes/collections/flowArray.ts:98](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/collections/flowArray.ts#L98)
+
+Inserts an item at the beginning of the array.
+Emits an "unshift" action to $lastAction.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `item` | `T` | The item to insert |
+
+#### Returns
+
+`void`
+
+***
+
+### update()
+
+```ts
+update(index, item): T | undefined;
+```
+
+Defined in: [api/nodes/collections/flowArray.ts:74](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/collections/flowArray.ts#L74)
+
+Replaces an item at a specific index.
+Emits an "update" action to $lastAction.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `index` | `number` | The index of the item to replace |
+| `item` | `T` | The new item |
+
+#### Returns
+
+`T` \| `undefined`
+
+The previous item at that index
+
+***
+
+### watch()
+
+```ts
+watch(tracker): void;
+```
+
+Defined in: [api/base/flowObservable.ts:18](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/base/flowObservable.ts#L18)
+
+Establishes a reactive dependency without reading the value.
+
+Registers this observable as a dependency of the given tracker, allowing it to be notified
+when changes occur. This enables dependency tracking without accessing the actual value.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `tracker` | [`FlowTracker`](/api/interfaces/FlowTracker.md) | Tracker that records this observable as a dependency |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`FlowState`](/api/interfaces/FlowState.md).[`watch`](/api/interfaces/FlowState.md#watch)

package/docs/api/interfaces/FlowConstant.md

@@ -0,0 +1,220 @@
+[@ersbeth/picoflow](/api/index.md) / FlowConstant
+
+# Interface: FlowConstant\<T\>
+
+Defined in: [api/nodes/sync/flowConstant.ts:17](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/sync/flowConstant.ts#L17)
+
+Read-only reactive value that computes once on initialization and never changes.
+
+Constants provide lazy initialization - the value isn't computed until first accessed via `get()` or `pick()`.
+Once computed, the value is cached forever. Use constants for expensive computations that only need to run once,
+such as loading configuration, computing static lookups, or initializing resources.
+
+## Extends
+
+- [`FlowValue`](/api/interfaces/FlowValue.md)\<`T`\>
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` |
+
+## Accessors
+
+### disposed
+
+#### Get Signature
+
+```ts
+get disposed(): boolean;
+```
+
+Defined in: [api/base/flowDisposable.ts:17](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/base/flowDisposable.ts#L17)
+
+Indicates whether this resource has been disposed.
+
+Returns `true` if `dispose()` has been called, `false` otherwise. Once disposed,
+the resource is no longer usable and any operations on it will throw errors.
+
+##### Returns
+
+`boolean`
+
+#### Inherited from
+
+[`FlowValue`](/api/interfaces/FlowValue.md).[`disposed`](/api/interfaces/FlowValue.md#disposed)
+
+## Methods
+
+### dispose()
+
+```ts
+dispose(): void;
+```
+
+Defined in: [api/base/flowDisposable.ts:27](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/base/flowDisposable.ts#L27)
+
+Releases all resources held by this disposable object.
+
+Cleans up all subscriptions, dependencies, and internal state. After calling this method,
+the resource enters a disposed state and cannot be reused. Any subsequent operations will
+throw errors. This method should be called when you no longer need the reactive primitive
+to prevent memory leaks.
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`FlowValue`](/api/interfaces/FlowValue.md).[`dispose`](/api/interfaces/FlowValue.md#dispose)
+
+***
+
+### get()
+
+```ts
+get(tracker): T;
+```
+
+Defined in: [api/nodes/flowValue.ts:24](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/flowValue.ts#L24)
+
+Gets the current value and establishes a reactive dependency.
+
+When called from within a reactive computation, this method registers the value as a dependency,
+ensuring the computation re-executes when the value changes. The value is computed on first access
+(if lazy) and then cached. For async values, throws PendingError while the value is resolving.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `tracker` | [`FlowTracker`](/api/interfaces/FlowTracker.md) | Tracker that records this value as a dependency |
+
+#### Returns
+
+`T`
+
+The current value
+
+#### Inherited from
+
+[`FlowValue`](/api/interfaces/FlowValue.md).[`get`](/api/interfaces/FlowValue.md#get)
+
+***
+
+### pick()
+
+```ts
+pick(): Promise<T>;
+```
+
+Defined in: [api/nodes/flowValue.ts:35](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/nodes/flowValue.ts#L35)
+
+Asynchronously gets the current value without establishing a reactive dependency.
+
+This method reads the value non-reactively, meaning it won't trigger re-execution of the calling
+computation when the value changes. The value is computed on first access (if lazy) and then cached.
+For async values, the promise resolves once the value is available.
+
+#### Returns
+
+`Promise`\<`T`\>
+
+Promise that resolves with the current value
+
+#### Inherited from
+
+[`FlowValue`](/api/interfaces/FlowValue.md).[`pick`](/api/interfaces/FlowValue.md#pick)
+
+***
+
+### subscribe()
+
+```ts
+subscribe(
+   onData, 
+   onError?, 
+   onPending?): FlowEffect;
+```
+
+Defined in: [api/base/flowSubscribable.ts:82](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/base/flowSubscribable.ts#L82)
+
+Subscribes to this observable with lifecycle callbacks.
+
+Creates an active subscription that executes immediately and then re-executes whenever
+the observable's dependencies change. The subscription remains active until the returned
+disposal function is called. The `onData` callback receives the computed value, while
+`onError` handles errors and `onPending` signals async operations in progress.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `onData` | [`FlowOnDataListener`](/api/type-aliases/FlowOnDataListener.md)\<`T`\> | Callback invoked with the computed data on each execution |
+| `onError?` | [`FlowOnErrorListener`](/api/type-aliases/FlowOnErrorListener.md) | Optional callback for handling errors during execution |
+| `onPending?` | [`FlowOnPendingListener`](/api/type-aliases/FlowOnPendingListener.md) | Optional callback invoked when async dependencies are pending |
+
+#### Returns
+
+[`FlowEffect`](/api/interfaces/FlowEffect.md)
+
+A function to dispose the subscription and stop receiving updates
+
+#### Inherited from
+
+[`FlowValue`](/api/interfaces/FlowValue.md).[`subscribe`](/api/interfaces/FlowValue.md#subscribe)
+
+***
+
+### trigger()
+
+```ts
+trigger(): void;
+```
+
+Defined in: [api/base/flowObservable.ts:27](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/base/flowObservable.ts#L27)
+
+Manually triggers notifications to all dependents.
+
+Forces all dependents of this observable to be notified and re-executed, even if the
+value hasn't actually changed. Useful for imperatively triggering updates when the
+reactive system cannot detect changes automatically.
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`FlowValue`](/api/interfaces/FlowValue.md).[`trigger`](/api/interfaces/FlowValue.md#trigger)
+
+***
+
+### watch()
+
+```ts
+watch(tracker): void;
+```
+
+Defined in: [api/base/flowObservable.ts:18](https://gitlab.com/ersbeth-web/picoflow/-/blob/4e864254f0eac72524c3be40b9e41d799a16e020/src/api/base/flowObservable.ts#L18)
+
+Establishes a reactive dependency without reading the value.
+
+Registers this observable as a dependency of the given tracker, allowing it to be notified
+when changes occur. This enables dependency tracking without accessing the actual value.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `tracker` | [`FlowTracker`](/api/interfaces/FlowTracker.md) | Tracker that records this observable as a dependency |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`FlowValue`](/api/interfaces/FlowValue.md).[`watch`](/api/interfaces/FlowValue.md#watch)