@zenfs/core 0.14.1 → 0.15.1

package/dist/config.d.ts

@@ -34,7 +34,7 @@ export interface Configuration<T extends ConfigMounts> extends SharedConfig {
 /**
  * Configures ZenFS with single mount point /
  */
-export declare function configure<T extends Backend>(config: MountConfiguration<T>): Promise<void>;
+export declare function configureSingle<T extends Backend>(config: MountConfiguration<T>): Promise<void>;
 /**
  * Configures ZenFS with the given configuration
  * @see Configuration

package/dist/config.js

@@ -47,6 +47,17 @@ export async function resolveMountConfig(config, _depth = 0) {
     await mount.ready();
     return mount;
 }
+/**
+ * Configures ZenFS with single mount point /
+ */
+export async function configureSingle(config) {
+    if (!isBackendConfig(config)) {
+        throw new TypeError('Invalid single mount point configuration');
+    }
+    const resolved = await resolveMountConfig(config);
+    fs.umount('/');
+    fs.mount('/', resolved);
+}
 /**
  * Configures ZenFS with the given configuration
  * @see Configuration
@@ -54,10 +65,6 @@ export async function resolveMountConfig(config, _depth = 0) {
 export async function configure(config) {
     const uid = 'uid' in config ? config.uid || 0 : 0;
     const gid = 'gid' in config ? config.gid || 0 : 0;
-    if (isMountConfig(config)) {
-        // single FS
-        config = { mounts: { '/': config } };
-    }
     setCred({ uid, gid, suid: uid, sgid: gid, euid: uid, egid: gid });
     if (!config.mounts) {
         return;

package/dist/emulation/promises.d.ts

@@ -18,7 +18,7 @@ import { BigIntStats, type Stats } from '../stats.js';
 import { Dir, Dirent } from './dir.js';
 import { ReadStream, WriteStream } from './streams.js';
 export * as constants from './constants.js';
-import '../symbol-dispose.js';
+import '../polyfills.js';
 export declare class FileHandle implements promises.FileHandle {
     /**
      * The file descriptor for this file handle.

package/dist/emulation/promises.js

@@ -54,7 +54,7 @@ import { dirname, join, parse } from './path.js';
 import { _statfs, cred, fd2file, fdMap, file2fd, fixError, mounts, resolveMount } from './shared.js';
 import { ReadStream, WriteStream } from './streams.js';
 export * as constants from './constants.js';
-import '../symbol-dispose.js';
+import '../polyfills.js';
 export class FileHandle {
     constructor(fdOrFile) {
         const isFile = typeof fdOrFile != 'number';

package/dist/file.d.ts

@@ -3,7 +3,7 @@
 import type { FileReadResult } from 'node:fs/promises';
 import type { FileSystem } from './filesystem.js';
 import { Stats, type FileType } from './stats.js';
-import './symbol-dispose.js';
+import './polyfills.js';
 declare global {
     interface ArrayBuffer {
         readonly resizable: boolean;

package/dist/file.js

@@ -2,7 +2,7 @@ import { O_APPEND, O_CREAT, O_EXCL, O_RDONLY, O_RDWR, O_SYNC, O_TRUNC, O_WRONLY,
 import { Errno, ErrnoError } from './error.js';
 import { size_max } from './inode.js';
 import { Stats } from './stats.js';
-import './symbol-dispose.js';
+import './polyfills.js';
 const validFlags = ['r', 'r+', 'rs', 'rs+', 'w', 'wx', 'w+', 'wx+', 'a', 'ax', 'a+', 'ax+'];
 export function parseFlag(flag) {
     if (typeof flag === 'number') {

package/dist/polyfills.js

@@ -0,0 +1,20 @@
+Promise.withResolvers ?? (Promise.withResolvers = function () {
+    let _resolve, 
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    _reject;
+    const promise = new Promise((resolve, reject) => {
+        _resolve = resolve;
+        _reject = reject;
+    });
+    return { promise, resolve: _resolve, reject: _reject };
+});
+/*
+    A polyfill for when these symbols are undefined.
+    For some reason, NodeJS does not polyfill them in a VM context.
+    Since jest uses a VM context for ESM, these need to be here.
+*/
+// @ts-expect-error 2540
+Symbol['dispose'] ?? (Symbol['dispose'] = Symbol('Symbol.dispose'));
+// @ts-expect-error 2540
+Symbol['asyncDispose'] ?? (Symbol['asyncDispose'] = Symbol('Symbol.asyncDispose'));
+export {};

package/license.md

@@ -1,4 +1,4 @@
-Copyright (c) James P. and other ZenFS contributors.
+Copyright (c) James Prevett and other ZenFS contributors.
 Copyright (c) 2013-2023 John Vilk and other BrowserFS contributors.
 Copyright (c) Joyent, Inc. and other Node contributors for `test/fixtures/node`.
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@zenfs/core",
-	"version": "0.14.1",
+	"version": "0.15.1",
 	"description": "A filesystem, anywhere",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
@@ -34,7 +34,7 @@
 		"url": "https://github.com/zen-fs/core/issues"
 	},
 	"engines": {
-		"node": ">= 22"
+		"node": ">= 16"
 	},
 	"exports": {
 		".": "./dist/index.js",

package/readme.md

@@ -58,11 +58,11 @@ import { configure, InMemory } from '@zenfs/core';
 import { IndexedDB } from '@zenfs/dom';
 import { Zip } from '@zenfs/zip';
 
-const zipData = await (await fetch('mydata.zip')).arrayBuffer();
+const res = await fetch('mydata.zip');
 
 await configure({
 	mounts: {
-		'/mnt/zip': { backend: Zip, zipData },
+		'/mnt/zip': { backend: Zip, data: await res.arrayBuffer() },
 		'/tmp': InMemory,
 		'/home': IndexedDB,
 	}
@@ -79,10 +79,10 @@ await configure({
 Here is an example that mounts the `WebStorage` backend from `@zenfs/dom` on `/`:
 
 ```js
-import { configure, fs } from '@zenfs/core';
+import { configureSingle, fs } from '@zenfs/core';
 import { WebStorage } from '@zenfs/dom';
 
-await configure({ backend: WebStorage });
+await configureSingle({ backend: WebStorage });
 
 if (!fs.existsSync('/test.txt')) {
 	fs.writeFileSync('/test.txt', 'This will persist across reloads!');
@@ -97,11 +97,11 @@ console.log(contents);
 The FS promises API is exposed as `promises`.
 
 ```js
-import { configure } from '@zenfs/core';
+import { configureSingle } from '@zenfs/core';
 import { exists, writeFile } from '@zenfs/core/promises';
 import { IndexedDB } from '@zenfs/dom';
 
-await configure({ '/': IndexedDB });
+await configureSingle({ backend: IndexedDB });
 
 const exists = await exists('/myfile.txt');
 if (!exists) {
@@ -137,7 +137,7 @@ await configure({
 fs.mkdirSync('/mnt');
 
 const res = await fetch('mydata.zip');
-const zipfs = await resolveMountConfig({ backend: Zip, zipData: await res.arrayBuffer() });
+const zipfs = await resolveMountConfig({ backend: Zip, data: await res.arrayBuffer() });
 fs.mount('/mnt/zip', zipfs);
 
 // do stuff with the mounted zip

package/src/backends/locked.ts

@@ -5,6 +5,7 @@ import type { FileSystemMetadata } from '../filesystem.js';
 import { FileSystem } from '../filesystem.js';
 import type { Stats } from '../stats.js';
 import type { Backend } from './backend.js';
+import '../polyfills.js';
 
 export interface MutexLock extends PromiseWithResolvers<void> {
 	[Symbol.dispose](): void;

package/src/backends/store/store.ts

@@ -1,6 +1,6 @@
 import { ErrnoError } from '../../error.js';
 import type { Ino } from '../../inode.js';
-import '../../symbol-dispose.js';
+import '../../polyfills.js';
 
 /**
  * Represents a key-value store.

package/src/config.ts

@@ -1,4 +1,3 @@
-import { type Entries } from 'utilium';
 import type { Backend, BackendConfiguration, FilesystemOf, SharedConfig } from './backends/backend.js';
 import { checkOptions, isBackend, isBackendConfig } from './backends/backend.js';
 import * as fs from './emulation/index.js';
@@ -91,34 +90,31 @@ export interface Configuration<T extends ConfigMounts> extends SharedConfig {
 /**
  * Configures ZenFS with single mount point /
  */
-export async function configure<T extends Backend>(config: MountConfiguration<T>): Promise<void>;
+export async function configureSingle<T extends Backend>(config: MountConfiguration<T>): Promise<void> {
+	if (!isBackendConfig(config)) {
+		throw new TypeError('Invalid single mount point configuration');
+	}
 
-/**
- * Configures ZenFS with the given configuration
- * @see Configuration
- */
-export async function configure<T extends ConfigMounts>(config: Partial<Configuration<T>>): Promise<void>;
+	const resolved = await resolveMountConfig(config);
+	fs.umount('/');
+	fs.mount('/', resolved);
+}
 
 /**
  * Configures ZenFS with the given configuration
  * @see Configuration
  */
-export async function configure(config: MountConfiguration<Backend> | Partial<Configuration<ConfigMounts>>): Promise<void> {
+export async function configure<T extends ConfigMounts>(config: Partial<Configuration<T>>): Promise<void> {
 	const uid = 'uid' in config ? config.uid || 0 : 0;
 	const gid = 'gid' in config ? config.gid || 0 : 0;
 
-	if (isMountConfig(config)) {
-		// single FS
-		config = { mounts: { '/': config } } as Partial<Configuration<ConfigMounts>>;
-	}
-
 	setCred({ uid, gid, suid: uid, sgid: gid, euid: uid, egid: gid });
 
 	if (!config.mounts) {
 		return;
 	}
 
-	for (const [point, mountConfig] of Object.entries(config.mounts) as Entries<typeof config.mounts>) {
+	for (const [point, mountConfig] of Object.entries(config.mounts)) {
 		if (!point.startsWith('/')) {
 			throw new ErrnoError(Errno.EINVAL, 'Mount points must have absolute paths');
 		}
@@ -127,7 +123,7 @@ export async function configure(config: MountConfiguration<Backend> | Partial<Co
 			mountConfig.disableAsyncCache ??= config.disableAsyncCache || false;
 		}
 
-		config.mounts[point] = await resolveMountConfig(mountConfig);
+		config.mounts[point as keyof T & `/${string}`] = await resolveMountConfig(mountConfig);
 	}
 
 	fs.mountObject(config.mounts as MountObject);

package/src/emulation/promises.ts

@@ -18,7 +18,7 @@ import { dirname, join, parse } from './path.js';
 import { _statfs, cred, fd2file, fdMap, file2fd, fixError, mounts, resolveMount } from './shared.js';
 import { ReadStream, WriteStream } from './streams.js';
 export * as constants from './constants.js';
-import '../symbol-dispose.js';
+import '../polyfills.js';
 
 export class FileHandle implements promises.FileHandle {
 	/**

package/src/file.ts

@@ -4,7 +4,7 @@ import { Errno, ErrnoError } from './error.js';
 import type { FileSystem } from './filesystem.js';
 import { size_max } from './inode.js';
 import { Stats, type FileType } from './stats.js';
-import './symbol-dispose.js';
+import './polyfills.js';
 
 /*
 	Typescript does not include a type declaration for resizable array buffers. 

package/src/polyfills.ts

@@ -0,0 +1,20 @@
+Promise.withResolvers ??= function <T>(): PromiseWithResolvers<T> {
+	let _resolve: ((value: T | PromiseLike<T>) => void) | undefined,
+		// eslint-disable-next-line @typescript-eslint/no-explicit-any
+		_reject: ((reason?: any) => void) | undefined;
+	const promise = new Promise<T>((resolve, reject) => {
+		_resolve = resolve;
+		_reject = reject;
+	});
+	return { promise, resolve: _resolve!, reject: _reject! };
+};
+
+/*
+	A polyfill for when these symbols are undefined.
+	For some reason, NodeJS does not polyfill them in a VM context.
+	Since jest uses a VM context for ESM, these need to be here.
+*/
+// @ts-expect-error 2540
+Symbol['dispose'] ??= Symbol('Symbol.dispose');
+// @ts-expect-error 2540
+Symbol['asyncDispose'] ??= Symbol('Symbol.asyncDispose');

package/dist/symbol-dispose.js

@@ -1,10 +0,0 @@
-/*
-    This file acts as a polyfill for when these symbols are undefined.
-    For some reason, NodeJS does not polyfill them in a VM context.
-    Since jest uses a VM context for ESM, these need to be here.
-*/
-// @ts-expect-error 2540
-Symbol['dispose'] ?? (Symbol['dispose'] = Symbol('Symbol.dispose'));
-// @ts-expect-error 2540
-Symbol['asyncDispose'] ?? (Symbol['asyncDispose'] = Symbol('Symbol.asyncDispose'));
-export {};

package/src/symbol-dispose.ts

@@ -1,9 +0,0 @@
-/*
-	This file acts as a polyfill for when these symbols are undefined.
-	For some reason, NodeJS does not polyfill them in a VM context.
-	Since jest uses a VM context for ESM, these need to be here.
-*/
-// @ts-expect-error 2540
-Symbol['dispose'] ??= Symbol('Symbol.dispose');
-// @ts-expect-error 2540
-Symbol['asyncDispose'] ??= Symbol('Symbol.asyncDispose');