Implementing features from API audit and node backport

packages/firestore/lite/pipelines/pipelines.ts

@@ -50,6 +50,8 @@ export type {
 
 export { PipelineSource } from '../../src/lite-api/pipeline-source';
 
+export { OneOf } from '../../src/util/types';
+
 export {
   PipelineResult,
   PipelineSnapshot
@@ -60,94 +62,86 @@ export { Pipeline } from '../../src/lite-api/pipeline';
 export { execute } from '../../src/lite-api/pipeline_impl';
 
 export {
-  Stage,
-  FindNearestOptions,
-  AddFields,
-  Aggregate,
-  Distinct,
-  CollectionSource,
-  CollectionGroupSource,
-  DatabaseSource,
-  DocumentsSource,
-  Where,
-  FindNearest,
-  Limit,
-  Offset,
-  Select,
-  Sort,
-  GenericStage
-} from '../../src/lite-api/stage';
+  StageOptions,
+  CollectionStageOptions,
+  CollectionGroupStageOptions,
+  DatabaseStageOptions,
+  DocumentsStageOptions,
+  AddFieldsStageOptions,
+  RemoveFieldsStageOptions,
+  SelectStageOptions,
+  WhereStageOptions,
+  OffsetStageOptions,
+  LimitStageOptions,
+  DistinctStageOptions,
+  AggregateStageOptions,
+  FindNearestStageOptions,
+  ReplaceWithStageOptions,
+  SampleStageOptions,
+  UnionStageOptions,
+  UnnestStageOptions,
+  SortStageOptions
+} from '../../src/lite-api/stage_options';
 
 export {
-  Expr,
+  Expression,
   field,
   and,
   array,
-  arrayOffset,
   constant,
   add,
   subtract,
   multiply,
-  avg,
-  bitAnd,
-  substr,
-  constantVector,
-  bitLeftShift,
-  bitNot,
+  average,
+  substring,
   count,
   mapMerge,
   mapRemove,
-  bitOr,
   ifError,
   isAbsent,
   isError,
   or,
-  rand,
-  bitRightShift,
-  bitXor,
   divide,
   isNotNan,
   map,
   isNotNull,
   isNull,
   mod,
   documentId,
-  eq,
-  neq,
-  lt,
+  equal,
+  notEqual,
+  lessThan,
   countIf,
-  lte,
-  gt,
-  gte,
+  lessThanOrEqual,
+  greaterThan,
+  greaterThanOrEqual,
   arrayConcat,
   arrayContains,
   arrayContainsAny,
   arrayContainsAll,
   arrayLength,
-  eqAny,
-  notEqAny,
+  equalAny,
+  notEqualAny,
   xor,
-  cond,
+  conditional,
   not,
   logicalMaximum,
   logicalMinimum,
   exists,
   isNan,
   reverse,
-  replaceFirst,
-  replaceAll,
   byteLength,
   charLength,
   like,
   regexContains,
   regexMatch,
-  strContains,
+  stringContains,
   startsWith,
   endsWith,
   toLower,
   toUpper,
   trim,
-  strConcat,
+  stringConcat,
   mapGet,
   countAll,
   minimum,
@@ -163,17 +157,17 @@ export {
   unixSecondsToTimestamp,
   timestampToUnixSeconds,
   timestampAdd,
-  timestampSub,
+  timestampSubtract,
   ascending,
   descending,
-  ExprWithAlias,
+  AliasedExpression,
   Field,
   Constant,
-  FunctionExpr,
+  FunctionExpression,
   Ordering,
-  ExprType,
+  ExpressionType,
   AggregateWithAlias,
   Selectable,
-  BooleanExpr,
+  BooleanExpression,
   AggregateFunction
 } from '../../src/lite-api/expressions';

packages/firestore/package.json

@@ -8,6 +8,7 @@
   "author": "Firebase <[email protected]> (https://firebase.google.com/)",
   "scripts": {
     "bundle": "rollup -c",
+    "compile": "tsc --emitDeclarationOnly --declaration -p tsconfig.json",
     "prebuild": "tsc --emitDeclarationOnly --declaration -p tsconfig.json; yarn api-report",
     "build": "run-p --npm-path npm build:lite build:main",
     "build:release": "yarn build && yarn typings:public",
@@ -95,33 +96,33 @@
         "require": "./dist/lite/pipelines.node.cjs.js",
         "import": "./dist/lite/pipelines.node.mjs"
       },
-      "react-native": "./dist/lite/pipelines.rn.esm2017.js",
+      "react-native": "./dist/lite/pipelines.rn.esm.js",
       "browser": {
         "require": "./dist/lite/pipelines.browser.cjs.js",
-        "import": "./dist/lite/pipelines.browser.esm2017.js"
+        "import": "./dist/lite/pipelines.browser.esm.js"
       },
-      "default": "./dist/lite/pipelines.browser.esm2017.js"
+      "default": "./dist/lite/pipelines.browser.esm.js"
     },
     "./pipelines": {
       "types": "./pipelines/pipelines.d.ts",
       "node": {
         "require": "./dist/pipelines.node.cjs.js",
         "import": "./dist/pipelines.node.mjs"
       },
-      "react-native": "./dist/index.rn.esm2017.js",
+      "react-native": "./dist/index.rn.esm.js",
       "browser": {
         "require": "./dist/pipelines.cjs.js",
-        "import": "./dist/pipelines.esm2017.js"
+        "import": "./dist/pipelines.esm.js"
       },
-      "default": "./dist/pipelines.esm2017.js"
+      "default": "./dist/pipelines.esm.js"
     },
     "./package.json": "./package.json"
   },
   "main": "dist/node-cjs/index.node.cjs.js",
   "main-esm": "dist/node-esm/index.node.mjs",
   "react-native": "dist/index.rn.js",
