@rebasepro/firebase 0.22.0 → 0.23.0

package/dist/hooks/useFirestoreDriver.d.ts

@@ -56,6 +56,33 @@ export declare function resolveOffsetWindow(limit: number | undefined, offset: n
     fetchLimit: number | undefined;
     skip: number;
 };
+/**
+ * The rows for the ids a text search returned, read once: in the order the
+ * search ranked them, windowed by `limit` and `offset`. An id whose document is
+ * gone is left out.
+ */
+export declare function readSearchResults({ ids, limit, offset, readOne }: {
+    ids: readonly string[];
+    limit?: number;
+    offset?: number;
+    readOne: (id: string) => Promise<Record<string, unknown> | undefined>;
+}): Promise<Record<string, unknown>[]>;
+/**
+ * The rows for the ids a text search returned, kept live: one document
+ * listener per id in the `limit`/`offset` window, and every change delivered
+ * as the whole list, in the order the search ranked the ids.
+ *
+ * The returned function cancels all of it, a search still in flight included:
+ * its listeners are then never opened.
+ */
+export declare function listenToSearchResults({ ids, limit, offset, listenOne, onUpdate, onError }: {
+    ids: Promise<readonly string[] | undefined>;
+    limit?: number;
+    offset?: number;
+    listenOne: (id: string, onRow: (row: Record<string, unknown> | null) => void, onError?: (error: Error) => void) => () => void;
+    onUpdate: (rows: Record<string, unknown>[]) => void;
+    onError?: (error: Error) => void;
+}): () => void;
 /**
  * Use this hook to build a {@link DataDriver} based on Firestore
  * @param firebaseApp

package/dist/index.es.js

@@ -9,7 +9,7 @@ import { COLLECTION_PATH_SEPARATOR, buildRebaseData, normalizeDriverOrderBy, sor
 import { DocumentReference, GeoPoint as GeoPoint$1, Timestamp, VectorValue, collection, deleteDoc, deleteField, doc, getCountFromServer, getDoc, getDocs, getFirestore, limit, onSnapshot, orderBy, query, serverTimestamp, setDoc, startAfter, vector, where } from "firebase/firestore";
 import Fuse from "fuse.js";
 import { getFunctions, httpsCallable } from "firebase/functions";
-import { endAt, equalTo, get, getDatabase, limitToFirst, onValue, orderByChild, orderByKey, push, query as query$1, ref as ref$1, remove, set, startAfter as startAfter$1, startAt } from "firebase/database";
+import { endAt, equalTo, get, getDatabase, limitToFirst, onValue, orderByChild, orderByKey, push, query as query$1, ref as ref$1, remove, set, startAfter as startAfter$1, startAt, update } from "firebase/database";
 import { removeUndefined } from "@rebasepro/utils";
 import { AdminModeControllerProvider, ErrorView, ModeControllerProvider, Rebase, RebaseLogo, RebaseRoutes, SnackbarProvider, useBrowserTitleAndIcon, useBuildAdminModeController, useBuildLocalConfigurationPersistence, useBuildModeController, useModeController, useSnackbarController } from "@rebasepro/app";
 import { AppBar, CollectionRegistryContext, Drawer, NavigationStateContext, RebaseRoute, Scaffold, SideDialogs, SidePanelProvider, UrlContext, useBuildCollectionRegistryController, useBuildNavigationStateController, useBuildUrlController } from "@rebasepro/cms";
@@ -533,7 +533,10 @@ var docsToCollectionTree = (docs) => {
 		if (id.includes(COLLECTION_PATH_SEPARATOR)) {
 			const parentId = id.split(COLLECTION_PATH_SEPARATOR).slice(0, -1).join(COLLECTION_PATH_SEPARATOR);
 			const parentCollection = collectionsMap[parentId];
-			if (parentCollection) parentCollection.subcollections = () => [...parentCollection.subcollections?.() ?? [], collection];
+			if (parentCollection) {
+				const siblings = parentCollection.subcollections;
+				parentCollection.subcollections = () => [...siblings?.() ?? [], collection];
+			}
 			delete collectionsMap[id];
 		}
 	});
@@ -984,6 +987,53 @@ function resolveOffsetWindow(limit, offset) {
 	};
 }
 /**
+* The rows for the ids a text search returned, read once: in the order the
+* search ranked them, windowed by `limit` and `offset`. An id whose document is
+* gone is left out.
+*/
+async function readSearchResults({ ids, limit, offset, readOne }) {
+	const { fetchLimit, skip } = resolveOffsetWindow(limit, offset);
+	return (await Promise.all(ids.slice(skip, fetchLimit).map(readOne))).filter((row) => row !== void 0);
+}
+/**
+* The rows for the ids a text search returned, kept live: one document
+* listener per id in the `limit`/`offset` window, and every change delivered
+* as the whole list, in the order the search ranked the ids.
+*
+* The returned function cancels all of it, a search still in flight included:
+* its listeners are then never opened.
+*/
+function listenToSearchResults({ ids, limit, offset, listenOne, onUpdate, onError }) {
+	let cancelled = false;
+	let subscriptions = [];
+	ids.then((found) => {
+		if (cancelled) return;
+		const { fetchLimit, skip } = resolveOffsetWindow(limit, offset);
+		const windowIds = (found ?? []).slice(skip, fetchLimit);
+		if (windowIds.length === 0) {
+			onUpdate([]);
+			return;
+		}
+		const rows = /* @__PURE__ */ new Map();
+		const emit = () => onUpdate(windowIds.flatMap((id) => {
+			const row = rows.get(id);
+			return row ? [row] : [];
+		}));
+		subscriptions = windowIds.map((id) => listenOne(id, (row) => {
+			if (row) rows.set(id, row);
+			else rows.delete(id);
+			emit();
+		}, onError));
+	}).catch((error) => {
+		if (cancelled) return;
+		onError?.(error instanceof Error ? error : new Error(String(error)));
+	});
+	return () => {
+		cancelled = true;
+		subscriptions.forEach((unsubscribe) => unsubscribe());
+	};
+}
+/**
 * Use this hook to build a {@link DataDriver} based on Firestore
 * @param firebaseApp
 * @param textSearchControllerBuilder
@@ -1044,11 +1094,11 @@ function useFirestoreDriver({ firebaseApp, textSearchControllerBuilder, firestor
 			error: onError
 		});
 	}, [firebaseApp]);
-	const performTextSearch = useCallback(({ path, databaseId, searchString, onUpdate }) => {
+	/** The ids the text search controller finds for `searchString` under `path`. */
+	const searchIds = useCallback((path, searchString, databaseId) => {
 		if (!firebaseApp) throw Error("useFirestoreDriver Firebase not initialised");
 		const textSearchController = searchControllerRef.current;
 		if (!textSearchController) throw Error("Trying to make text search without specifying a FirestoreTextSearchController");
-		let subscriptions = [];
 		const currentUser = getAuth(firebaseApp)?.currentUser;
 		const search = textSearchController.search({
 			path,
@@ -1057,37 +1107,24 @@ function useFirestoreDriver({ firebaseApp, textSearchControllerBuilder, firestor
 			databaseId
 		});
 		if (!search) throw Error("The current path is not supported by the specified FirestoreTextSearchController");
-		search.then((ids) => {
-			if (!ids || ids.length === 0) {
-				subscriptions = [];
-				onUpdate([]);
-			}
-			const rows = [];
-			const addedEntitiesSet = /* @__PURE__ */ new Set();
-			subscriptions = (ids ?? []).map((id) => {
-				return listenOne({
-					path,
-					id,
-					onUpdate: (row) => {
-						const incomingId = row?.id;
-						if (row && incomingId !== void 0) {
-							if (!addedEntitiesSet.has(incomingId)) {
-								addedEntitiesSet.add(incomingId);
-								rows.push(row);
-								onUpdate(rows);
-							}
-						} else {
-							addedEntitiesSet.delete(id);
-							onUpdate([...rows.filter((r) => r.id !== id)]);
-						}
-					}
-				});
-			});
+		return search;
+	}, [firebaseApp]);
+	const performTextSearch = useCallback(({ path, collection, searchString, limit, offset, onUpdate, onError }) => {
+		return listenToSearchResults({
+			ids: searchIds(path, searchString, collection?.databaseId),
+			limit,
+			offset,
+			listenOne: (id, onRow, onRowError) => listenOne({
+				path,
+				id,
+				collection,
+				onUpdate: onRow,
+				onError: onRowError
+			}),
+			onUpdate,
+			onError
 		});
-		return () => {
-			subscriptions.forEach((p) => p());
-		};
-	}, [firebaseApp, listenOne]);
+	}, [searchIds, listenOne]);
 	const initTextSearch = useCallback(async (props) => {
 		console.debug("Init text search controller", searchControllerRef.current, props.path);
 		if (!searchControllerRef.current) {
@@ -1128,9 +1165,19 @@ function useFirestoreDriver({ firebaseApp, textSearchControllerBuilder, firestor
 			orderBy,
 			order
 		});
+		if (searchString) return readSearchResults({
+			ids: await searchIds(resolvedPath, searchString, databaseId) ?? [],
+			limit,
+			offset,
+			readOne: (id) => getAndBuildEntity(resolvedPath, id, databaseId)
+		});
 		const { fetchLimit, skip } = resolveOffsetWindow(limit, offset);
 		return (await getDocs(buildQuery(resolvedPath, filter, orderBy, order, startAfter, fetchLimit, databaseId))).docs.slice(skip).map((doc) => createRowFromDocument(doc));
-	}, [buildQuery]);
+	}, [
+		buildQuery,
+		searchIds,
+		getAndBuildEntity
+	]);
 	/**
 	* Listen to a entities in a given path
 	* @param path
@@ -1147,7 +1194,7 @@ function useFirestoreDriver({ firebaseApp, textSearchControllerBuilder, firestor
 	* @see useCollection if you need this functionality implemented as a hook
 	* @group Firestore
 	*/
-	const listenCollection = useCallback(({ path, filter, limit, startAfter, searchString, orderBy, order, onUpdate, onError, collection }) => {
+	const listenCollection = useCallback(({ path, filter, limit, offset, startAfter, searchString, orderBy, order, onUpdate, onError, collection }) => {
 		console.debug("Listening collection", {
 			path,
 			searchString,
@@ -1162,18 +1209,22 @@ function useFirestoreDriver({ firebaseApp, textSearchControllerBuilder, firestor
 		const databaseId = collection?.databaseId;
 		if (searchString) return performTextSearch({
 			path,
+			collection,
 			searchString,
+			limit,
+			offset,
 			onUpdate,
-			databaseId
+			onError
 		});
 		const resolvedPath = path;
 		console.debug("Resolved path for listening", {
 			path,
 			resolvedPath
 		});
-		return onSnapshot(buildQuery(resolvedPath, filter, orderBy, order, startAfter, limit, databaseId), {
+		const { fetchLimit, skip } = resolveOffsetWindow(limit, offset);
+		return onSnapshot(buildQuery(resolvedPath, filter, orderBy, order, startAfter, fetchLimit, databaseId), {
 			next: (entity) => {
-				if (!searchString) onUpdate(entity.docs.map((doc) => createRowFromDocument(doc)));
+				onUpdate(entity.docs.slice(skip).map((doc) => createRowFromDocument(doc)));
 			},
 			error: onError
 		});
@@ -1267,11 +1318,17 @@ function useFirestoreDriver({ firebaseApp, textSearchControllerBuilder, firestor
 		if (value === void 0 || value === null) return Promise.resolve(true);
 		return (await getDocs(query(collection(firestore, path), where(name, "==", rebaseToFirestoreModel(value, firestore))))).docs.filter((doc) => doc.id !== id).length === 0;
 	}, [firebaseApp]);
-	const count = useCallback(async ({ path, filter, order, orderBy, collection }) => {
+	const count = useCallback(async ({ path, filter, order, orderBy, searchString, collection }) => {
 		if (!firebaseApp) throw Error("useFirestoreDriver Firebase not initialised");
 		const databaseId = collection?.databaseId;
-		return (await getCountFromServer(buildQuery(path, filter, orderBy, order, void 0, void 0, databaseId))).data().count;
-	}, [firebaseApp]);
+		const resolvedPath = path;
+		if (searchString) return (await searchIds(resolvedPath, searchString, databaseId) ?? []).length;
+		return (await getCountFromServer(buildQuery(resolvedPath, filter, orderBy, order, void 0, void 0, databaseId))).data().count;
+	}, [
+		firebaseApp,
+		buildQuery,
+		searchIds
+	]);
 	const isFilterCombinationValid = useCallback(({ path, collection, filterValues, sortBy }) => {
 		if (!firebaseApp) throw Error("useFirestoreDriver Firebase not initialised");
 		if (firestoreIndexesBuilder === void 0) return true;
@@ -1374,7 +1431,7 @@ function getCMSPathFromFirestorePath(fsPath) {
 	return fsPath.substring(0, to);
 }
 function rebaseToFirestoreModel(data, firestore, inArray = false) {
-	if (data === void 0) return deleteField();
+	if (data === void 0) return inArray ? void 0 : deleteField();
 	else if (data === null) return null;
 	else if (Array.isArray(data)) return data.filter((v) => v !== void 0).map((v) => rebaseToFirestoreModel(v, firestore, true));
 	else if (typeof data === "object" && data !== null && "isEntityReference" in data && typeof data.isEntityReference === "function" && data.isEntityReference()) {
@@ -1387,7 +1444,7 @@ function rebaseToFirestoreModel(data, firestore, inArray = false) {
 	else if (data instanceof Date) return Timestamp.fromDate(data);
 	else if (data && typeof data === "object" && "__type__" in data && data.__type__ === "__vector__") return vector(data.value || []);
 	else if (data && typeof data === "object") return Object.entries(data).map(([key, v]) => {
-		const firestoreModel = rebaseToFirestoreModel(v, firestore);
+		const firestoreModel = rebaseToFirestoreModel(v, firestore, inArray);
 		if (firestoreModel !== void 0) return { [key]: firestoreModel };
 		else return {};
 	}).reduce((a, b) => ({
@@ -1492,6 +1549,25 @@ function rtdbConstraints(plan) {
 	if (plan.limitToFirst !== void 0) constraints.push(limitToFirst(plan.limitToFirst));
 	return constraints;
 }
+/**
+* The rows of a query result, in the query's order, with the first `skip` dropped.
+*
+* `snapshot.val()` is a plain object, and an object's keys come back in key
+* order (integer-like keys first), not in the order the query sorted the
+* children. Read that way, `orderBy` was lost and an offset page dropped rows
+* by key rather than by position — page two of a list ordered by `age` held
+* whichever rows sorted last by id. `forEach` walks the children in query order.
+*/
+function rowsFromSnapshot(snapshot, skip) {
+	const rows = [];
+	snapshot.forEach((child) => {
+		rows.push({
+			...delegateToCMSModel(child.val()),
+			id: child.key
+		});
+	});
+	return rows.slice(skip);
+}
 function useFirebaseRTDBDelegate({ firebaseApp }) {
 	return {
 		key: "firebase_rtdb",
@@ -1499,27 +1575,14 @@ function useFirebaseRTDBDelegate({ firebaseApp }) {
 			if (!firebaseApp) throw new Error("Firebase app not provided");
 			const database = getDatabase(firebaseApp);
 			const plan = planRTDBQuery(props);
-			const entity = await get(query$1(ref$1(database, props.path), ...rtdbConstraints(plan)));
-			if (entity.exists()) return Object.entries(entity.val()).slice(plan.skip ?? 0).map(([id, values]) => ({
-				...delegateToCMSModel(values),
-				id
-			}));
-			return [];
+			return rowsFromSnapshot(await get(query$1(ref$1(database, props.path), ...rtdbConstraints(plan))), plan.skip ?? 0);
 		}, [firebaseApp]),
 		listenCollection: useCallback((props) => {
 			if (!firebaseApp) throw new Error("Firebase app not provided");
 			const database = getDatabase(firebaseApp);
 			const { onUpdate, onError } = props;
 			const plan = planRTDBQuery(props);
-			const unsubscribe = onValue(query$1(ref$1(database, props.path), ...rtdbConstraints(plan)), (entity) => {
-				if (entity.exists()) {
-					const result = Object.entries(entity.val()).slice(plan.skip ?? 0).map(([id, values]) => ({
-						...delegateToCMSModel(values),
-						id
-					}));
-					onUpdate(result);
-				} else onUpdate([]);
-			}, (error) => onError?.(error));
+			const unsubscribe = onValue(query$1(ref$1(database, props.path), ...rtdbConstraints(plan)), (entity) => onUpdate(rowsFromSnapshot(entity, plan.skip ?? 0)), (error) => onError?.(error));
 			return () => unsubscribe();
 		}, [firebaseApp]),
 		fetchOne: useCallback(async ({ path, id }) => {
@@ -1533,21 +1596,22 @@ function useFirebaseRTDBDelegate({ firebaseApp }) {
 		listenOne: useCallback(({ path, id, onUpdate, onError }) => {
 			if (!firebaseApp) throw new Error("Firebase app not provided");
 			const unsubscribe = onValue(ref$1(getDatabase(firebaseApp), `${path}/${id}`), (entity) => {
-				if (entity.exists()) onUpdate({
+				onUpdate(entity.exists() ? {
 					...delegateToCMSModel(entity.val()),
 					id
-				});
-				else onError?.(/* @__PURE__ */ new Error("Entity does not exist"));
-			});
+				} : null);
+			}, (error) => onError?.(error));
 			return () => unsubscribe();
 		}, [firebaseApp]),
-		save: useCallback(async ({ path, id, values }) => {
+		save: useCallback(async ({ path, id, values, status }) => {
 			if (!firebaseApp) throw new Error("Firebase app not provided");
 			const database = getDatabase(firebaseApp);
 			const finalId = id ?? push(ref$1(database, path)).key;
 			if (!finalId) throw new Error("Could not generate a new id");
-			const transformedValues = cmsToRTDBModel(values, database);
-			await set(ref$1(database, `${path}/${finalId}`), transformedValues);
+			const transformedValues = cmsToRTDBRecord(values, database);
+			const rowRef = ref$1(database, `${path}/${finalId}`);
+			if (status === "existing") await update(rowRef, transformedValues);
+			else await set(rowRef, transformedValues);
 			return {
 				...values,
 				id: finalId
@@ -1559,11 +1623,19 @@ function useFirebaseRTDBDelegate({ firebaseApp }) {
 		}, [firebaseApp]),
 		checkUniqueField: useCallback(async (slug, name, value, id) => {
 			if (!firebaseApp) throw new Error("Firebase app not provided");
-			const entity = await get(query$1(ref$1(getDatabase(firebaseApp), slug), orderByChild(name), startAt(value), limitToFirst(1)));
-			if (!entity.exists()) return true;
-			const [key, entityValue] = Object.entries(entity.val())[0];
-			if (entityValue && typeof entityValue === "object" && entityValue[name] === value && key === id) return true;
-			return false;
+			const database = getDatabase(firebaseApp);
+			const stored = cmsToRTDBModel(value, database);
+			if (stored === null) return true;
+			if (!isRTDBValue(stored)) throw new Error(`${RTDB}: cannot check \`${name}\` for uniqueness by a ${Array.isArray(stored) ? "array" : typeof stored} value; the Realtime Database compares strings, numbers and booleans.`);
+			const matches = await get(query$1(ref$1(database, slug), orderByChild(name), equalTo(stored), limitToFirst(2)));
+			let unique = true;
+			matches.forEach((child) => {
+				if (id === void 0 || child.key !== String(id)) {
+					unique = false;
+					return true;
+				}
+			});
+			return unique;
 		}, [firebaseApp]),
 		isFilterCombinationValid: useCallback(({ path, filter, sortBy }) => {
 			return false;
@@ -1600,16 +1672,15 @@ function cmsToRTDBModel(data, database) {
 		const entityRef = data;
 		return ref$1(database, `${entityRef.slug}/${entityRef.id}`);
 	} else if (data instanceof Date) return data.toISOString();
-	else if (data && typeof data === "object") return Object.entries(data).map(([key, v]) => {
-		const rtdbModel = cmsToRTDBModel(v, database);
-		if (rtdbModel !== void 0) return { [key]: rtdbModel };
-		else return {};
-	}).reduce((a, b) => ({
-		...a,
-		...b
-	}), {});
+	else if (data && typeof data === "object") return cmsToRTDBRecord(data, database);
 	return data;
 }
+/** {@link cmsToRTDBModel} for a map of values: each child converted, keys kept. */
+function cmsToRTDBRecord(data, database) {
+	const result = {};
+	for (const [key, v] of Object.entries(data)) result[key] = cmsToRTDBModel(v, database);
+	return result;
+}
 //#endregion
 //#region src/hooks/useRecaptcha.tsx
 var RECAPTCHA_CONTAINER_ID = "recaptcha-container";
@@ -2789,6 +2860,6 @@ function RebaseFirebaseApp({ name, logo, logoDark, accessGate, collections, view
 	}) });
 }
 //#endregion
-export { FirebaseLoginView, LoginButton, RECAPTCHA_CONTAINER_ID, RebaseFirebaseApp, buildCollectionId, buildExternalSearchController, buildPineconeSearchController, buildRebaseSearchController, docToCollection, docsToCollectionTree, firestoreToRebaseModel, getFirestoreDataInPath, localSearchControllerBuilder, performAlgoliaTextSearch, performPineconeTextSearch, planRTDBQuery, rebaseToFirestoreModel, resolveAccessDecision, resolveOffsetWindow, resolveRoleRefresh, useAppCheck, useBuildUserManagement, useFirebaseAccessGate, useFirebaseAuthController, useFirebaseRTDBDelegate, useFirebaseStorageSource, useFirestoreDriver, useInitialiseFirebase, useRecaptcha };
+export { FirebaseLoginView, LoginButton, RECAPTCHA_CONTAINER_ID, RebaseFirebaseApp, buildCollectionId, buildExternalSearchController, buildPineconeSearchController, buildRebaseSearchController, docToCollection, docsToCollectionTree, firestoreToRebaseModel, getFirestoreDataInPath, listenToSearchResults, localSearchControllerBuilder, performAlgoliaTextSearch, performPineconeTextSearch, planRTDBQuery, readSearchResults, rebaseToFirestoreModel, resolveAccessDecision, resolveOffsetWindow, resolveRoleRefresh, useAppCheck, useBuildUserManagement, useFirebaseAccessGate, useFirebaseAuthController, useFirebaseRTDBDelegate, useFirebaseStorageSource, useFirestoreDriver, useInitialiseFirebase, useRecaptcha };
 
 //# sourceMappingURL=index.es.js.map