@react-native-firebase/firestore 23.8.8 → 24.0.0

package/lib/web/query.ts

@@ -0,0 +1,150 @@
+/*
+ * 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 {
+  FieldPath,
+  query,
+  where,
+  orderBy,
+  limit,
+  limitToLast,
+  startAt,
+  startAfter,
+  endAt,
+  endBefore,
+  and,
+  or,
+} from '@react-native-firebase/app/dist/module/internal/web/firebaseFirestore';
+import type {
+  Firestore,
+  Query,
+  QueryConstraint,
+} from '@react-native-firebase/app/dist/module/internal/web/firebaseFirestore';
+import { parseTypeMap, readableToArray } from './convert';
+
+export interface FilterSpec {
+  fieldPath?: string[] | { _segments: string[] };
+  operator?: string;
+  value?: unknown;
+  queries?: FilterSpec[];
+}
+
+export interface OrderSpec {
+  fieldPath: string[] | string;
+  direction: string;
+}
+
+export interface QueryOptions {
+  limit?: number;
+  limitToLast?: number;
+  startAt?: unknown[];
+  startAfter?: unknown[];
+  endAt?: unknown[];
+  endBefore?: unknown[];
+}
+
+export function buildQuery(
+  queryInstance: Query,
+  filters: FilterSpec[],
+  orders: OrderSpec[],
+  options: QueryOptions,
+): Query {
+  let current: Query = queryInstance;
+
+  for (const filter of filters) {
+    current = query(current, getFilterConstraint(filter, queryInstance.firestore));
+  }
+
+  for (const order of orders) {
+    const fieldPath =
+      typeof order.fieldPath === 'string'
+        ? order.fieldPath
+        : new FieldPath(...(order.fieldPath as string[]));
+    const direction = order.direction === 'ASCENDING' ? 'asc' : 'desc';
+    current = query(current, orderBy(fieldPath, direction));
+  }
+
+  if ('limit' in options && options.limit !== undefined) {
+    current = query(current, limit(options.limit));
+  }
+  if ('limitToLast' in options && options.limitToLast !== undefined) {
+    current = query(current, limitToLast(options.limitToLast));
+  }
+  if ('startAt' in options && options.startAt !== undefined) {
+    const fieldList = readableToArray(queryInstance.firestore, options.startAt as unknown[]);
+    current = query(current, startAt(...fieldList));
+  }
+  if ('startAfter' in options && options.startAfter !== undefined) {
+    const fieldList = readableToArray(queryInstance.firestore, options.startAfter as unknown[]);
+    current = query(current, startAfter(...fieldList));
+  }
+  if ('endAt' in options && options.endAt !== undefined) {
+    const fieldList = readableToArray(queryInstance.firestore, options.endAt as unknown[]);
+    current = query(current, endAt(...fieldList));
+  }
+  if ('endBefore' in options && options.endBefore !== undefined) {
+    const fieldList = readableToArray(queryInstance.firestore, options.endBefore as unknown[]);
+    current = query(current, endBefore(...fieldList));
+  }
+
+  return current;
+}
+
+function getFilterConstraint(filter: FilterSpec, firestore: Firestore): QueryConstraint {
+  if ('fieldPath' in filter && filter.fieldPath) {
+    const fieldPath = Array.isArray(filter.fieldPath)
+      ? new FieldPath(...filter.fieldPath)
+      : new FieldPath(...(filter.fieldPath as { _segments: string[] })._segments);
+    const operator = filter.operator;
+    const value = parseTypeMap(firestore, filter.value as [number, unknown?]);
+
+    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 && filter.queries) {
+    const constraints = filter.queries.map(f => getFilterConstraint(f, firestore));
+
+    if (filter.operator === 'AND') {
+      return and(...(constraints as Parameters<typeof and>)) as unknown as QueryConstraint;
+    }
+    if (filter.operator === 'OR') {
+      return or(...(constraints as Parameters<typeof or>)) as unknown as QueryConstraint;
+    }
+    throw new Error('Invalid filter operator');
+  }
+
+  throw new Error('Invalid filter.');
+}

package/package.json

@@ -1,14 +1,15 @@
 {
   "name": "@react-native-firebase/firestore",
-  "version": "23.8.8",
+  "version": "24.0.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",
-  "types": "lib/index.d.ts",
+  "main": "./dist/module/index.js",
+  "types": "./dist/typescript/lib/index.d.ts",
   "scripts": {
-    "build": "genversion --semi lib/version.js",
+    "build": "genversion --esm --semi lib/version.ts",
     "build:clean": "rimraf android/build && rimraf ios/build",
-    "prepare": "yarn run build"
+    "compile": "bob build",
+    "prepare": "yarn run build && yarn compile"
   },
   "repository": {
     "type": "git",
@@ -30,11 +31,49 @@
     "react-native-url-polyfill": "3.0.0"
   },
   "peerDependencies": {
-    "@react-native-firebase/app": "23.8.8"
+    "@react-native-firebase/app": "24.0.0"
   },
   "publishConfig": {
     "access": "public",
     "provenance": true
   },
-  "gitHead": "d17b898bee0be82259fc1b88f46106a927bf81aa"
+  "devDependencies": {
+    "react-native-builder-bob": "^0.40.13"
+  },
+  "exports": {
+    ".": {
+      "source": "./lib/index.ts",
+      "types": "./dist/typescript/lib/index.d.ts",
+      "default": "./dist/module/index.js"
+    },
+    "./pipelines": {
+      "source": "./lib/pipelines/index.ts",
+      "types": "./dist/typescript/lib/pipelines/index.d.ts",
+      "default": "./dist/module/pipelines/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "react-native-builder-bob": {
+    "source": "lib",
+    "output": "dist",
+    "targets": [
+      [
+        "module",
+        {
+          "esm": true
+        }
+      ],
+      [
+        "typescript",
+        {
+          "tsc": "../../node_modules/.bin/tsc"
+        }
+      ]
+    ]
+  },
+  "eslintIgnore": [
+    "node_modules/",
+    "dist/"
+  ],
+  "gitHead": "46c48499190be2dc9b9792d39c251db29495a607"
 }

package/tsconfig.json

@@ -0,0 +1,35 @@
+{
+  "extends": "../../tsconfig.packages.base.json",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "rootDir": ".",
+    "paths": {
+      "@react-native-firebase/app/dist/module/common/*": [
+        "../app/dist/typescript/lib/common/*"
+      ],
+      "@react-native-firebase/app/dist/module/common": [
+        "../app/dist/typescript/lib/common"
+      ],
+      "@react-native-firebase/app/dist/module/internal/web/*": [
+        "../app/dist/typescript/lib/internal/web/*"
+      ],
+      "@react-native-firebase/app/dist/module/internal/*": [
+        "../app/dist/typescript/lib/internal/*"
+      ],
+      "@react-native-firebase/app/dist/module/internal": [
+        "../app/dist/typescript/lib/internal"
+      ],
+      "@react-native-firebase/app": [
+        "../app/dist/typescript/lib"
+      ],
+      "@react-native-firebase/app/dist/module/types/internal": [
+        "../app/dist/typescript/lib/types/internal"
+      ],
+      "@react-native-firebase/app/dist/module/types/common": [
+        "../app/dist/typescript/lib/types/common"
+      ]
+    }
+  },
+  "include": ["lib/**/*"],
+  "exclude": ["node_modules", "dist", "__tests__", "**/*.test.ts"]
+}

