@sardine/colour 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Sardine
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,2 @@
+# colour
+It does things to colours!

package/dist/CIEDE2000.js

@@ -0,0 +1,2 @@
+import{bigSquare as a,deltaHue_d as b,hue_d as c,meanHue_d as d,toRadians as e}from"./util/index.js";export function ciede2000(f,g){const h=f.L,i=f.a,j=f.b,k=g.L,l=g.a,m=g.b,n=Math.sqrt(Math.pow(i,2)+Math.pow(j,2)),o=Math.sqrt(Math.pow(l,2)+Math.pow(m,2)),p=.5*(1-a((n+o)/2)),q=i*(1+p),r=l*(1+p),s=Math.sqrt(Math.pow(q,2)+Math.pow(j,2)),t=Math.sqrt(Math.pow(r,2)+Math.pow(m,2)),u=(s+t)/2,v=t-s,w=c(j,q),x=c(m,r),y=b({C1:n,C2:o,h1_d:w,h2_d:x}),z=2*Math.sqrt(s*t)*Math.sin(e(y)/2),A=d({C1:n,C2:o,h1_d:w,h2_d:x}),B=(h+k)/2,C=1-.17*Math.cos(e(A-30))+.24*Math.cos(e(2*A))+.32*Math.cos(e(3*A+6))-.2*Math.cos(e(4*A-63)),D=.045*u+1,E=1+.015*u*C,F=-2*a(u)*Math.sin(e(2*(30*Math.exp(-Math.pow((A-275)/25,2)))));return Math.sqrt(Math.pow((k-h)/(1*(1+.015*Math.pow(B-50,2)/Math.sqrt(20+Math.pow(B-50,2)))),2)+Math.pow(v/(1*D),2)+Math.pow(z/(1*E),2)+F*(v/(1*D))*(z/(1*E)))}
+//# sourceMappingURL=CIEDE2000.js.map

