opfs-mock 1.0.1 → 2.0.0

package/LICENSE.md

@@ -1,21 +1,21 @@
-The MIT License (MIT)
-
-Copyright © 2024 Jure Rotar
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE
+The MIT License (MIT)
+
+Copyright © 2024 Jure Rotar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE

package/README.md

@@ -1,159 +1,159 @@
-# opfs-mock
-
-This is a pure JS 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.
-
-## Installation
-
-```shell
-npm install -save-dev opfs-mock
-```
-
-## Usage
-
-It replicates the behavior of origin private file system, except data is not persisted to disk.
-
-The easiest way to use it is to import `opfs-mock`, which will polyfill OPFS API to global scope.
-
-```ts
-import "opfs-mock";
-```
-
-Alternatively, you can explicitly import `storageFactory`:
-
-```ts
-import { storageFactory } from "opfs-mock";
-
-test('Your test', async () => {
-  const storage = await storageFactory();
-  const root = await storage.getDirectory();
-  const directoryHandle = await root.getFileHandle('test-file.txt', { create: true });
-  // rest of your test
-});
-```
-
-`storageFactory` has predefined `quota` and `estimate` values set to `0`, which is fine if you're not using these properties.
-In case you need specific values, you can pass both as arguments to `storageFactory`.
-
-```ts
-import { storageFactory } from "opfs-mock";
-
-test('Your test', async () => {
-  const storage = await storageFactory({ quota: 1_000_000, estimate: 1_000 });
-  const root = await storage.getDirectory();
-  const directoryHandle = await root.getFileHandle('test-file.txt', { create: true });
-  // rest of your test
-});
-```
-
-### Vitest
-
-To use `opfs-mock` in a single Vitest test suite, require `opfs-mock` at the beginning of the test file, as described above.
-
-To use it on all Vitest tests without having to include it in each file, add the auto setup script to the `test.setupFiles` in your Vite config:
-
-```ts
-// vite.config.ts
-
-import { defineConfig as defineViteConfig, mergeConfig } from 'vite';
-import { defineConfig as defineVitestConfig } from 'vitest/config';
-
-const viteConfig = defineViteConfig({
-  ...
-});
-
-const vitestConfig = defineVitestConfig({
-  test: {
-    setupFiles: ['opfs-mock'],
-  },
-});
-
-export default mergeConfig(viteConfig, vitestConfig);
-```
-
-Alternatively you can create a new setup file which then imports this module.
-
-```ts
-// vitest-setup.ts
-
-import "opfs-mock";
-```
-
-Add that file to your `test.setupFiles` array:
-
-```ts
-// vite.config.ts
-
-import { defineConfig as defineViteConfig, mergeConfig } from 'vite';
-import { defineConfig as defineVitestConfig } from 'vitest/config';
-
-const viteConfig = defineViteConfig({
-  ...
-});
-
-const vitestConfig = defineVitestConfig({
-  test: {
-    setupFiles: ['vitest-setup.ts'],
-  },
-});
-
-export default mergeConfig(viteConfig, vitestConfig);
-```
-
-
-### Jest
-
-To use `opfs-mock` in a single Jest test suite, require `opfs-mock` at the beginning of the test file, as described above.
-
-To use it on all Jest tests without having to include it in each file, add the auto setup script to the `setupFiles` in your Jest config:
-
-```ts
-// jest.config.js
-
-{
-  ...
-  "setupFiles": [
-    "opfs-mock"
-  ]
-}
-```
-
-Alternatively you can create a new setup file which then imports this module.
-
-```ts
-// jest-setup.ts
-
-import "opfs-mock";
-```
-
-Add that file to your `setupFiles` array:
-
-```ts
-// jest.config.js
-
-{
-  ...
-  "setupFiles": [
-    "jest-setup"
-  ]
-}
-```
-
-## Wiping/resetting the OPFS mock for a fresh state
-
-If you are keeping your tests completely isolated you might want to "reset" the state of the mocked OPFS. You can do this by using `resetMockOPFS` function, which creates a completely new instance of the mock.
-
-```ts
-import { resetMockOPFS } from 'opfs-mock';
-
-beforeEach(() => {
-  resetMockOPFS();
-});
-
-test('First isolated test', async () => {
-  // rest of your test
-});
-
-test('Second isolated test', async () => {
-  // rest of your test
-});
-```
+# opfs-mock
+
+This is a pure JS 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.
+
+## Installation
+
+```shell
+npm install -save-dev opfs-mock
+```
+
+## Usage
+
+It replicates the behavior of origin private file system, except data is not persisted to disk.
+
+The easiest way to use it is to import `opfs-mock`, which will polyfill OPFS API to global scope.
+
+```ts
+import "opfs-mock";
+```
+
+Alternatively, you can explicitly import `storageFactory`:
+
+```ts
+import { storageFactory } from "opfs-mock";
+
+test('Your test', async () => {
+  const storage = await storageFactory();
+  const root = await storage.getDirectory();
+  const directoryHandle = await root.getFileHandle('test-file.txt', { create: true });
+  // rest of your test
+});
+```
+
+`storageFactory` has predefined `quota` and `estimate` values set to `0`, which is fine if you're not using these properties.
+In case you need specific values, you can pass both as arguments to `storageFactory`.
+
+```ts
+import { storageFactory } from "opfs-mock";
+
+test('Your test', async () => {
+  const storage = await storageFactory({ quota: 1_000_000, estimate: 1_000 });
+  const root = await storage.getDirectory();
+  const directoryHandle = await root.getFileHandle('test-file.txt', { create: true });
+  // rest of your test
+});
+```
+
+### Vitest
+
+To use `opfs-mock` in a single Vitest test suite, require `opfs-mock` at the beginning of the test file, as described above.
+
+To use it on all Vitest tests without having to include it in each file, add the auto setup script to the `test.setupFiles` in your Vite config:
+
+```ts
+// vite.config.ts
+
+import { defineConfig as defineViteConfig, mergeConfig } from 'vite';
+import { defineConfig as defineVitestConfig } from 'vitest/config';
+
+const viteConfig = defineViteConfig({
+  ...
+});
+
+const vitestConfig = defineVitestConfig({
+  test: {
+    setupFiles: ['opfs-mock'],
+  },
+});
+
+export default mergeConfig(viteConfig, vitestConfig);
+```
+
+Alternatively you can create a new setup file which then imports this module.
+
+```ts
+// vitest-setup.ts
+
+import "opfs-mock";
+```
+
+Add that file to your `test.setupFiles` array:
+
+```ts
+// vite.config.ts
+
+import { defineConfig as defineViteConfig, mergeConfig } from 'vite';
+import { defineConfig as defineVitestConfig } from 'vitest/config';
+
+const viteConfig = defineViteConfig({
+  ...
+});
+
+const vitestConfig = defineVitestConfig({
+  test: {
+    setupFiles: ['vitest-setup.ts'],
+  },
+});
+
+export default mergeConfig(viteConfig, vitestConfig);
+```
+
+
+### Jest
+
+To use `opfs-mock` in a single Jest test suite, require `opfs-mock` at the beginning of the test file, as described above.
+
+To use it on all Jest tests without having to include it in each file, add the auto setup script to the `setupFiles` in your Jest config:
+
+```ts
+// jest.config.js
+
+{
+  ...
+  "setupFiles": [
+    "opfs-mock"
+  ]
+}
+```
+
+Alternatively you can create a new setup file which then imports this module.
+
+```ts
+// jest-setup.ts
+
+import "opfs-mock";
+```
+
+Add that file to your `setupFiles` array:
+
+```ts
+// jest.config.js
+
+{
+  ...
+  "setupFiles": [
+    "jest-setup"
+  ]
+}
+```
+
+## Wiping/resetting the OPFS mock for a fresh state
+
+If you are keeping your tests completely isolated you might want to "reset" the state of the mocked OPFS. You can do this by using `resetMockOPFS` function, which creates a completely new instance of the mock.
+
+```ts
+import { resetMockOPFS } from 'opfs-mock';
+
+beforeEach(() => {
+  resetMockOPFS();
+});
+
+test('First isolated test', async () => {
+  // rest of your test
+});
+
+test('Second isolated test', async () => {
+  // rest of your test
+});
+```

