npm - applesauce-core - Versions diffs - 0.0.0-next-20250219163923 → 0.0.0-next-20250221155809 - Mend

applesauce-core 0.0.0-next-20250219163923 → 0.0.0-next-20250221155809

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (4) hide show

package/dist/helpers/__tests__/comment.test.d.ts +1 -0
package/dist/helpers/__tests__/comment.test.js +235 -0
package/dist/helpers/comment.js +19 -15
package/package.json +1 -1

package/dist/helpers/__tests__/comment.test.d.ts ADDED Viewed

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

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

@@ -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/comment.js CHANGED Viewed

@@ -10,16 +10,18 @@ export const CommentReplyPointerSymbol = Symbol.for("comment-reply-pointer");
  * @throws
  */
 export function getCommentEventPointer(tags, root = false) {
-    const tag = tags.find((t) => t[0] === (root ? "E" : "e"));
+    const eTag = tags.find((t) => t[0] === (root ? "E" : "e"));
     const kind = tags.find((t) => t[0] === (root ? "K" : "k"))?.[1];
-    if (tag) {
+    if (eTag) {
         if (!kind)
             throw new Error("Missing kind tag");
+        // only the root pubkey can be gotten from the tags, since due to quotes and mentions there will be many "p" tags for replies
+        const rootPubkey = root ? tags.find((t) => t[0] === "P")?.[1] : undefined;
         const pointer = {
-            id: tag[1],
+            id: eTag[1],
             kind: parseInt(kind),
-            pubkey: tag[3] || undefined,
-            relay: tag[2] && isSafeRelayURL(tag[2]) ? tag[2] : undefined,
+            pubkey: eTag[3] || rootPubkey || undefined,
+            relay: eTag[2] && isSafeRelayURL(eTag[2]) ? eTag[2] : undefined,
         };
         return pointer;
     }
@@ -30,16 +32,19 @@ export function getCommentEventPointer(tags, root = false) {
  * @throws
  */
 export function getCommentAddressPointer(tags, root = false) {
-    const tag = tags.find((t) => t[0] === (root ? "A" : "a"));
-    const id = tags.find((t) => t[0] === (root ? "E" : "e"))?.[1];
+    const aTag = tags.find((t) => t[0] === (root ? "A" : "a"));
+    const eTag = tags.find((t) => t[0] === (root ? "E" : "e"));
     const kind = tags.find((t) => t[0] === (root ? "K" : "k"))?.[1];
-    if (tag) {
+    if (aTag) {
         if (!kind)
             throw new Error("Missing kind tag");
+        const addressPointer = getAddressPointerFromATag(aTag);
         const pointer = {
-            id,
-            ...getAddressPointerFromATag(tag),
-            kind: parseInt(kind),
+            id: eTag?.[1],
+            pubkey: addressPointer.pubkey,
+            identifier: addressPointer.identifier,
+            kind: addressPointer.kind || parseInt(kind),
+            relay: addressPointer.relays?.[0] || eTag?.[2],
         };
         return pointer;
     }
@@ -50,13 +55,12 @@ export function getCommentAddressPointer(tags, root = false) {
  * @throws
  */
 export function getCommentExternalPointer(tags, root = false) {
-    const tag = tags.find((t) => t[0] === (root ? "I" : "i"));
+    const iTag = tags.find((t) => t[0] === (root ? "I" : "i"));
     const kind = tags.find((t) => t[0] === (root ? "K" : "k"))?.[1];
-    if (tag) {
+    if (iTag) {
         if (!kind)
             throw new Error("Missing kind tag");
-        const pointer = getExternalPointerFromTag(tag);
-        return pointer;
+        return getExternalPointerFromTag(iTag);
     }
     return null;
 }

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "applesauce-core",
-  "version": "0.0.0-next-20250219163923",
+  "version": "0.0.0-next-20250221155809",
   "description": "",
   "type": "module",
   "main": "dist/index.js",