nostr-websocket-utils/dist/cjs/types/messages.d.ts

Robust WebSocket utilities for Nostr applications with automatic reconnection, supporting both ESM and CommonJS. Features channel-based messaging, heartbeat monitoring, message queueing, and comprehensive error handling with type-safe handlers.

/**
 * @file Message type definitions
 * @module types/messages
 */
import { MessagePriority } from './priority.js';
/**
 * Message types that can be sent through the WebSocket connection
 * Following NIP-01 and other NIPs message types
 */
export declare const MESSAGE_TYPES: {
    readonly EVENT: "EVENT";
    readonly REQ: "REQ";
    readonly CLOSE: "CLOSE";
    readonly NOTICE: "NOTICE";
    readonly EOSE: "EOSE";
    readonly OK: "OK";
    readonly AUTH: "AUTH";
    readonly COUNT: "COUNT";
    readonly PING: "PING";
    readonly PONG: "PONG";
    readonly ERROR: "error";
};
export type MessageType = keyof typeof MESSAGE_TYPES;
/**
 * Base Nostr WebSocket message interface
 */
export interface NostrWSMessageBase {
    type: MessageType;
    data?: unknown;
    priority?: MessagePriority;
    queuedAt?: number;
    retryCount?: number;
}
/**
 * Nostr WebSocket message type
 * Array format: [<message_type>, ...data]
 */
export type NostrWSMessage = [MessageType, ...unknown[]];
/**
 * Queue item interface for message queue
 */
export interface QueueItem extends NostrWSMessageBase {
    priority: MessagePriority;
    queuedAt: number;
    retryCount: number;
}
/**
 * Nostr event message
 */
export interface NostrEvent {
    id: string;
    kind: number;
    content: string;
    tags: string[][];
    created_at?: number;
    pubkey?: string;
    sig?: string;
}
/**
 * Server-side Nostr WebSocket message
 * Extends the base NostrWSMessage tuple type with additional server-specific metadata
 */
export type NostrWSServerMessage = NostrWSMessage & {
    clientId?: string;
    timestamp?: number;
};
/**
 * Helper function to create server messages
 */
export declare function createServerMessage(type: MessageType, data: unknown[], clientId?: string): NostrWSServerMessage;
/**
 * Structure of a Nostr WebSocket filter
 */
export interface NostrWSFilter {
    /** Array of event IDs */
    ids?: string[];
    /** Array of pubkeys */
    authors?: string[];
    /** Array of event kinds */
    kinds?: number[];
    /** Event tags */
    tags?: Record<string, string[]>;
    /** Unix timestamp range */
    since?: number;
    until?: number;
    /** Maximum number of events to return */
    limit?: number;
}
/**
 * Represents a subscription to a Nostr relay
 */
export interface NostrWSSubscription {
    /**
     * Unique identifier for the subscription
     */
    subscription_id: string;
    /**
     * Filters for the subscription
     */
    filters: Array<Record<string, unknown>>;
    /**
     * Active state of the subscription
     */
    active?: boolean;
    /**
     * Timestamp when the subscription was created
     */
    createdAt?: number;
}
/**
 * Result of validating a NostrWSMessage
 */
export interface NostrWSValidationResult {
    /**
     * Whether the message is valid
     */
    isValid: boolean;
    /**
     * Error message if validation failed
     */
    error?: string;
}
/**
 * Connection states for WebSocket client
 */
export declare enum ConnectionState {
    CONNECTING = "CONNECTING",
    CONNECTED = "CONNECTED",
    DISCONNECTED = "DISCONNECTED",
    RECONNECTING = "RECONNECTING",
    FAILED = "FAILED"
}
//# sourceMappingURL=messages.d.ts.map