applesauce-core 0.10.0 → 0.11.0

package/dist/helpers/__tests__/comment.test.js

@@ -0,0 +1,235 @@
+import { describe, expect, it } from "vitest";
+import { getCommentAddressPointer, getCommentEventPointer, getCommentExternalPointer, getCommentReplyPointer, getCommentRootPointer, } from "../comment.js";
+import { FakeUser } from "../../__tests__/fixtures.js";
+const user = new FakeUser();
+describe("getCommentRootPointer", () => {
+    it("should throw if event is not a comment", () => {
+        expect(() => {
+            getCommentRootPointer(user.note("testing"));
+        }).toThrow("Event is not a comment");
+    });
+});
+describe("getCommentReplyPointer", () => {
+    it("should throw if event is not a comment", () => {
+        expect(() => {
+            getCommentReplyPointer(user.note("testing"));
+        }).toThrow("Event is not a comment");
+    });
+});
+describe("getCommentEventPointer", () => {
+    it("should get pubkey from P tag when root=true", () => {
+        const tags = [
+            ["E", "86c0b95589b016ffb703bfc080d49e54106e74e2d683295119c3453e494dbe6f"],
+            ["K", "1621"],
+            ["P", "e4336cd525df79fa4d3af364fd9600d4b10dce4215aa4c33ed77ea0842344b10"],
+            ["k", "1621"],
+            ["p", "e4336cd525df79fa4d3af364fd9600d4b10dce4215aa4c33ed77ea0842344b10"],
+            ["e", "86c0b95589b016ffb703bfc080d49e54106e74e2d683295119c3453e494dbe6f"],
+        ];
+        expect(getCommentEventPointer(tags, true)).toEqual({
+            id: "86c0b95589b016ffb703bfc080d49e54106e74e2d683295119c3453e494dbe6f",
+            kind: 1621,
+            pubkey: "e4336cd525df79fa4d3af364fd9600d4b10dce4215aa4c33ed77ea0842344b10",
+            relay: undefined,
+        });
+    });
+    it("should default to pubkey in E tag when root pubkey do not match", () => {
+        const tags = [
+            [
+                "E",
+                "86c0b95589b016ffb703bfc080d49e54106e74e2d683295119c3453e494dbe6f",
+                "",
+                "e4336cd525df79fa4d3af364fd9600d4b10dce4215aa4c33ed77ea0842344b10",
+            ],
+            ["K", "1621"],
+            ["P", "bad-pubkey"],
+        ];
+        expect(getCommentEventPointer(tags, true)).toEqual({
+            id: "86c0b95589b016ffb703bfc080d49e54106e74e2d683295119c3453e494dbe6f",
+            kind: 1621,
+            pubkey: "e4336cd525df79fa4d3af364fd9600d4b10dce4215aa4c33ed77ea0842344b10",
+            relay: undefined,
+        });
+    });
+    it("should get pubkey from E tag", () => {
+        const tags = [
+            [
+                "E",
+                "86c0b95589b016ffb703bfc080d49e54106e74e2d683295119c3453e494dbe6f",
+                "",
+                "e4336cd525df79fa4d3af364fd9600d4b10dce4215aa4c33ed77ea0842344b10",
+            ],
+            ["K", "1621"],
+        ];
+        expect(getCommentEventPointer(tags, true)).toEqual({
+            id: "86c0b95589b016ffb703bfc080d49e54106e74e2d683295119c3453e494dbe6f",
+            kind: 1621,
+            pubkey: "e4336cd525df79fa4d3af364fd9600d4b10dce4215aa4c33ed77ea0842344b10",
+            relay: undefined,
+        });
+    });
+    it("should get relay from E tag", () => {
+        const tags = [
+            ["E", "86c0b95589b016ffb703bfc080d49e54106e74e2d683295119c3453e494dbe6f", "wss://relay.io/"],
+            ["K", "1621"],
+            ["P", "e4336cd525df79fa4d3af364fd9600d4b10dce4215aa4c33ed77ea0842344b10"],
+        ];
+        expect(getCommentEventPointer(tags, true)).toEqual({
+            id: "86c0b95589b016ffb703bfc080d49e54106e74e2d683295119c3453e494dbe6f",
+            kind: 1621,
+            pubkey: "e4336cd525df79fa4d3af364fd9600d4b10dce4215aa4c33ed77ea0842344b10",
+            relay: "wss://relay.io/",
+        });
+    });
+    it("should throw if K tag is missing", () => {
+        const tags = [
+            ["E", "86c0b95589b016ffb703bfc080d49e54106e74e2d683295119c3453e494dbe6f", "wss://relay.io/"],
+            ["P", "e4336cd525df79fa4d3af364fd9600d4b10dce4215aa4c33ed77ea0842344b10"],
+        ];
+        expect(() => {
+            getCommentEventPointer(tags, true);
+        }).toThrow("Missing kind tag");
+    });
+    it("should return null if missing E tag", () => {
+        const tags = [
+            ["K", "1621"],
+            ["P", "e4336cd525df79fa4d3af364fd9600d4b10dce4215aa4c33ed77ea0842344b10"],
+        ];
+        expect(getCommentEventPointer(tags, true)).toBe(null);
+        expect(getCommentEventPointer(tags)).toBe(null);
+    });
+});
+describe("getCommentAddressPointer", () => {
+    it("should get event id from E tag", () => {
+        // root
+        expect(getCommentAddressPointer([
+            ["A", "30000:e4336cd525df79fa4d3af364fd9600d4b10dce4215aa4c33ed77ea0842344b10:list"],
+            ["E", "86c0b95589b016ffb703bfc080d49e54106e74e2d683295119c3453e494dbe6f"],
+            ["K", "30000"],
+        ], true)).toEqual({
+            id: "86c0b95589b016ffb703bfc080d49e54106e74e2d683295119c3453e494dbe6f",
+            kind: 30000,
+            pubkey: "e4336cd525df79fa4d3af364fd9600d4b10dce4215aa4c33ed77ea0842344b10",
+            identifier: "list",
+        });
+        // reply
+        expect(getCommentAddressPointer([
+            ["a", "30000:e4336cd525df79fa4d3af364fd9600d4b10dce4215aa4c33ed77ea0842344b10:list"],
+            ["e", "86c0b95589b016ffb703bfc080d49e54106e74e2d683295119c3453e494dbe6f"],
+            ["k", "30000"],
+        ])).toEqual({
+            id: "86c0b95589b016ffb703bfc080d49e54106e74e2d683295119c3453e494dbe6f",
+            kind: 30000,
+            pubkey: "e4336cd525df79fa4d3af364fd9600d4b10dce4215aa4c33ed77ea0842344b10",
+            identifier: "list",
+        });
+    });
+    it("should get relay from A tag", () => {
+        // root
+        expect(getCommentAddressPointer([
+            ["A", "30000:e4336cd525df79fa4d3af364fd9600d4b10dce4215aa4c33ed77ea0842344b10:list", "wss://relay.io/"],
+            ["K", "30000"],
+        ], true)).toEqual({
+            kind: 30000,
+            pubkey: "e4336cd525df79fa4d3af364fd9600d4b10dce4215aa4c33ed77ea0842344b10",
+            identifier: "list",
+            relay: "wss://relay.io/",
+        });
+        // reply
+        expect(getCommentAddressPointer([
+            ["a", "30000:e4336cd525df79fa4d3af364fd9600d4b10dce4215aa4c33ed77ea0842344b10:list", "wss://relay.io/"],
+            ["k", "30000"],
+        ])).toEqual({
+            kind: 30000,
+            pubkey: "e4336cd525df79fa4d3af364fd9600d4b10dce4215aa4c33ed77ea0842344b10",
+            identifier: "list",
+            relay: "wss://relay.io/",
+        });
+    });
+    it("should get relay from E tag", () => {
+        // root
+        expect(getCommentAddressPointer([
+            ["A", "30000:e4336cd525df79fa4d3af364fd9600d4b10dce4215aa4c33ed77ea0842344b10:list"],
+            ["E", "86c0b95589b016ffb703bfc080d49e54106e74e2d683295119c3453e494dbe6f", "wss://relay.io/"],
+            ["K", "30000"],
+        ], true)).toEqual({
+            id: "86c0b95589b016ffb703bfc080d49e54106e74e2d683295119c3453e494dbe6f",
+            kind: 30000,
+            pubkey: "e4336cd525df79fa4d3af364fd9600d4b10dce4215aa4c33ed77ea0842344b10",
+            identifier: "list",
+            relay: "wss://relay.io/",
+        });
+        // reply
+        expect(getCommentAddressPointer([
+            ["a", "30000:e4336cd525df79fa4d3af364fd9600d4b10dce4215aa4c33ed77ea0842344b10:list"],
+            ["e", "86c0b95589b016ffb703bfc080d49e54106e74e2d683295119c3453e494dbe6f", "wss://relay.io/"],
+            ["k", "30000"],
+        ])).toEqual({
+            id: "86c0b95589b016ffb703bfc080d49e54106e74e2d683295119c3453e494dbe6f",
+            kind: 30000,
+            pubkey: "e4336cd525df79fa4d3af364fd9600d4b10dce4215aa4c33ed77ea0842344b10",
+            identifier: "list",
+            relay: "wss://relay.io/",
+        });
+    });
+    it("should return A tag kind over K tag", () => {
+        // root
+        expect(getCommentAddressPointer([
+            ["A", "30010:e4336cd525df79fa4d3af364fd9600d4b10dce4215aa4c33ed77ea0842344b10:list"],
+            ["K", "30000"],
+        ], true)).toEqual({
+            kind: 30010,
+            pubkey: "e4336cd525df79fa4d3af364fd9600d4b10dce4215aa4c33ed77ea0842344b10",
+            identifier: "list",
+        });
+        // reply
+        expect(getCommentAddressPointer([
+            ["a", "30010:e4336cd525df79fa4d3af364fd9600d4b10dce4215aa4c33ed77ea0842344b10:list"],
+            ["k", "30000"],
+        ])).toEqual({
+            kind: 30010,
+            pubkey: "e4336cd525df79fa4d3af364fd9600d4b10dce4215aa4c33ed77ea0842344b10",
+            identifier: "list",
+        });
+    });
+    it("should throw if missing K tag", () => {
+        // root
+        expect(() => getCommentAddressPointer([["A", "30010:e4336cd525df79fa4d3af364fd9600d4b10dce4215aa4c33ed77ea0842344b10:list"]], true)).toThrow("Missing kind tag");
+        // reply
+        expect(() => getCommentAddressPointer([["a", "30010:e4336cd525df79fa4d3af364fd9600d4b10dce4215aa4c33ed77ea0842344b10:list"]])).toThrow("Missing kind tag");
+    });
+    it("should return null if missing A tag", () => {
+        const tags = [
+            ["K", "1621"],
+            ["P", "e4336cd525df79fa4d3af364fd9600d4b10dce4215aa4c33ed77ea0842344b10"],
+        ];
+        expect(getCommentEventPointer(tags, true)).toBe(null);
+        expect(getCommentEventPointer(tags)).toBe(null);
+    });
+});
+describe("getCommentExternalPointer", () => {
+    it("should get kind prefix from I tag", () => {
+        // root
+        expect(getCommentExternalPointer([
+            ["I", "podcast:item:guid:d98d189b-dc7b-45b1-8720-d4b98690f31f"],
+            ["K", "podcast:item:guid"],
+        ], true)).toEqual({
+            identifier: "podcast:item:guid:d98d189b-dc7b-45b1-8720-d4b98690f31f",
+            kind: "podcast:item:guid",
+        });
+        // reply
+        expect(getCommentExternalPointer([
+            ["i", "podcast:item:guid:d98d189b-dc7b-45b1-8720-d4b98690f31f"],
+            ["k", "podcast:item:guid"],
+        ])).toEqual({
+            identifier: "podcast:item:guid:d98d189b-dc7b-45b1-8720-d4b98690f31f",
+            kind: "podcast:item:guid",
+        });
+    });
+    it("should throw if missing K tag", () => {
+        // root
+        expect(() => getCommentExternalPointer([["I", "podcast:item:guid:d98d189b-dc7b-45b1-8720-d4b98690f31f"]], true)).toThrow("Missing kind tag");
+        // reply
+        expect(() => getCommentExternalPointer([["i", "podcast:item:guid:d98d189b-dc7b-45b1-8720-d4b98690f31f"]])).toThrow("Missing kind tag");
+    });
+});

