@bsv/message-box-client 1.1.10 → 1.2.0

package/src/PeerPayClient.ts

@@ -13,9 +13,9 @@
 import { MessageBoxClient } from './MessageBoxClient.js'
 import { PeerMessage } from './types.js'
 import { WalletClient, P2PKH, PublicKey, createNonce, AtomicBEEF, AuthFetch, Base64String } from '@bsv/sdk'
-import { Logger } from './Utils/logger.js'
+import * as Logger from './Utils/logger.js'
 
-function safeParse<T> (input: any): T {
+function safeParse<T>(input: any): T {
   try {
     return typeof input === 'string' ? JSON.parse(input) : input
   } catch (e) {
@@ -74,7 +74,7 @@ export class PeerPayClient extends MessageBoxClient {
   private readonly peerPayWalletClient: WalletClient
   private _authFetchInstance?: AuthFetch
 
-  constructor (config: PeerPayClientConfig) {
+  constructor(config: PeerPayClientConfig) {
     const { messageBoxHost = 'https://messagebox.babbage.systems', walletClient, enableLogging = false } = config
 
     // 🔹 Pass enableLogging to MessageBoxClient
@@ -83,7 +83,7 @@ export class PeerPayClient extends MessageBoxClient {
     this.peerPayWalletClient = walletClient
   }
 
-  private get authFetchInstance (): AuthFetch {
+  private get authFetchInstance(): AuthFetch {
     if (this._authFetchInstance === null || this._authFetchInstance === undefined) {
       this._authFetchInstance = new AuthFetch(this.peerPayWalletClient)
     }
@@ -102,7 +102,7 @@ export class PeerPayClient extends MessageBoxClient {
    * @returns {Promise<PaymentToken>} A valid payment token containing transaction details.
    * @throws {Error} If the recipient's public key cannot be derived.
    */
-  async createPaymentToken (payment: PaymentParams): Promise<PaymentToken> {
+  async createPaymentToken(payment: PaymentParams): Promise<PaymentToken> {
     if (payment.amount <= 0) {
       throw new Error('Invalid payment details: recipient and valid amount are required')
     };
@@ -178,7 +178,7 @@ export class PeerPayClient extends MessageBoxClient {
    * @returns {Promise<any>} Resolves with the payment result.
    * @throws {Error} If the recipient is missing or the amount is invalid.
    */
-  async sendPayment (payment: PaymentParams): Promise<any> {
+  async sendPayment(payment: PaymentParams): Promise<any> {
     if (payment.recipient == null || payment.recipient.trim() === '' || payment.amount <= 0) {
       throw new Error('Invalid payment details: recipient and valid amount are required')
     }
@@ -206,7 +206,7 @@ export class PeerPayClient extends MessageBoxClient {
    * @returns {Promise<void>} Resolves when the payment has been sent.
    * @throws {Error} If payment token generation fails.
    */
-  async sendLivePayment (payment: PaymentParams): Promise<void> {
+  async sendLivePayment(payment: PaymentParams): Promise<void> {
     const paymentToken = await this.createPaymentToken(payment)
 
     try {
@@ -239,7 +239,7 @@ export class PeerPayClient extends MessageBoxClient {
    * @param {Function} obj.onPayment - Callback function triggered when a payment is received.
    * @returns {Promise<void>} Resolves when the listener is successfully set up.
    */
-  async listenForLivePayments ({
+  async listenForLivePayments({
     onPayment
   }: { onPayment: (payment: IncomingPayment) => void }): Promise<void> {
     await this.listenForLiveMessages({
@@ -270,7 +270,7 @@ export class PeerPayClient extends MessageBoxClient {
    * @returns {Promise<any>} Resolves with the payment result if successful.
    * @throws {Error} If payment processing fails.
    */
-  async acceptPayment (payment: IncomingPayment): Promise<any> {
+  async acceptPayment(payment: IncomingPayment): Promise<any> {
     try {
       Logger.log(`[PP CLIENT] Processing payment: ${JSON.stringify(payment, null, 2)}`)
 
@@ -310,7 +310,7 @@ export class PeerPayClient extends MessageBoxClient {
    * @param {IncomingPayment} payment - The payment object containing transaction details.
    * @returns {Promise<void>} Resolves when the payment is either acknowledged or refunded.
    */
-  async rejectPayment (payment: IncomingPayment): Promise<void> {
+  async rejectPayment(payment: IncomingPayment): Promise<void> {
     Logger.log(`[PP CLIENT] Rejecting payment: ${JSON.stringify(payment, null, 2)}`)
 
     if (payment.token.amount - 1000 < 1000) {
@@ -370,7 +370,7 @@ export class PeerPayClient extends MessageBoxClient {
    *
    * @returns {Promise<IncomingPayment[]>} Resolves with an array of pending payments.
    */
-  async listIncomingPayments (): Promise<IncomingPayment[]> {
+  async listIncomingPayments(): Promise<IncomingPayment[]> {
     const messages = await this.listMessages({ messageBox: STANDARD_PAYMENT_MESSAGEBOX })
 
     return messages.map((msg: any) => {

package/src/Utils/logger.ts

@@ -1,27 +1,25 @@
-export class Logger {
-  private static isEnabled = false
+let isEnabled = false
 
-  static enable (): void {
-    this.isEnabled = true
-  }
+export function enable (): void {
+  isEnabled = true
+}
 
-  static disable (): void {
-    this.isEnabled = false
-  }
+export function disable (): void {
+  isEnabled = false
+}
 
-  static log (...args: unknown[]): void {
-    if (this.isEnabled) {
-      console.log(...args)
-    }
+export function log (...args: unknown[]): void {
+  if (isEnabled) {
+    console.log(...args)
   }
+}
 
-  static warn (...args: unknown[]): void {
-    if (this.isEnabled) {
-      console.warn(...args)
-    }
+export function warn (...args: unknown[]): void {
+  if (isEnabled) {
+    console.warn(...args)
   }
+}
 
-  static error (...args: unknown[]): void {
-    console.error(...args)
-  }
+export function error (...args: unknown[]): void {
+  console.error(...args)
 }

package/src/types/permissions.ts

@@ -0,0 +1,81 @@
+/**
+ * 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
+}

package/src/types.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.
@@ -8,7 +8,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.
@@ -27,6 +27,11 @@ export interface MessageBoxClientOptions {
    * @default 'local'
    */
   networkPreset?: 'local' | 'mainnet' | 'testnet'
+
+  /**
+   * Originator of the message box client.
+   */
+  originator?: string
 }
 
 /**
@@ -62,6 +67,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
 }
 
 /**
@@ -81,10 +89,12 @@ 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
 }
 
 /**
@@ -92,10 +102,12 @@ export interface AcknowledgeMessageParams {
  *
  * @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
 }
 
 /**
@@ -106,3 +118,76 @@ 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 // Truncated for security (shows only last 10 characters)
+  active: boolean
+  createdAt: string
+  updatedAt: string
+  lastUsed: string
+}
+
+/**
+ * Response from listing registered devices
+ */
+export interface ListDevicesResponse {
+  status: string
+  devices: RegisteredDevice[]
+  description?: string // For error responses
+}