@metamask-previews/analytics-controller 0.0.0-preview-b8454d32

package/dist/AnalyticsController.cjs

@@ -0,0 +1,205 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _AnalyticsController_platformAdapter;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AnalyticsController = exports.getDefaultAnalyticsControllerState = exports.controllerName = void 0;
+const base_controller_1 = require("@metamask/base-controller");
+const uuid_1 = require("uuid");
+const AnalyticsLogger_1 = require("./AnalyticsLogger.cjs");
+// === GENERAL ===
+/**
+ * The name of the {@link AnalyticsController}, used to namespace the
+ * controller's actions and events and to namespace the controller's state data
+ * when composed with other controllers.
+ */
+exports.controllerName = 'AnalyticsController';
+/**
+ * The metadata for each property in {@link AnalyticsControllerState}.
+ */
+const analyticsControllerMetadata = {
+    enabled: {
+        includeInStateLogs: true,
+        persist: true,
+        includeInDebugSnapshot: true,
+        usedInUi: true,
+    },
+    optedIn: {
+        includeInStateLogs: true,
+        persist: true,
+        includeInDebugSnapshot: true,
+        usedInUi: true,
+    },
+    analyticsId: {
+        includeInStateLogs: false,
+        persist: true,
+        includeInDebugSnapshot: false,
+        usedInUi: false,
+    },
+};
+/**
+ * Constructs the default {@link AnalyticsController} state. This allows
+ * consumers to provide a partial state object when initializing the controller
+ * and also helps in constructing complete state objects for this controller in
+ * tests.
+ *
+ * @returns The default {@link AnalyticsController} state.
+ */
+function getDefaultAnalyticsControllerState() {
+    return {
+        enabled: true,
+        optedIn: false,
+        analyticsId: (0, uuid_1.v4)(),
+    };
+}
+exports.getDefaultAnalyticsControllerState = getDefaultAnalyticsControllerState;
+// === MESSENGER ===
+const MESSENGER_EXPOSED_METHODS = [
+    'trackEvent',
+    'identify',
+    'trackPage',
+    'enable',
+    'disable',
+    'optIn',
+    'optOut',
+];
+/**
+ * The AnalyticsController manages analytics tracking across platforms (Mobile/Extension).
+ * It provides a unified interface for tracking events, identifying users, and managing
+ * analytics preferences while delegating platform-specific implementation to an
+ * {@link AnalyticsPlatformAdapter}.
+ *
+ * This controller follows the MetaMask controller pattern and integrates with the
+ * messenger system to allow other controllers and components to track analytics events.
+ * It delegates platform-specific implementation to an {@link AnalyticsPlatformAdapter}.
+ */
+class AnalyticsController extends base_controller_1.BaseController {
+    /**
+     * Constructs an AnalyticsController instance.
+     *
+     * @param options - Controller options
+     * @param options.state - Initial controller state (defaults from getDefaultAnalyticsControllerState)
+     * @param options.messenger - Messenger used to communicate with BaseController
+     * @param options.platformAdapter - Platform adapter implementation for tracking
+     */
+    constructor({ state = {}, messenger, platformAdapter, }) {
+        const defaultState = getDefaultAnalyticsControllerState();
+        // Use analyticsId from state if provided, otherwise use the one from defaultState
+        const analyticsId = state.analyticsId !== undefined
+            ? state.analyticsId
+            : defaultState.analyticsId;
+        const mergedState = {
+            ...defaultState,
+            ...state,
+            analyticsId,
+        };
+        super({
+            name: exports.controllerName,
+            metadata: analyticsControllerMetadata,
+            state: mergedState,
+            messenger,
+        });
+        _AnalyticsController_platformAdapter.set(this, void 0);
+        __classPrivateFieldSet(this, _AnalyticsController_platformAdapter, platformAdapter, "f");
+        this.messenger.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
+        (0, AnalyticsLogger_1.projectLogger)('AnalyticsController initialized and ready', {
+            enabled: this.state.enabled,
+            optedIn: this.state.optedIn,
+            analyticsId: this.state.analyticsId,
+        });
+    }
+    /**
+     * Track an analytics event.
+     *
+     * Events are only tracked if analytics is enabled.
+     *
+     * @param eventName - The name of the event
+     * @param properties - Event properties
+     */
+    trackEvent(eventName, properties = {}) {
+        // Don't track if analytics is disabled
+        if (!this.state.enabled) {
+            return;
+        }
+        // Delegate to platform adapter
+        __classPrivateFieldGet(this, _AnalyticsController_platformAdapter, "f").trackEvent(eventName, properties);
+    }
+    /**
+     * Identify a user for analytics.
+     *
+     * @param userId - The user identifier (e.g., metametrics ID)
+     * @param traits - User traits/properties
+     */
+    identify(userId, traits) {
+        if (!this.state.enabled) {
+            return;
+        }
+        // Update state with analytics ID
+        this.update((state) => {
+            state.analyticsId = userId;
+        });
+        // Delegate to platform adapter if supported
+        if (__classPrivateFieldGet(this, _AnalyticsController_platformAdapter, "f").identify) {
+            __classPrivateFieldGet(this, _AnalyticsController_platformAdapter, "f").identify(userId, traits);
+        }
+    }
+    /**
+     * Track a page view.
+     *
+     * @param pageName - The name of the page
+     * @param properties - Page properties
+     */
+    trackPage(pageName, properties) {
+        if (!this.state.enabled) {
+            return;
+        }
+        // Delegate to platform adapter if supported
+        if (__classPrivateFieldGet(this, _AnalyticsController_platformAdapter, "f").trackPage) {
+            __classPrivateFieldGet(this, _AnalyticsController_platformAdapter, "f").trackPage(pageName, properties);
+        }
+    }
+    /**
+     * Enable analytics tracking.
+     */
+    enable() {
+        this.update((state) => {
+            state.enabled = true;
+        });
+    }
+    /**
+     * Disable analytics tracking.
+     */
+    disable() {
+        this.update((state) => {
+            state.enabled = false;
+        });
+    }
+    /**
+     * Opt in to analytics.
+     */
+    optIn() {
+        this.update((state) => {
+            state.optedIn = true;
+        });
+    }
+    /**
+     * Opt out of analytics.
+     */
+    optOut() {
+        this.update((state) => {
+            state.optedIn = false;
+        });
+    }
+}
+exports.AnalyticsController = AnalyticsController;
+_AnalyticsController_platformAdapter = new WeakMap();
+//# sourceMappingURL=AnalyticsController.cjs.map

