@design-edito/tools 0.4.5 → 0.4.6

package/agnostic/colors/typechecks/index.js

@@ -1,259 +1,197 @@
-// src/agnostic/objects/is-object/index.ts
-function isObject(unk) {
-  return typeof unk === "object";
-}
-function isNonNullObject(unk) {
-  return unk !== null && isObject(unk);
-}
-
-// src/agnostic/colors/cssColorsMap.ts
-var cssColors = {
-  aliceblue: { r: 240, g: 248, b: 255 },
-  antiquewhite: { r: 250, g: 235, b: 215 },
-  aqua: { r: 0, g: 255, b: 255 },
-  aquamarine: { r: 127, g: 255, b: 212 },
-  azure: { r: 240, g: 255, b: 255 },
-  beige: { r: 245, g: 245, b: 220 },
-  bisque: { r: 255, g: 228, b: 196 },
-  black: { r: 0, g: 0, b: 0 },
-  blanchedalmond: { r: 255, g: 235, b: 205 },
-  blue: { r: 0, g: 0, b: 255 },
-  blueviolet: { r: 138, g: 43, b: 226 },
-  brown: { r: 165, g: 42, b: 42 },
-  burlywood: { r: 222, g: 184, b: 135 },
-  cadetblue: { r: 95, g: 158, b: 160 },
-  chartreuse: { r: 127, g: 255, b: 0 },
-  chocolate: { r: 210, g: 105, b: 30 },
-  coral: { r: 255, g: 127, b: 80 },
-  cornflowerblue: { r: 100, g: 149, b: 237 },
-  cornsilk: { r: 255, g: 248, b: 220 },
-  crimson: { r: 220, g: 20, b: 60 },
-  cyan: { r: 0, g: 255, b: 255 },
-  darkblue: { r: 0, g: 0, b: 139 },
-  darkcyan: { r: 0, g: 139, b: 139 },
-  darkgoldenrod: { r: 184, g: 134, b: 11 },
-  darkgray: { r: 169, g: 169, b: 169 },
-  darkgreen: { r: 0, g: 100, b: 0 },
-  darkgrey: { r: 169, g: 169, b: 169 },
-  darkkhaki: { r: 189, g: 183, b: 107 },
-  darkmagenta: { r: 139, g: 0, b: 139 },
-  darkolivegreen: { r: 85, g: 107, b: 47 },
-  darkorange: { r: 255, g: 140, b: 0 },
-  darkorchid: { r: 153, g: 50, b: 204 },
-  darkred: { r: 139, g: 0, b: 0 },
-  darksalmon: { r: 233, g: 150, b: 122 },
-  darkseagreen: { r: 143, g: 188, b: 143 },
-  darkslateblue: { r: 72, g: 61, b: 139 },
-  darkslategray: { r: 47, g: 79, b: 79 },
-  darkslategrey: { r: 47, g: 79, b: 79 },
-  darkturquoise: { r: 0, g: 206, b: 209 },
-  darkviolet: { r: 148, g: 0, b: 211 },
-  deeppink: { r: 255, g: 20, b: 147 },
-  deepskyblue: { r: 0, g: 191, b: 255 },
-  dimgray: { r: 105, g: 105, b: 105 },
-  dimgrey: { r: 105, g: 105, b: 105 },
-  dodgerblue: { r: 30, g: 144, b: 255 },
-  firebrick: { r: 178, g: 34, b: 34 },
-  floralwhite: { r: 255, g: 250, b: 240 },
-  forestgreen: { r: 34, g: 139, b: 34 },
-  fuchsia: { r: 255, g: 0, b: 255 },
-  gainsboro: { r: 220, g: 220, b: 220 },
-  ghostwhite: { r: 248, g: 248, b: 255 },
-  gold: { r: 255, g: 215, b: 0 },
-  goldenrod: { r: 218, g: 165, b: 32 },
-  gray: { r: 128, g: 128, b: 128 },
-  green: { r: 0, g: 128, b: 0 },
-  greenyellow: { r: 173, g: 255, b: 47 },
-  grey: { r: 128, g: 128, b: 128 },
-  honeydew: { r: 240, g: 255, b: 240 },
-  hotpink: { r: 255, g: 105, b: 180 },
-  indianred: { r: 205, g: 92, b: 92 },
-  indigo: { r: 75, g: 0, b: 130 },
-  ivory: { r: 255, g: 255, b: 240 },
-  khaki: { r: 240, g: 230, b: 140 },
-  lavender: { r: 230, g: 230, b: 250 },
-  lavenderblush: { r: 255, g: 240, b: 245 },
-  lawngreen: { r: 124, g: 252, b: 0 },
-  lemonchiffon: { r: 255, g: 250, b: 205 },
-  lightblue: { r: 173, g: 216, b: 230 },
-  lightcoral: { r: 240, g: 128, b: 128 },
-  lightcyan: { r: 224, g: 255, b: 255 },
-  lightgoldenrodyellow: { r: 250, g: 250, b: 210 },
-  lightgray: { r: 211, g: 211, b: 211 },
-  lightgreen: { r: 144, g: 238, b: 144 },
-  lightgrey: { r: 211, g: 211, b: 211 },
-  lightpink: { r: 255, g: 182, b: 193 },
-  lightsalmon: { r: 255, g: 160, b: 122 },
-  lightseagreen: { r: 32, g: 178, b: 170 },
-  lightskyblue: { r: 135, g: 206, b: 250 },
-  lightslategray: { r: 119, g: 136, b: 153 },
-  lightslategrey: { r: 119, g: 136, b: 153 },
-  lightsteelblue: { r: 176, g: 196, b: 222 },
-  lightyellow: { r: 255, g: 255, b: 224 },
-  lime: { r: 0, g: 255, b: 0 },
-  limegreen: { r: 50, g: 205, b: 50 },
-  linen: { r: 250, g: 240, b: 230 },
-  magenta: { r: 255, g: 0, b: 255 },
-  maroon: { r: 128, g: 0, b: 0 },
-  mediumaquamarine: { r: 102, g: 205, b: 170 },
-  mediumblue: { r: 0, g: 0, b: 205 },
-  mediumorchid: { r: 186, g: 85, b: 211 },
-  mediumpurple: { r: 147, g: 112, b: 219 },
-  mediumseagreen: { r: 60, g: 179, b: 113 },
-  mediumslateblue: { r: 123, g: 104, b: 238 },
-  mediumspringgreen: { r: 0, g: 250, b: 154 },
-  mediumturquoise: { r: 72, g: 209, b: 204 },
-  mediumvioletred: { r: 199, g: 21, b: 133 },
-  midnightblue: { r: 25, g: 25, b: 112 },
-  mintcream: { r: 245, g: 255, b: 250 },
-  mistyrose: { r: 255, g: 228, b: 225 },
-  moccasin: { r: 255, g: 228, b: 181 },
-  navajowhite: { r: 255, g: 222, b: 173 },
-  navy: { r: 0, g: 0, b: 128 },
-  oldlace: { r: 253, g: 245, b: 230 },
-  olive: { r: 128, g: 128, b: 0 },
-  olivedrab: { r: 107, g: 142, b: 35 },
-  orange: { r: 255, g: 165, b: 0 },
-  orangered: { r: 255, g: 69, b: 0 },
-  orchid: { r: 218, g: 112, b: 214 },
-  palegoldenrod: { r: 238, g: 232, b: 170 },
-  palegreen: { r: 152, g: 251, b: 152 },
-  paleturquoise: { r: 175, g: 238, b: 238 },
-  palevioletred: { r: 219, g: 112, b: 147 },
-  papayawhip: { r: 255, g: 239, b: 213 },
-  peachpuff: { r: 255, g: 218, b: 185 },
-  peru: { r: 205, g: 133, b: 63 },
-  pink: { r: 255, g: 192, b: 203 },
-  plum: { r: 221, g: 160, b: 221 },
-  powderblue: { r: 176, g: 224, b: 230 },
-  purple: { r: 128, g: 0, b: 128 },
-  rebeccapurple: { r: 102, g: 51, b: 153 },
-  red: { r: 255, g: 0, b: 0 },
-  rosybrown: { r: 188, g: 143, b: 143 },
-  royalblue: { r: 65, g: 105, b: 225 },
-  saddlebrown: { r: 139, g: 69, b: 19 },
-  salmon: { r: 250, g: 128, b: 114 },
-  sandybrown: { r: 244, g: 164, b: 96 },
-  seagreen: { r: 46, g: 139, b: 87 },
-  seashell: { r: 255, g: 245, b: 238 },
-  sienna: { r: 160, g: 82, b: 45 },
-  silver: { r: 192, g: 192, b: 192 },
-  skyblue: { r: 135, g: 206, b: 235 },
-  slateblue: { r: 106, g: 90, b: 205 },
-  slategray: { r: 112, g: 128, b: 144 },
-  slategrey: { r: 112, g: 128, b: 144 },
-  snow: { r: 255, g: 250, b: 250 },
-  springgreen: { r: 0, g: 255, b: 127 },
-  steelblue: { r: 70, g: 130, b: 180 },
-  tan: { r: 210, g: 180, b: 140 },
-  teal: { r: 0, g: 128, b: 128 },
-  thistle: { r: 216, g: 191, b: 216 },
-  tomato: { r: 255, g: 99, b: 71 },
-  turquoise: { r: 64, g: 224, b: 208 },
-  violet: { r: 238, g: 130, b: 238 },
-  wheat: { r: 245, g: 222, b: 179 },
-  white: { r: 255, g: 255, b: 255 },
-  whitesmoke: { r: 245, g: 245, b: 245 },
-  yellow: { r: 255, g: 255, b: 0 },
-  yellowgreen: { r: 154, g: 205, b: 50 }
+import { isNonNullObject } from '../../objects/is-object/index.js';
+import { cssColors } from '../cssColorsMap.js';
+/**
+ * Type guard to check if a value is a valid hexadecimal color string.
+ *
+ * @param {unknown} color - The value to check.
+ * @returns {color is Hex} True if the value is a valid hex color, false otherwise.
+ */
+export const isHex = (color) => {
+    if (typeof color !== 'string')
+        return false;
+    if (!color.startsWith('#'))
+        return false;
+    const withoutHash = color.slice(1);
+    const withoutHashLength = withoutHash.length;
+    const allowedLengths = [3, 4, 6, 8];
+    if (!allowedLengths.includes(withoutHashLength))
+        return false;
+    return /^[0-9a-f]+$/igm.test(withoutHash);
 };
-
-// src/agnostic/colors/typechecks/index.ts
-var isHex = (color) => {
-  if (typeof color !== "string") return false;
-  if (!color.startsWith("#")) return false;
-  const withoutHash = color.slice(1);
-  const withoutHashLength = withoutHash.length;
-  const allowedLengths = [3, 4, 6, 8];
-  if (!allowedLengths.includes(withoutHashLength)) return false;
-  return /^[0-9a-f]+$/igm.test(withoutHash);
+/**
+ * Type guard to check if a value is a valid RGBA color object.
+ *
+ * @param {unknown} color - The value to check.
+ * @returns {color is Rgba} True if the value is a valid RGBA color, false otherwise.
+ */
+export const isRgb = (color) => {
+    if (!isNonNullObject(color))
+        return false;
+    const { r, g, b, a } = color;
+    if (typeof r !== 'number')
+        return false;
+    if (typeof g !== 'number')
+        return false;
+    if (typeof b !== 'number')
+        return false;
+    if (a !== undefined && typeof a !== 'number')
+        return false;
+    return true;
 };
-var isRgb = (color) => {
-  if (!isNonNullObject(color)) return false;
-  const { r, g, b, a } = color;
-  if (typeof r !== "number") return false;
-  if (typeof g !== "number") return false;
-  if (typeof b !== "number") return false;
-  if (a !== void 0 && typeof a !== "number") return false;
-  return true;
+/**
+ * Type guard to check if a value is a valid HSLA color object.
+ *
+ * @param {unknown} color - The value to check.
+ * @returns {color is Hsla} True if the value is a valid HSLA color, false otherwise.
+ */
+export const isHsl = (color) => {
+    if (!isNonNullObject(color))
+        return false;
+    const { h, s, l, a } = color;
+    if (typeof h !== 'number')
+        return false;
+    if (typeof s !== 'number')
+        return false;
+    if (typeof l !== 'number')
+        return false;
+    if (a !== undefined && typeof a !== 'number')
+        return false;
+    return true;
 };
-var isHsl = (color) => {
-  if (!isNonNullObject(color)) return false;
-  const { h, s, l, a } = color;
-  if (typeof h !== "number") return false;
-  if (typeof s !== "number") return false;
-  if (typeof l !== "number") return false;
-  if (a !== void 0 && typeof a !== "number") return false;
-  return true;
+/**
+ * Type guard to check if a value is a valid HSBA color object.
+ *
+ * @param {unknown} color - The value to check.
+ * @returns {color is Hsba} True if the value is a valid HSBA color, false otherwise.
+ */
+export const isHsb = (color) => {
+    if (!isNonNullObject(color))
+        return false;
+    const { h, s, b, a } = color;
+    if (typeof h !== 'number')
+        return false;
+    if (typeof s !== 'number')
+        return false;
+    if (typeof b !== 'number')
+        return false;
+    if (a !== undefined && typeof a !== 'number')
+        return false;
+    return true;
 };
-var isHsb = (color) => {
-  if (!isNonNullObject(color)) return false;
-  const { h, s, b, a } = color;
-  if (typeof h !== "number") return false;
-  if (typeof s !== "number") return false;
-  if (typeof b !== "number") return false;
-  if (a !== void 0 && typeof a !== "number") return false;
-  return true;
+/**
+ * Type guard to check if a value is a valid CIELAB color object.
+ *
+ * @param {unknown} color - The value to check.
+ * @returns {color is Laba} True if the value is a valid CIELAB color, false otherwise.
+ */
+export const isLab = (color) => {
+    if (!isNonNullObject(color))
+        return false;
+    const { l, a, b, al } = color;
+    if (typeof l !== 'number')
+        return false;
+    if (typeof a !== 'number')
+        return false;
+    if (typeof b !== 'number')
+        return false;
+    if (al !== undefined && typeof al !== 'number')
+        return false;
+    return true;
 };
-var isLab = (color) => {
-  if (!isNonNullObject(color)) return false;
-  const { l, a, b, al } = color;
-  if (typeof l !== "number") return false;
-  if (typeof a !== "number") return false;
-  if (typeof b !== "number") return false;
-  if (al !== void 0 && typeof al !== "number") return false;
-  return true;
+/**
+ * Type guard to check if a value is a valid CIELCh color object.
+ *
+ * @param {unknown} color - The value to check.
+ * @returns {color is Lcha} True if the value is a valid CIELCh color, false otherwise.
+ */
+export const isLch = (color) => {
+    if (!isNonNullObject(color))
+        return false;
+    const { l, c, h, a } = color;
+    if (typeof l !== 'number')
+        return false;
+    if (typeof c !== 'number')
+        return false;
+    if (typeof h !== 'number')
+        return false;
+    if (a !== undefined && typeof a !== 'number')
+        return false;
+    return true;
 };
-var isLch = (color) => {
-  if (!isNonNullObject(color)) return false;
-  const { l, c, h, a } = color;
-  if (typeof l !== "number") return false;
-  if (typeof c !== "number") return false;
-  if (typeof h !== "number") return false;
-  if (a !== void 0 && typeof a !== "number") return false;
-  return true;
+/**
+ * Type guard to check if a value is a valid CMYK color object.
+ *
+ * @param {unknown} color - The value to check.
+ * @returns {color is Cmyka} True if the value is a valid CMYK color, false otherwise.
+ */
+export const isCmyk = (color) => {
+    if (!isNonNullObject(color))
+        return false;
+    const { c, m, y, k, a } = color;
+    if (typeof c !== 'number')
+        return false;
+    if (typeof m !== 'number')
+        return false;
+    if (typeof y !== 'number')
+        return false;
+    if (typeof k !== 'number')
+        return false;
+    if (a !== undefined && typeof a !== 'number')
+        return false;
+    return true;
 };
-var isCmyk = (color) => {
-  if (!isNonNullObject(color)) return false;
-  const { c, m, y, k, a } = color;
-  if (typeof c !== "number") return false;
-  if (typeof m !== "number") return false;
-  if (typeof y !== "number") return false;
-  if (typeof k !== "number") return false;
-  if (a !== void 0 && typeof a !== "number") return false;
-  return true;
+/**
+ * Type guard to check if a value is a valid CIE XYZ color object.
+ *
+ * @param {unknown} color - The value to check.
+ * @returns {color is Xyza} True if the value is a valid CIE XYZ color, false otherwise.
+ */
+export const isXyz = (color) => {
+    if (!isNonNullObject(color))
+        return false;
+    const { x, y, z, a } = color;
+    if (typeof x !== 'number')
+        return false;
+    if (typeof y !== 'number')
+        return false;
+    if (typeof z !== 'number')
+        return false;
+    if (a !== undefined && typeof a !== 'number')
+        return false;
+    return true;
 };
-var isXyz = (color) => {
-  if (!isNonNullObject(color)) return false;
-  const { x, y, z, a } = color;
-  if (typeof x !== "number") return false;
-  if (typeof y !== "number") return false;
-  if (typeof z !== "number") return false;
-  if (a !== void 0 && typeof a !== "number") return false;
-  return true;
-};
-var isCssColor = (color) => typeof color === "string" && cssColors[color] !== void 0;
-var isColor = (color) => {
-  if (isHex(color)) return true;
-  if (isCssColor(color)) return true;
-  if (isRgb(color)) return true;
-  if (isHsl(color)) return true;
-  if (isHsb(color)) return true;
-  if (isCmyk(color)) return true;
-  if (isXyz(color)) return true;
-  if (isLab(color)) return true;
-  if (isLch(color)) return true;
-  return false;
-};
-export {
-  isCmyk,
-  isColor,
-  isCssColor,
-  isHex,
-  isHsb,
-  isHsl,
-  isLab,
-  isLch,
-  isRgb,
-  isXyz
+/**
+ * Type guard to check if a value is a valid CSS named color.
+ *
+ * @param {unknown} color - The value to check.
+ * @returns {color is CssColor} True if the value is a valid CSS named color, false otherwise.
+ */
+export const isCssColor = (color) => typeof color === 'string'
+    && cssColors[color] !== undefined;
+/**
+ * Type guard to check if a value is any valid color format.
+ *
+ * @param {unknown} color - The value to check.
+ * @returns {color is Color} True if the value is a valid color in any supported format, false otherwise.
+ */
+export const isColor = (color) => {
+    if (isHex(color))
+        return true;
+    if (isCssColor(color))
+        return true;
+    if (isRgb(color))
+        return true;
+    if (isHsl(color))
+        return true;
+    if (isHsb(color))
+        return true;
+    if (isCmyk(color))
+        return true;
+    if (isXyz(color))
+        return true;
+    if (isLab(color))
+        return true;
+    if (isLch(color))
+        return true;
+    return false;
 };

package/agnostic/colors/typechecks/index.test.js

@@ -0,0 +1,113 @@
+import { describe, it, expect } from 'vitest';
+import { isHex, isRgb, isHsl, isHsb, isCmyk, isXyz, isLab, isLch, isCssColor, isColor } from './index.js';
+describe('isHex', () => {
+    it('returns true for valid hex colors', () => {
+        expect(isHex('#ff0000')).toBe(true);
+        expect(isHex('#f00')).toBe(true);
+        expect(isHex('#ff0000ff')).toBe(true);
+        expect(isHex('#f00f')).toBe(true);
+    });
+    it('returns false for invalid hex colors', () => {
+        expect(isHex('ff0000')).toBe(false);
+        expect(isHex('#gg0000')).toBe(false);
+        expect(isHex('#ff')).toBe(false);
+        expect(isHex(123)).toBe(false);
+    });
+});
+describe('isRgb', () => {
+    it('returns true for valid RGB colors', () => {
+        expect(isRgb({ r: 255, g: 128, b: 64 })).toBe(true);
+        expect(isRgb({ r: 255, g: 128, b: 64, a: 0.5 })).toBe(true);
+    });
+    it('returns false for invalid RGB colors', () => {
+        expect(isRgb({ r: 255, g: 128 })).toBe(false);
+        expect(isRgb({ r: '255', g: 128, b: 64 })).toBe(false);
+        expect(isRgb(null)).toBe(false);
+    });
+});
+describe('isHsl', () => {
+    it('returns true for valid HSL colors', () => {
+        expect(isHsl({ h: 180, s: 50, l: 75 })).toBe(true);
+        expect(isHsl({ h: 180, s: 50, l: 75, a: 0.5 })).toBe(true);
+    });
+    it('returns false for invalid HSL colors', () => {
+        expect(isHsl({ h: 180, s: 50 })).toBe(false);
+        expect(isHsl({ h: '180', s: 50, l: 75 })).toBe(false);
+        expect(isHsl(null)).toBe(false);
+    });
+});
+describe('isHsb', () => {
+    it('returns true for valid HSB colors', () => {
+        expect(isHsb({ h: 180, s: 50, b: 75 })).toBe(true);
+        expect(isHsb({ h: 180, s: 50, b: 75, a: 0.5 })).toBe(true);
+    });
+    it('returns false for invalid HSB colors', () => {
+        expect(isHsb({ h: 180, s: 50 })).toBe(false);
+        expect(isHsb({ h: '180', s: 50, b: 75 })).toBe(false);
+    });
+});
+describe('isCmyk', () => {
+    it('returns true for valid CMYK colors', () => {
+        expect(isCmyk({ c: 50, m: 50, y: 50, k: 50 })).toBe(true);
+        expect(isCmyk({ c: 50, m: 50, y: 50, k: 50, a: 0.5 })).toBe(true);
+    });
+    it('returns false for invalid CMYK colors', () => {
+        expect(isCmyk({ c: 50, m: 50, y: 50 })).toBe(false);
+        expect(isCmyk({ c: '50', m: 50, y: 50, k: 50 })).toBe(false);
+    });
+});
+describe('isXyz', () => {
+    it('returns true for valid XYZ colors', () => {
+        expect(isXyz({ x: 50, y: 50, z: 50 })).toBe(true);
+        expect(isXyz({ x: 50, y: 50, z: 50, a: 0.5 })).toBe(true);
+    });
+    it('returns false for invalid XYZ colors', () => {
+        expect(isXyz({ x: 50, y: 50 })).toBe(false);
+        expect(isXyz({ x: '50', y: 50, z: 50 })).toBe(false);
+    });
+});
+describe('isLab', () => {
+    it('returns true for valid Lab colors', () => {
+        expect(isLab({ l: 50, a: 0, b: 0 })).toBe(true);
+        expect(isLab({ l: 50, a: 0, b: 0, al: 0.5 })).toBe(true);
+    });
+    it('returns false for invalid Lab colors', () => {
+        expect(isLab({ l: 50, a: 0 })).toBe(false);
+        expect(isLab({ l: '50', a: 0, b: 0 })).toBe(false);
+    });
+});
+describe('isLch', () => {
+    it('returns true for valid LCH colors', () => {
+        expect(isLch({ l: 50, c: 50, h: 180 })).toBe(true);
+        expect(isLch({ l: 50, c: 50, h: 180, a: 0.5 })).toBe(true);
+    });
+    it('returns false for invalid LCH colors', () => {
+        expect(isLch({ l: 50, c: 50 })).toBe(false);
+        expect(isLch({ l: '50', c: 50, h: 180 })).toBe(false);
+    });
+});
+describe('isCssColor', () => {
+    it('returns true for valid CSS color names', () => {
+        expect(isCssColor('red')).toBe(true);
+        expect(isCssColor('blue')).toBe(true);
+    });
+    it('returns false for invalid CSS color names', () => {
+        expect(isCssColor('notacolor')).toBe(false);
+        expect(isCssColor('#ff0000')).toBe(false);
+        expect(isCssColor(123)).toBe(false);
+    });
+});
+describe('isColor', () => {
+    it('returns true for any valid color format', () => {
+        expect(isColor('#ff0000')).toBe(true);
+        expect(isColor({ r: 255, g: 0, b: 0 })).toBe(true);
+        expect(isColor({ h: 0, s: 100, l: 50 })).toBe(true);
+        expect(isColor('red')).toBe(true);
+    });
+    it('returns false for invalid colors', () => {
+        expect(isColor('notacolor')).toBe(false);
+        expect(isColor(123)).toBe(false);
+        expect(isColor(null)).toBe(false);
+        expect(isColor({ r: 255 })).toBe(false);
+    });
+});

package/agnostic/colors/types.js

@@ -0,0 +1 @@
+export {};