@metamask-previews/analytics-privacy-controller 0.0.0-preview-fa81dffb

package/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+[Unreleased]: https://github.com/MetaMask/core/

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2026 MetaMask
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

package/README.md

@@ -0,0 +1,15 @@
+# `@metamask/analytics-privacy-controller`
+
+Controller for managing analytics privacy and GDPR/CCPA data deletion functionality
+
+## Installation
+
+`yarn add @metamask/analytics-privacy-controller`
+
+or
+
+`npm install @metamask/analytics-privacy-controller`
+
+## Contributing
+
+This package is part of a monorepo. Instructions for contributing can be found in the [monorepo README](https://github.com/MetaMask/core#readme).

package/dist/AnalyticsPrivacyController-method-action-types.cjs

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * Do not edit manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=AnalyticsPrivacyController-method-action-types.cjs.map

package/dist/AnalyticsPrivacyController-method-action-types.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"AnalyticsPrivacyController-method-action-types.cjs","sourceRoot":"","sources":["../src/AnalyticsPrivacyController-method-action-types.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated by `scripts/generate-method-action-types.ts`.\n * Do not edit manually.\n */\n\nimport type { AnalyticsPrivacyController } from './AnalyticsPrivacyController';\n\n/**\n * Creates a new delete regulation for the user.\n * This is necessary to respect the GDPR and CCPA regulations.\n *\n * @returns Promise containing the status of the request\n */\nexport type AnalyticsPrivacyControllerCreateDataDeletionTaskAction = {\n  type: `AnalyticsPrivacyController:createDataDeletionTask`;\n  handler: AnalyticsPrivacyController['createDataDeletionTask'];\n};\n\n/**\n * Check the latest delete regulation status.\n *\n * @returns Promise containing the timestamp, delete status and collected data flag\n */\nexport type AnalyticsPrivacyControllerCheckDataDeleteStatusAction = {\n  type: `AnalyticsPrivacyController:checkDataDeleteStatus`;\n  handler: AnalyticsPrivacyController['checkDataDeleteStatus'];\n};\n\n/**\n * Get the latest delete regulation request timestamp.\n *\n * @returns The timestamp (in milliseconds since epoch), or undefined\n */\nexport type AnalyticsPrivacyControllerGetDeleteRegulationCreationTimestampAction =\n  {\n    type: `AnalyticsPrivacyController:getDeleteRegulationCreationTimestamp`;\n    handler: AnalyticsPrivacyController['getDeleteRegulationCreationTimestamp'];\n  };\n\n/**\n * Get the latest delete regulation request id.\n *\n * @returns The id string, or undefined\n */\nexport type AnalyticsPrivacyControllerGetDeleteRegulationIdAction = {\n  type: `AnalyticsPrivacyController:getDeleteRegulationId`;\n  handler: AnalyticsPrivacyController['getDeleteRegulationId'];\n};\n\n/**\n * Indicate if events have been recorded since the last deletion request.\n *\n * @returns true if events have been recorded since the last deletion request\n */\nexport type AnalyticsPrivacyControllerIsDataRecordedAction = {\n  type: `AnalyticsPrivacyController:isDataRecorded`;\n  handler: AnalyticsPrivacyController['isDataRecorded'];\n};\n\n/**\n * Update the data recording flag if needed.\n * This method should be called after tracking events to ensure\n * the data recording flag is properly updated for data deletion workflows.\n *\n * @param saveDataRecording - Whether to save the data recording flag (default: true)\n */\nexport type AnalyticsPrivacyControllerUpdateDataRecordingFlagAction = {\n  type: `AnalyticsPrivacyController:updateDataRecordingFlag`;\n  handler: AnalyticsPrivacyController['updateDataRecordingFlag'];\n};\n\n/**\n * Union of all AnalyticsPrivacyController action types.\n */\nexport type AnalyticsPrivacyControllerMethodActions =\n  | AnalyticsPrivacyControllerCreateDataDeletionTaskAction\n  | AnalyticsPrivacyControllerCheckDataDeleteStatusAction\n  | AnalyticsPrivacyControllerGetDeleteRegulationCreationTimestampAction\n  | AnalyticsPrivacyControllerGetDeleteRegulationIdAction\n  | AnalyticsPrivacyControllerIsDataRecordedAction\n  | AnalyticsPrivacyControllerUpdateDataRecordingFlagAction;\n"]}

package/dist/AnalyticsPrivacyController-method-action-types.d.cts

@@ -0,0 +1,67 @@
+/**
+ * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * Do not edit manually.
+ */
+import type { AnalyticsPrivacyController } from "./AnalyticsPrivacyController.cjs";
+/**
+ * Creates a new delete regulation for the user.
+ * This is necessary to respect the GDPR and CCPA regulations.
+ *
+ * @returns Promise containing the status of the request
+ */
+export type AnalyticsPrivacyControllerCreateDataDeletionTaskAction = {
+    type: `AnalyticsPrivacyController:createDataDeletionTask`;
+    handler: AnalyticsPrivacyController['createDataDeletionTask'];
+};
+/**
+ * Check the latest delete regulation status.
+ *
+ * @returns Promise containing the timestamp, delete status and collected data flag
+ */
+export type AnalyticsPrivacyControllerCheckDataDeleteStatusAction = {
+    type: `AnalyticsPrivacyController:checkDataDeleteStatus`;
+    handler: AnalyticsPrivacyController['checkDataDeleteStatus'];
+};
+/**
+ * Get the latest delete regulation request timestamp.
+ *
+ * @returns The timestamp (in milliseconds since epoch), or undefined
+ */
+export type AnalyticsPrivacyControllerGetDeleteRegulationCreationTimestampAction = {
+    type: `AnalyticsPrivacyController:getDeleteRegulationCreationTimestamp`;
+    handler: AnalyticsPrivacyController['getDeleteRegulationCreationTimestamp'];
+};
+/**
+ * Get the latest delete regulation request id.
+ *
+ * @returns The id string, or undefined
+ */
+export type AnalyticsPrivacyControllerGetDeleteRegulationIdAction = {
+    type: `AnalyticsPrivacyController:getDeleteRegulationId`;
+    handler: AnalyticsPrivacyController['getDeleteRegulationId'];
+};
+/**
+ * Indicate if events have been recorded since the last deletion request.
+ *
+ * @returns true if events have been recorded since the last deletion request
+ */
+export type AnalyticsPrivacyControllerIsDataRecordedAction = {
+    type: `AnalyticsPrivacyController:isDataRecorded`;
+    handler: AnalyticsPrivacyController['isDataRecorded'];
+};
+/**
+ * Update the data recording flag if needed.
+ * This method should be called after tracking events to ensure
+ * the data recording flag is properly updated for data deletion workflows.
+ *
+ * @param saveDataRecording - Whether to save the data recording flag (default: true)
+ */
+export type AnalyticsPrivacyControllerUpdateDataRecordingFlagAction = {
+    type: `AnalyticsPrivacyController:updateDataRecordingFlag`;
+    handler: AnalyticsPrivacyController['updateDataRecordingFlag'];
+};
+/**
+ * Union of all AnalyticsPrivacyController action types.
+ */
+export type AnalyticsPrivacyControllerMethodActions = AnalyticsPrivacyControllerCreateDataDeletionTaskAction | AnalyticsPrivacyControllerCheckDataDeleteStatusAction | AnalyticsPrivacyControllerGetDeleteRegulationCreationTimestampAction | AnalyticsPrivacyControllerGetDeleteRegulationIdAction | AnalyticsPrivacyControllerIsDataRecordedAction | AnalyticsPrivacyControllerUpdateDataRecordingFlagAction;
+//# sourceMappingURL=AnalyticsPrivacyController-method-action-types.d.cts.map

