applesauce-core 0.0.0-next-20250308144838 → 0.0.0-next-20250309231023

package/dist/helpers/direct-messages.d.ts

@@ -0,0 +1,4 @@
+import { NostrEvent } from "nostr-tools";
+import { HiddenContentSigner } from "./hidden-content.js";
+/** Returns the decrypted content of a direct message */
+export declare function decryptDirectMessage(message: NostrEvent, signer: HiddenContentSigner): Promise<string>;

package/dist/helpers/direct-messages.js

@@ -0,0 +1,5 @@
+import { getHiddenContent, unlockHiddenContent } from "./hidden-content.js";
+/** Returns the decrypted content of a direct message */
+export async function decryptDirectMessage(message, signer) {
+    return getHiddenContent(message) || (await unlockHiddenContent(message, signer));
+}

package/dist/helpers/gift-wraps.d.ts

@@ -0,0 +1,12 @@
+import { NostrEvent, UnsignedEvent } from "nostr-tools";
+import { HiddenContentSigner } from "./hidden-content.js";
+export declare const GiftWrapSealSymbol: unique symbol;
+export declare const GiftWrapEventSymbol: unique symbol;
+/** Returns the unsigned seal event in a gift-wrap event */
+export declare function getGiftWrapSeal(gift: NostrEvent): NostrEvent;
+/** Returns the unsigned event in the gift-wrap seal */
+export declare function getGiftWrapEvent(gift: NostrEvent): UnsignedEvent;
+/** Returns if a gift-wrap event or gift-wrap seal is locked */
+export declare function isGiftWrapLocked(gift: NostrEvent): boolean;
+/** Unlocks and returns the unsigned seal event in a gift-wrap */
+export declare function unlockGiftWrap(gift: NostrEvent, signer: HiddenContentSigner): Promise<UnsignedEvent>;

package/dist/helpers/gift-wraps.js

@@ -0,0 +1,43 @@
+import { verifyEvent } from "nostr-tools";
+import { getHiddenContent, isHiddenContentLocked, unlockHiddenContent } from "./hidden-content.js";
+import { getOrComputeCachedValue } from "./cache.js";
+export const GiftWrapSealSymbol = Symbol.for("gift-wrap-seal");
+export const GiftWrapEventSymbol = Symbol.for("gift-wrap-event");
+/** Returns the unsigned seal event in a gift-wrap event */
+export function getGiftWrapSeal(gift) {
+    return getOrComputeCachedValue(gift, GiftWrapSealSymbol, () => {
+        const plaintext = getHiddenContent(gift);
+        if (!plaintext)
+            throw new Error("Gift-wrap is locked");
+        const seal = JSON.parse(plaintext);
+        // verify the seal is valid
+        verifyEvent(seal);
+        return seal;
+    });
+}
+/** Returns the unsigned event in the gift-wrap seal */
+export function getGiftWrapEvent(gift) {
+    return getOrComputeCachedValue(gift, GiftWrapEventSymbol, () => {
+        const seal = getGiftWrapSeal(gift);
+        const plaintext = getHiddenContent(seal);
+        if (!plaintext)
+            throw new Error("Gift-wrap seal is locked");
+        const event = JSON.parse(plaintext);
+        if (event.pubkey !== seal.pubkey)
+            throw new Error("Seal author does not match content");
+        return event;
+    });
+}
+/** Returns if a gift-wrap event or gift-wrap seal is locked */
+export function isGiftWrapLocked(gift) {
+    return isHiddenContentLocked(gift) || isHiddenContentLocked(getGiftWrapSeal(gift));
+}
+/** Unlocks and returns the unsigned seal event in a gift-wrap */
+export async function unlockGiftWrap(gift, signer) {
+    if (isHiddenContentLocked(gift))
+        await unlockHiddenContent(gift, signer);
+    const seal = getGiftWrapSeal(gift);
+    if (isHiddenContentLocked(seal))
+        await unlockHiddenContent(seal, signer);
+    return getGiftWrapEvent(gift);
+}

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

