@thi.ng/color 4.1.7 → 5.0.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/color",
-  "version": "4.1.7",
+  "version": "5.0.2",
   "description": "Array-based color types, CSS parsing, conversions, transformations, declarative theme generation, gradients, presets",
   "type": "module",
   "module": "./index.js",
@@ -32,30 +32,31 @@
     "doc:stats": "tools:module-stats",
     "pub": "yarn npm publish --access public",
     "test": "testament test",
+    "tool:maxchroma": "tools:node-esm tools/max-chroma.ts",
     "tool:swatches": "tools:node-esm tools/index.ts"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.3.3",
-    "@thi.ng/arrays": "^2.1.3",
-    "@thi.ng/binary": "^3.1.3",
-    "@thi.ng/checks": "^3.1.3",
-    "@thi.ng/compare": "^2.1.3",
-    "@thi.ng/compose": "^2.1.3",
-    "@thi.ng/defmulti": "^2.1.3",
-    "@thi.ng/errors": "^2.1.3",
-    "@thi.ng/math": "^5.2.0",
-    "@thi.ng/random": "^3.2.3",
-    "@thi.ng/strings": "^3.3.1",
-    "@thi.ng/transducers": "^8.2.0",
-    "@thi.ng/vectors": "^7.4.3"
+    "@thi.ng/api": "^8.3.5",
+    "@thi.ng/arrays": "^2.2.1",
+    "@thi.ng/binary": "^3.2.1",
+    "@thi.ng/checks": "^3.1.5",
+    "@thi.ng/compare": "^2.1.5",
+    "@thi.ng/compose": "^2.1.5",
+    "@thi.ng/defmulti": "^2.1.5",
+    "@thi.ng/errors": "^2.1.5",
+    "@thi.ng/math": "^5.3.1",
+    "@thi.ng/random": "^3.2.5",
+    "@thi.ng/strings": "^3.3.3",
+    "@thi.ng/transducers": "^8.3.1",
+    "@thi.ng/vectors": "^7.5.2"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.19.2",
-    "@thi.ng/testament": "^0.2.3",
+    "@microsoft/api-extractor": "^7.19.4",
+    "@thi.ng/testament": "^0.2.5",
     "rimraf": "^3.0.2",
     "tools": "^0.0.1",
