@metamask-previews/analytics-controller 0.0.0-preview-d21b3dc → 0.0.0-preview-a5935709

package/dist/AnalyticsController.d.mts

@@ -2,7 +2,7 @@ import type { ControllerGetStateAction, ControllerStateChangeEvent } from "@meta
 import { BaseController } from "@metamask/base-controller";
 import type { Messenger } from "@metamask/messenger";
 import type { AnalyticsControllerMethodActions } from "./AnalyticsController-method-action-types.mjs";
-import type { AnalyticsPlatformAdapter, AnalyticsEventProperties } from "./AnalyticsPlatformAdapter.types.mjs";
+import type { AnalyticsPlatformAdapter, AnalyticsEventProperties, AnalyticsUserTraits, AnalyticsTrackingEvent } from "./AnalyticsPlatformAdapter.types.mjs";
 /**
  * The name of the {@link AnalyticsController}, used to namespace the
  * controller's actions and events and to namespace the controller's state data
@@ -14,27 +14,29 @@ export declare const controllerName = "AnalyticsController";
  */
 export type AnalyticsControllerState = {
     /**
-     * Whether analytics tracking is enabled
+     * Whether the user has opted in to analytics for regular account.
      */
-    enabled: boolean;
+    optedInForRegularAccount: boolean;
     /**
-     * Whether the user has opted in to analytics
+     * Whether the user has opted in to analytics for social account.
      */
-    optedIn: boolean;
+    optedInForSocialAccount: boolean;
     /**
-     * User's UUIDv4 analytics identifier
+     * User's UUIDv4 analytics identifier.
+     * This is an identity (unique per user), not a preference.
+     * Must be provided by the platform - the controller does not generate it.
      */
     analyticsId: string;
 };
 /**
- * Constructs the default {@link AnalyticsController} state. This allows
- * consumers to provide a partial state object when initializing the controller
- * and also helps in constructing complete state objects for this controller in
- * tests.
+ * Returns default values for AnalyticsController state.
  *
- * @returns The default {@link AnalyticsController} state.
+ * Note: analyticsId is NOT included - it's an identity that must be
+ * provided by the platform (generated once on first run, then persisted).
+ *
+ * @returns Default state without analyticsId
  */
-export declare function getDefaultAnalyticsControllerState(): AnalyticsControllerState;
+export declare function getDefaultAnalyticsControllerState(): Omit<AnalyticsControllerState, 'analyticsId'>;
 /**
  * Returns the state of the {@link AnalyticsController}.
  */
@@ -68,10 +70,17 @@ export type AnalyticsControllerMessenger = Messenger<typeof controllerName, Anal
  * The options that AnalyticsController takes.
  */
 export type AnalyticsControllerOptions = {
-    state?: Partial<AnalyticsControllerState>;
+    /**
+     * Initial controller state. Must include a valid UUIDv4 `analyticsId`.
+     * The platform is responsible for generating and persisting the analyticsId.
+     */
+    state: AnalyticsControllerState;
+    /**
+     * Messenger used to communicate with BaseController and other controllers.
+     */
     messenger: AnalyticsControllerMessenger;
     /**
-     * Platform adapter implementation for tracking events
+     * Platform adapter implementation for tracking events.
      */
     platformAdapter: AnalyticsPlatformAdapter;
 };
