termark 1.0.0 → 2.0.0

package/README.md

@@ -4,9 +4,10 @@ Termark is a basic library to format console output to the standard non-browser
 
 ## Features & Highlights
 
-- 0-dependency
+- Zero dependencies
 - [ESM & CJS compatible](#esm--cjs-compatibility)
 - [NO_COLOR](https://no-color.org/)-friendly
+- [Default and named imports]
 - [Basic ANSI styling](#basic-ansi-styling) (`dim`, `bold`, `italic`, …)
 - [4-bit](#4-bit-colours) ($2^4 = 16$) colours (`red`, `cyan`, `blueBright`, …)
 - [8-bit](#8-bit-colours) ($2^8 = 256$) colours (`ansi256()`)
@@ -15,6 +16,7 @@ Termark is a basic library to format console output to the standard non-browser
 - Built-in [terminal logging methods](#built-in-terminal-logging-methods) (`success()`, `info()`, `warn()`, `error()`)
 - [Template strings](#template-strings) & [nested styles](#nested-styles) (``` green`Success: File ${cyan`plans.txt`} created successfully!` ```)
 - [Colour-detection utilities](#colour-detection-utilities) (`areColorsEnabled`, `is8bitEnabled`, `is24bitEnabled`)
+- [Usage as an object or as a class](#class-v-object)
 
 ## Installation
 
@@ -34,6 +36,24 @@ const termark = require('termark');
 import termark from 'termark';
 ```
 
+## Default & named imports
+
+Termark offers both a default import that has access to all properties and methods, or you can import each one individually:
+
+```ts
+// Default import:
+import termark from 'termark';
+
+termark.info('This is the default import, where all properties and methods are accessible.');
+
+// Named imports:
+import { success, inverse } from 'termark';
+
+success(
+    inverse('This text with a green background is achieved with named imports!')
+)
+```
+
 ## Usage
 
 Here's a quick reference for every feature Termark provides:
@@ -140,6 +160,8 @@ termark.rgb('text', convert.hex.rgb('008330'))('...');
 
 ### Gradients
 
+**Please note that gradients do not support nested styling.**
+
 ```ts
 import termark from 'termark';
 
@@ -147,25 +169,6 @@ termark.gradient('text', [[200, 123, 0], [0, 255, 255], [177, 209, 10]])('...');
 termark.gradient('background', [[123, 75, 204], [255, 255, 255], [0, 44, 55]])('...');
 ```
 
-The way this works is as follows:
-
-We have two colours $C_1 = (R_1,G_1,B_1)$ and $C_2 = (R_2,G_2,B_2)$, and we need to generate a gradient over a string of length $L$.  
-For each character at index $i$ (from 0 to $L-1$), we need to find an interpolated colour $C_i$.  
-For that, we can do the following:
-
-$$
-\begin{align*}
-t   &= \frac{i}{L-1} \\\\
-R_i &= R_1 + t \times (R_2 - R_1) \\
-G_i &= G_1 + t \times (G_2 - G_1) \\
-B_i &= B_1 + t \times (B_2 - B_1)
-\end{align*}
-$$
-
-We then apply $C_i$ to each character $i$ to get our (mostly) smooth gradient.
-
-**Please note that gradients do not support nested styling.**
-
 ### Built-in terminal logging methods
 
 ```ts
@@ -217,6 +220,22 @@ termark.is8bitEnabled; // Check whether 8-bit (256) colours are enabled.
 termark.is24bitEnabled; // Check whether 24-bit (truecolor) colours are enabled.
 ```
 
+### Class v. Object
+
+You can use Termark by importing the object, or you can import the class:
+
+```ts
+import { Termark } from 'termark';
+
+const termark = new Termark(); // This is the same as importing the `termark` object.
+termark.success('Termark is working!');
+
+// Alternatively, you could do this:
+Termark.init.success('This work, too!');
+```
+
+`Termark.init` enables using the `Termark` class as the default `termark` object.
+
 ## Licence
 
 Termark's code is licenced under the [Apache licence version 2](https://www.apache.org/licenses/LICENSE-2.0).  

package/dist/index.cjs

@@ -1,181 +1 @@
-/*
-Copyright 2025 Q
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-*/
-
-'use strict';
-
-const areColoursEnabled = () => {
-    const noColour = process.env.NO_COLOR;
-    return noColour ? false : true;
-};
-const getColourSupport = () => {
-    const colourTerm = process.env.COLORTERM;
-    const is16bit = colourTerm ? (colourTerm.includes('ansi') && !(colourTerm.includes('256'))) : false;
-    const is256 = colourTerm ? colourTerm.includes('ansi256') : false;
-    const isTrueColor = colourTerm ? (colourTerm.includes('truecolor') || colourTerm.includes('24bit')) : false;
-    return {
-        is16bit,
-        is256,
-        isTrueColor
-    };
-};
-function format(open, close, type) {
-    if (type === 'color' && !areColoursEnabled())
-        return (input) => input.toString();
-    const opener = `\x1b[${open}m`;
-    const closer = `\x1b[${close}m`;
-    return (input$1) => {
-        const input = input$1.toString().trim();
-        const index = input.indexOf(closer);
-        if (index === -1)
-            return `${opener}${input}${closer}`;
-        return `${opener}${input.replaceAll(closer, closer + opener)}${closer}`;
-    };
-}
-function interpolate(color1, color2, factor) {
-    return [
-        Math.round(color1[0] + factor * (color2[0] - color1[0])),
-        Math.round(color1[1] + factor * (color2[1] - color1[1])),
-        Math.round(color1[2] + factor * (color2[2] - color1[2])),
-    ];
-}
-
-const termark = {
-    areColorsEnabled: areColoursEnabled(),
-    is8bitEnabled: getColourSupport().is256,
-    is24bitEnabled: getColourSupport().isTrueColor,
-    reset: format(0, 0, 'format'),
-    bold: format(1, 22, 'format'),
-    dim: format(2, 22, 'format'),
-    italic: format(3, 23, 'format'),
-    underline: format(4, 24, 'format'),
-    blink: format(5, 25, 'format'),
-    inverse: format(7, 27, 'format'),
-    overline: format(53, 55, 'format'),
-    hidden: format(8, 28, 'format'),
-    strike: format(9, 29, 'format'),
-    black: format(30, 39, 'color'),
-    red: format(31, 39, 'color'),
-    green: format(32, 39, 'color'),
-    yellow: format(33, 39, 'color'),
-    blue: format(34, 39, 'color'),
-    magenta: format(35, 39, 'color'),
-    cyan: format(36, 39, 'color'),
-    white: format(37, 39, 'color'),
-    blackBright: format(90, 39, 'color'),
-    redBright: format(91, 39, 'color'),
-    greenBright: format(92, 39, 'color'),
-    yellowBright: format(93, 39, 'color'),
-    blueBright: format(94, 39, 'color'),
-    magentaBright: format(95, 39, 'color'),
-    cyanBright: format(96, 39, 'color'),
-    whiteBright: format(97, 39, 'color'),
-    bgBlack: format(40, 49, 'color'),
-    bgRed: format(41, 49, 'color'),
-    bgGreen: format(42, 49, 'color'),
-    bgYellow: format(43, 49, 'color'),
-    bgBlue: format(44, 49, 'color'),
-    bgMagenta: format(45, 49, 'color'),
-    bgCyan: format(46, 49, 'color'),
-    bgWhite: format(47, 49, 'color'),
-    bgBlackBright: format(100, 49, 'color'),
-    bgRedBright: format(101, 49, 'color'),
-    bgGreenBright: format(102, 49, 'color'),
-    bgYellowBright: format(103, 49, 'color'),
-    bgBlueBright: format(104, 49, 'color'),
-    bgMagentaBright: format(105, 49, 'color'),
-    bgCyanBright: format(106, 49, 'color'),
-    bgWhiteBright: format(107, 49, 'color'),
-    ansi256(type, color) {
-        if (color < 0 || color > 255)
-            throw new Error(termark.red('Value `color` is out of range! The value must be a number between 0 and 255!'));
-        if (!getColourSupport().is256 || !areColoursEnabled())
-            return (input) => input.toString();
-        const textFormat = `38;5;${color}`;
-        const bgFormat = `48;5;${color}`;
-        const opener = type === 'text' ? textFormat : bgFormat;
-        const closer = type === 'text' ? 39 : 49;
-        return format(opener, closer, 'color');
-    },
-    rgb(type, ...rgb) {
-        let red;
-        let green;
-        let blue;
-        if (Array.isArray(rgb[0])) {
-            red = rgb[0][0];
-            green = rgb[0][1];
-            blue = rgb[0][2];
-        }
-        else {
-            red = rgb[0];
-            green = rgb[1];
-            blue = rgb[2];
-        }
-        if (((typeof red === 'number') && (red < 0 || red > 255)) ||
-            ((typeof green === 'number') && (green < 0 || green > 255)) ||
-            ((typeof blue === 'number') && (blue < 0 || blue > 255)))
-            throw new Error(termark.red('One or multiple of the colours specified is out of range! Each colour can have a value only between 0 and 255!'));
-        if (!getColourSupport().isTrueColor)
-            return (input) => input.toString();
-        const textFormat = `38;2;${red};${green};${blue}`;
-        const bgFormat = `48;2;${red};${green};${blue}`;
-        const opener = type === 'text' ? textFormat : bgFormat;
-        const closer = type === 'text' ? 39 : 49;
-        return format(opener, closer, 'color');
-    },
-    gradient(type, colors) {
-        if (!areColoursEnabled() || !getColourSupport().isTrueColor)
-            return (input) => input.toString();
-        const textFormat = `38;2;`;
-        const bgFormat = `48;2;`;
-        const opener = type === 'text' ? `\x1b[${textFormat}` : `\x1b[${bgFormat}`;
-        const closer = type === 'text' ? `\x1b[${39}m` : `\x1b[${49}m`;
-        return (input$1) => {
-            const input = input$1.toString().trim();
-            const colourCount = colors.length;
-            const step = Math.min(input.length / (colourCount - 1));
-            let result = '';
-            for (let character = 0; character < input.length; character++) {
-                const colourIndex = Math.min(Math.floor(character / step), colourCount - 2);
-                const factor = (character % step) / step;
-                const startColour = colors[colourIndex];
-                const endColour = colors[colourIndex + 1];
-                const interpolatedColour = interpolate(startColour, endColour, factor);
-                result += `${opener}${interpolatedColour[0]};${interpolatedColour[1]};${interpolatedColour[2]}m${input[character]}${closer}`;
-            }
-            return result;
-        };
-    },
-    success(message, prefix = '') {
-        console.info(`${prefix}${termark.green(message)}`);
-    },
-    info(message, prefix = '') {
-        console.info(`${prefix}${termark.blue(message)}`);
-    },
-    warn(message, prefix = '') {
-        console.warn(`${prefix}${termark.yellow(message)}`);
-    },
-    error(message, prefix = '') {
-        console.error(`${prefix}${termark.red(message)}`);
-    },
-    custom(opener, closer, type) {
-        const formatType = type === 'asColor' ? 'color' : 'format';
-        return format(opener, closer, formatType);
-    },
-};
-
-module.exports = termark;
-
-// Copyright (C) 2025 Q
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});const r=()=>!process.env.NO_COLOR,t=()=>{const r=process.env.COLORTERM;return{is16bit:!!r&&(r.includes("ansi")&&!r.includes("256")),is256:!!r&&r.includes("ansi256"),isTrueColor:!!r&&(r.includes("truecolor")||r.includes("24bit"))}};function e(t,e,o){if("color"===o&&!r())return r=>r.toString();const i=`[${t}m`,s=`[${e}m`;return r=>{const t=r.toString().trim();return-1===t.indexOf(s)?`${i}${t}${s}`:`${i}${t.replaceAll(s,s+i)}${s}`}}function o(r,t,e){return[Math.round(r[0]+e*(t[0]-r[0])),Math.round(r[1]+e*(t[1]-r[1])),Math.round(r[2]+e*(t[2]-r[2]))]}class i{constructor(){this.areColorsEnabled=r(),this.is8bitEnabled=t().is256,this.is24bitEnabled=t().isTrueColor,this.reset=e(0,0,"format"),this.bold=e(1,22,"format"),this.dim=e(2,22,"format"),this.italic=e(3,23,"format"),this.underline=e(4,24,"format"),this.blink=e(5,25,"format"),this.inverse=e(7,27,"format"),this.overline=e(53,55,"format"),this.hidden=e(8,28,"format"),this.strike=e(9,29,"format"),this.black=e(30,39,"color"),this.red=e(31,39,"color"),this.green=e(32,39,"color"),this.yellow=e(33,39,"color"),this.blue=e(34,39,"color"),this.magenta=e(35,39,"color"),this.cyan=e(36,39,"color"),this.white=e(37,39,"color"),this.blackBright=e(90,39,"color"),this.redBright=e(91,39,"color"),this.greenBright=e(92,39,"color"),this.yellowBright=e(93,39,"color"),this.blueBright=e(94,39,"color"),this.magentaBright=e(95,39,"color"),this.cyanBright=e(96,39,"color"),this.whiteBright=e(97,39,"color"),this.bgBlack=e(40,49,"color"),this.bgRed=e(41,49,"color"),this.bgGreen=e(42,49,"color"),this.bgYellow=e(43,49,"color"),this.bgBlue=e(44,49,"color"),this.bgMagenta=e(45,49,"color"),this.bgCyan=e(46,49,"color"),this.bgWhite=e(47,49,"color"),this.bgBlackBright=e(100,49,"color"),this.bgRedBright=e(101,49,"color"),this.bgGreenBright=e(102,49,"color"),this.bgYellowBright=e(103,49,"color"),this.bgBlueBright=e(104,49,"color"),this.bgMagentaBright=e(105,49,"color"),this.bgCyanBright=e(106,49,"color"),this.bgWhiteBright=e(107,49,"color")}static get init(){return new this.termarkInstance}ansi256(o,s){if(s<0||s>255)throw new Error(i.init.red("Value `color` is out of range! The value must be a number between 0 and 255!"));if(!t().is256||!r())return r=>r.toString();return e("text"===o?`38;5;${s}`:`48;5;${s}`,"text"===o?39:49,"color")}rgb(r,...o){let s,n,l;if(Array.isArray(o[0])?(s=o[0][0],n=o[0][1],l=o[0][2]):(s=o[0],n=o[1],l=o[2]),"number"==typeof s&&(s<0||s>255)||"number"==typeof n&&(n<0||n>255)||"number"==typeof l&&(l<0||l>255))throw new Error(i.init.red("One or multiple of the colours specified is out of range! Each colour can have a value only between 0 and 255!"));if(!t().isTrueColor)return r=>r.toString();return e("text"===r?`38;2;${s};${n};${l}`:`48;2;${s};${n};${l}`,"text"===r?39:49,"color")}gradient(e,i){if(!r()||!t().isTrueColor)return r=>r.toString();const s="text"===e?"[38;2;":"[48;2;",n="text"===e?"":"";return r=>{const t=r.toString().trim(),e=i.length,l=Math.min(t.length/(e-1));let g="";for(let r=0;r<t.length;r++){const h=Math.min(Math.floor(r/l),e-2),a=r%l/l,c=o(i[h],i[h+1],a);g+=`${s}${c[0]};${c[1]};${c[2]}m${t[r]}${n}`}return g}}success(r,t=""){console.info(`${t}${i.init.green(r)}`)}info(r,t=""){console.info(`${t}${i.init.blue(r)}`)}warn(r,t=""){console.warn(`${t}${i.init.yellow(r)}`)}error(r,t=""){console.error(`${t}${i.init.red(r)}`)}custom(r,t,o){return e(r,t,"asColor"===o?"color":"format")}}i.termarkInstance=i;const s=new i,{areColorsEnabled:n,is8bitEnabled:l,is24bitEnabled:g,reset:h,bold:a,dim:c,italic:b,underline:u,blink:p,inverse:x,overline:B,hidden:d,strike:m,black:f,red:w,green:$,yellow:y,blue:k,magenta:C,cyan:M,white:E,blackBright:v,redBright:R,greenBright:O,yellowBright:T,blueBright:G,magentaBright:S,cyanBright:W,whiteBright:Y,bgBlack:A,bgRed:_,bgGreen:I,bgYellow:L,bgBlue:j,bgMagenta:N,bgCyan:P,bgWhite:V,bgBlackBright:q,bgRedBright:z,bgGreenBright:D,bgYellowBright:F,bgBlueBright:H,bgMagentaBright:J,bgCyanBright:K,bgWhiteBright:Q,ansi256:U,rgb:X,gradient:Z,success:rr,info:tr,warn:er,error:or,custom:ir}=s;exports.Termark=i,exports.ansi256=U,exports.areColorsEnabled=n,exports.bgBlack=A,exports.bgBlackBright=q,exports.bgBlue=j,exports.bgBlueBright=H,exports.bgCyan=P,exports.bgCyanBright=K,exports.bgGreen=I,exports.bgGreenBright=D,exports.bgMagenta=N,exports.bgMagentaBright=J,exports.bgRed=_,exports.bgRedBright=z,exports.bgWhite=V,exports.bgWhiteBright=Q,exports.bgYellow=L,exports.bgYellowBright=F,exports.black=f,exports.blackBright=v,exports.blink=p,exports.blue=k,exports.blueBright=G,exports.bold=a,exports.custom=ir,exports.cyan=M,exports.cyanBright=W,exports.default=s,exports.dim=c,exports.error=or,exports.gradient=Z,exports.green=$,exports.greenBright=O,exports.hidden=d,exports.info=tr,exports.inverse=x,exports.is24bitEnabled=g,exports.is8bitEnabled=l,exports.italic=b,exports.magenta=C,exports.magentaBright=S,exports.overline=B,exports.red=w,exports.redBright=R,exports.reset=h,exports.rgb=X,exports.strike=m,exports.success=rr,exports.underline=u,exports.warn=er,exports.white=E,exports.whiteBright=Y,exports.yellow=y,exports.yellowBright=T;

package/dist/index.d.ts

@@ -1,318 +1,137 @@
+import { ANSIStyleType, RGB } from './util';
 /**
- * All properties and methods provided by Termark.
+ * The `Termark` class is almost the same as the {@linkcode termark} object and by using `Termark.init`, it effectively does become the same.
+ *
+ * However, it is nonetheless useful as it enables type-safety,
+ *
+ * You use this class the same way as you would the {@linkcode termark} object.
+ *
+ * @example
+ * ```typescript
+ * import { Termark } from 'termark';
+ *
+ * const termark = new Termark(); // This is the same as if you'd import the `termark` object.
+ * termark.success('Termark is working!');
+ *
+ * // Alternatively, you could do:
+ * Termark.init.success('This works, too!');
+ * ```
+ *
+ * @see The {@linkcode termark} object.
  */
-interface Termark {
+export declare class Termark {
     /**
-     * Check whether terminal colours are enabled.
+     * A reference to a Termark instance.
      *
-     * @returns true If terminal colours are enabled.
+     * This is an object that holds the properties defined below.
      */
-    areColorsEnabled: boolean;
+    private static termarkInstance;
     /**
-     * Check whether 8-bit colours are enabled.
+     * A static getter function that returns a Termark reference object.
      *
-     * @returns true If 8-bit colours are enabled.
-     */
-    is8bitEnabled: boolean;
-    /**
-     * Check whether 24-bit colours (truecolor) are enabled.
+     * With this method, it's possible to use the `Termark` class like an object.
      *
-     * @returns true If 24-bit colours are enabled.
-     */
-    is24bitEnabled: boolean;
-    /**
-     * Reset all formatting of some text.
+     * @example
+     * ```typescript
+     * import { Termark } from 'termark';
+     * Termark.init.success('...');
      *
-     * @param input The text to format.
-     * @returns The formatted text.
-     */
-    reset: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make some text bold.
+     * // ...is the same as:
      *
-     * @param input The text to format.
-     * @returns The text in bold letters.
+     * import termark from 'termark';
+     * termark.success('...');
+     * ```
      */
+    static get init(): Termark;
+    /** Check whether terminal colours are enabled. */
+    areColorsEnabled: boolean;
+    /** Check whether 8-bit colours are enabled. */
+    is8bitEnabled: boolean;
+    /** Check whether 24-bit colours are enabled. */
+    is24bitEnabled: boolean;
+    /** Reset all styles. */
+    reset: (input: string | TemplateStringsArray) => string;
+    /** Make some text bold. */
     bold: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make some text thinner.
-     *
-     * @param input The text to format.
-     * @returns The text in thinner letters.
-     */
+    /** Make some text thin. */
     dim: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make some text italic. May not be widely supported.
-     *
-     * @param input The text to format.
-     * @returns The text with italicized (usually slanted) letters.
-     */
+    /** Make some text italic. May not be widely supported. */
     italic: (input: string | TemplateStringsArray) => string;
-    /**
-     * Underline some text.
-     *
-     * @param input The text to format.
-     * @returns The underlined text.
-     */
+    /** Underline some text. */
     underline: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make some text blink slowly.
-     *
-     * @param input The text to format.
-     * @returns The blinking text.
-     */
+    /** Make some text blink slowly. */
     blink: (input: string | TemplateStringsArray) => string;
-    /**
-     * Invert some text (foreground colour becomes background colour, background colour becomes foreground colour).
-     *
-     * @param input The text to format.
-     * @returns The inverted text.
-     */
+    /** Invert some text (foreground colour becomes background colour, background colour becomes foreground colour). */
     inverse: (input: string | TemplateStringsArray) => string;
-    /**
-     * Add a line above some text (may not be widely supported).
-     *
-     * @param input The text to format.
-     * @returns The text with a line above it.
-     */
+    /** Add a line above some text. May not be widely supported. */
     overline: (input: string | TemplateStringsArray) => string;
-    /**
-     * Hide some text (may not be widely supported).
-     *
-     * @param input The text to format.
-     * @returns The hidden text.
-     */
+    /** Visually hide some text. */
     hidden: (input: string | TemplateStringsArray) => string;
-    /**
-     * Add a line through (strike) some text.
-     *
-     * @param input The text to format.
-     * @returns The striked text.
-     */
+    /** Add a line through (strike) some text. */
     strike: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make some text black.
-     *
-     * @param input The text to colour.
-     * @returns If colours are enabled, `input` coloured black.
-     */
+    /** Colour some text black. */
     black: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make some text red.
-     *
-     * @param input The text to colour.
-     * @returns If colours are enabled, `input` coloured red.
-     */
+    /** Colour some text red. */
     red: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make some text green.
-     *
-     * @param input The text to colour.
-     * @returns If colours are enabled, `input` coloured green.
-     */
+    /** Colour some text green. */
     green: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make some text yellow.
-     *
-     * @param input The text to colour.
-     * @returns If colours are enabled, `input` coloured yellow.
-     */
+    /** Colour some text yellow. */
     yellow: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make some text blue.
-     *
-     * @param input The text to colour.
-     * @returns If colours are enabled, `input` coloured blue.
-     */
+    /** Colour some text blue. */
     blue: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make some text magenta.
-     *
-     * @param input The text to colour.
-     * @returns If colours are enabled, `input` coloured magenta.
-     */
+    /** Colour some text magenta. */
     magenta: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make some text cyan.
-     *
-     * @param input The text to colour.
-     * @returns If colours are enabled, `input` coloured cyan.
-     */
+    /** Colour some text cyan. */
     cyan: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make some text white.
-     *
-     * @param input The text to colour.
-     * @returns If colours are enabled, `input` coloured white.
-     */
+    /** Colour some text white. */
     white: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make some text bright black (grey).
-     *
-     * @param input The text to colour.
-     * @returns If colours are enabled, `input` coloured bright black (grey).
-     */
+    /** Colour some text bright black (grey). */
     blackBright: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make some text bright red.
-     *
-     * @param input The text to colour.
-     * @returns If colours are enabled, `input` coloured bright red.
-     */
+    /** Colour some text bright red. */
     redBright: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make some text bright green.
-     *
-     * @param input The text to colour.
-     * @returns If colours are enabled, `input` coloured bright green.
-     */
+    /** Colour some text bright green. */
     greenBright: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make some text bright yellow.
-     *
-     * @param input The text to colour.
-     * @returns If colours are enabled, `input` coloured bright yellow.
-     */
+    /** Colour some text bright yellow. */
     yellowBright: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make some text bright blue.
-     *
-     * @param input The text to colour.
-     * @returns If colours are enabled, `input` coloured bright blue.
-     */
+    /** Colour some text bright blue. */
     blueBright: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make some text bright magenta.
-     *
-     * @param input The text to colour.
-     * @returns If colours are enabled, `input` coloured bright magenta.
-     */
+    /** Colour some text bright magenta. */
     magentaBright: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make some text bright cyran.
-     *
-     * @param input The text to colour.
-     * @returns If colours are enabled, `input` coloured bright cyan.
-     */
+    /** Colour some text bright cyan. */
     cyanBright: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make some text bright white.
-     *
-     * @param input The text to colour.
-     * @returns If colours are enabled, `input` coloured bright white.
-     */
+    /** Colour some text bright white. */
     whiteBright: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make the background of some text black.
-     *
-     * @param input The text whose background to colour.
-     * @returns If colours are enabled, `input` with a black background.
-     */
+    /** Colour the background of some text black. */
     bgBlack: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make the background of some text red.
-     *
-     * @param input The text whose background to colour.
-     * @returns If colours are enabled, `input` with a red background.
-     */
+    /** Colour the background of some text red. */
     bgRed: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make the background of some text green.
-     *
-     * @param input The text whose background to colour.
-     * @returns If colours are enabled, `input` with a green background.
-     */
+    /** Colour the background of some text green. */
     bgGreen: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make the background of some text yellow.
-     *
-     * @param input The text whose background to colour.
-     * @returns If colours are enabled, `input` with a yellow background.
-     */
+    /** Colour the background of some text yellow. */
     bgYellow: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make the background of some text blue.
-     *
-     * @param input The text whose background to colour.
-     * @returns If colours are enabled, `input` with a blue background.
-     */
+    /** Colour the background of some text blue. */
     bgBlue: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make the background of some text magenta.
-     *
-     * @param input The text whose background to colour.
-     * @returns If colours are enabled, `input` with a magenta background.
-     */
+    /** Colour the background of some text magenta. */
     bgMagenta: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make the background of some text cyan.
-     *
-     * @param input The text whose background to colour.
-     * @returns If colours are enabled, `input` with a cyan background.
-     */
+    /** Colour the background of some text cyan. */
     bgCyan: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make the background of some text white.
-     *
-     * @param input The text whose background to colour.
-     * @returns If colours are enabled, `input` with a white background.
-     */
+    /** Colour the background of some text white. */
     bgWhite: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make the background of some text bright black (grey).
-     *
-     * @param input The text whose background to colour.
-     * @returns If colours are enabled, `input` with a bright black (grey) background.
-     */
+    /** Colour the background of some text bright black (grey). */
     bgBlackBright: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make the background of some text bright red.
-     *
-     * @param input The text whose background to colour.
-     * @returns If colours are enabled, `input` with a bright re backgroundd.
-     */
+    /** Colour the background of some text bright red. */
     bgRedBright: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make the background of some text bright green.
-     *
-     * @param input The text whose background to colour.
-     * @returns If colours are enabled, `input` with a bright gree backgroundn.
-     */
+    /** Colour the background of some text bright green. */
     bgGreenBright: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make the background of some text bright yellow.
-     *
-     * @param input The text whose background to colour.
-     * @returns If colours are enabled, `input` with a bright yello backgroundw.
-     */
+    /** Colour the background of some text bright yellow. */
     bgYellowBright: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make the background of some text bright blue.
-     *
-     * @param input The text whose background to colour.
-     * @returns If colours are enabled, `input` with a bright blu backgrounde.
-     */
+    /** Colour the background of some text bright blue. */
     bgBlueBright: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make the background of some text bright magenta.
-     *
-     * @param input The text whose background to colour.
-     * @returns If colours are enabled, `input` with a bright magent backgrounda.
-     */
+    /** Colour the background of some text bright magenta. */
     bgMagentaBright: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make the background of some text bright cyan.
-     *
-     * @param input The desired text to be styled.
-     * @returns If colours are enabled, `input` with a bright cyan background.
-     */
+    /** Colour the background of some text bright cyan. */
     bgCyanBright: (input: string | TemplateStringsArray) => string;
-    /**
-     * Make the background of some text bright white.
-     *
-     * @param input The desired text to be styled.
-     * @returns If colours are enabled, `input` with a bright white background.
-     */
+    /** Colour the background of some text bright white. */
     bgWhiteBright: (input: string | TemplateStringsArray) => string;
     /**
      * Make some text or its background one of 256 colours.
@@ -324,7 +143,7 @@ interface Termark {
      * @returns If terminal colours are enabled and [8-bit colours](https://en.wikipedia.org/wiki/ANSI_escape_code#8-bit) are supported, the stylized text. If either is false, it returns the plain string.
      * @see https://en.wikipedia.org/wiki/ANSI_escape_code#8-bit
      */
-    ansi256: (type: 'text' | 'background', color: number) => (input: string | TemplateStringsArray) => string;
+    ansi256(type: ANSIStyleType, color: number): (input: string | TemplateStringsArray) => string;
     /**
      * Make some text or its background using custom RGB values.
      *
@@ -340,7 +159,7 @@ interface Termark {
      * termark.rgb('text', [85, 222, 124])('...');
      * ```
      */
-    rgb: (type: 'text' | 'background', ...rgb: [number, number, number] | [[number, number, number]]) => (input: string | TemplateStringsArray) => string;
+    rgb(type: ANSIStyleType, ...rgb: RGB | [RGB]): (input: string | TemplateStringsArray) => string;
     /**
      * Apply a gradient to some text or its background.
      *
@@ -357,7 +176,7 @@ interface Termark {
      * termark.gradient('background', [[222, 111, 0], [93, 255, 68], [0, 224, 110]])('...');
      * ```
      */
-    gradient: (type: 'text' | 'background', colors: [number, number, number][]) => (input: string | TemplateStringsArray) => string;
+    gradient(type: ANSIStyleType, colors: RGB[]): (input: string | TemplateStringsArray) => string;
     /**
      * Logs a `message` to the console on the `info` level.
      *
@@ -374,7 +193,7 @@ interface Termark {
      * termark.success('...'); // Logs "..." in green as a success (info).
      * ```
      */
-    success: (message: string, prefix?: string) => void;
+    success(message: string, prefix?: string): void;
     /**
      * Logs a `message` to the console on the `info` level.
      *
@@ -388,7 +207,7 @@ interface Termark {
      * termark.info('...'); // Logs "..." in blue as an info.
      * ```
      */
-    info: (message: string, prefix?: string) => void;
+    info(message: string, prefix?: string): void;
     /**
      * Logs a `message` to the console on the `error` level.
      *
@@ -406,7 +225,7 @@ interface Termark {
      * termark.warn('...'); // Logs "..." in yellow as a warning (error).
      * ```
      */
-    warn: (message: string, prefix?: string) => void;
+    warn(message: string, prefix?: string): void;
     /**
      * Logs a `message` to the console on the `error` level.
      *
@@ -420,7 +239,7 @@ interface Termark {
      * termark.error('...'); // Logs "..." in red as an error.
      * ```
      */
-    error: (message: string, prefix?: string) => void;
+    error(message: string, prefix?: string): void;
     /**
      * Style some text using entirely custom settings.
      *
@@ -442,7 +261,7 @@ interface Termark {
      * termark.custom('58;2;33', 59)('...'); // This should result in a string with a blue underline.
      * ```
      */
-    custom: (opener: number | string, closer: number | string, type: 'asFormat' | 'asColor') => (input: string | TemplateStringsArray) => string;
+    custom(opener: string | number, closer: string | number, type: 'asColor' | 'asFormat'): (input: string | TemplateStringsArray) => string;
 }
 /**
  * The `termark` object enables accessing all features of Termark:
@@ -470,7 +289,7 @@ interface Termark {
  * termark.is24bitEnabled; // Check whether 24-bit (truecolor) colours are enabled
  * ```
  *
- * In addition, properties on the `termark` object are static, i.e., they only do one thing, and you have no input on it.
+ * In addition, properties on the `Termark` class are static-ish, i.e., they only do one thing, and you have no input on it.
  *
  * ---
  *
@@ -491,6 +310,8 @@ interface Termark {
  *
  * @example
  * ```typescript
+ * import termark from 'termark';
+ *
  * termark.ansi256('text', 33)('This is blue text');
  * termark.ansi256('text', 33)`This is also blue text`;
  * ```
@@ -501,6 +322,8 @@ interface Termark {
  * a function to specify your input. These ones are:
  *
  * ```typescript
+ * import termark from 'termark';
+ *
  * termark.success('...');
  * termark.info('...');
  * termark.warn('...');
@@ -512,3 +335,4 @@ interface Termark {
  */
 declare const termark: Termark;
 export default termark;
+export declare const areColorsEnabled: boolean, is8bitEnabled: boolean, is24bitEnabled: boolean, reset: (input: string | TemplateStringsArray) => string, bold: (input: string | TemplateStringsArray) => string, dim: (input: string | TemplateStringsArray) => string, italic: (input: string | TemplateStringsArray) => string, underline: (input: string | TemplateStringsArray) => string, blink: (input: string | TemplateStringsArray) => string, inverse: (input: string | TemplateStringsArray) => string, overline: (input: string | TemplateStringsArray) => string, hidden: (input: string | TemplateStringsArray) => string, strike: (input: string | TemplateStringsArray) => string, black: (input: string | TemplateStringsArray) => string, red: (input: string | TemplateStringsArray) => string, green: (input: string | TemplateStringsArray) => string, yellow: (input: string | TemplateStringsArray) => string, blue: (input: string | TemplateStringsArray) => string, magenta: (input: string | TemplateStringsArray) => string, cyan: (input: string | TemplateStringsArray) => string, white: (input: string | TemplateStringsArray) => string, blackBright: (input: string | TemplateStringsArray) => string, redBright: (input: string | TemplateStringsArray) => string, greenBright: (input: string | TemplateStringsArray) => string, yellowBright: (input: string | TemplateStringsArray) => string, blueBright: (input: string | TemplateStringsArray) => string, magentaBright: (input: string | TemplateStringsArray) => string, cyanBright: (input: string | TemplateStringsArray) => string, whiteBright: (input: string | TemplateStringsArray) => string, bgBlack: (input: string | TemplateStringsArray) => string, bgRed: (input: string | TemplateStringsArray) => string, bgGreen: (input: string | TemplateStringsArray) => string, bgYellow: (input: string | TemplateStringsArray) => string, bgBlue: (input: string | TemplateStringsArray) => string, bgMagenta: (input: string | TemplateStringsArray) => string, bgCyan: (input: string | TemplateStringsArray) => string, bgWhite: (input: string | TemplateStringsArray) => string, bgBlackBright: (input: string | TemplateStringsArray) => string, bgRedBright: (input: string | TemplateStringsArray) => string, bgGreenBright: (input: string | TemplateStringsArray) => string, bgYellowBright: (input: string | TemplateStringsArray) => string, bgBlueBright: (input: string | TemplateStringsArray) => string, bgMagentaBright: (input: string | TemplateStringsArray) => string, bgCyanBright: (input: string | TemplateStringsArray) => string, bgWhiteBright: (input: string | TemplateStringsArray) => string, ansi256: (type: ANSIStyleType, color: number) => (input: string | TemplateStringsArray) => string, rgb: (type: ANSIStyleType, ...rgb: RGB | [RGB]) => (input: string | TemplateStringsArray) => string, gradient: (type: ANSIStyleType, colors: RGB[]) => (input: string | TemplateStringsArray) => string, success: (message: string, prefix?: string) => void, info: (message: string, prefix?: string) => void, warn: (message: string, prefix?: string) => void, error: (message: string, prefix?: string) => void, custom: (opener: string | number, closer: string | number, type: "asColor" | "asFormat") => (input: string | TemplateStringsArray) => string;

package/dist/index.mjs

@@ -1,179 +1 @@
-/*
-Copyright 2025 Q
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-*/
-
-const areColoursEnabled = () => {
-    const noColour = process.env.NO_COLOR;
-    return noColour ? false : true;
-};
-const getColourSupport = () => {
-    const colourTerm = process.env.COLORTERM;
-    const is16bit = colourTerm ? (colourTerm.includes('ansi') && !(colourTerm.includes('256'))) : false;
-    const is256 = colourTerm ? colourTerm.includes('ansi256') : false;
-    const isTrueColor = colourTerm ? (colourTerm.includes('truecolor') || colourTerm.includes('24bit')) : false;
-    return {
-        is16bit,
-        is256,
-        isTrueColor
-    };
-};
-function format(open, close, type) {
-    if (type === 'color' && !areColoursEnabled())
-        return (input) => input.toString();
-    const opener = `\x1b[${open}m`;
-    const closer = `\x1b[${close}m`;
-    return (input$1) => {
-        const input = input$1.toString().trim();
-        const index = input.indexOf(closer);
-        if (index === -1)
-            return `${opener}${input}${closer}`;
-        return `${opener}${input.replaceAll(closer, closer + opener)}${closer}`;
-    };
-}
-function interpolate(color1, color2, factor) {
-    return [
-        Math.round(color1[0] + factor * (color2[0] - color1[0])),
-        Math.round(color1[1] + factor * (color2[1] - color1[1])),
-        Math.round(color1[2] + factor * (color2[2] - color1[2])),
-    ];
-}
-
-const termark = {
-    areColorsEnabled: areColoursEnabled(),
-    is8bitEnabled: getColourSupport().is256,
-    is24bitEnabled: getColourSupport().isTrueColor,
-    reset: format(0, 0, 'format'),
-    bold: format(1, 22, 'format'),
-    dim: format(2, 22, 'format'),
-    italic: format(3, 23, 'format'),
-    underline: format(4, 24, 'format'),
-    blink: format(5, 25, 'format'),
-    inverse: format(7, 27, 'format'),
-    overline: format(53, 55, 'format'),
-    hidden: format(8, 28, 'format'),
-    strike: format(9, 29, 'format'),
-    black: format(30, 39, 'color'),
-    red: format(31, 39, 'color'),
-    green: format(32, 39, 'color'),
-    yellow: format(33, 39, 'color'),
-    blue: format(34, 39, 'color'),
-    magenta: format(35, 39, 'color'),
-    cyan: format(36, 39, 'color'),
-    white: format(37, 39, 'color'),
-    blackBright: format(90, 39, 'color'),
-    redBright: format(91, 39, 'color'),
-    greenBright: format(92, 39, 'color'),
-    yellowBright: format(93, 39, 'color'),
-    blueBright: format(94, 39, 'color'),
-    magentaBright: format(95, 39, 'color'),
-    cyanBright: format(96, 39, 'color'),
-    whiteBright: format(97, 39, 'color'),
-    bgBlack: format(40, 49, 'color'),
-    bgRed: format(41, 49, 'color'),
-    bgGreen: format(42, 49, 'color'),
-    bgYellow: format(43, 49, 'color'),
-    bgBlue: format(44, 49, 'color'),
-    bgMagenta: format(45, 49, 'color'),
-    bgCyan: format(46, 49, 'color'),
-    bgWhite: format(47, 49, 'color'),
-    bgBlackBright: format(100, 49, 'color'),
-    bgRedBright: format(101, 49, 'color'),
-    bgGreenBright: format(102, 49, 'color'),
-    bgYellowBright: format(103, 49, 'color'),
-    bgBlueBright: format(104, 49, 'color'),
-    bgMagentaBright: format(105, 49, 'color'),
-    bgCyanBright: format(106, 49, 'color'),
-    bgWhiteBright: format(107, 49, 'color'),
-    ansi256(type, color) {
-        if (color < 0 || color > 255)
-            throw new Error(termark.red('Value `color` is out of range! The value must be a number between 0 and 255!'));
-        if (!getColourSupport().is256 || !areColoursEnabled())
-            return (input) => input.toString();
-        const textFormat = `38;5;${color}`;
-        const bgFormat = `48;5;${color}`;
-        const opener = type === 'text' ? textFormat : bgFormat;
-        const closer = type === 'text' ? 39 : 49;
-        return format(opener, closer, 'color');
-    },
-    rgb(type, ...rgb) {
-        let red;
-        let green;
-        let blue;
-        if (Array.isArray(rgb[0])) {
-            red = rgb[0][0];
-            green = rgb[0][1];
-            blue = rgb[0][2];
-        }
-        else {
-            red = rgb[0];
-            green = rgb[1];
-            blue = rgb[2];
-        }
-        if (((typeof red === 'number') && (red < 0 || red > 255)) ||
-            ((typeof green === 'number') && (green < 0 || green > 255)) ||
-            ((typeof blue === 'number') && (blue < 0 || blue > 255)))
-            throw new Error(termark.red('One or multiple of the colours specified is out of range! Each colour can have a value only between 0 and 255!'));
-        if (!getColourSupport().isTrueColor)
-            return (input) => input.toString();
-        const textFormat = `38;2;${red};${green};${blue}`;
-        const bgFormat = `48;2;${red};${green};${blue}`;
-        const opener = type === 'text' ? textFormat : bgFormat;
-        const closer = type === 'text' ? 39 : 49;
-        return format(opener, closer, 'color');
-    },
-    gradient(type, colors) {
-        if (!areColoursEnabled() || !getColourSupport().isTrueColor)
-            return (input) => input.toString();
-        const textFormat = `38;2;`;
-        const bgFormat = `48;2;`;
-        const opener = type === 'text' ? `\x1b[${textFormat}` : `\x1b[${bgFormat}`;
-        const closer = type === 'text' ? `\x1b[${39}m` : `\x1b[${49}m`;
-        return (input$1) => {
-            const input = input$1.toString().trim();
-            const colourCount = colors.length;
-            const step = Math.min(input.length / (colourCount - 1));
-            let result = '';
-            for (let character = 0; character < input.length; character++) {
-                const colourIndex = Math.min(Math.floor(character / step), colourCount - 2);
-                const factor = (character % step) / step;
-                const startColour = colors[colourIndex];
-                const endColour = colors[colourIndex + 1];
-                const interpolatedColour = interpolate(startColour, endColour, factor);
-                result += `${opener}${interpolatedColour[0]};${interpolatedColour[1]};${interpolatedColour[2]}m${input[character]}${closer}`;
-            }
-            return result;
-        };
-    },
-    success(message, prefix = '') {
-        console.info(`${prefix}${termark.green(message)}`);
-    },
-    info(message, prefix = '') {
-        console.info(`${prefix}${termark.blue(message)}`);
-    },
-    warn(message, prefix = '') {
-        console.warn(`${prefix}${termark.yellow(message)}`);
-    },
-    error(message, prefix = '') {
-        console.error(`${prefix}${termark.red(message)}`);
-    },
-    custom(opener, closer, type) {
-        const formatType = type === 'asColor' ? 'color' : 'format';
-        return format(opener, closer, formatType);
-    },
-};
-
-export { termark as default };
-
-// Copyright (C) 2025 Q
+const t=()=>!process.env.NO_COLOR,r=()=>{const t=process.env.COLORTERM;return{is16bit:!!t&&(t.includes("ansi")&&!t.includes("256")),is256:!!t&&t.includes("ansi256"),isTrueColor:!!t&&(t.includes("truecolor")||t.includes("24bit"))}};function e(r,e,i){if("color"===i&&!t())return t=>t.toString();const o=`[${r}m`,n=`[${e}m`;return t=>{const r=t.toString().trim();return-1===r.indexOf(n)?`${o}${r}${n}`:`${o}${r.replaceAll(n,n+o)}${n}`}}function i(t,r,e){return[Math.round(t[0]+e*(r[0]-t[0])),Math.round(t[1]+e*(r[1]-t[1])),Math.round(t[2]+e*(r[2]-t[2]))]}class o{constructor(){this.areColorsEnabled=t(),this.is8bitEnabled=r().is256,this.is24bitEnabled=r().isTrueColor,this.reset=e(0,0,"format"),this.bold=e(1,22,"format"),this.dim=e(2,22,"format"),this.italic=e(3,23,"format"),this.underline=e(4,24,"format"),this.blink=e(5,25,"format"),this.inverse=e(7,27,"format"),this.overline=e(53,55,"format"),this.hidden=e(8,28,"format"),this.strike=e(9,29,"format"),this.black=e(30,39,"color"),this.red=e(31,39,"color"),this.green=e(32,39,"color"),this.yellow=e(33,39,"color"),this.blue=e(34,39,"color"),this.magenta=e(35,39,"color"),this.cyan=e(36,39,"color"),this.white=e(37,39,"color"),this.blackBright=e(90,39,"color"),this.redBright=e(91,39,"color"),this.greenBright=e(92,39,"color"),this.yellowBright=e(93,39,"color"),this.blueBright=e(94,39,"color"),this.magentaBright=e(95,39,"color"),this.cyanBright=e(96,39,"color"),this.whiteBright=e(97,39,"color"),this.bgBlack=e(40,49,"color"),this.bgRed=e(41,49,"color"),this.bgGreen=e(42,49,"color"),this.bgYellow=e(43,49,"color"),this.bgBlue=e(44,49,"color"),this.bgMagenta=e(45,49,"color"),this.bgCyan=e(46,49,"color"),this.bgWhite=e(47,49,"color"),this.bgBlackBright=e(100,49,"color"),this.bgRedBright=e(101,49,"color"),this.bgGreenBright=e(102,49,"color"),this.bgYellowBright=e(103,49,"color"),this.bgBlueBright=e(104,49,"color"),this.bgMagentaBright=e(105,49,"color"),this.bgCyanBright=e(106,49,"color"),this.bgWhiteBright=e(107,49,"color")}static get init(){return new this.termarkInstance}ansi256(i,n){if(n<0||n>255)throw new Error(o.init.red("Value `color` is out of range! The value must be a number between 0 and 255!"));if(!r().is256||!t())return t=>t.toString();return e("text"===i?`38;5;${n}`:`48;5;${n}`,"text"===i?39:49,"color")}rgb(t,...i){let n,l,s;if(Array.isArray(i[0])?(n=i[0][0],l=i[0][1],s=i[0][2]):(n=i[0],l=i[1],s=i[2]),"number"==typeof n&&(n<0||n>255)||"number"==typeof l&&(l<0||l>255)||"number"==typeof s&&(s<0||s>255))throw new Error(o.init.red("One or multiple of the colours specified is out of range! Each colour can have a value only between 0 and 255!"));if(!r().isTrueColor)return t=>t.toString();return e("text"===t?`38;2;${n};${l};${s}`:`48;2;${n};${l};${s}`,"text"===t?39:49,"color")}gradient(e,o){if(!t()||!r().isTrueColor)return t=>t.toString();const n="text"===e?"[38;2;":"[48;2;",l="text"===e?"":"";return t=>{const r=t.toString().trim(),e=o.length,s=Math.min(r.length/(e-1));let h="";for(let t=0;t<r.length;t++){const g=Math.min(Math.floor(t/s),e-2),a=t%s/s,c=i(o[g],o[g+1],a);h+=`${n}${c[0]};${c[1]};${c[2]}m${r[t]}${l}`}return h}}success(t,r=""){console.info(`${r}${o.init.green(t)}`)}info(t,r=""){console.info(`${r}${o.init.blue(t)}`)}warn(t,r=""){console.warn(`${r}${o.init.yellow(t)}`)}error(t,r=""){console.error(`${r}${o.init.red(t)}`)}custom(t,r,i){return e(t,r,"asColor"===i?"color":"format")}}o.termarkInstance=o;const n=new o,{areColorsEnabled:l,is8bitEnabled:s,is24bitEnabled:h,reset:g,bold:a,dim:c,italic:b,underline:u,blink:d,inverse:B,overline:m,hidden:f,strike:$,black:w,red:y,green:k,yellow:C,blue:M,magenta:E,cyan:p,white:v,blackBright:x,redBright:O,greenBright:R,yellowBright:S,blueBright:T,magentaBright:G,cyanBright:W,whiteBright:Y,bgBlack:A,bgRed:I,bgGreen:L,bgYellow:N,bgBlue:V,bgMagenta:_,bgCyan:j,bgWhite:q,bgBlackBright:z,bgRedBright:D,bgGreenBright:F,bgYellowBright:H,bgBlueBright:J,bgMagentaBright:K,bgCyanBright:P,bgWhiteBright:Q,ansi256:U,rgb:X,gradient:Z,success:tt,info:rt,warn:et,error:it,custom:ot}=n;export{o as Termark,U as ansi256,l as areColorsEnabled,A as bgBlack,z as bgBlackBright,V as bgBlue,J as bgBlueBright,j as bgCyan,P as bgCyanBright,L as bgGreen,F as bgGreenBright,_ as bgMagenta,K as bgMagentaBright,I as bgRed,D as bgRedBright,q as bgWhite,Q as bgWhiteBright,N as bgYellow,H as bgYellowBright,w as black,x as blackBright,d as blink,M as blue,T as blueBright,a as bold,ot as custom,p as cyan,W as cyanBright,n as default,c as dim,it as error,Z as gradient,k as green,R as greenBright,f as hidden,rt as info,B as inverse,h as is24bitEnabled,s as is8bitEnabled,b as italic,E as magenta,G as magentaBright,m as overline,y as red,O as redBright,g as reset,X as rgb,$ as strike,tt as success,u as underline,et as warn,v as white,Y as whiteBright,C as yellow,S as yellowBright};

package/dist/util.d.ts

@@ -1,3 +1,5 @@
+export type ANSIStyleType = 'text' | 'background';
+export type RGB = [number, number, number];
 /**
  * Check whether terminal colours are supported/enabled.
  *
@@ -46,4 +48,4 @@ export declare function format(open: number | string, close: number | string, ty
  * @param factor How to calculate the colour.
  * @returns An RGB value that is the colour between `color1` and `color2` at `factor`.
  */
-export declare function interpolate(color1: [number, number, number], color2: [number, number, number], factor: number): [number, number, number];
+export declare function interpolate(color1: RGB, color2: RGB, factor: number): RGB;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "termark",
-    "version": "1.0.0",
+    "version": "2.0.0",
     "main": "./dist/index.cjs",
     "module": "./dist/index.mjs",
     "exports": {
@@ -30,9 +30,9 @@
         "url": "https://codeberg.org/Genesis_Software/termark.git"
     },
     "devDependencies": {
+        "@rollup/plugin-terser": "^0.4.4",
         "@types/node": "^24.3.0",
         "rollup": "^4.49.0",
-        "rollup-plugin-cleanup": "^3.2.1",
         "rollup-plugin-typescript2": "^0.36.0",
         "typescript": "^5.9.2"
     }