@progressive-development/pd-spa-helper 0.3.34 → 0.3.36

package/package.json

@@ -3,7 +3,7 @@
   "description": "Webcomponent pd-spa-helper following open-wc recommendations",
   "license": "MIT",
   "author": "pd-spa-helper",
-  "version": "0.3.34",
+  "version": "0.3.36",
   "main": "dist/src/index.js",
   "module": "dist/src/index.js",
   "exports": {

package/src/index.ts

@@ -32,6 +32,7 @@ export {
   callFunctionImpl,
   uploadFile,
   downloadFile,
+  deleteFile,
   getStorageFileList,
   activateCollectionListener,
 } from './service-provider/service-provider-impl.js'

package/src/service-provider/firebase/firestorage-client.ts

@@ -1,5 +1,5 @@
 import { FirebaseApp } from 'firebase/app';
-import { FirebaseStorage, FullMetadata, ListResult, StorageReference, UploadResult, getDownloadURL, getMetadata, getStorage, listAll, ref, uploadString } from "firebase/storage";
+import { FirebaseStorage, FullMetadata, ListResult, StorageReference, UploadResult, deleteObject, getDownloadURL, getMetadata, getStorage, listAll, ref, uploadString } from "firebase/storage";
 
 import { FileStorageConfig, StorageDocument, UploadFile } from '../service-provider-model.js';
 import { getUser } from '../service-provider-impl.js';
@@ -92,6 +92,7 @@ export const uploadFirestorageFile = (file: UploadFile):Promise<UploadResult> =>
       'creator': (getUser() as any)?.displayName,
       'comment': file.description,
       'name': file.descriptionName,
+      'readonly': file.readonly ? "true" : "false",
     }
   };
   
@@ -107,6 +108,7 @@ const fetchItemsAndFolders = async (
 ): Promise<StorageDocument[]> => {
   try {
     const itemRefs: StorageDocument[] = [];
+    const metaPromises: Promise<FullMetadata>[] = [];
     
     // Hole alle Items und Folder direkt unter `usedRef`
     const res: ListResult = await listAll(usedRef);
@@ -120,6 +122,7 @@ const fetchItemsAndFolders = async (
       descriptionName: metadata.customMetadata?.name,
       description: metadata.customMetadata?.comment,
       size: metadata.size,
+      readonly: metadata.customMetadata?.readonly === "true",
       metaData: metadata
     });
     
@@ -131,34 +134,42 @@ const fetchItemsAndFolders = async (
         storageName,
         refKey
       });
-    });
 
-    // 2. Verarbeite alle Ordner direkt unter usedRef, falls includeFolder gesetzt ist
-    const folderPromises = includeFolder ? res.prefixes.map(async (folderRef) => {
-      const folderRes = await listAll(folderRef);
-      folderRes.items.forEach((subItemRef) => {
-        itemRefs.push({
-          fileName: subItemRef.name,
-          filePath: subItemRef.fullPath,
-          storageName,
-          refKey,
-          subFolderName: folderRef.name
-        });
-      });
-    }) : [];
+      // Erzeuge die Metadaten-Promises direkt, wenn `includeMetaData` aktiv ist
+      if (includeMetaData) {
+        metaPromises.push(getMetadata(itemRef));
+      }
+    });
 
-    // 3. Warten bis alle Ordnerinhalte geladen sind
-    await Promise.all(folderPromises);
+     // 2. Verarbeite alle Ordner direkt unter usedRef, falls includeFolder gesetzt ist
+     if (includeFolder) {
+      await Promise.all(
+        res.prefixes.map(async (folderRef) => {
+          const folderRes = await listAll(folderRef);
+          folderRes.items.forEach((subItemRef) => {
+            itemRefs.push({
+              fileName: subItemRef.name,
+              filePath: subItemRef.fullPath,
+              storageName,
+              refKey,
+              subFolderName: folderRef.name
+            });
+
+            // Erzeuge Metadaten-Promises für die Ordner-Inhalte, wenn `includeMetaData` aktiv ist
+            if (includeMetaData) {
+              metaPromises.push(getMetadata(subItemRef));
+            }
+          });
+        })
+      );
+    }
 
