applesauce-content 0.0.0-next-20241103143210

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 hzrd149
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,32 @@
+# applesauce-content
+
+applesauce package for parsing text note content
+
+## Example
+
+```ts
+import { getParsedTextContent } from "applesauce-content/text";
+
+const stringContent = `
+hello nostr!
+nostr:npub180cvv07tjdrrgpa0j7j7tmnyl2yr6yr7l8j4s3evf6u64th6gkwsyjh6w6
+`;
+const ats = getParsedTextContent(stringContent);
+
+console.log(ats);
+/*
+{
+  type: 'root',
+  event: undefined,
+  children: [
+    { type: 'text', value: 'hello nostr!' },
+    { type: 'text', value: '\n' },
+    {
+      type: 'mention',
+      decoded: [Object],
+      encoded: 'npub180cvv07tjdrrgpa0j7j7tmnyl2yr6yr7l8j4s3evf6u64th6gkwsyjh6w6'
+    }
+  ]
+}
+*/
+```

package/dist/helpers/index.d.ts

@@ -0,0 +1 @@
+export * from "./regexp.js";

package/dist/helpers/index.js

@@ -0,0 +1 @@
+export * from "./regexp.js";

package/dist/helpers/regexp.d.ts

@@ -0,0 +1,7 @@
+export declare const Expressions: {
+    readonly cashu: RegExp;
+    readonly nostrLink: RegExp;
+    readonly emoji: RegExp;
+    readonly hashtag: RegExp;
+};
+export default Expressions;

package/dist/helpers/regexp.js

