@edgedev/firebase 1.7.11 → 1.8.0

package/README.md

@@ -576,6 +576,8 @@ The user object is reactive and contains these items:
 interface UserDataObject {
   uid: string | null;
   email: string;
+  firebaseUser: object; // contains the entire auth from firebase
+  oAuthCredential: object; // contains oAuth ID and token information
   loggedIn: boolean;
   logInError: boolean;
   logInErrorMessage: string;

package/edgeFirebase.ts

@@ -43,6 +43,9 @@ import {
   confirmPasswordReset,
   connectAuthEmulator,
   deleteUser,
+  OAuthProvider,
+  browserPopupRedirectResolver,
+  signInWithPopup,
 } from "firebase/auth";
 
 
@@ -80,6 +83,8 @@ interface permissions {
 
 type action = "assign" | "read" | "write" | "delete";
 
+type authProviders = "email" | "microsoft" | "google" | "facebook" | "github" | "twitter" | "apple";
+
 interface role {
   collectionPath: "-" | string; // - is root
   role: "admin" | "editor" | "writer" | "user";
@@ -93,6 +98,8 @@ interface specialPermission {
 interface UserDataObject {
   uid: string | null;
   email: string;
+  firebaseUser: object;
+  oAuthCredential: { accessToken: string; idToken: string;}
   loggedIn: boolean;
   logInError: boolean;
   logInErrorMessage: string;
@@ -101,7 +108,6 @@ interface UserDataObject {
   specialPermissions: specialPermission[];
   stagedDocId: string;
 }
-
 interface newUser {
   roles: role[];
   specialPermissions: specialPermission[];
@@ -110,7 +116,7 @@ interface newUser {
   subCreate?: {
     rootPath: string, // This must be a collection path (odd number of segments) since a document will be created and assigned to ther user here.
     role: string,
-    dynamicDocumentField: string, // This is the field in the document that will be set by the value of "dynamicDocumentFieldValue" passed during registration, like "name"
+    dynamicDocumentFieldValue: string, // This is the field in the document that will be set by the value of "dynamicDocumentFieldValue" passed during registration, like "name"
     documentStructure: {
       [key: string]: unknown
     }
@@ -118,8 +124,8 @@ interface newUser {
 }
 
 interface userRegister {
-  email: string;
-  password: string;
+  email?: string;
+  password?: string;
   meta: object;
   registrationCode: string;
   dynamicDocumentFieldValue?: string;
@@ -192,7 +198,7 @@ export const EdgeFirebase = class {
       persistence = browserLocalPersistence;
     }
 
-    this.auth = initializeAuth(this.app, { persistence });
+    this.auth = initializeAuth(this.app, { persistence, popupRedirectResolver: browserPopupRedirectResolver });
     if (this.firebaseConfig.emulatorAuth) {
       connectAuthEmulator(this.auth, `http://localhost:${this.firebaseConfig.emulatorAuth}`)
     }
@@ -368,6 +374,7 @@ export const EdgeFirebase = class {
       if (userAuth) {
         this.user.email = userAuth.email;
         this.user.uid = userAuth.uid;
+        this.user.firebaseUser = userAuth;
         this.user.logInError = false;
         this.user.logInErrorMessage = "";
         this.logAnalyticsEvent("login", { uid: this.user.uid });
@@ -375,14 +382,57 @@ export const EdgeFirebase = class {
       } else {
         this.user.email = "";
         this.user.uid = null;
+        this.user.firebaseUser = null;
+        this.user.oAuthCredential.accessToken = "";
+        this.user.oAuthCredential.idToken = "";
         this.user.loggedIn = false;
-        this.user.logInError = false;
-        this.user.logInErrorMessage = "";
       }
     });
   };
+
+  public logInWithMicrosoft = async (providerScopes: string[] = []): Promise<void> => {
+      const result = await this.signInWithMicrosoft(providerScopes);
+      if (!Object.prototype.hasOwnProperty.call(result, "user")) {
+        this.user.logInError = true;
+        this.user.logInErrorMessage = result
+        this.logOut();
+        return;
+      }
+      console.log(result.user.uid);
+      const userRef = doc(this.db, "staged-users", result.user.uid);
+      const userSnap = await getDoc(userRef);
+      if (!userSnap.exists()) { 
+        this.user.logInError = true;
+        this.user.logInErrorMessage = "User does not exist";
+        this.logOut();
+      }
+  };
+
+  private registerUserWithMicrosoft = async (providerScopes: string[] = []): Promise<any> => {
+    const result = await this.signInWithMicrosoft(providerScopes);
+    return result;
+  };
+
+  private signInWithMicrosoft = async (providerScopes: string[] = []): Promise<any> => {
+    const provider = new OAuthProvider("microsoft.com");
+    for (const scope of providerScopes) {
+      provider.addScope(scope);
+    }
+    try {
+      const result = await signInWithPopup(this.auth, provider);
+      const credential = OAuthProvider.credentialFromResult(result);
+      this.user.oAuthCredential.accessToken = credential.accessToken;
+      this.user.oAuthCredential.idToken = credential.idToken;
+      return result;
+    } catch (error) {
+      return error;
+    }
+  }
+
   public registerUser = async (
-    userRegister: userRegister
+    userRegister: userRegister,
+    authProvider: authProviders = "email",
+    providerScopes: string[] = []
   ): Promise<actionResponse> => {
     if (!Object.prototype.hasOwnProperty.call(userRegister, 'registrationCode') || userRegister.registrationCode === "") {
       return this.sendResponse({
@@ -411,12 +461,27 @@ export const EdgeFirebase = class {
             });
          }
         }
-        // TODO: check if user is already registered, if so return error with auth
-        const response = await createUserWithEmailAndPassword(
-          this.auth,
-          userRegister.email,
-          userRegister.password
-        );
+        let response;
+        if (authProvider === "email") {
+          try {
+            response = await createUserWithEmailAndPassword(
+              this.auth,
+              userRegister.email,
+              userRegister.password
+            );
+          } catch (error) {
+            response = error;
+          }
+        } else if (authProvider === "microsoft") {
+         response = await this.registerUserWithMicrosoft(providerScopes);
+        }
+        if (!Object.prototype.hasOwnProperty.call(response, "user")) { 
+          return this.sendResponse({
+            success: false,
+            message: response,
+            meta: {}
+          });
+        }
 
         let metaUpdate = {};
         if (Object.prototype.hasOwnProperty.call(userRegister, 'meta')) {
@@ -578,7 +643,6 @@ export const EdgeFirebase = class {
     }
   };
 
-  //TODO: Document this function
   public deleteSelf = async (): Promise<actionResponse> => {
     const userId = this.user.uid;
     const userRef = doc(this.db, "users", userId);
@@ -856,10 +920,11 @@ export const EdgeFirebase = class {
     }
     signOut(this.auth).then(() => {
       this.user.uid = null;
+      this.user.firebaseUser = null;
+      this.user.oAuthCredential.accessToken = "";
+      this.user.oAuthCredential.idToken = "";
       this.user.email = "";
       this.user.loggedIn = false;
-      this.user.logInError = false;
-      this.user.logInErrorMessage = "";
       this.user.meta = {};
       this.user.roles = [];
       this.user.specialPermissions = [];
@@ -880,7 +945,9 @@ export const EdgeFirebase = class {
     .catch((error) => {
       this.user.email = "";
       this.user.uid = null;
-
+      this.user.firebaseUser = null;
+      this.user.oAuthCredential.accessToken = "";
+      this.user.oAuthCredential.idToken = "";
       this.user.loggedIn = false;
       this.user.logInError = true;
       this.user.logInErrorMessage = error.code + ": " + error.message;
@@ -906,11 +973,13 @@ export const EdgeFirebase = class {
     email: "",
     loggedIn: false,
     logInError: false,
-    logInErrorMessage: "",
+    logInErrorMessage: "",   
     meta: {},
     roles: [],
     specialPermissions: [],
     stagedDocId: null,
+    firebaseUser: null,
+    oAuthCredential: {accessToken: "", idToken: ""},
   });
 
   public state = reactive({
@@ -970,7 +1039,6 @@ export const EdgeFirebase = class {
     return { data, next: nextLast };
   };
 
-  // Class for wrapping a getSaticData to handle pagination
   get SearchStaticData() {
     const getStaticData = this.getStaticData;
     const permissionCheckOnly = this.permissionCheckOnly;
@@ -1162,8 +1230,6 @@ export const EdgeFirebase = class {
     );
   };
 
-  // TODO: Document this and how the data is stored collectionPath + '/' + docId...
-  // Also stopSnapshot is by collectionPath + '/' + docId
   public startDocumentSnapshot = async (
     collectionPath: string,
     docId: string
@@ -1526,7 +1592,6 @@ export const EdgeFirebase = class {
     }
   };
 
-  // TODO: Add documentation for this function
   public changeDoc = async (
     collectionPath: string,
     docId: string,
@@ -1650,7 +1715,6 @@ export const EdgeFirebase = class {
     
   };
 
-  // Composable to delete a document
   public removeDoc = async (
     collectionPath: string,
     docId: string
@@ -1679,7 +1743,6 @@ export const EdgeFirebase = class {
     }
   };
 
-  // Composable to stop snapshot listener
   public stopSnapshot = (collectionPath: string): void => {
     if (this.unsubscibe[collectionPath] instanceof Function) {
       this.unsubscibe[collectionPath]();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@edgedev/firebase",
-  "version": "1.7.11",
+  "version": "1.8.0",
   "description": "Vue 3 / Nuxt 3 Plugin or Nuxt 3 plugin for firebase authentication and firestore.",
   "main": "index.ts",
   "scripts": {

package/src/firestore.rules

@@ -1,4 +1,4 @@
-rules_version = '2';
+// #EDGE FIREBASE RULES START
 service cloud.firestore {
 
   match /databases/{database}/documents/events/{event} {
@@ -282,4 +282,5 @@ service cloud.firestore {
         }
       }
     }
-  }
+  }
+  // #EDGE FIREBASE RULES END

package/src/functions.js

@@ -0,0 +1,103 @@
+// START @edge/firebase functions
+exports.updateUser = functions.firestore.document('staged-users/{docId}').onUpdate((change, context) => {
+  const eventId = context.eventId
+  const eventRef = db.collection('events').doc(eventId)
+  const stagedDocId = context.params.docId
+  let newData = change.after.data()
+  const oldData = change.before.data()
+  return shouldProcess(eventRef).then((process) => {
+    if (process) {
+      // Note: we can trust on newData.uid because we are checking in rules that it matches the auth.uid
+      // TODO: user might be invited to join another org with reg code.. if used when logged will combine new staged-user doc into first stage-user doc and sync to users.
+      if (newData.userId) {
+        const userRef = db.collection('users').doc(newData.userId)
+        setUser(userRef, newData, oldData, stagedDocId).then(() => {
+          return markProcessed(eventRef)
+        })
+      }
+      else {
+        if (newData.templateUserId !== oldData.templateUserId) {
+          newData.isTemplate = false
+          const templateUserId = newData.templateUserId
+          newData.meta = newData.templateMeta
+          delete newData.templateMeta
+          delete newData.templateUserId
+          if (Object.prototype.hasOwnProperty.call(newData, 'subCreate') && Object.values(newData.subCreate).length > 0) {
+            const subCreate = newData.subCreate
+            delete newData.subCreate
+            db.collection(subCreate.rootPath).add({ [subCreate.dynamicDocumentField]: newData.dynamicDocumentFieldValue }).then((addedDoc) => {
+              db.collection(subCreate.rootPath).doc(addedDoc.id).update({ docId: addedDoc.id }).then(() => {
+                delete newData.dynamicDocumentFieldValue
+                const newRole = { [`${subCreate.rootPath}-${addedDoc.id}`]: { collectionPath: `${subCreate.rootPath}-${addedDoc.id}`, role: subCreate.role } }
+                if (Object.prototype.hasOwnProperty.call(newData, 'collectionPaths')) {
+                  newData.collectionPaths.push(`${subCreate.rootPath}-${addedDoc.id}`)
+                }
+                else {
+                  newData.collectionPaths = [`${subCreate.rootPath}-${addedDoc.id}`]
+                }
+                const newRoles = { ...newData.roles, ...newRole }
+                newData = { ...newData, roles: newRoles }
+                const stagedUserRef = db.collection('staged-users').doc(templateUserId)
+                return stagedUserRef.set({ ...newData, userId: templateUserId }).then(() => {
+                  const userRef = db.collection('users').doc(templateUserId)
+                  setUser(userRef, newData, oldData, templateUserId).then(() => {
+                    return markProcessed(eventRef)
+                  })
+                })
+              })
+            })
+          }
+          else {
+            const stagedUserRef = db.collection('staged-users').doc(templateUserId)
+            return stagedUserRef.set({ ...newData, userId: templateUserId }).then(() => {
+              const userRef = db.collection('users').doc(templateUserId)
+              setUser(userRef, newData, oldData, templateUserId).then(() => {
+                return markProcessed(eventRef)
+              })
+            })
+          }
+        }
+      }
+      return markProcessed(eventRef)
+    }
+  })
+})
+
+function setUser(userRef, newData, oldData, stagedDocId) {
+// IT's OK If "users" doesn't match exactly matched "staged-users" because this is only preventing
+// writing from outside the @edgdev/firebase functions, so discrepancies will be rare since
+// the package will prevent before it gets this far.
+  return userRef.get().then((user) => {
+    let userUpdate = { meta: newData.meta, stagedDocId }
+
+    if (Object.prototype.hasOwnProperty.call(newData, 'roles')) {
+      userUpdate = { ...userUpdate, roles: newData.roles }
+    }
+    if (Object.prototype.hasOwnProperty.call(newData, 'specialPermissions')) {
+      userUpdate = { ...userUpdate, specialPermissions: newData.specialPermissions }
+    }
+
+    if (!oldData.userId) {
+      userUpdate = { ...userUpdate, userId: newData.uid }
+    }
+    if (!user.exists) {
+      return userRef.set(userUpdate)
+    }
+    else {
+      return userRef.update(userUpdate)
+    }
+  })
+}
+
+function shouldProcess(eventRef) {
+  return eventRef.get().then((eventDoc) => {
+    return !eventDoc.exists || !eventDoc.data().processed
+  })
+}
+
+function markProcessed(eventRef) {
+  return eventRef.set({ processed: true }).then(() => {
+    return null
+  })
+}
+// END @edge/firebase functions

package/src/postinstall.sh

@@ -3,15 +3,32 @@
 # Check if the destination file exists
 if [ ! -f ./firestore.rules ]; then
   # If the file does not exist, create it and add the rules_version line
-  echo 'rules_version = '\''2'\'';' > ./firestore.rules;
-else
-  # If the file exists, add the rules_version line at the beginning using sed
-  sed -i '1s/^/rules_version = \\'\''2\\'\'';\\n/' ./firestore.rules;
+  echo "rules_version = '2';" > ./firestore.rules;
 fi
 
+[ "$(tail -c1 ./firestore.rules)" != "" ] && echo "" >> ./firestore.rules
+
 # Extract the code block from the source file and append it to the destination file
-awk '/\/\/ #EDGE FIREBASE RULES START/,/\/\/ #EDGE FIREBASE RULES END/' ./src/firestore.rules | \
-  sed 's/\\/\\\\/g; s/&/\\&/g' | \
-  sed -e 's/\"/\\\\\"/g' -e 's/\//\\\\\//g' | \
+sed -i.backup '/\/\/ #EDGE FIREBASE RULES START/,/\/\/ #EDGE FIREBASE RULES END/d' ./firestore.rules
+
+awk '/\/\/ #EDGE FIREBASE RULES START/,/\/\/ #EDGE FIREBASE RULES END/' ./node_modules/@edgedev/firebase/src/firestore.rules | \
+  sed '1d;$d' | \
   sed -e '1s/^/\/\/ #EDGE FIREBASE RULES START\n/' -e '$s/$/\n\/\/ #EDGE FIREBASE RULES END/' \
   >> ./firestore.rules;
+
+if [ ! -f ./functions/index.js ]; then
+  mkdir -p ./functions
+  echo "const functions = require('firebase-functions');" > ./functions/index.js;
+  echo "const admin = require('firebase-admin');" >> ./functions/index.js;
+  echo "admin.initializeApp();" >> ./functions/index.js;
+  echo "const db = admin.firestore();" >> ./functions/index.js;
+fi   
+
+[ "$(tail -c1 ./firestore.rules)" != "" ] && echo "" >> ./functions/index.js
+
+sed -i.backup '/\/\/ START @edge\/firebase functions/,/\/\/ END @edge\/firebase functions/d' ./functions/index.js
+
+awk '/\/\/ START @edge\/firebase functions/,/\/\/ END @edge\/firebase functions/' ./node_modules/@edgedev/firebase/src/functions.js | \
+  sed '1d;$d' | \
+  sed -e '1s/^/\/\/ START @edge\/firebase functions\n/' -e '$s/$/\n\/\/ END @edge\/firebase functions/' \
+  >> ./functions/index.js;