@visulima/ansi 2.0.0 → 3.0.0

package/dist/clear.d.cts

@@ -1,77 +0,0 @@
-/**
- * Moves the cursor to the top-left (0,0 in 0-indexed terms) and erases from the cursor to the end of the screen.
- *
- * This sequence is a combination of:
- * 1. {@link cursorTo}(0, 0): Moves the cursor to the first row, first column.
- * (Equivalent to `CSI 1;1H` as `cursorTo` uses 0-indexed arguments which are converted to 1-indexed for the sequence).
- * 2. {@link eraseDisplay}({@link EraseDisplayMode.ToEnd}): Erases from the cursor position to the end of the screen (`CSI 0J` or `CSI J`).
- *
- * Effective combined sequence: `CSI 1;1H CSI J` (or `CSI 1;1H CSI 0J`).
- * @see {@link cursorTo}
- * @see {@link eraseDisplay}
- * @see {@link EraseDisplayMode.ToEnd}
- */
-export declare const clearScreenFromTopLeft: string;
-/**
- * Erases the entire current line and moves the cursor to the beginning of that line (column 1).
- *
- * This sequence is a combination of:
- * 1. {@link eraseInLine}({@link EraseLineMode.EntireLine}): Erases the entire current line (`CSI 2K`).
- * 2. `CSI G`: Moves the cursor to column 1 of the current line (Cursor Horizontal Absolute).
- * Alternatively, a carriage return (`\r`) could achieve a similar cursor move to the start of the line on many systems.
- *
- * Effective combined sequence: `CSI 2K CSI G`.
- * @see {@link eraseInLine}
- * @see {@link EraseLineMode.EntireLine}
- */
-export declare const clearLineAndHomeCursor: string;
-/**
- * Homes the cursor to the top-left position (row 1, column 1) and erases the entire screen.
- *
- * This sequence is a combination of:
- * 1. `CSI H`: Moves the cursor to the home position (top-left, equivalent to `CSI 1;1H`).
- * 2. {@link eraseDisplay}({@link EraseDisplayMode.EntireScreen}): Erases the entire screen (`CSI 2J`).
- *
- * Effective combined sequence: `CSI H CSI 2J`.
- * @remarks This is a very common sequence for clearing the visible terminal window.
- * @see {@link cursorPosition} (which `CSI H` relates to)
- * @see {@link eraseDisplay}
- * @see {@link EraseDisplayMode.EntireScreen}
- */
-export declare const clearScreenAndHomeCursor: string;
-/**
- * Clears the entire terminal display, including the scrollback buffer on supported terminals,
- * and attempts to reset the terminal to its initial (or a more pristine) state.
- *
- * This is generally a more comprehensive and forceful clear operation than just erasing the
- * visible screen content (like {@link clearScreenAndHomeCursor}).
- *
- * The exact behavior and sequences used can vary by terminal and operating system:
- *
- * - **On Windows:**
- * It typically uses `CSI 2J` (erase entire screen) followed by `CSI 0f`.
- * `CSI 0f` (or `CSI ;f`, `CSI 0;0f`) is an SGR sequence that also often acts as a cursor home command,
- * though its standardization can be less consistent than `CSI H`.
- * The primary goal is to clear the screen and move the cursor to the top-left.
- *
- * - **On other platforms (e.g., Linux, macOS with XTerm-like terminals):**
- * A more robust combination is used:
- * 1. {@link eraseDisplay}({@link EraseDisplayMode.EntireScreen}) (`CSI 2J`): Erases the entire visible screen.
- * 2. {@link eraseDisplay}({@link EraseDisplayMode.EntireScreenAndScrollback}) (`CSI 3J`): Erases the scrollback buffer (XTerm-specific, but widely supported).
- * 3. `CSI H`: Moves the cursor to the home position (top-left).
- * 4. `ESC c` (RIS - Reset to Initial State): This is the most powerful reset sequence. It typically resets the terminal
- * to its power-on state, clearing character sets, SGR attributes, modes, and more.
- * @returns A string containing the ANSI escape sequence(s) for resetting the terminal.
- * @example
- * ```typescript
- * import { resetTerminal } from '@visulima/ansi/clear';
- *
- * process.stdout.write(resetTerminal);
- * // The terminal attempts a full reset.
- * ```
- * @see {@link eraseDisplay}
- * @see {@link EraseDisplayMode.EntireScreen}
- * @see {@link EraseDisplayMode.EntireScreenAndScrollback}
- * @see {@link https://vt100.net/docs/vt510-rm/RIS.html} RIS documentation.
- */
-export declare const resetTerminal: string;

