@firebase-function-kits/firestore-bigquery-export 0.0.1 → 0.0.2-rc.1

package/tests/util.test.ts

@@ -0,0 +1,102 @@
+/**
+ * Copyright 2026 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
+ *
+ *    https://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 { ChangeType } from "@firebaseextensions/firestore-bigquery-change-tracker";
+import type { Change, DocumentSnapshot } from "firebase-functions/firestore";
+import { describe, expect, test } from "vitest";
+import { getChangeType, getDocumentId, resolveWildcardIds } from "../src/util";
+
+/** Builds a fake Firestore snapshot with just the fields the utils read. */
+function snap(
+  exists: boolean,
+  id: string,
+  data: unknown = {}
+): DocumentSnapshot {
+  return { exists, id, data: () => data } as unknown as DocumentSnapshot;
+}
+
+/** Builds a fake Change<DocumentSnapshot> from before/after snapshots. */
+function change(
+  before: DocumentSnapshot,
+  after: DocumentSnapshot
+): Change<DocumentSnapshot> {
+  return { before, after } as Change<DocumentSnapshot>;
+}
+
+describe("getChangeType", () => {
+  test("before missing => CREATE", () => {
+    const c = change(snap(false, "doc1"), snap(true, "doc1", { foo: "bar" }));
+    expect(getChangeType(c)).toBe(ChangeType.CREATE);
+  });
+
+  test("after missing => DELETE", () => {
+    const c = change(snap(true, "doc1", { foo: "bar" }), snap(false, "doc1"));
+    expect(getChangeType(c)).toBe(ChangeType.DELETE);
+  });
+
+  test("both present => UPDATE", () => {
+    const c = change(
+      snap(true, "doc1", { foo: "a" }),
+      snap(true, "doc1", { foo: "b" })
+    );
+    expect(getChangeType(c)).toBe(ChangeType.UPDATE);
+  });
+});
+
+describe("getDocumentId", () => {
+  test("prefers after.id when after exists", () => {
+    const c = change(snap(true, "before-id"), snap(true, "after-id"));
+    expect(getDocumentId(c)).toBe("after-id");
+  });
+
+  test("falls back to before.id on delete", () => {
+    const c = change(snap(true, "before-id"), snap(false, "after-id"));
+    expect(getDocumentId(c)).toBe("before-id");
+  });
+});
+
+describe("resolveWildcardIds", () => {
+  test("extracts a single wildcard", () => {
+    expect(
+      resolveWildcardIds(
+        "regions/{regionId}/countries",
+        "regions/asia/countries"
+      )
+    ).toEqual({ regionId: "asia" });
+  });
+
+  test("extracts multiple wildcards", () => {
+    expect(
+      resolveWildcardIds(
+        "regions/{regionId}/users/{userId}",
+        "regions/asia/users/u42"
+      )
+    ).toEqual({ regionId: "asia", userId: "u42" });
+  });
+
+  test("returns empty object when no wildcards", () => {
+    expect(
+      resolveWildcardIds("regions/asia/countries", "regions/asia/countries")
+    ).toEqual({});
+  });
+
+  test("maps wildcards positionally by segment", () => {
+    expect(resolveWildcardIds("a/{x}/b/{y}", "a/1/b/2")).toEqual({
+      x: "1",
+      y: "2",
+    });
+  });
+});

package/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "outDir": "lib",
+    "rootDir": "src",
+    "target": "ES2022",
+    "module": "nodenext",
+    "moduleResolution": "nodenext",
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "strict": false,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "types": ["node"]
+  },
+  "include": ["src"],
+  "exclude": ["node_modules", "lib", "**/*.test.ts"]
+}

package/tsconfig.tsbuildinfo