@@ -0,0 +1,15 @@
+export const Expressions = {
+    get cashu() {
+        return /(cashu(?:A|B)[A-Za-z0-9_-]{100,10000}={0,3})/gi;
+    },
+    get nostrLink() {
+        return /(?:nostr:)?((npub|note|nprofile|nevent|nrelay|naddr)1[qpzry9x8gf2tvdw0s3jn54khce6mua7l]{58,})/gi;
+    },
+    get emoji() {
+        return /:([a-zA-Z0-9_-]+):/gi;
+    },
+    get hashtag() {
+        return /(?<=^|[^\p{L}#])#([\p{L}\p{N}\p{M}]+)/gu;
+    },
+};
+export default Expressions;

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * as Text from "./text/index.js";
+export * as Nast from "./nast/index.js";
+export * as Markdown from "./markdown/index.js";
+export * as Helpers from "./helpers/index.js";

package/dist/index.js

@@ -0,0 +1,4 @@
+export * as Text from "./text/index.js";
+export * as Nast from "./nast/index.js";
+export * as Markdown from "./markdown/index.js";
+export * as Helpers from "./helpers/index.js";

package/dist/markdown/index.d.ts

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

package/dist/markdown/index.js

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

package/dist/markdown/mentions.d.ts

@@ -0,0 +1,8 @@
+import { Transformer } from "unified";
+import { Link, Nodes } from "mdast";
+import { DecodeResult } from "nostr-tools/nip19";
+export interface NostrMention extends Link {
+    type: "link";
+    data: DecodeResult;
+}
+export declare function remarkNostrMentions(): Transformer<Nodes>;

package/dist/markdown/mentions.js

@@ -0,0 +1,22 @@
+import { findAndReplace } from "mdast-util-find-and-replace";
+import { decode } from "nostr-tools/nip19";
+import Expressions from "../helpers/regexp.js";
+export function remarkNostrMentions() {
+    return (tree) => {
+        findAndReplace(tree, [
+            Expressions.nostrLink,
+            (_, $1) => {
+                try {
+                    return {
+                        type: "link",
+                        data: decode($1),
+                        children: [],
+                        url: "nostr:" + $1,
+                    };
+                }
+                catch (error) { }
+                return false;
+            },
+        ]);
+    };
+}

package/dist/nast/eol-metadata.d.ts

@@ -0,0 +1,3 @@
+import { Transformer } from "unified";
+import { Root } from "../nast/types.js";
+export declare function eolMetadata(): Transformer<Root>;

package/dist/nast/eol-metadata.js

@@ -0,0 +1,12 @@
+export function eolMetadata() {
+    return (tree) => {
+        for (let i = 0; i < tree.children.length; i++) {
+            // const node = tree.children[i];
+            const next = tree.children[i + 1];
+            if (next && next.type === "text" && next.value.startsWith("\n")) {
+                next.data = next.data || {};
+                next.data.eol = true;
+            }
+        }
+    };
+}

package/dist/nast/find-and-replace.d.ts

@@ -0,0 +1,6 @@
+import { Content, Root } from "./types.js";
+type Replace = (...groups: string[]) => null | undefined | false | string | Content | Content[];
+type FindAndReplaceTuple = [RegExp, Replace];
+type FindAndReplaceList = FindAndReplaceTuple[];
+export declare function findAndReplace(tree: Root, list: FindAndReplaceList): void;
+export {};

package/dist/nast/find-and-replace.js

@@ -0,0 +1,95 @@
+import { visitParents } from "unist-util-visit-parents";
+export function findAndReplace(tree, list) {
+    const pairs = list;
+    let pairIndex = -1;
+    const visitor = (node, parents) => {
+        let index = -1;
+        /** @type {Parents | undefined} */
+        let grandparent;
+        while (++index < parents.length) {
+            const parent = parents[index];
+            // const siblings = grandparent ? grandparent.children : undefined;
+            grandparent = parent;
+        }
+        if (grandparent) {
+            return handler(node, parents);
+        }
+        return undefined;
+    };
+    while (++pairIndex < pairs.length) {
+        visitParents(tree, "text", visitor);
+    }
+    /**
+     * Handle a text node which is not in an ignored parent.
+     *
+     * @param {Text} node
+     *   Text node.
+     * @param {Array<Parents>} parents
+     *   Parents.
+     * @returns {VisitorResult}
+     *   Result.
+     */
+    function handler(node, parents) {
+        const parent = parents[parents.length - 1];
+        const find = pairs[pairIndex][0];
+        const replace = pairs[pairIndex][1];
+        let start = 0;
+        const siblings = parent.children;
+        const index = siblings.indexOf(node);
+        let change = false;
+        let nodes = [];
+        find.lastIndex = 0;
+        let match = find.exec(node.value);
+        while (match) {
+            const position = match.index;
+            /** @type {RegExpMatchObject} */
+            // const matchObject = {
+            //   index: match.index,
+            //   input: match.input,
+            //   stack: [...parents, node],
+            // };
+            // let value = replace(...match, matchObject);
+            let value = replace(...match);
+            if (typeof value === "string") {
+                value = value.length > 0 ? { type: "text", value } : undefined;
+            }
+            // It wasn’t a match after all.
+            if (value === false) {
+                // False acts as if there was no match.
+                // So we need to reset `lastIndex`, which currently being at the end of
+                // the current match, to the beginning.
+                find.lastIndex = position + 1;
+            }
+            else {
+                if (start !== position) {
+                    nodes.push({
+                        type: "text",
+                        value: node.value.slice(start, position),
+                    });
+                }
+                if (Array.isArray(value)) {
+                    nodes.push(...value);
+                }
+                else if (value) {
+                    nodes.push(value);
+                }
+                start = position + match[0].length;
+                change = true;
+            }
+            if (!find.global) {
+                break;
+            }
+            match = find.exec(node.value);
+        }
+        if (change) {
+            if (start < node.value.length) {
+                nodes.push({ type: "text", value: node.value.slice(start) });
+            }
+            parent.children.splice(index, 1, ...nodes);
+        }
+        else {
+            nodes = [node];
+        }
+        return index + nodes.length;
+    }
+}

package/dist/nast/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./types.js";
+export * from "./find-and-replace.js";
+export * from "./eol-metadata.js";
+export * from "./truncate.js";

package/dist/nast/index.js

@@ -0,0 +1,4 @@
+export * from "./types.js";
+export * from "./find-and-replace.js";
+export * from "./eol-metadata.js";
+export * from "./truncate.js";

package/dist/nast/truncate.d.ts

@@ -0,0 +1,2 @@
+import { Root } from "./types.js";
+export declare function truncateContent(tree: Root, maxLength?: number): Root;

package/dist/nast/truncate.js

@@ -0,0 +1,48 @@
+export function truncateContent(tree, maxLength = 256) {
+    let length = 0;
+    for (let i = 0; i < tree.children.length; i++) {
+        const node = tree.children[i];
+        switch (node.type) {
+            case "hashtag":
+                length += 1 + node.hashtag.length;
+                break;
+            case "mention":
+                // guess user names are about 10 long
+                length += 10;
+                break;
+            case "cashu":
+                length += node.raw.length;
+                break;
+            case "gallery":
+                length += node.links.reduce((t, l) => t + l.length, 0);
+                break;
+            case "link":
+            case "text":
+                length += node.value.length;
+                break;
+            case "emoji":
+                length += 1;
+                break;
+        }
+        if (length > maxLength) {
+            if (node.type === "text") {
+                const children = i > 0 ? tree.children.slice(0, i) : [];
+                const chunkLength = node.value.length - (length - maxLength);
+                // find the nearest newline
+                const newLines = node.value.matchAll(/\n/g);
+                for (const match of newLines) {
+                    if (match.index && match.index > chunkLength) {
+                        children.push({ type: "text", value: node.value.slice(0, match.index) });
+                        return { ...tree, children, truncated: true };
+                    }
+                }
+                // just cut the string
+                children.push({ type: "text", value: node.value.slice(0, maxLength - length) });
+                return { ...tree, children, truncated: true };
+            }
+            else
+                return { ...tree, children: tree.children.slice(0, i), truncated: true };
+        }
+    }
+    return tree;
+}

package/dist/nast/types.d.ts

@@ -0,0 +1,69 @@
+import { EventTemplate, NostrEvent } from "nostr-tools";
+import { DecodeResult } from "nostr-tools/nip19";
+import { Node as UnistNode, Parent } from "unist";
+import { type Token } from "@cashu/cashu-ts";
+export interface CommonData {
+    eol?: boolean;
+}
+export interface Node extends Omit<UnistNode, "data"> {
+    data?: CommonData;
+}
+export interface Text extends Node {
+    type: "text";
+    value: string;
+}
+export interface Link extends Node {
+    type: "link";
+    value: string;
+    href: string;
+}
+export interface Gallery extends Node {
+    type: "gallery";
+    links: string[];
+}
+export interface Mention extends Node {
+    type: "mention";
+    decoded: DecodeResult;
+    encoded: string;
+}
+export interface CashuToken extends Node {
+    type: "cashu";
+    token: Token;
+    raw: string;
+}
+export interface LightningInvoice extends Node {
+    type: "lightning";
+    invoice: string;
+}
+export interface Hashtag extends Node {
+    type: "hashtag";
+    /** The name as it was written in the event */
+    name: string;
+    /** The lowercase canonical name */
+    hashtag: string;
+    tag: ["t", ...string[]];
+}
+export interface Emoji extends Node {
+    type: "emoji";
+    code: string;
+    raw: string;
+    url: string;
+    tag: ["emoji", ...string[]];
+}
+export interface ContentMap {
+    text: Text;
+    link: Link;
+    mention: Mention;
+    cashu: CashuToken;
+    lightning: LightningInvoice;
+    hashtag: Hashtag;
+    emoji: Emoji;
+    gallery: Gallery;
+}
+export type Content = ContentMap[keyof ContentMap];
+export interface Root extends Parent {
+    type: "root";
+    children: Content[];
+    event?: NostrEvent | EventTemplate;
+    truncated?: boolean;
+}

package/dist/nast/types.js

@@ -0,0 +1 @@
+export {};

package/dist/text/cashu.d.ts

@@ -0,0 +1,4 @@
+import { Transformer } from "unified";
+import { Root } from "../nast/types.js";
+/** Parse cashu tokens from an ATS tree */
+export declare function cashuTokens(): Transformer<Root>;

package/dist/text/cashu.js

@@ -0,0 +1,25 @@
+import { getDecodedToken } from "@cashu/cashu-ts";
+import Expressions from "../helpers/regexp.js";
+import { findAndReplace } from "../nast/find-and-replace.js";
+/** Parse cashu tokens from an ATS tree */
+export function cashuTokens() {
+    return (tree) => {
+        findAndReplace(tree, [
+            [
+                Expressions.cashu,
+                (_, $1) => {
+                    try {
+                        const token = getDecodedToken($1);
+                        return {
+                            type: "cashu",
+                            token,
+                            raw: $1,
+                        };
+                    }
+                    catch (error) { }
+                    return false;
+                },
+            ],
+        ]);
+    };
+}

package/dist/text/content.d.ts

@@ -0,0 +1,9 @@
+import { Transformer } from "unified";
+import { EventTemplate, NostrEvent } from "nostr-tools";
+import { Root } from "../nast/types.js";
+import { galleries } from "./gallery.js";
+export declare const ParsedTextContentSymbol: unique symbol;
+export declare const defaultTransformers: (typeof galleries)[];
+/** Parsed and process a note with custom transformers */
+export declare function getParsedTextContent(event: NostrEvent | EventTemplate | string, content?: string, transformers?: (() => Transformer<Root>)[]): Root;
+export declare function removeParsedTextContent(event: NostrEvent | EventTemplate): void;

package/dist/text/content.js

@@ -0,0 +1,33 @@
+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 { createTextNoteATS } from "./parser.js";
+import { hashtags } from "./hashtag.js";
+import { galleries } from "./gallery.js";
+export const ParsedTextContentSymbol = Symbol.for("parsed-text-content");
+// default kind 1 transformers
+export const defaultTransformers = [nostrMentions, galleries, emojis, hashtags, cashuTokens];
+/** Parsed and process a note with custom transformers */
+export function getParsedTextContent(event, content, transformers = defaultTransformers) {
+    // process strings
+    if (typeof event === "string") {
+        const processor = unified();
+        for (const transformer of transformers) {
+            processor.use(transformer);
+        }
+        return processor.runSync(createTextNoteATS(event, content));
+    }
+    return getOrComputeCachedValue(event, ParsedTextContentSymbol, () => {
+        const processor = unified();
+        for (const transformer of transformers) {
+            processor.use(transformer);
+        }
+        return processor.runSync(createTextNoteATS(event, content));
+    });
+}
+export function removeParsedTextContent(event) {
+    // @ts-expect-error
+    delete event[ParsedTextContentSymbol];
+}

package/dist/text/emoji.d.ts

@@ -0,0 +1,4 @@
+import { Transformer } from "unified";
+import { Root } from "../nast/types.js";
+/** Adds emoji tags to text ATS */
+export declare function emojis(): Transformer<Root>;

package/dist/text/emoji.js

@@ -0,0 +1,32 @@
+import { getEmojiTag } from "applesauce-core/helpers/emoji";
+import Expressions from "../helpers/regexp.js";
+import { findAndReplace } from "../nast/find-and-replace.js";
+/** Adds emoji tags to text ATS */
+export function emojis() {
+    return (tree) => {
+        const event = tree.event;
+        if (!event)
+            return;
+        findAndReplace(tree, [
+            [
+                Expressions.emoji,
+                (full, $1) => {
+                    try {
+                        const tag = getEmojiTag(event, $1);
+                        if (!tag)
+                            return false;
+                        return {
+                            type: "emoji",
+                            tag,
+                            raw: full,
+                            code: tag[1].toLowerCase(),
+                            url: tag[2],
+                        };
+                    }
+                    catch (error) { }
+                    return false;
+                },
+            ],
+        ]);
+    };
+}

package/dist/text/gallery.d.ts

@@ -0,0 +1,4 @@
+import { Transformer } from "unified";
+import { Root } from "../nast/types.js";
+/** Groups images into galleries in an ATS tree */
+export declare function galleries(types?: string[]): Transformer<Root>;

package/dist/text/gallery.js

@@ -0,0 +1,48 @@
+import { convertToUrl, getURLFilename, IMAGE_EXT } from "applesauce-core/helpers/url";
+/** Groups images into galleries in an ATS tree */
+export function galleries(types = IMAGE_EXT) {
+    return (tree) => {
+        let links = [];
+        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]);
+                // replace all nodes with a gallery
+                tree.children.splice(start, 1 + end - start, { type: "gallery", links: links.map((l) => l.href) });
+                links = [];
+                // return new cursor
+                return end - 1;
+            }
+            else {
+                links = [];
+                return index;
+            }
+        };
+        for (let i = 0; i < tree.children.length; i++) {
+            const node = tree.children[i];
+            try {
+                if (node.type === "link") {
+                    const url = convertToUrl(node.href);
+                    const filename = getURLFilename(url);
+                    if (filename && types.some((ext) => filename.endsWith(ext))) {
+                        links.push(node);
+                    }
+                    else {
+                        i = commit(i);
+                    }
+                }
+                else if (node.type === "text" && links.length > 0) {
+                    const isEmpty = node.value === "\n" || !node.value.match(/[^\s]/g);
+                    if (!isEmpty)
+                        i = commit(i);
+                }
+            }
+            catch (error) {
+                i = commit(i);
+            }
+        }
+        // Do one finally commit, just in case a link is the last element in the list
+        commit(tree.children.length);
+    };
+}

