@solidjs/signals 2.0.0-rc.6 → 2.0.0-rc.8

package/dist/types-cjs/core/index.d.cts

@@ -1,13 +0,0 @@
-export { ContextNotFoundError, NoOwnerError, NotReadyError, TimeoutError } from "./error.cjs";
-export { isEqual, untrack, runWithOwner, computed, signal, read, setSignal, setMemo, suppressComputedRecompute, optimisticSignal, optimisticComputed, installAuthoritativeRead, markRefresh, staleValues, setSnapshotCapture, markSnapshotScope, releaseSnapshotScope, clearSnapshots } from "./core.cjs";
-export { enableExternalSource, _resetExternalSourceConfig, type ExternalSourceFactory, type ExternalSource, type ExternalSourceConfig } from "./external.cjs";
-export { createOwner, createRoot, dispose, getNextChildId, getObserver, getOwner, isDisposed, cleanup, peekNextChildId } from "./owner.cjs";
-export { createContext, getContext, setContext, type Context, type ContextRecord } from "./context.cjs";
-export { handleAsync } from "./async.cjs";
-export { isPending, latest } from "./verdict.cjs";
-export type { Computed, Disposable, FirewallSignal, Link, Owner, Root, Signal, NodeOptions } from "./types.cjs";
-export { effect, trackedEffect, type Effect, type TrackedEffect } from "./effect.cjs";
-export { action } from "./action.cjs";
-export { flush, Queue, GlobalQueue, enforceLoadingBoundary, resetErrorHalt, type IQueue, type QueueCallback } from "./scheduler.cjs";
-export { DEV, type Dev, type DevHooks, type DiagnosticCapture, type DiagnosticCode, type DiagnosticEvent, type DiagnosticKind, type Diagnostics, type DiagnosticSeverity } from "./dev.cjs";
-export * from "./constants.cjs";

package/dist/types-cjs/core/invariants.d.cts

@@ -1,59 +0,0 @@
-import type { OptimisticLane } from "./lanes.cjs";
-import type { Computed, Signal } from "./types.cjs";
-/**
- * Test-mode invariant checks for the async/transition/lane machinery.
- * Catalog and rationale: packages/signals/INTERNALS-ASYNC-STATE.md.
- *
- * These are implementation self-consistency checks, not semantic rules: a
- * violation means the reactive system contradicted itself.
- *
- * They are gated on `__TEST__` (not just `__DEV__`): the per-write Set
- * tracking and per-flush quiescence sweep are too expensive for shipped dev
- * builds and for benchmarks (they showed up as a 5-21% hit across the
- * CodSpeed suite when they ran under `__DEV__`). Call sites stay `__DEV__`
- * guarded so production tree-shakes the calls; each entry point here
- * early-returns unless `__TEST__` is set, so dev builds pay only a no-op
- * call. The test suite (vitest run) defines `__TEST__: true`; benchmark mode
- * defines `__TEST__: false`.
- */
-type AnyNode = Signal<any> | Computed<any>;
-/** Wired by core.ts at module init to avoid import cycles. */
-export declare const InvariantHooks: {
-    pendingProbeActive: (() => boolean) | null;
-    /** Fresh oracle for what an isPending companion SHOULD read right now. */
-    computePendingState: ((node: AnyNode) => boolean) | null;
-};
-export declare function devTrackHeldPending(node: AnyNode): void;
-export declare function devTrackCompanionOwner(node: AnyNode): void;
-export declare function devTrackOptimistic(node: AnyNode): void;
-export declare function devTrackAffects(node: AnyNode): void;
-/**
- * Open/close the sanctioned registration window. Call sites are `__DEV__`
- * guarded (no prod cost); the code inside the window must not throw.
- */
-export declare function beginAsyncReporterWrites(): void;
-export declare function endAsyncReporterWrites(): void;
-export declare function createAsyncReporters(): Map<Computed<any>, Set<Computed<any>>>;
-/**
- * INV-2: a node with an *active* override must be registered for reversion in
- * the queue's or a transition's `_optimisticNodes`. An unregistered active
- * override would survive transition completion forever. Runs at the end of
- * every flush (not just quiescence — the invariant holds mid-transition).
- * (There is no revert-target requirement: authoritative values commit
- * silently into `_value` under the override mask — A17 — so reverting is
- * just dropping the override.)
- */
-export declare function devCheckActiveOverrides(isRegisteredForRevert: (node: AnyNode) => boolean): void;
-/** INV-1: an isPending() probe must never leak past its own call. */
-export declare function devCheckFlushStart(): void;
-/** INV-5: a merged lane's work moved to its root on merge and must stay empty. */
-export declare function devCheckMergedLaneEmpty(lane: OptimisticLane): void;
-export declare function devCensusCompanions(isQueuedForCommit?: (node: AnyNode) => boolean): void;
-/**
- * Quiescence checks. Run only when the system is fully drained: nothing
- * scheduled, no active/stashed transitions, no live lanes. At that point no
- * transition-scoped state may survive, and the lazily-created companions must
- * agree with a fresh computation of their owner's state.
- */
-export declare function devCheckQuiescent(isQueuedForCommit: (node: AnyNode) => boolean): void;
-export {};

