@metamask-previews/analytics-data-regulation-controller 0.0.0-preview-52f4a2ca

package/dist/AnalyticsDataRegulationController.d.mts

@@ -0,0 +1,147 @@
+import type { ControllerGetStateAction, ControllerStateChangeEvent } from "@metamask/base-controller";
+import { BaseController } from "@metamask/base-controller";
+import type { Messenger } from "@metamask/messenger";
+import type { AnalyticsDataRegulationControllerMethodActions } from "./AnalyticsDataRegulationController-method-action-types.mjs";
+import type { AnalyticsDataRegulationServiceActions } from "./AnalyticsDataRegulationService.mjs";
+import { DATA_DELETE_RESPONSE_STATUSES } from "./types.mjs";
+import type { DeleteRegulationResponse, DeleteRegulationStatus } from "./types.mjs";
+/**
+ * The name of the {@link AnalyticsDataRegulationController}, used to namespace the
+ * controller's actions and events and to namespace the controller's state data
+ * when composed with other controllers.
+ */
+export declare const controllerName = "AnalyticsDataRegulationController";
+/**
+ * Describes the shape of the state object for {@link AnalyticsDataRegulationController}.
+ */
+export type AnalyticsDataRegulationControllerState = {
+    /**
+     * Indicates if data has been recorded since the last deletion request.
+     */
+    hasCollectedDataSinceDeletionRequest: boolean;
+    /**
+     * Segment's data deletion regulation ID.
+     * The ID returned by the Segment delete API which allows checking the status of the deletion request.
+     */
+    deleteRegulationId?: string;
+    /**
+     * Segment's data deletion regulation creation timestamp.
+     * The timestamp (in milliseconds since epoch) when the deletion request was created.
+     */
+    deleteRegulationTimestamp?: number;
+};
+/**
+ * Returns default values for AnalyticsDataRegulationController state.
+ *
+ * @returns Default state
+ */
+export declare function getDefaultAnalyticsDataRegulationControllerState(): AnalyticsDataRegulationControllerState;
+/**
+ * Returns the state of the {@link AnalyticsDataRegulationController}.
+ */
+export type AnalyticsDataRegulationControllerGetStateAction = ControllerGetStateAction<typeof controllerName, AnalyticsDataRegulationControllerState>;
+/**
+ * Actions that {@link AnalyticsDataRegulationControllerMessenger} exposes to other consumers.
+ */
+export type AnalyticsDataRegulationControllerActions = AnalyticsDataRegulationControllerGetStateAction | AnalyticsDataRegulationControllerMethodActions;
+/**
+ * Actions from other messengers that {@link AnalyticsDataRegulationControllerMessenger} calls.
+ */
+type AllowedActions = AnalyticsDataRegulationServiceActions;
+/**
+ * Event emitted when a data deletion task is created.
+ */
+export type DataDeletionTaskCreatedEvent = {
+    type: `${typeof controllerName}:dataDeletionTaskCreated`;
+    payload: [DeleteRegulationResponse];
+};
+/**
+ * Event emitted when the data recording flag is updated.
+ */
+export type DataRecordingFlagUpdatedEvent = {
+    type: `${typeof controllerName}:dataRecordingFlagUpdated`;
+    payload: [boolean];
+};
+/**
+ * Event emitted when the state of the {@link AnalyticsDataRegulationController} changes.
+ */
+export type AnalyticsDataRegulationControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, AnalyticsDataRegulationControllerState>;
+/**
+ * Events that {@link AnalyticsDataRegulationControllerMessenger} exposes to other consumers.
+ */
+export type AnalyticsDataRegulationControllerEvents = AnalyticsDataRegulationControllerStateChangeEvent | DataDeletionTaskCreatedEvent | DataRecordingFlagUpdatedEvent;
+/**
+ * Events from other messengers that {@link AnalyticsDataRegulationControllerMessenger} subscribes to.
+ */
+type AllowedEvents = never;
+/**
+ * The messenger restricted to actions and events accessed by
+ * {@link AnalyticsDataRegulationController}.
+ */
+export type AnalyticsDataRegulationControllerMessenger = Messenger<typeof controllerName, AnalyticsDataRegulationControllerActions | AllowedActions, AnalyticsDataRegulationControllerEvents | AllowedEvents>;
+/**
+ * The options that AnalyticsDataRegulationController takes.
+ */
+export type AnalyticsDataRegulationControllerOptions = {
+    /**
+     * Initial controller state.
+     */
+    state?: Partial<AnalyticsDataRegulationControllerState>;
+    /**
+     * Messenger used to communicate with BaseController and other controllers.
+     */
+    messenger: AnalyticsDataRegulationControllerMessenger;
+    /**
+     * Analytics ID used for data deletion requests.
+     */
+    analyticsId: string;
+};
+/**
+ * The AnalyticsDataRegulationController manages analytics privacy and GDPR/CCPA data deletion functionality.
+ * It communicates with Segment's Regulations API via a proxy to create and monitor data deletion requests.
+ *
+ * This controller follows the MetaMask controller pattern and integrates with the
+ * messenger system to allow other controllers and components to manage data deletion tasks.
+ */
+export declare class AnalyticsDataRegulationController extends BaseController<typeof controllerName, AnalyticsDataRegulationControllerState, AnalyticsDataRegulationControllerMessenger> {
+    #private;
+    /**
+     * Constructs an AnalyticsDataRegulationController instance.
+     *
+     * @param options - Controller options
+     * @param options.state - Initial controller state. Use `getDefaultAnalyticsDataRegulationControllerState()` for defaults.
+     * @param options.messenger - Messenger used to communicate with BaseController
+     * @param options.analyticsId - Analytics ID used for data deletion requests
+     */
+    constructor({ state, messenger, analyticsId, }: AnalyticsDataRegulationControllerOptions);
+    /**
+     * Creates a new delete regulation for the user.
+     * This is necessary to respect the GDPR and CCPA regulations.
+     *
+     * @returns Promise containing the status of the request with regulateId
+     * @throws Error if analytics ID is missing or if the service call fails
+     */
+    createDataDeletionTask(): Promise<{
+        status: typeof DATA_DELETE_RESPONSE_STATUSES.Success;
+        regulateId: string;
+    }>;
+    /**
+     * Check the latest delete regulation status.
+     *
+     * @returns Promise containing the timestamp, delete status and collected data flag
+     */
+    checkDataDeleteStatus(): Promise<DeleteRegulationStatus>;
+    /**
+     * Update the data recording flag if needed.
+     * This method should be called after tracking events to ensure
+     * the data recording flag is properly updated for data deletion workflows.
+     *
+     * The flag can only be set to `true` (indicating data has been collected).
+     * It cannot be explicitly set to `false` - it is only reset to `false` when
+     * a new deletion task is created via `createDataDeletionTask`.
+     *
+     */
+    updateDataRecordingFlag(): void;
+}
+export {};
+//# sourceMappingURL=AnalyticsDataRegulationController.d.mts.map

