@react-native-firebase/database 24.1.1 → 25.0.1

package/lib/modular/query.js

@@ -1,305 +0,0 @@
-/**
- * @typedef {import('../..').DatabaseReference} DatabaseReference
- * @typedef {import('../..').DataSnapshot} DataSnapshot
- * @typedef {import('./query').QueryConstraint} IQueryConstraint
- * @typedef {import('./query').Query} Query
- * @typedef {import('./query').OnDisconnect} OnDisconnect
- * @typedef {import('./query').ListenOptions} ListenOptions
- * @typedef {import('./query').Unsubscribe} Unsubscribe
- * @typedef {import('./query').EventType} EventType
- * @typedef {import('./query').ThenableReference} ThenableReference
- */
-
-/**
- * @implements {IQueryConstraint}
- */
-
-import { MODULAR_DEPRECATION_ARG } from '@react-native-firebase/app/dist/module/common';
-
-class QueryConstraint {
-  constructor(type, ...args) {
-    this._type = type;
-    this._args = args;
-  }
-
-  _apply(query) {
-    return query[this._type].apply(query, [...this._args, MODULAR_DEPRECATION_ARG]);
-  }
-}
-
-/**
- * @param {number | string | boolean | null} value
- * @param {string?} key
- * @returns {QueryConstraint}
- */
-export function endAt(value, key) {
-  return new QueryConstraint('endAt', value, key);
-}
-
-/**
- * @param {number | string | boolean | null} value
- * @param {string?} key
- * @returns {QueryConstraint}
- */
-export function endBefore(value, key) {
-  return new QueryConstraint('endBefore', value, key);
-}
-
-/**
- * @param {number | string | boolean | null} value,
- * @param {string?} key,
- * @returns {QueryConstraint}
- */
-export function startAt(value, key) {
-  return new QueryConstraint('startAt', value, key);
-}
-
-/**
- * @param {number | string | boolean | null} value,
- * @param {string?} key,
- * @returns {QueryConstraint}
- */
-export function startAfter(value, key) {
-  return new QueryConstraint('startAfter', value, key);
-}
-
-/**
- * @param {number} limit
- * @returns {QueryConstraint}
- */
-export function limitToFirst(limit) {
-  return new QueryConstraint('limitToFirst', limit);
-}
-
-/**
- * @param {number} limit
- * @returns {QueryConstraint}
- */
-export function limitToLast(limit) {
-  return new QueryConstraint('limitToLast', limit);
-}
-
-/**
- * @param {string} path
- * @returns {QueryConstraint}
- */
-export function orderByChild(path) {
-  return new QueryConstraint('orderByChild', path);
-}
-
-export function orderByKey() {
-  return new QueryConstraint('orderByKey');
-}
-
-export function orderByPriority() {
-  return new QueryConstraint('orderByPriority');
-}
-
-export function orderByValue() {
-  return new QueryConstraint('orderByValue');
-}
-
-/**
- * @param {number | string | boolean | null} value
- * @param {string?} key
- * @returns {QueryConstraint}
- */
-export function equalTo(value, key) {
-  return new QueryConstraint('equalTo', value, key);
-}
-
-/**
- * @param {Query} query
- * @param {QueryConstraint[]} queryConstraints
- * @returns {Query}
- */
-export function query(query, ...queryConstraints) {
-  let q = query;
-  for (const queryConstraint of queryConstraints) {
-    q = queryConstraint._apply(q);
-  }
-  return q;
-}
-
-/**
- * @param {Query} query
- * @param {EventType} eventType
- * @param {(snapshot: DataSnapshot) => unknown} callback
- * @param {((error: Error) => unknown) | ListenOptions} cancelCallbackOrListenOptions
- * @param {ListenOptions?} options
- * @returns {Unsubscribe}
- */
-function addEventListener(query, eventType, callback, cancelCallbackOrListenOptions, options) {
-  let cancelCallback = cancelCallbackOrListenOptions;
-
-  if (typeof cancelCallbackOrListenOptions === 'object') {
-    cancelCallback = undefined;
-    options = cancelCallbackOrListenOptions;
-  }
-
-  if (options && options.onlyOnce) {
-    const userCallback = callback;
-    callback = snapshot => {
-      query.off.call(query, eventType, callback, null, MODULAR_DEPRECATION_ARG);
-      return userCallback(snapshot);
-    };
-  }
-
-  query.on.call(query, eventType, callback, cancelCallback, null, MODULAR_DEPRECATION_ARG);
-
-  return () => query.off.call(query, eventType, callback, null, MODULAR_DEPRECATION_ARG);
-}
-
-/**
- * @param {Query} query
- * @param {(snapshot: DataSnapshot) => unknown} callback
- * @param {((error: Error) => unknown) | ListenOptions | undefined} cancelCallbackOrListenOptions
- * @param {ListenOptions?} options
- * @returns {Unsubscribe}
- */
-export function onValue(query, callback, cancelCallbackOrListenOptions, options) {
-  return addEventListener(query, 'value', callback, cancelCallbackOrListenOptions, options);
-}
-
-/**
- * @param {Query} query
- * @param {(snapshot: DataSnapshot, previousChildName: string | null) => unknown} callback
- * @param {((error: Error) => unknown) | ListenOptions | undefined} cancelCallbackOrListenOptions
- * @param {ListenOptions?} options
- * @returns {Unsubscribe}
- */
-export function onChildAdded(query, callback, cancelCallbackOrListenOptions, options) {
-  return addEventListener(query, 'child_added', callback, cancelCallbackOrListenOptions, options);
-}
-
-/**
- * @param {Query} query
- * @param {(snapshot: DataSnapshot, previousChildName: string | null) => unknown} callback
- * @param {((error: Error) => unknown) | ListenOptions | undefined} cancelCallbackOrListenOptions
- * @param {ListenOptions?} options
- * @returns {Unsubscribe}
- */
-export function onChildChanged(query, callback, cancelCallbackOrListenOptions, options) {
-  return addEventListener(query, 'child_changed', callback, cancelCallbackOrListenOptions, options);
-}
-
-/**
- * @param {Query} query
- * @param {(snapshot: DataSnapshot, previousChildName: string | null) => unknown} callback
- * @param {((error: Error) => unknown) | ListenOptions | undefined} cancelCallbackOrListenOptions
- * @param {ListenOptions?} options
- * @returns {Unsubscribe}
- */
-export function onChildMoved(query, callback, cancelCallbackOrListenOptions, options) {
-  return addEventListener(query, 'child_moved', callback, cancelCallbackOrListenOptions, options);
-}
-
-/**
- * @param {Query} query
- * @param {(snapshot: DataSnapshot, previousChildName: string | null) => unknown} callback
- * @param {((error: Error) => unknown) | ListenOptions | undefined} cancelCallbackOrListenOptions
- * @param {ListenOptions?} options
- * @returns {Unsubscribe}
- */
-export function onChildRemoved(query, callback, cancelCallbackOrListenOptions, options) {
-  return addEventListener(query, 'child_removed', callback, cancelCallbackOrListenOptions, options);
-}
-
-/**
- * @param {DatabaseReference} ref
- * @param {unknown} value
- * @returns {Promise<void>}
- */
-export function set(ref, value) {
-  return ref.set.call(ref, value, () => {}, MODULAR_DEPRECATION_ARG);
-}
-
-/**
- * @param {DatabaseReference} ref
- * @param {string | number | null} priority
- * @returns {Promise<void>}
- */
-export function setPriority(ref, priority) {
-  return ref.setPriority.call(ref, priority, () => {}, MODULAR_DEPRECATION_ARG);
-}
-
-/**
- * @param {DatabaseReference} ref
- * @param {unknown} value
- * @param {string | number | null} priority
- * @returns {Promise<void>}
- */
-export function setWithPriority(ref, value, priority) {
-  return ref.setWithPriority.call(ref, value, priority, () => {}, MODULAR_DEPRECATION_ARG);
-}
-
-/**
- * @param {Query} query
- * @returns {DataSnapshot}
- */
-export function get(query) {
-  return query.once.call(
-    query,
-    'value',
-    () => {},
-    () => {},
-    {},
-    MODULAR_DEPRECATION_ARG,
-  );
-}
-
-export function off(_query, _eventType, _callback) {
-  throw new Error('off() is not implemented - use unsubscriber callback returned when subscribing');
-}
-
-/**
- * @param {DatabaseReference} parent
- * @param {string} path
- * @returns {DatabaseReference}
- */
-export function child(parent, path) {
-  return parent.child.call(parent, path, MODULAR_DEPRECATION_ARG);
-}
-
-/**
- * @param {DatabaseReference} ref
- * @returns {OnDisconnect}
- */
-export function onDisconnect(ref) {
-  return ref.onDisconnect.call(ref, MODULAR_DEPRECATION_ARG);
-}
-
-/**
- * @param {DatabaseReference} ref
- * @param {boolean} value
- * @returns {Promise<void>}
- */
-export function keepSynced(ref, value) {
-  return ref.keepSynced.call(ref, value, MODULAR_DEPRECATION_ARG);
-}
-
-/**
- * @param {DatabaseReference} parent
- * @param {unknown} value
- * @returns {ThenableReference}
- */
-export function push(parent, value) {
-  return parent.push.call(parent, value, MODULAR_DEPRECATION_ARG);
-}
-
-/**
- * @param {DatabaseReference} ref
- * @returns {Promise<void>}
- */
-export function remove(ref) {
-  return ref.remove.call(ref, MODULAR_DEPRECATION_ARG);
-}
-
-/**
- * @param {DatabaseReference} ref
- * @param {object} values
- * @returns {Promise<void>}
- */
-export function update(ref, values) {
-  return ref.update.call(ref, values, MODULAR_DEPRECATION_ARG);
-}

