@firebase-function-kits/delete-user-data 0.0.1 → 0.0.2-rc.0

package/lib/logs.js

@@ -0,0 +1,116 @@
+"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.customFunctionError = exports.storagePathError = exports.storagePath404 = exports.storagePathDeleting = exports.storagePathDeleted = exports.storageNotConfigured = exports.storageDeleting = exports.storageDeleted = exports.start = exports.rtdbPathError = exports.rtdbPathDeleting = exports.rtdbNotConfigured = exports.rtdbPathDeleted = exports.rtdbDeleting = exports.rtdbDeleted = exports.init = exports.firestorePathError = exports.firestorePathDeleting = exports.firestorePathDeleted = exports.firestoreNotConfigured = exports.firestoreDeleting = exports.firestoreDeleted = exports.complete = void 0;
+exports.warnInvalidPaths = warnInvalidPaths;
+const firebase_functions_1 = require("firebase-functions");
+const complete = (uid) => {
+    firebase_functions_1.logger.log(`Successfully removed data for user: ${uid}`);
+};
+exports.complete = complete;
+const firestoreDeleted = () => {
+    firebase_functions_1.logger.log("Finished deleting user data from Cloud Firestore");
+};
+exports.firestoreDeleted = firestoreDeleted;
+const firestoreDeleting = () => {
+    firebase_functions_1.logger.log("Deleting user data from Cloud Firestore");
+};
+exports.firestoreDeleting = firestoreDeleting;
+const firestoreNotConfigured = () => {
+    firebase_functions_1.logger.log("Cloud Firestore paths are not configured, skipping");
+};
+exports.firestoreNotConfigured = firestoreNotConfigured;
+const firestorePathDeleted = (path, recursive) => {
+    firebase_functions_1.logger.log(`Deleted: '${path}' from Cloud Firestore ${recursive ? "with recursive delete" : ""}`);
+};
+exports.firestorePathDeleted = firestorePathDeleted;
+const firestorePathDeleting = (path, recursive) => {
+    firebase_functions_1.logger.log(`Deleting: '${path}' from Cloud Firestore ${recursive ? "with recursive delete" : ""}`);
+};
+exports.firestorePathDeleting = firestorePathDeleting;
+const firestorePathError = (path, err) => {
+    firebase_functions_1.logger.error(`Error when deleting: '${path}' from Cloud Firestore`, err);
+};
+exports.firestorePathError = firestorePathError;
+const init = (config) => {
+    firebase_functions_1.logger.log("Initializing extension with configuration", config);
+};
+exports.init = init;
+const rtdbDeleted = () => {
+    firebase_functions_1.logger.log("Finished deleting user data from the Realtime Database");
+};
+exports.rtdbDeleted = rtdbDeleted;
+const rtdbDeleting = () => {
+    firebase_functions_1.logger.log("Deleting user data from the Realtime Database");
+};
+exports.rtdbDeleting = rtdbDeleting;
+const rtdbPathDeleted = (path) => {
+    firebase_functions_1.logger.log(`Deleted: '${path}' from the Realtime Database`);
+};
+exports.rtdbPathDeleted = rtdbPathDeleted;
+const rtdbNotConfigured = () => {
+    firebase_functions_1.logger.log("Realtime Database paths are not configured, skipping");
+};
+exports.rtdbNotConfigured = rtdbNotConfigured;
+const rtdbPathDeleting = (path) => {
+    firebase_functions_1.logger.log(`Deleting: '${path}' from the Realtime Database`);
+};
+exports.rtdbPathDeleting = rtdbPathDeleting;
+const rtdbPathError = (path, err) => {
+    firebase_functions_1.logger.error(`Error when deleting: '${path}' from the Realtime Database`, err);
+};
+exports.rtdbPathError = rtdbPathError;
+const start = (config) => {
+    firebase_functions_1.logger.log("Started extension execution with configuration", config);
+};
+exports.start = start;
+const storageDeleted = () => {
+    firebase_functions_1.logger.log("Finished deleting user data from Cloud Storage");
+};
+exports.storageDeleted = storageDeleted;
+const storageDeleting = () => {
+    firebase_functions_1.logger.log("Deleting user data from Cloud Storage");
+};
+exports.storageDeleting = storageDeleting;
+const storageNotConfigured = () => {
+    firebase_functions_1.logger.log("Cloud Storage paths are not configured, skipping");
+};
+exports.storageNotConfigured = storageNotConfigured;
+const storagePathDeleted = (path) => {
+    firebase_functions_1.logger.log(`Deleted: '${path}' from Cloud Storage`);
+};
+exports.storagePathDeleted = storagePathDeleted;
+const storagePathDeleting = (path) => {
+    firebase_functions_1.logger.log(`Deleting: '${path}' from Cloud Storage`);
+};
+exports.storagePathDeleting = storagePathDeleting;
+const storagePath404 = (path) => {
+    firebase_functions_1.logger.log(`File: '${path}' does not exist in Cloud Storage, skipping`);
+};
+exports.storagePath404 = storagePath404;
+const storagePathError = (path, err) => {
+    firebase_functions_1.logger.error(`Error deleting: '${path}' from Cloud Storage`, err);
+};
+exports.storagePathError = storagePathError;
+const customFunctionError = (err) => {
+    firebase_functions_1.logger.error(`Call to custom hook function threw an error`, err);
+};
+exports.customFunctionError = customFunctionError;
+function warnInvalidPaths(invalidPathCount, uid) {
+    firebase_functions_1.logger.warn(`Attempted to delete ${invalidPathCount} invalid paths for deleted user ${uid}`);
+}
+//# 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;AAGrC,MAAM,QAAQ,GAAG,CAAC,GAAW,EAAE,EAAE;IACtC,2BAAM,CAAC,GAAG,CAAC,uCAAuC,GAAG,EAAE,CAAC,CAAC;AAC3D,CAAC,CAAC;AAFW,QAAA,QAAQ,GAAR,QAAQ,CAEnB;AAEK,MAAM,gBAAgB,GAAG,GAAG,EAAE;IACnC,2BAAM,CAAC,GAAG,CAAC,kDAAkD,CAAC,CAAC;AACjE,CAAC,CAAC;AAFW,QAAA,gBAAgB,GAAhB,gBAAgB,CAE3B;AAEK,MAAM,iBAAiB,GAAG,GAAG,EAAE;IACpC,2BAAM,CAAC,GAAG,CAAC,yCAAyC,CAAC,CAAC;AACxD,CAAC,CAAC;AAFW,QAAA,iBAAiB,GAAjB,iBAAiB,CAE5B;AAEK,MAAM,sBAAsB,GAAG,GAAG,EAAE;IACzC,2BAAM,CAAC,GAAG,CAAC,oDAAoD,CAAC,CAAC;AACnE,CAAC,CAAC;AAFW,QAAA,sBAAsB,GAAtB,sBAAsB,CAEjC;AAEK,MAAM,oBAAoB,GAAG,CAAC,IAAY,EAAE,SAAkB,EAAE,EAAE;IACvE,2BAAM,CAAC,GAAG,CACR,aAAa,IAAI,0BACf,SAAS,CAAC,CAAC,CAAC,uBAAuB,CAAC,CAAC,CAAC,EACxC,EAAE,CACH,CAAC;AACJ,CAAC,CAAC;AANW,QAAA,oBAAoB,GAApB,oBAAoB,CAM/B;AAEK,MAAM,qBAAqB,GAAG,CAAC,IAAY,EAAE,SAAkB,EAAE,EAAE;IACxE,2BAAM,CAAC,GAAG,CACR,cAAc,IAAI,0BAChB,SAAS,CAAC,CAAC,CAAC,uBAAuB,CAAC,CAAC,CAAC,EACxC,EAAE,CACH,CAAC;AACJ,CAAC,CAAC;AANW,QAAA,qBAAqB,GAArB,qBAAqB,CAMhC;AAEK,MAAM,kBAAkB,GAAG,CAAC,IAAY,EAAE,GAAU,EAAE,EAAE;IAC7D,2BAAM,CAAC,KAAK,CAAC,yBAAyB,IAAI,wBAAwB,EAAE,GAAG,CAAC,CAAC;AAC3E,CAAC,CAAC;AAFW,QAAA,kBAAkB,GAAlB,kBAAkB,CAE7B;AAEK,MAAM,IAAI,GAAG,CAAC,MAAoC,EAAE,EAAE;IAC3D,2BAAM,CAAC,GAAG,CAAC,2CAA2C,EAAE,MAAM,CAAC,CAAC;AAClE,CAAC,CAAC;AAFW,QAAA,IAAI,GAAJ,IAAI,CAEf;AAEK,MAAM,WAAW,GAAG,GAAG,EAAE;IAC9B,2BAAM,CAAC,GAAG,CAAC,wDAAwD,CAAC,CAAC;AACvE,CAAC,CAAC;AAFW,QAAA,WAAW,GAAX,WAAW,CAEtB;AAEK,MAAM,YAAY,GAAG,GAAG,EAAE;IAC/B,2BAAM,CAAC,GAAG,CAAC,+CAA+C,CAAC,CAAC;AAC9D,CAAC,CAAC;AAFW,QAAA,YAAY,GAAZ,YAAY,CAEvB;AAEK,MAAM,eAAe,GAAG,CAAC,IAAY,EAAE,EAAE;IAC9C,2BAAM,CAAC,GAAG,CAAC,aAAa,IAAI,8BAA8B,CAAC,CAAC;AAC9D,CAAC,CAAC;AAFW,QAAA,eAAe,GAAf,eAAe,CAE1B;AAEK,MAAM,iBAAiB,GAAG,GAAG,EAAE;IACpC,2BAAM,CAAC,GAAG,CAAC,sDAAsD,CAAC,CAAC;AACrE,CAAC,CAAC;AAFW,QAAA,iBAAiB,GAAjB,iBAAiB,CAE5B;AAEK,MAAM,gBAAgB,GAAG,CAAC,IAAY,EAAE,EAAE;IAC/C,2BAAM,CAAC,GAAG,CAAC,cAAc,IAAI,8BAA8B,CAAC,CAAC;AAC/D,CAAC,CAAC;AAFW,QAAA,gBAAgB,GAAhB,gBAAgB,CAE3B;AAEK,MAAM,aAAa,GAAG,CAAC,IAAY,EAAE,GAAU,EAAE,EAAE;IACxD,2BAAM,CAAC,KAAK,CACV,yBAAyB,IAAI,8BAA8B,EAC3D,GAAG,CACJ,CAAC;AACJ,CAAC,CAAC;AALW,QAAA,aAAa,GAAb,aAAa,CAKxB;AAEK,MAAM,KAAK,GAAG,CAAC,MAAoC,EAAE,EAAE;IAC5D,2BAAM,CAAC,GAAG,CAAC,gDAAgD,EAAE,MAAM,CAAC,CAAC;AACvE,CAAC,CAAC;AAFW,QAAA,KAAK,GAAL,KAAK,CAEhB;AAEK,MAAM,cAAc,GAAG,GAAG,EAAE;IACjC,2BAAM,CAAC,GAAG,CAAC,gDAAgD,CAAC,CAAC;AAC/D,CAAC,CAAC;AAFW,QAAA,cAAc,GAAd,cAAc,CAEzB;AAEK,MAAM,eAAe,GAAG,GAAG,EAAE;IAClC,2BAAM,CAAC,GAAG,CAAC,uCAAuC,CAAC,CAAC;AACtD,CAAC,CAAC;AAFW,QAAA,eAAe,GAAf,eAAe,CAE1B;AAEK,MAAM,oBAAoB,GAAG,GAAG,EAAE;IACvC,2BAAM,CAAC,GAAG,CAAC,kDAAkD,CAAC,CAAC;AACjE,CAAC,CAAC;AAFW,QAAA,oBAAoB,GAApB,oBAAoB,CAE/B;AAEK,MAAM,kBAAkB,GAAG,CAAC,IAAY,EAAE,EAAE;IACjD,2BAAM,CAAC,GAAG,CAAC,aAAa,IAAI,sBAAsB,CAAC,CAAC;AACtD,CAAC,CAAC;AAFW,QAAA,kBAAkB,GAAlB,kBAAkB,CAE7B;AAEK,MAAM,mBAAmB,GAAG,CAAC,IAAY,EAAE,EAAE;IAClD,2BAAM,CAAC,GAAG,CAAC,cAAc,IAAI,sBAAsB,CAAC,CAAC;AACvD,CAAC,CAAC;AAFW,QAAA,mBAAmB,GAAnB,mBAAmB,CAE9B;AAEK,MAAM,cAAc,GAAG,CAAC,IAAY,EAAE,EAAE;IAC7C,2BAAM,CAAC,GAAG,CAAC,UAAU,IAAI,6CAA6C,CAAC,CAAC;AAC1E,CAAC,CAAC;AAFW,QAAA,cAAc,GAAd,cAAc,CAEzB;AAEK,MAAM,gBAAgB,GAAG,CAAC,IAAY,EAAE,GAAU,EAAE,EAAE;IAC3D,2BAAM,CAAC,KAAK,CAAC,oBAAoB,IAAI,sBAAsB,EAAE,GAAG,CAAC,CAAC;AACpE,CAAC,CAAC;AAFW,QAAA,gBAAgB,GAAhB,gBAAgB,CAE3B;AAEK,MAAM,mBAAmB,GAAG,CAAC,GAAU,EAAE,EAAE;IAChD,2BAAM,CAAC,KAAK,CAAC,6CAA6C,EAAE,GAAG,CAAC,CAAC;AACnE,CAAC,CAAC;AAFW,QAAA,mBAAmB,GAAnB,mBAAmB,CAE9B;AAEF,0BAAiC,gBAAwB,EAAE,GAAW;IACpE,2BAAM,CAAC,IAAI,CACT,uBAAuB,gBAAgB,mCAAmC,GAAG,EAAE,CAChF,CAAC;AACJ,CAAC"}

