@tuidom/core 0.1.0

package/dist/input/serializeMouse.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Convert a mouse event description to the raw SGR (1006) terminal sequence.
+ * Inverse of the mouse branch of `tokenize` — the counterpart of
+ * {@link import("./serializeKey.js").serializeKey} for the pointer:
+ *   serializeMouse({ action: "press", button: "left", x: 1, y: 1 })    → '\x1b[<0;1;1M'
+ *   serializeMouse({ action: "release", button: "left", x: 4, y: 2 })  → '\x1b[<0;4;2m'
+ *   serializeMouse({ action: "scroll-down", x: 4, y: 2 })              → '\x1b[<65;4;2M'
+ *   serializeMouse({ action: "move", button: "left", x: 4, y: 2 })     → '\x1b[<32;4;2M'
+ *
+ * Coordinates are 1-based, exactly as they arrive from a terminal and as
+ * {@link MouseToken} carries them.
+ */
+import type { MouseAction, MouseButton } from "./rawTerminalToken.js";
+export interface SerializeMouseInit {
+    action: MouseAction;
+    /** Defaults to `"none"` — the only meaningful button for scroll actions. */
+    button?: MouseButton;
+    /** 1-based column */
+    x: number;
+    /** 1-based row */
+    y: number;
+    shiftKey?: boolean;
+    altKey?: boolean;
+    ctrlKey?: boolean;
+}
+export declare function serializeMouse(init: SerializeMouseInit): string;

package/dist/input/serializeMouse.js

@@ -0,0 +1,38 @@
+/**
+ * Convert a mouse event description to the raw SGR (1006) terminal sequence.
+ * Inverse of the mouse branch of `tokenize` — the counterpart of
+ * {@link import("./serializeKey.ts").serializeKey} for the pointer:
+ *   serializeMouse({ action: "press", button: "left", x: 1, y: 1 })    → '\x1b[<0;1;1M'
+ *   serializeMouse({ action: "release", button: "left", x: 4, y: 2 })  → '\x1b[<0;4;2m'
+ *   serializeMouse({ action: "scroll-down", x: 4, y: 2 })              → '\x1b[<65;4;2M'
+ *   serializeMouse({ action: "move", button: "left", x: 4, y: 2 })     → '\x1b[<32;4;2M'
+ *
+ * Coordinates are 1-based, exactly as they arrive from a terminal and as
+ * {@link MouseToken} carries them.
+ */
+/** Bits 0-1 of the button byte. `none` maps to 3, the "no button" encoding. */
+const buttonBits = { left: 0, middle: 1, right: 2, none: 3 };
+/** Scroll actions live at 64 + wheel direction (up/down/left/right). */
+const scrollBits = {
+    "scroll-up": 64,
+    "scroll-down": 65,
+    "scroll-left": 66,
+    "scroll-right": 67,
+};
+export function serializeMouse(init) {
+    const { action, x, y } = init;
+    const button = init.button ?? "none";
+    let cb = scrollBits[action] ?? buttonBits[button];
+    if (action === "move")
+        cb |= 32;
+    if (init.shiftKey === true)
+        cb |= 4;
+    if (init.altKey === true)
+        cb |= 8;
+    if (init.ctrlKey === true)
+        cb |= 16;
+    // SGR distinguishes release from press by the final byte, not by the button
+    // bits — that is exactly why we speak 1006 and not the legacy X10 form.
+    const finalByte = action === "release" ? "m" : "M";
+    return `\x1b[<${String(cb)};${String(x)};${String(y)}${finalByte}`;
+}

package/dist/input/tokenize.d.ts

@@ -0,0 +1,59 @@
+import type { CsiLetterToken, CsiTildeToken, CsiUToken, DeviceReportToken, MouseToken, OscToken, RawTerminalToken, UnknownCsiToken } from "./rawTerminalToken.js";
+export declare function tokenize(data: string): RawTerminalToken[];
+/**
+ * Map Kitty Keyboard Protocol codepoints (Private Use Area U+E000+) to DOM-style key/code.
+ * Also includes standard codepoints used in CSI u for common keys (Enter, Tab, etc.).
+ *
+ * Reference: https://sw.kovidgoyal.net/kitty/keyboard-protocol/#functional-key-definitions
+ */
+export declare const kittyCodepointMap: Partial<Record<number, {
+    key: string;
+    code?: string;
+}>>;
+/** CSI final-byte → key name (cursor keys, F1–F4) */
+export declare const csiKeyMap: Partial<Record<string, string>>;
+/** CSI number~ → key name (navigation, F5–F12) */
+export declare const tildeKeyMap: Partial<Record<number, string>>;
+/** SS3 (ESC O) final-byte → key name */
+export declare const ss3KeyMap: Partial<Record<string, string>>;
+/**
+ * Decode xterm/kitty modifier parameter into individual boolean flags.
+ *
+ * Modifier encoding: value = 1 + bitmask
+ * Bitmask bits: 0=Shift, 1=Alt, 2=Ctrl, 3=Super(Meta), 4=Hyper, 5=Meta, 6=CapsLock, 7=NumLock
+ */
+export declare function decodeModifiers(mod: number): {
+    shiftKey: boolean;
+    altKey: boolean;
+    ctrlKey: boolean;
+    metaKey: boolean;
+};
+/**
+ * Infer a DOM-style `code` from a key value.
+ * Best-effort for traditional terminal mode (no physical key info available).
+ */
+export declare function inferCode(key: string): string;
+interface CSITokenResult {
+    token: CsiUToken | CsiLetterToken | CsiTildeToken | MouseToken | DeviceReportToken | UnknownCsiToken;
+    nextIndex: number;
+}
+/**
+ * Parse a CSI sequence starting at data[start] = ESC, data[start+1] = '['.
+ * Returns the parsed token and next index, or null if the sequence is not recognized.
+ *
+ * A `null` return also signals an *incomplete* sequence (e.g. the chunk was cut
+ * mid-sequence by stdin packetization) — KeyInputParser relies on this to buffer
+ * the tail until the rest arrives. See KeyInputParser.incompleteTailStart.
+ */
+export declare function parseCSI(data: string, start: number): CSITokenResult | null;
+interface OSCTokenResult {
+    token: OscToken;
+    nextIndex: number;
+}
+/**
+ * Parse an OSC sequence starting at data[start] = ESC, data[start+1] = ']'.
+ * OSC is terminated by BEL (\x07) or ST (\x1b\\).
+ * Returns null if the sequence is not complete.
+ */
+export declare function parseOSC(data: string, start: number): OSCTokenResult | null;
+export {};