@react-native-firebase/firestore 23.8.6 → 24.0.0

package/lib/FirestoreDocumentSnapshot.js

@@ -1,132 +0,0 @@
-/*
- * Copyright (c) 2016-present Invertase Limited & Contributors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this library except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *   http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- *
- */
-
-import { isArray, isString } from '@react-native-firebase/app/dist/module/common';
-import FirestoreDocumentReference, {
-  provideDocumentSnapshotClass,
-} from './FirestoreDocumentReference';
-import FirestoreFieldPath, { fromDotSeparatedString } from './FirestoreFieldPath';
-import FirestorePath from './FirestorePath';
-import FirestoreSnapshotMetadata from './FirestoreSnapshotMetadata';
-import { extractFieldPathData } from './utils';
-import { parseNativeMap } from './utils/serialize';
-
-export default class FirestoreDocumentSnapshot {
-  constructor(firestore, nativeData) {
-    this._data = parseNativeMap(firestore, nativeData.data);
-    this._metadata = new FirestoreSnapshotMetadata(nativeData.metadata);
-    this._ref = new FirestoreDocumentReference(firestore, FirestorePath.fromName(nativeData.path));
-    this._exists = nativeData.exists;
-  }
-
-  get id() {
-    return this._ref.id;
-  }
-
-  get metadata() {
-    return this._metadata;
-  }
-
-  get ref() {
-    return this._ref;
-  }
-
-  exists() {
-    return this._exists;
-  }
-
-  data() {
-    // TODO: ehesp: Figure out how to handle this.
-    // const snapshotOptions = {};
-    //
-    // if (!isUndefined(options)) {
-    //   if (!isObject(options)) {
-    //     throw new Error(
-    //       `firebase.firestore() DocumentSnapshot.data(*) 'options' expected an object if defined.`,
-    //     );
-    //   }
-    //
-    //   if (
-    //     options.serverTimestamps &&
-    //     options.serverTimestamps !== 'estimate' &&
-    //     options.serverTimestamps !== 'previous' &&
-    //     options.serverTimestamps !== 'none'
-    //   ) {
-    //     throw new Error(
-    //       `firebase.firestore() DocumentSnapshot.data(*) 'options.serverTimestamps' expected one of 'estimate', 'previous' or 'none'.`,
-    //     );
-    //   }
-    // }
-
-    return this._data;
-  }
-
-  get(fieldPath) {
-    // TODO: ehesp: How are SnapshotOptions handled?
-
-    if (
-      !isString(fieldPath) &&
-      !(fieldPath instanceof FirestoreFieldPath) &&
-      !Array.isArray(fieldPath)
-    ) {
-      throw new Error(
-        "firebase.firestore() DocumentSnapshot.get(*) 'fieldPath' expected type string, array or FieldPath.",
-      );
-    }
-
-    let path;
-
-    if (isString(fieldPath)) {
-      try {
-        path = fromDotSeparatedString(fieldPath);
-      } catch (e) {
-        throw new Error(`firebase.firestore() DocumentSnapshot.get(*) 'fieldPath' ${e.message}.`);
-      }
-    } else if (isArray(fieldPath)) {
-      path = new FirestoreFieldPath(...fieldPath);
-    } else {
-      // Is already field path
-      path = fieldPath;
-    }
-
-    return extractFieldPathData(this._data, path._segments);
-  }
-
-  isEqual(other) {
-    if (!(other instanceof FirestoreDocumentSnapshot)) {
-      throw new Error(
-        "firebase.firestore() DocumentSnapshot.isEqual(*) 'other' expected a DocumentSnapshot instance.",
-      );
-    }
-
-    if (
-      this.exists() !== other.exists() ||
-      !this.metadata.isEqual(other.metadata) ||
-      !this.ref.isEqual(other.ref)
-    ) {
-      return false;
-    }
-
-    const thisData = JSON.stringify(this.data());
-    const otherData = JSON.stringify(other.data());
-
-    return thisData === otherData;
-  }
-}
-
-// To avoid React Native require cycle
-provideDocumentSnapshotClass(FirestoreDocumentSnapshot);

package/lib/FirestoreFilter.js

