@visulima/ansi 1.0.18 → 2.0.0

package/dist/xterm.d.mts

@@ -0,0 +1,94 @@
+/**
+ * XTerm Key Modifier Options XTMODKEYS.
+ * Sets or resets XTerm key modifier resources.
+ *
+ * Sequence: `CSI > Pp m` (to reset resource Pp)
+ * Sequence: `CSI > Pp ; Pv m` (to set resource Pp to value Pv)
+ * @param resource The resource parameter (Pp), a non-negative integer.
+ * @param value Optional. The value parameter (Pv), a non-negative integer. If omitted, the resource is reset.
+ * If provided and not positive, it's treated as if omitted (resource is reset).
+ * @returns The ANSI escape sequence.
+ * @see {@link https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h3-Functions-using-CSI-_-ordered-by-the-final-character_s_}
+ */
+export declare const keyModifierOptions: (resource: number, value?: number) => string;
+/**
+ * Alias for {@link keyModifierOptions}.
+ * Provides a shorthand for setting or resetting XTerm key modifier resources.
+ * @see keyModifierOptions
+ */
+export declare const XTMODKEYS: (resource: number, value?: number) => string;
+/**
+ * Query XTerm Key Modifier Options (XTQMODKEYS).
+ * Requests the current setting of an XTerm key modifier resource.
+ *
+ * Sequence: `CSI ? Pp m`
+ * @param resource The resource parameter (Pp), a non-negative integer.
+ * @returns The ANSI escape sequence.
+ * @see {@link https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h3-Functions-using-CSI-_-ordered-by-the-final-character_s_}
+ */
+export declare const queryKeyModifierOptions: (resource: number) => string;
+/**
+ * Resets an XTerm key modifier resource to its initial value.
+ * This is an alias for `keyModifierOptions(resource)`.
+ * @param resource The resource parameter (Pp).
+ */
+export declare const resetKeyModifierOptions: (resource: number) => string;
+/**
+ * Sets an XTerm key modifier resource to a specific value.
+ * This is a more explicit alias for `keyModifierOptions(resource, value)`.
+ * @param resource The resource parameter (Pp).
+ * @param value The value parameter (Pv).
+ */
+export declare const setKeyModifierOptions: (resource: number, value: number) => string;
+/** Alias for {@link queryKeyModifierOptions}. */
+export declare const XTQMODKEYS: (resource: number) => string;
+/**
+ * Set XTerm "modifyOtherKeys" mode to mode 1 (sends modified escape sequences for certain keys).
+ * Sequence: `CSI > 4 ; 1 m`
+ * @example
+ * ```typescript
+ * import { setModifyOtherKeys1 } from "@visulima/ansi";
+ *
+ * process.stdout.write(setModifyOtherKeys1);
+ * // Sends: "\x1b[>4;1m"
+ * ```
+ */
+export declare const setModifyOtherKeys1: string;
+/**
+ * Set XTerm "modifyOtherKeys" mode to mode 2 (alternative modified escape sequences).
+ * Sequence: `CSI > 4 ; 2 m`
+ * @example
+ * ```typescript
+ * import { setModifyOtherKeys2 } from "@visulima/ansi";
+ *
+ * process.stdout.write(setModifyOtherKeys2);
+ * // Sends: "\x1b[>4;2m"
+ * ```
+ */
+export declare const setModifyOtherKeys2: string;
+/**
+ * Reset XTerm "modifyOtherKeys" to its default behavior (mode 0 or initial value).
+ * Sequence: `CSI > 4 m` (This effectively sets resource 4, value 0, or resets resource 4).
+ * @example
+ * ```typescript
+ * import { resetModifyOtherKeys } from "@visulima/ansi";
+ *
+ * process.stdout.write(resetModifyOtherKeys);
+ * // Sends: "\x1b[>4m"
+ * ```
+ */
+export declare const resetModifyOtherKeys: string;
+/**
+ * Query the current XTerm "modifyOtherKeys" mode.
+ * Sequence: `CSI ? 4 m`
+ * Response: `CSI > 4 ; Ps m` where Ps is 0, 1, or 2.
+ * @example
+ * ```typescript
+ * import { queryModifyOtherKeys } from "@visulima/ansi";
+ *
+ * process.stdout.write(queryModifyOtherKeys);
+ * // Sends: "\x1b[?4m"
+ * // Expect a response like: "\x1b[>4;1m" if mode 1 is set.
+ * ```
+ */
+export declare const queryModifyOtherKeys: string;

