applesauce-actions 0.11.0 → 0.12.0

package/README.md

@@ -0,0 +1,5 @@
+# Applesauce Actions
+
+A collection of pre-built actions nostr clients can use. built on top of `applesauce-core` and `applesauce-factory`
+
+[Documentation](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce_actions.html)

package/dist/__tests__/action-hub.test.d.ts

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

package/dist/__tests__/action-hub.test.js

@@ -0,0 +1,67 @@
+import { from, Subject } from "rxjs";
+import { describe, expect, it, vi } from "vitest";
+import { subscribeSpyTo } from "@hirez_io/observer-spy";
+import { EventFactory } from "applesauce-factory";
+import { EventStore } from "applesauce-core";
+import { FakeUser } from "./fake-user.js";
+import { ActionHub } from "../action-hub.js";
+import { CreateProfile } from "../actions/profile.js";
+const user = new FakeUser();
+const events = new EventStore();
+const factory = new EventFactory({ signer: user });
+describe("runAction", () => {
+    it("should handle action that return observables", async () => {
+        const e = [user.note(), user.profile({ name: "testing" })];
+        const action = () => from(e);
+        const spy = subscribeSpyTo(ActionHub.runAction({ events, factory, self: await user.getPublicKey() }, action));
+        await spy.onComplete();
+        expect(spy.getValues()).toEqual(e);
+    });
+    it("should handle action that return AsyncIterable", async () => {
+        const e = [user.note(), user.profile({ name: "testing" })];
+        async function* action() {
+            for (const event of e)
+                yield event;
+        }
+        const spy = subscribeSpyTo(ActionHub.runAction({ events, factory, self: await user.getPublicKey() }, action));
+        await spy.onComplete();
+        expect(spy.getValues()).toEqual(e);
+    });
+    it("should handle action that return Iterable", async () => {
+        const e = [user.note(), user.profile({ name: "testing" })];
+        function* action() {
+            for (const event of e)
+                yield event;
+        }
+        const spy = subscribeSpyTo(ActionHub.runAction({ events, factory, self: await user.getPublicKey() }, action));
+        await spy.onComplete();
+        expect(spy.getValues()).toEqual(e);
+    });
+});
+describe("run", () => {
+    it("should throw if publish is not set", async () => {
+        const hub = new ActionHub(events, factory);
+        await expect(async () => hub.run(CreateProfile, { name: "fiatjaf" })).rejects.toThrow();
+    });
+    it("should call publish with all events", async () => {
+        const publish = vi.fn().mockResolvedValue(undefined);
+        const hub = new ActionHub(events, factory, publish);
+        await hub.run(CreateProfile, { name: "fiatjaf" });
+        expect(publish).toHaveBeenCalledWith(expect.objectContaining({ content: JSON.stringify({ name: "fiatjaf" }) }));
+    });
+});
+describe("exec", () => {
+    it("should support forEach to stream to publish", async () => {
+        const publish = vi.fn().mockResolvedValue(undefined);
+        const hub = new ActionHub(events, factory);
+        await hub.exec(CreateProfile, { name: "fiatjaf" }).forEach(publish);
+        expect(publish).toHaveBeenCalledWith(expect.objectContaining({ content: JSON.stringify({ name: "fiatjaf" }) }));
+    });
+    it("should support streaming to a publish subject", async () => {
+        const publish = new Subject();
+        const spy = subscribeSpyTo(publish);
+        const hub = new ActionHub(events, factory);
+        await hub.exec(CreateProfile, { name: "fiatjaf" }).forEach((v) => publish.next(v));
+        expect(spy.getValues()).toEqual([expect.objectContaining({ content: JSON.stringify({ name: "fiatjaf" }) })]);
+    });
+});

package/dist/__tests__/fake-user.d.ts

@@ -0,0 +1,10 @@
+import { SimpleSigner } from "applesauce-signers/signers/simple-signer";
+import type { NostrEvent } from "nostr-tools";
+export declare class FakeUser extends SimpleSigner {
+    pubkey: string;
+    event(data?: Partial<NostrEvent>): NostrEvent;
+    note(content?: string, extra?: Partial<NostrEvent>): import("nostr-tools").Event;
+    profile(profile: any, extra?: Partial<NostrEvent>): import("nostr-tools").Event;
+    contacts(pubkeys?: string[]): import("nostr-tools").Event;
+    list(tags?: string[][], extra?: Partial<NostrEvent>): import("nostr-tools").Event;
+}

