@react-native-firebase/firestore 23.8.6 → 24.0.0

package/lib/modular/index.js

@@ -1,410 +0,0 @@
-/**
- * @typedef {import('..').FirebaseFirestoreTypes} FirebaseFirestoreTypes
- * @typedef {import('..').FirebaseFirestoreTypes.CollectionReference} CollectionReference
- * @typedef {import('..').FirebaseFirestoreTypes.DocumentData} DocumentData
- * @typedef {import('..').FirebaseFirestoreTypes.DocumentReference} DocumentReference
- * @typedef {import('..').FirebaseFirestoreTypes.FieldPath} FieldPath
- * @typedef {import('..').FirebaseFirestoreTypes.Module} Firestore
- * @typedef {import('..').FirebaseFirestoreTypes.Query} Query
- * @typedef {import('..').FirebaseFirestoreTypes.SetOptions} SetOptions
- * @typedef {import('..').FirebaseFirestoreTypes.Settings} FirestoreSettings
- * @typedef {import('..').FirebaseFirestoreTypes.PersistentCacheIndexManager} PersistentCacheIndexManager
- * @typedef {import('@firebase/app').FirebaseApp} FirebaseApp
- */
-
-import { getApp, setLogLevel as appSetLogLevel } from '@react-native-firebase/app';
-import { isObject, MODULAR_DEPRECATION_ARG } from '@react-native-firebase/app/dist/module/common';
-import {
-  FirestoreAggregateQuerySnapshot,
-  AggregateField,
-  AggregateType,
-  fieldPathFromArgument,
-} from '../FirestoreAggregate';
-import FirestoreQuery from '../FirestoreQuery';
-
-/**
- * @param {FirebaseApp?} app
- * @param {String?} databaseId
- * @returns {Firestore}
- */
-export function getFirestore(app, databaseId) {
-  if (app) {
-    if (databaseId) {
-      return getApp(app.name).firestore(databaseId);
-    } else {
-      return getApp(app.name).firestore();
-    }
-  }
-  if (databaseId) {
-    return getApp().firestore(databaseId);
-  }
-
-  return getApp().firestore();
-}
-
-/**
- * @param {Firestore | CollectionReference | DocumentReference<unknown>} parent
- * @param {string?} path
- * @param {string?} pathSegments
- * @returns {DocumentReference}
- */
-export function doc(parent, path, ...pathSegments) {
-  if (pathSegments && pathSegments.length) {
-    path = path + '/' + pathSegments.map(e => e.replace(/^\/|\/$/g, '')).join('/');
-  }
-
-  return parent.doc.call(parent, path, MODULAR_DEPRECATION_ARG);
-}
-
-/**
- * @param {Firestore | DocumentReference<unknown> | CollectionReference<unknown>} parent
- * @param {string} path
- * @param {string?} pathSegments
- * @returns {CollectionReference<DocumentData>}
- */
-export function collection(parent, path, ...pathSegments) {
-  if (pathSegments && pathSegments.length) {
-    path = path + '/' + pathSegments.map(e => e.replace(/^\/|\/$/g, '')).join('/');
-  }
-
-  return parent.collection.call(parent, path, MODULAR_DEPRECATION_ARG);
-}
-
-/**
- * @param {DocumentReference<AppModelType, DbModelType> | CollectionReference<AppModelType, DbModelType>} left
- * @param {DocumentReference<AppModelType, DbModelType> | CollectionReference<AppModelType, DbModelType>} right
- * @return boolean true if the two references are equal
- */
-export function refEqual(left, right) {
-  return left.isEqual.call(left, right, MODULAR_DEPRECATION_ARG);
-}
-
-/**
- * @param {Firestore} firestore
- * @param {string} collectionId
- * @returns {Query<DocumentData>}
- */
-export function collectionGroup(firestore, collectionId) {
-  return firestore.collectionGroup.call(firestore, collectionId, MODULAR_DEPRECATION_ARG);
-}
-
-let _id_SnapshotInSync = 0;
-
-export function onSnapshotsInSync(firestore, callback) {
-  const listenerId = _id_SnapshotInSync++;
-  firestore.native.addSnapshotsInSync(listenerId);
-  const onSnapshotsInSyncSubscription = firestore.emitter.addListener(
-    firestore.eventNameForApp(`firestore_snapshots_in_sync_event:${listenerId}`),
-    () => {
-      callback();
-    },
-  );
-
-  return () => {
-    onSnapshotsInSyncSubscription.remove();
-    firestore.native.removeSnapshotsInSync(listenerId);
-  };
-}
-
-/**
- * @param {DocumentReference} reference
- * @param {import('.').PartialWithFieldValue} data
- * @param {SetOptions?} options
- * @returns {Promise<void>}
- */
-export function setDoc(reference, data, options) {
-  return reference.set.call(reference, data, options, MODULAR_DEPRECATION_ARG);
-}
-
-/**
- * @param {DocumentReference} reference
- * @param {string | FieldPath | import('.').UpdateData} fieldOrUpdateData
- * @param {unknown?} value
- * @param {unknown} moreFieldsAndValues
- * @returns {Promise<void>}
- */
-export function updateDoc(reference, fieldOrUpdateData, value, ...moreFieldsAndValues) {
-  if (!fieldOrUpdateData) {
-    // @ts-ignore
-    return reference.update.call(reference, MODULAR_DEPRECATION_ARG);
-  }
-
-  if (!value) {
-    return reference.update.call(reference, fieldOrUpdateData, MODULAR_DEPRECATION_ARG);
-  }
-
-  if (!moreFieldsAndValues || !Array.isArray(moreFieldsAndValues)) {
-    return reference.update.call(reference, fieldOrUpdateData, value, MODULAR_DEPRECATION_ARG);
-  }
-
-  return reference.update.call(
-    reference,
-    fieldOrUpdateData,
-    value,
-    ...moreFieldsAndValues,
-    MODULAR_DEPRECATION_ARG,
-  );
-}
-
-/**
- * @param {CollectionReference} reference
- * @param {WithFieldValue} data
- * @returns {Promise<DocumentReference>}
- */
-export function addDoc(reference, data) {
-  return reference.add.call(reference, data, MODULAR_DEPRECATION_ARG);
-}
-
-/**
- * @param {Firestore} firestore
- * @returns {Promise<void>}
- */
-export function enableNetwork(firestore) {
-  return firestore.enableNetwork.call(firestore, MODULAR_DEPRECATION_ARG);
-}
-
-/**
- * @param {Firestore} firestore
- * @returns {Promise<void>}
- */
-export function disableNetwork(firestore) {
-  return firestore.disableNetwork.call(firestore, MODULAR_DEPRECATION_ARG);
-}
-
-/**
- * @param {Firestore} firestore
- * @returns {Promise<void>}
- */
-export function clearPersistence(firestore) {
-  // this will call deprecation warning as it isn't part of firebase-js-sdk API
-  return firestore.clearPersistence();
-}
-/**
- * @param {Firestore} firestore
- * @returns {Promise<void>}
- */
-export function clearIndexedDbPersistence(firestore) {
-  return firestore.clearPersistence.call(firestore, MODULAR_DEPRECATION_ARG);
-}
-
-/**
- * @param {Firestore} firestore
- * @returns {Promise<void>}
- */
-export function terminate(firestore) {
-  return firestore.terminate.call(firestore, MODULAR_DEPRECATION_ARG);
-}
-
-/**
- * @param {Firestore} firestore
- * @returns {Promise<void>}
- */
-export function waitForPendingWrites(firestore) {
-  return firestore.waitForPendingWrites.call(firestore, MODULAR_DEPRECATION_ARG);
-}
-
-/**
- * @param {FirebaseApp} app
- * @param {FirestoreSettings} settings
- * @param {string?} databaseId
- * @returns {Promise<Firestore>}
- */
-export async function initializeFirestore(app, settings, databaseId) {
-  const firebase = getApp(app.name);
-  const firestore = firebase.firestore(databaseId);
-  await firestore.settings.call(firestore, settings, MODULAR_DEPRECATION_ARG);
-  return firestore;
-}
-
-export function connectFirestoreEmulator(firestore, host, port, options) {
-  return firestore.useEmulator.call(firestore, host, port, options, MODULAR_DEPRECATION_ARG);
-}
-
-/**
- * @param {import('./').LogLevel} logLevel
- * @returns {void}
- */
-export function setLogLevel(logLevel) {
-  return appSetLogLevel(logLevel);
-}
-
-/**
- * @param {Firestore} firestore
- * @param {(transaction: FirebaseFirestoreTypes.Transaction) => Promise} updateFunction
- * @returns {Promise}
- */
-export function runTransaction(firestore, updateFunction) {
-  return firestore.runTransaction.call(firestore, updateFunction, MODULAR_DEPRECATION_ARG);
-}
-
-/**
- * @param {Query} query
- * @returns {Promise<FirebaseFirestoreTypes.AggregateQuerySnapshot>}
- */
-export function getCountFromServer(query) {
-  return query.count.call(query, MODULAR_DEPRECATION_ARG).get();
-}
-
-export function getAggregateFromServer(query, aggregateSpec) {
-  if (!(query instanceof FirestoreQuery)) {
-    throw new Error(
-      '`getAggregateFromServer(*, aggregateSpec)` `query` must be an instance of `FirestoreQuery`',
-    );
-  }
-
-  if (!isObject(aggregateSpec)) {
-    throw new Error('`getAggregateFromServer(query, *)` `aggregateSpec` must be an object');
-  } else {
-    const containsOneAggregateField = Object.values(aggregateSpec).find(
-      value => value instanceof AggregateField,
-    );
-
-    if (!containsOneAggregateField) {
-      throw new Error(
-        '`getAggregateFromServer(query, *)` `aggregateSpec` must contain at least one `AggregateField`',
-      );
-    }
-  }
-  const aggregateQueries = [];
-  for (const key in aggregateSpec) {
-    if (aggregateSpec.hasOwnProperty(key)) {
-      const aggregateField = aggregateSpec[key];
-      // we ignore any fields that are not `AggregateField`
-      if (aggregateField instanceof AggregateField) {
-        switch (aggregateField.aggregateType) {
-          case AggregateType.AVG:
-          case AggregateType.SUM:
-          case AggregateType.COUNT:
-            const aggregateQuery = {
-              aggregateType: aggregateField.aggregateType,
-              field:
-                aggregateField._fieldPath === null ? null : aggregateField._fieldPath._toPath(),
-              key,
-            };
-            aggregateQueries.push(aggregateQuery);
-            break;
-          default:
-            throw new Error(
-              `'AggregateField' has an an unknown 'AggregateType' : ${aggregateField.aggregateType}`,
-            );
-        }
-      }
-    }
-  }
-
-  return query._firestore.native
-    .aggregateQuery(
-      query._collectionPath.relativeName,
-      query._modifiers.type,
-      query._modifiers.filters,
-      query._modifiers.orders,
-      query._modifiers.options,
-      aggregateQueries,
-    )
-    .then(data => new FirestoreAggregateQuerySnapshot(query, data, false));
-}
-
-/**
- * Create an AggregateField object that can be used to compute the sum of
- * a specified field over a range of documents in the result set of a query.
- * @param field Specifies the field to sum across the result set.
- */
-export function sum(field) {
-  return new AggregateField(AggregateType.SUM, fieldPathFromArgument(field));
-}
-
-/**
- * Create an AggregateField object that can be used to compute the average of
- * a specified field over a range of documents in the result set of a query.
- * @param field Specifies the field to average across the result set.
- */
-export function average(field) {
-  return new AggregateField(AggregateType.AVG, fieldPathFromArgument(field));
-}
-
-/**
- * Create an AggregateField object that can be used to compute the count of
- * documents in the result set of a query.
- */
-export function count() {
-  return new AggregateField(AggregateType.COUNT, null);
-}
-
-/**
- * @param {Firestore} firestore
- * @param {ReadableStream<Uint8Array> | ArrayBuffer | string} bundleData
- * @returns {import('.').LoadBundleTask}
- */
-export function loadBundle(firestore, bundleData) {
-  return firestore.loadBundle.call(firestore, bundleData, MODULAR_DEPRECATION_ARG);
-}
-
-/**
- * @param {Firestore} firestore
- * @param {string} name
- * @returns {Query<DocumentData>}
- */
-export function namedQuery(firestore, name) {
-  return firestore.namedQuery.call(firestore, name, MODULAR_DEPRECATION_ARG);
-}
-
-/**
- * @param {Firestore} firestore
- * @returns {FirebaseFirestoreTypes.WriteBatch}
- */
-export function writeBatch(firestore) {
-  return firestore.batch.call(firestore, MODULAR_DEPRECATION_ARG);
-}
-
-/**
- * Gets the `PersistentCacheIndexManager` instance used by this Cloud Firestore instance.
- * This is not the same as Cloud Firestore Indexes.
- * Persistent cache indexes are optional indexes that only exist within the SDK to assist in local query execution.
- * Returns `null` if local persistent storage is not in use.
- * @param {Firestore} firestore
- * @returns {PersistentCacheIndexManager | null}
- */
-export function getPersistentCacheIndexManager(firestore) {
-  return firestore.persistentCacheIndexManager.call(firestore, MODULAR_DEPRECATION_ARG);
-}
-
-/**
- * Enables the SDK to create persistent cache indexes automatically for local query
- * execution when the SDK believes cache indexes can help improves performance.
- * This feature is disabled by default.
- * @param {PersistentCacheIndexManager} indexManager
- * @returns {Promise<void}
- */
-export function enablePersistentCacheIndexAutoCreation(indexManager) {
-  return indexManager.enableIndexAutoCreation.call(indexManager, MODULAR_DEPRECATION_ARG);
-}
-
-/**
- * Stops creating persistent cache indexes automatically for local query execution.
- * The indexes which have been created by calling `enableIndexAutoCreation()` still take effect.
- * @param {PersistentCacheIndexManager} indexManager
- * @returns {Promise<void}
- */
-export function disablePersistentCacheIndexAutoCreation(indexManager) {
-  return indexManager.disableIndexAutoCreation.call(indexManager, MODULAR_DEPRECATION_ARG);
-}
-
-/**
- * Removes all persistent cache indexes. Note this function also deletes indexes
- * generated by `setIndexConfiguration()`, which is deprecated.
- * @param {PersistentCacheIndexManager} indexManager
- * @returns {Promise<void}
- */
-export function deleteAllPersistentCacheIndexes(indexManager) {
-  return indexManager.deleteAllIndexes.call(indexManager, MODULAR_DEPRECATION_ARG);
-}
-
-export * from './query';
-export * from './snapshot';
-export * from './Bytes';
-export * from './FieldPath';
-export * from './FieldValue';
-export * from './GeoPoint';
-export * from './Timestamp';
-export * from './VectorValue';
-export { Filter } from '../FirestoreFilter';