@metamask-previews/analytics-controller 0.0.0-preview-21a5ddac → 0.0.0-preview-4ed214fa

package/CHANGELOG.md

@@ -9,6 +9,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- Initial release of @metamask/analytics-controller.
+- Initial release of @metamask/analytics-controller. ([#7017](https://github.com/MetaMask/core/pull/7017), [#7202](https://github.com/MetaMask/core/pull/7202))
 
 [Unreleased]: https://github.com/MetaMask/core/

package/README.md

@@ -30,24 +30,15 @@ The controller delegates platform-specific analytics implementation to a `Analyt
 import type { AnalyticsPlatformAdapter } from '@metamask/analytics-controller';
 
 const platformAdapter: AnalyticsPlatformAdapter = {
-  track: (eventName: string, properties: Record<string, unknown>) => {
+  trackEvent: (eventName: string, properties: Record<string, unknown>) => {
     // Platform-specific implementation (e.g., Segment, Mixpanel, etc.)
     segment.track(eventName, properties);
   },
   identify: (userId: string, traits?: Record<string, unknown>) => {
     segment.identify(userId, traits);
   },
-  view: (name: string, properties?: Record<string, unknown>) => {
-    segment.page(name, properties);
-  },
-  onSetupCompleted: (analyticsId: string) => {
-    // Lifecycle hook called after controller initialization
-    // The analyticsId is guaranteed to be set when this method is called
-    // Use this for platform-specific setup that requires the analytics ID
-    // For example, adding plugins that need the analytics ID:
-    segment.add({
-      plugin: new PrivacyPlugin(analyticsId),
-    });
+  trackPage: (pageName: string, properties?: Record<string, unknown>) => {
+    segment.page(pageName, properties);
   },
 };
 ```
@@ -121,7 +112,7 @@ console.log(controller.state.analyticsId); // '550e8400-e29b-41d4-a716-446655440
 ### 5. Track Page Views
 
 ```typescript
-controller.trackView('home', {
+controller.trackPage('home', {
   referrer: 'google',
   campaign: 'summer-2024',
 });
@@ -134,13 +125,9 @@ controller.trackView('home', {
 controller.enable();
 controller.disable();
 
-// Opt in/out for regular account
-controller.optInForRegularAccount();
-controller.optOutForRegularAccount();
-
-// Opt in/out for social account
-controller.optInForSocialAccount();
-controller.optOutForSocialAccount();
+// Opt in/out
+controller.optIn();
+controller.optOut();
 ```
 
 ### 7. Use Messenger Actions
@@ -161,10 +148,10 @@ messenger.call(
   },
 );
 
-messenger.call('AnalyticsController:optInForRegularAccount');
-messenger.call('AnalyticsController:optOutForRegularAccount');
-messenger.call('AnalyticsController:optInForSocialAccount');
-messenger.call('AnalyticsController:optOutForSocialAccount');
+messenger.call('AnalyticsController:enable');
+messenger.call('AnalyticsController:disable');
+messenger.call('AnalyticsController:optIn');
+messenger.call('AnalyticsController:optOut');
 ```
 
 ### 8. Subscribe to State Changes
@@ -206,54 +193,6 @@ const defaultState = getDefaultAnalyticsControllerState();
 
 **Analytics ID:** The `analyticsId` is a UUIDv4 string. If not provided in the `state` parameter, the controller automatically generates one on initialization. This ID is persisted in state and remains consistent across restarts. If you provide an `analyticsId` in the `state` parameter, it will be used instead (useful for migrations).
 
-## Lifecycle Hooks
-
-### `onSetupCompleted`
-
-The `onSetupCompleted` lifecycle hook is called once 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`).
-
-**When it's called:**
-
-- After the controller is fully initialized
-- Only when `analyticsId` is set in controller state (the presence of `analyticsId` is the definition of "completed" setup)
-- The `analyticsId` parameter is guaranteed to be set and be a valid UUIDv4 when this method is called
-
-**What it's used for:**
-
-Platform-specific setup that requires access to adapter implementation like adding plugins or middleware that need the `analyticsId`
-Any initialization that depends on the controller being ready
-
-**Example usage:**
-
-```typescript
-const platformAdapter: AnalyticsPlatformAdapter = {
-  // ... other methods ...
-  onSetupCompleted: (analyticsId: string) => {
-    // Add platform-specific plugins that require analyticsId
-    client.add({
-      plugin: new PrivacyPlugin(analyticsId),
-    });
-  },
-};
-```
-
-**Error handling:**
-
-- Errors thrown in `onSetupCompleted` are caught and logged
-
-**Best practices:**
-
-- Use `onSetupCompleted` for setup that requires controller state
-- Keep setup logic minimal and focused
-- Handle errors gracefully within the hook
-- If you don't need setup, provide a no-op implementation:
-
-```typescript
-onSetupCompleted: (_analyticsId: string) => {
-  // No-op: this adapter doesn't need setup
-},
-```
-
 ## Debugging
 
 To display analytics-controller logs in the mobile app, you can add the following to your `.js.env` file:

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

