memfs 3.6.0 → 4.1.0

package/lib/node-to-fsa/types.d.ts

@@ -0,0 +1,12 @@
+import type { IFs } from '..';
+/**
+ * Required Node.js `fs` module functions for File System Access API.
+ */
+export type NodeFsaFs = Pick<IFs, 'promises' | 'constants' | 'openSync' | 'fsyncSync' | 'statSync' | 'closeSync' | 'readSync' | 'truncateSync' | 'writeSync'>;
+export interface NodeFsaContext {
+    separator: '/' | '\\';
+    /** Whether synchronous file handles are allowed. */
+    syncHandleAllowed: boolean;
+    /** Whether writes are allowed, defaults to `read`. */
+    mode: 'read' | 'readwrite';
+}

package/lib/node-to-fsa/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/node-to-fsa/util.d.ts

@@ -0,0 +1,11 @@
+import type { NodeFsaContext } from './types';
+/**
+ * Creates a new {@link NodeFsaContext}.
+ */
+export declare const ctx: (partial?: Partial<NodeFsaContext>) => NodeFsaContext;
+export declare const basename: (path: string, separator: string) => string;
+export declare const assertName: (name: string, method: string, klass: string) => void;
+export declare const assertCanWrite: (mode: 'read' | 'readwrite') => void;
+export declare const newNotFoundError: () => DOMException;
+export declare const newTypeMismatchError: () => DOMException;
+export declare const newNotAllowedError: () => DOMException;

package/lib/node-to-fsa/util.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.newNotAllowedError = exports.newTypeMismatchError = exports.newNotFoundError = exports.assertCanWrite = exports.assertName = exports.basename = exports.ctx = void 0;
+/**
+ * Creates a new {@link NodeFsaContext}.
+ */
+const ctx = (partial = {}) => {
+    return Object.assign({ separator: '/', syncHandleAllowed: false, mode: 'read' }, partial);
+};
+exports.ctx = ctx;
+const basename = (path, separator) => {
+    const lastSlashIndex = path.lastIndexOf(separator);
+    return lastSlashIndex === -1 ? path : path.slice(lastSlashIndex + 1);
+};
+exports.basename = basename;
+const nameRegex = /^(\.{1,2})|(.*(\/|\\).*)$/;
+const assertName = (name, method, klass) => {
+    const isInvalid = !name || nameRegex.test(name);
+    if (isInvalid)
+        throw new TypeError(`Failed to execute '${method}' on '${klass}': Name is not allowed.`);
+};
+exports.assertName = assertName;
+const assertCanWrite = (mode) => {
+    if (mode !== 'readwrite')
+        throw new DOMException('The request is not allowed by the user agent or the platform in the current context.', 'NotAllowedError');
+};
+exports.assertCanWrite = assertCanWrite;
+const newNotFoundError = () => new DOMException('A requested file or directory could not be found at the time an operation was processed.', 'NotFoundError');
+exports.newNotFoundError = newNotFoundError;
+const newTypeMismatchError = () => new DOMException('The path supplied exists, but was not an entry of requested type.', 'TypeMismatchError');
+exports.newTypeMismatchError = newTypeMismatchError;
+const newNotAllowedError = () => new DOMException('Permission not granted.', 'NotAllowedError');
+exports.newNotAllowedError = newNotAllowedError;

package/lib/node.d.ts

