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

package/dist/erase.js

@@ -1,47 +0,0 @@
-import { C as CSI } from './packem_shared/constants-CE7WkXh_.js';
-import { u as cursorUp, t as cursorToColumn1 } from './packem_shared/cursor-CHPvxMal.js';
-
-var EraseDisplayMode = /* @__PURE__ */ ((EraseDisplayMode2) => {
-  EraseDisplayMode2[EraseDisplayMode2["EntireScreen"] = 2] = "EntireScreen";
-  EraseDisplayMode2[EraseDisplayMode2["EntireScreenAndScrollback"] = 3] = "EntireScreenAndScrollback";
-  EraseDisplayMode2[EraseDisplayMode2["ToBeginning"] = 1] = "ToBeginning";
-  EraseDisplayMode2[EraseDisplayMode2["ToEnd"] = 0] = "ToEnd";
-  return EraseDisplayMode2;
-})(EraseDisplayMode || {});
-const eraseDisplay = (mode) => {
-  const validMode = mode >= 0 && mode <= 3 ? mode : 0 /* ToEnd */;
-  return `${CSI + (validMode === 0 /* ToEnd */ ? "" : String(validMode))}J`;
-};
-var EraseLineMode = /* @__PURE__ */ ((EraseLineMode2) => {
-  EraseLineMode2[EraseLineMode2["EntireLine"] = 2] = "EntireLine";
-  EraseLineMode2[EraseLineMode2["ToBeginning"] = 1] = "ToBeginning";
-  EraseLineMode2[EraseLineMode2["ToEnd"] = 0] = "ToEnd";
-  return EraseLineMode2;
-})(EraseLineMode || {});
-const eraseInLine = (mode) => {
-  const validMode = mode >= 0 && mode <= 2 ? mode : 0 /* ToEnd */;
-  return `${CSI + (validMode === 0 /* ToEnd */ ? "" : String(validMode))}K`;
-};
-const eraseDown = eraseDisplay(0 /* ToEnd */);
-const eraseLine = eraseInLine(2 /* EntireLine */);
-const eraseLineEnd = eraseInLine(0 /* ToEnd */);
-const eraseLineStart = eraseInLine(1 /* ToBeginning */);
-const eraseLines = (count) => {
-  if (count <= 0) {
-    return "";
-  }
-  let clear = "";
-  for (let index = 0; index < count; index += 1) {
-    clear += eraseLine;
-    if (index < count - 1) {
-      clear += cursorUp();
-    }
-  }
-  clear += cursorToColumn1;
-  return clear;
-};
-const eraseScreen = eraseDisplay(2 /* EntireScreen */);
-const eraseUp = eraseDisplay(1 /* ToBeginning */);
-const eraseScreenAndScrollback = eraseDisplay(3 /* EntireScreenAndScrollback */);
-
-export { EraseDisplayMode, EraseLineMode, eraseDisplay, eraseDown, eraseInLine, eraseLine, eraseLineEnd, eraseLineStart, eraseLines, eraseScreen, eraseScreenAndScrollback, eraseUp };

package/dist/helpers.d.ts

