Add make, remove and get uri endpoints to local storage

Author: joshua-journey-apps

packages/attachments/src/AttachmentQueue.ts

@@ -158,10 +158,6 @@ export class AttachmentQueue {
     this.watchActiveAbortController?.abort();
   }
 
-  getLocalUri(filePath: string): string {
-    return `${this.localStorage.getUserStorageDirectory()}/${filePath}`;
-  }
-
   async saveFile({
     data,
     fileExtension,
@@ -177,7 +173,7 @@ export class AttachmentQueue {
   }): Promise<AttachmentRecord> {
     const resolvedId = id ?? (await this.context.db.get<{ id: string }>('SELECT uuid() as id')).id;
     const filename = `${resolvedId}.${fileExtension}`;
-    const localUri = this.getLocalUri(filename);
+    const localUri = this.localStorage.getLocalUri(filename);
     const size = await this.localStorage.saveFile(localUri, data);
 
     const attachment: AttachmentRecord = {
@@ -214,7 +210,7 @@ export class AttachmentQueue {
         continue;
       }
 
-      const newLocalUri = this.getLocalUri(attachment.filename);
+      const newLocalUri = this.localStorage.getLocalUri(attachment.filename);
       const newExists = await this.localStorage.fileExists(newLocalUri);
       if (newExists) {
         // The file exists but the localUri is broken, lets update it.

packages/attachments/src/LocalStorageAdapter.ts

@@ -8,7 +8,7 @@ export interface LocalStorageAdapter {
    * Saves buffer data to a local file.
    * @param filePath Path where the file will be stored
    * @param data Data string to store
-   * @returns number of bytes written
+   * @returns Number of bytes written
    */
   saveFile(filePath: string, data: ArrayBuffer | Blob | string): Promise<number>;
 
@@ -28,9 +28,24 @@ export interface LocalStorageAdapter {
   /**
    * Checks if a file exists at the given path.
    * @param filePath Path where the file is stored
+   * @returns True if the file exists, false otherwise
    */
   fileExists(filePath: string): Promise<boolean>;
 
+  /**
+   * Creates a directory at the specified path.
+   * @param path The full path to the directory
+   * @throws PowerSyncAttachmentError if creation fails
+   */
+  makeDir(path: string): Promise<void>;
+
+  /**
+   * Removes a directory at the specified path.
+   * @param path The full path to the directory
+   * @throws PowerSyncAttachmentError if removal fails
+   */
+  rmDir(path: string): Promise<void>;
+
   /**
    * Initializes the storage adapter (e.g., creating necessary directories).
    */
@@ -42,8 +57,9 @@ export interface LocalStorageAdapter {
   clear(): Promise<void>;
 
   /**
-   * Get the base directory used by the storage adapter.
-   * @returns The base directory path as a string.
+   * Returns the file path of the provided filename in the user storage directory.
+   * @param filename The filename to get the path for
+   * @returns The full file path
    */
-  getUserStorageDirectory(): string;
-}
+  getLocalUri(filename: string): string;
+}

packages/attachments/src/StorageService.ts

@@ -92,9 +92,8 @@ export class StorageService {
         reader.onerror = reject;
         reader.readAsDataURL(fileBlob);
       });
-      const userDir = this.localStorage.getUserStorageDirectory();
-      const localUri = `${userDir}${attachment.id}`;
 
+      const localUri = this.localStorage.getLocalUri(attachment.filename);
       await this.localStorage.saveFile(localUri, base64Data);
 
       return {

packages/attachments/src/storageAdapters/IndexDBFileSystemAdapter.ts

@@ -1,4 +1,4 @@
-import { EncodingType, LocalStorageAdapter } from 'src/LocalStorageAdapter.js';
+import { EncodingType, LocalStorageAdapter } from '../LocalStorageAdapter.js';
 
 export class IndexDBFileSystemStorageAdapter implements LocalStorageAdapter {
   private dbPromise: Promise<IDBDatabase>;
@@ -14,6 +14,21 @@ export class IndexDBFileSystemStorageAdapter implements LocalStorageAdapter {
     });
   }
 
+  clear(): Promise<void> {
+    return new Promise(async (resolve, reject) => {
+      const db = await this.dbPromise;
+      const tx = db.transaction('files', 'readwrite');
+      const store = tx.objectStore('files');
+      const req = store.clear();
+      req.onsuccess = () => resolve();
+      req.onerror = () => reject(req.error);
+    });
+  }
+
+  getLocalUri(filename: string): string {
+    return `indexeddb://PowerSyncFiles/files/${filename}`;
+  }
+
   private async getStore(mode: IDBTransactionMode = 'readonly'): Promise<IDBObjectStore> {
     const db = await this.dbPromise;
     const tx = db.transaction('files', mode);
@@ -54,24 +69,26 @@ export class IndexDBFileSystemStorageAdapter implements LocalStorageAdapter {
           return;
         }
 
-        if (options?.encoding === EncodingType.Base64) {
-          const base64String = req.result.replace(/^data:\w+;base64,/, '');
-          const binaryString = atob(base64String);
-          const len = binaryString.length;
-          const bytes = new Uint8Array(len);
-          for (let i = 0; i < len; i++) {
-            bytes[i] = binaryString.charCodeAt(i);
-          }
-          resolve(bytes.buffer);
-        }
+        // if (options?.encoding === EncodingType.Base64) {
+        // }
 
         if (options?.encoding === EncodingType.UTF8) {
           const encoder = new TextEncoder();
           const arrayBuffer = encoder.encode(req.result).buffer;
           resolve(arrayBuffer);
         }
 
-        reject(new Error('Unsupported encoding'));
+        // Default base64 encoding
+        const base64String = req.result.replace(/^data:\w+;base64,/, '');
+        const binaryString = atob(base64String);
+        const len = binaryString.length;
+        const bytes = new Uint8Array(len);
+        for (let i = 0; i < len; i++) {
+          bytes[i] = binaryString.charCodeAt(i);
+        }
+        resolve(bytes.buffer);
+
+        // reject(new Error('Unsupported encoding'));
       };
       req.onerror = () => reject(req.error);
     });
@@ -95,19 +112,11 @@ export class IndexDBFileSystemStorageAdapter implements LocalStorageAdapter {
     });
   }
 
