@react-native-firebase/firestore 23.8.6 → 24.0.0

package/lib/modular/snapshot.d.ts

@@ -1,256 +0,0 @@
-import { FirebaseFirestoreTypes } from '../index';
-
-import DocumentReference = FirebaseFirestoreTypes.DocumentReference;
-import DocumentSnapshot = FirebaseFirestoreTypes.DocumentSnapshot;
-import SnapshotListenOptions = FirebaseFirestoreTypes.SnapshotListenOptions;
-import QuerySnapshot = FirebaseFirestoreTypes.QuerySnapshot;
-import Query = FirebaseFirestoreTypes.Query;
-
-export type Unsubscribe = () => void;
-export type FirestoreError = Error;
-
-/**
- * Attaches a listener for `DocumentSnapshot` events. You may either pass
- * individual `onNext` and `onError` callbacks or pass a single observer
- * object with `next` and `error` callbacks.
- *
- * NOTE: Although an `onCompletion` callback can be provided, it will
- * never be called because the snapshot stream is never-ending.
- *
- * @param reference - A reference to the document to listen to.
- * @param observer - A single object containing `next` and `error` callbacks.
- * @returns An unsubscribe function that can be called to cancel
- * the snapshot listener.
- */
-export function onSnapshot<T>(
-  reference: DocumentReference<T>,
-  observer: {
-    next?: (snapshot: DocumentSnapshot<T>) => void;
-    error?: (error: FirestoreError) => void;
-    complete?: () => void;
-  },
-): Unsubscribe;
-/**
- * Attaches a listener for `DocumentSnapshot` events. You may either pass
- * individual `onNext` and `onError` callbacks or pass a single observer
- * object with `next` and `error` callbacks.
- *
- * NOTE: Although an `onCompletion` callback can be provided, it will
- * never be called because the snapshot stream is never-ending.
- *
- * @param reference - A reference to the document to listen to.
- * @param options - Options controlling the listen behavior.
- * @param observer - A single object containing `next` and `error` callbacks.
- * @returns An unsubscribe function that can be called to cancel
- * the snapshot listener.
- */
-export function onSnapshot<T>(
-  reference: DocumentReference<T>,
-  options: SnapshotListenOptions,
-  observer: {
-    next?: (snapshot: DocumentSnapshot<T>) => void;
-    error?: (error: FirestoreError) => void;
-    complete?: () => void;
-  },
-): Unsubscribe;
-/**
- * Attaches a listener for `DocumentSnapshot` events. You may either pass
- * individual `onNext` and `onError` callbacks or pass a single observer
- * object with `next` and `error` callbacks.
- *
- * NOTE: Although an `onCompletion` callback can be provided, it will
- * never be called because the snapshot stream is never-ending.
- *
- * @param reference - A reference to the document to listen to.
- * @param onNext - A callback to be called every time a new `DocumentSnapshot`
- * is available.
- * @param onError - A callback to be called if the listen fails or is
- * cancelled. No further callbacks will occur.
- * @param onCompletion - Can be provided, but will not be called since streams are
- * never ending.
- * @returns An unsubscribe function that can be called to cancel
- * the snapshot listener.
- */
-export function onSnapshot<T>(
-  reference: DocumentReference<T>,
-  onNext: (snapshot: DocumentSnapshot<T>) => void,
-  onError?: (error: FirestoreError) => void,
-  onCompletion?: () => void,
-): Unsubscribe;
-/**
- * Attaches a listener for `DocumentSnapshot` events. You may either pass
- * individual `onNext` and `onError` callbacks or pass a single observer
- * object with `next` and `error` callbacks.
- *
- * NOTE: Although an `onCompletion` callback can be provided, it will
- * never be called because the snapshot stream is never-ending.
- *
- * @param reference - A reference to the document to listen to.
- * @param options - Options controlling the listen behavior.
- * @param onNext - A callback to be called every time a new `DocumentSnapshot`
- * is available.
- * @param onError - A callback to be called if the listen fails or is
- * cancelled. No further callbacks will occur.
- * @param onCompletion - Can be provided, but will not be called since streams are
- * never ending.
- * @returns An unsubscribe function that can be called to cancel
- * the snapshot listener.
- */
-export function onSnapshot<T>(
-  reference: DocumentReference<T>,
-  options: SnapshotListenOptions,
-  onNext: (snapshot: DocumentSnapshot<T>) => void,
-  onError?: (error: FirestoreError) => void,
-  onCompletion?: () => void,
-): Unsubscribe;
-/**
- * Attaches a listener for `QuerySnapshot` events. You may either pass
- * individual `onNext` and `onError` callbacks or pass a single observer
- * object with `next` and `error` callbacks. The listener can be cancelled by
- * calling the function that is returned when `onSnapshot` is called.
- *
- * NOTE: Although an `onCompletion` callback can be provided, it will
- * never be called because the snapshot stream is never-ending.
- *
- * @param query - The query to listen to.
- * @param observer - A single object containing `next` and `error` callbacks.
- * @returns An unsubscribe function that can be called to cancel
- * the snapshot listener.
- */
-export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(
-  query: Query<AppModelType, DbModelType>,
-  observer: {
-    next?: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void;
-    error?: (error: FirestoreError) => void;
-    complete?: () => void;
-  },
-): Unsubscribe;
-/**
- * Attaches a listener for `QuerySnapshot` events. You may either pass
- * individual `onNext` and `onError` callbacks or pass a single observer
- * object with `next` and `error` callbacks. The listener can be cancelled by
- * calling the function that is returned when `onSnapshot` is called.
- *
- * NOTE: Although an `onCompletion` callback can be provided, it will
- * never be called because the snapshot stream is never-ending.
- *
- * @param query - The query to listen to.
- * @param options - Options controlling the listen behavior.
- * @param observer - A single object containing `next` and `error` callbacks.
- * @returns An unsubscribe function that can be called to cancel
- * the snapshot listener.
- */
-export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(
-  query: Query<AppModelType, DbModelType>,
-  options: SnapshotListenOptions,
-  observer: {
-    next?: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void;
-    error?: (error: FirestoreError) => void;
-    complete?: () => void;
-  },
-): Unsubscribe;
-/**
- * Attaches a listener for `QuerySnapshot` events. You may either pass
- * individual `onNext` and `onError` callbacks or pass a single observer
- * object with `next` and `error` callbacks. The listener can be cancelled by
- * calling the function that is returned when `onSnapshot` is called.
- *
- * NOTE: Although an `onCompletion` callback can be provided, it will
- * never be called because the snapshot stream is never-ending.
- *
- * @param query - The query to listen to.
- * @param onNext - A callback to be called every time a new `QuerySnapshot`
- * is available.
- * @param onCompletion - Can be provided, but will not be called since streams are
- * never ending.
- * @param onError - A callback to be called if the listen fails or is
- * cancelled. No further callbacks will occur.
- * @returns An unsubscribe function that can be called to cancel
- * the snapshot listener.
- */
-export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(
-  query: Query<AppModelType, DbModelType>,
-  onNext: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void,
-  onError?: (error: FirestoreError) => void,
-  onCompletion?: () => void,
-): Unsubscribe;
-/**
- * Attaches a listener for `QuerySnapshot` events. You may either pass
- * individual `onNext` and `onError` callbacks or pass a single observer
- * object with `next` and `error` callbacks. The listener can be cancelled by
- * calling the function that is returned when `onSnapshot` is called.
- *
- * NOTE: Although an `onCompletion` callback can be provided, it will
- * never be called because the snapshot stream is never-ending.
- *
- * @param query - The query to listen to.
- * @param options - Options controlling the listen behavior.
- * @param onNext - A callback to be called every time a new `QuerySnapshot`
- * is available.
- * @param onCompletion - Can be provided, but will not be called since streams are
- * never ending.
- * @param onError - A callback to be called if the listen fails or is
- * cancelled. No further callbacks will occur.
- * @returns An unsubscribe function that can be called to cancel
- * the snapshot listener.
- */
-export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(
-  query: Query<AppModelType, DbModelType>,
-  options: SnapshotListenOptions,
-  onNext: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void,
-  onError?: (error: FirestoreError) => void,
-  onCompletion?: () => void,
-): Unsubscribe;
-
-/**
- * Returns true if the provided snapshots are equal.
- *
- * @param left	DocumentSnapshot<AppModelType, DbModelType> | QuerySnapshot<AppModelType, DbModelType>	A snapshot to compare.
- * @param right	DocumentSnapshot<AppModelType, DbModelType> | QuerySnapshot<AppModelType, DbModelType>	A snapshot to compare.
- *
- * @returns boolean true if the snapshots are equal.
- */
-export function snapshotEqual<AppModelType, DbModelType extends DocumentData>(
-  left: DocumentSnapshot<AppModelType, DbModelType> | QuerySnapshot<AppModelType, DbModelType>,
-  right: DocumentSnapshot<AppModelType, DbModelType> | QuerySnapshot<AppModelType, DbModelType>,
-): boolean;
-
-/**
- * Returns true if the provided queries point to the same collection and apply the same constraints.
- *
- * @param left	Query<AppModelType, DbModelType> A Query to compare.
- * @param right	Query<AppModelType, DbModelType> A Query to compare.
- *
- * @return boolean true if the references point to the same location in the same Firestore database.
- */
-export declare function queryEqual<AppModelType, DbModelType extends DocumentData>(
-  left: Query<AppModelType, DbModelType>,
-  right: Query<AppModelType, DbModelType>,
-): boolean;
-
-/**
- * Attaches a listener for a snapshots-in-sync event.
- * The snapshots-in-sync event indicates that all listeners affected by a given change have fired, even if
- * a single server-generated change affects multiple listeners.
- *
- * @param firestore
- * @param observer
- */
-export declare function onSnapshotsInSync(
-  firestore: Firestore,
-  observer: {
-    next?: (value: void) => void;
-    error?: (error: FirestoreError) => void;
-    complete?: () => void;
-  },
-): Unsubscribe;
-
-/**
- * Attaches a listener for a snapshots-in-sync event.
- * The snapshots-in-sync event indicates that all listeners affected by a given change have fired, even if
- * a single server-generated change affects multiple listeners.
- *
- * @param firestore
- * @param onSync
- */
-export declare function onSnapshotsInSync(firestore: Firestore, onSync: () => void): Unsubscribe;