@@ -84,6 +93,11 @@ export type AnalyticsControllerOptions = {
  * This controller follows the MetaMask controller pattern and integrates with the
  * messenger system to allow other controllers and components to track analytics events.
  * It delegates platform-specific implementation to an {@link AnalyticsPlatformAdapter}.
+ *
+ * Note: This controller does not persist state internally (`persist: false` in metadata).
+ * The platform is responsible for:
+ * - Providing the initial state (including a valid UUIDv4 analyticsId)
+ * - Subscribing to `AnalyticsController:stateChange` event to persist changes
  */
 export declare class AnalyticsController extends BaseController<'AnalyticsController', AnalyticsControllerState, AnalyticsControllerMessenger> {
     #private;
@@ -91,9 +105,11 @@ export declare class AnalyticsController extends BaseController<'AnalyticsContro
      * Constructs an AnalyticsController instance.
      *
      * @param options - Controller options
-     * @param options.state - Initial controller state (defaults from getDefaultAnalyticsControllerState)
+     * @param options.state - Initial controller state. Must include a valid UUIDv4 `analyticsId`.
+     * Use `getDefaultAnalyticsControllerState()` for default opt-in preferences.
      * @param options.messenger - Messenger used to communicate with BaseController
      * @param options.platformAdapter - Platform adapter implementation for tracking
+     * @throws Error if state.analyticsId is missing or not a valid UUIDv4
      */
     constructor({ state, messenger, platformAdapter, }: AnalyticsControllerOptions);
     /**
@@ -101,40 +117,42 @@ export declare class AnalyticsController extends BaseController<'AnalyticsContro
      *
      * Events are only tracked if analytics is enabled.
      *
-     * @param eventName - The name of the event
-     * @param properties - Event properties
+     * @param event - Analytics event with properties and sensitive properties
      */
-    trackEvent(eventName: string, properties?: AnalyticsEventProperties): void;
+    trackEvent(event: AnalyticsTrackingEvent): void;
     /**
      * Identify a user for analytics.
      *
-     * @param userId - The user identifier (e.g., metametrics ID)
      * @param traits - User traits/properties
      */
-    identify(userId: string, traits?: AnalyticsEventProperties): void;
+    identify(traits?: AnalyticsUserTraits): void;
     /**
-     * Track a page view.
+     * Track a page or screen view.
      *
-     * @param pageName - The name of the page
-     * @param properties - Page properties
+     * @param name - The identifier/name of the page or screen being viewed (e.g., "home", "settings", "wallet")
+     * @param properties - Optional properties associated with the view
      */
-    trackPage(pageName: string, properties?: AnalyticsEventProperties): void;
+    trackView(name: string, properties?: AnalyticsEventProperties): void;
     /**
-     * Enable analytics tracking.
+     * Opt in to analytics for regular account.
+     * This updates the user's opt-in status for regular account.
      */
-    enable(): void;
+    optInForRegularAccount(): void;
     /**
-     * Disable analytics tracking.
+     * Opt out of analytics for regular account.
+     * This updates the user's opt-in status for regular account.
      */
-    disable(): void;
+    optOutForRegularAccount(): void;
     /**
-     * Opt in to analytics.
+     * Opt in to analytics for social account.
+     * This updates the user's opt-in status for social account.
      */
-    optIn(): void;
+    optInForSocialAccount(): void;
     /**
-     * Opt out of analytics.
+     * Opt out of analytics for social account.
+     * This updates the user's opt-in status for social account.
      */
-    optOut(): void;
+    optOutForSocialAccount(): void;
 }
 export {};
 //# sourceMappingURL=AnalyticsController.d.mts.map

package/dist/AnalyticsController.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"AnalyticsController.d.mts","sourceRoot":"","sources":["../src/AnalyticsController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAE3B,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AAGrD,OAAO,KAAK,EAAE,gCAAgC,EAAE,sDAAkD;AAElG,OAAO,KAAK,EACV,wBAAwB,EACxB,wBAAwB,EACzB,6CAAyC;AAI1C;;;;GAIG;AACH,eAAO,MAAM,cAAc,wBAAwB,CAAC;AAIpD;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AA0BF;;;;;;;GAOG;AACH,wBAAgB,kCAAkC,IAAI,wBAAwB,CAM7E;AAcD;;GAEG;AACH,MAAM,MAAM,iCAAiC,GAAG,wBAAwB,CACtE,OAAO,cAAc,EACrB,wBAAwB,CACzB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAClC,iCAAiC,GACjC,gCAAgC,CAAC;AAErC;;GAEG;AACH,KAAK,cAAc,GAAG,KAAK,CAAC;AAE5B;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAAG,0BAA0B,CAC1E,OAAO,cAAc,EACrB,wBAAwB,CACzB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,mCAAmC,CAAC;AAE5E;;GAEG;AACH,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,4BAA4B,GAAG,SAAS,CAClD,OAAO,cAAc,EACrB,0BAA0B,GAAG,cAAc,EAC3C,yBAAyB,GAAG,aAAa,CAC1C,CAAC;AAIF;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC,KAAK,CAAC,EAAE,OAAO,CAAC,wBAAwB,CAAC,CAAC;IAC1C,SAAS,EAAE,4BAA4B,CAAC;IACxC;;OAEG;IACH,eAAe,EAAE,wBAAwB,CAAC;CAC3C,CAAC;AAEF;;;;;;;;;GASG;AACH,qBAAa,mBAAoB,SAAQ,cAAc,CACrD,qBAAqB,EACrB,wBAAwB,EACxB,4BAA4B,CAC7B;;IAGC;;;;;;;OAOG;gBACS,EACV,KAAU,EACV,SAAS,EACT,eAAe,GAChB,EAAE,0BAA0B;IAyB7B;;;;;;;OAOG;IACH,UAAU,CACR,SAAS,EAAE,MAAM,EACjB,UAAU,GAAE,wBAA6B,GACxC,IAAI;IAUP;;;;;OAKG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,wBAAwB,GAAG,IAAI;IAgBjE;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,wBAAwB,GAAG,IAAI;IAWxE;;OAEG;IACH,MAAM,IAAI,IAAI;IAMd;;OAEG;IACH,OAAO,IAAI,IAAI;IAMf;;OAEG;IACH,KAAK,IAAI,IAAI;IAMb;;OAEG;IACH,MAAM,IAAI,IAAI;CAKf"}
+{"version":3,"file":"AnalyticsController.d.mts","sourceRoot":"","sources":["../src/AnalyticsController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAE3B,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AAErD,OAAO,KAAK,EAAE,gCAAgC,EAAE,sDAAkD;AAGlG,OAAO,KAAK,EACV,wBAAwB,EACxB,wBAAwB,EACxB,mBAAmB,EACnB,sBAAsB,EACvB,6CAAyC;AAK1C;;;;GAIG;AACH,eAAO,MAAM,cAAc,wBAAwB,CAAC;AAIpD;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,wBAAwB,EAAE,OAAO,CAAC;IAElC;;OAEG;IACH,uBAAuB,EAAE,OAAO,CAAC;IAEjC;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAgB,kCAAkC,IAAI,IAAI,CACxD,wBAAwB,EACxB,aAAa,CACd,CAKA;AAyCD;;GAEG;AACH,MAAM,MAAM,iCAAiC,GAAG,wBAAwB,CACtE,OAAO,cAAc,EACrB,wBAAwB,CACzB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAClC,iCAAiC,GACjC,gCAAgC,CAAC;AAErC;;GAEG;AACH,KAAK,cAAc,GAAG,KAAK,CAAC;AAE5B;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAAG,0BAA0B,CAC1E,OAAO,cAAc,EACrB,wBAAwB,CACzB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,mCAAmC,CAAC;AAE5E;;GAEG;AACH,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,4BAA4B,GAAG,SAAS,CAClD,OAAO,cAAc,EACrB,0BAA0B,GAAG,cAAc,EAC3C,yBAAyB,GAAG,aAAa,CAC1C,CAAC;AAIF;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC;;;OAGG;IACH,KAAK,EAAE,wBAAwB,CAAC;IAChC;;OAEG;IACH,SAAS,EAAE,4BAA4B,CAAC;IACxC;;OAEG;IACH,eAAe,EAAE,wBAAwB,CAAC;CAC3C,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,qBAAa,mBAAoB,SAAQ,cAAc,CACrD,qBAAqB,EACrB,wBAAwB,EACxB,4BAA4B,CAC7B;;IAGC;;;;;;;;;OASG;gBACS,EACV,KAAK,EACL,SAAS,EACT,eAAe,GAChB,EAAE,0BAA0B;IAuC7B;;;;;;OAMG;IACH,UAAU,CAAC,KAAK,EAAE,sBAAsB,GAAG,IAAI;IAoC/C;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI;IAS5C;;;;;OAKG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,wBAAwB,GAAG,IAAI;IASpE;;;OAGG;IACH,sBAAsB,IAAI,IAAI;IAM9B;;;OAGG;IACH,uBAAuB,IAAI,IAAI;IAM/B;;;OAGG;IACH,qBAAqB,IAAI,IAAI;IAM7B;;;OAGG;IACH,sBAAsB,IAAI,IAAI;CAK/B"}

package/dist/AnalyticsController.mjs

@@ -11,8 +11,9 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 };
 var _AnalyticsController_platformAdapter;
 import { BaseController } from "@metamask/base-controller";
-import { v4 as uuidv4 } from "uuid";
+import { validateAnalyticsControllerState } from "./analyticsControllerStateValidator.mjs";
 import { projectLogger } from "./AnalyticsLogger.mjs";
+import { analyticsControllerSelectors } from "./selectors.mjs";
 // === GENERAL ===
 /**
  * The name of the {@link AnalyticsController}, used to namespace the
@@ -20,53 +21,55 @@ import { projectLogger } from "./AnalyticsLogger.mjs";
  * when composed with other controllers.
  */
 export const controllerName = 'AnalyticsController';
+/**
+ * Returns default values for AnalyticsController state.
+ *
+ * Note: analyticsId is NOT included - it's an identity that must be
+ * provided by the platform (generated once on first run, then persisted).
+ *
+ * @returns Default state without analyticsId
+ */
+export function getDefaultAnalyticsControllerState() {
+    return {
+        optedInForRegularAccount: false,
+        optedInForSocialAccount: false,
+    };
+}
 /**
  * The metadata for each property in {@link AnalyticsControllerState}.
+ *
+ * Note: `persist` is set to `false` for all fields because the platform
+ * is responsible for persistence via the `stateChange` event listener.
  */
 const analyticsControllerMetadata = {
-    enabled: {
+    optedInForRegularAccount: {
         includeInStateLogs: true,
-        persist: true,
+        persist: false,
         includeInDebugSnapshot: true,
         usedInUi: true,
     },
-    optedIn: {
+    optedInForSocialAccount: {
         includeInStateLogs: true,
-        persist: true,
+        persist: false,
         includeInDebugSnapshot: true,
         usedInUi: true,
     },
     analyticsId: {
         includeInStateLogs: true,
-        persist: true,
+        persist: false,
         includeInDebugSnapshot: true,
         usedInUi: false,
     },
 };
-/**
- * Constructs the default {@link AnalyticsController} state. This allows
- * consumers to provide a partial state object when initializing the controller
- * and also helps in constructing complete state objects for this controller in
- * tests.
- *
- * @returns The default {@link AnalyticsController} state.
- */
-export function getDefaultAnalyticsControllerState() {
-    return {
-        enabled: true,
-        optedIn: false,
-        analyticsId: uuidv4(),
-    };
-}
 // === MESSENGER ===
 const MESSENGER_EXPOSED_METHODS = [
     'trackEvent',
     'identify',
-    'trackPage',
-    'enable',
-    'disable',
-    'optIn',
-    'optOut',
+    'trackView',
+    'optInForRegularAccount',
+    'optOutForRegularAccount',
+    'optInForSocialAccount',
+    'optOutForSocialAccount',
 ];
 /**
  * The AnalyticsController manages analytics tracking across platforms (Mobile/Extension).
@@ -77,115 +80,149 @@ const MESSENGER_EXPOSED_METHODS = [
  * This controller follows the MetaMask controller pattern and integrates with the
  * messenger system to allow other controllers and components to track analytics events.
  * It delegates platform-specific implementation to an {@link AnalyticsPlatformAdapter}.
+ *
+ * Note: This controller does not persist state internally (`persist: false` in metadata).
+ * The platform is responsible for:
+ * - Providing the initial state (including a valid UUIDv4 analyticsId)
+ * - Subscribing to `AnalyticsController:stateChange` event to persist changes
  */
 export class AnalyticsController extends BaseController {
     /**
      * Constructs an AnalyticsController instance.
      *
      * @param options - Controller options
-     * @param options.state - Initial controller state (defaults from getDefaultAnalyticsControllerState)
+     * @param options.state - Initial controller state. Must include a valid UUIDv4 `analyticsId`.
+     * Use `getDefaultAnalyticsControllerState()` for default opt-in preferences.
      * @param options.messenger - Messenger used to communicate with BaseController
      * @param options.platformAdapter - Platform adapter implementation for tracking
+     * @throws Error if state.analyticsId is missing or not a valid UUIDv4
      */
-    constructor({ state = {}, messenger, platformAdapter, }) {
+    constructor({ state, messenger, platformAdapter, }) {
+        const initialState = {
+            ...getDefaultAnalyticsControllerState(),
+            ...state,
+        };
+        validateAnalyticsControllerState(initialState);
         super({
             name: controllerName,
             metadata: analyticsControllerMetadata,
-            state: {
-                ...getDefaultAnalyticsControllerState(),
-                ...state,
-            },
+            state: initialState,
             messenger,
         });
         _AnalyticsController_platformAdapter.set(this, void 0);
         __classPrivateFieldSet(this, _AnalyticsController_platformAdapter, platformAdapter, "f");
         this.messenger.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
         projectLogger('AnalyticsController initialized and ready', {
-            enabled: this.state.enabled,
-            optedIn: this.state.optedIn,
+            enabled: analyticsControllerSelectors.selectEnabled(this.state),
+            optedIn: this.state.optedInForRegularAccount,
+            socialOptedIn: this.state.optedInForSocialAccount,
             analyticsId: this.state.analyticsId,
         });
+        // Call onSetupCompleted lifecycle hook after initialization
+        // State is already validated, so analyticsId is guaranteed to be a valid UUIDv4
+        __classPrivateFieldGet(this, _AnalyticsController_platformAdapter, "f")
+            .onSetupCompleted(this.state.analyticsId)
+            .catch((error) => {
+            // Log error but don't throw - adapter setup failure shouldn't break controller
+            projectLogger('Error calling platformAdapter.onSetupCompleted', error);
+        });
     }
     /**
      * Track an analytics event.
      *
      * Events are only tracked if analytics is enabled.
      *
-     * @param eventName - The name of the event
-     * @param properties - Event properties
+     * @param event - Analytics event with properties and sensitive properties
      */
-    trackEvent(eventName, properties = {}) {
+    trackEvent(event) {
         // Don't track if analytics is disabled
-        if (!this.state.enabled) {
+        if (!analyticsControllerSelectors.selectEnabled(this.state)) {
             return;
         }
-        // Delegate to platform adapter
-        __classPrivateFieldGet(this, _AnalyticsController_platformAdapter, "f").trackEvent(eventName, properties);
+        // Derive sensitivity from presence of sensitiveProperties
+        const hasSensitiveProperties = Object.keys(event.sensitiveProperties).length > 0;
+        // if event does not have properties, send event without properties
+        // and return to prevent any additional processing
+        if (!event.hasProperties) {
+            __classPrivateFieldGet(this, _AnalyticsController_platformAdapter, "f").track(event.name);
+            return;
+        }
+        // Track regular properties (without isSensitive flag - it's the default)
+        // Note: Even if properties object is empty, we still send it to ensure
+        // an event with user ID is tracked. When only sensitiveProperties exist,
+        // this creates two events: one with empty props (user ID) and one with
+        // sensitive props (anonymous ID), which is the expected behavior.
+        __classPrivateFieldGet(this, _AnalyticsController_platformAdapter, "f").track(event.name, {
+            ...event.properties,
+        });
+        // Track sensitive properties in a separate event with isSensitive flag
+        if (hasSensitiveProperties) {
+            __classPrivateFieldGet(this, _AnalyticsController_platformAdapter, "f").track(event.name, {
+                ...event.properties,
+                ...event.sensitiveProperties,
+                isSensitive: true,
+            });
+        }
     }
     /**
      * Identify a user for analytics.
      *
-     * @param userId - The user identifier (e.g., metametrics ID)
      * @param traits - User traits/properties
      */
-    identify(userId, traits) {
-        if (!this.state.enabled) {
+    identify(traits) {
+        if (!analyticsControllerSelectors.selectEnabled(this.state)) {
             return;
         }
-        // Update state with analytics ID
-        this.update((state) => {
-            state.analyticsId = userId;
-        });
-        // Delegate to platform adapter if supported
-        if (__classPrivateFieldGet(this, _AnalyticsController_platformAdapter, "f").identify) {
-            __classPrivateFieldGet(this, _AnalyticsController_platformAdapter, "f").identify(userId, traits);
-        }
+        // Delegate to platform adapter using the current analytics ID
+        __classPrivateFieldGet(this, _AnalyticsController_platformAdapter, "f").identify(this.state.analyticsId, traits);
     }
     /**
-     * Track a page view.
+     * Track a page or screen view.
      *
-     * @param pageName - The name of the page
-     * @param properties - Page properties
+     * @param name - The identifier/name of the page or screen being viewed (e.g., "home", "settings", "wallet")
+     * @param properties - Optional properties associated with the view
      */
-    trackPage(pageName, properties) {
-        if (!this.state.enabled) {
+    trackView(name, properties) {
+        if (!analyticsControllerSelectors.selectEnabled(this.state)) {
             return;
         }
-        // Delegate to platform adapter if supported
-        if (__classPrivateFieldGet(this, _AnalyticsController_platformAdapter, "f").trackPage) {
-            __classPrivateFieldGet(this, _AnalyticsController_platformAdapter, "f").trackPage(pageName, properties);
-        }
+        // Delegate to platform adapter
+        __classPrivateFieldGet(this, _AnalyticsController_platformAdapter, "f").view(name, properties);
     }
     /**
-     * Enable analytics tracking.
+     * Opt in to analytics for regular account.
+     * This updates the user's opt-in status for regular account.
      */
-    enable() {
+    optInForRegularAccount() {
         this.update((state) => {
-            state.enabled = true;
+            state.optedInForRegularAccount = true;
         });
     }
     /**
-     * Disable analytics tracking.
+     * Opt out of analytics for regular account.
+     * This updates the user's opt-in status for regular account.
      */
-    disable() {
+    optOutForRegularAccount() {
         this.update((state) => {
-            state.enabled = false;
+            state.optedInForRegularAccount = false;
         });
     }
     /**
-     * Opt in to analytics.
+     * Opt in to analytics for social account.
+     * This updates the user's opt-in status for social account.
      */
-    optIn() {
+    optInForSocialAccount() {
         this.update((state) => {
-            state.optedIn = true;
+            state.optedInForSocialAccount = true;
         });
     }
     /**
-     * Opt out of analytics.
+     * Opt out of analytics for social account.
+     * This updates the user's opt-in status for social account.
      */
-    optOut() {
+    optOutForSocialAccount() {
         this.update((state) => {
-            state.optedIn = false;
+            state.optedInForSocialAccount = false;
         });
     }
 }

package/dist/AnalyticsController.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"AnalyticsController.mjs","sourceRoot":"","sources":["../src/AnalyticsController.ts"],"names":[],"mappings":";;;;;;;;;;;;AAKA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAE3D,OAAO,EAAE,EAAE,IAAI,MAAM,EAAE,aAAa;AAGpC,OAAO,EAAE,aAAa,EAAE,8BAA0B;AAMlD,kBAAkB;AAElB;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,qBAAqB,CAAC;AAwBpD;;GAEG;AACH,MAAM,2BAA2B,GAAG;IAClC,OAAO,EAAE;QACP,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,IAAI;QAC5B,QAAQ,EAAE,IAAI;KACf;IACD,OAAO,EAAE;QACP,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,IAAI;QAC5B,QAAQ,EAAE,IAAI;KACf;IACD,WAAW,EAAE;QACX,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,IAAI;QAC5B,QAAQ,EAAE,KAAK;KAChB;CACgD,CAAC;AAEpD;;;;;;;GAOG;AACH,MAAM,UAAU,kCAAkC;IAChD,OAAO;QACL,OAAO,EAAE,IAAI;QACb,OAAO,EAAE,KAAK;QACd,WAAW,EAAE,MAAM,EAAE;KACtB,CAAC;AACJ,CAAC;AAED,oBAAoB;AAEpB,MAAM,yBAAyB,GAAG;IAChC,YAAY;IACZ,UAAU;IACV,WAAW;IACX,QAAQ;IACR,SAAS;IACT,OAAO;IACP,QAAQ;CACA,CAAC;AAgEX;;;;;;;;;GASG;AACH,MAAM,OAAO,mBAAoB,SAAQ,cAIxC;IAGC;;;;;;;OAOG;IACH,YAAY,EACV,KAAK,GAAG,EAAE,EACV,SAAS,EACT,eAAe,GACY;QAC3B,KAAK,CAAC;YACJ,IAAI,EAAE,cAAc;YACpB,QAAQ,EAAE,2BAA2B;YACrC,KAAK,EAAE;gBACL,GAAG,kCAAkC,EAAE;gBACvC,GAAG,KAAK;aACT;YACD,SAAS;SACV,CAAC,CAAC;QAvBI,uDAA2C;QAyBlD,uBAAA,IAAI,wCAAoB,eAAe,MAAA,CAAC;QAExC,IAAI,CAAC,SAAS,CAAC,4BAA4B,CACzC,IAAI,EACJ,yBAAyB,CAC1B,CAAC;QAEF,aAAa,CAAC,2CAA2C,EAAE;YACzD,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO;YAC3B,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO;YAC3B,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,WAAW;SACpC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,UAAU,CACR,SAAiB,EACjB,aAAuC,EAAE;QAEzC,uCAAuC;QACvC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;YACxB,OAAO;QACT,CAAC;QAED,+BAA+B;QAC/B,uBAAA,IAAI,4CAAiB,CAAC,UAAU,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;OAKG;IACH,QAAQ,CAAC,MAAc,EAAE,MAAiC;QACxD,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;YACxB,OAAO;QACT,CAAC;QAED,iCAAiC;QACjC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,WAAW,GAAG,MAAM,CAAC;QAC7B,CAAC,CAAC,CAAC;QAEH,4CAA4C;QAC5C,IAAI,uBAAA,IAAI,4CAAiB,CAAC,QAAQ,EAAE,CAAC;YACnC,uBAAA,IAAI,4CAAiB,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACjD,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAC,QAAgB,EAAE,UAAqC;QAC/D,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;YACxB,OAAO;QACT,CAAC;QAED,4CAA4C;QAC5C,IAAI,uBAAA,IAAI,4CAAiB,CAAC,SAAS,EAAE,CAAC;YACpC,uBAAA,IAAI,4CAAiB,CAAC,SAAS,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;QACxD,CAAC;IACH,CAAC;IAED;;OAEG;IACH,MAAM;QACJ,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC;QACvB,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,OAAO;QACL,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,OAAO,GAAG,KAAK,CAAC;QACxB,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK;QACH,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC;QACvB,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,MAAM;QACJ,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,OAAO,GAAG,KAAK,CAAC;QACxB,CAAC,CAAC,CAAC;IACL,CAAC;CACF","sourcesContent":["import type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n  StateMetadata,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport type { Messenger } from '@metamask/messenger';\nimport { v4 as uuidv4 } from 'uuid';\n\nimport type { AnalyticsControllerMethodActions } from './AnalyticsController-method-action-types';\nimport { projectLogger } from './AnalyticsLogger';\nimport type {\n  AnalyticsPlatformAdapter,\n  AnalyticsEventProperties,\n} from './AnalyticsPlatformAdapter.types';\n\n// === GENERAL ===\n\n/**\n * The name of the {@link AnalyticsController}, used to namespace the\n * controller's actions and events and to namespace the controller's state data\n * when composed with other controllers.\n */\nexport const controllerName = 'AnalyticsController';\n\n// === STATE ===\n\n/**\n * Describes the shape of the state object for {@link AnalyticsController}.\n */\nexport type AnalyticsControllerState = {\n  /**\n   * Whether analytics tracking is enabled\n   */\n  enabled: boolean;\n\n  /**\n   * Whether the user has opted in to analytics\n   */\n  optedIn: boolean;\n\n  /**\n   * User's UUIDv4 analytics identifier\n   */\n  analyticsId: string;\n};\n\n/**\n * The metadata for each property in {@link AnalyticsControllerState}.\n */\nconst analyticsControllerMetadata = {\n  enabled: {\n    includeInStateLogs: true,\n    persist: true,\n    includeInDebugSnapshot: true,\n    usedInUi: true,\n  },\n  optedIn: {\n    includeInStateLogs: true,\n    persist: true,\n    includeInDebugSnapshot: true,\n    usedInUi: true,\n  },\n  analyticsId: {\n    includeInStateLogs: true,\n    persist: true,\n    includeInDebugSnapshot: true,\n    usedInUi: false,\n  },\n} satisfies StateMetadata<AnalyticsControllerState>;\n\n/**\n * Constructs the default {@link AnalyticsController} state. This allows\n * consumers to provide a partial state object when initializing the controller\n * and also helps in constructing complete state objects for this controller in\n * tests.\n *\n * @returns The default {@link AnalyticsController} state.\n */\nexport function getDefaultAnalyticsControllerState(): AnalyticsControllerState {\n  return {\n    enabled: true,\n    optedIn: false,\n    analyticsId: uuidv4(),\n  };\n}\n\n// === MESSENGER ===\n\nconst MESSENGER_EXPOSED_METHODS = [\n  'trackEvent',\n  'identify',\n  'trackPage',\n  'enable',\n  'disable',\n  'optIn',\n  'optOut',\n] as const;\n\n/**\n * Returns the state of the {@link AnalyticsController}.\n */\nexport type AnalyticsControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  AnalyticsControllerState\n>;\n\n/**\n * Actions that {@link AnalyticsControllerMessenger} exposes to other consumers.\n */\nexport type AnalyticsControllerActions =\n  | AnalyticsControllerGetStateAction\n  | AnalyticsControllerMethodActions;\n\n/**\n * Actions from other messengers that {@link AnalyticsControllerMessenger} calls.\n */\ntype AllowedActions = never;\n\n/**\n * Event emitted when the state of the {@link AnalyticsController} changes.\n */\nexport type AnalyticsControllerStateChangeEvent = ControllerStateChangeEvent<\n  typeof controllerName,\n  AnalyticsControllerState\n>;\n\n/**\n * Events that {@link AnalyticsControllerMessenger} exposes to other consumers.\n */\nexport type AnalyticsControllerEvents = AnalyticsControllerStateChangeEvent;\n\n/**\n * Events from other messengers that {@link AnalyticsControllerMessenger} subscribes to.\n */\ntype AllowedEvents = never;\n\n/**\n * The messenger restricted to actions and events accessed by\n * {@link AnalyticsController}.\n */\nexport type AnalyticsControllerMessenger = Messenger<\n  typeof controllerName,\n  AnalyticsControllerActions | AllowedActions,\n  AnalyticsControllerEvents | AllowedEvents\n>;\n\n// === CONTROLLER DEFINITION ===\n\n/**\n * The options that AnalyticsController takes.\n */\nexport type AnalyticsControllerOptions = {\n  state?: Partial<AnalyticsControllerState>;\n  messenger: AnalyticsControllerMessenger;\n  /**\n   * Platform adapter implementation for tracking events\n   */\n  platformAdapter: AnalyticsPlatformAdapter;\n};\n\n/**\n * The AnalyticsController manages analytics tracking across platforms (Mobile/Extension).\n * It provides a unified interface for tracking events, identifying users, and managing\n * analytics preferences while delegating platform-specific implementation to an\n * {@link AnalyticsPlatformAdapter}.\n *\n * This controller follows the MetaMask controller pattern and integrates with the\n * messenger system to allow other controllers and components to track analytics events.\n * It delegates platform-specific implementation to an {@link AnalyticsPlatformAdapter}.\n */\nexport class AnalyticsController extends BaseController<\n  'AnalyticsController',\n  AnalyticsControllerState,\n  AnalyticsControllerMessenger\n> {\n  readonly #platformAdapter: AnalyticsPlatformAdapter;\n\n  /**\n   * Constructs an AnalyticsController instance.\n   *\n   * @param options - Controller options\n   * @param options.state - Initial controller state (defaults from getDefaultAnalyticsControllerState)\n   * @param options.messenger - Messenger used to communicate with BaseController\n   * @param options.platformAdapter - Platform adapter implementation for tracking\n   */\n  constructor({\n    state = {},\n    messenger,\n    platformAdapter,\n  }: AnalyticsControllerOptions) {\n    super({\n      name: controllerName,\n      metadata: analyticsControllerMetadata,\n      state: {\n        ...getDefaultAnalyticsControllerState(),\n        ...state,\n      },\n      messenger,\n    });\n\n    this.#platformAdapter = platformAdapter;\n\n    this.messenger.registerMethodActionHandlers(\n      this,\n      MESSENGER_EXPOSED_METHODS,\n    );\n\n    projectLogger('AnalyticsController initialized and ready', {\n      enabled: this.state.enabled,\n      optedIn: this.state.optedIn,\n      analyticsId: this.state.analyticsId,\n    });\n  }\n\n  /**\n   * Track an analytics event.\n   *\n   * Events are only tracked if analytics is enabled.\n   *\n   * @param eventName - The name of the event\n   * @param properties - Event properties\n   */\n  trackEvent(\n    eventName: string,\n    properties: AnalyticsEventProperties = {},\n  ): void {\n    // Don't track if analytics is disabled\n    if (!this.state.enabled) {\n      return;\n    }\n\n    // Delegate to platform adapter\n    this.#platformAdapter.trackEvent(eventName, properties);\n  }\n\n  /**\n   * Identify a user for analytics.\n   *\n   * @param userId - The user identifier (e.g., metametrics ID)\n   * @param traits - User traits/properties\n   */\n  identify(userId: string, traits?: AnalyticsEventProperties): void {\n    if (!this.state.enabled) {\n      return;\n    }\n\n    // Update state with analytics ID\n    this.update((state) => {\n      state.analyticsId = userId;\n    });\n\n    // Delegate to platform adapter if supported\n    if (this.#platformAdapter.identify) {\n      this.#platformAdapter.identify(userId, traits);\n    }\n  }\n\n  /**\n   * Track a page view.\n   *\n   * @param pageName - The name of the page\n   * @param properties - Page properties\n   */\n  trackPage(pageName: string, properties?: AnalyticsEventProperties): void {\n    if (!this.state.enabled) {\n      return;\n    }\n\n    // Delegate to platform adapter if supported\n    if (this.#platformAdapter.trackPage) {\n      this.#platformAdapter.trackPage(pageName, properties);\n    }\n  }\n\n  /**\n   * Enable analytics tracking.\n   */\n  enable(): void {\n    this.update((state) => {\n      state.enabled = true;\n    });\n  }\n\n  /**\n   * Disable analytics tracking.\n   */\n  disable(): void {\n    this.update((state) => {\n      state.enabled = false;\n    });\n  }\n\n  /**\n   * Opt in to analytics.\n   */\n  optIn(): void {\n    this.update((state) => {\n      state.optedIn = true;\n    });\n  }\n\n  /**\n   * Opt out of analytics.\n   */\n  optOut(): void {\n    this.update((state) => {\n      state.optedIn = false;\n    });\n  }\n}\n"]}
+{"version":3,"file":"AnalyticsController.mjs","sourceRoot":"","sources":["../src/AnalyticsController.ts"],"names":[],"mappings":";;;;;;;;;;;;AAKA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAI3D,OAAO,EAAE,gCAAgC,EAAE,gDAA4C;AACvF,OAAO,EAAE,aAAa,EAAE,8BAA0B;AAOlD,OAAO,EAAE,4BAA4B,EAAE,wBAAoB;AAE3D,kBAAkB;AAElB;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,qBAAqB,CAAC;AA0BpD;;;;;;;GAOG;AACH,MAAM,UAAU,kCAAkC;IAIhD,OAAO;QACL,wBAAwB,EAAE,KAAK;QAC/B,uBAAuB,EAAE,KAAK;KAC/B,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,2BAA2B,GAAG;IAClC,wBAAwB,EAAE;QACxB,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,KAAK;QACd,sBAAsB,EAAE,IAAI;QAC5B,QAAQ,EAAE,IAAI;KACf;IACD,uBAAuB,EAAE;QACvB,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,KAAK;QACd,sBAAsB,EAAE,IAAI;QAC5B,QAAQ,EAAE,IAAI;KACf;IACD,WAAW,EAAE;QACX,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,KAAK;QACd,sBAAsB,EAAE,IAAI;QAC5B,QAAQ,EAAE,KAAK;KAChB;CACgD,CAAC;AAEpD,oBAAoB;AAEpB,MAAM,yBAAyB,GAAG;IAChC,YAAY;IACZ,UAAU;IACV,WAAW;IACX,wBAAwB;IACxB,yBAAyB;IACzB,uBAAuB;IACvB,wBAAwB;CAChB,CAAC;AAuEX;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAO,mBAAoB,SAAQ,cAIxC;IAGC;;;;;;;;;OASG;IACH,YAAY,EACV,KAAK,EACL,SAAS,EACT,eAAe,GACY;QAC3B,MAAM,YAAY,GAA6B;YAC7C,GAAG,kCAAkC,EAAE;YACvC,GAAG,KAAK;SACT,CAAC;QAEF,gCAAgC,CAAC,YAAY,CAAC,CAAC;QAE/C,KAAK,CAAC;YACJ,IAAI,EAAE,cAAc;YACpB,QAAQ,EAAE,2BAA2B;YACrC,KAAK,EAAE,YAAY;YACnB,SAAS;SACV,CAAC,CAAC;QA7BI,uDAA2C;QA+BlD,uBAAA,IAAI,wCAAoB,eAAe,MAAA,CAAC;QAExC,IAAI,CAAC,SAAS,CAAC,4BAA4B,CACzC,IAAI,EACJ,yBAAyB,CAC1B,CAAC;QAEF,aAAa,CAAC,2CAA2C,EAAE;YACzD,OAAO,EAAE,4BAA4B,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC;YAC/D,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,wBAAwB;YAC5C,aAAa,EAAE,IAAI,CAAC,KAAK,CAAC,uBAAuB;YACjD,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,WAAW;SACpC,CAAC,CAAC;QAEH,4DAA4D;QAC5D,gFAAgF;QAChF,uBAAA,IAAI,4CAAiB;aAClB,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC;aACxC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,+EAA+E;YAC/E,aAAa,CAAC,gDAAgD,EAAE,KAAK,CAAC,CAAC;QACzE,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;OAMG;IACH,UAAU,CAAC,KAA6B;QACtC,uCAAuC;QACvC,IAAI,CAAC,4BAA4B,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAC5D,OAAO;QACT,CAAC;QAED,0DAA0D;QAC1D,MAAM,sBAAsB,GAC1B,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;QAEpD,mEAAmE;QACnE,kDAAkD;QAClD,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE,CAAC;YACzB,uBAAA,IAAI,4CAAiB,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACxC,OAAO;QACT,CAAC;QAED,yEAAyE;QACzE,uEAAuE;QACvE,yEAAyE;QACzE,uEAAuE;QACvE,kEAAkE;QAClE,uBAAA,IAAI,4CAAiB,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE;YACtC,GAAG,KAAK,CAAC,UAAU;SACpB,CAAC,CAAC;QAEH,uEAAuE;QACvE,IAAI,sBAAsB,EAAE,CAAC;YAC3B,uBAAA,IAAI,4CAAiB,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE;gBACtC,GAAG,KAAK,CAAC,UAAU;gBACnB,GAAG,KAAK,CAAC,mBAAmB;gBAC5B,WAAW,EAAE,IAAI;aAClB,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,MAA4B;QACnC,IAAI,CAAC,4BAA4B,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAC5D,OAAO;QACT,CAAC;QAED,8DAA8D;QAC9D,uBAAA,IAAI,4CAAiB,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IACjE,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAC,IAAY,EAAE,UAAqC;QAC3D,IAAI,CAAC,4BAA4B,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAC5D,OAAO;QACT,CAAC;QAED,+BAA+B;QAC/B,uBAAA,IAAI,4CAAiB,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IAC/C,CAAC;IAED;;;OAGG;IACH,sBAAsB;QACpB,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,wBAAwB,GAAG,IAAI,CAAC;QACxC,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,uBAAuB;QACrB,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,wBAAwB,GAAG,KAAK,CAAC;QACzC,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,qBAAqB;QACnB,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,uBAAuB,GAAG,IAAI,CAAC;QACvC,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,sBAAsB;QACpB,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,uBAAuB,GAAG,KAAK,CAAC;QACxC,CAAC,CAAC,CAAC;IACL,CAAC;CACF","sourcesContent":["import type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n  StateMetadata,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport type { Messenger } from '@metamask/messenger';\n\nimport type { AnalyticsControllerMethodActions } from './AnalyticsController-method-action-types';\nimport { validateAnalyticsControllerState } from './analyticsControllerStateValidator';\nimport { projectLogger } from './AnalyticsLogger';\nimport type {\n  AnalyticsPlatformAdapter,\n  AnalyticsEventProperties,\n  AnalyticsUserTraits,\n  AnalyticsTrackingEvent,\n} from './AnalyticsPlatformAdapter.types';\nimport { analyticsControllerSelectors } from './selectors';\n\n// === GENERAL ===\n\n/**\n * The name of the {@link AnalyticsController}, used to namespace the\n * controller's actions and events and to namespace the controller's state data\n * when composed with other controllers.\n */\nexport const controllerName = 'AnalyticsController';\n\n// === STATE ===\n\n/**\n * Describes the shape of the state object for {@link AnalyticsController}.\n */\nexport type AnalyticsControllerState = {\n  /**\n   * Whether the user has opted in to analytics for regular account.\n   */\n  optedInForRegularAccount: boolean;\n\n  /**\n   * Whether the user has opted in to analytics for social account.\n   */\n  optedInForSocialAccount: boolean;\n\n  /**\n   * User's UUIDv4 analytics identifier.\n   * This is an identity (unique per user), not a preference.\n   * Must be provided by the platform - the controller does not generate it.\n   */\n  analyticsId: string;\n};\n\n/**\n * Returns default values for AnalyticsController state.\n *\n * Note: analyticsId is NOT included - it's an identity that must be\n * provided by the platform (generated once on first run, then persisted).\n *\n * @returns Default state without analyticsId\n */\nexport function getDefaultAnalyticsControllerState(): Omit<\n  AnalyticsControllerState,\n  'analyticsId'\n> {\n  return {\n    optedInForRegularAccount: false,\n    optedInForSocialAccount: false,\n  };\n}\n\n/**\n * The metadata for each property in {@link AnalyticsControllerState}.\n *\n * Note: `persist` is set to `false` for all fields because the platform\n * is responsible for persistence via the `stateChange` event listener.\n */\nconst analyticsControllerMetadata = {\n  optedInForRegularAccount: {\n    includeInStateLogs: true,\n    persist: false,\n    includeInDebugSnapshot: true,\n    usedInUi: true,\n  },\n  optedInForSocialAccount: {\n    includeInStateLogs: true,\n    persist: false,\n    includeInDebugSnapshot: true,\n    usedInUi: true,\n  },\n  analyticsId: {\n    includeInStateLogs: true,\n    persist: false,\n    includeInDebugSnapshot: true,\n    usedInUi: false,\n  },\n} satisfies StateMetadata<AnalyticsControllerState>;\n\n// === MESSENGER ===\n\nconst MESSENGER_EXPOSED_METHODS = [\n  'trackEvent',\n  'identify',\n  'trackView',\n  'optInForRegularAccount',\n  'optOutForRegularAccount',\n  'optInForSocialAccount',\n  'optOutForSocialAccount',\n] as const;\n\n/**\n * Returns the state of the {@link AnalyticsController}.\n */\nexport type AnalyticsControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  AnalyticsControllerState\n>;\n\n/**\n * Actions that {@link AnalyticsControllerMessenger} exposes to other consumers.\n */\nexport type AnalyticsControllerActions =\n  | AnalyticsControllerGetStateAction\n  | AnalyticsControllerMethodActions;\n\n/**\n * Actions from other messengers that {@link AnalyticsControllerMessenger} calls.\n */\ntype AllowedActions = never;\n\n/**\n * Event emitted when the state of the {@link AnalyticsController} changes.\n */\nexport type AnalyticsControllerStateChangeEvent = ControllerStateChangeEvent<\n  typeof controllerName,\n  AnalyticsControllerState\n>;\n\n/**\n * Events that {@link AnalyticsControllerMessenger} exposes to other consumers.\n */\nexport type AnalyticsControllerEvents = AnalyticsControllerStateChangeEvent;\n\n/**\n * Events from other messengers that {@link AnalyticsControllerMessenger} subscribes to.\n */\ntype AllowedEvents = never;\n\n/**\n * The messenger restricted to actions and events accessed by\n * {@link AnalyticsController}.\n */\nexport type AnalyticsControllerMessenger = Messenger<\n  typeof controllerName,\n  AnalyticsControllerActions | AllowedActions,\n  AnalyticsControllerEvents | AllowedEvents\n>;\n\n// === CONTROLLER DEFINITION ===\n\n/**\n * The options that AnalyticsController takes.\n */\nexport type AnalyticsControllerOptions = {\n  /**\n   * Initial controller state. Must include a valid UUIDv4 `analyticsId`.\n   * The platform is responsible for generating and persisting the analyticsId.\n   */\n  state: AnalyticsControllerState;\n  /**\n   * Messenger used to communicate with BaseController and other controllers.\n   */\n  messenger: AnalyticsControllerMessenger;\n  /**\n   * Platform adapter implementation for tracking events.\n   */\n  platformAdapter: AnalyticsPlatformAdapter;\n};\n\n/**\n * The AnalyticsController manages analytics tracking across platforms (Mobile/Extension).\n * It provides a unified interface for tracking events, identifying users, and managing\n * analytics preferences while delegating platform-specific implementation to an\n * {@link AnalyticsPlatformAdapter}.\n *\n * This controller follows the MetaMask controller pattern and integrates with the\n * messenger system to allow other controllers and components to track analytics events.\n * It delegates platform-specific implementation to an {@link AnalyticsPlatformAdapter}.\n *\n * Note: This controller does not persist state internally (`persist: false` in metadata).\n * The platform is responsible for:\n * - Providing the initial state (including a valid UUIDv4 analyticsId)\n * - Subscribing to `AnalyticsController:stateChange` event to persist changes\n */\nexport class AnalyticsController extends BaseController<\n  'AnalyticsController',\n  AnalyticsControllerState,\n  AnalyticsControllerMessenger\n> {\n  readonly #platformAdapter: AnalyticsPlatformAdapter;\n\n  /**\n   * Constructs an AnalyticsController instance.\n   *\n   * @param options - Controller options\n   * @param options.state - Initial controller state. Must include a valid UUIDv4 `analyticsId`.\n   * Use `getDefaultAnalyticsControllerState()` for default opt-in preferences.\n   * @param options.messenger - Messenger used to communicate with BaseController\n   * @param options.platformAdapter - Platform adapter implementation for tracking\n   * @throws Error if state.analyticsId is missing or not a valid UUIDv4\n   */\n  constructor({\n    state,\n    messenger,\n    platformAdapter,\n  }: AnalyticsControllerOptions) {\n    const initialState: AnalyticsControllerState = {\n      ...getDefaultAnalyticsControllerState(),\n      ...state,\n    };\n\n    validateAnalyticsControllerState(initialState);\n\n    super({\n      name: controllerName,\n      metadata: analyticsControllerMetadata,\n      state: initialState,\n      messenger,\n    });\n\n    this.#platformAdapter = platformAdapter;\n\n    this.messenger.registerMethodActionHandlers(\n      this,\n      MESSENGER_EXPOSED_METHODS,\n    );\n\n    projectLogger('AnalyticsController initialized and ready', {\n      enabled: analyticsControllerSelectors.selectEnabled(this.state),\n      optedIn: this.state.optedInForRegularAccount,\n      socialOptedIn: this.state.optedInForSocialAccount,\n      analyticsId: this.state.analyticsId,\n    });\n\n    // Call onSetupCompleted lifecycle hook after initialization\n    // State is already validated, so analyticsId is guaranteed to be a valid UUIDv4\n    this.#platformAdapter\n      .onSetupCompleted(this.state.analyticsId)\n      .catch((error) => {\n        // Log error but don't throw - adapter setup failure shouldn't break controller\n        projectLogger('Error calling platformAdapter.onSetupCompleted', error);\n      });\n  }\n\n  /**\n   * Track an analytics event.\n   *\n   * Events are only tracked if analytics is enabled.\n   *\n   * @param event - Analytics event with properties and sensitive properties\n   */\n  trackEvent(event: AnalyticsTrackingEvent): void {\n    // Don't track if analytics is disabled\n    if (!analyticsControllerSelectors.selectEnabled(this.state)) {\n      return;\n    }\n\n    // Derive sensitivity from presence of sensitiveProperties\n    const hasSensitiveProperties =\n      Object.keys(event.sensitiveProperties).length > 0;\n\n    // if event does not have properties, send event without properties\n    // and return to prevent any additional processing\n    if (!event.hasProperties) {\n      this.#platformAdapter.track(event.name);\n      return;\n    }\n\n    // Track regular properties (without isSensitive flag - it's the default)\n    // Note: Even if properties object is empty, we still send it to ensure\n    // an event with user ID is tracked. When only sensitiveProperties exist,\n    // this creates two events: one with empty props (user ID) and one with\n    // sensitive props (anonymous ID), which is the expected behavior.\n    this.#platformAdapter.track(event.name, {\n      ...event.properties,\n    });\n\n    // Track sensitive properties in a separate event with isSensitive flag\n    if (hasSensitiveProperties) {\n      this.#platformAdapter.track(event.name, {\n        ...event.properties,\n        ...event.sensitiveProperties,\n        isSensitive: true,\n      });\n    }\n  }\n\n  /**\n   * Identify a user for analytics.\n   *\n   * @param traits - User traits/properties\n   */\n  identify(traits?: AnalyticsUserTraits): void {\n    if (!analyticsControllerSelectors.selectEnabled(this.state)) {\n      return;\n    }\n\n    // Delegate to platform adapter using the current analytics ID\n    this.#platformAdapter.identify(this.state.analyticsId, traits);\n  }\n\n  /**\n   * Track a page or screen view.\n   *\n   * @param name - The identifier/name of the page or screen being viewed (e.g., \"home\", \"settings\", \"wallet\")\n   * @param properties - Optional properties associated with the view\n   */\n  trackView(name: string, properties?: AnalyticsEventProperties): void {\n    if (!analyticsControllerSelectors.selectEnabled(this.state)) {\n      return;\n    }\n\n    // Delegate to platform adapter\n    this.#platformAdapter.view(name, properties);\n  }\n\n  /**\n   * Opt in to analytics for regular account.\n   * This updates the user's opt-in status for regular account.\n   */\n  optInForRegularAccount(): void {\n    this.update((state) => {\n      state.optedInForRegularAccount = true;\n    });\n  }\n\n  /**\n   * Opt out of analytics for regular account.\n   * This updates the user's opt-in status for regular account.\n   */\n  optOutForRegularAccount(): void {\n    this.update((state) => {\n      state.optedInForRegularAccount = false;\n    });\n  }\n\n  /**\n   * Opt in to analytics for social account.\n   * This updates the user's opt-in status for social account.\n   */\n  optInForSocialAccount(): void {\n    this.update((state) => {\n      state.optedInForSocialAccount = true;\n    });\n  }\n\n  /**\n   * Opt out of analytics for social account.\n   * This updates the user's opt-in status for social account.\n   */\n  optOutForSocialAccount(): void {\n    this.update((state) => {\n      state.optedInForSocialAccount = false;\n    });\n  }\n}\n"]}

package/dist/AnalyticsPlatformAdapter.types.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"AnalyticsPlatformAdapter.types.cjs","sourceRoot":"","sources":["../src/AnalyticsPlatformAdapter.types.ts"],"names":[],"mappings":"","sourcesContent":["import type { Json } from '@metamask/utils';\n\n/**\n * Analytics event properties\n */\nexport type AnalyticsEventProperties = Record<string, Json>;\n\n/**\n * Platform adapter interface for analytics tracking\n * Implementations should handle platform-specific details (Segment SDK, etc.)\n *\n * @todo This type is work in progress and will be updated as we\n * integrate with the new analytics system on mobile.\n * We have this draft type to help us iterate on the implementation.\n * It will be updated with proper types as we create the mobile adapter\n * And the controller package will be released only when this is completed.\n */\nexport type AnalyticsPlatformAdapter = {\n  /**\n   * Track an analytics event\n   *\n   * @param eventName - The name of the event\n   * @param properties - Event properties\n   */\n  trackEvent(eventName: string, properties: AnalyticsEventProperties): void;\n\n  /**\n   * Identify a user\n   *\n   * @param userId - The user identifier (e.g., metametrics ID)\n   * @param traits - User traits/properties\n   */\n  identify?(userId: string, traits?: AnalyticsEventProperties): void;\n\n  /**\n   * Track a page view\n   *\n   * @param pageName - The name of the page\n   * @param properties - Page properties\n   */\n  trackPage?(pageName: string, properties?: AnalyticsEventProperties): void;\n};\n"]}
+{"version":3,"file":"AnalyticsPlatformAdapter.types.cjs","sourceRoot":"","sources":["../src/AnalyticsPlatformAdapter.types.ts"],"names":[],"mappings":"","sourcesContent":["import type { Json } from '@metamask/utils';\n\n/**\n * Analytics event properties\n */\nexport type AnalyticsEventProperties = Record<string, Json>;\n\n/**\n * User traits/properties for analytics identification\n */\nexport type AnalyticsUserTraits = Record<string, Json>;\n\n/**\n * Event properties structure with two distinct properties lists for regular and sensitive data.\n * Similar to ITrackingEvent from legacy analytics but decoupled for platform agnosticism.\n * Sensitivity is derived from the presence of sensitiveProperties (if sensitiveProperties has keys, the event is sensitive).\n */\nexport type AnalyticsTrackingEvent = {\n  readonly name: string;\n  properties: AnalyticsEventProperties;\n  sensitiveProperties: AnalyticsEventProperties;\n  /**\n   * Legacy property handled by the mobile app.\n   * This property is ignored by the analytics controller and will be removed from the type in the future.\n   * The mobile app will use the future analytics privacy controller to handle this functionality.\n   */\n  saveDataRecording: boolean;\n  readonly hasProperties: boolean;\n};\n\n/**\n * Platform adapter interface for analytics tracking\n * Implementations should handle platform-specific details (Segment SDK, etc.)\n */\nexport type AnalyticsPlatformAdapter = {\n  /**\n   * Track an analytics event.\n   *\n   * This is the same as trackEvent in the old analytics system\n   *\n   * @param eventName - The name of the event\n   * @param properties - Event properties. If not provided, the event has no properties.\n   * The privacy plugin should check for `isSensitive === true` to determine if an event contains sensitive data.\n   */\n  track(eventName: string, properties?: AnalyticsEventProperties): void;\n\n  /**\n   * Identify a user with traits.\n   *\n   * @param userId - The user identifier (e.g., metametrics ID)\n   * @param traits - User traits/properties\n   */\n  identify(userId: string, traits?: AnalyticsUserTraits): void;\n\n  /**\n   * Track a UI unit (page or screen) view depending on the platform\n   *\n   * This method delegates to platform-specific Segment SDK methods:\n   * - Web adapters should call `analytics.page(name, properties)`\n   * - Mobile adapters should call `analytics.screen(name, properties)`\n   *\n   * @param name - The identifier/name of the page or screen being viewed (e.g., \"home\", \"settings\", \"wallet\")\n   * @param properties - Optional properties associated with the view\n   */\n  view(name: string, properties?: AnalyticsEventProperties): void;\n\n  /**\n   * Lifecycle hook called after the AnalyticsController is fully initialized.\n   *\n   * This hook allows platform-specific adapters to perform setup that requires\n   * access to the controller's state (e.g., analyticsId).\n   *\n   * The controller calls this method once after initialization, passing the\n   * analyticsId from controller state. The analyticsId is guaranteed to be set\n   * when this method is called - this is the definition of \"completed\" setup.\n   *\n   * @param analyticsId - The analytics ID from controller state. Always set (never empty).\n   * @throws {AnalyticsPlatformAdapterSetupError} May throw errors during setup (e.g., configuration errors, network failures).\n   * Errors thrown by this method are caught and logged by the controller, but do not prevent\n   * controller initialization from completing successfully.\n   *\n   * @example\n   * ```typescript\n   * async onSetupCompleted(analyticsId: string): Promise<void> {\n   *   // Add platform-specific plugins that require analyticsId\n   *   client.add({\n   *     plugin: new PrivacyPlugin(analyticsId),\n   *   });\n   * }\n   * ```\n   */\n  onSetupCompleted(analyticsId: string): Promise<void>;\n};\n"]}

package/dist/AnalyticsPlatformAdapter.types.d.cts

@@ -3,37 +3,85 @@ import type { Json } from "@metamask/utils";
  * Analytics event properties
  */
 export type AnalyticsEventProperties = Record<string, Json>;
+/**
+ * User traits/properties for analytics identification
+ */
+export type AnalyticsUserTraits = Record<string, Json>;
+/**
+ * Event properties structure with two distinct properties lists for regular and sensitive data.
+ * Similar to ITrackingEvent from legacy analytics but decoupled for platform agnosticism.
+ * Sensitivity is derived from the presence of sensitiveProperties (if sensitiveProperties has keys, the event is sensitive).
+ */
+export type AnalyticsTrackingEvent = {
+    readonly name: string;
+    properties: AnalyticsEventProperties;
+    sensitiveProperties: AnalyticsEventProperties;
+    /**
+     * Legacy property handled by the mobile app.
+     * This property is ignored by the analytics controller and will be removed from the type in the future.
+     * The mobile app will use the future analytics privacy controller to handle this functionality.
+     */
+    saveDataRecording: boolean;
+    readonly hasProperties: boolean;
+};
 /**
  * Platform adapter interface for analytics tracking
  * Implementations should handle platform-specific details (Segment SDK, etc.)
- *
- * @todo This type is work in progress and will be updated as we
- * integrate with the new analytics system on mobile.
- * We have this draft type to help us iterate on the implementation.
- * It will be updated with proper types as we create the mobile adapter
- * And the controller package will be released only when this is completed.
  */
 export type AnalyticsPlatformAdapter = {
     /**
-     * Track an analytics event
+     * Track an analytics event.
+     *
+     * This is the same as trackEvent in the old analytics system
      *
      * @param eventName - The name of the event
-     * @param properties - Event properties
+     * @param properties - Event properties. If not provided, the event has no properties.
+     * The privacy plugin should check for `isSensitive === true` to determine if an event contains sensitive data.
      */
-    trackEvent(eventName: string, properties: AnalyticsEventProperties): void;
+    track(eventName: string, properties?: AnalyticsEventProperties): void;
     /**
-     * Identify a user
+     * Identify a user with traits.
      *
      * @param userId - The user identifier (e.g., metametrics ID)
      * @param traits - User traits/properties
      */
-    identify?(userId: string, traits?: AnalyticsEventProperties): void;
+    identify(userId: string, traits?: AnalyticsUserTraits): void;
     /**
-     * Track a page view
+     * Track a UI unit (page or screen) view depending on the platform
+     *
+     * This method delegates to platform-specific Segment SDK methods:
+     * - Web adapters should call `analytics.page(name, properties)`
+     * - Mobile adapters should call `analytics.screen(name, properties)`
+     *
+     * @param name - The identifier/name of the page or screen being viewed (e.g., "home", "settings", "wallet")
+     * @param properties - Optional properties associated with the view
+     */
+    view(name: string, properties?: AnalyticsEventProperties): void;
+    /**
+     * Lifecycle hook called after the AnalyticsController is fully initialized.
+     *
+     * This hook allows platform-specific adapters to perform setup that requires
+     * access to the controller's state (e.g., analyticsId).
+     *
+     * The controller calls this method once after initialization, passing the
+     * analyticsId from controller state. The analyticsId is guaranteed to be set
+     * when this method is called - this is the definition of "completed" setup.
+     *
+     * @param analyticsId - The analytics ID from controller state. Always set (never empty).
+     * @throws {AnalyticsPlatformAdapterSetupError} May throw errors during setup (e.g., configuration errors, network failures).
+     * Errors thrown by this method are caught and logged by the controller, but do not prevent
+     * controller initialization from completing successfully.
      *
-     * @param pageName - The name of the page
-     * @param properties - Page properties
+     * @example
+     * ```typescript
+     * async onSetupCompleted(analyticsId: string): Promise<void> {
+     *   // Add platform-specific plugins that require analyticsId
+     *   client.add({
+     *     plugin: new PrivacyPlugin(analyticsId),
+     *   });
+     * }
+     * ```
      */
-    trackPage?(pageName: string, properties?: AnalyticsEventProperties): void;
+    onSetupCompleted(analyticsId: string): Promise<void>;
 };
 //# sourceMappingURL=AnalyticsPlatformAdapter.types.d.cts.map

package/dist/AnalyticsPlatformAdapter.types.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"AnalyticsPlatformAdapter.types.d.cts","sourceRoot":"","sources":["../src/AnalyticsPlatformAdapter.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAE5C;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;AAE5D;;;;;;;;;GASG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;;;;OAKG;IACH,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,wBAAwB,GAAG,IAAI,CAAC;IAE1E;;;;;OAKG;IACH,QAAQ,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,wBAAwB,GAAG,IAAI,CAAC;IAEnE;;;;;OAKG;IACH,SAAS,CAAC,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,wBAAwB,GAAG,IAAI,CAAC;CAC3E,CAAC"}
+{"version":3,"file":"AnalyticsPlatformAdapter.types.d.cts","sourceRoot":"","sources":["../src/AnalyticsPlatformAdapter.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAE5C;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;AAE5D;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;AAEvD;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,wBAAwB,CAAC;IACrC,mBAAmB,EAAE,wBAAwB,CAAC;IAC9C;;;;OAIG;IACH,iBAAiB,EAAE,OAAO,CAAC;IAC3B,QAAQ,CAAC,aAAa,EAAE,OAAO,CAAC;CACjC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;;;;;;;OAQG;IACH,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,wBAAwB,GAAG,IAAI,CAAC;IAEtE;;;;;OAKG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAE7D;;;;;;;;;OASG;IACH,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,wBAAwB,GAAG,IAAI,CAAC;IAEhE;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,gBAAgB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACtD,CAAC"}