applesauce-core 0.2.0 → 0.4.0

package/dist/query-store/index.js

@@ -1,71 +1,56 @@
-import { kinds } from "nostr-tools";
-import stringify from "json-stringify-deterministic";
 import { stateful } from "../observable/stateful.js";
-import { getProfileContent } from "../helpers/profile.js";
-import { getEventUID, getReplaceableUID, isReplaceable } from "../helpers/event.js";
-import { getInboxes, getOutboxes } from "../helpers/mailboxes.js";
 import { LRU } from "../utils/lru.js";
+import * as Queries from "../queries/index.js";
 export class QueryStore {
+    static Queries = Queries;
     store;
     constructor(store) {
         this.store = store;
     }
-    singleEvents = new LRU();
-    getEvent(id) {
-        if (!this.singleEvents.has(id)) {
-            const observable = stateful(this.store.single(id));
-            this.singleEvents.set(id, observable);
-        }
-        return this.singleEvents.get(id);
+    queries = new LRU();
+    /** Creates a cached query */
+    runQuery(queryConstructor) {
+        return (...args) => {
+            const query = queryConstructor(...args);
+            const key = `${queryConstructor.name}|${query.key}`;
+            if (!this.queries.has(key)) {
+                const observable = stateful(query.run(this.store, this));
+                this.queries.set(key, observable);
+                return observable;
+            }
+            return this.queries.get(key);
+        };
     }
-    getReplaceable(kind, pubkey, d) {
-        return this.getEvent(getReplaceableUID(kind, pubkey, d));
+    /** Returns a single event */
+    event(id) {
+        return this.runQuery(Queries.SingleEventQuery)(id);
     }
-    timelines = new LRU();
-    getTimeline(filters) {
-        const key = stringify(filters);
-        if (!this.singleEvents.has(key)) {
-            const observable = stateful(this.store.timeline(filters));
-            this.timelines.set(key, observable);
-        }
-        return this.timelines.get(key);
+    /** Returns the latest version of a replaceable event */
+    replaceable(kind, pubkey, d) {
+        return this.runQuery(Queries.ReplaceableQuery)(kind, pubkey, d);
     }
-    profiles = new LRU();
-    getProfile(pubkey) {
-        if (!this.profiles.has(pubkey)) {
-            const observable = stateful(this.getReplaceable(kinds.Metadata, pubkey).map((event) => event && getProfileContent(event)));
-            this.profiles.set(pubkey, observable);
-        }
-        return this.profiles.get(pubkey);
+    /** Returns an array of events that match the filter */
+    timeline(filters) {
+        return this.runQuery(Queries.TimelineQuery)(filters);
     }
-    reactions = new LRU();
-    getReactions(event) {
-        const uid = getEventUID(event);
-        if (!this.reactions.has(uid)) {
-            const observable = this.getTimeline(isReplaceable(event.kind)
-                ? [
-                    { kinds: [kinds.Reaction], "#e": [event.id] },
-                    { kinds: [kinds.Reaction], "#a": [uid] },
-                ]
-                : [
-                    {
-                        kinds: [kinds.Reaction],
-                        "#e": [event.id],
-                    },
-                ]);
-            this.reactions.set(uid, observable);
-        }
-        return this.reactions.get(uid);
+    /** Returns the parsed profile (0) for a pubkey */
+    profile(pubkey) {
+        return this.runQuery(Queries.ProfileQuery)(pubkey);
     }
-    mailboxes = new LRU();
-    getMailboxes(pubkey) {
-        if (!this.mailboxes.has(pubkey)) {
-            const observable = stateful(this.getReplaceable(kinds.RelayList, pubkey).map((event) => event && {
-                inboxes: getInboxes(event),
-                outboxes: getOutboxes(event),
-            }));
-            this.mailboxes.set(pubkey, observable);
-        }
-        return this.mailboxes.get(pubkey);
+    /** Returns all reactions for an event (supports replaceable events) */
+    reactions(event) {
+        return this.runQuery(Queries.ReactionsQuery)(event);
+    }
+    /** Returns the parsed relay list (10002) for the pubkey */
+    mailboxes(pubkey) {
+        return this.runQuery(Queries.MailboxesQuery)(pubkey);
+    }
+    /** Returns the parsed mute list for the pubkey */
+    mute(pubkey) {
+        return this.runQuery(Queries.UserMuteQuery)(pubkey);
+    }
+    thread(root) {
+        return this.runQuery(Queries.ThreadQuery)(root);
     }
 }
+export { Queries };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "applesauce-core",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "",
   "type": "module",
   "main": "dist/index.js",
@@ -33,6 +33,10 @@
     "./event-store": {
       "import": "./dist/event-store/index.js",
       "types": "./dist/event-store/index.d.ts"
+    },
+    "./queries": {
+      "import": "./dist/queries/index.js",
+      "types": "./dist/queries/index.d.ts"
     }
   },
   "dependencies": {
@@ -44,11 +48,26 @@
     "zen-push": "^0.3.1"
   },
   "devDependencies": {
+    "@jest/globals": "^29.7.0",
     "@types/debug": "^4.1.12",
+    "@types/jest": "^29.5.13",
     "@types/zen-observable": "^0.8.7",
+    "jest": "^29.7.0",
+    "jest-extended": "^4.0.2",
     "zen-observable": "^0.10.0"
   },
+  "jest": {
+    "roots": [
+      "dist"
+    ],
+    "setupFilesAfterEnv": [
+      "jest-extended/all"
+    ]
+  },
   "scripts": {
-    "build": "tsc"
+    "build": "tsc",
+    "watch:build": "tsc --watch > /dev/null",
+    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
+    "watch:test": "(trap 'kill 0' SIGINT; pnpm run build -w > /dev/null & pnpm run test --watch)"
   }
 }

package/dist/helpers/symbols.d.ts

@@ -1,17 +0,0 @@
-import { ProfileContent as TProfileContent } from "./profile.js";
-export declare const EventUID: unique symbol;
-export declare const EventIndexableTags: unique symbol;
-export declare const MailboxesInboxes: unique symbol;
-export declare const MailboxesOutboxes: unique symbol;
-export declare const ProfileContent: unique symbol;
-export declare const FromRelays: unique symbol;
-declare module "nostr-tools" {
-    interface Event {
-        [EventUID]?: string;
-        [MailboxesInboxes]?: Set<string>;
-        [MailboxesOutboxes]?: Set<string>;
-        [ProfileContent]?: TProfileContent | Error;
-        [EventIndexableTags]?: Set<string>;
-        [FromRelays]?: Set<string>;
-    }
-}

package/dist/helpers/symbols.js

@@ -1,10 +0,0 @@
-// event
-export const EventUID = Symbol.for("event-uid");
-export const EventIndexableTags = Symbol.for("indexable-tags");
-// mailboxes
-export const MailboxesInboxes = Symbol.for("mailboxes-inboxes");
-export const MailboxesOutboxes = Symbol.for("mailboxes-outboxes");
-// profile
-export const ProfileContent = Symbol.for("profile-content");
-// event relays
-export const FromRelays = Symbol.for("from-relays");