applesauce-actions 0.0.0-next-20250425210455 → 0.0.0-next-20250428223834

package/README.md

@@ -1,5 +1,42 @@
 # Applesauce Actions
 
-A collection of pre-built actions nostr clients can use. built on top of `applesauce-core` and `applesauce-factory`
+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)
+
+## Installation
+
+```bash
+npm install applesauce-actions
+```
+
+## Overview
+
+Actions are common pre-built async operations that apps can perform. They use:
+
+- `EventStore` for access to known nostr events
+- `EventFactory` to build and sign new nostr events
+- A `publish` method to publish or save the resulting events
+
+The package provides an `ActionHub` class that combines these components into a single manager for easier action execution.
+
+## Basic Usage
+
+```typescript
+import { ActionHub } from "applesauce-actions";
+import { FollowUser } from "applesauce-actions/actions";
+
+async function publishEvent(event: NostrEvent) {
+  await relayPool.publish(event, ["wss://relay.example.com"]);
+}
+
+// Create an action hub with your event store, factory and publish method
+const hub = new ActionHub(eventStore, eventFactory, publishEvent);
+
+// Example: Follow a user
+await hub
+  .exec(FollowUser, "3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d")
+  .forEach((event) => publishEvent(event));
+```
+
+For more detailed documentation and examples, visit the [full documentation](https://hzrd149.github.io/applesauce/overview/actions.html).

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

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

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

@@ -0,0 +1,93 @@
+import { EventStore } from "applesauce-core";
+import { BLOSSOM_SERVER_LIST_KIND } from "applesauce-core/helpers/blossom";
+import { EventFactory } from "applesauce-factory";
+import { firstValueFrom, lastValueFrom } from "rxjs";
+import { toArray } from "rxjs/operators";
+import { beforeEach, describe, expect, it } from "vitest";
+import { FakeUser } from "../../__tests__/fake-user.js";
+import { ActionHub } from "../../action-hub.js";
+import { AddBlossomServer, NewBlossomServers, RemoveBlossomServer, SetDefaultBlossomServer } from "../blossom.js";
+const user = new FakeUser();
+let events;
+let factory;
+let hub;
+beforeEach(() => {
+    events = new EventStore();
+    factory = new EventFactory({ signer: user });
+    hub = new ActionHub(events, factory);
+});
+describe("NewBlossomServers", () => {
+    it("should publish a kind 10063 blossom server list", async () => {
+        const result = await lastValueFrom(hub.exec(NewBlossomServers, ["https://cdn.example.com/"]).pipe(toArray()));
+        expect(result[0]).toMatchObject({ kind: BLOSSOM_SERVER_LIST_KIND, tags: [["server", "https://cdn.example.com/"]] });
+    });
+    it("should throw if a blossom servers event already exists", async () => {
+        // Create the initial event
+        await hub.exec(NewBlossomServers, ["https://cdn.example.com/"]).forEach((e) => events.add(e));
+        // Attempt to create another one
+        await expect(lastValueFrom(hub.exec(NewBlossomServers, ["https://other.example.com/"]).pipe(toArray()))).rejects.toThrow("Blossom servers event already exists");
+    });
+});
+describe("AddBlossomServer", () => {
+    beforeEach(async () => {
+        // Create an initial empty server list
+        await hub.exec(NewBlossomServers, ["https://cdn.example.com/"]).forEach((e) => events.add(e));
+    });
+    it("should add a single server to the list", async () => {
+        const result = await firstValueFrom(hub.exec(AddBlossomServer, "https://other.example.com/"));
+        expect(result).toMatchObject({
+            kind: BLOSSOM_SERVER_LIST_KIND,
+            tags: expect.arrayContaining([["server", expect.stringContaining("other.example.com")]]),
+        });
+    });
+    it("should add multiple servers to the list", async () => {
+        const result = await firstValueFrom(hub.exec(AddBlossomServer, ["https://other.example.com/", "https://other2.example.com/"]));
+        expect(result).toMatchObject({
+            kind: BLOSSOM_SERVER_LIST_KIND,
+            tags: expect.arrayContaining([
+                ["server", expect.stringContaining("other.example.com")],
+                ["server", expect.stringContaining("other2.example.com")],
+            ]),
+        });
+    });
+});
+describe("RemoveBlossomServer", () => {
+    beforeEach(async () => {
+        // Create an initial server list with two servers
+        await hub
+            .exec(NewBlossomServers, ["https://cdn.example.com/", "https://other.example.com/"])
+            .forEach((e) => events.add(e));
+    });
+    it("should remove a server from the list", async () => {
+        const result = await firstValueFrom(hub.exec(RemoveBlossomServer, "https://cdn.example.com/"));
+        expect(result).toMatchObject({
+            kind: BLOSSOM_SERVER_LIST_KIND,
+            tags: expect.arrayContaining([["server", expect.stringContaining("other.example.com")]]),
+        });
+    });
+    it("should remove multiple servers from the list", async () => {
+        const result = await firstValueFrom(hub.exec(RemoveBlossomServer, ["https://cdn.example.com/", "https://other.example.com/"]));
+        expect(result).toMatchObject({
+            kind: BLOSSOM_SERVER_LIST_KIND,
+            tags: [],
+        });
+    });
+});
+describe("SetDefaultBlossomServer", () => {
+    beforeEach(async () => {
+        // Create an initial server list with two servers
+        await hub
+            .exec(NewBlossomServers, ["https://cdn.example.com/", "https://other.example.com/"])
+            .forEach((e) => events.add(e));
+    });
+    it("should move the specified server to the top of the list", async () => {
+        const result = await firstValueFrom(hub.exec(SetDefaultBlossomServer, "https://other.example.com/"));
+        expect(result).toMatchObject({
+            kind: BLOSSOM_SERVER_LIST_KIND,
+            tags: expect.arrayContaining([
+                ["server", expect.stringContaining("other.example.com")],
+                ["server", expect.stringContaining("cdn.example.com")],
+            ]),
+        });
+    });
+});

package/dist/actions/blocked-relays.d.ts

@@ -0,0 +1,10 @@
+import { Action } from "../action-hub.js";
+/** An action that adds a relay to the 10006 blocked relays event */
+export declare function AddBlockedRelay(relay: string | string[], hidden?: boolean): Action;
+/** An action that removes a relay from the 10006 blocked relays event */
+export declare function RemoveBlockedRelay(relay: string | string[], hidden?: boolean): Action;
+/** Creates a new blocked relays event */
+export declare function NewBlockedRelays(relays?: string[] | {
+    public?: string[];
+    hidden?: string[];
+}): Action;

package/dist/actions/blocked-relays.js

@@ -0,0 +1,48 @@
+import { modifyHiddenTags, modifyPublicTags } from "applesauce-factory/operations/event";
+import { addRelayTag, removeRelayTag } from "applesauce-factory/operations/tag/relay";
+import { kinds } from "nostr-tools";
+function getBlockedRelaysEvent(events, self) {
+    const event = events.getReplaceable(kinds.BlockedRelaysList, self);
+    if (!event)
+        throw new Error("Can't find blocked relays event");
+    return event;
+}
+/** An action that adds a relay to the 10006 blocked relays event */
+export function AddBlockedRelay(relay, hidden = false) {
+    return async function* ({ events, factory, self }) {
+        const blocked = getBlockedRelaysEvent(events, self);
+        const operation = Array.isArray(relay) ? relay.map((r) => addRelayTag(r)) : addRelayTag(relay);
+        const draft = await factory.modifyTags(blocked, hidden ? { hidden: operation } : operation);
+        yield await factory.sign(draft);
+    };
+}
+/** An action that removes a relay from the 10006 blocked relays event */
+export function RemoveBlockedRelay(relay, hidden = false) {
+    return async function* ({ events, factory, self }) {
+        const blocked = getBlockedRelaysEvent(events, self);
+        const operation = Array.isArray(relay) ? relay.map((r) => removeRelayTag(r)) : removeRelayTag(relay);
+        const draft = await factory.modifyTags(blocked, hidden ? { hidden: operation } : operation);
+        yield await factory.sign(draft);
+    };
+}
+/** Creates a new blocked relays event */
+export function NewBlockedRelays(relays) {
+    return async function* ({ events, factory, self }) {
+        const blocked = events.getReplaceable(kinds.BlockedRelaysList, self);
+        if (blocked)
+            throw new Error("Blocked relays event already exists");
+        let publicOperations = [];
+        let hiddenOperations = [];
+        if (Array.isArray(relays)) {
+            publicOperations.push(...relays.map((r) => addRelayTag(r)));
+        }
+        else {
+            if (relays?.public)
+                publicOperations.push(...(relays?.public ?? []).map((r) => addRelayTag(r)));
+            if (relays?.hidden)
+                hiddenOperations.push(...(relays?.hidden ?? []).map((r) => addRelayTag(r)));
+        }
+        const draft = await factory.build({ kind: kinds.BlockedRelaysList }, publicOperations.length ? modifyPublicTags(...publicOperations) : undefined, hiddenOperations.length ? modifyHiddenTags(...hiddenOperations) : undefined);
+        yield await factory.sign(draft);
+    };
+}

package/dist/actions/blossom.d.ts

@@ -0,0 +1,9 @@
+import { Action } from "../action-hub.js";
+/** An action that adds a server to the Blossom servers event */
+export declare function AddBlossomServer(server: string | URL | (string | URL)[]): Action;
+/** An action that removes a server from the Blossom servers event */
+export declare function RemoveBlossomServer(server: string | URL | (string | URL)[]): Action;
+/** Makes a specific Blossom server the default server (move it to the top of the list) */
+export declare function SetDefaultBlossomServer(server: string | URL): Action;
+/** Creates a new Blossom servers event */
+export declare function NewBlossomServers(servers?: (string | URL)[]): Action;

package/dist/actions/blossom.js

@@ -0,0 +1,52 @@
+import { BLOSSOM_SERVER_LIST_KIND } from "applesauce-core/helpers/blossom";
+import { modifyPublicTags } from "applesauce-factory/operations/event";
+import { addBlossomServerTag, removeBlossomServerTag } from "applesauce-factory/operations/tag/blossom";
+function getBlossomServersEvent(events, self) {
+    const event = events.getReplaceable(BLOSSOM_SERVER_LIST_KIND, self);
+    if (!event)
+        throw new Error("Can't find Blossom servers event");
+    return event;
+}
+/** An action that adds a server to the Blossom servers event */
+export function AddBlossomServer(server) {
+    return async function* ({ events, factory, self }) {
+        const servers = getBlossomServersEvent(events, self);
+        const operation = Array.isArray(server) ? server.map((s) => addBlossomServerTag(s)) : addBlossomServerTag(server);
+        const draft = await factory.modifyTags(servers, operation);
+        yield await factory.sign(draft);
+    };
+}
+/** An action that removes a server from the Blossom servers event */
+export function RemoveBlossomServer(server) {
+    return async function* ({ events, factory, self }) {
+        const servers = getBlossomServersEvent(events, self);
+        const operation = Array.isArray(server)
+            ? server.map((s) => removeBlossomServerTag(s))
+            : removeBlossomServerTag(server);
+        const draft = await factory.modifyTags(servers, operation);
+        yield await factory.sign(draft);
+    };
+}
+/** Makes a specific Blossom server the default server (move it to the top of the list) */
+export function SetDefaultBlossomServer(server) {
+    return async function* ({ events, factory, self }) {
+        const servers = getBlossomServersEvent(events, self);
+        const prependTag = (tag) => (tags) => [tag, ...tags];
+        const draft = await factory.modifyTags(servers, [
+            removeBlossomServerTag(server),
+            prependTag(["server", String(server)]),
+        ]);
+        yield await factory.sign(draft);
+    };
+}
+/** Creates a new Blossom servers event */
+export function NewBlossomServers(servers) {
+    return async function* ({ events, factory, self }) {
+        const existing = events.getReplaceable(BLOSSOM_SERVER_LIST_KIND, self);
+        if (existing)
+            throw new Error("Blossom servers event already exists");
+        const operations = servers ? servers.map((s) => addBlossomServerTag(s)) : [];
+        const draft = await factory.build({ kind: BLOSSOM_SERVER_LIST_KIND }, modifyPublicTags(...operations));
+        yield await factory.sign(draft);
+    };
+}

package/dist/actions/dm-relays.d.ts

@@ -0,0 +1,7 @@
+import { Action } from "../action-hub.js";
+/** An action that adds a relay to the 10050 DM relays event */
+export declare function AddDMRelay(relay: string | string[]): Action;
+/** An action that removes a relay from the 10050 DM relays event */
+export declare function RemoveDMRelay(relay: string | string[]): Action;
+/** Creates a new DM relays event */
+export declare function NewDMRelays(relays?: string[]): Action;

package/dist/actions/dm-relays.js

@@ -0,0 +1,38 @@
+import { modifyPublicTags } from "applesauce-factory/operations/event";
+import { addRelayTag, removeRelayTag } from "applesauce-factory/operations/tag/relay";
+import { kinds } from "nostr-tools";
+function getDMRelaysEvent(events, self) {
+    const event = events.getReplaceable(kinds.DirectMessageRelaysList, self);
+    if (!event)
+        throw new Error("Can't find DM relays event");
+    return event;
+}
+/** An action that adds a relay to the 10050 DM relays event */
+export function AddDMRelay(relay) {
+    return async function* ({ events, factory, self }) {
+        const dmRelays = getDMRelaysEvent(events, self);
+        const operation = Array.isArray(relay) ? relay.map((r) => addRelayTag(r)) : addRelayTag(relay);
+        const draft = await factory.modifyTags(dmRelays, operation);
+        yield await factory.sign(draft);
+    };
+}
+/** An action that removes a relay from the 10050 DM relays event */
+export function RemoveDMRelay(relay) {
+    return async function* ({ events, factory, self }) {
+        const dmRelays = getDMRelaysEvent(events, self);
+        const operation = Array.isArray(relay) ? relay.map((r) => removeRelayTag(r)) : removeRelayTag(relay);
+        const draft = await factory.modifyTags(dmRelays, operation);
+        yield await factory.sign(draft);
+    };
+}
+/** Creates a new DM relays event */
+export function NewDMRelays(relays) {
+    return async function* ({ events, factory, self }) {
+        const dmRelays = events.getReplaceable(kinds.DirectMessageRelaysList, self);
+        if (dmRelays)
+            throw new Error("DM relays event already exists");
+        const operations = relays?.map((r) => addRelayTag(r)) ?? [];
+        const draft = await factory.build({ kind: kinds.DirectMessageRelaysList }, modifyPublicTags(...operations));
+        yield await factory.sign(draft);
+    };
+}

package/dist/actions/favorite-relays.d.ts

@@ -0,0 +1,18 @@
+import { AddressPointer } from "nostr-tools/nip19";
+import { Action } from "../action-hub.js";
+/** An action that adds a relay to the 10012 favorite relays event */
+export declare function AddFavoriteRelay(relay: string | string[], hidden?: boolean): Action;
+/** An action that removes a relay from the 10012 favorite relays event */
+export declare function RemoveFavoriteRelay(relay: string | string[], hidden?: boolean): Action;
+/** An action that adds a relay set to the 10012 favorite relays event */
+export declare function AddFavoriteRelaySet(addr: AddressPointer[] | AddressPointer, hidden?: boolean): Action;
+/** An action that removes a relay set from the 10012 favorite relays event */
+export declare function RemoveFavoriteRelaySet(addr: AddressPointer[] | AddressPointer, hidden?: boolean): Action;
+/** Creates a new favorite relays event */
+export declare function NewFavoriteRelays(relays?: string[] | {
+    public?: string[];
+    hidden?: string[];
+}, sets?: AddressPointer[] | {
+    public?: AddressPointer[];
+    hidden?: AddressPointer[];
+}): Action;

package/dist/actions/favorite-relays.js

@@ -0,0 +1,75 @@
+import { FAVORITE_RELAYS_KIND } from "applesauce-core/helpers/lists";
+import { modifyHiddenTags, modifyPublicTags } from "applesauce-factory/operations/event";
+import { addCoordinateTag, addRelayTag, removeCoordinateTag, removeRelayTag } from "applesauce-factory/operations/tag";
+function getFavoriteRelaysEvent(events, self) {
+    const event = events.getReplaceable(FAVORITE_RELAYS_KIND, self);
+    if (!event)
+        throw new Error("Can't find favorite relays event");
+    return event;
+}
+/** An action that adds a relay to the 10012 favorite relays event */
+export function AddFavoriteRelay(relay, hidden = false) {
+    return async function* ({ events, factory, self }) {
+        const favorites = getFavoriteRelaysEvent(events, self);
+        const operation = Array.isArray(relay) ? relay.map((r) => addRelayTag(r)) : addRelayTag(relay);
+        const draft = await factory.modifyTags(favorites, hidden ? { hidden: operation } : operation);
+        yield await factory.sign(draft);
+    };
+}
+/** An action that removes a relay from the 10012 favorite relays event */
+export function RemoveFavoriteRelay(relay, hidden = false) {
+    return async function* ({ events, factory, self }) {
+        const favorites = getFavoriteRelaysEvent(events, self);
+        const operation = Array.isArray(relay) ? relay.map((r) => removeRelayTag(r)) : removeRelayTag(relay);
+        const draft = await factory.modifyTags(favorites, hidden ? { hidden: operation } : operation);
+        yield await factory.sign(draft);
+    };
+}
+/** An action that adds a relay set to the 10012 favorite relays event */
+export function AddFavoriteRelaySet(addr, hidden = false) {
+    return async function* ({ events, factory, self }) {
+        const favorites = getFavoriteRelaysEvent(events, self);
+        const operation = Array.isArray(addr) ? addr.map((a) => addCoordinateTag(a)) : addCoordinateTag(addr);
+        const draft = await factory.modifyTags(favorites, hidden ? { hidden: operation } : operation);
+        yield await factory.sign(draft);
+    };
+}
+/** An action that removes a relay set from the 10012 favorite relays event */
+export function RemoveFavoriteRelaySet(addr, hidden = false) {
+    return async function* ({ events, factory, self }) {
+        const favorites = getFavoriteRelaysEvent(events, self);
+        const operation = Array.isArray(addr) ? addr.map((a) => removeCoordinateTag(a)) : removeCoordinateTag(addr);
+        const draft = await factory.modifyTags(favorites, hidden ? { hidden: operation } : operation);
+        yield await factory.sign(draft);
+    };
+}
+/** Creates a new favorite relays event */
+export function NewFavoriteRelays(relays, sets) {
+    return async function* ({ events, factory, self }) {
+        const favorites = events.getReplaceable(FAVORITE_RELAYS_KIND, self);
+        if (favorites)
+            throw new Error("Favorite relays event already exists");
+        let publicOperations = [];
+        let hiddenOperations = [];
+        if (Array.isArray(relays)) {
+            publicOperations.push(...relays.map((r) => addRelayTag(r)));
+        }
+        else {
+            if (relays?.public)
+                publicOperations.push(...(relays?.public ?? []).map((r) => addRelayTag(r)));
+            if (relays?.hidden)
+                hiddenOperations.push(...(relays?.hidden ?? []).map((r) => addRelayTag(r)));
+        }
+        if (Array.isArray(sets)) {
+            publicOperations.push(...sets.map((s) => addCoordinateTag(s)));
+        }
+        else {
+            if (sets?.public)
+                publicOperations.push(...(sets?.public ?? []).map((s) => addCoordinateTag(s)));
+            if (sets?.hidden)
+                hiddenOperations.push(...(sets?.hidden ?? []).map((s) => addCoordinateTag(s)));
+        }
+        const draft = await factory.build({ kind: FAVORITE_RELAYS_KIND }, publicOperations.length ? modifyPublicTags(...publicOperations) : undefined, hiddenOperations.length ? modifyHiddenTags(...hiddenOperations) : undefined);
+        yield await factory.sign(draft);
+    };
+}

package/dist/actions/favorites.d.ts

@@ -0,0 +1,2 @@
+import { Action } from "../action-hub.js";
+export declare function AddFavoriteRelay(relay: string): Action;

package/dist/actions/favorites.js

@@ -0,0 +1,14 @@
+import { kinds } from "nostr-tools";
+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.FavoriteRelays)
+        throw new Error("Event is not a favorite relays");
+    return set;
+}
+export function AddFavoriteRelay(relay) {
+    return async function* ({ events, factory, self }) {
+        const favoriteRelays = events.getReplaceable(kinds.FavoriteRelays, self);
+    };
+}

