applesauce-core 0.0.0-next-20241207164640 → 0.0.0-next-20241210191750

package/dist/helpers/comment.d.ts

@@ -0,0 +1,48 @@
+import { NostrEvent } from "nostr-tools";
+import { ExternalPointer, ExternalIdentifiers } from "./external-id.js";
+export declare const COMMENT_KIND = 1111;
+type CommentEventPointer = {
+    id: string;
+    kind: number;
+    pubkey?: string;
+    relay?: string;
+};
+type CommentAddressPointer = {
+    id?: string;
+    kind: number;
+    pubkey: string;
+    identifier: string;
+    relay?: string;
+};
+type CommentExternalPointer = ExternalPointer<keyof ExternalIdentifiers>;
+export type CommentPointer = CommentEventPointer | CommentAddressPointer | CommentExternalPointer;
+export declare const CommentRootPointerSymbol: unique symbol;
+export declare const CommentReplyPointerSymbol: unique symbol;
+/**
+ * Gets the EventPointer from an array of tags
+ * @throws
+ */
+export declare function getCommentEventPointer(tags: string[][], root?: boolean): CommentEventPointer | null;
+/**
+ * Gets the AddressPointer from an array of tags
+ * @throws
+ */
+export declare function getCommentAddressPointer(tags: string[][], root?: boolean): CommentAddressPointer | null;
+/**
+ * Gets the ExternalPointer from an array of tags
+ * @throws
+ */
+export declare function getCommentExternalPointer(tags: string[][], root?: boolean): CommentExternalPointer | null;
+/**
+ * Returns the root pointer for a comment
+ * @throws
+ */
+export declare function getCommentRootPointer(comment: NostrEvent): CommentPointer | null;
+/**
+ * Returns the reply pointer for a comment
+ * @throws
+ */
+export declare function getCommentReplyPointer(comment: NostrEvent): CommentPointer | null;
+export declare function isCommentEventPointer(pointer: any): pointer is CommentEventPointer;
+export declare function isCommentAddressPointer(pointer: any): pointer is CommentAddressPointer;
+export {};

package/dist/helpers/comment.js

