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

package/CHANGELOG.md

@@ -0,0 +1 @@
+- Initial release of kit, see README for differences between the legacy extension and this kit

package/README.md

@@ -0,0 +1,308 @@
+# @firebase/bigquery-firestore-export
+
+Schedule a BigQuery query and write each run's rows and metadata to Firestore.
+This is the Export BigQuery to Firestore Firebase Extension as an npm package
+you add to your own Firebase Functions codebase and deploy.
+
+The kit creates or reconciles a BigQuery Data Transfer scheduled query, listens
+for its Pub/Sub completion notifications, reads the destination table, and
+writes the rows to Firestore. The functions run in your own Firebase project;
+there is no hosted version, so you deploy them yourself.
+
+## Install
+
+```sh
+npm install @firebase/bigquery-firestore-export
+```
+
+## Required IAM
+
+Deploy needs these Google Cloud roles and APIs for the function's service
+account. Firebase CLI 15.23.0 or later creates that account, grants the roles
+below, enables the listed APIs, and attaches the account to every function in
+this kit. Do not set a custom runtime service account for this codebase—it
+conflicts with that automatic setup.
+
+| Role / API                            | Why                                                                 |
+| ------------------------------------- | ------------------------------------------------------------------- |
+| `roles/datastore.user`                | store transfer configs, run metadata, and query output in Firestore |
+| `roles/bigquery.admin`                | create scheduled queries and read their destination tables          |
+| `roles/pubsub.admin`                  | create the transfer-notification topic                              |
+| `roles/eventarc.eventReceiver`        | receive Gen2 Pub/Sub trigger events                                 |
+| `roles/run.invoker`                   | allow Eventarc/Tasks to invoke the Gen2 Cloud Run services          |
+| `bigquery.googleapis.com`             | run queries and read destination tables                             |
+| `bigquerydatatransfer.googleapis.com` | create and reconcile scheduled-query transfer configs               |
+| `pubsub.googleapis.com`               | deliver transfer-completion notifications                           |
+
+## Usage
+
+Export both functions from your functions codebase entry:
+
+```ts
+// functions/src/index.ts
+export {
+  processMessages,
+  upsertTransferConfig,
+} from "@firebase/bigquery-firestore-export";
+```
+
+and configure them with a `.env` (or `.env.<projectId>`):
+
+```sh
+INSTANCE_ID=analytics-export
+BIGQUERY_DATASET_LOCATION=US
+DATASET_ID=analytics
+TABLE_NAME=users
+QUERY_STRING=SELECT * FROM `my-project.source.users`
+DISPLAY_NAME=Export users to Firestore
+SCHEDULE=every 24 hours
+```
+
+- `processMessages` consumes BigQuery Data Transfer completion messages.
+- `upsertTransferConfig` is the idempotent lifecycle task that creates, links,
+  or updates the scheduled query and its notification topic.
+
+Importing the package without exporting its functions deploys nothing—the CLI
+only deploys what your entry file exports.
+
+## Deploy
+
+The package's `firebase.json` declares a `kit` stanza (Firebase CLI 15.25.1 or
+later, behind the `kits` experiment):
+
+```json
+{
+  "functions": [
+    {
+      "source": ".",
+      "kit": "bigquery-firestore-export",
+      "instances": {
+        "default": "."
+      }
+    }
+  ]
+}
+```
+
+`instances` maps each instance id to the directory (relative to
+`firebase.json`) holding that instance's `.env`. The CLI prefixes every
+function and task queue name with `kit-<instance id>-`, so the functions above
+deploy as `kit-default-processMessages` and
+`kit-default-upsertTransferConfig`.
+
+```sh
+firebase experiments:enable kits
+firebase deploy --only functions
+```
+
+Deploy a single instance with `firebase deploy --only functions:<instance id>`.
+
+## Configuration
+
+Set these values in a `.env` (or `.env.<projectId>`) file. The Firebase CLI
+loads them at deploy time and prompts for required values that are missing.
+`PROJECT_ID` is supplied by the Firebase CLI.
+
+| Field                     | Env var                     | Required | Default           | Description                                                  |
+| ------------------------- | --------------------------- | -------- | ----------------- | ------------------------------------------------------------ |
+| `instanceId`              | `INSTANCE_ID`               | yes      | —                 | Must match this instance's key in the `instances` map        |
+| `bigqueryDatasetLocation` | `BIGQUERY_DATASET_LOCATION` | no       | `US`              | BigQuery destination dataset location                        |
+| `transferConfigName`      | `TRANSFER_CONFIG_NAME`      | no       | (empty)           | Existing DTS config resource to link instead of creating one |
+| `datasetId`               | `DATASET_ID`                | yes      | —                 | BigQuery destination dataset id                              |
+| `tableName`               | `TABLE_NAME`                | yes      | —                 | Prefix for per-run destination tables                        |
+| `queryString`             | `QUERY_STRING`              | yes      | —                 | Scheduled Standard SQL query                                 |
+| `displayName`             | `DISPLAY_NAME`              | yes      | —                 | Human-readable scheduled-query name                          |
+| `partitioningField`       | `PARTITIONING_FIELD`        | no       | (empty)           | Destination-table partitioning field                         |
+| `schedule`                | `SCHEDULE`                  | yes      | —                 | DTS schedule, such as `every 24 hours`                       |
+| `firestoreCollection`     | `COLLECTION_PATH`           | no       | `transferConfigs` | Root Firestore collection for configs and output             |
+| `logLevel`                | `LOG_LEVEL`                 | no       | `info`            | `debug`, `info`, `warn`, `error`, or `silent`                |
+
+## Multiple instances
+
+To run several reverse-sync instances, add one entry per instance to the
+`instances` map, each pointing at its own config directory with its own `.env`:
+
+```json
+{
+  "functions": [
+    {
+      "source": ".",
+      "kit": "bigquery-firestore-export",
+      "instances": {
+        "users": "instances/users",
+        "orders": "instances/orders"
+      }
+    }
+  ]
+}
+```
+
+Instance ids must be unique across all kit stanzas in the project, and every
+instance's function names are namespaced by its `kit-<instance id>-` prefix, so
+the instances cannot collide. Set `INSTANCE_ID` in each config directory to the
+same value as that directory's key in the `instances` map; it also namespaces
+the Pub/Sub notification topic and associates the deployment with its transfer
+config.
+
+## Provisioning
+
+The kit wires `upsertTransferConfig` to both `afterFirstDeploy` and
+`afterRedeploy`. The lifecycle task creates the Pub/Sub topic and scheduled
+query on first deploy, then reconciles supported query, table, schedule,
+dataset, partitioning, and topic changes on later deploys. It retries transient
+failures up to five times with at least 30 seconds of backoff.
+
+Set `TRANSFER_CONFIG_NAME` to link an existing scheduled-query config without
+changing it. Otherwise the kit stores `extInstanceId` on the Firestore config
+document and uses that value to find the config on later deploys. BigQuery DTS
+does not support clearing a partitioning field once set; create a new transfer
+config to remove partitioning.
+
+## Firestore layout
+
+For a transfer config `{configId}` and run `{runId}`, the kit writes:
+
+```text
+transferConfigs/{configId}
+transferConfigs/{configId}/runs/{runId}
+transferConfigs/{configId}/runs/{runId}/output/{rowId}
+transferConfigs/{configId}/runs/latest
+```
+
+The run document stores DTS metadata and row counts. Its `output` subcollection
+contains converted query rows. The `latest` document is updated transactionally
+so an older completion message cannot replace a newer run.
+
+## Differences from the Export BigQuery to Firestore extension
+
+This kit is version 0.2.2 of the extension repackaged as an npm package. It is a
+close port: the same two functions, the same BigQuery Data Transfer scheduled
+query, the same `transferConfigs/{configId}/runs/{runId}` and `runs/latest`
+documents, the same `WRITE_TRUNCATE` destination table naming and the same
+row-by-row copy into Firestore. Every setting keeps its extension environment
+variable name and default, so a `.env` copied from your installed instance needs
+no value changes. What changes is the instance id, the Pub/Sub topic, the identity
+the scheduled query runs as, and how repeated BigQuery columns land in Firestore.
+
+### You set `INSTANCE_ID` yourself, and the Pub/Sub topic is renamed
+
+The extension derived an instance id at install and used it to name its
+notification topic (`ext-<instance id>-processMessages`) and to tag its transfer
+config document with `extInstanceId`. Here `INSTANCE_ID` is a setting you
+provide, and it must match this instance's key in the `instances` map in
+`firebase.json`.
+
+The topic becomes `kit-<INSTANCE_ID>-processMessages`, and the kit creates it on
+first run if it does not already exist. Set `INSTANCE_ID` to your installed
+instance's id if you want the kit to adopt the scheduled query that instance
+created, because the lookup is by `extInstanceId` on the documents in
+`COLLECTION_PATH`. With a different id the kit finds nothing, creates a second
+scheduled query, and you end up with two writing into the same collection.
+
+The existing transfer config still points its notifications at the old `ext-`
+topic; the kit's update path rewrites `notification_pubsub_topic` to the new one
+on the first deploy, so the old topic can be deleted afterwards.
+
+### Repeated BigQuery columns are now written as arrays
+
+A repeated (`ARRAY`) column used to arrive in Firestore as a map keyed by
+position, `{ "0": ..., "1": ... }`, because the conversion treated every
+non-scalar value as an object. The kit writes a real Firestore array instead.
+Anything reading those fields by numeric string key needs updating, and rows
+written before and after the change are not the same shape. Scalars, timestamps,
+dates, times, datetimes, bytes and geography values convert exactly as before.
+
+### The scheduled query runs as a different service account
+
+The extension created the transfer config with
+`serviceAccountName: ext-<instance id>@<project>.iam.gserviceaccount.com`, so the
+query ran as the extension's own service account. The kit creates it without a
+service account name, so BigQuery Data Transfer runs it as the identity that
+created it, which is your function's runtime service account (the default compute
+service account unless you have set one).
+
+That account needs to be able to read whatever `QUERY_STRING` touches and write
+to `DATASET_ID`. `roles/bigquery.admin` on the function covers this for datasets
+in the same project; a cross-project query needs the grant made explicitly. This
+was not exercised against a live deploy.
+
+Note also that a service account cannot be changed on an existing transfer config,
+so a scheduled query originally created by an installed extension instance keeps
+running as the extension's service account even after the kit adopts it. Delete
+and recreate the scheduled query if you want it moved.
+
+### The setup step runs on every deploy
+
+The install, update and configure hooks are replaced by an `upsertTransferConfig`
+task that the CLI runs after your first deploy and after every redeploy. It does
+the same work: create the scheduled query if this instance has none, otherwise
+reconcile the existing one against your current `QUERY_STRING`, `DATASET_ID`,
+`TABLE_NAME`, `PARTITIONING_FIELD` and `SCHEDULE`.
+
+Two consequences of it now being an ordinary task rather than a lifecycle event.
+There is no install UI to report progress into, so failures show up in the task's
+function logs, and the task retries up to five times with a 30 second minimum
+backoff. And `DISPLAY_NAME` is no longer immutable, but changing it does not
+rename an existing scheduled query, because display name is not part of the
+update; it only applies to a config the kit creates.
+
+Removing `PARTITIONING_FIELD` once it has been set still fails, with the same
+explanation, because the BigQuery Data Transfer API cannot clear it.
+
+### You can link an existing scheduled query
+
+`TRANSFER_CONFIG_NAME` is a new setting. Point it at the full resource name of a
+scheduled query you already have
+(`projects/<project>/locations/<location>/transferConfigs/<id>`) and the kit
+records that config in Firestore and consumes its notifications instead of
+creating one of its own. The extension carried the code for this but no setting to
+reach it. Leave it empty for the create-or-reconcile behaviour described above.
+
+### Region, and no location setting
+
+`LOCATION` is gone. Both functions deploy to your codebase's default region
+(`us-central1` unless you have changed it) rather than the immutable location you
+picked at install. `BIGQUERY_DATASET_LOCATION` is unchanged and still tells the
+result query where your dataset lives.
+
+### Failed notifications are retried
+
+`processMessages` is a 2nd gen Pub/Sub function with retries enabled, where the
+extension's 1st gen trigger did not retry. A run whose results fail to copy, for
+example because BigQuery or Firestore is briefly unavailable, is now retried
+rather than dropped. A notification that keeps failing, such as one for a transfer
+config not tagged with this `INSTANCE_ID`, is also retried until Pub/Sub gives up.
+
+Both functions' service accounts need `roles/eventarc.eventReceiver` and
+`roles/run.invoker` on top of the three roles the extension asked for, and the
+Pub/Sub API is now requested explicitly. The Firebase CLI handles all of this.
+
+### Unchanged
+
+- `COLLECTION_PATH` still defaults to `transferConfigs`, and the document layout
+  under it is identical: the transfer config document keyed by config id, a `runs`
+  subcollection keyed by run id holding `runMetadata`, `totalRowCount` and
+  `failedRowCount`, a `latest` document, and an `output` collection of rows per
+  run.
+- The destination table is still `TABLE_NAME_{run_time|"%H%M%S"}` with
+  `WRITE_TRUNCATE`, and results are still read with `SELECT *` in
+  `BIGQUERY_DATASET_LOCATION`.
+- Runs that do not succeed still write a run document with zeroed counts and still
+  update `latest`, and `latest` is still only moved forward by a newer run.
+- Rows are still written one document at a time in chunks of 10,000, with
+  per-row failures logged and counted rather than aborting the run.
+- `LOG_LEVEL` still accepts `debug`, `info`, `warn`, `error` and `silent`.
+
+## API surface
+
+- **Main entry** (`@firebase/bigquery-firestore-export`): exports
+  `processMessages` and `upsertTransferConfig`, registers first-deploy and
+  redeploy lifecycle hooks, and resolves runtime dependencies lazily. Use this
+  entry from Firebase deploy/emulator/runtime.
+- **Library entry** (`./lib`): side-effect-free config helpers, DTS helpers,
+  injectable handlers, BigQuery-to-Firestore conversion helpers, and public
+  message/config types for consumers that own trigger registration.
+
+## License
+
+Apache-2.0

