@texel/color 1.1.8 → 1.1.10

package/package.json

@@ -1,11 +1,13 @@
 {
   "name": "@texel/color",
-  "version": "1.1.8",
+  "version": "1.1.10",
   "description": "a minimal and modern color library",
   "type": "module",
   "main": "./src/index.js",
+  "types": "./types.d.ts",
   "exports": {
-    "import": "./src/index.js"
+    "import": "./src/index.js",
+    "types": "./types.d.ts"
   },
   "license": "MIT",
   "author": {

package/src/core.js

@@ -20,6 +20,10 @@ import { listColorSpaces, sRGB, XYZ } from "./spaces.js";
  * const vec = [ x, y, z ];
  */
 
+/**
+ * @typedef {number[][][]} ColorGamutCoefficients
+ */
+
 /**
  * @typedef {Object} ChromaticAdaptation
  * @property {Matrix3x3} from the matrix to convert from the source whitepoint to the destination whitepoint
@@ -42,6 +46,7 @@ import { listColorSpaces, sRGB, XYZ } from "./spaces.js";
 /**
  * @typedef {Object} ColorGamut
  * @property {ColorSpace} space the color space associated with this color gamut
+ * @property {ColorGamutCoefficients} [coefficients] the coefficients used during gamut mapping from OKLab
  */
 
 const tmp3 = vec3();

package/src/gamut.js

@@ -92,8 +92,8 @@ const setYZ = (v, a, b) => {
  * the RGB gamut, using the given coefficients.
  * @param {number} a The normalized a component of the hue.
  * @param {number} b The normalized b component of the hue.
- * @param {number[][]} lmsToRgb The LMS to RGB conversion matrix.
- * @param {number[][][]} okCoeff The OKLab coefficients.
+ * @param {Matrix3x3} lmsToRgb The LMS to RGB conversion matrix.
+ * @param {ColorGamutCoefficients} okCoeff The OKLab coefficients.
  * @returns {number} The maximum saturation.
  * @method
  * @category mapping

package/src/util.js

@@ -92,11 +92,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

@@ -15,6 +15,7 @@ declare module "@texel/color" {
      * const vec = [ x, y, z ];
      */
     type Vector = number[];
+    type ColorGamutCoefficients = number[][][];
     /**
      * @property from - the matrix to convert from the source whitepoint to the destination whitepoint
      * @property to - the matrix to convert from the destination whitepoint to the source whitepoint
@@ -47,9 +48,11 @@ declare module "@texel/color" {
     };
     /**
      * @property space - the color space associated with this color gamut
+     * @property [coefficients] - the coefficients used during gamut mapping from OKLab
      */
     type ColorGamut = {
         space: ColorSpace;
+        coefficients?: ColorGamutCoefficients;
     };
     /**
      * Converts OKLab color to another color space.
@@ -156,7 +159,7 @@ declare module "@texel/color" {
      * @param okCoeff - The OKLab coefficients.
      * @returns The maximum saturation.
      */
-    function computeMaxSaturationOKLC(a: number, b: number, lmsToRgb: number[][], okCoeff: number[][][]): number;
+    function computeMaxSaturationOKLC(a: number, b: number, lmsToRgb: Matrix3x3, okCoeff: ColorGamutCoefficients): number;
     /**
      * Retrieves the LMS to RGB conversion matrix from the given gamut.
      * @param gamut - The gamut object.