@zenfs/core 1.11.4 → 2.0.0

package/dist/vfs/shared.d.ts

@@ -1,22 +1,9 @@
 import type * as fs from 'node:fs';
-import type { File } from '../internal/file.js';
 import type { FileSystem } from '../internal/filesystem.js';
-import type { Stats } from '../stats.js';
-import { type BoundContext, type V_Context } from '../context.js';
+import type { V_Context } from '../context.js';
 import { ErrnoError } from '../internal/error.js';
-import { type AbsolutePath } from './path.js';
-/**
- * @internal @hidden
- */
-export declare const fdMap: Map<number, File>;
-/**
- * @internal @hidden
- */
-export declare function file2fd(file: File): number;
-/**
- * @internal @hidden
- */
-export declare function fd2file(fd: number): File;
+import type { InodeLike } from '../internal/inode.js';
+import { type AbsolutePath } from '../path.js';
 /**
  * @internal @hidden
  */
@@ -32,12 +19,12 @@ export declare const mounts: Map<string, FileSystem>;
  * @category Backends and Configuration
  * @internal
  */
-export declare function mount(mountPoint: string, fs: FileSystem): void;
+export declare function mount(this: V_Context, mountPoint: string, fs: FileSystem): void;
 /**
  * Unmounts the file system at `mountPoint`.
  * @category Backends and Configuration
  */
-export declare function umount(mountPoint: string): void;
+export declare function umount(this: V_Context, mountPoint: string): void;
 /**
  * @internal @hidden
  */
@@ -54,7 +41,7 @@ export interface ResolvedPath extends ResolvedMount {
     /** The real, absolute path */
     fullPath: string;
     /** Stats */
-    stats?: Stats;
+    stats?: InodeLike;
 }
 /**
  * Gets the internal `FileSystem` for the path, then returns it along with the path relative to the FS' root
@@ -71,18 +58,12 @@ export declare function fixPaths(text: string, paths: Record<string, string>): s
  * @internal @hidden
  */
 export declare function fixError<E extends ErrnoError>(e: E, paths: Record<string, string>): E;
-/**
- * @internal @deprecated
- */
-export declare function mountObject(mounts: MountObject): void;
 /**
  * @internal @hidden
  */
 export declare function _statfs<const T extends boolean>(fs: FileSystem, bigint?: T): T extends true ? fs.BigIntStatsFs : fs.StatsFs;
 /**
  * Change the root path
- * @param inPlace if true, this changes the root for the current context instead of creating a new one (if associated with a context).
  * @category Backends and Configuration
  */
-export declare function chroot(this: V_Context, path: string, inPlace?: false): BoundContext;
-export declare function chroot<T extends V_Context>(this: T, path: string, inPlace: true): T;
+export declare function chroot(this: V_Context, path: string): void;

package/dist/vfs/shared.js

@@ -1,34 +1,11 @@
 // Utilities and shared data
 import { InMemory } from '../backends/memory.js';
-import { bindContext } from '../context.js';
+import { defaultContext } from '../internal/contexts.js';
 import { Errno, ErrnoError } from '../internal/error.js';
-import { alert, debug, err, info, log_deprecated, notice, warn } from '../internal/log.js';
+import { alert, debug, err, info, notice, warn } from '../internal/log.js';
+import { join, resolve } from '../path.js';
 import { normalizePath } from '../utils.js';
 import { size_max } from './constants.js';
-import { join, resolve } from './path.js';
-// descriptors
-/**
- * @internal @hidden
- */
-export const fdMap = new Map();
-let nextFd = 100;
-/**
- * @internal @hidden
- */
-export function file2fd(file) {
-    const fd = nextFd++;
-    fdMap.set(fd, file);
-    return fd;
-}
-/**
- * @internal @hidden
- */
-export function fd2file(fd) {
-    if (!fdMap.has(fd)) {
-        throw new ErrnoError(Errno.EBADF);
-    }
-    return fdMap.get(fd);
-}
 /**
  * The map of mount points
  * @category Backends and Configuration
@@ -36,7 +13,7 @@ export function fd2file(fd) {
  */
 export const mounts = new Map();
 // Set a default root.