package/dist/CIEDE2000.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/CIEDE2000.ts"],"sourcesContent":["import { bigSquare, deltaHue_d, hue_d, meanHue_d, toRadians } from \"./util/index.js\";\nimport type { LabColour } from \"./converters\";\n\n/**\n * Mesures the colour difference between two colours in the Lab space\n *\n * Math taken from:\n *\n * https://en.wikipedia.org/wiki/Color_difference#CIEDE2000\n * http://www2.ece.rochester.edu/~gsharma/ciede2000/ciede2000noteCRNA.pdf\n * @param colour1 First colour to be compared\n * @param colour2 First colour to be compared\n */\nexport function ciede2000(colour1: LabColour, colour2: LabColour): number {\n  /**\n   * Glossary\n   * L - Lightness as defined by L*a*b*\n   * a - Describes the green–red opponent colors as defined by L*a*b*\n   * b - Describes the blue–yellow opponent colors as defined by L*a*b*\n   * C - Chroma as defined by CIE94\n   *\n   * Math notation\n   * _d - Derivative\n   * Δ - Difference between values\n   * ̅  - Mean value\n   */\n\n  /** Lightness for colour 1 */\n  const L1 = colour1.L;\n\n  /** green–red colour opponent for colour 1 */\n  const a1 = colour1.a;\n\n  /** blue–yellow colour opponent for colour 1 */\n  const b1 = colour1.b;\n\n  /** Lightness for colour 2 */\n  const L2 = colour2.L;\n\n  /** green–red colour opponent for colour 1 */\n  const a2 = colour2.a;\n\n  /** blue–yellow colour opponent for colour 1 */\n  const b2 = colour2.b;\n\n  /** Weighting factor for Luminance */\n  const kL = 1;\n\n  /** Weighting factor for Chroma */\n  const kC = 1;\n\n  /** Weighting factor for Hue */\n  const kH = 1;\n\n  /** Chroma for colour 1 */\n  const C1 = Math.sqrt(Math.pow(a1, 2) + Math.pow(b1, 2));\n\n  /** Chroma for colour 2 */\n  const C2 = Math.sqrt(Math.pow(a2, 2) + Math.pow(b2, 2));\n\n  /** Derivative of the Lightness difference */\n  const ΔL_d = L2 - L1;\n\n  /** Chroma mean value */\n  const C̅ = (C1 + C2) / 2;\n\n  const G = 0.5 * (1 - bigSquare(C̅));\n\n  /** Derivative of a1 */\n  const a1_d = a1 * (1 + G);\n\n  /** Derivative of a2 */\n  const a2_d = a2 * (1 + G);\n\n  /** Derivative of C1 */\n  const C1_d = Math.sqrt(Math.pow(a1_d, 2) + Math.pow(b1, 2));\n\n  /** Derivative of C2 */\n  const C2_d = Math.sqrt(Math.pow(a2_d, 2) + Math.pow(b2, 2));\n\n  /** Derivative of Chroma mean */\n  const C̅_d = (C1_d + C2_d) / 2;\n\n  /** Derivative of the mean difference of Chroma */\n  const ΔC̅_d = C2_d - C1_d;\n\n  /** Derivative of colour 1 Hue */\n  const h1_d = hue_d(b1, a1_d);\n\n  /** Derivative of colour 2 Hue */\n  const h2_d = hue_d(b2, a2_d);\n\n  /** Hue difference */\n  const Δh_d = deltaHue_d({ C1, C2, h1_d, h2_d });\n\n  const ΔH_d = 2 * Math.sqrt(C1_d * C2_d) * Math.sin(toRadians(Δh_d) / 2);\n\n  /** Derivative of mean hue */\n  const H̅_d = meanHue_d({ C1, C2, h1_d, h2_d });\n\n  /** Lightness Mean value*/\n  const L̅ = (L1 + L2) / 2;\n\n  /** Compensation for neutral colors (the primed values in the L*C*h differences) */\n  const T =\n    1 -\n    0.17 * Math.cos(toRadians(H̅_d - 30)) +\n    0.24 * Math.cos(toRadians(2 * H̅_d)) +\n    0.32 * Math.cos(toRadians(3 * H̅_d + 6)) -\n    0.2 * Math.cos(toRadians(4 * H̅_d - 63));\n\n  /** Compensation for lightness */\n  const SL =\n    1 + (0.015 * Math.pow(L̅ - 50, 2)) / Math.sqrt(20 + Math.pow(L̅ - 50, 2));\n\n  /** Compensation for chroma */\n  const SC = 0.045 * C̅_d + 1;\n\n  /** Compensation for hue */\n  const SH = 1 + 0.015 * C̅_d * T;\n\n  const rotation = 30 * Math.exp(-Math.pow((H̅_d - 275) / 25, 2));\n\n  /** A hue rotation term, to deal with the problematic blue region (hue angles in the neighborhood of 275°) */\n  const RT = -2 * bigSquare(C̅_d) * Math.sin(toRadians(rotation * 2));\n\n  /** Colour difference */\n  const ΔE = Math.sqrt(\n    Math.pow(ΔL_d / (kL * SL), 2) +\n      Math.pow(ΔC̅_d / (kC * SC), 2) +\n      Math.pow(ΔH_d / (kH * SH), 2) +\n      RT * (ΔC̅_d / (kC * SC)) * (ΔH_d / (kH * SH))\n  );\n\n  return ΔE;\n}\n"],"names":["bigSquare","deltaHue_d","hue_d","meanHue_d","toRadians","ciede2000","colour1","colour2","L1","L","a1","a","b1","b","L2","a2","b2","C1","Math","sqrt","pow","C2","G","a1_d","a2_d","C1_d","C2_d","C̅_d","ΔC̅_d","h1_d","h2_d","Δh_d","ΔH_d","sin","H̅_d","L̅","T","cos","SC","SH","RT","exp"],"mappings":"AAAA,MAAM,CAAGA,SAAS,IAATA,CAAS,CAAEC,UAAU,IAAVA,CAAU,CAAEC,KAAK,IAALA,CAAK,CAAEC,SAAS,IAATA,CAAS,CAAEC,SAAS,IAATA,CAAS,KAAQ,CAAiB,iBAapF,MAAM,UAAUC,SAAS,CAACC,CAAkB,CAAEC,CAAkB,CAAU,CAAC,AAezE,KAAK,CAACC,CAAE,CAAGF,CAAO,CAACG,CAAC,CAGdC,CAAE,CAAGJ,CAAO,CAACK,CAAC,CAGdC,CAAE,CAAGN,CAAO,CAACO,CAAC,CAGdC,CAAE,CAAGP,CAAO,CAACE,CAAC,CAGdM,CAAE,CAAGR,CAAO,CAACI,CAAC,CAGdK,CAAE,CAAGT,CAAO,CAACM,CAAC,CAYdI,CAAE,CAAGC,IAAI,CAACC,IAAI,CAACD,IAAI,CAACE,GAAG,CAACV,CAAE,CAAE,CAAC,EAAIQ,IAAI,CAACE,GAAG,CAACR,CAAE,CAAE,CAAC,GAG/CS,CAAE,CAAGH,IAAI,CAACC,IAAI,CAACD,IAAI,CAACE,GAAG,CAACL,CAAE,CAAE,CAAC,EAAIG,IAAI,CAACE,GAAG,CAACJ,CAAE,CAAE,CAAC,GAQ/CM,CAAC,CAAG,EAAG,EAAI,CAAC,CAAGtB,CAAS,EAFjBiB,CAAE,CAAGI,CAAE,EAAI,CAAC,GAKnBE,CAAI,CAAGb,CAAE,EAAI,CAAC,CAAGY,CAAC,EAGlBE,CAAI,CAAGT,CAAE,EAAI,CAAC,CAAGO,CAAC,EAGlBG,CAAI,CAAGP,IAAI,CAACC,IAAI,CAACD,IAAI,CAACE,GAAG,CAACG,CAAI,CAAE,CAAC,EAAIL,IAAI,CAACE,GAAG,CAACR,CAAE,CAAE,CAAC,GAGnDc,CAAI,CAAGR,IAAI,CAACC,IAAI,CAACD,IAAI,CAACE,GAAG,CAACI,CAAI,CAAE,CAAC,EAAIN,IAAI,CAACE,GAAG,CAACJ,CAAE,CAAE,CAAC,GAGnDW,CAAI,EAAKF,CAAI,CAAGC,CAAI,EAAI,CAAC,CAGxBE,CAAI,CAAKF,CAAI,CAAGD,CAAI,CAGnBI,CAAE,CAAG3B,CAAK,CAACU,CAAE,CAAEW,CAAI,EAGrBO,CAAI,CAAG5B,CAAK,CAACc,CAAE,CAAEQ,CAAI,EAGrBO,CAAI,CAAI9B,CAAU,CAAC,CAAC,AAACgB,EAAE,CAAFA,CAAE,CAAEI,EAAE,CAAFA,CAAE,CAAEQ,IAAI,CAAJA,CAAI,CAAEC,IAAI,CAAJA,CAAI,AAAC,CAAC,EAExCE,CAAG,CAAI,CAAC,CAAGd,IAAI,CAACC,IAAI,CAACM,CAAI,CAAGC,CAAI,EAAIR,IAAI,CAACe,GAAG,CAAC7B,CAAS,CAAC2B,CAAI,EAAK,CAAC,EAGhEG,CAAE,CAAI/B,CAAS,CAAC,CAAC,AAACc,EAAE,CAAFA,CAAE,CAAEI,EAAE,CAAFA,CAAE,CAAEQ,IAAI,CAAJA,CAAI,CAAEC,IAAI,CAAJA,CAAI,AAAC,CAAC,EAGvCK,CAAC,EAAK3B,CAAE,CAAGM,CAAE,EAAI,CAAC,CAGlBsB,CAAA,CACL,CAAC,CACD,GAAI,CAAGlB,IAAI,CAACmB,GAAG,CAACjC,CAAS,CAAC8B,CAAI,CAAI,EAAE,GACnC,GAAG,CAAGhB,IAAI,CAACmB,GAAG,CAACjC,CAAS,CAAC,CAAC,CAAG8B,CAAI,GACjC,GAAG,CAAGhB,IAAI,CAACmB,GAAG,CAACjC,CAAS,CAAC,CAAC,CAAG8B,CAAI,CAAI,CAAC,GACtC,EAAE,CAAGhB,IAAI,CAACmB,GAAG,CAACjC,CAAS,CAAC,CAAC,CAAG8B,CAAI,CAAI,EAAE,GAOlCI,CAAC,CAAG,IAAK,CAAGX,CAAI,CAAI,CAAC,CAGrBY,CAAC,CAAG,CAAC,CAAG,IAAK,CAAGZ,CAAI,CAAIS,CAAC,CAKzBI,CAAC,CAAG,EAAE,CAAGxC,CAAS,CAAC2B,CAAI,EAAKT,IAAI,CAACe,GAAG,CAAC7B,CAAS,CAAY,CAAC,EAHjD,EAAE,CAAGc,IAAI,CAACuB,GAAG,EAAEvB,IAAI,CAACE,GAAG,EAAEc,CAAK,CAAG,GAAG,EAAI,EAAE,CAAE,CAAC,MAa7D,MAAK,CAPMhB,IAAI,CAACC,IAAI,CACnBD,IAAI,CAACE,GAAG,EAnEIN,CAAE,CAAGN,CAAE,GAfV,CAAC,EAmEV,CAAC,CAAI,IAAK,CAAGU,IAAI,CAACE,GAAG,CAACe,CAAG,CAAG,EAAE,CAAE,CAAC,EAAKjB,IAAI,CAACC,IAAI,CAAC,EAAE,CAAGD,IAAI,CAACE,GAAG,CAACe,CAAG,CAAG,EAAE,CAAE,CAAC,KAe7C,CAAC,EAC3BjB,IAAI,CAACE,GAAG,CAACQ,CAAO,EAhFT,CAAC,CAgFiBU,CAAE,EAAG,CAAC,EAC/BpB,IAAI,CAACE,GAAG,CAACY,CAAK,EA9EP,CAAC,CA8EeO,CAAE,EAAG,CAAC,EAC7BC,CAAE,EAAIZ,CAAO,EAlFN,CAAC,CAkFcU,CAAE,IAAMN,CAAK,EA/E5B,CAAC,CA+EoCO,CAAE,GAIpD,CAAC"}

