applesauce-core 1.0.0 → 2.0.0

package/dist/queries/simple.d.ts

@@ -1,16 +0,0 @@
-import { Filter, NostrEvent } from "nostr-tools";
-import { Query } from "../query-store/index.js";
-/** Creates a Query that returns a single event or undefined */
-export declare function SingleEventQuery(id: string): Query<NostrEvent | undefined>;
-/** Creates a Query that returns a multiple events in a map */
-export declare function MultipleEventsQuery(ids: string[]): Query<Record<string, NostrEvent>>;
-/** Creates a Query returning the latest version of a replaceable event */
-export declare function ReplaceableQuery(kind: number, pubkey: string, d?: string): Query<NostrEvent | undefined>;
-/** Creates a Query that returns an array of sorted events matching the filters */
-export declare function TimelineQuery(filters: Filter | Filter[], includeOldVersion?: boolean): Query<NostrEvent[]>;
-/** Creates a Query that returns a directory of events by their UID */
-export declare function ReplaceableSetQuery(pointers: {
-    kind: number;
-    pubkey: string;
-    identifier?: string;
-}[]): Query<Record<string, NostrEvent>>;

package/dist/queries/simple.js

@@ -1,21 +0,0 @@
-/** Creates a Query that returns a single event or undefined */
-export function SingleEventQuery(id) {
-    return (events) => events.event(id);
-}
-/** Creates a Query that returns a multiple events in a map */
-export function MultipleEventsQuery(ids) {
-    return (events) => events.events(ids);
-}
-/** Creates a Query returning the latest version of a replaceable event */
-export function ReplaceableQuery(kind, pubkey, d) {
-    return (events) => events.replaceable(kind, pubkey, d);
-}
-/** Creates a Query that returns an array of sorted events matching the filters */
-export function TimelineQuery(filters, includeOldVersion) {
-    filters = Array.isArray(filters) ? filters : [filters];
-    return (events) => events.timeline(filters, includeOldVersion);
-}
-/** Creates a Query that returns a directory of events by their UID */
-export function ReplaceableSetQuery(pointers) {
-    return (events) => events.replaceableSet(pointers);
-}

package/dist/queries/user-status.d.ts

@@ -1,11 +0,0 @@
-import { NostrEvent } from "nostr-tools";
-import { UserStatusPointer } from "../helpers/user-status.js";
-import { Query } from "../query-store/index.js";
-export type UserStatus = UserStatusPointer & {
-    event: NostrEvent;
-    content: string;
-};
-/** Creates a Query that returns a parsed {@link UserStatus} for a certain type */
-export declare function UserStatusQuery(pubkey: string, type?: string): Query<UserStatus | undefined | null>;
-/** Creates a Query that returns a directory of parsed {@link UserStatus} for a pubkey */
-export declare function UserStatusesQuery(pubkey: string): Query<Record<string, UserStatus>>;

package/dist/queries/zaps.d.ts

@@ -1,5 +0,0 @@
-import { AddressPointer, EventPointer } from "nostr-tools/nip19";
-import { NostrEvent } from "nostr-tools";
-import { Query } from "../query-store/index.js";
-/** A query that gets all zap events for an event */
-export declare function EventZapsQuery(id: string | EventPointer | AddressPointer): Query<NostrEvent[]>;

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

@@ -1 +0,0 @@
-export {};

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

