applesauce-core 0.10.0 → 0.12.0

package/dist/query-store/index.d.ts

@@ -1,57 +1 @@
-import { BehaviorSubject, Observable } from "rxjs";
-import { Filter, NostrEvent } from "nostr-tools";
-import { EventStore } from "../event-store/event-store.js";
-import { LRU } from "../helpers/lru.js";
-import * as Queries from "../queries/index.js";
-import { AddressPointer, EventPointer } from "nostr-tools/nip19";
-export type Query<T extends unknown> = {
-    /**
-     * A unique key for this query. this is used to detect duplicate queries
-     */
-    key: string;
-    /** The args array this query was created with. This is mostly for debugging */
-    args?: Array<any>;
-    /**
-     * The meat of the query, this should return an Observables that subscribes to the eventStore in some way
-     */
-    run: (events: EventStore, store: QueryStore) => Observable<T>;
-};
-export type QueryConstructor<T extends unknown, Args extends Array<any>> = (...args: Args) => Query<T>;
-export declare class QueryStore {
-    static Queries: typeof Queries;
-    store: EventStore;
-    constructor(store: EventStore);
-    queries: LRU<Query<any>>;
-    observables: WeakMap<Query<any>, Observable<any> | BehaviorSubject<any>>;
-    /** Creates a cached query */
-    createQuery<T extends unknown, Args extends Array<any>>(queryConstructor: (...args: Args) => {
-        key: string;
-        run: (events: EventStore, store: QueryStore) => Observable<T>;
-    }, ...args: Args): Observable<T>;
-    /** Creates a SingleEventQuery */
-    event(id: string): Observable<import("nostr-tools").Event | undefined>;
-    /** Creates a MultipleEventsQuery */
-    events(ids: string[]): Observable<Map<string, import("nostr-tools").Event>>;
-    /** Creates a ReplaceableQuery */
-    replaceable(kind: number, pubkey: string, d?: string): Observable<import("nostr-tools").Event | undefined>;
-    /** Creates a ReplaceableSetQuery */
-    replaceableSet(pointers: {
-        kind: number;
-        pubkey: string;
-        identifier?: string;
-    }[]): Observable<Map<string, import("nostr-tools").Event>>;
-    /** Creates a TimelineQuery */
-    timeline(filters: Filter | Filter[], keepOldVersions?: boolean): Observable<import("nostr-tools").Event[]>;
-    /** Creates a ProfileQuery */
-    profile(pubkey: string): Observable<import("../helpers/profile.js").ProfileContent | undefined>;
-    /** Creates a ReactionsQuery */
-    reactions(event: NostrEvent): Observable<import("nostr-tools").Event[]>;
-    /** Creates a MailboxesQuery */
-    mailboxes(pubkey: string): Observable<{
-        inboxes: string[];
-        outboxes: string[];
-    } | undefined>;
-    /** Creates a ThreadQuery */
-    thread(root: string | EventPointer | AddressPointer): Observable<Queries.Thread>;
-}
-export { Queries };
+export * from "./query-store.js";

package/dist/query-store/index.js

@@ -1,66 +1 @@
-import { LRU } from "../helpers/lru.js";
-import * as Queries from "../queries/index.js";
-import { shareLatestValue } from "../observable/share-latest-value.js";
-export class QueryStore {
-    static Queries = Queries;
-    store;
-    constructor(store) {
-        this.store = store;
-    }
-    queries = new LRU();
-    observables = new WeakMap();
-    /** Creates a cached query */
-    createQuery(queryConstructor, ...args) {
-        const tempQuery = queryConstructor(...args);
-        const key = `${queryConstructor.name}|${tempQuery.key}`;
-        let query = this.queries.get(key);
-        if (!query) {
-            query = tempQuery;
-            this.queries.set(key, tempQuery);
-        }
-        if (!this.observables.has(query)) {
-            query.args = args;
-            const observable = query.run(this.store, this).pipe(shareLatestValue());
-            this.observables.set(query, observable);
-            return observable;
-        }
-        return this.observables.get(query);
-    }
-    /** Creates a SingleEventQuery */
-    event(id) {
-        return this.createQuery(Queries.SingleEventQuery, id);
-    }
-    /** Creates a MultipleEventsQuery */
-    events(ids) {
-        return this.createQuery(Queries.MultipleEventsQuery, ids);
-    }
-    /** Creates a ReplaceableQuery */
-    replaceable(kind, pubkey, d) {
-        return this.createQuery(Queries.ReplaceableQuery, kind, pubkey, d);
-    }
-    /** Creates a ReplaceableSetQuery */
-    replaceableSet(pointers) {
-        return this.createQuery(Queries.ReplaceableSetQuery, pointers);
-    }
-    /** Creates a TimelineQuery */
-    timeline(filters, keepOldVersions) {
-        return this.createQuery(Queries.TimelineQuery, filters, keepOldVersions);
-    }
-    /** Creates a ProfileQuery */
-    profile(pubkey) {
-        return this.createQuery(Queries.ProfileQuery, pubkey);
-    }
-    /** Creates a ReactionsQuery */
-    reactions(event) {
-        return this.createQuery(Queries.ReactionsQuery, event);
-    }
-    /** Creates a MailboxesQuery */
-    mailboxes(pubkey) {
-        return this.createQuery(Queries.MailboxesQuery, pubkey);
-    }
-    /** Creates a ThreadQuery */
-    thread(root) {
-        return this.createQuery(Queries.ThreadQuery, root);
-    }
-}
-export { Queries };
+export * from "./query-store.js";

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