package/dist/__tests__/fake-user.js

@@ -0,0 +1,32 @@
+import { unixNow } from "applesauce-core/helpers";
+import { SimpleSigner } from "applesauce-signers/signers/simple-signer";
+import { nanoid } from "nanoid";
+import { finalizeEvent, getPublicKey, kinds } from "nostr-tools";
+export class FakeUser extends SimpleSigner {
+    pubkey = getPublicKey(this.key);
+    event(data) {
+        return finalizeEvent({
+            kind: data?.kind ?? kinds.ShortTextNote,
+            content: data?.content || "",
+            created_at: data?.created_at ?? unixNow(),
+            tags: data?.tags || [],
+        }, this.key);
+    }
+    note(content = "Hello World", extra) {
+        return this.event({ kind: kinds.ShortTextNote, content, ...extra });
+    }
+    profile(profile, extra) {
+        return this.event({ kind: kinds.Metadata, content: JSON.stringify({ ...profile }), ...extra });
+    }
+    contacts(pubkeys = []) {
+        return this.event({ kind: kinds.Contacts, tags: pubkeys.map((p) => ["p", p]) });
+    }
+    list(tags = [], extra) {
+        return this.event({
+            kind: kinds.Bookmarksets,
+            content: "",
+            tags: [["d", nanoid()], ...tags],
+            ...extra,
+        });
+    }
+}

package/dist/action-hub.d.ts

@@ -0,0 +1,36 @@
+import { Observable } from "rxjs";
+import { NostrEvent } from "nostr-tools";
+import { IEventStore } from "applesauce-core/event-store";
+import { EventFactory } from "applesauce-factory";
+/**
+ * A callback used to tell the upstream app to publish an event
+ * @param label a label describing what
+ */
+export type PublishMethod = (event: NostrEvent) => void | Promise<void>;
+/** The context that is passed to actions for them to use to preform actions */
+export type ActionContext = {
+    /** The event store to load events from */
+    events: IEventStore;
+    /** The pubkey of the signer in the event factory */
+    self: string;
+    /** The event factory used to build and modify events */
+    factory: EventFactory;
+};
+/** An action that can be run in a context to preform an action */
+export type Action = (ctx: ActionContext) => Observable<NostrEvent> | AsyncGenerator<NostrEvent> | Generator<NostrEvent>;
+export type ActionConstructor<Args extends Array<any>> = (...args: Args) => Action;
+/** The main class that runs actions */
+export declare class ActionHub {
+    events: IEventStore;
+    factory: EventFactory;
+    publish?: PublishMethod | undefined;
+    constructor(events: IEventStore, factory: EventFactory, publish?: PublishMethod | undefined);
+    protected context: ActionContext | undefined;
+    protected getContext(): Promise<ActionContext>;
+    /** Runs an action in a ActionContext and converts the result to an Observable */
+    static runAction(ctx: ActionContext, action: Action): Observable<NostrEvent>;
+    /** Run an action and publish events using the publish method */
+    run<Args extends Array<any>>(Action: ActionConstructor<Args>, ...args: Args): Promise<void>;
+    /** Run an action without publishing the events */
+    exec<Args extends Array<any>>(Action: ActionConstructor<Args>, ...args: Args): Observable<NostrEvent>;
+}

package/dist/action-hub.js

@@ -0,0 +1,49 @@
+import { from, isObservable, lastValueFrom, switchMap, toArray } from "rxjs";
+/** The main class that runs actions */
+export class ActionHub {
+    events;
+    factory;
+    publish;
+    constructor(events, factory, publish) {
+        this.events = events;
+        this.factory = factory;
+        this.publish = publish;
+    }
+    context = undefined;
+    async getContext() {
+        if (this.context)
+            return this.context;
+        else {
+            if (!this.factory.context.signer)
+                throw new Error("Missing signer");
+            const self = await this.factory.context.signer.getPublicKey();
+            this.context = { self, events: this.events, factory: this.factory };
+            return this.context;
+        }
+    }
+    /** Runs an action in a ActionContext and converts the result to an Observable */
+    static runAction(ctx, action) {
+        const result = action(ctx);
+        if (isObservable(result))
+            return result;
+        else
+            return from(result);
+    }
+    /** Run an action and publish events using the publish method */
+    async run(Action, ...args) {
+        if (!this.publish)
+            throw new Error("Missing publish method, use ActionHub.exec");
+        // wait for action to complete and group events
+        const events = await lastValueFrom(this.exec(Action, ...args).pipe(toArray()));
+        // publish events
+        for (const event of events)
+            await this.publish(event);
+    }
+    /** Run an action without publishing the events */
+    exec(Action, ...args) {
+        return from(this.getContext()).pipe(switchMap((ctx) => {
+            const action = Action(...args);
+            return ActionHub.runAction(ctx, action);
+        }));
+    }
+}