package/dist/types-cjs/core/lanes.d.cts

@@ -1,44 +0,0 @@
-import { type QueueCallback, type Transition } from "./scheduler.cjs";
-import type { Computed, Signal } from "./types.cjs";
-/**
- * OptimisticLane represents the context for a single optimistic write.
- * Each optimistic signal creates its own lane. Lanes merge when their
- * dependency graphs overlap.
- */
-export interface OptimisticLane {
-    _source: Signal<any>;
-    _pendingAsync: Set<Computed<any>>;
-    _effectQueues: [QueueCallback[], QueueCallback[]];
-    _mergedInto: OptimisticLane | null;
-    _transition: Transition | null;
-    _parentLane: OptimisticLane | null;
-}
-export declare const signalLanes: WeakMap<Signal<any>, OptimisticLane>;
-export declare const activeLanes: Set<OptimisticLane>;
-/**
- * Get an existing lane for a signal or create a new one.
- * Reuses lane for multiple writes to the same signal.
- */
-export declare function getOrCreateLane(signal: Signal<any>): OptimisticLane;
-/**
- * Union-find: find the root lane.
- */
-export declare function findLane(lane: OptimisticLane): OptimisticLane;
-/**
- * Merge two lanes when their dependency graphs overlap.
- */
-export declare function mergeLanes(lane1: OptimisticLane, lane2: OptimisticLane): OptimisticLane;
-/**
- * Resolve a node's lane: follow union-find chain, verify active, clear if stale.
- */
-export declare function resolveLane(el: Signal<any> | Computed<any>): OptimisticLane | undefined;
-export declare function resolveTransition(el: Signal<any> | Computed<any>): Transition | null | undefined;
-/**
- * Check if a node has an active optimistic override.
- */
-export declare function hasActiveOverride(el: Signal<any> | Computed<any>): boolean;
-/**
- * Assign or merge a lane onto a node. At convergence points (node already has
- * a different active lane), merge unless the node has an active override.
- */
-export declare function assignOrMergeLane(el: Signal<any> | Computed<any>, sourceLane: OptimisticLane): void;

package/dist/types-cjs/core/optimistic.d.cts

@@ -1,6 +0,0 @@
-/**
- * Installs the engine's hooks. Idempotent; called by every module that can
- * create optimistic state (verdict.ts at module top level, createOptimistic
- * and createOptimisticStore at first call) BEFORE any optimistic node exists.
- */
-export declare function installOptimisticEngine(): void;

package/dist/types-cjs/core/owner.d.cts