package/dist/AnalyticsDataRegulationController.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AnalyticsDataRegulationController.d.mts","sourceRoot":"","sources":["../src/AnalyticsDataRegulationController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAE3B,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AAErD,OAAO,KAAK,EAAE,8CAA8C,EAAE,oEAAgE;AAC9H,OAAO,KAAK,EAAE,qCAAqC,EAAE,6CAAyC;AAE9F,OAAO,EAAE,6BAA6B,EAAwB,oBAAgB;AAC9E,OAAO,KAAK,EAAE,wBAAwB,EAAE,sBAAsB,EAAE,oBAAgB;AAIhF;;;;GAIG;AACH,eAAO,MAAM,cAAc,sCAAsC,CAAC;AAIlE;;GAEG;AACH,MAAM,MAAM,sCAAsC,GAAG;IACnD;;OAEG;IACH,oCAAoC,EAAE,OAAO,CAAC;IAE9C;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;;OAGG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;CACpC,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,gDAAgD,IAAI,sCAAsC,CAIzG;AAkCD;;GAEG;AACH,MAAM,MAAM,+CAA+C,GACzD,wBAAwB,CACtB,OAAO,cAAc,EACrB,sCAAsC,CACvC,CAAC;AAEJ;;GAEG;AACH,MAAM,MAAM,wCAAwC,GAChD,+CAA+C,GAC/C,8CAA8C,CAAC;AAEnD;;GAEG;AACH,KAAK,cAAc,GAAG,qCAAqC,CAAC;AAE5D;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACzC,IAAI,EAAE,GAAG,OAAO,cAAc,0BAA0B,CAAC;IACzD,OAAO,EAAE,CAAC,wBAAwB,CAAC,CAAC;CACrC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C,IAAI,EAAE,GAAG,OAAO,cAAc,2BAA2B,CAAC;IAC1D,OAAO,EAAE,CAAC,OAAO,CAAC,CAAC;CACpB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iDAAiD,GAC3D,0BAA0B,CACxB,OAAO,cAAc,EACrB,sCAAsC,CACvC,CAAC;AAEJ;;GAEG;AACH,MAAM,MAAM,uCAAuC,GAC/C,iDAAiD,GACjD,4BAA4B,GAC5B,6BAA6B,CAAC;AAElC;;GAEG;AACH,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,0CAA0C,GAAG,SAAS,CAChE,OAAO,cAAc,EACrB,wCAAwC,GAAG,cAAc,EACzD,uCAAuC,GAAG,aAAa,CACxD,CAAC;AAIF;;GAEG;AACH,MAAM,MAAM,wCAAwC,GAAG;IACrD;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC,sCAAsC,CAAC,CAAC;IACxD;;OAEG;IACH,SAAS,EAAE,0CAA0C,CAAC;IACtD;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;;;;;GAMG;AACH,qBAAa,iCAAkC,SAAQ,cAAc,CACnE,OAAO,cAAc,EACrB,sCAAsC,EACtC,0CAA0C,CAC3C;;IAMC;;;;;;;OAOG;gBACS,EACV,KAAU,EACV,SAAS,EACT,WAAW,GACZ,EAAE,wCAAwC;IA4B3C;;;;;;OAMG;IACG,sBAAsB,IAAI,OAAO,CAAC;QACtC,MAAM,EAAE,OAAO,6BAA6B,CAAC,OAAO,CAAC;QACrD,UAAU,EAAE,MAAM,CAAC;KACpB,CAAC;IA+BF;;;;OAIG;IACG,qBAAqB,IAAI,OAAO,CAAC,sBAAsB,CAAC;IA6B9D;;;;;;;;;OASG;IACH,uBAAuB,IAAI,IAAI;CAYhC"}

