Revert to get public API back, as free functions.

wu-hui · wu-hui · commit 0880c8d389be · 2020-11-16T10:15:47.000-05:00
diff --git a/integration/firestore/firebase_export.ts b/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
+};
diff --git a/integration/firestore/firebase_export_memory.ts b/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
+};
diff --git a/packages/firebase/index.d.ts b/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.
diff --git a/packages/firestore-types/index.d.ts b/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);
 
diff --git a/packages/firestore/exp-types/index.d.ts b/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'
diff --git a/packages/firestore/exp/test/shim.ts b/packages/firestore/exp/test/shim.ts
@@ -51,10 +51,13 @@ import {
   DocumentSnapshot,
   QuerySnapshot,
   wrapObserver,
-  extractSnapshotOptions
+  extractSnapshotOptions,
+  loadBundle,
+  namedQuery
 } from '../../src/api/database';
 
 export { GeoPoint, Timestamp } from '../index';
+export { loadBundle, namedQuery };
 
 /* eslint-disable @typescript-eslint/no-explicit-any */
 
diff --git a/packages/firestore/register-module.ts b/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 {
diff --git a/packages/firestore/src/api/bundle.ts b/packages/firestore/src/api/bundle.ts
@@ -15,46 +15,24 @@
  * limitations under the License.
  */
 
+import * as firestore from '@firebase/firestore-types';
 import { Deferred } from '../util/promise';
 import { PartialObserver } from './observer';
 import { debugAssert } from '../util/assert';
 import { FirestoreError } from '../util/error';
 
-export interface ApiLoadBundleTask {
-  onProgress(
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    next?: (progress: ApiLoadBundleTaskProgress) => any,
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    error?: (error: Error) => any,
-    complete?: () => void
-  ): void;
-
-  then<T, R>(
-    onFulfilled?: (a: ApiLoadBundleTaskProgress) => T | PromiseLike<T>,
-    onRejected?: (a: Error) => R | PromiseLike<R>
-  ): Promise<T | R>;
-
-  catch<R>(
-    onRejected: (a: Error) => R | PromiseLike<R>
-  ): Promise<R | ApiLoadBundleTaskProgress>;
-}
-
-export interface ApiLoadBundleTaskProgress {
-  documentsLoaded: number;
-  totalDocuments: number;
-  bytesLoaded: number;
-  totalBytes: number;
-  taskState: TaskState;
-}
-
-export type TaskState = 'Error' | 'Running' | 'Success';
-
 export class LoadBundleTask
-  implements ApiLoadBundleTask, PromiseLike<ApiLoadBundleTaskProgress> {
-  private _progressObserver: PartialObserver<ApiLoadBundleTaskProgress> = {};
-  private _taskCompletionResolver = new Deferred<ApiLoadBundleTaskProgress>();
-
-  private _lastProgress: ApiLoadBundleTaskProgress = {
+  implements
+    firestore.LoadBundleTask,
+    PromiseLike<firestore.LoadBundleTaskProgress> {
+  private _progressObserver: PartialObserver<
+    firestore.LoadBundleTaskProgress
+  > = {};
+  private _taskCompletionResolver = new Deferred<
+    firestore.LoadBundleTaskProgress
+  >();
+
+  private _lastProgress: firestore.LoadBundleTaskProgress = {
     taskState: 'Running',
     totalBytes: 0,
     totalDocuments: 0,
@@ -63,7 +41,7 @@ export class LoadBundleTask
   };
 
   onProgress(
-    next?: (progress: ApiLoadBundleTaskProgress) => unknown,
+    next?: (progress: firestore.LoadBundleTaskProgress) => unknown,
     error?: (err: Error) => unknown,
     complete?: () => void
   ): void {
@@ -76,12 +54,12 @@ export class LoadBundleTask
 
   catch<R>(
     onRejected: (a: Error) => R | PromiseLike<R>
-  ): Promise<R | ApiLoadBundleTaskProgress> {
+  ): Promise<R | firestore.LoadBundleTaskProgress> {
     return this._taskCompletionResolver.promise.catch(onRejected);
   }
 
   then<T, R>(
-    onFulfilled?: (a: ApiLoadBundleTaskProgress) => T | PromiseLike<T>,
+    onFulfilled?: (a: firestore.LoadBundleTaskProgress) => T | PromiseLike<T>,
     onRejected?: (a: Error) => R | PromiseLike<R>
   ): Promise<T | R> {
     return this._taskCompletionResolver.promise.then(onFulfilled, onRejected);
@@ -91,7 +69,7 @@ export class LoadBundleTask
    * Notifies all observers that bundle loading has completed, with a provided
    * `LoadBundleTaskProgress` object.
    */
-  _completeWith(progress: ApiLoadBundleTaskProgress): void {
+  _completeWith(progress: firestore.LoadBundleTaskProgress): void {
     debugAssert(
       progress.taskState === 'Success',
       'Task is not completed with Success.'
@@ -126,7 +104,7 @@ export class LoadBundleTask
    * Notifies a progress update of loading a bundle.
    * @param progress The new progress.
    */
-  _updateProgress(progress: ApiLoadBundleTaskProgress): void {
+  _updateProgress(progress: firestore.LoadBundleTaskProgress): void {
     debugAssert(
       this._lastProgress.taskState === 'Running',
       'Cannot update progress on a completed or failed task'
diff --git a/packages/firestore/src/api/database.ts b/packages/firestore/src/api/database.ts
@@ -156,7 +156,7 @@ import {
 
 import { makeDatabaseInfo } from '../../lite/src/api/database';
 import { DEFAULT_HOST } from '../../lite/src/api/components';
-import { ApiLoadBundleTask, LoadBundleTask } from './bundle';
+import { LoadBundleTask } from './bundle';
 
 /**
  * Constant used to indicate the LRU garbage collection should be disabled.
@@ -448,7 +448,7 @@ export function setLogLevel(level: PublicLogLevel): void {
 export function loadBundle(
   db: Firestore,
   bundleData: ArrayBuffer | ReadableStream<Uint8Array> | string
-): ApiLoadBundleTask {
+): LoadBundleTask {
   const resultTask = new LoadBundleTask();
   // eslint-disable-next-line @typescript-eslint/no-floating-promises
   firestoreClientLoadBundle(
diff --git a/packages/firestore/src/config.ts b/packages/firestore/src/config.ts
@@ -30,7 +30,9 @@ import {
   QuerySnapshot,
   Transaction,
   WriteBatch,
-  setLogLevel
+  setLogLevel,
+  loadBundle,
+  namedQuery
 } from './api/database';
 import { Blob } from './api/blob';
 import { FieldPath } from './api/field_path';
@@ -54,6 +56,8 @@ const firestoreNamespace = {
   FieldPath,
   FieldValue,
   setLogLevel,
+  loadBundle,
+  namedQuery,
   CACHE_SIZE_UNLIMITED
 };
 
diff --git a/packages/firestore/src/core/bundle.ts b/packages/firestore/src/core/bundle.ts
@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 
+import * as firestore from '@firebase/firestore-types';
 import { Query } from './query';
 import { SnapshotVersion } from './snapshot_version';
 import {
@@ -40,7 +41,6 @@ import {
   DocumentKeySet,
   MaybeDocumentMap
 } from '../model/collections';
-import { ApiLoadBundleTaskProgress } from '../api/bundle';
 
 /**
  * Represents a Firestore bundle saved by the SDK in its local storage.
@@ -118,7 +118,7 @@ export class BundleConverter {
  */
 export function bundleInitialProgress(
   metadata: BundleMetadata
-): ApiLoadBundleTaskProgress {
+): firestore.LoadBundleTaskProgress {
   return {
     taskState: 'Running',
     documentsLoaded: 0,
@@ -134,7 +134,7 @@ export function bundleInitialProgress(
  */
 export function bundleSuccessProgress(
   metadata: BundleMetadata
-): ApiLoadBundleTaskProgress {
+): firestore.LoadBundleTaskProgress {
   return {
     taskState: 'Success',
     documentsLoaded: metadata.totalDocuments!,
@@ -146,7 +146,7 @@ export function bundleSuccessProgress(
 
 export class BundleLoadResult {
   constructor(
-    readonly progress: ApiLoadBundleTaskProgress,
+    readonly progress: firestore.LoadBundleTaskProgress,
     readonly changedDocs: MaybeDocumentMap
   ) {}
 }
@@ -157,7 +157,7 @@ export class BundleLoadResult {
  */
 export class BundleLoader {
   /** The current progress of loading */
-  private progress: ApiLoadBundleTaskProgress;
+  private progress: firestore.LoadBundleTaskProgress;
   /** Batched queries to be saved into storage */
   private queries: bundleProto.NamedQuery[] = [];
   /** Batched documents to be saved into storage */
@@ -179,7 +179,7 @@ export class BundleLoader {
    */
   addSizedElement(
     element: SizedBundleElement
-  ): ApiLoadBundleTaskProgress | null {
+  ): firestore.LoadBundleTaskProgress | null {
     debugAssert(!element.isBundleMetadata(), 'Unexpected bundle metadata.');
 
     this.progress.bytesLoaded += element.byteLength;
diff --git a/packages/firestore/test/integration/api/bundle.test.ts b/packages/firestore/test/integration/api/bundle.test.ts
diff --git a/packages/firestore/test/integration/util/firebase_export.ts b/packages/firestore/test/integration/util/firebase_export.ts

Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,8 @@ declare module '@firebase/app-types' {`
`36`	`36`	`Transaction: typeof types.Transaction;`
`37`	`37`	`WriteBatch: typeof types.WriteBatch;`
`38`	`38`	`setLogLevel: typeof types.setLogLevel;`
	`39`	`+ loadBundle: typeof types.loadBundle;`
	`40`	`+ namedQuery: typeof types.namedQuery;`
`39`	`41`	`};`
`40`	`42`	`}`
`41`	`43`	`interface FirebaseApp {`