@@ -1,124 +0,0 @@
-import type { Computed, Disposable, Owner, Root } from "./types.cjs";
-export declare function markDisposal(el: Owner): void;
-export declare function dispose(node: Computed<unknown>): void;
-export declare function disposeChildren(node: Owner, self?: boolean, zombie?: boolean): void;
-/**
- * Allocates and returns the next stable child id for `owner`. Used by
- * hydration plumbing and `createUniqueId`. Not part of the user-facing API.
- *
- * @internal
- */
-export declare function getNextChildId(owner: Owner): string;
-/**
- * The id a freshly-created node inherits: an explicit `options.id` wins;
- * transparent nodes share their parent's id; otherwise the parent's next
- * child id is consumed (or `undefined` outside an id-carrying tree).
- */
-export declare function inheritId(options: {
-    id?: string;
-} | undefined, transparent: boolean, parent: Owner | null | undefined): string | undefined;
-/**
- * Returns the *next* child id for `owner` without consuming it. Used by
- * hydration plumbing to peek at the id a future child will receive.
- *
- * @internal
- */
-export declare function peekNextChildId(owner: Owner): string;
-/**
- * Returns the currently-tracking observer (the computation that subscribes to
- * reactive reads at this point), or `null` if reads here would be untracked.
- * Used by reactive primitives that need to know whether they're inside a
- * tracking scope. App code rarely needs this — see `getOwner()` for the
- * lifecycle owner instead.
- *
- * @example
- * ```ts
- * // Library predicate: only register a hot-path subscription when the
- * // caller is inside a tracking scope (memo / effect compute / JSX).
- * function trackIfTracked(source: () => unknown) {
- *   if (getObserver()) source();
- * }
- * ```
- */
-export declare function getObserver(): Owner | null;
-/**
- * Returns the current reactive **owner** — the lifecycle node that the next
- * `cleanup()` / `onCleanup()` / `createSignal()` etc. will be attached to.
- *
- * Returns `null` if called outside any owner. Capture the owner with
- * `getOwner()` and re-enter it later with `runWithOwner(owner, fn)` to attach
- * disposables created from a callback (event handler, async resolution, etc.)
- * back to a component's lifecycle.
- *
- * @example
- * ```ts
- * function defer<T>(fn: () => T) {
- *   const owner = getOwner();
- *   queueMicrotask(() => runWithOwner(owner, fn));
- * }
- * ```
- */
-export declare function getOwner(): Owner | null;
-/**
- * Low-level: registers `fn` as a disposal callback on the current owner.
- * Most code should use `onCleanup()` from `solid-js`, which adds dev-mode
- * checks. `cleanup()` is the unchecked primitive used by internals.
- */
-export declare function cleanup(fn: Disposable): Disposable;
-/**
- * Returns `true` if the owner has been disposed (or marked zombie pending
- * disposal). Pair with a captured owner to bail out of late callbacks whose
- * surrounding component already unmounted.
- *
- * @example
- * ```ts
- * function onSettleSafe(fn: () => void) {
- *   const owner = getOwner();
- *   queueMicrotask(() => {
- *     if (owner && isDisposed(owner)) return; // component unmounted; skip
- *     runWithOwner(owner, fn);
- *   });
- * }
- * ```
- */
-export declare function isDisposed(node: Owner): boolean;
-/**
- * Creates a fresh owner attached as a child of the current owner (or as a
- * detached root if there is none). Used by framework internals to group
- * cleanups; app code should use `createRoot()` (host a reactive scope outside
- * a component) or `runWithOwner()` (re-enter a captured owner).
- *
- * @internal
- */
-export declare function createOwner(options?: {
-    id?: string;
-    transparent?: boolean;
-}): Root;
-/**
- * Creates a detached reactive root. The callback receives a `dispose()`
- * function which, when called, tears down every signal, memo, effect, and
- * `onCleanup` registered inside the root.
- *
- * Use this to host long-lived reactive scopes outside of a component (custom
- * controllers, app bootstrapping, tests). Inside a component, prefer
- * letting Solid's component lifecycle own things.
- *
- * @example
- * ```ts
- * const dispose = createRoot(dispose => {
- *   const [n, setN] = createSignal(0);
- *   createEffect(() => n(), value => console.log(value));
- *   setInterval(() => setN(x => x + 1), 1000);
- *   return dispose;
- * });
- *
- * // Later, to tear everything down:
- * dispose();
- * ```
- *
- * @description https://docs.solidjs.com/reference/reactive-utilities/create-root
- */
-export declare function createRoot<T>(init: ((dispose: () => void) => T) | (() => T), options?: {
-    id?: string;
-    transparent?: boolean;
-}): T;

package/dist/types-cjs/core/scheduler.d.cts

