applesauce-core 0.0.0-next-20241103143210

package/dist/helpers/pointers.js

@@ -0,0 +1,127 @@
+import { naddrEncode, neventEncode, noteEncode, nprofileEncode, npubEncode, nrelayEncode, nsecEncode, } from "nostr-tools/nip19";
+import { getPublicKey } from "nostr-tools";
+import { safeRelayUrls } from "./relays.js";
+export function parseCoordinate(a, requireD = false, silent = true) {
+    const parts = a.split(":");
+    const kind = parts[0] && parseInt(parts[0]);
+    const pubkey = parts[1];
+    const d = parts[2];
+    if (!kind) {
+        if (silent)
+            return null;
+        else
+            throw new Error("Missing kind");
+    }
+    if (!pubkey) {
+        if (silent)
+            return null;
+        else
+            throw new Error("Missing pubkey");
+    }
+    if (requireD && d === undefined) {
+        if (silent)
+            return null;
+        else
+            throw new Error("Missing identifier");
+    }
+    return {
+        kind,
+        pubkey,
+        identifier: d,
+    };
+}
+export function getPubkeyFromDecodeResult(result) {
+    if (!result)
+        return;
+    switch (result.type) {
+        case "naddr":
+        case "nprofile":
+            return result.data.pubkey;
+        case "npub":
+            return result.data;
+        case "nsec":
+            return getPublicKey(result.data);
+        default:
+            return undefined;
+    }
+}
+export function encodeDecodeResult(result) {
+    switch (result.type) {
+        case "naddr":
+            return naddrEncode(result.data);
+        case "nprofile":
+            return nprofileEncode(result.data);
+        case "nevent":
+            return neventEncode(result.data);
+        case "nrelay":
+            return nrelayEncode(result.data);
+        case "nsec":
+            return nsecEncode(result.data);
+        case "npub":
+            return npubEncode(result.data);
+        case "note":
+            return noteEncode(result.data);
+    }
+    return "";
+}
+export function getEventPointerFromTag(tag) {
+    if (!tag[1])
+        throw new Error("Missing event id in tag");
+    let pointer = { id: tag[1] };
+    if (tag[2])
+        pointer.relays = safeRelayUrls([tag[2]]);
+    return pointer;
+}
+export function getAddressPointerFromTag(tag) {
+    if (!tag[1])
+        throw new Error("Missing coordinate in tag");
+    const pointer = parseCoordinate(tag[1], true, false);
+    if (tag[2])
+        pointer.relays = safeRelayUrls([tag[2]]);
+    return pointer;
+}
+export function getProfilePointerFromTag(tag) {
+    if (!tag[1])
+        throw new Error("Missing pubkey in tag");
+    const pointer = { pubkey: tag[1] };
+    if (tag[2])
+        pointer.relays = safeRelayUrls([tag[2]]);
+    return pointer;
+}
+export function getPointerFromTag(tag) {
+    try {
+        switch (tag[0]) {
+            case "e":
+                return { type: "nevent", data: getEventPointerFromTag(tag) };
+            case "a":
+                return {
+                    type: "naddr",
+                    data: getAddressPointerFromTag(tag),
+                };
+            case "p":
+                return { type: "nprofile", data: getProfilePointerFromTag(tag) };
+        }
+    }
+    catch (error) { }
+    return null;
+}
+export function isAddressPointer(pointer) {
+    return (typeof pointer !== "string" &&
+        Object.hasOwn(pointer, "identifier") &&
+        Object.hasOwn(pointer, "pubkey") &&
+        Object.hasOwn(pointer, "kind"));
+}
+export function isEventPointer(pointer) {
+    return typeof pointer !== "string" && Object.hasOwn(pointer, "id");
+}
+export function getCoordinateFromAddressPointer(pointer) {
+    return `${pointer.kind}:${pointer.pubkey}:${pointer.identifier}`;
+}
+export function getATagFromAddressPointer(pointer) {
+    const relay = pointer.relays?.[0];
+    const coordinate = getCoordinateFromAddressPointer(pointer);
+    return relay ? ["a", coordinate, relay] : ["a", coordinate];
+}
+export function getETagFromEventPointer(pointer) {
+    return pointer.relays?.length ? ["e", pointer.id, pointer.relays[0]] : ["e", pointer.id];
+}

