@visulima/ansi 2.0.1 → 3.0.0

package/dist/erase.d.ts

@@ -1,206 +1,23 @@
-/**
- * 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`.
-     */
+declare enum EraseDisplayMode {
     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`.
-     */
+declare const eraseDisplay: (mode: EraseDisplayMode | 0 | 1 | 2 | 3) => string;
+declare enum EraseLineMode {
     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;
+declare const eraseInLine: (mode: EraseLineMode | 0 | 1 | 2) => string;
+declare const eraseDown: string;
+declare const eraseLine: string;
+declare const eraseLineEnd: string;
+declare const eraseLineStart: string;
+declare const eraseLines: (count: number) => string;
+declare const eraseScreen: string;
+declare const eraseUp: string;
+declare const eraseScreenAndScrollback: string;
+
+export { EraseDisplayMode, EraseLineMode, eraseDisplay, eraseDown, eraseInLine, eraseLine, eraseLineEnd, eraseLineStart, eraseLines, eraseScreen, eraseScreenAndScrollback, eraseUp };

package/dist/erase.js

@@ -0,0 +1 @@
+var t=Object.defineProperty;var s=(e,r)=>t(e,"name",{value:r,configurable:!0});import{C as c}from"./packem_shared/constants-D12jy2Zh.js";import{s as l,r as E}from"./packem_shared/cursor-D2UOfUc_.js";var S=Object.defineProperty,a=s((e,r)=>S(e,"name",{value:r,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 n=a(e=>{const r=e>=0&&e<=3?e:0;return`${c+(r===0?"":String(r))}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 r=e>=0&&e<=2?e:0;return`${c+(r===0?"":String(r))}K`},"eraseInLine"),f=n(0),u=o(2),m=o(0),b=o(1),v=a(e=>{if(e<=0)return"";let r="";for(let i=0;i<e;i+=1)r+=u,i<e-1&&(r+=l());return r+=E,r},"eraseLines"),y=n(2),B=n(1),D=n(3);export{d as EraseDisplayMode,g as EraseLineMode,n 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/hyperlink.d.ts

@@ -1,27 +1,3 @@
-/**
- * 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 = hyperlink;
+
+export { hyperlink as default };

package/dist/hyperlink.js

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

package/dist/image.d.ts

@@ -1,73 +1,11 @@
-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.
-     */
+import { LiteralUnion } from 'type-fest';
+
+interface ImageOptions {
     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;
+declare const image: (data: Uint8Array, options?: ImageOptions) => string;
+
+export { image };
+export type { ImageOptions };

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),i=typeof globalThis<"u"&&typeof globalThis.process<"u"?globalThis.process:process,u=o(r=>{if(typeof i<"u"&&i.versions&&i.versions.node){const[e,t]=i.versions.node.split(".").map(Number);if(e>22||e===22&&t>=3||e===20&&t>=16)return i.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 t=`${l}1337;File=inline=1`;e.width!==void 0&&(t+=`;width=${e.width}`),e.height!==void 0&&(t+=`;height=${e.height}`),e.preserveAspectRatio===!1&&(t+=";preserveAspectRatio=0");const s=f.from(r).toString("base64");return`${t}:${s}${p}`},"image");export{v as image};

package/dist/index.d.ts

@@ -1,35 +1,30 @@
-/**
- * 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";
+export { ALT_SCREEN_OFF, ALT_SCREEN_ON, alternativeScreenOff, alternativeScreenOn } from './alternative-screen.js';
+export { clearLineAndHomeCursor, clearScreenAndHomeCursor, clearScreenFromTopLeft, resetTerminal } from './clear.js';
+export { CURSOR_BACKWARD_1, CURSOR_DOWN_1, CURSOR_FORWARD_1, CURSOR_UP_1, CursorStyle, REQUEST_CURSOR_POSITION, REQUEST_EXTENDED_CURSOR_POSITION, RESTORE_CURSOR_DEC, SAVE_CURSOR_DEC, cursorBackward, cursorBackwardTab, cursorDown, cursorForward, cursorHide, cursorHorizontalAbsolute, cursorHorizontalForwardTab, cursorLeft, cursorMove, cursorNextLine, cursorPosition, cursorPreviousLine, cursorRestore, cursorSave, cursorShow, cursorTo, cursorToColumn1, cursorUp, cursorVerticalAbsolute, eraseCharacter, setCursorStyle } from './cursor.js';
+export { EraseDisplayMode, EraseLineMode, eraseDisplay, eraseDown, eraseInLine, eraseLine, eraseLineEnd, eraseLineStart, eraseLines, eraseScreen, eraseScreenAndScrollback, eraseUp } from './erase.js';
+export { default as hyperlink } from './hyperlink.js';
+export { ImageOptions, image } from './image.js';
+export { IITerm2Payload, IT2_AUTO, ITerm2File, ITerm2FileEnd, ITerm2FilePart, ITerm2FileProperties, ITerm2MultipartFileStart, iTerm2, it2Cells, it2Percent, it2Pixels } from './iterm2.js';
+export { AnsiMode, BDSM, BiDirectionalSupportMode, BracketedPasteMode, DECRPM, DECRQM, DecMode, DisableModifiersMode, IRM, InBandResizeMode, InsertReplaceMode, KAM, KeyboardActionMode, LNM, LightDarkMode, LineFeedNewLineMode, LocalEchoMode, Mode, ModeSetting, OriginMode, RM, RequestBiDirectionalSupportMode, RequestInBandResizeMode, RequestInsertReplaceMode, RequestKeyboardActionMode, RequestLineFeedNewLineMode, RequestLocalEchoMode, RequestSendReceiveMode, RequestUnicodeCoreMode, ResetBiDirectionalSupportMode, ResetInBandResizeMode, ResetInsertReplaceMode, ResetKeyboardActionMode, ResetLineFeedNewLineMode, ResetLocalEchoMode, ResetSendReceiveMode, ResetUnicodeCoreMode, SGRMouseMode, SM, SRM, SendFocusEventsMode, SendReceiveMode, SetBiDirectionalSupportMode, SetInBandResizeMode, SetInsertReplaceMode, SetKeyboardActionMode, SetLineFeedNewLineMode, SetLocalEchoMode, SetSendReceiveMode, SetUnicodeCoreMode, TextCursorEnableMode, UnicodeCoreMode, createAnsiMode, createDecMode, isModeNotRecognized, isModePermanentlyReset, isModePermanentlySet, isModeReset, isModeSet, reportMode, requestMode, resetMode, setMode } from './mode.js';
+export { MouseButton, MouseButtonType, MouseModifiers, disableAnyEventMouse, disableButtonEventMouse, disableFocusTracking, disableNormalMouse, disableSgrMouse, disableX10Mouse, enableAnyEventMouse, enableButtonEventMouse, enableFocusTracking, enableNormalMouse, enableSgrMouse, enableX10Mouse, encodeMouseButtonByte, mouseSgrSequence, mouseX10Sequence } from './mouse.js';
+export { SCREEN_MAX_LEN_DEFAULT, SCREEN_TYPICAL_LIMIT, screenPassthrough, tmuxPassthrough } from './passthrough.js';
+export { RESET_INITIAL_STATE, RIS } from './reset.js';
+export { clearTabStop, deleteCharacter, deleteLine, insertCharacter, insertLine, repeatPreviousCharacter, requestPresentationStateReport, setLeftRightMargins, setTopBottomMargins } from './screen.js';
+export { SCROLL_DOWN_1, SCROLL_UP_1, scrollDown, scrollUp } from './scroll.js';
+export { AnsiStatusReport, CPR, DA1, DA2, DA3, DECXCPR, DSR, DSR_KeyboardLanguageDEC, DSR_PrinterStatusDEC, DSR_TerminalStatus, DSR_UDKStatusDEC, DecStatusReport, LightDarkReport, RequestLightDarkReport, RequestNameVersion, StatusReport, 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.js';
+export { default as strip } from './strip.js';
+export { XTGETTCAP, requestTermcap, requestTerminfo } from './termcap.js';
+export { decsin, decswt, setIconName, setIconNameAndWindowTitle, setIconNameAndWindowTitleWithST, setIconNameWithST, setWindowTitle, setWindowTitleWithST } from './title.js';
+export { XTWINOPS, XTermWindowOp, deiconifyWindow, iconifyWindow, lowerWindow, maximizeWindow, moveWindow, raiseWindow, refreshWindow, reportWindowPosition, reportWindowState, requestCellSizePixels, requestTextAreaSizeChars, requestTextAreaSizePixels, resizeTextAreaChars, resizeTextAreaPixels, restoreMaximizedWindow, setPageSizeLines, xtermWindowOp } from './window-ops.js';
+export { XTMODKEYS, XTQMODKEYS, keyModifierOptions, queryKeyModifierOptions, queryModifyOtherKeys, resetKeyModifierOptions, resetModifyOtherKeys, setKeyModifierOptions, setModifyOtherKeys1, setModifyOtherKeys2 } from './xterm.js';
+import 'type-fest';
+
+declare const resetProgressBar: string;
+declare const setProgressBar: (percentage: number) => string;
+declare const setErrorProgressBar: (percentage: number) => string;
+declare const setIndeterminateProgressBar: string;
+declare const setWarningProgressBar: (percentage: number) => string;
+
+declare const beep = "\u0007";
+
+export { beep, resetProgressBar, setErrorProgressBar, setIndeterminateProgressBar, setProgressBar, setWarningProgressBar };

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

package/dist/iterm2.d.ts

@@ -1,58 +1,43 @@
-import type { IITerm2Payload } from './iterm2/iterm2-properties.d.ts';
-export type { IITerm2Payload, ITerm2FileProperties } from './iterm2/iterm2-properties.d.ts';
-export { IT2_AUTO, it2Cells, it2Percent, it2Pixels, } from './iterm2/iterm2-properties.d.ts';
-export { ITerm2File, ITerm2FileEnd, ITerm2FilePart, ITerm2MultipartFileStart, } from './iterm2/iterm2-sequences.d.ts';
-/**
- * Generates a complete iTerm2 proprietary escape sequence (OSC 1337).
- *
- * This function serves as a general-purpose constructor for iTerm2 escape codes.
- * It takes a payload object that conforms to the {@link IITerm2Payload} interface.
- * The `toString()` method of this payload object is responsible for generating the
- * specific command and arguments part of the sequence (e.g., `File=...`, `ShellIntegrationVersion=...`).
- *
- * The overall structure of the generated sequence is: `OSC 1337 ; <PAYLOAD_STRING> BEL`
- * (`OSC` is `\x1b]`, `BEL` is `\x07`).
- * @param payload An object that implements the {@link IITerm2Payload} interface.
- * This object must have a `toString()` method that returns the string representation
- * of the iTerm2 command-specific payload.
- * Examples include instances of `ITerm2File`, `ITerm2MultipartFileStart`, etc.
- * @returns The fully formed ANSI escape sequence for the iTerm2 command.
- * Returns an empty string if the provided `payload` is invalid (e.g., null, undefined,
- * lacks a proper `toString` method, or its `toString` method is the generic `Object.prototype.toString`).
- * @see {@link https://iterm2.com/documentation-escape-codes.html iTerm2 Escape Codes Documentation}
- * for a comprehensive list of supported commands and their payloads.
- * @see {@link IITerm2Payload} for the interface requirement.
- * @see Classes like {@link ITerm2File}, {@link ITerm2MultipartFileStart}, {@link ITerm2FilePart}, {@link ITerm2FileEnd}
- * for concrete examples of payload objects.
- * @example
- * ```typescript
- * import { iTerm2, ITerm2File, ITerm2FileProps } from '@visulima/ansi/iterm2'; // ITerm2FileProps can be used for options
- * import { Buffer } from 'node:buffer';
- *
- * // Example 1: Sending a file inline (like an image)
- * const imageName = "my_image.png";
- * const imageData = Buffer.from("dummyimagecontent"); // Replace with actual Uint8Array image data
- * const imageFileProps: ITerm2FileProps = { // Use ITerm2FileProps for broader options
- *   name: Buffer.from(imageName).toString("base64"), // Name should be base64 encoded
- *   inline: true,
- *   width: "50%",
- *   height: "auto",
- *   ignoreAspectRatio: false, // Equivalent to preserveAspectRatio: true
- * };
- * const filePayload = new ITerm2File(imageFileProps, imageData);
- * const imageSequence = iTerm2(filePayload);
- * console.log(imageSequence);
- * // Expected output (simplified, actual base64 will be longer):
- * // OSC1337;File=name=bXlfaW1hZ2UucG5n;inline=1;width=50%;height=auto:ZHVtbXlpbWFnZWNvbnRlbnQ=BEL
- * // Note: if ignoreAspectRatio was true, preserveAspectRatio=0 would be in the sequence.
- *
- * // Example 2: A hypothetical simple command (e.g., shell integration handshake)
- * const shellIntegrationPayload: IITerm2Payload = {
- *   toString: () => "ShellIntegrationVersion=15;Shell=zsh"
- * };
- * const shellSequence = iTerm2(shellIntegrationPayload);
- * console.log(shellSequence);
- * // Output: OSC1337;ShellIntegrationVersion=15;Shell=zshBEL
- * ```
- */
-export declare const iTerm2: (payload: IITerm2Payload) => string;
+import { LiteralUnion } from 'type-fest';
+
+declare const IT2_AUTO: string;
+declare const it2Cells: (n: number) => string;
+declare const it2Pixels: (n: number) => string;
+declare const it2Percent: (n: number) => string;
+interface IITerm2Payload {
+    toString: () => string;
+}
+interface ITerm2FileProperties {
+    content?: string;
+    doNotMoveCursor?: boolean;
+    height?: LiteralUnion<typeof IT2_AUTO, number | string>;
+    ignoreAspectRatio?: boolean;
+    inline?: boolean;
+    name?: string;
+    size?: number;
+    width?: LiteralUnion<typeof IT2_AUTO, number | string>;
+}
+
+declare class ITerm2File implements IITerm2Payload {
+    private readonly fileProps;
+    constructor(properties: ITerm2FileProperties, fileData?: Uint8Array);
+    toString(): string;
+}
+declare class ITerm2FileEnd implements IITerm2Payload {
+    toString(): string;
+}
+declare class ITerm2FilePart implements IITerm2Payload {
+    private readonly base64Chunk;
+    constructor(base64Chunk: string);
+    toString(): string;
+}
+declare class ITerm2MultipartFileStart implements IITerm2Payload {
+    private readonly properties;
+    constructor(properties: Omit<ITerm2FileProperties, "content">);
+    toString(): string;
+}
+
+declare const iTerm2: (payload: IITerm2Payload) => string;
+
+export { IT2_AUTO, ITerm2File, ITerm2FileEnd, ITerm2FilePart, ITerm2MultipartFileStart, iTerm2, it2Cells, it2Percent, it2Pixels };
+export type { IITerm2Payload, ITerm2FileProperties };

package/dist/iterm2.js

@@ -0,0 +1 @@
+var o=Object.defineProperty;var r=(t,e)=>o(t,"name",{value:e,configurable:!0});import{O as i,B as m}from"./packem_shared/constants-D12jy2Zh.js";import{IT2_AUTO as I,it2Cells as c,it2Percent as s,it2Pixels as S}from"./packem_shared/IT2_AUTO-BYrffRAq.js";import{ITerm2File as g,ITerm2FileEnd as y,ITerm2FilePart as O,ITerm2MultipartFileStart as P}from"./packem_shared/ITerm2File-C88DBJC-.js";var n=Object.defineProperty,a=r((t,e)=>n(t,"name",{value:e,configurable:!0}),"t");const T=a(t=>{if(!t||typeof t.toString!="function"||t.toString===Object.prototype.toString)throw new Error("Invalid payload: must implement IITerm2Payload with a custom toString method");return`${i}1337;${t.toString()}${m}`},"iTerm2");export{I as IT2_AUTO,g as ITerm2File,y as ITerm2FileEnd,O as ITerm2FilePart,P as ITerm2MultipartFileStart,T as iTerm2,c as it2Cells,s as it2Percent,S as it2Pixels};