@@ -1 +1 @@
-{"version":3,"file":"AnalyticsController-method-action-types.cjs","sourceRoot":"","sources":["../src/AnalyticsController-method-action-types.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated by `scripts/generate-method-action-types.ts`.\n * Do not edit manually.\n */\n\nimport type { AnalyticsController } from './AnalyticsController';\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 */\nexport type AnalyticsControllerTrackEventAction = {\n  type: `AnalyticsController:trackEvent`;\n  handler: AnalyticsController['trackEvent'];\n};\n\n/**\n * Identify a user for analytics.\n *\n * @param traits - User traits/properties\n */\nexport type AnalyticsControllerIdentifyAction = {\n  type: `AnalyticsController:identify`;\n  handler: AnalyticsController['identify'];\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 */\nexport type AnalyticsControllerTrackViewAction = {\n  type: `AnalyticsController:trackView`;\n  handler: AnalyticsController['trackView'];\n};\n\n/**\n * Opt in to analytics for regular account.\n * This updates the user's opt-in status for regular account.\n */\nexport type AnalyticsControllerOptInForRegularAccountAction = {\n  type: `AnalyticsController:optInForRegularAccount`;\n  handler: AnalyticsController['optInForRegularAccount'];\n};\n\n/**\n * Opt out of analytics for regular account.\n * This updates the user's opt-in status for regular account.\n */\nexport type AnalyticsControllerOptOutForRegularAccountAction = {\n  type: `AnalyticsController:optOutForRegularAccount`;\n  handler: AnalyticsController['optOutForRegularAccount'];\n};\n\n/**\n * Opt in to analytics for social account.\n * This updates the user's opt-in status for social account.\n */\nexport type AnalyticsControllerOptInForSocialAccountAction = {\n  type: `AnalyticsController:optInForSocialAccount`;\n  handler: AnalyticsController['optInForSocialAccount'];\n};\n\n/**\n * Opt out of analytics for social account.\n * This updates the user's opt-in status for social account.\n */\nexport type AnalyticsControllerOptOutForSocialAccountAction = {\n  type: `AnalyticsController:optOutForSocialAccount`;\n  handler: AnalyticsController['optOutForSocialAccount'];\n};\n\n/**\n * Union of all AnalyticsController action types.\n */\nexport type AnalyticsControllerMethodActions =\n  | AnalyticsControllerTrackEventAction\n  | AnalyticsControllerIdentifyAction\n  | AnalyticsControllerTrackViewAction\n  | AnalyticsControllerOptInForRegularAccountAction\n  | AnalyticsControllerOptOutForRegularAccountAction\n  | AnalyticsControllerOptInForSocialAccountAction\n  | AnalyticsControllerOptOutForSocialAccountAction;\n"]}
+{"version":3,"file":"AnalyticsController-method-action-types.cjs","sourceRoot":"","sources":["../src/AnalyticsController-method-action-types.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated by `scripts/generate-method-action-types.ts`.\n * Do not edit manually.\n */\n\nimport type { AnalyticsController } from './AnalyticsController';\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 */\nexport type AnalyticsControllerTrackEventAction = {\n  type: `AnalyticsController:trackEvent`;\n  handler: AnalyticsController['trackEvent'];\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 */\nexport type AnalyticsControllerIdentifyAction = {\n  type: `AnalyticsController:identify`;\n  handler: AnalyticsController['identify'];\n};\n\n/**\n * Track a page view.\n *\n * @param pageName - The name of the page\n * @param properties - Page properties\n */\nexport type AnalyticsControllerTrackPageAction = {\n  type: `AnalyticsController:trackPage`;\n  handler: AnalyticsController['trackPage'];\n};\n\n/**\n * Enable analytics tracking.\n */\nexport type AnalyticsControllerEnableAction = {\n  type: `AnalyticsController:enable`;\n  handler: AnalyticsController['enable'];\n};\n\n/**\n * Disable analytics tracking.\n */\nexport type AnalyticsControllerDisableAction = {\n  type: `AnalyticsController:disable`;\n  handler: AnalyticsController['disable'];\n};\n\n/**\n * Opt in to analytics.\n */\nexport type AnalyticsControllerOptInAction = {\n  type: `AnalyticsController:optIn`;\n  handler: AnalyticsController['optIn'];\n};\n\n/**\n * Opt out of analytics.\n */\nexport type AnalyticsControllerOptOutAction = {\n  type: `AnalyticsController:optOut`;\n  handler: AnalyticsController['optOut'];\n};\n\n/**\n * Union of all AnalyticsController action types.\n */\nexport type AnalyticsControllerMethodActions =\n  | AnalyticsControllerTrackEventAction\n  | AnalyticsControllerIdentifyAction\n  | AnalyticsControllerTrackPageAction\n  | AnalyticsControllerEnableAction\n  | AnalyticsControllerDisableAction\n  | AnalyticsControllerOptInAction\n  | AnalyticsControllerOptOutAction;\n"]}

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

