@zenfs/core 1.3.6 → 1.4.0

package/dist/emulation/shared.js

@@ -1,18 +1,28 @@
 // Utilities and shared data
 import { InMemory } from '../backends/memory.js';
+import { bindContext } from '../context.js';
 import { Errno, ErrnoError } from '../error.js';
 import { normalizePath } from '../utils.js';
-import { resolve } from './path.js';
-import { size_max } from './constants.js';
 import { paths as pathCache } from './cache.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);
@@ -28,6 +38,7 @@ export const mounts = new Map();
 mount('/', InMemory.create({ name: 'root' }));
 /**
  * Mounts the file system at `mountPoint`.
+ * @internal
  */
 export function mount(mountPoint, fs) {
     if (mountPoint[0] !== '/') {
@@ -56,21 +67,23 @@ export function umount(mountPoint) {
 }
 /**
  * Gets the internal `FileSystem` for the path, then returns it along with the path relative to the FS' root
+ * @internal @hidden
  */
-export function resolveMount(path) {
-    path = normalizePath(path);
+export function resolveMount(path, ctx) {
+    const root = ctx?.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) {
         // We know path is normalized, so it would be a substring of the mount point.
         if (mountPoint.length <= path.length && path.startsWith(mountPoint)) {
             path = path.slice(mountPoint.length > 1 ? mountPoint.length : 0); // Resolve the path relative to the mount point
             if (path === '') {
-                path = '/';
+                path = root;
             }
-            return { fs, path, mountPoint };
+            return { fs, path, mountPoint, root };
         }
     }
-    throw new ErrnoError(Errno.EIO, 'ZenFS not initialized with a file system');
+    throw new ErrnoError(Errno.EIO, 'No file system');
 }
 /**
  * Wait for all file systems to be ready and synced.
@@ -83,7 +96,7 @@ export async function _synced() {
 }
 /**
  * Reverse maps the paths in text from the mounted FileSystem to the global path
- * @hidden
+ * @internal @hidden
  */
 export function fixPaths(text, paths) {
     for (const [from, to] of Object.entries(paths)) {
@@ -93,7 +106,7 @@ export function fixPaths(text, paths) {
 }
 /**
  * Fix paths in error stacks
- * @hidden
+ * @internal @hidden
  */
 export function fixError(e, paths) {
     if (typeof e.stack == 'string') {
@@ -105,10 +118,12 @@ export function fixError(e, paths) {
     catch {
         // `message` is read only
     }
+    if (e.path)
+        e.path = fixPaths(e.path, paths);
     return e;
 }
 /**
- * @deprecated
+ * @internal @deprecated
  */
 export function mountObject(mounts) {
     if ('/' in mounts) {
@@ -119,7 +134,7 @@ export function mountObject(mounts) {
     }
 }
 /**
- * @hidden
+ * @internal @hidden
  */
 export function _statfs(fs, bigint) {
     const md = fs.metadata();
@@ -134,3 +149,14 @@ export function _statfs(fs, bigint) {
         blocks: (bigint ? BigInt : Number)(md.totalSpace / bs),
     };
 }
+export function chroot(path, inPlace) {
+    const creds = this?.credentials;
+    if (creds?.uid && creds?.gid && creds?.euid && creds?.egid) {
+        throw new ErrnoError(Errno.EPERM, 'Can not chroot() as non-root user');
+    }
+    if (inPlace && this) {
+        this.root += path;
+        return this;
+    }
+    return bindContext(join(this?.root || '/', path), creds);
+}

package/dist/emulation/sync.d.ts

@@ -4,15 +4,16 @@ import type { FileContents } from '../filesystem.js';
 import { BigIntStats, type Stats } from '../stats.js';
 import { Dir, Dirent } from './dir.js';
 import { type InternalOptions, type ReaddirOptions } from './shared.js';
-export declare function renameSync(oldPath: fs.PathLike, newPath: fs.PathLike): void;
+import type { V_Context } from '../context.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.
  */
-export declare function existsSync(path: fs.PathLike): boolean;
-export declare function statSync(path: fs.PathLike, options?: {
+export declare function existsSync(this: V_Context, path: fs.PathLike): boolean;
+export declare function statSync(this: V_Context, path: fs.PathLike, options?: {
     bigint?: boolean;
 }): Stats;
-export declare function statSync(path: fs.PathLike, options: {
+export declare function statSync(this: V_Context, path: fs.PathLike, options: {
     bigint: true;
 }): BigIntStats;
 /**
@@ -20,34 +21,34 @@ export declare function statSync(path: fs.PathLike, options: {
  * `lstat()` is identical to `stat()`, except that if path is a symbolic link,
  * then the link itself is stat-ed, not the file that it refers to.
  */
-export declare function lstatSync(path: fs.PathLike, options?: {
+export declare function lstatSync(this: V_Context, path: fs.PathLike, options?: {
     bigint?: boolean;
 }): Stats;
-export declare function lstatSync(path: fs.PathLike, options: {
+export declare function lstatSync(this: V_Context, path: fs.PathLike, options: {
     bigint: true;
 }): BigIntStats;
-export declare function truncateSync(path: fs.PathLike, len?: number | null): void;
-export declare function unlinkSync(path: fs.PathLike): void;
+export declare function truncateSync(this: V_Context, path: fs.PathLike, len?: number | null): void;
+export declare function unlinkSync(this: V_Context, path: fs.PathLike): void;
 /**
  * Synchronous file open.
  * @see http://www.manpagez.com/man/2/open/
  */
-export declare function openSync(path: fs.PathLike, flag: fs.OpenMode, mode?: fs.Mode | null): number;
+export declare function openSync(this: V_Context, path: fs.PathLike, flag: fs.OpenMode, mode?: fs.Mode | null): number;
 /**
  * Opens a file or symlink
  * @internal
  */
-export declare function lopenSync(path: fs.PathLike, flag: string, mode?: fs.Mode | null): number;
+export declare function lopenSync(this: V_Context, path: fs.PathLike, flag: string, mode?: fs.Mode | null): number;
 /**
  * Synchronously reads the entire contents of a file.
  * @option encoding The string encoding for the file contents. Defaults to `null`.
  * @option flag Defaults to `'r'`.
  * @returns file contents
  */
-export declare function readFileSync(path: fs.PathOrFileDescriptor, options?: {
+export declare function readFileSync(this: V_Context, path: fs.PathOrFileDescriptor, options?: {
     flag?: string;
 } | null): Buffer;
-export declare function readFileSync(path: fs.PathOrFileDescriptor, options?: (fs.EncodingOption & {
+export declare function readFileSync(this: V_Context, path: fs.PathOrFileDescriptor, options?: (fs.EncodingOption & {
     flag?: string;
 }) | BufferEncoding | null): string;
 /**
@@ -58,30 +59,30 @@ export declare function readFileSync(path: fs.PathOrFileDescriptor, options?: (f
  * @option mode Defaults to `0644`.
  * @option flag Defaults to `'w'`.
  */
-export declare function writeFileSync(path: fs.PathOrFileDescriptor, data: FileContents, options?: fs.WriteFileOptions): void;
-export declare function writeFileSync(path: fs.PathOrFileDescriptor, data: FileContents, encoding?: BufferEncoding): void;
+export declare function writeFileSync(this: V_Context, path: fs.PathOrFileDescriptor, data: FileContents, options?: fs.WriteFileOptions): void;
+export declare function writeFileSync(this: V_Context, path: fs.PathOrFileDescriptor, data: FileContents, encoding?: BufferEncoding): void;
 /**
  * Asynchronously append data to a file, creating the file if it not yet exists.
  * @option encoding Defaults to `'utf8'`.
  * @option mode Defaults to `0644`.
  * @option flag Defaults to `'a+'`.
  */
-export declare function appendFileSync(filename: fs.PathOrFileDescriptor, data: FileContents, _options?: fs.WriteFileOptions): void;
+export declare function appendFileSync(this: V_Context, filename: fs.PathOrFileDescriptor, data: FileContents, _options?: fs.WriteFileOptions): void;
 /**
  * Synchronous `fstat`.
  * `fstat()` is identical to `stat()`, except that the file to be stat-ed is
  * specified by the file descriptor `fd`.
  */
-export declare function fstatSync(fd: number, options?: {
+export declare function fstatSync(this: V_Context, fd: number, options?: {
     bigint?: boolean;
 }): Stats;
-export declare function fstatSync(fd: number, options: {
+export declare function fstatSync(this: V_Context, fd: number, options: {
     bigint: true;
 }): BigIntStats;
-export declare function closeSync(fd: number): void;
-export declare function ftruncateSync(fd: number, len?: number | null): void;
-export declare function fsyncSync(fd: number): void;
-export declare function fdatasyncSync(fd: number): void;
+export declare function closeSync(this: V_Context, fd: number): void;
+export declare function ftruncateSync(this: V_Context, fd: number, len?: number | null): void;
+export declare function fsyncSync(this: V_Context, fd: number): void;
+export declare function fdatasyncSync(this: V_Context, fd: number): void;
 /**
  * Write buffer to the file specified by `fd`.
  * @param data Uint8Array containing the data to write to the file.
@@ -90,85 +91,85 @@ export declare function fdatasyncSync(fd: number): void;
  * @param position Offset from the beginning of the file where this data should be written.
  * If position is null, the data will be written at the current position.
  */
-export declare function writeSync(fd: number, data: ArrayBufferView, offset?: number | null, length?: number | null, position?: number | null): number;
-export declare function writeSync(fd: number, data: string, position?: number | null, encoding?: BufferEncoding | null): number;
-export declare function readSync(fd: number, buffer: ArrayBufferView, options?: fs.ReadSyncOptions): number;
-export declare function readSync(fd: number, buffer: ArrayBufferView, offset: number, length: number, position?: fs.ReadPosition | null): number;
-export declare function fchownSync(fd: number, uid: number, gid: number): void;
-export declare function fchmodSync(fd: number, mode: number | string): void;
+export declare function writeSync(this: V_Context, fd: number, data: ArrayBufferView, offset?: number | null, length?: number | null, position?: number | null): number;
+export declare function writeSync(this: V_Context, fd: number, data: string, position?: number | null, encoding?: BufferEncoding | null): number;
+export declare function readSync(this: V_Context, fd: number, buffer: ArrayBufferView, options?: fs.ReadSyncOptions): number;
+export declare function readSync(this: V_Context, fd: number, buffer: ArrayBufferView, offset: number, length: number, position?: fs.ReadPosition | null): number;
+export declare function fchownSync(this: V_Context, fd: number, uid: number, gid: number): void;
+export declare function fchmodSync(this: V_Context, fd: number, mode: number | string): void;
 /**
  * Change the file timestamps of a file referenced by the supplied file descriptor.
  */
-export declare function futimesSync(fd: number, atime: string | number | Date, mtime: string | number | Date): void;
-export declare function rmdirSync(path: fs.PathLike): void;
+export declare function futimesSync(this: V_Context, fd: number, atime: string | number | Date, mtime: string | number | Date): void;
+export declare function rmdirSync(this: V_Context, path: fs.PathLike): void;
 /**
  * Synchronous `mkdir`. Mode defaults to `o777`.
  */
-export declare function mkdirSync(path: fs.PathLike, options: fs.MakeDirectoryOptions & {
+export declare function mkdirSync(this: V_Context, path: fs.PathLike, options: fs.MakeDirectoryOptions & {
     recursive: true;
 }): string | undefined;
-export declare function mkdirSync(path: fs.PathLike, options?: fs.Mode | (fs.MakeDirectoryOptions & {
+export declare function mkdirSync(this: V_Context, path: fs.PathLike, options?: fs.Mode | (fs.MakeDirectoryOptions & {
     recursive?: false;
 }) | null): void;
-export declare function mkdirSync(path: fs.PathLike, options?: fs.Mode | fs.MakeDirectoryOptions | null): string | undefined;
-export declare function readdirSync(path: fs.PathLike, options?: (fs.ObjectEncodingOptions & ReaddirOptions & {
+export declare function mkdirSync(this: V_Context, path: fs.PathLike, options?: fs.Mode | fs.MakeDirectoryOptions | null): string | undefined;
+export declare function readdirSync(this: V_Context, path: fs.PathLike, options?: (fs.ObjectEncodingOptions & ReaddirOptions & {
     withFileTypes?: false;
 }) | BufferEncoding | null): string[];
-export declare function readdirSync(path: fs.PathLike, options: fs.BufferEncodingOption & ReaddirOptions & {
+export declare function readdirSync(this: V_Context, path: fs.PathLike, options: fs.BufferEncodingOption & ReaddirOptions & {
     withFileTypes?: false;
 }): Buffer[];
-export declare function readdirSync(path: fs.PathLike, options?: (fs.ObjectEncodingOptions & ReaddirOptions & {
+export declare function readdirSync(this: V_Context, path: fs.PathLike, options?: (fs.ObjectEncodingOptions & ReaddirOptions & {
     withFileTypes?: false;
 }) | BufferEncoding | null): string[] | Buffer[];
-export declare function readdirSync(path: fs.PathLike, options: fs.ObjectEncodingOptions & ReaddirOptions & {
+export declare function readdirSync(this: V_Context, path: fs.PathLike, options: fs.ObjectEncodingOptions & ReaddirOptions & {
     withFileTypes: true;
 }): Dirent[];
-export declare function readdirSync(path: fs.PathLike, options?: (ReaddirOptions & (fs.ObjectEncodingOptions | fs.BufferEncodingOption)) | BufferEncoding | null): string[] | Dirent[] | Buffer[];
-export declare function linkSync(targetPath: fs.PathLike, linkPath: fs.PathLike): void;
+export declare function readdirSync(this: V_Context, path: fs.PathLike, options?: (ReaddirOptions & (fs.ObjectEncodingOptions | fs.BufferEncodingOption)) | BufferEncoding | null): string[] | Dirent[] | Buffer[];
+export declare function linkSync(this: V_Context, targetPath: fs.PathLike, linkPath: fs.PathLike): void;
 /**
  * Synchronous `symlink`.
  * @param target target path
  * @param path link path
  * @param type can be either `'dir'` or `'file'` (default is `'file'`)
  */
-export declare function symlinkSync(target: fs.PathLike, path: fs.PathLike, type?: fs.symlink.Type | null): void;
-export declare function readlinkSync(path: fs.PathLike, options?: fs.BufferEncodingOption): Buffer;
-export declare function readlinkSync(path: fs.PathLike, options: fs.EncodingOption | BufferEncoding): string;
-export declare function readlinkSync(path: fs.PathLike, options?: fs.EncodingOption | BufferEncoding | fs.BufferEncodingOption): Buffer | string;
-export declare function chownSync(path: fs.PathLike, uid: number, gid: number): void;
-export declare function lchownSync(path: fs.PathLike, uid: number, gid: number): void;
-export declare function chmodSync(path: fs.PathLike, mode: fs.Mode): void;
-export declare function lchmodSync(path: fs.PathLike, mode: number | string): void;
+export declare function symlinkSync(this: V_Context, target: fs.PathLike, path: fs.PathLike, type?: fs.symlink.Type | null): void;
+export declare function readlinkSync(this: V_Context, path: fs.PathLike, options?: fs.BufferEncodingOption): Buffer;
+export declare function readlinkSync(this: V_Context, path: fs.PathLike, options: fs.EncodingOption | BufferEncoding): string;
+export declare function readlinkSync(this: V_Context, path: fs.PathLike, options?: fs.EncodingOption | BufferEncoding | fs.BufferEncodingOption): Buffer | string;
+export declare function chownSync(this: V_Context, path: fs.PathLike, uid: number, gid: number): void;
+export declare function lchownSync(this: V_Context, path: fs.PathLike, uid: number, gid: number): void;
+export declare function chmodSync(this: V_Context, path: fs.PathLike, mode: fs.Mode): void;
+export declare function lchmodSync(this: V_Context, path: fs.PathLike, mode: number | string): void;
 /**
  * Change file timestamps of the file referenced by the supplied path.
  */
-export declare function utimesSync(path: fs.PathLike, atime: string | number | Date, mtime: string | number | Date): void;
+export declare function utimesSync(this: V_Context, path: fs.PathLike, atime: string | number | Date, mtime: string | number | Date): void;
 /**
  * Change file timestamps of the file referenced by the supplied path.
  */
-export declare function lutimesSync(path: fs.PathLike, atime: string | number | Date, mtime: string | number | Date): void;
-export declare function realpathSync(path: fs.PathLike, options: fs.BufferEncodingOption): Buffer;
-export declare function realpathSync(path: fs.PathLike, options?: fs.EncodingOption): string;
-export declare function accessSync(path: fs.PathLike, mode?: number): void;
+export declare function lutimesSync(this: V_Context, path: fs.PathLike, atime: string | number | Date, mtime: string | number | Date): void;
+export declare function realpathSync(this: V_Context, path: fs.PathLike, options: fs.BufferEncodingOption): Buffer;
+export declare function realpathSync(this: V_Context, path: fs.PathLike, options?: fs.EncodingOption): string;
+export declare function accessSync(this: V_Context, path: fs.PathLike, mode?: number): void;
 /**
  * Synchronous `rm`. Removes files or directories (recursively).
  * @param path The path to the file or directory to remove.
  */
-export declare function rmSync(path: fs.PathLike, options?: fs.RmOptions & InternalOptions): void;
+export declare function rmSync(this: V_Context, path: fs.PathLike, options?: fs.RmOptions & InternalOptions): void;
 /**
  * Synchronous `mkdtemp`. Creates a unique temporary directory.
  * @param prefix The directory prefix.
  * @param options The encoding (or an object including `encoding`).
  * @returns The path to the created temporary directory, encoded as a string or buffer.
  */
-export declare function mkdtempSync(prefix: string, options: fs.BufferEncodingOption): Buffer;
-export declare function mkdtempSync(prefix: string, options?: fs.EncodingOption): string;
+export declare function mkdtempSync(this: V_Context, prefix: string, options: fs.BufferEncodingOption): Buffer;
+export declare function mkdtempSync(this: V_Context, prefix: string, options?: fs.EncodingOption): string;
 /**
  * Synchronous `copyFile`. Copies a file.
  * @param flags Optional flags for the copy operation. Currently supports these flags:
  * - `fs.constants.COPYFILE_EXCL`: If the destination file already exists, the operation fails.
  */
-export declare function copyFileSync(source: fs.PathLike, destination: fs.PathLike, flags?: number): void;
+export declare function copyFileSync(this: V_Context, source: fs.PathLike, destination: fs.PathLike, flags?: number): void;
 /**
  * Synchronous `readv`. Reads from a file descriptor into multiple buffers.
  * @param fd The file descriptor.
@@ -176,7 +177,7 @@ export declare function copyFileSync(source: fs.PathLike, destination: fs.PathLi
  * @param position The position in the file where to begin reading.
  * @returns The number of bytes read.
  */
-export declare function readvSync(fd: number, buffers: readonly NodeJS.ArrayBufferView[], position?: number): number;
+export declare function readvSync(this: V_Context, fd: number, buffers: readonly NodeJS.ArrayBufferView[], position?: number): number;
 /**
  * Synchronous `writev`. Writes from multiple buffers into a file descriptor.
  * @param fd The file descriptor.
@@ -184,7 +185,7 @@ export declare function readvSync(fd: number, buffers: readonly NodeJS.ArrayBuff
  * @param position The position in the file where to begin writing.
  * @returns The number of bytes written.
  */
-export declare function writevSync(fd: number, buffers: readonly ArrayBufferView[], position?: number): number;
+export declare function writevSync(this: V_Context, fd: number, buffers: readonly ArrayBufferView[], position?: number): number;
 /**
  * Synchronous `opendir`. Opens a directory.
  * @param path The path to the directory.
@@ -192,7 +193,7 @@ export declare function writevSync(fd: number, buffers: readonly ArrayBufferView
  * @returns A `Dir` object representing the opened directory.
  * @todo Handle options
  */
-export declare function opendirSync(path: fs.PathLike, options?: fs.OpenDirOptions): Dir;
+export declare function opendirSync(this: V_Context, path: fs.PathLike, options?: fs.OpenDirOptions): Dir;
 /**
  * Synchronous `cp`. Recursively copies a file or directory.
  * @param source The source file or directory.
@@ -205,16 +206,16 @@ export declare function opendirSync(path: fs.PathLike, options?: fs.OpenDirOptio
  * - `preserveTimestamps`: Preserve file timestamps.
  * - `recursive`: If `true`, copies directories recursively.
  */
-export declare function cpSync(source: fs.PathLike, destination: fs.PathLike, opts?: fs.CopySyncOptions): void;
+export declare function cpSync(this: V_Context, source: fs.PathLike, destination: fs.PathLike, opts?: fs.CopySyncOptions): void;
 /**
  * Synchronous statfs(2). Returns information about the mounted file system which contains path.
  * In case of an error, the err.code will be one of Common System Errors.
  * @param path A path to an existing file or directory on the file system to be queried.
  */
-export declare function statfsSync(path: fs.PathLike, options?: fs.StatFsOptions & {
+export declare function statfsSync(this: V_Context, path: fs.PathLike, options?: fs.StatFsOptions & {
     bigint?: false;
 }): fs.StatsFs;
-export declare function statfsSync(path: fs.PathLike, options: fs.StatFsOptions & {
+export declare function statfsSync(this: V_Context, path: fs.PathLike, options: fs.StatFsOptions & {
     bigint: true;
 }): fs.BigIntStatsFs;
-export declare function statfsSync(path: fs.PathLike, options?: fs.StatFsOptions): fs.StatsFs | fs.BigIntStatsFs;
+export declare function statfsSync(this: V_Context, path: fs.PathLike, options?: fs.StatFsOptions): fs.StatsFs | fs.BigIntStatsFs;