@firebase-function-kits/delete-user-data 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,220 @@
+# @firebase/delete-user-data
+
+Delete user data across Firestore, RTDB, and Storage on account deletion. This
+is the Delete User Data Firebase Extension as an npm package you add to your own
+Firebase Functions codebase and deploy.
+
+It listens for Firebase Auth user deletions, discovers configured (and optional
+auto-discovered) paths containing the user id, and clears matching data in
+Firestorestore, Realtime Database, and Cloud Storage. The functions run in your own
+Firebase project; there is no hosted version, so you deploy them yourself.
+
+## Install
+
+```sh
+npm install @firebase/delete-user-data
+```
+
+## Required IAM
+
+Deploy needs these Google Cloud roles on the function's service account.
+Firebase CLI 15.23.0 or later creates that account, grants the roles below,
+and attaches it to every function in this kit. Do not set a custom runtime
+service account for this codebase — it conflicts with that automatic setup.
+
+| Role | Why |
+|---|---|
+| `roles/datastore.owner` | discover and delete Firestore user data |
+| `roles/firebasedatabase.admin` | delete Realtime Database user data |
+| `roles/storage.admin` | delete Cloud Storage user objects |
+| `roles/pubsub.admin` | publish/subscribe discovery and deletion topics |
+| `roles/eventarc.eventReceiver` | receive Gen2 event triggers |
+| `roles/run.invoker` | allow Eventarc to invoke the Gen2 Cloud Run service |
+
+## Usage
+
+Export the functions from your functions codebase entry:
+
+```ts
+// functions/src/index.ts
+export {
+  clearData,
+  handleSearch,
+  handleDeletion,
+} from "@firebase/delete-user-data";
+```
+
+and configure with a `.env` (or `.env.<projectId>`).
+
+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": "delete-user-data",
+      "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-clearData`, `kit-default-handleSearch`, and
+`kit-default-handleDeletion`.
+
+```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 any required values that are missing.
+
+| Field | Env var | Required | Default | Description |
+|---|---|---|---|---|
+| `instanceId` | `INSTANCE_ID` | yes | — | Must match this instance's key in the `instances` map |
+| `firestorePaths` | `FIRESTORE_PATHS` | no | (empty) | Comma-separated Firestore paths with `{UID}` |
+| `firestoreDatabaseId` | `FIRESTORE_DATABASE_ID` | no | `(default)` | Firestore database id |
+| `firestoreDeleteMode` | `FIRESTORE_DELETE_MODE` | no | `shallow` | `shallow` or `recursive` |
+| `rtdbInstance` | `SELECTED_DATABASE_INSTANCE` | no | (empty) | RTDB instance id |
+| `rtdbLocation` | `SELECTED_DATABASE_LOCATION` | no | `us-central1` | RTDB location |
+| `rtdbPaths` | `RTDB_PATHS` | no | (empty) | Comma-separated RTDB paths with `{UID}` |
+| `storageBucket` | `CLOUD_STORAGE_BUCKET` | no | default Storage bucket | Bucket to clear |
+| `storagePaths` | `STORAGE_PATHS` | no | (empty) | Comma-separated Storage paths with `{UID}` |
+| `enableAutoDiscovery` | `ENABLE_AUTO_DISCOVERY` | no | `false` | Auto-discover user-linked docs |
+| `searchDepth` | `AUTO_DISCOVERY_SEARCH_DEPTH` | no | `3` | Discovery depth |
+| `searchFields` | `AUTO_DISCOVERY_SEARCH_FIELDS` | no | `id,uid,userId` | Fields treated as user ids |
+| `searchFunction` | `SEARCH_FUNCTION` | no | (empty) | Optional custom search function |
+| `discoveryTopicName` | `DISCOVERY_TOPIC_NAME` | no | `kit-<INSTANCE_ID>-discovery` | Pub/Sub discovery topic |
+| `deletionTopicName` | `DELETION_TOPIC_NAME` | no | `kit-<INSTANCE_ID>-deletion` | Pub/Sub deletion topic |
+
+## Multiple instances
+
+To run several deletion pipelines, add one entry per instance to the `instances`
+map, each pointing at its own config directory with its own `.env`:
+
+```json
+{
+  "functions": [
+    {
+      "source": ".",
+      "kit": "delete-user-data",
+      "instances": {
+        "app": "instances/app",
+        "admin": "instances/admin"
+      }
+    }
+  ]
+}
+```
+
+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.
+
+## Events
+
+When `EVENTARC_CHANNEL` is configured, the functions publish deletion events
+for each backend under `firebase.extensions.delete-user-data.v1.*`
+(`firestore`, `database`, and `storage`).
+
+## Differences from the Delete User Data extension
+
+This kit is the extension repackaged as an npm package, but a few things behave
+differently. If you are moving from an installed extension instance, read this
+section before you deploy.
+
+### Auto-discovery uses `true` / `false`
+
+`ENABLE_AUTO_DISCOVERY` is a boolean param, and only the literal string `true`
+enables it. The extension used `yes` / `no`, so copying an old config across
+leaves auto-discovery silently switched off. Change `yes` to `true` in your
+`.env`.
+
+### You set `INSTANCE_ID` yourself
+
+The extension derived an instance id at install time and used it to name the
+Pub/Sub topics. Here it is a setting you provide, and it must match this
+instance's key in the `instances` map in `firebase.json`. If the two disagree,
+auto-discovery publishes to a topic nothing is listening on.
+
+### Pub/Sub topics are named differently
+
+Discovery and deletion topics are now `kit-<INSTANCE_ID>-discovery` and
+`kit-<INSTANCE_ID>-deletion`, where the extension used an `ext-` prefix. The
+Firebase CLI creates them for you on deploy, so there is no manual setup step,
+but the old topics from an extension install are not reused and can be deleted
+once you have migrated.
+
+You can also override both names with `DISCOVERY_TOPIC_NAME` and
+`DELETION_TOPIC_NAME`, which the extension did not allow. Change them together,
+since one function publishes to a topic the other is triggered by.
+
+### Realtime Database deletion no longer needs a database instance
+
+The extension only cleared RTDB paths when both `SELECTED_DATABASE_INSTANCE`
+and `SELECTED_DATABASE_LOCATION` were set. This kit clears them whenever
+`RTDB_PATHS` is set, falling back to your project's default database when no
+instance is named. Set `SELECTED_DATABASE_INSTANCE` explicitly if you are
+targeting a secondary database, and leave `RTDB_PATHS` empty if you do not want
+RTDB touched at all.
+
+### Functions deploy to your default region
+
+The extension deployed to the location you picked at install time. This kit
+sets no region, so its functions deploy to your codebase's default
+(`us-central1` unless you have changed it).
+
+### Pub/Sub handlers are 2nd gen
+
+`handleSearch` and `handleDeletion` are now 2nd gen functions. `clearData`
+stays 1st gen, because the Firebase Auth `user.delete` trigger has no 2nd gen
+equivalent. This mainly matters if you have infrastructure or alerting keyed to
+function generation.
+
+### Empty search fields no longer error
+
+Setting `AUTO_DISCOVERY_SEARCH_FIELDS` to an empty value used to raise an
+invalid field path error during discovery. It is now treated as "match on the
+document path only". The default is unchanged (`id,uid,userId`).
+
+### Unchanged
+
+Events are the same. When `EVENTARC_CHANNEL` is configured, the functions still
+publish `firebase.extensions.delete-user-data.v1.firestore`, `.database` and
+`.storage` with the same payloads. Path syntax (`{UID}` substitution, comma
+separated lists, `{DEFAULT}` for the default Storage bucket), the shallow and
+recursive Firestore delete modes, the search depth and field matching rules,
+and the custom `SEARCH_FUNCTION` contract all behave as they did.
+
+## API surface
+
+- **Main entry** (`@firebase/delete-user-data`): exports `clearData`,
+  `handleSearch`, and `handleDeletion`. The main entry reads environment
+  variables when the module loads, so use it from Firebase deploy/emulator/runtime.
+  For your own triggers, import from `./lib` instead.
+- **Library entry** (`./lib`): handlers (`handleClear`, `handleSearch`,
+  `handleDeletion`), path helpers, search / batch-deletion utilities, and config
+  types (`DeleteUserDataConfig`, `resolveDeleteUserDataConfig`) for owning
+  trigger registration yourself.
+
+## License
+
+Apache-2.0

package/lib/config.d.ts

@@ -0,0 +1,22 @@
+/**
+ * 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 { DeleteUserDataConfig } from "./export-config";
+export declare const CONFIG_EXPRESSIONS: {
+    readonly discoveryTopicName: import("firebase-functions/params").StringParam;
+    readonly deletionTopicName: import("firebase-functions/params").StringParam;
+};
+export declare function configFromEnv(): DeleteUserDataConfig;
+//# 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":"AAAA;;;;;;;;;;;;;;GAcG;AAWH,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAoI5D,eAAO,MAAM,kBAAkB;aAC7B,kBAAkB;aAClB,iBAAiB;CACT,CAAC;AAMX,wBAAgB,aAAa,IAAI,oBAAoB,CAqBpD"}

package/lib/config.js

@@ -0,0 +1,153 @@
+"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 instanceId = (0, params_1.defineString)("INSTANCE_ID");
+const params = {
+    instanceId,
+    firestorePaths: (0, params_1.defineString)("FIRESTORE_PATHS", {
+        label: "Cloud Firestore paths",
+        description: "Which paths in your Cloud Firestore instance contain data keyed on a user ID? Leave empty if you don't use Cloud Firestore.\nEnter the full paths, separated by commas. Use `{UID}` as a placeholder for the user's UID.\nFor example, if you have the collections `users` and `admins`, and each collection has documents with User ID as document IDs, then enter `users/{UID},admins/{UID}`.",
+        default: "",
+        input: { text: { example: "users/{UID},admins/{UID}" } },
+    }),
+    firestoreDatabaseId: (0, params_1.defineString)("FIRESTORE_DATABASE_ID", {
+        label: "Firestore Database ID",
+        description: 'The ID of the Firestore database to use. Use "(default)" for the default database. You can view your available Firestore databases at https://console.cloud.google.com/firestore/databases.',
+        default: "(default)",
+    }),
+    firestoreDeleteMode: (0, params_1.defineString)("FIRESTORE_DELETE_MODE", {
+        label: "Cloud Firestore delete mode",
+        description: "(Only applicable if you use the `Cloud Firestore paths` parameter.) How do you want to delete Cloud Firestore documents? To also delete documents in subcollections, set this parameter to `recursive`.",
+        default: "shallow",
+        input: (0, params_1.select)({ Recursive: "recursive", Shallow: "shallow" }),
+    }),
+    rtdbInstance: (0, params_1.defineString)("SELECTED_DATABASE_INSTANCE", {
+        label: "Realtime Database instance",
+        description: "What is the ID of the Realtime Database instance from which you want to delete user data (keyed on user ID)?",
+        default: "",
+        input: {
+            text: {
+                example: "my-instance",
+                // Extension regex, with an empty branch added: the param is optional.
+                validationRegex: /^(?:[^\.\$\#\]\[\/\x00-\x1F\x7F]+|)$/,
+                validationErrorMessage: "Invalid database instance. Make sure that you have entered just the instance ID, and not the entire database URL.",
+            },
+        },
+    }),
+    rtdbLocation: (0, params_1.defineString)("SELECTED_DATABASE_LOCATION", {
+        label: "Realtime Database location",
+        description: "(Only applicable if you provided the `Realtime Database instance` parameter.) From which Realtime Database location do you want to delete data keyed on a user ID?",
+        default: "us-central1",
+        input: (0, params_1.select)({
+            "United States": "us-central1",
+            Belgium: "europe-west1",
+            Singapore: "asia-southeast1",
+        }),
+    }),
+    rtdbPaths: (0, params_1.defineString)("RTDB_PATHS", {
+        label: "Realtime Database paths",
+        description: "Which paths in your Realtime Database instance contain data keyed on a user ID? Leave empty if you don't use Realtime Database.\nEnter the full paths, separated by commas. Use `{UID}` as a placeholder for the user's UID.\nFor example: `users/{UID},admins/{UID}`.",
+        default: "",
+        input: { text: { example: "users/{UID},admins/{UID}" } },
+    }),
+    storageBucket: (0, params_1.defineString)("CLOUD_STORAGE_BUCKET", {
+        label: "Cloud Storage bucket",
+        description: "Which Google Cloud Storage bucket do you want to delete files from?",
+        default: params_1.storageBucket,
+        input: {
+            text: {
+                example: "my-project-12345.appspot.com",
+                validationRegex: /^([0-9a-z_.-]*)$/,
+                validationErrorMessage: "Invalid storage bucket",
+            },
+        },
+    }),
+    storagePaths: (0, params_1.defineString)("STORAGE_PATHS", {
+        label: "Cloud Storage paths",
+        description: "Where in Google Cloud Storage do you store data keyed on a user ID? Leave empty if you don't use Cloud Storage.\nEnter the full paths to files or directories in your Storage buckets, separated by commas. Use `{UID}` to represent the User ID of the deleted user, and use `{DEFAULT}` to represent your default Storage bucket.\nHere's a series of examples. To delete all the files in your default bucket with the file naming scheme `{UID}-pic.png`, enter `{DEFAULT}/{UID}-pic.png`. To also delete all the files in another bucket called my-app-logs with the file naming scheme `{UID}-logs.txt`, enter `{DEFAULT}/{UID}-pic.png,my-app-logs/{UID}-logs.txt`. To *also* delete a User ID-labeled directory and all its files (like `media/{UID}`), enter `{DEFAULT}/{UID}-pic.png,my-app-logs/{UID}-logs.txt,{DEFAULT}/media/{UID}`.",
+        default: "",
+        input: {
+            text: {
+                example: "{DEFAULT}/{UID}-pic.png,my-awesome-app-logs/{UID}-logs.txt",
+            },
+        },
+    }),
+    enableAutoDiscovery: (0, params_1.defineBoolean)("ENABLE_AUTO_DISCOVERY", {
+        label: "Enable auto discovery",
+        description: "Enable the extension to automatically discover Firestore collections and documents to delete.",
+        default: false,
+    }),
+    searchDepth: (0, params_1.defineInt)("AUTO_DISCOVERY_SEARCH_DEPTH", {
+        label: "Auto discovery search depth",
+        description: "If auto discovery is enabled, how deep should auto discovery find collections and documents. For example, setting to `1` would only discover root collections and documents, whereas setting to `9` would search sub-collections 9 levels deep. Defaults to `3`.",
+        default: 3,
+    }),
+    searchFields: (0, params_1.defineString)("AUTO_DISCOVERY_SEARCH_FIELDS", {
+        label: "Auto discovery search fields",
+        description: "If auto discovery is enabled, specify what document fields are used to associate the UID with the document. The extension will delete documents where the value for one or more of these fields matches the deleting user’s UID. If left empty, document fields will not be used in auto discovery.",
+        default: "id,uid,userId",
+    }),
+    searchFunction: (0, params_1.defineString)("SEARCH_FUNCTION", {
+        label: "Search function URL",
+        description: "Specify a URL to call that will return a list of document paths to delete. The extension will send a `POST` request to the specified `URL`, with the `uid` of the deleted user will be provided in the body of the request. The endpoint specified should return an array of firestore paths to delete.",
+        default: "",
+        input: {
+            text: {
+                example: "https://us-west1-my-project-id.cloudfunctions.net/myTransformFunction",
+            },
+        },
+    }),
+    // Non-empty defaults so Pub/Sub trigger bindings resolve during deploy
+    // discovery without freezing an empty topic name into the manifest.
+    discoveryTopicName: (0, params_1.defineString)("DISCOVERY_TOPIC_NAME", {
+        default: (0, params_1.expr) `kit-${instanceId}-discovery`,
+    }),
+    deletionTopicName: (0, params_1.defineString)("DELETION_TOPIC_NAME", {
+        default: (0, params_1.expr) `kit-${instanceId}-deletion`,
+    }),
+};
+exports.CONFIG_EXPRESSIONS = {
+    discoveryTopicName: params.discoveryTopicName,
+    deletionTopicName: params.deletionTopicName,
+};
+function optional(value) {
+    return value.length > 0 ? value : undefined;
+}
+function configFromEnv() {
+    return {
+        firestorePaths: optional(params.firestorePaths.value()),
+        firestoreDatabaseId: params.firestoreDatabaseId.value(),
+        firestoreDeleteMode: params.firestoreDeleteMode.value(),
+        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: params_1.projectID.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,sDAQmC;AAGnC,MAAM,UAAU,GAAG,IAAA,qBAAY,EAAC,aAAa,CAAC,CAAC;AAE/C,MAAM,MAAM,GAAG;IACb,UAAU;IACV,cAAc,EAAE,IAAA,qBAAY,EAAC,iBAAiB,EAAE;QAC9C,KAAK,EAAE,uBAAuB;QAC9B,WAAW,EACT,iYAAiY;QACnY,OAAO,EAAE,EAAE;QACX,KAAK,EAAE,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,0BAA0B,EAAE,EAAE;KACzD,CAAC;IACF,mBAAmB,EAAE,IAAA,qBAAY,EAAC,uBAAuB,EAAE;QACzD,KAAK,EAAE,uBAAuB;QAC9B,WAAW,EACT,6LAA6L;QAE/L,OAAO,EAAE,WAAW;KACrB,CAAC;IACF,mBAAmB,EAAE,IAAA,qBAAY,EAAC,uBAAuB,EAAE;QACzD,KAAK,EAAE,6BAA6B;QACpC,WAAW,EACT,yMAAyM;QAE3M,OAAO,EAAE,SAAS;QAClB,KAAK,EAAE,IAAA,eAAM,EAAC,EAAE,SAAS,EAAE,WAAW,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;KAC9D,CAAC;IACF,YAAY,EAAE,IAAA,qBAAY,EAAC,4BAA4B,EAAE;QACvD,KAAK,EAAE,4BAA4B;QACnC,WAAW,EACT,8GAA8G;QAEhH,OAAO,EAAE,EAAE;QACX,KAAK,EAAE;YACL,IAAI,EAAE;gBACJ,OAAO,EAAE,aAAa;gBAEtB,sEAAsE;gBACtE,eAAe,EAAE,sCAAsC;gBACvD,sBAAsB,EACpB,mHAAmH;aACtH;SACF;KACF,CAAC;IACF,YAAY,EAAE,IAAA,qBAAY,EAAC,4BAA4B,EAAE;QACvD,KAAK,EAAE,4BAA4B;QACnC,WAAW,EACT,oKAAoK;QAEtK,OAAO,EAAE,aAAa;QACtB,KAAK,EAAE,IAAA,eAAM,EAAC;YACZ,eAAe,EAAE,aAAa;YAC9B,OAAO,EAAE,cAAc;YACvB,SAAS,EAAE,iBAAiB;SAC7B,CAAC;KACH,CAAC;IACF,SAAS,EAAE,IAAA,qBAAY,EAAC,YAAY,EAAE;QACpC,KAAK,EAAE,yBAAyB;QAChC,WAAW,EACT,wQAAwQ;QAC1Q,OAAO,EAAE,EAAE;QACX,KAAK,EAAE,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,0BAA0B,EAAE,EAAE;KACzD,CAAC;IACF,aAAa,EAAE,IAAA,qBAAY,EAAC,sBAAsB,EAAE;QAClD,KAAK,EAAE,sBAAsB;QAC7B,WAAW,EACT,qEAAqE;QAEvE,OAAO,EAAE,sBAAa;QACtB,KAAK,EAAE;YACL,IAAI,EAAE;gBACJ,OAAO,EAAE,8BAA8B;gBAEvC,eAAe,EAAE,kBAAkB;gBACnC,sBAAsB,EAAE,wBAAwB;aACjD;SACF;KACF,CAAC;IACF,YAAY,EAAE,IAAA,qBAAY,EAAC,eAAe,EAAE;QAC1C,KAAK,EAAE,qBAAqB;QAC5B,WAAW,EACT,mzBAAmzB;QACrzB,OAAO,EAAE,EAAE;QACX,KAAK,EAAE;YACL,IAAI,EAAE;gBACJ,OAAO,EAAE,4DAA4D;aACtE;SACF;KACF,CAAC;IACF,mBAAmB,EAAE,IAAA,sBAAa,EAAC,uBAAuB,EAAE;QAC1D,KAAK,EAAE,uBAAuB;QAC9B,WAAW,EACT,+FAA+F;QAEjG,OAAO,EAAE,KAAK;KACf,CAAC;IACF,WAAW,EAAE,IAAA,kBAAS,EAAC,6BAA6B,EAAE;QACpD,KAAK,EAAE,6BAA6B;QACpC,WAAW,EACT,kQAAkQ;QACpQ,OAAO,EAAE,CAAC;KACX,CAAC;IACF,YAAY,EAAE,IAAA,qBAAY,EAAC,8BAA8B,EAAE;QACzD,KAAK,EAAE,8BAA8B;QACrC,WAAW,EACT,qSAAqS;QAEvS,OAAO,EAAE,eAAe;KACzB,CAAC;IACF,cAAc,EAAE,IAAA,qBAAY,EAAC,iBAAiB,EAAE;QAC9C,KAAK,EAAE,qBAAqB;QAC5B,WAAW,EACT,ySAAyS;QAC3S,OAAO,EAAE,EAAE;QACX,KAAK,EAAE;YACL,IAAI,EAAE;gBACJ,OAAO,EACL,uEAAuE;aAC1E;SACF;KACF,CAAC;IACF,uEAAuE;IACvE,oEAAoE;IACpE,kBAAkB,EAAE,IAAA,qBAAY,EAAC,sBAAsB,EAAE;QACvD,OAAO,EAAE,IAAA,aAAI,EAAA,OAAO,UAAU,YAAY;KAC3C,CAAC;IACF,iBAAiB,EAAE,IAAA,qBAAY,EAAC,qBAAqB,EAAE;QACrD,OAAO,EAAE,IAAA,aAAI,EAAA,OAAO,UAAU,WAAW;KAC1C,CAAC;CACH,CAAC;AAEW,QAAA,kBAAkB,GAAG;IAChC,kBAAkB,EAAE,MAAM,CAAC,kBAAkB;IAC7C,iBAAiB,EAAE,MAAM,CAAC,iBAAiB;CACnC,CAAC;AAEX,SAAS,QAAQ,CAAC,KAAa;IAC7B,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;AAC9C,CAAC;AAED;IACE,OAAO;QACL,cAAc,EAAE,QAAQ,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;QACvD,mBAAmB,EAAE,MAAM,CAAC,mBAAmB,CAAC,KAAK,EAAE;QACvD,mBAAmB,EACjB,MAAM,CAAC,mBAAmB,CAAC,KAAK,EAAiD;QACnF,YAAY,EAAE,QAAQ,CAAC,MAAM,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC;QACnD,YAAY,EAAE,QAAQ,CAAC,MAAM,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC;QACnD,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;QAC7C,aAAa,EACX,QAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC,IAAI,OAAO,CAAC,GAAG,CAAC,cAAc;QACtE,YAAY,EAAE,QAAQ,CAAC,MAAM,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC;QACnD,mBAAmB,EAAE,MAAM,CAAC,mBAAmB,CAAC,KAAK,EAAE;QACvD,WAAW,EAAE,MAAM,CAAC,WAAW,CAAC,KAAK,EAAE;QACvC,YAAY,EAAE,MAAM,CAAC,YAAY,CAAC,KAAK,EAAE;QACzC,cAAc,EAAE,QAAQ,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;QACvD,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC,KAAK,EAAE;QACrC,kBAAkB,EAAE,QAAQ,CAAC,MAAM,CAAC,kBAAkB,CAAC,KAAK,EAAE,CAAC;QAC/D,iBAAiB,EAAE,QAAQ,CAAC,MAAM,CAAC,iBAAiB,CAAC,KAAK,EAAE,CAAC;QAC7D,SAAS,EAAE,kBAAS,CAAC,KAAK,EAAE;KAC7B,CAAC;AACJ,CAAC"}

package/lib/events.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.
+ */
+export declare const setupEventChannel: () => void;
+export declare function publishDeletionEvent(target: "firestore" | "database" | "storage", data: object): Promise<unknown>;
+//# sourceMappingURL=events.d.ts.map

package/lib/events.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../src/events.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAMH,eAAO,MAAM,iBAAiB,QAAO,IAMpC,CAAC;AAEF,wBAAsB,oBAAoB,CACxC,MAAM,EAAE,WAAW,GAAG,UAAU,GAAG,SAAS,EAC5C,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,OAAO,CAAC,CAMlB"}

package/lib/events.js

@@ -0,0 +1,71 @@
+"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;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setupEventChannel = void 0;
+exports.publishDeletionEvent = publishDeletionEvent;
+const eventArc = __importStar(require("firebase-admin/eventarc"));
+let eventChannel;
+const setupEventChannel = () => {
+    eventChannel = process.env.EVENTARC_CHANNEL
+        ? eventArc.getEventarc().channel(process.env.EVENTARC_CHANNEL, {
+            allowedEventTypes: process.env.EXT_SELECTED_EVENTS,
+        })
+        : undefined;
+};
+exports.setupEventChannel = setupEventChannel;
+async function publishDeletionEvent(target, data) {
+    if (!eventChannel)
+        return Promise.resolve();
+    return eventChannel.publish({
+        type: `firebase.extensions.delete-user-data.v1.${target}`,
+        data,
+    });
+}
+//# sourceMappingURL=events.js.map

package/lib/events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../src/events.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,MAAY,QAAQ,oDAAgC;AAEpD,IAAI,YAA0C,CAAC;AAExC,MAAM,iBAAiB,GAAG,GAAS,EAAE;IAC1C,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC,gBAAgB;QACzC,CAAC,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE;YAC3D,iBAAiB,EAAE,OAAO,CAAC,GAAG,CAAC,mBAAmB;SACnD,CAAC;QACJ,CAAC,CAAC,SAAS,CAAC;AAChB,CAAC,CAAC;AANW,QAAA,iBAAiB,GAAjB,iBAAiB,CAM5B;AAEK,KAAK,+BACV,MAA4C,EAC5C,IAAY;IAEZ,IAAI,CAAC,YAAY;QAAE,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC5C,OAAO,YAAY,CAAC,OAAO,CAAC;QAC1B,IAAI,EAAE,2CAA2C,MAAM,EAAE;QACzD,IAAI;KACL,CAAC,CAAC;AACL,CAAC"}

package/lib/export-config.d.ts

@@ -0,0 +1,55 @@
+/**
+ * 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.
+ */
+export type FirestoreDeleteMode = "recursive" | "shallow";
+export interface DeleteUserDataConfig {
+    firestorePaths?: string;
+    firestoreDatabaseId?: string;
+    firestoreDeleteMode?: FirestoreDeleteMode;
+    rtdbInstance?: string;
+    rtdbLocation?: string;
+    rtdbPaths?: string;
+    storageBucket?: string;
+    storagePaths?: string;
+    enableAutoDiscovery?: boolean;
+    searchDepth?: number;
+    searchFields?: string;
+    searchFunction?: string;
+    instanceId: string;
+    discoveryTopicName?: string;
+    deletionTopicName?: string;
+    projectId?: string;
+}
+export interface ResolvedDeleteUserDataConfig {
+    firestorePaths?: string;
+    firestoreDatabaseId: string;
+    firestoreDeleteMode: FirestoreDeleteMode;
+    rtdbInstance?: string;
+    rtdbLocation?: string;
+    rtdbPaths?: string;
+    storageBucket?: string;
+    storagePaths?: string;
+    enableAutoDiscovery: boolean;
+    searchDepth: number;
+    searchFields: string;
+    searchFunction?: string;
+    instanceId: string;
+    discoveryTopicName: string;
+    deletionTopicName: string;
+    projectId?: string;
+}
+export declare function resolveDeleteUserDataConfig(config: DeleteUserDataConfig): ResolvedDeleteUserDataConfig;
+export declare function getDatabaseUrl(selectedDatabaseInstance: string | undefined, selectedDatabaseLocation: string | undefined): string | null;
+//# sourceMappingURL=export-config.d.ts.map

package/lib/export-config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"export-config.d.ts","sourceRoot":"","sources":["../src/export-config.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,MAAM,MAAM,mBAAmB,GAAG,WAAW,GAAG,SAAS,CAAC;AAE1D,MAAM,WAAW,oBAAoB;IACnC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IAC1C,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,4BAA4B;IAC3C,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,mBAAmB,EAAE,OAAO,CAAC;IAC7B,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAcD,wBAAgB,2BAA2B,CACzC,MAAM,EAAE,oBAAoB,GAC3B,4BAA4B,CA8B9B;AAED,wBAAgB,cAAc,CAC5B,wBAAwB,EAAE,MAAM,GAAG,SAAS,EAC5C,wBAAwB,EAAE,MAAM,GAAG,SAAS,GAC3C,MAAM,GAAG,IAAI,CAMf"}

package/lib/export-config.js

@@ -0,0 +1,56 @@
+"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.resolveDeleteUserDataConfig = resolveDeleteUserDataConfig;
+exports.getDatabaseUrl = getDatabaseUrl;
+const DEFAULT_FIRESTORE_DATABASE_ID = "(default)";
+const DEFAULT_FIRESTORE_DELETE_MODE = "shallow";
+const DEFAULT_SEARCH_DEPTH = 3;
+const DEFAULT_SEARCH_FIELDS = "id,uid,userId";
+function topicName(name, instanceId, suffix) {
+    return name ?? `kit-${instanceId}-${suffix}`;
+}
+function resolveDeleteUserDataConfig(config) {
+    const instanceId = config.instanceId;
+    return {
+        firestorePaths: config.firestorePaths,
+        firestoreDatabaseId: config.firestoreDatabaseId ?? DEFAULT_FIRESTORE_DATABASE_ID,
+        firestoreDeleteMode: config.firestoreDeleteMode ?? DEFAULT_FIRESTORE_DELETE_MODE,
+        rtdbInstance: config.rtdbInstance,
+        rtdbLocation: config.rtdbLocation,
+        rtdbPaths: config.rtdbPaths,
+        storageBucket: config.storageBucket,
+        storagePaths: config.storagePaths,
+        enableAutoDiscovery: config.enableAutoDiscovery ?? false,
+        searchDepth: config.searchDepth ?? DEFAULT_SEARCH_DEPTH,
+        searchFields: config.searchFields ?? DEFAULT_SEARCH_FIELDS,
+        searchFunction: config.searchFunction,
+        instanceId,
+        discoveryTopicName: topicName(config.discoveryTopicName, instanceId, "discovery"),
+        deletionTopicName: topicName(config.deletionTopicName, instanceId, "deletion"),
+        projectId: config.projectId,
+    };
+}
+function getDatabaseUrl(selectedDatabaseInstance, selectedDatabaseLocation) {
+    if (!selectedDatabaseLocation || !selectedDatabaseInstance)
+        return null;
+    if (selectedDatabaseLocation === "us-central1") {
+        return `https://${selectedDatabaseInstance}.firebaseio.com`;
+    }
+    return `https://${selectedDatabaseInstance}.${selectedDatabaseLocation}.firebasedatabase.app`;
+}
+//# sourceMappingURL=export-config.js.map

