@visulima/ansi 2.0.1 → 3.0.0

package/README.md

@@ -41,16 +41,16 @@ pnpm add @visulima/ansi
 
 ## Features
 
-*   **Comprehensive Cursor Control:** Functions for precise cursor positioning, movement, visibility, and style.
-*   **Screen Manipulation:** Clear parts of the screen or the entire screen, manage alternative screen buffers, and control scrolling.
-*   **Text Erasure:** Erase characters, lines, or parts of lines.
-*   **iTerm2 Integration:** Support for iTerm2 specific features like image display.
-*   **Terminal Mode Management:** Control various terminal modes like line feed, local echo, and mouse events.
-*   **Mouse Event Handling:** Enable and disable different types of mouse tracking.
-*   **Window and Title Control:** Manipulate window titles, icons, and basic window operations (maximize, minimize, etc. for supported terminals).
-*   **Status Reporting:** Request and report various terminal statuses.
-*   **Hyperlinks:** Create clickable hyperlinks in the terminal.
-*   **Utility Functions:** Includes functions to strip ANSI codes and passthrough sequences for tmux.
+- **Comprehensive Cursor Control:** Functions for precise cursor positioning, movement, visibility, and style.
+- **Screen Manipulation:** Clear parts of the screen or the entire screen, manage alternative screen buffers, and control scrolling.
+- **Text Erasure:** Erase characters, lines, or parts of lines.
+- **iTerm2 Integration:** Support for iTerm2 specific features like image display.
+- **Terminal Mode Management:** Control various terminal modes like line feed, local echo, and mouse events.
+- **Mouse Event Handling:** Enable and disable different types of mouse tracking.
+- **Window and Title Control:** Manipulate window titles, icons, and basic window operations (maximize, minimize, etc. for supported terminals).
+- **Status Reporting:** Request and report various terminal statuses.
+- **Hyperlinks:** Create clickable hyperlinks in the terminal.
+- **Utility Functions:** Includes functions to strip ANSI codes and passthrough sequences for tmux.
 
 ## Usage
 
@@ -115,7 +115,7 @@ While `@visulima/ansi` focuses on terminal control, you can combine it with libr
 import { cursorTo } from "@visulima/ansi";
 import chalk from "chalk";
 
