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

package/lib/index.js

@@ -0,0 +1,179 @@
+"use strict";
+/*
+ * Copyright 2019 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.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setupBigQuerySync = exports.initBigQuerySync = exports.fsexportbigquery = void 0;
+/**
+ * Main entry point. Exports the wired functions with deploy-time param
+ * expressions, then resolves concrete config lazily at runtime. Re-export
+ * `fsexportbigquery` and `initBigQuerySync` from your own functions codebase
+ * entry; configuration comes from a `.env` (or
+ * `.env.<projectId>`), which the Firebase CLI loads at deploy.
+ *
+ * Because this module initializes runtime dependencies lazily, deploy discovery
+ * can analyze it without resolving params too early.
+ * For side-effect-free imports (the handlers and config types), import from
+ * `./lib` instead.
+ */
+const firestore_bigquery_change_tracker_1 = require("@firebaseextensions/firestore-bigquery-change-tracker");
+const app_1 = require("firebase-admin/app");
+const firestore_1 = require("firebase-functions/firestore");
+const params_1 = require("firebase-functions/params");
+const tasks_1 = require("firebase-functions/tasks");
+const v2_1 = require("firebase-functions/v2");
+const lifecycle_1 = require("firebase-functions/v2/lifecycle");
+const config_1 = require("./config");
+const events = __importStar(require("./events"));
+const export_config_1 = require("./export-config");
+const handlers_1 = require("./handlers");
+const init_1 = require("./init");
+const logs = __importStar(require("./logs"));
+// Re-export the side-effect-free library surface (handlers and config types).
+__exportStar(require("./lib"), exports);
+const INIT_BIGQUERY_SYNC_FUNCTION = "initBigQuerySync";
+const SETUP_BIGQUERY_SYNC_FUNCTION = "setupBigQuerySync";
+const LIFECYCLE_RETRY_CONFIG = {
+    maxAttempts: 15,
+    minBackoffSeconds: 60,
+};
+const REQUIRED_ROLES = [
+    "roles/bigquery.dataEditor",
+    "roles/datastore.user",
+    "roles/bigquery.user",
+    // Gen2 Firestore triggers need Eventarc receive and run.invoker on the function SA.
+    "roles/eventarc.eventReceiver",
+    "roles/run.invoker",
+];
+const REQUIRED_APIS = [
+    {
+        api: "bigquery.googleapis.com",
+        reason: "Mirrors data from your Cloud Firestore collection in BigQuery.",
+    },
+];
+for (const role of REQUIRED_ROLES) {
+    (0, v2_1.requiresRole)(role);
+}
+for (const { api, reason } of REQUIRED_APIS) {
+    (0, v2_1.requiresAPI)(api, reason);
+}
+(0, lifecycle_1.afterFirstDeploy)({
+    task: { function: INIT_BIGQUERY_SYNC_FUNCTION, body: { data: {} } },
+});
+(0, lifecycle_1.afterRedeploy)({
+    task: { function: SETUP_BIGQUERY_SYNC_FUNCTION, body: { data: {} } },
+});
+let ctx;
+function getHandlerContext() {
+    if (ctx) {
+        return ctx;
+    }
+    const config = (0, export_config_1.resolveExportConfig)((0, config_1.configFromEnv)());
+    const tracker = new firestore_bigquery_change_tracker_1.FirestoreBigQueryEventHistoryTracker((0, export_config_1.toTrackerConfig)(config));
+    logs.logger.setLogLevel(config.logLevel);
+    logs.init(config);
+    if ((0, app_1.getApps)().length === 0) {
+        (0, app_1.initializeApp)();
+    }
+    events.setupEventChannel();
+    const ensureInitialized = (0, init_1.createEnsureInitialized)(tracker);
+    ctx = {
+        tracker,
+        config,
+        ensureInitialized,
+    };
+    return ctx;
+}
+const functionOptions = {
+    region: config_1.CONFIG_EXPRESSIONS.location,
+};
+/**
+ * Firestore trigger: streams document writes on the watched collection into the
+ * BigQuery changelog table. Failed executions are retried by the Firebase
+ * Functions runtime.
+ */
+exports.fsexportbigquery = (0, firestore_1.onDocumentWritten)({
+    ...functionOptions,
+    document: (0, params_1.expr) `${config_1.CONFIG_EXPRESSIONS.collectionPath}/{documentId}`,
+    database: config_1.CONFIG_EXPRESSIONS.database,
+    retry: true,
+}, (event) => (0, handlers_1.handleDocumentWrite)(event, getHandlerContext()));
+async function handleBigQuerySyncInitialization() {
+    try {
+        await getHandlerContext().ensureInitialized();
+    }
+    catch (err) {
+        logs.error(false, "Failed to initialize BigQuery resources", err);
+        throw err;
+    }
+}
+/**
+ * First-deploy provisioning task (`afterFirstDeploy`). Runs in the function's
+ * own identity, so it has the runtime service account and bound secrets that
+ * creating the dataset/table/views needs (e.g. CMEK). Cloud Tasks retries a
+ * failed initialization on its own schedule, so a transient BigQuery error does
+ * not leave the resources unprovisioned. It is idempotent (`initialize()`
+ * no-ops when resources already exist) and can also be invoked directly as an
+ * authenticated HTTP POST, without queue retries.
+ */
+exports.initBigQuerySync = (0, tasks_1.onTaskDispatched)({
+    ...functionOptions,
+    retryConfig: LIFECYCLE_RETRY_CONFIG,
+}, handleBigQuerySyncInitialization);
+/**
+ * Update/configure lifecycle task. Uses the same idempotent provisioning path
+ * so BigQuery resources are reconciled after parameter changes.
+ */
+exports.setupBigQuerySync = (0, tasks_1.onTaskDispatched)({
+    ...functionOptions,
+    retryConfig: LIFECYCLE_RETRY_CONFIG,
+}, handleBigQuerySyncInitialization);
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH;;;;;;;;;;;GAWG;AAEH,6GAA6G;AAC7G,4CAA4D;AAC5D,4DAAiE;AACjE,sDAAiD;AACjD,oDAA4D;AAE5D,8CAAkE;AAClE,+DAGyC;AACzC,qCAA6D;AAC7D,MAAY,MAAM,qCAAiB;AACnC,mDAAuE;AACvE,yCAAsE;AACtE,iCAAiD;AACjD,MAAY,IAAI,mCAAe;AAE/B,8EAA8E;AAC9E,wCAAsB;AAEtB,MAAM,2BAA2B,GAAG,kBAAkB,CAAC;AACvD,MAAM,4BAA4B,GAAG,mBAAmB,CAAC;AACzD,MAAM,sBAAsB,GAAG;IAC7B,WAAW,EAAE,EAAE;IACf,iBAAiB,EAAE,EAAE;CACb,CAAC;AACX,MAAM,cAAc,GAAwB;IAC1C,2BAA2B;IAC3B,sBAAsB;IACtB,qBAAqB;IACrB,oFAAoF;IACpF,8BAA8B;IAC9B,mBAAmB;CACpB,CAAC;AACF,MAAM,aAAa,GAAG;IACpB;QACE,GAAG,EAAE,yBAAyB;QAC9B,MAAM,EAAE,gEAAgE;KACzE;CACO,CAAC;AAEX,KAAK,MAAM,IAAI,IAAI,cAAc,EAAE,CAAC;IAClC,IAAA,iBAAY,EAAC,IAAI,CAAC,CAAC;AACrB,CAAC;AAED,KAAK,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,aAAa,EAAE,CAAC;IAC5C,IAAA,gBAAW,EAAC,GAAG,EAAE,MAAM,CAAC,CAAC;AAC3B,CAAC;AAED,IAAA,4BAAgB,EAAC;IACf,IAAI,EAAE,EAAE,QAAQ,EAAE,2BAA2B,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE;CACpE,CAAC,CAAC;AACH,IAAA,yBAAa,EAAC;IACZ,IAAI,EAAE,EAAE,QAAQ,EAAE,4BAA4B,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE;CACrE,CAAC,CAAC;AAEH,IAAI,GAA+B,CAAC;AAEpC,SAAS,iBAAiB;IACxB,IAAI,GAAG,EAAE,CAAC;QACR,OAAO,GAAG,CAAC;IACb,CAAC;IAED,MAAM,MAAM,GAAG,IAAA,mCAAmB,EAAC,IAAA,sBAAa,GAAE,CAAC,CAAC;IACpD,MAAM,OAAO,GAAG,IAAI,wEAAoC,CACtD,IAAA,+BAAe,EAAC,MAAM,CAAC,CACxB,CAAC;IAEF,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACzC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAElB,IAAI,IAAA,aAAO,GAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC3B,IAAA,mBAAa,GAAE,CAAC;IAClB,CAAC;IAED,MAAM,CAAC,iBAAiB,EAAE,CAAC;IAE3B,MAAM,iBAAiB,GAAG,IAAA,8BAAuB,EAAC,OAAO,CAAC,CAAC;IAE3D,GAAG,GAAG;QACJ,OAAO;QACP,MAAM;QACN,iBAAiB;KAClB,CAAC;IAEF,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,eAAe,GAAG;IACtB,MAAM,EAAE,2BAAkB,CAAC,QAAQ;CACpC,CAAC;AAEF;;;;GAIG;AACU,QAAA,gBAAgB,GAAG,IAAA,6BAAiB,EAC/C;IACE,GAAG,eAAe;IAClB,QAAQ,EAAE,IAAA,aAAI,EAAA,GAAG,2BAAkB,CAAC,cAAc,eAAe;IACjE,QAAQ,EAAE,2BAAkB,CAAC,QAAQ;IACrC,KAAK,EAAE,IAAI;CACZ,EACD,CAAC,KAAK,EAAE,EAAE,CAAC,IAAA,8BAAmB,EAAC,KAAK,EAAE,iBAAiB,EAAE,CAAC,CAC3D,CAAC;AAEF,KAAK,UAAU,gCAAgC;IAC7C,IAAI,CAAC;QACH,MAAM,iBAAiB,EAAE,CAAC,iBAAiB,EAAE,CAAC;IAChD,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,yCAAyC,EAAE,GAAG,CAAC,CAAC;QAClE,MAAM,GAAG,CAAC;IACZ,CAAC;AACH,CAAC;AAED;;;;;;;;GAQG;AACU,QAAA,gBAAgB,GAAG,IAAA,wBAAgB,EAC9C;IACE,GAAG,eAAe;IAClB,WAAW,EAAE,sBAAsB;CACpC,EACD,gCAAgC,CACjC,CAAC;AAEF;;;GAGG;AACU,QAAA,iBAAiB,GAAG,IAAA,wBAAgB,EAC/C;IACE,GAAG,eAAe;IAClB,WAAW,EAAE,sBAAsB;CACpC,EACD,gCAAgC,CACjC,CAAC"}

