@ztimson/utils 0.28.13 → 0.28.14

package/dist/color.d.ts

@@ -1,6 +1,19 @@
 /**
  * Determine if either black or white provides more contrast to the provided color
- * @param {string} background Color to compare against
+ * @param {string} color Color to compare against
  * @return {"white" | "black"} Color with the most contrast
  */
-export declare function contrast(background: string): 'white' | 'black';
+export declare function contrast(color: string): 'white' | 'black';
+export declare function hex2Int(hex: string): {
+    r: number;
+    g: number;
+    b: number;
+};
+export declare function hue2rgb(p: number, q: number, t: number): number;
+export declare function int2Hex(r: number, g: number, b: number): string;
+/**
+ * Adjusts the darkness of a hex color.
+ * @param {string} hex - The hex color (e.g., '#ff0000').
+ * @param {number} amount - A value between -1 (black) and 1 (white)
+ */
+export declare function shadeColor(hex: string, amount: number): string;

package/dist/index.cjs

@@ -669,13 +669,101 @@ ${opts.message || this.desc}`;
     /** Get all cached items */
     values = this.all;
   }
-  function contrast(background) {
-    const exploded = background?.match(background.length >= 6 ? /[0-9a-fA-F]{2}/g : /[0-9a-fA-F]/g);
+  function dec2Frac(num, maxDen = 1e3) {
+    let sign = Math.sign(num);
+    num = Math.abs(num);
+    if (Number.isInteger(num)) return sign * num + "";
+    let closest = { n: 0, d: 1, diff: Math.abs(num) };
+    for (let d = 1; d <= maxDen; d++) {
+      let n = Math.round(num * d);
+      let diff = Math.abs(num - n / d);
+      if (diff < closest.diff) {
+        closest = { n, d, diff };
+        if (diff < 1e-8) break;
+      }
+    }
+    let integer = Math.floor(closest.n / closest.d);
+    let numerator = closest.n - integer * closest.d;
+    return (sign < 0 ? "-" : "") + (integer ? integer + " " : "") + (numerator ? numerator + "/" + closest.d : "");
+  }
+  function dec2Hex(num) {
+    const hex = Math.round(num * 255).toString(16);
+    return hex.length === 1 ? "0" + hex : hex;
+  }
+  function frac2Dec(frac) {
+    let split = frac.split(" ");
+    const whole = split.length == 2 ? Number(split[0]) : 0;
+    split = split.pop().split("/");
+    return whole + Number(split[0]) / Number(split[1]);
+  }
+  function numSuffix(n) {
+    const s = ["th", "st", "nd", "rd"], v = n % 100;
+    return `${n}${s[(v - 20) % 10] || s[v] || s[0]}`;
+  }
+  function contrast(color) {
+    const exploded = color?.match(color.length >= 6 ? /[0-9a-fA-F]{2}/g : /[0-9a-fA-F]/g);
     if (!exploded || exploded?.length < 3) return "black";
     const [r, g, b] = exploded.map((hex) => parseInt(hex.length == 1 ? `${hex}${hex}` : hex, 16));
     const luminance = (0.299 * r + 0.587 * g + 0.114 * b) / 255;
     return luminance > 0.5 ? "black" : "white";
   }
+  function hex2Int(hex) {
+    let r = 0, g = 0, b = 0;
+    if (hex.length === 4) {
+      r = parseInt(hex[1] + hex[1], 16);
+      g = parseInt(hex[2] + hex[2], 16);
+      b = parseInt(hex[3] + hex[3], 16);
+    } else {
+      r = parseInt(hex.slice(1, 3), 16);
+      g = parseInt(hex.slice(3, 5), 16);
+      b = parseInt(hex.slice(5, 7), 16);
+    }
+    return { r, g, b };
+  }
+  function hue2rgb(p, q, t) {
+    if (t < 0) t += 1;
+    if (t > 1) t -= 1;
+    if (t < 1 / 6) return p + (q - p) * 6 * t;
+    if (t < 1 / 2) return q;
+    if (t < 2 / 3) return p + (q - p) * (2 / 3 - t) * 6;
+    return p;
+  }
+  function int2Hex(r, g, b) {
+    return "#" + dec2Hex(r) + dec2Hex(g) + dec2Hex(b);
+  }
+  function shadeColor(hex, amount) {
+    let { r, g, b } = hex2Int(hex);
+    r /= 255;
+    g /= 255;
+    b /= 255;
+    const max = Math.max(r, g, b), min = Math.min(r, g, b);
+    let h, s, l = (max + min) / 2;
+    if (max === min) {
+      h = s = 0;
+    } else {
+      const d = max - min;
+      s = l > 0.5 ? d / (2 - max - min) : d / (max + min);
+      switch (max) {
+        case r:
+          h = (g - b) / d + (g < b ? 6 : 0);
+          break;
+        case g:
+          h = (b - r) / d + 2;
+          break;
+        case b:
+          h = (r - g) / d + 4;
+          break;
+        default:
+          h = 0;
+          break;
+      }
+      h /= 6;
+    }
+    l = Math.max(0, Math.min(1, l + amount));
+    const q = l < 0.5 ? l * (1 + s) : l + s - l * s;
+    const p = 2 * l - q;
+    return int2Hex(hue2rgb(p, q, h + 1 / 3), hue2rgb(p, q, h), hue2rgb(p, q, h - 1 / 3));
+  }
   const LETTER_LIST = "ABCDEFGHIJKLMNOPQRSTUVWXYZ";
   const NUMBER_LIST = "0123456789";
   const SYMBOL_LIST = "~`!@#$%^&*()_-+={[}]|\\:;\"'<,>.?/";