package/dist/helpers/__tests__/emoji.test.d.ts

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

package/dist/helpers/__tests__/emoji.test.js

@@ -0,0 +1,15 @@
+import { describe, expect, it } from "vitest";
+import { getEmojiTag } from "../emoji.js";
+import { FakeUser } from "../../__tests__/fixtures.js";
+const user = new FakeUser();
+describe("getEmojiTag", () => {
+    it("Should find emoji tag", () => {
+        expect(getEmojiTag(user.note("hello :custom:", { tags: [["emoji", "custom", "https://cdn.example.com/reaction1.png"]] }), "custom")).toEqual(["emoji", "custom", "https://cdn.example.com/reaction1.png"]);
+    });
+    it("Should custom leading and trailing :", () => {
+        expect(getEmojiTag(user.note("hello :custom:", { tags: [["emoji", "custom", "https://cdn.example.com/reaction1.png"]] }), ":custom:")).toEqual(["emoji", "custom", "https://cdn.example.com/reaction1.png"]);
+    });
+    it("Should convert to lowercase", () => {
+        expect(getEmojiTag(user.note("hello :custom:", { tags: [["emoji", "custom", "https://cdn.example.com/reaction1.png"]] }), "CustoM")).toEqual(["emoji", "custom", "https://cdn.example.com/reaction1.png"]);
+    });
+});

