@metamask-previews/connectivity-controller 0.0.0-preview-9e00b40b

package/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+- Initial release ([#7623](https://github.com/MetaMask/core/pull/7623))
+
+[Unreleased]: https://github.com/MetaMask/core/

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2026 MetaMask
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

package/README.md

@@ -0,0 +1,15 @@
+# `@metamask/connectivity-controller`
+
+ConnectivityController stores the device's internet connectivity status.
+
+## Installation
+
+`yarn add @metamask/connectivity-controller`
+
+or
+
+`npm install @metamask/connectivity-controller`
+
+## Contributing
+
+This package is part of a monorepo. Instructions for contributing can be found in the [monorepo README](https://github.com/MetaMask/core#readme).

package/dist/ConnectivityController.cjs

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConnectivityController = exports.getDefaultConnectivityControllerState = exports.controllerName = void 0;
+const base_controller_1 = require("@metamask/base-controller");
+const types_1 = require("./types.cjs");
+/**
+ * The name of the {@link ConnectivityController}, used to namespace the
+ * controller's actions and events and to namespace the controller's state data
+ * when composed with other controllers.
+ */
+exports.controllerName = 'ConnectivityController';
+/**
+ * The metadata for each property in {@link ConnectivityControllerState}.
+ */
+const connectivityControllerMetadata = {
+    connectivityStatus: {
+        persist: false,
+        includeInDebugSnapshot: true,
+        includeInStateLogs: true,
+        usedInUi: true,
+    },
+};
+/**
+ * Constructs the default {@link ConnectivityController} 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 ConnectivityController} state.
+ */
+function getDefaultConnectivityControllerState() {
+    return {
+        connectivityStatus: types_1.ConnectivityStatus.Online,
+    };
+}
+exports.getDefaultConnectivityControllerState = getDefaultConnectivityControllerState;
+/**
+ * ConnectivityController stores the device's internet connectivity status.
+ *
+ * This controller is platform-agnostic and designed to be used across different
+ * MetaMask clients (extension, mobile). It requires a `ConnectivityService` to
+ * be injected, which provides platform-specific connectivity detection.
+ *
+ * The controller subscribes to the service's `onConnectivityChange` callback
+ * and updates its state accordingly. All connectivity updates flow through
+ * the service, ensuring a single source of truth.
+ *
+ * **Platform implementations:**
+ *
+ * - **Mobile:** Inject `NetInfoConnectivityService` using `@react-native-community/netinfo`
+ * - **Extension:** Inject `PassiveConnectivityService` in the background.
+ * Status is updated via the `setDeviceConnectivityStatus` API, which is called from:
+ * - MV3: Offscreen document (where browser events work reliably)
+ * - MV2: Background page (where browser events work directly)
+ *
+ * This controller provides a centralized state for connectivity status,
+ * enabling the UI and other controllers to adapt when the user goes offline.
+ */
+class ConnectivityController extends base_controller_1.BaseController {
+    /**
+     * Constructs a new {@link ConnectivityController}.
+     *
+     * @param args - The arguments to this controller.
+     * @param args.messenger - The messenger suited for this controller.
+     * @param args.connectivityService - The connectivity service to use.
+     */
+    constructor({ messenger, connectivityService, }) {
+        const initialStatus = connectivityService.getStatus();
+        super({
+            messenger,
+            metadata: connectivityControllerMetadata,
+            name: exports.controllerName,
+            state: {
+                ...getDefaultConnectivityControllerState(),
+                connectivityStatus: initialStatus,
+            },
+        });
+        connectivityService.onConnectivityChange((status) => {
+            this.update((draftState) => {
+                draftState.connectivityStatus = status;
+            });
+        });
+    }
+}
+exports.ConnectivityController = ConnectivityController;
+//# sourceMappingURL=ConnectivityController.cjs.map

package/dist/ConnectivityController.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConnectivityController.cjs","sourceRoot":"","sources":["../src/ConnectivityController.ts"],"names":[],"mappings":";;;AAKA,+DAA2D;AAG3D,uCAA6C;AAG7C;;;;GAIG;AACU,QAAA,cAAc,GAAG,wBAAwB,CAAC;AAavD;;GAEG;AACH,MAAM,8BAA8B,GAAG;IACrC,kBAAkB,EAAE;QAClB,OAAO,EAAE,KAAK;QACd,sBAAsB,EAAE,IAAI;QAC5B,kBAAkB,EAAE,IAAI;QACxB,QAAQ,EAAE,IAAI;KACf;CACmD,CAAC;AAEvD;;;;;;;GAOG;AACH,SAAgB,qCAAqC;IACnD,OAAO;QACL,kBAAkB,EAAE,0BAAkB,CAAC,MAAM;KAC9C,CAAC;AACJ,CAAC;AAJD,sFAIC;AA2ED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAa,sBAAuB,SAAQ,gCAI3C;IACC;;;;;;OAMG;IACH,YAAY,EACV,SAAS,EACT,mBAAmB,GACW;QAC9B,MAAM,aAAa,GAAG,mBAAmB,CAAC,SAAS,EAAE,CAAC;QAEtD,KAAK,CAAC;YACJ,SAAS;YACT,QAAQ,EAAE,8BAA8B;YACxC,IAAI,EAAE,sBAAc;YACpB,KAAK,EAAE;gBACL,GAAG,qCAAqC,EAAE;gBAC1C,kBAAkB,EAAE,aAAa;aAClC;SACF,CAAC,CAAC;QAEH,mBAAmB,CAAC,oBAAoB,CAAC,CAAC,MAAM,EAAE,EAAE;YAClD,IAAI,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,EAAE;gBACzB,UAAU,CAAC,kBAAkB,GAAG,MAAM,CAAC;YACzC,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAlCD,wDAkCC","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';\n\nimport { ConnectivityStatus } from './types';\nimport type { ConnectivityService } from './types';\n\n/**\n * The name of the {@link ConnectivityController}, 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 = 'ConnectivityController';\n\n/**\n * State for the {@link ConnectivityController}.\n */\nexport type ConnectivityControllerState = {\n  /**\n   * The current device connectivity status.\n   * Named with 'connectivity' prefix to avoid conflicts when state is flattened in Redux.\n   */\n  connectivityStatus: ConnectivityStatus;\n};\n\n/**\n * The metadata for each property in {@link ConnectivityControllerState}.\n */\nconst connectivityControllerMetadata = {\n  connectivityStatus: {\n    persist: false,\n    includeInDebugSnapshot: true,\n    includeInStateLogs: true,\n    usedInUi: true,\n  },\n} satisfies StateMetadata<ConnectivityControllerState>;\n\n/**\n * Constructs the default {@link ConnectivityController} 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 ConnectivityController} state.\n */\nexport function getDefaultConnectivityControllerState(): ConnectivityControllerState {\n  return {\n    connectivityStatus: ConnectivityStatus.Online,\n  };\n}\n\n/**\n * Retrieves the state of the {@link ConnectivityController}.\n */\nexport type ConnectivityControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  ConnectivityControllerState\n>;\n\n/**\n * Actions that {@link ConnectivityControllerMessenger} exposes to other consumers.\n */\nexport type ConnectivityControllerActions =\n  ConnectivityControllerGetStateAction;\n\n/**\n * Actions from other messengers that {@link ConnectivityControllerMessenger} calls.\n */\ntype AllowedActions = never;\n\n/**\n * Published when the state of {@link ConnectivityController} changes.\n */\nexport type ConnectivityControllerStateChangeEvent = ControllerStateChangeEvent<\n  typeof controllerName,\n  ConnectivityControllerState\n>;\n\n/**\n * Events that {@link ConnectivityControllerMessenger} exposes to other consumers.\n */\nexport type ConnectivityControllerEvents =\n  ConnectivityControllerStateChangeEvent;\n\n/**\n * Events from other messengers that {@link ConnectivityControllerMessenger} subscribes\n * to.\n */\ntype AllowedEvents = never;\n\n/**\n * The messenger restricted to actions and events accessed by\n * {@link ConnectivityController}.\n */\nexport type ConnectivityControllerMessenger = Messenger<\n  typeof controllerName,\n  ConnectivityControllerActions | AllowedActions,\n  ConnectivityControllerEvents | AllowedEvents\n>;\n\n/**\n * Options for constructing the {@link ConnectivityController}.\n */\nexport type ConnectivityControllerOptions = {\n  /**\n   * The messenger for inter-controller communication.\n   */\n  messenger: ConnectivityControllerMessenger;\n\n  /**\n   * Connectivity service for platform-specific detection.\n   *\n   * The controller subscribes to the service's `onConnectivityChange`\n   * callback to receive connectivity updates.\n   *\n   * Platform implementations:\n   * - Mobile: Use `NetInfoConnectivityService` with `@react-native-community/netinfo`\n   * - Extension (same context): Use `BrowserConnectivityService`\n   * - Extension (cross-context): Use `PassiveConnectivityService` and call\n   * `setStatus()` from the UI context\n   */\n  connectivityService: ConnectivityService;\n};\n\n/**\n * ConnectivityController stores the device's internet connectivity status.\n *\n * This controller is platform-agnostic and designed to be used across different\n * MetaMask clients (extension, mobile). It requires a `ConnectivityService` to\n * be injected, which provides platform-specific connectivity detection.\n *\n * The controller subscribes to the service's `onConnectivityChange` callback\n * and updates its state accordingly. All connectivity updates flow through\n * the service, ensuring a single source of truth.\n *\n * **Platform implementations:**\n *\n * - **Mobile:** Inject `NetInfoConnectivityService` using `@react-native-community/netinfo`\n * - **Extension:** Inject `PassiveConnectivityService` in the background.\n * Status is updated via the `setDeviceConnectivityStatus` API, which is called from:\n * - MV3: Offscreen document (where browser events work reliably)\n * - MV2: Background page (where browser events work directly)\n *\n * This controller provides a centralized state for connectivity status,\n * enabling the UI and other controllers to adapt when the user goes offline.\n */\nexport class ConnectivityController extends BaseController<\n  typeof controllerName,\n  ConnectivityControllerState,\n  ConnectivityControllerMessenger\n> {\n  /**\n   * Constructs a new {@link ConnectivityController}.\n   *\n   * @param args - The arguments to this controller.\n   * @param args.messenger - The messenger suited for this controller.\n   * @param args.connectivityService - The connectivity service to use.\n   */\n  constructor({\n    messenger,\n    connectivityService,\n  }: ConnectivityControllerOptions) {\n    const initialStatus = connectivityService.getStatus();\n\n    super({\n      messenger,\n      metadata: connectivityControllerMetadata,\n      name: controllerName,\n      state: {\n        ...getDefaultConnectivityControllerState(),\n        connectivityStatus: initialStatus,\n      },\n    });\n\n    connectivityService.onConnectivityChange((status) => {\n      this.update((draftState) => {\n        draftState.connectivityStatus = status;\n      });\n    });\n  }\n}\n"]}

package/dist/ConnectivityController.d.cts

@@ -0,0 +1,116 @@
+import type { ControllerGetStateAction, ControllerStateChangeEvent } from "@metamask/base-controller";
+import { BaseController } from "@metamask/base-controller";
+import type { Messenger } from "@metamask/messenger";
+import { ConnectivityStatus } from "./types.cjs";
+import type { ConnectivityService } from "./types.cjs";
+/**
+ * The name of the {@link ConnectivityController}, 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 = "ConnectivityController";
+/**
+ * State for the {@link ConnectivityController}.
+ */
+export type ConnectivityControllerState = {
+    /**
+     * The current device connectivity status.
+     * Named with 'connectivity' prefix to avoid conflicts when state is flattened in Redux.
+     */
+    connectivityStatus: ConnectivityStatus;
+};
+/**
+ * Constructs the default {@link ConnectivityController} 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 ConnectivityController} state.
+ */
+export declare function getDefaultConnectivityControllerState(): ConnectivityControllerState;
+/**
+ * Retrieves the state of the {@link ConnectivityController}.
+ */
+export type ConnectivityControllerGetStateAction = ControllerGetStateAction<typeof controllerName, ConnectivityControllerState>;
+/**
+ * Actions that {@link ConnectivityControllerMessenger} exposes to other consumers.
+ */
+export type ConnectivityControllerActions = ConnectivityControllerGetStateAction;
+/**
+ * Actions from other messengers that {@link ConnectivityControllerMessenger} calls.
+ */
+type AllowedActions = never;
+/**
+ * Published when the state of {@link ConnectivityController} changes.
+ */
+export type ConnectivityControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, ConnectivityControllerState>;
+/**
+ * Events that {@link ConnectivityControllerMessenger} exposes to other consumers.
+ */
+export type ConnectivityControllerEvents = ConnectivityControllerStateChangeEvent;
+/**
+ * Events from other messengers that {@link ConnectivityControllerMessenger} subscribes
+ * to.
+ */
+type AllowedEvents = never;
+/**
+ * The messenger restricted to actions and events accessed by
+ * {@link ConnectivityController}.
+ */
+export type ConnectivityControllerMessenger = Messenger<typeof controllerName, ConnectivityControllerActions | AllowedActions, ConnectivityControllerEvents | AllowedEvents>;
+/**
+ * Options for constructing the {@link ConnectivityController}.
+ */
+export type ConnectivityControllerOptions = {
+    /**
+     * The messenger for inter-controller communication.
+     */
+    messenger: ConnectivityControllerMessenger;
+    /**
+     * Connectivity service for platform-specific detection.
+     *
+     * The controller subscribes to the service's `onConnectivityChange`
+     * callback to receive connectivity updates.
+     *
+     * Platform implementations:
+     * - Mobile: Use `NetInfoConnectivityService` with `@react-native-community/netinfo`
+     * - Extension (same context): Use `BrowserConnectivityService`
+     * - Extension (cross-context): Use `PassiveConnectivityService` and call
+     * `setStatus()` from the UI context
+     */
+    connectivityService: ConnectivityService;
+};
+/**
+ * ConnectivityController stores the device's internet connectivity status.
+ *
+ * This controller is platform-agnostic and designed to be used across different
+ * MetaMask clients (extension, mobile). It requires a `ConnectivityService` to
+ * be injected, which provides platform-specific connectivity detection.
+ *
+ * The controller subscribes to the service's `onConnectivityChange` callback
+ * and updates its state accordingly. All connectivity updates flow through
+ * the service, ensuring a single source of truth.
+ *
+ * **Platform implementations:**
+ *
+ * - **Mobile:** Inject `NetInfoConnectivityService` using `@react-native-community/netinfo`
+ * - **Extension:** Inject `PassiveConnectivityService` in the background.
+ * Status is updated via the `setDeviceConnectivityStatus` API, which is called from:
+ * - MV3: Offscreen document (where browser events work reliably)
+ * - MV2: Background page (where browser events work directly)
+ *
+ * This controller provides a centralized state for connectivity status,
+ * enabling the UI and other controllers to adapt when the user goes offline.
+ */
+export declare class ConnectivityController extends BaseController<typeof controllerName, ConnectivityControllerState, ConnectivityControllerMessenger> {
+    /**
+     * Constructs a new {@link ConnectivityController}.
+     *
+     * @param args - The arguments to this controller.
+     * @param args.messenger - The messenger suited for this controller.
+     * @param args.connectivityService - The connectivity service to use.
+     */
+    constructor({ messenger, connectivityService, }: ConnectivityControllerOptions);
+}
+export {};
+//# sourceMappingURL=ConnectivityController.d.cts.map

package/dist/ConnectivityController.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConnectivityController.d.cts","sourceRoot":"","sources":["../src/ConnectivityController.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;AAErD,OAAO,EAAE,kBAAkB,EAAE,oBAAgB;AAC7C,OAAO,KAAK,EAAE,mBAAmB,EAAE,oBAAgB;AAEnD;;;;GAIG;AACH,eAAO,MAAM,cAAc,2BAA2B,CAAC;AAEvD;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC;;;OAGG;IACH,kBAAkB,EAAE,kBAAkB,CAAC;CACxC,CAAC;AAcF;;;;;;;GAOG;AACH,wBAAgB,qCAAqC,IAAI,2BAA2B,CAInF;AAED;;GAEG;AACH,MAAM,MAAM,oCAAoC,GAAG,wBAAwB,CACzE,OAAO,cAAc,EACrB,2BAA2B,CAC5B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,6BAA6B,GACvC,oCAAoC,CAAC;AAEvC;;GAEG;AACH,KAAK,cAAc,GAAG,KAAK,CAAC;AAE5B;;GAEG;AACH,MAAM,MAAM,sCAAsC,GAAG,0BAA0B,CAC7E,OAAO,cAAc,EACrB,2BAA2B,CAC5B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,4BAA4B,GACtC,sCAAsC,CAAC;AAEzC;;;GAGG;AACH,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,+BAA+B,GAAG,SAAS,CACrD,OAAO,cAAc,EACrB,6BAA6B,GAAG,cAAc,EAC9C,4BAA4B,GAAG,aAAa,CAC7C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;OAEG;IACH,SAAS,EAAE,+BAA+B,CAAC;IAE3C;;;;;;;;;;;OAWG;IACH,mBAAmB,EAAE,mBAAmB,CAAC;CAC1C,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,sBAAuB,SAAQ,cAAc,CACxD,OAAO,cAAc,EACrB,2BAA2B,EAC3B,+BAA+B,CAChC;IACC;;;;;;OAMG;gBACS,EACV,SAAS,EACT,mBAAmB,GACpB,EAAE,6BAA6B;CAmBjC"}

package/dist/ConnectivityController.d.mts

@@ -0,0 +1,116 @@
+import type { ControllerGetStateAction, ControllerStateChangeEvent } from "@metamask/base-controller";
+import { BaseController } from "@metamask/base-controller";
+import type { Messenger } from "@metamask/messenger";
+import { ConnectivityStatus } from "./types.mjs";
+import type { ConnectivityService } from "./types.mjs";
+/**
+ * The name of the {@link ConnectivityController}, 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 = "ConnectivityController";
+/**
+ * State for the {@link ConnectivityController}.
+ */
+export type ConnectivityControllerState = {
+    /**
+     * The current device connectivity status.
+     * Named with 'connectivity' prefix to avoid conflicts when state is flattened in Redux.
+     */
+    connectivityStatus: ConnectivityStatus;
+};
+/**
+ * Constructs the default {@link ConnectivityController} 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 ConnectivityController} state.
+ */
+export declare function getDefaultConnectivityControllerState(): ConnectivityControllerState;
+/**
+ * Retrieves the state of the {@link ConnectivityController}.
+ */
+export type ConnectivityControllerGetStateAction = ControllerGetStateAction<typeof controllerName, ConnectivityControllerState>;
+/**
+ * Actions that {@link ConnectivityControllerMessenger} exposes to other consumers.
+ */
+export type ConnectivityControllerActions = ConnectivityControllerGetStateAction;
+/**
+ * Actions from other messengers that {@link ConnectivityControllerMessenger} calls.
+ */
+type AllowedActions = never;
+/**
+ * Published when the state of {@link ConnectivityController} changes.
+ */
+export type ConnectivityControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, ConnectivityControllerState>;
+/**
+ * Events that {@link ConnectivityControllerMessenger} exposes to other consumers.
+ */
+export type ConnectivityControllerEvents = ConnectivityControllerStateChangeEvent;
+/**
+ * Events from other messengers that {@link ConnectivityControllerMessenger} subscribes
+ * to.
+ */
+type AllowedEvents = never;
+/**
+ * The messenger restricted to actions and events accessed by
+ * {@link ConnectivityController}.
+ */
+export type ConnectivityControllerMessenger = Messenger<typeof controllerName, ConnectivityControllerActions | AllowedActions, ConnectivityControllerEvents | AllowedEvents>;
+/**
+ * Options for constructing the {@link ConnectivityController}.
+ */
+export type ConnectivityControllerOptions = {
+    /**
+     * The messenger for inter-controller communication.
+     */
+    messenger: ConnectivityControllerMessenger;
+    /**
+     * Connectivity service for platform-specific detection.
+     *
+     * The controller subscribes to the service's `onConnectivityChange`
+     * callback to receive connectivity updates.
+     *
+     * Platform implementations:
+     * - Mobile: Use `NetInfoConnectivityService` with `@react-native-community/netinfo`
+     * - Extension (same context): Use `BrowserConnectivityService`
+     * - Extension (cross-context): Use `PassiveConnectivityService` and call
+     * `setStatus()` from the UI context
+     */
+    connectivityService: ConnectivityService;
+};
+/**
+ * ConnectivityController stores the device's internet connectivity status.
+ *
+ * This controller is platform-agnostic and designed to be used across different
+ * MetaMask clients (extension, mobile). It requires a `ConnectivityService` to
+ * be injected, which provides platform-specific connectivity detection.
+ *
+ * The controller subscribes to the service's `onConnectivityChange` callback
+ * and updates its state accordingly. All connectivity updates flow through
+ * the service, ensuring a single source of truth.
+ *
+ * **Platform implementations:**
+ *
+ * - **Mobile:** Inject `NetInfoConnectivityService` using `@react-native-community/netinfo`
+ * - **Extension:** Inject `PassiveConnectivityService` in the background.
+ * Status is updated via the `setDeviceConnectivityStatus` API, which is called from:
+ * - MV3: Offscreen document (where browser events work reliably)
+ * - MV2: Background page (where browser events work directly)
+ *
+ * This controller provides a centralized state for connectivity status,
+ * enabling the UI and other controllers to adapt when the user goes offline.
+ */
+export declare class ConnectivityController extends BaseController<typeof controllerName, ConnectivityControllerState, ConnectivityControllerMessenger> {
+    /**
+     * Constructs a new {@link ConnectivityController}.
+     *
+     * @param args - The arguments to this controller.
+     * @param args.messenger - The messenger suited for this controller.
+     * @param args.connectivityService - The connectivity service to use.
+     */
+    constructor({ messenger, connectivityService, }: ConnectivityControllerOptions);
+}
+export {};
+//# sourceMappingURL=ConnectivityController.d.mts.map

package/dist/ConnectivityController.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConnectivityController.d.mts","sourceRoot":"","sources":["../src/ConnectivityController.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;AAErD,OAAO,EAAE,kBAAkB,EAAE,oBAAgB;AAC7C,OAAO,KAAK,EAAE,mBAAmB,EAAE,oBAAgB;AAEnD;;;;GAIG;AACH,eAAO,MAAM,cAAc,2BAA2B,CAAC;AAEvD;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC;;;OAGG;IACH,kBAAkB,EAAE,kBAAkB,CAAC;CACxC,CAAC;AAcF;;;;;;;GAOG;AACH,wBAAgB,qCAAqC,IAAI,2BAA2B,CAInF;AAED;;GAEG;AACH,MAAM,MAAM,oCAAoC,GAAG,wBAAwB,CACzE,OAAO,cAAc,EACrB,2BAA2B,CAC5B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,6BAA6B,GACvC,oCAAoC,CAAC;AAEvC;;GAEG;AACH,KAAK,cAAc,GAAG,KAAK,CAAC;AAE5B;;GAEG;AACH,MAAM,MAAM,sCAAsC,GAAG,0BAA0B,CAC7E,OAAO,cAAc,EACrB,2BAA2B,CAC5B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,4BAA4B,GACtC,sCAAsC,CAAC;AAEzC;;;GAGG;AACH,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,+BAA+B,GAAG,SAAS,CACrD,OAAO,cAAc,EACrB,6BAA6B,GAAG,cAAc,EAC9C,4BAA4B,GAAG,aAAa,CAC7C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;OAEG;IACH,SAAS,EAAE,+BAA+B,CAAC;IAE3C;;;;;;;;;;;OAWG;IACH,mBAAmB,EAAE,mBAAmB,CAAC;CAC1C,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,sBAAuB,SAAQ,cAAc,CACxD,OAAO,cAAc,EACrB,2BAA2B,EAC3B,+BAA+B,CAChC;IACC;;;;;;OAMG;gBACS,EACV,SAAS,EACT,mBAAmB,GACpB,EAAE,6BAA6B;CAmBjC"}

package/dist/ConnectivityController.mjs

@@ -0,0 +1,81 @@
+import { BaseController } from "@metamask/base-controller";
+import { ConnectivityStatus } from "./types.mjs";
+/**
+ * The name of the {@link ConnectivityController}, 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 = 'ConnectivityController';
+/**
+ * The metadata for each property in {@link ConnectivityControllerState}.
+ */
+const connectivityControllerMetadata = {
+    connectivityStatus: {
+        persist: false,
+        includeInDebugSnapshot: true,
+        includeInStateLogs: true,
+        usedInUi: true,
+    },
+};
+/**
+ * Constructs the default {@link ConnectivityController} 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 ConnectivityController} state.
+ */
+export function getDefaultConnectivityControllerState() {
+    return {
+        connectivityStatus: ConnectivityStatus.Online,
+    };
+}
+/**
+ * ConnectivityController stores the device's internet connectivity status.
+ *
+ * This controller is platform-agnostic and designed to be used across different
+ * MetaMask clients (extension, mobile). It requires a `ConnectivityService` to
+ * be injected, which provides platform-specific connectivity detection.
+ *
+ * The controller subscribes to the service's `onConnectivityChange` callback
+ * and updates its state accordingly. All connectivity updates flow through
+ * the service, ensuring a single source of truth.
+ *
+ * **Platform implementations:**
+ *
+ * - **Mobile:** Inject `NetInfoConnectivityService` using `@react-native-community/netinfo`
+ * - **Extension:** Inject `PassiveConnectivityService` in the background.
+ * Status is updated via the `setDeviceConnectivityStatus` API, which is called from:
+ * - MV3: Offscreen document (where browser events work reliably)
+ * - MV2: Background page (where browser events work directly)
+ *
+ * This controller provides a centralized state for connectivity status,
+ * enabling the UI and other controllers to adapt when the user goes offline.
+ */
+export class ConnectivityController extends BaseController {
+    /**
+     * Constructs a new {@link ConnectivityController}.
+     *
+     * @param args - The arguments to this controller.
+     * @param args.messenger - The messenger suited for this controller.
+     * @param args.connectivityService - The connectivity service to use.
+     */
+    constructor({ messenger, connectivityService, }) {
+        const initialStatus = connectivityService.getStatus();
+        super({
+            messenger,
+            metadata: connectivityControllerMetadata,
+            name: controllerName,
+            state: {
+                ...getDefaultConnectivityControllerState(),
+                connectivityStatus: initialStatus,
+            },
+        });
+        connectivityService.onConnectivityChange((status) => {
+            this.update((draftState) => {
+                draftState.connectivityStatus = status;
+            });
+        });
+    }
+}
+//# sourceMappingURL=ConnectivityController.mjs.map

package/dist/ConnectivityController.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConnectivityController.mjs","sourceRoot":"","sources":["../src/ConnectivityController.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAG3D,OAAO,EAAE,kBAAkB,EAAE,oBAAgB;AAG7C;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,wBAAwB,CAAC;AAavD;;GAEG;AACH,MAAM,8BAA8B,GAAG;IACrC,kBAAkB,EAAE;QAClB,OAAO,EAAE,KAAK;QACd,sBAAsB,EAAE,IAAI;QAC5B,kBAAkB,EAAE,IAAI;QACxB,QAAQ,EAAE,IAAI;KACf;CACmD,CAAC;AAEvD;;;;;;;GAOG;AACH,MAAM,UAAU,qCAAqC;IACnD,OAAO;QACL,kBAAkB,EAAE,kBAAkB,CAAC,MAAM;KAC9C,CAAC;AACJ,CAAC;AA2ED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,OAAO,sBAAuB,SAAQ,cAI3C;IACC;;;;;;OAMG;IACH,YAAY,EACV,SAAS,EACT,mBAAmB,GACW;QAC9B,MAAM,aAAa,GAAG,mBAAmB,CAAC,SAAS,EAAE,CAAC;QAEtD,KAAK,CAAC;YACJ,SAAS;YACT,QAAQ,EAAE,8BAA8B;YACxC,IAAI,EAAE,cAAc;YACpB,KAAK,EAAE;gBACL,GAAG,qCAAqC,EAAE;gBAC1C,kBAAkB,EAAE,aAAa;aAClC;SACF,CAAC,CAAC;QAEH,mBAAmB,CAAC,oBAAoB,CAAC,CAAC,MAAM,EAAE,EAAE;YAClD,IAAI,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,EAAE;gBACzB,UAAU,CAAC,kBAAkB,GAAG,MAAM,CAAC;YACzC,CAAC,CAAC,CAAC;QACL,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';\n\nimport { ConnectivityStatus } from './types';\nimport type { ConnectivityService } from './types';\n\n/**\n * The name of the {@link ConnectivityController}, 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 = 'ConnectivityController';\n\n/**\n * State for the {@link ConnectivityController}.\n */\nexport type ConnectivityControllerState = {\n  /**\n   * The current device connectivity status.\n   * Named with 'connectivity' prefix to avoid conflicts when state is flattened in Redux.\n   */\n  connectivityStatus: ConnectivityStatus;\n};\n\n/**\n * The metadata for each property in {@link ConnectivityControllerState}.\n */\nconst connectivityControllerMetadata = {\n  connectivityStatus: {\n    persist: false,\n    includeInDebugSnapshot: true,\n    includeInStateLogs: true,\n    usedInUi: true,\n  },\n} satisfies StateMetadata<ConnectivityControllerState>;\n\n/**\n * Constructs the default {@link ConnectivityController} 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 ConnectivityController} state.\n */\nexport function getDefaultConnectivityControllerState(): ConnectivityControllerState {\n  return {\n    connectivityStatus: ConnectivityStatus.Online,\n  };\n}\n\n/**\n * Retrieves the state of the {@link ConnectivityController}.\n */\nexport type ConnectivityControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  ConnectivityControllerState\n>;\n\n/**\n * Actions that {@link ConnectivityControllerMessenger} exposes to other consumers.\n */\nexport type ConnectivityControllerActions =\n  ConnectivityControllerGetStateAction;\n\n/**\n * Actions from other messengers that {@link ConnectivityControllerMessenger} calls.\n */\ntype AllowedActions = never;\n\n/**\n * Published when the state of {@link ConnectivityController} changes.\n */\nexport type ConnectivityControllerStateChangeEvent = ControllerStateChangeEvent<\n  typeof controllerName,\n  ConnectivityControllerState\n>;\n\n/**\n * Events that {@link ConnectivityControllerMessenger} exposes to other consumers.\n */\nexport type ConnectivityControllerEvents =\n  ConnectivityControllerStateChangeEvent;\n\n/**\n * Events from other messengers that {@link ConnectivityControllerMessenger} subscribes\n * to.\n */\ntype AllowedEvents = never;\n\n/**\n * The messenger restricted to actions and events accessed by\n * {@link ConnectivityController}.\n */\nexport type ConnectivityControllerMessenger = Messenger<\n  typeof controllerName,\n  ConnectivityControllerActions | AllowedActions,\n  ConnectivityControllerEvents | AllowedEvents\n>;\n\n/**\n * Options for constructing the {@link ConnectivityController}.\n */\nexport type ConnectivityControllerOptions = {\n  /**\n   * The messenger for inter-controller communication.\n   */\n  messenger: ConnectivityControllerMessenger;\n\n  /**\n   * Connectivity service for platform-specific detection.\n   *\n   * The controller subscribes to the service's `onConnectivityChange`\n   * callback to receive connectivity updates.\n   *\n   * Platform implementations:\n   * - Mobile: Use `NetInfoConnectivityService` with `@react-native-community/netinfo`\n   * - Extension (same context): Use `BrowserConnectivityService`\n   * - Extension (cross-context): Use `PassiveConnectivityService` and call\n   * `setStatus()` from the UI context\n   */\n  connectivityService: ConnectivityService;\n};\n\n/**\n * ConnectivityController stores the device's internet connectivity status.\n *\n * This controller is platform-agnostic and designed to be used across different\n * MetaMask clients (extension, mobile). It requires a `ConnectivityService` to\n * be injected, which provides platform-specific connectivity detection.\n *\n * The controller subscribes to the service's `onConnectivityChange` callback\n * and updates its state accordingly. All connectivity updates flow through\n * the service, ensuring a single source of truth.\n *\n * **Platform implementations:**\n *\n * - **Mobile:** Inject `NetInfoConnectivityService` using `@react-native-community/netinfo`\n * - **Extension:** Inject `PassiveConnectivityService` in the background.\n * Status is updated via the `setDeviceConnectivityStatus` API, which is called from:\n * - MV3: Offscreen document (where browser events work reliably)\n * - MV2: Background page (where browser events work directly)\n *\n * This controller provides a centralized state for connectivity status,\n * enabling the UI and other controllers to adapt when the user goes offline.\n */\nexport class ConnectivityController extends BaseController<\n  typeof controllerName,\n  ConnectivityControllerState,\n  ConnectivityControllerMessenger\n> {\n  /**\n   * Constructs a new {@link ConnectivityController}.\n   *\n   * @param args - The arguments to this controller.\n   * @param args.messenger - The messenger suited for this controller.\n   * @param args.connectivityService - The connectivity service to use.\n   */\n  constructor({\n    messenger,\n    connectivityService,\n  }: ConnectivityControllerOptions) {\n    const initialStatus = connectivityService.getStatus();\n\n    super({\n      messenger,\n      metadata: connectivityControllerMetadata,\n      name: controllerName,\n      state: {\n        ...getDefaultConnectivityControllerState(),\n        connectivityStatus: initialStatus,\n      },\n    });\n\n    connectivityService.onConnectivityChange((status) => {\n      this.update((draftState) => {\n        draftState.connectivityStatus = status;\n      });\n    });\n  }\n}\n"]}

package/dist/index.cjs

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDefaultConnectivityControllerState = exports.ConnectivityController = exports.ConnectivityStatus = void 0;
+var types_1 = require("./types.cjs");
+Object.defineProperty(exports, "ConnectivityStatus", { enumerable: true, get: function () { return types_1.ConnectivityStatus; } });
+var ConnectivityController_1 = require("./ConnectivityController.cjs");
+Object.defineProperty(exports, "ConnectivityController", { enumerable: true, get: function () { return ConnectivityController_1.ConnectivityController; } });
+Object.defineProperty(exports, "getDefaultConnectivityControllerState", { enumerable: true, get: function () { return ConnectivityController_1.getDefaultConnectivityControllerState; } });
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AASA,qCAA6C;AAApC,2GAAA,kBAAkB,OAAA;AAC3B,uEAGkC;AAFhC,gIAAA,sBAAsB,OAAA;AACtB,+IAAA,qCAAqC,OAAA","sourcesContent":["export type {\n  ConnectivityControllerState,\n  ConnectivityControllerGetStateAction,\n  ConnectivityControllerActions,\n  ConnectivityControllerStateChangeEvent,\n  ConnectivityControllerEvents,\n  ConnectivityControllerMessenger,\n} from './ConnectivityController';\nexport type { ConnectivityService } from './types';\nexport { ConnectivityStatus } from './types';\nexport {\n  ConnectivityController,\n  getDefaultConnectivityControllerState,\n} from './ConnectivityController';\n"]}

package/dist/index.d.cts

@@ -0,0 +1,5 @@
+export type { ConnectivityControllerState, ConnectivityControllerGetStateAction, ConnectivityControllerActions, ConnectivityControllerStateChangeEvent, ConnectivityControllerEvents, ConnectivityControllerMessenger, } from "./ConnectivityController.cjs";
+export type { ConnectivityService } from "./types.cjs";
+export { ConnectivityStatus } from "./types.cjs";
+export { ConnectivityController, getDefaultConnectivityControllerState, } from "./ConnectivityController.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":"AAAA,YAAY,EACV,2BAA2B,EAC3B,oCAAoC,EACpC,6BAA6B,EAC7B,sCAAsC,EACtC,4BAA4B,EAC5B,+BAA+B,GAChC,qCAAiC;AAClC,YAAY,EAAE,mBAAmB,EAAE,oBAAgB;AACnD,OAAO,EAAE,kBAAkB,EAAE,oBAAgB;AAC7C,OAAO,EACL,sBAAsB,EACtB,qCAAqC,GACtC,qCAAiC"}

