@metamask-previews/analytics-data-regulation-controller 0.0.0-preview-ec24abb79 → 0.0.0-preview-95a403d7b

package/dist/{types.d.cts → types.d.ts}

@@ -3,14 +3,14 @@
  * Values match Segment API response values exactly.
  */
 export declare const DATA_DELETE_STATUSES: {
-    readonly Failed: "FAILED";
-    readonly Finished: "FINISHED";
-    readonly Initialized: "INITIALIZED";
-    readonly Invalid: "INVALID";
-    readonly NotSupported: "NOT_SUPPORTED";
-    readonly PartialSuccess: "PARTIAL_SUCCESS";
-    readonly Running: "RUNNING";
-    readonly Unknown: "UNKNOWN";
+    readonly Failed: 'FAILED';
+    readonly Finished: 'FINISHED';
+    readonly Initialized: 'INITIALIZED';
+    readonly Invalid: 'INVALID';
+    readonly NotSupported: 'NOT_SUPPORTED';
+    readonly PartialSuccess: 'PARTIAL_SUCCESS';
+    readonly Running: 'RUNNING';
+    readonly Unknown: 'UNKNOWN';
 };
 /**
  * Type union for data deletion status values.
@@ -20,8 +20,8 @@ export type DataDeleteStatus = (typeof DATA_DELETE_STATUSES)[keyof typeof DATA_D
  * Response status for deletion regulation operations.
  */
 export declare const DATA_DELETE_RESPONSE_STATUSES: {
-    readonly Success: "ok";
-    readonly Failure: "error";
+    readonly Success: 'ok';
+    readonly Failure: 'error';
 };
 /**
  * Type union for data deletion response status values.
@@ -43,4 +43,4 @@ export type DeleteRegulationStatus = {
     hasCollectedDataSinceDeletionRequest: boolean;
     dataDeletionRequestStatus: DataDeleteStatus;
 };
-//# sourceMappingURL=types.d.cts.map
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,eAAO,MAAM,oBAAoB;aAC/B,MAAM,EAAE,QAAQ;aAChB,QAAQ,EAAE,UAAU;aACpB,WAAW,EAAE,aAAa;aAC1B,OAAO,EAAE,SAAS;aAClB,YAAY,EAAE,eAAe;aAC7B,cAAc,EAAE,iBAAiB;aACjC,OAAO,EAAE,SAAS;aAClB,OAAO,EAAE,SAAS;CACV,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAC1B,CAAC,OAAO,oBAAoB,CAAC,CAAC,MAAM,OAAO,oBAAoB,CAAC,CAAC;AAEnE;;GAEG;AACH,eAAO,MAAM,6BAA6B;aACxC,OAAO,EAAE,IAAI;aACb,OAAO,EAAE,OAAO;CACR,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAClC,CAAC,OAAO,6BAA6B,CAAC,CAAC,MAAM,OAAO,6BAA6B,CAAC,CAAC;AAErF;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,MAAM,EAAE,OAAO,6BAA6B,CAAC,OAAO,CAAC;IACrD,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,oCAAoC,EAAE,OAAO,CAAC;IAC9C,yBAAyB,EAAE,gBAAgB,CAAC;CAC7C,CAAC"}

package/dist/{types.mjs → types.js}

@@ -19,4 +19,4 @@ export const DATA_DELETE_RESPONSE_STATUSES = {
     Success: 'ok',
     Failure: 'error',
 };
-//# sourceMappingURL=types.mjs.map
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAClC,MAAM,EAAE,QAAQ;IAChB,QAAQ,EAAE,UAAU;IACpB,WAAW,EAAE,aAAa;IAC1B,OAAO,EAAE,SAAS;IAClB,YAAY,EAAE,eAAe;IAC7B,cAAc,EAAE,iBAAiB;IACjC,OAAO,EAAE,SAAS;IAClB,OAAO,EAAE,SAAS;CACV,CAAC;AAQX;;GAEG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG;IAC3C,OAAO,EAAE,IAAI;IACb,OAAO,EAAE,OAAO;CACR,CAAC","sourcesContent":["/**\n * Status values for data deletion requests from Segment API.\n * Values match Segment API response values exactly.\n */\nexport const DATA_DELETE_STATUSES = {\n  Failed: 'FAILED',\n  Finished: 'FINISHED',\n  Initialized: 'INITIALIZED',\n  Invalid: 'INVALID',\n  NotSupported: 'NOT_SUPPORTED',\n  PartialSuccess: 'PARTIAL_SUCCESS',\n  Running: 'RUNNING',\n  Unknown: 'UNKNOWN',\n} as const;\n\n/**\n * Type union for data deletion status values.\n */\nexport type DataDeleteStatus =\n  (typeof DATA_DELETE_STATUSES)[keyof typeof DATA_DELETE_STATUSES];\n\n/**\n * Response status for deletion regulation operations.\n */\nexport const DATA_DELETE_RESPONSE_STATUSES = {\n  Success: 'ok',\n  Failure: 'error',\n} as const;\n\n/**\n * Type union for data deletion response status values.\n */\nexport type DataDeleteResponseStatus =\n  (typeof DATA_DELETE_RESPONSE_STATUSES)[keyof typeof DATA_DELETE_RESPONSE_STATUSES];\n\n/**\n * Response from creating a data deletion task.\n * The service throws errors on failure, so this type only represents the Success case.\n */\nexport type DeleteRegulationResponse = {\n  status: typeof DATA_DELETE_RESPONSE_STATUSES.Success;\n  regulateId: string; // Using exact API field name from Segment API response\n};\n\n/**\n * Status information for a data deletion request.\n */\nexport type DeleteRegulationStatus = {\n  deletionRequestTimestamp?: number;\n  hasCollectedDataSinceDeletionRequest: boolean;\n  dataDeletionRequestStatus: DataDeleteStatus;\n};\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/analytics-data-regulation-controller",
-  "version": "0.0.0-preview-ec24abb79",
+  "version": "0.0.0-preview-95a403d7b",
   "description": "Controller for managing analytics privacy and GDPR/CCPA data deletion functionality",
   "keywords": [
     "Ethereum",
@@ -18,19 +18,12 @@
   "files": [
     "dist/"
   ],
+  "type": "module",
   "sideEffects": false,
-  "main": "./dist/index.cjs",
-  "types": "./dist/index.d.cts",
   "exports": {
     ".": {
-      "import": {
-        "types": "./dist/index.d.mts",
-        "default": "./dist/index.mjs"
-      },
-      "require": {
-        "types": "./dist/index.d.cts",
-        "default": "./dist/index.cjs"
-      }
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
     },
     "./package.json": "./package.json"
   },
@@ -39,9 +32,11 @@
     "registry": "https://registry.npmjs.org/"
   },
   "scripts": {
-    "build": "ts-bridge --project tsconfig.build.json --verbose --clean --no-references",
-    "build:all": "ts-bridge --project tsconfig.build.json --verbose --clean",
+    "build": "tsc --project tsconfig.build.json",
+    "build:all": "tsc --build tsconfig.build.json --verbose",
+    "build:clean": "yarn build:only-clean && yarn build",
     "build:docs": "typedoc",
+    "build:only-clean": "rimraf './dist' './tsconfig.build.tsbuildinfo'",
     "changelog:update": "../../scripts/update-changelog.sh @metamask/analytics-data-regulation-controller",
     "changelog:validate": "../../scripts/validate-changelog.sh @metamask/analytics-data-regulation-controller",
     "lint:tsconfigs": "tsx ../../scripts/lint-tsconfigs/lint-tsconfigs.mts",
@@ -55,25 +50,26 @@
     "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch"
   },
   "dependencies": {
-    "@metamask/base-controller": "^9.1.0",
-    "@metamask/controller-utils": "^12.3.0",
-    "@metamask/messenger": "^2.0.0",
-    "@metamask/utils": "^11.11.0"
+    "@metamask/base-controller": "^10.0.0",
+    "@metamask/controller-utils": "^13.0.0",
+    "@metamask/messenger": "^3.0.0",
+    "@metamask/utils": "^12.0.0"
   },
   "devDependencies": {
     "@metamask/auto-changelog": "^6.1.0",
-    "@ts-bridge/cli": "^0.6.4",
     "@types/jest": "^30.0.0",
+    "@typescript/native": "npm:typescript@^7.0.2",
     "deepmerge": "^4.2.2",
     "jest": "^30.4.2",
     "nock": "^13.3.1",
+    "rimraf": "^5.0.5",
     "ts-jest": "^29.4.11",
     "tsx": "^4.20.5",
     "typedoc": "^0.25.13",
     "typedoc-plugin-missing-exports": "^2.0.0",
-    "typescript": "~5.3.3"
+    "typescript": "npm:@typescript/typescript6@^6.0.2"
   },
   "engines": {
-    "node": "^18.18 || >=20"
+    "node": "^22.14.0 || ^24"
   }
 }

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

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

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

