@travetto/terminal 3.4.0-rc.0 → 4.0.0-rc.0

package/src/named-colors.ts

@@ -1,160 +0,0 @@
-export const NAMED_COLORS = {
-  // Name: RGB
-  stdBlack: 0x000000,
-  stdRed: 0xcd0000,
-  stdGreen: 0x00cd00,
-  stdYellow: 0xcdcd00,
-  stdBlue: 0x0000ee,
-  stdMagenta: 0xcd00cd,
-  stdCyan: 0x00cdcd,
-  stdWhite: 0xe5e5e5,
-  brightBlack: 0x7f7f7f,
-  brightRed: 0xff0000,
-  brightGreen: 0x00fc00,
-  brightYellow: 0xffff00,
-  brightBlue: 0x0000fc,
-  brightMagenta: 0xff00ff,
-  brightCyan: 0x00ffff,
-  brightWhite: 0xffffff,
-
-  aliceBlue: 0xf0f8ff,
-  antiqueWhite: 0xfaebd7,
-  aqua: 0x00ffff,
-  aquamarine: 0x7fffd4,
-  azure: 0xf0ffff,
-  beige: 0xf5f5dc,
-  bisque: 0xffe4c4,
-  black: 0x000000,
-  blanchedAlmond: 0xffebcd,
-  blue: 0x0000ff,
-  blueViolet: 0x8a2be2,
-  brown: 0xa52a2a,
-  burlyWood: 0xdeb887,
-  cadetBlue: 0x5f9ea0,
-  chartreuse: 0x7fff00,
-  chocolate: 0xd2691e,
-  coral: 0xff7f50,
-  cornflowerBlue: 0x6495ed,
-  cornSilk: 0xfff8dc,
-  crimson: 0xdc143c,
-  cyan: 0x00ffff,
-  darkBlue: 0x00008b,
-  darkCyan: 0x008b8b,
-  darkGoldenrod: 0xb8860b,
-  darkGray: 0xa9a9a9,
-  darkGreen: 0x006400,
-  darkKhaki: 0xbdb76b,
-  darkMagenta: 0x8b008b,
-  darkOliveGreen: 0x556b2f,
-  darkOrange: 0xff8c00,
-  darkOrchid: 0x9932cc,
-  darkRed: 0x8b0000,
-  darkSalmon: 0xe9967a,
-  darkSeaGreen: 0x8fbc8f,
-  darkSlateBlue: 0x483d8b,
-  darkSlateGray: 0x2f4f4f,
-  darkTurquoise: 0x00ced1,
-  darkViolet: 0x9400d3,
-  deepPink: 0xff1493,
-  deepSkyBlue: 0x00bfff,
-  dimGray: 0x696969,
-  dodgerBlue: 0x1e90ff,
-  firebrick: 0xb22222,
-  floralWhite: 0xfffaf0,
-  forestGreen: 0x228b22,
-  fuchsia: 0xff00ff,
-  gainsboro: 0xdcdcdc,
-  ghostWhite: 0xf8f8ff,
-  gold: 0xffd700,
-  goldenrod: 0xdaa520,
-  gray: 0x808080,
-  green: 0x008000,
-  greenYellow: 0xadff2f,
-  honeydew: 0xf0fff0,
-  hotPink: 0xff69b4,
-  indianRed: 0xcd5c5c,
-  indigo: 0x4b0082,
-  ivory: 0xfffff0,
-  khaki: 0xf0e68c,
-  lavender: 0xe6e6fa,
-  lavenderBlush: 0xfff0f5,
-  lawnGreen: 0x7cfc00,
-  lemonChiffon: 0xfffacd,
-  lightBlue: 0xadd8e6,
-  lightCoral: 0xf08080,
-  lightCyan: 0xe0ffff,
-  lightGoldenRodYellow: 0xfafad2,
-  lightGray: 0xd3d3d3,
-  lightGreen: 0x90ee90,
-  lightPink: 0xffb6c1,
-  lightSalmon: 0xffa07a,
-  lightSeaGreen: 0x20b2aa,
-  lightSkyBlue: 0x87cefa,
-  lightSlateGray: 0x778899,
-  lightSteelBlue: 0xb0c4de,
-  lightYellow: 0xffffe0,
-  lime: 0x00ff00,
-  limeGreen: 0x32cd32,
-  linen: 0xfaf0e6,
-  magenta: 0xff00ff,
-  maroon: 0x800000,
-  mediumAquamarine: 0x66cdaa,
-  mediumBlue: 0x0000cd,
-  mediumOrchid: 0xba55d3,
-  mediumPurple: 0x9370db,
-  mediumSeaGreen: 0x3cb371,
-  mediumSlateBlue: 0x7b68ee,
-  mediumSpringGreen: 0x00fa9a,
-  mediumTurquoise: 0x48d1cc,
-  mediumVioletRed: 0xc71585,
-  midnightBlue: 0x191970,
-  mintCream: 0xf5fffa,
-  mistyRose: 0xffe4e1,
-  moccasin: 0xffe4b5,
-  navajoWhite: 0xffdead,
-  navy: 0x000080,
-  oldLace: 0xfdf5e6,
-  olive: 0x808000,
-  oliveDrab: 0x6b8e23,
-  orange: 0xffa500,
-  orangeRed: 0xff4500,
-  orchid: 0xda70d6,
-  paleGoldenrod: 0xeee8aa,
-  paleGreen: 0x98fb98,
-  paleTurquoise: 0xafeeee,
-  paleVioletRed: 0xdb7093,
-  papayaWhip: 0xffefd5,
-  peachPuff: 0xffdab9,
-  peru: 0xcd853f,
-  pink: 0xffc0cb,
-  plum: 0xdda0dd,
-  powderBlue: 0xb0e0e6,
-  purple: 0x800080,
-  red: 0xff0000,
-  rosyBrown: 0xbc8f8f,
-  royalBlue: 0x4169e1,
-  saddleBrown: 0x8b4513,
-  salmon: 0xfa8072,
-  sandyBrown: 0xf4a460,
-  seaGreen: 0x2e8b57,
-  seashell: 0xfff5ee,
-  sienna: 0xa0522d,
-  silver: 0xc0c0c0,
-  skyBlue: 0x87ceeb,
-  slateBlue: 0x6a5acd,
-  slateGray: 0x708090,
-  snow: 0xfffafa,
-  springGreen: 0x00ff7f,
-  steelBlue: 0x4682b4,
-  tan: 0xd2b48c,
-  teal: 0x008080,
-  thistle: 0xd8bfd8,
-  tomato: 0xff6347,
-  turquoise: 0x40e0d0,
-  violet: 0xee82ee,
-  wheat: 0xf5deb3,
-  white: 0xffffff,
-  whitesmoke: 0xf5f5f5,
-  yellow: 0xffff00,
-  yellowGreen: 0x9acd32,
-} as const;