package/dist/index.d.mts

@@ -0,0 +1,5 @@
+export type { ConnectivityControllerState, ConnectivityControllerGetStateAction, ConnectivityControllerActions, ConnectivityControllerStateChangeEvent, ConnectivityControllerEvents, ConnectivityControllerMessenger, } from "./ConnectivityController.mjs";
+export type { ConnectivityService } from "./types.mjs";
+export { ConnectivityStatus } from "./types.mjs";
+export { ConnectivityController, getDefaultConnectivityControllerState, } from "./ConnectivityController.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":"AAAA,YAAY,EACV,2BAA2B,EAC3B,oCAAoC,EACpC,6BAA6B,EAC7B,sCAAsC,EACtC,4BAA4B,EAC5B,+BAA+B,GAChC,qCAAiC;AAClC,YAAY,EAAE,mBAAmB,EAAE,oBAAgB;AACnD,OAAO,EAAE,kBAAkB,EAAE,oBAAgB;AAC7C,OAAO,EACL,sBAAsB,EACtB,qCAAqC,GACtC,qCAAiC"}

package/dist/index.mjs

@@ -0,0 +1,3 @@
+export { ConnectivityStatus } from "./types.mjs";
+export { ConnectivityController, getDefaultConnectivityControllerState } from "./ConnectivityController.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":"AASA,OAAO,EAAE,kBAAkB,EAAE,oBAAgB;AAC7C,OAAO,EACL,sBAAsB,EACtB,qCAAqC,EACtC,qCAAiC","sourcesContent":["export type {\n  ConnectivityControllerState,\n  ConnectivityControllerGetStateAction,\n  ConnectivityControllerActions,\n  ConnectivityControllerStateChangeEvent,\n  ConnectivityControllerEvents,\n  ConnectivityControllerMessenger,\n} from './ConnectivityController';\nexport type { ConnectivityService } from './types';\nexport { ConnectivityStatus } from './types';\nexport {\n  ConnectivityController,\n  getDefaultConnectivityControllerState,\n} from './ConnectivityController';\n"]}