@@ -149,7 +149,7 @@ export declare class File {
     truncate(len?: number): void;
     seekTo(position: number): void;
     stats(): Stats<number>;
-    write(buf: Buffer, offset?: number, length?: number, position?: number): number;
+    write(buf: Buffer, offset?: number, length?: number, position?: number | null): number;
     read(buf: Buffer | ArrayBufferView | DataView, offset?: number, length?: number, position?: number): number;
     chmod(perm: number): void;
     chown(uid: number, gid: number): void;

package/lib/volume.d.ts

@@ -6,11 +6,14 @@ import { Node, Link, File } from './node';
 import Stats from './Stats';
 import Dirent from './Dirent';
 import { TSetTimeout } from './setTimeoutUnref';
-import { Readable, Writable } from 'stream';
+import { Writable } from 'stream';
 import { constants } from './constants';
 import { EventEmitter } from 'events';
-import { TEncodingExtended, TDataOut } from './encoding';
+import { TDataOut } from './encoding';
+import * as misc from './node/types/misc';
+import * as opts from './node/types/options';
 import type { PathLike, symlink } from 'fs';
+import { FsCallbackApi, WritevCallback } from './node/types/callback';
 export interface IError extends Error {
     code?: string;
 }
@@ -20,102 +23,20 @@ export type TFlags = string | number;
 export type TMode = string | number;
 export type TTime = number | string | Date;
 export type TCallback<TData> = (error?: IError | null, data?: TData) => void;
-export declare enum FLAGS {
-    r,
-    'r+',
-    rs,
-    sr,
-    'rs+',
-    'sr+',
-    w,
-    wx,
-    xw,
-    'w+',
-    'wx+',
-    'xw+',
-    a,
-    ax,
-    xa,
-    'a+',
-    'ax+',
-    'xa+'
-}
 export type TFlagsCopy = typeof constants.COPYFILE_EXCL | typeof constants.COPYFILE_FICLONE | typeof constants.COPYFILE_FICLONE_FORCE;
-export declare function flagsToNumber(flags: TFlags | undefined): number;
-export interface IOptions {
-    encoding?: BufferEncoding | TEncodingExtended;
-}
-export interface IFileOptions extends IOptions {
-    mode?: TMode;
-    flag?: TFlags;
-}
-export interface IReadFileOptions extends IOptions {
-    flag?: string;
-}
-export interface IWriteFileOptions extends IFileOptions {
-}
-export interface IAppendFileOptions extends IFileOptions {
-}
-export interface IRealpathOptions {
-    encoding?: TEncodingExtended;
+export interface IAppendFileOptions extends opts.IFileOptions {
 }
 export interface IWatchFileOptions {
     persistent?: boolean;
     interval?: number;
 }
-export interface IReadStreamOptions {
-    flags?: TFlags;
-    encoding?: BufferEncoding;
-    fd?: number;
-    mode?: TMode;
-    autoClose?: boolean;
-    start?: number;
-    end?: number;
-}
-export interface IWriteStreamOptions {
-    flags?: TFlags;
-    defaultEncoding?: BufferEncoding;
-    fd?: number;
-    mode?: TMode;
-    autoClose?: boolean;
-    start?: number;
-}
-export interface IWatchOptions extends IOptions {
+export interface IWatchOptions extends opts.IOptions {
     persistent?: boolean;
     recursive?: boolean;
 }
-export interface IMkdirOptions {
-    mode?: TMode;
-    recursive?: boolean;
-}
-export interface IRmdirOptions {
-    /** @deprecated */
-    recursive?: boolean;
-    maxRetries?: number;
-    retryDelay?: number;
-}
-export interface IRmOptions {
-    force?: boolean;
-    maxRetries?: number;
-    recursive?: boolean;
-    retryDelay?: number;
-}
-export interface IReaddirOptions extends IOptions {
-    withFileTypes?: boolean;
-}
-export interface IStatOptions {
-    bigint?: boolean;
-    throwIfNoEntry?: boolean;
-}
-export interface IFStatOptions {
-    bigint?: boolean;
-}
-export declare function pathToFilename(path: PathLike): string;
 export declare function filenameToSteps(filename: string, base?: string): string[];
 export declare function pathToSteps(path: PathLike): string[];
 export declare function dataToStr(data: TData, encoding?: string): string;
-export declare function dataToBuffer(data: TData, encoding?: string): Buffer;
-export declare function bufferToEncoding(buffer: Buffer, encoding?: TEncodingExtended): TDataOut;
 export declare function toUnixTimestamp(time: any): any;
 type DirectoryContent = string | null;
 export interface DirectoryJSON {
@@ -127,7 +48,7 @@ export interface NestedDirectoryJSON {
 /**
  * `Volume` represents a file system.
  */
-export declare class Volume {
+export declare class Volume implements FsCallbackApi {
     static fromJSON(json: DirectoryJSON, cwd?: string): Volume;
     static fromNestedJSON(json: NestedDirectoryJSON, cwd?: string): Volume;
     /**
@@ -151,7 +72,7 @@ export declare class Volume {
     maxFiles: number;
     openFiles: number;
     StatWatcher: new () => StatWatcher;
-    ReadStream: new (...args: any[]) => IReadStream;
+    ReadStream: new (...args: any[]) => misc.IReadStream;
     WriteStream: new (...args: any[]) => IWriteStream;
     FSWatcher: new () => FSWatcher;
     props: {
@@ -168,9 +89,7 @@ export declare class Volume {
     private newInoNumber;
     private newFdNumber;
     createNode(isDirectory?: boolean, perm?: number): Node;
-    private getNode;
     private deleteNode;
-    genRndStr(): any;
     getLink(steps: string[]): Link | null;
     getLinkOrThrow(filename: string, funcName?: string): Link;
     getResolvedLink(filenameOrSteps: string | string[]): Link | null;
@@ -205,9 +124,9 @@ export declare class Volume {
     readSync(fd: number, buffer: Buffer | ArrayBufferView | DataView, offset: number, length: number, position: number): number;
     read(fd: number, buffer: Buffer | ArrayBufferView | DataView, offset: number, length: number, position: number, callback: (err?: Error | null, bytesRead?: number, buffer?: Buffer | ArrayBufferView | DataView) => void): void;
     private readFileBase;
-    readFileSync(file: TFileId, options?: IReadFileOptions | string): TDataOut;
+    readFileSync(file: TFileId, options?: opts.IReadFileOptions | string): TDataOut;
     readFile(id: TFileId, callback: TCallback<TDataOut>): any;
-    readFile(id: TFileId, options: IReadFileOptions | string, callback: TCallback<TDataOut>): any;
+    readFile(id: TFileId, options: opts.IReadFileOptions | string, callback: TCallback<TDataOut>): any;
     private writeBase;
     writeSync(fd: number, buffer: Buffer | ArrayBufferView | DataView, offset?: number, length?: number, position?: number): number;
     writeSync(fd: number, str: string, position?: number, encoding?: BufferEncoding): number;
@@ -218,10 +137,12 @@ export declare class Volume {
     write(fd: number, str: string, callback: (...args: any[]) => void): any;
     write(fd: number, str: string, position: number, callback: (...args: any[]) => void): any;
     write(fd: number, str: string, position: number, encoding: BufferEncoding, callback: (...args: any[]) => void): any;
+    writev(fd: number, buffers: ArrayBufferView[], callback: WritevCallback): void;
+    writev(fd: number, buffers: ArrayBufferView[], position: number | null, callback: WritevCallback): void;
     private writeFileBase;
-    writeFileSync(id: TFileId, data: TData, options?: IWriteFileOptions): void;
+    writeFileSync(id: TFileId, data: TData, options?: opts.IWriteFileOptions): void;
     writeFile(id: TFileId, data: TData, callback: TCallback<void>): any;
-    writeFile(id: TFileId, data: TData, options: IWriteFileOptions | string, callback: TCallback<void>): any;
+    writeFile(id: TFileId, data: TData, options: opts.IWriteFileOptions | string, callback: TCallback<void>): any;
     private linkBase;
     private copyFileBase;
     copyFileSync(src: PathLike, dest: PathLike, flags?: TFlagsCopy): void;
@@ -237,9 +158,9 @@ export declare class Volume {
     symlink(target: PathLike, path: PathLike, callback: TCallback<void>): any;
     symlink(target: PathLike, path: PathLike, type: symlink.Type, callback: TCallback<void>): any;
     private realpathBase;
-    realpathSync(path: PathLike, options?: IRealpathOptions | string): TDataOut;
+    realpathSync(path: PathLike, options?: opts.IRealpathOptions | string): TDataOut;
     realpath(path: PathLike, callback: TCallback<TDataOut>): any;
-    realpath(path: PathLike, options: IRealpathOptions | string, callback: TCallback<TDataOut>): any;
+    realpath(path: PathLike, options: opts.IRealpathOptions | string, callback: TCallback<TDataOut>): any;
     private lstatBase;
     lstatSync(path: PathLike): Stats<number>;
     lstatSync(path: PathLike, options: {
@@ -265,7 +186,7 @@ export declare class Volume {
         throwIfNoEntry: false;
     }): Stats<bigint> | undefined;
     lstat(path: PathLike, callback: TCallback<Stats>): void;
-    lstat(path: PathLike, options: IStatOptions, callback: TCallback<Stats>): void;
+    lstat(path: PathLike, options: opts.IStatOptions, callback: TCallback<Stats>): void;
     private statBase;
     statSync(path: PathLike): Stats<number>;
     statSync(path: PathLike, options: {
@@ -291,7 +212,7 @@ export declare class Volume {
         throwIfNoEntry: false;
     }): Stats<bigint> | undefined;
     stat(path: PathLike, callback: TCallback<Stats>): void;
-    stat(path: PathLike, options: IStatOptions, callback: TCallback<Stats>): void;
+    stat(path: PathLike, options: opts.IStatOptions, callback: TCallback<Stats>): void;
     private fstatBase;
     fstatSync(fd: number): Stats<number>;
     fstatSync(fd: number, options: {
@@ -301,7 +222,7 @@ export declare class Volume {
         bigint: true;
     }): Stats<bigint>;
     fstat(fd: number, callback: TCallback<Stats>): void;
-    fstat(fd: number, options: IFStatOptions, callback: TCallback<Stats>): void;
+    fstat(fd: number, options: opts.IFStatOptions, callback: TCallback<Stats>): void;
     private renameBase;
     renameSync(oldPath: PathLike, newPath: PathLike): void;
     rename(oldPath: PathLike, newPath: PathLike, callback: TCallback<void>): void;
@@ -316,13 +237,13 @@ export declare class Volume {
     appendFile(id: TFileId, data: TData, callback: TCallback<void>): any;
     appendFile(id: TFileId, data: TData, options: IAppendFileOptions | string, callback: TCallback<void>): any;
     private readdirBase;
-    readdirSync(path: PathLike, options?: IReaddirOptions | string): TDataOut[] | Dirent[];
+    readdirSync(path: PathLike, options?: opts.IReaddirOptions | string): TDataOut[] | Dirent[];
     readdir(path: PathLike, callback: TCallback<TDataOut[] | Dirent[]>): any;
-    readdir(path: PathLike, options: IReaddirOptions | string, callback: TCallback<TDataOut[] | Dirent[]>): any;
+    readdir(path: PathLike, options: opts.IReaddirOptions | string, callback: TCallback<TDataOut[] | Dirent[]>): any;
     private readlinkBase;
-    readlinkSync(path: PathLike, options?: IOptions): TDataOut;
+    readlinkSync(path: PathLike, options?: opts.IOptions): TDataOut;
     readlink(path: PathLike, callback: TCallback<TDataOut>): any;
-    readlink(path: PathLike, options: IOptions, callback: TCallback<TDataOut>): any;
+    readlink(path: PathLike, options: opts.IOptions, callback: TCallback<TDataOut>): any;
     private fsyncBase;
     fsyncSync(fd: number): void;
     fsync(fd: number, callback: TCallback<void>): void;
@@ -334,6 +255,10 @@ export declare class Volume {
     ftruncate(fd: number, callback: TCallback<void>): any;
     ftruncate(fd: number, len: number, callback: TCallback<void>): any;
     private truncateBase;
+    /**
+     * `id` should be a file descriptor or a path. `id` as file descriptor will
+     * not be supported soon.
+     */
     truncateSync(id: TFileId, len?: number): void;
     truncate(id: TFileId, callback: TCallback<void>): any;
     truncate(id: TFileId, len: number, callback: TCallback<void>): any;
@@ -350,36 +275,36 @@ export declare class Volume {
      * @param modeNum
      */
     private mkdirpBase;
-    mkdirSync(path: PathLike, options: IMkdirOptions & {
+    mkdirSync(path: PathLike, options: opts.IMkdirOptions & {
         recursive: true;
     }): string | undefined;
-    mkdirSync(path: PathLike, options?: TMode | (IMkdirOptions & {
+    mkdirSync(path: PathLike, options?: TMode | (opts.IMkdirOptions & {
         recursive?: false;
     })): void;
-    mkdirSync(path: PathLike, options?: TMode | IMkdirOptions): string | undefined;
+    mkdirSync(path: PathLike, options?: TMode | opts.IMkdirOptions): string | undefined;
     mkdir(path: PathLike, callback: TCallback<void>): any;
-    mkdir(path: PathLike, mode: TMode | (IMkdirOptions & {
+    mkdir(path: PathLike, mode: TMode | (opts.IMkdirOptions & {
         recursive?: false;
     }), callback: TCallback<void>): any;
-    mkdir(path: PathLike, mode: IMkdirOptions & {
+    mkdir(path: PathLike, mode: opts.IMkdirOptions & {
         recursive: true;
     }, callback: TCallback<string>): any;
-    mkdir(path: PathLike, mode: TMode | IMkdirOptions, callback: TCallback<string>): any;
+    mkdir(path: PathLike, mode: TMode | opts.IMkdirOptions, callback: TCallback<string>): any;
     mkdirpSync(path: PathLike, mode?: TMode): string | undefined;
     mkdirp(path: PathLike, callback: TCallback<string>): any;
     mkdirp(path: PathLike, mode: TMode, callback: TCallback<string>): any;
     private mkdtempBase;
-    mkdtempSync(prefix: string, options?: IOptions): TDataOut;
-    mkdtemp(prefix: string, callback: TCallback<void>): any;
-    mkdtemp(prefix: string, options: IOptions, callback: TCallback<void>): any;
+    mkdtempSync(prefix: string, options?: opts.IOptions): TDataOut;
+    mkdtemp(prefix: string, callback: TCallback<string>): any;
+    mkdtemp(prefix: string, options: opts.IOptions, callback: TCallback<string>): any;
     private rmdirBase;
-    rmdirSync(path: PathLike, options?: IRmdirOptions): void;
+    rmdirSync(path: PathLike, options?: opts.IRmdirOptions): void;
     rmdir(path: PathLike, callback: TCallback<void>): any;
-    rmdir(path: PathLike, options: IRmdirOptions, callback: TCallback<void>): any;
+    rmdir(path: PathLike, options: opts.IRmdirOptions, callback: TCallback<void>): any;
     private rmBase;
-    rmSync(path: PathLike, options?: IRmOptions): void;
+    rmSync(path: PathLike, options?: opts.IRmOptions): void;
     rm(path: PathLike, callback: TCallback<void>): void;
-    rm(path: PathLike, options: IRmOptions, callback: TCallback<void>): void;
+    rm(path: PathLike, options: opts.IRmOptions, callback: TCallback<void>): void;
     private fchmodBase;
     fchmodSync(fd: number, mode: TMode): void;
     fchmod(fd: number, mode: TMode, callback: TCallback<void>): void;
@@ -402,8 +327,8 @@ export declare class Volume {
     watchFile(path: PathLike, listener: (curr: Stats, prev: Stats) => void): StatWatcher;
     watchFile(path: PathLike, options: IWatchFileOptions, listener: (curr: Stats, prev: Stats) => void): StatWatcher;
     unwatchFile(path: PathLike, listener?: (curr: Stats, prev: Stats) => void): void;
-    createReadStream(path: PathLike, options?: IReadStreamOptions | string): IReadStream;
-    createWriteStream(path: PathLike, options?: IWriteStreamOptions | string): IWriteStream;
+    createReadStream(path: misc.PathLike, options?: opts.IReadStreamOptions | string): misc.IReadStream;
+    createWriteStream(path: PathLike, options?: opts.IWriteStreamOptions | string): IWriteStream;
     watch(path: PathLike, options?: IWatchOptions | string, listener?: (eventType: string, filename: string) => void): FSWatcher;
 }
 export declare class StatWatcher extends EventEmitter {
@@ -420,17 +345,11 @@ export declare class StatWatcher extends EventEmitter {
     start(path: string, persistent?: boolean, interval?: number): void;
     stop(): void;
 }
-export interface IReadStream extends Readable {
-    new (path: PathLike, options: IReadStreamOptions): any;
-    open(): any;
-    close(callback: TCallback<void>): any;
-    bytesRead: number;
-    path: string;
-}
 export interface IWriteStream extends Writable {
     bytesWritten: number;
     path: string;
-    new (path: PathLike, options: IWriteStreamOptions): any;
+    pending: boolean;
+    new (path: PathLike, options: opts.IWriteStreamOptions): any;
     open(): any;
     close(): any;
 }