@texel/color 1.1.9 → 1.1.11

package/.claude/settings.local.json

@@ -0,0 +1,14 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(npm ls:*)",
+      "Bash(wc:*)",
+      "Bash(npm audit:*)",
+      "Bash(npm test:*)",
+      "Bash(cat:*)",
+      "Bash(ls:*)",
+      "Bash(node --version:*)",
+      "Bash(npm:*)"
+    ]
+  }
+}

package/LICENSE.md

@@ -1,5 +1,5 @@
 The MIT License (MIT)
-Copyright (c) 2024 Matt DesLauriers
+Copyright (c) Matt DesLauriers
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -342,7 +342,7 @@ The library currently only exposes `{ lerp, lerpAngle }` functions. To interpola
 
 ## Custom Color Spaces
 
-You can build custom color space objects to extend this library, such as adding support for CIELab and HSL. See [test/spaces/lab.js](./test/spaces/lab.js) and [test/spaces/hsl.js](./test/spaces/hsl.js) for examples of this. Some of these spaces may be added to the library at a later point, although the current focus is on "modern" spaces (such as OKLab that has largely made CIELab and HSL obsolete). Documentaiton on custom color spaces is WIP.
+You can build custom color space objects to extend this library, such as adding support for CIELab and HSL. See [test/spaces/lab.js](./test/spaces/lab.js) and [test/spaces/hsl.js](./test/spaces/hsl.js) for examples of this. Some of these spaces may be added to the library at a later point, although the current focus is on "modern" spaces (such as OKLab that has largely made CIELab and HSL obsolete). Documentation on custom color spaces is WIP.
 
 ## Notes
 