@@ -1,231 +0,0 @@
-import { type Heap } from "./heap.cjs";
-import { activeLanes, assignOrMergeLane, findLane, type OptimisticLane } from "./lanes.cjs";
-import type { Computed, Signal } from "./types.cjs";
-export { activeLanes, assignOrMergeLane, findLane };
-export { getOrCreateLane, hasActiveOverride, mergeLanes, resolveLane } from "./lanes.cjs";
-export declare const dirtyQueue: Heap;
-export declare const zombieQueue: Heap;
-export declare let clock: number;
-export declare let activeTransition: Transition | null;
-export declare let projectionWriteActive: boolean;
-export declare let _hitUnhandledAsync: boolean;
-export declare function resetUnhandledAsync(): void;
-/**
- * Toggles the dev-mode "must be inside a `<Loading>` boundary" enforcement
- * window. Only `render()` calls this — wrapping the initial mount so that a
- * top-level uncaught async read surfaces the diagnostic. Not part of the
- * user-facing API.
- *
- * @internal
- */
-export declare function enforceLoadingBoundary(enabled: boolean): void;
-export declare function setProjectionWriteActive(value: boolean): void;
-export declare function setTrackedQueueCallback(value: boolean): void;
-export declare function setEffectCallback(value: boolean): void;
-export type QueueCallback = (type: number) => void;
-type QueueStub = {
-    _queues: [QueueCallback[], QueueCallback[]];
-    _children: QueueStub[];
-};
-type OptimisticNode = Signal<any> | Computed<any>;
-export interface Transition {
-    _time: number;
-    _asyncReporters: Map<Computed<any>, Set<Computed<any>>>;
-    _pendingNodes: Signal<any>[];
-    _optimisticNodes: OptimisticNode[];
-    _affectsNodes: OptimisticNode[];
-    _optimisticStores: Set<any>;
-    _actions: Array<Generator<any, any, any> | AsyncGenerator<any, any, any>>;
-    _queueStash: QueueStub;
-    _done: boolean | Transition;
-    _gatedSubs: Set<Computed<any>>;
-}
-/**
- * Flip-entanglement (#3164 follow-up): `until()` is a declaration of
- * relatedness — the predicate names the condition that confirms the awaiting
- * transaction. When the predicate settles truthy, every live foreign
- * transition whose staged write it read IS the confirming event by the
- * user's own definition, so it merges into the awaiting transaction and
- * reveals at the joint settle — the cross-primitive twin of the family fold
- * (a landing on an optimism-carrying family joins the retaining
- * transaction). Non-flipping updates never pass through here: falsy
- * evaluations don't entangle, so unrelated traffic on the watched sources
- * reveals freely on its own schedule.
- *
- * Runs inside the predicate's compute (pure phase) — the confirming
- * transition's stamps are still live and its commit decision hasn't run, so
- * the merge lands before any reveal. Only the tree-shaken graphs that call
- * `until()` retain this.
- */
-export declare function entangleConfirmingTransitions(obs: Computed<any>, target: Transition): void;
-export declare function schedule(): void;
-/**
- * Permanently halts the reactive system. Called when a user error escapes
- * every boundary — app state is undefined at that point, so scheduling stops
- * entirely rather than limping along with a half-applied update.
- */
-export declare function haltReactivity(cause?: unknown): void;
-/** @internal Test/dev-reload hook. Revives scheduling after a halt. */
-export declare function resetErrorHalt(): void;
-export interface IQueue {
-    enqueue(type: number, fn: QueueCallback): void;
-    run(type: number): boolean | void;
-    addChild(child: IQueue): void;
-    removeChild(child: IQueue): void;
-    created: number;
-    notify(node: Computed<any>, mask: number, flags: number, error?: any): boolean;
-    stashQueues(stub: QueueStub): void;
-    restoreQueues(stub: QueueStub): void;
-    _parent: IQueue | null;
-}
-export declare class Queue implements IQueue {
-    _parent: IQueue | null;
-    _queues: [QueueCallback[], QueueCallback[]];
-    _children: IQueue[];
-    _ranAt: number;
-    created: number;
-    addChild(child: IQueue): void;
-    removeChild(child: IQueue): void;
-    notify(node: Computed<any>, mask: number, flags: number, error?: any): boolean;
-    run(type: number): void;
-    enqueue(type: number, fn: QueueCallback): void;
-    stashQueues(stub: QueueStub): void;
-    restoreQueues(stub: QueueStub): void;
-}
-export declare class GlobalQueue extends Queue {
-    _running: boolean;
-    _batch: Transition;
-    static _update: (el: Computed<unknown>) => void;
-    static _dispose: (el: Computed<unknown>, self: boolean, zombie: boolean) => void;
-    static _runEffect: (el: Computed<unknown>) => void;
-    static _clearOptimisticStores: ((stores: Set<any>, completing: Transition | null) => void) | null;
-    static _releaseAffectsScope: ((node: OptimisticNode) => void) | null;
-    static _releaseAffectsMarks: ((nodes: OptimisticNode[]) => void) | null;
-    static _markAffects: ((node: OptimisticNode) => void) | null;
-    static _releaseAffectsMark: ((node: OptimisticNode) => void) | null;
-    static _wireExternalSource: ((self: Computed<any>) => void) | null;
-    static _externalUntrack: (<T>(fn: () => T) => T) | null;
-    static _syncCompanions: (<T>(el: Signal<T> | Computed<T>, value: T) => void) | null;
-    static _updatePendingSignal: ((el: OptimisticNode) => void) | null;
-    static _updateChildCompanions: ((el: Computed<any>) => void) | null;
-    static _snapCompanions: ((el: OptimisticNode) => void) | null;
-    static _latestRead: (<T>(el: Signal<T> | Computed<T>) => T) | null;
-    static _pendingCheck: ((el: OptimisticNode, c: Computed<any> | null, owner: OptimisticNode, firewall: Computed<any> | null) => void) | null;
-    static _recordFresh: ((el: OptimisticNode, value: any) => void) | null;
-    static _applyReask: ((el: Computed<any>, hadReask: boolean) => boolean) | null;
-    static _repollVerdicts: ((el: Computed<any>, snap?: boolean) => void) | null;
-    static _witnessAffects: ((node: OptimisticNode) => void) | null;
-    static _wakeSuppressedProbes: ((transition: Transition) => void) | null;
-    static _optimisticWrite: (<T>(el: Signal<T> | Computed<T>, v: T | ((prev: T) => T)) => T) | null;
-    static _resolveOptimistic: ((nodes: OptimisticNode[]) => void) | null;
-    static _transitionBlocked: ((transition: Transition) => boolean) | null;
-    static _cleanupLanes: ((completingTransition: Transition | null) => void) | null;
-    static _runLaneEffects: ((type: number) => void) | null;
-    /** Patch-channel optimistic drain (next/patch.ts): optimistic emissions
-     * apply at lane-effect timing — visible in flight, unlike the regular
-     * effect queues an action stashes. Injected; null when unused. */
-    static _drainPatchOptimistic: (() => void) | null;
-    static _gatedRead: ((el: Signal<any>, owner: OptimisticNode, c: Computed<any>) => boolean) | null;
-    static _laneSuspends: ((owner: OptimisticNode) => boolean) | null;
-    static _laneReadsCommitted: ((el: OptimisticNode, owner: OptimisticNode, c: Computed<any>) => boolean) | null;
-    static _recomputeLane: ((el: Computed<any>, own: boolean) => OptimisticLane | null | false) | null;
-    static _laneAsyncPending: ((el: Computed<any>) => void) | null;
-    /** Authoritative-view reader wakeup (until()): installed at first until() call.
-     * Call sites are gated by CONFIG_AUTHORITATIVE_OBSERVED, which only until()'s
-     * carve-out read can set, so `!` invocations are safe once the gate holds. */
-    static _notifyAuthoritativeObservers: ((el: Signal<any> | Computed<any>) => void) | null;
-    static _laneAsyncSettled: ((el: Computed<any>) => void) | null;
-    static _trackOptimisticStore: ((store: any) => void) | null;
-    flush(): void;
-    notify(node: Computed<any>, mask: number, flags: number, error?: any): boolean;
-    initTransition(transition?: Transition | null): void;
-}
-export declare function queuePendingNode(node: Signal<any>): void;
-export declare let reaskArmed: boolean;
-/** §12d: bumped by every recompute and every new subscriber edge. A node's
- * staged-rewrite skip is sound only while NOTHING recomputed or linked since
- * its last notify — a mid-batch pull can clean a marked subscriber, and a
- * skipped re-write would leave it stale. */
-export declare let notifyEpoch: number;
-export declare function bumpNotifyEpoch(): void;
-export declare function armReaskClear(): void;
-export declare function insertSubs(node: Signal<any> | Computed<any>, optimistic?: boolean): void;
-export declare let storeCommitHook: (() => void) | null;
-export declare function setStoreCommitHook(fn: () => void): void;
-/** Patch-channel release hook (next/patch.ts): transition-stamped patch
- * emissions are released when THEIR batch commits. Transitions never
- * abort: failed actions still commit (only optimistic overrides revert),
- * and merged-away transitions hand their stash to the survivor
- * (mergeTransitionState) — every stash drains exactly once. Injected like
- * storeCommitHook to stay tree-shakeable. */
-export declare let patchCommitHook: ((batch: Transition) => void) | null;
-export declare function setPatchCommitHook(fn: (batch: Transition) => void): void;
-export declare function finalizePureQueue(completingTransition?: Transition | null, incomplete?: boolean): void;
-/**
- * Count of live `affects()` registrations across the system (including
- * store-scope inherited marks). Gates the read-path mark check in `read()` so
- * graphs that never use the feature pay one integer compare.
- */
-export declare let activeAffectsMarks: number;
-/**
- * Counter mutation seam for the mark engine in affects.ts: an imported `let`
- * binding is read-only, and the read-path gate above must stay a plain module
- * variable so `read()` pays one integer compare, not a function call.
- *
- * @internal
- */
-export declare function shiftAffectsMarks(delta: 1 | -1): void;
-export declare const globalQueue: GlobalQueue;
-/**
- * Synchronously processes the pending reactive queue, or runs `fn` in a synchronous
- * flush scope before draining the queue.
- *
- * Reactive updates are normally batched onto the microtask queue, so multiple
- * writes in a row collapse into a single update pass. Call `flush()` when you
- * need to *observe* the result of those writes synchronously — most commonly
- * in tests, but also at the boundary of imperative integration code. Pass a
- * callback when the writes themselves should bypass microtask scheduling and
- * drain synchronously when the callback returns.
- *
- * @example
- * ```ts
- * const [count, setCount] = createSignal(0);
- * const doubled = createMemo(() => count() * 2);
- *
- * setCount(5);
- * flush();
- * expect(doubled()).toBe(10);
- *
- * flush(() => setCount(6));
- * expect(doubled()).toBe(12);
- *
- * // Nested flushes drain at each level:
- * flush(() => {
- *   setCount(7);
- *   flush(() => setCount(8)); // inner drain — effects fire here
- *   // outer continues with up-to-date state
- * });
- * ```
- */
-export declare function flush(): void;
-export declare function flush<T>(fn: () => T): T;
-/** A fresh, unentered transaction (#3146): the optimistic store's truth
- * flight DECLARES an owned transaction instead of relying on whatever the
- * ambient adoption machinery stamped on its firewall. Activate it with
- * initTransition; it is a plain batch until then. */
-export declare function createTransition(): Transition;
-export declare function currentTransition(transition: Transition): Transition;
-export declare function setActiveTransition(transition: Transition | null): void;
-export declare function runInTransition<T>(transition: Transition, fn: () => T): T;
-/** Run `fn` with `transition` as BOTH the ambient transaction and the
- * registration batch, restoring both after. runInTransition alone is not
- * enough for code that WRITES on behalf of a transaction from inside someone
- * else's window (optimistic replay re-arming a still-open action's edits
- * during a landing commit, #3123): registrations route through the queue's
- * batch pointer, and a bare activeTransition swap leaves them in the ambient
- * batch — a plain batch "completes" at the next flush and reverts optimistic
- * registrations that were supposed to live with the transaction.
- * initTransition is the wrong tool here: it MERGES the currently ambient
- * transaction into the target, entangling whatever the interrupted window
- * belonged to. */
-export declare function runAsTransitionBatch<T>(transition: Transition, fn: () => T): T;