applesauce-core 0.10.0 → 0.12.0

package/dist/__tests__/fixtures.d.ts

@@ -0,0 +1,8 @@
+import type { NostrEvent } from "nostr-tools";
+export declare class FakeUser {
+    key: Uint8Array<ArrayBufferLike>;
+    pubkey: string;
+    event(data?: Partial<NostrEvent>): NostrEvent;
+    note(content?: string, extra?: Partial<NostrEvent>): import("nostr-tools").Event;
+    profile(profile: any, extra?: Partial<NostrEvent>): import("nostr-tools").Event;
+}

package/dist/__tests__/fixtures.js

@@ -0,0 +1,20 @@
+import { finalizeEvent, generateSecretKey, getPublicKey, kinds } from "nostr-tools";
+import { unixNow } from "../helpers/time.js";
+export class FakeUser {
+    key = generateSecretKey();
+    pubkey = getPublicKey(this.key);
+    event(data) {
+        return finalizeEvent({
+            kind: data?.kind ?? kinds.ShortTextNote,
+            content: data?.content || "",
+            created_at: data?.created_at ?? unixNow(),
+            tags: data?.tags || [],
+        }, this.key);
+    }
+    note(content = "Hello World", extra) {
+        return this.event({ kind: kinds.ShortTextNote, content, ...extra });
+    }
+    profile(profile, extra) {
+        return this.event({ kind: kinds.Metadata, content: JSON.stringify({ ...profile }), ...extra });
+    }
+}

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

