@metamask-previews/analytics-data-regulation-controller 0.0.0-preview-52f4a2ca
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +10 -0
- package/LICENSE +20 -0
- package/README.md +15 -0
- package/dist/AnalyticsDataRegulationController-method-action-types.cjs +7 -0
- package/dist/AnalyticsDataRegulationController-method-action-types.cjs.map +1 -0
- package/dist/AnalyticsDataRegulationController-method-action-types.d.cts +44 -0
- package/dist/AnalyticsDataRegulationController-method-action-types.d.cts.map +1 -0
- package/dist/AnalyticsDataRegulationController-method-action-types.d.mts +44 -0
- package/dist/AnalyticsDataRegulationController-method-action-types.d.mts.map +1 -0
- package/dist/AnalyticsDataRegulationController-method-action-types.mjs +6 -0
- package/dist/AnalyticsDataRegulationController-method-action-types.mjs.map +1 -0
- package/dist/AnalyticsDataRegulationController.cjs +176 -0
- package/dist/AnalyticsDataRegulationController.cjs.map +1 -0
- package/dist/AnalyticsDataRegulationController.d.cts +147 -0
- package/dist/AnalyticsDataRegulationController.d.cts.map +1 -0
- package/dist/AnalyticsDataRegulationController.d.mts +147 -0
- package/dist/AnalyticsDataRegulationController.d.mts.map +1 -0
- package/dist/AnalyticsDataRegulationController.mjs +171 -0
- package/dist/AnalyticsDataRegulationController.mjs.map +1 -0
- package/dist/AnalyticsDataRegulationService-method-action-types.cjs +7 -0
- package/dist/AnalyticsDataRegulationService-method-action-types.cjs.map +1 -0
- package/dist/AnalyticsDataRegulationService-method-action-types.d.cts +32 -0
- package/dist/AnalyticsDataRegulationService-method-action-types.d.cts.map +1 -0
- package/dist/AnalyticsDataRegulationService-method-action-types.d.mts +32 -0
- package/dist/AnalyticsDataRegulationService-method-action-types.d.mts.map +1 -0
- package/dist/AnalyticsDataRegulationService-method-action-types.mjs +6 -0
- package/dist/AnalyticsDataRegulationService-method-action-types.mjs.map +1 -0
- package/dist/AnalyticsDataRegulationService.cjs +247 -0
- package/dist/AnalyticsDataRegulationService.cjs.map +1 -0
- package/dist/AnalyticsDataRegulationService.d.cts +172 -0
- package/dist/AnalyticsDataRegulationService.d.cts.map +1 -0
- package/dist/AnalyticsDataRegulationService.d.mts +172 -0
- package/dist/AnalyticsDataRegulationService.d.mts.map +1 -0
- package/dist/AnalyticsDataRegulationService.mjs +243 -0
- package/dist/AnalyticsDataRegulationService.mjs.map +1 -0
- package/dist/index.cjs +14 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +11 -0
- package/dist/index.d.cts.map +1 -0
- package/dist/index.d.mts +11 -0
- package/dist/index.d.mts.map +1 -0
- package/dist/index.mjs +5 -0
- package/dist/index.mjs.map +1 -0
- package/dist/logger.cjs +7 -0
- package/dist/logger.cjs.map +1 -0
- package/dist/logger.d.cts +3 -0
- package/dist/logger.d.cts.map +1 -0
- package/dist/logger.d.mts +3 -0
- package/dist/logger.d.mts.map +1 -0
- package/dist/logger.mjs +4 -0
- package/dist/logger.mjs.map +1 -0
- package/dist/selectors.cjs +34 -0
- package/dist/selectors.cjs.map +1 -0
- package/dist/selectors.d.cts +11 -0
- package/dist/selectors.d.cts.map +1 -0
- package/dist/selectors.d.mts +11 -0
- package/dist/selectors.d.mts.map +1 -0
- package/dist/selectors.mjs +31 -0
- package/dist/selectors.mjs.map +1 -0
- package/dist/types.cjs +25 -0
- package/dist/types.cjs.map +1 -0
- package/dist/types.d.cts +46 -0
- package/dist/types.d.cts.map +1 -0
- package/dist/types.d.mts +46 -0
- package/dist/types.d.mts.map +1 -0
- package/dist/types.mjs +22 -0
- package/dist/types.mjs.map +1 -0
- package/package.json +76 -0
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to this project will be documented in this file.
|
|
4
|
+
|
|
5
|
+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
6
|
+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
|
+
|
|
8
|
+
## [Unreleased]
|
|
9
|
+
|
|
10
|
+
[Unreleased]: https://github.com/MetaMask/core/
|
package/LICENSE
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 MetaMask
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
package/README.md
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# `@metamask/analytics-data-regulation-controller`
|
|
2
|
+
|
|
3
|
+
Controller for managing analytics privacy and GDPR/CCPA data deletion functionality
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
`yarn add @metamask/analytics-data-regulation-controller`
|
|
8
|
+
|
|
9
|
+
or
|
|
10
|
+
|
|
11
|
+
`npm install @metamask/analytics-data-regulation-controller`
|
|
12
|
+
|
|
13
|
+
## Contributing
|
|
14
|
+
|
|
15
|
+
This package is part of a monorepo. Instructions for contributing can be found in the [monorepo README](https://github.com/MetaMask/core#readme).
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* This file is auto generated by `scripts/generate-method-action-types.ts`.
|
|
4
|
+
* Do not edit manually.
|
|
5
|
+
*/
|
|
6
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
7
|
+
//# sourceMappingURL=AnalyticsDataRegulationController-method-action-types.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"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 by `scripts/generate-method-action-types.ts`.\n * Do not edit manually.\n */\n\nimport type { AnalyticsDataRegulationController } from './AnalyticsDataRegulationController';\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"]}
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file is auto generated by `scripts/generate-method-action-types.ts`.
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
*/
|
|
5
|
+
import type { AnalyticsDataRegulationController } from "./AnalyticsDataRegulationController.cjs";
|
|
6
|
+
/**
|
|
7
|
+
* Creates a new delete regulation for the user.
|
|
8
|
+
* This is necessary to respect the GDPR and CCPA regulations.
|
|
9
|
+
*
|
|
10
|
+
* @returns Promise containing the status of the request with regulateId
|
|
11
|
+
* @throws Error if analytics ID is missing or if the service call fails
|
|
12
|
+
*/
|
|
13
|
+
export type AnalyticsDataRegulationControllerCreateDataDeletionTaskAction = {
|
|
14
|
+
type: `AnalyticsDataRegulationController:createDataDeletionTask`;
|
|
15
|
+
handler: AnalyticsDataRegulationController['createDataDeletionTask'];
|
|
16
|
+
};
|
|
17
|
+
/**
|
|
18
|
+
* Check the latest delete regulation status.
|
|
19
|
+
*
|
|
20
|
+
* @returns Promise containing the timestamp, delete status and collected data flag
|
|
21
|
+
*/
|
|
22
|
+
export type AnalyticsDataRegulationControllerCheckDataDeleteStatusAction = {
|
|
23
|
+
type: `AnalyticsDataRegulationController:checkDataDeleteStatus`;
|
|
24
|
+
handler: AnalyticsDataRegulationController['checkDataDeleteStatus'];
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* Update the data recording flag if needed.
|
|
28
|
+
* This method should be called after tracking events to ensure
|
|
29
|
+
* the data recording flag is properly updated for data deletion workflows.
|
|
30
|
+
*
|
|
31
|
+
* The flag can only be set to `true` (indicating data has been collected).
|
|
32
|
+
* It cannot be explicitly set to `false` - it is only reset to `false` when
|
|
33
|
+
* a new deletion task is created via `createDataDeletionTask`.
|
|
34
|
+
*
|
|
35
|
+
*/
|
|
36
|
+
export type AnalyticsDataRegulationControllerUpdateDataRecordingFlagAction = {
|
|
37
|
+
type: `AnalyticsDataRegulationController:updateDataRecordingFlag`;
|
|
38
|
+
handler: AnalyticsDataRegulationController['updateDataRecordingFlag'];
|
|
39
|
+
};
|
|
40
|
+
/**
|
|
41
|
+
* Union of all AnalyticsDataRegulationController action types.
|
|
42
|
+
*/
|
|
43
|
+
export type AnalyticsDataRegulationControllerMethodActions = AnalyticsDataRegulationControllerCreateDataDeletionTaskAction | AnalyticsDataRegulationControllerCheckDataDeleteStatusAction | AnalyticsDataRegulationControllerUpdateDataRecordingFlagAction;
|
|
44
|
+
//# sourceMappingURL=AnalyticsDataRegulationController-method-action-types.d.cts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"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,gDAA4C;AAE7F;;;;;;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"}
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file is auto generated by `scripts/generate-method-action-types.ts`.
|
|
3
|
+
* Do not edit manually.
|
|
4
|
+
*/
|
|
5
|
+
import type { AnalyticsDataRegulationController } from "./AnalyticsDataRegulationController.mjs";
|
|
6
|
+
/**
|
|
7
|
+
* Creates a new delete regulation for the user.
|
|
8
|
+
* This is necessary to respect the GDPR and CCPA regulations.
|
|
9
|
+
*
|
|
10
|
+
* @returns Promise containing the status of the request with regulateId
|
|
11
|
+
* @throws Error if analytics ID is missing or if the service call fails
|
|
12
|
+
*/
|
|
13
|
+
export type AnalyticsDataRegulationControllerCreateDataDeletionTaskAction = {
|
|
14
|
+
type: `AnalyticsDataRegulationController:createDataDeletionTask`;
|
|
15
|
+
handler: AnalyticsDataRegulationController['createDataDeletionTask'];
|
|
16
|
+
};
|
|
17
|
+
/**
|
|
18
|
+
* Check the latest delete regulation status.
|
|
19
|
+
*
|
|
20
|
+
* @returns Promise containing the timestamp, delete status and collected data flag
|
|
21
|
+
*/
|
|
22
|
+
export type AnalyticsDataRegulationControllerCheckDataDeleteStatusAction = {
|
|
23
|
+
type: `AnalyticsDataRegulationController:checkDataDeleteStatus`;
|
|
24
|
+
handler: AnalyticsDataRegulationController['checkDataDeleteStatus'];
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* Update the data recording flag if needed.
|
|
28
|
+
* This method should be called after tracking events to ensure
|
|
29
|
+
* the data recording flag is properly updated for data deletion workflows.
|
|
30
|
+
*
|
|
31
|
+
* The flag can only be set to `true` (indicating data has been collected).
|
|
32
|
+
* It cannot be explicitly set to `false` - it is only reset to `false` when
|
|
33
|
+
* a new deletion task is created via `createDataDeletionTask`.
|
|
34
|
+
*
|
|
35
|
+
*/
|
|
36
|
+
export type AnalyticsDataRegulationControllerUpdateDataRecordingFlagAction = {
|
|
37
|
+
type: `AnalyticsDataRegulationController:updateDataRecordingFlag`;
|
|
38
|
+
handler: AnalyticsDataRegulationController['updateDataRecordingFlag'];
|
|
39
|
+
};
|
|
40
|
+
/**
|
|
41
|
+
* Union of all AnalyticsDataRegulationController action types.
|
|
42
|
+
*/
|
|
43
|
+
export type AnalyticsDataRegulationControllerMethodActions = AnalyticsDataRegulationControllerCreateDataDeletionTaskAction | AnalyticsDataRegulationControllerCheckDataDeleteStatusAction | AnalyticsDataRegulationControllerUpdateDataRecordingFlagAction;
|
|
44
|
+
//# sourceMappingURL=AnalyticsDataRegulationController-method-action-types.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"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,gDAA4C;AAE7F;;;;;;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"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"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 by `scripts/generate-method-action-types.ts`.\n * Do not edit manually.\n */\n\nimport type { AnalyticsDataRegulationController } from './AnalyticsDataRegulationController';\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"]}
|
|
@@ -0,0 +1,176 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
|
|
3
|
+
if (kind === "m") throw new TypeError("Private method is not writable");
|
|
4
|
+
if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
|
|
5
|
+
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");
|
|
6
|
+
return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
|
|
7
|
+
};
|
|
8
|
+
var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
|
|
9
|
+
if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
|
|
10
|
+
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");
|
|
11
|
+
return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
|
|
12
|
+
};
|
|
13
|
+
var _AnalyticsDataRegulationController_analyticsId;
|
|
14
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
15
|
+
exports.AnalyticsDataRegulationController = exports.getDefaultAnalyticsDataRegulationControllerState = exports.controllerName = void 0;
|
|
16
|
+
const base_controller_1 = require("@metamask/base-controller");
|
|
17
|
+
const logger_1 = require("./logger.cjs");
|
|
18
|
+
const types_1 = require("./types.cjs");
|
|
19
|
+
// === GENERAL ===
|
|
20
|
+
/**
|
|
21
|
+
* The name of the {@link AnalyticsDataRegulationController}, used to namespace the
|
|
22
|
+
* controller's actions and events and to namespace the controller's state data
|
|
23
|
+
* when composed with other controllers.
|
|
24
|
+
*/
|
|
25
|
+
exports.controllerName = 'AnalyticsDataRegulationController';
|
|
26
|
+
/**
|
|
27
|
+
* Returns default values for AnalyticsDataRegulationController state.
|
|
28
|
+
*
|
|
29
|
+
* @returns Default state
|
|
30
|
+
*/
|
|
31
|
+
function getDefaultAnalyticsDataRegulationControllerState() {
|
|
32
|
+
return {
|
|
33
|
+
hasCollectedDataSinceDeletionRequest: false,
|
|
34
|
+
};
|
|
35
|
+
}
|
|
36
|
+
exports.getDefaultAnalyticsDataRegulationControllerState = getDefaultAnalyticsDataRegulationControllerState;
|
|
37
|
+
/**
|
|
38
|
+
* The metadata for each property in {@link AnalyticsDataRegulationControllerState}.
|
|
39
|
+
*/
|
|
40
|
+
const analyticsDataRegulationControllerMetadata = {
|
|
41
|
+
hasCollectedDataSinceDeletionRequest: {
|
|
42
|
+
includeInStateLogs: true,
|
|
43
|
+
persist: true,
|
|
44
|
+
includeInDebugSnapshot: true,
|
|
45
|
+
usedInUi: true,
|
|
46
|
+
},
|
|
47
|
+
deleteRegulationId: {
|
|
48
|
+
includeInStateLogs: true,
|
|
49
|
+
persist: true,
|
|
50
|
+
includeInDebugSnapshot: true,
|
|
51
|
+
usedInUi: true,
|
|
52
|
+
},
|
|
53
|
+
deleteRegulationTimestamp: {
|
|
54
|
+
includeInStateLogs: true,
|
|
55
|
+
persist: true,
|
|
56
|
+
includeInDebugSnapshot: true,
|
|
57
|
+
usedInUi: true,
|
|
58
|
+
},
|
|
59
|
+
};
|
|
60
|
+
// === MESSENGER ===
|
|
61
|
+
const MESSENGER_EXPOSED_METHODS = [
|
|
62
|
+
'createDataDeletionTask',
|
|
63
|
+
'checkDataDeleteStatus',
|
|
64
|
+
'updateDataRecordingFlag',
|
|
65
|
+
];
|
|
66
|
+
/**
|
|
67
|
+
* The AnalyticsDataRegulationController manages analytics privacy and GDPR/CCPA data deletion functionality.
|
|
68
|
+
* It communicates with Segment's Regulations API via a proxy to create and monitor data deletion requests.
|
|
69
|
+
*
|
|
70
|
+
* This controller follows the MetaMask controller pattern and integrates with the
|
|
71
|
+
* messenger system to allow other controllers and components to manage data deletion tasks.
|
|
72
|
+
*/
|
|
73
|
+
class AnalyticsDataRegulationController extends base_controller_1.BaseController {
|
|
74
|
+
/**
|
|
75
|
+
* Constructs an AnalyticsDataRegulationController instance.
|
|
76
|
+
*
|
|
77
|
+
* @param options - Controller options
|
|
78
|
+
* @param options.state - Initial controller state. Use `getDefaultAnalyticsDataRegulationControllerState()` for defaults.
|
|
79
|
+
* @param options.messenger - Messenger used to communicate with BaseController
|
|
80
|
+
* @param options.analyticsId - Analytics ID used for data deletion requests
|
|
81
|
+
*/
|
|
82
|
+
constructor({ state = {}, messenger, analyticsId, }) {
|
|
83
|
+
const initialState = {
|
|
84
|
+
...getDefaultAnalyticsDataRegulationControllerState(),
|
|
85
|
+
...state,
|
|
86
|
+
};
|
|
87
|
+
super({
|
|
88
|
+
name: exports.controllerName,
|
|
89
|
+
metadata: analyticsDataRegulationControllerMetadata,
|
|
90
|
+
state: initialState,
|
|
91
|
+
messenger,
|
|
92
|
+
});
|
|
93
|
+
/**
|
|
94
|
+
* Analytics ID used for data deletion requests.
|
|
95
|
+
*/
|
|
96
|
+
_AnalyticsDataRegulationController_analyticsId.set(this, void 0);
|
|
97
|
+
__classPrivateFieldSet(this, _AnalyticsDataRegulationController_analyticsId, analyticsId, "f");
|
|
98
|
+
this.messenger.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
|
|
99
|
+
(0, logger_1.projectLogger)('AnalyticsDataRegulationController initialized', {
|
|
100
|
+
hasCollectedDataSinceDeletionRequest: this.state.hasCollectedDataSinceDeletionRequest,
|
|
101
|
+
hasDeleteRegulationId: Boolean(this.state.deleteRegulationId),
|
|
102
|
+
deleteRegulationTimestamp: this.state.deleteRegulationTimestamp,
|
|
103
|
+
});
|
|
104
|
+
}
|
|
105
|
+
/**
|
|
106
|
+
* Creates a new delete regulation for the user.
|
|
107
|
+
* This is necessary to respect the GDPR and CCPA regulations.
|
|
108
|
+
*
|
|
109
|
+
* @returns Promise containing the status of the request with regulateId
|
|
110
|
+
* @throws Error if analytics ID is missing or if the service call fails
|
|
111
|
+
*/
|
|
112
|
+
async createDataDeletionTask() {
|
|
113
|
+
if (!__classPrivateFieldGet(this, _AnalyticsDataRegulationController_analyticsId, "f") || __classPrivateFieldGet(this, _AnalyticsDataRegulationController_analyticsId, "f").trim() === '') {
|
|
114
|
+
const error = new Error('Analytics ID not found. You need to provide a valid analytics ID when initializing the AnalyticsDataRegulationController.');
|
|
115
|
+
(0, logger_1.projectLogger)('Analytics Deletion Task Error', error);
|
|
116
|
+
throw error;
|
|
117
|
+
}
|
|
118
|
+
const response = await this.messenger.call('AnalyticsDataRegulationService:createDataDeletionTask', __classPrivateFieldGet(this, _AnalyticsDataRegulationController_analyticsId, "f"));
|
|
119
|
+
const deletionTimestamp = Date.now();
|
|
120
|
+
// Service validates and throws on all errors, so if we reach here, the response
|
|
121
|
+
// is guaranteed to be a success response with regulateId present
|
|
122
|
+
this.update((state) => {
|
|
123
|
+
state.deleteRegulationId = response.regulateId;
|
|
124
|
+
state.deleteRegulationTimestamp = deletionTimestamp;
|
|
125
|
+
state.hasCollectedDataSinceDeletionRequest = false;
|
|
126
|
+
});
|
|
127
|
+
this.messenger.publish(`${exports.controllerName}:dataDeletionTaskCreated`, response);
|
|
128
|
+
return response;
|
|
129
|
+
}
|
|
130
|
+
/**
|
|
131
|
+
* Check the latest delete regulation status.
|
|
132
|
+
*
|
|
133
|
+
* @returns Promise containing the timestamp, delete status and collected data flag
|
|
134
|
+
*/
|
|
135
|
+
async checkDataDeleteStatus() {
|
|
136
|
+
// Capture all state values before async call to ensure consistency
|
|
137
|
+
// in case createDataDeletionTask() completes concurrently
|
|
138
|
+
const { deleteRegulationId } = this.state;
|
|
139
|
+
const { deleteRegulationTimestamp } = this.state;
|
|
140
|
+
const { hasCollectedDataSinceDeletionRequest } = this.state;
|
|
141
|
+
const status = {
|
|
142
|
+
deletionRequestTimestamp: deleteRegulationTimestamp,
|
|
143
|
+
dataDeletionRequestStatus: types_1.DATA_DELETE_STATUSES.Unknown,
|
|
144
|
+
hasCollectedDataSinceDeletionRequest,
|
|
145
|
+
};
|
|
146
|
+
if (!deleteRegulationId) {
|
|
147
|
+
return status;
|
|
148
|
+
}
|
|
149
|
+
// Service validates and throws on all errors, so if we reach here, the response
|
|
150
|
+
// is guaranteed to be a success response with dataDeleteStatus present
|
|
151
|
+
const dataDeletionTaskStatus = await this.messenger.call('AnalyticsDataRegulationService:checkDataDeleteStatus', deleteRegulationId);
|
|
152
|
+
status.dataDeletionRequestStatus = dataDeletionTaskStatus.dataDeleteStatus;
|
|
153
|
+
return status;
|
|
154
|
+
}
|
|
155
|
+
/**
|
|
156
|
+
* Update the data recording flag if needed.
|
|
157
|
+
* This method should be called after tracking events to ensure
|
|
158
|
+
* the data recording flag is properly updated for data deletion workflows.
|
|
159
|
+
*
|
|
160
|
+
* The flag can only be set to `true` (indicating data has been collected).
|
|
161
|
+
* It cannot be explicitly set to `false` - it is only reset to `false` when
|
|
162
|
+
* a new deletion task is created via `createDataDeletionTask`.
|
|
163
|
+
*
|
|
164
|
+
*/
|
|
165
|
+
updateDataRecordingFlag() {
|
|
166
|
+
if (!this.state.hasCollectedDataSinceDeletionRequest) {
|
|
167
|
+
this.update((state) => {
|
|
168
|
+
state.hasCollectedDataSinceDeletionRequest = true;
|
|
169
|
+
});
|
|
170
|
+
this.messenger.publish(`${exports.controllerName}:dataRecordingFlagUpdated`, true);
|
|
171
|
+
}
|
|
172
|
+
}
|
|
173
|
+
}
|
|
174
|
+
exports.AnalyticsDataRegulationController = AnalyticsDataRegulationController;
|
|
175
|
+
_AnalyticsDataRegulationController_analyticsId = new WeakMap();
|
|
176
|
+
//# sourceMappingURL=AnalyticsDataRegulationController.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"AnalyticsDataRegulationController.cjs","sourceRoot":"","sources":["../src/AnalyticsDataRegulationController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAKA,+DAA2D;AAK3D,yCAAgD;AAChD,uCAA8E;AAG9E,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,sBAAG,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,sBAAG,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,4BAAoB,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';\nimport type { AnalyticsDataRegulationServiceActions } from './AnalyticsDataRegulationService';\nimport { projectLogger as log } from './logger';\nimport { DATA_DELETE_RESPONSE_STATUSES, DATA_DELETE_STATUSES } from './types';\nimport type { DeleteRegulationResponse, DeleteRegulationStatus } from './types';\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"]}
|
|
@@ -0,0 +1,147 @@
|
|
|
1
|
+
import type { ControllerGetStateAction, ControllerStateChangeEvent } from "@metamask/base-controller";
|
|
2
|
+
import { BaseController } from "@metamask/base-controller";
|
|
3
|
+
import type { Messenger } from "@metamask/messenger";
|
|
4
|
+
import type { AnalyticsDataRegulationControllerMethodActions } from "./AnalyticsDataRegulationController-method-action-types.cjs";
|
|
5
|
+
import type { AnalyticsDataRegulationServiceActions } from "./AnalyticsDataRegulationService.cjs";
|
|
6
|
+
import { DATA_DELETE_RESPONSE_STATUSES } from "./types.cjs";
|
|
7
|
+
import type { DeleteRegulationResponse, DeleteRegulationStatus } from "./types.cjs";
|
|
8
|
+
/**
|
|
9
|
+
* The name of the {@link AnalyticsDataRegulationController}, used to namespace the
|
|
10
|
+
* controller's actions and events and to namespace the controller's state data
|
|
11
|
+
* when composed with other controllers.
|
|
12
|
+
*/
|
|
13
|
+
export declare const controllerName = "AnalyticsDataRegulationController";
|
|
14
|
+
/**
|
|
15
|
+
* Describes the shape of the state object for {@link AnalyticsDataRegulationController}.
|
|
16
|
+
*/
|
|
17
|
+
export type AnalyticsDataRegulationControllerState = {
|
|
18
|
+
/**
|
|
19
|
+
* Indicates if data has been recorded since the last deletion request.
|
|
20
|
+
*/
|
|
21
|
+
hasCollectedDataSinceDeletionRequest: boolean;
|
|
22
|
+
/**
|
|
23
|
+
* Segment's data deletion regulation ID.
|
|
24
|
+
* The ID returned by the Segment delete API which allows checking the status of the deletion request.
|
|
25
|
+
*/
|
|
26
|
+
deleteRegulationId?: string;
|
|
27
|
+
/**
|
|
28
|
+
* Segment's data deletion regulation creation timestamp.
|
|
29
|
+
* The timestamp (in milliseconds since epoch) when the deletion request was created.
|
|
30
|
+
*/
|
|
31
|
+
deleteRegulationTimestamp?: number;
|
|
32
|
+
};
|
|
33
|
+
/**
|
|
34
|
+
* Returns default values for AnalyticsDataRegulationController state.
|
|
35
|
+
*
|
|
36
|
+
* @returns Default state
|
|
37
|
+
*/
|
|
38
|
+
export declare function getDefaultAnalyticsDataRegulationControllerState(): AnalyticsDataRegulationControllerState;
|
|
39
|
+
/**
|
|
40
|
+
* Returns the state of the {@link AnalyticsDataRegulationController}.
|
|
41
|
+
*/
|
|
42
|
+
export type AnalyticsDataRegulationControllerGetStateAction = ControllerGetStateAction<typeof controllerName, AnalyticsDataRegulationControllerState>;
|
|
43
|
+
/**
|
|
44
|
+
* Actions that {@link AnalyticsDataRegulationControllerMessenger} exposes to other consumers.
|
|
45
|
+
*/
|
|
46
|
+
export type AnalyticsDataRegulationControllerActions = AnalyticsDataRegulationControllerGetStateAction | AnalyticsDataRegulationControllerMethodActions;
|
|
47
|
+
/**
|
|
48
|
+
* Actions from other messengers that {@link AnalyticsDataRegulationControllerMessenger} calls.
|
|
49
|
+
*/
|
|
50
|
+
type AllowedActions = AnalyticsDataRegulationServiceActions;
|
|
51
|
+
/**
|
|
52
|
+
* Event emitted when a data deletion task is created.
|
|
53
|
+
*/
|
|
54
|
+
export type DataDeletionTaskCreatedEvent = {
|
|
55
|
+
type: `${typeof controllerName}:dataDeletionTaskCreated`;
|
|
56
|
+
payload: [DeleteRegulationResponse];
|
|
57
|
+
};
|
|
58
|
+
/**
|
|
59
|
+
* Event emitted when the data recording flag is updated.
|
|
60
|
+
*/
|
|
61
|
+
export type DataRecordingFlagUpdatedEvent = {
|
|
62
|
+
type: `${typeof controllerName}:dataRecordingFlagUpdated`;
|
|
63
|
+
payload: [boolean];
|
|
64
|
+
};
|
|
65
|
+
/**
|
|
66
|
+
* Event emitted when the state of the {@link AnalyticsDataRegulationController} changes.
|
|
67
|
+
*/
|
|
68
|
+
export type AnalyticsDataRegulationControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, AnalyticsDataRegulationControllerState>;
|
|
69
|
+
/**
|
|
70
|
+
* Events that {@link AnalyticsDataRegulationControllerMessenger} exposes to other consumers.
|
|
71
|
+
*/
|
|
72
|
+
export type AnalyticsDataRegulationControllerEvents = AnalyticsDataRegulationControllerStateChangeEvent | DataDeletionTaskCreatedEvent | DataRecordingFlagUpdatedEvent;
|
|
73
|
+
/**
|
|
74
|
+
* Events from other messengers that {@link AnalyticsDataRegulationControllerMessenger} subscribes to.
|
|
75
|
+
*/
|
|
76
|
+
type AllowedEvents = never;
|
|
77
|
+
/**
|
|
78
|
+
* The messenger restricted to actions and events accessed by
|
|
79
|
+
* {@link AnalyticsDataRegulationController}.
|
|
80
|
+
*/
|
|
81
|
+
export type AnalyticsDataRegulationControllerMessenger = Messenger<typeof controllerName, AnalyticsDataRegulationControllerActions | AllowedActions, AnalyticsDataRegulationControllerEvents | AllowedEvents>;
|
|
82
|
+
/**
|
|
83
|
+
* The options that AnalyticsDataRegulationController takes.
|
|
84
|
+
*/
|
|
85
|
+
export type AnalyticsDataRegulationControllerOptions = {
|
|
86
|
+
/**
|
|
87
|
+
* Initial controller state.
|
|
88
|
+
*/
|
|
89
|
+
state?: Partial<AnalyticsDataRegulationControllerState>;
|
|
90
|
+
/**
|
|
91
|
+
* Messenger used to communicate with BaseController and other controllers.
|
|
92
|
+
*/
|
|
93
|
+
messenger: AnalyticsDataRegulationControllerMessenger;
|
|
94
|
+
/**
|
|
95
|
+
* Analytics ID used for data deletion requests.
|
|
96
|
+
*/
|
|
97
|
+
analyticsId: string;
|
|
98
|
+
};
|
|
99
|
+
/**
|
|
100
|
+
* The AnalyticsDataRegulationController manages analytics privacy and GDPR/CCPA data deletion functionality.
|
|
101
|
+
* It communicates with Segment's Regulations API via a proxy to create and monitor data deletion requests.
|
|
102
|
+
*
|
|
103
|
+
* This controller follows the MetaMask controller pattern and integrates with the
|
|
104
|
+
* messenger system to allow other controllers and components to manage data deletion tasks.
|
|
105
|
+
*/
|
|
106
|
+
export declare class AnalyticsDataRegulationController extends BaseController<typeof controllerName, AnalyticsDataRegulationControllerState, AnalyticsDataRegulationControllerMessenger> {
|
|
107
|
+
#private;
|
|
108
|
+
/**
|
|
109
|
+
* Constructs an AnalyticsDataRegulationController instance.
|
|
110
|
+
*
|
|
111
|
+
* @param options - Controller options
|
|
112
|
+
* @param options.state - Initial controller state. Use `getDefaultAnalyticsDataRegulationControllerState()` for defaults.
|
|
113
|
+
* @param options.messenger - Messenger used to communicate with BaseController
|
|
114
|
+
* @param options.analyticsId - Analytics ID used for data deletion requests
|
|
115
|
+
*/
|
|
116
|
+
constructor({ state, messenger, analyticsId, }: AnalyticsDataRegulationControllerOptions);
|
|
117
|
+
/**
|
|
118
|
+
* Creates a new delete regulation for the user.
|
|
119
|
+
* This is necessary to respect the GDPR and CCPA regulations.
|
|
120
|
+
*
|
|
121
|
+
* @returns Promise containing the status of the request with regulateId
|
|
122
|
+
* @throws Error if analytics ID is missing or if the service call fails
|
|
123
|
+
*/
|
|
124
|
+
createDataDeletionTask(): Promise<{
|
|
125
|
+
status: typeof DATA_DELETE_RESPONSE_STATUSES.Success;
|
|
126
|
+
regulateId: string;
|
|
127
|
+
}>;
|
|
128
|
+
/**
|
|
129
|
+
* Check the latest delete regulation status.
|
|
130
|
+
*
|
|
131
|
+
* @returns Promise containing the timestamp, delete status and collected data flag
|
|
132
|
+
*/
|
|
133
|
+
checkDataDeleteStatus(): Promise<DeleteRegulationStatus>;
|
|
134
|
+
/**
|
|
135
|
+
* Update the data recording flag if needed.
|
|
136
|
+
* This method should be called after tracking events to ensure
|
|
137
|
+
* the data recording flag is properly updated for data deletion workflows.
|
|
138
|
+
*
|
|
139
|
+
* The flag can only be set to `true` (indicating data has been collected).
|
|
140
|
+
* It cannot be explicitly set to `false` - it is only reset to `false` when
|
|
141
|
+
* a new deletion task is created via `createDataDeletionTask`.
|
|
142
|
+
*
|
|
143
|
+
*/
|
|
144
|
+
updateDataRecordingFlag(): void;
|
|
145
|
+
}
|
|
146
|
+
export {};
|
|
147
|
+
//# sourceMappingURL=AnalyticsDataRegulationController.d.cts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"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,oEAAgE;AAC9H,OAAO,KAAK,EAAE,qCAAqC,EAAE,6CAAyC;AAE9F,OAAO,EAAE,6BAA6B,EAAwB,oBAAgB;AAC9E,OAAO,KAAK,EAAE,wBAAwB,EAAE,sBAAsB,EAAE,oBAAgB;AAIhF;;;;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"}
|