package/dist/text/hashtag.d.ts

@@ -0,0 +1,3 @@
+import { Transformer } from "unified";
+import { Root } from "../nast/types.js";
+export declare function hashtags(): Transformer<Root>;

package/dist/text/hashtag.js

@@ -0,0 +1,30 @@
+import { getHashtagTag } from "applesauce-core/helpers/hashtag";
+import Expressions from "../helpers/regexp.js";
+import { findAndReplace } from "../nast/find-and-replace.js";
+export function hashtags() {
+    return (tree) => {
+        const event = tree.event;
+        if (!event)
+            return;
+        findAndReplace(tree, [
+            [
+                Expressions.hashtag,
+                (_, $1) => {
+                    try {
+                        const tag = getHashtagTag(event, $1);
+                        if (!tag)
+                            return false;
+                        return {
+                            type: "hashtag",
+                            tag,
+                            name: $1,
+                            hashtag: tag[1].toLowerCase(),
+                        };
+                    }
+                    catch (error) { }
+                    return false;
+                },
+            ],
+        ]);
+    };
+}

package/dist/text/index.d.ts

@@ -0,0 +1,7 @@
+export * from "./content.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";

package/dist/text/index.js

@@ -0,0 +1,7 @@
+export * from "./content.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";

package/dist/text/mentions.d.ts