package/lib/modular/snapshot.js

@@ -1,33 +0,0 @@
-/**
- * @typedef {import('../..').FirebaseFirestoreTypes.Query} Query
- * @typedef {import('../..').FirebaseFirestoreTypes.DocumentReference} DocumentReference
- * @typedef {import('snapshot').Unsubscribe} Unsubscribe
- */
-
-import { MODULAR_DEPRECATION_ARG } from '@react-native-firebase/app/dist/module/common';
-
-/**
- * @param {Query | DocumentReference} reference
- * @param {unknown} args
- * @returns {Promise<unknown>}
- */
-export function onSnapshot(reference, ...args) {
-  return reference.onSnapshot.call(reference, ...args, MODULAR_DEPRECATION_ARG);
-}
-
-export function snapshotEqual(left, right) {
-  return left.isEqual.call(left, right, MODULAR_DEPRECATION_ARG);
-}
-
-/**
- * Attaches a listener for a snapshots-in-sync event.
- * The snapshots-in-sync event indicates that all listeners affected by a given change have fired, even if
- * a single server-generated change affects multiple listeners.
- *
- * @param {*} firestore
- * @param  {...any} args
- */
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-export function onSnapshotsInSync(firestore, ...args) {
-  throw new Error('onSnapshotsInSync() is not implemented');
-}

