@metamask-previews/core-backend 4.1.0-preview-fa19a4d3 → 4.1.0-preview-96f3a4d7

package/dist/BackendWebSocketService-method-action-types.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"BackendWebSocketService-method-action-types.cjs","sourceRoot":"","sources":["../src/BackendWebSocketService-method-action-types.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated by `scripts/generate-method-action-types.ts`.\n * Do not edit manually.\n */\n\nimport type { BackendWebSocketService } from './BackendWebSocketService';\n\n/**\n * Establishes WebSocket connection with smart reconnection behavior\n *\n * Connection Requirements (all must be true):\n * 1. Feature enabled (isEnabled() = true)\n * 2. Wallet unlocked (checked by getBearerToken)\n * 3. User signed in (checked by getBearerToken)\n *\n * Platform code should call this when app opens/foregrounds.\n * Automatically called on KeyringController:unlock event.\n *\n * @returns Promise that resolves when connection is established\n */\nexport type BackendWebSocketServiceConnectAction = {\n  type: `BackendWebSocketService:connect`;\n  handler: BackendWebSocketService['connect'];\n};\n\n/**\n * Closes WebSocket connection\n */\nexport type BackendWebSocketServiceDisconnectAction = {\n  type: `BackendWebSocketService:disconnect`;\n  handler: BackendWebSocketService['disconnect'];\n};\n\n/**\n * Forces a WebSocket reconnection to clean up subscription state\n *\n * This method is useful when subscription state may be out of sync and needs to be reset.\n * It performs a controlled disconnect-then-reconnect sequence:\n * - Disconnects cleanly to trigger subscription cleanup\n * - Schedules reconnection with exponential backoff to prevent rapid loops\n * - All subscriptions will be cleaned up automatically on disconnect\n *\n * Use cases:\n * - Recovering from subscription/unsubscription issues\n * - Cleaning up orphaned subscriptions\n * - Forcing a fresh subscription state\n *\n * @returns Promise that resolves when disconnection is complete (reconnection is scheduled)\n */\nexport type BackendWebSocketServiceForceReconnectionAction = {\n  type: `BackendWebSocketService:forceReconnection`;\n  handler: BackendWebSocketService['forceReconnection'];\n};\n\n/**\n * Sends a message through the WebSocket (fire-and-forget, no response expected)\n *\n * This is a low-level method for sending messages without waiting for a response.\n * Most consumers should use `sendRequest()` instead, which handles request-response\n * correlation and provides proper error handling with timeouts.\n *\n * Use this method only when:\n * - You don't need a response from the server\n * - You're implementing custom message protocols\n * - You need fine-grained control over message timing\n *\n * @param message - The message to send\n * @throws Error if WebSocket is not connected or send fails\n *\n * @see sendRequest for request-response pattern with automatic correlation\n */\nexport type BackendWebSocketServiceSendMessageAction = {\n  type: `BackendWebSocketService:sendMessage`;\n  handler: BackendWebSocketService['sendMessage'];\n};\n\n/**\n * Sends a request and waits for a correlated response (recommended for most use cases)\n *\n * This is the recommended high-level method for request-response communication.\n * It automatically handles:\n * - Request ID generation and correlation\n * - Response matching with timeout protection\n * - Automatic reconnection on timeout\n * - Proper cleanup of pending requests\n *\n * @param message - The request message (can include optional requestId for testing)\n * @returns Promise that resolves with the response data\n * @throws Error if WebSocket is not connected, request times out, or response indicates failure\n *\n * @see sendMessage for fire-and-forget messaging without response handling\n */\nexport type BackendWebSocketServiceSendRequestAction = {\n  type: `BackendWebSocketService:sendRequest`;\n  handler: BackendWebSocketService['sendRequest'];\n};\n\n/**\n * Gets current connection information\n *\n * @returns Current connection status and details\n */\nexport type BackendWebSocketServiceGetConnectionInfoAction = {\n  type: `BackendWebSocketService:getConnectionInfo`;\n  handler: BackendWebSocketService['getConnectionInfo'];\n};\n\n/**\n * Gets all subscription information for a specific channel\n *\n * @param channel - The channel name to look up\n * @returns Array of subscription details for all subscriptions containing the channel\n */\nexport type BackendWebSocketServiceGetSubscriptionsByChannelAction = {\n  type: `BackendWebSocketService:getSubscriptionsByChannel`;\n  handler: BackendWebSocketService['getSubscriptionsByChannel'];\n};\n\n/**\n * Checks if a channel has a subscription\n *\n * @param channel - The channel name to check\n * @returns True if the channel has a subscription, false otherwise\n */\nexport type BackendWebSocketServiceChannelHasSubscriptionAction = {\n  type: `BackendWebSocketService:channelHasSubscription`;\n  handler: BackendWebSocketService['channelHasSubscription'];\n};\n\n/**\n * Finds all subscriptions that have channels starting with the specified prefix\n *\n * @param channelPrefix - The channel prefix to search for (e.g., \"account-activity.v1\")\n * @returns Array of subscription info for matching subscriptions\n */\nexport type BackendWebSocketServiceFindSubscriptionsByChannelPrefixAction = {\n  type: `BackendWebSocketService:findSubscriptionsByChannelPrefix`;\n  handler: BackendWebSocketService['findSubscriptionsByChannelPrefix'];\n};\n\n/**\n * Register a callback for specific channels (local callback only, no server subscription)\n *\n * **Key Difference from `subscribe()`:**\n * - `addChannelCallback()`: Registers a local callback without creating a server-side subscription.\n * The callback triggers on ANY message matching the channel name, regardless of subscriptionId.\n * Useful for system-wide notifications or when you don't control the subscription lifecycle.\n *\n * - `subscribe()`: Creates a proper server-side subscription with a subscriptionId.\n * The callback only triggers for messages with the matching subscriptionId.\n * Includes proper lifecycle management (unsubscribe, automatic cleanup on disconnect).\n *\n * **When to use `addChannelCallback()`:**\n * - Listening to system-wide notifications (e.g., 'system-notifications.v1')\n * - Monitoring channels where subscriptions are managed elsewhere\n * - Debug/logging scenarios where you want to observe all channel messages\n *\n * **When to use `subscribe()` instead:**\n * - Creating new subscriptions that need server-side registration\n * - When you need proper cleanup via unsubscribe\n * - Most application use cases (recommended approach)\n *\n * @param options - Channel callback configuration\n * @param options.channelName - Channel name to match exactly\n * @param options.callback - Function to call when channel matches\n *\n * @example\n * ```typescript\n * // Listen to system notifications (no server subscription needed)\n * webSocketService.addChannelCallback({\n * channelName: 'system-notifications.v1',\n * callback: (notification) => {\n * console.log('System notification:', notification.data);\n * }\n * });\n *\n * // For account-specific subscriptions, use subscribe() instead:\n * // const sub = await webSocketService.subscribe({\n * //   channels: ['account-activity.v1.eip155:0:0x1234...'],\n * //   callback: (notification) => { ... }\n * // });\n * ```\n *\n * @see subscribe for creating proper server-side subscriptions with lifecycle management\n */\nexport type BackendWebSocketServiceAddChannelCallbackAction = {\n  type: `BackendWebSocketService:addChannelCallback`;\n  handler: BackendWebSocketService['addChannelCallback'];\n};\n\n/**\n * Remove a channel callback\n *\n * @param channelName - The channel name returned from addChannelCallback\n * @returns True if callback was found and removed, false otherwise\n */\nexport type BackendWebSocketServiceRemoveChannelCallbackAction = {\n  type: `BackendWebSocketService:removeChannelCallback`;\n  handler: BackendWebSocketService['removeChannelCallback'];\n};\n\n/**\n * Get all registered channel callbacks (for debugging)\n *\n * @returns Array of all registered channel callbacks\n */\nexport type BackendWebSocketServiceGetChannelCallbacksAction = {\n  type: `BackendWebSocketService:getChannelCallbacks`;\n  handler: BackendWebSocketService['getChannelCallbacks'];\n};\n\n/**\n * Create and manage a subscription with server-side registration (recommended for most use cases)\n *\n * This is the recommended subscription API for high-level services. It creates a proper\n * server-side subscription and routes notifications based on subscriptionId.\n *\n * **Key Features:**\n * - Creates server-side subscription with unique subscriptionId\n * - Callback triggered only for messages with matching subscriptionId\n * - Automatic lifecycle management (cleanup on disconnect)\n * - Includes unsubscribe method for proper cleanup\n * - Request-response pattern with error handling\n *\n * **When to use `subscribe()`:**\n * - Creating new subscriptions (account activity, price updates, etc.)\n * - When you need proper cleanup/unsubscribe functionality\n * - Most application use cases\n *\n * **When to use `addChannelCallback()` instead:**\n * - System-wide notifications without server-side subscription\n * - Observing channels managed elsewhere\n * - Debug/logging scenarios\n *\n * @param options - Subscription configuration\n * @param options.channels - Array of channel names to subscribe to\n * @param options.callback - Callback function for handling notifications\n * @param options.requestId - Optional request ID for testing (will generate UUID if not provided)\n * @param options.channelType - Channel type identifier\n * @returns Subscription object with unsubscribe method\n *\n * @example\n * ```typescript\n * // AccountActivityService usage\n * const subscription = await webSocketService.subscribe({\n * channels: ['account-activity.v1.eip155:0:0x1234...'],\n * callback: (notification) => {\n * this.handleAccountActivity(notification.data);\n * }\n * });\n *\n * // Later, clean up\n * await subscription.unsubscribe();\n * ```\n *\n * @see addChannelCallback for local callbacks without server-side subscription\n */\nexport type BackendWebSocketServiceSubscribeAction = {\n  type: `BackendWebSocketService:subscribe`;\n  handler: BackendWebSocketService['subscribe'];\n};\n\n/**\n * Union of all BackendWebSocketService action types.\n */\nexport type BackendWebSocketServiceMethodActions =\n  | BackendWebSocketServiceConnectAction\n  | BackendWebSocketServiceDisconnectAction\n  | BackendWebSocketServiceForceReconnectionAction\n  | BackendWebSocketServiceSendMessageAction\n  | BackendWebSocketServiceSendRequestAction\n  | BackendWebSocketServiceGetConnectionInfoAction\n  | BackendWebSocketServiceGetSubscriptionsByChannelAction\n  | BackendWebSocketServiceChannelHasSubscriptionAction\n  | BackendWebSocketServiceFindSubscriptionsByChannelPrefixAction\n  | BackendWebSocketServiceAddChannelCallbackAction\n  | BackendWebSocketServiceRemoveChannelCallbackAction\n  | BackendWebSocketServiceGetChannelCallbacksAction\n  | BackendWebSocketServiceSubscribeAction;\n"]}
+{"version":3,"file":"BackendWebSocketService-method-action-types.cjs","sourceRoot":"","sources":["../src/BackendWebSocketService-method-action-types.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated by `scripts/generate-method-action-types.ts`.\n * Do not edit manually.\n */\n\nimport type { BackendWebSocketService } from './BackendWebSocketService';\n\n/**\n * Establishes WebSocket connection\n *\n * @returns Promise that resolves when connection is established\n */\nexport type BackendWebSocketServiceConnectAction = {\n  type: `BackendWebSocketService:connect`;\n  handler: BackendWebSocketService['connect'];\n};\n\n/**\n * Closes WebSocket connection\n *\n * @returns Promise that resolves when disconnection is complete\n */\nexport type BackendWebSocketServiceDisconnectAction = {\n  type: `BackendWebSocketService:disconnect`;\n  handler: BackendWebSocketService['disconnect'];\n};\n\n/**\n * Forces a WebSocket reconnection to clean up subscription state\n *\n * This method is useful when subscription state may be out of sync and needs to be reset.\n * It performs a controlled disconnect-then-reconnect sequence:\n * - Disconnects cleanly to trigger subscription cleanup\n * - Schedules reconnection with exponential backoff to prevent rapid loops\n * - All subscriptions will be cleaned up automatically on disconnect\n *\n * Use cases:\n * - Recovering from subscription/unsubscription issues\n * - Cleaning up orphaned subscriptions\n * - Forcing a fresh subscription state\n *\n * @returns Promise that resolves when disconnection is complete (reconnection is scheduled)\n */\nexport type BackendWebSocketServiceForceReconnectionAction = {\n  type: `BackendWebSocketService:forceReconnection`;\n  handler: BackendWebSocketService['forceReconnection'];\n};\n\n/**\n * Sends a message through the WebSocket\n *\n * @param message - The message to send\n * @returns Promise that resolves when message is sent\n */\nexport type BackendWebSocketServiceSendMessageAction = {\n  type: `BackendWebSocketService:sendMessage`;\n  handler: BackendWebSocketService['sendMessage'];\n};\n\n/**\n * Sends a request and waits for a correlated response\n *\n * @param message - The request message\n * @returns Promise that resolves with the response data\n */\nexport type BackendWebSocketServiceSendRequestAction = {\n  type: `BackendWebSocketService:sendRequest`;\n  handler: BackendWebSocketService['sendRequest'];\n};\n\n/**\n * Gets current connection information\n *\n * @returns Current connection status and details\n */\nexport type BackendWebSocketServiceGetConnectionInfoAction = {\n  type: `BackendWebSocketService:getConnectionInfo`;\n  handler: BackendWebSocketService['getConnectionInfo'];\n};\n\n/**\n * Gets all subscription information for a specific channel\n *\n * @param channel - The channel name to look up\n * @returns Array of subscription details for all subscriptions containing the channel\n */\nexport type BackendWebSocketServiceGetSubscriptionsByChannelAction = {\n  type: `BackendWebSocketService:getSubscriptionsByChannel`;\n  handler: BackendWebSocketService['getSubscriptionsByChannel'];\n};\n\n/**\n * Checks if a channel has a subscription\n *\n * @param channel - The channel name to check\n * @returns True if the channel has a subscription, false otherwise\n */\nexport type BackendWebSocketServiceChannelHasSubscriptionAction = {\n  type: `BackendWebSocketService:channelHasSubscription`;\n  handler: BackendWebSocketService['channelHasSubscription'];\n};\n\n/**\n * Finds all subscriptions that have channels starting with the specified prefix\n *\n * @param channelPrefix - The channel prefix to search for (e.g., \"account-activity.v1\")\n * @returns Array of subscription info for matching subscriptions\n */\nexport type BackendWebSocketServiceFindSubscriptionsByChannelPrefixAction = {\n  type: `BackendWebSocketService:findSubscriptionsByChannelPrefix`;\n  handler: BackendWebSocketService['findSubscriptionsByChannelPrefix'];\n};\n\n/**\n * Register a callback for specific channels\n *\n * @param options - Channel callback configuration\n * @param options.channelName - Channel name to match exactly\n * @param options.callback - Function to call when channel matches\n *\n * @example\n * ```typescript\n * // Listen to specific account activity channel\n * webSocketService.addChannelCallback({\n * channelName: 'account-activity.v1.eip155:0:0x1234...',\n * callback: (notification) => {\n * console.log('Account activity:', notification.data);\n * }\n * });\n *\n * // Listen to system notifications channel\n * webSocketService.addChannelCallback({\n * channelName: 'system-notifications.v1',\n * callback: (notification) => {\n * console.log('System notification:', notification.data);\n * }\n * });\n * ```\n */\nexport type BackendWebSocketServiceAddChannelCallbackAction = {\n  type: `BackendWebSocketService:addChannelCallback`;\n  handler: BackendWebSocketService['addChannelCallback'];\n};\n\n/**\n * Remove a channel callback\n *\n * @param channelName - The channel name to remove callback for\n * @returns True if callback was found and removed, false otherwise\n */\nexport type BackendWebSocketServiceRemoveChannelCallbackAction = {\n  type: `BackendWebSocketService:removeChannelCallback`;\n  handler: BackendWebSocketService['removeChannelCallback'];\n};\n\n/**\n * Get all registered channel callbacks (for debugging)\n */\nexport type BackendWebSocketServiceGetChannelCallbacksAction = {\n  type: `BackendWebSocketService:getChannelCallbacks`;\n  handler: BackendWebSocketService['getChannelCallbacks'];\n};\n\n/**\n * Create and manage a subscription with direct callback routing\n *\n * @param options - Subscription configuration\n * @param options.channels - Array of channel names to subscribe to\n * @param options.callback - Callback function for handling notifications\n * @returns Promise that resolves with subscription object containing unsubscribe method\n */\nexport type BackendWebSocketServiceSubscribeAction = {\n  type: `BackendWebSocketService:subscribe`;\n  handler: BackendWebSocketService['subscribe'];\n};\n\n/**\n * Union of all BackendWebSocketService action types.\n */\nexport type BackendWebSocketServiceMethodActions =\n  | BackendWebSocketServiceConnectAction\n  | BackendWebSocketServiceDisconnectAction\n  | BackendWebSocketServiceForceReconnectionAction\n  | BackendWebSocketServiceSendMessageAction\n  | BackendWebSocketServiceSendRequestAction\n  | BackendWebSocketServiceGetConnectionInfoAction\n  | BackendWebSocketServiceGetSubscriptionsByChannelAction\n  | BackendWebSocketServiceChannelHasSubscriptionAction\n  | BackendWebSocketServiceFindSubscriptionsByChannelPrefixAction\n  | BackendWebSocketServiceAddChannelCallbackAction\n  | BackendWebSocketServiceRemoveChannelCallbackAction\n  | BackendWebSocketServiceGetChannelCallbacksAction\n  | BackendWebSocketServiceSubscribeAction;\n"]}