@@ -0,0 +1,44 @@
+import { UnsignedEvent, type EventTemplate, type NostrEvent } from "nostr-tools";
+export declare const HiddenContentSymbol: unique symbol;
+export type HiddenContentSigner = {
+    nip04?: {
+        encrypt: (pubkey: string, plaintext: string) => Promise<string> | string;
+        decrypt: (pubkey: string, ciphertext: string) => Promise<string> | string;
+    };
+    nip44?: {
+        encrypt: (pubkey: string, plaintext: string) => Promise<string> | string;
+        decrypt: (pubkey: string, ciphertext: string) => Promise<string> | string;
+    };
+};
+/** Various event kinds that can have encrypted tags in their content and which encryption method they use */
+export declare const EventContentEncryptionMethod: Record<number, "nip04" | "nip44">;
+/** Checks if an event can have hidden content */
+export declare function canHaveHiddenContent(kind: number): boolean;
+/** Checks if an event has hidden content */
+export declare function hasHiddenContent(event: {
+    kind: number;
+    content: string;
+}): boolean;
+/** Returns the hidden tags for an event if they are unlocked */
+export declare function getHiddenContent(event: NostrEvent | EventTemplate): string | undefined;
+/** Checks if the hidden tags are locked */
+export declare function isHiddenContentLocked(event: NostrEvent | UnsignedEvent): boolean;
+/** Returns either nip04 or nip44 encryption methods depending on event kind */
+export declare function getHiddenContentEncryptionMethods(kind: number, signer: HiddenContentSigner): {
+    encrypt: (pubkey: string, plaintext: string) => Promise<string> | string;
+    decrypt: (pubkey: string, ciphertext: string) => Promise<string> | string;
+} | {
+    encrypt: (pubkey: string, plaintext: string) => Promise<string> | string;
+    decrypt: (pubkey: string, ciphertext: string) => Promise<string> | string;
+};
+/**
+ * Unlocks the encrypted content in an event
+ * @param event The event with content to decrypt
+ * @param signer A signer to use to decrypt the tags
+ * @throws
+ */
+export declare function unlockHiddenContent(event: {
+    kind: number;
+    pubkey: string;
+    content: string;
+}, signer: HiddenContentSigner): Promise<string>;

package/dist/helpers/hidden-content.js

@@ -0,0 +1,66 @@
+import * as kinds from "nostr-tools/kinds";
+import { GROUPS_LIST_KIND } from "./groups.js";
+export const HiddenContentSymbol = Symbol.for("hidden-content");
+/** Various event kinds that can have encrypted tags in their content and which encryption method they use */
+export const EventContentEncryptionMethod = {
+    // NIP-60 wallet
+    17375: "nip44",
+    7375: "nip44",
+    7376: "nip44",
+    // DMs
+    [kinds.EncryptedDirectMessage]: "nip04",
+    // Gift wraps
+    [kinds.GiftWrap]: "nip44",
+    // NIP-51 lists
+    [kinds.BookmarkList]: "nip04",
+    [kinds.InterestsList]: "nip04",
+    [kinds.Mutelist]: "nip04",
+    [kinds.CommunitiesList]: "nip04",
+    [kinds.PublicChatsList]: "nip04",
+    [kinds.SearchRelaysList]: "nip04",
+    [GROUPS_LIST_KIND]: "nip04",
+    // NIP-51 sets
+    [kinds.Bookmarksets]: "nip04",
+    [kinds.Relaysets]: "nip04",
+    [kinds.Followsets]: "nip04",
+    [kinds.Curationsets]: "nip04",
+    [kinds.Interestsets]: "nip04",
+};
+/** Checks if an event can have hidden content */
+export function canHaveHiddenContent(kind) {
+    return EventContentEncryptionMethod[kind] !== undefined;
+}
+/** Checks if an event has hidden content */
+export function hasHiddenContent(event) {
+    return canHaveHiddenContent(event.kind) && event.content.length > 0;
+}
+/** Returns the hidden tags for an event if they are unlocked */
+export function getHiddenContent(event) {
+    return Reflect.get(event, HiddenContentSymbol);
+}
+/** Checks if the hidden tags are locked */
+export function isHiddenContentLocked(event) {
+    return hasHiddenContent(event) && getHiddenContent(event) === undefined;
+}
+/** Returns either nip04 or nip44 encryption methods depending on event kind */
+export function getHiddenContentEncryptionMethods(kind, signer) {
+    const method = EventContentEncryptionMethod[kind];
+    const encryption = signer[method];
+    if (!encryption)
+        throw new Error(`Signer does not support ${method} encryption`);
+    return encryption;
+}
+/**
+ * Unlocks the encrypted content in an event
+ * @param event The event with content to decrypt
+ * @param signer A signer to use to decrypt the tags
+ * @throws
+ */
+export async function unlockHiddenContent(event, signer) {
+    if (!canHaveHiddenContent(event.kind))
+        throw new Error("Event kind does not support hidden content");
+    const encryption = getHiddenContentEncryptionMethods(event.kind, signer);
+    const plaintext = await encryption.decrypt(event.pubkey, event.content);
+    Reflect.set(event, HiddenContentSymbol, plaintext);
+    return plaintext;
+}