@@ -1802,33 +1890,6 @@ ${opts.message || this.desc}`;
       console.error(CliForeground.RED + str + CliEffects.CLEAR);
     }
   }
-  function dec2Frac(num, maxDen = 1e3) {
-    let sign = Math.sign(num);
-    num = Math.abs(num);
-    if (Number.isInteger(num)) return sign * num + "";
-    let closest = { n: 0, d: 1, diff: Math.abs(num) };
-    for (let d = 1; d <= maxDen; d++) {
-      let n = Math.round(num * d);
-      let diff = Math.abs(num - n / d);
-      if (diff < closest.diff) {
-        closest = { n, d, diff };
-        if (diff < 1e-8) break;
-      }
-    }
-    let integer = Math.floor(closest.n / closest.d);
-    let numerator = closest.n - integer * closest.d;
-    return (sign < 0 ? "-" : "") + (integer ? integer + " " : "") + (numerator ? numerator + "/" + closest.d : "");
-  }
-  function fracToDec(frac) {
-    let split = frac.split(" ");
-    const whole = split.length == 2 ? Number(split[0]) : 0;
-    split = split.pop().split("/");
-    return whole + Number(split[0]) / Number(split[1]);
-  }
-  function numSuffix(n) {
-    const s = ["th", "st", "nd", "rd"], v = n % 100;
-    return `${n}${s[(v - 20) % 10] || s[v] || s[0]}`;
-  }
   function compareVersions(target, vs) {
     const [tMajor, tMinor, tPatch] = target.split(".").map((v) => +v.replace(/[^0-9]/g, ""));
     const [vMajor, vMinor, vPatch] = vs.split(".").map((v) => +v.replace(/[^0-9]/g, ""));
@@ -2977,6 +3038,7 @@ ${err.message || err.toString()}`);
   exports2.dayOfWeek = dayOfWeek;
   exports2.dayOfYear = dayOfYear;
   exports2.dec2Frac = dec2Frac;
+  exports2.dec2Hex = dec2Hex;
   exports2.decodeJwt = decodeJwt;
   exports2.deepCopy = deepCopy;
   exports2.deepMerge = deepMerge;
@@ -2998,12 +3060,15 @@ ${err.message || err.toString()}`);
   exports2.formatDate = formatDate;
   exports2.formatMs = formatMs;
   exports2.formatPhoneNumber = formatPhoneNumber;
-  exports2.fracToDec = fracToDec;
+  exports2.frac2Dec = frac2Dec;
   exports2.fromCsv = fromCsv;
   exports2.gravatar = gravatar;
+  exports2.hex2Int = hex2Int;
+  exports2.hue2rgb = hue2rgb;
   exports2.includes = includes;
   exports2.insertAt = insertAt;
   exports2.instantInterval = instantInterval;
+  exports2.int2Hex = int2Hex;
   exports2.ipV6ToV4 = ipV6ToV4;
   exports2.isEqual = isEqual;
   exports2.kebabCase = kebabCase;
@@ -3027,6 +3092,7 @@ ${err.message || err.toString()}`);
   exports2.renderTemplate = renderTemplate;
   exports2.reservedIp = reservedIp;
   exports2.search = search;
+  exports2.shadeColor = shadeColor;
   exports2.sleep = sleep;
   exports2.sleepWhile = sleepWhile;
   exports2.snakeCase = snakeCase;