@@ -1,156 +0,0 @@
-import {
-  isString,
-  isNull,
-  isUndefined,
-  isArray,
-} from '@react-native-firebase/app/dist/module/common';
-import { fromDotSeparatedString } from './FirestoreFieldPath';
-import { generateNativeData } from './utils/serialize';
-import { OPERATORS } from './FirestoreQueryModifiers';
-const AND_QUERY = 'AND';
-const OR_QUERY = 'OR';
-
-export function Filter(fieldPath, operator, value) {
-  return new _Filter(fieldPath, operator, value);
-}
-
-export function _Filter(fieldPath, operator, value, filterOperator, queries) {
-  if ([AND_QUERY, OR_QUERY].includes(filterOperator)) {
-    // AND or OR Filter (list of Filters)
-    this.operator = filterOperator;
-    this.queries = queries;
-
-    this._toMap = function _toMap() {
-      return {
-        operator: this.operator,
-        queries: this.queries.map(query => query._toMap()),
-      };
-    };
-
-    return this;
-  } else {
-    // Filter
-    this.fieldPath = fieldPath;
-    this.operator = operator;
-    this.value = value;
-
-    this._toMap = function _toMap() {
-      return {
-        fieldPath: this.fieldPath,
-        operator: this.operator,
-        value: this.value,
-      };
-    };
-
-    return this;
-  }
-}
-
-Filter.and = function and(...queries) {
-  if (queries.length > 10 || queries.length < 1) {
-    throw new Error(`Expected 1-10 instances of Filter, but got ${queries.length} Filters`);
-  }
-
-  const validateFilters = queries.every(filter => filter instanceof _Filter);
-
-  if (!validateFilters) {
-    throw new Error('Expected every argument to be an instance of Filter');
-  }
-
-  return new _Filter(null, null, null, AND_QUERY, queries);
-};
-
-function hasOrOperator(obj) {
-  return obj.operator === 'OR' || (Array.isArray(obj.queries) && obj.queries.some(hasOrOperator));
-}
-
-Filter.or = function or(...queries) {
-  if (queries.length > 10 || queries.length < 1) {
-    throw new Error(`Expected 1-10 instances of Filter, but got ${queries.length} Filters`);
-  }
-
-  const validateFilters = queries.every(filter => filter instanceof _Filter);
-
-  if (!validateFilters) {
-    throw new Error('Expected every argument to be an instance of Filter');
-  }
-
-  const hasOr = queries.some(hasOrOperator);
-
-  if (hasOr) {
-    throw new Error('OR Filters with nested OR Filters are not supported');
-  }
-
-  return new _Filter(null, null, null, OR_QUERY, queries);
-};
-
-function mapFieldQuery({ fieldPath, operator, value, queries }, modifiers) {
-  if (operator === AND_QUERY || operator === OR_QUERY) {
-    return {
-      operator,
-      queries: queries.map(filter => mapFieldQuery(filter, modifiers)),
-    };
-  }
-
-  let path;
-  if (isString(fieldPath)) {
-    try {
-      path = fromDotSeparatedString(fieldPath);
-    } catch (e) {
-      throw new Error(`first argument of Filter(*,_ , _) 'fieldPath' ${e.message}.`);
-    }
-  } else {
-    path = fieldPath;
-  }
-
-  if (!modifiers.isValidOperator(operator)) {
-    throw new Error(
-      "second argument of Filter(*,_ , _) 'opStr' is invalid. Expected one of '==', '>', '>=', '<', '<=', '!=', 'array-contains', 'not-in', 'array-contains-any' or 'in'.",
-    );
-  }
-
-  if (isUndefined(value)) {
-    throw new Error("third argument of Filter(*,_ , _) 'value' argument expected.");
-  }
-
-  if (
-    isNull(value) &&
-    !modifiers.isEqualOperator(operator) &&
-    !modifiers.isNotEqualOperator(operator)
-  ) {
-    throw new Error(
-      "third argument of Filter(*,_ , _) 'value' is invalid. You can only perform equals comparisons on null",
-    );
-  }
-
-  if (modifiers.isInOperator(operator)) {
-    if (!isArray(value) || !value.length) {
-      throw new Error(
-        `third argument of Filter(*,_ , _) 'value' is invalid. A non-empty array is required for '${operator}' filters.`,
-      );
-    }
-
-    if (value.length > 10) {
-      throw new Error(
-        `third argument of Filter(*,_ , _) 'value' is invalid. '${operator}' filters support a maximum of 10 elements in the value array.`,
-      );
-    }
-  }
-
-  return {
-    fieldPath: path,
-    operator: OPERATORS[operator],
-    value: generateNativeData(value, true),
-  };
-}
-
-export function generateFilters(filter, modifiers) {
-  const filterMap = filter._toMap();
-
-  const queriesMaps = filterMap.queries.map(filter => mapFieldQuery(filter, modifiers));
-
-  return {
-    operator: filterMap.operator,
-    queries: queriesMaps,
-  };
-}

