@zenfs/core 0.5.5 → 0.5.7

package/dist/emulation/{callbacks.d.ts → async.d.ts}

@@ -1,11 +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 { TwoArgCallback, NoArgCallback, ThreeArgCallback, FileContents } from '../filesystem.js';
-import { BigIntStats, type Stats } from '../stats.js';
+import { FileContents, NoArgCallback, ThreeArgCallback, TwoArgCallback } from '../filesystem.js';
+import { BigIntStats, type BigIntStatsFs, type Stats, type StatsFs } from '../stats.js';
+import { Dirent, type Dir } from './dir.js';
 import { PathLike } from './shared.js';
 import { ReadStream, WriteStream } from './streams.js';
-import { Dirent } from './dir.js';
 /**
  * Asynchronous rename. No arguments other than a possible exception are given
  * to the completion callback.
@@ -19,6 +20,7 @@ export declare function rename(oldPath: PathLike, newPath: PathLike, cb?: NoArgC
  * Then call the callback argument with either true or false.
  * @param path
  * @param callback
+ * @deprecated Use {@link stat} or {@link access} instead.
  */
 export declare function exists(path: PathLike, cb?: (exists: boolean) => unknown): void;
 /**
@@ -102,7 +104,7 @@ export declare function readFile(filename: PathLike, cb: TwoArgCallback<Uint8Arr
 export declare function readFile(filename: PathLike, options: {
     flag?: string;
 }, callback?: TwoArgCallback<Uint8Array>): void;
-export declare function readFile(filename: PathLike, optios: {
+export declare function readFile(filename: PathLike, options: {
     encoding: BufferEncoding;
     flag?: string;
 } | BufferEncoding, cb: TwoArgCallback<string>): void;
@@ -197,9 +199,9 @@ export declare function fdatasync(fd: number, cb?: NoArgCallback): void;
  * @param callback The number specifies the number of bytes written into the file.
  */
 export declare function write(fd: number, buffer: Uint8Array, offset: number, length: number, cb?: ThreeArgCallback<number, Uint8Array>): void;
-export declare function write(fd: number, buffer: Uint8Array, offset: number, length: number, position: number | null, cb?: ThreeArgCallback<number, Uint8Array>): void;
+export declare function write(fd: number, buffer: Uint8Array, offset: number, length: number, position?: number, cb?: ThreeArgCallback<number, Uint8Array>): void;
 export declare function write(fd: number, data: FileContents, cb?: ThreeArgCallback<number, string>): void;
-export declare function write(fd: number, data: FileContents, position: number | null, cb?: ThreeArgCallback<number, string>): void;
+export declare function write(fd: number, data: FileContents, position?: number, cb?: ThreeArgCallback<number, string>): void;
 export declare function write(fd: number, data: FileContents, position: number | null, encoding: BufferEncoding, cb?: ThreeArgCallback<number, string>): void;
 /**
  * Read data from the file specified by `fd`.
@@ -288,8 +290,8 @@ export declare function symlink(target: PathLike, path: PathLike, type?: Node.sy
  */
 export declare function readlink(path: PathLike, callback: TwoArgCallback<string> & any): void;
 export declare function readlink(path: PathLike, options: Node.BufferEncodingOption, callback: TwoArgCallback<Uint8Array>): void;
-export declare function readlink(path: PathLike, options: Node.BaseEncodingOptions | string, callback: TwoArgCallback<string | Uint8Array>): void;
-export declare function readlink(path: PathLike, options: Node.BaseEncodingOptions | BufferEncoding, callback: TwoArgCallback<string>): void;
+export declare function readlink(path: PathLike, options: Node.EncodingOption, callback: TwoArgCallback<string | Uint8Array>): void;
+export declare function readlink(path: PathLike, options: Node.EncodingOption, callback: TwoArgCallback<string>): void;
 /**
  * Asynchronous `chown`.
  * @param path
@@ -344,7 +346,7 @@ export declare function lutimes(path: PathLike, atime: number | Date, mtime: num
  * @param callback
  */
 export declare function realpath(path: PathLike, cb?: TwoArgCallback<string>): void;
-export declare function realpath(path: PathLike, options: Node.BaseEncodingOptions, cb: TwoArgCallback<string>): void;
+export declare function realpath(path: PathLike, options: Node.EncodingOption, cb: TwoArgCallback<string>): void;
 /**
  * Asynchronous `access`.
  * @param path
@@ -353,16 +355,28 @@ export declare function realpath(path: PathLike, options: Node.BaseEncodingOptio
  */
 export declare function access(path: PathLike, cb: NoArgCallback): void;
 export declare function access(path: PathLike, mode: number, cb: NoArgCallback): void;
