Markduckworth/ppl node backport

package.json

@@ -142,6 +142,7 @@
     "postinstall-postinstall": "2.1.0",
     "prettier": "2.8.8",
     "protractor": "5.4.2",
+    "protobufjs-cli": "^1.1.3",
     "request": "2.88.2",
     "semver": "7.7.1",
     "simple-git": "3.27.0",

packages/firebase/firestore/pipelines/index.ts

@@ -0,0 +1,18 @@
+/**
+ * @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.
+ */
+
+export * from '@firebase/firestore/pipelines';

packages/firebase/firestore/pipelines/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "firebase/firestore/pipelines",
+  "main": "dist/pipelines.cjs.js",
+  "browser": "dist/esm/pipelines.esm.js",
+  "module": "dist/esm/pipelines.esm.js",
+  "typings": "dist/firestore/lite/pipelines.d.ts"
+}

packages/firebase/package.json

@@ -131,6 +131,18 @@
       },
       "default": "./firestore/dist/esm/index.esm.js"
     },
+    "./firestore/pipelines": {
+      "types": "./firestore/dist/firestore/pipelines.d.ts",
+      "node": {
+        "require": "./firestore/dist/pipelines.cjs.js",
+        "import": "./firestore/dist/pipelines.mjs"
+      },
+      "browser": {
+        "require": "./firestore/dist/pipelines.cjs.js",
+        "import": "./firestore/dist/esm/pipelines.esm.js"
+      },
+      "default": "./firestore/dist/esm/pipelines.esm.js"
+    },
     "./firestore/lite": {
       "types": "./firestore/lite/dist/firestore/lite/index.d.ts",
       "node": {

packages/firestore/.eslintrc.js

@@ -24,7 +24,7 @@ module.exports = {
     tsconfigRootDir: __dirname
   },
   plugins: ['import'],
-  ignorePatterns: ['compat/*'],
+  ignorePatterns: ['compat/*', 'pipelines.d.ts'],
   rules: {
     'no-console': ['error', { allow: ['warn', 'error'] }],
     '@typescript-eslint/no-unused-vars': [

packages/firestore/externs.json

@@ -17,7 +17,9 @@
     "packages/app-check-interop-types/index.d.ts",
     "packages/auth-interop-types/index.d.ts",
     "packages/firestore/dist/lite/internal.d.ts",
+    "packages/firestore/dist/lite/internal.pipelines.d.ts",
     "packages/firestore/dist/internal.d.ts",
+    "packages/firestore/dist/internal.pipelines.d.ts",
     "packages/firestore-types/index.d.ts",
     "packages/firebase/compat/index.d.ts",
     "packages/component/dist/src/component.d.ts",

packages/firestore/lite/pipelines/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "@firebase/firestore-lite-pipelines",
+  "description": "Pipelines for the lite Firestore SDK",
+  "main": "../../dist/lite/pipelines.node.cjs.js",
+  "main-esm": "../../dist/lite/pipelines.node.mjs",
+  "module": "../../dist/lite/pipelines.browser.esm2017.js",
+  "browser": "../../dist/lite/pipelines.browser.esm2017.js",
+  "react-native": "../../dist/lite/pipelines.rn.esm2017.js",
+  "typings": "./pipelines.d.ts",
+  "private": true,
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}

packages/firestore/lite/pipelines/pipelines.d.ts

@@ -0,0 +1,28 @@
+/**
+ * @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 { PipelineSource, Pipeline } from '../../dist/lite/pipelines';
+
+// Augument the Firestore class with the pipeline() method.
+// This is stripped from dist/lite/pipelines.d.ts during the build
+// so it needs to be re-added here.
+declare module '@firebase/firestore/lite' {
+  interface Firestore {
+    pipeline(): PipelineSource<Pipeline>;
+  }
+}
+
+export * from '../../dist/lite/pipelines';

packages/firestore/lite/pipelines/pipelines.ts

@@ -0,0 +1,173 @@
+/**
+ * Firestore Lite Pipelines
+ *
+ * @remarks Firestore Lite is a small online-only SDK that allows read
+ * and write access to your Firestore database. All operations connect
+ * directly to the backend, and `onSnapshot()` APIs are not supported.
+ * @packageDocumentation
+ */
+/**
+ * @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.
+ */
+
+// External exports: ./index
+// These external exports will be stripped from the dist/pipelines.d.ts file
+// by the prune-dts script, in order to reduce type duplication. However, these
+// types need to be exported here to ensure that api-extractor behaves
+// correctly. If a type from api.ts is missing from this export, then
+// api-extractor may rename it with a suffix `_#`, e.g. `YourType_2`.
+export type {
+  Timestamp,
+  DocumentReference,
+  VectorValue,
+  GeoPoint,
+  FieldPath,
+  DocumentData,
+  Query,
+  Firestore,
+  FirestoreDataConverter,
+  WithFieldValue,
+  PartialWithFieldValue,
+  SetOptions,
+  QueryDocumentSnapshot,
+  Primitive,
+  FieldValue,
+  Bytes
+} from '../index';
+
+export { PipelineSource } from '../../src/lite-api/pipeline-source';
+
+export { OneOf } from '../../src/util/types';
+
+export {
+  PipelineResult,
+  PipelineSnapshot
+} from '../../src/lite-api/pipeline-result';
+
+export { Pipeline } from '../../src/lite-api/pipeline';
+
+export { execute } from '../../src/lite-api/pipeline_impl';
+
+export {
+  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 {
+  Expression,
+  field,
+  and,
+  array,
+  constant,
+  add,
+  subtract,
+  multiply,
+  average,
+  substring,
+  count,
+  mapMerge,
+  mapRemove,
+  ifError,
+  isAbsent,
+  isError,
+  or,
+  divide,
+  isNotNan,
+  map,
+  isNotNull,
+  isNull,
+  mod,
+  documentId,
+  equal,
+  notEqual,
+  lessThan,
+  countIf,
+  lessThanOrEqual,
+  greaterThan,
+  greaterThanOrEqual,
+  arrayConcat,
+  arrayContains,
+  arrayContainsAny,
+  arrayContainsAll,
+  arrayLength,
+  equalAny,
+  notEqualAny,
+  xor,
+  conditional,
+  not,
+  logicalMaximum,
+  logicalMinimum,
+  exists,
+  isNan,
+  reverse,
+  byteLength,
+  charLength,
+  like,
+  regexContains,
+  regexMatch,
+  stringContains,
+  startsWith,
+  endsWith,
+  toLower,
+  toUpper,
+  trim,
+  stringConcat,
+  mapGet,
+  countAll,
+  minimum,
+  maximum,
+  cosineDistance,
+  dotProduct,
+  euclideanDistance,
+  vectorLength,
+  unixMicrosToTimestamp,
+  timestampToUnixMicros,
+  unixMillisToTimestamp,
+  timestampToUnixMillis,
+  unixSecondsToTimestamp,
+  timestampToUnixSeconds,
+  timestampAdd,
+  timestampSubtract,
+  ascending,
+  descending,
+  AliasedExpression,
+  Field,
+  Constant,
+  FunctionExpression,
+  Ordering,
+  ExpressionType,
+  AliasedAggregate,
+  Selectable,
+  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",
@@ -50,11 +51,13 @@
     "test:minified": "(cd ../../integration/firestore ; yarn test)",
     "trusted-type-check": "tsec -p tsconfig.json --noEmit",
     "api-report:main": "TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' ts-node ../../repo-scripts/prune-dts/extract-public-api.ts --package firestore --packageRoot . --typescriptDts ./dist/firestore/src/index.d.ts --rollupDts ./dist/private.d.ts --untrimmedRollupDts ./dist/internal.d.ts --publicDts ./dist/index.d.ts",
+    "api-report:pipelines": "TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' ts-node ../../repo-scripts/prune-dts/extract-public-api.ts --package firestore-pipelines --packageRoot . --typescriptDts ./dist/firestore/pipelines/pipelines.d.ts --rollupDts ./dist/private.pipelines.d.ts --untrimmedRollupDts ./dist/internal.pipelines.d.ts --publicDts ./dist/pipelines.d.ts --otherExportsPublicDtsFiles ./dist/index.d.ts",
     "api-report:lite": "TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' ts-node ../../repo-scripts/prune-dts/extract-public-api.ts --package firestore-lite --packageRoot . --typescriptDts ./dist/firestore/lite/index.d.ts --rollupDts ./dist/lite/private.d.ts --untrimmedRollupDts ./dist/lite/internal.d.ts --publicDts ./dist/lite/index.d.ts",
+    "api-report:lite:pipelines": "TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' ts-node ../../repo-scripts/prune-dts/extract-public-api.ts --package firestore-lite-pipelines --packageRoot . --typescriptDts ./dist/firestore/lite/pipelines/pipelines.d.ts --rollupDts ./dist/lite/private.pipelines.d.ts --untrimmedRollupDts ./dist/lite/internal.pipelines.d.ts --publicDts ./dist/lite/pipelines.d.ts --otherExportsPublicDtsFiles ./dist/lite/index.d.ts",
     "api-report:api-json": "rm -rf temp && api-extractor run --local --verbose",
-    "api-report": "run-s --npm-path npm api-report:main api-report:lite && yarn api-report:api-json",
+    "api-report": "run-s --npm-path npm api-report:main api-report:pipelines api-report:lite api-report:lite:pipelines && yarn api-report:api-json",
     "doc": "api-documenter markdown --input temp --output docs",
-    "typings:public": "node ../../scripts/build/use_typings.js ./dist/index.d.ts",
+    "typings:public": "node ../../scripts/build/use_typings.js ./dist/all-packages.d.ts",
     "assertion-id:check": "ts-node scripts/assertion-id-tool.ts --dir=src --check",
     "assertion-id:new": "ts-node scripts/assertion-id-tool.ts --dir=src --new",
     "assertion-id:list": "ts-node scripts/assertion-id-tool.ts --dir=src --list",
@@ -82,11 +85,37 @@
       },
       "react-native": "./dist/lite/index.rn.esm.js",
       "browser": {
-        "require": "./dist/lite/index.cjs.js",
+        "require": "./dist/lite/index.browser.cjs.js",
         "import": "./dist/lite/index.browser.esm.js"
       },
       "default": "./dist/lite/index.browser.esm.js"
     },
+    "./lite/pipelines": {
+      "types": "./dist/lite/pipelines.d.ts",
+      "node": {
+        "require": "./dist/lite/pipelines.node.cjs.js",
+        "import": "./dist/lite/pipelines.node.mjs"
+      },
+      "react-native": "./dist/lite/pipelines.rn.esm.js",
+      "browser": {
+        "require": "./dist/lite/pipelines.browser.cjs.js",
+        "import": "./dist/lite/pipelines.browser.esm.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.esm.js",
+      "browser": {
+        "require": "./dist/pipelines.cjs.js",
+        "import": "./dist/pipelines.esm.js"
+      },
+      "default": "./dist/pipelines.esm.js"
+    },
     "./package.json": "./package.json"
   },
   "main": "dist/index.node.cjs.js",
@@ -97,7 +126,11 @@
   "license": "Apache-2.0",
   "files": [
     "dist",
-    "lite/package.json"
+    "lite/package.json",
+    "pipelines/package.json",
+    "pipelines/pipelines.d.ts",
+    "lite/pipelines/package.json",
+    "lite/pipelines/pipelines.d.ts"
   ],
   "dependencies": {
     "@firebase/component": "0.7.0",
@@ -140,7 +173,7 @@
   "bugs": {
     "url": "https://github.com/firebase/firebase-js-sdk/issues"
   },
-  "typings": "dist/firestore/src/index.d.ts",
+  "types": "dist/firestore/src/index.d.ts",
   "nyc": {
     "extension": [
       ".ts"

packages/firestore/pipelines/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "@firebase/firestore/pipelines",
+  "description": "pipelines",
+  "main": "../dist/pipelines.node.cjs.js",
+  "main-esm": "../dist/pipelines.node.mjs",
+  "module": "../dist/pipelines.browser.esm2017.js",
+  "browser": "../dist/pipelines.browser.esm2017.js",
+  "react-native": "../dist/pipelines.rn.esm2017.js",
+  "typings": "./pipelines.d.ts",
+  "private": true,
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}