applesauce-common 0.0.0-next-20251203172109

package/dist/operations/torrent.d.ts

@@ -0,0 +1,33 @@
+import { EventOperation } from "applesauce-core/event-factory";
+import { TorrentExternalIdentifier, TorrentExternalIdentifierPrefix, TorrentFile } from "../helpers/torrent.js";
+/** Sets the BitTorrent info hash (required `x` tag) */
+export declare function setTorrentInfoHash(infoHash: string): EventOperation;
+/** Sets the torrent title */
+export declare function setTorrentTitle(title: string): EventOperation;
+/** Adds a file entry to the torrent */
+export declare function addTorrentFile(file: TorrentFile): EventOperation;
+/** Removes a file entry from the torrent */
+export declare function removeTorrentFile(fileName: string): EventOperation;
+/** Adds a tracker URL to the torrent */
+export declare function addTorrentTracker(tracker: string): EventOperation;
+/** Removes a tracker URL from the torrent */
+export declare function removeTorrentTracker(tracker: string): EventOperation;
+/** Sets the newznab category ID (replaces any existing newznab category) */
+export declare function setTorrentCategory(categoryId: number): EventOperation;
+/** Removes the newznab category ID */
+export declare function removeTorrentCategory(): EventOperation;
+/** Adds a search tag (for searchability) */
+export declare function addTorrentSearchTag(tag: string): EventOperation;
+/** Removes a search tag */
+export declare function removeTorrentSearchTag(tag: string): EventOperation;
+/** Sets the category path (tcat) */
+export declare function setTorrentCategoryPath(categoryPath: string): EventOperation;
+/** Adds an external identifier */
+export declare function addTorrentExternalIdentifier(identifier: TorrentExternalIdentifier): EventOperation;
+/**
+ * Adds an external identifier using prefix, id, and optional mediaType
+ * Convenience function that creates the identifier object automatically
+ */
+export declare function addTorrentExternalIdentifierByParts(prefix: TorrentExternalIdentifierPrefix, id: string, mediaType?: string): EventOperation;
+/** Removes an external identifier */
+export declare function removeTorrentExternalIdentifier(identifier: string): EventOperation;

package/dist/operations/torrent.js

@@ -0,0 +1,66 @@
+import { addNameValueTag, removeNameValueTag, setSingletonTag } from "applesauce-core/operations/tag/common";
+import { modifyPublicTags } from "applesauce-core/operations/tags";
+import { createTorrentExternalIdentifier, } from "../helpers/torrent.js";
+/** Sets the BitTorrent info hash (required `x` tag) */
+export function setTorrentInfoHash(infoHash) {
+    return modifyPublicTags(setSingletonTag(["x", infoHash]));
+}
+/** Sets the torrent title */
+export function setTorrentTitle(title) {
+    return modifyPublicTags(setSingletonTag(["title", title]));
+}
+/** Adds a file entry to the torrent */
+export function addTorrentFile(file) {
+    const tag = file.size
+        ? ["file", file.name, file.size.toString()]
+        : ["file", file.name];
+    return modifyPublicTags(addNameValueTag(tag, false));
+}
+/** Removes a file entry from the torrent */
+export function removeTorrentFile(fileName) {
+    return modifyPublicTags(removeNameValueTag(["file", fileName]));
+}
+/** Adds a tracker URL to the torrent */
+export function addTorrentTracker(tracker) {
+    return modifyPublicTags(addNameValueTag(["tracker", tracker], false));
+}
+/** Removes a tracker URL from the torrent */
+export function removeTorrentTracker(tracker) {
+    return modifyPublicTags(removeNameValueTag(["tracker", tracker]));
+}
+/** Sets the newznab category ID (replaces any existing newznab category) */
+export function setTorrentCategory(categoryId) {
+    return modifyPublicTags(setSingletonTag(["i", `newznab:${categoryId}`]));
+}
+/** Removes the newznab category ID */
+export function removeTorrentCategory() {
+    return modifyPublicTags((tags) => tags.filter((t) => !(t[0] === "i" && t[1]?.startsWith("newznab:"))));
+}
+/** Adds a search tag (for searchability) */
+export function addTorrentSearchTag(tag) {
+    return modifyPublicTags(addNameValueTag(["t", tag], false));
+}
+/** Removes a search tag */
+export function removeTorrentSearchTag(tag) {
+    return modifyPublicTags(removeNameValueTag(["t", tag]));
+}
+/** Sets the category path (tcat) */
+export function setTorrentCategoryPath(categoryPath) {
+    return modifyPublicTags(setSingletonTag(["i", `tcat:${categoryPath}`]));
+}
+/** Adds an external identifier */
+export function addTorrentExternalIdentifier(identifier) {
+    return modifyPublicTags(addNameValueTag(["i", identifier.identifier], false));
+}
+/**
+ * Adds an external identifier using prefix, id, and optional mediaType
+ * Convenience function that creates the identifier object automatically
+ */
+export function addTorrentExternalIdentifierByParts(prefix, id, mediaType) {
+    const identifier = createTorrentExternalIdentifier(prefix, id, mediaType);
+    return addTorrentExternalIdentifier(identifier);
+}
+/** Removes an external identifier */
+export function removeTorrentExternalIdentifier(identifier) {
+    return modifyPublicTags(removeNameValueTag(["i", identifier]));
+}

