@unicitylabs/sphere-sdk 0.3.8 → 0.4.0

package/dist/impl/nodejs/index.d.cts

@@ -46,6 +46,11 @@ interface Identity {
 interface FullIdentity extends Identity {
     readonly privateKey: string;
 }
+interface ComposingIndicator {
+    readonly senderPubkey: string;
+    readonly senderNametag?: string;
+    readonly expiresIn: number;
+}
 /**
  * Minimal data stored in persistent storage for a tracked address.
  * Only contains user state — derived fields are computed on load.
@@ -422,6 +427,38 @@ interface TransportProvider extends BaseProvider {
      * @returns Unsubscribe function
      */
     onPaymentRequestResponse?(handler: PaymentRequestResponseHandler): () => void;
+    /**
+     * Send a read receipt for a message
+     * @param recipientTransportPubkey - Transport pubkey of the message sender
+     * @param messageEventId - Event ID of the message being acknowledged
+     */
+    sendReadReceipt?(recipientTransportPubkey: string, messageEventId: string): Promise<void>;
+    /**
+     * Subscribe to incoming read receipts
+     * @returns Unsubscribe function
+     */
+    onReadReceipt?(handler: ReadReceiptHandler): () => void;
+    /**
+     * Send typing indicator to a recipient
+     * @param recipientTransportPubkey - Transport pubkey of the conversation partner
+     */
+    sendTypingIndicator?(recipientTransportPubkey: string): Promise<void>;
+    /**
+     * Subscribe to incoming typing indicators
+     * @returns Unsubscribe function
+     */
+    onTypingIndicator?(handler: TypingIndicatorHandler): () => void;
+    /**
+     * Send composing indicator to a recipient using NIP-44 encrypted gift wrap
+     * @param recipientTransportPubkey - Transport pubkey of the conversation partner
+     * @param content - JSON payload with senderNametag and expiresIn
+     */
+    sendComposingIndicator?(recipientTransportPubkey: string, content: string): Promise<void>;
+    /**
+     * Subscribe to incoming composing indicators
+     * @returns Unsubscribe function
+     */
+    onComposing?(handler: ComposingHandler): () => void;
     /**
      * Get list of configured relay URLs
      */
@@ -511,6 +548,10 @@ interface IncomingMessage {
     content: string;
     timestamp: number;
     encrypted: boolean;
+    /** Set when this is a self-wrap replay (sent message recovered from relay) */
+    isSelfWrap?: boolean;
+    /** Recipient pubkey — only present on self-wrap replays */
+    recipientTransportPubkey?: string;
 }
 type MessageHandler = (message: IncomingMessage) => void;
 interface TokenTransferPayload {
@@ -632,6 +673,25 @@ interface PeerInfo {
     /** Event timestamp */
     timestamp: number;
 }
+interface IncomingReadReceipt {
+    /** Transport-specific pubkey of the sender who read the message */
+    senderTransportPubkey: string;
+    /** Event ID of the message that was read */
+    messageEventId: string;
+    /** Timestamp */
+    timestamp: number;
+}
+type ReadReceiptHandler = (receipt: IncomingReadReceipt) => void;
+interface IncomingTypingIndicator {
+    /** Transport-specific pubkey of the sender who is typing */
+    senderTransportPubkey: string;
+    /** Sender's nametag (if known) */
+    senderNametag?: string;
+    /** Timestamp */
+    timestamp: number;
+}
+type TypingIndicatorHandler = (indicator: IncomingTypingIndicator) => void;
+type ComposingHandler = (indicator: ComposingIndicator) => void;
 
 /**
  * WebSocket Abstraction
@@ -724,6 +784,10 @@ declare class NostrTransportProvider implements TransportProvider {
     private transferHandlers;
     private paymentRequestHandlers;
     private paymentRequestResponseHandlers;
+    private readReceiptHandlers;
+    private typingIndicatorHandlers;
+    private composingHandlers;
+    private pendingMessages;
     private broadcastHandlers;
     private eventCallbacks;
     constructor(config: NostrTransportProviderConfig);
@@ -773,6 +837,12 @@ declare class NostrTransportProvider implements TransportProvider {
     onPaymentRequest(handler: PaymentRequestHandler): () => void;
     sendPaymentRequestResponse(recipientPubkey: string, payload: PaymentRequestResponsePayload): Promise<string>;
     onPaymentRequestResponse(handler: PaymentRequestResponseHandler): () => void;
+    sendReadReceipt(recipientTransportPubkey: string, messageEventId: string): Promise<void>;
+    onReadReceipt(handler: ReadReceiptHandler): () => void;
+    sendTypingIndicator(recipientTransportPubkey: string): Promise<void>;
+    onTypingIndicator(handler: TypingIndicatorHandler): () => void;
+    onComposing(handler: ComposingHandler): () => void;
+    sendComposingIndicator(recipientPubkey: string, content: string): Promise<void>;
     /**
      * Resolve any identifier to full peer information.
      * Routes to the appropriate specific resolve method based on identifier format.
@@ -846,6 +916,12 @@ declare class NostrTransportProvider implements TransportProvider {
     private ensureConnected;
     private ensureReady;
     private emitEvent;
+    /**
+     * Create a NIP-17 gift wrap with a custom inner rumor kind.
+     * Replicates the three-layer NIP-59 envelope (rumor → seal → gift wrap)
+     * because NIP17.createGiftWrap hardcodes kind 14 for the inner rumor.
+     */
+    private createCustomKindGiftWrap;
     private log;
 }
 
@@ -1316,6 +1392,15 @@ interface BasePriceConfig {
     /** Enable debug logging */
     debug?: boolean;
 }
+/**
+ * Base market module configuration
+ */
+interface BaseMarketConfig {
+    /** Market API base URL (default: https://market-api.unicity.network) */
+    apiUrl?: string;
+    /** Request timeout in ms (default: 30000) */
+    timeout?: number;
+}
 /**
  * Base providers result
  * Common structure for all platforms
@@ -1331,6 +1416,13 @@ interface BaseProviders {
     price?: PriceProvider;
 }
 
+interface MarketModuleConfig {
+    /** Market API base URL (default: https://market-api.unicity.network) */
+    apiUrl?: string;
+    /** Request timeout in ms (default: 30000) */
+    timeout?: number;
+}
+
 /** IPFS storage provider configuration */
 interface IpfsStorageConfig {
     /** Gateway URLs for HTTP API (defaults to Unicity dedicated nodes) */
@@ -1423,6 +1515,8 @@ interface NodeProvidersConfig {
         enabled?: boolean;
         relays?: string[];
     } | boolean;
+    /** Market module configuration. true = enable with defaults, object = custom config */
+    market?: BaseMarketConfig | boolean;
 }
 interface NodeProviders {
     storage: StorageProvider;
@@ -1437,6 +1531,8 @@ interface NodeProviders {
     ipfsTokenStorage?: TokenStorageProvider<TxfStorageDataBase>;
     /** Group chat config (resolved, for passing to Sphere.init) */
     groupChat?: GroupChatModuleConfig | boolean;
+    /** Market module config (resolved, for passing to Sphere.init) */
+    market?: MarketModuleConfig | boolean;
 }
 /**
  * Create all Node.js providers with default configuration

package/dist/impl/nodejs/index.d.ts

@@ -46,6 +46,11 @@ interface Identity {
 interface FullIdentity extends Identity {
     readonly privateKey: string;
 }
+interface ComposingIndicator {
+    readonly senderPubkey: string;
+    readonly senderNametag?: string;
+    readonly expiresIn: number;
+}
 /**
  * Minimal data stored in persistent storage for a tracked address.
  * Only contains user state — derived fields are computed on load.
@@ -422,6 +427,38 @@ interface TransportProvider extends BaseProvider {
      * @returns Unsubscribe function
      */
     onPaymentRequestResponse?(handler: PaymentRequestResponseHandler): () => void;
+    /**
+     * Send a read receipt for a message
+     * @param recipientTransportPubkey - Transport pubkey of the message sender
+     * @param messageEventId - Event ID of the message being acknowledged
+     */
+    sendReadReceipt?(recipientTransportPubkey: string, messageEventId: string): Promise<void>;
+    /**
+     * Subscribe to incoming read receipts
+     * @returns Unsubscribe function
+     */
+    onReadReceipt?(handler: ReadReceiptHandler): () => void;
+    /**
+     * Send typing indicator to a recipient
+     * @param recipientTransportPubkey - Transport pubkey of the conversation partner
+     */
+    sendTypingIndicator?(recipientTransportPubkey: string): Promise<void>;
+    /**
+     * Subscribe to incoming typing indicators
+     * @returns Unsubscribe function
+     */
+    onTypingIndicator?(handler: TypingIndicatorHandler): () => void;
+    /**
+     * Send composing indicator to a recipient using NIP-44 encrypted gift wrap
+     * @param recipientTransportPubkey - Transport pubkey of the conversation partner
+     * @param content - JSON payload with senderNametag and expiresIn
+     */
+    sendComposingIndicator?(recipientTransportPubkey: string, content: string): Promise<void>;
+    /**
+     * Subscribe to incoming composing indicators
+     * @returns Unsubscribe function
+     */
+    onComposing?(handler: ComposingHandler): () => void;
     /**
      * Get list of configured relay URLs
      */
@@ -511,6 +548,10 @@ interface IncomingMessage {
     content: string;
     timestamp: number;
     encrypted: boolean;
+    /** Set when this is a self-wrap replay (sent message recovered from relay) */
+    isSelfWrap?: boolean;
+    /** Recipient pubkey — only present on self-wrap replays */
+    recipientTransportPubkey?: string;
 }
 type MessageHandler = (message: IncomingMessage) => void;
 interface TokenTransferPayload {
@@ -632,6 +673,25 @@ interface PeerInfo {
     /** Event timestamp */
     timestamp: number;
 }
+interface IncomingReadReceipt {
+    /** Transport-specific pubkey of the sender who read the message */
+    senderTransportPubkey: string;
+    /** Event ID of the message that was read */
+    messageEventId: string;
+    /** Timestamp */
+    timestamp: number;
+}
+type ReadReceiptHandler = (receipt: IncomingReadReceipt) => void;
+interface IncomingTypingIndicator {
+    /** Transport-specific pubkey of the sender who is typing */
+    senderTransportPubkey: string;
+    /** Sender's nametag (if known) */
+    senderNametag?: string;
+    /** Timestamp */
+    timestamp: number;
+}
+type TypingIndicatorHandler = (indicator: IncomingTypingIndicator) => void;
+type ComposingHandler = (indicator: ComposingIndicator) => void;
 
 /**
  * WebSocket Abstraction
@@ -724,6 +784,10 @@ declare class NostrTransportProvider implements TransportProvider {
     private transferHandlers;
     private paymentRequestHandlers;
     private paymentRequestResponseHandlers;
+    private readReceiptHandlers;
+    private typingIndicatorHandlers;
+    private composingHandlers;
+    private pendingMessages;
     private broadcastHandlers;
     private eventCallbacks;
     constructor(config: NostrTransportProviderConfig);
@@ -773,6 +837,12 @@ declare class NostrTransportProvider implements TransportProvider {
     onPaymentRequest(handler: PaymentRequestHandler): () => void;
     sendPaymentRequestResponse(recipientPubkey: string, payload: PaymentRequestResponsePayload): Promise<string>;
     onPaymentRequestResponse(handler: PaymentRequestResponseHandler): () => void;
+    sendReadReceipt(recipientTransportPubkey: string, messageEventId: string): Promise<void>;
+    onReadReceipt(handler: ReadReceiptHandler): () => void;
+    sendTypingIndicator(recipientTransportPubkey: string): Promise<void>;
+    onTypingIndicator(handler: TypingIndicatorHandler): () => void;
+    onComposing(handler: ComposingHandler): () => void;
+    sendComposingIndicator(recipientPubkey: string, content: string): Promise<void>;
     /**
      * Resolve any identifier to full peer information.
      * Routes to the appropriate specific resolve method based on identifier format.
@@ -846,6 +916,12 @@ declare class NostrTransportProvider implements TransportProvider {
     private ensureConnected;
     private ensureReady;
     private emitEvent;
+    /**
+     * Create a NIP-17 gift wrap with a custom inner rumor kind.
+     * Replicates the three-layer NIP-59 envelope (rumor → seal → gift wrap)
+     * because NIP17.createGiftWrap hardcodes kind 14 for the inner rumor.
+     */
+    private createCustomKindGiftWrap;
     private log;
 }
 
@@ -1316,6 +1392,15 @@ interface BasePriceConfig {
     /** Enable debug logging */
     debug?: boolean;
 }
+/**
+ * Base market module configuration
+ */
+interface BaseMarketConfig {
+    /** Market API base URL (default: https://market-api.unicity.network) */
+    apiUrl?: string;
+    /** Request timeout in ms (default: 30000) */
+    timeout?: number;
+}
 /**
  * Base providers result
  * Common structure for all platforms
@@ -1331,6 +1416,13 @@ interface BaseProviders {
     price?: PriceProvider;
 }
 
+interface MarketModuleConfig {
+    /** Market API base URL (default: https://market-api.unicity.network) */
+    apiUrl?: string;
+    /** Request timeout in ms (default: 30000) */
+    timeout?: number;
+}
+
 /** IPFS storage provider configuration */
 interface IpfsStorageConfig {
     /** Gateway URLs for HTTP API (defaults to Unicity dedicated nodes) */
@@ -1423,6 +1515,8 @@ interface NodeProvidersConfig {
         enabled?: boolean;
         relays?: string[];
     } | boolean;
+    /** Market module configuration. true = enable with defaults, object = custom config */
+    market?: BaseMarketConfig | boolean;
 }
 interface NodeProviders {
     storage: StorageProvider;
@@ -1437,6 +1531,8 @@ interface NodeProviders {
     ipfsTokenStorage?: TokenStorageProvider<TxfStorageDataBase>;
     /** Group chat config (resolved, for passing to Sphere.init) */
     groupChat?: GroupChatModuleConfig | boolean;
+    /** Market module config (resolved, for passing to Sphere.init) */
+    market?: MarketModuleConfig | boolean;
 }
 /**
  * Create all Node.js providers with default configuration