@zenfs/core 1.3.6 → 1.4.0

package/src/stats.ts

@@ -1,405 +0,0 @@
-import type * as Node from 'node:fs';
-import { credentials } from './credentials.js';
-import {
-	R_OK,
-	S_IFBLK,
-	S_IFCHR,
-	S_IFDIR,
-	S_IFIFO,
-	S_IFLNK,
-	S_IFMT,
-	S_IFREG,
-	S_IFSOCK,
-	S_IRGRP,
-	S_IROTH,
-	S_IRUSR,
-	S_IWGRP,
-	S_IWOTH,
-	S_IWUSR,
-	S_IXGRP,
-	S_IXOTH,
-	S_IXUSR,
-	size_max,
-	W_OK,
-	X_OK,
-} from './emulation/constants.js';
-
-/**
- * Indicates the type of a file. Applied to 'mode'.
- */
-export type FileType = typeof S_IFREG | typeof S_IFDIR | typeof S_IFLNK;
-
-export interface StatsLike<T extends number | bigint = number | bigint> {
-	/**
-	 * Size of the item in bytes.
-	 * For directories/symlinks, this is normally the size of the struct that represents the item.
-	 */
-	size: T;
-	/**
-	 * Unix-style file mode (e.g. 0o644) that includes the item type
-	 */
-	mode: T;
-	/**
-	 * Time of last access, since epoch
-	 */
-	atimeMs: T;
-	/**
-	 * Time of last modification, since epoch
-	 */
-	mtimeMs: T;
-	/**
-	 * Time of last time file status was changed, since epoch
-	 */
-	ctimeMs: T;
-	/**
-	 * Time of file creation, since epoch
-	 */
-	birthtimeMs: T;
-	/**
-	 * The id of the user that owns the file
-	 */
-	uid: T;
-	/**
-	 * The id of the group that owns the file
-	 */
-	gid: T;
-	/**
-	 * Inode number
-	 */
-	ino: T;
-	/**
-	 * Number of hard links
-	 */
-	nlink: T;
-}
-
-/**
- * Provides information about a particular entry in the file system.
- * Common code used by both Stats and BigIntStats.
- */
-export abstract class StatsCommon<T extends number | bigint> implements Node.StatsBase<T>, StatsLike {
-	protected abstract _isBigint: T extends bigint ? true : false;
-
-	protected _convert(arg: number | bigint | string | boolean): T {
-		return (this._isBigint ? BigInt(arg) : Number(arg)) as T;
-	}
-
-	public get blocks(): T {
-		return this._convert(Math.ceil(Number(this.size) / 512));
-	}
-
-	/**
-	 * Unix-style file mode (e.g. 0o644) that includes the type of the item.
-	 * Type of the item can be FILE, DIRECTORY, SYMLINK, or SOCKET
-	 */
-	public mode: T;
-
-	/**
-	 * ID of device containing file
-	 */
-	public dev: T = this._convert(0);
-
-	/**
-	 * Inode number
-	 */
-	public ino: T = this._convert(0);
-
-	/**
-	 * Device ID (if special file)
-	 */
-	public rdev: T = this._convert(0);
-
-	/**
-	 * Number of hard links
-	 */
-	public nlink: T = this._convert(1);
-
-	/**
-	 * Block size for file system I/O
-	 */
-	public blksize: T = this._convert(4096);
-
-	/**
-	 * User ID of owner
-	 */
-	public uid: T = this._convert(0);
-
-	/**
-	 * Group ID of owner
-	 */
-	public gid: T = this._convert(0);
-
-	/**
-	 * Some file systems stash data on stats objects.
-	 */
-	public fileData?: Uint8Array;
-
-	/**
-	 * Time of last access, since epoch
-	 */
-	public atimeMs: T;
-
-	public get atime(): Date {
-		return new Date(Number(this.atimeMs));
-	}
-
-	public set atime(value: Date) {
-		this.atimeMs = this._convert(value.getTime());
-	}
-
-	/**
-	 * Time of last modification, since epoch
-	 */
-	public mtimeMs: T;
-
-	public get mtime(): Date {
-		return new Date(Number(this.mtimeMs));
-	}
-
-	public set mtime(value: Date) {
-		this.mtimeMs = this._convert(value.getTime());
-	}
-
-	/**
-	 * Time of last time file status was changed, since epoch
-	 */
-	public ctimeMs: T;
-
-	public get ctime(): Date {
-		return new Date(Number(this.ctimeMs));
-	}
-
-	public set ctime(value: Date) {
-		this.ctimeMs = this._convert(value.getTime());
-	}
-
-	/**
-	 * Time of file creation, since epoch
-	 */
-	public birthtimeMs: T;
-
-	public get birthtime(): Date {
-		return new Date(Number(this.birthtimeMs));
-	}
-
-	public set birthtime(value: Date) {
-		this.birthtimeMs = this._convert(value.getTime());
-	}
-
-	/**
-	 * Size of the item in bytes.
-	 * For directories/symlinks, this is normally the size of the struct that represents the item.
-	 */
-	public size: T;
-
-	/**
-	 * Creates a new stats instance from a stats-like object. Can be used to copy stats (note)
-	 */
-	public constructor({ atimeMs, mtimeMs, ctimeMs, birthtimeMs, uid, gid, size, mode, ino }: Partial<StatsLike> = {}) {
-		const now = Date.now();
-		this.atimeMs = this._convert(atimeMs ?? now);
-		this.mtimeMs = this._convert(mtimeMs ?? now);
-		this.ctimeMs = this._convert(ctimeMs ?? now);
-		this.birthtimeMs = this._convert(birthtimeMs ?? now);
-		this.uid = this._convert(uid ?? 0);
-		this.gid = this._convert(gid ?? 0);
-		this.size = this._convert(size ?? 0);
-		this.ino = this._convert(ino ?? 0);
-		this.mode = this._convert(mode ?? 0o644 & S_IFREG);
-
-		if ((this.mode & S_IFMT) == 0) {
-			this.mode = (this.mode | this._convert(S_IFREG)) as T;
-		}
-	}
-
-	public isFile(): boolean {
-		return (this.mode & S_IFMT) === S_IFREG;
-	}
-
-	public isDirectory(): boolean {
-		return (this.mode & S_IFMT) === S_IFDIR;
-	}
-
-	public isSymbolicLink(): boolean {
-		return (this.mode & S_IFMT) === S_IFLNK;
-	}
-
-	public isSocket(): boolean {
-		return (this.mode & S_IFMT) === S_IFSOCK;
-	}
-
-	public isBlockDevice(): boolean {
-		return (this.mode & S_IFMT) === S_IFBLK;
-	}
-
-	public isCharacterDevice(): boolean {
-		return (this.mode & S_IFMT) === S_IFCHR;
-	}
-
-	public isFIFO(): boolean {
-		return (this.mode & S_IFMT) === S_IFIFO;
-	}
-
-	/**
-	 * Checks if a given user/group has access to this item
-	 * @param mode The requested access, combination of W_OK, R_OK, and X_OK
-	 * @returns True if the request has access, false if the request does not
-	 * @internal
-	 */
-	public hasAccess(mode: number): boolean {
-		if (this.isSymbolicLink() || credentials.euid === 0 || credentials.egid === 0) return true;
-
-		let perm = 0;
-
-		// Owner permissions
-		if (credentials.uid === this.uid) {
-			if (this.mode & S_IRUSR) perm |= R_OK;
-			if (this.mode & S_IWUSR) perm |= W_OK;
-			if (this.mode & S_IXUSR) perm |= X_OK;
-		}
-
-		// Group permissions
-		if (credentials.gid === this.gid || credentials.groups.includes(Number(this.gid))) {
-			if (this.mode & S_IRGRP) perm |= R_OK;
-			if (this.mode & S_IWGRP) perm |= W_OK;
-			if (this.mode & S_IXGRP) perm |= X_OK;
-		}
-
-		// Others permissions
-		if (this.mode & S_IROTH) perm |= R_OK;
-		if (this.mode & S_IWOTH) perm |= W_OK;
-		if (this.mode & S_IXOTH) perm |= X_OK;
-
-		// Perform the access check
-		return (perm & mode) === mode;
-	}
-
-	/**
-	 * Change the mode of the file.
-	 * We use this helper function to prevent messing up the type of the file.
-	 * @internal
-	 * @deprecated This will be removed in the next minor release since it is internal
-	 */
-	public chmod(mode: number): void {
-		this.mode = this._convert((this.mode & S_IFMT) | mode);
-	}
-
-	/**
-	 * Change the owner user/group of the file.
-	 * This function makes sure it is a valid UID/GID (that is, a 32 unsigned int)
-	 * @internal
-	 * @deprecated This will be removed in the next minor release since it is internal
-	 */
-	public chown(uid: number, gid: number): void {
-		uid = Number(uid);
-		gid = Number(gid);
-		if (!isNaN(uid) && 0 <= uid && uid < 2 ** 32) {
-			this.uid = this._convert(uid);
-		}
-		if (!isNaN(gid) && 0 <= gid && gid < 2 ** 32) {
-			this.gid = this._convert(gid);
-		}
-	}
-
-	public get atimeNs(): bigint {
-		return BigInt(this.atimeMs) * 1000n;
-	}
-
-	public get mtimeNs(): bigint {
-		return BigInt(this.mtimeMs) * 1000n;
-	}
-
-	public get ctimeNs(): bigint {
-		return BigInt(this.ctimeMs) * 1000n;
-	}
-
-	public get birthtimeNs(): bigint {
-		return BigInt(this.birthtimeMs) * 1000n;
-	}
-}
-
-/**
- * @hidden @internal
- */
-export function _chown(stats: Partial<StatsLike<number>>, uid: number, gid: number) {
-	if (!isNaN(uid) && 0 <= uid && uid < 2 ** 32) {
-		stats.uid = uid;
-	}
-	if (!isNaN(gid) && 0 <= gid && gid < 2 ** 32) {
-		stats.gid = gid;
-	}
-}
-
-/**
- * Implementation of Node's `Stats`.
- *
- * Attribute descriptions are from `man 2 stat'
- * @see http://nodejs.org/api/fs.html#fs_class_fs_stats
- * @see http://man7.org/linux/man-pages/man2/stat.2.html
- */
-export class Stats extends StatsCommon<number> implements Node.Stats, StatsLike {
-	protected _isBigint = false as const;
-}
-Stats satisfies typeof Node.Stats;
-
-/**
- * Stats with bigint
- */
-export class BigIntStats extends StatsCommon<bigint> implements Node.BigIntStats, StatsLike {
-	protected _isBigint = true as const;
-}
-
-/**
- * Determines if the file stats have changed by comparing relevant properties.
- *
- * @param left The previous stats.
- * @param right The current stats.
- * @returns `true` if stats have changed; otherwise, `false`.
- * @internal
- */
-export function isStatsEqual<T extends number | bigint>(left: StatsCommon<T>, right: StatsCommon<T>): boolean {
-	return left.size == right.size && +left.atime == +right.atime && +left.mtime == +right.mtime && +left.ctime == +right.ctime && left.mode == right.mode;
-}
-
-/** @internal */
-export const ZenFsType = 0x7a656e6673; // 'z' 'e' 'n' 'f' 's'
-
-/**
- * @hidden
- */
-export class StatsFs implements Node.StatsFsBase<number> {
-	/** Type of file system. */
-	public type: number = 0x7a656e6673;
-	/**  Optimal transfer block size. */
-	public bsize: number = 4096;
-	/**  Total data blocks in file system. */
-	public blocks: number = 0;
-	/** Free blocks in file system. */
-	public bfree: number = 0;
-	/** Available blocks for unprivileged users */
-	public bavail: number = 0;
-	/** Total file nodes in file system. */
-	public files: number = size_max;
-	/** Free file nodes in file system. */
-	public ffree: number = size_max;
-}
-
-/**
- * @hidden
- */
-export class BigIntStatsFs implements Node.StatsFsBase<bigint> {
-	/** Type of file system. */
-	public type: bigint = 0x7a656e6673n;
-	/**  Optimal transfer block size. */
-	public bsize: bigint = 4096n;
-	/**  Total data blocks in file system. */
-	public blocks: bigint = 0n;
-	/** Free blocks in file system. */
-	public bfree: bigint = 0n;
-	/** Available blocks for unprivileged users */
-	public bavail: bigint = 0n;
-	/** Total file nodes in file system. */
-	public files: bigint = BigInt(size_max);
-	/** Free file nodes in file system. */
-	public ffree: bigint = BigInt(size_max);
-}

