@ersbeth/picoflow 0.0.1 → 0.1.0

package/test/resourceAsync.test.ts

@@ -0,0 +1,108 @@
+import { describe, expect, test, vi } from "vitest";
+import { effect, resourceAsync } from "#package";
+
+describe("resourceAsync", () => {
+    test("is updated", async () => {
+        let resourceCounter = 0;
+        const fetchResource = async () => {
+            resourceCounter++;
+            return resourceCounter;
+        };
+
+        const $resource = resourceAsync(fetchResource);
+        expect(await $resource.get()).toBe(1);
+
+        $resource.fetch();
+        expect(await $resource.get()).toBe(2);
+
+        $resource.fetch();
+        expect(await $resource.get()).toBe(3);
+    });
+
+    test("fetch throws when disposed", async () => {
+        let resourceCounter = 0;
+        const fetchResource = async () => {
+            resourceCounter++;
+            return resourceCounter;
+        };
+
+        const $resource = resourceAsync(fetchResource);
+        expect(await $resource.get()).toBe(1);
+
+        $resource.fetch();
+        expect(await $resource.get()).toBe(2);
+
+        $resource.dispose();
+        await expect(() => $resource.fetch()).rejects.toThrow(
+            "[PicoFlow] Primitive is disposed",
+        );
+    });
+
+    test("get throws when disposed", async () => {
+        let resourceCounter = 0;
+        const fetchResource = async () => {
+            resourceCounter++;
+            return resourceCounter;
+        };
+
+        const $resource = resourceAsync(fetchResource);
+        expect(await $resource.get()).toBe(1);
+
+        $resource.fetch();
+        expect(await $resource.get()).toBe(2);
+
+        $resource.dispose();
+        expect(() => $resource.get()).toThrow(
+            "[PicoFlow] Primitive is disposed",
+        );
+    });
+});
+
+describe("effect", () => {
+    test("called when resource updated", async () => {
+        let resourceCounter = 0;
+        const fetchResource = async () => {
+            resourceCounter++;
+            return resourceCounter;
+        };
+
+        const $resource = resourceAsync(fetchResource);
+        const effectFn = vi.fn();
+        effect((get) => effectFn(get($resource)));
+
+        expect(effectFn).toHaveBeenCalledTimes(1);
+        expect(await effectFn.mock.calls[0][0]).toBe(1);
+
+        $resource.fetch();
+        expect(effectFn).toHaveBeenCalledTimes(2);
+        expect(await effectFn.mock.calls[1][0]).toBe(2);
+
+        await $resource.fetch();
+        expect(effectFn).toHaveBeenCalledTimes(3);
+        expect(await effectFn.mock.calls[2][0]).toBe(3);
+    });
+
+    test("NOT called when disposed", async () => {
+        let resourceCounter = 0;
+        const fetchResource = async () => {
+            resourceCounter++;
+            return resourceCounter;
+        };
+
+        const $resource = resourceAsync(fetchResource);
+        const effectFn = vi.fn();
+        const $effect = effect((get) => effectFn(get($resource)));
+
+        expect(effectFn).toHaveBeenCalledTimes(1);
+        expect(await effectFn.mock.calls[0][0]).toBe(1);
+
+        await $resource.fetch();
+        expect(effectFn).toHaveBeenCalledTimes(2);
+        expect(await effectFn.mock.calls[1][0]).toBe(2);
+
+        $effect.dispose();
+        await $resource.fetch();
+        expect(effectFn).toHaveBeenCalledTimes(2);
+        expect(await effectFn.mock.calls[1][0]).toBe(2);
+    });
+});

package/test/signal.test.ts