package/dist/actions/__tests__/bookmarks.test.d.ts

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

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

@@ -0,0 +1,24 @@
+import { beforeEach, describe, expect, it, vitest } from "vitest";
+import { EventStore } from "applesauce-core";
+import { EventFactory } from "applesauce-factory";
+import { kinds } from "nostr-tools";
+import { FakeUser } from "../../__tests__/fake-user.js";
+import { ActionHub } from "../../action-hub.js";
+import { CreateBookmarkList } from "../bookmarks.js";
+const user = new FakeUser();
+let events;
+let factory;
+let publish;
+let hub;
+beforeEach(() => {
+    events = new EventStore();
+    factory = new EventFactory({ signer: user });
+    publish = vitest.fn().mockResolvedValue(undefined);
+    hub = new ActionHub(events, factory, publish);
+});
+describe("CreateBookmarkList", () => {
+    it("should publish a kind 10003 bookmark list", async () => {
+        await hub.run(CreateBookmarkList);
+        expect(publish).toBeCalledWith(expect.objectContaining({ kind: kinds.BookmarkList }));
+    });
+});

package/dist/actions/__tests__/contacts.test.d.ts

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

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

@@ -0,0 +1,53 @@
+import { describe, it, expect, beforeEach, vitest } from "vitest";
+import { FakeUser } from "../../__tests__/fake-user.js";
+import { EventFactory } from "applesauce-factory";
+import { EventStore } from "applesauce-core";
+import { ActionHub } from "../../action-hub.js";
+import { FollowUser, NewContacts, UnfollowUser } from "../contacts.js";
+const user = new FakeUser();
+let events;
+let factory;
+let publish;
+let hub;
+beforeEach(() => {
+    events = new EventStore();
+    factory = new EventFactory({ signer: user });
+    publish = vitest.fn().mockResolvedValue(undefined);
+    hub = new ActionHub(events, factory, publish);
+});
+describe("FollowUser", () => {
+    it("should throw an error if contacts does not exist", async () => {
+        // don't add any events to the store
+        await expect(hub.run(FollowUser, user.pubkey)).rejects.toThrow();
+        expect(publish).not.toHaveBeenCalled();
+    });
+    it('should publish an event with a new "p" tag', async () => {
+        events.add(user.contacts());
+        await hub.run(FollowUser, user.pubkey);
+        expect(publish).toHaveBeenCalledWith(expect.objectContaining({ tags: expect.arrayContaining([["p", user.pubkey]]) }));
+    });
+});
+describe("UnfollowUser", () => {
+    it("should throw an error if contacts does not exist", async () => {
+        // don't add any events to the store
+        await expect(hub.run(UnfollowUser, user.pubkey)).rejects.toThrow();
+        expect(publish).not.toHaveBeenCalled();
+    });
+    it('should publish an event with a new "p" tag', async () => {
+        events.add(user.contacts([user.pubkey]));
+        await hub.run(UnfollowUser, user.pubkey);
+        expect(publish).toHaveBeenCalledWith(expect.objectContaining({ kind: 3, tags: [] }));
+    });
+});
+describe("NewContacts", () => {
+    it("should throw if contact list already exists", async () => {
+        events.add(user.contacts([user.pubkey]));
+        await expect(hub.run(NewContacts, [])).rejects.toThrow();
+        expect(publish).not.toBeCalled();
+    });
+    it("should publish a new contact event with pubkeys", async () => {
+        await hub.run(NewContacts, [user.pubkey]);
+        expect(publish).toHaveBeenCalled();
+        expect(publish).toHaveBeenCalledWith(expect.objectContaining({ kind: 3, tags: expect.arrayContaining([["p", user.pubkey]]) }));
+    });
+});

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/bookmarks.d.ts

