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

package/lib/logs.d.ts

@@ -0,0 +1,21 @@
+import type { ResolvedBigqueryFirestoreExportConfig } from "./export-config";
+export declare function init(config: ResolvedBigqueryFirestoreExportConfig): void;
+export declare function start(): void;
+export declare function complete(): void;
+export declare function error(err: unknown): void;
+export declare function errorWritingToFirestore(err: unknown): void;
+export declare function bigqueryJobStarted(jobId: string | undefined): void;
+export declare function bigqueryResultsRowCount(transferConfigId: string, runId: string, count: number): void;
+export declare function bigqueryQueryFailed(transferConfigId: string, runId: string, tableName: string, err: unknown): void;
+export declare function runResultsWrittenToFirestore(runId: string, successCount: number, totalCount: number): void;
+export declare function latestDocUpdateSkipped(transferConfigId: string, runId: string, reason: string): void;
+export declare function handlingNonSuccessRun(transferConfigId: string, runId: string, state: string): void;
+export declare function createTransferConfig(): void;
+export declare function transferConfigCreated(name: string): void;
+export declare function updateTransferConfig(name: string): void;
+export declare function transferConfigUpdated(name: string): void;
+export declare function transferConfigNotFound(name: string): void;
+export declare function getTransferConfigFailed(name: string, err: unknown): void;
+export declare function partitioningFieldRemovalAttempted(name: string, existingField: string): void;
+export declare function topicCreated(name: string): void;
+//# sourceMappingURL=logs.d.ts.map

package/lib/logs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logs.d.ts","sourceRoot":"","sources":["../src/logs.ts"],"names":[],"mappings":"AAiBA,OAAO,KAAK,EAAE,qCAAqC,EAAE,MAAM,iBAAiB,CAAC;AAE7E,wBAAgB,IAAI,CAAC,MAAM,EAAE,qCAAqC,GAAG,IAAI,CAKxE;AAED,wBAAgB,KAAK,IAAI,IAAI,CAE5B;AAED,wBAAgB,QAAQ,IAAI,IAAI,CAE/B;AAED,wBAAgB,KAAK,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI,CAExC;AAED,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI,CAE1D;AAED,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,CAElE;AAED,wBAAgB,uBAAuB,CACrC,gBAAgB,EAAE,MAAM,EACxB,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,GACZ,IAAI,CAMN;AAED,wBAAgB,mBAAmB,CACjC,gBAAgB,EAAE,MAAM,EACxB,KAAK,EAAE,MAAM,EACb,SAAS,EAAE,MAAM,EACjB,GAAG,EAAE,OAAO,GACX,IAAI,CAON;AAED,wBAAgB,4BAA4B,CAC1C,KAAK,EAAE,MAAM,EACb,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,MAAM,GACjB,IAAI,CAMN;AAED,wBAAgB,sBAAsB,CACpC,gBAAgB,EAAE,MAAM,EACxB,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,GACb,IAAI,CAMN;AAED,wBAAgB,qBAAqB,CACnC,gBAAgB,EAAE,MAAM,EACxB,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,GACZ,IAAI,CAMN;AAED,wBAAgB,oBAAoB,IAAI,IAAI,CAE3C;AAED,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAExD;AAED,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAEvD;AAED,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAExD;AAED,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAEzD;AAED,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,GAAG,IAAI,CAExE;AAED,wBAAgB,iCAAiC,CAC/C,IAAI,EAAE,MAAM,EACZ,aAAa,EAAE,MAAM,GACpB,IAAI,CAKN;AAED,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAE/C"}

package/lib/logs.js

