@metamask-previews/analytics-controller 0.0.0-preview-81bccf77 → 0.0.0-preview-1f85e85a

package/README.md

@@ -193,6 +193,16 @@ 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).
 
+## Debugging
+
+To display analytics-controller logs in the mobile app, you can add the following to your `.js.env` file:
+
+```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.
+
 ## Contributing
 
 This package is part of a monorepo. Instructions for contributing can be found in the [monorepo README](https://github.com/MetaMask/core#readme).

package/dist/AnalyticsPlatformAdapter.types.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"AnalyticsPlatformAdapter.types.cjs","sourceRoot":"","sources":["../src/AnalyticsPlatformAdapter.types.ts"],"names":[],"mappings":"","sourcesContent":["import type { Json } from '@metamask/utils';\n\n/**\n * Analytics event properties\n */\nexport type AnalyticsEventProperties = Record<string, Json>;\n\n/**\n * Platform adapter interface for analytics tracking\n * Implementations should handle platform-specific details (Segment SDK, etc.)\n */\nexport type AnalyticsPlatformAdapter = {\n  /**\n   * Track an analytics event\n   *\n   * @param eventName - The name of the event\n   * @param properties - Event properties\n   */\n  trackEvent(eventName: string, properties: AnalyticsEventProperties): void;\n\n  /**\n   * Identify a user\n   *\n   * @param userId - The user identifier (e.g., metametrics ID)\n   * @param traits - User traits/properties\n   */\n  identify?(userId: string, traits?: AnalyticsEventProperties): void;\n\n  /**\n   * Track a page view\n   *\n   * @param pageName - The name of the page\n   * @param properties - Page properties\n   */\n  trackPage?(pageName: string, properties?: AnalyticsEventProperties): void;\n};\n"]}
+{"version":3,"file":"AnalyticsPlatformAdapter.types.cjs","sourceRoot":"","sources":["../src/AnalyticsPlatformAdapter.types.ts"],"names":[],"mappings":"","sourcesContent":["import type { Json } from '@metamask/utils';\n\n/**\n * Analytics event properties\n */\nexport type AnalyticsEventProperties = Record<string, Json>;\n\n/**\n * Platform adapter interface for analytics tracking\n * Implementations should handle platform-specific details (Segment SDK, etc.)\n *\n * @todo This type is work in progress and will be updated as we\n * integrate with the new analytics system on mobile.\n * We have this draft type to help us iterate on the implementation.\n * It will be updated with proper types as we create the mobile adapter\n * And the controller package will be released only when this is completed.\n */\nexport type AnalyticsPlatformAdapter = {\n  /**\n   * Track an analytics event\n   *\n   * @param eventName - The name of the event\n   * @param properties - Event properties\n   */\n  trackEvent(eventName: string, properties: AnalyticsEventProperties): void;\n\n  /**\n   * Identify a user\n   *\n   * @param userId - The user identifier (e.g., metametrics ID)\n   * @param traits - User traits/properties\n   */\n  identify?(userId: string, traits?: AnalyticsEventProperties): void;\n\n  /**\n   * Track a page view\n   *\n   * @param pageName - The name of the page\n   * @param properties - Page properties\n   */\n  trackPage?(pageName: string, properties?: AnalyticsEventProperties): void;\n};\n"]}

package/dist/AnalyticsPlatformAdapter.types.d.cts

@@ -6,6 +6,12 @@ export type AnalyticsEventProperties = Record<string, Json>;
 /**
  * Platform adapter interface for analytics tracking
  * Implementations should handle platform-specific details (Segment SDK, etc.)
+ *
+ * @todo This type is work in progress and will be updated as we
+ * integrate with the new analytics system on mobile.
+ * We have this draft type to help us iterate on the implementation.
+ * It will be updated with proper types as we create the mobile adapter
+ * And the controller package will be released only when this is completed.
  */
 export type AnalyticsPlatformAdapter = {
     /**

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

@@ -1 +1 @@
-{"version":3,"file":"AnalyticsPlatformAdapter.types.d.cts","sourceRoot":"","sources":["../src/AnalyticsPlatformAdapter.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAE5C;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;AAE5D;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;;;;OAKG;IACH,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,wBAAwB,GAAG,IAAI,CAAC;IAE1E;;;;;OAKG;IACH,QAAQ,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,wBAAwB,GAAG,IAAI,CAAC;IAEnE;;;;;OAKG;IACH,SAAS,CAAC,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,wBAAwB,GAAG,IAAI,CAAC;CAC3E,CAAC"}
+{"version":3,"file":"AnalyticsPlatformAdapter.types.d.cts","sourceRoot":"","sources":["../src/AnalyticsPlatformAdapter.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAE5C;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;AAE5D;;;;;;;;;GASG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;;;;OAKG;IACH,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,wBAAwB,GAAG,IAAI,CAAC;IAE1E;;;;;OAKG;IACH,QAAQ,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,wBAAwB,GAAG,IAAI,CAAC;IAEnE;;;;;OAKG;IACH,SAAS,CAAC,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,wBAAwB,GAAG,IAAI,CAAC;CAC3E,CAAC"}

package/dist/AnalyticsPlatformAdapter.types.d.mts

@@ -6,6 +6,12 @@ export type AnalyticsEventProperties = Record<string, Json>;
 /**
  * Platform adapter interface for analytics tracking
  * Implementations should handle platform-specific details (Segment SDK, etc.)
+ *
+ * @todo This type is work in progress and will be updated as we
+ * integrate with the new analytics system on mobile.
+ * We have this draft type to help us iterate on the implementation.
+ * It will be updated with proper types as we create the mobile adapter
+ * And the controller package will be released only when this is completed.
  */
 export type AnalyticsPlatformAdapter = {
     /**

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

@@ -1 +1 @@
-{"version":3,"file":"AnalyticsPlatformAdapter.types.d.mts","sourceRoot":"","sources":["../src/AnalyticsPlatformAdapter.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAE5C;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;AAE5D;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;;;;OAKG;IACH,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,wBAAwB,GAAG,IAAI,CAAC;IAE1E;;;;;OAKG;IACH,QAAQ,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,wBAAwB,GAAG,IAAI,CAAC;IAEnE;;;;;OAKG;IACH,SAAS,CAAC,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,wBAAwB,GAAG,IAAI,CAAC;CAC3E,CAAC"}
+{"version":3,"file":"AnalyticsPlatformAdapter.types.d.mts","sourceRoot":"","sources":["../src/AnalyticsPlatformAdapter.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAE5C;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;AAE5D;;;;;;;;;GASG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;;;;OAKG;IACH,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,wBAAwB,GAAG,IAAI,CAAC;IAE1E;;;;;OAKG;IACH,QAAQ,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,wBAAwB,GAAG,IAAI,CAAC;IAEnE;;;;;OAKG;IACH,SAAS,CAAC,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,wBAAwB,GAAG,IAAI,CAAC;CAC3E,CAAC"}

package/dist/AnalyticsPlatformAdapter.types.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"AnalyticsPlatformAdapter.types.mjs","sourceRoot":"","sources":["../src/AnalyticsPlatformAdapter.types.ts"],"names":[],"mappings":"","sourcesContent":["import type { Json } from '@metamask/utils';\n\n/**\n * Analytics event properties\n */\nexport type AnalyticsEventProperties = Record<string, Json>;\n\n/**\n * Platform adapter interface for analytics tracking\n * Implementations should handle platform-specific details (Segment SDK, etc.)\n */\nexport type AnalyticsPlatformAdapter = {\n  /**\n   * Track an analytics event\n   *\n   * @param eventName - The name of the event\n   * @param properties - Event properties\n   */\n  trackEvent(eventName: string, properties: AnalyticsEventProperties): void;\n\n  /**\n   * Identify a user\n   *\n   * @param userId - The user identifier (e.g., metametrics ID)\n   * @param traits - User traits/properties\n   */\n  identify?(userId: string, traits?: AnalyticsEventProperties): void;\n\n  /**\n   * Track a page view\n   *\n   * @param pageName - The name of the page\n   * @param properties - Page properties\n   */\n  trackPage?(pageName: string, properties?: AnalyticsEventProperties): void;\n};\n"]}
+{"version":3,"file":"AnalyticsPlatformAdapter.types.mjs","sourceRoot":"","sources":["../src/AnalyticsPlatformAdapter.types.ts"],"names":[],"mappings":"","sourcesContent":["import type { Json } from '@metamask/utils';\n\n/**\n * Analytics event properties\n */\nexport type AnalyticsEventProperties = Record<string, Json>;\n\n/**\n * Platform adapter interface for analytics tracking\n * Implementations should handle platform-specific details (Segment SDK, etc.)\n *\n * @todo This type is work in progress and will be updated as we\n * integrate with the new analytics system on mobile.\n * We have this draft type to help us iterate on the implementation.\n * It will be updated with proper types as we create the mobile adapter\n * And the controller package will be released only when this is completed.\n */\nexport type AnalyticsPlatformAdapter = {\n  /**\n   * Track an analytics event\n   *\n   * @param eventName - The name of the event\n   * @param properties - Event properties\n   */\n  trackEvent(eventName: string, properties: AnalyticsEventProperties): void;\n\n  /**\n   * Identify a user\n   *\n   * @param userId - The user identifier (e.g., metametrics ID)\n   * @param traits - User traits/properties\n   */\n  identify?(userId: string, traits?: AnalyticsEventProperties): void;\n\n  /**\n   * Track a page view\n   *\n   * @param pageName - The name of the page\n   * @param properties - Page properties\n   */\n  trackPage?(pageName: string, properties?: AnalyticsEventProperties): void;\n};\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/analytics-controller",
-  "version": "0.0.0-preview-81bccf77",
+  "version": "0.0.0-preview-1f85e85a",
   "description": "Common Analytics controller for event tracking",
   "keywords": [
     "MetaMask",