package/lib/init.d.ts

@@ -0,0 +1,16 @@
+import type { FirestoreBigQueryEventHistoryTracker } from "@firebaseextensions/firestore-bigquery-change-tracker";
+/**
+ * Builds the provisioning guard used by the `initBigQuerySync` endpoint and the
+ * retry-path self-heal. The hot write path never calls it.
+ *
+ * The returned function runs `tracker.initialize()` at most once per instance:
+ * concurrent invocations on a cold instance share a single in-flight promise. A
+ * failed initialization resets the guard so a later invocation can retry after
+ * a transient error.
+ *
+ * @param tracker - The event history tracker whose `initialize()` provisions
+ *   the BigQuery dataset, table, and views.
+ * @returns A function that resolves once the resources are provisioned.
+ */
+export declare function createEnsureInitialized(tracker: FirestoreBigQueryEventHistoryTracker): () => Promise<void>;
+//# sourceMappingURL=init.d.ts.map

package/lib/init.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../src/init.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,oCAAoC,EAAE,MAAM,uDAAuD,CAAC;AAElH;;;;;;;;;;;;GAYG;AACH,wBAAgB,uBAAuB,CACrC,OAAO,EAAE,oCAAoC,GAC5C,MAAM,OAAO,CAAC,IAAI,CAAC,CAWrB"}

package/lib/init.js

@@ -0,0 +1,44 @@
+"use strict";
+/*
+ * Copyright 2019 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.createEnsureInitialized = createEnsureInitialized;
+/**
+ * Builds the provisioning guard used by the `initBigQuerySync` endpoint and the
+ * retry-path self-heal. The hot write path never calls it.
+ *
+ * The returned function runs `tracker.initialize()` at most once per instance:
+ * concurrent invocations on a cold instance share a single in-flight promise. A
+ * failed initialization resets the guard so a later invocation can retry after
+ * a transient error.
+ *
+ * @param tracker - The event history tracker whose `initialize()` provisions
+ *   the BigQuery dataset, table, and views.
+ * @returns A function that resolves once the resources are provisioned.
+ */
+function createEnsureInitialized(tracker) {
+    let initialization = null;
+    return () => {
+        if (!initialization) {
+            initialization = tracker.initialize().catch((err) => {
+                initialization = null;
+                throw err;
+            });
+        }
+        return initialization;
+    };
+}
+//# sourceMappingURL=init.js.map