@@ -2,6 +2,13 @@ import { describe, expect, test, vi } from "vitest";
 import { effect, signal } from "#package";
 
 describe("signal", () => {
+    test("disposed is correct", () => {
+        const $signal = signal();
+        expect($signal.disposed).toBe(false);
+        $signal.dispose();
+        expect($signal.disposed).toBe(true);
+    });
+
     test("throws when disposed", () => {
         const $signal = signal();
         const effectFn = vi.fn();
@@ -16,7 +23,17 @@ describe("signal", () => {
         expect(effectFn).toHaveBeenCalledTimes(2);
 
         $signal.dispose();
-        expect(() => $signal.trigger()).toThrow("Signal is disposed");
+        expect(() => $signal.trigger()).toThrow(
+            "[PicoFlow] Primitive is disposed",
+        );
+    });
+
+    test("throws when disposed twice", () => {
+        const $signal = signal();
+        $signal.dispose();
+        expect(() => $signal.dispose()).toThrow(
+            "[PicoFlow] Primitive is disposed",
+        );
     });
 });
 

package/test/state.test.ts

@@ -2,6 +2,16 @@ import { describe, expect, test, vi } from "vitest";
 import { effect, state } from "#package";
 
 describe("state", () => {
+    test("is initialized", () => {
+        const $state = state(1);
+        expect($state.get()).toBe(1);
+    });
+
+    test("is lazy initialized", () => {
+        const $state = state(() => 1);
+        expect($state.get()).toBe(1);
+    });
+
     test("is updated", () => {
         const $state = state(1);
         expect($state.get()).toBe(1);
@@ -10,6 +20,14 @@ describe("state", () => {
         expect($state.get()).toBe(2);
     });
 
+    test("is updated from current", () => {
+        const $state = state(1);
+        expect($state.get()).toBe(1);
+
+        $state.set((state) => state + 1);
+        expect($state.get()).toBe(2);
+    });
+
     test("set throws when disposed", () => {
         const $state = state(1);
 
@@ -20,7 +38,7 @@ describe("state", () => {
 
         $state.dispose();
 
-        expect(() => $state.set(3)).toThrow("State is disposed");
+        expect(() => $state.set(3)).toThrow("[PicoFlow] Primitive is disposed");
     });
 
     test("get throws when disposed", () => {
@@ -33,11 +51,29 @@ describe("state", () => {
 
         $state.dispose();
 
-        expect(() => $state.get()).toThrow("State is disposed");
+        expect(() => $state.get()).toThrow("[PicoFlow] Primitive is disposed");
     });
 });
 
 describe("effect", () => {
+    test("called with init value", () => {
+        const $state = state(1);
+        const effectFn = vi.fn();
+        effect((get) => effectFn(get($state)));
+
+        expect(effectFn).toHaveBeenCalledTimes(1);
+        expect(effectFn).toHaveBeenLastCalledWith(1);
+    });
+
+    test("called with lazy init value", () => {
+        const $state = state(() => 1);
+        const effectFn = vi.fn();
+        effect((get) => effectFn(get($state)));
+
+        expect(effectFn).toHaveBeenCalledTimes(1);
+        expect(effectFn).toHaveBeenLastCalledWith(1);
+    });
+
     test("called when updated", () => {
         const $state = state(1);
         const effectFn = vi.fn();
@@ -87,3 +123,72 @@ describe("effect", () => {
         expect(effectFn).toHaveBeenLastCalledWith(2);
     });
 });
+
+describe("subscribe", () => {
+    test("called with init value", () => {
+        const $state = state(1);
+        const effectFn = vi.fn();
+        $state.subscribe((value) => effectFn(value));
+
+        expect(effectFn).toHaveBeenCalledTimes(1);
+        expect(effectFn).toHaveBeenLastCalledWith(1);
+    });
+
+    test("called with lazy init value", () => {
+        const $state = state(() => 1);
+        const effectFn = vi.fn();
+        $state.subscribe((value) => effectFn(value));
+
+        expect(effectFn).toHaveBeenCalledTimes(1);
+        expect(effectFn).toHaveBeenLastCalledWith(1);
+    });
+
+    test("called when updated", () => {
+        const $state = state(1);
+        const effectFn = vi.fn();
+        $state.subscribe((value) => effectFn(value));
+
+        expect(effectFn).toHaveBeenCalledTimes(1);
+        expect(effectFn).toHaveBeenLastCalledWith(1);
+
+        $state.set(2);
+        expect(effectFn).toHaveBeenCalledTimes(2);
+        expect(effectFn).toHaveBeenLastCalledWith(2);
+    });
+
+    test("NOT called when updated with the same value", () => {
+        const $state = state(1);
+        const effectFn = vi.fn();
+        $state.subscribe((value) => effectFn(value));
+
+        expect(effectFn).toHaveBeenCalledTimes(1);
+        expect(effectFn).toHaveBeenLastCalledWith(1);
+
+        $state.set(2);
+        expect(effectFn).toHaveBeenCalledTimes(2);
+        expect(effectFn).toHaveBeenLastCalledWith(2);
+
+        $state.set(2);
+        expect(effectFn).toHaveBeenCalledTimes(2);
+        expect(effectFn).toHaveBeenLastCalledWith(2);
+    });
+
+    test("NOT called when disposed", () => {
+        const $state = state(1);
+        const effectFn = vi.fn();
+        const unsubscribe = $state.subscribe((value) => effectFn(value));
+
+        expect(effectFn).toHaveBeenCalledTimes(1);
+        expect(effectFn).toHaveBeenLastCalledWith(1);
+
+        $state.set(2);
+        expect(effectFn).toHaveBeenCalledTimes(2);
+        expect(effectFn).toHaveBeenLastCalledWith(2);
+
+        unsubscribe();
+
+        $state.set(3);
+        expect(effectFn).toHaveBeenCalledTimes(2);
+        expect(effectFn).toHaveBeenLastCalledWith(2);
+    });
+});

package/test/stream.test.ts

@@ -19,9 +19,9 @@ describe("stream", () => {
             return () => {
                 counter.callback = undefined;
             };
-        }, counter.count);
+        });
 
-        expect($stream.get()).toBe(0);
+        expect($stream.get()).toBe(undefined);
 
         counter.increment();
         expect($stream.get()).toBe(1);
@@ -40,9 +40,9 @@ describe("stream", () => {
                 set(counter);
             }, 1000);
             return () => clearInterval(interval);
-        }, 0);
+        });
 
-        expect($stream.get()).toBe(0);
+        expect($stream.get()).toBe(undefined);
 
         vi.advanceTimersToNextTimer();
         expect($stream.get()).toBe(1);
@@ -61,9 +61,9 @@ describe("stream", () => {
                 set(counter);
             }, 1000);
             return () => clearInterval(interval);
-        }, 0);
+        });
 
