applesauce-relay 0.0.0-next-20250806165639 → 0.0.0-next-20250815164532

package/dist/__tests__/spy.js

@@ -0,0 +1,65 @@
+export function createClientSpy(addOnMessageListener) {
+    let queue = { type: "empty" };
+    addOnMessageListener((message) => {
+        switch (queue.type) {
+            case "empty": {
+                queue = {
+                    type: "message",
+                    items: [message],
+                };
+                break;
+            }
+            case "message": {
+                queue.items.push(message);
+                break;
+            }
+            case "resolver": {
+                const item = queue.items.shift();
+                if (item) {
+                    const resolve = item[0];
+                    resolve(message);
+                }
+                if (queue.items.length <= 0) {
+                    queue = { type: "empty" };
+                }
+            }
+        }
+    });
+    return {
+        __createClientSpy: true,
+        next: () => new Promise((resolve, reject) => {
+            switch (queue.type) {
+                case "empty": {
+                    queue = {
+                        type: "resolver",
+                        items: [[resolve, reject]],
+                    };
+                    break;
+                }
+                case "message": {
+                    const msg = queue.items.shift();
+                    if (msg) {
+                        resolve(msg);
+                    }
+                    if (queue.items.length <= 0) {
+                        queue = { type: "empty" };
+                    }
+                    break;
+                }
+                case "resolver": {
+                    queue.items.push([resolve, reject]);
+                    break;
+                }
+            }
+        }),
+        dispose: () => {
+            if (queue.type === "resolver") {
+                for (const item of queue.items) {
+                    const reject = item[1];
+                    reject(new Error());
+                }
+            }
+            queue = { type: "empty" };
+        },
+    };
+}

package/dist/__tests__/utils.d.ts

@@ -0,0 +1,3 @@
+export declare class TimeoutError extends Error {
+}
+export declare function withTimeout<T>(task: Promise<T> | (() => Promise<T>), message?: string, timeout?: number): Promise<T>;

package/dist/__tests__/utils.js

@@ -0,0 +1,8 @@
+export class TimeoutError extends Error {
+}
+export function withTimeout(task, message, timeout = 1000) {
+    return Promise.race([
+        typeof task === "function" ? task() : task,
+        new Promise((_, reject) => setTimeout(() => reject(new TimeoutError(message)), timeout)),
+    ]);
+}

package/dist/operators/__tests__/exports.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/operators/__tests__/exports.test.js

@@ -0,0 +1,15 @@
+import { describe, expect, it } from "vitest";
+import * as exports from "../index.js";
+describe("exports", () => {
+    it("should export the expected functions", () => {
+        expect(Object.keys(exports).sort()).toMatchInlineSnapshot(`
+      [
+        "completeOnEose",
+        "markFromRelay",
+        "onlyEvents",
+        "storeEvents",
+        "toEventStore",
+      ]
+    `);
+    });
+});

package/dist/operators/__tests__/to-event-store.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/operators/__tests__/to-event-store.test.js

@@ -0,0 +1,18 @@
+import { EventStore } from "applesauce-core";
+import { describe, expect, it } from "vitest";
+import { FakeUser } from "../../__tests__/fake-user.js";
+import { of } from "rxjs";
+import { subscribeSpyTo } from "@hirez_io/observer-spy";
+import { toEventStore } from "../to-event-store.js";
+const user = new FakeUser();
+describe("toEventStore", () => {
+    it("should remove duplicate events", () => {
+        const eventStore = new EventStore();
+        const event = user.note("original content");
+        const source = of(event, { ...event }, { ...event }, { ...event });
+        const spy = subscribeSpyTo(source.pipe(toEventStore(eventStore)));
+        expect(spy.getValuesLength()).toBe(1);
+        expect(spy.getValueAt(0).length).toBe(1);
+        expect(spy.getValueAt(0)[0]).toBe(event);
+    });
+});

