@ersbeth/picoflow 0.0.1 → 0.2.0

package/api/doc/picoflow.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [picoflow](./picoflow.md)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md)
 
 ## picoflow package
 
@@ -21,6 +21,28 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[FlowArray](./picoflow.flowarray.md)
+
+
+</td><td>
+
+Represents a reactive array.
+
+
+</td></tr>
+<tr><td>
+
+[FlowConstant](./picoflow.flowconstant.md)
+
+
+</td><td>
+
+Represents a reactive and immutable constant value computed lazily upon first access.
+
+
+</td></tr>
+<tr><td>
+
 [FlowDerivation](./picoflow.flowderivation.md)
 
 
@@ -37,7 +59,7 @@ Represents a reactive derivation whose value is computed based on other reactive
 
 </td><td>
 
-Represents a reactive effect that executes a side‐effect function based on its tracked dependencies.
+Represents a reactive effect that executes side-effect functions based on its tracked dependencies.
 
 
 </td></tr>
@@ -48,7 +70,7 @@ Represents a reactive effect that executes a side‐effect function based on its
 
 </td><td>
 
-Represents a reactive map of states that extends [FlowState](./picoflow.flowstate.md) for a Map of key/value pairs.
+Represents a reactive map of states extending [FlowState](./picoflow.flowstate.md) for a Map of key/value pairs.
 
 
 </td></tr>
