nostr-comments 0.1.0

package/dist/services/comment.d.ts

@@ -0,0 +1,32 @@
+import type { NostrEvent } from "nostr-tools";
+import type { Signer } from "../signers/types";
+import type { Comment } from "../types";
+export interface FetchCommentsOptions {
+    url: string;
+    relays: string[];
+    limit?: number;
+    until?: number;
+}
+export interface SubscribeCommentsOptions {
+    url: string;
+    relays: string[];
+    limit?: number;
+    onEvent: (event: NostrEvent) => void;
+    onEose?: () => void;
+}
+export declare function subscribeComments(options: SubscribeCommentsOptions): () => void;
+export declare function fetchComments(options: FetchCommentsOptions): Promise<NostrEvent[]>;
+export declare function publishComment(signer: Signer, options: {
+    url: string;
+    content: string;
+    relays?: string[];
+    authorPubkeys?: string[];
+}): Promise<NostrEvent>;
+export declare function publishReply(signer: Signer, options: {
+    url: string;
+    content: string;
+    parentEvent: NostrEvent;
+    relays?: string[];
+    authorPubkeys?: string[];
+}): Promise<NostrEvent>;
+export declare function buildCommentTree(events: NostrEvent[]): Comment[];

package/dist/services/nostr.d.ts

@@ -0,0 +1,6 @@
+import type { Filter, NostrEvent } from "nostr-tools";
+export declare function getDefaultRelays(): string[];
+export declare function queryEvents(relays: string[], filter: Filter): Promise<NostrEvent[]>;
+export declare function subscribeEvents(relays: string[], filter: Filter, onEvent: (event: NostrEvent) => void, onEose?: () => void): () => void;
+export declare function publishEvent(relays: string[], event: NostrEvent): Promise<void>;
+export declare function getRelays(relays?: string[], authors?: string[]): Promise<string[]>;

package/dist/services/reaction.d.ts

@@ -0,0 +1,18 @@
+import type { NostrEvent, EventTemplate } from 'nostr-tools';
+import type { Signer } from '../signers/types';
+export interface FetchReactionsOptions {
+    eventIds: string[];
+    relays: string[];
+}
+export interface SubscribeReactionsOptions {
+    eventIds: string[];
+    relays: string[];
+    onEvent: (event: NostrEvent) => void;
+    onEose?: () => void;
+}
+export declare function subscribeReactions(options: SubscribeReactionsOptions): () => void;
+export declare function fetchReactions(options: FetchReactionsOptions): Promise<NostrEvent[]>;
+export declare function buildReactionEvent(targetEvent: NostrEvent, content?: string): EventTemplate;
+export declare function publishReaction(signer: Signer, relays: string[], targetEvent: NostrEvent, content?: string): Promise<NostrEvent>;
+export declare function countLikes(reactions: NostrEvent[], eventId: string): number;
+export declare function hasLiked(reactions: NostrEvent[], eventId: string, pubkey: string): boolean;

package/dist/signers/BunkerSigner.d.ts

@@ -0,0 +1,13 @@
+import type { EventTemplate, VerifiedEvent } from "nostr-tools";
+import { BunkerSigner as Nip46Signer } from "nostr-tools/nip46";
+import type { Signer } from "./types";
+export declare class BunkerSigner implements Signer {
+    private signer;
+    private cachedPubKey;
+    constructor(signer: Nip46Signer);
+    connect(): Promise<void>;
+    getPublicKey(): Promise<string>;
+    signEvent(event: EventTemplate): Promise<VerifiedEvent>;
+    close(): Promise<void>;
+    static create(bunkerUrl: string): Promise<BunkerSigner>;
+}

package/dist/signers/Nip07Signer.d.ts

@@ -0,0 +1,16 @@
+import type { EventTemplate, VerifiedEvent } from 'nostr-tools';
+import type { Signer } from './types';
+declare global {
+    interface Window {
+        nostr?: {
+            getPublicKey: () => Promise<string>;
+            signEvent: (event: EventTemplate) => Promise<VerifiedEvent>;
+        };
+    }
+}
+export declare class Nip07Signer implements Signer {
+    private cachedPubKey;
+    static isAvailable(): boolean;
+    getPublicKey(): Promise<string>;
+    signEvent(event: EventTemplate): Promise<VerifiedEvent>;
+}

package/dist/signers/TempSigner.d.ts

@@ -0,0 +1,19 @@
+import type { EventTemplate, VerifiedEvent } from 'nostr-tools';
+import type { Signer } from './types';
+export declare class TempSigner implements Signer {
+    private secretKey;
+    private pubkey;
+    constructor(secretKey?: Uint8Array);
+    getPublicKey(): Promise<string>;
+    signEvent(event: EventTemplate): Promise<VerifiedEvent>;
+    getNsec(): string;
+    getNpub(): string;
+    exportKeyFile(): {
+        nsec: string;
+        npub: string;
+        pubkey: string;
+    };
+    downloadKeyFile(): void;
+    copyNsec(): Promise<void>;
+    static fromNsec(nsec: string): TempSigner;
+}

package/dist/signers/index.d.ts

@@ -0,0 +1,4 @@
+export type { Signer, SignerType, SignerInfo } from "./types";
+export { Nip07Signer } from "./Nip07Signer";
+export { TempSigner } from "./TempSigner";
+export { BunkerSigner } from "./BunkerSigner";

package/dist/signers/types.d.ts