package/lib/modular/Bytes.d.ts

@@ -1,11 +0,0 @@
-export declare class Bytes extends FirestoreBlob {
-  static fromBase64String(base64: string): Bytes;
-
-  static fromUint8Array(array: Uint8Array): Bytes;
-
-  toBase64(): string;
-
-  toUint8Array(): Uint8Array;
-
-  isEqual(other: Bytes): boolean;
-}

package/lib/modular/Bytes.js

@@ -1,62 +0,0 @@
-import FirestoreBlob from '../FirestoreBlob';
-
-/**
- * An immutable object representing an array of bytes.
- */
-export class Bytes extends FirestoreBlob {
-  /**
-   * @hideconstructor
-   * @param {firebase.firestore.Blob} blob
-   */
-  constructor(blob) {
-    super(true);
-    // binary string was already parsed and created, potentially expensive
-    // don't parse it again, just set it into the new FirebaseBlob
-    this._binaryString = blob._binaryString;
-  }
-
-  /**
-   * @param {string} base64
-   * @returns {Bytes}
-   */
-  static fromBase64String(base64) {
-    return new Bytes(FirestoreBlob.fromBase64String(base64));
-  }
-
-  /**
-   * @param {Uint8Array} array
-   * @returns {Bytes}
-   */
-  static fromUint8Array(array) {
-    return new Bytes(FirestoreBlob.fromUint8Array(array));
-  }
-
-  /**
-   * @returns {string}
-   */
-  toBase64() {
-    return super.toBase64();
-  }
-
-  /**
-   * @returns {Uint8Array}
-   */
-  toUint8Array() {
-    return super.toUint8Array();
-  }
-
-  /**
-   * @returns {string}
-   */
-  toString() {
-    return 'Bytes(base64: ' + this.toBase64() + ')';
-  }
-
-  /**
-   * @param {Bytes} other
-   * @returns {boolean}
-   */
-  isEqual(other) {
-    return super.isEqual(other);
-  }
-}

package/lib/modular/FieldPath.d.ts

@@ -1,20 +0,0 @@
-/**
- * A `FieldPath` refers to a field in a document. The path may consist of a
- * single field name (referring to a top-level field in the document), or a
- * list of field names (referring to a nested field in the document).
- *
- * Create a `FieldPath` by providing field names. If more than one field
- * name is provided, the path will point to a nested field in a document.
- */
-export declare class FieldPath {
-  constructor(...fieldNames: string[]);
-
-  isEqual(other: FieldPath): boolean;
-}
-
-/**
- * Returns a special sentinel FieldPath to refer to the ID of a document
- * It can be used in queries to sort or filter by the document ID
- */
-
-export declare function documentId(): FieldPath;

package/lib/modular/FieldPath.js

@@ -1,7 +0,0 @@
-import FirestoreFieldPath from '../FirestoreFieldPath';
-
-export const FieldPath = FirestoreFieldPath;
-
-export function documentId() {
-  return FieldPath.documentId();
-}

package/lib/modular/FieldValue.d.ts

