applesauce-actions 0.0.0-next-20250315131629 → 0.0.0-next-20250323173930

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/__tests__/mute.test.d.ts

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

package/dist/actions/__tests__/mute.test.js

@@ -0,0 +1,67 @@
+import { beforeEach, describe, expect, it } from "vitest";
+import { EventStore } from "applesauce-core";
+import { EventFactory } from "applesauce-factory";
+import { kinds } from "nostr-tools";
+import { getMutedThings, getHiddenMutedThings } 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 { MuteThread, UnmuteThread } from "../mute.js";
+const user = new FakeUser();
+const testEventId = "test-event-id";
+let events;
+let factory;
+let hub;
+beforeEach(() => {
+    events = new EventStore();
+    factory = new EventFactory({ signer: user });
+    hub = new ActionHub(events, factory);
+    // Add a mute list event to work with
+    const muteList = user.event({
+        kind: kinds.Mutelist,
+        tags: [],
+        content: "",
+        created_at: Math.floor(Date.now() / 1000),
+    });
+    events.add(muteList);
+});
+describe("MuteThread", () => {
+    it("should add an event to public tags in mute list", async () => {
+        const spy = subscribeSpyTo(hub.exec(MuteThread, testEventId), { expectErrors: false });
+        await spy.onComplete();
+        const emittedEvent = spy.getLastValue();
+        const mutedThings = getMutedThings(emittedEvent);
+        expect(mutedThings.threads).toContain(testEventId);
+    });
+    it("should add an event to hidden tags in mute list", async () => {
+        const spy = subscribeSpyTo(hub.exec(MuteThread, testEventId, true), { expectErrors: false });
+        await spy.onComplete();
+        const emittedEvent = spy.getLastValue();
+        const hiddenMutedThings = await getHiddenMutedThings(emittedEvent);
+        expect(hiddenMutedThings?.threads).toContain(testEventId);
+    });
+});
+describe("UnmuteThread", () => {
+    it("should remove an event from public tags in mute list", async () => {
+        // First add the thread to mute list
+        const addSpy = subscribeSpyTo(hub.exec(MuteThread, testEventId), { expectErrors: false });
+        await addSpy.onComplete();
+        // Then unmute it
+        const spy = subscribeSpyTo(hub.exec(UnmuteThread, testEventId), { expectErrors: false });
+        await spy.onComplete();
+        const emittedEvent = spy.getLastValue();
+        const mutedThings = getMutedThings(emittedEvent);
+        expect(mutedThings.threads).not.toContain(testEventId);
+    });
+    it("should remove an event from hidden tags in mute list", async () => {
+        // First add the thread to hidden mute list
+        const addSpy = subscribeSpyTo(hub.exec(MuteThread, testEventId, true), { expectErrors: false });
+        await addSpy.onComplete();
+        // Then unmute it
+        const spy = subscribeSpyTo(hub.exec(UnmuteThread, testEventId, true), { expectErrors: false });
+        await spy.onComplete();
+        const emittedEvent = spy.getLastValue();
+        const hiddenMutedThings = await getHiddenMutedThings(emittedEvent);
+        expect(hiddenMutedThings?.threads).not.toContain(testEventId);
+    });
+});

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

