applesauce-relay 3.0.0 → 3.1.0

package/dist/relay.d.ts

@@ -98,9 +98,9 @@ export declare class Relay implements IRelay {
     /** 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>;
+    protected customRetryOperator<T extends unknown = unknown>(times: undefined | boolean | number | RetryConfig, base?: RetryConfig): MonoTypeOperatorFunction<T>;
     /** Internal operator for creating the repeat() operator */
-    protected customRepeatOperator<T extends unknown = unknown>(times: boolean | number | RepeatConfig | undefined): MonoTypeOperatorFunction<T>;
+    protected customRepeatOperator<T extends unknown = unknown>(times: undefined | 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

@@ -7,6 +7,7 @@ import { BehaviorSubject, catchError, combineLatest, defer, endWith, filter, fin
 import { webSocket } from "rxjs/webSocket";
 import { completeOnEose } from "./operators/complete-on-eose.js";
 import { markFromRelay } from "./operators/mark-from-relay.js";
+const DEFAULT_RETRY_CONFIG = { count: 10, delay: 1000, resetOnSuccess: true };
 /** An error that is thrown when a REQ is closed from the relay side */
 export class ReqCloseError extends Error {
 }
@@ -356,11 +357,15 @@ export class Relay {
         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);
+    customRetryOperator(times, base) {
+        if (times === false)
+            return identity;
+        else if (typeof times === "number")
+            return retry({ ...base, count: times });
+        else if (times === true)
+            return base ? retry(base) : retry();
         else
-            return retry(times);
+            return retry({ ...base, ...times });
     }
     /** Internal operator for creating the repeat() operator */
     customRepeatOperator(times) {
@@ -377,9 +382,9 @@ export class Relay {
     subscription(filters, opts) {
         return this.req(filters, opts?.id).pipe(
         // Retry on connection errors
-        this.customRetryOperator(opts?.retries ?? 3), 
-        // Create reconnect logic (repeat operator)
-        this.customRepeatOperator(opts?.reconnect), 
+        this.customRetryOperator(opts?.retries ?? opts?.reconnect ?? true, DEFAULT_RETRY_CONFIG), 
+        // Create resubscribe logic (repeat operator)
+        this.customRepeatOperator(opts?.resubscribe), 
         // Single subscription
         share());
     }
@@ -387,9 +392,9 @@ export class Relay {
     request(filters, opts) {
         return this.req(filters, opts?.id).pipe(
         // Retry on connection errors
-        this.customRetryOperator(opts?.retries ?? 3), 
-        // Create reconnect logic (repeat operator)
-        this.customRepeatOperator(opts?.reconnect), 
+        this.customRetryOperator(opts?.retries ?? opts?.reconnect ?? true, DEFAULT_RETRY_CONFIG), 
+        // Create resubscribe logic (repeat operator)
+        this.customRepeatOperator(opts?.resubscribe), 
         // Complete when EOSE is received
         completeOnEose(), 
         // Single subscription
@@ -404,9 +409,7 @@ export class Relay {
             return of(result);
         }), 
         // Retry the publish until it succeeds or the number of retries is reached
-        this.customRetryOperator(opts?.retries ?? 3), 
-        // Create reconnect logic (repeat operator)
-        this.customRepeatOperator(opts?.reconnect), 
+        this.customRetryOperator(opts?.retries ?? opts?.reconnect ?? true, DEFAULT_RETRY_CONFIG), 
         // Single subscription
         share()));
     }

package/dist/types.d.ts

@@ -11,15 +11,16 @@ export type MultiplexWebSocket<T = any> = Pick<WebSocketSubject<T>, "multiplex">
 /** Options for the publish method on the pool and relay */
 export type PublishOptions = {
     /**
-     * Number of times to retry the publish. default is 3
+     * Number of times to retry the publish. default is 10
      * @see https://rxjs.dev/api/index/function/retry
+     * @deprecated use `reconnect` instead
      */
     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
+     * Whether to reconnect when socket fails to connect. default is true (10 retries with 1 second delay)
+     * @see https://rxjs.dev/api/index/function/retry
      */
-    reconnect?: boolean | Parameters<typeof repeat>[0];
+    reconnect?: boolean | number | Parameters<typeof retry>[0];
 };
 /** Options for the request method on the pool and relay */
 export type RequestOptions = SubscriptionOptions;
@@ -28,15 +29,21 @@ export type SubscriptionOptions = {
     /** Custom REQ id for the subscription */
     id?: string;
     /**
-     * Number of times to retry a request. default is 3
+     * Number of times to retry the subscription if the relay fails to connect. default is 10
      * @see https://rxjs.dev/api/index/function/retry
+     * @deprecated use `reconnect` instead
      */
     retries?: number | Parameters<typeof retry>[0];
     /**
-     * Whether to reconnect when socket is closed. A number of times or true for infinite. default is false
+     * Whether to resubscribe if the subscription is closed by the relay. default is false
      * @see https://rxjs.dev/api/index/function/repeat
      */
-    reconnect?: boolean | Parameters<typeof repeat>[0];
+    resubscribe?: boolean | number | Parameters<typeof repeat>[0];
+    /**
+     * Whether to reconnect when socket is closed. default is true (10 retries with 1 second delay)
+     * @see https://rxjs.dev/api/index/function/retry
+     */
+    reconnect?: boolean | number | Parameters<typeof retry>[0];
 };
 export type AuthSigner = {
     signEvent: (event: EventTemplate) => NostrEvent | Promise<NostrEvent>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "applesauce-relay",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "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": "^3.0.0",
+    "applesauce-core": "^3.1.0",
     "nanoid": "^5.0.9",
-    "nostr-tools": "^2.13",
+    "nostr-tools": "~2.15",
     "rxjs": "^7.8.1"
   },
   "devDependencies": {
     "@hirez_io/observer-spy": "^2.2.0",
-    "applesauce-signers": "^3.0.0",
+    "applesauce-signers": "^3.1.0",
     "@vitest/expect": "^3.1.1",
     "typescript": "^5.7.3",
     "vitest": "^3.2.3",