@@ -0,0 +1,53 @@
+import { Observable } from "rxjs";
+import { Filter, NostrEvent } from "nostr-tools";
+import type { AddressPointer, EventPointer } from "nostr-tools/nip19";
+import { IEventStore } from "../event-store/interface.js";
+import * as Queries from "../queries/index.js";
+export type Query<T extends unknown> = {
+    /** A unique key for this query. this is used to detect duplicate queries */
+    key: string;
+    /** The meat of the query, this should return an Observables that subscribes to the eventStore in some way */
+    run: (events: IEventStore, store: QueryStore) => Observable<T>;
+};
+export type QueryConstructor<T extends unknown, Args extends Array<any>> = (...args: Args) => Query<T>;
+export declare class QueryStore {
+    static Queries: typeof Queries;
+    store: IEventStore;
+    constructor(store: IEventStore);
+    /** A directory of all active queries */
+    queries: Map<QueryConstructor<any, any[]>, Map<string, Observable<any>>>;
+    /** How long a query should be kept "warm" while nothing is subscribed to it */
+    queryKeepWarmTimeout: number;
+    /** Creates a cached query */
+    createQuery<T extends unknown, Args extends Array<any>>(queryConstructor: QueryConstructor<T, Args>, ...args: Args): Observable<T | undefined>;
+    /** Creates a query and waits for the next value */
+    executeQuery<T extends unknown, Args extends Array<any>>(queryConstructor: QueryConstructor<T, Args>, ...args: Args): Promise<T>;
+    /** Creates a SingleEventQuery */
+    event(id: string): Observable<import("nostr-tools").Event | undefined>;
+    /** Creates a MultipleEventsQuery */
+    events(ids: string[]): Observable<Record<string, import("nostr-tools").Event> | undefined>;
+    /** Creates a ReplaceableQuery */
+    replaceable(kind: number, pubkey: string, d?: string): Observable<import("nostr-tools").Event | undefined>;
+    /** Creates a ReplaceableSetQuery */
+    replaceableSet(pointers: {
+        kind: number;
+        pubkey: string;
+        identifier?: string;
+    }[]): Observable<Record<string, import("nostr-tools").Event> | undefined>;
+    /** Creates a TimelineQuery */
+    timeline(filters: Filter | Filter[], keepOldVersions?: boolean): Observable<import("nostr-tools").Event[] | undefined>;
+    /** Creates a ProfileQuery */
+    profile(pubkey: string): Observable<import("../helpers/profile.js").ProfileContent | undefined>;
+    /** Creates a ReactionsQuery */
+    reactions(event: NostrEvent): Observable<import("nostr-tools").Event[] | undefined>;
+    /** Creates a MailboxesQuery */
+    mailboxes(pubkey: string): Observable<{
+        inboxes: string[];
+        outboxes: string[];
+    } | undefined>;
+    /** Creates a query for a users blossom servers */
+    blossomServers(pubkey: string): Observable<URL[] | undefined>;
+    /** Creates a ThreadQuery */
+    thread(root: string | EventPointer | AddressPointer): Observable<Queries.Thread | undefined>;
+}
+export { Queries };

package/dist/query-store/query-store.js

