@rebasepro/client-firebase 0.3.0 → 0.5.0

package/README.md

@@ -1,4 +1,98 @@
-# Rebase Firebase
+# @rebasepro/client-firebase
 
-This library provides a set of utilities to integrate [Rebase](https://rebase.pro) with 
-[Firebase](https://firebase.google.com/).
+Firebase client adapter for Rebase — connects the Rebase admin panel to Firebase (Firestore, Auth, Storage).
+
+## Installation
+
+```bash
+pnpm add @rebasepro/client-firebase
+```
+
+**Peer dependencies:** `firebase ^10.12.2 || ^11.0.0 || ^12.0.0`, `react >= 19.0.0`, `react-dom >= 19.0.0`, `typesense ^1.8.0` (optional)
+
+## What This Package Does
+
+This package provides the full Firebase integration layer for Rebase. It includes:
+
+- A top-level `RebaseFirebaseApp` component that wires up Firebase Auth, Firestore, and Storage into a complete admin app with login, routing, and data management.
+- React hooks for each Firebase service (auth, Firestore, storage, App Check, user management).
+- Text search adapters (Algolia, Pinecone, Typesense, local, Rebase-hosted).
+- Firebase login view with configurable sign-in providers.
+
+## Key Exports
+
+### Components
+
+| Export | Description |
+|---|---|
+| `RebaseFirebaseApp` | Full-featured Rebase app component backed by Firebase. Handles init, auth, routing, and rendering |
+| `RebaseFirebaseAppProps` | Props type for `RebaseFirebaseApp` — name, logo, collections, views, signInOptions, plugins, etc. |
+| `FirebaseLoginView` | Standalone Firebase login view with social sign-in buttons |
+
+### Hooks
+
+| Export | Description |
+|---|---|
+| `useInitialiseFirebase` | Initializes the Firebase app from config |
+| `useFirebaseAuthController` | Manages Firebase Auth state (sign-in, sign-out, user) |
+| `useFirestoreDriver` | Creates a Firestore-backed `DataDriver` for CRUD and realtime listeners |
+| `useFirebaseStorageSource` | Provides file upload/download via Firebase Storage |
+| `useAppCheck` | Enables Firebase App Check verification |
+| `useRecaptcha` | reCAPTCHA integration for App Check |
+| `useBuildUserManagement` | Builds a user/role management delegate from Firestore |
+| `useFirebaseAccessGate` | Evaluates whether the current user can access the admin panel |
+| `useFirebaseRealTimeDBDelegate` | Realtime Database integration |
+
+### Utils
+
+| Export | Description |
+|---|---|
+| `buildAlgoliaSearchController` | Algolia text search adapter |
+| `buildPineconeSearchController` | Pinecone text search adapter |
+| `buildRebaseSearchController` | Rebase-hosted search adapter |
+| `buildLocalTextSearchController` | Client-side fuzzy search (Fuse.js) |
+| `buildTextSearchController` | Generic text search adapter builder |
+| `buildCollectionsFromFirestore` | Auto-generate collection configs by introspecting Firestore data |
+
+### Types
+
+| Export | Description |
+|---|---|
+| `FirebaseSignInProvider` | Provider ID strings (`google.com`, `github.com`, etc.) |
+| `FirebaseSignInOption` | Sign-in config with scopes and custom parameters |
+| `FirebaseAuthController` | Extended auth controller type for Firebase |
+| `FirebaseUserWrapper` | Rebase user wrapper around Firebase User |
+| `FirestoreTextSearchControllerBuilder` | Builder type for text search controllers |
+| `AppCheckOptions` | App Check configuration type |
+
+## Quick Start
+
+```tsx
+import { RebaseFirebaseApp } from "@rebasepro/client-firebase";
+
+const firebaseConfig = {
+    apiKey: "...",
+    authDomain: "...",
+    projectId: "...",
+    storageBucket: "...",
+};
+
+export default function App() {
+    return (
+        <RebaseFirebaseApp
+            name="My Admin"
+            firebaseConfig={firebaseConfig}
+            collections={[/* your collections */]}
+            signInOptions={["google.com"]}
+        />
+    );
+}
+```
+
+## Related Packages
+
+- `@rebasepro/admin` — Admin panel UI (Scaffold, Drawer, SideDialogs)
+- `@rebasepro/core` — Core framework (Rebase provider, routing)
+- `@rebasepro/common` — Shared data utilities
+- `@rebasepro/types` — Shared type definitions
+- `@rebasepro/ui` — UI component library

package/dist/hooks/useBuildUserManagement.d.ts

@@ -1,4 +1,9 @@
-import { AuthController, DataDriver, Role, User, UserManagementDelegate } from "@rebasepro/types";
+import { AuthController, DataDriver, User, UserManagementDelegate } from "@rebasepro/types";
+export interface Role {
+    id: string;
+    name: string;
+    isAdmin?: boolean;
+}
 export interface UserManagementDelegateParams<CONTROLLER extends AuthController<User> = AuthController<User>> {
     authController: CONTROLLER;
     /**

package/dist/hooks/useFirebaseAuthController.d.ts

@@ -1,12 +1,12 @@
 import { FirebaseApp } from "@firebase/app";
 import { FirebaseAuthController, FirebaseSignInOption, FirebaseSignInProvider, FirebaseUserWrapper } from "../types";
-import { Role, User } from "@rebasepro/types";
+import type { User } from "@rebasepro/types";
 export interface FirebaseAuthControllerProps {
     loading?: boolean;
     firebaseApp?: FirebaseApp;
     signInOptions?: Array<FirebaseSignInProvider | FirebaseSignInOption>;
     onSignOut?: () => void;
-    defineRolesFor?: (user: User) => Promise<Role[] | undefined> | Role[] | undefined;
+    defineRolesFor?: (user: User) => Promise<string[] | undefined> | string[] | undefined;
 }
 /**
  * Use this hook to build an {@link AuthController} based on Firebase Auth

package/dist/index.es.js

@@ -34,9 +34,7 @@ const useFirebaseAuthController = ({
   const [userRoles, _setUserRoles] = useState();
   const [extra, setExtra] = useState();
   const setUserRoles = useCallback((roles) => {
-    const currentRoleIds = userRoles?.map((r) => r.id);
-    const newRoleIds = roles?.map((r_0) => r_0.id);
-    if (!deepEqual(currentRoleIds, newRoleIds)) {
+    if (!deepEqual(userRoles, roles)) {
       _setUserRoles(roles);
     }
   }, [userRoles]);
@@ -224,8 +222,7 @@ const useFirebaseAuthController = ({
   }, []);
   const firebaseUserWrapper = loggedUser ? {
     ...loggedUser,
-    roles: userRoles?.map((r_1) => r_1.id),
-    // User.roles is string[], keep Role[] internally only
+    roles: userRoles,
     firebaseUser: loggedUser
   } : null;
   return {
@@ -614,7 +611,8 @@ function normalizePropertiesEnumValues(properties, sortObjectFormat = false) {
       if (normalizedProperty.enum) {
         normalizedProperty.enum = normalizeEnumValuesToArray(normalizedProperty.enum, sortObjectFormat);
       }
-      if (normalizedProperty.dataType === "array" && typeof normalizedProperty.of === "object" && normalizedProperty.of !== null) {
+      const propType = normalizedProperty.type ?? normalizedProperty.dataType;
+      if (propType === "array" && typeof normalizedProperty.of === "object" && normalizedProperty.of !== null) {
         const ofProp = normalizedProperty.of;
         if (ofProp.enum) {
           normalizedProperty.of = {
@@ -623,7 +621,7 @@ function normalizePropertiesEnumValues(properties, sortObjectFormat = false) {
           };
         }
       }
-      if (normalizedProperty.dataType === "map" && normalizedProperty.properties) {
+      if (propType === "map" && normalizedProperty.properties) {
         normalizedProperty.properties = normalizePropertiesEnumValues(normalizedProperty.properties, sortObjectFormat);
       }
       result[key] = normalizedProperty;
@@ -2024,8 +2022,8 @@ function useBuildUserManagement({
     if (!usersWithRoleIds) throw Error("Users not loaded");
     const mgmtUser = usersWithRoleIds.find((u_1) => u_1.email?.toLowerCase() === user_1?.email?.toLowerCase());
     if (!mgmtUser || !mgmtUser.roles) return void 0;
-    return roles.filter((r) => mgmtUser.roles.includes(r.id));
-  }, [roles, usersWithRoleIds]);
+    return mgmtUser.roles;
+  }, [usersWithRoleIds]);
   const accessGate = useCallback(({
     user: user_2
   }) => {
@@ -2065,8 +2063,8 @@ function useBuildUserManagement({
     throw Error("Could not find a user with the provided email in the user management system.");
   }, [loading, users]);
   const userRoles = authController.user ? defineRolesFor(authController.user) : void 0;
-  const isAdmin = (userRoles ?? []).some((r_0) => r_0.id === "admin");
-  const userRoleIds = userRoles?.map((r_1) => r_1.id);
+  const isAdmin = (userRoles ?? []).some((r) => r === "admin");
+  const userRoleIds = userRoles;
   useEffect(() => {
     console.debug("Setting user roles", {
       userRoles,