-  getUserStorageDirectory(): string {
-    // Not applicable for web, but return a logical root
-    return 'indexeddb://PowerSyncFiles/files';
+  async makeDir(path: string): Promise<void> {
+    // No-op for IndexedDB
   }
 
-  clear(): Promise<void> {
-    return new Promise(async (resolve, reject) => {
-      const db = await this.dbPromise;
-      const tx = db.transaction('files', 'readwrite');
-      const store = tx.objectStore('files');
-      const req = store.clear();
-      req.onsuccess = () => resolve();
-      req.onerror = () => reject(req.error);
-    });
+  async rmDir(path: string): Promise<void> {
+    // No-op for IndexedDB
   }
 }

packages/attachments/src/storageAdapters/NodeFileSystemAdapter.ts

@@ -1,8 +1,24 @@
 import { promises as fs } from 'fs';
 import * as path from 'path';
-import { EncodingType, LocalStorageAdapter } from 'src/LocalStorageAdapter.js';
+import { EncodingType, LocalStorageAdapter } from '../LocalStorageAdapter.js';
 
 export class NodeFileSystemAdapter implements LocalStorageAdapter {
+  async initialize(): Promise<void> {
+    // const dir = this.getUserStorageDirectory();
+    const dir = path.resolve('./user_data');
+    await fs.mkdir(dir, { recursive: true });
+  }
+
+  async clear(): Promise<void> {
+    // const dir = this.getUserStorageDirectory();
+    const dir = path.resolve('./user_data');
+    await fs.rmdir(dir, { recursive: true });
+  }
+
+  getLocalUri(filename: string): string {
+    return path.join(path.resolve('./user_data'), filename);
+  }
+
   async uploadFile(filePath: string, data: ArrayBuffer, options?: { encoding: EncodingType }): Promise<void> {
     const buffer = Buffer.from(data);
     await fs.writeFile(filePath, buffer, {
@@ -57,15 +73,7 @@ export class NodeFileSystemAdapter implements LocalStorageAdapter {
     await fs.mkdir(path, { recursive: true });
   }
 
-  async rmDir(filePath: string): Promise<void> {
-    await fs.rmdir(filePath, { recursive: true });
-  }
-
-  async copyFile(sourcePath: string, targetPath: string): Promise<void> {
-    await fs.copyFile(sourcePath, targetPath);
-  }
-
-  getUserStorageDirectory(): string {
-    return path.resolve('./user_data') + path.sep;
+  async rmDir(path: string): Promise<void> {
+    await fs.rmdir(path, { recursive: true });
   }
 }