-        expect($stream.get()).toBe(0);
+        expect($stream.get()).toBe(undefined);
 
         vi.advanceTimersToNextTimer();
         expect($stream.get()).toBe(1);
@@ -73,7 +73,7 @@ describe("stream", () => {
 
         $stream.dispose();
         vi.advanceTimersToNextTimer();
-        expect(() => $stream.get()).toThrow("Stream is disposed");
+        expect(() => $stream.get()).toThrow("[PicoFlow] Primitive is disposed");
     });
 });
 
@@ -88,13 +88,13 @@ describe("effect", () => {
                 set(counter);
             }, 1000);
             return () => clearInterval(interval);
-        }, 0);
+        });
 
         const effectFn = vi.fn();
         effect((get) => effectFn(get($stream)));
 
         expect(effectFn).toHaveBeenCalledTimes(1);
-        expect(effectFn).toHaveBeenLastCalledWith(0);
+        expect(effectFn).toHaveBeenLastCalledWith(undefined);
 
         vi.advanceTimersToNextTimer();
         expect(effectFn).toHaveBeenCalledTimes(2);
@@ -105,6 +105,31 @@ describe("effect", () => {
         expect(effectFn).toHaveBeenLastCalledWith(2);
     });
 
+    test("NOT called when stream is updated with same value", async () => {
+        vi.useFakeTimers();
+
+        const $stream = stream((set) => {
+            const interval = setInterval(() => {
+                set(5);
+            }, 1000);
+            return () => clearInterval(interval);
+        });
+
+        const effectFn = vi.fn();
+        effect((get) => effectFn(get($stream)));
+
+        expect(effectFn).toHaveBeenCalledTimes(1);
+        expect(effectFn).toHaveBeenLastCalledWith(undefined);
+
+        vi.advanceTimersToNextTimer();
+        expect(effectFn).toHaveBeenCalledTimes(2);
+        expect(effectFn).toHaveBeenLastCalledWith(5);
+
+        vi.advanceTimersToNextTimer();
+        expect(effectFn).toHaveBeenCalledTimes(2);
+        expect(effectFn).toHaveBeenLastCalledWith(5);
+    });
+
     test("NOT called when  disposed", async () => {
         vi.useFakeTimers();
 
@@ -115,13 +140,13 @@ describe("effect", () => {
                 set(counter);
             }, 1000);
             return () => clearInterval(interval);
-        }, 0);
+        });
 
         const effectFn = vi.fn();
         const $effect = effect((get) => effectFn(get($stream)));
 
         expect(effectFn).toHaveBeenCalledTimes(1);
