applesauce-core 3.1.0 → 4.0.0

package/dist/models/legacy-messages.d.ts

@@ -7,8 +7,8 @@ export declare function LegacyMessagesGroups(self: string): Model<{
     lastMessage: NostrEvent;
 }[]>;
 /** Returns all legacy direct messages in a group */
-export declare function LegacyMessagesGroup(self: string, corraspondant: string): Model<NostrEvent[]>;
+export declare function LegacyMessagesGroup(self: string, correspondent: string): Model<NostrEvent[]>;
 /** Returns an array of legacy messages that have replies */
-export declare function LegacyMessageThreads(self: string, corraspondant: string): Model<NostrEvent[]>;
+export declare function LegacyMessageThreads(self: string, correspondent: string): Model<NostrEvent[]>;
 /** Returns all the legacy direct messages that are replies to a given message */
 export declare function LegacyMessageReplies(self: string, message: NostrEvent): Model<NostrEvent[]>;

package/dist/models/legacy-messages.js

@@ -1,7 +1,8 @@
 import { kinds } from "nostr-tools";
-import { getLegacyMessageCorraspondant, getLegacyMessageParent } from "../helpers/legacy-messages.js";
+import { getLegacyMessageCorrespondent, getLegacyMessageParent } from "../helpers/legacy-messages.js";
 import { map } from "rxjs";
 import { getConversationIdentifierFromMessage, getConversationParticipants } from "../helpers/messages.js";
