signalium 2.1.7 → 2.2.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # signalium
 
+## 2.2.0
+
+### Minor Changes
+
+- 0b6b650: Add setSuspended API for more explicit suspension support
+
 ## 2.1.7
 
 ### Patch Changes

package/dist/cjs/development/{core-api-C3NaxanI.js → core-api-BO_W1aEw.js}

@@ -1,5 +1,5 @@
 "use strict";
-const debug = require("./debug-CjBhOupU.js");
+const debug = require("./debug-DW86yXJK.js");
 const DERIVED_DEFINITION_MAP = /* @__PURE__ */ new Map();
 function getReactiveFnAndDefinition(fn, opts) {
   let fnAndDef = DERIVED_DEFINITION_MAP.get(fn);
@@ -52,4 +52,4 @@ exports.reactiveSignal = reactiveSignal;
 exports.relay = relay;
 exports.task = task;
 exports.watcher = watcher;
-//# sourceMappingURL=core-api-C3NaxanI.js.map
+//# sourceMappingURL=core-api-BO_W1aEw.js.map

package/dist/cjs/development/core-api-BO_W1aEw.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"core-api-BO_W1aEw.js","sources":["../../../src/internals/core-api.ts"],"sourcesContent":["import {\n  ReactiveTask,\n  ReactiveValue,\n  Watcher,\n  ReactiveOptions,\n  RelayActivate,\n  type DiscriminatedReactivePromise,\n  SignalOptions,\n  ReactiveFn,\n  ReadonlySignal,\n} from '../types.js';\nimport { getCurrentScope, getScopeOwner, SignalScope } from './contexts.js';\nimport {\n  createReactiveDefinition,\n  createReactiveSignal,\n  ReactiveDefinition as ReactiveDefinition,\n} from './reactive.js';\nimport { createRelay, createTask } from './async.js';\nimport { Tracer } from './trace.js';\n\n// eslint-disable-next-line @typescript-eslint/no-unsafe-function-type\nexport const DERIVED_DEFINITION_MAP = new Map<Function, [(...args: any) => any, ReactiveDefinition<any, any>]>();\n\nexport function getReactiveFnAndDefinition<T, Args extends unknown[]>(\n  fn: (...args: Args) => T,\n  opts?: ReactiveOptions<T, Args>,\n): [(...args: Args) => ReactiveValue<T>, ReactiveDefinition<T, Args>] {\n  let fnAndDef = DERIVED_DEFINITION_MAP.get(fn);\n\n  if (!fnAndDef) {\n    const def = createReactiveDefinition(opts?.id, opts?.desc, fn, opts?.equals, false, opts?.paramKey, undefined);\n\n    const defScope = getCurrentScope();\n\n    const reactiveFn: ReactiveFn<T, Args> = (...args) => {\n      const scope = getCurrentScope(defScope);\n      const signal = scope.get(def, args as any);\n\n      return signal.value;\n    };\n\n    fnAndDef = [reactiveFn, def];\n\n    DERIVED_DEFINITION_MAP.set(fn, fnAndDef);\n  }\n\n  return fnAndDef;\n}\n\nexport function reactive<T, Args extends unknown[]>(\n  fn: (...args: Args) => T,\n  opts?: ReactiveOptions<T, Args>,\n): ReactiveFn<T, Args> {\n  return getReactiveFnAndDefinition(fn, opts)[0];\n}\n\nexport const reactiveMethod = <T, Args extends unknown[]>(\n  owner: object,\n  fn: (...args: Args) => T,\n  opts?: ReactiveOptions<T, Args>,\n): ReactiveFn<T, Args> => {\n  const def = createReactiveDefinition(opts?.id, opts?.desc, fn, opts?.equals, false, opts?.paramKey, undefined);\n\n  const reactiveFn: ReactiveFn<T, Args> = (...args) => {\n    return getScopeOwner(owner).get(def, args as any).value;\n  };\n\n  DERIVED_DEFINITION_MAP.set(reactiveFn, [reactiveFn, def]);\n\n  return reactiveFn;\n};\n\nexport function relay<T>(activate: RelayActivate<T>, opts?: SignalOptions<T>): DiscriminatedReactivePromise<T> {\n  const scope = getCurrentScope();\n\n  return createRelay(activate, scope, opts) as DiscriminatedReactivePromise<T>;\n}\n\nexport const task = <T, Args extends unknown[]>(\n  fn: (...args: Args) => Promise<T>,\n  opts?: SignalOptions<T>,\n): ReactiveTask<T, Args> => {\n  const scope = getCurrentScope();\n\n  return createTask(fn, scope, opts);\n};\n\nexport function watcher<T>(fn: () => T, opts?: SignalOptions<T> & { isolate?: boolean; tracer?: Tracer }): Watcher<T> {\n  const def = createReactiveDefinition(opts?.id, opts?.desc, fn, opts?.equals, false, undefined, opts?.tracer);\n\n  const scope = opts?.isolate ? new SignalScope([]) : getCurrentScope();\n\n  return createReactiveSignal(def, undefined, undefined, scope);\n}\n\n/**\n * Creates a reactive signal from a compute function. This is useful for when you\n * want to create a signal that does not receive parameters, but is still reactive.\n *\n * @param compute\n * @param opts\n * @returns\n */\nexport const reactiveSignal = <T>(\n  compute: () => T,\n  opts?: SignalOptions<T> & { isolate?: boolean },\n): ReadonlySignal<T> => {\n  const def = createReactiveDefinition(opts?.id, opts?.desc, compute, opts?.equals, false, undefined, undefined);\n\n  const scope = opts?.isolate ? new SignalScope([]) : getCurrentScope();\n\n  return createReactiveSignal(def, undefined, undefined, scope);\n};\n"],"names":["createReactiveDefinition","getCurrentScope","getScopeOwner","createRelay","createTask","SignalScope","createReactiveSignal"],"mappings":";;AAqBO,MAAM,6CAA6B,IAAA;AAEnC,SAAS,2BACd,IACA,MACoE;AACpE,MAAI,WAAW,uBAAuB,IAAI,EAAE;AAE5C,MAAI,CAAC,UAAU;AACb,UAAM,MAAMA,MAAAA,yBAAyB,MAAM,IAAI,MAAM,MAAM,IAAI,MAAM,QAAQ,OAAO,MAAM,UAAU,MAAS;AAE7G,UAAM,WAAWC,MAAAA,gBAAA;AAEjB,UAAM,aAAkC,IAAI,SAAS;AACnD,YAAM,QAAQA,MAAAA,gBAAgB,QAAQ;AACtC,YAAM,SAAS,MAAM,IAAI,KAAK,IAAW;AAEzC,aAAO,OAAO;AAAA,IAChB;AAEA,eAAW,CAAC,YAAY,GAAG;AAE3B,2BAAuB,IAAI,IAAI,QAAQ;AAAA,EACzC;AAEA,SAAO;AACT;AAEO,SAAS,SACd,IACA,MACqB;AACrB,SAAO,2BAA2B,IAAI,IAAI,EAAE,CAAC;AAC/C;AAEO,MAAM,iBAAiB,CAC5B,OACA,IACA,SACwB;AACxB,QAAM,MAAMD,MAAAA,yBAAyB,MAAM,IAAI,MAAM,MAAM,IAAI,MAAM,QAAQ,OAAO,MAAM,UAAU,MAAS;AAE7G,QAAM,aAAkC,IAAI,SAAS;AACnD,WAAOE,MAAAA,cAAc,KAAK,EAAE,IAAI,KAAK,IAAW,EAAE;AAAA,EACpD;AAEA,yBAAuB,IAAI,YAAY,CAAC,YAAY,GAAG,CAAC;AAExD,SAAO;AACT;AAEO,SAAS,MAAS,UAA4B,MAA0D;AAC7G,QAAM,QAAQD,MAAAA,gBAAA;AAEd,SAAOE,kBAAY,UAAU,OAAO,IAAI;AAC1C;AAEO,MAAM,OAAO,CAClB,IACA,SAC0B;AAC1B,QAAM,QAAQF,MAAAA,gBAAA;AAEd,SAAOG,iBAAW,IAAI,OAAO,IAAI;AACnC;AAEO,SAAS,QAAW,IAAa,MAA8E;AACpH,QAAM,MAAMJ,MAAAA,yBAAyB,MAAM,IAAI,MAAM,MAAM,IAAI,MAAM,QAAQ,OAAO,QAAW,MAAM,MAAM;AAE3G,QAAM,QAAQ,MAAM,UAAU,IAAIK,MAAAA,YAAY,CAAA,CAAE,IAAIJ,sBAAA;AAEpD,SAAOK,MAAAA,qBAAqB,KAAK,QAAW,QAAW,KAAK;AAC9D;AAUO,MAAM,iBAAiB,CAC5B,SACA,SACsB;AACtB,QAAM,MAAMN,MAAAA,yBAAyB,MAAM,IAAI,MAAM,MAAM,SAAS,MAAM,QAAQ,OAAO,QAAW,MAAS;AAE7G,QAAM,QAAQ,MAAM,UAAU,IAAIK,MAAAA,YAAY,CAAA,CAAE,IAAIJ,sBAAA;AAEpD,SAAOK,MAAAA,qBAAqB,KAAK,QAAW,QAAW,KAAK;AAC9D;;;;;;;;"}