-    "typedoc": "^0.22.10",
-    "typescript": "^4.5.3"
+    "typedoc": "^0.22.13",
+    "typescript": "^4.6.2"
   },
   "keywords": [
     "color",
@@ -123,274 +124,295 @@
   ],
   "exports": {
     ".": {
-      "import": "./index.js"
+      "default": "./index.js"
     },
     "./alpha": {
-      "import": "./alpha.js"
+      "default": "./alpha.js"
     },
     "./analog": {
-      "import": "./analog.js"
+      "default": "./analog.js"
     },
     "./api/constants": {
-      "import": "./api/constants.js"
+      "default": "./api/constants.js"
     },
     "./api/gradients": {
-      "import": "./api/gradients.js"
+      "default": "./api/gradients.js"
     },
     "./api/names": {
-      "import": "./api/names.js"
+      "default": "./api/names.js"
     },
     "./api/ranges": {
-      "import": "./api/ranges.js"
+      "default": "./api/ranges.js"
     },
     "./api/system": {
-      "import": "./api/system.js"
+      "default": "./api/system.js"
     },
     "./api": {
-      "import": "./api.js"
+      "default": "./api.js"
     },
     "./clamp": {
-      "import": "./clamp.js"
+      "default": "./clamp.js"
     },
     "./closest-hue": {
-      "import": "./closest-hue.js"
+      "default": "./closest-hue.js"
     },
     "./color-range": {
-      "import": "./color-range.js"
+      "default": "./color-range.js"
     },
     "./color": {
-      "import": "./color.js"
+      "default": "./color.js"
     },
     "./convert": {
-      "import": "./convert.js"
+      "default": "./convert.js"
     },
     "./cosine-gradients": {
-      "import": "./cosine-gradients.js"
+      "default": "./cosine-gradients.js"
     },
     "./css/css": {
-      "import": "./css/css.js"
+      "default": "./css/css.js"
     },
     "./css/parse-css": {
-      "import": "./css/parse-css.js"
+      "default": "./css/parse-css.js"
     },
     "./defcolor": {
-      "import": "./defcolor.js"
+      "default": "./defcolor.js"
     },
     "./distance": {
-      "import": "./distance.js"
+      "default": "./distance.js"
     },
     "./gradients": {
-      "import": "./gradients.js"
+      "default": "./gradients.js"
     },
     "./hcy/hcy-rgb": {
-      "import": "./hcy/hcy-rgb.js"
+      "default": "./hcy/hcy-rgb.js"
     },
     "./hcy/hcy": {
-      "import": "./hcy/hcy.js"
+      "default": "./hcy/hcy.js"
     },
     "./hsi/hsi-rgb": {
-      "import": "./hsi/hsi-rgb.js"
+      "default": "./hsi/hsi-rgb.js"
     },
     "./hsi/hsi": {
-      "import": "./hsi/hsi.js"
+      "default": "./hsi/hsi.js"
     },
     "./hsl/hsl-css": {
-      "import": "./hsl/hsl-css.js"
+      "default": "./hsl/hsl-css.js"
     },
     "./hsl/hsl-hsv": {
-      "import": "./hsl/hsl-hsv.js"
+      "default": "./hsl/hsl-hsv.js"
     },
     "./hsl/hsl-rgb": {
-      "import": "./hsl/hsl-rgb.js"
+      "default": "./hsl/hsl-rgb.js"
     },
     "./hsl/hsl": {
-      "import": "./hsl/hsl.js"
+      "default": "./hsl/hsl.js"
     },
     "./hsv/hsv-css": {
-      "import": "./hsv/hsv-css.js"
+      "default": "./hsv/hsv-css.js"
     },
     "./hsv/hsv-hsl": {
-      "import": "./hsv/hsv-hsl.js"
+      "default": "./hsv/hsv-hsl.js"
     },
     "./hsv/hsv-rgb": {
-      "import": "./hsv/hsv-rgb.js"
+      "default": "./hsv/hsv-rgb.js"
     },
     "./hsv/hsv": {
-      "import": "./hsv/hsv.js"
+      "default": "./hsv/hsv.js"
     },
     "./int/int-css": {
-      "import": "./int/int-css.js"
+      "default": "./int/int-css.js"
     },
     "./int/int-int": {
-      "import": "./int/int-int.js"
+      "default": "./int/int-int.js"
     },
     "./int/int-rgb": {
-      "import": "./int/int-rgb.js"
+      "default": "./int/int-rgb.js"
     },
     "./int/int-srgb": {
-      "import": "./int/int-srgb.js"
+      "default": "./int/int-srgb.js"
     },
     "./int/int": {
-      "import": "./int/int.js"
+      "default": "./int/int.js"
     },
     "./invert": {
-      "import": "./invert.js"
+      "default": "./invert.js"
     },
     "./is-black": {
-      "import": "./is-black.js"
+      "default": "./is-black.js"
+    },
+    "./is-gamut": {
+      "default": "./is-gamut.js"
     },
     "./is-gray": {
-      "import": "./is-gray.js"
+      "default": "./is-gray.js"
     },
     "./is-white": {
-      "import": "./is-white.js"
+      "default": "./is-white.js"
     },
     "./lab/lab-css": {
-      "import": "./lab/lab-css.js"
+      "default": "./lab/lab-css.js"
     },
     "./lab/lab-lab": {
-      "import": "./lab/lab-lab.js"
+      "default": "./lab/lab-lab.js"
     },
     "./lab/lab-lch": {
-      "import": "./lab/lab-lch.js"
+      "default": "./lab/lab-lch.js"
     },
     "./lab/lab-rgb": {
-      "import": "./lab/lab-rgb.js"
+      "default": "./lab/lab-rgb.js"
     },
     "./lab/lab-xyz": {
-      "import": "./lab/lab-xyz.js"
+      "default": "./lab/lab-xyz.js"
     },
     "./lab/lab50": {
-      "import": "./lab/lab50.js"
+      "default": "./lab/lab50.js"
     },
     "./lab/lab65": {
-      "import": "./lab/lab65.js"
+      "default": "./lab/lab65.js"
     },
     "./lch/lch-css": {
-      "import": "./lch/lch-css.js"
+      "default": "./lch/lch-css.js"
     },
     "./lch/lch": {
-      "import": "./lch/lch.js"
+      "default": "./lch/lch.js"
+    },
+    "./lighten": {
+      "default": "./lighten.js"
     },
     "./linear": {
-      "import": "./linear.js"
+      "default": "./linear.js"
     },
     "./luminance-rgb": {
-      "import": "./luminance-rgb.js"
+      "default": "./luminance-rgb.js"
     },
     "./luminance": {
-      "import": "./luminance.js"
+      "default": "./luminance.js"
+    },
+    "./max-chroma": {
+      "default": "./max-chroma.js"
     },
     "./mix": {
-      "import": "./mix.js"
+      "default": "./mix.js"
     },
     "./oklab/oklab-rgb": {
-      "import": "./oklab/oklab-rgb.js"
+      "default": "./oklab/oklab-rgb.js"
     },
     "./oklab/oklab-xyz": {
-      "import": "./oklab/oklab-xyz.js"
+      "default": "./oklab/oklab-xyz.js"
     },
     "./oklab/oklab": {
-      "import": "./oklab/oklab.js"
+      "default": "./oklab/oklab.js"
     },
     "./rgb/hue-rgb": {
-      "import": "./rgb/hue-rgb.js"
+      "default": "./rgb/hue-rgb.js"
     },
     "./rgb/kelvin-rgba": {
-      "import": "./rgb/kelvin-rgba.js"
+      "default": "./rgb/kelvin-rgba.js"
     },
     "./rgb/rgb-css": {
-      "import": "./rgb/rgb-css.js"
+      "default": "./rgb/rgb-css.js"
     },
     "./rgb/rgb-hcv": {
-      "import": "./rgb/rgb-hcv.js"
+      "default": "./rgb/rgb-hcv.js"
     },
     "./rgb/rgb-hcy": {
-      "import": "./rgb/rgb-hcy.js"
+      "default": "./rgb/rgb-hcy.js"
     },
     "./rgb/rgb-hsi": {
-      "import": "./rgb/rgb-hsi.js"
+      "default": "./rgb/rgb-hsi.js"
     },
     "./rgb/rgb-hsl": {
-      "import": "./rgb/rgb-hsl.js"
+      "default": "./rgb/rgb-hsl.js"
     },
     "./rgb/rgb-hsv": {
-      "import": "./rgb/rgb-hsv.js"
+      "default": "./rgb/rgb-hsv.js"
     },
     "./rgb/rgb-lab": {
-      "import": "./rgb/rgb-lab.js"
+      "default": "./rgb/rgb-lab.js"
     },
     "./rgb/rgb-oklab": {
-      "import": "./rgb/rgb-oklab.js"
+      "default": "./rgb/rgb-oklab.js"
     },
     "./rgb/rgb-srgb": {
-      "import": "./rgb/rgb-srgb.js"
+      "default": "./rgb/rgb-srgb.js"
     },
     "./rgb/rgb-xyz": {
-      "import": "./rgb/rgb-xyz.js"
+      "default": "./rgb/rgb-xyz.js"
     },
     "./rgb/rgb-ycc": {
-      "import": "./rgb/rgb-ycc.js"
+      "default": "./rgb/rgb-ycc.js"
     },
     "./rgb/rgb": {
-      "import": "./rgb/rgb.js"
+      "default": "./rgb/rgb.js"
+    },
+    "./rotate": {
+      "default": "./rotate.js"
     },
     "./sort": {
-      "import": "./sort.js"
+      "default": "./sort.js"
     },
     "./srgb/srgb-css": {
-      "import": "./srgb/srgb-css.js"
+      "default": "./srgb/srgb-css.js"
     },
     "./srgb/srgb-int": {
-      "import": "./srgb/srgb-int.js"
+      "default": "./srgb/srgb-int.js"
     },
     "./srgb/srgb-rgb": {
-      "import": "./srgb/srgb-rgb.js"
+      "default": "./srgb/srgb-rgb.js"
     },
     "./srgb/srgb": {
-      "import": "./srgb/srgb.js"
+      "default": "./srgb/srgb.js"
+    },
+    "./strategies": {
+      "default": "./strategies.js"
     },
     "./swatches": {
-      "import": "./swatches.js"
+      "default": "./swatches.js"
+    },
+    "./tint": {
+      "default": "./tint.js"
     },
     "./transform": {
-      "import": "./transform.js"
+      "default": "./transform.js"
+    },
+    "./variations": {
+      "default": "./variations.js"
     },
     "./xyy/xyy-xyz": {
-      "import": "./xyy/xyy-xyz.js"
+      "default": "./xyy/xyy-xyz.js"
     },
     "./xyy/xyy": {
-      "import": "./xyy/xyy.js"
+      "default": "./xyy/xyy.js"
     },
     "./xyz/wavelength-xyz": {
-      "import": "./xyz/wavelength-xyz.js"
+      "default": "./xyz/wavelength-xyz.js"
     },
     "./xyz/xyz-lab": {
-      "import": "./xyz/xyz-lab.js"
+      "default": "./xyz/xyz-lab.js"
     },
     "./xyz/xyz-oklab": {
-      "import": "./xyz/xyz-oklab.js"
+      "default": "./xyz/xyz-oklab.js"
     },
     "./xyz/xyz-rgb": {
-      "import": "./xyz/xyz-rgb.js"
+      "default": "./xyz/xyz-rgb.js"
     },
     "./xyz/xyz-xyy": {
-      "import": "./xyz/xyz-xyy.js"
+      "default": "./xyz/xyz-xyy.js"
     },
     "./xyz/xyz-xyz": {
-      "import": "./xyz/xyz-xyz.js"
+      "default": "./xyz/xyz-xyz.js"
     },
     "./xyz/xyz50": {
-      "import": "./xyz/xyz50.js"
+      "default": "./xyz/xyz50.js"
     },
     "./xyz/xyz65": {
-      "import": "./xyz/xyz65.js"
+      "default": "./xyz/xyz65.js"
     },
     "./ycc/ycc-rgb": {
-      "import": "./ycc/ycc-rgb.js"
+      "default": "./ycc/ycc-rgb.js"
     },
     "./ycc/ycc": {
-      "import": "./ycc/ycc.js"
+      "default": "./ycc/ycc.js"
     }
   },
   "thi.ng": {
@@ -399,5 +421,5 @@
       "vectors"
     ]
   },
