@openclaw/fs-safe 0.19.0 → 0.21.0

package/dist/watch-alias.js

@@ -0,0 +1,80 @@
+import path from "node:path";
+import { FsSafeError } from "./errors.js";
+import { isNotFoundPathError } from "./path.js";
+import { assertRootIdentityCurrent, resolvePathInRoot } from "./root-context.js";
+import { createRootDirectoryObservationGuard, assertRootDirectoryObservationGuard } from "./root-directory-list.js";
+import { lookupRootDirectoryEntry } from "./root-directory-entry.js";
+import { nativeChanges, scopedChanges } from "./watch-hints.js";
+/** Resolve native spelling aliases without treating case folding as identity. */
+export async function admittedNativeChanges(root, scopes, before, after, batch, signal, limit) {
+    if (!nativeChanges(scopes, before, batch, limit))
+        return undefined;
+    const result = new Map();
+    const candidates = new Map([...before?.targets ?? [], ...after.targets, ...after.directories]);
+    const add = (change) => {
+        if (!result.has(change.path) && result.size >= limit)
+            return false;
+        const prior = result.get(change.path);
+        result.set(change.path, prior?.type === "structural" ? prior : change);
+        return true;
+    };
+    for (const hint of batch.hints) {
+        signal.throwIfAborted();
+        const name = hint.name; // nativeChanges rejected unknown or non-literal names.
+        let parent = hint.directory;
+        let guard;
+        let expected = after.directories.get(parent);
+        if (!expected) {
+            // Native recursion observes one Root handle and may report descendants of
+            // unselected/entry-only directories. Admit a parent alias by exact identity,
+            // not by lowercasing, and do not turn unselected descendants into events.
+            try {
+                const resolved = await resolvePathInRoot(root, parent ? "./" + parent : ".", { rejectSymlinks: true });
+                guard = await createRootDirectoryObservationGuard(root, resolved.resolved);
+            }
+            catch (error) {
+                await assertRootIdentityCurrent(root);
+                if (isNotFoundPathError(error) || (error instanceof FsSafeError && ["not-found", "path-alias", "outside-workspace", "symlink", "not-file"].includes(error.code)))
+                    continue;
+                throw error;
+            }
+            const admitted = [...after.directories].find(([, identity]) => identity.dev === guard.stat.dev && identity.ino === guard.stat.ino);
+            if (!admitted)
+                continue;
+            [parent, expected] = admitted;
+        }
+        const candidate = parent ? path.join(parent, name) : name;
+        const selected = scopedChanges(scopes, { path: candidate,
+            type: hint.event === "change" && before?.entries.get(candidate)?.startsWith("file:") ? "content" : "structural" });
+        if (selected.length) {
+            for (const change of selected)
+                if (!add(change))
+                    return undefined;
+            continue;
+        }
+        if (!guard) {
+            const resolved = await resolvePathInRoot(root, parent ? "./" + parent : ".", { rejectSymlinks: true });
+            guard = await createRootDirectoryObservationGuard(root, resolved.resolved);
+        }
+        if (guard.stat.dev !== expected.dev || guard.stat.ino !== expected.ino) {
+            throw new FsSafeError("path-mismatch", "watch hint parent changed during reconciliation");
+        }
+        const found = await lookupRootDirectoryEntry(root, guard, name);
+        signal.throwIfAborted();
+        if (!found)
+            return undefined; // Could be a deleted short-name/case alias.
+        for (const [relative, identity] of candidates) {
+            if (!relative || (path.dirname(relative) === "." ? "" : path.dirname(relative)) !== parent)
+                continue;
+            if (identity.dev !== found.identity.dev || identity.ino !== found.identity.ino)
+                continue;
+            for (const change of scopedChanges(scopes, { path: relative, type: "structural" }))
+                if (!add(change))
+                    return undefined;
+        }
+        await assertRootDirectoryObservationGuard(root, guard);
+    }
+    await assertRootIdentityCurrent(root);
+    signal.throwIfAborted();
+    return [...result.values()];
+}

