@visulima/ansi 4.0.0-alpha.2 → 4.0.0-alpha.4

package/dist/title.d.ts

@@ -0,0 +1,185 @@
+/**
+ * Sets the icon name and window title using an OSC (Operating System Command) sequence.
+ * This typically affects the title shown in the window's title bar and the name used for the icon
+ * when the window is minimized or in a taskbar.
+ *
+ * Uses the sequence: `OSC 0 ; title BEL`
+ * - `OSC`: Operating System Command (`\x1b]`).
+ * - `0`: Parameter indicating to set both icon name and window title.
+ * - `title`: The string to set.
+ * - `BEL`: Bell character (`\x07`) as terminator.
+ * @param title The string to be set as both the icon name and the window title.
+ * @returns The ANSI escape sequence for setting the icon name and window title.
+ * @see {@link https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h2-Operating-System-Commands Xterm OSC documentation}
+ * @example
+ * ```typescript
+ * import { setIconNameAndWindowTitle } from "@visulima/ansi";
+ *
+ * process.stdout.write(setIconNameAndWindowTitle("My Application"));
+ * // Sends: "\x1b]0;My Application\x07"
+ * ```
+ */
+export declare const setIconNameAndWindowTitle: (title: string) => string;
+/**
+ * Sets the icon name using an OSC (Operating System Command) sequence.
+ * This affects the name used for the icon when the window is minimized or in a taskbar.
+ *
+ * Uses the sequence: `OSC 1 ; iconName BEL`
+ * - `OSC`: Operating System Command (`\x1b]`).
+ * - `1`: Parameter indicating to set only the icon name.
+ * - `iconName`: The string to set as the icon name.
+ * - `BEL`: Bell character (`\x07`) as terminator.
+ * @param iconName The string to be set as the icon name.
+ * @returns The ANSI escape sequence for setting the icon name.
+ * @see {@link https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h2-Operating-System-Commands Xterm OSC documentation}
+ * @example
+ * ```typescript
+ * import { setIconName } from "@visulima/ansi";
+ *
+ * process.stdout.write(setIconName("AppIcon"));
+ * // Sends: "\x1b]1;AppIcon\x07"
+ * ```
+ */
+export declare const setIconName: (iconName: string) => string;
+/**
+ * Sets the window title using an OSC (Operating System Command) sequence.
+ * This affects the title shown in the window's title bar.
+ *
+ * Uses the sequence: `OSC 2 ; title BEL`
+ * - `OSC`: Operating System Command (`\x1b]`).
+ * - `2`: Parameter indicating to set only the window title.
+ * - `title`: The string to set as the window title.
+ * - `BEL`: Bell character (`\x07`) as terminator.
+ * @param title The string to be set as the window title.
+ * @returns The ANSI escape sequence for setting the window title.
+ * @see {@link https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h2-Operating-System-Commands Xterm OSC documentation}
+ * @example
+ * ```typescript
+ * import { setWindowTitle } from "@visulima/ansi";
+ *
+ * process.stdout.write(setWindowTitle("Current Document - Editor"));
+ * // Sends: "\x1b]2;Current Document - Editor\x07"
+ * ```
+ */
+export declare const setWindowTitle: (title: string) => string;
+/**
+ * Sets a DEC Special Window Title (DECSWT) using an OSC sequence.
+ * The original Go library implemented this by prepending "1;" to the title and using `setWindowTitle`,
+ * resulting in an `OSC 2 ; 1;<title> BEL` sequence.
+ * This differs from some interpretations where DECSWT might use `OSC 1`.
+ * This implementation replicates the Go library's specific behavior.
+ *
+ * Note: DECSWT (`OSC 2;1;...BEL`) was introduced in the DEC VT520/VT525 family
+ * and is ignored by earlier DEC terminals. Support varies across modern emulators;
+ * for example, Zutty 0.6+ claims VT520 compatibility, but many others that handle
+ * common OSC sequences may drop or ignore DECSWT.
+ * If relying on this sequence, testing on actual VT520 hardware or emulators
+ * with known VT520 support is recommended. Unsupported sequences are typically
+ * silently ignored by most terminals.
+ *
+ * Uses the sequence: `OSC 2 ; 1;<title> BEL` (based on Go library's behavior)
+ * @param title The title string.
+ * @returns The ANSI escape sequence for DECSWT (as implemented).
+ * @see EK-VT520-RM 5–134 (VT520 Programmer Reference Manual)
+ * @see setWindowTitle
+ * @example
+ * ```typescript
+ * import { decswt } from "@visulima/ansi";
+ *
+ * process.stdout.write(decswt("My Special Window"));
+ * // Sends: "\\x1b]2;1;My Special Window\\x07"
+ * ```
+ */
+export declare const decswt: (title: string) => string;
+/**
+ * Sets a DEC Special Icon Name (DECSIN) using an OSC sequence.
+ * The original Go library implemented this by prepending "L;" to the name and using `setWindowTitle`,
+ * resulting in an `OSC 2 ; L;<name> BEL` sequence.
+ * This differs from some interpretations where DECSIN might use `OSC L` or `OSC 1`.
+ * This implementation replicates the Go library's specific behavior.
+ *
+ * Note: DECSIN (`OSC 2;L;...BEL`) was introduced in the DEC VT520/VT525 family
+ * and is ignored by earlier DEC terminals. Support varies across modern emulators;
+ * for example, Zutty 0.6+ claims VT520 compatibility, but many others that handle
+ * common OSC sequences may drop or ignore DECSIN.
+ * If relying on this sequence, testing on actual VT520 hardware or emulators
+ * with known VT520 support is recommended. Unsupported sequences are typically
+ * silently ignored by most terminals.
+ *
+ * Uses the sequence: `OSC 2 ; L;<name> BEL` (based on Go library's behavior)
+ * @param name The name or content for the DEC-style icon name.
+ * @returns The ANSI escape sequence for DECSIN (as implemented).
+ * @see EK-VT520-RM 5–134 (VT520 Programmer Reference Manual)
+ * @see setWindowTitle
+ * @example
+ * ```typescript
+ * import { decsin } from "@visulima/ansi";
+ *
+ * process.stdout.write(decsin("SpecialIcon"));
+ * // Sends: "\\x1b]2;L;SpecialIcon\\x07"
+ * ```
+ */
+export declare const decsin: (name: string) => string;
+/**
+ * Sets the icon name and window title using an OSC sequence, terminated with ST (String Terminator).
+ * This is an alternative to the BEL-terminated version.
+ *
+ * Uses the sequence: `OSC 0 ; title ST`
+ * - `OSC`: Operating System Command (`\x1b]`).
+ * - `0`: Parameter indicating to set both icon name and window title.
+ * - `title`: The string to set.
+ * - `ST`: String Terminator (`\x1b\\`).
+ * @param title The string to be set as both the icon name and the window title.
+ * @returns The ANSI escape sequence for setting the icon name and window title, using ST.
+ * @see {@link https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h2-Operating-System-Commands Xterm OSC documentation}
+ * @example
+ * ```typescript
+ * import { setIconNameAndWindowTitleWithST } from "@visulima/ansi";
+ *
+ * process.stdout.write(setIconNameAndWindowTitleWithST("My App ST"));
+ * // Sends: "\x1b]0;My App ST\x1b\\"
+ * ```
+ */
+export declare const setIconNameAndWindowTitleWithST: (title: string) => string;
+/**
+ * Sets the icon name using an OSC sequence, terminated with ST (String Terminator).
+ * This is an alternative to the BEL-terminated version.
+ *
+ * Uses the sequence: `OSC 1 ; iconName ST`
+ * - `OSC`: Operating System Command (`\x1b]`).
+ * - `1`: Parameter indicating to set only the icon name.
+ * - `iconName`: The string to set as the icon name.
+ * - `ST`: String Terminator (`\x1b\\`).
+ * @param iconName The string to be set as the icon name.
+ * @returns The ANSI escape sequence for setting the icon name, using ST.
+ * @see {@link https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h2-Operating-System-Commands Xterm OSC documentation}
+ * @example
+ * ```typescript
+ * import { setIconNameWithST } from "@visulima/ansi";
+ *
+ * process.stdout.write(setIconNameWithST("AppIcon ST"));
+ * // Sends: "\x1b]1;AppIcon ST\x1b\\"
+ * ```
+ */
+export declare const setIconNameWithST: (iconName: string) => string;
+/**
+ * Sets the window title using an OSC sequence, terminated with ST (String Terminator).
+ * This is an alternative to the BEL-terminated version.
+ *
+ * Uses the sequence: `OSC 2 ; title ST`
+ * - `OSC`: Operating System Command (`\x1b]`).
+ * - `2`: Parameter indicating to set only the window title.
+ * - `title`: The string to set as the window title.
+ * - `ST`: String Terminator (`\x1b\\`).
+ * @param title The string to be set as the window title.
+ * @returns The ANSI escape sequence for setting the window title, using ST.
+ * @see {@link https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h2-Operating-System-Commands Xterm OSC documentation}
+ * @example
+ * ```typescript
+ * import { setWindowTitleWithST } from "@visulima/ansi";
+ *
+ * process.stdout.write(setWindowTitleWithST("Document ST - Editor"));
+ * // Sends: "\x1b]2;Document ST - Editor\x1b\\"
+ * ```
+ */
+export declare const setWindowTitleWithST: (title: string) => string;

