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

package/README.md

@@ -4,13 +4,10 @@ Common Analytics controller for event tracking.
 
 ## Features
 
-- Provides a unified interface for:
-  - Tracking analytics events
-  - Identifying users
-  - Managing analytics preferences (enable/disable, opt-in/opt-out)
+- Unified interface for tracking analytics events, identifying users, and managing preferences
 - Delegates platform-specific implementation to `AnalyticsPlatformAdapter`
 - Integrates with the MetaMask messenger system for inter-controller communication
-- Supports state persistence and migrations
+- Platform-managed storage: controller doesn't persist state internally
 
 ## Installation
 
@@ -24,184 +21,290 @@ or
 
 ### 1. Create a Platform Adapter
 
-The controller delegates platform-specific analytics implementation to a `AnalyticsPlatformAdapter`. You must provide an adapter that implements the required methods:
+The controller delegates platform-specific analytics implementation to an `AnalyticsPlatformAdapter`:
 
 ```typescript
 import type { AnalyticsPlatformAdapter } from '@metamask/analytics-controller';
 
 const platformAdapter: AnalyticsPlatformAdapter = {
-  trackEvent: (eventName: string, properties: Record<string, unknown>) => {
-    // Platform-specific implementation (e.g., Segment, Mixpanel, etc.)
+  track: (eventName: string, properties?: Record<string, unknown>) => {
     segment.track(eventName, properties);
   },
   identify: (userId: string, traits?: Record<string, unknown>) => {
     segment.identify(userId, traits);
   },
-  trackPage: (pageName: string, properties?: Record<string, unknown>) => {
-    segment.page(pageName, properties);
+  view: (name: string, properties?: Record<string, unknown>) => {
+    segment.page(name, properties);
+  },
+  onSetupCompleted: async (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),
+    });
   },
 };
 ```
 
-### 2. Initialize the Controller
+### 2. Load Analytics Settings from Storage
+
+The platform is responsible for loading and persisting analytics settings—the controller does not handle storage internally. This design allows:
 
-#### Basic Initialization (Uses Defaults)
+- **Early access**: Platform can read the `analyticsId` before the controller is initialized (useful for other controllers or early startup code)
+- **Resilience**: Storing analytics settings separately from main state protects them from state corruption, allowing analytics to continue working even when main state is corrupted
 
-The controller uses default state values when no `state` parameter is provided:
+Load settings **before** initializing the controller:
 
 ```typescript
-import { AnalyticsController } from '@metamask/analytics-controller';
-import { Messenger } from '@metamask/messenger';
-
-const messenger = new Messenger({ namespace: 'AnalyticsController' });
-
-const controller = new AnalyticsController({
-  messenger,
-  platformAdapter,
-  // State defaults to:
-  // - enabled: true
-  // - optedIn: false
-  // - analyticsId: auto-generated UUIDv4 (if not provided)
-});
+import { v4 as uuidv4 } from 'uuid';
+import {
+  getDefaultAnalyticsControllerState,
+  type AnalyticsControllerState,
+} from '@metamask/analytics-controller';
+
+async function loadAnalyticsSettings(): Promise<AnalyticsControllerState> {
+  // Load from platform storage (e.g., MMKV, AsyncStorage, localStorage)
+  const [savedAnalyticsId, savedOptedInRegular, savedOptedInSocial] =
+    await Promise.all([
+      storage.getItem('analytics.id'),
+      storage.getItem('analytics.optedInForRegularAccount'),
+      storage.getItem('analytics.optedInForSocialAccount'),
+    ]);
+
+  const defaults = getDefaultAnalyticsControllerState();
+
+  // Generate UUID on first run if not in storage
+  let analyticsId = savedAnalyticsId;
+  if (!analyticsId) {
+    analyticsId = uuidv4();
+    // Persist immediately - this ID must never change
+    await storage.setItem('analytics.id', analyticsId);
+  }
+
+  // Parse boolean values (stored as strings)
+  const optedInForRegularAccount =
+    savedOptedInRegular !== null
+      ? savedOptedInRegular === 'true'
+      : defaults.optedInForRegularAccount;
+
+  const optedInForSocialAccount =
+    savedOptedInSocial !== null
+      ? savedOptedInSocial === 'true'
+      : defaults.optedInForSocialAccount;
+
+  return {
+    analyticsId,
+    optedInForRegularAccount,
+    optedInForSocialAccount,
+  };
+}
 ```
 
