@metamask-previews/analytics-controller 1.2.1-preview-a1d0bbfa8 → 1.2.1-preview-d77c814bb

package/dist/AnalyticsPlatformAdapter.types.d.cts

@@ -51,6 +51,25 @@ export type AnalyticsTrackingEvent = {
  * Optional analytics context payload (for example Segment-style context).
  */
 export type AnalyticsContext = Record<string, Json>;
+/**
+ * Names of the geolocation fields attached to an analytics event.
+ *
+ * These follow the schema that downstream analytics destinations expect, which
+ * is why they are snake_case rather than camelCase:
+ *
+ * - `country_code` is an ISO 3166-1 alpha-2 country code (e.g. `US`).
+ * - `region` is an ISO 3166-2 subdivision code without the country prefix
+ *   (e.g. `WA`).
+ * - `timezone` is an IANA time zone name (e.g. `America/Los_Angeles`).
+ */
+export type AnalyticsLocationField = 'country_code' | 'region' | 'timezone';
+/**
+ * Geolocation fields attached to the `location` key of {@link AnalyticsContext}.
+ *
+ * Each field is only present when the geolocation API returned a valid value
+ * for it.
+ */
+export type AnalyticsLocationContext = Partial<Record<AnalyticsLocationField, string>>;
 /**
  * Platform adapter interface for analytics tracking
  * Implementations should handle platform-specific details (Segment SDK, etc.)

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;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;AAEvD;;;GAGG;AACH,MAAM,MAAM,2BAA2B,GAAG,CAAC,KAAK,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;AAEpE;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,2BAA2B,CAAC;CACxC,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,wBAAwB,CAAC;IACrC,mBAAmB,EAAE,wBAAwB,CAAC;IAC9C;;;;OAIG;IACH,iBAAiB,EAAE,OAAO,CAAC;IAC3B,QAAQ,CAAC,aAAa,EAAE,OAAO,CAAC;CACjC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;AAEpD;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;;;;;;;;;OAUG;IACH,KAAK,CACH,SAAS,EAAE,MAAM,EACjB,UAAU,CAAC,EAAE,wBAAwB,EACrC,OAAO,CAAC,EAAE,gBAAgB,EAC1B,OAAO,CAAC,EAAE,wBAAwB,GACjC,IAAI,CAAC;IAER;;;;;;;OAOG;IACH,QAAQ,CACN,MAAM,EAAE,MAAM,EACd,MAAM,CAAC,EAAE,mBAAmB,EAC5B,OAAO,CAAC,EAAE,gBAAgB,EAC1B,OAAO,CAAC,EAAE,wBAAwB,GACjC,IAAI,CAAC;IAER;;;;;;;;;;;OAWG;IACH,IAAI,CACF,IAAI,EAAE,MAAM,EACZ,UAAU,CAAC,EAAE,wBAAwB,EACrC,OAAO,CAAC,EAAE,gBAAgB,EAC1B,OAAO,CAAC,EAAE,wBAAwB,GACjC,IAAI,CAAC;IAER;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,gBAAgB,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7C,CAAC"}
+{"version":3,"file":"AnalyticsPlatformAdapter.types.d.cts","sourceRoot":"","sources":["../src/AnalyticsPlatformAdapter.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,wBAAwB;AAE5C;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;AAE5D;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;AAEvD;;;GAGG;AACH,MAAM,MAAM,2BAA2B,GAAG,CAAC,KAAK,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;AAEpE;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,2BAA2B,CAAC;CACxC,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,wBAAwB,CAAC;IACrC,mBAAmB,EAAE,wBAAwB,CAAC;IAC9C;;;;OAIG;IACH,iBAAiB,EAAE,OAAO,CAAC;IAC3B,QAAQ,CAAC,aAAa,EAAE,OAAO,CAAC;CACjC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;AAEpD;;;;;;;;;;GAUG;AACH,MAAM,MAAM,sBAAsB,GAAG,cAAc,GAAG,QAAQ,GAAG,UAAU,CAAC;AAE5E;;;;;GAKG;AACH,MAAM,MAAM,wBAAwB,GAAG,OAAO,CAC5C,MAAM,CAAC,sBAAsB,EAAE,MAAM,CAAC,CACvC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;;;;;;;;;OAUG;IACH,KAAK,CACH,SAAS,EAAE,MAAM,EACjB,UAAU,CAAC,EAAE,wBAAwB,EACrC,OAAO,CAAC,EAAE,gBAAgB,EAC1B,OAAO,CAAC,EAAE,wBAAwB,GACjC,IAAI,CAAC;IAER;;;;;;;OAOG;IACH,QAAQ,CACN,MAAM,EAAE,MAAM,EACd,MAAM,CAAC,EAAE,mBAAmB,EAC5B,OAAO,CAAC,EAAE,gBAAgB,EAC1B,OAAO,CAAC,EAAE,wBAAwB,GACjC,IAAI,CAAC;IAER;;;;;;;;;;;OAWG;IACH,IAAI,CACF,IAAI,EAAE,MAAM,EACZ,UAAU,CAAC,EAAE,wBAAwB,EACrC,OAAO,CAAC,EAAE,gBAAgB,EAC1B,OAAO,CAAC,EAAE,wBAAwB,GACjC,IAAI,CAAC;IAER;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,gBAAgB,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7C,CAAC"}

package/dist/AnalyticsPlatformAdapter.types.d.mts

@@ -51,6 +51,25 @@ export type AnalyticsTrackingEvent = {
  * Optional analytics context payload (for example Segment-style context).
  */
 export type AnalyticsContext = Record<string, Json>;
+/**
+ * Names of the geolocation fields attached to an analytics event.
+ *
+ * These follow the schema that downstream analytics destinations expect, which
+ * is why they are snake_case rather than camelCase:
+ *
+ * - `country_code` is an ISO 3166-1 alpha-2 country code (e.g. `US`).
+ * - `region` is an ISO 3166-2 subdivision code without the country prefix
+ *   (e.g. `WA`).
+ * - `timezone` is an IANA time zone name (e.g. `America/Los_Angeles`).
+ */
+export type AnalyticsLocationField = 'country_code' | 'region' | 'timezone';
+/**
+ * Geolocation fields attached to the `location` key of {@link AnalyticsContext}.
+ *
+ * Each field is only present when the geolocation API returned a valid value
+ * for it.
+ */
+export type AnalyticsLocationContext = Partial<Record<AnalyticsLocationField, string>>;
 /**
  * Platform adapter interface for analytics tracking
  * Implementations should handle platform-specific details (Segment SDK, etc.)

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;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;AAEvD;;;GAGG;AACH,MAAM,MAAM,2BAA2B,GAAG,CAAC,KAAK,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;AAEpE;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,2BAA2B,CAAC;CACxC,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,wBAAwB,CAAC;IACrC,mBAAmB,EAAE,wBAAwB,CAAC;IAC9C;;;;OAIG;IACH,iBAAiB,EAAE,OAAO,CAAC;IAC3B,QAAQ,CAAC,aAAa,EAAE,OAAO,CAAC;CACjC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;AAEpD;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;;;;;;;;;OAUG;IACH,KAAK,CACH,SAAS,EAAE,MAAM,EACjB,UAAU,CAAC,EAAE,wBAAwB,EACrC,OAAO,CAAC,EAAE,gBAAgB,EAC1B,OAAO,CAAC,EAAE,wBAAwB,GACjC,IAAI,CAAC;IAER;;;;;;;OAOG;IACH,QAAQ,CACN,MAAM,EAAE,MAAM,EACd,MAAM,CAAC,EAAE,mBAAmB,EAC5B,OAAO,CAAC,EAAE,gBAAgB,EAC1B,OAAO,CAAC,EAAE,wBAAwB,GACjC,IAAI,CAAC;IAER;;;;;;;;;;;OAWG;IACH,IAAI,CACF,IAAI,EAAE,MAAM,EACZ,UAAU,CAAC,EAAE,wBAAwB,EACrC,OAAO,CAAC,EAAE,gBAAgB,EAC1B,OAAO,CAAC,EAAE,wBAAwB,GACjC,IAAI,CAAC;IAER;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,gBAAgB,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7C,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;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;AAEvD;;;GAGG;AACH,MAAM,MAAM,2BAA2B,GAAG,CAAC,KAAK,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;AAEpE;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,2BAA2B,CAAC;CACxC,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,wBAAwB,CAAC;IACrC,mBAAmB,EAAE,wBAAwB,CAAC;IAC9C;;;;OAIG;IACH,iBAAiB,EAAE,OAAO,CAAC;IAC3B,QAAQ,CAAC,aAAa,EAAE,OAAO,CAAC;CACjC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;AAEpD;;;;;;;;;;GAUG;AACH,MAAM,MAAM,sBAAsB,GAAG,cAAc,GAAG,QAAQ,GAAG,UAAU,CAAC;AAE5E;;;;;GAKG;AACH,MAAM,MAAM,wBAAwB,GAAG,OAAO,CAC5C,MAAM,CAAC,sBAAsB,EAAE,MAAM,CAAC,CACvC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;;;;;;;;;OAUG;IACH,KAAK,CACH,SAAS,EAAE,MAAM,EACjB,UAAU,CAAC,EAAE,wBAAwB,EACrC,OAAO,CAAC,EAAE,gBAAgB,EAC1B,OAAO,CAAC,EAAE,wBAAwB,GACjC,IAAI,CAAC;IAER;;;;;;;OAOG;IACH,QAAQ,CACN,MAAM,EAAE,MAAM,EACd,MAAM,CAAC,EAAE,mBAAmB,EAC5B,OAAO,CAAC,EAAE,gBAAgB,EAC1B,OAAO,CAAC,EAAE,wBAAwB,GACjC,IAAI,CAAC;IAER;;;;;;;;;;;OAWG;IACH,IAAI,CACF,IAAI,EAAE,MAAM,EACZ,UAAU,CAAC,EAAE,wBAAwB,EACrC,OAAO,CAAC,EAAE,gBAAgB,EAC1B,OAAO,CAAC,EAAE,wBAAwB,GACjC,IAAI,CAAC;IAER;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,gBAAgB,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7C,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 * User traits/properties for analytics identification\n */\nexport type AnalyticsUserTraits = Record<string, Json>;\n\n/**\n * Callback invoked by the platform adapter after an analytics payload is\n * delivered or fails.\n */\nexport type AnalyticsInvocationCallback = (error?: unknown) => void;\n\n/**\n * Internal delivery metadata used by AnalyticsController when event queue\n * persistence is enabled.\n */\nexport type AnalyticsDeliveryOptions = {\n  /**\n   * Stable identifier for the analytics payload.\n   */\n  messageId?: string;\n\n  /**\n   * Original timestamp for the analytics payload.\n   */\n  timestamp?: Date;\n\n  /**\n   * Callback for delivery acknowledgement.\n   */\n  callback?: AnalyticsInvocationCallback;\n};\n\n/**\n * Event properties structure with two distinct properties lists for regular and sensitive data.\n * Similar to ITrackingEvent from legacy analytics but decoupled for platform agnosticism.\n * Sensitivity is derived from the presence of sensitiveProperties (if sensitiveProperties has keys, the event is sensitive).\n */\nexport type AnalyticsTrackingEvent = {\n  readonly name: string;\n  properties: AnalyticsEventProperties;\n  sensitiveProperties: AnalyticsEventProperties;\n  /**\n   * Legacy property handled by the mobile app.\n   * This property is ignored by the analytics controller and will be removed from the type in the future.\n   * The mobile app will use the future analytics privacy controller to handle this functionality.\n   */\n  saveDataRecording: boolean;\n  readonly hasProperties: boolean;\n};\n\n/**\n * Optional analytics context payload (for example Segment-style context).\n */\nexport type AnalyticsContext = 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   * When `true`, the controller accepts any non-empty `analyticsId` string\n   * instead of requiring UUIDv4 format. Defaults to validation against UUIDv4 when omitted or `false`.\n   */\n  skipUUIDv4Check?: boolean;\n\n  /**\n   * Track an analytics event.\n   *\n   * This is the same as trackEvent in the old analytics system\n   *\n   * @param eventName - The name of the event\n   * @param properties - Event properties. If not provided, the event has no properties.\n   * The privacy plugin should check for `isSensitive === true` to determine if an event contains sensitive data.\n   * @param context - Optional platform-specific context attached to the invocation.\n   * @param options - Optional delivery metadata for platform adapters.\n   */\n  track(\n    eventName: string,\n    properties?: AnalyticsEventProperties,\n    context?: AnalyticsContext,\n    options?: AnalyticsDeliveryOptions,\n  ): void;\n\n  /**\n   * Identify a user with traits.\n   *\n   * @param userId - The user identifier (e.g., metametrics ID)\n   * @param traits - User traits/properties\n   * @param context - Optional platform-specific context attached to the invocation.\n   * @param options - Optional delivery metadata for platform adapters.\n   */\n  identify(\n    userId: string,\n    traits?: AnalyticsUserTraits,\n    context?: AnalyticsContext,\n    options?: AnalyticsDeliveryOptions,\n  ): void;\n\n  /**\n   * Track a UI unit (page or screen) view depending on the platform\n   *\n   * This method delegates to platform-specific Segment SDK methods:\n   * - Web adapters should call `analytics.page(name, properties)`\n   * - Mobile adapters should call `analytics.screen(name, properties)`\n   *\n   * @param name - The identifier/name of the page or screen being viewed (e.g., \"home\", \"settings\", \"wallet\")\n   * @param properties - Optional properties associated with the view\n   * @param context - Optional platform-specific context attached to the invocation.\n   * @param options - Optional delivery metadata for platform adapters.\n   */\n  view(\n    name: string,\n    properties?: AnalyticsEventProperties,\n    context?: AnalyticsContext,\n    options?: AnalyticsDeliveryOptions,\n  ): void;\n\n  /**\n   * Lifecycle hook called after the AnalyticsController is fully initialized.\n   *\n   * This hook allows platform-specific adapters to perform setup that requires\n   * access to the controller's state (e.g., analyticsId).\n   *\n   * The controller calls this method once after initialization, passing the\n   * analyticsId from controller state. The analyticsId is guaranteed to be set\n   * when this method is called - this is the definition of \"completed\" setup.\n   *\n   * @param analyticsId - The analytics ID from controller state. Always set (never empty).\n   * @throws {AnalyticsPlatformAdapterSetupError} May throw errors during setup (e.g., configuration errors, network failures).\n   * Errors thrown by this method are caught and logged by the controller, but do not prevent\n   * controller initialization from completing successfully.\n   *\n   * @example\n   * ```typescript\n   * onSetupCompleted(analyticsId: string): void {\n   *   // Add platform-specific plugins that require analyticsId\n   *   client.add({\n   *     plugin: new PrivacyPlugin(analyticsId),\n   *   });\n   * }\n   * ```\n   */\n  onSetupCompleted(analyticsId: string): 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 * User traits/properties for analytics identification\n */\nexport type AnalyticsUserTraits = Record<string, Json>;\n\n/**\n * Callback invoked by the platform adapter after an analytics payload is\n * delivered or fails.\n */\nexport type AnalyticsInvocationCallback = (error?: unknown) => void;\n\n/**\n * Internal delivery metadata used by AnalyticsController when event queue\n * persistence is enabled.\n */\nexport type AnalyticsDeliveryOptions = {\n  /**\n   * Stable identifier for the analytics payload.\n   */\n  messageId?: string;\n\n  /**\n   * Original timestamp for the analytics payload.\n   */\n  timestamp?: Date;\n\n  /**\n   * Callback for delivery acknowledgement.\n   */\n  callback?: AnalyticsInvocationCallback;\n};\n\n/**\n * Event properties structure with two distinct properties lists for regular and sensitive data.\n * Similar to ITrackingEvent from legacy analytics but decoupled for platform agnosticism.\n * Sensitivity is derived from the presence of sensitiveProperties (if sensitiveProperties has keys, the event is sensitive).\n */\nexport type AnalyticsTrackingEvent = {\n  readonly name: string;\n  properties: AnalyticsEventProperties;\n  sensitiveProperties: AnalyticsEventProperties;\n  /**\n   * Legacy property handled by the mobile app.\n   * This property is ignored by the analytics controller and will be removed from the type in the future.\n   * The mobile app will use the future analytics privacy controller to handle this functionality.\n   */\n  saveDataRecording: boolean;\n  readonly hasProperties: boolean;\n};\n\n/**\n * Optional analytics context payload (for example Segment-style context).\n */\nexport type AnalyticsContext = Record<string, Json>;\n\n/**\n * Names of the geolocation fields attached to an analytics event.\n *\n * These follow the schema that downstream analytics destinations expect, which\n * is why they are snake_case rather than camelCase:\n *\n * - `country_code` is an ISO 3166-1 alpha-2 country code (e.g. `US`).\n * - `region` is an ISO 3166-2 subdivision code without the country prefix\n *   (e.g. `WA`).\n * - `timezone` is an IANA time zone name (e.g. `America/Los_Angeles`).\n */\nexport type AnalyticsLocationField = 'country_code' | 'region' | 'timezone';\n\n/**\n * Geolocation fields attached to the `location` key of {@link AnalyticsContext}.\n *\n * Each field is only present when the geolocation API returned a valid value\n * for it.\n */\nexport type AnalyticsLocationContext = Partial<\n  Record<AnalyticsLocationField, string>\n>;\n\n/**\n * Platform adapter interface for analytics tracking\n * Implementations should handle platform-specific details (Segment SDK, etc.)\n */\nexport type AnalyticsPlatformAdapter = {\n  /**\n   * When `true`, the controller accepts any non-empty `analyticsId` string\n   * instead of requiring UUIDv4 format. Defaults to validation against UUIDv4 when omitted or `false`.\n   */\n  skipUUIDv4Check?: boolean;\n\n  /**\n   * Track an analytics event.\n   *\n   * This is the same as trackEvent in the old analytics system\n   *\n   * @param eventName - The name of the event\n   * @param properties - Event properties. If not provided, the event has no properties.\n   * The privacy plugin should check for `isSensitive === true` to determine if an event contains sensitive data.\n   * @param context - Optional platform-specific context attached to the invocation.\n   * @param options - Optional delivery metadata for platform adapters.\n   */\n  track(\n    eventName: string,\n    properties?: AnalyticsEventProperties,\n    context?: AnalyticsContext,\n    options?: AnalyticsDeliveryOptions,\n  ): void;\n\n  /**\n   * Identify a user with traits.\n   *\n   * @param userId - The user identifier (e.g., metametrics ID)\n   * @param traits - User traits/properties\n   * @param context - Optional platform-specific context attached to the invocation.\n   * @param options - Optional delivery metadata for platform adapters.\n   */\n  identify(\n    userId: string,\n    traits?: AnalyticsUserTraits,\n    context?: AnalyticsContext,\n    options?: AnalyticsDeliveryOptions,\n  ): void;\n\n  /**\n   * Track a UI unit (page or screen) view depending on the platform\n   *\n   * This method delegates to platform-specific Segment SDK methods:\n   * - Web adapters should call `analytics.page(name, properties)`\n   * - Mobile adapters should call `analytics.screen(name, properties)`\n   *\n   * @param name - The identifier/name of the page or screen being viewed (e.g., \"home\", \"settings\", \"wallet\")\n   * @param properties - Optional properties associated with the view\n   * @param context - Optional platform-specific context attached to the invocation.\n   * @param options - Optional delivery metadata for platform adapters.\n   */\n  view(\n    name: string,\n    properties?: AnalyticsEventProperties,\n    context?: AnalyticsContext,\n    options?: AnalyticsDeliveryOptions,\n  ): void;\n\n  /**\n   * Lifecycle hook called after the AnalyticsController is fully initialized.\n   *\n   * This hook allows platform-specific adapters to perform setup that requires\n   * access to the controller's state (e.g., analyticsId).\n   *\n   * The controller calls this method once after initialization, passing the\n   * analyticsId from controller state. The analyticsId is guaranteed to be set\n   * when this method is called - this is the definition of \"completed\" setup.\n   *\n   * @param analyticsId - The analytics ID from controller state. Always set (never empty).\n   * @throws {AnalyticsPlatformAdapterSetupError} May throw errors during setup (e.g., configuration errors, network failures).\n   * Errors thrown by this method are caught and logged by the controller, but do not prevent\n   * controller initialization from completing successfully.\n   *\n   * @example\n   * ```typescript\n   * onSetupCompleted(analyticsId: string): void {\n   *   // Add platform-specific plugins that require analyticsId\n   *   client.add({\n   *     plugin: new PrivacyPlugin(analyticsId),\n   *   });\n   * }\n   * ```\n   */\n  onSetupCompleted(analyticsId: string): void;\n};\n"]}

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,8CAA8C;AAC9C,oEAGkC;AAFhC,6HAAA,mBAAmB,OAAA;AACnB,4IAAA,kCAAkC,OAAA;AAIpC,gBAAgB;AAChB,kGAA6F;AAApF,2JAAA,kCAAkC,OAAA;AAwB3C,mBAAmB;AACnB,gDAA8D;AAArD,4HAAA,4BAA4B,OAAA","sourcesContent":["// Export controller class and state utilities\nexport {\n  AnalyticsController,\n  getDefaultAnalyticsControllerState,\n} from './AnalyticsController.js';\nexport type { AnalyticsControllerOptions } from './AnalyticsController.js';\n\n// Export errors\nexport { AnalyticsPlatformAdapterSetupError } from './AnalyticsPlatformAdapterSetupError.js';\n\n// Export types\nexport type {\n  AnalyticsContext,\n  AnalyticsEventProperties,\n  AnalyticsDeliveryOptions,\n  AnalyticsInvocationCallback,\n  AnalyticsUserTraits,\n  AnalyticsPlatformAdapter,\n  AnalyticsTrackingEvent,\n} from './AnalyticsPlatformAdapter.types';\n\n// Export state types\nexport type {\n  AnalyticsControllerState,\n  AnalyticsEventQueue,\n  AnalyticsQueuedEvent,\n  AnalyticsQueuedEventType,\n  AnalyticsQueuedTrackEvent,\n  AnalyticsQueuedIdentifyEvent,\n  AnalyticsQueuedViewEvent,\n} from './AnalyticsController.js';\n\n// Export selectors\nexport { analyticsControllerSelectors } from './selectors.js';\n\n// Export messenger types\nexport type { AnalyticsControllerMessenger } from './AnalyticsController.js';\n\n// Export action and event types\nexport type {\n  AnalyticsControllerActions,\n  AnalyticsControllerEvents,\n  AnalyticsControllerGetStateAction,\n  AnalyticsControllerStateChangeEvent,\n} from './AnalyticsController.js';\nexport type {\n  AnalyticsControllerTrackEventAction,\n  AnalyticsControllerIdentifyAction,\n  AnalyticsControllerTrackViewAction,\n  AnalyticsControllerOptInAction,\n  AnalyticsControllerOptOutAction,\n  AnalyticsControllerResetConsentDecisionAction,\n  AnalyticsControllerMethodActions,\n} from './AnalyticsController-method-action-types.js';\n"]}
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,8CAA8C;AAC9C,oEAGkC;AAFhC,6HAAA,mBAAmB,OAAA;AACnB,4IAAA,kCAAkC,OAAA;AAIpC,gBAAgB;AAChB,kGAA6F;AAApF,2JAAA,kCAAkC,OAAA;AA0B3C,mBAAmB;AACnB,gDAA8D;AAArD,4HAAA,4BAA4B,OAAA","sourcesContent":["// Export controller class and state utilities\nexport {\n  AnalyticsController,\n  getDefaultAnalyticsControllerState,\n} from './AnalyticsController.js';\nexport type { AnalyticsControllerOptions } from './AnalyticsController.js';\n\n// Export errors\nexport { AnalyticsPlatformAdapterSetupError } from './AnalyticsPlatformAdapterSetupError.js';\n\n// Export types\nexport type {\n  AnalyticsContext,\n  AnalyticsEventProperties,\n  AnalyticsDeliveryOptions,\n  AnalyticsInvocationCallback,\n  AnalyticsLocationContext,\n  AnalyticsLocationField,\n  AnalyticsUserTraits,\n  AnalyticsPlatformAdapter,\n  AnalyticsTrackingEvent,\n} from './AnalyticsPlatformAdapter.types';\n\n// Export state types\nexport type {\n  AnalyticsControllerState,\n  AnalyticsEventQueue,\n  AnalyticsQueuedEvent,\n  AnalyticsQueuedEventType,\n  AnalyticsQueuedTrackEvent,\n  AnalyticsQueuedIdentifyEvent,\n  AnalyticsQueuedViewEvent,\n} from './AnalyticsController.js';\n\n// Export selectors\nexport { analyticsControllerSelectors } from './selectors.js';\n\n// Export messenger types\nexport type { AnalyticsControllerMessenger } from './AnalyticsController.js';\n\n// Export action and event types\nexport type {\n  AnalyticsControllerActions,\n  AnalyticsControllerEvents,\n  AnalyticsControllerGetStateAction,\n  AnalyticsControllerStateChangeEvent,\n} from './AnalyticsController.js';\nexport type {\n  AnalyticsControllerTrackEventAction,\n  AnalyticsControllerIdentifyAction,\n  AnalyticsControllerTrackViewAction,\n  AnalyticsControllerOptInAction,\n  AnalyticsControllerOptOutAction,\n  AnalyticsControllerResetConsentDecisionAction,\n  AnalyticsControllerMethodActions,\n} from './AnalyticsController-method-action-types.js';\n"]}

package/dist/index.d.cts

@@ -1,7 +1,7 @@
 export { AnalyticsController, getDefaultAnalyticsControllerState, } from "./AnalyticsController.cjs";
 export type { AnalyticsControllerOptions } from "./AnalyticsController.cjs";
 export { AnalyticsPlatformAdapterSetupError } from "./AnalyticsPlatformAdapterSetupError.cjs";
-export type { AnalyticsContext, AnalyticsEventProperties, AnalyticsDeliveryOptions, AnalyticsInvocationCallback, AnalyticsUserTraits, AnalyticsPlatformAdapter, AnalyticsTrackingEvent, } from "./AnalyticsPlatformAdapter.types.cjs";
+export type { AnalyticsContext, AnalyticsEventProperties, AnalyticsDeliveryOptions, AnalyticsInvocationCallback, AnalyticsLocationContext, AnalyticsLocationField, AnalyticsUserTraits, AnalyticsPlatformAdapter, AnalyticsTrackingEvent, } from "./AnalyticsPlatformAdapter.types.cjs";
 export type { AnalyticsControllerState, AnalyticsEventQueue, AnalyticsQueuedEvent, AnalyticsQueuedEventType, AnalyticsQueuedTrackEvent, AnalyticsQueuedIdentifyEvent, AnalyticsQueuedViewEvent, } from "./AnalyticsController.cjs";
 export { analyticsControllerSelectors } from "./selectors.cjs";
 export type { AnalyticsControllerMessenger } from "./AnalyticsController.cjs";

package/dist/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EACL,mBAAmB,EACnB,kCAAkC,GACnC,kCAAiC;AAClC,YAAY,EAAE,0BAA0B,EAAE,kCAAiC;AAG3E,OAAO,EAAE,kCAAkC,EAAE,iDAAgD;AAG7F,YAAY,EACV,gBAAgB,EAChB,wBAAwB,EACxB,wBAAwB,EACxB,2BAA2B,EAC3B,mBAAmB,EACnB,wBAAwB,EACxB,sBAAsB,GACvB,6CAAyC;AAG1C,YAAY,EACV,wBAAwB,EACxB,mBAAmB,EACnB,oBAAoB,EACpB,wBAAwB,EACxB,yBAAyB,EACzB,4BAA4B,EAC5B,wBAAwB,GACzB,kCAAiC;AAGlC,OAAO,EAAE,4BAA4B,EAAE,wBAAuB;AAG9D,YAAY,EAAE,4BAA4B,EAAE,kCAAiC;AAG7E,YAAY,EACV,0BAA0B,EAC1B,yBAAyB,EACzB,iCAAiC,EACjC,mCAAmC,GACpC,kCAAiC;AAClC,YAAY,EACV,mCAAmC,EACnC,iCAAiC,EACjC,kCAAkC,EAClC,8BAA8B,EAC9B,+BAA+B,EAC/B,6CAA6C,EAC7C,gCAAgC,GACjC,sDAAqD"}
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EACL,mBAAmB,EACnB,kCAAkC,GACnC,kCAAiC;AAClC,YAAY,EAAE,0BAA0B,EAAE,kCAAiC;AAG3E,OAAO,EAAE,kCAAkC,EAAE,iDAAgD;AAG7F,YAAY,EACV,gBAAgB,EAChB,wBAAwB,EACxB,wBAAwB,EACxB,2BAA2B,EAC3B,wBAAwB,EACxB,sBAAsB,EACtB,mBAAmB,EACnB,wBAAwB,EACxB,sBAAsB,GACvB,6CAAyC;AAG1C,YAAY,EACV,wBAAwB,EACxB,mBAAmB,EACnB,oBAAoB,EACpB,wBAAwB,EACxB,yBAAyB,EACzB,4BAA4B,EAC5B,wBAAwB,GACzB,kCAAiC;AAGlC,OAAO,EAAE,4BAA4B,EAAE,wBAAuB;AAG9D,YAAY,EAAE,4BAA4B,EAAE,kCAAiC;AAG7E,YAAY,EACV,0BAA0B,EAC1B,yBAAyB,EACzB,iCAAiC,EACjC,mCAAmC,GACpC,kCAAiC;AAClC,YAAY,EACV,mCAAmC,EACnC,iCAAiC,EACjC,kCAAkC,EAClC,8BAA8B,EAC9B,+BAA+B,EAC/B,6CAA6C,EAC7C,gCAAgC,GACjC,sDAAqD"}

package/dist/index.d.mts

@@ -1,7 +1,7 @@
 export { AnalyticsController, getDefaultAnalyticsControllerState, } from "./AnalyticsController.mjs";
 export type { AnalyticsControllerOptions } from "./AnalyticsController.mjs";
 export { AnalyticsPlatformAdapterSetupError } from "./AnalyticsPlatformAdapterSetupError.mjs";
-export type { AnalyticsContext, AnalyticsEventProperties, AnalyticsDeliveryOptions, AnalyticsInvocationCallback, AnalyticsUserTraits, AnalyticsPlatformAdapter, AnalyticsTrackingEvent, } from "./AnalyticsPlatformAdapter.types.mjs";
+export type { AnalyticsContext, AnalyticsEventProperties, AnalyticsDeliveryOptions, AnalyticsInvocationCallback, AnalyticsLocationContext, AnalyticsLocationField, AnalyticsUserTraits, AnalyticsPlatformAdapter, AnalyticsTrackingEvent, } from "./AnalyticsPlatformAdapter.types.mjs";
 export type { AnalyticsControllerState, AnalyticsEventQueue, AnalyticsQueuedEvent, AnalyticsQueuedEventType, AnalyticsQueuedTrackEvent, AnalyticsQueuedIdentifyEvent, AnalyticsQueuedViewEvent, } from "./AnalyticsController.mjs";
 export { analyticsControllerSelectors } from "./selectors.mjs";
 export type { AnalyticsControllerMessenger } from "./AnalyticsController.mjs";

package/dist/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EACL,mBAAmB,EACnB,kCAAkC,GACnC,kCAAiC;AAClC,YAAY,EAAE,0BAA0B,EAAE,kCAAiC;AAG3E,OAAO,EAAE,kCAAkC,EAAE,iDAAgD;AAG7F,YAAY,EACV,gBAAgB,EAChB,wBAAwB,EACxB,wBAAwB,EACxB,2BAA2B,EAC3B,mBAAmB,EACnB,wBAAwB,EACxB,sBAAsB,GACvB,6CAAyC;AAG1C,YAAY,EACV,wBAAwB,EACxB,mBAAmB,EACnB,oBAAoB,EACpB,wBAAwB,EACxB,yBAAyB,EACzB,4BAA4B,EAC5B,wBAAwB,GACzB,kCAAiC;AAGlC,OAAO,EAAE,4BAA4B,EAAE,wBAAuB;AAG9D,YAAY,EAAE,4BAA4B,EAAE,kCAAiC;AAG7E,YAAY,EACV,0BAA0B,EAC1B,yBAAyB,EACzB,iCAAiC,EACjC,mCAAmC,GACpC,kCAAiC;AAClC,YAAY,EACV,mCAAmC,EACnC,iCAAiC,EACjC,kCAAkC,EAClC,8BAA8B,EAC9B,+BAA+B,EAC/B,6CAA6C,EAC7C,gCAAgC,GACjC,sDAAqD"}
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EACL,mBAAmB,EACnB,kCAAkC,GACnC,kCAAiC;AAClC,YAAY,EAAE,0BAA0B,EAAE,kCAAiC;AAG3E,OAAO,EAAE,kCAAkC,EAAE,iDAAgD;AAG7F,YAAY,EACV,gBAAgB,EAChB,wBAAwB,EACxB,wBAAwB,EACxB,2BAA2B,EAC3B,wBAAwB,EACxB,sBAAsB,EACtB,mBAAmB,EACnB,wBAAwB,EACxB,sBAAsB,GACvB,6CAAyC;AAG1C,YAAY,EACV,wBAAwB,EACxB,mBAAmB,EACnB,oBAAoB,EACpB,wBAAwB,EACxB,yBAAyB,EACzB,4BAA4B,EAC5B,wBAAwB,GACzB,kCAAiC;AAGlC,OAAO,EAAE,4BAA4B,EAAE,wBAAuB;AAG9D,YAAY,EAAE,4BAA4B,EAAE,kCAAiC;AAG7E,YAAY,EACV,0BAA0B,EAC1B,yBAAyB,EACzB,iCAAiC,EACjC,mCAAmC,GACpC,kCAAiC;AAClC,YAAY,EACV,mCAAmC,EACnC,iCAAiC,EACjC,kCAAkC,EAClC,8BAA8B,EAC9B,+BAA+B,EAC/B,6CAA6C,EAC7C,gCAAgC,GACjC,sDAAqD"}

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,OAAO,EACL,mBAAmB,EACnB,kCAAkC,EACnC,kCAAiC;AAGlC,gBAAgB;AAChB,OAAO,EAAE,kCAAkC,EAAE,iDAAgD;AAwB7F,mBAAmB;AACnB,OAAO,EAAE,4BAA4B,EAAE,wBAAuB","sourcesContent":["// Export controller class and state utilities\nexport {\n  AnalyticsController,\n  getDefaultAnalyticsControllerState,\n} from './AnalyticsController.js';\nexport type { AnalyticsControllerOptions } from './AnalyticsController.js';\n\n// Export errors\nexport { AnalyticsPlatformAdapterSetupError } from './AnalyticsPlatformAdapterSetupError.js';\n\n// Export types\nexport type {\n  AnalyticsContext,\n  AnalyticsEventProperties,\n  AnalyticsDeliveryOptions,\n  AnalyticsInvocationCallback,\n  AnalyticsUserTraits,\n  AnalyticsPlatformAdapter,\n  AnalyticsTrackingEvent,\n} from './AnalyticsPlatformAdapter.types';\n\n// Export state types\nexport type {\n  AnalyticsControllerState,\n  AnalyticsEventQueue,\n  AnalyticsQueuedEvent,\n  AnalyticsQueuedEventType,\n  AnalyticsQueuedTrackEvent,\n  AnalyticsQueuedIdentifyEvent,\n  AnalyticsQueuedViewEvent,\n} from './AnalyticsController.js';\n\n// Export selectors\nexport { analyticsControllerSelectors } from './selectors.js';\n\n// Export messenger types\nexport type { AnalyticsControllerMessenger } from './AnalyticsController.js';\n\n// Export action and event types\nexport type {\n  AnalyticsControllerActions,\n  AnalyticsControllerEvents,\n  AnalyticsControllerGetStateAction,\n  AnalyticsControllerStateChangeEvent,\n} from './AnalyticsController.js';\nexport type {\n  AnalyticsControllerTrackEventAction,\n  AnalyticsControllerIdentifyAction,\n  AnalyticsControllerTrackViewAction,\n  AnalyticsControllerOptInAction,\n  AnalyticsControllerOptOutAction,\n  AnalyticsControllerResetConsentDecisionAction,\n  AnalyticsControllerMethodActions,\n} from './AnalyticsController-method-action-types.js';\n"]}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAC9C,OAAO,EACL,mBAAmB,EACnB,kCAAkC,EACnC,kCAAiC;AAGlC,gBAAgB;AAChB,OAAO,EAAE,kCAAkC,EAAE,iDAAgD;AA0B7F,mBAAmB;AACnB,OAAO,EAAE,4BAA4B,EAAE,wBAAuB","sourcesContent":["// Export controller class and state utilities\nexport {\n  AnalyticsController,\n  getDefaultAnalyticsControllerState,\n} from './AnalyticsController.js';\nexport type { AnalyticsControllerOptions } from './AnalyticsController.js';\n\n// Export errors\nexport { AnalyticsPlatformAdapterSetupError } from './AnalyticsPlatformAdapterSetupError.js';\n\n// Export types\nexport type {\n  AnalyticsContext,\n  AnalyticsEventProperties,\n  AnalyticsDeliveryOptions,\n  AnalyticsInvocationCallback,\n  AnalyticsLocationContext,\n  AnalyticsLocationField,\n  AnalyticsUserTraits,\n  AnalyticsPlatformAdapter,\n  AnalyticsTrackingEvent,\n} from './AnalyticsPlatformAdapter.types';\n\n// Export state types\nexport type {\n  AnalyticsControllerState,\n  AnalyticsEventQueue,\n  AnalyticsQueuedEvent,\n  AnalyticsQueuedEventType,\n  AnalyticsQueuedTrackEvent,\n  AnalyticsQueuedIdentifyEvent,\n  AnalyticsQueuedViewEvent,\n} from './AnalyticsController.js';\n\n// Export selectors\nexport { analyticsControllerSelectors } from './selectors.js';\n\n// Export messenger types\nexport type { AnalyticsControllerMessenger } from './AnalyticsController.js';\n\n// Export action and event types\nexport type {\n  AnalyticsControllerActions,\n  AnalyticsControllerEvents,\n  AnalyticsControllerGetStateAction,\n  AnalyticsControllerStateChangeEvent,\n} from './AnalyticsController.js';\nexport type {\n  AnalyticsControllerTrackEventAction,\n  AnalyticsControllerIdentifyAction,\n  AnalyticsControllerTrackViewAction,\n  AnalyticsControllerOptInAction,\n  AnalyticsControllerOptOutAction,\n  AnalyticsControllerResetConsentDecisionAction,\n  AnalyticsControllerMethodActions,\n} from './AnalyticsController-method-action-types.js';\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/analytics-controller",
-  "version": "1.2.1-preview-a1d0bbfa8",
+  "version": "1.2.1-preview-d77c814bb",
   "description": "Common Analytics controller for event tracking",
   "keywords": [
     "Ethereum",
@@ -56,6 +56,7 @@
   },
   "dependencies": {
     "@metamask/base-controller": "^9.1.0",
+    "@metamask/geolocation-controller": "^0.1.3",
     "@metamask/messenger": "^2.0.0",
     "@metamask/utils": "^11.11.0",
     "lodash": "^4.17.21",