package/lib/modular/utils/observer.js

@@ -1,16 +0,0 @@
-/**
- * @param {unknown} obj
- * @returns {boolean}
- */
-export function isPartialObserver(obj) {
-  const observerMethods = ['next', 'error', 'complete'];
-  if (typeof obj !== 'object' || obj == null) return false;
-
-  for (const method of observerMethods) {
-    if (method in obj && typeof obj[method] === 'function') {
-      return true;
-    }
-  }
-
-  return false;
-}

package/lib/version.js

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

package/lib/web/query.js

@@ -1,112 +0,0 @@
-import {
-  FieldPath,
-  query,
-  where,
-  orderBy,
-  limit,
-  limitToLast,
-  startAt,
-  startAfter,
-  endAt,
-  endBefore,
-  and,
-  or,
-} from '@react-native-firebase/app/dist/module/internal/web/firebaseFirestore';
-import { parseTypeMap, readableToArray } from './convert';
-
-export function buildQuery(queryInstance, filters, orders, options) {
-  // Apply filters
-  for (const filter of filters) {
-    queryInstance = query(queryInstance, getFilterConstraint(filter));
-  }
-
-  // Apply orders
-  for (const order of orders) {
-    const fieldPath =
-      typeof order.fieldPath === 'string' ? order.fieldPath : new FieldPath(...order.fieldPath);
-    const direction = order.direction === 'ASCENDING' ? 'asc' : 'desc';
-    queryInstance = query(queryInstance, orderBy(fieldPath, direction));
-  }
-
-  // Apply options
-  if ('limit' in options) {
-    queryInstance = query(queryInstance, limit(options.limit));
-  }
-
-  if ('limitToLast' in options) {
-    queryInstance = query(queryInstance, limitToLast(options.limitToLast));
-  }
-
-  if ('startAt' in options) {
-    const fieldList = readableToArray(queryInstance.firestore, options.startAt);
-    queryInstance = query(queryInstance, startAt(...fieldList));
-  }
-
-  if ('startAfter' in options) {
-    const fieldList = readableToArray(queryInstance.firestore, options.startAfter);
-    queryInstance = query(queryInstance, startAfter(...fieldList));
-  }
-
-  if ('endAt' in options) {
-    const fieldList = readableToArray(queryInstance.firestore, options.endAt);
-    queryInstance = query(queryInstance, endAt(...fieldList));
-  }
-
-  if ('endBefore' in options) {
-    const fieldList = readableToArray(queryInstance.firestore, options.endBefore);
-    queryInstance = query(queryInstance, endBefore(...fieldList));
-  }
-
-  return queryInstance;
-}
-
-function getFilterConstraint(filter) {
-  if ('fieldPath' in filter && filter.fieldPath) {
-    const fieldPath = Array.isArray(filter.fieldPath)
-      ? new FieldPath(...filter.fieldPath)
-      : new FieldPath(...filter.fieldPath._segments);
-    const operator = filter.operator;
-    const value = parseTypeMap(query.firestore, filter.value);
-
-    switch (operator) {
-      case 'EQUAL':
-        return where(fieldPath, '==', value);
-      case 'NOT_EQUAL':
-        return where(fieldPath, '!=', value);
-      case 'GREATER_THAN':
-        return where(fieldPath, '>', value);
-      case 'GREATER_THAN_OR_EQUAL':
-        return where(fieldPath, '>=', value);
-      case 'LESS_THAN':
-        return where(fieldPath, '<', value);
-      case 'LESS_THAN_OR_EQUAL':
-        return where(fieldPath, '<=', value);
-      case 'ARRAY_CONTAINS':
-        return where(fieldPath, 'array-contains', value);
-      case 'ARRAY_CONTAINS_ANY':
-        return where(fieldPath, 'array-contains-any', value);
-      case 'IN':
-        return where(fieldPath, 'in', value);
-      case 'NOT_IN':
-        return where(fieldPath, 'not-in', value);
-    }
-  } else if ('operator' in filter && 'queries' in filter) {
-    const constraints = [];
-
-    for (const constraint of filter.queries) {
-      constraints.push(getFilterConstraint(constraint));
-    }
-
-    if (filter.operator === 'AND') {
-      return and(...constraints);
-    }
-
-    if (filter.operator === 'OR') {
-      return or(...constraints);
-    }
-
-    throw new Error('Invalid filter operator');
-  }
-
-  throw new Error('Invalid filter.');
-}