documint 0.0.2 → 0.0.4

package/README.md

@@ -40,7 +40,7 @@ This editor takes markdown in and gives markdown back out.
 export function App() {
   const [content, setContent] = useState(initialMarkdown);
 
-  return <Documint content={content} onContentChange={setContent} />;
+  return <Documint content={content} onContentChanged={setContent} />;
 }
 ```
 
@@ -60,6 +60,6 @@ const customTheme = {
 export function App() {
   const [content, setContent] = useState("# Themed Documint");
 
-  return <Documint content={content} onContentChange={setContent} theme={customTheme} />;
+  return <Documint content={content} onContentChanged={setContent} theme={customTheme} />;
 }
 ```

package/dist/index.d.ts

@@ -11,6 +11,7 @@ type Comment$1 = {
 type Document$1 = {
 	blocks: Block[];
 	comments: CommentThread[];
+	frontMatter?: string;
 };
 export type Block = ParagraphBlock | HeadingBlock | ListBlock | ListItemBlock | BlockquoteBlock | TableBlock | DividerBlock | CodeBlock | DirectiveBlock | RawBlock;
 export type Inline = Text$1 | Link | Image$1 | Code | LineBreak | Raw;
@@ -148,6 +149,8 @@ export type EditorTheme = {
 	leafText: string;
 	linkText: string;
 	listMarkerText: string;
+	mentionBackground?: string;
+	mentionText?: string;
 	paddingX: number;
 	paddingY: number;
 	paragraphText: string;
@@ -158,11 +161,29 @@ export type EditorTheme = {
 	tableBorder: string;
 	tableHeaderBackground: string;
 };
-export type Presence = {
-	color?: string;
+/**
+ * A user known to the host. The full set is the mention roster; the subset
+ * that also appears in `presence` shows a live cursor in the document.
+ */
+export type DocumentUser = {
+	id: string;
+	username: string;
+	fullName?: string;
+	avatarUrl?: string;
+};
+/**
+ * One user's live cursor in the document. `userId` foreign-keys into the
+ * `users` roster; entries without a matching user are silently dropped.
+ *
+ * `cursor` is a content-addressable anchor (prefix/suffix). The editor
+ * resolves it against the current document; if the anchor matches zero or
+ * more than one place, the cursor is treated as unresolved and rendered as
+ * an "unknown location" indicator rather than guessed.
+ */
+export type DocumentPresence = {
+	userId: string;
 	cursor?: Anchor;
-	imageUrl?: string;
-	name: string;
+	color?: string;
 };
 export type EditorKeybinding = {
 	altKey?: boolean;
@@ -177,9 +198,30 @@ export type DocumintProps = {
 	className?: string;
 	theme?: DocumintTheme;
 	keybindings?: EditorKeybinding[];
-	presence?: Presence[];
-	onContentChange?: (content: string, document: Document$1) => void;
-	onStateChange?: (state: DocumintState) => void;
+	presence?: DocumentPresence[];
+	users?: DocumentUser[];
+	onContentChanged?: (content: string, document: Document$1) => void;
+	onStateChanged?: (state: DocumintState) => void;
+	onCommentChanged?: (event: CommentChangedEvent) => void;
+};
+export type CommentChangedEvent = {
+	kind: "added";
+	comment: Comment$1;
+	mentionedUserIds: string[];
+	thread: CommentThread;
+	threadIndex: number;
+} | {
+	kind: "edited";
+	comment: Comment$1;
+	previousBody: string;
+	mentionedUserIds: string[];
+	thread: CommentThread;
+	threadIndex: number;
+} | {
+	kind: "deleted";
+	comment: Comment$1;
+	thread: CommentThread;
+	threadIndex: number;
 };
 export type DocumintTheme = EditorTheme | {
 	dark: EditorTheme;
@@ -197,7 +239,7 @@ export type DocumintState = {
 	selectionFrom: number;
 	selectionTo: number;
 };
-export declare function Documint({ className, content, keybindings, onContentChange, onStateChange, presence, theme, }: DocumintProps): import("react/jsx-runtime").JSX.Element;
+export declare function Documint({ className, content, keybindings, onCommentChanged, onContentChanged, onStateChanged, presence, theme, users, }: DocumintProps): import("react/jsx-runtime").JSX.Element;
 export declare const lightTheme: EditorTheme;
 export declare const darkTheme: EditorTheme;
 export declare const mintTheme: EditorTheme;