applesauce-core 0.8.0 → 0.10.0

package/README.md

@@ -1,6 +1,6 @@
 # applesauce-core
 
-AppleSauce Core is an interpretation layer for nostr clients, Push events into the in-memory [database](https://hzrd149.github.io/applesauce/classes/Database.html) and get nicely formatted data out with [queries](https://hzrd149.github.io/applesauce/modules/Queries)
+AppleSauce Core is an interpretation layer for nostr clients, Push events into the in-memory [database](https://hzrd149.github.io/applesauce/typedoc/classes/Database.html) and get nicely formatted data out with [queries](https://hzrd149.github.io/applesauce/typedoc/modules/Queries)
 
 # Example
 

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

@@ -1,9 +1,9 @@
-/// <reference types="debug" />
 import { Filter, NostrEvent } from "nostr-tools";
 import { Subject } from "rxjs";
 import { LRU } from "../helpers/lru.js";
 /**
  * An in-memory database for nostr events
+ * NOTE: does not handle replaceable events
  */
 export declare class Database {
     protected log: import("debug").Debugger;
@@ -14,6 +14,7 @@ export declare class Database {
     protected created_at: NostrEvent[];
     /** LRU cache of last events touched */
     events: LRU<import("nostr-tools").Event>;
+    protected replaceable: Map<string, import("nostr-tools").Event[]>;
     /** A stream of events inserted into the database */
     inserted: Subject<import("nostr-tools").Event>;
     /** A stream of events that have been updated */
@@ -28,18 +29,20 @@ export declare class Database {
     protected getTagIndex(tagAndValue: string): Set<import("nostr-tools").Event>;
     /** Moves an event to the top of the LRU cache */
     touch(event: NostrEvent): void;
-    hasEvent(uid: string): import("nostr-tools").Event | undefined;
-    getEvent(uid: string): import("nostr-tools").Event | undefined;
+    /** Checks if the database contains an event without touching it */
+    hasEvent(id: string): boolean;
+    /** Gets a single event based on id */
+    getEvent(id: string): NostrEvent | undefined;
     /** Checks if the database contains a replaceable event without touching it */
     hasReplaceable(kind: number, pubkey: string, d?: string): boolean;
-    /** Gets a replaceable event and touches it */
-    getReplaceable(kind: number, pubkey: string, d?: string): import("nostr-tools").Event | undefined;
+    /** Gets an array of replaceable events */
+    getReplaceable(kind: number, pubkey: string, d?: string): NostrEvent[] | undefined;
     /** Inserts an event into the database and notifies all subscriptions */
-    addEvent(event: NostrEvent): import("nostr-tools").Event;
+    addEvent(event: NostrEvent): NostrEvent;
     /** Inserts and event into the database and notifies all subscriptions that the event has updated */
-    updateEvent(event: NostrEvent): import("nostr-tools").Event;
+    updateEvent(event: NostrEvent): NostrEvent;
     /** Deletes an event from the database and notifies all subscriptions */
-    deleteEvent(eventOrUID: string | NostrEvent): boolean;
+    deleteEvent(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 */
@@ -48,14 +51,14 @@ export declare class Database {
     removeClaim(event: NostrEvent, claim: any): void;
     /** Removes all claims on an event */
     clearClaim(event: NostrEvent): void;
-    iterateAuthors(authors: Iterable<string>): Generator<import("nostr-tools").Event, void, unknown>;
-    iterateTag(tag: string, values: Iterable<string>): Generator<import("nostr-tools").Event, void, unknown>;
-    iterateKinds(kinds: Iterable<number>): Generator<import("nostr-tools").Event, void, unknown>;
-    iterateTime(since: number | undefined, until: number | undefined): Generator<never, Set<import("nostr-tools").Event>, unknown>;
-    iterateIds(ids: Iterable<string>): Generator<import("nostr-tools").Event, void, unknown>;
+    iterateAuthors(authors: Iterable<string>): Generator<NostrEvent>;
+    iterateTag(tag: string, values: Iterable<string>): Generator<NostrEvent>;
+    iterateKinds(kinds: Iterable<number>): Generator<NostrEvent>;
+    iterateTime(since: number | undefined, until: number | undefined): Generator<NostrEvent>;
+    iterateIds(ids: Iterable<string>): Generator<NostrEvent>;
     /** Returns all events that match the filter */
     getEventsForFilter(filter: Filter): Set<NostrEvent>;
-    getForFilters(filters: Filter[]): Set<import("nostr-tools").Event>;
+    getForFilters(filters: Filter[]): Set<NostrEvent>;
     /** Remove the oldest events that are not claimed */
     prune(limit?: number): number;
 }

package/dist/event-store/database.js

@@ -1,11 +1,12 @@
 import { binarySearch, insertEventIntoDescendingList } from "nostr-tools/utils";
 import { Subject } from "rxjs";
-import { FromCacheSymbol, getEventUID, getIndexableTags, getReplaceableUID } from "../helpers/event.js";
+import { FromCacheSymbol, getEventUID, getIndexableTags, getReplaceableUID, isReplaceable } from "../helpers/event.js";
 import { INDEXABLE_TAGS } from "./common.js";
 import { logger } from "../logger.js";
 import { LRU } from "../helpers/lru.js";
 /**
  * An in-memory database for nostr events
+ * NOTE: does not handle replaceable events
  */
 export class Database {
     log = logger.extend("Database");
@@ -16,6 +17,7 @@ export class Database {
     created_at = [];
     /** LRU cache of last events touched */
     events = new LRU();
+    replaceable = new Map();
     /** A stream of events inserted into the database */
     inserted = new Subject();
     /** A stream of events that have been updated */
@@ -56,35 +58,36 @@ export class Database {
     }
     /** Moves an event to the top of the LRU cache */
     touch(event) {
-        this.events.set(getEventUID(event), event);
+        this.events.set(event.id, event);
     }
-    hasEvent(uid) {
-        return this.events.get(uid);
+    /** Checks if the database contains an event without touching it */
+    hasEvent(id) {
+        return this.events.has(id);
     }
-    getEvent(uid) {
-        return this.events.get(uid);
+    /** Gets a single event based on id */
+    getEvent(id) {
+        return this.events.get(id);
     }
     /** Checks if the database contains a replaceable event without touching it */
     hasReplaceable(kind, pubkey, d) {
-        return this.events.has(getReplaceableUID(kind, pubkey, d));
+        const events = this.replaceable.get(getReplaceableUID(kind, pubkey, d));
+        return !!events && events.length > 0;
     }
-    /** Gets a replaceable event and touches it */
+    /** Gets an array of replaceable events */
     getReplaceable(kind, pubkey, d) {
-        return this.events.get(getReplaceableUID(kind, pubkey, d));
+        return this.replaceable.get(getReplaceableUID(kind, pubkey, d));
     }
     /** Inserts an event into the database and notifies all subscriptions */
     addEvent(event) {
-        const uid = getEventUID(event);
-        const current = this.events.get(uid);
-        if (current && event.created_at <= current.created_at) {
+        const id = event.id;
+        const current = this.events.get(id);
+        if (current) {
             // if this is a duplicate event, transfer some import symbols
-            if (current.id === event.id) {
-                if (event[FromCacheSymbol])
-                    current[FromCacheSymbol] = event[FromCacheSymbol];
-            }
+            if (event[FromCacheSymbol])
+                current[FromCacheSymbol] = event[FromCacheSymbol];
             return current;
         }
-        this.events.set(uid, event);
+        this.events.set(id, event);
         this.getKindIndex(event.kind).add(event);
         this.getAuthorsIndex(event.pubkey).add(event);
         for (const tag of getIndexableTags(event)) {
@@ -92,7 +95,18 @@ export class Database {
                 this.getTagIndex(tag).add(event);
             }
         }
+        // insert into time index
         insertEventIntoDescendingList(this.created_at, event);
+        // insert into replaceable index
+        if (isReplaceable(event.kind)) {
+            const uid = getEventUID(event);
+            let array = this.replaceable.get(uid);
+            if (!this.replaceable.has(uid)) {
+                array = [];
+                this.replaceable.set(uid, array);
+            }
+            insertEventIntoDescendingList(array, event);
+        }
         this.inserted.next(event);
         return event;
     }
@@ -103,13 +117,13 @@ export class Database {
         return inserted;
     }
     /** Deletes an event from the database and notifies all subscriptions */
-    deleteEvent(eventOrUID) {
-        let event = typeof eventOrUID === "string" ? this.events.get(eventOrUID) : eventOrUID;
+    deleteEvent(eventOrId) {
+        let event = typeof eventOrId === "string" ? this.events.get(eventOrId) : eventOrId;
         if (!event)
             throw new Error("Missing event");
-        const uid = getEventUID(event);
+        const id = event.id;
         // only remove events that are known
-        if (!this.events.has(uid))
+        if (!this.events.has(id))
             return false;
         this.getAuthorsIndex(event.pubkey).delete(event);
         this.getKindIndex(event.kind).delete(event);
@@ -121,7 +135,16 @@ export class Database {
         // remove from created_at index
         const i = this.created_at.indexOf(event);
         this.created_at.splice(i, 1);
-        this.events.delete(uid);
+        this.events.delete(id);
+        // remove from replaceable index
+        if (isReplaceable(event.kind)) {
+            const uid = getEventUID(event);
+            const array = this.replaceable.get(uid);
+            if (array && array.includes(event)) {
+                const idx = array.indexOf(event);
+                array.splice(idx, 1);
+            }
+        }
         this.deleted.next(event);
         return true;
     }
@@ -179,27 +202,21 @@ export class Database {
         let sinceIndex = this.created_at.length - 1;
         let start = until
             ? binarySearch(this.created_at, (mid) => {
-                if (mid.created_at === until)
-                    return -1;
                 return mid.created_at - until;
             })
             : undefined;
-        if (start && start[1])
+        if (start)
             untilIndex = start[0];
         const end = since
             ? binarySearch(this.created_at, (mid) => {
-                if (mid.created_at === since)
-                    return 1;
-                return since - mid.created_at;
+                return mid.created_at - since;
             })
             : undefined;
-        if (end && end[1])
+        if (end)
             sinceIndex = end[0];
-        const events = new Set();
-        for (let i = untilIndex; i <= sinceIndex; i++) {
-            events.add(this.created_at[i]);
+        for (let i = untilIndex; i < sinceIndex; i++) {
+            yield this.created_at[i];
         }
-        return events;
     }
     *iterateIds(ids) {
         for (const id of ids) {

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

@@ -3,24 +3,47 @@ import { Observable } from "rxjs";
 import { Database } from "./database.js";
 export declare class EventStore {
     database: Database;
+    /** Enable this to keep old versions of replaceable events */
+    keepOldVersions: boolean;
     constructor();
-    /** Adds an event to the database */
-    add(event: NostrEvent, fromRelay?: string): import("nostr-tools").Event;
+    /** 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 handleDeleteEvent(deleteEvent: NostrEvent): void;
+    protected checkDeleted(event: 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): import("nostr-tools").Event;
-    getAll(filters: Filter[]): Set<import("nostr-tools").Event>;
-    hasEvent(uid: string): import("nostr-tools").Event | undefined;
-    getEvent(uid: string): import("nostr-tools").Event | undefined;
+    update(event: NostrEvent): NostrEvent;
+    getAll(filters: Filter[]): Set<NostrEvent>;
+    hasEvent(uid: string): boolean;
+    getEvent(uid: string): NostrEvent | undefined;
     hasReplaceable(kind: number, pubkey: string, d?: string): boolean;
-    getReplaceable(kind: number, pubkey: string, d?: string): import("nostr-tools").Event | undefined;
+    /** 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 */
-    event(uid: string): Observable<import("nostr-tools").Event | undefined>;
+    event(id: string): Observable<NostrEvent | undefined>;
     /** Creates an observable that subscribes to multiple events */
-    events(uids: string[]): Observable<Map<string, import("nostr-tools").Event>>;
-    /** Creates an observable that updates a single replaceable event */
-    replaceable(kind: number, pubkey: string, d?: string): Observable<import("nostr-tools").Event | undefined>;
-    /** Creates an observable that streams all events that match the filter */
-    stream(filters: Filter[]): Observable<import("nostr-tools").Event>;
+    events(ids: string[]): Observable<Map<string, NostrEvent>>;
+    /** Creates an observable with 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 */
+    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>;
     /** Creates an observable that updates with an array of sorted events */
-    timeline(filters: Filter[]): Observable<import("nostr-tools").Event[]>;
+    timeline(filters: Filter | Filter[], keepOldVersions?: boolean): Observable<NostrEvent[]>;
 }