@@ -1,67 +0,0 @@
-/**
- * Sentinel values that can be used when writing document fields with `set()`
- * or `update()`.
- */
-export declare class FieldValue {
-  isEqual(other: FieldValue): boolean;
-}
-
-/**
- * Returns a sentinel for use with {@link @firebase/firestore#(updateDoc:1)} or
- * {@link @firebase/firestore/lite#(setDoc:1)} with `{merge: true}` to mark a field for deletion.
- */
-export function deleteField(): FieldValue;
-
-/**
- * Returns a sentinel used with {@link @firebase/firestore#(setDoc:1)} or {@link @firebase/firestore/lite#(updateDoc:1)} to
- * include a server-generated timestamp in the written data.
- */
-export function serverTimestamp(): FieldValue;
-
-/**
- * Returns a special value that can be used with {@link @firebase/firestore#(setDoc:1)} or {@link
- * @firebase/firestore/lite#(updateDoc:1)} that tells the server to union the given elements with any array
- * value that already exists on the server. Each specified element that doesn't
- * already exist in the array will be added to the end. If the field being
- * modified is not already an array it will be overwritten with an array
- * containing exactly the specified elements.
- *
- * @param elements - The elements to union into the array.
- * @returns The `FieldValue` sentinel for use in a call to `setDoc()` or
- * `updateDoc()`.
- */
-export function arrayUnion(...elements: unknown[]): FieldValue;
-
-/**
- * Returns a special value that can be used with {@link (setDoc:1)} or {@link
- * updateDoc:1} that tells the server to remove the given elements from any
- * array value that already exists on the server. All instances of each element
- * specified will be removed from the array. If the field being modified is not
- * already an array it will be overwritten with an empty array.
- *
- * @param elements - The elements to remove from the array.
- * @returns The `FieldValue` sentinel for use in a call to `setDoc()` or
- * `updateDoc()`
- */
-export function arrayRemove(...elements: unknown[]): FieldValue;
-
-/**
- * Returns a special value that can be used with {@link @firebase/firestore#(setDoc:1)} or {@link
- * @firebase/firestore/lite#(updateDoc:1)} that tells the server to increment the field's current value by
- * the given value.
- *
- * If either the operand or the current field value uses floating point
- * precision, all arithmetic follows IEEE 754 semantics. If both values are
- * integers, values outside of JavaScript's safe number range
- * (`Number.MIN_SAFE_INTEGER` to `Number.MAX_SAFE_INTEGER`) are also subject to
- * precision loss. Furthermore, once processed by the Firestore backend, all
- * integer operations are capped between -2^63 and 2^63-1.
- *
- * If the current field value is not of type `number`, or if the field does not
- * yet exist, the transformation sets the field to the given value.
- *
- * @param n - The value to increment by.
- * @returns The `FieldValue` sentinel for use in a call to `setDoc()` or
- * `updateDoc()`
- */
-export function increment(n: number): FieldValue;

package/lib/modular/FieldValue.js

@@ -1,41 +0,0 @@
-import FirestoreFieldValue from '../FirestoreFieldValue';
-
-export const FieldValue = FirestoreFieldValue;
-
-/**
- * @returns {FieldValue}
- */
-export function deleteField() {
-  return FieldValue.delete();
-}
-
-/**
- * @returns {FieldValue}
- */
-export function serverTimestamp() {
-  return FieldValue.serverTimestamp();
-}
-
-/**
- * @param {unknown} elements
- * @returns {FieldValue}
- */
-export function arrayUnion(...elements) {
-  return FieldValue.arrayUnion(...elements);
-}
-
-/**
- * @param {unknown} elements
- * @returns {FieldValue}
- */
-export function arrayRemove(...elements) {
-  return FieldValue.arrayRemove(...elements);
-}
-
-/**
- * @param {number} n
- * @returns {FieldValue}
- */
-export function increment(n) {
-  return FieldValue.increment(n);
-}

package/lib/modular/GeoPoint.d.ts

@@ -1,17 +0,0 @@
-/**
- * An immutable object representing a geographic location in Firestore. The
- * location is represented as latitude/longitude pair.
- *
- * Latitude values are in the range of [-90, 90].
- * Longitude values are in the range of [-180, 180].
- */
-export declare class GeoPoint {
-  readonly latitude: number;
-  readonly longitude: number;
-
-  constructor(latitude: number, longitude: number);
-
-  isEqual(other: GeoPoint): boolean;
-
-  toJSON(): { latitude: number; longitude: number };
-}

package/lib/modular/GeoPoint.js

@@ -1,3 +0,0 @@
-import FirestoreGeoPoint from '../FirestoreGeoPoint';
-
-export const GeoPoint = FirestoreGeoPoint;

package/lib/modular/Timestamp.d.ts