@@ -0,0 +1,24 @@
+import { NostrEvent } from "nostr-tools";
+import { Action } from "../action-hub.js";
+/**
+ * An action that adds a note or article to the bookmark list or a bookmark set
+ * @param event the event to bookmark
+ * @param identifier the "d" tag of the bookmark set
+ * @param hidden set to true to add to hidden bookmarks
+ */
+export declare function BookmarkEvent(event: NostrEvent, identifier?: string, hidden?: boolean): Action;
+/**
+ * An action that removes a note or article from the bookmark list or bookmark set
+ * @param event the event to remove from bookmarks
+ * @param identifier the "d" tag of the bookmark set
+ * @param hidden set to true to remove from hidden bookmarks
+ */
+export declare function UnbookmarkEvent(event: NostrEvent, identifier: string, hidden?: boolean): Action;
+/** An action that creates a new bookmark list for a user */
+export declare function CreateBookmarkList(bookmarks?: NostrEvent[]): Action;
+/** An action that creates a new bookmark set for a user */
+export declare function CreateBookmarkSet(title: string, description: string, additional: {
+    image?: string;
+    hidden?: NostrEvent[];
+    public?: NostrEvent[];
+}): Action;

package/dist/actions/bookmarks.js

@@ -0,0 +1,58 @@
+import { kinds } from "nostr-tools";
+import { addEventBookmarkTag, removeEventBookmarkTag } from "applesauce-factory/operations/tag";
+import { modifyHiddenTags, modifyPublicTags, setListDescription, setListImage, setListTitle, } from "applesauce-factory/operations/event";
+function getBookmarkEvent(events, self, identifier) {
+    return events.getReplaceable(identifier ? kinds.Bookmarksets : kinds.BookmarkList, self, identifier);
+}
+/**
+ * An action that adds a note or article to the bookmark list or a bookmark set
+ * @param event the event to bookmark
+ * @param identifier the "d" tag of the bookmark set
+ * @param hidden set to true to add to hidden bookmarks
+ */
+export function BookmarkEvent(event, identifier, hidden = false) {
+    return async function* ({ events, factory, self }) {
+        const bookmarks = getBookmarkEvent(events, self, identifier);
+        if (!bookmarks)
+            throw new Error("Cant find bookmarks");
+        const operation = addEventBookmarkTag(event);
+        const draft = await factory.modifyTags(bookmarks, hidden ? { hidden: operation } : operation);
+        yield await factory.sign(draft);
+    };
+}
+/**
+ * An action that removes a note or article from the bookmark list or bookmark set
+ * @param event the event to remove from bookmarks
+ * @param identifier the "d" tag of the bookmark set
+ * @param hidden set to true to remove from hidden bookmarks
+ */
+export function UnbookmarkEvent(event, identifier, hidden = false) {
+    return async function* ({ events, factory, self }) {
+        const bookmarks = getBookmarkEvent(events, self, identifier);
+        if (!bookmarks)
+            throw new Error("Cant find bookmarks");
+        const operation = removeEventBookmarkTag(event);
+        const draft = await factory.modifyTags(bookmarks, hidden ? { hidden: operation } : operation);
+        yield await factory.sign(draft);
+    };
+}
+/** An action that creates a new bookmark list for a user */
+export function CreateBookmarkList(bookmarks) {
+    return async function* ({ events, factory, self }) {
+        const existing = getBookmarkEvent(events, self);
+        if (existing)
+            throw new Error("Bookmark list already exists");
+        const draft = await factory.build({ kind: kinds.BookmarkList }, bookmarks ? modifyPublicTags(...bookmarks.map(addEventBookmarkTag)) : undefined);
+        yield await factory.sign(draft);
+    };
+}
+/** An action that creates a new bookmark set for a user */
+export function CreateBookmarkSet(title, description, additional) {
+    return async function* ({ events, factory, self }) {
+        const existing = getBookmarkEvent(events, self);
+        if (existing)
+            throw new Error("Bookmark list already exists");
+        const draft = await factory.process({ kind: kinds.BookmarkList }, setListTitle(title), setListDescription(description), additional.image ? setListImage(additional.image) : undefined, additional.public ? modifyPublicTags(...additional.public.map(addEventBookmarkTag)) : undefined, additional.hidden ? modifyHiddenTags(...additional.hidden.map(addEventBookmarkTag)) : undefined);
+        yield await factory.sign(draft);
+    };
+}

