Merge ac4bf09 into 8697166

Author: wu-hui

.changeset/lemon-steaks-draw.md

@@ -0,0 +1,3 @@
+---
+
+---

integration/firestore/firebase_export.ts

@@ -55,5 +55,16 @@ const Timestamp = firebase.firestore.Timestamp;
 const GeoPoint = firebase.firestore.GeoPoint;
 const FieldValue = firebase.firestore.FieldValue;
 const Blob = firebase.firestore.Blob;
+const loadBundle = firebase.firestore.loadBundle;
+const namedQuery = firebase.firestore.namedQuery;
 
-export { Firestore, FieldValue, FieldPath, Timestamp, Blob, GeoPoint };
+export {
+  Firestore,
+  FieldValue,
+  FieldPath,
+  Timestamp,
+  Blob,
+  GeoPoint,
+  loadBundle,
+  namedQuery
+};

integration/firestore/firebase_export_memory.ts

@@ -55,5 +55,16 @@ const Timestamp = firebase.firestore.Timestamp;
 const GeoPoint = firebase.firestore.GeoPoint;
 const FieldValue = firebase.firestore.FieldValue;
 const Blob = firebase.firestore.Blob;
+const loadBundle = firebase.firestore.loadBundle;
+const namedQuery = firebase.firestore.namedQuery;
 
-export { Firestore, FieldValue, FieldPath, Timestamp, Blob, GeoPoint };
+export {
+  Firestore,
+  FieldValue,
+  FieldPath,
+  Timestamp,
+  Blob,
+  GeoPoint,
+  loadBundle,
+  namedQuery
+};

packages-exp/auth-exp/index.webworker.ts

