@rebasepro/client-firebase 0.0.1-canary.4d4fb3e → 0.0.1-canary.ca2cb6e

package/dist/components/RebaseFirebaseAppProps.d.ts

@@ -130,7 +130,7 @@ export type RebaseFirebaseAppProps = {
     /**
      * Delegate for user and role management. Provides the admin views if specified.
      */
-    userManagement?: UserManagementDelegate;
+    userManagement?: UserManagementDelegate<FirebaseUserWrapper>;
 };
 export type ComponentsRegistry = {
     /**

package/dist/hooks/index.d.ts

@@ -5,3 +5,4 @@ export * from "./useAppCheck";
 export * from "./useFirestoreDriver";
 export * from "./useFirebaseRealTimeDBDelegate";
 export * from "./useRecaptcha";
+export * from "./useBuildUserManagement";

package/dist/hooks/useAppCheck.d.ts

@@ -17,4 +17,4 @@ export interface InitializeAppCheckResult {
  *
  * @group Firebase
  */
-export declare function useAppCheck({ firebaseApp, options, }: InitializeAppCheckProps): InitializeAppCheckResult;
+export declare function useAppCheck({ firebaseApp, options }: InitializeAppCheckProps): InitializeAppCheckResult;

package/dist/hooks/useBuildUserManagement.d.ts

@@ -0,0 +1,46 @@
+import { AuthController, DataDriver, Role, User, UserManagementDelegate } from "@rebasepro/types";
+export interface UserManagementDelegateParams<CONTROLLER extends AuthController<any> = AuthController<any>> {
+    authController: CONTROLLER;
+    /**
+     * The delegate in charge of persisting the data.
+     */
+    dataSourceDelegate?: DataDriver;
+    /**
+     * 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 database, and should always have an odd number of segments.
+     */
+    usersPath?: string;
+    /**
+     * Path where the plugin roles configuration is stored.
+     * Default: __FIRECMS/config/roles
+     */
+    rolesPath?: string;
+    /**
+     * The roles that are available in the user management system.
+     * If you provide this, the user management system will not fetch the roles from the database.
+     */
+    roles?: Role[];
+    /**
+     * If there are no roles in the database, provide a button to create the default roles.
+     */
+    allowDefaultRolesCreation?: boolean;
+    /**
+     * Include the collection config permissions in the user management system.
+     */
+    includeCollectionConfigPermissions?: boolean;
+}
+/**
+ * This hook is used to build a user management object that can be used to
+ * manage users and roles in a Firestore backend.
+ * @param authController
+ * @param dataSourceDelegate
+ * @param usersPath
+ * @param rolesPath
+ * @param roles
+ * @param allowDefaultRolesCreation
+ * @param includeCollectionConfigPermissions
+ */
+export declare function useBuildUserManagement<CONTROLLER extends AuthController<any> = AuthController<any>, USER extends User = CONTROLLER extends AuthController<infer U> ? U : any>({ authController, dataSourceDelegate, roles: rolesProp, usersPath, rolesPath, allowDefaultRolesCreation, includeCollectionConfigPermissions }: UserManagementDelegateParams<CONTROLLER>): UserManagementDelegate<USER> & CONTROLLER;