@@ -0,0 +1,115 @@
+import { getExternalPointerFromTag } from "./external-id.js";
+import { getOrComputeCachedValue } from "./cache.js";
+import { getAddressPointerFromTag, getEventPointerFromTag } from "./pointers.js";
+export const COMMENT_KIND = 1111;
+export const CommentRootPointerSymbol = Symbol.for("comment-root-pointer");
+export const CommentReplyPointerSymbol = Symbol.for("comment-reply-pointer");
+/**
+ * Gets the EventPointer from an array of tags
+ * @throws
+ */
+export function getCommentEventPointer(tags, root = false) {
+    const tag = tags.find((t) => t[0] === (root ? "E" : "e"));
+    const kind = tags.find((t) => t[0] === (root ? "K" : "k"))?.[1];
+    if (tag) {
+        if (!kind)
+            throw new Error("Missing kind tag");
+        const eventPointer = getEventPointerFromTag(tag);
+        return {
+            id: eventPointer.id,
+            kind: parseInt(kind),
+            pubkey: eventPointer.author,
+            relay: eventPointer.relays?.[0],
+        };
+    }
+    return null;
+}
+/**
+ * Gets the AddressPointer from an array of tags
+ * @throws
+ */
+export function getCommentAddressPointer(tags, root = false) {
+    const tag = tags.find((t) => t[0] === (root ? "A" : "a"));
+    const id = tags.find((t) => t[0] === (root ? "E" : "e"))?.[1];
+    const kind = tags.find((t) => t[0] === (root ? "K" : "k"))?.[1];
+    if (tag) {
+        if (!kind)
+            throw new Error("Missing kind tag");
+        const pointer = {
+            id,
+            ...getAddressPointerFromTag(tag),
+            kind: parseInt(kind),
+        };
+        return pointer;
+    }
+    return null;
+}
+/**
+ * Gets the ExternalPointer from an array of tags
+ * @throws
+ */
+export function getCommentExternalPointer(tags, root = false) {
+    const tag = tags.find((t) => t[0] === (root ? "I" : "i"));
+    const kind = tags.find((t) => t[0] === (root ? "K" : "k"))?.[1];
+    if (tag) {
+        if (!kind)
+            throw new Error("Missing kind tag");
+        const pointer = getExternalPointerFromTag(tag);
+        return pointer;
+    }
+    return null;
+}
+/**
+ * Returns the root pointer for a comment
+ * @throws
+ */
+export function getCommentRootPointer(comment) {
+    if (comment.kind !== COMMENT_KIND)
+        throw new Error("Event is not a comment");
+    return getOrComputeCachedValue(comment, CommentRootPointerSymbol, () => {
+        // check for address pointer first since it can also have E tags
+        const A = getCommentAddressPointer(comment.tags, true);
+        if (A)
+            return A;
+        const E = getCommentEventPointer(comment.tags, true);
+        if (E)
+            return E;
+        const I = getCommentExternalPointer(comment.tags, true);
+        if (I)
+            return I;
+        return null;
+    });
+}
+/**
+ * Returns the reply pointer for a comment
+ * @throws
+ */
+export function getCommentReplyPointer(comment) {
+    if (comment.kind !== COMMENT_KIND)
+        throw new Error("Event is not a comment");
+    return getOrComputeCachedValue(comment, CommentReplyPointerSymbol, () => {
+        // check for address pointer first since it can also have E tags
+        const A = getCommentAddressPointer(comment.tags, false);
+        if (A)
+            return A;
+        const E = getCommentEventPointer(comment.tags, false);
+        if (E)
+            return E;
+        const I = getCommentExternalPointer(comment.tags, false);
+        if (I)
+            return I;
+        return null;
+    });
+}
+export function isCommentEventPointer(pointer) {
+    return (Reflect.has(pointer, "id") &&
+        Reflect.has(pointer, "kind") &&
+        !Reflect.has(pointer, "identifier") &&
+        typeof pointer.kind === "number");
+}
+export function isCommentAddressPointer(pointer) {
+    return (Reflect.has(pointer, "identifier") &&
+        Reflect.has(pointer, "pubkey") &&
+        Reflect.has(pointer, "kind") &&
+        typeof pointer.kind === "number");
+}

package/dist/helpers/emoji.d.ts

@@ -3,8 +3,9 @@ import { EventTemplate, NostrEvent } from "nostr-tools";
 export declare function getEmojiTag(event: NostrEvent | EventTemplate, code: string): ["emoji", string, string] | undefined;
 /** Returns the name of a NIP-30 emoji pack */
 export declare function getPackName(pack: NostrEvent): string | undefined;
-/** Returns an array of emojis from a NIP-30 emoji pack */
-export declare function getEmojis(pack: NostrEvent): {
+export type Emoji = {
     name: string;
     url: string;
-}[];
+};
+/** Returns an array of emojis from a NIP-30 emoji pack */
+export declare function getEmojis(pack: NostrEvent): Emoji[];

package/dist/helpers/external-id.d.ts