package/dist/helpers/profile.d.ts

@@ -0,0 +1,25 @@
+import { NostrEvent } from "nostr-tools";
+export declare const ProfileContentSymbol: unique symbol;
+declare module "nostr-tools" {
+    interface Event {
+        [ProfileContentSymbol]?: ProfileContent | Error;
+    }
+}
+export type ProfileContent = {
+    name?: string;
+    display_name?: string;
+    displayName?: string;
+    about?: string;
+    /** @deprecated */
+    image?: string;
+    picture?: string;
+    banner?: string;
+    website?: string;
+    lud16?: string;
+    lud06?: string;
+    nip05?: string;
+};
+/** Returns the parsed profile content for a kind 0 event */
+export declare function getProfileContent(event: NostrEvent): ProfileContent;
+export declare function getProfileContent(event: NostrEvent, quite: false): ProfileContent;
+export declare function getProfileContent(event: NostrEvent, quite: true): ProfileContent | Error;

package/dist/helpers/profile.js

@@ -0,0 +1,28 @@
+export const ProfileContentSymbol = Symbol.for("profile-content");
+export function getProfileContent(event, quite = false) {
+    let cached = event[ProfileContentSymbol];
+    if (!cached) {
+        try {
+            const profile = JSON.parse(event.content);
+            // ensure nip05 is a string
+            if (profile.nip05 && typeof profile.nip05 !== "string")
+                profile.nip05 = String(profile.nip05);
+            cached = event[ProfileContentSymbol] = profile;
+        }
+        catch (e) {
+            if (e instanceof Error)
+                cached = event[ProfileContentSymbol] = e;
+        }
+    }
+    if (cached === undefined) {
+        throw new Error("Failed to parse profile");
+    }
+    else if (cached instanceof Error) {
+        if (!quite)
+            throw cached;
+        else
+            return cached;
+    }
+    else
+        return cached;
+}

package/dist/helpers/relays.d.ts

@@ -0,0 +1,12 @@
+import { NostrEvent } from "nostr-tools";
+export declare const SeenRelaysSymbol: unique symbol;
+declare module "nostr-tools" {
+    interface Event {
+        [SeenRelaysSymbol]?: Set<string>;
+    }
+}
+export declare function addSeenRelay(event: NostrEvent, relay: string): Set<string>;
+export declare function getSeenRelays(event: NostrEvent): Set<string> | undefined;
+export declare function validateRelayURL(relay: string | URL): URL;
+export declare function safeRelayUrl(relayUrl: string | URL): string | null;
+export declare function safeRelayUrls(urls: Iterable<string>): string[];

package/dist/helpers/relays.js

@@ -0,0 +1,31 @@
+export const SeenRelaysSymbol = Symbol.for("seen-relays");
+// Seen relays
+export function addSeenRelay(event, relay) {
+    if (!event[SeenRelaysSymbol])
+        event[SeenRelaysSymbol] = new Set();
+    event[SeenRelaysSymbol].add(relay);
+    return event[SeenRelaysSymbol];
+}
+export function getSeenRelays(event) {
+    return event[SeenRelaysSymbol];
+}
+// Relay URLs
+export function validateRelayURL(relay) {
+    if (typeof relay === "string" && relay.includes(",ws"))
+        throw new Error("Can not have multiple relays in one string");
+    const url = typeof relay === "string" ? new URL(relay) : relay;
+    if (url.protocol !== "wss:" && url.protocol !== "ws:")
+        throw new Error("Incorrect protocol");
+    return url;
+}
+export function safeRelayUrl(relayUrl) {
+    try {
+        return validateRelayURL(relayUrl).toString();
+    }
+    catch (e) {
+        return null;
+    }
+}
+export function safeRelayUrls(urls) {
+    return Array.from(urls).map(safeRelayUrl).filter(Boolean);
+}

package/dist/helpers/string.d.ts