package/dist/watch-hints.d.ts

@@ -0,0 +1,8 @@
+import type { NativeWatchBatch } from "./watch-native.js";
+import type { WatchSnapshot } from "./watch-scan.js";
+import type { WatchChange, WatchScope } from "./watch-types.js";
+export declare function scopedChanges(scopes: readonly WatchScope[], change: WatchChange): WatchChange[];
+export declare function nativeChanges(scopes: readonly WatchScope[], snapshot: WatchSnapshot | undefined, batch: NativeWatchBatch, limit?: number): WatchChange[] | undefined;
+export declare function changedEntries(before: WatchSnapshot | undefined, after: WatchSnapshot, limit: number): WatchChange[] | undefined;
+/** Backend names never establish authority to publish a pathname. */
+export declare function guardedHintChanges(scopes: readonly WatchScope[], before: WatchSnapshot | undefined, after: WatchSnapshot, hints: readonly WatchChange[] | undefined, observed: readonly WatchChange[] | undefined, limit: number): WatchChange[] | undefined;

package/dist/watch-hints.js

@@ -0,0 +1,77 @@
+import path from "node:path";
+function below(parent, child) {
+    return parent === "" ? child !== "" : child.startsWith(parent + path.sep);
+}
+function distance(parent, child) {
+    return (parent === "" ? child : child.slice(parent.length + 1)).split(path.sep).length;
+}
+export function scopedChanges(scopes, change) {
+    const result = new Map();
+    for (const scope of scopes) {
+        if (scope.path === change.path || (scope.kind === "tree" && below(scope.path, change.path) && distance(scope.path, change.path) <= scope.depth)) {
+            result.set(change.path, change);
+        }
+        else if (below(change.path, scope.path)) {
+            // A changed ancestor invalidates the requested target, not authority outside it.
+            result.set(scope.path, { path: scope.path, type: "structural" });
+        }
+    }
+    return [...result.values()];
+}
+export function nativeChanges(scopes, snapshot, batch, limit = 256) {
+    if (batch.overflow)
+        return undefined;
+    const result = new Map();
+    for (const hint of batch.hints) {
+        const name = hint.name;
+        // Backend filenames are untrusted hints. Never resolve or perform I/O on them.
+        if (typeof name !== "string" || !name || name === "." || name === ".." || name.includes("\0") || name.includes("/") || (process.platform === "win32" && /[\\:]/.test(name)))
+            return undefined;
+        const relative = hint.directory ? path.join(hint.directory, name) : name;
+        for (const change of scopedChanges(scopes, {
+            path: relative,
+            type: hint.event === "change" && snapshot?.entries.get(relative)?.startsWith("file:") ? "content" : "structural",
+        })) {
+            if (!result.has(change.path) && result.size >= limit)
+                return undefined;
+            const prior = result.get(change.path);
+            result.set(change.path, prior?.type === "structural" ? prior : change);
+        }
+    }
+    return [...result.values()];
+}
+export function changedEntries(before, after, limit) {
+    if (!before)
+        return undefined;
+    const changes = [];
+    for (const name of new Set([...before.entries.keys(), ...after.entries.keys()])) {
+        const left = before.entries.get(name);
+        const right = after.entries.get(name);
+        if (left === right)
+            continue;
+        if (changes.length >= limit)
+            return undefined;
+        const sameFile = left?.startsWith("file:") && right?.startsWith("file:") &&
+            left.split(":").slice(0, 3).join(":") === right.split(":").slice(0, 3).join(":");
+        changes.push(Object.freeze({ path: name, type: sameFile ? "content" : "structural" }));
+    }
+    return changes;
+}
+/** Backend names never establish authority to publish a pathname. */
+export function guardedHintChanges(scopes, before, after, hints, observed, limit) {
+    if (!hints || !observed)
+        return undefined;
+    const result = new Map(observed.map(change => [change.path, change]));
+    for (const hint of hints) {
+        // Only publish an independently observed name (including a deletion from
+        // the previous guarded snapshot), or a target explicitly supplied by caller.
+        // A stale/misdirected inode watch may report outside names: erase its detail.
+        if (!before?.entries.has(hint.path) && !after.entries.has(hint.path) && !scopes.some(scope => scope.path === hint.path))
+            return undefined;
+        if (!result.has(hint.path) && result.size >= limit)
+            return undefined;
+        const prior = result.get(hint.path);
+        result.set(hint.path, Object.freeze(prior?.type === "structural" ? prior : hint));
+    }
+    return [...result.values()];
+}