package/lib/recursiveDelete.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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 type * as admin from "firebase-admin";
+export declare const recursiveDelete: (path: string, db: admin.firestore.Firestore) => Promise<void>;
+//# sourceMappingURL=recursiveDelete.d.ts.map

package/lib/recursiveDelete.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"recursiveDelete.d.ts","sourceRoot":"","sources":["../src/recursiveDelete.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,KAAK,KAAK,KAAK,MAAM,gBAAgB,CAAC;AAI7C,eAAO,MAAM,eAAe,SACpB,MAAM,MACR,KAAK,CAAC,SAAS,CAAC,SAAS,kBAmB9B,CAAC"}

package/lib/recursiveDelete.js

@@ -0,0 +1,37 @@
+"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.recursiveDelete = void 0;
+const MAX_RETRY_ATTEMPTS = 3;
+const recursiveDelete = async (path, db) => {
+    // Recursively delete a reference and log the references of failures.
+    const bulkWriter = db.bulkWriter();
+    bulkWriter.onWriteError((error) => {
+        if (error.failedAttempts < MAX_RETRY_ATTEMPTS) {
+            return true;
+        }
+        else {
+            console.warn("Failed to delete document: ", error.documentRef.path);
+            return false;
+        }
+    });
+    const isDocument = path.split("/").length % 2 === 0;
+    const reference = isDocument ? db.doc(path) : db.collection(path);
+    await db.recursiveDelete(reference, bulkWriter);
+};
+exports.recursiveDelete = recursiveDelete;
+//# sourceMappingURL=recursiveDelete.js.map