package/src/operation.ts

@@ -1,158 +0,0 @@
-import { IterableUtil } from './iterable';
-import { TerminalWriter } from './writer';
-import { Indexed, TerminalProgressRender, TerminalStreamingConfig, TerminalWaitingConfig, TermState } from './types';
-import { ColorOutputUtil, TermStyleInput } from './color-output';
-
-const STD_WAIT_STATES = '⠋⠙⠹⠸⠼⠴⠦⠧⠇⠏'.split('');
-
-/**
- * Standard Terminal Operations
- */
-export class TerminalOperation {
-
-  static truncateIfNeeded(term: TermState, text: string, suffix = '...'): string {
-    if (text.length > term.width) {
-      return `${text.substring(0, term.width - suffix.length)}${suffix}`;
-    }
-    return text;
-  }
-
-  /**
-   * Allows for writing at top, bottom, or current position while new text is added
-   */
-  static async streamToPosition(term: TermState, source: AsyncIterable<string>, config: TerminalStreamingConfig = {}): Promise<void> {
-    const curPos = config.at ?? { ...await term.getCursorPosition() };
-    const pos = config.position ?? 'inline';
-
-    const writePos = pos === 'inline' ?
-      { ...curPos, x: 0 } :
-      { x: 0, y: pos === 'top' ? 0 : -1 };
-
-    try {
-      const batch = TerminalWriter.for(term).hideCursor();
-      if (pos !== 'inline') {
-        batch.storePosition().scrollRange(pos === 'top' ? { start: 2 } : { end: -2 }).restorePosition();
-        if (pos === 'top' && curPos.y === 0) {
-          batch.changePosition({ y: 1 }).write('');
-        } else if (pos === 'bottom' && curPos.y === term.height - 1) {
-          batch.changePosition({ y: -1 }).write('\n');
-        }
-      } else {
-        batch.write('\n'); // Move past line
-      }
-      await batch.commit();
-
-      let start = Date.now();
-      const minDelay = config.minDelay ?? 0;
-
-      let line: string = '';
-      for await (const text of source) {
-        line = text;
-        if ((Date.now() - start) >= minDelay) {
-          start = Date.now();
-          await TerminalWriter.for(term).setPosition(writePos).write(line).clearLine(1).commit(true);
-          line = '';
-        }
-      }
-
-      if (line) {
-        await TerminalWriter.for(term).setPosition(writePos).write(line).clearLine(1).commit(true);
-      }
-
-      if (config.clearOnFinish ?? true) {
-        await TerminalWriter.for(term).setPosition(writePos).clearLine().commit(true);
-      }
-    } finally {
-      const finalCursor = await term.getCursorPosition();
-      await TerminalWriter.for(term).scrollRangeClear().setPosition(finalCursor).showCursor().commit();
-    }
-  }
-
-  /**
-   * Consumes a stream, of events, tied to specific list indices, and updates in place
-   */
-  static async streamList(term: TermState, source: AsyncIterable<Indexed & { text: string }>): Promise<void> {
-    let max = 0;
-    try {
-      await TerminalWriter.for(term).hideCursor().commit();
-      for await (const { idx, text } of source) {
-        max = Math.max(idx, max);
-        await TerminalWriter.for(term).write('\n'.repeat(idx)).rewriteLine(text).clearLine(1).changePosition({ y: -idx }).commit();
-      }
-    } finally {
-      await TerminalWriter.for(term).changePosition({ y: max + 1 }).writeLine('\n').showCursor().commit();
-    }
-  }
-
-  /**
-   * Waiting indicator, streamed to a specific position, can be canceled
-   */
-  static streamWaiting(term: TermState, message: string, config: TerminalWaitingConfig = {}): () => Promise<void> {
-    const { stop, stream } = IterableUtil.cycle(STD_WAIT_STATES);
-    const indicator = IterableUtil.map(
-      stream,
-      IterableUtil.DELAY(config),
-      (ch, i) => config.end ? `${message} ${ch}` : `${ch} ${message}`
-    );
-
-    const final = this.streamToPosition(term, indicator, config);
-    return async () => { stop(); return final; };
-  }
-
-  /**
-   * Build progress par formatter for terminal progress events
-   */
-  static buildProgressBar(term: TermState, style: TermStyleInput): TerminalProgressRender {
-    const color = ColorOutputUtil.colorer(term, style);
-    return ({ total, idx, text }): string => {
-      text ||= total ? '%idx/%total' : '%idx';
-
-      const totalStr = `${total ?? ''}`;
-      const idxStr = `${idx}`.padStart(totalStr.length);
-      const pct = total === undefined ? 0 : (idx / total);
-      const line = text
-        .replace(/%idx/, idxStr)
-        .replace(/%total/, totalStr)
-        .replace(/%pct/, `${Math.trunc(pct * 100)}`);
-      const full = this.truncateIfNeeded(term, ` ${line}`.padEnd(term.width));
-      const mid = Math.trunc(pct * term.width);
-      const [l, r] = [full.substring(0, mid), full.substring(mid)];
-      return `${color(l)}${r}`;
-    };
-  }
-
-  /**
-   * Stream lines with a waiting indicator
-   */
-  static async streamLinesWithWaiting(term: TermState, lines: AsyncIterable<string | undefined>, cfg: TerminalWaitingConfig = {}): Promise<void> {
-    let writer: (() => Promise<unknown>) | undefined;
-    let line: string | undefined;
-
-    let pos = await term.getCursorPosition();
-
-
-    const commitLine = async (): Promise<void> => {
-      await writer?.();
-      if (line) {
-        const msg = cfg.committedPrefix ? `${cfg.committedPrefix} ${line}` : line;
-        if (cfg.position === 'inline') {
-          await TerminalWriter.for(term).setPosition(pos).write(msg).commit(true);
-        } else {
-          await TerminalWriter.for(term).writeLine(msg).commit();
-        }
-        line = undefined;
-      }
-    };
-
-    for await (let msg of lines) {
-      await commitLine();
-      if (msg !== undefined) {
-        msg = msg.replace(/\n$/, '');
-        pos = await term.getCursorPosition();
-        writer = this.streamWaiting(term, this.truncateIfNeeded(term, msg), { ...cfg, at: pos, clearOnFinish: false });
-        line = msg;
-      }
-    }
-    await commitLine();
-  }
-}