package/dist/actions/index.d.ts

@@ -1,7 +1,13 @@
+export * from "./blocked-relays.js";
+export * from "./blossom.js";
 export * from "./bookmarks.js";
 export * from "./contacts.js";
+export * from "./dm-relays.js";
+export * from "./favorite-relays.js";
 export * from "./follow-sets.js";
 export * from "./mailboxes.js";
+export * from "./mute.js";
 export * from "./pins.js";
 export * from "./profile.js";
-export * from "./mute.js";
+export * from "./relay-sets.js";
+export * from "./search-relays.js";

package/dist/actions/index.js

@@ -1,7 +1,13 @@
+export * from "./blocked-relays.js";
+export * from "./blossom.js";
 export * from "./bookmarks.js";
 export * from "./contacts.js";
+export * from "./dm-relays.js";
+export * from "./favorite-relays.js";
 export * from "./follow-sets.js";
 export * from "./mailboxes.js";
+export * from "./mute.js";
 export * from "./pins.js";
 export * from "./profile.js";
-export * from "./mute.js";
+export * from "./relay-sets.js";
+export * from "./search-relays.js";

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

@@ -0,0 +1,19 @@
+import { NostrEvent } from "nostr-tools";
+import { Action } from "../action-hub.js";
+/** An action that adds a relay to a relay set*/
+export declare function AddRelayToRelaySet(relay: string | string[], identifier: NostrEvent | string, hidden?: boolean): Action;
+/** An action that removes a relay from a relay set */
+export declare function RemoveRelayFromRelaySet(relay: string | string[], identifier: NostrEvent | string, hidden?: boolean): Action;
+/** An action that creates a new relay set */
+export declare function CreateRelaySet(title: string, options?: {
+    description?: string;
+    image?: string;
+    public?: string[];
+    hidden?: string[];
+}): Action;
+/** An action that updates the title, description, or image of a relay set */
+export declare function UpdateRelaySetInformation(identifier: string, info: {
+    title?: string;
+    description?: string;
+    image?: string;
+}): Action;