@@ -0,0 +1,122 @@
+"use strict";
+/*
+ * 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
+ *
+ *    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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.init = init;
+exports.start = start;
+exports.complete = complete;
+exports.error = error;
+exports.errorWritingToFirestore = errorWritingToFirestore;
+exports.bigqueryJobStarted = bigqueryJobStarted;
+exports.bigqueryResultsRowCount = bigqueryResultsRowCount;
+exports.bigqueryQueryFailed = bigqueryQueryFailed;
+exports.runResultsWrittenToFirestore = runResultsWrittenToFirestore;
+exports.latestDocUpdateSkipped = latestDocUpdateSkipped;
+exports.handlingNonSuccessRun = handlingNonSuccessRun;
+exports.createTransferConfig = createTransferConfig;
+exports.transferConfigCreated = transferConfigCreated;
+exports.updateTransferConfig = updateTransferConfig;
+exports.transferConfigUpdated = transferConfigUpdated;
+exports.transferConfigNotFound = transferConfigNotFound;
+exports.getTransferConfigFailed = getTransferConfigFailed;
+exports.partitioningFieldRemovalAttempted = partitioningFieldRemovalAttempted;
+exports.topicCreated = topicCreated;
+const firebase_functions_1 = require("firebase-functions");
+function init(config) {
+    firebase_functions_1.logger.info("Initializing BigQuery Firestore export", {
+        ...config,
+        queryString: "<omitted>",
+    });
+}
+function start() {
+    firebase_functions_1.logger.info("Started BigQuery Firestore export execution");
+}
+function complete() {
+    firebase_functions_1.logger.info("Completed BigQuery Firestore export execution");
+}
+function error(err) {
+    firebase_functions_1.logger.error("Unhandled error during BigQuery Firestore export", err);
+}
+function errorWritingToFirestore(err) {
+    firebase_functions_1.logger.error("Error writing a BigQuery row to Firestore", err);
+}
+function bigqueryJobStarted(jobId) {
+    firebase_functions_1.logger.info(`BigQuery job ${jobId ?? "<unknown>"} started`);
+}
+function bigqueryResultsRowCount(transferConfigId, runId, count) {
+    firebase_functions_1.logger.debug("Read BigQuery transfer results", {
+        transferConfigId,
+        runId,
+        count,
+    });
+}
+function bigqueryQueryFailed(transferConfigId, runId, tableName, err) {
+    firebase_functions_1.logger.error("BigQuery result query failed", {
+        transferConfigId,
+        runId,
+        tableName,
+        err,
+    });
+}
+function runResultsWrittenToFirestore(runId, successCount, totalCount) {
+    firebase_functions_1.logger.info("Finished writing BigQuery results to Firestore", {
+        runId,
+        successCount,
+        totalCount,
+    });
+}
+function latestDocUpdateSkipped(transferConfigId, runId, reason) {
+    firebase_functions_1.logger.debug("Skipped updating latest transfer-run document", {
+        transferConfigId,
+        runId,
+        reason,
+    });
+}
+function handlingNonSuccessRun(transferConfigId, runId, state) {
+    firebase_functions_1.logger.info("Recording non-successful BigQuery transfer run", {
+        transferConfigId,
+        runId,
+        state,
+    });
+}
+function createTransferConfig() {
+    firebase_functions_1.logger.info("Creating BigQuery Data Transfer config");
+}
+function transferConfigCreated(name) {
+    firebase_functions_1.logger.info("Created BigQuery Data Transfer config", { name });
+}
+function updateTransferConfig(name) {
+    firebase_functions_1.logger.info("Updating BigQuery Data Transfer config", { name });
+}
+function transferConfigUpdated(name) {
+    firebase_functions_1.logger.info("Updated BigQuery Data Transfer config", { name });
+}
+function transferConfigNotFound(name) {
+    firebase_functions_1.logger.error("BigQuery Data Transfer config not found", { name });
+}
+function getTransferConfigFailed(name, err) {
+    firebase_functions_1.logger.error("Failed to read BigQuery Data Transfer config", { name, err });
+}
+function partitioningFieldRemovalAttempted(name, existingField) {
+    firebase_functions_1.logger.warn("Cannot remove an existing DTS partitioning field", {
+        name,
+        existingField,
+    });
+}
+function topicCreated(name) {
+    firebase_functions_1.logger.info("Created Pub/Sub topic for transfer notifications", { name });
+}
+//# sourceMappingURL=logs.js.map

package/lib/logs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logs.js","sourceRoot":"","sources":["../src/logs.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;;;;;;;;;;;;;;;;;;;AAEH,2DAA4C;AAG5C,cAAqB,MAA6C;IAChE,2BAAM,CAAC,IAAI,CAAC,wCAAwC,EAAE;QACpD,GAAG,MAAM;QACT,WAAW,EAAE,WAAW;KACzB,CAAC,CAAC;AACL,CAAC;AAED;IACE,2BAAM,CAAC,IAAI,CAAC,6CAA6C,CAAC,CAAC;AAC7D,CAAC;AAED;IACE,2BAAM,CAAC,IAAI,CAAC,+CAA+C,CAAC,CAAC;AAC/D,CAAC;AAED,eAAsB,GAAY;IAChC,2BAAM,CAAC,KAAK,CAAC,kDAAkD,EAAE,GAAG,CAAC,CAAC;AACxE,CAAC;AAED,iCAAwC,GAAY;IAClD,2BAAM,CAAC,KAAK,CAAC,2CAA2C,EAAE,GAAG,CAAC,CAAC;AACjE,CAAC;AAED,4BAAmC,KAAyB;IAC1D,2BAAM,CAAC,IAAI,CAAC,gBAAgB,KAAK,IAAI,WAAW,UAAU,CAAC,CAAC;AAC9D,CAAC;AAED,iCACE,gBAAwB,EACxB,KAAa,EACb,KAAa;IAEb,2BAAM,CAAC,KAAK,CAAC,gCAAgC,EAAE;QAC7C,gBAAgB;QAChB,KAAK;QACL,KAAK;KACN,CAAC,CAAC;AACL,CAAC;AAED,6BACE,gBAAwB,EACxB,KAAa,EACb,SAAiB,EACjB,GAAY;IAEZ,2BAAM,CAAC,KAAK,CAAC,8BAA8B,EAAE;QAC3C,gBAAgB;QAChB,KAAK;QACL,SAAS;QACT,GAAG;KACJ,CAAC,CAAC;AACL,CAAC;AAED,sCACE,KAAa,EACb,YAAoB,EACpB,UAAkB;IAElB,2BAAM,CAAC,IAAI,CAAC,gDAAgD,EAAE;QAC5D,KAAK;QACL,YAAY;QACZ,UAAU;KACX,CAAC,CAAC;AACL,CAAC;AAED,gCACE,gBAAwB,EACxB,KAAa,EACb,MAAc;IAEd,2BAAM,CAAC,KAAK,CAAC,+CAA+C,EAAE;QAC5D,gBAAgB;QAChB,KAAK;QACL,MAAM;KACP,CAAC,CAAC;AACL,CAAC;AAED,+BACE,gBAAwB,EACxB,KAAa,EACb,KAAa;IAEb,2BAAM,CAAC,IAAI,CAAC,gDAAgD,EAAE;QAC5D,gBAAgB;QAChB,KAAK;QACL,KAAK;KACN,CAAC,CAAC;AACL,CAAC;AAED;IACE,2BAAM,CAAC,IAAI,CAAC,wCAAwC,CAAC,CAAC;AACxD,CAAC;AAED,+BAAsC,IAAY;IAChD,2BAAM,CAAC,IAAI,CAAC,uCAAuC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;AACjE,CAAC;AAED,8BAAqC,IAAY;IAC/C,2BAAM,CAAC,IAAI,CAAC,wCAAwC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;AAClE,CAAC;AAED,+BAAsC,IAAY;IAChD,2BAAM,CAAC,IAAI,CAAC,uCAAuC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;AACjE,CAAC;AAED,gCAAuC,IAAY;IACjD,2BAAM,CAAC,KAAK,CAAC,yCAAyC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;AACpE,CAAC;AAED,iCAAwC,IAAY,EAAE,GAAY;IAChE,2BAAM,CAAC,KAAK,CAAC,8CAA8C,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC;AAC9E,CAAC;AAED,2CACE,IAAY,EACZ,aAAqB;IAErB,2BAAM,CAAC,IAAI,CAAC,kDAAkD,EAAE;QAC9D,IAAI;QACJ,aAAa;KACd,CAAC,CAAC;AACL,CAAC;AAED,sBAA6B,IAAY;IACvC,2BAAM,CAAC,IAAI,CAAC,kDAAkD,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;AAC5E,CAAC"}

package/lib/metadata.d.ts

@@ -0,0 +1,6 @@
+export declare const metadata: {
+    readonly roles: readonly ["datastore.user", "bigquery.admin", "pubsub.admin", "eventarc.eventReceiver", "run.invoker"];
+    readonly apis: readonly ["bigquery.googleapis.com", "bigquerydatatransfer.googleapis.com", "pubsub.googleapis.com"];
+    readonly functionNames: readonly ["processMessages", "upsertTransferConfig"];
+};
+//# sourceMappingURL=metadata.d.ts.map

package/lib/metadata.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"metadata.d.ts","sourceRoot":"","sources":["../src/metadata.ts"],"names":[],"mappings":"AAgBA,eAAO,MAAM,QAAQ;aACnB,KAAK,YACH,gBAAgB,EAChB,gBAAgB,EAChB,cAAc,EACd,wBAAwB,EACxB,aAAa;aAEf,IAAI,YACF,yBAAyB,EACzB,qCAAqC,EACrC,uBAAuB;aAEzB,aAAa,YAAG,iBAAiB,EAAE,sBAAsB;CACjD,CAAC"}

package/lib/metadata.js

@@ -0,0 +1,34 @@
+"use strict";
+/*
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.metadata = void 0;
+exports.metadata = {
+    roles: [
+        "datastore.user",
+        "bigquery.admin",
+        "pubsub.admin",
+        "eventarc.eventReceiver",
+        "run.invoker",
+    ],
+    apis: [
+        "bigquery.googleapis.com",
+        "bigquerydatatransfer.googleapis.com",
+        "pubsub.googleapis.com",
+    ],
+    functionNames: ["processMessages", "upsertTransferConfig"],
+};
+//# sourceMappingURL=metadata.js.map

package/lib/metadata.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../src/metadata.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEU,QAAA,QAAQ,GAAG;IACtB,KAAK,EAAE;QACL,gBAAgB;QAChB,gBAAgB;QAChB,cAAc;QACd,wBAAwB;QACxB,aAAa;KACd;IACD,IAAI,EAAE;QACJ,yBAAyB;QACzB,qCAAqC;QACrC,uBAAuB;KACxB;IACD,aAAa,EAAE,CAAC,iBAAiB,EAAE,sBAAsB,CAAC;CAClD,CAAC"}

package/lib/types.d.ts

@@ -0,0 +1,44 @@
+import type { BigQueryDate, BigQueryDatetime, BigQueryTime, BigQueryTimestamp, Geography } from "@google-cloud/bigquery";
+import type { Timestamp } from "firebase-admin/firestore";
+/** Parameters attached to a BigQuery scheduled-query transfer run. */
+export interface TransferRunParams {
+    destination_table_name_template: string;
+    partitioning_field: string;
+    query: string;
+    write_disposition: string;
+}
+/** State of a BigQuery Data Transfer run. */
+export type TransferRunState = "SUCCEEDED" | "FAILED" | "CANCELLED" | "PENDING" | "RUNNING" | "TRANSFER_STATE_UNSPECIFIED";
+/** JSON payload from a BigQuery Data Transfer Pub/Sub notification. */
+export interface TransferRunPayload {
+    name: string;
+    runTime: string;
+    state: TransferRunState;
+    destinationDatasetId: string;
+    dataSourceId: string;
+    schedule: string;
+    scheduleTime: string;
+    startTime: string;
+    endTime: string;
+    updateTime: string;
+    userId: string;
+    notificationPubsubTopic: string;
+    params: TransferRunParams;
+    emailPreferences: Record<string, unknown>;
+    errorStatus: Record<string, unknown>;
+}
+/** Message-shaped wrapper retained for the core handler boundary. */
+export interface TransferRunMessage {
+    json: TransferRunPayload;
+}
+/** Values returned in a BigQuery row before conversion. */
+export type BigQueryRowValue = string | number | boolean | null | Date | Buffer | BigQueryTimestamp | BigQueryDate | BigQueryTime | BigQueryDatetime | Geography | BigQueryRow | BigQueryRowValue[];
+export interface BigQueryRow {
+    [key: string]: BigQueryRowValue;
+}
+/** Firestore-compatible equivalent of a BigQuery row value. */
+export type FirestoreRowValue = string | number | boolean | null | Timestamp | Uint8Array | FirestoreRow | FirestoreRowValue[];
+export interface FirestoreRow {
+    [key: string]: FirestoreRowValue;
+}
+//# sourceMappingURL=types.d.ts.map