package/dist/AnalyticsDataRegulationController.mjs

@@ -0,0 +1,171 @@
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _AnalyticsDataRegulationController_analyticsId;
+import { BaseController } from "@metamask/base-controller";
+import { projectLogger as log } from "./logger.mjs";
+import { DATA_DELETE_RESPONSE_STATUSES, DATA_DELETE_STATUSES } from "./types.mjs";
+// === GENERAL ===
+/**
+ * The name of the {@link AnalyticsDataRegulationController}, used to namespace the
+ * controller's actions and events and to namespace the controller's state data
+ * when composed with other controllers.
+ */
+export const controllerName = 'AnalyticsDataRegulationController';
+/**
+ * Returns default values for AnalyticsDataRegulationController state.
+ *
+ * @returns Default state
+ */
+export function getDefaultAnalyticsDataRegulationControllerState() {
+    return {
+        hasCollectedDataSinceDeletionRequest: false,
+    };
+}
+/**
+ * The metadata for each property in {@link AnalyticsDataRegulationControllerState}.
+ */
+const analyticsDataRegulationControllerMetadata = {
+    hasCollectedDataSinceDeletionRequest: {
+        includeInStateLogs: true,
+        persist: true,
+        includeInDebugSnapshot: true,
+        usedInUi: true,
+    },
+    deleteRegulationId: {
+        includeInStateLogs: true,
+        persist: true,
+        includeInDebugSnapshot: true,
+        usedInUi: true,
+    },
+    deleteRegulationTimestamp: {
+        includeInStateLogs: true,
+        persist: true,
+        includeInDebugSnapshot: true,
+        usedInUi: true,
+    },
+};
+// === MESSENGER ===
+const MESSENGER_EXPOSED_METHODS = [
+    'createDataDeletionTask',
+    'checkDataDeleteStatus',
+    'updateDataRecordingFlag',
+];
+/**
+ * The AnalyticsDataRegulationController manages analytics privacy and GDPR/CCPA data deletion functionality.
+ * It communicates with Segment's Regulations API via a proxy to create and monitor data deletion requests.
+ *
+ * This controller follows the MetaMask controller pattern and integrates with the
+ * messenger system to allow other controllers and components to manage data deletion tasks.
+ */
+export class AnalyticsDataRegulationController extends BaseController {
+    /**
+     * Constructs an AnalyticsDataRegulationController instance.
+     *
+     * @param options - Controller options
+     * @param options.state - Initial controller state. Use `getDefaultAnalyticsDataRegulationControllerState()` for defaults.
+     * @param options.messenger - Messenger used to communicate with BaseController
+     * @param options.analyticsId - Analytics ID used for data deletion requests
+     */
+    constructor({ state = {}, messenger, analyticsId, }) {
+        const initialState = {
+            ...getDefaultAnalyticsDataRegulationControllerState(),
+            ...state,
+        };
+        super({
+            name: controllerName,
+            metadata: analyticsDataRegulationControllerMetadata,
+            state: initialState,
+            messenger,
+        });
+        /**
+         * Analytics ID used for data deletion requests.
+         */
+        _AnalyticsDataRegulationController_analyticsId.set(this, void 0);
+        __classPrivateFieldSet(this, _AnalyticsDataRegulationController_analyticsId, analyticsId, "f");
+        this.messenger.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
+        log('AnalyticsDataRegulationController initialized', {
+            hasCollectedDataSinceDeletionRequest: this.state.hasCollectedDataSinceDeletionRequest,
+            hasDeleteRegulationId: Boolean(this.state.deleteRegulationId),
+            deleteRegulationTimestamp: this.state.deleteRegulationTimestamp,
+        });
+    }
+    /**
+     * Creates a new delete regulation for the user.
+     * This is necessary to respect the GDPR and CCPA regulations.
+     *
+     * @returns Promise containing the status of the request with regulateId
+     * @throws Error if analytics ID is missing or if the service call fails
+     */
+    async createDataDeletionTask() {
+        if (!__classPrivateFieldGet(this, _AnalyticsDataRegulationController_analyticsId, "f") || __classPrivateFieldGet(this, _AnalyticsDataRegulationController_analyticsId, "f").trim() === '') {
+            const error = new Error('Analytics ID not found. You need to provide a valid analytics ID when initializing the AnalyticsDataRegulationController.');
+            log('Analytics Deletion Task Error', error);
+            throw error;
+        }
+        const response = await this.messenger.call('AnalyticsDataRegulationService:createDataDeletionTask', __classPrivateFieldGet(this, _AnalyticsDataRegulationController_analyticsId, "f"));
+        const deletionTimestamp = Date.now();
+        // Service validates and throws on all errors, so if we reach here, the response
+        // is guaranteed to be a success response with regulateId present
+        this.update((state) => {
+            state.deleteRegulationId = response.regulateId;
+            state.deleteRegulationTimestamp = deletionTimestamp;
+            state.hasCollectedDataSinceDeletionRequest = false;
+        });
+        this.messenger.publish(`${controllerName}:dataDeletionTaskCreated`, response);
+        return response;
+    }
+    /**
+     * Check the latest delete regulation status.
+     *
+     * @returns Promise containing the timestamp, delete status and collected data flag
+     */
+    async checkDataDeleteStatus() {
+        // Capture all state values before async call to ensure consistency
+        // in case createDataDeletionTask() completes concurrently
+        const { deleteRegulationId } = this.state;
+        const { deleteRegulationTimestamp } = this.state;
+        const { hasCollectedDataSinceDeletionRequest } = this.state;
+        const status = {
+            deletionRequestTimestamp: deleteRegulationTimestamp,
+            dataDeletionRequestStatus: DATA_DELETE_STATUSES.Unknown,
+            hasCollectedDataSinceDeletionRequest,
+        };
+        if (!deleteRegulationId) {
+            return status;
+        }
+        // Service validates and throws on all errors, so if we reach here, the response
+        // is guaranteed to be a success response with dataDeleteStatus present
+        const dataDeletionTaskStatus = await this.messenger.call('AnalyticsDataRegulationService:checkDataDeleteStatus', deleteRegulationId);
+        status.dataDeletionRequestStatus = dataDeletionTaskStatus.dataDeleteStatus;
+        return status;
+    }
+    /**
+     * Update the data recording flag if needed.
+     * This method should be called after tracking events to ensure
+     * the data recording flag is properly updated for data deletion workflows.
+     *
+     * The flag can only be set to `true` (indicating data has been collected).
+     * It cannot be explicitly set to `false` - it is only reset to `false` when
+     * a new deletion task is created via `createDataDeletionTask`.
+     *
+     */
+    updateDataRecordingFlag() {
+        if (!this.state.hasCollectedDataSinceDeletionRequest) {
+            this.update((state) => {
+                state.hasCollectedDataSinceDeletionRequest = true;
+            });
+            this.messenger.publish(`${controllerName}:dataRecordingFlagUpdated`, true);
+        }
+    }
+}
+_AnalyticsDataRegulationController_analyticsId = new WeakMap();
+//# sourceMappingURL=AnalyticsDataRegulationController.mjs.map

