@metamask-previews/profile-metrics-controller 0.0.0-preview-e0d310b4

package/dist/ProfileMetricsService.d.mts

@@ -0,0 +1,120 @@
+import type { CreateServicePolicyOptions, ServicePolicy } from "@metamask/controller-utils";
+import type { Messenger } from "@metamask/messenger";
+import type { AuthenticationController } from "@metamask/profile-sync-controller";
+import { type ProfileMetricsServiceMethodActions, Env } from "./index.mjs";
+/**
+ * The name of the {@link ProfileMetricsService}, used to namespace the
+ * service's actions and events.
+ */
+export declare const serviceName = "ProfileMetricsService";
+/**
+ * An account address along with its associated scopes.
+ */
+export type AccountWithScopes = {
+    address: string;
+    scopes: `${string}:${string}`[];
+};
+/**
+ * The shape of the request object for updating the user profile.
+ */
+export type ProfileMetricsUpdateRequest = {
+    metametricsId: string;
+    entropySourceId?: string | null;
+    accounts: AccountWithScopes[];
+};
+/**
+ * Actions that {@link ProfileMetricsService} exposes to other consumers.
+ */
+export type ProfileMetricsServiceActions = ProfileMetricsServiceMethodActions;
+/**
+ * Actions from other messengers that {@link ProfileMetricsService} calls.
+ */
+type AllowedActions = AuthenticationController.AuthenticationControllerGetBearerToken;
+/**
+ * Events that {@link ProfileMetricsService} exposes to other consumers.
+ */
+export type ProfileMetricsServiceEvents = never;
+/**
+ * Events from other messengers that {@link ProfileMetricsService} subscribes
+ * to.
+ */
+type AllowedEvents = never;
+/**
+ * The messenger which is restricted to actions and events accessed by
+ * {@link ProfileMetricsService}.
+ */
+export type ProfileMetricsServiceMessenger = Messenger<typeof serviceName, ProfileMetricsServiceActions | AllowedActions, ProfileMetricsServiceEvents | AllowedEvents>;
+export declare class ProfileMetricsService {
+    #private;
+    /**
+     * The name of the service.
+     */
+    readonly name: typeof serviceName;
+    /**
+     * Constructs a new ProfileMetricsService object.
+     *
+     * @param args - The constructor arguments.
+     * @param args.messenger - The messenger suited for this service.
+     * @param args.fetch - A function that can be used to make an HTTP request. If
+     * your JavaScript environment supports `fetch` natively, you'll probably want
+     * to pass that; otherwise you can pass an equivalent (such as `fetch` via
+     * `node-fetch`).
+     * @param args.policyOptions - Options to pass to `createServicePolicy`, which
+     * is used to wrap each request. See {@link CreateServicePolicyOptions}.
+     * @param args.env - The environment to determine the correct API endpoints.
+     */
+    constructor({ messenger, fetch: fetchFunction, policyOptions, env, }: {
+        messenger: ProfileMetricsServiceMessenger;
+        fetch: typeof fetch;
+        policyOptions?: CreateServicePolicyOptions;
+        env?: Env;
+    });
+    /**
+     * 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 CockatielEvent}.
+     * @see {@link createServicePolicy}
+     */
+    onRetry(listener: Parameters<ServicePolicy['onRetry']>[0]): import("cockatiel").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 CockatielEvent}.
+     * @see {@link createServicePolicy}
+     */
+    onBreak(listener: Parameters<ServicePolicy['onBreak']>[0]): import("cockatiel").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 one of the following failures:
+     *    1. A connection initiation error
+     *    2. A connection reset error
+     *    3. A timeout error
+     *    4. A non-JSON response
+     *    5. A 502, 503, or 504 response
+     * 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. See
+     * {@link CockatielEvent}.
+     */
+    onDegraded(listener: Parameters<ServicePolicy['onDegraded']>[0]): import("cockatiel").IDisposable;
+    /**
+     * Makes a request to the API in order to update the user profile.
+     *
+     * @param data - The data to send in the profile update request.
+     * @returns The response from the API.
+     */
+    updateProfile(data: ProfileMetricsUpdateRequest): Promise<void>;
+}
+export {};
+//# sourceMappingURL=ProfileMetricsService.d.mts.map

