opfs-mock 1.0.0 → 1.0.1

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

@@ -18,12 +18,27 @@ The easiest way to use it is to import `opfs-mock`, which will polyfill OPFS API
 import "opfs-mock";
 ```
 
-Alternatively, you can explicitly import `storage`:
+Alternatively, you can explicitly import `storageFactory`:
 
 ```ts
-import { storage } from "opfs-mock";
+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
@@ -37,14 +52,22 @@ To use `opfs-mock` in a single Vitest test suite, require `opfs-mock` at the beg
 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.js
+// 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.
@@ -60,13 +83,20 @@ Add that file to your `test.setupFiles` array:
 ```ts
 // vite.config.ts
 
-import { defineConfig } from 'vite'
+import { defineConfig as defineViteConfig, mergeConfig } from 'vite';
+import { defineConfig as defineVitestConfig } from 'vitest/config';
 
-export default defineConfig({
+const viteConfig = defineViteConfig({
+  ...
+});
+
+const vitestConfig = defineVitestConfig({
   test: {
     setupFiles: ['vitest-setup.ts'],
-  }
+  },
 });
+
+export default mergeConfig(viteConfig, vitestConfig);
 ```
 
 

package/dist/index.d.ts

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

package/dist/index.js

@@ -89,14 +89,14 @@ const g = (o, n) => ({
       return r(void 0, e);
     }
   };
-}, w = () => {
-  const o = y("root");
+}, w = ({ usage: o = 0, quota: n = 0 } = {}) => {
+  const t = y("root");
   return {
     estimate: async () => ({
-      usage: 0,
-      quota: 0
+      usage: o,
+      quota: n
     }),
-    getDirectory: async () => o,
+    getDirectory: async () => t,
     persist: async () => !0,
     persisted: async () => !0
   };
@@ -124,5 +124,5 @@ typeof globalThis < "u" && b();
 export {
   b as mockOPFS,
   h as resetMockOPFS,
-  w as storage
+  w as storageFactory
 };

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "opfs-mock",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "type": "module",
   "description": "Mock all origin private file system APIs for your Jest or Vitest tests",
-  "author": "jurerotar <hello@jurerotar.com>",
+  "author": "Jure Rotar <hello@jurerotar.com>",
   "license": "MIT",
   "homepage": "https://github.com/jurerotar/opfs-mock#README",
   "repository": {
@@ -39,9 +39,9 @@
     "release": "npm publish --access public"
   },
   "devDependencies": {
-    "@biomejs/biome": "1.9.3",
-    "typescript": "5.6.2",
-    "vite": "5.4.8",
-    "vitest": "2.1.2"
+    "@biomejs/biome": "1.9.4",
+    "typescript": "5.7.3",
+    "vite": "6.0.7",
+    "vitest": "2.1.8"
   }
 }