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

package/dist/AnalyticsController.mjs

@@ -0,0 +1,200 @@
+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;
+import { BaseController } from "@metamask/base-controller";
+import { v4 as uuidv4 } from "uuid";
+import { projectLogger } from "./AnalyticsLogger.mjs";
+// === 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.
+ */
+export const 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.
+ */
+export function getDefaultAnalyticsControllerState() {
+    return {
+        enabled: true,
+        optedIn: false,
+        analyticsId: uuidv4(),
+    };
+}
+// === 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}.
+ */
+export class AnalyticsController extends 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: 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);
+        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;
+        });
+    }
+}
+_AnalyticsController_platformAdapter = new WeakMap();
+//# sourceMappingURL=AnalyticsController.mjs.map

package/dist/AnalyticsController.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"AnalyticsController.mjs","sourceRoot":"","sources":["../src/AnalyticsController.ts"],"names":[],"mappings":";;;;;;;;;;;;AAKA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAE3D,OAAO,EAAE,EAAE,IAAI,MAAM,EAAE,aAAa;AAGpC,OAAO,EAAE,aAAa,EAAE,8BAA0B;AAMlD,kBAAkB;AAElB;;;;GAIG;AACH,MAAM,CAAC,MAAM,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,MAAM,UAAU,kCAAkC;IAChD,OAAO;QACL,OAAO,EAAE,IAAI;QACb,OAAO,EAAE,KAAK;QACd,WAAW,EAAE,MAAM,EAAE;KACtB,CAAC;AACJ,CAAC;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,MAAM,OAAO,mBAAoB,SAAQ,cAIxC;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,cAAc;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,aAAa,CAAC,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","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/AnalyticsLogger.cjs

@@ -0,0 +1,8 @@
+"use strict";
+/* istanbul ignore file */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createModuleLogger = exports.projectLogger = void 0;
+const utils_1 = require("@metamask/utils");
+Object.defineProperty(exports, "createModuleLogger", { enumerable: true, get: function () { return utils_1.createModuleLogger; } });
+exports.projectLogger = (0, utils_1.createProjectLogger)('analytics-controller');
+//# sourceMappingURL=AnalyticsLogger.cjs.map

package/dist/AnalyticsLogger.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"AnalyticsLogger.cjs","sourceRoot":"","sources":["../src/AnalyticsLogger.ts"],"names":[],"mappings":";AAAA,0BAA0B;;;AAE1B,2CAA0E;AAIjE,mGAJqB,0BAAkB,OAIrB;AAFd,QAAA,aAAa,GAAG,IAAA,2BAAmB,EAAC,sBAAsB,CAAC,CAAC","sourcesContent":["/* istanbul ignore file */\n\nimport { createProjectLogger, createModuleLogger } from '@metamask/utils';\n\nexport const projectLogger = createProjectLogger('analytics-controller');\n\nexport { createModuleLogger };\n"]}

package/dist/AnalyticsLogger.d.cts

@@ -0,0 +1,5 @@
+/// <reference types="debug" />
+import { createModuleLogger } from "@metamask/utils";
+export declare const projectLogger: import("debug").Debugger;
+export { createModuleLogger };
+//# sourceMappingURL=AnalyticsLogger.d.cts.map

package/dist/AnalyticsLogger.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AnalyticsLogger.d.cts","sourceRoot":"","sources":["../src/AnalyticsLogger.ts"],"names":[],"mappings":";AAEA,OAAO,EAAuB,kBAAkB,EAAE,wBAAwB;AAE1E,eAAO,MAAM,aAAa,0BAA8C,CAAC;AAEzE,OAAO,EAAE,kBAAkB,EAAE,CAAC"}

package/dist/AnalyticsLogger.d.mts

@@ -0,0 +1,5 @@
+/// <reference types="debug" />
+import { createModuleLogger } from "@metamask/utils";
+export declare const projectLogger: import("debug").Debugger;
+export { createModuleLogger };
+//# sourceMappingURL=AnalyticsLogger.d.mts.map

package/dist/AnalyticsLogger.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AnalyticsLogger.d.mts","sourceRoot":"","sources":["../src/AnalyticsLogger.ts"],"names":[],"mappings":";AAEA,OAAO,EAAuB,kBAAkB,EAAE,wBAAwB;AAE1E,eAAO,MAAM,aAAa,0BAA8C,CAAC;AAEzE,OAAO,EAAE,kBAAkB,EAAE,CAAC"}

package/dist/AnalyticsLogger.mjs