package/dist/ProfileMetricsService.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProfileMetricsService.d.mts","sourceRoot":"","sources":["../src/ProfileMetricsService.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,0BAA0B,EAC1B,aAAa,EACd,mCAAmC;AAEpC,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AACrD,OAAO,KAAK,EAAE,wBAAwB,EAAE,0CAA0C;AAElF,OAAO,EAAE,KAAK,kCAAkC,EAAE,GAAG,EAAa,oBAAU;AAI5E;;;GAGG;AACH,eAAO,MAAM,WAAW,0BAA0B,CAAC;AAEnD;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,GAAG,MAAM,IAAI,MAAM,EAAE,EAAE,CAAC;CACjC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,QAAQ,EAAE,iBAAiB,EAAE,CAAC;CAC/B,CAAC;AAMF;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG,kCAAkC,CAAC;AAE9E;;GAEG;AACH,KAAK,cAAc,GACjB,wBAAwB,CAAC,sCAAsC,CAAC;AAElE;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG,KAAK,CAAC;AAEhD;;;GAGG;AACH,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,8BAA8B,GAAG,SAAS,CACpD,OAAO,WAAW,EAClB,4BAA4B,GAAG,cAAc,EAC7C,2BAA2B,GAAG,aAAa,CAC5C,CAAC;AAIF,qBAAa,qBAAqB;;IAChC;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,OAAO,WAAW,CAAC;IA4BlC;;;;;;;;;;;;OAYG;gBACS,EACV,SAAS,EACT,KAAK,EAAE,aAAa,EACpB,aAAkB,EAClB,GAAa,GACd,EAAE;QACD,SAAS,EAAE,8BAA8B,CAAC;QAC1C,KAAK,EAAE,OAAO,KAAK,CAAC;QACpB,aAAa,CAAC,EAAE,0BAA0B,CAAC;QAC3C,GAAG,CAAC,EAAE,GAAG,CAAC;KACX;IAaD;;;;;;;;;OASG;IACH,OAAO,CAAC,QAAQ,EAAE,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;IAIzD;;;;;;;;OAQG;IACH,OAAO,CAAC,QAAQ,EAAE,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;IAKzD;;;;;;;;;;;;;;;;OAgBG;IAEH,UAAU,CAAC,QAAQ,EAAE,UAAU,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;IAI/D;;;;;OAKG;IACG,aAAa,CAAC,IAAI,EAAE,2BAA2B,GAAG,OAAO,CAAC,IAAI,CAAC;CA2BtE"}

package/dist/ProfileMetricsService.mjs