@@ -0,0 +1,3 @@
+import { Transformer } from "unified";
+import { Root } from "../nast/types.js";
+export declare function nostrMentions(): Transformer<Root>;

package/dist/text/mentions.js

@@ -0,0 +1,23 @@
+import { decode } from "nostr-tools/nip19";
+import Expressions from "../helpers/regexp.js";
+import { findAndReplace } from "../nast/find-and-replace.js";
+export function nostrMentions() {
+    return (tree) => {
+        findAndReplace(tree, [
+            [
+                Expressions.nostrLink,
+                (_, $1) => {
+                    try {
+                        return {
+                            type: "mention",
+                            decoded: decode($1),
+                            encoded: $1,
+                        };
+                    }
+                    catch (error) { }
+                    return false;
+                },
+            ],
+        ]);
+    };
+}

package/dist/text/parser.d.ts

@@ -0,0 +1,4 @@
+import { EventTemplate, NostrEvent } from "nostr-tools";
+import { Root } from "../nast/types.js";
+/** Creates a {@link Root} ATS node for a text note */
+export declare function createTextNoteATS(event: NostrEvent | EventTemplate | string, content?: string): Root;

package/dist/text/parser.js

@@ -0,0 +1,15 @@
+import { tokenize } from "linkifyjs";
+/** Creates a {@link Root} ATS node for a text note */
+export function createTextNoteATS(event, content) {
+    const tokens = tokenize(content || (typeof event === "string" ? event : event.content));
+    return {
+        type: "root",
+        event: typeof event !== "string" ? event : undefined,
+        children: tokens.map((token) => {
+            if (token.isLink)
+                return { type: "link", href: token.toHref(), value: token.toString() };
+            else
+                return { type: "text", value: token.v };
+        }),
+    };
+}

