applesauce-actions 0.0.0-next-20250308144838 → 0.0.0-next-20250311125119

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,34 @@
+import { EventStore } from "applesauce-core";
+import { EventFactory } from "applesauce-factory";
+import { NostrEvent } from "nostr-tools";
+/**
+ * A callback used to tell the upstream app to publish an event
+ * @param label a label describing what
+ */
+export type PublishMethod = (label: string, event: NostrEvent, explicitRelays?: string[]) => 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: EventStore;
+    /** The pubkey of the signer in the event factory */
+    self: string;
+    /** The event factory used to build and modify events */
+    factory: EventFactory;
+    /** A method used to publish final events to relays */
+    publish: PublishMethod;
+};
+/** An action that can be run in a context to preform an action */
+export type Action<T extends unknown = unknown> = (ctx: ActionContext) => Promise<T>;
+export type ActionConstructor<Args extends Array<any>, T extends unknown = unknown> = (...args: Args) => Action<T>;
+/** The main class that runs actions */
+export declare class ActionHub {
+    events: EventStore;
+    factory: EventFactory;
+    publish: PublishMethod;
+    constructor(events: EventStore, factory: EventFactory, publish: PublishMethod);
+    protected context: ActionContext | undefined;
+    getContext(): Promise<ActionContext>;
+    run<Args extends Array<any>, T extends unknown = unknown>(Action: ActionConstructor<Args, T>, ...args: Args): Promise<T>;
+    follow(pubkey: string): Promise<unknown>;
+    unfollow(pubkey: string): Promise<unknown>;
+}

package/dist/action-hub.js

@@ -0,0 +1,47 @@
+import { FollowUser } from "./actions/contacts.js";
+/** 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;
+        /** The the context observable to get the pubkey */
+        // this.context = defer(() => {
+        //   if (!this.factory.context.signer) throw new Error("Missing signer");
+        //   return from(this.factory.context.signer.getPublicKey());
+        // }).pipe(map((self) => ({ self, events: this.events, factory: this.factory, publish: this.publish })));
+    }
+    // log = new Subject<{ label: string; args: Array<any>; result: any }>();
+    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, publish: this.publish };
+            return this.context;
+        }
+    }
+    async run(
+    // label: string,
+    Action, ...args) {
+        const action = Action(...args);
+        const ctx = await this.getContext();
+        return await action(ctx);
+        // const log = { label, args, result };
+        // this.log.next(log);
+        // return await result;
+    }
+    // helper methods
+    follow(pubkey) {
+        return this.run(FollowUser, pubkey);
+    }
+    unfollow(pubkey) {
+        return this.run(FollowUser, pubkey);
+    }
+}

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.any(String), 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.any(String), 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.any(String), expect.objectContaining({ kind: 3, tags: expect.arrayContaining([["p", user.pubkey]]) }));
+    });
+});

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 ({ events, factory, self, publish }) => {
+        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);
+        await publish("Update contacts", await factory.sign(draft));
+    };
+}
+/** An action that removes a pubkey from a users contacts event */
+export function UnfollowUser(pubkey, hidden = false) {
+    return async ({ events, factory, self, publish }) => {
+        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);
+        await publish("Update contacts", 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 ({ events, factory, self, publish }) => {
+        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]) });
+        await publish("New contact list", await factory.sign(draft));
+    };
+}

package/dist/actions/index.d.ts

@@ -0,0 +1 @@
+export * from "./contacts.js";

package/dist/actions/index.js

@@ -0,0 +1 @@
+export * from "./contacts.js";

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.0.0-next-20250308144838",
+  "version": "0.0.0-next-20250311125119",
   "description": "A package for performing common nostr actions",
   "type": "module",
   "main": "dist/index.js",
@@ -19,17 +19,27 @@
       "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.0.0-next-20250308144838",
-    "applesauce-factory": "0.0.0-next-20250308144838",
-    "debug": "^4.4.0",
-    "nostr-tools": "^2.10.4",
-    "rxjs": "^7.8.1"
+    "applesauce-core": "0.0.0-next-20250311125119",
+    "applesauce-factory": "0.0.0-next-20250311125119",
+    "nostr-tools": "^2.10.4"
   },
   "devDependencies": {
     "@types/debug": "^4.1.12",
+    "applesauce-signers": "0.0.0-next-20250311125119",
+    "nanoid": "^5.0.9",
     "typescript": "^5.7.3",
     "vitest": "^3.0.5"
   },