documint 0.0.1 → 0.0.3

package/dist/index.d.ts

@@ -105,17 +105,7 @@ export type Anchor = {
 	prefix?: string;
 	suffix?: string;
 };
-export type Presence = {
-	color?: string;
-	cursor?: Anchor;
-	imageUrl?: string;
-	name: string;
-};
-/**
- * Canvas render themes for the editor surface. These tokens are intentionally
- * semantic so paint code can stay focused on structure rather than color
- * decisions.
- */
+type EditorCommand = "dedent" | "deleteBackward" | "indent" | "insertLineBreak" | "moveListItemDown" | "moveListItemUp" | "moveToDocumentEnd" | "moveToDocumentStart" | "moveToLineEnd" | "moveToLineStart" | "redo" | "selectAll" | "toggleBold" | "toggleInlineCode" | "toggleItalic" | "toggleStrikethrough" | "toggleUnderline" | "undo";
 export type EditorTheme = {
 	activeBlockBackground: string;
 	activeBlockFlash: string;
@@ -158,6 +148,8 @@ export type EditorTheme = {
 	leafText: string;
 	linkText: string;
 	listMarkerText: string;
+	mentionBackground?: string;
+	mentionText?: string;
 	paddingX: number;
 	paddingY: number;
 	paragraphText: string;
@@ -168,7 +160,30 @@ export type EditorTheme = {
 	tableBorder: string;
 	tableHeaderBackground: string;
 };
-type EditorCommand = "dedent" | "deleteBackward" | "indent" | "insertLineBreak" | "moveListItemDown" | "moveListItemUp" | "moveToLineEnd" | "moveToLineStart" | "redo" | "toggleBold" | "toggleInlineCode" | "toggleItalic" | "toggleStrikethrough" | "toggleUnderline" | "undo";
+/**
+ * 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;
+	color?: string;
+};
 export type EditorKeybinding = {
 	altKey?: boolean;
 	command: EditorCommand;
@@ -177,6 +192,20 @@ export type EditorKeybinding = {
 	shiftKey?: boolean | "any";
 };
 export declare const defaultKeybindings: EditorKeybinding[];
+export type DocumintProps = {
+	content: string;
+	className?: string;
+	theme?: DocumintTheme;
+	keybindings?: EditorKeybinding[];
+	presence?: DocumentPresence[];
+	users?: DocumentUser[];
+	onContentChange?: (content: string, document: Document$1) => void;
+	onStateChange?: (state: DocumintState) => void;
+};
+export type DocumintTheme = EditorTheme | {
+	dark: EditorTheme;
+	light: EditorTheme;
+};
 export type DocumintState = {
 	activeBlockType: string | null;
 	activeCommentThreadIndex: number | null;
@@ -184,29 +213,12 @@ export type DocumintState = {
 	canonicalContent: string;
 	characterCount: number;
 	commentThreadCount: number;
-	docChangeCount: number;
-	lastTransactionMs: number;
 	layoutWidth: number;
-	lineCount: number;
 	resolvedCommentCount: number;
 	selectionFrom: number;
 	selectionTo: number;
-	transactionCount: number;
-};
-export type DocumintTheme = EditorTheme | {
-	dark: EditorTheme;
-	light: EditorTheme;
-};
-export type DocumintProps = {
-	className?: string;
-	content: string;
-	keybindings?: EditorKeybinding[];
-	onContentChange?: (content: string, document: Document$1) => void;
-	onStateChange?: (state: DocumintState) => void;
-	presence?: Presence[];
-	theme?: DocumintTheme;
 };
-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, onContentChange, onStateChange, 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;