applesauce-content 5.0.0 → 6.2.0

package/dist/markdown/blossom.d.ts

@@ -0,0 +1,9 @@
+import { ParsedBlossomURI } from "applesauce-common/helpers/blossom";
+import { Link, Nodes } from "mdast";
+import { Transformer } from "unified";
+export interface BlossomMdastLink extends Link {
+    type: "link";
+    data: ParsedBlossomURI;
+}
+/** Finds and creates BUD-10 `blossom:` URI links in a mdast tree */
+export declare function remarkBlossomURIs(): Transformer<Nodes>;

package/dist/markdown/blossom.js

@@ -0,0 +1,22 @@
+import { parseBlossomURI } from "applesauce-common/helpers/blossom";
+import { Tokens } from "applesauce-core/helpers/regexp";
+import { findAndReplace } from "mdast-util-find-and-replace";
+/** Finds and creates BUD-10 `blossom:` URI links in a mdast tree */
+export function remarkBlossomURIs() {
+    return (tree) => {
+        findAndReplace(tree, [
+            Tokens.blossom,
+            (raw) => {
+                const parsed = parseBlossomURI(raw);
+                if (!parsed)
+                    return false;
+                return {
+                    type: "link",
+                    data: parsed,
+                    url: raw,
+                    children: [{ type: "text", value: raw }],
+                };
+            },
+        ]);
+    };
+}

package/dist/markdown/cashu.d.ts

@@ -0,0 +1,12 @@
+import { type Token } from "@cashu/cashu-ts";
+import { Link, Nodes } from "mdast";
+import { Transformer } from "unified";
+export interface CashuMdastLink extends Link {
+    type: "link";
+    data: {
+        token: Token;
+        raw: string;
+    };
+}
+/** Finds cashu tokens in a mdast tree and replaces them with link nodes carrying the decoded token */
+export declare function remarkCashuTokens(): Transformer<Nodes>;

package/dist/markdown/cashu.js

@@ -0,0 +1,24 @@
+import { getDecodedToken } from "@cashu/cashu-ts";
+import { Tokens } from "applesauce-core/helpers/regexp";
+import { findAndReplace } from "mdast-util-find-and-replace";
+/** Finds cashu tokens in a mdast tree and replaces them with link nodes carrying the decoded token */
+export function remarkCashuTokens() {
+    return (tree) => {
+        findAndReplace(tree, [
+            Tokens.cashu,
+            (_, $1) => {
+                try {
+                    const token = getDecodedToken($1, []);
+                    return {
+                        type: "link",
+                        data: { token, raw: $1 },
+                        url: "cashu:" + $1,
+                        children: [{ type: "text", value: $1 }],
+                    };
+                }
+                catch (error) { }
+                return false;
+            },
+        ]);
+    };
+}

package/dist/markdown/index.d.ts

@@ -1 +1,2 @@
 export * from "./mentions.js";
+export * from "./blossom.js";

package/dist/markdown/index.js

@@ -1 +1,2 @@
 export * from "./mentions.js";
+export * from "./blossom.js";

package/dist/nast/truncate.js

