@ersbeth/picoflow 1.1.1 → 2.0.0

package/dist/types/solid/primitives.d.ts

@@ -1,181 +0,0 @@
-import { ResourceFetcher } from 'solid-js';
-/**
- * A getter function or value for Solid state/derivation.
- *
- * @typeParam T - The value type.
- * @public
- */
-export type SolidGetter<T> = ((previous: T) => T) | T;
-/**
- * Interface for a Solid-style observable value.
- *
- * @typeParam T - The value type.
- * @public
- */
-export interface SolidObservable<T> {
-    /**
-     * Returns the current value.
-     */
-    get: () => T;
-}
-/**
- * Solid-style state container wrapping SolidJS's createSignal, providing a writable reactive signal.
- *
- * @remarks
- * SolidState is a thin wrapper around SolidJS's `createSignal` that provides a class-based
- * interface consistent with PicoFlow's API style. It's used internally by PicoFlow's Solid
- * integration but can also be used directly in Solid components.
- *
- * Unlike PicoFlow's {@link FlowState} which uses explicit tracking context, SolidState
- * relies on SolidJS's automatic dependency tracking within reactive contexts like
- * `createEffect` or component render functions.
- *
- * @example
- * ```typescript
- * const count = new SolidState(0);
- *
- * // In a Solid component
- * function Counter() {
- *   return <div>{count.get()}</div>; // Automatically reactive
- * }
- *
- * // Update the value
- * count.set(1);
- * count.set(prev => prev + 1);
- * ```
- *
- * @typeParam T - The value type.
- * @public
- */
-export declare class SolidState<T> implements SolidObservable<T> {
-    /**
-     * Returns the current value.
-     */
-    readonly get: () => T;
-    /**
-     * Sets the value or updates it using a getter function.
-     */
-    readonly set: (param: SolidGetter<T>) => void;
-    /**
-     * Creates a new SolidState with the given initial value.
-     * @param initialValue - The initial value.
-     */
-    constructor(initialValue: T);
-}
-/**
- * Solid-style derivation wrapping SolidJS's createMemo, providing a computed reactive value.
- *
- * @remarks
- * SolidDerivation is a thin wrapper around SolidJS's `createMemo` that provides a class-based
- * interface consistent with PicoFlow's API style. It creates a memoized computation that
- * automatically tracks its dependencies and recomputes only when they change.
- *
- * Unlike PicoFlow's {@link FlowDerivation} which uses explicit tracking context, SolidDerivation
- * relies on SolidJS's automatic dependency tracking. The computation function runs within
- * SolidJS's reactive scope and automatically subscribes to any signals accessed during execution.
- *
- * **Memoization:**
- * The computed value is cached and only recomputed when tracked dependencies change,
- * providing efficient derived state management.
- *
- * @example
- * ```typescript
- * const firstName = new SolidState('John');
- * const lastName = new SolidState('Doe');
- *
- * const fullName = new SolidDerivation(() => {
- *   return `${firstName.get()} ${lastName.get()}`;
- * });
- *
- * // In a Solid component
- * function Display() {
- *   return <div>{fullName.get()}</div>; // Automatically updates
- * }
- * ```
- *
- * @typeParam T - The value type.
- * @public
- */
-export declare class SolidDerivation<T> implements SolidObservable<T> {
-    /**
-     * Returns the current derived value.
-     */
-    readonly get: () => T;
-    /**
-     * Creates a new SolidDerivation from a getter function or value.
-     * @param calculator - The getter function or value.
-     */
-    constructor(calculator: SolidGetter<T>);
-}
-/**
- * Solid-style resource wrapping SolidJS's createResource, providing async data loading with reactive state.
- *
- * @remarks
- * SolidResource is a thin wrapper around SolidJS's `createResource` that provides a class-based
- * interface consistent with PicoFlow's API style. It manages asynchronous data fetching with
- * built-in loading states, error handling, and automatic reactivity.
- *
- * Unlike PicoFlow's {@link FlowResource} or {@link FlowResourceAsync}, SolidResource integrates
- * directly with SolidJS's Suspense and ErrorBoundary mechanisms, providing a first-class async
- * data loading experience in Solid applications.
- *
- * **Resource States:**
- * - `unresolved`: Initial state before first fetch
- * - `pending`: Fetch is in progress
- * - `ready`: Data has been successfully loaded
- * - `refreshing`: Refetching while previous data is still available
- * - `errored`: Fetch failed with an error
- *
- * **Properties:**
- * - `get()`: Returns the current value (or undefined if not ready)
- * - `state()`: Returns the current loading state
- * - `latest()`: Returns the most recent successfully loaded value
- * - `refetch()`: Triggers a new fetch operation
- *
- * @example
- * ```typescript
- * const user = new SolidResource(async () => {
- *   const res = await fetch('/api/user');
- *   return res.json();
- * });
- *
- * // In a Solid component
- * function UserProfile() {
- *   return (
- *     <div>
- *       {user.state() === 'pending' && <p>Loading...</p>}
- *       {user.state() === 'ready' && <p>Name: {user.get()?.name}</p>}
- *       <button onClick={() => user.refetch()}>Refresh</button>
- *     </div>
- *   );
- * }
- * ```
- *
- * @typeParam T - The value type.
- * @public
- */
-export declare class SolidResource<T> implements SolidObservable<T | undefined> {
-    /**
-     * Returns the current value (or undefined if not yet loaded).
-     */
-    readonly get: () => T | undefined;
-    /**
-     * Returns the current resource state.
-     */
-    readonly state: () => "unresolved" | "pending" | "errored" | "ready" | "refreshing";
-    /**
-     * Returns the latest successfully loaded value (or undefined).
-     */
-    readonly latest: () => T | undefined;
-    /**
-     * Triggers a refetch of the resource.
-     */
-    readonly refetch: () => void;
-    readonly set: (param: SolidGetter<T>) => void;
-    /**
-     * Creates a new SolidResource from a fetcher function.
-     * @param fetcher - The async fetcher function.
-     */
-    constructor(fetcher: ResourceFetcher<true, T, unknown>);
-}
-//# sourceMappingURL=primitives.d.ts.map