package/dist/AnalyticsController.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"AnalyticsController.cjs","sourceRoot":"","sources":["../src/AnalyticsController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAKA,+DAA2D;AAE3D,+BAAoC;AAGpC,2DAAkD;AAMlD,kBAAkB;AAElB;;;;GAIG;AACU,QAAA,cAAc,GAAG,qBAAqB,CAAC;AAwBpD;;GAEG;AACH,MAAM,2BAA2B,GAAG;IAClC,OAAO,EAAE;QACP,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,IAAI;QAC5B,QAAQ,EAAE,IAAI;KACf;IACD,OAAO,EAAE;QACP,kBAAkB,EAAE,IAAI;QACxB,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,IAAI;QAC5B,QAAQ,EAAE,IAAI;KACf;IACD,WAAW,EAAE;QACX,kBAAkB,EAAE,KAAK;QACzB,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,KAAK;QAC7B,QAAQ,EAAE,KAAK;KAChB;CACgD,CAAC;AAEpD;;;;;;;GAOG;AACH,SAAgB,kCAAkC;IAChD,OAAO;QACL,OAAO,EAAE,IAAI;QACb,OAAO,EAAE,KAAK;QACd,WAAW,EAAE,IAAA,SAAM,GAAE;KACtB,CAAC;AACJ,CAAC;AAND,gFAMC;AAED,oBAAoB;AAEpB,MAAM,yBAAyB,GAAG;IAChC,YAAY;IACZ,UAAU;IACV,WAAW;IACX,QAAQ;IACR,SAAS;IACT,OAAO;IACP,QAAQ;CACA,CAAC;AAgEX;;;;;;;;;GASG;AACH,MAAa,mBAAoB,SAAQ,gCAIxC;IAGC;;;;;;;OAOG;IACH,YAAY,EACV,KAAK,GAAG,EAAE,EACV,SAAS,EACT,eAAe,GACY;QAC3B,MAAM,YAAY,GAAG,kCAAkC,EAAE,CAAC;QAC1D,kFAAkF;QAClF,MAAM,WAAW,GACf,KAAK,CAAC,WAAW,KAAK,SAAS;YAC7B,CAAC,CAAC,KAAK,CAAC,WAAW;YACnB,CAAC,CAAC,YAAY,CAAC,WAAW,CAAC;QAC/B,MAAM,WAAW,GAA6B;YAC5C,GAAG,YAAY;YACf,GAAG,KAAK;YACR,WAAW;SACZ,CAAC;QAEF,KAAK,CAAC;YACJ,IAAI,EAAE,sBAAc;YACpB,QAAQ,EAAE,2BAA2B;YACrC,KAAK,EAAE,WAAW;YAClB,SAAS;SACV,CAAC,CAAC;QAhCI,uDAA2C;QAkClD,uBAAA,IAAI,wCAAoB,eAAe,MAAA,CAAC;QAExC,IAAI,CAAC,SAAS,CAAC,4BAA4B,CACzC,IAAI,EACJ,yBAAyB,CAC1B,CAAC;QAEF,IAAA,+BAAa,EAAC,2CAA2C,EAAE;YACzD,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO;YAC3B,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO;YAC3B,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,WAAW;SACpC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,UAAU,CACR,SAAiB,EACjB,aAAuC,EAAE;QAEzC,uCAAuC;QACvC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE;YACvB,OAAO;SACR;QAED,+BAA+B;QAC/B,uBAAA,IAAI,4CAAiB,CAAC,UAAU,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;OAKG;IACH,QAAQ,CAAC,MAAc,EAAE,MAAiC;QACxD,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE;YACvB,OAAO;SACR;QAED,iCAAiC;QACjC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,WAAW,GAAG,MAAM,CAAC;QAC7B,CAAC,CAAC,CAAC;QAEH,4CAA4C;QAC5C,IAAI,uBAAA,IAAI,4CAAiB,CAAC,QAAQ,EAAE;YAClC,uBAAA,IAAI,4CAAiB,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;SAChD;IACH,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAC,QAAgB,EAAE,UAAqC;QAC/D,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE;YACvB,OAAO;SACR;QAED,4CAA4C;QAC5C,IAAI,uBAAA,IAAI,4CAAiB,CAAC,SAAS,EAAE;YACnC,uBAAA,IAAI,4CAAiB,CAAC,SAAS,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;SACvD;IACH,CAAC;IAED;;OAEG;IACH,MAAM;QACJ,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC;QACvB,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,OAAO;QACL,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,OAAO,GAAG,KAAK,CAAC;QACxB,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK;QACH,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC;QACvB,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,MAAM;QACJ,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,OAAO,GAAG,KAAK,CAAC;QACxB,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AApJD,kDAoJC","sourcesContent":["import type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n  StateMetadata,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport type { Messenger } from '@metamask/messenger';\nimport { v4 as uuidv4 } from 'uuid';\n\nimport type { AnalyticsControllerMethodActions } from './AnalyticsController-method-action-types';\nimport { projectLogger } from './AnalyticsLogger';\nimport type {\n  AnalyticsPlatformAdapter,\n  AnalyticsEventProperties,\n} from './AnalyticsPlatformAdapter.types';\n\n// === GENERAL ===\n\n/**\n * The name of the {@link AnalyticsController}, used to namespace the\n * controller's actions and events and to namespace the controller's state data\n * when composed with other controllers.\n */\nexport const controllerName = 'AnalyticsController';\n\n// === STATE ===\n\n/**\n * Describes the shape of the state object for {@link AnalyticsController}.\n */\nexport type AnalyticsControllerState = {\n  /**\n   * Whether analytics tracking is enabled\n   */\n  enabled: boolean;\n\n  /**\n   * Whether the user has opted in to analytics\n   */\n  optedIn: boolean;\n\n  /**\n   * User's UUIDv4 analytics identifier\n   */\n  analyticsId: string;\n};\n\n/**\n * The metadata for each property in {@link AnalyticsControllerState}.\n */\nconst analyticsControllerMetadata = {\n  enabled: {\n    includeInStateLogs: true,\n    persist: true,\n    includeInDebugSnapshot: true,\n    usedInUi: true,\n  },\n  optedIn: {\n    includeInStateLogs: true,\n    persist: true,\n    includeInDebugSnapshot: true,\n    usedInUi: true,\n  },\n  analyticsId: {\n    includeInStateLogs: false,\n    persist: true,\n    includeInDebugSnapshot: false,\n    usedInUi: false,\n  },\n} satisfies StateMetadata<AnalyticsControllerState>;\n\n/**\n * Constructs the default {@link AnalyticsController} state. This allows\n * consumers to provide a partial state object when initializing the controller\n * and also helps in constructing complete state objects for this controller in\n * tests.\n *\n * @returns The default {@link AnalyticsController} state.\n */\nexport function getDefaultAnalyticsControllerState(): AnalyticsControllerState {\n  return {\n    enabled: true,\n    optedIn: false,\n    analyticsId: uuidv4(),\n  };\n}\n\n// === MESSENGER ===\n\nconst MESSENGER_EXPOSED_METHODS = [\n  'trackEvent',\n  'identify',\n  'trackPage',\n  'enable',\n  'disable',\n  'optIn',\n  'optOut',\n] as const;\n\n/**\n * Returns the state of the {@link AnalyticsController}.\n */\nexport type AnalyticsControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  AnalyticsControllerState\n>;\n\n/**\n * Actions that {@link AnalyticsControllerMessenger} exposes to other consumers.\n */\nexport type AnalyticsControllerActions =\n  | AnalyticsControllerGetStateAction\n  | AnalyticsControllerMethodActions;\n\n/**\n * Actions from other messengers that {@link AnalyticsControllerMessenger} calls.\n */\ntype AllowedActions = never;\n\n/**\n * Event emitted when the state of the {@link AnalyticsController} changes.\n */\nexport type AnalyticsControllerStateChangeEvent = ControllerStateChangeEvent<\n  typeof controllerName,\n  AnalyticsControllerState\n>;\n\n/**\n * Events that {@link AnalyticsControllerMessenger} exposes to other consumers.\n */\nexport type AnalyticsControllerEvents = AnalyticsControllerStateChangeEvent;\n\n/**\n * Events from other messengers that {@link AnalyticsControllerMessenger} subscribes to.\n */\ntype AllowedEvents = never;\n\n/**\n * The messenger restricted to actions and events accessed by\n * {@link AnalyticsController}.\n */\nexport type AnalyticsControllerMessenger = Messenger<\n  typeof controllerName,\n  AnalyticsControllerActions | AllowedActions,\n  AnalyticsControllerEvents | AllowedEvents\n>;\n\n// === CONTROLLER DEFINITION ===\n\n/**\n * The options that AnalyticsController takes.\n */\nexport type AnalyticsControllerOptions = {\n  state?: Partial<AnalyticsControllerState>;\n  messenger: AnalyticsControllerMessenger;\n  /**\n   * Platform adapter implementation for tracking events\n   */\n  platformAdapter: AnalyticsPlatformAdapter;\n};\n\n/**\n * The AnalyticsController manages analytics tracking across platforms (Mobile/Extension).\n * It provides a unified interface for tracking events, identifying users, and managing\n * analytics preferences while delegating platform-specific implementation to an\n * {@link AnalyticsPlatformAdapter}.\n *\n * This controller follows the MetaMask controller pattern and integrates with the\n * messenger system to allow other controllers and components to track analytics events.\n * It delegates platform-specific implementation to an {@link AnalyticsPlatformAdapter}.\n */\nexport class AnalyticsController extends BaseController<\n  'AnalyticsController',\n  AnalyticsControllerState,\n  AnalyticsControllerMessenger\n> {\n  readonly #platformAdapter: AnalyticsPlatformAdapter;\n\n  /**\n   * Constructs an AnalyticsController instance.\n   *\n   * @param options - Controller options\n   * @param options.state - Initial controller state (defaults from getDefaultAnalyticsControllerState)\n   * @param options.messenger - Messenger used to communicate with BaseController\n   * @param options.platformAdapter - Platform adapter implementation for tracking\n   */\n  constructor({\n    state = {},\n    messenger,\n    platformAdapter,\n  }: AnalyticsControllerOptions) {\n    const defaultState = getDefaultAnalyticsControllerState();\n    // Use analyticsId from state if provided, otherwise use the one from defaultState\n    const analyticsId: string =\n      state.analyticsId !== undefined\n        ? state.analyticsId\n        : defaultState.analyticsId;\n    const mergedState: AnalyticsControllerState = {\n      ...defaultState,\n      ...state,\n      analyticsId,\n    };\n\n    super({\n      name: controllerName,\n      metadata: analyticsControllerMetadata,\n      state: mergedState,\n      messenger,\n    });\n\n    this.#platformAdapter = platformAdapter;\n\n    this.messenger.registerMethodActionHandlers(\n      this,\n      MESSENGER_EXPOSED_METHODS,\n    );\n\n    projectLogger('AnalyticsController initialized and ready', {\n      enabled: this.state.enabled,\n      optedIn: this.state.optedIn,\n      analyticsId: this.state.analyticsId,\n    });\n  }\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   */\n  trackEvent(\n    eventName: string,\n    properties: AnalyticsEventProperties = {},\n  ): void {\n    // Don't track if analytics is disabled\n    if (!this.state.enabled) {\n      return;\n    }\n\n    // Delegate to platform adapter\n    this.#platformAdapter.trackEvent(eventName, properties);\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   */\n  identify(userId: string, traits?: AnalyticsEventProperties): void {\n    if (!this.state.enabled) {\n      return;\n    }\n\n    // Update state with analytics ID\n    this.update((state) => {\n      state.analyticsId = userId;\n    });\n\n    // Delegate to platform adapter if supported\n    if (this.#platformAdapter.identify) {\n      this.#platformAdapter.identify(userId, traits);\n    }\n  }\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    if (!this.state.enabled) {\n      return;\n    }\n\n    // Delegate to platform adapter if supported\n    if (this.#platformAdapter.trackPage) {\n      this.#platformAdapter.trackPage(pageName, properties);\n    }\n  }\n\n  /**\n   * Enable analytics tracking.\n   */\n  enable(): void {\n    this.update((state) => {\n      state.enabled = true;\n    });\n  }\n\n  /**\n   * Disable analytics tracking.\n   */\n  disable(): void {\n    this.update((state) => {\n      state.enabled = false;\n    });\n  }\n\n  /**\n   * Opt in to analytics.\n   */\n  optIn(): void {\n    this.update((state) => {\n      state.optedIn = true;\n    });\n  }\n\n  /**\n   * Opt out of analytics.\n   */\n  optOut(): void {\n    this.update((state) => {\n      state.optedIn = false;\n    });\n  }\n}\n"]}

