Don't use interface types

Author: schmidt-sebastian

packages/firestore/exp/index.ts

@@ -22,7 +22,7 @@ registerFirestore();
 export { FieldPath, documentId } from '../lite/src/api/field_path';
 
 export {
-  Firestore as FirebaseFirestore,
+  FirebaseFirestore,
   initializeFirestore,
   getFirestore,
   enableIndexedDbPersistence,
@@ -31,14 +31,19 @@ export {
   waitForPendingWrites,
   disableNetwork,
   enableNetwork,
-  terminate
+  terminate,
+  Settings
 } from './src/api/database';
 
 export {
+  DocumentChange,
   DocumentSnapshot,
   QueryDocumentSnapshot,
   QuerySnapshot,
-  snapshotEqual
+  snapshotEqual,
+  SnapshotOptions,
+  FirestoreDataConverter,
+  DocumentChangeType
 } from './src/api/snapshot';
 
 export { SnapshotMetadata } from '../src/api/database';
@@ -59,7 +64,12 @@ export {
   limit,
   limitToLast,
   where,
-  orderBy
+  orderBy,
+  SetOptions,
+  QueryConstraintType,
+  DocumentData,
+  UpdateData,
+  OrderByDirection
 } from '../lite/src/api/reference';
 
 export { runTransaction, Transaction } from './src/api/transaction';
@@ -88,7 +98,7 @@ export {
   serverTimestamp
 } from '../lite/src/api/field_value';
 
-export { setLogLevel } from '../src/util/log';
+export { setLogLevel, LogLevel } from '../src/util/log';
 
 export { Bytes } from '../lite/src/api/bytes';
 
@@ -101,3 +111,9 @@ 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';
+
+export { FirestoreErrorCode, FirestoreError } from '../src/util/error';

packages/firestore/exp/register.ts

@@ -18,7 +18,7 @@
 import { _registerComponent, registerVersion } from '@firebase/app-exp';
 import { Component, ComponentType } from '@firebase/component';
 
-import { Firestore } from './src/api/database';
+import { FirebaseFirestore } from './src/api/database';
 import { version } from '../package.json';
 
 export function registerFirestore(): void {
@@ -27,7 +27,7 @@ export function registerFirestore(): void {
       'firestore-exp',
       container => {
         const app = container.getProvider('app-exp').getImmediate()!;
-        return ((app, auth) => new Firestore(app, auth))(
+        return ((app, auth) => new FirebaseFirestore(app, auth))(
           app,
           container.getProvider('auth-internal')
         );

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

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-import { Firestore } from './database';
+import { FirebaseFirestore } from './database';
 import { PersistenceSettings } from '../../../src/core/firestore_client';
 import {
   MemoryOfflineComponentProvider,
@@ -45,16 +45,16 @@ export const LOG_TAG = 'ComponentProvider';
 // Instance maps that ensure that only one component provider exists per
 // Firestore instance.
 const offlineComponentProviders = new Map<
-  Firestore,
+  FirebaseFirestore,
   Promise<OfflineComponentProvider>
 >();
 const onlineComponentProviders = new Map<
-  Firestore,
+  FirebaseFirestore,
   Promise<OnlineComponentProvider>
 >();
 
 export async function setOfflineComponentProvider(
-  firestore: Firestore,
+  firestore: FirebaseFirestore,
   persistenceSettings: PersistenceSettings,
   offlineComponentProvider: OfflineComponentProvider
 ): Promise<void> {
@@ -83,7 +83,7 @@ export async function setOfflineComponentProvider(
 }
 
 export async function setOnlineComponentProvider(
-  firestore: Firestore,
+  firestore: FirebaseFirestore,
   onlineComponentProvider: OnlineComponentProvider
 ): Promise<void> {
   const onlineDeferred = new Deferred<OnlineComponentProvider>();
@@ -112,7 +112,7 @@ export async function setOnlineComponentProvider(
 }
 
 function getOfflineComponentProvider(
-  firestore: Firestore
+  firestore: FirebaseFirestore
 ): Promise<OfflineComponentProvider> {
   firestore._queue.verifyOperationInProgress();
 
@@ -129,7 +129,7 @@ function getOfflineComponentProvider(
 }
 
 function getOnlineComponentProvider(
-  firestore: Firestore
+  firestore: FirebaseFirestore
 ): Promise<OnlineComponentProvider> {
   firestore._queue.verifyOperationInProgress();
 
@@ -144,19 +144,25 @@ function getOnlineComponentProvider(
 // Note: These functions cannot be `async` since we want to throw an exception
 // when Firestore is terminated (via `getOnlineComponentProvider()`).
 
-export function getSyncEngine(firestore: Firestore): Promise<SyncEngine> {
+export function getSyncEngine(
+  firestore: FirebaseFirestore
+): Promise<SyncEngine> {
   return getOnlineComponentProvider(firestore).then(
     components => components.syncEngine
   );
 }
 
-export function getRemoteStore(firestore: Firestore): Promise<RemoteStore> {
+export function getRemoteStore(
+  firestore: FirebaseFirestore
+): Promise<RemoteStore> {
   return getOnlineComponentProvider(firestore).then(
     components => components.remoteStore
   );
 }
 
-export function getEventManager(firestore: Firestore): Promise<EventManager> {
+export function getEventManager(
+  firestore: FirebaseFirestore
+): Promise<EventManager> {
   return getOnlineComponentProvider(firestore).then(components => {
     const eventManager = components.eventManager;
     eventManager.onListen = syncEngineListen.bind(null, components.syncEngine);
@@ -168,13 +174,17 @@ export function getEventManager(firestore: Firestore): Promise<EventManager> {
   });
 }
 
-export function getPersistence(firestore: Firestore): Promise<Persistence> {
+export function getPersistence(
+  firestore: FirebaseFirestore
+): Promise<Persistence> {
   return getOfflineComponentProvider(firestore).then(
     components => components.persistence
   );
 }
 
-export function getLocalStore(firestore: Firestore): Promise<LocalStore> {
+export function getLocalStore(
+  firestore: FirebaseFirestore
+): Promise<LocalStore> {
   return getOfflineComponentProvider(firestore).then(
     provider => provider.localStore
   );
@@ -184,7 +194,9 @@ export function getLocalStore(firestore: Firestore): Promise<LocalStore> {
  * Removes all components associated with the provided instance. Must be called
  * when the Firestore instance is terminated.
  */
-export async function removeComponents(firestore: Firestore): Promise<void> {
+export async function removeComponents(
+  firestore: FirebaseFirestore
+): Promise<void> {
   const onlineComponentProviderPromise = onlineComponentProviders.get(
     firestore
   );

packages/firestore/exp/src/api/database.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';
@@ -33,7 +31,10 @@ import {
   MultiTabOfflineComponentProvider,
   OnlineComponentProvider
 } from '../../../src/core/component_provider';
-import { Firestore as LiteFirestore } from '../../../lite/src/api/database';
+import {
+  FirebaseFirestore 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';
@@ -66,13 +67,17 @@ import { PersistenceSettings } from '../../../exp-types';
 
 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
+export class FirebaseFirestore
   extends LiteFirestore
-  implements firestore.FirebaseFirestore, _FirebaseService {
+  implements _FirebaseService {
   readonly _queue = new AsyncQueue();
   readonly _persistenceKey: string;
   readonly _clientId = AutoId.newId();
@@ -83,7 +88,7 @@ export class Firestore
 
   // 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,
@@ -130,7 +135,7 @@ export class Firestore
     };
   }
 
-  _getSettings(): firestore.Settings {
+  _getSettings(): Settings {
     return super._getSettings();
   }
 
@@ -171,12 +176,12 @@ export class Firestore
 
 export function initializeFirestore(
   app: FirebaseApp,
-  settings: firestore.Settings
-): Firestore {
+  settings: Settings
+): FirebaseFirestore {
   const firestore = _getProvider(
     app,
     'firestore-exp'
-  ).getImmediate() as Firestore;
+  ).getImmediate() as FirebaseFirestore;
 
   if (
     settings.cacheSizeBytes !== undefined &&
@@ -193,15 +198,15 @@ export function initializeFirestore(
   return firestore;
 }
 
-export function getFirestore(app: FirebaseApp): Firestore {
-  return _getProvider(app, 'firestore-exp').getImmediate() as Firestore;
+export function getFirestore(app: FirebaseApp): FirebaseFirestore {
+  return _getProvider(app, 'firestore-exp').getImmediate() as FirebaseFirestore;
 }
 
 export function enableIndexedDbPersistence(
-  firestore: firestore.FirebaseFirestore,
+  firestore: FirebaseFirestore,
   persistenceSettings?: PersistenceSettings
 ): Promise<void> {
-  const firestoreImpl = cast(firestore, Firestore);
+  const firestoreImpl = cast(firestore, FirebaseFirestore);
   verifyNotInitialized(firestoreImpl);
 
   // `_getSettings()` freezes the client settings and prevents further changes
@@ -232,9 +237,9 @@ export function enableIndexedDbPersistence(
 }
 
 export function enableMultiTabIndexedDbPersistence(
-  firestore: firestore.FirebaseFirestore
+  firestore: FirebaseFirestore
 ): Promise<void> {
-  const firestoreImpl = cast(firestore, Firestore);
+  const firestoreImpl = cast(firestore, FirebaseFirestore);
   verifyNotInitialized(firestoreImpl);
 
   // `_getSettings()` freezes the client settings and prevents further changes
@@ -264,9 +269,9 @@ export function enableMultiTabIndexedDbPersistence(
 }
 
 export function clearIndexedDbPersistence(
-  firestore: firestore.FirebaseFirestore
+  firestore: FirebaseFirestore
 ): Promise<void> {
-  const firestoreImpl = cast(firestore, Firestore);
+  const firestoreImpl = cast(firestore, FirebaseFirestore);
   if (firestoreImpl._initialized && !firestoreImpl._terminated) {
     throw new FirestoreError(
       Code.FAILED_PRECONDITION,
@@ -293,9 +298,9 @@ export function clearIndexedDbPersistence(
 }
 
 export function waitForPendingWrites(
-  firestore: firestore.FirebaseFirestore
+  firestore: FirebaseFirestore
 ): Promise<void> {
-  const firestoreImpl = cast(firestore, Firestore);
+  const firestoreImpl = cast(firestore, FirebaseFirestore);
   firestoreImpl._verifyNotTerminated();
 
   const deferred = new Deferred<void>();
@@ -306,10 +311,8 @@ export function waitForPendingWrites(
   return deferred.promise;
 }
 
-export function enableNetwork(
-  firestore: firestore.FirebaseFirestore
-): Promise<void> {
-  const firestoreImpl = cast(firestore, Firestore);
+export function enableNetwork(firestore: FirebaseFirestore): Promise<void> {
+  const firestoreImpl = cast(firestore, FirebaseFirestore);
   firestoreImpl._verifyNotTerminated();
 
   return firestoreImpl._queue.enqueue(async () => {
@@ -320,10 +323,8 @@ export function enableNetwork(
   });
 }
 
-export function disableNetwork(
-  firestore: firestore.FirebaseFirestore
-): Promise<void> {
-  const firestoreImpl = cast(firestore, Firestore);
+export function disableNetwork(firestore: FirebaseFirestore): Promise<void> {
+  const firestoreImpl = cast(firestore, FirebaseFirestore);
   firestoreImpl._verifyNotTerminated();
 
   return firestoreImpl._queue.enqueue(async () => {
@@ -334,15 +335,13 @@ export function disableNetwork(
   });
 }
 
-export function terminate(
-  firestore: firestore.FirebaseFirestore
-): Promise<void> {
+export function terminate(firestore: FirebaseFirestore): Promise<void> {
   _removeServiceInstance(firestore.app, 'firestore-exp');
-  const firestoreImpl = cast(firestore, Firestore);
+  const firestoreImpl = cast(firestore, FirebaseFirestore);
   return firestoreImpl._delete();
 }
 
-function verifyNotInitialized(firestore: Firestore): void {
+function verifyNotInitialized(firestore: FirebaseFirestore): void {
   if (firestore._initialized || firestore._terminated) {
     throw new FirestoreError(
       Code.FAILED_PRECONDITION,