Merge 37c864b into 8d3aca7

Author: schmidt-sebastian

common/api-review/firestore-exp.api.md

@@ -136,6 +136,7 @@
     "ora": "4.0.5",
     "prettier": "2.0.5",
     "protractor": "5.4.2",
+    "rollup-plugin-copy": "3.3.0",
     "rxjs": "6.6.2",
     "semver": "7.3.2",
     "simple-git": "1.132.0",
@@ -157,4 +158,4 @@
       "pre-commit": "node tools/gitHooks/precommit.js"
     }
   }
-}
+}

common/api-review/firestore-lite.api.md

@@ -0,0 +1,8 @@
+{
+  "extends": "../../../config/api-extractor.json",
+  "mainEntryPointFilePath": "../dist/exp/firestore/exp/index.d.ts",
+  "dtsRollup": {
+    "enabled": true,
+    "publicTrimmedFilePath": "../dist/exp/index.d.ts"
+  }
+}

package.json

@@ -31,14 +31,18 @@ export {
   waitForPendingWrites,
   disableNetwork,
   enableNetwork,
-  terminate
+  terminate,
+  Settings
 } from './src/api/database';
 
 export {
   DocumentSnapshot,
   QueryDocumentSnapshot,
   QuerySnapshot,
-  snapshotEqual
+  snapshotEqual,
+  SnapshotOptions,
+  FirestoreDataConverter,
+  DocumentChangeType
 } from './src/api/snapshot';
 
 export { SnapshotMetadata } from '../src/api/database';