@@ -0,0 +1,4 @@
+export declare function isHex(str?: string): boolean;
+export declare function isHexKey(key?: string): boolean;
+export declare function stripInvisibleChar(str: string): string;
+export declare function stripInvisibleChar(str?: string | undefined): string | undefined;

package/dist/helpers/string.js

@@ -0,0 +1,13 @@
+export function isHex(str) {
+    if (str?.match(/^[0-9a-f]+$/i))
+        return true;
+    return false;
+}
+export function isHexKey(key) {
+    if (key?.toLowerCase()?.match(/^[0-9a-f]{64}$/))
+        return true;
+    return false;
+}
+export function stripInvisibleChar(str) {
+    return str && str.replaceAll(/[\p{Cf}\p{Zs}]/gu, "");
+}

package/dist/helpers/tags.d.ts

@@ -0,0 +1,6 @@
+export declare function isETag(tag: string[]): tag is ["e", string, ...string[]];
+export declare function isPTag(tag: string[]): tag is ["p", string, ...string[]];
+export declare function isRTag(tag: string[]): tag is ["r", string, ...string[]];
+export declare function isDTag(tag: string[]): tag is ["d", string, ...string[]];
+export declare function isATag(tag: string[]): tag is ["a", string, ...string[]];
+export declare function isTTag(tag: string[]): tag is ["t", string, ...string[]];

package/dist/helpers/tags.js

@@ -0,0 +1,18 @@
+export function isETag(tag) {
+    return tag[0] === "e" && tag[1] !== undefined;
+}
+export function isPTag(tag) {
+    return tag[0] === "p" && tag[1] !== undefined;
+}
+export function isRTag(tag) {
+    return tag[0] === "r" && tag[1] !== undefined;
+}
+export function isDTag(tag) {
+    return tag[0] === "d" && tag[1] !== undefined;
+}
+export function isATag(tag) {
+    return tag[0] === "a" && tag[1] !== undefined;
+}
+export function isTTag(tag) {
+    return tag[0] === "a" && tag[1] !== undefined;
+}

package/dist/helpers/threading.d.ts

@@ -0,0 +1,55 @@
+import { EventTemplate, NostrEvent } from "nostr-tools";
+import { AddressPointer, EventPointer } from "nostr-tools/nip19";
+export type ThreadReferences = {
+    root?: {
+        e: EventPointer;
+        a: undefined;
+    } | {
+        e: undefined;
+        a: AddressPointer;
+    } | {
+        e: EventPointer;
+        a: AddressPointer;
+    };
+    reply?: {
+        e: EventPointer;
+        a: undefined;
+    } | {
+        e: undefined;
+        a: AddressPointer;
+    } | {
+        e: EventPointer;
+        a: AddressPointer;
+    };
+};
+export declare const Nip10ThreadRefsSymbol: unique symbol;
+declare module "nostr-tools" {
+    interface Event {
+        [Nip10ThreadRefsSymbol]?: ThreadReferences;
+    }
+}
+/** Parses NIP-10 tags and handles legacy behavior */
+export declare function interpretThreadTags(event: NostrEvent | EventTemplate): {
+    root?: {
+        e: string[];
+        a: undefined;
+    } | {
+        e: undefined;
+        a: string[];
+    } | {
+        e: string[];
+        a: string[];
+    };
+    reply?: {
+        e: string[];
+        a: undefined;
+    } | {
+        e: undefined;
+        a: string[];
+    } | {
+        e: string[];
+        a: string[];
+    };
+};
+/** Returns the parsed NIP-10 tags for an event */
+export declare function getNip10References(event: NostrEvent | EventTemplate): ThreadReferences;

package/dist/helpers/threading.js

