@zenfs/core 2.2.2 → 2.2.3

package/dist/backends/single_buffer.js

@@ -486,6 +486,7 @@ let SuperBlock = (() => {
          * @returns the new metadata block
          */
         rotateMetadata() {
+            this.used_bytes += this.used_bytes % BigInt(4);
             const metadata = new MetadataBlock(this.buffer, Number(this.used_bytes));
             metadata.previous_offset = this.metadata_offset;
             this.metadata = metadata;

package/dist/internal/credentials.d.ts

@@ -28,3 +28,9 @@ export interface CredentialsInit extends Partial<Credentials> {
  * @category Internals
  */
 export declare function createCredentials(source: CredentialsInit): Credentials;
+/**
+ * Returns true if the credentials can be used for an operation that requires root privileges.
+ * @internal
+ * @category Internals
+ */
+export declare function credentialsAllowRoot(cred?: Credentials): boolean;

package/dist/internal/credentials.js

@@ -11,3 +11,13 @@ export function createCredentials(source) {
         ...source,
     };
 }
+/**
+ * Returns true if the credentials can be used for an operation that requires root privileges.
+ * @internal
+ * @category Internals
+ */
+export function credentialsAllowRoot(cred) {
+    if (!cred)
+        return false;
+    return !cred.uid || !cred.gid || !cred.euid || !cred.egid || cred.groups.some(gid => !gid);
+}

package/dist/utils.d.ts

@@ -48,8 +48,7 @@ export declare function normalizePath(p: fs.PathLike, noResolve?: boolean): stri
  */
 export declare function normalizeOptions(options: fs.WriteFileOptions | (fs.EncodingOption & {
     flag?: fs.OpenMode;
-}) | undefined, encoding: (BufferEncoding | null) | undefined, flag: string, mode?: number): {
-    encoding?: BufferEncoding | null;
+}) | undefined, encoding: (BufferEncoding | null) | undefined, flag: string, mode?: number): fs.ObjectEncodingOptions & {
     flag: string;
     mode: number;
 };

package/dist/vfs/dir.d.ts

@@ -2,11 +2,12 @@ import type { Dir as _Dir, Dirent as _Dirent } from 'node:fs';
 import type { V_Context } from '../context.js';
 import type { InodeLike } from '../internal/inode.js';
 import type { Callback } from '../utils.js';
-export declare class Dirent implements _Dirent {
+export declare class Dirent<Name extends string | Buffer = string> implements _Dirent<Name> {
     path: string;
     protected stats: InodeLike;
-    get name(): string;
-    constructor(path: string, stats: InodeLike);
+    protected readonly encoding?: (BufferEncoding | "buffer" | null) | undefined;
+    get name(): Name;
+    constructor(path: string, stats: InodeLike, encoding?: (BufferEncoding | "buffer" | null) | undefined);
     get parentPath(): string;
     isFile(): boolean;
     isDirectory(): boolean;

package/dist/vfs/dir.js

@@ -5,11 +5,13 @@ import { readdir } from './promises.js';
 import { readdirSync } from './sync.js';
 export class Dirent {
     get name() {
-        return basename(this.path);
+        const name = Buffer.from(basename(this.path));
+        return (this.encoding == 'buffer' ? name : name.toString(this.encoding));
     }
-    constructor(path, stats) {
+    constructor(path, stats, encoding) {
         this.path = path;
         this.stats = stats;
+        this.encoding = encoding;
     }
     get parentPath() {
         return this.path;

package/dist/vfs/promises.d.ts

@@ -1,3 +1,4 @@
+import type { Abortable } from 'node:events';
 import type * as fs from 'node:fs';
 import type * as promises from 'node:fs/promises';
 import type { Stream } from 'node:stream';
@@ -6,7 +7,7 @@ import type { V_Context } from '../context.js';
 import type { FileSystem, StreamOptions } from '../internal/filesystem.js';
 import type { InodeLike } from '../internal/inode.js';
 import type { Interface as ReadlineInterface } from '../readline.js';
-import type { FileContents, NullEnc, ReaddirOptions, ReaddirOptsI, ReaddirOptsU } from './types.js';
+import type { FileContents, ReaddirOptions } from './types.js';
 import { Buffer } from 'buffer';
 import '../polyfills.js';
 import { Dir, Dirent } from './dir.js';
@@ -114,16 +115,13 @@ export declare class FileHandle implements promises.FileHandle {
     read<T extends NodeJS.ArrayBufferView>(buffer: T, offset?: number, length?: number, position?: number | null): Promise<promises.FileReadResult<T>>;
     read<T extends NodeJS.ArrayBufferView = Buffer>(buffer: T, options?: promises.FileReadOptions<T>): Promise<promises.FileReadResult<T>>;
     read<T extends NodeJS.ArrayBufferView = Buffer>(options?: promises.FileReadOptions<T>): Promise<promises.FileReadResult<T>>;
-    /**
-     * Asynchronously reads the entire contents of a file. The underlying file will _not_ be closed automatically.
-     * The `FileHandle` must have been opened for reading.
-     * @param _options An object that may contain an optional flag.
-     * If a flag is not provided, it defaults to `'r'`.
-     */
-    readFile(_options?: {
-        flag?: fs.OpenMode;
-    }): Promise<Buffer>;
-    readFile(_options: (fs.ObjectEncodingOptions & promises.FlagAndOpenMode) | BufferEncoding): Promise<string>;
+    readFile(options?: ({
+        encoding?: null;
+    } & Abortable) | null): Promise<Buffer>;
+    readFile(options: ({
+        encoding: BufferEncoding;
+    } & Abortable) | BufferEncoding): Promise<string>;
+    readFile(_options?: (fs.ObjectEncodingOptions & Abortable) | BufferEncoding | null): Promise<string | Buffer>;
     /**
      * Read file data using a `ReadableStream`.
      * The handle will not be closed automatically.
@@ -254,15 +252,15 @@ export declare function open(this: V_Context, path: fs.PathLike, flag?: fs.OpenM
  * @option flag Defaults to `'r'`.
  * @returns the file data
  */
-export declare function readFile(this: V_Context, path: fs.PathLike | promises.FileHandle, options?: {
+export declare function readFile(this: V_Context, path: fs.PathLike | promises.FileHandle, options?: ({
     encoding?: null;
     flag?: fs.OpenMode;
-} | null): Promise<Buffer>;
-export declare function readFile(this: V_Context, path: fs.PathLike | promises.FileHandle, options: {
+} & Abortable) | null): Promise<Buffer>;
+export declare function readFile(this: V_Context, path: fs.PathLike | promises.FileHandle, options: ({
     encoding: BufferEncoding;
     flag?: fs.OpenMode;
-} | BufferEncoding): Promise<string>;
-export declare function readFile(this: V_Context, path: fs.PathLike | promises.FileHandle, options?: (fs.ObjectEncodingOptions & {
+} & Abortable) | BufferEncoding): Promise<string>;
+export declare function readFile(this: V_Context, path: fs.PathLike | promises.FileHandle, _options?: (fs.ObjectEncodingOptions & Abortable & {
     flag?: fs.OpenMode;
 }) | BufferEncoding | null): Promise<string | Buffer>;
 /**
@@ -309,19 +307,29 @@ export declare function mkdir(this: V_Context, path: fs.PathLike, options?: fs.M
  * @param path A path to a file. If a URL is provided, it must use the `file:` protocol.
  * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'`.
  */
-export declare function readdir(this: V_Context, path: fs.PathLike, options?: ReaddirOptsI<{
+export declare function readdir(this: V_Context, path: fs.PathLike, options?: (fs.ObjectEncodingOptions & {
     withFileTypes?: false;
-}> | NullEnc): Promise<string[]>;
-export declare function readdir(this: V_Context, path: fs.PathLike, options: fs.BufferEncodingOption & ReaddirOptions & {
+    recursive?: boolean;
+}) | BufferEncoding | null): Promise<string[]>;
+export declare function readdir(this: V_Context, path: fs.PathLike, options: {
+    encoding: 'buffer';
     withFileTypes?: false;
-}): Promise<Buffer[]>;
-export declare function readdir(this: V_Context, path: fs.PathLike, options?: ReaddirOptsI<{
+    recursive?: boolean;
+} | 'buffer'): Promise<Buffer[]>;
+export declare function readdir(this: V_Context, path: fs.PathLike, options?: (fs.ObjectEncodingOptions & {
     withFileTypes?: false;
-}> | NullEnc): Promise<string[] | Buffer[]>;
-export declare function readdir(this: V_Context, path: fs.PathLike, options: ReaddirOptsI<{
+    recursive?: boolean;
+}) | BufferEncoding | null): Promise<string[] | Buffer[]>;
+export declare function readdir(this: V_Context, path: fs.PathLike, options: fs.ObjectEncodingOptions & {
+    withFileTypes: true;
+    recursive?: boolean;
+}): Promise<Dirent[]>;
+export declare function readdir(this: V_Context, path: fs.PathLike, options: {
+    encoding: 'buffer';
     withFileTypes: true;
-}>): Promise<Dirent[]>;
-export declare function readdir(this: V_Context, path: fs.PathLike, options?: ReaddirOptsU<fs.BufferEncodingOption> | NullEnc): Promise<string[] | Dirent[] | Buffer[]>;
+    recursive?: boolean;
+}): Promise<Dirent<Buffer>[]>;
+export declare function readdir(this: V_Context, path: fs.PathLike, options?: ReaddirOptions): Promise<string[] | Dirent<any>[] | Buffer[]>;
 export declare function link(this: V_Context, path: fs.PathLike, dest: fs.PathLike): Promise<void>;
 /**
  * `symlink`.

package/dist/vfs/promises.js

@@ -737,7 +737,7 @@ export async function mkdir(path, options) {
 }
 mkdir;
 export async function readdir(path, options) {
-    options = typeof options === 'object' ? options : { encoding: options };
+    const opt = typeof options === 'object' && options != null ? options : { encoding: options, withFileTypes: false, recursive: false };
     path = await realpath.call(this, path);
     const { fs, path: resolved } = resolveMount(path, this);
     const $ex = { syscall: 'readdir', path };
@@ -752,7 +752,7 @@ export async function readdir(path, options) {
     const values = [];
     const addEntry = async (entry) => {
         let entryStats;
-        if ((options === null || options === void 0 ? void 0 : options.recursive) || (options === null || options === void 0 ? void 0 : options.withFileTypes)) {
+        if (opt.recursive || opt.withFileTypes) {
             entryStats = await fs.stat(join(resolved, entry)).catch((e) => {
                 if (e.code == 'ENOENT')
                     return;
@@ -761,18 +761,18 @@ export async function readdir(path, options) {
             if (!entryStats)
                 return;
         }
-        if (options === null || options === void 0 ? void 0 : options.withFileTypes) {
-            values.push(new Dirent(entry, entryStats));
+        if (opt.withFileTypes) {
+            values.push(new Dirent(entry, entryStats, opt.encoding));
         }
-        else if ((options === null || options === void 0 ? void 0 : options.encoding) == 'buffer') {
+        else if (opt.encoding == 'buffer') {
             values.push(Buffer.from(entry));
         }
         else {
             values.push(entry);
         }
-        if (!(options === null || options === void 0 ? void 0 : options.recursive) || !isDirectory(entryStats))
+        if (!opt.recursive || !isDirectory(entryStats))
             return;
-        for (const subEntry of await readdir.call(this, join(path, entry), options)) {
+        for (const subEntry of await readdir.call(this, join(path, entry), opt)) {
             if (subEntry instanceof Dirent) {
                 subEntry.path = join(entry, subEntry.path);
                 values.push(subEntry);
@@ -1102,7 +1102,7 @@ export async function rm(path, options) {
     switch (stats.mode & constants.S_IFMT) {
         case constants.S_IFDIR:
             if (options === null || options === void 0 ? void 0 : options.recursive) {
-                for (const entry of (await readdir.call(this, path))) {
+                for (const entry of await readdir.call(this, path)) {
                     await rm.call(this, join(path, entry), options);
                 }
             }

package/dist/vfs/shared.js

@@ -6,6 +6,7 @@ import { defaultContext } from '../internal/contexts.js';
 import { join, resolve } from '../path.js';
 import { normalizePath } from '../utils.js';
 import { size_max } from './constants.js';
+import { credentialsAllowRoot } from '../internal/credentials.js';
 /**
  * The map of mount points
  * @category Backends and Configuration
@@ -59,7 +60,7 @@ export function resolveMount(path, ctx) {
             continue;
         path = path.slice(mountPoint.length > 1 ? mountPoint.length : 0); // Resolve the path relative to the mount point
         if (path === '')
-            path = root;
+            path = '/';
         const case_fold = fs.attributes.get('case_fold');
         if (case_fold === 'lower')
             path = path.toLowerCase();
@@ -90,13 +91,13 @@ export function _statfs(fs, bigint) {
  * @category Backends and Configuration
  */
 export function chroot(path) {
-    var _a, _b, _c, _d, _e, _f, _g;
+    var _a, _b, _c;
     const $ = this !== null && this !== void 0 ? this : defaultContext;
-    if (((_a = $.credentials) === null || _a === void 0 ? void 0 : _a.uid) !== 0 && ((_b = $.credentials) === null || _b === void 0 ? void 0 : _b.gid) !== 0 && ((_c = $.credentials) === null || _c === void 0 ? void 0 : _c.euid) !== 0 && ((_d = $.credentials) === null || _d === void 0 ? void 0 : _d.egid) !== 0)
+    if (!credentialsAllowRoot($.credentials))
         throw withErrno('EPERM', 'Can not chroot() as non-root user');
-    (_e = $.root) !== null && _e !== void 0 ? _e : ($.root = '/');
+    (_a = $.root) !== null && _a !== void 0 ? _a : ($.root = '/');
     const newRoot = join($.root, path);
-    for (const handle of (_g = (_f = $.descriptors) === null || _f === void 0 ? void 0 : _f.values()) !== null && _g !== void 0 ? _g : []) {
+    for (const handle of (_c = (_b = $.descriptors) === null || _b === void 0 ? void 0 : _b.values()) !== null && _c !== void 0 ? _c : []) {
         if (!handle.path.startsWith($.root))
             throw UV('EBUSY', 'chroot', handle.path);
         handle.path = handle.path.slice($.root.length);

package/dist/vfs/sync.d.ts

@@ -1,6 +1,6 @@
 import type * as fs from 'node:fs';
 import type { V_Context } from '../context.js';
-import type { FileContents, NullEnc, ReaddirOptions, ReaddirOptsI, ReaddirOptsU } from './types.js';
+import type { FileContents, ReaddirOptions } from './types.js';
 import { Buffer } from 'buffer';
 import { Dir, Dirent } from './dir.js';
 import { BigIntStats, Stats } from './stats.js';
@@ -47,7 +47,7 @@ export declare function lopenSync(this: V_Context, path: fs.PathLike, flag: stri
  */
 export declare function readFileSync(this: V_Context, path: fs.PathOrFileDescriptor, options?: {
     flag?: string;
-} | null): Buffer;
+} | null): NonSharedBuffer;
 export declare function readFileSync(this: V_Context, path: fs.PathOrFileDescriptor, options?: (fs.EncodingOption & {
     flag?: string;
 }) | BufferEncoding | null): string;
@@ -112,19 +112,30 @@ export declare function mkdirSync(this: V_Context, path: fs.PathLike, options?:
     recursive?: false;
 }) | null): void;
 export declare function mkdirSync(this: V_Context, path: fs.PathLike, options?: fs.Mode | fs.MakeDirectoryOptions | null): string | undefined;
-export declare function readdirSync(this: V_Context, path: fs.PathLike, options?: ReaddirOptsI<{
+export declare function readdirSync(this: V_Context, path: fs.PathLike, options?: {
+    encoding: BufferEncoding | null;
     withFileTypes?: false;
-}> | NullEnc): string[];
-export declare function readdirSync(this: V_Context, path: fs.PathLike, options: fs.BufferEncodingOption & ReaddirOptions & {
+    recursive?: boolean;
+} | BufferEncoding | null): string[];
+export declare function readdirSync(this: V_Context, path: fs.PathLike, options: {
+    encoding: 'buffer';
     withFileTypes?: false;
-}): Buffer[];
-export declare function readdirSync(this: V_Context, path: fs.PathLike, options?: ReaddirOptsI<{
+    recursive?: boolean;
+} | 'buffer'): Buffer[];
+export declare function readdirSync(this: V_Context, path: fs.PathLike, options?: (fs.ObjectEncodingOptions & {
     withFileTypes?: false;
-}> | NullEnc): string[] | Buffer[];
-export declare function readdirSync(this: V_Context, path: fs.PathLike, options: ReaddirOptsI<{
+    recursive?: boolean;
+}) | BufferEncoding | null): string[] | Buffer[];
+export declare function readdirSync(this: V_Context, path: fs.PathLike, options: fs.ObjectEncodingOptions & {
     withFileTypes: true;
-}>): Dirent[];
-export declare function readdirSync(this: V_Context, path: fs.PathLike, options?: ReaddirOptsU<fs.BufferEncodingOption> | NullEnc): string[] | Dirent[] | Buffer[];
+    recursive?: boolean;
+}): Dirent[];
+export declare function readdirSync(this: V_Context, path: fs.PathLike, options: {
+    encoding: 'buffer';
+    withFileTypes: true;
+    recursive?: boolean;
+}): Dirent<Buffer>[];
+export declare function readdirSync(this: V_Context, path: fs.PathLike, options?: ReaddirOptions): string[] | Dirent<any>[] | Buffer[];
 export declare function linkSync(this: V_Context, targetPath: fs.PathLike, linkPath: fs.PathLike): void;
 /**
  * Synchronous `symlink`.

package/dist/vfs/sync.js

@@ -496,7 +496,7 @@ export function readdirSync(path, options) {
             continue;
         }
         if (options === null || options === void 0 ? void 0 : options.withFileTypes) {
-            values.push(new Dirent(entry, entryStat));
+            values.push(new Dirent(entry, entryStat, options.encoding));
         }
         else if ((options === null || options === void 0 ? void 0 : options.encoding) == 'buffer') {
             values.push(Buffer.from(entry));

package/dist/vfs/types.d.ts

@@ -15,15 +15,10 @@ export interface OpenOptions {
      */
     allowDirectory?: boolean;
 }
-export interface ReaddirOptions {
+export type ReaddirOptions = {
     withFileTypes?: boolean;
     recursive?: boolean;
-}
+    encoding?: BufferEncoding | 'buffer' | null;
+} | BufferEncoding | 'buffer' | null;
 /** Helper union @hidden */
 export type GlobOptionsU = fs.GlobOptionsWithFileTypes | fs.GlobOptionsWithoutFileTypes | fs.GlobOptions;
-/** Helper with union @hidden */
-export type ReaddirOptsU<T> = (ReaddirOptions & (fs.ObjectEncodingOptions | T)) | NullEnc;
-/** Helper with intersection @hidden */
-export type ReaddirOptsI<T> = ReaddirOptions & fs.ObjectEncodingOptions & T;
-/** @hidden */
-export type NullEnc = BufferEncoding | null;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@zenfs/core",
-	"version": "2.2.2",
+	"version": "2.2.3",
 	"description": "A filesystem, anywhere",
 	"funding": {
 		"type": "individual",
@@ -71,7 +71,7 @@
 		"buffer": "^6.0.3",
 		"eventemitter3": "^5.0.1",
 		"kerium": "^1.3.4",
-		"memium": "^0.2.0",
+		"memium": "^0.2.1",
 		"readable-stream": "^4.5.2",
 		"utilium": "^2.3.3"
 	},

package/tests/common/context.test.ts

@@ -3,6 +3,7 @@ import { suite, test } from 'node:test';
 import { canary } from 'utilium';
 import { bindContext } from '../../dist/context.js';
 import * as fs from '../../dist/vfs/index.js';
+import { configure, InMemory } from '../../dist/index.js';
 
 fs.mkdirSync('/ctx');
 const { fs: ctx } = bindContext({ root: '/ctx' });
@@ -58,4 +59,17 @@ suite('Context', () => {
 		await watcher.return!();
 		await promise;
 	});
+
+	test('Path resolution of / with context root and mount point being the same', async () => {
+		// @zenfs/core#226
+		await configure({
+			mounts: { '/bananas': InMemory },
+		});
+
+		const bananas = bindContext({ root: '/bananas' });
+
+		fs.writeFileSync('/bananas/yellow', 'true');
+
+		assert.deepEqual(bananas.fs.readdirSync('/'), ['yellow']);
+	});
 });