package/dist/clear.d.mts

@@ -1,77 +0,0 @@
-/**
- * Moves the cursor to the top-left (0,0 in 0-indexed terms) and erases from the cursor to the end of the screen.
- *
- * This sequence is a combination of:
- * 1. {@link cursorTo}(0, 0): Moves the cursor to the first row, first column.
- * (Equivalent to `CSI 1;1H` as `cursorTo` uses 0-indexed arguments which are converted to 1-indexed for the sequence).
- * 2. {@link eraseDisplay}({@link EraseDisplayMode.ToEnd}): Erases from the cursor position to the end of the screen (`CSI 0J` or `CSI J`).
- *
- * Effective combined sequence: `CSI 1;1H CSI J` (or `CSI 1;1H CSI 0J`).
- * @see {@link cursorTo}
- * @see {@link eraseDisplay}
- * @see {@link EraseDisplayMode.ToEnd}
- */
-export declare const clearScreenFromTopLeft: string;
-/**
- * Erases the entire current line and moves the cursor to the beginning of that line (column 1).
- *
- * This sequence is a combination of:
- * 1. {@link eraseInLine}({@link EraseLineMode.EntireLine}): Erases the entire current line (`CSI 2K`).
- * 2. `CSI G`: Moves the cursor to column 1 of the current line (Cursor Horizontal Absolute).
- * Alternatively, a carriage return (`\r`) could achieve a similar cursor move to the start of the line on many systems.
- *
- * Effective combined sequence: `CSI 2K CSI G`.
- * @see {@link eraseInLine}
- * @see {@link EraseLineMode.EntireLine}
- */
-export declare const clearLineAndHomeCursor: string;
-/**
- * Homes the cursor to the top-left position (row 1, column 1) and erases the entire screen.
- *
- * This sequence is a combination of:
- * 1. `CSI H`: Moves the cursor to the home position (top-left, equivalent to `CSI 1;1H`).
- * 2. {@link eraseDisplay}({@link EraseDisplayMode.EntireScreen}): Erases the entire screen (`CSI 2J`).
- *
- * Effective combined sequence: `CSI H CSI 2J`.
- * @remarks This is a very common sequence for clearing the visible terminal window.
- * @see {@link cursorPosition} (which `CSI H` relates to)
- * @see {@link eraseDisplay}
- * @see {@link EraseDisplayMode.EntireScreen}
- */
-export declare const clearScreenAndHomeCursor: string;
-/**
- * Clears the entire terminal display, including the scrollback buffer on supported terminals,
- * and attempts to reset the terminal to its initial (or a more pristine) state.
- *
- * This is generally a more comprehensive and forceful clear operation than just erasing the
- * visible screen content (like {@link clearScreenAndHomeCursor}).
- *
- * The exact behavior and sequences used can vary by terminal and operating system:
- *
- * - **On Windows:**
- * It typically uses `CSI 2J` (erase entire screen) followed by `CSI 0f`.
- * `CSI 0f` (or `CSI ;f`, `CSI 0;0f`) is an SGR sequence that also often acts as a cursor home command,
- * though its standardization can be less consistent than `CSI H`.
- * The primary goal is to clear the screen and move the cursor to the top-left.
- *
- * - **On other platforms (e.g., Linux, macOS with XTerm-like terminals):**
- * A more robust combination is used:
- * 1. {@link eraseDisplay}({@link EraseDisplayMode.EntireScreen}) (`CSI 2J`): Erases the entire visible screen.
- * 2. {@link eraseDisplay}({@link EraseDisplayMode.EntireScreenAndScrollback}) (`CSI 3J`): Erases the scrollback buffer (XTerm-specific, but widely supported).
- * 3. `CSI H`: Moves the cursor to the home position (top-left).
- * 4. `ESC c` (RIS - Reset to Initial State): This is the most powerful reset sequence. It typically resets the terminal
- * to its power-on state, clearing character sets, SGR attributes, modes, and more.
- * @returns A string containing the ANSI escape sequence(s) for resetting the terminal.
- * @example
- * ```typescript
- * import { resetTerminal } from '@visulima/ansi/clear';
- *
- * process.stdout.write(resetTerminal);
- * // The terminal attempts a full reset.
- * ```
- * @see {@link eraseDisplay}
- * @see {@link EraseDisplayMode.EntireScreen}
- * @see {@link EraseDisplayMode.EntireScreenAndScrollback}
- * @see {@link https://vt100.net/docs/vt510-rm/RIS.html} RIS documentation.
- */
-export declare const resetTerminal: string;

