@zenfs/core 0.8.0 → 0.9.0

package/dist/emulation/async.d.ts

@@ -4,8 +4,9 @@
 import type * as Node from '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 { 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';
 /**
@@ -375,25 +376,50 @@ export declare function watch(filename: PathLike, listener?: (event: string, fil
 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?: {
+interface StreamOptions {
     flags?: string;
-    encoding?: string;
-    fd?: number;
+    encoding?: BufferEncoding;
+    fd?: number | promises.FileHandle;
     mode?: number;
     autoClose?: boolean;
-}): ReadStream;
+    emitClose?: boolean;
+    start?: number;
+    signal?: AbortSignal;
+    highWaterMark?: number;
+}
+interface FSImplementation {
+    open?: (...args: any[]) => unknown;
+    close?: (...args: any[]) => unknown;
+}
+interface ReadStreamOptions extends StreamOptions {
+    fs?: FSImplementation & {
+        read: (...args: any[]) => unknown;
+    };
+    end?: number;
+}
+interface WriteStreamOptions extends StreamOptions {
+    fs?: FSImplementation & {
+        write: (...args: any[]) => unknown;
+        writev?: (...args: any[]) => unknown;
+    };
+    flush?: boolean;
+}
+/**
+ * Opens a file in read mode and creates a Node.js-like ReadStream.
+ *
+ * @param path The path to the file to be opened.
+ * @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;
 /**
- * @todo Implement
+ * Opens a file in write mode and creates a Node.js-like WriteStream.
+ *
+ * @param path The path to the file to be opened.
+ * @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?: {
-    flags?: string;
-    encoding?: string;
-    fd?: number;
-    mode?: number;
-}): WriteStream;
+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;
 /**
@@ -406,11 +432,11 @@ export declare function mkdtemp(prefix: string, options: Node.BufferEncodingOpti
 export declare function copyFile(src: PathLike, dest: PathLike, callback: Callback): void;
 export declare function copyFile(src: PathLike, dest: PathLike, flags: number, callback: Callback): void;
 type readvCb = Callback<[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;
+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: NodeJS.ArrayBufferView[], cb: writevCb): void;
-export declare function writev(fd: number, buffers: NodeJS.ArrayBufferView[], position: number, cb: writevCb): void;
+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;
@@ -422,5 +448,4 @@ export declare function statfs(path: PathLike, options: Node.StatFsOptions & {
 export declare function statfs(path: PathLike, options: Node.StatFsOptions & {
     bigint: true;
 }, callback: Callback<[BigIntStatsFs]>): void;
-export declare function openAsBlob(path: PathLike, options?: Node.OpenAsBlobOptions): Promise<Blob>;
 export {};

package/dist/emulation/async.js

@@ -1,8 +1,10 @@
 import { ApiError, ErrorCode } from '../ApiError.js';
 import { BigIntStats } from '../stats.js';
+import { nop, normalizeMode } from '../utils.js';
 import { R_OK } from './constants.js';
 import * as promises from './promises.js';
-import { fd2file, nop, normalizeMode } from './shared.js';
+import { fd2file } from './shared.js';
+import { ReadStream, WriteStream } from './streams.js';
 /**
  * Asynchronous rename. No arguments other than a possible exception are given
  * to the completion callback.
@@ -429,32 +431,98 @@ export function access(path, cbMode, cb = nop) {
 }
 access;
 export function watchFile(filename, optsListener, listener = nop) {
-    throw ApiError.With('ENOTSUP', filename, 'watchFile');
+    throw ApiError.With('ENOSYS', filename, 'watchFile');
 }
 watchFile;
 /**
  * @todo Implement
  */
 export function unwatchFile(filename, listener = nop) {
-    throw ApiError.With('ENOTSUP', filename, 'unwatchFile');
+    throw ApiError.With('ENOSYS', filename, 'unwatchFile');
 }
 unwatchFile;
 export function watch(filename, options, listener = nop) {
-    throw ApiError.With('ENOTSUP', filename, 'watch');
+    throw ApiError.With('ENOSYS', filename, 'watch');
 }
 watch;
 /**
- * @todo Implement
+ * Opens a file in read mode and creates a Node.js-like ReadStream.
+ *
+ * @param path The path to the file to be opened.
+ * @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 function createReadStream(path, options) {
-    throw ApiError.With('ENOTSUP', path, 'createReadStream');
+export function createReadStream(path, _options) {
+    const options = typeof _options == 'object' ? _options : { encoding: _options };
+    let handle;
+    const stream = new ReadStream({
+        highWaterMark: options.highWaterMark || 64 * 1024,
+        encoding: options.encoding || 'utf8',
+        async read(size) {
+            try {
+                handle || (handle = await promises.open(path, 'r', options?.mode));
+                const result = await handle.read(new Uint8Array(size), 0, size, handle.file.position);
+                stream.push(!result.bytesRead ? null : result.buffer.slice(0, result.bytesRead));
+                handle.file.position += result.bytesRead;
+                if (!result.bytesRead) {
+                    await handle.close();
+                }
+            }
+            catch (error) {
+                await handle?.close();
+                stream.destroy(error);
+            }
+        },
+        destroy(error, callback) {
+            handle
+                ?.close()
+                .then(() => callback(error))
+                .catch(callback);
+        },
+    });
+    stream.path = path;
+    return stream;
 }
 createReadStream;
 /**
- * @todo Implement
+ * Opens a file in write mode and creates a Node.js-like WriteStream.
+ *
+ * @param path The path to the file to be opened.
+ * @param options Options for the WriteStream and file opening (e.g., `encoding`, `highWaterMark`, `mode`).
+ * @returns A WriteStream object for writing to the file.
  */