package/lib/modular/transaction.d.ts

@@ -1,54 +0,0 @@
-import { FirebaseDatabaseTypes } from '../..';
-
-export type TransactionResult = FirebaseDatabaseTypes.TransactionResult;
-import DatabaseReference = FirebaseDatabaseTypes.Reference;
-
-/**
- * An options object to configure transactions.
- */
-export interface TransactionOptions {
-  readonly applyLocally?: boolean;
-}
-
-/**
- * Atomically modifies the data at this location.
- *
- * Atomically modify the data at this location. Unlike a normal `set()`, which
- * just overwrites the data regardless of its previous value, `runTransaction()` is
- * used to modify the existing value to a new value, ensuring there are no
- * conflicts with other clients writing to the same location at the same time.
- *
- * To accomplish this, you pass `runTransaction()` an update function which is
- * used to transform the current value into a new value. If another client
- * writes to the location before your new value is successfully written, your
- * update function will be called again with the new current value, and the
- * write will be retried. This will happen repeatedly until your write succeeds
- * without conflict or you abort the transaction by not returning a value from
- * your update function.
- *
- * Note: Modifying data with `set()` will cancel any pending transactions at
- * that location, so extreme care should be taken if mixing `set()` and
- * `runTransaction()` to update the same data.
- *
- * Note: When using transactions with Security and Firebase Rules in place, be
- * aware that a client needs `.read` access in addition to `.write` access in
- * order to perform a transaction. This is because the client-side nature of
- * transactions requires the client to read the data in order to transactionally
- * update it.
- *
- * @param ref - The location to atomically modify.
- * @param transactionUpdate - A developer-supplied function which will be passed
- * the current data stored at this location (as a JavaScript object). The
- * function should return the new value it would like written (as a JavaScript
- * object). If `undefined` is returned (i.e. you return with no arguments) the
- * transaction will be aborted and the data at this location will not be
- * modified.
- * @param options - An options object to configure transactions.
- * @returns A `Promise` that can optionally be used instead of the `onComplete`
- * callback to handle success and failure.
- */
-export function runTransaction(
-  ref: DatabaseReference,
-  transactionUpdate: (currentData: any) => unknown,
-  options?: TransactionOptions,
-): Promise<TransactionResult>;

package/lib/modular/transaction.js

@@ -1,24 +0,0 @@
-/**
- * @typedef {import('./database').DatabaseReference} DatabaseReference
- * @typedef {import('./transaction').TransactionOptions} TransactionOptions
- * @typedef {import('./transaction').TransactionResult} TransactionResult
- */
-
-/**
- * @param {DatabaseReference} ref
- * @param {(options: any) => unknown} transactionUpdate
- * @param {TransactionOptions?} options
- * @returns {Promise<TransactionResult>}
- */
-
-import { MODULAR_DEPRECATION_ARG } from '@react-native-firebase/app/dist/module/common';
-
-export function runTransaction(ref, transactionUpdate, options) {
-  return ref.transaction.call(
-    ref,
-    transactionUpdate,
-    undefined,
-    options && options.applyLocally,
-    MODULAR_DEPRECATION_ARG,
-  );
-}

package/lib/version.js

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

package/lib/web/RNFBDatabaseModule.android.js

@@ -1,2 +0,0 @@
-// No-op for android.
-export default {};

package/lib/web/RNFBDatabaseModule.ios.js

@@ -1,2 +0,0 @@
-// No-op for ios.
-export default {};