@fresh-editor/fresh-editor 0.3.0 → 0.3.1

package/plugins/kotlin-lsp.ts

@@ -50,7 +50,10 @@ let kotlinLspError: { serverCommand: string; message: string } | null = null;
 /**
  * Handle LSP server errors for Kotlin
  */
-function on_kotlin_lsp_server_error(data: LspServerErrorData): void {
+
+
+// Register hook for LSP server errors
+editor.on("lsp_server_error", (data) => {
   // Only handle Kotlin language errors
   if (data.language !== "kotlin") {
     return;
@@ -72,18 +75,15 @@ function on_kotlin_lsp_server_error(data: LspServerErrorData): void {
   } else {
     editor.setStatus(`Kotlin LSP error: ${data.message}`);
   }
-}
-registerHandler("on_kotlin_lsp_server_error", on_kotlin_lsp_server_error);
-
-// Register hook for LSP server errors
-editor.on("lsp_server_error", "on_kotlin_lsp_server_error");
+});
 
 /**
  * Handle status bar click when there's a Kotlin LSP error
  */
-function on_kotlin_lsp_status_clicked(
-  data: LspStatusClickedData
-): void {
+
+
+// Register hook for status bar clicks
+editor.on("lsp_status_clicked", (data) => {
   // Only handle Kotlin language clicks when there's an error
   if (data.language !== "kotlin" || !kotlinLspError) {
     return;
@@ -104,18 +104,15 @@ function on_kotlin_lsp_status_clicked(
       { id: "dismiss", label: "Dismiss (ESC)" },
     ],
   });
-}
-registerHandler("on_kotlin_lsp_status_clicked", on_kotlin_lsp_status_clicked);
-
-// Register hook for status bar clicks
-editor.on("lsp_status_clicked", "on_kotlin_lsp_status_clicked");
+});
 
 /**
  * Handle action popup results for Kotlin LSP help
  */