package/dist/RGBdistance.js

@@ -0,0 +1,2 @@
+import{ciede2000 as a}from"./CIEDE2000.js";import{convertRGBtoLab as b}from"./converters.js";export const RGBdistance=(c,d)=>{const e=b(c),f=b(d);return a(e,f)}
+//# sourceMappingURL=RGBdistance.js.map

package/dist/RGBdistance.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/RGBdistance.ts"],"sourcesContent":["import { ciede2000 } from \"./CIEDE2000.js\";\nimport { convertRGBtoLab } from \"./converters.js\";\nimport type { RGBColour } from \"./converters.js\";\n\nexport const RGBdistance = (colour1: RGBColour, colour2: RGBColour): number => {\n  const c1 = convertRGBtoLab(colour1);\n  const c2 = convertRGBtoLab(colour2);\n\n  return ciede2000(c1, c2);\n};\n"],"names":["ciede2000","convertRGBtoLab","RGBdistance","colour1","colour2","c1","c2"],"mappings":"AAAA,MAAM,CAAGA,SAAS,IAATA,CAAS,KAAQ,CAAgB,gBAC1C,MAAM,CAAGC,eAAe,IAAfA,CAAe,KAAQ,CAAiB,iBAGjD,MAAM,CAAC,KAAK,CAACC,WAAW,EAAIC,CAAkB,CAAEC,CAAkB,GAAa,CAAC,AAC9E,KAAK,CAACC,CAAE,CAAGJ,CAAe,CAACE,CAAO,EAC5BG,CAAE,CAAGL,CAAe,CAACG,CAAO,EAElC,MAAM,CAACJ,CAAS,CAACK,CAAE,CAAEC,CAAE,CACzB,CAAC"}

package/dist/colour.d.ts