package/dist/watch-native.d.ts

@@ -0,0 +1,32 @@
+import { type NativeBinding } from "./native.js";
+import type { RootContext } from "./root-context.js";
+import type { DirectoryIdentity } from "./watch-scan.js";
+export type NativeWatchHint = {
+    directory: string;
+    name: string;
+    event: "rename" | "change";
+};
+export type NativeWatchBatch = {
+    hints: NativeWatchHint[];
+    overflow: boolean;
+    error?: string;
+};
+export type NativeWatchWireBatch = {
+    hints: {
+        directory: string;
+        name: string;
+        structural: boolean;
+    }[];
+    overflow: boolean;
+    error?: string;
+};
+export declare function watchBinding(mode: "auto" | "events" | "poll"): NativeBinding | undefined;
+export declare class NativeWatchBackend {
+    private binding;
+    private root;
+    private id;
+    constructor(binding: NativeBinding, root: RootContext, callback: (batch: NativeWatchBatch) => void, limit: number, persistent: boolean);
+    add(name: string, identity: DirectoryIdentity): void;
+    testEvent(path: string, flags: number): void;
+    close(): void;
+}

package/dist/watch-native.js

@@ -0,0 +1,56 @@
+import { FsSafeError } from "./errors.js";
+import { getNativeBinding } from "./native.js";
+import { getFsSafeNativeConfig } from "./native-config.js";
+export function watchBinding(mode) {
+    if (mode === "poll")
+        return;
+    const binding = getNativeBinding(); // Preserves require + missing-addon failure.
+    // Bun TSFN teardown remains unqualified; guarded native scans remain usable.
+    if (binding?.watchRegister && !process.versions.bun && !process.versions.deno && ["linux", "darwin", "win32"].includes(process.platform))
+        return binding;
+    if (mode === "events" || getFsSafeNativeConfig().mode === "require") {
+        throw new FsSafeError("helper-unavailable", "native watch events are unavailable", { details: { operation: "watch" } });
+    }
+}
+export class NativeWatchBackend {
+    binding;
+    root;
+    id;
+    constructor(binding, root, callback, limit, persistent) {
+        this.binding = binding;
+        this.root = root;
+        try {
+            this.id = binding.watchRegister(root.rootReal, limit, batch => {
+                if (this.id !== undefined)
+                    callback({ overflow: batch.overflow, error: batch.error, hints: batch.hints.map(hint => ({
+                            directory: hint.directory, name: hint.name, event: hint.structural ? "rename" : "change",
+                        })) });
+            }, persistent);
+        }
+        catch (cause) {
+            throw watchError(cause);
+        }
+    }
+    add(name, identity) {
+        try {
+            this.binding.watchAdd(this.id, { root: this.root.rootReal, relative: name,
+                rootDev: BigInt(this.root.rootIdentity.dev), rootIno: BigInt(this.root.rootIdentity.ino), ...identity });
+        }
+        catch (cause) {
+            throw watchError(cause);
+        }
+    }
+    testEvent(path, flags) { this.binding.watchTestEvent(this.id, path, flags); }
+    close() {
+        const id = this.id;
+        this.id = undefined; // Fence queued TSFN callbacks before synchronous native join.
+        if (id !== undefined)
+            this.binding.watchUnregister(id);
+    }
+}
+function watchError(cause) {
+    const code = cause?.code;
+    return new FsSafeError(code === "ENOTSUP" ? "helper-unavailable" : ["ESTALE", "ENOTDIR", "ELOOP"].includes(code ?? "") ? "path-mismatch" : code === "ENOENT" ? "not-found" : "helper-failed", "native watch registration failed", {
+        cause, details: { operation: "watch", code },
+    });
+}

