@zenfs/core 0.9.6 → 0.10.0

package/dist/emulation/shared.d.ts

@@ -1,14 +1,13 @@
 import { Cred } from '../cred.js';
 import type { File } from '../file.js';
 import { FileSystem } from '../filesystem.js';
+import { type AbsolutePath } from './path.js';
 export declare let cred: Cred;
 export declare function setCred(val: Cred): void;
 export declare const fdMap: Map<number, File>;
-export declare function getFdForFile(file: File): number;
+export declare function file2fd(file: File): number;
 export declare function fd2file(fd: number): File;
-export interface MountMapping {
-    [point: string]: FileSystem;
-}
+export type MountObject = Record<AbsolutePath, FileSystem>;
 /**
  * The map of mount points
  * @internal
@@ -33,16 +32,6 @@ export declare function resolveMount(path: string): {
 /**
  * Reverse maps the paths in text from the mounted FileSystem to the global path
  */
-export declare function fixPaths(text: string, paths: {
-    [from: string]: string;
-}): string;
-export declare function fixError<E extends Error>(e: E, paths: {
-    [from: string]: string;
-}): E;
-export declare function mountMapping(mountMapping: MountMapping): void;
-/**
- * Types supports as path parameters.
- *
- * In the future, maybe support URL?
- */
-export type PathLike = string;
+export declare function fixPaths(text: string, paths: Record<string, string>): string;
+export declare function fixError<E extends Error>(e: E, paths: Record<string, string>): E;
+export declare function mountObject(mounts: MountObject): void;

package/dist/emulation/shared.js

@@ -1,5 +1,5 @@
 // Utilities and shared data
-import { ApiError, ErrorCode } from '../ApiError.js';
+import { ErrnoError, Errno } from '../error.js';
 import { InMemory } from '../backends/InMemory.js';
 import { rootCred } from '../cred.js';
 import { normalizePath } from '../utils.js';
@@ -12,14 +12,14 @@ export function setCred(val) {
 // descriptors
 export const fdMap = new Map();
 let nextFd = 100;
-export function getFdForFile(file) {
+export function file2fd(file) {
     const fd = nextFd++;
     fdMap.set(fd, file);
     return fd;
 }
 export function fd2file(fd) {
     if (!fdMap.has(fd)) {
-        throw new ApiError(ErrorCode.EBADF);
+        throw new ErrnoError(Errno.EBADF);
     }
     return fdMap.get(fd);
 }
@@ -41,7 +41,7 @@ export function mount(mountPoint, fs) {
     }
     mountPoint = resolve(mountPoint);
     if (mounts.has(mountPoint)) {
-        throw new ApiError(ErrorCode.EINVAL, 'Mount point ' + mountPoint + ' is already in use.');
+        throw new ErrnoError(Errno.EINVAL, 'Mount point ' + mountPoint + ' is already in use.');
     }
     mounts.set(mountPoint, fs);
 }
@@ -54,7 +54,7 @@ export function umount(mountPoint) {
     }
     mountPoint = resolve(mountPoint);
     if (!mounts.has(mountPoint)) {
-        throw new ApiError(ErrorCode.EINVAL, 'Mount point ' + mountPoint + ' is already unmounted.');
+        throw new ErrnoError(Errno.EINVAL, 'Mount point ' + mountPoint + ' is already unmounted.');
     }
     mounts.delete(mountPoint);
 }
@@ -74,7 +74,7 @@ export function resolveMount(path) {
             return { fs, path, mountPoint };
         }
     }
