@ersbeth/picoflow 0.0.1

package/api/doc/picoflow.md

@@ -0,0 +1,287 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [picoflow](./picoflow.md)
+
+## picoflow package
+
+PicoFlow is a lightweight reactive dataflow library that provides a set of reactive primitives such as signals, state, resources, streams, derivations, effects, and reactive maps.
+
+## Classes
+
+<table><thead><tr><th>
+
+Class
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[FlowDerivation](./picoflow.flowderivation.md)
+
+
+</td><td>
+
+Represents a reactive derivation whose value is computed based on other reactive signals.
+
+
+</td></tr>
+<tr><td>
+
+[FlowEffect](./picoflow.floweffect.md)
+
+
+</td><td>
+
+Represents a reactive effect that executes a side‐effect function based on its tracked dependencies.
+
+
+</td></tr>
+<tr><td>
+
+[FlowMap](./picoflow.flowmap.md)
+
+
+</td><td>
+
+Represents a reactive map of states that extends [FlowState](./picoflow.flowstate.md) for a Map of key/value pairs.
+
+
+</td></tr>
+<tr><td>
+
+[FlowResource](./picoflow.flowresource.md)
+
+
+</td><td>
+
+Represents a reactive resource that asynchronously fetches its value.
+
+
+</td></tr>
+<tr><td>
+
+[FlowSignal](./picoflow.flowsignal.md)
+
+
+</td><td>
+
+Represents a reactive signal.
+
+
+</td></tr>
+<tr><td>
+
+[FlowState](./picoflow.flowstate.md)
+
+
+</td><td>
+
+Represents a reactive state that holds a mutable value.
+
+
+</td></tr>
+<tr><td>
+
+[FlowStream](./picoflow.flowstream.md)
+
+
+</td><td>
+
+Represents a reactive stream that updates its value based on an updater function.
+
+
+</td></tr>
+</tbody></table>
+
+## Abstract Classes
+
+<table><thead><tr><th>
+
+Abstract Class
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[FlowObservable](./picoflow.flowobservable.md)
+
+
+</td><td>
+
+Represents a reactive observable that carries a value.
+
+
+</td></tr>
+</tbody></table>
+
+## Functions
+
+<table><thead><tr><th>
+
+Function
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[derivation(fn)](./picoflow.derivation.md)
+
+
+</td><td>
+
+Creates a new reactive derivation whose value is computed based on other reactive signals.
+
+
+</td></tr>
+<tr><td>
+
+[effect(fn)](./picoflow.effect.md)
+
+
+</td><td>
+
+Creates a new reactive effect that executes a side-effect function based on its dependencies.
+
+
+</td></tr>
+<tr><td>
+
+[map(initial)](./picoflow.map.md)
+
+
+</td><td>
+
+Creates a new reactive map state.
+
+
+</td></tr>
+<tr><td>
+
+[resource(fn, initial)](./picoflow.resource.md)
+
+
+</td><td>
+
+Creates a new reactive resource that asynchronously fetches its value.
+
+
+</td></tr>
+<tr><td>
+
+[signal()](./picoflow.signal.md)
+
+
+</td><td>
+
+Creates a new reactive signal.
+
+
+</td></tr>
+<tr><td>
+
+[state(value)](./picoflow.state.md)
+
+
+</td><td>
+
+Creates a new reactive state holding a value.
+
+
+</td></tr>
+<tr><td>
+
+[stream(updater, initial)](./picoflow.stream.md)
+
+
+</td><td>
+
+Creates a new reactive stream.
+
+
+</td></tr>
+</tbody></table>
+
+## Type Aliases
+
+<table><thead><tr><th>
+
+Type Alias
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[FlowDisposer](./picoflow.flowdisposer.md)
+
+
+</td><td>
+
+A function that disposes of a resource.
+
+
+</td></tr>
+<tr><td>
+
+[FlowGetter](./picoflow.flowgetter.md)
+
+
+</td><td>
+
+A function for retrieving the current value from a FlowObservable.
+
+
+</td></tr>
+<tr><td>
+
+[FlowSetter](./picoflow.flowsetter.md)
+
+
+</td><td>
+
+A function that sets a new value.
+
+
+</td></tr>
+<tr><td>
+
+[FlowUpdater](./picoflow.flowupdater.md)
+
+
+</td><td>
+
+A function that performs updates on a stream.
+
+
+</td></tr>
+<tr><td>
+
+[FlowWatcher](./picoflow.flowwatcher.md)
+
+
+</td><td>
+
+A function for watching a FlowSignal.
+
+
+</td></tr>
+</tbody></table>