package/lib/recursiveDelete.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"recursiveDelete.js","sourceRoot":"","sources":["../src/recursiveDelete.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAIH,MAAM,kBAAkB,GAAG,CAAC,CAAC;AAEtB,MAAM,eAAe,GAAG,KAAK,EAClC,IAAY,EACZ,EAA6B,EAC7B,EAAE;IACF,qEAAqE;IACrE,MAAM,UAAU,GAAG,EAAE,CAAC,UAAU,EAAE,CAAC;IAEnC,UAAU,CAAC,YAAY,CAAC,CAAC,KAAK,EAAE,EAAE;QAChC,IAAI,KAAK,CAAC,cAAc,GAAG,kBAAkB,EAAE,CAAC;YAC9C,OAAO,IAAI,CAAC;QACd,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,IAAI,CAAC,6BAA6B,EAAE,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;YACpE,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,GAAG,CAAC,KAAK,CAAC,CAAC;IAEpD,MAAM,SAAS,GAAG,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAElE,MAAM,EAAE,CAAC,eAAe,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;AAClD,CAAC,CAAC;AArBW,QAAA,eAAe,GAAf,eAAe,CAqB1B"}

package/lib/runBatchPubSubDeletions.d.ts

@@ -0,0 +1,27 @@
+/**
+ * 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 type { PubSub } from "@google-cloud/pubsub";
+import type { ResolvedDeleteUserDataConfig } from "./export-config";
+export interface DeletionPaths {
+    firestorePaths: string[];
+}
+export interface PublisherContext {
+    pubsub: PubSub;
+    config: ResolvedDeleteUserDataConfig;
+}
+export declare function publishSearch(uid: string, depth: number, path: string, ctx: PublisherContext): Promise<void>;
+export declare function runBatchPubSubDeletions(paths: DeletionPaths, uid: string, ctx: PublisherContext): Promise<void>;
+//# sourceMappingURL=runBatchPubSubDeletions.d.ts.map

package/lib/runBatchPubSubDeletions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"runBatchPubSubDeletions.d.ts","sourceRoot":"","sources":["../src/runBatchPubSubDeletions.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAEnD,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,iBAAiB,CAAC;AAEpE,MAAM,WAAW,aAAa;IAC5B,cAAc,EAAE,MAAM,EAAE,CAAC;CAC1B;AAED,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,4BAA4B,CAAC;CACtC;AAaD,wBAAsB,aAAa,CACjC,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,MAAM,EACZ,GAAG,EAAE,gBAAgB,GACpB,OAAO,CAAC,IAAI,CAAC,CAIf;AAED,wBAAsB,uBAAuB,CAC3C,KAAK,EAAE,aAAa,EACpB,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,gBAAgB,GACpB,OAAO,CAAC,IAAI,CAAC,CAUf"}

package/lib/runBatchPubSubDeletions.js

@@ -0,0 +1,47 @@
+"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.
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.publishSearch = publishSearch;
+exports.runBatchPubSubDeletions = runBatchPubSubDeletions;
+const lodash_chunk_1 = __importDefault(require("lodash.chunk"));
+function topicPath(config, topicName) {
+    const projectId = config.projectId ??
+        process.env.GOOGLE_CLOUD_PROJECT ??
+        process.env.PROJECT_ID;
+    return projectId ? `projects/${projectId}/topics/${topicName}` : topicName;
+}
+async function publishSearch(uid, depth, path, ctx) {
+    await ctx.pubsub
+        .topic(topicPath(ctx.config, ctx.config.discoveryTopicName))
+        .publishMessage({ json: { path, uid, depth } });
+}
+async function runBatchPubSubDeletions(paths, uid, ctx) {
+    const { firestorePaths } = paths;
+    if (!firestorePaths || !Array.isArray(firestorePaths))
+        return;
+    if (firestorePaths.length === 0)
+        return;
+    for (const chunkedPaths of (0, lodash_chunk_1.default)(firestorePaths, 450)) {
+        await ctx.pubsub
+            .topic(topicPath(ctx.config, ctx.config.deletionTopicName))
+            .publishMessage({ json: { paths: chunkedPaths, uid } });
+    }
+}
+//# sourceMappingURL=runBatchPubSubDeletions.js.map

package/lib/runBatchPubSubDeletions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runBatchPubSubDeletions.js","sourceRoot":"","sources":["../src/runBatchPubSubDeletions.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;;;;;AAGH,gEAAiC;AAYjC,SAAS,SAAS,CAChB,MAAoC,EACpC,SAAiB;IAEjB,MAAM,SAAS,GACb,MAAM,CAAC,SAAS;QAChB,OAAO,CAAC,GAAG,CAAC,oBAAoB;QAChC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC;IACzB,OAAO,SAAS,CAAC,CAAC,CAAC,YAAY,SAAS,WAAW,SAAS,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;AAC7E,CAAC;AAEM,KAAK,wBACV,GAAW,EACX,KAAa,EACb,IAAY,EACZ,GAAqB;IAErB,MAAM,GAAG,CAAC,MAAM;SACb,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC;SAC3D,cAAc,CAAC,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;AACpD,CAAC;AAEM,KAAK,kCACV,KAAoB,EACpB,GAAW,EACX,GAAqB;IAErB,MAAM,EAAE,cAAc,EAAE,GAAG,KAAK,CAAC;IACjC,IAAI,CAAC,cAAc,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC;QAAE,OAAO;IAC9D,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO;IAExC,KAAK,MAAM,YAAY,IAAI,IAAA,sBAAK,EAAS,cAAc,EAAE,GAAG,CAAC,EAAE,CAAC;QAC9D,MAAM,GAAG,CAAC,MAAM;aACb,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC;aAC1D,cAAc,CAAC,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;IAC5D,CAAC;AACH,CAAC"}

package/lib/runCustomSearchFunction.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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 type { PublisherContext } from "./runBatchPubSubDeletions";
+export declare const runCustomSearchFunction: (uid: string, ctx: PublisherContext) => Promise<void>;
+//# sourceMappingURL=runCustomSearchFunction.d.ts.map

package/lib/runCustomSearchFunction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"runCustomSearchFunction.d.ts","sourceRoot":"","sources":["../src/runCustomSearchFunction.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAIH,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAGlE,eAAO,MAAM,uBAAuB,QAC7B,MAAM,OACN,gBAAgB,KACpB,OAAO,CAAC,IAAI,CAyBd,CAAC"}

package/lib/runCustomSearchFunction.js

@@ -0,0 +1,78 @@
+"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.
+ */
+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 __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runCustomSearchFunction = void 0;
+const node_fetch_1 = __importDefault(require("node-fetch"));
+const logs = __importStar(require("./logs"));
+const runBatchPubSubDeletions_1 = require("./runBatchPubSubDeletions");
+const runCustomSearchFunction = async (uid, ctx) => {
+    if (!ctx.config.searchFunction)
+        return;
+    const response = await (0, node_fetch_1.default)(ctx.config.searchFunction, {
+        method: "POST",
+        body: JSON.stringify({ uid }),
+        headers: { "Content-Type": "application/json" },
+    });
+    if (!response.ok) {
+        const body = await response.text();
+        logs.customFunctionError(new Error(body));
+        return;
+    }
+    const json = await response.json();
+    if (Array.isArray(json)) {
+        return (0, runBatchPubSubDeletions_1.runBatchPubSubDeletions)({ firestorePaths: json }, uid, ctx);
+    }
+    return (0, runBatchPubSubDeletions_1.runBatchPubSubDeletions)(json, uid, ctx);
+};
+exports.runCustomSearchFunction = runCustomSearchFunction;
+//# sourceMappingURL=runCustomSearchFunction.js.map