package/dist/relay.d.ts

@@ -1,16 +1,20 @@
 import { logger } from "applesauce-core";
 import { type Filter, type NostrEvent } from "nostr-tools";
-import { BehaviorSubject, Observable } from "rxjs";
-import { WebSocketSubject, WebSocketSubjectConfig } from "rxjs/webSocket";
 import { RelayInformation } from "nostr-tools/nip11";
+import { BehaviorSubject, MonoTypeOperatorFunction, Observable, RepeatConfig, RetryConfig, Subject } from "rxjs";
+import { WebSocketSubject, WebSocketSubjectConfig } from "rxjs/webSocket";
 import { AuthSigner, FilterInput, IRelay, PublishOptions, PublishResponse, RequestOptions, SubscriptionOptions, SubscriptionResponse } from "./types.js";
 /** An error that is thrown when a REQ is closed from the relay side */
 export declare class ReqCloseError extends Error {
 }
 export type RelayOptions = {
+    /** Custom WebSocket implementation */
     WebSocket?: WebSocketSubjectConfig<any>["WebSocketCtor"];
+    /** How long to wait for an EOSE message (default 10s) */
     eoseTimeout?: number;
+    /** How long to wait for an OK message from the relay (default 10s) */
     eventTimeout?: number;
+    /** How long to keep the connection alive after nothing is subscribed (default 30s) */
     keepAlive?: number;
 };
 export declare class Relay implements IRelay {
@@ -50,6 +54,12 @@ export declare class Relay implements IRelay {
     protected _nip11: RelayInformation | null;
     /** An observable that emits the limitations for the relay */
     limitations$: Observable<RelayInformation["limitation"] | null>;
+    /** An observable that emits when underlying websocket is opened */
+    open$: Subject<Event>;
+    /** An observable that emits when underlying websocket is closed */
+    close$: Subject<CloseEvent>;
+    /** An observable that emits when underlying websocket is closing due to unsubscription */
+    closing$: Subject<void>;
     get connected(): boolean;
     get challenge(): string | null;
     get notices(): string[];
@@ -87,6 +97,10 @@ export declare class Relay implements IRelay {
     auth(event: NostrEvent): Promise<PublishResponse>;
     /** Authenticate with the relay using a signer */
     authenticate(signer: AuthSigner): Promise<PublishResponse>;
+    /** Internal operator for creating the retry() operator */
+    protected customRetryOperator<T extends unknown = unknown>(times: number | RetryConfig): MonoTypeOperatorFunction<T>;
+    /** Internal operator for creating the repeat() operator */
+    protected customRepeatOperator<T extends unknown = unknown>(times: boolean | number | RepeatConfig | undefined): MonoTypeOperatorFunction<T>;
     /** Creates a REQ that retries when relay errors ( default 3 retries ) */
     subscription(filters: Filter | Filter[], opts?: SubscriptionOptions): Observable<SubscriptionResponse>;
     /** Makes a single request that retires on errors and completes on EOSE */

package/dist/relay.js

@@ -1,10 +1,10 @@
 import { logger } from "applesauce-core";
+import { ensureHttpURL } from "applesauce-core/helpers";
 import { simpleTimeout } from "applesauce-core/observable";
 import { nanoid } from "nanoid";
 import { nip42 } from "nostr-tools";
-import { BehaviorSubject, catchError, combineLatest, defer, endWith, filter, finalize, from, ignoreElements, isObservable, lastValueFrom, map, merge, mergeMap, mergeWith, NEVER, of, retry, scan, share, shareReplay, Subject, switchMap, take, takeUntil, tap, throwError, timeout, timer, } from "rxjs";
+import { BehaviorSubject, catchError, combineLatest, defer, endWith, filter, finalize, from, identity, ignoreElements, isObservable, lastValueFrom, map, merge, mergeMap, mergeWith, NEVER, of, repeat, retry, scan, share, shareReplay, Subject, switchMap, take, takeUntil, tap, throwError, timeout, timer, } from "rxjs";
 import { webSocket } from "rxjs/webSocket";
-import { ensureHttpURL } from "applesauce-core/helpers";
 import { completeOnEose } from "./operators/complete-on-eose.js";
 import { markFromRelay } from "./operators/mark-from-relay.js";
 /** An error that is thrown when a REQ is closed from the relay side */
@@ -47,6 +47,12 @@ export class Relay {
     _nip11 = null;
     /** An observable that emits the limitations for the relay */
     limitations$;
+    /** An observable that emits when underlying websocket is opened */
+    open$ = new Subject();
+    /** An observable that emits when underlying websocket is closed */
+    close$ = new Subject();
+    /** An observable that emits when underlying websocket is closing due to unsubscription */
+    closing$ = new Subject();
     // sync state
     get connected() {
         return this.connected$.value;
@@ -107,28 +113,28 @@ export class Relay {
         this.authenticated$ = this.authenticationResponse$.pipe(map((response) => response?.ok === true));
         /** Use the static method to create a new reconnect method for this relay */
         this.reconnectTimer = Relay.createReconnectTimer(url);
+        // Subscribe to open and close events
+        this.open$.subscribe(() => {
+            this.log("Connected");
+            this.connected$.next(true);
+            this.attempts$.next(0);
+            this.error$.next(null);
+            this.resetState();
+        });
+        this.close$.subscribe((event) => {
+            this.log("Disconnected");
+            this.connected$.next(false);
+            this.attempts$.next(this.attempts$.value + 1);
+            this.resetState();
+            // Start the reconnect timer if the connection was not closed cleanly
+            if (!event.wasClean)
+                this.startReconnectTimer(event);
+        });
         this.socket = webSocket({
             url,
-            openObserver: {
-                next: () => {
-                    this.log("Connected");
-                    this.connected$.next(true);
-                    this.attempts$.next(0);
-                    this.error$.next(null);
-                    this.resetState();
-                },
-            },
-            closeObserver: {
-                next: (event) => {
-                    this.log("Disconnected");
-                    this.connected$.next(false);
-                    this.attempts$.next(this.attempts$.value + 1);
-                    this.resetState();
-                    // Start the reconnect timer if the connection was not closed cleanly
-                    if (!event.wasClean)
-                        this.startReconnectTimer(event);
-                },
-            },
+            openObserver: this.open$,
+            closeObserver: this.close$,
+            closingObserver: this.closing$,
             WebSocketCtor: opts?.WebSocket,
         });
         // Create an observable to fetch the NIP-11 information document
@@ -207,7 +213,7 @@ export class Relay {
     }
     /** Wait for authentication state, make connection and then wait for authentication if required */
     waitForAuth(
-    // NOTE: require BehaviorSubject so it always has a value
+    // NOTE: require BehaviorSubject or shareReplay so it always has a value
     requireAuth, observable) {
         return combineLatest([requireAuth, this.authenticated$]).pipe(
         // Once the auth state is known, make a connection and watch for auth challenges
@@ -245,21 +251,26 @@ export class Relay {
         // Convert filters input into an observable, if its a normal value merge it with NEVER so it never completes
         const input = isObservable(filters) ? filters : merge(of(filters), NEVER);
         // Create an observable that completes when the upstream observable completes
-        const complete = input.pipe(ignoreElements(), endWith(null));
+        const filtersComplete = input.pipe(ignoreElements(), endWith(null));
         // Create an observable that filters responses from the relay to just the ones for this REQ
-        const messages = this.socket.pipe(filter((m) => Array.isArray(m) && (m[0] === "EVENT" || m[0] === "CLOSED" || m[0] === "EOSE") && m[1] === id));
+        const messages = this.socket.pipe(filter((m) => Array.isArray(m) && (m[0] === "EVENT" || m[0] === "CLOSED" || m[0] === "EOSE") && m[1] === id), 
+        // Singleton (prevents the .pipe() operator later from sending two REQ messages )
+        share());
         // Create an observable that controls sending the filters and closing the REQ
         const control = input.pipe(
         // Send the filters when they change
         tap((filters) => this.socket.next(Array.isArray(filters) ? ["REQ", id, ...filters] : ["REQ", id, filters])), 
-        // Close the req when unsubscribed
+        // Send the CLOSE message when unsubscribed or input completes
         finalize(() => this.socket.next(["CLOSE", id])), 
         // Once filters have been sent, switch to listening for messages
         switchMap(() => messages));
         // Start the watch tower with the observables
         const observable = merge(this.watchTower, control).pipe(
+        // Complete the subscription when the control observable completes
+        // This is to work around the fact that merge() waits for both observables to complete
+        takeUntil(messages.pipe(ignoreElements(), endWith(true))), 
         // Complete the subscription when the input is completed
-        takeUntil(complete), 
+        takeUntil(filtersComplete), 
         // Map the messages to events, EOSE, or throw an error
         map((message) => {
             if (message[0] === "EOSE")
@@ -294,15 +305,20 @@ export class Relay {
     }
     /** Send an EVENT or AUTH message and return an observable of PublishResponse that completes or errors */
     event(event, verb = "EVENT") {
-        const base = defer(() => {
+        const messages = defer(() => {
             // Send event when subscription starts
             this.socket.next([verb, event]);
             return this.socket.pipe(filter((m) => m[0] === "OK" && m[1] === event.id), 
             // format OK message
             map((m) => ({ ok: m[2], message: m[3], from: this.url })));
-        });
+        }).pipe(
+        // Singleton (prevents the .pipe() operator later from sending two EVENT messages )
+        share());
         // Start the watch tower and add complete operators
-        const observable = merge(this.watchTower, base).pipe(
+        const observable = merge(this.watchTower, messages).pipe(
+        // Complete the subscription when the messages observable completes
+        // This is to work around the fact that merge() waits for both observables to complete
+        takeUntil(messages.pipe(ignoreElements(), endWith(true))), 
         // complete on first value
         take(1), 
         // listen for OK auth-required
@@ -339,19 +355,45 @@ export class Relay {
         const start = p instanceof Promise ? from(p) : of(p);
         return lastValueFrom(start.pipe(switchMap((event) => this.auth(event))));
     }
+    /** Internal operator for creating the retry() operator */
+    customRetryOperator(times) {
+        if (typeof times === "number")
+            return retry(times);
+        else
+            return retry(times);
+    }
+    /** Internal operator for creating the repeat() operator */
+    customRepeatOperator(times) {
+        if (times === false || times === undefined)
+            return identity;
+        else if (times === true)
+            return repeat();
+        else if (typeof times === "number")
+            return repeat(times);
+        else
+            return repeat(times);
+    }
     /** Creates a REQ that retries when relay errors ( default 3 retries ) */
     subscription(filters, opts) {
         return this.req(filters, opts?.id).pipe(
         // Retry on connection errors
-        retry({ count: opts?.retries ?? 3, resetOnSuccess: true }));
+        this.customRetryOperator(opts?.retries ?? 3), 
+        // Create reconnect logic (repeat operator)
+        this.customRepeatOperator(opts?.reconnect), 
+        // Single subscription
+        share());
     }
     /** Makes a single request that retires on errors and completes on EOSE */
     request(filters, opts) {
         return this.req(filters, opts?.id).pipe(
         // Retry on connection errors
-        retry(opts?.retries ?? 3), 
+        this.customRetryOperator(opts?.retries ?? 3), 
+        // Create reconnect logic (repeat operator)
+        this.customRepeatOperator(opts?.reconnect), 
         // Complete when EOSE is received
-        completeOnEose());
+        completeOnEose(), 
+        // Single subscription
+        share());
     }
     /** Publishes an event to the relay and retries when relay errors or responds with auth-required ( default 3 retries ) */
     publish(event, opts) {
@@ -362,7 +404,11 @@ export class Relay {
             return of(result);
         }), 
         // Retry the publish until it succeeds or the number of retries is reached
-        retry(opts?.retries ?? 3)));
+        this.customRetryOperator(opts?.retries ?? 3), 
+        // Create reconnect logic (repeat operator)
+        this.customRepeatOperator(opts?.reconnect), 
+        // Single subscription
+        share()));
     }
     /** Force close the connection */
     close() {

package/dist/server/connection.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/server/connection.js

@@ -0,0 +1,9 @@
+import { z } from "zod";
+const IncomingREQ = z.tuple([z.literal("REQ"), z.string(), z.array(z.any())]);
+const IncomingEVENT = z.tuple([z.literal("EVENT"), z.any()]);
+const IncomingCLOSE = z.tuple([z.literal("CLOSE"), z.string()]);
+const IncomingAUTH = z.tuple([z.literal("AUTH"), z.any()]);
+const OutgoingEVENT = z.tuple([z.literal("EVENT"), z.string(), z.any()]);
+const OutgoingNOTICE = z.tuple([z.literal("NOTICE"), z.string()]);
+const OutgoingCLOSE = z.tuple([z.literal("CLOSE"), z.string()]);
+const OutgoingAUTH = z.tuple([z.literal("AUTH"), z.string()]);

package/dist/types.d.ts

@@ -1,5 +1,5 @@
 import { type EventTemplate, type Filter, type NostrEvent } from "nostr-tools";
-import { Observable } from "rxjs";
+import { Observable, repeat, retry } from "rxjs";
 import { WebSocketSubject } from "rxjs/webSocket";
 export type SubscriptionResponse = NostrEvent | "EOSE";
 export type PublishResponse = {
@@ -8,16 +8,35 @@ export type PublishResponse = {
     from: string;
 };
 export type MultiplexWebSocket<T = any> = Pick<WebSocketSubject<T>, "multiplex">;
+/** Options for the publish method on the pool and relay */
 export type PublishOptions = {
-    retries?: number;
-};
-export type RequestOptions = {
-    id?: string;
-    retries?: number;
+    /**
+     * Number of times to retry the publish. default is 3
+     * @see https://rxjs.dev/api/index/function/retry
+     */
+    retries?: number | Parameters<typeof retry>[0];
+    /**
+     * Whether to reconnect when socket is closed. A number of times or true for infinite. default is false
+     * @see https://rxjs.dev/api/index/function/repeat
+     */
+    reconnect?: boolean | Parameters<typeof repeat>[0];
 };
+/** Options for the request method on the pool and relay */
+export type RequestOptions = SubscriptionOptions;
+/** Options for the subscription method on the pool and relay */
 export type SubscriptionOptions = {
+    /** Custom REQ id for the subscription */
     id?: string;
-    retries?: number;
+    /**
+     * Number of times to retry a request. default is 3
+     * @see https://rxjs.dev/api/index/function/retry
+     */
+    retries?: number | Parameters<typeof retry>[0];
+    /**
+     * Whether to reconnect when socket is closed. A number of times or true for infinite. default is false
+     * @see https://rxjs.dev/api/index/function/repeat
+     */
+    reconnect?: boolean | Parameters<typeof repeat>[0];
 };
 export type AuthSigner = {
     signEvent: (event: EventTemplate) => NostrEvent | Promise<NostrEvent>;
@@ -47,19 +66,11 @@ export interface IRelay extends MultiplexWebSocket {
     /** Authenticate with the relay using a signer */
     authenticate(signer: AuthSigner): Promise<PublishResponse>;
     /** Send an EVENT message with retries */
-    publish(event: NostrEvent, opts?: {
-        retries?: number;
-    }): Promise<PublishResponse>;
+    publish(event: NostrEvent, opts?: PublishOptions): Promise<PublishResponse>;
     /** Send a REQ message with retries */
-    request(filters: FilterInput, opts?: {
-        id?: string;
-        retries?: number;
-    }): Observable<NostrEvent>;
+    request(filters: FilterInput, opts?: RequestOptions): Observable<NostrEvent>;
     /** Open a subscription with retries */
-    subscription(filters: FilterInput, opts?: {
-        id?: string;
-        retries?: number;
-    }): Observable<SubscriptionResponse>;
+    subscription(filters: FilterInput, opts?: SubscriptionOptions): Observable<SubscriptionResponse>;
 }
 export interface IGroup {
     /** Send a REQ message */
@@ -67,19 +78,11 @@ export interface IGroup {
     /** Send an EVENT message */
     event(event: NostrEvent): Observable<PublishResponse>;
     /** Send an EVENT message with retries */
-    publish(event: NostrEvent, opts?: {
-        retries?: number;
-    }): Promise<PublishResponse[]>;
+    publish(event: NostrEvent, opts?: PublishOptions): Promise<PublishResponse[]>;
     /** Send a REQ message with retries */
-    request(filters: FilterInput, opts?: {
-        id?: string;
-        retries?: number;
-    }): Observable<NostrEvent>;
+    request(filters: FilterInput, opts?: RequestOptions): Observable<NostrEvent>;
     /** Open a subscription with retries */
-    subscription(filters: FilterInput, opts?: {
-        id?: string;
-        retries?: number;
-    }): Observable<SubscriptionResponse>;
+    subscription(filters: FilterInput, opts?: SubscriptionOptions): Observable<SubscriptionResponse>;
 }
 export interface IPool {
     /** Get or create a relay */
@@ -93,17 +96,9 @@ export interface IPool {
     /** Send an EVENT message */
     event(relays: string[], event: NostrEvent): Observable<PublishResponse>;
     /** Send an EVENT message to relays with retries */
-    publish(relays: string[], event: NostrEvent, opts?: {
-        retries?: number;
-    }): Promise<PublishResponse[]>;
+    publish(relays: string[], event: NostrEvent, opts?: PublishOptions): Promise<PublishResponse[]>;
     /** Send a REQ message to relays with retries */
-    request(relays: string[], filters: FilterInput, opts?: {
-        id?: string;
-        retries?: number;
-    }): Observable<NostrEvent>;
+    request(relays: string[], filters: FilterInput, opts?: RequestOptions): Observable<NostrEvent>;
     /** Open a subscription to relays with retries */
-    subscription(relays: string[], filters: FilterInput, opts?: {
-        id?: string;
-        retries?: number;
-    }): Observable<SubscriptionResponse>;
+    subscription(relays: string[], filters: FilterInput, opts?: SubscriptionOptions): Observable<SubscriptionResponse>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "applesauce-relay",
-  "version": "0.0.0-next-20250806165639",
+  "version": "0.0.0-next-20250815164532",
   "description": "nostr relay communication framework built on rxjs",
   "type": "module",
   "main": "dist/index.js",
@@ -54,14 +54,14 @@
   },
   "dependencies": {
     "@noble/hashes": "^1.7.1",
-    "applesauce-core": "0.0.0-next-20250806165639",
+    "applesauce-core": "0.0.0-next-20250815164532",
     "nanoid": "^5.0.9",
     "nostr-tools": "^2.13",
     "rxjs": "^7.8.1"
   },
   "devDependencies": {
     "@hirez_io/observer-spy": "^2.2.0",
-    "applesauce-signers": "0.0.0-next-20250806165639",
+    "applesauce-signers": "0.0.0-next-20250815164532",
     "@vitest/expect": "^3.1.1",
     "typescript": "^5.7.3",
     "vitest": "^3.2.3",