@@ -0,0 +1,5 @@
+/* istanbul ignore file */
+import { createProjectLogger, createModuleLogger } from "@metamask/utils";
+export const projectLogger = createProjectLogger('analytics-controller');
+export { createModuleLogger };
+//# sourceMappingURL=AnalyticsLogger.mjs.map

package/dist/AnalyticsLogger.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"AnalyticsLogger.mjs","sourceRoot":"","sources":["../src/AnalyticsLogger.ts"],"names":[],"mappings":"AAAA,0BAA0B;AAE1B,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,wBAAwB;AAE1E,MAAM,CAAC,MAAM,aAAa,GAAG,mBAAmB,CAAC,sBAAsB,CAAC,CAAC;AAEzE,OAAO,EAAE,kBAAkB,EAAE,CAAC","sourcesContent":["/* istanbul ignore file */\n\nimport { createProjectLogger, createModuleLogger } from '@metamask/utils';\n\nexport const projectLogger = createProjectLogger('analytics-controller');\n\nexport { createModuleLogger };\n"]}

package/dist/AnalyticsPlatformAdapter.types.cjs

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=AnalyticsPlatformAdapter.types.cjs.map

package/dist/AnalyticsPlatformAdapter.types.cjs.map

@@ -0,0 +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"]}

package/dist/AnalyticsPlatformAdapter.types.d.cts

