applesauce-relay 2.0.0 → 2.3.0

package/dist/relay.d.ts

@@ -24,8 +24,10 @@ export declare class Relay implements IRelay {
     connected$: BehaviorSubject<boolean>;
     /** The authentication challenge string from the relay */
     challenge$: BehaviorSubject<string | null>;
-    /** Whether the client is authenticated with the relay */
-    authenticated$: BehaviorSubject<boolean>;
+    /** Boolean authentication state (will be false if auth failed) */
+    authenticated$: Observable<boolean>;
+    /** The response to the last AUTH message sent to the relay */
+    authenticationResponse$: BehaviorSubject<PublishResponse | null>;
     /** The notices from the relay */
     notices$: BehaviorSubject<string[]>;
     /** The last connection error */
@@ -49,6 +51,7 @@ export declare class Relay implements IRelay {
     get challenge(): string | null;
     get notices(): string[];
     get authenticated(): boolean;
+    get authenticationResponse(): PublishResponse | null;
     get information(): RelayInformation | null;
     /** If an EOSE message is not seen in this time, emit one locally  */
     eoseTimeout: number;
@@ -58,8 +61,8 @@ export declare class Relay implements IRelay {
     keepAlive: number;
     protected receivedAuthRequiredForReq: BehaviorSubject<boolean>;
     protected receivedAuthRequiredForEvent: BehaviorSubject<boolean>;
-    protected authRequiredForReq: Observable<boolean>;
-    protected authRequiredForEvent: Observable<boolean>;
+    authRequiredForRead$: Observable<boolean>;
+    authRequiredForPublish$: Observable<boolean>;
     protected resetState(): void;
     /** An internal observable that is responsible for watching all messages and updating state, subscribing to it will trigger a connection to the relay */
     protected watchTower: Observable<never>;

package/dist/relay.js

@@ -4,6 +4,7 @@ import { nanoid } from "nanoid";
 import { nip42 } from "nostr-tools";
 import { BehaviorSubject, catchError, combineLatest, defer, endWith, filter, finalize, from, ignoreElements, isObservable, map, merge, mergeMap, mergeWith, NEVER, of, 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 */
@@ -23,8 +24,10 @@ export class Relay {
     connected$ = new BehaviorSubject(false);
     /** The authentication challenge string from the relay */
     challenge$ = new BehaviorSubject(null);
-    /** Whether the client is authenticated with the relay */
-    authenticated$ = new BehaviorSubject(false);
+    /** Boolean authentication state (will be false if auth failed) */
+    authenticated$;
+    /** The response to the last AUTH message sent to the relay */
+    authenticationResponse$ = new BehaviorSubject(null);
     /** The notices from the relay */
     notices$ = new BehaviorSubject([]);
     /** The last connection error */
@@ -55,7 +58,10 @@ export class Relay {
         return this.notices$.value;
     }
     get authenticated() {
-        return this.authenticated$.value;
+        return this.authenticationResponse?.ok === true;
+    }
+    get authenticationResponse() {
+        return this.authenticationResponse$.value;
     }
     get information() {
         return this._nip11;
@@ -66,18 +72,18 @@ export class Relay {
     eventTimeout = 10_000;
     /** How long to keep the connection alive after nothing is subscribed */
     keepAlive = 30_000;
-    // subjects that track if an "auth-required" message has been received for REQ or EVENT
+    // Subjects that track if an "auth-required" message has been received for REQ or EVENT
     receivedAuthRequiredForReq = new BehaviorSubject(false);
     receivedAuthRequiredForEvent = new BehaviorSubject(false);
     // Computed observables that track if auth is required for REQ or EVENT
-    authRequiredForReq;
-    authRequiredForEvent;
+    authRequiredForRead$;
+    authRequiredForPublish$;
     resetState() {
         // NOTE: only update the values if they need to be changed, otherwise this will cause an infinite loop
         if (this.challenge$.value !== null)
             this.challenge$.next(null);
-        if (this.authenticated$.value)
-            this.authenticated$.next(false);
+        if (this.authenticationResponse$.value)
+            this.authenticationResponse$.next(null);
         if (this.notices$.value.length > 0)
             this.notices$.next([]);
         if (this.receivedAuthRequiredForReq.value)
@@ -90,6 +96,8 @@ export class Relay {
     constructor(url, opts) {
         this.url = url;
         this.log = this.log.extend(url);
+        // Create an observable that tracks boolean authentication state
+        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);
         this.socket = webSocket({
@@ -129,8 +137,8 @@ export class Relay {
         tap((info) => (this._nip11 = info)));
         this.limitations$ = this.information$.pipe(map((info) => info?.limitation));
         // Create observables that track if auth is required for REQ or EVENT
-        this.authRequiredForReq = combineLatest([this.receivedAuthRequiredForReq, this.limitations$]).pipe(map(([received, limitations]) => received || limitations?.auth_required === true), tap((required) => required && this.log("Auth required for REQ")), shareReplay(1));
-        this.authRequiredForEvent = combineLatest([this.receivedAuthRequiredForEvent, this.limitations$]).pipe(map(([received, limitations]) => received || limitations?.auth_required === true), tap((required) => required && this.log("Auth required for EVENT")), shareReplay(1));
+        this.authRequiredForRead$ = this.receivedAuthRequiredForReq.pipe(tap((required) => required && this.log("Auth required for REQ")), shareReplay(1));
+        this.authRequiredForPublish$ = this.receivedAuthRequiredForEvent.pipe(tap((required) => required && this.log("Auth required for EVENT")), shareReplay(1));
         // Update the notices state
         const listenForNotice = this.socket.pipe(
         // listen for NOTICE messages
@@ -275,7 +283,7 @@ export class Relay {
         // Only create one upstream subscription
         share());
         // Wait for auth if required and make sure to start the watch tower
-        return this.waitForReady(this.waitForAuth(this.authRequiredForReq, observable));
+        return this.waitForReady(this.waitForAuth(this.authRequiredForRead$, observable));
     }
     /** Send an EVENT or AUTH message and return an observable of PublishResponse that completes or errors */
     event(event, verb = "EVENT") {
@@ -308,13 +316,13 @@ export class Relay {
         if (verb === "AUTH")
             return this.waitForReady(observable);
         else
-            return this.waitForReady(this.waitForAuth(this.authRequiredForEvent, observable));
+            return this.waitForReady(this.waitForAuth(this.authRequiredForPublish$, observable));
     }
     /** send and AUTH message */
     auth(event) {
         return this.event(event, "AUTH").pipe(
         // update authenticated
-        tap((result) => this.authenticated$.next(result.ok)));
+        tap((result) => this.authenticationResponse$.next(result)));
     }
     /** Authenticate with the relay using a signer */
     authenticate(signer) {
@@ -351,7 +359,7 @@ export class Relay {
     }
     /** Static method to fetch the NIP-11 information document for a relay */
     static fetchInformationDocument(url) {
-        return from(fetch(url, { headers: { Accept: "application/nostr+json" } }).then((res) => res.json())).pipe(
+        return from(fetch(ensureHttpURL(url), { headers: { Accept: "application/nostr+json" } }).then((res) => res.json())).pipe(
         // if the fetch fails, return null
         catchError(() => of(null)), 
         // timeout after 10s

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "applesauce-relay",
-  "version": "2.0.0",
+  "version": "2.3.0",
   "description": "nostr relay communication framework built on rxjs",
   "type": "module",
   "main": "dist/index.js",
@@ -54,7 +54,7 @@
   },
   "dependencies": {
     "@noble/hashes": "^1.7.1",
-    "applesauce-core": "^2.0.0",
+    "applesauce-core": "^2.3.0",
     "nanoid": "^5.0.9",
     "nostr-tools": "^2.13",
     "rxjs": "^7.8.1"