package/dist/helpers/__tests__/event.test.d.ts

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

package/dist/helpers/__tests__/event.test.js

@@ -0,0 +1,36 @@
+import { describe, expect, it } from "vitest";
+import { EventIndexableTagsSymbol, getIndexableTags, getTagValue } from "../event.js";
+const event = {
+    content: "",
+    created_at: 1732889913,
+    id: "2d53511f321cc82dd13eedfb597c9fe834d12d271c10d8068e9d8cfb8f58d1b4",
+    kind: 30000,
+    pubkey: "266815e0c9210dfa324c6cba3573b14bee49da4209a9456f9484e5106cd408a5",
+    sig: "e6a442487ef44a8a00ec1e0a852e547991fcd5cbf19aa1a4219fa65d6f41022675e0745207649f4b16fe9a6c5c7c3693dc3e13966ffa5b2891634867c874cf22",
+    tags: [
+        ["d", "qRxLhBbTfRlxsvKSu0iUl"],
+        ["title", "Musicians"],
+        ["client", "noStrudel", "31990:266815e0c9210dfa324c6cba3573b14bee49da4209a9456f9484e5106cd408a5:1686066542546"],
+        ["p", "2842e34860c59dfacd5df48ba7a65065e6760d08c35f779553d83c2c2310b493"],
+        ["p", "28ca019b78b494c25a9da2d645975a8501c7e99b11302e5cbe748ee593fcb2cc"],
+        ["p", "f46192b8b9be1b43fc30ea27c7cb16210aede17252b3aa9692fbb3f2ba153199"],
+    ],
+};
+describe("getIndexableTags", () => {
+    it("should return a set of indexable tags for event", () => {
+        expect(Array.from(getIndexableTags(event))).toEqual(expect.arrayContaining([
+            "p:2842e34860c59dfacd5df48ba7a65065e6760d08c35f779553d83c2c2310b493",
+            "p:28ca019b78b494c25a9da2d645975a8501c7e99b11302e5cbe748ee593fcb2cc",
+            "p:f46192b8b9be1b43fc30ea27c7cb16210aede17252b3aa9692fbb3f2ba153199",
+        ]));
+    });
+    it("should cache value on EventIndexableTagsSymbol", () => {
+        getIndexableTags(event);
+        expect(Reflect.has(event, EventIndexableTagsSymbol)).toBe(true);
+    });
+});
+describe("getTagValue", () => {
+    it("should return value of tag if present", () => {
+        expect(getTagValue(event, "title")).toBe("Musicians");
+    });
+});