package/dist/AnalyticsPrivacyController-method-action-types.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AnalyticsPrivacyController-method-action-types.d.cts","sourceRoot":"","sources":["../src/AnalyticsPrivacyController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,0BAA0B,EAAE,yCAAqC;AAE/E;;;;;GAKG;AACH,MAAM,MAAM,sDAAsD,GAAG;IACnE,IAAI,EAAE,mDAAmD,CAAC;IAC1D,OAAO,EAAE,0BAA0B,CAAC,wBAAwB,CAAC,CAAC;CAC/D,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,qDAAqD,GAAG;IAClE,IAAI,EAAE,kDAAkD,CAAC;IACzD,OAAO,EAAE,0BAA0B,CAAC,uBAAuB,CAAC,CAAC;CAC9D,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,oEAAoE,GAC9E;IACE,IAAI,EAAE,iEAAiE,CAAC;IACxE,OAAO,EAAE,0BAA0B,CAAC,sCAAsC,CAAC,CAAC;CAC7E,CAAC;AAEJ;;;;GAIG;AACH,MAAM,MAAM,qDAAqD,GAAG;IAClE,IAAI,EAAE,kDAAkD,CAAC;IACzD,OAAO,EAAE,0BAA0B,CAAC,uBAAuB,CAAC,CAAC;CAC9D,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,8CAA8C,GAAG;IAC3D,IAAI,EAAE,2CAA2C,CAAC;IAClD,OAAO,EAAE,0BAA0B,CAAC,gBAAgB,CAAC,CAAC;CACvD,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,uDAAuD,GAAG;IACpE,IAAI,EAAE,oDAAoD,CAAC;IAC3D,OAAO,EAAE,0BAA0B,CAAC,yBAAyB,CAAC,CAAC;CAChE,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uCAAuC,GAC/C,sDAAsD,GACtD,qDAAqD,GACrD,oEAAoE,GACpE,qDAAqD,GACrD,8CAA8C,GAC9C,uDAAuD,CAAC"}

package/dist/AnalyticsPrivacyController-method-action-types.d.mts

@@ -0,0 +1,67 @@
+/**
+ * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * Do not edit manually.
+ */
+import type { AnalyticsPrivacyController } from "./AnalyticsPrivacyController.mjs";
+/**
+ * Creates a new delete regulation for the user.
+ * This is necessary to respect the GDPR and CCPA regulations.
+ *
+ * @returns Promise containing the status of the request
+ */
+export type AnalyticsPrivacyControllerCreateDataDeletionTaskAction = {
+    type: `AnalyticsPrivacyController:createDataDeletionTask`;
+    handler: AnalyticsPrivacyController['createDataDeletionTask'];
+};
+/**
+ * Check the latest delete regulation status.
+ *
+ * @returns Promise containing the timestamp, delete status and collected data flag
+ */
+export type AnalyticsPrivacyControllerCheckDataDeleteStatusAction = {
+    type: `AnalyticsPrivacyController:checkDataDeleteStatus`;
+    handler: AnalyticsPrivacyController['checkDataDeleteStatus'];
+};
+/**
+ * Get the latest delete regulation request timestamp.
+ *
+ * @returns The timestamp (in milliseconds since epoch), or undefined
+ */
+export type AnalyticsPrivacyControllerGetDeleteRegulationCreationTimestampAction = {
+    type: `AnalyticsPrivacyController:getDeleteRegulationCreationTimestamp`;
+    handler: AnalyticsPrivacyController['getDeleteRegulationCreationTimestamp'];
+};
+/**
+ * Get the latest delete regulation request id.
+ *
+ * @returns The id string, or undefined
+ */
+export type AnalyticsPrivacyControllerGetDeleteRegulationIdAction = {
+    type: `AnalyticsPrivacyController:getDeleteRegulationId`;
+    handler: AnalyticsPrivacyController['getDeleteRegulationId'];
+};
+/**
+ * Indicate if events have been recorded since the last deletion request.
+ *
+ * @returns true if events have been recorded since the last deletion request
+ */
+export type AnalyticsPrivacyControllerIsDataRecordedAction = {
+    type: `AnalyticsPrivacyController:isDataRecorded`;
+    handler: AnalyticsPrivacyController['isDataRecorded'];
+};
+/**
+ * Update the data recording flag if needed.
+ * This method should be called after tracking events to ensure
+ * the data recording flag is properly updated for data deletion workflows.
+ *
+ * @param saveDataRecording - Whether to save the data recording flag (default: true)
+ */
+export type AnalyticsPrivacyControllerUpdateDataRecordingFlagAction = {
+    type: `AnalyticsPrivacyController:updateDataRecordingFlag`;
+    handler: AnalyticsPrivacyController['updateDataRecordingFlag'];
+};
+/**
+ * Union of all AnalyticsPrivacyController action types.
+ */
+export type AnalyticsPrivacyControllerMethodActions = AnalyticsPrivacyControllerCreateDataDeletionTaskAction | AnalyticsPrivacyControllerCheckDataDeleteStatusAction | AnalyticsPrivacyControllerGetDeleteRegulationCreationTimestampAction | AnalyticsPrivacyControllerGetDeleteRegulationIdAction | AnalyticsPrivacyControllerIsDataRecordedAction | AnalyticsPrivacyControllerUpdateDataRecordingFlagAction;
+//# sourceMappingURL=AnalyticsPrivacyController-method-action-types.d.mts.map

package/dist/AnalyticsPrivacyController-method-action-types.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AnalyticsPrivacyController-method-action-types.d.mts","sourceRoot":"","sources":["../src/AnalyticsPrivacyController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,0BAA0B,EAAE,yCAAqC;AAE/E;;;;;GAKG;AACH,MAAM,MAAM,sDAAsD,GAAG;IACnE,IAAI,EAAE,mDAAmD,CAAC;IAC1D,OAAO,EAAE,0BAA0B,CAAC,wBAAwB,CAAC,CAAC;CAC/D,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,qDAAqD,GAAG;IAClE,IAAI,EAAE,kDAAkD,CAAC;IACzD,OAAO,EAAE,0BAA0B,CAAC,uBAAuB,CAAC,CAAC;CAC9D,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,oEAAoE,GAC9E;IACE,IAAI,EAAE,iEAAiE,CAAC;IACxE,OAAO,EAAE,0BAA0B,CAAC,sCAAsC,CAAC,CAAC;CAC7E,CAAC;AAEJ;;;;GAIG;AACH,MAAM,MAAM,qDAAqD,GAAG;IAClE,IAAI,EAAE,kDAAkD,CAAC;IACzD,OAAO,EAAE,0BAA0B,CAAC,uBAAuB,CAAC,CAAC;CAC9D,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,8CAA8C,GAAG;IAC3D,IAAI,EAAE,2CAA2C,CAAC;IAClD,OAAO,EAAE,0BAA0B,CAAC,gBAAgB,CAAC,CAAC;CACvD,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,uDAAuD,GAAG;IACpE,IAAI,EAAE,oDAAoD,CAAC;IAC3D,OAAO,EAAE,0BAA0B,CAAC,yBAAyB,CAAC,CAAC;CAChE,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uCAAuC,GAC/C,sDAAsD,GACtD,qDAAqD,GACrD,oEAAoE,GACpE,qDAAqD,GACrD,8CAA8C,GAC9C,uDAAuD,CAAC"}