package/dist/xterm.d.ts

@@ -0,0 +1,94 @@
+/**
+ * XTerm Key Modifier Options XTMODKEYS.
+ * Sets or resets XTerm key modifier resources.
+ *
+ * Sequence: `CSI > Pp m` (to reset resource Pp)
+ * Sequence: `CSI > Pp ; Pv m` (to set resource Pp to value Pv)
+ * @param resource The resource parameter (Pp), a non-negative integer.
+ * @param value Optional. The value parameter (Pv), a non-negative integer. If omitted, the resource is reset.
+ * If provided and not positive, it's treated as if omitted (resource is reset).
+ * @returns The ANSI escape sequence.
+ * @see {@link https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h3-Functions-using-CSI-_-ordered-by-the-final-character_s_}
+ */
+export declare const keyModifierOptions: (resource: number, value?: number) => string;
+/**
+ * Alias for {@link keyModifierOptions}.
+ * Provides a shorthand for setting or resetting XTerm key modifier resources.
+ * @see keyModifierOptions
+ */
+export declare const XTMODKEYS: (resource: number, value?: number) => string;
+/**
+ * Query XTerm Key Modifier Options (XTQMODKEYS).
+ * Requests the current setting of an XTerm key modifier resource.
+ *
+ * Sequence: `CSI ? Pp m`
+ * @param resource The resource parameter (Pp), a non-negative integer.
+ * @returns The ANSI escape sequence.
+ * @see {@link https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h3-Functions-using-CSI-_-ordered-by-the-final-character_s_}
+ */
+export declare const queryKeyModifierOptions: (resource: number) => string;
+/**
+ * Resets an XTerm key modifier resource to its initial value.
+ * This is an alias for `keyModifierOptions(resource)`.
+ * @param resource The resource parameter (Pp).
+ */
+export declare const resetKeyModifierOptions: (resource: number) => string;
+/**
+ * Sets an XTerm key modifier resource to a specific value.
+ * This is a more explicit alias for `keyModifierOptions(resource, value)`.
+ * @param resource The resource parameter (Pp).
+ * @param value The value parameter (Pv).
+ */
+export declare const setKeyModifierOptions: (resource: number, value: number) => string;
+/** Alias for {@link queryKeyModifierOptions}. */
+export declare const XTQMODKEYS: (resource: number) => string;
+/**
+ * Set XTerm "modifyOtherKeys" mode to mode 1 (sends modified escape sequences for certain keys).
+ * Sequence: `CSI > 4 ; 1 m`
+ * @example
+ * ```typescript
+ * import { setModifyOtherKeys1 } from "@visulima/ansi";
+ *
+ * process.stdout.write(setModifyOtherKeys1);
+ * // Sends: "\x1b[>4;1m"
+ * ```
+ */
+export declare const setModifyOtherKeys1: string;
+/**
+ * Set XTerm "modifyOtherKeys" mode to mode 2 (alternative modified escape sequences).
+ * Sequence: `CSI > 4 ; 2 m`
+ * @example
+ * ```typescript
+ * import { setModifyOtherKeys2 } from "@visulima/ansi";
+ *
+ * process.stdout.write(setModifyOtherKeys2);
+ * // Sends: "\x1b[>4;2m"
+ * ```
+ */
+export declare const setModifyOtherKeys2: string;
+/**
+ * Reset XTerm "modifyOtherKeys" to its default behavior (mode 0 or initial value).
+ * Sequence: `CSI > 4 m` (This effectively sets resource 4, value 0, or resets resource 4).
+ * @example
+ * ```typescript
+ * import { resetModifyOtherKeys } from "@visulima/ansi";
+ *
+ * process.stdout.write(resetModifyOtherKeys);
+ * // Sends: "\x1b[>4m"
+ * ```
+ */
+export declare const resetModifyOtherKeys: string;
+/**
+ * Query the current XTerm "modifyOtherKeys" mode.
+ * Sequence: `CSI ? 4 m`
+ * Response: `CSI > 4 ; Ps m` where Ps is 0, 1, or 2.
+ * @example
+ * ```typescript
+ * import { queryModifyOtherKeys } from "@visulima/ansi";
+ *
+ * process.stdout.write(queryModifyOtherKeys);
+ * // Sends: "\x1b[?4m"
+ * // Expect a response like: "\x1b[>4;1m" if mode 1 is set.
+ * ```
+ */
+export declare const queryModifyOtherKeys: string;

