@progressive-development/pd-spa-helper 0.1.170 → 0.1.172

package/package.json

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

package/src/service-provider/firebase/auth.ts

@@ -34,6 +34,12 @@ export const isAuthenticated = (): boolean => {
   return authCheck;
 };
 
+export const getAuthUser = (): unknown => {
+  if (!auth) {
+    throw new Error("isAuthenticated: Auth was not initialized");
+  }    
+  return auth.currentUser;
+};
 
 export const authStateChanged = (callback: Function) => {  
   if (!auth) {

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

@@ -1,7 +1,8 @@
 import { FirebaseApp } from 'firebase/app';
-import { FirebaseStorage, StorageReference, UploadResult, getStorage, listAll, ref, uploadString } from "firebase/storage";
+import { FirebaseStorage, FullMetadata, StorageReference, UploadResult, getMetadata, getStorage, listAll, ref, uploadString } from "firebase/storage";
 
 import { FileStorageConfig, StorageDocument, UploadFile } from '../service-provider-model.js';
+import { getUser } from '../service-provider-impl.js';
 
 const DEFAULT_STORAGE = "default_storage";
 
@@ -79,21 +80,30 @@ export const uploadFirestorageFile = (file: UploadFile):Promise<UploadResult> =>
   // create file reference and upload
   const fileRef = ref(uploadRefConf.storageRef, subFolderName ? `${subFolderName}/${fileName}` : fileName);
 
-  // Meta data with description
+  // default usefull metadata: contentType, size, timeCreated, updated
+
+  // additional custom metadata
   const metadata = {
     customMetadata: {
+      'creator': (getUser() as any)?.displayName,
       'comment': file.description,
+      'name': file.descriptionName,
     }
   };
   
   return uploadString(fileRef, file.base64DataURL, 'data_url', metadata);
 };
 
-export const getFirestorageFileList = (storageName: string, refKey: string):Promise<StorageDocument[]> => {  
+export const getFirestorageFileList = (
+  storageName: string, 
+  refKey: string, 
+  subFolder?: string,
+  includeMetaData?: boolean
+):Promise<StorageDocument[]> => {  
 
   if (!storageMap || storageMap.size === 0) {
     throw new Error("No storage is configured");
-  }  
+  }
 
   // get storage  
   const storageConf = storageMap.get(storageName);
@@ -106,32 +116,44 @@ export const getFirestorageFileList = (storageName: string, refKey: string):Prom
 
   // get refrence
   const storageRef = storageConf.references.filter(refIt => refIt.key === refKey)[0];
-      
+  if (!storageRef) {
+    throw new Error(`No reference available for storage: ${storageName || DEFAULT_STORAGE} and ref: ${refKey}`);
+  }
+
+  const usedRef = subFolder ? ref(storageRef.storageRef, subFolder) : storageRef.storageRef;  
   const itemRefs: StorageDocument[] = [];
-  return listAll(storageRef.storageRef)
+  return listAll(usedRef)
     .then((res) => {
-      res.items.forEach((itemRef) => {
-        // All the items under listRef.
+      
+      const metaPromises:Promise<FullMetadata>[] = [];
+      res.items.forEach((itemRef) => {        
+        // All the items under listRef        .
         itemRefs.push({
           fileName: itemRef.name,
           filePath: itemRef.fullPath,
-          documentType: "ToDo",
-          // description: "ToDo Some Description",
-          // creator: "ToDo",
-          // creation: new Date(),
         });
+
+        // MetaData for each item with own promise
+        if (includeMetaData) {
+          metaPromises.push(getMetadata(itemRef));          
+        }
       });
 
-      // MetaData for each item with own promise
-      /*
-      // Get metadata properties
-      getMetadata(forestRef)
-        .then((metadata) => {
-          // Metadata now contains the metadata for 'images/forest.jpg'
-        }).catch((error) => {
-          // Uh-oh, an error occurred!
-        });
-      */
+      if (includeMetaData) {
+        return Promise.all(metaPromises)
+          .then(metaResults => itemRefs.map((item: StorageDocument, index: number) => (
+            {
+              ...item,
+              creation: new Date(metaResults[index]?.timeCreated),
+              documentType: metaResults[index]?.contentType,              
+              creator: metaResults[index]?.customMetadata?.creator,
+              descriptionName: metaResults[index]?.customMetadata?.name,
+              description: metaResults[index]?.customMetadata?.comment,
+              size: metaResults[index]?.size,
+              metaData: metaResults[index]
+            }
+          )));
+      }
       return itemRefs;
     }).catch((error) => {
       // TODO: add error handling

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

@@ -32,6 +32,11 @@ const internalCallFunction = async (def: FunctionDefinition, functionInput: any)
         && funcResult.data && def.successCodes.includes(funcResult.data.statusCode)) {
       return funcResult.data as FunctionResult;
     }
+
+    if (funcResult && funcResult.data) {
+      throw new Error(`Error: ${funcResult.data.statusCode} - ${funcResult.data.resultData}`);
+    }
+
     /*
     const ne = new Error("Invalid result");
     if (result.data) {

package/src/service-provider/mock/auth.ts

@@ -37,6 +37,12 @@ export const isAuthenticatedMock = (): boolean => {
   return loginAvailable;
 } 
 
+export const getAuthUserMock = (): unknown => 
+  isAuthenticatedMock() ? {
+    uid: "34234234",
+    displayName: "userMockName"
+  } : undefined;
+
 
 export const authStateChangedMock = () => {
   console.log("Not implemented for MOCK");

package/src/service-provider/mock/storage-client.ts

@@ -124,8 +124,13 @@ export const uploadStorageFileMock = (file: UploadFile):Promise<any> => {
   return storageConf.storage.uploadFile(fileRef, file);
 };
 
-export const getMockFileList = (storageName: string, keyRef: string):Promise<StorageDocument[]> => {
-  console.log("Searching for Documents in ", storageName, keyRef);
+export const getMockFileList = (
+  storageName: string, 
+  keyRef: string,
+  subFolder?: string,
+  includeMetadata?: boolean
+):Promise<StorageDocument[]> => {
+  console.log("Searching for Documents in ", storageName, keyRef, subFolder, includeMetadata);
   return Promise.resolve([{
     fileName: "workReport.png",
     filePath: "workReports/1234234f2fswf/workReport.png",

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

@@ -1,7 +1,7 @@
 import { FirebaseApp, FirebaseOptions, initializeApp } from "firebase/app";
 
-import { authStateChanged, initAuth, isAuthenticated, login, logout } from "./firebase/auth.js";
-import { authStateChangedMock, isAuthenticatedMock, loginMock, logoutMock } from "./mock/auth.js";
+import { authStateChanged, getAuthUser, initAuth, isAuthenticated, login, logout } from "./firebase/auth.js";
+import { authStateChangedMock, getAuthUserMock, isAuthenticatedMock, loginMock, logoutMock } from "./mock/auth.js";
 import { AppConfiguration, FileStorageConfig, FunctionDefinition, FunctionResult, FunctionsConfig, ServiceProviderConfiguration, StorageDocument, UploadFile } from "./service-provider-model.js";
 import { callFunction, initFunctions } from "./firebase/functions-client.js";
 import { initFirestore } from "./firebase/firestore-client.js";
@@ -142,6 +142,17 @@ export const logoutImpl = () => {
     return logoutMock();
   }     
   return throwUndefinedProviderError();  
+};
+
+// Refactor: Return defined USer Object
+export const getUser = () => {
+  if (provider === "firebase") {
+    return getAuthUser();
+  }   
+  if (provider === "mock") {
+    return getAuthUserMock();
+  }     
+  return throwUndefinedProviderError();  
 }
 
 /* #####################
@@ -157,12 +168,17 @@ export const uploadFile = (file: UploadFile): Promise<unknown> => {
   return throwUndefinedProviderError();  
 }
 
-export const getStorageFileList = (storageName: string, keyRef: string): Promise<StorageDocument[]> => {  
+export const getStorageFileList = (
+  storageName: string, 
+  keyRef: string, 
+  subFolder?: string, 
+  includeMetadata?:boolean
+): Promise<StorageDocument[]> => {  
   if (provider === "firebase") {
-    return getFirestorageFileList(storageName, keyRef);
+    return getFirestorageFileList(storageName, keyRef, subFolder, includeMetadata);
   }
   if (provider === "mock") {
-    return getMockFileList(storageName, keyRef);
+    return getMockFileList(storageName, keyRef, subFolder, includeMetadata);
   }
   return throwUndefinedProviderError();  
 }

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

@@ -123,16 +123,23 @@ export interface UploadFile {
   base64DataURL:string,
   descriptionName:string,
   description:string,
-  storageName?: string
-  referenceKey?: string
+  storageName: string
+  referenceKey: string
   subFolderName?: string,
 }
 
+export interface StorageMetadata {
+
+}
+
 export interface StorageDocument {
-  fileName: string,
-  documentType: string,
+  fileName: string,  
   filePath: string,
+  documentType?: string,  
   description?:string,  
+  descriptionName?: string,
   creation?:Date,
   creator?:string,
+  size?: number,
+  metaData?: StorageMetadata
 }