Remove type references from the core Firestore API surface. This will support multiple entrypoints work.

Author: MarkDuckworth

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

@@ -1056,8 +1056,6 @@ export interface FindNearestOptions {
 // @public
 export class Firestore {
     get app(): FirebaseApp;
-    // Warning: (ae-incompatible-release-tags) The symbol "pipeline" is marked as @public, but its signature references "PipelineSource" which is marked as @beta
-    pipeline(): PipelineSource;
     toJSON(): object;
     type: 'firestore-lite' | 'firestore';
 }
@@ -1657,7 +1655,6 @@ export class Query<AppModelType = DocumentData, DbModelType extends DocumentData
     protected constructor();
     readonly converter: FirestoreDataConverter<AppModelType, DbModelType> | null;
     readonly firestore: Firestore;
-    pipeline(): Pipeline;
     readonly type: 'query' | 'collection';
     withConverter(converter: null): Query<DocumentData, DocumentData>;
     withConverter<NewAppModelType, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): Query<NewAppModelType, NewDbModelType>;
@@ -2208,8 +2205,8 @@ export function xor(left: FilterExpr, ...right: FilterExpr[]): Xor;
 
 // Warnings were encountered during analysis:
 //
-// /Users/markduckworth/projects/firebase-js-sdk/packages/firestore/dist/lite/index.d.ts:9248:9 - (ae-incompatible-release-tags) The symbol "accumulators" is marked as @public, but its signature references "AccumulatorTarget" which is marked as @beta
-// /Users/markduckworth/projects/firebase-js-sdk/packages/firestore/dist/lite/index.d.ts:9249:9 - (ae-incompatible-release-tags) The symbol "groups" is marked as @public, but its signature references "Selectable" which is marked as @beta
-// /Users/markduckworth/projects/firebase-js-sdk/packages/firestore/dist/lite/index.d.ts:9278:9 - (ae-incompatible-release-tags) The symbol "orderings" is marked as @public, but its signature references "Ordering" which is marked as @beta
+// /Users/markduckworth/projects/firebase-js-sdk/packages/firestore/dist/lite/index.d.ts:9244:9 - (ae-incompatible-release-tags) The symbol "accumulators" is marked as @public, but its signature references "AccumulatorTarget" which is marked as @beta
+// /Users/markduckworth/projects/firebase-js-sdk/packages/firestore/dist/lite/index.d.ts:9245:9 - (ae-incompatible-release-tags) The symbol "groups" is marked as @public, but its signature references "Selectable" which is marked as @beta
+// /Users/markduckworth/projects/firebase-js-sdk/packages/firestore/dist/lite/index.d.ts:9274:9 - (ae-incompatible-release-tags) The symbol "orderings" is marked as @public, but its signature references "Ordering" which is marked as @beta
 
 ```

common/api-review/firestore.api.md

@@ -1119,8 +1119,6 @@ export interface FindNearestOptions {
 // @public
 export class Firestore {
     get app(): FirebaseApp;
-    // Warning: (ae-incompatible-release-tags) The symbol "pipeline" is marked as @public, but its signature references "PipelineSource" which is marked as @beta
-    pipeline(): PipelineSource;
     toJSON(): object;
     type: 'firestore-lite' | 'firestore';
 }
@@ -1925,7 +1923,6 @@ export class Query<AppModelType = DocumentData, DbModelType extends DocumentData
     protected constructor();
     readonly converter: FirestoreDataConverter<AppModelType, DbModelType> | null;
     readonly firestore: Firestore;
-    pipeline(): Pipeline;
     readonly type: 'query' | 'collection';
     withConverter(converter: null): Query<DocumentData, DocumentData>;
     withConverter<NewAppModelType, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): Query<NewAppModelType, NewDbModelType>;
@@ -2512,8 +2509,8 @@ export function xor(left: FilterExpr, ...right: FilterExpr[]): Xor;
 
 // Warnings were encountered during analysis:
 //
-// /Users/markduckworth/projects/firebase-js-sdk/packages/firestore/dist/index.d.ts:10177:26 - (ae-incompatible-release-tags) The symbol "accumulators" is marked as @public, but its signature references "AccumulatorTarget" which is marked as @beta
-// /Users/markduckworth/projects/firebase-js-sdk/packages/firestore/dist/index.d.ts:10177:61 - (ae-incompatible-release-tags) The symbol "groups" is marked as @public, but its signature references "Selectable" which is marked as @beta
-// /Users/markduckworth/projects/firebase-js-sdk/packages/firestore/dist/index.d.ts:10204:21 - (ae-incompatible-release-tags) The symbol "orderings" is marked as @public, but its signature references "Ordering" which is marked as @beta
+// /Users/markduckworth/projects/firebase-js-sdk/packages/firestore/dist/index.d.ts:10173:26 - (ae-incompatible-release-tags) The symbol "accumulators" is marked as @public, but its signature references "AccumulatorTarget" which is marked as @beta
+// /Users/markduckworth/projects/firebase-js-sdk/packages/firestore/dist/index.d.ts:10173:61 - (ae-incompatible-release-tags) The symbol "groups" is marked as @public, but its signature references "Selectable" which is marked as @beta
+// /Users/markduckworth/projects/firebase-js-sdk/packages/firestore/dist/index.d.ts:10200:21 - (ae-incompatible-release-tags) The symbol "orderings" is marked as @public, but its signature references "Ordering" which is marked as @beta
 
 ```

