@zenfs/core 0.9.6 → 0.9.7

package/dist/config.d.ts

@@ -3,7 +3,7 @@ import { FileSystem } from './filesystem.js';
 /**
  * Configuration for a specific mount point
  */
-export type MountConfiguration<FS extends FileSystem = FileSystem, TOptions extends object = object> = FS | BackendConfiguration<FS, TOptions> | Backend<FS, TOptions>;
+export type MountConfiguration<FS extends FileSystem = FileSystem, TOptions extends object = object> = FS | BackendConfiguration<Backend<FS, TOptions>> | Backend<FS, TOptions>;
 /**
  * Retrieve a file system with the given configuration.
  * @param config A BackendConfig object.

package/dist/config.js

@@ -49,8 +49,8 @@ export async function resolveMountConfig(config, _depth = 0) {
  * @see Configuration for more info on the configuration object.
  */
 export async function configure(config) {
-    const uid = 'uid' in config ? +config.uid || 0 : 0;
-    const gid = 'gid' in config ? +config.gid || 0 : 0;
+    const uid = 'uid' in config ? config.uid || 0 : 0;
+    const gid = 'gid' in config ? config.gid || 0 : 0;
     if (isMountConfig(config)) {
         // single FS
         config = { '/': config };

package/dist/emulation/async.d.ts

@@ -1,13 +1,12 @@
 /// <reference types="node" resolution-mode="require"/>
 /// <reference types="node" resolution-mode="require"/>
 /// <reference types="node" resolution-mode="require"/>
-import type * as Node from 'fs';
+import type * as fs from 'node:fs';
 import type { FileContents } from '../filesystem.js';
 import { BigIntStats, type BigIntStatsFs, type Stats, type StatsFs } from '../stats.js';
 import { type Callback } from '../utils.js';
 import { Dirent, type Dir } from './dir.js';
 import * as promises from './promises.js';
-import { PathLike } from './shared.js';
 import { ReadStream, WriteStream } from './streams.js';
 /**
  * Asynchronous rename. No arguments other than a possible exception are given
@@ -16,7 +15,7 @@ import { ReadStream, WriteStream } from './streams.js';
  * @param newPath
  * @param callback
  */
-export declare function rename(oldPath: PathLike, newPath: PathLike, cb?: Callback): void;
+export declare function rename(oldPath: fs.PathLike, newPath: fs.PathLike, cb?: Callback): void;
 /**
  * Test whether or not the given path exists by checking with the file system.
  * Then call the callback argument with either true or false.
@@ -24,20 +23,20 @@ export declare function rename(oldPath: PathLike, newPath: PathLike, cb?: Callba
  * @param callback
  * @deprecated Use {@link stat} or {@link access} instead.
  */
-export declare function exists(path: PathLike, cb?: (exists: boolean) => unknown): void;
+export declare function exists(path: fs.PathLike, cb?: (exists: boolean) => unknown): void;
 /**
  * Asynchronous `stat`.
  * @param path
  * @param callback
  */
-export declare function stat(path: PathLike, callback: Callback<[Stats]>): void;
-export declare function stat(path: PathLike, options: {
+export declare function stat(path: fs.PathLike, callback: Callback<[Stats]>): void;
+export declare function stat(path: fs.PathLike, options: {
     bigint?: false;
 }, callback: Callback<[Stats]>): void;
-export declare function stat(path: PathLike, options: {
+export declare function stat(path: fs.PathLike, options: {
     bigint: true;
 }, callback: Callback<[BigIntStats]>): void;
-export declare function stat(path: PathLike, options: Node.StatOptions, callback: Callback<[Stats] | [BigIntStats]>): void;
+export declare function stat(path: fs.PathLike, options: fs.StatOptions, callback: Callback<[Stats] | [BigIntStats]>): void;
 /**
  * Asynchronous `lstat`.
  * `lstat()` is identical to `stat()`, except that if path is a symbolic link,
@@ -45,28 +44,28 @@ export declare function stat(path: PathLike, options: Node.StatOptions, callback
  * @param path
  * @param callback
  */
-export declare function lstat(path: PathLike, callback: Callback<[Stats]>): void;
-export declare function lstat(path: PathLike, options: Node.StatOptions & {
+export declare function lstat(path: fs.PathLike, callback: Callback<[Stats]>): void;
+export declare function lstat(path: fs.PathLike, options: fs.StatOptions & {
     bigint?: false;
 }, callback: Callback<[Stats]>): void;
-export declare function lstat(path: PathLike, options: Node.StatOptions & {
+export declare function lstat(path: fs.PathLike, options: fs.StatOptions & {
     bigint: true;
 }, callback: Callback<[BigIntStats]>): void;
-export declare function lstat(path: PathLike, options: Node.StatOptions, callback: Callback<[Stats | BigIntStats]>): void;
+export declare function lstat(path: fs.PathLike, options: fs.StatOptions, callback: Callback<[Stats | BigIntStats]>): void;
 /**
  * Asynchronous `truncate`.
  * @param path
  * @param len
  * @param callback
  */
-export declare function truncate(path: PathLike, cb?: Callback): void;
-export declare function truncate(path: PathLike, len: number, cb?: Callback): void;
+export declare function truncate(path: fs.PathLike, cb?: Callback): void;
+export declare function truncate(path: fs.PathLike, len: number, cb?: Callback): void;
 /**
  * Asynchronous `unlink`.
  * @param path
  * @param callback
  */
-export declare function unlink(path: PathLike, cb?: Callback): void;
+export declare function unlink(path: fs.PathLike, cb?: Callback): void;
 /**
  * Asynchronous file open.
  * Exclusive mode ensures that path is newly created.
@@ -92,8 +91,8 @@ export declare function unlink(path: PathLike, cb?: Callback): void;
  * @param mode defaults to `0644`
  * @param callback
  */
-export declare function open(path: PathLike, flag: string, cb?: Callback<[number]>): void;
-export declare function open(path: PathLike, flag: string, mode: number | string, cb?: Callback<[number]>): void;
+export declare function open(path: fs.PathLike, flag: string, cb?: Callback<[number]>): void;
+export declare function open(path: fs.PathLike, flag: string, mode: number | string, cb?: Callback<[number]>): void;
 /**
  * Asynchronously reads the entire contents of a file.
  * @param filename
@@ -102,11 +101,11 @@ export declare function open(path: PathLike, flag: string, mode: number | string
  * @option options flag Defaults to `'r'`.
  * @param callback If no encoding is specified, then the raw buffer is returned.
  */
-export declare function readFile(filename: PathLike, cb: Callback<[Uint8Array]>): void;
-export declare function readFile(filename: PathLike, options: {
+export declare function readFile(filename: fs.PathLike, cb: Callback<[Uint8Array]>): void;
+export declare function readFile(filename: fs.PathLike, options: {
     flag?: string;
 }, callback?: Callback<[Uint8Array]>): void;
-export declare function readFile(filename: PathLike, options: {
+export declare function readFile(filename: fs.PathLike, options: {
     encoding: BufferEncoding;
     flag?: string;
 } | BufferEncoding, cb: Callback<[string]>): void;
@@ -124,9 +123,9 @@ export declare function readFile(filename: PathLike, options: {
  * @option flag Defaults to `'w'`.
  * @param callback
  */
-export declare function writeFile(filename: PathLike, data: FileContents, cb?: Callback): void;
-export declare function writeFile(filename: PathLike, data: FileContents, encoding?: BufferEncoding, cb?: Callback): void;
-export declare function writeFile(filename: PathLike, data: FileContents, options?: Node.WriteFileOptions, cb?: Callback): void;
+export declare function writeFile(filename: fs.PathLike, data: FileContents, cb?: Callback): void;
+export declare function writeFile(filename: fs.PathLike, data: FileContents, encoding?: BufferEncoding, cb?: Callback): void;
+export declare function writeFile(filename: fs.PathLike, data: FileContents, options?: fs.WriteFileOptions, cb?: Callback): void;
 /**
  * Asynchronously append data to a file, creating the file if it not yet
  * exists.
@@ -139,13 +138,13 @@ export declare function writeFile(filename: PathLike, data: FileContents, option
  * @option flag Defaults to `'a'`.
  * @param callback
  */
-export declare function appendFile(filename: PathLike, data: FileContents, cb?: Callback): void;
-export declare function appendFile(filename: PathLike, data: FileContents, options?: {
+export declare function appendFile(filename: fs.PathLike, data: FileContents, cb?: Callback): void;
+export declare function appendFile(filename: fs.PathLike, data: FileContents, options?: {
     encoding?: string;
     mode?: number | string;
     flag?: string;
 }, cb?: Callback): void;
-export declare function appendFile(filename: PathLike, data: FileContents, encoding?: string, cb?: Callback): void;
+export declare function appendFile(filename: fs.PathLike, data: FileContents, encoding?: string, cb?: Callback): void;
 /**
  * Asynchronous `fstat`.
  * `fstat()` is identical to `stat()`, except that the file to be stat-ed is
@@ -154,10 +153,10 @@ export declare function appendFile(filename: PathLike, data: FileContents, encod
  * @param callback
  */
 export declare function fstat(fd: number, cb: Callback<[Stats]>): void;
-export declare function fstat(fd: number, options: Node.StatOptions & {
+export declare function fstat(fd: number, options: fs.StatOptions & {
     bigint?: false;
 }, cb: Callback<[Stats]>): void;
-export declare function fstat(fd: number, options: Node.StatOptions & {
+export declare function fstat(fd: number, options: fs.StatOptions & {
     bigint: true;
 }, cb: Callback<[BigIntStats]>): void;
 /**
@@ -247,14 +246,14 @@ export declare function futimes(fd: number, atime: number | Date, mtime: number
  * @param path
  * @param callback
  */
-export declare function rmdir(path: PathLike, cb?: Callback): void;
+export declare function rmdir(path: fs.PathLike, cb?: Callback): void;
 /**
  * Asynchronous `mkdir`.
  * @param path
  * @param mode defaults to `0777`
  * @param callback
  */
-export declare function mkdir(path: PathLike, mode?: Node.Mode, cb?: Callback): void;
+export declare function mkdir(path: fs.PathLike, mode?: fs.Mode, cb?: Callback): void;
 /**
  * Asynchronous `readdir`. Reads the contents of a directory.
  * The callback gets two arguments `(err, files)` where `files` is an array of
@@ -262,11 +261,11 @@ export declare function mkdir(path: PathLike, mode?: Node.Mode, cb?: Callback):
  * @param path
  * @param callback
  */
-export declare function readdir(path: PathLike, cb: Callback<[string[]]>): void;
-export declare function readdir(path: PathLike, options: {
+export declare function readdir(path: fs.PathLike, cb: Callback<[string[]]>): void;
+export declare function readdir(path: fs.PathLike, options: {
     withFileTypes?: false;
 }, cb: Callback<[string[]]>): void;
-export declare function readdir(path: PathLike, options: {
+export declare function readdir(path: fs.PathLike, options: {
     withFileTypes: true;
 }, cb: Callback<[Dirent[]]>): void;
 /**
@@ -275,7 +274,7 @@ export declare function readdir(path: PathLike, options: {
  * @param newpath
  * @param callback
  */
-export declare function link(existing: PathLike, newpath: PathLike, cb?: Callback): void;
+export declare function link(existing: fs.PathLike, newpath: fs.PathLike, cb?: Callback): void;
 /**
  * Asynchronous `symlink`.
  * @param target target path
@@ -283,17 +282,17 @@ export declare function link(existing: PathLike, newpath: PathLike, cb?: Callbac
  * @param type can be either `'dir'` or `'file'` (default is `'file'`)
  * @param callback
  */
-export declare function symlink(target: PathLike, path: PathLike, cb?: Callback): void;
-export declare function symlink(target: PathLike, path: PathLike, type?: Node.symlink.Type, cb?: Callback): void;
+export declare function symlink(target: fs.PathLike, path: fs.PathLike, cb?: Callback): void;
+export declare function symlink(target: fs.PathLike, path: fs.PathLike, type?: fs.symlink.Type, cb?: Callback): void;
 /**
  * Asynchronous readlink.
  * @param path
  * @param callback
  */
-export declare function readlink(path: PathLike, callback: Callback<[string]> & any): void;
-export declare function readlink(path: PathLike, options: Node.BufferEncodingOption, callback: Callback<[Uint8Array]>): void;
-export declare function readlink(path: PathLike, options: Node.EncodingOption, callback: Callback<[string | Uint8Array]>): void;
-export declare function readlink(path: PathLike, options: Node.EncodingOption, callback: Callback<[string]>): void;
+export declare function readlink(path: fs.PathLike, callback: Callback<[string]> & any): void;
+export declare function readlink(path: fs.PathLike, options: fs.BufferEncodingOption, callback: Callback<[Uint8Array]>): void;
+export declare function readlink(path: fs.PathLike, options: fs.EncodingOption, callback: Callback<[string | Uint8Array]>): void;
+export declare function readlink(path: fs.PathLike, options: fs.EncodingOption, callback: Callback<[string]>): void;
 /**
  * Asynchronous `chown`.
  * @param path
@@ -301,7 +300,7 @@ export declare function readlink(path: PathLike, options: Node.EncodingOption, c
  * @param gid
  * @param callback
  */
-export declare function chown(path: PathLike, uid: number, gid: number, cb?: Callback): void;
+export declare function chown(path: fs.PathLike, uid: number, gid: number, cb?: Callback): void;
 /**
  * Asynchronous `lchown`.
  * @param path
@@ -309,21 +308,21 @@ export declare function chown(path: PathLike, uid: number, gid: number, cb?: Cal
  * @param gid
  * @param callback
  */
-export declare function lchown(path: PathLike, uid: number, gid: number, cb?: Callback): void;
+export declare function lchown(path: fs.PathLike, uid: number, gid: number, cb?: Callback): void;
 /**
  * Asynchronous `chmod`.
  * @param path
  * @param mode
  * @param callback
  */
-export declare function chmod(path: PathLike, mode: number | string, cb?: Callback): void;
+export declare function chmod(path: fs.PathLike, mode: number | string, cb?: Callback): void;
 /**
  * Asynchronous `lchmod`.
  * @param path
  * @param mode
  * @param callback
  */
-export declare function lchmod(path: PathLike, mode: number | string, cb?: Callback): void;
+export declare function lchmod(path: fs.PathLike, mode: number | string, cb?: Callback): void;
 /**
  * Change file timestamps of the file referenced by the supplied path.
  * @param path
@@ -331,7 +330,7 @@ export declare function lchmod(path: PathLike, mode: number | string, cb?: Callb
  * @param mtime
  * @param callback
  */
-export declare function utimes(path: PathLike, atime: number | Date, mtime: number | Date, cb?: Callback): void;
+export declare function utimes(path: fs.PathLike, atime: number | Date, mtime: number | Date, cb?: Callback): void;
 /**
  * Change file timestamps of the file referenced by the supplied path.
  * @param path
@@ -339,7 +338,7 @@ export declare function utimes(path: PathLike, atime: number | Date, mtime: numb
  * @param mtime
  * @param callback
  */
-export declare function lutimes(path: PathLike, atime: number | Date, mtime: number | Date, cb?: Callback): void;
+export declare function lutimes(path: fs.PathLike, atime: number | Date, mtime: number | Date, cb?: Callback): void;
 /**
  * Asynchronous `realpath`. The callback gets two arguments
  * `(err, resolvedPath)`. May use `process.cwd` to resolve relative paths.
@@ -347,35 +346,35 @@ export declare function lutimes(path: PathLike, atime: number | Date, mtime: num
  * @param path
  * @param callback
  */
-export declare function realpath(path: PathLike, cb?: Callback<[string]>): void;
-export declare function realpath(path: PathLike, options: Node.EncodingOption, cb: Callback<[string]>): void;
+export declare function realpath(path: fs.PathLike, cb?: Callback<[string]>): void;
+export declare function realpath(path: fs.PathLike, options: fs.EncodingOption, cb: Callback<[string]>): void;
 /**
  * Asynchronous `access`.
  * @param path
  * @param mode
  * @param callback
  */
-export declare function access(path: PathLike, cb: Callback): void;
-export declare function access(path: PathLike, mode: number, cb: Callback): void;
+export declare function access(path: fs.PathLike, cb: Callback): void;
+export declare function access(path: fs.PathLike, mode: number, cb: Callback): void;
 /**
  * @todo Implement
  */
-export declare function watchFile(filename: PathLike, listener: (curr: Stats, prev: Stats) => void): void;
-export declare function watchFile(filename: PathLike, options: {
+export declare function watchFile(path: fs.PathLike, listener: (curr: Stats, prev: Stats) => void): void;
+export declare function watchFile(path: fs.PathLike, options: {
     persistent?: boolean;
     interval?: number;
 }, listener: (curr: Stats, prev: Stats) => void): void;
 /**
  * @todo Implement
  */
-export declare function unwatchFile(filename: PathLike, listener?: (curr: Stats, prev: Stats) => void): void;
+export declare function unwatchFile(path: fs.PathLike, listener?: (curr: Stats, prev: Stats) => void): void;
 /**
  * @todo Implement
  */
-export declare function watch(filename: PathLike, listener?: (event: string, filename: string) => any): Node.FSWatcher;
-export declare function watch(filename: PathLike, options: {
+export declare function watch(path: fs.PathLike, listener?: (event: string, filename: string) => any): fs.FSWatcher;
+export declare function watch(path: fs.PathLike, options: {
     persistent?: boolean;
-}, listener?: (event: string, filename: string) => any): Node.FSWatcher;
+}, listener?: (event: string, filename: string) => any): fs.FSWatcher;
 interface StreamOptions {
     flags?: string;
     encoding?: BufferEncoding;
@@ -388,19 +387,19 @@ interface StreamOptions {
     highWaterMark?: number;
 }
 interface FSImplementation {
-    open?: (...args: any[]) => unknown;
-    close?: (...args: any[]) => unknown;
+    open?: (...args: unknown[]) => unknown;
+    close?: (...args: unknown[]) => unknown;
 }
 interface ReadStreamOptions extends StreamOptions {
     fs?: FSImplementation & {
-        read: (...args: any[]) => unknown;
+        read: (...args: unknown[]) => unknown;
     };
     end?: number;
 }
 interface WriteStreamOptions extends StreamOptions {
     fs?: FSImplementation & {
-        write: (...args: any[]) => unknown;
-        writev?: (...args: any[]) => unknown;
+        write: (...args: unknown[]) => unknown;
+        writev?: (...args: unknown[]) => unknown;
     };
     flush?: boolean;
 }
@@ -411,7 +410,7 @@ interface WriteStreamOptions extends StreamOptions {
  * @param options Options for the ReadStream and file opening (e.g., `encoding`, `highWaterMark`, `mode`).
  * @returns A ReadStream object for interacting with the file's contents.
  */
-export declare function createReadStream(path: PathLike, _options?: BufferEncoding | ReadStreamOptions): ReadStream;
+export declare function createReadStream(path: fs.PathLike, _options?: BufferEncoding | ReadStreamOptions): ReadStream;
 /**
  * Opens a file in write mode and creates a Node.js-like WriteStream.
  *
@@ -419,34 +418,34 @@ export declare function createReadStream(path: PathLike, _options?: BufferEncodi
  * @param options Options for the WriteStream and file opening (e.g., `encoding`, `highWaterMark`, `mode`).
  * @returns A WriteStream object for writing to the file.
  */
-export declare function createWriteStream(path: PathLike, _options?: BufferEncoding | WriteStreamOptions): WriteStream;
-export declare function rm(path: PathLike, callback: Callback): void;
-export declare function rm(path: PathLike, options: Node.RmOptions, callback: Callback): void;
+export declare function createWriteStream(path: fs.PathLike, _options?: BufferEncoding | WriteStreamOptions): WriteStream;
+export declare function rm(path: fs.PathLike, callback: Callback): void;
+export declare function rm(path: fs.PathLike, options: fs.RmOptions, callback: Callback): void;
 /**
  * Asynchronously creates a unique temporary directory.
  * Generates six random characters to be appended behind a required prefix to create a unique temporary directory.
  */
 export declare function mkdtemp(prefix: string, callback: Callback<[string]>): void;
-export declare function mkdtemp(prefix: string, options: Node.EncodingOption, callback: Callback<[string]>): void;
-export declare function mkdtemp(prefix: string, options: Node.BufferEncodingOption, callback: Callback<[Buffer]>): void;
-export declare function copyFile(src: PathLike, dest: PathLike, callback: Callback): void;
-export declare function copyFile(src: PathLike, dest: PathLike, flags: number, callback: Callback): void;
+export declare function mkdtemp(prefix: string, options: fs.EncodingOption, callback: Callback<[string]>): void;
+export declare function mkdtemp(prefix: string, options: fs.BufferEncodingOption, callback: Callback<[Buffer]>): void;
+export declare function copyFile(src: fs.PathLike, dest: fs.PathLike, callback: Callback): void;
+export declare function copyFile(src: fs.PathLike, dest: fs.PathLike, flags: number, callback: Callback): void;
 type readvCb = Callback<[number, NodeJS.ArrayBufferView[]]>;
 export declare function readv(fd: number, buffers: NodeJS.ArrayBufferView[], cb: readvCb): void;
 export declare function readv(fd: number, buffers: NodeJS.ArrayBufferView[], position: number, cb: readvCb): void;
 type writevCb = Callback<[number, NodeJS.ArrayBufferView[]]>;
 export declare function writev(fd: number, buffers: Uint8Array[], cb: writevCb): void;
 export declare function writev(fd: number, buffers: Uint8Array[], position: number, cb: writevCb): void;
-export declare function opendir(path: PathLike, cb: Callback<[Dir]>): void;
-export declare function opendir(path: PathLike, options: Node.OpenDirOptions, cb: Callback<[Dir]>): void;
-export declare function cp(source: PathLike, destination: PathLike, callback: Callback): void;
-export declare function cp(source: PathLike, destination: PathLike, opts: Node.CopyOptions, callback: Callback): void;
-export declare function statfs(path: PathLike, callback: Callback<[StatsFs]>): void;
-export declare function statfs(path: PathLike, options: Node.StatFsOptions & {
+export declare function opendir(path: fs.PathLike, cb: Callback<[Dir]>): void;
+export declare function opendir(path: fs.PathLike, options: fs.OpenDirOptions, cb: Callback<[Dir]>): void;
+export declare function cp(source: fs.PathLike, destination: fs.PathLike, callback: Callback): void;
+export declare function cp(source: fs.PathLike, destination: fs.PathLike, opts: fs.CopyOptions, callback: Callback): void;
+export declare function statfs(path: fs.PathLike, callback: Callback<[StatsFs]>): void;
+export declare function statfs(path: fs.PathLike, options: fs.StatFsOptions & {
     bigint?: false;
 }, callback: Callback<[StatsFs]>): void;
-export declare function statfs(path: PathLike, options: Node.StatFsOptions & {
+export declare function statfs(path: fs.PathLike, options: fs.StatFsOptions & {
     bigint: true;
 }, callback: Callback<[BigIntStatsFs]>): void;
-export declare function openAsBlob(path: PathLike, options?: Node.OpenAsBlobOptions): Promise<Blob>;
+export declare function openAsBlob(path: fs.PathLike, options?: fs.OpenAsBlobOptions): Promise<Blob>;
 export {};