-        expect(effectFn).toHaveBeenLastCalledWith(0);
+        expect(effectFn).toHaveBeenLastCalledWith(undefined);
 
         vi.advanceTimersToNextTimer();
         expect(effectFn).toHaveBeenCalledTimes(2);
@@ -147,13 +172,13 @@ describe("effect", () => {
                 set(counter);
             }, 1000);
             return () => clearInterval(interval);
-        }, 0);
+        });
 
         const effectFn = vi.fn();
         effect((get) => effectFn(get($stream)));
 
         expect(effectFn).toHaveBeenCalledTimes(1);
-        expect(effectFn).toHaveBeenLastCalledWith(0);
+        expect(effectFn).toHaveBeenLastCalledWith(undefined);
 
         vi.advanceTimersToNextTimer();
         expect(effectFn).toHaveBeenCalledTimes(2);

package/test/streamAsync.test.ts

@@ -0,0 +1,194 @@
+import { describe, expect, test, vi } from "vitest";
+import { effect, streamAsync } from "#package";
+
+describe("streamAsync", () => {
+    test("is updated (callback)", async () => {
+        const counter = {
+            count: 0,
+            callback: undefined as ((value: number) => void) | undefined,
+            increment() {
+                this.count++;
+                if (this.callback) {
+                    this.callback(this.count);
+                }
+            },
+        };
+
+        const $stream = streamAsync((set) => {
+            counter.callback = set;
+            return () => {
+                counter.callback = undefined;
+            };
+        });
+
+        const promise = $stream.get();
+
+        counter.increment();
+        expect(await promise).toBe(1);
+        expect(await $stream.get()).toBe(1);
+
+        counter.increment();
+        expect(await $stream.get()).toBe(2);
+    });
+
+    test("stream is updated (interval)", async () => {
+        vi.useFakeTimers();
+
+        const $stream = streamAsync<number>((set) => {
+            let counter = 0;
+            const interval = setInterval(() => {
+                counter++;
+                set(counter);
+            }, 1000);
+            return () => clearInterval(interval);
+        });
+
+        const promise = $stream.get();
+
+        vi.advanceTimersToNextTimer();
+        expect(await promise).toBe(1);
+        expect(await $stream.get()).toBe(1);
+
+        vi.advanceTimersToNextTimer();
+        expect(await $stream.get()).toBe(2);
+    });
+
+    test("get throws when stream is disposed", async () => {
+        vi.useFakeTimers();
+
+        const $stream = streamAsync((set) => {
+            let counter = 0;
+            const interval = setInterval(() => {
+                counter++;
+                set(counter);
+            }, 1000);
+            return () => clearInterval(interval);
+        });
+
+        vi.advanceTimersToNextTimer();
+        expect(await $stream.get()).toBe(1);
+
+        vi.advanceTimersToNextTimer();
+        expect(await $stream.get()).toBe(2);
+
+        $stream.dispose();
+        vi.advanceTimersToNextTimer();
+        expect(() => $stream.get()).toThrow("[PicoFlow] Primitive is disposed");
+    });
+});
+
+describe("effect", () => {
+    test("called when stream is updated", async () => {
+        vi.useFakeTimers();
+
+        const $stream = streamAsync((set) => {
+            let counter = 0;
+            const interval = setInterval(() => {
+                counter++;
+                set(counter);
+            }, 1000);
+            return () => clearInterval(interval);
+        });
+
+        const effectFn = vi.fn();
+        effect((get) => effectFn(get($stream)));
+
+        expect(effectFn).toHaveBeenCalledTimes(1);
+        expect(effectFn).toHaveBeenLastCalledWith(new Promise(() => {}));
+
+        vi.advanceTimersToNextTimer();
+        expect(effectFn).toHaveBeenCalledTimes(2);
+        expect(await effectFn.mock.calls[1][0]).toEqual(1);
+
+        vi.advanceTimersToNextTimer();
+        expect(effectFn).toHaveBeenCalledTimes(3);
+        expect(await effectFn.mock.calls[2][0]).toEqual(2);
+
+        vi.advanceTimersToNextTimer();
+        expect(effectFn).toHaveBeenCalledTimes(4);
+        expect(await effectFn.mock.calls[3][0]).toEqual(3);
+    });
+
+    test("NOT called when stream is updated with same value", async () => {
+        vi.useFakeTimers();
+
+        const $stream = streamAsync((set) => {
+            const interval = setInterval(() => {
+                set(5);
+            }, 1000);
+            return () => clearInterval(interval);
+        });
+
+        const effectFn = vi.fn();
+        effect((get) => effectFn(get($stream)));
+
+        expect(effectFn).toHaveBeenCalledTimes(1);
+        expect(effectFn).toHaveBeenLastCalledWith(new Promise(() => {}));
+
+        vi.advanceTimersToNextTimer();
+        expect(effectFn).toHaveBeenCalledTimes(2);
+        expect(await effectFn.mock.calls[1][0]).toEqual(5);
+
+        vi.advanceTimersToNextTimer();
+        expect(effectFn).toHaveBeenCalledTimes(2);
+        expect(await effectFn.mock.calls[1][0]).toEqual(5);
+    });
+
+    test("NOT called when  disposed", async () => {
+        vi.useFakeTimers();
+
+        const $stream = streamAsync((set) => {
+            let counter = 0;
+            const interval = setInterval(() => {
+                counter++;
+                set(counter);
+            }, 1000);
+            return () => clearInterval(interval);
+        });
+
+        const effectFn = vi.fn();
+        const $effect = effect((get) => effectFn(get($stream)));
+
+        vi.advanceTimersToNextTimer();
+        expect(effectFn).toHaveBeenCalledTimes(2);
+        expect(await effectFn.mock.calls[1][0]).toEqual(1);
+
+        vi.advanceTimersToNextTimer();
+        expect(effectFn).toHaveBeenCalledTimes(3);
+        expect(await effectFn.mock.calls[2][0]).toEqual(2);
+
+        $effect.dispose();
+        vi.advanceTimersToNextTimer();
+        expect(effectFn).toHaveBeenCalledTimes(3);
+        expect(await effectFn.mock.calls[2][0]).toEqual(2);
+    });
+
+    test("NOT called when stream is disposed", async () => {
+        vi.useFakeTimers();
+
+        const $stream = streamAsync((set) => {
+            let counter = 0;
+            const interval = setInterval(() => {
+                counter++;
+                set(counter);
+            }, 1000);
+            return () => clearInterval(interval);
+        });
+
+        const effectFn = vi.fn();
+        effect((get) => effectFn(get($stream)));
+
+        vi.advanceTimersToNextTimer();
+        expect(effectFn).toHaveBeenCalledTimes(2);
+        expect(await effectFn.mock.calls[1][0]).toEqual(1);
+
+        vi.advanceTimersToNextTimer();
+        expect(effectFn).toHaveBeenCalledTimes(3);
+        expect(await effectFn.mock.calls[2][0]).toEqual(2);
+
+        $stream.dispose();
+        vi.advanceTimersToNextTimer();
+        expect(effectFn).toHaveBeenCalledTimes(3);
+        expect(await effectFn.mock.calls[2][0]).toEqual(2);
+    });
+});