@@ -0,0 +1,140 @@
+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 _a, _ProfileMetricsService_messenger, _ProfileMetricsService_fetch, _ProfileMetricsService_policy, _ProfileMetricsService_baseURL;
+import { createServicePolicy, HttpError } from "@metamask/controller-utils";
+import { Env, getEnvUrl } from "./index.mjs";
+// === GENERAL ===
+/**
+ * The name of the {@link ProfileMetricsService}, used to namespace the
+ * service's actions and events.
+ */
+export const serviceName = 'ProfileMetricsService';
+// === MESSENGER ===
+const MESSENGER_EXPOSED_METHODS = ['updateProfile'];
+// === SERVICE DEFINITION ===
+export class ProfileMetricsService {
+    /**
+     * Constructs a new ProfileMetricsService object.
+     *
+     * @param args - The constructor arguments.
+     * @param args.messenger - The messenger suited for this service.
+     * @param args.fetch - A function that can be used to make an HTTP request. If
+     * your JavaScript environment supports `fetch` natively, you'll probably want
+     * to pass that; otherwise you can pass an equivalent (such as `fetch` via
+     * `node-fetch`).
+     * @param args.policyOptions - Options to pass to `createServicePolicy`, which
+     * is used to wrap each request. See {@link CreateServicePolicyOptions}.
+     * @param args.env - The environment to determine the correct API endpoints.
+     */
+    constructor({ messenger, fetch: fetchFunction, policyOptions = {}, env = Env.DEV, }) {
+        /**
+         * The messenger suited for this service.
+         */
+        _ProfileMetricsService_messenger.set(this, void 0);
+        /**
+         * A function that can be used to make an HTTP request.
+         */
+        _ProfileMetricsService_fetch.set(this, void 0);
+        /**
+         * The policy that wraps the request.
+         *
+         * @see {@link createServicePolicy}
+         */
+        _ProfileMetricsService_policy.set(this, void 0);
+        /**
+         * The API base URL environment.
+         */
+        _ProfileMetricsService_baseURL.set(this, void 0);
+        this.name = serviceName;
+        __classPrivateFieldSet(this, _ProfileMetricsService_messenger, messenger, "f");
+        __classPrivateFieldSet(this, _ProfileMetricsService_fetch, fetchFunction, "f");
+        __classPrivateFieldSet(this, _ProfileMetricsService_policy, createServicePolicy(policyOptions), "f");
+        __classPrivateFieldSet(this, _ProfileMetricsService_baseURL, getEnvUrl(env), "f");
+        __classPrivateFieldGet(this, _ProfileMetricsService_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 CockatielEvent}.
+     * @see {@link createServicePolicy}
+     */
+    onRetry(listener) {
+        return __classPrivateFieldGet(this, _ProfileMetricsService_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 CockatielEvent}.
+     * @see {@link createServicePolicy}
+     */
+    onBreak(listener) {
+        return __classPrivateFieldGet(this, _ProfileMetricsService_policy, "f").onBreak(listener);
+    }
+    /* eslint-disable jsdoc/check-indentation */
+    /**
+     * 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 one of the following failures:
+     *    1. A connection initiation error
+     *    2. A connection reset error
+     *    3. A timeout error
+     *    4. A non-JSON response
+     *    5. A 502, 503, or 504 response
+     * 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. See
+     * {@link CockatielEvent}.
+     */
+    /* eslint-enable jsdoc/check-indentation */
+    onDegraded(listener) {
+        return __classPrivateFieldGet(this, _ProfileMetricsService_policy, "f").onDegraded(listener);
+    }
+    /**
+     * Makes a request to the API in order to update the user profile.
+     *
+     * @param data - The data to send in the profile update request.
+     * @returns The response from the API.
+     */
+    async updateProfile(data) {
+        const authToken = await __classPrivateFieldGet(this, _ProfileMetricsService_messenger, "f").call('AuthenticationController:getBearerToken', data.entropySourceId || undefined);
+        await __classPrivateFieldGet(this, _ProfileMetricsService_policy, "f").execute(async () => {
+            const url = new URL(`${__classPrivateFieldGet(this, _ProfileMetricsService_baseURL, "f")}/profile/accounts`);
+            const localResponse = await __classPrivateFieldGet(this, _ProfileMetricsService_fetch, "f").call(this, url, {
+                method: 'PUT',
+                headers: {
+                    Authorization: `Bearer ${authToken}`,
+                    'Content-Type': 'application/json',
+                },
+                body: JSON.stringify({
+                    metametrics_id: data.metametricsId,
+                    accounts: data.accounts,
+                }),
+            });
+            if (!localResponse.ok) {
+                throw new HttpError(localResponse.status, `Fetching '${url.toString()}' failed with status '${localResponse.status}'`);
+            }
+            return localResponse;
+        });
+    }
+}
+_a = ProfileMetricsService, _ProfileMetricsService_messenger = new WeakMap(), _ProfileMetricsService_fetch = new WeakMap(), _ProfileMetricsService_policy = new WeakMap(), _ProfileMetricsService_baseURL = new WeakMap();
+//# sourceMappingURL=ProfileMetricsService.mjs.map

package/dist/ProfileMetricsService.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProfileMetricsService.mjs","sourceRoot":"","sources":["../src/ProfileMetricsService.ts"],"names":[],"mappings":";;;;;;;;;;;;AAIA,OAAO,EAAE,mBAAmB,EAAE,SAAS,EAAE,mCAAmC;AAI5E,OAAO,EAA2C,GAAG,EAAE,SAAS,EAAE,oBAAU;AAE5E,kBAAkB;AAElB;;;GAGG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,uBAAuB,CAAC;AAmBnD,oBAAoB;AAEpB,MAAM,yBAAyB,GAAG,CAAC,eAAe,CAAU,CAAC;AAkC7D,6BAA6B;AAE7B,MAAM,OAAO,qBAAqB;IAgChC;;;;;;;;;;;;OAYG;IACH,YAAY,EACV,SAAS,EACT,KAAK,EAAE,aAAa,EACpB,aAAa,GAAG,EAAE,EAClB,GAAG,GAAG,GAAG,CAAC,GAAG,GAMd;QAjDD;;WAEG;QACM,mDAES;QAElB;;WAEG;QACM,+CAEK;QAEd;;;;WAIG;QACM,gDAAuB;QAEhC;;WAEG;QACM,iDAAiB;QA0BxB,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC;QACxB,uBAAA,IAAI,oCAAc,SAAS,MAAA,CAAC;QAC5B,uBAAA,IAAI,gCAAU,aAAa,MAAA,CAAC;QAC5B,uBAAA,IAAI,iCAAW,mBAAmB,CAAC,aAAa,CAAC,MAAA,CAAC;QAClD,uBAAA,IAAI,kCAAY,SAAS,CAAC,GAAG,CAAC,MAAA,CAAC;QAE/B,uBAAA,IAAI,wCAAW,CAAC,4BAA4B,CAC1C,IAAI,EACJ,yBAAyB,CAC1B,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,OAAO,CAAC,QAAiD;QACvD,OAAO,uBAAA,IAAI,qCAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;;OAQG;IACH,OAAO,CAAC,QAAiD;QACvD,OAAO,uBAAA,IAAI,qCAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACxC,CAAC;IAED,4CAA4C;IAC5C;;;;;;;;;;;;;;;;OAgBG;IACH,2CAA2C;IAC3C,UAAU,CAAC,QAAoD;QAC7D,OAAO,uBAAA,IAAI,qCAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CAAC,IAAiC;QACnD,MAAM,SAAS,GAAG,MAAM,uBAAA,IAAI,wCAAW,CAAC,IAAI,CAC1C,yCAAyC,EACzC,IAAI,CAAC,eAAe,IAAI,SAAS,CAClC,CAAC;QACF,MAAM,uBAAA,IAAI,qCAAQ,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE;YACpC,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,uBAAA,IAAI,sCAAS,mBAAmB,CAAC,CAAC;YACzD,MAAM,aAAa,GAAG,MAAM,uBAAA,IAAI,oCAAO,MAAX,IAAI,EAAQ,GAAG,EAAE;gBAC3C,MAAM,EAAE,KAAK;gBACb,OAAO,EAAE;oBACP,aAAa,EAAE,UAAU,SAAS,EAAE;oBACpC,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;oBACnB,cAAc,EAAE,IAAI,CAAC,aAAa;oBAClC,QAAQ,EAAE,IAAI,CAAC,QAAQ;iBACxB,CAAC;aACH,CAAC,CAAC;YACH,IAAI,CAAC,aAAa,CAAC,EAAE,EAAE,CAAC;gBACtB,MAAM,IAAI,SAAS,CACjB,aAAa,CAAC,MAAM,EACpB,aAAa,GAAG,CAAC,QAAQ,EAAE,yBAAyB,aAAa,CAAC,MAAM,GAAG,CAC5E,CAAC;YACJ,CAAC;YACD,OAAO,aAAa,CAAC;QACvB,CAAC,CAAC,CAAC;IACL,CAAC;CACF","sourcesContent":["import type {\n  CreateServicePolicyOptions,\n  ServicePolicy,\n} from '@metamask/controller-utils';\nimport { createServicePolicy, HttpError } from '@metamask/controller-utils';\nimport type { Messenger } from '@metamask/messenger';\nimport type { AuthenticationController } from '@metamask/profile-sync-controller';\n\nimport { type ProfileMetricsServiceMethodActions, Env, getEnvUrl } from '.';\n\n// === GENERAL ===\n\n/**\n * The name of the {@link ProfileMetricsService}, used to namespace the\n * service's actions and events.\n */\nexport const serviceName = 'ProfileMetricsService';\n\n/**\n * An account address along with its associated scopes.\n */\nexport type AccountWithScopes = {\n  address: string;\n  scopes: `${string}:${string}`[];\n};\n\n/**\n * The shape of the request object for updating the user profile.\n */\nexport type ProfileMetricsUpdateRequest = {\n  metametricsId: string;\n  entropySourceId?: string | null;\n  accounts: AccountWithScopes[];\n};\n\n// === MESSENGER ===\n\nconst MESSENGER_EXPOSED_METHODS = ['updateProfile'] as const;\n\n/**\n * Actions that {@link ProfileMetricsService} exposes to other consumers.\n */\nexport type ProfileMetricsServiceActions = ProfileMetricsServiceMethodActions;\n\n/**\n * Actions from other messengers that {@link ProfileMetricsService} calls.\n */\ntype AllowedActions =\n  AuthenticationController.AuthenticationControllerGetBearerToken;\n\n/**\n * Events that {@link ProfileMetricsService} exposes to other consumers.\n */\nexport type ProfileMetricsServiceEvents = never;\n\n/**\n * Events from other messengers that {@link ProfileMetricsService} subscribes\n * to.\n */\ntype AllowedEvents = never;\n\n/**\n * The messenger which is restricted to actions and events accessed by\n * {@link ProfileMetricsService}.\n */\nexport type ProfileMetricsServiceMessenger = Messenger<\n  typeof serviceName,\n  ProfileMetricsServiceActions | AllowedActions,\n  ProfileMetricsServiceEvents | AllowedEvents\n>;\n\n// === SERVICE DEFINITION ===\n\nexport class ProfileMetricsService {\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: ConstructorParameters<\n    typeof ProfileMetricsService\n  >[0]['messenger'];\n\n  /**\n   * A function that can be used to make an HTTP request.\n   */\n  readonly #fetch: ConstructorParameters<\n    typeof ProfileMetricsService\n  >[0]['fetch'];\n\n  /**\n   * The policy that wraps the request.\n   *\n   * @see {@link createServicePolicy}\n   */\n  readonly #policy: ServicePolicy;\n\n  /**\n   * The API base URL environment.\n   */\n  readonly #baseURL: string;\n\n  /**\n   * Constructs a new ProfileMetricsService object.\n   *\n   * @param args - The constructor arguments.\n   * @param args.messenger - The messenger suited for this service.\n   * @param args.fetch - A function that can be used to make an HTTP request. If\n   * your JavaScript environment supports `fetch` natively, you'll probably want\n   * to pass that; otherwise you can pass an equivalent (such as `fetch` via\n   * `node-fetch`).\n   * @param args.policyOptions - Options to pass to `createServicePolicy`, which\n   * is used to wrap each request. See {@link CreateServicePolicyOptions}.\n   * @param args.env - The environment to determine the correct API endpoints.\n   */\n  constructor({\n    messenger,\n    fetch: fetchFunction,\n    policyOptions = {},\n    env = Env.DEV,\n  }: {\n    messenger: ProfileMetricsServiceMessenger;\n    fetch: typeof fetch;\n    policyOptions?: CreateServicePolicyOptions;\n    env?: Env;\n  }) {\n    this.name = serviceName;\n    this.#messenger = messenger;\n    this.#fetch = fetchFunction;\n    this.#policy = createServicePolicy(policyOptions);\n    this.#baseURL = getEnvUrl(env);\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. See\n   * {@link CockatielEvent}.\n   * @see {@link createServicePolicy}\n   */\n  onRetry(listener: Parameters<ServicePolicy['onRetry']>[0]) {\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. See\n   * {@link CockatielEvent}.\n   * @see {@link createServicePolicy}\n   */\n  onBreak(listener: Parameters<ServicePolicy['onBreak']>[0]) {\n    return this.#policy.onBreak(listener);\n  }\n\n  /* eslint-disable jsdoc/check-indentation */\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 one of the following failures:\n   *    1. A connection initiation error\n   *    2. A connection reset error\n   *    3. A timeout error\n   *    4. A non-JSON response\n   *    5. A 502, 503, or 504 response\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. See\n   * {@link CockatielEvent}.\n   */\n  /* eslint-enable jsdoc/check-indentation */\n  onDegraded(listener: Parameters<ServicePolicy['onDegraded']>[0]) {\n    return this.#policy.onDegraded(listener);\n  }\n\n  /**\n   * Makes a request to the API in order to update the user profile.\n   *\n   * @param data - The data to send in the profile update request.\n   * @returns The response from the API.\n   */\n  async updateProfile(data: ProfileMetricsUpdateRequest): Promise<void> {\n    const authToken = await this.#messenger.call(\n      'AuthenticationController:getBearerToken',\n      data.entropySourceId || undefined,\n    );\n    await this.#policy.execute(async () => {\n      const url = new URL(`${this.#baseURL}/profile/accounts`);\n      const localResponse = await this.#fetch(url, {\n        method: 'PUT',\n        headers: {\n          Authorization: `Bearer ${authToken}`,\n          'Content-Type': 'application/json',\n        },\n        body: JSON.stringify({\n          metametrics_id: data.metametricsId,\n          accounts: data.accounts,\n        }),\n      });\n      if (!localResponse.ok) {\n        throw new HttpError(\n          localResponse.status,\n          `Fetching '${url.toString()}' failed with status '${localResponse.status}'`,\n        );\n      }\n      return localResponse;\n    });\n  }\n}\n"]}

package/dist/constants.cjs

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getEnvUrl = exports.Env = void 0;
+var Env;
+(function (Env) {
+    Env["DEV"] = "dev";
+    Env["UAT"] = "uat";
+    Env["PRD"] = "prd";
+})(Env || (exports.Env = Env = {}));
+const ENV_URLS = {
+    dev: 'https://authentication.dev-api.cx.metamask.io/api/v2',
+    uat: 'https://authentication.uat-api.cx.metamask.io/api/v2',
+    prd: 'https://authentication.api.cx.metamask.io/api/v2',
+};
+/**
+ * Validates and returns correct environment endpoints
+ *
+ * @param env - environment field
+ * @returns the correct environment url
+ * @throws on invalid environment passed
+ */
+function getEnvUrl(env) {
+    if (!ENV_URLS[env]) {
+        throw new Error('invalid environment configuration');
+    }
+    return ENV_URLS[env];
+}
+exports.getEnvUrl = getEnvUrl;
+//# sourceMappingURL=constants.cjs.map

package/dist/constants.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.cjs","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":";;;AAAA,IAAY,GAIX;AAJD,WAAY,GAAG;IACb,kBAAW,CAAA;IACX,kBAAW,CAAA;IACX,kBAAW,CAAA;AACb,CAAC,EAJW,GAAG,mBAAH,GAAG,QAId;AAED,MAAM,QAAQ,GAAwB;IACpC,GAAG,EAAE,sDAAsD;IAC3D,GAAG,EAAE,sDAAsD;IAC3D,GAAG,EAAE,kDAAkD;CACxD,CAAC;AAEF;;;;;;GAMG;AACH,SAAgB,SAAS,CAAC,GAAQ;IAChC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;IACvD,CAAC;IACD,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC;AACvB,CAAC;AALD,8BAKC","sourcesContent":["export enum Env {\n  DEV = 'dev',\n  UAT = 'uat',\n  PRD = 'prd',\n}\n\nconst ENV_URLS: Record<Env, string> = {\n  dev: 'https://authentication.dev-api.cx.metamask.io/api/v2',\n  uat: 'https://authentication.uat-api.cx.metamask.io/api/v2',\n  prd: 'https://authentication.api.cx.metamask.io/api/v2',\n};\n\n/**\n * Validates and returns correct environment endpoints\n *\n * @param env - environment field\n * @returns the correct environment url\n * @throws on invalid environment passed\n */\nexport function getEnvUrl(env: Env): string {\n  if (!ENV_URLS[env]) {\n    throw new Error('invalid environment configuration');\n  }\n  return ENV_URLS[env];\n}\n"]}

package/dist/constants.d.cts

@@ -0,0 +1,14 @@
+export declare enum Env {
+    DEV = "dev",
+    UAT = "uat",
+    PRD = "prd"
+}
+/**
+ * Validates and returns correct environment endpoints
+ *
+ * @param env - environment field
+ * @returns the correct environment url
+ * @throws on invalid environment passed
+ */
+export declare function getEnvUrl(env: Env): string;
+//# sourceMappingURL=constants.d.cts.map

package/dist/constants.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.cts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,oBAAY,GAAG;IACb,GAAG,QAAQ;IACX,GAAG,QAAQ;IACX,GAAG,QAAQ;CACZ;AAQD;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,GAAG,GAAG,MAAM,CAK1C"}

package/dist/constants.d.mts

@@ -0,0 +1,14 @@
+export declare enum Env {
+    DEV = "dev",
+    UAT = "uat",
+    PRD = "prd"
+}
+/**
+ * Validates and returns correct environment endpoints
+ *
+ * @param env - environment field
+ * @returns the correct environment url
+ * @throws on invalid environment passed
+ */
+export declare function getEnvUrl(env: Env): string;
+//# sourceMappingURL=constants.d.mts.map

package/dist/constants.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.mts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,oBAAY,GAAG;IACb,GAAG,QAAQ;IACX,GAAG,QAAQ;IACX,GAAG,QAAQ;CACZ;AAQD;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,GAAG,GAAG,MAAM,CAK1C"}

package/dist/constants.mjs

@@ -0,0 +1,25 @@
+export var Env;
+(function (Env) {
+    Env["DEV"] = "dev";
+    Env["UAT"] = "uat";
+    Env["PRD"] = "prd";
+})(Env || (Env = {}));
+const ENV_URLS = {
+    dev: 'https://authentication.dev-api.cx.metamask.io/api/v2',
+    uat: 'https://authentication.uat-api.cx.metamask.io/api/v2',
+    prd: 'https://authentication.api.cx.metamask.io/api/v2',
+};
+/**
+ * Validates and returns correct environment endpoints
+ *
+ * @param env - environment field
+ * @returns the correct environment url
+ * @throws on invalid environment passed
+ */
+export function getEnvUrl(env) {
+    if (!ENV_URLS[env]) {
+        throw new Error('invalid environment configuration');
+    }
+    return ENV_URLS[env];
+}
+//# sourceMappingURL=constants.mjs.map

package/dist/constants.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.mjs","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,GAIX;AAJD,WAAY,GAAG;IACb,kBAAW,CAAA;IACX,kBAAW,CAAA;IACX,kBAAW,CAAA;AACb,CAAC,EAJW,GAAG,KAAH,GAAG,QAId;AAED,MAAM,QAAQ,GAAwB;IACpC,GAAG,EAAE,sDAAsD;IAC3D,GAAG,EAAE,sDAAsD;IAC3D,GAAG,EAAE,kDAAkD;CACxD,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,UAAU,SAAS,CAAC,GAAQ;IAChC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;IACvD,CAAC;IACD,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC;AACvB,CAAC","sourcesContent":["export enum Env {\n  DEV = 'dev',\n  UAT = 'uat',\n  PRD = 'prd',\n}\n\nconst ENV_URLS: Record<Env, string> = {\n  dev: 'https://authentication.dev-api.cx.metamask.io/api/v2',\n  uat: 'https://authentication.uat-api.cx.metamask.io/api/v2',\n  prd: 'https://authentication.api.cx.metamask.io/api/v2',\n};\n\n/**\n * Validates and returns correct environment endpoints\n *\n * @param env - environment field\n * @returns the correct environment url\n * @throws on invalid environment passed\n */\nexport function getEnvUrl(env: Env): string {\n  if (!ENV_URLS[env]) {\n    throw new Error('invalid environment configuration');\n  }\n  return ENV_URLS[env];\n}\n"]}

package/dist/index.cjs

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Env = exports.getEnvUrl = exports.serviceName = exports.ProfileMetricsService = exports.getDefaultProfileMetricsControllerState = exports.ProfileMetricsController = void 0;
+var ProfileMetricsController_1 = require("./ProfileMetricsController.cjs");
+Object.defineProperty(exports, "ProfileMetricsController", { enumerable: true, get: function () { return ProfileMetricsController_1.ProfileMetricsController; } });
+Object.defineProperty(exports, "getDefaultProfileMetricsControllerState", { enumerable: true, get: function () { return ProfileMetricsController_1.getDefaultProfileMetricsControllerState; } });
+var ProfileMetricsService_1 = require("./ProfileMetricsService.cjs");
+Object.defineProperty(exports, "ProfileMetricsService", { enumerable: true, get: function () { return ProfileMetricsService_1.ProfileMetricsService; } });
+Object.defineProperty(exports, "serviceName", { enumerable: true, get: function () { return ProfileMetricsService_1.serviceName; } });
+var constants_1 = require("./constants.cjs");
+Object.defineProperty(exports, "getEnvUrl", { enumerable: true, get: function () { return constants_1.getEnvUrl; } });
+Object.defineProperty(exports, "Env", { enumerable: true, get: function () { return constants_1.Env; } });
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAQA,2EAGoC;AAFlC,oIAAA,wBAAwB,OAAA;AACxB,mJAAA,uCAAuC,OAAA;AAQzC,qEAA6E;AAApE,8HAAA,qBAAqB,OAAA;AAAE,oHAAA,WAAW,OAAA;AAE3C,6CAA6C;AAApC,sGAAA,SAAS,OAAA;AAAE,gGAAA,GAAG,OAAA","sourcesContent":["export type {\n  ProfileMetricsControllerActions,\n  ProfileMetricsControllerEvents,\n  ProfileMetricsControllerGetStateAction,\n  ProfileMetricsControllerMessenger,\n  ProfileMetricsControllerState,\n  ProfileMetricsControllerStateChangeEvent,\n} from './ProfileMetricsController';\nexport {\n  ProfileMetricsController,\n  getDefaultProfileMetricsControllerState,\n} from './ProfileMetricsController';\nexport type {\n  ProfileMetricsServiceActions,\n  ProfileMetricsServiceEvents,\n  ProfileMetricsServiceMessenger,\n  ProfileMetricsUpdateRequest,\n} from './ProfileMetricsService';\nexport { ProfileMetricsService, serviceName } from './ProfileMetricsService';\nexport type { ProfileMetricsServiceMethodActions } from './ProfileMetricsService-method-action-types';\nexport { getEnvUrl, Env } from './constants';\n"]}

package/dist/index.d.cts

@@ -0,0 +1,7 @@
+export type { ProfileMetricsControllerActions, ProfileMetricsControllerEvents, ProfileMetricsControllerGetStateAction, ProfileMetricsControllerMessenger, ProfileMetricsControllerState, ProfileMetricsControllerStateChangeEvent, } from "./ProfileMetricsController.cjs";
+export { ProfileMetricsController, getDefaultProfileMetricsControllerState, } from "./ProfileMetricsController.cjs";
+export type { ProfileMetricsServiceActions, ProfileMetricsServiceEvents, ProfileMetricsServiceMessenger, ProfileMetricsUpdateRequest, } from "./ProfileMetricsService.cjs";
+export { ProfileMetricsService, serviceName } from "./ProfileMetricsService.cjs";
+export type { ProfileMetricsServiceMethodActions } from "./ProfileMetricsService-method-action-types.cjs";
+export { getEnvUrl, Env } from "./constants.cjs";
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,+BAA+B,EAC/B,8BAA8B,EAC9B,sCAAsC,EACtC,iCAAiC,EACjC,6BAA6B,EAC7B,wCAAwC,GACzC,uCAAmC;AACpC,OAAO,EACL,wBAAwB,EACxB,uCAAuC,GACxC,uCAAmC;AACpC,YAAY,EACV,4BAA4B,EAC5B,2BAA2B,EAC3B,8BAA8B,EAC9B,2BAA2B,GAC5B,oCAAgC;AACjC,OAAO,EAAE,qBAAqB,EAAE,WAAW,EAAE,oCAAgC;AAC7E,YAAY,EAAE,kCAAkC,EAAE,wDAAoD;AACtG,OAAO,EAAE,SAAS,EAAE,GAAG,EAAE,wBAAoB"}

package/dist/index.d.mts

@@ -0,0 +1,7 @@
+export type { ProfileMetricsControllerActions, ProfileMetricsControllerEvents, ProfileMetricsControllerGetStateAction, ProfileMetricsControllerMessenger, ProfileMetricsControllerState, ProfileMetricsControllerStateChangeEvent, } from "./ProfileMetricsController.mjs";
+export { ProfileMetricsController, getDefaultProfileMetricsControllerState, } from "./ProfileMetricsController.mjs";
+export type { ProfileMetricsServiceActions, ProfileMetricsServiceEvents, ProfileMetricsServiceMessenger, ProfileMetricsUpdateRequest, } from "./ProfileMetricsService.mjs";
+export { ProfileMetricsService, serviceName } from "./ProfileMetricsService.mjs";
+export type { ProfileMetricsServiceMethodActions } from "./ProfileMetricsService-method-action-types.mjs";
+export { getEnvUrl, Env } from "./constants.mjs";
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,+BAA+B,EAC/B,8BAA8B,EAC9B,sCAAsC,EACtC,iCAAiC,EACjC,6BAA6B,EAC7B,wCAAwC,GACzC,uCAAmC;AACpC,OAAO,EACL,wBAAwB,EACxB,uCAAuC,GACxC,uCAAmC;AACpC,YAAY,EACV,4BAA4B,EAC5B,2BAA2B,EAC3B,8BAA8B,EAC9B,2BAA2B,GAC5B,oCAAgC;AACjC,OAAO,EAAE,qBAAqB,EAAE,WAAW,EAAE,oCAAgC;AAC7E,YAAY,EAAE,kCAAkC,EAAE,wDAAoD;AACtG,OAAO,EAAE,SAAS,EAAE,GAAG,EAAE,wBAAoB"}

package/dist/index.mjs

@@ -0,0 +1,4 @@
+export { ProfileMetricsController, getDefaultProfileMetricsControllerState } from "./ProfileMetricsController.mjs";
+export { ProfileMetricsService, serviceName } from "./ProfileMetricsService.mjs";
+export { getEnvUrl, Env } from "./constants.mjs";
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAQA,OAAO,EACL,wBAAwB,EACxB,uCAAuC,EACxC,uCAAmC;AAOpC,OAAO,EAAE,qBAAqB,EAAE,WAAW,EAAE,oCAAgC;AAE7E,OAAO,EAAE,SAAS,EAAE,GAAG,EAAE,wBAAoB","sourcesContent":["export type {\n  ProfileMetricsControllerActions,\n  ProfileMetricsControllerEvents,\n  ProfileMetricsControllerGetStateAction,\n  ProfileMetricsControllerMessenger,\n  ProfileMetricsControllerState,\n  ProfileMetricsControllerStateChangeEvent,\n} from './ProfileMetricsController';\nexport {\n  ProfileMetricsController,\n  getDefaultProfileMetricsControllerState,\n} from './ProfileMetricsController';\nexport type {\n  ProfileMetricsServiceActions,\n  ProfileMetricsServiceEvents,\n  ProfileMetricsServiceMessenger,\n  ProfileMetricsUpdateRequest,\n} from './ProfileMetricsService';\nexport { ProfileMetricsService, serviceName } from './ProfileMetricsService';\nexport type { ProfileMetricsServiceMethodActions } from './ProfileMetricsService-method-action-types';\nexport { getEnvUrl, Env } from './constants';\n"]}

package/package.json

@@ -0,0 +1,82 @@
+{
+  "name": "@metamask-previews/profile-metrics-controller",
+  "version": "0.0.0-preview-e0d310b4",
+  "description": "Sample package to illustrate best practices for controllers",
+  "keywords": [
+    "MetaMask",
+    "Ethereum"
+  ],
+  "homepage": "https://github.com/MetaMask/core/tree/main/packages/profile-metrics-controller#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/core/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MetaMask/core.git"
+  },
+  "license": "MIT",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.cjs",
+  "types": "./dist/index.d.cts",
+  "files": [
+    "dist/"
+  ],
+  "scripts": {
+    "build": "ts-bridge --project tsconfig.build.json --verbose --clean --no-references",
+    "build:all": "ts-bridge --project tsconfig.build.json --verbose --clean",
+    "build:docs": "typedoc",
+    "changelog:update": "../../scripts/update-changelog.sh @metamask/profile-metrics-controller",
+    "changelog:validate": "../../scripts/validate-changelog.sh @metamask/profile-metrics-controller",
+    "publish:preview": "yarn npm publish --tag preview",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter",
+    "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache",
+    "test:verbose": "NODE_OPTIONS=--experimental-vm-modules jest --verbose",
+    "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch"
+  },
+  "dependencies": {
+    "@metamask/accounts-controller": "^35.0.0",
+    "@metamask/base-controller": "^9.0.0",
+    "@metamask/controller-utils": "^11.16.0",
+    "@metamask/keyring-controller": "^25.0.0",
+    "@metamask/messenger": "^0.3.0",
+    "@metamask/polling-controller": "^16.0.0",
+    "@metamask/profile-sync-controller": "^27.0.0",
+    "@metamask/utils": "^11.8.1",
+    "async-mutex": "^0.5.0"
+  },
+  "devDependencies": {
+    "@metamask/auto-changelog": "^3.4.4",
+    "@metamask/keyring-internal-api": "^9.0.0",
+    "@ts-bridge/cli": "^0.6.4",
+    "@types/jest": "^27.4.1",
+    "deepmerge": "^4.2.2",
+    "jest": "^27.5.1",
+    "nock": "^13.3.1",
+    "sinon": "^9.2.4",
+    "ts-jest": "^27.1.4",
+    "typedoc": "^0.24.8",
+    "typedoc-plugin-missing-exports": "^2.0.0",
+    "typescript": "~5.3.3"
+  },
+  "engines": {
+    "node": "^18.18 || >=20"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}