-  "gitHead": "1ba92c6b9509e74e509b4c0b875fc380a97bbbc1\n"
+  "gitHead": "542bf14bd0c7a56b4e6297718189eea772a824b7\n"
 }

package/rgb/rgb-lab.d.ts

@@ -6,15 +6,15 @@ import type { ColorOp } from "../api.js";
  * Important: We're using a normalized Lab space w/ all three coordinates
  * divided by 100 (normalized to 100% luminance).
  *
- * @param out
- * @param src
+ * @param out -
+ * @param src -
  */
 export declare const rgbLab: ColorOp;
 /**
  * Same as {@link rgbLab}, but using {@link D65} white point.
  *
- * @param out
- * @param src
+ * @param out -
+ * @param src -
  */
 export declare const rgbLabD65: ColorOp;
 //# sourceMappingURL=rgb-lab.d.ts.map

package/rgb/rgb-lab.js

@@ -7,14 +7,14 @@ import { xyzLab, xyzLabD65 } from "../xyz/xyz-lab.js";
  * Important: We're using a normalized Lab space w/ all three coordinates
  * divided by 100 (normalized to 100% luminance).
  *
- * @param out
- * @param src
+ * @param out -
+ * @param src -
  */
 export const rgbLab = (out, src) => xyzLab(null, rgbXyz(out, src));
 /**
  * Same as {@link rgbLab}, but using {@link D65} white point.
  *
- * @param out
- * @param src
+ * @param out -
+ * @param src -
  */
 export const rgbLabD65 = (out, src) => xyzLabD65(null, rgbXyzD65(out, src));

