tiptop-editor 2.0.0 → 2.2.0

package/dist/types.d.ts

@@ -18,6 +18,12 @@ export type TiptopEditorOptions = Omit<Partial<UseEditorOptions & {
    */
     imgUploadResponseKey?: ImageUploadResponseResolver;
     /**
+   * Custom HTTP headers to include in the image upload request.
+   * Useful for passing authorization tokens or other API headers.
+   * @default undefined
+   */
+    imgUploadHeaders?: Record<string, string>;
+    /**
    * Disables the default Card wrapper and removes the editor's built-in padding.
    * Use this when you want to embed the editor inside your own layout container.
    * @default false
@@ -29,6 +35,15 @@ export type TiptopEditorOptions = Omit<Partial<UseEditorOptions & {
    */
     showDragHandle?: boolean;
     /**
+   * Enables the comment system. When `true`:
+   * - The `CommentMark` and `NodeCommentExtension` extensions are added automatically.
+   * - A `CommentSelectionMenu` bubble menu is rendered that appears on text selection
+   *   when the editor is in view mode (`editable: false`).
+   * - Wrap the editor with `CommentsProvider` and add your own comment drawer using `useComments()` and `useCommentActions()`.
+   * @default false
+   */
+    showCommentMenu?: boolean;
+    /**
    * Additional Tiptap extensions to append after the built-in editor set.
    * Use this to add feature-specific extensions like AI commands or collaboration.
    * @default undefined
@@ -196,6 +211,44 @@ export interface KeyDownRef {
         event: KeyboardEvent;
     }) => boolean;
 }
+export interface TiptopCommentReply {
+    id: string;
+    content: string;
+    author?: string;
+    createdAt: Date;
+}
+export interface TiptopComment {
+    id: string;
+    /** 'inline' — applied to a text range via a mark. 'node' — applied to a whole block node. */
+    type: 'inline' | 'node';
+    content: string;
+    author?: string;
+    createdAt: Date;
+    replies: TiptopCommentReply[];
+    resolved: boolean;
+}
+export type PendingComment = {
+    id: string;
+    type: 'inline';
+    from: number;
+    to: number;
+} | {
+    id: string;
+    type: 'node';
+    nodePos: number;
+};
+export interface CommentsContextValue {
+    comments: TiptopComment[];
+    activeCommentId: string | null;
+    pendingComment: PendingComment | null;
+    addComment: (id: string, type: 'inline' | 'node', content: string, author?: string) => void;
+    removeComment: (id: string) => void;
+    resolveComment: (id: string) => void;
+    replyToComment: (commentId: string, content: string, author?: string) => void;
+    setActiveCommentId: (id: string | null) => void;
+    setPendingComment: (comment: PendingComment | null) => void;
+    getComment: (id: string) => TiptopComment | undefined;
+}
 export interface ImageUploaderExtensionOptions {
     /**
      * The url of the server where the file should be uploaded.
@@ -213,6 +266,7 @@ export interface ImageUploaderExtensionOptions {
     imgUploadResponseKey?: ImageUploadResponseResolver;
     allowedMimeTypes?: string[];
     maxFileSize: number;
+    imgUploadHeaders?: Record<string, string>;
 }
 export interface ImageUploaderExtensionStorage {
     uploadImageFromFile: (editor: Editor, file: File, id: string, updateExisting?: boolean, pos?: number) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tiptop-editor",
-  "version": "2.0.0",
+  "version": "2.2.0",
   "description": "Notion-like editor built with Tiptap v3 and HeroUI",
   "type": "module",
   "main": "./dist/tiptop-editor.umd.js",