opfs-mock 2.5.1 → 2.6.1

package/README.md

@@ -1,7 +1,7 @@
 # opfs-mock
 
 In-memory implementation of the [origin private file system](https://developer.mozilla.org/en-US/docs/Web/API/File_System_API/Origin_private_file_system). Its main utility is for testing OPFS-dependent code in Node.js. It's tested
-on Node.js versions 20-25.
+on all supported Node.js versions (`22.x`, `24.x`, `25.x`, `26.x`).
 
 ## Installation
 

package/dist/index.d.mts

@@ -1,9 +1,37 @@
+//#region src/types.d.ts
+// Experimental properties:
+// https://developer.mozilla.org/en-US/docs/Web/API/FileSystemHandle/queryPermission
+// https://developer.mozilla.org/en-US/docs/Web/API/FileSystemHandle/requestPermission
+// https://developer.mozilla.org/en-US/docs/Web/API/FileSystemHandle/remove
+type PermissionHandler = (descriptor?: FileSystemHandlePermissionDescriptor) => Promise<PermissionState>;
+declare global {
+  interface FileSystemHandlePermissionDescriptor {
+    mode?: 'read' | 'readwrite';
+  }
+  interface FileSystemFileHandle extends FileSystemHandle {
+    queryPermission(descriptor?: FileSystemHandlePermissionDescriptor): Promise<PermissionState>;
+    requestPermission(descriptor?: FileSystemHandlePermissionDescriptor): Promise<PermissionState>;
+    remove(): Promise<void>;
+  }
+  interface FileSystemDirectoryHandle extends FileSystemHandle {
+    queryPermission(descriptor?: FileSystemHandlePermissionDescriptor): Promise<PermissionState>;
+    requestPermission(descriptor?: FileSystemHandlePermissionDescriptor): Promise<PermissionState>;
+    remove(): Promise<void>;
+  }
+}
+//#endregion
 //#region src/index.d.ts
+interface StorageFactoryOptions extends StorageEstimate {
+  queryPermission?: PermissionHandler;
+  requestPermission?: PermissionHandler;
+}
 declare const storageFactory: ({
   usage,
-  quota
-}?: StorageEstimate) => StorageManager;
+  quota,
+  queryPermission,
+  requestPermission
+}?: StorageFactoryOptions) => StorageManager;
 declare const mockOPFS: () => void;
-declare const resetMockOPFS: () => void;
+declare const resetMockOPFS: (options?: StorageFactoryOptions) => void;
 //#endregion
-export { mockOPFS, resetMockOPFS, storageFactory };
+export { StorageFactoryOptions, mockOPFS, resetMockOPFS, storageFactory };

package/dist/index.mjs

@@ -13,31 +13,36 @@ const getSizeOfDirectory = async (directory) => {
 	} else if (isDirectoryHandle(handle)) totalSize += await getSizeOfDirectory(handle);
 	return totalSize;
 };
-
 //#endregion
 //#region src/opfs.ts
 const isObject = (v) => typeof v === "object" && v !== null;
 const isLegacyWriteParams = (v) => isObject(v) && !("type" in v) && "data" in v;
