console-toolkit 1.2.9 → 1.2.10

package/src/alphanumeric/unicode-cultural-numbers.d.ts

@@ -0,0 +1,65 @@
+import {SymbolRange} from './utils.js';
+
+/** Transcode tables for cultural number systems, mapping ASCII digits to their Unicode equivalents. */
+export const transcodeTables: {
+  arabicIndic: SymbolRange;
+  arabicIndicExtended: SymbolRange;
+  tamil: SymbolRange;
+  nko: SymbolRange;
+  devanagari: SymbolRange;
+  bengali: SymbolRange;
+  gurmukhi: SymbolRange;
+  gujarati: SymbolRange;
+  oriya: SymbolRange;
+  telugu: SymbolRange;
+  kannada: SymbolRange;
+  malayalam: SymbolRange;
+  thai: SymbolRange;
+  lao: SymbolRange;
+  myanmar: SymbolRange;
+  myanmarShan: SymbolRange;
+  ethiopic: SymbolRange;
+  khmer: SymbolRange;
+  mongolian: SymbolRange;
+  limbu: SymbolRange;
+  balinese: SymbolRange;
+  sundanese: SymbolRange;
+  lepcha: SymbolRange;
+  vai: SymbolRange;
+  saurashtra: SymbolRange;
+  javanese: SymbolRange;
+  cham: SymbolRange;
+  osmanya: SymbolRange;
+  kharoshthi: SymbolRange;
+  rumi: SymbolRange;
+  brahmi: SymbolRange;
+  brahmiNumbers: SymbolRange;
+  chakma: SymbolRange;
+  sharada: SymbolRange;
+  khudawadi: SymbolRange;
+  newa: SymbolRange;
+  tirhuta: SymbolRange;
+  modi: SymbolRange;
+  takri: SymbolRange;
+  ahom: SymbolRange;
+  bhaiksuki: SymbolRange;
+  bhaiksukiNumbers: SymbolRange;
+  mro: SymbolRange;
+  medefaidrin: SymbolRange;
+  wancho: SymbolRange;
+  adlam: SymbolRange;
+  aegean: SymbolRange;
+  palmyren: SymbolRange;
+  nabataean: SymbolRange;
+  oldPersian: SymbolRange;
+  imperialAramaic: SymbolRange;
+  meroiticCursive: SymbolRange;
+  inscriptionalParthian: SymbolRange;
+  inscriptionalPahlavi: SymbolRange;
+  psalterPahlavi: SymbolRange;
+  oldSogdian: SymbolRange;
+  indicSiyaq: SymbolRange;
+  indicSiyaqPrefixed: SymbolRange;
+  indicSiyaqAlternate: SymbolRange;
+  copticEpact: SymbolRange;
+};

package/src/alphanumeric/unicode-cultural-numbers.js

@@ -1,5 +1,6 @@
 import {SymbolRange} from './utils.js';
 
+/** Transcode tables for cultural number systems, mapping ASCII digits to their Unicode equivalents. */
 export const transcodeTables = {
   arabicIndic: new SymbolRange('٠'),
   arabicIndicExtended: new SymbolRange('۰'),

package/src/alphanumeric/unicode-letters.d.ts

@@ -0,0 +1,32 @@
+import {SymbolRange} from './utils.js';
+
+/** Transcode tables for mathematical and decorative letter styles. */
+export const transcodeTables: {
+  bold: SymbolRange[];
+  italic: SymbolRange[];
+  boldItalic: SymbolRange[];
+  sansSerif: SymbolRange[];
+  sansSerifBold: SymbolRange[];
+  sansSerifItalic: SymbolRange[];
+  sansSerifBoldItalic: SymbolRange[];
+  script: SymbolRange[];
+  scriptBold: SymbolRange[];
+  fraktur: SymbolRange[];
+  frakturBold: SymbolRange[];
+  mono: SymbolRange[];
+  doubleStruck: SymbolRange[];
+  parens: SymbolRange[];
+  circled: SymbolRange[];
+  squared: SymbolRange[];
+  negativeCircled: SymbolRange[];
+  negativeSquared: SymbolRange[];
+  regionalIndicators: SymbolRange[];
+};
+
+/** Transcodes a string to a Unicode letter style.
+ * @param s - The string to transcode.
+ * @param name - Style name (key of `transcodeTables`) or an array of SymbolRanges.
+ * @param options - Options.
+ * @returns The transcoded string.
+ */
+export function transcode(s: string, name: string | SymbolRange[], options?: {missing?: string}): string;

package/src/alphanumeric/unicode-letters.js

@@ -5,6 +5,7 @@ const range = (fromCapital, fromSmall) =>
     x => x
   );
 