+import { hasNameValueTag } from "../helpers/event-tags.js";
 /** A model that returns all legacy message groups (1-1) that a pubkey is participating in */
 export function LegacyMessagesGroups(self) {
     return (store) => store.timeline({ kinds: [kinds.EncryptedDirectMessage], "#p": [self] }).pipe(map((messages) => {
@@ -19,41 +20,43 @@ export function LegacyMessagesGroups(self) {
     }));
 }
 /** Returns all legacy direct messages in a group */
-export function LegacyMessagesGroup(self, corraspondant) {
+export function LegacyMessagesGroup(self, correspondent) {
     return (store) => store.timeline([
         {
             kinds: [kinds.EncryptedDirectMessage],
             "#p": [self],
-            authors: [corraspondant],
+            authors: [correspondent],
         },
         {
             kinds: [kinds.EncryptedDirectMessage],
-            "#p": [corraspondant],
+            "#p": [correspondent],
             authors: [self],
         },
     ]);
 }
 /** Returns an array of legacy messages that have replies */
-export function LegacyMessageThreads(self, corraspondant) {
-    return (store) => store.model(LegacyMessagesGroup, self, corraspondant).pipe(map((messages) => messages.filter((message) => 
+export function LegacyMessageThreads(self, correspondent) {
+    return (store) => store.model(LegacyMessagesGroup, self, correspondent).pipe(map((messages) => messages.filter((message) => 
     // Only select messages that are not replies
     !getLegacyMessageParent(message) &&
         // Check if message has any replies
-        store.getByFilters({ "#e": [message.id], kinds: [kinds.EncryptedDirectMessage] }).size > 0)));
+        messages.some((m) => hasNameValueTag(m, "e", message.id)))));
 }
 /** Returns all the legacy direct messages that are replies to a given message */
 export function LegacyMessageReplies(self, message) {
-    const corraspondant = getLegacyMessageCorraspondant(message, self);
+    const correspondent = getLegacyMessageCorrespondent(message, self);
+    if (!correspondent)
+        throw new Error("Legacy message has no correspondent");
     return (store) => store.timeline([
         {
             kinds: [kinds.EncryptedDirectMessage],
             "#p": [self],
-            authors: [corraspondant],
+            authors: [correspondent],
             "#e": [message.id],
         },
         {
             kinds: [kinds.EncryptedDirectMessage],
-            "#p": [corraspondant],
+            "#p": [correspondent],
             authors: [self],
             "#e": [message.id],
         },

package/dist/models/outbox.d.ts

@@ -0,0 +1,13 @@
+import { ProfilePointer } from "nostr-tools/nip19";
+import { Model } from "../event-store/interface.js";
+import { SelectOptimalRelaysOptions } from "../helpers/relay-selection.js";
+import { ignoreBlacklistedRelays } from "../observable/relay-selection.js";
+export type OutboxModelOptions = SelectOptimalRelaysOptions & {
+    type?: "inbox" | "outbox";
+    blacklist?: Parameters<typeof ignoreBlacklistedRelays>[0];
+};
+/** A model that returns the users contacts with the relays to connect to */
+export declare function OutboxModel(user: string | ProfilePointer, opts: OutboxModelOptions): Model<ProfilePointer[]>;
+export declare namespace OutboxModel {
+    var getKey: (user: string | ProfilePointer, opts: OutboxModelOptions) => string;
+}

package/dist/models/outbox.js

@@ -0,0 +1,18 @@
+import hash_sum from "hash-sum";
+import { identity, map } from "rxjs";
+import { selectOptimalRelays } from "../helpers/relay-selection.js";
+import { ignoreBlacklistedRelays, includeMailboxes } from "../observable/relay-selection.js";
+/** A model that returns the users contacts with the relays to connect to */
+export function OutboxModel(user, opts) {
+    return (store) => store.contacts(user).pipe(
+    /** Ignore blacklisted relays */
+    opts?.blacklist ? ignoreBlacklistedRelays(opts.blacklist) : identity, 
+    /** Include mailboxes */
+    includeMailboxes(store, opts.type), 
+    /** Select the optimal relays */
+    map((users) => selectOptimalRelays(users, opts)));
+}
+OutboxModel.getKey = (user, opts) => {
+    const p = typeof user === "string" ? user : user.pubkey;
+    return hash_sum([p, opts.type, opts.maxConnections, opts.maxRelaysPerUser]);
+};

package/dist/models/profile.d.ts

@@ -1,5 +1,5 @@
+import { ProfilePointer } from "nostr-tools/nip19";
 import { Model } from "../event-store/interface.js";
 import { ProfileContent } from "../helpers/profile.js";
-import { ProfilePointer } from "nostr-tools/nip19";
 /** A model that gets and parses the kind 0 metadata for a pubkey */
 export declare function ProfileModel(user: string | ProfilePointer): Model<ProfileContent | undefined>;

package/dist/models/zaps.d.ts

@@ -1,9 +1,10 @@
-import { NostrEvent } from "nostr-tools";
+import { kinds } from "nostr-tools";
 import { AddressPointer, EventPointer } from "nostr-tools/nip19";
 import { Model } from "../event-store/interface.js";
+import { KnownEvent } from "../helpers/index.js";
 /** A model that gets all zap events for an event */
-export declare function EventZapsModel(id: string | EventPointer | AddressPointer): Model<NostrEvent[]>;
+export declare function EventZapsModel(id: string | EventPointer | AddressPointer): Model<KnownEvent<kinds.Zap>[]>;
 /** A model that returns all zaps sent by a user */
-export declare function SentZapsModel(pubkey: string): Model<NostrEvent[]>;
+export declare function SentZapsModel(pubkey: string): Model<KnownEvent<kinds.Zap>[]>;
 /** A model that returns all zaps received by a user */
-export declare function ReceivedZapsModel(pubkey: string): Model<NostrEvent[]>;
+export declare function ReceivedZapsModel(pubkey: string): Model<KnownEvent<kinds.Zap>[]>;

package/dist/models/zaps.js

@@ -18,9 +18,9 @@ export function EventZapsModel(id) {
 }
 /** A model that returns all zaps sent by a user */
 export function SentZapsModel(pubkey) {
-    return (events) => events.timeline([{ kinds: [kinds.Zap], authors: [pubkey] }]);
+    return (events) => events.timeline([{ kinds: [kinds.Zap], authors: [pubkey] }]).pipe(map((events) => events.filter(isValidZap)));
 }
 /** A model that returns all zaps received by a user */
 export function ReceivedZapsModel(pubkey) {
-    return (events) => events.timeline([{ kinds: [kinds.Zap], "#a": [pubkey] }]);
+    return (events) => events.timeline([{ kinds: [kinds.Zap], "#p": [pubkey] }]).pipe(map((events) => events.filter(isValidZap)));
 }

package/dist/observable/index.d.ts

@@ -1,9 +1,10 @@
-import { firstValueFrom, lastValueFrom } from "rxjs";
+export { firstValueFrom, lastValueFrom, combineLatest, merge } from "rxjs";
+export { Observable, Subject, BehaviorSubject, ReplaySubject } from "rxjs";
 export * from "./defined.js";
 export * from "./get-observable-value.js";
-export * from "./map-events-timeline.js";
+export * from "./map-events-to-timeline.js";
 export * from "./map-events-to-store.js";
 export * from "./simple-timeout.js";
 export * from "./watch-event-updates.js";
 export * from "./with-immediate-value.js";
-export { firstValueFrom, lastValueFrom };
+export * from "./relay-selection.js";

package/dist/observable/index.js

@@ -1,10 +1,11 @@
-import { firstValueFrom, lastValueFrom } from "rxjs";
+// Re-export some useful rxjs functions
+export { firstValueFrom, lastValueFrom, combineLatest, merge } from "rxjs";
+export { Observable, Subject, BehaviorSubject, ReplaySubject } from "rxjs";
 export * from "./defined.js";
 export * from "./get-observable-value.js";
-export * from "./map-events-timeline.js";
+export * from "./map-events-to-timeline.js";
 export * from "./map-events-to-store.js";
 export * from "./simple-timeout.js";
 export * from "./watch-event-updates.js";
 export * from "./with-immediate-value.js";
-// Re-export some useful rxjs functions
-export { firstValueFrom, lastValueFrom };
+export * from "./relay-selection.js";

package/dist/observable/map-events-to-store.d.ts

@@ -1,5 +1,7 @@
-import { MonoTypeOperatorFunction } from "rxjs";
 import { NostrEvent } from "nostr-tools";
-import { IEventStore } from "../event-store/interface.js";
+import { MonoTypeOperatorFunction } from "rxjs";
+import { IAsyncEventStoreActions, IEventStoreActions } from "../event-store/interface.js";
 /** Saves all events to an event store and filters out invalid events */
-export declare function mapEventsToStore(store: IEventStore, removeDuplicates?: boolean): MonoTypeOperatorFunction<NostrEvent>;
+export declare function mapEventsToStore(store: IEventStoreActions | IAsyncEventStoreActions, removeDuplicates?: boolean): MonoTypeOperatorFunction<NostrEvent>;
+/** Alias for {@link mapEventsToStore} */
+export declare const filterDuplicateEvents: (store: IEventStoreActions | IAsyncEventStoreActions) => MonoTypeOperatorFunction<import("nostr-tools").Event>;

package/dist/observable/map-events-to-store.js

@@ -1,12 +1,23 @@
-import { distinct, filter, identity, map } from "rxjs";
+import { catchError, distinct, filter, from, identity, mergeMap, of } from "rxjs";
 /** Saves all events to an event store and filters out invalid events */
 export function mapEventsToStore(store, removeDuplicates = true) {
     return (source) => source.pipe(
     // Map all events to the store
-    // NOTE: map is used here because we want to return the single cononical version of the event so that distinct() can be used later
-    map((event) => store.add(event)), 
+    // NOTE: mergeMap is used here because we want to return the single instance of the event so that distinct() can be used later
+    mergeMap((event) => {
+        const r = store.add(event);
+        // Unwrap the promise from the async store
+        if (r instanceof Promise)
+            return from(r);
+        else
+            return of(r);
+    }), 
+    // Ignore errors when inserting events into the store
+    catchError(() => of(null)), 
     // Ignore invalid events
     filter((e) => e !== null), 
     // Remove duplicates if requested
     removeDuplicates ? distinct() : identity);
 }
+/** Alias for {@link mapEventsToStore} */
+export const filterDuplicateEvents = (store) => mapEventsToStore(store, true);

package/dist/observable/map-events-to-timeline.js

@@ -0,0 +1,12 @@
+import { insertEventIntoDescendingList } from "nostr-tools/utils";
+import { pipe, scan } from "rxjs";
+import { withImmediateValueOrDefault } from "./with-immediate-value.js";
+/**
+ * Accumulate events into an ordered timeline
+ * @note This does not remove duplicate events
+ */
+export function mapEventsToTimeline() {
+    return pipe(scan((timeline, event) => insertEventIntoDescendingList(timeline, event), []), 
+    // Emit an empty array first. This is to prevent empty observables completing without a value (EMPTY)
+    withImmediateValueOrDefault([]));
+}

package/dist/observable/relay-selection.d.ts

@@ -0,0 +1,7 @@
+import { ProfilePointer } from "nostr-tools/nip19";
+import { type MonoTypeOperatorFunction, type Observable, type OperatorFunction } from "rxjs";
+import { IEventSubscriptions } from "../event-store/interface.js";
+/** RxJS operator that fetches outboxes for profile pointers from the event store */
+export declare function includeMailboxes(store: IEventSubscriptions, type?: "inbox" | "outbox"): OperatorFunction<ProfilePointer[], ProfilePointer[]>;
+/** Removes blacklisted relays from the user's relays */
+export declare function ignoreBlacklistedRelays(blacklist: string[] | Observable<string[]>): MonoTypeOperatorFunction<ProfilePointer[]>;

package/dist/observable/relay-selection.js

@@ -0,0 +1,38 @@
+import { combineLatest, combineLatestWith, isObservable, map, of, pipe, switchMap, } from "rxjs";
+import { getInboxes, getOutboxes } from "../helpers/mailboxes.js";
+import { addRelayHintsToPointer } from "../helpers/pointers.js";
+/** RxJS operator that fetches outboxes for profile pointers from the event store */
+export function includeMailboxes(store, type = "outbox") {
+    // Get the outboxes for all contacts
+    return switchMap((contacts) => combineLatest(contacts.map((user) => 
+    // Subscribe to the outboxes for the user
+    store
+        .replaceable({
+        kind: 10002,
+        pubkey: user.pubkey,
+    })
+        .pipe(
+    // Add the relays to the user
+    map((event) => {
+        if (!event)
+            return user;
+        // Get the relays from the event
+        const relays = type === "outbox" ? getOutboxes(event) : getInboxes(event);
+        if (!relays)
+            return user;
+        // Add the relays to the user
+        return addRelayHintsToPointer(user, relays);
+    })))));
+}
+/** Removes blacklisted relays from the user's relays */
+export function ignoreBlacklistedRelays(blacklist) {
+    return pipe(
+    // Combine with the observable so it re-emits when the blacklist changes
+    combineLatestWith(isObservable(blacklist) ? blacklist : of(blacklist)), 
+    // Filter the relays for the user
+    map(([users, blacklist]) => users.map((user) => {
+        if (!user.relays)
+            return user;
+        return { ...user, relays: user.relays.filter((relay) => !blacklist.includes(relay)) };
+    })));
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "applesauce-core",
-  "version": "3.1.0",
+  "version": "4.0.0",
   "description": "",
   "type": "module",
   "main": "dist/index.js",
@@ -64,21 +64,23 @@
     "hash-sum": "^2.0.0",
     "light-bolt11-decoder": "^3.2.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",
     "@types/debug": "^4.1.12",
     "@types/hash-sum": "^1.0.2",
+    "rimraf": "^6.0.1",
     "typescript": "^5.8.3",
-    "vitest": "^3.2.3"
+    "vitest": "^3.2.4"
   },
   "funding": {
     "type": "lightning",
     "url": "lightning:nostrudel@geyser.fund"
   },
   "scripts": {
+    "prebuild": "rimraf dist",
     "build": "tsc",
     "watch:build": "tsc --watch > /dev/null",
     "test": "vitest run --passWithNoTests",

package/dist/observable/map-events-timeline.js

@@ -1,9 +0,0 @@
-import { insertEventIntoDescendingList } from "nostr-tools/utils";
-import { scan } from "rxjs";
-/**
- * Accumulate events into an ordered timeline
- * @note This does not remove duplicate events
- */
-export function mapEventsToTimeline() {
-    return scan((timeline, event) => insertEventIntoDescendingList(timeline, event), []);
-}