applesauce-core 0.0.0-next-20250808173123 → 0.0.0-next-20250820215033

package/dist/helpers/encrypted-content.d.ts

@@ -25,6 +25,8 @@ export declare function setEncryptedContentEncryptionMethod(kind: number, method
  * @param kind The event kind to get the encryption method for
  * @param signer The signer to use to get the encryption methods
  * @param override The encryption method to use instead of the default
+ * @throws If the event kind does not support encrypted content
+ * @throws If the signer does not support the encryption method
  * @returns The encryption methods for the event kind
  */
 export declare function getEncryptedContentEncryptionMethods(kind: number, signer: EncryptedContentSigner, override?: EncryptionMethod): EncryptionMethods;

package/dist/helpers/encrypted-content.js

@@ -18,6 +18,8 @@ export function setEncryptedContentEncryptionMethod(kind, method) {
  * @param kind The event kind to get the encryption method for
  * @param signer The signer to use to get the encryption methods
  * @param override The encryption method to use instead of the default
+ * @throws If the event kind does not support encrypted content
+ * @throws If the signer does not support the encryption method
  * @returns The encryption methods for the event kind
  */
 export function getEncryptedContentEncryptionMethods(kind, signer, override) {

package/dist/helpers/event.d.ts

@@ -39,10 +39,7 @@ export declare function isFromCache(event: NostrEvent): boolean;
 export declare function getParentEventStore<T extends object>(event: T): IEventStore | undefined;
 /** Notifies the events parent store that an event has been updated */
 export declare function notifyEventUpdate(event: NostrEvent): void;
-/**
- * Returns the replaceable identifier for a replaceable event
- * @throws {Error} if the event is not addressable or missing the "d" tag
- */
+/** Returns the replaceable identifier for a replaceable event */
 export declare function getReplaceableIdentifier(event: NostrEvent): string;
 /** Checks if an event is a NIP-70 protected event */
 export declare function isProtectedEvent(event: NostrEvent): boolean;

package/dist/helpers/event.js

@@ -85,18 +85,10 @@ export function notifyEventUpdate(event) {
     if (eventStore)
         eventStore.update(event);
 }
-/**
- * Returns the replaceable identifier for a replaceable event
- * @throws {Error} if the event is not addressable or missing the "d" tag
- */
+/** Returns the replaceable identifier for a replaceable event */
 export function getReplaceableIdentifier(event) {
-    if (!isAddressableKind(event.kind))
-        throw new Error("Event is not addressable");
     return getOrComputeCachedValue(event, ReplaceableIdentifierSymbol, () => {
-        const d = event.tags.find((t) => t[0] === "d")?.[1];
-        if (d === undefined)
-            throw new Error("Event missing identifier");
-        return d;
+        return event.tags.find((t) => t[0] === "d")?.[1] ?? "";
     });
 }
 /** Checks if an event is a NIP-70 protected event */

package/dist/helpers/highlight.d.ts

@@ -0,0 +1,45 @@
+import { NostrEvent } from "nostr-tools";
+import { AddressPointer, EventPointer, ProfilePointer } from "nostr-tools/nip19";
+export declare const HighlightSourceEventPointerSymbol: unique symbol;
+export declare const HighlightSourceAddressPointerSymbol: unique symbol;
+export declare const HighlightAttributionSymbol: unique symbol;
+/**
+ * Get the highlighted content from a highlight event
+ * Returns the content field which contains the highlighted text
+ */
+export declare function getHighlightText(event: NostrEvent): string;
+/**
+ * Get the source event pointer that was highlighted (from 'e' tag)
+ * Returns undefined if no event reference is found
+ */
+export declare function getHighlightSourceEventPointer(event: NostrEvent): EventPointer | undefined;
+/**
+ * Get the source address pointer that was highlighted (from 'a' tag)
+ * Returns undefined if no address reference is found
+ */
+export declare function getHighlightSourceAddressPointer(event: NostrEvent): AddressPointer | undefined;
+/** Get the source URL that was highlighted (from 'r' tag) */
+export declare function getHighlightSourceUrl(event: NostrEvent): string | undefined;
+/** Role of an attributed profiles in a highlight */
+export type HighlightAttributionRole = "author" | "editor" | "mention" | string;
+/** Attribution information for a highlight */
+export type HighlightAttribution = ProfilePointer & {
+    /** Role of the attributed profile */
+    role?: HighlightAttributionRole;
+};
+/**
+ * Get attribution information from p tags
+ * Parses p tags to extract authors, editors, and other attributed individuals
+ */
+export declare function getHighlightAttributions(event: NostrEvent): HighlightAttribution[];
+/**
+ * Get the context text for a highlight (from 'context' tag)
+ * This provides surrounding content to give context to the highlight
+ */
+export declare function getHighlightContext(event: NostrEvent): string | undefined;
+/** Get the comment for a highlight (from 'comment' tag) */
+export declare function getHighlightComment(event: NostrEvent): string | undefined;
+/**
+ * Check if the highlight has any source reference (event, address, or URL)
+ */
+export declare function hasHighlightSource(event: NostrEvent): boolean;

package/dist/helpers/highlight.js

@@ -0,0 +1,76 @@
+import { getOrComputeCachedValue } from "./cache.js";
+import { getTagValue } from "./event-tags.js";
+import { getAddressPointerFromATag, getEventPointerFromETag, getProfilePointerFromPTag } from "./pointers.js";
+import { isATag, isETag, isPTag } from "./tags.js";
+// Symbol constants for caching
+export const HighlightSourceEventPointerSymbol = Symbol.for("highlight-source-event-pointer");
+export const HighlightSourceAddressPointerSymbol = Symbol.for("highlight-source-address-pointer");
+export const HighlightAttributionSymbol = Symbol.for("highlight-attribution");
+/**
+ * Get the highlighted content from a highlight event
+ * Returns the content field which contains the highlighted text
+ */
+export function getHighlightText(event) {
+    return event.content;
+}
+/**
+ * Get the source event pointer that was highlighted (from 'e' tag)
+ * Returns undefined if no event reference is found
+ */
+export function getHighlightSourceEventPointer(event) {
+    return getOrComputeCachedValue(event, HighlightSourceEventPointerSymbol, () => {
+        const eTag = event.tags.find(isETag);
+        return eTag ? getEventPointerFromETag(eTag) : undefined;
+    });
+}
+/**
+ * Get the source address pointer that was highlighted (from 'a' tag)
+ * Returns undefined if no address reference is found
+ */
+export function getHighlightSourceAddressPointer(event) {
+    return getOrComputeCachedValue(event, HighlightSourceAddressPointerSymbol, () => {
+        const aTag = event.tags.find(isATag);
+        return aTag ? getAddressPointerFromATag(aTag) : undefined;
+    });
+}
+/** Get the source URL that was highlighted (from 'r' tag) */
+export function getHighlightSourceUrl(event) {
+    return getTagValue(event, "r");
+}
+/**
+ * Get attribution information from p tags
+ * Parses p tags to extract authors, editors, and other attributed individuals
+ */
+export function getHighlightAttributions(event) {
+    return getOrComputeCachedValue(event, HighlightAttributionSymbol, () => {
+        const attributions = [];
+        const pTags = event.tags.filter(isPTag);
+        for (const pTag of pTags) {
+            const pointer = getProfilePointerFromPTag(pTag);
+            const role = pTag[3] || "other"; // Role is the 4th element (index 3)
+            const entry = { ...pointer, role };
+            // Categorize by role
+            attributions.push(entry);
+        }
+        return attributions;
+    });
+}
+/**
+ * Get the context text for a highlight (from 'context' tag)
+ * This provides surrounding content to give context to the highlight
+ */
+export function getHighlightContext(event) {
+    return getTagValue(event, "context");
+}
+/** Get the comment for a highlight (from 'comment' tag) */
+export function getHighlightComment(event) {
+    return getTagValue(event, "comment");
+}
+/**
+ * Check if the highlight has any source reference (event, address, or URL)
+ */
+export function hasHighlightSource(event) {
+    return !!(getHighlightSourceEventPointer(event) ||
+        getHighlightSourceAddressPointer(event) ||
+        getHighlightSourceUrl(event));
+}

package/dist/helpers/index.d.ts

@@ -29,6 +29,7 @@ export * from "./groups.js";
 export * from "./hashtag.js";
 export * from "./hidden-content.js";
 export * from "./hidden-tags.js";
+export * from "./highlight.js";
 export * from "./json.js";
 export * from "./legacy-messages.js";
 export * from "./lists.js";
@@ -39,6 +40,7 @@ export * from "./messages.js";
 export * from "./mutes.js";
 export * from "./picture-post.js";
 export * from "./pointers.js";
+export * from "./poll.js";
 export * from "./profile.js";
 export * from "./reactions.js";
 export * from "./relays.js";

package/dist/helpers/index.js

@@ -29,6 +29,7 @@ export * from "./groups.js";
 export * from "./hashtag.js";
 export * from "./hidden-content.js";
 export * from "./hidden-tags.js";
+export * from "./highlight.js";
 export * from "./json.js";
 export * from "./legacy-messages.js";
 export * from "./lists.js";
@@ -39,6 +40,7 @@ export * from "./messages.js";
 export * from "./mutes.js";
 export * from "./picture-post.js";
 export * from "./pointers.js";
+export * from "./poll.js";
 export * from "./profile.js";
 export * from "./reactions.js";
 export * from "./relays.js";

package/dist/helpers/poll.d.ts

@@ -0,0 +1,46 @@
+import { NostrEvent } from "nostr-tools";
+export declare const POLL_KIND = 1068;
+export declare const POLL_RESPONSE_KIND = 1018;
+export declare const PollOptionsSymbol: unique symbol;
+export interface PollOption {
+    id: string;
+    label: string;
+}
+export type PollType = "singlechoice" | "multiplechoice";
+/**
+ * Get the poll question/label from a poll event
+ * Returns the content field which contains the poll question
+ */
+export declare function getPollQuestion(event: NostrEvent): string;
+/**
+ * Get the poll options from a poll event
+ * Returns array of options with id and label
+ */
+export declare function getPollOptions(event: NostrEvent): PollOption[];
+/**
+ * Get the relays specified for poll responses (from 'relay' tags)
+ * Returns undefined if no relays are specified
+ */
+export declare function getPollRelays(event: NostrEvent): string[];
+/**
+ * Get the poll type from a poll event (from 'polltype' tag)
+ * Returns "singlechoice" or "multiplechoice", defaults to "singlechoice"
+ */
+export declare function getPollType(event: NostrEvent): PollType;
+/**
+ * Get the poll expiration timestamp (from 'endsAt' tag)
+ * Returns undefined if no expiration is set
+ */
+export declare function getPollEndsAt(event: NostrEvent): number | undefined;
+/**
+ * Get the poll ID that a response is referencing (from 'e' tag)
+ * Returns undefined if no poll reference is found
+ */
+export declare function getPollResponsePollId(event: NostrEvent): string | undefined;
+/** Get the selected option IDs from a poll response event (from 'response' tags) */
+export declare function getPollResponseOptions(event: NostrEvent): string[];
+/**
+ * Gets the options that a user has voted for in a poll event
+ * Returns undefined if the response is not valid
+ */
+export declare function getPollResponseVotes(poll: NostrEvent, response: NostrEvent): string[] | undefined;

package/dist/helpers/poll.js

@@ -0,0 +1,78 @@
+import { getOrComputeCachedValue } from "./cache.js";
+import { getTagValue } from "./event-tags.js";
+// NIP-88 Poll kinds
+export const POLL_KIND = 1068;
+export const POLL_RESPONSE_KIND = 1018;
+// Cache symbols
+export const PollOptionsSymbol = Symbol.for("poll-options");
+/**
+ * Get the poll question/label from a poll event
+ * Returns the content field which contains the poll question
+ */
+export function getPollQuestion(event) {
+    return event.content;
+}
+/**
+ * Get the poll options from a poll event
+ * Returns array of options with id and label
+ */
+export function getPollOptions(event) {
+    return getOrComputeCachedValue(event, PollOptionsSymbol, () => {
+        return event.tags
+            .filter((tag) => tag[0] === "option" && tag.length >= 3)
+            .map((tag) => ({
+            id: tag[1],
+            label: tag[2],
+        }));
+    });
+}
+/**
+ * Get the relays specified for poll responses (from 'relay' tags)
+ * Returns undefined if no relays are specified
+ */
+export function getPollRelays(event) {
+    return event.tags.filter((tag) => tag[0] === "relay" && tag.length >= 2).map((tag) => tag[1]);
+}
+/**
+ * Get the poll type from a poll event (from 'polltype' tag)
+ * Returns "singlechoice" or "multiplechoice", defaults to "singlechoice"
+ */
+export function getPollType(event) {
+    const type = getTagValue(event, "polltype");
+    return type === "multiplechoice" || type === "singlechoice" ? type : "singlechoice";
+}
+/**
+ * Get the poll expiration timestamp (from 'endsAt' tag)
+ * Returns undefined if no expiration is set
+ */
+export function getPollEndsAt(event) {
+    const endsAt = getTagValue(event, "endsAt");
+    return endsAt ? parseInt(endsAt, 10) : undefined;
+}
+/**
+ * Get the poll ID that a response is referencing (from 'e' tag)
+ * Returns undefined if no poll reference is found
+ */
+export function getPollResponsePollId(event) {
+    return getTagValue(event, "e");
+}
+/** Get the selected option IDs from a poll response event (from 'response' tags) */
+export function getPollResponseOptions(event) {
+    return event.tags.filter((tag) => tag[0] === "response" && tag.length >= 2).map((tag) => tag[1]);
+}
+/**
+ * Gets the options that a user has voted for in a poll event
+ * Returns undefined if the response is not valid
+ */
+export function getPollResponseVotes(poll, response) {
+    if (poll.id !== getPollResponsePollId(response))
+        return;
+    const pollOptions = getPollOptions(poll);
+    const responseOptions = getPollResponseOptions(response);
+    const votes = responseOptions.filter((opts) => pollOptions.some((option) => option.id === opts));
+    const type = getPollType(poll);
+    // If its a single choice poll, return the first vote
+    if (type === "singlechoice")
+        return votes.length === 1 ? [votes[0]] : undefined;
+    return Array.from(new Set(votes));
+}

package/package.json

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