package/dist/xterm.mjs

@@ -0,0 +1,35 @@
+import { C as CSI } from './packem_shared/constants-CE7WkXh_.mjs';
+
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+const keyModifierOptions = /* @__PURE__ */ __name((resource, value) => {
+  if (resource < 0 || !Number.isInteger(resource)) {
+    return "";
+  }
+  const pp = resource.toString();
+  if (value !== void 0) {
+    if (!Number.isInteger(value)) {
+      return "";
+    }
+    const pv = value.toString();
+    return `${CSI}>${pp};${pv}m`;
+  }
+  return `${CSI}>${pp}m`;
+}, "keyModifierOptions");
+const XTMODKEYS = keyModifierOptions;
+const queryKeyModifierOptions = /* @__PURE__ */ __name((resource) => {
+  if (resource < 0 || !Number.isInteger(resource)) {
+    return "";
+  }
+  const pp = resource.toString();
+  return `${CSI}?${pp}m`;
+}, "queryKeyModifierOptions");
+const resetKeyModifierOptions = /* @__PURE__ */ __name((resource) => keyModifierOptions(resource), "resetKeyModifierOptions");
+const setKeyModifierOptions = /* @__PURE__ */ __name((resource, value) => keyModifierOptions(resource, value), "setKeyModifierOptions");
+const XTQMODKEYS = queryKeyModifierOptions;
+const setModifyOtherKeys1 = `${CSI}>4;1m`;
+const setModifyOtherKeys2 = `${CSI}>4;2m`;
+const resetModifyOtherKeys = `${CSI}>4m`;
+const queryModifyOtherKeys = `${CSI}?4m`;
+
+export { XTMODKEYS, XTQMODKEYS, keyModifierOptions, queryKeyModifierOptions, queryModifyOtherKeys, resetKeyModifierOptions, resetModifyOtherKeys, setKeyModifierOptions, setModifyOtherKeys1, setModifyOtherKeys2 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@visulima/ansi",
-  "version": "1.0.18",
+  "version": "2.0.0",
   "description": "ANSI escape codes for some terminal swag.",
   "keywords": [
     "alternative-screen",
@@ -21,6 +21,7 @@
     "iterm",
     "iterm2",
     "link",
+    "hyperlink",
     "log",
     "logging",
     "screen",
@@ -125,14 +126,14 @@
         "default": "./dist/image.mjs"
       }
     },
-    "./link": {
+    "./hyperlink": {
       "require": {
-        "types": "./dist/link.d.cts",
-        "default": "./dist/link.cjs"
+        "types": "./dist/hyperlink.d.cts",
+        "default": "./dist/hyperlink.cjs"
       },
       "import": {
-        "types": "./dist/link.d.mts",
-        "default": "./dist/link.mjs"
+        "types": "./dist/hyperlink.d.mts",
+        "default": "./dist/hyperlink.mjs"
       }
     },
     "./scroll": {
@@ -155,6 +156,116 @@
         "default": "./dist/strip.mjs"
       }
     },