@@ -1 +0,0 @@
-{"version":3,"file":"AnalyticsDataRegulationController-method-action-types.cjs","sourceRoot":"","sources":["../src/AnalyticsDataRegulationController-method-action-types.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated.\n * Do not edit manually.\n */\n\nimport type { AnalyticsDataRegulationController } from './AnalyticsDataRegulationController.js';\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 with regulateId\n * @throws Error if analytics ID is missing or if the service call fails\n */\nexport type AnalyticsDataRegulationControllerCreateDataDeletionTaskAction = {\n  type: `AnalyticsDataRegulationController:createDataDeletionTask`;\n  handler: AnalyticsDataRegulationController['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 AnalyticsDataRegulationControllerCheckDataDeleteStatusAction = {\n  type: `AnalyticsDataRegulationController:checkDataDeleteStatus`;\n  handler: AnalyticsDataRegulationController['checkDataDeleteStatus'];\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 * The flag can only be set to `true` (indicating data has been collected).\n * It cannot be explicitly set to `false` - it is only reset to `false` when\n * a new deletion task is created via `createDataDeletionTask`.\n *\n */\nexport type AnalyticsDataRegulationControllerUpdateDataRecordingFlagAction = {\n  type: `AnalyticsDataRegulationController:updateDataRecordingFlag`;\n  handler: AnalyticsDataRegulationController['updateDataRecordingFlag'];\n};\n\n/**\n * Union of all AnalyticsDataRegulationController action types.\n */\nexport type AnalyticsDataRegulationControllerMethodActions =\n  | AnalyticsDataRegulationControllerCreateDataDeletionTaskAction\n  | AnalyticsDataRegulationControllerCheckDataDeleteStatusAction\n  | AnalyticsDataRegulationControllerUpdateDataRecordingFlagAction;\n"]}

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

@@ -1,44 +0,0 @@
-/**
- * This file is auto generated.
- * Do not edit manually.
- */
-import type { AnalyticsDataRegulationController } from "./AnalyticsDataRegulationController.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 with regulateId
- * @throws Error if analytics ID is missing or if the service call fails
- */
-export type AnalyticsDataRegulationControllerCreateDataDeletionTaskAction = {
-    type: `AnalyticsDataRegulationController:createDataDeletionTask`;
-    handler: AnalyticsDataRegulationController['createDataDeletionTask'];
-};
-/**
- * Check the latest delete regulation status.
- *
- * @returns Promise containing the timestamp, delete status and collected data flag
- */
-export type AnalyticsDataRegulationControllerCheckDataDeleteStatusAction = {
-    type: `AnalyticsDataRegulationController:checkDataDeleteStatus`;
-    handler: AnalyticsDataRegulationController['checkDataDeleteStatus'];
-};
-/**
- * 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.
- *
- * The flag can only be set to `true` (indicating data has been collected).
- * It cannot be explicitly set to `false` - it is only reset to `false` when
- * a new deletion task is created via `createDataDeletionTask`.
- *
- */
-export type AnalyticsDataRegulationControllerUpdateDataRecordingFlagAction = {
-    type: `AnalyticsDataRegulationController:updateDataRecordingFlag`;
-    handler: AnalyticsDataRegulationController['updateDataRecordingFlag'];
-};
-/**
- * Union of all AnalyticsDataRegulationController action types.
- */
-export type AnalyticsDataRegulationControllerMethodActions = AnalyticsDataRegulationControllerCreateDataDeletionTaskAction | AnalyticsDataRegulationControllerCheckDataDeleteStatusAction | AnalyticsDataRegulationControllerUpdateDataRecordingFlagAction;
-//# sourceMappingURL=AnalyticsDataRegulationController-method-action-types.d.cts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"AnalyticsDataRegulationController-method-action-types.d.cts","sourceRoot":"","sources":["../src/AnalyticsDataRegulationController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,iCAAiC,EAAE,gDAA+C;AAEhG;;;;;;GAMG;AACH,MAAM,MAAM,6DAA6D,GAAG;IAC1E,IAAI,EAAE,0DAA0D,CAAC;IACjE,OAAO,EAAE,iCAAiC,CAAC,wBAAwB,CAAC,CAAC;CACtE,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,4DAA4D,GAAG;IACzE,IAAI,EAAE,yDAAyD,CAAC;IAChE,OAAO,EAAE,iCAAiC,CAAC,uBAAuB,CAAC,CAAC;CACrE,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,8DAA8D,GAAG;IAC3E,IAAI,EAAE,2DAA2D,CAAC;IAClE,OAAO,EAAE,iCAAiC,CAAC,yBAAyB,CAAC,CAAC;CACvE,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,8CAA8C,GACtD,6DAA6D,GAC7D,4DAA4D,GAC5D,8DAA8D,CAAC"}

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

