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

package/dist/erase.d.ts

@@ -0,0 +1,206 @@
+/**
+ * Defines the modes for erasing parts of the display using the ED (Erase in Display) sequence.
+ * The ED sequence is `CSI Ps J`, where `Ps` is one of these mode values.
+ * @see {@link eraseDisplay} for the function that generates ED sequences.
+ * @see {@link https://vt100.net/docs/vt510-rm/ED.html} VT510 Erase in Display (ED) documentation.
+ * @enum {number}
+ */
+export declare enum EraseDisplayMode {
+    /**
+     * Clears the entire screen. The cursor position usually does not change, but this can be
+     * terminal-dependent. Some terminals might move the cursor to the home position (top-left).
+     * This corresponds to `Ps=2` in `CSI Ps J`.
+     * Sequence: `CSI 2J`.
+     */
+    EntireScreen = 2,
+    /**
+     * Clears the entire screen and, on supported terminals (like XTerm and derivatives),
+     * also deletes all lines saved in the scrollback buffer.
+     * This corresponds to `Ps=3` in `CSI Ps J` (an XTerm extension, widely adopted).
+     * Sequence: `CSI 3J`.
+     * @remarks This mode is particularly useful for a more complete "reset" of the terminal view.
+     */
+    EntireScreenAndScrollback = 3,
+    /**
+     * Clears from the beginning of the screen to the current cursor position (inclusive).
+     * This corresponds to `Ps=1` in `CSI Ps J`.
+     * Sequence: `CSI 1J`.
+     */
+    ToBeginning = 1,
+    /**
+     * Clears from the current cursor position to the end of the screen (inclusive).
+     * If the cursor is at the top-left, this clears the entire screen.
+     * This corresponds to `Ps=0` (or `Ps` omitted) in `CSI Ps J`.
+     * Sequence: `CSI J` or `CSI 0J`.
+     */
+    ToEnd = 0
+}
+/**
+ * Generates an ANSI escape sequence to erase parts of the display (ED - Erase in Display).
+ * The specific sequence is `CSI <mode>J`, where `<mode>` is a parameter from {@link EraseDisplayMode}.
+ *
+ * - If `mode` is `EraseDisplayMode.ToEnd` (or `0`), the sequence can be shortened to `CSI J`.
+ * - The function validates the input `mode`. If an invalid number is provided, it defaults to `EraseDisplayMode.ToEnd`.
+ * @param mode The erase mode, specified as a value from `EraseDisplayMode` or its corresponding number (0, 1, 2, 3).
+ * @returns The ANSI escape sequence string for erasing in display.
+ * @example
+ * ```typescript
+ * import { eraseDisplay, EraseDisplayMode } from '@visulima/ansi/erase';
+ *
+ * // Erase from cursor to end of screen
+ * process.stdout.write(eraseDisplay(EraseDisplayMode.ToEnd)); // or eraseDisplay(0)
+ *
+ * // Erase entire screen
+ * process.stdout.write(eraseDisplay(EraseDisplayMode.EntireScreen)); // or eraseDisplay(2)
+ *
+ * // Erase entire screen and scrollback buffer
+ * process.stdout.write(eraseDisplay(EraseDisplayMode.EntireScreenAndScrollback)); // or eraseDisplay(3)
+ * ```
+ * @see {@link EraseDisplayMode}
+ * @see {@link https://vt100.net/docs/vt510-rm/ED.html} VT510 Erase in Display (ED) documentation.
+ */
+export declare const eraseDisplay: (mode: EraseDisplayMode | 0 | 1 | 2 | 3) => string;
+/**
+ * Defines the modes for erasing parts of the current line using the EL (Erase in Line) sequence.
+ * The EL sequence is `CSI Ps K`, where `Ps` is one of these mode values.
+ * The cursor position is NOT affected by EL sequences.
+ * @see {@link eraseInLine} for the function that generates EL sequences.
+ * @see {@link https://vt100.net/docs/vt510-rm/EL.html} VT510 Erase in Line (EL) documentation.
+ * @enum {number}
+ */
+export declare enum EraseLineMode {
+    /**
+     * Clears the entire current line.
+     * This corresponds to `Ps=2` in `CSI Ps K`.
+     * Sequence: `CSI 2K`.
+     */
+    EntireLine = 2,
+    /**
+     * Clears from the beginning of the line to the current cursor position (inclusive).
+     * This corresponds to `Ps=1` in `CSI Ps K`.
+     * Sequence: `CSI 1K`.
+     */
+    ToBeginning = 1,
+    /**
+     * Clears from the current cursor position to the end of the line (inclusive).
+     * This corresponds to `Ps=0` (or `Ps` omitted) in `CSI Ps K`.
+     * Sequence: `CSI K` or `CSI 0K`.
+     */
+    ToEnd = 0
+}
+/**
+ * Generates an ANSI escape sequence to erase parts of the current line (EL - Erase in Line).
+ * The specific sequence is `CSI <mode>K`, where `<mode>` is a parameter from {@link EraseLineMode}.
+ * The cursor position is NOT changed by this sequence.
+ *
+ * - If `mode` is `EraseLineMode.ToEnd` (or `0`), the sequence can be shortened to `CSI K`.
+ * - The function validates the input `mode`. If an invalid number is provided, it defaults to `EraseLineMode.ToEnd`.
+ * @param mode The erase mode, specified as a value from `EraseLineMode` or its corresponding number (0, 1, 2).
+ * @returns The ANSI escape sequence string for erasing in line.
+ * @example
+ * ```typescript
+ * import { eraseInLine, EraseLineMode } from '@visulima/ansi/erase';
+ *
+ * // Erase from cursor to end of line
+ * process.stdout.write(eraseInLine(EraseLineMode.ToEnd)); // or eraseInLine(0)
+ *
+ * // Erase entire current line
+ * process.stdout.write(eraseInLine(EraseLineMode.EntireLine)); // or eraseInLine(2)
+ * ```
+ * @see {@link EraseLineMode}
+ * @see {@link https://vt100.net/docs/vt510-rm/EL.html} VT510 Erase in Line (EL) documentation.
+ */
+export declare const eraseInLine: (mode: EraseLineMode | 0 | 1 | 2) => string;
+/**
+ * Erases the screen from the current cursor position down to the bottom of the screen (inclusive).
+ * This is a convenience constant for `eraseDisplay(EraseDisplayMode.ToEnd)`.
+ * Sequence: `CSI J` (or `CSI 0J`).
+ * @returns The ANSI escape sequence `CSI J`.
+ * @see {@link eraseDisplay}
+ * @see {@link EraseDisplayMode.ToEnd}
+ */
+export declare const eraseDown: string;
+/**
+ * Erases the entire current line. The cursor position does not change.
+ * This is a convenience constant for `eraseInLine(EraseLineMode.EntireLine)`.
+ * Sequence: `CSI 2K`.
+ * @returns The ANSI escape sequence `CSI 2K`.
+ * @see {@link eraseInLine}
+ * @see {@link EraseLineMode.EntireLine}
+ */
+export declare const eraseLine: string;
+/**
+ * Erases from the current cursor position to the end of the current line (inclusive).
+ * The cursor position does not change.
+ * This is a convenience constant for `eraseInLine(EraseLineMode.ToEnd)`.
+ * Sequence: `CSI K` (or `CSI 0K`).
+ * @returns The ANSI escape sequence `CSI K`.
+ * @see {@link eraseInLine}
+ * @see {@link EraseLineMode.ToEnd}
+ */
+export declare const eraseLineEnd: string;
+/**
+ * Erases from the current cursor position to the beginning of the current line (inclusive).
+ * The cursor position does not change.
+ * This is a convenience constant for `eraseInLine(EraseLineMode.ToBeginning)`.
+ * Sequence: `CSI 1K`.
+ * @returns The ANSI escape sequence `CSI 1K`.
+ * @see {@link eraseInLine}
+ * @see {@link EraseLineMode.ToBeginning}
+ */
+export declare const eraseLineStart: string;
+/**
+ * Erases a specified number of lines, starting from the current line and moving upwards,
+ * then moves the cursor to the beginning of the topmost erased line (which becomes the new current line).
+ *
+ * This is a custom helper function, not a single standard ANSI/VT sequence. It combines
+ * multiple sequences: {@link eraseLine} to clear each line, {@link cursorUp} to move to the line above,
+ * and finally {@link cursorToColumn1} to position the cursor at the start of the resulting current line.
+ * @param count The total number of lines to erase. This includes the current line and `count-1` lines above it.
+ * If `count` is 0 or negative, an empty string is returned (no operation).
+ * @returns A string of concatenated ANSI escape sequences to perform the operation.
+ * @example
+ * ```typescript
+ * import { eraseLines } from '@visulima/ansi/erase';
+ *
+ * // To erase the current line and the 2 lines above it (total 3 lines):
+ * process.stdout.write(eraseLines(3));
+ * // Conceptual sequence of operations:
+ * // 1. Erase current line
+ * // 2. Cursor up
+ * // 3. Erase current line (which was the line above the original)
+ * // 4. Cursor up
+ * // 5. Erase current line (which was two lines above the original)
+ * // 6. Cursor to column 1 (on this topmost erased line)
+ * ```
+ */
+export declare const eraseLines: (count: number) => string;
+/**
+ * Erases the entire screen. The cursor position usually does not change, though this can be terminal-dependent.
+ * This is a convenience constant for `eraseDisplay(EraseDisplayMode.EntireScreen)`.
+ * Sequence: `CSI 2J`.
+ * @returns The ANSI escape sequence `CSI 2J`.
+ * @see {@link eraseDisplay}
+ * @see {@link EraseDisplayMode.EntireScreen}
+ */
+export declare const eraseScreen: string;
+/**
+ * Erases the screen from the current cursor position up to the top of the screen (inclusive).
+ * This is a convenience constant for `eraseDisplay(EraseDisplayMode.ToBeginning)`.
+ * Sequence: `CSI 1J`.
+ * @returns The ANSI escape sequence `CSI 1J`.
+ * @see {@link eraseDisplay}
+ * @see {@link EraseDisplayMode.ToBeginning}
+ */
+export declare const eraseUp: string;
+/**
+ * Erases the entire screen and, on supported terminals (like XTerm and derivatives),
+ * also deletes all lines saved in the scrollback buffer.
+ * This is a convenience constant for `eraseDisplay(EraseDisplayMode.EntireScreenAndScrollback)`.
+ * Sequence: `CSI 3J` (an XTerm extension, widely adopted).
+ * @returns The ANSI escape sequence `CSI 3J`.
+ * @remarks This mode is particularly useful for a more complete "reset" of the terminal view.
+ * @see {@link eraseDisplay}
+ * @see {@link EraseDisplayMode.EntireScreenAndScrollback}
+ */
+export declare const eraseScreenAndScrollback: string;