package/dist/watch-scan.d.ts

@@ -0,0 +1,24 @@
+import { type RootContext } from "./root-context.js";
+import { type RootDirectoryObservationGuard } from "./root-directory-list.js";
+import type { WatchOptions, WatchScope } from "./watch-types.js";
+export type DirectoryIdentity = Readonly<{
+    dev: bigint;
+    ino: bigint;
+}>;
+export type WatchSnapshot = {
+    entries: Map<string, string>;
+    directories: Map<string, DirectoryIdentity>;
+    targets: Map<string, DirectoryIdentity>;
+    scanned: number;
+    structural?: Set<string>;
+    overflow?: boolean;
+};
+export declare function watchScopes(input: readonly WatchScope[]): readonly WatchScope[];
+/** A descendant's unavailable metadata never grants it authority or retires the Root. */
+export declare function isWatchPathError(error: unknown): boolean;
+export declare function scanWatch(root: RootContext, scopes: readonly WatchScope[], options: Pick<WatchOptions, "exclude"> & {
+    maxEntries: number;
+    maxDirectories: number;
+    maxPendingPaths: number;
+    admitting: boolean;
+}, signal: AbortSignal, register: (name: string, identity: DirectoryIdentity, guard: RootDirectoryObservationGuard) => Promise<void>, onCleanupFailure?: (error: unknown) => void): Promise<WatchSnapshot>;

package/dist/watch-scan.js

