applesauce-actions 0.0.0-next-20250314151125 → 0.0.0-next-20250315140539

package/dist/actions/__tests__/follow-sets.test.d.ts

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

package/dist/actions/__tests__/follow-sets.test.js

@@ -0,0 +1,80 @@
+import { beforeEach, describe, expect, it } from "vitest";
+import { EventStore } from "applesauce-core";
+import { EventFactory } from "applesauce-factory";
+import { kinds } from "nostr-tools";
+import { unlockHiddenTags } from "applesauce-core/helpers";
+import { subscribeSpyTo } from "@hirez_io/observer-spy";
+import { FakeUser } from "../../__tests__/fake-user.js";
+import { ActionHub } from "../../action-hub.js";
+import { AddUserToFollowSet, RemoveUserFromFollowSet } from "../follow-sets.js";
+const user = new FakeUser();
+const testPubkey = "test-pubkey";
+const testIdentifier = "test-list";
+let events;
+let factory;
+let hub;
+beforeEach(() => {
+    events = new EventStore();
+    factory = new EventFactory({ signer: user });
+    hub = new ActionHub(events, factory);
+    // Add a follow set event to work with
+    const followSet = user.event({
+        kind: kinds.Followsets,
+        tags: [["d", testIdentifier]],
+        content: "",
+        created_at: Math.floor(Date.now() / 1000),
+    });
+    events.add(followSet);
+});
+describe("AddUserToList", () => {
+    it("should add a pubkey to public tags in a follow set", async () => {
+        const spy = subscribeSpyTo(hub.exec(AddUserToFollowSet, testPubkey, testIdentifier), { expectErrors: false });
+        await spy.onComplete();
+        const emittedEvent = spy.getLastValue();
+        expect(emittedEvent).toMatchObject({
+            kind: kinds.Followsets,
+            tags: expect.arrayContaining([
+                ["d", testIdentifier],
+                ["p", testPubkey],
+            ]),
+        });
+    });
+    it("should add a pubkey to hidden tags in a follow set", async () => {
+        const spy = subscribeSpyTo(hub.exec(AddUserToFollowSet, testPubkey, testIdentifier, true), { expectErrors: false });
+        await spy.onComplete();
+        const emittedEvent = spy.getLastValue();
+        expect(await unlockHiddenTags(emittedEvent, user)).toEqual(expect.arrayContaining([["p", testPubkey]]));
+    });
+});
+describe("RemoveUserFromList", () => {
+    beforeEach(async () => {
+        // Add a follow set with existing tags to remove
+        const followSetWithTags = user.event({
+            kind: kinds.Followsets,
+            tags: [
+                ["d", testIdentifier],
+                ["p", testPubkey],
+            ],
+            content: await user.nip04.encrypt(user.pubkey, JSON.stringify(["p", testPubkey])),
+            created_at: Math.floor(Date.now() / 1000),
+        });
+        events.add(followSetWithTags);
+    });
+    it("should remove a pubkey from public tags in a follow set", async () => {
+        const spy = subscribeSpyTo(hub.exec(RemoveUserFromFollowSet, testPubkey, testIdentifier), { expectErrors: false });
+        await spy.onComplete();
+        const emittedEvent = spy.getLastValue();
+        expect(emittedEvent).toMatchObject({
+            kind: kinds.Followsets,
+            tags: expect.not.arrayContaining([["p", testPubkey]]),
+        });
+    });
+    it("should remove a pubkey from hidden tags in a follow set", async () => {
+        const spy = subscribeSpyTo(hub.exec(RemoveUserFromFollowSet, testPubkey, testIdentifier, true), {
+            expectErrors: false,
+        });
+        await spy.onComplete();
+        const emittedEvent = spy.getLastValue();
+        expect(await unlockHiddenTags(emittedEvent, user)).toEqual(expect.not.arrayContaining([["hidden", "p", testPubkey]]));
+    });
+});

package/dist/actions/follow-sets.d.ts