package/dist/AnalyticsController.d.cts

@@ -0,0 +1,140 @@
+import type { ControllerGetStateAction, ControllerStateChangeEvent } from "@metamask/base-controller";
+import { BaseController } from "@metamask/base-controller";
+import type { Messenger } from "@metamask/messenger";
+import type { AnalyticsControllerMethodActions } from "./AnalyticsController-method-action-types.cjs";
+import type { AnalyticsPlatformAdapter, AnalyticsEventProperties } from "./AnalyticsPlatformAdapter.types.cjs";
+/**
+ * The name of the {@link AnalyticsController}, used to namespace the
+ * controller's actions and events and to namespace the controller's state data
+ * when composed with other controllers.
+ */
+export declare const controllerName = "AnalyticsController";
+/**
+ * Describes the shape of the state object for {@link AnalyticsController}.
+ */
+export type AnalyticsControllerState = {
+    /**
+     * Whether analytics tracking is enabled
+     */
+    enabled: boolean;
+    /**
+     * Whether the user has opted in to analytics
+     */
+    optedIn: boolean;
+    /**
+     * User's UUIDv4 analytics identifier
+     */
+    analyticsId: string;
+};
+/**
+ * Constructs the default {@link AnalyticsController} state. This allows
+ * consumers to provide a partial state object when initializing the controller
+ * and also helps in constructing complete state objects for this controller in
+ * tests.
+ *
+ * @returns The default {@link AnalyticsController} state.
+ */
+export declare function getDefaultAnalyticsControllerState(): AnalyticsControllerState;
+/**
+ * Returns the state of the {@link AnalyticsController}.
+ */
+export type AnalyticsControllerGetStateAction = ControllerGetStateAction<typeof controllerName, AnalyticsControllerState>;
+/**
+ * Actions that {@link AnalyticsControllerMessenger} exposes to other consumers.
+ */
+export type AnalyticsControllerActions = AnalyticsControllerGetStateAction | AnalyticsControllerMethodActions;
+/**
+ * Actions from other messengers that {@link AnalyticsControllerMessenger} calls.
+ */
+type AllowedActions = never;
+/**
+ * Event emitted when the state of the {@link AnalyticsController} changes.
+ */
+export type AnalyticsControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, AnalyticsControllerState>;
+/**
+ * Events that {@link AnalyticsControllerMessenger} exposes to other consumers.
+ */
+export type AnalyticsControllerEvents = AnalyticsControllerStateChangeEvent;
+/**
+ * Events from other messengers that {@link AnalyticsControllerMessenger} subscribes to.
+ */
+type AllowedEvents = never;
+/**
+ * The messenger restricted to actions and events accessed by
+ * {@link AnalyticsController}.
+ */
+export type AnalyticsControllerMessenger = Messenger<typeof controllerName, AnalyticsControllerActions | AllowedActions, AnalyticsControllerEvents | AllowedEvents>;
+/**
+ * The options that AnalyticsController takes.
+ */
+export type AnalyticsControllerOptions = {
+    state?: Partial<AnalyticsControllerState>;
+    messenger: AnalyticsControllerMessenger;
+    /**
+     * Platform adapter implementation for tracking events
+     */
+    platformAdapter: AnalyticsPlatformAdapter;
+};
+/**
+ * The AnalyticsController manages analytics tracking across platforms (Mobile/Extension).
+ * It provides a unified interface for tracking events, identifying users, and managing
+ * analytics preferences while delegating platform-specific implementation to an
+ * {@link AnalyticsPlatformAdapter}.
+ *
+ * This controller follows the MetaMask controller pattern and integrates with the
+ * messenger system to allow other controllers and components to track analytics events.
+ * It delegates platform-specific implementation to an {@link AnalyticsPlatformAdapter}.
+ */
+export declare class AnalyticsController extends BaseController<'AnalyticsController', AnalyticsControllerState, AnalyticsControllerMessenger> {
+    #private;
+    /**
+     * Constructs an AnalyticsController instance.
+     *
+     * @param options - Controller options
+     * @param options.state - Initial controller state (defaults from getDefaultAnalyticsControllerState)
+     * @param options.messenger - Messenger used to communicate with BaseController
+     * @param options.platformAdapter - Platform adapter implementation for tracking
+     */
+    constructor({ state, messenger, platformAdapter, }: AnalyticsControllerOptions);
+    /**
+     * Track an analytics event.
+     *
+     * Events are only tracked if analytics is enabled.
+     *
+     * @param eventName - The name of the event
+     * @param properties - Event properties
+     */
+    trackEvent(eventName: string, properties?: AnalyticsEventProperties): void;
+    /**
+     * Identify a user for analytics.
+     *
+     * @param userId - The user identifier (e.g., metametrics ID)
+     * @param traits - User traits/properties
+     */
+    identify(userId: string, traits?: AnalyticsEventProperties): void;
+    /**
+     * Track a page view.
+     *
+     * @param pageName - The name of the page
+     * @param properties - Page properties
+     */
+    trackPage(pageName: string, properties?: AnalyticsEventProperties): void;
+    /**
+     * Enable analytics tracking.
+     */
+    enable(): void;
+    /**
+     * Disable analytics tracking.
+     */
+    disable(): void;
+    /**
+     * Opt in to analytics.
+     */
+    optIn(): void;
+    /**
+     * Opt out of analytics.
+     */
+    optOut(): void;
+}
+export {};
+//# sourceMappingURL=AnalyticsController.d.cts.map