package/dist/AnalyticsPrivacyController-method-action-types.mjs

@@ -0,0 +1,6 @@
+/**
+ * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * Do not edit manually.
+ */
+export {};
+//# sourceMappingURL=AnalyticsPrivacyController-method-action-types.mjs.map

package/dist/AnalyticsPrivacyController-method-action-types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"AnalyticsPrivacyController-method-action-types.mjs","sourceRoot":"","sources":["../src/AnalyticsPrivacyController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated by `scripts/generate-method-action-types.ts`.\n * Do not edit manually.\n */\n\nimport type { AnalyticsPrivacyController } from './AnalyticsPrivacyController';\n\n/**\n * Creates a new delete regulation for the user.\n * This is necessary to respect the GDPR and CCPA regulations.\n *\n * @returns Promise containing the status of the request\n */\nexport type AnalyticsPrivacyControllerCreateDataDeletionTaskAction = {\n  type: `AnalyticsPrivacyController:createDataDeletionTask`;\n  handler: AnalyticsPrivacyController['createDataDeletionTask'];\n};\n\n/**\n * Check the latest delete regulation status.\n *\n * @returns Promise containing the timestamp, delete status and collected data flag\n */\nexport type AnalyticsPrivacyControllerCheckDataDeleteStatusAction = {\n  type: `AnalyticsPrivacyController:checkDataDeleteStatus`;\n  handler: AnalyticsPrivacyController['checkDataDeleteStatus'];\n};\n\n/**\n * Get the latest delete regulation request timestamp.\n *\n * @returns The timestamp (in milliseconds since epoch), or undefined\n */\nexport type AnalyticsPrivacyControllerGetDeleteRegulationCreationTimestampAction =\n  {\n    type: `AnalyticsPrivacyController:getDeleteRegulationCreationTimestamp`;\n    handler: AnalyticsPrivacyController['getDeleteRegulationCreationTimestamp'];\n  };\n\n/**\n * Get the latest delete regulation request id.\n *\n * @returns The id string, or undefined\n */\nexport type AnalyticsPrivacyControllerGetDeleteRegulationIdAction = {\n  type: `AnalyticsPrivacyController:getDeleteRegulationId`;\n  handler: AnalyticsPrivacyController['getDeleteRegulationId'];\n};\n\n/**\n * Indicate if events have been recorded since the last deletion request.\n *\n * @returns true if events have been recorded since the last deletion request\n */\nexport type AnalyticsPrivacyControllerIsDataRecordedAction = {\n  type: `AnalyticsPrivacyController:isDataRecorded`;\n  handler: AnalyticsPrivacyController['isDataRecorded'];\n};\n\n/**\n * Update the data recording flag if needed.\n * This method should be called after tracking events to ensure\n * the data recording flag is properly updated for data deletion workflows.\n *\n * @param saveDataRecording - Whether to save the data recording flag (default: true)\n */\nexport type AnalyticsPrivacyControllerUpdateDataRecordingFlagAction = {\n  type: `AnalyticsPrivacyController:updateDataRecordingFlag`;\n  handler: AnalyticsPrivacyController['updateDataRecordingFlag'];\n};\n\n/**\n * Union of all AnalyticsPrivacyController action types.\n */\nexport type AnalyticsPrivacyControllerMethodActions =\n  | AnalyticsPrivacyControllerCreateDataDeletionTaskAction\n  | AnalyticsPrivacyControllerCheckDataDeleteStatusAction\n  | AnalyticsPrivacyControllerGetDeleteRegulationCreationTimestampAction\n  | AnalyticsPrivacyControllerGetDeleteRegulationIdAction\n  | AnalyticsPrivacyControllerIsDataRecordedAction\n  | AnalyticsPrivacyControllerUpdateDataRecordingFlagAction;\n"]}

package/dist/AnalyticsPrivacyController.cjs

