@zenfs/core 0.16.0 → 0.16.2

package/dist/config.d.ts

@@ -9,7 +9,7 @@ export type MountConfiguration<T extends Backend> = FilesystemOf<T> | BackendCon
  * @see MountConfiguration
  */
 export declare function resolveMountConfig<T extends Backend>(config: MountConfiguration<T>, _depth?: number): Promise<FilesystemOf<T>>;
-type ConfigMounts = {
+export type ConfigMounts = {
     [K in AbsolutePath]: Backend;
 };
 /**
@@ -40,4 +40,3 @@ export declare function configureSingle<T extends Backend>(config: MountConfigur
  * @see Configuration
  */
 export declare function configure<T extends ConfigMounts>(config: Partial<Configuration<T>>): Promise<void>;
-export {};

package/dist/config.js

@@ -37,9 +37,9 @@ export async function resolveMountConfig(config, _depth = 0) {
     }
     const { backend } = config;
     if (!(await backend.isAvailable())) {
-        throw new ErrnoError(Errno.EPERM, 'Backend not available: ' + backend);
+        throw new ErrnoError(Errno.EPERM, 'Backend not available: ' + backend.name);
     }
-    checkOptions(backend, config);
+    await checkOptions(backend, config);
     const mount = (await backend.create(config));
     if ('_disableSync' in mount) {
         mount._disableSync = config.disableAsyncCache || false;

package/dist/emulation/async.d.ts

@@ -141,12 +141,11 @@ export declare function writeFile(filename: fs.PathLike, data: FileContents, opt
  * @param callback
  */
 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;
+export declare function appendFile(filename: fs.PathLike, data: FileContents, options?: fs.EncodingOption & {
+    mode?: fs.Mode;
+    flag?: fs.OpenMode;
 }, cb?: Callback): void;
-export declare function appendFile(filename: fs.PathLike, data: FileContents, encoding?: string, cb?: Callback): void;
+export declare function appendFile(filename: fs.PathLike, data: FileContents, encoding?: BufferEncoding, cb?: Callback): void;
 /**
  * Asynchronous `fstat`.
  * `fstat()` is identical to `stat()`, except that the file to be stat-ed is

package/dist/emulation/async.js

@@ -97,9 +97,10 @@ export function writeFile(filename, data, cbEncOpts, cb = nop) {
 }
 writeFile;
 export function appendFile(filename, data, cbEncOpts, cb = nop) {
+    const optionsOrEncoding = typeof cbEncOpts != 'function' ? cbEncOpts : undefined;
     cb = typeof cbEncOpts === 'function' ? cbEncOpts : cb;
     promises
-        .appendFile(filename, data, typeof cbEncOpts === 'function' ? null : cbEncOpts)
+        .appendFile(filename, data, optionsOrEncoding)
         .then(() => cb())
         .catch(cb);
 }
@@ -160,7 +161,7 @@ export function fdatasync(fd, cb = nop) {
         .catch(cb);
 }
 fdatasync;
-export function write(fd, data, cbPosOff, cbLenEnc, cbPos, cb = nop) {
+export function write(fd, data, cbPosOff, cbLenEnc, cbPosEnc, cb = nop) {
     let buffer, offset, length, position, encoding;
     const handle = new promises.FileHandle(fd);
     if (typeof data === 'string') {
@@ -175,11 +176,11 @@ export function write(fd, data, cbPosOff, cbLenEnc, cbPos, cb = nop) {
                 // (fd, string, position, encoding?, cb?)
                 position = cbPosOff;
                 encoding = typeof cbLenEnc === 'string' ? cbLenEnc : 'utf8';
-                cb = typeof cbPos === 'function' ? cbPos : cb;
+                cb = typeof cbPosEnc === 'function' ? cbPosEnc : cb;
                 break;
             default:
                 // ...try to find the callback and get out of here!
-                cb = typeof cbLenEnc === 'function' ? cbLenEnc : typeof cbPos === 'function' ? cbPos : cb;
+                cb = (typeof cbLenEnc === 'function' ? cbLenEnc : typeof cbPosEnc === 'function' ? cbPosEnc : cb);
                 cb(new ErrnoError(Errno.EINVAL, 'Invalid arguments.'));
                 return;
         }
@@ -197,9 +198,9 @@ export function write(fd, data, cbPosOff, cbLenEnc, cbPos, cb = nop) {
         buffer = Buffer.from(data.buffer);
         offset = cbPosOff;
         length = cbLenEnc;
-        position = typeof cbPos === 'number' ? cbPos : null;
-        const _cb = typeof cbPos === 'function' ? cbPos : cb;
-        handle
+        position = typeof cbPosEnc === 'number' ? cbPosEnc : null;
+        const _cb = (typeof cbPosEnc === 'function' ? cbPosEnc : cb);
+        void handle
             .write(buffer, offset, length, position)
             .then(({ bytesWritten }) => _cb(undefined, bytesWritten, buffer))
             .catch(_cb);
@@ -297,7 +298,6 @@ export function readdir(path, _options, cb = nop) {
     const options = typeof _options != 'function' ? _options : {};
     promises
         .readdir(path, options)
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         .then(entries => cb(undefined, entries))
         .catch(cb);
 }
@@ -426,7 +426,7 @@ 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 cbMode === 'function' ? null : cbMode)
+        .access(path, mode)
         .then(() => cb())
         .catch(cb);
 }

package/dist/emulation/dir.js

@@ -76,7 +76,7 @@ export class Dir {
         if (!cb) {
             return this._read();
         }
-        this._read().then(value => cb(undefined, value));
+        void this._read().then(value => cb(undefined, value));
     }
     /**
      * Synchronously read the next directory entry via `readdir(3)` as a `Dirent`.

package/dist/emulation/promises.js

@@ -169,17 +169,17 @@ export class FileHandle {
      */
     readableWebStream(options = {}) {
         // Note: using an arrow function to preserve `this`
-        const start = async ({ close, enqueue, error }) => {
+        const start = async (controller) => {
             try {
                 const chunkSize = 64 * 1024, maxChunks = 1e7;
                 let i = 0, position = 0, bytesRead = NaN;
                 while (bytesRead > 0) {
                     const result = await this.read(new Uint8Array(chunkSize), 0, chunkSize, position);
                     if (!result.bytesRead) {
-                        close();
+                        controller.close();
                         return;
                     }
-                    enqueue(result.buffer.slice(0, result.bytesRead));
+                    controller.enqueue(result.buffer.slice(0, result.bytesRead));
                     position += result.bytesRead;
                     if (++i >= maxChunks) {
                         throw new ErrnoError(Errno.EFBIG, 'Too many iterations on readable stream', this.file.path, 'FileHandle.readableWebStream');
@@ -188,10 +188,14 @@ export class FileHandle {
                 }
             }
             catch (e) {
-                error(e);
+                controller.error(e);
             }
         };
-        return new globalThis.ReadableStream({ start, type: options.type });
+        const _gt = globalThis;
+        if (!('ReadableStream' in _gt)) {
+            throw new ErrnoError(Errno.ENOSYS, 'ReadableStream is missing on globalThis');
+        }
+        return new _gt.ReadableStream({ start, type: options.type });
     }
     readLines(options) {
         throw ErrnoError.With('ENOSYS', this.file.path, 'FileHandle.readLines');
@@ -290,6 +294,7 @@ export class FileHandle {
         const stream = new ReadStream({
             highWaterMark: options?.highWaterMark || 64 * 1024,
             encoding: options.encoding,
+            // eslint-disable-next-line @typescript-eslint/no-misused-promises
             read: async (size) => {
                 try {
                     const result = await this.read(new Uint8Array(size), 0, size, this.file.position);

package/dist/emulation/sync.d.ts

@@ -247,6 +247,7 @@ export declare function symlinkSync(target: fs.PathLike, path: fs.PathLike, type
  */
 export declare function readlinkSync(path: fs.PathLike, options?: fs.BufferEncodingOption): Buffer;
 export declare function readlinkSync(path: fs.PathLike, options: fs.EncodingOption | BufferEncoding): string;
+export declare function readlinkSync(path: fs.PathLike, options?: fs.EncodingOption | BufferEncoding | fs.BufferEncodingOption): Buffer | string;
 /**
  * Synchronous `chown`.
  * @param path

package/dist/emulation/sync.js

@@ -618,7 +618,7 @@ export function realpathSync(path, options) {
         if (!stats.isSymbolicLink()) {
             return lpath;
         }
-        return realpathSync(mountPoint + readlinkSync(lpath));
+        return realpathSync(mountPoint + readlinkSync(lpath, options).toString());
     }
     catch (e) {
         throw fixError(e, { [resolvedPath]: lpath });

package/dist/file.js

@@ -228,8 +228,8 @@ export class PreloadFile extends File {
     /**
      * Asynchronous `stat`.
      */
-    async stat() {
-        return new Stats(this.stats);
+    stat() {
+        return Promise.resolve(new Stats(this.stats));
     }
     /**
      * Synchronous `stat`.
@@ -453,8 +453,8 @@ export class NoSyncFile extends PreloadFile {
     /**
      * Asynchronous sync. Doesn't do anything, simply calls the cb.
      */
-    async sync() {
-        return;
+    sync() {
+        return Promise.resolve();
     }
     /**
      * Synchronous sync. Doesn't do anything.
@@ -465,8 +465,8 @@ export class NoSyncFile extends PreloadFile {
     /**
      * Asynchronous close. Doesn't do anything, simply calls the cb.
      */
-    async close() {
-        return;
+    close() {
+        return Promise.resolve();
     }
     /**
      * Synchronous close. Doesn't do anything.

package/dist/filesystem.js

@@ -301,7 +301,7 @@ export function Async(FS) {
          */
         queue(...op) {
             this._queue.push(op);
-            this._next();
+            void this._next();
         }
     }
     return AsyncFS;

package/dist/inode.d.ts

@@ -13,7 +13,7 @@ export declare const size_max: number;
  * Room inode
  * @hidden
  */
-export declare const rootIno: 0n;
+export declare const rootIno = 0n;
 /**
  * Generate a random ino
  * @internal

package/dist/inode.js

@@ -25,20 +25,37 @@ export function randomIno() {
 /**
  * Offsets for inode members
  */
-var Offset;
-(function (Offset) {
-    Offset[Offset["ino"] = 0] = "ino";
-    Offset[Offset["size"] = 8] = "size";
-    Offset[Offset["mode"] = 12] = "mode";
-    Offset[Offset["nlink"] = 14] = "nlink";
-    Offset[Offset["uid"] = 18] = "uid";
-    Offset[Offset["gid"] = 22] = "gid";
-    Offset[Offset["atime"] = 26] = "atime";
-    Offset[Offset["birthtime"] = 34] = "birthtime";
-    Offset[Offset["mtime"] = 42] = "mtime";
-    Offset[Offset["ctime"] = 50] = "ctime";
-    Offset[Offset["end"] = 58] = "end";
-})(Offset || (Offset = {}));
+const offsets = {
+    ino: 0,
+    size: 8,
+    mode: 12,
+    nlink: 14,
+    uid: 18,
+    gid: 22,
+    atime: 26,
+    birthtime: 34,
+    mtime: 42,
+    ctime: 50,
+    end: 58,
+};
+/**
+ *  Offsets for a 64-bit inode's members
+ * Currently unused
+ */
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+const offsets_64 = {
+    ino: 0,
+    size: 8,
+    mode: 16,
+    nlink: 18,
+    uid: 22,
+    gid: 26,
+    atime: 30,
+    birthtime: 38,
+    mtime: 46,
+    ctime: 54,
+    end: 62,
+};
 /**
  * Generic inode definition that can easily be serialized.
  */
@@ -48,9 +65,9 @@ export class Inode {
     }
     constructor(buffer) {
         const setDefaults = !buffer;
-        buffer ?? (buffer = new ArrayBuffer(Offset.end));
-        if (buffer?.byteLength < Offset.end) {
-            throw new RangeError(`Can not create an inode from a buffer less than ${Offset.end} bytes`);
+        buffer ?? (buffer = new ArrayBuffer(offsets.end));
+        if (buffer?.byteLength < offsets.end) {
+            throw new RangeError(`Can not create an inode from a buffer less than ${offsets.end} bytes`);
         }
         this.view = new DataView(buffer);
         this.buffer = buffer;
@@ -68,64 +85,64 @@ export class Inode {
         this.birthtimeMs = now;
     }
     get ino() {
-        return this.view.getBigUint64(Offset.ino, true);
+        return this.view.getBigUint64(offsets.ino, true);
     }
     set ino(value) {
-        this.view.setBigUint64(Offset.ino, value, true);
+        this.view.setBigUint64(offsets.ino, value, true);
     }
     get size() {
-        return this.view.getUint32(Offset.size, true);
+        return this.view.getUint32(offsets.size, true);
     }
     set size(value) {
-        this.view.setUint32(Offset.size, value, true);
+        this.view.setUint32(offsets.size, value, true);
     }
     get mode() {
-        return this.view.getUint16(Offset.mode, true);
+        return this.view.getUint16(offsets.mode, true);
     }
     set mode(value) {
-        this.view.setUint16(Offset.mode, value, true);
+        this.view.setUint16(offsets.mode, value, true);
     }
     get nlink() {
-        return this.view.getUint32(Offset.nlink, true);
+        return this.view.getUint32(offsets.nlink, true);
     }
     set nlink(value) {
-        this.view.setUint32(Offset.nlink, value, true);
+        this.view.setUint32(offsets.nlink, value, true);
     }
     get uid() {
-        return this.view.getUint32(Offset.uid, true);
+        return this.view.getUint32(offsets.uid, true);
     }
     set uid(value) {
-        this.view.setUint32(Offset.uid, value, true);
+        this.view.setUint32(offsets.uid, value, true);
     }
     get gid() {
-        return this.view.getUint32(Offset.gid, true);
+        return this.view.getUint32(offsets.gid, true);
     }
     set gid(value) {
-        this.view.setUint32(Offset.gid, value, true);
+        this.view.setUint32(offsets.gid, value, true);
     }
     get atimeMs() {
-        return this.view.getFloat64(Offset.atime, true);
+        return this.view.getFloat64(offsets.atime, true);
     }
     set atimeMs(value) {
-        this.view.setFloat64(Offset.atime, value, true);
+        this.view.setFloat64(offsets.atime, value, true);
     }
     get birthtimeMs() {
-        return this.view.getFloat64(Offset.birthtime, true);
+        return this.view.getFloat64(offsets.birthtime, true);
     }
     set birthtimeMs(value) {
-        this.view.setFloat64(Offset.birthtime, value, true);
+        this.view.setFloat64(offsets.birthtime, value, true);
     }
     get mtimeMs() {
-        return this.view.getFloat64(Offset.mtime, true);
+        return this.view.getFloat64(offsets.mtime, true);
     }
     set mtimeMs(value) {
-        this.view.setFloat64(Offset.mtime, value, true);
+        this.view.setFloat64(offsets.mtime, value, true);
     }
     get ctimeMs() {
-        return this.view.getFloat64(Offset.ctime, true);
+        return this.view.getFloat64(offsets.ctime, true);
     }
     set ctimeMs(value) {
-        this.view.setFloat64(Offset.ctime, value, true);
+        this.view.setFloat64(offsets.ctime, value, true);
     }
     /**
      * Handy function that converts the Inode to a Node Stats object.

package/dist/polyfills.js

@@ -1,3 +1,4 @@
+// eslint-disable-next-line @typescript-eslint/unbound-method
 Promise.withResolvers ?? (Promise.withResolvers = function () {
     let _resolve, 
     // eslint-disable-next-line @typescript-eslint/no-explicit-any

package/dist/utils.d.ts

@@ -56,7 +56,7 @@ export declare function _toUnixTimestamp(time: Date | number): number;
  * Normalizes a mode
  * @internal
  */
-export declare function normalizeMode(mode: string | number | unknown, def?: number): number;
+export declare function normalizeMode(mode: unknown, def?: number): number;
 /**
  * Normalizes a time
  * @internal

package/dist/utils.js

@@ -146,7 +146,7 @@ export function _toUnixTimestamp(time) {
     if (time instanceof Date) {
         return Math.floor(time.getTime() / 1000);
     }
-    throw new Error('Cannot parse time: ' + time);
+    throw new Error('Cannot parse time');
 }
 /**
  * Normalizes a mode

package/eslint.shared.js

@@ -0,0 +1,53 @@
+/*
+	Shared eslint rules
+*/
+
+import eslint from '@eslint/js';
+import stylistic from '@stylistic/eslint-plugin';
+import globals from 'globals';
+import tseslint from 'typescript-eslint';
+
+export default {
+	name: 'ZenFS',
+	extends: [eslint.configs.recommended, ...tseslint.configs.recommendedTypeChecked],
+	files: ['src/**/*.ts', 'tests/**/*.ts'],
+	languageOptions: {
+		globals: { ...globals.browser, ...globals.node },
+		ecmaVersion: 'latest',
+		sourceType: 'module',
+	},
+	plugins: { stylistic },
+	rules: {
+		'no-useless-escape': 'warn',
+		'stylistic/no-mixed-spaces-and-tabs': 'warn',
+		'no-unreachable': 'warn',
+		'stylistic/no-extra-semi': 'warn',
+		'no-fallthrough': 'warn',
+		'no-empty': 'warn',
+		'no-case-declarations': 'warn',
+		'prefer-const': 'warn',
+		'prefer-rest-params': 'warn',
+		'prefer-spread': 'warn',
+		'no-unused-vars': 'off',
+		'@typescript-eslint/no-unused-vars': 'warn',
+		'@typescript-eslint/no-inferrable-types': 'off',
+		'@typescript-eslint/no-this-alias': 'off',
+		'@typescript-eslint/no-unsafe-function-type': 'warn',
+		'@typescript-eslint/no-wrapper-object-types': 'warn',
+		'@typescript-eslint/triple-slash-reference': 'warn',
+		'@typescript-eslint/no-non-null-assertion': 'off',
+		'@typescript-eslint/no-namespace': 'warn',
+		'@typescript-eslint/prefer-as-const': 'warn',
+		'@typescript-eslint/no-explicit-any': 'warn',
+		'@typescript-eslint/consistent-type-assertions': 'warn',
+		'@typescript-eslint/consistent-type-imports': 'warn',
+		'@typescript-eslint/no-unnecessary-type-assertion': 'warn',
+		'@typescript-eslint/require-await': 'warn',
+		'@typescript-eslint/no-unsafe-return': 'warn',
+		'@typescript-eslint/no-unsafe-assignment': 'warn',
+		'@typescript-eslint/no-unsafe-member-access': 'warn',
+		'@typescript-eslint/no-unsafe-argument': 'warn',
+		'@typescript-eslint/no-redundant-type-constituents': 'warn',
+		'@typescript-eslint/no-unsafe-call': 'warn',
+	},
+};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@zenfs/core",
-	"version": "0.16.0",
+	"version": "0.16.2",
 	"description": "A filesystem, anywhere",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
@@ -17,7 +17,8 @@
 		"dist",
 		"src",
 		"license.md",
-		"tsconfig.json"
+		"tsconfig.json",
+		"eslint.shared.js"
 	],
 	"type": "module",
 	"homepage": "https://github.com/zen-fs/core",
@@ -51,6 +52,11 @@
 		"dev": "npm run build -- --watch",
 		"prepublishOnly": "npm run build"
 	},
+	"lint-staged": {
+		"*": [
+			"prettier --write"
+		]
+	},
 	"dependencies": {
 		"@types/node": "^20.12.12",
 		"@types/readable-stream": "^4.0.10",
@@ -61,19 +67,23 @@
 		"utilium": "^0.4.0"
 	},
 	"devDependencies": {
+		"@eslint/js": "^9.8.0",
 		"@fal-works/esbuild-plugin-global-externals": "^2.1.2",
 		"@jest/globals": "^29.5.0",
+		"@stylistic/eslint-plugin": "^2.6.1",
+		"@types/eslint__js": "^8.42.3",
 		"@types/jest": "^29.5.1",
-		"@typescript-eslint/eslint-plugin": "^7.7.0",
-		"@typescript-eslint/parser": "^7.7.0",
 		"cross-env": "^7.0.3",
 		"esbuild": "^0.21.0",
-		"eslint": "^8.36.0",
+		"eslint": "^9.8.0",
+		"globals": "^15.9.0",
 		"jest": "^29.7.0",
+		"lint-staged": "^15.2.7",
 		"prettier": "^3.2.5",
 		"ts-jest": "^29.1.5",
 		"typedoc": "^0.25.13",
 		"typedoc-plugin-remove-references": "^0.0.6",
-		"typescript": "^5.4.0"
+		"typescript": "^5.4.0",
+		"typescript-eslint": "^8.0.0"
 	}
 }

package/src/backends/fetch.ts

@@ -15,21 +15,22 @@ import type { IndexData } from './index/index.js';
 async function fetchFile(path: string, type: 'buffer'): Promise<Uint8Array>;
 async function fetchFile<T extends object>(path: string, type: 'json'): Promise<T>;
 async function fetchFile<T extends object>(path: string, type: 'buffer' | 'json'): Promise<T | Uint8Array>;
-async function fetchFile<T extends object>(path: string, type: 'buffer' | 'json'): Promise<T | Uint8Array> {
-	const response = await fetch(path).catch(e => {
+async function fetchFile<T extends object>(path: string, type: string): Promise<T | Uint8Array> {
+	const response = await fetch(path).catch((e: Error) => {
 		throw new ErrnoError(Errno.EIO, e.message);
 	});
 	if (!response.ok) {
 		throw new ErrnoError(Errno.EIO, 'fetch failed: response returned code ' + response.status);
 	}
 	switch (type) {
-		case 'buffer':
-			const arrayBuffer = await response.arrayBuffer().catch(e => {
+		case 'buffer': {
+			const arrayBuffer = await response.arrayBuffer().catch((e: Error) => {
 				throw new ErrnoError(Errno.EIO, e.message);
 			});
 			return new Uint8Array(arrayBuffer);
+		}
 		case 'json':
-			return response.json().catch(e => {
+			return response.json().catch((e: Error) => {
 				throw new ErrnoError(Errno.EIO, e.message);
 			}) as Promise<T>;
 		default:

package/src/backends/index/fs.ts

@@ -39,8 +39,8 @@ export abstract class IndexFS extends Readonly(FileSystem) {
 		}
 	}
 
-	public async stat(path: string): Promise<Stats> {
-		return this.statSync(path);
+	public stat(path: string): Promise<Stats> {
+		return Promise.resolve(this.statSync(path));
 	}
 
 	public statSync(path: string): Stats {
@@ -91,8 +91,8 @@ export abstract class IndexFS extends Readonly(FileSystem) {
 		return new NoSyncFile(this, path, flag, stats, stats.isDirectory() ? stats.fileData : this.getDataSync(path, stats));
 	}
 
-	public async readdir(path: string): Promise<string[]> {
-		return this.readdirSync(path);
+	public readdir(path: string): Promise<string[]> {
+		return Promise.resolve(this.readdirSync(path));
 	}
 
 	public readdirSync(path: string): string[] {
@@ -106,7 +106,14 @@ export abstract class IndexFS extends Readonly(FileSystem) {
 			throw ErrnoError.With('ENOTDIR', path, 'readdir');
 		}
 
-		return JSON.parse(decode(stats.fileData));
+		const content: unknown = JSON.parse(decode(stats.fileData));
+		if (!Array.isArray(content)) {
+			throw ErrnoError.With('ENODATA', path, 'readdir');
+		}
+		if (!content.every(item => typeof item == 'string')) {
+			throw ErrnoError.With('ENODATA', path, 'readdir');
+		}
+		return content as string[];
 	}
 
 	protected abstract getData(path: string, stats: Stats): Promise<Uint8Array>;

package/src/backends/index/index.ts

@@ -96,7 +96,7 @@ export class Index extends Map<string, Stats> {
 			throw new ErrnoError(Errno.EINVAL, 'Invalid JSON');
 		}
 
-		const json = JSON.parse(data);
+		const json = JSON.parse(data) as IndexData;
 		const index = new Index();
 		index.fromJSON(json);
 		return index;