applesauce-common 0.0.0-next-20251209200210 → 0.0.0-next-20251231055351

package/README.md

@@ -1,11 +1,33 @@
 # applesauce-common
 
-AppleSauce is a collection of utilities for building reactive nostr applications. The common package provides NIP-specific helpers and models for working with various Nostr Improvement Proposals (NIPs).
+AppleSauce is a collection of utilities for building reactive nostr applications. The common package provides NIP-specific helpers, models, operations, and utilities for working with various Nostr Improvement Proposals (NIPs). This package contains all the extra functionality that applications can use with nostr events that is not directly related to the core protocol.
+
+## Installation
+
+```bash
+npm install applesauce-common
+```
+
+or
+
+```bash
+yarn add applesauce-common
+```
+
+or
+
+```bash
+pnpm add applesauce-common
+```
 
 ## Key Components
 
 - **Helpers**: NIP-specific utility methods for parsing and extracting data from nostr events
-- **Models**: Complex subscriptions for NIP-specific nostr data patterns
+- **Models**: Complex reactive subscriptions for NIP-specific nostr data patterns
+- **Operations**: Functions for creating and constructing nostr events according to various NIPs
+- **Blueprints**: Event blueprints and templates for creating properly formatted nostr events
+- **Casts**: Type casting utilities for converting between different event representations
+- **Observable**: Observable utilities and operators for working with reactive streams of nostr events
 
 ## Documentation
 