package/dist/operations/wrapped-message.d.ts

@@ -0,0 +1,12 @@
+import { EventOperation } from "applesauce-core/event-factory";
+import { Rumor } from "../helpers/gift-wrap.js";
+/**
+ * Sets the nessiary "p" tags for a wrapped message
+ * @param participants - The conversation identifier (pubkey1:pubkey2:pubkey3), a users pubkey, or a list of participant pubkeys
+ * @param self - The public key of the sender
+ */
+export declare function setConversation(participants: string | string[], self: string): EventOperation;
+/** Sets the subject of a wrapped message */
+export declare function setSubject(subject: string): EventOperation;
+/** Makes the wrapped message a reply to the parent message */
+export declare function setParent(parent: Rumor | string): EventOperation;

package/dist/operations/wrapped-message.js

@@ -0,0 +1,28 @@
+import { kinds } from "applesauce-core/helpers/event";
+import { eventPipe } from "applesauce-core/helpers/pipeline";
+import { includeNameValueTag } from "applesauce-core/operations/tags";
+import { getConversationParticipants } from "../helpers/messages.js";
+/**
+ * Sets the nessiary "p" tags for a wrapped message
+ * @param participants - The conversation identifier (pubkey1:pubkey2:pubkey3), a users pubkey, or a list of participant pubkeys
+ * @param self - The public key of the sender
+ */
+export function setConversation(participants, self) {
+    const keys = new Set(typeof participants === "string" ? getConversationParticipants(participants) : participants);
+    // NOTE: do not include the sender in the message. their pubkey will be attached to the message in "pubkey"
+    keys.delete(self);
+    // TODO: support relay hints
+    return eventPipe(...Array.from(keys).map((key) => includeNameValueTag(["p", key])));
+}
+/** Sets the subject of a wrapped message */
+export function setSubject(subject) {
+    return includeNameValueTag(["subject", subject]);
+}
+/** Makes the wrapped message a reply to the parent message */
+export function setParent(parent) {
+    if (typeof parent !== "string" && parent.kind !== kinds.PrivateDirectMessage)
+        throw new Error("Parent must be a private direct message event");
+    const id = typeof parent === "string" ? parent : parent.id;
+    // TODO: support relay hints
+    return includeNameValueTag(["e", id]);
+}

package/dist/operations/zap-split.d.ts

@@ -0,0 +1,10 @@
+import { EventOperation } from "applesauce-core/event-factory";
+import { ZapSplit } from "../helpers/zap.js";
+/** Override the zap splits on an event */
+export declare function setZapSplitTags(splits: Omit<ZapSplit, "percent" | "relay">[]): EventOperation;
+/** Options for {@link setZapSplit} */
+export type ZapOptions = {
+    splits?: Omit<ZapSplit, "percent" | "relay">[];
+};
+/** Creates the necessary operations for zap options */
+export declare function setZapSplit(options?: ZapOptions): EventOperation;

package/dist/operations/zap-split.js

