feat/pipelines to main

integration/firestore/gulpfile.js

@@ -61,6 +61,23 @@ function copyTests() {
         /\s+from '\.(\.\/util)?\/firebase_export';/,
         ` from '${resolve(__dirname, './firebase_export')}';
 
+if (typeof process === 'undefined') {
+  process = { env: { INCLUDE_FIRESTORE_PERSISTENCE: '${isPersistenceEnabled()}' } } as any;
+} else {
+  process.env.INCLUDE_FIRESTORE_PERSISTENCE = '${isPersistenceEnabled()}';
+}
+`
+      )
+    )
+    .pipe(
+      replace(
+        /**
+         * This regex is designed to match the Firebase import in our
+         * integration tests.
+         */
+        /\s+from '\.(\.\/util)?\/pipeline_export';/,
+        ` from '${resolve(__dirname, './pipeline_export')}';
+
 if (typeof process === 'undefined') {
   process = { env: { INCLUDE_FIRESTORE_PERSISTENCE: '${isPersistenceEnabled()}' } } as any;
 } else {

integration/firestore/pipeline_export.ts

@@ -0,0 +1,21 @@
+/**
+ * @license
+ * Copyright 2025 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.
+ */
+
+// This file replaces "packages/firestore/test/integration/util/pipeline_export"
+// and depends on the minified sources.
+
+export * from '@firebase/firestore/pipelines';

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/lite/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/lite/pipelines';

packages/firebase/firestore/lite/pipelines/package.json

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

packages/firebase/firestore/package.json

@@ -4,4 +4,4 @@
   "browser": "dist/esm/index.esm.js",
   "module": "dist/esm/index.esm.js",
   "typings": "dist/firestore/index.d.ts"
-}
+}

packages/firebase/firestore/pipelines/index.cdn.ts

@@ -0,0 +1,21 @@
+/**
+ * @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';
+
+import * as pipelines from '@firebase/firestore/pipelines';
+export { pipelines };

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/pipelines/index.d.ts"
+}

packages/firebase/gulpfile.js

@@ -21,7 +21,7 @@ const replace = require('gulp-replace');
 
 const pkgJson = require('./package.json');
 const files = pkgJson.components.map(component => {
-  const componentName = component.replace('/', '-');
+  const componentName = component.replaceAll('/', '-');
   return `firebase-${componentName}.js`;
 });
 const FIREBASE_APP_URL = `https://www.gstatic.com/firebasejs/${pkgJson.version}/firebase-app.js`;

packages/firebase/package.json

@@ -131,6 +131,18 @@
       },
       "default": "./firestore/dist/esm/index.esm.js"
     },
+    "./firestore/pipelines": {
+      "types": "./firestore/pipelines/dist/firestore/pipelines/index.d.ts",
+      "node": {
+        "require": "./firestore/pipelines/dist/pipelines.cjs.js",
+        "import": "./firestore/pipelines/dist/pipelines.mjs"
+      },
+      "browser": {
+        "require": "./firestore/pipelines/dist/pipelines.cjs.js",
+        "import": "./firestore/pipelines/dist/esm/pipelines.esm.js"
+      },
+      "default": "./firestore/pipelines/dist/esm/pipelines.esm.js"
+    },
     "./firestore/lite": {
       "types": "./firestore/lite/dist/firestore/lite/index.d.ts",
       "node": {
@@ -143,6 +155,18 @@
       },
       "default": "./firestore/lite/dist/esm/index.esm.js"
     },
+    "./firestore/lite/pipelines": {
+      "types": "./firestore/lite/pipelines/dist/firestore/lite/pipelines/index.d.ts",
+      "node": {
+        "require": "./firestore/lite/pipelines/dist/pipelines.cjs.js",
+        "import": "./firestore/lite/pipelines/dist/pipelines.mjs"
+      },
+      "browser": {
+        "require": "./firestore/lite/pipelines/dist/pipelines.cjs.js",
+        "import": "./firestore/lite/pipelines/dist/esm/pipelines.esm.js"
+      },
+      "default": "./firestore/lite/pipelines/dist/esm/pipelines.esm.js"
+    },
     "./functions": {
       "types": "./functions/dist/functions/index.d.ts",
       "node": {
@@ -453,6 +477,8 @@
     "functions",
     "firestore",
     "firestore/lite",
+    "firestore/pipelines",
+    "firestore/lite/pipelines",
     "installations",
     "storage",
     "performance",

packages/firebase/rollup.config.js

@@ -20,6 +20,7 @@ import commonjs from '@rollup/plugin-commonjs';
 import json from '@rollup/plugin-json';
 import pkg from './package.json';
 import { resolve } from 'path';
+import { existsSync } from 'fs';
 import resolveModule from '@rollup/plugin-node-resolve';
 import rollupTypescriptPlugin from 'rollup-plugin-typescript2';
 import sourcemaps from 'rollup-plugin-sourcemaps';
@@ -149,10 +150,12 @@ const cdnBuilds = [
     .map(component => {
       // It is needed for handling sub modules, for example firestore/lite which should produce firebase-firestore-lite.js
       // Otherwise, we will create a directory with '/' in the name.
-      const componentName = component.replace('/', '-');
+      const componentName = component.replaceAll('/', '-');
 
       return {
-        input: `${component}/index.ts`,
+        input: existsSync(`${component}/index.cdn.ts`)
+          ? `${component}/index.cdn.ts`
+          : `${component}/index.ts`,
         output: {
           file: `firebase-${componentName}.js`,
           sourcemap: true,

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.esm.js",
+  "browser": "../../dist/lite/pipelines.browser.esm.js",
+  "react-native": "../../dist/lite/pipelines.rn.esm.js",
+  "typings": "./pipelines.d.ts",
+  "private": true,
+  "engines": {
+    "node": ">=20.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';