@rebasepro/client-firebase 0.7.0 → 0.8.0

package/dist/index.es.js

@@ -1035,221 +1035,232 @@ function useFirestoreDriver({ firebaseApp, textSearchControllerBuilder, firestor
 			subscriptions.forEach((p) => p());
 		};
 	}, [firebaseApp, listenEntity]);
-	return {
+	const initTextSearch = useCallback(async (props) => {
+		console.debug("Init text search controller", searchControllerRef.current, props.path);
+		if (!searchControllerRef.current) {
+			console.warn("You are trying to use text search, but have not provided a text search controller in `useFirestoreDriver`. You can also set the flag `localTextSearchEnabled` to use local search in `useFirestoreDriver`. Local text search can incur in performance issues and higher costs for large datasets.");
+			return false;
+		}
+		try {
+			return searchControllerRef.current.init(props);
+		} catch (e) {
+			console.error("Error initializing text search controller", e);
+			return false;
+		}
+	}, []);
+	/**
+	* Fetch entities in a Firestore path
+	* @param path
+	* @param collection
+	* @param filter
+	* @param limit
+	* @param startAfter
+	* @param searchString
+	* @param orderBy
+	* @param order
+	* @return Function to cancel subscription
+	* @see useCollectionFetch if you need this functionality implemented as a hook
+	* @group Firestore
+	*/
+	const fetchCollection = useCallback(async ({ path, filter, limit, startAfter, searchString, orderBy, order, collection }) => {
+		const databaseId = collection?.databaseId;
+		const resolvedPath = path;
+		console.debug("Fetching collection", {
+			path,
+			limit,
+			filter,
+			startAfter,
+			orderBy,
+			order
+		});
+		return (await getDocs(buildQuery(resolvedPath, filter, orderBy, order, startAfter, limit, databaseId))).docs.map((doc) => createEntityFromDocument(doc, databaseId));
+	}, [buildQuery]);
+	/**
+	* Listen to a entities in a given path
+	* @param path
+	* @param collection
+	* @param onError
+	* @param filter
+	* @param limit
+	* @param startAfter
+	* @param searchString
+	* @param orderBy
+	* @param order
+	* @param onUpdate
+	* @return Function to cancel subscription
+	* @see useCollectionFetch if you need this functionality implemented as a hook
+	* @group Firestore
+	*/
+	const listenCollection = useCallback(({ path, filter, limit, startAfter, searchString, orderBy, order, onUpdate, onError, collection }) => {
+		console.debug("Listening collection", {
+			path,
+			searchString,
+			limit,
+			filter,
+			startAfter,
+			orderBy,
+			order,
+			collection
+		});
+		if (!firebaseApp) throw Error("useFirestoreDriver Firebase not initialised");
+		const databaseId = collection?.databaseId;
+		if (searchString) return performTextSearch({
+			path,
+			searchString,
+			onUpdate,
+			databaseId
+		});
+		const resolvedPath = path;
+		console.debug("Resolved path for listening", {
+			path,
+			resolvedPath
+		});
+		return onSnapshot(buildQuery(resolvedPath, filter, orderBy, order, startAfter, limit, databaseId), {
+			next: (snapshot) => {
+				if (!searchString) onUpdate(snapshot.docs.map((doc) => createEntityFromDocument(doc, databaseId)));
+			},
+			error: onError
+		});
+	}, [
+		buildQuery,
+		firebaseApp,
+		performTextSearch
+	]);
+	/**
+	* Retrieve an entity given a path and a collection
+	* @param path
+	* @param entityId
+	* @param collection
+	* @group Firestore
+	*/
+	const fetchEntity = useCallback(({ path, entityId, collection }) => {
+		return getAndBuildEntity(path, entityId, collection?.databaseId);
+	}, [getAndBuildEntity]);
+	/**
+	* Save entity to the specified path. Note that Firestore does not allow
+	* undefined values.
+	* @param path
+	* @param entityId
+	* @param values
+	* @param schemaId
+	* @param collection
+	* @param status
+	* @group Firestore
+	*/
+	const saveEntity = useCallback(({ path, entityId, values: valuesProp, collection: collection$1, status }) => {
+		if (!firebaseApp) throw Error("useFirestoreDriver Firebase not initialised");
+		console.debug("1", {
+			path,
+			entityId,
+			values: valuesProp,
+			collection: collection$1
+		});
+		const values = cmsToFirestoreModel(valuesProp, getFirestore(firebaseApp));
+		console.debug("2", {
+			path,
+			entityId,
+			values: valuesProp,
+			collection: collection$1
+		});
+		const databaseId = collection$1?.databaseId;
+		const collectionReference = collection(databaseId ? getFirestore(firebaseApp, databaseId) : getFirestore(firebaseApp), path);
+		console.debug("Saving entity", {
+			path,
+			entityId,
+			values,
+			databaseId
+		});
+		let documentReference;
+		if (entityId) documentReference = doc(collectionReference, String(entityId));
+		else documentReference = doc(collectionReference);
+		return setDoc(documentReference, values, { merge: true }).then(() => {
+			return {
+				id: documentReference.id,
+				path,
+				values: firestoreToCMSModel(values)
+			};
+		}).catch((error) => {
+			console.error("Error saving entity", error);
+			throw error;
+		});
+	}, [firebaseApp]);
+	/**
+	* Delete an entity
+	* @param entity
+	* @param collection
+	* @group Firestore
+	*/
+	const deleteEntity = useCallback(({ entity }) => {
+		if (!firebaseApp) throw Error("useFirestoreDriver Firebase not initialised");
+		const databaseId = entity.databaseId;
+		return deleteDoc(doc(databaseId ? getFirestore(firebaseApp, databaseId) : getFirestore(firebaseApp), entity.path, String(entity.id)));
+	}, [firebaseApp]);
+	/**
+	* Check if the given property is unique in the given collection
+	* @param path Collection path
+	* @param name of the property
+	* @param value
+	* @param property
+	* @param entityId
+	* @return `true` if there are no other fields besides the given entity
+	* @group Firestore
+	*/
+	const checkUniqueField = useCallback(async (path, name, value, entityId, collection$2) => {
+		if (!firebaseApp) throw Error("useFirestoreDriver Firebase not initialised");
+		const databaseId = collection$2?.databaseId;
+		const firestore = databaseId ? getFirestore(firebaseApp, databaseId) : getFirestore(firebaseApp);
+		if (value === void 0 || value === null) return Promise.resolve(true);
+		return (await getDocs(query(collection(firestore, path), where(name, "==", cmsToFirestoreModel(value, firestore))))).docs.filter((doc) => doc.id !== entityId).length === 0;
+	}, [firebaseApp]);
+	const countEntities = useCallback(async ({ path, filter, order, orderBy, 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 isFilterCombinationValid = useCallback(({ path, collection, filterValues, sortBy }) => {
+		if (!firebaseApp) throw Error("useFirestoreDriver Firebase not initialised");
+		if (firestoreIndexesBuilder === void 0) return true;
+		const indexes = firestoreIndexesBuilder?.({
+			path,
+			collection
+		});
+		const sortKey = sortBy ? sortBy[0] : void 0;
+		const sortDirection = sortBy ? sortBy[1] : void 0;
+		const values = Object.values(filterValues);
+		const filterKeys = Object.keys(filterValues);
+		const filtersCount = filterKeys.length;
+		if (!sortKey && values.every((v) => v[0] === "==")) return true;
+		if (filtersCount === 1 && (!sortKey || sortKey === filterKeys[0])) return true;
+		if (!indexes && filtersCount > 1) return false;
+		return !!indexes && indexes.filter((compositeIndex) => !sortKey || sortKey in compositeIndex).find((compositeIndex) => Object.entries(filterValues).every(([key, value]) => compositeIndex[key] !== void 0 && (!sortDirection || compositeIndex[key] === sortDirection))) !== void 0;
+	}, [firebaseApp]);
+	return useMemo(() => ({
 		key: "firestore",
 		currentTime,
 		initialised: Boolean(firebaseApp),
-		initTextSearch: useCallback(async (props) => {
-			console.debug("Init text search controller", searchControllerRef.current, props.path);
-			if (!searchControllerRef.current) {
-				console.warn("You are trying to use text search, but have not provided a text search controller in `useFirestoreDriver`. You can also set the flag `localTextSearchEnabled` to use local search in `useFirestoreDriver`. Local text search can incur in performance issues and higher costs for large datasets.");
-				return false;
-			}
-			try {
-				return searchControllerRef.current.init(props);
-			} catch (e) {
-				console.error("Error initializing text search controller", e);
-				return false;
-			}
-		}, []),
-		/**
-		* Fetch entities in a Firestore path
-		* @param path
-		* @param collection
-		* @param filter
-		* @param limit
-		* @param startAfter
-		* @param searchString
-		* @param orderBy
-		* @param order
-		* @return Function to cancel subscription
-		* @see useCollectionFetch if you need this functionality implemented as a hook
-		* @group Firestore
-		*/
-		fetchCollection: useCallback(async ({ path, filter, limit, startAfter, searchString, orderBy, order, collection }) => {
-			const databaseId = collection?.databaseId;
-			const resolvedPath = path;
-			console.debug("Fetching collection", {
-				path,
-				limit,
-				filter,
-				startAfter,
-				orderBy,
-				order
-			});
-			return (await getDocs(buildQuery(resolvedPath, filter, orderBy, order, startAfter, limit, databaseId))).docs.map((doc) => createEntityFromDocument(doc, databaseId));
-		}, [buildQuery]),
-		/**
-		* Listen to a entities in a given path
-		* @param path
-		* @param collection
-		* @param onError
-		* @param filter
-		* @param limit
-		* @param startAfter
-		* @param searchString
-		* @param orderBy
-		* @param order
-		* @param onUpdate
-		* @return Function to cancel subscription
-		* @see useCollectionFetch if you need this functionality implemented as a hook
-		* @group Firestore
-		*/
-		listenCollection: useCallback(({ path, filter, limit, startAfter, searchString, orderBy, order, onUpdate, onError, collection }) => {
-			console.debug("Listening collection", {
-				path,
-				searchString,
-				limit,
-				filter,
-				startAfter,
-				orderBy,
-				order,
-				collection
-			});
-			if (!firebaseApp) throw Error("useFirestoreDriver Firebase not initialised");
-			const databaseId = collection?.databaseId;
-			if (searchString) return performTextSearch({
-				path,
-				searchString,
-				onUpdate,
-				databaseId
-			});
-			const resolvedPath = path;
-			console.debug("Resolved path for listening", {
-				path,
-				resolvedPath
-			});
-			return onSnapshot(buildQuery(resolvedPath, filter, orderBy, order, startAfter, limit, databaseId), {
-				next: (snapshot) => {
-					if (!searchString) onUpdate(snapshot.docs.map((doc) => createEntityFromDocument(doc, databaseId)));
-				},
-				error: onError
-			});
-		}, [
-			buildQuery,
-			firebaseApp,
-			performTextSearch
-		]),
-		/**
-		* Retrieve an entity given a path and a collection
-		* @param path
-		* @param entityId
-		* @param collection
-		* @group Firestore
-		*/
-		fetchEntity: useCallback(({ path, entityId, collection }) => {
-			return getAndBuildEntity(path, entityId, collection?.databaseId);
-		}, [getAndBuildEntity]),
-		/**
-		*
-		* @param path
-		* @param entityId
-		* @param collection
-		* @param onUpdate
-		* @param onError
-		* @return Function to cancel subscription
-		* @group Firestore
-		*/
+		initTextSearch,
+		fetchCollection,
+		listenCollection,
+		fetchEntity,
 		listenEntity,
-		/**
-		* Save entity to the specified path. Note that Firestore does not allow
-		* undefined values.
-		* @param path
-		* @param entityId
-		* @param values
-		* @param schemaId
-		* @param collection
-		* @param status
-		* @group Firestore
-		*/
-		saveEntity: useCallback(({ path, entityId, values: valuesProp, collection: collection$1, status }) => {
-			if (!firebaseApp) throw Error("useFirestoreDriver Firebase not initialised");
-			console.debug("1", {
-				path,
-				entityId,
-				values: valuesProp,
-				collection: collection$1
-			});
-			const values = cmsToFirestoreModel(valuesProp, getFirestore(firebaseApp));
-			console.debug("2", {
-				path,
-				entityId,
-				values: valuesProp,
-				collection: collection$1
-			});
-			const databaseId = collection$1?.databaseId;
-			const collectionReference = collection(databaseId ? getFirestore(firebaseApp, databaseId) : getFirestore(firebaseApp), path);
-			console.debug("Saving entity", {
-				path,
-				entityId,
-				values,
-				databaseId
-			});
-			let documentReference;
-			if (entityId) documentReference = doc(collectionReference, String(entityId));
-			else documentReference = doc(collectionReference);
-			return setDoc(documentReference, values, { merge: true }).then(() => {
-				return {
-					id: documentReference.id,
-					path,
-					values: firestoreToCMSModel(values)
-				};
-			}).catch((error) => {
-				console.error("Error saving entity", error);
-				throw error;
-			});
-		}, [firebaseApp]),
-		/**
-		* Delete an entity
-		* @param entity
-		* @param collection
-		* @group Firestore
-		*/
-		deleteEntity: useCallback(({ entity }) => {
-			if (!firebaseApp) throw Error("useFirestoreDriver Firebase not initialised");
-			const databaseId = entity.databaseId;
-			return deleteDoc(doc(databaseId ? getFirestore(firebaseApp, databaseId) : getFirestore(firebaseApp), entity.path, String(entity.id)));
-		}, [firebaseApp]),
-		/**
-		* Check if the given property is unique in the given collection
-		* @param path Collection path
-		* @param name of the property
-		* @param value
-		* @param property
-		* @param entityId
-		* @return `true` if there are no other fields besides the given entity
-		* @group Firestore
-		*/
-		checkUniqueField: useCallback(async (path, name, value, entityId, collection$2) => {
-			if (!firebaseApp) throw Error("useFirestoreDriver Firebase not initialised");
-			const databaseId = collection$2?.databaseId;
-			const firestore = databaseId ? getFirestore(firebaseApp, databaseId) : getFirestore(firebaseApp);
-			if (value === void 0 || value === null) return Promise.resolve(true);
-			return (await getDocs(query(collection(firestore, path), where(name, "==", cmsToFirestoreModel(value, firestore))))).docs.filter((doc) => doc.id !== entityId).length === 0;
-		}, [firebaseApp]),
-		countEntities: useCallback(async ({ path, filter, order, orderBy, 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]),
-		isFilterCombinationValid: useCallback(({ path, collection, filterValues, sortBy }) => {
-			if (!firebaseApp) throw Error("useFirestoreDriver Firebase not initialised");
-			if (firestoreIndexesBuilder === void 0) return true;
-			const indexes = firestoreIndexesBuilder?.({
-				path,
-				collection
-			});
-			const sortKey = sortBy ? sortBy[0] : void 0;
-			const sortDirection = sortBy ? sortBy[1] : void 0;
-			const values = Object.values(filterValues);
-			const filterKeys = Object.keys(filterValues);
-			const filtersCount = filterKeys.length;
-			if (!sortKey && values.every((v) => v[0] === "==")) return true;
-			if (filtersCount === 1 && (!sortKey || sortKey === filterKeys[0])) return true;
-			if (!indexes && filtersCount > 1) return false;
-			return !!indexes && indexes.filter((compositeIndex) => !sortKey || sortKey in compositeIndex).find((compositeIndex) => Object.entries(filterValues).every(([key, value]) => compositeIndex[key] !== void 0 && (!sortDirection || compositeIndex[key] === sortDirection))) !== void 0;
-		}, [firebaseApp])
-	};
+		saveEntity,
+		deleteEntity,
+		checkUniqueField,
+		countEntities,
+		isFilterCombinationValid
+	}), [
+		firebaseApp,
+		initTextSearch,
+		fetchCollection,
+		listenCollection,
+		fetchEntity,
+		listenEntity,
+		saveEntity,
+		deleteEntity,
+		checkUniqueField,
+		countEntities,
+		isFilterCombinationValid
+	]);
 }
 var createEntityFromDocument = (docSnap, databaseId) => {
 	const values = firestoreToCMSModel(docSnap.data());