packages/firestore/src/api/database.ts

@@ -46,7 +46,6 @@ import {
   connectFirestoreEmulator,
   Firestore as LiteFirestore
 } from '../lite-api/database';
-import type { PipelineSource } from '../lite-api/pipeline-source';
 import { Query } from '../lite-api/reference';
 import {
   indexedDbClearPersistence,
@@ -129,15 +128,6 @@ export class Firestore extends LiteFirestore {
       await terminate;
     }
   }
-
-  /**
-   * Pipeline query.
-   */
-  pipeline(): PipelineSource {
-    throw new Error(
-      'Pipelines not initialized. Your application must call `useFluentPipelines()` before using Firestore Pipeline features.'
-    );
-  }
 }
 
 /**

packages/firestore/src/api/pipeline_impl.ts

@@ -28,6 +28,12 @@ import { Firestore, ensureFirestoreConfigured } from './database';
 import { DocumentReference, Query } from './reference';
 import { ExpUserDataWriter } from './user_data_writer';
 
+declare module './database' {
+  interface Firestore {
+    pipeline(): PipelineSource;
+  }
+}
+
 /**
  * Experimental Modular API for console testing.
  * @param firestore

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

@@ -43,7 +43,6 @@ import { logWarn } from '../util/log';
 import { FirestoreService, removeComponents } from './components';
 // `import type` to avoid bundling the source for
 // pipelines if `useFluentPipelines()` is not called
-import type { PipelineSource } from './pipeline-source';
 import {
   DEFAULT_HOST,
   FirestoreSettingsImpl,
@@ -176,15 +175,6 @@ export class Firestore implements FirestoreService {
     removeComponents(this);
     return Promise.resolve();
   }
-
-  /**
-   * Pipeline query.
-   */
-  pipeline(): PipelineSource {
-    throw new Error(
-      'Pipelines not initialized. Your application must call `useFluentPipelines()` before using Firestore Pipeline features.'
-    );
-  }
 }
 
 /**

packages/firestore/src/lite-api/pipeline_impl.ts

@@ -27,6 +27,18 @@ import { DocumentReference, Query } from './reference';
 import { LiteUserDataWriter } from './reference_impl';
 import { newUserDataReader } from './user_data_reader';
 
+declare module './database' {
+  interface Firestore {
+    pipeline(): PipelineSource;
+  }
+}
+
+declare module './reference' {
+  interface Query {
+    pipeline(): Pipeline;
+  }
+}
+
 /**
  * Modular API for console experimentation.
  * @param pipeline Execute this pipeline.

packages/firestore/src/lite-api/reference.ts

@@ -37,7 +37,6 @@ import { AutoId } from '../util/misc';
 import { Firestore } from './database';
 import { FieldPath } from './field_path';
 import { FieldValue } from './field_value';
-import type { Pipeline } from './pipeline';
 import { FirestoreDataConverter } from './snapshot';
 import { NestedUpdateFields, Primitive } from './types';
 
@@ -178,15 +177,6 @@ export class Query<
       this._query
     );
   }
-
-  /**
-   * Pipeline query.
-   */
-  pipeline(): Pipeline {
-    throw new Error(
-      'Pipelines not initialized. Your application must call `useFluentPipelines()` before using Firestore Pipeline features.'
-    );
-  }
 }
 
 /**

packages/firestore/test/integration/api/pipeline.test.ts

@@ -69,7 +69,7 @@ use(chaiAsPromised);
 
 setLogLevel('debug');
 
-apiDescribe.only('Pipelines', persistence => {
+apiDescribe('Pipelines', persistence => {
   addEqualityMatcher();
   let firestore: Firestore;
   let randomCol: CollectionReference;