@zenfs/core 0.3.4 → 0.4.0

package/dist/file.js

@@ -2,6 +2,9 @@ import { ApiError, ErrorCode } from './ApiError.js';
 import { O_APPEND, O_CREAT, O_EXCL, O_RDONLY, O_RDWR, O_SYNC, O_TRUNC, O_WRONLY, S_IFMT } from './emulation/constants.js';
 import { size_max } from './inode.js';
 import { Stats } from './stats.js';
+/**
+ * @hidden
+ */
 export var ActionType;
 (function (ActionType) {
     // Indicates that the code should not do anything.
@@ -38,33 +41,32 @@ export class FileFlag {
      * @return The FileFlag object representing the flag
      * @throw when the flag string is invalid
      */
-    static FromString(flag) {
+    static Get(flag) {
         // Check cache first.
-        if (!FileFlag.flagCache.has(flag)) {
-            FileFlag.flagCache.set(flag, new FileFlag(flag));
+        if (!FileFlag.cache.has(flag)) {
+            FileFlag.cache.set(flag, new FileFlag(flag));
         }
-        return FileFlag.flagCache.get(flag);
+        return FileFlag.cache.get(flag);
     }
     /**
-     * This should never be called directly.
      * @param flag The string or number representing the flag
      * @throw when the flag is invalid
      */
     constructor(flag) {
-        if (typeof flag === 'number') {
-            flag = FileFlag.NumberToString(flag);
+        if (typeof flag == 'number') {
+            flag = FileFlag.StringOf(flag);
         }
-        if (FileFlag.validFlagStrs.indexOf(flag) < 0) {
+        if (!FileFlag.validStrings.includes(flag)) {
             throw new ApiError(ErrorCode.EINVAL, 'Invalid flag string: ' + flag);
         }
-        this.flagStr = flag;
+        this._flag = flag;
     }
     /**
      * @param flag The number representing the flag
-     * @return The string representing the flag
-     * @throw when the flag number is invalid
+     * @returns The string representing the flag
+     * @throws when the flag number is invalid
      */
-    static NumberToString(flag) {
+    static StringOf(flag) {
         // based on https://github.com/nodejs/node/blob/abbdc3efaa455e6c907ebef5409ac8b0f222f969/lib/internal/fs/utils.js#L619
         switch (flag) {
             case O_RDONLY:
@@ -95,11 +97,46 @@ export class FileFlag {
                 throw new ApiError(ErrorCode.EINVAL, 'Invalid flag number: ' + flag);
         }
     }
+    /**
+     * @param flag The string representing the flag
+     * @returns The number representing the flag
+     * @throws when the flag string is invalid
+     */
+    static NumberOf(flag) {
+        switch (flag) {
+            case 'r':
+                return O_RDONLY;
+            case 'rs':
+                return O_RDONLY | O_SYNC;
+            case 'r+':
+                return O_RDWR;
+            case 'rs+':
+                return O_RDWR | O_SYNC;
+            case 'w':
+                return O_TRUNC | O_CREAT | O_WRONLY;
+            case 'wx':
+                return O_TRUNC | O_CREAT | O_WRONLY | O_EXCL;
+            case 'w+':
+                return O_TRUNC | O_CREAT | O_RDWR;
+            case 'wx+':
+                return O_TRUNC | O_CREAT | O_RDWR | O_EXCL;
+            case 'a':
+                return O_APPEND | O_CREAT | O_WRONLY;
+            case 'ax':
+                return O_APPEND | O_CREAT | O_WRONLY | O_EXCL;
+            case 'a+':
+                return O_APPEND | O_CREAT | O_RDWR;
+            case 'ax+':
+                return O_APPEND | O_CREAT | O_RDWR | O_EXCL;
+            default:
+                throw new ApiError(ErrorCode.EINVAL, 'Invalid flag string: ' + flag);
+        }
+    }
     /**
      * Get the underlying flag string for this flag.
      */
     toString() {
-        return this.flagStr;
+        return this._flag;
     }
     /**
      * Get the equivalent mode (0b0xxx: read, write, execute)
@@ -118,37 +155,37 @@ export class FileFlag {
      * Returns true if the file is readable.
      */
     isReadable() {
-        return this.flagStr.indexOf('r') !== -1 || this.flagStr.indexOf('+') !== -1;
+        return this._flag.indexOf('r') != -1 || this._flag.indexOf('+') != -1;
     }
     /**
      * Returns true if the file is writeable.
      */
     isWriteable() {
-        return this.flagStr.indexOf('w') !== -1 || this.flagStr.indexOf('a') !== -1 || this.flagStr.indexOf('+') !== -1;
+        return this._flag.indexOf('w') != -1 || this._flag.indexOf('a') != -1 || this._flag.indexOf('+') != -1;
     }
     /**
      * Returns true if the file mode should truncate.
      */
     isTruncating() {
-        return this.flagStr.indexOf('w') !== -1;
+        return this._flag.indexOf('w') !== -1;
     }
     /**
      * Returns true if the file is appendable.
      */
     isAppendable() {
-        return this.flagStr.indexOf('a') !== -1;
+        return this._flag.indexOf('a') !== -1;
     }
     /**
      * Returns true if the file is open in synchronous mode.
      */
     isSynchronous() {
-        return this.flagStr.indexOf('s') !== -1;
+        return this._flag.indexOf('s') !== -1;
     }
     /**
      * Returns true if the file is open in exclusive mode.
      */
     isExclusive() {
-        return this.flagStr.indexOf('x') !== -1;
+        return this._flag.indexOf('x') !== -1;
     }
     /**
      * Returns one of the static fields on this object that indicates the
@@ -168,18 +205,20 @@ export class FileFlag {
      * appropriate response to the path not existing.
      */
     pathNotExistsAction() {
-        if ((this.isWriteable() || this.isAppendable()) && this.flagStr !== 'r+') {
+        if ((this.isWriteable() || this.isAppendable()) && this._flag != 'r+') {
             return ActionType.CREATE;
         }
-        else {
-            return ActionType.THROW;
-        }
+        return ActionType.THROW;
     }
 }
-// Contains cached FileMode instances.
-FileFlag.flagCache = new Map();
-// Array of valid mode strings.
-FileFlag.validFlagStrs = ['r', 'r+', 'rs', 'rs+', 'w', 'wx', 'w+', 'wx+', 'a', 'ax', 'a+', 'ax+'];
+/**
+ * Contains cached FileMode instances.
+ */
+FileFlag.cache = new Map();
+/**
+ * Array of valid mode strings.
+ */
+FileFlag.validStrings = ['r', 'r+', 'rs', 'rs+', 'w', 'wx', 'w+', 'wx+', 'a', 'ax', 'a+', 'ax+'];
 export class File {
     /**
      * Asynchronous `datasync`.
@@ -282,13 +321,13 @@ export class PreloadFile extends File {
      * Asynchronous `stat`.
      */
     async stat() {
-        return Stats.clone(this.stats);
+        return new Stats(this.stats);
     }
     /**
      * Synchronous `stat`.
      */
     statSync() {
-        return Stats.clone(this.stats);
+        return new Stats(this.stats);
     }
     /**
      * Asynchronous truncate.

package/dist/filesystem.d.ts

@@ -1,7 +1,7 @@
 import { ApiError } from './ApiError.js';
-import { Stats } from './stats.js';
-import { File, FileFlag } from './file.js';
-import { Cred } from './cred.js';
+import type { Stats } from './stats.js';
+import type { File, FileFlag } from './file.js';
+import type { Cred } from './cred.js';
 export type NoArgCallback = (e?: ApiError) => unknown;
 export type TwoArgCallback<T> = (e?: ApiError, rv?: T) => unknown;
 export type ThreeArgCallback<T, U> = (e?: ApiError, arg1?: T, arg2?: U) => unknown;

package/dist/index.d.ts

@@ -3,7 +3,6 @@
  */
 import * as fs from './emulation/index.js';
 import { FileSystem } from './filesystem.js';
-import { backends } from './backends/index.js';
 import { type Backend, type BackendConfig } from './backends/backend.js';
 /**
  * Initializes ZenFS with the given file systems.
@@ -15,7 +14,7 @@ export declare function initialize(mounts: {
  * Defines a mapping of mount points to their configurations
  */
 export interface ConfigMapping {
-    [mountPoint: string]: FileSystem | BackendConfig | keyof typeof backends | Backend;
+    [mountPoint: string]: FileSystem | BackendConfig | Backend;
 }
 /**
  * A configuration for ZenFS
@@ -26,8 +25,12 @@ export type Configuration = FileSystem | BackendConfig | ConfigMapping;
  * See the Configuration type for more info on the configuration object.
  */
 export declare function configure(config: Configuration): Promise<void>;
-export * from './backends/index.js';
+export type { Backend, BackendConfig } from './backends/backend.js';
+export * from './backends/AsyncMirror.js';
 export * from './backends/AsyncStore.js';
+export * from './backends/InMemory.js';
+export * from './backends/Locked.js';
+export * from './backends/Overlay.js';
 export * from './backends/SyncStore.js';
 export * from './ApiError.js';
 export * from './cred.js';

package/dist/index.js

@@ -3,7 +3,6 @@
  */
 import * as fs from './emulation/index.js';
 import { FileSystem } from './filesystem.js';
-import { backends } from './backends/index.js';
 import { Cred } from './cred.js';
 import { isBackend, resolveBackendConfig } from './backends/backend.js';
 import { setCred } from './emulation/shared.js';
@@ -31,9 +30,6 @@ export async function configure(config) {
         if (value instanceof FileSystem) {
             continue;
         }
-        if (typeof value == 'string') {
-            value = { backend: backends[value] };
-        }
         if (isBackend(value)) {
             value = { backend: value };
         }
@@ -41,8 +37,11 @@ export async function configure(config) {
     }
     initialize(config);
 }
-export * from './backends/index.js';
+export * from './backends/AsyncMirror.js';
 export * from './backends/AsyncStore.js';
+export * from './backends/InMemory.js';
+export * from './backends/Locked.js';
+export * from './backends/Overlay.js';
 export * from './backends/SyncStore.js';
 export * from './ApiError.js';
 export * from './cred.js';

package/dist/inode.d.ts

@@ -1,20 +1,28 @@
-import { Stats } from './stats.js';
+import { Stats, type StatsLike } from './stats.js';
+/**
+ * Alias for an ino.
+ * This will be helpful if in the future inode numbers/IDs are changed to strings or numbers.
+ */
 export type Ino = bigint;
+/**
+ * Max 32-bit integer
+ * @hidden
+ */
 export declare const size_max: number;
 /**
- * @internal
+ * Room inode
+ * @hidden
  */
 export declare const rootIno: Ino;
 /**
- * Generate 4 random bits at a time
- *
+ * Generate a random ino
  * @internal
  */
 export declare function randomIno(): Ino;
 /**
  * Generic inode definition that can easily be serialized.
  */
-export declare class Inode {
+export declare class Inode implements StatsLike {
     readonly buffer: ArrayBufferLike;
     get data(): Uint8Array;
     protected view: DataView;
@@ -31,20 +39,18 @@ export declare class Inode {
     set uid(value: number);
     get gid(): number;
     set gid(value: number);
-    get atime(): number;
-    set atime(value: number);
-    get mtime(): number;
-    set mtime(value: number);
-    get ctime(): number;
-    set ctime(value: number);
+    get atimeMs(): number;
+    set atimeMs(value: number);
+    get birthtimeMs(): number;
+    set birthtimeMs(value: number);
+    get mtimeMs(): number;
+    set mtimeMs(value: number);
+    get ctimeMs(): number;
+    set ctimeMs(value: number);
     /**
      * Handy function that converts the Inode to a Node Stats object.
      */
     toStats(): Stats;
-    /**
-     * Get the size of this Inode, in bytes.
-     */
-    sizeof(): number;
     /**
      * Updates the Inode using information from the stats object. Used by file
      * systems at sync time, e.g.:

package/dist/inode.js

@@ -1,20 +1,12 @@
-import { S_IFMT } from './emulation/constants.js';
-import { Stats, FileType } from './stats.js';
-var Offset;
-(function (Offset) {
-    Offset[Offset["ino"] = 0] = "ino";
-    Offset[Offset["size"] = 8] = "size";
-    Offset[Offset["mode"] = 12] = "mode";
-    Offset[Offset["nlink"] = 14] = "nlink";
-    Offset[Offset["uid"] = 18] = "uid";
-    Offset[Offset["gid"] = 22] = "gid";
-    Offset[Offset["atime"] = 26] = "atime";
-    Offset[Offset["mtime"] = 34] = "mtime";
-    Offset[Offset["ctime"] = 42] = "ctime";
-})(Offset || (Offset = {}));
+import { Stats } from './stats.js';
+/**
+ * Max 32-bit integer
+ * @hidden
+ */
 export const size_max = 2 ** 32 - 1;
 /**
- * @internal
+ * Room inode
+ * @hidden
  */
 export const rootIno = 0n;
 /**
@@ -24,13 +16,29 @@ function _random() {
     return Math.round(Math.random() * 2 ** 32).toString(16);
 }
 /**
- * Generate 4 random bits at a time
- *
+ * Generate a random ino
  * @internal
  */
 export function randomIno() {
     return BigInt('0x' + _random() + _random());
 }
+/**
+ * Offsets for inode members
+ */
+var Offset;
+(function (Offset) {
+    Offset[Offset["ino"] = 0] = "ino";
+    Offset[Offset["size"] = 8] = "size";
+    Offset[Offset["mode"] = 12] = "mode";
+    Offset[Offset["nlink"] = 14] = "nlink";
+    Offset[Offset["uid"] = 18] = "uid";
+    Offset[Offset["gid"] = 22] = "gid";
+    Offset[Offset["atime"] = 26] = "atime";
+    Offset[Offset["birthtime"] = 34] = "birthtime";
+    Offset[Offset["mtime"] = 42] = "mtime";
+    Offset[Offset["ctime"] = 50] = "ctime";
+    Offset[Offset["end"] = 58] = "end";
+})(Offset || (Offset = {}));
 /**
  * Generic inode definition that can easily be serialized.
  */
@@ -40,7 +48,10 @@ export class Inode {
     }
     constructor(buffer) {
         const setDefaults = !buffer;
-        buffer ?? (buffer = new ArrayBuffer(50));
+        buffer ?? (buffer = new ArrayBuffer(Offset.end));
+        if (buffer?.byteLength < Offset.end) {
+            throw new RangeError(`Can not create an inode from a buffer less than ${Offset.end} bytes`);
+        }
         this.view = new DataView(buffer);
         this.buffer = buffer;
         if (!setDefaults) {
@@ -51,9 +62,10 @@ export class Inode {
         this.nlink = 1;
         this.size = 4096;
         const now = Date.now();
-        this.atime = now;
-        this.mtime = now;
-        this.ctime = now;
+        this.atimeMs = now;
+        this.mtimeMs = now;
+        this.ctimeMs = now;
+        this.birthtimeMs = now;
     }
     get ino() {
         return this.view.getBigUint64(Offset.ino, true);
@@ -91,35 +103,35 @@ export class Inode {
     set gid(value) {
         this.view.setUint32(Offset.gid, value, true);
     }
-    get atime() {
+    get atimeMs() {
         return this.view.getFloat64(Offset.atime, true);
     }
-    set atime(value) {
+    set atimeMs(value) {
         this.view.setFloat64(Offset.atime, value, true);
     }
-    get mtime() {
+    get birthtimeMs() {
+        return this.view.getFloat64(Offset.birthtime, true);
+    }
+    set birthtimeMs(value) {
+        this.view.setFloat64(Offset.birthtime, value, true);
+    }
+    get mtimeMs() {
         return this.view.getFloat64(Offset.mtime, true);
     }
-    set mtime(value) {
+    set mtimeMs(value) {
         this.view.setFloat64(Offset.mtime, value, true);
     }
-    get ctime() {
+    get ctimeMs() {
         return this.view.getFloat64(Offset.ctime, true);
     }
-    set ctime(value) {
+    set ctimeMs(value) {
         this.view.setFloat64(Offset.ctime, value, true);
     }
     /**
      * Handy function that converts the Inode to a Node Stats object.
      */
     toStats() {
-        return new Stats((this.mode & S_IFMT) === FileType.DIRECTORY ? FileType.DIRECTORY : FileType.FILE, this.size, this.mode, this.atime, this.mtime, this.ctime, this.uid, this.gid);
-    }
-    /**
-     * Get the size of this Inode, in bytes.
-     */
-    sizeof() {
-        return this.buffer.byteLength;
+        return new Stats(this);
     }
     /**
      * Updates the Inode using information from the stats object. Used by file
@@ -153,16 +165,16 @@ export class Inode {
             this.uid = stats.uid;
             hasChanged = true;
         }
-        if (this.atime !== stats.atimeMs) {
-            this.atime = stats.atimeMs;
+        if (this.atimeMs !== stats.atimeMs) {
+            this.atimeMs = stats.atimeMs;
             hasChanged = true;
         }
-        if (this.mtime !== stats.mtimeMs) {
-            this.mtime = stats.mtimeMs;
+        if (this.mtimeMs !== stats.mtimeMs) {
+            this.mtimeMs = stats.mtimeMs;
             hasChanged = true;
         }
-        if (this.ctime !== stats.ctimeMs) {
-            this.ctime = stats.ctimeMs;
+        if (this.ctimeMs !== stats.ctimeMs) {
+            this.ctimeMs = stats.ctimeMs;
             hasChanged = true;
         }
         return hasChanged;

package/dist/mutex.d.ts

@@ -1,9 +1,8 @@
-export type MutexCallback = () => void;
 /**
  * Non-recursive mutex
  * @internal
  */
-export default class Mutex {
+export declare class Mutex {
     private _locks;
     lock(path: string): Promise<void>;
     unlock(path: string): void;

package/dist/mutex.js

@@ -2,7 +2,7 @@
  * Non-recursive mutex
  * @internal
  */
-export default class Mutex {
+export class Mutex {
     constructor() {
         this._locks = new Map();
     }

package/dist/stats.d.ts

@@ -10,14 +10,58 @@ export declare enum FileType {
     SYMLINK
 }
 /**
- * Common code used by both Stats and BigIntStats
+ *
+ */
+export interface StatsLike {
+    /**
+     * Size of the item in bytes.
+     * For directories/symlinks, this is normally the size of the struct that represents the item.
+     */
+    size: number | bigint;
+    /**
+     * Unix-style file mode (e.g. 0o644) that includes the item type
+     * Type of the item can be FILE, DIRECTORY, SYMLINK, or SOCKET
+     */
+    mode: number | bigint;
+    /**
+     * time of last access, in milliseconds since epoch
+     */
+    atimeMs: number | bigint;
+    /**
+     * time of last modification, in milliseconds since epoch
+     */
+    mtimeMs: number | bigint;
+    /**
+     * time of last time file status was changed, in milliseconds since epoch
+     */
+    ctimeMs: number | bigint;
+    /**
+     * time of file creation, in milliseconds since epoch
+     */
+    birthtimeMs: number | bigint;
+    /**
+     * the id of the user that owns the file
+     */
+    uid: number | bigint;
+    /**
+     * the id of the group that owns the file
+     */
+    gid: number | bigint;
+}
+/**
+ * Provides information about a particular entry in the file system.
+ * Common code used by both Stats and BigIntStats.
  */
-export declare abstract class StatsCommon<T extends number | bigint> implements Node.StatsBase<T> {
+export declare abstract class StatsCommon<T extends number | bigint> implements Node.StatsBase<T>, StatsLike {
     protected abstract _isBigint: boolean;
     protected get _typename(): string;
     protected get _typename_inverse(): string;
     protected _convert(arg: number | bigint | string | boolean): T;
     blocks: T;
+    /**
+     * Unix-style file mode (e.g. 0o644) that includes the type of the item.
+     * Type of the item can be FILE, DIRECTORY, SYMLINK, or SOCKET
+     */
     mode: T;
     /**
      * ID of device containing file
@@ -51,33 +95,39 @@ export declare abstract class StatsCommon<T extends number | bigint> implements
      * Some file systems stash data on stats objects.
      */
     fileData?: Uint8Array;
+    /**
+     * time of last access, in milliseconds since epoch
+     */
     atimeMs: T;
     get atime(): Date;
     set atime(value: Date);
+    /**
+     * time of last modification, in milliseconds since epoch
+     */
     mtimeMs: T;
     get mtime(): Date;
     set mtime(value: Date);
+    /**
+     * time of last time file status was changed, in milliseconds since epoch
+     */
     ctimeMs: T;
     get ctime(): Date;
     set ctime(value: Date);
+    /**
+     * time of file creation, in milliseconds since epoch
+     */
     birthtimeMs: T;
     get birthtime(): Date;
     set birthtime(value: Date);
+    /**
+     * Size of the item in bytes.
+     * For directories/symlinks, this is normally the size of the struct that represents the item.
+     */
     size: T;
     /**
-     * Provides information about a particular entry in the file system.
-     * @param itemType Type of the item (FILE, DIRECTORY, SYMLINK, or SOCKET)
-     * @param size Size of the item in bytes. For directories/symlinks,
-     *   this is normally the size of the struct that represents the item.
-     * @param mode Unix-style file mode (e.g. 0o644)
-     * @param atimeMs time of last access, in milliseconds since epoch
-     * @param mtimeMs time of last modification, in milliseconds since epoch
-     * @param ctimeMs time of last time file status was changed, in milliseconds since epoch
-     * @param uid the id of the user that owns the file
-     * @param gid the id of the group that owns the file
-     * @param birthtimeMs time of file creation, in milliseconds since epoch
+     * Creates a new stats instance from a stats-like object. Can be used to copy stats (note)
      */
-    constructor(itemType?: FileType, size?: number | bigint, mode?: number | bigint, atimeMs?: number | bigint, mtimeMs?: number | bigint, ctimeMs?: number | bigint, uid?: number | bigint, gid?: number | bigint, birthtimeMs?: number | bigint);
+    constructor({ atimeMs, mtimeMs, ctimeMs, birthtimeMs, uid, gid, size, mode }?: Partial<StatsLike>);
     /**
      * @returns true if this item is a file.
      */
@@ -128,18 +178,19 @@ export declare abstract class StatsCommon<T extends number | bigint> implements
  * @see http://nodejs.org/api/fs.html#fs_class_fs_stats
  * @see http://man7.org/linux/man-pages/man2/stat.2.html
  */
-export declare class Stats extends StatsCommon<number> implements Node.Stats {
+export declare class Stats extends StatsCommon<number> implements Node.Stats, StatsLike {
     protected _isBigint: boolean;
     /**
      * Clones the stats object.
+     * @deprecated use `new Stats(stats)`
      */
-    static clone(s: Stats): Stats;
+    static clone(stats: Stats): Stats;
 }
 /**
  * Stats with bigint
  * @todo Implement with bigint instead of wrapping Stats
  */
-export declare class BigIntStats extends StatsCommon<bigint> implements Node.BigIntStats {
+export declare class BigIntStats extends StatsCommon<bigint> implements Node.BigIntStats, StatsLike {
     protected _isBigint: boolean;
     atimeNs: bigint;
     mtimeNs: bigint;
@@ -147,6 +198,7 @@ export declare class BigIntStats extends StatsCommon<bigint> implements Node.Big
     birthtimeNs: bigint;
     /**
      * Clone a stats object.
+     * @deprecated use `new BigIntStats(stats)`
      */
-    static clone(s: BigIntStats | Stats): BigIntStats;
+    static clone(stats: BigIntStats | Stats): BigIntStats;
 }