@@ -37,7 +37,10 @@ registerAuth(ClientPlatform.WORKER);
 export function getAuth(app = getApp()): Auth {
   // Unlike the other environments, we need to explicitly check if indexedDb is
   // available. That means doing the whole rigamarole
-  const auth = _getProvider(app, _ComponentName.AUTH).getImmediate() as AuthImpl;
+  const auth = _getProvider(
+    app,
+    _ComponentName.AUTH
+  ).getImmediate() as AuthImpl;
 
   // This promise is intended to float; auth initialization happens in the
   // background, meanwhile the auth object may be used by the app.

packages/database/src/api/Database.ts

@@ -157,14 +157,17 @@ export class Database implements FirebaseService {
     validateUrl(apiName, 1, parsedURL);
 
     const repoInfo = parsedURL.repoInfo;
-    if (!repoInfo.isCustomHost() && repoInfo.host !== this.repo_.repoInfo_.host) {
+    if (
+      !repoInfo.isCustomHost() &&
+      repoInfo.host !== this.repo_.repoInfo_.host
+    ) {
       fatal(
         apiName +
           ': Host name does not match the current database: ' +
           '(found ' +
           repoInfo.host +
           ' but expected ' +
-          this.repo_.repoInfo_.host+
+          this.repo_.repoInfo_.host +
           ')'
       );
     }

packages/firebase/index.d.ts

@@ -8285,6 +8285,43 @@ declare namespace firebase.firestore {
     INTERNAL: { delete: () => Promise<void> };
   }
 
+  export function loadBundle(
+    db: Firestore,
+    bundleData: ArrayBuffer | ReadableStream<ArrayBuffer> | string
+  ): LoadBundleTask;
+
+  export function namedQuery(
+    db: Firestore,
+    name: string
+  ): Promise<Query<DocumentData> | null>;
+
+  export interface LoadBundleTask {
+    onProgress(
+      next?: (progress: LoadBundleTaskProgress) => any,
+      error?: (error: Error) => any,
+      complete?: () => void
+    ): void;
+
+    then<T, R>(
+      onFulfilled?: (a: LoadBundleTaskProgress) => T | PromiseLike<T>,
+      onRejected?: (a: Error) => R | PromiseLike<R>
+    ): Promise<T | R>;
+
+    catch<R>(
+      onRejected: (a: Error) => R | PromiseLike<R>
+    ): Promise<R | LoadBundleTaskProgress>;
+  }
+
+  export interface LoadBundleTaskProgress {
+    documentsLoaded: number;
+    totalDocuments: number;
+    bytesLoaded: number;
+    totalBytes: number;
+    taskState: TaskState;
+  }
+
+  export type TaskState = 'Error' | 'Running' | 'Success';
+
   /**
    * An immutable object representing a geo point in Firestore. The geo point
    * is represented as latitude/longitude pair.

packages/firestore-types/index.d.ts

@@ -99,6 +99,43 @@ export class FirebaseFirestore {
   INTERNAL: { delete: () => Promise<void> };
 }
 
+export function loadBundle(
+  db: FirebaseFirestore,
+  bundleData: ArrayBuffer | ReadableStream<ArrayBuffer> | string
+): LoadBundleTask;
+
+export function namedQuery(
+  db: FirebaseFirestore,
+  name: string
+): Promise<Query<DocumentData> | null>;
+
+export interface LoadBundleTask {
+  onProgress(
+    next?: (progress: LoadBundleTaskProgress) => any,
+    error?: (error: Error) => any,
+    complete?: () => void
+  ): void;
+
+  then<T, R>(
+    onFulfilled?: (a: LoadBundleTaskProgress) => T | PromiseLike<T>,
+    onRejected?: (a: Error) => R | PromiseLike<R>
+  ): Promise<T | R>;
+
+  catch<R>(
+    onRejected: (a: Error) => R | PromiseLike<R>
+  ): Promise<R | LoadBundleTaskProgress>;
+}
+
+export interface LoadBundleTaskProgress {
+  documentsLoaded: number;
+  totalDocuments: number;
+  bytesLoaded: number;
+  totalBytes: number;
+  taskState: TaskState;
+}
+
+export type TaskState = 'Error' | 'Running' | 'Success';
+
 export class GeoPoint {
   constructor(latitude: number, longitude: number);
 

packages/firestore/exp-types/index.d.ts

@@ -516,6 +516,43 @@ export function snapshotEqual<T>(
   right: DocumentSnapshot<T> | QuerySnapshot<T>
 ): boolean;
 
+export interface LoadBundleTask {
+  onProgress(
+    next?: (progress: LoadBundleTaskProgress) => any,
+    error?: (error: Error) => any,
+    complete?: () => void
+  ): void;
+
+  then<T, R>(
+    onFulfilled?: (a: LoadBundleTaskProgress) => T | PromiseLike<T>,
+    onRejected?: (a: Error) => R | PromiseLike<R>
+  ): Promise<T | R>;
+
+  catch<R>(
+    onRejected: (a: Error) => R | PromiseLike<R>
+  ): Promise<R | LoadBundleTaskProgress>;
+}
+
+export interface LoadBundleTaskProgress {
+  documentsLoaded: number;
+  totalDocuments: number;
+  bytesLoaded: number;
+  totalBytes: number;
+  taskState: TaskState;
+}
+
+export type TaskState = 'Error' | 'Running' | 'Success';
+
+export function loadBundle(
+  firestore: FirebaseFirestore,
+  bundleData: ArrayBuffer | ReadableStream<Uint8Array> | string
+): LoadBundleTask;
+
+export function namedQuery(
+  firestore: FirebaseFirestore,
+  name: string
+): Promise<Query<DocumentData> | null>;
+
 export type FirestoreErrorCode =
   | 'cancelled'
   | 'unknown'

packages/firestore/exp/index.ts

@@ -31,8 +31,9 @@ export {
   waitForPendingWrites,
   disableNetwork,
   enableNetwork,
-  terminate,
-  Settings
+  namedQuery,
+  loadBundle,
+  terminate
 } from './src/api/database';
 
 export {

packages/firestore/exp/src/api/database.ts

@@ -24,6 +24,8 @@ import {
   FirestoreClient,
   firestoreClientDisableNetwork,
   firestoreClientEnableNetwork,
+  firestoreClientGetNamedQuery,
+  firestoreClientLoadBundle,
   firestoreClientWaitForPendingWrites,
   setOfflineComponentProvider,
   setOnlineComponentProvider
@@ -53,6 +55,8 @@ import {
   indexedDbStoragePrefix
 } from '../../../src/local/indexeddb_persistence';
 import { PersistenceSettings } from '../../../exp-types';
+import { Query } from '../../../lite/src/api/reference';
+import { LoadBundleTask } from '../../../src/api/bundle';
 
 /** DOMException error code constants. */
 const DOM_EXCEPTION_INVALID_STATE = 11;
@@ -430,3 +434,29 @@ function verifyNotInitialized(firestore: FirestoreCompat): void {
     );
   }
 }
+
+export function loadBundle(
+  firestore: FirebaseFirestore,
+  bundleData: ArrayBuffer | ReadableStream<Uint8Array> | string
+): LoadBundleTask {
+  const client = ensureFirestoreConfigured(firestore);
+  const resultTask = new LoadBundleTask();
+
+  // eslint-disable-next-line @typescript-eslint/no-floating-promises
+  firestoreClientLoadBundle(client, bundleData, resultTask);
+  return resultTask;
+}
+
+export function namedQuery(
+  firestore: FirebaseFirestore,
+  name: string
+): Promise<Query | null> {
+  const client = ensureFirestoreConfigured(firestore);
+  return firestoreClientGetNamedQuery(client, name).then(namedQuery => {
+    if (!namedQuery) {
+      return null;
+    }
+
+    return new Query(firestore, null, namedQuery.query);
+  });
+}

packages/firestore/exp/test/shim.ts

@@ -41,6 +41,8 @@ import {
   getDocsFromCache,
   getDocsFromServer,
   initializeFirestore,
+  loadBundle,
+  namedQuery,
   onSnapshot,
   onSnapshotsInSync,
   query,
@@ -73,6 +75,7 @@ import { Compat } from '../../src/compat/compat';
 
 export { GeoPoint, Timestamp } from '../index';
 export { FieldValue } from '../../src/compat/field_value';
+export { loadBundle, namedQuery };
 
 /* eslint-disable @typescript-eslint/no-explicit-any */
 

packages/firestore/externs.json

@@ -28,6 +28,7 @@
     "packages/webchannel-wrapper/src/index.d.ts",
     "packages/util/dist/src/crypt.d.ts",
     "packages/util/dist/src/environment.d.ts",
+    "packages/firestore/src/protos/firestore_bundle_proto.ts",
     "packages/firestore/src/protos/firestore_proto_api.d.ts",
     "packages/firestore/src/util/error.ts",
     "packages/firestore/src/local/indexeddb_schema.ts",

packages/firestore/register-module.ts

@@ -36,6 +36,8 @@ declare module '@firebase/app-types' {
       Transaction: typeof types.Transaction;
       WriteBatch: typeof types.WriteBatch;
       setLogLevel: typeof types.setLogLevel;
+      loadBundle: typeof types.loadBundle;
+      namedQuery: typeof types.namedQuery;
     };
   }
   interface FirebaseApp {

packages/firestore/rollup.shared.js

@@ -129,7 +129,8 @@ const manglePrivatePropertiesOptions = {
   },
   mangle: {
     properties: {
-      regex: /^__PRIVATE_/
+      regex: /^__PRIVATE_/,
+      reserved: ['do']
     }
   }
 };