package/lib/runCustomSearchFunction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runCustomSearchFunction.js","sourceRoot":"","sources":["../src/runCustomSearchFunction.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,4DAA+B;AAC/B,MAAY,IAAI,mCAAe;AAE/B,uEAAoE;AAE7D,MAAM,uBAAuB,GAAG,KAAK,EAC1C,GAAW,EACX,GAAqB,EACN,EAAE;IACjB,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,cAAc;QAAE,OAAO;IAEvC,MAAM,QAAQ,GAAG,MAAM,IAAA,oBAAK,EAAC,GAAG,CAAC,MAAM,CAAC,cAAc,EAAE;QACtD,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,CAAC;QAC7B,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;KAChD,CAAC,CAAC;IAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACnC,IAAI,CAAC,mBAAmB,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;QAC1C,OAAO;IACT,CAAC;IAED,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;IACnC,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,OAAO,IAAA,iDAAuB,EAAC,EAAE,cAAc,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;IACrE,CAAC;IAED,OAAO,IAAA,iDAAuB,EAC5B,IAAoC,EACpC,GAAG,EACH,GAAG,CACJ,CAAC;AACJ,CAAC,CAAC;AA5BW,QAAA,uBAAuB,GAAvB,uBAAuB,CA4BlC"}

package/lib/search.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 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 type * as admin from "firebase-admin";
+import { type PublisherContext } from "./runBatchPubSubDeletions";
+export declare const search: (uid: string, depth: number, db: admin.firestore.Firestore, ctx: PublisherContext, document?: admin.firestore.DocumentReference<admin.firestore.DocumentData>) => Promise<void>;
+//# sourceMappingURL=search.d.ts.map