package/dist/helpers/__tests__/file-metadata.test.d.ts

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

package/dist/helpers/__tests__/file-metadata.test.js

@@ -0,0 +1,103 @@
+import { describe, expect, it } from "vitest";
+import { getFileMetadataFromImetaTag, parseFileMetadataTags } from "../file-metadata.js";
+describe("file metadata helpers", () => {
+    describe("parseFileMetadataTags", () => {
+        it("should parse a simple 1060 event", () => {
+            const tags = [
+                ["url", "https://image.nostr.build/30696696e57a2732d4e9f1b15ff4d4d4eaa64b759df6876863f436ff5d736eae.gif"],
+                ["ox", "30696696e57a2732d4e9f1b15ff4d4d4eaa64b759df6876863f436ff5d736eae"],
+                ["fallback", "https://media.tenor.com/wpvrkjn192gAAAAC/daenerys-targaryen.gif"],
+                ["x", "77fcf42b2b720babcdbe686eff67273d8a68862d74a2672db672bc48439a3ea5"],
+                ["m", "image/gif"],
+                ["dim", "360x306"],
+                ["bh", "L38zleNL00~W^kRj0L-p0KM_^kx]"],
+                ["blurhash", "L38zleNL00~W^kRj0L-p0KM_^kx]"],
+                [
+                    "thumb",
+                    "https://image.nostr.build/thumb/30696696e57a2732d4e9f1b15ff4d4d4eaa64b759df6876863f436ff5d736eae.gif",
+                ],
+                ["t", "gifbuddy"],
+                ["summary", "Khaleesi call dragons Daenerys Targaryen"],
+                ["alt", "a woman with blonde hair and a brooch on her shoulder"],
+                [
+                    "thumb",
+                    "https://media.tenor.com/wpvrkjn192gAAAAx/daenerys-targaryen.webp",
+                    "5d92423664fc15874b1d26c70a05a541ec09b5c438bf157977a87c8e64b31463",
+                ],
+                [
+                    "image",
+                    "https://media.tenor.com/wpvrkjn192gAAAAe/daenerys-targaryen.png",
+                    "5d92423664fc15874b1d26c70a05a541ec09b5c438bf157977a87c8e64b31463",
+                ],
+            ];
+            expect(parseFileMetadataTags(tags)).toEqual({
+                url: "https://image.nostr.build/30696696e57a2732d4e9f1b15ff4d4d4eaa64b759df6876863f436ff5d736eae.gif",
+                type: "image/gif",
+                dimensions: "360x306",
+                blurhash: "L38zleNL00~W^kRj0L-p0KM_^kx]",
+                sha256: "77fcf42b2b720babcdbe686eff67273d8a68862d74a2672db672bc48439a3ea5",
+                originalSha256: "30696696e57a2732d4e9f1b15ff4d4d4eaa64b759df6876863f436ff5d736eae",
+                thumbnail: "https://media.tenor.com/wpvrkjn192gAAAAx/daenerys-targaryen.webp",
+                image: "https://media.tenor.com/wpvrkjn192gAAAAe/daenerys-targaryen.png",
+                summary: "Khaleesi call dragons Daenerys Targaryen",
+                fallback: ["https://media.tenor.com/wpvrkjn192gAAAAC/daenerys-targaryen.gif"],
+                alt: "a woman with blonde hair and a brooch on her shoulder",
+            });
+        });
+    });
+    describe("getFileMetadataFromImetaTag", () => {
+        it("should parse simple imeta tag", () => {
+            expect(getFileMetadataFromImetaTag([
+                "imeta",
+                "url https://blossom.primal.net/3f4dbf2797ac4e90b00bcfe2728e5c8367ed909c48230ac454cc325f1993646c.jpg",
+                "x 3f4dbf2797ac4e90b00bcfe2728e5c8367ed909c48230ac454cc325f1993646c",
+                "dim 1024x1024",
+                "m image/jpeg",
+                "blurhash ggH{Aws:RPWBRjaeay?^ozV@aeRjaej[$gt7kCofWVofkCrrofxuofa|ozbHx]s:tRofaet7ay",
+            ])).toEqual({
+                url: "https://blossom.primal.net/3f4dbf2797ac4e90b00bcfe2728e5c8367ed909c48230ac454cc325f1993646c.jpg",
+                sha256: "3f4dbf2797ac4e90b00bcfe2728e5c8367ed909c48230ac454cc325f1993646c",
+                dimensions: "1024x1024",
+                type: "image/jpeg",
+                blurhash: "ggH{Aws:RPWBRjaeay?^ozV@aeRjaej[$gt7kCofWVofkCrrofxuofa|ozbHx]s:tRofaet7ay",
+            });
+        });
+        it("should parse thumbnail url", () => {
+            expect(getFileMetadataFromImetaTag([
+                "imeta",
+                "url https://blossom.primal.net/3f4dbf2797ac4e90b00bcfe2728e5c8367ed909c48230ac454cc325f1993646c.jpg",
+                "x 3f4dbf2797ac4e90b00bcfe2728e5c8367ed909c48230ac454cc325f1993646c",
+                "dim 1024x1024",
+                "m image/jpeg",
+                "blurhash ggH{Aws:RPWBRjaeay?^ozV@aeRjaej[$gt7kCofWVofkCrrofxuofa|ozbHx]s:tRofaet7ay",
+                "thumb https://exmaple.com/thumb.jpg",
+            ])).toEqual({
+                url: "https://blossom.primal.net/3f4dbf2797ac4e90b00bcfe2728e5c8367ed909c48230ac454cc325f1993646c.jpg",
+                sha256: "3f4dbf2797ac4e90b00bcfe2728e5c8367ed909c48230ac454cc325f1993646c",
+                dimensions: "1024x1024",
+                type: "image/jpeg",
+                blurhash: "ggH{Aws:RPWBRjaeay?^ozV@aeRjaej[$gt7kCofWVofkCrrofxuofa|ozbHx]s:tRofaet7ay",
+                thumbnail: "https://exmaple.com/thumb.jpg",
+            });
+        });
+        it("should parse multiple fallback urls", () => {
+            expect(getFileMetadataFromImetaTag([
+                "imeta",
+                "url https://blossom.primal.net/3f4dbf2797ac4e90b00bcfe2728e5c8367ed909c48230ac454cc325f1993646c.jpg",
+                "x 3f4dbf2797ac4e90b00bcfe2728e5c8367ed909c48230ac454cc325f1993646c",
+                "dim 1024x1024",
+                "m image/jpeg",
+                "blurhash ggH{Aws:RPWBRjaeay?^ozV@aeRjaej[$gt7kCofWVofkCrrofxuofa|ozbHx]s:tRofaet7ay",
+                "fallback https://exmaple.com/image2.jpg",
+                "fallback https://exmaple.com/image3.jpg",
+            ])).toEqual({
+                url: "https://blossom.primal.net/3f4dbf2797ac4e90b00bcfe2728e5c8367ed909c48230ac454cc325f1993646c.jpg",
+                sha256: "3f4dbf2797ac4e90b00bcfe2728e5c8367ed909c48230ac454cc325f1993646c",
+                dimensions: "1024x1024",
+                type: "image/jpeg",
+                blurhash: "ggH{Aws:RPWBRjaeay?^ozV@aeRjaej[$gt7kCofWVofkCrrofxuofa|ozbHx]s:tRofaet7ay",
+                fallback: ["https://exmaple.com/image2.jpg", "https://exmaple.com/image3.jpg"],
+            });
+        });
+    });
+});

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

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