@@ -0,0 +1 @@
+{"version":"7.0.2","root":["./src/config.ts","./src/events.ts","./src/export-config.ts","./src/handlers.ts","./src/index.ts","./src/init.ts","./src/lib.ts","./src/logs.ts","./src/util.ts"],"packageJsons":["./node_modules/@firebase/app-types/package.json","./node_modules/@firebase/component/package.json","./node_modules/@firebase/database-types/package.json","./node_modules/@firebase/logger/package.json","./node_modules/@firebase/util/package.json","./node_modules/@firebaseextensions/firestore-bigquery-change-tracker/package.json","./node_modules/@google-cloud/bigquery/package.json","./node_modules/@google-cloud/common/package.json","./node_modules/@google-cloud/firestore/node_modules/@grpc/proto-loader/package.json","./node_modules/@google-cloud/firestore/node_modules/gaxios/build/esm/package.json","./node_modules/@google-cloud/firestore/node_modules/gaxios/package.json","./node_modules/@google-cloud/firestore/node_modules/gcp-metadata/package.json","./node_modules/@google-cloud/firestore/node_modules/google-auth-library/package.json","./node_modules/@google-cloud/firestore/node_modules/google-gax/package.json","./node_modules/@google-cloud/firestore/node_modules/google-logging-utils/package.json","./node_modules/@google-cloud/firestore/node_modules/gtoken/package.json","./node_modules/@google-cloud/firestore/node_modules/proto3-json-serializer/package.json","./node_modules/@google-cloud/firestore/package.json","./node_modules/@google-cloud/paginator/package.json","./node_modules/@google-cloud/precise-date/package.json","./node_modules/@grpc/grpc-js/node_modules/@grpc/proto-loader/package.json","./node_modules/@grpc/grpc-js/package.json","./node_modules/@js-sdsl/ordered-map/package.json","./node_modules/@types/body-parser/package.json","./node_modules/@types/connect/package.json","./node_modules/@types/cors/package.json","./node_modules/@types/express-serve-static-core/package.json","./node_modules/@types/express/package.json","./node_modules/@types/http-errors/package.json","./node_modules/@types/node/package.json","./node_modules/@types/qs/package.json","./node_modules/@types/range-parser/package.json","./node_modules/@types/send/package.json","./node_modules/@types/serve-static/package.json","./node_modules/body-parser/package.json","./node_modules/cors/package.json","./node_modules/express/package.json","./node_modules/firebase-admin/package.json","./node_modules/firebase-functions/package.json","./node_modules/gaxios/package.json","./node_modules/gcp-metadata/package.json","./node_modules/google-auth-library/package.json","./node_modules/gtoken/package.json","./node_modules/http-errors/package.json","./node_modules/long/package.json","./node_modules/long/umd/package.json","./node_modules/protobufjs/package.json","./node_modules/qs/package.json","./node_modules/range-parser/package.json","./node_modules/send/package.json","./node_modules/serve-static/package.json","./node_modules/string_decoder/package.json","./node_modules/teeny-request/package.json","./node_modules/undici-types/package.json","./package.json"],"missingPackageJsons":["./node_modules/@apollo/server/package.json","./node_modules/@as-integrations/express4/package.json","./node_modules/@firebase/logger/dist/package.json","./node_modules/@firebase/logger/dist/src/package.json","./node_modules/@firebase/util/dist/package.json","./node_modules/@firebaseextensions/firestore-bigquery-change-tracker/lib/bigquery/package.json","./node_modules/@firebaseextensions/firestore-bigquery-change-tracker/lib/bigquery/partitioning/package.json","./node_modules/@firebaseextensions/firestore-bigquery-change-tracker/lib/package.json","./node_modules/@firebaseextensions/firestore-bigquery-change-tracker/node_modules/@google-cloud/bigquery/package.json","./node_modules/@firebaseextensions/firestore-bigquery-change-tracker/node_modules/@types/google-cloud__bigquery/package.json","./node_modules/@google-cloud/bigquery/build/package.json","./node_modules/@google-cloud/bigquery/build/src/package.json","./node_modules/@google-cloud/common/build/package.json","./node_modules/@google-cloud/common/build/src/package.json","./node_modules/@google-cloud/common/build/src/util/package.json","./node_modules/@google-cloud/firestore/node_modules/@grpc/grpc-js/build/src/client/package.json","./node_modules/@google-cloud/firestore/node_modules/@grpc/grpc-js/package.json","./node_modules/@google-cloud/firestore/node_modules/@grpc/proto-loader/build/package.json","./node_modules/@google-cloud/firestore/node_modules/@grpc/proto-loader/build/src/package.json","./node_modules/@google-cloud/firestore/node_modules/events/package.json","./node_modules/@google-cloud/firestore/node_modules/gaxios/build/cjs/package.json","./node_modules/@google-cloud/firestore/node_modules/gaxios/build/cjs/src/package.json","./node_modules/@google-cloud/firestore/node_modules/gaxios/build/esm/src/package.json","./node_modules/@google-cloud/firestore/node_modules/gaxios/build/package.json","./node_modules/@google-cloud/firestore/node_modules/gcp-metadata/build/package.json","./node_modules/@google-cloud/firestore/node_modules/gcp-metadata/build/src/package.json","./node_modules/@google-cloud/firestore/node_modules/google-auth-library/build/package.json","./node_modules/@google-cloud/firestore/node_modules/google-auth-library/build/src/auth/googleauth/package.json","./node_modules/@google-cloud/firestore/node_modules/google-auth-library/build/src/auth/package.json","./node_modules/@google-cloud/firestore/node_modules/google-auth-library/build/src/crypto/package.json","./node_modules/@google-cloud/firestore/node_modules/google-auth-library/build/src/package.json","./node_modules/@google-cloud/firestore/node_modules/google-gax/build/package.json","./node_modules/@google-cloud/firestore/node_modules/google-gax/build/protos/package.json","./node_modules/@google-cloud/firestore/node_modules/google-gax/build/src/bundlingCalls/package.json","./node_modules/@google-cloud/firestore/node_modules/google-gax/build/src/longRunningCalls/package.json","./node_modules/@google-cloud/firestore/node_modules/google-gax/build/src/normalCalls/package.json","./node_modules/@google-cloud/firestore/node_modules/google-gax/build/src/package.json","./node_modules/@google-cloud/firestore/node_modules/google-gax/build/src/paginationCalls/package.json","./node_modules/@google-cloud/firestore/node_modules/google-gax/build/src/streamingCalls/package.json","./node_modules/@google-cloud/firestore/node_modules/google-logging-utils/build/package.json","./node_modules/@google-cloud/firestore/node_modules/google-logging-utils/build/src/package.json","./node_modules/@google-cloud/firestore/node_modules/gtoken/build/cjs/package.json","./node_modules/@google-cloud/firestore/node_modules/gtoken/build/cjs/src/package.json","./node_modules/@google-cloud/firestore/node_modules/gtoken/build/package.json","./node_modules/@google-cloud/firestore/node_modules/http/package.json","./node_modules/@google-cloud/firestore/node_modules/long/package.json","./node_modules/@google-cloud/firestore/node_modules/proto3-json-serializer/build/package.json","./node_modules/@google-cloud/firestore/node_modules/proto3-json-serializer/build/src/package.json","./node_modules/@google-cloud/firestore/node_modules/protobufjs/ext/descriptor/package.json","./node_modules/@google-cloud/firestore/node_modules/protobufjs/minimal/package.json","./node_modules/@google-cloud/firestore/node_modules/protobufjs/package.json","./node_modules/@google-cloud/firestore/node_modules/querystring/package.json","./node_modules/@google-cloud/firestore/node_modules/stream/package.json","./node_modules/@google-cloud/firestore/node_modules/undici-types/package.json","./node_modules/@google-cloud/firestore/types/package.json","./node_modules/@google-cloud/firestore/types/protos/package.json","./node_modules/@google-cloud/firestore/types/v1/package.json","./node_modules/@google-cloud/firestore/types/v1beta1/package.json","./node_modules/@google-cloud/paginator/build/package.json","./node_modules/@google-cloud/paginator/build/src/package.json","./node_modules/@google-cloud/precise-date/build/package.json","./node_modules/@google-cloud/precise-date/build/src/package.json","./node_modules/@grpc/grpc-js/build/package.json","./node_modules/@grpc/grpc-js/build/src/client/package.json","./node_modules/@grpc/grpc-js/build/src/generated/google/package.json","./node_modules/@grpc/grpc-js/build/src/generated/google/protobuf/package.json","./node_modules/@grpc/grpc-js/build/src/generated/grpc/channelz/package.json","./node_modules/@grpc/grpc-js/build/src/generated/grpc/channelz/v1/package.json","./node_modules/@grpc/grpc-js/build/src/generated/grpc/package.json","./node_modules/@grpc/grpc-js/build/src/generated/package.json","./node_modules/@grpc/grpc-js/build/src/generated/xds/data/orca/package.json","./node_modules/@grpc/grpc-js/build/src/generated/xds/data/orca/v3/package.json","./node_modules/@grpc/grpc-js/build/src/generated/xds/data/package.json","./node_modules/@grpc/grpc-js/build/src/generated/xds/package.json","./node_modules/@grpc/grpc-js/build/src/generated/xds/service/orca/package.json","./node_modules/@grpc/grpc-js/build/src/generated/xds/service/orca/v3/package.json","./node_modules/@grpc/grpc-js/build/src/generated/xds/service/package.json","./node_modules/@grpc/grpc-js/build/src/package.json","./node_modules/@grpc/grpc-js/node_modules/@grpc/proto-loader/build/package.json","./node_modules/@grpc/grpc-js/node_modules/@grpc/proto-loader/build/src/package.json","./node_modules/@grpc/grpc-js/node_modules/@js-sdsl/ordered-map/package.json","./node_modules/@grpc/grpc-js/node_modules/events/package.json","./node_modules/@grpc/grpc-js/node_modules/http2/package.json","./node_modules/@grpc/grpc-js/node_modules/long/package.json","./node_modules/@grpc/grpc-js/node_modules/net/package.json","./node_modules/@grpc/grpc-js/node_modules/protobufjs/ext/descriptor/package.json","./node_modules/@grpc/grpc-js/node_modules/protobufjs/package.json","./node_modules/@grpc/grpc-js/node_modules/stream/package.json","./node_modules/@grpc/grpc-js/node_modules/tls/package.json","./node_modules/@js-sdsl/ordered-map/dist/esm/package.json","./node_modules/@js-sdsl/ordered-map/dist/package.json","./node_modules/@types/assert/package.json","./node_modules/@types/assert/strict/package.json","./node_modules/@types/async_hooks/package.json","./node_modules/@types/buffer/package.json","./node_modules/@types/child_process/package.json","./node_modules/@types/cluster/package.json","./node_modules/@types/console/package.json","./node_modules/@types/constants/package.json","./node_modules/@types/crypto/package.json","./node_modules/@types/dgram/package.json","./node_modules/@types/diagnostics_channel/package.json","./node_modules/@types/dns/package.json","./node_modules/@types/dns/promises/package.json","./node_modules/@types/domain/package.json","./node_modules/@types/events/package.json","./node_modules/@types/fs/package.json","./node_modules/@types/fs/promises/package.json","./node_modules/@types/http/package.json","./node_modules/@types/http2/package.json","./node_modules/@types/https/package.json","./node_modules/@types/inspector/package.json","./node_modules/@types/inspector/promises/package.json","./node_modules/@types/module/package.json","./node_modules/@types/net/package.json","./node_modules/@types/node/assert/package.json","./node_modules/@types/node/dns/package.json","./node_modules/@types/node/fs/package.json","./node_modules/@types/node/inspector/package.json","./node_modules/@types/node/path/package.json","./node_modules/@types/node/readline/package.json","./node_modules/@types/node/stream/package.json","./node_modules/@types/node/test/package.json","./node_modules/@types/node/timers/package.json","./node_modules/@types/node/util/package.json","./node_modules/@types/node/web-globals/package.json","./node_modules/@types/node/zlib/package.json","./node_modules/@types/os/package.json","./node_modules/@types/path/package.json","./node_modules/@types/path/posix/package.json","./node_modules/@types/path/win32/package.json","./node_modules/@types/perf_hooks/package.json","./node_modules/@types/process/package.json","./node_modules/@types/punycode/package.json","./node_modules/@types/querystring/package.json","./node_modules/@types/readline/package.json","./node_modules/@types/readline/promises/package.json","./node_modules/@types/repl/package.json","./node_modules/@types/stream/consumers/package.json","./node_modules/@types/stream/iter/package.json","./node_modules/@types/stream/package.json","./node_modules/@types/stream/promises/package.json","./node_modules/@types/stream/web/package.json","./node_modules/@types/string_decoder/package.json","./node_modules/@types/timers/package.json","./node_modules/@types/timers/promises/package.json","./node_modules/@types/tls/package.json","./node_modules/@types/trace_events/package.json","./node_modules/@types/tty/package.json","./node_modules/@types/url/package.json","./node_modules/@types/util/package.json","./node_modules/@types/util/types/package.json","./node_modules/@types/v8/package.json","./node_modules/@types/vm/package.json","./node_modules/@types/wasi/package.json","./node_modules/@types/worker_threads/package.json","./node_modules/@types/zlib/package.json","./node_modules/assert/package.json","./node_modules/assert/strict/package.json","./node_modules/async_hooks/package.json","./node_modules/buffer/package.json","./node_modules/child_process/package.json","./node_modules/cluster/package.json","./node_modules/connect/package.json","./node_modules/console/package.json","./node_modules/constants/package.json","./node_modules/crypto/package.json","./node_modules/dgram/package.json","./node_modules/diagnostics_channel/package.json","./node_modules/dns/package.json","./node_modules/dns/promises/package.json","./node_modules/domain/package.json","./node_modules/events/package.json","./node_modules/express-serve-static-core/package.json","./node_modules/firebase-admin/app-check/package.json","./node_modules/firebase-admin/app/package.json","./node_modules/firebase-admin/auth/package.json","./node_modules/firebase-admin/database/package.json","./node_modules/firebase-admin/eventarc/package.json","./node_modules/firebase-admin/firestore/package.json","./node_modules/firebase-admin/lib/app-check/package.json","./node_modules/firebase-admin/lib/app/package.json","./node_modules/firebase-admin/lib/auth/package.json","./node_modules/firebase-admin/lib/database/package.json","./node_modules/firebase-admin/lib/eventarc/package.json","./node_modules/firebase-admin/lib/firestore/package.json","./node_modules/firebase-admin/lib/package.json","./node_modules/firebase-admin/lib/utils/package.json","./node_modules/firebase-admin/node_modules/@firebase/database-types/package.json","./node_modules/firebase-admin/node_modules/@google-cloud/firestore/package.json","./node_modules/firebase-admin/node_modules/http/package.json","./node_modules/firebase-functions/firestore/package.json","./node_modules/firebase-functions/lib/common/package.json","./node_modules/firebase-functions/lib/common/providers/package.json","./node_modules/firebase-functions/lib/lifecycle/package.json","./node_modules/firebase-functions/lib/logger/package.json","./node_modules/firebase-functions/lib/package.json","./node_modules/firebase-functions/lib/params/package.json","./node_modules/firebase-functions/lib/runtime/package.json","./node_modules/firebase-functions/lib/v1/package.json","./node_modules/firebase-functions/lib/v1/providers/package.json","./node_modules/firebase-functions/lib/v2/package.json","./node_modules/firebase-functions/lib/v2/providers/alerts/package.json","./node_modules/firebase-functions/lib/v2/providers/dataconnect/package.json","./node_modules/firebase-functions/lib/v2/providers/package.json","./node_modules/firebase-functions/params/package.json","./node_modules/firebase-functions/tasks/package.json","./node_modules/firebase-functions/v2/lifecycle/package.json","./node_modules/firebase-functions/v2/package.json","./node_modules/fs/package.json","./node_modules/fs/promises/package.json","./node_modules/gaxios/build/package.json","./node_modules/gaxios/build/src/package.json","./node_modules/gcp-metadata/build/package.json","./node_modules/gcp-metadata/build/src/package.json","./node_modules/google-auth-library/build/package.json","./node_modules/google-auth-library/build/src/auth/package.json","./node_modules/google-auth-library/build/src/crypto/package.json","./node_modules/google-auth-library/build/src/package.json","./node_modules/graphql/package.json","./node_modules/gtoken/build/package.json","./node_modules/gtoken/build/src/package.json","./node_modules/http/package.json","./node_modules/http2/package.json","./node_modules/https/package.json","./node_modules/inspector/package.json","./node_modules/inspector/promises/package.json","./node_modules/module/package.json","./node_modules/net/package.json","./node_modules/os/package.json","./node_modules/path/package.json","./node_modules/path/posix/package.json","./node_modules/path/win32/package.json","./node_modules/perf_hooks/package.json","./node_modules/process/package.json","./node_modules/protobufjs/ext/descriptor/package.json","./node_modules/protobufjs/ext/package.json","./node_modules/protobufjs/minimal/package.json","./node_modules/punycode/package.json","./node_modules/querystring/package.json","./node_modules/readline/package.json","./node_modules/readline/promises/package.json","./node_modules/repl/package.json","./node_modules/stream/consumers/package.json","./node_modules/stream/iter/package.json","./node_modules/stream/package.json","./node_modules/stream/promises/package.json","./node_modules/stream/web/package.json","./node_modules/teeny-request/build/package.json","./node_modules/teeny-request/build/src/package.json","./node_modules/teeny-request/node_modules/http/package.json","./node_modules/teeny-request/node_modules/https/package.json","./node_modules/teeny-request/node_modules/stream/package.json","./node_modules/timers/package.json","./node_modules/timers/promises/package.json","./node_modules/tls/package.json","./node_modules/trace_events/package.json","./node_modules/tty/package.json","./node_modules/url/package.json","./node_modules/util/package.json","./node_modules/util/types/package.json","./node_modules/v8/package.json","./node_modules/vm/package.json","./node_modules/wasi/package.json","./node_modules/worker_threads/package.json","./node_modules/zlib/package.json"]}