+/**
+ * @todo Implement
+ */
 export declare function watchFile(filename: PathLike, listener: (curr: Stats, prev: Stats) => void): void;
 export declare function watchFile(filename: 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;
+/**
+ * @todo Implement
+ */
 export declare function watch(filename: PathLike, listener?: (event: string, filename: string) => any): Node.FSWatcher;
 export declare function watch(filename: PathLike, options: {
     persistent?: boolean;
 }, listener?: (event: string, filename: string) => any): Node.FSWatcher;
+/**
+ * @todo Implement
+ */
 export declare function createReadStream(path: PathLike, options?: {
     flags?: string;
     encoding?: string;
@@ -370,19 +384,42 @@ export declare function createReadStream(path: PathLike, options?: {
     mode?: number;
     autoClose?: boolean;
 }): ReadStream;
+/**
+ * @todo Implement
+ */
 export declare function createWriteStream(path: PathLike, options?: {
     flags?: string;
     encoding?: string;
     fd?: number;
     mode?: number;
 }): WriteStream;
-export declare function rm(path: PathLike): void;
-export declare function mkdtemp(path: PathLike): void;
+export declare function rm(path: PathLike, callback: NoArgCallback): void;
+export declare function rm(path: PathLike, options: Node.RmOptions, callback: NoArgCallback): 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: TwoArgCallback<string>): void;
+export declare function mkdtemp(prefix: string, options: Node.EncodingOption, callback: TwoArgCallback<string>): void;
+export declare function mkdtemp(prefix: string, options: Node.BufferEncodingOption, callback: TwoArgCallback<Buffer>): void;
 export declare function copyFile(src: PathLike, dest: PathLike, callback: NoArgCallback): void;
 export declare function copyFile(src: PathLike, dest: PathLike, flags: number, callback: NoArgCallback): void;
-export declare function readv(path: PathLike): void;
-type writevCallback = ThreeArgCallback<number, Uint8Array[]>;
-export declare function writev(fd: number, buffers: Uint8Array[], cb: writevCallback): void;
-export declare function writev(fd: number, buffers: Uint8Array[], position: number, cb: writevCallback): void;
-export declare function opendir(path: PathLike): void;
+type readvCb = ThreeArgCallback<number, NodeJS.ArrayBufferView[]>;
+export declare function readv(fd: number, buffers: readonly NodeJS.ArrayBufferView[], cb: readvCb): void;
+export declare function readv(fd: number, buffers: readonly NodeJS.ArrayBufferView[], position: number, cb: readvCb): void;
+type writevCb = ThreeArgCallback<number, NodeJS.ArrayBufferView[]>;
+export declare function writev(fd: number, buffers: NodeJS.ArrayBufferView[], cb: writevCb): void;
+export declare function writev(fd: number, buffers: NodeJS.ArrayBufferView[], position: number, cb: writevCb): void;
+export declare function opendir(path: PathLike, cb: TwoArgCallback<Dir>): void;
+export declare function opendir(path: PathLike, options: Node.OpenDirOptions, cb: TwoArgCallback<Dir>): void;
+export declare function cp(source: PathLike, destination: PathLike, callback: NoArgCallback): void;
+export declare function cp(source: PathLike, destination: PathLike, opts: Node.CopyOptions, callback: NoArgCallback): void;
+export declare function statfs(path: PathLike, callback: TwoArgCallback<StatsFs>): void;
+export declare function statfs(path: PathLike, options: Node.StatFsOptions & {
+    bigint?: false;
+}, callback: TwoArgCallback<StatsFs>): void;
+export declare function statfs(path: PathLike, options: Node.StatFsOptions & {
+    bigint: true;
+}, callback: TwoArgCallback<BigIntStatsFs>): void;
+export declare function openAsBlob(path: PathLike, options?: Node.OpenAsBlobOptions): Promise<Blob>;
 export {};

package/dist/emulation/{callbacks.js → async.js}

@@ -1,9 +1,8 @@
 import { ApiError, ErrorCode } from '../ApiError.js';
 import { BigIntStats } from '../stats.js';
-import { fd2file, nop, normalizeMode } from './shared.js';
-import * as promises from './promises.js';
 import { R_OK } from './constants.js';
-import { decode, encode } from '../utils.js';
+import * as promises from './promises.js';
+import { fd2file, nop, normalizeMode } from './shared.js';
 /**
  * Asynchronous rename. No arguments other than a possible exception are given
  * to the completion callback.
@@ -23,6 +22,7 @@ rename;
  * Then call the callback argument with either true or false.
  * @param path
  * @param callback
+ * @deprecated Use {@link stat} or {@link access} instead.
  */
 export function exists(path, cb = nop) {
     promises
@@ -47,9 +47,9 @@ export function lstat(path, options, callback = nop) {
         .catch(callback);
 }
 lstat;
-export function truncate(path, arg2 = 0, cb = nop) {
-    cb = typeof arg2 === 'function' ? arg2 : cb;
-    const len = typeof arg2 === 'number' ? arg2 : 0;
+export function truncate(path, cbLen = 0, cb = nop) {
+    cb = typeof cbLen === 'function' ? cbLen : cb;
+    const len = typeof cbLen === 'number' ? cbLen : 0;
     promises
         .truncate(path, len)
         .then(() => cb())
@@ -68,9 +68,9 @@ export function unlink(path, cb = nop) {
         .catch(cb);
 }
 unlink;
-export function open(path, flag, arg2, cb = nop) {
-    const mode = normalizeMode(arg2, 0o644);
-    cb = typeof arg2 === 'function' ? arg2 : cb;
+export function open(path, flag, cbMode, cb = nop) {
+    const mode = normalizeMode(cbMode, 0o644);
+    cb = typeof cbMode === 'function' ? cbMode : cb;
     promises
         .open(path, flag, mode)
         .then(handle => cb(null, handle.fd))
@@ -85,17 +85,20 @@ export function readFile(filename, options, cb = nop) {
         .catch(cb);
 }
 readFile;
-export function writeFile(filename, data, arg3, cb = nop) {
-    cb = typeof arg3 === 'function' ? arg3 : cb;
+export function writeFile(filename, data, cbEncOpts, cb = nop) {
+    cb = typeof cbEncOpts === 'function' ? cbEncOpts : cb;
     promises
-        .writeFile(filename, data, typeof arg3 != 'function' ? arg3 : null)
+        .writeFile(filename, data, typeof cbEncOpts != 'function' ? cbEncOpts : null)
         .then(() => cb(null))
         .catch(cb);
 }
 writeFile;
-export function appendFile(filename, data, arg3, cb = nop) {
-    cb = typeof arg3 === 'function' ? arg3 : cb;
-    promises.appendFile(filename, data, typeof arg3 === 'function' ? null : arg3);
+export function appendFile(filename, data, cbEncOpts, cb = nop) {
+    cb = typeof cbEncOpts === 'function' ? cbEncOpts : cb;
+    promises
+        .appendFile(filename, data, typeof cbEncOpts === 'function' ? null : cbEncOpts)
+        .then(() => cb())
+        .catch(cb);
 }
 appendFile;
 export function fstat(fd, options, cb = nop) {
@@ -154,45 +157,45 @@ export function fdatasync(fd, cb = nop) {
         .catch(cb);
 }
 fdatasync;
-export function write(fd, arg2, arg3, arg4, arg5, cb = nop) {
+export function write(fd, data, cbPosOff, cbLenEnc, cbPos, cb = nop) {
     let buffer, offset, length, position = null, encoding;
     const handle = new promises.FileHandle(fd);
-    if (typeof arg2 === 'string') {
+    if (typeof data === 'string') {
         // Signature 1: (fd, string, [position?, [encoding?]], cb?)
         encoding = 'utf8';
-        switch (typeof arg3) {
+        switch (typeof cbPosOff) {
             case 'function':
                 // (fd, string, cb)
-                cb = arg3;
+                cb = cbPosOff;
                 break;
             case 'number':
                 // (fd, string, position, encoding?, cb?)
-                position = arg3;
-                encoding = (typeof arg4 === 'string' ? arg4 : 'utf8');
-                cb = typeof arg5 === 'function' ? arg5 : cb;
+                position = cbPosOff;
+                encoding = (typeof cbLenEnc === 'string' ? cbLenEnc : 'utf8');
+                cb = typeof cbPos === 'function' ? cbPos : cb;
                 break;
             default:
                 // ...try to find the callback and get out of here!
-                cb = typeof arg4 === 'function' ? arg4 : typeof arg5 === 'function' ? arg5 : cb;
+                cb = typeof cbLenEnc === 'function' ? cbLenEnc : typeof cbPos === 'function' ? cbPos : cb;
                 cb(new ApiError(ErrorCode.EINVAL, 'Invalid arguments.'));
                 return;
         }
-        buffer = encode(arg2);
+        buffer = Buffer.from(data);
         offset = 0;
         length = buffer.length;
         const _cb = cb;
         handle
             .write(buffer, offset, length, position)
-            .then(({ bytesWritten }) => _cb(null, bytesWritten, decode(buffer)))
+            .then(({ bytesWritten }) => _cb(null, bytesWritten, buffer.toString(encoding)))
             .catch(_cb);
     }
     else {
         // Signature 2: (fd, buffer, offset, length, position?, cb?)
-        buffer = arg2;
-        offset = arg3;
-        length = arg4;
-        position = typeof arg5 === 'number' ? arg5 : null;
-        const _cb = (typeof arg5 === 'function' ? arg5 : cb);
+        buffer = Buffer.from(data);
+        offset = cbPosOff;
+        length = cbLenEnc;
+        position = typeof cbPos === 'number' ? cbPos : null;
+        const _cb = (typeof cbPos === 'function' ? cbPos : cb);
         handle
             .write(buffer, offset, length, position)
             .then(({ bytesWritten }) => _cb(null, bytesWritten, buffer))
@@ -416,45 +419,111 @@ export function realpath(path, arg2, cb = nop) {
         .catch(cb);
 }
 realpath;
-export function access(path, arg2, cb = nop) {
-    const mode = typeof arg2 === 'number' ? arg2 : R_OK;
-    cb = typeof arg2 === 'function' ? arg2 : cb;
+export function access(path, cbMode, cb = nop) {
+    const mode = typeof cbMode === 'number' ? cbMode : R_OK;
+    cb = typeof cbMode === 'function' ? cbMode : cb;
     promises
-        .access(path, typeof arg2 === 'function' ? null : arg2)
+        .access(path, typeof cbMode === 'function' ? null : cbMode)
         .then(() => cb())
         .catch(cb);
 }
 access;
-export function watchFile(filename, arg2, listener = nop) {
-    throw new ApiError(ErrorCode.ENOTSUP);
+export function watchFile(filename, optsListener, listener = nop) {
+    throw ApiError.With('ENOTSUP', filename, 'watchFile');
 }
+watchFile;
+/**
+ * @todo Implement
+ */
 export function unwatchFile(filename, listener = nop) {
-    throw new ApiError(ErrorCode.ENOTSUP);
+    throw ApiError.With('ENOTSUP', filename, 'unwatchFile');
 }
-export function watch(filename, arg2, listener = nop) {
-    throw new ApiError(ErrorCode.ENOTSUP);
+unwatchFile;
+export function watch(filename, options, listener = nop) {
+    throw ApiError.With('ENOTSUP', filename, 'watch');
 }
+watch;
+/**
+ * @todo Implement
+ */
 export function createReadStream(path, options) {
-    throw new ApiError(ErrorCode.ENOTSUP);
+    throw ApiError.With('ENOTSUP', path, 'createReadStream');
 }
+createReadStream;
+/**
+ * @todo Implement
+ */
 export function createWriteStream(path, options) {
-    throw new ApiError(ErrorCode.ENOTSUP);
+    throw ApiError.With('ENOTSUP', path, 'createWriteStream');
 }
-export function rm(path) {
-    new ApiError(ErrorCode.ENOTSUP);
+createWriteStream;
+export function rm(path, options, callback = nop) {
+    callback = typeof options === 'function' ? options : callback;
+    promises
+        .rm(path, typeof options === 'function' ? null : options)
+        .then(() => callback(null))
+        .catch(callback);
 }
-export function mkdtemp(path) {
-    new ApiError(ErrorCode.ENOTSUP);
+rm;
+export function mkdtemp(prefix, options, callback = nop) {
+    callback = typeof options === 'function' ? options : callback;
+    promises
+        .mkdtemp(prefix, typeof options != 'function' ? options : null)
+        .then(result => callback(null, result))
+        .catch(callback);
 }
+mkdtemp;
 export function copyFile(src, dest, flags, callback) {
-    new ApiError(ErrorCode.ENOTSUP);
+    callback = typeof flags === 'function' ? flags : callback;
+    promises
+        .copyFile(src, dest, typeof flags === 'function' ? null : flags)
+        .then(() => callback(null))
+        .catch(callback);
+}
+copyFile;
+export function readv(fd, buffers, position, cb = nop) {
+    cb = typeof position === 'function' ? position : cb;
+    new promises.FileHandle(fd)
+        .readv(buffers, typeof position === 'function' ? null : position)
+        .then(({ buffers, bytesRead }) => cb(null, bytesRead, buffers))
+        .catch(cb);
 }
-export function readv(path) {
-    new ApiError(ErrorCode.ENOTSUP);
+readv;
+export function writev(fd, buffers, position, cb = nop) {
+    cb = typeof position === 'function' ? position : cb;
+    new promises.FileHandle(fd)
+        .writev(buffers, typeof position === 'function' ? null : position)
+        .then(({ buffers, bytesWritten }) => cb(null, bytesWritten, buffers))
+        .catch(cb);
 }
-export function writev(fd, buffers, position, cb) {
-    throw new ApiError(ErrorCode.ENOTSUP);
+writev;
+export function opendir(path, options, cb = nop) {
+    cb = typeof options === 'function' ? options : cb;
+    promises
+        .opendir(path, typeof options === 'function' ? null : options)
+        .then(result => cb(null, result))
+        .catch(cb);
+}
+opendir;
+export function cp(source, destination, opts, callback) {
+    callback = typeof opts === 'function' ? opts : callback;
+    promises
+        .cp(source, destination, typeof opts === 'function' ? null : opts)
+        .then(() => callback(null))
+        .catch(callback);
+}
+cp;
+export function statfs(path, options, callback = nop) {
+    callback = typeof options === 'function' ? options : callback;
+    promises
+        .statfs(path, typeof options === 'function' ? null : options)
+        .then(result => callback(null, result))
+        .catch(callback);
 }
-export function opendir(path) {
-    throw new ApiError(ErrorCode.ENOTSUP);
+statfs;
+/* eslint-disable @typescript-eslint/no-unused-vars */
+export function openAsBlob(path, options) {
+    throw ApiError.With('ENOTSUP', path, 'openAsBlob');
 }
+openAsBlob;
+/* eslint-enable @typescript-eslint/no-unused-vars */

package/dist/emulation/constants.d.ts

@@ -105,3 +105,8 @@ export declare const S_IROTH = 4;
 export declare const S_IWOTH = 2;
 /** File mode indicating executable by others. */
 export declare const S_IXOTH = 1;
+/**
+ * When set, a memory file mapping is used to access the file.
+ * This flag is ignored since a unix-like FS is emulated
+ */
+export declare const UV_FS_O_FILEMAP = 0;

package/dist/emulation/constants.js

@@ -117,3 +117,8 @@ export const S_IROTH = 4;
 export const S_IWOTH = 2;
 /** File mode indicating executable by others. */
 export const S_IXOTH = 1;
+/**
+ * When set, a memory file mapping is used to access the file.
+ * This flag is ignored since a unix-like FS is emulated
+ */
+export const UV_FS_O_FILEMAP = 0;

package/dist/emulation/dir.d.ts

@@ -3,9 +3,10 @@ import type { Dirent as _Dirent, Dir as _Dir } from 'fs';
 import type { NoArgCallback, TwoArgCallback } from '../filesystem.js';
 import type { Stats } from '../stats.js';
 export declare class Dirent implements _Dirent {
-    name: string;
+    path: string;
     protected stats: Stats;
-    constructor(name: string, stats: Stats);
+    get name(): string;
+    constructor(path: string, stats: Stats);
     isFile(): boolean;
     isDirectory(): boolean;
     isBlockDevice(): boolean;

package/dist/emulation/dir.js

@@ -1,9 +1,13 @@
 import { readdir } from './promises.js';
 import { ApiError, ErrorCode } from '../ApiError.js';
 import { readdirSync } from './sync.js';
+import { basename } from './path.js';
 export class Dirent {
-    constructor(name, stats) {
-        this.name = name;
+    get name() {
+        return basename(this.path);
+    }
+    constructor(path, stats) {
+        this.path = path;
         this.stats = stats;
     }
     isFile() {

package/dist/emulation/index.d.ts

@@ -1,8 +1,8 @@
-export * from './callbacks.js';
+export * from './async.js';
 export * from './sync.js';
 export * as promises from './promises.js';
 export * as constants from './constants.js';
 export * from './streams.js';
 export * from './dir.js';
 export { initialize, mounts, mount, umount, _toUnixTimestamp } from './shared.js';
-export { Stats, BigIntStats } from '../stats.js';
+export { Stats, BigIntStats, StatsFs } from '../stats.js';

package/dist/emulation/index.js

@@ -1,8 +1,8 @@
-export * from './callbacks.js';
+export * from './async.js';
 export * from './sync.js';
 export * as promises from './promises.js';
 export * as constants from './constants.js';
 export * from './streams.js';
 export * from './dir.js';
 export { initialize, mounts, mount, umount, _toUnixTimestamp } from './shared.js';
-export { Stats, BigIntStats } from '../stats.js';
+export { Stats, BigIntStats, StatsFs } from '../stats.js';