package/lib/FirestoreBlob.js

@@ -1,107 +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 { Base64, isString } from '@react-native-firebase/app/dist/module/common';
-
-export default class FirestoreBlob {
-  constructor(internal = false, binaryString = undefined) {
-    if (internal === false) {
-      throw new Error(
-        'firebase.firestore.Blob constructor is private, use Blob.<field>() instead.',
-      );
-    }
-
-    this._binaryString = binaryString;
-  }
-
-  /**
-   * Creates a new Blob from the given Base64 string
-   *
-   * @url https://firebase.google.com/docs/reference/js/firebase.firestore.Blob#.fromBase64String
-   * @param base64 string
-   */
-  static fromBase64String(base64) {
-    if (!isString(base64) || base64.length < 1) {
-      throw new Error(
-        'firestore.Blob.fromBase64String expects a string of at least 1 character in length',
-      );
-    }
-
-    return new FirestoreBlob(true, Base64.atob(base64));
-  }
-
-  /**
-   * Creates a new Blob from the given Uint8Array.
-   *
-   * @url https://firebase.google.com/docs/reference/js/firebase.firestore.Blob#.fromUint8Array
-   * @param array Array
-   */
-  static fromUint8Array(array) {
-    if (!(array instanceof Uint8Array)) {
-      throw new Error('firestore.Blob.fromUint8Array expects an instance of Uint8Array');
-    }
-
-    return new FirestoreBlob(
-      true,
-      Array.prototype.map.call(array, $ => String.fromCharCode($)).join(''),
-    );
-  }
-
-  /**
-   * Returns 'true' if this Blob is equal to the provided one.
-   * @url https://firebase.google.com/docs/reference/js/firebase.firestore.Blob#isEqual
-   * @param {*} blob Blob The Blob to compare against. Value must not be null.
-   * @returns boolean 'true' if this Blob is equal to the provided one.
-   */
-  isEqual(blob) {
-    if (!(blob instanceof FirestoreBlob)) {
-      throw new Error('firestore.Blob.isEqual expects an instance of Blob');
-    }
-
-    return this._binaryString === blob._binaryString;
-  }
-
-  /**
-   * Returns the bytes of a Blob as a Base64-encoded string.
-   *
-   * @url https://firebase.google.com/docs/reference/js/firebase.firestore.Blob#toBase64
-   * @returns string The Base64-encoded string created from the Blob object.
-   */
-  toBase64() {
-    return Base64.btoa(this._binaryString);
-  }
-
-  /**
-   * Returns the bytes of a Blob in a new Uint8Array.
-   *
-   * @url https://firebase.google.com/docs/reference/js/firebase.firestore.Blob#toUint8Array
-   * @returns non-null Uint8Array The Uint8Array created from the Blob object.
-   */
-  toUint8Array() {
-    return new Uint8Array(this._binaryString.split('').map(c => c.charCodeAt(0)));
-  }
-
-  /**
-   * Returns a string representation of this blob instance
-   *
-   * @returns {string}
-   * @memberof Blob
-   */
-  toString() {
-    return `firestore.Blob(base64: ${this.toBase64()})`;
-  }
-}