@@ -0,0 +1,272 @@
+import { beforeEach, describe, expect, it, vi } from "vitest";
+import { kinds } from "nostr-tools";
+import { subscribeSpyTo } from "@hirez_io/observer-spy";
+import { EventStore } from "../event-store.js";
+import { addSeenRelay, getSeenRelays } from "../../helpers/relays.js";
+import { getEventUID } from "../../helpers/event.js";
+import { FakeUser } from "../../__tests__/fixtures.js";
+let eventStore;
+beforeEach(() => {
+    eventStore = new EventStore();
+});
+const user = new FakeUser();
+const profile = user.profile({ name: "fake user" });
+const note = user.note();
+describe("add", () => {
+    it("should return original event in case of duplicates", () => {
+        const a = { ...profile };
+        expect(eventStore.add(a)).toBe(a);
+        const b = { ...profile };
+        expect(eventStore.add(b)).toBe(a);
+        const c = { ...profile };
+        expect(eventStore.add(c)).toBe(a);
+    });
+    it("should merge seen relays on duplicate events", () => {
+        const a = { ...profile };
+        addSeenRelay(a, "wss://relay.a.com");
+        eventStore.add(a);
+        const b = { ...profile };
+        addSeenRelay(b, "wss://relay.b.com");
+        eventStore.add(b);
+        expect(eventStore.getEvent(profile.id)).toBeDefined();
+        expect([...getSeenRelays(eventStore.getEvent(profile.id))]).toEqual(expect.arrayContaining(["wss://relay.a.com", "wss://relay.b.com"]));
+    });
+    it("should ignore deleted events", () => {
+        const deleteEvent = {
+            id: "delete event id",
+            kind: kinds.EventDeletion,
+            created_at: profile.created_at + 100,
+            pubkey: user.pubkey,
+            tags: [["e", profile.id]],
+            sig: "this should be ignored for the test",
+            content: "test",
+        };
+        // add delete event first
+        eventStore.add(deleteEvent);
+        // now event should be ignored
+        eventStore.add(profile);
+        expect(eventStore.getEvent(profile.id)).toBeUndefined();
+    });
+});
+describe("verifyEvent", () => {
+    it("should be called for all events added", () => {
+        const verifyEvent = vi.fn().mockReturnValue(true);
+        eventStore.verifyEvent = verifyEvent;
+        eventStore.add(profile);
+        expect(verifyEvent).toHaveBeenCalledWith(profile);
+    });
+    it("should not be called for duplicate events", () => {
+        const verifyEvent = vi.fn().mockReturnValue(true);
+        eventStore.verifyEvent = verifyEvent;
+        const a = { ...profile };
+        eventStore.add(a);
+        expect(verifyEvent).toHaveBeenCalledWith(a);
+        const b = { ...profile };
+        eventStore.add(b);
+        expect(verifyEvent).toHaveBeenCalledTimes(1);
+        const c = { ...profile };
+        eventStore.add(c);
+        expect(verifyEvent).toHaveBeenCalledTimes(1);
+    });
+});
+describe("removed", () => {
+    it("should complete when event is removed", () => {
+        eventStore.add(profile);
+        const spy = subscribeSpyTo(eventStore.removed(profile.id));
+        eventStore.remove(profile);
+        expect(spy.getValues()).toEqual([]);
+        expect(spy.receivedComplete()).toBe(true);
+    });
+});
+describe("event", () => {
+    it("should emit existing event", () => {
+        eventStore.add(profile);
+        const spy = subscribeSpyTo(eventStore.event(profile.id));
+        expect(spy.getValues()).toEqual([profile]);
+    });
+    it("should emit then event when its added", () => {
+        const spy = subscribeSpyTo(eventStore.event(profile.id));
+        expect(spy.getValues()).toEqual([]);
+        eventStore.add(profile);
+        expect(spy.getValues()).toEqual([profile]);
+    });
+    it("should emit undefined when event is removed", () => {
+        eventStore.add(profile);
+        const spy = subscribeSpyTo(eventStore.event(profile.id));
+        expect(spy.getValues()).toEqual([profile]);
+        eventStore.remove(profile);
+        expect(spy.getValues()).toEqual([profile, undefined]);
+    });
+    it("should emit new value if event is re-added", () => {
+        eventStore.add(profile);
+        const spy = subscribeSpyTo(eventStore.event(profile.id));
+        eventStore.remove(profile);
+        eventStore.add(profile);
+        expect(spy.getValues()).toEqual([profile, undefined, profile]);
+    });
+    it("should not complete when event is removed", () => {
+        eventStore.add(profile);
+        const spy = subscribeSpyTo(eventStore.event(profile.id));
+        eventStore.remove(profile);
+        expect(spy.receivedComplete()).toBe(false);
+    });
+    it("should not emit any values if there are no events", () => {
+        const spy = subscribeSpyTo(eventStore.event(profile.id));
+        expect(spy.receivedNext()).toBe(false);
+    });
+});
+describe("events", () => {
+    it("should emit existing events", () => {
+        eventStore.add(profile);
+        const spy = subscribeSpyTo(eventStore.events([profile.id]));
+        expect(spy.getValues()).toEqual([{ [profile.id]: profile }]);
+    });
+    it("should remove events when they are removed", () => {
+        eventStore.add(profile);
+        const spy = subscribeSpyTo(eventStore.events([profile.id]));
+        expect(spy.getValues()).toEqual([{ [profile.id]: profile }]);
+        eventStore.remove(profile);
+        expect(spy.getValues()).toEqual([{ [profile.id]: profile }, {}]);
+    });
+    it("should add events back if then are re-added", () => {
+        eventStore.add(profile);
+        const spy = subscribeSpyTo(eventStore.events([profile.id]));
+        eventStore.remove(profile);
+        eventStore.add(profile);
+        expect(spy.getValues()).toEqual([{ [profile.id]: profile }, {}, { [profile.id]: profile }]);
+    });
+    it("should not emit any values if there are no events", () => {
+        const spy = subscribeSpyTo(eventStore.events([profile.id]));
+        expect(spy.receivedNext()).toBe(false);
+    });
+});
+describe("replaceable", () => {
+    it("should not emit till there is an event", () => {
+        const spy = subscribeSpyTo(eventStore.replaceable(0, user.pubkey));
+        expect(spy.receivedNext()).toBe(false);
+    });
+    it("should emit existing events", () => {
+        eventStore.add(profile);
+        const spy = subscribeSpyTo(eventStore.replaceable(0, user.pubkey));
+        expect(spy.getValues()).toEqual([profile]);
+    });
+    it("should emit undefined when event is removed", () => {
+        eventStore.add(profile);
+        const spy = subscribeSpyTo(eventStore.replaceable(0, user.pubkey));
+        eventStore.remove(profile);
+        expect(spy.getValues()).toEqual([profile, undefined]);
+    });
+    it("should not complete when event is removed", () => {
+        eventStore.add(profile);
+        const spy = subscribeSpyTo(eventStore.replaceable(0, user.pubkey));
+        eventStore.remove(profile);
+        expect(spy.receivedComplete()).toBe(false);
+    });
+    it("should emit event when re-added", () => {
+        eventStore.add(profile);
+        const spy = subscribeSpyTo(eventStore.replaceable(0, user.pubkey));
+        eventStore.remove(profile);
+        eventStore.add(profile);
+        expect(spy.getValues()).toEqual([profile, undefined, profile]);
+    });
+    it("should claim event", () => {
+        eventStore.add(profile);
+        eventStore.replaceable(0, user.pubkey).subscribe();
+        expect(eventStore.database.isClaimed(profile)).toBe(true);
+    });
+    it("should remove claim when event is removed", () => {
+        eventStore.add(profile);
+        eventStore.replaceable(0, user.pubkey).subscribe();
+        eventStore.remove(profile);
+        expect(eventStore.database.isClaimed(profile)).toBe(false);
+    });
+    it("should ignore older events added later", () => {
+        eventStore.add(profile);
+        const spy = subscribeSpyTo(eventStore.replaceable(0, user.pubkey));
+        eventStore.add(user.profile({ name: "old name" }, { created_at: profile.created_at - 500 }));
+        eventStore.add(user.profile({ name: "really old name" }, { created_at: profile.created_at - 1000 }));
+        expect(spy.getValues()).toEqual([profile]);
+    });
+});
+describe("timeline", () => {
+    it("should emit an empty array if there are not events", () => {
+        const spy = subscribeSpyTo(eventStore.timeline({ kinds: [1] }));
+        expect(spy.getValues()).toEqual([[]]);
+    });
+    it("should emit existing events", () => {
+        eventStore.add(profile);
+        const spy = subscribeSpyTo(eventStore.timeline({ kinds: [0] }));
+        expect(spy.getValues()).toEqual([[profile]]);
+    });
+    it("should emit new events", () => {
+        const spy = subscribeSpyTo(eventStore.timeline({ kinds: [0, 1] }));
+        eventStore.add(profile);
+        eventStore.add(note);
+        expect(spy.getValues()).toEqual([[], [profile], [note, profile]]);
+    });
+    it("should remove event when its removed", () => {
+        eventStore.add(profile);
+        const spy = subscribeSpyTo(eventStore.timeline({ kinds: [0] }));
+        eventStore.remove(profile);
+        expect(spy.getValues()).toEqual([[profile], []]);
+    });
+    it("should not emit when other events are removed", () => {
+        eventStore.add(profile);
+        const spy = subscribeSpyTo(eventStore.timeline({ kinds: [0] }));
+        eventStore.add(note);
+        eventStore.remove(note);
+        expect(spy.getValues()).toEqual([[profile]]);
+    });
+    it("should ignore older events added later", () => {
+        eventStore.add(profile);
+        const spy = subscribeSpyTo(eventStore.timeline({ kinds: [0] }));
+        eventStore.add(user.profile({ name: "old-name" }, { created_at: profile.created_at - 1000 }));
+        expect(spy.getValues()).toEqual([[profile]]);
+    });
+    it("should return new array for every value", () => {
+        const first = user.note("first note");
+        const second = user.note("second note");
+        const third = user.note("third note");
+        eventStore.add(first);
+        const spy = subscribeSpyTo(eventStore.timeline({ kinds: [0] }));
+        eventStore.add(second);
+        eventStore.add(third);
+        const hasDuplicates = (arr) => {
+            return new Set(arr).size !== arr.length;
+        };
+        expect(hasDuplicates(spy.getValues())).toBe(false);
+    });
+});
+describe("replaceableSet", () => {
+    it("should not emit if there are not events", () => {
+        const spy = subscribeSpyTo(eventStore.replaceableSet([{ kind: 0, pubkey: user.pubkey }]));
+        expect(spy.receivedNext()).toBe(false);
+    });
+    it("should emit existing events", () => {
+        eventStore.add(profile);
+        const spy = subscribeSpyTo(eventStore.replaceableSet([{ kind: 0, pubkey: user.pubkey }]));
+        expect(spy.getValues()).toEqual([{ [getEventUID(profile)]: profile }]);
+    });
+    it("should remove event when removed", () => {
+        eventStore.add(profile);
+        const spy = subscribeSpyTo(eventStore.replaceableSet([{ kind: 0, pubkey: user.pubkey }]));
+        eventStore.remove(profile);
+        expect(spy.getValues()).toEqual([{ [getEventUID(profile)]: profile }, {}]);
+    });
+    it("should replace older events", () => {
+        const event2 = { ...profile, created_at: profile.created_at + 100, id: "newer-event" };
+        const uid = getEventUID(profile);
+        eventStore.add(profile);
+        const spy = subscribeSpyTo(eventStore.replaceableSet([{ kind: 0, pubkey: user.pubkey }]));
+        eventStore.add(event2);
+        expect(spy.getValues()).toEqual([{ [uid]: profile }, { [uid]: event2 }]);
+    });
+    it("should ignore old events added later", () => {
+        const old = user.profile({ name: "old-name" }, { created_at: profile.created_at - 1000 });
+        const uid = getEventUID(profile);
+        eventStore.add(profile);
+        const spy = subscribeSpyTo(eventStore.replaceableSet([{ kind: 0, pubkey: user.pubkey }]));
+        eventStore.add(old);
+        expect(spy.getValues()).toEqual([{ [uid]: profile }]);
+    });
+});