package/lib/config.d.ts

@@ -0,0 +1,5 @@
+import type { BigqueryFirestoreExportConfig, DeployTimeOptions } from "./export-config";
+export declare const CONFIG_EXPRESSIONS: DeployTimeOptions;
+/** Reads runtime values from Firebase deploy-time parameters. */
+export declare function configFromEnv(): BigqueryFirestoreExportConfig;
+//# sourceMappingURL=config.d.ts.map

package/lib/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAsBA,OAAO,KAAK,EACV,6BAA6B,EAC7B,iBAAiB,EAElB,MAAM,iBAAiB,CAAC;AA+IzB,eAAO,MAAM,kBAAkB,EAAE,iBAEhC,CAAC;AAcF,iEAAiE;AACjE,wBAAgB,aAAa,IAAI,6BAA6B,CAkB7D"}

package/lib/config.js

@@ -0,0 +1,181 @@
+"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.CONFIG_EXPRESSIONS = void 0;
+exports.configFromEnv = configFromEnv;
+const params_1 = require("firebase-functions/params");
+const LOG_LEVEL_OPTIONS = ["debug", "info", "warn", "error", "silent"];
+const instanceId = (0, params_1.defineString)("INSTANCE_ID");
+const params = {
+    instanceId,
+    bigqueryDatasetLocation: (0, params_1.defineString)("BIGQUERY_DATASET_LOCATION", {
+        label: "BigQuery Dataset Location",
+        description: "What is the location of the BigQuery dataset referenced in the query?",
+        default: "US",
+        input: (0, params_1.select)({
+            "Columbus, Ohio (us-east5)": "us-east5",
+            "Iowa (us-central1)": "us-central1",
+            "Las Vegas (us-west4)": "us-west4",
+            "Los Angeles (us-west2)": "us-west2",
+            "Montréal (northamerica-northeast1)": "northamerica-northeast1",
+            "Northern Virginia (us-east4)": "us-east4",
+            "Oregon (us-west1)": "us-west1",
+            "Salt Lake City (us-west3)": "us-west3",
+            "São Paulo (southamerica-east1)": "southamerica-east1",
+            "Santiago (southamerica-west1)": "southamerica-west1",
+            "South Carolina (us-east1)": "us-east1",
+            "Toronto (northamerica-northeast2)": "northamerica-northeast2",
+            "Delhi (asia-south2)": "asia-south2",
+            "Hong Kong (asia-east2)": "asia-east2",
+            "Jakarta (asia-southeast2)": "asia-southeast2",
+            "Melbourne (australia-southeast2)": "australia-southeast2",
+            "Mumbai (asia-south1)": "asia-south1",
+            "Osaka (asia-northeast2)": "asia-northeast2",
+            "Seoul (asia-northeast3)": "asia-northeast3",
+            "Singapore (asia-southeast1)": "asia-southeast1",
+            "Sydney (australia-southeast1)": "australia-southeast1",
+            "Taiwan (asia-east1)": "asia-east1",
+            "Tokyo (asia-northeast1)": "asia-northeast1",
+            "Belgium (europe-west1)": "europe-west1",
+            "Finland (europe-north1)": "europe-north1",
+            "Frankfurt (europe-west3)": "europe-west3",
+            "London (europe-west2)": "europe-west2",
+            "Madrid (europe-southwest1)": "europe-southwest1",
+            "Milan (europe-west8)": "europe-west8",
+            "Netherlands (europe-west4)": "europe-west4",
+            "Paris (europe-west9)": "europe-west9",
+            "Warsaw (europe-central2)": "europe-central2",
+            "Zürich (europe-west6)": "europe-west6",
+            "US Multi-Region (US)": "US",
+            "EU Mutli-Region (EU)": "EU",
+        }),
+    }),
+    transferConfigName: (0, params_1.defineString)("TRANSFER_CONFIG_NAME", { default: "" }),
+    datasetId: (0, params_1.defineString)("DATASET_ID", {
+        label: "Dataset ID",
+        description: "What's the BigQuery destination dataset you'd like to use? Each transfer run will write to a table in this destination dataset.",
+        input: {
+            text: {
+                nonEmpty: true,
+                example: "customer_data",
+            },
+        },
+    }),
+    tableName: (0, params_1.defineString)("TABLE_NAME", {
+        label: "Destination Table Name",
+        description: "What's the destination table name prefix you'd like to use? Each transfer run will write to the table with this name, postfixed with the runtime.",
+        input: {
+            text: {
+                nonEmpty: true,
+                example: "transactions",
+            },
+        },
+    }),
+    queryString: (0, params_1.defineString)("QUERY_STRING", {
+        label: "Query String",
+        description: "What's the BQ query you'd like to execute?",
+        input: {
+            text: {
+                nonEmpty: true,
+                example: "SELECT * from <PROJECT_ID>.customer_data.transactions",
+            },
+        },
+    }),
+    displayName: (0, params_1.defineString)("DISPLAY_NAME", {
+        label: "Display Name",
+        description: "What display name would you like to use?",
+        input: {
+            text: {
+                nonEmpty: true,
+                example: "Daily Rollup - Customer Transactions",
+            },
+        },
+    }),
+    partitioningField: (0, params_1.defineString)("PARTITIONING_FIELD", {
+        label: "Partitioning Field",
+        description: "What's the partitioning field on the destination table ID? Leave empty if not using a partitioning field.",
+        default: "",
+        input: { text: { example: "timestamp" } },
+    }),
+    schedule: (0, params_1.defineString)("SCHEDULE", {
+        label: "Schedule",
+        description: "What's the execution schedule you'd like to use for this query?",
+        input: {
+            text: {
+                nonEmpty: true,
+                example: "every 15 minutes",
+            },
+        },
+    }),
+    firestoreCollection: (0, params_1.defineString)("COLLECTION_PATH", {
+        label: "Firestore Collection",
+        description: "What's the top-level Firestore Collection to store transfer configs, run metadata, and query output?",
+        default: "transferConfigs",
+        input: {
+            text: {
+                example: "transferConfigs",
+                validationRegex: /^[^\/]+(\/[^\/]+\/[^\/]+)*$/,
+                validationErrorMessage: "Must be a valid Cloud Firestore Collection",
+            },
+        },
+    }),
+    logLevel: (0, params_1.defineString)("LOG_LEVEL", {
+        label: "Log Level",
+        description: "What's the log level you'd like to use for this extension?",
+        default: "info",
+        input: (0, params_1.select)({
+            DEBUG: "debug",
+            INFO: "info",
+            WARN: "warn",
+            ERROR: "error",
+            SILENT: "silent",
+        }),
+    }),
+};
+exports.CONFIG_EXPRESSIONS = {
+    pubSubTopic: (0, params_1.expr) `kit-${instanceId}-processMessages`,
+};
+function optional(value) {
+    const normalized = value.trim();
+    return normalized.length > 0 ? normalized : undefined;
+}
+function normalizeLogLevel(value) {
+    const normalized = value.toLowerCase();
+    return LOG_LEVEL_OPTIONS.includes(normalized)
+        ? normalized
+        : "info";
+}
+/** Reads runtime values from Firebase deploy-time parameters. */
+function configFromEnv() {
+    const resolvedInstanceId = params.instanceId.value();
+    return {
+        bigqueryDatasetLocation: params.bigqueryDatasetLocation.value(),
+        projectId: params_1.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()),
+    };
+}
+//# sourceMappingURL=config.js.map