package/dist/AnalyticsController.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AnalyticsController.d.cts","sourceRoot":"","sources":["../src/AnalyticsController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAE3B,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AAGrD,OAAO,KAAK,EAAE,gCAAgC,EAAE,sDAAkD;AAElG,OAAO,KAAK,EACV,wBAAwB,EACxB,wBAAwB,EACzB,6CAAyC;AAI1C;;;;GAIG;AACH,eAAO,MAAM,cAAc,wBAAwB,CAAC;AAIpD;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AA0BF;;;;;;;GAOG;AACH,wBAAgB,kCAAkC,IAAI,wBAAwB,CAM7E;AAcD;;GAEG;AACH,MAAM,MAAM,iCAAiC,GAAG,wBAAwB,CACtE,OAAO,cAAc,EACrB,wBAAwB,CACzB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAClC,iCAAiC,GACjC,gCAAgC,CAAC;AAErC;;GAEG;AACH,KAAK,cAAc,GAAG,KAAK,CAAC;AAE5B;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAAG,0BAA0B,CAC1E,OAAO,cAAc,EACrB,wBAAwB,CACzB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,mCAAmC,CAAC;AAE5E;;GAEG;AACH,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,4BAA4B,GAAG,SAAS,CAClD,OAAO,cAAc,EACrB,0BAA0B,GAAG,cAAc,EAC3C,yBAAyB,GAAG,aAAa,CAC1C,CAAC;AAIF;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC,KAAK,CAAC,EAAE,OAAO,CAAC,wBAAwB,CAAC,CAAC;IAC1C,SAAS,EAAE,4BAA4B,CAAC;IACxC;;OAEG;IACH,eAAe,EAAE,wBAAwB,CAAC;CAC3C,CAAC;AAEF;;;;;;;;;GASG;AACH,qBAAa,mBAAoB,SAAQ,cAAc,CACrD,qBAAqB,EACrB,wBAAwB,EACxB,4BAA4B,CAC7B;;IAGC;;;;;;;OAOG;gBACS,EACV,KAAU,EACV,SAAS,EACT,eAAe,GAChB,EAAE,0BAA0B;IAkC7B;;;;;;;OAOG;IACH,UAAU,CACR,SAAS,EAAE,MAAM,EACjB,UAAU,GAAE,wBAA6B,GACxC,IAAI;IAUP;;;;;OAKG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,wBAAwB,GAAG,IAAI;IAgBjE;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,wBAAwB,GAAG,IAAI;IAWxE;;OAEG;IACH,MAAM,IAAI,IAAI;IAMd;;OAEG;IACH,OAAO,IAAI,IAAI;IAMf;;OAEG;IACH,KAAK,IAAI,IAAI;IAMb;;OAEG;IACH,MAAM,IAAI,IAAI;CAKf"}

