@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.
Files changed (68) hide show
  1. package/CHANGELOG.md +10 -0
  2. package/LICENSE +20 -0
  3. package/README.md +15 -0
  4. package/dist/AnalyticsDataRegulationController-method-action-types.cjs +7 -0
  5. package/dist/AnalyticsDataRegulationController-method-action-types.cjs.map +1 -0
  6. package/dist/AnalyticsDataRegulationController-method-action-types.d.cts +44 -0
  7. package/dist/AnalyticsDataRegulationController-method-action-types.d.cts.map +1 -0
  8. package/dist/AnalyticsDataRegulationController-method-action-types.d.mts +44 -0
  9. package/dist/AnalyticsDataRegulationController-method-action-types.d.mts.map +1 -0
  10. package/dist/AnalyticsDataRegulationController-method-action-types.mjs +6 -0
  11. package/dist/AnalyticsDataRegulationController-method-action-types.mjs.map +1 -0
  12. package/dist/AnalyticsDataRegulationController.cjs +176 -0
  13. package/dist/AnalyticsDataRegulationController.cjs.map +1 -0
  14. package/dist/AnalyticsDataRegulationController.d.cts +147 -0
  15. package/dist/AnalyticsDataRegulationController.d.cts.map +1 -0
  16. package/dist/AnalyticsDataRegulationController.d.mts +147 -0
  17. package/dist/AnalyticsDataRegulationController.d.mts.map +1 -0
  18. package/dist/AnalyticsDataRegulationController.mjs +171 -0
  19. package/dist/AnalyticsDataRegulationController.mjs.map +1 -0
  20. package/dist/AnalyticsDataRegulationService-method-action-types.cjs +7 -0
  21. package/dist/AnalyticsDataRegulationService-method-action-types.cjs.map +1 -0
  22. package/dist/AnalyticsDataRegulationService-method-action-types.d.cts +32 -0
  23. package/dist/AnalyticsDataRegulationService-method-action-types.d.cts.map +1 -0
  24. package/dist/AnalyticsDataRegulationService-method-action-types.d.mts +32 -0
  25. package/dist/AnalyticsDataRegulationService-method-action-types.d.mts.map +1 -0
  26. package/dist/AnalyticsDataRegulationService-method-action-types.mjs +6 -0
  27. package/dist/AnalyticsDataRegulationService-method-action-types.mjs.map +1 -0
  28. package/dist/AnalyticsDataRegulationService.cjs +247 -0
  29. package/dist/AnalyticsDataRegulationService.cjs.map +1 -0
  30. package/dist/AnalyticsDataRegulationService.d.cts +172 -0
  31. package/dist/AnalyticsDataRegulationService.d.cts.map +1 -0
  32. package/dist/AnalyticsDataRegulationService.d.mts +172 -0
  33. package/dist/AnalyticsDataRegulationService.d.mts.map +1 -0
  34. package/dist/AnalyticsDataRegulationService.mjs +243 -0
  35. package/dist/AnalyticsDataRegulationService.mjs.map +1 -0
  36. package/dist/index.cjs +14 -0
  37. package/dist/index.cjs.map +1 -0
  38. package/dist/index.d.cts +11 -0
  39. package/dist/index.d.cts.map +1 -0
  40. package/dist/index.d.mts +11 -0
  41. package/dist/index.d.mts.map +1 -0
  42. package/dist/index.mjs +5 -0
  43. package/dist/index.mjs.map +1 -0
  44. package/dist/logger.cjs +7 -0
  45. package/dist/logger.cjs.map +1 -0
  46. package/dist/logger.d.cts +3 -0
  47. package/dist/logger.d.cts.map +1 -0
  48. package/dist/logger.d.mts +3 -0
  49. package/dist/logger.d.mts.map +1 -0
  50. package/dist/logger.mjs +4 -0
  51. package/dist/logger.mjs.map +1 -0
  52. package/dist/selectors.cjs +34 -0
  53. package/dist/selectors.cjs.map +1 -0
  54. package/dist/selectors.d.cts +11 -0
  55. package/dist/selectors.d.cts.map +1 -0
  56. package/dist/selectors.d.mts +11 -0
  57. package/dist/selectors.d.mts.map +1 -0
  58. package/dist/selectors.mjs +31 -0
  59. package/dist/selectors.mjs.map +1 -0
  60. package/dist/types.cjs +25 -0
  61. package/dist/types.cjs.map +1 -0
  62. package/dist/types.d.cts +46 -0
  63. package/dist/types.d.cts.map +1 -0
  64. package/dist/types.d.mts +46 -0
  65. package/dist/types.d.mts.map +1 -0
  66. package/dist/types.mjs +22 -0
  67. package/dist/types.mjs.map +1 -0
  68. package/package.json +76 -0