package/lib/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;;AAEH,sDAKmC;AAOnC,MAAM,iBAAiB,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAU,CAAC;AAChF,MAAM,UAAU,GAAG,IAAA,qBAAY,EAAC,aAAa,CAAC,CAAC;AAE/C,MAAM,MAAM,GAAG;IACb,UAAU;IACV,uBAAuB,EAAE,IAAA,qBAAY,EAAC,2BAA2B,EAAE;QACjE,KAAK,EAAE,2BAA2B;QAClC,WAAW,EACT,uEAAuE;QAEzE,OAAO,EAAE,IAAI;QACb,KAAK,EAAE,IAAA,eAAM,EAAC;YACZ,2BAA2B,EAAE,UAAU;YACvC,oBAAoB,EAAE,aAAa;YACnC,sBAAsB,EAAE,UAAU;YAClC,wBAAwB,EAAE,UAAU;YACpC,oCAAoC,EAAE,yBAAyB;YAC/D,8BAA8B,EAAE,UAAU;YAC1C,mBAAmB,EAAE,UAAU;YAC/B,2BAA2B,EAAE,UAAU;YACvC,gCAAgC,EAAE,oBAAoB;YACtD,+BAA+B,EAAE,oBAAoB;YACrD,2BAA2B,EAAE,UAAU;YACvC,mCAAmC,EAAE,yBAAyB;YAC9D,qBAAqB,EAAE,aAAa;YACpC,wBAAwB,EAAE,YAAY;YACtC,2BAA2B,EAAE,iBAAiB;YAC9C,kCAAkC,EAAE,sBAAsB;YAC1D,sBAAsB,EAAE,aAAa;YACrC,yBAAyB,EAAE,iBAAiB;YAC5C,yBAAyB,EAAE,iBAAiB;YAC5C,6BAA6B,EAAE,iBAAiB;YAChD,+BAA+B,EAAE,sBAAsB;YACvD,qBAAqB,EAAE,YAAY;YACnC,yBAAyB,EAAE,iBAAiB;YAC5C,wBAAwB,EAAE,cAAc;YACxC,yBAAyB,EAAE,eAAe;YAC1C,0BAA0B,EAAE,cAAc;YAC1C,uBAAuB,EAAE,cAAc;YACvC,4BAA4B,EAAE,mBAAmB;YACjD,sBAAsB,EAAE,cAAc;YACtC,4BAA4B,EAAE,cAAc;YAC5C,sBAAsB,EAAE,cAAc;YACtC,0BAA0B,EAAE,iBAAiB;YAC7C,uBAAuB,EAAE,cAAc;YACvC,sBAAsB,EAAE,IAAI;YAC5B,sBAAsB,EAAE,IAAI;SAC7B,CAAC;KACH,CAAC;IACF,kBAAkB,EAAE,IAAA,qBAAY,EAAC,sBAAsB,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;IACzE,SAAS,EAAE,IAAA,qBAAY,EAAC,YAAY,EAAE;QACpC,KAAK,EAAE,YAAY;QACnB,WAAW,EACT,iIAAiI;QACnI,KAAK,EAAE;YACL,IAAI,EAAE;gBACJ,QAAQ,EAAE,IAAI;gBACd,OAAO,EAAE,eAAe;aACzB;SACF;KACF,CAAC;IACF,SAAS,EAAE,IAAA,qBAAY,EAAC,YAAY,EAAE;QACpC,KAAK,EAAE,wBAAwB;QAC/B,WAAW,EACT,mJAAmJ;QACrJ,KAAK,EAAE;YACL,IAAI,EAAE;gBACJ,QAAQ,EAAE,IAAI;gBACd,OAAO,EAAE,cAAc;aACxB;SACF;KACF,CAAC;IACF,WAAW,EAAE,IAAA,qBAAY,EAAC,cAAc,EAAE;QACxC,KAAK,EAAE,cAAc;QACrB,WAAW,EAAE,4CAA4C;QACzD,KAAK,EAAE;YACL,IAAI,EAAE;gBACJ,QAAQ,EAAE,IAAI;gBAEd,OAAO,EAAE,uDAAuD;aACjE;SACF;KACF,CAAC;IACF,WAAW,EAAE,IAAA,qBAAY,EAAC,cAAc,EAAE;QACxC,KAAK,EAAE,cAAc;QACrB,WAAW,EAAE,0CAA0C;QACvD,KAAK,EAAE;YACL,IAAI,EAAE;gBACJ,QAAQ,EAAE,IAAI;gBACd,OAAO,EAAE,sCAAsC;aAChD;SACF;KACF,CAAC;IACF,iBAAiB,EAAE,IAAA,qBAAY,EAAC,oBAAoB,EAAE;QACpD,KAAK,EAAE,oBAAoB;QAC3B,WAAW,EACT,2GAA2G;QAC7G,OAAO,EAAE,EAAE;QACX,KAAK,EAAE,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,WAAW,EAAE,EAAE;KAC1C,CAAC;IACF,QAAQ,EAAE,IAAA,qBAAY,EAAC,UAAU,EAAE;QACjC,KAAK,EAAE,UAAU;QACjB,WAAW,EACT,iEAAiE;QACnE,KAAK,EAAE;YACL,IAAI,EAAE;gBACJ,QAAQ,EAAE,IAAI;gBACd,OAAO,EAAE,kBAAkB;aAC5B;SACF;KACF,CAAC;IACF,mBAAmB,EAAE,IAAA,qBAAY,EAAC,iBAAiB,EAAE;QACnD,KAAK,EAAE,sBAAsB;QAC7B,WAAW,EACT,sGAAsG;QAExG,OAAO,EAAE,iBAAiB;QAC1B,KAAK,EAAE;YACL,IAAI,EAAE;gBACJ,OAAO,EAAE,iBAAiB;gBAE1B,eAAe,EAAE,6BAA6B;gBAC9C,sBAAsB,EAAE,4CAA4C;aACrE;SACF;KACF,CAAC;IACF,QAAQ,EAAE,IAAA,qBAAY,EAAC,WAAW,EAAE;QAClC,KAAK,EAAE,WAAW;QAClB,WAAW,EAAE,4DAA4D;QAEzE,OAAO,EAAE,MAAM;QACf,KAAK,EAAE,IAAA,eAAM,EAAC;YACZ,KAAK,EAAE,OAAO;YACd,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,OAAO;YACd,MAAM,EAAE,QAAQ;SACjB,CAAC;KACH,CAAC;CACH,CAAC;AAEW,QAAA,kBAAkB,GAAsB;IACnD,WAAW,EAAE,IAAA,aAAI,EAAA,OAAO,UAAU,kBAAkB;CACrD,CAAC;AAEF,SAAS,QAAQ,CAAC,KAAa;IAC7B,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;IAChC,OAAO,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;AACxD,CAAC;AAED,SAAS,iBAAiB,CAAC,KAAa;IACtC,MAAM,UAAU,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;IACvC,OAAO,iBAAiB,CAAC,QAAQ,CAAC,UAAsB,CAAC;QACvD,CAAC,CAAE,UAAuB;QAC1B,CAAC,CAAC,MAAM,CAAC;AACb,CAAC;AAED,iEAAiE;AACjE;IACE,MAAM,kBAAkB,GAAG,MAAM,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;IAErD,OAAO;QACL,uBAAuB,EAAE,MAAM,CAAC,uBAAuB,CAAC,KAAK,EAAE;QAC/D,SAAS,EAAE,kBAAS,CAAC,KAAK,EAAE;QAC5B,UAAU,EAAE,kBAAkB;QAC9B,kBAAkB,EAAE,QAAQ,CAAC,MAAM,CAAC,kBAAkB,CAAC,KAAK,EAAE,CAAC;QAC/D,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE;QACnC,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE;QACnC,WAAW,EAAE,MAAM,CAAC,WAAW,CAAC,KAAK,EAAE;QACvC,WAAW,EAAE,MAAM,CAAC,WAAW,CAAC,KAAK,EAAE;QACvC,iBAAiB,EAAE,QAAQ,CAAC,MAAM,CAAC,iBAAiB,CAAC,KAAK,EAAE,CAAC;QAC7D,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE;QACjC,WAAW,EAAE,OAAO,kBAAkB,kBAAkB;QACxD,mBAAmB,EAAE,MAAM,CAAC,mBAAmB,CAAC,KAAK,EAAE;QACvD,QAAQ,EAAE,iBAAiB,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;KACrD,CAAC;AACJ,CAAC"}

