@zenfs/core 0.1.0 → 0.2.0

package/dist/emulation/shared.d.ts

@@ -1,15 +1,14 @@
 /// <reference types="node" resolution-mode="require"/>
 import { Cred } from '../cred.js';
 import { FileSystem } from '../filesystem.js';
-import { File } from '../file.js';
-import { BackendConstructor } from '../backends/backend.js';
+import type { File } from '../file.js';
 /**
- * converts Date or number to a fractional UNIX timestamp
+ * converts Date or number to a integer UNIX timestamp
  * Grabbed from NodeJS sources (lib/fs.js)
  */
 export declare function _toUnixTimestamp(time: Date | number): number;
-export declare function normalizeMode(mode: unknown, def: number): number;
-export declare function normalizeTime(time: number | Date): Date;
+export declare function normalizeMode(mode: string | number | unknown, def?: number): number;
+export declare function normalizeTime(time: string | number | Date): Date;
 export declare function normalizePath(p: string): string;
 export declare function normalizeOptions(options: any, defEnc: string | null, defFlag: string, defMode: number | null): {
     encoding: BufferEncoding;
@@ -23,7 +22,7 @@ export declare const fdMap: Map<number, File>;
 export declare function getFdForFile(file: File): number;
 export declare function fd2file(fd: number): File;
 export interface MountMapping {
-    [point: string]: InstanceType<BackendConstructor>;
+    [point: string]: FileSystem;
 }
 export declare const mounts: Map<string, FileSystem>;
 /**
@@ -69,8 +68,9 @@ export type PathLike = string;
 /**
  * @internal
  *
- * Converts any Buffer in T to Uint8Array
+ * Recursivly converts `From` in `Target` to `To`
  */
-export type BufferToUint8Array<T> = T extends Buffer ? Uint8Array : T extends (...args: any[]) => unknown ? (...args: Parameters<T>) => BufferToUint8Array<ReturnType<T>> : T extends object ? {
-    [K in keyof T]: BufferToUint8Array<T[K]>;
-} : T;
+export type Convert<Target, From, To> = Target extends From ? To : Target extends (...args: any[]) => unknown ? (...args: Convert<Parameters<Target>, From, To> & Array<unknown>) => Convert<ReturnType<Target>, From, To> : Target extends object ? {
+    [K in keyof Target]: Convert<Target[K], From, To>;
+} : Target;
+export type BufferToUint8Array<T> = Convert<T, Buffer, Uint8Array>;

package/dist/emulation/shared.js

@@ -2,17 +2,17 @@
 import { resolve } from './path.js';
 import { ApiError, ErrorCode } from '../ApiError.js';
 import { Cred } from '../cred.js';
-import { InMemoryFileSystem } from '../backends/InMemory.js';
+import { InMemory } from '../backends/InMemory.js';
 /**
- * converts Date or number to a fractional UNIX timestamp
+ * converts Date or number to a integer UNIX timestamp
  * Grabbed from NodeJS sources (lib/fs.js)
  */
 export function _toUnixTimestamp(time) {
     if (typeof time === 'number') {
-        return time;
+        return Math.floor(time);
     }
-    else if (time instanceof Date) {
-        return time.getTime() / 1000;
+    if (time instanceof Date) {
+        return Math.floor(time.getTime() / 1000);
     }
     throw new Error('Cannot parse time: ' + time);
 }
@@ -27,20 +27,23 @@ export function normalizeMode(mode, def) {
             if (!isNaN(trueMode)) {
                 return trueMode;
             }
-            // Invalid string.
-            return def;
-        default:
-            return def;
     }
+    if (typeof def == 'number') {
+        return def;
+    }
+    throw new ApiError(ErrorCode.EINVAL, 'Invalid mode: ' + mode?.toString());
 }
 export function normalizeTime(time) {
     if (time instanceof Date) {
         return time;
     }
-    if (typeof time === 'number') {
+    if (typeof time == 'number') {
         return new Date(time * 1000);
     }
-    throw new ApiError(ErrorCode.EINVAL, `Invalid time.`);
+    if (typeof time == 'string') {
+        return new Date(time);
+    }
+    throw new ApiError(ErrorCode.EINVAL, 'Invalid time.');
 }
 export function normalizePath(p) {
     // Node doesn't allow null characters in paths.
@@ -98,17 +101,15 @@ export function getFdForFile(file) {
 }
 export function fd2file(fd) {
     if (!fdMap.has(fd)) {
-        throw new ApiError(ErrorCode.EBADF, 'Invalid file descriptor.');
+        throw new ApiError(ErrorCode.EBADF);
     }
     return fdMap.get(fd);
 }
 export const mounts = new Map();
 /*
 Set a default root.
-There is a very small but not 0 change that initialize() will try to unmount the default before it is mounted.
-This can be fixed by using a top-level await, which is not done to maintain ES6 compatibility.
 */
-InMemoryFileSystem.Create().then(fs => mount('/', fs));
+mount('/', InMemory.create({ name: 'root' }));
 /**
  * Gets the file system mounted at `mountPoint`
  */
@@ -151,6 +152,7 @@ export function umount(mountPoint) {
  * Gets the internal FileSystem for the path, then returns it along with the path relative to the FS' root
  */
 export function resolveFS(path) {
+    path = normalizePath(path);
     const sortedMounts = [...mounts].sort((a, b) => (a[0].length > b[0].length ? -1 : 1)); // decending order of the string length
     for (const [mountPoint, fs] of sortedMounts) {
         // We know path is normalized, so it would be a substring of the mount point.
@@ -181,14 +183,10 @@ export function fixError(e, paths) {
     return e;
 }
 export function initialize(mountMapping) {
-    if (mountMapping['/']) {
+    if ('/' in mountMapping) {
         umount('/');
     }
     for (const [point, fs] of Object.entries(mountMapping)) {
-        const FS = fs.constructor;
-        if (!FS.isAvailable()) {
-            throw new ApiError(ErrorCode.EINVAL, `Can not mount "${point}" since the filesystem is unavailable.`);
-        }
         mount(point, fs);
     }
 }

package/dist/emulation/sync.d.ts

@@ -54,12 +54,17 @@ export declare function unlinkSync(path: PathLike): void;
 /**
  * Synchronous file open.
  * @see http://www.manpagez.com/man/2/open/
- * @param path
- * @param flags
- * @param mode defaults to `0644`
- * @returns file descriptor
+ * @param flags Handles the complexity of the various file
+ *   modes. See its API for more details.
+ * @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;
+/**
+ * Opens a file or symlink
+ * @internal
  */
-export declare function openSync(path: PathLike, flag: string, mode?: number | string): number;
+export declare function lopenSync(path: PathLike, flag: string, mode?: Node.Mode): number;
 /**
  * Synchronously reads the entire contents of a file.
  * @param filename
@@ -89,16 +94,11 @@ export declare function readFileSync(filename: string, encoding: string): string
  * @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?: string): void;
+export declare function writeFileSync(filename: string, data: FileContents, encoding?: BufferEncoding): void;
 /**
  * Asynchronously append data to a file, creating the file if it not yet
  * exists.
  *
- * @example Usage example
- *   fs.appendFile('message.txt', 'data to append', function (err) {
- *     if (err) throw err;
- *     console.log('The "data to append" was appended to file!');
- *   });
  * @param filename
  * @param data
  * @param options
@@ -146,7 +146,7 @@ export declare function fdatasyncSync(fd: number): void;
  * Note that it is unsafe to use fs.write multiple times on the same file
  * without waiting for it to return.
  * @param fd
- * @param buffer Uint8Array containing the data to write to
+ * @param data Uint8Array containing the data to write to
  *   the file.
  * @param offset Offset in the buffer to start reading data from.
  * @param length The amount of bytes to write to the file.
@@ -154,8 +154,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, buffer: Uint8Array, offset: number, length: number, position?: number | null): number;
-export declare function writeSync(fd: number, data: string, position?: number | null, encoding?: BufferEncoding): number;
+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;
 /**
  * Read data from the file specified by `fd`.
  * @param fd
@@ -190,7 +190,7 @@ export declare function fchmodSync(fd: number, mode: number | string): void;
  * @param atime
  * @param mtime
  */
-export declare function futimesSync(fd: number, atime: number | Date, mtime: number | Date): void;
+export declare function futimesSync(fd: number, atime: string | number | Date, mtime: string | number | Date): void;
 /**
  * Synchronous `rmdir`.
  * @param path
@@ -212,7 +212,7 @@ export declare function mkdirSync(path: PathLike, options?: Node.Mode | (Node.Ma
  * Synchronous `readdir`. Reads the contents of a directory.
  * @param path
  */
-export declare function readdirSync(path: PathLike, options: {
+export declare function readdirSync(path: PathLike, options?: {
     encoding?: BufferEncoding;
     withFileTypes?: false;
 } | BufferEncoding): string[];
@@ -225,17 +225,17 @@ export declare function readdirSync(path: PathLike, options: {
 }): Dirent[];
 /**
  * Synchronous `link`.
- * @param srcpath
- * @param dstpath
+ * @param existing
+ * @param newpath
  */
-export declare function linkSync(srcpath: PathLike, dstpath: PathLike): void;
+export declare function linkSync(existing: PathLike, newpath: PathLike): void;
 /**
  * Synchronous `symlink`.
- * @param srcpath
- * @param dstpath
+ * @param target target path
+ * @param path link path
  * @param type can be either `'dir'` or `'file'` (default is `'file'`)
  */
-export declare function symlinkSync(srcpath: PathLike, dstpath: PathLike, type?: symlink.Type): void;
+export declare function symlinkSync(target: PathLike, path: PathLike, type?: symlink.Type): void;
 /**
  * Synchronous readlink.
  * @param path
@@ -261,7 +261,7 @@ export declare function lchownSync(path: PathLike, uid: number, gid: number): vo
  * @param path
  * @param mode
  */
-export declare function chmodSync(path: PathLike, mode: string | number): void;
+export declare function chmodSync(path: PathLike, mode: Node.Mode): void;
 /**
  * Synchronous `lchmod`.
  * @param path
@@ -274,14 +274,14 @@ export declare function lchmodSync(path: PathLike, mode: number | string): void;
  * @param atime
  * @param mtime
  */
-export declare function utimesSync(path: PathLike, atime: number | Date, mtime: number | Date): void;
+export declare function utimesSync(path: 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: number | Date, mtime: number | Date): void;
+export declare function lutimesSync(path: PathLike, atime: string | number | Date, mtime: string | number | Date): void;
 /**
  * Synchronous `realpath`.
  * @param path