package/dist/event-store/database.d.ts

@@ -19,8 +19,10 @@ export declare class Database {
     inserted: Subject<import("nostr-tools").Event>;
     /** A stream of events that have been updated */
     updated: Subject<import("nostr-tools").Event>;
-    /** A stream of events removed of the database */
-    deleted: Subject<import("nostr-tools").Event>;
+    /** A stream of events removed from the database */
+    removed: Subject<import("nostr-tools").Event>;
+    /** A method thats called before a new event is inserted */
+    onBeforeInsert?: (event: NostrEvent) => void;
     get size(): number;
     protected claims: WeakMap<import("nostr-tools").Event, any>;
     /** Index helper methods */
@@ -41,8 +43,8 @@ export declare class Database {
     addEvent(event: NostrEvent): NostrEvent;
     /** Inserts and event into the database and notifies all subscriptions that the event has updated */
     updateEvent(event: NostrEvent): NostrEvent;
-    /** Deletes an event from the database and notifies all subscriptions */
-    deleteEvent(eventOrId: string | NostrEvent): boolean;
+    /** Removes an event from the database and notifies all subscriptions */
+    removeEvent(eventOrId: string | NostrEvent): boolean;
     /** Sets the claim on the event and touches it */
     claimEvent(event: NostrEvent, claim: any): void;
     /** Checks if an event is claimed by anything */
@@ -58,7 +60,7 @@ export declare class Database {
     iterateIds(ids: Iterable<string>): Generator<NostrEvent>;
     /** Returns all events that match the filter */
     getEventsForFilter(filter: Filter): Set<NostrEvent>;
-    getForFilters(filters: Filter[]): Set<NostrEvent>;
+    getEventsForFilters(filters: Filter[]): Set<NostrEvent>;
     /** Remove the oldest events that are not claimed */
     prune(limit?: number): number;
 }

package/dist/event-store/database.js

@@ -22,8 +22,10 @@ export class Database {
     inserted = new Subject();
     /** A stream of events that have been updated */
     updated = new Subject();
-    /** A stream of events removed of the database */
-    deleted = new Subject();
+    /** A stream of events removed from the database */
+    removed = new Subject();
+    /** A method thats called before a new event is inserted */
+    onBeforeInsert;
     get size() {
         return this.events.size;
     }
@@ -82,11 +84,12 @@ export class Database {
         const id = event.id;
         const current = this.events.get(id);
         if (current) {
-            // if this is a duplicate event, transfer some import symbols
+            // if this is a duplicate event, transfer some important symbols
             if (event[FromCacheSymbol])
                 current[FromCacheSymbol] = event[FromCacheSymbol];
             return current;
         }
+        this.onBeforeInsert?.(event);
         this.events.set(id, event);
         this.getKindIndex(event.kind).add(event);
         this.getAuthorsIndex(event.pubkey).add(event);
@@ -116,8 +119,8 @@ export class Database {
         this.updated.next(inserted);
         return inserted;
     }
-    /** Deletes an event from the database and notifies all subscriptions */
-    deleteEvent(eventOrId) {
+    /** Removes an event from the database and notifies all subscriptions */
+    removeEvent(eventOrId) {
         let event = typeof eventOrId === "string" ? this.events.get(eventOrId) : eventOrId;
         if (!event)
             throw new Error("Missing event");
@@ -145,7 +148,10 @@ export class Database {
                 array.splice(idx, 1);
             }
         }
-        this.deleted.next(event);
+        // remove any claims this event has
+        this.claims.delete(event);
+        // notify subscribers this event was removed
+        this.removed.next(event);
         return true;
     }
     /** Sets the claim on the event and touches it */
@@ -281,7 +287,7 @@ export class Database {
         }
         return events;
     }
-    getForFilters(filters) {
+    getEventsForFilters(filters) {
         if (filters.length === 0)
             throw new Error("No Filters");
         let events = new Set();
@@ -299,7 +305,7 @@ export class Database {
         while (cursor) {
             const event = cursor.value;
             if (!this.isClaimed(event)) {
-                this.deleteEvent(event);
+                this.removeEvent(event);
                 removed++;
                 if (removed >= limit)
                     break;

package/dist/event-store/event-store.d.ts

@@ -1,49 +1,69 @@
 import { Filter, NostrEvent } from "nostr-tools";
 import { Observable } from "rxjs";
 import { Database } from "./database.js";
-export declare class EventStore {
+import { IEventStore } from "./interface.js";
+export declare const EventStoreSymbol: unique symbol;
+export declare class EventStore implements IEventStore {
     database: Database;
     /** Enable this to keep old versions of replaceable events */
     keepOldVersions: boolean;
+    /** A method used to verify new events before added them */
+    verifyEvent?: (event: NostrEvent) => boolean;
+    /** A stream of events that have been updated */
+    updates: Observable<NostrEvent>;
     constructor();
-    /** Adds an event to the database and update subscriptions */
-    add(event: NostrEvent, fromRelay?: string): NostrEvent;
-    /** Removes an event from the database and updates subscriptions */
-    remove(event: string | NostrEvent): boolean;
     protected deletedIds: Set<string>;
     protected deletedCoords: Map<string, number>;
+    protected checkDeleted(event: string | NostrEvent): boolean;
     protected handleDeleteEvent(deleteEvent: NostrEvent): void;
-    protected checkDeleted(event: NostrEvent): boolean;
+    /** Copies important metadata from and identical event to another */
+    static mergeDuplicateEvent(source: NostrEvent, dest: NostrEvent): void;
+    /**
+     * Adds an event to the database and update subscriptions
+     * @throws
+     */
+    add(event: NostrEvent, fromRelay?: string): NostrEvent;
+    /** Removes an event from the database and updates subscriptions */
+    remove(event: string | NostrEvent): boolean;
     /** Removes any event that is not being used by a subscription */
     prune(max?: number): number;
     /** Add an event to the store and notifies all subscribes it has updated */
     update(event: NostrEvent): NostrEvent;
-    getAll(filters: Filter[]): Set<NostrEvent>;
-    hasEvent(uid: string): boolean;
-    getEvent(uid: string): NostrEvent | undefined;
+    /** Get all events matching a filter */
+    getAll(filters: Filter | Filter[]): Set<NostrEvent>;
+    /** Check if the store has an event */
+    hasEvent(id: string): boolean;
+    getEvent(id: string): NostrEvent | undefined;
+    /** Check if the store has a replaceable event */
     hasReplaceable(kind: number, pubkey: string, d?: string): boolean;
     /** Gets the latest version of a replaceable event */
     getReplaceable(kind: number, pubkey: string, d?: string): NostrEvent | undefined;
     /** Returns all versions of a replaceable event */
     getReplaceableHistory(kind: number, pubkey: string, d?: string): NostrEvent[] | undefined;
-    /** Creates an observable that updates a single event */
+    /** Returns a timeline of events that match filters */
+    getTimeline(filters: Filter | Filter[]): NostrEvent[];
+    /**
+     * Creates an observable that streams all events that match the filter and remains open
+     * @param filters
+     * @param [onlyNew=false] Only subscribe to new events
+     */
+    filters(filters: Filter | Filter[], onlyNew?: boolean): Observable<NostrEvent>;
+    /** Returns an observable that completes when an event is removed */
+    removed(id: string): Observable<never>;
+    /** Creates an observable that emits when event is updated */
+    updated(event: string | NostrEvent): Observable<NostrEvent>;
+    /** Creates an observable that subscribes to a single event */
     event(id: string): Observable<NostrEvent | undefined>;
     /** Creates an observable that subscribes to multiple events */
-    events(ids: string[]): Observable<Map<string, NostrEvent>>;
-    /** Creates an observable with the latest version of a replaceable event */
+    events(ids: string[]): Observable<Record<string, NostrEvent>>;
+    /** Creates an observable that subscribes to the latest version of a replaceable event */
     replaceable(kind: number, pubkey: string, d?: string): Observable<NostrEvent | undefined>;
-    /** Creates an observable with the latest versions of replaceable events */
+    /** Creates an observable that subscribes to the latest version of an array of replaceable events*/
     replaceableSet(pointers: {
         kind: number;
         pubkey: string;
         identifier?: string;
-    }[]): Observable<Map<string, NostrEvent>>;
-    /**
-     * Creates an observable that streams all events that match the filter
-     * @param filters
-     * @param [onlyNew=false] Only subscribe to new events
-     */
-    stream(filters: Filter | Filter[], onlyNew?: boolean): Observable<NostrEvent>;
+    }[]): Observable<Record<string, NostrEvent>>;
     /** Creates an observable that updates with an array of sorted events */
     timeline(filters: Filter | Filter[], keepOldVersions?: boolean): Observable<NostrEvent[]>;
 }