package/dist/AnalyticsDataRegulationController.mjs.map

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

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"AnalyticsDataRegulationService-method-action-types.cjs","sourceRoot":"","sources":["../src/AnalyticsDataRegulationService-method-action-types.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated by `scripts/generate-method-action-types.ts`.\n * Do not edit manually.\n */\n\nimport type { AnalyticsDataRegulationService } from './AnalyticsDataRegulationService';\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"]}

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

@@ -0,0 +1,32 @@
+/**
+ * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * Do not edit manually.
+ */
+import type { AnalyticsDataRegulationService } from "./AnalyticsDataRegulationService.cjs";
+/**
+ * Creates a DELETE_ONLY regulation for the given analyticsId.
+ *
+ * @param analyticsId - The analytics ID of the user for whom to create the deletion task.
+ * @returns Promise resolving to a successful deletion regulation response.
+ * @throws Error if the request fails or the response is invalid.
+ */
+export type AnalyticsDataRegulationServiceCreateDataDeletionTaskAction = {
+    type: `AnalyticsDataRegulationService:createDataDeletionTask`;
+    handler: AnalyticsDataRegulationService['createDataDeletionTask'];
+};
+/**
+ * Checks the status of a regulation by ID.
+ *
+ * @param regulationId - The regulation ID to check.
+ * @returns Promise resolving to a successful regulation status response.
+ * @throws Error if the request fails or the response is invalid.
+ */
+export type AnalyticsDataRegulationServiceCheckDataDeleteStatusAction = {
+    type: `AnalyticsDataRegulationService:checkDataDeleteStatus`;
+    handler: AnalyticsDataRegulationService['checkDataDeleteStatus'];
+};
+/**
+ * Union of all AnalyticsDataRegulationService action types.
+ */
+export type AnalyticsDataRegulationServiceMethodActions = AnalyticsDataRegulationServiceCreateDataDeletionTaskAction | AnalyticsDataRegulationServiceCheckDataDeleteStatusAction;
+//# sourceMappingURL=AnalyticsDataRegulationService-method-action-types.d.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"AnalyticsDataRegulationService-method-action-types.d.cts","sourceRoot":"","sources":["../src/AnalyticsDataRegulationService-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,8BAA8B,EAAE,6CAAyC;AAEvF;;;;;;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"}

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