package/src/query.ts

@@ -1,94 +0,0 @@
-import type tty from 'tty';
-import { spawn } from 'child_process';
-
-import { ANSICodes } from './codes';
-import { IterableUtil } from './iterable';
-import { RGB, TermCoord, TermQuery } from './types';
-
-const to256 = (x: string): number => Math.trunc(parseInt(x, 16) / (16 ** (x.length - 2)));
-const COLOR_RESPONSE = /(?<r>][0-9a-f]+)[/](?<g>[0-9a-f]+)[/](?<b>[0-9a-f]+)[/]?(?<a>[0-9a-f]+)?/i;
-
-const queryScript = (function (...bytes: number[]): void {
-  const i = process.stdin;
-  i.setRawMode(true);
-  i.resume();
-  i.once('readable', function () {
-    const inp = i.read();
-    /* @ts-expect-error */
-    process.send(Buffer.isBuffer(inp) ? inp.toString('utf8') : inp);
-    i.setRawMode(false);
-  });
-  process.stdout.write(String.fromCharCode(...bytes));
-});
-
-const runQuery = async (input: tty.ReadStream, output: tty.WriteStream, code: string): Promise<Buffer> => {
-  const script = queryScript.toString().replaceAll('\'', '"').replaceAll('\n', '');
-  const fullScript = `(${script})(${code.split('').map(x => x.charCodeAt(0))})`;
-  const proc = spawn(process.argv0, ['-e', fullScript], { stdio: [input, output, 2, 'ipc'], detached: true });
-  const text = await new Promise<string>((res, rej) => {
-    proc.once('message', res);
-    proc.on('error', rej);
-  });
-  return Buffer.from(text, 'utf8');
-};
-
-const ANSIQueries = {
-  /** Parse xterm color response */
-  color: (field: 'background' | 'foreground'): TermQuery<RGB | undefined> => ({
-    query: (): string => ANSICodes.OSC_QUERY(`${field}Color`),
-    response: (response: Buffer): RGB | undefined => {
-      const groups = response.toString('utf8').match(COLOR_RESPONSE)?.groups ?? {};
-      return 'r' in groups ? [to256(groups.r), to256(groups.g), to256(groups.b)] : undefined;
-    }
-  }),
-  /** Parse cursor query response into {x,y} */
-  cursorPosition: {
-    query: (): string => ANSICodes.DEVICE_STATUS_REPORT('cursorPosition'),
-    response: (response: Buffer): TermCoord => {
-      const groups = response.toString('utf8').match(/(?<r>\d*);(?<c>\d*)/)?.groups ?? {};
-      return 'c' in groups ? { x: +(groups.c) - 1, y: +(groups.r) - 1 } : { x: 0, y: 0 };
-    }
-  }
-};
-
-/**
- * Terminal query support with centralized queuing for multiple writes to the same stream
- */
-export class TerminalQuerier {
-
-  static #cache = new Map<tty.ReadStream, TerminalQuerier>();
-
-  static for(input: tty.ReadStream, output: tty.WriteStream): TerminalQuerier {
-    if (!this.#cache.has(input)) {
-      this.#cache.set(input, new TerminalQuerier(input, output));
-    }
-    return this.#cache.get(input)!;
-  }
-
-  #queue = IterableUtil.simpleQueue();
-  #output: tty.WriteStream;
-  #input: tty.ReadStream;
-  #restore?: () => void;
-
-  constructor(input: tty.ReadStream, output: tty.WriteStream) {
-    this.#input = input;
-    this.#output = output;
-  }
-
-  query<T>(q: TermQuery<T>): Promise<T> {
-    return this.#queue.add(() => runQuery(this.#input, this.#output, q.query()).then(q.response));
-  }
-
-  cursorPosition(): Promise<TermCoord> {
-    return this.query(ANSIQueries.cursorPosition);
-  }
-
-  backgroundColor(): Promise<RGB | undefined> {
-    return this.query(ANSIQueries.color('background'));
-  }
-
-  close(): void {
-    this.#restore?.();
-    this.#queue.close();
-  }
-}