@@ -0,0 +1,137 @@
+declare module "util/index" {
+    export interface HueHelper {
+        /** Chroma for colour 1 */
+        C1: number;
+        /** Chroma for colour 2 */
+        C2: number;
+        /** Derivative of colour 1 Hue */
+        h1_d: number;
+        /** Derivative of colour 2 Hue */
+        h2_d: number;
+    }
+    /**
+     * Calculates the Hue derivative
+     * @param x A numeric expression representing the cartesian x-coordinate.
+     * @param y A numeric expression representing the cartesian y-coordinate.
+     */
+    export function hue_d(x: number, y: number): number;
+    /**
+     * Calculates the difference between two Hue derivatives
+     * @param HueHelper param
+     */
+    export function deltaHue_d({ C1, C2, h1_d, h2_d }: HueHelper): number;
+    /**
+     * Calculates the mean between two Hue derivatives
+     * @param HueHelper param
+     */
+    export function meanHue_d({ C1, C2, h1_d, h2_d }: HueHelper): number;
+    /**
+     * Converts a number in degrees to radians
+     * @param n Number in degrees to be converted
+     */
+    export const toRadians: (n: number) => number;
+    /**
+     * Calculates a recurring square root
+     * @param n Input number
+     */
+    export const bigSquare: (n: number) => number;
+    /**
+     * Normalise black and white colorimetry as specified in IEC 61966-2-1
+     * @param n number to be normalised
+     */
+    export function reverseTransformation(n: number): number;
+    /**
+     * The division of the f function domain into two parts was done to prevent an infinite slope at n = 0
+     * @param n Number to be constrained
+     */
+    export function constrainLab(n: number): number;
+}
+declare module "converters" {
+    /**
+     * The RGB colour model represents a broad array of colours by describing the Red, Green and Blue channels.
+     */
+    export interface RGBColour {
+        /** A number between 0 and 255 to describe the Red colour channel */
+        R: number;
+        /** A number between 0 and 255 to describe the Green colour channel */
+        G: number;
+        /** A number between 0 and 255 to describe the Blue colour channel */
+        B: number;
+        /** A optional number between 0 and 1 to describe the Alpha colour channel */
+        A?: number;
+    }
+    /**
+     * L*a*b* space is three-dimensional and covers the entire range of human colour perception
+     */
+    export interface LabColour {
+        /** A number between 0 and 100 to describe the colour's lightness. (0 - black, 100 - white)  */
+        L: number;
+        /** A number between -128 and 127 to describe the green–red opponent colors, with negative values toward green and positive values toward red */
+        a: number;
+        /** A number between -128 and 127 to describe  blue–yellow opponents, with negative numbers toward blue and positive toward yellow */
+        b: number;
+    }
+    /**
+     * The CIE XYZ colour space is a device independent colour representation
+     */
+    export interface XYZColour {
+        /** X is a mix of response curves chosen to be nonnegative */
+        X: number;
+        /** Y as luminance */
+        Y: number;
+        /** Z is quasi-equal to blue */
+        Z: number;
+    }
+    /**
+     * Converts sRGB colour space to XYZ.
+     * Math comes from https://en.wikipedia.org/wiki/SRGB#The_reverse_transformation
+     * @param {RGBColour} colour sRGB colour
+     * @return {XYZColour} XYZ colour
+     */
+    export function convertRGBtoXYZ(colour: RGBColour): XYZColour;
+    /**
+     * Converts XYZ colour space to Lab
+     * Math comes from https://en.wikipedia.org/wiki/CIELAB_color_space#From_CIEXYZ_to_CIELAB[11]
+     * @param colour XYZ colour
+     * @return {LabColour} Lab colour
+     */
+    export function convertXYZtoLab(colour: XYZColour): LabColour;
+    /**
+     * Indirectly converts RGB to Lab.
+     * First converts RGB to XYZ,
+     * Then converts XYZ to Lab
+     * @param {RGBColour} colour sRGB colour
+     * @return {LabColour} Lab colour
+     */
+    export function convertRGBtoLab(colour: RGBColour): LabColour;
+}
+declare module "CIEDE2000" {
+    import type { LabColour } from "converters";
+    /**
+     * Mesures the colour difference between two colours in the Lab space
+     *
+     * Math taken from:
+     *
+     * https://en.wikipedia.org/wiki/Color_difference#CIEDE2000
+     * http://www2.ece.rochester.edu/~gsharma/ciede2000/ciede2000noteCRNA.pdf
+     * @param colour1 First colour to be compared
+     * @param colour2 First colour to be compared
+     */
+    export function ciede2000(colour1: LabColour, colour2: LabColour): number;
+}
+declare module "RGBdistance" {
+    import type { RGBColour } from "converters";
+    export const RGBdistance: (colour1: RGBColour, colour2: RGBColour) => number;
+}
+declare module "findNearestColours" {
+    import type { RGBColour } from "converters";
+    export function findNearestColours(colours: RGBColour[], palette: RGBColour[]): RGBColour[];
+}
+declare module "index" {
+    export { ciede2000 } from "CIEDE2000";
+    export { convertRGBtoXYZ, convertRGBtoLab, convertXYZtoLab, } from "converters";
+    export { RGBdistance } from "RGBdistance";
+}
+declare module "tests/CIEDE2000.test" { }
+declare module "tests/converters.test" { }
+declare module "tests/util.test" { }

package/dist/converters.js

@@ -0,0 +1,2 @@
+import{constrainLab as a,reverseTransformation as b}from"./util/index.js";export function convertRGBtoXYZ(a){const{R:c,G:d,B:e}=a,f=100*b(c/255),g=100*b(d/255),h=100*b(e/255);return{X:.4124*f+.3576*g+.1805*h,Y:.2126*f+.7152*g+.0722*h,Z:.0193*f+.1192*g+.9505*h}}export function convertXYZtoLab(b){const{X:c,Y:d,Z:e}=b,f=a(c/95.047),g=a(d/100),h=a(e/108.883);return{L:116*g-16,a:500*(f-g),b:200*(g-h)}}export function convertRGBtoLab(a){const b=convertRGBtoXYZ(a);return convertXYZtoLab(b)}
+//# sourceMappingURL=converters.js.map

