@zenfs/core 1.10.2 → 1.10.3

package/dist/backends/cow.d.ts

@@ -3,6 +3,7 @@ import type { CreationOptions, UsageInfo } from '../internal/filesystem.js';
 import type { InodeLike } from '../internal/inode.js';
 import type { Stats } from '../stats.js';
 import { FileSystem } from '../internal/filesystem.js';
+import { EventEmitter } from 'eventemitter3';
 /**
  * Configuration options for CoW.
  * @category Backends and Configuration
@@ -12,22 +13,13 @@ export interface CopyOnWriteOptions {
     readable: FileSystem;
     /** The file system to write modified files to. */
     writable: FileSystem;
-    /** Options for the journal */
-    journal?: JournalOptions;
+    /** @see {@link Journal} */
+    journal?: Journal;
 }
 /**
  *  @hidden @deprecated use `CopyOnWriteOptions`
  */
 export type OverlayOptions = CopyOnWriteOptions;
-/**
- * Configuration options for the journal used by CoW.
- * @category Backends and Configuration
- * @internal
- */
-export interface JournalOptions {
-    /** The contents of the journal */
-    contents?: string | JournalEntry[];
-}
 declare const journalOperations: readonly ["delete"];
 /**
  * @internal
@@ -44,15 +36,16 @@ export interface JournalEntry {
  * Tracks various operations for the CoW backend
  * @internal
  */
-export declare class Journal {
-    readonly fs: CopyOnWriteFS;
-    entries: JournalEntry[];
-    constructor(fs: CopyOnWriteFS);
+export declare class Journal extends EventEmitter<{
+    update: [op: JournalOperation, path: string];
+    delete: [path: string];
+}> {
+    protected entries: JournalEntry[];
     toString(): string;
     /**
      * Parse a journal from a string
      */
-    fromString(value: string): void;
+    fromString(value: string): this;
     add(op: JournalOperation, path: string): void;
     has(op: JournalOperation, path: string): boolean;
     isDeleted(path: string): boolean;
@@ -62,25 +55,20 @@ export declare class Journal {
  * @internal
  */
 export declare class CopyOnWriteFS extends FileSystem {
-    /**
-     * The file system that initially populates this file system.
-     */
+    /** The file system that initially populates this file system. */
     readonly readable: FileSystem;
-    /**
-     * The file system to write modified files to.
-     */
+    /** The file system to write modified files to. */
     readonly writable: FileSystem;
-    ready(): Promise<void>;
+    /** The journal to use for persisting deletions */
     readonly journal: Journal;
+    ready(): Promise<void>;
     constructor(
-    /**
-     * The file system that initially populates this file system.
-     */
+    /** The file system that initially populates this file system. */
     readable: FileSystem, 
-    /**
-     * The file system to write modified files to.
-     */
-    writable: FileSystem);
+    /** The file system to write modified files to. */
+    writable: FileSystem, 
+    /** The journal to use for persisting deletions */
+    journal?: Journal);
     isDeleted(path: string): boolean;
     /**
      * @todo Consider trying to track information on the writable as well

package/dist/backends/cow.js

@@ -56,6 +56,7 @@ import { LazyFile } from '../internal/file.js';
 import { FileSystem } from '../internal/filesystem.js';
 import { debug, err, warn } from '../internal/log.js';
 import { dirname, join } from '../vfs/path.js';
+import { EventEmitter } from 'eventemitter3';
 const journalOperations = ['delete'];
 /** Because TS doesn't work right w/o it */
 function isJournalOp(op) {
@@ -67,9 +68,9 @@ const journalMagicString = '#journal@v0\n';
  * Tracks various operations for the CoW backend
  * @internal
  */
-export class Journal {
-    constructor(fs) {
-        this.fs = fs;
+export class Journal extends EventEmitter {
+    constructor() {
+        super(...arguments);
         this.entries = [];
     }
     toString() {
@@ -91,9 +92,12 @@ export class Journal {
             }
             this.entries.push({ op, path });
         }
+        return this;
     }
     add(op, path) {
         this.entries.push({ op, path });
+        this.emit('update', op, path);
+        this.emit(op, path);
     }
     has(op, path) {
         const test = JSON.stringify({ op, path });
@@ -125,18 +129,16 @@ export class CopyOnWriteFS extends FileSystem {
         await this.writable.ready();
     }
     constructor(
-    /**
-     * The file system that initially populates this file system.
-     */
+    /** The file system that initially populates this file system. */
     readable, 
-    /**
-     * The file system to write modified files to.
-     */
-    writable) {
+    /** The file system to write modified files to. */
+    writable, 
+    /** The journal to use for persisting deletions */
+    journal = new Journal()) {
         super(0x62756c6c, readable.name);
         this.readable = readable;
         this.writable = writable;
-        this.journal = new Journal(this);
+        this.journal = journal;
         if (writable.attributes.has('no_write')) {
             throw err(new ErrnoError(Errno.EINVAL, 'Writable file system can not be written to'));
         }
@@ -477,14 +479,7 @@ const _CopyOnWrite = {
         journal: { type: 'object', required: false },
     },
     create(options) {
-        const fs = new CopyOnWriteFS(options.readable, options.writable);
-        if (typeof options.journal == 'string') {
-            fs.journal.fromString(options.journal);
-        }
-        if (Array.isArray(options.journal)) {
-            fs.journal.entries.push(...options.journal);
-        }
-        return fs;
+        return new CopyOnWriteFS(options.readable, options.writable, options.journal);
     },
 };
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@zenfs/core",
-	"version": "1.10.2",
+	"version": "1.10.3",
 	"description": "A filesystem, anywhere",
 	"funding": {
 		"type": "individual",