package/src/types.ts

@@ -1,33 +0,0 @@
-import tty from 'tty';
-
-export type Indexed = { idx: number };
-export type DelayedConfig = { initialDelay?: number, cycleDelay?: number };
-
-type I = number;
-export type RGB = [r: I, g: I, b: I] | (readonly [r: I, g: I, b: I]);
-export type TermCoord = { x: number, y: number };
-export type TermLinePosition = 'top' | 'bottom' | 'inline';
-export type TermColorField = 'foregroundColor' | 'backgroundColor';
-
-export type TerminalTableEvent = { idx: number, text: string, done?: boolean };
-export type TerminalTableConfig = { header?: string[], forceNonInteractiveOrder?: boolean };
-export type TerminalProgressEvent = { idx: number, total?: number, text?: string };
-export type TerminalProgressRender = (ev: TerminalProgressEvent) => string;
-export type TerminalStreamingConfig = { position?: TermLinePosition, clearOnFinish?: boolean, at?: TermCoord, minDelay?: number };
-export type TerminalWaitingConfig = { end?: boolean, committedPrefix?: string } & TerminalStreamingConfig & DelayedConfig;
-
-export type TermColorLevel = 0 | 1 | 2 | 3;
-export type TermColorScheme = 'dark' | 'light';
-
-export type TermState = {
-  interactive: boolean;
-  height: number;
-  width: number;
-  input: tty.ReadStream;
-  output: tty.WriteStream;
-  colorLevel: TermColorLevel;
-  backgroundScheme: TermColorScheme;
-  getCursorPosition(): Promise<TermCoord>;
-};
-
-export type TermQuery<T> = { query: () => string, response: (inp: Buffer) => T };