@@ -0,0 +1,243 @@
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";
15
+ /**
16
+ * Segment API regulation type for DELETE_ONLY operations.
17
+ */
18
+ const SEGMENT_REGULATION_TYPE_DELETE_ONLY = 'DELETE_ONLY';
19
+ /**
20
+ * Segment API subject type for user ID operations.
21
+ */
22
+ const SEGMENT_SUBJECT_TYPE_USER_ID = 'USER_ID';
23
+ /**
24
+ * Segment API Content-Type header value.
25
+ */
26
+ const SEGMENT_CONTENT_TYPE = 'application/vnd.segment.v1+json';
27
+ // === GENERAL ===
28
+ /**
29
+ * The name of the {@link AnalyticsDataRegulationService}, used to namespace the
30
+ * service's actions and events.
31
+ */
32
+ export const serviceName = 'AnalyticsDataRegulationService';
33
+ // === MESSENGER ===
34
+ const MESSENGER_EXPOSED_METHODS = [
35
+ 'createDataDeletionTask',
36
+ 'checkDataDeleteStatus',
37
+ ];
38
+ /**
39
+ * Type guard to check if a value is a valid DataDeleteStatus.
40
+ *
41
+ * @param status - The value to check.
42
+ * @returns True if the value is a valid DataDeleteStatus.
43
+ */
44
+ function isDataDeleteStatus(status) {
45
+ const dataDeleteStatuses = Object.values(DATA_DELETE_STATUSES);
46
+ return dataDeleteStatuses.includes(status);
47
+ }
48
+ /**
49
+ * This service object is responsible for making requests to the Segment Regulations API
50
+ * via a proxy endpoint for GDPR/CCPA data deletion functionality.
51
+ *
52
+ * @example
53
+ *
54
+ * ```ts
55
+ * import { Messenger } from '@metamask/messenger';
56
+ * import type {
57
+ * AnalyticsDataRegulationServiceActions,
58
+ * AnalyticsDataRegulationServiceEvents,
59
+ * } from '@metamask/analytics-data-regulation-controller';
60
+ *
61
+ * const rootMessenger = new Messenger<
62
+ * 'Root',
63
+ * AnalyticsDataRegulationServiceActions,
64
+ * AnalyticsDataRegulationServiceEvents
65
+ * >({ namespace: 'Root' });
66
+ * const serviceMessenger = new Messenger<
67
+ * 'AnalyticsDataRegulationService',
68
+ * AnalyticsDataRegulationServiceActions,
69
+ * AnalyticsDataRegulationServiceEvents,
70
+ * typeof rootMessenger,
71
+ * >({
72
+ * namespace: 'AnalyticsDataRegulationService',
73
+ * parent: rootMessenger,
74
+ * });
75
+ * // Instantiate the service to register its actions on the messenger
76
+ * new AnalyticsDataRegulationService({
77
+ * messenger: serviceMessenger,
78
+ * fetch,
79
+ * segmentSourceId: 'abc123',
80
+ * segmentRegulationsEndpoint: 'https://proxy.example.com/v1beta',
81
+ * });
82
+ *
83
+ * // Later...
84
+ * // Create a data deletion task
85
+ * const response = await rootMessenger.call(
86
+ * 'AnalyticsDataRegulationService:createDataDeletionTask',
87
+ * 'user-analytics-id',
88
+ * );
89
+ * ```
90
+ */
91
+ export class AnalyticsDataRegulationService {
92
+ /**
93
+ * Constructs a new AnalyticsDataRegulationService object.
94
+ *
95
+ * @param options - The constructor options.
96
+ */
97
+ 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
+ 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);
128
+ }
129
+ /**
130
+ * Registers a handler that will be called after a request returns a non-500
131
+ * response, causing a retry. Primarily useful in tests where timers are being
132
+ * mocked.
133
+ *
134
+ * @param listener - The handler to be called.
135
+ * @returns An object that can be used to unregister the handler.
136
+ * @see {@link createServicePolicy}
137
+ */
138
+ onRetry(listener) {
139
+ return __classPrivateFieldGet(this, _AnalyticsDataRegulationService_policy, "f").onRetry(listener);
140
+ }
141
+ /**
142
+ * Registers a handler that will be called after a set number of retry rounds
143
+ * prove that requests to the API endpoint consistently return a 5xx response.
144
+ *
145
+ * @param listener - The handler to be called.
146
+ * @returns An object that can be used to unregister the handler.
147
+ * @see {@link createServicePolicy}
148
+ */
149
+ onBreak(listener) {
150
+ return __classPrivateFieldGet(this, _AnalyticsDataRegulationService_policy, "f").onBreak(listener);
151
+ }
152
+ /**
153
+ * Registers a handler that will be called under one of two circumstances:
154
+ *
155
+ * 1. After a set number of retries prove that requests to the API
156
+ * consistently result in failures.
157
+ * 2. After a successful request is made to the API, but the response takes
158
+ * longer than a set duration to return.
159
+ *
160
+ * @param listener - The handler to be called.
161
+ * @returns An object that can be used to unregister the handler.
162
+ */
163
+ onDegraded(listener) {
164
+ return __classPrivateFieldGet(this, _AnalyticsDataRegulationService_policy, "f").onDegraded(listener);
165
+ }
166
+ /**
167
+ * Creates a DELETE_ONLY regulation for the given analyticsId.
168
+ *
169
+ * @param analyticsId - The analytics ID of the user for whom to create the deletion task.
170
+ * @returns Promise resolving to a successful deletion regulation response.
171
+ * @throws Error if the request fails or the response is invalid.
172
+ */
173
+ async createDataDeletionTask(analyticsId) {
174
+ if (!__classPrivateFieldGet(this, _AnalyticsDataRegulationService_segmentSourceId, "f") || !__classPrivateFieldGet(this, _AnalyticsDataRegulationService_segmentRegulationsEndpoint, "f")) {
175
+ throw new Error('Segment API source ID or endpoint not found');
176
+ }
177
+ const url = `${__classPrivateFieldGet(this, _AnalyticsDataRegulationService_segmentRegulationsEndpoint, "f")}/regulations/sources/${__classPrivateFieldGet(this, _AnalyticsDataRegulationService_segmentSourceId, "f")}`;
178
+ const body = JSON.stringify({
179
+ regulationType: SEGMENT_REGULATION_TYPE_DELETE_ONLY,
180
+ subjectType: SEGMENT_SUBJECT_TYPE_USER_ID,
181
+ subjectIds: [analyticsId],
182
+ });
183
+ const response = await __classPrivateFieldGet(this, _AnalyticsDataRegulationService_policy, "f").execute(async () => {
184
+ const localResponse = await __classPrivateFieldGet(this, _AnalyticsDataRegulationService_fetch, "f").call(this, url, {
185
+ method: 'POST',
186
+ headers: {
187
+ 'Content-Type': SEGMENT_CONTENT_TYPE,
188
+ },
189
+ body,
190
+ });
191
+ if (!localResponse.ok) {
192
+ throw new HttpError(localResponse.status, `Creating data deletion task failed with status '${localResponse.status}'`);
193
+ }
194
+ return localResponse;
195
+ });
196
+ const jsonResponse = (await response.json());
197
+ if (!jsonResponse?.data?.data?.regulateId ||
198
+ typeof jsonResponse.data.data.regulateId !== 'string' ||
199
+ jsonResponse.data.data.regulateId.trim() === '') {
200
+ throw new Error('Malformed response from Segment API: missing or invalid regulateId');
201
+ }
202
+ return {
203
+ status: DATA_DELETE_RESPONSE_STATUSES.Success,
204
+ regulateId: jsonResponse.data.data.regulateId,
205
+ };
206
+ }
207
+ /**
208
+ * Checks the status of a regulation by ID.
209
+ *
210
+ * @param regulationId - The regulation ID to check.
211
+ * @returns Promise resolving to a successful regulation status response.
212
+ * @throws Error if the request fails or the response is invalid.
213
+ */
214
+ async checkDataDeleteStatus(regulationId) {
215
+ if (!regulationId || !__classPrivateFieldGet(this, _AnalyticsDataRegulationService_segmentRegulationsEndpoint, "f")) {
216
+ throw new Error('Regulation ID or endpoint not configured');
217
+ }
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, {
221
+ method: 'GET',
222
+ headers: {
223
+ 'Content-Type': SEGMENT_CONTENT_TYPE,
224
+ },
225
+ });
226
+ if (!localResponse.ok) {
227
+ throw new HttpError(localResponse.status, `Checking data deletion status failed with status '${localResponse.status}'`);
228
+ }
229
+ return localResponse;
230
+ });
231
+ const jsonResponse = (await response.json());
232
+ const rawStatus = jsonResponse?.data?.data?.regulation?.overallStatus;
233
+ const dataDeleteStatus = isDataDeleteStatus(rawStatus)
234
+ ? rawStatus
235
+ : DATA_DELETE_STATUSES.Unknown;
236
+ return {
237
+ status: DATA_DELETE_RESPONSE_STATUSES.Success,
238
+ dataDeleteStatus,
239
+ };
240
+ }
241
+ }
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
@@ -0,0 +1 @@
1
+ {"version":3,"file":"AnalyticsDataRegulationService.mjs","sourceRoot":"","sources":["../src/AnalyticsDataRegulationService.ts"],"names":[],"mappings":";;;;;;;;;;;;AAIA,OAAO,EAAE,mBAAmB,EAAE,SAAS,EAAE,mCAAmC;AAK5E,OAAO,EAAE,6BAA6B,EAAE,oBAAoB,EAAE,oBAAgB;AAG9E;;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;IAkCzC;;;;OAIG;IACH,YAAY,OAA8C;QAjC1D;;WAEG;QACM,4DAAoD;QAE7D;;WAEG;QACM,wDAAqB;QAE9B;;WAEG;QACM,kEAAyB;QAElC;;;WAGG;QACM,6EAAoC;QAE7C;;;;WAIG;QACM,yDAAuB;QAQ9B,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC;QACxB,uBAAA,IAAI,6CAAc,OAAO,CAAC,SAAS,MAAA,CAAC;QACpC,uBAAA,IAAI,yCAAU,OAAO,CAAC,KAAK,MAAA,CAAC;QAC5B,uBAAA,IAAI,mDAAoB,OAAO,CAAC,eAAe,MAAA,CAAC;QAChD,uBAAA,IAAI,8DAA+B,OAAO,CAAC,0BAA0B,MAAA,CAAC;QACtE,uBAAA,IAAI,0CAAW,mBAAmB,CAAC,OAAO,CAAC,aAAa,IAAI,EAAE,CAAC,MAAA,CAAC;QAEhE,uBAAA,IAAI,iDAAW,CAAC,4BAA4B,CAC1C,IAAI,EACJ,yBAAyB,CAC1B,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,OAAO,CAAC,QAAiD;QACvD,OAAO,uBAAA,IAAI,8CAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;OAOG;IACH,OAAO,CAAC,QAAiD;QACvD,OAAO,uBAAA,IAAI,8CAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;;;;OAUG;IACH,UAAU,CACR,QAAoD;QAEpD,OAAO,uBAAA,IAAI,8CAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,sBAAsB,CAAC,WAAmB;QAI9C,IAAI,CAAC,uBAAA,IAAI,uDAAiB,IAAI,CAAC,uBAAA,IAAI,kEAA4B,EAAE,CAAC;YAChE,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;QACjE,CAAC;QAED,MAAM,GAAG,GAAG,GAAG,uBAAA,IAAI,kEAA4B,wBAAwB,uBAAA,IAAI,uDAAiB,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,uBAAA,IAAI,8CAAQ,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE;YACrD,MAAM,aAAa,GAAG,MAAM,uBAAA,IAAI,6CAAO,MAAX,IAAI,EAAQ,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,uBAAA,IAAI,kEAA4B,EAAE,CAAC;YACvD,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;QAC9D,CAAC;QAED,MAAM,GAAG,GAAG,GAAG,uBAAA,IAAI,kEAA4B,gBAAgB,YAAY,EAAE,CAAC;QAE9E,MAAM,QAAQ,GAAG,MAAM,uBAAA,IAAI,8CAAQ,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE;YACrD,MAAM,aAAa,GAAG,MAAM,uBAAA,IAAI,6CAAO,MAAX,IAAI,EAAQ,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';\nimport { DATA_DELETE_RESPONSE_STATUSES, DATA_DELETE_STATUSES } from './types';\nimport type { DataDeleteStatus } from './types';\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"]}
package/dist/index.cjs ADDED
@@ -0,0 +1,14 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.analyticsDataRegulationControllerSelectors = exports.DATA_DELETE_RESPONSE_STATUSES = exports.DATA_DELETE_STATUSES = exports.AnalyticsDataRegulationService = exports.getDefaultAnalyticsDataRegulationControllerState = exports.AnalyticsDataRegulationController = void 0;
4
+ var AnalyticsDataRegulationController_1 = require("./AnalyticsDataRegulationController.cjs");
5
+ Object.defineProperty(exports, "AnalyticsDataRegulationController", { enumerable: true, get: function () { return AnalyticsDataRegulationController_1.AnalyticsDataRegulationController; } });
6
+ Object.defineProperty(exports, "getDefaultAnalyticsDataRegulationControllerState", { enumerable: true, get: function () { return AnalyticsDataRegulationController_1.getDefaultAnalyticsDataRegulationControllerState; } });
7
+ var AnalyticsDataRegulationService_1 = require("./AnalyticsDataRegulationService.cjs");
8
+ Object.defineProperty(exports, "AnalyticsDataRegulationService", { enumerable: true, get: function () { return AnalyticsDataRegulationService_1.AnalyticsDataRegulationService; } });
9
+ var types_1 = require("./types.cjs");
10
+ Object.defineProperty(exports, "DATA_DELETE_STATUSES", { enumerable: true, get: function () { return types_1.DATA_DELETE_STATUSES; } });
11
+ Object.defineProperty(exports, "DATA_DELETE_RESPONSE_STATUSES", { enumerable: true, get: function () { return types_1.DATA_DELETE_RESPONSE_STATUSES; } });
12
+ var selectors_1 = require("./selectors.cjs");
13
+ Object.defineProperty(exports, "analyticsDataRegulationControllerSelectors", { enumerable: true, get: function () { return selectors_1.analyticsDataRegulationControllerSelectors; } });
14
+ //# sourceMappingURL=index.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,6FAG6C;AAF3C,sJAAA,iCAAiC,OAAA;AACjC,qKAAA,gDAAgD,OAAA;AAIlD,uFAAkF;AAAzE,gJAAA,8BAA8B,OAAA;AAQvC,qCAKiB;AAJf,6GAAA,oBAAoB,OAAA;AACpB,sHAAA,6BAA6B,OAAA;AAQ/B,6CAAyE;AAAhE,uIAAA,0CAA0C,OAAA","sourcesContent":["export {\n AnalyticsDataRegulationController,\n getDefaultAnalyticsDataRegulationControllerState,\n} from './AnalyticsDataRegulationController';\nexport type { AnalyticsDataRegulationControllerOptions } from './AnalyticsDataRegulationController';\n\nexport { AnalyticsDataRegulationService } from './AnalyticsDataRegulationService';\nexport type {\n AnalyticsDataRegulationServiceActions,\n AnalyticsDataRegulationServiceEvents,\n AnalyticsDataRegulationServiceMessenger,\n AnalyticsDataRegulationServiceOptions,\n} from './AnalyticsDataRegulationService';\n\nexport {\n DATA_DELETE_STATUSES,\n DATA_DELETE_RESPONSE_STATUSES,\n type DataDeleteStatus,\n type DataDeleteResponseStatus,\n} from './types';\nexport type { DeleteRegulationResponse, DeleteRegulationStatus } from './types';\n\nexport type { AnalyticsDataRegulationControllerState } from './AnalyticsDataRegulationController';\n\nexport { analyticsDataRegulationControllerSelectors } from './selectors';\n\nexport type { AnalyticsDataRegulationControllerMessenger } from './AnalyticsDataRegulationController';\n\nexport type {\n AnalyticsDataRegulationControllerActions,\n AnalyticsDataRegulationControllerEvents,\n AnalyticsDataRegulationControllerGetStateAction,\n AnalyticsDataRegulationControllerStateChangeEvent,\n DataDeletionTaskCreatedEvent,\n DataRecordingFlagUpdatedEvent,\n} from './AnalyticsDataRegulationController';\n"]}
@@ -0,0 +1,11 @@
1
+ export { AnalyticsDataRegulationController, getDefaultAnalyticsDataRegulationControllerState, } from "./AnalyticsDataRegulationController.cjs";
2
+ export type { AnalyticsDataRegulationControllerOptions } from "./AnalyticsDataRegulationController.cjs";
3
+ export { AnalyticsDataRegulationService } from "./AnalyticsDataRegulationService.cjs";
4
+ export type { AnalyticsDataRegulationServiceActions, AnalyticsDataRegulationServiceEvents, AnalyticsDataRegulationServiceMessenger, AnalyticsDataRegulationServiceOptions, } from "./AnalyticsDataRegulationService.cjs";
5
+ export { DATA_DELETE_STATUSES, DATA_DELETE_RESPONSE_STATUSES, type DataDeleteStatus, type DataDeleteResponseStatus, } from "./types.cjs";
6
+ export type { DeleteRegulationResponse, DeleteRegulationStatus } from "./types.cjs";
7
+ export type { AnalyticsDataRegulationControllerState } from "./AnalyticsDataRegulationController.cjs";
8
+ export { analyticsDataRegulationControllerSelectors } from "./selectors.cjs";
9
+ export type { AnalyticsDataRegulationControllerMessenger } from "./AnalyticsDataRegulationController.cjs";
10
+ export type { AnalyticsDataRegulationControllerActions, AnalyticsDataRegulationControllerEvents, AnalyticsDataRegulationControllerGetStateAction, AnalyticsDataRegulationControllerStateChangeEvent, DataDeletionTaskCreatedEvent, DataRecordingFlagUpdatedEvent, } from "./AnalyticsDataRegulationController.cjs";
11
+ //# sourceMappingURL=index.d.cts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iCAAiC,EACjC,gDAAgD,GACjD,gDAA4C;AAC7C,YAAY,EAAE,wCAAwC,EAAE,gDAA4C;AAEpG,OAAO,EAAE,8BAA8B,EAAE,6CAAyC;AAClF,YAAY,EACV,qCAAqC,EACrC,oCAAoC,EACpC,uCAAuC,EACvC,qCAAqC,GACtC,6CAAyC;AAE1C,OAAO,EACL,oBAAoB,EACpB,6BAA6B,EAC7B,KAAK,gBAAgB,EACrB,KAAK,wBAAwB,GAC9B,oBAAgB;AACjB,YAAY,EAAE,wBAAwB,EAAE,sBAAsB,EAAE,oBAAgB;AAEhF,YAAY,EAAE,sCAAsC,EAAE,gDAA4C;AAElG,OAAO,EAAE,0CAA0C,EAAE,wBAAoB;AAEzE,YAAY,EAAE,0CAA0C,EAAE,gDAA4C;AAEtG,YAAY,EACV,wCAAwC,EACxC,uCAAuC,EACvC,+CAA+C,EAC/C,iDAAiD,EACjD,4BAA4B,EAC5B,6BAA6B,GAC9B,gDAA4C"}
@@ -0,0 +1,11 @@
1
+ export { AnalyticsDataRegulationController, getDefaultAnalyticsDataRegulationControllerState, } from "./AnalyticsDataRegulationController.mjs";
2
+ export type { AnalyticsDataRegulationControllerOptions } from "./AnalyticsDataRegulationController.mjs";
3
+ export { AnalyticsDataRegulationService } from "./AnalyticsDataRegulationService.mjs";
4
+ export type { AnalyticsDataRegulationServiceActions, AnalyticsDataRegulationServiceEvents, AnalyticsDataRegulationServiceMessenger, AnalyticsDataRegulationServiceOptions, } from "./AnalyticsDataRegulationService.mjs";
5
+ export { DATA_DELETE_STATUSES, DATA_DELETE_RESPONSE_STATUSES, type DataDeleteStatus, type DataDeleteResponseStatus, } from "./types.mjs";
6
+ export type { DeleteRegulationResponse, DeleteRegulationStatus } from "./types.mjs";
7
+ export type { AnalyticsDataRegulationControllerState } from "./AnalyticsDataRegulationController.mjs";
8
+ export { analyticsDataRegulationControllerSelectors } from "./selectors.mjs";
9
+ export type { AnalyticsDataRegulationControllerMessenger } from "./AnalyticsDataRegulationController.mjs";
10
+ export type { AnalyticsDataRegulationControllerActions, AnalyticsDataRegulationControllerEvents, AnalyticsDataRegulationControllerGetStateAction, AnalyticsDataRegulationControllerStateChangeEvent, DataDeletionTaskCreatedEvent, DataRecordingFlagUpdatedEvent, } from "./AnalyticsDataRegulationController.mjs";
11
+ //# sourceMappingURL=index.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iCAAiC,EACjC,gDAAgD,GACjD,gDAA4C;AAC7C,YAAY,EAAE,wCAAwC,EAAE,gDAA4C;AAEpG,OAAO,EAAE,8BAA8B,EAAE,6CAAyC;AAClF,YAAY,EACV,qCAAqC,EACrC,oCAAoC,EACpC,uCAAuC,EACvC,qCAAqC,GACtC,6CAAyC;AAE1C,OAAO,EACL,oBAAoB,EACpB,6BAA6B,EAC7B,KAAK,gBAAgB,EACrB,KAAK,wBAAwB,GAC9B,oBAAgB;AACjB,YAAY,EAAE,wBAAwB,EAAE,sBAAsB,EAAE,oBAAgB;AAEhF,YAAY,EAAE,sCAAsC,EAAE,gDAA4C;AAElG,OAAO,EAAE,0CAA0C,EAAE,wBAAoB;AAEzE,YAAY,EAAE,0CAA0C,EAAE,gDAA4C;AAEtG,YAAY,EACV,wCAAwC,EACxC,uCAAuC,EACvC,+CAA+C,EAC/C,iDAAiD,EACjD,4BAA4B,EAC5B,6BAA6B,GAC9B,gDAA4C"}
package/dist/index.mjs ADDED
@@ -0,0 +1,5 @@
1
+ export { AnalyticsDataRegulationController, getDefaultAnalyticsDataRegulationControllerState } from "./AnalyticsDataRegulationController.mjs";
2
+ export { AnalyticsDataRegulationService } from "./AnalyticsDataRegulationService.mjs";
3
+ export { DATA_DELETE_STATUSES, DATA_DELETE_RESPONSE_STATUSES } from "./types.mjs";
4
+ export { analyticsDataRegulationControllerSelectors } from "./selectors.mjs";
5
+ //# sourceMappingURL=index.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iCAAiC,EACjC,gDAAgD,EACjD,gDAA4C;AAG7C,OAAO,EAAE,8BAA8B,EAAE,6CAAyC;AAQlF,OAAO,EACL,oBAAoB,EACpB,6BAA6B,EAG9B,oBAAgB;AAKjB,OAAO,EAAE,0CAA0C,EAAE,wBAAoB","sourcesContent":["export {\n AnalyticsDataRegulationController,\n getDefaultAnalyticsDataRegulationControllerState,\n} from './AnalyticsDataRegulationController';\nexport type { AnalyticsDataRegulationControllerOptions } from './AnalyticsDataRegulationController';\n\nexport { AnalyticsDataRegulationService } from './AnalyticsDataRegulationService';\nexport type {\n AnalyticsDataRegulationServiceActions,\n AnalyticsDataRegulationServiceEvents,\n AnalyticsDataRegulationServiceMessenger,\n AnalyticsDataRegulationServiceOptions,\n} from './AnalyticsDataRegulationService';\n\nexport {\n DATA_DELETE_STATUSES,\n DATA_DELETE_RESPONSE_STATUSES,\n type DataDeleteStatus,\n type DataDeleteResponseStatus,\n} from './types';\nexport type { DeleteRegulationResponse, DeleteRegulationStatus } from './types';\n\nexport type { AnalyticsDataRegulationControllerState } from './AnalyticsDataRegulationController';\n\nexport { analyticsDataRegulationControllerSelectors } from './selectors';\n\nexport type { AnalyticsDataRegulationControllerMessenger } from './AnalyticsDataRegulationController';\n\nexport type {\n AnalyticsDataRegulationControllerActions,\n AnalyticsDataRegulationControllerEvents,\n AnalyticsDataRegulationControllerGetStateAction,\n AnalyticsDataRegulationControllerStateChangeEvent,\n DataDeletionTaskCreatedEvent,\n DataRecordingFlagUpdatedEvent,\n} from './AnalyticsDataRegulationController';\n"]}
@@ -0,0 +1,7 @@
1
+ "use strict";
2
+ /* istanbul ignore file */
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.projectLogger = void 0;
5
+ const utils_1 = require("@metamask/utils");
6
+ exports.projectLogger = (0, utils_1.createProjectLogger)('analytics-data-regulation-controller');
7
+ //# sourceMappingURL=logger.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"logger.cjs","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":";AAAA,0BAA0B;;;AAE1B,2CAAsD;AAEzC,QAAA,aAAa,GAAG,IAAA,2BAAmB,EAC9C,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,3 @@
1
+ /// <reference types="debug" />
2
+ export declare const projectLogger: import("debug").Debugger;
3
+ //# sourceMappingURL=logger.d.cts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"logger.d.cts","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":";AAIA,eAAO,MAAM,aAAa,0BAEzB,CAAC"}
@@ -0,0 +1,3 @@
1
+ /// <reference types="debug" />
2
+ export declare const projectLogger: import("debug").Debugger;
3
+ //# sourceMappingURL=logger.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"logger.d.mts","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":";AAIA,eAAO,MAAM,aAAa,0BAEzB,CAAC"}
@@ -0,0 +1,4 @@
1
+ /* istanbul ignore file */
2
+ import { createProjectLogger } from "@metamask/utils";
3
+ export const projectLogger = createProjectLogger('analytics-data-regulation-controller');
4
+ //# sourceMappingURL=logger.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"logger.mjs","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":"AAAA,0BAA0B;AAE1B,OAAO,EAAE,mBAAmB,EAAE,wBAAwB;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,34 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.analyticsDataRegulationControllerSelectors = void 0;
4
+ /**
5
+ * Selects the data recorded flag from the controller state.
6
+ *
7
+ * @param state - The controller state
8
+ * @returns Whether data has been recorded since the last deletion request
9
+ */
10
+ const selectHasCollectedDataSinceDeletionRequest = (state) => state.hasCollectedDataSinceDeletionRequest;
11
+ /**
12
+ * Selects the delete regulation ID from the controller state.
13
+ *
14
+ * @param state - The controller state
15
+ * @returns The regulation ID, or undefined if not set
16
+ */
17
+ const selectDeleteRegulationId = (state) => state.deleteRegulationId;
18
+ /**
19
+ * Selects the delete regulation creation timestamp from the controller state.
20
+ *
21
+ * @param state - The controller state
22
+ * @returns The deletion timestamp (in milliseconds since epoch), or undefined if not set
23
+ */
24
+ const selectDeleteRegulationTimestamp = (state) => state.deleteRegulationTimestamp;
25
+ /**
26
+ * Selectors for the AnalyticsDataRegulationController state.
27
+ * These can be used with Redux or directly with controller state.
28
+ */
29
+ exports.analyticsDataRegulationControllerSelectors = {
30
+ selectHasCollectedDataSinceDeletionRequest,
31
+ selectDeleteRegulationId,
32
+ selectDeleteRegulationTimestamp,
33
+ };
34
+ //# sourceMappingURL=selectors.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"selectors.cjs","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;AACU,QAAA,0CAA0C,GAAG;IACxD,0CAA0C;IAC1C,wBAAwB;IACxB,+BAA+B;CAChC,CAAC","sourcesContent":["import type { AnalyticsDataRegulationControllerState } from './AnalyticsDataRegulationController';\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"]}
@@ -0,0 +1,11 @@
1
+ import type { AnalyticsDataRegulationControllerState } from "./AnalyticsDataRegulationController.cjs";
2
+ /**
3
+ * Selectors for the AnalyticsDataRegulationController state.
4
+ * These can be used with Redux or directly with controller state.
5
+ */
6
+ export declare const analyticsDataRegulationControllerSelectors: {
7
+ selectHasCollectedDataSinceDeletionRequest: (state: AnalyticsDataRegulationControllerState) => boolean;
8
+ selectDeleteRegulationId: (state: AnalyticsDataRegulationControllerState) => string | undefined;
9
+ selectDeleteRegulationTimestamp: (state: AnalyticsDataRegulationControllerState) => number | undefined;
10
+ };
11
+ //# sourceMappingURL=selectors.d.cts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"selectors.d.cts","sourceRoot":"","sources":["../src/selectors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sCAAsC,EAAE,gDAA4C;AAgClG;;;GAGG;AACH,eAAO,MAAM,0CAA0C;wDA3B9C,sCAAsC,KAC5C,OAAO;sCASD,sCAAsC,KAC5C,MAAM,GAAG,SAAS;6CASZ,sCAAsC,KAC5C,MAAM,GAAG,SAAS;CAUpB,CAAC"}
@@ -0,0 +1,11 @@
1
+ import type { AnalyticsDataRegulationControllerState } from "./AnalyticsDataRegulationController.mjs";
2
+ /**
3
+ * Selectors for the AnalyticsDataRegulationController state.
4
+ * These can be used with Redux or directly with controller state.
5
+ */
6
+ export declare const analyticsDataRegulationControllerSelectors: {
7
+ selectHasCollectedDataSinceDeletionRequest: (state: AnalyticsDataRegulationControllerState) => boolean;
8
+ selectDeleteRegulationId: (state: AnalyticsDataRegulationControllerState) => string | undefined;
9
+ selectDeleteRegulationTimestamp: (state: AnalyticsDataRegulationControllerState) => number | undefined;
10
+ };
11
+ //# sourceMappingURL=selectors.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"selectors.d.mts","sourceRoot":"","sources":["../src/selectors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sCAAsC,EAAE,gDAA4C;AAgClG;;;GAGG;AACH,eAAO,MAAM,0CAA0C;wDA3B9C,sCAAsC,KAC5C,OAAO;sCASD,sCAAsC,KAC5C,MAAM,GAAG,SAAS;6CASZ,sCAAsC,KAC5C,MAAM,GAAG,SAAS;CAUpB,CAAC"}
@@ -0,0 +1,31 @@
1
+ /**
2
+ * Selects the data recorded flag from the controller state.
3
+ *
4
+ * @param state - The controller state
5
+ * @returns Whether data has been recorded since the last deletion request
6
+ */
7
+ const selectHasCollectedDataSinceDeletionRequest = (state) => state.hasCollectedDataSinceDeletionRequest;
8
+ /**
9
+ * Selects the delete regulation ID from the controller state.
10
+ *
11
+ * @param state - The controller state
12
+ * @returns The regulation ID, or undefined if not set
13
+ */
14
+ const selectDeleteRegulationId = (state) => state.deleteRegulationId;
15
+ /**
16
+ * Selects the delete regulation creation timestamp from the controller state.
17
+ *
18
+ * @param state - The controller state
19
+ * @returns The deletion timestamp (in milliseconds since epoch), or undefined if not set
20
+ */
21
+ const selectDeleteRegulationTimestamp = (state) => state.deleteRegulationTimestamp;
22
+ /**
23
+ * Selectors for the AnalyticsDataRegulationController state.
24
+ * These can be used with Redux or directly with controller state.
25
+ */
26
+ export const analyticsDataRegulationControllerSelectors = {
27
+ selectHasCollectedDataSinceDeletionRequest,
28
+ selectDeleteRegulationId,
29
+ selectDeleteRegulationTimestamp,
30
+ };
31
+ //# sourceMappingURL=selectors.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"selectors.mjs","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';\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"]}
package/dist/types.cjs ADDED
@@ -0,0 +1,25 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.DATA_DELETE_RESPONSE_STATUSES = exports.DATA_DELETE_STATUSES = void 0;
4
+ /**
5
+ * Status values for data deletion requests from Segment API.
6
+ * Values match Segment API response values exactly.
7
+ */
8
+ exports.DATA_DELETE_STATUSES = {
9
+ Failed: 'FAILED',
10
+ Finished: 'FINISHED',
11
+ Initialized: 'INITIALIZED',
12
+ Invalid: 'INVALID',
13
+ NotSupported: 'NOT_SUPPORTED',
14
+ PartialSuccess: 'PARTIAL_SUCCESS',
15
+ Running: 'RUNNING',
16
+ Unknown: 'UNKNOWN',
17
+ };
18
+ /**
19
+ * Response status for deletion regulation operations.
20
+ */
21
+ exports.DATA_DELETE_RESPONSE_STATUSES = {
22
+ Success: 'ok',
23
+ Failure: 'error',
24
+ };
25
+ //# sourceMappingURL=types.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.cjs","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACU,QAAA,oBAAoB,GAAG;IAClC,MAAM,EAAE,QAAQ;IAChB,QAAQ,EAAE,UAAU;IACpB,WAAW,EAAE,aAAa;IAC1B,OAAO,EAAE,SAAS;IAClB,YAAY,EAAE,eAAe;IAC7B,cAAc,EAAE,iBAAiB;IACjC,OAAO,EAAE,SAAS;IAClB,OAAO,EAAE,SAAS;CACV,CAAC;AAQX;;GAEG;AACU,QAAA,6BAA6B,GAAG;IAC3C,OAAO,EAAE,IAAI;IACb,OAAO,EAAE,OAAO;CACR,CAAC","sourcesContent":["/**\n * Status values for data deletion requests from Segment API.\n * Values match Segment API response values exactly.\n */\nexport const DATA_DELETE_STATUSES = {\n Failed: 'FAILED',\n Finished: 'FINISHED',\n Initialized: 'INITIALIZED',\n Invalid: 'INVALID',\n NotSupported: 'NOT_SUPPORTED',\n PartialSuccess: 'PARTIAL_SUCCESS',\n Running: 'RUNNING',\n Unknown: 'UNKNOWN',\n} as const;\n\n/**\n * Type union for data deletion status values.\n */\nexport type DataDeleteStatus =\n (typeof DATA_DELETE_STATUSES)[keyof typeof DATA_DELETE_STATUSES];\n\n/**\n * Response status for deletion regulation operations.\n */\nexport const DATA_DELETE_RESPONSE_STATUSES = {\n Success: 'ok',\n Failure: 'error',\n} as const;\n\n/**\n * Type union for data deletion response status values.\n */\nexport type DataDeleteResponseStatus =\n (typeof DATA_DELETE_RESPONSE_STATUSES)[keyof typeof DATA_DELETE_RESPONSE_STATUSES];\n\n/**\n * Response from creating a data deletion task.\n * The service throws errors on failure, so this type only represents the Success case.\n */\nexport type DeleteRegulationResponse = {\n status: typeof DATA_DELETE_RESPONSE_STATUSES.Success;\n regulateId: string; // Using exact API field name from Segment API response\n};\n\n/**\n * Status information for a data deletion request.\n */\nexport type DeleteRegulationStatus = {\n deletionRequestTimestamp?: number;\n hasCollectedDataSinceDeletionRequest: boolean;\n dataDeletionRequestStatus: DataDeleteStatus;\n};\n"]}
@@ -0,0 +1,46 @@
1
+ /**
2
+ * Status values for data deletion requests from Segment API.
3
+ * Values match Segment API response values exactly.
4
+ */
5
+ export declare const DATA_DELETE_STATUSES: {
6
+ readonly Failed: "FAILED";
7
+ readonly Finished: "FINISHED";
8
+ readonly Initialized: "INITIALIZED";
9
+ readonly Invalid: "INVALID";
10
+ readonly NotSupported: "NOT_SUPPORTED";
11
+ readonly PartialSuccess: "PARTIAL_SUCCESS";
12
+ readonly Running: "RUNNING";
13
+ readonly Unknown: "UNKNOWN";
14
+ };
15
+ /**
16
+ * Type union for data deletion status values.
17
+ */
18
+ export type DataDeleteStatus = (typeof DATA_DELETE_STATUSES)[keyof typeof DATA_DELETE_STATUSES];
19
+ /**
20
+ * Response status for deletion regulation operations.
21
+ */
22
+ export declare const DATA_DELETE_RESPONSE_STATUSES: {
23
+ readonly Success: "ok";
24
+ readonly Failure: "error";
25
+ };
26
+ /**
27
+ * Type union for data deletion response status values.
28
+ */
29
+ export type DataDeleteResponseStatus = (typeof DATA_DELETE_RESPONSE_STATUSES)[keyof typeof DATA_DELETE_RESPONSE_STATUSES];
30
+ /**
31
+ * Response from creating a data deletion task.
32
+ * The service throws errors on failure, so this type only represents the Success case.
33
+ */
34
+ export type DeleteRegulationResponse = {
35
+ status: typeof DATA_DELETE_RESPONSE_STATUSES.Success;
36
+ regulateId: string;
37
+ };
38
+ /**
39
+ * Status information for a data deletion request.
40
+ */
41
+ export type DeleteRegulationStatus = {
42
+ deletionRequestTimestamp?: number;
43
+ hasCollectedDataSinceDeletionRequest: boolean;
44
+ dataDeletionRequestStatus: DataDeleteStatus;
45
+ };
46
+ //# sourceMappingURL=types.d.cts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.d.cts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;CASvB,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAC1B,CAAC,OAAO,oBAAoB,CAAC,CAAC,MAAM,OAAO,oBAAoB,CAAC,CAAC;AAEnE;;GAEG;AACH,eAAO,MAAM,6BAA6B;;;CAGhC,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAClC,CAAC,OAAO,6BAA6B,CAAC,CAAC,MAAM,OAAO,6BAA6B,CAAC,CAAC;AAErF;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,MAAM,EAAE,OAAO,6BAA6B,CAAC,OAAO,CAAC;IACrD,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,oCAAoC,EAAE,OAAO,CAAC;IAC9C,yBAAyB,EAAE,gBAAgB,CAAC;CAC7C,CAAC"}