-    // 4. Falls includeMetaData gesetzt ist, lade alle Meta-Daten parallel
-    if (includeMetaData) {
-      const metaPromises = itemRefs.map((item) => getMetadata({ fullPath: item.filePath } as StorageReference));
+     // 3. Falls `includeMetaData`, warte auf alle Metadaten und ordne sie den `itemRefs` zu
+     if (includeMetaData) {
       const metaResults = await Promise.all(metaPromises);
-      
-      // Weisen die Metadaten den Items zu
       return itemRefs.map((item, index) => processMetadata(item, metaResults[index]));
     }
-
+    
     return itemRefs;  // Rückgabe ohne Metadaten, falls nicht angefordert
   } catch (error) {
     console.error("Error during file and folder listing:", error);
@@ -212,6 +223,36 @@ export const downloadFileFirestorage = (file: StorageDocument) => {
   return getDownloadURL(usedRef);
 }
 
+/**
+ * Löscht eine Datei in Firebase Storage basierend auf den Informationen im StorageDocument.
+ *
+ * @param deleteFile - Das StorageDocument-Objekt, das die zu löschende Datei beschreibt.
+ * @returns Ein Promise, das erfüllt wird, wenn die Datei gelöscht wurde, oder abgelehnt wird, wenn ein Fehler auftritt.
+ */
+export async function deleteFirestorageDocument(deleteFile: StorageDocument): Promise<void> {
+  if (!deleteFile.filePath) {
+    throw new Error("File path is required to delete a document.");
+  }
+
+  // Hole die Storage-Konfiguration basierend auf dem storageName
+  const storageConf = storageMap.get(deleteFile.storageName);
+  if (!storageConf) {
+    throw new Error(`Invalid storage name: ${deleteFile.storageName}`);
+  }
+
+  // Erstelle eine Referenz zur Datei in Firebase Storage
+  const deleteRef = ref(storageConf.storage, deleteFile.filePath);
+
+  try {
+    // Lösche die Datei
+    await deleteObject(deleteRef);
+    console.log(`File ${deleteFile.fileName} successfully deleted.`);
+  } catch (error) {
+    console.error("Error deleting file:", error);
+    throw error;
+  }
+}
+
 
 /* Firestorage Error List: https://firebase.google.com/docs/storage/web/handle-errors */
 /* 

package/src/service-provider/service-provider-impl.ts

@@ -10,7 +10,7 @@ import { callFunction, initFunctions } from "./firebase/functions-client.js";
 import { getFirebaseCollectionListener, initFirestore } from "./firebase/firestore-client.js";
 import { callFunctionMock, initMockResponse } from "./mock/function-client.js";
 import { ServiceCallController } from "../service-call-controller2.js";
-import { downloadFileFirestorage, getFirestorageFileList, initFirestorage, uploadFirestorageFile } from "./firebase/firestorage-client.js";
+import { deleteFirestorageDocument, downloadFileFirestorage, getFirestorageFileList, initFirestorage, uploadFirestorageFile } from "./firebase/firestorage-client.js";
 import { downloadFileMock, getMockFileList, initStorageMock, uploadStorageFileMock } from "./mock/storage-client.js";
 import { initFirebaseMessaging } from "./firebase/messagingFirebaseClient.js";
 
@@ -214,6 +214,13 @@ export const downloadFile = (file: StorageDocument): Promise<unknown> => {
   return throwUndefinedProviderError();  
 }
 
+export const deleteFile = (file: StorageDocument): Promise<unknown> => {  
+  if (provider === "firebase") {
+    return deleteFirestorageDocument(file);
+  }
+  return throwUndefinedProviderError();  
+}
+
 /* #########################################
  * Remote Database Implementation
  * ######################################### */

package/src/service-provider/service-provider-model.ts

@@ -131,6 +131,7 @@ export interface UploadFile {
   storageName: string
   referenceKey: string
   subFolderName?: string,
+  readonly?: boolean,
 }
 
 export interface StorageMetadata {
@@ -149,6 +150,7 @@ export interface StorageDocument {
   creation?:Date,
   creator?:string,
   size?: number,
+  readonly?: boolean,
   metaData?: StorageMetadata
 }