@@ -0,0 +1,29 @@
+export type ExternalIdentifiers = {
+    "#": `#${string}`;
+    geo: `geo:${string}`;
+    isbn: `isbn:${string}`;
+    "podcast:guid": `podcast:guid:${string}`;
+    "podcast:item:guid": `podcast:item:guid:${string}`;
+    "podcast:publisher:guid": `podcast:publisher:guid:${string}`;
+    isan: `isan:${string}`;
+    doi: `doi:${string}`;
+};
+export type ExternalPointer<Prefix extends keyof ExternalIdentifiers> = {
+    kind: Prefix;
+    identifier: ExternalIdentifiers[Prefix];
+};
+export type ParseResult = {
+    [P in keyof ExternalIdentifiers]: ExternalPointer<P>;
+}[keyof ExternalIdentifiers];
+/**
+ * Parses a NIP-73 external identifier
+ * @throws
+ */
+export declare function parseExternalPointer<Prefix extends keyof ExternalIdentifiers>(identifier: `${Prefix}1${string}`): ExternalPointer<Prefix>;
+export declare function parseExternalPointer(identifier: string): ParseResult;
+/**
+ * Gets an ExternalPointer for a "i" tag
+ * @throws
+ */
+export declare function getExternalPointerFromTag<Prefix extends keyof ExternalIdentifiers>(tag: string[]): ExternalPointer<Prefix>;
+export declare function getExternalPointerFromTag(tag: string[]): ParseResult;

package/dist/helpers/external-id.js

@@ -0,0 +1,20 @@
+export function parseExternalPointer(identifier) {
+    if (identifier.startsWith("#"))
+        return { kind: "#", identifier: identifier };
+    if (identifier.startsWith("geo:"))
+        return { kind: "geo", identifier: identifier };
+    if (identifier.startsWith("podcast:guid:"))
+        return { kind: "podcast:guid", identifier: identifier };
+    if (identifier.startsWith("podcast:item:guid:"))
+        return { kind: "podcast:item:guid", identifier: identifier };
+    if (identifier.startsWith("podcast:publisher:guid:"))
+        return { kind: "podcast:publisher:guid", identifier: identifier };
+    if (identifier.startsWith("isan:"))
+        return { kind: "isan", identifier: identifier };
+    if (identifier.startsWith("doi:"))
+        return { kind: "doi", identifier: identifier };
+    throw new Error("Failed to parse external identifier");
+}
+export function getExternalPointerFromTag(tag) {
+    return parseExternalPointer(tag[1]);
+}

package/dist/helpers/index.d.ts

@@ -1,19 +1,23 @@
-export * from "./profile.js";
-export * from "./relays.js";
+export * from "./bolt11.js";
+export * from "./cache.js";
+export * from "./comment.js";
+export * from "./delete.js";
+export * from "./emoji.js";
 export * from "./event.js";
+export * from "./external-id.js";
 export * from "./filter.js";
+export * from "./hashtag.js";
+export * from "./hidden-tags.js";
+export * from "./lnurl.js";
+export * from "./lru.js";
 export * from "./mailboxes.js";
-export * from "./threading.js";
+export * from "./media-attachment.js";
 export * from "./pointers.js";
+export * from "./profile.js";
+export * from "./relays.js";
 export * from "./string.js";
-export * from "./time.js";
 export * from "./tags.js";
-export * from "./emoji.js";
-export * from "./lru.js";
-export * from "./hashtag.js";
+export * from "./threading.js";
+export * from "./time.js";
 export * from "./url.js";
 export * from "./zap.js";
-export * from "./hidden-tags.js";
-export * from "./bolt11.js";
-export * from "./lnurl.js";
-export * from "./delete.js";

package/dist/helpers/index.js

@@ -1,19 +1,23 @@
-export * from "./profile.js";
-export * from "./relays.js";
+export * from "./bolt11.js";
+export * from "./cache.js";
+export * from "./comment.js";
+export * from "./delete.js";
+export * from "./emoji.js";
 export * from "./event.js";
+export * from "./external-id.js";
 export * from "./filter.js";
+export * from "./hashtag.js";
+export * from "./hidden-tags.js";
+export * from "./lnurl.js";
+export * from "./lru.js";
 export * from "./mailboxes.js";
-export * from "./threading.js";
+export * from "./media-attachment.js";
 export * from "./pointers.js";
+export * from "./profile.js";
+export * from "./relays.js";
 export * from "./string.js";
-export * from "./time.js";
 export * from "./tags.js";
-export * from "./emoji.js";
-export * from "./lru.js";
-export * from "./hashtag.js";
+export * from "./threading.js";
+export * from "./time.js";
 export * from "./url.js";
 export * from "./zap.js";