-  "browser": "dist/index.esm.js",
-  "module": "dist/index.esm.js",
+  "browser": "dist/browser-esm2017/index.esm.js",
+  "module": "dist/browser-esm2017/index.esm.js",
   "license": "Apache-2.0",
   "files": [
     "dist",

packages/firestore/rollup.config.js

@@ -178,8 +178,8 @@ const allBuilds = [
     output: [
       {
         dir: 'dist/',
-        entryFileNames: '[name].esm2017.js',
-        chunkFileNames: 'common-[hash].esm2017.js',
+        entryFileNames: '[name].esm.js',
+        chunkFileNames: 'common-[hash].esm.js',
         format: 'es',
         sourcemap: true
       }

packages/firestore/rollup.config.lite.js

@@ -187,8 +187,8 @@ const allBuilds = [
     output: [
       {
         dir: 'dist/lite/',
-        entryFileNames: '[name].esm2017.js',
-        chunkFileNames: 'common-[hash].esm2017.js',
+        entryFileNames: '[name].esm.js',
+        chunkFileNames: 'common-[hash].esm.js',
         format: 'es',
         sourcemap: true
       }
@@ -207,8 +207,8 @@ const allBuilds = [
     input: ['./lite/index.ts', './lite/pipelines/pipelines.ts'],
     output: {
       dir: 'dist/lite/',
-      entryFileNames: '[name].rn.esm2017.js',
-      chunkFileNames: 'common-[hash].rn.esm2017.js',
+      entryFileNames: '[name].rn.esm.js',
+      chunkFileNames: 'common-[hash].rn.esm.js',
       format: 'es',
       sourcemap: true
     },

packages/firestore/src/api/pipeline_impl.ts

@@ -17,11 +17,20 @@
 
 import { Pipeline } from '../api/pipeline';
 import { firestoreClientExecutePipeline } from '../core/firestore_client';
+import {
+  StructuredPipeline,
+  StructuredPipelineOptions
+} from '../core/structured_pipeline';
 import { Pipeline as LitePipeline } from '../lite-api/pipeline';
 import { PipelineResult, PipelineSnapshot } from '../lite-api/pipeline-result';
 import { PipelineSource } from '../lite-api/pipeline-source';
+import { PipelineExecuteOptions } from '../lite-api/pipeline_options';
 import { Stage } from '../lite-api/stage';
-import { newUserDataReader } from '../lite-api/user_data_reader';
+import {
+  newUserDataReader,
+  UserDataReader,
+  UserDataSource
+} from '../lite-api/user_data_reader';
 import { cast } from '../util/input_validation';
 
 import { ensureFirestoreConfigured, Firestore } from './database';
@@ -68,45 +77,86 @@ declare module './database' {
  * @param pipeline The pipeline to execute.
  * @return A Promise representing the asynchronous pipeline execution.
  */
-export function execute(pipeline: LitePipeline): Promise<PipelineSnapshot> {
+export function execute(pipeline: LitePipeline): Promise<PipelineSnapshot>;
+export function execute(
+  options: PipelineExecuteOptions
+): Promise<PipelineSnapshot>;
+export function execute(
+  pipelineOrOptions: LitePipeline | PipelineExecuteOptions
+): Promise<PipelineSnapshot> {
+  const options: PipelineExecuteOptions = !(
+    pipelineOrOptions instanceof LitePipeline
+  )
+    ? pipelineOrOptions
+    : {
+        pipeline: pipelineOrOptions
+      };
+
+  const { pipeline, rawOptions, ...rest } = options;
+
   const firestore = cast(pipeline._db, Firestore);
   const client = ensureFirestoreConfigured(firestore);
-  return firestoreClientExecutePipeline(client, pipeline).then(result => {
-    // Get the execution time from the first result.
-    // firestoreClientExecutePipeline returns at least one PipelineStreamElement
-    // even if the returned document set is empty.
-    const executionTime =
-      result.length > 0 ? result[0].executionTime?.toTimestamp() : undefined;
 
-    const docs = result
-      // Currently ignore any response from ExecutePipeline that does
-      // not contain any document data in the `fields` property.
-      .filter(element => !!element.fields)
-      .map(
-        element =>
-          new PipelineResult(
-            pipeline._userDataWriter,
-            element.key?.path
-              ? new DocumentReference(firestore, null, element.key)
-              : undefined,
-            element.fields,
-            element.createTime?.toTimestamp(),
-            element.updateTime?.toTimestamp()
-          )
-      );
+  const udr = new UserDataReader(
+    firestore._databaseId,
+    /* ignoreUndefinedProperties */ true
+  );
+  const context = udr.createContext(UserDataSource.Argument, 'execute');
+
+  const structuredPipelineOptions = new StructuredPipelineOptions(
+    rest,
+    rawOptions
+  );
+  structuredPipelineOptions._readUserData(context);
 
-    return new PipelineSnapshot(pipeline, docs, executionTime);
-  });
+  const structuredPipeline: StructuredPipeline = new StructuredPipeline(
+    pipeline,
+    structuredPipelineOptions
+  );
+
+  return firestoreClientExecutePipeline(client, structuredPipeline).then(
+    result => {
+      // Get the execution time from the first result.
+      // firestoreClientExecutePipeline returns at least one PipelineStreamElement
+      // even if the returned document set is empty.
+      const executionTime =
+        result.length > 0 ? result[0].executionTime?.toTimestamp() : undefined;
+
+      const docs = result
+        // Currently ignore any response from ExecutePipeline that does
+        // not contain any document data in the `fields` property.
+        .filter(element => !!element.fields)
+        .map(
+          element =>
+            new PipelineResult(
+              pipeline._userDataWriter,
+              element.fields!,
+              element.key?.path
+                ? new DocumentReference(firestore, null, element.key)
+                : undefined,
+              element.createTime?.toTimestamp(),
+              element.updateTime?.toTimestamp()
+            )
+        );
+
+      return new PipelineSnapshot(pipeline, docs, executionTime);
+    }
+  );
 }
 
 // Augment the Firestore class with the pipeline() factory method
 Firestore.prototype.pipeline = function (): PipelineSource<Pipeline> {
-  return new PipelineSource<Pipeline>(this._databaseId, (stages: Stage[]) => {
-    return new Pipeline(
-      this,
-      newUserDataReader(this),
-      new ExpUserDataWriter(this),
-      stages
-    );
-  });
+  const userDataReader = newUserDataReader(this);
+  return new PipelineSource<Pipeline>(
+    this._databaseId,
+    userDataReader,
+    (stages: Stage[]) => {
+      return new Pipeline(
+        this,
+        userDataReader,
+        new ExpUserDataWriter(this),
+        stages
+      );
+    }
+  );
 };