package/lib/init.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"init.js","sourceRoot":"","sources":["../src/init.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAIH;;;;;;;;;;;;GAYG;AACH,iCACE,OAA6C;IAE7C,IAAI,cAAc,GAAyB,IAAI,CAAC;IAChD,OAAO,GAAG,EAAE;QACV,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,cAAc,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;gBAClD,cAAc,GAAG,IAAI,CAAC;gBACtB,MAAM,GAAG,CAAC;YACZ,CAAC,CAAC,CAAC;QACL,CAAC;QACD,OAAO,cAAc,CAAC;IACxB,CAAC,CAAC;AACJ,CAAC"}

package/lib/lib.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Side-effect-free library surface:
+ *
+ * - {@link handleDocumentWrite} — the handler, for consumers who want to own
+ *   trigger registration themselves. It takes an injected
+ *   {@link HandlerContext}.
+ * - Config types and helpers ({@link ExportConfig}, {@link resolveExportConfig},
+ *   {@link toTrackerConfig}) for building that context.
+ *
+ * Importing this module has no side effects (it reads no environment), so it is
+ * safe to import anywhere. The main entry point (`./index`) is the one that
+ * reads env params and exports the wired functions.
+ *
+ * The change-tracker engine is an internal dependency and is deliberately not
+ * re-exported; only the types the handler signatures need are surfaced.
+ */
+export { type ChangeTrackerConfig, ChangeType, type FirestoreBigQueryEventHistoryTracker, } from "@firebaseextensions/firestore-bigquery-change-tracker";
+export { type ExportConfig, type ResolvedExportConfig, resolveExportConfig, toTrackerConfig, type ViewType, } from "./export-config";
+export { type DocumentWriteEvent, type HandlerContext, handleDocumentWrite, } from "./handlers";
+//# sourceMappingURL=lib.d.ts.map

package/lib/lib.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lib.d.ts","sourceRoot":"","sources":["../src/lib.ts"],"names":[],"mappings":"AAgBA;;;;;;;;;;;;;;;GAeG;AAKH,OAAO,EACL,KAAK,mBAAmB,EACxB,UAAU,EACV,KAAK,oCAAoC,GAC1C,MAAM,uDAAuD,CAAC;AAE/D,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,oBAAoB,EACzB,mBAAmB,EACnB,eAAe,EACf,KAAK,QAAQ,GACd,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EACL,KAAK,kBAAkB,EACvB,KAAK,cAAc,EACnB,mBAAmB,GACpB,MAAM,YAAY,CAAC"}

package/lib/lib.js

@@ -0,0 +1,47 @@
+"use strict";
+/*
+ * Copyright 2019 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.handleDocumentWrite = exports.toTrackerConfig = exports.resolveExportConfig = exports.ChangeType = void 0;
+/**
+ * Side-effect-free library surface:
+ *
+ * - {@link handleDocumentWrite} — the handler, for consumers who want to own
+ *   trigger registration themselves. It takes an injected
+ *   {@link HandlerContext}.
+ * - Config types and helpers ({@link ExportConfig}, {@link resolveExportConfig},
+ *   {@link toTrackerConfig}) for building that context.
+ *
+ * Importing this module has no side effects (it reads no environment), so it is
+ * safe to import anywhere. The main entry point (`./index`) is the one that
+ * reads env params and exports the wired functions.
+ *
+ * The change-tracker engine is an internal dependency and is deliberately not
+ * re-exported; only the types the handler signatures need are surfaced.
+ */
+// Engine types referenced by the handler and config signatures. Type-only —
+// the engine itself is internal. `ChangeType` is exported for handler tests and
+// advanced consumers that build Firestore events directly.
+var firestore_bigquery_change_tracker_1 = require("@firebaseextensions/firestore-bigquery-change-tracker");
+Object.defineProperty(exports, "ChangeType", { enumerable: true, get: function () { return firestore_bigquery_change_tracker_1.ChangeType; } });
+// Config types and helpers
+var export_config_1 = require("./export-config");
+Object.defineProperty(exports, "resolveExportConfig", { enumerable: true, get: function () { return export_config_1.resolveExportConfig; } });
+Object.defineProperty(exports, "toTrackerConfig", { enumerable: true, get: function () { return export_config_1.toTrackerConfig; } });
+// Handlers
+var handlers_1 = require("./handlers");
+Object.defineProperty(exports, "handleDocumentWrite", { enumerable: true, get: function () { return handlers_1.handleDocumentWrite; } });
+//# sourceMappingURL=lib.js.map

package/lib/lib.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lib.js","sourceRoot":"","sources":["../src/lib.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH;;;;;;;;;;;;;;;GAeG;AAEH,4EAA4E;AAC5E,gFAAgF;AAChF,2DAA2D;AAC3D,2GAI+D;AAF7D,+HAAA,UAAU,OAAA;AAGZ,2BAA2B;AAC3B,iDAMyB;AAHvB,oHAAA,mBAAmB,OAAA;AACnB,gHAAA,eAAe,OAAA;AAGjB,WAAW;AACX,uCAIoB;AADlB,+GAAA,mBAAmB,OAAA"}

package/lib/logs.d.ts

