Use pruned DTS file for API report (#4207)

Author: schmidt-sebastian

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

@@ -4,13 +4,8 @@
 
 ```ts
 
-import { DocumentData as DocumentData_2 } from '@firebase/firestore-types';
 import { FirebaseApp } from '@firebase/app-types-exp';
-import { FirebaseAuthInternalName } from '@firebase/auth-interop-types';
-import { _FirebaseService } from '@firebase/app-types-exp';
 import { LogLevelString as LogLevel } from '@firebase/logger';
-import { Provider } from '@firebase/component';
-import { SetOptions as SetOptions_2 } from '@firebase/firestore-types';
 
 // @public
 export function addDoc<T>(reference: CollectionReference<T>, data: T): Promise<DocumentReference<T>>;
@@ -23,11 +18,6 @@ export function arrayUnion(...elements: unknown[]): FieldValue;
 
 // @public
 export class Bytes {
-    constructor(byteString: ByteString);
-    // Warning: (ae-forgotten-export) The symbol "ByteString" needs to be exported by the entry point index.d.ts
-    //
-    // (undocumented)
-    _byteString: ByteString;
     static fromBase64String(base64: string): Bytes;
     static fromUint8Array(array: Uint8Array): Bytes;
     isEqual(other: Bytes): boolean;
@@ -50,16 +40,11 @@ export function collectionGroup(firestore: FirebaseFirestore, collectionId: stri
 
 // @public
 export class CollectionReference<T = DocumentData> extends Query<T> {
-    constructor(firestore: FirebaseFirestore, converter: FirestoreDataConverter<T> | null, _path: ResourcePath);
     // (undocumented)
     readonly firestore: FirebaseFirestore;
     get id(): string;
     get parent(): DocumentReference<DocumentData> | null;
     get path(): string;
-    // Warning: (ae-forgotten-export) The symbol "ResourcePath" needs to be exported by the entry point index.d.ts
-    //
-    // (undocumented)
-    readonly _path: ResourcePath;
     // (undocumented)
     readonly type = "collection";
     withConverter<U>(converter: FirestoreDataConverter<U>): CollectionReference<U>;
@@ -91,47 +76,22 @@ export function documentId(): FieldPath;
 
 // @public
 export class DocumentReference<T = DocumentData> {
-    constructor(firestore: FirebaseFirestore, _converter: FirestoreDataConverter<T> | null, _key: DocumentKey);
-    // (undocumented)
-    readonly _converter: FirestoreDataConverter<T> | null;
     readonly firestore: FirebaseFirestore;
     get id(): string;
-    // Warning: (ae-forgotten-export) The symbol "DocumentKey" needs to be exported by the entry point index.d.ts
-    //
-    // (undocumented)
-    readonly _key: DocumentKey;
     get parent(): CollectionReference<T>;
     get path(): string;
-    // (undocumented)
-    get _path(): ResourcePath;
     readonly type = "document";
     withConverter<U>(converter: FirestoreDataConverter<U>): DocumentReference<U>;
 }
 
 // @public
 export class DocumentSnapshot<T = DocumentData> {
-    constructor(_firestore: FirebaseFirestore, _userDataWriter: AbstractUserDataWriter, _key: DocumentKey, _document: Document_2 | null, _converter: UntypedFirestoreDataConverter<T> | null);
-    // Warning: (ae-forgotten-export) The symbol "UntypedFirestoreDataConverter" needs to be exported by the entry point index.d.ts
-    //
-    // (undocumented)
-    _converter: UntypedFirestoreDataConverter<T> | null;
+    protected constructor();
     data(): T | undefined;
-    // Warning: (ae-forgotten-export) The symbol "Document" needs to be exported by the entry point index.d.ts
-    //
-    // (undocumented)
-    _document: Document_2 | null;
     exists(): this is QueryDocumentSnapshot<T>;
-    // (undocumented)
-    _firestore: FirebaseFirestore;
     get(fieldPath: string | FieldPath): any;
     get id(): string;
-    // (undocumented)
-    _key: DocumentKey;
     get ref(): DocumentReference<T>;
-    // Warning: (ae-forgotten-export) The symbol "AbstractUserDataWriter" needs to be exported by the entry point index.d.ts
-    //
-    // (undocumented)
-    _userDataWriter: AbstractUserDataWriter;
 }
 
 // @public
@@ -149,8 +109,6 @@ export function endBefore(...fieldValues: unknown[]): QueryConstraint;
 // @public
 export class FieldPath {
     constructor(...fieldNames: string[]);
-    // Warning: (ae-forgotten-export) The symbol "FieldPath" needs to be exported by the entry point index.d.ts
-    readonly _internalPath: FieldPath_2;
     isEqual(other: FieldPath): boolean;
 }
 
@@ -159,49 +117,14 @@ export abstract class FieldValue {
     constructor(_methodName: string);
     // (undocumented)
     abstract isEqual(other: FieldValue): boolean;
-    // (undocumented)
-    _methodName: string;
-    // Warning: (ae-forgotten-export) The symbol "ParseContext" needs to be exported by the entry point index.d.ts
-    // Warning: (ae-forgotten-export) The symbol "FieldTransform" needs to be exported by the entry point index.d.ts
-    //
-    // (undocumented)
-    abstract _toFieldTransform(context: ParseContext): FieldTransform | null;
 }
 
-// Warning: (ae-forgotten-export) The symbol "FirestoreService" needs to be exported by the entry point index.d.ts
-//
 // @public
-export class FirebaseFirestore implements FirestoreService {
-    constructor(databaseIdOrApp: DatabaseId | FirebaseApp, authProvider: Provider<FirebaseAuthInternalName>);
+export class FirebaseFirestore {
     get app(): FirebaseApp;
-    // Warning: (ae-forgotten-export) The symbol "CredentialsProvider" needs to be exported by the entry point index.d.ts
-    //
-    // (undocumented)
-    _credentials: CredentialsProvider;
-    // Warning: (ae-forgotten-export) The symbol "DatabaseId" needs to be exported by the entry point index.d.ts
-    //
-    // (undocumented)
-    readonly _databaseId: DatabaseId;
     // (undocumented)
-    _delete(): Promise<void>;
-    // (undocumented)
-    _freezeSettings(): FirestoreSettings;
-    // Warning: (ae-forgotten-export) The symbol "FirestoreSettings" needs to be exported by the entry point index.d.ts
-    //
-    // (undocumented)
-    _getSettings(): FirestoreSettings;
-    // (undocumented)
-    get _initialized(): boolean;
-    // (undocumented)
-    readonly _persistenceKey: string;
-    // Warning: (ae-forgotten-export) The symbol "PrivateSettings" needs to be exported by the entry point index.d.ts
-    //
-    // (undocumented)
-    _setSettings(settings: PrivateSettings): void;
-    protected _terminate(): Promise<void>;
-    // (undocumented)
-    get _terminated(): boolean;
-    }
+    toJSON(): object;
+}
 
 // @public
 export interface FirestoreDataConverter<T> {
@@ -212,7 +135,6 @@ export interface FirestoreDataConverter<T> {
 
 // @public
 export class FirestoreError extends Error {
-    constructor(code: FirestoreErrorCode, message: string);
     // (undocumented)
     readonly code: FirestoreErrorCode;
     // (undocumented)
@@ -229,7 +151,6 @@ export type FirestoreErrorCode = 'cancelled' | 'unknown' | 'invalid-argument' |
 // @public
 export class GeoPoint {
     constructor(latitude: number, longitude: number);
-    _compareTo(other: GeoPoint): number;
     isEqual(other: GeoPoint): boolean;
     get latitude(): number;
     get longitude(): number;
@@ -271,14 +192,8 @@ export type OrderByDirection = 'desc' | 'asc';
 
 // @public
 export class Query<T = DocumentData> {
-    constructor(firestore: FirebaseFirestore, _converter: FirestoreDataConverter<T> | null, _query: Query_2);
-    // (undocumented)
-    readonly _converter: FirestoreDataConverter<T> | null;
+    protected constructor();
     readonly firestore: FirebaseFirestore;
-    // Warning: (ae-forgotten-export) The symbol "Query" needs to be exported by the entry point index.d.ts
-    //
-    // (undocumented)
-    readonly _query: Query_2;
     readonly type: 'query' | 'collection';
     withConverter<U>(converter: FirestoreDataConverter<U>): Query<U>;
 }
@@ -288,7 +203,6 @@ export function query<T>(query: Query<T>, ...queryConstraints: QueryConstraint[]
 
 // @public
 export abstract class QueryConstraint {
-    abstract _apply<T>(query: Query<T>): Query<T>;
     abstract readonly type: QueryConstraintType;
 }
 
@@ -306,10 +220,7 @@ export function queryEqual<T>(left: Query<T>, right: Query<T>): boolean;
 
 // @public
 export class QuerySnapshot<T = DocumentData> {
-    constructor(_query: Query<T>, _docs: Array<QueryDocumentSnapshot<T>>);
     get docs(): Array<QueryDocumentSnapshot<T>>;
-    // (undocumented)
-    readonly _docs: Array<QueryDocumentSnapshot<T>>;
     get empty(): boolean;
     forEach(callback: (result: QueryDocumentSnapshot<T>) => void, thisArg?: unknown): void;
     readonly query: Query<T>;
@@ -378,8 +289,6 @@ export function terminate(firestore: FirebaseFirestore): Promise<void>;
 // @public
 export class Timestamp {
     constructor(seconds: number, nanoseconds: number);
-    // (undocumented)
-    _compareTo(other: Timestamp): number;
     static fromDate(date: Date): Timestamp;
     static fromMillis(milliseconds: number): Timestamp;
     isEqual(other: Timestamp): boolean;
@@ -402,11 +311,7 @@ export class Timestamp {
 
 // @public
 export class Transaction {
-    // Warning: (ae-forgotten-export) The symbol "Transaction" needs to be exported by the entry point index.d.ts
-    constructor(_firestore: FirebaseFirestore, _transaction: Transaction_2);
     delete(documentRef: DocumentReference<unknown>): this;
-    // (undocumented)
-    protected readonly _firestore: FirebaseFirestore;
     get<T>(documentRef: DocumentReference<T>): Promise<DocumentSnapshot<T>>;
     set<T>(documentRef: DocumentReference<T>, data: T): this;
     set<T>(documentRef: DocumentReference<T>, data: Partial<T>, options: SetOptions): this;
@@ -437,15 +342,13 @@ export type WhereFilterOp = '<' | '<=' | '==' | '!=' | '>=' | '>' | 'array-conta
 
 // @public
 export class WriteBatch {
-    // Warning: (ae-forgotten-export) The symbol "Mutation" needs to be exported by the entry point index.d.ts
-    constructor(_firestore: FirebaseFirestore, _commitHandler: (m: Mutation[]) => Promise<void>);
     commit(): Promise<void>;
     delete(documentRef: DocumentReference<unknown>): WriteBatch;
     set<T>(documentRef: DocumentReference<T>, data: T): WriteBatch;
     set<T>(documentRef: DocumentReference<T>, data: Partial<T>, options: SetOptions): WriteBatch;
     update(documentRef: DocumentReference<unknown>, data: UpdateData): WriteBatch;
     update(documentRef: DocumentReference<unknown>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): WriteBatch;
-    }
+}
 
 // @public
 export function writeBatch(firestore: FirebaseFirestore): WriteBatch;

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

@@ -18,7 +18,7 @@
 module.exports = {
   extends: '../../config/.eslintrc.js',
   parserOptions: {
-    project: 'tsconfig.json',
+    project: 'tsconfig.eslint.json',
     // to make vscode-eslint work with monorepo
     // https://github.com/typescript-eslint/typescript-eslint/issues/251#issuecomment-463943250
     tsconfigRootDir: __dirname

packages/firestore/.eslintrc.js

@@ -7,10 +7,8 @@
   "description": "The Cloud Firestore component of the Firebase JS SDK.",
   "author": "Firebase <[email protected]> (https://firebase.google.com/)",
   "scripts": {
-    "api-report:exp": "(cd exp; api-extractor run --local --verbose) && ts-node-script ../../repo-scripts/prune-dts/prune-dts.ts --input dist/exp/private.d.ts --output dist/exp/index.d.ts",
-    "api-report:lite": "(cd lite; api-extractor run --local --verbose) && ts-node-script ../../repo-scripts/prune-dts/prune-dts.ts --input dist/lite/private.d.ts --output dist/lite/index.d.ts",
     "bundle": "rollup -c",
-    "prebuild": "tsc --emitDeclarationOnly --declaration -p tsconfig.json; run-p api-report:exp api-report:lite",
+    "prebuild": "tsc --emitDeclarationOnly --declaration -p tsconfig.json && yarn api-report",
     "build": "run-p 'bundle rollup.config.browser.js' 'bundle rollup.config.node.js' 'bundle rollup.config.rn.js' build:lite build:exp",
     "build:scripts": "tsc -moduleResolution node --module commonjs scripts/*.ts && ls scripts/*.js | xargs -I % sh -c 'terser %  -o %'",
     "prebuild:release": "yarn prebuild",
@@ -27,9 +25,9 @@
     "lint": "eslint -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'",
     "lint:fix": "eslint --fix -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'",
     "prettier": "prettier --write '*.js' '*.ts' '@(lite|exp|src|test)/**/*.ts'",
-    "pregendeps:exp": "yarn api-report:exp && node scripts/build-bundle.js --input ./exp/index.ts --output ./dist/exp/tmp.js",
+    "pregendeps:exp": "yarn api-report && node scripts/build-bundle.js --input ./exp/index.ts --output ./dist/exp/tmp.js",
     "gendeps:exp": "../../scripts/exp/extract-deps.sh --types ./dist/exp/index.d.ts --bundle ./dist/exp/tmp.js --output ./dist/exp/dependencies.json",
-    "pregendeps:lite": "yarn api-report:lite && node scripts/build-bundle.js --input ./lite/index.ts --output ./dist/lite/tmp.js",
+    "pregendeps:lite": "yarn api-report && node scripts/build-bundle.js --input ./lite/index.ts --output ./dist/lite/tmp.js",
     "gendeps:lite": "../../scripts/exp/extract-deps.sh --types ./dist/lite/index.d.ts --bundle ./dist/lite/tmp.js --output ./dist/lite/dependencies.json",
     "test:lite": "node ./scripts/run-tests.js --emulator --platform node_lite --main=lite/index.ts 'test/lite/**/*.test.ts'",
     "test:lite:prod": "node ./scripts/run-tests.js --platform node_lite --main=lite/index.ts 'test/lite/**/*.test.ts'",
@@ -46,7 +44,7 @@
     "test:node:persistence:prod": "node ./scripts/run-tests.js --main=index.node.ts --persistence 'test/{,!(browser|lite)/**/}*.test.ts'",
     "test:travis": "ts-node --compiler-options='{\"module\":\"commonjs\"}' ../../scripts/emulator-testing/firestore-test-runner.ts",
     "test:minified": "(cd ../../integration/firestore ; yarn test)",
-    "api-report": "rm -rf temp && api-extractor run --local --verbose",
+    "api-report": "TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' ts-node ./scripts/api-report.ts",
     "predoc": "node ../../scripts/exp/remove-exp.js temp",
     "doc": "api-documenter markdown --input temp --output docs"
   },