documint 0.0.15 → 0.0.17

package/dist/index.d.ts

@@ -1,18 +1,41 @@
 import { LucideIcon } from 'lucide-react';
 
+declare const ANCHOR_KINDS: readonly [
+	"text",
+	"code",
+	"tableCell"
+];
+type AnchorKind = (typeof ANCHOR_KINDS)[number];
+type TextAnchor = {
+	kind?: AnchorKind;
+	prefix?: string;
+	suffix?: string;
+};
 export type CommentThread = {
+	id: string;
 	quote: string;
 	comments: Comment$1[];
-	anchor: Anchor;
+	anchor: TextAnchor;
 	resolvedAt?: string;
 };
 type Comment$1 = {
 	body: string;
 	updatedAt: string;
 };
+type CommentThreadAnchor = {
+	threadId: string;
+};
+export type Anchor = TextAnchor | CommentThreadAnchor;
 type Document$1 = {
 	blocks: Block[];
 	comments: CommentThread[];
+	/**
+	 * Markdown-only round-trip slot for the leading `---`-fenced front matter,
+	 * preserved verbatim. Treat as opaque metadata: the document engine never
+	 * reads it. Intentionally an unparsed string until there is a concrete
+	 * reason to model YAML/TOML structurally — once we do, this becomes a
+	 * `metadata: Record<string, unknown>` slot owned at the document layer.
+	 */
 	frontMatter?: string;
 };
 export type Block = ParagraphBlock | HeadingBlock | ListBlock | ListItemBlock | BlockquoteBlock | TableBlock | DividerBlock | CodeBlock | DirectiveBlock | RawBlock;
@@ -101,17 +124,6 @@ export type Raw = DocumentNode<"raw", {
 	originalType: string;
 	source: string;
 }>;
-declare const ANCHOR_KINDS: readonly [
-	"text",
-	"code",
-	"tableCell"
-];
-type AnchorKind = (typeof ANCHOR_KINDS)[number];
-export type Anchor = {
-	kind?: AnchorKind;
-	prefix?: string;
-	suffix?: string;
-};
 export type DocumintStorage = {
 	readFile(path: string): Promise<Blob | null>;
 	writeFile(file: File): Promise<string>;
@@ -160,11 +172,11 @@ export type EditorTheme = {
 	leafShadow?: string;
 	leafText: string;
 	linkText: string;
-	listMarkerText: string;
+	listMarkerText?: string;
 	mentionBackground?: string;
 	mentionText?: string;
-	paddingX: number;
-	paddingY: number;
+	paddingX?: number;
+	paddingY?: number;
 	paragraphText: string;
 	selectionBackground: string;
 	selectionHandleBackground: string;
@@ -184,13 +196,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;
@@ -207,6 +218,7 @@ export type EditorKeybinding = {
 export declare const defaultKeybindings: EditorKeybinding[];
 export type DocumintDecoration = {
 	backgroundColor?: string;
+	pulse?: boolean;
 	color?: string;
 	pattern: RegExp;
 };
@@ -237,19 +249,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;