applesauce-core 6.0.3 → 6.1.0

package/dist/casts/cast.d.ts

@@ -1,8 +1,6 @@
-import { Observable } from "rxjs";
 import { EventModels, IEventStoreStreams, IEventSubscriptions } from "../event-store/index.js";
 import { NostrEvent } from "../helpers/event.js";
-import { ChainableObservable } from "../observable/chainable.js";
-import { User } from "./user.js";
+import { EventCast } from "./event.js";
 /** The type of event store that is passed to cast references */
 export type CastRefEventStore = IEventSubscriptions & EventModels & IEventStoreStreams;
 /** A symbol used to store all the cast instances for a given event */
@@ -13,19 +11,3 @@ export declare const CASTS_SYMBOL: unique symbol;
 export type CastConstructor<C extends EventCast<NostrEvent>> = new (event: NostrEvent, store: CastRefEventStore) => C;
 /** Cast a Nostr event to a specific class */
 export declare function castEvent<C extends EventCast<NostrEvent>>(event: NostrEvent, cls: CastConstructor<C>, store?: CastRefEventStore): C;
-/** The base class for all casts */
-export declare class EventCast<T extends NostrEvent = NostrEvent> {
-    #private;
-    readonly event: T;
-    readonly store: CastRefEventStore;
-    get id(): string;
-    get uid(): string;
-    get createdAt(): Date;
-    /** Get the {@link User} that authored this event */
-    get author(): User;
-    /** Return the set of relays this event was seen on */
-    get seen(): Set<string> | undefined;
-    constructor(event: T, store: CastRefEventStore);
-    /** Internal method for creating a reference */
-    protected $$ref<Return extends unknown>(key: string, builder: (store: CastRefEventStore) => Observable<Return>): ChainableObservable<Return>;
-}

package/dist/casts/cast.js

@@ -1,7 +1,4 @@
-import { getEventUID, getParentEventStore } from "../helpers/event.js";
-import { getSeenRelays } from "../helpers/relays.js";
-import { chainable } from "../observable/chainable.js";
-import { castUser } from "./user.js";
+import { getParentEventStore } from "../helpers/event.js";
 /** A symbol used to store all the cast instances for a given event */
 export const CAST_REF_SYMBOL = Symbol.for("cast-ref");
 /** A symbol used to store all the casts for an event */
@@ -26,42 +23,3 @@ export function castEvent(event, cls, store) {
         casts.set(cls, cast);
     return cast;
 }