@@ -0,0 +1,97 @@
+import { filter, finalize, ReplaySubject, share, timer } from "rxjs";
+import hash_sum from "hash-sum";
+import * as Queries from "../queries/index.js";
+import { getObservableValue } from "../observable/get-observable-value.js";
+import { withImmediateValueOrDefault } from "../observable/with-immediate-value.js";
+export class QueryStore {
+    static Queries = Queries;
+    store;
+    constructor(store) {
+        if (!store)
+            throw new Error("EventStore required");
+        this.store = store;
+    }
+    /** A directory of all active queries */
+    queries = new Map();
+    /** How long a query should be kept "warm" while nothing is subscribed to it */
+    queryKeepWarmTimeout = 60_000;
+    /** Creates a cached query */
+    createQuery(queryConstructor, ...args) {
+        let observables = this.queries.get(queryConstructor);
+        if (!observables) {
+            observables = new Map();
+            this.queries.set(queryConstructor, observables);
+        }
+        const key = hash_sum(args);
+        let observable = observables.get(key);
+        if (!observable) {
+            const cleanup = () => {
+                if (observables.get(key) === observable)
+                    observables.delete(key);
+            };
+            observable = queryConstructor(...args)
+                .run(this.store, this)
+                .pipe(
+            // always emit undefined so the observable is sync
+            withImmediateValueOrDefault(undefined), 
+            // remove the observable when its subscribed
+            finalize(cleanup), 
+            // only create a single observable for all components
+            share({
+                connector: () => new ReplaySubject(1),
+                resetOnComplete: () => timer(this.queryKeepWarmTimeout),
+                resetOnRefCountZero: () => timer(this.queryKeepWarmTimeout),
+            }));
+            // set debug fields
+            Reflect.set(observable, "queryArgs", args);
+            observables.set(key, observable);
+        }
+        return observable;
+    }
+    /** Creates a query and waits for the next value */
+    async executeQuery(queryConstructor, ...args) {
+        const query = this.createQuery(queryConstructor, ...args).pipe(filter((v) => v !== undefined));
+        return getObservableValue(query);
+    }
+    /** Creates a SingleEventQuery */
+    event(id) {
+        return this.createQuery(Queries.SingleEventQuery, id);
+    }
+    /** Creates a MultipleEventsQuery */
+    events(ids) {
+        return this.createQuery(Queries.MultipleEventsQuery, ids);
+    }
+    /** Creates a ReplaceableQuery */
+    replaceable(kind, pubkey, d) {
+        return this.createQuery(Queries.ReplaceableQuery, kind, pubkey, d);
+    }
+    /** Creates a ReplaceableSetQuery */
+    replaceableSet(pointers) {
+        return this.createQuery(Queries.ReplaceableSetQuery, pointers);
+    }
+    /** Creates a TimelineQuery */
+    timeline(filters, keepOldVersions) {
+        return this.createQuery(Queries.TimelineQuery, filters, keepOldVersions);
+    }
+    /** Creates a ProfileQuery */
+    profile(pubkey) {
+        return this.createQuery(Queries.ProfileQuery, pubkey);
+    }
+    /** Creates a ReactionsQuery */
+    reactions(event) {
+        return this.createQuery(Queries.ReactionsQuery, event);
+    }
+    /** Creates a MailboxesQuery */
+    mailboxes(pubkey) {
+        return this.createQuery(Queries.MailboxesQuery, pubkey);
+    }
+    /** Creates a query for a users blossom servers */
+    blossomServers(pubkey) {
+        return this.createQuery(Queries.UserBlossomServersQuery, pubkey);
+    }
+    /** Creates a ThreadQuery */
+    thread(root) {
+        return this.createQuery(Queries.ThreadQuery, root);
+    }
+}
+export { Queries };

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "applesauce-core",
-  "version": "0.10.0",
+  "version": "0.12.0",
   "description": "",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "keywords": [
-    "nostr"
+    "nostr",
+    "applesauce"
   ],
   "author": "hzrd149",
   "license": "MIT",
