Firestore pipelines

.github/scripts/compare-types/README.md

@@ -185,7 +185,9 @@ import newPackageConfig from '../packages/<package-name>/config';
 // inside the packages array:
 {
   name: '<package-name>',
-  firebaseSdkTypesPath: path.join(SCRIPT_DIR, 'packages', '<package-name>', 'firebase-sdk.d.ts'),
+  firebaseSdkTypesPaths: [
+    path.join(SCRIPT_DIR, 'packages', '<package-name>', 'firebase-sdk.d.ts'),
+  ],
   rnFirebaseModularFiles: [
     path.join(rnDist('<package-name>'), 'types', 'modular.d.ts'),
     path.join(rnDist('<package-name>'), 'modular.d.ts'),

.github/scripts/compare-types/packages/firestore-pipelines/config.ts

@@ -0,0 +1,30 @@
+/**
+ * Known differences between the firebase-js-sdk Firestore Pipelines API
+ * and the @react-native-firebase/firestore pipelines API
+ * (imported from "@react-native-firebase/firestore/pipelines").
+ *
+ * Reference: .github/scripts/compare-types/packages/firestore-pipelines/pipelines.d.ts (JS SDK).
+ * RN Firebase built types: packages/firestore/dist/typescript/lib/pipelines/*.d.ts
+ *
+ * Each entry must have a `name` (the export name) and a `reason` explaining
+ * why the difference exists. Any difference NOT listed here will cause CI to
+ * fail so that new drift is caught and deliberately acknowledged.
+ *
+ * Sections:
+ *  nameMapping     — exports that exist in both but under different names
+ *  missingInRN     — JS SDK pipeline exports absent from RN Firebase
+ *  extraInRN       — RN Firebase pipeline exports not in the JS SDK
+ *  differentShape  — same export name but differing signatures/members
+ */
+
+import type { PackageConfig } from '../../src/types';
+
+
+const config: PackageConfig = {
+  nameMapping: {},
+  missingInRN: [],
+  extraInRN: [],
+  differentShape: [],
+};
+
+export default config;