package/dist/erase.js

@@ -0,0 +1 @@
+var t=Object.defineProperty;var s=(e,n)=>t(e,"name",{value:n,configurable:!0});import{C as c}from"./packem_shared/constants-D12jy2Zh.js";import{u as l,t as E}from"./packem_shared/cursor-nxpKt8Tn.js";var S=Object.defineProperty,a=s((e,n)=>S(e,"name",{value:n,configurable:!0}),"o"),d=(e=>(e[e.EntireScreen=2]="EntireScreen",e[e.EntireScreenAndScrollback=3]="EntireScreenAndScrollback",e[e.ToBeginning=1]="ToBeginning",e[e.ToEnd=0]="ToEnd",e))(d||{});const r=a(e=>{const n=e>=0&&e<=3?e:0;return`${c+(n===0?"":String(n))}J`},"eraseDisplay");var g=(e=>(e[e.EntireLine=2]="EntireLine",e[e.ToBeginning=1]="ToBeginning",e[e.ToEnd=0]="ToEnd",e))(g||{});const o=a(e=>{const n=e>=0&&e<=2?e:0;return`${c+(n===0?"":String(n))}K`},"eraseInLine"),f=r(0),u=o(2),m=o(0),b=o(1),v=a(e=>{if(e<=0)return"";let n="";for(let i=0;i<e;i+=1)n+=u,i<e-1&&(n+=l());return n+=E,n},"eraseLines"),y=r(2),B=r(1),D=r(3);export{d as EraseDisplayMode,g as EraseLineMode,r as eraseDisplay,f as eraseDown,o as eraseInLine,u as eraseLine,m as eraseLineEnd,b as eraseLineStart,v as eraseLines,y as eraseScreen,D as eraseScreenAndScrollback,B as eraseUp};

