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

package/dist/AnalyticsDataRegulationService.cjs

@@ -0,0 +1,247 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _AnalyticsDataRegulationService_messenger, _AnalyticsDataRegulationService_fetch, _AnalyticsDataRegulationService_segmentSourceId, _AnalyticsDataRegulationService_segmentRegulationsEndpoint, _AnalyticsDataRegulationService_policy;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AnalyticsDataRegulationService = exports.serviceName = void 0;
+const controller_utils_1 = require("@metamask/controller-utils");
+const types_1 = require("./types.cjs");
+/**
+ * Segment API regulation type for DELETE_ONLY operations.
+ */
+const SEGMENT_REGULATION_TYPE_DELETE_ONLY = 'DELETE_ONLY';
+/**
+ * Segment API subject type for user ID operations.
+ */
+const SEGMENT_SUBJECT_TYPE_USER_ID = 'USER_ID';
+/**
+ * Segment API Content-Type header value.
+ */
+const SEGMENT_CONTENT_TYPE = 'application/vnd.segment.v1+json';
+// === GENERAL ===
+/**
+ * The name of the {@link AnalyticsDataRegulationService}, used to namespace the
+ * service's actions and events.
+ */
+exports.serviceName = 'AnalyticsDataRegulationService';
+// === MESSENGER ===
+const MESSENGER_EXPOSED_METHODS = [
+    'createDataDeletionTask',
+    'checkDataDeleteStatus',
+];
+/**
+ * Type guard to check if a value is a valid DataDeleteStatus.
+ *
+ * @param status - The value to check.
+ * @returns True if the value is a valid DataDeleteStatus.
+ */
+function isDataDeleteStatus(status) {
+    const dataDeleteStatuses = Object.values(types_1.DATA_DELETE_STATUSES);
+    return dataDeleteStatuses.includes(status);
+}
+/**
+ * This service object is responsible for making requests to the Segment Regulations API
+ * via a proxy endpoint for GDPR/CCPA data deletion functionality.
+ *
+ * @example
+ *
+ * ```ts
+ * import { Messenger } from '@metamask/messenger';
+ * import type {
+ *   AnalyticsDataRegulationServiceActions,
+ *   AnalyticsDataRegulationServiceEvents,
+ * } from '@metamask/analytics-data-regulation-controller';
+ *
+ * const rootMessenger = new Messenger<
+ *   'Root',
+ *   AnalyticsDataRegulationServiceActions,
+ *   AnalyticsDataRegulationServiceEvents
+ * >({ namespace: 'Root' });
+ * const serviceMessenger = new Messenger<
+ *   'AnalyticsDataRegulationService',
+ *   AnalyticsDataRegulationServiceActions,
+ *   AnalyticsDataRegulationServiceEvents,
+ *   typeof rootMessenger,
+ * >({
+ *   namespace: 'AnalyticsDataRegulationService',
+ *   parent: rootMessenger,
+ * });
+ * // Instantiate the service to register its actions on the messenger
+ * new AnalyticsDataRegulationService({
+ *   messenger: serviceMessenger,
+ *   fetch,
+ *   segmentSourceId: 'abc123',
+ *   segmentRegulationsEndpoint: 'https://proxy.example.com/v1beta',
+ * });
+ *
+ * // Later...
+ * // Create a data deletion task
+ * const response = await rootMessenger.call(
+ *   'AnalyticsDataRegulationService:createDataDeletionTask',
+ *   'user-analytics-id',
+ * );
+ * ```
+ */
+class AnalyticsDataRegulationService {
+    /**
+     * Constructs a new AnalyticsDataRegulationService object.
+     *
+     * @param options - The constructor options.
+     */
+    constructor(options) {
+        /**
+         * The messenger suited for this service.
+         */
+        _AnalyticsDataRegulationService_messenger.set(this, void 0);
+        /**
+         * A function that can be used to make an HTTP request.
+         */
+        _AnalyticsDataRegulationService_fetch.set(this, void 0);
+        /**
+         * Segment API source ID.
+         */
+        _AnalyticsDataRegulationService_segmentSourceId.set(this, void 0);
+        /**
+         * Base URL for the proxy endpoint that communicates with Segment's Regulations API.
+         * This endpoint varies by environment and forwards requests to Segment API with authentication.
+         */
+        _AnalyticsDataRegulationService_segmentRegulationsEndpoint.set(this, void 0);
+        /**
+         * The policy that wraps the request.
+         *
+         * @see {@link createServicePolicy}
+         */
+        _AnalyticsDataRegulationService_policy.set(this, void 0);
+        this.name = exports.serviceName;
+        __classPrivateFieldSet(this, _AnalyticsDataRegulationService_messenger, options.messenger, "f");
+        __classPrivateFieldSet(this, _AnalyticsDataRegulationService_fetch, options.fetch, "f");
+        __classPrivateFieldSet(this, _AnalyticsDataRegulationService_segmentSourceId, options.segmentSourceId, "f");
+        __classPrivateFieldSet(this, _AnalyticsDataRegulationService_segmentRegulationsEndpoint, options.segmentRegulationsEndpoint, "f");
+        __classPrivateFieldSet(this, _AnalyticsDataRegulationService_policy, (0, controller_utils_1.createServicePolicy)(options.policyOptions ?? {}), "f");
+        __classPrivateFieldGet(this, _AnalyticsDataRegulationService_messenger, "f").registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
+    }
+    /**
+     * Registers a handler that will be called after a request returns a non-500
+     * response, causing a retry. Primarily useful in tests where timers are being
+     * mocked.
+     *
+     * @param listener - The handler to be called.
+     * @returns An object that can be used to unregister the handler.
+     * @see {@link createServicePolicy}
+     */
+    onRetry(listener) {
+        return __classPrivateFieldGet(this, _AnalyticsDataRegulationService_policy, "f").onRetry(listener);
+    }
+    /**
+     * Registers a handler that will be called after a set number of retry rounds
+     * prove that requests to the API endpoint consistently return a 5xx response.
+     *
+     * @param listener - The handler to be called.
+     * @returns An object that can be used to unregister the handler.
+     * @see {@link createServicePolicy}
+     */
+    onBreak(listener) {
+        return __classPrivateFieldGet(this, _AnalyticsDataRegulationService_policy, "f").onBreak(listener);
+    }
+    /**
+     * Registers a handler that will be called under one of two circumstances:
+     *
+     * 1. After a set number of retries prove that requests to the API
+     * consistently result in failures.
+     * 2. After a successful request is made to the API, but the response takes
+     * longer than a set duration to return.
+     *
+     * @param listener - The handler to be called.
+     * @returns An object that can be used to unregister the handler.
+     */
+    onDegraded(listener) {
+        return __classPrivateFieldGet(this, _AnalyticsDataRegulationService_policy, "f").onDegraded(listener);
+    }
+    /**
+     * 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.
+     */
+    async createDataDeletionTask(analyticsId) {
+        if (!__classPrivateFieldGet(this, _AnalyticsDataRegulationService_segmentSourceId, "f") || !__classPrivateFieldGet(this, _AnalyticsDataRegulationService_segmentRegulationsEndpoint, "f")) {
+            throw new Error('Segment API source ID or endpoint not found');
+        }
+        const url = `${__classPrivateFieldGet(this, _AnalyticsDataRegulationService_segmentRegulationsEndpoint, "f")}/regulations/sources/${__classPrivateFieldGet(this, _AnalyticsDataRegulationService_segmentSourceId, "f")}`;
+        const body = JSON.stringify({
+            regulationType: SEGMENT_REGULATION_TYPE_DELETE_ONLY,
+            subjectType: SEGMENT_SUBJECT_TYPE_USER_ID,
+            subjectIds: [analyticsId],
+        });
+        const response = await __classPrivateFieldGet(this, _AnalyticsDataRegulationService_policy, "f").execute(async () => {
+            const localResponse = await __classPrivateFieldGet(this, _AnalyticsDataRegulationService_fetch, "f").call(this, url, {
+                method: 'POST',
+                headers: {
+                    'Content-Type': SEGMENT_CONTENT_TYPE,
+                },
+                body,
+            });
+            if (!localResponse.ok) {
+                throw new controller_utils_1.HttpError(localResponse.status, `Creating data deletion task failed with status '${localResponse.status}'`);
+            }
+            return localResponse;
+        });
+        const jsonResponse = (await response.json());
+        if (!jsonResponse?.data?.data?.regulateId ||
+            typeof jsonResponse.data.data.regulateId !== 'string' ||
+            jsonResponse.data.data.regulateId.trim() === '') {
+            throw new Error('Malformed response from Segment API: missing or invalid regulateId');
+        }
+        return {
+            status: types_1.DATA_DELETE_RESPONSE_STATUSES.Success,
+            regulateId: jsonResponse.data.data.regulateId,
+        };
+    }
+    /**
+     * 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.
+     */
+    async checkDataDeleteStatus(regulationId) {
+        if (!regulationId || !__classPrivateFieldGet(this, _AnalyticsDataRegulationService_segmentRegulationsEndpoint, "f")) {
+            throw new Error('Regulation ID or endpoint not configured');
+        }
+        const url = `${__classPrivateFieldGet(this, _AnalyticsDataRegulationService_segmentRegulationsEndpoint, "f")}/regulations/${regulationId}`;
+        const response = await __classPrivateFieldGet(this, _AnalyticsDataRegulationService_policy, "f").execute(async () => {
+            const localResponse = await __classPrivateFieldGet(this, _AnalyticsDataRegulationService_fetch, "f").call(this, url, {
+                method: 'GET',
+                headers: {
+                    'Content-Type': SEGMENT_CONTENT_TYPE,
+                },
+            });
+            if (!localResponse.ok) {
+                throw new controller_utils_1.HttpError(localResponse.status, `Checking data deletion status failed with status '${localResponse.status}'`);
+            }
+            return localResponse;
+        });
+        const jsonResponse = (await response.json());
+        const rawStatus = jsonResponse?.data?.data?.regulation?.overallStatus;
+        const dataDeleteStatus = isDataDeleteStatus(rawStatus)
+            ? rawStatus
+            : types_1.DATA_DELETE_STATUSES.Unknown;
+        return {
+            status: types_1.DATA_DELETE_RESPONSE_STATUSES.Success,
+            dataDeleteStatus,
+        };
+    }
+}
+exports.AnalyticsDataRegulationService = AnalyticsDataRegulationService;
+_AnalyticsDataRegulationService_messenger = new WeakMap(), _AnalyticsDataRegulationService_fetch = new WeakMap(), _AnalyticsDataRegulationService_segmentSourceId = new WeakMap(), _AnalyticsDataRegulationService_segmentRegulationsEndpoint = new WeakMap(), _AnalyticsDataRegulationService_policy = new WeakMap();
+//# sourceMappingURL=AnalyticsDataRegulationService.cjs.map

