applesauce-actions 2.3.0 → 3.1.0

package/dist/action-hub.d.ts

@@ -2,10 +2,7 @@ import { Observable } from "rxjs";
 import { NostrEvent } from "nostr-tools";
 import { EventFactory } from "applesauce-factory";
 import { IEventStoreActions, IEventStoreRead } from "applesauce-core";
-/**
- * A callback used to tell the upstream app to publish an event
- * @param label a label describing what
- */
+/** A callback used to tell the upstream app to publish an event */
 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 = {

package/dist/actions/blocked-relays.js

@@ -1,4 +1,4 @@
-import { modifyHiddenTags, modifyPublicTags } from "applesauce-factory/operations/event";
+import { modifyHiddenTags, modifyPublicTags } from "applesauce-factory/operations";
 import { addRelayTag, removeRelayTag } from "applesauce-factory/operations/tag/relay";
 import { kinds } from "nostr-tools";
 function getBlockedRelaysEvent(events, self) {

package/dist/actions/blossom.js

@@ -1,5 +1,5 @@
 import { BLOSSOM_SERVER_LIST_KIND } from "applesauce-core/helpers/blossom";
-import { modifyPublicTags, modifyTags } from "applesauce-factory/operations/event";
+import { modifyPublicTags, modifyTags } from "applesauce-factory/operations";
 import { addBlossomServerTag, removeBlossomServerTag } from "applesauce-factory/operations/tag/blossom";
 /** An action that adds a server to the Blossom servers event */
 export function AddBlossomServer(server) {

package/dist/actions/bookmarks.js

@@ -1,4 +1,4 @@
-import { modifyHiddenTags, modifyPublicTags, setListDescription, setListImage, setListTitle, } from "applesauce-factory/operations/event";
+import { modifyHiddenTags, modifyPublicTags, List } from "applesauce-factory/operations";
 import { addEventBookmarkTag, removeEventBookmarkTag } from "applesauce-factory/operations/tag";
 import { kinds } from "nostr-tools";
 /**
@@ -76,7 +76,7 @@ export function CreateBookmarkList(bookmarks) {
 /** An action that creates a new bookmark set for a user */
 export function CreateBookmarkSet(title, description, additional) {
     return async function* ({ factory }) {
-        const draft = await factory.build({ 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);
+        const draft = await factory.build({ kind: kinds.BookmarkList }, List.setTitle(title), List.setDescription(description), additional.image ? List.setImage(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/calendar.d.ts

@@ -0,0 +1,6 @@
+import { NostrEvent } from "nostr-tools";
+import { Action } from "../action-hub.js";
+/** Adds a calendar event to a calendar */
+export declare function AddEventToCalendar(calendar: NostrEvent, event: NostrEvent): Action;
+/** Removes a calendar event from a calendar */
+export declare function RemoveEventFromCalendar(calendar: NostrEvent, event: NostrEvent): Action;

package/dist/actions/calendar.js

@@ -0,0 +1,25 @@
+import { DATE_BASED_CALENDAR_EVENT_KIND, TIME_BASED_CALENDAR_EVENT_KIND } from "applesauce-core/helpers/calendar-event";
+import { Calendar } from "applesauce-factory/operations";
+import { kinds } from "nostr-tools";
+/** Adds a calendar event to a calendar */
+export function AddEventToCalendar(calendar, event) {
+    if (calendar.kind !== kinds.Calendar)
+        throw new Error("Calendar is not a calendar event");
+    if (event.kind !== DATE_BASED_CALENDAR_EVENT_KIND && event.kind !== TIME_BASED_CALENDAR_EVENT_KIND)
+        throw new Error("Event is not a calendar event");
+    return async function* ({ factory }) {
+        const draft = await factory.modify(calendar, Calendar.addEvent(event));
+        return await factory.sign(draft);
+    };
+}
+/** Removes a calendar event from a calendar */
+export function RemoveEventFromCalendar(calendar, event) {
+    if (calendar.kind !== kinds.Calendar)
+        throw new Error("Calendar is not a calendar event");
+    if (event.kind !== DATE_BASED_CALENDAR_EVENT_KIND && event.kind !== TIME_BASED_CALENDAR_EVENT_KIND)
+        throw new Error("Event is not a calendar event");
+    return async function* ({ factory }) {
+        const draft = await factory.modify(calendar, Calendar.removeEvent(event));
+        return await factory.sign(draft);
+    };
+}

package/dist/actions/contacts.js

@@ -1,4 +1,4 @@
-import { modifyHiddenTags, modifyPublicTags } from "applesauce-factory/operations/event";
+import { modifyHiddenTags, modifyPublicTags } from "applesauce-factory/operations";
 import { addPubkeyTag, removePubkeyTag } from "applesauce-factory/operations/tag";
 import { kinds } from "nostr-tools";
 /** An action that adds a pubkey to a users contacts event */

package/dist/actions/dm-relays.js

@@ -1,4 +1,4 @@
-import { modifyPublicTags } from "applesauce-factory/operations/event";
+import { modifyPublicTags } from "applesauce-factory/operations";
 import { addRelayTag, removeRelayTag } from "applesauce-factory/operations/tag/relay";
 import { kinds } from "nostr-tools";
 function getDMRelaysEvent(events, self) {

package/dist/actions/favorite-relays.js

@@ -1,6 +1,6 @@
 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";
+import { modifyHiddenTags, modifyPublicTags } from "applesauce-factory/operations";
+import { addAddressTag, addRelayTag, removeAddressTag, removeRelayTag } from "applesauce-factory/operations/tag";
 function getFavoriteRelaysEvent(events, self) {
     const event = events.getReplaceable(FAVORITE_RELAYS_KIND, self);
     if (!event)
@@ -29,7 +29,7 @@ export function RemoveFavoriteRelay(relay, hidden = false) {
 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 operation = Array.isArray(addr) ? addr.map((a) => addAddressTag(a)) : addAddressTag(addr);
         const draft = await factory.modifyTags(favorites, hidden ? { hidden: operation } : operation);
         yield await factory.sign(draft);
     };
@@ -38,7 +38,7 @@ export function AddFavoriteRelaySet(addr, hidden = false) {
 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 operation = Array.isArray(addr) ? addr.map((a) => removeAddressTag(a)) : removeAddressTag(addr);
         const draft = await factory.modifyTags(favorites, hidden ? { hidden: operation } : operation);
         yield await factory.sign(draft);
     };
@@ -61,13 +61,13 @@ export function NewFavoriteRelays(relays, sets) {
                 hiddenOperations.push(...(relays?.hidden ?? []).map((r) => addRelayTag(r)));
         }
         if (Array.isArray(sets)) {
-            publicOperations.push(...sets.map((s) => addCoordinateTag(s)));
+            publicOperations.push(...sets.map((s) => addAddressTag(s)));
         }
         else {
             if (sets?.public)
-                publicOperations.push(...(sets?.public ?? []).map((s) => addCoordinateTag(s)));
+                publicOperations.push(...(sets?.public ?? []).map((s) => addAddressTag(s)));
             if (sets?.hidden)
-                hiddenOperations.push(...(sets?.hidden ?? []).map((s) => addCoordinateTag(s)));
+                hiddenOperations.push(...(sets?.hidden ?? []).map((s) => addAddressTag(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/follow-sets.js

@@ -1,4 +1,4 @@
-import { modifyHiddenTags, modifyPublicTags, setListDescription, setListImage, setListTitle, } from "applesauce-factory/operations/event";
+import { modifyHiddenTags, modifyPublicTags, List } from "applesauce-factory/operations";
 import { addPubkeyTag, removePubkeyTag } from "applesauce-factory/operations/tag";
 import { kinds } from "nostr-tools";
 function getFollowSetEvent(events, self, identifier) {
@@ -17,7 +17,7 @@ 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, 
+        List.setTitle(title), options?.description ? List.setDescription(options.description) : undefined, options?.image ? List.setImage(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);
@@ -62,7 +62,7 @@ export function RemoveUserFromFollowSet(pubkey, identifier, hidden = false) {
 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);
+        const draft = await factory.modify(follows, info?.title ? List.setTitle(info.title) : undefined, info?.description ? List.setDescription(info.description) : undefined, info?.image ? List.setImage(info.image) : undefined);
         yield await factory.sign(draft);
     };
 }

package/dist/actions/index.d.ts

@@ -1,6 +1,7 @@
 export * from "./blocked-relays.js";
 export * from "./blossom.js";
 export * from "./bookmarks.js";
+export * from "./calendar.js";
 export * from "./contacts.js";
 export * from "./dm-relays.js";
 export * from "./favorite-relays.js";

package/dist/actions/index.js

@@ -1,6 +1,7 @@
 export * from "./blocked-relays.js";
 export * from "./blossom.js";
 export * from "./bookmarks.js";
+export * from "./calendar.js";
 export * from "./contacts.js";
 export * from "./dm-relays.js";
 export * from "./favorite-relays.js";

package/dist/actions/lists.js

@@ -1,5 +1,5 @@
 import { isAddressPointer } from "applesauce-core/helpers";
-import { setListDescription, setListImage, setListTitle } from "applesauce-factory/operations/event";
+import { List } from "applesauce-factory/operations";
 function getList(events, address) {
     const list = isAddressPointer(address)
         ? events.getReplaceable(address.kind, address.pubkey, address.identifier)
@@ -12,7 +12,7 @@ function getList(events, address) {
 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));
+        const draft = await factory.modify(list, List.setTitle(info.title ?? null), List.setDescription(info.description ?? null), List.setImage(info.image ?? null));
         yield await factory.sign(draft);
     };
 }

package/dist/actions/mailboxes.js

@@ -1,6 +1,6 @@
 import { kinds } from "nostr-tools";
 import { addInboxRelay, addOutboxRelay, removeInboxRelay, removeOutboxRelay } from "applesauce-factory/operations/tag";
-import { modifyPublicTags } from "applesauce-factory/operations/event";
+import { modifyPublicTags } from "applesauce-factory/operations";
 /** An action to create a new kind 10002 relay list event */
 export function CreateMailboxes(inboxes, outboxes) {
     return async function* ({ events, factory, self }) {

package/dist/actions/pins.d.ts

@@ -1,5 +1,6 @@
 import { NostrEvent } from "nostr-tools";
 import { Action } from "../action-hub.js";
+export declare const ALLOWED_PIN_KINDS: number[];
 /** 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 */

package/dist/actions/pins.js

@@ -1,13 +1,18 @@
+import { getReplaceableAddress, isReplaceable } from "applesauce-core/helpers";
+import { modifyPublicTags } from "applesauce-factory/operations";
+import { addAddressTag, addEventTag, removeAddressTag, removeEventTag } from "applesauce-factory/operations/tag";
 import { kinds } from "nostr-tools";
-import { addEventTag, removeEventTag } from "applesauce-factory/operations/tag";
-import { modifyPublicTags } from "applesauce-factory/operations/event";
+export const ALLOWED_PIN_KINDS = [kinds.ShortTextNote, kinds.LongFormArticle];
 /** An action that pins a note to the users pin list */
 export function PinNote(note) {
+    if (!ALLOWED_PIN_KINDS.includes(note.kind))
+        throw new Error(`Event kind ${note.kind} can not be pinned`);
     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));
+        const operation = isReplaceable(note.kind) ? addAddressTag(getReplaceableAddress(note)) : addEventTag(note.id);
+        const draft = pins
+            ? await factory.modifyTags(pins, operation)
+            : await factory.build({ kind: kinds.Pinlist }, modifyPublicTags(operation));
         yield await factory.sign(draft);
     };
 }
@@ -16,8 +21,11 @@ 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));
+            return;
+        const operation = isReplaceable(note.kind)
+            ? removeAddressTag(getReplaceableAddress(note))
+            : removeEventTag(note.id);
+        const draft = await factory.modifyTags(pins, operation);
         yield await factory.sign(draft);
     };
 }

package/dist/actions/profile.js

@@ -1,12 +1,12 @@
 import { kinds } from "nostr-tools";
-import { setProfileContent, updateProfileContent } from "applesauce-factory/operations/event";
+import { Profile } from "applesauce-factory/operations";
 /** 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));
+        const draft = await factory.build({ kind: kinds.Metadata }, Profile.setProfile(content));
         yield await factory.sign(draft);
     };
 }
@@ -16,7 +16,7 @@ export function UpdateProfile(content) {
         const metadata = events.getReplaceable(kinds.Metadata, self);
         if (!metadata)
             throw new Error("Profile does not exists");
-        const draft = await factory.modify(metadata, updateProfileContent(content));
+        const draft = await factory.modify(metadata, Profile.updateProfile(content));
         yield await factory.sign(draft);
     };
 }

package/dist/actions/relay-sets.js

@@ -1,4 +1,4 @@
-import { modifyHiddenTags, modifyPublicTags, setListDescription, setListImage, setListTitle, } from "applesauce-factory/operations/event";
+import { modifyHiddenTags, modifyPublicTags, List } from "applesauce-factory/operations";
 import { addRelayTag, removeRelayTag } from "applesauce-factory/operations/tag";
 import { kinds } from "nostr-tools";
 function getRelaySetEvent(events, self, identifier) {
@@ -30,7 +30,7 @@ export function RemoveRelayFromRelaySet(relay, identifier, hidden = false) {
 /** 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);
+        const draft = await factory.build({ kind: kinds.Relaysets }, List.setTitle(title), options?.description ? List.setDescription(options.description) : undefined, options?.image ? List.setImage(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);
     };
 }
@@ -38,7 +38,7 @@ export function CreateRelaySet(title, options) {
 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);
+        const draft = await factory.modify(relays, info?.title ? List.setTitle(info.title) : undefined, info?.description ? List.setDescription(info.description) : undefined, info?.image ? List.setImage(info.image) : undefined);
         yield await factory.sign(draft);
     };
 }

package/dist/actions/search-relays.js

@@ -1,4 +1,4 @@
-import { modifyHiddenTags, modifyPublicTags } from "applesauce-factory/operations/event";
+import { modifyHiddenTags, modifyPublicTags } from "applesauce-factory/operations";
 import { addRelayTag, removeRelayTag } from "applesauce-factory/operations/tag/relay";
 import { kinds } from "nostr-tools";
 function getSearchRelaysEvent(events, self) {

package/dist/actions/wrapped-messages.d.ts

@@ -1,6 +1,6 @@
 import { Rumor } from "applesauce-core/helpers";
 import { WrappedMessageBlueprintOptions } from "applesauce-factory/blueprints";
-import { GiftWrapOptions } from "applesauce-factory/operations/event";
+import { GiftWrapOptions } from "applesauce-factory/operations/gift-wrap";
 import { Action } from "../action-hub.js";
 /**
  * Sends a NIP-17 wrapped message to a conversation

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "applesauce-actions",
-  "version": "2.3.0",
+  "version": "3.1.0",
   "description": "A package for performing common nostr actions",
   "type": "module",
   "main": "dist/index.js",
@@ -32,15 +32,15 @@
     }
   },
   "dependencies": {
-    "applesauce-core": "^2.3.0",
-    "applesauce-factory": "^2.3.0",
-    "nostr-tools": "^2.13",
+    "applesauce-core": "^3.1.0",
+    "applesauce-factory": "^3.1.0",
+    "nostr-tools": "~2.15",
     "rxjs": "^7.8.1"
   },
   "devDependencies": {
     "@hirez_io/observer-spy": "^2.2.0",
     "@types/debug": "^4.1.12",
-    "applesauce-signers": "^2.0.0",
+    "applesauce-signers": "^3.1.0",
     "nanoid": "^5.1.5",
     "typescript": "^5.8.3",
     "vitest": "^3.2.3"