+    "./termcap": {
+      "require": {
+        "types": "./dist/termcap.d.cts",
+        "default": "./dist/termcap.cjs"
+      },
+      "import": {
+        "types": "./dist/termcap.d.mts",
+        "default": "./dist/termcap.mjs"
+      }
+    },
+    "./title": {
+      "require": {
+        "types": "./dist/title.d.cts",
+        "default": "./dist/title.cjs"
+      },
+      "import": {
+        "types": "./dist/title.d.mts",
+        "default": "./dist/title.mjs"
+      }
+    },
+    "./window-ops": {
+      "require": {
+        "types": "./dist/window-ops.d.cts",
+        "default": "./dist/window-ops.cjs"
+      },
+      "import": {
+        "types": "./dist/window-ops.d.mts",
+        "default": "./dist/window-ops.mjs"
+      }
+    },
+    "./xterm": {
+      "require": {
+        "types": "./dist/xterm.d.cts",
+        "default": "./dist/xterm.cjs"
+      },
+      "import": {
+        "types": "./dist/xterm.d.mts",
+        "default": "./dist/xterm.mjs"
+      }
+    },
+    "./iterm2": {
+      "require": {
+        "types": "./dist/iterm2.d.cts",
+        "default": "./dist/iterm2.cjs"
+      },
+      "import": {
+        "types": "./dist/iterm2.d.mts",
+        "default": "./dist/iterm2.mjs"
+      }
+    },
+    "./mode": {
+      "require": {
+        "types": "./dist/mode.d.cts",
+        "default": "./dist/mode.cjs"
+      },
+      "import": {
+        "types": "./dist/mode.d.mts",
+        "default": "./dist/mode.mjs"
+      }
+    },
+    "./mouse": {
+      "require": {
+        "types": "./dist/mouse.d.cts",
+        "default": "./dist/mouse.cjs"
+      },
+      "import": {
+        "types": "./dist/mouse.d.mts",
+        "default": "./dist/mouse.mjs"
+      }
+    },
+    "./passthrough": {
+      "require": {
+        "types": "./dist/passthrough.d.cts",
+        "default": "./dist/passthrough.cjs"
+      },
+      "import": {
+        "types": "./dist/passthrough.d.mts",
+        "default": "./dist/passthrough.mjs"
+      }
+    },
+    "./reset": {
+      "require": {
+        "types": "./dist/reset.d.cts",
+        "default": "./dist/reset.cjs"
+      },
+      "import": {
+        "types": "./dist/reset.d.mts",
+        "default": "./dist/reset.mjs"
+      }
+    },
+    "./screen": {
+      "require": {
+        "types": "./dist/screen.d.cts",
+        "default": "./dist/screen.cjs"
+      },
+      "import": {
+        "types": "./dist/screen.d.mts",
+        "default": "./dist/screen.mjs"
+      }
+    },
+    "./status": {
+      "require": {
+        "types": "./dist/status.d.cts",
+        "default": "./dist/status.cjs"
+      },
+      "import": {
+        "types": "./dist/status.d.mts",
+        "default": "./dist/status.mjs"
+      }
+    },
     "./package.json": "./package.json"
   },
   "main": "dist/index.cjs",
@@ -181,14 +292,47 @@
       "image": [
         "./dist/image.d.ts"
       ],
-      "link": [
-        "./dist/link.d.ts"
+      "hyperlink": [
+        "./dist/hyperlink.d.ts"
       ],
       "scroll": [
         "./dist/scroll.d.ts"
       ],
       "strip": [
         "./dist/strip.d.ts"
+      ],
+      "termcap": [
+        "./dist/termcap.d.ts"
+      ],
+      "title": [
+        "./dist/title.d.ts"
+      ],
+      "window-ops": [
+        "./dist/window-ops.d.ts"
+      ],
+      "xterm": [
+        "./dist/xterm.d.ts"
+      ],
+      "iterm2": [
+        "./dist/iterm2.d.ts"
+      ],
+      "mode": [
+        "./dist/mode.d.ts"
+      ],
+      "mouse": [
+        "./dist/mouse.d.ts"
+      ],
+      "passthrough": [
+        "./dist/passthrough.d.ts"
+      ],
+      "reset": [
+        "./dist/reset.d.ts"
+      ],
+      "screen": [
+        "./dist/screen.d.ts"
+      ],
+      "status": [
+        "./dist/status.d.ts"
       ]
     }
   },