package/dist/converters.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/converters.ts"],"sourcesContent":["import { constrainLab, reverseTransformation } from \"./util/index.js\";\n\n/**\n * The RGB colour model represents a broad array of colours by describing the Red, Green and Blue channels.\n */\n export interface RGBColour {\n  /** A number between 0 and 255 to describe the Red colour channel */\n  R: number;\n  /** A number between 0 and 255 to describe the Green colour channel */\n  G: number;\n  /** A number between 0 and 255 to describe the Blue colour channel */\n  B: number;\n  /** A optional number between 0 and 1 to describe the Alpha colour channel */\n  A?: number;\n}\n\n/**\n * L*a*b* space is three-dimensional and covers the entire range of human colour perception\n */\nexport interface LabColour {\n  /** A number between 0 and 100 to describe the colour's lightness. (0 - black, 100 - white)  */\n  L: number;\n  /** A number between -128 and 127 to describe the green–red opponent colors, with negative values toward green and positive values toward red */\n  a: number;\n  /** A number between -128 and 127 to describe  blue–yellow opponents, with negative numbers toward blue and positive toward yellow */\n  b: number;\n}\n\n/**\n * The CIE XYZ colour space is a device independent colour representation\n */\nexport interface XYZColour {\n  /** X is a mix of response curves chosen to be nonnegative */\n  X: number;\n  /** Y as luminance */\n  Y: number;\n  /** Z is quasi-equal to blue */\n  Z: number;\n}\n\n/**\n * Converts sRGB colour space to XYZ.\n * Math comes from https://en.wikipedia.org/wiki/SRGB#The_reverse_transformation\n * @param {RGBColour} colour sRGB colour\n * @return {XYZColour} XYZ colour\n */\nexport function convertRGBtoXYZ(colour: RGBColour): XYZColour {\n  const { R, G, B } = colour;\n\n  //sRGB values in the range 0 to 1\n  const rR: number = R / 255;\n  const rG: number = G / 255;\n  const rB: number = B / 255;\n\n  const _R = reverseTransformation(rR) * 100;\n  const _G = reverseTransformation(rG) * 100;\n  const _B = reverseTransformation(rB) * 100;\n\n  // Magic numbers are pre-calculated sRGB D65 constants\n  const X = _R * 0.4124 + _G * 0.3576 + _B * 0.1805;\n  const Y = _R * 0.2126 + _G * 0.7152 + _B * 0.0722;\n  const Z = _R * 0.0193 + _G * 0.1192 + _B * 0.9505;\n\n  return { X, Y, Z };\n}\n\n/**\n * Converts XYZ colour space to Lab\n * Math comes from https://en.wikipedia.org/wiki/CIELAB_color_space#From_CIEXYZ_to_CIELAB[11]\n * @param colour XYZ colour\n * @return {LabColour} Lab colour\n */\nexport function convertXYZtoLab(colour: XYZColour): LabColour {\n  const { X, Y, Z } = colour;\n\n  // Magic numbers are normalised for relative luminance from the D65 standard\n  const _X = X / 95.047;\n  const _Y = Y / 100;\n  const _Z = Z / 108.883;\n\n  const fX = constrainLab(_X);\n  const fY = constrainLab(_Y);\n  const fZ = constrainLab(_Z);\n\n  const L = 116 * fY - 16;\n  const a = 500 * (fX - fY);\n  const b = 200 * (fY - fZ);\n\n  return { L, a, b };\n}\n\n/**\n * Indirectly converts RGB to Lab.\n * First converts RGB to XYZ,\n * Then converts XYZ to Lab\n * @param {RGBColour} colour sRGB colour\n * @return {LabColour} Lab colour\n */\nexport function convertRGBtoLab(colour: RGBColour): LabColour {\n  const XYZColour = convertRGBtoXYZ(colour);\n  return convertXYZtoLab(XYZColour);\n}\n"],"names":["constrainLab","reverseTransformation","convertRGBtoXYZ","colour","R","G","B","_R","_G","_B","X","Y","Z","convertXYZtoLab","fX","fY","fZ","L","a","b","convertRGBtoLab","XYZColour"],"mappings":"AAAA,MAAM,CAAGA,YAAY,IAAZA,CAAY,CAAEC,qBAAqB,IAArBA,CAAqB,KAAQ,CAAiB,iBA8CrE,MAAM,UAAUC,eAAe,CAACC,CAAiB,CAAa,CAAC,AAC7D,KAAK,AAAC,CAAC,AAACC,CAAC,CAADA,CAAC,CAAEC,CAAC,CAADA,CAAC,CAAEC,CAAC,CAADA,CAAC,AAAC,CAAC,CAAGH,CAAM,CAOpBI,CAAE,CAA+B,GAAG,CAA/BN,CAAqB,CAJbG,CAAC,CAAG,GAAG,EAKpBI,CAAE,CAA+B,GAAG,CAA/BP,CAAqB,CAJbI,CAAC,CAAG,GAAG,EAKpBI,CAAE,CAA+B,GAAG,CAA/BR,CAAqB,CAJbK,CAAC,CAAG,GAAG,EAW1B,MAAM,AAAC,CAAC,AAACI,CAAC,CAJK,KAAM,CAAXH,CAAE,CAAiB,KAAM,CAAXC,CAAE,CAAiB,KAAM,CAAXC,CAAE,CAI5BE,CAAC,CAHE,KAAM,CAAXJ,CAAE,CAAiB,KAAM,CAAXC,CAAE,CAAiB,KAAM,CAAXC,CAAE,CAGzBG,CAAC,CAFD,KAAM,CAAXL,CAAE,CAAiB,KAAM,CAAXC,CAAE,CAAiB,KAAM,CAAXC,CAAE,AAEvB,CAAC,AACpB,CAAC,AAQD,MAAM,UAAUI,eAAe,CAACV,CAAiB,CAAa,CAAC,AAC7D,KAAK,AAAC,CAAC,AAACO,CAAC,CAADA,CAAC,CAAEC,CAAC,CAADA,CAAC,CAAEC,CAAC,CAADA,CAAC,AAAC,CAAC,CAAGT,CAAM,CAOpBW,CAAE,CAAGd,CAAY,CAJZU,CAAC,CAAG,MAAM,EAKfK,CAAE,CAAGf,CAAY,CAJZW,CAAC,CAAG,GAAG,EAKZK,CAAE,CAAGhB,CAAY,CAJZY,CAAC,CAAG,OAAO,EAUtB,MAAM,AAAC,CAAC,AAACK,CAAC,CAJA,GAAG,CAAGF,CAAE,CAAG,EAAE,CAIXG,CAAC,CAHH,GAAG,EAAIJ,CAAE,CAAGC,CAAE,EAGTI,CAAC,CAFN,GAAG,EAAIJ,CAAE,CAAGC,CAAE,CAEP,CAAC,AACpB,CAAC,AASD,MAAM,UAAUI,eAAe,CAACjB,CAAiB,CAAa,CAAC,AAC7D,KAAK,CAACkB,CAAS,CAAGnB,eAAe,CAACC,CAAM,EACxC,MAAM,CAACU,eAAe,CAACQ,CAAS,CAClC,CAAC"}