package/dist/index.d.ts

@@ -1,3 +1,5 @@
-export declare const storageFactory: ({ usage, quota }?: StorageEstimate) => StorageManager;
-export declare const mockOPFS: () => void;
-export declare const resetMockOPFS: () => void;
+declare const storageFactory: ({ usage, quota }?: StorageEstimate) => StorageManager;
+declare const mockOPFS: () => void;
+declare const resetMockOPFS: () => void;
+
+export { mockOPFS, resetMockOPFS, storageFactory };

package/dist/index.js

@@ -1,128 +1,262 @@
-const g = (o, n) => ({
-  kind: "file",
-  name: o,
-  isSameEntry: async (t) => t.name === o && t.kind === "file",
-  getFile: async () => new File([n.content], o, {
-    type: "application/json"
-  }),
-  // @ts-ignore TODO: Implement options, add missing properties
-  createWritable: async (t) => new WritableStream({
-    write: (e) => {
-      const r = new TextDecoder().decode(e);
-      n.content += r;
-    },
-    close: () => {
-    },
-    abort: (e) => {
-    }
-  }).getWriter(),
-  createSyncAccessHandle: async () => ({
-    getSize: () => n.content.length,
-    read: (t, { at: s = 0 } = {}) => {
-      const e = new TextEncoder().encode(n.content), r = Math.min(t.length, e.length - s);
-      return t.set(e.subarray(s, s + r)), r;
-    },
-    write: (t, { at: s = 0 } = {}) => {
-      const e = new TextDecoder().decode(t), r = n.content.length;
-      return s < r ? n.content = n.content.slice(0, s) + e + n.content.slice(s + e.length) : n.content += e, t.byteLength;
-    },
-    // Flush is a no-op in memory
-    flush: async () => {
+// src/opfs.ts
+var fileSystemFileHandleFactory = (name, fileData) => {
+  return {
+    kind: "file",
+    name,
+    isSameEntry: async (other) => {
+      return other.name === name && other.kind === "file";
     },
-    // Close is a no-op in memory
-    close: async () => {
+    getFile: async () => new File([fileData.content], name),
+    createWritable: async (_options) => {
+      let newContent = "";
+      let cursorPosition = 0;
+      let aborted = false;
+      let closed = false;
+      const locked = false;
+      const writableStream = new WritableStream({
+        write: async (chunk) => {
+          if (aborted) {
+            throw new DOMException("Write operation aborted", "AbortError");
+          }
+          if (closed) {
+            throw new TypeError("Cannot write to a CLOSED writable stream");
+          }
+          if (chunk === void 0) {
+            throw new TypeError("Cannot write undefined data to the stream");
+          }
+          let chunkText;
+          if (typeof chunk === "string") {
+            chunkText = chunk;
+          } else if (chunk instanceof Blob) {
+            chunkText = await chunk.text();
+          } else if (ArrayBuffer.isView(chunk)) {
+            chunkText = new TextDecoder().decode(new Uint8Array(chunk.buffer));
+          } else if (typeof chunk === "object" && "data" in chunk) {
+            if (chunk.position !== void 0 && (typeof chunk.position !== "number" || chunk.position < 0)) {
+              throw new TypeError("Invalid position value in write parameters");
+            }
+            if (chunk.size !== void 0 && (typeof chunk.size !== "number" || chunk.size < 0)) {
+              throw new TypeError("Invalid size value in write parameters");
+            }
+            if (chunk.position !== void 0 && chunk.position !== null) {
+              cursorPosition = chunk.position;
+            }
+            if (chunk.data) {
+              if (typeof chunk.data === "string") {
+                chunkText = chunk.data;
+              } else if (chunk.data instanceof Blob) {
+                chunkText = await chunk.data.text();
+              } else {
+                chunkText = new TextDecoder().decode(new Uint8Array(chunk.data instanceof ArrayBuffer ? chunk.data : chunk.data.buffer));
+              }
+            } else {
+              chunkText = "";
+            }
+          } else {
+            throw new TypeError("Invalid data type written to the file. Data must be of type FileSystemWriteChunkType.");
+          }
+          newContent = newContent.slice(0, cursorPosition) + chunkText + newContent.slice(cursorPosition + chunkText.length);
+          cursorPosition += chunkText.length;
+        },
+        close: async () => {
+          if (aborted) {
+            throw new DOMException("Stream has been aborted", "AbortError");
+          }
+          closed = true;
+          fileData.content = newContent;
+        },
+        abort: (reason) => {
+          if (aborted) {
+            return Promise.reject(new TypeError("Cannot abort an already aborted writable stream"));
+          }
+          if (locked) {
+            return Promise.reject(new TypeError("Cannot abort a locked writable stream"));
+          }
+          aborted = true;
+          return Promise.resolve(reason);
+        }
+      });
+      const writer = writableStream.getWriter();
+      return Object.assign(writer, {
+        locked: false,
+        truncate: async (size) => {
+          if (size < 0) {
+            throw new DOMException("Invalid truncate size", "IndexSizeError");
+          }
+          if (size < newContent.length) {
+            newContent = newContent.slice(0, size);
+          } else {
+            newContent = newContent.padEnd(size, "\0");
+          }
+          cursorPosition = Math.min(cursorPosition, size);
+        },
+        getWriter: () => writer,
+        seek: async (position) => {
+          if (position < 0 || position > newContent.length) {
+            throw new DOMException("Invalid seek position", "IndexSizeError");
+          }
+          cursorPosition = position;
+        }
+      });
     },
-    truncate: async (t) => {
-      n.content = n.content.slice(0, t);
-    }
-  })
-}), y = (o) => {
-  const n = /* @__PURE__ */ new Map(), t = /* @__PURE__ */ new Map(), s = () => new Map([...n, ...t]);
+    createSyncAccessHandle: async () => ({
+      getSize: () => fileData.content.length,
+      read: (buffer, { at = 0 } = {}) => {
+        const text = new TextEncoder().encode(fileData.content);
+        const bytesRead = Math.min(buffer.length, text.length - at);
+        buffer.set(text.subarray(at, at + bytesRead));
+        return bytesRead;
+      },
+      write: (data, { at = 0 } = {}) => {
+        const newContent = new TextDecoder().decode(data);
+        const originalLength = fileData.content.length;
+        if (at < originalLength) {
+          fileData.content = fileData.content.slice(0, at) + newContent + fileData.content.slice(at + newContent.length);
+        } else {
+          fileData.content += newContent;
+        }
+        return data.byteLength;
+      },
+      // Flush is a no-op in memory
+      flush: async () => {
+      },
+      // Close is a no-op in memory
+      close: async () => {
+      },
+      truncate: async (size) => {
+        fileData.content = fileData.content.slice(0, size);
+      }
+    })
+  };
+};
+var fileSystemDirectoryHandleFactory = (name) => {
+  const files = /* @__PURE__ */ new Map();
+  const directories = /* @__PURE__ */ new Map();
+  const getJoinedMaps = () => {
+    return new Map([...files, ...directories]);
+  };
   return {
     kind: "directory",
-    name: o,
-    isSameEntry: async (e) => e.name === o && e.kind === "directory",
-    getFileHandle: async (e, r) => {
-      !n.has(e) && (r != null && r.create) && n.set(e, g(e, { content: "" }));
-      const c = n.get(e);
-      if (!c)
-        throw new Error(`File not found: ${e}`);
-      return c;
+    name,
+    isSameEntry: async (other) => {
+      return other.name === name && other.kind === "directory";
+    },
+    getFileHandle: async (fileName, options) => {
+      if (!files.has(fileName) && options?.create) {
+        files.set(fileName, fileSystemFileHandleFactory(fileName, { content: "" }));
+      }
+      const fileHandle = files.get(fileName);
+      if (!fileHandle) {
+        throw new Error(`File not found: ${fileName}`);
+      }
+      return fileHandle;
     },
-    getDirectoryHandle: async (e, r) => {
-      !t.has(e) && (r != null && r.create) && t.set(e, y(e));
-      const c = t.get(e);
-      if (!c)
-        throw new Error(`Directory not found: ${e}`);
-      return c;
+    getDirectoryHandle: async (dirName, options) => {
+      if (!directories.has(dirName) && options?.create) {
+        directories.set(dirName, fileSystemDirectoryHandleFactory(dirName));
+      }
+      const directoryHandle = directories.get(dirName);
+      if (!directoryHandle) {
+        throw new Error(`Directory not found: ${dirName}`);
+      }
+      return directoryHandle;
     },
-    removeEntry: async (e) => {
-      if (n.has(e))
-        n.delete(e);
-      else if (t.has(e))
-        t.delete(e);
-      else
-        throw new Error(`Entry not found: ${e}`);
+    removeEntry: async (entryName) => {
+      if (files.has(entryName)) {
+        files.delete(entryName);
+      } else if (directories.has(entryName)) {
+        directories.delete(entryName);
+      } else {
+        throw new Error(`Entry not found: ${entryName}`);
+      }
     },
     entries: async function* () {
-      yield* s().entries();
+      const joinedMaps = getJoinedMaps();
+      yield* joinedMaps.entries();
     },
     keys: async function* () {
-      yield* s().keys();
+      const joinedMaps = getJoinedMaps();
+      yield* joinedMaps.keys();
     },
     values: async function* () {
-      yield* s().values();
+      const joinedMaps = getJoinedMaps();
+      yield* joinedMaps.values();
     },
-    resolve: async (e) => {
-      const r = async (c, a, l = []) => {
-        if (await c.isSameEntry(a))
-          return l;
-        for await (const [d, i] of c.entries())
-          if (i.kind === "directory") {
-            const u = await r(i, a, [...l, d]);
-            if (u)
-              return u;
-          } else if (i.kind === "file" && await i.isSameEntry(a))
-            return [...l, d];
+    resolve: async (possibleDescendant) => {
+      const traverseDirectory = async (directory, target, path = []) => {
+        if (await directory.isSameEntry(target)) {
+          return path;
+        }
+        for await (const [name2, handle] of directory.entries()) {
+          if (handle.kind === "directory") {
+            const subDirectory = handle;
+            const result = await traverseDirectory(subDirectory, target, [...path, name2]);
+            if (result) {
+              return result;
+            }
+          } else if (handle.kind === "file") {
+            if (await handle.isSameEntry(target)) {
+              return [...path, name2];
+            }
+          }
+        }
         return null;
       };
-      return r(void 0, e);
+      return traverseDirectory(void 0, possibleDescendant);
     }
   };
-}, w = ({ usage: o = 0, quota: n = 0 } = {}) => {
-  const t = y("root");
+};
+
+// src/index.ts
+var storageFactory = ({ usage = 0, quota = 0 } = {}) => {
+  const root = fileSystemDirectoryHandleFactory("root");
   return {
-    estimate: async () => ({
-      usage: o,
-      quota: n
-    }),
-    getDirectory: async () => t,
-    persist: async () => !0,
-    persisted: async () => !0
+    estimate: async () => {
+      return {
+        usage,
+        quota
+      };
+    },
+    getDirectory: async () => {
+      return root;
+    },
+    persist: async () => {
+      return true;
+    },
+    persisted: async () => {
+      return true;
+    }
   };
-}, b = () => {
-  if ("navigator" in globalThis || Object.defineProperty(globalThis, "navigator", {
-    value: {},
-    writable: !0
-  }), !globalThis.navigator.storage) {
-    const { getDirectory: o } = w();
+};
+var mockOPFS = () => {
+  if (!("navigator" in globalThis)) {
+    Object.defineProperty(globalThis, "navigator", {
+      value: {},
+      writable: true
+    });
+  }
+  if (!globalThis.navigator.storage) {
+    const { getDirectory } = storageFactory();
     Object.defineProperty(globalThis.navigator, "storage", {
       value: {
-        getDirectory: o
+        getDirectory
       },
-      writable: !0
+      writable: true
     });
   }
-}, h = () => {
-  const o = y("root");
+};
+var resetMockOPFS = () => {
+  const root = fileSystemDirectoryHandleFactory("root");
   Object.defineProperty(globalThis.navigator.storage, "getDirectory", {
-    value: () => o,
-    writable: !0
+    value: () => root,
+    writable: true
   });
 };
-typeof globalThis < "u" && b();
+if (typeof globalThis !== "undefined") {
+  mockOPFS();
+}
 export {
-  b as mockOPFS,
-  h as resetMockOPFS,
-  w as storageFactory
+  mockOPFS,
+  resetMockOPFS,
+  storageFactory
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "opfs-mock",
-  "version": "1.0.1",
+  "version": "2.0.0",
   "type": "module",
   "description": "Mock all origin private file system APIs for your Jest or Vitest tests",
   "author": "Jure Rotar <hello@jurerotar.com>",
@@ -23,25 +23,25 @@
       "import": "./dist/index.js"
     }
   },
+  "main": "dist/index.js",
   "module": "dist/index.js",
   "files": ["dist"],
   "scripts": {
-    "dev": "vite",
-    "build": "vite build",
+    "dev": "tsup --watch",
+    "build": "tsup",
     "lint:check": "npx @biomejs/biome lint",
     "lint": "npx @biomejs/biome lint --fix",
     "format:check": "npx @biomejs/biome format",
     "format": "npx @biomejs/biome format --write",
     "type-check": "tsc --noEmit",
     "test": "vitest",
-    "build:types": "tsc --emitDeclarationOnly",
-    "prepublishOnly": "npm run build && npm run build:types",
+    "prepublishOnly": "npm run build",
     "release": "npm publish --access public"
   },
   "devDependencies": {
     "@biomejs/biome": "1.9.4",
+    "tsup": "8.3.6",
     "typescript": "5.7.3",
-    "vite": "6.0.7",
-    "vitest": "2.1.8"
+    "vitest": "3.0.6"
   }
 }

package/dist/opfs.d.ts

@@ -1 +0,0 @@
-export declare const fileSystemDirectoryHandleFactory: (name: string) => FileSystemDirectoryHandle;