@zenfs/core 2.3.10 → 2.4.0

package/LICENSE.md

@@ -0,0 +1,157 @@
+# GNU LESSER GENERAL PUBLIC LICENSE
+
+Version 3, 29 June 2007
+
+Copyright (C) 2007 Free Software Foundation, Inc.
+<https://fsf.org/>
+
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
+
+This version of the GNU Lesser General Public License incorporates the
+terms and conditions of version 3 of the GNU General Public License,
+supplemented by the additional permissions listed below.
+
+## 0. Additional Definitions.
+
+As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the
+GNU General Public License.
+
+"The Library" refers to a covered work governed by this License, other
+than an Application or a Combined Work as defined below.
+
+An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+A "Combined Work" is a work produced by combining or linking an
+Application with the Library. The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+## 1. Exception to Section 3 of the GNU GPL.
+
+You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+## 2. Conveying Modified Versions.
+
+If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+-   a) under this License, provided that you make a good faith effort
+    to ensure that, in the event an Application does not supply the
+    function or data, the facility still operates, and performs
+    whatever part of its purpose remains meaningful, or
+-   b) under the GNU GPL, with none of the additional permissions of
+    this License applicable to that copy.
+
+## 3. Object Code Incorporating Material from Library Header Files.
+
+The object code form of an Application may incorporate material from a
+header file that is part of the Library. You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+-   a) Give prominent notice with each copy of the object code that
+    the Library is used in it and that the Library and its use are
+    covered by this License.
+-   b) Accompany the object code with a copy of the GNU GPL and this
+    license document.
+
+## 4. Combined Works.
+
+You may convey a Combined Work under terms of your choice that, taken
+together, effectively do not restrict modification of the portions of
+the Library contained in the Combined Work and reverse engineering for
+debugging such modifications, if you also do each of the following:
+
+-   a) Give prominent notice with each copy of the Combined Work that
+    the Library is used in it and that the Library and its use are
+    covered by this License.
+-   b) Accompany the Combined Work with a copy of the GNU GPL and this
+    license document.
+-   c) For a Combined Work that displays copyright notices during
+    execution, include the copyright notice for the Library among
+    these notices, as well as a reference directing the user to the
+    copies of the GNU GPL and this license document.
+-   d) Do one of the following:
+    -   0) Convey the Minimal Corresponding Source under the terms of
+        this License, and the Corresponding Application Code in a form
+        suitable for, and under terms that permit, the user to
+        recombine or relink the Application with a modified version of
+        the Linked Version to produce a modified Combined Work, in the
+        manner specified by section 6 of the GNU GPL for conveying
+        Corresponding Source.
+    -   1) Use a suitable shared library mechanism for linking with
+        the Library. A suitable mechanism is one that (a) uses at run
+        time a copy of the Library already present on the user's
+        computer system, and (b) will operate properly with a modified
+        version of the Library that is interface-compatible with the
+        Linked Version.
+-   e) Provide Installation Information, but only if you would
+    otherwise be required to provide such information under section 6
+    of the GNU GPL, and only to the extent that such information is
+    necessary to install and execute a modified version of the
+    Combined Work produced by recombining or relinking the Application
+    with a modified version of the Linked Version. (If you use option
+    4d0, the Installation Information must accompany the Minimal
+    Corresponding Source and Corresponding Application Code. If you
+    use option 4d1, you must provide the Installation Information in
+    the manner specified by section 6 of the GNU GPL for conveying
+    Corresponding Source.)
+
+## 5. Combined Libraries.
+
+You may place library facilities that are a work based on the Library
+side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+-   a) Accompany the combined library with a copy of the same work
+    based on the Library, uncombined with any other library
+    facilities, conveyed under the terms of this License.
+-   b) Give prominent notice with the combined library that part of it
+    is a work based on the Library, and explaining where to find the
+    accompanying uncombined form of the same work.
+
+## 6. Revised Versions of the GNU Lesser General Public License.
+
+The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Library
+as you received it specifies that a certain numbered version of the
+GNU Lesser General Public License "or any later version" applies to
+it, you have the option of following the terms and conditions either
+of that published version or of any later version published by the
+Free Software Foundation. If the Library as you received it does not
+specify a version number of the GNU Lesser General Public License, you
+may choose any version of the GNU Lesser General Public License ever
+published by the Free Software Foundation.
+
+If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

package/dist/backends/backend.js

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 /* eslint-disable @typescript-eslint/no-explicit-any, @typescript-eslint/no-redundant-type-constituents */
 import { withErrno } from 'kerium';
 import { debug, err } from 'kerium/log';

package/dist/backends/fetch.js

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 import { withErrno } from 'kerium';
 import { err, warn } from 'kerium/log';
 import { decodeUTF8 } from 'utilium';