@@ -0,0 +1,269 @@
+import path from "node:path";
+import { isWindowsReservedDeviceName } from "./device-path.js";
+import { isNotFoundPathError } from "./path.js";
+import { FsSafeError } from "./errors.js";
+import { assertSynchronousCallbackResult } from "./mutation-authority.js";
+import { validatePinnedRelativePath } from "./pinned-operation.js";
+import { assertRootIdentityCurrent, assertValidRootRelativePath, resolvePathInRoot } from "./root-context.js";
+import { createRootDirectoryObservationGuard, assertRootDirectoryObservationGuard, openRootDirectoryListing, pathStatFromStats } from "./root-directory-list.js";
+import { createSuppressedError } from "./suppressed-error.js";
+import { lookupRootDirectoryEntry } from "./root-directory-entry.js";
+export function watchScopes(input) {
+    if (!Array.isArray(input) || input.length > 128)
+        throw new RangeError("watch accepts at most 128 scopes");
+    return Object.freeze(input.map(scope => {
+        const { path: suppliedPath, kind: suppliedKind, depth: suppliedDepth } = scope;
+        if (typeof suppliedPath !== "string" || path.isAbsolute(suppliedPath))
+            throw new FsSafeError("invalid-path", "watch scopes must be relative");
+        validatePinnedRelativePath(suppliedPath);
+        assertValidRootRelativePath(suppliedPath);
+        if (process.platform === "win32" && suppliedPath.split(/[\\/]/).some(component => component !== "." &&
+            (component.endsWith(".") || component.endsWith(" ") || isWindowsReservedDeviceName(component)))) {
+            throw new FsSafeError("invalid-path", "watch scopes must use literal Windows names");
+        }
+        if (suppliedKind !== "entry" && suppliedKind !== "tree")
+            throw new TypeError("invalid watch scope kind");
+        const depth = suppliedDepth ?? 32;
+        if (!Number.isSafeInteger(depth) || depth < 0 || depth > 128)
+            throw new RangeError("watch depth must be between 0 and 128");
+        // Normalize only admitted input, then remove the separator normalize preserves.
+        const spelling = path.normalize(suppliedPath);
+        const normalized = spelling.endsWith(path.sep) ? spelling.slice(0, -1) : spelling;
+        return Object.freeze({ path: normalized === "." ? "" : normalized, kind: suppliedKind, depth });
+    }));
+}
+function kind(entry) {
+    return entry.isSymbolicLink ? "symlink" : entry.isDirectory ? "directory" : entry.isFile ? "file" : "other";
+}
+function fingerprint(entry, identity) {
+    const { dev, ino } = identity;
+    // Metadata is advisory; identity bits are never rounded through PathStat. Directory size/mtime
+    // reflect children, not changes to an entry-only scope.
+    return entry.isDirectory
+        ? [kind(entry), dev, ino, entry.mode].join(":")
+        : [kind(entry), dev, ino, entry.size, entry.mtimeMs, entry.mode].join(":");
+}
+/** A descendant's unavailable metadata never grants it authority or retires the Root. */
+export function isWatchPathError(error) {
+    if (isNotFoundPathError(error))
+        return true;
+    if (error instanceof FsSafeError) {
+        if (error.details?.operation === "watch" && ["EACCES", "EPERM", "EBUSY"].includes(String(error.details.code)))
+            return true;
+        return ["not-found", "path-mismatch", "not-file", "symlink", "outside-workspace", "path-alias"].includes(error.code);
+    }
+    return ["ENOTDIR", "EACCES", "EPERM", "EBUSY", "ESTALE", "EIO", "ELOOP"].includes(error?.code ?? "");
+}
+export async function scanWatch(root, scopes, options, signal, register, onCleanupFailure) {
+    const result = { entries: new Map(), directories: new Map(), targets: new Map(), scanned: 0 };
+    const attempts = new Map();
+    const guards = new Map();
+    const walked = new Map();
+    const structural = new Set();
+    result.structural = structural;
+    const invalidate = (relative) => {
+        if (structural.size < options.maxPendingPaths)
+            structural.add(relative);
+        else
+            result.overflow = true;
+        // Discard partially observed names when their enclosing directory lost admission.
+        const below = (name) => name === relative || !relative || name.startsWith(relative + path.sep);
+        for (const map of [result.entries, result.targets, result.directories, guards, walked]) {
+            for (const name of map.keys())
+                if (below(name))
+                    map.delete(name);
+        }
+    };
+    const recover = async (relative, error) => {
+        signal.throwIfAborted();
+        await assertRootIdentityCurrent(root);
+        const code = error instanceof FsSafeError ? error.details?.code ?? error.code : error?.code;
+        if (!isWatchPathError(error) || (!relative && (code === "EACCES" || code === "EPERM")))
+            throw error;
+        invalidate(relative);
+    };
+    const examined = () => {
+        if (++result.scanned > options.maxEntries)
+            throw new FsSafeError("too-large", "watch entry budget exceeded", { details: { operation: "scan" } });
+    };
+    const excluded = (name, entry) => {
+        let value;
+        try {
+            value = options.exclude?.({ path: name, kind: kind(entry) });
+            assertSynchronousCallbackResult(value, "watch exclude");
+        }
+        catch (cause) {
+            throw new FsSafeError("helper-failed", "watch exclusion callback failed", { cause, details: { operation: "callback" } });
+        }
+        signal.throwIfAborted();
+        return value;
+    };
+    const directory = async (relative) => {
+        signal.throwIfAborted();
+        const prior = guards.get(relative);
+        if (prior) {
+            try {
+                await assertRootDirectoryObservationGuard(root, prior);
+                return prior;
+            }
+            catch (error) {
+                await recover(relative, error);
+            }
+        }
+        if (!attempts.has(relative) && attempts.size >= options.maxDirectories) {
+            throw new FsSafeError("too-large", "watch directory budget exceeded", { details: { operation: "scan" } });
+        }
+        let registrationError;
+        while ((attempts.get(relative) ?? 0) < 3) {
+            attempts.set(relative, (attempts.get(relative) ?? 0) + 1);
+            try {
+                const resolved = await resolvePathInRoot(root, relative ? "./" + relative : ".", { rejectSymlinks: true });
+                const guard = await createRootDirectoryObservationGuard(root, resolved.resolved);
+                const identity = { dev: guard.stat.dev, ino: guard.stat.ino };
+                result.directories.set(relative, identity);
+                await register(relative, identity, guard);
+                signal.throwIfAborted();
+                await assertRootDirectoryObservationGuard(root, guard);
+                guards.set(relative, guard);
+                return guard;
+            }
+            catch (error) {
+                registrationError = error;
+                await recover(relative, error);
+            }
+        }
+        if (!relative)
+            throw new FsSafeError("helper-failed", "watch Root registration could not be established", {
+                cause: registrationError, details: { operation: "watch", code: "registration-failed" },
+            });
+        throw new FsSafeError("path-mismatch", "watch directory changed during registration");
+    };
+    const tree = async (relative, depth) => {
+        if ((walked.get(relative) ?? 0) >= depth)
+            return;
+        walked.set(relative, depth);
+        let guard;
+        let listing;
+        for (let attempt = 0; attempt < 3; attempt++) {
+            try {
+                guard = await directory(relative);
+                listing = await openRootDirectoryListing(root, guard.realPath, {
+                    order: "filesystem", snapshot: false, signal, exactIdentity: true, onCleanupFailure, admitEntry: () => { examined(); return true; },
+                });
+                // The listing has its own guard. Both identities must agree before reading names.
+                await assertRootDirectoryObservationGuard(root, guard);
+                break;
+            }
+            catch (error) {
+                await listing?.[Symbol.asyncDispose]();
+                listing = undefined;
+                await recover(relative, error);
+            }
+        }
+        if (!listing)
+            return;
+        let failed = false;
+        let operationError;
+        try {
+            while (true) {
+                const next = await listing.next();
+                signal.throwIfAborted();
+                if (!next)
+                    break;
+                if (next.kind === "limit")
+                    throw new FsSafeError("too-large", "watch entry budget exceeded");
+                if (!next.identity)
+                    throw new FsSafeError("path-mismatch", "watch listing lacks exact identity");
+                const entry = next.entry;
+                const name = relative ? path.join(relative, entry.name) : entry.name;
+                if (excluded(name, entry))
+                    continue;
+                result.entries.set(name, fingerprint(entry, next.identity));
+                if (entry.isDirectory && !entry.isSymbolicLink && depth > 1)
+                    await tree(name, depth - 1);
+            }
+            await listing.assertCurrent();
+        }
+        catch (error) {
+            failed = true;
+            operationError = error;
+            await recover(relative, error);
+        }
+        finally {
+            try {
+                await listing[Symbol.asyncDispose]();
+            }
+            catch (closeError) {
+                if (failed)
+                    throw createSuppressedError(closeError, operationError, "watch scan and directory disposal both failed");
+                throw closeError;
+            }
+        }
+        try {
+            await assertRootDirectoryObservationGuard(root, guard);
+        }
+        catch (error) {
+            await recover(relative, error);
+        }
+    };
+    await assertRootIdentityCurrent(root);
+    for (const scope of scopes) {
+        signal.throwIfAborted();
+        if (!scope.path) {
+            const guard = await directory("");
+            result.entries.set("", fingerprint({ name: "", ...pathStatFromStats(guard.stat) }, guard.stat));
+            if (scope.kind === "tree" && scope.depth > 0)
+                await tree("", scope.depth);
+            continue;
+        }
+        const segments = scope.path.split(path.sep);
+        let relative = "";
+        try {
+            for (let i = 0; i < segments.length; i++) {
+                const guard = await directory(relative);
+                examined();
+                // Filesystem lookup, not lowercase/prefix matching, owns case, Unicode and
+                // short-name aliases. It also preserves case-sensitive Windows directories.
+                const found = await lookupRootDirectoryEntry(root, guard, segments[i]);
+                signal.throwIfAborted();
+                if (!found)
+                    break;
+                const name = relative ? path.join(relative, segments[i]) : segments[i];
+                if (excluded(name, found.entry))
+                    break;
+                if (i === segments.length - 1) {
+                    result.entries.set(name, fingerprint(found.entry, found.identity));
+                    result.targets.set(name, found.identity);
+                    if (scope.kind === "tree" && found.entry.isDirectory && !found.entry.isSymbolicLink && scope.depth > 0)
+                        await tree(name, scope.depth);
+                    break;
+                }
+                if (found.entry.isSymbolicLink) {
+                    if (options.admitting)
+                        throw new FsSafeError("symlink", "watch scope traverses a symbolic link; admit its target separately", { details: { operation: "scope" } });
+                    invalidate(name);
+                    break;
+                }
+                if (!found.entry.isDirectory)
+                    break;
+                relative = name;
+            }
+        }
+        catch (error) {
+            if (error instanceof FsSafeError && error.details?.operation === "scope")
+                throw error;
+            await recover(relative, error);
+        }
+    }
+    for (const [relative, guard] of guards) {
+        try {
+            await assertRootDirectoryObservationGuard(root, guard);
+        }
+        catch (error) {
+            await recover(relative, error);
+        }
+    }
+    await assertRootIdentityCurrent(root);
+    signal.throwIfAborted();
+    return result;
+}

