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

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.
Files changed (86) hide show
  1. package/CHANGELOG.md +9 -4
  2. package/dist/{AnalyticsDataRegulationController-method-action-types.d.mts → AnalyticsDataRegulationController-method-action-types.d.ts} +2 -2
  3. package/dist/AnalyticsDataRegulationController-method-action-types.d.ts.map +1 -0
  4. package/dist/{AnalyticsDataRegulationController-method-action-types.mjs → AnalyticsDataRegulationController-method-action-types.js} +1 -1
  5. package/dist/AnalyticsDataRegulationController-method-action-types.js.map +1 -0
  6. package/dist/{AnalyticsDataRegulationController.d.cts → AnalyticsDataRegulationController.d.ts} +8 -8
  7. package/dist/AnalyticsDataRegulationController.d.ts.map +1 -0
  8. package/dist/{AnalyticsDataRegulationController.mjs → AnalyticsDataRegulationController.js} +11 -24
  9. package/dist/AnalyticsDataRegulationController.js.map +1 -0
  10. package/dist/{AnalyticsDataRegulationService-method-action-types.d.cts → AnalyticsDataRegulationService-method-action-types.d.ts} +2 -2
  11. package/dist/AnalyticsDataRegulationService-method-action-types.d.ts.map +1 -0
  12. package/dist/{AnalyticsDataRegulationService-method-action-types.mjs → AnalyticsDataRegulationService-method-action-types.js} +1 -1
  13. package/dist/AnalyticsDataRegulationService-method-action-types.js.map +1 -0
  14. package/dist/{AnalyticsDataRegulationService.d.mts → AnalyticsDataRegulationService.d.ts} +7 -7
  15. package/dist/AnalyticsDataRegulationService.d.ts.map +1 -0
  16. package/dist/{AnalyticsDataRegulationService.mjs → AnalyticsDataRegulationService.js} +47 -56
  17. package/dist/AnalyticsDataRegulationService.js.map +1 -0
  18. package/dist/index.d.ts +11 -0
  19. package/dist/index.d.ts.map +1 -0
  20. package/dist/index.js +5 -0
  21. package/dist/index.js.map +1 -0
  22. package/dist/logger.d.ts +2 -0
  23. package/dist/logger.d.ts.map +1 -0
  24. package/dist/{logger.mjs → logger.js} +2 -2
  25. package/dist/logger.js.map +1 -0
  26. package/dist/selectors.d.ts +33 -0
  27. package/dist/selectors.d.ts.map +1 -0
  28. package/dist/{selectors.mjs → selectors.js} +1 -1
  29. package/dist/selectors.js.map +1 -0
  30. package/dist/{types.d.cts → types.d.ts} +11 -11
  31. package/dist/types.d.ts.map +1 -0
  32. package/dist/{types.mjs → types.js} +1 -1
  33. package/dist/types.js.map +1 -0
  34. package/package.json +16 -20
  35. package/dist/AnalyticsDataRegulationController-method-action-types.cjs +0 -7
  36. package/dist/AnalyticsDataRegulationController-method-action-types.cjs.map +0 -1
  37. package/dist/AnalyticsDataRegulationController-method-action-types.d.cts +0 -44
  38. package/dist/AnalyticsDataRegulationController-method-action-types.d.cts.map +0 -1
  39. package/dist/AnalyticsDataRegulationController-method-action-types.d.mts.map +0 -1
  40. package/dist/AnalyticsDataRegulationController-method-action-types.mjs.map +0 -1
  41. package/dist/AnalyticsDataRegulationController.cjs +0 -176
  42. package/dist/AnalyticsDataRegulationController.cjs.map +0 -1
  43. package/dist/AnalyticsDataRegulationController.d.cts.map +0 -1
  44. package/dist/AnalyticsDataRegulationController.d.mts +0 -147
  45. package/dist/AnalyticsDataRegulationController.d.mts.map +0 -1
  46. package/dist/AnalyticsDataRegulationController.mjs.map +0 -1
  47. package/dist/AnalyticsDataRegulationService-method-action-types.cjs +0 -7
  48. package/dist/AnalyticsDataRegulationService-method-action-types.cjs.map +0 -1
  49. package/dist/AnalyticsDataRegulationService-method-action-types.d.cts.map +0 -1
  50. package/dist/AnalyticsDataRegulationService-method-action-types.d.mts +0 -32
  51. package/dist/AnalyticsDataRegulationService-method-action-types.d.mts.map +0 -1
  52. package/dist/AnalyticsDataRegulationService-method-action-types.mjs.map +0 -1
  53. package/dist/AnalyticsDataRegulationService.cjs +0 -247
  54. package/dist/AnalyticsDataRegulationService.cjs.map +0 -1
  55. package/dist/AnalyticsDataRegulationService.d.cts +0 -172
  56. package/dist/AnalyticsDataRegulationService.d.cts.map +0 -1
  57. package/dist/AnalyticsDataRegulationService.d.mts.map +0 -1
  58. package/dist/AnalyticsDataRegulationService.mjs.map +0 -1
  59. package/dist/index.cjs +0 -14
  60. package/dist/index.cjs.map +0 -1
  61. package/dist/index.d.cts +0 -11
  62. package/dist/index.d.cts.map +0 -1
  63. package/dist/index.d.mts +0 -11
  64. package/dist/index.d.mts.map +0 -1
  65. package/dist/index.mjs +0 -5
  66. package/dist/index.mjs.map +0 -1
  67. package/dist/logger.cjs +0 -7
  68. package/dist/logger.cjs.map +0 -1
  69. package/dist/logger.d.cts +0 -3
  70. package/dist/logger.d.cts.map +0 -1
  71. package/dist/logger.d.mts +0 -3
  72. package/dist/logger.d.mts.map +0 -1
  73. package/dist/logger.mjs.map +0 -1
  74. package/dist/selectors.cjs +0 -34
  75. package/dist/selectors.cjs.map +0 -1
  76. package/dist/selectors.d.cts +0 -11
  77. package/dist/selectors.d.cts.map +0 -1
  78. package/dist/selectors.d.mts +0 -11
  79. package/dist/selectors.d.mts.map +0 -1
  80. package/dist/selectors.mjs.map +0 -1
  81. package/dist/types.cjs +0 -25
  82. package/dist/types.cjs.map +0 -1
  83. package/dist/types.d.cts.map +0 -1
  84. package/dist/types.d.mts +0 -46
  85. package/dist/types.d.mts.map +0 -1
  86. package/dist/types.mjs.map +0 -1
package/CHANGELOG.md CHANGED
@@ -9,9 +9,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
9
9
 
10
10
  ### Changed
11
11
 