@@ -0,0 +1,32 @@
+/**
+ * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * Do not edit manually.
+ */
+import type { AnalyticsDataRegulationService } from "./AnalyticsDataRegulationService.mjs";
+/**
+ * Creates a DELETE_ONLY regulation for the given analyticsId.
+ *
+ * @param analyticsId - The analytics ID of the user for whom to create the deletion task.
+ * @returns Promise resolving to a successful deletion regulation response.
+ * @throws Error if the request fails or the response is invalid.
+ */
+export type AnalyticsDataRegulationServiceCreateDataDeletionTaskAction = {
+    type: `AnalyticsDataRegulationService:createDataDeletionTask`;
+    handler: AnalyticsDataRegulationService['createDataDeletionTask'];
+};
+/**
+ * Checks the status of a regulation by ID.
+ *
+ * @param regulationId - The regulation ID to check.
+ * @returns Promise resolving to a successful regulation status response.
+ * @throws Error if the request fails or the response is invalid.
+ */
+export type AnalyticsDataRegulationServiceCheckDataDeleteStatusAction = {
+    type: `AnalyticsDataRegulationService:checkDataDeleteStatus`;
+    handler: AnalyticsDataRegulationService['checkDataDeleteStatus'];
+};
+/**
+ * Union of all AnalyticsDataRegulationService action types.
+ */
+export type AnalyticsDataRegulationServiceMethodActions = AnalyticsDataRegulationServiceCreateDataDeletionTaskAction | AnalyticsDataRegulationServiceCheckDataDeleteStatusAction;
+//# sourceMappingURL=AnalyticsDataRegulationService-method-action-types.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"AnalyticsDataRegulationService-method-action-types.d.mts","sourceRoot":"","sources":["../src/AnalyticsDataRegulationService-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,8BAA8B,EAAE,6CAAyC;AAEvF;;;;;;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"}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"AnalyticsDataRegulationService-method-action-types.mjs","sourceRoot":"","sources":["../src/AnalyticsDataRegulationService-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated by `scripts/generate-method-action-types.ts`.\n * Do not edit manually.\n */\n\nimport type { AnalyticsDataRegulationService } from './AnalyticsDataRegulationService';\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"]}