-    throw new ApiError(ErrorCode.EIO, 'ZenFS not initialized with a file system');
+    throw new ErrnoError(Errno.EIO, 'ZenFS not initialized with a file system');
 }
 /**
  * Reverse maps the paths in text from the mounted FileSystem to the global path
@@ -92,11 +92,11 @@ export function fixError(e, paths) {
     e.message = fixPaths(e.message, paths);
     return e;
 }
-export function mountMapping(mountMapping) {
-    if ('/' in mountMapping) {
+export function mountObject(mounts) {
+    if ('/' in mounts) {
         umount('/');
     }
-    for (const [point, fs] of Object.entries(mountMapping)) {
+    for (const [point, fs] of Object.entries(mounts)) {
         mount(point, fs);
     }
 }

package/dist/emulation/streams.js

@@ -1,4 +1,5 @@
 import { Readable, Writable } from 'readable-stream';
+import { ErrnoError, Errno } from '../error.js';
 export class ReadStream extends Readable {
     close(callback = () => null) {
         try {
@@ -7,7 +8,7 @@ export class ReadStream extends Readable {
             callback();
         }
         catch (err) {
-            callback(err);
+            callback(new ErrnoError(Errno.EIO, err.toString()));
         }
     }
 }
@@ -19,7 +20,7 @@ export class WriteStream extends Writable {
             callback();
         }
         catch (err) {
-            callback(err);
+            callback(new ErrnoError(Errno.EIO, err.toString()));
         }
     }
 }

package/dist/emulation/sync.d.ts

@@ -1,32 +1,31 @@
 /// <reference types="node" resolution-mode="require"/>
 /// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
 import { Buffer } from 'buffer';
-import type * as Node from 'fs';
-import type { BufferEncodingOption, EncodingOption, ReadSyncOptions, symlink } from 'fs';
+import type * as fs from 'node:fs';
 import { FileContents } from '../filesystem.js';
 import { BigIntStats, type BigIntStatsFs, type Stats, type StatsFs } from '../stats.js';
 import { Dir, Dirent } from './dir.js';
-import { PathLike } from './shared.js';
 /**
  * Synchronous rename.
  * @param oldPath
  * @param newPath
  */
-export declare function renameSync(oldPath: PathLike, newPath: PathLike): void;
+export declare function renameSync(oldPath: fs.PathLike, newPath: fs.PathLike): void;
 /**
  * Test whether or not the given path exists by checking with the file system.
  * @param path
  */
-export declare function existsSync(path: PathLike): boolean;
+export declare function existsSync(path: fs.PathLike): boolean;
 /**
  * Synchronous `stat`.
  * @param path
  * @returns Stats
  */