package/dist/findNearestColours.js

@@ -0,0 +1,2 @@
+import{RGBdistance as a}from"./RGBdistance.js";export function findNearestColours(b,c){const d=[],e=new WeakMap();for(const f of b)if(e.has(f))d.push(e.get(f));else{const g=[];for(let h=0;h<c.length;h++){const i=c[h],j=a(f,i);g.push(j)}const k=g.findIndex(a=>a===Math.min(...g)),l=c[k];d.push(l),e.set(f,l)}return d}
+//# sourceMappingURL=findNearestColours.js.map

package/dist/findNearestColours.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/findNearestColours.ts"],"sourcesContent":["import { RGBdistance } from \"./RGBdistance.js\";\nimport type  { RGBColour } from \"./converters\";\n\nexport function findNearestColours(\n  colours: RGBColour[],\n  palette: RGBColour[]\n): RGBColour[] {\n  const setColour: RGBColour[] = [];\n  const colourWeakMap = new WeakMap();\n  for (const colour of colours) {\n    if (colourWeakMap.has(colour)) {\n      setColour.push(colourWeakMap.get(colour));\n    } else {\n      const distanceMap: number[]  = [];\n      for (let i = 0; i < palette.length; i++) {\n        const brickColour = palette[i] as RGBColour;\n        const distance = RGBdistance(colour, brickColour);\n        distanceMap.push(distance);\n      }\n      const closestIndex = distanceMap.findIndex(el => el === Math.min(...distanceMap));\n      const closest = palette[closestIndex] as RGBColour;\n      setColour.push(closest);\n      colourWeakMap.set(colour, closest);\n    }\n  }\n  return setColour;\n}\n"],"names":["RGBdistance","findNearestColours","colours","palette","setColour","colourWeakMap","WeakMap","colour","has","push","get","distanceMap","i","length","brickColour","distance","closestIndex","findIndex","el","Math","min","closest","set"],"mappings":"AAAA,MAAM,CAAGA,WAAW,IAAXA,CAAW,KAAQ,CAAkB,kBAG9C,MAAM,UAAUC,kBAAkB,CAChCC,CAAoB,CACpBC,CAAoB,CACP,CAAC,AACd,KAAK,CAACC,CAAS,CAAgB,CAAC,CAAC,CAC3BC,CAAa,CAAG,GAAG,CAACC,OAAO,GACjC,GAAG,CAAE,KAAK,CAACC,CAAM,IAAIL,CAAO,CAC1B,EAAE,CAAEG,CAAa,CAACG,GAAG,CAACD,CAAM,EAC1BH,CAAS,CAACK,IAAI,CAACJ,CAAa,CAACK,GAAG,CAACH,CAAM,OAClC,CAAC,AACN,KAAK,CAACI,CAAW,CAAc,CAAC,CAAC,CACjC,GAAG,CAAE,GAAG,CAACC,CAAC,CAAG,CAAC,CAAEA,CAAC,CAAGT,CAAO,CAACU,MAAM,CAAED,CAAC,GAAI,CAAC,AACxC,KAAK,CAACE,CAAW,CAAGX,CAAO,CAACS,CAAC,EACvBG,CAAQ,CAAGf,CAAW,CAACO,CAAM,CAAEO,CAAW,EAChDH,CAAW,CAACF,IAAI,CAACM,CAAQ,CAC3B,CAAC,AACD,KAAK,CAACC,CAAY,CAAGL,CAAW,CAACM,SAAS,CAACC,CAAE,EAAIA,CAAE,GAAKC,IAAI,CAACC,GAAG,IAAIT,CAAW,GACzEU,CAAO,CAAGlB,CAAO,CAACa,CAAY,EACpCZ,CAAS,CAACK,IAAI,CAACY,CAAO,EACtBhB,CAAa,CAACiB,GAAG,CAACf,CAAM,CAAEc,CAAO,CACnC,CAAC,AAEH,MAAM,CAACjB,CAAS,AAClB,CAAC"}

package/dist/index.js

@@ -0,0 +1,2 @@
+export{ciede2000}from"./CIEDE2000.js";export{convertRGBtoXYZ,convertRGBtoLab,convertXYZtoLab}from"./converters.js";export{RGBdistance}from"./RGBdistance.js"
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["export { ciede2000 } from \"./CIEDE2000.js\";\nexport {\n  convertRGBtoXYZ,\n  convertRGBtoLab,\n  convertXYZtoLab,\n} from \"./converters.js\";\nexport { RGBdistance } from \"./RGBdistance.js\";\n"],"names":["ciede2000","convertRGBtoXYZ","convertRGBtoLab","convertXYZtoLab","RGBdistance"],"mappings":"AAAA,MAAM,CAAGA,SAAS,KAAQ,CAAgB,gBAC1C,MAAM,CACJC,eAAe,CACfC,eAAe,CACfC,eAAe,KACV,CAAiB,iBACxB,MAAM,CAAGC,WAAW,KAAQ,CAAkB"}