@@ -13,6 +13,9 @@ export function truncateContent(tree, maxLength = 256) {
             case "cashu":
                 length += node.raw.length;
                 break;
+            case "blossom":
+                length += node.raw.length;
+                break;
             case "gallery":
                 length += node.links.reduce((t, l) => t + l.length, 0);
                 break;

package/dist/nast/types.d.ts

@@ -1,5 +1,3 @@
-import { type Token } from "@cashu/cashu-ts";
-import { type ParsedInvoice } from "applesauce-common/helpers/bolt11";
 import { type EventTemplate, type NostrEvent } from "applesauce-core/helpers/event";
 import { type DecodeResult } from "applesauce-core/helpers/pointers";
 import { type Parent, type Node as UnistNode } from "unist";
@@ -27,16 +25,6 @@ export interface Mention extends Node {
     decoded: DecodeResult;
     encoded: string;
 }
-export interface CashuToken extends Node {
-    type: "cashu";
-    token: Token;
-    raw: string;
-}
-export interface LightningInvoice extends Node {
-    type: "lightning";
-    invoice: string;
-    parsed: ParsedInvoice;
-}
 export interface Hashtag extends Node {
     type: "hashtag";
     /** The name as it was written in the event */
@@ -53,15 +41,29 @@ export interface Emoji extends Node {
     url: string;
     tag: ["emoji", ...string[]];
 }
+export interface BlossomURI extends Node {
+    type: "blossom";
+    /** The original matched text, e.g. `blossom:<hash>.pdf?xs=...` */
+    raw: string;
+    /** 64 character lowercase hex sha256 hash of the blob */
+    sha256: string;
+    /** File extension without the leading dot */
+    ext: string;
+    /** Optional exact blob size in bytes */
+    size?: number;
+    /** Server hints from repeated `xs` query parameters */
+    servers: string[];
+    /** Author hex pubkeys from repeated `as` query parameters */
+    authors: string[];
+}
 export interface ContentMap {
     text: Text;
     link: Link;
     mention: Mention;
-    cashu: CashuToken;
-    lightning: LightningInvoice;
     hashtag: Hashtag;
     emoji: Emoji;
     gallery: Gallery;
+    blossom: BlossomURI;
 }
 export type Content = ContentMap[keyof ContentMap];
 export interface Root extends Parent {

package/dist/text/blossom.d.ts

@@ -0,0 +1,4 @@
+import { Transformer } from "unified";
+import { Root } from "../nast/types.js";
+/** Finds and creates BUD-10 blossom URI nodes in the tree */
+export declare function blossomURIs(): Transformer<Root>;

package/dist/text/blossom.js

@@ -0,0 +1,23 @@
+import { parseBlossomURI } from "applesauce-common/helpers/blossom";
+import { Tokens } from "applesauce-core/helpers/regexp";
+import { findAndReplace } from "../nast/find-and-replace.js";
+/** Finds and creates BUD-10 blossom URI nodes in the tree */
+export function blossomURIs() {
+    return (tree) => {
+        findAndReplace(tree, [
+            [
+                Tokens.blossom,
+                (raw) => {
+                    const parsed = parseBlossomURI(raw);
+                    if (!parsed)
+                        return false;
+                    return {
+                        type: "blossom",
+                        raw,
+                        ...parsed,
+                    };
+                },
+            ],
+        ]);
+    };
+}

package/dist/text/cashu.d.ts

@@ -1,4 +1,15 @@
+import { type Token } from "@cashu/cashu-ts";
 import { Transformer } from "unified";
-import { Root } from "../nast/types.js";
+import { Node, Root } from "../nast/types.js";
+export interface CashuToken extends Node {
+    type: "cashu";
+    token: Token;
+    raw: string;
+}
+declare module "../nast/types.js" {
+    interface ContentMap {
+        cashu: CashuToken;
+    }
+}
 /** Parse cashu tokens from an ATS tree */
 export declare function cashuTokens(): Transformer<Root>;

package/dist/text/cashu.js

@@ -1,6 +1,7 @@
 import { getDecodedToken } from "@cashu/cashu-ts";
 import { Tokens } from "applesauce-core/helpers/regexp";
 import { findAndReplace } from "../nast/find-and-replace.js";
+import { textNoteTransformers } from "./content.js";
 /** Parse cashu tokens from an ATS tree */
 export function cashuTokens() {
     return (tree) => {
@@ -9,7 +10,7 @@ export function cashuTokens() {
                 Tokens.cashu,
                 (_, $1) => {
                     try {
-                        const token = getDecodedToken($1);
+                        const token = getDecodedToken($1, []);
                         return {
                             type: "cashu",
                             token,
@@ -23,3 +24,9 @@ export function cashuTokens() {
         ]);
     };
 }
+// Register the cashu transformer in the default text-note pipeline as a side
+// effect of importing this module. Consumers opt-in to cashu support by
+// importing `applesauce-content/text/cashu`.
+if (!textNoteTransformers.includes(cashuTokens)) {
+    textNoteTransformers.push(cashuTokens);
+}

package/dist/text/content.d.ts

@@ -1,9 +1,8 @@
 import { Transformer } from "unified";
 import { EventTemplate, NostrEvent } from "applesauce-core/helpers/event";
 import { Root } from "../nast/types.js";
-import { galleries } from "./gallery.js";
 export declare const TextNoteContentSymbol: unique symbol;
-export declare const textNoteTransformers: (typeof galleries)[];
+export declare const textNoteTransformers: (() => Transformer<Root>)[];
 /** Parsed and process a note with custom transformers */
 export declare function getParsedContent(event: NostrEvent | EventTemplate | string, content?: string, transformers?: (() => Transformer<Root>)[], cacheKey?: symbol | null | undefined): Root;
 export declare function removeParsedTextContent(event: NostrEvent | EventTemplate): void;

package/dist/text/content.js

@@ -1,24 +1,25 @@
 import { unified } from "unified";
 import { getOrComputeCachedValue } from "applesauce-core/helpers/cache";
 import { nostrMentions } from "./mentions.js";
-import { cashuTokens } from "./cashu.js";
 import { emojis } from "./emoji.js";
 import { createEventContentTree } from "./parser.js";
 import { hashtags } from "./hashtag.js";
 import { galleries } from "./gallery.js";
-import { lightningInvoices } from "./lightning.js";
 import { eolMetadata } from "../nast/eol-metadata.js";
 import { links } from "./links.js";
+import { blossomURIs } from "./blossom.js";
 export const TextNoteContentSymbol = Symbol.for("text-note-content");
-// default kind 1 transformers
+// default kind 1 transformers. Optional transformers (like `cashuTokens` and
+// `lightningInvoices`) opt in by appending to this array when their module is
+// imported — see `applesauce-content/text/cashu` and
+// `applesauce-content/text/lightning`.
 export const textNoteTransformers = [
+    blossomURIs,
     links,
     nostrMentions,
     galleries,
     emojis,
     hashtags,
-    lightningInvoices,
-    cashuTokens,
     eolMetadata,
 ];
 /** Parsed and process a note with custom transformers */

package/dist/text/gallery.d.ts

@@ -1,4 +1,8 @@
 import { Transformer } from "unified";
 import { Root } from "../nast/types.js";
+export interface GalleriesOptions {
+    /** When true, adjacent `blossom:` image URIs are clustered alongside HTTP image links. Defaults to false. */
+    includeBlossom?: boolean;
+}
 /** Group images into galleries in an ATS tree */
-export declare function galleries(types?: string[]): Transformer<Root>;
+export declare function galleries(types?: string[], options?: GalleriesOptions): Transformer<Root>;

package/dist/text/gallery.js

@@ -1,21 +1,23 @@
 import { convertToUrl, getURLFilename, IMAGE_EXT } from "applesauce-core/helpers/url";
 /** Group images into galleries in an ATS tree */
-export function galleries(types = IMAGE_EXT) {
+export function galleries(types = IMAGE_EXT, options = {}) {
+    const { includeBlossom = false } = options;
     return (tree) => {
-        let links = [];
+        let items = [];
+        const getItemHref = (item) => (item.type === "link" ? item.href : item.raw);
         const commit = (index) => {
             // only create a gallery if there are more than a single image
-            if (links.length > 1) {
-                const start = tree.children.indexOf(links[0]);
-                const end = tree.children.indexOf(links[links.length - 1]);
+            if (items.length > 1) {
+                const start = tree.children.indexOf(items[0]);
+                const end = tree.children.indexOf(items[items.length - 1]);
                 // replace all nodes with a gallery
-                tree.children.splice(start, 1 + end - start, { type: "gallery", links: links.map((l) => l.href) });
-                links = [];
+                tree.children.splice(start, 1 + end - start, { type: "gallery", links: items.map(getItemHref) });
+                items = [];
                 // return new cursor
                 return end - 1;
             }
             else {
-                links = [];
+                items = [];
                 return index;
             }
         };
@@ -26,13 +28,21 @@ export function galleries(types = IMAGE_EXT) {
                     const url = convertToUrl(node.href);
                     const filename = getURLFilename(url);
                     if (filename && types.some((ext) => filename.endsWith(ext))) {
-                        links.push(node);
+                        items.push(node);
                     }
                     else {
                         i = commit(i);
                     }
                 }
-                else if (node.type === "text" && links.length > 0) {
+                else if (node.type === "blossom" && includeBlossom) {
+                    if (types.some((ext) => ext === `.${node.ext.toLowerCase()}`)) {
+                        items.push(node);
+                    }
+                    else {
+                        i = commit(i);
+                    }
+                }
+                else if (node.type === "text" && items.length > 0) {
                     const isEmpty = node.value === "\n" || !node.value.match(/[^\s]/g);
                     if (!isEmpty)
                         i = commit(i);

package/dist/text/imeta.d.ts

@@ -0,0 +1,11 @@
+import { type FileMetadataFields } from "applesauce-common/helpers/file-metadata";
+import { type Transformer } from "unified";
+import { Root } from "../nast/types.js";
+declare module "../nast/types.js" {
+    interface Link {
+        /** File metadata from a matching NIP-92 `imeta` tag on the event */
+        metadata?: FileMetadataFields;
+    }
+}
+/** Hydrates link nodes with NIP-92 file metadata from matching `imeta` tags on the event */
+export declare function imetaLinks(): Transformer<Root>;

package/dist/text/imeta.js

@@ -0,0 +1,40 @@
+import { getMediaAttachments } from "applesauce-common/helpers/file-metadata";
+import { textNoteTransformers } from "./content.js";
+/** Hydrates link nodes with NIP-92 file metadata from matching `imeta` tags on the event */
+export function imetaLinks() {
+    return (tree) => {
+        const event = tree.event;
+        if (!event || !event.tags || event.tags.length === 0)
+            return;
+        const attachments = getMediaAttachments(event);
+        if (attachments.length === 0)
+            return;
+        // Build a normalized URL -> metadata map so lookups match `link.href` exactly
+        const byUrl = new Map();
+        for (const attachment of attachments) {
+            if (!attachment.url)
+                continue;
+            try {
+                byUrl.set(new URL(attachment.url).toString(), attachment);
+            }
+            catch {
+                // ignore invalid URLs
+            }
+        }
+        if (byUrl.size === 0)
+            return;
+        for (const node of tree.children) {
+            if (node.type !== "link")
+                continue;
+            const metadata = byUrl.get(node.href);
+            if (metadata)
+                node.metadata = metadata;
+        }
+    };
+}
+// Register the imeta transformer in the default text-note pipeline as a side
+// effect of importing this module. Consumers opt-in to imeta link hydration
+// by importing `applesauce-content/text/imeta`.
+if (!textNoteTransformers.includes(imetaLinks)) {
+    textNoteTransformers.push(imetaLinks);
+}

package/dist/text/index.d.ts

@@ -1,9 +1,9 @@
+export * from "./blossom.js";
 export * from "./content.js";
+export * from "./emoji.js";
+export * from "./gallery.js";
+export * from "./hashtag.js";
+export * from "./imeta.js";
 export * from "./links.js";
 export * from "./mentions.js";
-export * from "./cashu.js";
-export * from "./emoji.js";
 export * from "./parser.js";
-export * from "./hashtag.js";
-export * from "./gallery.js";
-export * from "./lightning.js";

package/dist/text/index.js

@@ -1,9 +1,9 @@
+export * from "./blossom.js";
 export * from "./content.js";
+export * from "./emoji.js";
+export * from "./gallery.js";
+export * from "./hashtag.js";
+export * from "./imeta.js";
 export * from "./links.js";
 export * from "./mentions.js";
-export * from "./cashu.js";
-export * from "./emoji.js";
 export * from "./parser.js";
-export * from "./hashtag.js";
-export * from "./gallery.js";
-export * from "./lightning.js";

package/dist/text/lightning.d.ts

@@ -1,4 +1,15 @@
+import { type ParsedInvoice } from "applesauce-common/helpers/bolt11";
 import { type Transformer } from "unified";
-import { Root } from "../nast/types.js";
+import { Node, Root } from "../nast/types.js";
+export interface LightningInvoice extends Node {
+    type: "lightning";
+    invoice: string;
+    parsed: ParsedInvoice;
+}
+declare module "../nast/types.js" {
+    interface ContentMap {
+        lightning: LightningInvoice;
+    }
+}
 /** Finds and creates lightning invoice nodes in the tree */
 export declare function lightningInvoices(): Transformer<Root>;

package/dist/text/lightning.js

@@ -1,6 +1,7 @@
 import { parseBolt11 } from "applesauce-common/helpers/bolt11";
 import { Tokens } from "applesauce-core/helpers/regexp";
 import { findAndReplace } from "../nast/find-and-replace.js";
+import { textNoteTransformers } from "./content.js";
 /** Finds and creates lightning invoice nodes in the tree */
 export function lightningInvoices() {
     return (tree) => {
@@ -24,3 +25,9 @@ export function lightningInvoices() {
         ]);
     };
 }
+// Register the lightning transformer in the default text-note pipeline as a
+// side effect of importing this module. Consumers opt-in to lightning invoice
+// parsing by importing `applesauce-content/text/lightning`.
+if (!textNoteTransformers.includes(lightningInvoices)) {
+    textNoteTransformers.push(lightningInvoices);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "applesauce-content",
-  "version": "5.0.0",
+  "version": "6.2.0",
   "description": "Unified plugins for processing event content",
   "type": "module",
   "main": "dist/index.js",
@@ -39,19 +39,28 @@
       "require": "./dist/markdown/index.js",
       "types": "./dist/markdown/index.d.ts"
     },
+    "./markdown/*": {
+      "import": "./dist/markdown/*.js",
+      "require": "./dist/markdown/*.js",
+      "types": "./dist/markdown/*.d.ts"
+    },
     "./text": {
       "import": "./dist/text/index.js",
       "require": "./dist/text/index.js",
       "types": "./dist/text/index.d.ts"
+    },
+    "./text/*": {
+      "import": "./dist/text/*.js",
+      "require": "./dist/text/*.js",
+      "types": "./dist/text/*.d.ts"
     }
   },
   "dependencies": {
-    "@cashu/cashu-ts": "^3.1.1",
     "@types/hast": "^3.0.4",
     "@types/mdast": "^4.0.4",
     "@types/unist": "^3.0.3",
-    "applesauce-common": "^5.0.0",
-    "applesauce-core": "^5.0.0",
+    "applesauce-common": "^6.2.0",
+    "applesauce-core": "^6.2.0",
     "mdast-util-find-and-replace": "^3.0.2",
     "remark": "^15.0.1",
     "remark-parse": "^11.0.0",
@@ -59,11 +68,20 @@
     "unist-util-visit-parents": "^6.0.1"
   },
   "devDependencies": {
-    "applesauce-signers": "^5.0.0",
+    "@cashu/cashu-ts": "^4.5.1",
+    "applesauce-signers": "^6.2.0",
     "rimraf": "^6.0.1",
     "typescript": "^5.8.3",
     "vitest": "^4.0.15"
   },
+  "peerDependencies": {
+    "@cashu/cashu-ts": "^4.5.1"
+  },
+  "peerDependenciesMeta": {
+    "@cashu/cashu-ts": {
+      "optional": true
+    }
+  },
   "funding": {
     "type": "lightning",
     "url": "lightning:nostrudel@geyser.fund"