@@ -0,0 +1,207 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AnalyticsPrivacyController = exports.getDefaultAnalyticsPrivacyControllerState = exports.controllerName = void 0;
+const base_controller_1 = require("@metamask/base-controller");
+const AnalyticsPrivacyLogger_1 = require("./AnalyticsPrivacyLogger.cjs");
+const types_1 = require("./types.cjs");
+// === GENERAL ===
+/**
+ * The name of the {@link AnalyticsPrivacyController}, used to namespace the
+ * controller's actions and events and to namespace the controller's state data
+ * when composed with other controllers.
+ */
+exports.controllerName = 'AnalyticsPrivacyController';
+/**
+ * Returns default values for AnalyticsPrivacyController state.
+ *
+ * @returns Default state
+ */
+function getDefaultAnalyticsPrivacyControllerState() {
+    return {
+        dataRecorded: false,
+        deleteRegulationId: null,
+        deleteRegulationTimestamp: null,
+    };
+}
+exports.getDefaultAnalyticsPrivacyControllerState = getDefaultAnalyticsPrivacyControllerState;
+/**
+ * The metadata for each property in {@link AnalyticsPrivacyControllerState}.
+ */
+const analyticsPrivacyControllerMetadata = {
+    dataRecorded: {
+        includeInStateLogs: true,
+        persist: true,
+        includeInDebugSnapshot: true,
+        usedInUi: true,
+    },
+    deleteRegulationId: {
+        includeInStateLogs: true,
+        persist: true,
+        includeInDebugSnapshot: true,
+        usedInUi: true,
+    },
+    deleteRegulationTimestamp: {
+        includeInStateLogs: true,
+        persist: true,
+        includeInDebugSnapshot: true,
+        usedInUi: true,
+    },
+};
+// === MESSENGER ===
+const MESSENGER_EXPOSED_METHODS = [
+    'createDataDeletionTask',
+    'checkDataDeleteStatus',
+    'getDeleteRegulationCreationTimestamp',
+    'getDeleteRegulationId',
+    'isDataRecorded',
+    'updateDataRecordingFlag',
+];
+/**
+ * The AnalyticsPrivacyController manages analytics privacy and GDPR/CCPA data deletion functionality.
+ * It communicates with Segment's Regulations API via a proxy to create and monitor data deletion requests.
+ *
+ * This controller follows the MetaMask controller pattern and integrates with the
+ * messenger system to allow other controllers and components to manage data deletion tasks.
+ */
+class AnalyticsPrivacyController extends base_controller_1.BaseController {
+    /**
+     * Constructs an AnalyticsPrivacyController instance.
+     *
+     * @param options - Controller options
+     * @param options.state - Initial controller state. Use `getDefaultAnalyticsPrivacyControllerState()` for defaults.
+     * @param options.messenger - Messenger used to communicate with BaseController
+     */
+    constructor({ state = {}, messenger }) {
+        const initialState = {
+            ...getDefaultAnalyticsPrivacyControllerState(),
+            ...state,
+        };
+        super({
+            name: exports.controllerName,
+            metadata: analyticsPrivacyControllerMetadata,
+            state: initialState,
+            messenger,
+        });
+        this.messenger.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
+        (0, AnalyticsPrivacyLogger_1.projectLogger)('AnalyticsPrivacyController initialized', {
+            dataRecorded: this.state.dataRecorded,
+            hasDeleteRegulationId: Boolean(this.state.deleteRegulationId),
+            deleteRegulationTimestamp: this.state.deleteRegulationTimestamp,
+        });
+    }
+    /**
+     * Creates a new delete regulation for the user.
+     * This is necessary to respect the GDPR and CCPA regulations.
+     *
+     * @returns Promise containing the status of the request
+     */
+    async createDataDeletionTask() {
+        try {
+            const analyticsControllerState = this.messenger.call('AnalyticsController:getState');
+            const { analyticsId } = analyticsControllerState;
+            if (!analyticsId || analyticsId.trim() === '') {
+                const error = new Error('Analytics ID not found');
+                (0, AnalyticsPrivacyLogger_1.projectLogger)('Analytics Deletion Task Error', error);
+                return {
+                    status: types_1.DataDeleteResponseStatus.Failure,
+                    error: 'Analytics ID not found',
+                };
+            }
+            const response = await this.messenger.call('AnalyticsPrivacyService:createDataDeletionTask', analyticsId);
+            if (response.status === types_1.DataDeleteResponseStatus.Success &&
+                response.regulateId &&
+                typeof response.regulateId === 'string' &&
+                response.regulateId.trim() !== '') {
+                const deletionTimestamp = Date.now();
+                // Already validated as non-empty string above
+                const { regulateId } = response;
+                this.update((state) => {
+                    state.deleteRegulationId = regulateId;
+                    state.deleteRegulationTimestamp = deletionTimestamp;
+                    state.dataRecorded = false;
+                });
+                this.messenger.publish(`${exports.controllerName}:dataDeletionTaskCreated`, response);
+            }
+            return response;
+        }
+        catch (error) {
+            (0, AnalyticsPrivacyLogger_1.projectLogger)('Analytics Deletion Task Error', error);
+            const errorMessage = error instanceof Error
+                ? error.message
+                : 'Analytics Deletion Task Error';
+            return {
+                status: types_1.DataDeleteResponseStatus.Failure,
+                error: errorMessage,
+            };
+        }
+    }
+    /**
+     * Check the latest delete regulation status.
+     *
+     * @returns Promise containing the timestamp, delete status and collected data flag
+     */
+    async checkDataDeleteStatus() {
+        const status = {
+            deletionRequestTimestamp: undefined,
+            dataDeletionRequestStatus: types_1.DataDeleteStatus.Unknown,
+            hasCollectedDataSinceDeletionRequest: false,
+        };
+        if (!this.state.deleteRegulationId) {
+            return status;
+        }
+        try {
+            const dataDeletionTaskStatus = await this.messenger.call('AnalyticsPrivacyService:checkDataDeleteStatus', this.state.deleteRegulationId);
+            status.dataDeletionRequestStatus =
+                dataDeletionTaskStatus.dataDeleteStatus;
+        }
+        catch (error) {
+            (0, AnalyticsPrivacyLogger_1.projectLogger)('Error checkDataDeleteStatus', error);
+            status.dataDeletionRequestStatus = types_1.DataDeleteStatus.Unknown;
+        }
+        status.deletionRequestTimestamp =
+            this.state.deleteRegulationTimestamp ?? undefined;
+        status.hasCollectedDataSinceDeletionRequest = this.state.dataRecorded;
+        return status;
+    }
+    /**
+     * Get the latest delete regulation request timestamp.
+     *
+     * @returns The timestamp (in milliseconds since epoch), or undefined
+     */
+    getDeleteRegulationCreationTimestamp() {
+        return this.state.deleteRegulationTimestamp ?? undefined;
+    }
+    /**
+     * Get the latest delete regulation request id.
+     *
+     * @returns The id string, or undefined
+     */
+    getDeleteRegulationId() {
+        return this.state.deleteRegulationId ?? undefined;
+    }
+    /**
+     * Indicate if events have been recorded since the last deletion request.
+     *
+     * @returns true if events have been recorded since the last deletion request
+     */
+    isDataRecorded() {
+        return this.state.dataRecorded;
+    }
+    /**
+     * Update the data recording flag if needed.
+     * This method should be called after tracking events to ensure
+     * the data recording flag is properly updated for data deletion workflows.
+     *
+     * @param saveDataRecording - Whether to save the data recording flag (default: true)
+     */
+    updateDataRecordingFlag(saveDataRecording = true) {
+        if (saveDataRecording && !this.state.dataRecorded) {
+            this.update((state) => {
+                state.dataRecorded = true;
+            });
+            this.messenger.publish(`${exports.controllerName}:dataRecordingFlagUpdated`, true);
+        }
+    }
+}
+exports.AnalyticsPrivacyController = AnalyticsPrivacyController;
+//# sourceMappingURL=AnalyticsPrivacyController.cjs.map

