@visulima/ansi 1.0.18 → 1.1.0

package/dist/image.mjs

@@ -1,19 +1,24 @@
-import { B as BEL, O as OSC } from './packem_shared/constants-CqXMfQy0.mjs';
+import { Buffer } from 'node:buffer';
+import { O as OSC, B as BEL } from './packem_shared/constants-CE7WkXh_.mjs';
 
 var __defProp = Object.defineProperty;
 var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
 const image = /* @__PURE__ */ __name((data, options = {}) => {
+  if (!data) {
+    return "";
+  }
   let returnValue = `${OSC}1337;File=inline=1`;
-  if (options.width) {
+  if (options.width !== void 0) {
     returnValue += `;width=${options.width}`;
   }
-  if (options.height) {
+  if (options.height !== void 0) {
     returnValue += `;height=${options.height}`;
   }
   if (options.preserveAspectRatio === false) {
     returnValue += ";preserveAspectRatio=0";
   }
-  return returnValue + ":" + Buffer.from(data).toString("base64") + BEL;
+  const base64Data = Buffer.from(data).toString("base64");
+  return `${returnValue}:${base64Data}${BEL}`;
 }, "image");
 
-export { image as default };
+export { image };

package/dist/index.cjs

@@ -4,45 +4,243 @@ Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toString
 
 const alternativeScreen = require('./alternative-screen.cjs');
 const clear = require('./clear.cjs');
-const cursor = require('./packem_shared/cursor-2tHgT9r6.cjs');
+const cursor = require('./packem_shared/cursor-CQKLCu7U.cjs');
 const erase = require('./erase.cjs');
+const hyperlink = require('./hyperlink.cjs');
 const image = require('./image.cjs');
-const link = require('./link.cjs');
+const iterm2 = require('./iterm2.cjs');
+const mode = require('./mode.cjs');
+const mouse = require('./mouse.cjs');
+const passthrough = require('./passthrough.cjs');
+const reset = require('./reset.cjs');
+const screen = require('./screen.cjs');
 const scroll = require('./scroll.cjs');
+const status = require('./status.cjs');
 const strip = require('./strip.cjs');
+const termcap = require('./termcap.cjs');
+const title = require('./title.cjs');
+const windowOps = require('./window-ops.cjs');
+const xterm = require('./xterm.cjs');
+const IT2_AUTO = require('./packem_shared/IT2_AUTO-5vTJQMm6.cjs');
+const ITerm2File = require('./packem_shared/ITerm2File-BGPqNSjB.cjs');
 
 const beep = "\x07";
 
-exports.alternativeScreenEnter = alternativeScreen.alternativeScreenEnter;
-exports.alternativeScreenExit = alternativeScreen.alternativeScreenExit;
-exports.clearLine = clear.clearLine;
-exports.clearScreen = clear.clearScreen;
-exports.clearScrollbar = clear.clearScrollbar;
-exports.clearTerminal = clear.clearTerminal;
-exports.fullReset = clear.fullReset;
+exports.ALT_SCREEN_OFF = alternativeScreen.ALT_SCREEN_OFF;
+exports.ALT_SCREEN_ON = alternativeScreen.ALT_SCREEN_ON;
+exports.alternativeScreenOff = alternativeScreen.alternativeScreenOff;
+exports.alternativeScreenOn = alternativeScreen.alternativeScreenOn;
+exports.clearLineAndHomeCursor = clear.clearLineAndHomeCursor;
+exports.clearScreenAndHomeCursor = clear.clearScreenAndHomeCursor;
+exports.clearScreenFromTopLeft = clear.clearScreenFromTopLeft;
+exports.resetTerminal = clear.resetTerminal;
+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.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.eraseDisplay = erase.eraseDisplay;
 exports.eraseDown = erase.eraseDown;
+exports.eraseInLine = erase.eraseInLine;
 exports.eraseLine = erase.eraseLine;
 exports.eraseLineEnd = erase.eraseLineEnd;
 exports.eraseLineStart = erase.eraseLineStart;
 exports.eraseLines = erase.eraseLines;
 exports.eraseScreen = erase.eraseScreen;
+exports.eraseScreenAndScrollback = erase.eraseScreenAndScrollback;
 exports.eraseUp = erase.eraseUp;
-exports.image = image;
-exports.link = link;
+exports.hyperlink = hyperlink;
+exports.image = image.image;
+exports.iTerm2 = iterm2.iTerm2;
+exports.BDSM = mode.BDSM;
+exports.BiDirectionalSupportMode = mode.BiDirectionalSupportMode;
+exports.DECRPM = mode.DECRPM;
+exports.DECRQM = mode.DECRQM;
+exports.IRM = mode.IRM;
+exports.InsertReplaceMode = mode.InsertReplaceMode;
+exports.KAM = mode.KAM;
+exports.KeyboardActionMode = mode.KeyboardActionMode;
+exports.LNM = mode.LNM;
+exports.LineFeedNewLineMode = mode.LineFeedNewLineMode;
+exports.LocalEchoMode = mode.LocalEchoMode;
+exports.RM = mode.RM;
+exports.RequestBiDirectionalSupportMode = mode.RequestBiDirectionalSupportMode;
+exports.RequestInsertReplaceMode = mode.RequestInsertReplaceMode;
+exports.RequestKeyboardActionMode = mode.RequestKeyboardActionMode;
+exports.RequestLineFeedNewLineMode = mode.RequestLineFeedNewLineMode;
+exports.RequestLocalEchoMode = mode.RequestLocalEchoMode;
+exports.RequestSendReceiveMode = mode.RequestSendReceiveMode;
+exports.ResetBiDirectionalSupportMode = mode.ResetBiDirectionalSupportMode;
+exports.ResetInsertReplaceMode = mode.ResetInsertReplaceMode;
+exports.ResetKeyboardActionMode = mode.ResetKeyboardActionMode;
+exports.ResetLineFeedNewLineMode = mode.ResetLineFeedNewLineMode;
+exports.ResetLocalEchoMode = mode.ResetLocalEchoMode;
+exports.ResetSendReceiveMode = mode.ResetSendReceiveMode;
+exports.SM = mode.SM;
+exports.SRM = mode.SRM;
+exports.SendReceiveMode = mode.SendReceiveMode;
+exports.SetBiDirectionalSupportMode = mode.SetBiDirectionalSupportMode;
+exports.SetInsertReplaceMode = mode.SetInsertReplaceMode;
+exports.SetKeyboardActionMode = mode.SetKeyboardActionMode;
+exports.SetLineFeedNewLineMode = mode.SetLineFeedNewLineMode;
+exports.SetLocalEchoMode = mode.SetLocalEchoMode;
+exports.SetSendReceiveMode = mode.SetSendReceiveMode;
+exports.createAnsiMode = mode.createAnsiMode;
+exports.createDecMode = mode.createDecMode;
+exports.isModeNotRecognized = mode.isModeNotRecognized;
+exports.isModePermanentlyReset = mode.isModePermanentlyReset;
+exports.isModePermanentlySet = mode.isModePermanentlySet;
+exports.isModeReset = mode.isModeReset;
+exports.isModeSet = mode.isModeSet;
+exports.reportMode = mode.reportMode;
+exports.requestMode = mode.requestMode;
+exports.resetMode = mode.resetMode;
+exports.setMode = mode.setMode;
+exports.MouseButton = mouse.MouseButton;
+exports.disableAnyEventMouse = mouse.disableAnyEventMouse;
+exports.disableButtonEventMouse = mouse.disableButtonEventMouse;
+exports.disableFocusTracking = mouse.disableFocusTracking;
+exports.disableNormalMouse = mouse.disableNormalMouse;
+exports.disableSgrMouse = mouse.disableSgrMouse;
+exports.disableX10Mouse = mouse.disableX10Mouse;
+exports.enableAnyEventMouse = mouse.enableAnyEventMouse;
+exports.enableButtonEventMouse = mouse.enableButtonEventMouse;
+exports.enableFocusTracking = mouse.enableFocusTracking;
+exports.enableNormalMouse = mouse.enableNormalMouse;
+exports.enableSgrMouse = mouse.enableSgrMouse;
+exports.enableX10Mouse = mouse.enableX10Mouse;
+exports.encodeMouseButtonByte = mouse.encodeMouseButtonByte;
+exports.mouseSgrSequence = mouse.mouseSgrSequence;
+exports.mouseX10Sequence = mouse.mouseX10Sequence;
+exports.SCREEN_MAX_LEN_DEFAULT = passthrough.SCREEN_MAX_LEN_DEFAULT;
+exports.SCREEN_TYPICAL_LIMIT = passthrough.SCREEN_TYPICAL_LIMIT;
+exports.screenPassthrough = passthrough.screenPassthrough;
+exports.tmuxPassthrough = passthrough.tmuxPassthrough;
+exports.RESET_INITIAL_STATE = reset.RESET_INITIAL_STATE;
+exports.RIS = reset.RIS;
+exports.clearTabStop = screen.clearTabStop;
+exports.deleteCharacter = screen.deleteCharacter;
+exports.deleteLine = screen.deleteLine;
+exports.insertCharacter = screen.insertCharacter;
+exports.insertLine = screen.insertLine;
+exports.repeatPreviousCharacter = screen.repeatPreviousCharacter;
+exports.requestPresentationStateReport = screen.requestPresentationStateReport;
+exports.setLeftRightMargins = screen.setLeftRightMargins;
+exports.setTopBottomMargins = screen.setTopBottomMargins;
+exports.SCROLL_DOWN_1 = scroll.SCROLL_DOWN_1;
+exports.SCROLL_UP_1 = scroll.SCROLL_UP_1;
 exports.scrollDown = scroll.scrollDown;
 exports.scrollUp = scroll.scrollUp;
+exports.CPR = status.CPR;
+exports.DA1 = status.DA1;
+exports.DA2 = status.DA2;
+exports.DA3 = status.DA3;
+exports.DECXCPR = status.DECXCPR;
+exports.DSR = status.DSR;
+exports.DSR_KeyboardLanguageDEC = status.DSR_KeyboardLanguageDEC;
+exports.DSR_PrinterStatusDEC = status.DSR_PrinterStatusDEC;
+exports.DSR_TerminalStatus = status.DSR_TerminalStatus;
+exports.DSR_UDKStatusDEC = status.DSR_UDKStatusDEC;
+exports.RequestNameVersion = status.RequestNameVersion;
+exports.XTVERSION = status.XTVERSION;
+exports.createAnsiStatusReport = status.createAnsiStatusReport;
+exports.createDecStatusReport = status.createDecStatusReport;
+exports.cursorPositionReport = status.cursorPositionReport;
+exports.deviceStatusReport = status.deviceStatusReport;
+exports.extendedCursorPositionReport = status.extendedCursorPositionReport;
+exports.reportKeyboardLanguageDEC = status.reportKeyboardLanguageDEC;
+exports.reportPrimaryDeviceAttributes = status.reportPrimaryDeviceAttributes;
+exports.reportPrinterNoPaperDEC = status.reportPrinterNoPaperDEC;
+exports.reportPrinterNotReadyDEC = status.reportPrinterNotReadyDEC;
+exports.reportPrinterReadyDEC = status.reportPrinterReadyDEC;
+exports.reportSecondaryDeviceAttributes = status.reportSecondaryDeviceAttributes;
+exports.reportTerminalNotOK = status.reportTerminalNotOK;
+exports.reportTerminalOK = status.reportTerminalOK;
+exports.reportTertiaryDeviceAttributes = status.reportTertiaryDeviceAttributes;
+exports.reportUDKLockedDEC = status.reportUDKLockedDEC;
+exports.reportUDKUnlockedDEC = status.reportUDKUnlockedDEC;
+exports.requestCursorPositionReport = status.requestCursorPositionReport;
+exports.requestExtendedCursorPositionReport = status.requestExtendedCursorPositionReport;
+exports.requestKeyboardLanguageDEC = status.requestKeyboardLanguageDEC;
+exports.requestPrimaryDeviceAttributes = status.requestPrimaryDeviceAttributes;
+exports.requestPrimaryDeviceAttributesParam0 = status.requestPrimaryDeviceAttributesParam0;
+exports.requestPrinterStatusDEC = status.requestPrinterStatusDEC;
+exports.requestSecondaryDeviceAttributes = status.requestSecondaryDeviceAttributes;
+exports.requestSecondaryDeviceAttributesParam0 = status.requestSecondaryDeviceAttributesParam0;
+exports.requestTerminalStatus = status.requestTerminalStatus;
+exports.requestTertiaryDeviceAttributes = status.requestTertiaryDeviceAttributes;
+exports.requestTertiaryDeviceAttributesParam0 = status.requestTertiaryDeviceAttributesParam0;
+exports.requestUDKStatusDEC = status.requestUDKStatusDEC;
 exports.strip = strip;
+exports.XTGETTCAP = termcap.XTGETTCAP;
+exports.requestTermcap = termcap.requestTermcap;
+exports.requestTerminfo = termcap.requestTerminfo;
+exports.decsin = title.decsin;
+exports.decswt = title.decswt;
+exports.setIconName = title.setIconName;
+exports.setIconNameAndWindowTitle = title.setIconNameAndWindowTitle;
+exports.setIconNameAndWindowTitleWithST = title.setIconNameAndWindowTitleWithST;
+exports.setIconNameWithST = title.setIconNameWithST;
+exports.setWindowTitle = title.setWindowTitle;
+exports.setWindowTitleWithST = title.setWindowTitleWithST;
+exports.XTWINOPS = windowOps.XTWINOPS;
+exports.deiconifyWindow = windowOps.deiconifyWindow;
+exports.iconifyWindow = windowOps.iconifyWindow;
+exports.lowerWindow = windowOps.lowerWindow;
+exports.maximizeWindow = windowOps.maximizeWindow;
+exports.moveWindow = windowOps.moveWindow;
+exports.raiseWindow = windowOps.raiseWindow;
+exports.refreshWindow = windowOps.refreshWindow;
+exports.reportWindowPosition = windowOps.reportWindowPosition;
+exports.reportWindowState = windowOps.reportWindowState;
+exports.requestCellSizePixels = windowOps.requestCellSizePixels;
+exports.requestTextAreaSizeChars = windowOps.requestTextAreaSizeChars;
+exports.requestTextAreaSizePixels = windowOps.requestTextAreaSizePixels;
+exports.resizeTextAreaChars = windowOps.resizeTextAreaChars;
+exports.resizeTextAreaPixels = windowOps.resizeTextAreaPixels;
+exports.restoreMaximizedWindow = windowOps.restoreMaximizedWindow;
+exports.setPageSizeLines = windowOps.setPageSizeLines;
+exports.xtermWindowOp = windowOps.xtermWindowOp;
+exports.XTMODKEYS = xterm.XTMODKEYS;
+exports.XTQMODKEYS = xterm.XTQMODKEYS;
+exports.keyModifierOptions = xterm.keyModifierOptions;
+exports.queryKeyModifierOptions = xterm.queryKeyModifierOptions;
+exports.queryModifyOtherKeys = xterm.queryModifyOtherKeys;
+exports.resetKeyModifierOptions = xterm.resetKeyModifierOptions;
+exports.resetModifyOtherKeys = xterm.resetModifyOtherKeys;
+exports.setKeyModifierOptions = xterm.setKeyModifierOptions;
+exports.setModifyOtherKeys1 = xterm.setModifyOtherKeys1;
+exports.setModifyOtherKeys2 = xterm.setModifyOtherKeys2;
+exports.IT2_AUTO = IT2_AUTO.IT2_AUTO;
+exports.it2Cells = IT2_AUTO.it2Cells;
+exports.it2Percent = IT2_AUTO.it2Percent;
+exports.it2Pixels = IT2_AUTO.it2Pixels;
+exports.ITerm2File = ITerm2File.ITerm2File;
+exports.ITerm2FileEnd = ITerm2File.ITerm2FileEnd;
+exports.ITerm2FilePart = ITerm2File.ITerm2FilePart;
+exports.ITerm2MultipartFileStart = ITerm2File.ITerm2MultipartFileStart;
 exports.beep = beep;

package/dist/index.d.cts

@@ -1,12 +1,35 @@
-export { alternativeScreenEnter, alternativeScreenExit } from './alternative-screen.cjs';
-export { clearLine, clearScreen, clearScrollbar, clearTerminal, fullReset } from './clear.cjs';
-export { cursorBackward, cursorDown, cursorForward, cursorHide, cursorLeft, cursorMove, cursorNextLine, cursorPreviousLine, cursorRestore, cursorSave, cursorShow, cursorTo, cursorUp } from './cursor.cjs';
-export { eraseDown, eraseLine, eraseLineEnd, eraseLineStart, eraseLines, eraseScreen, eraseUp } from './erase.cjs';
-export { default as image } from './image.cjs';
-export { default as link } from './link.cjs';
-export { scrollDown, scrollUp } from './scroll.cjs';
-export { default as strip } from './strip.cjs';
-
-declare const beep = "\u0007";
-
-export { beep };
+/**
+ * Output a beeping sound.
+ */
+export declare const beep = "\u0007";
+export { ALT_SCREEN_OFF, ALT_SCREEN_ON, alternativeScreenOff, alternativeScreenOn, } from "./alternative-screen.d.cts";
+export { clearLineAndHomeCursor, clearScreenAndHomeCursor, clearScreenFromTopLeft, resetTerminal, } from "./clear.d.cts";
+export type { CursorStyle } from "./cursor.d.cts";
+export { 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, // Function
+cursorSave, // Function
+cursorShow, cursorTo, cursorToColumn1, cursorUp, cursorVerticalAbsolute, eraseCharacter, REQUEST_CURSOR_POSITION, REQUEST_EXTENDED_CURSOR_POSITION, RESTORE_CURSOR_DEC, // Constant for ESC 8
+SAVE_CURSOR_DEC, // Constant for ESC 7
+setCursorStyle, } from "./cursor.d.cts";
+export type { EraseDisplayMode, EraseLineMode } from "./erase.d.cts";
+export { eraseDisplay, eraseDown, eraseInLine, eraseLine, eraseLineEnd, eraseLines, eraseLineStart, eraseScreen, eraseScreenAndScrollback, eraseUp, } from "./erase.d.cts";
+export { default as hyperlink } from "./hyperlink.d.cts";
+export type { ImageOptions } from "./image.d.cts";
+export { image } from "./image.d.cts";
+export type { IITerm2Payload, ITerm2FileProperties } from "./iterm2.d.cts";
+export { IT2_AUTO, it2Cells, it2Percent, it2Pixels, iTerm2, ITerm2File, ITerm2FileEnd, ITerm2FilePart, ITerm2MultipartFileStart, } from "./iterm2.d.cts";
+export type { AnsiMode, DecMode, Mode, ModeSetting, } from "./mode.d.cts";
+export { 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, } from "./mode.d.cts";
+export type { MouseButtonType, MouseModifiers } from "./mouse.d.cts";
+export { disableAnyEventMouse, disableButtonEventMouse, disableFocusTracking, disableNormalMouse, disableSgrMouse, disableX10Mouse, enableAnyEventMouse, enableButtonEventMouse, enableFocusTracking, enableNormalMouse, enableSgrMouse, enableX10Mouse, encodeMouseButtonByte, MouseButton, mouseSgrSequence, mouseX10Sequence, } from "./mouse.d.cts";
+export { SCREEN_MAX_LEN_DEFAULT, SCREEN_TYPICAL_LIMIT, screenPassthrough, tmuxPassthrough, } from "./passthrough.d.cts";
+export { RESET_INITIAL_STATE, RIS, } from "./reset.d.cts";
+export { clearTabStop, deleteCharacter, deleteLine, insertCharacter, insertLine, repeatPreviousCharacter, requestPresentationStateReport, setLeftRightMargins, setTopBottomMargins, } from "./screen.d.cts";
+export { SCROLL_DOWN_1, SCROLL_UP_1, scrollDown, scrollUp, } from "./scroll.d.cts";
+export type { AnsiStatusReport, DecStatusReport, StatusReport } from "./status.d.cts";
+export { 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, } from "./status.d.cts";
+export { default as strip } from "./strip.d.cts";
+export { requestTermcap, requestTerminfo, XTGETTCAP, } from "./termcap.d.cts";
+export { decsin, decswt, setIconName, setIconNameAndWindowTitle, setIconNameAndWindowTitleWithST, setIconNameWithST, setWindowTitle, setWindowTitleWithST, } from "./title.d.cts";
+export type { XTermWindowOp } from "./window-ops.d.cts";
+export { deiconifyWindow, iconifyWindow, lowerWindow, maximizeWindow, moveWindow, raiseWindow, refreshWindow, reportWindowPosition, reportWindowState, requestCellSizePixels, requestTextAreaSizeChars, requestTextAreaSizePixels, resizeTextAreaChars, resizeTextAreaPixels, restoreMaximizedWindow, setPageSizeLines, xtermWindowOp, XTWINOPS, } from "./window-ops.d.cts";
+export { keyModifierOptions, queryKeyModifierOptions, queryModifyOtherKeys, resetKeyModifierOptions, resetModifyOtherKeys, setKeyModifierOptions, setModifyOtherKeys1, setModifyOtherKeys2, XTMODKEYS, XTQMODKEYS, } from "./xterm.d.cts";

package/dist/index.d.mts

@@ -1,12 +1,35 @@
-export { alternativeScreenEnter, alternativeScreenExit } from './alternative-screen.mjs';
-export { clearLine, clearScreen, clearScrollbar, clearTerminal, fullReset } from './clear.mjs';
-export { cursorBackward, cursorDown, cursorForward, cursorHide, cursorLeft, cursorMove, cursorNextLine, cursorPreviousLine, cursorRestore, cursorSave, cursorShow, cursorTo, cursorUp } from './cursor.mjs';
-export { eraseDown, eraseLine, eraseLineEnd, eraseLineStart, eraseLines, eraseScreen, eraseUp } from './erase.mjs';
-export { default as image } from './image.mjs';
-export { default as link } from './link.mjs';
-export { scrollDown, scrollUp } from './scroll.mjs';
-export { default as strip } from './strip.mjs';
-
-declare const beep = "\u0007";
-
-export { beep };
+/**
+ * Output a beeping sound.
+ */
+export declare const beep = "\u0007";
+export { ALT_SCREEN_OFF, ALT_SCREEN_ON, alternativeScreenOff, alternativeScreenOn, } from "./alternative-screen.d.mts";
+export { clearLineAndHomeCursor, clearScreenAndHomeCursor, clearScreenFromTopLeft, resetTerminal, } from "./clear.d.mts";
+export type { CursorStyle } from "./cursor.d.mts";
+export { 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, // Function
+cursorSave, // Function
+cursorShow, cursorTo, cursorToColumn1, cursorUp, cursorVerticalAbsolute, eraseCharacter, REQUEST_CURSOR_POSITION, REQUEST_EXTENDED_CURSOR_POSITION, RESTORE_CURSOR_DEC, // Constant for ESC 8
+SAVE_CURSOR_DEC, // Constant for ESC 7
+setCursorStyle, } from "./cursor.d.mts";
+export type { EraseDisplayMode, EraseLineMode } from "./erase.d.mts";
+export { eraseDisplay, eraseDown, eraseInLine, eraseLine, eraseLineEnd, eraseLines, eraseLineStart, eraseScreen, eraseScreenAndScrollback, eraseUp, } from "./erase.d.mts";
+export { default as hyperlink } from "./hyperlink.d.mts";
+export type { ImageOptions } from "./image.d.mts";
+export { image } from "./image.d.mts";
+export type { IITerm2Payload, ITerm2FileProperties } from "./iterm2.d.mts";
+export { IT2_AUTO, it2Cells, it2Percent, it2Pixels, iTerm2, ITerm2File, ITerm2FileEnd, ITerm2FilePart, ITerm2MultipartFileStart, } from "./iterm2.d.mts";
+export type { AnsiMode, DecMode, Mode, ModeSetting, } from "./mode.d.mts";
+export { 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, } from "./mode.d.mts";
+export type { MouseButtonType, MouseModifiers } from "./mouse.d.mts";
+export { disableAnyEventMouse, disableButtonEventMouse, disableFocusTracking, disableNormalMouse, disableSgrMouse, disableX10Mouse, enableAnyEventMouse, enableButtonEventMouse, enableFocusTracking, enableNormalMouse, enableSgrMouse, enableX10Mouse, encodeMouseButtonByte, MouseButton, mouseSgrSequence, mouseX10Sequence, } from "./mouse.d.mts";
+export { SCREEN_MAX_LEN_DEFAULT, SCREEN_TYPICAL_LIMIT, screenPassthrough, tmuxPassthrough, } from "./passthrough.d.mts";
+export { RESET_INITIAL_STATE, RIS, } from "./reset.d.mts";
+export { clearTabStop, deleteCharacter, deleteLine, insertCharacter, insertLine, repeatPreviousCharacter, requestPresentationStateReport, setLeftRightMargins, setTopBottomMargins, } from "./screen.d.mts";
+export { SCROLL_DOWN_1, SCROLL_UP_1, scrollDown, scrollUp, } from "./scroll.d.mts";
+export type { AnsiStatusReport, DecStatusReport, StatusReport } from "./status.d.mts";
+export { 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, } from "./status.d.mts";
+export { default as strip } from "./strip.d.mts";
+export { requestTermcap, requestTerminfo, XTGETTCAP, } from "./termcap.d.mts";
+export { decsin, decswt, setIconName, setIconNameAndWindowTitle, setIconNameAndWindowTitleWithST, setIconNameWithST, setWindowTitle, setWindowTitleWithST, } from "./title.d.mts";
+export type { XTermWindowOp } from "./window-ops.d.mts";
+export { deiconifyWindow, iconifyWindow, lowerWindow, maximizeWindow, moveWindow, raiseWindow, refreshWindow, reportWindowPosition, reportWindowState, requestCellSizePixels, requestTextAreaSizeChars, requestTextAreaSizePixels, resizeTextAreaChars, resizeTextAreaPixels, restoreMaximizedWindow, setPageSizeLines, xtermWindowOp, XTWINOPS, } from "./window-ops.d.mts";
+export { keyModifierOptions, queryKeyModifierOptions, queryModifyOtherKeys, resetKeyModifierOptions, resetModifyOtherKeys, setKeyModifierOptions, setModifyOtherKeys1, setModifyOtherKeys2, XTMODKEYS, XTQMODKEYS, } from "./xterm.d.mts";

package/dist/index.d.ts

@@ -1,12 +1,35 @@
-export { alternativeScreenEnter, alternativeScreenExit } from './alternative-screen.js';
-export { clearLine, clearScreen, clearScrollbar, clearTerminal, fullReset } from './clear.js';
-export { cursorBackward, cursorDown, cursorForward, cursorHide, cursorLeft, cursorMove, cursorNextLine, cursorPreviousLine, cursorRestore, cursorSave, cursorShow, cursorTo, cursorUp } from './cursor.js';
-export { eraseDown, eraseLine, eraseLineEnd, eraseLineStart, eraseLines, eraseScreen, eraseUp } from './erase.js';
-export { default as image } from './image.js';
-export { default as link } from './link.js';
-export { scrollDown, scrollUp } from './scroll.js';
-export { default as strip } from './strip.js';
-
-declare const beep = "\u0007";
-
-export { beep };
+/**
+ * Output a beeping sound.
+ */
+export declare const beep = "\u0007";
+export { ALT_SCREEN_OFF, ALT_SCREEN_ON, alternativeScreenOff, alternativeScreenOn, } from "./alternative-screen.d.ts";
+export { clearLineAndHomeCursor, clearScreenAndHomeCursor, clearScreenFromTopLeft, resetTerminal, } from "./clear.d.ts";
+export type { CursorStyle } from "./cursor.d.ts";
+export { 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, // Function
+cursorSave, // Function
+cursorShow, cursorTo, cursorToColumn1, cursorUp, cursorVerticalAbsolute, eraseCharacter, REQUEST_CURSOR_POSITION, REQUEST_EXTENDED_CURSOR_POSITION, RESTORE_CURSOR_DEC, // Constant for ESC 8
+SAVE_CURSOR_DEC, // Constant for ESC 7
+setCursorStyle, } from "./cursor.d.ts";
+export type { EraseDisplayMode, EraseLineMode } from "./erase.d.ts";
+export { eraseDisplay, eraseDown, eraseInLine, eraseLine, eraseLineEnd, eraseLines, eraseLineStart, eraseScreen, eraseScreenAndScrollback, eraseUp, } from "./erase.d.ts";
+export { default as hyperlink } from "./hyperlink.d.ts";
+export type { ImageOptions } from "./image.d.ts";
+export { image } from "./image.d.ts";
+export type { IITerm2Payload, ITerm2FileProperties } from "./iterm2.d.ts";
+export { IT2_AUTO, it2Cells, it2Percent, it2Pixels, iTerm2, ITerm2File, ITerm2FileEnd, ITerm2FilePart, ITerm2MultipartFileStart, } from "./iterm2.d.ts";
+export type { AnsiMode, DecMode, Mode, ModeSetting, } from "./mode.d.ts";
+export { 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, } from "./mode.d.ts";
+export type { MouseButtonType, MouseModifiers } from "./mouse.d.ts";
+export { disableAnyEventMouse, disableButtonEventMouse, disableFocusTracking, disableNormalMouse, disableSgrMouse, disableX10Mouse, enableAnyEventMouse, enableButtonEventMouse, enableFocusTracking, enableNormalMouse, enableSgrMouse, enableX10Mouse, encodeMouseButtonByte, MouseButton, mouseSgrSequence, mouseX10Sequence, } from "./mouse.d.ts";
+export { SCREEN_MAX_LEN_DEFAULT, SCREEN_TYPICAL_LIMIT, screenPassthrough, tmuxPassthrough, } from "./passthrough.d.ts";
+export { RESET_INITIAL_STATE, RIS, } from "./reset.d.ts";
+export { clearTabStop, deleteCharacter, deleteLine, insertCharacter, insertLine, repeatPreviousCharacter, requestPresentationStateReport, setLeftRightMargins, setTopBottomMargins, } from "./screen.d.ts";
+export { SCROLL_DOWN_1, SCROLL_UP_1, scrollDown, scrollUp, } from "./scroll.d.ts";
+export type { AnsiStatusReport, DecStatusReport, StatusReport } from "./status.d.ts";
+export { 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, } from "./status.d.ts";
+export { default as strip } from "./strip.d.ts";
+export { requestTermcap, requestTerminfo, XTGETTCAP, } from "./termcap.d.ts";
+export { decsin, decswt, setIconName, setIconNameAndWindowTitle, setIconNameAndWindowTitleWithST, setIconNameWithST, setWindowTitle, setWindowTitleWithST, } from "./title.d.ts";
+export type { XTermWindowOp } from "./window-ops.d.ts";
+export { deiconifyWindow, iconifyWindow, lowerWindow, maximizeWindow, moveWindow, raiseWindow, refreshWindow, reportWindowPosition, reportWindowState, requestCellSizePixels, requestTextAreaSizeChars, requestTextAreaSizePixels, resizeTextAreaChars, resizeTextAreaPixels, restoreMaximizedWindow, setPageSizeLines, xtermWindowOp, XTWINOPS, } from "./window-ops.d.ts";
+export { keyModifierOptions, queryKeyModifierOptions, queryModifyOtherKeys, resetKeyModifierOptions, resetModifyOtherKeys, setKeyModifierOptions, setModifyOtherKeys1, setModifyOtherKeys2, XTMODKEYS, XTQMODKEYS, } from "./xterm.d.ts";

package/dist/index.mjs

@@ -1,11 +1,24 @@
-export { alternativeScreenEnter, alternativeScreenExit } from './alternative-screen.mjs';
-export { clearLine, clearScreen, clearScrollbar, clearTerminal, fullReset } from './clear.mjs';
-export { c as cursorBackward, a as cursorDown, b as cursorForward, d as cursorHide, e as cursorLeft, f as cursorMove, g as cursorNextLine, h as cursorPreviousLine, i as cursorRestore, j as cursorSave, k as cursorShow, l as cursorTo, m as cursorUp } from './packem_shared/cursor-CDCWqbC9.mjs';
-export { eraseDown, eraseLine, eraseLineEnd, eraseLineStart, eraseLines, eraseScreen, eraseUp } from './erase.mjs';
-export { default as image } from './image.mjs';
-export { default as link } from './link.mjs';
-export { scrollDown, scrollUp } from './scroll.mjs';
+export { ALT_SCREEN_OFF, ALT_SCREEN_ON, alternativeScreenOff, alternativeScreenOn } from './alternative-screen.mjs';
+export { clearLineAndHomeCursor, clearScreenAndHomeCursor, clearScreenFromTopLeft, resetTerminal } from './clear.mjs';
+export { C as CURSOR_BACKWARD_1, a as CURSOR_DOWN_1, b as CURSOR_FORWARD_1, c as CURSOR_UP_1, R as REQUEST_CURSOR_POSITION, x as REQUEST_EXTENDED_CURSOR_POSITION, y as RESTORE_CURSOR_DEC, S as SAVE_CURSOR_DEC, d as cursorBackward, e as cursorBackwardTab, f as cursorDown, g as cursorForward, h as cursorHide, i as cursorHorizontalAbsolute, j as cursorHorizontalForwardTab, k as cursorLeft, l as cursorMove, m as cursorNextLine, n as cursorPosition, o as cursorPreviousLine, p as cursorRestore, q as cursorSave, r as cursorShow, s as cursorTo, t as cursorToColumn1, u as cursorUp, v as cursorVerticalAbsolute, w as eraseCharacter, z as setCursorStyle } from './packem_shared/cursor-DhFQcQ9g.mjs';
+export { eraseDisplay, eraseDown, eraseInLine, eraseLine, eraseLineEnd, eraseLineStart, eraseLines, eraseScreen, eraseScreenAndScrollback, eraseUp } from './erase.mjs';
+export { default as hyperlink } from './hyperlink.mjs';
+export { image } from './image.mjs';
+export { iTerm2 } from './iterm2.mjs';
+export { BDSM, BiDirectionalSupportMode, DECRPM, DECRQM, IRM, InsertReplaceMode, KAM, KeyboardActionMode, LNM, LineFeedNewLineMode, LocalEchoMode, RM, RequestBiDirectionalSupportMode, RequestInsertReplaceMode, RequestKeyboardActionMode, RequestLineFeedNewLineMode, RequestLocalEchoMode, RequestSendReceiveMode, ResetBiDirectionalSupportMode, ResetInsertReplaceMode, ResetKeyboardActionMode, ResetLineFeedNewLineMode, ResetLocalEchoMode, ResetSendReceiveMode, SM, SRM, SendReceiveMode, SetBiDirectionalSupportMode, SetInsertReplaceMode, SetKeyboardActionMode, SetLineFeedNewLineMode, SetLocalEchoMode, SetSendReceiveMode, createAnsiMode, createDecMode, isModeNotRecognized, isModePermanentlyReset, isModePermanentlySet, isModeReset, isModeSet, reportMode, requestMode, resetMode, setMode } from './mode.mjs';
+export { MouseButton, disableAnyEventMouse, disableButtonEventMouse, disableFocusTracking, disableNormalMouse, disableSgrMouse, disableX10Mouse, enableAnyEventMouse, enableButtonEventMouse, enableFocusTracking, enableNormalMouse, enableSgrMouse, enableX10Mouse, encodeMouseButtonByte, mouseSgrSequence, mouseX10Sequence } from './mouse.mjs';
+export { SCREEN_MAX_LEN_DEFAULT, SCREEN_TYPICAL_LIMIT, screenPassthrough, tmuxPassthrough } from './passthrough.mjs';
+export { RESET_INITIAL_STATE, RIS } from './reset.mjs';
+export { clearTabStop, deleteCharacter, deleteLine, insertCharacter, insertLine, repeatPreviousCharacter, requestPresentationStateReport, setLeftRightMargins, setTopBottomMargins } from './screen.mjs';
+export { SCROLL_DOWN_1, SCROLL_UP_1, scrollDown, scrollUp } from './scroll.mjs';
+export { CPR, DA1, DA2, DA3, DECXCPR, DSR, DSR_KeyboardLanguageDEC, DSR_PrinterStatusDEC, DSR_TerminalStatus, DSR_UDKStatusDEC, RequestNameVersion, XTVERSION, createAnsiStatusReport, createDecStatusReport, cursorPositionReport, deviceStatusReport, extendedCursorPositionReport, reportKeyboardLanguageDEC, reportPrimaryDeviceAttributes, reportPrinterNoPaperDEC, reportPrinterNotReadyDEC, reportPrinterReadyDEC, reportSecondaryDeviceAttributes, reportTerminalNotOK, reportTerminalOK, reportTertiaryDeviceAttributes, reportUDKLockedDEC, reportUDKUnlockedDEC, requestCursorPositionReport, requestExtendedCursorPositionReport, requestKeyboardLanguageDEC, requestPrimaryDeviceAttributes, requestPrimaryDeviceAttributesParam0, requestPrinterStatusDEC, requestSecondaryDeviceAttributes, requestSecondaryDeviceAttributesParam0, requestTerminalStatus, requestTertiaryDeviceAttributes, requestTertiaryDeviceAttributesParam0, requestUDKStatusDEC } from './status.mjs';
 export { default as strip } from './strip.mjs';
+export { XTGETTCAP, requestTermcap, requestTerminfo } from './termcap.mjs';
+export { decsin, decswt, setIconName, setIconNameAndWindowTitle, setIconNameAndWindowTitleWithST, setIconNameWithST, setWindowTitle, setWindowTitleWithST } from './title.mjs';
+export { XTWINOPS, deiconifyWindow, iconifyWindow, lowerWindow, maximizeWindow, moveWindow, raiseWindow, refreshWindow, reportWindowPosition, reportWindowState, requestCellSizePixels, requestTextAreaSizeChars, requestTextAreaSizePixels, resizeTextAreaChars, resizeTextAreaPixels, restoreMaximizedWindow, setPageSizeLines, xtermWindowOp } from './window-ops.mjs';
+export { XTMODKEYS, XTQMODKEYS, keyModifierOptions, queryKeyModifierOptions, queryModifyOtherKeys, resetKeyModifierOptions, resetModifyOtherKeys, setKeyModifierOptions, setModifyOtherKeys1, setModifyOtherKeys2 } from './xterm.mjs';
+export { IT2_AUTO, it2Cells, it2Percent, it2Pixels } from './packem_shared/IT2_AUTO-DnfCUXso.mjs';
+export { ITerm2File, ITerm2FileEnd, ITerm2FilePart, ITerm2MultipartFileStart } from './packem_shared/ITerm2File-DKFkdqdA.mjs';
 
 const beep = "\x07";
 

package/dist/iterm2/iterm2-properties.d.cts

@@ -0,0 +1,135 @@
+import type { LiteralUnion } from "type-fest";
+/**
+ * Represents the special string value `'auto'` used for iTerm2 image or file dimensions.
+ * When `'auto'` is used for width or height, the terminal (iTerm2) determines the appropriate dimension
+ * based on the image's inherent size or other context.
+ * @example `width: IT2_AUTO`
+ */
+export declare const IT2_AUTO: string;
+/**
+ * Formats a number as a string representing a dimension in character cells for iTerm2.
+ * iTerm2 interprets plain numbers for width/height as character cell counts.
+ * @param n The number of character cells.
+ * @returns A string representation of the number (e.g., `10` becomes `"10"`).
+ * @example
+ * ```typescript
+ * const widthInCells = it2Cells(20); // "20"
+ * const sequence = `File=width=${widthInCells}`;
+ * ```
+ */
+export declare const it2Cells: (n: number) => string;
+/**
+ * Formats a number as a string representing a dimension in pixels for iTerm2.
+ * Appends `px` to the number.
+ * @param n The number of pixels.
+ * @returns A string representing the dimension in pixels (e.g., `100` becomes `"100px"`).
+ * @example
+ * ```typescript
+ * const heightInPixels = it2Pixels(150);
+ * const sequence = `File=height=${heightInPixels}`;
+ * ```
+ */
+export declare const it2Pixels: (n: number) => string;
+/**
+ * Formats a number as a string representing a dimension as a percentage for iTerm2.
+ * Appends `%` to the number.
+ * @param n The percentage value (e.g., `50` for 50%).
+ * @returns A string representing the dimension as a percentage (e.g., `50` becomes `"50%"`).
+ * @example
+ * ```typescript
+ * const widthAsPercentage = it2Percent(75);
+ * const sequence = `File=width=${widthAsPercentage}`;
+ * ```
+ */
+export declare const it2Percent: (n: number) => string;
+/**
+ * Defines the interface for any iTerm2 OSC 1337 payload object.
+ *
+ * An OSC 1337 sequence has the general form: `OSC 1337 ; <payload_string> BEL`.
+ * Objects implementing this interface are responsible for generating that `<payload_string>`
+ * via their `toString()` method. This allows for a structured way to build various iTerm2 commands.
+ * @see {@link iTerm2} function which consumes objects of this type.
+ */
+export interface IITerm2Payload {
+    /**
+     * Converts the payload object into its specific string representation required for an iTerm2 OSC 1337 command.
+     * For example, for a file transfer, this might return `"File=name=...;size=...:content..."`.
+     * @returns The string payload part of the OSC 1337 sequence.
+     */
+    toString: () => string;
+}
+/**
+ * Defines the properties for an iTerm2 file transfer or inline image display command (`File=...`).
+ * These correspond to the key-value pairs used within the `File=` argument of the OSC 1337 sequence.
+ * @see {@link https://iterm2.com/documentation-escape-codes.html} iTerm2 Escape Codes (search for `File=`)
+ * @see {@link https://iterm2.com/documentation-images.html} iTerm2 Inline Images Protocol
+ */
+export interface ITerm2FileProperties {
+    /**
+     * The Base64 encoded content of the file or image.
+     * This is typically used when `inline=1` is set for images, or for transferring small files directly
+     * within the escape sequence. For larger files, multipart transfer is recommended.
+     * @remarks The `ITerm2File` class can handle the Base64 encoding of `Uint8Array` data automatically.
+     */
+    content?: string;
+    /**
+     * If `true`, instructs the terminal not to move the cursor after displaying an inline image.
+     * Corresponds to `doNotMoveCursor=1` in the sequence.
+     * This is a WezTerm extension, also supported by iTerm2 beta/nightly builds as of some versions.
+     * @default false (cursor behavior is default terminal behavior)
+     */
+    doNotMoveCursor?: boolean;
+    /**
+     * The display height of the image or file placeholder.
+     * Can be:
+     * - A number (interpreted as character cells, e.g., `10`).
+     * - A string with units: `"Npx"` (N pixels), `"N%"` (N percent of session height).
+     * - The string {@link IT2_AUTO} (`"auto"`) for automatic sizing.
+     * Use helper functions like {@link it2Cells}, {@link it2Pixels}, {@link it2Percent} for formatting if needed.
+     * @example `10`, `"100px"`, `"50%"`, `IT2_AUTO`
+     */
+    height?: LiteralUnion<typeof IT2_AUTO, number | string>;
+    /**
+     * Controls aspect ratio preservation for inline images.
+     * - If `true` (or omitted), the aspect ratio *is* preserved (`preserveAspectRatio=1`, which is the default iTerm2 behavior if the param is absent).
+     * - If `false`, the aspect ratio is *not* preserved, and the image may stretch (`preserveAspectRatio=0`).
+     * @remarks Note the slight inversion: this property `ignoreAspectRatio: true` means `preserveAspectRatio=0` in the sequence.
+     * The default iTerm2 behavior *is* to preserve aspect ratio if the `preserveAspectRatio` parameter is not given.
+     * So, to *not* preserve, you set this to true to *add* `preserveAspectRatio=0`.
+     * If you want to preserve (default), you can omit this or set it to `false`.
+     * @default false (meaning aspect ratio is preserved by iTerm2 default unless overridden)
+     */
+    ignoreAspectRatio?: boolean;
+    /**
+     * If `true`, the file (typically an image) should be displayed inline in the terminal.
+     * Corresponds to `inline=1` in the sequence.
+     * If `false` or omitted, iTerm2 might prompt for download or handle based on file type.
+     * @default false
+     */
+    inline?: boolean;
+    /**
+     * The name of the file. This is displayed in UI elements (like a download prompt or image info)
+     * and used as the default filename if downloaded.
+     * The name **must be Base64 encoded** if it contains special characters (like `;`, `=`, or non-ASCII characters)
+     * to ensure correct parsing of the escape sequence by iTerm2.
+     * The `ITerm2File` and `ITerm2MultipartFileStart` classes generally expect the name to be pre-encoded if necessary.
+     * @example `"bXlmaWxlLnR4dA=="` (Base64 for "myfile.txt")
+     */
+    name?: string;
+    /**
+     * The size of the file in bytes. This is used by iTerm2 for progress indication during downloads
+     * or to inform inline display mechanisms.
+     * JavaScript `number` type is generally sufficient for typical file sizes (up to `Number.MAX_SAFE_INTEGER`).
+     */
+    size?: number;
+    /**
+     * The display width of the image or file placeholder.
+     * Can be:
+     * - A number (interpreted as character cells, e.g., `20`).
+     * - A string with units: `"Npx"` (N pixels), `"N%"` (N percent of session width).
+     * - The string {@link IT2_AUTO} (`"auto"`) for automatic sizing.
+     * Use helper functions like {@link it2Cells}, {@link it2Pixels}, {@link it2Percent} for formatting if needed.
+     * @example `20`, `"200px"`, `"75%"`, `IT2_AUTO`
+     */
+    width?: LiteralUnion<typeof IT2_AUTO, number | string>;
+}