feat: add opfs driver

Author: loilo

docs/content/6.drivers/origin-private-file-system.md

@@ -0,0 +1,28 @@
+---
+navigation.title: Origin Private File System
+---
+
+# Origin Private File System
+
+Maps data to the [origin private file system (OPFS)](https://developer.mozilla.org/en-US/docs/Web/API/File_System_API/Origin_private_file_system) using directory structure for nested keys.
+
+This driver implements meta for each key including `mtime` (last modified time), `type` (mime type) and `size` (file size) of the underlying [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File) object.
+
+The origin private file system cannot be watched.
+
+```js
+import { createStorage } from "unstorage";
+import opfsDriver from "unstorage/drivers/opfs";
+
+const storage = createStorage({
+  driver: opfsDriver({ base: "tmp" }),
+});
+```
+
+**Options:**
+
+- `base`: Base directory to isolate operations on this directory
+- `ignore`: Ignore patterns for key listing
+- `readOnly`: Whether to ignore any write operations
+- `noClear`: Whether to disallow clearing the storage
+- `fs`: An alternative file system handle using the [`FileSystemDirectoryHandle`](https://developer.mozilla.org/en-US/docs/Web/API/FileSystemDirectoryHandle) interface (e.g. the user's native file system using `window.showDirectoryPicker()`)

package.json

@@ -79,6 +79,7 @@
     "eslint": "^8.51.0",
     "eslint-config-unjs": "^0.2.1",
     "fake-indexeddb": "^4.0.2",
+    "file-system-access": "^1.0.4",
     "idb-keyval": "^6.2.1",
     "ioredis-mock": "^8.9.0",
     "jiti": "^1.20.0",

pnpm-lock.yaml

@@ -0,0 +1,109 @@
+import { defineDriver } from "./utils";
+import {
+  DRIVER_NAME,
+  exists,
+  getFileObject,
+  joinPaths,
+  normalizePath,
+  readFile,
+  readdirRecursive,
+  remove,
+  removeChildren,
+  unlink,
+  writeFile,
+} from "./utils/opfs-utils";
+
+export interface OPFSStorageOptions {
+  /**
+   * The filesystem root to use
+   * Defaults to the OPFS root at `navigator.storage.getDirectory()`
+   */
+  fs?: FileSystemDirectoryHandle | Promise<FileSystemDirectoryHandle>;
+
+  /**
+   * The base path to use for all operations
+   * Defaults to the root directory (empty string)
+   */
+  base?: string;
+
+  /**
+   * A callback to ignore certain files in getKeys()
+   */
+  ignore?: (path: string) => boolean;
+
+  /**
+   * Whether to ignore any write operations
+   */
+  readOnly?: boolean;
+
+  /**
+   * Whether to disallow clearing the storage
+   */
+  noClear?: boolean;
+}
+
+export default defineDriver<OPFSStorageOptions | undefined>(
+  (opts: OPFSStorageOptions = {}) => {
+    const fsPromise = Promise.resolve(
+      opts.fs ?? navigator.storage.getDirectory()
+    );
+
+    opts.base = normalizePath(opts.base ?? "");
+
+    const resolve = (path: string) => joinPaths(opts.base!, path);
+
+    return {
+      name: DRIVER_NAME,
+      options: opts,
+      async hasItem(key) {
+        return exists(await fsPromise, resolve(key), "file");
+      },
+      async getItem(key) {
+        if (!(await exists(await fsPromise, resolve(key), "file"))) return null;
+        return readFile(await fsPromise, resolve(key), "utf8");
+      },
+      async getItemRaw(key) {
+        if (!(await exists(await fsPromise, resolve(key), "file"))) return null;
+        return readFile(await fsPromise, resolve(key));
+      },
+      async getMeta(key) {
+        const file = await getFileObject(await fsPromise, resolve(key));
+        if (!file) return null;
+
+        return {
+          mtime: new Date(file.lastModified),
+          size: file.size,
+          type: file.type,
+        };
+      },
+      async setItem(key, value) {
+        if (opts.readOnly) return;
+
+        return writeFile(await fsPromise, resolve(key), value);
+      },
+      async setItemRaw(key, value) {
+        if (opts.readOnly) return;
+
+        return writeFile(await fsPromise, resolve(key), value);
+      },
+      async removeItem(key) {
+        if (opts.readOnly) return;
+
+        return unlink(await fsPromise, resolve(key));
+      },
+      async getKeys() {
+        return readdirRecursive(await fsPromise, resolve(""), opts.ignore);
+      },
+      async clear() {
+        if (opts.readOnly || opts.noClear) return;
+
+        if (opts.base!.length === 0) {
+          // We cannot delete an OPFS root, so we just empty it
+          await removeChildren(await fsPromise, resolve(""));
+        } else {
+          await remove(await fsPromise, resolve(""));
+        }
+      },
+    };
+  }
+);