package/dist/helpers/{hidden-tags.test.js → __tests__/hidden-tags.test.js}

@@ -1,6 +1,7 @@
 import { describe, beforeEach, it, expect } from "vitest";
-import { getHiddenTags, unixNow, unlockHiddenTags } from "applesauce-core/helpers";
 import { finalizeEvent, generateSecretKey, getPublicKey, kinds, nip04 } from "nostr-tools";
+import { getHiddenTags, unlockHiddenTags } from "../hidden-tags.js";
+import { unixNow } from "../time.js";
 const key = generateSecretKey();
 const pubkey = getPublicKey(key);
 const signer = {

package/dist/helpers/__tests__/mailboxes.test.d.ts

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

package/dist/helpers/{mailboxes.test.js → __tests__/mailboxes.test.js}

@@ -1,5 +1,5 @@
 import { describe, test, expect } from "vitest";
-import { getInboxes, getOutboxes } from "./mailboxes.js";
+import { getInboxes, getOutboxes } from "../mailboxes.js";
 const emptyEvent = {
     kind: 10002,
     content: "",

package/dist/helpers/__tests__/relays.test.d.ts

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

package/dist/helpers/__tests__/relays.test.js

@@ -0,0 +1,21 @@
+import { describe, expect, it } from "vitest";
+import { isSafeRelayURL } from "../relays.js";
+describe("isSafeRelayURL", () => {
+    it("should correctly filter URLs", () => {
+        // safe URLs
+        expect(isSafeRelayURL("wss://relay.damus.io/")).toBe(true);
+        expect(isSafeRelayURL("wss://nostrue.com")).toBe(true);
+        expect(isSafeRelayURL("ws://192.168.0.194:8080")).toBe(true);
+        expect(isSafeRelayURL("ws://localhost:4869/ws")).toBe(true);
+        expect(isSafeRelayURL("ws://localhost/testing")).toBe(true);
+        expect(isSafeRelayURL("ws://437fqnfqtcaquzvs5sd43ugznw7dsoatvtskoowgnpn6q5vqkljcrsyd.onion")).toBe(true);
+        expect(isSafeRelayURL("ws://hypr1fk4trjnhjf62r6hhkpettmvxhxx2uvkkg4u4ea44va2fvxvfkl4s82m6dy.hyper")).toBe(true);
+        // bad URLs
+        expect(isSafeRelayURL("")).toBe(false);
+        expect(isSafeRelayURL("bad")).toBe(false);
+        expect(isSafeRelayURL("bad wss://nostr.wine")).toBe(false);
+        expect(isSafeRelayURL("http://nostr.wine")).toBe(false);
+        expect(isSafeRelayURL("http://cache-relay.com")).toBe(false);
+        expect(isSafeRelayURL("wss://nostr.wine,wss://relayable.com")).toBe(false);
+    });
+});

package/dist/helpers/__tests__/tags.test.d.ts

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

package/dist/helpers/__tests__/tags.test.js

@@ -0,0 +1,24 @@
+import { describe, expect, it } from "vitest";
+import { isATag, isNameValueTag, processTags } from "../tags.js";
+import { getAddressPointerFromATag } from "../pointers.js";
+describe("isNameValueTag", () => {
+    it("should return true if tag has at least two indexes", () => {
+        expect(isNameValueTag(["a", "30000:pubkey:list"])).toBe(true);
+        expect(isNameValueTag(["title", "article", "other-value"])).toBe(true);
+    });
+    it("should ignore tags without values", () => {
+        expect(isNameValueTag(["a"])).toBe(false);
+        expect(isNameValueTag(["title"])).toBe(false);
+    });
+});
+describe("processTags", () => {
+    it("should filter out errors", () => {
+        expect(processTags([["a", "bad coordinate"], ["e"], ["a", "30000:pubkey:list"]], getAddressPointerFromATag)).toEqual([{ identifier: "list", kind: 30000, pubkey: "pubkey" }]);
+    });
+    it("should filter out undefined", () => {
+        expect(processTags([["a", "bad coordinate"], ["e"], ["a", "30000:pubkey:list"]], (tag) => isATag(tag) ? tag : undefined)).toEqual([
+            ["a", "bad coordinate"],
+            ["a", "30000:pubkey:list"],
+        ]);
+    });
+});

package/dist/helpers/__tests__/threading.test.d.ts

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

package/dist/helpers/{threading.test.js → __tests__/threading.test.js}

@@ -1,5 +1,5 @@
 import { describe, expect, it } from "vitest";
-import { interpretThreadTags } from "./threading.js";
+import { interpretThreadTags } from "../threading.js";
 describe("threading helpers", () => {
     describe("interpretThreadTags", () => {
         it("should handle legacy tags", () => {

package/dist/helpers/blossom.d.ts

@@ -0,0 +1,9 @@
+export declare const BLOSSOM_SERVER_LIST_KIND = 10063;
+/** Check if two servers are the same */
+export declare function areBlossomServersEqual(a: string | URL, b: string | URL): boolean;
+/** Checks if a string is a sha256 hash */
+export declare function isSha256(str: string): boolean;
+/** Returns an ordered array of servers found in a server list event (10063) */
+export declare function getBlossomServersFromList(event: {
+    tags: string[][];
+} | string[][]): URL[];

package/dist/helpers/blossom.js

@@ -0,0 +1,22 @@
+import { isNameValueTag, processTags } from "./tags.js";
+export const BLOSSOM_SERVER_LIST_KIND = 10063;
+/** Check if two servers are the same */
+export function areBlossomServersEqual(a, b) {
+    const hostnameA = new URL("/", a).toString();
+    const hostnameB = new URL("/", b).toString();
+    return hostnameA === hostnameB;
+}
+/** Checks if a string is a sha256 hash */
+export function isSha256(str) {
+    return !!str.match(/^[0-9a-f]{64}$/);
+}
+/** Returns an ordered array of servers found in a server list event (10063) */
+export function getBlossomServersFromList(event) {
+    const tags = Array.isArray(event) ? event : event.tags;
+    return processTags(tags, (tag) => {
+        if (isNameValueTag(tag, "server") && URL.canParse(tag[1]))
+            return new URL("/", tag[1]);
+        else
+            return undefined;
+    });
+}

package/dist/helpers/bookmarks.d.ts

@@ -0,0 +1,15 @@
+import { NostrEvent } from "nostr-tools";
+import { AddressPointer, EventPointer } from "nostr-tools/nip19";
+export declare const BookmarkPublicSymbol: unique symbol;
+export declare const BookmarkHiddenSymbol: unique symbol;
+export type Bookmarks = {
+    notes: EventPointer[];
+    articles: AddressPointer[];
+    hashtags: string[];
+    urls: string[];
+};
+export declare function parseBookmarkTags(tags: string[][]): Bookmarks;
+/** Returns the public bookmarks of the event */
+export declare function getBookmarks(bookmark: NostrEvent): Bookmarks;
+/** Returns the bookmarks of the event if its unlocked */
+export declare function getHiddenBookmarks(bookmark: NostrEvent): Bookmarks | undefined;

package/dist/helpers/bookmarks.js

@@ -0,0 +1,27 @@
+import { kinds } from "nostr-tools";
+import { getAddressPointerFromATag, getEventPointerFromETag } from "./pointers.js";
+import { getOrComputeCachedValue } from "./cache.js";
+import { getHiddenTags } from "./index.js";
+export const BookmarkPublicSymbol = Symbol.for("bookmark-public");
+export const BookmarkHiddenSymbol = Symbol.for("bookmark-hidden");
+export function parseBookmarkTags(tags) {
+    const notes = tags.filter((t) => t[0] === "e" && t[1]).map(getEventPointerFromETag);
+    const articles = tags
+        .filter((t) => t[0] === "a" && t[1])
+        .map(getAddressPointerFromATag)
+        .filter((addr) => addr.kind === kinds.LongFormArticle);
+    const hashtags = tags.filter((t) => t[0] === "t" && t[1]).map((t) => t[1]);
+    const urls = tags.filter((t) => t[0] === "r" && t[1]).map((t) => t[1]);
+    return { notes, articles, hashtags, urls };
+}
+/** Returns the public bookmarks of the event */
+export function getBookmarks(bookmark) {
+    return getOrComputeCachedValue(bookmark, BookmarkPublicSymbol, () => parseBookmarkTags(bookmark.tags));
+}
+/** Returns the bookmarks of the event if its unlocked */
+export function getHiddenBookmarks(bookmark) {
+    return getOrComputeCachedValue(bookmark, BookmarkHiddenSymbol, () => {
+        const tags = getHiddenTags(bookmark);
+        return tags && parseBookmarkTags(tags);
+    });
+}

package/dist/helpers/channels.d.ts

@@ -0,0 +1,10 @@
+import { nip19, NostrEvent } from "nostr-tools";
+import { ChannelMetadata } from "nostr-tools/nip28";
+export declare const ChannelMetadataSymbol: unique symbol;
+export type ChannelMetadataContent = ChannelMetadata & {
+    relays?: string[];
+};
+/** Gets the parsed metadata on a channel creation or channel metadata event */
+export declare function getChannelMetadataContent(channel: NostrEvent): ChannelMetadataContent;
+/** gets the EventPointer for a channel message or metadata event */
+export declare function getChannelPointer(event: NostrEvent): nip19.EventPointer | undefined;

package/dist/helpers/channels.js

@@ -0,0 +1,27 @@
+import { getOrComputeCachedValue } from "./cache.js";
+export const ChannelMetadataSymbol = Symbol.for("channel-metadata");
+function parseChannelMetadataContent(channel) {
+    const metadata = JSON.parse(channel.content);
+    if (metadata.name === undefined)
+        throw new Error("Missing name");
+    if (metadata.about === undefined)
+        throw new Error("Missing about");
+    if (metadata.picture === undefined)
+        throw new Error("Missing picture");
+    if (metadata.relays && !Array.isArray(metadata.relays))
+        throw new Error("Invalid relays");
+    return metadata;
+}
+/** Gets the parsed metadata on a channel creation or channel metadata event */
+export function getChannelMetadataContent(channel) {
+    return getOrComputeCachedValue(channel, ChannelMetadataSymbol, () => {
+        return parseChannelMetadataContent(channel);
+    });
+}
+/** gets the EventPointer for a channel message or metadata event */
+export function getChannelPointer(event) {
+    const tag = event.tags.find((t) => t[0] === "e" && t[1]);
+    if (!tag)
+        return undefined;
+    return tag[2] ? { id: tag[1], relays: [tag[2]] } : { id: tag[1] };
+}

package/dist/helpers/comment.d.ts

@@ -1,20 +1,20 @@
 import { NostrEvent } from "nostr-tools";
 import { ExternalPointer, ExternalIdentifiers } from "./external-id.js";
 export declare const COMMENT_KIND = 1111;
-type CommentEventPointer = {
+export type CommentEventPointer = {
     id: string;
     kind: number;
     pubkey?: string;
     relay?: string;
 };
-type CommentAddressPointer = {
+export type CommentAddressPointer = {
     id?: string;
     kind: number;
     pubkey: string;
     identifier: string;
     relay?: string;
 };
-type CommentExternalPointer = ExternalPointer<keyof ExternalIdentifiers>;
+export type CommentExternalPointer = ExternalPointer<keyof ExternalIdentifiers>;
 export type CommentPointer = CommentEventPointer | CommentAddressPointer | CommentExternalPointer;
 export declare const CommentRootPointerSymbol: unique symbol;
 export declare const CommentReplyPointerSymbol: unique symbol;
@@ -45,4 +45,3 @@ export declare function getCommentRootPointer(comment: NostrEvent): CommentPoint
 export declare function getCommentReplyPointer(comment: NostrEvent): CommentPointer | null;
 export declare function isCommentEventPointer(pointer: any): pointer is CommentEventPointer;
 export declare function isCommentAddressPointer(pointer: any): pointer is CommentAddressPointer;
-export {};