package/rgb/rgb-oklab.d.ts

@@ -3,8 +3,8 @@ import type { ColorOp } from "../api.js";
  * @remarks
  * Reference: https://bottosson.github.io/posts/oklab/
  *
- * @param out
- * @param src
+ * @param out -
+ * @param src -
  */
 export declare const rgbOklab: ColorOp;
 //# sourceMappingURL=rgb-oklab.d.ts.map

package/rgb/rgb-oklab.js

@@ -9,7 +9,7 @@ const CONE_LMS = [
  * @remarks
  * Reference: https://bottosson.github.io/posts/oklab/
  *
- * @param out
- * @param src
+ * @param out -
+ * @param src -
  */
 export const rgbOklab = (out, src) => __mulV33(null, OKLAB_M2, powN3(null, __mulV33(out, CONE_LMS, src), 1 / 3));

package/rgb/rgb-xyz.d.ts

@@ -14,8 +14,8 @@ export declare const rgbXyz: (out: Color | null, src: ReadonlyColor, mat?: numbe
  * Same as {@link rgbXyz}, but hard coded to use {@link D65} white point (via
  * {@link RGB_XYZ_D65} matrix).
  *
- * @param out
- * @param src
+ * @param out -
+ * @param src -
  */
 export declare const rgbXyzD65: ColorOp;
 //# sourceMappingURL=rgb-xyz.d.ts.map

package/rgb/rgb-xyz.js

@@ -16,7 +16,7 @@ export const rgbXyz = (out, src, mat = RGB_XYZ_D50) => __mulV33(null, mat, clamp
  * Same as {@link rgbXyz}, but hard coded to use {@link D65} white point (via
  * {@link RGB_XYZ_D65} matrix).
  *
- * @param out
- * @param src
+ * @param out -
+ * @param src -
  */
 export const rgbXyzD65 = (out, src) => rgbXyz(out, src, RGB_XYZ_D65);

package/rgb/rgb-ycc.d.ts

@@ -9,9 +9,9 @@ import type { Color, ReadonlyColor } from "../api.js";
  * - https://en.wikipedia.org/wiki/YCbCr#ITU-R_BT.709_conversion
  * - https://en.wikipedia.org/wiki/Rec._709
  *
- * @param out
- * @param src
- * @param luma
+ * @param out -
+ * @param src -
+ * @param luma -
  */
 export declare const rgbYcc: (out: Color | null, src: ReadonlyColor, luma?: number[]) => import("@thi.ng/vectors").Vec;
 //# sourceMappingURL=rgb-ycc.d.ts.map

package/rgb/rgb-ycc.js

@@ -12,9 +12,9 @@ import { __ensureAlpha } from "../internal/ensure.js";
  * - https://en.wikipedia.org/wiki/YCbCr#ITU-R_BT.709_conversion
  * - https://en.wikipedia.org/wiki/Rec._709
  *
- * @param out
- * @param src
- * @param luma
+ * @param out -
+ * @param src -
+ * @param luma -
  */
 export const rgbYcc = (out, src, luma = RGB_LUMINANCE_REC709) => {
     const y = dot3(src, luma);

package/rotate.d.ts

@@ -0,0 +1,4 @@
+import type { Color, TypedColor } from "./api.js";
+export declare const rotate: import("@thi.ng/defmulti").MultiFn3<import("@thi.ng/vectors").Vec | null, TypedColor<any>, number, import("@thi.ng/vectors").Vec>;
+export declare const complementary: (out: Color | null, src: TypedColor<any>) => import("@thi.ng/vectors").Vec;
+//# sourceMappingURL=rotate.d.ts.map

package/rotate.js

@@ -0,0 +1,10 @@
+import { defmulti } from "@thi.ng/defmulti/defmulti";
+import { fract } from "@thi.ng/math/prec";
+import { setC4 } from "@thi.ng/vectors/setc";
+import { __dispatch1 } from "./internal/dispatch.js";
+import { __ensureAlpha } from "./internal/ensure.js";
+export const rotate = defmulti(__dispatch1, { hsv: "hsl", hsi: "hsl", hcy: "hsl" }, {
+    hsl: (out, src, theta) => setC4(out || src, fract(src[0] + theta), src[1], src[2], __ensureAlpha(src[3])),
+    lch: (out, src, theta) => setC4(out || src, src[0], src[1], fract(src[2] + theta), __ensureAlpha(src[3])),
+});
+export const complementary = (out, src) => rotate(out, src, 0.5);

package/sort.d.ts

@@ -7,8 +7,8 @@ export declare const selectChannel: (id: number) => (col: ReadonlyColor) => numb
  * function for {@link sort} to compute the distance metric of a color to the
  * given `target`.
  *
- * @param target
- * @param dist
+ * @param target -
+ * @param dist -
  */
 export declare const proximity: (target: ReadonlyColor, dist?: ColorDistance) => (col: ReadonlyColor) => number;
 /**
@@ -17,8 +17,8 @@ export declare const proximity: (target: ReadonlyColor, dist?: ColorDistance) =>
  * function (default: {@link distEucledian3}) and will be in sRGB space. Hence
  * given `target` color should be provided in the same space too.
  *
- * @param target
- * @param dist
+ * @param target -
+ * @param dist -
  */
 export declare const proximityABGR32: (target: ReadonlyColor, dist?: ColorDistance) => (col: ReadonlyColor) => number;
 export declare const sort: (colors: ReadonlyColor[], key: Fn<ReadonlyColor, number>, isReverse?: boolean) => import("@thi.ng/vectors").ReadonlyVec[];
@@ -56,9 +56,9 @@ export declare const sort: (colors: ReadonlyColor[], key: Fn<ReadonlyColor, numb
  * // ]
  * ```
  *
- * @param colors
- * @param key
- * @param isReverse
+ * @param colors -
+ * @param key -
+ * @param isReverse -
  */
 export declare const sortMapped: <T extends TypedColor<any>>(colors: T[], key: Fn<ReadonlyColor, number>, isReverse?: boolean) => T[];
 //# sourceMappingURL=sort.d.ts.map

package/sort.js

@@ -12,8 +12,8 @@ export const selectChannel = (id) => (col) => col[id];
  * function for {@link sort} to compute the distance metric of a color to the
  * given `target`.
  *
- * @param target
- * @param dist
+ * @param target -
+ * @param dist -
  */
 export const proximity = (target, dist = distEucledian3) => (col) => dist(target, col);
 /**
@@ -22,8 +22,8 @@ export const proximity = (target, dist = distEucledian3) => (col) => dist(target
  * function (default: {@link distEucledian3}) and will be in sRGB space. Hence
  * given `target` color should be provided in the same space too.
  *
- * @param target
- * @param dist
+ * @param target -
+ * @param dist -
  */
 export const proximityABGR32 = (target, dist = distEucledian3) => (col) => dist(target, intAbgr32Srgb([], col[0]));
 export const sort = (colors, key, isReverse = false) => sortByCachedKey(colors, key, isReverse ? compareNumDesc : compareNumAsc);
@@ -61,9 +61,9 @@ export const sort = (colors, key, isReverse = false) => sortByCachedKey(colors,
  * // ]
  * ```
  *
- * @param colors
- * @param key
- * @param isReverse
+ * @param colors -
+ * @param key -
+ * @param isReverse -
  */
 export const sortMapped = (colors, key, isReverse = false) => {
     if (!colors.length)