package/lib/search.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../src/search.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,KAAK,KAAK,KAAK,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EACL,KAAK,gBAAgB,EAEtB,MAAM,2BAA2B,CAAC;AAEnC,eAAO,MAAM,MAAM,QACZ,MAAM,SACJ,MAAM,MACT,KAAK,CAAC,SAAS,CAAC,SAAS,OACxB,gBAAgB,aACV,KAAK,CAAC,SAAS,CAAC,iBAAiB,CAAC,KAAK,CAAC,SAAS,CAAC,YAAY,CAAC,KACzE,OAAO,CAAC,IAAI,CAQd,CAAC"}

package/lib/search.js

@@ -0,0 +1,29 @@
+"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.search = void 0;
+const runBatchPubSubDeletions_1 = require("./runBatchPubSubDeletions");
+const search = async (uid, depth, db, ctx, document) => {
+    const collections = !document
+        ? await db.listCollections()
+        : await document.listCollections();
+    for (const collection of collections) {
+        await (0, runBatchPubSubDeletions_1.publishSearch)(uid, depth, collection.path, ctx);
+    }
+};
+exports.search = search;
+//# sourceMappingURL=search.js.map

package/lib/search.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"search.js","sourceRoot":"","sources":["../src/search.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAGH,uEAGmC;AAE5B,MAAM,MAAM,GAAG,KAAK,EACzB,GAAW,EACX,KAAa,EACb,EAA6B,EAC7B,GAAqB,EACrB,QAA0E,EAC3D,EAAE;IACjB,MAAM,WAAW,GAAG,CAAC,QAAQ;QAC3B,CAAC,CAAC,MAAM,EAAE,CAAC,eAAe,EAAE;QAC5B,CAAC,CAAC,MAAM,QAAQ,CAAC,eAAe,EAAE,CAAC;IAErC,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;QACrC,MAAM,IAAA,uCAAa,EAAC,GAAG,EAAE,KAAK,EAAE,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IACxD,CAAC;AACH,CAAC,CAAC;AAdW,QAAA,MAAM,GAAN,MAAM,CAcjB"}