package/dist/types.cjs

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConnectivityStatus = void 0;
+/**
+ * Connectivity status constants.
+ * Used to represent whether the device has internet connectivity.
+ */
+exports.ConnectivityStatus = {
+    Online: 'online',
+    Offline: 'offline',
+};
+//# sourceMappingURL=types.cjs.map

package/dist/types.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.cjs","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACU,QAAA,kBAAkB,GAAG;IAChC,MAAM,EAAE,QAAQ;IAChB,OAAO,EAAE,SAAS;CACV,CAAC","sourcesContent":["/**\n * Connectivity status constants.\n * Used to represent whether the device has internet connectivity.\n */\nexport const ConnectivityStatus = {\n  Online: 'online',\n  Offline: 'offline',\n} as const;\n\nexport type ConnectivityStatus =\n  (typeof ConnectivityStatus)[keyof typeof ConnectivityStatus];\n\n/**\n * Service interface for platform-specific connectivity detection.\n *\n * Each platform (extension, mobile) implements this interface using\n * platform-specific APIs:\n * - Extension: `navigator.onLine` and `online`/`offline` events\n * - Mobile: `@react-native-community/netinfo`\n *\n * The service is injected into the ConnectivityController, which\n * subscribes to connectivity changes and updates its state accordingly.\n */\nexport type ConnectivityService = {\n  /**\n   * Returns the current connectivity status.\n   *\n   * @returns 'online' if the device is online, 'offline' otherwise.\n   */\n  getStatus(): ConnectivityStatus;\n\n  /**\n   * Registers a callback to be called when connectivity status changes.\n   *\n   * @param callback - Function called with 'online' when online, 'offline' when offline.\n   */\n  onConnectivityChange(callback: (status: ConnectivityStatus) => void): void;\n\n  /**\n   * Cleans up any resources (event listeners, subscriptions).\n   */\n  destroy(): void;\n};\n"]}

