@edgedev/firebase 1.4.2 → 1.4.4

package/README.md

@@ -242,10 +242,10 @@ 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 be a listed index by  email/user id.
+This will list all users that are members of the collection and subcollections passed to the function 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();
+const users = await edgeFirebase.listUsers("myItems");
 ```
 
 ```typescript
@@ -257,8 +257,8 @@ interface usersByEmail {
 ```typescript
 interface user {
   email: string;
-  roles: {[collectionPath: string ]: "admin" | "user"}
-  specialPermissions: {[collectionPath: string]: permissions};
+  roles: role[];
+  specialPermissions: specialPermission[];
   userId: string;
   docId: string;
   uid: string;
@@ -266,14 +266,27 @@ interface user {
 }
 ```
 
+```typescript
+interface role {
+  collectionPath: "-" | string; // - is root
+  role: "admin" | "user";
+}
+```
 
+```typescript
+interface specialPermission {
+  collectionPath: "-" | string; // - is root
+  permissions: permissions;
+}
+```
 
-### List Collections with Assign Access
-
-This function will list all collections that the user running it has assign access for. 
-
-```javascript
-const collections = await edgeFirebase.listCollectionsCanAssign();  // returns array of strings (collection paths)
+```typescript
+interface permissions {
+  assign: boolean;
+  read: boolean;
+  write: boolean;
+  delete: boolean;
+}
 ```
 
 # Firebase Authentication
@@ -302,7 +315,8 @@ interface UserDataObject {
   logInErrorMessage: string;
   meta: object;
   roles: role[]; //see role below
-  specialPermissions: specialPermission[]; //see specialPermission bleow
+  specialPermissions: specialPermission[]; //see specialPermission below
+  canAssignCollectionPaths: string[]; //an array of collectionPaths that the user has "assign" access to
 }
 
 // sub types of UserDataObject:

package/edgeFirebase.ts

@@ -92,6 +92,7 @@ interface UserDataObject {
   meta: object;
   roles: role[];
   specialPermissions: specialPermission[];
+  canAssignCollectionPaths: string[];
 }
 
 interface newUser {
@@ -103,8 +104,8 @@ interface newUser {
 
 interface user {
   email: string;
-  roles: {[collectionPath: string ]: "admin" | "user"}
-  specialPermissions: {[collectionPath: string]: permissions};
+  roles: role[];
+  specialPermissions: specialPermission[];
   userId: string;
   docId: string;
   uid: string;
@@ -209,6 +210,7 @@ export const EdgeFirebase = class {
         }
       }
       this.user.specialPermissions = specialPermissions;
+      this.listCollectionsCanAssign()
     }
     const metaUnsubscribe = onSnapshot(
       doc(this.db, "users", this.user.email),
@@ -218,7 +220,7 @@ export const EdgeFirebase = class {
             email: this.user.email,
             roles: [],
             specialPermissions: [],
-            meta: {}
+            meta: {},
           });
           this.user.meta = {};
         } else {
@@ -245,6 +247,7 @@ export const EdgeFirebase = class {
             }
           }
           this.user.specialPermissions = specialPermissions;
+          this.listCollectionsCanAssign()
         }
       }
     );
@@ -438,19 +441,28 @@ export const EdgeFirebase = class {
       newUser.specialPermissions
     );
     if (canAssignRole.canDo && canAssignSpecialPermissions.canDo) {
-      const userMeta: userMeta = {
-        docId: newUser.email,
-        userId: "",
-        email: newUser.email,
-        roles: newUser.roles,
-        specialPermissions: newUser.specialPermissions,
-        meta: newUser.meta
-      };
-      this.generateUserMeta(userMeta);
-      return this.sendResponse({
-        success: true,
-        message: ""
-      });
+      const userRef = doc(this.db, "users", newUser.email);
+      const userSnap = await getDoc(userRef);
+      if (!userSnap.exists()) {
+        const userMeta: userMeta = {
+          docId: newUser.email,
+          userId: "",
+          email: newUser.email,
+          roles: newUser.roles,
+          specialPermissions: newUser.specialPermissions,
+          meta: newUser.meta
+        };
+        this.generateUserMeta(userMeta);
+        return this.sendResponse({
+          success: true,
+          message: ""
+        });
+      } else {
+        return this.sendResponse({
+          success: false,
+          message: "User already exists"
+        });
+      }
     } else {
       return this.sendResponse({
         success: false,
@@ -715,7 +727,8 @@ export const EdgeFirebase = class {
     logInErrorMessage: "",
     meta: {},
     roles: [],
-    specialPermissions: []
+    specialPermissions: [],
+    canAssignCollectionPaths: [],
   });
 
   public getDocData = async (
@@ -988,8 +1001,7 @@ export const EdgeFirebase = class {
     }
   };
 
-  // TODO: change this function to be synced dynamically on the user object
-  public listCollectionsCanAssign = async (): Promise<string[]> => {
+  private listCollectionsCanAssign = async (): Promise<void> => {
     let collectionPaths = [];
     for (const role of this.user.roles) {
       const canAssign = await this.permissionCheck(
@@ -1033,75 +1045,71 @@ export const EdgeFirebase = class {
       }
     }
     collectionPathList = [...new Set(collectionPathList)];
-    return collectionPathList;
+    this.user.canAssignCollectionPaths = collectionPathList;
   };
 
-  // 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) {
-      const roleUsers = await getDocs(
-        query(
-          collection(this.db, "users"),
-          where(
-            "roles." + collectionPath + ".collectionPath",
-            "==",
-            collectionPath
+
+    for (const collectionPathCheck of this.user.canAssignCollectionPaths) {
+
+      if (collectionPathCheck.startsWith(collectionPath.replaceAll('/', '-'))) {
+        const roleUsers = await getDocs(
+          query(
+            collection(this.db, "users"),
+            where(
+              "roles." + collectionPathCheck + ".collectionPath",
+              "==",
+              collectionPathCheck
+            )
           )
-        )
-      );
-      roleUsers.forEach((doc) => {
-        const user = doc.data();
-        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
+        );
+            
+        roleUsers.forEach((doc) => {
+          const user = doc.data();
+          if (!Object.prototype.hasOwnProperty.call(userList, user.docId)) {
+            userList[user.email] = {
+              docId: user.docId,
+              email: user.email,
+              roles: [{collectionPathCheck, role: user.roles[collectionPathCheck].role }],
+              specialPermissions: [],
+              meta: user.meta,
+              last_updated: user.last_updated,
+              userId: user.userId,
+              uid: user.uid
+            }
+          } else {
+            userList[user.email].roles.push({ collectionPathCheck, role: user.roles[collectionPathCheck].role }) 
           }
-        } else {
-          userList[user.email].roles[collectionPath] = user.roles[collectionPath].role
-        }
-      });
-      const specialPermissionsUsers = await getDocs(
-        query(
-          collection(this.db, "users"),
-          where(
-            "specialPermissions." + collectionPath + ".collectionPath",
-            "==",
-            collectionPath
+        });
+        const specialPermissionsUsers = await getDocs(
+          query(
+            collection(this.db, "users"),
+            where(
+              "specialPermissions." + collectionPathCheck + ".collectionPath",
+              "==",
+              collectionPathCheck
+            )
           )
-        )
-      );
-      specialPermissionsUsers.forEach((doc) => {
-        const user = doc.data();
-        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
+        );
+        specialPermissionsUsers.forEach((doc) => {
+          const user = doc.data();
+          if (!Object.prototype.hasOwnProperty.call(userList, user.docId)) {
+            userList[user.email] = {
+              docId: user.docId,
+              email: user.email,
+              role: [],
+              specialPermissions: [{ collectionPathCheck, permissions: user.specialPermissions[collectionPathCheck].permissions }],
+              meta: user.meta,
+              last_updated: user.last_updated,
+              userId: user.userId,
+              uid: user.uid
+            }
+          } else {
+          userList[user.email].specialPermissions.push({ collectionPathCheck, permissions: user.specialPermissions[collectionPathCheck].permissions })
           }
-        } else {
-         userList[user.email].specialPermissions[collectionPath] = user.specialPermissions[collectionPath].permissions
-        }
-      });
+        });
+      }
     }
     return userList;
   };
@@ -1186,7 +1194,7 @@ export const EdgeFirebase = class {
     }
   };
 
-  public storeUserRoles = async (
+  private storeUserRoles = async (
     email: string,
     collectionPath: string,
     role: "admin" | "user"

package/package.json

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