@bsv/message-box-client 1.1.10 → 1.2.0

package/dist/types/src/MessageBoxClient.d.ts

@@ -21,16 +21,10 @@
  * @author Project Babbage
  * @license Open BSV License
  */
-import { AuthFetch, BEEF, LockingScript, HexString } from '@bsv/sdk';
+import { AuthFetch, PubKeyHex } from '@bsv/sdk';
 import { AuthSocketClient } from '@bsv/authsocket-client';
-import { AcknowledgeMessageParams, ListMessagesParams, MessageBoxClientOptions, PeerMessage, SendMessageParams, SendMessageResponse } from './types.js';
-interface AdvertisementToken {
-    host: string;
-    txid: HexString;
-    outputIndex: number;
-    lockingScript: LockingScript;
-    beef: BEEF;
-}
+import { AcknowledgeMessageParams, AdvertisementToken, ListMessagesParams, MessageBoxClientOptions, PeerMessage, SendMessageParams, SendMessageResponse, DeviceRegistrationParams, DeviceRegistrationResponse, RegisteredDevice } from './types.js';
+import { SetMessageBoxPermissionParams, GetMessageBoxPermissionParams, MessageBoxPermission, MessageBoxQuote, ListPermissionsParams, GetQuoteParams } from './types/permissions.js';
 /**
  * @class MessageBoxClient
  * @description
@@ -72,7 +66,7 @@ export declare class MessageBoxClient {
      * @constructor
      * @param {Object} options - Initialization options for the MessageBoxClient.
      * @param {string} [options.host] - The base URL of the MessageBox server. If omitted, defaults to mainnet/testnet hosts.
-     * @param {WalletClient} options.walletClient - Wallet instance used for authentication, signing, and encryption.
+     * @param {WalletInterface} options.walletClient - Wallet instance used for authentication, signing, and encryption.
      * @param {boolean} [options.enableLogging=false] - Whether to enable detailed debug logging to the console.
      * @param {'local' | 'mainnet' | 'testnet'} [options.networkPreset='mainnet'] - Overlay network preset used for routing and advertisement lookup.
      *
@@ -97,6 +91,7 @@ export declare class MessageBoxClient {
      * @method init
      * @async
      * @param {string} [targetHost] - Optional host to set or override the default host.
+     * @param {string} [originator] - Optional originator to use with walletClient.
      * @returns {Promise<void>}
      *
      * @description
@@ -115,7 +110,7 @@ export declare class MessageBoxClient {
      * await client.init()
      * await client.sendMessage({ recipient, messageBox: 'inbox', body: 'Hello' })
      */
-    init(targetHost?: string): Promise<void>;
+    init(targetHost?: string, originator?: string): Promise<void>;
     /**
      * @method assertInitialized
      * @private
@@ -138,12 +133,13 @@ export declare class MessageBoxClient {
     getJoinedRooms(): Set<string>;
     /**
    * @method getIdentityKey
+   * @param {string} [originator] - Optional originator to use for identity key lookup
    * @returns {Promise<string>} The identity public key of the user
    * @description
    * Returns the client's identity key, used for signing, encryption, and addressing.
    * If not already loaded, it will fetch and cache it.
    */
-    getIdentityKey(): Promise<string>;
+    getIdentityKey(originator?: string): Promise<string>;
     /**
      * @property testSocket
      * @readonly
@@ -158,6 +154,7 @@ export declare class MessageBoxClient {
     get testSocket(): ReturnType<typeof AuthSocketClient> | undefined;
     /**
      * @method initializeConnection
+     * @param {string} [originator] - Optional originator to use for authentication.
      * @async
      * @returns {Promise<void>}
      * @description
@@ -179,11 +176,12 @@ export declare class MessageBoxClient {
      * await mb.initializeConnection()
      * // WebSocket is now ready for use
      */
-    initializeConnection(): Promise<void>;
+    initializeConnection(originator?: string): Promise<void>;
     /**
      * @method resolveHostForRecipient
      * @async
      * @param {string} identityKey - The public identity key of the intended recipient.
+     * @param {string} [originator] - The originator to use for the WalletClient.
      * @returns {Promise<string>} - A fully qualified host URL for the recipient's MessageBox server.
      *
      * @description
@@ -198,7 +196,7 @@ export declare class MessageBoxClient {
      * @example
      * const host = await resolveHostForRecipient('028d...') // → returns either overlay host or this.host
      */
-    resolveHostForRecipient(identityKey: string): Promise<string>;
+    resolveHostForRecipient(identityKey: string, originator?: string): Promise<string>;
     /**
      * Core lookup: ask the LookupResolver (optionally filtered by host),
      * decode every PushDrop output, and collect all the host URLs you find.
@@ -207,7 +205,7 @@ export declare class MessageBoxClient {
      * @param host?        if passed, only look for adverts anointed at that host
      * @returns            0-length array if nothing valid was found
      */
-    queryAdvertisements(identityKey?: string, host?: string): Promise<AdvertisementToken[]>;
+    queryAdvertisements(identityKey?: string, host?: string, originator?: string): Promise<AdvertisementToken[]>;
     /**
      * @method joinRoom
      * @async
@@ -256,9 +254,10 @@ export declare class MessageBoxClient {
      *   onMessage: (msg) => console.log('Received live message:', msg)
      * })
      */