package/dist/types.d.cts

@@ -0,0 +1,39 @@
+/**
+ * Connectivity status constants.
+ * Used to represent whether the device has internet connectivity.
+ */
+export declare const ConnectivityStatus: {
+    readonly Online: "online";
+    readonly Offline: "offline";
+};
+export type ConnectivityStatus = (typeof ConnectivityStatus)[keyof typeof ConnectivityStatus];
+/**
+ * Service interface for platform-specific connectivity detection.
+ *
+ * Each platform (extension, mobile) implements this interface using
+ * platform-specific APIs:
+ * - Extension: `navigator.onLine` and `online`/`offline` events
+ * - Mobile: `@react-native-community/netinfo`
+ *
+ * The service is injected into the ConnectivityController, which
+ * subscribes to connectivity changes and updates its state accordingly.
+ */
+export type ConnectivityService = {
+    /**
+     * Returns the current connectivity status.
+     *
+     * @returns 'online' if the device is online, 'offline' otherwise.
+     */
+    getStatus(): ConnectivityStatus;
+    /**
+     * Registers a callback to be called when connectivity status changes.
+     *
+     * @param callback - Function called with 'online' when online, 'offline' when offline.
+     */
+    onConnectivityChange(callback: (status: ConnectivityStatus) => void): void;
+    /**
+     * Cleans up any resources (event listeners, subscriptions).
+     */
+    destroy(): void;
+};
+//# sourceMappingURL=types.d.cts.map