package/lib/FirestoreCollectionReference.js

@@ -1,70 +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 { generateFirestoreId, isObject } from '@react-native-firebase/app/dist/module/common';
-import FirestoreDocumentReference, {
-  provideCollectionReferenceClass,
-} from './FirestoreDocumentReference';
-import FirestoreQuery from './FirestoreQuery';
-import FirestoreQueryModifiers from './FirestoreQueryModifiers';
-
-export default class FirestoreCollectionReference extends FirestoreQuery {
-  constructor(firestore, collectionPath) {
-    super(firestore, collectionPath, new FirestoreQueryModifiers());
-  }
-
-  get id() {
-    return this._collectionPath.id;
-  }
-
-  get parent() {
-    const parent = this._collectionPath.parent();
-    if (!parent) {
-      return null;
-    }
-    return new FirestoreDocumentReference(this._firestore, parent);
-  }
-
-  get path() {
-    return this._collectionPath.relativeName;
-  }
-
-  add(data) {
-    if (!isObject(data)) {
-      throw new Error("firebase.firestore().collection().add(*) 'data' must be an object.");
-    }
-
-    const documentRef = this.doc();
-    return documentRef.set(data).then(() => Promise.resolve(documentRef));
-  }
-
-  doc(documentPath) {
-    const newPath = documentPath || generateFirestoreId();
-    const path = this._collectionPath.child(newPath);
-
-    if (!path.isDocument) {
-      throw new Error(
-        "firebase.firestore().collection().doc(*) 'documentPath' must point to a document.",
-      );
-    }
-
-    return new FirestoreDocumentReference(this._firestore, path);
-  }
-}
-
-// To avoid React Native require cycle warnings
-provideCollectionReferenceClass(FirestoreCollectionReference);

package/lib/FirestoreDocumentReference.js

