@visulima/ansi 1.0.17 → 1.1.0

package/dist/scroll.d.ts

@@ -1,4 +1,67 @@
-declare const scrollDown: (count?: number) => string;
-declare const scrollUp: (count?: number) => string;
-
-export { scrollDown, scrollUp };
+/**
+ * Scrolls the content of the active scrolling region upwards by a specified number of lines.
+ * (SU - Scroll Up)
+ *
+ * New blank lines are added at the bottom of the scrolling region.
+ * If the parameter `count` is 1 or omitted, it defaults to scrolling one line.
+ * The cursor position is not affected by this command.
+ *
+ * Sequence: `CSI Pn S`
+ * - `Pn`: Number of lines to scroll up (default: 1).
+ * @param count The number of lines to scroll up. Defaults to 1. If 0, an empty string is returned as no operation is performed.
+ * @returns The ANSI escape sequence for scrolling up.
+ * @see {@link https://vt100.net/docs/vt510-rm/SU.html VT510 SU Documentation}
+ * @example
+ * ```typescript
+ * import { scrollUp } from \'@visulima/ansi/scroll\';
+ *
+ * // Scroll up 1 line
+ * process.stdout.write(scrollUp());    // CSI S
+ * process.stdout.write(scrollUp(1)); // CSI S
+ *
+ * // Scroll up 5 lines
+ * process.stdout.write(scrollUp(5));  // CSI 5S
+ *
+ * // No operation
+ * process.stdout.write(scrollUp(0));  // ""
+ * ```
+ */
+export declare const scrollUp: (count?: number) => string;
+/**
+ * Scrolls the content of the active scrolling region downwards by a specified number of lines.
+ * (SD - Scroll Down)
+ *
+ * New blank lines are added at the top of the scrolling region.
+ * If the parameter `count` is 1 or omitted, it defaults to scrolling one line.
+ * The cursor position is not affected by this command.
+ *
+ * Sequence: `CSI Pn T`
+ * - `Pn`: Number of lines to scroll down (default: 1).
+ * @param count The number of lines to scroll down. Defaults to 1. If 0, an empty string is returned.
+ * @returns The ANSI escape sequence for scrolling down.
+ * @see {@link https://vt100.net/docs/vt510-rm/SD.html VT510 SD Documentation}
+ * @example
+ * ```typescript
+ * import { scrollDown } from \'@visulima/ansi/scroll\';
+ *
+ * // Scroll down 1 line
+ * process.stdout.write(scrollDown());    // CSI T
+ * process.stdout.write(scrollDown(1)); // CSI T
+ *
+ * // Scroll down 3 lines
+ * process.stdout.write(scrollDown(3));  // CSI 3T
+ * ```
+ */
+export declare const scrollDown: (count?: number) => string;
+/**
+ * ANSI escape sequence to scroll up one line: `CSI S`.
+ * This is equivalent to `scrollUp(1)`.
+ * @see {@link scrollUp}
+ */
+export declare const SCROLL_UP_1: string;
+/**
+ * ANSI escape sequence to scroll down one line: `CSI T`.
+ * This is equivalent to `scrollDown(1)`.
+ * @see {@link scrollDown}
+ */
+export declare const SCROLL_DOWN_1: string;

package/dist/scroll.mjs

@@ -1,8 +1,20 @@
-import { C as CSI } from './packem_shared/constants-CqXMfQy0.mjs';
+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 scrollDown = /* @__PURE__ */ __name((count = 1) => `${CSI}T`.repeat(count), "scrollDown");
-const scrollUp = /* @__PURE__ */ __name((count = 1) => `${CSI}S`.repeat(count), "scrollUp");
+const scrollUp = /* @__PURE__ */ __name((count = 1) => {
+  if (count === 0) {
+    return "";
+  }
+  return `${CSI + (count <= 1 ? "" : count)}S`;
+}, "scrollUp");
+const scrollDown = /* @__PURE__ */ __name((count = 1) => {
+  if (count === 0) {
+    return "";
+  }
+  return `${CSI + (count <= 1 ? "" : count)}T`;
+}, "scrollDown");
+const SCROLL_UP_1 = `${CSI}S`;
+const SCROLL_DOWN_1 = `${CSI}T`;
 
-export { scrollDown, scrollUp };
+export { SCROLL_DOWN_1, SCROLL_UP_1, scrollDown, scrollUp };