package/dist/actions/contacts.d.ts

@@ -0,0 +1,7 @@
+import { Action } from "../action-hub.js";
+/** An action that adds a pubkey to a users contacts event */
+export declare function FollowUser(pubkey: string, relay?: string, hidden?: boolean): Action;
+/** An action that removes a pubkey from a users contacts event */
+export declare function UnfollowUser(pubkey: string, hidden?: boolean): Action;
+/** An action that creates a new kind 3 contacts lists, throws if a contact list already exists */
+export declare function NewContacts(pubkeys?: string[]): Action;

package/dist/actions/contacts.js

@@ -0,0 +1,35 @@
+import { kinds } from "nostr-tools";
+import { addPubkeyTag, removePubkeyTag } from "applesauce-factory/operations/tag";
+/** An action that adds a pubkey to a users contacts event */
+export function FollowUser(pubkey, relay, hidden = false) {
+    return async function* ({ events, factory, self }) {
+        const contacts = events.getReplaceable(kinds.Contacts, self);
+        if (!contacts)
+            throw new Error("Missing contacts event");
+        const pointer = { pubkey, relays: relay ? [relay] : undefined };
+        const operation = addPubkeyTag(pointer);
+        const draft = await factory.modifyTags(contacts, hidden ? { hidden: operation } : operation);
+        yield await factory.sign(draft);
+    };
+}
+/** An action that removes a pubkey from a users contacts event */
+export function UnfollowUser(pubkey, hidden = false) {
+    return async function* ({ events, factory, self }) {
+        const contacts = events.getReplaceable(kinds.Contacts, self);
+        if (!contacts)
+            throw new Error("Missing contacts event");
+        const operation = removePubkeyTag(pubkey);
+        const draft = await factory.modifyTags(contacts, hidden ? { hidden: operation } : operation);
+        yield await factory.sign(draft);
+    };
+}
+/** An action that creates a new kind 3 contacts lists, throws if a contact list already exists */
+export function NewContacts(pubkeys) {
+    return async function* ({ events, factory, self }) {
+        const contacts = events.getReplaceable(kinds.Contacts, self);
+        if (contacts)
+            throw new Error("Contact list already exists");
+        const draft = await factory.process({ kind: kinds.Contacts, tags: pubkeys?.map((p) => ["p", p]) });
+        yield await factory.sign(draft);
+    };
+}

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

@@ -0,0 +1,17 @@
+import { NostrEvent } from "nostr-tools";
+import { Action } from "../action-hub.js";
+import { ProfilePointer } from "nostr-tools/nip19";
+/**
+ * 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 | 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
+ */
+export declare function RemoveUserFromFollowSet(pubkey: string | ProfilePointer, identifier: NostrEvent | string, hidden?: boolean): Action;

package/dist/actions/follow-sets.js

@@ -0,0 +1,38 @@
+import { kinds } from "nostr-tools";
+import { addPubkeyTag, removePubkeyTag } from "applesauce-factory/operations/tag";
+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 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);
+        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);
+        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

@@ -0,0 +1,5 @@
+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

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

package/dist/actions/pins.d.ts

@@ -0,0 +1,8 @@
+import { NostrEvent } from "nostr-tools";
+import { Action } from "../action-hub.js";
+/** An action that pins a note to the users pin list */
+export declare function PinNote(note: NostrEvent): Action;
+/** An action that removes an event from the users pin list */
+export declare function UnpinNote(note: NostrEvent): Action;
+/** An action that creates a new pin list for a user */
+export declare function CreatePinList(pins?: NostrEvent[]): Action;

package/dist/actions/pins.js

@@ -0,0 +1,33 @@
+import { kinds } from "nostr-tools";
+import { addEventTag, removeEventTag } from "applesauce-factory/operations/tag";
+import { modifyPublicTags } from "applesauce-factory/operations/event";
+/** An action that pins a note to the users pin list */
+export function PinNote(note) {
+    return async function* ({ events, factory, self }) {
+        const pins = events.getReplaceable(kinds.Pinlist, self);
+        if (!pins)
+            throw new Error("Missing pin list");
+        const draft = await factory.modifyTags(pins, addEventTag(note.id));
+        yield await factory.sign(draft);
+    };
+}
+/** An action that removes an event from the users pin list */
+export function UnpinNote(note) {
+    return async function* ({ events, factory, self }) {
+        const pins = events.getReplaceable(kinds.Pinlist, self);
+        if (!pins)
+            throw new Error("Missing pin list");
+        const draft = await factory.modifyTags(pins, removeEventTag(note.id));
+        yield await factory.sign(draft);
+    };
+}
+/** An action that creates a new pin list for a user */
+export function CreatePinList(pins = []) {
+    return async function* ({ events, factory, self }) {
+        const existing = events.getReplaceable(kinds.Pinlist, self);
+        if (existing)
+            throw new Error("Pin list already exists");
+        const draft = await factory.process({ kind: kinds.Pinlist }, modifyPublicTags(...pins.map((event) => addEventTag(event.id))));
+        yield await factory.sign(draft);
+    };
+}

