@edgedev/firebase 1.3.3 → 1.4.2

package/README.md

@@ -242,23 +242,23 @@ edgeFirebase.removeUser("user@edgemarketingdesign.com");
 
 ### List Users
 
-This will list all users that are members of collections that the user running the function has assign access for, it will list them grouped by collections.
+This will list all users that are members of collections that the user running the function has assign access for, it will be a listed index by  email/user id.
 
 ```javascript
 const users = await edgeFirebase.listUsers();
 ```
 
 ```typescript
-interface usersByCollection {
-  [collectionPath: string]: [user];
+interface usersByEmail {
+  [email: string]: [user];
 }
 ```
 
 ```typescript
 interface user {
   email: string;
-  role: "admin" | "user" | null;
-  specialPermission: permissions | null;
+  roles: {[collectionPath: string ]: "admin" | "user"}
+  specialPermissions: {[collectionPath: string]: permissions};
   userId: string;
   docId: string;
   uid: string;
@@ -372,6 +372,30 @@ This function allows a user to change their current password while logged in:
 edgeFirebase.setPassword("old-password", "new-password");
 ```
 
+### Password Reset:
+
+For users not logged in (like forgotten password).  This is a two step process if the project is setup to redirect password resets back to a custom password reset page.
+
+Step 1:
+
+```javascript
+edgeFirebase.sendPasswordReset('user@edgemarketingdesign.com');
+```
+
+Step 2: (If the password redirect is setup to go a custom page, you'll need to pull the "oobCode" from the query string and pass that along with the newpassword.)
+
+```javascript
+edgeFirebase.passwordReset('NewPassword123','AAaaAABaaaaAAABBBaaaBBBBAaaaaBABAbbaa');
+```
+
+### Update User Meta:
+
+A user can update their own meta data when logged in.  The object contain meta data will only update/add the keys passed in the object.
+
+```javascript
+edgeFirebase.setUserMeta({ lastName: "Smith" });
+```
+
 # Firestore Basic Document Interactions
 
 ### Adding/Update a Document.

package/edgeFirebase.ts

@@ -36,7 +36,9 @@ import {
   createUserWithEmailAndPassword,
   updatePassword,
   reauthenticateWithCredential,
-  EmailAuthProvider
+  EmailAuthProvider,
+  sendPasswordResetEmail,
+  confirmPasswordReset
 } from "firebase/auth";
 
 interface FirestoreQuery {
@@ -76,8 +78,6 @@ interface role {
   role: "admin" | "user";
 }
 
-// TODO: PASSWORD RESET FUNCTION <-- NOT LOGGED IN,  AND USER META UPDATE FUNCTION (ONLY FOR THEMSELVES)
-
 interface specialPermission {
   collectionPath: "-" | string; // - is root
   permissions: permissions;
@@ -103,16 +103,16 @@ interface newUser {
 
 interface user {
   email: string;
-  role: "admin" | "user" | null;
-  specialPermission: permissions | null;
+  roles: {[collectionPath: string ]: "admin" | "user"}
+  specialPermissions: {[collectionPath: string]: permissions};
   userId: string;
   docId: string;
   uid: string;
   last_updated: Date;
 }
 
-interface usersByCollection {
-  [collectionPath: string]: [user];
+interface usersByEmail {
+  [email: string]: [user];
 }
 interface userMeta extends newUser {
   docId: string;
@@ -314,6 +314,40 @@ export const EdgeFirebase = class {
     }
   };
 
+  public sendPasswordReset = async (email: string): Promise<actionResponse> => {
+    try {
+      await sendPasswordResetEmail(this.auth, email);
+      return this.sendResponse({
+        success: true,
+        message: ""
+      });
+    } catch (error) {
+      return this.sendResponse({
+        success: false,
+        message: error.message
+      });
+    }
+  };
+
+  public passwordReset = async (
+    password: string,
+    oobCode: string
+  ): Promise<actionResponse> => {
+    try {
+      // await verifyPasswordResetCode(this.auth, oobCode);
+      await confirmPasswordReset(this.auth, oobCode, password);
+      return this.sendResponse({
+        success: true,
+        message: ""
+      });
+    } catch (error) {
+      return this.sendResponse({
+        success: false,
+        message: error.message
+      });
+    }
+  };
+
   public setPassword = async (
     oldpassword: string,
     password: string
@@ -338,6 +372,18 @@ export const EdgeFirebase = class {
     }
   };
 
+  setUserMeta = async (meta: unknown): Promise<actionResponse> => {
+    for (const [key, value] of Object.entries(meta)) {
+      await updateDoc(doc(this.db, "users/" + this.user.email), {
+        ["meta." + key]: value
+      });
+    }
+    return this.sendResponse({
+      success: true,
+      message: ""
+    });
+  };
+
   public removeUser = async (email: string): Promise<actionResponse> => {
     const removedFrom = [];
     const userRef = doc(this.db, "users", email);
@@ -942,6 +988,7 @@ export const EdgeFirebase = class {
     }
   };
 
+  // TODO: change this function to be synced dynamically on the user object
   public listCollectionsCanAssign = async (): Promise<string[]> => {
     let collectionPaths = [];
     for (const role of this.user.roles) {
@@ -989,11 +1036,18 @@ export const EdgeFirebase = class {
     return collectionPathList;
   };
 
-  public listUsers = async (): Promise<usersByCollection> => {
+  // TODO: finish making this query by collectionPath if passed.. in furture will be used to get users by collectionPath
+  // because having one giant list of users is not scalable
+  public listUsers = async (collectionPath = ''): Promise<usersByEmail> => {
     const userList = {};
+    if (collectionPath) {
+      const canAssign = await this.permissionCheck("assign", collectionPath);
+      if (!canAssign) {
+        return {}
+      }
+    }
     const collectionPathList = await this.listCollectionsCanAssign();
     for (const collectionPath of collectionPathList) {
-      userList[collectionPath] = [];
       const roleUsers = await getDocs(
         query(
           collection(this.db, "users"),
@@ -1006,16 +1060,20 @@ export const EdgeFirebase = class {
       );
       roleUsers.forEach((doc) => {
         const user = doc.data();
-        userList[collectionPath].push({
-          docId: user.docId,
-          email: user.email,
-          role: user.roles[collectionPath].role,
-          specialPermission: null,
-          meta: user.meta,
-          last_updated: user.last_updated,
-          userId: user.userId,
-          uid: user.uid
-        });
+        if (!Object.prototype.hasOwnProperty.call(userList, user.docId)) {
+          userList[user.email] = {
+            docId: user.docId,
+            email: user.email,
+            roles: {[collectionPath]: user.roles[collectionPath].role },
+            specialPermissions: {},
+            meta: user.meta,
+            last_updated: user.last_updated,
+            userId: user.userId,
+            uid: user.uid
+          }
+        } else {
+          userList[user.email].roles[collectionPath] = user.roles[collectionPath].role
+        }
       });
       const specialPermissionsUsers = await getDocs(
         query(
@@ -1029,17 +1087,20 @@ export const EdgeFirebase = class {
       );
       specialPermissionsUsers.forEach((doc) => {
         const user = doc.data();
-        userList[collectionPath].push({
-          docId: user.docId,
-          email: user.email,
-          role: null,
-          specialPermission:
-            user.specialPermissions[collectionPath].permissions,
-          meta: user.meta,
-          last_updated: user.last_updated,
-          userId: user.userId,
-          uid: user.uid
-        });
+        if (!Object.prototype.hasOwnProperty.call(userList, user.docId)) {
+          userList[user.email] = {
+            docId: user.docId,
+            email: user.email,
+            role: {},
+            specialPermissions: {[collectionPath]: user.specialPermissions[collectionPath].permissions},
+            meta: user.meta,
+            last_updated: user.last_updated,
+            userId: user.userId,
+            uid: user.uid
+          }
+        } else {
+         userList[user.email].specialPermissions[collectionPath] = user.specialPermissions[collectionPath].permissions
+        }
       });
     }
     return userList;

package/package.json

@@ -1,8 +1,11 @@
 {
   "name": "@edgedev/firebase",
-  "version": "1.3.3",
+  "version": "1.4.2",
   "description": "Vue 3 / Nuxt 3 Plugin or Nuxt 3 global composable for firebase authentication and firestore.",
   "main": "index.ts",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
   "author": "Seth Fischer",
   "keywords": [
     "firebase authentication",
@@ -32,8 +35,5 @@
   "peerDependencies": {
     "firebase": "^9.12.1",
     "vue": "^3.0.0"
-  },
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
   }
-}
+}