applesauce-core 5.1.0 → 5.2.0

package/dist/event-factory/types.d.ts

@@ -38,6 +38,8 @@ export type Emoji = {
     shortcode: string;
     /** The URL to the emoji image */
     url: string;
+    /** The NIP-01 "a" tag address of the emoji pack this emoji belongs to */
+    address?: AddressPointer;
 };
 export interface EmojiContext {
     /** An array of custom emojis that will be used for text notes */

package/dist/helpers/pointers.d.ts

@@ -4,42 +4,42 @@ export { decode as decodePointer, naddrEncode, neventEncode, noteEncode, nprofil
 export type { NAddr, NEvent, NProfile, NPub } from "nostr-tools/nip19";
 import { NostrEvent } from "./event.js";
 export type DecodeResult = DecodedResult;
-/** Decodes any nip-19 encoded entity to a ProfilePointer */
+/** Decodes any NIP-19 encoded string into a ProfilePointer. Returns null if the string cannot be decoded. */
 export declare function decodeProfilePointer(str: string): ProfilePointer | null;
-/** Decodes an naddr encoded string to an AddressPointer */
+/** Decodes an encoded NIP-19 naddr string to an AddressPointer. Returns null if the string cannot be decoded. */
 export declare function decodeAddressPointer(str: string): AddressPointer | null;
-/** Decodes a note1 or nevent encoded string to an EventPointer */
+/** Decodes an encoded NIP-19 note1 or nevent string to an EventPointer. Returns null if the string cannot be decoded. */
 export declare function decodeEventPointer(str: string): EventPointer | null;
 export type AddressPointerWithoutD = Omit<AddressPointer, "identifier"> & {
     identifier?: string;
 };
-/** Parse the value of an "a" tag into an AddressPointer */
+/** Parses the value of an "a" tag into an AddressPointer. Returns null if the address cannot be parsed. */
 export declare function parseReplaceableAddress(address: string, requireIdentifier?: boolean): AddressPointer | null;
-/** Extra a pubkey from the result of nip19.decode */
+/** Extracts a pubkey from the result of nip19.decode  Returns undefined if the decode result does not have a pubkey */
 export declare function getPubkeyFromDecodeResult(result?: DecodeResult): string | undefined;
-/** Gets the relays from a decode result */
+/** Extracts the relays from a decode result */
 export declare function getRelaysFromDecodeResult(result?: DecodeResult): string[] | undefined;
-/** Encodes the result of nip19.decode */
+/** Encodes the result of nip19.decode to a NIP-19 string. Returns an empty string if the result cannot be encoded. */
 export declare function encodeDecodeResult(result: DecodeResult): "" | `nevent1${string}` | `nprofile1${string}` | `naddr1${string}` | `nsec1${string}` | `npub1${string}` | `note1${string}`;
-/** Encodes a pointer to a NIP-19 string */
+/** Encodes a pointer to a NIP-19 string. Returns an empty string if the pointer cannot be encoded. */
 export declare function encodePointer(pointer: AddressPointer | EventPointer | ProfilePointer): string;
-/** Gets an EventPointer form a common "e" tag */
+/** Parses a common "e" tag into an EventPointer. Returns null if the tag cannot be parsed. */
 export declare function getEventPointerFromETag(tag: string[]): EventPointer | null;
-/** Gets an EventPointer form a common "q" tag */
+/** Parses a common "q" tag into an EventPointer. Returns null if the tag cannot be parsed. */
 export declare function getEventPointerFromQTag(tag: string[]): EventPointer | null;
-/** Get an AddressPointer from a common "a" tag */
+/** Parses a common "a" tag into an AddressPointer. Returns null if the tag cannot be parsed. */
 export declare function getAddressPointerFromATag(tag: string[]): AddressPointer | null;
-/** Gets a ProfilePointer from a common "p" tag */
+/** Parses a common "p" tag into a ProfilePointer. Returns null if the tag cannot be parsed. */
 export declare function getProfilePointerFromPTag(tag: string[]): ProfilePointer | null;
-/** Checks if a pointer is an AddressPointer */
+/** Checks if a pointer object is an AddressPointer */
 export declare function isAddressPointer(pointer: any): pointer is AddressPointer;
-/** Checks if a pointer is a ProfilePointer */
+/** Checks if a pointer object is a ProfilePointer */
 export declare function isProfilePointer(pointer: any): pointer is ProfilePointer;
-/** Checks if a pointer is an EventPointer */
+/** Checks if a pointer object is an EventPointer */
 export declare function isEventPointer(pointer: any): pointer is EventPointer;
-/** Returns the stringified address pointer */
+/** Returns the stringified NIP-19 encoded naddr address pointer for an AddressPointer. */
 export declare function getReplaceableAddressFromPointer(pointer: AddressPointer): string;
-/** Returns an AddressPointer for a replaceable event */
+/** 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 */
 export declare function getEventPointerForEvent(event: NostrEvent, relays?: string[]): EventPointer;
@@ -49,17 +49,17 @@ export declare function getPointerForEvent(event: NostrEvent, relays?: string[])
 export declare function addRelayHintsToPointer<T extends {
     relays?: string[];
 }>(pointer: T, relays?: Iterable<string>): T;
-/** Gets the hex pubkey from any nip-19 encoded string */
+/** Parses any nip-19 encoded string into a hex pubkey. Returns null if the string is not a valid pubkey. */
 export declare function normalizeToPubkey(str: NPub): string;
 export declare function normalizeToPubkey(str: string): string | null;
-/** Gets a ProfilePointer from any nip-19 encoded string */
+/** Parses any nip-19 encoded string into a ProfilePointer. Returns null if the string cannot be parsed. */
 export declare function normalizeToProfilePointer(str: NProfile): ProfilePointer;
 export declare function normalizeToProfilePointer(str: NPub): ProfilePointer;
 export declare function normalizeToProfilePointer(str: string): ProfilePointer | null;
-/** Gets an AddressPointer from any nip-19 encoded string */
+/** Parses any nip-19 encoded string into an AddressPointer. Returns null if the string cannot be parsed. */
 export declare function normalizeToAddressPointer(str: NAddr): AddressPointer;
 export declare function normalizeToAddressPointer(str: string): AddressPointer | null;
-/** Gets an EventPointer from any nip-19 encoded string */
+/** Parses any nip-19 encoded string into an EventPointer. Returns null if the string cannot be parsed. */
 export declare function normalizeToEventPointer(str: NEvent): EventPointer;
 export declare function normalizeToEventPointer(str: string): EventPointer | null;
 /** Returns all NIP-19 pointers in a content string */
@@ -79,5 +79,9 @@ export declare function mergeAddressPointers(a: AddressPointer, b: AddressPointe
  * @throws if the pubkeys are different
  */
 export declare function mergeProfilePointers(a: ProfilePointer, b: ProfilePointer): ProfilePointer;
+/** Checks if two address pointers refer to the same addressable event. Ignores relays. */
+export declare function isAddressPointerSame(a: AddressPointer, b: AddressPointer): boolean;
+/** Checks if two event pointers refer to the same event. Ignores relays. */
+export declare function isEventPointerSame(a: EventPointer, b: EventPointer): boolean;
 /** Checks if an event matches a pointer */
 export declare function eventMatchesPointer(event: NostrEvent, pointer: EventPointer | AddressPointer | AddressPointerWithoutD): boolean;

package/dist/helpers/pointers.js

@@ -7,7 +7,7 @@ import { Tokens } from "./regexp.js";
 import { isSafeRelayURL, relaySet } from "./relays.js";
 import { isHexKey } from "./string.js";
 import { normalizeURL } from "./url.js";
-/** Decodes a string and handles errors */
+/** Decodes a string and handles errors. Returns null if the string cannot be decoded. */
 function safeDecode(str) {
     try {
         return decode(str);
@@ -16,7 +16,7 @@ function safeDecode(str) {
         return null;
     }
 }
-/** Decodes any nip-19 encoded entity to a ProfilePointer */
+/** Decodes any NIP-19 encoded string into a ProfilePointer. Returns null if the string cannot be decoded. */
 export function decodeProfilePointer(str) {
     const result = safeDecode(str);
     if (!result)
@@ -29,14 +29,14 @@ export function decodeProfilePointer(str) {
         relays: getRelaysFromDecodeResult(result),
     };
 }
-/** Decodes an naddr encoded string to an AddressPointer */
+/** Decodes an encoded NIP-19 naddr string to an AddressPointer. Returns null if the string cannot be decoded. */
 export function decodeAddressPointer(str) {
     const result = safeDecode(str);
     if (!result)
         return null;
     return result.type === "naddr" ? result.data : null;
 }
-/** Decodes a note1 or nevent encoded string to an EventPointer */
+/** Decodes an encoded NIP-19 note1 or nevent string to an EventPointer. Returns null if the string cannot be decoded. */
 export function decodeEventPointer(str) {
     const result = safeDecode(str);
     if (!result)
@@ -50,7 +50,7 @@ export function decodeEventPointer(str) {
             return null;
     }
 }
-/** Parse the value of an "a" tag into an AddressPointer */
+/** Parses the value of an "a" tag into an AddressPointer. Returns null if the address cannot be parsed. */
 export function parseReplaceableAddress(address, requireIdentifier = false) {
     const parts = address.split(":");
     const kind = parts[0] ? parseInt(parts[0]) : undefined;
@@ -73,7 +73,7 @@ export function parseReplaceableAddress(address, requireIdentifier = false) {
         identifier,
     };
 }
-/** Extra a pubkey from the result of nip19.decode */
+/** Extracts a pubkey from the result of nip19.decode  Returns undefined if the decode result does not have a pubkey */
 export function getPubkeyFromDecodeResult(result) {
     if (!result)
         return;
@@ -89,7 +89,7 @@ export function getPubkeyFromDecodeResult(result) {
             return undefined;
     }
 }
-/** Gets the relays from a decode result */
+/** Extracts the relays from a decode result */
 export function getRelaysFromDecodeResult(result) {
     if (!result)
         return;
@@ -103,7 +103,7 @@ export function getRelaysFromDecodeResult(result) {
     }
     return undefined;
 }
-/** Encodes the result of nip19.decode */
+/** Encodes the result of nip19.decode to a NIP-19 string. Returns an empty string if the result cannot be encoded. */
 export function encodeDecodeResult(result) {
     switch (result.type) {
         case "naddr":
@@ -121,7 +121,7 @@ export function encodeDecodeResult(result) {
     }
     return "";
 }
-/** Encodes a pointer to a NIP-19 string */
+/** Encodes a pointer to a NIP-19 string. Returns an empty string if the pointer cannot be encoded. */
 export function encodePointer(pointer) {
     if (isAddressPointer(pointer))
         return naddrEncode(pointer);
@@ -132,7 +132,7 @@ export function encodePointer(pointer) {
     else
         return "";
 }
-/** Gets an EventPointer form a common "e" tag */
+/** Parses a common "e" tag into an EventPointer. Returns null if the tag cannot be parsed. */
 export function getEventPointerFromETag(tag) {
     const id = tag[1];
     if (!id || !isHexKey(id))
@@ -142,7 +142,7 @@ export function getEventPointerFromETag(tag) {
         pointer.relays = [normalizeURL(tag[2])];
     return pointer;
 }
-/** Gets an EventPointer form a common "q" tag */
+/** Parses a common "q" tag into an EventPointer. Returns null if the tag cannot be parsed. */
 export function getEventPointerFromQTag(tag) {
     const id = tag[1];
     if (!id || !isHexKey(id))
@@ -154,7 +154,7 @@ export function getEventPointerFromQTag(tag) {
         pointer.author = tag[3];
     return pointer;
 }
-/** Get an AddressPointer from a common "a" tag */
+/** Parses a common "a" tag into an AddressPointer. Returns null if the tag cannot be parsed. */
 export function getAddressPointerFromATag(tag) {
     if (!tag[1])
         return null;
@@ -165,7 +165,7 @@ export function getAddressPointerFromATag(tag) {
         pointer.relays = [normalizeURL(tag[2])];
     return pointer;
 }
-/** Gets a ProfilePointer from a common "p" tag */
+/** Parses a common "p" tag into a ProfilePointer. Returns null if the tag cannot be parsed. */
 export function getProfilePointerFromPTag(tag) {
     const pubkey = tag[1];
     if (!pubkey || !isHexKey(pubkey))
@@ -175,7 +175,7 @@ export function getProfilePointerFromPTag(tag) {
         pointer.relays = [normalizeURL(tag[2])];
     return pointer;
 }
-/** Checks if a pointer is an AddressPointer */
+/** Checks if a pointer object is an AddressPointer */
 export function isAddressPointer(pointer) {
     return (typeof pointer === "object" &&
         pointer !== null &&
@@ -186,7 +186,7 @@ export function isAddressPointer(pointer) {
         typeof pointer.pubkey === "string" &&
         typeof pointer.kind === "number");
 }
-/** Checks if a pointer is a ProfilePointer */
+/** Checks if a pointer object is a ProfilePointer */
 export function isProfilePointer(pointer) {
     return (typeof pointer === "object" &&
         pointer !== null &&
@@ -196,15 +196,15 @@ export function isProfilePointer(pointer) {
         !isEventPointer(pointer) &&
         !isAddressPointer(pointer));
 }
-/** Checks if a pointer is an EventPointer */
+/** Checks if a pointer object is an EventPointer */
 export function isEventPointer(pointer) {
     return typeof pointer === "object" && pointer !== null && "id" in pointer && typeof pointer.id === "string";
 }
-/** Returns the stringified address pointer */
+/** Returns the stringified NIP-19 encoded naddr address pointer for an AddressPointer. */
 export function getReplaceableAddressFromPointer(pointer) {
     return pointer.kind + ":" + pointer.pubkey + ":" + pointer.identifier;
 }
-/** Returns an AddressPointer for a replaceable event */
+/** 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))
         return null;
@@ -345,6 +345,21 @@ export function mergeProfilePointers(a, b) {
     const relays = relaySet(a.relays, b.relays);
     return { ...a, relays };
 }
+/** Checks if two address pointers refer to the same addressable event. Ignores relays. */
+export function isAddressPointerSame(a, b) {
+    return a.kind === b.kind && a.pubkey === b.pubkey && a.identifier === b.identifier;
+}
+/** Checks if two event pointers refer to the same event. Ignores relays. */
+export function isEventPointerSame(a, b) {
+    return (
+    // Check if id is the same
+    a.id === b.id &&
+        // Because event id's are unique, we can skip extra checks if either pointer is missing some fields
+        // If any kind is undefined, ignore it
+        (a.kind !== undefined || b.kind !== undefined ? a.kind === b.kind : true) &&
+        // If any author is undefined, ignore it
+        (a.author !== undefined || b.author !== undefined ? a.author === b.author : true));
+}
 /** Checks if an event matches a pointer */
 export function eventMatchesPointer(event, pointer) {
     if (isEventPointer(pointer)) {

package/dist/operations/content.js

@@ -1,7 +1,7 @@
 import { EncryptedContentSymbol } from "../helpers/encrypted-content.js";
 import { ensureProfilePointerTag, ensureQuoteEventPointerTag } from "../helpers/factory.js";
 import { eventPipe, skip } from "../helpers/pipeline.js";
-import { getContentPointers, getPubkeyFromDecodeResult } from "../helpers/pointers.js";
+import { getContentPointers, getPubkeyFromDecodeResult, getReplaceableAddressFromPointer, } from "../helpers/pointers.js";
 import { Expressions } from "../helpers/regexp.js";
 import { ensureNamedValueTag } from "../helpers/tags.js";
 /** Override the event content */
@@ -86,7 +86,9 @@ export function includeEmojis(emojis) {
         for (const [_, name] of matches) {
             const emoji = all.find((e) => e.shortcode === name);
             if (emoji?.url) {
-                tags.push(["emoji", emoji.shortcode, emoji.url]);
+                tags.push(emoji.address
+                    ? ["emoji", emoji.shortcode, emoji.url, getReplaceableAddressFromPointer(emoji.address)]
+                    : ["emoji", emoji.shortcode, emoji.url]);
             }
         }
         return { ...draft, tags };

package/package.json

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