package/dist/AnalyticsPrivacyController.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"AnalyticsPrivacyController.cjs","sourceRoot":"","sources":["../src/AnalyticsPrivacyController.ts"],"names":[],"mappings":";;;AAMA,+DAA2D;AAI3D,yEAAgE;AAEhE,uCAAqE;AAMrE,kBAAkB;AAElB;;;;GAIG;AACU,QAAA,cAAc,GAAG,4BAA4B,CAAC;AA0B3D;;;;GAIG;AACH,SAAgB,yCAAyC;IACvD,OAAO;QACL,YAAY,EAAE,KAAK;QACnB,kBAAkB,EAAE,IAAI;QACxB,yBAAyB,EAAE,IAAI;KAChC,CAAC;AACJ,CAAC;AAND,8FAMC;AAED;;GAEG;AACH,MAAM,kCAAkC,GAAG;IACzC,YAAY,EAAE;QACZ,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,IAAI;QAC5B,QAAQ,EAAE,IAAI;KACf;IACD,kBAAkB,EAAE;QAClB,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,IAAI;QAC5B,QAAQ,EAAE,IAAI;KACf;IACD,yBAAyB,EAAE;QACzB,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,IAAI;QAC5B,QAAQ,EAAE,IAAI;KACf;CACuD,CAAC;AAE3D,oBAAoB;AAEpB,MAAM,yBAAyB,GAAG;IAChC,wBAAwB;IACxB,uBAAuB;IACvB,sCAAsC;IACtC,uBAAuB;IACvB,gBAAgB;IAChB,yBAAyB;CACjB,CAAC;AAwFX;;;;;;GAMG;AACH,MAAa,0BAA2B,SAAQ,gCAI/C;IACC;;;;;;OAMG;IACH,YAAY,EAAE,KAAK,GAAG,EAAE,EAAE,SAAS,EAAqC;QACtE,MAAM,YAAY,GAAoC;YACpD,GAAG,yCAAyC,EAAE;YAC9C,GAAG,KAAK;SACT,CAAC;QAEF,KAAK,CAAC;YACJ,IAAI,EAAE,sBAAc;YACpB,QAAQ,EAAE,kCAAkC;YAC5C,KAAK,EAAE,YAAY;YACnB,SAAS;SACV,CAAC,CAAC;QAEH,IAAI,CAAC,SAAS,CAAC,4BAA4B,CACzC,IAAI,EACJ,yBAAyB,CAC1B,CAAC;QAEF,IAAA,sCAAG,EAAC,wCAAwC,EAAE;YAC5C,YAAY,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY;YACrC,qBAAqB,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC;YAC7D,yBAAyB,EAAE,IAAI,CAAC,KAAK,CAAC,yBAAyB;SAChE,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,sBAAsB;QAC1B,IAAI,CAAC;YACH,MAAM,wBAAwB,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAClD,8BAA8B,CAC/B,CAAC;YACF,MAAM,EAAE,WAAW,EAAE,GAAG,wBAAwB,CAAC;YAEjD,IAAI,CAAC,WAAW,IAAI,WAAW,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;gBAC9C,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;gBAClD,IAAA,sCAAG,EAAC,+BAA+B,EAAE,KAAK,CAAC,CAAC;gBAC5C,OAAO;oBACL,MAAM,EAAE,gCAAwB,CAAC,OAAO;oBACxC,KAAK,EAAE,wBAAwB;iBAChC,CAAC;YACJ,CAAC;YAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CACxC,gDAAgD,EAChD,WAAW,CACZ,CAAC;YAEF,IACE,QAAQ,CAAC,MAAM,KAAK,gCAAwB,CAAC,OAAO;gBACpD,QAAQ,CAAC,UAAU;gBACnB,OAAO,QAAQ,CAAC,UAAU,KAAK,QAAQ;gBACvC,QAAQ,CAAC,UAAU,CAAC,IAAI,EAAE,KAAK,EAAE,EACjC,CAAC;gBACD,MAAM,iBAAiB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;gBACrC,8CAA8C;gBAC9C,MAAM,EAAE,UAAU,EAAE,GAAG,QAAQ,CAAC;gBAEhC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;oBACpB,KAAK,CAAC,kBAAkB,GAAG,UAAU,CAAC;oBACtC,KAAK,CAAC,yBAAyB,GAAG,iBAAiB,CAAC;oBACpD,KAAK,CAAC,YAAY,GAAG,KAAK,CAAC;gBAC7B,CAAC,CAAC,CAAC;gBAEH,IAAI,CAAC,SAAS,CAAC,OAAO,CACpB,GAAG,sBAAc,0BAA0B,EAC3C,QAAQ,CACT,CAAC;YACJ,CAAC;YAED,OAAO,QAAQ,CAAC;QAClB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAA,sCAAG,EAAC,+BAA+B,EAAE,KAAK,CAAC,CAAC;YAC5C,MAAM,YAAY,GAChB,KAAK,YAAY,KAAK;gBACpB,CAAC,CAAC,KAAK,CAAC,OAAO;gBACf,CAAC,CAAC,+BAA+B,CAAC;YACtC,OAAO;gBACL,MAAM,EAAE,gCAAwB,CAAC,OAAO;gBACxC,KAAK,EAAE,YAAY;aACpB,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,qBAAqB;QACzB,MAAM,MAAM,GAA4B;YACtC,wBAAwB,EAAE,SAAS;YACnC,yBAAyB,EAAE,wBAAgB,CAAC,OAAO;YACnD,oCAAoC,EAAE,KAAK;SAC5C,CAAC;QAEF,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,kBAAkB,EAAE,CAAC;YACnC,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,IAAI,CAAC;YACH,MAAM,sBAAsB,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CACtD,+CAA+C,EAC/C,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAC9B,CAAC;YAEF,MAAM,CAAC,yBAAyB;gBAC9B,sBAAsB,CAAC,gBAAgB,CAAC;QAC5C,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAA,sCAAG,EAAC,6BAA6B,EAAE,KAAK,CAAC,CAAC;YAC1C,MAAM,CAAC,yBAAyB,GAAG,wBAAgB,CAAC,OAAO,CAAC;QAC9D,CAAC;QAED,MAAM,CAAC,wBAAwB;YAC7B,IAAI,CAAC,KAAK,CAAC,yBAAyB,IAAI,SAAS,CAAC;QACpD,MAAM,CAAC,oCAAoC,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC;QAEtE,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACH,oCAAoC;QAClC,OAAO,IAAI,CAAC,KAAK,CAAC,yBAAyB,IAAI,SAAS,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACH,qBAAqB;QACnB,OAAO,IAAI,CAAC,KAAK,CAAC,kBAAkB,IAAI,SAAS,CAAC;IACpD,CAAC;IAED;;;;OAIG;IACH,cAAc;QACZ,OAAO,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC;IACjC,CAAC;IAED;;;;;;OAMG;IACH,uBAAuB,CAAC,oBAA6B,IAAI;QACvD,IAAI,iBAAiB,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC;YAClD,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;YAC5B,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,SAAS,CAAC,OAAO,CACpB,GAAG,sBAAc,2BAA2B,EAC5C,IAAI,CACL,CAAC;QACJ,CAAC;IACH,CAAC;CACF;AAtLD,gEAsLC","sourcesContent":["import type { AnalyticsControllerGetStateAction } from '@metamask/analytics-controller';\nimport type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n  StateMetadata,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport type { Messenger } from '@metamask/messenger';\n\nimport type { AnalyticsPrivacyControllerMethodActions } from './AnalyticsPrivacyController-method-action-types';\nimport { projectLogger as log } from './AnalyticsPrivacyLogger';\nimport type { AnalyticsPrivacyServiceActions } from './AnalyticsPrivacyService';\nimport { DataDeleteResponseStatus, DataDeleteStatus } from './types';\nimport type {\n  IDeleteRegulationResponse,\n  IDeleteRegulationStatus,\n} from './types';\n\n// === GENERAL ===\n\n/**\n * The name of the {@link AnalyticsPrivacyController}, used to namespace the\n * controller's actions and events and to namespace the controller's state data\n * when composed with other controllers.\n */\nexport const controllerName = 'AnalyticsPrivacyController';\n\n// === STATE ===\n\n/**\n * Describes the shape of the state object for {@link AnalyticsPrivacyController}.\n */\nexport type AnalyticsPrivacyControllerState = {\n  /**\n   * Indicates if data has been recorded since the last deletion request.\n   */\n  dataRecorded: boolean;\n\n  /**\n   * Segment's data deletion regulation ID.\n   * The ID returned by the Segment delete API which allows checking the status of the deletion request.\n   */\n  deleteRegulationId: string | null;\n\n  /**\n   * Segment's data deletion regulation creation timestamp.\n   * The timestamp (in milliseconds since epoch) when the deletion request was created.\n   */\n  deleteRegulationTimestamp: number | null;\n};\n\n/**\n * Returns default values for AnalyticsPrivacyController state.\n *\n * @returns Default state\n */\nexport function getDefaultAnalyticsPrivacyControllerState(): AnalyticsPrivacyControllerState {\n  return {\n    dataRecorded: false,\n    deleteRegulationId: null,\n    deleteRegulationTimestamp: null,\n  };\n}\n\n/**\n * The metadata for each property in {@link AnalyticsPrivacyControllerState}.\n */\nconst analyticsPrivacyControllerMetadata = {\n  dataRecorded: {\n    includeInStateLogs: true,\n    persist: true,\n    includeInDebugSnapshot: true,\n    usedInUi: true,\n  },\n  deleteRegulationId: {\n    includeInStateLogs: true,\n    persist: true,\n    includeInDebugSnapshot: true,\n    usedInUi: true,\n  },\n  deleteRegulationTimestamp: {\n    includeInStateLogs: true,\n    persist: true,\n    includeInDebugSnapshot: true,\n    usedInUi: true,\n  },\n} satisfies StateMetadata<AnalyticsPrivacyControllerState>;\n\n// === MESSENGER ===\n\nconst MESSENGER_EXPOSED_METHODS = [\n  'createDataDeletionTask',\n  'checkDataDeleteStatus',\n  'getDeleteRegulationCreationTimestamp',\n  'getDeleteRegulationId',\n  'isDataRecorded',\n  'updateDataRecordingFlag',\n] as const;\n\n/**\n * Returns the state of the {@link AnalyticsPrivacyController}.\n */\nexport type AnalyticsPrivacyControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  AnalyticsPrivacyControllerState\n>;\n\n/**\n * Actions that {@link AnalyticsPrivacyControllerMessenger} exposes to other consumers.\n */\nexport type AnalyticsPrivacyControllerActions =\n  | AnalyticsPrivacyControllerGetStateAction\n  | AnalyticsPrivacyControllerMethodActions;\n\n/**\n * Actions from other messengers that {@link AnalyticsPrivacyControllerMessenger} calls.\n */\ntype AllowedActions =\n  | AnalyticsControllerGetStateAction\n  | AnalyticsPrivacyServiceActions;\n\n/**\n * Event emitted when a data deletion task is created.\n */\nexport type DataDeletionTaskCreatedEvent = {\n  type: `${typeof controllerName}:dataDeletionTaskCreated`;\n  payload: [IDeleteRegulationResponse];\n};\n\n/**\n * Event emitted when the data recording flag is updated.\n */\nexport type DataRecordingFlagUpdatedEvent = {\n  type: `${typeof controllerName}:dataRecordingFlagUpdated`;\n  payload: [boolean];\n};\n\n/**\n * Event emitted when the state of the {@link AnalyticsPrivacyController} changes.\n */\nexport type AnalyticsPrivacyControllerStateChangeEvent =\n  ControllerStateChangeEvent<\n    typeof controllerName,\n    AnalyticsPrivacyControllerState\n  >;\n\n/**\n * Events that {@link AnalyticsPrivacyControllerMessenger} exposes to other consumers.\n */\nexport type AnalyticsPrivacyControllerEvents =\n  | AnalyticsPrivacyControllerStateChangeEvent\n  | DataDeletionTaskCreatedEvent\n  | DataRecordingFlagUpdatedEvent;\n\n/**\n * Events from other messengers that {@link AnalyticsPrivacyControllerMessenger} subscribes to.\n */\ntype AllowedEvents = never;\n\n/**\n * The messenger restricted to actions and events accessed by\n * {@link AnalyticsPrivacyController}.\n */\nexport type AnalyticsPrivacyControllerMessenger = Messenger<\n  typeof controllerName,\n  AnalyticsPrivacyControllerActions | AllowedActions,\n  AnalyticsPrivacyControllerEvents | AllowedEvents\n>;\n\n// === CONTROLLER DEFINITION ===\n\n/**\n * The options that AnalyticsPrivacyController takes.\n */\nexport type AnalyticsPrivacyControllerOptions = {\n  /**\n   * Initial controller state.\n   */\n  state?: Partial<AnalyticsPrivacyControllerState>;\n  /**\n   * Messenger used to communicate with BaseController and other controllers.\n   */\n  messenger: AnalyticsPrivacyControllerMessenger;\n};\n\n/**\n * The AnalyticsPrivacyController manages analytics privacy and GDPR/CCPA data deletion functionality.\n * It communicates with Segment's Regulations API via a proxy to create and monitor data deletion requests.\n *\n * This controller follows the MetaMask controller pattern and integrates with the\n * messenger system to allow other controllers and components to manage data deletion tasks.\n */\nexport class AnalyticsPrivacyController extends BaseController<\n  typeof controllerName,\n  AnalyticsPrivacyControllerState,\n  AnalyticsPrivacyControllerMessenger\n> {\n  /**\n   * Constructs an AnalyticsPrivacyController instance.\n   *\n   * @param options - Controller options\n   * @param options.state - Initial controller state. Use `getDefaultAnalyticsPrivacyControllerState()` for defaults.\n   * @param options.messenger - Messenger used to communicate with BaseController\n   */\n  constructor({ state = {}, messenger }: AnalyticsPrivacyControllerOptions) {\n    const initialState: AnalyticsPrivacyControllerState = {\n      ...getDefaultAnalyticsPrivacyControllerState(),\n      ...state,\n    };\n\n    super({\n      name: controllerName,\n      metadata: analyticsPrivacyControllerMetadata,\n      state: initialState,\n      messenger,\n    });\n\n    this.messenger.registerMethodActionHandlers(\n      this,\n      MESSENGER_EXPOSED_METHODS,\n    );\n\n    log('AnalyticsPrivacyController initialized', {\n      dataRecorded: this.state.dataRecorded,\n      hasDeleteRegulationId: Boolean(this.state.deleteRegulationId),\n      deleteRegulationTimestamp: this.state.deleteRegulationTimestamp,\n    });\n  }\n\n  /**\n   * Creates a new delete regulation for the user.\n   * This is necessary to respect the GDPR and CCPA regulations.\n   *\n   * @returns Promise containing the status of the request\n   */\n  async createDataDeletionTask(): Promise<IDeleteRegulationResponse> {\n    try {\n      const analyticsControllerState = this.messenger.call(\n        'AnalyticsController:getState',\n      );\n      const { analyticsId } = analyticsControllerState;\n\n      if (!analyticsId || analyticsId.trim() === '') {\n        const error = new Error('Analytics ID not found');\n        log('Analytics Deletion Task Error', error);\n        return {\n          status: DataDeleteResponseStatus.Failure,\n          error: 'Analytics ID not found',\n        };\n      }\n\n      const response = await this.messenger.call(\n        'AnalyticsPrivacyService:createDataDeletionTask',\n        analyticsId,\n      );\n\n      if (\n        response.status === DataDeleteResponseStatus.Success &&\n        response.regulateId &&\n        typeof response.regulateId === 'string' &&\n        response.regulateId.trim() !== ''\n      ) {\n        const deletionTimestamp = Date.now();\n        // Already validated as non-empty string above\n        const { regulateId } = response;\n\n        this.update((state) => {\n          state.deleteRegulationId = regulateId;\n          state.deleteRegulationTimestamp = deletionTimestamp;\n          state.dataRecorded = false;\n        });\n\n        this.messenger.publish(\n          `${controllerName}:dataDeletionTaskCreated`,\n          response,\n        );\n      }\n\n      return response;\n    } catch (error) {\n      log('Analytics Deletion Task Error', error);\n      const errorMessage =\n        error instanceof Error\n          ? error.message\n          : 'Analytics Deletion Task Error';\n      return {\n        status: DataDeleteResponseStatus.Failure,\n        error: errorMessage,\n      };\n    }\n  }\n\n  /**\n   * Check the latest delete regulation status.\n   *\n   * @returns Promise containing the timestamp, delete status and collected data flag\n   */\n  async checkDataDeleteStatus(): Promise<IDeleteRegulationStatus> {\n    const status: IDeleteRegulationStatus = {\n      deletionRequestTimestamp: undefined,\n      dataDeletionRequestStatus: DataDeleteStatus.Unknown,\n      hasCollectedDataSinceDeletionRequest: false,\n    };\n\n    if (!this.state.deleteRegulationId) {\n      return status;\n    }\n\n    try {\n      const dataDeletionTaskStatus = await this.messenger.call(\n        'AnalyticsPrivacyService:checkDataDeleteStatus',\n        this.state.deleteRegulationId,\n      );\n\n      status.dataDeletionRequestStatus =\n        dataDeletionTaskStatus.dataDeleteStatus;\n    } catch (error) {\n      log('Error checkDataDeleteStatus', error);\n      status.dataDeletionRequestStatus = DataDeleteStatus.Unknown;\n    }\n\n    status.deletionRequestTimestamp =\n      this.state.deleteRegulationTimestamp ?? undefined;\n    status.hasCollectedDataSinceDeletionRequest = this.state.dataRecorded;\n\n    return status;\n  }\n\n  /**\n   * Get the latest delete regulation request timestamp.\n   *\n   * @returns The timestamp (in milliseconds since epoch), or undefined\n   */\n  getDeleteRegulationCreationTimestamp(): number | undefined {\n    return this.state.deleteRegulationTimestamp ?? undefined;\n  }\n\n  /**\n   * Get the latest delete regulation request id.\n   *\n   * @returns The id string, or undefined\n   */\n  getDeleteRegulationId(): string | undefined {\n    return this.state.deleteRegulationId ?? undefined;\n  }\n\n  /**\n   * Indicate if events have been recorded since the last deletion request.\n   *\n   * @returns true if events have been recorded since the last deletion request\n   */\n  isDataRecorded(): boolean {\n    return this.state.dataRecorded;\n  }\n\n  /**\n   * Update the data recording flag if needed.\n   * This method should be called after tracking events to ensure\n   * the data recording flag is properly updated for data deletion workflows.\n   *\n   * @param saveDataRecording - Whether to save the data recording flag (default: true)\n   */\n  updateDataRecordingFlag(saveDataRecording: boolean = true): void {\n    if (saveDataRecording && !this.state.dataRecorded) {\n      this.update((state) => {\n        state.dataRecorded = true;\n      });\n\n      this.messenger.publish(\n        `${controllerName}:dataRecordingFlagUpdated`,\n        true,\n      );\n    }\n  }\n}\n"]}