package/dist/types/solid/primitives.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"primitives.d.ts","sourceRoot":"","sources":["../../../src/solid/primitives.ts"],"names":[],"mappings":"AAAA,OAAO,EAIN,KAAK,eAAe,EACpB,MAAM,UAAU,CAAC;AAElB;;;;;GAKG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC;AAEtD;;;;;GAKG;AACH,MAAM,WAAW,eAAe,CAAC,CAAC;IACjC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC,CAAC;CACb;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,qBAAa,UAAU,CAAC,CAAC,CAAE,YAAW,eAAe,CAAC,CAAC,CAAC;IACvD;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IACtB;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;IAE9C;;;OAGG;gBACS,YAAY,EAAE,CAAC;CAK3B;AAGD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,qBAAa,eAAe,CAAC,CAAC,CAAE,YAAW,eAAe,CAAC,CAAC,CAAC;IAC5D;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IAEtB;;;OAGG;gBACS,UAAU,EAAE,WAAW,CAAC,CAAC,CAAC;CAItC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,qBAAa,aAAa,CAAC,CAAC,CAAE,YAAW,eAAe,CAAC,CAAC,GAAG,SAAS,CAAC;IACtE;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,SAAS,CAAC;IAClC;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MACb,YAAY,GACZ,SAAS,GACT,SAAS,GACT,OAAO,GACP,YAAY,CAAC;IAChB;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,CAAC;IACrC;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,IAAI,CAAC;IAE7B,QAAQ,CAAC,GAAG,EAAE,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;IAE9C;;;OAGG;gBACS,OAAO,EAAE,eAAe,CAAC,IAAI,EAAE,CAAC,EAAE,OAAO,CAAC;CAStD"}

package/docs/api/classes/FlowArray.md