-    listenForLiveMessages({ onMessage, messageBox }: {
+    listenForLiveMessages({ onMessage, messageBox, originator }: {
         onMessage: (message: PeerMessage) => void;
         messageBox: string;
+        originator?: string;
     }): Promise<void>;
     /**
      * @method sendLiveMessage
@@ -289,7 +288,7 @@ export declare class MessageBoxClient {
      *   body: { amount: 1000 }
      * })
      */
-    sendLiveMessage({ recipient, messageBox, body, messageId, skipEncryption }: SendMessageParams): Promise<SendMessageResponse>;
+    sendLiveMessage({ recipient, messageBox, body, messageId, skipEncryption, checkPermissions, originator }: SendMessageParams): Promise<SendMessageResponse>;
     /**
      * @method leaveRoom
      * @async
@@ -347,7 +346,7 @@ export declare class MessageBoxClient {
      *   body: { type: 'ping' }
      * })
      */
-    sendMessage(message: SendMessageParams, overrideHost?: string): Promise<SendMessageResponse>;
+    sendMessage(message: SendMessageParams, overrideHost?: string, originator?: string): Promise<SendMessageResponse>;
     /**
      * @method anointHost
      * @async
@@ -371,13 +370,14 @@ export declare class MessageBoxClient {
      * @example
      * const { txid } = await client.anointHost('https://my-messagebox.io')
      */
-    anointHost(host: string): Promise<{
+    anointHost(host: string, originator?: string): Promise<{
         txid: string;
     }>;
     /**
      * @method revokeHostAdvertisement
      * @async
      * @param {AdvertisementToken} advertisementToken - The advertisement token containing the messagebox host to revoke.
+     * @param {string} [originator] - Optional originator to use with walletClient.
      * @returns {Promise<{ txid: string }>} - The transaction ID of the revocation broadcast to the overlay network.
      *
      * @description
@@ -387,7 +387,7 @@ export declare class MessageBoxClient {
      * @example
      * const { txid } = await client.revokeHost('https://my-messagebox.io')
      */
-    revokeHostAdvertisement(advertisementToken: AdvertisementToken): Promise<{
+    revokeHostAdvertisement(advertisementToken: AdvertisementToken, originator?: string): Promise<{
         txid: string;
     }>;
     /**
@@ -402,9 +402,16 @@ export declare class MessageBoxClient {
      *
      * Each message is:
      * - Parsed and, if encrypted, decrypted using AES-256-GCM via BRC-2-compliant ECDH key derivation and symmetric encryption.
+     * - Automatically processed for payments: if the message includes recipient fee payments, they are internalized using `walletClient.internalizeAction()`.
      * - Returned as a normalized `PeerMessage` with readable string body content.
      *
-     * Decryption automatically derives a shared secret using the sender’s identity key and the receiver’s child private key.
+     * Payment Processing:
+     * - Detects messages that include payment data (from paid message delivery).
+     * - Automatically internalizes recipient payment outputs, allowing you to receive payments without additional API calls.
+     * - Only recipient payments are stored with messages - delivery fees are already processed by the server.
+     * - Continues processing messages even if payment internalization fails.
+     *
+     * Decryption automatically derives a shared secret using the sender's identity key and the receiver's child private key.
      * If the sender is the same as the recipient, the `counterparty` is set to `'self'`.
      *
      * @throws {Error} If no messageBox is specified, the request fails, or the server returns an error.
@@ -412,8 +419,9 @@ export declare class MessageBoxClient {
      * @example
      * const messages = await client.listMessages({ messageBox: 'inbox' })
      * messages.forEach(msg => console.log(msg.sender, msg.body))
+     * // Payments included with messages are automatically received
      */
-    listMessages({ messageBox, host }: ListMessagesParams): Promise<PeerMessage[]>;
+    listMessages({ messageBox, host, originator }: ListMessagesParams): Promise<PeerMessage[]>;
     /**
      * @method acknowledgeMessage
      * @async
@@ -435,7 +443,210 @@ export declare class MessageBoxClient {
      * @example
      * await client.acknowledgeMessage({ messageIds: ['msg123', 'msg456'] })
      */
-    acknowledgeMessage({ messageIds, host }: AcknowledgeMessageParams): Promise<string>;
+    acknowledgeMessage({ messageIds, host, originator }: AcknowledgeMessageParams): Promise<string>;
+    /**
+     * @method setMessageBoxPermission
+     * @async
+     * @param {SetMessageBoxPermissionParams} params - Permission configuration
+     * @param {string} [overrideHost] - Optional host override
+     * @returns {Promise<void>} Permission status after setting
+     *
+     * @description
+     * Sets permission for receiving messages in a specific messageBox.
+     * Can set sender-specific permissions or box-wide defaults.
+     *
+     * @example
+     * // Set box-wide default: allow notifications for 10 sats
+     * await client.setMessageBoxPermission({ messageBox: 'notifications', recipientFee: 10 })
+     *
+     * // Block specific sender
+     * await client.setMessageBoxPermission({
+     *   messageBox: 'notifications',
+     *   sender: '03abc123...',
+     *   recipientFee: -1
+     * })
+     */
+    setMessageBoxPermission(params: SetMessageBoxPermissionParams, overrideHost?: string): Promise<void>;
+    /**
+     * @method getMessageBoxPermission
+     * @async
+     * @param {GetMessageBoxPermissionParams} params - Permission query parameters
+     * @param {string} [overrideHost] - Optional host override
+     * @returns {Promise<MessageBoxPermission | null>} Permission data (null if not set)
+     *
+     * @description
+     * Gets current permission data for a sender/messageBox combination.
+     * Returns null if no permission is set.
+     *
+     * @example
+     * const status = await client.getMessageBoxPermission({
+     *   recipient: '03def456...',
+     *   messageBox: 'notifications',
+     *   sender: '03abc123...'
+     * })
+     */
+    getMessageBoxPermission(params: GetMessageBoxPermissionParams, overrideHost?: string): Promise<MessageBoxPermission | null>;
+    /**
+     * @method getMessageBoxQuote
+     * @async
+     * @param {GetQuoteParams} params - Quote request parameters
+     * @returns {Promise<MessageBoxQuote>} Fee quote and permission status
+     *
+     * @description
+     * Gets a fee quote for sending a message, including delivery and recipient fees.
+     *
+     * @example
+     * const quote = await client.getMessageBoxQuote({
+     *   recipient: '03def456...',
+     *   messageBox: 'notifications'
+     * })
+     */
+    getMessageBoxQuote(params: GetQuoteParams, overrideHost?: string): Promise<MessageBoxQuote>;
+    /**
+     * @method listMessageBoxPermissions
+     * @async
+     * @param {ListPermissionsParams} [params] - Optional filtering and pagination parameters
+     * @returns {Promise<MessageBoxPermission[]>} List of current permissions
+     *
+     * @description
+     * Lists permissions for the authenticated user's messageBoxes with optional pagination.
+     *
+     * @example
+     * // List all permissions
+     * const all = await client.listMessageBoxPermissions()
+     *
+     * // List only notification permissions with pagination
+     * const notifications = await client.listMessageBoxPermissions({
+     *   messageBox: 'notifications',
+     *   limit: 50,
+     *   offset: 0
+     * })
+     */
+    listMessageBoxPermissions(params?: ListPermissionsParams, overrideHost?: string): Promise<MessageBoxPermission[]>;
+    /**
+     * @method allowNotificationsFromPeer
+     * @async
+     * @param {PubKeyHex} identityKey - Sender's identity key to allow
+     * @param {number} [recipientFee=0] - Fee to charge (0 for always allow)
+     * @param {string} [overrideHost] - Optional host override
+     * @returns {Promise<void>} Permission status after allowing
+     *
+     * @description
+     * Convenience method to allow notifications from a specific peer.
+     *
+     * @example
+     * await client.allowNotificationsFromPeer('03abc123...') // Always allow
+     * await client.allowNotificationsFromPeer('03def456...', 5) // Allow for 5 sats
+     */
+    allowNotificationsFromPeer(identityKey: PubKeyHex, recipientFee?: number, overrideHost?: string): Promise<void>;
+    /**
+     * @method denyNotificationsFromPeer
+     * @async
+     * @param {PubKeyHex} identityKey - Sender's identity key to block
+     * @returns {Promise<void>} Permission status after denying
+     *
+     * @description
+     * Convenience method to block notifications from a specific peer.
+     *
+     * @example
+     * await client.denyNotificationsFromPeer('03spam123...')
+     */
+    denyNotificationsFromPeer(identityKey: PubKeyHex, overrideHost?: string): Promise<void>;
+    /**
+     * @method checkPeerNotificationStatus
+     * @async
+     * @param {PubKeyHex} identityKey - Sender's identity key to check
+     * @returns {Promise<MessageBoxPermission>} Current permission status
+     *
+     * @description
+     * Convenience method to check notification permission for a specific peer.
+     *
+     * @example
+     * const status = await client.checkPeerNotificationStatus('03abc123...')
+     * console.log(status.allowed) // true/false
+     */
+    checkPeerNotificationStatus(identityKey: PubKeyHex, overrideHost?: string): Promise<MessageBoxPermission | null>;
+    /**
+     * @method listPeerNotifications
+     * @async
+     * @returns {Promise<MessageBoxPermission[]>} List of notification permissions
+     *
+     * @description
+     * Convenience method to list all notification permissions.
+     *
+     * @example
+     * const notifications = await client.listPeerNotifications()
+     */
+    listPeerNotifications(overrideHost?: string): Promise<MessageBoxPermission[]>;
+    /**
+     * @method sendNotification
+     * @async
+     * @param {PubKeyHex} recipient - Recipient's identity key
+     * @param {string | object} body - Notification content
+     * @param {string} [overrideHost] - Optional host override
+     * @returns {Promise<SendMessageResponse>} Send result
+     *
+     * @description
+     * Convenience method to send a notification with automatic quote fetching and payment handling.
+     * Automatically determines the required payment amount and creates the payment if needed.
+     *
+     * @example
+     * // Send notification (auto-determines payment needed)
+     * await client.sendNotification('03def456...', 'Hello!')
+     *
+     * // Send with maximum payment limit for safety
+     * await client.sendNotification('03def456...', { title: 'Alert', body: 'Important update' }, 50)
+     */
+    sendNotification(recipient: PubKeyHex, body: string | object, overrideHost?: string): Promise<SendMessageResponse>;
+    /**
+     * Register a device for FCM push notifications.
+     *
+     * @async
+     * @param {DeviceRegistrationParams} params - Device registration parameters
+     * @param {string} [overrideHost] - Optional host override
+     * @returns {Promise<DeviceRegistrationResponse>} Registration response
+     *
+     * @description
+     * Registers a device with the message box server to receive FCM push notifications.
+     * The FCM token is obtained from Firebase SDK on the client side.
+     *
+     * @example
+     * const result = await client.registerDevice({
+     *   fcmToken: 'eBo8F...',
+     *   platform: 'ios',
+     *   deviceId: 'iPhone15Pro'
+     * })
+     */
+    registerDevice(params: DeviceRegistrationParams, overrideHost?: string): Promise<DeviceRegistrationResponse>;
+    /**
+     * List all registered devices for push notifications.
+     *
+     * @async
+     * @param {string} [overrideHost] - Optional host override
+     * @returns {Promise<RegisteredDevice[]>} Array of registered devices
+     *
+     * @description
+     * Retrieves all devices registered by the authenticated user for FCM push notifications.
+     * Only shows devices belonging to the current user (authenticated via AuthFetch).
+     *
+     * @example
+     * const devices = await client.listRegisteredDevices()
+     * console.log(`Found ${devices.length} registered devices`)
+     * devices.forEach(device => {
+     *   console.log(`Device: ${device.platform} - ${device.fcmToken}`)
+     * })
+     */
+    listRegisteredDevices(overrideHost?: string): Promise<RegisteredDevice[]>;
+    private static getStatusFromFee;
+    /**
+     * Creates payment transaction for message delivery fees
+     * TODO: Consider consolidating payment generating logic with a util PeerPayClient can use as well.
+     * @private
+     * @param {string} recipient - Recipient identity key
+     * @param {MessageBoxQuote} quote - Fee quote with delivery and recipient fees
+     * @param {string} description - Description for the payment transaction
+     * @returns {Promise<Payment>} Payment transaction data
+     */
+    private createMessagePayment;
 }
-export {};
 //# sourceMappingURL=MessageBoxClient.d.ts.map

package/dist/types/src/MessageBoxClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"MessageBoxClient.d.ts","sourceRoot":"","sources":["../../../src/MessageBoxClient.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,OAAO,EAEL,SAAS,EAMT,IAAI,EACJ,aAAa,EACb,SAAS,EACV,MAAM,UAAU,CAAA;AACjB,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAA;AAEzD,OAAO,EAAE,wBAAwB,EAAoB,kBAAkB,EAAE,uBAAuB,EAAE,WAAW,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAA;AAKzK,UAAU,kBAAkB;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,SAAS,CAAA;IACf,WAAW,EAAE,MAAM,CAAA;IACnB,aAAa,EAAE,aAAa,CAAA;IAC5B,IAAI,EAAE,IAAI,CAAA;CACX;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,IAAI,CAAQ;IACpB,SAAgB,SAAS,EAAE,SAAS,CAAA;IACpC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAc;IAC3C,OAAO,CAAC,MAAM,CAAC,CAAqC;IACpD,OAAO,CAAC,aAAa,CAAC,CAAQ;IAC9B,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAyB;IACrD,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAgB;IAC/C,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAiC;IAC/D,OAAO,CAAC,WAAW,CAAQ;IAE3B;;;;;;;;;;;;;;;;;;;;;;;OAuBG;gBACS,OAAO,GAAE,uBAA4B;IA4BjD;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,IAAI,CAAC,UAAU,GAAE,MAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IA6BzD;;;;;;;;;;OAUG;YACW,iBAAiB;IAM/B;;;;;;OAMG;IACI,cAAc,IAAI,GAAG,CAAC,MAAM,CAAC;IAIpC;;;;;;KAMC;IACY,cAAc,IAAI,OAAO,CAAC,MAAM,CAAC;IAiB9C;;;;;;;;;;OAUG;IACH,IAAW,UAAU,IAAI,UAAU,CAAC,OAAO,gBAAgB,CAAC,GAAG,SAAS,CAEvE;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,oBAAoB,IAAI,OAAO,CAAC,IAAI,CAAC;IAmF3C;;;;;;;;;;;;;;;;;OAiBG;IACG,uBAAuB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAUnE;;;;;;;OAOG;IACG,mBAAmB,CACvB,WAAW,CAAC,EAAE,MAAM,EACpB,IAAI,CAAC,EAAE,MAAM,GACZ,OAAO,CAAC,kBAAkB,EAAE,CAAC;IA0ChC;;;;;;;;;;;;;;;;;;OAkBG;IACG,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IA+BjD;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACG,qBAAqB,CAAC,EAC1B,SAAS,EACT,UAAU,EACX,EAAE;QACD,SAAS,EAAE,CAAC,OAAO,EAAE,WAAW,KAAK,IAAI,CAAA;QACzC,UAAU,EAAE,MAAM,CAAA;KACnB,GAAG,OAAO,CAAC,IAAI,CAAC;IA6DjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACG,eAAe,CAAC,EACpB,SAAS,EACT,UAAU,EACV,IAAI,EACJ,SAAS,EACT,cAAc,EACf,EAAE,iBAAiB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAqInD;;;;;;;;;;;;;;OAcG;IACG,SAAS,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAmBlD;;;;;;;;;;;;OAYG;IACG,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC;IAW1C;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACG,WAAW,CACf,OAAO,EAAE,iBAAiB,EAC1B,YAAY,CAAC,EAAE,MAAM,GACpB,OAAO,CAAC,mBAAmB,CAAC;IAmG/B;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IAoEzD;;;;;;;;;;;;OAYG;IACG,uBAAuB,CAAC,kBAAkB,EAAE,kBAAkB,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IAwEhG;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,YAAY,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IAsHpF;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,kBAAkB,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,EAAE,wBAAwB,GAAG,OAAO,CAAC,MAAM,CAAC;CAwD1F"}
+{"version":3,"file":"MessageBoxClient.d.ts","sourceRoot":"","sources":["../../../src/MessageBoxClient.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,OAAO,EAEL,SAAS,EAMT,SAAS,EAQV,MAAM,UAAU,CAAA;AACjB,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAA;AAEzD,OAAO,EAAE,wBAAwB,EAAE,kBAAkB,EAAoB,kBAAkB,EAAE,uBAAuB,EAAW,WAAW,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,wBAAwB,EAAE,0BAA0B,EAAE,gBAAgB,EAAuB,MAAM,YAAY,CAAA;AACnS,OAAO,EACL,6BAA6B,EAC7B,6BAA6B,EAC7B,oBAAoB,EACpB,eAAe,EACf,qBAAqB,EACrB,cAAc,EACf,MAAM,wBAAwB,CAAA;AAK/B;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,IAAI,CAAQ;IACpB,SAAgB,SAAS,EAAE,SAAS,CAAA;IACpC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAiB;IAC9C,OAAO,CAAC,MAAM,CAAC,CAAqC;IACpD,OAAO,CAAC,aAAa,CAAC,CAAQ;IAC9B,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAyB;IACrD,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAgB;IAC/C,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAiC;IAC/D,OAAO,CAAC,WAAW,CAAQ;IAE3B;;;;;;;;;;;;;;;;;;;;;;;OAuBG;gBACS,OAAO,GAAE,uBAA4B;IA6BjD;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,IAAI,CAAC,UAAU,GAAE,MAAkB,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IA6B9E;;;;;;;;;;OAUG;YACW,iBAAiB;IAM/B;;;;;;OAMG;IACI,cAAc,IAAI,GAAG,CAAC,MAAM,CAAC;IAIpC;;;;;;;KAOC;IACY,cAAc,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAiBjE;;;;;;;;;;OAUG;IACH,IAAW,UAAU,IAAI,UAAU,CAAC,OAAO,gBAAgB,CAAC,GAAG,SAAS,CAEvE;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,oBAAoB,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IA2E9D;;;;;;;;;;;;;;;;;;OAkBG;IACG,uBAAuB,CAAC,WAAW,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAUxF;;;;;;;OAOG;IACG,mBAAmB,CACvB,WAAW,CAAC,EAAE,MAAM,EACpB,IAAI,CAAC,EAAE,MAAM,EACb,UAAU,CAAC,EAAE,MAAM,GAClB,OAAO,CAAC,kBAAkB,EAAE,CAAC;IA0ChC;;;;;;;;;;;;;;;;;;OAkBG;IACG,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IA+BjD;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACG,qBAAqB,CAAC,EAC1B,SAAS,EACT,UAAU,EACV,UAAU,EACX,EAAE;QACD,SAAS,EAAE,CAAC,OAAO,EAAE,WAAW,KAAK,IAAI,CAAA;QACzC,UAAU,EAAE,MAAM,CAAA;QAClB,UAAU,CAAC,EAAE,MAAM,CAAA;KACpB,GAAG,OAAO,CAAC,IAAI,CAAC;IA6DjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACG,eAAe,CAAC,EACpB,SAAS,EACT,UAAU,EACV,IAAI,EACJ,SAAS,EACT,cAAc,EACd,gBAAgB,EAChB,UAAU,EACX,EAAE,iBAAiB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAuInD;;;;;;;;;;;;;;OAcG;IACG,SAAS,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAmBlD;;;;;;;;;;;;OAYG;IACG,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC;IAW1C;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACG,WAAW,CACf,OAAO,EAAE,iBAAiB,EAC1B,YAAY,CAAC,EAAE,MAAM,EACrB,UAAU,CAAC,EAAE,MAAM,GAClB,OAAO,CAAC,mBAAmB,CAAC;IAyI/B;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IAoE9E;;;;;;;;;;;;;OAaG;IACG,uBAAuB,CAAC,kBAAkB,EAAE,kBAAkB,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IAwErH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACG,YAAY,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IAuLhG;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,kBAAkB,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE,wBAAwB,GAAG,OAAO,CAAC,MAAM,CAAC;IA6DrG;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,uBAAuB,CAC3B,MAAM,EAAE,6BAA6B,EACrC,YAAY,CAAC,EAAE,MAAM,GACpB,OAAO,CAAC,IAAI,CAAC;IA2BhB;;;;;;;;;;;;;;;;;OAiBG;IACG,uBAAuB,CAC3B,MAAM,EAAE,6BAA6B,EACrC,YAAY,CAAC,EAAE,MAAM,GACpB,OAAO,CAAC,oBAAoB,GAAG,IAAI,CAAC;IA6BvC;;;;;;;;;;;;;;OAcG;IACG,kBAAkB,CAAC,MAAM,EAAE,cAAc,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IAsCjG;;;;;;;;;;;;;;;;;;;OAmBG;IACG,yBAAyB,CAAC,MAAM,CAAC,EAAE,qBAAqB,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,EAAE,CAAC;IA8CvH;;;;;;;;;;;;;;OAcG;IACG,0BAA0B,CAAC,WAAW,EAAE,SAAS,EAAE,YAAY,GAAE,MAAU,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQxH;;;;;;;;;;;OAWG;IACG,yBAAyB,CAAC,WAAW,EAAE,SAAS,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ7F;;;;;;;;;;;;OAYG;IACG,2BAA2B,CAAC,WAAW,EAAE,SAAS,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,GAAG,IAAI,CAAC;IAStH;;;;;;;;;;OAUG;IACG,qBAAqB,CAAC,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,EAAE,CAAC;IAInF;;;;;;;;;;;;;;;;;;OAkBG;IACG,gBAAgB,CACpB,SAAS,EAAE,SAAS,EACpB,IAAI,EAAE,MAAM,GAAG,MAAM,EACrB,YAAY,CAAC,EAAE,MAAM,GACpB,OAAO,CAAC,mBAAmB,CAAC;IAa/B;;;;;;;;;;;;;;;;;;OAkBG;IACG,cAAc,CAClB,MAAM,EAAE,wBAAwB,EAChC,YAAY,CAAC,EAAE,MAAM,GACpB,OAAO,CAAC,0BAA0B,CAAC;IA8CtC;;;;;;;;;;;;;;;;;OAiBG;IACG,qBAAqB,CACzB,YAAY,CAAC,EAAE,MAAM,GACpB,OAAO,CAAC,gBAAgB,EAAE,CAAC;IA8B9B,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAM/B;;;;;;;;OAQG;YACW,oBAAoB;CAoHnC"}

package/dist/types/src/PeerPayClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PeerPayClient.d.ts","sourceRoot":"","sources":["../../../src/PeerPayClient.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAExD,OAAO,EAAE,YAAY,EAAiC,UAAU,EAAa,YAAY,EAAE,MAAM,UAAU,CAAA;AAc3G,eAAO,MAAM,2BAA2B,kBAAkB,CAAA;AAG1D;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,YAAY,EAAE,YAAY,CAAA;IAC1B,aAAa,CAAC,EAAE,OAAO,CAAA;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,MAAM,CAAA;CACf;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,kBAAkB,EAAE;QAClB,gBAAgB,EAAE,YAAY,CAAA;QAC9B,gBAAgB,EAAE,YAAY,CAAA;KAC/B,CAAA;IACD,WAAW,EAAE,UAAU,CAAA;IACvB,MAAM,EAAE,MAAM,CAAA;CACf;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,YAAY,CAAA;CACpB;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,gBAAgB;IACjD,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAc;IAClD,OAAO,CAAC,kBAAkB,CAAC,CAAW;gBAEzB,MAAM,EAAE,mBAAmB;IASxC,OAAO,KAAK,iBAAiB,GAK5B;IAED;;;;;;;;;;;OAWG;IACG,kBAAkB,CAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC;IAgExE;;;;;;;;;;;OAWG;IACG,WAAW,CAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,GAAG,CAAC;IAexD;;;;;;;;;;;;OAYG;IACG,eAAe,CAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAsB7D;;;;;;;;;;OAUG;IACG,qBAAqB,CAAE,EAC3B,SAAS,EACV,EAAE;QAAE,SAAS,EAAE,CAAC,OAAO,EAAE,eAAe,KAAK,IAAI,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAkBpE;;;;;;;;;;OAUG;IACG,aAAa,CAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC;IA8B5D;;;;;;;;;OASG;IACG,aAAa,CAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAoD7D;;;;;;;OAOG;IACG,oBAAoB,IAAK,OAAO,CAAC,eAAe,EAAE,CAAC;CAa1D"}
+{"version":3,"file":"PeerPayClient.d.ts","sourceRoot":"","sources":["../../../src/PeerPayClient.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAExD,OAAO,EAAE,YAAY,EAAiC,UAAU,EAAa,YAAY,EAAE,MAAM,UAAU,CAAA;AAc3G,eAAO,MAAM,2BAA2B,kBAAkB,CAAA;AAG1D;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,YAAY,EAAE,YAAY,CAAA;IAC1B,aAAa,CAAC,EAAE,OAAO,CAAA;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,MAAM,CAAA;CACf;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,kBAAkB,EAAE;QAClB,gBAAgB,EAAE,YAAY,CAAA;QAC9B,gBAAgB,EAAE,YAAY,CAAA;KAC/B,CAAA;IACD,WAAW,EAAE,UAAU,CAAA;IACvB,MAAM,EAAE,MAAM,CAAA;CACf;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,YAAY,CAAA;CACpB;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,gBAAgB;IACjD,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAc;IAClD,OAAO,CAAC,kBAAkB,CAAC,CAAW;gBAE1B,MAAM,EAAE,mBAAmB;IASvC,OAAO,KAAK,iBAAiB,GAK5B;IAED;;;;;;;;;;;OAWG;IACG,kBAAkB,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC;IAgEvE;;;;;;;;;;;OAWG;IACG,WAAW,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,GAAG,CAAC;IAevD;;;;;;;;;;;;OAYG;IACG,eAAe,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAsB5D;;;;;;;;;;OAUG;IACG,qBAAqB,CAAC,EAC1B,SAAS,EACV,EAAE;QAAE,SAAS,EAAE,CAAC,OAAO,EAAE,eAAe,KAAK,IAAI,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAkBpE;;;;;;;;;;OAUG;IACG,aAAa,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC;IA8B3D;;;;;;;;;OASG;IACG,aAAa,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAoD5D;;;;;;;OAOG;IACG,oBAAoB,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;CAazD"}

package/dist/types/src/Utils/logger.d.ts

@@ -1,9 +1,6 @@
-export declare class Logger {
-    private static isEnabled;
-    static enable(): void;
-    static disable(): void;
-    static log(...args: unknown[]): void;
-    static warn(...args: unknown[]): void;
-    static error(...args: unknown[]): void;
-}
+export declare function enable(): void;
+export declare function disable(): void;
+export declare function log(...args: unknown[]): void;
+export declare function warn(...args: unknown[]): void;
+export declare function error(...args: unknown[]): void;
 //# sourceMappingURL=logger.d.ts.map

package/dist/types/src/Utils/logger.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../../../src/Utils/logger.ts"],"names":[],"mappings":"AAAA,qBAAa,MAAM;IACjB,OAAO,CAAC,MAAM,CAAC,SAAS,CAAQ;IAEhC,MAAM,CAAC,MAAM,IAAK,IAAI;IAItB,MAAM,CAAC,OAAO,IAAK,IAAI;IAIvB,MAAM,CAAC,GAAG,CAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI;IAMrC,MAAM,CAAC,IAAI,CAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI;IAMtC,MAAM,CAAC,KAAK,CAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI;CAGxC"}
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../../../src/Utils/logger.ts"],"names":[],"mappings":"AAEA,wBAAgB,MAAM,IAAK,IAAI,CAE9B;AAED,wBAAgB,OAAO,IAAK,IAAI,CAE/B;AAED,wBAAgB,GAAG,CAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAI7C;AAED,wBAAgB,IAAI,CAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAI9C;AAED,wBAAgB,KAAK,CAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAE/C"}

package/dist/types/src/types/permissions.d.ts

@@ -0,0 +1,75 @@
+/**
+ * Permission and fee management types for MessageBox system
+ */
+import { PubKeyHex } from '@bsv/sdk';
+/**
+ * Parameters for setting message box permissions
+ */
+export interface SetMessageBoxPermissionParams {
+    /** The messageBox type (e.g., 'notifications', 'inbox') */
+    messageBox: string;
+    /** Optional sender - if omitted, sets box-wide default */
+    sender?: string;
+    /** Recipient fee: -1=block all, 0=always allow, >0=satoshi amount required */
+    recipientFee: number;
+}
+/**
+ * Parameters for getting message box permissions
+ */
+export interface GetMessageBoxPermissionParams {
+    /** The recipient's identity key */
+    recipient: string;
+    /** The messageBox type */
+    messageBox: string;
+    /** Optional sender - if omitted, gets box-wide default */
+    sender?: string;
+}
+/**
+ * Permission response from server
+ */
+export interface MessageBoxPermission {
+    /** Sender identity key (null for box-wide defaults) */
+    sender: string | null;
+    /** MessageBox type */
+    messageBox: string;
+    /** Recipient fee setting */
+    recipientFee: number;
+    /** Permission status derived from recipientFee */
+    status: 'always_allow' | 'blocked' | 'payment_required';
+    /** Creation timestamp */
+    createdAt: string;
+    /** Last update timestamp */
+    updatedAt: string;
+}
+/**
+ * Fee quote response
+ */
+export interface MessageBoxQuote {
+    /** Server delivery fee */
+    deliveryFee: number;
+    /** Recipient fee */
+    recipientFee: number;
+    /** Delivery agent identity key */
+    deliveryAgentIdentityKey: PubKeyHex;
+}
+/**
+ * Parameters for listing permissions
+ */
+export interface ListPermissionsParams {
+    /** Optional messageBox filter */
+    messageBox?: string;
+    /** Optional pagination limit */
+    limit?: number;
+    /** Optional pagination offset */
+    offset?: number;
+}
+/**
+ * Parameters for getting fee quote
+ */
+export interface GetQuoteParams {
+    /** Recipient identity key */
+    recipient: string;
+    /** MessageBox type */
+    messageBox: string;
+}
+//# sourceMappingURL=permissions.d.ts.map

package/dist/types/src/types/permissions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"permissions.d.ts","sourceRoot":"","sources":["../../../../src/types/permissions.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAA;AAEpC;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,2DAA2D;IAC3D,UAAU,EAAE,MAAM,CAAA;IAClB,0DAA0D;IAC1D,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,8EAA8E;IAC9E,YAAY,EAAE,MAAM,CAAA;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,mCAAmC;IACnC,SAAS,EAAE,MAAM,CAAA;IACjB,0BAA0B;IAC1B,UAAU,EAAE,MAAM,CAAA;IAClB,0DAA0D;IAC1D,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,uDAAuD;IACvD,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,sBAAsB;IACtB,UAAU,EAAE,MAAM,CAAA;IAClB,4BAA4B;IAC5B,YAAY,EAAE,MAAM,CAAA;IACpB,kDAAkD;IAClD,MAAM,EAAE,cAAc,GAAG,SAAS,GAAG,kBAAkB,CAAA;IACvD,yBAAyB;IACzB,SAAS,EAAE,MAAM,CAAA;IACjB,4BAA4B;IAC5B,SAAS,EAAE,MAAM,CAAA;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,0BAA0B;IAC1B,WAAW,EAAE,MAAM,CAAA;IACnB,oBAAoB;IACpB,YAAY,EAAE,MAAM,CAAA;IACpB,kCAAkC;IAClC,wBAAwB,EAAE,SAAS,CAAA;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,iCAAiC;IACjC,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,gCAAgC;IAChC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,iCAAiC;IACjC,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,6BAA6B;IAC7B,SAAS,EAAE,MAAM,CAAA;IACjB,sBAAsB;IACtB,UAAU,EAAE,MAAM,CAAA;CACnB"}

package/dist/types/src/types.d.ts

@@ -1,4 +1,4 @@
-import { Base64String, WalletClient } from '@bsv/sdk';
+import { AtomicBEEF, Base64String, BasketStringUnder300Bytes, BEEF, BooleanDefaultTrue, DescriptionString5to50Bytes, HexString, LabelStringUnder300Bytes, LockingScript, OutputTagStringUnder300Bytes, PositiveIntegerOrZero, PubKeyHex, WalletInterface } from '@bsv/sdk';
 /**
  * Configuration options for initializing a MessageBoxClient.
  */
@@ -7,7 +7,7 @@ export interface MessageBoxClientOptions {
      * Wallet instance used for auth, identity, and encryption.
      * If not provided, a new WalletClient will be created.
      */
-    walletClient?: WalletClient;
+    walletClient?: WalletInterface;
     /**
      * Base URL of the MessageBox server.
      * @default 'https://messagebox.babbage.systems'
@@ -23,6 +23,10 @@ export interface MessageBoxClientOptions {
      * @default 'local'
      */
     networkPreset?: 'local' | 'mainnet' | 'testnet';
+    /**
+     * Originator of the message box client.
+     */
+    originator?: string;
 }
 /**
  * Represents a decrypted message received from a MessageBox.
@@ -56,6 +60,9 @@ export interface SendMessageParams {
     body: string | object;
     messageId?: string;
     skipEncryption?: boolean;
+    /** Optional: Enable permission and fee checking (default: false for backwards compatibility) */
+    checkPermissions?: boolean;
+    originator?: string;
 }
 /**
  * Server response structure for successful message delivery.
@@ -73,20 +80,24 @@ export interface SendMessageResponse {
  *
  * @property {string[]} messageIds - An array of message IDs to acknowledge.
  * @property {string} [host] - Optional host URL where the messages originated.
+ * @property {string} [originator] - Optional originator of the message box client.
  */
 export interface AcknowledgeMessageParams {
     messageIds: string[];
     host?: string;
+    originator?: string;
 }
 /**
  * Parameters for listing messages in a message box.
  *
  * @property messageBox - The identifier of the message box to retrieve messages from.
  * @property host - (Optional) The host URL to connect to for retrieving messages.
+ * @property originator - (Optional) The originator of the message box client.
  */
 export interface ListMessagesParams {
     messageBox: string;
     host?: string;
+    originator?: string;
 }
 /**
  * Encapsulates an AES-256-GCM encrypted message body.
@@ -96,4 +107,71 @@ export interface ListMessagesParams {
 export interface EncryptedMessage {
     encryptedMessage: Base64String;
 }
+export interface AdvertisementToken {
+    host: string;
+    txid: HexString;
+    outputIndex: number;
+    lockingScript: LockingScript;
+    beef: BEEF;
+}
+export interface Payment {
+    tx: AtomicBEEF;
+    outputs: Array<{
+        outputIndex: PositiveIntegerOrZero;
+        protocol: 'wallet payment' | 'basket insertion';
+        paymentRemittance?: {
+            derivationPrefix: Base64String;
+            derivationSuffix: Base64String;
+            senderIdentityKey: PubKeyHex;
+        };
+        insertionRemittance?: {
+            basket: BasketStringUnder300Bytes;
+            customInstructions?: string;
+            tags?: OutputTagStringUnder300Bytes[];
+        };
+    }>;
+    description: DescriptionString5to50Bytes;
+    labels?: LabelStringUnder300Bytes[];
+    seekPermission?: BooleanDefaultTrue;
+}
+/**
+ * Device registration parameters for FCM notifications
+ */
+export interface DeviceRegistrationParams {
+    /** FCM token from Firebase SDK */
+    fcmToken: string;
+    /** Optional device identifier */
+    deviceId?: string;
+    /** Optional platform type */
+    platform?: 'ios' | 'android' | 'web';
+}
+/**
+ * Device registration response
+ */
+export interface DeviceRegistrationResponse {
+    status: string;
+    message: string;
+    deviceId: number;
+}
+/**
+ * Registered device information
+ */
+export interface RegisteredDevice {
+    id: number;
+    deviceId: string | null;
+    platform: string | null;
+    fcmToken: string;
+    active: boolean;
+    createdAt: string;
+    updatedAt: string;
+    lastUsed: string;
+}
+/**
+ * Response from listing registered devices
+ */
+export interface ListDevicesResponse {
+    status: string;
+    devices: RegisteredDevice[];
+    description?: string;
+}
 //# sourceMappingURL=types.d.ts.map

package/dist/types/src/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AAErD;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,YAAY,CAAC,EAAE,YAAY,CAAA;IAE3B;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IAEvB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,SAAS,CAAA;CAChD;AAED;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC1B,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAClC,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,MAAM,CAAA;IACjB,UAAU,EAAE,MAAM,CAAA;IAClB,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;IACrB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;CAClB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,wBAAwB;IACvC,UAAU,EAAE,MAAM,EAAE,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IACjC,UAAU,EAAE,MAAM,CAAA;IAClB,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,gBAAgB,EAAE,YAAY,CAAA;CAC/B"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,yBAAyB,EAAE,IAAI,EAAE,kBAAkB,EAAE,2BAA2B,EAAE,SAAS,EAAE,wBAAwB,EAAE,aAAa,EAAE,4BAA4B,EAAE,qBAAqB,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,UAAU,CAAA;AAE1Q;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,YAAY,CAAC,EAAE,eAAe,CAAA;IAE9B;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IAEvB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,SAAS,CAAA;IAE/C;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC1B,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAClC,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,MAAM,CAAA;IACjB,UAAU,EAAE,MAAM,CAAA;IAClB,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;IACrB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,gGAAgG;IAChG,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;CAClB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,wBAAwB;IACvC,UAAU,EAAE,MAAM,EAAE,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,kBAAkB;IACjC,UAAU,EAAE,MAAM,CAAA;IAClB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,gBAAgB,EAAE,YAAY,CAAA;CAC/B;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,SAAS,CAAA;IACf,WAAW,EAAE,MAAM,CAAA;IACnB,aAAa,EAAE,aAAa,CAAA;IAC5B,IAAI,EAAE,IAAI,CAAA;CACX;AAED,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,UAAU,CAAA;IACd,OAAO,EAAE,KAAK,CAAC;QACb,WAAW,EAAE,qBAAqB,CAAA;QAClC,QAAQ,EAAE,gBAAgB,GAAG,kBAAkB,CAAA;QAC/C,iBAAiB,CAAC,EAAE;YAClB,gBAAgB,EAAE,YAAY,CAAA;YAC9B,gBAAgB,EAAE,YAAY,CAAA;YAC9B,iBAAiB,EAAE,SAAS,CAAA;SAC7B,CAAA;QACD,mBAAmB,CAAC,EAAE;YACpB,MAAM,EAAE,yBAAyB,CAAA;YACjC,kBAAkB,CAAC,EAAE,MAAM,CAAA;YAC3B,IAAI,CAAC,EAAE,4BAA4B,EAAE,CAAA;SACtC,CAAA;KACF,CAAC,CAAA;IACF,WAAW,EAAE,2BAA2B,CAAA;IACxC,MAAM,CAAC,EAAE,wBAAwB,EAAE,CAAA;IACnC,cAAc,CAAC,EAAE,kBAAkB,CAAA;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,kCAAkC;IAClC,QAAQ,EAAE,MAAM,CAAA;IAChB,iCAAiC;IACjC,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,6BAA6B;IAC7B,QAAQ,CAAC,EAAE,KAAK,GAAG,SAAS,GAAG,KAAK,CAAA;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAA;IACV,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,OAAO,CAAA;IACf,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,EAAE,gBAAgB,EAAE,CAAA;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB"}