documint 0.0.21 → 0.0.23

package/README.md

@@ -16,11 +16,11 @@ A canvas-based, batteries-included markdown editor for React.
 
 - **Context-aware toolbars ("leaves")** — Floating toolbars that appear based on what you're interacting with: text formatting options on selection, link editing on links, column/row controls on tables, and block insertion (headings, lists, quotes, tables) on empty lines.
 
-- **Configurable themes and keybindings** — Ships with built-in light and dark themes, follows the system theme by default, and lets you customize every theme value or start from presets like mint, midnight, and sunrise. Keybindings are configurable too — remap formatting shortcuts, navigation, and list operations to match your users' expectations.
+- **Configurable themes and keybindings** — Ships with built-in light and dark themes, follows the system theme by default, and lets you customize every theme value. Keybindings are configurable too — remap formatting shortcuts, navigation, and list operations to match your users' expectations.
 
 - **Comments and presence for review workflows** — Anchor comments to any range of text, with full threading (replies, resolution, deletion) and self-repairing quote-based matching after edits. External user and AI agent presence can be projected into the document as live cursors and viewport indicators without becoming document content.
 
-- **Fast and lightweight** — Canvas-based rendering optimized for hot-path performance even on large documents. A custom markdown parser, editor engine, and layout/rendering system all ship in a bundle <80 KB gzipped.
+- **Fast and lightweight** — Canvas-based rendering optimized for hot-path performance even on large documents. A custom markdown parser, editor engine, and layout/rendering system all ship in a bundle ~100 KB gzipped.
 
 ## Getting Started
 

package/dist/index.d.ts

@@ -39,7 +39,7 @@ type Document$1 = {
 	frontMatter?: string;
 };
 export type Block = ParagraphBlock | HeadingBlock | ListBlock | ListItemBlock | BlockquoteBlock | TableBlock | DividerBlock | CodeBlock | DirectiveBlock | RawBlock;
-export type Inline = Text$1 | Link | Image$1 | Mention | Code | LineBreak | Raw;
+export type Inline = Text$1 | Link | Image$1 | Mention | Resource | LineBreak | Raw;
 type DocumentNode<K extends string, P = {}> = {
 	id: string;
 	type: K;
@@ -96,7 +96,7 @@ export type RawBlock = BlockNode<"raw", {
 	originalType: string;
 	source: string;
 }>;
-export type Mark = "bold" | "italic" | "strikethrough" | "underline" | "superscript";
+export type Mark = "code" | "bold" | "italic" | "strikethrough" | "underline" | "superscript";
 type Text$1 = DocumentNode<"text", {
 	marks: Mark[];
 	text: string;
@@ -116,14 +116,34 @@ type Mention = DocumentNode<"mention", {
 	name: string;
 	userId: string;
 }>;
-type LineBreak = DocumentNode<"lineBreak">;
-type Code = DocumentNode<"code", {
-	code: string;
+export type Resource = DocumentNode<"resource", {
+	label: string;
+	protocol: string;
+	url: string;
 }>;
+type LineBreak = DocumentNode<"lineBreak">;
 export type Raw = DocumentNode<"raw", {
 	originalType: string;
 	source: string;
 }>;
+export type DocumentResourceProtocol = {
+	icon?: DocumentResourceIcon;
+	label: string;
+};
+export type DocumentResourceIcon = string | DocumentResourceVectorIcon;
+export type DocumentResourceVectorIcon = {
+	node: DocumentResourceIconNode;
+	type: "svg";
+};
+export type DocumentResourceIconNode = readonly DocumentResourceIconNodeElement[];
+type DocumentResourceIconNodeElement = readonly [
+	elementName: string,
+	attrs: Readonly<Record<string, string>>
+];
+export type DocumentResourceReference = {
+	protocol: string;
+	url: string;
+};
 export type DocumintStorage = {
 	readFile(path: string): Promise<Blob | null>;
 	writeFile(file: File): Promise<string>;
@@ -161,7 +181,7 @@ export type EditorTheme = {
 	inlineCodeText?: string;
 	insertHighlightText?: string;
 	leafAccent: string;
-	leafBackground: string;
+	leafBackground?: string;
 	leafBorder: string;
 	leafInputBackground: string;
 	leafButtonText?: string;
@@ -207,7 +227,10 @@ export type DocumentPresence = {
 	userId: string;
 	cursor?: Anchor;
 	color?: string;
+	status?: string;
 };
+export type ResourceProtocolRecord = ReadonlyMap<string, DocumentResourceProtocol> | Record<string, DocumentResourceProtocol>;
+export type ActiveResourceSet = ReadonlySet<string> | readonly string[] | Record<string, boolean>;
 export type EditorInputKeybinding = {
 	altKey?: boolean;
 	command: EditorInputCommand;
@@ -216,24 +239,44 @@ export type EditorInputKeybinding = {
 	shiftKey?: boolean | "any";
 };
 export declare const defaultKeybindings: EditorInputKeybinding[];
+export type DocumintPatch = {
+	revision: string | null;
+	changes: DocumintPatchChange[];
+};
+export type DocumintPatchChange = {
+	startLine: number;
+	endLine: number;
+	text: string;
+};
+export declare function applyDocumintPatch(content: string, patch: DocumintPatch): string;
 export type DocumintDecoration = {
 	backgroundColor?: string;
 	pulse?: boolean;
 	color?: string;
 	pattern: RegExp;
 };
+export type UserMentionEvent = {
+	lineMarkdown: string;
+	lineNumber: number;
+	userId: string;
+};
 export type DocumintProps = {
 	content: string;
 	className?: string;
+	revision?: string | null;
 	actions?: DocumintActions;
 	theme?: DocumintTheme;
 	keybindings?: EditorInputKeybinding[];
 	decorations?: readonly DocumintDecoration[];
 	presence?: DocumentPresence[];
+	protocols?: ResourceProtocolRecord;
+	resources?: ActiveResourceSet;
 	storage?: DocumintStorage;
 	users?: DocumentUser[];
-	onContentChanged?: (content: string, document: Document$1) => void;
+	onContentChanged?: (content: string, document: Document$1, patch: DocumintPatch | null) => void;
 	onCommentChanged?: (change: CommentChange) => void;
+	onResourceOpened?: (resource: DocumentResourceReference) => void;
+	onResourcesRequested?: (resources: readonly DocumentResourceReference[]) => void;
 	onUserMentioned?: (event: UserMentionEvent) => void;
 };
 export type DocumintAction<T> = {
@@ -263,11 +306,6 @@ export type CommentChange = {
 	thread: CommentThread;
 	threadId: string;
 };
-export type UserMentionEvent = {
-	lineMarkdown: string;
-	lineNumber: number;
-	userId: string;
-};
 export type DocumintTheme = EditorTheme | {
 	dark: EditorTheme;
 	light: EditorTheme;
@@ -275,8 +313,9 @@ export type DocumintTheme = EditorTheme | {
 export declare function Documint({ content, ...props }: DocumintProps): import("react/jsx-runtime").JSX.Element;
 export declare const lightTheme: EditorTheme;
 export declare const darkTheme: EditorTheme;
-export declare const mintTheme: EditorTheme;
-export declare const midnightTheme: EditorTheme;
+export declare function lucideResourceIcon(node: DocumentResourceIconNode): DocumentResourceIcon;
+export declare function normalizeResourceProtocol(protocol: string): string | null;
+export declare function resolveResourceProtocol(url: string): string | null;
 
 export {
 	Comment$1 as Comment,