@@ -48,12 +70,31 @@ thread.subscribe((thread) => {
 
 ## Supported NIPs
 
-This package includes helpers and models for various NIPs including:
+This package includes helpers, models, and operations for various NIPs including:
 
 - NIP-10 (Threading)
+- NIP-18 (Reposts)
 - NIP-22 (Comments)
-- NIP-53 (Streams)
 - NIP-23 (Articles)
+- NIP-25 (Reactions)
+- NIP-28 (Channels)
 - NIP-52 (Calendar Events)
+- NIP-53 (Streams)
+- NIP-57 (Zaps)
 - NIP-88 (Polls)
 - And many more...
+
+## Exports
+
+The package provides several export paths:
+
+- `applesauce-common` - Main exports (Helpers, Models, Operations, etc.)
+- `applesauce-common/helpers` - All helper functions
+- `applesauce-common/helpers/*` - Individual helper modules
+- `applesauce-common/models` - All model functions
+- `applesauce-common/models/*` - Individual model modules
+- `applesauce-common/operations` - All operation functions
+- `applesauce-common/operations/*` - Individual operation modules
+- `applesauce-common/blueprints` - Event blueprints
+- `applesauce-common/casts` - Type casting utilities
+- `applesauce-common/observable` - Observable utilities

package/dist/blueprints/__register__.d.ts

@@ -0,0 +1,7 @@
+import "./comment.js";
+import "./delete.js";
+import "./note.js";
+import "./reaction.js";
+import "./share.js";
+import "./poll.js";
+import "./torrent.js";

package/dist/blueprints/__register__.js

@@ -0,0 +1,8 @@
+// Import blueprints that should register with the event factory
+import "./comment.js";
+import "./delete.js";
+import "./note.js";
+import "./reaction.js";
+import "./share.js";
+import "./poll.js";
+import "./torrent.js";

package/dist/blueprints/comment.d.ts

@@ -1,12 +1,13 @@
 import { NostrEvent, EventTemplate } from "applesauce-core/helpers/event";
 import { TextContentOptions } from "applesauce-core/operations/content";
 import { MetaTagOptions } from "applesauce-core/operations/event";
+import { CommentPointer } from "../helpers/comment.js";
 export type CommentBlueprintOptions = TextContentOptions & MetaTagOptions;
 /** A blueprint to create a NIP-22 comment event */
-export declare function CommentBlueprint(parent: NostrEvent, content: string, options?: CommentBlueprintOptions): import("applesauce-core/event-factory").EventBlueprint;
+export declare function CommentBlueprint(parent: NostrEvent | CommentPointer, content: string, options?: CommentBlueprintOptions): import("applesauce-core/event-factory").EventBlueprint;
 declare module "applesauce-core/event-factory" {
     interface EventFactory {
         /** Create a NIP-22 comment event */
-        comment(parent: NostrEvent, content: string, options?: CommentBlueprintOptions): Promise<EventTemplate>;
+        comment(parent: NostrEvent | CommentPointer, content: string, options?: CommentBlueprintOptions): Promise<EventTemplate>;
     }
 }

package/dist/blueprints/group-mangement.d.ts

@@ -0,0 +1,25 @@
+import { NostrEvent } from "applesauce-core/helpers/event";
+import { GroupMetadata, GroupPointer } from "../helpers/groups.js";
+/** Options for group membership blueprints that support previous references */
+export type GroupMembershipOptions = {
+    previous?: NostrEvent[];
+    reason?: string;
+};
+/** A blueprint for a NIP-29 join request (kind 9021) */
+export declare function GroupJoinRequestBlueprint(group: GroupPointer, reason?: string, inviteCode?: string): import("applesauce-core/event-factory").EventBlueprint;
+/** A blueprint for a NIP-29 leave request (kind 9022) */
+export declare function GroupLeaveRequestBlueprint(group: GroupPointer, reason?: string): import("applesauce-core/event-factory").EventBlueprint;
+/** A blueprint for a NIP-29 put user moderation event (kind 9000) */
+export declare function PutUserBlueprint(group: GroupPointer, pubkey: string, roles?: string[], options?: GroupMembershipOptions): import("applesauce-core/event-factory").EventBlueprint;
+/** A blueprint for a NIP-29 remove user moderation event (kind 9001) */
+export declare function GroupRemoveUserBlueprint(group: GroupPointer, pubkey: string, options?: GroupMembershipOptions): import("applesauce-core/event-factory").EventBlueprint;
+/** A blueprint for a NIP-29 edit metadata moderation event (kind 9002) */
+export declare function GroupEditMetadataBlueprint(group: GroupPointer, fields: Partial<GroupMetadata>, options?: GroupMembershipOptions): import("applesauce-core/event-factory").EventBlueprint;
+/** A blueprint for a NIP-29 delete event moderation event (kind 9005) */
+export declare function GroupDeleteEventBlueprint(group: GroupPointer, eventId: string, options?: GroupMembershipOptions): import("applesauce-core/event-factory").EventBlueprint;
+/** A blueprint for a NIP-29 create group moderation event (kind 9007) */
+export declare function GroupCreateGroupBlueprint(group: GroupPointer, options?: GroupMembershipOptions): import("applesauce-core/event-factory").EventBlueprint;
+/** A blueprint for a NIP-29 delete group moderation event (kind 9008) */
+export declare function GroupDeleteGroupBlueprint(group: GroupPointer, options?: GroupMembershipOptions): import("applesauce-core/event-factory").EventBlueprint;
+/** A blueprint for a NIP-29 create invite moderation event (kind 9009) */
+export declare function GroupCreateInviteBlueprint(group: GroupPointer, options?: GroupMembershipOptions): import("applesauce-core/event-factory").EventBlueprint;

package/dist/blueprints/group-mangement.js

@@ -0,0 +1,40 @@
+import { blueprint } from "applesauce-core/event-factory";
+import { setContent } from "applesauce-core/operations/content";
+import { CREATE_GROUP_KIND, CREATE_INVITE_KIND, DELETE_EVENT_KIND, DELETE_GROUP_KIND, EDIT_METADATA_KIND, JOIN_REQUEST_KIND, LEAVE_REQUEST_KIND, PUT_USER_KIND, REMOVE_USER_KIND, } from "../helpers/groups.js";
+import { addPreviousRefs, setDeleteEventTags, setEditMetadataTags, setGroupPointer, setJoinRequestTags, setLeaveRequestTags, setPutUserTags, setRemoveUserTags, } from "../operations/group.js";
+/** A blueprint for a NIP-29 join request (kind 9021) */
+export function GroupJoinRequestBlueprint(group, reason, inviteCode) {
+    return blueprint(JOIN_REQUEST_KIND, setGroupPointer(group), setJoinRequestTags(group, inviteCode), reason ? setContent(reason) : undefined);
+}
+/** A blueprint for a NIP-29 leave request (kind 9022) */
+export function GroupLeaveRequestBlueprint(group, reason) {
+    return blueprint(LEAVE_REQUEST_KIND, setGroupPointer(group), setLeaveRequestTags(group), reason ? setContent(reason) : undefined);
+}
+/** A blueprint for a NIP-29 put user moderation event (kind 9000) */
+export function PutUserBlueprint(group, pubkey, roles, options) {
+    return blueprint(PUT_USER_KIND, setGroupPointer(group), setPutUserTags(pubkey, roles), options?.previous && options.previous.length > 0 ? addPreviousRefs(options.previous) : undefined, options?.reason ? setContent(options.reason) : undefined);
+}
+/** A blueprint for a NIP-29 remove user moderation event (kind 9001) */
+export function GroupRemoveUserBlueprint(group, pubkey, options) {
+    return blueprint(REMOVE_USER_KIND, setGroupPointer(group), setRemoveUserTags(pubkey), options?.previous && options.previous.length > 0 ? addPreviousRefs(options.previous) : undefined, options?.reason ? setContent(options.reason) : undefined);
+}
+/** A blueprint for a NIP-29 edit metadata moderation event (kind 9002) */
+export function GroupEditMetadataBlueprint(group, fields, options) {
+    return blueprint(EDIT_METADATA_KIND, setGroupPointer(group), setEditMetadataTags(fields), options?.previous && options.previous.length > 0 ? addPreviousRefs(options.previous) : undefined, options?.reason ? setContent(options.reason) : undefined);
+}
+/** A blueprint for a NIP-29 delete event moderation event (kind 9005) */
+export function GroupDeleteEventBlueprint(group, eventId, options) {
+    return blueprint(DELETE_EVENT_KIND, setGroupPointer(group), setDeleteEventTags(eventId), options?.previous && options.previous.length > 0 ? addPreviousRefs(options.previous) : undefined, options?.reason ? setContent(options.reason) : undefined);
+}
+/** A blueprint for a NIP-29 create group moderation event (kind 9007) */
+export function GroupCreateGroupBlueprint(group, options) {
+    return blueprint(CREATE_GROUP_KIND, setGroupPointer(group), options?.previous && options.previous.length > 0 ? addPreviousRefs(options.previous) : undefined, options?.reason ? setContent(options.reason) : undefined);
+}
+/** A blueprint for a NIP-29 delete group moderation event (kind 9008) */
+export function GroupDeleteGroupBlueprint(group, options) {
+    return blueprint(DELETE_GROUP_KIND, setGroupPointer(group), options?.previous && options.previous.length > 0 ? addPreviousRefs(options.previous) : undefined, options?.reason ? setContent(options.reason) : undefined);
+}
+/** A blueprint for a NIP-29 create invite moderation event (kind 9009) */
+export function GroupCreateInviteBlueprint(group, options) {
+    return blueprint(CREATE_INVITE_KIND, setGroupPointer(group), options?.previous && options.previous.length > 0 ? addPreviousRefs(options.previous) : undefined, options?.reason ? setContent(options.reason) : undefined);
+}

package/dist/blueprints/index.d.ts

@@ -7,6 +7,7 @@ export * from "./file-metadata.js";
 export * from "./follow-set.js";
 export * from "./gift-wrap.js";
 export * from "./group.js";
+export * from "./group-mangement.js";
 export * from "./delete.js";
 export * from "./highlight.js";
 export * from "./legacy-message.js";

package/dist/blueprints/index.js

@@ -7,6 +7,7 @@ export * from "./file-metadata.js";
 export * from "./follow-set.js";
 export * from "./gift-wrap.js";
 export * from "./group.js";
+export * from "./group-mangement.js";
 export * from "./delete.js";
 export * from "./highlight.js";
 export * from "./legacy-message.js";

package/dist/blueprints/torrent.d.ts

@@ -1,3 +1,4 @@
+import { EventTemplate } from "applesauce-core/helpers/event";
 import { MetaTagOptions } from "applesauce-core/operations/event";
 import { TorrentExternalIdentifier, TorrentFile } from "../helpers/torrent.js";
 export type TorrentBlueprintOptions = MetaTagOptions & {
@@ -21,3 +22,9 @@ export type TorrentBlueprintOptions = MetaTagOptions & {
  * Creates a torrent event with info hash and optional metadata
  */
 export declare function TorrentBlueprint(infoHash: string, content: string, options?: TorrentBlueprintOptions): import("applesauce-core/event-factory").EventBlueprint;
+declare module "applesauce-core/event-factory" {
+    interface EventFactory {
+        /** Create a NIP-35 torrent event (kind 2003) */
+        torrent(infoHash: string, content: string, options?: TorrentBlueprintOptions): Promise<EventTemplate>;
+    }
+}

package/dist/blueprints/torrent.js

@@ -1,4 +1,4 @@
-import { blueprint } from "applesauce-core/event-factory";
+import { blueprint, EventFactory } from "applesauce-core/event-factory";
 import { eventPipe } from "applesauce-core/helpers/pipeline";
 import { setContent } from "applesauce-core/operations/content";
 import { setMetaTags } from "applesauce-core/operations/event";
@@ -23,3 +23,7 @@ export function TorrentBlueprint(infoHash, content, options) {
         ? eventPipe(...options.externalIdentifiers.map((id) => addTorrentExternalIdentifier(id)))
         : undefined, setMetaTags({ ...options, alt: options?.alt ?? `Torrent: ${options?.title ?? infoHash}` }));
 }
+// Register this blueprint with EventFactory
+EventFactory.prototype.torrent = function (infoHash, content, options) {
+    return this.create(TorrentBlueprint, infoHash, content, options);
+};

package/dist/casts/article.d.ts

@@ -0,0 +1,19 @@
+import { NostrEvent } from "applesauce-core/helpers";
+import { ArticleEvent } from "../helpers/article.js";
+import { CastRefEventStore, EventCast } from "./cast.js";
+import { Reaction } from "./reaction.js";
+export declare class Article extends EventCast<ArticleEvent> {
+    constructor(event: NostrEvent, store: CastRefEventStore);
+    get title(): string;
+    get image(): string | undefined;
+    get summary(): string | undefined;
+    get published(): number;
+    get publishedDate(): Date;
+    get pointer(): import("nostr-tools/nip19").AddressPointer;
+    /** An observable of the address with relay hints from the authors outboxes */
+    get pointer$(): import("applesauce-core").Observable<import("nostr-tools/nip19").AddressPointer>;
+    get address(): `naddr1${string}`;
+    /** An observable of the address with relay hints from the authors outboxes */
+    get address$(): import("applesauce-core").Observable<`naddr1${string}`>;
+    get reactions$(): import("../observable/chainable.js").ChainableObservable<Reaction[]>;
+}

package/dist/casts/article.js

@@ -0,0 +1,47 @@
+import { withImmediateValueOrDefault } from "applesauce-core";
+import { addRelayHintsToPointer, getAddressPointerForEvent, naddrEncode } from "applesauce-core/helpers";
+import { map } from "rxjs";
+import { getArticleImage, getArticlePublished, getArticleSummary, getArticleTitle, isValidArticle, } from "../helpers/article.js";
+import { ReactionsModel } from "../models/reactions.js";
+import { castTimelineStream } from "../observable/cast-stream.js";
+import { EventCast } from "./cast.js";
+import { Reaction } from "./reaction.js";
+export class Article extends EventCast {
+    constructor(event, store) {
+        if (!isValidArticle(event))
+            throw new Error("Invalid article");
+        super(event, store);
+    }
+    get title() {
+        return getArticleTitle(this.event);
+    }
+    get image() {
+        return getArticleImage(this.event);
+    }
+    get summary() {
+        return getArticleSummary(this.event);
+    }
+    get published() {
+        return getArticlePublished(this.event);
+    }
+    get publishedDate() {
+        return new Date(this.published * 1000);
+    }
+    get pointer() {
+        return getAddressPointerForEvent(this.event);
+    }
+    /** An observable of the address with relay hints from the authors outboxes */
+    get pointer$() {
+        return this.author.outboxes$.pipe(withImmediateValueOrDefault(undefined), map((outboxes) => (outboxes ? addRelayHintsToPointer(this.pointer, outboxes.slice(0, 3)) : this.pointer)));
+    }
+    get address() {
+        return naddrEncode(this.pointer);
+    }
+    /** An observable of the address with relay hints from the authors outboxes */
+    get address$() {
+        return this.pointer$.pipe(map((pointer) => naddrEncode(pointer)));
+    }
+    get reactions$() {
+        return this.$$ref("reactions$", (store) => store.model(ReactionsModel, this.event).pipe(castTimelineStream(Reaction, store)));
+    }
+}

package/dist/casts/bookmarks.d.ts

@@ -0,0 +1,35 @@
+import { HiddenContentSigner, NostrEvent } from "applesauce-core/helpers";
+import { BookmarkListEvent, BookmarkSetEvent } from "../helpers/bookmark.js";
+import { Article } from "./article.js";
+import { CastRefEventStore, EventCast } from "./cast.js";
+import { Note } from "./note.js";
+/** Base class for bookmarks lists and sets */
+declare class BookmarksListBase<T extends BookmarkListEvent | BookmarkSetEvent> extends EventCast<T> {
+    constructor(event: T, store: CastRefEventStore);
+    get bookmarks(): import("../helpers/bookmark.js").BookmarkPointer[];
+    get articles(): import("nostr-tools/nip19").AddressPointer[];
+    get notes(): import("nostr-tools/nip19").EventPointer[];
+    get notes$(): import("../observable/chainable.js").ChainableObservable<Note[]>;
+    get articles$(): import("../observable/chainable.js").ChainableObservable<Article[]>;
+    /** Get the unlocked hidden bookmarks */
+    get hidden(): import("../helpers/bookmark.js").BookmarkPointer[] | undefined;
+    /** An observable that updates when hidden bookmarks are unlocked */
+    get hidden$(): import("../observable/chainable.js").ChainableObservable<import("../helpers/bookmark.js").BookmarkPointer[] | undefined>;
+    get hiddenNotes$(): import("../observable/chainable.js").ChainableObservable<Note[] | undefined>;
+    get hiddenArticles$(): import("../observable/chainable.js").ChainableObservable<Article[] | undefined>;
+    /** Whether the bookmark set has hidden bookmarks */
+    get hasHidden(): boolean;
+    /** Whether the bookmark set is unlocked */
+    get unlocked(): boolean;
+    /** Unlocks the hidden bookmarks on the bookmark set */
+    unlock(signer: HiddenContentSigner): Promise<import("../helpers/bookmark.js").BookmarkPointer[]>;
+}
+/** A class for bookmarks lists (kind 10003) */
+export declare class BookmarksList extends BookmarksListBase<BookmarkListEvent> {
+    constructor(event: NostrEvent, store: CastRefEventStore);
+}
+/** A class for bookmarks sets (kind 30003) */
+export declare class BookmarksSet extends BookmarksListBase<BookmarkSetEvent> {
+    constructor(event: NostrEvent, store: CastRefEventStore);
+}
+export {};

package/dist/casts/bookmarks.js

@@ -0,0 +1,91 @@
+import { hasHiddenContent, isAddressPointer, isEventPointer, } from "applesauce-core/helpers";
+import { watchEventUpdates } from "applesauce-core/observable";
+import { combineLatest, map, of, switchMap } from "rxjs";
+import { getBookmarks, getHiddenBookmarks, isHiddenBookmarksUnlocked, isValidBookmarkList, isValidBookmarkSet, unlockHiddenBookmarks, } from "../helpers/bookmark.js";
+import { castTimelineStream } from "../observable/cast-stream.js";
+import { Article } from "./article.js";
+import { EventCast } from "./cast.js";
+import { Note } from "./note.js";
+/** Base class for bookmarks lists and sets */
+class BookmarksListBase extends EventCast {
+    constructor(event, store) {
+        if (!isValidBookmarkList(event) && !isValidBookmarkSet(event))
+            throw new Error("Invalid bookmark list or set");
+        super(event, store);
+    }
+    get bookmarks() {
+        return getBookmarks(this.event);
+    }
+    get articles() {
+        return this.bookmarks.filter((pointer) => isAddressPointer(pointer));
+    }
+    get notes() {
+        return this.bookmarks.filter((pointer) => isEventPointer(pointer));
+    }
+    get notes$() {
+        return this.$$ref("notes$", (store) => combineLatest(this.notes.map((pointer) => store.event(pointer))).pipe(map((arr) => arr.filter((e) => !!e)), castTimelineStream(Note, store)));
+    }
+    get articles$() {
+        return this.$$ref("articles$", (store) => combineLatest(this.articles.map((pointer) => store.replaceable(pointer))).pipe(map((arr) => arr.filter((e) => !!e)), castTimelineStream(Article, store)));
+    }
+    /** Get the unlocked hidden bookmarks */
+    get hidden() {
+        return getHiddenBookmarks(this.event);
+    }
+    /** An observable that updates when hidden bookmarks are unlocked */
+    get hidden$() {
+        return this.$$ref("hidden$", (store) => of(this.event).pipe(
+        // Watch for event updates
+        watchEventUpdates(store), 
+        // Get hidden bookmarks
+        map((event) => event && getHiddenBookmarks(event))));
+    }
+    get hiddenNotes$() {
+        return this.$$ref("hiddenNotes$", (store) => this.hidden$.pipe(switchMap((hidden) => {
+            if (hidden === undefined)
+                return of(undefined);
+            const eventPointers = hidden.filter((pointer) => isEventPointer(pointer));
+            if (eventPointers.length === 0)
+                return of([]);
+            return combineLatest(eventPointers.map((pointer) => store.event(pointer))).pipe(map((arr) => arr.filter((e) => !!e)), castTimelineStream(Note, store));
+        })));
+    }
+    get hiddenArticles$() {
+        return this.$$ref("hiddenArticles$", (store) => this.hidden$.pipe(switchMap((hidden) => {
+            if (hidden === undefined)
+                return of(undefined);
+            const addressPointers = hidden.filter((pointer) => isAddressPointer(pointer));
+            if (addressPointers.length === 0)
+                return of([]);
+            return combineLatest(addressPointers.map((pointer) => store.replaceable(pointer))).pipe(map((arr) => arr.filter((e) => !!e)), castTimelineStream(Article, store));
+        })));
+    }
+    /** Whether the bookmark set has hidden bookmarks */
+    get hasHidden() {
+        return hasHiddenContent(this.event);
+    }
+    /** Whether the bookmark set is unlocked */
+    get unlocked() {
+        return isHiddenBookmarksUnlocked(this.event);
+    }
+    /** Unlocks the hidden bookmarks on the bookmark set */
+    async unlock(signer) {
+        return unlockHiddenBookmarks(this.event, signer);
+    }
+}
+/** A class for bookmarks lists (kind 10003) */
+export class BookmarksList extends BookmarksListBase {
+    constructor(event, store) {
+        if (!isValidBookmarkList(event))
+            throw new Error("Invalid bookmark list");
+        super(event, store);
+    }
+}
+/** A class for bookmarks sets (kind 30003) */
+export class BookmarksSet extends BookmarksListBase {
+    constructor(event, store) {
+        if (!isValidBookmarkSet(event))
+            throw new Error("Invalid bookmark set");
+        super(event, store);
+    }
+}

package/dist/casts/cast.d.ts

@@ -0,0 +1,30 @@
+import { EventModels, IEventStoreStreams, IEventSubscriptions } from "applesauce-core/event-store";
+import { NostrEvent } from "applesauce-core/helpers/event";
+import { Observable } from "rxjs";
+import { ChainableObservable } from "../observable/chainable.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 */
+export declare const CAST_REF_SYMBOL: unique symbol;
+/** A symbol used to store all the casts for an event */
+export declare const CASTS_SYMBOL: unique symbol;
+/** A class that can be used to cast a Nostr event */
+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(): import("./user.js").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

@@ -0,0 +1,67 @@
+import { getSeenRelays } from "applesauce-core/helpers";
+import { getEventUID, getParentEventStore } from "applesauce-core/helpers/event";
+import { chainable } from "../observable/chainable.js";
+import { castUser } from "./user.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 */
+export const CASTS_SYMBOL = Symbol.for("casts");
+/** Cast a Nostr event to a specific class */
+export function castEvent(event, cls, store) {
+    const casts = Reflect.get(event, CASTS_SYMBOL);
+    // If the event has already been cast to this class, return the existing cast
+    const existing = casts?.get(cls);
+    if (existing)
+        return existing;
+    if (!store) {
+        store = getParentEventStore(event);
+        if (!store)
+            throw new Error("Event is not attached to an event store, an event store must be provided");
+    }
+    // Create a new instance of the class
+    const cast = new cls(event, store);
+    if (!casts)
+        Reflect.set(event, CASTS_SYMBOL, new Map([[cls, cast]]));
+    else
+        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/comment.d.ts

@@ -0,0 +1,18 @@
+import { NostrEvent } from "applesauce-core/helpers/event";
+import { CommentEvent } from "../helpers/comment.js";
+import { CastRefEventStore, EventCast } from "./cast.js";
+import { Reaction } from "./reaction.js";
+import { Zap } from "./zap.js";
+/** Cast a kind 1111 event to a Comment */
+export declare class Comment extends EventCast<CommentEvent> {
+    constructor(event: NostrEvent, store: CastRefEventStore);
+    get rootPointer(): import("../helpers/comment.js").CommentPointer;
+    get replyPointer(): import("../helpers/comment.js").CommentPointer | null;
+    /** Get the event at the root of this thread */
+    get root$(): import("../observable/chainable.js").ChainableObservable<import("nostr-tools").Event | undefined>;
+    /** Get the event that this comment is replying to */
+    get parent$(): import("../observable/chainable.js").ChainableObservable<import("nostr-tools").Event | undefined>;
+    get zaps$(): import("../observable/chainable.js").ChainableObservable<Zap[]>;
+    get replies$(): import("../observable/chainable.js").ChainableObservable<Comment[]>;
+    get reactions$(): import("../observable/chainable.js").ChainableObservable<Reaction[]>;
+}

package/dist/casts/comment.js

@@ -0,0 +1,54 @@
+import { of } from "rxjs";
+import { getCommentReplyPointer, getCommentRootPointer, isValidComment } from "../helpers/comment.js";
+import { CommentsModel } from "../models/comments.js";
+import { ReactionsModel } from "../models/reactions.js";
+import { EventZapsModel } from "../models/zaps.js";
+import { castTimelineStream } from "../observable/cast-stream.js";
+import { EventCast } from "./cast.js";
+import { Reaction } from "./reaction.js";
+import { Zap } from "./zap.js";
+/** Cast a kind 1111 event to a Comment */
+export class Comment extends EventCast {
+    constructor(event, store) {
+        if (!isValidComment(event))
+            throw new Error("Invalid comment");
+        super(event, store);
+    }
+    get rootPointer() {
+        return getCommentRootPointer(this.event);
+    }
+    get replyPointer() {
+        return getCommentReplyPointer(this.event);
+    }
+    /** Get the event at the root of this thread */
+    get root$() {
+        return this.$$ref("root$", (store) => {
+            const pointer = this.rootPointer;
+            if (pointer.type === "event" || pointer.type === "address")
+                return store.event(pointer);
+            else
+                return of(undefined);
+        });
+    }
+    /** Get the event that this comment is replying to */
+    get parent$() {
+        return this.$$ref("parent$", (store) => {
+            const pointer = this.replyPointer;
+            if (!pointer)
+                return of(undefined);
+            else if (pointer.type === "event" || pointer.type === "address")
+                return store.event(pointer);
+            else
+                return of(undefined);
+        });
+    }
+    get zaps$() {
+        return this.$$ref("zaps$", (store) => store.model(EventZapsModel, this.event).pipe(castTimelineStream(Zap, store)));
+    }
+    get replies$() {
+        return this.$$ref("replies$", (store) => store.model(CommentsModel, this.event).pipe(castTimelineStream(Comment, store)));
+    }
+    get reactions$() {
+        return this.$$ref("reactions$", (store) => store.model(ReactionsModel, this.event).pipe(castTimelineStream(Reaction, store)));
+    }
+}

package/dist/casts/groups.d.ts

@@ -0,0 +1,19 @@
+import { HiddenContentSigner } from "applesauce-core/helpers";
+import { KnownEvent, NostrEvent } from "applesauce-core/helpers/event";
+import { GROUPS_LIST_KIND } from "../helpers/groups.js";
+import { CastRefEventStore, EventCast } from "./cast.js";
+export declare class GroupsList extends EventCast<KnownEvent<typeof GROUPS_LIST_KIND>> {
+    constructor(event: NostrEvent, store: CastRefEventStore);
+    /** The public groups in the list */
+    get groups(): import("../helpers/groups.js").GroupPointer[];
+    /** Get the unlocked hidden groups */
+    get hidden(): import("../helpers/groups.js").GroupPointer[] | undefined;
+    /** An observable that updates when hidden groups are unlocked */
+    get hidden$(): import("../observable/chainable.js").ChainableObservable<import("../helpers/groups.js").GroupPointer[] | undefined>;
+    /** Whether the groups list has hidden groups */
+    get hasHidden(): boolean;
+    /** Whether the groups list is unlocked */
+    get unlocked(): boolean;
+    /** Unlocks the hidden groups on the groups list */
+    unlock(signer: HiddenContentSigner): Promise<import("../helpers/groups.js").GroupPointer[]>;
+}