package/dist/title.js

@@ -0,0 +1 @@
+var d=Object.defineProperty;var a=(e,n)=>d(e,"name",{value:n,configurable:!0});import{O as i,B as o,a as s}from"./packem_shared/constants-D12jy2Zh.js";var r=Object.defineProperty,t=a((e,n)=>r(e,"name",{value:n,configurable:!0}),"n");const T=t(e=>{if(typeof e!="string")throw new TypeError("Title must be a string");return e.replaceAll(/[\u0007\u001B]/g,"")},"validateTitle"),W=t(e=>`${i}0;${T(e)}${o}`,"setIconNameAndWindowTitle"),m=t(e=>`${i}1;${e}${o}`,"setIconName"),$=t(e=>`${i}2;${e}${o}`,"setWindowTitle"),w=t(e=>$(`1;${e}`),"decswt"),I=t(e=>$(`L;${e}`),"decsin"),N=t(e=>`${i}0;${e}${s}`,"setIconNameAndWindowTitleWithST"),S=t(e=>`${i}1;${e}${s}`,"setIconNameWithST"),h=t(e=>`${i}2;${e}${s}`,"setWindowTitleWithST");export{I as decsin,w as decswt,m as setIconName,W as setIconNameAndWindowTitle,N as setIconNameAndWindowTitleWithST,S as setIconNameWithST,$ as setWindowTitle,h as setWindowTitleWithST};

