@zenfs/core 1.9.3 → 1.9.5

package/dist/backends/fetch.d.ts

@@ -73,5 +73,8 @@ declare const _Fetch: {
 type _Fetch = typeof _Fetch;
 export interface Fetch extends _Fetch {
 }
+/**
+ * @category Backends and Configuration
+ */
 export declare const Fetch: Fetch;
 export {};

package/dist/backends/fetch.js

@@ -123,4 +123,7 @@ const _Fetch = {
         return fs;
     },
 };
+/**
+ * @category Backends and Configuration
+ */
 export const Fetch = _Fetch;

package/dist/backends/memory.d.ts

@@ -10,7 +10,6 @@ export declare class InMemoryStore extends Map<number, Uint8Array> implements Sy
     readonly name = "tmpfs";
     constructor(label?: string | undefined);
     sync(): Promise<void>;
-    clearSync(): void;
     transaction(): SyncMapTransaction;
 }
 declare const _InMemory: {
@@ -31,6 +30,7 @@ export interface InMemory extends _InMemory {
 /**
  * A simple in-memory file system backed by an InMemoryStore.
  * Files are not persisted across page loads.
+ * @category Backends and Configuration
  */
 export declare const InMemory: InMemory;
 export {};

package/dist/backends/memory.js

@@ -12,9 +12,6 @@ export class InMemoryStore extends Map {
         this.name = 'tmpfs';
     }
     async sync() { }
-    clearSync() {
-        this.clear();
-    }
     transaction() {
         return new SyncMapTransaction(this);
     }
@@ -33,5 +30,6 @@ const _InMemory = {
 /**
  * A simple in-memory file system backed by an InMemoryStore.
  * Files are not persisted across page loads.
+ * @category Backends and Configuration
  */
 export const InMemory = _InMemory;

package/dist/backends/overlay.d.ts

@@ -117,6 +117,7 @@ export interface Overlay extends _Overlay {
 /**
  * Overlay makes a read-only filesystem writable by storing writes on a second, writable file system.
  * Deletes are persisted via metadata stored on the writable file system.
+ * @category Backends and Configuration
  * @internal
  */
 export declare const Overlay: Overlay;

package/dist/backends/overlay.js

@@ -550,6 +550,7 @@ const _Overlay = {
 /**
  * Overlay makes a read-only filesystem writable by storing writes on a second, writable file system.
  * Deletes are persisted via metadata stored on the writable file system.
+ * @category Backends and Configuration
  * @internal
  */
 export const Overlay = _Overlay;

package/dist/backends/port/fs.d.ts

@@ -2,12 +2,12 @@ import type { ExtractProperties } from 'utilium';
 import type { Inode, InodeLike } from '../..//internal/inode.js';
 import type { MountConfiguration } from '../../config.js';
 import type { File } from '../../internal/file.js';
-import type { CreationOptions, FileSystemMetadata } from '../../internal/filesystem.js';
+import type { CreationOptions, UsageInfo } from '../../internal/filesystem.js';
 import type { Backend, FilesystemOf } from '../backend.js';
 import { FileSystem } from '../../internal/filesystem.js';
 import { Stats } from '../../stats.js';
 import * as RPC from './rpc.js';
-type FSMethods = ExtractProperties<FileSystem, (...args: any[]) => Promise<any> | FileSystemMetadata>;
+type FSMethods = ExtractProperties<FileSystem, (...args: any[]) => Promise<any> | UsageInfo>;
 type FSMethod = keyof FSMethods;
 export type FSRequest<TMethod extends FSMethod = FSMethod> = RPC.Message & {
     [M in TMethod]: {
@@ -73,6 +73,12 @@ declare const _Port: {
 type _Port = typeof _Port;
 export interface Port extends _Port {
 }
+/**
+ * @category Backends and Configuration
+ */
 export declare const Port: Port;
+/**
+ * @category Backends and Configuration
+ */
 export declare function resolveRemoteMount<T extends Backend>(port: RPC.Port, config: MountConfiguration<T>, _depth?: number): Promise<FilesystemOf<T>>;
 export {};

package/dist/backends/port/fs.js

@@ -134,12 +134,18 @@ const _Port = {
         return new PortFS(options);
     },
 };
+/**
+ * @category Backends and Configuration
+ */
 export const Port = _Port;
+/**
+ * @category Backends and Configuration
+ */
 export async function resolveRemoteMount(port, config, _depth = 0) {
     const stopAndReplay = RPC.catchMessages(port);
     const fs = await resolveMountConfig(config, _depth);
     attachFS(port, fs);
-    stopAndReplay(fs);
+    await stopAndReplay(fs);
     info('Resolved remote mount: ' + fs.toString());
     return fs;
 }

package/dist/backends/port/rpc.d.ts

@@ -10,7 +10,7 @@ type _MessageEvent<T = any> = T | {
 /** @internal */
 export interface Port {
     postMessage(value: unknown, transfer?: TransferListItem[]): void;
-    on?(event: 'message', listener: (value: unknown) => void): this;
+    on?(event: 'message' | 'online', listener: (value: unknown) => void): this;
     off?(event: 'message', listener: (value: unknown) => void): this;
     addEventListener?(type: 'message', listener: (ev: _MessageEvent) => void): void;
     removeEventListener?(type: 'message', listener: (ev: _MessageEvent) => void): void;
@@ -70,4 +70,8 @@ export declare function request<const TRequest extends Request, TValue>(request:
 export declare function handleResponse<const TResponse extends Response>(response: TResponse): void;
 export declare function attach<T extends Message>(port: Port, handler: (message: T) => unknown): void;
 export declare function detach<T extends Message>(port: Port, handler: (message: T) => unknown): void;
-export declare function catchMessages<T extends Backend>(port: Port): (fs: FilesystemOf<T>) => void;
+export declare function catchMessages<T extends Backend>(port: Port): (fs: FilesystemOf<T>) => Promise<void>;
+/**
+ * @internal
+ */
+export declare function waitOnline(port: Port): Promise<void>;

package/dist/backends/port/rpc.js

@@ -64,7 +64,7 @@ export function attach(port, handler) {
         throw err(new ErrnoError(Errno.EINVAL, 'Cannot attach to non-existent port'));
     info('Attached handler to port: ' + handler.name);
     port['on' in port ? 'on' : 'addEventListener']('message', (message) => {
-        handler('data' in message ? message.data : message);
+        handler(typeof message == 'object' && message !== null && 'data' in message ? message.data : message);
     });
 }
 export function detach(port, handler) {
@@ -72,18 +72,29 @@ export function detach(port, handler) {
         throw err(new ErrnoError(Errno.EINVAL, 'Cannot detach from non-existent port'));
     info('Detached handler from port: ' + handler.name);
     port['off' in port ? 'off' : 'removeEventListener']('message', (message) => {
-        handler('data' in message ? message.data : message);
+        handler(typeof message == 'object' && message !== null && 'data' in message ? message.data : message);
     });
 }
 export function catchMessages(port) {
     const events = [];
     const handler = events.push.bind(events);
     attach(port, handler);
-    return function (fs) {
+    return async function (fs) {
         detach(port, handler);
         for (const event of events) {
             const request = 'data' in event ? event.data : event;
-            void handleRequest(port, fs, request);
+            await handleRequest(port, fs, request);
         }
     };
 }
+/**
+ * @internal
+ */
+export async function waitOnline(port) {
+    if (!('on' in port))
+        return; // Only need to wait in Node.js
+    const online = Promise.withResolvers();
+    setTimeout(online.reject, 500);
+    port.on('online', online.resolve);
+    await online.promise;
+}

package/dist/backends/store/fs.d.ts

@@ -6,11 +6,8 @@ import { Inode, type InodeLike } from '../../internal/inode.js';
 import type { Stats } from '../../stats.js';
 import { WrappedTransaction, type Store } from './store.js';
 /**
- * A file system which uses a key-value store.
+ * A file system which uses a `Store`
  *
- * We use a unique ID for each node in the file system. The root node has a fixed ID.
- *
- * @todo Introduce Node ID caching?
  * @todo Check modes?
  * @category Stores and Transactions
  * @internal

package/dist/backends/store/fs.js

@@ -63,11 +63,8 @@ import { S_IFDIR, S_IFREG, S_ISGID, S_ISUID, size_max } from '../../vfs/constant
 import { basename, dirname, join, parse, relative } from '../../vfs/path.js';
 import { WrappedTransaction } from './store.js';
 /**
- * A file system which uses a key-value store.
+ * A file system which uses a `Store`
  *
- * We use a unique ID for each node in the file system. The root node has a fixed ID.
- *
- * @todo Introduce Node ID caching?
  * @todo Check modes?
  * @category Stores and Transactions
  * @internal

package/dist/config.d.ts

@@ -45,21 +45,6 @@ export interface Configuration<T extends ConfigMounts> extends SharedConfig {
      * @default false
      */
     addDevices: boolean;
-    /**
-     * If true, enables caching stats for certain operations.
-     * This should reduce the number of stat calls performed.
-     * @experimental
-     * @default false
-     */
-    cacheStats: boolean;
-    /**
-     * If true, enables caching realpath output
-     *
-     * This can increase performance.
-     * @experimental
-     * @default false
-     */
-    cachePaths: boolean;
     /**
      * If true, disables *all* permissions checking.
      *

package/dist/config.js

@@ -4,7 +4,6 @@ import { DeviceFS } from './internal/devices.js';
 import { Errno, ErrnoError } from './internal/error.js';
 import { FileSystem } from './internal/filesystem.js';
 import { configure as configureLog, crit, err, info } from './internal/log.js';
-import * as cache from './vfs/cache.js';
 import { config } from './vfs/config.js';
 import * as fs from './vfs/index.js';
 import { mounts } from './vfs/shared.js';
@@ -99,12 +98,10 @@ export function addDevice(driver, options) {
  * @see Configuration
  */
 export async function configure(configuration) {
-    var _a, _b, _c;
+    var _a;
     const uid = 'uid' in configuration ? configuration.uid || 0 : 0;
     const gid = 'gid' in configuration ? configuration.gid || 0 : 0;
     useCredentials({ uid, gid });
-    cache.stats.isEnabled = (_a = configuration.cacheStats) !== null && _a !== void 0 ? _a : false;
-    cache.paths.isEnabled = (_b = configuration.cachePaths) !== null && _b !== void 0 ? _b : false;
     config.checkAccess = !configuration.disableAccessChecks;
     config.updateOnRead = !configuration.disableUpdateOnRead;
     config.syncImmediately = !configuration.onlySyncOnClose;
@@ -115,7 +112,7 @@ export async function configure(configuration) {
         for (const [_point, mountConfig] of Object.entries(configuration.mounts).sort(([a], [b]) => (a.length > b.length ? 1 : -1))) {
             const point = _point.startsWith('/') ? _point : '/' + _point;
             if (isBackendConfig(mountConfig)) {
-                (_c = mountConfig.disableAsyncCache) !== null && _c !== void 0 ? _c : (mountConfig.disableAsyncCache = configuration.disableAsyncCache || false);
+                (_a = mountConfig.disableAsyncCache) !== null && _a !== void 0 ? _a : (mountConfig.disableAsyncCache = configuration.disableAsyncCache || false);
             }
             if (point == '/')
                 fs.umount('/');

package/dist/internal/file_index.d.ts

@@ -10,7 +10,7 @@ export interface IndexData {
 }
 export declare const version = 1;
 /**
- * An index of files
+ * An index of file metadata
  * @category Internals
  * @internal
  */

package/dist/internal/file_index.js

@@ -6,7 +6,7 @@ import { Errno, ErrnoError } from './error.js';
 import { Inode } from './inode.js';
 export const version = 1;
 /**
- * An index of files
+ * An index of file metadata
  * @category Internals
  * @internal
  */

package/dist/internal/index_fs.d.ts

@@ -4,7 +4,7 @@ import { Index } from './file_index.js';
 import { FileSystem, type CreationOptions, type PureCreationOptions } from './filesystem.js';
 import { Inode, type InodeLike } from './inode.js';
 /**
- * Uses an `Index` for metadata.
+ * A file system that uses an `Index` for metadata.
  * @category Internals
  * @internal
  */

package/dist/internal/index_fs.js

@@ -9,7 +9,7 @@ import { Index } from './file_index.js';
 import { FileSystem } from './filesystem.js';
 import { Inode } from './inode.js';
 /**
- * Uses an `Index` for metadata.
+ * A file system that uses an `Index` for metadata.
  * @category Internals
  * @internal
  */

package/dist/utils.d.ts

@@ -1,7 +1,6 @@
 import type * as fs from 'node:fs';
 import type { ClassLike, OptionalTuple } from 'utilium';
 import { ErrnoError } from './internal/error.js';
-import type { AbsolutePath } from './vfs/path.js';
 declare global {
     function atob(data: string): string;
     function btoa(data: string): string;
@@ -54,7 +53,7 @@ export declare function normalizeTime(time: string | number | Date): number;
  * Normalizes a path
  * @internal
  */
-export declare function normalizePath(p: fs.PathLike): AbsolutePath;
+export declare function normalizePath(p: fs.PathLike, noResolve?: boolean): string;
 /**
  * Normalizes options
  * @param options options to normalize

package/dist/utils.js

@@ -101,15 +101,23 @@ export function normalizeTime(time) {
  * Normalizes a path
  * @internal
  */
-export function normalizePath(p) {
+export function normalizePath(p, noResolve = false) {
+    if (p instanceof URL) {
+        if (p.protocol != 'file:')
+            throw new ErrnoError(Errno.EINVAL, 'URLs must use the file: protocol');
+        p = p.pathname;
+    }
     p = p.toString();
+    if (p.startsWith('file://'))
+        p = p.slice('file://'.length);
     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, '/'));
+    p = p.replaceAll(/[/\\]+/g, '/');
+    return noResolve ? p : resolve(p);
 }
 /**
  * Normalizes options

package/dist/vfs/promises.d.ts

@@ -6,7 +6,7 @@ import type { Interface as ReadlineInterface } from 'readline';
 import type { V_Context } from '../context.js';
 import type { File } from '../internal/file.js';
 import type { Stats } from '../stats.js';
-import type { FileContents, InternalOptions, NullEnc, ReaddirOptions, ReaddirOptsI, ReaddirOptsU } from './types.js';
+import type { FileContents, NullEnc, ReaddirOptions, ReaddirOptsI, ReaddirOptsU } from './types.js';
 import { Buffer } from 'buffer';
 import '../polyfills.js';
 import { BigIntStats } from '../stats.js';
@@ -304,7 +304,7 @@ export declare function access(this: V_Context, path: fs.PathLike, mode?: number
  * Asynchronous `rm`. Removes files or directories (recursively).
  * @param path The path to the file or directory to remove.
  */
-export declare function rm(this: V_Context, path: fs.PathLike, options?: fs.RmOptions & InternalOptions): Promise<void>;
+export declare function rm(this: V_Context, path: fs.PathLike, options?: fs.RmOptions): Promise<void>;
 /**
  * Asynchronous `mkdtemp`. Creates a unique temporary directory.
  * @param prefix The directory prefix.