@@ -60,12 +64,19 @@ export {
   limit,
   limitToLast,
   where,
-  orderBy
+  orderBy,
+  SetOptions,
+  QueryConstraintType,
+  DocumentData,
+  UpdateData,
+  OrderByDirection
 } from '../lite/src/api/reference';
 
 export { runTransaction, Transaction } from './src/api/transaction';
 
 export {
+  FirestoreErrorCode,
+  FirestoreError,
   getDoc,
   getDocFromCache,
   getDocFromServer,
@@ -89,7 +100,7 @@ export {
   serverTimestamp
 } from '../lite/src/api/field_value';
 
-export { setLogLevel } from '../src/util/log';
+export { setLogLevel, LogLevel } from '../src/util/log';
 
 export { Blob } from '../src/api/blob';
 
@@ -102,3 +113,7 @@ export { GeoPoint } from '../src/api/geo_point';
 export { Timestamp } from '../src/api/timestamp';
 
 export { refEqual, queryEqual } from '../lite/src/api/reference';
+
+export { SnapshotListenOptions } from './src/api/reference';
+
+export { CACHE_SIZE_UNLIMITED } from '../src/api/database';

packages/firestore/exp/api-extractor.json

@@ -1,5 +1,5 @@
 {
-  "name": "@firebase/firestore/exp",
+  "name": "@firebase/firestore-exp",
   "description": "A tree-shakeable version of the Firestore SDK",
   "main": "../dist/exp/index.node.umd.js",
   "main-esm": "../dist/exp/index.node.esm2017.js",

packages/firestore/exp/index.ts

@@ -15,8 +15,6 @@
  * limitations under the License.
  */
 
-import * as firestore from '../../../exp-types';
-
 import { _getProvider, _removeServiceInstance } from '@firebase/app-exp';
 import { _FirebaseService, FirebaseApp } from '@firebase/app-types-exp';
 import { Provider } from '@firebase/component';
@@ -37,7 +35,10 @@ import {
   MultiTabOfflineComponentProvider,
   OnlineComponentProvider
 } from '../../../src/core/component_provider';
-import { Firestore as LiteFirestore } from '../../../lite/src/api/database';
+import {
+  Firestore as LiteFirestore,
+  Settings as LiteSettings
+} from '../../../lite/src/api/database';
 import { cast } from '../../../lite/src/api/util';
 import { Code, FirestoreError } from '../../../src/util/error';
 import { Deferred } from '../../../src/util/promise';
@@ -65,12 +66,15 @@ import { logDebug } from '../../../src/util/log';
 
 const LOG_TAG = 'Firestore';
 
+export interface Settings extends LiteSettings {
+  cacheSizeBytes?: number;
+}
+
 /**
  * The root reference to the Firestore database and the entry point for the
  * tree-shakeable SDK.
  */
-export class Firestore extends LiteFirestore
-  implements firestore.FirebaseFirestore, _FirebaseService {
+export class Firestore extends LiteFirestore implements _FirebaseService {
   readonly _queue = new AsyncQueue();
   readonly _persistenceKey: string;
   readonly _clientId = AutoId.newId();
@@ -81,7 +85,7 @@ export class Firestore extends LiteFirestore
 
   // We override the Settings property of the Lite SDK since the full Firestore
   // SDK supports more settings.
-  protected _settings?: firestore.Settings;
+  protected _settings?: Settings;
 
   constructor(
     app: FirebaseApp,
@@ -128,7 +132,7 @@ export class Firestore extends LiteFirestore
     };
   }
 
-  _getSettings(): firestore.Settings {
+  _getSettings(): Settings {
     return super._getSettings();
   }
 
@@ -160,7 +164,7 @@ export class Firestore extends LiteFirestore
 
 export function initializeFirestore(
   app: FirebaseApp,
-  settings: firestore.Settings
+  settings: Settings
 ): Firestore {
   const firestore = _getProvider(
     app,
@@ -187,7 +191,7 @@ export function getFirestore(app: FirebaseApp): Firestore {
 }
 
 export function enableIndexedDbPersistence(
-  firestore: firestore.FirebaseFirestore
+  firestore: Firestore
 ): Promise<void> {
   const firestoreImpl = cast(firestore, Firestore);
   verifyNotInitialized(firestoreImpl);
@@ -213,7 +217,7 @@ export function enableIndexedDbPersistence(
 }
 
 export function enableMultiTabIndexedDbPersistence(
-  firestore: firestore.FirebaseFirestore
+  firestore: Firestore
 ): Promise<void> {
   const firestoreImpl = cast(firestore, Firestore);
   verifyNotInitialized(firestoreImpl);
@@ -243,9 +247,7 @@ export function enableMultiTabIndexedDbPersistence(
   );
 }
 
-export function clearIndexedDbPersistence(
-  firestore: firestore.FirebaseFirestore
-): Promise<void> {
+export function clearIndexedDbPersistence(firestore: Firestore): Promise<void> {
   const firestoreImpl = cast(firestore, Firestore);
   if (firestoreImpl._initialized && !firestoreImpl._terminated) {
     throw new FirestoreError(
@@ -272,18 +274,14 @@ export function clearIndexedDbPersistence(
   return deferred.promise;
 }
 
-export function waitForPendingWrites(
-  firestore: firestore.FirebaseFirestore
-): Promise<void> {
+export function waitForPendingWrites(firestore: Firestore): Promise<void> {
   const firestoreImpl = cast(firestore, Firestore);
   return getSyncEngine(firestoreImpl).then(syncEngine =>
     enqueueWaitForPendingWrites(firestoreImpl._queue, syncEngine)
   );
 }
 
-export function enableNetwork(
-  firestore: firestore.FirebaseFirestore
-): Promise<void> {
+export function enableNetwork(firestore: Firestore): Promise<void> {
   const firestoreImpl = cast(firestore, Firestore);
   return Promise.all([
     getRemoteStore(firestoreImpl),
@@ -298,9 +296,7 @@ export function enableNetwork(
   );
 }
 
-export function disableNetwork(
-  firestore: firestore.FirebaseFirestore
-): Promise<void> {
+export function disableNetwork(firestore: Firestore): Promise<void> {
   const firestoreImpl = cast(firestore, Firestore);
   return Promise.all([
     getRemoteStore(firestoreImpl),
@@ -315,9 +311,7 @@ export function disableNetwork(
   );
 }
 
-export function terminate(
-  firestore: firestore.FirebaseFirestore
-): Promise<void> {
+export function terminate(firestore: Firestore): Promise<void> {
   _removeServiceInstance(firestore.app, 'firestore-exp');
   const firestoreImpl = cast(firestore, Firestore);
   return firestoreImpl.delete();