package/tsconfig.json

@@ -16,7 +16,9 @@
         "noUnusedParameters": true,
         "noFallthroughCasesInSwitch": true,
         "noImplicitOverride": true,
-        "noImplicitReturns": true
+        "noImplicitReturns": true,
+
+        "stripInternal": true
     },
     "include": ["./src/**/*", "./test/**/*"]
 }

package/api/doc/picoflow.flowdisposer.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [FlowDisposer](./picoflow.flowdisposer.md)
-
-## FlowDisposer type
-
-A function that disposes of a resource.
-
-**Signature:**
-
-```typescript
-export type FlowDisposer = () => void;
-```

package/api/doc/picoflow.flowsetter.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [FlowSetter](./picoflow.flowsetter.md)
-
-## FlowSetter type
-
-A function that sets a new value.
-
-**Signature:**
-
-```typescript
-export type FlowSetter<T> = (value: T) => void;
-```

package/api/doc/picoflow.flowstate._constructor_.md

@@ -1,49 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [picoflow](./picoflow.md) &gt; [FlowState](./picoflow.flowstate.md) &gt; [(constructor)](./picoflow.flowstate._constructor_.md)
-
-## FlowState.(constructor)
-
-Creates a new FlowState with the given initial value.
-
-**Signature:**
-
-```typescript
-constructor(value: 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>