package/dist/helpers/hidden-tags.d.ts

@@ -1,18 +1,7 @@
 import { EventTemplate, NostrEvent } from "nostr-tools";
 import { EventStore } from "../event-store/event-store.js";
-export type HiddenTagsSigner = {
-    nip04?: {
-        encrypt: (pubkey: string, plaintext: string) => Promise<string> | string;
-        decrypt: (pubkey: string, ciphertext: string) => Promise<string> | string;
-    };
-    nip44?: {
-        encrypt: (pubkey: string, plaintext: string) => Promise<string> | string;
-        decrypt: (pubkey: string, ciphertext: string) => Promise<string> | string;
-    };
-};
+import { HiddenContentSigner } from "./hidden-content.js";
 export declare const HiddenTagsSymbol: unique symbol;
-/** Various event kinds that can have encrypted tags in their content and which encryption method they use */
-export declare const EventEncryptionMethod: Record<number, "nip04" | "nip44">;
 /** Checks if an event can have hidden tags */
 export declare function canHaveHiddenTags(kind: number): boolean;
 /** Checks if an event has hidden tags */
@@ -22,7 +11,7 @@ export declare function getHiddenTags(event: NostrEvent | EventTemplate): string
 /** Checks if the hidden tags are locked */
 export declare function isHiddenTagsLocked(event: NostrEvent): boolean;
 /** Returns either nip04 or nip44 encryption method depending on list kind */