package/dist/clear.mjs

@@ -1,10 +0,0 @@
-import { C as CSI, E as ESC } from './packem_shared/constants-CE7WkXh_.mjs';
-import { s as cursorTo, A as isWindows } from './packem_shared/cursor-DhFQcQ9g.mjs';
-import { eraseDisplay, EraseDisplayMode, eraseInLine, EraseLineMode } from './erase.mjs';
-
-const clearScreenFromTopLeft = cursorTo(0, 0) + eraseDisplay(EraseDisplayMode.ToEnd);
-const clearLineAndHomeCursor = `${eraseInLine(EraseLineMode.EntireLine) + CSI}G`;
-const clearScreenAndHomeCursor = `${CSI}H${eraseDisplay(EraseDisplayMode.EntireScreen)}`;
-const resetTerminal = isWindows ? `${eraseDisplay(EraseDisplayMode.EntireScreen) + CSI}0f` : `${eraseDisplay(EraseDisplayMode.EntireScreen) + eraseDisplay(EraseDisplayMode.EntireScreenAndScrollback) + CSI}H${ESC}c`;
-
-export { clearLineAndHomeCursor, clearScreenAndHomeCursor, clearScreenFromTopLeft, resetTerminal };

package/dist/constants.d.cts

@@ -1,20 +0,0 @@
-/** Escape character (\u001B). */
-export declare const ESC: string;
-/** Control Sequence Introducer (ESC [). */
-export declare const CSI: string;
-/** Operating System Command (ESC ]). */
-export declare const OSC: string;
-/** Bell character (\u0007). Often used to terminate OSC sequences. */
-export declare const BEL: string;
-/** Separator used in some ANSI sequences, typically a semicolon. */
-export declare const SEP: string;
-/** Device Control String (ESC P). */
-export declare const DCS: string;
-/** String Terminator (ESC \\). Used to terminate DCS, SOS, PM, APC sequences. */
-export declare const ST: string;
-/** Application Program Command (ESC _). */
-export declare const APC: string;
-/** Start of String (ESC X). */
-export declare const SOS: string;
-/** Privacy Message (ESC ^). */
-export declare const PM: string;

package/dist/constants.d.mts

@@ -1,20 +0,0 @@
-/** Escape character (\u001B). */
-export declare const ESC: string;
-/** Control Sequence Introducer (ESC [). */
-export declare const CSI: string;
-/** Operating System Command (ESC ]). */
-export declare const OSC: string;
-/** Bell character (\u0007). Often used to terminate OSC sequences. */
-export declare const BEL: string;
-/** Separator used in some ANSI sequences, typically a semicolon. */
-export declare const SEP: string;
-/** Device Control String (ESC P). */
-export declare const DCS: string;
-/** String Terminator (ESC \\). Used to terminate DCS, SOS, PM, APC sequences. */
-export declare const ST: string;
-/** Application Program Command (ESC _). */
-export declare const APC: string;
-/** Start of String (ESC X). */
-export declare const SOS: string;
-/** Privacy Message (ESC ^). */
-export declare const PM: string;