@@ -0,0 +1,73 @@
+import { getAddressPointerFromTag, getEventPointerFromTag } from "./pointers.js";
+import { getOrComputeCachedValue } from "./cache.js";
+export const Nip10ThreadRefsSymbol = Symbol.for("nip10-thread-refs");
+/** Parses NIP-10 tags and handles legacy behavior */
+export function interpretThreadTags(event) {
+    const eTags = event.tags.filter((t) => t[0] === "e" && t[1]);
+    const aTags = event.tags.filter((t) => t[0] === "a" && t[1]);
+    // find the root and reply tags.
+    let rootETag = eTags.find((t) => t[3] === "root");
+    let replyETag = eTags.find((t) => t[3] === "reply");
+    let rootATag = aTags.find((t) => t[3] === "root");
+    let replyATag = aTags.find((t) => t[3] === "reply");
+    if (!rootETag || !replyETag) {
+        // a direct reply does not need a "reply" reference
+        // https://github.com/nostr-protocol/nips/blob/master/10.md
+        // this is not necessarily to spec. but if there is only one id (root or reply) then assign it to both
+        // this handles the cases where a client only set a "reply" tag and no root
+        rootETag = replyETag = rootETag || replyETag;
+    }
+    if (!rootATag || !replyATag) {
+        rootATag = replyATag = rootATag || replyATag;
+    }
+    if (!rootETag && !replyETag) {
+        // legacy behavior
+        // https://github.com/nostr-protocol/nips/blob/master/10.md#positional-e-tags-deprecated
+        const legacyETags = eTags.filter((t) => {
+            // ignore it if there is a marker
+            if (t[3])
+                return false;
+            return true;
+        });
+        if (legacyETags.length >= 1) {
+            // first tag is the root
+            rootETag = legacyETags[0];
+            // last tag is reply
+            replyETag = legacyETags[legacyETags.length - 1] ?? rootETag;
+        }
+    }
+    return {
+        root: rootETag || rootATag ? { e: rootETag, a: rootATag } : undefined,
+        reply: replyETag || replyATag ? { e: replyETag, a: replyATag } : undefined,
+    };
+}
+/** Returns the parsed NIP-10 tags for an event */
+export function getNip10References(event) {
+    return getOrComputeCachedValue(event, Nip10ThreadRefsSymbol, () => {
+        const tags = interpretThreadTags(event);
+        let root;
+        if (tags.root) {
+            try {
+                root = {
+                    e: tags.root.e && getEventPointerFromTag(tags.root.e),
+                    a: tags.root.a && getAddressPointerFromTag(tags.root.a),
+                };
+            }
+            catch (error) { }
+        }
+        let reply;
+        if (tags.reply) {
+            try {
+                reply = {
+                    e: tags.reply.e && getEventPointerFromTag(tags.reply.e),
+                    a: tags.reply.a && getAddressPointerFromTag(tags.reply.a),
+                };
+            }
+            catch (error) { }
+        }
+        return {
+            root,
+            reply,
+        };
+    });
+}

package/dist/helpers/time.d.ts

@@ -0,0 +1,2 @@
+/** Returns the current unix timestamp */
+export declare function unixNow(): number;

package/dist/helpers/time.js

@@ -0,0 +1,4 @@
+/** Returns the current unix timestamp */
+export function unixNow() {
+    return Math.round(Date.now() / 1000);
+}

package/dist/helpers/url.d.ts

@@ -0,0 +1,11 @@
+export declare const convertToUrl: (url: string | URL) => URL;
+export declare const getURLFilename: (url: URL) => string | undefined;
+export declare const IMAGE_EXT: string[];
+export declare const VIDEO_EXT: string[];
+export declare const STREAM_EXT: string[];
+export declare const AUDIO_EXT: string[];
+export declare function isVisualMediaURL(url: string | URL): boolean;
+export declare function isImageURL(url: string | URL): boolean;
+export declare function isVideoURL(url: string | URL): boolean;
+export declare function isStreamURL(url: string | URL): boolean;
+export declare function isAudioURL(url: string | URL): boolean;

package/dist/helpers/url.js