package/lib/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EACV,YAAY,EACZ,gBAAgB,EAChB,YAAY,EACZ,iBAAiB,EACjB,SAAS,EACV,MAAM,wBAAwB,CAAC;AAChC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AAE1D,sEAAsE;AACtE,MAAM,WAAW,iBAAiB;IAChC,+BAA+B,EAAE,MAAM,CAAC;IACxC,kBAAkB,EAAE,MAAM,CAAC;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AAED,6CAA6C;AAC7C,MAAM,MAAM,gBAAgB,GACxB,WAAW,GACX,QAAQ,GACR,WAAW,GACX,SAAS,GACT,SAAS,GACT,4BAA4B,CAAC;AAEjC,uEAAuE;AACvE,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,gBAAgB,CAAC;IACxB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,uBAAuB,EAAE,MAAM,CAAC;IAChC,MAAM,EAAE,iBAAiB,CAAC;IAC1B,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC1C,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACtC;AAED,qEAAqE;AACrE,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,kBAAkB,CAAC;CAC1B;AAED,2DAA2D;AAC3D,MAAM,MAAM,gBAAgB,GACxB,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,MAAM,GACN,iBAAiB,GACjB,YAAY,GACZ,YAAY,GACZ,gBAAgB,GAChB,SAAS,GACT,WAAW,GACX,gBAAgB,EAAE,CAAC;AAEvB,MAAM,WAAW,WAAW;IAC1B,CAAC,GAAG,EAAE,MAAM,GAAG,gBAAgB,CAAC;CACjC;AAED,+DAA+D;AAC/D,MAAM,MAAM,iBAAiB,GACzB,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,GACJ,SAAS,GACT,UAAU,GACV,YAAY,GACZ,iBAAiB,EAAE,CAAC;AAExB,MAAM,WAAW,YAAY;IAC3B,CAAC,GAAG,EAAE,MAAM,GAAG,iBAAiB,CAAC;CAClC"}

