@progressive-development/pd-spa-helper 0.3.102 → 0.3.104

package/src/service-call-controller2.ts

@@ -1,68 +0,0 @@
-import {ReactiveControllerHost} from 'lit';
-import {initialState, Task} from '@lit-labs/task';
-
-import { FunctionDefinition, FunctionResult } from './service-provider/service-provider-model.js';
-import { initController } from './service-provider/service-provider-impl.js';
-
-export interface ServiceControllerInput {
-  promise: Promise<FunctionResult>,
-  func: FunctionDefinition,
-}
-
-export class ServiceCallController {
-
-  host: ReactiveControllerHost;
-
-  private task!: Task;
-
-  private _callDataPromise!: ServiceControllerInput;
-
-  constructor(host: ReactiveControllerHost) {
-    this.host = host;
-    this.task = new Task<[ServiceControllerInput], FunctionResult>(host,
-
-      async ([callDataPromise]: [ServiceControllerInput]) => {
-        if (!callDataPromise) {
-          return initialState;
-        }
-        try {
-          const result = await callDataPromise.promise;
-          return result as FunctionResult;
-        } catch (e) {
-          console.error("Error: ", e);
-          throw new Error(`Failed call function "${callDataPromise.func.name}"`);
-        }
-
-      }, () => [this.callDataPromise]
-
-    );
-    initController(this);
-  }
-
-  /*
-  set callData(value: FunctionParam) {
-    this._callData = value;
-    this.host.requestUpdate();
-  }
-
-  get callData(): FunctionParam { return this._callData; }
-  */
-
-  set callDataPromise(value: ServiceControllerInput) {
-    this._callDataPromise = value;
-    this.host.requestUpdate();
-  }
-
-  get callDataPromise(): ServiceControllerInput { return this._callDataPromise; }
-
-  clear() {
-    this.task.status = 0;
-    this.host.requestUpdate();
-  }
-
-  // TODO: Type definition FunctionResult do not work, but work in Homepage Project...
-  render(renderFunctions: any) {
-    return this.task.render(renderFunctions);
-  }
-
-}

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

@@ -1,89 +0,0 @@
-import { FirebaseApp } from 'firebase/app';
-import { Auth, getAuth, onAuthStateChanged, onIdTokenChanged, signInWithEmailAndPassword, signOut, User } from 'firebase/auth';
-
-let auth: Auth;
-
-/**
- * During start/load application, initialize functions.  
- * 
- * @param {*} app - initialized app. 
- */
-export const initAuth = (appParam: FirebaseApp) => {
-  auth = getAuth(appParam);
-  console.log("App for auth is set: ", auth);
-}
-
-export const logout = async (): Promise<boolean> => {
-  if (!auth) {
-    throw new Error("logout: Auth was not initialized");
-  }
-  try {
-    await signOut(auth);
-    return true;
-  } catch (error) {
-    return false;
-  }
-};
-
-export const isAuthenticated = (): boolean => {
-  if (!auth) {
-    throw new Error("isAuthenticated: Auth was not initialized");
-  }
-  const authCheck = auth.currentUser !== null;
-  console.log("Check auth: ", authCheck);
-  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) {
-    throw new Error("authStateChanged: Auth was not initialized");
-  }
-  onAuthStateChanged(auth, (user) => callback(user));  
-
-  /* Alter code aus init in pd-spa-helper, hier falsch, noch refactorieren   
-  if (user) {
-    this._user = user;
-    if (postLoginFunc) {      
-      callFunction(postLoginFunc, postLoginFunc.param)
-        .then((result:FunctionResult) => {
-          this._profile = result.resultData;
-          // redirect if login in the meantime is available 
-          // => else stay on the login page after reload/url navigation
-          if (this.route === "login" && postLoginFunc?.redirect) {                
-            this.navigate(postLoginFunc.redirect);
-          }
-          // new event, could/should replace redirect
-          document.dispatchEvent(new CustomEvent("user-login-event"));
-        }).catch(() => {
-          if (postLoginFunc?.logoutOnFail) {
-            logout();
-            this._user = undefined;
-            this._profile = undefined;
-          }
-        });            
-    } else {
-      this._user = undefined;
-      this._profile = undefined;
-    }
-  }
-  */
-}
-
-export const authIdTokenStateChanged = (callback: Function) => {  
-  onIdTokenChanged(auth, (user) => callback(user));
-}
-
-export const login = async (user:string, sec:string): Promise<User> => {
-  if (!auth) {
-    throw new Error("login: Auth was not initialized");
-  }
-  const credentials = await signInWithEmailAndPassword(auth, user, sec);
-  return credentials.user;
-}

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