package/package.json

@@ -1,12 +1,45 @@
 {
   "name": "@firebase-function-kits/delete-user-data",
-  "version": "0.0.1",
+  "version": "0.0.2-rc.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/firebase/extensions.git",
+    "directory": "kits/delete-user-data"
+  },
   "description": "Delete user data across Firestore, RTDB, and Storage on account deletion",
   "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": {
+    "@google-cloud/pubsub": "^4.3.3",
+    "firebase-admin": "^13.2.0",
+    "firebase-functions": "7.3.2",
+    "lodash.chunk": "^4.2.0",
+    "node-fetch": "^2.6.2"
+  },
+  "devDependencies": {
+    "@types/lodash.chunk": "^4.2.7",
+    "@types/node-fetch": "^2.6.2",
+    "vitest": "^4.1.10"
   }
 }

package/src/config.ts

@@ -0,0 +1,98 @@
+/**
+ * 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 {
+  defineBoolean,
+  defineInt,
+  defineString,
+  expr,
+  projectID,
+  select,
+  storageBucket,
+} from "firebase-functions/params";
+import type { DeleteUserDataConfig } from "./export-config";
+
+const instanceId = defineString("INSTANCE_ID");
+
+const params = {
+  instanceId,
+  firestorePaths: defineString("FIRESTORE_PATHS", { default: "" }),
+  firestoreDatabaseId: defineString("FIRESTORE_DATABASE_ID", {
+    default: "(default)",
+  }),
+  firestoreDeleteMode: defineString("FIRESTORE_DELETE_MODE", {
+    default: "shallow",
+    input: select(["recursive", "shallow"]),
+  }),
+  rtdbInstance: defineString("SELECTED_DATABASE_INSTANCE", { default: "" }),
+  rtdbLocation: defineString("SELECTED_DATABASE_LOCATION", {
+    default: "us-central1",
+    input: select(["us-central1", "europe-west1", "asia-southeast1"]),
+  }),
+  rtdbPaths: defineString("RTDB_PATHS", { default: "" }),
+  storageBucket: defineString("CLOUD_STORAGE_BUCKET", {
+    default: storageBucket,
+  }),
+  storagePaths: defineString("STORAGE_PATHS", { default: "" }),
+  enableAutoDiscovery: defineBoolean("ENABLE_AUTO_DISCOVERY", {
+    default: false,
+  }),
+  searchDepth: defineInt("AUTO_DISCOVERY_SEARCH_DEPTH", { default: 3 }),
+  searchFields: defineString("AUTO_DISCOVERY_SEARCH_FIELDS", {
+    default: "id,uid,userId",
+  }),
+  searchFunction: defineString("SEARCH_FUNCTION", { default: "" }),
+  // Non-empty defaults so Pub/Sub trigger bindings resolve during deploy
+  // discovery without freezing an empty topic name into the manifest.
+  discoveryTopicName: defineString("DISCOVERY_TOPIC_NAME", {
+    default: expr`kit-${instanceId}-discovery`,
+  }),
+  deletionTopicName: defineString("DELETION_TOPIC_NAME", {
+    default: expr`kit-${instanceId}-deletion`,
+  }),
+};
+
+export const CONFIG_EXPRESSIONS = {
+  discoveryTopicName: params.discoveryTopicName,
+  deletionTopicName: params.deletionTopicName,
+} as const;
+
+function optional(value: string): string | undefined {
+  return value.length > 0 ? value : undefined;
+}
+
+export function configFromEnv(): DeleteUserDataConfig {
+  return {
+    firestorePaths: optional(params.firestorePaths.value()),
+    firestoreDatabaseId: params.firestoreDatabaseId.value(),
+    firestoreDeleteMode:
+      params.firestoreDeleteMode.value() as DeleteUserDataConfig["firestoreDeleteMode"],
+    rtdbInstance: optional(params.rtdbInstance.value()),
+    rtdbLocation: optional(params.rtdbLocation.value()),
+    rtdbPaths: optional(params.rtdbPaths.value()),
+    storageBucket:
+      optional(params.storageBucket.value()) ?? process.env.STORAGE_BUCKET,
+    storagePaths: optional(params.storagePaths.value()),
+    enableAutoDiscovery: params.enableAutoDiscovery.value(),
+    searchDepth: params.searchDepth.value(),
+    searchFields: params.searchFields.value(),
+    searchFunction: optional(params.searchFunction.value()),
+    instanceId: params.instanceId.value(),
+    discoveryTopicName: optional(params.discoveryTopicName.value()),
+    deletionTopicName: optional(params.deletionTopicName.value()),
+    projectId: projectID.value(),
+  };
+}

package/src/events.ts

@@ -0,0 +1,38 @@
+/**
+ * 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 * as eventArc from "firebase-admin/eventarc";
+
+let eventChannel: eventArc.Channel | undefined;
+
+export const setupEventChannel = (): void => {
+  eventChannel = process.env.EVENTARC_CHANNEL
+    ? eventArc.getEventarc().channel(process.env.EVENTARC_CHANNEL, {
+        allowedEventTypes: process.env.EXT_SELECTED_EVENTS,
+      })
+    : undefined;
+};
+
+export async function publishDeletionEvent(
+  target: "firestore" | "database" | "storage",
+  data: object
+): Promise<unknown> {
+  if (!eventChannel) return Promise.resolve();
+  return eventChannel.publish({
+    type: `firebase.extensions.delete-user-data.v1.${target}`,
+    data,
+  });
+}