@rebasepro/client-firebase 0.7.0 → 0.9.0

package/dist/types/text_search.d.ts

@@ -1,6 +1,6 @@
 import { User as FirebaseUser } from "@firebase/auth";
 import { FirebaseApp } from "@firebase/app";
-import { EntityCollection } from "@rebasepro/types";
+import { CollectionConfig } from "@rebasepro/types";
 export type FirestoreTextSearchControllerBuilder = (props: {
     firebaseApp: FirebaseApp;
 }) => FirestoreTextSearchController;
@@ -23,7 +23,7 @@ export type FirestoreTextSearchController = {
     init: (props: {
         path: string;
         databaseId?: string;
-        collection?: EntityCollection;
+        collection?: CollectionConfig;
     }) => Promise<boolean>;
     /**
      * Do the search and return a list of ids.
@@ -34,6 +34,6 @@ export type FirestoreTextSearchController = {
         path: string;
         currentUser?: FirebaseUser;
         databaseId?: string;
-        collection?: EntityCollection;
+        collection?: CollectionConfig;
     }) => (Promise<readonly string[] | undefined>);
 };

package/dist/utils/collections_firestore.d.ts

@@ -1,5 +1,5 @@
 import { DocumentSnapshot } from "@firebase/firestore";
-import { EntityCollection } from "@rebasepro/types";
+import { CollectionConfig } from "@rebasepro/types";
 export declare function buildCollectionId(idOrPath: string, parentCollectionSlugs?: string[], parentEntityIds?: string[]): string;
-export declare const docsToCollectionTree: (docs: DocumentSnapshot[]) => EntityCollection[];
-export declare const docToCollection: (doc: DocumentSnapshot) => EntityCollection;
+export declare const docsToCollectionTree: (docs: DocumentSnapshot[]) => CollectionConfig[];
+export declare const docToCollection: (doc: DocumentSnapshot) => CollectionConfig;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@rebasepro/client-firebase",
   "type": "module",
-  "version": "0.7.0",
+  "version": "0.9.0",
   "publishConfig": {
     "access": "public"
   },
@@ -10,16 +10,15 @@
   "types": "./dist/index.d.ts",
   "source": "src/index.ts",
   "dependencies": {
-    "@firebase/auth": "^1.13.2",
-    "@rebasepro/admin": "workspace:*",
-    "@rebasepro/common": "workspace:*",
-    "@rebasepro/core": "workspace:*",
-    "@rebasepro/types": "workspace:*",
-    "@rebasepro/ui": "workspace:*",
-    "@rebasepro/utils": "workspace:*",
     "fast-equals": "6.0.0",
     "fuse.js": "^7.4.2",
-    "react-router-dom": "^7.17.0"
+    "react-router-dom": "^7.17.0",
+    "@rebasepro/core": "0.9.0",
+    "@rebasepro/types": "0.9.0",
+    "@rebasepro/common": "0.9.0",
+    "@rebasepro/utils": "0.9.0",
+    "@rebasepro/ui": "0.9.0",
+    "@rebasepro/admin": "0.9.0"
   },
   "peerDependencies": {
     "firebase": "^10.12.2 || ^11.0.0 || ^12.0.0",
@@ -42,10 +41,11 @@
     "./package.json": "./package.json"
   },
   "devDependencies": {
-    "@firebase/app": "^0.14.13",
-    "@firebase/app-check": "^0.11.4",
+    "@firebase/app": "^0.15.0",
+    "@firebase/app-check": "^0.12.0",
+    "@firebase/auth": "^1.13.3",
     "@firebase/database": "^1.1.3",
-    "@firebase/firestore": "^4.15.0",
+    "@firebase/firestore": "^4.16.0",
     "@firebase/functions": "^0.13.5",
     "@firebase/storage": "^0.14.3",
     "@types/jest": "^30.0.0",
@@ -54,16 +54,11 @@
     "@types/react-dom": "^19.2.3",
     "@vitejs/plugin-react": "^6.0.2",
     "babel-plugin-react-compiler": "19.0.0-beta-ebf51a3-20250411",
-    "firebase": "^12.14.0",
+    "firebase": "^12.15.0",
     "typescript": "^6.0.3",
     "typesense": "^3.0.6",
     "vite": "^8.0.16"
   },
-  "scripts": {
-    "dev": "vite",
-    "build": "vite build && tsc --emitDeclarationOnly -p tsconfig.prod.json",
-    "clean": "rm -rf dist && find ./src -name '*.js' -type f | xargs rm -f"
-  },
   "files": [
     "dist",
     "src"
@@ -73,5 +68,10 @@
     "type": "git",
     "url": "https://github.com/rebasepro/rebase.git",
     "directory": "packages/client-firebase"
+  },
+  "scripts": {
+    "dev": "vite",
+    "build": "vite build && tsc --emitDeclarationOnly -p tsconfig.prod.json",
+    "clean": "rm -rf dist && find ./src -name '*.js' -type f | xargs rm -f"
   }
-}
+}

package/src/components/RebaseFirebaseApp.tsx

@@ -23,10 +23,10 @@ import {
     CollectionRegistryContext,
     UrlContext,
     NavigationStateContext,
-    SideEntityProvider,
+    SidePanelProvider,
     RebaseRoute
 } from "@rebasepro/admin";
-import { Entity, PropertyConfig, RebaseContext } from "@rebasepro/types";
+import { DEFAULT_DATA_SOURCE_KEY, Entity, PropertyConfig, RebaseContext } from "@rebasepro/types";
 import { CenteredView, CircularProgressCenter } from "@rebasepro/ui";
 import { buildRebaseData } from "@rebasepro/common";
 import { Route, Outlet, Navigate } from "react-router-dom";
@@ -220,7 +220,12 @@ export function RebaseFirebaseApp({
                                     authController={authController}
                                     userConfigPersistence={userConfigPersistence}
                         dateTimeFormat={dateTimeFormat}
-                        driver={firestoreDelegate}
+                        dataSources={[{
+                            key: DEFAULT_DATA_SOURCE_KEY,
+                            engine: "firestore",
+                            transport: "direct",
+                            driver: firestoreDelegate
+                        }]}
                         storageSource={storageSource}
                         entityLinkBuilder={({ entity }: { entity: Entity<any> }) => `https://console.firebase.google.com/project/${firebaseApp.options.projectId}/firestore/data/${entity.path}/${entity.id}`}
                         locale={locale}
@@ -253,7 +258,7 @@ export function RebaseFirebaseApp({
                                     const fallbackRoute = firstCollectionEntry ? <Navigate to={urlController.buildUrlCollectionPath(firstCollectionEntry.id)} replace /> : <CenteredView>No home page or collections provided.</CenteredView>;
 
                                     component = (
-                                        <SideEntityProvider>
+                                        <SidePanelProvider>
                                             <RebaseRoutes>
                                                 <Route element={
                                                     <Scaffold
@@ -269,7 +274,7 @@ export function RebaseFirebaseApp({
                                                     <Route path="/c/*" element={<RebaseRoute/>}/>
                                                 </Route>
                                             </RebaseRoutes>
-                                        </SideEntityProvider>
+                                        </SidePanelProvider>
                                     );
                                 }
                             }

package/src/components/RebaseFirebaseAppProps.tsx

@@ -1,6 +1,6 @@
 import React from "react";
 
-import { AnalyticsEvent, AppView, AppViewsBuilder, EntityCollection, EntityCollectionsBuilder, RebasePlugin, Locale, PropertyConfig } from "@rebasepro/types";
+import { AnalyticsEvent, AppView, AppViewsBuilder, CollectionConfig, CollectionConfigsBuilder, RebasePlugin, Locale, PropertyConfig } from "@rebasepro/types";
 import { FirebaseAccessGate } from "../hooks/useFirebaseAccessGate";
 
 import { FirebaseApp } from "@firebase/app";
@@ -42,7 +42,7 @@ export type RebaseFirebaseAppProps = {
      * Each of the navigation entries in this field
      * generates an entry in the main menu.
      */
-    collections?: EntityCollection[] | EntityCollectionsBuilder;
+    collections?: CollectionConfig[] | CollectionConfigsBuilder;
 
     /**
      * Custom additional views created by the developer, added to the main

package/src/hooks/useBuildUserManagement.tsx

@@ -107,11 +107,11 @@ export function useBuildUserManagement<CONTROLLER extends AuthController<User> =
         setRolesLoading(true);
         return dataSourceDelegate.listenCollection?.({
             path: rolesPath,
-            onUpdate(entities: Entity<any>[]): void {
+            onUpdate(rows: Record<string, unknown>[]): void {
                 setRolesError(undefined);
-                console.debug("Updating roles", entities);
+                console.debug("Updating roles", rows);
                 try {
-                    const newRoles = entityToRoles(entities);
+                    const newRoles = rowsToRoles(rows);
                     if (!equal(newRoles, roles)) {
                         setRoles(newRoles);
                     }
@@ -144,11 +144,11 @@ export function useBuildUserManagement<CONTROLLER extends AuthController<User> =
         setUsersLoading(true);
         return dataSourceDelegate.listenCollection?.({
             path: usersPath,
-            onUpdate(entities: Entity<any>[]): void {
-                console.debug("Updating users", entities);
+            onUpdate(rows: Record<string, unknown>[]): void {
+                console.debug("Updating users", rows);
                 setUsersError(undefined);
                 try {
-                    const newUsers = entitiesToUsers(entities) as UserWithRoleIds<USER>[];
+                    const newUsers = rowsToUsers(rows) as UserWithRoleIds<USER>[];
                     // if (!equal(newUsers, usersWithRoleIds))
                     setUsersWithRoleIds(newUsers);
                 } catch (e) {
@@ -186,12 +186,12 @@ export function useBuildUserManagement<CONTROLLER extends AuthController<User> =
         };
         // delete the previous user entry if it exists and the uid has changed
         if (userExists && userExists.uid !== user.uid) {
-            const entity: Entity<any> = {
+            const row = {
                 values: {},
                 path: usersPath,
                 id: userExists.uid
             }
-            await dataSourceDelegate.deleteEntity({ entity })
+            await dataSourceDelegate.delete({ row })
                 .then(() => {
                     console.debug("Deleted previous user", userExists);
                 })
@@ -201,10 +201,10 @@ export function useBuildUserManagement<CONTROLLER extends AuthController<User> =
 
         }
 
-        return dataSourceDelegate.saveEntity({
+        return dataSourceDelegate.save({
             status: "existing",
             path: usersPath,
-            entityId: email,
+            id: email,
             values: removeUndefined(data) as Record<string, unknown>
         }).then(() => user);
     }, [usersPath, dataSourceDelegate?.initialised]);
@@ -217,10 +217,10 @@ export function useBuildUserManagement<CONTROLLER extends AuthController<User> =
             id,
             ...roleData
         } = role;
-        return dataSourceDelegate.saveEntity({
+        return dataSourceDelegate.save({
             status: "existing",
             path: rolesPath,
-            entityId: id,
+            id: id,
             values: removeUndefined(roleData) as Record<string, unknown>
         }).then(() => {
             return;
@@ -232,12 +232,12 @@ export function useBuildUserManagement<CONTROLLER extends AuthController<User> =
         if (!usersPath) throw Error("useBuildUserManagement Firestore not initialised");
         console.debug("Deleting", user);
         const { uid } = user;
-        const entity: Entity<any> = {
+        const row = {
             path: usersPath,
             id: uid,
             values: {}
         };
-        await dataSourceDelegate.deleteEntity({ entity })
+        await dataSourceDelegate.delete({ row })
     }, [usersPath, dataSourceDelegate?.initialised]);
 
     const deleteRole = useCallback(async (role: Role): Promise<void> => {
@@ -245,12 +245,12 @@ export function useBuildUserManagement<CONTROLLER extends AuthController<User> =
         if (!rolesPath) throw Error("useBuildUserManagement Firestore not initialised");
         console.debug("Deleting", role);
         const { id } = role;
-        const entity: Entity<any> = {
+        const row = {
             path: rolesPath,
             id: id,
             values: {}
         };
-        await dataSourceDelegate.deleteEntity({ entity })
+        await dataSourceDelegate.delete({ row })
     }, [rolesPath, dataSourceDelegate?.initialised]);
 
 
@@ -345,23 +345,22 @@ export function useBuildUserManagement<CONTROLLER extends AuthController<User> =
     }
 }
 
-const entitiesToUsers = (docs: Entity<Omit<UserWithRoleIds, "id">>[]): (UserWithRoleIds)[] => {
-    return docs.map((doc) => {
-        const data = doc.values;
-        const record = data as Record<string, unknown>;
+const rowsToUsers = (rows: Record<string, unknown>[]): (UserWithRoleIds)[] => {
+    return rows.map((row) => {
+        const { id, ...data } = row;
         const newVar = {
             ...data,
-            uid: doc.id,
-            created_on: record.created_on as Date | undefined,
-            updated_on: record.updated_on as Date | undefined
+            uid: id,
+            created_on: data.created_on as Date | undefined,
+            updated_on: data.updated_on as Date | undefined
         };
         return newVar as unknown as UserWithRoleIds;
     });
 }
 
-const entityToRoles = (entities: Entity<Omit<Role, "id">>[]): Role[] => {
-    return entities.map((doc) => ({
-        id: doc.id,
-        ...doc.values
-    } as Role));
+const rowsToRoles = (rows: Record<string, unknown>[]): Role[] => {
+    return rows.map((row) => ({
+        ...row,
+        id: row.id
+    } as unknown as Role));
 }

package/src/hooks/useFirebaseRealTimeDBDelegate.ts

@@ -15,7 +15,7 @@ import {
     startAt
 } from "@firebase/database";
 import { useCallback } from "react";
-import { DataDriver, DeleteEntityProps, Entity, EntityCollection, FetchCollectionProps, FetchEntityProps, FilterValues, ListenCollectionProps, ListenEntityProps, SaveEntityProps } from "@rebasepro/types";
+import { DataDriver, DeleteProps, FetchCollectionProps, FetchOneProps, FilterValues, ListenCollectionProps, ListenOneProps, SaveProps } from "@rebasepro/types";
 
 export function useFirebaseRTDBDelegate({ firebaseApp }: { firebaseApp?: FirebaseApp }): DataDriver {
 
@@ -27,7 +27,7 @@ export function useFirebaseRTDBDelegate({ firebaseApp }: { firebaseApp?: Firebas
         orderBy,
         order,
         searchString
-    }: FetchCollectionProps<M>): Promise<Entity<M>[]> => {
+    }: FetchCollectionProps<M>): Promise<Record<string, unknown>[]> => {
         if (!firebaseApp) {
             throw new Error("Firebase app not provided");
         }
@@ -43,12 +43,11 @@ export function useFirebaseRTDBDelegate({ firebaseApp }: { firebaseApp?: Firebas
             dbQuery = query(dbQuery, limitToFirst(limit));
         }
 
-        const snapshot = await get(dbQuery);
-        if (snapshot.exists()) {
-            return Object.entries(snapshot.val()).map(([id, values]) => ({
-                id,
-                path: path,
-                values: delegateToCMSModel(values) as M
+        const entity = await get(dbQuery);
+        if (entity.exists()) {
+            return Object.entries(entity.val()).map(([id, values]) => ({
+                ...(delegateToCMSModel(values) as Record<string, unknown>),
+                id
             }));
         }
         return [];
@@ -65,12 +64,11 @@ export function useFirebaseRTDBDelegate({ firebaseApp }: { firebaseApp?: Firebas
         const database = getDatabase(firebaseApp);
 
         const dbRef = ref(database, path);
-        const unsubscribe = onValue(dbRef, (snapshot) => {
-            if (snapshot.exists()) {
-                const result: Entity<M>[] = Object.entries(snapshot.val()).map(([id, values]) => ({
-                    id,
-                    path: path,
-                    values: delegateToCMSModel(values) as M
+        const unsubscribe = onValue(dbRef, (entity) => {
+            if (entity.exists()) {
+                const result: Record<string, unknown>[] = Object.entries(entity.val()).map(([id, values]) => ({
+                    ...(delegateToCMSModel(values) as Record<string, unknown>),
+                    id
                 }));
                 onUpdate(result);
             } else {
@@ -81,44 +79,42 @@ export function useFirebaseRTDBDelegate({ firebaseApp }: { firebaseApp?: Firebas
         return () => unsubscribe();
     }, [firebaseApp]);
 
-    const fetchEntity = useCallback(async <M extends Record<string, any>>({
+    const fetchOne = useCallback(async <M extends Record<string, any>>({
         path,
-        entityId
-    }: FetchEntityProps<M>): Promise<Entity<M> | undefined> => {
+        id
+    }: FetchOneProps<M>): Promise<Record<string, unknown> | undefined> => {
         if (!firebaseApp) {
             throw new Error("Firebase app not provided");
         }
         const database = getDatabase(firebaseApp);
 
-        const snapshot = await get(ref(database, `${path}/${entityId}`));
-        if (snapshot.exists()) {
+        const entity = await get(ref(database, `${path}/${id}`));
+        if (entity.exists()) {
             return {
-                id: entityId,
-                path: path,
-                values: delegateToCMSModel(snapshot.val()) as M
+                ...(delegateToCMSModel(entity.val()) as Record<string, unknown>),
+                id: id
             };
         }
         return undefined;
     }, [firebaseApp]);
 
-    const listenEntity = useCallback(<M extends Record<string, any>>({
+    const listenOne = useCallback(<M extends Record<string, any>>({
         path,
-        entityId,
+        id,
         onUpdate,
         onError
-    }: ListenEntityProps<M>): () => void => {
+    }: ListenOneProps<M>): () => void => {
         if (!firebaseApp) {
             throw new Error("Firebase app not provided");
         }
         const database = getDatabase(firebaseApp);
 
-        const dbRef = ref(database, `${path}/${entityId}`);
-        const unsubscribe = onValue(dbRef, (snapshot) => {
-            if (snapshot.exists()) {
+        const dbRef = ref(database, `${path}/${id}`);
+        const unsubscribe = onValue(dbRef, (entity) => {
+            if (entity.exists()) {
                 onUpdate({
-                    id: entityId,
-                    path,
-                    values: delegateToCMSModel(snapshot.val()) as M
+                    ...(delegateToCMSModel(entity.val()) as Record<string, unknown>),
+                    id: id
                 });
             } else {
                 onError?.(new Error("Entity does not exist"));
@@ -128,18 +124,18 @@ export function useFirebaseRTDBDelegate({ firebaseApp }: { firebaseApp?: Firebas
         return () => unsubscribe();
     }, [firebaseApp]);
 
-    const saveEntity = useCallback(async <M extends Record<string, any>>({
+    const save = useCallback(async <M extends Record<string, any>>({
         path,
-        entityId,
+        id,
         values
-    }: SaveEntityProps<M>): Promise<Entity<M>> => {
+    }: SaveProps<M>): Promise<Record<string, unknown>> => {
         if (!firebaseApp) {
             throw new Error("Firebase app not provided");
         }
         const database = getDatabase(firebaseApp);
 
-        // If entityId is not provided, a new entity will be created
-        const finalId = entityId ?? push(ref(database, path)).key;
+        // If id is not provided, a new entity will be created
+        const finalId = id ?? push(ref(database, path)).key;
         if (!finalId) {
             throw new Error("Could not generate a new id");
         }
@@ -149,25 +145,24 @@ export function useFirebaseRTDBDelegate({ firebaseApp }: { firebaseApp?: Firebas
         await set(ref(database, `${path}/${finalId}`), transformedValues);
 
         return {
-            id: finalId,
-            path: path,
-            values: values as M
+            ...values,
+            id: finalId
         };
     }, [firebaseApp]);
 
-    const deleteEntity = useCallback(async <M extends Record<string, any>>({
-        entity
-    }: DeleteEntityProps<M>): Promise<void> => {
+    const deleteOne = useCallback(async <M extends Record<string, any>>({
+        row
+    }: DeleteProps<M>): Promise<void> => {
         if (!firebaseApp) {
             throw new Error("Firebase app not provided");
         }
         const database = getDatabase(firebaseApp);
 
-        await remove(ref(database, `${entity.path}/${entity.id}`));
+        await remove(ref(database, `${row.path}/${row.id}`));
     }, [firebaseApp]);
 
     // Implementing additional methods required by DataDriver
-    const checkUniqueField = useCallback(async (slug: string, name: string, value: unknown, entityId?: string | number): Promise<boolean> => {
+    const checkUniqueField = useCallback(async (slug: string, name: string, value: unknown, id?: string | number): Promise<boolean> => {
         if (!firebaseApp) {
             throw new Error("Firebase app not provided");
         }
@@ -175,15 +170,15 @@ export function useFirebaseRTDBDelegate({ firebaseApp }: { firebaseApp?: Firebas
 
         // Simplified example; the Realtime Database does not support querying with "not equal" conditions
         const dbRef = query(ref(database, slug), orderByChild(name), startAt(value as string | number | boolean | null), limitToFirst(1));
-        const snapshot = await get(dbRef);
+        const entity = await get(dbRef);
 
-        if (!snapshot.exists()) {
+        if (!entity.exists()) {
             return true;
         }
 
         // Check if the found entity is the same as the one being checked
-        const [key, entityValue] = Object.entries(snapshot.val())[0];
-        if (entityValue && typeof entityValue === "object" && (entityValue as Record<string, unknown>)[name] === value && key === entityId) {
+        const [key, entityValue] = Object.entries(entity.val())[0];
+        if (entityValue && typeof entityValue === "object" && (entityValue as Record<string, unknown>)[name] === value && key === id) {
             return true;
         }
 
@@ -206,10 +201,10 @@ export function useFirebaseRTDBDelegate({ firebaseApp }: { firebaseApp?: Firebas
         key: "firebase_rtdb",
         fetchCollection,
         listenCollection,
-        fetchEntity,
-        listenEntity,
-        saveEntity,
-        deleteEntity,
+        fetchOne,
+        listenOne,
+        save,
+        delete: deleteOne,
         checkUniqueField,
         isFilterCombinationValid,
         currentTime: () => new Date()

package/src/hooks/useFirebaseStorageSource.ts

@@ -69,8 +69,8 @@ export function useFirebaseStorageSource({
                     setProgressTimeout();
 
                     uploadTask.on("state_changed",
-                        (snapshot) => {
-                            const progress = (snapshot.bytesTransferred / snapshot.totalBytes) * 100;
+                        (entity) => {
+                            const progress = (entity.bytesTransferred / entity.totalBytes) * 100;
 
                             if (progress > lastProgress) {
                                 lastProgress = progress;