@metamask-previews/analytics-controller 0.0.0-preview-8647bc1c → 0.0.0-preview-704ae19a

package/README.md

@@ -30,15 +30,24 @@ The controller delegates platform-specific analytics implementation to a `Analyt
 import type { AnalyticsPlatformAdapter } from '@metamask/analytics-controller';
 
 const platformAdapter: AnalyticsPlatformAdapter = {
-  trackEvent: (eventName: string, properties: Record<string, unknown>) => {
+  track: (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);
   },
-  trackPage: (pageName: string, properties?: Record<string, unknown>) => {
-    segment.page(pageName, properties);
+  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),
+    });
   },
 };
 ```
@@ -112,7 +121,7 @@ console.log(controller.state.analyticsId); // '550e8400-e29b-41d4-a716-446655440
 ### 5. Track Page Views
 
 ```typescript
-controller.trackPage('home', {
+controller.trackView('home', {
   referrer: 'google',
   campaign: 'summer-2024',
 });
@@ -193,6 +202,54 @@ 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 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 view.\n *\n * @param name - The name of the UI item being viewed (pages for web, screen for mobile)\n * @param properties - UI item properties\n */\nexport type AnalyticsControllerTrackViewAction = {\n  type: `AnalyticsController:trackView`;\n  handler: AnalyticsController['trackView'];\n};\n\n/**\n * Opt in to analytics.\n * This updates the user's opt-in status.\n */\nexport type AnalyticsControllerOptInAction = {\n  type: `AnalyticsController:optIn`;\n  handler: AnalyticsController['optIn'];\n};\n\n/**\n * Opt out of analytics.\n * This updates the user's opt-in status.\n */\nexport type AnalyticsControllerOptOutAction = {\n  type: `AnalyticsController:optOut`;\n  handler: AnalyticsController['optOut'];\n};\n\n/**\n * Opt in to analytics through social account.\n * This updates the user's social opt-in status.\n */\nexport type AnalyticsControllerSocialOptInAction = {\n  type: `AnalyticsController:socialOptIn`;\n  handler: AnalyticsController['socialOptIn'];\n};\n\n/**\n * Opt out of analytics through social account.\n * This updates the user's social opt-in status.\n */\nexport type AnalyticsControllerSocialOptOutAction = {\n  type: `AnalyticsController:socialOptOut`;\n  handler: AnalyticsController['socialOptOut'];\n};\n\n/**\n * Get the analytics ID from the controller state.\n *\n * @returns The current analytics ID.\n */\nexport type AnalyticsControllerGetAnalyticsIdAction = {\n  type: `AnalyticsController:getAnalyticsId`;\n  handler: AnalyticsController['getAnalyticsId'];\n};\n\n/**\n * Get the enabled status from the controller state.\n * This is computed from user state via the state machine.\n *\n * @returns The current enabled status.\n */\nexport type AnalyticsControllerIsEnabledAction = {\n  type: `AnalyticsController:isEnabled`;\n  handler: AnalyticsController['isEnabled'];\n};\n\n/**\n * Get the opted in status from the controller state.\n *\n * @returns The current opted in status.\n */\nexport type AnalyticsControllerIsOptedInAction = {\n  type: `AnalyticsController:isOptedIn`;\n  handler: AnalyticsController['isOptedIn'];\n};\n\n/**\n * Get the social opted in status from the controller state.\n *\n * @returns The current social opted in status.\n */\nexport type AnalyticsControllerIsSocialOptedInAction = {\n  type: `AnalyticsController:isSocialOptedIn`;\n  handler: AnalyticsController['isSocialOptedIn'];\n};\n\n/**\n * Union of all AnalyticsController action types.\n */\nexport type AnalyticsControllerMethodActions =\n  | AnalyticsControllerTrackEventAction\n  | AnalyticsControllerIdentifyAction\n  | AnalyticsControllerTrackViewAction\n  | AnalyticsControllerOptInAction\n  | AnalyticsControllerOptOutAction\n  | AnalyticsControllerSocialOptInAction\n  | AnalyticsControllerSocialOptOutAction\n  | AnalyticsControllerGetAnalyticsIdAction\n  | AnalyticsControllerIsEnabledAction\n  | AnalyticsControllerIsOptedInAction\n  | AnalyticsControllerIsSocialOptedInAction;\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 = {
@@ -28,29 +26,16 @@ export type AnalyticsControllerIdentifyAction = {
 /**
  * Track a page view.
  *
- * @param pageName - The name of the page
- * @param properties - Page properties
+ * @param name - The name of the UI item being viewed (pages for web, screen for mobile)
+ * @param properties - UI item properties
  */
-export type AnalyticsControllerTrackPageAction = {
-    type: `AnalyticsController:trackPage`;
-    handler: AnalyticsController['trackPage'];
-};
-/**
- * Enable analytics tracking.
- */
-export type AnalyticsControllerEnableAction = {
-    type: `AnalyticsController:enable`;
-    handler: AnalyticsController['enable'];
-};
-/**
- * Disable analytics tracking.
- */
-export type AnalyticsControllerDisableAction = {
-    type: `AnalyticsController:disable`;
-    handler: AnalyticsController['disable'];
+export type AnalyticsControllerTrackViewAction = {
+    type: `AnalyticsController:trackView`;
+    handler: AnalyticsController['trackView'];
 };
 /**
  * Opt in to analytics.
+ * This updates the user's opt-in status.
  */
 export type AnalyticsControllerOptInAction = {
     type: `AnalyticsController:optIn`;
@@ -58,13 +43,67 @@ export type AnalyticsControllerOptInAction = {
 };
 /**
  * Opt out of analytics.
+ * This updates the user's opt-in status.
  */
 export type AnalyticsControllerOptOutAction = {
     type: `AnalyticsController:optOut`;
     handler: AnalyticsController['optOut'];
 };
+/**
+ * Opt in to analytics through social account.
+ * This updates the user's social opt-in status.
+ */
+export type AnalyticsControllerSocialOptInAction = {
+    type: `AnalyticsController:socialOptIn`;
+    handler: AnalyticsController['socialOptIn'];
+};
+/**
+ * Opt out of analytics through social account.
+ * This updates the user's social opt-in status.
+ */
+export type AnalyticsControllerSocialOptOutAction = {
+    type: `AnalyticsController:socialOptOut`;
+    handler: AnalyticsController['socialOptOut'];
+};
+/**
+ * Get the analytics ID from the controller state.
+ *
+ * @returns The current analytics ID.
+ */
+export type AnalyticsControllerGetAnalyticsIdAction = {
+    type: `AnalyticsController:getAnalyticsId`;
+    handler: AnalyticsController['getAnalyticsId'];
+};
+/**
+ * Get the enabled status from the controller state.
+ * This is computed from user state via the state machine.
+ *
+ * @returns The current enabled status.
+ */
+export type AnalyticsControllerIsEnabledAction = {
+    type: `AnalyticsController:isEnabled`;
+    handler: AnalyticsController['isEnabled'];
+};
+/**
+ * Get the opted in status from the controller state.
+ *
+ * @returns The current opted in status.
+ */
+export type AnalyticsControllerIsOptedInAction = {
+    type: `AnalyticsController:isOptedIn`;
+    handler: AnalyticsController['isOptedIn'];
+};
+/**
+ * Get the social opted in status from the controller state.
+ *
+ * @returns The current social opted in status.
+ */
+export type AnalyticsControllerIsSocialOptedInAction = {
+    type: `AnalyticsController:isSocialOptedIn`;
+    handler: AnalyticsController['isSocialOptedIn'];
+};
 /**
  * Union of all AnalyticsController action types.
  */
-export type AnalyticsControllerMethodActions = AnalyticsControllerTrackEventAction | AnalyticsControllerIdentifyAction | AnalyticsControllerTrackPageAction | AnalyticsControllerEnableAction | AnalyticsControllerDisableAction | AnalyticsControllerOptInAction | AnalyticsControllerOptOutAction;
+export type AnalyticsControllerMethodActions = AnalyticsControllerTrackEventAction | AnalyticsControllerIdentifyAction | AnalyticsControllerTrackViewAction | AnalyticsControllerOptInAction | AnalyticsControllerOptOutAction | AnalyticsControllerSocialOptInAction | AnalyticsControllerSocialOptOutAction | AnalyticsControllerGetAnalyticsIdAction | AnalyticsControllerIsEnabledAction | AnalyticsControllerIsOptedInAction | AnalyticsControllerIsSocialOptedInAction;
 //# 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,8BAA8B,GAAG;IAC3C,IAAI,EAAE,2BAA2B,CAAC;IAClC,OAAO,EAAE,mBAAmB,CAAC,OAAO,CAAC,CAAC;CACvC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,4BAA4B,CAAC;IACnC,OAAO,EAAE,mBAAmB,CAAC,QAAQ,CAAC,CAAC;CACxC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,oCAAoC,GAAG;IACjD,IAAI,EAAE,iCAAiC,CAAC;IACxC,OAAO,EAAE,mBAAmB,CAAC,aAAa,CAAC,CAAC;CAC7C,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,qCAAqC,GAAG;IAClD,IAAI,EAAE,kCAAkC,CAAC;IACzC,OAAO,EAAE,mBAAmB,CAAC,cAAc,CAAC,CAAC;CAC9C,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,uCAAuC,GAAG;IACpD,IAAI,EAAE,oCAAoC,CAAC;IAC3C,OAAO,EAAE,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;CAChD,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;;;;GAIG;AACH,MAAM,MAAM,kCAAkC,GAAG;IAC/C,IAAI,EAAE,+BAA+B,CAAC;IACtC,OAAO,EAAE,mBAAmB,CAAC,WAAW,CAAC,CAAC;CAC3C,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,wCAAwC,GAAG;IACrD,IAAI,EAAE,qCAAqC,CAAC;IAC5C,OAAO,EAAE,mBAAmB,CAAC,iBAAiB,CAAC,CAAC;CACjD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gCAAgC,GACxC,mCAAmC,GACnC,iCAAiC,GACjC,kCAAkC,GAClC,8BAA8B,GAC9B,+BAA+B,GAC/B,oCAAoC,GACpC,qCAAqC,GACrC,uCAAuC,GACvC,kCAAkC,GAClC,kCAAkC,GAClC,wCAAwC,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 = {
@@ -28,29 +26,16 @@ export type AnalyticsControllerIdentifyAction = {
 /**
  * Track a page view.
  *
- * @param pageName - The name of the page
- * @param properties - Page properties
+ * @param name - The name of the UI item being viewed (pages for web, screen for mobile)
+ * @param properties - UI item properties
  */
-export type AnalyticsControllerTrackPageAction = {
-    type: `AnalyticsController:trackPage`;
-    handler: AnalyticsController['trackPage'];
-};
-/**
- * Enable analytics tracking.
- */
-export type AnalyticsControllerEnableAction = {
-    type: `AnalyticsController:enable`;
-    handler: AnalyticsController['enable'];
-};
-/**
- * Disable analytics tracking.
- */
-export type AnalyticsControllerDisableAction = {
-    type: `AnalyticsController:disable`;
-    handler: AnalyticsController['disable'];
+export type AnalyticsControllerTrackViewAction = {
+    type: `AnalyticsController:trackView`;
+    handler: AnalyticsController['trackView'];
 };
 /**
  * Opt in to analytics.
+ * This updates the user's opt-in status.
  */
 export type AnalyticsControllerOptInAction = {
     type: `AnalyticsController:optIn`;
@@ -58,13 +43,67 @@ export type AnalyticsControllerOptInAction = {
 };
 /**
  * Opt out of analytics.
+ * This updates the user's opt-in status.
  */
 export type AnalyticsControllerOptOutAction = {
     type: `AnalyticsController:optOut`;
     handler: AnalyticsController['optOut'];
 };
+/**
+ * Opt in to analytics through social account.
+ * This updates the user's social opt-in status.
+ */
+export type AnalyticsControllerSocialOptInAction = {
+    type: `AnalyticsController:socialOptIn`;
+    handler: AnalyticsController['socialOptIn'];
+};
+/**
+ * Opt out of analytics through social account.
+ * This updates the user's social opt-in status.
+ */
+export type AnalyticsControllerSocialOptOutAction = {
+    type: `AnalyticsController:socialOptOut`;
+    handler: AnalyticsController['socialOptOut'];
+};
+/**
+ * Get the analytics ID from the controller state.
+ *
+ * @returns The current analytics ID.
+ */
+export type AnalyticsControllerGetAnalyticsIdAction = {
+    type: `AnalyticsController:getAnalyticsId`;
+    handler: AnalyticsController['getAnalyticsId'];
+};
+/**
+ * Get the enabled status from the controller state.
+ * This is computed from user state via the state machine.
+ *
+ * @returns The current enabled status.
+ */
+export type AnalyticsControllerIsEnabledAction = {
+    type: `AnalyticsController:isEnabled`;
+    handler: AnalyticsController['isEnabled'];
+};
+/**
+ * Get the opted in status from the controller state.
+ *
+ * @returns The current opted in status.
+ */
+export type AnalyticsControllerIsOptedInAction = {
+    type: `AnalyticsController:isOptedIn`;
+    handler: AnalyticsController['isOptedIn'];
+};
+/**
+ * Get the social opted in status from the controller state.
+ *
+ * @returns The current social opted in status.
+ */
+export type AnalyticsControllerIsSocialOptedInAction = {
+    type: `AnalyticsController:isSocialOptedIn`;
+    handler: AnalyticsController['isSocialOptedIn'];
+};
 /**
  * Union of all AnalyticsController action types.
  */
-export type AnalyticsControllerMethodActions = AnalyticsControllerTrackEventAction | AnalyticsControllerIdentifyAction | AnalyticsControllerTrackPageAction | AnalyticsControllerEnableAction | AnalyticsControllerDisableAction | AnalyticsControllerOptInAction | AnalyticsControllerOptOutAction;
+export type AnalyticsControllerMethodActions = AnalyticsControllerTrackEventAction | AnalyticsControllerIdentifyAction | AnalyticsControllerTrackViewAction | AnalyticsControllerOptInAction | AnalyticsControllerOptOutAction | AnalyticsControllerSocialOptInAction | AnalyticsControllerSocialOptOutAction | AnalyticsControllerGetAnalyticsIdAction | AnalyticsControllerIsEnabledAction | AnalyticsControllerIsOptedInAction | AnalyticsControllerIsSocialOptedInAction;
 //# 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,8BAA8B,GAAG;IAC3C,IAAI,EAAE,2BAA2B,CAAC;IAClC,OAAO,EAAE,mBAAmB,CAAC,OAAO,CAAC,CAAC;CACvC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C,IAAI,EAAE,4BAA4B,CAAC;IACnC,OAAO,EAAE,mBAAmB,CAAC,QAAQ,CAAC,CAAC;CACxC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,oCAAoC,GAAG;IACjD,IAAI,EAAE,iCAAiC,CAAC;IACxC,OAAO,EAAE,mBAAmB,CAAC,aAAa,CAAC,CAAC;CAC7C,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,qCAAqC,GAAG;IAClD,IAAI,EAAE,kCAAkC,CAAC;IACzC,OAAO,EAAE,mBAAmB,CAAC,cAAc,CAAC,CAAC;CAC9C,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,uCAAuC,GAAG;IACpD,IAAI,EAAE,oCAAoC,CAAC;IAC3C,OAAO,EAAE,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;CAChD,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;;;;GAIG;AACH,MAAM,MAAM,kCAAkC,GAAG;IAC/C,IAAI,EAAE,+BAA+B,CAAC;IACtC,OAAO,EAAE,mBAAmB,CAAC,WAAW,CAAC,CAAC;CAC3C,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,wCAAwC,GAAG;IACrD,IAAI,EAAE,qCAAqC,CAAC;IAC5C,OAAO,EAAE,mBAAmB,CAAC,iBAAiB,CAAC,CAAC;CACjD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gCAAgC,GACxC,mCAAmC,GACnC,iCAAiC,GACjC,kCAAkC,GAClC,8BAA8B,GAC9B,+BAA+B,GAC/B,oCAAoC,GACpC,qCAAqC,GACrC,uCAAuC,GACvC,kCAAkC,GAClC,kCAAkC,GAClC,wCAAwC,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 view.\n *\n * @param name - The name of the UI item being viewed (pages for web, screen for mobile)\n * @param properties - UI item properties\n */\nexport type AnalyticsControllerTrackViewAction = {\n  type: `AnalyticsController:trackView`;\n  handler: AnalyticsController['trackView'];\n};\n\n/**\n * Opt in to analytics.\n * This updates the user's opt-in status.\n */\nexport type AnalyticsControllerOptInAction = {\n  type: `AnalyticsController:optIn`;\n  handler: AnalyticsController['optIn'];\n};\n\n/**\n * Opt out of analytics.\n * This updates the user's opt-in status.\n */\nexport type AnalyticsControllerOptOutAction = {\n  type: `AnalyticsController:optOut`;\n  handler: AnalyticsController['optOut'];\n};\n\n/**\n * Opt in to analytics through social account.\n * This updates the user's social opt-in status.\n */\nexport type AnalyticsControllerSocialOptInAction = {\n  type: `AnalyticsController:socialOptIn`;\n  handler: AnalyticsController['socialOptIn'];\n};\n\n/**\n * Opt out of analytics through social account.\n * This updates the user's social opt-in status.\n */\nexport type AnalyticsControllerSocialOptOutAction = {\n  type: `AnalyticsController:socialOptOut`;\n  handler: AnalyticsController['socialOptOut'];\n};\n\n/**\n * Get the analytics ID from the controller state.\n *\n * @returns The current analytics ID.\n */\nexport type AnalyticsControllerGetAnalyticsIdAction = {\n  type: `AnalyticsController:getAnalyticsId`;\n  handler: AnalyticsController['getAnalyticsId'];\n};\n\n/**\n * Get the enabled status from the controller state.\n * This is computed from user state via the state machine.\n *\n * @returns The current enabled status.\n */\nexport type AnalyticsControllerIsEnabledAction = {\n  type: `AnalyticsController:isEnabled`;\n  handler: AnalyticsController['isEnabled'];\n};\n\n/**\n * Get the opted in status from the controller state.\n *\n * @returns The current opted in status.\n */\nexport type AnalyticsControllerIsOptedInAction = {\n  type: `AnalyticsController:isOptedIn`;\n  handler: AnalyticsController['isOptedIn'];\n};\n\n/**\n * Get the social opted in status from the controller state.\n *\n * @returns The current social opted in status.\n */\nexport type AnalyticsControllerIsSocialOptedInAction = {\n  type: `AnalyticsController:isSocialOptedIn`;\n  handler: AnalyticsController['isSocialOptedIn'];\n};\n\n/**\n * Union of all AnalyticsController action types.\n */\nexport type AnalyticsControllerMethodActions =\n  | AnalyticsControllerTrackEventAction\n  | AnalyticsControllerIdentifyAction\n  | AnalyticsControllerTrackViewAction\n  | AnalyticsControllerOptInAction\n  | AnalyticsControllerOptOutAction\n  | AnalyticsControllerSocialOptInAction\n  | AnalyticsControllerSocialOptOutAction\n  | AnalyticsControllerGetAnalyticsIdAction\n  | AnalyticsControllerIsEnabledAction\n  | AnalyticsControllerIsOptedInAction\n  | AnalyticsControllerIsSocialOptedInAction;\n"]}