@@ -1,327 +0,0 @@
-import { FirebaseApp } from 'firebase/app';
-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';
-
-const DEFAULT_STORAGE = "default_storage";
-
-const storageMap:Map<string, {  
-  storage: FirebaseStorage,
-  references?: {
-    key: string,
-    storageRef:  StorageReference
-  }[],
-}> = new Map();
-
-/**
- * During start/load application, initialize functions.
- *
- * @param {*} app - initialized app.
- */
-export const initFirestorage = (
-  app: FirebaseApp, 
-  defaultStorage?: string, 
-  storageConfig?: FileStorageConfig
-) => {
-  try {
-
-    // add default storage
-    if (defaultStorage) {
-      storageMap.set(DEFAULT_STORAGE, {
-        storage: getStorage(app)
-      });
-    }    
-    
-    // add specific storages
-    storageConfig?.storage.forEach(storeConfig => {
-
-      const storage = getStorage(app, storeConfig.name);
-      const storageRootRef = ref(storage);
-
-      storageMap.set(storeConfig.name, {
-        storage,
-        references: [
-          {
-            key: "ROOT",
-            storageRef: storageRootRef
-          },
-          ...storeConfig.references.map(refConfigString => ({
-            key: refConfigString,
-            storageRef: ref(storageRootRef, refConfigString)
-          }))
-        ]
-      });
-    });            
-
-  } catch (error) {
-    console.error(error);
-  }
-};
-
-export const uploadFirestorageFile = (file: UploadFile):Promise<UploadResult> => {  
-
-  if (!storageMap || storageMap.size === 0) {
-    throw new Error("No storage is configured");
-  }  
-
-  // get storage
-  const {storageName, referenceKey, subFolderName, fileName} = file;
-  const storageConf = storageMap.get(storageName || DEFAULT_STORAGE);
-  if (!storageConf ) {
-    throw new Error(`Invalid storage name: ${storageName || DEFAULT_STORAGE}`);
-  }  
-  if (!storageConf.references || storageConf.references.length === 0) {
-    throw new Error(`No references configured for storage: ${storageName || DEFAULT_STORAGE}`);
-  }
-
-  // get reference to path
-  const uploadRefConf = referenceKey ? (storageConf.references.filter(filterRef => filterRef.key === referenceKey)[0]) : storageConf.references[0];
-  if (!uploadRefConf || !uploadRefConf.storageRef) {
-    throw new Error(`No valid reference for key: ${referenceKey}`);
-  }
-
-  // create file reference and upload
-  const fileRef = ref(uploadRefConf.storageRef, subFolderName ? `${subFolderName}/${fileName}` : fileName);
-
-  // default usefull metadata: contentType, size, timeCreated, updated
-
-  // additional custom metadata
-  const metadata = {
-    customMetadata: {
-      'creator': (getUser() as any)?.displayName,
-      'comment': file.description,
-      'name': file.descriptionName,
-      'readonly': file.readonly ? "true" : "false",
-    }
-  };
-  
-  return uploadString(fileRef, file.base64DataURL, 'data_url', metadata);
-};
-
-const fetchItemsAndFolders = async (
-  usedRef: StorageReference,
-  storageName: string,
-  refKey: string,
-  includeMetaData = false,
-  includeFolder = false
-): Promise<StorageDocument[]> => {
-  try {
-    const itemRefs: StorageDocument[] = [];
-    const metaPromises: Promise<FullMetadata>[] = [];
-    
-    // Hole alle Items und Folder direkt unter `usedRef`
-    const res: ListResult = await listAll(usedRef);
-
-    // Hilfsfunktion zur Verarbeitung der Metadaten
-    const processMetadata = (item: StorageDocument, metadata: FullMetadata): StorageDocument => ({
-      ...item,
-      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
-    });
-    
-    // 1. Items direkt im usedRef-Ordner verarbeiten
-    res.items.forEach((itemRef) => {
-      itemRefs.push({
-        fileName: itemRef.name,
-        filePath: itemRef.fullPath,
-        storageName,
-        refKey
-      });
-
-      // Erzeuge die Metadaten-Promises direkt, wenn `includeMetaData` aktiv ist
-      if (includeMetaData) {
-        metaPromises.push(getMetadata(itemRef));
-      }
-    });
-
-     // 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));
-            }
-          });
-        })
-      );
-    }
-
-     // 3. Falls `includeMetaData`, warte auf alle Metadaten und ordne sie den `itemRefs` zu
-     if (includeMetaData) {
-      const metaResults = await Promise.all(metaPromises);
-      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);
-    throw error;
-  }
-}
-
-// 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, 
-  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);
-  if (!storageConf ) {
-    throw new Error(`Invalid storage name: ${storageName}`);
-  }  
-  if (!storageConf.references || storageConf.references.length === 0) {
-    throw new Error(`No references configured for storage: ${storageName || DEFAULT_STORAGE}`);
-  }
-
-  // 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;    
-  return fetchItemsAndFolders(usedRef, storageName, refKey, includeMetaData, true);
-};
-
-
-export const downloadFileFirestorage = (file: StorageDocument) => {
-
-  if (!storageMap || storageMap.size === 0) {
-    throw new Error("No storage is configured");
-  }
-
-  // get storage  
-  const storageConf = storageMap.get(file.storageName);
-  if (!storageConf ) {
-    throw new Error(`Invalid storage name: ${file.storageName}`);
-  }  
-  const usedRef = ref(storageConf.storage, file.filePath);
-  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 */
-/* 
-storage/unknown	An unknown error occurred.
-storage/object-not-found	No object exists at the desired reference.
-storage/bucket-not-found	No bucket is configured for Cloud Storage
-storage/project-not-found	No project is configured for Cloud Storage
-storage/quota-exceeded	Quota on your Cloud Storage bucket has been exceeded. If you're on the no-cost tier, upgrade to a paid plan. If you're on a paid plan, reach out to Firebase support.
-storage/unauthenticated	User is unauthenticated, please authenticate and try again.
-storage/unauthorized	User is not authorized to perform the desired action, check your security rules to ensure they are correct.
-storage/retry-limit-exceeded	The maximum time limit on an operation (upload, download, delete, etc.) has been excceded. Try uploading again.
-storage/invalid-checksum	File on the client does not match the checksum of the file received by the server. Try uploading again.
-storage/canceled	User canceled the operation.
-storage/invalid-event-name	Invalid event name provided. Must be one of [`running`, `progress`, `pause`]
-storage/invalid-url	Invalid URL provided to refFromURL(). Must be of the form: gs://bucket/object or https://firebasestorage.googleapis.com/v0/b/bucket/o/object?token=<TOKEN>
-storage/invalid-argument	The argument passed to put() must be `File`, `Blob`, or `UInt8` Array. The argument passed to putString() must be a raw, `Base64`, or `Base64URL` string.
-storage/no-default-bucket	No bucket has been set in your config's storageBucket property.
-storage/cannot-slice-blob	Commonly occurs when the local file has changed (deleted, saved again, etc.). Try uploading again after verifying that the file hasn't changed.
-storage/server-file-wrong-size
-*/

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

@@ -1,40 +0,0 @@
-import { FirebaseApp } from 'firebase/app';
-import {collection, Firestore, getFirestore, onSnapshot, query, QueryConstraint, where} from 'firebase/firestore';
-import { CollectionContraint } from '../service-provider-model';
-// import { getAuth } from 'firebase/auth';
-
-let db:Firestore;
-
-/**
- * During start/load application, initialize functions.
- *
- * @param {*} app - initialized app.
- */
-export const initFirestore = (app: FirebaseApp) => {
-  try {
-    // init db access
-    db = getFirestore(app);
-  } catch (error) {
-    console.error(error);
-  }
-};
-
-export const getDB = ():Firestore => db;
-
-export const getFirebaseCollectionListener = (
-  callback: Function, 
-  col: string, 
-  constraints?:CollectionContraint[]
-) => {
-  const queryConstraints:QueryConstraint[] = 
-    (constraints || []).map(constraint => {
-      if (constraint.type === "where") {
-        return where(constraint.field, constraint.operator, constraint.value)
-      }
-      throw new Error(`Unkown constraint type: ${constraint.type}`);
-    });
-  const q = query(collection(db, col), ...queryConstraints);
-  return onSnapshot(q, (querySnapshot) => callback(querySnapshot));
-}
-
-  

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

@@ -1,73 +0,0 @@
-import { FirebaseApp } from "firebase/app";
-import { getFunctions, HttpsCallable, httpsCallable } from "firebase/functions";
-import { FunctionDefinition, FunctionResult, FunctionsConfig } from "../service-provider-model.js";
-
-const functionMap = new Map<FunctionDefinition, HttpsCallable>;
-
-/**
- * During start/load application, initialize functions.  
- * 
- * @param {*} app - initialized app. 
- */
-export const initFunctions = (app: FirebaseApp, functionsConfig: FunctionsConfig) => {
-  try {
-      // Initialize cloud functions through Firebase
-      const functions = getFunctions(app, functionsConfig.region);
-
-      // Initialize functions map
-      functionsConfig.functions.forEach(func => {
-        functionMap.set(func, httpsCallable(functions, func.name));
-      });
-
-  } catch (error) {
-      console.error("ToDo: Error programmieren...", error);
-  }
-}
-
-const internalCallFunction = async (def: FunctionDefinition, functionInput: any): Promise<FunctionResult> => {
-  const funcRef = functionMap.get(def);    
-  if (funcRef) {    
-    const funcResult:any = await funcRef(functionInput);
-    if (funcResult 
-        && 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) {
-      // Read result of the Cloud Function.                            
-      switch (result.data.statusCode) {
-        case 200:
-          return resolve(result.data.projects);
-        default:
-          ne.data = result.data;
-          return reject(ne);
-      }
-    } else {
-          return reject(ne);
-        }
-      })
-      .catch((error) => {
-      // Getting the Error details.
-      const {code} = error;
-      const {message} = error;
-      const {details} = error;
-
-      console.warn("Error occured: ", code, message, details);
-      console.warn("Error: ", error);
-      return reject(error);
-    })
-    */
-  } 
-  console.log("No function available for ", def.name);
-  throw new Error("Illegal state, no data with right state available");
-}
-
-export const callFunction = async (def: FunctionDefinition, functionInput: any): Promise<FunctionResult> => 
-  internalCallFunction(def, functionInput);  
-  

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