package/dist/window-ops.d.ts

@@ -0,0 +1,418 @@
+/**
+ * Enum for XTerm Window Operations (XTWINOPS).
+ * These are parameters for the `CSI Ps ; Ps ; Ps t` sequence.
+ * @see {@link https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h4-Functions-using-CSI-_-ordered-by-the-final-character-lparen-s-rparen:CSI-Ps;Ps;Ps-t.1EB0}
+ */
+export declare enum XTermWindowOp {
+    /**
+     * De-iconify window.
+     */
+    DEICONIFY_WINDOW = 1,
+    /**
+     * Iconify window.
+     */
+    ICONIFY_WINDOW = 2,
+    /**
+     * Lower the window to the bottom of the stacking order.
+     */
+    LOWER_WINDOW = 6,
+    /**
+     * Maximize window (i.e., "zoom" or "toggle").
+     */
+    MAXIMIZE_WINDOW = 10,
+    /**
+     * Maximize window horizontally.
+     */
+    MAXIMIZE_WINDOW_HORIZONTALLY = 10.2,
+    /**
+     * Maximize window vertically.
+     */
+    MAXIMIZE_WINDOW_VERTICALLY = 10.1,
+    /**
+     * Move window to `[x, y]`.
+     */
+    MOVE_WINDOW = 3,
+    /**
+     * Pop window title from stack.
+     */
+    POP_WINDOW_TITLE = 23,
+    /**
+     * Push window title on stack.
+     */
+    PUSH_WINDOW_TITLE = 22,
+    /**
+     * Raise the window to the front of the stacking order.
+     */
+    RAISE_WINDOW = 5,
+    /**
+     * Refresh the window.
+     */
+    REFRESH_WINDOW = 7,
+    /**
+     * Report cell size in pixels.
+     * Response: `CSI 6 ; height ; width t`
+     */
+    REPORT_CELL_SIZE_PIXELS = 16,// From Go code
+    /**
+     * Report icon label.
+     * Response: `OSC L label ST`
+     */
+    REPORT_ICON_LABEL = 19,
+    /**
+     * Report text area size in characters.
+     * Response: `CSI 4 ; height ; width t`
+     */
+    REPORT_TEXT_AREA_SIZE_CHARS = 14,
+    /**
+     * Report text area size in pixels.
+     * Response: `CSI 8 ; height ; width t`
+     */
+    REPORT_TEXT_AREA_SIZE_PIXELS = 18,
+    /**
+     * Report window position.
+     * Response: `CSI 3 ; x ; y t`
+     */
+    REPORT_WINDOW_POSITION = 13,
+    /**
+     * Report window state.
+     * Response: `CSI code t` where `code` is 1 if de-iconified, 2 if iconified.
+     */
+    REPORT_WINDOW_STATE = 11,
+    /**
+     * Report window title.
+     * Response: `OSC l label ST`
+     */
+    REPORT_WINDOW_TITLE = 21,
+    /**
+     * Report window size in pixels.
+     * Alias for `REPORT_TEXT_AREA_SIZE_PIXELS` for compatibility with some terminals (e.g., mintty).
+     * Response: `CSI 4 ; height ; width t`
+     * Should be REPORT_TEXT_AREA_SIZE_PIXELS (18) for XTerm, but using Go's value.
+     */
+    REQUEST_WINDOW_SIZE_WIN_OP_COMPAT = 14,// From Go code
+    /**
+     * Resize the screen to `[width, height]` in pixels and resize the text area to `[cols, lines]` in characters.
+     * (DECSLPP - Set Lines Per Page)
+     */
+    RESIZE_SCREEN_AND_TEXT_AREA = 24,// Typically with one param (lines), but XTerm extends it for width/height too
+    /**
+     * Resize the text area to `[height, width]` in characters.
+     */
+    RESIZE_TEXT_AREA_CHARS = 4,
+    /**
+     * Resize the text area to `[height, width]` in pixels.
+     */
+    RESIZE_TEXT_AREA_PIXELS = 8,
+    /**
+     * Restore maximized window.
+     */
+    RESTORE_MAXIMIZED_WINDOW = 9,
+    /**
+     * Undo full-screen mode.
+     */
+    UNDO_FULL_SCREEN_MODE = 10.3
+}
+/**
+ * Generates an XTerm Window Operation (XTWINOPS) sequence.
+ *
+ * `CSI Ps ; Ps ; Ps t`
+ * @param p The primary parameter, typically one of {@link XTermWindowOp}.
+ * @param ps Additional parameters.
+ * @returns The ANSI sequence string, or an empty string if `p` is invalid.
+ * @see {@link https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h4-Functions-using-CSI-_-ordered-by-the-final-character-lparen-s-rparen:CSI-Ps;Ps;Ps-t.1EB0}
+ */
+export declare const xtermWindowOp: (p: number, ...ps: number[]) => string;
+/**
+ * Alias for {@link xtermWindowOp}.
+ */
+export declare const XTWINOPS: (p: number, ...ps: number[]) => string;
+/**
+ * Resizes the terminal window's text area to a specified height and width in characters.
+ * This effectively sets the number of rows and columns for text display.
+ *
+ * Sequence: `CSI 4 ; height ; width t`
+ * @param height The desired height in characters (number of rows).
+ * @param width The desired width in characters (number of columns).
+ * @returns The ANSI escape sequence to resize the text area.
+ * @see xtermWindowOp
+ * @see XTermWindowOp.RESIZE_TEXT_AREA_CHARS
+ * @example
+ * ```typescript
+ * import { resizeTextAreaChars } from "@visulima/ansi";
+ *
+ * // Resize to 24 rows, 80 columns
+ * process.stdout.write(resizeTextAreaChars(24, 80));
+ * // Sends: "\x1b[4;24;80t"
+ * ```
+ */
+export declare const resizeTextAreaChars: (height: number, width: number) => string;
+/**
+ * Requests a report of the terminal window's text area size in characters (rows and columns).
+ * The terminal is expected to respond with a sequence like `CSI 4 ; height ; width t`.
+ *
+ * This function uses `XTermWindowOp.REQUEST_WINDOW_SIZE_WIN_OP_COMPAT` (14), which corresponds to
+ * `XTermWindowOp.REPORT_TEXT_AREA_SIZE_CHARS` in XTerm.
+ *
+ * Sequence: `CSI 14 t` (which triggers the report `CSI 4 ; height ; width t`)
+ * @returns The ANSI escape sequence to request the text area size in characters.
+ * @see xtermWindowOp
+ * @see XTermWindowOp.REPORT_TEXT_AREA_SIZE_CHARS
+ * @see XTermWindowOp.REQUEST_WINDOW_SIZE_WIN_OP_COMPAT
+ * @example
+ * ```typescript
+ * import { requestTextAreaSizeChars } from "@visulima/ansi";
+ *
+ * process.stdout.write(requestTextAreaSizeChars());
+ * // Sends: "\x1b[14t"
+ * // Expect response like: "\x1b[4;24;80t" if terminal is 24x80
+ * ```
+ */
+export declare const requestTextAreaSizeChars: () => string;
+/**
+ * Requests a report of the terminal's character cell size in pixels.
+ * The terminal is expected to respond with a sequence like `CSI 6 ; height ; width t`,
+ * where height and width are the dimensions of a single character cell in pixels.
+ *
+ * Sequence: `CSI 16 t` (which triggers the report `CSI 6 ; height ; width t`)
+ * @returns The ANSI escape sequence to request the cell size in pixels.
+ * @see xtermWindowOp
+ * @see XTermWindowOp.REPORT_CELL_SIZE_PIXELS
+ * @example
+ * ```typescript
+ * import { requestCellSizePixels } from "@visulima/ansi";
+ *
+ * process.stdout.write(requestCellSizePixels());
+ * // Sends: "\x1b[16t"
+ * // Expect response like: "\x1b[6;15;8t" if cell size is 15px height, 8px width
+ * ```
+ */
+export declare const requestCellSizePixels: () => string;
+/**
+ * Requests a report of the terminal window's text area size in pixels.
+ * The terminal is expected to respond with a sequence like `CSI 8 ; height ; width t`.
+ *
+ * Sequence: `CSI 18 t` (which triggers the report `CSI 8 ; height ; width t`)
+ * @returns The ANSI escape sequence to request the text area size in pixels.
+ * @see xtermWindowOp
+ * @see XTermWindowOp.REPORT_TEXT_AREA_SIZE_PIXELS
+ * @example
+ * ```typescript
+ * import { requestTextAreaSizePixels } from "@visulima/ansi";
+ *
+ * process.stdout.write(requestTextAreaSizePixels());
+ * // Sends: "\x1b[18t"
+ * // Expect response like: "\x1b[8;600;800t" if text area is 600px height, 800px width
+ * ```
+ */
+export declare const requestTextAreaSizePixels: () => string;
+/**
+ * De-iconifies the terminal window (restores it if minimized).
+ *
+ * Sequence: `CSI 1 t`
+ * @returns The ANSI escape sequence to de-iconify the window.
+ * @see xtermWindowOp
+ * @see XTermWindowOp.DEICONIFY_WINDOW
+ * @example
+ * ```typescript
+ * import { deiconifyWindow } from "@visulima/ansi";
+ *
+ * process.stdout.write(deiconifyWindow()); // Sends: "\x1b[1t"
+ * ```
+ */
+export declare const deiconifyWindow: () => string;
+/**
+ * Iconifies the terminal window (minimizes it).
+ *
+ * Sequence: `CSI 2 t`
+ * @returns The ANSI escape sequence to iconify the window.
+ * @see xtermWindowOp
+ * @see XTermWindowOp.ICONIFY_WINDOW
+ * @example
+ * ```typescript
+ * import { iconifyWindow } from "@visulima/ansi";
+ *
+ * process.stdout.write(iconifyWindow()); // Sends: "\x1b[2t"
+ * ```
+ */
+export declare const iconifyWindow: () => string;
+/**
+ * Moves the terminal window to the specified screen coordinates (top-left corner).
+ *
+ * Sequence: `CSI 3 ; x ; y t`
+ * - `x`: The X-coordinate (horizontal position in pixels from the left edge).
+ * - `y`: The Y-coordinate (vertical position in pixels from the top edge).
+ * @param x The target X-coordinate for the window's top-left corner.
+ * @param y The target Y-coordinate for the window's top-left corner.
+ * @returns The ANSI escape sequence to move the window.
+ * @see xtermWindowOp
+ * @see XTermWindowOp.MOVE_WINDOW
+ * @example
+ * ```typescript
+ * import { moveWindow } from "@visulima/ansi";
+ *
+ * // Move window to X=100, Y=50
+ * process.stdout.write(moveWindow(100, 50)); // Sends: "\x1b[3;100;50t"
+ * ```
+ */
+export declare const moveWindow: (x: number, y: number) => string;
+/**
+ * Raises the terminal window to the front of the stacking order.
+ *
+ * Sequence: `CSI 5 t`
+ * @returns The ANSI escape sequence to raise the window.
+ * @see xtermWindowOp
+ * @see XTermWindowOp.RAISE_WINDOW
+ * @example
+ * ```typescript
+ * import { raiseWindow } from "@visulima/ansi";
+ *
+ * process.stdout.write(raiseWindow()); // Sends: "\x1b[5t"
+ * ```
+ */
+export declare const raiseWindow: () => string;
+/**
+ * Lowers the terminal window to the bottom of the stacking order.
+ *
+ * Sequence: `CSI 6 t`
+ * @returns The ANSI escape sequence to lower the window.
+ * @see xtermWindowOp
+ * @see XTermWindowOp.LOWER_WINDOW
+ * @example
+ * ```typescript
+ * import { lowerWindow } from "@visulima/ansi";
+ *
+ * process.stdout.write(lowerWindow()); // Sends: "\x1b[6t"
+ * ```
+ */
+export declare const lowerWindow: () => string;
+/**
+ * Refreshes the terminal window content.
+ * This can be useful if the display becomes corrupted or needs redrawing.
+ *
+ * Sequence: `CSI 7 t`
+ * @returns The ANSI escape sequence to refresh the window.
+ * @see xtermWindowOp
+ * @see XTermWindowOp.REFRESH_WINDOW
+ * @example
+ * ```typescript
+ * import { refreshWindow } from "@visulima/ansi";
+ *
+ * process.stdout.write(refreshWindow()); // Sends: "\x1b[7t"
+ * ```
+ */
+export declare const refreshWindow: () => string;
+/**
+ * Resizes the terminal window's text area to a specified height and width in pixels.
+ *
+ * Sequence: `CSI 8 ; height ; width t`
+ * @param height The desired height in pixels.
+ * @param width The desired width in pixels.
+ * @returns The ANSI escape sequence to resize the text area in pixels.
+ * @see xtermWindowOp
+ * @see XTermWindowOp.RESIZE_TEXT_AREA_PIXELS
+ * @example
+ * ```typescript
+ * import { resizeTextAreaPixels } from "@visulima/ansi";
+ *
+ * // Resize text area to 600px height, 800px width
+ * process.stdout.write(resizeTextAreaPixels(600, 800));
+ * // Sends: "\x1b[8;600;800t"
+ * ```
+ */
+export declare const resizeTextAreaPixels: (height: number, width: number) => string;
+/**
+ * Restores a maximized terminal window to its previous size and position.
+ * XTerm typically uses `CSI 9 ; 0 t` for this operation, where 0 signifies restore.
+ * Some interpretations might use `CSI 9 t` if no other parameter implies restore.
+ *
+ * Sequence: `CSI 9 t` (simplified, relies on `XTermWindowOp.RESTORE_MAXIMIZED_WINDOW` which is 9)
+ * More specific might be `CSI 9 ; 0 t`.
+ * @returns The ANSI escape sequence to restore a maximized window.
+ * @see xtermWindowOp
+ * @see XTermWindowOp.RESTORE_MAXIMIZED_WINDOW
+ * @example
+ * ```typescript
+ * import { restoreMaximizedWindow } from "@visulima/ansi";
+ *
+ * process.stdout.write(restoreMaximizedWindow()); // Sends: "\x1b[9t"
+ * ```
+ */
+export declare const restoreMaximizedWindow: () => string;
+/**
+ * Maximizes the terminal window (often a "zoom" or toggle effect).
+ * XTerm typically uses `CSI 9 ; 1 t` for this, where 1 signifies maximize.
+ * Some terminals might use `CSI 10 t` for a general maximize/toggle.
+ * This function uses `XTermWindowOp.MAXIMIZE_WINDOW` which is 10.
+ *
+ * Sequence: `CSI 10 t` (using `XTermWindowOp.MAXIMIZE_WINDOW`)
+ * @returns The ANSI escape sequence to maximize the window.
+ * @see xtermWindowOp
+ * @see XTermWindowOp.MAXIMIZE_WINDOW
+ * @example
+ * ```typescript
+ * import { maximizeWindow } from "@visulima/ansi";
+ *
+ * process.stdout.write(maximizeWindow()); // Sends: "\x1b[10t"
+ * ```
+ */
+export declare const maximizeWindow: () => string;
+/**
+ * Report window position.
+ * Response: `CSI 3 ; x ; y t`
+ * `CSI 1 3 t`
+ *
+ * Requests a report of the terminal window's position on the screen.
+ * The terminal responds with `CSI 3 ; x ; y t` where x and y are the window coordinates.
+ * @returns The ANSI escape sequence to request window position.
+ * @see xtermWindowOp
+ * @see XTermWindowOp.REPORT_WINDOW_POSITION
+ * @example
+ * ```typescript
+ * import { reportWindowPosition } from "@visulima/ansi";
+ *
+ * process.stdout.write(reportWindowPosition());
+ * // Sends: "\x1b[13t"
+ * // Expect response like: "\x1b[3;100;50t" if window is at position (100, 50)
+ * ```
+ */
+export declare const reportWindowPosition: () => string;
+/**
+ * Report window state.
+ * Response: `CSI 1 t` if de-iconified, `CSI 2 t` if iconified.
+ * (XTerm doc uses `CSI ? 1 t` and `CSI ? 2 t`, but general form `CSI Ps t` is also listed for 11)
+ * `CSI 1 1 t`
+ *
+ * Requests a report of the terminal window's state (iconified/minimized or de-iconified/normal).
+ * The terminal responds with `CSI 1 t` if de-iconified or `CSI 2 t` if iconified.
+ * @returns The ANSI escape sequence to request window state.
+ * @see xtermWindowOp
+ * @see XTermWindowOp.REPORT_WINDOW_STATE
+ * @example
+ * ```typescript
+ * import { reportWindowState } from "@visulima/ansi";
+ *
+ * process.stdout.write(reportWindowState());
+ * // Sends: "\x1b[11t"
+ * // Expect response: "\x1b[1t" (de-iconified) or "\x1b[2t" (iconified)
+ * ```
+ */
+export declare const reportWindowState: () => string;
+/**
+ * Set page size (DECSLPP - Set Lines Per Page), often used for resizing the screen.
+ * `CSI Pl t` where Pl is the number of lines.
+ * XTerm extends this to `CSI > lines ; width ; height t` where width/height are in pixels.
+ * `CSI 24 ; lines t`
+ * @param lines The number of lines for the page.
+ * @returns The ANSI escape sequence to set page size.
+ * @see xtermWindowOp
+ * @see XTermWindowOp.RESIZE_SCREEN_AND_TEXT_AREA
+ * @example
+ * ```typescript
+ * import { setPageSizeLines } from "@visulima/ansi";
+ *
+ * // Set page size to 30 lines
+ * process.stdout.write(setPageSizeLines(30));
+ * // Sends: "\x1b[24;30t"
+ * ```
+ */
+export declare const setPageSizeLines: (lines: number) => string;