@@ -1,85 +0,0 @@
-/**
- * A `Timestamp` represents a point in time independent of any time zone or
- * calendar, represented as seconds and fractions of seconds at nanosecond
- * resolution in UTC Epoch time.
- *
- * It is encoded using the Proleptic Gregorian Calendar which extends the
- * Gregorian calendar backwards to year one. It is encoded assuming all minutes
- * are 60 seconds long, i.e. leap seconds are "smeared" so that no leap second
- * table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to
- * 9999-12-31T23:59:59.999999999Z.
- *
- * For examples and further specifications, refer to the
- * {@link https://github.com/google/protobuf/blob/master/src/google/protobuf/timestamp.proto | Timestamp definition}.
- */
-export declare class Timestamp {
-  readonly seconds: number;
-  readonly nanoseconds: number;
-
-  constructor(seconds: number, nanoseconds: number);
-
-  /**
-   * Creates a new timestamp with the current date, with millisecond precision.
-   *
-   * @returns a new timestamp representing the current date.
-   */
-  static now(): Timestamp;
-
-  /**
-   * Creates a new timestamp from the given date.
-   *
-   * @param date - The date to initialize the `Timestamp` from.
-   * @returns A new `Timestamp` representing the same point in time as the given
-   *     date.
-   */
-  static fromDate(date: Date): Timestamp;
-
-  /**
-   * Creates a new timestamp from the given number of milliseconds.
-   *
-   * @param milliseconds - Number of milliseconds since Unix epoch
-   *     1970-01-01T00:00:00Z.
-   * @returns A new `Timestamp` representing the same point in time as the given
-   *     number of milliseconds.
-   */
-  static fromMillis(milliseconds: number): Timestamp;
-
-  /**
-   * Converts a `Timestamp` to a JavaScript `Date` object. This conversion
-   * causes a loss of precision since `Date` objects only support millisecond
-   * precision.
-   *
-   * @returns JavaScript `Date` object representing the same point in time as
-   *     this `Timestamp`, with millisecond precision.
-   */
-  toDate(): Date;
-
-  /**
-   * Converts a `Timestamp` to a numeric timestamp (in milliseconds since
-   * epoch). This operation causes a loss of precision.
-   *
-   * @returns The point in time corresponding to this timestamp, represented as
-   *     the number of milliseconds since Unix epoch 1970-01-01T00:00:00Z.
-   */
-  toMillis(): number;
-
-  /**
-   * Returns true if this `Timestamp` is equal to the provided one.
-   *
-   * @param other - The `Timestamp` to compare against.
-   * @returns true if this `Timestamp` is equal to the provided one.
-   */
-  isEqual(other: Timestamp): boolean;
-
-  /** Returns a JSON-serializable representation of this `Timestamp`. */
-  toJSON(): { seconds: number; nanoseconds: number };
-
-  /** Returns a textual representation of this `Timestamp`. */
-  toString(): string;
-
-  /**
-   * Converts this object to a primitive string, which allows `Timestamp` objects
-   * to be compared using the `>`, `<=`, `>=` and `>` operators.
-   */
-  valueOf(): string;
-}

package/lib/modular/Timestamp.js

@@ -1,3 +0,0 @@
-import FirestoreTimestamp from '../FirestoreTimestamp';
-
-export const Timestamp = FirestoreTimestamp;

package/lib/modular/VectorValue.d.ts

@@ -1,30 +0,0 @@
-/**
- * Represents a vector type in Firestore documents. Create an instance with vector().
- */
-export declare class VectorValue {
-  // Note the values array and constructor are not public APIs.
-
-  /**
-   * Builds a VectorValue instance from a JSON object created by VectorValue.toJSON().
-   *
-   * @param json a JSON object represention of a VectorValue instance.
-   */
-  static fromJSON(json: object): VectorValue;
-
-  /**
-   * Returns true if the two VectorValue values have the same raw number arrays, returns false otherwise.
-   */
-  isEqual(other: VectorValue): boolean;
-
-  /**
-   * Returns a copy of the raw number array form of the vector.
-   */
-  toArray(): number[];
-
-  /**
-   * Returns a JSON-serializable representation of this VectorValue instance.
-   */
-  toJSON(): { values: number[] };
-}
-
-export declare function vector(values?: number[]): VectorValue;

package/lib/modular/VectorValue.js

@@ -1,11 +0,0 @@
-import FirestoreVectorValue from '../FirestoreVectorValue';
-
-export const VectorValue = FirestoreVectorValue;
-
-/**
- * @param {number[]=} values
- * @returns {VectorValue}
- */
-export function vector(values) {
-  return new VectorValue(values);
-}