nostr-websocket-utils 0.3.1 → 0.3.3

package/dist/cjs/types/events.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * @file Nostr event type definitions
+ * @module types/events
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=events.js.map

package/dist/cjs/types/events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../../../src/types/events.ts"],"names":[],"mappings":";AAAA;;;GAGG"}

package/dist/cjs/types/filters.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @file Filter type definitions
+ * @module types/filters
+ */
+import { NostrEventFilter } from './events';
+/**
+ * Subscription request filter
+ */
+export interface NostrSubscriptionFilter extends NostrEventFilter {
+    subscriptionId?: string;
+    limit?: number;
+}
+/**
+ * Filter validation result
+ */
+export interface NostrFilterValidationResult {
+    valid: boolean;
+    error?: string;
+}
+//# sourceMappingURL=filters.d.ts.map

package/dist/cjs/types/filters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"filters.d.ts","sourceRoot":"","sources":["../../../src/types/filters.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE5C;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,gBAAgB;IAC/D,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,KAAK,EAAE,OAAO,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB"}

package/dist/cjs/types/filters.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * @file Filter type definitions
+ * @module types/filters
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=filters.js.map

package/dist/cjs/types/filters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"filters.js","sourceRoot":"","sources":["../../../src/types/filters.ts"],"names":[],"mappings":";AAAA;;;GAGG"}

package/dist/cjs/types/handlers.d.ts

@@ -0,0 +1,81 @@
+/**
+ * @file Handler type definitions for WebSocket events
+ * @module types/handlers
+ */
+import type { WebSocket } from 'ws';
+import type { NostrWSMessage } from './messages';
+import type { ExtendedWebSocket } from './websocket';
+/**
+ * Events emitted by the NostrWSClient
+ * @interface NostrWSClientEvents
+ */
+export interface NostrWSClientEvents {
+    /**
+     * Emitted when the client connects to the relay
+     */
+    connect: () => void;
+    /**
+     * Emitted when the client disconnects from the relay
+     */
+    disconnect: () => void;
+    /**
+     * Emitted when the client reconnects to the relay
+     */
+    reconnect: () => void;
+    /**
+     * Emitted when a message is received from the relay
+     * @param message - The received message
+     */
+    message: (message: NostrWSMessage) => void;
+    /**
+     * Emitted when an error occurs
+     * @param error - The error object
+     */
+    error: (error: Error) => void;
+}
+/**
+ * Events emitted by the NostrWSServer
+ * @interface NostrWSServerEvents
+ */
+export interface NostrWSServerEvents {
+    /**
+     * Emitted when a client connects to the server
+     * @param client - The connected client
+     */
+    connection: (client: ExtendedWebSocket) => void;
+    /**
+     * Emitted when a message is received from a client
+     * @param message - The received message
+     * @param client - The client that sent the message
+     */
+    message: (message: NostrWSMessage, client: ExtendedWebSocket) => void;
+    /**
+     * Emitted when an error occurs
+     * @param error - The error object
+     */
+    error: (error: Error) => void;
+}
+/**
+ * Configuration options for WebSocket handlers
+ * @interface NostrWSHandlers
+ */
+export interface NostrWSHandlers {
+    /**
+     * Handler for incoming messages
+     * @param ws - The WebSocket instance
+     * @param message - The received message
+     */
+    message: (ws: ExtendedWebSocket, message: NostrWSMessage) => Promise<void> | void;
+    /**
+     * Handler for WebSocket errors
+     * @param ws - The WebSocket instance
+     * @param error - The error object
+     */
+    error?: (ws: WebSocket, error: Error) => void;
+    /**
+     * Handler for WebSocket connection close
+     * @param ws - The WebSocket instance
+     */
+    close?: (ws: WebSocket) => void;
+}
+//# sourceMappingURL=handlers.d.ts.map