@@ -1,14 +0,0 @@
-/**
- * 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

@@ -1,27 +0,0 @@
-/**
- * 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

@@ -1,5 +0,0 @@
-import { O as OSC, S as SEP, B as BEL } from './packem_shared/constants-CE7WkXh_.js';
-
-const hyperlink = (text, url) => [OSC, "8", SEP, SEP, url, BEL, text, OSC, "8", SEP, SEP, BEL].join("");
-
-export { hyperlink as default };

package/dist/image.d.ts

@@ -1,73 +0,0 @@
-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

@@ -1,43 +0,0 @@
-import { createRequire as __cjs_createRequire } from "node:module";
-
-const __cjs_require = __cjs_createRequire(import.meta.url);
-
-const __cjs_getProcess = typeof globalThis !== "undefined" && typeof globalThis.process !== "undefined" ? globalThis.process : process;
-
-const __cjs_getBuiltinModule = (module) => {
-    // Check if we're in Node.js and version supports getBuiltinModule
-    if (typeof __cjs_getProcess !== "undefined" && __cjs_getProcess.versions && __cjs_getProcess.versions.node) {
-        const [major, minor] = __cjs_getProcess.versions.node.split(".").map(Number);
-        // Node.js 20.16.0+ and 22.3.0+
-        if (major > 22 || (major === 22 && minor >= 3) || (major === 20 && minor >= 16)) {
-            return __cjs_getProcess.getBuiltinModule(module);
-        }
-    }
-    // Fallback to createRequire
-    return __cjs_require(module);
-};
-
-const {
-  Buffer
-} = __cjs_getBuiltinModule("node:buffer");
-import { O as OSC, B as BEL } from './packem_shared/constants-CE7WkXh_.js';
-
-const image = (data, options = {}) => {
-  if (!data) {
-    return "";
-  }
-  let returnValue = `${OSC}1337;File=inline=1`;
-  if (options.width !== void 0) {
-    returnValue += `;width=${options.width}`;
-  }
-  if (options.height !== void 0) {
-    returnValue += `;height=${options.height}`;
-  }
-  if (options.preserveAspectRatio === false) {
-    returnValue += ";preserveAspectRatio=0";
-  }
-  const base64Data = Buffer.from(data).toString("base64");
-  return `${returnValue}:${base64Data}${BEL}`;
-};
-
-export { image };

package/dist/index.d.ts

@@ -1,36 +0,0 @@
-/**
- * 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

@@ -1,26 +0,0 @@
-export { ALT_SCREEN_OFF, ALT_SCREEN_ON, alternativeScreenOff, alternativeScreenOn } from './alternative-screen.js';
-export { clearLineAndHomeCursor, clearScreenAndHomeCursor, clearScreenFromTopLeft, resetTerminal } from './clear.js';
-export { C as CURSOR_BACKWARD_1, a as CURSOR_DOWN_1, b as CURSOR_FORWARD_1, c as CURSOR_UP_1, R as REQUEST_CURSOR_POSITION, x as REQUEST_EXTENDED_CURSOR_POSITION, y as RESTORE_CURSOR_DEC, S as SAVE_CURSOR_DEC, d as cursorBackward, e as cursorBackwardTab, f as cursorDown, g as cursorForward, h as cursorHide, i as cursorHorizontalAbsolute, j as cursorHorizontalForwardTab, k as cursorLeft, l as cursorMove, m as cursorNextLine, n as cursorPosition, o as cursorPreviousLine, p as cursorRestore, q as cursorSave, r as cursorShow, s as cursorTo, t as cursorToColumn1, u as cursorUp, v as cursorVerticalAbsolute, w as eraseCharacter, z as setCursorStyle } from './packem_shared/cursor-CHPvxMal.js';
-export { eraseDisplay, eraseDown, eraseInLine, eraseLine, eraseLineEnd, eraseLineStart, eraseLines, eraseScreen, eraseScreenAndScrollback, eraseUp } from './erase.js';
-export { default as hyperlink } from './hyperlink.js';
-export { image } from './image.js';
-export { iTerm2 } from './iterm2.js';
-export { BDSM, BiDirectionalSupportMode, BracketedPasteMode, DECRPM, DECRQM, DisableModifiersMode, IRM, InBandResizeMode, InsertReplaceMode, KAM, KeyboardActionMode, LNM, LightDarkMode, LineFeedNewLineMode, LocalEchoMode, 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, 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 { resetProgressBar, setErrorProgressBar, setIndeterminateProgressBar, setProgressBar, setWarningProgressBar } from './packem_shared/resetProgressBar-kV21u2hs.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 { CPR, DA1, DA2, DA3, DECXCPR, DSR, DSR_KeyboardLanguageDEC, DSR_PrinterStatusDEC, DSR_TerminalStatus, DSR_UDKStatusDEC, LightDarkReport, RequestLightDarkReport, RequestNameVersion, XTVERSION, createAnsiStatusReport, createDecStatusReport, cursorPositionReport, deviceStatusReport, extendedCursorPositionReport, reportKeyboardLanguageDEC, reportPrimaryDeviceAttributes, reportPrinterNoPaperDEC, reportPrinterNotReadyDEC, reportPrinterReadyDEC, reportSecondaryDeviceAttributes, reportTerminalNotOK, reportTerminalOK, reportTertiaryDeviceAttributes, reportUDKLockedDEC, reportUDKUnlockedDEC, requestCursorPositionReport, requestExtendedCursorPositionReport, requestKeyboardLanguageDEC, requestPrimaryDeviceAttributes, requestPrimaryDeviceAttributesParam0, requestPrinterStatusDEC, requestSecondaryDeviceAttributes, requestSecondaryDeviceAttributesParam0, requestTerminalStatus, requestTertiaryDeviceAttributes, requestTertiaryDeviceAttributesParam0, requestUDKStatusDEC } from './status.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, 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';
-export { IT2_AUTO, it2Cells, it2Percent, it2Pixels } from './packem_shared/IT2_AUTO-BGxGtZAE.js';
-export { ITerm2File, ITerm2FileEnd, ITerm2FilePart, ITerm2MultipartFileStart } from './packem_shared/ITerm2File-DzWaT6j3.js';
-
-const beep = "\x07";
-
-export { beep };

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

@@ -1,135 +0,0 @@
-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

@@ -1,96 +0,0 @@
-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;
-}

package/dist/iterm2.d.ts

@@ -1,58 +0,0 @@
-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;

package/dist/iterm2.js

@@ -1,12 +0,0 @@
-import { O as OSC, B as BEL } from './packem_shared/constants-CE7WkXh_.js';
-export { IT2_AUTO, it2Cells, it2Percent, it2Pixels } from './packem_shared/IT2_AUTO-BGxGtZAE.js';
-export { ITerm2File, ITerm2FileEnd, ITerm2FilePart, ITerm2MultipartFileStart } from './packem_shared/ITerm2File-DzWaT6j3.js';
-
-const iTerm2 = (payload) => {
-  if (!payload || typeof payload.toString !== "function" || payload.toString === Object.prototype.toString) {
-    throw new Error("Invalid payload: must implement IITerm2Payload with a custom toString method");
-  }
-  return `${OSC}1337;${payload.toString()}${BEL}`;
-};
-
-export { iTerm2 };