package/dist/AnalyticsController.d.mts

@@ -0,0 +1,140 @@
+import type { ControllerGetStateAction, ControllerStateChangeEvent } from "@metamask/base-controller";
+import { BaseController } from "@metamask/base-controller";
+import type { Messenger } from "@metamask/messenger";
+import type { AnalyticsControllerMethodActions } from "./AnalyticsController-method-action-types.mjs";
+import type { AnalyticsPlatformAdapter, AnalyticsEventProperties } from "./AnalyticsPlatformAdapter.types.mjs";
+/**
+ * The name of the {@link AnalyticsController}, used to namespace the
+ * controller's actions and events and to namespace the controller's state data
+ * when composed with other controllers.
+ */
+export declare const controllerName = "AnalyticsController";
+/**
+ * Describes the shape of the state object for {@link AnalyticsController}.
+ */
+export type AnalyticsControllerState = {
+    /**
+     * Whether analytics tracking is enabled
+     */
+    enabled: boolean;
+    /**
+     * Whether the user has opted in to analytics
+     */
+    optedIn: boolean;
+    /**
+     * User's UUIDv4 analytics identifier
+     */
+    analyticsId: string;
+};
+/**
+ * Constructs the default {@link AnalyticsController} state. This allows
+ * consumers to provide a partial state object when initializing the controller
+ * and also helps in constructing complete state objects for this controller in
+ * tests.
+ *
+ * @returns The default {@link AnalyticsController} state.
+ */
+export declare function getDefaultAnalyticsControllerState(): AnalyticsControllerState;
+/**
+ * Returns the state of the {@link AnalyticsController}.
+ */
+export type AnalyticsControllerGetStateAction = ControllerGetStateAction<typeof controllerName, AnalyticsControllerState>;
+/**
+ * Actions that {@link AnalyticsControllerMessenger} exposes to other consumers.
+ */
+export type AnalyticsControllerActions = AnalyticsControllerGetStateAction | AnalyticsControllerMethodActions;
+/**
+ * Actions from other messengers that {@link AnalyticsControllerMessenger} calls.
+ */
+type AllowedActions = never;
+/**
+ * Event emitted when the state of the {@link AnalyticsController} changes.
+ */
+export type AnalyticsControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, AnalyticsControllerState>;
+/**
+ * Events that {@link AnalyticsControllerMessenger} exposes to other consumers.
+ */
+export type AnalyticsControllerEvents = AnalyticsControllerStateChangeEvent;
+/**
+ * Events from other messengers that {@link AnalyticsControllerMessenger} subscribes to.
+ */
+type AllowedEvents = never;
+/**
+ * The messenger restricted to actions and events accessed by
+ * {@link AnalyticsController}.
+ */
+export type AnalyticsControllerMessenger = Messenger<typeof controllerName, AnalyticsControllerActions | AllowedActions, AnalyticsControllerEvents | AllowedEvents>;
+/**
+ * The options that AnalyticsController takes.
+ */
+export type AnalyticsControllerOptions = {
+    state?: Partial<AnalyticsControllerState>;
+    messenger: AnalyticsControllerMessenger;
+    /**
+     * Platform adapter implementation for tracking events
+     */
+    platformAdapter: AnalyticsPlatformAdapter;
+};
+/**
+ * The AnalyticsController manages analytics tracking across platforms (Mobile/Extension).
+ * It provides a unified interface for tracking events, identifying users, and managing
+ * analytics preferences while delegating platform-specific implementation to an
+ * {@link AnalyticsPlatformAdapter}.
+ *
+ * This controller follows the MetaMask controller pattern and integrates with the
+ * messenger system to allow other controllers and components to track analytics events.
+ * It delegates platform-specific implementation to an {@link AnalyticsPlatformAdapter}.
+ */
+export declare class AnalyticsController extends BaseController<'AnalyticsController', AnalyticsControllerState, AnalyticsControllerMessenger> {
+    #private;
+    /**
+     * Constructs an AnalyticsController instance.
+     *
+     * @param options - Controller options
+     * @param options.state - Initial controller state (defaults from getDefaultAnalyticsControllerState)
+     * @param options.messenger - Messenger used to communicate with BaseController
+     * @param options.platformAdapter - Platform adapter implementation for tracking
+     */
+    constructor({ state, messenger, platformAdapter, }: AnalyticsControllerOptions);
+    /**
+     * Track an analytics event.
+     *
+     * Events are only tracked if analytics is enabled.
+     *
+     * @param eventName - The name of the event
+     * @param properties - Event properties
+     */
+    trackEvent(eventName: string, properties?: AnalyticsEventProperties): void;
+    /**
+     * Identify a user for analytics.
+     *
+     * @param userId - The user identifier (e.g., metametrics ID)
+     * @param traits - User traits/properties
+     */
+    identify(userId: string, traits?: AnalyticsEventProperties): void;
+    /**
+     * Track a page view.
+     *
+     * @param pageName - The name of the page
+     * @param properties - Page properties
+     */
+    trackPage(pageName: string, properties?: AnalyticsEventProperties): void;
+    /**
+     * Enable analytics tracking.
+     */
+    enable(): void;
+    /**
+     * Disable analytics tracking.
+     */
+    disable(): void;
+    /**
+     * Opt in to analytics.
+     */
+    optIn(): void;
+    /**
+     * Opt out of analytics.
+     */
+    optOut(): void;
+}
+export {};
+//# sourceMappingURL=AnalyticsController.d.mts.map