@@ -8,7 +8,8 @@ import type { AnalyticsController } from "./AnalyticsController.cjs";
  *
  * Events are only tracked if analytics is enabled.
  *
- * @param event - Analytics event with properties and sensitive properties
+ * @param eventName - The name of the event
+ * @param properties - Event properties
  */
 export type AnalyticsControllerTrackEventAction = {
     type: `AnalyticsController:trackEvent`;
@@ -17,6 +18,7 @@ export type AnalyticsControllerTrackEventAction = {
 /**
  * Identify a user for analytics.
  *
+ * @param userId - The user identifier (e.g., metametrics ID)
  * @param traits - User traits/properties
  */
 export type AnalyticsControllerIdentifyAction = {
@@ -24,49 +26,45 @@ export type AnalyticsControllerIdentifyAction = {
     handler: AnalyticsController['identify'];
 };
 /**
- * Track a page or screen view.
+ * Track a page view.
  *
- * @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
+ * @param pageName - The name of the page
+ * @param properties - Page properties
  */
-export type AnalyticsControllerTrackViewAction = {
-    type: `AnalyticsController:trackView`;
-    handler: AnalyticsController['trackView'];
+export type AnalyticsControllerTrackPageAction = {
+    type: `AnalyticsController:trackPage`;
+    handler: AnalyticsController['trackPage'];
 };
 /**
- * Opt in to analytics for regular account.
- * This updates the user's opt-in status for regular account.
+ * Enable analytics tracking.
  */
-export type AnalyticsControllerOptInForRegularAccountAction = {
-    type: `AnalyticsController:optInForRegularAccount`;
-    handler: AnalyticsController['optInForRegularAccount'];
+export type AnalyticsControllerEnableAction = {
+    type: `AnalyticsController:enable`;
+    handler: AnalyticsController['enable'];
 };
 /**
- * Opt out of analytics for regular account.
- * This updates the user's opt-in status for regular account.
+ * Disable analytics tracking.
  */
-export type AnalyticsControllerOptOutForRegularAccountAction = {
-    type: `AnalyticsController:optOutForRegularAccount`;
-    handler: AnalyticsController['optOutForRegularAccount'];
+export type AnalyticsControllerDisableAction = {
+    type: `AnalyticsController:disable`;
+    handler: AnalyticsController['disable'];
 };
 /**
- * Opt in to analytics for social account.
- * This updates the user's opt-in status for social account.
+ * Opt in to analytics.
  */
-export type AnalyticsControllerOptInForSocialAccountAction = {
-    type: `AnalyticsController:optInForSocialAccount`;
-    handler: AnalyticsController['optInForSocialAccount'];
+export type AnalyticsControllerOptInAction = {
+    type: `AnalyticsController:optIn`;
+    handler: AnalyticsController['optIn'];
 };
 /**
- * Opt out of analytics for social account.
- * This updates the user's opt-in status for social account.
+ * Opt out of analytics.
  */
-export type AnalyticsControllerOptOutForSocialAccountAction = {
-    type: `AnalyticsController:optOutForSocialAccount`;
-    handler: AnalyticsController['optOutForSocialAccount'];
+export type AnalyticsControllerOptOutAction = {
+    type: `AnalyticsController:optOut`;
+    handler: AnalyticsController['optOut'];
 };
 /**
  * Union of all AnalyticsController action types.
  */
-export type AnalyticsControllerMethodActions = AnalyticsControllerTrackEventAction | AnalyticsControllerIdentifyAction | AnalyticsControllerTrackViewAction | AnalyticsControllerOptInForRegularAccountAction | AnalyticsControllerOptOutForRegularAccountAction | AnalyticsControllerOptInForSocialAccountAction | AnalyticsControllerOptOutForSocialAccountAction;
+export type AnalyticsControllerMethodActions = AnalyticsControllerTrackEventAction | AnalyticsControllerIdentifyAction | AnalyticsControllerTrackPageAction | AnalyticsControllerEnableAction | AnalyticsControllerDisableAction | AnalyticsControllerOptInAction | AnalyticsControllerOptOutAction;
 //# sourceMappingURL=AnalyticsController-method-action-types.d.cts.map

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

@@ -1 +1 @@
-{"version":3,"file":"AnalyticsController-method-action-types.d.cts","sourceRoot":"","sources":["../src/AnalyticsController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,mBAAmB,EAAE,kCAA8B;AAEjE;;;;;;GAMG;AACH,MAAM,MAAM,mCAAmC,GAAG;IAChD,IAAI,EAAE,gCAAgC,CAAC;IACvC,OAAO,EAAE,mBAAmB,CAAC,YAAY,CAAC,CAAC;CAC5C,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,iCAAiC,GAAG;IAC9C,IAAI,EAAE,8BAA8B,CAAC;IACrC,OAAO,EAAE,mBAAmB,CAAC,UAAU,CAAC,CAAC;CAC1C,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,kCAAkC,GAAG;IAC/C,IAAI,EAAE,+BAA+B,CAAC;IACtC,OAAO,EAAE,mBAAmB,CAAC,WAAW,CAAC,CAAC;CAC3C,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,+CAA+C,GAAG;IAC5D,IAAI,EAAE,4CAA4C,CAAC;IACnD,OAAO,EAAE,mBAAmB,CAAC,wBAAwB,CAAC,CAAC;CACxD,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,gDAAgD,GAAG;IAC7D,IAAI,EAAE,6CAA6C,CAAC;IACpD,OAAO,EAAE,mBAAmB,CAAC,yBAAyB,CAAC,CAAC;CACzD,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,8CAA8C,GAAG;IAC3D,IAAI,EAAE,2CAA2C,CAAC;IAClD,OAAO,EAAE,mBAAmB,CAAC,uBAAuB,CAAC,CAAC;CACvD,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,+CAA+C,GAAG;IAC5D,IAAI,EAAE,4CAA4C,CAAC;IACnD,OAAO,EAAE,mBAAmB,CAAC,wBAAwB,CAAC,CAAC;CACxD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gCAAgC,GACxC,mCAAmC,GACnC,iCAAiC,GACjC,kCAAkC,GAClC,+CAA+C,GAC/C,gDAAgD,GAChD,8CAA8C,GAC9C,+CAA+C,CAAC"}
+{"version":3,"file":"AnalyticsController-method-action-types.d.cts","sourceRoot":"","sources":["../src/AnalyticsController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,mBAAmB,EAAE,kCAA8B;AAEjE;;;;;;;GAOG;AACH,MAAM,MAAM,mCAAmC,GAAG;IAChD,IAAI,EAAE,gCAAgC,CAAC;IACvC,OAAO,EAAE,mBAAmB,CAAC,YAAY,CAAC,CAAC;CAC5C,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,iCAAiC,GAAG;IAC9C,IAAI,EAAE,8BAA8B,CAAC;IACrC,OAAO,EAAE,mBAAmB,CAAC,UAAU,CAAC,CAAC;CAC1C,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,kCAAkC,GAAG;IAC/C,IAAI,EAAE,+BAA+B,CAAC;IACtC,OAAO,EAAE,mBAAmB,CAAC,WAAW,CAAC,CAAC;CAC3C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,4BAA4B,CAAC;IACnC,OAAO,EAAE,mBAAmB,CAAC,QAAQ,CAAC,CAAC;CACxC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gCAAgC,GAAG;IAC7C,IAAI,EAAE,6BAA6B,CAAC;IACpC,OAAO,EAAE,mBAAmB,CAAC,SAAS,CAAC,CAAC;CACzC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG;IAC3C,IAAI,EAAE,2BAA2B,CAAC;IAClC,OAAO,EAAE,mBAAmB,CAAC,OAAO,CAAC,CAAC;CACvC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,4BAA4B,CAAC;IACnC,OAAO,EAAE,mBAAmB,CAAC,QAAQ,CAAC,CAAC;CACxC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gCAAgC,GACxC,mCAAmC,GACnC,iCAAiC,GACjC,kCAAkC,GAClC,+BAA+B,GAC/B,gCAAgC,GAChC,8BAA8B,GAC9B,+BAA+B,CAAC"}

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

@@ -8,7 +8,8 @@ import type { AnalyticsController } from "./AnalyticsController.mjs";
  *
  * Events are only tracked if analytics is enabled.
  *
- * @param event - Analytics event with properties and sensitive properties
+ * @param eventName - The name of the event
+ * @param properties - Event properties
  */
 export type AnalyticsControllerTrackEventAction = {
     type: `AnalyticsController:trackEvent`;
@@ -17,6 +18,7 @@ export type AnalyticsControllerTrackEventAction = {
 /**
  * Identify a user for analytics.
  *
+ * @param userId - The user identifier (e.g., metametrics ID)
  * @param traits - User traits/properties
  */
 export type AnalyticsControllerIdentifyAction = {
@@ -24,49 +26,45 @@ export type AnalyticsControllerIdentifyAction = {
     handler: AnalyticsController['identify'];
 };
 /**
- * Track a page or screen view.
+ * Track a page view.
  *
- * @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
+ * @param pageName - The name of the page
+ * @param properties - Page properties
  */
-export type AnalyticsControllerTrackViewAction = {
-    type: `AnalyticsController:trackView`;
-    handler: AnalyticsController['trackView'];
+export type AnalyticsControllerTrackPageAction = {
+    type: `AnalyticsController:trackPage`;
+    handler: AnalyticsController['trackPage'];
 };
 /**
- * Opt in to analytics for regular account.
- * This updates the user's opt-in status for regular account.
+ * Enable analytics tracking.
  */
-export type AnalyticsControllerOptInForRegularAccountAction = {
-    type: `AnalyticsController:optInForRegularAccount`;
-    handler: AnalyticsController['optInForRegularAccount'];
+export type AnalyticsControllerEnableAction = {
+    type: `AnalyticsController:enable`;
+    handler: AnalyticsController['enable'];
 };
 /**
- * Opt out of analytics for regular account.
- * This updates the user's opt-in status for regular account.
+ * Disable analytics tracking.
  */
-export type AnalyticsControllerOptOutForRegularAccountAction = {
-    type: `AnalyticsController:optOutForRegularAccount`;
-    handler: AnalyticsController['optOutForRegularAccount'];
+export type AnalyticsControllerDisableAction = {
+    type: `AnalyticsController:disable`;
+    handler: AnalyticsController['disable'];
 };
 /**
- * Opt in to analytics for social account.
- * This updates the user's opt-in status for social account.
+ * Opt in to analytics.
  */
-export type AnalyticsControllerOptInForSocialAccountAction = {
-    type: `AnalyticsController:optInForSocialAccount`;
-    handler: AnalyticsController['optInForSocialAccount'];
+export type AnalyticsControllerOptInAction = {
+    type: `AnalyticsController:optIn`;
+    handler: AnalyticsController['optIn'];
 };
 /**
- * Opt out of analytics for social account.
- * This updates the user's opt-in status for social account.
+ * Opt out of analytics.
  */
-export type AnalyticsControllerOptOutForSocialAccountAction = {
-    type: `AnalyticsController:optOutForSocialAccount`;
-    handler: AnalyticsController['optOutForSocialAccount'];
+export type AnalyticsControllerOptOutAction = {
+    type: `AnalyticsController:optOut`;
+    handler: AnalyticsController['optOut'];
 };
 /**
  * Union of all AnalyticsController action types.
  */
-export type AnalyticsControllerMethodActions = AnalyticsControllerTrackEventAction | AnalyticsControllerIdentifyAction | AnalyticsControllerTrackViewAction | AnalyticsControllerOptInForRegularAccountAction | AnalyticsControllerOptOutForRegularAccountAction | AnalyticsControllerOptInForSocialAccountAction | AnalyticsControllerOptOutForSocialAccountAction;
+export type AnalyticsControllerMethodActions = AnalyticsControllerTrackEventAction | AnalyticsControllerIdentifyAction | AnalyticsControllerTrackPageAction | AnalyticsControllerEnableAction | AnalyticsControllerDisableAction | AnalyticsControllerOptInAction | AnalyticsControllerOptOutAction;
 //# sourceMappingURL=AnalyticsController-method-action-types.d.mts.map

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

@@ -1 +1 @@
-{"version":3,"file":"AnalyticsController-method-action-types.d.mts","sourceRoot":"","sources":["../src/AnalyticsController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,mBAAmB,EAAE,kCAA8B;AAEjE;;;;;;GAMG;AACH,MAAM,MAAM,mCAAmC,GAAG;IAChD,IAAI,EAAE,gCAAgC,CAAC;IACvC,OAAO,EAAE,mBAAmB,CAAC,YAAY,CAAC,CAAC;CAC5C,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,iCAAiC,GAAG;IAC9C,IAAI,EAAE,8BAA8B,CAAC;IACrC,OAAO,EAAE,mBAAmB,CAAC,UAAU,CAAC,CAAC;CAC1C,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,kCAAkC,GAAG;IAC/C,IAAI,EAAE,+BAA+B,CAAC;IACtC,OAAO,EAAE,mBAAmB,CAAC,WAAW,CAAC,CAAC;CAC3C,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,+CAA+C,GAAG;IAC5D,IAAI,EAAE,4CAA4C,CAAC;IACnD,OAAO,EAAE,mBAAmB,CAAC,wBAAwB,CAAC,CAAC;CACxD,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,gDAAgD,GAAG;IAC7D,IAAI,EAAE,6CAA6C,CAAC;IACpD,OAAO,EAAE,mBAAmB,CAAC,yBAAyB,CAAC,CAAC;CACzD,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,8CAA8C,GAAG;IAC3D,IAAI,EAAE,2CAA2C,CAAC;IAClD,OAAO,EAAE,mBAAmB,CAAC,uBAAuB,CAAC,CAAC;CACvD,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,+CAA+C,GAAG;IAC5D,IAAI,EAAE,4CAA4C,CAAC;IACnD,OAAO,EAAE,mBAAmB,CAAC,wBAAwB,CAAC,CAAC;CACxD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gCAAgC,GACxC,mCAAmC,GACnC,iCAAiC,GACjC,kCAAkC,GAClC,+CAA+C,GAC/C,gDAAgD,GAChD,8CAA8C,GAC9C,+CAA+C,CAAC"}
+{"version":3,"file":"AnalyticsController-method-action-types.d.mts","sourceRoot":"","sources":["../src/AnalyticsController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,mBAAmB,EAAE,kCAA8B;AAEjE;;;;;;;GAOG;AACH,MAAM,MAAM,mCAAmC,GAAG;IAChD,IAAI,EAAE,gCAAgC,CAAC;IACvC,OAAO,EAAE,mBAAmB,CAAC,YAAY,CAAC,CAAC;CAC5C,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,iCAAiC,GAAG;IAC9C,IAAI,EAAE,8BAA8B,CAAC;IACrC,OAAO,EAAE,mBAAmB,CAAC,UAAU,CAAC,CAAC;CAC1C,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,kCAAkC,GAAG;IAC/C,IAAI,EAAE,+BAA+B,CAAC;IACtC,OAAO,EAAE,mBAAmB,CAAC,WAAW,CAAC,CAAC;CAC3C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,4BAA4B,CAAC;IACnC,OAAO,EAAE,mBAAmB,CAAC,QAAQ,CAAC,CAAC;CACxC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gCAAgC,GAAG;IAC7C,IAAI,EAAE,6BAA6B,CAAC;IACpC,OAAO,EAAE,mBAAmB,CAAC,SAAS,CAAC,CAAC;CACzC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG;IAC3C,IAAI,EAAE,2BAA2B,CAAC;IAClC,OAAO,EAAE,mBAAmB,CAAC,OAAO,CAAC,CAAC;CACvC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,4BAA4B,CAAC;IACnC,OAAO,EAAE,mBAAmB,CAAC,QAAQ,CAAC,CAAC;CACxC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gCAAgC,GACxC,mCAAmC,GACnC,iCAAiC,GACjC,kCAAkC,GAClC,+BAA+B,GAC/B,gCAAgC,GAChC,8BAA8B,GAC9B,+BAA+B,CAAC"}

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

@@ -1 +1 @@
-{"version":3,"file":"AnalyticsController-method-action-types.mjs","sourceRoot":"","sources":["../src/AnalyticsController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated by `scripts/generate-method-action-types.ts`.\n * Do not edit manually.\n */\n\nimport type { AnalyticsController } from './AnalyticsController';\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 */\nexport type AnalyticsControllerTrackEventAction = {\n  type: `AnalyticsController:trackEvent`;\n  handler: AnalyticsController['trackEvent'];\n};\n\n/**\n * Identify a user for analytics.\n *\n * @param traits - User traits/properties\n */\nexport type AnalyticsControllerIdentifyAction = {\n  type: `AnalyticsController:identify`;\n  handler: AnalyticsController['identify'];\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 */\nexport type AnalyticsControllerTrackViewAction = {\n  type: `AnalyticsController:trackView`;\n  handler: AnalyticsController['trackView'];\n};\n\n/**\n * Opt in to analytics for regular account.\n * This updates the user's opt-in status for regular account.\n */\nexport type AnalyticsControllerOptInForRegularAccountAction = {\n  type: `AnalyticsController:optInForRegularAccount`;\n  handler: AnalyticsController['optInForRegularAccount'];\n};\n\n/**\n * Opt out of analytics for regular account.\n * This updates the user's opt-in status for regular account.\n */\nexport type AnalyticsControllerOptOutForRegularAccountAction = {\n  type: `AnalyticsController:optOutForRegularAccount`;\n  handler: AnalyticsController['optOutForRegularAccount'];\n};\n\n/**\n * Opt in to analytics for social account.\n * This updates the user's opt-in status for social account.\n */\nexport type AnalyticsControllerOptInForSocialAccountAction = {\n  type: `AnalyticsController:optInForSocialAccount`;\n  handler: AnalyticsController['optInForSocialAccount'];\n};\n\n/**\n * Opt out of analytics for social account.\n * This updates the user's opt-in status for social account.\n */\nexport type AnalyticsControllerOptOutForSocialAccountAction = {\n  type: `AnalyticsController:optOutForSocialAccount`;\n  handler: AnalyticsController['optOutForSocialAccount'];\n};\n\n/**\n * Union of all AnalyticsController action types.\n */\nexport type AnalyticsControllerMethodActions =\n  | AnalyticsControllerTrackEventAction\n  | AnalyticsControllerIdentifyAction\n  | AnalyticsControllerTrackViewAction\n  | AnalyticsControllerOptInForRegularAccountAction\n  | AnalyticsControllerOptOutForRegularAccountAction\n  | AnalyticsControllerOptInForSocialAccountAction\n  | AnalyticsControllerOptOutForSocialAccountAction;\n"]}
+{"version":3,"file":"AnalyticsController-method-action-types.mjs","sourceRoot":"","sources":["../src/AnalyticsController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated by `scripts/generate-method-action-types.ts`.\n * Do not edit manually.\n */\n\nimport type { AnalyticsController } from './AnalyticsController';\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 */\nexport type AnalyticsControllerTrackEventAction = {\n  type: `AnalyticsController:trackEvent`;\n  handler: AnalyticsController['trackEvent'];\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 */\nexport type AnalyticsControllerIdentifyAction = {\n  type: `AnalyticsController:identify`;\n  handler: AnalyticsController['identify'];\n};\n\n/**\n * Track a page view.\n *\n * @param pageName - The name of the page\n * @param properties - Page properties\n */\nexport type AnalyticsControllerTrackPageAction = {\n  type: `AnalyticsController:trackPage`;\n  handler: AnalyticsController['trackPage'];\n};\n\n/**\n * Enable analytics tracking.\n */\nexport type AnalyticsControllerEnableAction = {\n  type: `AnalyticsController:enable`;\n  handler: AnalyticsController['enable'];\n};\n\n/**\n * Disable analytics tracking.\n */\nexport type AnalyticsControllerDisableAction = {\n  type: `AnalyticsController:disable`;\n  handler: AnalyticsController['disable'];\n};\n\n/**\n * Opt in to analytics.\n */\nexport type AnalyticsControllerOptInAction = {\n  type: `AnalyticsController:optIn`;\n  handler: AnalyticsController['optIn'];\n};\n\n/**\n * Opt out of analytics.\n */\nexport type AnalyticsControllerOptOutAction = {\n  type: `AnalyticsController:optOut`;\n  handler: AnalyticsController['optOut'];\n};\n\n/**\n * Union of all AnalyticsController action types.\n */\nexport type AnalyticsControllerMethodActions =\n  | AnalyticsControllerTrackEventAction\n  | AnalyticsControllerIdentifyAction\n  | AnalyticsControllerTrackPageAction\n  | AnalyticsControllerEnableAction\n  | AnalyticsControllerDisableAction\n  | AnalyticsControllerOptInAction\n  | AnalyticsControllerOptOutAction;\n"]}

package/dist/AnalyticsController.cjs

@@ -16,8 +16,6 @@ exports.AnalyticsController = exports.getDefaultAnalyticsControllerState = expor
 const base_controller_1 = require("@metamask/base-controller");
 const uuid_1 = require("uuid");
 const AnalyticsLogger_1 = require("./AnalyticsLogger.cjs");
-const analyticsStateComputer_1 = require("./analyticsStateComputer.cjs");
-const analyticsStateValidator_1 = require("./analyticsStateValidator.cjs");
 // === GENERAL ===
 /**
  * The name of the {@link AnalyticsController}, used to namespace the
@@ -29,13 +27,13 @@ exports.controllerName = 'AnalyticsController';
  * The metadata for each property in {@link AnalyticsControllerState}.
  */
 const analyticsControllerMetadata = {
-    optedInForRegularAccount: {
+    enabled: {
         includeInStateLogs: true,
         persist: true,
         includeInDebugSnapshot: true,
         usedInUi: true,
     },
-    optedInForSocialAccount: {
+    optedIn: {
         includeInStateLogs: true,
         persist: true,
         includeInDebugSnapshot: true,
@@ -58,8 +56,8 @@ const analyticsControllerMetadata = {
  */
 function getDefaultAnalyticsControllerState() {
     return {
-        optedInForRegularAccount: false,
-        optedInForSocialAccount: false,
+        enabled: true,
+        optedIn: false,
         analyticsId: (0, uuid_1.v4)(),
     };
 }
@@ -68,11 +66,11 @@ exports.getDefaultAnalyticsControllerState = getDefaultAnalyticsControllerState;
 const MESSENGER_EXPOSED_METHODS = [
     'trackEvent',
     'identify',
-    'trackView',
-    'optInForRegularAccount',
-    'optOutForRegularAccount',
-    'optInForSocialAccount',
-    'optOutForSocialAccount',
+    'trackPage',
+    'enable',
+    'disable',
+    'optIn',
+    'optOut',
 ];
 /**
  * The AnalyticsController manages analytics tracking across platforms (Mobile/Extension).
@@ -89,136 +87,109 @@ class AnalyticsController extends base_controller_1.BaseController {
      * Constructs an AnalyticsController instance.
      *
      * @param options - Controller options
-     * @param options.state - Initial controller state (defaults from getDefaultAnalyticsControllerState).
-     * For migration from a previous system, pass the existing analytics ID via state.analyticsId.
+     * @param options.state - Initial controller state (defaults from getDefaultAnalyticsControllerState)
      * @param options.messenger - Messenger used to communicate with BaseController
      * @param options.platformAdapter - Platform adapter implementation for tracking
      */
     constructor({ state = {}, messenger, platformAdapter, }) {
-        const initialState = {
-            ...getDefaultAnalyticsControllerState(),
-            ...state,
-        };
-        (0, analyticsStateValidator_1.validateAnalyticsState)(initialState);
         super({
             name: exports.controllerName,
             metadata: analyticsControllerMetadata,
-            state: initialState,
+            state: {
+                ...getDefaultAnalyticsControllerState(),
+                ...state,
+            },
             messenger,
         });
         _AnalyticsController_platformAdapter.set(this, void 0);
         __classPrivateFieldSet(this, _AnalyticsController_platformAdapter, platformAdapter, "f");
         this.messenger.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
         (0, AnalyticsLogger_1.projectLogger)('AnalyticsController initialized and ready', {
-            enabled: (0, analyticsStateComputer_1.computeEnabledState)(this.state),
-            optedIn: this.state.optedInForRegularAccount,
-            socialOptedIn: this.state.optedInForSocialAccount,
+            enabled: this.state.enabled,
+            optedIn: this.state.optedIn,
             analyticsId: this.state.analyticsId,
         });
-        // Call onSetupCompleted lifecycle hook after initialization
-        // State is already validated, so analyticsId is guaranteed to be a valid UUIDv4
-        try {
-            __classPrivateFieldGet(this, _AnalyticsController_platformAdapter, "f").onSetupCompleted(this.state.analyticsId);
-        }
-        catch (error) {
-            // Log error but don't throw - adapter setup failure shouldn't break controller
-            (0, AnalyticsLogger_1.projectLogger)('Error calling platformAdapter.onSetupCompleted', error);
-        }
     }
     /**
      * Track an analytics event.
      *
      * Events are only tracked if analytics is enabled.
      *
-     * @param event - Analytics event with properties and sensitive properties
+     * @param eventName - The name of the event
+     * @param properties - Event properties
      */
-    trackEvent(event) {
+    trackEvent(eventName, properties = {}) {
         // Don't track if analytics is disabled
-        if (!(0, analyticsStateComputer_1.computeEnabledState)(this.state)) {
-            return;
-        }
-        // 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);
+        if (!this.state.enabled) {
             return;
         }
-        // Track regular properties (without isSensitive flag - it's the default)
-        __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, {
-                isSensitive: true,
-                ...event.properties,
-                ...event.sensitiveProperties,
-            });
-        }
+        // Delegate to platform adapter
+        __classPrivateFieldGet(this, _AnalyticsController_platformAdapter, "f").trackEvent(eventName, properties);
     }
     /**
      * Identify a user for analytics.
      *
+     * @param userId - The user identifier (e.g., metametrics ID)
      * @param traits - User traits/properties
      */
-    identify(traits) {
-        if (!(0, analyticsStateComputer_1.computeEnabledState)(this.state)) {
+    identify(userId, traits) {
+        if (!this.state.enabled) {
             return;
         }
-        // Delegate to platform adapter if supported, using the current analytics ID
+        // 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(this.state.analyticsId, traits);
+            __classPrivateFieldGet(this, _AnalyticsController_platformAdapter, "f").identify(userId, traits);
         }
     }
     /**
-     * Track a page or screen view.
+     * Track a page view.
      *
-     * @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
+     * @param pageName - The name of the page
+     * @param properties - Page properties
      */
-    trackView(name, properties) {
-        if (!(0, analyticsStateComputer_1.computeEnabledState)(this.state)) {
+    trackPage(pageName, properties) {
+        if (!this.state.enabled) {
             return;
         }
-        // Delegate to platform adapter
-        __classPrivateFieldGet(this, _AnalyticsController_platformAdapter, "f").view(name, properties);
+        // Delegate to platform adapter if supported
+        if (__classPrivateFieldGet(this, _AnalyticsController_platformAdapter, "f").trackPage) {
+            __classPrivateFieldGet(this, _AnalyticsController_platformAdapter, "f").trackPage(pageName, properties);
+        }
     }
     /**
-     * Opt in to analytics for regular account.
-     * This updates the user's opt-in status for regular account.
+     * Enable analytics tracking.
      */
-    optInForRegularAccount() {
+    enable() {
         this.update((state) => {
-            state.optedInForRegularAccount = true;
+            state.enabled = true;
         });
     }
     /**
-     * Opt out of analytics for regular account.
-     * This updates the user's opt-in status for regular account.
+     * Disable analytics tracking.
      */
-    optOutForRegularAccount() {
+    disable() {
         this.update((state) => {
-            state.optedInForRegularAccount = false;
+            state.enabled = false;
         });
     }
     /**
-     * Opt in to analytics for social account.
-     * This updates the user's opt-in status for social account.
+     * Opt in to analytics.
      */
-    optInForSocialAccount() {
+    optIn() {
         this.update((state) => {
-            state.optedInForSocialAccount = true;
+            state.optedIn = true;
         });
     }
     /**
-     * Opt out of analytics for social account.
-     * This updates the user's opt-in status for social account.
+     * Opt out of analytics.
      */
-    optOutForSocialAccount() {
+    optOut() {
         this.update((state) => {
-            state.optedInForSocialAccount = false;
+            state.optedIn = false;
         });
     }
 }