-export declare function getListEncryptionMethods(kind: number, signer: HiddenTagsSigner): {
+export declare function getListEncryptionMethods(kind: number, signer: HiddenContentSigner): {
     encrypt: (pubkey: string, plaintext: string) => Promise<string> | string;
     decrypt: (pubkey: string, ciphertext: string) => Promise<string> | string;
 } | {
@@ -40,9 +29,10 @@ export declare function unlockHiddenTags<T extends {
     kind: number;
     pubkey: string;
     content: string;
-}>(event: T, signer: HiddenTagsSigner, store?: EventStore): Promise<T>;
+}>(event: T, signer: HiddenContentSigner, store?: EventStore): Promise<string[][]>;
 /**
  * Override the hidden tags in an event
+ * @deprecated use EventFactory to create draft events
  * @throws
  */
-export declare function overrideHiddenTags(event: NostrEvent, hidden: string[][], signer: HiddenTagsSigner): Promise<EventTemplate>;
+export declare function overrideHiddenTags(event: NostrEvent, hidden: string[][], signer: HiddenContentSigner): Promise<EventTemplate>;

package/dist/helpers/hidden-tags.js

@@ -1,30 +1,10 @@
-import { kinds } from "nostr-tools";
-import { GROUPS_LIST_KIND } from "./groups.js";
 import { unixNow } from "./time.js";
 import { isEvent } from "./event.js";
+import { canHaveHiddenContent, getHiddenContentEncryptionMethods, unlockHiddenContent, } from "./hidden-content.js";
 export const HiddenTagsSymbol = Symbol.for("hidden-tags");
-/** Various event kinds that can have encrypted tags in their content and which encryption method they use */
-export const EventEncryptionMethod = {
-    // NIP-60 wallet
-    17375: "nip44",
-    // NIP-51 lists
-    [kinds.BookmarkList]: "nip04",
-    [kinds.InterestsList]: "nip04",
-    [kinds.Mutelist]: "nip04",
-    [kinds.CommunitiesList]: "nip04",
-    [kinds.PublicChatsList]: "nip04",
-    [kinds.SearchRelaysList]: "nip04",
-    [GROUPS_LIST_KIND]: "nip04",
-    // NIP-51 sets
-    [kinds.Bookmarksets]: "nip04",
-    [kinds.Relaysets]: "nip04",
-    [kinds.Followsets]: "nip04",
-    [kinds.Curationsets]: "nip04",
-    [kinds.Interestsets]: "nip04",
-};
 /** Checks if an event can have hidden tags */
 export function canHaveHiddenTags(kind) {
-    return EventEncryptionMethod[kind] !== undefined;
+    return canHaveHiddenContent(kind);
 }
 /** Checks if an event has hidden tags */
 export function hasHiddenTags(event) {
@@ -40,11 +20,7 @@ export function isHiddenTagsLocked(event) {
 }
 /** Returns either nip04 or nip44 encryption method depending on list kind */
 export function getListEncryptionMethods(kind, signer) {
-    const method = EventEncryptionMethod[kind];
-    const encryption = signer[method];
-    if (!encryption)
-        throw new Error(`Signer does not support ${method} encryption`);
-    return encryption;
+    return getHiddenContentEncryptionMethods(kind, signer);
 }
 /**
  * Decrypts the private list
@@ -56,8 +32,7 @@ export function getListEncryptionMethods(kind, signer) {
 export async function unlockHiddenTags(event, signer, store) {
     if (!canHaveHiddenTags(event.kind))
         throw new Error("Event kind does not support hidden tags");
-    const encryption = getListEncryptionMethods(event.kind, signer);
-    const plaintext = await encryption.decrypt(event.pubkey, event.content);
+    const plaintext = await unlockHiddenContent(event, signer);
     const parsed = JSON.parse(plaintext);
     if (!Array.isArray(parsed))
         throw new Error("Content is not an array of tags");
@@ -66,10 +41,11 @@ export async function unlockHiddenTags(event, signer, store) {
     Reflect.set(event, HiddenTagsSymbol, tags);
     if (store && isEvent(event))
         store.update(event);
-    return event;
+    return tags;
 }
 /**
  * Override the hidden tags in an event
+ * @deprecated use EventFactory to create draft events
  * @throws
  */
 export async function overrideHiddenTags(event, hidden, signer) {

package/dist/helpers/index.d.ts

@@ -7,14 +7,17 @@ export * from "./comment.js";
 export * from "./contacts.js";
 export * from "./content.js";
 export * from "./delete.js";
+export * from "./direct-messages.js";
 export * from "./dns-identity.js";
 export * from "./emoji.js";
 export * from "./event.js";
 export * from "./external-id.js";
 export * from "./file-metadata.js";
 export * from "./filter.js";
+export * from "./gift-wraps.js";
 export * from "./groups.js";
 export * from "./hashtag.js";
+export * from "./hidden-content.js";
 export * from "./hidden-tags.js";
 export * from "./json.js";
 export * from "./lists.js";

package/dist/helpers/index.js

@@ -7,14 +7,17 @@ export * from "./comment.js";
 export * from "./contacts.js";
 export * from "./content.js";
 export * from "./delete.js";
+export * from "./direct-messages.js";
 export * from "./dns-identity.js";
 export * from "./emoji.js";
 export * from "./event.js";
 export * from "./external-id.js";
 export * from "./file-metadata.js";
 export * from "./filter.js";
+export * from "./gift-wraps.js";
 export * from "./groups.js";
 export * from "./hashtag.js";
+export * from "./hidden-content.js";
 export * from "./hidden-tags.js";
 export * from "./json.js";
 export * from "./lists.js";

package/package.json

@@ -1,18 +1,18 @@
 {
   "name": "applesauce-core",
-  "version": "0.0.0-next-20250308144838",
+  "version": "0.0.0-next-20250309231023",
   "description": "",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "keywords": [
-    "nostr"
+    "nostr",
+    "applesauce"
   ],
   "author": "hzrd149",
   "license": "MIT",
   "files": [
-    "dist",
-    "applesauce"
+    "dist"
   ],
   "exports": {
     ".": {