package/dist/types.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.cts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,eAAO,MAAM,kBAAkB;;;CAGrB,CAAC;AAEX,MAAM,MAAM,kBAAkB,GAC5B,CAAC,OAAO,kBAAkB,CAAC,CAAC,MAAM,OAAO,kBAAkB,CAAC,CAAC;AAE/D;;;;;;;;;;GAUG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;;;OAIG;IACH,SAAS,IAAI,kBAAkB,CAAC;IAEhC;;;;OAIG;IACH,oBAAoB,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,kBAAkB,KAAK,IAAI,GAAG,IAAI,CAAC;IAE3E;;OAEG;IACH,OAAO,IAAI,IAAI,CAAC;CACjB,CAAC"}

package/dist/types.d.mts

@@ -0,0 +1,39 @@
+/**
+ * Connectivity status constants.
+ * Used to represent whether the device has internet connectivity.
+ */
+export declare const ConnectivityStatus: {
+    readonly Online: "online";
+    readonly Offline: "offline";
+};
+export type ConnectivityStatus = (typeof ConnectivityStatus)[keyof typeof ConnectivityStatus];
+/**
+ * Service interface for platform-specific connectivity detection.
+ *
+ * Each platform (extension, mobile) implements this interface using
+ * platform-specific APIs:
+ * - Extension: `navigator.onLine` and `online`/`offline` events
+ * - Mobile: `@react-native-community/netinfo`
+ *
+ * The service is injected into the ConnectivityController, which
+ * subscribes to connectivity changes and updates its state accordingly.
+ */
+export type ConnectivityService = {
+    /**
+     * Returns the current connectivity status.
+     *
+     * @returns 'online' if the device is online, 'offline' otherwise.
+     */
+    getStatus(): ConnectivityStatus;
+    /**
+     * Registers a callback to be called when connectivity status changes.
+     *
+     * @param callback - Function called with 'online' when online, 'offline' when offline.
+     */
+    onConnectivityChange(callback: (status: ConnectivityStatus) => void): void;
+    /**
+     * Cleans up any resources (event listeners, subscriptions).
+     */
+    destroy(): void;
+};
+//# sourceMappingURL=types.d.mts.map