package/dist/helpers.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Checks if the current environment is a browser-like environment.
+ * It specifically checks for the presence of `globalThis.window.document`.
+ */
+/**
+ * Indicates whether the code is running inside Apple's Terminal.app.
+ * This is true if not in a browser and the `TERM_PROGRAM` environment variable is "Apple_Terminal".
+ */
+export declare const isTerminalApp: boolean;
+/**
+ * Indicates whether the current platform is Windows.
+ * This is true if not in a browser and `process.platform` is "win32".
+ */
+export declare const isWindows: boolean;

package/dist/hyperlink.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Creates a clickable hyperlink in the terminal.
+ *
+ * This function constructs an ANSI escape sequence that, when printed to a compatible terminal,
+ * renders as a clickable link. The link's visible text and its target URL are specified
+ * by the `text` and `url` parameters, respectively.
+ *
+ * For information on terminal support for hyperlinks, see this
+ * [Gist by Egmont Kob](https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda).
+ * To programmatically check for hyperlink support in the current environment,
+ * consider using a library like [`supports-hyperlinks`](https://github.com/jamestalmage/supports-hyperlinks).
+ * @param text The visible text of the link.
+ * @param url The URL the link should point to.
+ * @returns A string representing the ANSI escape sequence for the hyperlink.
+ * @example
+ * ```typescript
+ * import { hyperlink } from "@visulima/ansi/hyperlink"; // Adjust import path as needed
+ *
+ * const aLink = hyperlink("Visulima", "https://www.visulima.com");
+ * console.log(`Visit ${aLink} for more information.`);
+ * // In a supported terminal, this will output:
+ * // Visit Visulima for more information. (where "Visulima" is a clickable link)
+ * ```
+ * @see {@link https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda} for supported terminals.
+ */
+declare const hyperlink: (text: string, url: string) => string;
+export default hyperlink;

package/dist/hyperlink.js

@@ -0,0 +1 @@
+var i=Object.defineProperty;var n=(e,a)=>i(e,"name",{value:a,configurable:!0});import{O as o,S as r,B as t}from"./packem_shared/constants-D12jy2Zh.js";var s=Object.defineProperty,f=n((e,a)=>s(e,"name",{value:a,configurable:!0}),"n");const u=f((e,a)=>[o,"8",r,r,a,t,e,o,"8",r,r,t].join(""),"hyperlink");export{u as default};

package/dist/image.d.ts

@@ -0,0 +1,73 @@
+import type { LiteralUnion } from "type-fest";
+/**
+ * Options for controlling the display of an inline image in iTerm2.
+ */
+export interface ImageOptions {
+    /**
+     * The display height of the image. It can be specified as:
+     * - A number: Interpreted as the number of character cells (e.g., `10`).
+     * - A string with `px`: Interpreted as pixels (e.g., `"100px"`).
+     * - A string with `%`: Interpreted as a percentage of the terminal session's height (e.g., `"50%"`).
+     * - The string `"auto"`: The image's inherent height will be used, or the terminal will decide.
+     */
+    readonly height?: LiteralUnion<"auto", number | string>;
+    /**
+     * Controls whether the image's aspect ratio is preserved when scaling.
+     * - If `true` (default), the aspect ratio is preserved.
+     * - If `false`, the image may be stretched to fit the specified width and height.
+     * Corresponds to the `preserveAspectRatio` argument in the iTerm2 sequence (`1` for true, `0` for false).
+     * @default true
+     */
+    readonly preserveAspectRatio?: boolean;
+    /**
+     * The display width of the image. It can be specified as:
+     * - A number: Interpreted as the number of character cells (e.g., `20`).
+     * - A string with `px`: Interpreted as pixels (e.g., `"200px"`).
+     * - A string with `%`: Interpreted as a percentage of the terminal session's width (e.g., `"75%"`).
+     * - The string `"auto"`: The image's inherent width will be used, or the terminal will decide.
+     */
+    readonly width?: LiteralUnion<"auto", number | string>;
+}
+/**
+ * Generates an ANSI escape sequence for displaying an image inline, primarily for iTerm2.
+ *
+ * This function constructs a proprietary iTerm2 escape sequence (`OSC 1337 ; File = [arguments] : &lt;base64_data> BEL`)
+ * that allows raw image data to be displayed directly in the terminal.
+ * @param data The raw image data as a `Uint8Array`. This data will be Base64 encoded.
+ * @param options Optional parameters to control how the image is displayed (e.g., width, height, aspect ratio).
+ * See {@link ImageOptions}.
+ * @returns A string containing the ANSI escape sequence for displaying the image in iTerm2.
+ * Returns an empty string if `data` is null or undefined, though TypeScript should prevent this.
+ * @example
+ * ```typescript
+ * import { image } from '@visulima/ansi/image'; // Adjust import path
+ * import { promises as fs } from 'fs';
+ *
+ * async function displayImage() {
+ *   try {
+ *     const imageData = await fs.readFile('path/to/your/image.png');
+ *     const imageSequence = image(new Uint8Array(imageData), {
+ *       width: 50, // 50 character cells wide
+ *       height: "auto",
+ *       preserveAspectRatio: true,
+ *     });
+ *     console.log(imageSequence);
+ *   } catch (error) {
+ *     console.error("Error reading or displaying image:", error);
+ *   }
+ * }
+ *
+ * displayImage();
+ * ```
+ * @remarks
+ * - This sequence is specific to iTerm2 and may not work in other terminal emulators.
+ * - For Node.js environments, `Buffer.from(data).toString("base64")` is used for Base64 encoding.
+ * In browser environments, a polyfill or an alternative method for Base64 encoding `Uint8Array` would be necessary
+ * if `Buffer` is not available (e.g., `btoa(String.fromCharCode(...data))` after careful handling of binary data).
+ * - The `name` parameter (for filename) is not directly supported by this simplified helper but is part of the
+ * full iTerm2 inline image protocol. For more advanced features, consider using the more detailed iTerm2 sequence
+ * builders in `iterm2/` files.
+ * @see {@link https://iterm2.com/documentation-images.html} iTerm2 Inline Images Protocol.
+ * @see {@link ImageOptions}
+ */
+export declare const image: (data: Uint8Array, options?: ImageOptions) => string;

package/dist/image.js

@@ -0,0 +1 @@
+var n=Object.defineProperty;var o=(r,e)=>n(r,"name",{value:e,configurable:!0});import{createRequire as a}from"node:module";import{O as l,B as p}from"./packem_shared/constants-D12jy2Zh.js";const c=a(import.meta.url),t=typeof globalThis<"u"&&typeof globalThis.process<"u"?globalThis.process:process,u=o(r=>{if(typeof t<"u"&&t.versions&&t.versions.node){const[e,i]=t.versions.node.split(".").map(Number);if(e>22||e===22&&i>=3||e===20&&i>=16)return t.getBuiltinModule(r)}return c(r)},"__cjs_getBuiltinModule"),{Buffer:f}=u("node:buffer");var d=Object.defineProperty,g=o((r,e)=>d(r,"name",{value:e,configurable:!0}),"i");const v=g((r,e={})=>{if(!r)return"";let i=`${l}1337;File=inline=1`;e.width!==void 0&&(i+=`;width=${e.width}`),e.height!==void 0&&(i+=`;height=${e.height}`),e.preserveAspectRatio===!1&&(i+=";preserveAspectRatio=0");const s=f.from(r).toString("base64");return`${i}:${s}${p}`},"image");export{v as image};

package/dist/index.d.ts

@@ -0,0 +1,36 @@
+/**
+ * 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, BracketedPasteMode, createAnsiMode, createDecMode, DECRPM, DECRQM, DisableModifiersMode, InBandResizeMode, InsertReplaceMode, IRM, isModeNotRecognized, isModePermanentlyReset, isModePermanentlySet, isModeReset, isModeSet, KAM, KeyboardActionMode, LightDarkMode, LineFeedNewLineMode, LNM, LocalEchoMode, OriginMode, reportMode, RequestBiDirectionalSupportMode, RequestInBandResizeMode, RequestInsertReplaceMode, RequestKeyboardActionMode, RequestLineFeedNewLineMode, RequestLocalEchoMode, requestMode, RequestSendReceiveMode, RequestUnicodeCoreMode, ResetBiDirectionalSupportMode, ResetInBandResizeMode, ResetInsertReplaceMode, ResetKeyboardActionMode, ResetLineFeedNewLineMode, ResetLocalEchoMode, resetMode, ResetSendReceiveMode, ResetUnicodeCoreMode, RM, SendFocusEventsMode, SendReceiveMode, SetBiDirectionalSupportMode, SetInBandResizeMode, SetInsertReplaceMode, SetKeyboardActionMode, SetLineFeedNewLineMode, SetLocalEchoMode, setMode, SetSendReceiveMode, SetUnicodeCoreMode, SGRMouseMode, SM, SRM, TextCursorEnableMode, UnicodeCoreMode, } 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 { resetProgressBar, setErrorProgressBar, setIndeterminateProgressBar, setProgressBar, setWarningProgressBar } from "./progress.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, LightDarkReport, reportKeyboardLanguageDEC, reportPrimaryDeviceAttributes, reportPrinterNoPaperDEC, reportPrinterNotReadyDEC, reportPrinterReadyDEC, reportSecondaryDeviceAttributes, reportTerminalNotOK, reportTerminalOK, reportTertiaryDeviceAttributes, reportUDKLockedDEC, reportUDKUnlockedDEC, requestCursorPositionReport, requestExtendedCursorPositionReport, requestKeyboardLanguageDEC, RequestLightDarkReport, 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.js

@@ -0,0 +1 @@
+import{ALT_SCREEN_OFF as t,ALT_SCREEN_ON as s,alternativeScreenOff as i,alternativeScreenOn as a}from"./alternative-screen.js";import{clearLineAndHomeCursor as d,clearScreenAndHomeCursor as u,clearScreenFromTopLeft as c,resetTerminal as S}from"./clear.js";import{C as M,a as l,b as p,c as m,R as D,x as T,y as E,S as C,d as P,e as A,f as L,g as f,h as y,i as x,j as O,k as b,l as _,m as q,n as I,o as N,p as g,q as w,r as h,s as v,t as U,u as B,v as K,w as W,z as F}from"./packem_shared/cursor-nxpKt8Tn.js";import{eraseDisplay as k,eraseDown as X,eraseInLine as H,eraseLine as Q,eraseLineEnd as V,eraseLineStart as Y,eraseLines as G,eraseScreen as j,eraseScreenAndScrollback as J,eraseUp as Z}from"./erase.js";import{default as ee}from"./hyperlink.js";import{image as oe}from"./image.js";import{iTerm2 as se}from"./iterm2.js";import{BDSM as ae,BiDirectionalSupportMode as ne,BracketedPasteMode as de,DECRPM as ue,DECRQM as ce,DisableModifiersMode as Se,IRM as Re,InBandResizeMode as Me,InsertReplaceMode as le,KAM as pe,KeyboardActionMode as me,LNM as De,LightDarkMode as Te,LineFeedNewLineMode as Ee,LocalEchoMode as Ce,OriginMode as Pe,RM as Ae,RequestBiDirectionalSupportMode as Le,RequestInBandResizeMode as fe,RequestInsertReplaceMode as ye,RequestKeyboardActionMode as xe,RequestLineFeedNewLineMode as Oe,RequestLocalEchoMode as be,RequestSendReceiveMode as _e,RequestUnicodeCoreMode as qe,ResetBiDirectionalSupportMode as Ie,ResetInBandResizeMode as Ne,ResetInsertReplaceMode as ge,ResetKeyboardActionMode as we,ResetLineFeedNewLineMode as he,ResetLocalEchoMode as ve,ResetSendReceiveMode as Ue,ResetUnicodeCoreMode as Be,SGRMouseMode as Ke,SM as We,SRM as Fe,SendFocusEventsMode as ze,SendReceiveMode as ke,SetBiDirectionalSupportMode as Xe,SetInBandResizeMode as He,SetInsertReplaceMode as Qe,SetKeyboardActionMode as Ve,SetLineFeedNewLineMode as Ye,SetLocalEchoMode as Ge,SetSendReceiveMode as je,SetUnicodeCoreMode as Je,TextCursorEnableMode as Ze,UnicodeCoreMode as $e,createAnsiMode as er,createDecMode as rr,isModeNotRecognized as or,isModePermanentlyReset as tr,isModePermanentlySet as sr,isModeReset as ir,isModeSet as ar,reportMode as nr,requestMode as dr,resetMode as ur,setMode as cr}from"./mode.js";import{MouseButton as Rr,disableAnyEventMouse as Mr,disableButtonEventMouse as lr,disableFocusTracking as pr,disableNormalMouse as mr,disableSgrMouse as Dr,disableX10Mouse as Tr,enableAnyEventMouse as Er,enableButtonEventMouse as Cr,enableFocusTracking as Pr,enableNormalMouse as Ar,enableSgrMouse as Lr,enableX10Mouse as fr,encodeMouseButtonByte as yr,mouseSgrSequence as xr,mouseX10Sequence as Or}from"./mouse.js";import{SCREEN_MAX_LEN_DEFAULT as _r,SCREEN_TYPICAL_LIMIT as qr,screenPassthrough as Ir,tmuxPassthrough as Nr}from"./passthrough.js";import{resetProgressBar as wr,setErrorProgressBar as hr,setIndeterminateProgressBar as vr,setProgressBar as Ur,setWarningProgressBar as Br}from"./packem_shared/resetProgressBar-BtBbpWCM.js";import{RESET_INITIAL_STATE as Wr,RIS as Fr}from"./reset.js";import{clearTabStop as kr,deleteCharacter as Xr,deleteLine as Hr,insertCharacter as Qr,insertLine as Vr,repeatPreviousCharacter as Yr,requestPresentationStateReport as Gr,setLeftRightMargins as jr,setTopBottomMargins as Jr}from"./screen.js";import{SCROLL_DOWN_1 as $r,SCROLL_UP_1 as eo,scrollDown as ro,scrollUp as oo}from"./scroll.js";import{CPR as so,DA1 as io,DA2 as ao,DA3 as no,DECXCPR as uo,DSR as co,DSR_KeyboardLanguageDEC as So,DSR_PrinterStatusDEC as Ro,DSR_TerminalStatus as Mo,DSR_UDKStatusDEC as lo,LightDarkReport as po,RequestLightDarkReport as mo,RequestNameVersion as Do,XTVERSION as To,createAnsiStatusReport as Eo,createDecStatusReport as Co,cursorPositionReport as Po,deviceStatusReport as Ao,extendedCursorPositionReport as Lo,reportKeyboardLanguageDEC as fo,reportPrimaryDeviceAttributes as yo,reportPrinterNoPaperDEC as xo,reportPrinterNotReadyDEC as Oo,reportPrinterReadyDEC as bo,reportSecondaryDeviceAttributes as _o,reportTerminalNotOK as qo,reportTerminalOK as Io,reportTertiaryDeviceAttributes as No,reportUDKLockedDEC as go,reportUDKUnlockedDEC as wo,requestCursorPositionReport as ho,requestExtendedCursorPositionReport as vo,requestKeyboardLanguageDEC as Uo,requestPrimaryDeviceAttributes as Bo,requestPrimaryDeviceAttributesParam0 as Ko,requestPrinterStatusDEC as Wo,requestSecondaryDeviceAttributes as Fo,requestSecondaryDeviceAttributesParam0 as zo,requestTerminalStatus as ko,requestTertiaryDeviceAttributes as Xo,requestTertiaryDeviceAttributesParam0 as Ho,requestUDKStatusDEC as Qo}from"./status.js";import{default as Yo}from"./strip.js";import{XTGETTCAP as jo,requestTermcap as Jo,requestTerminfo as Zo}from"./termcap.js";import{decsin as et,decswt as rt,setIconName as ot,setIconNameAndWindowTitle as tt,setIconNameAndWindowTitleWithST as st,setIconNameWithST as it,setWindowTitle as at,setWindowTitleWithST as nt}from"./title.js";import{XTWINOPS as ut,deiconifyWindow as ct,iconifyWindow as St,lowerWindow as Rt,maximizeWindow as Mt,moveWindow as lt,raiseWindow as pt,refreshWindow as mt,reportWindowPosition as Dt,reportWindowState as Tt,requestCellSizePixels as Et,requestTextAreaSizeChars as Ct,requestTextAreaSizePixels as Pt,resizeTextAreaChars as At,resizeTextAreaPixels as Lt,restoreMaximizedWindow as ft,setPageSizeLines as yt,xtermWindowOp as xt}from"./window-ops.js";import{XTMODKEYS as bt,XTQMODKEYS as _t,keyModifierOptions as qt,queryKeyModifierOptions as It,queryModifyOtherKeys as Nt,resetKeyModifierOptions as gt,resetModifyOtherKeys as wt,setKeyModifierOptions as ht,setModifyOtherKeys1 as vt,setModifyOtherKeys2 as Ut}from"./xterm.js";import{IT2_AUTO as Kt,it2Cells as Wt,it2Percent as Ft,it2Pixels as zt}from"./packem_shared/IT2_AUTO-BYrffRAq.js";import{ITerm2File as Xt,ITerm2FileEnd as Ht,ITerm2FilePart as Qt,ITerm2MultipartFileStart as Vt}from"./packem_shared/ITerm2File-C88DBJC-.js";const e="\x07";export{t as ALT_SCREEN_OFF,s as ALT_SCREEN_ON,ae as BDSM,ne as BiDirectionalSupportMode,de as BracketedPasteMode,so as CPR,M as CURSOR_BACKWARD_1,l as CURSOR_DOWN_1,p as CURSOR_FORWARD_1,m as CURSOR_UP_1,io as DA1,ao as DA2,no as DA3,ue as DECRPM,ce as DECRQM,uo as DECXCPR,co as DSR,So as DSR_KeyboardLanguageDEC,Ro as DSR_PrinterStatusDEC,Mo as DSR_TerminalStatus,lo as DSR_UDKStatusDEC,Se as DisableModifiersMode,Re as IRM,Kt as IT2_AUTO,Xt as ITerm2File,Ht as ITerm2FileEnd,Qt as ITerm2FilePart,Vt as ITerm2MultipartFileStart,Me as InBandResizeMode,le as InsertReplaceMode,pe as KAM,me as KeyboardActionMode,De as LNM,Te as LightDarkMode,po as LightDarkReport,Ee as LineFeedNewLineMode,Ce as LocalEchoMode,Rr as MouseButton,Pe as OriginMode,D as REQUEST_CURSOR_POSITION,T as REQUEST_EXTENDED_CURSOR_POSITION,Wr as RESET_INITIAL_STATE,E as RESTORE_CURSOR_DEC,Fr as RIS,Ae as RM,Le as RequestBiDirectionalSupportMode,fe as RequestInBandResizeMode,ye as RequestInsertReplaceMode,xe as RequestKeyboardActionMode,mo as RequestLightDarkReport,Oe as RequestLineFeedNewLineMode,be as RequestLocalEchoMode,Do as RequestNameVersion,_e as RequestSendReceiveMode,qe as RequestUnicodeCoreMode,Ie as ResetBiDirectionalSupportMode,Ne as ResetInBandResizeMode,ge as ResetInsertReplaceMode,we as ResetKeyboardActionMode,he as ResetLineFeedNewLineMode,ve as ResetLocalEchoMode,Ue as ResetSendReceiveMode,Be as ResetUnicodeCoreMode,C as SAVE_CURSOR_DEC,_r as SCREEN_MAX_LEN_DEFAULT,qr as SCREEN_TYPICAL_LIMIT,$r as SCROLL_DOWN_1,eo as SCROLL_UP_1,Ke as SGRMouseMode,We as SM,Fe as SRM,ze as SendFocusEventsMode,ke as SendReceiveMode,Xe as SetBiDirectionalSupportMode,He as SetInBandResizeMode,Qe as SetInsertReplaceMode,Ve as SetKeyboardActionMode,Ye as SetLineFeedNewLineMode,Ge as SetLocalEchoMode,je as SetSendReceiveMode,Je as SetUnicodeCoreMode,Ze as TextCursorEnableMode,$e as UnicodeCoreMode,jo as XTGETTCAP,bt as XTMODKEYS,_t as XTQMODKEYS,To as XTVERSION,ut as XTWINOPS,i as alternativeScreenOff,a as alternativeScreenOn,e as beep,d as clearLineAndHomeCursor,u as clearScreenAndHomeCursor,c as clearScreenFromTopLeft,kr as clearTabStop,er as createAnsiMode,Eo as createAnsiStatusReport,rr as createDecMode,Co as createDecStatusReport,P as cursorBackward,A as cursorBackwardTab,L as cursorDown,f as cursorForward,y as cursorHide,x as cursorHorizontalAbsolute,O as cursorHorizontalForwardTab,b as cursorLeft,_ as cursorMove,q as cursorNextLine,I as cursorPosition,Po as cursorPositionReport,N as cursorPreviousLine,g as cursorRestore,w as cursorSave,h as cursorShow,v as cursorTo,U as cursorToColumn1,B as cursorUp,K as cursorVerticalAbsolute,et as decsin,rt as decswt,ct as deiconifyWindow,Xr as deleteCharacter,Hr as deleteLine,Ao as deviceStatusReport,Mr as disableAnyEventMouse,lr as disableButtonEventMouse,pr as disableFocusTracking,mr as disableNormalMouse,Dr as disableSgrMouse,Tr as disableX10Mouse,Er as enableAnyEventMouse,Cr as enableButtonEventMouse,Pr as enableFocusTracking,Ar as enableNormalMouse,Lr as enableSgrMouse,fr as enableX10Mouse,yr as encodeMouseButtonByte,W as eraseCharacter,k as eraseDisplay,X as eraseDown,H as eraseInLine,Q as eraseLine,V as eraseLineEnd,Y as eraseLineStart,G as eraseLines,j as eraseScreen,J as eraseScreenAndScrollback,Z as eraseUp,Lo as extendedCursorPositionReport,ee as hyperlink,se as iTerm2,St as iconifyWindow,oe as image,Qr as insertCharacter,Vr as insertLine,or as isModeNotRecognized,tr as isModePermanentlyReset,sr as isModePermanentlySet,ir as isModeReset,ar as isModeSet,Wt as it2Cells,Ft as it2Percent,zt as it2Pixels,qt as keyModifierOptions,Rt as lowerWindow,Mt as maximizeWindow,xr as mouseSgrSequence,Or as mouseX10Sequence,lt as moveWindow,It as queryKeyModifierOptions,Nt as queryModifyOtherKeys,pt as raiseWindow,mt as refreshWindow,Yr as repeatPreviousCharacter,fo as reportKeyboardLanguageDEC,nr as reportMode,yo as reportPrimaryDeviceAttributes,xo as reportPrinterNoPaperDEC,Oo as reportPrinterNotReadyDEC,bo as reportPrinterReadyDEC,_o as reportSecondaryDeviceAttributes,qo as reportTerminalNotOK,Io as reportTerminalOK,No as reportTertiaryDeviceAttributes,go as reportUDKLockedDEC,wo as reportUDKUnlockedDEC,Dt as reportWindowPosition,Tt as reportWindowState,Et as requestCellSizePixels,ho as requestCursorPositionReport,vo as requestExtendedCursorPositionReport,Uo as requestKeyboardLanguageDEC,dr as requestMode,Gr as requestPresentationStateReport,Bo as requestPrimaryDeviceAttributes,Ko as requestPrimaryDeviceAttributesParam0,Wo as requestPrinterStatusDEC,Fo as requestSecondaryDeviceAttributes,zo as requestSecondaryDeviceAttributesParam0,Jo as requestTermcap,ko as requestTerminalStatus,Zo as requestTerminfo,Xo as requestTertiaryDeviceAttributes,Ho as requestTertiaryDeviceAttributesParam0,Ct as requestTextAreaSizeChars,Pt as requestTextAreaSizePixels,Qo as requestUDKStatusDEC,gt as resetKeyModifierOptions,ur as resetMode,wt as resetModifyOtherKeys,wr as resetProgressBar,S as resetTerminal,At as resizeTextAreaChars,Lt as resizeTextAreaPixels,ft as restoreMaximizedWindow,Ir as screenPassthrough,ro as scrollDown,oo as scrollUp,F as setCursorStyle,hr as setErrorProgressBar,ot as setIconName,tt as setIconNameAndWindowTitle,st as setIconNameAndWindowTitleWithST,it as setIconNameWithST,vr as setIndeterminateProgressBar,ht as setKeyModifierOptions,jr as setLeftRightMargins,cr as setMode,vt as setModifyOtherKeys1,Ut as setModifyOtherKeys2,yt as setPageSizeLines,Ur as setProgressBar,Jr as setTopBottomMargins,Br as setWarningProgressBar,at as setWindowTitle,nt as setWindowTitleWithST,Yo as strip,Nr as tmuxPassthrough,xt as xtermWindowOp};

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

@@ -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>;
+}

package/dist/iterm2/iterm2-sequences.d.ts

@@ -0,0 +1,96 @@
+import type { IITerm2Payload, ITerm2FileProperties } from "./iterm2-properties.d.ts";
+/**
+ * Represents the payload for a complete iTerm2 file transfer or an inline image display command.
+ * This class is used to construct the part of the OSC 1337 sequence that follows `File=`.
+ * The generated payload can be either:
+ * - `File=[PROPERTIES]:[BASE64_CONTENT]` (for inline content)
+ * - `File=[PROPERTIES]` (if content is not provided directly, e.g., for a download announcement)
+ *
+ * Implements {@link IITerm2Payload} for use with the generic `iTerm2` function.
+ * @see {@link ITerm2FileProps} for property details.
+ * @see {@link iTerm2} for the function that wraps this payload into a full escape sequence.
+ */
+export declare class ITerm2File implements IITerm2Payload {
+    private readonly fileProps;
+    /**
+     * Constructs an `ITerm2File` payload object.
+     * @param properties An object containing properties for the file/image, as defined by {@link ITerm2FileProps}.
+     * The `name` property within `props` should be pre-Base64 encoded by the caller if it might
+     * contain special characters (like `;`, `=`, or non-ASCII characters).
+     * If `fileData` is provided, `props.content` will be overridden, and `props.size` will be
+     * set from `fileData.byteLength` if not already present in `props`.
+     * @param fileData (Optional) A `Uint8Array` containing the raw file data. If provided, this data will be
+     * Base64 encoded and used as the `content` of the file transfer. The `size` property
+     * will also be automatically set from `fileData.byteLength` if not specified in `props`.
+     */
+    constructor(properties: ITerm2FileProperties, fileData?: Uint8Array);
+    /**
+     * Converts the file properties and its content (if any) into the string payload
+     * suitable for the iTerm2 `File=` command.
+     * @returns The string payload (e.g., `"File=name=...;size=...:BASE64_CONTENT"` or `"File=name=...;size=..."`).
+     */
+    toString(): string;
+}
+/**
+ * Represents the payload for ending an iTerm2 multipart file transfer.
+ * This class is used to construct the part of the OSC 1337 sequence that is simply `FileEnd`.
+ *
+ * Implements {@link IITerm2Payload} for use with the generic `iTerm2` function.
+ * @see {@link ITerm2MultipartFileStart} to initiate the transfer.
+ * @see {@link ITerm2FilePart} for sending file chunks.
+ */
+export declare class ITerm2FileEnd implements IITerm2Payload {
+    /**
+     * Generates the string payload for the iTerm2 `FileEnd` command.
+     * @returns The string `"FileEnd"`.
+     */
+    toString(): string;
+}
+/**
+ * Represents the payload for a part (chunk) of an iTerm2 multipart file transfer.
+ * This class is used to construct the part of the OSC 1337 sequence that follows `FilePart=`.
+ * The provided chunk must already be Base64 encoded.
+ *
+ * Implements {@link IITerm2Payload} for use with the generic `iTerm2` function.
+ * @see {@link ITerm2MultipartFileStart} to initiate the transfer.
+ * @see {@link ITerm2FileEnd} to finalize the transfer.
+ */
+export declare class ITerm2FilePart implements IITerm2Payload {
+    private readonly base64Chunk;
+    /**
+     * Constructs an `ITerm2FilePart` payload object.
+     * @param base64Chunk A string containing a Base64 encoded chunk of the file data.
+     * The caller is responsible for chunking the file and Base64 encoding each chunk.
+     */
+    constructor(base64Chunk: string);
+    /**
+     * Converts the Base64 encoded chunk into the string payload suitable for the iTerm2 `FilePart=` command.
+     * @returns The string payload (e.g., `"FilePart=U09NRURBVEE="`).
+     */
+    toString(): string;
+}
+/**
+ * Represents the payload for starting an iTerm2 multipart file transfer.
+ * This class is used to construct the part of the OSC 1337 sequence that follows `MultipartFile=`.
+ * This command initiates a transfer; the actual file data is sent in subsequent `FilePart` commands.
+ *
+ * Implements {@link IITerm2Payload} for use with the generic `iTerm2` function.
+ * @see {@link ITerm2FileProps} for property details (omitting `content`).
+ * @see {@link ITerm2FilePart} for sending file chunks.
+ * @see {@link ITerm2FileEnd} for finalizing the transfer.
+ */
+export declare class ITerm2MultipartFileStart implements IITerm2Payload {
+    private readonly properties;
+    /**
+     * Constructs an `ITerm2MultipartFileStart` payload object.
+     * @param properties Properties for the multipart file (e.g., `name`, `size`). Content is not part of this command.
+     * The `name` property within `props` should be pre-Base64 encoded by the caller if it might
+     * contain special characters.
+     */
+    constructor(properties: Omit<ITerm2FileProperties, "content">);
+    /**
+     * Converts the file properties into the string payload suitable for the iTerm2 `MultipartFile=` command.
+     * @returns The string payload (e.g., `"MultipartFile=name=...;size=..."`).
+     */
+    toString(): string;
+}