-#### Custom Initial State
+### 3. Initialize the Controller
 
-You can provide partial state to override defaults:
+Create the controller with loaded state and subscribe to state changes for persistence:
 
 ```typescript
-const controller = new AnalyticsController({
-  messenger,
-  platformAdapter,
-  state: {
-    enabled: false, // Override default (true)
-    optedIn: true, // Override default (false)
-    analyticsId: '550e8400-e29b-41d4-a716-446655440000', // Override default
-  },
-});
+import {
+  AnalyticsController,
+  type AnalyticsControllerState,
+} from '@metamask/analytics-controller';
+
+// Persist state changes to storage (fire-and-forget)
+function persistAnalyticsSettings(state: AnalyticsControllerState): void {
+  storage.setItem('analytics.id', state.analyticsId);
+  storage.setItem(
+    'analytics.optedInForRegularAccount',
+    String(state.optedInForRegularAccount),
+  );
+  storage.setItem(
+    'analytics.optedInForSocialAccount',
+    String(state.optedInForSocialAccount),
+  );
+}
+
+async function initializeAnalyticsController(
+  messenger: AnalyticsControllerMessenger,
+): Promise<AnalyticsController> {
+  // 1. Load settings from storage
+  const state = await loadAnalyticsSettings();
+
+  // 2. Create controller with loaded state
+  const controller = new AnalyticsController({
+    messenger,
+    platformAdapter,
+    state, // Must include valid UUIDv4 analyticsId
+  });
+
+  // 3. Subscribe to state changes for persistence
+  messenger.subscribe('AnalyticsController:stateChange', (newState) => {
+    persistAnalyticsSettings(newState);
+  });
+
+  return controller;
+}
 ```
 
-**Important:** The `state` parameter is the single source of truth for initial values. Any properties you provide will override the defaults from `getDefaultAnalyticsControllerState()`.
+### 4. Access Analytics ID Before Controller Init
+
+One benefit of platform-managed storage is accessing the analytics ID before the controller is initialized:
+
+```typescript
+async function getAnalyticsId(): Promise<string | null> {
+  return storage.getItem('analytics.id');
+}
+
+// Use in other controllers or early initialization
+const analyticsId = await getAnalyticsId();
+if (analyticsId) {
+  // Use analyticsId before AnalyticsController is ready
+}
+```
 
-### 3. Track Events
+### 5. Track Events
 
 ```typescript
-// Track a simple event
-controller.trackEvent('wallet_connected', {
-  network: 'ethereum',
-  account_type: 'hd',
+// Track event with properties
+controller.trackEvent({
+  name: 'wallet_connected',
+  properties: { network: 'ethereum', account_type: 'hd' },
+  sensitiveProperties: {},
+  hasProperties: true,
+  saveDataRecording: true,
 });
 
-// Events are automatically filtered when analytics is disabled
-controller.disable();
-controller.trackEvent('some_event'); // This will not be tracked
+// Events are filtered when analytics is disabled (both opt-ins are false)
 ```
 
-### 4. Identify Users
+### 6. Identify Users
 
 ```typescript
-controller.identify('550e8400-e29b-41d4-a716-446655440000', {
-  email: 'user@example.com',
-  plan: 'premium',
+controller.identify({
+  ENABLE_OPENSEA_API: 'ON',
+  NFT_AUTODETECTION: 'ON',
 });
 
-// The analytics ID is automatically stored in controller state
-console.log(controller.state.analyticsId); // '550e8400-e29b-41d4-a716-446655440000'
+// Uses the analyticsId from controller state
 ```
 
-### 5. Track Page Views
+### 7. Track Page Views
 
 ```typescript
-controller.trackPage('home', {
+controller.trackView('home', {
   referrer: 'google',
   campaign: 'summer-2024',
 });
 ```
 