package/lib/dts.d.ts

@@ -0,0 +1,21 @@
+import * as bigqueryDataTransfer from "@google-cloud/bigquery-data-transfer";
+import type { ResolvedBigqueryFirestoreExportConfig } from "./export-config";
+export type DataTransferClient = bigqueryDataTransfer.v1.DataTransferServiceClient;
+export type TransferConfig = bigqueryDataTransfer.protos.google.cloud.bigquery.datatransfer.v1.ITransferConfig;
+export declare const PARTITIONING_FIELD_REMOVAL_ERROR_PREFIX = "Cannot remove partitioning_field from an existing transfer config";
+export declare const PARTITIONING_FIELD_REMOVAL_ERROR = "Cannot remove partitioning_field from an existing transfer config. 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.";
+/**
+ * Creates the protobuf-shaped request used for a scheduled query.
+ *
+ * The query runs as whichever identity creates it, which is this function. To
+ * name a different account, `serviceAccountName` goes on the request rather
+ * than on the transfer config, and the caller needs `actAs` on the account it
+ * names, including its own.
+ */
+export declare function createTransferConfigRequest(config: ResolvedBigqueryFirestoreExportConfig): bigqueryDataTransfer.protos.google.cloud.bigquery.datatransfer.v1.ICreateTransferConfigRequest;
+export declare function getTransferConfig(client: DataTransferClient, transferConfigName: string): Promise<TransferConfig | null>;
+export declare function createTransferConfig(client: DataTransferClient, config: ResolvedBigqueryFirestoreExportConfig): Promise<TransferConfig>;
+/** Builds a minimal update mask while retaining unsupported immutable fields. */
+export declare function constructUpdateTransferConfigRequest(client: DataTransferClient, transferConfigName: string, config: ResolvedBigqueryFirestoreExportConfig): Promise<bigqueryDataTransfer.protos.google.cloud.bigquery.datatransfer.v1.IUpdateTransferConfigRequest>;
+export declare function updateTransferConfig(client: DataTransferClient, transferConfigName: string, config: ResolvedBigqueryFirestoreExportConfig): Promise<TransferConfig>;
+//# sourceMappingURL=dts.d.ts.map