@@ -1,102 +0,0 @@
-import { FirebaseApp } from "firebase/app";
-import { getMessaging, getToken, Messaging } from "firebase/messaging";
-import { User } from "firebase/auth";
-
-import { MessagingConfig } from "../service-provider-model.js";
-import { update, USER_COLLECTION } from '../../store/indexDB.js';
-
-import { pdStore } from "../../store/mini-rx.store.js";
-import { updateNewNotificationToken } from "../../store/spa-app-actions.js";
-import { authIdTokenStateChanged } from "./auth.js";
-
-
-export const NOTIFICATION_TOKEN = "pd.spa.helper.notification.token";
-
-let messaging: Messaging;
-let firebaseMessagingAppConfigKey: MessagingConfig;
-
-
-export function prepareMessaging(
-  app: FirebaseApp,
-  messageConfig: MessagingConfig
-) {
-  messaging = getMessaging(app);
-  firebaseMessagingAppConfigKey = messageConfig;
-}
-
-export const activateTokenChangeHandler = (appName:string) => {  
-  authIdTokenStateChanged(async (user:User) => {
-    if (user) {
-      const token = await user.getIdToken();
-      if (token) {
-        await update(USER_COLLECTION, {
-          id: appName,
-          userNameToken: user.displayName,
-          userIdToken: token,
-        });
-        console.log('UserToken stored in local db');
-      }
-    }
-  });
-}
-
-const initMessageToken = async (
-  registration: ServiceWorkerRegistration
-) => {
-  
-  if (!messaging || !firebaseMessagingAppConfigKey || !registration) {
-    throw new Error("Messaging, Registration or Key not available");
-  }
-
-  // get token from cache or network
-  const currentToken = await getToken(
-    messaging, 
-    {
-      vapidKey: firebaseMessagingAppConfigKey.apidKey,
-      serviceWorkerRegistration: registration
-    }
-  );
-
-  if (currentToken) {
-    const storedToken = localStorage.getItem(NOTIFICATION_TOKEN);
-    if (storedToken !== currentToken) {          
-      console.log("Update new token in Backend");
-      pdStore().dispatch(updateNewNotificationToken({
-        messagingToken: currentToken
-      }));
-    } else {
-      console.log("RegisterDevice: Stored token is valid");
-    }
-  } else {
-    console.warn("No token received - no new token was generated.");
-  }
-}
-
-
-export const registerDevice = async (
-  registration: ServiceWorkerRegistration
-) => {
-
-  console.log("Start registering app for messages and notifications");
-
-  // Noch keine Berechtigung erteilt, diese vom Benutzer abfragen
-  if (Notification.permission === "default") {
-    // TODO: Manually triggered with user information
-    await Notification.requestPermission();
-  } 
-      
-  // Berechtigung erteilt, Gerät für messaging registrieren
-  if (Notification.permission === "granted") {
-    // FCM-Token abrufen, wenn online oder lokal verfügbar
-    await initMessageToken(registration);
-  }
-
-  // Keine Berechtigung erteilt
-  if (Notification.permission === "denied") {
-    console.warn("Messaging not possible, missing rights");
-  }
-       
-}
-
-
-export const getFirebaseMessaging = () => messaging;