package/dist/types.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.mts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,eAAO,MAAM,kBAAkB;;;CAGrB,CAAC;AAEX,MAAM,MAAM,kBAAkB,GAC5B,CAAC,OAAO,kBAAkB,CAAC,CAAC,MAAM,OAAO,kBAAkB,CAAC,CAAC;AAE/D;;;;;;;;;;GAUG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;;;OAIG;IACH,SAAS,IAAI,kBAAkB,CAAC;IAEhC;;;;OAIG;IACH,oBAAoB,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,kBAAkB,KAAK,IAAI,GAAG,IAAI,CAAC;IAE3E;;OAEG;IACH,OAAO,IAAI,IAAI,CAAC;CACjB,CAAC"}

package/dist/types.mjs

@@ -0,0 +1,9 @@
+/**
+ * Connectivity status constants.
+ * Used to represent whether the device has internet connectivity.
+ */
+export const ConnectivityStatus = {
+    Online: 'online',
+    Offline: 'offline',
+};
+//# sourceMappingURL=types.mjs.map

package/dist/types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.mjs","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC,MAAM,EAAE,QAAQ;IAChB,OAAO,EAAE,SAAS;CACV,CAAC","sourcesContent":["/**\n * Connectivity status constants.\n * Used to represent whether the device has internet connectivity.\n */\nexport const ConnectivityStatus = {\n  Online: 'online',\n  Offline: 'offline',\n} as const;\n\nexport type ConnectivityStatus =\n  (typeof ConnectivityStatus)[keyof typeof ConnectivityStatus];\n\n/**\n * Service interface for platform-specific connectivity detection.\n *\n * Each platform (extension, mobile) implements this interface using\n * platform-specific APIs:\n * - Extension: `navigator.onLine` and `online`/`offline` events\n * - Mobile: `@react-native-community/netinfo`\n *\n * The service is injected into the ConnectivityController, which\n * subscribes to connectivity changes and updates its state accordingly.\n */\nexport type ConnectivityService = {\n  /**\n   * Returns the current connectivity status.\n   *\n   * @returns 'online' if the device is online, 'offline' otherwise.\n   */\n  getStatus(): ConnectivityStatus;\n\n  /**\n   * Registers a callback to be called when connectivity status changes.\n   *\n   * @param callback - Function called with 'online' when online, 'offline' when offline.\n   */\n  onConnectivityChange(callback: (status: ConnectivityStatus) => void): void;\n\n  /**\n   * Cleans up any resources (event listeners, subscriptions).\n   */\n  destroy(): void;\n};\n"]}

package/package.json

@@ -0,0 +1,72 @@
+{
+  "name": "@metamask-previews/connectivity-controller",
+  "version": "0.0.0-preview-9e00b40b",
+  "description": "ConnectivityController stores the device's internet connectivity status",
+  "keywords": [
+    "MetaMask",
+    "Ethereum"
+  ],
+  "homepage": "https://github.com/MetaMask/core/tree/main/packages/connectivity-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/connectivity-controller",
+    "changelog:validate": "../../scripts/validate-changelog.sh @metamask/connectivity-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"
+  },
+  "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.3.3"
+  },
+  "engines": {
+    "node": "^18.18 || >=20"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}