-process.stdout.write(cursorTo(0,0));
+process.stdout.write(cursorTo(0, 0));
 process.stdout.write(chalk.blue("This is a blue message at the top left!"));
 ```
 
@@ -125,278 +125,278 @@ This package exports the following functions and constants. For a detailed list
 
 **General**
 
-*   `beep`
+- `beep`
 
 **Alternative Screen** (from `alternative-screen.ts`)
 
-*   `ALT_SCREEN_OFF`
-*   `ALT_SCREEN_ON`
-*   `alternativeScreenOff`
-*   `alternativeScreenOn`
+- `ALT_SCREEN_OFF`
+- `ALT_SCREEN_ON`
+- `alternativeScreenOff`
+- `alternativeScreenOn`
 
 **Clear** (from `clear.ts`)
 
-*   `clearLineAndHomeCursor`
-*   `clearScreenAndHomeCursor`
-*   `clearScreenFromTopLeft`
-*   `resetTerminal`
+- `clearLineAndHomeCursor`
+- `clearScreenAndHomeCursor`
+- `clearScreenFromTopLeft`
+- `resetTerminal`
 
 **Cursor** (from `cursor.ts`)
 
-*   `CURSOR_BACKWARD_1`
-*   `CURSOR_DOWN_1`
-*   `CURSOR_FORWARD_1`
-*   `CURSOR_UP_1`
-*   `cursorBackward`
-*   `cursorBackwardTab`
-*   `cursorDown`
-*   `cursorForward`
-*   `cursorHide`
-*   `cursorHorizontalAbsolute`
-*   `cursorHorizontalForwardTab`
-*   `cursorLeft`
-*   `cursorMove`
-*   `cursorNextLine`
-*   `cursorPosition`
-*   `cursorPreviousLine`
-*   `cursorRestore`
-*   `cursorSave`
-*   `cursorShow`
-*   `cursorTo`
-*   `cursorToColumn1`
-*   `cursorUp`
-*   `cursorVerticalAbsolute`
-*   `eraseCharacter` (Note: Also related to erase)
-*   `REQUEST_CURSOR_POSITION`
-*   `REQUEST_EXTENDED_CURSOR_POSITION`
-*   `RESTORE_CURSOR_DEC`
-*   `SAVE_CURSOR_DEC`
-*   `setCursorStyle`
+- `CURSOR_BACKWARD_1`
+- `CURSOR_DOWN_1`
+- `CURSOR_FORWARD_1`
+- `CURSOR_UP_1`
+- `cursorBackward`
+- `cursorBackwardTab`
+- `cursorDown`
+- `cursorForward`
+- `cursorHide`
+- `cursorHorizontalAbsolute`
+- `cursorHorizontalForwardTab`
+- `cursorLeft`
+- `cursorMove`
+- `cursorNextLine`
+- `cursorPosition`
+- `cursorPreviousLine`
+- `cursorRestore`
+- `cursorSave`
+- `cursorShow`
+- `cursorTo`
+- `cursorToColumn1`
+- `cursorUp`
+- `cursorVerticalAbsolute`
+- `eraseCharacter` (Note: Also related to erase)
+- `REQUEST_CURSOR_POSITION`
+- `REQUEST_EXTENDED_CURSOR_POSITION`
+- `RESTORE_CURSOR_DEC`
+- `SAVE_CURSOR_DEC`
+- `setCursorStyle`
 
 **Erase** (from `erase.ts`)
 
-*   `eraseDisplay`
-*   `eraseDown`
-*   `eraseInLine`
-*   `eraseLine`
-*   `eraseLineEnd`
-*   `eraseLines`
-*   `eraseLineStart`
-*   `eraseScreen`
-*   `eraseScreenAndScrollback`
-*   `eraseUp`
+- `eraseDisplay`
+- `eraseDown`
+- `eraseInLine`
+- `eraseLine`
+- `eraseLineEnd`
+- `eraseLines`
+- `eraseLineStart`
+- `eraseScreen`
+- `eraseScreenAndScrollback`
+- `eraseUp`
 
 **Hyperlink** (from `hyperlink.ts`)
 
-*   `hyperlink`
+- `hyperlink`
 
 **Image** (from `image.ts`)
 
-*   `image`
+- `image`
 
 **iTerm2 Integration** (from `iterm2.ts` and `iterm2/`)
 
-*   `IT2_AUTO`
-*   `it2Cells`
-*   `it2Percent`
-*   `it2Pixels`
-*   `iTerm2`
-*   `ITerm2File`
-*   `ITerm2FileEnd`
-*   `ITerm2FilePart`
-*   `ITerm2MultipartFileStart`
+- `IT2_AUTO`
+- `it2Cells`
+- `it2Percent`
+- `it2Pixels`
+- `iTerm2`
+- `ITerm2File`
+- `ITerm2FileEnd`
+- `ITerm2FilePart`
+- `ITerm2MultipartFileStart`
 
 **Mode** (from `mode.ts`)
 
-*   `BDSM`
-*   `BiDirectionalSupportMode`
-*   `createAnsiMode`
-*   `createDecMode`
-*   `DECRPM`
-*   `DECRQM`
-*   `InsertReplaceMode`
-*   `IRM`
-*   `isModeNotRecognized`
-*   `isModePermanentlyReset`
-*   `isModePermanentlySet`
-*   `isModeReset`
-*   `isModeSet`
-*   `KAM`
-*   `KeyboardActionMode`
-*   `LineFeedNewLineMode`
-*   `LNM`
-*   `LocalEchoMode`
-*   `reportMode`
-*   `RequestBiDirectionalSupportMode`
-*   `RequestInsertReplaceMode`
-*   `RequestKeyboardActionMode`
-*   `RequestLineFeedNewLineMode`
-*   `RequestLocalEchoMode`
-*   `requestMode`
-*   `RequestSendReceiveMode`
-*   `ResetBiDirectionalSupportMode`
-*   `ResetInsertReplaceMode`
-*   `ResetKeyboardActionMode`
-*   `ResetLineFeedNewLineMode`
-*   `ResetLocalEchoMode`
-*   `resetMode`
-*   `ResetSendReceiveMode`
-*   `RM`
-*   `SendReceiveMode`
-*   `SetBiDirectionalSupportMode`
-*   `SetInsertReplaceMode`
-*   `SetKeyboardActionMode`
-*   `SetLineFeedNewLineMode`
-*   `SetLocalEchoMode`
-*   `setMode`
-*   `SetSendReceiveMode`
-*   `SM`
-*   `SRM`
+- `BDSM`
+- `BiDirectionalSupportMode`
+- `createAnsiMode`
+- `createDecMode`
+- `DECRPM`
+- `DECRQM`
+- `InsertReplaceMode`
+- `IRM`
+- `isModeNotRecognized`
+- `isModePermanentlyReset`
+- `isModePermanentlySet`
+- `isModeReset`
+- `isModeSet`
+- `KAM`
+- `KeyboardActionMode`
+- `LineFeedNewLineMode`
+- `LNM`
+- `LocalEchoMode`
+- `reportMode`
+- `RequestBiDirectionalSupportMode`
+- `RequestInsertReplaceMode`
+- `RequestKeyboardActionMode`
+- `RequestLineFeedNewLineMode`
+- `RequestLocalEchoMode`
+- `requestMode`
+- `RequestSendReceiveMode`
+- `ResetBiDirectionalSupportMode`
+- `ResetInsertReplaceMode`
+- `ResetKeyboardActionMode`
+- `ResetLineFeedNewLineMode`
+- `ResetLocalEchoMode`
+- `resetMode`
+- `ResetSendReceiveMode`
+- `RM`
+- `SendReceiveMode`
+- `SetBiDirectionalSupportMode`
+- `SetInsertReplaceMode`
+- `SetKeyboardActionMode`
+- `SetLineFeedNewLineMode`
+- `SetLocalEchoMode`
+- `setMode`
+- `SetSendReceiveMode`
+- `SM`
+- `SRM`
 
 **Mouse** (from `mouse.ts`)
 
-*   `disableAnyEventMouse`
-*   `disableButtonEventMouse`
-*   `disableFocusTracking`
-*   `disableNormalMouse`
-*   `disableSgrMouse`
-*   `disableX10Mouse`
-*   `enableAnyEventMouse`
-*   `enableButtonEventMouse`
-*   `enableFocusTracking`
-*   `enableNormalMouse`
-*   `enableSgrMouse`
-*   `enableX10Mouse`
-*   `encodeMouseButtonByte`
-*   `MouseButton`
-*   `mouseSgrSequence`
-*   `mouseX10Sequence`
+- `disableAnyEventMouse`
+- `disableButtonEventMouse`
+- `disableFocusTracking`
+- `disableNormalMouse`
+- `disableSgrMouse`
+- `disableX10Mouse`
+- `enableAnyEventMouse`
+- `enableButtonEventMouse`
+- `enableFocusTracking`
+- `enableNormalMouse`
+- `enableSgrMouse`
+- `enableX10Mouse`
+- `encodeMouseButtonByte`
+- `MouseButton`
+- `mouseSgrSequence`
+- `mouseX10Sequence`
 
 **Passthrough** (from `passthrough.ts`)
 
-*   `SCREEN_MAX_LEN_DEFAULT`
-*   `SCREEN_TYPICAL_LIMIT`
-*   `screenPassthrough`
-*   `tmuxPassthrough`
+- `SCREEN_MAX_LEN_DEFAULT`
+- `SCREEN_TYPICAL_LIMIT`
+- `screenPassthrough`
+- `tmuxPassthrough`
 
 **Reset** (from `reset.ts`)
 
-*   `RESET_INITIAL_STATE`
-*   `RIS`
+- `RESET_INITIAL_STATE`
+- `RIS`
 
 **Screen** (from `screen.ts`)
 
-*   `clearTabStop`
-*   `deleteCharacter`
-*   `deleteLine`
-*   `insertCharacter`
-*   `insertLine`
-*   `repeatPreviousCharacter`
-*   `requestPresentationStateReport`
-*   `setLeftRightMargins`
-*   `setTopBottomMargins`
+- `clearTabStop`
+- `deleteCharacter`
+- `deleteLine`
+- `insertCharacter`
+- `insertLine`
+- `repeatPreviousCharacter`
+- `requestPresentationStateReport`
+- `setLeftRightMargins`
+- `setTopBottomMargins`
 
 **Scroll** (from `scroll.ts`)
 
-*   `SCROLL_DOWN_1`
-*   `SCROLL_UP_1`
-*   `scrollDown`
-*   `scrollUp`
+- `SCROLL_DOWN_1`
+- `SCROLL_UP_1`
+- `scrollDown`
+- `scrollUp`
 
 **Status** (from `status.ts`)
 
-*   `CPR`
-*   `createAnsiStatusReport`
-*   `createDecStatusReport`
-*   `cursorPositionReport`
-*   `DA1`
-*   `DA2`
-*   `DA3`
-*   `DECXCPR`
-*   `deviceStatusReport`
-*   `DSR`
-*   `DSR_KeyboardLanguageDEC`
-*   `DSR_PrinterStatusDEC`
-*   `DSR_TerminalStatus`
-*   `DSR_UDKStatusDEC`
-*   `extendedCursorPositionReport`
-*   `reportKeyboardLanguageDEC`
-*   `reportPrimaryDeviceAttributes`
-*   `reportPrinterNoPaperDEC`
-*   `reportPrinterNotReadyDEC`
-*   `reportPrinterReadyDEC`
-*   `reportSecondaryDeviceAttributes`
-*   `reportTerminalNotOK`
-*   `reportTerminalOK`
-*   `reportTertiaryDeviceAttributes`
-*   `reportUDKLockedDEC`
-*   `reportUDKUnlockedDEC`
-*   `requestCursorPositionReport`
-*   `requestExtendedCursorPositionReport`
-*   `requestKeyboardLanguageDEC`
-*   `RequestNameVersion`
-*   `requestPrimaryDeviceAttributes`
-*   `requestPrimaryDeviceAttributesParam0`
-*   `requestPrinterStatusDEC`
-*   `requestSecondaryDeviceAttributes`
-*   `requestSecondaryDeviceAttributesParam0`
-*   `requestTerminalStatus`
-*   `requestTertiaryDeviceAttributes`
-*   `requestTertiaryDeviceAttributesParam0`
-*   `requestUDKStatusDEC`
-*   `XTVERSION`
+- `CPR`
+- `createAnsiStatusReport`
+- `createDecStatusReport`
+- `cursorPositionReport`
+- `DA1`
+- `DA2`
+- `DA3`
+- `DECXCPR`
+- `deviceStatusReport`
+- `DSR`
+- `DSR_KeyboardLanguageDEC`
+- `DSR_PrinterStatusDEC`
+- `DSR_TerminalStatus`
+- `DSR_UDKStatusDEC`
+- `extendedCursorPositionReport`
+- `reportKeyboardLanguageDEC`
+- `reportPrimaryDeviceAttributes`
+- `reportPrinterNoPaperDEC`
+- `reportPrinterNotReadyDEC`
+- `reportPrinterReadyDEC`
+- `reportSecondaryDeviceAttributes`
+- `reportTerminalNotOK`
+- `reportTerminalOK`
+- `reportTertiaryDeviceAttributes`
+- `reportUDKLockedDEC`
+- `reportUDKUnlockedDEC`
+- `requestCursorPositionReport`
+- `requestExtendedCursorPositionReport`
+- `requestKeyboardLanguageDEC`
+- `RequestNameVersion`
+- `requestPrimaryDeviceAttributes`
+- `requestPrimaryDeviceAttributesParam0`
+- `requestPrinterStatusDEC`
+- `requestSecondaryDeviceAttributes`
+- `requestSecondaryDeviceAttributesParam0`
+- `requestTerminalStatus`
+- `requestTertiaryDeviceAttributes`
+- `requestTertiaryDeviceAttributesParam0`
+- `requestUDKStatusDEC`
+- `XTVERSION`
 
 **Strip** (from `strip.ts`)
 
-*   `strip`
+- `strip`
 
 **Termcap/Terminfo** (from `termcap.ts`)
 
-*   `requestTermcap`
-*   `requestTerminfo`
-*   `XTGETTCAP`
+- `requestTermcap`
+- `requestTerminfo`
+- `XTGETTCAP`
 
 **Title** (from `title.ts`)
 
-*   `decsin`
-*   `decswt`
-*   `setIconName`
-*   `setIconNameAndWindowTitle`
-*   `setIconNameAndWindowTitleWithST`
-*   `setIconNameWithST`
-*   `setWindowTitle`
-*   `setWindowTitleWithST`
+- `decsin`
+- `decswt`
+- `setIconName`
+- `setIconNameAndWindowTitle`
+- `setIconNameAndWindowTitleWithST`
+- `setIconNameWithST`
+- `setWindowTitle`
+- `setWindowTitleWithST`
 
 **Window Operations** (from `window-ops.ts`)
 
-*   `deiconifyWindow`
-*   `iconifyWindow`
-*   `lowerWindow`
-*   `maximizeWindow`
-*   `moveWindow`
-*   `raiseWindow`
-*   `refreshWindow`
-*   `reportWindowPosition`
-*   `reportWindowState`
-*   `requestCellSizePixels`
-*   `requestFullScreen`
-*   `requestTextAreaSizeChars`
-*   `requestTextAreaSizePixels`
-*   `requestWindowPosition`
-*   `requestWindowSizeChars`
-*   `requestWindowSizePixels`
-*   `resizeTextAreaChars`
-*   `resizeTextAreaPixels`
-*   `restoreWindow`
-*   `XTWINOPS`
+- `deiconifyWindow`
+- `iconifyWindow`
+- `lowerWindow`
+- `maximizeWindow`
+- `moveWindow`
+- `raiseWindow`
+- `refreshWindow`
+- `reportWindowPosition`
+- `reportWindowState`
+- `requestCellSizePixels`
+- `requestFullScreen`
+- `requestTextAreaSizeChars`
+- `requestTextAreaSizePixels`
+- `requestWindowPosition`
+- `requestWindowSizeChars`
+- `requestWindowSizePixels`
+- `resizeTextAreaChars`
+- `resizeTextAreaPixels`
+- `restoreWindow`
+- `XTWINOPS`
 
 **XTerm** (from `xterm.ts`)
 
-*   `xtermBell`
-*   `xtermManipulateWindow`
-*   `xtermReport`
-*   `xtermRequest`
-*   `xtermSet`
+- `xtermBell`
+- `xtermManipulateWindow`
+- `xtermReport`
+- `xtermRequest`
+- `xtermSet`
 
 ## Related
 

package/dist/alternative-screen.d.ts

@@ -1,74 +1,6 @@
-/**
- * ANSI escape sequence to enable the alternative screen buffer.
- *
- * This sequence (`CSI ?1049h`) instructs the terminal to switch to the alternative screen buffer.
- * This is a common practice for full-screen terminal applications (e.g., vim, less, htop)
- * to provide a separate screen area for their interface, leaving the original shell content
- * undisturbed and restoring it upon exit.
- * When this mode is activated, the original screen content is typically saved by the terminal,
- * and a blank screen is presented. Operations then occur on this alternative buffer.
- *
- * The specific behavior (like whether the screen is cleared on switch) can sometimes vary
- * slightly between terminal emulators. `?1049h` generally includes saving the cursor position
- * along with the screen content and clearing the alternative screen.
- * It is closely related to mode `?47h`, which also switches to an alternative buffer but might
- * have different semantics regarding screen clearing and cursor saving.
- * Mode `?1049h` is generally preferred for a more robust alternative screen experience.
- * @see {@link ALT_SCREEN_OFF} for the sequence to disable the alternative screen buffer.
- * @see {@link alternativeScreenOn} for a function that returns this sequence.
- * @see {@link https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h2-The-Alternate-Screen-Buffer} Xterm Control Sequences documentation.
- * @see {@link https://vt100.net/docs/vt510-rm/DECSLPP.html} (related DEC modes, though 1049 is more common for this behavior).
- */
-export declare const ALT_SCREEN_ON: string;
-/**
- * ANSI escape sequence to disable the alternative screen buffer.
- *
- * This sequence (`CSI ?1049l`) instructs the terminal to switch back from the alternative
- * screen buffer to the main screen buffer. When this occurs, the terminal typically
- * restores the screen content and cursor position that were saved when the alternative
- * buffer was activated by {@link ALT_SCREEN_ON}.
- *
- * This is used when a full-screen application exits, allowing the user to return to their
- * previous shell session seamlessly.
- * @see {@link ALT_SCREEN_ON} for the sequence to enable the alternative screen buffer.
- * @see {@link alternativeScreenOff} for a function that returns this sequence.
- */
-export declare const ALT_SCREEN_OFF: string;
-/**
- * Returns the ANSI escape sequence to enable the alternative screen buffer.
- *
- * This function is a convenience wrapper around the {@link ALT_SCREEN_ON} constant.
- * It provides a more descriptive way to obtain the sequence for enabling the
- * alternative screen, often used at the initialization phase of a full-screen
- * terminal application.
- * @returns The ANSI escape sequence (`CSI ?1049h`) for enabling the alternative screen buffer.
- * @example
- * ```typescript
- * import { alternativeScreenOn } from '@visulima/ansi/alternative-screen';
- *
- * process.stdout.write(alternativeScreenOn());
- * // Terminal switches to the alternative screen buffer.
- * ```
- * @see {@link ALT_SCREEN_ON}
- * @see {@link alternativeScreenOff}
- */
-export declare const alternativeScreenOn: () => string;
-/**
- * Returns the ANSI escape sequence to disable the alternative screen buffer.
- *
- * This function is a convenience wrapper around the {@link ALT_SCREEN_OFF} constant.
- * It provides a more descriptive way to obtain the sequence for disabling the
- * alternative screen, typically used when a full-screen terminal application is exiting
- * to restore the user's original terminal state.
- * @returns The ANSI escape sequence (`CSI ?1049l`) for disabling the alternative screen buffer.
- * @example
- * ```typescript
- * import { alternativeScreenOff } from '@visulima/ansi/alternative-screen';
- *
- * process.stdout.write(alternativeScreenOff());
- * // Terminal switches back to the main screen buffer, restoring previous content.
- * ```
- * @see {@link ALT_SCREEN_OFF}
- * @see {@link alternativeScreenOn}
- */
-export declare const alternativeScreenOff: () => string;
+declare const ALT_SCREEN_ON: string;
+declare const ALT_SCREEN_OFF: string;
+declare const alternativeScreenOn: () => string;
+declare const alternativeScreenOff: () => string;
+
+export { ALT_SCREEN_OFF, ALT_SCREEN_ON, alternativeScreenOff, alternativeScreenOn };

package/dist/alternative-screen.js

@@ -0,0 +1 @@
+var c=Object.defineProperty;var t=(e,r)=>c(e,"name",{value:r,configurable:!0});import{C as a}from"./packem_shared/constants-D12jy2Zh.js";var f=Object.defineProperty,n=t((e,r)=>f(e,"name",{value:r,configurable:!0}),"t");const i=`${a}?1049h`,l=`${a}?1049l`,O=n(()=>i,"alternativeScreenOn"),S=n(()=>l,"alternativeScreenOff");export{l as ALT_SCREEN_OFF,i as ALT_SCREEN_ON,S as alternativeScreenOff,O as alternativeScreenOn};