@signaldb/opfs 2.0.0-beta.6 → 2.0.0-beta.7

package/dist/storage-adapters/generic-fs/src/index.d.ts

@@ -0,0 +1,31 @@
+/**
+ * A driver interface that abstracts low-level filesystem operations.
+ * Implementations can back this with Node.js fs/promises, browser FS APIs, or other storage mechanisms.
+ */
+export interface Driver<T extends {
+    id: I;
+} & Record<string, unknown>, I> {
+    fileNameForId(id: I): Promise<string>;
+    fileNameForIndexKey(key: string): Promise<string>;
+    joinPath(...parts: string[]): Promise<string>;
+    ensureDir(path: string): Promise<void>;
+    fileExists(path: string): Promise<boolean>;
+    readObject(path: string): Promise<T[] | null>;
+    writeObject(path: string, value: T[]): Promise<void>;
+    readIndexObject(path: string): Promise<Record<string, I[]>[] | null>;
+    writeIndexObject(path: string, value: Record<string, I[]>[]): Promise<void>;
+    listFilesRecursive(directoryPath: string): Promise<string[]>;
+    removeEntry(path: string, options?: {
+        recursive?: boolean;
+    }): Promise<void>;
+}
+/**
+ * Creates a storage adapter for managing a SignalDB collection using a generic filesystem-like driver.
+ * Data is sharded into subdirectories based on item identifiers, and indices are maintained as files.
+ * @param driver - The driver that handles low-level file operations.
+ * @param folderName - The root folder path for storing the collection data.
+ * @returns A SignalDB storage adapter for managing data in a filesystem-like storage.
+ */
+export default function createGenericFSAdapter<T extends {
+    id: I;
+} & Record<string, unknown>, I>(driver: Driver<T, I>, folderName: string): import("@signaldb/core").StorageAdapter<T, I>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@signaldb/opfs",
-  "version": "2.0.0-beta.6",
+  "version": "2.0.0-beta.7",
   "description": "",
   "scripts": {
     "build": "rimraf dist && vite build",
@@ -53,9 +53,9 @@
     "dist"
   ],
   "peerDependencies": {
-    "@signaldb/core": "2.0.0-beta.6"
+    "@signaldb/core": "2.0.0-beta.7"
   },
   "dependencies": {
-    "@signaldb/generic-fs": "^2.0.0-beta.6"
+    "@signaldb/generic-fs": "^2.0.0-beta.7"
   }
 }