applesauce-core 5.1.0 → 6.0.0

package/dist/operations/tags.js

@@ -12,21 +12,23 @@ export function includeNameValueTag(tag, replace = true) {
 }
 /** An event operation that modifies the public tags with {@link TagOperation}s */
 export function modifyPublicTags(...operations) {
-    return async (draft, ctx) => {
-        return { ...draft, tags: await tagPipe(...operations)(Array.from(draft.tags), ctx) };
+    return async (draft) => {
+        return { ...draft, tags: await tagPipe(...operations)(Array.from(draft.tags)) };
     };
 }
 /**
  * Creates an event operation that modifies the hidden tags on an event with {@link TagOperation}s
+ * @param signer - EventSigner for encrypting/decrypting hidden tags
+ * @param operations - Tag operations to apply to hidden tags
  * @throws {Error} if no signer is provided
  * @throws {Error} if the event kind does not support hidden tags
  */
-export function modifyHiddenTags(...operations) {
+export function modifyHiddenTags(signer, ...operations) {
     operations = operations.filter((o) => !!o);
     if (operations.length === 0)
         return skip();
-    return async (draft, ctx) => {
-        if (!ctx.signer)
+    return async (draft) => {
+        if (!signer)
             throw new Error("Missing signer for hidden tags");
         if (!canHaveHiddenTags(draft.kind))
             throw new Error("Event kind does not support hidden tags");
@@ -41,8 +43,8 @@ export function modifyHiddenTags(...operations) {
             if (hidden === undefined) {
                 if (hasHiddenTags(draft)) {
                     // draft is an existing event, attempt to unlock tags
-                    pubkey = await ctx.signer.getPublicKey();
-                    hidden = await unlockHiddenTags({ ...draft, pubkey }, ctx.signer);
+                    pubkey = await signer.getPublicKey();
+                    hidden = await unlockHiddenTags({ ...draft, pubkey }, signer);
                 }
                 // create a new array of hidden tags
                 else
@@ -56,19 +58,23 @@ export function modifyHiddenTags(...operations) {
         if (hidden === undefined)
             throw new Error("Failed to find hidden tags");
         // Create the new hidden tags
-        const tags = await tagPipe(...operations)(hidden, ctx);
+        const tags = await tagPipe(...operations)(hidden);
         // Encrypt new hidden tags
-        const methods = getHiddenTagsEncryptionMethods(draft.kind, ctx.signer);
+        const methods = getHiddenTagsEncryptionMethods(draft.kind, signer);
         if (!pubkey)
-            pubkey = await ctx.signer.getPublicKey();
+            pubkey = await signer.getPublicKey();
         const plaintext = JSON.stringify(tags);
         const content = await methods.encrypt(pubkey, plaintext);
         // add the plaintext content on the draft so it can be carried forward
         return { ...draft, content, [EncryptedContentSymbol]: plaintext };
     };
 }
-/** A flexible method for creating an event operation that modifies the tags */
-export function modifyTags(tagOperations) {
+/**
+ * A flexible method for creating an event operation that modifies the tags
+ * @param tagOperations - Tag operations for public and/or hidden tags
+ * @param signer - Optional signer (required if modifying hidden tags)
+ */
+export function modifyTags(tagOperations, signer) {
     let publicOperations = [];
     let hiddenOperations = [];
     // normalize tag operation arg
@@ -89,5 +95,5 @@ export function modifyTags(tagOperations) {
             hiddenOperations = tagOperations.hidden;
     }
     // return a new event operation that modifies the tags
-    return eventPipe(publicOperations.length > 0 ? modifyPublicTags(...publicOperations) : undefined, hiddenOperations.length > 0 ? modifyHiddenTags(...hiddenOperations) : undefined);
+    return eventPipe(publicOperations.length > 0 ? modifyPublicTags(...publicOperations) : undefined, hiddenOperations.length > 0 ? modifyHiddenTags(signer, ...hiddenOperations) : undefined);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "applesauce-core",
-  "version": "5.1.0",
+  "version": "6.0.0",
   "description": "",
   "type": "module",
   "main": "dist/index.js",
@@ -60,10 +60,15 @@
       "require": "./dist/event-store/index.js",
       "types": "./dist/event-store/index.d.ts"
     },
-    "./event-factory": {
-      "import": "./dist/event-factory/index.js",
-      "require": "./dist/event-factory/index.js",
-      "types": "./dist/event-factory/index.d.ts"
+    "./factories": {
+      "import": "./dist/factories/index.js",
+      "require": "./dist/factories/index.js",
+      "types": "./dist/factories/index.d.ts"
+    },
+    "./factories/*": {
+      "import": "./dist/factories/*.js",
+      "require": "./dist/factories/*.js",
+      "types": "./dist/factories/*.d.ts"
     },
     "./operations": {
       "import": "./dist/operations/index.js",
@@ -74,6 +79,16 @@
       "import": "./dist/operations/*.js",
       "require": "./dist/operations/*.js",
       "types": "./dist/operations/*.d.ts"
+    },
+    "./casts": {
+      "import": "./dist/casts/index.js",
+      "require": "./dist/casts/index.js",
+      "types": "./dist/casts/index.d.ts"
+    },
+    "./casts/*": {
+      "import": "./dist/casts/*.js",
+      "require": "./dist/casts/*.js",
+      "types": "./dist/casts/*.d.ts"
     }
   },
   "dependencies": {

package/dist/event-factory/event-factory.d.ts

@@ -1,57 +0,0 @@
-import { EventTemplate, NostrEvent, UnsignedEvent } from "../helpers/event.js";
-import { ModifyTagsOptions } from "../operations/tags.js";
-import { EventFactoryTemplate } from "./methods.js";
-import { EventBlueprint, EventFactoryContext, EventOperation, IEventFactory } from "./types.js";
-/**
- * Base class that provides event creation functionality.
- * This class can be extended by other packages to add additional helpful event creation methods.
- *
- * @example
- * ```ts
- * // In another package (e.g., applesauce-common)
- * import { EventFactory } from "applesauce-core/event-factory";
- * import { NoteBlueprint, ReactionBlueprint } from "applesauce-common/blueprints";
- *
- * // Add methods to the prototype
- * EventFactory.prototype.note = function(content, options) {
- *   return this.create(NoteBlueprint, content, options);
- * };
- *
- * EventFactory.prototype.reaction = function(event, emoji) {
- *   return this.create(ReactionBlueprint, event, emoji);
- * };
- *
- * // Extend the type via module augmentation
- * declare module "applesauce-core/event-factory" {
- *   interface EventFactory {
- *     note(content: string, options?: NoteBlueprintOptions): Promise<EventTemplate>;
- *     reaction(event: NostrEvent, emoji?: string): Promise<EventTemplate>;
- *   }
- * }
- * ```
- */
-export declare class EventFactory implements IEventFactory {
-    context: EventFactoryContext;
-    constructor(context?: EventFactoryContext);
-    /** Build an event template with operations */
-    build(template: EventFactoryTemplate, ...operations: (EventOperation | undefined)[]): Promise<EventTemplate>;
-    /** Create an event from a blueprint */
-    create<T extends EventTemplate | UnsignedEvent | NostrEvent>(blueprint: EventBlueprint<T>): Promise<T>;
-    create<T extends EventTemplate | UnsignedEvent | NostrEvent, Args extends Array<any>>(blueprint: (...args: Args) => EventBlueprint<T>, ...args: Args): Promise<T>;
-    /** Modify an existing event with operations and updated the created_at */
-    modify(draft: EventTemplate | UnsignedEvent | NostrEvent, ...operations: (EventOperation | undefined)[]): Promise<EventTemplate>;
-    /** Modify a lists public and hidden tags and updated the created_at */
-    modifyTags(event: EventTemplate | UnsignedEvent | NostrEvent, tagOperations?: ModifyTagsOptions, eventOperations?: EventOperation | (EventOperation | undefined)[]): Promise<EventTemplate>;
-    /** Attaches the signers pubkey to an event template */
-    stamp(draft: EventTemplate | UnsignedEvent): Promise<UnsignedEvent>;
-    /** Signs a event template with the signer */
-    sign(draft: EventTemplate | UnsignedEvent): Promise<NostrEvent>;
-    /** Sets the signer in the context */
-    setSigner(signer: EventFactoryContext["signer"]): void;
-    /** clears the signer in the context */
-    clearSigner(): void;
-    /** sets the client in the context */
-    setClient(client: EventFactoryContext["client"]): void;
-    /** clears the client in the context */
-    clearClient(): void;
-}

package/dist/event-factory/event-factory.js

@@ -1,94 +0,0 @@
-import { sign, stamp } from "../operations/event.js";
-import { modifyTags } from "../operations/tags.js";
-import { buildEvent, modifyEvent } from "./methods.js";
-/**
- * Base class that provides event creation functionality.
- * This class can be extended by other packages to add additional helpful event creation methods.
- *
- * @example
- * ```ts
- * // In another package (e.g., applesauce-common)
- * import { EventFactory } from "applesauce-core/event-factory";
- * import { NoteBlueprint, ReactionBlueprint } from "applesauce-common/blueprints";
- *
- * // Add methods to the prototype
- * EventFactory.prototype.note = function(content, options) {
- *   return this.create(NoteBlueprint, content, options);
- * };
- *
- * EventFactory.prototype.reaction = function(event, emoji) {
- *   return this.create(ReactionBlueprint, event, emoji);
- * };
- *
- * // Extend the type via module augmentation
- * declare module "applesauce-core/event-factory" {
- *   interface EventFactory {
- *     note(content: string, options?: NoteBlueprintOptions): Promise<EventTemplate>;
- *     reaction(event: NostrEvent, emoji?: string): Promise<EventTemplate>;
- *   }
- * }
- * ```
- */
-export class EventFactory {
-    context;
-    constructor(context = {}) {
-        this.context = context;
-    }
-    /** Build an event template with operations */
-    async build(template, ...operations) {
-        return await buildEvent(template, this.context, ...operations);
-    }
-    async create(blueprint, ...args) {
-        // Context, blueprint(context)
-        if (arguments.length === 1) {
-            return (await blueprint(this.context));
-        }
-        // Context, blueprintConstructor(...args)(context), ...args
-        else {
-            const constructor = blueprint;
-            return await constructor(...args)(this.context);
-        }
-    }
-    /** Modify an existing event with operations and updated the created_at */
-    async modify(draft, ...operations) {
-        return await modifyEvent(draft, this.context, ...operations);
-    }
-    /** Modify a lists public and hidden tags and updated the created_at */
-    async modifyTags(event, tagOperations, eventOperations) {
-        let eventOperationsArr = [];
-        // normalize event operation arg
-        if (eventOperations === undefined)
-            eventOperationsArr = [];
-        else if (typeof eventOperations === "function")
-            eventOperationsArr = [eventOperations];
-        else if (Array.isArray(eventOperations))
-            eventOperationsArr = eventOperations.filter((e) => !!e);
-        // modify event
-        return await this.modify(event, modifyTags(tagOperations), ...eventOperationsArr);
-    }
-    /** Attaches the signers pubkey to an event template */
-    async stamp(draft) {
-        return await stamp()(draft, this.context);
-    }
-    /** Signs a event template with the signer */
-    async sign(draft) {
-        return await sign()(draft, this.context);
-    }
-    // Helpers
-    /** Sets the signer in the context */
-    setSigner(signer) {
-        this.context.signer = signer;
-    }
-    /** clears the signer in the context */
-    clearSigner() {
-        this.context.signer = undefined;
-    }
-    /** sets the client in the context */
-    setClient(client) {
-        this.context.client = client;
-    }
-    /** clears the client in the context */
-    clearClient() {
-        this.context.client = undefined;
-    }
-}

package/dist/event-factory/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./types.js";
-export * from "./event-factory.js";
-export * from "./methods.js";

package/dist/event-factory/index.js

@@ -1,3 +0,0 @@
-export * from "./types.js";
-export * from "./event-factory.js";
-export * from "./methods.js";

package/dist/event-factory/methods.d.ts

@@ -1,17 +0,0 @@
-import { EventTemplate, NostrEvent, UnsignedEvent } from "../helpers/event.js";
-import { EventBlueprint, EventFactoryContext, EventOperation } from "./types.js";
-export type EventFactoryTemplate = {
-    kind: number;
-    content?: string;
-    tags?: string[][];
-    created_at?: number;
-};
-/** Creates an event using a template, context, and a set of operations */
-export declare function buildEvent(template: EventFactoryTemplate, context: EventFactoryContext, ...operations: (EventOperation | undefined)[]): Promise<EventTemplate>;
-/** Creates a blueprint function with operations */
-export declare function blueprint(kind: number, ...operations: (EventOperation | undefined)[]): EventBlueprint;
-/** Creates an event from a context and a blueprint */
-export declare function createEvent<T extends EventTemplate | UnsignedEvent | NostrEvent>(context: EventFactoryContext, blueprint: EventBlueprint<T>): Promise<T>;
-export declare function createEvent<T extends EventTemplate | UnsignedEvent | NostrEvent, Args extends Array<any>>(context: EventFactoryContext, blueprintConstructor: (...args: Args) => EventBlueprint<T>, ...args: Args): Promise<T>;
-/** Modifies an event using a context and a set of operations */
-export declare function modifyEvent(event: EventTemplate | UnsignedEvent | NostrEvent, context: EventFactoryContext, ...operations: (EventOperation | undefined)[]): Promise<EventTemplate>;

package/dist/event-factory/methods.js

@@ -1,44 +0,0 @@
-import { EncryptedContentSymbol } from "../helpers/encrypted-content.js";
-import { isEvent } from "../helpers/event.js";
-import { eventPipe } from "../helpers/pipeline.js";
-import { unixNow } from "../helpers/time.js";
-import { setClient } from "../operations/client.js";
-import { includeReplaceableIdentifier, stripSignature, stripStamp, stripSymbols, updateCreatedAt, } from "../operations/event.js";
-/** Wraps a set of operations with common event operations */
-function wrapCommon(...operations) {
-    return eventPipe(
-    // Remove all symbols from the event except for the encrypted content symbol
-    stripSymbols([EncryptedContentSymbol]), 
-    // Ensure all addressable events have "d" tags
-    includeReplaceableIdentifier(), 
-    // Apply operations
-    ...operations, 
-    // Include client tag if its set in the context
-    (draft, ctx) => (ctx.client ? setClient(ctx.client.name, ctx.client.address)(draft, ctx) : draft));
-}
-/** Creates an event using a template, context, and a set of operations */
-export async function buildEvent(template, context, ...operations) {
-    return await wrapCommon(stripSignature(), stripStamp(), ...operations)({ created_at: unixNow(), tags: [], content: "", ...template }, context);
-}
-/** Creates a blueprint function with operations */
-export function blueprint(kind, ...operations) {
-    return async (context) => await buildEvent({ kind }, context, ...operations);
-}
-export async function createEvent(context, blueprint, ...args) {
-    // Context, blueprint(context)
-    if (arguments.length === 2) {
-        return (await blueprint(context));
-    }
-    // Context, blueprintConstructor(...args)(context), ...args
-    else {
-        const constructor = blueprint;
-        return await constructor(...args)(context);
-    }
-}
-/** Modifies an event using a context and a set of operations */
-export async function modifyEvent(event, context, ...operations) {
-    // NOTE: Unwrapping evnet object in order to handle cast events from applesauce-common
-    if ("event" in event && isEvent(event.event))
-        event = event.event;
-    return await wrapCommon(stripSignature(), stripStamp(), updateCreatedAt(), ...operations)(event, context);
-}

package/dist/event-factory/types.d.ts

@@ -1,76 +0,0 @@
-import { EventTemplate, NostrEvent, UnsignedEvent } from "../helpers/event.js";
-import { AddressPointer } from "../helpers/pointers.js";
-import { ModifyTagsOptions } from "../operations/tags.js";
-import { EventFactoryTemplate } from "./methods.js";
-/** Nostr event signer */
-export interface EventSigner {
-    getPublicKey: () => Promise<string> | string;
-    signEvent: (draft: EventTemplate | UnsignedEvent) => Promise<NostrEvent> | NostrEvent;
-    nip04?: {
-        encrypt: (pubkey: string, plaintext: string) => Promise<string> | string;
-        decrypt: (pubkey: string, ciphertext: string) => Promise<string> | string;
-    };
-    nip44?: {
-        encrypt: (pubkey: string, plaintext: string) => Promise<string> | string;
-        decrypt: (pubkey: string, ciphertext: string) => Promise<string> | string;
-    };
-}
-/** A context with optional methods for getting relay hints */
-export interface RelayHintContext {
-    getEventRelayHint?: (event: string) => string | undefined | Promise<string> | Promise<undefined>;
-    getPubkeyRelayHint?: (pubkey: string) => string | undefined | Promise<string> | Promise<undefined>;
-}
-/** A context with an optional signer */
-export interface EventSignerContext {
-    signer?: EventSigner;
-}
-export interface EventFactoryClient {
-    name: string;
-    address?: Omit<AddressPointer, "kind" | "relays">;
-}
-/** A context with an optional NIP-89 app pointer */
-export interface ClientPointerContext {
-    client?: EventFactoryClient;
-}
-/** NIP-30 emoji type. this should be moved out of the core package to common */
-export type Emoji = {
-    /** The emoji shortcode (without the ::) */
-    shortcode: string;
-    /** The URL to the emoji image */
-    url: string;
-};
-export interface EmojiContext {
-    /** An array of custom emojis that will be used for text notes */
-    emojis?: Emoji[];
-}
-/** All options that can be passed when building an event */
-export interface EventFactoryContext extends ClientPointerContext, EventSignerContext, RelayHintContext, EmojiContext {
-}
-/** A single operation that modifies an events public or hidden tags array */
-export type Operation<I extends unknown = unknown, R extends unknown = unknown> = (value: I, context: EventFactoryContext) => R | Promise<R>;
-/** A single operation that modifies an events public or hidden tags array */
-export type TagOperation = Operation<string[][], string[][]>;
-/** A single operation that modifies an event */
-export type EventOperation<I extends EventTemplate | UnsignedEvent | NostrEvent = EventTemplate, R extends EventTemplate | UnsignedEvent | NostrEvent = EventTemplate> = Operation<I, R>;
-/** A method that creates a new event based on a set of operations */
-export type EventBlueprint<T extends EventTemplate | UnsignedEvent | NostrEvent = EventTemplate> = (context: EventFactoryContext) => Promise<T>;
-/**
- * Core helpful event creation interface.
- * Contains only methods that use blueprints from the core package.
- * Other packages (like applesauce-common) can extend this interface via module augmentation.
- */
-export interface IEventFactory {
-    /** Build an event template with operations */
-    build(template: EventFactoryTemplate, ...operations: (EventOperation | undefined)[]): Promise<EventTemplate>;
-    /** Create an event from a blueprint */
-    create<T extends EventTemplate | UnsignedEvent | NostrEvent>(blueprint: EventBlueprint<T>): Promise<T>;
-    create<T extends EventTemplate | UnsignedEvent | NostrEvent, Args extends Array<any>>(blueprint: (...args: Args) => EventBlueprint<T>, ...args: Args): Promise<T>;
-    /** Modify an existing event with operations and updated the created_at */
-    modify(draft: EventTemplate | UnsignedEvent | NostrEvent, ...operations: (EventOperation | undefined)[]): Promise<EventTemplate>;
-    /** Modify a lists public and hidden tags and updated the created_at */
-    modifyTags(event: EventTemplate | UnsignedEvent | NostrEvent, tagOperations?: ModifyTagsOptions, eventOperations?: EventOperation | (EventOperation | undefined)[]): Promise<EventTemplate>;
-    /** Attaches the signers pubkey to an event template */
-    stamp(draft: EventTemplate | UnsignedEvent): Promise<UnsignedEvent>;
-    /** Signs a event template with the signer */
-    sign(draft: EventTemplate | UnsignedEvent): Promise<NostrEvent>;
-}