@@ -198,7 +342,7 @@
     "CHANGELOG.md"
   ],
   "engines": {
-    "node": ">=18.0.0 <=23.x"
+    "node": ">=20.18 <=24.x"
   },
   "publishConfig": {
     "access": "public",

package/dist/link.cjs

@@ -1,9 +0,0 @@
-'use strict';
-
-const constants = require('./packem_shared/constants-D8u2npjW.cjs');
-
-var __defProp = Object.defineProperty;
-var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
-const link = /* @__PURE__ */ __name((text, url) => [constants.OSC, "8", constants.SEP, constants.SEP, url, constants.BEL, text, constants.OSC, "8", constants.SEP, constants.SEP, constants.BEL].join(""), "link");
-
-module.exports = link;

package/dist/link.d.cts

@@ -1,3 +0,0 @@
-declare const link: (text: string, url: string) => string;
-
-export = link;

package/dist/link.d.mts

@@ -1,3 +0,0 @@
-declare const link: (text: string, url: string) => string;
-
-export { link as default };

package/dist/link.d.ts

@@ -1,3 +0,0 @@
-declare const link: (text: string, url: string) => string;
-
-export = link;

package/dist/link.mjs

@@ -1,7 +0,0 @@
-import { O as OSC, S as SEP, B as BEL } from './packem_shared/constants-CqXMfQy0.mjs';
-
-var __defProp = Object.defineProperty;
-var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
-const link = /* @__PURE__ */ __name((text, url) => [OSC, "8", SEP, SEP, url, BEL, text, OSC, "8", SEP, SEP, BEL].join(""), "link");
-
-export { link as default };

package/dist/packem_shared/constants-CqXMfQy0.mjs

@@ -1,7 +0,0 @@
-const ESC = "\x1B";
-const CSI = `${ESC}[`;
-const OSC = "\x1B]";
-const BEL = "\x07";
-const SEP = ";";
-
-export { BEL as B, CSI as C, ESC as E, OSC as O, SEP as S };

package/dist/packem_shared/cursor-2tHgT9r6.cjs

@@ -1,57 +0,0 @@
-'use strict';
-
-const constants = require('./constants-D8u2npjW.cjs');
-require('./restoreCursor-DC_ZKZwT.cjs');
-
-const isBrowser = globalThis?.window?.document !== void 0;
-const isTerminalApp = !isBrowser && process.env.TERM_PROGRAM === "Apple_Terminal";
-const isWindows = !isBrowser && process.platform === "win32";
-
-var __defProp = Object.defineProperty;
-var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
-const cursorBackward = /* @__PURE__ */ __name((count = 1) => constants.CSI + count + "D", "cursorBackward");
-const cursorDown = /* @__PURE__ */ __name((count = 1) => constants.CSI + count + "B", "cursorDown");
-const cursorForward = /* @__PURE__ */ __name((count = 1) => constants.CSI + count + "C", "cursorForward");
-const cursorHide = constants.CSI + "?25l";
-const cursorLeft = constants.CSI + "G";
-const cursorMove = /* @__PURE__ */ __name((x, y) => {
-  let returnValue = "";
-  if (x < 0) {
-    returnValue += constants.CSI + -x + "D";
-  } else if (x > 0) {
-    returnValue += constants.CSI + x + "C";
-  }
-  if (y < 0) {
-    returnValue += constants.CSI + -y + "A";
-  } else if (y > 0) {
-    returnValue += constants.CSI + y + "B";
-  }
-  return returnValue;
-}, "cursorMove");
-const cursorNextLine = /* @__PURE__ */ __name((count = 1) => (constants.CSI + "E").repeat(count), "cursorNextLine");
-const cursorPreviousLine = /* @__PURE__ */ __name((count = 1) => (constants.CSI + "F").repeat(count), "cursorPreviousLine");
-const cursorRestore = isTerminalApp ? constants.ESC + "8" : constants.ESC + "u";
-const cursorSave = isTerminalApp ? constants.ESC + "7" : constants.ESC + "s";
-const cursorShow = constants.CSI + "?25h";
-const cursorTo = /* @__PURE__ */ __name((x, y) => {
-  if (!y && y !== 0) {
-    return constants.CSI + (x + 1) + "G";
-  }
-  return constants.CSI + (y + 1) + constants.SEP + (x + 1) + "H";
-}, "cursorTo");
-const cursorUp = /* @__PURE__ */ __name((count = 1) => constants.CSI + count + "A", "cursorUp");
-
-exports.cursorBackward = cursorBackward;
-exports.cursorDown = cursorDown;
-exports.cursorForward = cursorForward;
-exports.cursorHide = cursorHide;
-exports.cursorLeft = cursorLeft;
-exports.cursorMove = cursorMove;
-exports.cursorNextLine = cursorNextLine;
-exports.cursorPreviousLine = cursorPreviousLine;
-exports.cursorRestore = cursorRestore;
-exports.cursorSave = cursorSave;
-exports.cursorShow = cursorShow;
-exports.cursorTo = cursorTo;
-exports.cursorUp = cursorUp;
-exports.isWindows = isWindows;

package/dist/packem_shared/cursor-CDCWqbC9.mjs

@@ -1,42 +0,0 @@
-import { C as CSI, E as ESC, S as SEP } from './constants-CqXMfQy0.mjs';
-import './restoreCursor-C6pNB8UY.mjs';
-
-const isBrowser = globalThis?.window?.document !== void 0;
-const isTerminalApp = !isBrowser && process.env.TERM_PROGRAM === "Apple_Terminal";
-const isWindows = !isBrowser && process.platform === "win32";
-
-var __defProp = Object.defineProperty;
-var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
-const cursorBackward = /* @__PURE__ */ __name((count = 1) => CSI + count + "D", "cursorBackward");
-const cursorDown = /* @__PURE__ */ __name((count = 1) => CSI + count + "B", "cursorDown");
-const cursorForward = /* @__PURE__ */ __name((count = 1) => CSI + count + "C", "cursorForward");
-const cursorHide = CSI + "?25l";
-const cursorLeft = CSI + "G";
-const cursorMove = /* @__PURE__ */ __name((x, y) => {
-  let returnValue = "";
-  if (x < 0) {
-    returnValue += CSI + -x + "D";
-  } else if (x > 0) {
-    returnValue += CSI + x + "C";
-  }
-  if (y < 0) {
-    returnValue += CSI + -y + "A";
-  } else if (y > 0) {
-    returnValue += CSI + y + "B";
-  }
-  return returnValue;
-}, "cursorMove");
-const cursorNextLine = /* @__PURE__ */ __name((count = 1) => (CSI + "E").repeat(count), "cursorNextLine");
-const cursorPreviousLine = /* @__PURE__ */ __name((count = 1) => (CSI + "F").repeat(count), "cursorPreviousLine");
-const cursorRestore = isTerminalApp ? ESC + "8" : ESC + "u";
-const cursorSave = isTerminalApp ? ESC + "7" : ESC + "s";
-const cursorShow = CSI + "?25h";
-const cursorTo = /* @__PURE__ */ __name((x, y) => {
-  if (!y && y !== 0) {
-    return CSI + (x + 1) + "G";
-  }
-  return CSI + (y + 1) + SEP + (x + 1) + "H";
-}, "cursorTo");
-const cursorUp = /* @__PURE__ */ __name((count = 1) => CSI + count + "A", "cursorUp");
-
-export { cursorDown as a, cursorForward as b, cursorBackward as c, cursorHide as d, cursorLeft as e, cursorMove as f, cursorNextLine as g, cursorPreviousLine as h, cursorRestore as i, cursorSave as j, cursorShow as k, cursorTo as l, cursorUp as m, isWindows as n };