package/dist/BackendWebSocketService-method-action-types.d.cts

@@ -4,15 +4,7 @@
  */
 import type { BackendWebSocketService } from "./BackendWebSocketService.cjs";
 /**
- * Establishes WebSocket connection with smart reconnection behavior
- *
- * Connection Requirements (all must be true):
- * 1. Feature enabled (isEnabled() = true)
- * 2. Wallet unlocked (checked by getBearerToken)
- * 3. User signed in (checked by getBearerToken)
- *
- * Platform code should call this when app opens/foregrounds.
- * Automatically called on KeyringController:unlock event.
+ * Establishes WebSocket connection
  *
  * @returns Promise that resolves when connection is established
  */
@@ -22,6 +14,8 @@ export type BackendWebSocketServiceConnectAction = {
 };
 /**
  * Closes WebSocket connection
+ *
+ * @returns Promise that resolves when disconnection is complete
  */
 export type BackendWebSocketServiceDisconnectAction = {
     type: `BackendWebSocketService:disconnect`;
@@ -48,41 +42,20 @@ export type BackendWebSocketServiceForceReconnectionAction = {
     handler: BackendWebSocketService['forceReconnection'];
 };
 /**
- * Sends a message through the WebSocket (fire-and-forget, no response expected)
- *
- * This is a low-level method for sending messages without waiting for a response.
- * Most consumers should use `sendRequest()` instead, which handles request-response
- * correlation and provides proper error handling with timeouts.
- *
- * Use this method only when:
- * - You don't need a response from the server
- * - You're implementing custom message protocols
- * - You need fine-grained control over message timing
+ * Sends a message through the WebSocket
  *
  * @param message - The message to send
- * @throws Error if WebSocket is not connected or send fails
- *
- * @see sendRequest for request-response pattern with automatic correlation
+ * @returns Promise that resolves when message is sent
  */
 export type BackendWebSocketServiceSendMessageAction = {
     type: `BackendWebSocketService:sendMessage`;
     handler: BackendWebSocketService['sendMessage'];
 };
 /**
- * Sends a request and waits for a correlated response (recommended for most use cases)
- *
- * This is the recommended high-level method for request-response communication.
- * It automatically handles:
- * - Request ID generation and correlation
- * - Response matching with timeout protection
- * - Automatic reconnection on timeout
- * - Proper cleanup of pending requests
+ * Sends a request and waits for a correlated response
  *
- * @param message - The request message (can include optional requestId for testing)
+ * @param message - The request message
  * @returns Promise that resolves with the response data
- * @throws Error if WebSocket is not connected, request times out, or response indicates failure
- *
- * @see sendMessage for fire-and-forget messaging without response handling
  */
 export type BackendWebSocketServiceSendRequestAction = {
     type: `BackendWebSocketService:sendRequest`;
@@ -128,26 +101,7 @@ export type BackendWebSocketServiceFindSubscriptionsByChannelPrefixAction = {
     handler: BackendWebSocketService['findSubscriptionsByChannelPrefix'];
 };
 /**
- * Register a callback for specific channels (local callback only, no server subscription)
- *
- * **Key Difference from `subscribe()`:**
- * - `addChannelCallback()`: Registers a local callback without creating a server-side subscription.
- * The callback triggers on ANY message matching the channel name, regardless of subscriptionId.
- * Useful for system-wide notifications or when you don't control the subscription lifecycle.
- *
- * - `subscribe()`: Creates a proper server-side subscription with a subscriptionId.
- * The callback only triggers for messages with the matching subscriptionId.
- * Includes proper lifecycle management (unsubscribe, automatic cleanup on disconnect).
- *
- * **When to use `addChannelCallback()`:**
- * - Listening to system-wide notifications (e.g., 'system-notifications.v1')
- * - Monitoring channels where subscriptions are managed elsewhere
- * - Debug/logging scenarios where you want to observe all channel messages
- *
- * **When to use `subscribe()` instead:**
- * - Creating new subscriptions that need server-side registration
- * - When you need proper cleanup via unsubscribe
- * - Most application use cases (recommended approach)
+ * Register a callback for specific channels
  *
  * @param options - Channel callback configuration
  * @param options.channelName - Channel name to match exactly
@@ -155,22 +109,22 @@ export type BackendWebSocketServiceFindSubscriptionsByChannelPrefixAction = {
  *
  * @example
  * ```typescript
- * // Listen to system notifications (no server subscription needed)
+ * // Listen to specific account activity channel
+ * webSocketService.addChannelCallback({
+ * channelName: 'account-activity.v1.eip155:0:0x1234...',
+ * callback: (notification) => {
+ * console.log('Account activity:', notification.data);
+ * }
+ * });
+ *
+ * // Listen to system notifications channel
  * webSocketService.addChannelCallback({
  * channelName: 'system-notifications.v1',
  * callback: (notification) => {
  * console.log('System notification:', notification.data);
  * }
  * });
- *
- * // For account-specific subscriptions, use subscribe() instead:
- * // const sub = await webSocketService.subscribe({
- * //   channels: ['account-activity.v1.eip155:0:0x1234...'],
- * //   callback: (notification) => { ... }
- * // });
  * ```
- *
- * @see subscribe for creating proper server-side subscriptions with lifecycle management
  */
 export type BackendWebSocketServiceAddChannelCallbackAction = {
     type: `BackendWebSocketService:addChannelCallback`;
@@ -179,7 +133,7 @@ export type BackendWebSocketServiceAddChannelCallbackAction = {
 /**
  * Remove a channel callback
  *
- * @param channelName - The channel name returned from addChannelCallback
+ * @param channelName - The channel name to remove callback for
  * @returns True if callback was found and removed, false otherwise
  */
 export type BackendWebSocketServiceRemoveChannelCallbackAction = {
@@ -188,58 +142,18 @@ export type BackendWebSocketServiceRemoveChannelCallbackAction = {
 };
 /**
  * Get all registered channel callbacks (for debugging)
- *
- * @returns Array of all registered channel callbacks
  */
 export type BackendWebSocketServiceGetChannelCallbacksAction = {
     type: `BackendWebSocketService:getChannelCallbacks`;
     handler: BackendWebSocketService['getChannelCallbacks'];
 };
 /**
- * Create and manage a subscription with server-side registration (recommended for most use cases)
- *
- * This is the recommended subscription API for high-level services. It creates a proper
- * server-side subscription and routes notifications based on subscriptionId.
- *
- * **Key Features:**
- * - Creates server-side subscription with unique subscriptionId
- * - Callback triggered only for messages with matching subscriptionId
- * - Automatic lifecycle management (cleanup on disconnect)
- * - Includes unsubscribe method for proper cleanup
- * - Request-response pattern with error handling
- *
- * **When to use `subscribe()`:**
- * - Creating new subscriptions (account activity, price updates, etc.)
- * - When you need proper cleanup/unsubscribe functionality
- * - Most application use cases
- *
- * **When to use `addChannelCallback()` instead:**
- * - System-wide notifications without server-side subscription
- * - Observing channels managed elsewhere
- * - Debug/logging scenarios
+ * Create and manage a subscription with direct callback routing
  *
  * @param options - Subscription configuration
  * @param options.channels - Array of channel names to subscribe to
  * @param options.callback - Callback function for handling notifications
- * @param options.requestId - Optional request ID for testing (will generate UUID if not provided)
- * @param options.channelType - Channel type identifier
- * @returns Subscription object with unsubscribe method
- *
- * @example
- * ```typescript
- * // AccountActivityService usage
- * const subscription = await webSocketService.subscribe({
- * channels: ['account-activity.v1.eip155:0:0x1234...'],
- * callback: (notification) => {
- * this.handleAccountActivity(notification.data);
- * }
- * });
- *
- * // Later, clean up
- * await subscription.unsubscribe();
- * ```
- *
- * @see addChannelCallback for local callbacks without server-side subscription
+ * @returns Promise that resolves with subscription object containing unsubscribe method
  */
 export type BackendWebSocketServiceSubscribeAction = {
     type: `BackendWebSocketService:subscribe`;

package/dist/BackendWebSocketService-method-action-types.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"BackendWebSocketService-method-action-types.d.cts","sourceRoot":"","sources":["../src/BackendWebSocketService-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,uBAAuB,EAAE,sCAAkC;AAEzE;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,oCAAoC,GAAG;IACjD,IAAI,EAAE,iCAAiC,CAAC;IACxC,OAAO,EAAE,uBAAuB,CAAC,SAAS,CAAC,CAAC;CAC7C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uCAAuC,GAAG;IACpD,IAAI,EAAE,oCAAoC,CAAC;IAC3C,OAAO,EAAE,uBAAuB,CAAC,YAAY,CAAC,CAAC;CAChD,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,8CAA8C,GAAG;IAC3D,IAAI,EAAE,2CAA2C,CAAC;IAClD,OAAO,EAAE,uBAAuB,CAAC,mBAAmB,CAAC,CAAC;CACvD,CAAC;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,MAAM,wCAAwC,GAAG;IACrD,IAAI,EAAE,qCAAqC,CAAC;IAC5C,OAAO,EAAE,uBAAuB,CAAC,aAAa,CAAC,CAAC;CACjD,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,wCAAwC,GAAG;IACrD,IAAI,EAAE,qCAAqC,CAAC;IAC5C,OAAO,EAAE,uBAAuB,CAAC,aAAa,CAAC,CAAC;CACjD,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,8CAA8C,GAAG;IAC3D,IAAI,EAAE,2CAA2C,CAAC;IAClD,OAAO,EAAE,uBAAuB,CAAC,mBAAmB,CAAC,CAAC;CACvD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,sDAAsD,GAAG;IACnE,IAAI,EAAE,mDAAmD,CAAC;IAC1D,OAAO,EAAE,uBAAuB,CAAC,2BAA2B,CAAC,CAAC;CAC/D,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,mDAAmD,GAAG;IAChE,IAAI,EAAE,gDAAgD,CAAC;IACvD,OAAO,EAAE,uBAAuB,CAAC,wBAAwB,CAAC,CAAC;CAC5D,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,6DAA6D,GAAG;IAC1E,IAAI,EAAE,0DAA0D,CAAC;IACjE,OAAO,EAAE,uBAAuB,CAAC,kCAAkC,CAAC,CAAC;CACtE,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,MAAM,MAAM,+CAA+C,GAAG;IAC5D,IAAI,EAAE,4CAA4C,CAAC;IACnD,OAAO,EAAE,uBAAuB,CAAC,oBAAoB,CAAC,CAAC;CACxD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,kDAAkD,GAAG;IAC/D,IAAI,EAAE,+CAA+C,CAAC;IACtD,OAAO,EAAE,uBAAuB,CAAC,uBAAuB,CAAC,CAAC;CAC3D,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,gDAAgD,GAAG;IAC7D,IAAI,EAAE,6CAA6C,CAAC;IACpD,OAAO,EAAE,uBAAuB,CAAC,qBAAqB,CAAC,CAAC;CACzD,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,MAAM,MAAM,sCAAsC,GAAG;IACnD,IAAI,EAAE,mCAAmC,CAAC;IAC1C,OAAO,EAAE,uBAAuB,CAAC,WAAW,CAAC,CAAC;CAC/C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oCAAoC,GAC5C,oCAAoC,GACpC,uCAAuC,GACvC,8CAA8C,GAC9C,wCAAwC,GACxC,wCAAwC,GACxC,8CAA8C,GAC9C,sDAAsD,GACtD,mDAAmD,GACnD,6DAA6D,GAC7D,+CAA+C,GAC/C,kDAAkD,GAClD,gDAAgD,GAChD,sCAAsC,CAAC"}
+{"version":3,"file":"BackendWebSocketService-method-action-types.d.cts","sourceRoot":"","sources":["../src/BackendWebSocketService-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,uBAAuB,EAAE,sCAAkC;AAEzE;;;;GAIG;AACH,MAAM,MAAM,oCAAoC,GAAG;IACjD,IAAI,EAAE,iCAAiC,CAAC;IACxC,OAAO,EAAE,uBAAuB,CAAC,SAAS,CAAC,CAAC;CAC7C,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,uCAAuC,GAAG;IACpD,IAAI,EAAE,oCAAoC,CAAC;IAC3C,OAAO,EAAE,uBAAuB,CAAC,YAAY,CAAC,CAAC;CAChD,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,8CAA8C,GAAG;IAC3D,IAAI,EAAE,2CAA2C,CAAC;IAClD,OAAO,EAAE,uBAAuB,CAAC,mBAAmB,CAAC,CAAC;CACvD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,wCAAwC,GAAG;IACrD,IAAI,EAAE,qCAAqC,CAAC;IAC5C,OAAO,EAAE,uBAAuB,CAAC,aAAa,CAAC,CAAC;CACjD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,wCAAwC,GAAG;IACrD,IAAI,EAAE,qCAAqC,CAAC;IAC5C,OAAO,EAAE,uBAAuB,CAAC,aAAa,CAAC,CAAC;CACjD,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,8CAA8C,GAAG;IAC3D,IAAI,EAAE,2CAA2C,CAAC;IAClD,OAAO,EAAE,uBAAuB,CAAC,mBAAmB,CAAC,CAAC;CACvD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,sDAAsD,GAAG;IACnE,IAAI,EAAE,mDAAmD,CAAC;IAC1D,OAAO,EAAE,uBAAuB,CAAC,2BAA2B,CAAC,CAAC;CAC/D,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,mDAAmD,GAAG;IAChE,IAAI,EAAE,gDAAgD,CAAC;IACvD,OAAO,EAAE,uBAAuB,CAAC,wBAAwB,CAAC,CAAC;CAC5D,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,6DAA6D,GAAG;IAC1E,IAAI,EAAE,0DAA0D,CAAC;IACjE,OAAO,EAAE,uBAAuB,CAAC,kCAAkC,CAAC,CAAC;CACtE,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,MAAM,+CAA+C,GAAG;IAC5D,IAAI,EAAE,4CAA4C,CAAC;IACnD,OAAO,EAAE,uBAAuB,CAAC,oBAAoB,CAAC,CAAC;CACxD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,kDAAkD,GAAG;IAC/D,IAAI,EAAE,+CAA+C,CAAC;IACtD,OAAO,EAAE,uBAAuB,CAAC,uBAAuB,CAAC,CAAC;CAC3D,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gDAAgD,GAAG;IAC7D,IAAI,EAAE,6CAA6C,CAAC;IACpD,OAAO,EAAE,uBAAuB,CAAC,qBAAqB,CAAC,CAAC;CACzD,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,sCAAsC,GAAG;IACnD,IAAI,EAAE,mCAAmC,CAAC;IAC1C,OAAO,EAAE,uBAAuB,CAAC,WAAW,CAAC,CAAC;CAC/C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oCAAoC,GAC5C,oCAAoC,GACpC,uCAAuC,GACvC,8CAA8C,GAC9C,wCAAwC,GACxC,wCAAwC,GACxC,8CAA8C,GAC9C,sDAAsD,GACtD,mDAAmD,GACnD,6DAA6D,GAC7D,+CAA+C,GAC/C,kDAAkD,GAClD,gDAAgD,GAChD,sCAAsC,CAAC"}

package/dist/BackendWebSocketService-method-action-types.d.mts

@@ -4,15 +4,7 @@
  */
 import type { BackendWebSocketService } from "./BackendWebSocketService.mjs";
 /**
- * Establishes WebSocket connection with smart reconnection behavior
- *
- * Connection Requirements (all must be true):
- * 1. Feature enabled (isEnabled() = true)
- * 2. Wallet unlocked (checked by getBearerToken)
- * 3. User signed in (checked by getBearerToken)
- *
- * Platform code should call this when app opens/foregrounds.
- * Automatically called on KeyringController:unlock event.
+ * Establishes WebSocket connection
  *
  * @returns Promise that resolves when connection is established
  */
@@ -22,6 +14,8 @@ export type BackendWebSocketServiceConnectAction = {
 };
 /**
  * Closes WebSocket connection
+ *
+ * @returns Promise that resolves when disconnection is complete
  */
 export type BackendWebSocketServiceDisconnectAction = {
     type: `BackendWebSocketService:disconnect`;
@@ -48,41 +42,20 @@ export type BackendWebSocketServiceForceReconnectionAction = {
     handler: BackendWebSocketService['forceReconnection'];
 };
 /**
- * Sends a message through the WebSocket (fire-and-forget, no response expected)
- *
- * This is a low-level method for sending messages without waiting for a response.
- * Most consumers should use `sendRequest()` instead, which handles request-response
- * correlation and provides proper error handling with timeouts.
- *
- * Use this method only when:
- * - You don't need a response from the server
- * - You're implementing custom message protocols
- * - You need fine-grained control over message timing
+ * Sends a message through the WebSocket
  *
  * @param message - The message to send
- * @throws Error if WebSocket is not connected or send fails
- *
- * @see sendRequest for request-response pattern with automatic correlation
+ * @returns Promise that resolves when message is sent
  */
 export type BackendWebSocketServiceSendMessageAction = {
     type: `BackendWebSocketService:sendMessage`;
     handler: BackendWebSocketService['sendMessage'];
 };
 /**
- * Sends a request and waits for a correlated response (recommended for most use cases)
- *
- * This is the recommended high-level method for request-response communication.
- * It automatically handles:
- * - Request ID generation and correlation
- * - Response matching with timeout protection
- * - Automatic reconnection on timeout
- * - Proper cleanup of pending requests
+ * Sends a request and waits for a correlated response
  *
- * @param message - The request message (can include optional requestId for testing)
+ * @param message - The request message
  * @returns Promise that resolves with the response data
- * @throws Error if WebSocket is not connected, request times out, or response indicates failure
- *
- * @see sendMessage for fire-and-forget messaging without response handling
  */
 export type BackendWebSocketServiceSendRequestAction = {
     type: `BackendWebSocketService:sendRequest`;
@@ -128,26 +101,7 @@ export type BackendWebSocketServiceFindSubscriptionsByChannelPrefixAction = {
     handler: BackendWebSocketService['findSubscriptionsByChannelPrefix'];
 };
 /**
- * Register a callback for specific channels (local callback only, no server subscription)
- *
- * **Key Difference from `subscribe()`:**
- * - `addChannelCallback()`: Registers a local callback without creating a server-side subscription.
- * The callback triggers on ANY message matching the channel name, regardless of subscriptionId.
- * Useful for system-wide notifications or when you don't control the subscription lifecycle.
- *
- * - `subscribe()`: Creates a proper server-side subscription with a subscriptionId.
- * The callback only triggers for messages with the matching subscriptionId.
- * Includes proper lifecycle management (unsubscribe, automatic cleanup on disconnect).
- *
- * **When to use `addChannelCallback()`:**
- * - Listening to system-wide notifications (e.g., 'system-notifications.v1')
- * - Monitoring channels where subscriptions are managed elsewhere
- * - Debug/logging scenarios where you want to observe all channel messages
- *
- * **When to use `subscribe()` instead:**
- * - Creating new subscriptions that need server-side registration
- * - When you need proper cleanup via unsubscribe
- * - Most application use cases (recommended approach)
+ * Register a callback for specific channels
  *
  * @param options - Channel callback configuration
  * @param options.channelName - Channel name to match exactly
@@ -155,22 +109,22 @@ export type BackendWebSocketServiceFindSubscriptionsByChannelPrefixAction = {
  *
  * @example
  * ```typescript
- * // Listen to system notifications (no server subscription needed)
+ * // Listen to specific account activity channel
+ * webSocketService.addChannelCallback({
+ * channelName: 'account-activity.v1.eip155:0:0x1234...',
+ * callback: (notification) => {
+ * console.log('Account activity:', notification.data);
+ * }
+ * });
+ *
+ * // Listen to system notifications channel
  * webSocketService.addChannelCallback({
  * channelName: 'system-notifications.v1',
  * callback: (notification) => {
  * console.log('System notification:', notification.data);
  * }
  * });
- *
- * // For account-specific subscriptions, use subscribe() instead:
- * // const sub = await webSocketService.subscribe({
- * //   channels: ['account-activity.v1.eip155:0:0x1234...'],
- * //   callback: (notification) => { ... }
- * // });
  * ```
- *
- * @see subscribe for creating proper server-side subscriptions with lifecycle management
  */
 export type BackendWebSocketServiceAddChannelCallbackAction = {
     type: `BackendWebSocketService:addChannelCallback`;
@@ -179,7 +133,7 @@ export type BackendWebSocketServiceAddChannelCallbackAction = {
 /**
  * Remove a channel callback
  *
- * @param channelName - The channel name returned from addChannelCallback
+ * @param channelName - The channel name to remove callback for
  * @returns True if callback was found and removed, false otherwise
  */
 export type BackendWebSocketServiceRemoveChannelCallbackAction = {
@@ -188,58 +142,18 @@ export type BackendWebSocketServiceRemoveChannelCallbackAction = {
 };
 /**
  * Get all registered channel callbacks (for debugging)
- *
- * @returns Array of all registered channel callbacks
  */
 export type BackendWebSocketServiceGetChannelCallbacksAction = {
     type: `BackendWebSocketService:getChannelCallbacks`;
     handler: BackendWebSocketService['getChannelCallbacks'];
 };
 /**
- * Create and manage a subscription with server-side registration (recommended for most use cases)
- *
- * This is the recommended subscription API for high-level services. It creates a proper
- * server-side subscription and routes notifications based on subscriptionId.
- *
- * **Key Features:**
- * - Creates server-side subscription with unique subscriptionId
- * - Callback triggered only for messages with matching subscriptionId
- * - Automatic lifecycle management (cleanup on disconnect)
- * - Includes unsubscribe method for proper cleanup
- * - Request-response pattern with error handling
- *
- * **When to use `subscribe()`:**
- * - Creating new subscriptions (account activity, price updates, etc.)
- * - When you need proper cleanup/unsubscribe functionality
- * - Most application use cases
- *
- * **When to use `addChannelCallback()` instead:**
- * - System-wide notifications without server-side subscription
- * - Observing channels managed elsewhere
- * - Debug/logging scenarios
+ * Create and manage a subscription with direct callback routing
  *
  * @param options - Subscription configuration
  * @param options.channels - Array of channel names to subscribe to
  * @param options.callback - Callback function for handling notifications
- * @param options.requestId - Optional request ID for testing (will generate UUID if not provided)
- * @param options.channelType - Channel type identifier
- * @returns Subscription object with unsubscribe method
- *
- * @example
- * ```typescript
- * // AccountActivityService usage
- * const subscription = await webSocketService.subscribe({
- * channels: ['account-activity.v1.eip155:0:0x1234...'],
- * callback: (notification) => {
- * this.handleAccountActivity(notification.data);
- * }
- * });
- *
- * // Later, clean up
- * await subscription.unsubscribe();
- * ```
- *
- * @see addChannelCallback for local callbacks without server-side subscription
+ * @returns Promise that resolves with subscription object containing unsubscribe method
  */
 export type BackendWebSocketServiceSubscribeAction = {
     type: `BackendWebSocketService:subscribe`;

package/dist/BackendWebSocketService-method-action-types.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"BackendWebSocketService-method-action-types.d.mts","sourceRoot":"","sources":["../src/BackendWebSocketService-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,uBAAuB,EAAE,sCAAkC;AAEzE;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,oCAAoC,GAAG;IACjD,IAAI,EAAE,iCAAiC,CAAC;IACxC,OAAO,EAAE,uBAAuB,CAAC,SAAS,CAAC,CAAC;CAC7C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uCAAuC,GAAG;IACpD,IAAI,EAAE,oCAAoC,CAAC;IAC3C,OAAO,EAAE,uBAAuB,CAAC,YAAY,CAAC,CAAC;CAChD,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,8CAA8C,GAAG;IAC3D,IAAI,EAAE,2CAA2C,CAAC;IAClD,OAAO,EAAE,uBAAuB,CAAC,mBAAmB,CAAC,CAAC;CACvD,CAAC;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,MAAM,wCAAwC,GAAG;IACrD,IAAI,EAAE,qCAAqC,CAAC;IAC5C,OAAO,EAAE,uBAAuB,CAAC,aAAa,CAAC,CAAC;CACjD,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,wCAAwC,GAAG;IACrD,IAAI,EAAE,qCAAqC,CAAC;IAC5C,OAAO,EAAE,uBAAuB,CAAC,aAAa,CAAC,CAAC;CACjD,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,8CAA8C,GAAG;IAC3D,IAAI,EAAE,2CAA2C,CAAC;IAClD,OAAO,EAAE,uBAAuB,CAAC,mBAAmB,CAAC,CAAC;CACvD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,sDAAsD,GAAG;IACnE,IAAI,EAAE,mDAAmD,CAAC;IAC1D,OAAO,EAAE,uBAAuB,CAAC,2BAA2B,CAAC,CAAC;CAC/D,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,mDAAmD,GAAG;IAChE,IAAI,EAAE,gDAAgD,CAAC;IACvD,OAAO,EAAE,uBAAuB,CAAC,wBAAwB,CAAC,CAAC;CAC5D,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,6DAA6D,GAAG;IAC1E,IAAI,EAAE,0DAA0D,CAAC;IACjE,OAAO,EAAE,uBAAuB,CAAC,kCAAkC,CAAC,CAAC;CACtE,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,MAAM,MAAM,+CAA+C,GAAG;IAC5D,IAAI,EAAE,4CAA4C,CAAC;IACnD,OAAO,EAAE,uBAAuB,CAAC,oBAAoB,CAAC,CAAC;CACxD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,kDAAkD,GAAG;IAC/D,IAAI,EAAE,+CAA+C,CAAC;IACtD,OAAO,EAAE,uBAAuB,CAAC,uBAAuB,CAAC,CAAC;CAC3D,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,gDAAgD,GAAG;IAC7D,IAAI,EAAE,6CAA6C,CAAC;IACpD,OAAO,EAAE,uBAAuB,CAAC,qBAAqB,CAAC,CAAC;CACzD,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,MAAM,MAAM,sCAAsC,GAAG;IACnD,IAAI,EAAE,mCAAmC,CAAC;IAC1C,OAAO,EAAE,uBAAuB,CAAC,WAAW,CAAC,CAAC;CAC/C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oCAAoC,GAC5C,oCAAoC,GACpC,uCAAuC,GACvC,8CAA8C,GAC9C,wCAAwC,GACxC,wCAAwC,GACxC,8CAA8C,GAC9C,sDAAsD,GACtD,mDAAmD,GACnD,6DAA6D,GAC7D,+CAA+C,GAC/C,kDAAkD,GAClD,gDAAgD,GAChD,sCAAsC,CAAC"}
+{"version":3,"file":"BackendWebSocketService-method-action-types.d.mts","sourceRoot":"","sources":["../src/BackendWebSocketService-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,uBAAuB,EAAE,sCAAkC;AAEzE;;;;GAIG;AACH,MAAM,MAAM,oCAAoC,GAAG;IACjD,IAAI,EAAE,iCAAiC,CAAC;IACxC,OAAO,EAAE,uBAAuB,CAAC,SAAS,CAAC,CAAC;CAC7C,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,uCAAuC,GAAG;IACpD,IAAI,EAAE,oCAAoC,CAAC;IAC3C,OAAO,EAAE,uBAAuB,CAAC,YAAY,CAAC,CAAC;CAChD,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,8CAA8C,GAAG;IAC3D,IAAI,EAAE,2CAA2C,CAAC;IAClD,OAAO,EAAE,uBAAuB,CAAC,mBAAmB,CAAC,CAAC;CACvD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,wCAAwC,GAAG;IACrD,IAAI,EAAE,qCAAqC,CAAC;IAC5C,OAAO,EAAE,uBAAuB,CAAC,aAAa,CAAC,CAAC;CACjD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,wCAAwC,GAAG;IACrD,IAAI,EAAE,qCAAqC,CAAC;IAC5C,OAAO,EAAE,uBAAuB,CAAC,aAAa,CAAC,CAAC;CACjD,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,8CAA8C,GAAG;IAC3D,IAAI,EAAE,2CAA2C,CAAC;IAClD,OAAO,EAAE,uBAAuB,CAAC,mBAAmB,CAAC,CAAC;CACvD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,sDAAsD,GAAG;IACnE,IAAI,EAAE,mDAAmD,CAAC;IAC1D,OAAO,EAAE,uBAAuB,CAAC,2BAA2B,CAAC,CAAC;CAC/D,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,mDAAmD,GAAG;IAChE,IAAI,EAAE,gDAAgD,CAAC;IACvD,OAAO,EAAE,uBAAuB,CAAC,wBAAwB,CAAC,CAAC;CAC5D,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,6DAA6D,GAAG;IAC1E,IAAI,EAAE,0DAA0D,CAAC;IACjE,OAAO,EAAE,uBAAuB,CAAC,kCAAkC,CAAC,CAAC;CACtE,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,MAAM,+CAA+C,GAAG;IAC5D,IAAI,EAAE,4CAA4C,CAAC;IACnD,OAAO,EAAE,uBAAuB,CAAC,oBAAoB,CAAC,CAAC;CACxD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,kDAAkD,GAAG;IAC/D,IAAI,EAAE,+CAA+C,CAAC;IACtD,OAAO,EAAE,uBAAuB,CAAC,uBAAuB,CAAC,CAAC;CAC3D,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gDAAgD,GAAG;IAC7D,IAAI,EAAE,6CAA6C,CAAC;IACpD,OAAO,EAAE,uBAAuB,CAAC,qBAAqB,CAAC,CAAC;CACzD,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,sCAAsC,GAAG;IACnD,IAAI,EAAE,mCAAmC,CAAC;IAC1C,OAAO,EAAE,uBAAuB,CAAC,WAAW,CAAC,CAAC;CAC/C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oCAAoC,GAC5C,oCAAoC,GACpC,uCAAuC,GACvC,8CAA8C,GAC9C,wCAAwC,GACxC,wCAAwC,GACxC,8CAA8C,GAC9C,sDAAsD,GACtD,mDAAmD,GACnD,6DAA6D,GAC7D,+CAA+C,GAC/C,kDAAkD,GAClD,gDAAgD,GAChD,sCAAsC,CAAC"}

package/dist/BackendWebSocketService-method-action-types.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"BackendWebSocketService-method-action-types.mjs","sourceRoot":"","sources":["../src/BackendWebSocketService-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated by `scripts/generate-method-action-types.ts`.\n * Do not edit manually.\n */\n\nimport type { BackendWebSocketService } from './BackendWebSocketService';\n\n/**\n * Establishes WebSocket connection with smart reconnection behavior\n *\n * Connection Requirements (all must be true):\n * 1. Feature enabled (isEnabled() = true)\n * 2. Wallet unlocked (checked by getBearerToken)\n * 3. User signed in (checked by getBearerToken)\n *\n * Platform code should call this when app opens/foregrounds.\n * Automatically called on KeyringController:unlock event.\n *\n * @returns Promise that resolves when connection is established\n */\nexport type BackendWebSocketServiceConnectAction = {\n  type: `BackendWebSocketService:connect`;\n  handler: BackendWebSocketService['connect'];\n};\n\n/**\n * Closes WebSocket connection\n */\nexport type BackendWebSocketServiceDisconnectAction = {\n  type: `BackendWebSocketService:disconnect`;\n  handler: BackendWebSocketService['disconnect'];\n};\n\n/**\n * Forces a WebSocket reconnection to clean up subscription state\n *\n * This method is useful when subscription state may be out of sync and needs to be reset.\n * It performs a controlled disconnect-then-reconnect sequence:\n * - Disconnects cleanly to trigger subscription cleanup\n * - Schedules reconnection with exponential backoff to prevent rapid loops\n * - All subscriptions will be cleaned up automatically on disconnect\n *\n * Use cases:\n * - Recovering from subscription/unsubscription issues\n * - Cleaning up orphaned subscriptions\n * - Forcing a fresh subscription state\n *\n * @returns Promise that resolves when disconnection is complete (reconnection is scheduled)\n */\nexport type BackendWebSocketServiceForceReconnectionAction = {\n  type: `BackendWebSocketService:forceReconnection`;\n  handler: BackendWebSocketService['forceReconnection'];\n};\n\n/**\n * Sends a message through the WebSocket (fire-and-forget, no response expected)\n *\n * This is a low-level method for sending messages without waiting for a response.\n * Most consumers should use `sendRequest()` instead, which handles request-response\n * correlation and provides proper error handling with timeouts.\n *\n * Use this method only when:\n * - You don't need a response from the server\n * - You're implementing custom message protocols\n * - You need fine-grained control over message timing\n *\n * @param message - The message to send\n * @throws Error if WebSocket is not connected or send fails\n *\n * @see sendRequest for request-response pattern with automatic correlation\n */\nexport type BackendWebSocketServiceSendMessageAction = {\n  type: `BackendWebSocketService:sendMessage`;\n  handler: BackendWebSocketService['sendMessage'];\n};\n\n/**\n * Sends a request and waits for a correlated response (recommended for most use cases)\n *\n * This is the recommended high-level method for request-response communication.\n * It automatically handles:\n * - Request ID generation and correlation\n * - Response matching with timeout protection\n * - Automatic reconnection on timeout\n * - Proper cleanup of pending requests\n *\n * @param message - The request message (can include optional requestId for testing)\n * @returns Promise that resolves with the response data\n * @throws Error if WebSocket is not connected, request times out, or response indicates failure\n *\n * @see sendMessage for fire-and-forget messaging without response handling\n */\nexport type BackendWebSocketServiceSendRequestAction = {\n  type: `BackendWebSocketService:sendRequest`;\n  handler: BackendWebSocketService['sendRequest'];\n};\n\n/**\n * Gets current connection information\n *\n * @returns Current connection status and details\n */\nexport type BackendWebSocketServiceGetConnectionInfoAction = {\n  type: `BackendWebSocketService:getConnectionInfo`;\n  handler: BackendWebSocketService['getConnectionInfo'];\n};\n\n/**\n * Gets all subscription information for a specific channel\n *\n * @param channel - The channel name to look up\n * @returns Array of subscription details for all subscriptions containing the channel\n */\nexport type BackendWebSocketServiceGetSubscriptionsByChannelAction = {\n  type: `BackendWebSocketService:getSubscriptionsByChannel`;\n  handler: BackendWebSocketService['getSubscriptionsByChannel'];\n};\n\n/**\n * Checks if a channel has a subscription\n *\n * @param channel - The channel name to check\n * @returns True if the channel has a subscription, false otherwise\n */\nexport type BackendWebSocketServiceChannelHasSubscriptionAction = {\n  type: `BackendWebSocketService:channelHasSubscription`;\n  handler: BackendWebSocketService['channelHasSubscription'];\n};\n\n/**\n * Finds all subscriptions that have channels starting with the specified prefix\n *\n * @param channelPrefix - The channel prefix to search for (e.g., \"account-activity.v1\")\n * @returns Array of subscription info for matching subscriptions\n */\nexport type BackendWebSocketServiceFindSubscriptionsByChannelPrefixAction = {\n  type: `BackendWebSocketService:findSubscriptionsByChannelPrefix`;\n  handler: BackendWebSocketService['findSubscriptionsByChannelPrefix'];\n};\n\n/**\n * Register a callback for specific channels (local callback only, no server subscription)\n *\n * **Key Difference from `subscribe()`:**\n * - `addChannelCallback()`: Registers a local callback without creating a server-side subscription.\n * The callback triggers on ANY message matching the channel name, regardless of subscriptionId.\n * Useful for system-wide notifications or when you don't control the subscription lifecycle.\n *\n * - `subscribe()`: Creates a proper server-side subscription with a subscriptionId.\n * The callback only triggers for messages with the matching subscriptionId.\n * Includes proper lifecycle management (unsubscribe, automatic cleanup on disconnect).\n *\n * **When to use `addChannelCallback()`:**\n * - Listening to system-wide notifications (e.g., 'system-notifications.v1')\n * - Monitoring channels where subscriptions are managed elsewhere\n * - Debug/logging scenarios where you want to observe all channel messages\n *\n * **When to use `subscribe()` instead:**\n * - Creating new subscriptions that need server-side registration\n * - When you need proper cleanup via unsubscribe\n * - Most application use cases (recommended approach)\n *\n * @param options - Channel callback configuration\n * @param options.channelName - Channel name to match exactly\n * @param options.callback - Function to call when channel matches\n *\n * @example\n * ```typescript\n * // Listen to system notifications (no server subscription needed)\n * webSocketService.addChannelCallback({\n * channelName: 'system-notifications.v1',\n * callback: (notification) => {\n * console.log('System notification:', notification.data);\n * }\n * });\n *\n * // For account-specific subscriptions, use subscribe() instead:\n * // const sub = await webSocketService.subscribe({\n * //   channels: ['account-activity.v1.eip155:0:0x1234...'],\n * //   callback: (notification) => { ... }\n * // });\n * ```\n *\n * @see subscribe for creating proper server-side subscriptions with lifecycle management\n */\nexport type BackendWebSocketServiceAddChannelCallbackAction = {\n  type: `BackendWebSocketService:addChannelCallback`;\n  handler: BackendWebSocketService['addChannelCallback'];\n};\n\n/**\n * Remove a channel callback\n *\n * @param channelName - The channel name returned from addChannelCallback\n * @returns True if callback was found and removed, false otherwise\n */\nexport type BackendWebSocketServiceRemoveChannelCallbackAction = {\n  type: `BackendWebSocketService:removeChannelCallback`;\n  handler: BackendWebSocketService['removeChannelCallback'];\n};\n\n/**\n * Get all registered channel callbacks (for debugging)\n *\n * @returns Array of all registered channel callbacks\n */\nexport type BackendWebSocketServiceGetChannelCallbacksAction = {\n  type: `BackendWebSocketService:getChannelCallbacks`;\n  handler: BackendWebSocketService['getChannelCallbacks'];\n};\n\n/**\n * Create and manage a subscription with server-side registration (recommended for most use cases)\n *\n * This is the recommended subscription API for high-level services. It creates a proper\n * server-side subscription and routes notifications based on subscriptionId.\n *\n * **Key Features:**\n * - Creates server-side subscription with unique subscriptionId\n * - Callback triggered only for messages with matching subscriptionId\n * - Automatic lifecycle management (cleanup on disconnect)\n * - Includes unsubscribe method for proper cleanup\n * - Request-response pattern with error handling\n *\n * **When to use `subscribe()`:**\n * - Creating new subscriptions (account activity, price updates, etc.)\n * - When you need proper cleanup/unsubscribe functionality\n * - Most application use cases\n *\n * **When to use `addChannelCallback()` instead:**\n * - System-wide notifications without server-side subscription\n * - Observing channels managed elsewhere\n * - Debug/logging scenarios\n *\n * @param options - Subscription configuration\n * @param options.channels - Array of channel names to subscribe to\n * @param options.callback - Callback function for handling notifications\n * @param options.requestId - Optional request ID for testing (will generate UUID if not provided)\n * @param options.channelType - Channel type identifier\n * @returns Subscription object with unsubscribe method\n *\n * @example\n * ```typescript\n * // AccountActivityService usage\n * const subscription = await webSocketService.subscribe({\n * channels: ['account-activity.v1.eip155:0:0x1234...'],\n * callback: (notification) => {\n * this.handleAccountActivity(notification.data);\n * }\n * });\n *\n * // Later, clean up\n * await subscription.unsubscribe();\n * ```\n *\n * @see addChannelCallback for local callbacks without server-side subscription\n */\nexport type BackendWebSocketServiceSubscribeAction = {\n  type: `BackendWebSocketService:subscribe`;\n  handler: BackendWebSocketService['subscribe'];\n};\n\n/**\n * Union of all BackendWebSocketService action types.\n */\nexport type BackendWebSocketServiceMethodActions =\n  | BackendWebSocketServiceConnectAction\n  | BackendWebSocketServiceDisconnectAction\n  | BackendWebSocketServiceForceReconnectionAction\n  | BackendWebSocketServiceSendMessageAction\n  | BackendWebSocketServiceSendRequestAction\n  | BackendWebSocketServiceGetConnectionInfoAction\n  | BackendWebSocketServiceGetSubscriptionsByChannelAction\n  | BackendWebSocketServiceChannelHasSubscriptionAction\n  | BackendWebSocketServiceFindSubscriptionsByChannelPrefixAction\n  | BackendWebSocketServiceAddChannelCallbackAction\n  | BackendWebSocketServiceRemoveChannelCallbackAction\n  | BackendWebSocketServiceGetChannelCallbacksAction\n  | BackendWebSocketServiceSubscribeAction;\n"]}
+{"version":3,"file":"BackendWebSocketService-method-action-types.mjs","sourceRoot":"","sources":["../src/BackendWebSocketService-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated by `scripts/generate-method-action-types.ts`.\n * Do not edit manually.\n */\n\nimport type { BackendWebSocketService } from './BackendWebSocketService';\n\n/**\n * Establishes WebSocket connection\n *\n * @returns Promise that resolves when connection is established\n */\nexport type BackendWebSocketServiceConnectAction = {\n  type: `BackendWebSocketService:connect`;\n  handler: BackendWebSocketService['connect'];\n};\n\n/**\n * Closes WebSocket connection\n *\n * @returns Promise that resolves when disconnection is complete\n */\nexport type BackendWebSocketServiceDisconnectAction = {\n  type: `BackendWebSocketService:disconnect`;\n  handler: BackendWebSocketService['disconnect'];\n};\n\n/**\n * Forces a WebSocket reconnection to clean up subscription state\n *\n * This method is useful when subscription state may be out of sync and needs to be reset.\n * It performs a controlled disconnect-then-reconnect sequence:\n * - Disconnects cleanly to trigger subscription cleanup\n * - Schedules reconnection with exponential backoff to prevent rapid loops\n * - All subscriptions will be cleaned up automatically on disconnect\n *\n * Use cases:\n * - Recovering from subscription/unsubscription issues\n * - Cleaning up orphaned subscriptions\n * - Forcing a fresh subscription state\n *\n * @returns Promise that resolves when disconnection is complete (reconnection is scheduled)\n */\nexport type BackendWebSocketServiceForceReconnectionAction = {\n  type: `BackendWebSocketService:forceReconnection`;\n  handler: BackendWebSocketService['forceReconnection'];\n};\n\n/**\n * Sends a message through the WebSocket\n *\n * @param message - The message to send\n * @returns Promise that resolves when message is sent\n */\nexport type BackendWebSocketServiceSendMessageAction = {\n  type: `BackendWebSocketService:sendMessage`;\n  handler: BackendWebSocketService['sendMessage'];\n};\n\n/**\n * Sends a request and waits for a correlated response\n *\n * @param message - The request message\n * @returns Promise that resolves with the response data\n */\nexport type BackendWebSocketServiceSendRequestAction = {\n  type: `BackendWebSocketService:sendRequest`;\n  handler: BackendWebSocketService['sendRequest'];\n};\n\n/**\n * Gets current connection information\n *\n * @returns Current connection status and details\n */\nexport type BackendWebSocketServiceGetConnectionInfoAction = {\n  type: `BackendWebSocketService:getConnectionInfo`;\n  handler: BackendWebSocketService['getConnectionInfo'];\n};\n\n/**\n * Gets all subscription information for a specific channel\n *\n * @param channel - The channel name to look up\n * @returns Array of subscription details for all subscriptions containing the channel\n */\nexport type BackendWebSocketServiceGetSubscriptionsByChannelAction = {\n  type: `BackendWebSocketService:getSubscriptionsByChannel`;\n  handler: BackendWebSocketService['getSubscriptionsByChannel'];\n};\n\n/**\n * Checks if a channel has a subscription\n *\n * @param channel - The channel name to check\n * @returns True if the channel has a subscription, false otherwise\n */\nexport type BackendWebSocketServiceChannelHasSubscriptionAction = {\n  type: `BackendWebSocketService:channelHasSubscription`;\n  handler: BackendWebSocketService['channelHasSubscription'];\n};\n\n/**\n * Finds all subscriptions that have channels starting with the specified prefix\n *\n * @param channelPrefix - The channel prefix to search for (e.g., \"account-activity.v1\")\n * @returns Array of subscription info for matching subscriptions\n */\nexport type BackendWebSocketServiceFindSubscriptionsByChannelPrefixAction = {\n  type: `BackendWebSocketService:findSubscriptionsByChannelPrefix`;\n  handler: BackendWebSocketService['findSubscriptionsByChannelPrefix'];\n};\n\n/**\n * Register a callback for specific channels\n *\n * @param options - Channel callback configuration\n * @param options.channelName - Channel name to match exactly\n * @param options.callback - Function to call when channel matches\n *\n * @example\n * ```typescript\n * // Listen to specific account activity channel\n * webSocketService.addChannelCallback({\n * channelName: 'account-activity.v1.eip155:0:0x1234...',\n * callback: (notification) => {\n * console.log('Account activity:', notification.data);\n * }\n * });\n *\n * // Listen to system notifications channel\n * webSocketService.addChannelCallback({\n * channelName: 'system-notifications.v1',\n * callback: (notification) => {\n * console.log('System notification:', notification.data);\n * }\n * });\n * ```\n */\nexport type BackendWebSocketServiceAddChannelCallbackAction = {\n  type: `BackendWebSocketService:addChannelCallback`;\n  handler: BackendWebSocketService['addChannelCallback'];\n};\n\n/**\n * Remove a channel callback\n *\n * @param channelName - The channel name to remove callback for\n * @returns True if callback was found and removed, false otherwise\n */\nexport type BackendWebSocketServiceRemoveChannelCallbackAction = {\n  type: `BackendWebSocketService:removeChannelCallback`;\n  handler: BackendWebSocketService['removeChannelCallback'];\n};\n\n/**\n * Get all registered channel callbacks (for debugging)\n */\nexport type BackendWebSocketServiceGetChannelCallbacksAction = {\n  type: `BackendWebSocketService:getChannelCallbacks`;\n  handler: BackendWebSocketService['getChannelCallbacks'];\n};\n\n/**\n * Create and manage a subscription with direct callback routing\n *\n * @param options - Subscription configuration\n * @param options.channels - Array of channel names to subscribe to\n * @param options.callback - Callback function for handling notifications\n * @returns Promise that resolves with subscription object containing unsubscribe method\n */\nexport type BackendWebSocketServiceSubscribeAction = {\n  type: `BackendWebSocketService:subscribe`;\n  handler: BackendWebSocketService['subscribe'];\n};\n\n/**\n * Union of all BackendWebSocketService action types.\n */\nexport type BackendWebSocketServiceMethodActions =\n  | BackendWebSocketServiceConnectAction\n  | BackendWebSocketServiceDisconnectAction\n  | BackendWebSocketServiceForceReconnectionAction\n  | BackendWebSocketServiceSendMessageAction\n  | BackendWebSocketServiceSendRequestAction\n  | BackendWebSocketServiceGetConnectionInfoAction\n  | BackendWebSocketServiceGetSubscriptionsByChannelAction\n  | BackendWebSocketServiceChannelHasSubscriptionAction\n  | BackendWebSocketServiceFindSubscriptionsByChannelPrefixAction\n  | BackendWebSocketServiceAddChannelCallbackAction\n  | BackendWebSocketServiceRemoveChannelCallbackAction\n  | BackendWebSocketServiceGetChannelCallbacksAction\n  | BackendWebSocketServiceSubscribeAction;\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask-previews/core-backend",
-  "version": "4.1.0-preview-fa19a4d3",
+  "version": "4.1.0-preview-96f3a4d7",
   "description": "Core backend services for MetaMask",
   "keywords": [
     "MetaMask",