package/lib/dts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dts.d.ts","sourceRoot":"","sources":["../src/dts.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,oBAAoB,MAAM,sCAAsC,CAAC;AAC7E,OAAO,KAAK,EAAE,qCAAqC,EAAE,MAAM,iBAAiB,CAAC;AAG7E,MAAM,MAAM,kBAAkB,GAC5B,oBAAoB,CAAC,EAAE,CAAC,yBAAyB,CAAC;AACpD,MAAM,MAAM,cAAc,GACxB,oBAAoB,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC,eAAe,CAAC;AAMpF,eAAO,MAAM,uCAAuC,sEACxB,CAAC;AAC7B,eAAO,MAAM,gCAAgC,oPAAgN,CAAC;AAoC9P;;;;;;;GAOG;AACH,wBAAgB,2BAA2B,CACzC,MAAM,EAAE,qCAAqC,GAC5C,oBAAoB,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC,4BAA4B,CAqBhG;AAED,wBAAsB,iBAAiB,CACrC,MAAM,EAAE,kBAAkB,EAC1B,kBAAkB,EAAE,MAAM,GACzB,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,CAchC;AAED,wBAAsB,oBAAoB,CACxC,MAAM,EAAE,kBAAkB,EAC1B,MAAM,EAAE,qCAAqC,GAC5C,OAAO,CAAC,cAAc,CAAC,CAUzB;AAED,iFAAiF;AACjF,wBAAsB,oCAAoC,CACxD,MAAM,EAAE,kBAAkB,EAC1B,kBAAkB,EAAE,MAAM,EAC1B,MAAM,EAAE,qCAAqC,GAC5C,OAAO,CAAC,oBAAoB,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC,4BAA4B,CAAC,CAyDzG;AAED,wBAAsB,oBAAoB,CACxC,MAAM,EAAE,kBAAkB,EAC1B,kBAAkB,EAAE,MAAM,EAC1B,MAAM,EAAE,qCAAqC,GAC5C,OAAO,CAAC,cAAc,CAAC,CAczB"}