package/dist/backends/index.js

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 export * from './backend.js';
 export * from './cow.js';
 export * from './fetch.js';

package/dist/backends/passthrough.js

@@ -50,6 +50,7 @@ var __disposeResources = (this && this.__disposeResources) || (function (Suppres
     var e = new Error(message);
     return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
 });
+// SPDX-License-Identifier: LGPL-3.0-or-later
 import { err, warn } from 'kerium/log';
 import { FileSystem } from '../internal/filesystem.js';
 import { isDirectory } from '../internal/inode.js';

package/dist/backends/single_buffer.js

@@ -84,6 +84,7 @@ var __disposeResources = (this && this.__disposeResources) || (function (Suppres
     var e = new Error(message);
     return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
 });
+// SPDX-License-Identifier: LGPL-3.0-or-later
 import { withErrno } from 'kerium';
 import { alert, crit, err, warn } from 'kerium/log';
 import { array, offsetof, packed, sizeof } from 'memium';

package/dist/backends/store/fs.js

@@ -50,6 +50,7 @@ var __disposeResources = (this && this.__disposeResources) || (function (Suppres
     var e = new Error(message);
     return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
 });
+// SPDX-License-Identifier: LGPL-3.0-or-later
 import { withErrno } from 'kerium';
 import { crit, debug, err, notice, warn } from 'kerium/log';
 import { sizeof } from 'memium';

package/dist/backends/store/store.js

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 import { withErrno } from 'kerium';
 import { warn } from 'kerium/log';
 import { Resource } from 'utilium/cache.js';

package/dist/config.d.ts