package/dist/AnalyticsController.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AnalyticsController.d.mts","sourceRoot":"","sources":["../src/AnalyticsController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAE3B,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AAGrD,OAAO,KAAK,EAAE,gCAAgC,EAAE,sDAAkD;AAElG,OAAO,KAAK,EACV,wBAAwB,EACxB,wBAAwB,EACzB,6CAAyC;AAI1C;;;;GAIG;AACH,eAAO,MAAM,cAAc,wBAAwB,CAAC;AAIpD;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AA0BF;;;;;;;GAOG;AACH,wBAAgB,kCAAkC,IAAI,wBAAwB,CAM7E;AAcD;;GAEG;AACH,MAAM,MAAM,iCAAiC,GAAG,wBAAwB,CACtE,OAAO,cAAc,EACrB,wBAAwB,CACzB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAClC,iCAAiC,GACjC,gCAAgC,CAAC;AAErC;;GAEG;AACH,KAAK,cAAc,GAAG,KAAK,CAAC;AAE5B;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAAG,0BAA0B,CAC1E,OAAO,cAAc,EACrB,wBAAwB,CACzB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,mCAAmC,CAAC;AAE5E;;GAEG;AACH,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,4BAA4B,GAAG,SAAS,CAClD,OAAO,cAAc,EACrB,0BAA0B,GAAG,cAAc,EAC3C,yBAAyB,GAAG,aAAa,CAC1C,CAAC;AAIF;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC,KAAK,CAAC,EAAE,OAAO,CAAC,wBAAwB,CAAC,CAAC;IAC1C,SAAS,EAAE,4BAA4B,CAAC;IACxC;;OAEG;IACH,eAAe,EAAE,wBAAwB,CAAC;CAC3C,CAAC;AAEF;;;;;;;;;GASG;AACH,qBAAa,mBAAoB,SAAQ,cAAc,CACrD,qBAAqB,EACrB,wBAAwB,EACxB,4BAA4B,CAC7B;;IAGC;;;;;;;OAOG;gBACS,EACV,KAAU,EACV,SAAS,EACT,eAAe,GAChB,EAAE,0BAA0B;IAkC7B;;;;;;;OAOG;IACH,UAAU,CACR,SAAS,EAAE,MAAM,EACjB,UAAU,GAAE,wBAA6B,GACxC,IAAI;IAUP;;;;;OAKG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,wBAAwB,GAAG,IAAI;IAgBjE;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,wBAAwB,GAAG,IAAI;IAWxE;;OAEG;IACH,MAAM,IAAI,IAAI;IAMd;;OAEG;IACH,OAAO,IAAI,IAAI;IAMf;;OAEG;IACH,KAAK,IAAI,IAAI;IAMb;;OAEG;IACH,MAAM,IAAI,IAAI;CAKf"}