-export * from "./hidden-tags.js";
-export * from "./bolt11.js";
-export * from "./lnurl.js";
-export * from "./delete.js";

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

@@ -0,0 +1,33 @@
+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

@@ -0,0 +1,60 @@
+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);
+    });
+}

package/dist/helpers/pointers.js

@@ -72,9 +72,10 @@ export function getEventPointerFromTag(tag) {
     let pointer = { id: tag[1] };
     if (tag[2])
         pointer.relays = safeRelayUrls([tag[2]]);
-    // get author from NIP-18 quote tags
-    if (tag[0] === "q" && tag[3] && tag[3].length === 64)
+    // get author from NIP-18 quote tags and nip-22 comments
+    if ((tag[0] === "q" || tag[0] === "e" || tag[0] === "E") && tag[3] && tag[3].length === 64) {
         pointer.author = tag[3];
+    }
     return pointer;
 }
 /** @throws */

package/dist/queries/comment.d.ts

@@ -0,0 +1,4 @@
+import { NostrEvent } from "nostr-tools";
+import { Query } from "../query-store/index.js";
+/** Returns all NIP-22 comment replies for the event */
+export declare function CommentsQuery(parent: NostrEvent): Query<NostrEvent[]>;

package/dist/queries/comment.js

@@ -0,0 +1,14 @@
+import { COMMENT_KIND, getEventUID } from "../helpers/index.js";
+import { isParameterizedReplaceableKind } from "nostr-tools/kinds";
+/** Returns all NIP-22 comment replies for the event */
+export function CommentsQuery(parent) {
+    return {
+        key: `${getEventUID(parent)}-comments`,
+        run: (events) => {
+            const filter = { kinds: [COMMENT_KIND], "#e": [parent.id] };
+            if (isParameterizedReplaceableKind(parent.kind))
+                filter["#a"] = [getEventUID(parent)];
+            return events.timeline(filter);
+        },
+    };
+}

package/dist/queries/comments.d.ts

@@ -0,0 +1,4 @@
+import { NostrEvent } from "nostr-tools";
+import { Query } from "../query-store/index.js";
+/** Returns all NIP-22 comment replies for the event */
+export declare function CommentsQuery(parent: NostrEvent): Query<NostrEvent[]>;

package/dist/queries/comments.js

@@ -0,0 +1,14 @@
+import { COMMENT_KIND, getEventUID } from "../helpers/index.js";
+import { isParameterizedReplaceableKind } from "nostr-tools/kinds";
+/** Returns all NIP-22 comment replies for the event */
+export function CommentsQuery(parent) {
+    return {
+        key: `${getEventUID(parent)}-comments`,
+        run: (events) => {
+            const filter = { kinds: [COMMENT_KIND], "#e": [parent.id] };
+            if (isParameterizedReplaceableKind(parent.kind))
+                filter["#a"] = [getEventUID(parent)];
+            return events.timeline(filter);
+        },
+    };
+}

package/dist/queries/index.d.ts

@@ -1,6 +1,7 @@
-export * from "./simple.js";
-export * from "./profile.js";
+export * from "./comments.js";
 export * from "./mailboxes.js";
+export * from "./profile.js";
 export * from "./reactions.js";
+export * from "./simple.js";
 export * from "./thread.js";
 export * from "./zaps.js";

package/dist/queries/index.js

@@ -1,6 +1,7 @@
-export * from "./simple.js";
-export * from "./profile.js";
+export * from "./comments.js";
 export * from "./mailboxes.js";
+export * from "./profile.js";
 export * from "./reactions.js";
+export * from "./simple.js";
 export * from "./thread.js";
 export * from "./zaps.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "applesauce-core",
-  "version": "0.0.0-next-20241207164640",
+  "version": "0.0.0-next-20241210191750",
   "description": "",
   "type": "module",
   "main": "dist/index.js",