Add Api Extractor for @firestore/lite

Author: schmidt-sebastian

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

@@ -67,7 +67,6 @@
     "@changesets/cli": "2.9.2",
     "@microsoft/api-documenter": "7.8.21",
     "@microsoft/api-extractor": "7.9.2",
-    "@types/mz": "2.7.1",
     "@types/chai": "4.2.12",
     "@types/chai-as-promised": "7.1.3",
     "@types/child-process-promise": "2.2.1",
@@ -136,6 +135,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 +157,4 @@
       "pre-commit": "node tools/gitHooks/precommit.js"
     }
   }
-}
+}

package.json

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

packages/firestore/lite/api-extractor.json

@@ -20,17 +20,23 @@ import { registerFirestore } from './register';
 registerFirestore();
 
 export {
+  Settings,
   Firestore as FirebaseFirestore,
   initializeFirestore,
   getFirestore,
   terminate
 } from './src/api/database';
 
 export {
+  DocumentData,
+  UpdateData,
   DocumentReference,
   Query,
   QueryConstraint,
+  QueryConstraintType,
   CollectionReference,
+  OrderByDirection,
+  WhereFilterOp,
   collection,
   collectionGroup,
   doc,

packages/firestore/lite/index.ts

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

packages/firestore/lite/package.json

@@ -15,8 +15,6 @@
  * limitations under the License.
  */
 
-import * as firestore from '../../../lite-types';
-
 import { _getProvider, _removeServiceInstance } from '@firebase/app-exp';
 import { FirebaseApp, _FirebaseService } from '@firebase/app-types-exp';
 import { Provider } from '@firebase/component';
@@ -31,17 +29,22 @@ import {
 import { cast } from './util';
 import { removeComponents } from './components';
 
+export interface Settings {
+  host?: string;
+  ssl?: boolean;
+  ignoreUndefinedProperties?: boolean;
+}
+
 /**
  * The root reference to the Firestore Lite database.
  */
-export class Firestore
-  implements firestore.FirebaseFirestore, _FirebaseService {
+export class Firestore implements _FirebaseService {
   readonly _databaseId: DatabaseId;
   readonly _credentials: CredentialsProvider;
   readonly _persistenceKey: string = '(lite)';
 
   // Assigned via _configureClient()
-  protected _settings?: firestore.Settings;
+  protected _settings?: Settings;
   private _settingsFrozen = false;
 
   // A task that is assigned when the terminate() is invoked and resolved when
@@ -64,7 +67,7 @@ export class Firestore
     return this._terminateTask !== undefined;
   }
 
-  _configureClient(settings: firestore.Settings): void {
+  _configureClient(settings: Settings): void {
     if (this._settingsFrozen) {
       throw new FirestoreError(
         Code.FAILED_PRECONDITION,
@@ -76,7 +79,7 @@ export class Firestore
     this._settings = settings;
   }
 
-  _getSettings(): firestore.Settings {
+  _getSettings(): Settings {
     if (!this._settings) {
       this._settings = {};
     }
@@ -123,7 +126,7 @@ export class Firestore
 
 export function initializeFirestore(
   app: FirebaseApp,
-  settings: firestore.Settings
+  settings: Settings
 ): Firestore {
   const firestore = _getProvider(
     app,
@@ -137,9 +140,7 @@ export function getFirestore(app: FirebaseApp): Firestore {
   return _getProvider(app, 'firestore/lite').getImmediate() as Firestore;
 }
 
-export function terminate(
-  firestore: firestore.FirebaseFirestore
-): Promise<void> {
+export function terminate(firestore: Firestore): Promise<void> {
   _removeServiceInstance(firestore.app, 'firestore/lite');
   const firestoreClient = cast(firestore, Firestore);
   return firestoreClient.delete();

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

@@ -15,8 +15,6 @@
  * limitations under the License.
  */
 
-import * as firestore from '../../../lite-types';
-
 import { BaseFieldPath } from '../../../src/api/field_path';
 import { cast } from './util';
 import { DOCUMENT_KEY_NAME } from '../../../src/model/path';
@@ -26,7 +24,7 @@ import { DOCUMENT_KEY_NAME } from '../../../src/model/path';
  * field name (referring to a top-level field in the document), or a list of
  * field names (referring to a nested field in the document).
  */
-export class FieldPath extends BaseFieldPath implements firestore.FieldPath {
+export class FieldPath extends BaseFieldPath {
   // Note: This class is stripped down a copy of the FieldPath class in the
   // legacy SDK. The changes are:
   // - The `documentId()` static method has been removed
@@ -43,12 +41,12 @@ export class FieldPath extends BaseFieldPath implements firestore.FieldPath {
     super(fieldNames);
   }
 
-  isEqual(other: firestore.FieldPath): boolean {
+  isEqual(other: FieldPath): boolean {
     const path = cast(other, FieldPath);
     return this._internalPath.isEqual(path._internalPath);
   }
 }
 
-export function documentId(): firestore.FieldPath {
+export function documentId(): FieldPath {
   return new FieldPath(DOCUMENT_KEY_NAME);
 }

packages/firestore/lite/src/api/field_path.ts

@@ -15,8 +15,6 @@
  * limitations under the License.
  */
 
-import * as firestore from '../../../lite-types';
-
 import { validateAtLeastNumberOfArgs } from '../../../src/util/input_validation';
 import {
   ArrayRemoveFieldValueImpl,
@@ -30,8 +28,7 @@ import { ParseContext } from '../../../src/api/user_data_reader';
 import { FieldTransform } from '../../../src/model/mutation';
 
 /** The public FieldValue class of the lite API. */
-export abstract class FieldValue extends SerializableFieldValue
-  implements firestore.FieldValue {}
+export abstract class FieldValue extends SerializableFieldValue {}
 
 /**
  * A delegate class that allows the FieldValue implementations returned by
@@ -42,7 +39,7 @@ export abstract class FieldValue extends SerializableFieldValue
  * implementations as the base FieldValue class differs between the lite, full
  * and legacy SDK.
  */
-class FieldValueDelegate extends FieldValue implements firestore.FieldValue {
+class FieldValueDelegate extends FieldValue {
   readonly _methodName: string;
 
   constructor(readonly _delegate: SerializableFieldValue) {
@@ -54,25 +51,25 @@ class FieldValueDelegate extends FieldValue implements firestore.FieldValue {
     return this._delegate._toFieldTransform(context);
   }
 
-  isEqual(other: firestore.FieldValue): boolean {
+  isEqual(other: FieldValue): boolean {
     if (!(other instanceof FieldValueDelegate)) {
       return false;
     }
     return this._delegate.isEqual(other._delegate);
   }
 }
 
-export function deleteField(): firestore.FieldValue {
+export function deleteField(): FieldValue {
   return new FieldValueDelegate(new DeleteFieldValueImpl('deleteField'));
 }
 
-export function serverTimestamp(): firestore.FieldValue {
+export function serverTimestamp(): FieldValue {
   return new FieldValueDelegate(
     new ServerTimestampFieldValueImpl('serverTimestamp')
   );
 }
 
-export function arrayUnion(...elements: unknown[]): firestore.FieldValue {
+export function arrayUnion(...elements: unknown[]): FieldValue {
   validateAtLeastNumberOfArgs('arrayUnion()', arguments, 1);
   // NOTE: We don't actually parse the data until it's used in set() or
   // update() since we'd need the Firestore instance to do this.
@@ -81,7 +78,7 @@ export function arrayUnion(...elements: unknown[]): firestore.FieldValue {
   );
 }
 
-export function arrayRemove(...elements: unknown[]): firestore.FieldValue {
+export function arrayRemove(...elements: unknown[]): FieldValue {
   validateAtLeastNumberOfArgs('arrayRemove()', arguments, 1);
   // NOTE: We don't actually parse the data until it's used in set() or
   // update() since we'd need the Firestore instance to do this.
@@ -90,7 +87,7 @@ export function arrayRemove(...elements: unknown[]): firestore.FieldValue {
   );
 }
 
-export function increment(n: number): firestore.FieldValue {
+export function increment(n: number): FieldValue {
   return new FieldValueDelegate(
     new NumericIncrementFieldValueImpl('increment', n)
   );