@metamask-previews/analytics-privacy-controller 0.0.0-preview-fa81dffb

package/dist/AnalyticsPrivacyService.cjs

@@ -0,0 +1,252 @@
+"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 _AnalyticsPrivacyService_messenger, _AnalyticsPrivacyService_fetch, _AnalyticsPrivacyService_segmentSourceId, _AnalyticsPrivacyService_segmentRegulationsEndpoint, _AnalyticsPrivacyService_policy;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AnalyticsPrivacyService = exports.serviceName = void 0;
+const controller_utils_1 = require("@metamask/controller-utils");
+const AnalyticsPrivacyLogger_1 = require("./AnalyticsPrivacyLogger.cjs");
+const constants_1 = require("./constants.cjs");
+const types_1 = require("./types.cjs");
+// === GENERAL ===
+/**
+ * The name of the {@link AnalyticsPrivacyService}, used to namespace the
+ * service's actions and events.
+ */
+exports.serviceName = 'AnalyticsPrivacyService';
+// === MESSENGER ===
+const MESSENGER_EXPOSED_METHODS = [
+    'createDataDeletionTask',
+    'checkDataDeleteStatus',
+];
+/**
+ * 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 {
+ *   AnalyticsPrivacyServiceActions,
+ *   AnalyticsPrivacyServiceEvents,
+ * } from '@metamask/analytics-privacy-controller';
+ *
+ * const rootMessenger = new Messenger<
+ *   'Root',
+ *   AnalyticsPrivacyServiceActions,
+ *   AnalyticsPrivacyServiceEvents
+ * >({ namespace: 'Root' });
+ * const serviceMessenger = new Messenger<
+ *   'AnalyticsPrivacyService',
+ *   AnalyticsPrivacyServiceActions,
+ *   AnalyticsPrivacyServiceEvents,
+ *   typeof rootMessenger,
+ * >({
+ *   namespace: 'AnalyticsPrivacyService',
+ *   parent: rootMessenger,
+ * });
+ * // Instantiate the service to register its actions on the messenger
+ * new AnalyticsPrivacyService({
+ *   messenger: serviceMessenger,
+ *   fetch,
+ *   segmentSourceId: 'abc123',
+ *   segmentRegulationsEndpoint: 'https://proxy.example.com/v1beta',
+ * });
+ *
+ * // Later...
+ * // Create a data deletion task
+ * const response = await rootMessenger.call(
+ *   'AnalyticsPrivacyService:createDataDeletionTask',
+ *   'user-analytics-id',
+ * );
+ * ```
+ */
+class AnalyticsPrivacyService {
+    /**
+     * Constructs a new AnalyticsPrivacyService object.
+     *
+     * @param options - The constructor options.
+     */
+    constructor(options) {
+        /**
+         * The messenger suited for this service.
+         */
+        _AnalyticsPrivacyService_messenger.set(this, void 0);
+        /**
+         * A function that can be used to make an HTTP request.
+         */
+        _AnalyticsPrivacyService_fetch.set(this, void 0);
+        /**
+         * Segment API source ID.
+         */
+        _AnalyticsPrivacyService_segmentSourceId.set(this, void 0);
+        /**
+         * Base URL for the proxy endpoint.
+         */
+        _AnalyticsPrivacyService_segmentRegulationsEndpoint.set(this, void 0);
+        /**
+         * The policy that wraps the request.
+         *
+         * @see {@link createServicePolicy}
+         */
+        _AnalyticsPrivacyService_policy.set(this, void 0);
+        this.name = exports.serviceName;
+        __classPrivateFieldSet(this, _AnalyticsPrivacyService_messenger, options.messenger, "f");
+        __classPrivateFieldSet(this, _AnalyticsPrivacyService_fetch, options.fetch, "f");
+        __classPrivateFieldSet(this, _AnalyticsPrivacyService_segmentSourceId, options.segmentSourceId, "f");
+        __classPrivateFieldSet(this, _AnalyticsPrivacyService_segmentRegulationsEndpoint, options.segmentRegulationsEndpoint, "f");
+        __classPrivateFieldSet(this, _AnalyticsPrivacyService_policy, (0, controller_utils_1.createServicePolicy)(options.policyOptions ?? {}), "f");
+        __classPrivateFieldGet(this, _AnalyticsPrivacyService_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, _AnalyticsPrivacyService_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, _AnalyticsPrivacyService_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, _AnalyticsPrivacyService_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 the deletion regulation response.
+     */
+    async createDataDeletionTask(analyticsId) {
+        if (!__classPrivateFieldGet(this, _AnalyticsPrivacyService_segmentSourceId, "f") || !__classPrivateFieldGet(this, _AnalyticsPrivacyService_segmentRegulationsEndpoint, "f")) {
+            return {
+                status: types_1.DataDeleteResponseStatus.Failure,
+                error: 'Segment API source ID or endpoint not found',
+            };
+        }
+        try {
+            const url = `${__classPrivateFieldGet(this, _AnalyticsPrivacyService_segmentRegulationsEndpoint, "f")}/regulations/sources/${__classPrivateFieldGet(this, _AnalyticsPrivacyService_segmentSourceId, "f")}`;
+            const body = JSON.stringify({
+                regulationType: constants_1.SEGMENT_REGULATION_TYPE_DELETE_ONLY,
+                subjectType: constants_1.SEGMENT_SUBJECT_TYPE_USER_ID,
+                subjectIds: [analyticsId],
+            });
+            const response = await __classPrivateFieldGet(this, _AnalyticsPrivacyService_policy, "f").execute(async () => {
+                const localResponse = await __classPrivateFieldGet(this, _AnalyticsPrivacyService_fetch, "f").call(this, url, {
+                    method: 'POST',
+                    headers: {
+                        'Content-Type': constants_1.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') {
+                return {
+                    status: types_1.DataDeleteResponseStatus.Success,
+                    regulateId: jsonResponse.data.data.regulateId,
+                };
+            }
+            (0, AnalyticsPrivacyLogger_1.projectLogger)('Analytics Deletion Task Error', new Error('Malformed response from Segment API'));
+            return {
+                status: types_1.DataDeleteResponseStatus.Failure,
+                error: 'Analytics Deletion Task Error',
+            };
+        }
+        catch (error) {
+            (0, AnalyticsPrivacyLogger_1.projectLogger)('Analytics Deletion Task Error', error);
+            return {
+                status: types_1.DataDeleteResponseStatus.Failure,
+                error: 'Analytics Deletion Task Error',
+            };
+        }
+    }
+    /**
+     * Checks the status of a regulation by ID.
+     *
+     * @param regulationId - The regulation ID to check.
+     * @returns Promise resolving to the regulation status response.
+     */
+    async checkDataDeleteStatus(regulationId) {
+        // Early return if regulationId is missing (cannot check status) or endpoint is not configured
+        if (!regulationId || !__classPrivateFieldGet(this, _AnalyticsPrivacyService_segmentRegulationsEndpoint, "f")) {
+            return {
+                status: types_1.DataDeleteResponseStatus.Failure,
+                dataDeleteStatus: types_1.DataDeleteStatus.Unknown,
+            };
+        }
+        try {
+            const url = `${__classPrivateFieldGet(this, _AnalyticsPrivacyService_segmentRegulationsEndpoint, "f")}/regulations/${regulationId}`;
+            const response = await __classPrivateFieldGet(this, _AnalyticsPrivacyService_policy, "f").execute(async () => {
+                const localResponse = await __classPrivateFieldGet(this, _AnalyticsPrivacyService_fetch, "f").call(this, url, {
+                    method: 'GET',
+                    headers: {
+                        'Content-Type': constants_1.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 = Object.values(types_1.DataDeleteStatus).includes(rawStatus)
+                ? rawStatus
+                : types_1.DataDeleteStatus.Unknown;
+            return {
+                status: types_1.DataDeleteResponseStatus.Success,
+                dataDeleteStatus,
+            };
+        }
+        catch (error) {
+            (0, AnalyticsPrivacyLogger_1.projectLogger)('Analytics Deletion Task Check Error', error);
+            return {
+                status: types_1.DataDeleteResponseStatus.Failure,
+                dataDeleteStatus: types_1.DataDeleteStatus.Unknown,
+            };
+        }
+    }
+}
+exports.AnalyticsPrivacyService = AnalyticsPrivacyService;
+_AnalyticsPrivacyService_messenger = new WeakMap(), _AnalyticsPrivacyService_fetch = new WeakMap(), _AnalyticsPrivacyService_segmentSourceId = new WeakMap(), _AnalyticsPrivacyService_segmentRegulationsEndpoint = new WeakMap(), _AnalyticsPrivacyService_policy = new WeakMap();
+//# sourceMappingURL=AnalyticsPrivacyService.cjs.map

package/dist/AnalyticsPrivacyService.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"AnalyticsPrivacyService.cjs","sourceRoot":"","sources":["../src/AnalyticsPrivacyService.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAIA,iEAA4E;AAI5E,yEAAgE;AAEhE,+CAIqB;AACrB,uCAAqE;AAMrE,kBAAkB;AAElB;;;GAGG;AACU,QAAA,WAAW,GAAG,yBAAyB,CAAC;AAErD,oBAAoB;AAEpB,MAAM,yBAAyB,GAAG;IAChC,wBAAwB;IACxB,uBAAuB;CACf,CAAC;AA0FX;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,MAAa,uBAAuB;IAiClC;;;;OAIG;IACH,YAAY,OAAuC;QAhCnD;;WAEG;QACM,qDAA6C;QAEtD;;WAEG;QACM,iDAAqB;QAE9B;;WAEG;QACM,2DAAyB;QAElC;;WAEG;QACM,sEAAoC;QAE7C;;;;WAIG;QACM,kDAAuB;QAQ9B,IAAI,CAAC,IAAI,GAAG,mBAAW,CAAC;QACxB,uBAAA,IAAI,sCAAc,OAAO,CAAC,SAAS,MAAA,CAAC;QACpC,uBAAA,IAAI,kCAAU,OAAO,CAAC,KAAK,MAAA,CAAC;QAC5B,uBAAA,IAAI,4CAAoB,OAAO,CAAC,eAAe,MAAA,CAAC;QAChD,uBAAA,IAAI,uDAA+B,OAAO,CAAC,0BAA0B,MAAA,CAAC;QACtE,uBAAA,IAAI,mCAAW,IAAA,sCAAmB,EAAC,OAAO,CAAC,aAAa,IAAI,EAAE,CAAC,MAAA,CAAC;QAEhE,uBAAA,IAAI,0CAAW,CAAC,4BAA4B,CAC1C,IAAI,EACJ,yBAAyB,CAC1B,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,OAAO,CAAC,QAAiD;QACvD,OAAO,uBAAA,IAAI,uCAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;OAOG;IACH,OAAO,CAAC,QAAiD;QACvD,OAAO,uBAAA,IAAI,uCAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;;;;OAUG;IACH,UAAU,CACR,QAAoD;QAEpD,OAAO,uBAAA,IAAI,uCAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,sBAAsB,CAC1B,WAAmB;QAEnB,IAAI,CAAC,uBAAA,IAAI,gDAAiB,IAAI,CAAC,uBAAA,IAAI,2DAA4B,EAAE,CAAC;YAChE,OAAO;gBACL,MAAM,EAAE,gCAAwB,CAAC,OAAO;gBACxC,KAAK,EAAE,6CAA6C;aACrD,CAAC;QACJ,CAAC;QAED,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,GAAG,uBAAA,IAAI,2DAA4B,wBAAwB,uBAAA,IAAI,gDAAiB,EAAE,CAAC;YAC/F,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC;gBAC1B,cAAc,EAAE,+CAAmC;gBACnD,WAAW,EAAE,wCAA4B;gBACzC,UAAU,EAAE,CAAC,WAAW,CAAC;aAC1B,CAAC,CAAC;YAEH,MAAM,QAAQ,GAAG,MAAM,uBAAA,IAAI,uCAAQ,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE;gBACrD,MAAM,aAAa,GAAG,MAAM,uBAAA,IAAI,sCAAO,MAAX,IAAI,EAAQ,GAAG,EAAE;oBAC3C,MAAM,EAAE,MAAM;oBACd,OAAO,EAAE;wBACP,cAAc,EAAE,gCAAoB;qBACrC;oBACD,IAAI;iBACL,CAAC,CAAC;gBAEH,IAAI,CAAC,aAAa,CAAC,EAAE,EAAE,CAAC;oBACtB,MAAM,IAAI,4BAAS,CACjB,aAAa,CAAC,MAAM,EACpB,mDAAmD,aAAa,CAAC,MAAM,GAAG,CAC3E,CAAC;gBACJ,CAAC;gBAED,OAAO,aAAa,CAAC;YACvB,CAAC,CAAC,CAAC;YAEH,MAAM,YAAY,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAA6B,CAAC;YAEzE,IACE,YAAY,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU;gBACpC,OAAO,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,KAAK,QAAQ,EACrD,CAAC;gBACD,OAAO;oBACL,MAAM,EAAE,gCAAwB,CAAC,OAAO;oBACxC,UAAU,EAAE,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU;iBAC9C,CAAC;YACJ,CAAC;YAED,IAAA,sCAAG,EACD,+BAA+B,EAC/B,IAAI,KAAK,CAAC,qCAAqC,CAAC,CACjD,CAAC;YACF,OAAO;gBACL,MAAM,EAAE,gCAAwB,CAAC,OAAO;gBACxC,KAAK,EAAE,+BAA+B;aACvC,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAA,sCAAG,EAAC,+BAA+B,EAAE,KAAK,CAAC,CAAC;YAC5C,OAAO;gBACL,MAAM,EAAE,gCAAwB,CAAC,OAAO;gBACxC,KAAK,EAAE,+BAA+B;aACvC,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,qBAAqB,CACzB,YAAoB;QAEpB,8FAA8F;QAC9F,IAAI,CAAC,YAAY,IAAI,CAAC,uBAAA,IAAI,2DAA4B,EAAE,CAAC;YACvD,OAAO;gBACL,MAAM,EAAE,gCAAwB,CAAC,OAAO;gBACxC,gBAAgB,EAAE,wBAAgB,CAAC,OAAO;aAC3C,CAAC;QACJ,CAAC;QAED,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,GAAG,uBAAA,IAAI,2DAA4B,gBAAgB,YAAY,EAAE,CAAC;YAE9E,MAAM,QAAQ,GAAG,MAAM,uBAAA,IAAI,uCAAQ,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE;gBACrD,MAAM,aAAa,GAAG,MAAM,uBAAA,IAAI,sCAAO,MAAX,IAAI,EAAQ,GAAG,EAAE;oBAC3C,MAAM,EAAE,KAAK;oBACb,OAAO,EAAE;wBACP,cAAc,EAAE,gCAAoB;qBACrC;iBACF,CAAC,CAAC;gBAEH,IAAI,CAAC,aAAa,CAAC,EAAE,EAAE,CAAC;oBACtB,MAAM,IAAI,4BAAS,CACjB,aAAa,CAAC,MAAM,EACpB,qDAAqD,aAAa,CAAC,MAAM,GAAG,CAC7E,CAAC;gBACJ,CAAC;gBAED,OAAO,aAAa,CAAC;YACvB,CAAC,CAAC,CAAC;YAEH,MAAM,YAAY,GAChB,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAgC,CAAC;YAEzD,MAAM,SAAS,GAAG,YAAY,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,aAAa,CAAC;YACtE,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,CAAC,wBAAgB,CAAC,CAAC,QAAQ,CAC/D,SAA6B,CAC9B;gBACC,CAAC,CAAE,SAA8B;gBACjC,CAAC,CAAC,wBAAgB,CAAC,OAAO,CAAC;YAE7B,OAAO;gBACL,MAAM,EAAE,gCAAwB,CAAC,OAAO;gBACxC,gBAAgB;aACjB,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAA,sCAAG,EAAC,qCAAqC,EAAE,KAAK,CAAC,CAAC;YAClD,OAAO;gBACL,MAAM,EAAE,gCAAwB,CAAC,OAAO;gBACxC,gBAAgB,EAAE,wBAAgB,CAAC,OAAO;aAC3C,CAAC;QACJ,CAAC;IACH,CAAC;CACF;AAlOD,0DAkOC","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 { projectLogger as log } from './AnalyticsPrivacyLogger';\nimport type { AnalyticsPrivacyServiceMethodActions } from './AnalyticsPrivacyService-method-action-types';\nimport {\n  SEGMENT_REGULATION_TYPE_DELETE_ONLY,\n  SEGMENT_SUBJECT_TYPE_USER_ID,\n  SEGMENT_CONTENT_TYPE,\n} from './constants';\nimport { DataDeleteResponseStatus, DataDeleteStatus } from './types';\nimport type {\n  IDeleteRegulationResponse,\n  IDeleteRegulationStatusResponse,\n} from './types';\n\n// === GENERAL ===\n\n/**\n * The name of the {@link AnalyticsPrivacyService}, used to namespace the\n * service's actions and events.\n */\nexport const serviceName = 'AnalyticsPrivacyService';\n\n// === MESSENGER ===\n\nconst MESSENGER_EXPOSED_METHODS = [\n  'createDataDeletionTask',\n  'checkDataDeleteStatus',\n] as const;\n\n/**\n * Actions that {@link AnalyticsPrivacyService} exposes to other consumers.\n */\nexport type AnalyticsPrivacyServiceActions =\n  AnalyticsPrivacyServiceMethodActions;\n\n/**\n * Actions from other messengers that {@link AnalyticsPrivacyServiceMessenger} calls.\n */\ntype AllowedActions = never;\n\n/**\n * Events that {@link AnalyticsPrivacyService} exposes to other consumers.\n */\nexport type AnalyticsPrivacyServiceEvents = never;\n\n/**\n * Events from other messengers that {@link AnalyticsPrivacyService} subscribes to.\n */\ntype AllowedEvents = never;\n\n/**\n * The messenger which is restricted to actions and events accessed by\n * {@link AnalyticsPrivacyService}.\n */\nexport type AnalyticsPrivacyServiceMessenger = Messenger<\n  typeof serviceName,\n  AnalyticsPrivacyServiceActions | AllowedActions,\n  AnalyticsPrivacyServiceEvents | 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 AnalyticsPrivacyService}.\n */\nexport type AnalyticsPrivacyServiceOptions = {\n  /**\n   * The messenger suited for this service.\n   */\n  messenger: AnalyticsPrivacyServiceMessenger;\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 (not Segment API directly).\n   * The proxy forwards requests to Segment API and adds authentication tokens.\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 * 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 *   AnalyticsPrivacyServiceActions,\n *   AnalyticsPrivacyServiceEvents,\n * } from '@metamask/analytics-privacy-controller';\n *\n * const rootMessenger = new Messenger<\n *   'Root',\n *   AnalyticsPrivacyServiceActions,\n *   AnalyticsPrivacyServiceEvents\n * >({ namespace: 'Root' });\n * const serviceMessenger = new Messenger<\n *   'AnalyticsPrivacyService',\n *   AnalyticsPrivacyServiceActions,\n *   AnalyticsPrivacyServiceEvents,\n *   typeof rootMessenger,\n * >({\n *   namespace: 'AnalyticsPrivacyService',\n *   parent: rootMessenger,\n * });\n * // Instantiate the service to register its actions on the messenger\n * new AnalyticsPrivacyService({\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 *   'AnalyticsPrivacyService:createDataDeletionTask',\n *   'user-analytics-id',\n * );\n * ```\n */\nexport class AnalyticsPrivacyService {\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: AnalyticsPrivacyServiceMessenger;\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.\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 AnalyticsPrivacyService object.\n   *\n   * @param options - The constructor options.\n   */\n  constructor(options: AnalyticsPrivacyServiceOptions) {\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 the deletion regulation response.\n   */\n  async createDataDeletionTask(\n    analyticsId: string,\n  ): Promise<IDeleteRegulationResponse> {\n    if (!this.#segmentSourceId || !this.#segmentRegulationsEndpoint) {\n      return {\n        status: DataDeleteResponseStatus.Failure,\n        error: 'Segment API source ID or endpoint not found',\n      };\n    }\n\n    try {\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      ) {\n        return {\n          status: DataDeleteResponseStatus.Success,\n          regulateId: jsonResponse.data.data.regulateId,\n        };\n      }\n\n      log(\n        'Analytics Deletion Task Error',\n        new Error('Malformed response from Segment API'),\n      );\n      return {\n        status: DataDeleteResponseStatus.Failure,\n        error: 'Analytics Deletion Task Error',\n      };\n    } catch (error) {\n      log('Analytics Deletion Task Error', error);\n      return {\n        status: DataDeleteResponseStatus.Failure,\n        error: 'Analytics Deletion Task Error',\n      };\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 the regulation status response.\n   */\n  async checkDataDeleteStatus(\n    regulationId: string,\n  ): Promise<IDeleteRegulationStatusResponse> {\n    // Early return if regulationId is missing (cannot check status) or endpoint is not configured\n    if (!regulationId || !this.#segmentRegulationsEndpoint) {\n      return {\n        status: DataDeleteResponseStatus.Failure,\n        dataDeleteStatus: DataDeleteStatus.Unknown,\n      };\n    }\n\n    try {\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 =\n        (await response.json()) as GetRegulationStatusResponse;\n\n      const rawStatus = jsonResponse?.data?.data?.regulation?.overallStatus;\n      const dataDeleteStatus = Object.values(DataDeleteStatus).includes(\n        rawStatus as DataDeleteStatus,\n      )\n        ? (rawStatus as DataDeleteStatus)\n        : DataDeleteStatus.Unknown;\n\n      return {\n        status: DataDeleteResponseStatus.Success,\n        dataDeleteStatus,\n      };\n    } catch (error) {\n      log('Analytics Deletion Task Check Error', error);\n      return {\n        status: DataDeleteResponseStatus.Failure,\n        dataDeleteStatus: DataDeleteStatus.Unknown,\n      };\n    }\n  }\n}\n"]}

package/dist/AnalyticsPrivacyService.d.cts

@@ -0,0 +1,160 @@
+import type { CreateServicePolicyOptions, ServicePolicy } from "@metamask/controller-utils";
+import type { Messenger } from "@metamask/messenger";
+import type { IDisposable } from "cockatiel";
+import type { AnalyticsPrivacyServiceMethodActions } from "./AnalyticsPrivacyService-method-action-types.cjs";
+import type { IDeleteRegulationResponse, IDeleteRegulationStatusResponse } from "./types.cjs";
+/**
+ * The name of the {@link AnalyticsPrivacyService}, used to namespace the
+ * service's actions and events.
+ */
+export declare const serviceName = "AnalyticsPrivacyService";
+/**
+ * Actions that {@link AnalyticsPrivacyService} exposes to other consumers.
+ */
+export type AnalyticsPrivacyServiceActions = AnalyticsPrivacyServiceMethodActions;
+/**
+ * Actions from other messengers that {@link AnalyticsPrivacyServiceMessenger} calls.
+ */
+type AllowedActions = never;
+/**
+ * Events that {@link AnalyticsPrivacyService} exposes to other consumers.
+ */
+export type AnalyticsPrivacyServiceEvents = never;
+/**
+ * Events from other messengers that {@link AnalyticsPrivacyService} subscribes to.
+ */
+type AllowedEvents = never;
+/**
+ * The messenger which is restricted to actions and events accessed by
+ * {@link AnalyticsPrivacyService}.
+ */
+export type AnalyticsPrivacyServiceMessenger = Messenger<typeof serviceName, AnalyticsPrivacyServiceActions | AllowedActions, AnalyticsPrivacyServiceEvents | AllowedEvents>;
+/**
+ * Options for constructing {@link AnalyticsPrivacyService}.
+ */
+export type AnalyticsPrivacyServiceOptions = {
+    /**
+     * The messenger suited for this service.
+     */
+    messenger: AnalyticsPrivacyServiceMessenger;
+    /**
+     * 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 (not Segment API directly).
+     * The proxy forwards requests to Segment API and adds authentication tokens.
+     */
+    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 {
+ *   AnalyticsPrivacyServiceActions,
+ *   AnalyticsPrivacyServiceEvents,
+ * } from '@metamask/analytics-privacy-controller';
+ *
+ * const rootMessenger = new Messenger<
+ *   'Root',
+ *   AnalyticsPrivacyServiceActions,
+ *   AnalyticsPrivacyServiceEvents
+ * >({ namespace: 'Root' });
+ * const serviceMessenger = new Messenger<
+ *   'AnalyticsPrivacyService',
+ *   AnalyticsPrivacyServiceActions,
+ *   AnalyticsPrivacyServiceEvents,
+ *   typeof rootMessenger,
+ * >({
+ *   namespace: 'AnalyticsPrivacyService',
+ *   parent: rootMessenger,
+ * });
+ * // Instantiate the service to register its actions on the messenger
+ * new AnalyticsPrivacyService({
+ *   messenger: serviceMessenger,
+ *   fetch,
+ *   segmentSourceId: 'abc123',
+ *   segmentRegulationsEndpoint: 'https://proxy.example.com/v1beta',
+ * });
+ *
+ * // Later...
+ * // Create a data deletion task
+ * const response = await rootMessenger.call(
+ *   'AnalyticsPrivacyService:createDataDeletionTask',
+ *   'user-analytics-id',
+ * );
+ * ```
+ */
+export declare class AnalyticsPrivacyService {
+    #private;
+    /**
+     * The name of the service.
+     */
+    readonly name: typeof serviceName;
+    /**
+     * Constructs a new AnalyticsPrivacyService object.
+     *
+     * @param options - The constructor options.
+     */
+    constructor(options: AnalyticsPrivacyServiceOptions);
+    /**
+     * 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 the deletion regulation response.
+     */
+    createDataDeletionTask(analyticsId: string): Promise<IDeleteRegulationResponse>;
+    /**
+     * Checks the status of a regulation by ID.
+     *
+     * @param regulationId - The regulation ID to check.
+     * @returns Promise resolving to the regulation status response.
+     */
+    checkDataDeleteStatus(regulationId: string): Promise<IDeleteRegulationStatusResponse>;
+}
+export {};
+//# sourceMappingURL=AnalyticsPrivacyService.d.cts.map

package/dist/AnalyticsPrivacyService.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AnalyticsPrivacyService.d.cts","sourceRoot":"","sources":["../src/AnalyticsPrivacyService.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;AAG7C,OAAO,KAAK,EAAE,oCAAoC,EAAE,0DAAsD;AAO1G,OAAO,KAAK,EACV,yBAAyB,EACzB,+BAA+B,EAChC,oBAAgB;AAIjB;;;GAGG;AACH,eAAO,MAAM,WAAW,4BAA4B,CAAC;AASrD;;GAEG;AACH,MAAM,MAAM,8BAA8B,GACxC,oCAAoC,CAAC;AAEvC;;GAEG;AACH,KAAK,cAAc,GAAG,KAAK,CAAC;AAE5B;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG,KAAK,CAAC;AAElD;;GAEG;AACH,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,gCAAgC,GAAG,SAAS,CACtD,OAAO,WAAW,EAClB,8BAA8B,GAAG,cAAc,EAC/C,6BAA6B,GAAG,aAAa,CAC9C,CAAC;AA4BF;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG;IAC3C;;OAEG;IACH,SAAS,EAAE,gCAAgC,CAAC;IAE5C;;OAEG;IACH,KAAK,EAAE,OAAO,KAAK,CAAC;IAEpB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,0BAA0B,EAAE,MAAM,CAAC;IAEnC;;OAEG;IACH,aAAa,CAAC,EAAE,0BAA0B,CAAC;CAC5C,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,qBAAa,uBAAuB;;IAClC;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,OAAO,WAAW,CAAC;IA6BlC;;;;OAIG;gBACS,OAAO,EAAE,8BAA8B;IAcnD;;;;;;;;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;;;;;OAKG;IACG,sBAAsB,CAC1B,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,yBAAyB,CAAC;IAgErC;;;;;OAKG;IACG,qBAAqB,CACzB,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,+BAA+B,CAAC;CAoD5C"}

package/dist/AnalyticsPrivacyService.d.mts

@@ -0,0 +1,160 @@
+import type { CreateServicePolicyOptions, ServicePolicy } from "@metamask/controller-utils";
+import type { Messenger } from "@metamask/messenger";
+import type { IDisposable } from "cockatiel";
+import type { AnalyticsPrivacyServiceMethodActions } from "./AnalyticsPrivacyService-method-action-types.mjs";
+import type { IDeleteRegulationResponse, IDeleteRegulationStatusResponse } from "./types.mjs";
+/**
+ * The name of the {@link AnalyticsPrivacyService}, used to namespace the
+ * service's actions and events.
+ */
+export declare const serviceName = "AnalyticsPrivacyService";
+/**
+ * Actions that {@link AnalyticsPrivacyService} exposes to other consumers.
+ */
+export type AnalyticsPrivacyServiceActions = AnalyticsPrivacyServiceMethodActions;
+/**
+ * Actions from other messengers that {@link AnalyticsPrivacyServiceMessenger} calls.
+ */
+type AllowedActions = never;
+/**
+ * Events that {@link AnalyticsPrivacyService} exposes to other consumers.
+ */
+export type AnalyticsPrivacyServiceEvents = never;
+/**
+ * Events from other messengers that {@link AnalyticsPrivacyService} subscribes to.
+ */
+type AllowedEvents = never;
+/**
+ * The messenger which is restricted to actions and events accessed by
+ * {@link AnalyticsPrivacyService}.
+ */
+export type AnalyticsPrivacyServiceMessenger = Messenger<typeof serviceName, AnalyticsPrivacyServiceActions | AllowedActions, AnalyticsPrivacyServiceEvents | AllowedEvents>;
+/**
+ * Options for constructing {@link AnalyticsPrivacyService}.
+ */
+export type AnalyticsPrivacyServiceOptions = {
+    /**
+     * The messenger suited for this service.
+     */
+    messenger: AnalyticsPrivacyServiceMessenger;
+    /**
+     * 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 (not Segment API directly).
+     * The proxy forwards requests to Segment API and adds authentication tokens.
+     */
+    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 {
+ *   AnalyticsPrivacyServiceActions,
+ *   AnalyticsPrivacyServiceEvents,
+ * } from '@metamask/analytics-privacy-controller';
+ *
+ * const rootMessenger = new Messenger<
+ *   'Root',
+ *   AnalyticsPrivacyServiceActions,
+ *   AnalyticsPrivacyServiceEvents
+ * >({ namespace: 'Root' });
+ * const serviceMessenger = new Messenger<
+ *   'AnalyticsPrivacyService',
+ *   AnalyticsPrivacyServiceActions,
+ *   AnalyticsPrivacyServiceEvents,
+ *   typeof rootMessenger,
+ * >({
+ *   namespace: 'AnalyticsPrivacyService',
+ *   parent: rootMessenger,
+ * });
+ * // Instantiate the service to register its actions on the messenger
+ * new AnalyticsPrivacyService({
+ *   messenger: serviceMessenger,
+ *   fetch,
+ *   segmentSourceId: 'abc123',
+ *   segmentRegulationsEndpoint: 'https://proxy.example.com/v1beta',
+ * });
+ *
+ * // Later...
+ * // Create a data deletion task
+ * const response = await rootMessenger.call(
+ *   'AnalyticsPrivacyService:createDataDeletionTask',
+ *   'user-analytics-id',
+ * );
+ * ```
+ */
+export declare class AnalyticsPrivacyService {
+    #private;
+    /**
+     * The name of the service.
+     */
+    readonly name: typeof serviceName;
+    /**
+     * Constructs a new AnalyticsPrivacyService object.
+     *
+     * @param options - The constructor options.
+     */
+    constructor(options: AnalyticsPrivacyServiceOptions);
+    /**
+     * 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 the deletion regulation response.
+     */
+    createDataDeletionTask(analyticsId: string): Promise<IDeleteRegulationResponse>;
+    /**
+     * Checks the status of a regulation by ID.
+     *
+     * @param regulationId - The regulation ID to check.
+     * @returns Promise resolving to the regulation status response.
+     */
+    checkDataDeleteStatus(regulationId: string): Promise<IDeleteRegulationStatusResponse>;
+}
+export {};
+//# sourceMappingURL=AnalyticsPrivacyService.d.mts.map

package/dist/AnalyticsPrivacyService.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AnalyticsPrivacyService.d.mts","sourceRoot":"","sources":["../src/AnalyticsPrivacyService.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;AAG7C,OAAO,KAAK,EAAE,oCAAoC,EAAE,0DAAsD;AAO1G,OAAO,KAAK,EACV,yBAAyB,EACzB,+BAA+B,EAChC,oBAAgB;AAIjB;;;GAGG;AACH,eAAO,MAAM,WAAW,4BAA4B,CAAC;AASrD;;GAEG;AACH,MAAM,MAAM,8BAA8B,GACxC,oCAAoC,CAAC;AAEvC;;GAEG;AACH,KAAK,cAAc,GAAG,KAAK,CAAC;AAE5B;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG,KAAK,CAAC;AAElD;;GAEG;AACH,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,gCAAgC,GAAG,SAAS,CACtD,OAAO,WAAW,EAClB,8BAA8B,GAAG,cAAc,EAC/C,6BAA6B,GAAG,aAAa,CAC9C,CAAC;AA4BF;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG;IAC3C;;OAEG;IACH,SAAS,EAAE,gCAAgC,CAAC;IAE5C;;OAEG;IACH,KAAK,EAAE,OAAO,KAAK,CAAC;IAEpB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,0BAA0B,EAAE,MAAM,CAAC;IAEnC;;OAEG;IACH,aAAa,CAAC,EAAE,0BAA0B,CAAC;CAC5C,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,qBAAa,uBAAuB;;IAClC;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,OAAO,WAAW,CAAC;IA6BlC;;;;OAIG;gBACS,OAAO,EAAE,8BAA8B;IAcnD;;;;;;;;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;;;;;OAKG;IACG,sBAAsB,CAC1B,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,yBAAyB,CAAC;IAgErC;;;;;OAKG;IACG,qBAAqB,CACzB,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,+BAA+B,CAAC;CAoD5C"}