package/dist/constants.d.ts

@@ -1,20 +0,0 @@
-/** Escape character (\u001B). */
-export declare const ESC: string;
-/** Control Sequence Introducer (ESC [). */
-export declare const CSI: string;
-/** Operating System Command (ESC ]). */
-export declare const OSC: string;
-/** Bell character (\u0007). Often used to terminate OSC sequences. */
-export declare const BEL: string;
-/** Separator used in some ANSI sequences, typically a semicolon. */
-export declare const SEP: string;
-/** Device Control String (ESC P). */
-export declare const DCS: string;
-/** String Terminator (ESC \\). Used to terminate DCS, SOS, PM, APC sequences. */
-export declare const ST: string;
-/** Application Program Command (ESC _). */
-export declare const APC: string;
-/** Start of String (ESC X). */
-export declare const SOS: string;
-/** Privacy Message (ESC ^). */
-export declare const PM: string;

package/dist/cursor.cjs

@@ -1,41 +0,0 @@
-'use strict';
-
-Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: 'Module' } });
-
-require('./packem_shared/constants-BK26O-46.cjs');
-const cursor = require('./packem_shared/cursor-CQKLCu7U.cjs');
-const restoreCursor = require('./packem_shared/restoreCursor-DC_ZKZwT.cjs');
-
-
-
-exports.CURSOR_BACKWARD_1 = cursor.CURSOR_BACKWARD_1;
-exports.CURSOR_DOWN_1 = cursor.CURSOR_DOWN_1;
-exports.CURSOR_FORWARD_1 = cursor.CURSOR_FORWARD_1;
-exports.CURSOR_UP_1 = cursor.CURSOR_UP_1;
-exports.CursorStyle = cursor.CursorStyle;
-exports.REQUEST_CURSOR_POSITION = cursor.REQUEST_CURSOR_POSITION;
-exports.REQUEST_EXTENDED_CURSOR_POSITION = cursor.REQUEST_EXTENDED_CURSOR_POSITION;
-exports.RESTORE_CURSOR_DEC = cursor.RESTORE_CURSOR_DEC;
-exports.SAVE_CURSOR_DEC = cursor.SAVE_CURSOR_DEC;
-exports.cursorBackward = cursor.cursorBackward;
-exports.cursorBackwardTab = cursor.cursorBackwardTab;
-exports.cursorDown = cursor.cursorDown;
-exports.cursorForward = cursor.cursorForward;
-exports.cursorHide = cursor.cursorHide;
-exports.cursorHorizontalAbsolute = cursor.cursorHorizontalAbsolute;
-exports.cursorHorizontalForwardTab = cursor.cursorHorizontalForwardTab;
-exports.cursorLeft = cursor.cursorLeft;
-exports.cursorMove = cursor.cursorMove;
-exports.cursorNextLine = cursor.cursorNextLine;
-exports.cursorPosition = cursor.cursorPosition;
-exports.cursorPreviousLine = cursor.cursorPreviousLine;
-exports.cursorRestore = cursor.cursorRestore;
-exports.cursorSave = cursor.cursorSave;
-exports.cursorShow = cursor.cursorShow;
-exports.cursorTo = cursor.cursorTo;
-exports.cursorToColumn1 = cursor.cursorToColumn1;
-exports.cursorUp = cursor.cursorUp;
-exports.cursorVerticalAbsolute = cursor.cursorVerticalAbsolute;
-exports.eraseCharacter = cursor.eraseCharacter;
-exports.setCursorStyle = cursor.setCursorStyle;
-exports.restoreCursor = restoreCursor;