@visulima/colorize 1.4.26 → 1.4.28

package/dist/template.mjs

@@ -1,2 +1,138 @@
-var y=Object.defineProperty;var i=(e,t)=>y(e,"name",{value:t,configurable:!0});import{m as x}from"./packem_shared/colorize.server-BkwhBIE0.mjs";import{convertHexToRgb as m}from"./packem_shared/convertHexToRgb-DGcGUKnj.mjs";var T=Object.defineProperty,j=i((e,t)=>T(e,"name",{value:t,configurable:!0}),"n");const d=j(e=>(t,...r)=>{if(!Array.isArray(t)||!Array.isArray(t.raw))throw new TypeError("A tagged template literal must be provided");const a=[t.raw[0]];for(let n=1;n<t.raw.length;n++)a.push(String(r[n-1]).replaceAll(/[{}\\]/g,String.raw`\$&`),String(t.raw[n]));return e(a.join(""))},"makeColorizeTemplate");var A=Object.defineProperty,$=i((e,t)=>A(e,"name",{value:t,configurable:!0}),"e");const k=new Map([["0","\0"],["\\","\\"],["a","\x07"],["b","\b"],["e","\x1B"],["f","\f"],["n",`
-`],["r","\r"],["t","	"],["v","\v"]]),b=$(e=>{const t=e.startsWith("u"),r=e[1]==="{";return t&&!r&&e.length===5||e.startsWith("x")&&e.length===3?String.fromCodePoint(Number.parseInt(e.slice(1),16)):t&&r?String.fromCodePoint(Number.parseInt(e.slice(2,-1),16)):k.get(e)??e},"unescape");var S=Object.defineProperty,u=i((e,t)=>S(e,"name",{value:t,configurable:!0}),"u");const E=/\\(u(?:[a-f\d]{4}|\{[a-f\d]{1,6}\})|x[a-f\d]{2}|.)|\{(~)?(#?[\w:]+(?:\([^)]*\))?(?:\.#?[\w:]+(?:\([^)]*\))?)*)(?:[ \t]|(?=\r?\n))|(\})|((?:.|[\r\n\f])+?)/gi,g=/(?:^|\.)(?:(\w+)(?:\(([^)]*)\))?|#(?=[:a-f\d]{2,})([a-f\d]{6})?(?::([a-f\d]{6}))?)/gi,N=/^(['"])((?:\\.|(?!\1)[^\\])*)\1$/,P=/\\(u(?:[a-f\d]{4}|\{[a-f\d]{1,6}\})|x[a-f\d]{2}|.)|([^\\])/gi,O=u((e,t)=>{const r=[],a=t.trim().split(/\s*,\s*/);let n;for(const s of a){const o=Number(s);if(!Number.isNaN(o))r.push(o);else if(n=N.exec(s))r.push(n[2].replace(P,(f,l,p)=>l?b(l):p));else throw new Error(`Invalid template style argument: ${s} (in style '${e}')`)}return r},"parseArguments"),C=u(e=>{g.lastIndex=0;const t=[];let r;for(;(r=g.exec(e))!==null;){const a=r[1];r[2]?t.push([a,...O(a,r[2])]):r[3]||r[4]?(r[3]&&t.push(["rgb",...m(r[3])]),r[4]&&t.push(["bgRgb",...m(r[4])])):t.push([a])}return t},"parseStyle"),h=u((e,t)=>{const r={};for(const n of t)for(const s of n.styles)r[s[0]]=n.inverse?null:s.slice(1);let a=e;for(const[n,s]of Object.entries(r))if(Array.isArray(s)){if(!(n in a))throw new Error(`Unknown style: ${n}`);a=s.length>0?a[n](...s):a[n]}return a},"buildStyle"),w=u(e=>t=>{const r=[],a=[];let n=[];if(t.replaceAll(E,(s,o,f,l,p,v)=>{if(o)n.push(b(o));else if(l){const c=n.join("");n=[],a.push(r.length===0?c:h(e,r)(c)),r.push({inverse:f,styles:C(l)})}else if(p){if(r.length===0)throw new Error("Found extraneous } in template literal");a.push(h(e,r)(n.join(""))),n=[],r.pop()}else n.push(v)}),a.push(n.join("")),r.length>0)throw new Error(`template literal is missing ${r.length} closing bracket${r.length===1?"":"s"} (\`}\`)`);return a.join("")},"makeTemplate");var I=Object.defineProperty,z=i((e,t)=>I(e,"name",{value:t,configurable:!0}),"o");const R=new x,M=z(e=>d(w(e)),"makeTaggedTemplate"),W=w(R),U=d(W);export{U as default,M as makeTaggedTemplate,W as template};
+import { C as Colorize } from './packem_shared/colorize.server-ry9FZNfG.mjs';
+import { convertHexToRgb } from './packem_shared/convertHexToRgb-CWdAm2kE.mjs';
+
+const makeColorizeTemplate = (template) => (firstString, ...arguments_) => {
+  if (!Array.isArray(firstString) || !Array.isArray(firstString.raw)) {
+    throw new TypeError("A tagged template literal must be provided");
+  }
+  const parts = [firstString.raw[0]];
+  for (let index = 1; index < firstString.raw.length; index++) {
+    parts.push(String(arguments_[index - 1]).replaceAll(/[{}\\]/g, String.raw`\$&`), String(firstString.raw[index]));
+  }
+  return template(parts.join(""));
+};
+
+const ESCAPES = /* @__PURE__ */ new Map([
+  ["0", "\0"],
+  ["\\", "\\"],
+  ["a", "\x07"],
+  ["b", "\b"],
+  ["e", "\x1B"],
+  ["f", "\f"],
+  ["n", "\n"],
+  ["r", "\r"],
+  ["t", "	"],
+  ["v", "\v"]
+]);
+const unescape = (c) => {
+  const u = c.startsWith("u");
+  const bracket = c[1] === "{";
+  if (u && !bracket && c.length === 5 || c.startsWith("x") && c.length === 3) {
+    return String.fromCodePoint(Number.parseInt(c.slice(1), 16));
+  }
+  if (u && bracket) {
+    return String.fromCodePoint(Number.parseInt(c.slice(2, -1), 16));
+  }
+  return ESCAPES.get(c) ?? c;
+};
+
+const TEMPLATE_REGEX = /\\(u(?:[a-f\d]{4}|\{[a-f\d]{1,6}\})|x[a-f\d]{2}|.)|\{(~)?(#?[\w:]+(?:\([^)]*\))?(?:\.#?[\w:]+(?:\([^)]*\))?)*)(?:[ \t]|(?=\r?\n))|(\})|((?:.|[\r\n\f])+?)/gi;
+const STYLE_REGEX = /(?:^|\.)(?:(\w+)(?:\(([^)]*)\))?|#(?=[:a-f\d]{2,})([a-f\d]{6})?(?::([a-f\d]{6}))?)/gi;
+const STRING_REGEX = /^(['"])((?:\\.|(?!\1)[^\\])*)\1$/;
+const ESCAPE_REGEX = /\\(u(?:[a-f\d]{4}|\{[a-f\d]{1,6}\})|x[a-f\d]{2}|.)|([^\\])/gi;
+const parseArguments = (name, value) => {
+  const results = [];
+  const chunks = value.trim().split(/\s*,\s*/);
+  let matches;
+  for (const chunk of chunks) {
+    const number = Number(chunk);
+    if (!Number.isNaN(number)) {
+      results.push(number);
+    } else if (matches = STRING_REGEX.exec(chunk)) {
+      results.push(matches[2].replace(ESCAPE_REGEX, (_, escape, character) => escape ? unescape(escape) : character));
+    } else {
+      throw new Error(`Invalid template style argument: ${chunk} (in style '${name}')`);
+    }
+  }
+  return results;
+};
+const parseStyle = (style) => {
+  STYLE_REGEX.lastIndex = 0;
+  const results = [];
+  let matches;
+  while ((matches = STYLE_REGEX.exec(style)) !== null) {
+    const name = matches[1];
+    if (matches[2]) {
+      results.push([name, ...parseArguments(name, matches[2])]);
+    } else if (matches[3] || matches[4]) {
+      if (matches[3]) {
+        results.push(["rgb", ...convertHexToRgb(matches[3])]);
+      }
+      if (matches[4]) {
+        results.push(["bgRgb", ...convertHexToRgb(matches[4])]);
+      }
+    } else {
+      results.push([name]);
+    }
+  }
+  return results;
+};
+const buildStyle = (colorize, styles) => {
+  const enabled = {};
+  for (const layer of styles) {
+    for (const style of layer.styles) {
+      enabled[style[0]] = layer.inverse ? null : style.slice(1);
+    }
+  }
+  let current = colorize;
+  for (const [styleName, enabledStyles] of Object.entries(enabled)) {
+    if (!Array.isArray(enabledStyles)) {
+      continue;
+    }
+    if (!(styleName in current)) {
+      throw new Error(`Unknown style: ${styleName}`);
+    }
+    current = enabledStyles.length > 0 ? current[styleName](...enabledStyles) : current[styleName];
+  }
+  return current;
+};
+const makeTemplate = (colorize) => (string) => {
+  const styles = [];
+  const chunks = [];
+  let chunk = [];
+  string.replaceAll(
+    TEMPLATE_REGEX,
+    // @ts-expect-error - TS doesn't understand that the regex args are defined
+    (_, escapeCharacter, inverse, style, close, character) => {
+      if (escapeCharacter) {
+        chunk.push(unescape(escapeCharacter));
+      } else if (style) {
+        const joinedChunk = chunk.join("");
+        chunk = [];
+        chunks.push(styles.length === 0 ? joinedChunk : buildStyle(colorize, styles)(joinedChunk));
+        styles.push({ inverse, styles: parseStyle(style) });
+      } else if (close) {
+        if (styles.length === 0) {
+          throw new Error("Found extraneous } in template literal");
+        }
+        chunks.push(buildStyle(colorize, styles)(chunk.join("")));
+        chunk = [];
+        styles.pop();
+      } else {
+        chunk.push(character);
+      }
+    }
+  );
+  chunks.push(chunk.join(""));
+  if (styles.length > 0) {
+    throw new Error(`template literal is missing ${styles.length} closing bracket${styles.length === 1 ? "" : "s"} (\`}\`)`);
+  }
+  return chunks.join("");
+};
+
+const colorize = new Colorize();
+const makeTaggedTemplate = (instance) => makeColorizeTemplate(makeTemplate(instance));
+const template = makeTemplate(colorize);
+const templateFunction = makeColorizeTemplate(template);
+
+export { templateFunction as default, makeTaggedTemplate, template };

package/dist/types.d.cts

@@ -0,0 +1,174 @@
+export type ColorValueHex = `#${string}`;
+export interface ColorizeType {
+    /**
+     * Return styled string.
+     * @param {string | TemplateStringsArray} string
+     */
+    (string: number | string): string;
+    (string: TemplateStringsArray, ...parameters: string[]): string;
+    /**
+     * Set [256-color ANSI code](https://en.wikipedia.org/wiki/ANSI_escape_code#8-bit) for foreground color.
+     *
+     * Code ranges:
+     * ```
+     * 0 -   7: standard colors
+     * 8 -  15: high intensity colors
+     * 16 - 231: 6 × 6 × 6 cube (216 colors)
+     * 232 - 255: grayscale from black to white in 24 steps
+     * ```
+     * @param {number} code in range [0, 255].
+     */
+    ansi256: (code: number) => this;
+    /**
+     * Alias for bgAnsi256.
+     * @param {number} code in range [0, 255].
+     */
+    bg: (code: number) => this;
+    /**
+     * Set [256-color ANSI code](https://en.wikipedia.org/wiki/ANSI_escape_code#8-bit) for background color.
+     *
+     * Code ranges:
+     * ```
+     * 0 -   7: standard colors
+     * 8 -  15: high intensity colors
+     * 16 - 231: 6 × 6 × 6 cube (216 colors)
+     * 232 - 255: grayscale from black to white in 24 steps
+     * ```
+     * @param {number} code in range [0, 255].
+     */
+    bgAnsi256: (code: number) => this;
+    readonly bgBlack: this;
+    readonly bgBlackBright: this;
+    readonly bgBlue: this;
+    readonly bgBlueBright: this;
+    readonly bgCyan: this;
+    readonly bgCyanBright: this;
+    readonly bgGray: this;
+    readonly bgGreen: this;
+    readonly bgGreenBright: this;
+    readonly bgGrey: this;
+    /**
+     * Set HEX value for background color.
+     * @param {string} hex
+     */
+    bgHex: (color: ColorValueHex) => this;
+    readonly bgMagenta: this;
+    readonly bgMagentaBright: this;
+    readonly bgRed: this;
+    readonly bgRedBright: this;
+    /**
+     * Set RGB values for background color.
+     * @param {number} red The red value, in range [0, 255].
+     * @param {number} green The green value, in range [0, 255].
+     * @param {number} blue The blue value, in range [0, 255].
+     */
+    bgRgb: (red: number, green: number, blue: number) => this;
+    readonly bgWhite: this;
+    readonly bgWhiteBright: this;
+    readonly bgYellow: this;
+    readonly bgYellowBright: this;
+    readonly black: this;
+    readonly blackBright: this;
+    readonly blue: this;
+    readonly blueBright: this;
+    /** <b>Bold</b> style (high intensity). */
+    readonly bold: this;
+    /** The ANSI escape sequences for ending the current style. */
+    readonly close: string;
+    readonly cyan: this;
+    readonly cyanBright: this;
+    /** Faint style (low intensity or dim). */
+    readonly dim: this;
+    /**
+     * Alias for ansi256.
+     * @param {number} code in range [0, 255].
+     */
+    fg: (code: number) => this;
+    readonly gray: this;
+    readonly green: this;
+    readonly greenBright: this;
+    readonly grey: this;
+    /**
+     * Set HEX value for foreground color.
+     * @param {string} hex
+     */
+    hex: (color: ColorValueHex) => this;
+    /** Print the invisible text. */
+    readonly hidden: this;
+    /** Invert background and foreground colors. */
+    readonly inverse: this;
+    /** <i>Italic</i> style. (Not widely supported) */
+    readonly italic: this;
+    readonly magenta: this;
+    readonly magentaBright: this;
+    /** The ANSI escape sequences for starting the current style. */
+    readonly open: string;
+    /** O̅v̅e̅r̅l̅i̅n̅e̅ style. (Not widely supported) */
+    readonly overline: this;
+    readonly red: this;
+    readonly redBright: this;
+    /** Reset the current style. */
+    readonly reset: this;
+    /**
+     * Set RGB values for foreground color.
+     * @param {number} red The red value, in range [0, 255].
+     * @param {number} green The green value, in range [0, 255].
+     * @param {number} blue The blue value, in range [0, 255].
+     */
+    rgb: (red: number, green: number, blue: number) => this;
+    /** S̶t̶r̶i̶k̶e̶t̶h̶r̶o̶u̶g̶h̶ style. (Not widely supported) The alias for `strikethrough`. */
+    readonly strike: this;
+    /** S̶t̶r̶i̶k̶e̶t̶h̶r̶o̶u̶g̶h̶ style. (Not widely supported) */
+    readonly strikethrough: this;
+    /**
+     * Remove ANSI styling codes.
+     * @param {string} str
+     * @returns {string}
+     */
+    strip: (string: string) => string;
+    /** U̲n̲d̲e̲r̲l̲i̲n̲e̲ style. (Not widely supported) */
+    readonly underline: this;
+    /** Print visible text without ANSI styling. */
+    readonly visible: this;
+    readonly white: this;
+    readonly whiteBright: this;
+    readonly yellow: this;
+    readonly yellowBright: this;
+}
+export type ColorData = {
+    close: string;
+    open: string;
+};
+/**
+ * Base ANSI Styles
+ */
+export type AnsiStyles = "bold" | "dim" | "hidden" | "inverse" | "italic" | "overline" | "reset" | "strike" | "strikethrough" | "underline" | "visible";
+/**
+ * Base ANSI Colors
+ */
+export type AnsiColors = "bgBlack" | "bgBlackBright" | "bgBlue" | "bgBlueBright" | "bgCyan" | "bgCyanBright" | "bgGray" | "bgGreen" | "bgGreenBright" | "bgGrey" | "bgMagenta" | "bgMagentaBright" | "bgRed" | "bgRedBright" | "bgWhite" | "bgWhiteBright" | "bgYellow" | "bgYellowBright" | "black" | "blackBright" | "blue" | "blueBright" | "cyan" | "cyanBright" | "gray" | "green" | "greenBright" | "grey" | "magenta" | "magentaBright" | "red" | "redBright" | "white" | "whiteBright" | "yellow" | "yellowBright";
+export type CssColorName = "aliceblue" | "antiquewhite" | "aqua" | "aquamarine" | "azure" | "beige" | "bisque" | "black" | "blanchedalmond" | "blue" | "blueviolet" | "brown" | "burlywood" | "cadetblue" | "chartreuse" | "chocolate" | "coral" | "cornflowerblue" | "cornsilk" | "crimson" | "cyan" | "darkblue" | "darkcyan" | "darkgoldenrod" | "darkgray" | "darkgreen" | "darkgrey" | "darkkhaki" | "darkmagenta" | "darkolivegreen" | "darkorange" | "darkorchid" | "darkred" | "darksalmon" | "darkseagreen" | "darkslateblue" | "darkslategray" | "darkslategrey" | "darkturquoise" | "darkviolet" | "deeppink" | "deepskyblue" | "dimgray" | "dimgrey" | "dodgerblue" | "firebrick" | "floralwhite" | "forestgreen" | "fuchsia" | "gainsboro" | "ghostwhite" | "gold" | "goldenrod" | "gray" | "green" | "greenyellow" | "grey" | "honeydew" | "hotpink" | "indianred" | "indigo" | "ivory" | "khaki" | "lavender" | "lavenderblush" | "lawngreen" | "lemonchiffon" | "lightblue" | "lightcoral" | "lightcyan" | "lightgoldenrodyellow" | "lightgray" | "lightgreen" | "lightgrey" | "lightpink" | "lightsalmon" | "lightseagreen" | "lightskyblue" | "lightslategray" | "lightslategrey" | "lightsteelblue" | "lightyellow" | "lime" | "limegreen" | "linen" | "magenta" | "maroon" | "mediumaquamarine" | "mediumblue" | "mediumorchid" | "mediumpurple" | "mediumseagreen" | "mediumslateblue" | "mediumspringgreen" | "mediumturquoise" | "mediumvioletred" | "midnightblue" | "mintcream" | "mistyrose" | "moccasin" | "navajowhite" | "navy" | "oldlace" | "olive" | "olivedrab" | "orange" | "orangered" | "orchid" | "palegoldenrod" | "palegreen" | "paleturquoise" | "palevioletred" | "papayawhip" | "peachpuff" | "peru" | "pink" | "plum" | "powderblue" | "purple" | "rebeccapurple" | "red" | "rosybrown" | "royalblue" | "saddlebrown" | "salmon" | "sandybrown" | "seagreen" | "seashell" | "sienna" | "silver" | "skyblue" | "slateblue" | "slategray" | "slategrey" | "snow" | "springgreen" | "steelblue" | "tan" | "teal" | "thistle" | "tomato" | "turquoise" | "violet" | "wheat" | "white" | "whitesmoke" | "yellow" | "yellowgreen";
+export type CssColorCodes = {
+    [key in CssColorName]: [number, number, number];
+};
+export type StopInput = {
+    color?: ColorValueHex | CssColorName | RGB | [number, number, number];
+    colorLess?: boolean;
+    position: number;
+};
+export type StopOutput = {
+    color: [number, number, number] | undefined;
+    colorLess?: boolean;
+    position: number;
+};
+export type RGB = {
+    b: number;
+    g: number;
+    r: number;
+};
+export type HSVA = {
+    a?: number;
+    h: number;
+    s: number;
+    v: number;
+};

package/dist/types.d.mts

@@ -0,0 +1,174 @@
+export type ColorValueHex = `#${string}`;
+export interface ColorizeType {
+    /**
+     * Return styled string.
+     * @param {string | TemplateStringsArray} string
+     */
+    (string: number | string): string;
+    (string: TemplateStringsArray, ...parameters: string[]): string;
+    /**
+     * Set [256-color ANSI code](https://en.wikipedia.org/wiki/ANSI_escape_code#8-bit) for foreground color.
+     *
+     * Code ranges:
+     * ```
+     * 0 -   7: standard colors
+     * 8 -  15: high intensity colors
+     * 16 - 231: 6 × 6 × 6 cube (216 colors)
+     * 232 - 255: grayscale from black to white in 24 steps
+     * ```
+     * @param {number} code in range [0, 255].
+     */
+    ansi256: (code: number) => this;
+    /**
+     * Alias for bgAnsi256.
+     * @param {number} code in range [0, 255].
+     */
+    bg: (code: number) => this;
+    /**
+     * Set [256-color ANSI code](https://en.wikipedia.org/wiki/ANSI_escape_code#8-bit) for background color.
+     *
+     * Code ranges:
+     * ```
+     * 0 -   7: standard colors
+     * 8 -  15: high intensity colors
+     * 16 - 231: 6 × 6 × 6 cube (216 colors)
+     * 232 - 255: grayscale from black to white in 24 steps
+     * ```
+     * @param {number} code in range [0, 255].
+     */
+    bgAnsi256: (code: number) => this;
+    readonly bgBlack: this;
+    readonly bgBlackBright: this;
+    readonly bgBlue: this;
+    readonly bgBlueBright: this;
+    readonly bgCyan: this;
+    readonly bgCyanBright: this;
+    readonly bgGray: this;
+    readonly bgGreen: this;
+    readonly bgGreenBright: this;
+    readonly bgGrey: this;
+    /**
+     * Set HEX value for background color.
+     * @param {string} hex
+     */
+    bgHex: (color: ColorValueHex) => this;
+    readonly bgMagenta: this;
+    readonly bgMagentaBright: this;
+    readonly bgRed: this;
+    readonly bgRedBright: this;
+    /**
+     * Set RGB values for background color.
+     * @param {number} red The red value, in range [0, 255].
+     * @param {number} green The green value, in range [0, 255].
+     * @param {number} blue The blue value, in range [0, 255].
+     */
+    bgRgb: (red: number, green: number, blue: number) => this;
+    readonly bgWhite: this;
+    readonly bgWhiteBright: this;
+    readonly bgYellow: this;
+    readonly bgYellowBright: this;
+    readonly black: this;
+    readonly blackBright: this;
+    readonly blue: this;
+    readonly blueBright: this;
+    /** <b>Bold</b> style (high intensity). */
+    readonly bold: this;
+    /** The ANSI escape sequences for ending the current style. */
+    readonly close: string;
+    readonly cyan: this;
+    readonly cyanBright: this;
+    /** Faint style (low intensity or dim). */
+    readonly dim: this;
+    /**
+     * Alias for ansi256.
+     * @param {number} code in range [0, 255].
+     */
+    fg: (code: number) => this;
+    readonly gray: this;
+    readonly green: this;
+    readonly greenBright: this;
+    readonly grey: this;
+    /**
+     * Set HEX value for foreground color.
+     * @param {string} hex
+     */
+    hex: (color: ColorValueHex) => this;
+    /** Print the invisible text. */
+    readonly hidden: this;
+    /** Invert background and foreground colors. */
+    readonly inverse: this;
+    /** <i>Italic</i> style. (Not widely supported) */
+    readonly italic: this;
+    readonly magenta: this;
+    readonly magentaBright: this;
+    /** The ANSI escape sequences for starting the current style. */
+    readonly open: string;
+    /** O̅v̅e̅r̅l̅i̅n̅e̅ style. (Not widely supported) */
+    readonly overline: this;
+    readonly red: this;
+    readonly redBright: this;
+    /** Reset the current style. */
+    readonly reset: this;
+    /**
+     * Set RGB values for foreground color.
+     * @param {number} red The red value, in range [0, 255].
+     * @param {number} green The green value, in range [0, 255].
+     * @param {number} blue The blue value, in range [0, 255].
+     */
+    rgb: (red: number, green: number, blue: number) => this;
+    /** S̶t̶r̶i̶k̶e̶t̶h̶r̶o̶u̶g̶h̶ style. (Not widely supported) The alias for `strikethrough`. */
+    readonly strike: this;
+    /** S̶t̶r̶i̶k̶e̶t̶h̶r̶o̶u̶g̶h̶ style. (Not widely supported) */
+    readonly strikethrough: this;
+    /**
+     * Remove ANSI styling codes.
+     * @param {string} str
+     * @returns {string}
+     */
+    strip: (string: string) => string;
+    /** U̲n̲d̲e̲r̲l̲i̲n̲e̲ style. (Not widely supported) */
+    readonly underline: this;
+    /** Print visible text without ANSI styling. */
+    readonly visible: this;
+    readonly white: this;
+    readonly whiteBright: this;
+    readonly yellow: this;
+    readonly yellowBright: this;
+}
+export type ColorData = {
+    close: string;
+    open: string;
+};
+/**
+ * Base ANSI Styles
+ */
+export type AnsiStyles = "bold" | "dim" | "hidden" | "inverse" | "italic" | "overline" | "reset" | "strike" | "strikethrough" | "underline" | "visible";
+/**
+ * Base ANSI Colors
+ */
+export type AnsiColors = "bgBlack" | "bgBlackBright" | "bgBlue" | "bgBlueBright" | "bgCyan" | "bgCyanBright" | "bgGray" | "bgGreen" | "bgGreenBright" | "bgGrey" | "bgMagenta" | "bgMagentaBright" | "bgRed" | "bgRedBright" | "bgWhite" | "bgWhiteBright" | "bgYellow" | "bgYellowBright" | "black" | "blackBright" | "blue" | "blueBright" | "cyan" | "cyanBright" | "gray" | "green" | "greenBright" | "grey" | "magenta" | "magentaBright" | "red" | "redBright" | "white" | "whiteBright" | "yellow" | "yellowBright";
+export type CssColorName = "aliceblue" | "antiquewhite" | "aqua" | "aquamarine" | "azure" | "beige" | "bisque" | "black" | "blanchedalmond" | "blue" | "blueviolet" | "brown" | "burlywood" | "cadetblue" | "chartreuse" | "chocolate" | "coral" | "cornflowerblue" | "cornsilk" | "crimson" | "cyan" | "darkblue" | "darkcyan" | "darkgoldenrod" | "darkgray" | "darkgreen" | "darkgrey" | "darkkhaki" | "darkmagenta" | "darkolivegreen" | "darkorange" | "darkorchid" | "darkred" | "darksalmon" | "darkseagreen" | "darkslateblue" | "darkslategray" | "darkslategrey" | "darkturquoise" | "darkviolet" | "deeppink" | "deepskyblue" | "dimgray" | "dimgrey" | "dodgerblue" | "firebrick" | "floralwhite" | "forestgreen" | "fuchsia" | "gainsboro" | "ghostwhite" | "gold" | "goldenrod" | "gray" | "green" | "greenyellow" | "grey" | "honeydew" | "hotpink" | "indianred" | "indigo" | "ivory" | "khaki" | "lavender" | "lavenderblush" | "lawngreen" | "lemonchiffon" | "lightblue" | "lightcoral" | "lightcyan" | "lightgoldenrodyellow" | "lightgray" | "lightgreen" | "lightgrey" | "lightpink" | "lightsalmon" | "lightseagreen" | "lightskyblue" | "lightslategray" | "lightslategrey" | "lightsteelblue" | "lightyellow" | "lime" | "limegreen" | "linen" | "magenta" | "maroon" | "mediumaquamarine" | "mediumblue" | "mediumorchid" | "mediumpurple" | "mediumseagreen" | "mediumslateblue" | "mediumspringgreen" | "mediumturquoise" | "mediumvioletred" | "midnightblue" | "mintcream" | "mistyrose" | "moccasin" | "navajowhite" | "navy" | "oldlace" | "olive" | "olivedrab" | "orange" | "orangered" | "orchid" | "palegoldenrod" | "palegreen" | "paleturquoise" | "palevioletred" | "papayawhip" | "peachpuff" | "peru" | "pink" | "plum" | "powderblue" | "purple" | "rebeccapurple" | "red" | "rosybrown" | "royalblue" | "saddlebrown" | "salmon" | "sandybrown" | "seagreen" | "seashell" | "sienna" | "silver" | "skyblue" | "slateblue" | "slategray" | "slategrey" | "snow" | "springgreen" | "steelblue" | "tan" | "teal" | "thistle" | "tomato" | "turquoise" | "violet" | "wheat" | "white" | "whitesmoke" | "yellow" | "yellowgreen";
+export type CssColorCodes = {
+    [key in CssColorName]: [number, number, number];
+};
+export type StopInput = {
+    color?: ColorValueHex | CssColorName | RGB | [number, number, number];
+    colorLess?: boolean;
+    position: number;
+};
+export type StopOutput = {
+    color: [number, number, number] | undefined;
+    colorLess?: boolean;
+    position: number;
+};
+export type RGB = {
+    b: number;
+    g: number;
+    r: number;
+};
+export type HSVA = {
+    a?: number;
+    h: number;
+    s: number;
+    v: number;
+};

package/dist/types.d.ts

@@ -0,0 +1,174 @@
+export type ColorValueHex = `#${string}`;
+export interface ColorizeType {
+    /**
+     * Return styled string.
+     * @param {string | TemplateStringsArray} string
+     */
+    (string: number | string): string;
+    (string: TemplateStringsArray, ...parameters: string[]): string;
+    /**
+     * Set [256-color ANSI code](https://en.wikipedia.org/wiki/ANSI_escape_code#8-bit) for foreground color.
+     *
+     * Code ranges:
+     * ```
+     * 0 -   7: standard colors
+     * 8 -  15: high intensity colors
+     * 16 - 231: 6 × 6 × 6 cube (216 colors)
+     * 232 - 255: grayscale from black to white in 24 steps
+     * ```
+     * @param {number} code in range [0, 255].
+     */
+    ansi256: (code: number) => this;
+    /**
+     * Alias for bgAnsi256.
+     * @param {number} code in range [0, 255].
+     */
+    bg: (code: number) => this;
+    /**
+     * Set [256-color ANSI code](https://en.wikipedia.org/wiki/ANSI_escape_code#8-bit) for background color.
+     *
+     * Code ranges:
+     * ```
+     * 0 -   7: standard colors
+     * 8 -  15: high intensity colors
+     * 16 - 231: 6 × 6 × 6 cube (216 colors)
+     * 232 - 255: grayscale from black to white in 24 steps
+     * ```
+     * @param {number} code in range [0, 255].
+     */
+    bgAnsi256: (code: number) => this;
+    readonly bgBlack: this;
+    readonly bgBlackBright: this;
+    readonly bgBlue: this;
+    readonly bgBlueBright: this;
+    readonly bgCyan: this;
+    readonly bgCyanBright: this;
+    readonly bgGray: this;
+    readonly bgGreen: this;
+    readonly bgGreenBright: this;
+    readonly bgGrey: this;
+    /**
+     * Set HEX value for background color.
+     * @param {string} hex
+     */
+    bgHex: (color: ColorValueHex) => this;
+    readonly bgMagenta: this;
+    readonly bgMagentaBright: this;
+    readonly bgRed: this;
+    readonly bgRedBright: this;
+    /**
+     * Set RGB values for background color.
+     * @param {number} red The red value, in range [0, 255].
+     * @param {number} green The green value, in range [0, 255].
+     * @param {number} blue The blue value, in range [0, 255].
+     */
+    bgRgb: (red: number, green: number, blue: number) => this;
+    readonly bgWhite: this;
+    readonly bgWhiteBright: this;
+    readonly bgYellow: this;
+    readonly bgYellowBright: this;
+    readonly black: this;
+    readonly blackBright: this;
+    readonly blue: this;
+    readonly blueBright: this;
+    /** <b>Bold</b> style (high intensity). */
+    readonly bold: this;
+    /** The ANSI escape sequences for ending the current style. */
+    readonly close: string;
+    readonly cyan: this;
+    readonly cyanBright: this;
+    /** Faint style (low intensity or dim). */
+    readonly dim: this;
+    /**
+     * Alias for ansi256.
+     * @param {number} code in range [0, 255].
+     */
+    fg: (code: number) => this;
+    readonly gray: this;
+    readonly green: this;
+    readonly greenBright: this;
+    readonly grey: this;
+    /**
+     * Set HEX value for foreground color.
+     * @param {string} hex
+     */
+    hex: (color: ColorValueHex) => this;
+    /** Print the invisible text. */
+    readonly hidden: this;
+    /** Invert background and foreground colors. */
+    readonly inverse: this;
+    /** <i>Italic</i> style. (Not widely supported) */
+    readonly italic: this;
+    readonly magenta: this;
+    readonly magentaBright: this;
+    /** The ANSI escape sequences for starting the current style. */
+    readonly open: string;
+    /** O̅v̅e̅r̅l̅i̅n̅e̅ style. (Not widely supported) */
+    readonly overline: this;
+    readonly red: this;
+    readonly redBright: this;
+    /** Reset the current style. */
+    readonly reset: this;
+    /**
+     * Set RGB values for foreground color.
+     * @param {number} red The red value, in range [0, 255].
+     * @param {number} green The green value, in range [0, 255].
+     * @param {number} blue The blue value, in range [0, 255].
+     */
+    rgb: (red: number, green: number, blue: number) => this;
+    /** S̶t̶r̶i̶k̶e̶t̶h̶r̶o̶u̶g̶h̶ style. (Not widely supported) The alias for `strikethrough`. */
+    readonly strike: this;
+    /** S̶t̶r̶i̶k̶e̶t̶h̶r̶o̶u̶g̶h̶ style. (Not widely supported) */
+    readonly strikethrough: this;
+    /**
+     * Remove ANSI styling codes.
+     * @param {string} str
+     * @returns {string}
+     */
+    strip: (string: string) => string;
+    /** U̲n̲d̲e̲r̲l̲i̲n̲e̲ style. (Not widely supported) */
+    readonly underline: this;
+    /** Print visible text without ANSI styling. */
+    readonly visible: this;
+    readonly white: this;
+    readonly whiteBright: this;
+    readonly yellow: this;
+    readonly yellowBright: this;
+}
+export type ColorData = {
+    close: string;
+    open: string;
+};
+/**
+ * Base ANSI Styles
+ */
+export type AnsiStyles = "bold" | "dim" | "hidden" | "inverse" | "italic" | "overline" | "reset" | "strike" | "strikethrough" | "underline" | "visible";
+/**
+ * Base ANSI Colors
+ */
+export type AnsiColors = "bgBlack" | "bgBlackBright" | "bgBlue" | "bgBlueBright" | "bgCyan" | "bgCyanBright" | "bgGray" | "bgGreen" | "bgGreenBright" | "bgGrey" | "bgMagenta" | "bgMagentaBright" | "bgRed" | "bgRedBright" | "bgWhite" | "bgWhiteBright" | "bgYellow" | "bgYellowBright" | "black" | "blackBright" | "blue" | "blueBright" | "cyan" | "cyanBright" | "gray" | "green" | "greenBright" | "grey" | "magenta" | "magentaBright" | "red" | "redBright" | "white" | "whiteBright" | "yellow" | "yellowBright";
+export type CssColorName = "aliceblue" | "antiquewhite" | "aqua" | "aquamarine" | "azure" | "beige" | "bisque" | "black" | "blanchedalmond" | "blue" | "blueviolet" | "brown" | "burlywood" | "cadetblue" | "chartreuse" | "chocolate" | "coral" | "cornflowerblue" | "cornsilk" | "crimson" | "cyan" | "darkblue" | "darkcyan" | "darkgoldenrod" | "darkgray" | "darkgreen" | "darkgrey" | "darkkhaki" | "darkmagenta" | "darkolivegreen" | "darkorange" | "darkorchid" | "darkred" | "darksalmon" | "darkseagreen" | "darkslateblue" | "darkslategray" | "darkslategrey" | "darkturquoise" | "darkviolet" | "deeppink" | "deepskyblue" | "dimgray" | "dimgrey" | "dodgerblue" | "firebrick" | "floralwhite" | "forestgreen" | "fuchsia" | "gainsboro" | "ghostwhite" | "gold" | "goldenrod" | "gray" | "green" | "greenyellow" | "grey" | "honeydew" | "hotpink" | "indianred" | "indigo" | "ivory" | "khaki" | "lavender" | "lavenderblush" | "lawngreen" | "lemonchiffon" | "lightblue" | "lightcoral" | "lightcyan" | "lightgoldenrodyellow" | "lightgray" | "lightgreen" | "lightgrey" | "lightpink" | "lightsalmon" | "lightseagreen" | "lightskyblue" | "lightslategray" | "lightslategrey" | "lightsteelblue" | "lightyellow" | "lime" | "limegreen" | "linen" | "magenta" | "maroon" | "mediumaquamarine" | "mediumblue" | "mediumorchid" | "mediumpurple" | "mediumseagreen" | "mediumslateblue" | "mediumspringgreen" | "mediumturquoise" | "mediumvioletred" | "midnightblue" | "mintcream" | "mistyrose" | "moccasin" | "navajowhite" | "navy" | "oldlace" | "olive" | "olivedrab" | "orange" | "orangered" | "orchid" | "palegoldenrod" | "palegreen" | "paleturquoise" | "palevioletred" | "papayawhip" | "peachpuff" | "peru" | "pink" | "plum" | "powderblue" | "purple" | "rebeccapurple" | "red" | "rosybrown" | "royalblue" | "saddlebrown" | "salmon" | "sandybrown" | "seagreen" | "seashell" | "sienna" | "silver" | "skyblue" | "slateblue" | "slategray" | "slategrey" | "snow" | "springgreen" | "steelblue" | "tan" | "teal" | "thistle" | "tomato" | "turquoise" | "violet" | "wheat" | "white" | "whitesmoke" | "yellow" | "yellowgreen";
+export type CssColorCodes = {
+    [key in CssColorName]: [number, number, number];
+};
+export type StopInput = {
+    color?: ColorValueHex | CssColorName | RGB | [number, number, number];
+    colorLess?: boolean;
+    position: number;
+};
+export type StopOutput = {
+    color: [number, number, number] | undefined;
+    colorLess?: boolean;
+    position: number;
+};
+export type RGB = {
+    b: number;
+    g: number;
+    r: number;
+};
+export type HSVA = {
+    a?: number;
+    h: number;
+    s: number;
+    v: number;
+};