@@ -1,222 +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 {
-  isObject,
-  isString,
-  isUndefined,
-  createDeprecationProxy,
-  filterModularArgument,
-} from '@react-native-firebase/app/dist/module/common';
-import NativeError from '@react-native-firebase/app/dist/module/internal/NativeFirebaseError';
-import { parseSetOptions, parseSnapshotArgs, parseUpdateArgs } from './utils';
-import { buildNativeMap, provideDocumentReferenceClass } from './utils/serialize';
-
-// To avoid React Native require cycle warnings
-let FirestoreCollectionReference = null;
-export function provideCollectionReferenceClass(collectionReference) {
-  FirestoreCollectionReference = collectionReference;
-}
-
-let FirestoreDocumentSnapshot = null;
-export function provideDocumentSnapshotClass(documentSnapshot) {
-  FirestoreDocumentSnapshot = documentSnapshot;
-}
-
-let _id = 0;
-
-export default class FirestoreDocumentReference {
-  constructor(firestore, documentPath) {
-    this._firestore = firestore;
-    this._documentPath = documentPath;
-  }
-
-  get firestore() {
-    return this._firestore;
-  }
-
-  get id() {
-    return this._documentPath.id;
-  }
-
-  get parent() {
-    const parentPath = this._documentPath.parent();
-    return new FirestoreCollectionReference(this._firestore, parentPath);
-  }
-
-  get path() {
-    return this._documentPath.relativeName;
-  }
-
-  collection(collectionPath) {
-    if (!isString(collectionPath)) {
-      throw new Error(
-        "firebase.firestore().doc().collection(*) 'collectionPath' must be a string value.",
-      );
-    }
-
-    if (collectionPath === '') {
-      throw new Error(
-        "firebase.firestore().doc().collection(*) 'collectionPath' must be a non-empty string.",
-      );
-    }
-
-    const path = this._documentPath.child(collectionPath);
-
-    if (!path.isCollection) {
-      throw new Error(
-        "firebase.firestore().doc().collection(*) 'collectionPath' must point to a collection.",
-      );
-    }
-
-    return new FirestoreCollectionReference(this._firestore, path);
-  }
-
-  delete() {
-    return this._firestore.native.documentDelete(this.path);
-  }
-
-  get(options) {
-    if (!isUndefined(options) && !isObject(options)) {
-      throw new Error("firebase.firestore().doc().get(*) 'options' must be an object is provided.");
-    }
-
-    if (
-      options &&
-      options.source &&
-      options.source !== 'default' &&
-      options.source !== 'server' &&
-      options.source !== 'cache'
-    ) {
-      throw new Error(
-        "firebase.firestore().doc().get(*) 'options' GetOptions.source must be one of 'default', 'server' or 'cache'.",
-      );
-    }
-
-    return this._firestore.native
-      .documentGet(this.path, options)
-      .then(data => createDeprecationProxy(new FirestoreDocumentSnapshot(this._firestore, data)));
-  }
-
-  isEqual(other) {
-    if (!(other instanceof FirestoreDocumentReference)) {
-      throw new Error(
-        "firebase.firestore().doc().isEqual(*) 'other' expected a DocumentReference instance.",
-      );
-    }
-
-    return !(
-      this.path !== other.path ||
-      this.firestore.app.name !== other.firestore.app.name ||
-      this.firestore.app.options.projectId !== other.firestore.app.options.projectId
-    );
-  }
-
-  onSnapshot(...args) {
-    let snapshotListenOptions;
-    let callback;
-    let onNext;
-    let onError;
-
-    try {
-      const options = parseSnapshotArgs(args);
-      snapshotListenOptions = options.snapshotListenOptions;
-      callback = options.callback;
-      onNext = options.onNext;
-      onError = options.onError;
-    } catch (e) {
-      throw new Error(`firebase.firestore().doc().onSnapshot(*) ${e.message}`);
-    }
-
-    function handleSuccess(documentSnapshot) {
-      callback(documentSnapshot, null);
-      onNext(documentSnapshot);
-    }
-
-    function handleError(error) {
-      callback(null, error);
-      onError(error);
-    }
-
-    const listenerId = _id++;
-
-    const onSnapshotSubscription = this._firestore.emitter.addListener(
-      this._firestore.eventNameForApp(`firestore_document_sync_event:${listenerId}`),
-      event => {
-        if (event.body.error) {
-          handleError(NativeError.fromEvent(event.body.error, 'firestore'));
-        } else {
-          const documentSnapshot = createDeprecationProxy(
-            new FirestoreDocumentSnapshot(this._firestore, event.body.snapshot),
-          );
-          handleSuccess(documentSnapshot);
-        }
-      },
-    );
-
-    const unsubscribe = () => {
-      onSnapshotSubscription.remove();
-      this._firestore.native.documentOffSnapshot(listenerId);
-    };
-
-    this._firestore.native.documentOnSnapshot(this.path, listenerId, snapshotListenOptions);
-
-    return unsubscribe;
-  }
-
-  set(data, options) {
-    if (!isObject(data)) {
-      throw new Error("firebase.firestore().doc().set(*) 'data' must be an object.");
-    }
-
-    let setOptions;
-    try {
-      setOptions = parseSetOptions(options);
-    } catch (e) {
-      throw new Error(`firebase.firestore().doc().set(_, *) ${e.message}.`);
-    }
-
-    return this._firestore.native.documentSet(
-      this.path,
-      buildNativeMap(data, this._firestore._settings.ignoreUndefinedProperties),
-      setOptions,
-    );
-  }
-
-  update(...args) {
-    const updatedArgs = filterModularArgument(args);
-    if (updatedArgs.length === 0) {
-      throw new Error(
-        'firebase.firestore().doc().update(*) expected at least 1 argument but was called with 0 arguments.',
-      );
-    }
-
-    let data;
-    try {
-      data = parseUpdateArgs(updatedArgs);
-    } catch (e) {
-      throw new Error(`firebase.firestore().doc().update(*) ${e.message}`);
-    }
-
-    return this._firestore.native.documentUpdate(
-      this.path,
-      buildNativeMap(data, this._firestore._settings.ignoreUndefinedProperties),
-    );
-  }
-}
-
-provideDocumentReferenceClass(FirestoreDocumentReference); // serialize