-export declare function statSync(path: PathLike, options?: {
-    bigint?: false;
+export declare function statSync(path: fs.PathLike, options?: {
+    bigint?: boolean;
 }): Stats;
-export declare function statSync(path: PathLike, options: {
+export declare function statSync(path: fs.PathLike, options: {
     bigint: true;
 }): BigIntStats;
 /**
@@ -35,10 +34,10 @@ export declare function statSync(path: PathLike, options: {
  * then the link itself is stat-ed, not the file that it refers to.
  * @param path
  */
-export declare function lstatSync(path: PathLike, options?: {
-    bigint?: false;
+export declare function lstatSync(path: fs.PathLike, options?: {
+    bigint?: boolean;
 }): Stats;
-export declare function lstatSync(path: PathLike, options: {
+export declare function lstatSync(path: fs.PathLike, options: {
     bigint: true;
 }): BigIntStats;
 /**
@@ -46,12 +45,12 @@ export declare function lstatSync(path: PathLike, options: {
  * @param path
  * @param len
  */
-export declare function truncateSync(path: PathLike, len?: number): void;
+export declare function truncateSync(path: fs.PathLike, len?: number | null): void;
 /**
  * Synchronous `unlink`.
  * @param path
  */
-export declare function unlinkSync(path: PathLike): void;
+export declare function unlinkSync(path: fs.PathLike): void;
 /**
  * Synchronous file open.
  * @see http://www.manpagez.com/man/2/open/
@@ -60,40 +59,40 @@ export declare function unlinkSync(path: PathLike): void;
  * @param mode Mode to use to open the file. Can be ignored if the
  *   filesystem doesn't support permissions.
  */
-export declare function openSync(path: PathLike, flag: string, mode?: Node.Mode): number;
+export declare function openSync(path: fs.PathLike, flag: fs.OpenMode, mode?: fs.Mode | null): number;
 /**
  * Opens a file or symlink
  * @internal
  */
-export declare function lopenSync(path: PathLike, flag: string, mode?: Node.Mode): number;
+export declare function lopenSync(path: fs.PathLike, flag: string, mode?: fs.Mode | null): number;
 /**
  * Synchronously reads the entire contents of a file.
- * @param filename
+ * @param path
  * @param options
  * @option options encoding The string encoding for the file contents. Defaults to `null`.
  * @option options flag Defaults to `'r'`.
  * @returns file contents
  */
-export declare function readFileSync(filename: string, options?: {
+export declare function readFileSync(path: fs.PathOrFileDescriptor, options?: {
     flag?: string;
-}): Buffer;
-export declare function readFileSync(filename: string, options: (Node.EncodingOption & {
+} | null): Buffer;
+export declare function readFileSync(path: fs.PathOrFileDescriptor, options?: (fs.EncodingOption & {
     flag?: string;
-}) | BufferEncoding): string;
+}) | BufferEncoding | null): string;
 /**
  * Synchronously writes data to a file, replacing the file if it already
  * exists.
  *
  * The encoding option is ignored if data is a buffer.
- * @param filename
+ * @param path
  * @param data
  * @param options
  * @option options encoding Defaults to `'utf8'`.
  * @option options mode Defaults to `0644`.
  * @option options flag Defaults to `'w'`.
  */
-export declare function writeFileSync(filename: string, data: FileContents, options?: Node.WriteFileOptions): void;
-export declare function writeFileSync(filename: string, data: FileContents, encoding?: BufferEncoding): void;
+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;
 /**
  * Asynchronously append data to a file, creating the file if it not yet
  * exists.
@@ -105,7 +104,7 @@ export declare function writeFileSync(filename: string, data: FileContents, enco
  * @option options mode Defaults to `0644`.
  * @option options flag Defaults to `'a'`.
  */
-export declare function appendFileSync(filename: string, data: FileContents, _options?: Node.WriteFileOptions): void;
+export declare function appendFileSync(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
@@ -113,7 +112,7 @@ export declare function appendFileSync(filename: string, data: FileContents, _op
  * @param fd
  */
 export declare function fstatSync(fd: number, options?: {
-    bigint?: false;
+    bigint?: boolean;
 }): Stats;
 export declare function fstatSync(fd: number, options: {
     bigint: true;
@@ -128,7 +127,7 @@ export declare function closeSync(fd: number): void;
  * @param fd
  * @param len
  */
-export declare function ftruncateSync(fd: number, len?: number): void;
+export declare function ftruncateSync(fd: number, len?: number | null): void;
 /**
  * Synchronous fsync.
  * @param fd
@@ -152,8 +151,8 @@ export declare function fdatasyncSync(fd: number): void;
  *   data should be written. If position is null, the data will be written at
  *   the current position.
  */
-export declare function writeSync(fd: number, data: Uint8Array, offset: number, length: number, position?: number): number;
-export declare function writeSync(fd: number, data: string, position?: number, encoding?: BufferEncoding): number;
+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;
 /**
  * Read data from the file specified by `fd`.
  * @param fd
@@ -166,8 +165,8 @@ export declare function writeSync(fd: number, data: string, position?: number, e
  *   in the file. If position is null, data will be read from the current file
  *   position.
  */
-export declare function readSync(fd: number, buffer: Uint8Array, opts?: ReadSyncOptions): number;
-export declare function readSync(fd: number, buffer: Uint8Array, offset: number, length: number, position?: number): number;
+export declare function readSync(fd: number, buffer: ArrayBufferView, opts?: fs.ReadSyncOptions): number;
+export declare function readSync(fd: number, buffer: ArrayBufferView, offset: number, length: number, position?: fs.ReadPosition | null): number;
 /**
  * Synchronous `fchown`.
  * @param fd
@@ -193,93 +192,101 @@ export declare function futimesSync(fd: number, atime: string | number | Date, m
  * Synchronous `rmdir`.
  * @param path
  */
-export declare function rmdirSync(path: PathLike): void;
+export declare function rmdirSync(path: fs.PathLike): void;
 /**
  * Synchronous `mkdir`.
  * @param path
  * @param mode defaults to o777
  * @todo Implement recursion
  */
-export declare function mkdirSync(path: PathLike, options: Node.MakeDirectoryOptions & {
+export declare function mkdirSync(path: fs.PathLike, options: fs.MakeDirectoryOptions & {
     recursive: true;
-}): string;
-export declare function mkdirSync(path: PathLike, options?: Node.Mode | (Node.MakeDirectoryOptions & {
+}): string | undefined;
+export declare function mkdirSync(path: fs.PathLike, options?: fs.Mode | (fs.MakeDirectoryOptions & {
     recursive?: false;
-})): void;
+}) | null): void;
+export declare function mkdirSync(path: fs.PathLike, options?: fs.Mode | fs.MakeDirectoryOptions | null): string | undefined;
 /**
  * Synchronous `readdir`. Reads the contents of a directory.
  * @param path
  */
-export declare function readdirSync(path: PathLike, options?: {
-    encoding?: BufferEncoding;
+export declare function readdirSync(path: fs.PathLike, options?: {
+    recursive?: boolean;
+    encoding?: BufferEncoding | null;
     withFileTypes?: false;
-} | BufferEncoding): string[];
-export declare function readdirSync(path: PathLike, options: {
+} | BufferEncoding | null): string[];
+export declare function readdirSync(path: fs.PathLike, options: {
+    recursive?: boolean;
     encoding: 'buffer';
     withFileTypes?: false;
 } | 'buffer'): Buffer[];
-export declare function readdirSync(path: PathLike, options: {
+export declare function readdirSync(path: fs.PathLike, options: {
+    recursive?: boolean;
     withFileTypes: true;
 }): Dirent[];
+export declare function readdirSync(path: fs.PathLike, options?: (fs.ObjectEncodingOptions & {
+    withFileTypes?: false;
+    recursive?: boolean;
+}) | BufferEncoding | null): string[] | Buffer[];
 /**
  * Synchronous `link`.
  * @param existing
  * @param newpath
  */
-export declare function linkSync(existing: PathLike, newpath: PathLike): void;
+export declare function linkSync(existing: fs.PathLike, newpath: 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: PathLike, path: PathLike, type?: symlink.Type): void;
+export declare function symlinkSync(target: fs.PathLike, path: fs.PathLike, type?: fs.symlink.Type | null): void;
 /**
  * Synchronous readlink.
  * @param path
  */
-export declare function readlinkSync(path: PathLike, options?: BufferEncodingOption): Buffer;
-export declare function readlinkSync(path: PathLike, options: EncodingOption | BufferEncoding): string;
+export declare function readlinkSync(path: fs.PathLike, options?: fs.BufferEncodingOption): Buffer;
+export declare function readlinkSync(path: fs.PathLike, options: fs.EncodingOption | BufferEncoding): string;
 /**
  * Synchronous `chown`.
  * @param path
  * @param uid
  * @param gid
  */
-export declare function chownSync(path: PathLike, uid: number, gid: number): void;
+export declare function chownSync(path: fs.PathLike, uid: number, gid: number): void;
 /**
  * Synchronous `lchown`.
  * @param path
  * @param uid
  * @param gid
  */
-export declare function lchownSync(path: PathLike, uid: number, gid: number): void;
+export declare function lchownSync(path: fs.PathLike, uid: number, gid: number): void;
 /**
  * Synchronous `chmod`.
  * @param path
  * @param mode
  */
-export declare function chmodSync(path: PathLike, mode: Node.Mode): void;
+export declare function chmodSync(path: fs.PathLike, mode: fs.Mode): void;
 /**
  * Synchronous `lchmod`.
  * @param path
  * @param mode
  */
-export declare function lchmodSync(path: PathLike, mode: number | string): void;
+export declare function lchmodSync(path: fs.PathLike, mode: number | string): void;
 /**
  * Change file timestamps of the file referenced by the supplied path.
  * @param path
  * @param atime
  * @param mtime
  */
-export declare function utimesSync(path: PathLike, atime: string | number | Date, mtime: string | number | Date): void;
+export declare function utimesSync(path: fs.PathLike, atime: string | number | Date, mtime: string | number | Date): void;
 /**
  * Change file timestamps of the file referenced by the supplied path.
  * @param path
  * @param atime
  * @param mtime
  */
-export declare function lutimesSync(path: PathLike, atime: string | number | Date, mtime: string | number | Date): void;
+export declare function lutimesSync(path: fs.PathLike, atime: string | number | Date, mtime: string | number | Date): void;
 /**
  * Synchronous `realpath`.
  * @param path
@@ -288,27 +295,27 @@ export declare function lutimesSync(path: PathLike, atime: string | number | Dat
  *   known real paths.
  * @returns the real path
  */
-export declare function realpathSync(path: PathLike, options: BufferEncodingOption): Buffer;
-export declare function realpathSync(path: PathLike, options?: EncodingOption): string;
+export declare function realpathSync(path: fs.PathLike, options: fs.BufferEncodingOption): Buffer;
+export declare function realpathSync(path: fs.PathLike, options?: fs.EncodingOption): string;
 /**
  * Synchronous `access`.
  * @param path
  * @param mode
  */
-export declare function accessSync(path: PathLike, mode?: number): void;
+export declare function accessSync(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: PathLike, options?: Node.RmOptions): void;
+export declare function rmSync(path: fs.PathLike, options?: fs.RmOptions): 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: BufferEncodingOption): Buffer;
-export declare function mkdtempSync(prefix: string, options?: EncodingOption): string;
+export declare function mkdtempSync(prefix: string, options: fs.BufferEncodingOption): Buffer;
+export declare function mkdtempSync(prefix: string, options?: fs.EncodingOption): string;
 /**
  * Synchronous `copyFile`. Copies a file.
  * @param src The source file.
@@ -316,7 +323,7 @@ export declare function mkdtempSync(prefix: string, options?: EncodingOption): s
  * @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(src: PathLike, dest: PathLike, flags?: number): void;
+export declare function copyFileSync(src: fs.PathLike, dest: fs.PathLike, flags?: number): void;
 /**
  * Synchronous `readv`. Reads from a file descriptor into multiple buffers.
  * @param fd The file descriptor.
@@ -324,7 +331,7 @@ export declare function copyFileSync(src: PathLike, dest: PathLike, flags?: numb
  * @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 Uint8Array[], position?: number): number;
+export declare function readvSync(fd: number, buffers: readonly NodeJS.ArrayBufferView[], position?: number): number;
 /**
  * Synchronous `writev`. Writes from multiple buffers into a file descriptor.
  * @param fd The file descriptor.
@@ -332,14 +339,14 @@ export declare function readvSync(fd: number, buffers: readonly Uint8Array[], po
  * @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 Uint8Array[], position?: number): number;
+export declare function writevSync(fd: number, buffers: readonly ArrayBufferView[], position?: number): number;
 /**
  * Synchronous `opendir`. Opens a directory.
  * @param path The path to the directory.
  * @param options Options for opening the directory.
  * @returns A `Dir` object representing the opened directory.
  */
-export declare function opendirSync(path: PathLike, options?: Node.OpenDirOptions): Dir;
+export declare function opendirSync(path: fs.PathLike, options?: fs.OpenDirOptions): Dir;
 /**
  * Synchronous `cp`. Recursively copies a file or directory.
  * @param source The source file or directory.
@@ -352,17 +359,17 @@ export declare function opendirSync(path: PathLike, options?: Node.OpenDirOption
  *   * `preserveTimestamps`: Preserve file timestamps.
  *   * `recursive`: If `true`, copies directories recursively.
  */
-export declare function cpSync(source: PathLike, destination: PathLike, opts?: Node.CopySyncOptions): void;
+export declare function cpSync(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.
  * @param callback
  */
-export declare function statfsSync(path: PathLike, options?: Node.StatFsOptions & {
+export declare function statfsSync(path: fs.PathLike, options?: fs.StatFsOptions & {
     bigint?: false;
 }): StatsFs;
-export declare function statfsSync(path: PathLike, options: Node.StatFsOptions & {
+export declare function statfsSync(path: fs.PathLike, options: fs.StatFsOptions & {
     bigint: true;
 }): BigIntStatsFs;
-export declare function statfsSync(path: PathLike, options?: Node.StatFsOptions): StatsFs | BigIntStatsFs;
+export declare function statfsSync(path: fs.PathLike, options?: fs.StatFsOptions): StatsFs | BigIntStatsFs;