applesauce-actions 1.0.0 → 1.1.0

package/README.md

@@ -2,7 +2,7 @@
 
 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)
+[Documentation](https://hzrd149.github.io/applesauce/typedoc/modules/applesauce-actions.html)
 
 ## Installation
 

package/dist/actions/bookmarks.js

@@ -1,6 +1,6 @@
-import { kinds } from "nostr-tools";
-import { addEventBookmarkTag, removeEventBookmarkTag } from "applesauce-factory/operations/tag";
 import { modifyHiddenTags, modifyPublicTags, setListDescription, setListImage, setListTitle, } from "applesauce-factory/operations/event";
+import { addEventBookmarkTag, removeEventBookmarkTag } from "applesauce-factory/operations/tag";
+import { kinds } from "nostr-tools";
 function getBookmarkEvent(events, self, identifier) {
     return events.getReplaceable(identifier ? kinds.Bookmarksets : kinds.BookmarkList, self, identifier);
 }

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

@@ -1,6 +1,6 @@
 import { NostrEvent } from "nostr-tools";
-import { Action } from "../action-hub.js";
 import { ProfilePointer } from "nostr-tools/nip19";
+import { Action } from "../action-hub.js";
 /**
  * An action that creates a new follow set
  * @param identifier the "d" tag of the follow set

package/dist/actions/follow-sets.js

@@ -1,6 +1,6 @@
-import { kinds } from "nostr-tools";
-import { addPubkeyTag, removePubkeyTag } from "applesauce-factory/operations/tag";
 import { modifyHiddenTags, modifyPublicTags, setListDescription, setListImage, setListTitle, } from "applesauce-factory/operations/event";
+import { addPubkeyTag, removePubkeyTag } from "applesauce-factory/operations/tag";
+import { kinds } from "nostr-tools";
 function getFollowSetEvent(events, self, identifier) {
     const set = typeof identifier === "string" ? events.getReplaceable(kinds.Followsets, self, identifier) : identifier;
     if (!set)

package/dist/actions/index.d.ts

@@ -5,6 +5,7 @@ export * from "./contacts.js";
 export * from "./dm-relays.js";
 export * from "./favorite-relays.js";
 export * from "./follow-sets.js";
+export * from "./lists.js";
 export * from "./mailboxes.js";
 export * from "./mute.js";
 export * from "./pins.js";

package/dist/actions/index.js

@@ -5,6 +5,7 @@ export * from "./contacts.js";
 export * from "./dm-relays.js";
 export * from "./favorite-relays.js";
 export * from "./follow-sets.js";
+export * from "./lists.js";
 export * from "./mailboxes.js";
 export * from "./mute.js";
 export * from "./pins.js";

package/dist/actions/lists.d.ts

@@ -0,0 +1,9 @@
+import { NostrEvent } from "nostr-tools";
+import { AddressPointer } from "nostr-tools/nip19";
+import { Action } from "../action-hub.js";
+/** An action that sets or removes a NIP-15 list information */
+export declare function SetListMetadata(list: NostrEvent | AddressPointer, info: {
+    title?: string;
+    description?: string;
+    image?: string;
+}): Action;

package/dist/actions/lists.js

@@ -0,0 +1,18 @@
+import { isAddressPointer } from "applesauce-core/helpers";
+import { setListDescription, setListImage, setListTitle } from "applesauce-factory/operations/event";
+function getList(events, address) {
+    const list = isAddressPointer(address)
+        ? events.getReplaceable(address.kind, address.pubkey, address.identifier)
+        : address;
+    if (!list)
+        throw new Error("Can't find list");
+    return list;
+}
+/** An action that sets or removes a NIP-15 list information */
+export function SetListMetadata(list, info) {
+    return async function* ({ events, factory }) {
+        list = getList(events, list);
+        const draft = await factory.modify(list, setListTitle(info.title ?? null), setListDescription(info.description ?? null), setListImage(info.image ?? null));
+        yield await factory.sign(draft);
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "applesauce-actions",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "A package for performing common nostr actions",
   "type": "module",
   "main": "dist/index.js",
@@ -33,7 +33,7 @@
   },
   "dependencies": {
     "applesauce-core": "^1.0.0",
-    "applesauce-factory": "^1.0.0",
+    "applesauce-factory": "^1.1.0",
     "nostr-tools": "^2.10.4",
     "rxjs": "^7.8.1"
   },