package/dist/status.cjs

@@ -0,0 +1,147 @@
+'use strict';
+
+Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: 'Module' } });
+
+const constants = require('./packem_shared/constants-BK26O-46.cjs');
+
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+class AnsiStatusReportImpl {
+  constructor(reportCode) {
+    this.reportCode = reportCode;
+  }
+  static {
+    __name(this, "AnsiStatusReportImpl");
+  }
+  isDecReport = false;
+}
+class DecStatusReportImpl {
+  constructor(reportCode) {
+    this.reportCode = reportCode;
+  }
+  static {
+    __name(this, "DecStatusReportImpl");
+  }
+  isDecReport = true;
+}
+const createAnsiStatusReport = /* @__PURE__ */ __name((code) => new AnsiStatusReportImpl(code), "createAnsiStatusReport");
+const createDecStatusReport = /* @__PURE__ */ __name((code) => new DecStatusReportImpl(code), "createDecStatusReport");
+const deviceStatusReport = /* @__PURE__ */ __name((...reports) => {
+  if (reports.length === 0) {
+    return "";
+  }
+  let hasDecReport = false;
+  const reportCodes = reports.map((report) => {
+    if (report.isDecReport) {
+      hasDecReport = true;
+    }
+    return report.reportCode.toString();
+  });
+  let seq = constants.CSI;
+  if (hasDecReport) {
+    seq += "?";
+  }
+  return `${seq + reportCodes.join(constants.SEP)}n`;
+}, "deviceStatusReport");
+const DSR = /* @__PURE__ */ __name((report) => deviceStatusReport(report), "DSR");
+const requestCursorPositionReport = `${constants.CSI}6n`;
+const requestExtendedCursorPositionReport = `${constants.CSI}?6n`;
+const cursorPositionReport = /* @__PURE__ */ __name((line, column) => {
+  const r = Math.max(1, line);
+  const c = Math.max(1, column);
+  return `${constants.CSI + r.toString() + constants.SEP + c.toString()}R`;
+}, "cursorPositionReport");
+const CPR = cursorPositionReport;
+const extendedCursorPositionReport = /* @__PURE__ */ __name((line, column, page) => {
+  const r = Math.max(1, line);
+  const c = Math.max(1, column);
+  let seq = `${constants.CSI}?`;
+  seq += r.toString() + constants.SEP + c.toString();
+  if (page > 0) {
+    seq += constants.SEP + page.toString();
+  }
+  seq += "R";
+  return seq;
+}, "extendedCursorPositionReport");
+const DECXCPR = extendedCursorPositionReport;
+const RequestNameVersion = `${constants.CSI}>0q`;
+const XTVERSION = RequestNameVersion;
+const requestPrimaryDeviceAttributes = `${constants.CSI}c`;
+const DA1 = requestPrimaryDeviceAttributes;
+const reportPrimaryDeviceAttributes = /* @__PURE__ */ __name((...attributes) => {
+  if (attributes.length === 0) {
+    return "";
+  }
+  return `${constants.CSI}?${attributes.join(constants.SEP)}c`;
+}, "reportPrimaryDeviceAttributes");
+const requestSecondaryDeviceAttributes = `${constants.CSI}>c`;
+const DA2 = requestSecondaryDeviceAttributes;
+const reportSecondaryDeviceAttributes = /* @__PURE__ */ __name((version, level, cartridge = 0) => {
+  const pv = Math.max(0, version);
+  const pl = Math.max(0, level);
+  const pc = Math.max(0, cartridge);
+  return `${constants.CSI}>${pv}${constants.SEP}${pl}${constants.SEP}${pc}c`;
+}, "reportSecondaryDeviceAttributes");
+const requestTertiaryDeviceAttributes = `${constants.CSI}=c`;
+const DA3 = requestTertiaryDeviceAttributes;
+const reportTertiaryDeviceAttributes = /* @__PURE__ */ __name((unitID) => `${constants.DCS}!|${unitID}${constants.ST}`, "reportTertiaryDeviceAttributes");
+const requestPrimaryDeviceAttributesParam0 = `${constants.CSI}0c`;
+const requestSecondaryDeviceAttributesParam0 = `${constants.CSI}>0c`;
+const requestTertiaryDeviceAttributesParam0 = `${constants.CSI}=0c`;
+const requestTerminalStatus = createAnsiStatusReport(5);
+const DSR_TerminalStatus = deviceStatusReport(requestTerminalStatus);
+const reportTerminalOK = `${constants.CSI}0n`;
+const reportTerminalNotOK = `${constants.CSI}3n`;
+const requestPrinterStatusDEC = createDecStatusReport(15);
+const DSR_PrinterStatusDEC = deviceStatusReport(requestPrinterStatusDEC);
+const reportPrinterReadyDEC = `${constants.CSI}?10n`;
+const reportPrinterNotReadyDEC = `${constants.CSI}?11n`;
+const reportPrinterNoPaperDEC = `${constants.CSI}?13n`;
+const requestUDKStatusDEC = createDecStatusReport(25);
+const DSR_UDKStatusDEC = deviceStatusReport(requestUDKStatusDEC);
+const reportUDKLockedDEC = `${constants.CSI}?20n`;
+const reportUDKUnlockedDEC = `${constants.CSI}?21n`;
+const requestKeyboardLanguageDEC = createDecStatusReport(26);
+const DSR_KeyboardLanguageDEC = deviceStatusReport(requestKeyboardLanguageDEC);
+const reportKeyboardLanguageDEC = /* @__PURE__ */ __name((langCode) => `${constants.CSI}?27${constants.SEP}${langCode.toString()}n`, "reportKeyboardLanguageDEC");
+
+exports.CPR = CPR;
+exports.DA1 = DA1;
+exports.DA2 = DA2;
+exports.DA3 = DA3;
+exports.DECXCPR = DECXCPR;
+exports.DSR = DSR;
+exports.DSR_KeyboardLanguageDEC = DSR_KeyboardLanguageDEC;
+exports.DSR_PrinterStatusDEC = DSR_PrinterStatusDEC;
+exports.DSR_TerminalStatus = DSR_TerminalStatus;
+exports.DSR_UDKStatusDEC = DSR_UDKStatusDEC;
+exports.RequestNameVersion = RequestNameVersion;
+exports.XTVERSION = XTVERSION;
+exports.createAnsiStatusReport = createAnsiStatusReport;
+exports.createDecStatusReport = createDecStatusReport;
+exports.cursorPositionReport = cursorPositionReport;
+exports.deviceStatusReport = deviceStatusReport;
+exports.extendedCursorPositionReport = extendedCursorPositionReport;
+exports.reportKeyboardLanguageDEC = reportKeyboardLanguageDEC;
+exports.reportPrimaryDeviceAttributes = reportPrimaryDeviceAttributes;
+exports.reportPrinterNoPaperDEC = reportPrinterNoPaperDEC;
+exports.reportPrinterNotReadyDEC = reportPrinterNotReadyDEC;
+exports.reportPrinterReadyDEC = reportPrinterReadyDEC;
+exports.reportSecondaryDeviceAttributes = reportSecondaryDeviceAttributes;
+exports.reportTerminalNotOK = reportTerminalNotOK;
+exports.reportTerminalOK = reportTerminalOK;
+exports.reportTertiaryDeviceAttributes = reportTertiaryDeviceAttributes;
+exports.reportUDKLockedDEC = reportUDKLockedDEC;
+exports.reportUDKUnlockedDEC = reportUDKUnlockedDEC;
+exports.requestCursorPositionReport = requestCursorPositionReport;
+exports.requestExtendedCursorPositionReport = requestExtendedCursorPositionReport;
+exports.requestKeyboardLanguageDEC = requestKeyboardLanguageDEC;
+exports.requestPrimaryDeviceAttributes = requestPrimaryDeviceAttributes;
+exports.requestPrimaryDeviceAttributesParam0 = requestPrimaryDeviceAttributesParam0;
+exports.requestPrinterStatusDEC = requestPrinterStatusDEC;
+exports.requestSecondaryDeviceAttributes = requestSecondaryDeviceAttributes;
+exports.requestSecondaryDeviceAttributesParam0 = requestSecondaryDeviceAttributesParam0;
+exports.requestTerminalStatus = requestTerminalStatus;
+exports.requestTertiaryDeviceAttributes = requestTertiaryDeviceAttributes;
+exports.requestTertiaryDeviceAttributesParam0 = requestTertiaryDeviceAttributesParam0;
+exports.requestUDKStatusDEC = requestUDKStatusDEC;