package/src/utils.ts

@@ -1,276 +0,0 @@
-/* eslint-disable @typescript-eslint/no-unsafe-member-access,@typescript-eslint/no-unsafe-call,@typescript-eslint/no-unsafe-return */
-import type * as fs from 'node:fs';
-import type { ClassLike, OptionalTuple } from 'utilium';
-import { dirname, resolve, type AbsolutePath } from './emulation/path.js';
-import { Errno, ErrnoError } from './error.js';
-import type { FileSystem } from './filesystem.js';
-
-declare global {
-	function atob(data: string): string;
-	function btoa(data: string): string;
-}
-
-/**
- * Synchronous recursive makedir.
- * @hidden
- */
-export function mkdirpSync(path: string, mode: number, fs: FileSystem): void {
-	if (!fs.existsSync(path)) {
-		mkdirpSync(dirname(path), mode, fs);
-		fs.mkdirSync(path, mode);
-	}
-}
-
-function _min(d0: number, d1: number, d2: number, bx: number, ay: number): number {
-	return Math.min(d0 + 1, d1 + 1, d2 + 1, bx === ay ? d1 : d1 + 1);
-}
-
-/**
- * Calculates levenshtein distance.
- * @hidden
- */
-export function levenshtein(a: string, b: string): number {
-	if (a === b) {
-		return 0;
-	}
-
-	if (a.length > b.length) {
-		[a, b] = [b, a]; // Swap a and b
-	}
-
-	let la = a.length;
-	let lb = b.length;
-
-	// Trim common suffix
-	while (la > 0 && a.charCodeAt(la - 1) === b.charCodeAt(lb - 1)) {
-		la--;
-		lb--;
-	}
-
-	let offset = 0;
-
-	// Trim common prefix
-	while (offset < la && a.charCodeAt(offset) === b.charCodeAt(offset)) {
-		offset++;
-	}
-
-	la -= offset;
-	lb -= offset;
-
-	if (la === 0 || lb === 1) {
-		return lb;
-	}
-
-	const vector = new Array<number>(la << 1);
-
-	for (let y = 0; y < la; ) {
-		vector[la + y] = a.charCodeAt(offset + y);
-		vector[y] = ++y;
-	}
-
-	let x: number;
-	let d0: number;
-	let d1: number;
-	let d2: number;
-	let d3: number;
-	for (x = 0; x + 3 < lb; ) {
-		const bx0 = b.charCodeAt(offset + (d0 = x));
-		const bx1 = b.charCodeAt(offset + (d1 = x + 1));
-		const bx2 = b.charCodeAt(offset + (d2 = x + 2));
-		const bx3 = b.charCodeAt(offset + (d3 = x + 3));
-		let dd = (x += 4);
-		for (let y = 0; y < la; ) {
-			const ay = vector[la + y];
-			const dy = vector[y];
-			d0 = _min(dy, d0, d1, bx0, ay);
-			d1 = _min(d0, d1, d2, bx1, ay);
-			d2 = _min(d1, d2, d3, bx2, ay);
-			dd = _min(d2, d3, dd, bx3, ay);
-			vector[y++] = dd;
-			d3 = d2;
-			d2 = d1;
-			d1 = d0;
-			d0 = dy;
-		}
-	}
-
-	let dd: number = 0;
-	for (; x < lb; ) {
-		const bx0 = b.charCodeAt(offset + (d0 = x));
-		dd = ++x;
-		for (let y = 0; y < la; y++) {
-			const dy = vector[y];
-			vector[y] = dd = dy < d0 || dd < d0 ? (dy > dd ? dd + 1 : dy + 1) : bx0 === vector[la + y] ? d0 : d0 + 1;
-			d0 = dy;
-		}
-	}
-
-	return dd;
-}
-
-/**
- * Encodes a string into a buffer
- * @internal
- */
-export function encodeRaw(input: string): Uint8Array {
-	if (typeof input != 'string') {
-		throw new ErrnoError(Errno.EINVAL, 'Can not encode a non-string');
-	}
-	return new Uint8Array(Array.from(input).map(char => char.charCodeAt(0)));
-}
-
-/**
- * Decodes a string from a buffer
- * @internal
- */
-export function decodeRaw(input?: Uint8Array): string {
-	if (!(input instanceof Uint8Array)) {
-		throw new ErrnoError(Errno.EINVAL, 'Can not decode a non-Uint8Array');
-	}
-
-	return Array.from(input)
-		.map(char => String.fromCharCode(char))
-		.join('');
-}
-
-const encoder = new TextEncoder();
-
-/**
- * Encodes a string into a buffer
- * @internal
- */
-export function encodeUTF8(input: string): Uint8Array {
-	if (typeof input != 'string') {
-		throw new ErrnoError(Errno.EINVAL, 'Can not encode a non-string');
-	}
-	return encoder.encode(input);
-}
-
-export { /** @deprecated @hidden */ encodeUTF8 as encode };
-
-const decoder = new TextDecoder();
-
-/**
- * Decodes a string from a buffer
- * @internal
- */
-export function decodeUTF8(input?: Uint8Array): string {
-	if (!(input instanceof Uint8Array)) {
-		throw new ErrnoError(Errno.EINVAL, 'Can not decode a non-Uint8Array');
-	}
-
-	return decoder.decode(input);
-}
-
-export { /** @deprecated @hidden */ decodeUTF8 as decode };
-
-/**
- * Decodes a directory listing
- * @hidden
- */
-export function decodeDirListing(data: Uint8Array): Record<string, bigint> {
-	return JSON.parse(decodeUTF8(data), (k, v) => (k == '' ? v : BigInt(v as string)));
-}
-
-/**
- * Encodes a directory listing
- * @hidden
- */
-export function encodeDirListing(data: Record<string, bigint>): Uint8Array {
-	return encodeUTF8(JSON.stringify(data, (k, v) => (k == '' ? v : v.toString())));
-}
-
-export type Callback<Args extends unknown[] = []> = (e?: ErrnoError, ...args: OptionalTuple<Args>) => unknown;
-
-/**
- * Normalizes a mode
- * @internal
- */
-export function normalizeMode(mode: unknown, def?: number): number {
-	if (typeof mode == 'number') {
-		return mode;
-	}
-
-	if (typeof mode == 'string') {
-		const parsed = parseInt(mode, 8);
-		if (!isNaN(parsed)) {
-			return parsed;
-		}
-	}
-
-	if (typeof def == 'number') {
-		return def;
-	}
-
-	throw new ErrnoError(Errno.EINVAL, 'Invalid mode: ' + mode?.toString());
-}
-
-/**
- * Normalizes a time
- * @internal
- */
-export function normalizeTime(time: string | number | Date): Date {
-	if (time instanceof Date) {
-		return time;
-	}
-
-	try {
-		return new Date(time);
-	} catch {
-		throw new ErrnoError(Errno.EINVAL, 'Invalid time.');
-	}
-}
-
-/**
- * Normalizes a path
- * @internal
- */
-export function normalizePath(p: fs.PathLike): AbsolutePath {
-	p = p.toString();
-	if (p.includes('\x00')) {
-		throw new ErrnoError(Errno.EINVAL, 'Path can not contain null character');
-	}
-	if (p.length == 0) {
-		throw new ErrnoError(Errno.EINVAL, 'Path can not be empty');
-	}
-	return resolve(p.replaceAll(/[/\\]+/g, '/'));
-}
-
-/**
- * Normalizes options
- * @param options options to normalize
- * @param encoding default encoding
- * @param flag default flag
- * @param mode default mode
- * @internal
- */
-export function normalizeOptions(
-	options: fs.WriteFileOptions | (fs.EncodingOption & { flag?: fs.OpenMode }) | undefined,
-	encoding: BufferEncoding | null = 'utf8',
-	flag: string,
-	mode: number = 0
-): { encoding?: BufferEncoding | null; flag: string; mode: number } {
-	if (typeof options != 'object' || options === null) {
-		return {
-			encoding: typeof options == 'string' ? options : encoding ?? null,
-			flag,
-			mode,
-		};
-	}
-
-	return {
-		encoding: typeof options?.encoding == 'string' ? options.encoding : encoding ?? null,
-		flag: typeof options?.flag == 'string' ? options.flag : flag,
-		mode: normalizeMode('mode' in options ? options?.mode : null, mode),
-	};
-}
-
-export type Concrete<T extends ClassLike> = Pick<T, keyof T> & (new (...args: any[]) => InstanceType<T>);
-
-/**
- * Generate a random ino
- * @internal
- */
-export function randomBigInt(): bigint {
-	return crypto.getRandomValues(new BigUint64Array(1))[0];
-}

package/tests/mounts.test.ts

@@ -1,18 +0,0 @@
-import assert from 'node:assert';
-import { suite, test } from 'node:test';
-import { configure } from '../src/config.js';
-import * as fs from '../src/emulation/index.js';
-import { InMemory } from '../src/index.js';
-
-suite('Mounts', () => {
-	test('Mount in nested directory', async () => {
-		await configure({
-			mounts: {
-				'/nested/dir': InMemory,
-			},
-		});
-
-		assert.deepStrictEqual(fs.readdirSync('/'), ['nested']);
-		assert.deepStrictEqual(fs.readdirSync('/nested'), ['dir']);
-	});
-});