@@ -0,0 +1,10 @@
+import type { EventTemplate, VerifiedEvent } from 'nostr-tools';
+export interface Signer {
+    getPublicKey(): Promise<string>;
+    signEvent(event: EventTemplate): Promise<VerifiedEvent>;
+}
+export type SignerType = 'nip07' | 'bunker' | 'temp';
+export interface SignerInfo {
+    type: SignerType;
+    pubkey: string;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,80 @@
+import type { NostrEvent } from "nostr-tools";
+export interface Comment {
+    event: NostrEvent;
+    children: Comment[];
+    /** Parent comment event when this is a nested reply (depth >= 2) */
+    replyTo?: NostrEvent;
+}
+export interface Profile {
+    pubkey: string;
+    name?: string;
+    displayName?: string;
+    picture?: string;
+    nip05?: string;
+    about?: string;
+}
+export interface Translations {
+    comments: string;
+    writeComment: string;
+    reply: string;
+    replyTo: string;
+    publish: string;
+    publishing: string;
+    cancel: string;
+    login: string;
+    logout: string;
+    loginRequired: string;
+    loginDescription: string;
+    extensionLogin: string;
+    extensionLoginDesc: string;
+    bunkerLogin: string;
+    bunkerLoginDesc: string;
+    bunkerUrlPlaceholder: string;
+    connect: string;
+    connecting: string;
+    tempAccount: string;
+    tempAccountDesc: string;
+    tempAccountCreated: string;
+    createAccount: string;
+    copyKey: string;
+    keyCopied: string;
+    downloadKey: string;
+    keyCompatibility: string;
+    startCommenting: string;
+    importKey: string;
+    importKeyDesc: string;
+    importKeyPlaceholder: string;
+    importKeyError: string;
+    like: string;
+    liked: string;
+    loadMore: string;
+    loading: string;
+    noComments: string;
+    error: string;
+    retry: string;
+    anonymous: string;
+    timeJustNow: string;
+    timeMinutesAgo: string;
+    timeHoursAgo: string;
+    timeDaysAgo: string;
+}
+export interface NostrCommentsProps {
+    url: string;
+    authorPubkeys?: string[];
+    relays?: string[];
+    pageSize?: number;
+    locale?: string;
+    translations?: Partial<Translations>;
+    theme?: "light" | "dark" | "auto";
+    headless?: boolean;
+    classNames?: {
+        root?: string;
+        list?: string;
+        item?: string;
+        editor?: string;
+        loginModal?: string;
+    };
+    enabledSigners?: ("nip07" | "bunker" | "temp")[];
+    onCommentPublished?: (event: NostrEvent) => void;
+    onError?: (error: Error) => void;
+}

package/dist/utils/avatar.d.ts

@@ -0,0 +1,3 @@
+export declare function getColorFromPubkey(pubkey: string): string;
+export declare function generateAvatarSvg(pubkey: string, size?: number): string;
+export declare function getAvatarDataUrl(pubkey: string, size?: number): string;

package/dist/utils/ensureStyles.d.ts

@@ -0,0 +1 @@
+export declare function ensureStyles(): void;

package/dist/utils/nip22.d.ts

@@ -0,0 +1,17 @@
+import type { EventTemplate, NostrEvent } from "nostr-tools";
+export interface WebCommentOptions {
+    url: string;
+    content: string;
+    authorPubkeys?: string[];
+}
+export interface ReplyCommentOptions {
+    url: string;
+    content: string;
+    parentEvent: NostrEvent;
+    authorPubkeys?: string[];
+}
+export declare function buildWebComment(options: WebCommentOptions): EventTemplate;
+export declare function buildReplyComment(options: ReplyCommentOptions): EventTemplate;
+export declare function isReply(event: NostrEvent): boolean;
+export declare function getParentId(event: NostrEvent): string | null;
+export declare function getRootUrl(event: NostrEvent): string | null;

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "nostr-comments",
+  "version": "0.1.0",
+  "description": "A Nostr-based web comment component using NIP-22 protocol",
+  "type": "module",
+  "main": "./dist/nostr-comments.cjs",
+  "module": "./dist/nostr-comments.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/nostr-comments.js",
+      "require": "./dist/nostr-comments.cjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "dev": "vite",
+    "build": "vite build && tsc --emitDeclarationOnly",
+    "preview": "vite preview",
+    "storybook": "storybook dev -p 6006",
+    "build-storybook": "storybook build"
+  },
+  "keywords": [
+    "nostr",
+    "comments",
+    "nip-22",
+    "react",
+    "web-component"
+  ],
+  "author": "",
+  "license": "MIT",
+  "peerDependencies": {
+    "react": "^18.0.0 || ^19.0.0",
+    "react-dom": "^18.0.0 || ^19.0.0"
+  },
+  "dependencies": {
+    "@nostr/gadgets": "npm:@jsr/nostr__gadgets@^0.0.46",
+    "lucide-react": "^0.563.0",
+    "nostr-tools": "^2.10.4"
+  },
+  "devDependencies": {
+    "@chromatic-com/storybook": "^5.0.0",
+    "@storybook/addon-a11y": "^10.2.0",
+    "@storybook/addon-docs": "^10.2.0",
+    "@storybook/addon-vitest": "^10.2.0",
+    "@storybook/react-vite": "^10.2.0",
+    "@types/react": "^19.1.6",
+    "@types/react-dom": "^19.1.5",
+    "@vitejs/plugin-react": "^4.5.1",
+    "@vitest/browser-playwright": "^4.0.18",
+    "@vitest/coverage-v8": "^4.0.18",
+    "playwright": "^1.58.0",
+    "react": "^19.1.0",
+    "react-dom": "^19.1.0",
+    "storybook": "^10.2.0",
+    "typescript": "^5.7.3",
+    "vite": "^6.0.11",
+    "vite-plugin-css-injected-by-js": "^3.5.2",
+    "vitest": "^4.0.18"
+  }
+}