documint 0.0.13 → 0.0.16

package/README.md

@@ -125,3 +125,22 @@ export function App() {
   return <Documint content={content} onContentChanged={setContent} storage={storage} />;
 }
 ```
+
+## Text Decorations
+
+Use the `decorations` prop to style text that matches host-provided regular expressions. Decorations are worker-derived presentation ranges, update asynchronously as content changes, and are not serialized back to markdown. Link text keeps the theme link color when it overlaps a text-color decoration.
+
+```tsx
+import { useState } from "react";
+import { Documint, type DocumintDecoration } from "documint";
+
+const decorations: readonly DocumintDecoration[] = [
+  { pattern: /\blist\b/gi, color: "red", backgroundColor: "rgba(255, 0, 0, 0.12)" },
+];
+
+export function App() {
+  const [content, setContent] = useState("A list of things");
+
+  return <Documint content={content} onContentChanged={setContent} decorations={decorations} />;
+}
+```

package/dist/index.d.ts

@@ -1,9 +1,10 @@
 import { LucideIcon } from 'lucide-react';
 
 export type CommentThread = {
+	id: string;
 	quote: string;
 	comments: Comment$1[];
-	anchor: Anchor;
+	anchor: TextAnchor;
 	resolvedAt?: string;
 };
 type Comment$1 = {
@@ -107,11 +108,15 @@ declare const ANCHOR_KINDS: readonly [
 	"tableCell"
 ];
 type AnchorKind = (typeof ANCHOR_KINDS)[number];
-export type Anchor = {
+type TextAnchor = {
 	kind?: AnchorKind;
 	prefix?: string;
 	suffix?: string;
 };
+type CommentThreadAnchor = {
+	threadId: string;
+};
+export type Anchor = TextAnchor | CommentThreadAnchor;
 export type DocumintStorage = {
 	readFile(path: string): Promise<Blob | null>;
 	writeFile(file: File): Promise<string>;
@@ -160,7 +165,7 @@ export type EditorTheme = {
 	leafShadow?: string;
 	leafText: string;
 	linkText: string;
-	listMarkerText: string;
+	listMarkerText?: string;
 	mentionBackground?: string;
 	mentionText?: string;
 	paddingX: number;
@@ -184,13 +189,12 @@ export type DocumentUser = {
 	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.
+ * One user's live document presence. `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.
+ * `cursor` is either a content-addressable text anchor (prefix/suffix) or a
+ * comment-thread anchor (`{ threadId }`). The editor resolves comment-thread
+ * anchors to a presence-active comment rule instead of a remote caret.
  */
 export type DocumentPresence = {
 	userId: string;
@@ -205,12 +209,19 @@ export type EditorKeybinding = {
 	shiftKey?: boolean | "any";
 };
 export declare const defaultKeybindings: EditorKeybinding[];
+export type DocumintDecoration = {
+	backgroundColor?: string;
+	pulse?: boolean;
+	color?: string;
+	pattern: RegExp;
+};
 export type DocumintProps = {
 	content: string;
 	className?: string;
 	actions?: DocumintActions;
 	theme?: DocumintTheme;
 	keybindings?: EditorKeybinding[];
+	decorations?: readonly DocumintDecoration[];
 	presence?: DocumentPresence[];
 	storage?: DocumintStorage;
 	users?: DocumentUser[];
@@ -231,19 +242,19 @@ export type CommentChange = {
 	comment: Comment$1;
 	mentionedUserIds: string[];
 	thread: CommentThread;
-	threadIndex: number;
+	threadId: string;
 } | {
 	kind: "edited";
 	comment: Comment$1;
 	previousBody: string;
 	mentionedUserIds: string[];
 	thread: CommentThread;
-	threadIndex: number;
+	threadId: string;
 } | {
 	kind: "deleted";
 	comment: Comment$1;
 	thread: CommentThread;
-	threadIndex: number;
+	threadId: string;
 };
 export type UserMentionEvent = {
 	lineMarkdown: string;