-/** The base class for all casts */
-export class EventCast {
-    event;
-    store;
-    get id() {
-        return this.event.id;
-    }
-    get uid() {
-        return getEventUID(this.event);
-    }
-    get createdAt() {
-        return new Date(this.event.created_at * 1000);
-    }
-    /** Get the {@link User} that authored this event */
-    get author() {
-        return castUser(this.event, this.store);
-    }
-    /** Return the set of relays this event was seen on */
-    get seen() {
-        return getSeenRelays(this.event);
-    }
-    // Enfore kind check in constructor. this will force child classes to verify the event before calling super()
-    constructor(event, store) {
-        this.event = event;
-        this.store = store;
-    }
-    /** A cache of observable references */
-    #refs = {};
-    /** Internal method for creating a reference */
-    $$ref(key, builder) {
-        // Return cached observable
-        if (this.#refs[key])
-            return this.#refs[key];
-        // Build a new observable and cache it
-        const observable = chainable(builder(this.store));
-        this.#refs[key] = observable;
-        return observable;
-    }
-}

package/dist/casts/event.d.ts

@@ -0,0 +1,33 @@
+import { Observable } from "rxjs";
+import { NostrEvent } from "../helpers/event.js";
+import { AddressPointer, EventPointer } from "../helpers/pointers.js";
+import { ChainableObservable } from "../observable/chainable.js";
+import { CastRefEventStore } from "./cast.js";
+import { User } from "./user.js";
+/** The base class for all casts */
+export declare class EventCast<T extends NostrEvent = NostrEvent> {
+    #private;
+    readonly event: T;
+    readonly store: CastRefEventStore;
+    /** Alias for event.id */
+    get id(): string;
+    /** Alias for event.kind */
+    get kind(): number;
+    /** Returns the unique identifier for this event */
+    get uid(): string;
+    /** Returns the created_at timestamp as a Date object */
+    get createdAt(): Date;
+    /** Get the {@link User} that authored this event */
+    get author(): User;
+    /** Return the set of relays this event was seen on */
+    get seen(): Set<string> | undefined;
+    /** Returns the NIP-01 address string for this event if its replaceable or addressable, otherwise returns null */
+    get coordinate(): string | null;
+    /** Alias for {@link coordinate} */
+    get replaceableAddress(): string | null;
+    /** Returns a single {@link EventPointer} or {@link AddressPointer} for this event */
+    get pointer(): EventPointer | AddressPointer;
+    constructor(event: T, store: CastRefEventStore);
+    /** Internal method for creating a reference */
+    protected $$ref<Return extends unknown>(key: string, builder: (store: CastRefEventStore) => Observable<Return>): ChainableObservable<Return>;
+}

package/dist/casts/event.js

@@ -0,0 +1,65 @@
+import { getEventUID, isAddressableKind, isReplaceableKind } from "../helpers/event.js";
+import { getAddressPointerForEvent, getEventPointerForEvent, getReplaceableAddressForEvent, } from "../helpers/pointers.js";
+import { getSeenRelays } from "../helpers/relays.js";
+import { chainable } from "../observable/chainable.js";
+import { castUser } from "./user.js";
+/** The base class for all casts */
+export class EventCast {
+    event;
+    store;
+    /** Alias for event.id */
+    get id() {
+        return this.event.id;
+    }
+    /** Alias for event.kind */
+    get kind() {
+        return this.event.kind;
+    }
+    /** Returns the unique identifier for this event */
+    get uid() {
+        return getEventUID(this.event);
+    }
+    /** Returns the created_at timestamp as a Date object */
+    get createdAt() {
+        return new Date(this.event.created_at * 1000);
+    }
+    /** Get the {@link User} that authored this event */
+    get author() {
+        return castUser(this.event, this.store);
+    }
+    /** Return the set of relays this event was seen on */
+    get seen() {
+        return getSeenRelays(this.event);
+    }
+    /** Returns the NIP-01 address string for this event if its replaceable or addressable, otherwise returns null */
+    get coordinate() {
+        return getReplaceableAddressForEvent(this.event);
+    }
+    /** Alias for {@link coordinate} */
+    get replaceableAddress() {
+        return this.coordinate;
+    }
+    /** Returns a single {@link EventPointer} or {@link AddressPointer} for this event */
+    get pointer() {
+        if (isReplaceableKind(this.kind) || isAddressableKind(this.kind))
+            return getAddressPointerForEvent(this.event) || getEventPointerForEvent(this.event);
+        return getEventPointerForEvent(this.event);
+    }
+    // Enfore kind check in constructor. this will force child classes to verify the event before calling super()
+    constructor(event, store) {
+        this.event = event;
+        this.store = store;
+    }
+    /** A cache of observable references */
+    #refs = {};
+    /** Internal method for creating a reference */
+    $$ref(key, builder) {
+        // Return cached observable
+        if (this.#refs[key])
+            return this.#refs[key];
+        // Build a new observable and cache it
+        const observable = chainable(builder(this.store));
+        this.#refs[key] = observable;
+        return observable;
+    }
+}

package/dist/casts/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./cast.js";
+export * from "./event.js";
 export * from "./pubkey.js";
 export * from "./user.js";

package/dist/casts/index.js

@@ -1,3 +1,4 @@
 export * from "./cast.js";
+export * from "./event.js";
 export * from "./pubkey.js";
 export * from "./user.js";

package/dist/casts/pubkey.d.ts

@@ -1,4 +1,3 @@
-/** A constructor type for {@link PubkeyCast} subclasses */
 import { Observable } from "rxjs";
 import { NostrEvent } from "../helpers/event.js";
 import type { ProfilePointer } from "../helpers/pointers.js";

package/dist/casts/pubkey.js

@@ -1,4 +1,3 @@
-/** A constructor type for {@link PubkeyCast} subclasses */
 import { isEvent } from "../helpers/event.js";
 import { isHexKey } from "../helpers/string.js";
 import { chainable } from "../observable/chainable.js";

package/dist/casts/user.d.ts

@@ -1,8 +1,11 @@
+import { Observable } from "rxjs";
 import { NostrEvent } from "../helpers/event.js";
+import { Filter } from "../helpers/filter.js";
 import { ProfilePointer } from "../helpers/pointers.js";
 import { ChainableObservable } from "../observable/chainable.js";
-import type { CastRefEventStore } from "./cast.js";
+import type { CastConstructor, CastRefEventStore } from "./cast.js";
 import { PubkeyCast } from "./pubkey.js";
+import { EventCast } from "./event.js";
 /** Cast a Nostr event or pointer into a {@link User} */
 export declare function castUser(event: NostrEvent, store: CastRefEventStore): User;
 export declare function castUser(user: string | ProfilePointer, store: CastRefEventStore): User;
@@ -10,10 +13,19 @@ export declare function castUser(user: string | ProfilePointer, store: CastRefEv
 export declare class User extends PubkeyCast {
     /** A global cache of pubkey -> {@link User} */
     static cache: Map<string, User>;
+    /** Returns the NIP-19 npub for this user */
     get npub(): `npub1${string}`;
+    /** Returns the NIP-19 nprofile for this user */
     get nprofile(): `nprofile1${string}`;
     /** Subscribe to a replaceable event for this user */
     replaceable(kind: number, identifier?: string, relays?: string[]): ChainableObservable<NostrEvent | undefined>;
     /** Subscribe to an addressable event for this user */
     addressable(kind: number, identifier: string, relays?: string[]): ChainableObservable<NostrEvent | undefined>;
+    /**
+     * Creates an observable of a timeline of events created by this user
+     * @param input - The filter(s) for the timeline or kind(s)
+     * @returns A timeline observable of events by the user rom the event store
+     */
+    timeline$(input: Omit<Filter, "authors"> | Omit<Filter, "authors">[] | number | number[]): Observable<NostrEvent[]>;
+    timeline$<T extends EventCast>(input: Omit<Filter, "authors"> | Omit<Filter, "authors">[] | number | number[], cast?: CastConstructor<T>): Observable<T[]>;
 }

package/dist/casts/user.js

@@ -1,6 +1,8 @@
+import hash_sum from "hash-sum";
 import { nprofileEncode, npubEncode } from "../helpers/pointers.js";
 import { chainable } from "../observable/chainable.js";
 import { castPubkey, PubkeyCast } from "./pubkey.js";
+import { castTimelineStream } from "../observable/cast-stream.js";
 export function castUser(user, store) {
     return castPubkey(user, User, store);
 }
@@ -8,9 +10,11 @@ export function castUser(user, store) {
 export class User extends PubkeyCast {
     /** A global cache of pubkey -> {@link User} */
     static cache = new Map();
+    /** Returns the NIP-19 npub for this user */
     get npub() {
         return npubEncode(this.pubkey);
     }
+    /** Returns the NIP-19 nprofile for this user */
     get nprofile() {
         return nprofileEncode(this.pointer);
     }
@@ -22,4 +26,24 @@ export class User extends PubkeyCast {
     addressable(kind, identifier, relays) {
         return chainable(this.store.addressable({ kind, pubkey: this.pointer.pubkey, identifier, relays }));
     }
+    timeline$(input, cast) {
+        let filters = [];
+        if (typeof input === "number") {
+            filters.push({ kinds: [input] });
+        }
+        else if (Array.isArray(input)) {
+            filters.push(...input.map((f) => (typeof f === "number" ? { kinds: [f] } : f)));
+        }
+        else if (input instanceof Object) {
+            filters.push(input);
+        }
+        // Use hash_sum to create a unique key for the timeline observable
+        const key = "timeline$|" + hash_sum(filters);
+        const base$ = this.$$ref(key, (store) => store.timeline(filters.map((f) => ({ ...f, authors: [this.pubkey] }))));
+        // Cast the timeline stream into a cast if provided
+        if (cast)
+            return base$.pipe(castTimelineStream(cast));
+        else
+            return base$;
+    }
 }

package/dist/helpers/pointers.d.ts

@@ -39,6 +39,8 @@ export declare function isProfilePointer(pointer: any): pointer is ProfilePointe
 export declare function isEventPointer(pointer: any): pointer is EventPointer;
 /** Returns the stringified NIP-19 encoded naddr address pointer for an AddressPointer. */
 export declare function getReplaceableAddressFromPointer(pointer: AddressPointer): string;
+/** Returns the replaceable coordinate for a replaceable event ( used for "a" tags to reference replaceable events ). */
+export declare function getReplaceableAddressForEvent(event: NostrEvent): string | null;
 /** Returns an AddressPointer for a replaceable event. Returns null if the event is not addressable or replaceable. */
 export declare function getAddressPointerForEvent(event: NostrEvent, relays?: string[]): AddressPointer | null;
 /** Returns an EventPointer for an event */

package/dist/helpers/pointers.js

@@ -204,6 +204,13 @@ export function isEventPointer(pointer) {
 export function getReplaceableAddressFromPointer(pointer) {
     return pointer.kind + ":" + pointer.pubkey + ":" + pointer.identifier;
 }
+/** Returns the replaceable coordinate for a replaceable event ( used for "a" tags to reference replaceable events ). */
+export function getReplaceableAddressForEvent(event) {
+    if (!isReplaceableKind(event.kind) && !isAddressableKind(event.kind))
+        return null;
+    const d = getReplaceableIdentifier(event);
+    return event.kind + ":" + event.pubkey + ":" + d;
+}
 /** Returns an AddressPointer for a replaceable event. Returns null if the event is not addressable or replaceable. */
 export function getAddressPointerForEvent(event, relays) {
     if (!isAddressableKind(event.kind) && !isReplaceableKind(event.kind))

package/dist/observable/cast-stream.d.ts

@@ -0,0 +1,8 @@
+import { OperatorFunction } from "rxjs";
+import type { CastConstructor, CastRefEventStore } from "../casts/cast.js";
+import { EventCast } from "../casts/index.js";
+import { NostrEvent } from "../helpers/event.js";
+/** Casts an event to a specific type */
+export declare function castEventStream<C extends EventCast>(cls: CastConstructor<C>, store?: CastRefEventStore): OperatorFunction<NostrEvent | undefined, C | undefined>;
+/** Casts and array of events to an array of casted events and filters out undefined values */
+export declare function castTimelineStream<C extends EventCast>(cls: CastConstructor<C>, store?: CastRefEventStore): OperatorFunction<NostrEvent[], C[]>;

package/dist/observable/cast-stream.js

@@ -0,0 +1,29 @@
+import { map } from "rxjs";
+import { castEvent } from "../casts/index.js";
+import { defined } from "./defined.js";
+/** Casts an event to a specific type */
+export function castEventStream(cls, store) {
+    return (source) => source.pipe(map((event) => {
+        if (!event)
+            return undefined;
+        try {
+            return castEvent(event, cls, store);
+        }
+        catch { }
+        return undefined;
+    }));
+}
+/** Casts and array of events to an array of casted events and filters out undefined values */
+export function castTimelineStream(cls, store) {
+    return (source) => source.pipe(map((events) => {
+        const castedEvents = [];
+        for (const event of events) {
+            try {
+                const casted = castEvent(event, cls, store);
+                castedEvents.push(casted);
+            }
+            catch { }
+        }
+        return castedEvents;
+    }), defined());
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "applesauce-core",
-  "version": "6.0.3",
+  "version": "6.1.0",
   "description": "",
   "type": "module",
   "main": "dist/index.js",