@ersbeth/picoflow 2.0.3 → 2.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025-2026 Elisabeth Rousset
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -4,6 +4,10 @@
 
 > **Upgrading from v1.x?** See the [Upgrade Guide](https://ersbeth-web.gitlab.io/picoflow/guide/advanced/migration-v2.html) for migration instructions.
 
+## Requirements
+
+The schedulers use `Promise.withResolvers()`, so picoflow needs **Node ≥ 22**, or Chrome ≥ 119, Safari ≥ 17.4, Firefox ≥ 121 in the browser. There is no fallback: on an older runtime the failure is immediate, on the first primitive you create.
+
 ## Installation
 
 ```bash
@@ -21,6 +25,17 @@ yarn add @ersbeth/picoflow
 
 For comprehensive guides and API documentation, visit the [official website](https://ersbeth-web.gitlab.io/picoflow/)
 
+## Development
+
+```bash
+pnpm install
+pnpm playwright:install   # once — downloads Chromium for the browser tests
+pnpm test                 # watch Node tests
+pnpm test:browser         # watch browser tests
+```
+
+See [`CONTRIBUTING.md`](CONTRIBUTING.md) for the full setup, the conventions and the release procedure. Known issues and their status are tracked in [`audits/FINDINGS.md`](audits/FINDINGS.md); planned breaking changes in [`ROADMAP.md`](ROADMAP.md); vulnerability reporting in [`SECURITY.md`](SECURITY.md).
+
 ## AI Coding Agents
 
 Picoflow ships a [`SKILL.md`](SKILL.md) with the npm package, matching the exact version you have

package/SKILL.md

@@ -59,7 +59,12 @@ callback) rather than needing manual `await`/try-catch inside a derivation.
 - **Creating a subscription inside another subscription's callback** — it re-creates one on every run
   and leaks. Combine into a single `subscribe()` whose data function reads all the needed primitives.
 - **A `subscribe()`/`.subscribe()` callback that calls `.set()` on a primitive it also reads** — infinite
-  loop.
+  loop. PicoFlow's own cycle guard stops it after 10 000 steps and reports it through `onFlushError()`
+  (see below) rather than crashing the process, but the loop is still a bug to fix, not something to rely
+  on the guard for.
+- **`subscribe(fn)` with no `onError`, and no global `onFlushError()` handler installed** — any exception
+  thrown inside `fn` is only logged via `console.error` by default; install `onFlushError((error) => ...)`
+  once at startup if the application needs to observe or report these instead of the default logging.
 - **Using `add()`/`update()` on `array`/`map` without checking preconditions** — `array.update(index, x)`
   throws if the index is out of bounds; `map.add(key, x)` throws if the key exists; `map.update(key, x)`
   throws if it doesn't. Check first (`.pick()`) or branch on it, don't assume.