@componentor/fs 3.0.3 → 3.0.5

package/README.md

@@ -82,6 +82,7 @@ const fs = new VFSFileSystem({
   strictPermissions: false, // Enforce Unix permissions (default: false)
   sabSize: 4194304,       // SharedArrayBuffer size in bytes (default: 4MB)
   debug: false,           // Enable debug logging (default: false)
+  swScope: undefined,     // Custom service worker scope (default: auto-scoped per root)
 });
 ```
 
@@ -368,6 +369,33 @@ constants.O_TRUNC    // 512
 constants.O_APPEND   // 1024
 ```
 
+## Maintenance Helpers
+
+Standalone utilities for VFS maintenance, recovery, and migration. Must be called from a Worker context (sync access handle requirement). Close any running `VFSFileSystem` instance first.
+
+```typescript
+import { unpackToOPFS, loadFromOPFS, repairVFS } from '@componentor/fs';
+
+// Export VFS contents to real OPFS files (clears existing OPFS files first)
+const { files, directories } = await unpackToOPFS('/my-app');
+
+// Rebuild VFS from real OPFS files (deletes .vfs.bin, creates fresh VFS)
+const { files, directories } = await loadFromOPFS('/my-app');
+
+// Attempt to recover files from a corrupt VFS binary
+const { recovered, lost, entries } = await repairVFS('/my-app');
+console.log(`Recovered ${recovered} entries, lost ${lost}`);
+for (const entry of entries) {
+  console.log(`  ${entry.type} ${entry.path} (${entry.size} bytes)`);
+}
+```
+
+| Function | Description |
+|----------|-------------|
+| `unpackToOPFS(root?)` | Read all files from VFS, write to real OPFS paths |
+| `loadFromOPFS(root?)` | Read all OPFS files, create fresh VFS with their contents |
+| `repairVFS(root?)` | Scan corrupt `.vfs.bin` for recoverable inodes, rebuild fresh VFS |
+
 ## isomorphic-git Integration
 
 ```typescript
@@ -419,8 +447,8 @@ await git.commit({
 │  ┌────────────────────────────────────────────────────────────┐  │
 │  │                     VFS Engine                             │  │
 │  │  ┌──────────────────┐  ┌─────────────┐  ┌──────────────┐   │  │
-│  │  │  VFS Binary File  │  │  Inode/Path │  │  Block Data │   │  │
-│  │  │  (.vfs.bin OPFS)  │  │    Table    │  │   Region    │   │  │
+│  │  │  VFS Binary File │  │  Inode/Path │  │  Block Data  │   │  │
+│  │  │  (.vfs.bin OPFS) │  │    Table    │  │   Region     │   │  │
 │  │  └──────────────────┘  └─────────────┘  └──────────────┘   │  │
 │  └────────────────────────────────────────────────────────────┘  │
 │                            │                                     │
@@ -481,6 +509,26 @@ Make sure `opfsSync` is enabled (it's `true` by default). Files are mirrored to
 
 ## Changelog
 
+### v3.0.5 (2026)
+
+**Fixes:**
+- Scope the internal service worker by default so it won't collide with the host application's own service worker
+- Remove unnecessary `clients.claim()` from the service worker — it only acts as a MessagePort broker and never needs to control pages
+- Namespace leader lock, BroadcastChannel, and SW scope by `root` so multiple `VFSFileSystem` instances with different roots don't collide
+- Add `swScope` config option for custom service worker scope override
+
+### v3.0.4 (2026)
+
+**Features:**
+- Add `unpackToOPFS(root?)` — export all VFS contents to real OPFS files
+- Add `loadFromOPFS(root?)` — rebuild VFS from real OPFS files (deletes and recreates `.vfs.bin`)
+- Add `repairVFS(root?)` — scan corrupt VFS binary for recoverable inodes and rebuild a clean VFS
+- Add `VFSEngine.exportAll()` for extracting all files/dirs/symlinks with their data
+
+**Bug Fixes:**
+- VFS corruption detection on init — validates magic, version, block size, inode count, section offsets, file size, and root directory existence
+- Release sync access handle on init failure (previously leaked, blocking re-acquisition)
+
 ### v3.0.3 (2026)
 
 **Features:**
@@ -548,7 +596,7 @@ git clone https://github.com/componentor/fs
 cd fs
 npm install
 npm run build       # Build the library
-npm test            # Run unit tests (84 tests)
+npm test            # Run unit tests (97 tests)
 npm run benchmark:open  # Run benchmarks in browser
 ```