@@ -1,489 +0,0 @@
-[@ersbeth/picoflow](/api/index.md) / FlowArray
-
-# Class: FlowArray\<T\>
-
-Defined in: [advanced/array.ts:46](https://gitlab.com/ersbeth-web/picoflow/-/blob/a6cd2e5702b60b87a8efe22e2fe7d2ce3b0ccca4/src/advanced/array.ts#L46)
-
-Represents a reactive array.
-
-## Extends
-
-- [`FlowObservable`](/api/classes/FlowObservable.md)\<`T`[]\>
-
-## Type Parameters
-
-| Type Parameter |
-| ------ |
-| `T` |
-
-## Constructors
-
-### Constructor
-
-```ts
-new FlowArray<T>(value): FlowArray<T>;
-```
-
-Defined in: [advanced/array.ts:58](https://gitlab.com/ersbeth-web/picoflow/-/blob/a6cd2e5702b60b87a8efe22e2fe7d2ce3b0ccca4/src/advanced/array.ts#L58)
-
-Creates an instance of FlowArray.
-
-#### Parameters
-
-| Parameter | Type | Default value | Description |
-| ------ | ------ | ------ | ------ |
-| `value` | `T`[] | `[]` | Initial array value. |
-
-#### Returns
-
-`FlowArray`\<`T`\>
-
-#### Overrides
-
-[`FlowObservable`](/api/classes/FlowObservable.md).[`constructor`](/api/classes/FlowObservable.md#constructor)
-
-## Properties
-
-| Property | Modifier | Type | Description | Defined in |
-| ------ | ------ | ------ | ------ | ------ |
-| <a id="lastaction"></a> `$lastAction` | `public` | [`FlowState`](/api/classes/FlowState.md)\<[`FlowArrayAction`](/api/type-aliases/FlowArrayAction.md)\<`T`\>\> | Last action performed on the FlowArray. | [advanced/array.ts:51](https://gitlab.com/ersbeth-web/picoflow/-/blob/a6cd2e5702b60b87a8efe22e2fe7d2ce3b0ccca4/src/advanced/array.ts#L51) |
-
-## Accessors
-
-### disposed
-
-#### Get Signature
-
-```ts
-get disposed(): boolean;
-```
-
-Defined in: [basic/signal.ts:97](https://gitlab.com/ersbeth-web/picoflow/-/blob/a6cd2e5702b60b87a8efe22e2fe7d2ce3b0ccca4/src/basic/signal.ts#L97)
-
-Indicates whether the FlowSignal has been disposed.
-
-##### Remarks
-
-Once disposed, the signal should not be used.
-
-##### Returns
-
-`boolean`
-
-#### Inherited from
-
-[`FlowObservable`](/api/classes/FlowObservable.md).[`disposed`](/api/classes/FlowObservable.md#disposed)
-
-***
-
-### length
-
-#### Get Signature
-
-```ts
-get length(): number;
-```
-
-Defined in: [advanced/array.ts:72](https://gitlab.com/ersbeth-web/picoflow/-/blob/a6cd2e5702b60b87a8efe22e2fe7d2ce3b0ccca4/src/advanced/array.ts#L72)
-
-Gets the current length of the array.
-
-##### Returns
-
-`number`
-
-The length of the array.
-
-## Methods
-
-### clear()
-
-```ts
-clear(): void;
-```
-
-Defined in: [advanced/array.ts:195](https://gitlab.com/ersbeth-web/picoflow/-/blob/a6cd2e5702b60b87a8efe22e2fe7d2ce3b0ccca4/src/advanced/array.ts#L195)
-
-Clears all items from the array.
-
-#### Returns
-
-`void`
-
-***
-
-### dispose()
-
-```ts
-dispose(options?): void;
-```
-
-Defined in: [advanced/array.ts:211](https://gitlab.com/ersbeth-web/picoflow/-/blob/a6cd2e5702b60b87a8efe22e2fe7d2ce3b0ccca4/src/advanced/array.ts#L211)
-
-Disposes the FlowArray and its items.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `options?` | \{ `self`: `boolean`; \} | Disposal options. |
-| `options.self?` | `boolean` | - |
-
-#### Returns
-
-`void`
-
-#### Overrides
-
-[`FlowObservable`](/api/classes/FlowObservable.md).[`dispose`](/api/classes/FlowObservable.md#dispose)
-
-***
-
-### get()
-
-```ts
-get(context): T[];
-```
-
-Defined in: [basic/observable.ts:47](https://gitlab.com/ersbeth-web/picoflow/-/blob/a6cd2e5702b60b87a8efe22e2fe7d2ce3b0ccca4/src/basic/observable.ts#L47)
-
-Gets the current value with optional dependency tracking.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `context` | [`TrackingContext`](/api/classes/TrackingContext.md) \| `null` | The tracking context for reactive tracking, or null for untracked access. When a context is provided, this observable is registered as a dependency. When null, the value is read without any tracking. |
-
-#### Returns
-
-`T`[]
-
-The current value of type T.
-
-#### Remarks
-
-Use `get(t)` within effects and derivations to create reactive dependencies.
-Use `get(null)` when you need to read a value without tracking (though `pick()` is more idiomatic).
-
-#### Example
-
-```typescript
-effect((t) => {
-  const tracked = $state.get(t);     // Dependency registered
-  const untracked = $other.get(null); // No dependency
-});
-```
-
-#### Inherited from
-
-[`FlowObservable`](/api/classes/FlowObservable.md).[`get`](/api/classes/FlowObservable.md#get)
-
-***
-
-### pick()
-
-```ts
-pick(): T[];
-```
-
-Defined in: [basic/observable.ts:82](https://gitlab.com/ersbeth-web/picoflow/-/blob/a6cd2e5702b60b87a8efe22e2fe7d2ce3b0ccca4/src/basic/observable.ts#L82)
-
-Gets the current value without any dependency tracking.
-
-#### Returns
-
-`T`[]
-
-The current value of type T.
-
-#### Remarks
-
-This method is equivalent to calling `get(null)` but provides a more semantic and readable API.
-Use `pick()` when you want to read a snapshot of the current value without creating a reactive
-dependency. This is useful for:
-- Reading initial values
-- Accessing configuration that shouldn't trigger updates
-- Mixing tracked and untracked reads in the same effect
-
-#### Example
-
-```typescript
-// Read a snapshot outside reactive context
-const currentValue = $state.pick();
-
-// Mix tracked and untracked reads
-effect((t) => {
-  const tracked = $reactive.get(t);    // Triggers re-runs
-  const snapshot = $config.pick();     // Doesn't trigger re-runs
-  processData(tracked, snapshot);
-});
-```
-
-#### Inherited from
-
-[`FlowObservable`](/api/classes/FlowObservable.md).[`pick`](/api/classes/FlowObservable.md#pick)
-
-***
-
-### pop()
-
-```ts
-pop(): void;
-```
-
-Defined in: [advanced/array.ts:133](https://gitlab.com/ersbeth-web/picoflow/-/blob/a6cd2e5702b60b87a8efe22e2fe7d2ce3b0ccca4/src/advanced/array.ts#L133)
-
-Removes the last item from the array.
-
-#### Returns
-
-`void`
-
-***
-
-### push()
-
-```ts
-push(item): void;
-```
-
-Defined in: [advanced/array.ts:122](https://gitlab.com/ersbeth-web/picoflow/-/blob/a6cd2e5702b60b87a8efe22e2fe7d2ce3b0ccca4/src/advanced/array.ts#L122)
-
-Appends an item to the end of the array.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `item` | `T` | The item to append. |
-
-#### Returns
-
-`void`
-
-***
-
-### set()
-
-```ts
-set(items): void;
-```
-
-Defined in: [advanced/array.ts:91](https://gitlab.com/ersbeth-web/picoflow/-/blob/a6cd2e5702b60b87a8efe22e2fe7d2ce3b0ccca4/src/advanced/array.ts#L91)
-
-Replaces the entire array with new items.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `items` | `T`[] | The new array of items. |
-
-#### Returns
-
-`void`
-
-***
-
-### setItem()
-
-```ts
-setItem(index, item): void;
-```
-
-Defined in: [advanced/array.ts:107](https://gitlab.com/ersbeth-web/picoflow/-/blob/a6cd2e5702b60b87a8efe22e2fe7d2ce3b0ccca4/src/advanced/array.ts#L107)
-
-Replaces an item at a specific index.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `index` | `number` | The index of the item to replace. |
-| `item` | `T` | The new item. |
-
-#### Returns
-
-`void`
-
-***
-
-### shift()
-
-```ts
-shift(): void;
-```
-
-Defined in: [advanced/array.ts:159](https://gitlab.com/ersbeth-web/picoflow/-/blob/a6cd2e5702b60b87a8efe22e2fe7d2ce3b0ccca4/src/advanced/array.ts#L159)
-
-Removes the first item from the array.
-
-#### Returns
-
-`void`
-
-***
-
-### splice()
-
-```ts
-splice(
-   start, 
-   deleteCount, ...
-   newItems): void;
-```
-
-Defined in: [advanced/array.ts:176](https://gitlab.com/ersbeth-web/picoflow/-/blob/a6cd2e5702b60b87a8efe22e2fe7d2ce3b0ccca4/src/advanced/array.ts#L176)
-
-Changes the content of the array.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `start` | `number` | The starting index. |
-| `deleteCount` | `number` | Number of items to remove. |
-| ...`newItems` | `T`[] | New items to add. |
-
-#### Returns
-
-`void`
-
-***
-
-### subscribe()
-
-```ts
-subscribe(listener): () => void;
-```
-
-Defined in: [basic/observable.ts:103](https://gitlab.com/ersbeth-web/picoflow/-/blob/a6cd2e5702b60b87a8efe22e2fe7d2ce3b0ccca4/src/basic/observable.ts#L103)
-
-Subscribes a listener function to changes of the observable.
-The listener is executed immediately with the current value and on subsequent updates.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `listener` | (`value`) => `void` | A callback function that receives the new value. |
-
-#### Returns
-
-A disposer function to cancel the subscription.
-
-```ts
-(): void;
-```
-
-##### Returns
-
-`void`
-
-#### Inherited from
-
-[`FlowObservable`](/api/classes/FlowObservable.md).[`subscribe`](/api/classes/FlowObservable.md#subscribe)
-
-***
-
-### trigger()
-
-```ts
-trigger(): void;
-```
-
-Defined in: [basic/signal.ts:19](https://gitlab.com/ersbeth-web/picoflow/-/blob/a6cd2e5702b60b87a8efe22e2fe7d2ce3b0ccca4/src/basic/signal.ts#L19)
-
-Triggers the FlowSignal.
-Notifies all registered listeners and schedules execution of associated effects.
-
-#### Returns
-
-`void`
-
-#### Throws
-
-If the FlowSignal has already been disposed.
-
-#### Inherited from
-
-[`FlowObservable`](/api/classes/FlowObservable.md).[`trigger`](/api/classes/FlowObservable.md#trigger)
-
-***
-
-### unshift()
-
-```ts
-unshift(item): void;
-```
-
-Defined in: [advanced/array.ts:148](https://gitlab.com/ersbeth-web/picoflow/-/blob/a6cd2e5702b60b87a8efe22e2fe7d2ce3b0ccca4/src/advanced/array.ts#L148)
-
-Inserts an item at the beginning of the array.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `item` | `T` | The item to insert. |
-
-#### Returns
-
-`void`
-
-***
-
-### watch()
-
-```ts
-watch(context): void;
-```
-
-Defined in: [basic/signal.ts:57](https://gitlab.com/ersbeth-web/picoflow/-/blob/a6cd2e5702b60b87a8efe22e2fe7d2ce3b0ccca4/src/basic/signal.ts#L57)
-
-Watches the signal, registering it as a dependency in the tracking context.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `context` | [`TrackingContext`](/api/classes/TrackingContext.md) | The tracking context in which to register this signal as a dependency. |
-
-#### Returns
-
-`void`
-
-#### Remarks
-
-Use `watch()` when you want to track a signal without reading its value (signals don't
-have values to read). This is useful for triggering effects based on signal events
-without needing associated data.
-
-When the signal is triggered via `trigger()`, any effects or derivations that have
-watched this signal will automatically re-execute.
-
-This method must be called within an effect or derivation context where a TrackingContext
-is available. For observables (which hold values), use `.get(t)` instead, which both
-reads the value and watches for changes.
-
-#### Throws
-
-Error if the signal has been disposed.
-
-#### Example
-
-```typescript
-const $signal = signal();
-
-effect((t) => {
-  $signal.watch(t);  // Track the signal
-  console.log('Signal triggered!');
-});
-
-$signal.trigger(); // Logs: "Signal triggered!"
-```
-
-#### Inherited from
-
-[`FlowObservable`](/api/classes/FlowObservable.md).[`watch`](/api/classes/FlowObservable.md#watch)