@@ -0,0 +1,15 @@
+import { Action } from "../action-hub.js";
+/**
+ * An action that adds a pubkey to a follow set
+ * @param pubkey the pubkey to add to the set
+ * @param identifier the "d" tag of the follow set
+ * @param hidden set to true to add to hidden follows
+ */
+export declare function AddUserToFollowSet(pubkey: string, identifier: string, hidden?: boolean): Action;
+/**
+ * An action that removes a pubkey from a follow set
+ * @param pubkey the pubkey to remove from the set
+ * @param identifier the "d" tag of the follow set
+ * @param hidden set to true to remove from hidden follows
+ */
+export declare function RemoveUserFromFollowSet(pubkey: string, identifier: string, hidden?: boolean): Action;

package/dist/actions/follow-sets.js

@@ -0,0 +1,37 @@
+import { kinds } from "nostr-tools";
+import { addPubkeyTag, removePubkeyTag } from "applesauce-factory/operations/tag";
+function getFollowSetEvent(events, self, identifier) {
+    return events.getReplaceable(kinds.Followsets, self, identifier);
+}
+/**
+ * An action that adds a pubkey to a follow set
+ * @param pubkey the pubkey to add to the set
+ * @param identifier the "d" tag of the follow set
+ * @param hidden set to true to add to hidden follows
+ */
+export function AddUserToFollowSet(pubkey, identifier, hidden = false) {
+    return async function* ({ events, factory, self }) {
+        const follows = getFollowSetEvent(events, self, identifier);
+        if (!follows)
+            throw new Error("Can't find follow set");
+        const operation = addPubkeyTag({ pubkey });
+        const draft = await factory.modifyTags(follows, hidden ? { hidden: operation } : operation);
+        yield await factory.sign(draft);
+    };
+}
+/**
+ * An action that removes a pubkey from a follow set
+ * @param pubkey the pubkey to remove from the set
+ * @param identifier the "d" tag of the follow set
+ * @param hidden set to true to remove from hidden follows
+ */
+export function RemoveUserFromFollowSet(pubkey, identifier, hidden = false) {
+    return async function* ({ events, factory, self }) {
+        const follows = getFollowSetEvent(events, self, identifier);
+        if (!follows)
+            throw new Error("Can't find follow set");
+        const operation = removePubkeyTag(pubkey);
+        const draft = await factory.modifyTags(follows, hidden ? { hidden: operation } : operation);
+        yield await factory.sign(draft);
+    };
+}

package/dist/actions/index.d.ts

@@ -1,4 +1,5 @@
-export * from "./contacts.js";
 export * from "./bookmarks.js";
+export * from "./contacts.js";
+export * from "./follow-sets.js";
 export * from "./pins.js";
 export * from "./profile.js";

package/dist/actions/index.js

@@ -1,4 +1,5 @@
-export * from "./contacts.js";
 export * from "./bookmarks.js";
+export * from "./contacts.js";
+export * from "./follow-sets.js";
 export * from "./pins.js";
 export * from "./profile.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "applesauce-actions",
-  "version": "0.0.0-next-20250314151125",
+  "version": "0.0.0-next-20250315140539",
   "description": "A package for performing common nostr actions",
   "type": "module",
   "main": "dist/index.js",
@@ -32,15 +32,15 @@
     }
   },
   "dependencies": {
-    "applesauce-core": "0.0.0-next-20250314151125",
-    "applesauce-factory": "0.0.0-next-20250314151125",
+    "applesauce-core": "0.0.0-next-20250315140539",
+    "applesauce-factory": "0.0.0-next-20250315140539",
     "nostr-tools": "^2.10.4",
     "rxjs": "^7.8.1"
   },
   "devDependencies": {
     "@hirez_io/observer-spy": "^2.2.0",
     "@types/debug": "^4.1.12",
-    "applesauce-signers": "0.0.0-next-20250314151125",
+    "applesauce-signers": "0.0.0-next-20250315140539",
     "nanoid": "^5.0.9",
     "typescript": "^5.7.3",
     "vitest": "^3.0.5"