-const fileSystemFileHandleFactory = (name, fileData, exists) => {
+const fileSystemFileHandleFactory = (name, fileData, exists, onRemove, permissions) => {
+	const checkPermission = async (mode = "read") => {
+		if (await (permissions?.queryPermission?.({ mode }) ?? Promise.resolve("granted")) !== "granted") throw new DOMException("Permission denied", "NotAllowedError");
+	};
 	return {
 		kind: "file",
 		name,
-		queryPermission: async () => {
-			return "granted";
-		},
-		requestPermission: async () => {
-			return "granted";
+		queryPermission: permissions?.queryPermission ?? (async () => "granted"),
+		requestPermission: permissions?.requestPermission ?? (async () => "granted"),
+		remove: async () => {
+			await checkPermission("readwrite");
+			if (!exists()) throw new DOMException("A requested file or directory could not be found at the time an operation was processed.", "NotFoundError");
+			onRemove?.();
 		},
 		isSameEntry: async function(other) {
 			return other === this;
 		},
 		getFile: async () => {
+			await checkPermission("read");
 			if (!exists()) throw new DOMException("A requested file or directory could not be found at the time an operation was processed.", "NotFoundError");
 			const f = new File([fileData.content], name, { lastModified: fileData.lastModified });
 			f._opfsId = fileData.id;
 			return f;
 		},
 		createWritable: async (options) => {
+			await checkPermission("readwrite");
 			const keepExistingData = options?.keepExistingData;
 			let abortReason = "";
 			let isAborted = false;
@@ -152,6 +157,7 @@ const fileSystemFileHandleFactory = (name, fileData, exists) => {
 			});
 		},
 		createSyncAccessHandle: async () => {
+			await checkPermission("readwrite");
 			if (fileData.locked) throw new DOMException("A sync access handle is already open for this file", "InvalidStateError");
 			fileData.locked = true;
 			let closed = false;
@@ -207,27 +213,39 @@ const fileSystemFileHandleFactory = (name, fileData, exists) => {
 		}
 	};
 };
-const fileSystemDirectoryHandleFactory = (name) => {
+const fileSystemDirectoryHandleFactory = (name, permissions, onRemove) => {
 	const files = /* @__PURE__ */ new Map();
 	const directories = /* @__PURE__ */ new Map();
 	const getJoinedMaps = () => {
 		return new Map([...files, ...directories]);
 	};
-	return {
+	const checkPermission = async (mode = "read") => {
+		if (await (permissions?.queryPermission?.({ mode }) ?? Promise.resolve("granted")) !== "granted") throw new DOMException("Permission denied", "NotAllowedError");
+	};
+	const handle = {
 		kind: "directory",
 		name,
-		queryPermission: async () => "granted",
-		requestPermission: async () => "granted",
+		queryPermission: permissions?.queryPermission ?? (async () => "granted"),
+		requestPermission: permissions?.requestPermission ?? (async () => "granted"),
+		remove: async () => {
+			await checkPermission("readwrite");
+			if (!onRemove) throw new DOMException("The root directory cannot be removed.", "InvalidModificationError");
+			for await (const _ of handle.values()) throw new DOMException("The directory is not empty", "InvalidModificationError");
+			onRemove();
+		},
 		isSameEntry: async function(other) {
 			return other === this;
 		},
 		getFileHandle: async (fileName, options) => {
 			if (directories.has(fileName)) throw new DOMException(`A directory with the same name exists: ${fileName}`, "TypeMismatchError");
-			if (!files.has(fileName) && options?.create) files.set(fileName, fileSystemFileHandleFactory(fileName, {
-				content: new Uint8Array(),
-				lastModified: Date.now(),
-				id: Symbol("file")
-			}, () => files.has(fileName)));
+			if (!files.has(fileName) && options?.create) {
+				await checkPermission("readwrite");
+				files.set(fileName, fileSystemFileHandleFactory(fileName, {
+					content: new Uint8Array(),
+					lastModified: Date.now(),
+					id: Symbol("file")
+				}, () => files.has(fileName), () => files.delete(fileName), permissions));
+			} else await checkPermission("read");
 			const fileHandle = files.get(fileName);
 			if (!fileHandle) throw new DOMException(`File not found: ${fileName}`, "NotFoundError");
 			return fileHandle;
@@ -235,14 +253,16 @@ const fileSystemDirectoryHandleFactory = (name) => {
 		getDirectoryHandle: async (dirName, options) => {
 			if (files.has(dirName)) throw new DOMException(`A file with the same name exists: ${dirName}`, "TypeMismatchError");
 			if (!directories.has(dirName) && options?.create) {
-				const dir = fileSystemDirectoryHandleFactory(dirName);
+				await checkPermission("readwrite");
+				const dir = fileSystemDirectoryHandleFactory(dirName, permissions, () => directories.delete(dirName));
 				directories.set(dirName, dir);
-			}
+			} else await checkPermission("read");
 			const directoryHandle = directories.get(dirName);
 			if (!directoryHandle) throw new DOMException(`Directory not found: ${dirName}`, "NotFoundError");
 			return directoryHandle;
 		},
 		removeEntry: async (entryName, options) => {
+			await checkPermission("readwrite");
 			if (files.has(entryName)) {
 				files.delete(entryName);
 				return;
@@ -256,20 +276,27 @@ const fileSystemDirectoryHandleFactory = (name) => {
 			throw new DOMException(`No such file or directory: ${entryName}`, "NotFoundError");
 		},
 		[Symbol.asyncIterator]: async function* () {
+			await checkPermission("read");
 			const entries = getJoinedMaps();
 			for (const [n, h] of entries) yield [n, h];
 			return void 0;
 		},
 		entries: async function* () {
-			yield* getJoinedMaps().entries();
+			await checkPermission("read");
+			const joinedMaps = getJoinedMaps();
+			for (const [n, h] of joinedMaps.entries()) yield [n, h];
 		},
 		keys: async function* () {
+			await checkPermission("read");
 			yield* getJoinedMaps().keys();
 		},
 		values: async function* () {
-			yield* getJoinedMaps().values();
+			await checkPermission("read");
+			const joinedMaps = getJoinedMaps();
+			for (const h of joinedMaps.values()) yield h;
 		},
 		resolve: async function(possibleDescendant) {
+			await checkPermission("read");
 			const traverseDirectory = async (directory, target, path = []) => {
 				if (await directory.isSameEntry(target)) return path;
 				for await (const [nm, h] of directory.entries()) if (isDirectoryHandle(h)) {
@@ -283,12 +310,15 @@ const fileSystemDirectoryHandleFactory = (name) => {
 			return traverseDirectory(this, possibleDescendant);
 		}
 	};
+	return handle;
 };
-
 //#endregion
 //#region src/index.ts
-const storageFactory = ({ usage = 0, quota = 1024 ** 3 } = {}) => {
-	const root = fileSystemDirectoryHandleFactory("root");
+const storageFactory = ({ usage = 0, quota = 1024 ** 3, queryPermission, requestPermission } = {}) => {
+	const root = fileSystemDirectoryHandleFactory("root", {
+		queryPermission,
+		requestPermission
+	});
 	return {
 		estimate: async () => {
 			return {
@@ -317,14 +347,16 @@ const mockOPFS = () => {
 		writable: true
 	});
 };
-const resetMockOPFS = () => {
-	const root = fileSystemDirectoryHandleFactory("root");
+const resetMockOPFS = (options = {}) => {
+	const root = fileSystemDirectoryHandleFactory("root", {
+		queryPermission: options.queryPermission,
+		requestPermission: options.requestPermission
+	});
 	Object.defineProperty(globalThis.navigator.storage, "getDirectory", {
 		value: () => root,
 		writable: true
 	});
 };
 if (typeof globalThis !== "undefined") mockOPFS();
-
 //#endregion
-export { mockOPFS, resetMockOPFS, storageFactory };
+export { mockOPFS, resetMockOPFS, storageFactory };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "opfs-mock",
-  "version": "2.5.1",
+  "version": "2.6.1",
   "type": "module",
   "description": "Mock all origin private file system APIs for your Jest or Vitest tests",
   "author": "Jure Rotar <hello@jurerotar.com>",
@@ -51,7 +51,7 @@
     "lint": "npx @biomejs/biome lint --fix",
     "format:check": "npx @biomejs/biome format",
     "format": "npx @biomejs/biome format --write",
-    "type-check": "tsc --noEmit",
+    "type-check": "tsgo",
     "test": "npm run test:node && npm run test:happy-dom",
     "test:node": "vitest --environment=node",
     "test:jsdom": "vitest --environment=jsdom",
@@ -60,13 +60,14 @@
     "release": "npm publish --access public"
   },
   "devDependencies": {
-    "@biomejs/biome": "2.3.4",
-    "@vitest/coverage-v8": "4.0.7",
+    "@biomejs/biome": "2.4.14",
+    "@typescript/native-preview": "7.0.0-dev.20260505.1",
+    "@vitest/coverage-v8": "4.1.5",
     "@web-std/file": "3.0.3",
-    "happy-dom": "20.0.10",
-    "jsdom": "27.1.0",
-    "tsdown": "0.16.0",
-    "typescript": "5.9.3",
-    "vitest": "4.0.7"
+    "happy-dom": "20.9.0",
+    "jsdom": "29.1.1",
+    "tsdown": "0.21.10",
+    "typescript": "6.0.3",
+    "vitest": "4.1.5"
   }
 }