-mount('/', InMemory.create({ name: 'root' }));
+mount('/', InMemory.create({ label: 'root' }));
 /**
  * Mounts the file system at `mountPoint`.
  * @category Backends and Configuration
@@ -45,7 +22,7 @@ mount('/', InMemory.create({ name: 'root' }));
 export function mount(mountPoint, fs) {
     if (mountPoint[0] != '/')
         mountPoint = '/' + mountPoint;
-    mountPoint = resolve(mountPoint);
+    mountPoint = resolve.call(this, mountPoint);
     if (mounts.has(mountPoint))
         throw err(new ErrnoError(Errno.EINVAL, 'Mount point is already in use: ' + mountPoint));
     fs._mountPoint = mountPoint;
@@ -60,7 +37,7 @@ export function mount(mountPoint, fs) {
 export function umount(mountPoint) {
     if (mountPoint[0] != '/')
         mountPoint = '/' + mountPoint;
-    mountPoint = resolve(mountPoint);
+    mountPoint = resolve.call(this, mountPoint);
     if (!mounts.has(mountPoint)) {
         warn(mountPoint + ' is already unmounted');
         return;
@@ -73,7 +50,7 @@ export function umount(mountPoint) {
  * @internal @hidden
  */
 export function resolveMount(path, ctx) {
-    const root = (ctx === null || ctx === void 0 ? void 0 : ctx.root) || '/';
+    const root = (ctx === null || ctx === void 0 ? void 0 : ctx.root) || defaultContext.root;
     path = normalizePath(join(root, path));
     const sortedMounts = [...mounts].sort((a, b) => (a[0].length > b[0].length ? -1 : 1)); // descending order of the string length
     for (const [mountPoint, fs] of sortedMounts) {
@@ -115,20 +92,6 @@ export function fixError(e, paths) {
         e.path = fixPaths(e.path, paths);
     return e;
 }
-/* node:coverage disable */
-/**
- * @internal @deprecated
- */
-export function mountObject(mounts) {
-    log_deprecated('mountObject');
-    if ('/' in mounts) {
-        umount('/');
-    }
-    for (const [point, fs] of Object.entries(mounts)) {
-        mount(point, fs);
-    }
-}
-/* node:coverage enable */
 /**
  * @internal @hidden
  */
@@ -136,7 +99,7 @@ export function _statfs(fs, bigint) {
     const md = fs.usage();
     const bs = md.blockSize || 4096;
     return {
-        type: (bigint ? BigInt : Number)(fs.id),
+        type: (bigint ? BigInt : Number)(fs.type),
         bsize: (bigint ? BigInt : Number)(bs),
         ffree: (bigint ? BigInt : Number)(md.freeNodes || size_max),
         files: (bigint ? BigInt : Number)(md.totalNodes || size_max),
@@ -145,16 +108,25 @@ export function _statfs(fs, bigint) {
         blocks: (bigint ? BigInt : Number)(md.totalSpace / bs),
     };
 }
-export function chroot(path, inPlace) {
-    const creds = this === null || this === void 0 ? void 0 : this.credentials;
-    if ((creds === null || creds === void 0 ? void 0 : creds.uid) && (creds === null || creds === void 0 ? void 0 : creds.gid) && (creds === null || creds === void 0 ? void 0 : creds.euid) && (creds === null || creds === void 0 ? void 0 : creds.egid)) {
+/**
+ * Change the root path
+ * @category Backends and Configuration
+ */
+export function chroot(path) {
+    var _a, _b, _c, _d, _e, _f, _g;
+    const $ = this !== null && this !== void 0 ? this : defaultContext;
+    if (((_a = $.credentials) === null || _a === void 0 ? void 0 : _a.uid) !== 0 && ((_b = $.credentials) === null || _b === void 0 ? void 0 : _b.gid) !== 0 && ((_c = $.credentials) === null || _c === void 0 ? void 0 : _c.euid) !== 0 && ((_d = $.credentials) === null || _d === void 0 ? void 0 : _d.egid) !== 0)
         throw new ErrnoError(Errno.EPERM, 'Can not chroot() as non-root user');
+    (_e = $.root) !== null && _e !== void 0 ? _e : ($.root = '/');
+    const newRoot = join($.root, path);
+    for (const handle of (_g = (_f = $.descriptors) === null || _f === void 0 ? void 0 : _f.values()) !== null && _g !== void 0 ? _g : []) {
+        if (!handle.path.startsWith($.root))
+            throw ErrnoError.With('EBUSY', handle.path, 'chroot');
+        handle.path = handle.path.slice($.root.length);
     }
-    if (inPlace && this) {
-        this.root += path;
-        return this;
-    }
-    return bindContext(join((this === null || this === void 0 ? void 0 : this.root) || '/', path), creds);
+    if (newRoot.length > $.root.length)
+        throw new ErrnoError(Errno.EPERM, 'Can not chroot() outside of current root');
+    $.root = newRoot;
 }
 /**
  * @internal @hidden

package/dist/{stats.d.ts → vfs/stats.d.ts}

@@ -1,12 +1,6 @@
 import type * as Node from 'node:fs';
-import type { V_Context } from './context.js';
-import type { InodeFields, InodeLike } from './internal/inode.js';
-import * as c from './vfs/constants.js';
-/**
- * Indicates the type of a file. Applied to 'mode'.
- * @deprecated
- */
-export type FileType = typeof c.S_IFREG | typeof c.S_IFDIR | typeof c.S_IFLNK;
+import type { V_Context } from '../context.js';
+import type { InodeFields } from '../internal/inode.js';
 export interface StatsLike<T extends number | bigint = number | bigint> {
     /**
      * Size of the item in bytes.
@@ -91,12 +85,6 @@ export declare abstract class StatsCommon<T extends number | bigint> implements
      * Group ID of owner
      */
     gid: T;
-    /**
-     * Some file systems stash data on stats objects.
-     * @todo [BREAKING] Remove this
-     * @deprecated @hidden
-     */
-    fileData?: unknown;
     /**
      * Time of last access, since epoch
      */
@@ -126,12 +114,22 @@ export declare abstract class StatsCommon<T extends number | bigint> implements
      * For directories/symlinks, this is normally the size of the struct that represents the item.
      */
     size: T;
+    /**
+     * @internal Used by inodes
+     */
     data?: number;
+    /**
+     * @internal Used by inodes
+     */
     flags?: number;
+    /**
+     * @internal Used by inodes
+     */
+    version?: number;
     /**
      * Creates a new stats instance from a stats-like object. Can be used to copy stats (note)
      */
-    constructor({ atimeMs, mtimeMs, ctimeMs, birthtimeMs, uid, gid, size, mode, ino, ...rest }?: Partial<InodeLike>);
+    constructor({ atimeMs, mtimeMs, ctimeMs, birthtimeMs, uid, gid, size, mode, ino, ...rest }?: Partial<StatsLike & InodeFields>);
     isFile(): boolean;
     isDirectory(): boolean;
     isSymbolicLink(): boolean;
@@ -147,18 +145,6 @@ export declare abstract class StatsCommon<T extends number | bigint> implements
      * @internal
      */
     hasAccess(mode: number, context?: V_Context): boolean;
-    /**
-     * Change the mode of the file.
-     * We use this helper function to prevent messing up the type of the file.
-     * @internal @deprecated
-     */
-    chmod(mode: number): void;
-    /**
-     * Change the owner user/group of the file.
-     * This function makes sure it is a valid UID/GID (that is, a 32 unsigned int)
-     * @internal @deprecated
-     */
-    chown(uid: number, gid: number): void;
     get atimeNs(): bigint;
     get mtimeNs(): bigint;
     get ctimeNs(): bigint;
@@ -167,7 +153,7 @@ export declare abstract class StatsCommon<T extends number | bigint> implements
 /**
  * @hidden @internal
  */
-export declare function _chown(stats: Partial<StatsLike<number>>, uid: number, gid: number): void;
+export declare function _chown(stats: Partial<StatsLike<number>>, uid: number, gid: number): boolean;
 /**
  * Implementation of Node's `Stats`.
  *

package/dist/{stats.js → vfs/stats.js}

@@ -1,8 +1,6 @@
 import { pick } from 'utilium';
-import { credentials } from './internal/credentials.js';
-import { _inode_fields } from './internal/inode.js';
-import { log_deprecated } from './internal/log.js';
-import * as c from './vfs/constants.js';
+import { _inode_fields, hasAccess } from '../internal/inode.js';
+import * as c from './constants.js';
 const n1000 = BigInt(1000);
 /**
  * Provides information about a particular entry in the file system.
@@ -118,65 +116,8 @@ export class StatsCommon {
      * @internal
      */
     hasAccess(mode, context) {
-        const creds = (context === null || context === void 0 ? void 0 : context.credentials) || credentials;
-        if (this.isSymbolicLink() || creds.euid === 0 || creds.egid === 0)
-            return true;
-        let perm = 0;
-        // Owner permissions
-        if (creds.uid === this.uid) {
-            if (this.mode & c.S_IRUSR)
-                perm |= c.R_OK;
-            if (this.mode & c.S_IWUSR)
-                perm |= c.W_OK;
-            if (this.mode & c.S_IXUSR)
-                perm |= c.X_OK;
-        }
-        // Group permissions
-        if (creds.gid === this.gid || creds.groups.includes(Number(this.gid))) {
-            if (this.mode & c.S_IRGRP)
-                perm |= c.R_OK;
-            if (this.mode & c.S_IWGRP)
-                perm |= c.W_OK;
-            if (this.mode & c.S_IXGRP)
-                perm |= c.X_OK;
-        }
-        // Others permissions
-        if (this.mode & c.S_IROTH)
-            perm |= c.R_OK;
-        if (this.mode & c.S_IWOTH)
-            perm |= c.W_OK;
-        if (this.mode & c.S_IXOTH)
-            perm |= c.X_OK;
-        // Perform the access check
-        return (perm & mode) === mode;
-    }
-    /* node:coverage disable */
-    /**
-     * Change the mode of the file.
-     * We use this helper function to prevent messing up the type of the file.
-     * @internal @deprecated
-     */
-    chmod(mode) {
-        log_deprecated('StatsCommon#chmod');
-        this.mode = this._convert((this.mode & c.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)
-     * @internal @deprecated
-     */
-    chown(uid, gid) {
-        log_deprecated('StatsCommon#chown');
-        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 < 2 ** 32) {
-            this.gid = this._convert(gid);
-        }
+        return hasAccess(context, this._isBigint ? new Stats(this) : this, mode);
     }
-    /* node:coverage enable */
     get atimeNs() {
         return BigInt(this.atimeMs) * n1000;
     }
@@ -194,12 +135,16 @@ export class StatsCommon {
  * @hidden @internal
  */
 export function _chown(stats, uid, gid) {
-    if (!isNaN(uid) && 0 <= uid && uid < c.size_max) {
+    let valid = true;
+    if (!isNaN(uid) && uid >= 0 && uid < c.size_max)
         stats.uid = uid;
-    }
-    if (!isNaN(gid) && 0 <= gid && gid < 2 ** 32) {
+    else
+        valid = false;
+    if (!isNaN(gid) && gid >= 0 && gid < c.size_max)
         stats.gid = gid;
-    }
+    else
+        valid = false;
+    return valid;
 }
 /**
  * Implementation of Node's `Stats`.

package/dist/vfs/streams.d.ts

@@ -48,6 +48,7 @@ export declare class ReadStream extends Readable implements fs.ReadStream {
     private _path;
     private _bytesRead;
     private reader?;
+    private ready;
     constructor(opts: CreateReadStreamOptions | undefined, handleOrPromise: FileHandle | Promise<FileHandle>);
     _read(): Promise<void>;
     close(callback?: Callback<[void], null>): void;

package/dist/vfs/streams.js

@@ -11,28 +11,33 @@ export class ReadStream extends Readable {
         this.pending = true;
         this._path = '<unknown>';
         this._bytesRead = 0;
-        Promise.resolve(handleOrPromise)
-            .then(({ file }) => {
-            this._path = file.path;
-            const internal = file.streamRead({ start: opts.start, end: opts.end });
+        this.ready = Promise.resolve(handleOrPromise)
+            .then(handle => {
+            this._path = handle.path;
+            const internal = handle.readableWebStream({ start: opts.start, end: opts.end });
             this.reader = internal.getReader();
             this.pending = false;
-            return this._read();
         })
-            .catch(err => this.destroy(err));
+            .catch(err => {
+            this.destroy(err);
+        });
     }
     async _read() {
-        if (!this.reader)
-            return;
-        const { done, value } = await this.reader.read();
-        if (done) {
-            this.push(null);
-            return;
+        try {
+            await this.ready;
+            if (!this.reader)
+                return;
+            const { done, value } = await this.reader.read();
+            if (done) {
+                this.push(null);
+                return;
+            }
+            this._bytesRead += value.byteLength;
+            this.push(value);
+        }
+        catch (err) {
+            this.destroy(new ErrnoError(Errno.EIO, err.toString()));
         }
-        this._bytesRead += value.byteLength;
-        if (!this.push(value))
-            return;
-        await this._read();
     }
     close(callback = () => null) {
         try {
@@ -65,9 +70,9 @@ export class WriteStream extends Writable {
         this._path = '<unknown>';
         this._bytesWritten = 0;
         this.ready = Promise.resolve(handleOrPromise)
-            .then(({ file }) => {
-            this._path = file.path;
-            const internal = file.streamWrite({ start: opts.start });
+            .then(handle => {
+            this._path = handle.path;
+            const internal = handle.writableWebStream({ start: opts.start });
             this.writer = internal.getWriter();
             this.pending = false;
         })

package/dist/vfs/sync.d.ts

@@ -1,10 +1,10 @@
 import type * as fs from 'node:fs';
 import type { V_Context } from '../context.js';
-import type { Stats } from '../stats.js';
+import { Stats } from './stats.js';
 import type { FileContents, NullEnc, ReaddirOptions, ReaddirOptsI, ReaddirOptsU } from './types.js';
 import { Buffer } from 'buffer';
-import { BigIntStats } from '../stats.js';
 import { Dir, Dirent } from './dir.js';
+import { BigIntStats } from './stats.js';
 export declare function renameSync(this: V_Context, oldPath: fs.PathLike, newPath: fs.PathLike): void;
 /**
  * Test whether or not `path` exists by checking with the file system.
@@ -31,7 +31,8 @@ export declare function truncateSync(this: V_Context, path: fs.PathLike, len?: n
 export declare function unlinkSync(this: V_Context, path: fs.PathLike): void;
 /**
  * Synchronous file open.
- * @see http://www.manpagez.com/man/2/open/
+ * @see https://nodejs.org/api/fs.html#fsopensyncpath-flags-mode
+ * @param flag {@link https://nodejs.org/api/fs.html#file-system-flags}
  */
 export declare function openSync(this: V_Context, path: fs.PathLike, flag: fs.OpenMode, mode?: fs.Mode | null): number;
 /**