-function on_kotlin_lsp_action_result(
-  data: ActionPopupResultData
-): void {
+
+
+// Register hook for action popup results
+editor.on("action_popup_result", (data) => {
   // Only handle our popup
   if (data.popup_id !== "kotlin-lsp-help") {
     return;
@@ -153,10 +150,6 @@ function on_kotlin_lsp_action_result(
     default:
       editor.debug(`kotlin-lsp: Unknown action: ${data.action_id}`);
   }
-}
-registerHandler("on_kotlin_lsp_action_result", on_kotlin_lsp_action_result);
-
-// Register hook for action popup results
-editor.on("action_popup_result", "on_kotlin_lsp_action_result");
+});
 
 editor.debug("kotlin-lsp: Plugin loaded");

package/plugins/latex-lsp.ts

@@ -22,7 +22,8 @@ interface ActionPopupResultData {
 const INSTALL_URL = "https://github.com/latex-lsp/texlab#installation";
 let latexLspError: { serverCommand: string; message: string } | null = null;
 
-function on_latex_lsp_server_error(data: LspServerErrorData) : void {
+
+editor.on("lsp_server_error", (data) => {
   if (data.language !== "latex") return;
   latexLspError = { serverCommand: data.server_command, message: data.message };
   if (data.error_type === "not_found") {
@@ -30,11 +31,10 @@ function on_latex_lsp_server_error(data: LspServerErrorData) : void {
   } else {
     editor.setStatus(`LaTeX LSP error: ${data.message}`);
   }
-}
-registerHandler("on_latex_lsp_server_error", on_latex_lsp_server_error);
-editor.on("lsp_server_error", "on_latex_lsp_server_error");
+});
+
 
-function on_latex_lsp_status_clicked(data: LspStatusClickedData) : void {
+editor.on("lsp_status_clicked", (data) => {
   if (data.language !== "latex" || !latexLspError) return;
   editor.showActionPopup({
     id: "latex-lsp-help",
@@ -46,11 +46,10 @@ function on_latex_lsp_status_clicked(data: LspStatusClickedData) : void {
       { id: "dismiss", label: "Dismiss (ESC)" },
     ],
   });
-}
-registerHandler("on_latex_lsp_status_clicked", on_latex_lsp_status_clicked);
-editor.on("lsp_status_clicked", "on_latex_lsp_status_clicked");
+});
+
 
-function on_latex_lsp_action_result(data: ActionPopupResultData) : void {
+editor.on("action_popup_result", (data) => {
   if (data.popup_id !== "latex-lsp-help") return;
   switch (data.action_id) {
     case "copy_url":
@@ -63,6 +62,4 @@ function on_latex_lsp_action_result(data: ActionPopupResultData) : void {
       latexLspError = null;
       break;
   }
-}
-registerHandler("on_latex_lsp_action_result", on_latex_lsp_action_result);
-editor.on("action_popup_result", "on_latex_lsp_action_result");
+});

package/plugins/lib/fresh.d.ts

@@ -240,6 +240,44 @@ type ViewportInfo = {
 	*/
 	height: number;
 };
+type KeyEventPayload = {
+	/**
+	* Key name (e.g. `"a"`, `"escape"`, `"f1"`).
+	*/
+	key: string;
+	/**
+	* Ctrl held.
+	*/
+	ctrl: boolean;
+	/**
+	* Alt held.
+	*/
+	alt: boolean;
+	/**
+	* Shift held (only meaningful for non-character keys; for
+	* printable characters the case is already encoded in `key`).
+	*/
+	shift: boolean;
+	/**
+	* Super / Cmd / Meta held.
+	*/
+	meta: boolean;
+};
+type SplitSnapshot = {
+	/**
+	* Stable split identifier; matches the values used by
+	* `setSplitBuffer`, `focusSplit`, `getSplitByLabel`, etc.
+	*/
+	splitId: number;
+	/**
+	* Buffer currently shown in this split.
+	*/
+	bufferId: BufferId;
+	/**
+	* Viewport (top byte / dimensions) for this split's active buffer.
+	*/
+	viewport: ViewportInfo;
+};
 type LayoutHints = {
 	/**
 	* Optional compose width for centering/wrapping
@@ -631,6 +669,19 @@ type GrammarInfoSnapshot = {
 	*/
 	short_name: string | null;
 };
+type AnimationRect = {
+	x: number;
+	y: number;
+	width: number;
+	height: number;
+};
+type PluginAnimationEdge = "top" | "bottom" | "left" | "right";
+type PluginAnimationKind = {
+	"kind": "slideIn";
+	from: PluginAnimationEdge;
+	durationMs: number;
+	delayMs: number;
+};
 type AuthorityFilesystem = {
 	kind: "local";
 };
@@ -641,6 +692,7 @@ type AuthoritySpawner = {
 	container_id: string;
 	user?: string | null;
 	workspace?: string | null;
+	env?: [string, string][];
 };
 type AuthorityTerminalWrapper = {
 	kind: "host-shell";
@@ -655,6 +707,17 @@ type AuthorityPayload = {
 	spawner: AuthoritySpawner;
 	terminal_wrapper: AuthorityTerminalWrapper;
 	display_label?: string;
+	/**
+	* Optional host↔remote workspace path mapping. The dev-container
+	* authority sets both roots (editor.getCwd() on host;
+	* remoteWorkspaceFolder on container) so LSP URIs translate at the
+	* host/container boundary. Local and SSH authorities omit it.
+	*/
+	path_translation?: PathTranslationSpec;
+};
+type PathTranslationSpec = {
+	host_root: string;
+	remote_root: string;
 };
 type BackgroundProcessResult = {
 	/**
@@ -1068,6 +1131,15 @@ interface EditorAPI {
 	*/
 	getViewport(): ViewportInfo | null;
 	/**
+	* List every split with its active buffer and viewport.
+	* 
+	* Plugins that need to operate on every visible buffer
+	* simultaneously (multi-split flash labels, syncing decorations
+	* across panes, …) iterate this list rather than only seeing
+	* `getViewport()`'s active-split data.  Order is unspecified.
+	*/
+	listSplits(): SplitSnapshot[];
+	/**
 	* Get the line number (0-indexed) of the primary cursor
 	*/
 	getCursorLine(): number;
@@ -1140,6 +1212,21 @@ interface EditorAPI {
 	*/
 	closeBuffer(bufferId: number): boolean;
 	/**
+	* Start a frame-buffer animation over an arbitrary screen region.
+	* Returns an animation id usable with `cancelAnimation`.
+	*/
+	animateArea(rect: AnimationRect, kind: PluginAnimationKind): number;
+	/**
+	* Start an animation over the on-screen Rect currently occupied by a
+	* virtual buffer. No-op if the buffer is not visible.
+	*/
+	animateVirtualBuffer(bufferId: number, kind: PluginAnimationKind): number;
+	/**
+	* Cancel an animation previously started via `animateArea` or
+	* `animateVirtualBuffer`. No-op if the ID is unknown or already done.
+	*/
+	cancelAnimation(id: number): boolean;
+	/**
 	* Subscribe to an editor event
 	*/
 	on(eventName: string, handlerName: string): void;
@@ -1546,6 +1633,14 @@ interface EditorAPI {
 	*/
 	removeVirtualText(bufferId: number, virtualTextId: string): boolean;
 	/**
+	* Add styled virtual text — richer form of `addVirtualText` whose
+	* `options` accepts an `addOverlay`-style record: `fg`/`bg` may
+	* be RGB arrays or theme-key strings, plus `bold`/`italic`. Theme
+	* keys are resolved at render time so the label follows theme
+	* changes live.
+	*/
+	addVirtualTextStyled(bufferId: number, virtualTextId: string, position: number, text: string, options: Record<string, unknown>, before: boolean): boolean;
+	/**
 	* Remove virtual texts whose ID starts with the given prefix
 	*/
 	removeVirtualTextsByPrefix(bufferId: number, prefix: string): boolean;
@@ -1577,6 +1672,38 @@ interface EditorAPI {
 	*/
 	startPrompt(label: string, promptType: string): boolean;
 	/**
+	* Begin a key-capture window for the calling plugin.
+	* 
+	* Pair with `endKeyCapture()` around any `getNextKey()` loop.
+	* While capture is active, keys arriving between two
+	* `getNextKey()` calls are buffered in-order rather than
+	* falling through to the buffer / mode bindings, so fast typing,
+	* pastes, or held-key auto-repeat are delivered losslessly.
+	* Without this, a plugin's input loop has a race where keys
+	* typed while the plugin is mid-redraw can leak into the editor.
+	*/
+	beginKeyCapture(): boolean;
+	/**
+	* End the key-capture window and discard any unconsumed buffered
+	* keys.  Call from a `finally` block so capture is released even
+	* if the plugin's loop throws.
+	*/
+	endKeyCapture(): boolean;
+	/**
+	* Wait for the next keypress and resolve with a `KeyEventPayload`.
+	* 
+	* While the returned promise is pending the editor consumes the
+	* next key and resolves it; the key does not propagate to mode
+	* bindings or other dispatch. Multiple in-flight requests across
+	* plugins are FIFO. Designed for short input loops (flash labels,
+	* vi find-char, replace-char) that would otherwise need to bind
+	* every printable key in `defineMode`.
+	* 
+	* For lossless capture against fast typing or paste, wrap the
+	* loop with `beginKeyCapture()` / `endKeyCapture()`.
+	*/
+	getNextKey(): Promise<KeyEventPayload>;
+	/**
 	* Start a prompt with initial value
 	*/
 	startPromptWithInitial(label: string, promptType: string, initialValue: string): boolean;
@@ -1925,3 +2052,254 @@ interface EditorAPI {
 interface EditorAPI {
 	getPluginApi<K extends keyof FreshPluginRegistry>(name: K): FreshPluginRegistry[K] | null;
 }
+/**
+* Maps every hook event name to its payload type.
+*
+* Payloads match the flat JSON produced by `hook_args_to_json` on the Rust
+* side (`HookArgs` is `#[serde(untagged)]`, so each variant serializes as its
+* fields only). The TypeScript types here are derived directly from the Rust
+* field definitions and must be kept in sync with `fresh-core/src/hooks.rs`.
+*
+* `action` in `pre_command`/`post_command` is the serde JSON of the `Action`
+* enum: unit variants serialize as a plain string (e.g. `"MoveLeft"`),
+* tuple variants as a single-key object (e.g. `{"InsertChar": "a"}`).
+*/
+interface HookEventMap {
+	// ── lifecycle ────────────────────────────────────────────────────────────
+	editor_initialized: Record<string, never>;
+	plugins_loaded: Record<string, never>;
+	ready: Record<string, never>;
+	focus_gained: Record<string, never>;
+	authority_changed: {
+		label: string;
+	};
+	// ── buffer lifecycle ─────────────────────────────────────────────────────
+	buffer_activated: {
+		buffer_id: number;
+	};
+	buffer_deactivated: {
+		buffer_id: number;
+	};
+	buffer_closed: {
+		buffer_id: number;
+	};
+	// ── file I/O ─────────────────────────────────────────────────────────────
+	before_file_open: {
+		path: string;
+	};
+	after_file_open: {
+		path: string;
+		buffer_id: number;
+	};
+	before_file_save: {
+		path: string;
+		buffer_id: number;
+	};
+	after_file_save: {
+		path: string;
+		buffer_id: number;
+	};
+	// ── text edits ───────────────────────────────────────────────────────────
+	before_insert: {
+		buffer_id: number;
+		position: number;
+		text: string;
+	};
+	after_insert: {
+		buffer_id: number;
+		position: number;
+		text: string;
+		affected_start: number;
+		affected_end: number;
+		start_line: number;
+		end_line: number;
+		lines_added: number;
+	};
+	before_delete: {
+		buffer_id: number;
+		start: number;
+		end: number;
+	};
+	after_delete: {
+		buffer_id: number;
+		start: number;
+		end: number;
+		deleted_text: string;
+		affected_start: number;
+		deleted_len: number;
+		start_line: number;
+		end_line: number;
+		lines_removed: number;
+	};
+	// ── cursor & viewport ────────────────────────────────────────────────────
+	cursor_moved: {
+		buffer_id: number;
+		cursor_id: number;
+		old_position: number;
+		new_position: number;
+		line: number;
+		text_properties: Record<string, unknown>[];
+	};
+	viewport_changed: {
+		split_id: number;
+		buffer_id: number;
+		top_byte: number;
+		top_line: number | null;
+		width: number;
+		height: number;
+	};
+	// ── rendering ────────────────────────────────────────────────────────────
+	render_start: {
+		buffer_id: number;
+	};
+	render_line: {
+		buffer_id: number;
+		line_number: number;
+		byte_start: number;
+		byte_end: number;
+		content: string;
+	};
+	lines_changed: {
+		buffer_id: number;
+		lines: {
+			line_number: number;
+			byte_start: number;
+			byte_end: number;
+			content: string;
+		}[];
+	};
+	view_transform_request: {
+		buffer_id: number;
+		split_id: number;
+		viewport_start: number;
+		viewport_end: number;
+		tokens: ViewTokenWire[];
+		cursor_positions: number[];
+	};
+	// ── commands ─────────────────────────────────────────────────────────────
+	pre_command: {
+		action: string | Record<string, unknown>;
+	};
+	post_command: {
+		action: string | Record<string, unknown>;
+	};
+	idle: {
+		milliseconds: number;
+	};
+	resize: {
+		width: number;
+		height: number;
+	};
+	// ── prompts ──────────────────────────────────────────────────────────────
+	prompt_changed: {
+		prompt_type: string;
+		input: string;
+	};
+	prompt_confirmed: {
+		prompt_type: string;
+		input: string;
+		selected_index: number | null;
+	};
+	prompt_cancelled: {
+		prompt_type: string;
+		input: string;
+	};
+	prompt_selection_changed: {
+		prompt_type: string;
+		selected_index: number;
+	};
+	// ── mouse ────────────────────────────────────────────────────────────────
+	mouse_click: MouseClickHookArgs;
+	mouse_move: {
+		column: number;
+		row: number;
+		content_x: number;
+		content_y: number;
+	};
+	mouse_scroll: {
+		buffer_id: number;
+		delta: number;
+		col: number;
+		row: number;
+	};
+	// ── LSP ──────────────────────────────────────────────────────────────────
+	diagnostics_updated: {
+		uri: string;
+		count: number;
+	};
+	lsp_references: {
+		symbol: string;
+		locations: {
+			file: string;
+			line: number;
+			column: number;
+		}[];
+	};
+	lsp_server_request: {
+		language: string;
+		method: string;
+		server_command: string;
+		params: string | null;
+	};
+	lsp_server_error: {
+		language: string;
+		server_command: string;
+		error_type: string;
+		message: string;
+	};
+	lsp_status_clicked: {
+		language: string;
+		has_error: boolean;
+		missing_servers: string[];
+		user_dismissed: boolean;
+	};
+	// ── UI events ────────────────────────────────────────────────────────────
+	action_popup_result: {
+		popup_id: string;
+		action_id: string;
+	};
+	process_output: {
+		process_id: number;
+		data: string;
+	};
+	language_changed: {
+		buffer_id: number;
+		language: string;
+	};
+	theme_inspect_key: {
+		theme_name: string;
+		key: string;
+	};
+	keyboard_shortcuts: {
+		bindings: {
+			key: string;
+			action: string;
+		}[];
+	};
+}
+/**
+* Typed overloads of `editor.on` / `editor.off`.
+*
+* When the event name is a key of `HookEventMap` the handler receives a
+* fully-typed payload — TypeScript will flag misspelled field accesses at
+* compile time. Unknown event names fall through to the untyped base
+* signatures in the EditorAPI interface.
+*
+* Both function-value and handler-name forms are supported:
+*
+* ```ts
+* editor.on("buffer_activated", (args) => { /* args.buffer_id is number *\/ });
+* editor.on("buffer_activated", "myHandler");   // registerHandler("myHandler", fn)
+* ```
+*/
+interface EditorAPI {
+	on<K extends keyof HookEventMap>(eventName: K, handler: (args: HookEventMap[K]) => boolean | void | Promise<boolean | void>): void;
+	on<K extends keyof HookEventMap>(eventName: K, handlerName: string): void;
+	off<K extends keyof HookEventMap>(eventName: K, handler: (args: HookEventMap[K]) => boolean | void | Promise<boolean | void>): void;
+	off<K extends keyof HookEventMap>(eventName: K, handlerName: string): void;
+	/**
+	* Create a buffer group: multiple panels appearing as one tab.
+	* This is an async runtime binding (not a direct #[qjs] method).
+	*/
+	createBufferGroup(name: string, mode: string, layout: unknown): Promise<BufferGroupResult>;
+}

package/plugins/lua-lsp.ts

@@ -49,7 +49,10 @@ let luaLspError: { serverCommand: string; message: string } | null = null;
 /**
  * Handle LSP server errors for Lua
  */
-function on_lua_lsp_server_error(data: LspServerErrorData): void {
+
+
+// Register hook for LSP server errors
+editor.on("lsp_server_error", (data) => {
   // Only handle Lua language errors
   if (data.language !== "lua") {
     return;
@@ -71,18 +74,15 @@ function on_lua_lsp_server_error(data: LspServerErrorData): void {
   } else {
     editor.setStatus(`Lua LSP error: ${data.message}`);
   }
-}
-registerHandler("on_lua_lsp_server_error", on_lua_lsp_server_error);
-
-// Register hook for LSP server errors
-editor.on("lsp_server_error", "on_lua_lsp_server_error");
+});
 
 /**
  * Handle status bar click when there's a Lua LSP error
  */
-function on_lua_lsp_status_clicked(
-  data: LspStatusClickedData
-): void {
+
+
+// Register hook for status bar clicks
+editor.on("lsp_status_clicked", (data) => {
   // Only handle Lua language clicks when there's an error
   if (data.language !== "lua" || !luaLspError) {
     return;
@@ -103,18 +103,15 @@ function on_lua_lsp_status_clicked(
       { id: "dismiss", label: "Dismiss (ESC)" },
     ],
   });
-}
-registerHandler("on_lua_lsp_status_clicked", on_lua_lsp_status_clicked);
-
-// Register hook for status bar clicks
-editor.on("lsp_status_clicked", "on_lua_lsp_status_clicked");
+});
 
 /**
  * Handle action popup results for Lua LSP help
  */
-function on_lua_lsp_action_result(
-  data: ActionPopupResultData
-): void {
+
+
+// Register hook for action popup results
+editor.on("action_popup_result", (data) => {
   // Only handle our popup
   if (data.popup_id !== "lua-lsp-help") {
     return;
@@ -152,10 +149,6 @@ function on_lua_lsp_action_result(
     default:
       editor.debug(`lua-lsp: Unknown action: ${data.action_id}`);
   }
-}
-registerHandler("on_lua_lsp_action_result", on_lua_lsp_action_result);
-
-// Register hook for action popup results
-editor.on("action_popup_result", "on_lua_lsp_action_result");
+});
 
 editor.debug("lua-lsp: Plugin loaded");