@@ -16,56 +17,67 @@
   "exports": {
     ".": {
       "import": "./dist/index.js",
+      "require": "./dist/index.js",
       "types": "./dist/index.d.ts"
     },
     "./helpers": {
       "import": "./dist/helpers/index.js",
+      "require": "./dist/helpers/index.js",
       "types": "./dist/helpers/index.d.ts"
     },
     "./helpers/*": {
       "import": "./dist/helpers/*.js",
+      "require": "./dist/helpers/*.js",
       "types": "./dist/helpers/*.d.ts"
     },
     "./queries": {
       "import": "./dist/queries/index.js",
+      "require": "./dist/queries/index.js",
       "types": "./dist/queries/index.d.ts"
     },
     "./queries/*": {
       "import": "./dist/queries/*.js",
+      "require": "./dist/queries/*.js",
       "types": "./dist/queries/*.d.ts"
     },
     "./observable": {
       "import": "./dist/observable/index.js",
+      "require": "./dist/observable/index.js",
       "types": "./dist/observable/index.d.ts"
     },
     "./promise": {
       "import": "./dist/promise/index.js",
+      "require": "./dist/promise/index.js",
       "types": "./dist/promise/index.d.ts"
     },
     "./query-store": {
       "import": "./dist/query-store/index.js",
+      "require": "./dist/query-store/index.js",
       "types": "./dist/query-store/index.d.ts"
     },
     "./event-store": {
       "import": "./dist/event-store/index.js",
+      "require": "./dist/event-store/index.js",
       "types": "./dist/event-store/index.d.ts"
     }
   },
   "dependencies": {
-    "@scure/base": "^1.1.9",
-    "debug": "^4.3.7",
+    "@noble/hashes": "^1.7.1",
+    "@scure/base": "^1.2.4",
+    "debug": "^4.4.0",
     "fast-deep-equal": "^3.1.3",
     "hash-sum": "^2.0.0",
     "light-bolt11-decoder": "^3.2.0",
-    "nanoid": "^5.0.7",
-    "nostr-tools": "^2.10.3",
+    "nanoid": "^5.0.9",
+    "nostr-tools": "^2.10.4",
     "rxjs": "^7.8.1"
   },
   "devDependencies": {
+    "@hirez_io/observer-spy": "^2.2.0",
     "@types/debug": "^4.1.12",
     "@types/hash-sum": "^1.0.2",
-    "typescript": "^5.6.3",
-    "vitest": "^2.1.8"
+    "typescript": "^5.7.3",
+    "vitest": "^3.0.5"
   },
   "funding": {
     "type": "lightning",

package/dist/helpers/media-attachment.d.ts

@@ -1,33 +0,0 @@
-import { NostrEvent } from "nostr-tools";
-export type MediaAttachment = {
-    /** URL of the file */
-    url: string;
-    /** mime type */
-    type?: string;
-    /** sha256 hash of the file */
-    sha256?: string;
-    /** size of the file in bytes */
-    size?: number;
-    /** size of file in pixels in the form <width>x<height> */
-    dimensions?: string;
-    /** magnet */
-    magnet?: string;
-    /** torrent infohash */
-    infohash?: string;
-    /** URL to a thumbnail */
-    thumb?: string;
-    /** URL to a preview image with the same dimensions */
-    image?: string;
-    /** summary */
-    summary?: string;
-    /** description for accessability */
-    alt?: string;
-};
-/**
- * Parses a imeta tag into a {@link MediaAttachment}
- * @throws
- */
-export declare function parseMediaAttachmentTag(tag: string[]): MediaAttachment;
-export declare const MediaAttachmentsSymbol: unique symbol;
-/** Gets all the media attachments on an event */
-export declare function getMediaAttachments(event: NostrEvent): MediaAttachment[];

package/dist/helpers/media-attachment.js

@@ -1,60 +0,0 @@
-import { getOrComputeCachedValue } from "./cache.js";
-/**
- * Parses a imeta tag into a {@link MediaAttachment}
- * @throws
- */
-export function parseMediaAttachmentTag(tag) {
-    const parts = tag.slice(1);
-    const fields = {};
-    for (const part of parts) {
-        const match = part.match(/^(.+?)\s(.+)$/);
-        if (match) {
-            const [_, name, value] = match;
-            fields[name] = value;
-        }
-    }
-    if (!fields.url)
-        throw new Error("Missing required url in attachment");
-    const attachment = { url: fields.url };
-    // parse size
-    if (fields.size)
-        attachment.size = parseInt(fields.size);
-    // copy optional fields
-    if (fields.m)
-        attachment.type = fields.m;
-    if (fields.x)
-        attachment.sha256 = fields.x;
-    if (fields.dim)
-        attachment.dimensions = fields.dim;
-    if (fields.magnet)
-        attachment.magnet = fields.magnet;
-    if (fields.i)
-        attachment.infohash = fields.i;
-    if (fields.thumb)
-        attachment.thumb = fields.thumb;
-    if (fields.image)
-        attachment.image = fields.image;
-    if (fields.summary)
-        attachment.summary = fields.summary;
-    if (fields.alt)
-        attachment.alt = fields.alt;
-    return attachment;
-}
-export const MediaAttachmentsSymbol = Symbol.for("media-attachments");
-/** Gets all the media attachments on an event */
-export function getMediaAttachments(event) {
-    return getOrComputeCachedValue(event, MediaAttachmentsSymbol, () => {
-        return event.tags
-            .filter((t) => t[0] === "imeta")
-            .map((tag) => {
-            try {
-                return parseMediaAttachmentTag(tag);
-            }
-            catch (error) {
-                // ignore invalid attachments
-                return undefined;
-            }
-        })
-            .filter((a) => !!a);
-    });
-}