@zenfs/core 0.0.12 → 0.1.0

package/dist/index.js

@@ -1,15 +1,6 @@
 /**
  * ZenFS's main module. This is exposed in the browser via the ZenFS global.
  */
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 import fs from './emulation/fs.js';
 import { FileSystem } from './filesystem.js';
 import { backends } from './backends/index.js';
@@ -23,28 +14,25 @@ export function initialize(mounts, uid = 0, gid = 0) {
     setCred(new Cred(uid, gid, uid, gid, uid, gid));
     return fs.initialize(mounts);
 }
-function _configure(config) {
-    return __awaiter(this, void 0, void 0, function* () {
-        if ('fs' in config || config instanceof FileSystem) {
-            // single FS
-            config = { '/': config };
+async function _configure(config) {
+    if ('fs' in config || config instanceof FileSystem) {
+        // single FS
+        config = { '/': config };
+    }
+    for (let [point, value] of Object.entries(config)) {
+        if (typeof value == 'number') {
+            //should never happen
+            continue;
+        }
+        if (value instanceof FileSystem) {
+            continue;
         }
-        for (let [point, value] of Object.entries(config)) {
-            if (typeof value == 'number') {
-                //should never happen
-                continue;
-            }
-            point = point.toString(); // so linting stops complaining that point should be declared with const, which can't be done since value is assigned to
-            if (value instanceof FileSystem) {
-                continue;
-            }
-            if (typeof value == 'string') {
-                value = { fs: value };
-            }
-            config[point] = yield getFileSystem(value);
+        if (typeof value == 'string') {
+            value = { fs: value };
         }
-        return initialize(config);
-    });
+        config[point] = await getFileSystem(value);
+    }
+    return initialize(config);
 }
 export function configure(config, cb) {
     // Promise version
@@ -57,31 +45,29 @@ export function configure(config, cb) {
         .catch(err => cb(err));
     return;
 }
-function _getFileSystem({ fs: fsName, options = {} }) {
-    return __awaiter(this, void 0, void 0, function* () {
-        if (!fsName) {
-            throw new ApiError(ErrorCode.EPERM, 'Missing "fs" property on configuration object.');
-        }
-        if (typeof options !== 'object' || options === null) {
-            throw new ApiError(ErrorCode.EINVAL, 'Invalid "options" property on configuration object.');
-        }
-        const props = Object.keys(options).filter(k => k != 'fs');
-        for (const prop of props) {
-            const opt = options[prop];
-            if (opt === null || typeof opt !== 'object' || !('fs' in opt)) {
-                continue;
-            }
-            const fs = yield _getFileSystem(opt);
-            options[prop] = fs;
-        }
-        const fsc = backends[fsName];
-        if (!fsc) {
-            throw new ApiError(ErrorCode.EPERM, `File system ${fsName} is not available in ZenFS.`);
-        }
-        else {
-            return fsc.Create(options);
+async function _getFileSystem({ fs: fsName, options = {} }) {
+    if (!fsName) {
+        throw new ApiError(ErrorCode.EPERM, 'Missing "fs" property on configuration object.');
+    }
+    if (typeof options !== 'object' || options === null) {
+        throw new ApiError(ErrorCode.EINVAL, 'Invalid "options" property on configuration object.');
+    }
+    const props = Object.keys(options).filter(k => k != 'fs');
+    for (const prop of props) {
+        const opt = options[prop];
+        if (opt === null || typeof opt !== 'object' || !('fs' in opt)) {
+            continue;
         }
-    });
+        const fs = await _getFileSystem(opt);
+        options[prop] = fs;
+    }
+    const fsc = backends[fsName];
+    if (!fsc) {
+        throw new ApiError(ErrorCode.EPERM, `File system ${fsName} is not available in ZenFS.`);
+    }
+    else {
+        return fsc.Create(options);
+    }
 }
 export function getFileSystem(config, cb) {
     // Promise version

package/dist/stats.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" resolution-mode="require"/>
-import type { StatsBase } from 'fs';
+import type * as Node from 'fs';
 import { Cred } from './cred.js';
 /**
  * Indicates the type of the given file. Applied to 'mode'.
@@ -10,33 +10,53 @@ export declare enum FileType {
     SYMLINK
 }
 /**
- * Implementation of Node's `Stats`.
- *
- * Attribute descriptions are from `man 2 stat'
- * @see http://nodejs.org/api/fs.html#fs_class_fs_stats
- * @see http://man7.org/linux/man-pages/man2/stat.2.html
+ * Common code used by both Stats and BigIntStats
  */
-export declare class Stats implements StatsBase<number> {
-    static Deserialize(data: ArrayBufferLike | ArrayBufferView): Stats;
+export declare abstract class StatsCommon<T extends number | bigint> implements Node.StatsBase<T> {
+    static Deserialize(data: ArrayBufferLike | ArrayBufferView): StatsCommon<number> | StatsCommon<bigint>;
+    protected abstract _isBigint: boolean;
+    protected get _typename(): string;
+    protected get _typename_inverse(): string;
+    protected _convert(arg: number | bigint | string | boolean): T;
+    blocks: T;
+    mode: T;
     /**
-     * Clones the stats object.
+     * ID of device containing file
+     */
+    dev: T;
+    /**
+     * inode number
+     */
+    ino: T;
+    /**
+     * device ID (if special file)
+     */
+    rdev: T;
+    /**
+     * number of hard links
+     */
+    nlink: T;
+    /**
+     * blocksize for file system I/O
+     */
+    blksize: T;
+    /**
+     * user ID of owner
+     */
+    uid: T;
+    /**
+     * group ID of owner
+     */
+    gid: T;
+    /**
+     * Some file systems stash data on stats objects.
      */
-    static clone(s: Stats): Stats;
-    blocks: number;
-    mode: number;
-    dev: number;
-    ino: number;
-    rdev: number;
-    nlink: number;
-    blksize: number;
-    uid: number;
-    gid: number;
     fileData: Uint8Array | null;
-    atimeMs: number;
-    mtimeMs: number;
-    ctimeMs: number;
-    birthtimeMs: number;
-    size: number;
+    atimeMs: T;
+    mtimeMs: T;
+    ctimeMs: T;
+    birthtimeMs: T;
+    size: T;
     get atime(): Date;
     get mtime(): Date;
     get ctime(): Date;
@@ -54,8 +74,8 @@ export declare class Stats implements StatsBase<number> {
      * @param gid the id of the group that owns the file
      * @param birthtimeMs time of file creation, in milliseconds since epoch
      */
-    constructor(itemType: FileType, size: number, mode?: number, atimeMs?: number, mtimeMs?: number, ctimeMs?: number, uid?: number, gid?: number, birthtimeMs?: number);
-    serialize(): Uint8Array;
+    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);
+    abstract serialize(): Uint8Array;
     /**
      * @return [Boolean] True if this item is a file.
      */
@@ -89,9 +109,42 @@ export declare class Stats implements StatsBase<number> {
      * Change the owner user/group of the file.
      * This function makes sure it is a valid UID/GID (that is, a 32 unsigned int)
      */
-    chown(uid: number, gid: number): void;
+    chown(uid: number | bigint, gid: number | bigint): void;
     isSocket(): boolean;
     isBlockDevice(): boolean;
     isCharacterDevice(): boolean;
     isFIFO(): boolean;
 }
+/**
+ * Implementation of Node's `Stats`.
+ *
+ * Attribute descriptions are from `man 2 stat'
+ * @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 {
+    protected _isBigint: boolean;
+    /**
+     * Clones the stats object.
+     */
+    static clone(s: Stats): Stats;
+    static Deserialize(data: ArrayBufferLike | ArrayBufferView): Stats;
+    serialize(): Uint8Array;
+}
+/**
+ * Stats with bigint
+ * @todo Implement with bigint instead of wrapping Stats
+ */
+export declare class BigIntStats extends StatsCommon<bigint> implements Node.BigIntStats {
+    protected _isBigint: boolean;
+    atimeNs: bigint;
+    mtimeNs: bigint;
+    ctimeNs: bigint;
+    birthtimeNs: bigint;
+    /**
+     * Clone a stats object.
+     */
+    static clone(s: BigIntStats | Stats): BigIntStats;
+    static Deserialize(data: ArrayBufferLike | ArrayBufferView): Stats;
+    serialize(): Uint8Array;
+}

package/dist/stats.js

@@ -10,35 +10,33 @@ export var FileType;
     FileType[FileType["SYMLINK"] = S_IFLNK] = "SYMLINK";
 })(FileType = FileType || (FileType = {}));
 /**
- * Implementation of Node's `Stats`.
- *
- * Attribute descriptions are from `man 2 stat'
- * @see http://nodejs.org/api/fs.html#fs_class_fs_stats
- * @see http://man7.org/linux/man-pages/man2/stat.2.html
+ * Common code used by both Stats and BigIntStats
  */
-export class Stats {
+export class StatsCommon {
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     static Deserialize(data) {
-        const view = new DataView('buffer' in data ? data.buffer : data);
-        const size = view.getUint32(0, true), mode = view.getUint32(4, true), atime = view.getFloat64(8, true), mtime = view.getFloat64(16, true), ctime = view.getFloat64(24, true), uid = view.getUint32(32, true), gid = view.getUint32(36, true);
-        return new Stats(mode & S_IFMT, size, mode & ~S_IFMT, atime, mtime, ctime, uid, gid);
+        throw new ReferenceError('Called static abstract method: StatsCommon.Deserialize()');
     }
-    /**
-     * Clones the stats object.
-     */
-    static clone(s) {
-        return new Stats(s.mode & S_IFMT, s.size, s.mode & ~S_IFMT, s.atimeMs, s.mtimeMs, s.ctimeMs, s.uid, s.gid, s.birthtimeMs);
+    get _typename() {
+        return this._isBigint ? 'bigint' : 'number';
+    }
+    get _typename_inverse() {
+        return this._isBigint ? 'number' : 'bigint';
+    }
+    _convert(arg) {
+        return (this._isBigint ? BigInt(arg) : Number(arg));
     }
     get atime() {
-        return new Date(this.atimeMs);
+        return new Date(Number(this.atimeMs));
     }
     get mtime() {
-        return new Date(this.mtimeMs);
+        return new Date(Number(this.mtimeMs));
     }
     get ctime() {
-        return new Date(this.ctimeMs);
+        return new Date(Number(this.ctimeMs));
     }
     get birthtime() {
-        return new Date(this.birthtimeMs);
+        return new Date(Number(this.birthtimeMs));
     }
     /**
      * Provides information about a particular entry in the file system.
@@ -53,89 +51,69 @@ export class Stats {
      * @param gid the id of the group that owns the file
      * @param birthtimeMs time of file creation, in milliseconds since epoch
      */
-    constructor(itemType, size, mode, atimeMs, mtimeMs, ctimeMs, uid, gid, birthtimeMs) {
-        // ID of device containing file
-        this.dev = 0;
-        // inode number
-        this.ino = 0;
-        // device ID (if special file)
-        this.rdev = 0;
-        // number of hard links
-        this.nlink = 1;
-        // blocksize for file system I/O
-        this.blksize = 4096;
-        // user ID of owner
-        this.uid = 0;
-        // group ID of owner
-        this.gid = 0;
-        // Some file systems stash data on stats objects.
+    constructor(itemType = FileType.FILE, size = -1, mode, atimeMs, mtimeMs, ctimeMs, uid, gid, birthtimeMs) {
+        /**
+         * ID of device containing file
+         */
+        this.dev = this._convert(0);
+        /**
+         * inode number
+         */
+        this.ino = this._convert(0);
+        /**
+         * device ID (if special file)
+         */
+        this.rdev = this._convert(0);
+        /**
+         * number of hard links
+         */
+        this.nlink = this._convert(1);
+        /**
+         * blocksize for file system I/O
+         */
+        this.blksize = this._convert(4096);
+        /**
+         * user ID of owner
+         */
+        this.uid = this._convert(0);
+        /**
+         * group ID of owner
+         */
+        this.gid = this._convert(0);
+        /**
+         * Some file systems stash data on stats objects.
+         */
         this.fileData = null;
-        this.size = size;
-        let currentTime = 0;
-        if (typeof atimeMs !== 'number') {
-            currentTime = Date.now();
-            atimeMs = currentTime;
-        }
-        if (typeof mtimeMs !== 'number') {
-            if (!currentTime) {
-                currentTime = Date.now();
-            }
-            mtimeMs = currentTime;
-        }
-        if (typeof ctimeMs !== 'number') {
-            if (!currentTime) {
-                currentTime = Date.now();
-            }
-            ctimeMs = currentTime;
-        }
-        if (typeof birthtimeMs !== 'number') {
-            if (!currentTime) {
-                currentTime = Date.now();
-            }
-            birthtimeMs = currentTime;
-        }
-        if (typeof uid !== 'number') {
-            uid = 0;
+        const currentTime = Date.now();
+        const resolveT = (v, def) => (typeof v == this._typename ? v : this._convert(typeof v == this._typename_inverse ? v : def));
+        this.atimeMs = resolveT(atimeMs, currentTime);
+        this.mtimeMs = resolveT(mtimeMs, currentTime);
+        this.ctimeMs = resolveT(ctimeMs, currentTime);
+        this.birthtimeMs = resolveT(birthtimeMs, currentTime);
+        this.uid = resolveT(uid, 0);
+        this.gid = resolveT(gid, 0);
+        this.size = this._convert(size);
+        if (mode) {
+            this.mode = this._convert(mode);
         }
-        if (typeof gid !== 'number') {
-            gid = 0;
-        }
-        this.atimeMs = atimeMs;
-        this.ctimeMs = ctimeMs;
-        this.mtimeMs = mtimeMs;
-        this.birthtimeMs = birthtimeMs;
-        if (!mode) {
+        else {
             switch (itemType) {
                 case FileType.FILE:
-                    this.mode = 0o644;
+                    this.mode = this._convert(0o644);
                     break;
                 case FileType.DIRECTORY:
                 default:
-                    this.mode = 0o777;
+                    this.mode = this._convert(0o777);
             }
         }
-        else {
-            this.mode = mode;
-        }
         // number of 512B blocks allocated
-        this.blocks = Math.ceil(size / 512);
+        this.blocks = this._convert(Math.ceil(Number(size) / 512));
         // Check if mode also includes top-most bits, which indicate the file's
         // type.
         if ((this.mode & S_IFMT) == 0) {
-            this.mode |= itemType;
+            this.mode = (this.mode | this._convert(itemType));
         }
     }
-    serialize() {
-        const data = new Uint8Array(32), view = new DataView(data.buffer);
-        view.setUint32(0, this.size, true);
-        view.setUint32(4, this.mode, true);
-        view.setFloat64(8, this.atime.getTime(), true);
-        view.setFloat64(16, this.mtime.getTime(), true);
-        view.setFloat64(24, this.ctime.getTime(), true);
-        view.setUint32(32, this.uid, true);
-        view.setUint32(36, this.gid, true);
-        return data;
-    }
     /**
      * @return [Boolean] True if this item is a file.
      */
@@ -188,26 +166,28 @@ export class Stats {
     /**
      * Convert the current stats object into a cred object
      */
-    getCred(uid = this.uid, gid = this.gid) {
-        return new Cred(uid, gid, this.uid, this.gid, uid, gid);
+    getCred(uid = Number(this.uid), gid = Number(this.gid)) {
+        return new Cred(uid, gid, Number(this.uid), Number(this.gid), uid, gid);
     }
     /**
      * Change the mode of the file. We use this helper function to prevent messing
      * up the type of the file, which is encoded in mode.
      */
     chmod(mode) {
-        this.mode = (this.mode & S_IFMT) | mode;
+        this.mode = this._convert((this.mode & S_IFMT) | mode);
     }
     /**
      * Change the owner user/group of the file.
      * This function makes sure it is a valid UID/GID (that is, a 32 unsigned int)
      */
     chown(uid, gid) {
-        if (!isNaN(+uid) && 0 <= +uid && +uid < Math.pow(2, 32)) {
-            this.uid = uid;
+        uid = Number(uid);
+        gid = Number(gid);
+        if (!isNaN(uid) && 0 <= uid && uid < 2 ** 32) {
+            this.uid = this._convert(uid);
         }
-        if (!isNaN(+gid) && 0 <= +gid && +gid < Math.pow(2, 32)) {
-            this.gid = gid;
+        if (!isNaN(gid) && 0 <= gid && gid < 2 ** 32) {
+            this.gid = this._convert(gid);
         }
     }
     // We don't support the following types of files.
@@ -224,3 +204,72 @@ export class Stats {
         return false;
     }
 }
+/**
+ * Implementation of Node's `Stats`.
+ *
+ * Attribute descriptions are from `man 2 stat'
+ * @see http://nodejs.org/api/fs.html#fs_class_fs_stats
+ * @see http://man7.org/linux/man-pages/man2/stat.2.html
+ */
+export class Stats extends StatsCommon {
+    constructor() {
+        super(...arguments);
+        this._isBigint = false;
+    }
+    /**
+     * Clones the stats object.
+     */
+    static clone(s) {
+        return new Stats(s.mode & S_IFMT, s.size, s.mode & ~S_IFMT, s.atimeMs, s.mtimeMs, s.ctimeMs, s.uid, s.gid, s.birthtimeMs);
+    }
+    static Deserialize(data) {
+        const view = new DataView('buffer' in data ? data.buffer : data);
+        const size = view.getUint32(0, true), mode = view.getUint32(4, true), atime = view.getFloat64(8, true), mtime = view.getFloat64(16, true), ctime = view.getFloat64(24, true), uid = view.getUint32(32, true), gid = view.getUint32(36, true);
+        return new Stats(mode & S_IFMT, size, mode & ~S_IFMT, atime, mtime, ctime, uid, gid);
+    }
+    serialize() {
+        const data = new Uint8Array(32), view = new DataView(data.buffer);
+        view.setUint32(0, this.size, true);
+        view.setUint32(4, this.mode, true);
+        view.setFloat64(8, this.atime.getTime(), true);
+        view.setFloat64(16, this.mtime.getTime(), true);
+        view.setFloat64(24, this.ctime.getTime(), true);
+        view.setUint32(32, this.uid, true);
+        view.setUint32(36, this.gid, true);
+        return data;
+    }
+}
+Stats;
+/**
+ * Stats with bigint
+ * @todo Implement with bigint instead of wrapping Stats
+ */
+export class BigIntStats extends StatsCommon {
+    constructor() {
+        super(...arguments);
+        this._isBigint = true;
+    }
+    /**
+     * Clone a stats object.
+     */
+    static clone(s) {
+        return new BigIntStats(Number(s.mode) & S_IFMT, BigInt(s.size), BigInt(s.mode) & BigInt(~S_IFMT), BigInt(s.atimeMs), BigInt(s.mtimeMs), BigInt(s.ctimeMs), BigInt(s.uid), BigInt(s.gid), BigInt(s.birthtimeMs));
+    }
+    static Deserialize(data) {
+        const view = new DataView('buffer' in data ? data.buffer : data);
+        const size = view.getBigUint64(0, true), mode = view.getBigUint64(4, true), atime = view.getFloat64(8, true), mtime = view.getFloat64(16, true), ctime = view.getFloat64(24, true), uid = view.getBigUint64(32, true), gid = view.getBigUint64(36, true);
+        return new Stats(Number(mode) & S_IFMT, size, mode & BigInt(~S_IFMT), atime, mtime, ctime, uid, gid);
+    }
+    serialize() {
+        const data = new Uint8Array(32), view = new DataView(data.buffer);
+        view.setBigUint64(0, this.size, true);
+        view.setBigUint64(4, this.mode, true);
+        view.setFloat64(8, this.atime.getTime(), true);
+        view.setFloat64(16, this.mtime.getTime(), true);
+        view.setFloat64(24, this.ctime.getTime(), true);
+        view.setBigUint64(32, this.uid, true);
+        view.setBigUint64(36, this.gid, true);
+        return data;
+    }
+}
+BigIntStats;

package/dist/utils.d.ts

@@ -5,7 +5,6 @@
 import { FileSystem } from './filesystem.js';
 import { Cred } from './cred.js';
 import type { BaseBackendConstructor } from './backends/backend.js';
-import type { TextEncoder as TextEncoderType, TextDecoder as TextDecoderType } from 'node:util';
 /**
  * Synchronous recursive makedir.
  * @internal
@@ -31,13 +30,10 @@ export declare const setImmediate: (callback: () => unknown) => void;
  * @internal
  */
 export declare const ROOT_NODE_ID: string;
-declare const textEncoder: TextEncoderType;
-export declare const encode: typeof textEncoder.encode;
-declare const textDecoder: TextDecoderType;
-export declare const decode: typeof textDecoder.decode;
+export declare function encode(input: string, encoding?: string): Uint8Array;
+export declare function decode(input?: NodeJS.ArrayBufferView | ArrayBuffer, encoding?: string): string;
 /**
  * Generates a random ID.
  * @internal
  */
 export declare function randomUUID(): string;
-export {};