@react-native-firebase/firestore 19.2.2 → 19.3.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [19.3.0](https://github.com/invertase/react-native-firebase/compare/v19.2.2...v19.3.0) (2024-05-20)
+
+### Features
+
+- **firestore:** export and test types for the modular API ([ad40ea2](https://github.com/invertase/react-native-firebase/commit/ad40ea2eb828a59451a619059bb4bef96277e23f))
+- **firestore:** implement the getDoc modular api ([e90782b](https://github.com/invertase/react-native-firebase/commit/e90782b00702878204dd93d3a04c09c620cdf163))
+
+### Bug Fixes
+
+- **firestore:** fix types for the `where` api in modular queries ([d874e15](https://github.com/invertase/react-native-firebase/commit/d874e15145086f59bba11fee4f23a8d9cc50cc68))
+
 ## [19.2.2](https://github.com/invertase/react-native-firebase/compare/v19.2.1...v19.2.2) (2024-04-13)
 
 **Note:** Version bump only for package @react-native-firebase/firestore

package/lib/index.d.ts

@@ -2340,6 +2340,8 @@ export const firebase: ReactNativeFirebase.Module & {
   ): ReactNativeFirebase.FirebaseApp & { firestore(): FirebaseFirestoreTypes.Module };
 };
 
+export * from './modular';
+
 export const Filter: FilterFunction;
 
 export default defaultExport;

package/lib/modular/index.d.ts

@@ -532,3 +532,11 @@ export function namedQuery(firestore: Firestore, name: string): Query<DocumentDa
  * writes.
  */
 export function writeBatch(firestore: Firestore): FirebaseFirestoreTypes.WriteBatch;
+
+export * from './query';
+export * from './snapshot';
+export * from './Bytes';
+export * from './FieldPath';
+export * from './FieldValue';
+export * from './GeoPoint';
+export * from './Timestamp';

package/lib/modular/query.d.ts

@@ -40,7 +40,7 @@ export interface AppliableConstraint {
  * can then be passed to {@link (query:1)} to create a new query instance that
  * also contains this `QueryConstraint`.
  */
-export interface IQueryConstraint extends AppliableConstraint {
+export interface QueryConstraint extends AppliableConstraint {
   /** The type of this query constraint */
   readonly type: QueryConstraintType;
 
@@ -239,6 +239,42 @@ export function startAfter<AppModelType, DbModelType extends DocumentData>(
  */
 export function limit(limit: number): QueryLimitConstraint;
 
+/**
+ * Reads the document referred to by this `DocumentReference`.
+ *
+ * Note: `getDoc()` attempts to provide up-to-date data when possible by waiting
+ * for data from the server, but it may return cached data or fail if you are
+ * offline and the server cannot be reached. To specify this behavior, invoke
+ * {@link getDocFromCache} or {@link getDocFromServer}.
+ *
+ * @param reference - The reference of the document to fetch.
+ * @returns A Promise resolved with a `DocumentSnapshot` containing the
+ * current document contents.
+ */
+export declare function getDoc<T>(reference: DocumentReference<T>): Promise<DocumentSnapshot<T>>;
+
+/**
+ * Reads the document referred to by this `DocumentReference` from cache.
+ * Returns an error if the document is not currently cached.
+ *
+ * @returns A `Promise` resolved with a `DocumentSnapshot` containing the
+ * current document contents.
+ */
+export declare function getDocFromCache<T>(
+  reference: DocumentReference<T>,
+): Promise<DocumentSnapshot<T>>;
+
+/**
+ * Reads the document referred to by this `DocumentReference` from the server.
+ * Returns an error if the network is not available.
+ *
+ * @returns A `Promise` resolved with a `DocumentSnapshot` containing the
+ * current document contents.
+ */
+export declare function getDocFromServer<T>(
+  reference: DocumentReference<T>,
+): Promise<DocumentSnapshot<T>>;
+
 /**
  * Executes the query and returns the results as a `QuerySnapshot`.
  *

package/lib/modular/query.js

@@ -169,6 +169,30 @@ export function limitToLast(limit) {
   return new QueryConstraint('limitToLast', limit);
 }
 
+/**
+ * @param {DocumentReference} query
+ * @returns {Promise<DocumentSnapshot>}
+ */
+export function getDoc(reference) {
+  return reference.get({ source: 'default' });
+}
+
+/**
+ * @param {DocumentReference} query
+ * @returns {Promise<DocumentSnapshot>}
+ */
+export function getDocFromCache(reference) {
+  return reference.get({ source: 'cache' });
+}
+
+/**
+ * @param {DocumentReference} query
+ * @returns {Promise<DocumentSnapshot>}
+ */
+export function getDocFromServer(reference) {
+  return reference.get({ source: 'server' });
+}
+
 /**
  * @param {Query} query
  * @returns {Promise<QuerySnapshot>}

package/lib/version.js

@@ -1,2 +1,2 @@
 // Generated by genversion.
-module.exports = '19.2.2';
+module.exports = '19.3.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-native-firebase/firestore",
-  "version": "19.2.2",
+  "version": "19.3.0",
   "author": "Invertase <oss@invertase.io> (http://invertase.io)",
   "description": "React Native Firebase - Cloud Firestore is a NoSQL cloud database to store and sync data between your React Native application and Firebase's database. The API matches the Firebase Web SDK whilst taking advantage of the native SDKs performance and offline capabilities.",
   "main": "lib/index.js",
@@ -27,10 +27,10 @@
     "firestore"
   ],
   "peerDependencies": {
-    "@react-native-firebase/app": "19.2.2"
+    "@react-native-firebase/app": "19.3.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "2c1f48eacba95904c89073dcb391d89d0f966165"
+  "gitHead": "edac62269c1b3088cadf74586d48f68214d6e8e4"
 }