@@ -0,0 +1,20 @@
+import { skip } from "applesauce-core/helpers/pipeline";
+import { fillAndTrimTag } from "applesauce-core/helpers/tags";
+/** Override the zap splits on an event */
+export function setZapSplitTags(splits) {
+    return async (draft, ctx) => {
+        let tags = Array.from(draft.tags);
+        // remove any existing zap split tags
+        tags = tags.filter((t) => t[0] !== "zap");
+        // add split tags
+        for (const split of splits) {
+            const hint = await ctx.getPubkeyRelayHint?.(split.pubkey);
+            tags.push(fillAndTrimTag(["zap", split.pubkey, hint, String(split.weight)]));
+        }
+        return { ...draft, tags };
+    };
+}
+/** Creates the necessary operations for zap options */
+export function setZapSplit(options) {
+    return options?.splits ? setZapSplitTags(options.splits) : skip();
+}

package/dist/register.d.ts

@@ -0,0 +1,11 @@
+import "./models/blossom.js";
+import "./models/mutes.js";
+import "./models/reactions.js";
+import "./models/comments.js";
+import "./models/thread.js";
+import "./blueprints/comment.js";
+import "./blueprints/delete.js";
+import "./blueprints/note.js";
+import "./blueprints/reaction.js";
+import "./blueprints/share.js";
+import "./blueprints/poll.js";

package/dist/register.js

@@ -0,0 +1,13 @@
+// Import models that should register with the event store
+import "./models/blossom.js";
+import "./models/mutes.js";
+import "./models/reactions.js";
+import "./models/comments.js";
+import "./models/thread.js";
+// Import blueprints that should register with the event factory
+import "./blueprints/comment.js";
+import "./blueprints/delete.js";
+import "./blueprints/note.js";
+import "./blueprints/reaction.js";
+import "./blueprints/share.js";
+import "./blueprints/poll.js";

package/package.json

@@ -0,0 +1,91 @@
+{
+  "name": "applesauce-common",
+  "version": "0.0.0-next-20251203172109",
+  "description": "Common NIP-specific helpers and models for applesauce",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "keywords": [
+    "nostr",
+    "applesauce"
+  ],
+  "author": "hzrd149",
+  "license": "MIT",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./helpers": {
+      "import": "./dist/helpers/index.js",
+      "require": "./dist/helpers/index.js",
+      "types": "./dist/helpers/index.d.ts"
+    },
+    "./helpers/*": {
+      "import": "./dist/helpers/*.js",
+      "require": "./dist/helpers/*.js",
+      "types": "./dist/helpers/*.d.ts"
+    },
+    "./models": {
+      "import": "./dist/models/index.js",
+      "require": "./dist/models/index.js",
+      "types": "./dist/models/index.d.ts"
+    },
+    "./models/*": {
+      "import": "./dist/models/*.js",
+      "require": "./dist/models/*.js",
+      "types": "./dist/models/*.d.ts"
+    },
+    "./operations": {
+      "import": "./dist/operations/index.js",
+      "require": "./dist/operations/index.js",
+      "types": "./dist/operations/index.d.ts"
+    },
+    "./operations/*": {
+      "import": "./dist/operations/*.js",
+      "require": "./dist/operations/*.js",
+      "types": "./dist/operations/*.d.ts"
+    },
+    "./blueprints": {
+      "import": "./dist/blueprints/index.js",
+      "require": "./dist/blueprints/index.js",
+      "types": "./dist/blueprints/index.d.ts"
+    },
+    "./blueprints/*": {
+      "import": "./dist/blueprints/*.js",
+      "require": "./dist/blueprints/*.js",
+      "types": "./dist/blueprints/*.d.ts"
+    }
+  },
+  "dependencies": {
+    "@scure/base": "^1.2.4",
+    "applesauce-core": "0.0.0-next-20251203172109",
+    "hash-sum": "^2.0.0",
+    "light-bolt11-decoder": "^3.2.0",
+    "rxjs": "^7.8.1"
+  },
+  "devDependencies": {
+    "@hirez_io/observer-spy": "^2.2.0",
+    "@types/debug": "^4.1.12",
+    "@types/hash-sum": "^1.0.2",
+    "nostr-tools": "^2.18",
+    "rimraf": "^6.0.1",
+    "typescript": "^5.8.3",
+    "vitest": "^4.0.15"
+  },
+  "funding": {
+    "type": "lightning",
+    "url": "lightning:nostrudel@geyser.fund"
+  },
+  "scripts": {
+    "prebuild": "rimraf dist",
+    "build": "tsc",
+    "watch:build": "tsc --watch > /dev/null",
+    "test": "vitest run --passWithNoTests",
+    "watch:test": "vitest"
+  }
+}