@@ -0,0 +1,43 @@
+import { NostrEvent } from "nostr-tools";
+import { Action } from "../action-hub.js";
+import { ProfilePointer } from "nostr-tools/nip19";
+/**
+ * An action that creates a new follow set
+ * @param identifier the "d" tag of the follow set
+ * @param pubkeys the pubkeys to add to the follow set
+ * @param hidden set to true to create a hidden follow set
+ * @throws if a follow set already exists
+ */
+export declare function CreateFollowSet(title: string, options?: {
+    description?: string;
+    image?: string;
+    public?: (string | ProfilePointer)[];
+    hidden?: (string | ProfilePointer)[];
+}): Action;
+/**
+ * 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
+ * @throws if the follow set does not exist
+ */
+export declare function AddUserToFollowSet(pubkey: (string | ProfilePointer)[] | string | ProfilePointer, identifier: NostrEvent | 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
+ * @throws if the follow set does not exist
+ */
+export declare function RemoveUserFromFollowSet(pubkey: (string | ProfilePointer)[] | string | ProfilePointer, identifier: NostrEvent | string, hidden?: boolean): Action;
+/**
+ * An action that updates the title, description, or image of a follow set
+ * @param identifier the "d" tag of the follow set
+ * @param info the new information for the follow set
+ * @throws if the follow set does not exist
+ */
+export declare function UpdateFollowSetInformation(identifier: string, info: {
+    title?: string;
+    description?: string;
+    image?: string;
+}): Action;

package/dist/actions/follow-sets.js

@@ -0,0 +1,71 @@
+import { kinds } from "nostr-tools";
+import { addPubkeyTag, removePubkeyTag } from "applesauce-factory/operations/tag";
+import { modifyHiddenTags, modifyPublicTags, setListDescription, setListImage, setListTitle, } from "applesauce-factory/operations/event";
+function getFollowSetEvent(events, self, identifier) {
+    const set = typeof identifier === "string" ? events.getReplaceable(kinds.Followsets, self, identifier) : identifier;
+    if (!set)
+        throw new Error("Can't find follow set");
+    if (set.kind !== kinds.Followsets)
+        throw new Error("Event is not a follow set");
+    return set;
+}
+/**
+ * An action that creates a new follow set
+ * @param identifier the "d" tag of the follow set
+ * @param pubkeys the pubkeys to add to the follow set
+ * @param hidden set to true to create a hidden follow set
+ * @throws if a follow set already exists
+ */
+export function CreateFollowSet(title, options) {
+    return async function* ({ factory }) {
+        const draft = await factory.build({ kind: kinds.Followsets }, 
+        // set list information
+        setListTitle(title), options?.description ? setListDescription(options.description) : undefined, options?.image ? setListImage(options.image) : undefined, 
+        // add pubkey tags
+        options?.public ? modifyPublicTags(...options.public.map((p) => addPubkeyTag(p))) : undefined, options?.hidden ? modifyHiddenTags(...options.hidden.map((p) => addPubkeyTag(p))) : undefined);
+        yield await factory.sign(draft);
+    };
+}
+/**
+ * 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
+ * @throws if the follow set does not exist
+ */
+export function AddUserToFollowSet(pubkey, identifier, hidden = false) {
+    return async function* ({ events, factory, self }) {
+        const follows = getFollowSetEvent(events, self, identifier);
+        const operations = Array.isArray(pubkey) ? pubkey.map((p) => addPubkeyTag(p)) : addPubkeyTag(pubkey);
+        const draft = await factory.modifyTags(follows, hidden ? { hidden: operations } : operations);
+        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
+ * @throws if the follow set does not exist
+ */
+export function RemoveUserFromFollowSet(pubkey, identifier, hidden = false) {
+    return async function* ({ events, factory, self }) {
+        const follows = getFollowSetEvent(events, self, identifier);
+        const operations = Array.isArray(pubkey) ? pubkey.map((p) => removePubkeyTag(p)) : removePubkeyTag(pubkey);
+        const draft = await factory.modifyTags(follows, hidden ? { hidden: operations } : operations);
+        yield await factory.sign(draft);
+    };
+}
+/**
+ * An action that updates the title, description, or image of a follow set
+ * @param identifier the "d" tag of the follow set
+ * @param info the new information for the follow set
+ * @throws if the follow set does not exist
+ */
+export function UpdateFollowSetInformation(identifier, info) {
+    return async function* ({ events, factory, self }) {
+        const follows = getFollowSetEvent(events, self, identifier);
+        const draft = await factory.modify(follows, info?.title ? setListTitle(info.title) : undefined, info?.description ? setListDescription(info.description) : undefined, info?.image ? setListImage(info.image) : undefined);
+        yield await factory.sign(draft);
+    };
+}

package/dist/actions/index.d.ts

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

package/dist/actions/index.js

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

package/dist/actions/mailboxes.d.ts

@@ -0,0 +1,11 @@
+import { Action } from "../action-hub.js";
+/** An action to create a new kind 10002 relay list event */
+export declare function CreateMailboxes(inboxes: string[], outboxes: string[]): Action;
+/** An action to add an inbox relay to the kind 10002 relay list */
+export declare function AddInboxRelay(relay: string | string[]): Action;
+/** An action to remove an inbox relay from the kind 10002 relay list */
+export declare function RemoveInboxRelay(relay: string | string[]): Action;
+/** An action to add an outbox relay to the kind 10002 relay list */
+export declare function AddOutboxRelay(relay: string | string[]): Action;
+/** An action to remove an outbox relay from the kind 10002 relay list */
+export declare function RemoveOutboxRelay(relay: string | string[]): Action;

package/dist/actions/mailboxes.js

@@ -0,0 +1,66 @@
+import { kinds } from "nostr-tools";
+import { addInboxRelay, addOutboxRelay, removeInboxRelay, removeOutboxRelay } from "applesauce-factory/operations/tag";
+import { modifyPublicTags } from "applesauce-factory/operations/event";
+/** An action to create a new kind 10002 relay list event */
+export function CreateMailboxes(inboxes, outboxes) {
+    return async function* ({ events, factory, self }) {
+        const mailboxes = events.getReplaceable(kinds.RelayList, self);
+        if (mailboxes)
+            throw new Error("Mailbox event already exists");
+        const draft = await factory.build({ kind: kinds.RelayList }, modifyPublicTags(...inboxes.map(addInboxRelay), ...outboxes.map(addOutboxRelay)));
+        const signed = await factory.sign(draft);
+        yield signed;
+    };
+}
+/** An action to add an inbox relay to the kind 10002 relay list */
+export function AddInboxRelay(relay) {
+    return async function* ({ events, factory, self }) {
+        if (typeof relay === "string")
+            relay = [relay];
+        const mailboxes = events.getReplaceable(kinds.RelayList, self);
+        if (!mailboxes)
+            throw new Error("Missing mailboxes event");
+        const draft = await factory.modifyTags(mailboxes, ...relay.map(addInboxRelay));
+        const signed = await factory.sign(draft);
+        yield signed;
+    };
+}
+/** An action to remove an inbox relay from the kind 10002 relay list */
+export function RemoveInboxRelay(relay) {
+    return async function* ({ events, factory, self }) {
+        if (typeof relay === "string")
+            relay = [relay];
+        const mailboxes = events.getReplaceable(kinds.RelayList, self);
+        if (!mailboxes)
+            throw new Error("Missing mailboxes event");
+        const draft = await factory.modifyTags(mailboxes, ...relay.map(removeInboxRelay));
+        const signed = await factory.sign(draft);
+        yield signed;
+    };
+}
+/** An action to add an outbox relay to the kind 10002 relay list */
+export function AddOutboxRelay(relay) {
+    return async function* ({ events, factory, self }) {
+        if (typeof relay === "string")
+            relay = [relay];
+        const mailboxes = events.getReplaceable(kinds.RelayList, self);
+        if (!mailboxes)
+            throw new Error("Missing mailboxes event");
+        const draft = await factory.modifyTags(mailboxes, ...relay.map(addOutboxRelay));
+        const signed = await factory.sign(draft);
+        yield signed;
+    };
+}
+/** An action to remove an outbox relay from the kind 10002 relay list */
+export function RemoveOutboxRelay(relay) {
+    return async function* ({ events, factory, self }) {
+        if (typeof relay === "string")
+            relay = [relay];
+        const mailboxes = events.getReplaceable(kinds.RelayList, self);
+        if (!mailboxes)
+            throw new Error("Missing mailboxes event");
+        const draft = await factory.modifyTags(mailboxes, ...relay.map(removeOutboxRelay));
+        const signed = await factory.sign(draft);
+        yield signed;
+    };
+}

package/dist/actions/mute.d.ts

@@ -0,0 +1,19 @@
+import { NostrEvent } from "nostr-tools";
+import { EventPointer } from "nostr-tools/nip19";
+import { Action } from "../action-hub.js";
+/** An action that adds a pubkey to the mute list */
+export declare function MuteUser(pubkey: string, hidden?: boolean): Action;
+/** Removes a pubkey from the mute list */
+export declare function UnmuteUser(pubkey: string, hidden?: boolean): Action;
+/** Add a thread to the mute list */
+export declare function MuteThread(thread: string | NostrEvent | EventPointer, hidden?: boolean): Action;
+/** Removes a thread from the mute list */
+export declare function UnmuteThread(thread: string | NostrEvent | EventPointer, hidden?: boolean): Action;
+/** Add a word to the mute list */
+export declare function MuteWord(word: string, hidden?: boolean): Action;
+/** Removes a word from the mute list */
+export declare function UnmuteWord(word: string, hidden?: boolean): Action;
+/** Add a hashtag to the mute list */
+export declare function MuteHashtag(hashtag: string, hidden?: boolean): Action;
+/** Removes a hashtag from the mute list */
+export declare function UnmuteHashtag(hashtag: string, hidden?: boolean): Action;

package/dist/actions/mute.js

@@ -0,0 +1,79 @@
+import { addEventTag, addNameValueTag, addPubkeyTag, removeEventTag, removeNameValueTag, removePubkeyTag, } from "applesauce-factory/operations/tag";
+import { kinds } from "nostr-tools";
+function ensureMuteList(events, self) {
+    const mute = events.getReplaceable(kinds.Mutelist, self);
+    if (!mute)
+        throw new Error("No mute list found");
+    return mute;
+}
+/** An action that adds a pubkey to the mute list */
+export function MuteUser(pubkey, hidden = false) {
+    return async function* ({ events, factory, self }) {
+        const mute = ensureMuteList(events, self);
+        const operation = addPubkeyTag(pubkey);
+        const draft = await factory.modifyTags(mute, hidden ? { hidden: operation } : operation);
+        yield await factory.sign(draft);
+    };
+}
+/** Removes a pubkey from the mute list */
+export function UnmuteUser(pubkey, hidden = false) {
+    return async function* ({ events, factory, self }) {
+        const mute = ensureMuteList(events, self);
+        const draft = await factory.modifyTags(mute, hidden ? { hidden: removePubkeyTag(pubkey) } : removePubkeyTag(pubkey));
+        yield await factory.sign(draft);
+    };
+}
+/** Add a thread to the mute list */
+export function MuteThread(thread, hidden = false) {
+    return async function* ({ events, factory, self }) {
+        const mute = ensureMuteList(events, self);
+        const operation = addEventTag(thread);
+        const draft = await factory.modifyTags(mute, hidden ? { hidden: operation } : operation);
+        yield await factory.sign(draft);
+    };
+}
+/** Removes a thread from the mute list */
+export function UnmuteThread(thread, hidden = false) {
+    return async function* ({ events, factory, self }) {
+        const mute = ensureMuteList(events, self);
+        const operation = removeEventTag(thread);
+        const draft = await factory.modifyTags(mute, hidden ? { hidden: operation } : operation);
+        yield await factory.sign(draft);
+    };
+}
+/** Add a word to the mute list */
+export function MuteWord(word, hidden = false) {
+    return async function* ({ events, factory, self }) {
+        const mute = ensureMuteList(events, self);
+        const operation = addNameValueTag(["word", word.toLocaleLowerCase()], true);
+        const draft = await factory.modifyTags(mute, hidden ? { hidden: operation } : operation);
+        yield await factory.sign(draft);
+    };
+}
+/** Removes a word from the mute list */
+export function UnmuteWord(word, hidden = false) {
+    return async function* ({ events, factory, self }) {
+        const mute = ensureMuteList(events, self);
+        const operation = removeNameValueTag(["word", word.toLocaleLowerCase()]);
+        const draft = await factory.modifyTags(mute, hidden ? { hidden: operation } : operation);
+        yield await factory.sign(draft);
+    };
+}
+/** Add a hashtag to the mute list */
+export function MuteHashtag(hashtag, hidden = false) {
+    return async function* ({ events, factory, self }) {
+        const mute = ensureMuteList(events, self);
+        const operation = addNameValueTag(["t", hashtag.toLocaleLowerCase()], true);
+        const draft = await factory.modifyTags(mute, hidden ? { hidden: operation } : operation);
+        yield await factory.sign(draft);
+    };
+}
+/** Removes a hashtag from the mute list */
+export function UnmuteHashtag(hashtag, hidden = false) {
+    return async function* ({ events, factory, self }) {
+        const mute = ensureMuteList(events, self);
+        const operation = removeNameValueTag(["t", hashtag.toLocaleLowerCase()]);
+        const draft = await factory.modifyTags(mute, hidden ? { hidden: operation } : operation);
+        yield await factory.sign(draft);
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "applesauce-actions",
-  "version": "0.0.0-next-20250315131629",
+  "version": "0.0.0-next-20250323173930",
   "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-20250315131629",
-    "applesauce-factory": "0.0.0-next-20250315131629",
+    "applesauce-core": "^0.12.0",
+    "applesauce-factory": "^0.12.0",
     "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-20250315131629",
+    "applesauce-signers": "0.0.0-next-20250323173930",
     "nanoid": "^5.0.9",
     "typescript": "^5.7.3",
     "vitest": "^3.0.5"