+/** Transcode tables for mathematical and decorative letter styles. */
 export const transcodeTables = {
   bold: range('\u{1D400}', '\u{1D41A}'),
   italic: range('\u{1D434}', '\u{1D44E}'),
@@ -56,6 +57,13 @@ transcodeTables.script[1].overlay = {e: '\u{212F}', g: '\u{210A}', o: '\u{2134}'
 
 // API
 
+/** Transcodes a string to a Unicode letter style.
+ * @param {string} s - The string to transcode.
+ * @param {string|import('./utils.js').SymbolRange[]} name - Style name (key of `transcodeTables`) or an array of SymbolRanges.
+ * @param {object} [options] - Options.
+ * @param {string} [options.missing] - Replacement for unmapped characters.
+ * @returns {string} The transcoded string.
+ */
 export const transcode = (s, name, options) => {
   let tables = typeof name == 'string' ? transcodeTables[name] : name;
   if (!tables) throw new Error(`There is no transcode table "${name}"`);

package/src/alphanumeric/unicode-numbers.d.ts

@@ -0,0 +1,44 @@
+import {SymbolRange} from './utils.js';
+
+/** Transcode tables for Unicode number styles and embellishments. */
+export const transcodeTables: {
+  circled: SymbolRange;
+  parens: SymbolRange;
+  dots: SymbolRange;
+  doubleCircled: SymbolRange;
+  bold: SymbolRange;
+  doubleStruck: SymbolRange;
+  sansSerif: SymbolRange;
+  sansSerifBold: SymbolRange;
+  mono: SymbolRange;
+  commas: SymbolRange;
+  roman: SymbolRange;
+  romanLower: SymbolRange;
+  dingbatsCircledSansSerif: SymbolRange;
+  dingbatsNegativeCircled: SymbolRange;
+  dingbatsNegativeCircledSansSerif: SymbolRange;
+  superscript: SymbolRange;
+  subscript: SymbolRange;
+};
+
+/** Transcodes a string of digits to a Unicode number style.
+ * @param s - The digit string to transcode.
+ * @param name - Style name (key of `transcodeTables`) or a SymbolRange.
+ * @param options - Options.
+ * @returns The transcoded string.
+ */
+export function transcode(s: string, name: string | SymbolRange, options?: {missing?: string}): string;
+
+/** Replaces digit-punctuation pairs with Unicode enclosed digits.
+ * @param s - The string containing digits with commas/dots.
+ * @param options - Options for surrounding text.
+ * @returns The string with Unicode punctuation replacements.
+ */
+export function numberPunctuation(s: string, options?: {addBefore?: string; addAfter?: string}): string;
+
+/** Converts scientific notation to Unicode superscript exponent form.
+ * @param s - The number string in scientific notation (e.g., '1.5e10').
+ * @param options - Options.
+ * @returns The formatted string with Unicode superscripts.
+ */
+export function numberExponent(s: string, options?: {useSpecialMinus?: boolean}): string;

package/src/alphanumeric/unicode-numbers.js

@@ -1,6 +1,7 @@
 import {SymbolRange, transcode as internalTranscode} from './utils.js';
 import {minus, multiplication, superscriptPlus, superscriptMinus} from '../symbols.js';
 
+/** Transcode tables for Unicode number styles and embellishments. */
 export const transcodeTables = {
   // Enclosed Alphanumeric
   circled: new SymbolRange('①', 1, 20),
@@ -50,18 +51,38 @@ transcodeTables.superscript.overlay = {1: '¹', 2: '²', 3: '³'};
 
 // API
 
+/** Transcodes a string of digits to a Unicode number style.
+ * @param {string} s - The digit string to transcode.
+ * @param {string|import('./utils.js').SymbolRange} name - Style name (key of `transcodeTables`) or a SymbolRange.
+ * @param {object} [options] - Options.
+ * @param {string} [options.missing] - Replacement for unmapped characters.
+ * @returns {string} The transcoded string.
+ */
 export const transcode = (s, name, options) => {
   const table = typeof name == 'string' ? transcodeTables[name] : name;
   if (!table) throw new Error(`There is no transcode table "${name}"`);
   return internalTranscode(s, table, options);
 };
 
+/** Replaces digit-punctuation pairs with Unicode enclosed digits.
+ * @param {string} s - The string containing digits with commas/dots.
+ * @param {object} [options] - Options for surrounding text.
+ * @param {string} [options.addBefore=''] - String to add before a digit.
+ * @param {string} [options.addAfter=' '] - String to add after a digit.
+ * @returns {string} The string with Unicode punctuation replacements.
+ */
 export const numberPunctuation = (s, {addBefore = '', addAfter = ' '} = {}) =>
   s.replace(
     /(\d)([\,\.])/g,
     (_, d, p) => addBefore + transcodeTables[p === '.' ? 'dots' : 'commas'].transcode(d) + addAfter
   );
 
+/** Converts scientific notation to Unicode superscript exponent form.
+ * @param {string} s - The number string in scientific notation (e.g., '1.5e10').
+ * @param {object} [options] - Options.
+ * @param {boolean} [options.useSpecialMinus] - If true, use a special math minus symbol.
+ * @returns {string} The formatted string with Unicode superscripts.
+ */
 export const numberExponent = (s, {useSpecialMinus} = {}) => {
   const r = /^([+-]?)([^e]+)e([+-]?)(.+)$/i.exec(s);
   return r

package/src/alphanumeric/utils.d.ts

@@ -0,0 +1,45 @@
+/** Maps a range of numeric values to Unicode code points for transcoding digits/letters. */
+export class SymbolRange {
+  /** Start of the numeric range. */
+  from: number;
+  /** End of the numeric range (inclusive). */
+  to: number;
+  /** Unicode code point base offset. */
+  base: number;
+  /** Code point of the input character corresponding to 0. */
+  inputBase: number;
+  /** Optional overlay for custom symbol replacements. */
+  overlay: SymbolRange | Record<string, string> | null;
+
+  /** Creates a new SymbolRange.
+   * @param fromSymbol - The Unicode character corresponding to the `from` value.
+   * @param from - Start of the range (default: 0).
+   * @param to - End of the range inclusive (default: 9).
+   * @param inputBase - The input character corresponding to 0 (default: '0').
+   */
+  constructor(fromSymbol: string, from?: number, to?: number, inputBase?: string);
+
+  /** Gets the transcoded symbol for a value or character.
+   * @param i - Numeric index or input character.
+   * @returns The transcoded symbol, or `false` if out of range.
+   */
+  get(i: number | string): string | false;
+  /** Transcodes a string by replacing each character with its mapped symbol.
+   * @param s - The string to transcode.
+   * @param options - Options.
+   * @returns The transcoded string.
+   */
+  transcode(s: string, options?: {missing?: string}): string;
+}
+
+/** Transcodes a string using one or more lookup tables.
+ * @param s - The string to transcode.
+ * @param tables - A function, SymbolRange, array of SymbolRanges, or a plain mapping object.
+ * @param options - Options.
+ * @returns The transcoded string.
+ */
+export function transcode(
+  s: string,
+  tables: ((m: string) => string | undefined) | SymbolRange | SymbolRange[] | Record<string, string>,
+  options?: {missing?: string}
+): string;

package/src/alphanumeric/utils.js

@@ -1,4 +1,13 @@
+/** Maps a range of numeric values to Unicode code points for transcoding digits/letters.
+ * Supports overlays for custom symbol replacements.
+ */
 export class SymbolRange {
+  /**
+   * @param {string} fromSymbol - The Unicode character corresponding to the `from` value.
+   * @param {number} [from=0] - Start of the range.
+   * @param {number} [to=9] - End of the range (inclusive).
+   * @param {string} [inputBase='0'] - The input character corresponding to 0.
+   */
   constructor(fromSymbol, from = 0, to = 9, inputBase = '0') {
     this.from = from;
     this.to = to;
@@ -6,6 +15,10 @@ export class SymbolRange {
     this.inputBase = inputBase.codePointAt(0);
     this.overlay = null;
   }
+  /** Gets the transcoded symbol for a value or character.
+   * @param {number|string} i - Numeric index or input character.
+   * @returns {string|false} The transcoded symbol, or false if out of range.
+   */
   get(i) {
     if (this.overlay) {
       const result =
@@ -19,11 +32,24 @@ export class SymbolRange {
     }
     return this.from <= i && i <= this.to && String.fromCodePoint(this.base + i);
   }
+  /** Transcodes a string by replacing each character with its mapped symbol.
+   * @param {string} s - The string to transcode.
+   * @param {object} [options] - Options.
+   * @param {string} [options.missing] - Replacement for unmapped characters.
+   * @returns {string} The transcoded string.
+   */
   transcode(s, {missing} = {}) {
     return s.replace(/./g, missing ? m => this.get(m) || missing : m => this.get(m) || m);
   }
 }
 
+/** Transcodes a string using one or more lookup tables.
+ * @param {string} s - The string to transcode.
+ * @param {Function|object|Array} tables - A function, object, SymbolRange, or array of them.
+ * @param {object} [options] - Options.
+ * @param {string} [options.missing] - Replacement for unmapped characters.
+ * @returns {string} The transcoded string.
+ */
 export const transcode = (s, tables, {missing} = {}) => {
   let fn;
   if (typeof tables == 'function') {

package/src/ansi/csi.d.ts

@@ -0,0 +1,141 @@
+export * from './sgr.js';
+
+/** RegExp matching CSI (Control Sequence Introducer) escape sequences. */
+export const matchCsi: RegExp;
+
+/** Moves cursor up 1 row. */
+export const CURSOR_UP1: string;
+/** Moves cursor down 1 row. */
+export const CURSOR_DOWN1: string;
+/** Moves cursor forward 1 column. */
+export const CURSOR_FORWARD1: string;
+/** Moves cursor back 1 column. */
+export const CURSOR_BACK1: string;
+/** Moves cursor to beginning of next line. */
+export const CURSOR_NEXT_LINE1: string;
+/** Moves cursor to beginning of previous line. */
+export const CURSOR_PREV_LINE1: string;
+/** Moves cursor to column 1. */
+export const CURSOR_COLUMN1: string;
+/** Moves cursor to home position (1,1). */
+export const CURSOR_HOME: string;
+
+/** Requests cursor position report. */
+export const CURSOR_GET_POS: string;
+/** Saves cursor position. */
+export const CURSOR_SAVE_POS: string;
+/** Restores saved cursor position. */
+export const CURSOR_RESTORE_POS: string;
+/** Shows the cursor. */
+export const CURSOR_NORMAL: string;
+/** Hides the cursor. */
+export const CURSOR_INVISIBLE: string;
+
+/** Moves the cursor up by `n` rows.
+ * @param n - Number of rows (default: 1).
+ * @returns CSI escape sequence.
+ */
+export function cursorUp(n?: number): string;
+/** Moves the cursor down by `n` rows.
+ * @param n - Number of rows (default: 1).
+ * @returns CSI escape sequence.
+ */
+export function cursorDown(n?: number): string;
+/** Moves the cursor forward by `n` columns.
+ * @param n - Number of columns (default: 1).
+ * @returns CSI escape sequence.
+ */
+export function cursorForward(n?: number): string;
+/** Moves the cursor back by `n` columns.
+ * @param n - Number of columns (default: 1).
+ * @returns CSI escape sequence.
+ */
+export function cursorBack(n?: number): string;
+/** Moves cursor to beginning of line `n` lines down.
+ * @param n - Number of lines (default: 1).
+ * @returns CSI escape sequence.
+ */
+export function cursorNextLine(n?: number): string;
+/** Moves cursor to beginning of line `n` lines up.
+ * @param n - Number of lines (default: 1).
+ * @returns CSI escape sequence.
+ */
+export function cursorPrevLine(n?: number): string;
+/** Moves cursor to column `n`.
+ * @param n - Column number (default: 1).
+ * @returns CSI escape sequence.
+ */
+export function cursorColumn(n?: number): string;
+/** Sets the cursor to row `n`, column `m` (1-based).
+ * @param n - Row.
+ * @param m - Column.
+ * @returns CSI escape sequence.
+ */
+export function cursorSetPos(n: number, m: number): string;
+/** Sets the cursor position (alternative sequence).
+ * @param n - Row.
+ * @param m - Column.
+ * @returns CSI escape sequence.
+ */
+export function cursorSetPosAlt(n: number, m: number): string;
+
+/** Alias for CURSOR_FORWARD1. */
+export const CURSOR_RIGHT1: string;
+/** Alias for CURSOR_BACK1. */
+export const CURSOR_LEFT1: string;
+/** Alias for cursorForward. */
+export const cursorRight: typeof cursorForward;
+/** Alias for cursorBack. */
+export const cursorLeft: typeof cursorBack;
+
+/** Clears from cursor to end of screen. */
+export const CLEAR_EOS: string;
+/** Clears from cursor to beginning of screen. */
+export const CLEAR_BOS: string;
+/** Clears the entire screen. */
+export const CLEAR_SCREEN: string;
+/** Clears the entire screen and scrollback buffer. */
+export const CLEAR_SCREEN_ALL: string;
+/** Clears from cursor to end of line. */
+export const CLEAR_EOL: string;
+/** Clears from cursor to beginning of line. */
+export const CLEAR_BOL: string;
+/** Clears the entire line. */
+export const CLEAR_LINE: string;
+
+/** Saves the screen state. */
+export const SCREEN_SAVE: string;
+/** Restores the screen state. */
+export const SCREEN_RESTORE: string;
+/** Enables the alternative screen buffer. */
+export const SCREEN_ALT_ON: string;
+/** Disables the alternative screen buffer. */
+export const SCREEN_ALT_OFF: string;
+/** Scrolls screen up 1 line. */
+export const SCREEN_SCROLL_UP1: string;
+/** Scrolls screen down 1 line. */
+export const SCREEN_SCROLL_DOWN1: string;
+/** Enables focus reporting. */
+export const SCREEN_REPORT_FOCUS_ON: string;
+/** Disables focus reporting. */
+export const SCREEN_REPORT_FOCUS_OFF: string;
+
+/** Scrolls the screen up by `n` lines.
+ * @param n - Number of lines (default: 1).
+ * @returns CSI escape sequence.
+ */
+export function screenScrollUp(n?: number): string;
+/** Scrolls the screen down by `n` lines.
+ * @param n - Number of lines (default: 1).
+ * @returns CSI escape sequence.
+ */
+export function screenScrollDown(n?: number): string;
+
+/** Enables line wrapping. */
+export const WRAPPING_ON: string;
+/** Disables line wrapping. */
+export const WRAPPING_OFF: string;
+/** Enables bracketed paste mode. */
+export const BRACKETED_PASTE_ON: string;
+/** Disables bracketed paste mode. */
+export const BRACKETED_PASTE_OFF: string;

package/src/ansi/csi.js

@@ -7,6 +7,9 @@
 export * from './sgr.js';
 
 // matcher
+/** RegExp matching CSI (Control Sequence Introducer) escape sequences with parameter, intermediate, and final byte groups.
+ * @type {RegExp}
+ */
 export const matchCsi = /\x1B\[([\x30-\x3F]*)([\x20-\x2F]*)([\x40-\x7E])/g;
 
 const CSI = '\x1B[';
@@ -26,14 +29,52 @@ export const CURSOR_RESTORE_POS = CSI + 'u';
 export const CURSOR_NORMAL = CSI + '?25h';
 export const CURSOR_INVISIBLE = CSI + '?25l';
 
+/** Moves the cursor up by `n` rows.
+ * @param {number} [n=1]
+ * @returns {string} CSI sequence.
+ */
 export const cursorUp = (n = 1) => CSI + (n > 1 ? n.toFixed() : '') + 'A';
+/** Moves the cursor down by `n` rows.
+ * @param {number} [n=1]
+ * @returns {string} CSI sequence.
+ */
 export const cursorDown = (n = 1) => CSI + (n > 1 ? n.toFixed() : '') + 'B';
+/** Moves the cursor forward by `n` columns.
+ * @param {number} [n=1]
+ * @returns {string} CSI sequence.
+ */
 export const cursorForward = (n = 1) => CSI + (n > 1 ? n.toFixed() : '') + 'C';
+/** Moves the cursor back by `n` columns.
+ * @param {number} [n=1]
+ * @returns {string} CSI sequence.
+ */
 export const cursorBack = (n = 1) => CSI + (n > 1 ? n.toFixed() : '') + 'D';
+/** Moves cursor to beginning of line `n` lines down.
+ * @param {number} [n=1]
+ * @returns {string} CSI sequence.
+ */
 export const cursorNextLine = (n = 1) => CSI + (n > 1 ? n.toFixed() : '') + 'E';
+/** Moves cursor to beginning of line `n` lines up.
+ * @param {number} [n=1]
+ * @returns {string} CSI sequence.
+ */
 export const cursorPrevLine = (n = 1) => CSI + (n > 1 ? n.toFixed() : '') + 'F';
+/** Moves cursor to column `n`.
+ * @param {number} [n=1]
+ * @returns {string} CSI sequence.
+ */
 export const cursorColumn = (n = 1) => CSI + (n > 1 ? n.toFixed() : '') + 'G';
+/** Sets the cursor to row `n`, column `m` (1-based).
+ * @param {number} n - Row.
+ * @param {number} m - Column.
+ * @returns {string} CSI sequence.
+ */
 export const cursorSetPos = (n, m) => CSI + (n > 1 ? n.toFixed() : '') + ';' + (m > 1 ? m.toFixed() : '') + 'H';
+/** Sets the cursor position (alternative HVP sequence).
+ * @param {number} n - Row.
+ * @param {number} m - Column.
+ * @returns {string} CSI sequence.
+ */
 export const cursorSetPosAlt = (n, m) => CSI + (n > 1 ? n.toFixed() : '') + ';' + (m > 1 ? m.toFixed() : '') + 'f'; // HVP
 
 export const CURSOR_RIGHT1 = CURSOR_FORWARD1;
@@ -53,12 +94,20 @@ export const SCREEN_SAVE = CSI + '?47h';
 export const SCREEN_RESTORE = CSI + '?47l';
 export const SCREEN_ALT_ON = CSI + '?1049h'; // alternative screen buffer
 export const SCREEN_ALT_OFF = CSI + '?1049l';
-export const SCREEN_SCROLL_UP1 = CSI + 'S'
-export const SCREEN_SCROLL_DOWN1 = CSI + 'T'
+export const SCREEN_SCROLL_UP1 = CSI + 'S';
+export const SCREEN_SCROLL_DOWN1 = CSI + 'T';
 export const SCREEN_REPORT_FOCUS_ON = CSI + '?1004h';
 export const SCREEN_REPORT_FOCUS_OFF = CSI + '?1004l';
 
+/** Scrolls the screen up by `n` lines.
+ * @param {number} [n=1]
+ * @returns {string} CSI sequence.
+ */
 export const screenScrollUp = (n = 1) => CSI + (n > 1 ? n.toFixed() : '') + 'S';
+/** Scrolls the screen down by `n` lines.
+ * @param {number} [n=1]
+ * @returns {string} CSI sequence.
+ */
 export const screenScrollDown = (n = 1) => CSI + (n > 1 ? n.toFixed() : '') + 'T';
 
 export const WRAPPING_ON = CSI + '=7h';

package/src/ansi/index.d.ts

@@ -0,0 +1,26 @@
+export * from './csi.js';
+
+/** The ESC character (\x1B). */
+export const ESC: string;
+
+/** Deletes the character at the cursor. */
+export const CURSOR_DELETE: string;
+
+/** Moves cursor up 1 row (Fe sequence). */
+export const CURSOR_GO_UP1: string;
+
+/** Saves cursor position (Fe sequence). */
+export const CURSOR_SAVE: string;
+/** Restores cursor position (Fe sequence). */
+export const CURSOR_RESTORE: string;
+
+/** RegExp matching Fe escape sequences. */
+export const matchFe: RegExp;
+/** RegExp matching Fs escape sequences. */
+export const matchFs: RegExp;
+/** RegExp matching Fp escape sequences. */
+export const matchFp: RegExp;
+/** RegExp matching Nf escape sequences. */
+export const matchNf: RegExp;
+/** RegExp matching OSC escape sequences. */
+export const matchOsc: RegExp;