Update the typings export for pipelines and lite pipelines so that it auguments the Firestore and Query classes.

Author: MarkDuckworth

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' {
+  interface Firestore {
+    pipeline(): PipelineSource<Pipeline>;
+  }
+}
+
+export * from "../../dist/lite/pipelines";

packages/firestore/package.json

@@ -98,7 +98,7 @@
       "default": "./dist/lite/pipelines.browser.esm2017.js"
     },
     "./pipelines": {
-      "types": "./dist/pipelines.d.ts",
+      "types": "./pipelines/pipelines.d.ts",
       "node": {
         "require": "./dist/pipelines.node.cjs.js",
         "import": "./dist/pipelines.node.mjs"

packages/firestore/pipelines/package.json

@@ -6,7 +6,7 @@
   "module": "../dist/pipelines.browser.esm2017.js",
   "browser": "../dist/pipelines.browser.esm2017.js",
   "react-native": "../dist/pipelines.rn.esm2017.js",
-  "typings": "../dist/pipelines.d.ts",
+  "typings": "./pipelines.d.ts",
   "private": true,
   "engines": {
     "node": ">=18.0.0"

packages/firestore/pipelines/pipelines.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @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/pipelines";
+
+// Augument the Firestore and Query classes 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' {
+  interface Firestore {
+    pipeline(): PipelineSource<Pipeline>;
+  }
+  interface Query {
+    pipeline(): Pipeline;
+  }
+}
+
+export * from "../dist/pipelines";

packages/firestore/src/api/pipeline_impl.ts

@@ -27,12 +27,6 @@ import { Firestore } from './database';
 import { Query } from './reference';
 import { ExpUserDataWriter } from './user_data_writer';
 
-declare module './database' {
-  interface Firestore {
-    pipeline(): PipelineSource<Pipeline>;
-  }
-}
-
 /**
  * Experimental Modular API for console testing.
  * @param firestore
@@ -79,12 +73,12 @@ export function execute(pipeline: LitePipeline): Promise<PipelineResult[]> {
   return pipeline.execute();
 }
 
-// Augument the Firestore class with the pipeline() factory method
+// Augment the Firestore class with the pipeline() factory method
 Firestore.prototype.pipeline = function (): PipelineSource<Pipeline> {
   return pipeline(this);
 };
 
-// Augument the Query class with the pipeline() factory method
+// Augment the Query class with the pipeline() factory method
 Query.prototype.pipeline = function (): Pipeline {
   return pipeline(this);
 };