@opfs-vfs/effect 0.3.0 → 0.4.0

package/README.md

@@ -1,6 +1,11 @@
 # @opfs-vfs/effect
 
-Effect v4 adapter for worker-backed OPFS volumes and direct mounts. Requires stable `effect@4.0.0`; consumers must upgrade their Effect runtime to 4.0.0.
+Effect v4 adapter for worker-backed OPFS volumes and direct mounts. Requires stable Effect v4, starting at `4.1.0` and excluding v5 and prereleases.
+
+Install it with the exact `@opfs-vfs/opfs-vfs` and `@opfs-vfs/plugin-subscriptions`
+versions listed in its peer dependencies, and upgrade the three packages
+together. The default worker contains a copy of the storage engine, so a
+different core version would run a different engine than the one you installed.
 
 ```ts
 import { Effect } from 'effect';
@@ -64,9 +69,10 @@ listing, removal, rename, recursive copy and volume-local temporary paths.
 Unlike Node's filesystem, operands must be absolute volume paths; relative
 symlink targets are preserved. Recursive copy does not follow symlinks, keeps
 copied relative link targets as written (Node's default copy resolves them to
-the source), is not atomic, and does not preserve hard-link topology. `chown`
-and `glob` remain intentionally unsupported in v1 and return typed `ENOTSUP`
-errors. Scoped temporary paths remove only their private directory
+the source), is not atomic, and does not preserve hard-link topology. As in
+Node, `remove` rejects any directory, empty or not, unless `recursive` is set. `glob`
+needs an absolute `root` or pattern. `chown` remains intentionally unsupported
+in v1 and returns a typed `ENOTSUP` error. Scoped temporary paths remove only their private directory
 when the scope closes; the default parent is `/tmp` inside the volume. A temporary
 path uses its resolved physical parent, so retargeting the caller-supplied parent
 symlink does not redirect cleanup. Ownership covers the created root pathname and
@@ -80,7 +86,9 @@ path fails with `NotFound`, and a symlink target fails with `BadResource`. It
 watches regular files or directories and emits absolute volume paths as
 `Create`, `Update`, or `Remove`. Recursive directory watching preserves the
 native descendant records for directory renames; symlink entries inside a
-watched directory are reported, but a symlink target is not followed.
+watched directory are reported, but a symlink target is not followed. The watched
+path is resolved through the volume, so `watch` agrees with every other call
+and reports canonical paths.
 
 Watch notifications are hints, not a replayable log. Preflight checks and
 directory scans are not atomic snapshots; logical event counts and ordering can

package/dist/errors.js

@@ -1,5 +1,5 @@
 import { Schema as e } from "effect";
-//#region src/errors.ts
+// src/errors.ts
 var t = [
 	"meta-snapshot",
 	"data-wal",
@@ -155,5 +155,4 @@ var t = [
 		...h === void 0 ? {} : { cause: h }
 	});
 };
-//#endregion
 export { a as EncryptionError, s as MountError, n as RemoteErrorDetails, o as SubscriptionError, i as VolumeError, f as classify, h as mountError, l as remoteDetails, m as volumeError };