package/dist/cjs/types/handlers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"handlers.d.ts","sourceRoot":"","sources":["../../../src/types/handlers.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,IAAI,CAAC;AACpC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAErD;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,OAAO,EAAE,MAAM,IAAI,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,MAAM,IAAI,CAAC;IAEvB;;OAEG;IACH,SAAS,EAAE,MAAM,IAAI,CAAC;IAEtB;;;OAGG;IACH,OAAO,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,IAAI,CAAC;IAE3C;;;OAGG;IACH,KAAK,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,UAAU,EAAE,CAAC,MAAM,EAAE,iBAAiB,KAAK,IAAI,CAAC;IAEhD;;;;OAIG;IACH,OAAO,EAAE,CAAC,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,iBAAiB,KAAK,IAAI,CAAC;IAEtE;;;OAGG;IACH,KAAK,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;OAIG;IACH,OAAO,EAAE,CAAC,EAAE,EAAE,iBAAiB,EAAE,OAAO,EAAE,cAAc,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAElF;;;;OAIG;IACH,KAAK,CAAC,EAAE,CAAC,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IAE9C;;;OAGG;IACH,KAAK,CAAC,EAAE,CAAC,EAAE,EAAE,SAAS,KAAK,IAAI,CAAC;CACjC"}

package/dist/cjs/types/handlers.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * @file Handler type definitions for WebSocket events
+ * @module types/handlers
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=handlers.js.map

package/dist/cjs/types/handlers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"handlers.js","sourceRoot":"","sources":["../../../src/types/handlers.ts"],"names":[],"mappings":";AAAA;;;GAGG"}

package/dist/cjs/types/index.d.ts