package/dist/util/index.js

@@ -0,0 +1,2 @@
+export function hue_d(a,b){if(0===a&&0===b)return 0;const c=Math.atan2(a,b)*(180/Math.PI);return c>=0?c:c+360}export function deltaHue_d({C1:a,C2:b,h1_d:c,h2_d:d}){return a*b==0?0:180>=Math.abs(d-c)?d-c:d-c>180?d-c-360:d-c< -180?d-c+360:0}export function meanHue_d({C1:a,C2:b,h1_d:c,h2_d:d}){return a*b==0?d+c:180>=Math.abs(c-d)?(d+c)/2:Math.abs(c-d)>180&&c+d<360?(d+c+360)/2:Math.abs(c-d)>180&&c+d>=360?(d+c-360)/2:0}export const toRadians=a=>a*(Math.PI/180);export const bigSquare=a=>Math.sqrt(Math.pow(a,7)/(Math.pow(a,7)+6103515625));export function reverseTransformation(a){return a>.04045?Math.pow((a+.055)/1.055,2.4):a/12.92}export function constrainLab(a){const b=6/29;return a>Math.pow(b,3)?Math.cbrt(a):a/(3*Math.pow(b,2))+4/29}
+//# sourceMappingURL=index.js.map

package/dist/util/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/util/index.ts"],"sourcesContent":["export interface HueHelper {\n  /** Chroma for colour 1 */\n  C1: number;\n  /** Chroma for colour 2 */\n  C2: number;\n  /** Derivative of colour 1 Hue */\n  h1_d: number;\n  /** Derivative of colour 2 Hue */\n  h2_d: number;\n}\n\n/**\n * Calculates the Hue derivative\n * @param x A numeric expression representing the cartesian x-coordinate.\n * @param y A numeric expression representing the cartesian y-coordinate.\n */\nexport function hue_d(x: number, y: number): number {\n  // early exit if both values are 0\n  if (x === 0 && y === 0) {\n    return 0;\n  }\n  /** The angle in degrees */\n  const angle = Math.atan2(x, y) * (180 / Math.PI);\n  if (angle >= 0) {\n    return angle;\n  }\n  return angle + 360;\n}\n\n/**\n * Calculates the difference between two Hue derivatives\n * @param HueHelper param\n */\nexport function deltaHue_d({ C1, C2, h1_d, h2_d }: HueHelper): number {\n  if (C1 * C2 === 0) {\n    return 0;\n  }\n  if (Math.abs(h2_d - h1_d) <= 180) {\n    return h2_d - h1_d;\n  }\n  if (h2_d - h1_d > 180) {\n    return h2_d - h1_d - 360;\n  }\n  if (h2_d - h1_d < -180) {\n    return h2_d - h1_d + 360;\n  }\n  // it should never reach this point\n  return 0;\n}\n\n/**\n * Calculates the mean between two Hue derivatives\n * @param HueHelper param\n */\nexport function meanHue_d({ C1, C2, h1_d, h2_d }: HueHelper): number {\n  if (C1 * C2 === 0) {\n    return h2_d + h1_d;\n  }\n  if (Math.abs(h1_d - h2_d) <= 180) {\n    return (h2_d + h1_d) / 2;\n  }\n  if (Math.abs(h1_d - h2_d) > 180 && h1_d + h2_d < 360) {\n    return (h2_d + h1_d + 360) / 2;\n  }\n  if (Math.abs(h1_d - h2_d) > 180 && h1_d + h2_d >= 360) {\n    return (h2_d + h1_d - 360) / 2;\n  }\n  // it should never reach this point\n  return 0;\n}\n\n/**\n * Converts a number in degrees to radians\n * @param n Number in degrees to be converted\n */\nexport const toRadians = (n: number): number => n * (Math.PI / 180);\n\n/**\n * Calculates a recurring square root\n * @param n Input number\n */\nexport const bigSquare = (n: number): number =>\n  Math.sqrt(Math.pow(n, 7) / (Math.pow(n, 7) + Math.pow(25, 7)));\n\n/**\n * Normalise black and white colorimetry as specified in IEC 61966-2-1\n * @param n number to be normalised\n */\nexport function reverseTransformation(n: number) {\n  let u: number;\n\n  if (n > 0.04045) {\n    u = Math.pow((n + 0.055) / 1.055, 2.4);\n  } else {\n    u = n / 12.92;\n  }\n\n  return u;\n}\n\n/**\n * The division of the f function domain into two parts was done to prevent an infinite slope at n = 0\n * @param n Number to be constrained\n */\nexport function constrainLab(n: number): number {\n  const delta = 6 / 29;\n  const deltaCube = Math.pow(delta, 3);\n  let t: number;\n\n  if (n > deltaCube) {\n    t = Math.cbrt(n);\n  } else {\n    t = n / (3 * Math.pow(delta, 2)) + 4 / 29;\n  }\n\n  return t;\n}\n"],"names":["hue_d","x","y","angle","Math","atan2","PI","deltaHue_d","C1","C2","h1_d","h2_d","abs","meanHue_d","toRadians","n","bigSquare","sqrt","pow","reverseTransformation","constrainLab","delta","cbrt"],"mappings":"AAgBA,MAAM,UAAUA,KAAK,CAACC,CAAS,CAAEC,CAAS,CAAU,CAAC,AAEnD,EAAE,CAAQ,CAAC,GAAPD,CAAC,EAAgB,CAAC,GAAPC,CAAC,CACd,MAAM,CAAC,CAAC,CAGV,KAAK,CAACC,CAAK,CAAGC,IAAI,CAACC,KAAK,CAACJ,CAAC,CAAEC,CAAC,GAAK,GAAG,CAAGE,IAAI,CAACE,EAAE,SAC3CH,CAAK,EAAI,CAAC,CACLA,CAAK,CAEPA,CAAK,CAAG,GAAG,AACpB,CAAC,AAMD,MAAM,UAAUI,UAAU,CAAC,CAAC,AAACC,EAAE,CAAFA,CAAE,CAAEC,EAAE,CAAFA,CAAE,CAAEC,IAAI,CAAJA,CAAI,CAAEC,IAAI,CAAJA,CAAI,AAAY,CAAC,CAAU,CAAC,OACjEH,CAAE,CAAGC,CAAE,EAAK,CAAC,CACR,CAAC,CAEmB,GAAG,EAA5BL,IAAI,CAACQ,GAAG,CAACD,CAAI,CAAGD,CAAI,EACfC,CAAI,CAAGD,CAAI,CAEhBC,CAAI,CAAGD,CAAI,CAAG,GAAG,CACZC,CAAI,CAAGD,CAAI,CAAG,GAAG,CAEtBC,CAAI,CAAGD,CAAI,EAAG,IAAI,CACbC,CAAI,CAAGD,CAAI,CAAG,GAAG,CAGnB,CAAC,AACV,CAAC,AAMD,MAAM,UAAUG,SAAS,CAAC,CAAC,AAACL,EAAE,CAAFA,CAAE,CAAEC,EAAE,CAAFA,CAAE,CAAEC,IAAI,CAAJA,CAAI,CAAEC,IAAI,CAAJA,CAAI,AAAY,CAAC,CAAU,CAAC,OAChEH,CAAE,CAAGC,CAAE,EAAK,CAAC,CACRE,CAAI,CAAGD,CAAI,CAES,GAAG,EAA5BN,IAAI,CAACQ,GAAG,CAACF,CAAI,CAAGC,CAAI,GACdA,CAAI,CAAGD,CAAI,EAAI,CAAC,CAEtBN,IAAI,CAACQ,GAAG,CAACF,CAAI,CAAGC,CAAI,EAAI,GAAG,EAAID,CAAI,CAAGC,CAAI,CAAG,GAAG,EAC1CA,CAAI,CAAGD,CAAI,CAAG,GAAG,EAAI,CAAC,CAE5BN,IAAI,CAACQ,GAAG,CAACF,CAAI,CAAGC,CAAI,EAAI,GAAG,EAAID,CAAI,CAAGC,CAAI,EAAI,GAAG,EAC3CA,CAAI,CAAGD,CAAI,CAAG,GAAG,EAAI,CAAC,CAGzB,CAAC,AACV,CAAC,AAMD,MAAM,CAAC,KAAK,CAACI,SAAS,CAAIC,CAAS,EAAaA,CAAC,EAAIX,IAAI,CAACE,EAAE,CAAG,GAAG,EAMlE,MAAM,CAAC,KAAK,CAACU,SAAS,CAAID,CAAS,EACjCX,IAAI,CAACa,IAAI,CAACb,IAAI,CAACc,GAAG,CAACH,CAAC,CAAE,CAAC,GAAKX,IAAI,CAACc,GAAG,CAACH,CAAC,CAAE,CAAC,EAAIX,UAAe,GAM9D,MAAM,UAAUe,qBAAqB,CAACJ,CAAS,CAAE,CAAC,AAShD,MAAM,CANFA,CAAC,CAAG,MAAO,CACTX,IAAI,CAACc,GAAG,EAAEH,CAAC,CAAG,IAAK,EAAI,KAAK,CAAE,GAAG,EAEjCA,CAAC,CAAG,KAAK,AAIjB,CAAC,AAMD,MAAM,UAAUK,YAAY,CAACL,CAAS,CAAU,CAAC,AAC/C,KAAK,CAACM,CAAK,CAAG,CAAC,CAAG,EAAE,CAUpB,MAAM,CANFN,CAAC,CAHaX,IAAI,CAACc,GAAG,CAACG,CAAK,CAAE,CAAC,EAI7BjB,IAAI,CAACkB,IAAI,CAACP,CAAC,EAEXA,CAAC,EAAI,CAAC,CAAGX,IAAI,CAACc,GAAG,CAACG,CAAK,CAAE,CAAC,GAAK,CAAC,CAAG,EAAE,AAI7C,CAAC"}

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@sardine/colour",
+  "version": "1.0.0",
+  "description": "It does things to colours",
+  "module": "./dist/index.js",
+  "type": "module",
+  "types": "./dist/colour.d.ts",
+  "scripts": {
+    "build": "rm -rf ./dist && npx swc ./src -d ./dist",
+    "test": "npm run build && c8 ava",
+    "types:emit": "npx tsc --declaration --emitDeclarationOnly --outFile ./dist/colour.d.ts",
+    "types:check": "npx tsc --noEmit",
+    "publish:next": "npm run build && npm run types:emit && npm publish --tag next",
+    "publish:latest": "npm run build && npm run types:emit && npm publish"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sardinedev/colour.git"
+  },
+  "files": [
+    "dist",
+    "!dist/tests"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "color",
+    "colour"
+  ],
+  "author": "Hugo Nogueira",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/sardinedev/colour/issues"
+  },
+  "homepage": "https://github.com/sardinedev/colour#readme",
+  "engines": {
+    "node": ">= 14"
+  },
+  "devDependencies": {
+    "@swc/cli": "^0.1.55",
+    "@swc/core": "^1.2.136",
+    "ava": "^4.0.1",
+    "c8": "^7.11.0",
+    "typescript": "^4.5.5"
+  }
+}