12
- - Bump `@metamask/utils` from `^11.9.0` to `^11.11.0` ([#9074](https://github.com/MetaMask/core/pull/9074))
13
- - Bump `@metamask/controller-utils` from `^11.19.0` to `^12.3.0` ([#8344](https://github.com/MetaMask/core/pull/8344), [#8755](https://github.com/MetaMask/core/pull/8755), [#8774](https://github.com/MetaMask/core/pull/8774), [#9058](https://github.com/MetaMask/core/pull/9058), [#9083](https://github.com/MetaMask/core/pull/9083), [#9218](https://github.com/MetaMask/core/pull/9218))
14
- - Bump `@metamask/messenger` from `^1.1.0` to `^2.0.0` ([#8373](https://github.com/MetaMask/core/pull/8373), [#8632](https://github.com/MetaMask/core/pull/8632), [#9392](https://github.com/MetaMask/core/pull/9392))
15
- - Bump `@metamask/base-controller` from `^9.0.1` to `^9.1.0` ([#8457](https://github.com/MetaMask/core/pull/8457))
12
+ - **BREAKING:** Drop CommonJS support ([#9536](https://github.com/MetaMask/core/pull/9536))
13
+ - This package is now ESM-only, but can still be used in CommonJS projects via `require(esm)` in modern Node.js versions (22+), or dynamic imports in older Node.js versions.
14
+ - **BREAKING:** Bump minimum Node.js version to 22 ([#9976](https://github.com/MetaMask/core/pull/9976))
15
+ - **BREAKING:** Bump TypeScript target to ES2022 ([#10019](https://github.com/MetaMask/core/pull/10019))
16
+ - This package now ships ES2022 code, requiring a compatible modern environment or bundler configuration to consume.
17
+ - Bump `@metamask/utils` from `^11.9.0` to `^12.0.0` ([#9074](https://github.com/MetaMask/core/pull/9074), [#10076](https://github.com/MetaMask/core/pull/10076), [#10192](https://github.com/MetaMask/core/pull/10192))
18
+ - Bump `@metamask/controller-utils` from `^11.19.0` to `^13.0.0` ([#8344](https://github.com/MetaMask/core/pull/8344), [#8755](https://github.com/MetaMask/core/pull/8755), [#8774](https://github.com/MetaMask/core/pull/8774), [#9058](https://github.com/MetaMask/core/pull/9058), [#9083](https://github.com/MetaMask/core/pull/9083), [#9218](https://github.com/MetaMask/core/pull/9218), [#10160](https://github.com/MetaMask/core/pull/10160))
19
+ - Bump `@metamask/messenger` from `^1.1.0` to `^3.0.0` ([#8373](https://github.com/MetaMask/core/pull/8373), [#8632](https://github.com/MetaMask/core/pull/8632), [#9392](https://github.com/MetaMask/core/pull/9392), [#10160](https://github.com/MetaMask/core/pull/10160))
20
+ - Bump `@metamask/base-controller` from `^9.0.1` to `^10.0.0` ([#8457](https://github.com/MetaMask/core/pull/8457), [#10160](https://github.com/MetaMask/core/pull/10160))
16
21
 
17
22
  [Unreleased]: https://github.com/MetaMask/core/
@@ -2,7 +2,7 @@
2
2
  * This file is auto generated.
3
3
  * Do not edit manually.
4
4
  */
5
- import type { AnalyticsDataRegulationController } from "./AnalyticsDataRegulationController.mjs";
5
+ import type { AnalyticsDataRegulationController } from './AnalyticsDataRegulationController.js';
6
6
  /**
7
7
  * Creates a new delete regulation for the user.
8
8
  * This is necessary to respect the GDPR and CCPA regulations.
@@ -41,4 +41,4 @@ export type AnalyticsDataRegulationControllerUpdateDataRecordingFlagAction = {
41
41
  * Union of all AnalyticsDataRegulationController action types.
42
42
  */
43
43
  export type AnalyticsDataRegulationControllerMethodActions = AnalyticsDataRegulationControllerCreateDataDeletionTaskAction | AnalyticsDataRegulationControllerCheckDataDeleteStatusAction | AnalyticsDataRegulationControllerUpdateDataRecordingFlagAction;
44
- //# sourceMappingURL=AnalyticsDataRegulationController-method-action-types.d.mts.map
44
+ //# sourceMappingURL=AnalyticsDataRegulationController-method-action-types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"AnalyticsDataRegulationController-method-action-types.d.ts","sourceRoot":"","sources":["../src/AnalyticsDataRegulationController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,iCAAiC,EAAE,MAAM,wCAAwC,CAAC;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"}
@@ -3,4 +3,4 @@
3
3
  * Do not edit manually.
4
4
  */
5
5
  export {};
6
- //# sourceMappingURL=AnalyticsDataRegulationController-method-action-types.mjs.map
6
+ //# sourceMappingURL=AnalyticsDataRegulationController-method-action-types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"AnalyticsDataRegulationController-method-action-types.js","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"]}
@@ -1,10 +1,10 @@
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";
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.js';
5
+ import type { AnalyticsDataRegulationServiceActions } from './AnalyticsDataRegulationService.js';
6
+ import { DATA_DELETE_RESPONSE_STATUSES } from './types.js';
7
+ import type { DeleteRegulationResponse, DeleteRegulationStatus } from './types.js';
8
8
  /**
9
9
  * The name of the {@link AnalyticsDataRegulationController}, used to namespace the
10
10
  * controller's actions and events and to namespace the controller's state data
@@ -144,4 +144,4 @@ export declare class AnalyticsDataRegulationController extends BaseController<ty
144
144
  updateDataRecordingFlag(): void;
145
145
  }
146
146
  export {};
147
- //# sourceMappingURL=AnalyticsDataRegulationController.d.cts.map
147
+ //# sourceMappingURL=AnalyticsDataRegulationController.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"AnalyticsDataRegulationController.d.ts","sourceRoot":"","sources":["../src/AnalyticsDataRegulationController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAE3B,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAErD,OAAO,KAAK,EAAE,8CAA8C,EAAE,MAAM,4DAA4D,CAAC;AACjI,OAAO,KAAK,EAAE,qCAAqC,EAAE,MAAM,qCAAqC,CAAC;AAEjG,OAAO,EACL,6BAA6B,EAE9B,MAAM,YAAY,CAAC;AACpB,OAAO,KAAK,EACV,wBAAwB,EACxB,sBAAsB,EACvB,MAAM,YAAY,CAAC;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;IACH,YAAY,EACV,KAAU,EACV,SAAS,EACT,WAAW,GACZ,EAAE,wCAAwC,EA0B1C;IAED;;;;;;OAMG;IACG,sBAAsB,IAAI,OAAO,CAAC;QACtC,MAAM,EAAE,OAAO,6BAA6B,CAAC,OAAO,CAAC;QACrD,UAAU,EAAE,MAAM,CAAC;KACpB,CAAC,CA6BD;IAED;;;;OAIG;IACG,qBAAqB,IAAI,OAAO,CAAC,sBAAsB,CAAC,CA2B7D;IAED;;;;;;;;;OASG;IACH,uBAAuB,IAAI,IAAI,CAW9B;CACF"}
@@ -1,18 +1,6 @@
1
- var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
2
- if (kind === "m") throw new TypeError("Private method is not writable");
3
- if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
4
- 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");
5
- return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
6
- };
7
- var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
8
- if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
9
- 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");
10
- return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
11
- };
12
- var _AnalyticsDataRegulationController_analyticsId;
13
- import { BaseController } from "@metamask/base-controller";
14
- import { projectLogger as log } from "./logger.mjs";
15
- import { DATA_DELETE_RESPONSE_STATUSES, DATA_DELETE_STATUSES } from "./types.mjs";
1
+ import { BaseController } from '@metamask/base-controller';
2
+ import { projectLogger as log } from './logger.js';
3
+ import { DATA_DELETE_STATUSES, } from './types.js';
16
4
  // === GENERAL ===
17
5
  /**
18
6
  * The name of the {@link AnalyticsDataRegulationController}, used to namespace the
@@ -67,6 +55,10 @@ const MESSENGER_EXPOSED_METHODS = [
67
55
  * messenger system to allow other controllers and components to manage data deletion tasks.
68
56
  */
69
57
  export class AnalyticsDataRegulationController extends BaseController {
58
+ /**
59
+ * Analytics ID used for data deletion requests.
60
+ */
61
+ #analyticsId;
70
62
  /**
71
63
  * Constructs an AnalyticsDataRegulationController instance.
72
64
  *
@@ -86,11 +78,7 @@ export class AnalyticsDataRegulationController extends BaseController {
86
78
  state: initialState,
87
79
  messenger,
88
80
  });
89
- /**
90
- * Analytics ID used for data deletion requests.
91
- */
92
- _AnalyticsDataRegulationController_analyticsId.set(this, void 0);
93
- __classPrivateFieldSet(this, _AnalyticsDataRegulationController_analyticsId, analyticsId, "f");
81
+ this.#analyticsId = analyticsId;
94
82
  this.messenger.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
95
83
  log('AnalyticsDataRegulationController initialized', {
96
84
  hasCollectedDataSinceDeletionRequest: this.state.hasCollectedDataSinceDeletionRequest,
@@ -106,12 +94,12 @@ export class AnalyticsDataRegulationController extends BaseController {
106
94
  * @throws Error if analytics ID is missing or if the service call fails
107
95
  */
108
96
  async createDataDeletionTask() {
109
- if (!__classPrivateFieldGet(this, _AnalyticsDataRegulationController_analyticsId, "f") || __classPrivateFieldGet(this, _AnalyticsDataRegulationController_analyticsId, "f").trim() === '') {
97
+ if (!this.#analyticsId || this.#analyticsId.trim() === '') {
110
98
  const error = new Error('Analytics ID not found. You need to provide a valid analytics ID when initializing the AnalyticsDataRegulationController.');
111
99
  log('Analytics Deletion Task Error', error);
112
100
  throw error;
113
101
  }
114
- const response = await this.messenger.call('AnalyticsDataRegulationService:createDataDeletionTask', __classPrivateFieldGet(this, _AnalyticsDataRegulationController_analyticsId, "f"));
102
+ const response = await this.messenger.call('AnalyticsDataRegulationService:createDataDeletionTask', this.#analyticsId);
115
103
  const deletionTimestamp = Date.now();
116
104
  // Service validates and throws on all errors, so if we reach here, the response
117
105
  // is guaranteed to be a success response with regulateId present
@@ -167,5 +155,4 @@ export class AnalyticsDataRegulationController extends BaseController {
167
155
  }
168
156
  }
169
157
  }
170
- _AnalyticsDataRegulationController_analyticsId = new WeakMap();
171
- //# sourceMappingURL=AnalyticsDataRegulationController.mjs.map
158
+ //# sourceMappingURL=AnalyticsDataRegulationController.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"AnalyticsDataRegulationController.js","sourceRoot":"","sources":["../src/AnalyticsDataRegulationController.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAK3D,OAAO,EAAE,aAAa,IAAI,GAAG,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EAEL,oBAAoB,GACrB,MAAM,YAAY,CAAC;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;IACC;;OAEG;IACM,YAAY,CAAS;IAE9B;;;;;;;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;QAEH,IAAI,CAAC,YAAY,GAAG,WAAW,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,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,YAAY,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,IAAI,CAAC,YAAY,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"]}
@@ -2,7 +2,7 @@
2
2
  * This file is auto generated.
3
3
  * Do not edit manually.
4
4
  */
5
- import type { AnalyticsDataRegulationService } from "./AnalyticsDataRegulationService.cjs";
5
+ import type { AnalyticsDataRegulationService } from './AnalyticsDataRegulationService.js';
6
6
  /**
7
7
  * Creates a DELETE_ONLY regulation for the given analyticsId.
8
8
  *
@@ -29,4 +29,4 @@ export type AnalyticsDataRegulationServiceCheckDataDeleteStatusAction = {
29
29
  * Union of all AnalyticsDataRegulationService action types.
30
30
  */
31
31
  export type AnalyticsDataRegulationServiceMethodActions = AnalyticsDataRegulationServiceCreateDataDeletionTaskAction | AnalyticsDataRegulationServiceCheckDataDeleteStatusAction;
32
- //# sourceMappingURL=AnalyticsDataRegulationService-method-action-types.d.cts.map
32
+ //# sourceMappingURL=AnalyticsDataRegulationService-method-action-types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"AnalyticsDataRegulationService-method-action-types.d.ts","sourceRoot":"","sources":["../src/AnalyticsDataRegulationService-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,8BAA8B,EAAE,MAAM,qCAAqC,CAAC;AAE1F;;;;;;GAMG;AACH,MAAM,MAAM,0DAA0D,GAAG;IACvE,IAAI,EAAE,uDAAuD,CAAC;IAC9D,OAAO,EAAE,8BAA8B,CAAC,wBAAwB,CAAC,CAAC;CACnE,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,yDAAyD,GAAG;IACtE,IAAI,EAAE,sDAAsD,CAAC;IAC7D,OAAO,EAAE,8BAA8B,CAAC,uBAAuB,CAAC,CAAC;CAClE,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,2CAA2C,GACnD,0DAA0D,GAC1D,yDAAyD,CAAC"}
@@ -3,4 +3,4 @@
3
3
  * Do not edit manually.
4
4
  */
5
5
  export {};
6
- //# sourceMappingURL=AnalyticsDataRegulationService-method-action-types.mjs.map
6
+ //# sourceMappingURL=AnalyticsDataRegulationService-method-action-types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"AnalyticsDataRegulationService-method-action-types.js","sourceRoot":"","sources":["../src/AnalyticsDataRegulationService-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated.\n * Do not edit manually.\n */\n\nimport type { AnalyticsDataRegulationService } from './AnalyticsDataRegulationService.js';\n\n/**\n * Creates a DELETE_ONLY regulation for the given analyticsId.\n *\n * @param analyticsId - The analytics ID of the user for whom to create the deletion task.\n * @returns Promise resolving to a successful deletion regulation response.\n * @throws Error if the request fails or the response is invalid.\n */\nexport type AnalyticsDataRegulationServiceCreateDataDeletionTaskAction = {\n type: `AnalyticsDataRegulationService:createDataDeletionTask`;\n handler: AnalyticsDataRegulationService['createDataDeletionTask'];\n};\n\n/**\n * Checks the status of a regulation by ID.\n *\n * @param regulationId - The regulation ID to check.\n * @returns Promise resolving to a successful regulation status response.\n * @throws Error if the request fails or the response is invalid.\n */\nexport type AnalyticsDataRegulationServiceCheckDataDeleteStatusAction = {\n type: `AnalyticsDataRegulationService:checkDataDeleteStatus`;\n handler: AnalyticsDataRegulationService['checkDataDeleteStatus'];\n};\n\n/**\n * Union of all AnalyticsDataRegulationService action types.\n */\nexport type AnalyticsDataRegulationServiceMethodActions =\n | AnalyticsDataRegulationServiceCreateDataDeletionTaskAction\n | AnalyticsDataRegulationServiceCheckDataDeleteStatusAction;\n"]}
@@ -1,9 +1,9 @@
1
- import type { CreateServicePolicyOptions, ServicePolicy } from "@metamask/controller-utils";
2
- import type { Messenger } from "@metamask/messenger";
3
- import type { IDisposable } from "cockatiel";
4
- import type { AnalyticsDataRegulationServiceMethodActions } from "./AnalyticsDataRegulationService-method-action-types.mjs";
5
- import { DATA_DELETE_RESPONSE_STATUSES } from "./types.mjs";
6
- import type { DataDeleteStatus } from "./types.mjs";
1
+ import type { CreateServicePolicyOptions, ServicePolicy } from '@metamask/controller-utils';
2
+ import type { Messenger } from '@metamask/messenger';
3
+ import type { IDisposable } from 'cockatiel';
4
+ import type { AnalyticsDataRegulationServiceMethodActions } from './AnalyticsDataRegulationService-method-action-types.js';
5
+ import { DATA_DELETE_RESPONSE_STATUSES } from './types.js';
6
+ import type { DataDeleteStatus } from './types.js';
7
7
  /**
8
8
  * The name of the {@link AnalyticsDataRegulationService}, used to namespace the
9
9
  * service's actions and events.
@@ -169,4 +169,4 @@ export declare class AnalyticsDataRegulationService {
169
169
  }>;
170
170
  }
171
171
  export {};
172
- //# sourceMappingURL=AnalyticsDataRegulationService.d.mts.map
172
+ //# sourceMappingURL=AnalyticsDataRegulationService.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"AnalyticsDataRegulationService.d.ts","sourceRoot":"","sources":["../src/AnalyticsDataRegulationService.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,0BAA0B,EAC1B,aAAa,EACd,MAAM,4BAA4B,CAAC;AAEpC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAE7C,OAAO,KAAK,EAAE,2CAA2C,EAAE,MAAM,yDAAyD,CAAC;AAC3H,OAAO,EACL,6BAA6B,EAE9B,MAAM,YAAY,CAAC;AACpB,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAmBnD;;;GAGG;AACH,eAAO,MAAM,WAAW,mCAAmC,CAAC;AAS5D;;GAEG;AACH,MAAM,MAAM,qCAAqC,GAC/C,2CAA2C,CAAC;AAE9C;;GAEG;AACH,KAAK,cAAc,GAAG,KAAK,CAAC;AAE5B;;GAEG;AACH,MAAM,MAAM,oCAAoC,GAAG,KAAK,CAAC;AAEzD;;GAEG;AACH,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,uCAAuC,GAAG,SAAS,CAC7D,OAAO,WAAW,EAClB,qCAAqC,GAAG,cAAc,EACtD,oCAAoC,GAAG,aAAa,CACrD,CAAC;AA4BF;;GAEG;AACH,MAAM,MAAM,qCAAqC,GAAG;IAClD;;OAEG;IACH,SAAS,EAAE,uCAAuC,CAAC;IAEnD;;OAEG;IACH,KAAK,EAAE,OAAO,KAAK,CAAC;IAEpB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;;;OAMG;IACH,0BAA0B,EAAE,MAAM,CAAC;IAEnC;;OAEG;IACH,aAAa,CAAC,EAAE,0BAA0B,CAAC;CAC5C,CAAC;AAaF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,qBAAa,8BAA8B;;IACzC;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,OAAO,WAAW,CAAC;IA8BlC;;;;OAIG;IACH,YAAY,OAAO,EAAE,qCAAqC,EAYzD;IAED;;;;;;;;OAQG;IACH,OAAO,CAAC,QAAQ,EAAE,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW,CAEtE;IAED;;;;;;;OAOG;IACH,OAAO,CAAC,QAAQ,EAAE,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW,CAEtE;IAED;;;;;;;;;;OAUG;IACH,UAAU,CACR,QAAQ,EAAE,UAAU,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,GACnD,WAAW,CAEb;IAED;;;;;;OAMG;IACG,sBAAsB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC;QACzD,MAAM,EAAE,OAAO,6BAA6B,CAAC,OAAO,CAAC;QACrD,UAAU,EAAE,MAAM,CAAC;KACpB,CAAC,CA+CD;IAED;;;;;;OAMG;IACG,qBAAqB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC;QACzD,MAAM,EAAE,OAAO,6BAA6B,CAAC,OAAO,CAAC;QACrD,gBAAgB,EAAE,gBAAgB,CAAC;KACpC,CAAC,CAoCD;CACF"}
@@ -1,17 +1,5 @@
1
- var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
2
- if (kind === "m") throw new TypeError("Private method is not writable");
3
- if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
4
- 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");
5
- return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
6
- };
7
- var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
8
- if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
9
- 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");
10
- return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
11
- };
12
- var _AnalyticsDataRegulationService_messenger, _AnalyticsDataRegulationService_fetch, _AnalyticsDataRegulationService_segmentSourceId, _AnalyticsDataRegulationService_segmentRegulationsEndpoint, _AnalyticsDataRegulationService_policy;
13
- import { createServicePolicy, HttpError } from "@metamask/controller-utils";
14
- import { DATA_DELETE_RESPONSE_STATUSES, DATA_DELETE_STATUSES } from "./types.mjs";
1
+ import { createServicePolicy, HttpError } from '@metamask/controller-utils';
2
+ import { DATA_DELETE_RESPONSE_STATUSES, DATA_DELETE_STATUSES, } from './types.js';
15
3
  /**
16
4
  * Segment API regulation type for DELETE_ONLY operations.
17
5
  */
@@ -89,42 +77,46 @@ function isDataDeleteStatus(status) {
89
77
  * ```
90
78
  */
91
79
  export class AnalyticsDataRegulationService {
80
+ /**
81
+ * The name of the service.
82
+ */
83
+ name;
84
+ /**
85
+ * The messenger suited for this service.
86
+ */
87
+ #messenger;
88
+ /**
89
+ * A function that can be used to make an HTTP request.
90
+ */
91
+ #fetch;
92
+ /**
93
+ * Segment API source ID.
94
+ */
95
+ #segmentSourceId;
96
+ /**
97
+ * Base URL for the proxy endpoint that communicates with Segment's Regulations API.
98
+ * This endpoint varies by environment and forwards requests to Segment API with authentication.
99
+ */
100
+ #segmentRegulationsEndpoint;
101
+ /**
102
+ * The policy that wraps the request.
103
+ *
104
+ * @see {@link createServicePolicy}
105
+ */
106
+ #policy;
92
107
  /**
93
108
  * Constructs a new AnalyticsDataRegulationService object.
94
109
  *
95
110
  * @param options - The constructor options.
96
111
  */
97
112
  constructor(options) {
98
- /**
99
- * The messenger suited for this service.
100
- */
101
- _AnalyticsDataRegulationService_messenger.set(this, void 0);
102
- /**
103
- * A function that can be used to make an HTTP request.
104
- */
105
- _AnalyticsDataRegulationService_fetch.set(this, void 0);
106
- /**
107
- * Segment API source ID.
108
- */
109
- _AnalyticsDataRegulationService_segmentSourceId.set(this, void 0);
110
- /**
111
- * Base URL for the proxy endpoint that communicates with Segment's Regulations API.
112
- * This endpoint varies by environment and forwards requests to Segment API with authentication.
113
- */
114
- _AnalyticsDataRegulationService_segmentRegulationsEndpoint.set(this, void 0);
115
- /**
116
- * The policy that wraps the request.
117
- *
118
- * @see {@link createServicePolicy}
119
- */
120
- _AnalyticsDataRegulationService_policy.set(this, void 0);
121
113
  this.name = serviceName;
122
- __classPrivateFieldSet(this, _AnalyticsDataRegulationService_messenger, options.messenger, "f");
123
- __classPrivateFieldSet(this, _AnalyticsDataRegulationService_fetch, options.fetch, "f");
124
- __classPrivateFieldSet(this, _AnalyticsDataRegulationService_segmentSourceId, options.segmentSourceId, "f");
125
- __classPrivateFieldSet(this, _AnalyticsDataRegulationService_segmentRegulationsEndpoint, options.segmentRegulationsEndpoint, "f");
126
- __classPrivateFieldSet(this, _AnalyticsDataRegulationService_policy, createServicePolicy(options.policyOptions ?? {}), "f");
127
- __classPrivateFieldGet(this, _AnalyticsDataRegulationService_messenger, "f").registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
114
+ this.#messenger = options.messenger;
115
+ this.#fetch = options.fetch;
116
+ this.#segmentSourceId = options.segmentSourceId;
117
+ this.#segmentRegulationsEndpoint = options.segmentRegulationsEndpoint;
118
+ this.#policy = createServicePolicy(options.policyOptions ?? {});
119
+ this.#messenger.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
128
120
  }
129
121
  /**
130
122
  * Registers a handler that will be called after a request returns a non-500
@@ -136,7 +128,7 @@ export class AnalyticsDataRegulationService {
136
128
  * @see {@link createServicePolicy}
137
129
  */
138
130
  onRetry(listener) {
139
- return __classPrivateFieldGet(this, _AnalyticsDataRegulationService_policy, "f").onRetry(listener);
131
+ return this.#policy.onRetry(listener);
140
132
  }
141
133
  /**
142
134
  * Registers a handler that will be called after a set number of retry rounds
@@ -147,7 +139,7 @@ export class AnalyticsDataRegulationService {
147
139
  * @see {@link createServicePolicy}
148
140
  */
149
141
  onBreak(listener) {
150
- return __classPrivateFieldGet(this, _AnalyticsDataRegulationService_policy, "f").onBreak(listener);
142
+ return this.#policy.onBreak(listener);
151
143
  }
152
144
  /**
153
145
  * Registers a handler that will be called under one of two circumstances:
@@ -161,7 +153,7 @@ export class AnalyticsDataRegulationService {
161
153
  * @returns An object that can be used to unregister the handler.
162
154
  */
163
155
  onDegraded(listener) {
164
- return __classPrivateFieldGet(this, _AnalyticsDataRegulationService_policy, "f").onDegraded(listener);
156
+ return this.#policy.onDegraded(listener);
165
157
  }
166
158
  /**
167
159
  * Creates a DELETE_ONLY regulation for the given analyticsId.
@@ -171,17 +163,17 @@ export class AnalyticsDataRegulationService {
171
163
  * @throws Error if the request fails or the response is invalid.
172
164
  */
173
165
  async createDataDeletionTask(analyticsId) {
174
- if (!__classPrivateFieldGet(this, _AnalyticsDataRegulationService_segmentSourceId, "f") || !__classPrivateFieldGet(this, _AnalyticsDataRegulationService_segmentRegulationsEndpoint, "f")) {
166
+ if (!this.#segmentSourceId || !this.#segmentRegulationsEndpoint) {
175
167
  throw new Error('Segment API source ID or endpoint not found');
176
168
  }
177
- const url = `${__classPrivateFieldGet(this, _AnalyticsDataRegulationService_segmentRegulationsEndpoint, "f")}/regulations/sources/${__classPrivateFieldGet(this, _AnalyticsDataRegulationService_segmentSourceId, "f")}`;
169
+ const url = `${this.#segmentRegulationsEndpoint}/regulations/sources/${this.#segmentSourceId}`;
178
170
  const body = JSON.stringify({
179
171
  regulationType: SEGMENT_REGULATION_TYPE_DELETE_ONLY,
180
172
  subjectType: SEGMENT_SUBJECT_TYPE_USER_ID,
181
173
  subjectIds: [analyticsId],
182
174
  });
183
- const response = await __classPrivateFieldGet(this, _AnalyticsDataRegulationService_policy, "f").execute(async () => {
184
- const localResponse = await __classPrivateFieldGet(this, _AnalyticsDataRegulationService_fetch, "f").call(this, url, {
175
+ const response = await this.#policy.execute(async () => {
176
+ const localResponse = await this.#fetch(url, {
185
177
  method: 'POST',
186
178
  headers: {
187
179
  'Content-Type': SEGMENT_CONTENT_TYPE,
@@ -212,12 +204,12 @@ export class AnalyticsDataRegulationService {
212
204
  * @throws Error if the request fails or the response is invalid.
213
205
  */
214
206
  async checkDataDeleteStatus(regulationId) {
215
- if (!regulationId || !__classPrivateFieldGet(this, _AnalyticsDataRegulationService_segmentRegulationsEndpoint, "f")) {
207
+ if (!regulationId || !this.#segmentRegulationsEndpoint) {
216
208
  throw new Error('Regulation ID or endpoint not configured');
217
209
  }
218
- const url = `${__classPrivateFieldGet(this, _AnalyticsDataRegulationService_segmentRegulationsEndpoint, "f")}/regulations/${regulationId}`;
219
- const response = await __classPrivateFieldGet(this, _AnalyticsDataRegulationService_policy, "f").execute(async () => {
220
- const localResponse = await __classPrivateFieldGet(this, _AnalyticsDataRegulationService_fetch, "f").call(this, url, {
210
+ const url = `${this.#segmentRegulationsEndpoint}/regulations/${regulationId}`;
211
+ const response = await this.#policy.execute(async () => {
212
+ const localResponse = await this.#fetch(url, {
221
213
  method: 'GET',
222
214
  headers: {
223
215
  'Content-Type': SEGMENT_CONTENT_TYPE,
@@ -239,5 +231,4 @@ export class AnalyticsDataRegulationService {
239
231
  };
240
232
  }
241
233
  }
242
- _AnalyticsDataRegulationService_messenger = new WeakMap(), _AnalyticsDataRegulationService_fetch = new WeakMap(), _AnalyticsDataRegulationService_segmentSourceId = new WeakMap(), _AnalyticsDataRegulationService_segmentRegulationsEndpoint = new WeakMap(), _AnalyticsDataRegulationService_policy = new WeakMap();
243
- //# sourceMappingURL=AnalyticsDataRegulationService.mjs.map
234
+ //# sourceMappingURL=AnalyticsDataRegulationService.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"AnalyticsDataRegulationService.js","sourceRoot":"","sources":["../src/AnalyticsDataRegulationService.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,mBAAmB,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAK5E,OAAO,EACL,6BAA6B,EAC7B,oBAAoB,GACrB,MAAM,YAAY,CAAC;AAGpB;;GAEG;AACH,MAAM,mCAAmC,GAAG,aAAa,CAAC;AAE1D;;GAEG;AACH,MAAM,4BAA4B,GAAG,SAAS,CAAC;AAE/C;;GAEG;AACH,MAAM,oBAAoB,GAAG,iCAAiC,CAAC;AAE/D,kBAAkB;AAElB;;;GAGG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,gCAAgC,CAAC;AAE5D,oBAAoB;AAEpB,MAAM,yBAAyB,GAAG;IAChC,wBAAwB;IACxB,uBAAuB;CACf,CAAC;AA6FX;;;;;GAKG;AACH,SAAS,kBAAkB,CAAC,MAAe;IACzC,MAAM,kBAAkB,GAAa,MAAM,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC;IACzE,OAAO,kBAAkB,CAAC,QAAQ,CAAC,MAAgB,CAAC,CAAC;AACvD,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,MAAM,OAAO,8BAA8B;IACzC;;OAEG;IACM,IAAI,CAAqB;IAElC;;OAEG;IACM,UAAU,CAA0C;IAE7D;;OAEG;IACM,MAAM,CAAe;IAE9B;;OAEG;IACM,gBAAgB,CAAS;IAElC;;;OAGG;IACM,2BAA2B,CAAS;IAE7C;;;;OAIG;IACM,OAAO,CAAgB;IAEhC;;;;OAIG;IACH,YAAY,OAA8C;QACxD,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC;QACxB,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC;QACpC,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;QAC5B,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,eAAe,CAAC;QAChD,IAAI,CAAC,2BAA2B,GAAG,OAAO,CAAC,0BAA0B,CAAC;QACtE,IAAI,CAAC,OAAO,GAAG,mBAAmB,CAAC,OAAO,CAAC,aAAa,IAAI,EAAE,CAAC,CAAC;QAEhE,IAAI,CAAC,UAAU,CAAC,4BAA4B,CAC1C,IAAI,EACJ,yBAAyB,CAC1B,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,OAAO,CAAC,QAAiD;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;OAOG;IACH,OAAO,CAAC,QAAiD;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;;;;OAUG;IACH,UAAU,CACR,QAAoD;QAEpD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,sBAAsB,CAAC,WAAmB;QAI9C,IAAI,CAAC,IAAI,CAAC,gBAAgB,IAAI,CAAC,IAAI,CAAC,2BAA2B,EAAE,CAAC;YAChE,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;QACjE,CAAC;QAED,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,2BAA2B,wBAAwB,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAC/F,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC;YAC1B,cAAc,EAAE,mCAAmC;YACnD,WAAW,EAAE,4BAA4B;YACzC,UAAU,EAAE,CAAC,WAAW,CAAC;SAC1B,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE;YACrD,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE;gBAC3C,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE;oBACP,cAAc,EAAE,oBAAoB;iBACrC;gBACD,IAAI;aACL,CAAC,CAAC;YAEH,IAAI,CAAC,aAAa,CAAC,EAAE,EAAE,CAAC;gBACtB,MAAM,IAAI,SAAS,CACjB,aAAa,CAAC,MAAM,EACpB,mDAAmD,aAAa,CAAC,MAAM,GAAG,CAC3E,CAAC;YACJ,CAAC;YAED,OAAO,aAAa,CAAC;QACvB,CAAC,CAAC,CAAC;QAEH,MAAM,YAAY,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAA6B,CAAC;QAEzE,IACE,CAAC,YAAY,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU;YACrC,OAAO,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,KAAK,QAAQ;YACrD,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,KAAK,EAAE,EAC/C,CAAC;YACD,MAAM,IAAI,KAAK,CACb,oEAAoE,CACrE,CAAC;QACJ,CAAC;QAED,OAAO;YACL,MAAM,EAAE,6BAA6B,CAAC,OAAO;YAC7C,UAAU,EAAE,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU;SAC9C,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,qBAAqB,CAAC,YAAoB;QAI9C,IAAI,CAAC,YAAY,IAAI,CAAC,IAAI,CAAC,2BAA2B,EAAE,CAAC;YACvD,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;QAC9D,CAAC;QAED,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,2BAA2B,gBAAgB,YAAY,EAAE,CAAC;QAE9E,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE;YACrD,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE;gBAC3C,MAAM,EAAE,KAAK;gBACb,OAAO,EAAE;oBACP,cAAc,EAAE,oBAAoB;iBACrC;aACF,CAAC,CAAC;YAEH,IAAI,CAAC,aAAa,CAAC,EAAE,EAAE,CAAC;gBACtB,MAAM,IAAI,SAAS,CACjB,aAAa,CAAC,MAAM,EACpB,qDAAqD,aAAa,CAAC,MAAM,GAAG,CAC7E,CAAC;YACJ,CAAC;YAED,OAAO,aAAa,CAAC;QACvB,CAAC,CAAC,CAAC;QAEH,MAAM,YAAY,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAgC,CAAC;QAE5E,MAAM,SAAS,GAAG,YAAY,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,aAAa,CAAC;QACtE,MAAM,gBAAgB,GAAG,kBAAkB,CAAC,SAAS,CAAC;YACpD,CAAC,CAAC,SAAS;YACX,CAAC,CAAC,oBAAoB,CAAC,OAAO,CAAC;QAEjC,OAAO;YACL,MAAM,EAAE,6BAA6B,CAAC,OAAO;YAC7C,gBAAgB;SACjB,CAAC;IACJ,CAAC;CACF","sourcesContent":["import type {\n CreateServicePolicyOptions,\n ServicePolicy,\n} from '@metamask/controller-utils';\nimport { createServicePolicy, HttpError } from '@metamask/controller-utils';\nimport type { Messenger } from '@metamask/messenger';\nimport type { IDisposable } from 'cockatiel';\n\nimport type { AnalyticsDataRegulationServiceMethodActions } from './AnalyticsDataRegulationService-method-action-types.js';\nimport {\n DATA_DELETE_RESPONSE_STATUSES,\n DATA_DELETE_STATUSES,\n} from './types.js';\nimport type { DataDeleteStatus } from './types.js';\n\n/**\n * Segment API regulation type for DELETE_ONLY operations.\n */\nconst SEGMENT_REGULATION_TYPE_DELETE_ONLY = 'DELETE_ONLY';\n\n/**\n * Segment API subject type for user ID operations.\n */\nconst SEGMENT_SUBJECT_TYPE_USER_ID = 'USER_ID';\n\n/**\n * Segment API Content-Type header value.\n */\nconst SEGMENT_CONTENT_TYPE = 'application/vnd.segment.v1+json';\n\n// === GENERAL ===\n\n/**\n * The name of the {@link AnalyticsDataRegulationService}, used to namespace the\n * service's actions and events.\n */\nexport const serviceName = 'AnalyticsDataRegulationService';\n\n// === MESSENGER ===\n\nconst MESSENGER_EXPOSED_METHODS = [\n 'createDataDeletionTask',\n 'checkDataDeleteStatus',\n] as const;\n\n/**\n * Actions that {@link AnalyticsDataRegulationService} exposes to other consumers.\n */\nexport type AnalyticsDataRegulationServiceActions =\n AnalyticsDataRegulationServiceMethodActions;\n\n/**\n * Actions from other messengers that {@link AnalyticsDataRegulationServiceMessenger} calls.\n */\ntype AllowedActions = never;\n\n/**\n * Events that {@link AnalyticsDataRegulationService} exposes to other consumers.\n */\nexport type AnalyticsDataRegulationServiceEvents = never;\n\n/**\n * Events from other messengers that {@link AnalyticsDataRegulationService} subscribes to.\n */\ntype AllowedEvents = never;\n\n/**\n * The messenger which is restricted to actions and events accessed by\n * {@link AnalyticsDataRegulationService}.\n */\nexport type AnalyticsDataRegulationServiceMessenger = Messenger<\n typeof serviceName,\n AnalyticsDataRegulationServiceActions | AllowedActions,\n AnalyticsDataRegulationServiceEvents | AllowedEvents\n>;\n\n// === SERVICE DEFINITION ===\n\n/**\n * Response structure from Segment API for creating a regulation.\n */\ntype CreateRegulationResponse = {\n data: {\n data: {\n regulateId: string;\n };\n };\n};\n\n/**\n * Response structure from Segment API for getting regulation status.\n */\ntype GetRegulationStatusResponse = {\n data: {\n data: {\n regulation: {\n overallStatus: string;\n };\n };\n };\n};\n\n/**\n * Options for constructing {@link AnalyticsDataRegulationService}.\n */\nexport type AnalyticsDataRegulationServiceOptions = {\n /**\n * The messenger suited for this service.\n */\n messenger: AnalyticsDataRegulationServiceMessenger;\n\n /**\n * A function that can be used to make an HTTP request.\n */\n fetch: typeof fetch;\n\n /**\n * Segment API source ID (required for creating regulations).\n */\n segmentSourceId: string;\n\n /**\n * Base URL for the proxy endpoint that communicates with Segment's Regulations API.\n * This is a proxy endpoint (not Segment API directly) that forwards requests to Segment's\n * Regulations API and adds authentication tokens. The endpoint URL varies by environment\n * (e.g., development, staging, production) and should be configured accordingly.\n * Example: 'https://proxy.example.com/v1beta'\n */\n segmentRegulationsEndpoint: string;\n\n /**\n * Options to pass to `createServicePolicy`, which is used to wrap each request.\n */\n policyOptions?: CreateServicePolicyOptions;\n};\n\n/**\n * Type guard to check if a value is a valid DataDeleteStatus.\n *\n * @param status - The value to check.\n * @returns True if the value is a valid DataDeleteStatus.\n */\nfunction isDataDeleteStatus(status: unknown): status is DataDeleteStatus {\n const dataDeleteStatuses: string[] = Object.values(DATA_DELETE_STATUSES);\n return dataDeleteStatuses.includes(status as string);\n}\n\n/**\n * This service object is responsible for making requests to the Segment Regulations API\n * via a proxy endpoint for GDPR/CCPA data deletion functionality.\n *\n * @example\n *\n * ```ts\n * import { Messenger } from '@metamask/messenger';\n * import type {\n * AnalyticsDataRegulationServiceActions,\n * AnalyticsDataRegulationServiceEvents,\n * } from '@metamask/analytics-data-regulation-controller';\n *\n * const rootMessenger = new Messenger<\n * 'Root',\n * AnalyticsDataRegulationServiceActions,\n * AnalyticsDataRegulationServiceEvents\n * >({ namespace: 'Root' });\n * const serviceMessenger = new Messenger<\n * 'AnalyticsDataRegulationService',\n * AnalyticsDataRegulationServiceActions,\n * AnalyticsDataRegulationServiceEvents,\n * typeof rootMessenger,\n * >({\n * namespace: 'AnalyticsDataRegulationService',\n * parent: rootMessenger,\n * });\n * // Instantiate the service to register its actions on the messenger\n * new AnalyticsDataRegulationService({\n * messenger: serviceMessenger,\n * fetch,\n * segmentSourceId: 'abc123',\n * segmentRegulationsEndpoint: 'https://proxy.example.com/v1beta',\n * });\n *\n * // Later...\n * // Create a data deletion task\n * const response = await rootMessenger.call(\n * 'AnalyticsDataRegulationService:createDataDeletionTask',\n * 'user-analytics-id',\n * );\n * ```\n */\nexport class AnalyticsDataRegulationService {\n /**\n * The name of the service.\n */\n readonly name: typeof serviceName;\n\n /**\n * The messenger suited for this service.\n */\n readonly #messenger: AnalyticsDataRegulationServiceMessenger;\n\n /**\n * A function that can be used to make an HTTP request.\n */\n readonly #fetch: typeof fetch;\n\n /**\n * Segment API source ID.\n */\n readonly #segmentSourceId: string;\n\n /**\n * Base URL for the proxy endpoint that communicates with Segment's Regulations API.\n * This endpoint varies by environment and forwards requests to Segment API with authentication.\n */\n readonly #segmentRegulationsEndpoint: string;\n\n /**\n * The policy that wraps the request.\n *\n * @see {@link createServicePolicy}\n */\n readonly #policy: ServicePolicy;\n\n /**\n * Constructs a new AnalyticsDataRegulationService object.\n *\n * @param options - The constructor options.\n */\n constructor(options: AnalyticsDataRegulationServiceOptions) {\n this.name = serviceName;\n this.#messenger = options.messenger;\n this.#fetch = options.fetch;\n this.#segmentSourceId = options.segmentSourceId;\n this.#segmentRegulationsEndpoint = options.segmentRegulationsEndpoint;\n this.#policy = createServicePolicy(options.policyOptions ?? {});\n\n this.#messenger.registerMethodActionHandlers(\n this,\n MESSENGER_EXPOSED_METHODS,\n );\n }\n\n /**\n * Registers a handler that will be called after a request returns a non-500\n * response, causing a retry. Primarily useful in tests where timers are being\n * mocked.\n *\n * @param listener - The handler to be called.\n * @returns An object that can be used to unregister the handler.\n * @see {@link createServicePolicy}\n */\n onRetry(listener: Parameters<ServicePolicy['onRetry']>[0]): IDisposable {\n return this.#policy.onRetry(listener);\n }\n\n /**\n * Registers a handler that will be called after a set number of retry rounds\n * prove that requests to the API endpoint consistently return a 5xx response.\n *\n * @param listener - The handler to be called.\n * @returns An object that can be used to unregister the handler.\n * @see {@link createServicePolicy}\n */\n onBreak(listener: Parameters<ServicePolicy['onBreak']>[0]): IDisposable {\n return this.#policy.onBreak(listener);\n }\n\n /**\n * Registers a handler that will be called under one of two circumstances:\n *\n * 1. After a set number of retries prove that requests to the API\n * consistently result in failures.\n * 2. After a successful request is made to the API, but the response takes\n * longer than a set duration to return.\n *\n * @param listener - The handler to be called.\n * @returns An object that can be used to unregister the handler.\n */\n onDegraded(\n listener: Parameters<ServicePolicy['onDegraded']>[0],\n ): IDisposable {\n return this.#policy.onDegraded(listener);\n }\n\n /**\n * Creates a DELETE_ONLY regulation for the given analyticsId.\n *\n * @param analyticsId - The analytics ID of the user for whom to create the deletion task.\n * @returns Promise resolving to a successful deletion regulation response.\n * @throws Error if the request fails or the response is invalid.\n */\n async createDataDeletionTask(analyticsId: string): Promise<{\n status: typeof DATA_DELETE_RESPONSE_STATUSES.Success;\n regulateId: string;\n }> {\n if (!this.#segmentSourceId || !this.#segmentRegulationsEndpoint) {\n throw new Error('Segment API source ID or endpoint not found');\n }\n\n const url = `${this.#segmentRegulationsEndpoint}/regulations/sources/${this.#segmentSourceId}`;\n const body = JSON.stringify({\n regulationType: SEGMENT_REGULATION_TYPE_DELETE_ONLY,\n subjectType: SEGMENT_SUBJECT_TYPE_USER_ID,\n subjectIds: [analyticsId],\n });\n\n const response = await this.#policy.execute(async () => {\n const localResponse = await this.#fetch(url, {\n method: 'POST',\n headers: {\n 'Content-Type': SEGMENT_CONTENT_TYPE,\n },\n body,\n });\n\n if (!localResponse.ok) {\n throw new HttpError(\n localResponse.status,\n `Creating data deletion task failed with status '${localResponse.status}'`,\n );\n }\n\n return localResponse;\n });\n\n const jsonResponse = (await response.json()) as CreateRegulationResponse;\n\n if (\n !jsonResponse?.data?.data?.regulateId ||\n typeof jsonResponse.data.data.regulateId !== 'string' ||\n jsonResponse.data.data.regulateId.trim() === ''\n ) {\n throw new Error(\n 'Malformed response from Segment API: missing or invalid regulateId',\n );\n }\n\n return {\n status: DATA_DELETE_RESPONSE_STATUSES.Success,\n regulateId: jsonResponse.data.data.regulateId,\n };\n }\n\n /**\n * Checks the status of a regulation by ID.\n *\n * @param regulationId - The regulation ID to check.\n * @returns Promise resolving to a successful regulation status response.\n * @throws Error if the request fails or the response is invalid.\n */\n async checkDataDeleteStatus(regulationId: string): Promise<{\n status: typeof DATA_DELETE_RESPONSE_STATUSES.Success;\n dataDeleteStatus: DataDeleteStatus;\n }> {\n if (!regulationId || !this.#segmentRegulationsEndpoint) {\n throw new Error('Regulation ID or endpoint not configured');\n }\n\n const url = `${this.#segmentRegulationsEndpoint}/regulations/${regulationId}`;\n\n const response = await this.#policy.execute(async () => {\n const localResponse = await this.#fetch(url, {\n method: 'GET',\n headers: {\n 'Content-Type': SEGMENT_CONTENT_TYPE,\n },\n });\n\n if (!localResponse.ok) {\n throw new HttpError(\n localResponse.status,\n `Checking data deletion status failed with status '${localResponse.status}'`,\n );\n }\n\n return localResponse;\n });\n\n const jsonResponse = (await response.json()) as GetRegulationStatusResponse;\n\n const rawStatus = jsonResponse?.data?.data?.regulation?.overallStatus;\n const dataDeleteStatus = isDataDeleteStatus(rawStatus)\n ? rawStatus\n : DATA_DELETE_STATUSES.Unknown;\n\n return {\n status: DATA_DELETE_RESPONSE_STATUSES.Success,\n dataDeleteStatus,\n };\n }\n}\n"]}
@@ -0,0 +1,11 @@
1
+ export { AnalyticsDataRegulationController, getDefaultAnalyticsDataRegulationControllerState, } from './AnalyticsDataRegulationController.js';
2
+ export type { AnalyticsDataRegulationControllerOptions } from './AnalyticsDataRegulationController.js';
3
+ export { AnalyticsDataRegulationService } from './AnalyticsDataRegulationService.js';
4
+ export type { AnalyticsDataRegulationServiceActions, AnalyticsDataRegulationServiceEvents, AnalyticsDataRegulationServiceMessenger, AnalyticsDataRegulationServiceOptions, } from './AnalyticsDataRegulationService.js';
5
+ export { DATA_DELETE_STATUSES, DATA_DELETE_RESPONSE_STATUSES, type DataDeleteStatus, type DataDeleteResponseStatus, } from './types.js';
6
+ export type { DeleteRegulationResponse, DeleteRegulationStatus, } from './types.js';
7
+ export type { AnalyticsDataRegulationControllerState } from './AnalyticsDataRegulationController.js';
8
+ export { analyticsDataRegulationControllerSelectors } from './selectors.js';
9
+ export type { AnalyticsDataRegulationControllerMessenger } from './AnalyticsDataRegulationController.js';
10
+ export type { AnalyticsDataRegulationControllerActions, AnalyticsDataRegulationControllerEvents, AnalyticsDataRegulationControllerGetStateAction, AnalyticsDataRegulationControllerStateChangeEvent, DataDeletionTaskCreatedEvent, DataRecordingFlagUpdatedEvent, } from './AnalyticsDataRegulationController.js';
11
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iCAAiC,EACjC,gDAAgD,GACjD,MAAM,wCAAwC,CAAC;AAChD,YAAY,EAAE,wCAAwC,EAAE,MAAM,wCAAwC,CAAC;AAEvG,OAAO,EAAE,8BAA8B,EAAE,MAAM,qCAAqC,CAAC;AACrF,YAAY,EACV,qCAAqC,EACrC,oCAAoC,EACpC,uCAAuC,EACvC,qCAAqC,GACtC,MAAM,qCAAqC,CAAC;AAE7C,OAAO,EACL,oBAAoB,EACpB,6BAA6B,EAC7B,KAAK,gBAAgB,EACrB,KAAK,wBAAwB,GAC9B,MAAM,YAAY,CAAC;AACpB,YAAY,EACV,wBAAwB,EACxB,sBAAsB,GACvB,MAAM,YAAY,CAAC;AAEpB,YAAY,EAAE,sCAAsC,EAAE,MAAM,wCAAwC,CAAC;AAErG,OAAO,EAAE,0CAA0C,EAAE,MAAM,gBAAgB,CAAC;AAE5E,YAAY,EAAE,0CAA0C,EAAE,MAAM,wCAAwC,CAAC;AAEzG,YAAY,EACV,wCAAwC,EACxC,uCAAuC,EACvC,+CAA+C,EAC/C,iDAAiD,EACjD,4BAA4B,EAC5B,6BAA6B,GAC9B,MAAM,wCAAwC,CAAC"}
package/dist/index.js ADDED
@@ -0,0 +1,5 @@
1
+ export { AnalyticsDataRegulationController, getDefaultAnalyticsDataRegulationControllerState, } from './AnalyticsDataRegulationController.js';
2
+ export { AnalyticsDataRegulationService } from './AnalyticsDataRegulationService.js';
3
+ export { DATA_DELETE_STATUSES, DATA_DELETE_RESPONSE_STATUSES, } from './types.js';
4
+ export { analyticsDataRegulationControllerSelectors } from './selectors.js';
5
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iCAAiC,EACjC,gDAAgD,GACjD,MAAM,wCAAwC,CAAC;AAGhD,OAAO,EAAE,8BAA8B,EAAE,MAAM,qCAAqC,CAAC;AAQrF,OAAO,EACL,oBAAoB,EACpB,6BAA6B,GAG9B,MAAM,YAAY,CAAC;AAQpB,OAAO,EAAE,0CAA0C,EAAE,MAAM,gBAAgB,CAAC","sourcesContent":["export {\n AnalyticsDataRegulationController,\n getDefaultAnalyticsDataRegulationControllerState,\n} from './AnalyticsDataRegulationController.js';\nexport type { AnalyticsDataRegulationControllerOptions } from './AnalyticsDataRegulationController.js';\n\nexport { AnalyticsDataRegulationService } from './AnalyticsDataRegulationService.js';\nexport type {\n AnalyticsDataRegulationServiceActions,\n AnalyticsDataRegulationServiceEvents,\n AnalyticsDataRegulationServiceMessenger,\n AnalyticsDataRegulationServiceOptions,\n} from './AnalyticsDataRegulationService.js';\n\nexport {\n DATA_DELETE_STATUSES,\n DATA_DELETE_RESPONSE_STATUSES,\n type DataDeleteStatus,\n type DataDeleteResponseStatus,\n} from './types.js';\nexport type {\n DeleteRegulationResponse,\n DeleteRegulationStatus,\n} from './types.js';\n\nexport type { AnalyticsDataRegulationControllerState } from './AnalyticsDataRegulationController.js';\n\nexport { analyticsDataRegulationControllerSelectors } from './selectors.js';\n\nexport type { AnalyticsDataRegulationControllerMessenger } from './AnalyticsDataRegulationController.js';\n\nexport type {\n AnalyticsDataRegulationControllerActions,\n AnalyticsDataRegulationControllerEvents,\n AnalyticsDataRegulationControllerGetStateAction,\n AnalyticsDataRegulationControllerStateChangeEvent,\n DataDeletionTaskCreatedEvent,\n DataRecordingFlagUpdatedEvent,\n} from './AnalyticsDataRegulationController.js';\n"]}
@@ -0,0 +1,2 @@
1
+ export declare const projectLogger: import("debug").Debugger;
2
+ //# sourceMappingURL=logger.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,aAAa,0BAEzB,CAAC"}
@@ -1,4 +1,4 @@
1
1
  /* istanbul ignore file */
2
- import { createProjectLogger } from "@metamask/utils";
2
+ import { createProjectLogger } from '@metamask/utils';
3
3
  export const projectLogger = createProjectLogger('analytics-data-regulation-controller');
4
- //# sourceMappingURL=logger.mjs.map
4
+ //# sourceMappingURL=logger.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"logger.js","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":"AAAA,0BAA0B;AAE1B,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAEtD,MAAM,CAAC,MAAM,aAAa,GAAG,mBAAmB,CAC9C,sCAAsC,CACvC,CAAC","sourcesContent":["/* istanbul ignore file */\n\nimport { createProjectLogger } from '@metamask/utils';\n\nexport const projectLogger = createProjectLogger(\n 'analytics-data-regulation-controller',\n);\n"]}
@@ -0,0 +1,33 @@
1
+ import type { AnalyticsDataRegulationControllerState } from './AnalyticsDataRegulationController.js';
2
+ /**
3
+ * Selects the data recorded flag from the controller state.
4
+ *
5
+ * @param state - The controller state
6
+ * @returns Whether data has been recorded since the last deletion request
7
+ */
8
+ declare const selectHasCollectedDataSinceDeletionRequest: (state: AnalyticsDataRegulationControllerState) => boolean;
9
+ /**
10
+ * Selects the delete regulation ID from the controller state.
11
+ *
12
+ * @param state - The controller state
13
+ * @returns The regulation ID, or undefined if not set
14
+ */
15
+ declare const selectDeleteRegulationId: (state: AnalyticsDataRegulationControllerState) => string | undefined;
16
+ /**
17
+ * Selects the delete regulation creation timestamp from the controller state.
18
+ *
19
+ * @param state - The controller state
20
+ * @returns The deletion timestamp (in milliseconds since epoch), or undefined if not set
21
+ */
22
+ declare const selectDeleteRegulationTimestamp: (state: AnalyticsDataRegulationControllerState) => number | undefined;
23
+ /**
24
+ * Selectors for the AnalyticsDataRegulationController state.
25
+ * These can be used with Redux or directly with controller state.
26
+ */
27
+ export declare const analyticsDataRegulationControllerSelectors: {
28
+ selectHasCollectedDataSinceDeletionRequest: typeof selectHasCollectedDataSinceDeletionRequest;
29
+ selectDeleteRegulationId: typeof selectDeleteRegulationId;
30
+ selectDeleteRegulationTimestamp: typeof selectDeleteRegulationTimestamp;
31
+ };
32
+ export {};
33
+ //# sourceMappingURL=selectors.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"selectors.d.ts","sourceRoot":"","sources":["../src/selectors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sCAAsC,EAAE,MAAM,wCAAwC,CAAC;AAErG;;;;;GAKG;AACH,QAAA,MAAM,0CAA0C,UACvC,sCAAsC,KAC5C,OAAqD,CAAC;AAEzD;;;;;GAKG;AACH,QAAA,MAAM,wBAAwB,UACrB,sCAAsC,KAC5C,MAAM,GAAG,SAAqC,CAAC;AAElD;;;;;GAKG;AACH,QAAA,MAAM,+BAA+B,UAC5B,sCAAsC,KAC5C,MAAM,GAAG,SAA4C,CAAC;AAEzD;;;GAGG;AACH,eAAO,MAAM,0CAA0C;;;;CAItD,CAAC"}
@@ -28,4 +28,4 @@ export const analyticsDataRegulationControllerSelectors = {
28
28
  selectDeleteRegulationId,
29
29
  selectDeleteRegulationTimestamp,
30
30
  };
31
- //# sourceMappingURL=selectors.mjs.map
31
+ //# sourceMappingURL=selectors.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"selectors.js","sourceRoot":"","sources":["../src/selectors.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,MAAM,0CAA0C,GAAG,CACjD,KAA6C,EACpC,EAAE,CAAC,KAAK,CAAC,oCAAoC,CAAC;AAEzD;;;;;GAKG;AACH,MAAM,wBAAwB,GAAG,CAC/B,KAA6C,EACzB,EAAE,CAAC,KAAK,CAAC,kBAAkB,CAAC;AAElD;;;;;GAKG;AACH,MAAM,+BAA+B,GAAG,CACtC,KAA6C,EACzB,EAAE,CAAC,KAAK,CAAC,yBAAyB,CAAC;AAEzD;;;GAGG;AACH,MAAM,CAAC,MAAM,0CAA0C,GAAG;IACxD,0CAA0C;IAC1C,wBAAwB;IACxB,+BAA+B;CAChC,CAAC","sourcesContent":["import type { AnalyticsDataRegulationControllerState } from './AnalyticsDataRegulationController.js';\n\n/**\n * Selects the data recorded flag from the controller state.\n *\n * @param state - The controller state\n * @returns Whether data has been recorded since the last deletion request\n */\nconst selectHasCollectedDataSinceDeletionRequest = (\n state: AnalyticsDataRegulationControllerState,\n): boolean => state.hasCollectedDataSinceDeletionRequest;\n\n/**\n * Selects the delete regulation ID from the controller state.\n *\n * @param state - The controller state\n * @returns The regulation ID, or undefined if not set\n */\nconst selectDeleteRegulationId = (\n state: AnalyticsDataRegulationControllerState,\n): string | undefined => state.deleteRegulationId;\n\n/**\n * Selects the delete regulation creation timestamp from the controller state.\n *\n * @param state - The controller state\n * @returns The deletion timestamp (in milliseconds since epoch), or undefined if not set\n */\nconst selectDeleteRegulationTimestamp = (\n state: AnalyticsDataRegulationControllerState,\n): number | undefined => state.deleteRegulationTimestamp;\n\n/**\n * Selectors for the AnalyticsDataRegulationController state.\n * These can be used with Redux or directly with controller state.\n */\nexport const analyticsDataRegulationControllerSelectors = {\n selectHasCollectedDataSinceDeletionRequest,\n selectDeleteRegulationId,\n selectDeleteRegulationTimestamp,\n};\n"]}