Merge remote-tracking branch 'origin/feat/pipelines' into wuandy/offppl-type1

# Conflicts:
#	packages/firestore/lite/index.ts
#	packages/firestore/src/api/database_augmentation.ts
#	packages/firestore/src/api/pipeline_impl.ts
#	packages/firestore/src/lite-api/expressions.ts

Author: wu-hui

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

@@ -33,7 +33,11 @@ export { PipelineResult } from '../src/lite-api/pipeline-result';
 
 export { Pipeline } from '../src/lite-api/pipeline';
 
-export { execute } from '../src/lite-api/pipeline_impl';
+export {
+  useFluentPipelines,
+  pipeline,
+  execute
+} from '../src/lite-api/pipeline_impl';
 
 export {
   Stage,

common/api-review/firestore.api.md

@@ -21,9 +21,7 @@ export { PipelineResult } from './lite-api/pipeline-result';
 
 export { Pipeline } from './api/pipeline';
 
-export { useFirestorePipelines, pipeline } from './api/pipeline_impl';
-
-export { execute } from './lite-api/pipeline_impl';
+export { useFluentPipelines, pipeline, execute } from './api/pipeline_impl';
 
 export {
   Stage,

packages/firestore/lite/index.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 `useFirestorePipelines()` before using Firestore Pipeline features.'
-    );
-  }
 }
 
 /**

packages/firestore/src/api.ts

@@ -39,61 +39,61 @@ export class PipelineSource extends LitePipelineSoure {
   /**
    * @internal
    * @private
-   * @param db
-   * @param userDataReader
-   * @param userDataWriter
-   * @param documentReferenceFactory
+   * @param _db
+   * @param _userDataReader
+   * @param _userDataWriter
+   * @param _documentReferenceFactory
    */
   // eslint-disable-next-line @typescript-eslint/no-useless-constructor
   constructor(
-    db: Firestore,
-    userDataReader: UserDataReader,
-    userDataWriter: AbstractUserDataWriter,
-    documentReferenceFactory: (id: DocumentKey) => DocumentReference
+    _db: Firestore,
+    _userDataReader: UserDataReader,
+    _userDataWriter: AbstractUserDataWriter,
+    _documentReferenceFactory: (id: DocumentKey) => DocumentReference
   ) {
-    super(db, userDataReader, userDataWriter, documentReferenceFactory);
+    super(_db, _userDataReader, _userDataWriter, _documentReferenceFactory);
   }
 
   collection(collectionPath: string): Pipeline {
-    const db = cast<Firestore>(this.db, Firestore);
+    const _db = cast<Firestore>(this._db, Firestore);
     return new Pipeline(
-      db,
-      this.userDataReader,
-      this.userDataWriter,
-      this.documentReferenceFactory,
+      _db,
+      this._userDataReader,
+      this._userDataWriter,
+      this._documentReferenceFactory,
       [new CollectionSource(collectionPath)]
     );
   }
 
   collectionGroup(collectionId: string): Pipeline {
-    const db = cast<Firestore>(this.db, Firestore);
+    const _db = cast<Firestore>(this._db, Firestore);
     return new Pipeline(
-      db,
-      this.userDataReader,
-      this.userDataWriter,
-      this.documentReferenceFactory,
+      _db,
+      this._userDataReader,
+      this._userDataWriter,
+      this._documentReferenceFactory,
       [new CollectionGroupSource(collectionId)]
     );
   }
 
   database(): Pipeline {
-    const db = cast<Firestore>(this.db, Firestore);
+    const _db = cast<Firestore>(this._db, Firestore);
     return new Pipeline(
-      db,
-      this.userDataReader,
-      this.userDataWriter,
-      this.documentReferenceFactory,
+      _db,
+      this._userDataReader,
+      this._userDataWriter,
+      this._documentReferenceFactory,
       [new DatabaseSource()]
     );
   }
 
   documents(docs: DocumentReference[]): Pipeline {
-    const db = cast<Firestore>(this.db, Firestore);
+    const _db = cast<Firestore>(this._db, Firestore);
     return new Pipeline(
-      db,
-      this.userDataReader,
-      this.userDataWriter,
-      this.documentReferenceFactory,
+      _db,
+      this._userDataReader,
+      this._userDataWriter,
+      this._documentReferenceFactory,
       [DocumentsSource.of(docs)]
     );
   }

packages/firestore/src/api/database.ts

@@ -58,6 +58,17 @@ export class Pipeline<
     );
   }
 
+  /**
+   * @internal
+   * @private
+   * @param db
+   * @param userDataReader
+   * @param userDataWriter
+   * @param documentReferenceFactory
+   * @param stages
+   * @param converter
+   * @protected
+   */
   protected newPipeline(
     db: Firestore,
     userDataReader: UserDataReader,
@@ -109,7 +120,7 @@ export class Pipeline<
    */
   execute(): Promise<Array<PipelineResult<AppModelType>>> {
     throw new Error(
-      'Pipelines not initialized. Your application must call `useFirestorePipelines()` before using Firestore Pipeline features.'
+      'Pipelines not initialized. Your application must call `useFluentPipelines()` before using Firestore Pipeline features.'
     );
   }
 }

packages/firestore/src/api/database_augmentation.ts

@@ -1,16 +1,19 @@
-// Copyright 2024 Google LLC
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//      http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 
 import { PipelineSnapshot } from './snapshot';
 import { FirestoreError } from '../util/error';
@@ -28,13 +31,22 @@ import { PipelineResult } from '../lite-api/pipeline-result';
 import { CorePipeline } from '../core/pipeline_run';
 
 import { PipelineSource } from '../api/pipeline-source';
+import { firestoreClientExecutePipeline } from '../core/firestore_client';
+import { Pipeline as LitePipeline } from '../lite-api/pipeline';
+import { PipelineResult } from '../lite-api/pipeline-result';
 import { newUserDataReader } from '../lite-api/user_data_reader';
 import { DocumentKey } from '../model/document_key';
 import { cast } from '../util/input_validation';
 
 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
@@ -76,7 +88,7 @@ export function pipeline(
     return result;
   }
 }
-export function useFirestorePipelines(): void {
+export function useFluentPipelines(): void {
   Firestore.prototype.pipeline = function (): PipelineSource {
     return pipeline(this);
   };
@@ -91,7 +103,7 @@ export function useFirestorePipelines(): void {
 }
 
 export function execute<AppModelType>(
-  pipeline: Pipeline
+  pipeline: LitePipeline
 ): Promise<Array<PipelineResult<AppModelType>>> {
   const firestore = cast(pipeline._db, Firestore);
   const client = ensureFirestoreConfigured(firestore);

packages/firestore/src/api/pipeline-source.ts

@@ -20,7 +20,7 @@ export { PipelineResult } from './lite-api/pipeline-result';
 
 export { Pipeline } from './lite-api/pipeline';
 
-export { useFirestorePipelines } from './api/database_augmentation';
+export { useFluentPipelines, execute, pipeline } from './api/pipeline_impl';
 
 export {
   Stage,