package/lib/types.js

@@ -0,0 +1,18 @@
+"use strict";
+/*
+ * 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
+ *
+ *    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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/lib/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG"}

package/package.json

@@ -1,12 +1,48 @@
 {
   "name": "@firebase-function-kits/bigquery-firestore-export",
-  "version": "0.0.1",
+  "version": "0.0.2-rc.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/firebase/extensions.git",
+    "directory": "kits/bigquery-firestore-export"
+  },
+  "private": false,
   "description": "Reverse-sync rows from BigQuery into Firestore",
   "license": "Apache-2.0",
-  "main": "index.js",
-  "private": false,
-  "repository": "firebase/extensions",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "default": "./lib/index.js"
+    },
+    "./lib": {
+      "types": "./lib/lib.d.ts",
+      "default": "./lib/lib.js"
+    }
+  },
   "engines": {
     "node": ">=22"
+  },
+  "scripts": {
+    "build": "tsc -b",
+    "clean": "tsc -b --clean",
+    "test": "vitest run",
+    "deploy": "pnpm build && firebase deploy --only functions",
+    "serve": "firebase emulators:start --only functions"
+  },
+  "dependencies": {
+    "@firebase/app": "^0.16.0",
+    "@google-cloud/bigquery": "^8.3.1",
+    "@google-cloud/bigquery-data-transfer": "^5.0.1",
+    "@google-cloud/pubsub": "^4.11.0",
+    "firebase-admin": "^14.1.0",
+    "firebase-functions": "7.3.2"
+  },
+  "devDependencies": {
+    "vitest": "^4.1.10"
+  },
+  "overrides": {
+    "uuid@9.0.1": "11.1.1"
   }
 }

package/src/config.ts

@@ -0,0 +1,88 @@
+/*
+ * 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 {
+  defineString,
+  expr,
+  projectID,
+  select,
+} from "firebase-functions/params";
+import type {
+  BigqueryFirestoreExportConfig,
+  DeployTimeOptions,
+  LogLevel,
+} from "./export-config";
+
+const LOG_LEVEL_OPTIONS = ["debug", "info", "warn", "error", "silent"] as const;
+const instanceId = defineString("INSTANCE_ID");
+
+const params = {
+  instanceId,
+  bigqueryDatasetLocation: defineString("BIGQUERY_DATASET_LOCATION", {
+    default: "US",
+  }),
+  transferConfigName: defineString("TRANSFER_CONFIG_NAME", { default: "" }),
+  datasetId: defineString("DATASET_ID"),
+  tableName: defineString("TABLE_NAME"),
+  queryString: defineString("QUERY_STRING"),
+  displayName: defineString("DISPLAY_NAME"),
+  partitioningField: defineString("PARTITIONING_FIELD", { default: "" }),
+  schedule: defineString("SCHEDULE"),
+  firestoreCollection: defineString("COLLECTION_PATH", {
+    default: "transferConfigs",
+  }),
+  logLevel: defineString("LOG_LEVEL", {
+    default: "info",
+    input: select([...LOG_LEVEL_OPTIONS]),
+  }),
+};
+
+export const CONFIG_EXPRESSIONS: DeployTimeOptions = {
+  pubSubTopic: expr`kit-${instanceId}-processMessages`,
+};
+
+function optional(value: string): string | undefined {
+  const normalized = value.trim();
+  return normalized.length > 0 ? normalized : undefined;
+}
+
+function normalizeLogLevel(value: string): LogLevel {
+  const normalized = value.toLowerCase();
+  return LOG_LEVEL_OPTIONS.includes(normalized as LogLevel)
+    ? (normalized as LogLevel)
+    : "info";
+}
+
+/** Reads runtime values from Firebase deploy-time parameters. */
+export function configFromEnv(): BigqueryFirestoreExportConfig {
+  const resolvedInstanceId = params.instanceId.value();
+
+  return {
+    bigqueryDatasetLocation: params.bigqueryDatasetLocation.value(),
+    projectId: projectID.value(),
+    instanceId: resolvedInstanceId,
+    transferConfigName: optional(params.transferConfigName.value()),
+    datasetId: params.datasetId.value(),
+    tableName: params.tableName.value(),
+    queryString: params.queryString.value(),
+    displayName: params.displayName.value(),
+    partitioningField: optional(params.partitioningField.value()),
+    schedule: params.schedule.value(),
+    pubSubTopic: `kit-${resolvedInstanceId}-processMessages`,
+    firestoreCollection: params.firestoreCollection.value(),
+    logLevel: normalizeLogLevel(params.logLevel.value()),
+  };
+}

