nostr-comments 0.6.0 → 0.7.0

package/README.md

@@ -25,7 +25,6 @@ npm install nostr-comments
 
 ```tsx
 import { NostrComments } from "nostr-comments";
-import "nostr-comments/style.css";
 
 function App() {
   return <NostrComments url="https://example.com/blog/my-post" locale="en" />;
@@ -36,21 +35,22 @@ function App() {
 
 ### NostrComments Component Props
 
-| Prop                 | Type                                | Default            | Description                                          |
-| -------------------- | ----------------------------------- | ------------------ | ---------------------------------------------------- |
-| `url`                | `string`                            | **Required**       | Web page URL, used to identify comment scope         |
+| Prop                 | Type                                | Default            | Description                                                |
+| -------------------- | ----------------------------------- | ------------------ | ---------------------------------------------------------- |
+| `url`                | `string`                            | **Required**       | Web page URL, used to identify comment scope               |
 | `mention`            | `string`                            | -                  | Public key to mention in comments (receives notifications) |
-| `relays`             | `string[]`                          | Default relay list | List of Nostr relay addresses                        |
-| `pageSize`           | `number`                            | `50`               | Number of comments per page                          |
-| `locale`             | `string`                            | Auto-detect        | Interface language (20 languages supported)          |
-| `translations`       | `Partial<Translations>`             | -                  | Custom translation text                              |
-| `theme`              | `'light' \| 'dark' \| 'auto'`       | `'auto'`           | Theme mode                                           |
-| `headless`           | `boolean`                           | `false`            | Enable Headless mode                                 |
-| `classNames`         | `object`                            | -                  | Custom CSS class names                               |
-| `enabledSigners`     | `('nip07' \| 'bunker' \| 'temp')[]` | All enabled        | Enabled login methods                                |
-| `pow`                | `number`                            | `18`               | POW difficulty (leading zero bits) to prevent spam   |
-| `onCommentPublished` | `(event: NostrEvent) => void`       | -                  | Callback when comment is published                   |
-| `onError`            | `(error: Error) => void`            | -                  | Error callback                                       |
+| `relays`             | `string[]`                          | Default relay list | List of Nostr relay addresses                              |
+| `pageSize`           | `number`                            | `50`               | Number of comments per page                                |
+| `locale`             | `string`                            | Auto-detect        | Interface language (20 languages supported)                |
+| `translations`       | `Partial<Translations>`             | -                  | Custom translation text                                    |
+| `theme`              | `'light' \| 'dark' \| 'auto'`       | `'auto'`           | Theme mode                                                 |
+| `headless`           | `boolean`                           | `false`            | Enable Headless mode                                       |
+| `classNames`         | `object`                            | -                  | Custom CSS class names                                     |
+| `signer`             | `Signer`                            | -                  | External signer instance (skips login modal when provided) |
+| `enabledSigners`     | `('nip07' \| 'bunker' \| 'temp')[]` | All enabled        | Enabled login methods                                      |
+| `pow`                | `number`                            | `18`               | POW difficulty (leading zero bits) to prevent spam         |
+| `onCommentPublished` | `(event: NostrEvent) => void`       | -                  | Callback when comment is published                         |
+| `onError`            | `(error: Error) => void`            | -                  | Error callback                                             |
 
 ### classNames Object
 
@@ -100,10 +100,10 @@ function App() {
 ### Anti-Spam with POW
 
 ```tsx
-<NostrComments url="https://example.com/post/123" pow={16} />
+<NostrComments url="https://example.com/post/123" pow={18} />
 ```
 
-Requires commenters to compute a proof-of-work (NIP-13) before publishing. Higher values = more computation time = stronger spam prevention. Recommended: 8-16 bits.
+Requires commenters to compute a proof-of-work (NIP-13) before publishing. Higher values = more computation time = stronger spam prevention. Recommended: 10-20 bits.
 
 ### Extension Login Only
 
@@ -111,6 +111,28 @@ Requires commenters to compute a proof-of-work (NIP-13) before publishing. Highe
 <NostrComments url="https://example.com/post/123" enabledSigners={["nip07"]} />
 ```
 
+### External Signer
+
+Pass your own signer instance to skip the built-in login modal:
+
+```tsx
+import { NostrComments, Nip07Signer, TempSigner } from "nostr-comments";
+
+// Use NIP-07 extension
+const signer = new Nip07Signer();
+
+// Or use a temporary signer
+const signer = new TempSigner();
+
+// Or any object that implements the Signer interface
+const customSigner = {
+  getPublicKey: async () => "your-pubkey",
+  signEvent: async (event) => signedEvent,
+};
+
+<NostrComments url="https://example.com/post/123" signer={signer} />;
+```
+
 ### Headless Mode
 
 ```tsx
@@ -169,8 +191,10 @@ For dark mode, override the base colors under `[data-theme="dark"]` or `[data-th
 
   /* Border Radius */
   --nc-radius-sm: 8px;
+  /* button, textarea radius */
   --nc-radius-md: 12px;
   --nc-radius-lg: 16px;
+  /* modal radius */
   --nc-radius-xl: 24px;
 
   /* Avatar Border Radius */

package/dist/hooks/index.d.ts

@@ -1,4 +1,4 @@
-export { useSigner, isLoggedIn } from "./useSigner";
+export { useSigner, isLoggedIn, setExternalSigner } from "./useSigner";
 export { useComments } from "./useComments";
 export type { UseCommentsOptions } from "./useComments";
 export { useProfile } from "./useProfile";

package/dist/hooks/useSigner.d.ts

@@ -1,6 +1,7 @@
 import { TempSigner } from "../signers";
 import type { Signer, SignerInfo } from "../signers/types";
 export declare function isLoggedIn(): boolean;
+export declare function setExternalSigner(signer: Signer): Promise<boolean>;
 export declare function useSigner(): {
     signer: Signer | null;
     signerInfo: SignerInfo | null;

package/dist/index.d.ts

@@ -2,7 +2,7 @@ export { NostrComments } from "./NostrComments";
 export type { NostrCommentsProps, Comment, Profile, Translations, } from "./types";
 export { Nip07Signer, TempSigner, BunkerSigner } from "./signers";
 export type { Signer, SignerType, SignerInfo } from "./signers";
-export { useSigner, useComments, useProfile, isLoggedIn } from "./hooks";
+export { useSigner, useComments, useProfile, isLoggedIn, setExternalSigner } from "./hooks";
 export type { UseCommentsOptions } from "./hooks";
 export { Avatar, Username, CommentItem, CommentList, CommentEditor, LoginModal, } from "./components";
 export { getDefaultRelays, queryEvents, subscribeEvents, publishEvent, } from "./services/nostr";