@@ -0,0 +1,29 @@
+export const convertToUrl = (url) => (url instanceof URL ? url : new URL(url));
+export const getURLFilename = (url) => url.pathname.split("/").pop()?.toLocaleLowerCase() || url.searchParams.get("filename")?.toLocaleLowerCase();
+export const IMAGE_EXT = [".svg", ".gif", ".png", ".jpg", ".jpeg", ".webp", ".avif"];
+export const VIDEO_EXT = [".mp4", ".mkv", ".webm", ".mov"];
+export const STREAM_EXT = [".m3u8"];
+export const AUDIO_EXT = [".mp3", ".wav", ".ogg", ".aac"];
+export function isVisualMediaURL(url) {
+    return isImageURL(url) || isVideoURL(url) || isStreamURL(url);
+}
+export function isImageURL(url) {
+    url = convertToUrl(url);
+    const filename = getURLFilename(url);
+    return !!filename && IMAGE_EXT.some((ext) => filename.endsWith(ext));
+}
+export function isVideoURL(url) {
+    url = convertToUrl(url);
+    const filename = getURLFilename(url);
+    return !!filename && VIDEO_EXT.some((ext) => filename.endsWith(ext));
+}
+export function isStreamURL(url) {
+    url = convertToUrl(url);
+    const filename = getURLFilename(url);
+    return !!filename && STREAM_EXT.some((ext) => filename.endsWith(ext));
+}
+export function isAudioURL(url) {
+    url = convertToUrl(url);
+    const filename = getURLFilename(url);
+    return !!filename && AUDIO_EXT.some((ext) => filename.endsWith(ext));
+}

package/dist/helpers/zap.d.ts

@@ -0,0 +1,12 @@
+import { NostrEvent } from "nostr-tools";
+export declare const ZapRequestSymbol: unique symbol;
+export declare const ZapFromSymbol: unique symbol;
+export declare const ZapInvoiceSymbol: unique symbol;
+export declare const ZapEventPointerSymbol: unique symbol;
+export declare function getZapSender(zap: NostrEvent): string;
+export declare function getZapRecipient(zap: NostrEvent): string;
+export declare function getZapPayment(zap: NostrEvent): import("./bolt11.js").ParsedInvoice | undefined;
+export declare function getZapAddressPointer(zap: NostrEvent): import("nostr-tools/nip19").AddressPointer | null;
+export declare function getZapEventPointer(zap: NostrEvent): import("nostr-tools/nip19").EventPointer | null;
+export declare function getZapPreimage(zap: NostrEvent): string | undefined;
+export declare function getZapRequest(zap: NostrEvent): import("nostr-tools").Event;

package/dist/helpers/zap.js

@@ -0,0 +1,51 @@
+import { nip57 } from "nostr-tools";
+import { getOrComputeCachedValue } from "./cache.js";
+import { getTagValue } from "./event.js";
+import { isATag, isETag } from "./tags.js";
+import { getAddressPointerFromTag, getEventPointerFromTag } from "./pointers.js";
+import { parseBolt11 } from "./bolt11.js";
+export const ZapRequestSymbol = Symbol.for("zap-request");
+export const ZapFromSymbol = Symbol.for("zap-from");
+export const ZapInvoiceSymbol = Symbol.for("zap-bolt11");
+export const ZapEventPointerSymbol = Symbol.for("zap-event-pointer");
+export function getZapSender(zap) {
+    return getTagValue(zap, "P") || getZapRequest(zap).pubkey;
+}
+export function getZapRecipient(zap) {
+    const recipient = getTagValue(zap, "p");
+    if (!recipient)
+        throw new Error("Missing recipient");
+    return recipient;
+}
+export function getZapPayment(zap) {
+    return getOrComputeCachedValue(zap, ZapInvoiceSymbol, () => {
+        const bolt11 = getTagValue(zap, "bolt11");
+        return bolt11 ? parseBolt11(bolt11) : undefined;
+    });
+}
+export function getZapAddressPointer(zap) {
+    return getOrComputeCachedValue(zap, ZapEventPointerSymbol, () => {
+        const a = zap.tags.find(isATag);
+        return a ? getAddressPointerFromTag(a) : null;
+    });
+}
+export function getZapEventPointer(zap) {
+    return getOrComputeCachedValue(zap, ZapEventPointerSymbol, () => {
+        const e = zap.tags.find(isETag);
+        return e ? getEventPointerFromTag(e) : null;
+    });
+}
+export function getZapPreimage(zap) {
+    return getTagValue(zap, "preimage");
+}
+export function getZapRequest(zap) {
+    return getOrComputeCachedValue(zap, ZapRequestSymbol, () => {
+        const description = getTagValue(zap, "description");
+        if (!description)
+            throw new Error("Missing description tag");
+        const error = nip57.validateZapRequest(description);
+        if (error)
+            throw new Error(error);
+        return JSON.parse(description);
+    });
+}

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./event-store/index.js";
+export * from "./query-store/index.js";
+export * as Helpers from "./helpers/index.js";
+export * as Queries from "./queries/index.js";
+export * from "./logger.js";