-export function createWriteStream(path, options) {
-    throw ApiError.With('ENOTSUP', path, 'createWriteStream');
+export function createWriteStream(path, _options) {
+    const options = typeof _options == 'object' ? _options : { encoding: _options };
+    let handle;
+    const stream = new WriteStream({
+        highWaterMark: options?.highWaterMark,
+        async write(chunk, encoding, callback) {
+            try {
+                handle || (handle = await promises.open(path, 'w', options?.mode || 0o666));
+                await handle.write(chunk, null, encoding);
+                callback(null);
+            }
+            catch (error) {
+                await handle?.close();
+                callback(error);
+            }
+        },
+        destroy(error, callback) {
+            callback(error);
+            handle
+                ?.close()
+                .then(() => callback(error))
+                .catch(callback);
+        },
+        final(callback) {
+            handle
+                ?.close()
+                .then(() => callback())
+                .catch(callback);
+        },
+    });
+    stream.path = path;
+    return stream;
 }
 createWriteStream;
 export function rm(path, options, callback = nop) {
@@ -521,9 +589,3 @@ export function statfs(path, options, callback = nop) {
         .catch(callback);
 }
 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/index.d.ts

@@ -4,5 +4,5 @@ export * as promises from './promises.js';
 export * as constants from './constants.js';
 export * from './streams.js';
 export * from './dir.js';
-export { mountMapping, mounts, mount, umount, _toUnixTimestamp } from './shared.js';
+export { mountMapping, mounts, mount, umount } from './shared.js';
 export { Stats, BigIntStats, StatsFs } from '../stats.js';

package/dist/emulation/index.js

@@ -4,5 +4,5 @@ export * as promises from './promises.js';
 export * as constants from './constants.js';
 export * from './streams.js';
 export * from './dir.js';
-export { mountMapping, mounts, mount, umount, _toUnixTimestamp } from './shared.js';
+export { mountMapping, mounts, mount, umount } from './shared.js';
 export { Stats, BigIntStats, StatsFs } from '../stats.js';

package/dist/emulation/promises.d.ts

@@ -8,14 +8,18 @@ import { Buffer } from 'buffer';
 import type * as Node from 'node:fs';
 import type * as promises from 'node:fs/promises';
 import type { CreateReadStreamOptions, CreateWriteStreamOptions, FileChangeInfo, FileReadResult, FlagAndOpenMode } from 'node:fs/promises';
-import type { ReadableStream } from 'node:stream/web';
+import type { ReadableStream as TReadableStream } from 'node:stream/web';
 import type { Interface as ReadlineInterface } from 'readline';
+import { File } from '../file.js';
 import { FileContents } from '../filesystem.js';
 import { BigIntStats, type BigIntStatsFs, type Stats, type StatsFs } from '../stats.js';
-import { Dirent, type Dir } from './dir.js';
+import { Dir, Dirent } from './dir.js';
 import type { PathLike } from './shared.js';
 import { ReadStream, WriteStream } from './streams.js';
 export * as constants from './constants.js';
+declare global {
+    const ReadableStream: typeof TReadableStream;
+}
 export declare class FileHandle implements promises.FileHandle {
     /**
      * Gets the file descriptor for this file handle.
@@ -26,8 +30,10 @@ export declare class FileHandle implements promises.FileHandle {
      * Gets the file descriptor for this file handle.
      */
     fd: number);
-    private get file();
-    private get path();
+    /**
+     * @internal
+     */
+    get file(): File;
     /**
      * Asynchronous fchown(2) - Change ownership of a file.
      */
@@ -97,7 +103,7 @@ export declare class FileHandle implements promises.FileHandle {
      * @since v17.0.0
      * @experimental
      */
-    readableWebStream(options?: promises.ReadableWebStreamOptions): ReadableStream;
+    readableWebStream(options?: promises.ReadableWebStreamOptions): TReadableStream<Uint8Array>;
     readLines(options?: promises.CreateReadStreamOptions): ReadlineInterface;
     [Symbol.asyncDispose](): Promise<void>;
     /**
@@ -153,16 +159,32 @@ export declare class FileHandle implements promises.FileHandle {
      */
     close(): Promise<void>;
     /**
-     * See `fs.writev` promisified version.
-     * @todo Implement
+     * Asynchronous `writev`. Writes from multiple buffers.
+     * @param buffers An array of Uint8Array buffers.
+     * @param position The position in the file where to begin writing.
+     * @returns The number of bytes written.
+     */
+    writev(buffers: Uint8Array[], position?: number): Promise<Node.WriteVResult>;
+    /**
+     * Asynchronous `readv`. Reads into multiple buffers.
+     * @param buffers An array of Uint8Array buffers.
+     * @param position The position in the file where to begin reading.
+     * @returns The number of bytes read.
      */
-    writev(buffers: NodeJS.ArrayBufferView[], position?: number): Promise<Node.WriteVResult>;
+    readv(buffers: NodeJS.ArrayBufferView[], position?: number): Promise<Node.ReadVResult>;
     /**
-     * See `fs.readv` promisified version.
-     * @todo Implement
+     * Creates a `ReadStream` for reading from the file.
+     *
+     * @param options Options for the readable stream
+     * @returns A `ReadStream` object.
      */
-    readv(buffers: readonly NodeJS.ArrayBufferView[], position?: number): Promise<Node.ReadVResult>;
     createReadStream(options?: CreateReadStreamOptions): ReadStream;
+    /**
+     * Creates a `WriteStream` for writing to the file.
+     *
+     * @param options Options for the writeable stream.
+     * @returns A `WriteStream` object
+     */
     createWriteStream(options?: CreateWriteStreamOptions): WriteStream;
 }
 /**
@@ -237,7 +259,7 @@ export declare function readFile(filename: PathLike, options: (Node.EncodingOpti
     flag?: Node.OpenMode;
 }) | BufferEncoding): Promise<string>;
 /**
- * Synchronously writes data to a file, replacing the file if it already exists.
+ * Asynchronously writes data to a file, replacing the file if it already exists.
  *
  * The encoding option is ignored if data is a buffer.
  * @param filename
@@ -373,22 +395,45 @@ export declare function watch(filename: PathLike, options?: Node.WatchOptions |
  */
 export declare function access(path: PathLike, mode?: number): Promise<void>;
 /**
- * @todo Implement
+ * Asynchronous `rm`. Removes files or directories (recursively).
+ * @param path The path to the file or directory to remove.
  */
 export declare function rm(path: PathLike, options?: Node.RmOptions): Promise<void>;
 /**
- * @todo Implement
+ * Asynchronous `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 mkdtemp(prefix: string, options?: Node.EncodingOption): Promise<string>;
 export declare function mkdtemp(prefix: string, options?: Node.BufferEncodingOption): Promise<Buffer>;
 /**
- * @todo Implement
+ * Asynchronous `copyFile`. Copies a file.
+ * @param src The source file.
+ * @param dest The destination file.
+ * @param mode 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 copyFile(src: PathLike, dest: PathLike, mode?: number): Promise<void>;
 /**
- * @todo Implement
+ * Asynchronous `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 opendir(path: PathLike, options?: Node.OpenDirOptions): Promise<Dir>;
+/**
+ * Asynchronous `cp`. Recursively copies a file or directory.
+ * @param source The source file or directory.
+ * @param destination The destination file or directory.
+ * @param opts Options for the copy operation. Currently supports these options from Node.js 'fs.await cp':
+ *   * `dereference`: Dereference symbolic links.
+ *   * `errorOnExist`: Throw an error if the destination file or directory already exists.
+ *   * `filter`: A function that takes a source and destination path and returns a boolean, indicating whether to copy the given source element.
+ *   * `force`: Overwrite the destination if it exists, and overwrite existing readonly destination files.
+ *   * `preserveTimestamps`: Preserve file timestamps.
+ *   * `recursive`: If `true`, copies directories recursively.
+ */
 export declare function cp(source: PathLike, destination: PathLike, opts?: Node.CopyOptions): Promise<void>;
 /**
  * @since v18.15.0
@@ -401,3 +446,4 @@ export declare function statfs(path: PathLike, opts: Node.StatFsOptions & {
     bigint: true;
 }): Promise<BigIntStatsFs>;
 export declare function statfs(path: PathLike, opts?: Node.StatFsOptions): Promise<StatsFs | BigIntStatsFs>;
+export declare function openAsBlob(path: PathLike, options?: Node.OpenAsBlobOptions): Promise<Blob>;