-### 6. Manage Analytics State
+### 8. Manage Analytics Preferences
 
 ```typescript
-// Enable/disable analytics
-controller.enable();
-controller.disable();
+// Opt in/out for regular account
+controller.optInForRegularAccount();
+controller.optOutForRegularAccount();
 
-// Opt in/out
-controller.optIn();
-controller.optOut();
-```
+// Opt in/out for social account
+controller.optInForSocialAccount();
+controller.optOutForSocialAccount();
 
-### 7. Use Messenger Actions
+// Changes trigger stateChange event → platform persists to storage
+```
 
-The controller exposes methods as messenger actions for inter-controller communication:
+### 9. Use Messenger Actions
 
 ```typescript
 // From another controller
-messenger.call('AnalyticsController:trackEvent', 'wallet_created', {
-  wallet_type: 'hd',
+messenger.call('AnalyticsController:trackEvent', {
+  name: 'wallet_created',
+  properties: { wallet_type: 'hd' },
+  sensitiveProperties: {},
+  hasProperties: true,
+  saveDataRecording: true,
 });
 
-messenger.call(
-  'AnalyticsController:identify',
-  '550e8400-e29b-41d4-a716-446655440000',
-  {
-    email: 'newuser@example.com',
-  },
-);
-
-messenger.call('AnalyticsController:enable');
-messenger.call('AnalyticsController:disable');
-messenger.call('AnalyticsController:optIn');
-messenger.call('AnalyticsController:optOut');
-```
-
-### 8. Subscribe to State Changes
-
-```typescript
-messenger.subscribe('AnalyticsController:stateChange', (state, prevState) => {
-  console.log('Analytics state changed:', {
-    enabled: state.enabled,
-    optedIn: state.optedIn,
-    analyticsId: state.analyticsId,
-  });
-});
+messenger.call('AnalyticsController:optInForRegularAccount');
 ```
 
 ## State Management
 
 ### Default State
 
-The default state is provided by `getDefaultAnalyticsControllerState()`:
+Use `getDefaultAnalyticsControllerState()` to get default values for opt-in preferences:
 
 ```typescript
 import { getDefaultAnalyticsControllerState } from '@metamask/analytics-controller';
 
-const defaultState = getDefaultAnalyticsControllerState();
-// {
-//   enabled: true,
-//   optedIn: false,
-//   analyticsId: auto-generated UUIDv4
-// }
+const defaults = getDefaultAnalyticsControllerState();
+// Returns: { optedInForRegularAccount: false, optedInForSocialAccount: false }
+// Note: analyticsId is NOT included - platform must provide it
 ```
 
-### Initialization Strategy
+### State Structure
+
+| Field                      | Type      | Description                            |
+| -------------------------- | --------- | -------------------------------------- |
+| `analyticsId`              | `string`  | UUIDv4 identifier (platform-generated) |
+| `optedInForRegularAccount` | `boolean` | User opt-in status for regular account |
+| `optedInForSocialAccount`  | `boolean` | User opt-in status for social account  |
+
+### Why `analyticsId` Has No Default
+
+The `analyticsId` is an **identity** (unique per user), not a **preference** (static default). A default should return the same value each call (deterministic), but a UUID must be unique each time (non-deterministic). These are mutually exclusive.
+
+**Solution:** Platform generates the UUID once on first run, persists it, and provides it to the controller.
+
+### Platform Responsibilities
 
-- **No `state` parameter**: Uses defaults from `getDefaultAnalyticsControllerState()` and auto-generates `analyticsId` as UUIDv4
-- **Partial `state`**: Merges with defaults (user-provided values override defaults); `analyticsId` is auto-generated if not provided
-- **Complete `state`**: Full control for migrations and advanced use cases
+1. **Generate UUID on first run**: Use `uuid` package or platform equivalent
+2. **Load state before controller init**: Read from storage, provide to constructor
+3. **Subscribe to state changes**: Persist changes to storage
+4. **Persist to isolated storage**: Keep analytics settings separate from main state (protects against state corruption)
 
-**Best Practice:** Use `state` as the single source of truth for initial values. Do not use convenience parameters—they have been removed to ensure consistency.
+### Why Platform-Managed Storage?
 
-**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).
+- **Access before controller init**: Other code can read analytics ID early
+- **Protection from state corruption**: Analytics settings in separate storage survive main state corruption
+- **Analytics during corruption**: Can still report issues even when main state is corrupted
+- **Platform flexibility**: Each platform uses its preferred storage mechanism
+
+## Lifecycle Hooks
+
+### `onSetupCompleted`
+
+Called once after controller initialization with guaranteed valid `analyticsId`:
+
+```typescript
+onSetupCompleted: async (analyticsId: string) => {
+  // analyticsId is guaranteed to be a valid UUIDv4
+  client.add({ plugin: new PrivacyPlugin(analyticsId) });
+},
+```
+
+Errors in `onSetupCompleted` are caught and logged—they don't break the controller.
 
 ## Debugging
 
-To display analytics-controller logs in the mobile app, you can add the following to your `.js.env` file:
+Enable debug logging:
 
 ```bash
 export DEBUG="metamask:analytics-controller"
 ```
 
-This will enable debug logging for the analytics-controller, allowing you to see detailed logs of analytics events, state changes, and controller operations.
+## Development
+
+### Build
+
+```bash
+yarn install && yarn workspace @metamask/analytics-controller build
+```
+
+### Test
+
+```bash
+yarn install && yarn workspace @metamask/analytics-controller test
+```
 
 ## Contributing
 

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 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"]}
+{"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"]}

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

@@ -8,8 +8,7 @@ import type { AnalyticsController } from "./AnalyticsController.cjs";
  *
  * 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
  */
 export type AnalyticsControllerTrackEventAction = {
     type: `AnalyticsController:trackEvent`;
@@ -18,7 +17,6 @@ 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 = {
@@ -26,45 +24,49 @@ export type AnalyticsControllerIdentifyAction = {
     handler: AnalyticsController['identify'];
 };
 /**
- * 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
  */
-export type AnalyticsControllerTrackPageAction = {
-    type: `AnalyticsController:trackPage`;
-    handler: AnalyticsController['trackPage'];
+export type AnalyticsControllerTrackViewAction = {
+    type: `AnalyticsController:trackView`;
+    handler: AnalyticsController['trackView'];
 };
 /**
- * Enable analytics tracking.
+ * Opt in to analytics for regular account.
+ * This updates the user's opt-in status for regular account.
  */
-export type AnalyticsControllerEnableAction = {
-    type: `AnalyticsController:enable`;
-    handler: AnalyticsController['enable'];
+export type AnalyticsControllerOptInForRegularAccountAction = {
+    type: `AnalyticsController:optInForRegularAccount`;
+    handler: AnalyticsController['optInForRegularAccount'];
 };
 /**
- * Disable analytics tracking.
+ * Opt out of analytics for regular account.
+ * This updates the user's opt-in status for regular account.
  */
-export type AnalyticsControllerDisableAction = {
-    type: `AnalyticsController:disable`;
-    handler: AnalyticsController['disable'];
+export type AnalyticsControllerOptOutForRegularAccountAction = {
+    type: `AnalyticsController:optOutForRegularAccount`;
+    handler: AnalyticsController['optOutForRegularAccount'];
 };
 /**
- * Opt in to analytics.
+ * Opt in to analytics for social account.
+ * This updates the user's opt-in status for social account.
  */
-export type AnalyticsControllerOptInAction = {
-    type: `AnalyticsController:optIn`;
-    handler: AnalyticsController['optIn'];
+export type AnalyticsControllerOptInForSocialAccountAction = {
+    type: `AnalyticsController:optInForSocialAccount`;
+    handler: AnalyticsController['optInForSocialAccount'];
 };
 /**
- * Opt out of analytics.
+ * Opt out of analytics for social account.
+ * This updates the user's opt-in status for social account.
  */
-export type AnalyticsControllerOptOutAction = {
-    type: `AnalyticsController:optOut`;
-    handler: AnalyticsController['optOut'];
+export type AnalyticsControllerOptOutForSocialAccountAction = {
+    type: `AnalyticsController:optOutForSocialAccount`;
+    handler: AnalyticsController['optOutForSocialAccount'];
 };
 /**
  * Union of all AnalyticsController action types.
  */
-export type AnalyticsControllerMethodActions = AnalyticsControllerTrackEventAction | AnalyticsControllerIdentifyAction | AnalyticsControllerTrackPageAction | AnalyticsControllerEnableAction | AnalyticsControllerDisableAction | AnalyticsControllerOptInAction | AnalyticsControllerOptOutAction;
+export type AnalyticsControllerMethodActions = AnalyticsControllerTrackEventAction | AnalyticsControllerIdentifyAction | AnalyticsControllerTrackViewAction | AnalyticsControllerOptInForRegularAccountAction | AnalyticsControllerOptOutForRegularAccountAction | AnalyticsControllerOptInForSocialAccountAction | AnalyticsControllerOptOutForSocialAccountAction;
 //# 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;;;;;;;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"}
+{"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"}

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

@@ -8,8 +8,7 @@ import type { AnalyticsController } from "./AnalyticsController.mjs";
  *
  * 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
  */
 export type AnalyticsControllerTrackEventAction = {
     type: `AnalyticsController:trackEvent`;
@@ -18,7 +17,6 @@ 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 = {
@@ -26,45 +24,49 @@ export type AnalyticsControllerIdentifyAction = {
     handler: AnalyticsController['identify'];
 };
 /**
- * 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
  */
-export type AnalyticsControllerTrackPageAction = {
-    type: `AnalyticsController:trackPage`;
-    handler: AnalyticsController['trackPage'];
+export type AnalyticsControllerTrackViewAction = {
+    type: `AnalyticsController:trackView`;
+    handler: AnalyticsController['trackView'];
 };
 /**
- * Enable analytics tracking.
+ * Opt in to analytics for regular account.
+ * This updates the user's opt-in status for regular account.
  */
-export type AnalyticsControllerEnableAction = {
-    type: `AnalyticsController:enable`;
-    handler: AnalyticsController['enable'];
+export type AnalyticsControllerOptInForRegularAccountAction = {
+    type: `AnalyticsController:optInForRegularAccount`;
+    handler: AnalyticsController['optInForRegularAccount'];
 };
 /**
- * Disable analytics tracking.
+ * Opt out of analytics for regular account.
+ * This updates the user's opt-in status for regular account.
  */
-export type AnalyticsControllerDisableAction = {
-    type: `AnalyticsController:disable`;
-    handler: AnalyticsController['disable'];
+export type AnalyticsControllerOptOutForRegularAccountAction = {
+    type: `AnalyticsController:optOutForRegularAccount`;
+    handler: AnalyticsController['optOutForRegularAccount'];
 };
 /**
- * Opt in to analytics.
+ * Opt in to analytics for social account.
+ * This updates the user's opt-in status for social account.
  */
-export type AnalyticsControllerOptInAction = {
-    type: `AnalyticsController:optIn`;
-    handler: AnalyticsController['optIn'];
+export type AnalyticsControllerOptInForSocialAccountAction = {
+    type: `AnalyticsController:optInForSocialAccount`;
+    handler: AnalyticsController['optInForSocialAccount'];
 };
 /**
- * Opt out of analytics.
+ * Opt out of analytics for social account.
+ * This updates the user's opt-in status for social account.
  */
-export type AnalyticsControllerOptOutAction = {
-    type: `AnalyticsController:optOut`;
-    handler: AnalyticsController['optOut'];
+export type AnalyticsControllerOptOutForSocialAccountAction = {
+    type: `AnalyticsController:optOutForSocialAccount`;
+    handler: AnalyticsController['optOutForSocialAccount'];
 };
 /**
  * Union of all AnalyticsController action types.
  */
-export type AnalyticsControllerMethodActions = AnalyticsControllerTrackEventAction | AnalyticsControllerIdentifyAction | AnalyticsControllerTrackPageAction | AnalyticsControllerEnableAction | AnalyticsControllerDisableAction | AnalyticsControllerOptInAction | AnalyticsControllerOptOutAction;
+export type AnalyticsControllerMethodActions = AnalyticsControllerTrackEventAction | AnalyticsControllerIdentifyAction | AnalyticsControllerTrackViewAction | AnalyticsControllerOptInForRegularAccountAction | AnalyticsControllerOptOutForRegularAccountAction | AnalyticsControllerOptInForSocialAccountAction | AnalyticsControllerOptOutForSocialAccountAction;
 //# 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;;;;;;;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"}
+{"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"}

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 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"]}
+{"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"]}