package/dist/index.js

@@ -0,0 +1,5 @@
+export * from "./event-store/index.js";
+export * from "./query-store/index.js";
+export * as Helpers from "./helpers/index.js";
+export * as Queries from "./queries/index.js";
+export * from "./logger.js";

package/dist/logger.d.ts

@@ -0,0 +1,2 @@
+import debug from "debug";
+export declare const logger: debug.Debugger;

package/dist/logger.js

@@ -0,0 +1,2 @@
+import debug from "debug";
+export const logger = debug("applesauce");

package/dist/observable/getValue.d.ts

@@ -0,0 +1,2 @@
+import { Observable } from "rxjs";
+export declare function getValue<T>(observable: Observable<T>): T | Promise<T>;

package/dist/observable/getValue.js

@@ -0,0 +1,13 @@
+import { BehaviorSubject } from "rxjs";
+export function getValue(observable) {
+    if (observable instanceof BehaviorSubject)
+        return observable.value;
+    if (Reflect.has(observable, "value"))
+        return Reflect.get(observable, "value");
+    return new Promise((res) => {
+        const sub = observable.subscribe((v) => {
+            res(v);
+            sub.unsubscribe();
+        });
+    });
+}

package/dist/observable/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./getValue.js";
+export * from "./share-latest-value.js";

package/dist/observable/index.js

@@ -0,0 +1,2 @@
+export * from "./getValue.js";
+export * from "./share-latest-value.js";

package/dist/observable/share-behavior.d.ts

@@ -0,0 +1,2 @@
+import { BehaviorSubject, Observable, UnaryFunction } from "rxjs";
+export declare function shareBehavior<T>(): UnaryFunction<Observable<T>, BehaviorSubject<T | undefined>>;

package/dist/observable/share-behavior.js

@@ -0,0 +1,7 @@
+import { BehaviorSubject, share } from "rxjs";
+export function shareBehavior() {
+    return share({
+        connector: () => new BehaviorSubject(undefined),
+        resetOnRefCountZero: false,
+    });
+}

package/dist/observable/share-latest-value.d.ts

@@ -0,0 +1,8 @@
+import { Observable, ShareConfig } from "rxjs";
+/**
+ * Creates an operator that adds a 'value' property and multiplexes the source
+ * @param config Optional ShareConfig for customizing sharing behavior
+ */
+export declare function shareLatestValue<T>(config?: ShareConfig<T>): (source: Observable<T>) => Observable<T> & {
+    value: T | undefined;
+};

package/dist/observable/share-latest-value.js

@@ -0,0 +1,21 @@
+import { share } from "rxjs";
+import { tap } from "rxjs/operators";
+/**
+ * Creates an operator that adds a 'value' property and multiplexes the source
+ * @param config Optional ShareConfig for customizing sharing behavior
+ */
+export function shareLatestValue(config = {}) {
+    return (source) => {
+        // Create storage for latest value
+        let latestValue = undefined;
+        // Create shared source with value tracking
+        const shared$ = source.pipe(tap((value) => {
+            latestValue = value;
+        }), share(config));
+        // Add value property
+        Object.defineProperty(shared$, "value", {
+            get: () => latestValue,
+        });
+        return shared$;
+    };
+}

package/dist/observable/stateful.d.ts

@@ -0,0 +1,10 @@
+import { Observable } from "rxjs";
+export type StatefulObservable<T> = Observable<T> & {
+    _stateful?: true;
+    value?: T;
+    error?: Error;
+    complete?: boolean;
+};
+/** Wraps an {@link Observable} and makes it stateful */
+export declare function stateful<T extends unknown>(observable: Observable<T>, cleanup?: boolean): StatefulObservable<T>;
+export declare function isStateful<T extends unknown>(observable: Observable<T> | StatefulObservable<T>): observable is StatefulObservable<T>;