Merge remote-tracking branch 'origin/feat/pipelines' into new-types

Author: ehsannas

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

@@ -143,6 +143,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",

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

@@ -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';

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/firestore/pipelines/index.ts

@@ -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/firebase/firestore/pipelines/package.json

@@ -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/firebase/package.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/.eslintrc.js

@@ -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/externs.json

@@ -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';