package/api/doc/picoflow.resource.md

@@ -0,0 +1,71 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [resource](./picoflow.resource.md)
+
+## resource() function
+
+Creates a new reactive resource that asynchronously fetches its value.
+
+**Signature:**
+
+```typescript
+export declare function resource<T>(fn: () => Promise<T>, initial: T): FlowResource<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>
+<tr><td>
+
+initial
+
+
+</td><td>
+
+T
+
+
+</td><td>
+
+The initial value of the resource.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[FlowResource](./picoflow.flowresource.md)<!-- -->&lt;T&gt;
+
+A new instance of [FlowResource](./picoflow.flowresource.md)<!-- -->.
+

package/api/doc/picoflow.signal.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [signal](./picoflow.signal.md)
+
+## signal() function
+
+Creates a new reactive signal.
+
+**Signature:**
+
+```typescript
+export declare function signal(): FlowSignal;
+```
+**Returns:**
+
+[FlowSignal](./picoflow.flowsignal.md)
+
+A new instance of [FlowSignal](./picoflow.flowsignal.md)<!-- -->.
+

package/api/doc/picoflow.state.md

@@ -0,0 +1,55 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [state](./picoflow.state.md)
+
+## state() function
+
+Creates a new reactive state holding a value.
+
+**Signature:**
+
+```typescript
+export declare function state<T>(value: T): FlowState<T>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+value
+
+
+</td><td>
+
+T
+
+
+</td><td>
+
+The initial value for the state.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[FlowState](./picoflow.flowstate.md)<!-- -->&lt;T&gt;
+
+A new instance of [FlowState](./picoflow.flowstate.md)<!-- -->.
+

package/api/doc/picoflow.stream.md