@@ -51,6 +51,11 @@ export interface Configuration<T extends ConfigMounts> extends SharedConfig {
      * @default false
      */
     addDevices: boolean;
+    /**
+     * Whether to automatically create some directories (e.g. /tmp)
+     * @default false
+     */
+    defaultDirectories: boolean;
     /**
      * If true, disables *all* permissions checking.
      *

package/dist/config.js

@@ -101,6 +101,7 @@ export function addDevice(driver, options) {
         throw log.crit(withErrno('ENOTSUP', '/dev does not exist or is not a device file system'));
     return devfs._createDevice(driver, options);
 }
+const _defaultDirectories = ['/tmp', '/var', '/etc'];
 /**
  * Configures ZenFS with `configuration`
  * @category Backends and Configuration
@@ -136,6 +137,17 @@ export async function configure(configuration) {
         await devfs.ready();
         await mount('/dev', devfs);
     }
+    if (configuration.defaultDirectories) {
+        for (const dir of _defaultDirectories) {
+            if (await fs.promises.exists(dir)) {
+                const stats = await fs.promises.stat(dir);
+                if (!stats.isDirectory())
+                    log.warn('Default directory exists but is not a directory: ' + dir);
+            }
+            else
+                await fs.promises.mkdir(dir);
+        }
+    }
 }
 export async function sync() {
     for (const fs of mounts.values())

package/dist/context.js

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 import { bindFunctions } from 'utilium';
 import { defaultContext } from './internal/contexts.js';
 import { createCredentials } from './internal/credentials.js';

package/dist/index.js

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 export * from './backends/index.js';
 export * from './config.js';
 export * from './context.js';

package/dist/internal/devices.js

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 /*
 This is a great resource: https://www.kernel.org/doc/html/latest/admin-guide/devices.html
 */

package/dist/internal/error.js

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 import { Exception, setUVMessage } from 'kerium';
 /**
  * @deprecated Use {@link Exception} instead

package/dist/internal/file_index.js

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 /* Note: this file is named file_index.ts because Typescript has special behavior regarding index.ts which can't be disabled. */
 import { withErrno } from 'kerium';
 import { sizeof } from 'memium';

package/dist/internal/filesystem.d.ts

@@ -115,6 +115,7 @@ export interface CreationOptions extends Partial<InodeLike> {
 export interface StreamOptions {
     start?: number;
     end?: number;
+    autoClose?: boolean;
 }
 /**
  * Provides a consistent and easy to use internal API.

package/dist/internal/index.js

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 export { log } from 'kerium'; // DO NOT USE
 export * from './credentials.js';
 export * from './devices.js';

package/dist/internal/index_fs.d.ts

@@ -30,6 +30,8 @@ export declare abstract class IndexFS extends FileSystem {
     protected create(path: string, options: CreationOptions): Inode;
     createFile(path: string, options: CreationOptions): Promise<InodeLike>;
     createFileSync(path: string, options: CreationOptions): InodeLike;
+    protected _mkdir?(path: string, options: CreationOptions): Promise<void>;
+    protected _mkdirSync?(path: string, options: CreationOptions): void;
     mkdir(path: string, options: CreationOptions): Promise<InodeLike>;
     mkdirSync(path: string, options: CreationOptions): InodeLike;
     link(target: string, link: string): Promise<void>;

package/dist/internal/index_fs.js

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 /* eslint-disable @typescript-eslint/require-await */
 import { withErrno } from 'kerium';
 import { _throw } from 'utilium';
@@ -38,31 +39,56 @@ export class IndexFS extends FileSystem {
                 to = to.slice(0, -1);
             toRename.push({ from, to, inode });
         }
+        toRename.sort((a, b) => b.from.length - a.from.length);
         return toRename;
     }
     async rename(oldPath, newPath) {
         if (oldPath == newPath)
             return;
-        for (const { from, to, inode } of this.pathsForRename(oldPath, newPath)) {
+        const toRename = this.pathsForRename(oldPath, newPath);
+        const contents = new Map();
+        for (const { from, to, inode } of toRename) {
             const data = new Uint8Array(inode.size);
             await this.read(from, data, 0, inode.size);
+            contents.set(to, data);
             this.index.delete(from);
+            await this.remove(from);
+            if (this.index.has(to))
+                await this.remove(to);
+        }
+        toRename.reverse();
+        for (const { to, inode } of toRename) {
+            const data = contents.get(to);
             this.index.set(to, inode);
-            await this.write(to, data, 0);
+            if ((inode.mode & S_IFMT) == S_IFDIR)
+                await this._mkdir?.(to, inode);
+            else
+                await this.write(to, data, 0);
         }
-        await this.remove(oldPath);
     }
     renameSync(oldPath, newPath) {
         if (oldPath == newPath)
             return;
-        for (const { from, to, inode } of this.pathsForRename(oldPath, newPath)) {
+        const toRename = this.pathsForRename(oldPath, newPath);
+        const contents = new Map();
+        for (const { from, to, inode } of toRename) {
             const data = new Uint8Array(inode.size);
             this.readSync(from, data, 0, inode.size);
+            contents.set(to, data);
             this.index.delete(from);
+            this.removeSync(from);
+            if (this.index.has(to))
+                this.removeSync(to);
+        }
+        toRename.reverse();
+        for (const { to, inode } of toRename) {
+            const data = contents.get(to);
             this.index.set(to, inode);
-            this.writeSync(to, data, 0);
+            if ((inode.mode & S_IFMT) == S_IFDIR)
+                this._mkdirSync?.(to, inode);
+            else
+                this.writeSync(to, data, 0);
         }
-        this.removeSync(oldPath);
     }
     async stat(path) {
         const inode = this.index.get(path);
@@ -148,11 +174,15 @@ export class IndexFS extends FileSystem {
     }
     async mkdir(path, options) {
         options.mode |= S_IFDIR;
-        return this.create(path, options);
+        const inode = this.create(path, options);
+        await this._mkdir?.(path, options);
+        return inode;
     }
     mkdirSync(path, options) {
         options.mode |= S_IFDIR;
-        return this.create(path, options);
+        const inode = this.create(path, options);
+        this._mkdirSync?.(path, options);
+        return inode;
     }
     link(target, link) {
         throw withErrno('ENOSYS');

package/dist/internal/inode.js

@@ -32,6 +32,7 @@ var __runInitializers = (this && this.__runInitializers) || function (thisArg, i
     }
     return useValue ? value : void 0;
 };
+// SPDX-License-Identifier: LGPL-3.0-or-later
 import { withErrno } from 'kerium';
 import { crit, warn } from 'kerium/log';
 import { sizeof } from 'memium';

package/dist/mixins/index.js

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 export * from './async.js';
 export * from './mutexed.js';
 export * from './readonly.js';

package/dist/mixins/mutexed.d.ts

@@ -49,7 +49,7 @@ export declare class _MutexedFS<T extends FileSystem> implements FileSystem {
      * If the path is currently locked, waits for it to be unlocked.
      * @internal
      */
-    lock(): Promise<MutexLock>;
+    lock(timeout?: number): Promise<MutexLock>;
     /**
      * Locks `path` asynchronously.
      * If the path is currently locked, an error will be thrown

package/dist/mixins/mutexed.js

@@ -135,7 +135,7 @@ export class _MutexedFS {
      * If the path is currently locked, waits for it to be unlocked.
      * @internal
      */
-    async lock() {
+    async lock(timeout = 5000) {
         const previous = this.currentLock;
         const lock = this.addLock();
         const stack = new Error().stack;
@@ -145,7 +145,7 @@ export class _MutexedFS {
                 error.stack += stack?.slice('Error'.length);
                 throw err(error);
             }
-        }, 5000);
+        }, timeout);
         await previous?.done();
         return lock;
     }

package/dist/mixins/readonly.js

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 import { withErrno } from 'kerium';
 /**
  * Implements the non-readonly methods to throw `EROFS`

package/dist/mixins/shared.js

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 /* eslint-disable @typescript-eslint/no-empty-object-type,@typescript-eslint/no-explicit-any */
 /*
     Code shared by various mixins

package/dist/path.js

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 /*
 Copyright Joyent, Inc. and other Node contributors.
 

package/dist/polyfills.js

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 /* node:coverage disable */
 /* eslint-disable @typescript-eslint/unbound-method */
 import { warn } from 'kerium/log';

package/dist/readline.js

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 /* eslint-disable @typescript-eslint/no-explicit-any */
 // A cross-platform node:readline implementation
 import { EventEmitter } from 'eventemitter3';

package/dist/utils.d.ts

@@ -59,3 +59,7 @@ export declare function normalizeOptions(options: fs.WriteFileOptions | (fs.Enco
  */
 export declare function globToRegex(pattern: string): RegExp;
 export declare function waitOnline(worker: NodeWorker): Promise<void>;
+/**
+ * @internal @hidden
+ */
+export declare function _tempDirName(prefix: fs.PathLike): string;

package/dist/utils.js

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 import { withErrno } from 'kerium';
 import { decodeUTF8, encodeUTF8 } from 'utilium';
 import { resolve } from './path.js';
@@ -114,3 +115,9 @@ export async function waitOnline(worker) {
     worker.on('online', online.resolve);
     await online.promise;
 }
+/**
+ * @internal @hidden
+ */
+export function _tempDirName(prefix) {
+    return `/tmp/${normalizePath(prefix, true)}${Date.now()}-${Math.random().toString(36).slice(2)}`;
+}

package/dist/vfs/acl.js

@@ -32,6 +32,7 @@ var __runInitializers = (this && this.__runInitializers) || function (thisArg, i
     }
     return useValue ? value : void 0;
 };
+// SPDX-License-Identifier: LGPL-3.0-or-later
 /*
     Access Control Lists.
     At the moment, they are only intended for internal use.

package/dist/vfs/config.js

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 /** Whether to perform access checks */
 export let checkAccess = true;
 /**

package/dist/vfs/constants.js

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 /*
 FS Constants
 See https://nodejs.org/api/fs.html#file-access-constants

package/dist/vfs/dir.js

@@ -35,7 +35,7 @@ var __runInitializers = (this && this.__runInitializers) || function (thisArg, i
 import { Buffer } from 'buffer';
 import { withErrno } from 'kerium';
 import { warn } from 'kerium/log';
-import { packed, sizeof } from 'memium';
+import { sizeof } from 'memium';
 import { $from, struct, types as t } from 'memium/decorators';
 import { encodeUTF8 } from 'utilium';
 import { BufferView } from 'utilium/buffer.js';
@@ -252,9 +252,13 @@ export class Dir {
         return this;
     }
     [Symbol.dispose]() {
+        if (this.closed)
+            return;
         this.closeSync();
     }
     async [Symbol.asyncDispose]() {
+        if (this.closed)
+            return;
         await this.close();
     }
 }

package/dist/vfs/file.js

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 import { UV, withErrno } from 'kerium';
 import { defaultContext } from '../internal/contexts.js';
 import { InodeFlags, isBlockDevice, isCharacterDevice } from '../internal/inode.js';

package/dist/vfs/flags.js

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 import { withErrno } from 'kerium';
 import * as c from './constants.js';
 export const pattern = /[rwasx]{1,2}\+?/;

package/dist/vfs/index.js

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 export * from './async.js';
 export * as constants from './constants.js';
 export * from './dir.js';

package/dist/vfs/ioctl.js

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 /*
     ioctl stuff. The majority of the code here is ported from Linux
     See:

package/dist/vfs/promises.d.ts

@@ -359,9 +359,9 @@ export declare function lutimes(this: V_Context, path: fs.PathLike, atime: fs.Ti
  */
 export declare function realpath(this: V_Context, path: fs.PathLike, options: fs.BufferEncodingOption): Promise<Buffer>;
 export declare function realpath(this: V_Context, path: fs.PathLike, options?: fs.EncodingOption | BufferEncoding): Promise<string>;
-export declare function watch(this: V_Context, filename: fs.PathLike, options?: fs.WatchOptions | BufferEncoding): AsyncIteratorObject<promises.FileChangeInfo<string>>;
-export declare function watch(this: V_Context, filename: fs.PathLike, options: fs.WatchOptions | fs.BufferEncodingOption): AsyncIteratorObject<promises.FileChangeInfo<Buffer>>;
-export declare function watch(this: V_Context, filename: fs.PathLike, options?: fs.WatchOptions | string): AsyncIteratorObject<promises.FileChangeInfo<string>> | AsyncIteratorObject<promises.FileChangeInfo<Buffer>>;
+export declare function watch(this: V_Context, filename: fs.PathLike, options?: fs.WatchOptions | BufferEncoding): AsyncIteratorObject<promises.FileChangeInfo<string>, undefined>;
+export declare function watch(this: V_Context, filename: fs.PathLike, options: fs.WatchOptions | fs.BufferEncodingOption): AsyncIteratorObject<promises.FileChangeInfo<Buffer>, undefined>;
+export declare function watch(this: V_Context, filename: fs.PathLike, options?: fs.WatchOptions | string): AsyncIteratorObject<promises.FileChangeInfo<string>, undefined> | AsyncIteratorObject<promises.FileChangeInfo<Buffer>, undefined>;
 export declare function access(this: V_Context, path: fs.PathLike, mode?: number): Promise<void>;
 /**
  * Asynchronous `rm`. Removes files or directories (recursively).
@@ -376,6 +376,18 @@ export declare function rm(this: V_Context, path: fs.PathLike, options?: fs.RmOp
  */
 export declare function mkdtemp(this: V_Context, prefix: string, options?: fs.EncodingOption): Promise<string>;
 export declare function mkdtemp(this: V_Context, prefix: string, options?: fs.BufferEncodingOption): Promise<Buffer>;
+/**
+ * The resulting Promise holds an async-disposable object whose `path` property holds the created directory path.
+ * When the object is disposed, the directory and its contents will be removed asynchronously if it still exists.
+ * If the directory cannot be deleted, disposal will throw an error.
+ * The object has an async `remove()` method which will perform the same task.
+ * @todo Add `satisfies` and maybe change return type once @types/node adds this.
+ */
+export declare function mkdtempDisposable(this: V_Context, prefix: fs.PathLike, options?: fs.EncodingOption | fs.BufferEncodingOption): Promise<{
+    path: string;
+    remove(): Promise<void>;
+    [Symbol.asyncDispose](): Promise<void>;
+}>;
 /**
  * Asynchronous `copyFile`. Copies a file.
  * @param src The source file.

package/dist/vfs/promises.js

@@ -57,7 +57,7 @@ import { hasAccess, InodeFlags, isBlockDevice, isCharacterDevice, isDirectory, i
 import { basename, dirname, join, matchesGlob, parse, resolve } from '../path.js';
 import '../polyfills.js';
 import { createInterface } from '../readline.js';
-import { __assertType, globToRegex, normalizeMode, normalizeOptions, normalizePath, normalizeTime } from '../utils.js';
+import { __assertType, _tempDirName, globToRegex, normalizeMode, normalizeOptions, normalizePath, normalizeTime } from '../utils.js';
 import { checkAccess } from './config.js';
 import * as constants from './constants.js';
 import { Dir, Dirent } from './dir.js';
@@ -1062,12 +1062,12 @@ export function watch(filename, options = {}) {
             resolve({ value: null, done });
         }
         eventQueue.length = 0; // Clear the queue
-        return Promise.resolve({ value: null, done: true });
+        return Promise.resolve({ value: undefined, done: true });
     }
     return {
         async next() {
             if (done)
-                return Promise.resolve({ value: null, done });
+                return Promise.resolve({ value: undefined, done });
             const { promise, resolve } = Promise.withResolvers();
             eventQueue.push(resolve);
             return promise;
@@ -1128,12 +1128,24 @@ export async function rm(path, options) {
 rm;
 export async function mkdtemp(prefix, options) {
     const encoding = typeof options === 'object' ? options?.encoding : options || 'utf8';
-    const fsName = `${prefix}${Date.now()}-${Math.random().toString(36).slice(2)}`;
-    const resolvedPath = '/tmp/' + fsName;
-    await mkdir.call(this, resolvedPath);
-    return encoding == 'buffer' ? Buffer.from(resolvedPath) : resolvedPath;
+    const path = _tempDirName(prefix);
+    await mkdir.call(this, path);
+    return encoding == 'buffer' ? Buffer.from(path) : path;
 }
 mkdtemp;
+/**
+ * The resulting Promise holds an async-disposable object whose `path` property holds the created directory path.
+ * When the object is disposed, the directory and its contents will be removed asynchronously if it still exists.
+ * If the directory cannot be deleted, disposal will throw an error.
+ * The object has an async `remove()` method which will perform the same task.
+ * @todo Add `satisfies` and maybe change return type once @types/node adds this.
+ */
+export async function mkdtempDisposable(prefix, options) {
+    const path = _tempDirName(prefix);
+    await mkdir.call(this, path);
+    const remove = () => rm(path, { recursive: true, force: true });
+    return { path, remove, [Symbol.asyncDispose]: remove };
+}
 /**
  * Asynchronous `copyFile`. Copies a file.
  * @param src The source file.

package/dist/vfs/shared.js

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 // Utilities and shared data
 import { Errno, Exception, UV, withErrno } from 'kerium';
 import { alert, debug, err, info, notice, warn } from 'kerium/log';

package/dist/vfs/sync.d.ts

@@ -173,8 +173,20 @@ export declare function rmSync(this: V_Context, path: fs.PathLike, options?: fs.
  * @param options The encoding (or an object including `encoding`).
  * @returns The path to the created temporary directory, encoded as a string or buffer.
  */
-export declare function mkdtempSync(this: V_Context, prefix: string, options: fs.BufferEncodingOption): Buffer;
-export declare function mkdtempSync(this: V_Context, prefix: string, options?: fs.EncodingOption): string;
+export declare function mkdtempSync(this: V_Context, prefix: fs.PathLike, options: fs.BufferEncodingOption): Buffer;
+export declare function mkdtempSync(this: V_Context, prefix: fs.PathLike, options?: fs.EncodingOption): string;
+/**
+ * Returns a disposable object whose `path` property holds the created directory path.
+ * When the object is disposed, the directory and its contents will be removed if it still exists.
+ * If the directory cannot be deleted, disposal will throw an error.
+ * The object has a `remove()` method which will perform the same task.
+ * @todo Add `satisfies` and maybe change return type once @types/node adds this.
+ */
+export declare function mkdtempDisposableSync(this: V_Context, prefix: fs.PathLike, options?: fs.EncodingOption | fs.BufferEncodingOption): {
+    path: string;
+    remove(): void;
+    [Symbol.dispose](): void;
+};
 /**
  * Synchronous `copyFile`. Copies a file.
  * @param flags Optional flags for the copy operation. Currently supports these flags:

package/dist/vfs/sync.js

@@ -57,7 +57,7 @@ import { defaultContext } from '../internal/contexts.js';
 import { wrap } from '../internal/error.js';
 import { hasAccess, isDirectory, isSymbolicLink } from '../internal/inode.js';
 import { basename, dirname, join, matchesGlob, parse, resolve } from '../path.js';
-import { __assertType, globToRegex, normalizeMode, normalizeOptions, normalizePath, normalizeTime } from '../utils.js';
+import { __assertType, _tempDirName, globToRegex, normalizeMode, normalizeOptions, normalizePath, normalizeTime } from '../utils.js';
 import { checkAccess } from './config.js';
 import * as constants from './constants.js';
 import { Dir, Dirent } from './dir.js';
@@ -733,12 +733,24 @@ export function rmSync(path, options) {
 rmSync;
 export function mkdtempSync(prefix, options) {
     const encoding = typeof options === 'object' ? options?.encoding : options || 'utf8';
-    const fsName = `${prefix}${Date.now()}-${Math.random().toString(36).slice(2)}`;
-    const resolvedPath = '/tmp/' + fsName;
-    mkdirSync.call(this, resolvedPath);
-    return encoding == 'buffer' ? Buffer.from(resolvedPath) : resolvedPath;
+    const path = _tempDirName(prefix);
+    mkdirSync.call(this, path);
+    return encoding == 'buffer' ? Buffer.from(path) : path;
 }
 mkdtempSync;
+/**
+ * Returns a disposable object whose `path` property holds the created directory path.
+ * When the object is disposed, the directory and its contents will be removed if it still exists.
+ * If the directory cannot be deleted, disposal will throw an error.
+ * The object has a `remove()` method which will perform the same task.
+ * @todo Add `satisfies` and maybe change return type once @types/node adds this.
+ */
+export function mkdtempDisposableSync(prefix, options) {
+    const path = _tempDirName(prefix);
+    mkdirSync.call(this, path);
+    const remove = () => rmSync(path, { recursive: true, force: true });
+    return { path, remove, [Symbol.dispose]: remove };
+}
 /**
  * Synchronous `copyFile`. Copies a file.
  * @param flags Optional flags for the copy operation. Currently supports these flags:

package/dist/vfs/xattr.js

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 import { Buffer } from 'buffer';
 import { rethrow, setUVMessage, UV } from 'kerium';
 import { Attributes, hasAccess } from '../internal/inode.js';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@zenfs/core",
-	"version": "2.3.10",
+	"version": "2.4.0",
 	"description": "A filesystem, anywhere",
 	"funding": {
 		"type": "individual",
@@ -31,7 +31,7 @@
 	"contributors": [
 		"John Vilk <jvilk@cs.umass.edu>"
 	],
-	"license": "MIT",
+	"license": "LGPL-3.0-or-later",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/zen-fs/core.git"
@@ -59,8 +59,10 @@
 	"scripts": {
 		"format": "prettier --write .",
 		"format:check": "prettier --check .",
+		"spdx:check": "npx lice -a src tests/*.ts tests/**/*.test.ts",
+		"spdx:fix": "npx lice -aw src tests/*.ts tests/**/*.test.ts",
 		"lint": "eslint src tests",
-		"test": "npx zenfs-test --clean; npx zenfs-test -abcfp; tests/fetch/run.sh; npx zenfs-test --report",
+		"test": "npx zenfs-test --clean; npx zenfs-test -abcp; tests/fetch/run.sh; npx zenfs-test --report",
 		"build": "tsc -p tsconfig.json",
 		"build:docs": "typedoc",
 		"dev": "npm run build -- --watch",
@@ -73,7 +75,7 @@
 		"kerium": "^1.3.4",
 		"memium": "^0.3.7",
 		"readable-stream": "^4.5.2",
-		"utilium": "^2.3.3"
+		"utilium": "^2.5.0"
 	},
 	"devDependencies": {
 		"@eslint/js": "^9.8.0",

package/tests/assignment.ts

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 /* eslint-disable @typescript-eslint/no-unused-vars */
 
 /*

package/tests/backend/fetch.test.ts

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 import assert from 'node:assert/strict';
 import { join } from 'node:path';
 import { after, suite, test } from 'node:test';

package/tests/backend/port.test.ts

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 import assert from 'node:assert/strict';
 import { after, suite, test } from 'node:test';
 import { MessageChannel, Worker } from 'node:worker_threads';
@@ -12,7 +13,7 @@ setupLogs();
 const timeoutChannel = new MessageChannel();
 timeoutChannel.port2.unref();
 
-await suite('Timeout', { timeout: 1000 }, () => {
+await suite('Timeout', () => {
 	test('Misconfiguration', async () => {
 		const configured = configure({
 			mounts: {

package/tests/backend/single-buffer.test.ts

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 import assert from 'node:assert';
 import { suite, test } from 'node:test';
 import { Worker } from 'worker_threads';

package/tests/common/casefold.test.ts

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 import assert from 'node:assert/strict';
 import { suite, test } from 'node:test';
 import { mounts, configure, fs } from '../../dist/index.js';

package/tests/common/context.test.ts

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 import assert from 'node:assert/strict';
 import { suite, test } from 'node:test';
 import { canary } from 'utilium';

package/tests/common/devices.test.ts

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 import { suite, test } from 'node:test';
 import assert from 'node:assert/strict';
 import { configure } from '../../dist/config.js';

package/tests/common/handle.test.ts

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 import assert from 'node:assert/strict';
 import { after, suite, test } from 'node:test';
 import { wait } from 'utilium';

package/tests/common/inode.test.ts

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 import { suite, test } from 'node:test';
 import { Inode } from '../../dist/internal/inode.js';
 import assert from 'node:assert';

package/tests/common/mounts.test.ts

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 import assert from 'node:assert/strict';
 import { suite, test } from 'node:test';
 import { configure } from '../../dist/config.js';

package/tests/common/mutex.test.ts

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 import assert from 'node:assert/strict';
 import { suite, test } from 'node:test';
 import { wait } from 'utilium';
@@ -20,11 +21,11 @@ suite('Mutexed FS', () => {
 		let lock1Resolved = false;
 		let lock2Resolved = false;
 
-		const lock1 = fs.lock().then(lock => {
+		const lock1 = fs.lock(100).then(lock => {
 			lock1Resolved = true;
 			lock.unlock();
 		});
-		const lock2 = fs.lock().then(lock => {
+		const lock2 = fs.lock(100).then(lock => {
 			lock2Resolved = true;
 			lock.unlock();
 		});
@@ -50,7 +51,7 @@ suite('Mutexed FS', () => {
 		let x = 1;
 
 		async function foo() {
-			const lock = await fs.lock();
+			const lock = await fs.lock(100);
 			await wait(25);
 			x++;
 			lock.unlock();

package/tests/common/path.test.ts

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 import assert from 'node:assert/strict';
 import { suite, test } from 'node:test';
 import { basename, dirname, extname, join, normalize, resolve } from '../../dist/path.js';

package/tests/common/readline.test.ts

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 import assert from 'node:assert/strict';
 import { PassThrough } from 'node:stream';
 import { suite, test } from 'node:test';

package/tests/common.ts

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 import { join, resolve } from 'node:path';
 import { fs as defaultFS } from '../dist/index.js';
 import { setupLogs } from './logs.js';

package/{license.md → tests/data-license.md}

@@ -1,5 +1,3 @@
-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/data`.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of

package/tests/fs/append.test.ts

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 import assert from 'node:assert/strict';
 import { suite, test } from 'node:test';
 import { fs } from '../common.js';

package/tests/fs/dir.test.ts

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 import assert, { rejects } from 'node:assert/strict';
 import { suite, test } from 'node:test';
 import { fs, type Dirent } from '../common.js';

package/tests/fs/directory.test.ts

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 import assert from 'node:assert/strict';
 import { join } from 'node:path/posix';
 import { suite, test } from 'node:test';

package/tests/fs/errors.test.ts

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 import assert from 'node:assert/strict';
 import test, { suite } from 'node:test';
 import { fs } from '../common.js';

package/tests/fs/exists.test.ts

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 import assert from 'node:assert/strict';
 import { suite, test } from 'node:test';
 import { fs } from '../common.js';

package/tests/fs/links.test.ts

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 import type { Exception } from 'kerium';
 import assert from 'node:assert/strict';
 import { suite, test } from 'node:test';

package/tests/fs/open.test.ts

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 import assert from 'node:assert/strict';
 import { suite, test } from 'node:test';
 import { fs } from '../common.js';

package/tests/fs/permissions.test.ts

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 import { Exception } from 'kerium';
 import assert from 'node:assert/strict';
 import { suite, test } from 'node:test';

package/tests/fs/read.test.ts

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 import { Buffer } from 'buffer';
 import assert from 'node:assert/strict';
 import type { OpenMode, PathLike } from 'node:fs';

package/tests/fs/readFile.test.ts

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 import assert from 'node:assert/strict';
 import { suite, test } from 'node:test';
 import { fs } from '../common.js';

package/tests/fs/rename.test.ts

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 import assert from 'node:assert/strict';
 import { suite, test } from 'node:test';
 import { fs } from '../common.js';

package/tests/fs/scaling.test.ts

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 import assert from 'node:assert/strict';
 import { suite, test } from 'node:test';
 import { sync } from '../../dist/config.js';

package/tests/fs/stat.test.ts

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 import assert from 'node:assert/strict';
 import { suite, test } from 'node:test';
 import { defaultContext } from '../../dist/internal/contexts.js';

package/tests/fs/streams.test.ts

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 import assert from 'node:assert/strict';
 import { suite, test } from 'node:test';
 import { fs } from '../common.js';

package/tests/fs/tempdir.test.ts

@@ -0,0 +1,41 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
+import { test, suite } from 'node:test';
+import { fs } from '../common.js';
+import assert from 'node:assert/strict';
+import { basename } from 'node:path/posix';
+
+await fs.promises.mkdir('/tmp');
+
+suite('Temporary Directories', () => {
+	test('mkdtempSync', () => {
+		const path = fs.mkdtempSync('test-', { encoding: 'utf8' });
+
+		assert.deepEqual(fs.readdirSync('/tmp'), [basename(path)]);
+
+		fs.rmdirSync(path);
+	});
+
+	test('mkdtemp', async () => {
+		const path = await fs.promises.mkdtemp('test-', { encoding: 'utf8' });
+
+		assert.deepEqual(await fs.promises.readdir('/tmp'), [basename(path)]);
+
+		await fs.promises.rmdir(path);
+	});
+
+	test('mkdtempDisposableSync', () => {
+		using result = fs.mkdtempDisposableSync('test-', { encoding: 'utf8' });
+
+		assert.deepEqual(fs.readdirSync('/tmp'), [basename(result.path)]);
+
+		fs.rmdirSync(result.path);
+	});
+
+	test('mkdtempDisposable', async () => {
+		await using result = await fs.promises.mkdtempDisposable('test-', { encoding: 'utf8' });
+
+		assert.deepEqual(await fs.promises.readdir('/tmp'), [basename(result.path)]);
+
+		await fs.promises.rmdir(result.path);
+	});
+});

package/tests/fs/times.test.ts

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 import { Exception } from 'kerium';
 import assert from 'node:assert/strict';
 import { suite, test } from 'node:test';

package/tests/fs/truncate.test.ts

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 import assert from 'node:assert/strict';
 import { suite, test } from 'node:test';
 import { fs } from '../common.js';

package/tests/fs/watch.test.ts

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 import assert from 'node:assert/strict';
 import { suite, test } from 'node:test';
 import { fs, type Stats } from '../common.js';

package/tests/fs/write.test.ts

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 import assert from 'node:assert/strict';
 import { readFileSync } from 'node:fs';
 import { join } from 'node:path/posix';

package/tests/fs/xattr.test.ts

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 import { Buffer } from 'buffer';
 import assert from 'node:assert/strict';
 import { suite, test } from 'node:test';

package/tests/setup.ts

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: LGPL-3.0-or-later
 import { existsSync, mkdirSync, readFileSync, readdirSync, statSync } from 'node:fs';
 import { join, relative } from 'node:path';
 import { fs as _fs } from '../dist/index.js';