package/dist/AnalyticsPrivacyController.d.cts

@@ -0,0 +1,152 @@
+import type { AnalyticsControllerGetStateAction } from "@metamask/analytics-controller";
+import type { ControllerGetStateAction, ControllerStateChangeEvent } from "@metamask/base-controller";
+import { BaseController } from "@metamask/base-controller";
+import type { Messenger } from "@metamask/messenger";
+import type { AnalyticsPrivacyControllerMethodActions } from "./AnalyticsPrivacyController-method-action-types.cjs";
+import type { AnalyticsPrivacyServiceActions } from "./AnalyticsPrivacyService.cjs";
+import type { IDeleteRegulationResponse, IDeleteRegulationStatus } from "./types.cjs";
+/**
+ * The name of the {@link AnalyticsPrivacyController}, used to namespace the
+ * controller's actions and events and to namespace the controller's state data
+ * when composed with other controllers.
+ */
+export declare const controllerName = "AnalyticsPrivacyController";
+/**
+ * Describes the shape of the state object for {@link AnalyticsPrivacyController}.
+ */
+export type AnalyticsPrivacyControllerState = {
+    /**
+     * Indicates if data has been recorded since the last deletion request.
+     */
+    dataRecorded: boolean;
+    /**
+     * Segment's data deletion regulation ID.
+     * The ID returned by the Segment delete API which allows checking the status of the deletion request.
+     */
+    deleteRegulationId: string | null;
+    /**
+     * Segment's data deletion regulation creation timestamp.
+     * The timestamp (in milliseconds since epoch) when the deletion request was created.
+     */
+    deleteRegulationTimestamp: number | null;
+};
+/**
+ * Returns default values for AnalyticsPrivacyController state.
+ *
+ * @returns Default state
+ */
+export declare function getDefaultAnalyticsPrivacyControllerState(): AnalyticsPrivacyControllerState;
+/**
+ * Returns the state of the {@link AnalyticsPrivacyController}.
+ */
+export type AnalyticsPrivacyControllerGetStateAction = ControllerGetStateAction<typeof controllerName, AnalyticsPrivacyControllerState>;
+/**
+ * Actions that {@link AnalyticsPrivacyControllerMessenger} exposes to other consumers.
+ */
+export type AnalyticsPrivacyControllerActions = AnalyticsPrivacyControllerGetStateAction | AnalyticsPrivacyControllerMethodActions;
+/**
+ * Actions from other messengers that {@link AnalyticsPrivacyControllerMessenger} calls.
+ */
+type AllowedActions = AnalyticsControllerGetStateAction | AnalyticsPrivacyServiceActions;
+/**
+ * Event emitted when a data deletion task is created.
+ */
+export type DataDeletionTaskCreatedEvent = {
+    type: `${typeof controllerName}:dataDeletionTaskCreated`;
+    payload: [IDeleteRegulationResponse];
+};
+/**
+ * Event emitted when the data recording flag is updated.
+ */
+export type DataRecordingFlagUpdatedEvent = {
+    type: `${typeof controllerName}:dataRecordingFlagUpdated`;
+    payload: [boolean];
+};
+/**
+ * Event emitted when the state of the {@link AnalyticsPrivacyController} changes.
+ */
+export type AnalyticsPrivacyControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, AnalyticsPrivacyControllerState>;
+/**
+ * Events that {@link AnalyticsPrivacyControllerMessenger} exposes to other consumers.
+ */
+export type AnalyticsPrivacyControllerEvents = AnalyticsPrivacyControllerStateChangeEvent | DataDeletionTaskCreatedEvent | DataRecordingFlagUpdatedEvent;
+/**
+ * Events from other messengers that {@link AnalyticsPrivacyControllerMessenger} subscribes to.
+ */
+type AllowedEvents = never;
+/**
+ * The messenger restricted to actions and events accessed by
+ * {@link AnalyticsPrivacyController}.
+ */
+export type AnalyticsPrivacyControllerMessenger = Messenger<typeof controllerName, AnalyticsPrivacyControllerActions | AllowedActions, AnalyticsPrivacyControllerEvents | AllowedEvents>;
+/**
+ * The options that AnalyticsPrivacyController takes.
+ */
+export type AnalyticsPrivacyControllerOptions = {
+    /**
+     * Initial controller state.
+     */
+    state?: Partial<AnalyticsPrivacyControllerState>;
+    /**
+     * Messenger used to communicate with BaseController and other controllers.
+     */
+    messenger: AnalyticsPrivacyControllerMessenger;
+};
+/**
+ * The AnalyticsPrivacyController manages analytics privacy and GDPR/CCPA data deletion functionality.
+ * It communicates with Segment's Regulations API via a proxy to create and monitor data deletion requests.
+ *
+ * This controller follows the MetaMask controller pattern and integrates with the
+ * messenger system to allow other controllers and components to manage data deletion tasks.
+ */
+export declare class AnalyticsPrivacyController extends BaseController<typeof controllerName, AnalyticsPrivacyControllerState, AnalyticsPrivacyControllerMessenger> {
+    /**
+     * Constructs an AnalyticsPrivacyController instance.
+     *
+     * @param options - Controller options
+     * @param options.state - Initial controller state. Use `getDefaultAnalyticsPrivacyControllerState()` for defaults.
+     * @param options.messenger - Messenger used to communicate with BaseController
+     */
+    constructor({ state, messenger }: AnalyticsPrivacyControllerOptions);
+    /**
+     * Creates a new delete regulation for the user.
+     * This is necessary to respect the GDPR and CCPA regulations.
+     *
+     * @returns Promise containing the status of the request
+     */
+    createDataDeletionTask(): Promise<IDeleteRegulationResponse>;
+    /**
+     * Check the latest delete regulation status.
+     *
+     * @returns Promise containing the timestamp, delete status and collected data flag
+     */
+    checkDataDeleteStatus(): Promise<IDeleteRegulationStatus>;
+    /**
+     * Get the latest delete regulation request timestamp.
+     *
+     * @returns The timestamp (in milliseconds since epoch), or undefined
+     */
+    getDeleteRegulationCreationTimestamp(): number | undefined;
+    /**
+     * Get the latest delete regulation request id.
+     *
+     * @returns The id string, or undefined
+     */
+    getDeleteRegulationId(): string | undefined;
+    /**
+     * Indicate if events have been recorded since the last deletion request.
+     *
+     * @returns true if events have been recorded since the last deletion request
+     */
+    isDataRecorded(): boolean;
+    /**
+     * Update the data recording flag if needed.
+     * This method should be called after tracking events to ensure
+     * the data recording flag is properly updated for data deletion workflows.
+     *
+     * @param saveDataRecording - Whether to save the data recording flag (default: true)
+     */
+    updateDataRecordingFlag(saveDataRecording?: boolean): void;
+}
+export {};
+//# sourceMappingURL=AnalyticsPrivacyController.d.cts.map