package/lib/export-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"export-config.js","sourceRoot":"","sources":["../src/export-config.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;;AA0CH,MAAM,6BAA6B,GAAG,WAAW,CAAC;AAClD,MAAM,6BAA6B,GAAwB,SAAS,CAAC;AACrE,MAAM,oBAAoB,GAAG,CAAC,CAAC;AAC/B,MAAM,qBAAqB,GAAG,eAAe,CAAC;AAC9C,SAAS,SAAS,CAChB,IAAwB,EACxB,UAAkB,EAClB,MAAc;IAEd,OAAO,IAAI,IAAI,OAAO,UAAU,IAAI,MAAM,EAAE,CAAC;AAC/C,CAAC;AAED,qCACE,MAA4B;IAE5B,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC;IACrC,OAAO;QACL,cAAc,EAAE,MAAM,CAAC,cAAc;QACrC,mBAAmB,EACjB,MAAM,CAAC,mBAAmB,IAAI,6BAA6B;QAC7D,mBAAmB,EACjB,MAAM,CAAC,mBAAmB,IAAI,6BAA6B;QAC7D,YAAY,EAAE,MAAM,CAAC,YAAY;QACjC,YAAY,EAAE,MAAM,CAAC,YAAY;QACjC,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,aAAa,EAAE,MAAM,CAAC,aAAa;QACnC,YAAY,EAAE,MAAM,CAAC,YAAY;QACjC,mBAAmB,EAAE,MAAM,CAAC,mBAAmB,IAAI,KAAK;QACxD,WAAW,EAAE,MAAM,CAAC,WAAW,IAAI,oBAAoB;QACvD,YAAY,EAAE,MAAM,CAAC,YAAY,IAAI,qBAAqB;QAC1D,cAAc,EAAE,MAAM,CAAC,cAAc;QACrC,UAAU;QACV,kBAAkB,EAAE,SAAS,CAC3B,MAAM,CAAC,kBAAkB,EACzB,UAAU,EACV,WAAW,CACZ;QACD,iBAAiB,EAAE,SAAS,CAC1B,MAAM,CAAC,iBAAiB,EACxB,UAAU,EACV,UAAU,CACX;QACD,SAAS,EAAE,MAAM,CAAC,SAAS;KAC5B,CAAC;AACJ,CAAC;AAED,wBACE,wBAA4C,EAC5C,wBAA4C;IAE5C,IAAI,CAAC,wBAAwB,IAAI,CAAC,wBAAwB;QAAE,OAAO,IAAI,CAAC;IACxE,IAAI,wBAAwB,KAAK,aAAa,EAAE,CAAC;QAC/C,OAAO,WAAW,wBAAwB,iBAAiB,CAAC;IAC9D,CAAC;IACD,OAAO,WAAW,wBAAwB,IAAI,wBAAwB,uBAAuB,CAAC;AAChG,CAAC"}