package/dist/window-ops.js

@@ -0,0 +1 @@
+var R=Object.defineProperty;var T=(_,W)=>R(_,"name",{value:W,configurable:!0});import{C as E}from"./packem_shared/constants-D12jy2Zh.js";var r=Object.defineProperty,e=T((_,W)=>r(_,"name",{value:W,configurable:!0}),"_"),A=(_=>(_[_.DEICONIFY_WINDOW=1]="DEICONIFY_WINDOW",_[_.ICONIFY_WINDOW=2]="ICONIFY_WINDOW",_[_.LOWER_WINDOW=6]="LOWER_WINDOW",_[_.MAXIMIZE_WINDOW=10]="MAXIMIZE_WINDOW",_[_.MAXIMIZE_WINDOW_HORIZONTALLY=10.2]="MAXIMIZE_WINDOW_HORIZONTALLY",_[_.MAXIMIZE_WINDOW_VERTICALLY=10.1]="MAXIMIZE_WINDOW_VERTICALLY",_[_.MOVE_WINDOW=3]="MOVE_WINDOW",_[_.POP_WINDOW_TITLE=23]="POP_WINDOW_TITLE",_[_.PUSH_WINDOW_TITLE=22]="PUSH_WINDOW_TITLE",_[_.RAISE_WINDOW=5]="RAISE_WINDOW",_[_.REFRESH_WINDOW=7]="REFRESH_WINDOW",_[_.REPORT_CELL_SIZE_PIXELS=16]="REPORT_CELL_SIZE_PIXELS",_[_.REPORT_ICON_LABEL=19]="REPORT_ICON_LABEL",_[_.REPORT_TEXT_AREA_SIZE_CHARS=14]="REPORT_TEXT_AREA_SIZE_CHARS",_[_.REPORT_TEXT_AREA_SIZE_PIXELS=18]="REPORT_TEXT_AREA_SIZE_PIXELS",_[_.REPORT_WINDOW_POSITION=13]="REPORT_WINDOW_POSITION",_[_.REPORT_WINDOW_STATE=11]="REPORT_WINDOW_STATE",_[_.REPORT_WINDOW_TITLE=21]="REPORT_WINDOW_TITLE",_[_.REQUEST_WINDOW_SIZE_WIN_OP_COMPAT=14]="REQUEST_WINDOW_SIZE_WIN_OP_COMPAT",_[_.RESIZE_SCREEN_AND_TEXT_AREA=24]="RESIZE_SCREEN_AND_TEXT_AREA",_[_.RESIZE_TEXT_AREA_CHARS=4]="RESIZE_TEXT_AREA_CHARS",_[_.RESIZE_TEXT_AREA_PIXELS=8]="RESIZE_TEXT_AREA_PIXELS",_[_.RESTORE_MAXIMIZED_WINDOW=9]="RESTORE_MAXIMIZED_WINDOW",_[_.UNDO_FULL_SCREEN_MODE=10.3]="UNDO_FULL_SCREEN_MODE",_))(A||{});const I=e((_,...W)=>{if(![10.1,10.2,10.3].includes(_)&&_<=0)return"";const O=[_];for(const i of W)i>=0&&O.push(i);return`${E}${O.join(";")}t`},"xtermWindowOp"),o=I,P=e((_,W)=>I(4,_,W),"resizeTextAreaChars"),D=e(()=>I(14),"requestTextAreaSizeChars"),n=e(()=>I(16),"requestCellSizePixels"),t=e(()=>I(18),"requestTextAreaSizePixels"),s=e(()=>I(1),"deiconifyWindow"),L=e(()=>I(2),"iconifyWindow"),a=e((_,W)=>I(3,_,W),"moveWindow"),d=e(()=>I(5),"raiseWindow"),C=e(()=>I(6),"lowerWindow"),X=e(()=>I(7),"refreshWindow"),w=e((_,W)=>I(8,_,W),"resizeTextAreaPixels"),M=e(()=>I(9),"restoreMaximizedWindow"),Z=e(()=>I(10),"maximizeWindow"),x=e(()=>I(13),"reportWindowPosition"),z=e(()=>I(11),"reportWindowState"),l=e(_=>I(24,_),"setPageSizeLines");export{o as XTWINOPS,A as XTermWindowOp,s as deiconifyWindow,L as iconifyWindow,C as lowerWindow,Z as maximizeWindow,a as moveWindow,d as raiseWindow,X as refreshWindow,x as reportWindowPosition,z as reportWindowState,n as requestCellSizePixels,D as requestTextAreaSizeChars,t as requestTextAreaSizePixels,P as resizeTextAreaChars,w as resizeTextAreaPixels,M as restoreMaximizedWindow,l as setPageSizeLines,I as xtermWindowOp};