@firecms/user_management 3.0.0-canary.84 → 3.0.0-canary.86

package/dist/hooks/index.d.ts

@@ -1,2 +1,2 @@
-export * from "./useFirestoreUserManagement";
+export * from "./useBuildUserManagement";
 export * from "./useUserManagement";

package/dist/hooks/{useFirestoreUserManagement.d.ts → useBuildUserManagement.d.ts}

@@ -1,17 +1,16 @@
-import { FirebaseApp } from "@firebase/app";
 import { UserManagement } from "../types";
+import { DataSourceDelegate } from "@firecms/core";
 export interface UserManagementParams {
     /**
-     * The Firebase app to use for the user management. The config will be saved in the Firestore
-     * collection indicated by `configPath`.
+     * The delegate in charge of persisting the data.
      */
-    firebaseApp?: FirebaseApp;
+    dataSourceDelegate?: DataSourceDelegate;
     /**
      * Path where the plugin users configuration is stored.
      * Default: __FIRECMS/config/users
      * You can specify a different path if you want to store the user management configuration in a different place.
      * Please keep in mind that the FireCMS users are not necessarily the same as the Firebase users (but they can be).
-     * The path should be relative to the root of the Firestore database, and should always have an odd number of segments.
+     * The path should be relative to the root of the database, and should always have an odd number of segments.
      */
     usersPath?: string;
     /**
@@ -39,10 +38,12 @@ export interface UserManagementParams {
 /**
  * This hook is used to build a user management object that can be used to
  * manage users and roles in a Firestore backend.
- * @param backendFirebaseApp
+ * @param dataSourceDelegate
  * @param usersPath
  * @param rolesPath
  * @param usersLimit
  * @param canEditRoles
+ * @param allowDefaultRolesCreation
+ * @param includeCollectionConfigPermissions
  */
-export declare function useFirestoreUserManagement({ firebaseApp, usersPath, rolesPath, usersLimit, canEditRoles, allowDefaultRolesCreation, includeCollectionConfigPermissions }: UserManagementParams): UserManagement;
+export declare function useBuildUserManagement({ dataSourceDelegate, usersPath, rolesPath, usersLimit, canEditRoles, allowDefaultRolesCreation, includeCollectionConfigPermissions }: UserManagementParams): UserManagement;

package/dist/index.es.js

@@ -1,5 +1,5 @@
 import React, { useEffect, useCallback, useContext, useState } from "react";
-import { getFirestore, onSnapshot, collection, setDoc, doc, addDoc, deleteDoc } from "@firebase/firestore";
+import equal from "react-fast-compare";
 import { jsx, jsxs, Fragment } from "react/jsx-runtime";
 import { getColorSchemeForSeed, Chip, Dialog, DialogContent, Typography, TextField, Paper, Table, TableHeader, TableCell, TableBody, TableRow, Tooltip, Checkbox, Select, SelectItem, DialogActions, Button, LoadingButton, DoneIcon, IconButton, DeleteIcon, CenteredView, Container, AddIcon, MultiSelect, MultiSelectItem } from "@firecms/ui";
 import * as Yup from "yup";
@@ -15,13 +15,13 @@ const DEFAULT_PERMISSIONS = {
   delete: false
 };
 function resolveUserRolePermissions({
-  collection: collection2,
+  collection,
   user
 }) {
   const roles = user?.roles;
   if (!roles) {
     return DEFAULT_PERMISSIONS;
-  } else if (collection2.ownerId === user?.uid) {
+  } else if (collection.ownerId === user?.uid) {
     return {
       read: true,
       create: true,
@@ -35,7 +35,7 @@ function resolveUserRolePermissions({
       edit: false,
       delete: false
     };
-    return roles.map((role) => resolveCollectionRole(role, collection2.id)).reduce(mergePermissions, basePermissions);
+    return roles.map((role) => resolveCollectionRole(role, collection.id)).reduce(mergePermissions, basePermissions);
   }
 }
 function resolveCollectionRole(role, id) {
@@ -140,8 +140,8 @@ function hexToRgbaWithOpacity(hexColor, opacity = 10) {
   const alpha = opacity / 100;
   return `rgba(${r}, ${g}, ${b}, ${alpha})`;
 }
-function useFirestoreUserManagement({
-  firebaseApp,
+function useBuildUserManagement({
+  dataSourceDelegate,
   usersPath = "__FIRECMS/config/users",
   rolesPath = "__FIRECMS/config/roles",
   usersLimit,
@@ -161,59 +161,56 @@ function useFirestoreUserManagement({
   const [usersError, setUsersError] = React.useState();
   const loading = rolesLoading || usersLoading;
   useEffect(() => {
-    if (!firebaseApp || !rolesPath) return;
-    const firestore = getFirestore(firebaseApp);
-    return onSnapshot(
-      collection(firestore, rolesPath),
-      {
-        next: (snapshot) => {
-          setRolesError(void 0);
-          try {
-            const newRoles = docsToRoles(snapshot.docs);
+    if (!dataSourceDelegate || !rolesPath) return;
+    if (dataSourceDelegate.initialised !== void 0 && !dataSourceDelegate.initialised) return;
+    return dataSourceDelegate.listenCollection?.({
+      path: rolesPath,
+      onUpdate(entities) {
+        setRolesError(void 0);
+        try {
+          const newRoles = entityToRoles(entities);
+          if (!equal(newRoles, roles))
             setRoles(newRoles);
-          } catch (e) {
-            console.error("Error loading roles", e);
-            setRolesError(e);
-          }
-          setRolesLoading(false);
-        },
-        error: (e) => {
+        } catch (e) {
           console.error("Error loading roles", e);
           setRolesError(e);
-          setRolesLoading(false);
         }
+        setRolesLoading(false);
+      },
+      onError(e) {
+        console.error("Error loading roles", e);
+        setRolesError(e);
+        setRolesLoading(false);
       }
-    );
-  }, [firebaseApp, rolesPath]);
+    });
+  }, [dataSourceDelegate, rolesPath]);
   useEffect(() => {
-    if (!firebaseApp || !usersPath) return;
-    const firestore = getFirestore(firebaseApp);
-    return onSnapshot(
-      collection(firestore, usersPath),
-      {
-        next: (snapshot) => {
-          setUsersError(void 0);
-          try {
-            const newUsers = docsToUsers(snapshot.docs);
+    if (!dataSourceDelegate || !usersPath) return;
+    if (dataSourceDelegate.initialised !== void 0 && !dataSourceDelegate.initialised) return;
+    return dataSourceDelegate.listenCollection?.({
+      path: usersPath,
+      onUpdate(entities) {
+        setUsersError(void 0);
+        try {
+          const newUsers = entitiesToUsers(entities);
+          if (!equal(newUsers, usersWithRoleIds))
             setUsersWithRoleIds(newUsers);
-          } catch (e) {
-            console.error("Error loading users", e);
-            setUsersError(e);
-          }
-          setUsersLoading(false);
-        },
-        error: (e) => {
+        } catch (e) {
           console.error("Error loading users", e);
           setUsersError(e);
-          setUsersLoading(false);
         }
+        setUsersLoading(false);
+      },
+      onError(e) {
+        console.error("Error loading users", e);
+        setUsersError(e);
+        setUsersLoading(false);
       }
-    );
-  }, [firebaseApp, usersPath]);
+    });
+  }, [dataSourceDelegate, usersPath]);
   const saveUser = useCallback(async (user) => {
-    if (!firebaseApp) throw Error("useFirestoreUserManagement Firebase not initialised");
-    const firestore = getFirestore(firebaseApp);
-    if (!firestore || !usersPath) throw Error("useFirestoreUserManagement Firestore not initialised");
+    if (!dataSourceDelegate) throw Error("useBuildUserManagement Firebase not initialised");
+    if (!usersPath) throw Error("useBuildUserManagement Firestore not initialised");
     console.debug("Persisting user", user);
     const roleIds = user.roles?.map((r) => r.id);
     const {
@@ -225,45 +222,66 @@ function useFirestoreUserManagement({
       roles: roleIds
     };
     if (uid) {
-      return setDoc(doc(firestore, usersPath, uid), data, { merge: true }).then(() => user);
+      return dataSourceDelegate.saveEntity({
+        status: "existing",
+        path: usersPath,
+        entityId: uid,
+        values: data
+      }).then(() => user);
     } else {
-      return addDoc(collection(firestore, usersPath), data).then(() => user);
+      return dataSourceDelegate.saveEntity({
+        status: "new",
+        path: usersPath,
+        values: data
+      }).then(() => user);
     }
-  }, [usersPath, firebaseApp]);
+  }, [usersPath, dataSourceDelegate]);
   const saveRole = useCallback((role) => {
-    if (!firebaseApp) throw Error("useFirestoreUserManagement Firebase not initialised");
-    const firestore = getFirestore(firebaseApp);
-    if (!firestore || !rolesPath) throw Error("useFirestoreUserManagement Firestore not initialised");
+    if (!dataSourceDelegate) throw Error("useBuildUserManagement Firebase not initialised");
+    if (!rolesPath) throw Error("useBuildUserManagement Firestore not initialised");
     console.debug("Persisting role", role);
     const {
       id,
       ...roleData
     } = role;
-    const ref = doc(firestore, rolesPath, id);
-    return setDoc(ref, roleData, { merge: true });
-  }, [rolesPath, firebaseApp]);
+    return dataSourceDelegate.saveEntity({
+      status: "existing",
+      path: rolesPath,
+      entityId: id,
+      values: roleData
+    }).then(() => {
+      return;
+    });
+  }, [rolesPath, dataSourceDelegate]);
   const deleteUser = useCallback(async (user) => {
-    if (!firebaseApp) throw Error("useFirestoreUserManagement Firebase not initialised");
-    const firestore = getFirestore(firebaseApp);
-    if (!firestore || !usersPath) throw Error("useFirestoreUserManagement Firestore not initialised");
+    if (!dataSourceDelegate) throw Error("useBuildUserManagement Firebase not initialised");
+    if (!usersPath) throw Error("useBuildUserManagement Firestore not initialised");
     console.debug("Deleting", user);
     const { uid } = user;
-    return deleteDoc(doc(firestore, usersPath, uid));
-  }, [usersPath, firebaseApp]);
-  const deleteRole = useCallback((role) => {
-    if (!firebaseApp) throw Error("useFirestoreUserManagement Firebase not initialised");
-    const firestore = getFirestore(firebaseApp);
-    if (!firestore || !rolesPath) throw Error("useFirestoreUserManagement Firestore not initialised");
+    const entity = {
+      path: usersPath,
+      id: uid,
+      values: {}
+    };
+    await dataSourceDelegate.deleteEntity({ entity });
+  }, [usersPath, dataSourceDelegate]);
+  const deleteRole = useCallback(async (role) => {
+    if (!dataSourceDelegate) throw Error("useBuildUserManagement Firebase not initialised");
+    if (!rolesPath) throw Error("useBuildUserManagement Firestore not initialised");
     console.debug("Deleting", role);
     const { id } = role;
-    const ref = doc(firestore, rolesPath, id);
-    return deleteDoc(ref);
-  }, [rolesPath, firebaseApp]);
+    const entity = {
+      path: usersPath,
+      id,
+      values: {}
+    };
+    await dataSourceDelegate.deleteEntity({ entity });
+  }, [rolesPath, dataSourceDelegate]);
   const collectionPermissions = useCallback(({
-    collection: collection2,
+    collection,
     user
   }) => resolveUserRolePermissions({
-    collection: collection2,
+    collection,
     user
   }), []);
   const defineRolesFor = useCallback((user) => {
@@ -307,22 +325,22 @@ function useFirestoreUserManagement({
     authenticator
   };
 }
-const docsToUsers = (docs) => {
-  return docs.map((doc2) => {
-    const data = doc2.data();
+const entitiesToUsers = (docs) => {
+  return docs.map((doc) => {
+    const data = doc.values;
     const newVar = {
-      uid: doc2.id,
+      uid: doc.id,
       ...data,
-      created_on: data?.created_on?.toDate(),
-      updated_on: data?.updated_on?.toDate()
+      created_on: data?.created_on,
+      updated_on: data?.updated_on
     };
     return newVar;
   });
 };
-const docsToRoles = (docs) => {
-  return docs.map((doc2) => ({
-    id: doc2.id,
-    ...doc2.data()
+const entityToRoles = (entities) => {
+  return entities.map((doc) => ({
+    id: doc.id,
+    ...doc.values
   }));
 };
 const UserManagementContext = React.createContext({});
@@ -1519,7 +1537,7 @@ export {
   getUserRoles,
   hexToRgbaWithOpacity,
   resolveUserRolePermissions,
-  useFirestoreUserManagement,
+  useBuildUserManagement,
   useUserManagement,
   useUserManagementPlugin,
   userManagementAdminViews