@rebasepro/client-firebase 0.4.0 → 0.6.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/components/FirebaseLoginView.d.ts

@@ -63,10 +63,10 @@ export interface FirebaseLoginViewProps {
 
  * @category Firebase
  */
-export declare function FirebaseLoginView({ children, allowSkipLogin, logo, signInOptions, firebaseApp, authController, noUserComponent, disableSignupScreen, disableResetPassword, disabled, additionalComponent, notAllowedError, className }: FirebaseLoginViewProps): import("react/jsx-runtime").JSX.Element;
+export declare function FirebaseLoginView({ children, allowSkipLogin, logo, signInOptions, firebaseApp, authController, noUserComponent, disableSignupScreen, disableResetPassword, disabled, additionalComponent, notAllowedError, className }: FirebaseLoginViewProps): React.JSX.Element;
 export declare function LoginButton({ icon, onClick, text, disabled }: {
     icon: React.ReactNode;
     onClick: () => void;
     text: string;
     disabled?: boolean;
-}): import("react/jsx-runtime").JSX.Element;
+}): React.JSX.Element;

package/dist/components/RebaseFirebaseApp.d.ts

@@ -1,3 +1,4 @@
+import React from "react";
 import { RebaseFirebaseAppProps } from "./RebaseFirebaseAppProps";
 /**
  * This is the default implementation of a Rebase app using the Firebase services
@@ -16,4 +17,4 @@ import { RebaseFirebaseAppProps } from "./RebaseFirebaseAppProps";
 
  * @category Firebase
  */
-export declare function RebaseFirebaseApp({ name, logo, logoDark, accessGate, collections, views, adminViews, textSearchControllerBuilder, allowSkipLogin, signInOptions, firebaseConfig, onFirebaseInit, appCheckOptions, dateTimeFormat, locale, basePath, baseCollectionPath, onAnalyticsEvent, propertyConfigs: propertyConfigsProp, plugins, autoOpenDrawer, firestoreIndexesBuilder, components, localTextSearchEnabled, userManagement }: RebaseFirebaseAppProps): import("react/jsx-runtime").JSX.Element;
+export declare function RebaseFirebaseApp({ name, logo, logoDark, accessGate, collections, views, adminViews, textSearchControllerBuilder, allowSkipLogin, signInOptions, firebaseConfig, onFirebaseInit, appCheckOptions, dateTimeFormat, locale, basePath, baseCollectionPath, onAnalyticsEvent, propertyConfigs: propertyConfigsProp, plugins, autoOpenDrawer, firestoreIndexesBuilder, components, localTextSearchEnabled }: RebaseFirebaseAppProps): React.JSX.Element;

package/dist/components/RebaseFirebaseAppProps.d.ts

@@ -1,7 +1,6 @@
 import React from "react";
 import { AnalyticsEvent, AppView, AppViewsBuilder, EntityCollection, EntityCollectionsBuilder, RebasePlugin, Locale, PropertyConfig } from "@rebasepro/types";
 import { FirebaseAccessGate } from "../hooks/useFirebaseAccessGate";
-import { UserManagementDelegate } from "@rebasepro/types";
 import { FirebaseApp } from "@firebase/app";
 import { FirebaseLoginViewProps } from "./FirebaseLoginView";
 import { AppCheckOptions, FirebaseSignInOption, FirebaseSignInProvider, FirebaseUserWrapper, FirestoreTextSearchControllerBuilder } from "../types";
@@ -128,10 +127,6 @@ export type RebaseFirebaseAppProps = {
     firestoreIndexesBuilder?: FirestoreIndexesBuilder;
     localTextSearchEnabled?: boolean;
     components?: ComponentsRegistry;
-    /**
-     * Delegate for user and role management. Provides the admin views if specified.
-     */
-    userManagement?: UserManagementDelegate<FirebaseUserWrapper>;
 };
 export type ComponentsRegistry = {
     /**

package/dist/components/social_icons.d.ts

@@ -1,6 +1,6 @@
-export declare const googleIcon: (mode: "light" | "dark") => import("react/jsx-runtime").JSX.Element;
-export declare const appleIcon: (mode: "light" | "dark") => import("react/jsx-runtime").JSX.Element;
-export declare const githubIcon: (mode: "light" | "dark") => import("react/jsx-runtime").JSX.Element;
-export declare const facebookIcon: (mode: "light" | "dark") => import("react/jsx-runtime").JSX.Element;
-export declare const microsoftIcon: (mode: "light" | "dark") => import("react/jsx-runtime").JSX.Element;
-export declare const twitterIcon: (mode: "light" | "dark") => import("react/jsx-runtime").JSX.Element;
+export declare const googleIcon: (mode: "light" | "dark") => import("react").JSX.Element;
+export declare const appleIcon: (mode: "light" | "dark") => import("react").JSX.Element;
+export declare const githubIcon: (mode: "light" | "dark") => import("react").JSX.Element;
+export declare const facebookIcon: (mode: "light" | "dark") => import("react").JSX.Element;
+export declare const microsoftIcon: (mode: "light" | "dark") => import("react").JSX.Element;
+export declare const twitterIcon: (mode: "light" | "dark") => import("react").JSX.Element;

package/dist/hooks/useBuildUserManagement.d.ts

@@ -1,4 +1,5 @@
-import { AuthController, DataDriver, User, UserManagementDelegate } from "@rebasepro/types";
+import { AuthController, DataDriver, User } from "@rebasepro/types";
+import { FirebaseAccessGate } from "./useFirebaseAccessGate";
 export interface Role {
     id: string;
     name: string;
@@ -43,4 +44,34 @@ export interface UserManagementDelegateParams<CONTROLLER extends AuthController<
  * @param roles
  * @param allowDefaultRolesCreation
  */
-export declare function useBuildUserManagement<CONTROLLER extends AuthController<User> = AuthController<User>, USER extends User = CONTROLLER extends AuthController<infer U> ? U : User>({ authController, dataSourceDelegate, roles: rolesProp, usersPath, rolesPath, allowDefaultRolesCreation }: UserManagementDelegateParams<CONTROLLER>): UserManagementDelegate<USER> & CONTROLLER;
+export declare function useBuildUserManagement<CONTROLLER extends AuthController<User> = AuthController<User>, USER extends User = CONTROLLER extends AuthController<infer U> ? U : User>({ authController, dataSourceDelegate, roles: rolesProp, usersPath, rolesPath, allowDefaultRolesCreation }: UserManagementDelegateParams<CONTROLLER>): {
+    loading: boolean;
+    roles: Role[];
+    users: USER[];
+    saveUser: (user: USER) => Promise<USER>;
+    saveRole: (role: Role) => Promise<void>;
+    rolesError: Error | undefined;
+    deleteUser: (user: User) => Promise<void>;
+    deleteRole: (role: Role) => Promise<void>;
+    usersError: Error | undefined;
+    isAdmin: boolean;
+    allowDefaultRolesCreation: boolean;
+    defineRolesFor: (user: User) => string[] | undefined;
+    accessGate: FirebaseAccessGate<USER>;
+} & CONTROLLER & {
+    initialLoading: boolean;
+    userRoles: string[] | undefined;
+    getUser: (uid: string) => USER | null;
+    user: {
+        roles: string[] | undefined;
+        uid: string;
+        displayName: string | null;
+        email: string | null;
+        photoURL: string | null;
+        providerId: string;
+        isAnonymous: boolean;
+        createdAt?: Date | string | null;
+        metadata?: Record<string, any>;
+        getIdToken?: (forceRefresh?: boolean) => Promise<string>;
+    } | null;
+};