@@ -62,6 +84,17 @@ Represents a reactive map of states that extends [FlowState](./picoflow.flowstat
 Represents a reactive resource that asynchronously fetches its value.
 
 
+</td></tr>
+<tr><td>
+
+[FlowResourceAsync](./picoflow.flowresourceasync.md)
+
+
+</td><td>
+
+Represents a reactive resource that asynchronously fetches its value.
+
+
 </td></tr>
 <tr><td>
 
@@ -95,6 +128,17 @@ Represents a reactive state that holds a mutable value.
 Represents a reactive stream that updates its value based on an updater function.
 
 
+</td></tr>
+<tr><td>
+
+[FlowStreamAsync](./picoflow.flowstreamasync.md)
+
+
+</td><td>
+
+Represents an asynchronous reactive stream that updates its value based on an updater function.
+
+
 </td></tr>
 </tbody></table>
 
@@ -118,7 +162,7 @@ Description
 
 </td><td>
 
-Represents a reactive observable that carries a value.
+Represents a reactive observable that holds and tracks a value.
 
 
 </td></tr>
@@ -139,6 +183,28 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[array(initial)](./picoflow.array.md)
+
+
+</td><td>
+
+Creates a new reactive array.
+
+
+</td></tr>
+<tr><td>
+
+[constant(value)](./picoflow.constant.md)
+
+
+</td><td>
+
+Creates a new reactive constant.
+
+
+</td></tr>
+<tr><td>
+
 [derivation(fn)](./picoflow.derivation.md)
 
 
@@ -158,6 +224,17 @@ Creates a new reactive derivation whose value is computed based on other reactiv
 Creates a new reactive effect that executes a side-effect function based on its dependencies.
 
 
+</td></tr>
+<tr><td>
+
+[isDisposable(obj)](./picoflow.isdisposable.md)
+
+
+</td><td>
+
+Checks whether an object implements the FlowDisposable interface.
+
+
 </td></tr>
 <tr><td>
 
@@ -172,7 +249,7 @@ Creates a new reactive map state.
 </td></tr>
 <tr><td>
 
-[resource(fn, initial)](./picoflow.resource.md)
+[resource(fn)](./picoflow.resource.md)
 
 
 </td><td>
@@ -180,6 +257,17 @@ Creates a new reactive map state.
 Creates a new reactive resource that asynchronously fetches its value.
 
 
+</td></tr>
+<tr><td>
+
+[resourceAsync(fn)](./picoflow.resourceasync.md)
+
+
+</td><td>
+
+Creates a new reactive asynchronous resource that fetches its value.
+
+
 </td></tr>
 <tr><td>
 
@@ -205,7 +293,7 @@ Creates a new reactive state holding a value.
 </td></tr>
 <tr><td>
 
-[stream(updater, initial)](./picoflow.stream.md)
+[stream(updater)](./picoflow.stream.md)
 
 
 </td><td>
@@ -213,6 +301,43 @@ Creates a new reactive state holding a value.
 Creates a new reactive stream.
 
 
+</td></tr>
+<tr><td>
+
+[streamAsync(updater)](./picoflow.streamasync.md)
+
+
+</td><td>
+
+Creates a new reactive asynchronous stream.
+
+
+</td></tr>
+</tbody></table>
+
+## Interfaces
+
+<table><thead><tr><th>
+
+Interface
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[FlowDisposable](./picoflow.flowdisposable.md)
+
+
+</td><td>
+
+Represents an object with a disposable lifecycle.
+
+
 </td></tr>
 </tbody></table>
 
@@ -231,12 +356,12 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[FlowDisposer](./picoflow.flowdisposer.md)
+[FlowArrayAction](./picoflow.flowarrayaction.md)
 
 
 </td><td>
 
-A function that disposes of a resource.
+Represents the actions that can be performed on a FlowArray.
 
 
 </td></tr>
@@ -247,29 +372,40 @@ A function that disposes of a resource.
 
 </td><td>
 
-A function for retrieving the current value from a FlowObservable.
+A function that retrieves the current value from a FlowObservable.
+
+
+</td></tr>
+<tr><td>
+
+[FlowStreamDisposer](./picoflow.flowstreamdisposer.md)
+
+
+</td><td>
+
+A function type that disposes of a resource.
 
 
 </td></tr>
 <tr><td>
 
-[FlowSetter](./picoflow.flowsetter.md)
+[FlowStreamSetter](./picoflow.flowstreamsetter.md)
 
 
 </td><td>
 
-A function that sets a new value.
+A function type that sets a new value for the reactive stream.
 
 
 </td></tr>
 <tr><td>
 
-[FlowUpdater](./picoflow.flowupdater.md)
+[FlowStreamUpdater](./picoflow.flowstreamupdater.md)
 
 
 </td><td>
 
-A function that performs updates on a stream.
+A function type that updates a stream and returns a disposer for cleanup.
 
 
 </td></tr>

package/api/doc/picoflow.resource.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [resource](./picoflow.resource.md)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [resource](./picoflow.resource.md)
 
 ## resource() function
 
@@ -9,7 +9,7 @@ Creates a new reactive resource that asynchronously fetches its value.
 **Signature:**
 
 ```typescript
-export declare function resource<T>(fn: () => Promise<T>, initial: T): FlowResource<T>;
+export declare function resource<T>(fn: () => Promise<T>): FlowResource<T>;
 ```
 
 ## Parameters
@@ -45,22 +45,6 @@ fn
 An asynchronous function that fetches the resource value.
 
 
-</td></tr>
-<tr><td>
-
-initial
-
-
-</td><td>
-
-T
-
-
-</td><td>
-
-The initial value of the resource.
-
-
 </td></tr>
 </tbody></table>
 **Returns:**

package/api/doc/picoflow.resourceasync.md

@@ -0,0 +1,55 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [resourceAsync](./picoflow.resourceasync.md)
+
+## resourceAsync() function
+
+Creates a new reactive asynchronous resource that fetches its value.
+
+**Signature:**
+
+```typescript
+export declare function resourceAsync<T>(fn: () => Promise<T>): FlowResourceAsync<T>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+fn
+
+
+</td><td>
+
+() =&gt; Promise&lt;T&gt;
+
+
+</td><td>
+
+An asynchronous function that fetches the resource value.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[FlowResourceAsync](./picoflow.flowresourceasync.md)<!-- -->&lt;T&gt;
+
+A new instance of [FlowResourceAsync](./picoflow.flowresourceasync.md)<!-- -->.
+

package/api/doc/picoflow.signal.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [signal](./picoflow.signal.md)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [signal](./picoflow.signal.md)
 
 ## signal() function
 

package/api/doc/picoflow.state.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [state](./picoflow.state.md)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [state](./picoflow.state.md)
 
 ## state() function
 
@@ -9,7 +9,7 @@ Creates a new reactive state holding a value.
 **Signature:**
 
 ```typescript
-export declare function state<T>(value: T): FlowState<T>;
+export declare function state<T>(value: T | (() => T)): FlowState<T>;
 ```
 
 ## Parameters
@@ -37,7 +37,7 @@ value
 
 </td><td>
 
-T
+T \| (() =&gt; T)
 
 
 </td><td>

package/api/doc/picoflow.stream.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [stream](./picoflow.stream.md)
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [stream](./picoflow.stream.md)
 
 ## stream() function
 
@@ -9,7 +9,7 @@ Creates a new reactive stream.
 **Signature:**
 
 ```typescript
-export declare function stream<T>(updater: (set: (value: T) => void) => () => void, initial: T): FlowStream<T>;
+export declare function stream<T>(updater: (set: (value: T) => void) => () => void): FlowStream<T>;
 ```
 
 ## Parameters
@@ -45,22 +45,6 @@ updater
 A function that receives a setter to update the stream's value. It should return a disposer function to clean up resources.
 
 
-</td></tr>
-<tr><td>
-
-initial
-
-
-</td><td>
-
-T
-
-
-</td><td>
-
-The initial value of the stream.
-
-
 </td></tr>
 </tbody></table>
 **Returns:**

package/api/doc/picoflow.streamasync.md

@@ -0,0 +1,55 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ersbeth/picoflow](./picoflow.md) &gt; [streamAsync](./picoflow.streamasync.md)
+
+## streamAsync() function
+
+Creates a new reactive asynchronous stream.
+
+**Signature:**
+
+```typescript
+export declare function streamAsync<T>(updater: (set: (value: T) => void) => () => void): FlowStreamAsync<T>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+updater
+
+
+</td><td>
+
+(set: (value: T) =&gt; void) =&gt; () =&gt; void
+
+
+</td><td>
+
+A function that receives a setter to update the stream's value. It should return a disposer function to clean up resources.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[FlowStreamAsync](./picoflow.flowstreamasync.md)<!-- -->&lt;T&gt;
+
+A new instance of [FlowStreamAsync](./picoflow.flowstreamasync.md)<!-- -->.
+

package/api/picoflow.public.api.md

@@ -0,0 +1,192 @@
+## Public API Report File for "@ersbeth/picoflow"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+// @public
+export function array<T>(initial?: T[]): FlowArray<T>;
+
+// @public
+export function constant<T>(value: T | (() => T)): FlowConstant<T>;
+
+// @public
+export function derivation<T>(fn: (get: FlowGetter, watch: FlowWatcher) => T): FlowDerivation<T>;
+
+// @public
+export function effect(fn: (get: FlowGetter, watch: FlowWatcher) => void): FlowEffect;
+
+// @public
+export class FlowArray<T> extends FlowObservable<T[]> {
+    $lastAction: FlowState<FlowArrayAction<T>>;
+    constructor(value?: T[]);
+    clear(): void;
+    dispose(options?: {
+        self: boolean;
+    }): void;
+    get(): T[];
+    get length(): number;
+    pop(): void;
+    push(item: T): void;
+    set(items: T[]): void;
+    setItem(index: number, item: T): void;
+    shift(): void;
+    splice(start: number, deleteCount: number, ...newItems: T[]): void;
+    unshift(item: T): void;
+}
+
+// @public
+export type FlowArrayAction<T> = {
+    type: "set";
+    items: T[];
+} | {
+    type: "setItem";
+    index: number;
+    item: T;
+} | {
+    type: "push";
+    item: T;
+} | {
+    type: "pop";
+} | {
+    type: "unshift";
+    item: T;
+} | {
+    type: "shift";
+} | {
+    type: "splice";
+    start: number;
+    deleteCount: number;
+    items: T[];
+} | {
+    type: "clear";
+};
+
+// @public
+export class FlowConstant<T> extends FlowObservable<T> {
+    constructor(value: T | (() => T));
+    get(): T;
+}
+
+// @public
+export class FlowDerivation<T> extends FlowObservable<T> {
+    constructor(compute: (get: FlowGetter, watch: FlowWatcher) => T);
+    get(): T;
+}
+
+// @public
+export interface FlowDisposable {
+    dispose(options?: {
+        self: boolean;
+    }): void;
+}
+
+// @public
+export class FlowEffect {
+    constructor(apply: (get: FlowGetter, watch: FlowWatcher) => void);
+    dispose(): void;
+    get disposed(): boolean;
+}
+
+// @public
+export type FlowGetter = <T>(observable: FlowObservable<T>) => T;
+
+// @public
+export class FlowMap<K, V> extends FlowState<Map<K, V>> {
+    $lastDeleted: FlowState<{
+        key?: K;
+        value?: V;
+    }>;
+    $lastSet: FlowState<{
+        key?: K;
+        value?: V;
+    }>;
+    delete(key: K): void;
+    setAt(key: K, value: V): void;
+}
+
+// @public
+export abstract class FlowObservable<T> extends FlowSignal {
+    abstract get(): T;
+    subscribe(listener: (value: T) => void): () => void;
+}
+
+// @public
+export class FlowResource<T> extends FlowObservable<T | undefined> {
+    constructor(fetch: () => Promise<T>);
+    fetch(): Promise<void>;
+    get(): T | undefined;
+}
+
+// @public
+export class FlowResourceAsync<T> extends FlowObservable<Promise<T>> {
+    constructor(fetch: () => Promise<T>);
+    fetch(): Promise<void>;
+    get(): Promise<T>;
+}
+
+// @public
+export class FlowSignal implements FlowDisposable {
+    dispose(options?: {
+        self: boolean;
+    }): void;
+    get disposed(): boolean;
+    trigger(): void;
+}
+
+// @public
+export class FlowState<T> extends FlowConstant<T> {
+    set(value: T | ((current: T) => T)): void;
+}
+
+// @public
+export class FlowStream<T> extends FlowObservable<T | undefined> {
+    constructor(updater: FlowStreamUpdater<T>);
+    dispose(): void;
+    get(): T | undefined;
+}
+
+// @public
+export class FlowStreamAsync<T> extends FlowObservable<Promise<T>> {
+    constructor(updater: FlowStreamUpdater<T>);
+    dispose(): void;
+    get(): Promise<T>;
+}
+
+// @public
+export type FlowStreamDisposer = () => void;
+
+// @public
+export type FlowStreamSetter<T> = (value: T) => void;
+
+// @public
+export type FlowStreamUpdater<T> = (set: FlowStreamSetter<T>) => FlowStreamDisposer;
+
+// @public
+export type FlowWatcher = (signal: FlowSignal) => void;
+
+// @public
+export function isDisposable(obj: unknown): obj is FlowDisposable;
+
+// @public
+export function map<K extends string | number | symbol, V>(initial?: Record<K, V>): FlowMap<K, V>;
+
+// @public
+export function resource<T>(fn: () => Promise<T>): FlowResource<T>;
+
+// @public
+export function resourceAsync<T>(fn: () => Promise<T>): FlowResourceAsync<T>;
+
+// @public
+export function signal(): FlowSignal;
+
+// @public
+export function state<T>(value: T | (() => T)): FlowState<T>;
+
+// @public
+export function stream<T>(updater: (set: (value: T) => void) => () => void): FlowStream<T>;
+
+// @public
+export function streamAsync<T>(updater: (set: (value: T) => void) => () => void): FlowStreamAsync<T>;
+
+```

package/api-extractor.json

@@ -6,7 +6,8 @@
     "apiReport": {
         "enabled": true,
         "reportFolder": "<projectFolder>/api/",
-        "reportTempFolder": "<projectFolder>/api/temp/"
+        "reportTempFolder": "<projectFolder>/api/temp/",
+        "reportVariants": ["public"]
     },
 
     "docModel": {