package/dist/AnalyticsDataRegulationService.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"AnalyticsDataRegulationService.cjs","sourceRoot":"","sources":["../src/AnalyticsDataRegulationService.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAIA,iEAA4E;AAK5E,uCAA8E;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;AACU,QAAA,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,4BAAoB,CAAC,CAAC;IACzE,OAAO,kBAAkB,CAAC,QAAQ,CAAC,MAAgB,CAAC,CAAC;AACvD,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,MAAa,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,mBAAW,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,IAAA,sCAAmB,EAAC,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,4BAAS,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,qCAA6B,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,4BAAS,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,4BAAoB,CAAC,OAAO,CAAC;QAEjC,OAAO;YACL,MAAM,EAAE,qCAA6B,CAAC,OAAO;YAC7C,gBAAgB;SACjB,CAAC;IACJ,CAAC;CACF;AAzMD,wEAyMC","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/AnalyticsDataRegulationService.d.cts

@@ -0,0 +1,172 @@
+import type { CreateServicePolicyOptions, ServicePolicy } from "@metamask/controller-utils";
+import type { Messenger } from "@metamask/messenger";
+import type { IDisposable } from "cockatiel";
+import type { AnalyticsDataRegulationServiceMethodActions } from "./AnalyticsDataRegulationService-method-action-types.cjs";
+import { DATA_DELETE_RESPONSE_STATUSES } from "./types.cjs";
+import type { DataDeleteStatus } from "./types.cjs";
+/**
+ * The name of the {@link AnalyticsDataRegulationService}, used to namespace the
+ * service's actions and events.
+ */
+export declare const serviceName = "AnalyticsDataRegulationService";
+/**
+ * Actions that {@link AnalyticsDataRegulationService} exposes to other consumers.
+ */
+export type AnalyticsDataRegulationServiceActions = AnalyticsDataRegulationServiceMethodActions;
+/**
+ * Actions from other messengers that {@link AnalyticsDataRegulationServiceMessenger} calls.
+ */
+type AllowedActions = never;
+/**
+ * Events that {@link AnalyticsDataRegulationService} exposes to other consumers.
+ */
+export type AnalyticsDataRegulationServiceEvents = never;
+/**
+ * Events from other messengers that {@link AnalyticsDataRegulationService} subscribes to.
+ */
+type AllowedEvents = never;
+/**
+ * The messenger which is restricted to actions and events accessed by
+ * {@link AnalyticsDataRegulationService}.
+ */
+export type AnalyticsDataRegulationServiceMessenger = Messenger<typeof serviceName, AnalyticsDataRegulationServiceActions | AllowedActions, AnalyticsDataRegulationServiceEvents | AllowedEvents>;
+/**
+ * Options for constructing {@link AnalyticsDataRegulationService}.
+ */
+export type AnalyticsDataRegulationServiceOptions = {
+    /**
+     * The messenger suited for this service.
+     */
+    messenger: AnalyticsDataRegulationServiceMessenger;
+    /**
+     * A function that can be used to make an HTTP request.
+     */
+    fetch: typeof fetch;
+    /**
+     * Segment API source ID (required for creating regulations).
+     */
+    segmentSourceId: string;
+    /**
+     * Base URL for the proxy endpoint that communicates with Segment's Regulations API.
+     * This is a proxy endpoint (not Segment API directly) that forwards requests to Segment's
+     * Regulations API and adds authentication tokens. The endpoint URL varies by environment
+     * (e.g., development, staging, production) and should be configured accordingly.
+     * Example: 'https://proxy.example.com/v1beta'
+     */
+    segmentRegulationsEndpoint: string;
+    /**
+     * Options to pass to `createServicePolicy`, which is used to wrap each request.
+     */
+    policyOptions?: CreateServicePolicyOptions;
+};
+/**
+ * This service object is responsible for making requests to the Segment Regulations API
+ * via a proxy endpoint for GDPR/CCPA data deletion functionality.
+ *
+ * @example
+ *
+ * ```ts
+ * import { Messenger } from '@metamask/messenger';
+ * import type {
+ *   AnalyticsDataRegulationServiceActions,
+ *   AnalyticsDataRegulationServiceEvents,
+ * } from '@metamask/analytics-data-regulation-controller';
+ *
+ * const rootMessenger = new Messenger<
+ *   'Root',
+ *   AnalyticsDataRegulationServiceActions,
+ *   AnalyticsDataRegulationServiceEvents
+ * >({ namespace: 'Root' });
+ * const serviceMessenger = new Messenger<
+ *   'AnalyticsDataRegulationService',
+ *   AnalyticsDataRegulationServiceActions,
+ *   AnalyticsDataRegulationServiceEvents,
+ *   typeof rootMessenger,
+ * >({
+ *   namespace: 'AnalyticsDataRegulationService',
+ *   parent: rootMessenger,
+ * });
+ * // Instantiate the service to register its actions on the messenger
+ * new AnalyticsDataRegulationService({
+ *   messenger: serviceMessenger,
+ *   fetch,
+ *   segmentSourceId: 'abc123',
+ *   segmentRegulationsEndpoint: 'https://proxy.example.com/v1beta',
+ * });
+ *
+ * // Later...
+ * // Create a data deletion task
+ * const response = await rootMessenger.call(
+ *   'AnalyticsDataRegulationService:createDataDeletionTask',
+ *   'user-analytics-id',
+ * );
+ * ```
+ */
+export declare class AnalyticsDataRegulationService {
+    #private;
+    /**
+     * The name of the service.
+     */
+    readonly name: typeof serviceName;
+    /**
+     * Constructs a new AnalyticsDataRegulationService object.
+     *
+     * @param options - The constructor options.
+     */
+    constructor(options: AnalyticsDataRegulationServiceOptions);
+    /**
+     * Registers a handler that will be called after a request returns a non-500
+     * response, causing a retry. Primarily useful in tests where timers are being
+     * mocked.
+     *
+     * @param listener - The handler to be called.
+     * @returns An object that can be used to unregister the handler.
+     * @see {@link createServicePolicy}
+     */
+    onRetry(listener: Parameters<ServicePolicy['onRetry']>[0]): IDisposable;
+    /**
+     * Registers a handler that will be called after a set number of retry rounds
+     * prove that requests to the API endpoint consistently return a 5xx response.
+     *
+     * @param listener - The handler to be called.
+     * @returns An object that can be used to unregister the handler.
+     * @see {@link createServicePolicy}
+     */
+    onBreak(listener: Parameters<ServicePolicy['onBreak']>[0]): IDisposable;
+    /**
+     * Registers a handler that will be called under one of two circumstances:
+     *
+     * 1. After a set number of retries prove that requests to the API
+     * consistently result in failures.
+     * 2. After a successful request is made to the API, but the response takes
+     * longer than a set duration to return.
+     *
+     * @param listener - The handler to be called.
+     * @returns An object that can be used to unregister the handler.
+     */
+    onDegraded(listener: Parameters<ServicePolicy['onDegraded']>[0]): IDisposable;
+    /**
+     * 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.
+     */
+    createDataDeletionTask(analyticsId: string): Promise<{
+        status: typeof DATA_DELETE_RESPONSE_STATUSES.Success;
+        regulateId: string;
+    }>;
+    /**
+     * 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.
+     */
+    checkDataDeleteStatus(regulationId: string): Promise<{
+        status: typeof DATA_DELETE_RESPONSE_STATUSES.Success;
+        dataDeleteStatus: DataDeleteStatus;
+    }>;
+}
+export {};
+//# sourceMappingURL=AnalyticsDataRegulationService.d.cts.map

package/dist/AnalyticsDataRegulationService.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AnalyticsDataRegulationService.d.cts","sourceRoot":"","sources":["../src/AnalyticsDataRegulationService.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,0BAA0B,EAC1B,aAAa,EACd,mCAAmC;AAEpC,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AACrD,OAAO,KAAK,EAAE,WAAW,EAAE,kBAAkB;AAE7C,OAAO,KAAK,EAAE,2CAA2C,EAAE,iEAA6D;AACxH,OAAO,EAAE,6BAA6B,EAAwB,oBAAgB;AAC9E,OAAO,KAAK,EAAE,gBAAgB,EAAE,oBAAgB;AAmBhD;;;GAGG;AACH,eAAO,MAAM,WAAW,mCAAmC,CAAC;AAS5D;;GAEG;AACH,MAAM,MAAM,qCAAqC,GAC/C,2CAA2C,CAAC;AAE9C;;GAEG;AACH,KAAK,cAAc,GAAG,KAAK,CAAC;AAE5B;;GAEG;AACH,MAAM,MAAM,oCAAoC,GAAG,KAAK,CAAC;AAEzD;;GAEG;AACH,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,uCAAuC,GAAG,SAAS,CAC7D,OAAO,WAAW,EAClB,qCAAqC,GAAG,cAAc,EACtD,oCAAoC,GAAG,aAAa,CACrD,CAAC;AA4BF;;GAEG;AACH,MAAM,MAAM,qCAAqC,GAAG;IAClD;;OAEG;IACH,SAAS,EAAE,uCAAuC,CAAC;IAEnD;;OAEG;IACH,KAAK,EAAE,OAAO,KAAK,CAAC;IAEpB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;;;OAMG;IACH,0BAA0B,EAAE,MAAM,CAAC;IAEnC;;OAEG;IACH,aAAa,CAAC,EAAE,0BAA0B,CAAC;CAC5C,CAAC;AAaF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,qBAAa,8BAA8B;;IACzC;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,OAAO,WAAW,CAAC;IA8BlC;;;;OAIG;gBACS,OAAO,EAAE,qCAAqC;IAc1D;;;;;;;;OAQG;IACH,OAAO,CAAC,QAAQ,EAAE,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW;IAIvE;;;;;;;OAOG;IACH,OAAO,CAAC,QAAQ,EAAE,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW;IAIvE;;;;;;;;;;OAUG;IACH,UAAU,CACR,QAAQ,EAAE,UAAU,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,GACnD,WAAW;IAId;;;;;;OAMG;IACG,sBAAsB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC;QACzD,MAAM,EAAE,OAAO,6BAA6B,CAAC,OAAO,CAAC;QACrD,UAAU,EAAE,MAAM,CAAC;KACpB,CAAC;IAiDF;;;;;;OAMG;IACG,qBAAqB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC;QACzD,MAAM,EAAE,OAAO,6BAA6B,CAAC,OAAO,CAAC;QACrD,gBAAgB,EAAE,gBAAgB,CAAC;KACpC,CAAC;CAqCH"}

package/dist/AnalyticsDataRegulationService.d.mts

@@ -0,0 +1,172 @@
+import type { CreateServicePolicyOptions, ServicePolicy } from "@metamask/controller-utils";
+import type { Messenger } from "@metamask/messenger";
+import type { IDisposable } from "cockatiel";
+import type { AnalyticsDataRegulationServiceMethodActions } from "./AnalyticsDataRegulationService-method-action-types.mjs";
+import { DATA_DELETE_RESPONSE_STATUSES } from "./types.mjs";
+import type { DataDeleteStatus } from "./types.mjs";
+/**
+ * The name of the {@link AnalyticsDataRegulationService}, used to namespace the
+ * service's actions and events.
+ */
+export declare const serviceName = "AnalyticsDataRegulationService";
+/**
+ * Actions that {@link AnalyticsDataRegulationService} exposes to other consumers.
+ */
+export type AnalyticsDataRegulationServiceActions = AnalyticsDataRegulationServiceMethodActions;
+/**
+ * Actions from other messengers that {@link AnalyticsDataRegulationServiceMessenger} calls.
+ */
+type AllowedActions = never;
+/**
+ * Events that {@link AnalyticsDataRegulationService} exposes to other consumers.
+ */
+export type AnalyticsDataRegulationServiceEvents = never;
+/**
+ * Events from other messengers that {@link AnalyticsDataRegulationService} subscribes to.
+ */
+type AllowedEvents = never;
+/**
+ * The messenger which is restricted to actions and events accessed by
+ * {@link AnalyticsDataRegulationService}.
+ */
+export type AnalyticsDataRegulationServiceMessenger = Messenger<typeof serviceName, AnalyticsDataRegulationServiceActions | AllowedActions, AnalyticsDataRegulationServiceEvents | AllowedEvents>;
+/**
+ * Options for constructing {@link AnalyticsDataRegulationService}.
+ */
+export type AnalyticsDataRegulationServiceOptions = {
+    /**
+     * The messenger suited for this service.
+     */
+    messenger: AnalyticsDataRegulationServiceMessenger;
+    /**
+     * A function that can be used to make an HTTP request.
+     */
+    fetch: typeof fetch;
+    /**
+     * Segment API source ID (required for creating regulations).
+     */
+    segmentSourceId: string;
+    /**
+     * Base URL for the proxy endpoint that communicates with Segment's Regulations API.
+     * This is a proxy endpoint (not Segment API directly) that forwards requests to Segment's
+     * Regulations API and adds authentication tokens. The endpoint URL varies by environment
+     * (e.g., development, staging, production) and should be configured accordingly.
+     * Example: 'https://proxy.example.com/v1beta'
+     */
+    segmentRegulationsEndpoint: string;
+    /**
+     * Options to pass to `createServicePolicy`, which is used to wrap each request.
+     */
+    policyOptions?: CreateServicePolicyOptions;
+};
+/**
+ * This service object is responsible for making requests to the Segment Regulations API
+ * via a proxy endpoint for GDPR/CCPA data deletion functionality.
+ *
+ * @example
+ *
+ * ```ts
+ * import { Messenger } from '@metamask/messenger';
+ * import type {
+ *   AnalyticsDataRegulationServiceActions,
+ *   AnalyticsDataRegulationServiceEvents,
+ * } from '@metamask/analytics-data-regulation-controller';
+ *
+ * const rootMessenger = new Messenger<
+ *   'Root',
+ *   AnalyticsDataRegulationServiceActions,
+ *   AnalyticsDataRegulationServiceEvents
+ * >({ namespace: 'Root' });
+ * const serviceMessenger = new Messenger<
+ *   'AnalyticsDataRegulationService',
+ *   AnalyticsDataRegulationServiceActions,
+ *   AnalyticsDataRegulationServiceEvents,
+ *   typeof rootMessenger,
+ * >({
+ *   namespace: 'AnalyticsDataRegulationService',
+ *   parent: rootMessenger,
+ * });
+ * // Instantiate the service to register its actions on the messenger
+ * new AnalyticsDataRegulationService({
+ *   messenger: serviceMessenger,
+ *   fetch,
+ *   segmentSourceId: 'abc123',
+ *   segmentRegulationsEndpoint: 'https://proxy.example.com/v1beta',
+ * });
+ *
+ * // Later...
+ * // Create a data deletion task
+ * const response = await rootMessenger.call(
+ *   'AnalyticsDataRegulationService:createDataDeletionTask',
+ *   'user-analytics-id',
+ * );
+ * ```
+ */
+export declare class AnalyticsDataRegulationService {
+    #private;
+    /**
+     * The name of the service.
+     */
+    readonly name: typeof serviceName;
+    /**
+     * Constructs a new AnalyticsDataRegulationService object.
+     *
+     * @param options - The constructor options.
+     */
+    constructor(options: AnalyticsDataRegulationServiceOptions);
+    /**
+     * Registers a handler that will be called after a request returns a non-500
+     * response, causing a retry. Primarily useful in tests where timers are being
+     * mocked.
+     *
+     * @param listener - The handler to be called.
+     * @returns An object that can be used to unregister the handler.
+     * @see {@link createServicePolicy}
+     */
+    onRetry(listener: Parameters<ServicePolicy['onRetry']>[0]): IDisposable;
+    /**
+     * Registers a handler that will be called after a set number of retry rounds
+     * prove that requests to the API endpoint consistently return a 5xx response.
+     *
+     * @param listener - The handler to be called.
+     * @returns An object that can be used to unregister the handler.
+     * @see {@link createServicePolicy}
+     */
+    onBreak(listener: Parameters<ServicePolicy['onBreak']>[0]): IDisposable;
+    /**
+     * Registers a handler that will be called under one of two circumstances:
+     *
+     * 1. After a set number of retries prove that requests to the API
+     * consistently result in failures.
+     * 2. After a successful request is made to the API, but the response takes
+     * longer than a set duration to return.
+     *
+     * @param listener - The handler to be called.
+     * @returns An object that can be used to unregister the handler.
+     */
+    onDegraded(listener: Parameters<ServicePolicy['onDegraded']>[0]): IDisposable;
+    /**
+     * 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.
+     */
+    createDataDeletionTask(analyticsId: string): Promise<{
+        status: typeof DATA_DELETE_RESPONSE_STATUSES.Success;
+        regulateId: string;
+    }>;
+    /**
+     * 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.
+     */
+    checkDataDeleteStatus(regulationId: string): Promise<{
+        status: typeof DATA_DELETE_RESPONSE_STATUSES.Success;
+        dataDeleteStatus: DataDeleteStatus;
+    }>;
+}
+export {};
+//# sourceMappingURL=AnalyticsDataRegulationService.d.mts.map

package/dist/AnalyticsDataRegulationService.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AnalyticsDataRegulationService.d.mts","sourceRoot":"","sources":["../src/AnalyticsDataRegulationService.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,0BAA0B,EAC1B,aAAa,EACd,mCAAmC;AAEpC,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AACrD,OAAO,KAAK,EAAE,WAAW,EAAE,kBAAkB;AAE7C,OAAO,KAAK,EAAE,2CAA2C,EAAE,iEAA6D;AACxH,OAAO,EAAE,6BAA6B,EAAwB,oBAAgB;AAC9E,OAAO,KAAK,EAAE,gBAAgB,EAAE,oBAAgB;AAmBhD;;;GAGG;AACH,eAAO,MAAM,WAAW,mCAAmC,CAAC;AAS5D;;GAEG;AACH,MAAM,MAAM,qCAAqC,GAC/C,2CAA2C,CAAC;AAE9C;;GAEG;AACH,KAAK,cAAc,GAAG,KAAK,CAAC;AAE5B;;GAEG;AACH,MAAM,MAAM,oCAAoC,GAAG,KAAK,CAAC;AAEzD;;GAEG;AACH,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,uCAAuC,GAAG,SAAS,CAC7D,OAAO,WAAW,EAClB,qCAAqC,GAAG,cAAc,EACtD,oCAAoC,GAAG,aAAa,CACrD,CAAC;AA4BF;;GAEG;AACH,MAAM,MAAM,qCAAqC,GAAG;IAClD;;OAEG;IACH,SAAS,EAAE,uCAAuC,CAAC;IAEnD;;OAEG;IACH,KAAK,EAAE,OAAO,KAAK,CAAC;IAEpB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;;;OAMG;IACH,0BAA0B,EAAE,MAAM,CAAC;IAEnC;;OAEG;IACH,aAAa,CAAC,EAAE,0BAA0B,CAAC;CAC5C,CAAC;AAaF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,qBAAa,8BAA8B;;IACzC;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,OAAO,WAAW,CAAC;IA8BlC;;;;OAIG;gBACS,OAAO,EAAE,qCAAqC;IAc1D;;;;;;;;OAQG;IACH,OAAO,CAAC,QAAQ,EAAE,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW;IAIvE;;;;;;;OAOG;IACH,OAAO,CAAC,QAAQ,EAAE,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW;IAIvE;;;;;;;;;;OAUG;IACH,UAAU,CACR,QAAQ,EAAE,UAAU,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,GACnD,WAAW;IAId;;;;;;OAMG;IACG,sBAAsB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC;QACzD,MAAM,EAAE,OAAO,6BAA6B,CAAC,OAAO,CAAC;QACrD,UAAU,EAAE,MAAM,CAAC;KACpB,CAAC;IAiDF;;;;;;OAMG;IACG,qBAAqB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC;QACzD,MAAM,EAAE,OAAO,6BAA6B,CAAC,OAAO,CAAC;QACrD,gBAAgB,EAAE,gBAAgB,CAAC;KACpC,CAAC;CAqCH"}