Fix build. Finish rename. Rename useFirestorePipelines to useFluentPipelines.

Author: MarkDuckworth

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

@@ -31,11 +31,13 @@ export { PipelineSource } from '../src/lite-api/pipeline-source';
 
 export { PipelineResult } from '../src/lite-api/pipeline-result';
 
-export { Pipeline, pipeline } from '../src/lite-api/pipeline';
+export { Pipeline } from '../src/lite-api/pipeline';
 
-export { useFirestorePipelines } from '../src/lite-api/database_augmentation';
-
-export { execute } from '../src/lite-api/pipeline_impl';
+export {
+  useFluentPipelines,
+  pipeline,
+  execute
+} from '../src/lite-api/pipeline_impl';
 
 export {
   Stage,
@@ -73,13 +75,13 @@ export {
   arrayContainsAny,
   arrayContainsAll,
   arrayLength,
-  inAny,
-  notInAny,
+  eqAny,
+  notEqAny,
   xor,
-  ifFunction,
+  cond,
   not,
-  logicalMax,
-  logicalMin,
+  logicalMaximum,
+  logicalMinimum,
   exists,
   isNan,
   reverse,
@@ -99,8 +101,8 @@ export {
   strConcat,
   mapGet,
   countAll,
-  min,
-  max,
+  minimum,
+  maximum,
   cosineDistance,
   dotProduct,
   euclideanDistance,
@@ -139,16 +141,16 @@ export {
   ArrayContainsAny,
   ArrayLength,
   ArrayElement,
-  In,
+  EqAny,
   IsNan,
   Exists,
   Not,
   And,
   Or,
   Xor,
-  If,
-  LogicalMax,
-  LogicalMin,
+  Cond,
+  LogicalMaximum,
+  LogicalMinimum,
   Reverse,
   ReplaceFirst,
   ReplaceAll,
@@ -168,8 +170,8 @@ export {
   Count,
   Sum,
   Avg,
-  Min,
-  Max,
+  Minimum,
+  Maximum,
   CosineDistance,
   DotProduct,
   EuclideanDistance,

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

@@ -135,7 +135,7 @@ export class Firestore extends LiteFirestore {
    */
   pipeline(): PipelineSource {
     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.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

@@ -17,8 +17,9 @@
 
 import { Pipeline } from '../api/pipeline';
 import { PipelineSource } from '../api/pipeline-source';
-import { PipelineResult } from '../api_pipelines';
 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';
@@ -68,7 +69,7 @@ export function pipeline(
     return result;
   }
 }
-export function useFirestorePipelines(): void {
+export function useFluentPipelines(): void {
   Firestore.prototype.pipeline = function (): PipelineSource {
     return pipeline(this);
   };
@@ -83,7 +84,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,