@@ -350,9 +350,9 @@ You can build custom color space objects to extend this library, such as adding
 
 [Colorjs](https://colorjs.io/) is fantastic and perhaps the current leading standard in JavaScript, but it's not very practical for creative coding and real-time web applications, where the requirements are often (1) leaner codebases, (2) highly optimized, and (3) minimal GC thrashing.
 
-Colorjs, and simialrly, [Culori](https://culorijs.org/), are focused on matching CSS spec, which means it will very likely continue to grow in complexity over time, and performance will often be marred (for example, `@texel/color` cusp intersection gamut mapping is ~125 times faster than Colorjs and ~60 times faster than culori).
+Colorjs, and similarly, [Culori](https://culorijs.org/), are focused on matching CSS spec, which means it will very likely continue to grow in complexity over time, and performance will often be marred (for example, `@texel/color` cusp intersection gamut mapping is ~125 times faster than Colorjs and ~60 times faster than culori).
 
-There are many other options such as [color-space](https://www.npmjs.com/package/color-space) or [color-convert](https://www.npmjs.com/package/color-convert), however, these do not support modern spacse such as OKLab and OKHSL, and/or have dubious levels of accuracy (many libraries, for example, do not distinguish between D50 and D65 whitepoints in XYZ).
+There are many other options such as [color-space](https://www.npmjs.com/package/color-space) or [color-convert](https://www.npmjs.com/package/color-convert), however, these do not support modern spaces such as OKLab and OKHSL, and/or have dubious levels of accuracy (many libraries, for example, do not distinguish between D50 and D65 whitepoints in XYZ).
 
 ### Supported Spaces
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@texel/color",
-  "version": "1.1.9",
+  "version": "1.1.11",
   "description": "a minimal and modern color library",
   "type": "module",
   "main": "./src/index.js",
@@ -23,6 +23,7 @@
     "esbuild": "^0.23.0",
     "faucet": "^0.0.4",
     "jsdoc": "^4.0.4",
+    "jsdoc-memberof-namespace": "^2.2.0",
     "pako": "^2.1.0",
     "png-tools": "^1.0.4",
     "prettier": "^3.3.3",
@@ -34,7 +35,7 @@
     "visualize": "canvas-sketch-cli test/canvas-graph.js --open",
     "docs": "jsdoc src -r -t node_modules/better-docs -c tools/.jsdoc.json -d docs -R DOC.md",
     "types": "jsdoc src -r -t node_modules/tsd-jsdoc/dist -c tools/.jsdoc.types.json -d .",
-    "test": "faucet test/test*.js",
+    "test": "node test/test.js | faucet",
     "bench": "node test/bench-colorjs.js",
     "bench:node": "NODE_ENV=production node --prof --no-logfile-per-isolate test/bench-node.js && node --prof-process v8.log",
     "bench:size": "esbuild test/bench-size.js --format=esm --bundle --minify --tree-shaking=true | wc -c",

package/src/core.js

@@ -146,7 +146,7 @@ export const serialize = (input, inputSpace, outputSpace = inputSpace) => {
     convert(input, inputSpace, outputSpace, tmp3);
   }
   const id = outputSpace.id;
-  if (id == "srgb") {
+  if (id === "srgb") {
     // uses the legacy rgb() format
     const r = floatToByte(tmp3[0]);
     const g = floatToByte(tmp3[1]);
@@ -155,7 +155,7 @@ export const serialize = (input, inputSpace, outputSpace = inputSpace) => {
     return alpha === 1 ? `rgb(${rgb})` : `rgba(${rgb}, ${alpha})`;
   } else {
     const alphaSuffix = alpha === 1 ? "" : ` / ${alpha}`;
-    if (id == "oklab" || id == "oklch") {
+    if (id === "oklab" || id === "oklch") {
       // older versions of Safari don't support oklch with 0..1 L but do support %
       return `${id}(${tmp3[0] * 100}% ${tmp3[1]} ${tmp3[2]}${alphaSuffix})`;
     } else {
@@ -296,7 +296,7 @@ export const parse = (input, targetSpace, out = vec3()) => {
   // store alpha
   if (alpha !== 1) out[3] = alpha;
   // reduce to 3D
-  if (alpha == 1 && out.length === 4) out.pop();
+  if (alpha === 1 && out.length === 4) out.pop();
   return out;
 };
 
@@ -318,7 +318,7 @@ export const convert = (input, fromSpace, toSpace, out = vec3()) => {
   if (!toSpace) throw new Error(`must specify a toSpace`);
 
   // special case: no conversion needed
-  if (fromSpace == toSpace) {
+  if (fromSpace === toSpace) {
     return out;
   }
 

package/src/gamut.js

@@ -345,7 +345,7 @@ export const gamutMapOKLCH = (
   const lmsToRgb = gamutSpaceBase.fromLMS_M;
   if (!lmsToRgb) {
     throw new Error(
-      `color space ${outSpace.id} has no base with LMS to RGB matrix`
+      `color space ${gamutSpaceBase.id} has no base with LMS to RGB matrix`
     );
   }
 
@@ -406,7 +406,7 @@ export const gamutMapOKLCH = (
     //    will be applied. The OKLCH result is _basically_ in gamut, but not exactly; you'll need to clip at final stage.
     // I've documented this behaviour in the readme.
     const targetSpaceBase = targetSpace.base ?? targetSpace;
-    if (targetSpaceBase.id == "oklab") {
+    if (targetSpaceBase.id === "oklab") {
       return convert(out, OKLCH, targetSpace, out);
     }
 

package/src/okhsl.js

@@ -371,7 +371,7 @@ export const OKLabToOKHSV = (lab, gamut = sRGBGamut, out = vec3()) => {
     s = ((s0 + tMax) * cv) / (tMax * s0 + tMax * k * cv);
   }
 
-  // unlike colorjs.io, we are not worknig with none-types
+  // unlike colorjs.io, we are not working with none-types
   // if (Math.abs(s) < ε || v === 0.0) {
   //   h = null;
   // }

package/src/util.js

@@ -84,6 +84,8 @@ export const RGBToHex = (rgb) =>
 /**
  * @method
  * @deprecated Use RGBToHex instead.
+ * @param {Vector} rgb The RGB array.
+ * @returns {string} The hex color string.
  * @category rgb
  */
 export const RGBtoHex = RGBToHex;
@@ -92,11 +94,11 @@ export const RGBtoHex = RGBToHex;
  * Checks if an RGB color is within the gamut.
  * @method
  * @param {Vector} lrgb The linear RGB array.
- * @param {number} [ep=GAMUT_EPSILON] The epsilon value for comparison.
+ * @param {number} [ep=0] The epsilon value for comparison.
  * @returns {boolean} True if the color is within the gamut, false otherwise.
  * @category rgb
  */
-export const isRGBInGamut = (lrgb, ep = GAMUT_EPSILON) => {
+export const isRGBInGamut = (lrgb, ep = 0) => {
   const r = lrgb[0];
   const g = lrgb[1];
   const b = lrgb[2];

package/types.d.ts

@@ -386,11 +386,15 @@ declare module "@texel/color" {
      * @returns The hex color string.
      */
     function RGBToHex(rgb: Vector): string;
-    function RGBtoHex(): void;
+    /**
+     * @param rgb - The RGB array.
+     * @returns The hex color string.
+     */
+    function RGBtoHex(rgb: Vector): string;
     /**
      * Checks if an RGB color is within the gamut.
      * @param lrgb - The linear RGB array.
-     * @param [ep = GAMUT_EPSILON] - The epsilon value for comparison.
+     * @param [ep = 0] - The epsilon value for comparison.
      * @returns True if the color is within the gamut, false otherwise.
      */
     function isRGBInGamut(lrgb: Vector, ep?: number): boolean;