applesauce-relay 3.1.0 → 4.1.0

package/dist/types.d.ts

@@ -1,12 +1,20 @@
-import { type EventTemplate, type Filter, type NostrEvent } from "nostr-tools";
-import { Observable, repeat, retry } from "rxjs";
-import { WebSocketSubject } from "rxjs/webSocket";
+import type { EventTemplate, Filter, NostrEvent } from "nostr-tools";
+import type { RelayInformation } from "nostr-tools/nip11";
+import type { Observable, repeat, retry } from "rxjs";
+import type { WebSocketSubject } from "rxjs/webSocket";
+import type { NegentropySyncOptions, ReconcileFunction } from "./negentropy.js";
+import type { IAsyncEventStoreRead, IEventStoreRead } from "applesauce-core";
+import type { SyncDirection } from "./relay.js";
+import type { GroupNegentropySyncOptions, GroupRequestOptions, GroupSubscriptionOptions } from "./group.js";
 export type SubscriptionResponse = NostrEvent | "EOSE";
 export type PublishResponse = {
     ok: boolean;
     message?: string;
     from: string;
 };
+export type CountResponse = {
+    count: number;
+};
 export type MultiplexWebSocket<T = any> = Pick<WebSocketSubject<T>, "multiplex">;
 /** Options for the publish method on the pool and relay */
 export type PublishOptions = {
@@ -21,6 +29,8 @@ export type PublishOptions = {
      * @see https://rxjs.dev/api/index/function/retry
      */
     reconnect?: boolean | number | Parameters<typeof retry>[0];
+    /** Timeout for publish in milliseconds (default 30 seconds) */
+    timeout?: number | boolean;
 };
 /** Options for the request method on the pool and relay */
 export type RequestOptions = SubscriptionOptions;
@@ -58,6 +68,10 @@ export interface IRelay extends MultiplexWebSocket {
     challenge$: Observable<string | null>;
     authenticated$: Observable<boolean>;
     notices$: Observable<string[]>;
+    open$: Observable<Event>;
+    close$: Observable<CloseEvent>;
+    closing$: Observable<void>;
+    error$: Observable<Error | null>;
     readonly connected: boolean;
     readonly authenticated: boolean;
     readonly challenge: string | null;
@@ -66,10 +80,14 @@ export interface IRelay extends MultiplexWebSocket {
     close(): void;
     /** Send a REQ message */
     req(filters: FilterInput, id?: string): Observable<SubscriptionResponse>;
+    /** Send a COUNT message */
+    count(filters: Filter | Filter[], id?: string): Observable<CountResponse>;
     /** Send an EVENT message */
     event(event: NostrEvent): Observable<PublishResponse>;
     /** Send an AUTH message */
     auth(event: NostrEvent): Promise<PublishResponse>;
+    /** Negentropy sync event ids with the relay and an event store */
+    negentropy(store: IEventStoreRead | IAsyncEventStoreRead | NostrEvent[], filter: Filter, reconcile: ReconcileFunction, opts?: NegentropySyncOptions): Promise<boolean>;
     /** Authenticate with the relay using a signer */
     authenticate(signer: AuthSigner): Promise<PublishResponse>;
     /** Send an EVENT message with retries */
@@ -78,20 +96,39 @@ export interface IRelay extends MultiplexWebSocket {
     request(filters: FilterInput, opts?: RequestOptions): Observable<NostrEvent>;
     /** Open a subscription with retries */
     subscription(filters: FilterInput, opts?: SubscriptionOptions): Observable<SubscriptionResponse>;
+    /** Negentropy sync events with the relay and an event store */
+    sync(store: IEventStoreRead | IAsyncEventStoreRead | NostrEvent[], filter: Filter, direction?: SyncDirection): Observable<NostrEvent>;
+    /** Get the NIP-11 information document for the relay */
+    getInformation(): Promise<RelayInformation | null>;
+    /** Get the limitations for the relay */
+    getLimitations(): Promise<RelayInformation["limitation"] | null>;
+    /** Get the supported NIPs for the relay */
+    getSupported(): Promise<number[] | null>;
 }
 export interface IGroup {
     /** Send a REQ message */
     req(filters: FilterInput, id?: string): Observable<SubscriptionResponse>;
     /** Send an EVENT message */
     event(event: NostrEvent): Observable<PublishResponse>;
+    /** Negentropy sync event ids with the relays and an event store */
+    negentropy(store: IEventStoreRead | IAsyncEventStoreRead | NostrEvent[], filter: Filter, reconcile: ReconcileFunction, opts?: NegentropySyncOptions): Promise<boolean>;
     /** Send an EVENT message with retries */
     publish(event: NostrEvent, opts?: PublishOptions): Promise<PublishResponse[]>;
     /** Send a REQ message with retries */
-    request(filters: FilterInput, opts?: RequestOptions): Observable<NostrEvent>;
+    request(filters: FilterInput, opts?: GroupRequestOptions): Observable<NostrEvent>;
     /** Open a subscription with retries */
-    subscription(filters: FilterInput, opts?: SubscriptionOptions): Observable<SubscriptionResponse>;
+    subscription(filters: FilterInput, opts?: GroupSubscriptionOptions): Observable<SubscriptionResponse>;
+    /** Count events on the relays and an event store */
+    count(filters: Filter | Filter[], id?: string): Observable<Record<string, CountResponse>>;
+    /** Negentropy sync events with the relay and an event store */
+    sync(store: IEventStoreRead | IAsyncEventStoreRead | NostrEvent[], filter: Filter, direction?: SyncDirection): Observable<NostrEvent>;
+}
+/** Signals emitted by the pool */
+export interface IPoolSignals {
+    add$: Observable<IRelay>;
+    remove$: Observable<IRelay>;
 }
-export interface IPool {
+export interface IPool extends IPoolSignals {
     /** Get or create a relay */
     relay(url: string): IRelay;
     /** Create a relay group */
@@ -102,10 +139,16 @@ export interface IPool {
     req(relays: string[], filters: FilterInput, id?: string): Observable<SubscriptionResponse>;
     /** Send an EVENT message */
     event(relays: string[], event: NostrEvent): Observable<PublishResponse>;
+    /** Negentropy sync event ids with the relays and an event store */
+    negentropy(relays: string[], store: IEventStoreRead | IAsyncEventStoreRead | NostrEvent[], filter: Filter, reconcile: ReconcileFunction, opts?: GroupNegentropySyncOptions): Promise<boolean>;
     /** Send an EVENT message to relays with retries */
-    publish(relays: string[], event: NostrEvent, opts?: PublishOptions): Promise<PublishResponse[]>;
+    publish(relays: string[], event: Parameters<IGroup["publish"]>[0], opts?: Parameters<IGroup["publish"]>[1]): Promise<PublishResponse[]>;
     /** Send a REQ message to relays with retries */
-    request(relays: string[], filters: FilterInput, opts?: RequestOptions): Observable<NostrEvent>;
+    request(relays: string[], filters: Parameters<IGroup["request"]>[0], opts?: Parameters<IGroup["request"]>[1]): Observable<NostrEvent>;
     /** Open a subscription to relays with retries */
-    subscription(relays: string[], filters: FilterInput, opts?: SubscriptionOptions): Observable<SubscriptionResponse>;
+    subscription(relays: string[], filters: Parameters<IGroup["subscription"]>[0], opts?: Parameters<IGroup["subscription"]>[1]): Observable<SubscriptionResponse>;
+    /** Count events on the relays and an event store */
+    count(relays: string[], filters: Filter | Filter[], id?: string): Observable<Record<string, CountResponse>>;
+    /** Negentropy sync events with the relay and an event store */
+    sync(relays: string[], store: IEventStoreRead | IAsyncEventStoreRead | NostrEvent[], filter: Filter, direction?: SyncDirection): Observable<NostrEvent>;
 }

package/package.json

@@ -1,19 +1,17 @@
 {
   "name": "applesauce-relay",
-  "version": "3.1.0",
+  "version": "4.1.0",
   "description": "nostr relay communication framework built on rxjs",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "keywords": [
-    "nostr",
-    "applesauce"
+    "nostr"
   ],
   "author": "hzrd149",
   "license": "MIT",
   "files": [
-    "dist",
-    "applesauce"
+    "dist"
   ],
   "exports": {
     ".": {
@@ -54,17 +52,17 @@
   },
   "dependencies": {
     "@noble/hashes": "^1.7.1",
-    "applesauce-core": "^3.1.0",
+    "applesauce-core": "^4.1.0",
     "nanoid": "^5.0.9",
-    "nostr-tools": "~2.15",
+    "nostr-tools": "~2.17",
     "rxjs": "^7.8.1"
   },
   "devDependencies": {
     "@hirez_io/observer-spy": "^2.2.0",
-    "applesauce-signers": "^3.1.0",
-    "@vitest/expect": "^3.1.1",
+    "applesauce-signers": "^4.1.0",
+    "rimraf": "^6.0.1",
     "typescript": "^5.7.3",
-    "vitest": "^3.2.3",
+    "vitest": "^3.2.4",
     "vitest-websocket-mock": "^0.5.0"
   },
   "funding": {
@@ -72,6 +70,7 @@
     "url": "lightning:nostrudel@geyser.fund"
   },
   "scripts": {
+    "prebuild": "rimraf dist",
     "build": "tsc",
     "watch:build": "tsc --watch > /dev/null",
     "test": "vitest run --passWithNoTests",