@@ -0,0 +1,39 @@
+import { type ChangeType, Logger } from "@firebaseextensions/firestore-bigquery-change-tracker";
+export declare const logger: Logger;
+export declare const arrayFieldInvalid: (fieldName: string) => void;
+export declare const bigQueryDatasetCreated: (datasetId: string) => void;
+export declare const bigQueryDatasetCreating: (datasetId: string) => void;
+export declare const bigQueryDatasetExists: (datasetId: string) => void;
+export declare const bigQueryErrorRecordingDocumentChange: (e: Error) => void;
+export declare const bigQueryLatestSnapshotViewQueryCreated: (query: string) => void;
+export declare const bigQueryTableAlreadyExists: (tableName: string, datasetName: string) => void;
+export declare const bigQueryTableCreated: (tableName: string) => void;
+export declare const bigQueryTableCreating: (tableName: string) => void;
+export declare const bigQueryTableUpdated: (tableName: string) => void;
+export declare const bigQueryTableUpdating: (tableName: string) => void;
+export declare const bigQueryTableUpToDate: (tableName: string) => void;
+export declare const bigQueryTableValidated: (tableName: string) => void;
+export declare const bigQueryTableValidating: (tableName: string) => void;
+export declare const bigQueryUserDefinedFunctionCreating: (functionDefinition: string) => void;
+export declare const bigQueryUserDefinedFunctionCreated: (functionDefinition: string) => void;
+export declare const bigQueryViewCreated: (viewName: string) => void;
+export declare const bigQueryViewCreating: (viewName: string) => void;
+export declare const bigQueryViewAlreadyExists: (viewName: string, datasetName: string) => void;
+export declare const bigQueryViewUpdated: (viewName: string) => void;
+export declare const bigQueryViewUpdating: (viewName: string) => void;
+export declare const bigQueryViewUpToDate: (viewName: string) => void;
+export declare const bigQueryViewValidated: (viewName: string) => void;
+export declare const bigQueryViewValidating: (viewName: string) => void;
+export declare const complete: () => void;
+export declare const dataInserted: (rowCount: number) => void;
+export declare const dataInserting: (rowCount: number) => void;
+export declare const dataTypeInvalid: (fieldName: string, fieldType: string, dataType: string) => void;
+export declare const error: (includeEvent: boolean, message: string, err: Error, event?: any, // Made optional, as it is not always required
+eventTrackerConfig?: any) => void;
+export declare const init: (config?: unknown) => void;
+export declare const start: (config?: unknown) => void;
+export declare const timestampMissingValue: (fieldName: string) => void;
+export declare const logEventAction: (action: string, document_name: string, event_id: string, operation: ChangeType) => void;
+export declare const logFailedEventAction: (action: string, document_name: string, event_id: string, operation: ChangeType, error: Error) => void;
+export declare const failedToWriteToBigQueryImmediately: (error: Error) => 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":"AAgBA,OAAO,EACL,KAAK,UAAU,EACf,MAAM,EACP,MAAM,uDAAuD,CAAC;AAE/D,eAAO,MAAM,MAAM,QAAe,CAAC;AAEnC,eAAO,MAAM,iBAAiB,cAAe,MAAM,SAElD,CAAC;AAEF,eAAO,MAAM,sBAAsB,cAAe,MAAM,SAEvD,CAAC;AAEF,eAAO,MAAM,uBAAuB,cAAe,MAAM,SAExD,CAAC;AAEF,eAAO,MAAM,qBAAqB,cAAe,MAAM,SAEtD,CAAC;AAEF,eAAO,MAAM,oCAAoC,MAAO,KAAK,SAE5D,CAAC;AAEF,eAAO,MAAM,sCAAsC,UAAW,MAAM,SAEnE,CAAC;AAEF,eAAO,MAAM,0BAA0B,cAC1B,MAAM,eACJ,MAAM,SAMpB,CAAC;AAEF,eAAO,MAAM,oBAAoB,cAAe,MAAM,SAErD,CAAC;AAEF,eAAO,MAAM,qBAAqB,cAAe,MAAM,SAEtD,CAAC;AAEF,eAAO,MAAM,oBAAoB,cAAe,MAAM,SAErD,CAAC;AAEF,eAAO,MAAM,qBAAqB,cAAe,MAAM,SAEtD,CAAC;AAEF,eAAO,MAAM,qBAAqB,cAAe,MAAM,SAEtD,CAAC;AAEF,eAAO,MAAM,sBAAsB,cAAe,MAAM,SAEvD,CAAC;AAEF,eAAO,MAAM,uBAAuB,cAAe,MAAM,SAExD,CAAC;AAEF,eAAO,MAAM,mCAAmC,uBAC1B,MAAM,SAK3B,CAAC;AAEF,eAAO,MAAM,kCAAkC,uBACzB,MAAM,SAG3B,CAAC;AAEF,eAAO,MAAM,mBAAmB,aAAc,MAAM,SAEnD,CAAC;AAEF,eAAO,MAAM,oBAAoB,aAAc,MAAM,SAEpD,CAAC;AAEF,eAAO,MAAM,yBAAyB,aAC1B,MAAM,eACH,MAAM,SAKpB,CAAC;AAEF,eAAO,MAAM,mBAAmB,aAAc,MAAM,SAEnD,CAAC;AAEF,eAAO,MAAM,oBAAoB,aAAc,MAAM,SAEpD,CAAC;AAEF,eAAO,MAAM,oBAAoB,aAAc,MAAM,SAEpD,CAAC;AAEF,eAAO,MAAM,qBAAqB,aAAc,MAAM,SAErD,CAAC;AAEF,eAAO,MAAM,sBAAsB,aAAc,MAAM,SAEtD,CAAC;AAEF,eAAO,MAAM,QAAQ,YAEpB,CAAC;AAEF,eAAO,MAAM,YAAY,aAAc,MAAM,SAE5C,CAAC;AAEF,eAAO,MAAM,aAAa,aAAc,MAAM,SAE7C,CAAC;AAEF,eAAO,MAAM,eAAe,cACf,MAAM,aACN,MAAM,YACP,MAAM,SAKjB,CAAC;AAEF,eAAO,MAAM,KAAK,iBACF,OAAO,WACZ,MAAM,OACV,KAAK,UACF,GAAG,EAAE,8CAA8C;qBACtC,GAAG,SAazB,CAAC;AAEF,eAAO,MAAM,IAAI,YAAa,OAAO,SAEpC,CAAC;AAEF,eAAO,MAAM,KAAK,YAAa,OAAO,SAErC,CAAC;AAEF,eAAO,MAAM,qBAAqB,cAAe,MAAM,SAItD,CAAC;AAEF,eAAO,MAAM,cAAc,WACjB,MAAM,iBACC,MAAM,YACX,MAAM,aACL,UAAU,SAOtB,CAAC;AAEF,eAAO,MAAM,oBAAoB,WACvB,MAAM,iBACC,MAAM,YACX,MAAM,aACL,UAAU,SACd,KAAK,SAeb,CAAC;AAEF,eAAO,MAAM,kCAAkC,UAAW,KAAK,SAK9D,CAAC"}

package/lib/logs.js