@@ -0,0 +1,144 @@
+/**
+ * @file Core type definitions
+ * @module types
+ */
+import type { WebSocket } from 'ws';
+import type { Logger } from './logger';
+import type { NostrWSMessage, NostrEvent as MessageNostrEvent } from './messages';
+export { NostrWSMessage } from './messages';
+export { QueueItem } from './messages';
+export * from './filters';
+export * from './relays';
+export * from './logger';
+export * from './priority';
+export type NostrEvent = MessageNostrEvent;
+/**
+ * Extended WebSocket interface with client ID
+ */
+export interface ExtendedWebSocket extends WebSocket {
+    clientId?: string;
+    isAlive?: boolean;
+    subscriptions?: Set<string>;
+    lastPing?: number;
+    reconnectAttempts?: number;
+    messageQueue?: NostrWSMessage[];
+}
+/**
+ * WebSocket connection states
+ */
+export declare enum ConnectionState {
+    CONNECTING = "CONNECTING",
+    CONNECTED = "CONNECTED",
+    DISCONNECTED = "DISCONNECTED",
+    RECONNECTING = "RECONNECTING",
+    FAILED = "FAILED"
+}
+/**
+ * Retry configuration options
+ */
+export interface RetryConfig {
+    maxAttempts: number;
+    initialDelay: number;
+    maxDelay: number;
+    backoffFactor: number;
+}
+/**
+ * Queue configuration options
+ */
+export interface QueueConfig {
+    maxSize: number;
+    maxRetries: number;
+    retryDelay: number;
+    staleTimeout: number;
+}
+/**
+ * Heartbeat configuration options
+ */
+export interface HeartbeatConfig {
+    interval: number;
+    timeout: number;
+    maxMissed: number;
+}
+/**
+ * WebSocket client options
+ */
+export interface NostrWSOptions {
+    WebSocketImpl?: typeof WebSocket;
+    connectionTimeout?: number;
+    retryAttempts?: number;
+    retryDelay?: number;
+    onMessage?: (message: string) => void;
+    onError?: (error: Error) => void;
+    retry?: Partial<RetryConfig>;
+    queue?: Partial<QueueConfig>;
+    heartbeat?: Partial<HeartbeatConfig>;
+    autoReconnect?: boolean;
+    bufferMessages?: boolean;
+    cleanStaleMessages?: boolean;
+    logger?: Logger;
+}
+/**
+ * Represents a subscription to a Nostr relay
+ */
+export interface NostrWSSubscription {
+    /**
+     * Channel identifier for the subscription
+     */
+    channel: string;
+    /**
+     * Filter criteria for the subscription
+     */
+    filter?: Record<string, unknown>;
+}
+/**
+ * Events emitted by the NostrWSClient
+ */
+export interface NostrWSClientEvents {
+    /**
+     * Emitted when the client connects to the relay
+     */
+    connect: () => void;
+    /**
+     * Emitted when the client disconnects from the relay
+     */
+    disconnect: () => void;
+    /**
+     * Emitted when the client reconnects to the relay
+     */
+    reconnect: () => void;
+    /**
+     * Emitted when a message is received from the relay
+     * @param message - The received message
+     */
+    message: (message: NostrWSMessage) => Promise<void>;
+    /**
+     * Emitted when an error occurs
+     * @param error - The error that occurred
+     */
+    error: (error: Error) => void;
+    close: () => void;
+    stateChange?: (state: ConnectionState) => void;
+    heartbeat?: () => void;
+}
+/**
+ * Events emitted by the NostrWSServer
+ */
+export interface NostrWSServerEvents {
+    /**
+     * Emitted when a client connects
+     * @param client - The connected client
+     */
+    connection: (client: ExtendedWebSocket) => void;
+    /**
+     * Emitted when a message is received from a client
+     * @param message - The received message
+     * @param client - The client that sent the message
+     */
+    message: (message: NostrWSMessage, client: ExtendedWebSocket) => void;
+    /**
+     * Emitted when an error occurs
+     * @param error - The error that occurred
+     */
+    error: (error: Error) => void;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/cjs/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,IAAI,CAAC;AACpC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,KAAK,EAAE,cAAc,EAAE,UAAU,IAAI,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAGlF,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAC5C,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAG3B,MAAM,MAAM,UAAU,GAAG,iBAAiB,CAAC;AAE3C;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,SAAS;IAClD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,aAAa,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,YAAY,CAAC,EAAE,cAAc,EAAE,CAAC;CACjC;AAED;;GAEG;AACH,oBAAY,eAAe;IACzB,UAAU,eAAe;IACzB,SAAS,cAAc;IACvB,YAAY,iBAAiB;IAC7B,YAAY,iBAAiB;IAC7B,MAAM,WAAW;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,aAAa,CAAC,EAAE,OAAO,SAAS,CAAC;IACjC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IACtC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IACjC,KAAK,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;IAC7B,KAAK,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;IAC7B,SAAS,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;IACrC,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,OAAO,EAAE,MAAM,IAAI,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,MAAM,IAAI,CAAC;IAEvB;;OAEG;IACH,SAAS,EAAE,MAAM,IAAI,CAAC;IAEtB;;;OAGG;IACH,OAAO,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpD;;;OAGG;IACH,KAAK,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IAC9B,KAAK,EAAE,MAAM,IAAI,CAAC;IAClB,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,eAAe,KAAK,IAAI,CAAC;IAC/C,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,UAAU,EAAE,CAAC,MAAM,EAAE,iBAAiB,KAAK,IAAI,CAAC;IAEhD;;;;OAIG;IACH,OAAO,EAAE,CAAC,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,iBAAiB,KAAK,IAAI,CAAC;IAEtE;;;OAGG;IACH,KAAK,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;CAC/B"}

package/dist/cjs/types/index.js

@@ -0,0 +1,37 @@
+"use strict";
+/**
+ * @file Core type definitions
+ * @module types
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConnectionState = void 0;
+__exportStar(require("./filters"), exports);
+__exportStar(require("./relays"), exports);
+__exportStar(require("./logger"), exports);
+__exportStar(require("./priority"), exports);
+/**
+ * WebSocket connection states
+ */
+var ConnectionState;
+(function (ConnectionState) {
+    ConnectionState["CONNECTING"] = "CONNECTING";
+    ConnectionState["CONNECTED"] = "CONNECTED";
+    ConnectionState["DISCONNECTED"] = "DISCONNECTED";
+    ConnectionState["RECONNECTING"] = "RECONNECTING";
+    ConnectionState["FAILED"] = "FAILED";
+})(ConnectionState || (exports.ConnectionState = ConnectionState = {}));
+//# sourceMappingURL=index.js.map

package/dist/cjs/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;AASH,4CAA0B;AAC1B,2CAAyB;AACzB,2CAAyB;AACzB,6CAA2B;AAiB3B;;GAEG;AACH,IAAY,eAMX;AAND,WAAY,eAAe;IACzB,4CAAyB,CAAA;IACzB,0CAAuB,CAAA;IACvB,gDAA6B,CAAA;IAC7B,gDAA6B,CAAA;IAC7B,oCAAiB,CAAA;AACnB,CAAC,EANW,eAAe,+BAAf,eAAe,QAM1B"}

package/dist/cjs/types/logger.d.ts

@@ -0,0 +1,41 @@
+/**
+ * @file Logger type definitions
+ * @module types/logger
+ */
+import type { Logger as PinoLogger } from 'pino';
+export type Logger = PinoLogger;
+/**
+ * WebSocket context for logging
+ */
+export interface WebSocketLogContext {
+    clientId?: string;
+    url?: string;
+    messageId?: string;
+    [key: string]: unknown;
+}
+/**
+ * Extended logger interface with WebSocket-specific methods
+ */
+export interface NostrWSLogger extends Logger {
+    /**
+     * Log WebSocket connection event
+     */
+    wsConnect(context: WebSocketLogContext): void;
+    /**
+     * Log WebSocket disconnection event
+     */
+    wsDisconnect(context: WebSocketLogContext): void;
+    /**
+     * Log WebSocket message event
+     */
+    wsMessage(context: WebSocketLogContext): void;
+    /**
+     * Log WebSocket error event
+     */
+    wsError(error: Error, context: WebSocketLogContext): void;
+    /**
+     * Log WebSocket metrics
+     */
+    wsMetrics(metrics: Record<string, unknown>, context: WebSocketLogContext): void;
+}
+//# sourceMappingURL=logger.d.ts.map

package/dist/cjs/types/logger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../../src/types/logger.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,MAAM,IAAI,UAAU,EAAE,MAAM,MAAM,CAAC;AAEjD,MAAM,MAAM,MAAM,GAAG,UAAU,CAAC;AAEhC;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,MAAM;IAC3C;;OAEG;IACH,SAAS,CAAC,OAAO,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAE9C;;OAEG;IACH,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAEjD;;OAEG;IACH,SAAS,CAAC,OAAO,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAE9C;;OAEG;IACH,OAAO,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAE1D;;OAEG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,EAAE,mBAAmB,GAAG,IAAI,CAAC;CACjF"}

package/dist/cjs/types/logger.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * @file Logger type definitions
+ * @module types/logger
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=logger.js.map

package/dist/cjs/types/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../../src/types/logger.ts"],"names":[],"mappings":";AAAA;;;GAGG"}

package/dist/cjs/types/messages.d.ts

@@ -0,0 +1,133 @@
+/**
+ * @file Message type definitions
+ * @module types/messages
+ */
+import { MessagePriority } from './priority';
+/**
+ * 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

package/dist/cjs/types/messages.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../../../src/types/messages.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAE7C;;;GAGG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;CAYhB,CAAC;AAEX,MAAM,MAAM,WAAW,GAAG,MAAM,OAAO,aAAa,CAAC;AAErD;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,WAAW,CAAC;IAClB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,QAAQ,CAAC,EAAE,eAAe,CAAC;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,WAAW,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;AAEzD;;GAEG;AACH,MAAM,WAAW,SAAU,SAAQ,kBAAkB;IACnD,QAAQ,EAAE,eAAe,CAAC;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,cAAc,GAAG;IAClD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,oBAAoB,CAK/G;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,yBAAyB;IACzB,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;IACf,uBAAuB;IACvB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,2BAA2B;IAC3B,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,iBAAiB;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IAChC,2BAA2B;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,yCAAyC;IACzC,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAExC;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,oBAAY,eAAe;IACzB,UAAU,eAAe;IACzB,SAAS,cAAc;IACvB,YAAY,iBAAiB;IAC7B,YAAY,iBAAiB;IAC7B,MAAM,WAAW;CAClB"}

package/dist/cjs/types/messages.js

@@ -0,0 +1,46 @@
+"use strict";
+/**
+ * @file Message type definitions
+ * @module types/messages
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConnectionState = exports.MESSAGE_TYPES = void 0;
+exports.createServerMessage = createServerMessage;
+/**
+ * Message types that can be sent through the WebSocket connection
+ * Following NIP-01 and other NIPs message types
+ */
+exports.MESSAGE_TYPES = {
+    EVENT: 'EVENT', // NIP-01: Basic protocol flow events
+    REQ: 'REQ', // NIP-01: Request events
+    CLOSE: 'CLOSE', // NIP-01: Close subscription
+    NOTICE: 'NOTICE', // NIP-01: Human-readable messages
+    EOSE: 'EOSE', // NIP-15: End of stored events notice
+    OK: 'OK', // NIP-20: Command result
+    AUTH: 'AUTH', // NIP-42: Authentication
+    COUNT: 'COUNT', // NIP-45: Event counts
+    PING: 'PING', // Internal heartbeat ping
+    PONG: 'PONG', // Internal heartbeat pong
+    ERROR: 'error' // Internal error type (lowercase to differentiate)
+};
+/**
+ * Helper function to create server messages
+ */
+function createServerMessage(type, data, clientId) {
+    const message = [type, ...data];
+    message.clientId = clientId;
+    message.timestamp = Date.now();
+    return message;
+}
+/**
+ * Connection states for WebSocket client
+ */
+var ConnectionState;
+(function (ConnectionState) {
+    ConnectionState["CONNECTING"] = "CONNECTING";
+    ConnectionState["CONNECTED"] = "CONNECTED";
+    ConnectionState["DISCONNECTED"] = "DISCONNECTED";
+    ConnectionState["RECONNECTING"] = "RECONNECTING";
+    ConnectionState["FAILED"] = "FAILED";
+})(ConnectionState || (exports.ConnectionState = ConnectionState = {}));
+//# sourceMappingURL=messages.js.map

package/dist/cjs/types/messages.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"messages.js","sourceRoot":"","sources":["../../../src/types/messages.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AA2EH,kDAKC;AA5ED;;;GAGG;AACU,QAAA,aAAa,GAAG;IAC3B,KAAK,EAAE,OAAO,EAAK,qCAAqC;IACxD,GAAG,EAAE,KAAK,EAAQ,yBAAyB;IAC3C,KAAK,EAAE,OAAO,EAAI,6BAA6B;IAC/C,MAAM,EAAE,QAAQ,EAAE,kCAAkC;IACpD,IAAI,EAAE,MAAM,EAAM,sCAAsC;IACxD,EAAE,EAAE,IAAI,EAAU,yBAAyB;IAC3C,IAAI,EAAE,MAAM,EAAM,yBAAyB;IAC3C,KAAK,EAAE,OAAO,EAAI,uBAAuB;IACzC,IAAI,EAAE,MAAM,EAAM,0BAA0B;IAC5C,IAAI,EAAE,MAAM,EAAM,0BAA0B;IAC5C,KAAK,EAAE,OAAO,CAAI,mDAAmD;CAC7D,CAAC;AAoDX;;GAEG;AACH,SAAgB,mBAAmB,CAAC,IAAiB,EAAE,IAAe,EAAE,QAAiB;IACvF,MAAM,OAAO,GAAG,CAAC,IAAI,EAAE,GAAG,IAAI,CAAyB,CAAC;IACxD,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC5B,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAC/B,OAAO,OAAO,CAAC;AACjB,CAAC;AA6DD;;GAEG;AACH,IAAY,eAMX;AAND,WAAY,eAAe;IACzB,4CAAyB,CAAA;IACzB,0CAAuB,CAAA;IACvB,gDAA6B,CAAA;IAC7B,gDAA6B,CAAA;IAC7B,oCAAiB,CAAA;AACnB,CAAC,EANW,eAAe,+BAAf,eAAe,QAM1B"}