package/dist/actions/profile.d.ts

@@ -0,0 +1,6 @@
+import { ProfileContent } from "applesauce-core/helpers";
+import { Action } from "../action-hub.js";
+/** An action that creates a new kind 0 profile event for a user */
+export declare function CreateProfile(content: ProfileContent): Action;
+/** An action that updates a kind 0 profile evnet for a user */
+export declare function UpdateProfile(content: Partial<ProfileContent>): Action;

package/dist/actions/profile.js

@@ -0,0 +1,22 @@
+import { kinds } from "nostr-tools";
+import { setProfileContent, updateProfileContent } from "applesauce-factory/operations/event";
+/** An action that creates a new kind 0 profile event for a user */
+export function CreateProfile(content) {
+    return async function* ({ events, factory, self }) {
+        const metadata = events.getReplaceable(kinds.Metadata, self);
+        if (metadata)
+            throw new Error("Profile already exists");
+        const draft = await factory.build({ kind: kinds.Metadata }, setProfileContent(content));
+        yield await factory.sign(draft);
+    };
+}
+/** An action that updates a kind 0 profile evnet for a user */
+export function UpdateProfile(content) {
+    return async function* ({ events, factory, self }) {
+        const metadata = events.getReplaceable(kinds.Metadata, self);
+        if (!metadata)
+            throw new Error("Profile does not exists");
+        const draft = await factory.modify(metadata, updateProfileContent(content));
+        yield await factory.sign(draft);
+    };
+}

package/dist/helpers/observable.d.ts

@@ -0,0 +1,3 @@
+import { Observable } from "rxjs";
+/** Subscribes to an observable, send all the values to a method and unsubscribes when complete */
+export declare function play<T extends unknown = unknown>(stream: Observable<T>, method: (value: T) => void): Promise<void>;

package/dist/helpers/observable.js

@@ -0,0 +1,20 @@
+/** Subscribes to an observable, send all the values to a method and unsubscribes when complete */
+export function play(stream, method) {
+    return new Promise((resolve, reject) => {
+        const sub = stream.subscribe({
+            next: (v) => {
+                try {
+                    method(v);
+                }
+                catch (error) {
+                    reject(error);
+                }
+            },
+            error: (error) => reject(error),
+            complete: () => {
+                sub.unsubscribe();
+                resolve();
+            },
+        });
+    });
+}

package/dist/index.d.ts

@@ -1 +1,2 @@
-export declare const actions = 0;
+export * from "./action-hub.js";
+export * as Actions from "./actions/index.js";

package/dist/index.js

@@ -1 +1,2 @@
-export const actions = 0;
+export * from "./action-hub.js";
+export * as Actions from "./actions/index.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "applesauce-actions",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "A package for performing common nostr actions",
   "type": "module",
   "main": "dist/index.js",
@@ -19,17 +19,29 @@
       "import": "./dist/index.js",
       "require": "./dist/index.js",
       "types": "./dist/index.d.ts"
+    },
+    "./actions": {
+      "import": "./dist/actions/index.js",
+      "require": "./dist/actions/index.js",
+      "types": "./dist/actions/index.d.ts"
+    },
+    "./actions/*": {
+      "import": "./dist/actions/*.js",
+      "require": "./dist/actions/*.js",
+      "types": "./dist/actions/*.d.ts"
     }
   },
   "dependencies": {
-    "applesauce-core": "^0.11.0",
-    "applesauce-factory": "^0.11.0",
-    "debug": "^4.4.0",
+    "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.12.0",
+    "nanoid": "^5.0.9",
     "typescript": "^5.7.3",
     "vitest": "^3.0.5"
   },