@@ -1,63 +0,0 @@
-import { describe, it, expect, beforeEach } from "vitest";
-import { subscribeSpyTo } from "@hirez_io/observer-spy";
-import { EventStore } from "../../event-store/event-store.js";
-import { QueryStore } from "../query-store.js";
-import { ProfileQuery } from "../../queries/profile.js";
-import { SingleEventQuery } from "../../queries/simple.js";
-let eventStore;
-let queryStore;
-const event = {
-    content: '{"name":"hzrd149","picture":"https://cdn.hzrd149.com/5ed3fe5df09a74e8c126831eac999364f9eb7624e2b86d521521b8021de20bdc.png","about":"JavaScript developer working on some nostr stuff\\n- noStrudel https://nostrudel.ninja/ \\n- Blossom https://github.com/hzrd149/blossom \\n- Applesauce https://hzrd149.github.io/applesauce/","website":"https://hzrd149.com","nip05":"_@hzrd149.com","lud16":"hzrd1499@minibits.cash","pubkey":"266815e0c9210dfa324c6cba3573b14bee49da4209a9456f9484e5106cd408a5","display_name":"hzrd149","displayName":"hzrd149","banner":""}',
-    created_at: 1738362529,
-    id: "e9df8d5898c4ccfbd21fcd59f3f48abb3ff0ab7259b19570e2f1756de1e9306b",
-    kind: 0,
-    pubkey: "266815e0c9210dfa324c6cba3573b14bee49da4209a9456f9484e5106cd408a5",
-    sig: "465a47b93626a587bf81dadc2b306b8f713a62db31d6ce1533198e9ae1e665a6eaf376a03250bf9ffbb02eb9059c8eafbd37ae1092d05d215757575bd8357586",
-    tags: [],
-};
-beforeEach(() => {
-    eventStore = new EventStore();
-    queryStore = new QueryStore(eventStore);
-});
-describe("createQuery", () => {
-    it("should emit synchronous value if it exists", () => {
-        let value = undefined;
-        eventStore.add(event);
-        queryStore.createQuery(ProfileQuery, event.pubkey).subscribe((v) => (value = v));
-        expect(value).not.toBe(undefined);
-    });
-    it("should not emit undefined if value exists", () => {
-        eventStore.add(event);
-        const spy = subscribeSpyTo(queryStore.createQuery(SingleEventQuery, event.id));
-        expect(spy.getValues()).toEqual([event]);
-    });
-    it("should emit synchronous undefined if value does not exists", () => {
-        let value = 0;
-        queryStore.createQuery(ProfileQuery, event.pubkey).subscribe((v) => {
-            value = v;
-        });
-        expect(value).not.toBe(0);
-        expect(value).toBe(undefined);
-    });
-    it("should share latest value", () => {
-        eventStore.add(event);
-        const spy = subscribeSpyTo(queryStore.createQuery(SingleEventQuery, event.id));
-        const spy2 = subscribeSpyTo(queryStore.createQuery(SingleEventQuery, event.id));
-        expect(spy.getValues()).toEqual([event]);
-        expect(spy2.getValues()).toEqual([event]);
-    });
-});
-describe("executeQuery", () => {
-    it("should resolve when value is already present", async () => {
-        eventStore.add(event);
-        expect(await queryStore.executeQuery(ProfileQuery, event.pubkey)).toEqual(expect.objectContaining({ name: "hzrd149" }));
-    });
-    it("should resolve when value is added to event store", async () => {
-        const p = queryStore.executeQuery(ProfileQuery, event.pubkey);
-        // delay adding the event
-        setTimeout(() => {
-            eventStore.add(event);
-        }, 10);
-        await expect(p).resolves.toEqual(expect.objectContaining({ name: "hzrd149" }));
-    });
-});

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

@@ -1 +0,0 @@
-export * from "./query-store.js";

package/dist/query-store/index.js

@@ -1 +0,0 @@
-export * from "./query-store.js";

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

@@ -1,54 +0,0 @@
-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> = (events: IEventStore, store: QueryStore) => Observable<T>;
-export type QueryConstructor<T extends unknown, Args extends Array<any>> = ((...args: Args) => Query<T>) & {
-    getKey?: (...args: Args) => string;
-};
-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 ContactsQuery */
-    contacts(pubkey: string): Observable<import("nostr-tools/nip19").ProfilePointer[] | undefined>;
-    /** Creates a MuteQuery */
-    mutes(pubkey: string): Observable<import("../helpers/mutes.js").Mutes | 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

@@ -1,102 +0,0 @@
-import { filter, finalize, firstValueFrom, ReplaySubject, share, timer } from "rxjs";
-import hash_sum from "hash-sum";
-import * as Queries from "../queries/index.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 = queryConstructor.getKey ? queryConstructor.getKey(...args) : hash_sum(args);
-        let observable = observables.get(key);
-        if (!observable) {
-            const cleanup = () => {
-                if (observables.get(key) === observable)
-                    observables.delete(key);
-            };
-            observable = queryConstructor(...args)(this.store, this).pipe(
-            // always emit undefined so the observable is sync
-            withImmediateValueOrDefault(undefined), 
-            // remove the observable when its unsubscribed
-            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 firstValueFrom(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 ContactsQuery */
-    contacts(pubkey) {
-        return this.createQuery(Queries.ContactsQuery, pubkey);
-    }
-    /** Creates a MuteQuery */
-    mutes(pubkey) {
-        return this.createQuery(Queries.MuteQuery, 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 };