@@ -1 +0,0 @@
-{"version":3,"file":"AnalyticsDataRegulationController-method-action-types.d.mts","sourceRoot":"","sources":["../src/AnalyticsDataRegulationController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,iCAAiC,EAAE,gDAA+C;AAEhG;;;;;;GAMG;AACH,MAAM,MAAM,6DAA6D,GAAG;IAC1E,IAAI,EAAE,0DAA0D,CAAC;IACjE,OAAO,EAAE,iCAAiC,CAAC,wBAAwB,CAAC,CAAC;CACtE,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,4DAA4D,GAAG;IACzE,IAAI,EAAE,yDAAyD,CAAC;IAChE,OAAO,EAAE,iCAAiC,CAAC,uBAAuB,CAAC,CAAC;CACrE,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,8DAA8D,GAAG;IAC3E,IAAI,EAAE,2DAA2D,CAAC;IAClE,OAAO,EAAE,iCAAiC,CAAC,yBAAyB,CAAC,CAAC;CACvE,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,8CAA8C,GACtD,6DAA6D,GAC7D,4DAA4D,GAC5D,8DAA8D,CAAC"}

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

@@ -1 +0,0 @@
-{"version":3,"file":"AnalyticsDataRegulationController-method-action-types.mjs","sourceRoot":"","sources":["../src/AnalyticsDataRegulationController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated.\n * Do not edit manually.\n */\n\nimport type { AnalyticsDataRegulationController } from './AnalyticsDataRegulationController.js';\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 with regulateId\n * @throws Error if analytics ID is missing or if the service call fails\n */\nexport type AnalyticsDataRegulationControllerCreateDataDeletionTaskAction = {\n  type: `AnalyticsDataRegulationController:createDataDeletionTask`;\n  handler: AnalyticsDataRegulationController['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 AnalyticsDataRegulationControllerCheckDataDeleteStatusAction = {\n  type: `AnalyticsDataRegulationController:checkDataDeleteStatus`;\n  handler: AnalyticsDataRegulationController['checkDataDeleteStatus'];\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 * The flag can only be set to `true` (indicating data has been collected).\n * It cannot be explicitly set to `false` - it is only reset to `false` when\n * a new deletion task is created via `createDataDeletionTask`.\n *\n */\nexport type AnalyticsDataRegulationControllerUpdateDataRecordingFlagAction = {\n  type: `AnalyticsDataRegulationController:updateDataRecordingFlag`;\n  handler: AnalyticsDataRegulationController['updateDataRecordingFlag'];\n};\n\n/**\n * Union of all AnalyticsDataRegulationController action types.\n */\nexport type AnalyticsDataRegulationControllerMethodActions =\n  | AnalyticsDataRegulationControllerCreateDataDeletionTaskAction\n  | AnalyticsDataRegulationControllerCheckDataDeleteStatusAction\n  | AnalyticsDataRegulationControllerUpdateDataRecordingFlagAction;\n"]}

package/dist/AnalyticsDataRegulationController.cjs

@@ -1,176 +0,0 @@
-"use strict";
-var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
-    if (kind === "m") throw new TypeError("Private method is not writable");
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
-    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
-};
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var _AnalyticsDataRegulationController_analyticsId;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AnalyticsDataRegulationController = exports.getDefaultAnalyticsDataRegulationControllerState = exports.controllerName = void 0;
-const base_controller_1 = require("@metamask/base-controller");
-const logger_js_1 = require("./logger.cjs");
-const types_js_1 = require("./types.cjs");
-// === GENERAL ===
-/**
- * The name of the {@link AnalyticsDataRegulationController}, used to namespace the
- * controller's actions and events and to namespace the controller's state data
- * when composed with other controllers.
- */
-exports.controllerName = 'AnalyticsDataRegulationController';
-/**
- * Returns default values for AnalyticsDataRegulationController state.
- *
- * @returns Default state
- */
-function getDefaultAnalyticsDataRegulationControllerState() {
-    return {
-        hasCollectedDataSinceDeletionRequest: false,
-    };
-}
-exports.getDefaultAnalyticsDataRegulationControllerState = getDefaultAnalyticsDataRegulationControllerState;
-/**
- * The metadata for each property in {@link AnalyticsDataRegulationControllerState}.
- */
-const analyticsDataRegulationControllerMetadata = {
-    hasCollectedDataSinceDeletionRequest: {
-        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',
-    'updateDataRecordingFlag',
-];
-/**
- * The AnalyticsDataRegulationController 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 AnalyticsDataRegulationController extends base_controller_1.BaseController {
-    /**
-     * Constructs an AnalyticsDataRegulationController instance.
-     *
-     * @param options - Controller options
-     * @param options.state - Initial controller state. Use `getDefaultAnalyticsDataRegulationControllerState()` for defaults.
-     * @param options.messenger - Messenger used to communicate with BaseController
-     * @param options.analyticsId - Analytics ID used for data deletion requests
-     */
-    constructor({ state = {}, messenger, analyticsId, }) {
-        const initialState = {
-            ...getDefaultAnalyticsDataRegulationControllerState(),
-            ...state,
-        };
-        super({
-            name: exports.controllerName,
-            metadata: analyticsDataRegulationControllerMetadata,
-            state: initialState,
-            messenger,
-        });
-        /**
-         * Analytics ID used for data deletion requests.
-         */
-        _AnalyticsDataRegulationController_analyticsId.set(this, void 0);
-        __classPrivateFieldSet(this, _AnalyticsDataRegulationController_analyticsId, analyticsId, "f");
-        this.messenger.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
-        (0, logger_js_1.projectLogger)('AnalyticsDataRegulationController initialized', {
-            hasCollectedDataSinceDeletionRequest: this.state.hasCollectedDataSinceDeletionRequest,
-            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 with regulateId
-     * @throws Error if analytics ID is missing or if the service call fails
-     */
-    async createDataDeletionTask() {
-        if (!__classPrivateFieldGet(this, _AnalyticsDataRegulationController_analyticsId, "f") || __classPrivateFieldGet(this, _AnalyticsDataRegulationController_analyticsId, "f").trim() === '') {
-            const error = new Error('Analytics ID not found. You need to provide a valid analytics ID when initializing the AnalyticsDataRegulationController.');
-            (0, logger_js_1.projectLogger)('Analytics Deletion Task Error', error);
-            throw error;
-        }
-        const response = await this.messenger.call('AnalyticsDataRegulationService:createDataDeletionTask', __classPrivateFieldGet(this, _AnalyticsDataRegulationController_analyticsId, "f"));
-        const deletionTimestamp = Date.now();
-        // Service validates and throws on all errors, so if we reach here, the response
-        // is guaranteed to be a success response with regulateId present
-        this.update((state) => {
-            state.deleteRegulationId = response.regulateId;
-            state.deleteRegulationTimestamp = deletionTimestamp;
-            state.hasCollectedDataSinceDeletionRequest = false;
-        });
-        this.messenger.publish(`${exports.controllerName}:dataDeletionTaskCreated`, response);
-        return response;
-    }
-    /**
-     * Check the latest delete regulation status.
-     *
-     * @returns Promise containing the timestamp, delete status and collected data flag
-     */
-    async checkDataDeleteStatus() {
-        // Capture all state values before async call to ensure consistency
-        // in case createDataDeletionTask() completes concurrently
-        const { deleteRegulationId } = this.state;
-        const { deleteRegulationTimestamp } = this.state;
-        const { hasCollectedDataSinceDeletionRequest } = this.state;
-        const status = {
-            deletionRequestTimestamp: deleteRegulationTimestamp,
-            dataDeletionRequestStatus: types_js_1.DATA_DELETE_STATUSES.Unknown,
-            hasCollectedDataSinceDeletionRequest,
-        };
-        if (!deleteRegulationId) {
-            return status;
-        }
-        // Service validates and throws on all errors, so if we reach here, the response
-        // is guaranteed to be a success response with dataDeleteStatus present
-        const dataDeletionTaskStatus = await this.messenger.call('AnalyticsDataRegulationService:checkDataDeleteStatus', deleteRegulationId);
-        status.dataDeletionRequestStatus = dataDeletionTaskStatus.dataDeleteStatus;
-        return status;
-    }
-    /**
-     * 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.
-     *
-     * The flag can only be set to `true` (indicating data has been collected).
-     * It cannot be explicitly set to `false` - it is only reset to `false` when
-     * a new deletion task is created via `createDataDeletionTask`.
-     *
-     */
-    updateDataRecordingFlag() {
-        if (!this.state.hasCollectedDataSinceDeletionRequest) {
-            this.update((state) => {
-                state.hasCollectedDataSinceDeletionRequest = true;
-            });
-            this.messenger.publish(`${exports.controllerName}:dataRecordingFlagUpdated`, true);
-        }
-    }
-}
-exports.AnalyticsDataRegulationController = AnalyticsDataRegulationController;
-_AnalyticsDataRegulationController_analyticsId = new WeakMap();
-//# sourceMappingURL=AnalyticsDataRegulationController.cjs.map

package/dist/AnalyticsDataRegulationController.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"AnalyticsDataRegulationController.cjs","sourceRoot":"","sources":["../src/AnalyticsDataRegulationController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAKA,+DAA2D;AAK3D,4CAAmD;AACnD,0CAGoB;AAMpB,kBAAkB;AAElB;;;;GAIG;AACU,QAAA,cAAc,GAAG,mCAAmC,CAAC;AA0BlE;;;;GAIG;AACH,SAAgB,gDAAgD;IAC9D,OAAO;QACL,oCAAoC,EAAE,KAAK;KAC5C,CAAC;AACJ,CAAC;AAJD,4GAIC;AAED;;GAEG;AACH,MAAM,yCAAyC,GAAG;IAChD,oCAAoC,EAAE;QACpC,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;CAC8D,CAAC;AAElE,oBAAoB;AAEpB,MAAM,yBAAyB,GAAG;IAChC,wBAAwB;IACxB,uBAAuB;IACvB,yBAAyB;CACjB,CAAC;AA2FX;;;;;;GAMG;AACH,MAAa,iCAAkC,SAAQ,gCAItD;IAMC;;;;;;;OAOG;IACH,YAAY,EACV,KAAK,GAAG,EAAE,EACV,SAAS,EACT,WAAW,GAC8B;QACzC,MAAM,YAAY,GAA2C;YAC3D,GAAG,gDAAgD,EAAE;YACrD,GAAG,KAAK;SACT,CAAC;QAEF,KAAK,CAAC;YACJ,IAAI,EAAE,sBAAc;YACpB,QAAQ,EAAE,yCAAyC;YACnD,KAAK,EAAE,YAAY;YACnB,SAAS;SACV,CAAC,CAAC;QA5BL;;WAEG;QACM,iEAAqB;QA2B5B,uBAAA,IAAI,kDAAgB,WAAW,MAAA,CAAC;QAEhC,IAAI,CAAC,SAAS,CAAC,4BAA4B,CACzC,IAAI,EACJ,yBAAyB,CAC1B,CAAC;QAEF,IAAA,yBAAG,EAAC,+CAA+C,EAAE;YACnD,oCAAoC,EAClC,IAAI,CAAC,KAAK,CAAC,oCAAoC;YACjD,qBAAqB,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC;YAC7D,yBAAyB,EAAE,IAAI,CAAC,KAAK,CAAC,yBAAyB;SAChE,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,sBAAsB;QAI1B,IAAI,CAAC,uBAAA,IAAI,sDAAa,IAAI,uBAAA,IAAI,sDAAa,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;YAC1D,MAAM,KAAK,GAAG,IAAI,KAAK,CACrB,2HAA2H,CAC5H,CAAC;YACF,IAAA,yBAAG,EAAC,+BAA+B,EAAE,KAAK,CAAC,CAAC;YAC5C,MAAM,KAAK,CAAC;QACd,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CACxC,uDAAuD,EACvD,uBAAA,IAAI,sDAAa,CAClB,CAAC;QAEF,MAAM,iBAAiB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACrC,gFAAgF;QAChF,iEAAiE;QACjE,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,kBAAkB,GAAG,QAAQ,CAAC,UAAU,CAAC;YAC/C,KAAK,CAAC,yBAAyB,GAAG,iBAAiB,CAAC;YACpD,KAAK,CAAC,oCAAoC,GAAG,KAAK,CAAC;QACrD,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,SAAS,CAAC,OAAO,CACpB,GAAG,sBAAc,0BAA0B,EAC3C,QAAQ,CACT,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,qBAAqB;QACzB,mEAAmE;QACnE,0DAA0D;QAC1D,MAAM,EAAE,kBAAkB,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QAC1C,MAAM,EAAE,yBAAyB,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QACjD,MAAM,EAAE,oCAAoC,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QAE5D,MAAM,MAAM,GAA2B;YACrC,wBAAwB,EAAE,yBAAyB;YACnD,yBAAyB,EAAE,+BAAoB,CAAC,OAAO;YACvD,oCAAoC;SACrC,CAAC;QAEF,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACxB,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,gFAAgF;QAChF,uEAAuE;QACvE,MAAM,sBAAsB,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CACtD,sDAAsD,EACtD,kBAAkB,CACnB,CAAC;QAEF,MAAM,CAAC,yBAAyB,GAAG,sBAAsB,CAAC,gBAAgB,CAAC;QAE3E,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;;;;OASG;IACH,uBAAuB;QACrB,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,oCAAoC,EAAE,CAAC;YACrD,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,KAAK,CAAC,oCAAoC,GAAG,IAAI,CAAC;YACpD,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,SAAS,CAAC,OAAO,CACpB,GAAG,sBAAc,2BAA2B,EAC5C,IAAI,CACL,CAAC;QACJ,CAAC;IACH,CAAC;CACF;AAnJD,8EAmJC","sourcesContent":["import 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 { AnalyticsDataRegulationControllerMethodActions } from './AnalyticsDataRegulationController-method-action-types.js';\nimport type { AnalyticsDataRegulationServiceActions } from './AnalyticsDataRegulationService.js';\nimport { projectLogger as log } from './logger.js';\nimport {\n  DATA_DELETE_RESPONSE_STATUSES,\n  DATA_DELETE_STATUSES,\n} from './types.js';\nimport type {\n  DeleteRegulationResponse,\n  DeleteRegulationStatus,\n} from './types.js';\n\n// === GENERAL ===\n\n/**\n * The name of the {@link AnalyticsDataRegulationController}, 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 = 'AnalyticsDataRegulationController';\n\n// === STATE ===\n\n/**\n * Describes the shape of the state object for {@link AnalyticsDataRegulationController}.\n */\nexport type AnalyticsDataRegulationControllerState = {\n  /**\n   * Indicates if data has been recorded since the last deletion request.\n   */\n  hasCollectedDataSinceDeletionRequest: 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;\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;\n};\n\n/**\n * Returns default values for AnalyticsDataRegulationController state.\n *\n * @returns Default state\n */\nexport function getDefaultAnalyticsDataRegulationControllerState(): AnalyticsDataRegulationControllerState {\n  return {\n    hasCollectedDataSinceDeletionRequest: false,\n  };\n}\n\n/**\n * The metadata for each property in {@link AnalyticsDataRegulationControllerState}.\n */\nconst analyticsDataRegulationControllerMetadata = {\n  hasCollectedDataSinceDeletionRequest: {\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<AnalyticsDataRegulationControllerState>;\n\n// === MESSENGER ===\n\nconst MESSENGER_EXPOSED_METHODS = [\n  'createDataDeletionTask',\n  'checkDataDeleteStatus',\n  'updateDataRecordingFlag',\n] as const;\n\n/**\n * Returns the state of the {@link AnalyticsDataRegulationController}.\n */\nexport type AnalyticsDataRegulationControllerGetStateAction =\n  ControllerGetStateAction<\n    typeof controllerName,\n    AnalyticsDataRegulationControllerState\n  >;\n\n/**\n * Actions that {@link AnalyticsDataRegulationControllerMessenger} exposes to other consumers.\n */\nexport type AnalyticsDataRegulationControllerActions =\n  | AnalyticsDataRegulationControllerGetStateAction\n  | AnalyticsDataRegulationControllerMethodActions;\n\n/**\n * Actions from other messengers that {@link AnalyticsDataRegulationControllerMessenger} calls.\n */\ntype AllowedActions = AnalyticsDataRegulationServiceActions;\n\n/**\n * Event emitted when a data deletion task is created.\n */\nexport type DataDeletionTaskCreatedEvent = {\n  type: `${typeof controllerName}:dataDeletionTaskCreated`;\n  payload: [DeleteRegulationResponse];\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 AnalyticsDataRegulationController} changes.\n */\nexport type AnalyticsDataRegulationControllerStateChangeEvent =\n  ControllerStateChangeEvent<\n    typeof controllerName,\n    AnalyticsDataRegulationControllerState\n  >;\n\n/**\n * Events that {@link AnalyticsDataRegulationControllerMessenger} exposes to other consumers.\n */\nexport type AnalyticsDataRegulationControllerEvents =\n  | AnalyticsDataRegulationControllerStateChangeEvent\n  | DataDeletionTaskCreatedEvent\n  | DataRecordingFlagUpdatedEvent;\n\n/**\n * Events from other messengers that {@link AnalyticsDataRegulationControllerMessenger} subscribes to.\n */\ntype AllowedEvents = never;\n\n/**\n * The messenger restricted to actions and events accessed by\n * {@link AnalyticsDataRegulationController}.\n */\nexport type AnalyticsDataRegulationControllerMessenger = Messenger<\n  typeof controllerName,\n  AnalyticsDataRegulationControllerActions | AllowedActions,\n  AnalyticsDataRegulationControllerEvents | AllowedEvents\n>;\n\n// === CONTROLLER DEFINITION ===\n\n/**\n * The options that AnalyticsDataRegulationController takes.\n */\nexport type AnalyticsDataRegulationControllerOptions = {\n  /**\n   * Initial controller state.\n   */\n  state?: Partial<AnalyticsDataRegulationControllerState>;\n  /**\n   * Messenger used to communicate with BaseController and other controllers.\n   */\n  messenger: AnalyticsDataRegulationControllerMessenger;\n  /**\n   * Analytics ID used for data deletion requests.\n   */\n  analyticsId: string;\n};\n\n/**\n * The AnalyticsDataRegulationController 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 AnalyticsDataRegulationController extends BaseController<\n  typeof controllerName,\n  AnalyticsDataRegulationControllerState,\n  AnalyticsDataRegulationControllerMessenger\n> {\n  /**\n   * Analytics ID used for data deletion requests.\n   */\n  readonly #analyticsId: string;\n\n  /**\n   * Constructs an AnalyticsDataRegulationController instance.\n   *\n   * @param options - Controller options\n   * @param options.state - Initial controller state. Use `getDefaultAnalyticsDataRegulationControllerState()` for defaults.\n   * @param options.messenger - Messenger used to communicate with BaseController\n   * @param options.analyticsId - Analytics ID used for data deletion requests\n   */\n  constructor({\n    state = {},\n    messenger,\n    analyticsId,\n  }: AnalyticsDataRegulationControllerOptions) {\n    const initialState: AnalyticsDataRegulationControllerState = {\n      ...getDefaultAnalyticsDataRegulationControllerState(),\n      ...state,\n    };\n\n    super({\n      name: controllerName,\n      metadata: analyticsDataRegulationControllerMetadata,\n      state: initialState,\n      messenger,\n    });\n\n    this.#analyticsId = analyticsId;\n\n    this.messenger.registerMethodActionHandlers(\n      this,\n      MESSENGER_EXPOSED_METHODS,\n    );\n\n    log('AnalyticsDataRegulationController initialized', {\n      hasCollectedDataSinceDeletionRequest:\n        this.state.hasCollectedDataSinceDeletionRequest,\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 with regulateId\n   * @throws Error if analytics ID is missing or if the service call fails\n   */\n  async createDataDeletionTask(): Promise<{\n    status: typeof DATA_DELETE_RESPONSE_STATUSES.Success;\n    regulateId: string;\n  }> {\n    if (!this.#analyticsId || this.#analyticsId.trim() === '') {\n      const error = new Error(\n        'Analytics ID not found. You need to provide a valid analytics ID when initializing the AnalyticsDataRegulationController.',\n      );\n      log('Analytics Deletion Task Error', error);\n      throw error;\n    }\n\n    const response = await this.messenger.call(\n      'AnalyticsDataRegulationService:createDataDeletionTask',\n      this.#analyticsId,\n    );\n\n    const deletionTimestamp = Date.now();\n    // Service validates and throws on all errors, so if we reach here, the response\n    // is guaranteed to be a success response with regulateId present\n    this.update((state) => {\n      state.deleteRegulationId = response.regulateId;\n      state.deleteRegulationTimestamp = deletionTimestamp;\n      state.hasCollectedDataSinceDeletionRequest = false;\n    });\n\n    this.messenger.publish(\n      `${controllerName}:dataDeletionTaskCreated`,\n      response,\n    );\n\n    return response;\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<DeleteRegulationStatus> {\n    // Capture all state values before async call to ensure consistency\n    // in case createDataDeletionTask() completes concurrently\n    const { deleteRegulationId } = this.state;\n    const { deleteRegulationTimestamp } = this.state;\n    const { hasCollectedDataSinceDeletionRequest } = this.state;\n\n    const status: DeleteRegulationStatus = {\n      deletionRequestTimestamp: deleteRegulationTimestamp,\n      dataDeletionRequestStatus: DATA_DELETE_STATUSES.Unknown,\n      hasCollectedDataSinceDeletionRequest,\n    };\n\n    if (!deleteRegulationId) {\n      return status;\n    }\n\n    // Service validates and throws on all errors, so if we reach here, the response\n    // is guaranteed to be a success response with dataDeleteStatus present\n    const dataDeletionTaskStatus = await this.messenger.call(\n      'AnalyticsDataRegulationService:checkDataDeleteStatus',\n      deleteRegulationId,\n    );\n\n    status.dataDeletionRequestStatus = dataDeletionTaskStatus.dataDeleteStatus;\n\n    return status;\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   * The flag can only be set to `true` (indicating data has been collected).\n   * It cannot be explicitly set to `false` - it is only reset to `false` when\n   * a new deletion task is created via `createDataDeletionTask`.\n   *\n   */\n  updateDataRecordingFlag(): void {\n    if (!this.state.hasCollectedDataSinceDeletionRequest) {\n      this.update((state) => {\n        state.hasCollectedDataSinceDeletionRequest = true;\n      });\n\n      this.messenger.publish(\n        `${controllerName}:dataRecordingFlagUpdated`,\n        true,\n      );\n    }\n  }\n}\n"]}

package/dist/AnalyticsDataRegulationController.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"AnalyticsDataRegulationController.d.cts","sourceRoot":"","sources":["../src/AnalyticsDataRegulationController.ts"],"names":[],"mappings":"AAAA,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,8CAA8C,EAAE,oEAAmE;AACjI,OAAO,KAAK,EAAE,qCAAqC,EAAE,6CAA4C;AAEjG,OAAO,EACL,6BAA6B,EAE9B,oBAAmB;AACpB,OAAO,KAAK,EACV,wBAAwB,EACxB,sBAAsB,EACvB,oBAAmB;AAIpB;;;;GAIG;AACH,eAAO,MAAM,cAAc,sCAAsC,CAAC;AAIlE;;GAEG;AACH,MAAM,MAAM,sCAAsC,GAAG;IACnD;;OAEG;IACH,oCAAoC,EAAE,OAAO,CAAC;IAE9C;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;;OAGG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;CACpC,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,gDAAgD,IAAI,sCAAsC,CAIzG;AAkCD;;GAEG;AACH,MAAM,MAAM,+CAA+C,GACzD,wBAAwB,CACtB,OAAO,cAAc,EACrB,sCAAsC,CACvC,CAAC;AAEJ;;GAEG;AACH,MAAM,MAAM,wCAAwC,GAChD,+CAA+C,GAC/C,8CAA8C,CAAC;AAEnD;;GAEG;AACH,KAAK,cAAc,GAAG,qCAAqC,CAAC;AAE5D;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACzC,IAAI,EAAE,GAAG,OAAO,cAAc,0BAA0B,CAAC;IACzD,OAAO,EAAE,CAAC,wBAAwB,CAAC,CAAC;CACrC,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,iDAAiD,GAC3D,0BAA0B,CACxB,OAAO,cAAc,EACrB,sCAAsC,CACvC,CAAC;AAEJ;;GAEG;AACH,MAAM,MAAM,uCAAuC,GAC/C,iDAAiD,GACjD,4BAA4B,GAC5B,6BAA6B,CAAC;AAElC;;GAEG;AACH,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,0CAA0C,GAAG,SAAS,CAChE,OAAO,cAAc,EACrB,wCAAwC,GAAG,cAAc,EACzD,uCAAuC,GAAG,aAAa,CACxD,CAAC;AAIF;;GAEG;AACH,MAAM,MAAM,wCAAwC,GAAG;IACrD;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC,sCAAsC,CAAC,CAAC;IACxD;;OAEG;IACH,SAAS,EAAE,0CAA0C,CAAC;IACtD;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;;;;;GAMG;AACH,qBAAa,iCAAkC,SAAQ,cAAc,CACnE,OAAO,cAAc,EACrB,sCAAsC,EACtC,0CAA0C,CAC3C;;IAMC;;;;;;;OAOG;gBACS,EACV,KAAU,EACV,SAAS,EACT,WAAW,GACZ,EAAE,wCAAwC;IA4B3C;;;;;;OAMG;IACG,sBAAsB,IAAI,OAAO,CAAC;QACtC,MAAM,EAAE,OAAO,6BAA6B,CAAC,OAAO,CAAC;QACrD,UAAU,EAAE,MAAM,CAAC;KACpB,CAAC;IA+BF;;;;OAIG;IACG,qBAAqB,IAAI,OAAO,CAAC,sBAAsB,CAAC;IA6B9D;;;;;;;;;OASG;IACH,uBAAuB,IAAI,IAAI;CAYhC"}

package/dist/AnalyticsDataRegulationController.d.mts

@@ -1,147 +0,0 @@
-import type { ControllerGetStateAction, ControllerStateChangeEvent } from "@metamask/base-controller";
-import { BaseController } from "@metamask/base-controller";
-import type { Messenger } from "@metamask/messenger";
-import type { AnalyticsDataRegulationControllerMethodActions } from "./AnalyticsDataRegulationController-method-action-types.mjs";
-import type { AnalyticsDataRegulationServiceActions } from "./AnalyticsDataRegulationService.mjs";
-import { DATA_DELETE_RESPONSE_STATUSES } from "./types.mjs";
-import type { DeleteRegulationResponse, DeleteRegulationStatus } from "./types.mjs";
-/**
- * The name of the {@link AnalyticsDataRegulationController}, 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 = "AnalyticsDataRegulationController";
-/**
- * Describes the shape of the state object for {@link AnalyticsDataRegulationController}.
- */
-export type AnalyticsDataRegulationControllerState = {
-    /**
-     * Indicates if data has been recorded since the last deletion request.
-     */
-    hasCollectedDataSinceDeletionRequest: 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;
-    /**
-     * Segment's data deletion regulation creation timestamp.
-     * The timestamp (in milliseconds since epoch) when the deletion request was created.
-     */
-    deleteRegulationTimestamp?: number;
-};
-/**
- * Returns default values for AnalyticsDataRegulationController state.
- *
- * @returns Default state
- */
-export declare function getDefaultAnalyticsDataRegulationControllerState(): AnalyticsDataRegulationControllerState;
-/**
- * Returns the state of the {@link AnalyticsDataRegulationController}.
- */
-export type AnalyticsDataRegulationControllerGetStateAction = ControllerGetStateAction<typeof controllerName, AnalyticsDataRegulationControllerState>;
-/**
- * Actions that {@link AnalyticsDataRegulationControllerMessenger} exposes to other consumers.
- */
-export type AnalyticsDataRegulationControllerActions = AnalyticsDataRegulationControllerGetStateAction | AnalyticsDataRegulationControllerMethodActions;
-/**
- * Actions from other messengers that {@link AnalyticsDataRegulationControllerMessenger} calls.
- */
-type AllowedActions = AnalyticsDataRegulationServiceActions;
-/**
- * Event emitted when a data deletion task is created.
- */
-export type DataDeletionTaskCreatedEvent = {
-    type: `${typeof controllerName}:dataDeletionTaskCreated`;
-    payload: [DeleteRegulationResponse];
-};
-/**
- * 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 AnalyticsDataRegulationController} changes.
- */
-export type AnalyticsDataRegulationControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, AnalyticsDataRegulationControllerState>;
-/**
- * Events that {@link AnalyticsDataRegulationControllerMessenger} exposes to other consumers.
- */
-export type AnalyticsDataRegulationControllerEvents = AnalyticsDataRegulationControllerStateChangeEvent | DataDeletionTaskCreatedEvent | DataRecordingFlagUpdatedEvent;
-/**
- * Events from other messengers that {@link AnalyticsDataRegulationControllerMessenger} subscribes to.
- */
-type AllowedEvents = never;
-/**
- * The messenger restricted to actions and events accessed by
- * {@link AnalyticsDataRegulationController}.
- */
-export type AnalyticsDataRegulationControllerMessenger = Messenger<typeof controllerName, AnalyticsDataRegulationControllerActions | AllowedActions, AnalyticsDataRegulationControllerEvents | AllowedEvents>;
-/**
- * The options that AnalyticsDataRegulationController takes.
- */
-export type AnalyticsDataRegulationControllerOptions = {
-    /**
-     * Initial controller state.
-     */
-    state?: Partial<AnalyticsDataRegulationControllerState>;
-    /**
-     * Messenger used to communicate with BaseController and other controllers.
-     */
-    messenger: AnalyticsDataRegulationControllerMessenger;
-    /**
-     * Analytics ID used for data deletion requests.
-     */
-    analyticsId: string;
-};
-/**
- * The AnalyticsDataRegulationController 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 AnalyticsDataRegulationController extends BaseController<typeof controllerName, AnalyticsDataRegulationControllerState, AnalyticsDataRegulationControllerMessenger> {
-    #private;
-    /**
-     * Constructs an AnalyticsDataRegulationController instance.
-     *
-     * @param options - Controller options
-     * @param options.state - Initial controller state. Use `getDefaultAnalyticsDataRegulationControllerState()` for defaults.
-     * @param options.messenger - Messenger used to communicate with BaseController
-     * @param options.analyticsId - Analytics ID used for data deletion requests
-     */
-    constructor({ state, messenger, analyticsId, }: AnalyticsDataRegulationControllerOptions);
-    /**
-     * 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 with regulateId
-     * @throws Error if analytics ID is missing or if the service call fails
-     */
-    createDataDeletionTask(): Promise<{
-        status: typeof DATA_DELETE_RESPONSE_STATUSES.Success;
-        regulateId: string;
-    }>;
-    /**
-     * Check the latest delete regulation status.
-     *
-     * @returns Promise containing the timestamp, delete status and collected data flag
-     */
-    checkDataDeleteStatus(): Promise<DeleteRegulationStatus>;
-    /**
-     * 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.
-     *
-     * The flag can only be set to `true` (indicating data has been collected).
-     * It cannot be explicitly set to `false` - it is only reset to `false` when
-     * a new deletion task is created via `createDataDeletionTask`.
-     *
-     */
-    updateDataRecordingFlag(): void;
-}
-export {};
-//# sourceMappingURL=AnalyticsDataRegulationController.d.mts.map

package/dist/AnalyticsDataRegulationController.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"AnalyticsDataRegulationController.d.mts","sourceRoot":"","sources":["../src/AnalyticsDataRegulationController.ts"],"names":[],"mappings":"AAAA,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,8CAA8C,EAAE,oEAAmE;AACjI,OAAO,KAAK,EAAE,qCAAqC,EAAE,6CAA4C;AAEjG,OAAO,EACL,6BAA6B,EAE9B,oBAAmB;AACpB,OAAO,KAAK,EACV,wBAAwB,EACxB,sBAAsB,EACvB,oBAAmB;AAIpB;;;;GAIG;AACH,eAAO,MAAM,cAAc,sCAAsC,CAAC;AAIlE;;GAEG;AACH,MAAM,MAAM,sCAAsC,GAAG;IACnD;;OAEG;IACH,oCAAoC,EAAE,OAAO,CAAC;IAE9C;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;;OAGG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;CACpC,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,gDAAgD,IAAI,sCAAsC,CAIzG;AAkCD;;GAEG;AACH,MAAM,MAAM,+CAA+C,GACzD,wBAAwB,CACtB,OAAO,cAAc,EACrB,sCAAsC,CACvC,CAAC;AAEJ;;GAEG;AACH,MAAM,MAAM,wCAAwC,GAChD,+CAA+C,GAC/C,8CAA8C,CAAC;AAEnD;;GAEG;AACH,KAAK,cAAc,GAAG,qCAAqC,CAAC;AAE5D;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACzC,IAAI,EAAE,GAAG,OAAO,cAAc,0BAA0B,CAAC;IACzD,OAAO,EAAE,CAAC,wBAAwB,CAAC,CAAC;CACrC,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,iDAAiD,GAC3D,0BAA0B,CACxB,OAAO,cAAc,EACrB,sCAAsC,CACvC,CAAC;AAEJ;;GAEG;AACH,MAAM,MAAM,uCAAuC,GAC/C,iDAAiD,GACjD,4BAA4B,GAC5B,6BAA6B,CAAC;AAElC;;GAEG;AACH,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,0CAA0C,GAAG,SAAS,CAChE,OAAO,cAAc,EACrB,wCAAwC,GAAG,cAAc,EACzD,uCAAuC,GAAG,aAAa,CACxD,CAAC;AAIF;;GAEG;AACH,MAAM,MAAM,wCAAwC,GAAG;IACrD;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC,sCAAsC,CAAC,CAAC;IACxD;;OAEG;IACH,SAAS,EAAE,0CAA0C,CAAC;IACtD;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;;;;;GAMG;AACH,qBAAa,iCAAkC,SAAQ,cAAc,CACnE,OAAO,cAAc,EACrB,sCAAsC,EACtC,0CAA0C,CAC3C;;IAMC;;;;;;;OAOG;gBACS,EACV,KAAU,EACV,SAAS,EACT,WAAW,GACZ,EAAE,wCAAwC;IA4B3C;;;;;;OAMG;IACG,sBAAsB,IAAI,OAAO,CAAC;QACtC,MAAM,EAAE,OAAO,6BAA6B,CAAC,OAAO,CAAC;QACrD,UAAU,EAAE,MAAM,CAAC;KACpB,CAAC;IA+BF;;;;OAIG;IACG,qBAAqB,IAAI,OAAO,CAAC,sBAAsB,CAAC;IA6B9D;;;;;;;;;OASG;IACH,uBAAuB,IAAI,IAAI;CAYhC"}