package/dist/AnalyticsPrivacyController.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AnalyticsPrivacyController.d.cts","sourceRoot":"","sources":["../src/AnalyticsPrivacyController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iCAAiC,EAAE,uCAAuC;AACxF,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAE3B,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AAErD,OAAO,KAAK,EAAE,uCAAuC,EAAE,6DAAyD;AAEhH,OAAO,KAAK,EAAE,8BAA8B,EAAE,sCAAkC;AAEhF,OAAO,KAAK,EACV,yBAAyB,EACzB,uBAAuB,EACxB,oBAAgB;AAIjB;;;;GAIG;AACH,eAAO,MAAM,cAAc,+BAA+B,CAAC;AAI3D;;GAEG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C;;OAEG;IACH,YAAY,EAAE,OAAO,CAAC;IAEtB;;;OAGG;IACH,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,yBAAyB,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1C,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,yCAAyC,IAAI,+BAA+B,CAM3F;AAqCD;;GAEG;AACH,MAAM,MAAM,wCAAwC,GAAG,wBAAwB,CAC7E,OAAO,cAAc,EACrB,+BAA+B,CAChC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iCAAiC,GACzC,wCAAwC,GACxC,uCAAuC,CAAC;AAE5C;;GAEG;AACH,KAAK,cAAc,GACf,iCAAiC,GACjC,8BAA8B,CAAC;AAEnC;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACzC,IAAI,EAAE,GAAG,OAAO,cAAc,0BAA0B,CAAC;IACzD,OAAO,EAAE,CAAC,yBAAyB,CAAC,CAAC;CACtC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C,IAAI,EAAE,GAAG,OAAO,cAAc,2BAA2B,CAAC;IAC1D,OAAO,EAAE,CAAC,OAAO,CAAC,CAAC;CACpB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,0CAA0C,GACpD,0BAA0B,CACxB,OAAO,cAAc,EACrB,+BAA+B,CAChC,CAAC;AAEJ;;GAEG;AACH,MAAM,MAAM,gCAAgC,GACxC,0CAA0C,GAC1C,4BAA4B,GAC5B,6BAA6B,CAAC;AAElC;;GAEG;AACH,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,mCAAmC,GAAG,SAAS,CACzD,OAAO,cAAc,EACrB,iCAAiC,GAAG,cAAc,EAClD,gCAAgC,GAAG,aAAa,CACjD,CAAC;AAIF;;GAEG;AACH,MAAM,MAAM,iCAAiC,GAAG;IAC9C;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC,+BAA+B,CAAC,CAAC;IACjD;;OAEG;IACH,SAAS,EAAE,mCAAmC,CAAC;CAChD,CAAC;AAEF;;;;;;GAMG;AACH,qBAAa,0BAA2B,SAAQ,cAAc,CAC5D,OAAO,cAAc,EACrB,+BAA+B,EAC/B,mCAAmC,CACpC;IACC;;;;;;OAMG;gBACS,EAAE,KAAU,EAAE,SAAS,EAAE,EAAE,iCAAiC;IAyBxE;;;;;OAKG;IACG,sBAAsB,IAAI,OAAO,CAAC,yBAAyB,CAAC;IAyDlE;;;;OAIG;IACG,qBAAqB,IAAI,OAAO,CAAC,uBAAuB,CAAC;IA+B/D;;;;OAIG;IACH,oCAAoC,IAAI,MAAM,GAAG,SAAS;IAI1D;;;;OAIG;IACH,qBAAqB,IAAI,MAAM,GAAG,SAAS;IAI3C;;;;OAIG;IACH,cAAc,IAAI,OAAO;IAIzB;;;;;;OAMG;IACH,uBAAuB,CAAC,iBAAiB,GAAE,OAAc,GAAG,IAAI;CAYjE"}