package/src/dts.ts

@@ -0,0 +1,214 @@
+/*
+ * 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
+ *
+ *    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 * as bigqueryDataTransfer from "@google-cloud/bigquery-data-transfer";
+import type { ResolvedBigqueryFirestoreExportConfig } from "./export-config";
+import * as logs from "./logs";
+
+export type DataTransferClient =
+  bigqueryDataTransfer.v1.DataTransferServiceClient;
+export type TransferConfig =
+  bigqueryDataTransfer.protos.google.cloud.bigquery.datatransfer.v1.ITransferConfig;
+
+const GRPC_NOT_FOUND = 5;
+const PACKAGE_PARTITIONING_ERROR =
+  "Cannot remove partitioning_field from an existing transfer config";
+
+export const PARTITIONING_FIELD_REMOVAL_ERROR_PREFIX =
+  PACKAGE_PARTITIONING_ERROR;
+export const PARTITIONING_FIELD_REMOVAL_ERROR = `${PACKAGE_PARTITIONING_ERROR}. The BigQuery Data Transfer API does not support clearing this parameter once it has been set. To change partitioning, create a new transfer config with the desired setting.`;
+
+function isNotFoundError(err: unknown): boolean {
+  return (
+    typeof err === "object" &&
+    err !== null &&
+    "code" in err &&
+    err.code === GRPC_NOT_FOUND
+  );
+}
+
+function transferConfigFields(config: TransferConfig) {
+  const fields = config.params?.fields;
+  if (!fields) {
+    throw new Error(
+      "Transfer config has invalid structure: missing params.fields"
+    );
+  }
+  if (!fields.query) {
+    throw new Error(
+      "Transfer config has invalid structure: missing params.fields.query"
+    );
+  }
+  if (!fields.destination_table_name_template) {
+    throw new Error(
+      "Transfer config has invalid structure: missing params.fields.destination_table_name_template"
+    );
+  }
+
+  return fields;
+}
+
+function stringField(value: string | undefined): { stringValue: string } {
+  return { stringValue: value ?? "" };
+}
+
+/** Creates the protobuf-shaped request used for a scheduled query. */
+export function createTransferConfigRequest(
+  config: ResolvedBigqueryFirestoreExportConfig,
+  serviceAccountEmail?: string
+): bigqueryDataTransfer.protos.google.cloud.bigquery.datatransfer.v1.ICreateTransferConfigRequest {
+  return {
+    parent: `projects/${config.projectId}`,
+    transferConfig: {
+      destinationDatasetId: config.datasetId,
+      displayName: config.displayName,
+      dataSourceId: "scheduled_query",
+      params: {
+        fields: {
+          query: stringField(config.queryString),
+          destination_table_name_template: stringField(
+            `${config.tableName}_{run_time|"%H%M%S"}`
+          ),
+          write_disposition: stringField("WRITE_TRUNCATE"),
+          partitioning_field: stringField(config.partitioningField),
+        },
+      },
+      schedule: config.schedule,
+      notificationPubsubTopic: `projects/${config.projectId}/topics/${config.pubSubTopic}`,
+      ...(serviceAccountEmail
+        ? { serviceAccountName: serviceAccountEmail }
+        : {}),
+    },
+  };
+}
+
+export async function getTransferConfig(
+  client: DataTransferClient,
+  transferConfigName: string
+): Promise<TransferConfig | null> {
+  try {
+    const [config] = await client.getTransferConfig({
+      name: transferConfigName,
+    });
+    return config;
+  } catch (err) {
+    if (isNotFoundError(err)) {
+      logs.transferConfigNotFound(transferConfigName);
+      return null;
+    }
+    logs.getTransferConfigFailed(transferConfigName, err);
+    throw err;
+  }
+}
+
+export async function createTransferConfig(
+  client: DataTransferClient,
+  config: ResolvedBigqueryFirestoreExportConfig
+): Promise<TransferConfig> {
+  logs.createTransferConfig();
+  const [created] = await client.createTransferConfig(
+    createTransferConfigRequest(config, config.serviceAccount)
+  );
+  if (!created.name) {
+    throw new Error("BigQuery API returned a transfer config without a name");
+  }
+  logs.transferConfigCreated(created.name);
+  return created;
+}
+
+/** Builds a minimal update mask while retaining unsupported immutable fields. */
+export async function constructUpdateTransferConfigRequest(
+  client: DataTransferClient,
+  transferConfigName: string,
+  config: ResolvedBigqueryFirestoreExportConfig
+): Promise<bigqueryDataTransfer.protos.google.cloud.bigquery.datatransfer.v1.IUpdateTransferConfigRequest> {
+  const transferConfig = await getTransferConfig(client, transferConfigName);
+  if (!transferConfig) throw new Error("Transfer config not found");
+
+  const fields = transferConfigFields(transferConfig);
+  const updatedConfig = JSON.parse(
+    JSON.stringify(transferConfig)
+  ) as TransferConfig;
+  const updatedFields = transferConfigFields(updatedConfig);
+  const updateMask: string[] = [];
+
+  if (config.datasetId !== transferConfig.destinationDatasetId) {
+    updateMask.push("destination_dataset_id");
+    updatedConfig.destinationDatasetId = config.datasetId;
+  }
+  if (config.queryString !== fields.query.stringValue) {
+    updateMask.push("params");
+    updatedFields.query.stringValue = config.queryString;
+  }
+
+  const tableTemplate = `${config.tableName}_{run_time|"%H%M%S"}`;
+  if (tableTemplate !== fields.destination_table_name_template.stringValue) {
+    updateMask.push("params");
+    updatedFields.destination_table_name_template.stringValue = tableTemplate;
+  }
+
+  const existingPartitioningField =
+    fields.partitioning_field?.stringValue ?? "";
+  const newPartitioningField = config.partitioningField ?? "";
+  if (newPartitioningField !== existingPartitioningField) {
+    if (!newPartitioningField) {
+      logs.partitioningFieldRemovalAttempted(
+        transferConfigName,
+        existingPartitioningField
+      );
+      throw new Error(PARTITIONING_FIELD_REMOVAL_ERROR);
+    }
+    updateMask.push("params");
+    updatedFields.partitioning_field ??= {};
+    updatedFields.partitioning_field.stringValue = newPartitioningField;
+  }
+
+  if (config.schedule !== transferConfig.schedule) {
+    updateMask.push("schedule");
+    updatedConfig.schedule = config.schedule;
+  }
+
+  const expectedTopic = `projects/${config.projectId}/topics/${config.pubSubTopic}`;
+  if (expectedTopic !== transferConfig.notificationPubsubTopic) {
+    updateMask.push("notification_pubsub_topic");
+    updatedConfig.notificationPubsubTopic = expectedTopic;
+  }
+
+  return {
+    transferConfig: updatedConfig,
+    updateMask: { paths: [...new Set(updateMask)] },
+  };
+}
+
+export async function updateTransferConfig(
+  client: DataTransferClient,
+  transferConfigName: string,
+  config: ResolvedBigqueryFirestoreExportConfig
+): Promise<TransferConfig> {
+  const request = await constructUpdateTransferConfigRequest(
+    client,
+    transferConfigName,
+    config
+  );
+  logs.updateTransferConfig(transferConfigName);
+  const converted =
+    bigqueryDataTransfer.protos.google.cloud.bigquery.datatransfer.v1.UpdateTransferConfigRequest.fromObject(
+      request
+    );
+  const [updated] = await client.updateTransferConfig(converted);
+  logs.transferConfigUpdated(transferConfigName);
+  return updated;
+}