@travetto/terminal 7.0.3 → 7.0.4

package/README.md

@@ -30,22 +30,24 @@ These palettes then are usable at runtime, with the module determining light or
 
 **Code: CLI Color Palette**
 ```typescript
-import { StyleUtil } from '@travetto/terminal';
-
-export const cliTpl = StyleUtil.getTemplate({
-  input: '#6b8e23', // Olive drab
-  output: '#ffc0cb', // Pink
-  path: '#008080', // Teal
-  success: '#00ff00', // Green
-  failure: '#ff0000', // Red
+import { StyleUtil, type TermStyledTemplate } from '@travetto/terminal';
+
+const input = {
+  input: ['#6b8e23'], // Olive drab
+  output: ['#ffc0cb'], // Pink
+  path: ['#008080'], // Teal
+  success: ['#00ff00'], // Green
+  failure: ['#ff0000'], // Red
   param: ['#ffff00', '#daa520'], // Yellow / Goldenrod
-  type: '#00ffff', // Teal
+  type: ['#00ffff'], // Teal
   description: ['#e5e5e5', '#808080'], // White / Gray
   title: ['#ffffff', '#000000'], // Bright white / black
-  identifier: '#1e90ff', // Dodger blue
+  identifier: ['#1e90ff'], // Dodger blue
   subtitle: ['#d3d3d3', '#a9a9a9'], // Light gray / Dark Gray
-  subsubtitle: '#a9a9a9' // Dark gray
-});
+  subsubtitle: ['#a9a9a9'] // Dark gray
+} as const;
+
+export const cliTpl: TermStyledTemplate<keyof typeof input> = StyleUtil.getTemplate(input);
 ```
 
 When the color palette is combined with [Runtime](https://github.com/travetto/travetto/tree/main/module/runtime#readme "Runtime for travetto applications.")'s Util.makeTemplate, you produce a string template function that will automatically colorize:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/terminal",
-  "version": "7.0.3",
+  "version": "7.0.4",
   "type": "module",
   "description": "General terminal support",
   "keywords": [
@@ -25,7 +25,7 @@
     "directory": "module/terminal"
   },
   "dependencies": {
-    "@travetto/runtime": "^7.0.3",
+    "@travetto/runtime": "^7.0.4",
     "chalk": "^5.6.2"
   },
   "travetto": {

package/src/style.ts

@@ -5,19 +5,48 @@ import { Env, TypedObject } from '@travetto/runtime';
 type TemplatePrim = number | string | bigint | boolean | RegExp;
 type Color = `#${string}`;
 export type TermStyleInput = Color | { text: Color, background?: Color, inverse?: boolean, bold?: boolean, italic?: boolean, underline?: boolean };
-type TermStylePairInput = TermStyleInput | [dark: TermStyleInput, light: TermStyleInput];
+type TermStylePairInput = [dark: TermStyleInput, light?: TermStyleInput] | readonly [dark: TermStyleInput, light?: TermStyleInput];
 export type TermStyleFn = (input: TemplatePrim) => string;
-type TermStyledTemplate<T extends string> = (values: TemplateStringsArray, ...keys: (Partial<Record<T, TemplatePrim>> | string)[]) => string;
+export type TermStyledTemplate<T extends string> = (values: TemplateStringsArray, ...keys: (Partial<Record<T, TemplatePrim>> | string)[]) => string;
 export type ColorLevel = 0 | 1 | 2 | 3;
 
-const DARK_ANSI_256 = new Set([
-  0, 1, 2, 3, 4, 5, 6, 16, 17, 18, 19, 20, 22, 23, 24, 25, 26, 28, 29, 30, 31, 32, 34, 35, 36, 37, 38, 40, 41, 42, 43, 44, 52, 53, 54,
-  55, 56, 58, 59, 60, 64, 65, 66, 70, 76, 88, 89, 90, 91, 92, 94, 95, 96, 100, 101, 106, 112, 124, 125, 126, 127, 128, 130, 136, 142,
-  148, 160, 161, 162, 163, 164, 166, 172, 178, 184, 232, 233, 234, 235, 236, 237, 238, 239, 240, 241, 242, 243
-]);
+const ANSI_16_RGB: [number, number, number][] = [
+  [0, 0, 0], [128, 0, 0], [0, 128, 0], [128, 128, 0],
+  [0, 0, 128], [128, 0, 128], [0, 128, 128], [192, 192, 192],
+  [128, 128, 128], [255, 0, 0], [0, 255, 0], [255, 255, 0],
+  [0, 0, 255], [255, 0, 255], [0, 255, 255], [255, 255, 255]
+];
+
+const toLinear = (v: number): number => {
+  const s = v / 255;
+  return s <= 0.03928 ? s / 12.92 : ((s + 0.055) / 1.055) ** 2.4;
+};
 
 export class StyleUtil {
 
+  /** Compute RGB values for ANSI 256 color code */
+  static computeRGBForAnsi256(code: number): [number, number, number] {
+    if (code < 16) {
+      return ANSI_16_RGB[code];
+    } else if (code <= 231) {
+      const cubeIdx = code - 16;
+      const levels = [0, 95, 135, 175, 215, 255];
+      const ri = Math.floor(cubeIdx / 36);
+      const gi = Math.floor((cubeIdx % 36) / 6);
+      const bi = cubeIdx % 6;
+      return [levels[ri], levels[gi], levels[bi]];
+    } else {
+      const gray = 8 + (code - 232) * 10;
+      return [gray, gray, gray];
+    }
+  }
+
+  /** Compute Luminosity for ANSI 256 color code */
+  static computeAnsi256Luminosity(code: number): number {
+    const [r, g, b] = this.computeRGBForAnsi256(code);
+    return 0.2126 * toLinear(r) + 0.7152 * toLinear(g) + 0.0722 * toLinear(b);
+  }
+
   static #scheme: { key: string, dark: boolean } = { key: '', dark: true };
 
   /**
@@ -50,7 +79,7 @@ export class StyleUtil {
     }
 
     const [, bg = '0'] = key.split(';');
-    const dark = DARK_ANSI_256.has(+bg);
+    const dark = this.computeAnsi256Luminosity(+bg) < 0.4;
     Object.assign(this.#scheme, { key, dark });
     return dark;
   }
@@ -59,7 +88,7 @@ export class StyleUtil {
    * Create renderer from input source
    */
   static getThemedStyle(input: TermStylePairInput): TermStyleFn {
-    const [dark, light] = (Array.isArray(input) ? input : [input]);
+    const [dark, light] = input;
     const isDark = this.isBackgroundDark();
     return isDark ? this.getStyle(dark) : this.getStyle(light ?? dark);
   }

package/src/terminal.ts

@@ -1,4 +1,4 @@
-import tty from 'node:tty';
+import type tty from 'node:tty';
 
 import { Env, Util } from '@travetto/runtime';
 

package/src/util.ts

@@ -1,5 +1,5 @@
-import { StyleUtil, TermStyleFn, TermStyleInput } from './style.ts';
-import { Terminal, WAIT_TOKEN } from './terminal.ts';
+import { StyleUtil, type TermStyleFn, type TermStyleInput } from './style.ts';
+import { type Terminal, WAIT_TOKEN } from './terminal.ts';
 
 type ProgressEvent<T> = { total?: number, idx: number, value: T };
 type ProgressStyle = { complete: TermStyleFn, incomplete?: TermStyleFn };

package/src/writer.ts

@@ -1,4 +1,4 @@
-import tty from 'node:tty';
+import type tty from 'node:tty';
 
 import { ShutdownManager } from '@travetto/runtime';