package/dist/watch-types.d.ts

@@ -0,0 +1,58 @@
+/** Literal Root-relative names. Trees include their entry; depth defaults to 32 (max 128). */
+export type WatchScope = Readonly<{
+    path: string;
+    kind: "entry" | "tree";
+    depth?: number;
+}>;
+export type WatchEntry = Readonly<{
+    path: string;
+    kind: "file" | "directory" | "symlink" | "other";
+}>;
+export type WatchChange = Readonly<{
+    path: string;
+    type: "content" | "structural";
+}>;
+export type WatchInvalidation = Readonly<{
+    reason: "event" | "reconcile" | "overflow";
+    /** Bounded advisory detail. undefined => invalidate every configured scope. */
+    changes?: readonly WatchChange[];
+}>;
+export type WatchFailure = Readonly<{
+    operation: "watch" | "scan" | "callback" | "close";
+    code?: string;
+    error: unknown;
+}>;
+export type WatchHealth = Readonly<{
+    state: "starting" | "ready" | "reconciling" | "unavailable" | "closed";
+    mode: "events" | "poll";
+    /** Directories currently observed, for pressure warnings. */
+    directories: number;
+    failure?: WatchFailure;
+}>;
+export type WatchOptions = {
+    scopes: readonly WatchScope[];
+    /** Required. auto selects events when available, otherwise poll. */
+    mode: "auto" | "events" | "poll";
+    /** Keep the Node event loop alive while open. Defaults to true. */
+    persistent?: boolean;
+    /** Guarded reconciliation interval: events 30000, poll 1000; minimum 20 ms. */
+    intervalMs?: number;
+    exclude?: (entry: WatchEntry) => boolean;
+    maxDirectories?: number;
+    maxEntries?: number;
+    maxPendingPaths?: number;
+    onInvalidate: (invalidation: WatchInvalidation) => void;
+    onHealth?: (health: WatchHealth) => void;
+    signal?: AbortSignal;
+};
+export type WatchSubscription = {
+    readonly ready: Promise<void>;
+    /** Immediately fences the old generation. Superseded calls reject AbortError. */
+    setScopes(scopes: readonly WatchScope[]): Promise<void>;
+    /** Completes a pass started after this call; concurrent pending requests coalesce. */
+    reconcile(): Promise<void>;
+    health(): WatchHealth;
+    /** Terminal, idempotent, joined; rejects only retirement failures. */
+    close(): Promise<void>;
+    [Symbol.asyncDispose](): Promise<void>;
+};

package/dist/watch-types.js

@@ -0,0 +1 @@
+export {};

package/dist/watch.d.ts

@@ -0,0 +1,5 @@
+import type { Root } from "./root.js";
+import type { WatchOptions, WatchSubscription } from "./watch-types.js";
+export type * from "./watch-types.js";
+/** Advisory observation only. Hints never grant filesystem authority. */
+export declare function watch(root: Root, input: WatchOptions): WatchSubscription;