@@ -0,0 +1,71 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [stream](./picoflow.stream.md)
+
+## stream() function
+
+Creates a new reactive stream.
+
+**Signature:**
+
+```typescript
+export declare function stream<T>(updater: (set: (value: T) => void) => () => void, initial: T): FlowStream<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>
+<tr><td>
+
+initial
+
+
+</td><td>
+
+T
+
+
+</td><td>
+
+The initial value of the stream.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[FlowStream](./picoflow.flowstream.md)<!-- -->&lt;T&gt;
+
+A new instance of [FlowStream](./picoflow.flowstream.md)<!-- -->.
+

package/api/picoflow.api.md

@@ -0,0 +1,145 @@
+## API Report File for "picoflow"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+// @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 FlowDerivation<T> extends FlowObservable<T> {
+    constructor(compute: (get: FlowGetter, watch: FlowWatcher) => T);
+    // @internal
+    _exec(): void;
+    get(): T;
+    // @internal
+    _notify(): void;
+    // @internal
+    _watch(): void;
+}
+
+// @public
+export type FlowDisposer = () => void;
+
+// @public
+export class FlowEffect {
+    constructor(apply: (get: FlowGetter, watch: FlowWatcher) => void);
+    dispose(): void;
+    get disposed(): boolean;
+    // @internal
+    _exec(): void;
+    // @internal
+    _registerDependency(dependency: FlowSignal): void;
+    // @internal
+    _unregisterDependency(dependency: FlowSignal): void;
+}
+
+// @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;
+    // @internal
+    _getFrom(listener: FlowObservable<unknown> | FlowEffect): T;
+    // @internal
+    protected _value: T;
+}
+
+// @public
+export class FlowResource<T> extends FlowObservable<T> {
+    constructor(fetch: () => Promise<T>, initial: T);
+    fetch(): Promise<void>;
+    get(): T;
+}
+
+// @public
+export type FlowSetter<T> = (value: T) => void;
+
+// @public
+export class FlowSignal {
+    // @internal (undocumented)
+    protected _dependencies: Set<FlowSignal>;
+    dispose(): void;
+    get disposed(): boolean;
+    // @internal (undocumented)
+    protected _disposed: boolean;
+    // @internal (undocumented)
+    protected _effects: Set<FlowEffect>;
+    // @internal (undocumented)
+    protected _listeners: Set<FlowSignal>;
+    // @internal
+    _notify(): void;
+    // @internal
+    _registerDependency(dependency: FlowSignal): void;
+    // @internal
+    _registerEffect(effect: FlowEffect): void;
+    // @internal
+    _registerListener(signal: FlowSignal): void;
+    trigger(): void;
+    // @internal
+    _unregisterDependency(dependency: FlowSignal): void;
+    // @internal
+    _unregisterEffect(effect: FlowEffect): void;
+    // @internal
+    _unregisterListener(signal: FlowSignal): void;
+    // @internal
+    _watch(): void;
+    // @internal
+    _watchFrom(listener: FlowSignal | FlowEffect): void;
+}
+
+// @public
+export class FlowState<T> extends FlowObservable<T> {
+    constructor(value: T);
+    get(): T;
+    set(value: T): void;
+}
+
+// @public
+export class FlowStream<T> extends FlowObservable<T> {
+    constructor(updater: FlowUpdater<T>, initial: T);
+    dispose(): void;
+    get(): T;
+}
+
+// @public
+export type FlowUpdater<T> = (set: FlowSetter<T>) => FlowDisposer;
+
+// @public
+export type FlowWatcher = (signal: FlowSignal) => void;
+
+// @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>, initial: T): FlowResource<T>;
+
+// @public
+export function signal(): FlowSignal;
+
+// @public
+export function state<T>(value: T): FlowState<T>;
+
+// @public
+export function stream<T>(updater: (set: (value: T) => void) => () => void, initial: T): FlowStream<T>;
+
+```

package/api-extractor.json

@@ -0,0 +1,60 @@
+{
+    "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+    "mainEntryPointFilePath": "<projectFolder>/dist/types/index.d.ts",
+    "newlineKind": "lf",
+
+    "apiReport": {
+        "enabled": true,
+        "reportFolder": "<projectFolder>/api/",
+        "reportTempFolder": "<projectFolder>/api/temp/"
+    },
+
+    "docModel": {
+        "enabled": true,
+        "apiJsonFilePath": "<projectFolder>/api/temp/<unscopedPackageName>.api.json",
+
+        /**
+         * The base URL where the project's source code can be viewed on a website such as GitHub or
+         * Azure DevOps. This URL path corresponds to the `<projectFolder>` path on disk.
+         *
+         * This URL is concatenated with the file paths serialized to the doc model to produce URL file paths to individual API items.
+         * For example, if the `projectFolderUrl` is "https://github.com/microsoft/rushstack/tree/main/apps/api-extractor" and an API
+         * item's file path is "api/ExtractorConfig.ts", the full URL file path would be
+         * "https://github.com/microsoft/rushstack/tree/main/apps/api-extractor/api/ExtractorConfig.js".
+         *
+         * This setting can be omitted if you don't need source code links in your API documentation reference.
+         *
+         * SUPPORTED TOKENS: none
+         * DEFAULT VALUE: ""
+         */
+        "projectFolderUrl": "https://gitlab.com/ersbeth-web/picomachine"
+    },
+
+    "dtsRollup": {
+        "enabled": false
+    },
+
+    "tsdocMetadata": {
+        "enabled": false
+    },
+
+    "messages": {
+        "compilerMessageReporting": {
+            "default": {
+                "logLevel": "warning"
+            }
+        },
+
+        "extractorMessageReporting": {
+            "default": {
+                "logLevel": "warning"
+            }
+        },
+
+        "tsdocMessageReporting": {
+            "default": {
+                "logLevel": "warning"
+            }
+        }
+    }
+}