package/dist/AnalyticsDataRegulationController.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"AnalyticsDataRegulationController.mjs","sourceRoot":"","sources":["../src/AnalyticsDataRegulationController.ts"],"names":[],"mappings":";;;;;;;;;;;;AAKA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAK3D,OAAO,EAAE,aAAa,IAAI,GAAG,EAAE,qBAAoB;AACnD,OAAO,EACL,6BAA6B,EAC7B,oBAAoB,EACrB,oBAAmB;AAMpB,kBAAkB;AAElB;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,mCAAmC,CAAC;AA0BlE;;;;GAIG;AACH,MAAM,UAAU,gDAAgD;IAC9D,OAAO;QACL,oCAAoC,EAAE,KAAK;KAC5C,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,yCAAyC,GAAG;IAChD,oCAAoC,EAAE;QACpC,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;CAC8D,CAAC;AAElE,oBAAoB;AAEpB,MAAM,yBAAyB,GAAG;IAChC,wBAAwB;IACxB,uBAAuB;IACvB,yBAAyB;CACjB,CAAC;AA2FX;;;;;;GAMG;AACH,MAAM,OAAO,iCAAkC,SAAQ,cAItD;IAMC;;;;;;;OAOG;IACH,YAAY,EACV,KAAK,GAAG,EAAE,EACV,SAAS,EACT,WAAW,GAC8B;QACzC,MAAM,YAAY,GAA2C;YAC3D,GAAG,gDAAgD,EAAE;YACrD,GAAG,KAAK;SACT,CAAC;QAEF,KAAK,CAAC;YACJ,IAAI,EAAE,cAAc;YACpB,QAAQ,EAAE,yCAAyC;YACnD,KAAK,EAAE,YAAY;YACnB,SAAS;SACV,CAAC,CAAC;QA5BL;;WAEG;QACM,iEAAqB;QA2B5B,uBAAA,IAAI,kDAAgB,WAAW,MAAA,CAAC;QAEhC,IAAI,CAAC,SAAS,CAAC,4BAA4B,CACzC,IAAI,EACJ,yBAAyB,CAC1B,CAAC;QAEF,GAAG,CAAC,+CAA+C,EAAE;YACnD,oCAAoC,EAClC,IAAI,CAAC,KAAK,CAAC,oCAAoC;YACjD,qBAAqB,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC;YAC7D,yBAAyB,EAAE,IAAI,CAAC,KAAK,CAAC,yBAAyB;SAChE,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,sBAAsB;QAI1B,IAAI,CAAC,uBAAA,IAAI,sDAAa,IAAI,uBAAA,IAAI,sDAAa,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;YAC1D,MAAM,KAAK,GAAG,IAAI,KAAK,CACrB,2HAA2H,CAC5H,CAAC;YACF,GAAG,CAAC,+BAA+B,EAAE,KAAK,CAAC,CAAC;YAC5C,MAAM,KAAK,CAAC;QACd,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CACxC,uDAAuD,EACvD,uBAAA,IAAI,sDAAa,CAClB,CAAC;QAEF,MAAM,iBAAiB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACrC,gFAAgF;QAChF,iEAAiE;QACjE,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,kBAAkB,GAAG,QAAQ,CAAC,UAAU,CAAC;YAC/C,KAAK,CAAC,yBAAyB,GAAG,iBAAiB,CAAC;YACpD,KAAK,CAAC,oCAAoC,GAAG,KAAK,CAAC;QACrD,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,SAAS,CAAC,OAAO,CACpB,GAAG,cAAc,0BAA0B,EAC3C,QAAQ,CACT,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,qBAAqB;QACzB,mEAAmE;QACnE,0DAA0D;QAC1D,MAAM,EAAE,kBAAkB,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QAC1C,MAAM,EAAE,yBAAyB,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QACjD,MAAM,EAAE,oCAAoC,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QAE5D,MAAM,MAAM,GAA2B;YACrC,wBAAwB,EAAE,yBAAyB;YACnD,yBAAyB,EAAE,oBAAoB,CAAC,OAAO;YACvD,oCAAoC;SACrC,CAAC;QAEF,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACxB,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,gFAAgF;QAChF,uEAAuE;QACvE,MAAM,sBAAsB,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CACtD,sDAAsD,EACtD,kBAAkB,CACnB,CAAC;QAEF,MAAM,CAAC,yBAAyB,GAAG,sBAAsB,CAAC,gBAAgB,CAAC;QAE3E,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;;;;OASG;IACH,uBAAuB;QACrB,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,oCAAoC,EAAE,CAAC;YACrD,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,KAAK,CAAC,oCAAoC,GAAG,IAAI,CAAC;YACpD,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,SAAS,CAAC,OAAO,CACpB,GAAG,cAAc,2BAA2B,EAC5C,IAAI,CACL,CAAC;QACJ,CAAC;IACH,CAAC;CACF","sourcesContent":["import 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 { AnalyticsDataRegulationControllerMethodActions } from './AnalyticsDataRegulationController-method-action-types.js';\nimport type { AnalyticsDataRegulationServiceActions } from './AnalyticsDataRegulationService.js';\nimport { projectLogger as log } from './logger.js';\nimport {\n  DATA_DELETE_RESPONSE_STATUSES,\n  DATA_DELETE_STATUSES,\n} from './types.js';\nimport type {\n  DeleteRegulationResponse,\n  DeleteRegulationStatus,\n} from './types.js';\n\n// === GENERAL ===\n\n/**\n * The name of the {@link AnalyticsDataRegulationController}, 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 = 'AnalyticsDataRegulationController';\n\n// === STATE ===\n\n/**\n * Describes the shape of the state object for {@link AnalyticsDataRegulationController}.\n */\nexport type AnalyticsDataRegulationControllerState = {\n  /**\n   * Indicates if data has been recorded since the last deletion request.\n   */\n  hasCollectedDataSinceDeletionRequest: 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;\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;\n};\n\n/**\n * Returns default values for AnalyticsDataRegulationController state.\n *\n * @returns Default state\n */\nexport function getDefaultAnalyticsDataRegulationControllerState(): AnalyticsDataRegulationControllerState {\n  return {\n    hasCollectedDataSinceDeletionRequest: false,\n  };\n}\n\n/**\n * The metadata for each property in {@link AnalyticsDataRegulationControllerState}.\n */\nconst analyticsDataRegulationControllerMetadata = {\n  hasCollectedDataSinceDeletionRequest: {\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<AnalyticsDataRegulationControllerState>;\n\n// === MESSENGER ===\n\nconst MESSENGER_EXPOSED_METHODS = [\n  'createDataDeletionTask',\n  'checkDataDeleteStatus',\n  'updateDataRecordingFlag',\n] as const;\n\n/**\n * Returns the state of the {@link AnalyticsDataRegulationController}.\n */\nexport type AnalyticsDataRegulationControllerGetStateAction =\n  ControllerGetStateAction<\n    typeof controllerName,\n    AnalyticsDataRegulationControllerState\n  >;\n\n/**\n * Actions that {@link AnalyticsDataRegulationControllerMessenger} exposes to other consumers.\n */\nexport type AnalyticsDataRegulationControllerActions =\n  | AnalyticsDataRegulationControllerGetStateAction\n  | AnalyticsDataRegulationControllerMethodActions;\n\n/**\n * Actions from other messengers that {@link AnalyticsDataRegulationControllerMessenger} calls.\n */\ntype AllowedActions = AnalyticsDataRegulationServiceActions;\n\n/**\n * Event emitted when a data deletion task is created.\n */\nexport type DataDeletionTaskCreatedEvent = {\n  type: `${typeof controllerName}:dataDeletionTaskCreated`;\n  payload: [DeleteRegulationResponse];\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 AnalyticsDataRegulationController} changes.\n */\nexport type AnalyticsDataRegulationControllerStateChangeEvent =\n  ControllerStateChangeEvent<\n    typeof controllerName,\n    AnalyticsDataRegulationControllerState\n  >;\n\n/**\n * Events that {@link AnalyticsDataRegulationControllerMessenger} exposes to other consumers.\n */\nexport type AnalyticsDataRegulationControllerEvents =\n  | AnalyticsDataRegulationControllerStateChangeEvent\n  | DataDeletionTaskCreatedEvent\n  | DataRecordingFlagUpdatedEvent;\n\n/**\n * Events from other messengers that {@link AnalyticsDataRegulationControllerMessenger} subscribes to.\n */\ntype AllowedEvents = never;\n\n/**\n * The messenger restricted to actions and events accessed by\n * {@link AnalyticsDataRegulationController}.\n */\nexport type AnalyticsDataRegulationControllerMessenger = Messenger<\n  typeof controllerName,\n  AnalyticsDataRegulationControllerActions | AllowedActions,\n  AnalyticsDataRegulationControllerEvents | AllowedEvents\n>;\n\n// === CONTROLLER DEFINITION ===\n\n/**\n * The options that AnalyticsDataRegulationController takes.\n */\nexport type AnalyticsDataRegulationControllerOptions = {\n  /**\n   * Initial controller state.\n   */\n  state?: Partial<AnalyticsDataRegulationControllerState>;\n  /**\n   * Messenger used to communicate with BaseController and other controllers.\n   */\n  messenger: AnalyticsDataRegulationControllerMessenger;\n  /**\n   * Analytics ID used for data deletion requests.\n   */\n  analyticsId: string;\n};\n\n/**\n * The AnalyticsDataRegulationController 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 AnalyticsDataRegulationController extends BaseController<\n  typeof controllerName,\n  AnalyticsDataRegulationControllerState,\n  AnalyticsDataRegulationControllerMessenger\n> {\n  /**\n   * Analytics ID used for data deletion requests.\n   */\n  readonly #analyticsId: string;\n\n  /**\n   * Constructs an AnalyticsDataRegulationController instance.\n   *\n   * @param options - Controller options\n   * @param options.state - Initial controller state. Use `getDefaultAnalyticsDataRegulationControllerState()` for defaults.\n   * @param options.messenger - Messenger used to communicate with BaseController\n   * @param options.analyticsId - Analytics ID used for data deletion requests\n   */\n  constructor({\n    state = {},\n    messenger,\n    analyticsId,\n  }: AnalyticsDataRegulationControllerOptions) {\n    const initialState: AnalyticsDataRegulationControllerState = {\n      ...getDefaultAnalyticsDataRegulationControllerState(),\n      ...state,\n    };\n\n    super({\n      name: controllerName,\n      metadata: analyticsDataRegulationControllerMetadata,\n      state: initialState,\n      messenger,\n    });\n\n    this.#analyticsId = analyticsId;\n\n    this.messenger.registerMethodActionHandlers(\n      this,\n      MESSENGER_EXPOSED_METHODS,\n    );\n\n    log('AnalyticsDataRegulationController initialized', {\n      hasCollectedDataSinceDeletionRequest:\n        this.state.hasCollectedDataSinceDeletionRequest,\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 with regulateId\n   * @throws Error if analytics ID is missing or if the service call fails\n   */\n  async createDataDeletionTask(): Promise<{\n    status: typeof DATA_DELETE_RESPONSE_STATUSES.Success;\n    regulateId: string;\n  }> {\n    if (!this.#analyticsId || this.#analyticsId.trim() === '') {\n      const error = new Error(\n        'Analytics ID not found. You need to provide a valid analytics ID when initializing the AnalyticsDataRegulationController.',\n      );\n      log('Analytics Deletion Task Error', error);\n      throw error;\n    }\n\n    const response = await this.messenger.call(\n      'AnalyticsDataRegulationService:createDataDeletionTask',\n      this.#analyticsId,\n    );\n\n    const deletionTimestamp = Date.now();\n    // Service validates and throws on all errors, so if we reach here, the response\n    // is guaranteed to be a success response with regulateId present\n    this.update((state) => {\n      state.deleteRegulationId = response.regulateId;\n      state.deleteRegulationTimestamp = deletionTimestamp;\n      state.hasCollectedDataSinceDeletionRequest = false;\n    });\n\n    this.messenger.publish(\n      `${controllerName}:dataDeletionTaskCreated`,\n      response,\n    );\n\n    return response;\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<DeleteRegulationStatus> {\n    // Capture all state values before async call to ensure consistency\n    // in case createDataDeletionTask() completes concurrently\n    const { deleteRegulationId } = this.state;\n    const { deleteRegulationTimestamp } = this.state;\n    const { hasCollectedDataSinceDeletionRequest } = this.state;\n\n    const status: DeleteRegulationStatus = {\n      deletionRequestTimestamp: deleteRegulationTimestamp,\n      dataDeletionRequestStatus: DATA_DELETE_STATUSES.Unknown,\n      hasCollectedDataSinceDeletionRequest,\n    };\n\n    if (!deleteRegulationId) {\n      return status;\n    }\n\n    // Service validates and throws on all errors, so if we reach here, the response\n    // is guaranteed to be a success response with dataDeleteStatus present\n    const dataDeletionTaskStatus = await this.messenger.call(\n      'AnalyticsDataRegulationService:checkDataDeleteStatus',\n      deleteRegulationId,\n    );\n\n    status.dataDeletionRequestStatus = dataDeletionTaskStatus.dataDeleteStatus;\n\n    return status;\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   * The flag can only be set to `true` (indicating data has been collected).\n   * It cannot be explicitly set to `false` - it is only reset to `false` when\n   * a new deletion task is created via `createDataDeletionTask`.\n   *\n   */\n  updateDataRecordingFlag(): void {\n    if (!this.state.hasCollectedDataSinceDeletionRequest) {\n      this.update((state) => {\n        state.hasCollectedDataSinceDeletionRequest = true;\n      });\n\n      this.messenger.publish(\n        `${controllerName}:dataRecordingFlagUpdated`,\n        true,\n      );\n    }\n  }\n}\n"]}

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

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