@@ -0,0 +1,186 @@
+"use strict";
+/*
+ * Copyright 2019 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.failedToWriteToBigQueryImmediately = exports.logFailedEventAction = exports.logEventAction = exports.timestampMissingValue = exports.start = exports.init = exports.error = exports.dataTypeInvalid = exports.dataInserting = exports.dataInserted = exports.complete = exports.bigQueryViewValidating = exports.bigQueryViewValidated = exports.bigQueryViewUpToDate = exports.bigQueryViewUpdating = exports.bigQueryViewUpdated = exports.bigQueryViewAlreadyExists = exports.bigQueryViewCreating = exports.bigQueryViewCreated = exports.bigQueryUserDefinedFunctionCreated = exports.bigQueryUserDefinedFunctionCreating = exports.bigQueryTableValidating = exports.bigQueryTableValidated = exports.bigQueryTableUpToDate = exports.bigQueryTableUpdating = exports.bigQueryTableUpdated = exports.bigQueryTableCreating = exports.bigQueryTableCreated = exports.bigQueryTableAlreadyExists = exports.bigQueryLatestSnapshotViewQueryCreated = exports.bigQueryErrorRecordingDocumentChange = exports.bigQueryDatasetExists = exports.bigQueryDatasetCreating = exports.bigQueryDatasetCreated = exports.arrayFieldInvalid = exports.logger = void 0;
+const firestore_bigquery_change_tracker_1 = require("@firebaseextensions/firestore-bigquery-change-tracker");
+exports.logger = new firestore_bigquery_change_tracker_1.Logger();
+const arrayFieldInvalid = (fieldName) => {
+    exports.logger.warn(`Array field '${fieldName}' does not contain an array, skipping`);
+};
+exports.arrayFieldInvalid = arrayFieldInvalid;
+const bigQueryDatasetCreated = (datasetId) => {
+    exports.logger.info(`Created BigQuery dataset: ${datasetId}`);
+};
+exports.bigQueryDatasetCreated = bigQueryDatasetCreated;
+const bigQueryDatasetCreating = (datasetId) => {
+    exports.logger.debug(`Creating BigQuery dataset: ${datasetId}`);
+};
+exports.bigQueryDatasetCreating = bigQueryDatasetCreating;
+const bigQueryDatasetExists = (datasetId) => {
+    exports.logger.info(`BigQuery dataset already exists: ${datasetId}`);
+};
+exports.bigQueryDatasetExists = bigQueryDatasetExists;
+const bigQueryErrorRecordingDocumentChange = (e) => {
+    exports.logger.error(`Error recording document changes.`, e);
+};
+exports.bigQueryErrorRecordingDocumentChange = bigQueryErrorRecordingDocumentChange;
+const bigQueryLatestSnapshotViewQueryCreated = (query) => {
+    exports.logger.info(`BigQuery latest snapshot view query:\n${query}`);
+};
+exports.bigQueryLatestSnapshotViewQueryCreated = bigQueryLatestSnapshotViewQueryCreated;
+const bigQueryTableAlreadyExists = (tableName, datasetName) => {
+    exports.logger.info(`BigQuery table with name ${tableName} already ` +
+        `exists in dataset ${datasetName}!`);
+};
+exports.bigQueryTableAlreadyExists = bigQueryTableAlreadyExists;
+const bigQueryTableCreated = (tableName) => {
+    exports.logger.info(`Created BigQuery table: ${tableName}`);
+};
+exports.bigQueryTableCreated = bigQueryTableCreated;
+const bigQueryTableCreating = (tableName) => {
+    exports.logger.debug(`Creating BigQuery table: ${tableName}`);
+};
+exports.bigQueryTableCreating = bigQueryTableCreating;
+const bigQueryTableUpdated = (tableName) => {
+    exports.logger.info(`Updated existing BigQuery table: ${tableName}`);
+};
+exports.bigQueryTableUpdated = bigQueryTableUpdated;
+const bigQueryTableUpdating = (tableName) => {
+    exports.logger.debug(`Updating existing BigQuery table: ${tableName}`);
+};
+exports.bigQueryTableUpdating = bigQueryTableUpdating;
+const bigQueryTableUpToDate = (tableName) => {
+    exports.logger.info(`BigQuery table: ${tableName} is up to date`);
+};
+exports.bigQueryTableUpToDate = bigQueryTableUpToDate;
+const bigQueryTableValidated = (tableName) => {
+    exports.logger.info(`Validated existing BigQuery table: ${tableName}`);
+};
+exports.bigQueryTableValidated = bigQueryTableValidated;
+const bigQueryTableValidating = (tableName) => {
+    exports.logger.debug(`Validating existing BigQuery table: ${tableName}`);
+};
+exports.bigQueryTableValidating = bigQueryTableValidating;
+const bigQueryUserDefinedFunctionCreating = (functionDefinition) => {
+    exports.logger.debug(`Creating BigQuery User-defined Function:\n${functionDefinition}`);
+};
+exports.bigQueryUserDefinedFunctionCreating = bigQueryUserDefinedFunctionCreating;
+const bigQueryUserDefinedFunctionCreated = (functionDefinition) => {
+    exports.logger.info(`Created BigQuery User-defined Function:\n${functionDefinition}`);
+};
+exports.bigQueryUserDefinedFunctionCreated = bigQueryUserDefinedFunctionCreated;
+const bigQueryViewCreated = (viewName) => {
+    exports.logger.info(`Created BigQuery view: ${viewName}`);
+};
+exports.bigQueryViewCreated = bigQueryViewCreated;
+const bigQueryViewCreating = (viewName) => {
+    exports.logger.debug(`Creating BigQuery view: ${viewName}`);
+};
+exports.bigQueryViewCreating = bigQueryViewCreating;
+const bigQueryViewAlreadyExists = (viewName, datasetName) => {
+    exports.logger.info(`View with id ${viewName} already exists in dataset ${datasetName}.`);
+};
+exports.bigQueryViewAlreadyExists = bigQueryViewAlreadyExists;
+const bigQueryViewUpdated = (viewName) => {
+    exports.logger.info(`Updated existing BigQuery view: ${viewName}`);
+};
+exports.bigQueryViewUpdated = bigQueryViewUpdated;
+const bigQueryViewUpdating = (viewName) => {
+    exports.logger.debug(`Updating existing BigQuery view: ${viewName}`);
+};
+exports.bigQueryViewUpdating = bigQueryViewUpdating;
+const bigQueryViewUpToDate = (viewName) => {
+    exports.logger.info(`BigQuery view: ${viewName} is up to date`);
+};
+exports.bigQueryViewUpToDate = bigQueryViewUpToDate;
+const bigQueryViewValidated = (viewName) => {
+    exports.logger.info(`Validated existing BigQuery view: ${viewName}`);
+};
+exports.bigQueryViewValidated = bigQueryViewValidated;
+const bigQueryViewValidating = (viewName) => {
+    exports.logger.debug(`Validating existing BigQuery view: ${viewName}`);
+};
+exports.bigQueryViewValidating = bigQueryViewValidating;
+const complete = () => {
+    exports.logger.info("Completed execution of extension");
+};
+exports.complete = complete;
+const dataInserted = (rowCount) => {
+    exports.logger.debug(`Inserted ${rowCount} row(s) of data into BigQuery`);
+};
+exports.dataInserted = dataInserted;
+const dataInserting = (rowCount) => {
+    exports.logger.debug(`Inserting ${rowCount} row(s) of data into BigQuery`);
+};
+exports.dataInserting = dataInserting;
+const dataTypeInvalid = (fieldName, fieldType, dataType) => {
+    exports.logger.warn(`Field '${fieldName}' has invalid data. Expected: ${fieldType}, received: ${dataType}`);
+};
+exports.dataTypeInvalid = dataTypeInvalid;
+const error = (includeEvent, message, err, event, // Made optional, as it is not always required
+eventTrackerConfig // Made optional, as it is not always required
+) => {
+    const logDetails = { error: err };
+    if (includeEvent && event) {
+        logDetails.event = event;
+    }
+    if (includeEvent && eventTrackerConfig) {
+        logDetails.eventTrackerConfig = eventTrackerConfig;
+    }
+    exports.logger.error(`Error when mirroring data to BigQuery: ${message}`, logDetails);
+};
+exports.error = error;
+const init = (config) => {
+    exports.logger.info("Initializing with configuration", config);
+};
+exports.init = init;
+const start = (config) => {
+    exports.logger.info("Started execution with configuration", config);
+};
+exports.start = start;
+const timestampMissingValue = (fieldName) => {
+    exports.logger.warn(`Missing value for timestamp field: ${fieldName}, using default timestamp instead.`);
+};
+exports.timestampMissingValue = timestampMissingValue;
+const logEventAction = (action, document_name, event_id, operation) => {
+    exports.logger.info(action, {
+        document_name,
+        event_id,
+        operation,
+    });
+};
+exports.logEventAction = logEventAction;
+const logFailedEventAction = (action, document_name, event_id, operation, error) => {
+    const changeTypeMap = {
+        0: "CREATE",
+        1: "DELETE",
+        2: "UPDATE",
+        3: "IMPORT",
+    };
+    exports.logger.error(action, {
+        document_name,
+        event_id,
+        operation: changeTypeMap[operation],
+        error,
+    });
+};
+exports.logFailedEventAction = logFailedEventAction;
+const failedToWriteToBigQueryImmediately = (error) => {
+    exports.logger.warn("Failed to write event to BigQuery Immediately. Will attempt to Enqueue to Cloud Tasks.", error);
+};
+exports.failedToWriteToBigQueryImmediately = failedToWriteToBigQueryImmediately;
+//# 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,6GAG+D;AAElD,QAAA,MAAM,GAAG,IAAI,0CAAM,EAAE,CAAC;AAE5B,MAAM,iBAAiB,GAAG,CAAC,SAAiB,EAAE,EAAE;IACrD,QAAA,MAAM,CAAC,IAAI,CAAC,gBAAgB,SAAS,uCAAuC,CAAC,CAAC;AAChF,CAAC,CAAC;AAFW,QAAA,iBAAiB,GAAjB,iBAAiB,CAE5B;AAEK,MAAM,sBAAsB,GAAG,CAAC,SAAiB,EAAE,EAAE;IAC1D,QAAA,MAAM,CAAC,IAAI,CAAC,6BAA6B,SAAS,EAAE,CAAC,CAAC;AACxD,CAAC,CAAC;AAFW,QAAA,sBAAsB,GAAtB,sBAAsB,CAEjC;AAEK,MAAM,uBAAuB,GAAG,CAAC,SAAiB,EAAE,EAAE;IAC3D,QAAA,MAAM,CAAC,KAAK,CAAC,8BAA8B,SAAS,EAAE,CAAC,CAAC;AAC1D,CAAC,CAAC;AAFW,QAAA,uBAAuB,GAAvB,uBAAuB,CAElC;AAEK,MAAM,qBAAqB,GAAG,CAAC,SAAiB,EAAE,EAAE;IACzD,QAAA,MAAM,CAAC,IAAI,CAAC,oCAAoC,SAAS,EAAE,CAAC,CAAC;AAC/D,CAAC,CAAC;AAFW,QAAA,qBAAqB,GAArB,qBAAqB,CAEhC;AAEK,MAAM,oCAAoC,GAAG,CAAC,CAAQ,EAAE,EAAE;IAC/D,QAAA,MAAM,CAAC,KAAK,CAAC,mCAAmC,EAAE,CAAC,CAAC,CAAC;AACvD,CAAC,CAAC;AAFW,QAAA,oCAAoC,GAApC,oCAAoC,CAE/C;AAEK,MAAM,sCAAsC,GAAG,CAAC,KAAa,EAAE,EAAE;IACtE,QAAA,MAAM,CAAC,IAAI,CAAC,yCAAyC,KAAK,EAAE,CAAC,CAAC;AAChE,CAAC,CAAC;AAFW,QAAA,sCAAsC,GAAtC,sCAAsC,CAEjD;AAEK,MAAM,0BAA0B,GAAG,CACxC,SAAiB,EACjB,WAAmB,EACnB,EAAE;IACF,QAAA,MAAM,CAAC,IAAI,CACT,4BAA4B,SAAS,WAAW;QAC9C,qBAAqB,WAAW,GAAG,CACtC,CAAC;AACJ,CAAC,CAAC;AARW,QAAA,0BAA0B,GAA1B,0BAA0B,CAQrC;AAEK,MAAM,oBAAoB,GAAG,CAAC,SAAiB,EAAE,EAAE;IACxD,QAAA,MAAM,CAAC,IAAI,CAAC,2BAA2B,SAAS,EAAE,CAAC,CAAC;AACtD,CAAC,CAAC;AAFW,QAAA,oBAAoB,GAApB,oBAAoB,CAE/B;AAEK,MAAM,qBAAqB,GAAG,CAAC,SAAiB,EAAE,EAAE;IACzD,QAAA,MAAM,CAAC,KAAK,CAAC,4BAA4B,SAAS,EAAE,CAAC,CAAC;AACxD,CAAC,CAAC;AAFW,QAAA,qBAAqB,GAArB,qBAAqB,CAEhC;AAEK,MAAM,oBAAoB,GAAG,CAAC,SAAiB,EAAE,EAAE;IACxD,QAAA,MAAM,CAAC,IAAI,CAAC,oCAAoC,SAAS,EAAE,CAAC,CAAC;AAC/D,CAAC,CAAC;AAFW,QAAA,oBAAoB,GAApB,oBAAoB,CAE/B;AAEK,MAAM,qBAAqB,GAAG,CAAC,SAAiB,EAAE,EAAE;IACzD,QAAA,MAAM,CAAC,KAAK,CAAC,qCAAqC,SAAS,EAAE,CAAC,CAAC;AACjE,CAAC,CAAC;AAFW,QAAA,qBAAqB,GAArB,qBAAqB,CAEhC;AAEK,MAAM,qBAAqB,GAAG,CAAC,SAAiB,EAAE,EAAE;IACzD,QAAA,MAAM,CAAC,IAAI,CAAC,mBAAmB,SAAS,gBAAgB,CAAC,CAAC;AAC5D,CAAC,CAAC;AAFW,QAAA,qBAAqB,GAArB,qBAAqB,CAEhC;AAEK,MAAM,sBAAsB,GAAG,CAAC,SAAiB,EAAE,EAAE;IAC1D,QAAA,MAAM,CAAC,IAAI,CAAC,sCAAsC,SAAS,EAAE,CAAC,CAAC;AACjE,CAAC,CAAC;AAFW,QAAA,sBAAsB,GAAtB,sBAAsB,CAEjC;AAEK,MAAM,uBAAuB,GAAG,CAAC,SAAiB,EAAE,EAAE;IAC3D,QAAA,MAAM,CAAC,KAAK,CAAC,uCAAuC,SAAS,EAAE,CAAC,CAAC;AACnE,CAAC,CAAC;AAFW,QAAA,uBAAuB,GAAvB,uBAAuB,CAElC;AAEK,MAAM,mCAAmC,GAAG,CACjD,kBAA0B,EAC1B,EAAE;IACF,QAAA,MAAM,CAAC,KAAK,CACV,6CAA6C,kBAAkB,EAAE,CAClE,CAAC;AACJ,CAAC,CAAC;AANW,QAAA,mCAAmC,GAAnC,mCAAmC,CAM9C;AAEK,MAAM,kCAAkC,GAAG,CAChD,kBAA0B,EAC1B,EAAE;IACF,QAAA,MAAM,CAAC,IAAI,CAAC,4CAA4C,kBAAkB,EAAE,CAAC,CAAC;AAChF,CAAC,CAAC;AAJW,QAAA,kCAAkC,GAAlC,kCAAkC,CAI7C;AAEK,MAAM,mBAAmB,GAAG,CAAC,QAAgB,EAAE,EAAE;IACtD,QAAA,MAAM,CAAC,IAAI,CAAC,0BAA0B,QAAQ,EAAE,CAAC,CAAC;AACpD,CAAC,CAAC;AAFW,QAAA,mBAAmB,GAAnB,mBAAmB,CAE9B;AAEK,MAAM,oBAAoB,GAAG,CAAC,QAAgB,EAAE,EAAE;IACvD,QAAA,MAAM,CAAC,KAAK,CAAC,2BAA2B,QAAQ,EAAE,CAAC,CAAC;AACtD,CAAC,CAAC;AAFW,QAAA,oBAAoB,GAApB,oBAAoB,CAE/B;AAEK,MAAM,yBAAyB,GAAG,CACvC,QAAgB,EAChB,WAAmB,EACnB,EAAE;IACF,QAAA,MAAM,CAAC,IAAI,CACT,gBAAgB,QAAQ,8BAA8B,WAAW,GAAG,CACrE,CAAC;AACJ,CAAC,CAAC;AAPW,QAAA,yBAAyB,GAAzB,yBAAyB,CAOpC;AAEK,MAAM,mBAAmB,GAAG,CAAC,QAAgB,EAAE,EAAE;IACtD,QAAA,MAAM,CAAC,IAAI,CAAC,mCAAmC,QAAQ,EAAE,CAAC,CAAC;AAC7D,CAAC,CAAC;AAFW,QAAA,mBAAmB,GAAnB,mBAAmB,CAE9B;AAEK,MAAM,oBAAoB,GAAG,CAAC,QAAgB,EAAE,EAAE;IACvD,QAAA,MAAM,CAAC,KAAK,CAAC,oCAAoC,QAAQ,EAAE,CAAC,CAAC;AAC/D,CAAC,CAAC;AAFW,QAAA,oBAAoB,GAApB,oBAAoB,CAE/B;AAEK,MAAM,oBAAoB,GAAG,CAAC,QAAgB,EAAE,EAAE;IACvD,QAAA,MAAM,CAAC,IAAI,CAAC,kBAAkB,QAAQ,gBAAgB,CAAC,CAAC;AAC1D,CAAC,CAAC;AAFW,QAAA,oBAAoB,GAApB,oBAAoB,CAE/B;AAEK,MAAM,qBAAqB,GAAG,CAAC,QAAgB,EAAE,EAAE;IACxD,QAAA,MAAM,CAAC,IAAI,CAAC,qCAAqC,QAAQ,EAAE,CAAC,CAAC;AAC/D,CAAC,CAAC;AAFW,QAAA,qBAAqB,GAArB,qBAAqB,CAEhC;AAEK,MAAM,sBAAsB,GAAG,CAAC,QAAgB,EAAE,EAAE;IACzD,QAAA,MAAM,CAAC,KAAK,CAAC,sCAAsC,QAAQ,EAAE,CAAC,CAAC;AACjE,CAAC,CAAC;AAFW,QAAA,sBAAsB,GAAtB,sBAAsB,CAEjC;AAEK,MAAM,QAAQ,GAAG,GAAG,EAAE;IAC3B,QAAA,MAAM,CAAC,IAAI,CAAC,kCAAkC,CAAC,CAAC;AAClD,CAAC,CAAC;AAFW,QAAA,QAAQ,GAAR,QAAQ,CAEnB;AAEK,MAAM,YAAY,GAAG,CAAC,QAAgB,EAAE,EAAE;IAC/C,QAAA,MAAM,CAAC,KAAK,CAAC,YAAY,QAAQ,+BAA+B,CAAC,CAAC;AACpE,CAAC,CAAC;AAFW,QAAA,YAAY,GAAZ,YAAY,CAEvB;AAEK,MAAM,aAAa,GAAG,CAAC,QAAgB,EAAE,EAAE;IAChD,QAAA,MAAM,CAAC,KAAK,CAAC,aAAa,QAAQ,+BAA+B,CAAC,CAAC;AACrE,CAAC,CAAC;AAFW,QAAA,aAAa,GAAb,aAAa,CAExB;AAEK,MAAM,eAAe,GAAG,CAC7B,SAAiB,EACjB,SAAiB,EACjB,QAAgB,EAChB,EAAE;IACF,QAAA,MAAM,CAAC,IAAI,CACT,UAAU,SAAS,iCAAiC,SAAS,eAAe,QAAQ,EAAE,CACvF,CAAC;AACJ,CAAC,CAAC;AARW,QAAA,eAAe,GAAf,eAAe,CAQ1B;AAEK,MAAM,KAAK,GAAG,CACnB,YAAqB,EACrB,OAAe,EACf,GAAU,EACV,KAAW,EAAE,8CAA8C;AAC3D,kBAAwB,CAAC,8CAA8C;EACvE,EAAE;IACF,MAAM,UAAU,GAAwB,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC;IAEvD,IAAI,YAAY,IAAI,KAAK,EAAE,CAAC;QAC1B,UAAU,CAAC,KAAK,GAAG,KAAK,CAAC;IAC3B,CAAC;IAED,IAAI,YAAY,IAAI,kBAAkB,EAAE,CAAC;QACvC,UAAU,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;IACrD,CAAC;IAED,QAAA,MAAM,CAAC,KAAK,CAAC,0CAA0C,OAAO,EAAE,EAAE,UAAU,CAAC,CAAC;AAChF,CAAC,CAAC;AAlBW,QAAA,KAAK,GAAL,KAAK,CAkBhB;AAEK,MAAM,IAAI,GAAG,CAAC,MAAgB,EAAE,EAAE;IACvC,QAAA,MAAM,CAAC,IAAI,CAAC,iCAAiC,EAAE,MAAM,CAAC,CAAC;AACzD,CAAC,CAAC;AAFW,QAAA,IAAI,GAAJ,IAAI,CAEf;AAEK,MAAM,KAAK,GAAG,CAAC,MAAgB,EAAE,EAAE;IACxC,QAAA,MAAM,CAAC,IAAI,CAAC,sCAAsC,EAAE,MAAM,CAAC,CAAC;AAC9D,CAAC,CAAC;AAFW,QAAA,KAAK,GAAL,KAAK,CAEhB;AAEK,MAAM,qBAAqB,GAAG,CAAC,SAAiB,EAAE,EAAE;IACzD,QAAA,MAAM,CAAC,IAAI,CACT,sCAAsC,SAAS,oCAAoC,CACpF,CAAC;AACJ,CAAC,CAAC;AAJW,QAAA,qBAAqB,GAArB,qBAAqB,CAIhC;AAEK,MAAM,cAAc,GAAG,CAC5B,MAAc,EACd,aAAqB,EACrB,QAAgB,EAChB,SAAqB,EACrB,EAAE;IACF,QAAA,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE;QAClB,aAAa;QACb,QAAQ;QACR,SAAS;KACV,CAAC,CAAC;AACL,CAAC,CAAC;AAXW,QAAA,cAAc,GAAd,cAAc,CAWzB;AAEK,MAAM,oBAAoB,GAAG,CAClC,MAAc,EACd,aAAqB,EACrB,QAAgB,EAChB,SAAqB,EACrB,KAAY,EACZ,EAAE;IACF,MAAM,aAAa,GAAG;QACpB,CAAC,EAAE,QAAQ;QACX,CAAC,EAAE,QAAQ;QACX,CAAC,EAAE,QAAQ;QACX,CAAC,EAAE,QAAQ;KACZ,CAAC;IAEF,QAAA,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE;QACnB,aAAa;QACb,QAAQ;QACR,SAAS,EAAE,aAAa,CAAC,SAAS,CAAC;QACnC,KAAK;KACN,CAAC,CAAC;AACL,CAAC,CAAC;AApBW,QAAA,oBAAoB,GAApB,oBAAoB,CAoB/B;AAEK,MAAM,kCAAkC,GAAG,CAAC,KAAY,EAAE,EAAE;IACjE,QAAA,MAAM,CAAC,IAAI,CACT,wFAAwF,EACxF,KAAK,CACN,CAAC;AACJ,CAAC,CAAC;AALW,QAAA,kCAAkC,GAAlC,kCAAkC,CAK7C"}

package/lib/util.d.ts

@@ -0,0 +1,23 @@
+import { ChangeType } from "@firebaseextensions/firestore-bigquery-change-tracker";
+import type { Change, DocumentSnapshot } from "firebase-functions/firestore";
+/**
+ * Get the change type (CREATE, UPDATE, DELETE) from the Firestore change.
+ * @param change Firestore document change object.
+ * @returns {ChangeType} The type of change.
+ */
+export declare function getChangeType(change: Change<DocumentSnapshot>): ChangeType;
+/**
+ * Get the document ID from the Firestore change.
+ * @param change Firestore document change object.
+ * @returns {string} The document ID.
+ */
+export declare function getDocumentId(change: Change<DocumentSnapshot>): string;
+/**
+ *
+ * @param template - eg, regions/{regionId}/countries
+ * @param text - eg, regions/asia/countries
+ *
+ * @return - eg, { regionId: "asia" }
+ */
+export declare const resolveWildcardIds: (template: string, text: string) => {};
+//# sourceMappingURL=util.d.ts.map

package/lib/util.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,UAAU,EAAE,MAAM,uDAAuD,CAAC;AACnF,OAAO,KAAK,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAE7E;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAQ1E;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,CAAC,gBAAgB,CAAC,GAAG,MAAM,CAKtE;AAED;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,aAAc,MAAM,QAAQ,MAAM,OAUhE,CAAC"}