package/dist/actions/relay-sets.js

@@ -0,0 +1,44 @@
+import { modifyHiddenTags, modifyPublicTags, setListDescription, setListImage, setListTitle, } from "applesauce-factory/operations/event";
+import { addRelayTag, removeRelayTag } from "applesauce-factory/operations/tag";
+import { kinds } from "nostr-tools";
+function getRelaySetEvent(events, self, identifier) {
+    const set = typeof identifier === "string" ? events.getReplaceable(kinds.Relaysets, self, identifier) : identifier;
+    if (!set)
+        throw new Error("Can't find relay set");
+    if (set.kind !== kinds.Relaysets)
+        throw new Error("Event is not a relay set");
+    return set;
+}
+/** An action that adds a relay to a relay set*/
+export function AddRelayToRelaySet(relay, identifier, hidden = false) {
+    return async function* ({ events, factory, self }) {
+        const relays = getRelaySetEvent(events, self, identifier);
+        const operations = Array.isArray(relay) ? relay.map((r) => addRelayTag(r)) : addRelayTag(relay);
+        const draft = await factory.modifyTags(relays, hidden ? { hidden: operations } : operations);
+        yield await factory.sign(draft);
+    };
+}
+/** An action that removes a relay from a relay set */
+export function RemoveRelayFromRelaySet(relay, identifier, hidden = false) {
+    return async function* ({ events, factory, self }) {
+        const relays = getRelaySetEvent(events, self, identifier);
+        const operations = Array.isArray(relay) ? relay.map((r) => removeRelayTag(r)) : removeRelayTag(relay);
+        const draft = await factory.modifyTags(relays, hidden ? { hidden: operations } : operations);
+        yield await factory.sign(draft);
+    };
+}
+/** An action that creates a new relay set */
+export function CreateRelaySet(title, options) {
+    return async function* ({ factory }) {
+        const draft = await factory.build({ kind: kinds.Relaysets }, setListTitle(title), options?.description ? setListDescription(options.description) : undefined, options?.image ? setListImage(options.image) : undefined, options?.public ? modifyPublicTags(...options.public.map((r) => addRelayTag(r))) : undefined, options?.hidden ? modifyHiddenTags(...options.hidden.map((r) => addRelayTag(r))) : undefined);
+        yield await factory.sign(draft);
+    };
+}
+/** An action that updates the title, description, or image of a relay set */
+export function UpdateRelaySetInformation(identifier, info) {
+    return async function* ({ events, factory, self }) {
+        const relays = getRelaySetEvent(events, self, identifier);
+        const draft = await factory.modify(relays, 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/search-relays.d.ts

@@ -0,0 +1,10 @@
+import { Action } from "../action-hub.js";
+/** An action that adds a relay to the 10007 search relays event */
+export declare function AddSearchRelay(relay: string | string[], hidden?: boolean): Action;
+/** An action that removes a relay from the 10007 search relays event */
+export declare function RemoveSearchRelay(relay: string | string[], hidden?: boolean): Action;
+/** Creates a new search relays event */
+export declare function NewSearchRelays(relays?: string[] | {
+    public?: string[];
+    hidden?: string[];
+}): Action;

package/dist/actions/search-relays.js

@@ -0,0 +1,48 @@
+import { modifyHiddenTags, modifyPublicTags } from "applesauce-factory/operations/event";
+import { addRelayTag, removeRelayTag } from "applesauce-factory/operations/tag/relay";
+import { kinds } from "nostr-tools";
+function getSearchRelaysEvent(events, self) {
+    const event = events.getReplaceable(kinds.SearchRelaysList, self);
+    if (!event)
+        throw new Error("Can't find search relays event");
+    return event;
+}
+/** An action that adds a relay to the 10007 search relays event */
+export function AddSearchRelay(relay, hidden = false) {
+    return async function* ({ events, factory, self }) {
+        const search = getSearchRelaysEvent(events, self);
+        const operation = Array.isArray(relay) ? relay.map((r) => addRelayTag(r)) : addRelayTag(relay);
+        const draft = await factory.modifyTags(search, hidden ? { hidden: operation } : operation);
+        yield await factory.sign(draft);
+    };
+}
+/** An action that removes a relay from the 10007 search relays event */
+export function RemoveSearchRelay(relay, hidden = false) {
+    return async function* ({ events, factory, self }) {
+        const search = getSearchRelaysEvent(events, self);
+        const operation = Array.isArray(relay) ? relay.map((r) => removeRelayTag(r)) : removeRelayTag(relay);
+        const draft = await factory.modifyTags(search, hidden ? { hidden: operation } : operation);
+        yield await factory.sign(draft);
+    };
+}
+/** Creates a new search relays event */
+export function NewSearchRelays(relays) {
+    return async function* ({ events, factory, self }) {
+        const search = events.getReplaceable(kinds.SearchRelaysList, self);
+        if (search)
+            throw new Error("Search relays event already exists");
+        let publicOperations = [];
+        let hiddenOperations = [];
+        if (Array.isArray(relays)) {
+            publicOperations.push(...relays.map((r) => addRelayTag(r)));
+        }
+        else {
+            if (relays?.public)
+                publicOperations.push(...(relays?.public ?? []).map((r) => addRelayTag(r)));
+            if (relays?.hidden)
+                hiddenOperations.push(...(relays?.hidden ?? []).map((r) => addRelayTag(r)));
+        }
+        const draft = await factory.build({ kind: kinds.SearchRelaysList }, publicOperations.length ? modifyPublicTags(...publicOperations) : undefined, hiddenOperations.length ? modifyHiddenTags(...hiddenOperations) : undefined);
+        yield await factory.sign(draft);
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "applesauce-actions",
-  "version": "0.0.0-next-20250425210455",
+  "version": "0.0.0-next-20250428223834",
   "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-20250425210455",
-    "applesauce-factory": "0.0.0-next-20250425210455",
+    "applesauce-core": "0.0.0-next-20250428223834",
+    "applesauce-factory": "0.0.0-next-20250428223834",
     "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-20250425210455",
+    "applesauce-signers": "0.0.0-next-20250428223834",
     "nanoid": "^5.1.5",
     "typescript": "^5.8.3",
     "vitest": "^3.1.1"