@@ -0,0 +1,33 @@
+import type { Json } from "@metamask/utils";
+/**
+ * Analytics event properties
+ */
+export type AnalyticsEventProperties = Record<string, Json>;
+/**
+ * Platform adapter interface for analytics tracking
+ * Implementations should handle platform-specific details (Segment SDK, etc.)
+ */
+export type AnalyticsPlatformAdapter = {
+    /**
+     * Track an analytics event
+     *
+     * @param eventName - The name of the event
+     * @param properties - Event properties
+     */
+    trackEvent(eventName: string, properties: AnalyticsEventProperties): void;
+    /**
+     * Identify a user
+     *
+     * @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;
+};
+//# sourceMappingURL=AnalyticsPlatformAdapter.types.d.cts.map

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

@@ -0,0 +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"}

package/dist/AnalyticsPlatformAdapter.types.d.mts

@@ -0,0 +1,33 @@
+import type { Json } from "@metamask/utils";
+/**
+ * Analytics event properties
+ */
+export type AnalyticsEventProperties = Record<string, Json>;
+/**
+ * Platform adapter interface for analytics tracking
+ * Implementations should handle platform-specific details (Segment SDK, etc.)
+ */
+export type AnalyticsPlatformAdapter = {
+    /**
+     * Track an analytics event
+     *
+     * @param eventName - The name of the event
+     * @param properties - Event properties
+     */
+    trackEvent(eventName: string, properties: AnalyticsEventProperties): void;
+    /**
+     * Identify a user
+     *
+     * @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;
+};
+//# sourceMappingURL=AnalyticsPlatformAdapter.types.d.mts.map

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

@@ -0,0 +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"}

package/dist/AnalyticsPlatformAdapter.types.mjs

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=AnalyticsPlatformAdapter.types.mjs.map

package/dist/AnalyticsPlatformAdapter.types.mjs.map

@@ -0,0 +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"]}

package/dist/index.cjs

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDefaultAnalyticsControllerState = exports.AnalyticsController = void 0;
+// Export controller class
+var AnalyticsController_1 = require("./AnalyticsController.cjs");
+Object.defineProperty(exports, "AnalyticsController", { enumerable: true, get: function () { return AnalyticsController_1.AnalyticsController; } });
+var AnalyticsController_2 = require("./AnalyticsController.cjs");
+Object.defineProperty(exports, "getDefaultAnalyticsControllerState", { enumerable: true, get: function () { return AnalyticsController_2.getDefaultAnalyticsControllerState; } });
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,0BAA0B;AAC1B,iEAA4D;AAAnD,0HAAA,mBAAmB,OAAA;AAW5B,iEAA2E;AAAlE,yIAAA,kCAAkC,OAAA","sourcesContent":["// Export controller class\nexport { AnalyticsController } from './AnalyticsController';\nexport type { AnalyticsControllerOptions } from './AnalyticsController';\n\n// Export types\nexport type {\n  AnalyticsEventProperties,\n  AnalyticsPlatformAdapter,\n} from './AnalyticsPlatformAdapter.types';\n\n// Export state types and utilities\nexport type { AnalyticsControllerState } from './AnalyticsController';\nexport { getDefaultAnalyticsControllerState } from './AnalyticsController';\n\n// Export messenger types\nexport type { AnalyticsControllerMessenger } from './AnalyticsController';\n\n// Export action and event types\nexport type {\n  AnalyticsControllerActions,\n  AnalyticsControllerEvents,\n  AnalyticsControllerGetStateAction,\n  AnalyticsControllerStateChangeEvent,\n  controllerName,\n} from './AnalyticsController';\nexport type {\n  AnalyticsControllerTrackEventAction,\n  AnalyticsControllerIdentifyAction,\n  AnalyticsControllerTrackPageAction,\n  AnalyticsControllerEnableAction,\n  AnalyticsControllerDisableAction,\n  AnalyticsControllerOptInAction,\n  AnalyticsControllerOptOutAction,\n  AnalyticsControllerMethodActions,\n} from './AnalyticsController-method-action-types';\n"]}

package/dist/index.d.cts

@@ -0,0 +1,9 @@
+export { AnalyticsController } from "./AnalyticsController.cjs";
+export type { AnalyticsControllerOptions } from "./AnalyticsController.cjs";
+export type { AnalyticsEventProperties, AnalyticsPlatformAdapter, } from "./AnalyticsPlatformAdapter.types.cjs";
+export type { AnalyticsControllerState } from "./AnalyticsController.cjs";
+export { getDefaultAnalyticsControllerState } from "./AnalyticsController.cjs";
+export type { AnalyticsControllerMessenger } from "./AnalyticsController.cjs";
+export type { AnalyticsControllerActions, AnalyticsControllerEvents, AnalyticsControllerGetStateAction, AnalyticsControllerStateChangeEvent, controllerName, } from "./AnalyticsController.cjs";
+export type { AnalyticsControllerTrackEventAction, AnalyticsControllerIdentifyAction, AnalyticsControllerTrackPageAction, AnalyticsControllerEnableAction, AnalyticsControllerDisableAction, AnalyticsControllerOptInAction, AnalyticsControllerOptOutAction, AnalyticsControllerMethodActions, } from "./AnalyticsController-method-action-types.cjs";
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,kCAA8B;AAC5D,YAAY,EAAE,0BAA0B,EAAE,kCAA8B;AAGxE,YAAY,EACV,wBAAwB,EACxB,wBAAwB,GACzB,6CAAyC;AAG1C,YAAY,EAAE,wBAAwB,EAAE,kCAA8B;AACtE,OAAO,EAAE,kCAAkC,EAAE,kCAA8B;AAG3E,YAAY,EAAE,4BAA4B,EAAE,kCAA8B;AAG1E,YAAY,EACV,0BAA0B,EAC1B,yBAAyB,EACzB,iCAAiC,EACjC,mCAAmC,EACnC,cAAc,GACf,kCAA8B;AAC/B,YAAY,EACV,mCAAmC,EACnC,iCAAiC,EACjC,kCAAkC,EAClC,+BAA+B,EAC/B,gCAAgC,EAChC,8BAA8B,EAC9B,+BAA+B,EAC/B,gCAAgC,GACjC,sDAAkD"}

package/dist/index.d.mts

@@ -0,0 +1,9 @@
+export { AnalyticsController } from "./AnalyticsController.mjs";
+export type { AnalyticsControllerOptions } from "./AnalyticsController.mjs";
+export type { AnalyticsEventProperties, AnalyticsPlatformAdapter, } from "./AnalyticsPlatformAdapter.types.mjs";
+export type { AnalyticsControllerState } from "./AnalyticsController.mjs";
+export { getDefaultAnalyticsControllerState } from "./AnalyticsController.mjs";
+export type { AnalyticsControllerMessenger } from "./AnalyticsController.mjs";
+export type { AnalyticsControllerActions, AnalyticsControllerEvents, AnalyticsControllerGetStateAction, AnalyticsControllerStateChangeEvent, controllerName, } from "./AnalyticsController.mjs";
+export type { AnalyticsControllerTrackEventAction, AnalyticsControllerIdentifyAction, AnalyticsControllerTrackPageAction, AnalyticsControllerEnableAction, AnalyticsControllerDisableAction, AnalyticsControllerOptInAction, AnalyticsControllerOptOutAction, AnalyticsControllerMethodActions, } from "./AnalyticsController-method-action-types.mjs";
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,kCAA8B;AAC5D,YAAY,EAAE,0BAA0B,EAAE,kCAA8B;AAGxE,YAAY,EACV,wBAAwB,EACxB,wBAAwB,GACzB,6CAAyC;AAG1C,YAAY,EAAE,wBAAwB,EAAE,kCAA8B;AACtE,OAAO,EAAE,kCAAkC,EAAE,kCAA8B;AAG3E,YAAY,EAAE,4BAA4B,EAAE,kCAA8B;AAG1E,YAAY,EACV,0BAA0B,EAC1B,yBAAyB,EACzB,iCAAiC,EACjC,mCAAmC,EACnC,cAAc,GACf,kCAA8B;AAC/B,YAAY,EACV,mCAAmC,EACnC,iCAAiC,EACjC,kCAAkC,EAClC,+BAA+B,EAC/B,gCAAgC,EAChC,8BAA8B,EAC9B,+BAA+B,EAC/B,gCAAgC,GACjC,sDAAkD"}

package/dist/index.mjs

@@ -0,0 +1,4 @@
+// Export controller class
+export { AnalyticsController } from "./AnalyticsController.mjs";
+export { getDefaultAnalyticsControllerState } from "./AnalyticsController.mjs";
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,0BAA0B;AAC1B,OAAO,EAAE,mBAAmB,EAAE,kCAA8B;AAW5D,OAAO,EAAE,kCAAkC,EAAE,kCAA8B","sourcesContent":["// Export controller class\nexport { AnalyticsController } from './AnalyticsController';\nexport type { AnalyticsControllerOptions } from './AnalyticsController';\n\n// Export types\nexport type {\n  AnalyticsEventProperties,\n  AnalyticsPlatformAdapter,\n} from './AnalyticsPlatformAdapter.types';\n\n// Export state types and utilities\nexport type { AnalyticsControllerState } from './AnalyticsController';\nexport { getDefaultAnalyticsControllerState } from './AnalyticsController';\n\n// Export messenger types\nexport type { AnalyticsControllerMessenger } from './AnalyticsController';\n\n// Export action and event types\nexport type {\n  AnalyticsControllerActions,\n  AnalyticsControllerEvents,\n  AnalyticsControllerGetStateAction,\n  AnalyticsControllerStateChangeEvent,\n  controllerName,\n} from './AnalyticsController';\nexport type {\n  AnalyticsControllerTrackEventAction,\n  AnalyticsControllerIdentifyAction,\n  AnalyticsControllerTrackPageAction,\n  AnalyticsControllerEnableAction,\n  AnalyticsControllerDisableAction,\n  AnalyticsControllerOptInAction,\n  AnalyticsControllerOptOutAction,\n  AnalyticsControllerMethodActions,\n} from './AnalyticsController-method-action-types';\n"]}

package/package.json

@@ -0,0 +1,74 @@
+{
+  "name": "@metamask-previews/analytics-controller",
+  "version": "0.0.0-preview-b8454d32",
+  "description": "Common Analytics controller for event tracking",
+  "keywords": [
+    "MetaMask",
+    "Ethereum"
+  ],
+  "homepage": "https://github.com/MetaMask/core/tree/main/packages/analytics-controller#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/core/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MetaMask/core.git"
+  },
+  "license": "MIT",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.cjs",
+  "types": "./dist/index.d.cts",
+  "files": [
+    "dist/"
+  ],
+  "scripts": {
+    "build": "ts-bridge --project tsconfig.build.json --verbose --clean --no-references",
+    "build:all": "ts-bridge --project tsconfig.build.json --verbose --clean",
+    "build:docs": "typedoc",
+    "changelog:update": "../../scripts/update-changelog.sh @metamask/analytics-controller",
+    "changelog:validate": "../../scripts/validate-changelog.sh @metamask/analytics-controller",
+    "publish:preview": "yarn npm publish --tag preview",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter",
+    "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache",
+    "test:verbose": "NODE_OPTIONS=--experimental-vm-modules jest --verbose",
+    "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch"
+  },
+  "dependencies": {
+    "@metamask/base-controller": "^9.0.0",
+    "@metamask/messenger": "^0.3.0",
+    "@metamask/utils": "^11.8.1",
+    "uuid": "^8.3.2"
+  },
+  "devDependencies": {
+    "@metamask/auto-changelog": "^3.4.4",
+    "@ts-bridge/cli": "^0.6.4",
+    "@types/jest": "^27.4.1",
+    "deepmerge": "^4.2.2",
+    "jest": "^27.5.1",
+    "ts-jest": "^27.1.4",
+    "typedoc": "^0.24.8",
+    "typedoc-plugin-missing-exports": "^2.0.0",
+    "typescript": "~5.2.2"
+  },
+  "engines": {
+    "node": "^18.18 || >=20"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}