package/package.json

@@ -0,0 +1,72 @@
+{
+  "name": "applesauce-content",
+  "version": "0.0.0-next-20241103143210",
+  "description": "Unified plugins for processing event content",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "keywords": [
+    "nostr"
+  ],
+  "author": "hzrd149",
+  "license": "MIT",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./helpers": {
+      "import": "./dist/helpers/index.js",
+      "types": "./dist/helpers/index.d.ts"
+    },
+    "./nast": {
+      "import": "./dist/nast/index.js",
+      "types": "./dist/nast/index.d.ts"
+    },
+    "./markdown": {
+      "import": "./dist/markdown/index.js",
+      "types": "./dist/markdown/index.d.ts"
+    },
+    "./text": {
+      "import": "./dist/text/index.js",
+      "types": "./dist/text/index.d.ts"
+    }
+  },
+  "dependencies": {
+    "@cashu/cashu-ts": "^1.1.0",
+    "@types/hast": "^3.0.4",
+    "@types/mdast": "^4.0.4",
+    "@types/unist": "^3.0.3",
+    "applesauce-core": "0.0.0-next-20241103143210",
+    "linkifyjs": "^4.1.3",
+    "mdast-util-find-and-replace": "^3.0.1",
+    "nostr-tools": "^2.7.2",
+    "remark": "^15.0.1",
+    "remark-parse": "^11.0.0",
+    "unified": "^11.0.5",
+    "unist-util-visit-parents": "^6.0.1"
+  },
+  "devDependencies": {
+    "@jest/globals": "^29.7.0",
+    "@types/jest": "^29.5.13",
+    "jest": "^29.7.0",
+    "jest-extended": "^4.0.2"
+  },
+  "jest": {
+    "roots": [
+      "dist"
+    ],
+    "setupFilesAfterEnv": [
+      "jest-extended/all"
+    ]
+  },
+  "scripts": {
+    "build": "tsc",
+    "watch:build": "tsc --watch > /dev/null",
+    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js --passWithNoTests",
+    "watch:test": "(trap 'kill 0' SIGINT; pnpm run build -w > /dev/null & pnpm run test --watch)"
+  }
+}