lume-js 2.2.1 → 2.3.0

package/src/core/effect.js

@@ -29,6 +29,8 @@ import { logError } from '../utils/log.js';
  * Features:
  * - Automatic dependency collection via withReadObserver scope (default)
  * - Explicit dependencies for side-effects
+ * - Explicit-deps notifications are coalesced: one run per microtask,
+ *   no matter how many tracked keys (or stores) changed in the same tick
  * - Returns cleanup function
  * - Compatible with per-state batching
  */
@@ -87,6 +89,27 @@ export function effect(fn, deps) {
 
   // EXPLICIT DEPS MODE: deps array provided
   if (Array.isArray(deps)) {
+    // Coalesce notifications: when several tracked keys change in the same
+    // flush (or several stores flush in the same tick), run the effect once
+    // per microtask instead of once per changed key. This matches the
+    // dedupe guarantee auto-tracking mode gets from the per-state effect queue.
+    let scheduled = false;
+    let disposed = false;
+    cleanups.push(() => { disposed = true; });
+
+    const scheduleExecute = () => {
+      if (scheduled) return;
+      scheduled = true;
+      queueMicrotask(() => {
+        scheduled = false;
+        if (disposed) return;
+        // execute() logs and re-throws; swallow here so a throwing effect
+        // doesn't become an uncaught error inside the microtask (same
+        // containment the state flush loop provides for subscribers).
+        try { execute(); } catch { /* already logged by execute() */ }
+      });
+    };
+
     // Subscribe to each [store, key1, key2, ...] tuple explicitly
     for (const dep of deps) {
       if (Array.isArray(dep) && dep.length >= 2) {
@@ -102,7 +125,7 @@ export function effect(fn, deps) {
                 isFirst = false;
                 return; // Skip first call, we'll run execute() below
               }
-              execute();
+              scheduleExecute();
             });
             cleanups.push(unsub);
           }
@@ -123,12 +146,13 @@ export function effect(fn, deps) {
       // them so the effect stays reactive.
       const oldCleanups = cleanups.splice(0);
 
-      // Create effect context for tracking
+      // Tracking is keyed per store proxy (WeakMap<proxy, Set<key>>) so the
+      // same key name on two different stores creates two subscriptions.
       const myContext = {
         fn,
         cleanups,
         execute: executeWithTracking,
-        tracking: {}
+        tracking: new WeakMap()
       };
 
       // Set as current effect (for state.js to detect)
@@ -141,8 +165,13 @@ export function effect(fn, deps) {
         const onRead = (proxy, key, registerEffect) => {
           // Only the currently active effect (not a nested one) creates subscriptions
           if (currentEffect !== myContext) return;
-          if (myContext.tracking[key]) return;
-          myContext.tracking[key] = true;
+          let keys = myContext.tracking.get(proxy);
+          if (!keys) {
+            keys = new Set();
+            myContext.tracking.set(proxy, keys);
+          }
+          if (keys.has(key)) return;
+          keys.add(key);
           myContext.cleanups.push(registerEffect(key, myContext.execute));
         };
         withReadObserver(onRead, fn);

package/src/core/state.js

@@ -12,6 +12,7 @@
  * - $subscribe for listening to key changes
  * - Cleanup with unsubscribe
  * - Per-state microtask batching for writes
+ * - batch() for grouping writes across states with cross-store effect dedupe
  * - Scope-based read tracking via withReadObserver (multi-observer safe)
  *
  * Usage:
@@ -23,6 +24,7 @@
  */
 
 import { logError, logWarn } from '../utils/log.js';
+import { enqueueIfBatching, MAX_FLUSH_ITERATIONS } from './batch.js';
 
 // Per-state batching – each state object maintains its own microtask flush.
 // This keeps effects simple and aligned with Lume's minimal philosophy.
@@ -48,6 +50,22 @@ import { logError, logWarn } from '../utils/log.js';
 // own independent Set via ES module / CommonJS isolation.
 const readers = new Set();
 
+/**
+ * Brand symbol stamped on every object passed to state().
+ *
+ * Uses the global symbol registry (Symbol.for) so independent copies of
+ * lume-js on the same page (e.g. a CDN build next to a bundled chunk)
+ * agree on the same brand. This is a type tag for reliable detection
+ * (see isReactive in addons), not a security boundary — any code can
+ * stamp it.
+ *
+ * Internal API — exported for addons; not re-exported from the package root.
+ */
+export const REACTIVE_BRAND = Symbol.for('lume.reactive');
+
+// batch() lives in ./batch.js (which never imports this module — no cycle).
+// state.js participates through enqueueIfBatching in scheduleFlush below.
+
 /**
  * Run a function with a read observer active.
  * The observer receives (proxy, key, registerEffect) for every property read.
@@ -89,6 +107,49 @@ export function state(obj) {
   const beforeFlushHooks = [];
   let flushScheduled = false;
 
+  // ── Flush steps ──────────────────────────────────────────────────────
+  // Named pieces shared by the per-state microtask flush and batch().
+
+  function runBeforeFlushHooks() {
+    for (let i = 0; i < beforeFlushHooks.length; i++) {
+      try {
+        beforeFlushHooks[i]();
+      } catch (err) {
+        logError('[Lume.js state] Error in beforeFlush hook:', err);
+      }
+    }
+  }
+
+  function notifySubscribers() {
+    for (const [key, value] of pendingNotifications) {
+      if (listeners[key]) {
+        const subs = listeners[key];
+        let i = 0;
+        while (i < subs.length) {
+          const fn = subs[i];
+          try {
+            fn(value);
+          } catch (err) {
+            logError(`[Lume.js state] Error notifying subscriber for key "${String(key)}":`, err);
+          }
+          // Only advance if fn wasn't removed (something shifted into its place)
+          if (subs[i] === fn) i++;
+        }
+      }
+    }
+    pendingNotifications.clear();
+  }
+
+  /** Drain queued effects (Set deduplicates) into an array. */
+  function takeEffects() {
+    const effects = Array.from(pendingEffects);
+    pendingEffects.clear();
+    return effects;
+  }
+
+  // Handle this state gives batch() — flush steps only, no live queues.
+  const batchHandle = { runBeforeFlushHooks, notifySubscribers, takeEffects };
+
   /**
    * Schedule a single microtask flush for this state object.
    *
@@ -100,57 +161,28 @@ export function state(obj) {
    *
    * Notes:
    * - Batching is per state; effects that depend on multiple states
-   *   may run once per state that changed (by design).
+   *   may run once per state that changed (by design). Use batch() to
+   *   group writes across states and run such effects once.
+   * - Inside batch(), the microtask is skipped: the state enqueues
+   *   itself for the synchronous flush at the end of the batch.
    */
   function scheduleFlush() {
+    // Inside batch(): the batch captures this state's flush handle and
+    // flushes synchronously at the end — skip the microtask.
+    if (enqueueIfBatching(batchHandle)) return;
+
     if (flushScheduled) return;
 
     flushScheduled = true;
-    // eslint-disable-next-line sonarjs/cognitive-complexity -- single-pass flush loop: hooks → subscribers → effects → cycle detection; must stay atomic
     queueMicrotask(() => {
       let iterations = 0;
-      const MAX_ITERATIONS = 100;
 
       try {
-        while ((pendingNotifications.size > 0 || pendingEffects.size > 0) && iterations < MAX_ITERATIONS) {
+        while ((pendingNotifications.size > 0 || pendingEffects.size > 0) && iterations < MAX_FLUSH_ITERATIONS) {
           iterations++;
-
-          // Run registered before-flush hooks (e.g. plugin onNotify)
-          for (let i = 0; i < beforeFlushHooks.length; i++) {
-            try {
-              beforeFlushHooks[i]();
-            } catch (err) {
-              logError('[Lume.js state] Error in beforeFlush hook:', err);
-            }
-          }
-
-          // Notify all subscribers of changed keys
-          for (const [key, value] of pendingNotifications) {
-            if (listeners[key]) {
-              const subs = listeners[key];
-              let i = 0;
-              while (i < subs.length) {
-                const fn = subs[i];
-                try {
-                  fn(value);
-                } catch (err) {
-                  logError(`[Lume.js state] Error notifying subscriber for key "${String(key)}":`, err);
-                }
-                // Only advance if fn wasn't removed (something shifted into its place)
-                if (subs[i] === fn) i++;
-              }
-            }
-          }
-
-          pendingNotifications.clear();
-
-          // Run each effect exactly once (Set deduplicates)
-          const effects = new Array(pendingEffects.size);
-          let idx = 0;
-          for (const effect of pendingEffects) {
-            effects[idx++] = effect;
-          }
-          pendingEffects.clear();
+          runBeforeFlushHooks();
+          notifySubscribers();
+          const effects = takeEffects();
           for (let i = 0; i < effects.length; i++) {
             try {
               effects[i]();
@@ -163,7 +195,7 @@ export function state(obj) {
         flushScheduled = false;
       }
 
-      if (iterations >= MAX_ITERATIONS) {
+      if (iterations >= MAX_FLUSH_ITERATIONS) {
         logError(
           '[Lume.js state] Maximum flush iterations reached (100). ' +
           'This usually indicates an infinite loop caused by an effect or computed mutating state it depends on.'
@@ -172,29 +204,47 @@ export function state(obj) {
     });
   }
 
-  // Brand symbol for type-level reactive identification
-  const REACTIVE_BRAND = Symbol('lume.reactive');
-  obj[REACTIVE_BRAND] = true;
+  // Stamp the shared brand (non-enumerable: spreads/Object.assign copies
+  // of a store do not inherit the brand and won't masquerade as reactive).
+  Object.defineProperty(obj, REACTIVE_BRAND, { value: true });
 
-  // Defined once per state instance — not per property read — to avoid per-read closure allocation.
-  const registerEffect = (key, executeFn) => {
-    if (!listeners[key]) listeners[key] = [];
-
-    const callback = () => {
-      pendingEffects.add(executeFn);
-    };
-
-    listeners[key].push(callback);
+  const MAX_SUBSCRIBERS = 1000;
+  const noopUnsubscribe = () => {};
 
+  /**
+   * Shared listener registration with a per-key cap (subscriber DoS
+   * protection). Applied identically to $subscribe callbacks and effect
+   * subscriptions so both paths degrade the same way: a loud console
+   * error and a no-op unsubscribe.
+   */
+  function addListener(key, fn, kind) {
+    if (!listeners[key]) listeners[key] = [];
+    if (listeners[key].length >= MAX_SUBSCRIBERS) {
+      logError(
+        `[Lume.js state] Subscriber limit (${MAX_SUBSCRIBERS}) reached for key "${String(key)}". ` +
+        `${kind} ignored — it will NOT receive updates. ` +
+        'This usually means subscriptions are created in a loop without cleanup.'
+      );
+      return noopUnsubscribe;
+    }
+    listeners[key].push(fn);
     return () => {
       if (listeners[key]) {
-        const idx = listeners[key].indexOf(callback);
+        const idx = listeners[key].indexOf(fn);
         if (idx !== -1) {
           listeners[key].splice(idx, 1);
           if (listeners[key].length === 0) delete listeners[key];
         }
       }
     };
+  }
+
+  // Defined once per state instance — not per property read — to avoid per-read closure allocation.
+  const registerEffect = (key, executeFn) => {
+    const callback = () => {
+      pendingEffects.add(executeFn);
+    };
+    return addListener(key, callback, 'Effect subscription');
   };
 
   const BLOCKED_KEYS = new Set(['__proto__', 'constructor', 'prototype']);
@@ -269,33 +319,20 @@ export function state(obj) {
     };
   };
 
-  const MAX_SUBSCRIBERS = 1000;
-
   obj.$subscribe = (key, fn) => {
     if (typeof fn !== 'function') {
       throw new Error('Subscriber must be a function');
     }
 
-    if (!listeners[key]) listeners[key] = [];
-    if (listeners[key].length >= MAX_SUBSCRIBERS) {
-      logWarn(`[Lume.js state] Subscriber limit (${MAX_SUBSCRIBERS}) reached for key "${key}". New subscriber ignored.`);
-      return () => {};
-    }
-    listeners[key].push(fn);
+    const unsubscribe = addListener(key, fn, 'New subscriber');
+
+    // Over the cap: listener was not added, skip the immediate call too
+    if (unsubscribe === noopUnsubscribe) return unsubscribe;
 
     // Call immediately with current value (NOT batched)
     fn(proxy[key]);
 
-    // Return unsubscribe function
-    return () => {
-      if (listeners[key]) {
-        const idx = listeners[key].indexOf(fn);
-        if (idx !== -1) {
-          listeners[key].splice(idx, 1);
-          if (listeners[key].length === 0) delete listeners[key];
-        }
-      }
-    };
+    return unsubscribe;
   };
 
   return proxy;

package/src/handlers/index.d.ts

@@ -85,6 +85,30 @@ export function classToggle(...names: string[]): Handler[];
  */
 export function stringAttr(name: string): Handler;
 
+/**
+ * Create handlers for declarative event wiring.
+ * Each type creates a handler: data-on{type}="key" wires the function held
+ * at that store key as a DOM event listener.
+ *
+ * Reactive like any binding: assigning a new function to the key re-wires
+ * the listener; assigning null/undefined detaches it. Non-function truthy
+ * values detach with a console warning.
+ *
+ * Returns an array — pass directly to handlers (auto-flattened by bindDom).
+ *
+ * @param types - DOM event types ('click', 'input', 'submit', ...)
+ *
+ * @example
+ * ```typescript
+ * const store = state({
+ *   addTodo: (event: Event) => { ... }
+ * });
+ * bindDom(root, store, { handlers: [on('click')] });
+ * // <button data-onclick="addTodo">Add</button>
+ * ```
+ */
+export function on(...types: string[]): Handler[];
+
 /** Form-related handlers preset (readonly) */
 export const formHandlers: Handler[];
 

package/src/handlers/index.js

@@ -25,5 +25,6 @@ export { boolAttr }                from './boolAttr.js';
 export { ariaAttr }                from './ariaAttr.js';
 export { classToggle }             from './classToggle.js';
 export { stringAttr }              from './stringAttr.js';
+export { on }                      from './on.js';
 export { htmlAttrs }               from './htmlAttrs.js';
 export { formHandlers, a11yHandlers } from './presets.js';

package/src/handlers/on.js

@@ -0,0 +1,60 @@
+/**
+ * Create handlers for declarative event wiring.
+ * Each type creates a handler: data-on{type}="key" wires the function held
+ * at that store key as a DOM event listener.
+ *
+ *   <button data-onclick="addTodo">Add</button>
+ *
+ *   const store = state({
+ *     addTodo: (event) => { ... }   // a plain function in state
+ *   });
+ *   bindDom(root, store, { handlers: [on('click')] });
+ *
+ * Reactive like any binding: assigning a new function to the key re-wires
+ * the listener; assigning null/undefined detaches it.
+ *
+ * Returns an array — pass directly to handlers (auto-flattened by bindDom).
+ *
+ * @security Same trust model as data-bind: an injected data-on* attribute
+ * can only reference functions that already exist in reachable state — no
+ * expressions, no eval. Ensure your HTML is trusted or sanitized.
+ *
+ * Note: bindDom's cleanup stops future re-wiring but does not detach
+ * listeners already attached to elements that remain in the DOM. Discard
+ * the bound subtree (the normal SPA teardown) to drop them.
+ *
+ * @param {...string} types - DOM event types ('click', 'input', 'submit', ...)
+ * @returns {Array<{ attr: string, apply: function }>}
+ */
+
+import { logWarn } from '../utils/log.js';
+
+// element → Map<eventType, listener> — tracks what we attached so a
+// re-assigned store key swaps the listener instead of stacking a second one.
+const attached = new WeakMap();
+
+export function on(...types) {
+  return types.map(type => ({
+    attr: `data-on${type}`,
+    apply(el, val) {
+      let byType = attached.get(el);
+      const prev = byType ? byType.get(type) : undefined;
+
+      if (prev) {
+        el.removeEventListener(type, prev);
+        byType.delete(type);
+      }
+
+      if (typeof val === 'function') {
+        el.addEventListener(type, val);
+        if (!byType) {
+          byType = new Map();
+          attached.set(el, byType);
+        }
+        byType.set(type, val);
+      } else if (val != null) {
+        logWarn(`[Lume.js] on('${type}'): bound value is not a function — listener detached`);
+      }
+    }
+  }));
+}

package/src/index.d.ts

@@ -353,6 +353,46 @@ export function effect(fn: () => void): Unsubscribe;
  */
 export function effect(fn: () => void, deps: EffectDependency[]): Unsubscribe;
 
+/**
+ * Group multiple state writes and flush them together, synchronously,
+ * when the outermost batch() returns.
+ *
+ * Guarantees:
+ * - Subscribers see only the final value of each key written in the batch.
+ * - An effect depending on several stores mutated in the batch runs exactly
+ *   ONCE (normal microtask batching is per-state: such effects run once per
+ *   mutated store).
+ * - Nested batch() calls are absorbed into the outermost batch.
+ * - If fn throws, writes made before the throw still flush, then the error
+ *   propagates.
+ *
+ * fn must be synchronous. Writes after an `await` fall back to normal
+ * per-state microtask flushing (a console warning is logged if fn returns
+ * a Promise).
+ *
+ * @param fn - Function performing state writes
+ * @returns The return value of fn
+ * @throws {Error} If fn is not a function
+ *
+ * @example
+ * ```typescript
+ * import { state, effect, batch } from 'lume-js';
+ *
+ * const a = state({ value: 1 });
+ * const b = state({ value: 2 });
+ *
+ * effect(() => {
+ *   render(a.value + b.value);
+ * });
+ *
+ * batch(() => {
+ *   a.value = 10;
+ *   b.value = 20;
+ * }); // render() ran exactly once, seeing 30
+ * ```
+ */
+export function batch<T>(fn: () => T): T;
+
 /**
  * Run a function with a read observer active.
  *

package/src/index.js

@@ -5,12 +5,14 @@
  * - state(): create reactive state
  * - bindDom(): zero-runtime DOM binding
  * - effect(): reactive effect with automatic dependency tracking
+ * - batch(): group writes across states, flush once synchronously
  * - withReadObserver(): advanced API for custom reactive primitives
  *
  * Usage:
- *   import { state, bindDom, effect } from "lume-js";
+ *   import { state, bindDom, effect, batch } from "lume-js";
  */
 
 export { state, withReadObserver } from "./core/state.js";
+export { batch } from "./core/batch.js";
 export { bindDom } from "./core/bindDom.js";
 export { effect } from "./core/effect.js";

package/src/state.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Lume.js Universal State Entry — TypeScript Definitions
+ *
+ * The DOM-free kernel: state() + batch() + withReadObserver().
+ * Import from "lume-js/state" in Node, Deno, workers, and CLI tools.
+ * Types are shared with the full core entry.
+ */
+
+export type {
+  Unsubscribe,
+  Subscriber,
+  Plugin,
+  TypedPlugin,
+  ReactiveState,
+} from './index.js';
+
+export { state, batch, withReadObserver } from './index.js';

package/src/state.js

@@ -0,0 +1,25 @@
+/**
+ * Lume-JS Universal State Entry
+ *
+ * The DOM-free kernel: reactive state + cross-store batching. Runs anywhere
+ * JavaScript runs — Node, Deno, Bun, workers, CLI tools, browsers.
+ *
+ * Use this entry when you don't need DOM binding:
+ *
+ *   import { state, batch } from "lume-js/state";
+ *
+ *   const store = state({ count: 0 });
+ *   store.$subscribe("count", v => console.log("count:", v));
+ *
+ *   batch(() => {
+ *     store.count = 1;
+ *     store.count = 2;
+ *   }); // subscribers see only 2, synchronously
+ *
+ * For DOM binding and effects, use the full core instead:
+ *
+ *   import { state, bindDom, effect, batch } from "lume-js";
+ */
+
+export { state, withReadObserver } from "./core/state.js";
+export { batch } from "./core/batch.js";