@progressive-development/pd-spa-helper 0.3.35 → 0.3.37

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.35",
+  "version": "0.3.37",
   "main": "dist/src/index.js",
   "module": "dist/src/index.js",
   "exports": {

package/src/index.ts

@@ -32,7 +32,9 @@ export {
   callFunctionImpl,
   uploadFile,
   downloadFile,
+  deleteFile,
   getStorageFileList,
+  getStorageFile,
   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",
     }
   };
   
@@ -121,6 +122,7 @@ const fetchItemsAndFolders = async (
       descriptionName: metadata.customMetadata?.name,
       description: metadata.customMetadata?.comment,
       size: metadata.size,
+      readonly: metadata.customMetadata?.readonly === "true",
       metaData: metadata
     });
     
@@ -175,6 +177,58 @@ const fetchItemsAndFolders = async (
   }
 }
 
+// Funktion, um `StorageDocument` von einer `storageURI` zu erstellen
+export const getFirestorageFile = async (
+  storageName: string, 
+  refKey:string,
+  storageURI: string,
+  includeMetaData = false
+): Promise<StorageDocument> => {
+  try {
+    
+    if (!storageMap || storageMap.size === 0) {
+      throw new Error("No storage is configured");
+    }
+  
+    // get storage  
+    const storageConf = storageMap.get(storageName);
+    if (!storageConf ) {
+      throw new Error(`Invalid storage name: ${storageName}`);
+    }  
+    const storageRef = ref(storageConf.storage, storageURI);
+
+    // Basis-StorageDocument ohne Metadaten
+    const storageDocument: StorageDocument = {
+      fileName: storageRef.name,
+      filePath: storageRef.fullPath,
+      storageName,
+      refKey,
+    };
+
+    // Falls Metadaten angefordert, lade und füge sie hinzu
+    if (includeMetaData) {
+      const metadata = await getMetadata(storageRef);
+
+      return {
+        ...storageDocument,
+        creation: new Date(metadata.timeCreated),
+        documentType: metadata.contentType,
+        creator: metadata.customMetadata?.creator,
+        descriptionName: metadata.customMetadata?.name,
+        description: metadata.customMetadata?.comment,
+        size: metadata.size,
+        readonly: metadata.customMetadata?.readonly === "true",
+        metaData: metadata
+      };
+    }
+
+    return storageDocument; // Rückgabe ohne Metadaten
+  } catch (error) {
+    console.error("Error creating StorageDocument:", error);
+    throw error;
+  }
+};
+
 export const getFirestorageFileList = (
   storageName: string, 
   refKey: string, 
@@ -221,6 +275,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, getFirestorageFile, getFirestorageFileList, initFirestorage, uploadFirestorageFile } from "./firebase/firestorage-client.js";
 import { downloadFileMock, getMockFileList, initStorageMock, uploadStorageFileMock } from "./mock/storage-client.js";
 import { initFirebaseMessaging } from "./firebase/messagingFirebaseClient.js";
 
@@ -204,6 +204,20 @@ export const getStorageFileList = (
   return throwUndefinedProviderError();  
 }
 
+export const getStorageFile = ( 
+  storageName: string, 
+  refKey:string,
+  storageURI: string,
+  includeMetaData: boolean,
+): Promise<unknown> => {  
+  if (provider === "firebase") {
+    return getFirestorageFile(
+      storageName, refKey, storageURI, includeMetaData 
+    );
+  }
+  return throwUndefinedProviderError();  
+}
+
 export const downloadFile = (file: StorageDocument): Promise<unknown> => {  
   if (provider === "firebase") {
     return downloadFileFirestorage(file);
@@ -214,6 +228,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
 }