package/dist/cjs/development/{debug-CjBhOupU.js → debug-DW86yXJK.js}

@@ -414,40 +414,121 @@ function signal(initialValue, opts) {
 const notifier = (opts) => {
   return new StateSignal(void 0, FALSE_EQUALS$1, opts?.desc);
 };
-function watchSignal(signal2) {
+function watchSignal(signal2, parentIsSuspended) {
+  if (parentIsSuspended) {
+    watchSuspendedSignal(signal2);
+  } else {
+    watchActiveSignal(signal2);
+  }
+}
+function unwatchSignal(signal2, parentIsSuspended) {
+  if (parentIsSuspended) {
+    unwatchSuspendedSignal(signal2);
+  } else {
+    unwatchActiveSignal(signal2);
+  }
+}
+function watchActiveSignal(signal2) {
   const { watchCount } = signal2;
   const newWatchCount = watchCount + 1;
   signal2.watchCount = newWatchCount;
-  if (watchCount > 0) return;
-  signal2.scope?.removeFromGc(signal2);
-  for (const dep of signal2.deps.keys()) {
-    watchSignal(dep);
+  if (signal2._isActive) {
+    return;
   }
-  if (isRelay(signal2)) {
-    checkSignal(signal2);
+  for (const dep of signal2.deps.keys()) {
+    watchActiveSignal(dep);
   }
+  activateSignal(signal2);
 }
-function unwatchSignal(signal2, count = 1) {
+function unwatchActiveSignal(signal2) {
   const { watchCount } = signal2;
-  const newWatchCount = Math.max(watchCount - count, 0);
+  const newWatchCount = Math.max(watchCount - 1, 0);
   signal2.watchCount = newWatchCount;
-  if (newWatchCount > 0) {
-    return;
+  if (newWatchCount === 0) {
+    scheduleDeactivate(signal2);
   }
+}
+function watchSuspendedSignal(signal2) {
+  const { watchCount, suspendCount } = signal2;
+  const newWatchCount = watchCount + 1;
+  const newSuspendCount = suspendCount + 1;
+  signal2.watchCount = newWatchCount;
+  signal2.suspendCount = newSuspendCount;
+  signal2.scope?.removeFromGc(signal2);
+  cancelDeactivate(signal2);
+  if (watchCount === 0) {
+    for (const dep of signal2.deps.keys()) {
+      watchSuspendedSignal(dep);
+    }
+  }
+}
+function unwatchSuspendedSignal(signal2) {
+  const { watchCount, suspendCount } = signal2;
+  const newWatchCount = Math.max(watchCount - 1, 0);
+  const newSuspendCount = Math.max(suspendCount - 1, 0);
+  signal2.watchCount = newWatchCount;
+  signal2.suspendCount = newSuspendCount;
+  if (newWatchCount === 0) {
+    scheduleDeactivate(signal2);
+  }
+}
+function resumeSignal(signal2) {
+  const { watchCount, suspendCount } = signal2;
+  const newSuspendCount = Math.max(suspendCount - 1, 0);
+  signal2.suspendCount = newSuspendCount;
+  if (watchCount > 0 && !signal2._isActive) {
+    for (const dep of signal2.deps.keys()) {
+      resumeSignal(dep);
+    }
+    activateSignal(signal2);
+  }
+}
+function suspendSignal(signal2) {
+  const { watchCount, suspendCount } = signal2;
+  const newSuspendCount = suspendCount + 1;
+  signal2.suspendCount = newSuspendCount;
+  if (watchCount > 0 && newSuspendCount === watchCount) {
+    scheduleDeactivate(signal2);
+  }
+}
+function activateSignal(signal2) {
+  signal2.scope?.removeFromGc(signal2);
+  cancelDeactivate(signal2);
+  signal2._isActive = true;
+  if (isRelay(signal2)) {
+    checkSignal(signal2);
+  }
+}
+function deactivateSignal(signal2) {
+  const { watchCount, suspendCount } = signal2;
+  signal2._isActive = false;
+  const isSuspending = watchCount > 0 && suspendCount === watchCount;
   for (const dep of signal2.deps.keys()) {
-    unwatchSignal(dep);
+    const { watchCount: depWatchCount, suspendCount: depSuspendCount } = dep;
+    if (isSuspending) {
+      const newSuspendCount = dep.suspendCount = depSuspendCount + 1;
+      if (newSuspendCount === depWatchCount) {
+        deactivateSignal(dep);
+      }
+    } else {
+      const newWatchCount = dep.watchCount = depWatchCount - 1;
+      if (newWatchCount === 0) {
+        deactivateSignal(dep);
+      }
+    }
   }
   if (isRelay(signal2)) {
     signal2._value?.();
   }
-  if (newWatchCount === 0 && signal2.scope) {
-    signal2.scope.markForGc(signal2);
+  if (watchCount === 0) {
+    signal2.scope?.markForGc(signal2);
+    signal2.reset();
   }
 }
 const scheduleIdleCallback = typeof requestIdleCallback === "function" ? requestIdleCallback : (cb) => config.scheduleFlush(cb);
 let PENDING_PULLS = /* @__PURE__ */ new Set();
 let PENDING_ASYNC_PULLS = [];
-let PENDING_UNWATCH = /* @__PURE__ */ new Map();
+let PENDING_DEACTIVE = /* @__PURE__ */ new Set();
 let PENDING_LISTENERS = [];
 let PENDING_TRACERS = [];
 let PENDING_GC = /* @__PURE__ */ new Set();
@@ -471,11 +552,13 @@ const scheduleAsyncPull = (signal2) => {
   PENDING_ASYNC_PULLS.push(signal2);
   scheduleFlush();
 };
-const scheduleUnwatch = (unwatch) => {
-  const current = PENDING_UNWATCH.get(unwatch) ?? 0;
-  PENDING_UNWATCH.set(unwatch, current + 1);
+const scheduleDeactivate = (signal2) => {
+  PENDING_DEACTIVE.add(signal2);
   scheduleFlush();
 };
+const cancelDeactivate = (signal2) => {
+  PENDING_DEACTIVE.delete(signal2);
+};
 const scheduleListeners = (signal2) => {
   PENDING_LISTENERS.push(signal2);
   scheduleFlush();
@@ -513,9 +596,10 @@ const flushWatchers = async () => {
   }
   currentFlush = null;
   config.runBatch(() => {
-    for (const [signal2, count] of PENDING_UNWATCH) {
-      unwatchSignal(signal2, count);
+    for (const signal2 of PENDING_DEACTIVE) {
+      deactivateSignal(signal2);
     }
+    PENDING_DEACTIVE.clear();
     for (const signal2 of PENDING_LISTENERS) {
       if (signal2 instanceof ReactiveSignal) {
         runListeners(signal2);
@@ -529,11 +613,15 @@ const flushWatchers = async () => {
       }
       PENDING_TRACERS = [];
     }
-    PENDING_UNWATCH.clear();
     PENDING_LISTENERS = [];
   });
   flush.resolve();
 };
+const settled = async () => {
+  while (currentFlush) {
+    await currentFlush.promise;
+  }
+};
 function dirtySignal(signal2) {
   const prevState = signal2._state;
   if (prevState === ReactiveFnState.Dirty) {
@@ -555,7 +643,7 @@ function propagateDirty(signal2) {
       scheduleAsyncPull(signal2);
     }
   } else {
-    if (signal2._isListener) {
+    if (signal2._isListener && !signal2._isSuspendedListener) {
       schedulePull(signal2);
     }
     dirtySignalConsumers(signal2.subs);
@@ -861,15 +949,15 @@ class ReactivePromiseImpl {
     const arr = arrayFrom(values);
     const len = arr.length;
     if (len === 0) return p;
-    let settled = false;
+    let settled2 = false;
     const onFulfill = (v) => {
-      if (settled) return;
-      settled = true;
+      if (settled2) return;
+      settled2 = true;
       p._setValue(v);
     };
     const onReject = (r) => {
-      if (settled) return;
-      settled = true;
+      if (settled2) return;
+      settled2 = true;
       p._setError(r);
     };
     for (let i = 0; i < len; i++) {
@@ -1296,7 +1384,6 @@ function createRelay(activate, scope, opts) {
     const signal2 = p["_signal"];
     signal2.subs = /* @__PURE__ */ new Map();
     signal2._state = ReactiveFnState.Dirty;
-    signal2.watchCount = 0;
     active = false;
     currentSub = void 0;
   };
@@ -1376,7 +1463,7 @@ function getSignal(signal2) {
           });
         }
         if (currentConsumer.watchCount > 0) {
-          watchSignal(signal2);
+          watchSignal(signal2, currentConsumer._isSuspended);
         }
       }
       const updatedAt = checkSignal(signal2);
@@ -1501,10 +1588,10 @@ function runSignal(signal2) {
   }
 }
 function disconnectSignal(signal2, computedCount = signal2.computedCount) {
-  const { ref, deps } = signal2;
+  const { ref, deps, _isSuspended: isSuspended } = signal2;
   for (const [dep, edge] of deps) {
     if (edge.consumedAt !== computedCount) {
-      scheduleUnwatch(dep);
+      unwatchSignal(dep, isSuspended);
       dep.subs.delete(ref);
       deps.delete(dep);
     }
@@ -1844,6 +1931,7 @@ class ReactiveSignal {
   updatedCount = 0;
   computedCount = 0;
   watchCount = 0;
+  suspendCount = 0;
   key;
   args;
   callbacks = void 0;
@@ -1876,21 +1964,31 @@ class ReactiveSignal {
   get _isListener() {
     return (this.flags & 16) !== 0;
   }
-  set _isListener(isListener) {
-    if (isListener) {
-      this.flags |= 16;
+  get _isSuspendedListener() {
+    return (this.flags & 32) !== 0;
+  }
+  get _isSuspended() {
+    const { watchCount, suspendCount } = this;
+    return watchCount > 0 && watchCount === suspendCount;
+  }
+  get _isActive() {
+    return (this.flags & 64) !== 0;
+  }
+  set _isActive(isActive) {
+    if (isActive) {
+      this.flags |= 64;
     } else {
-      this.flags &= -17;
+      this.flags &= -65;
     }
   }
   get _isLazy() {
-    return (this.flags & 32) !== 0;
+    return (this.flags & 128) !== 0;
   }
   set _isLazy(isLazy) {
     if (isLazy) {
-      this.flags |= 32;
+      this.flags |= 128;
     } else {
-      this.flags &= -33;
+      this.flags &= -129;
     }
   }
   get listeners() {
@@ -1907,7 +2005,7 @@ class ReactiveSignal {
     const { current } = this.listeners;
     if (!current.has(listener)) {
       if (!this._isListener) {
-        watchSignal(this);
+        watchSignal(this, this._isSuspended);
         this.flags |= 16;
       }
       schedulePull(this);
@@ -1918,7 +2016,7 @@ class ReactiveSignal {
         current.delete(listener);
         if (current.size === 0) {
           cancelPull(this);
-          scheduleUnwatch(this);
+          unwatchSignal(this, this._isSuspended);
           this.flags &= -17;
         }
       }
@@ -1929,11 +2027,37 @@ class ReactiveSignal {
   // the listener as watched so that relays that are accessed will be activated.
   addListenerLazy() {
     if (!this._isListener) {
-      watchSignal(this);
+      watchSignal(this, this._isSuspended);
       this.flags |= 16;
     }
     return this.listeners.cachedBoundAdd;
   }
+  setSuspended(suspended) {
+    const { flags } = this;
+    const isListener = (flags & 16) !== 0;
+    const isSuspendedListener = (flags & 32) !== 0;
+    if (suspended && !isSuspendedListener) {
+      this.flags = flags | 32;
+      if (isListener) {
+        suspendSignal(this);
+      }
+    } else if (!suspended && isSuspendedListener) {
+      this.flags = flags & -33;
+      if (isListener) {
+        resumeSignal(this);
+      }
+    }
+  }
+  reset() {
+    this.flags = (this.def.isRelay ? 8 : 0) | 2;
+    this.dirtyHead = void 0;
+    this.updatedCount = 0;
+    this.computedCount = 0;
+    this.deps = /* @__PURE__ */ new Map();
+    this.subs = /* @__PURE__ */ new Map();
+    this.watchCount = 0;
+    this.suspendCount = 0;
+  }
 }
 const runListeners = (signal2) => {
   const { listeners } = signal2;
@@ -2131,8 +2255,9 @@ exports.setGlobalContexts = setGlobalContexts;
 exports.setReactivePromise = setReactivePromise;
 exports.setScopeOwner = setScopeOwner;
 exports.setTracing = setTracing;
+exports.settled = settled;
 exports.signal = signal;
 exports.unwatchSignal = unwatchSignal;
 exports.watchSignal = watchSignal;
 exports.withContexts = withContexts;
-//# sourceMappingURL=debug-CjBhOupU.js.map
+//# sourceMappingURL=debug-DW86yXJK.js.map