Color Helpers

.github/bin/license/check-license.mjs

@@ -57,7 +57,7 @@ const allFiles = (await getFiles('./')).filter((file) => {
 
 		for (const line of lines) {
 			if (line.includes('@license')) {
-				if (line === ' * @license W3C') {
+				if (line.startsWith(' * @license W3C')) {
 					// W3C license is ok
 					continue;
 				}

packages/color-helpers/.gitignore

@@ -0,0 +1,5 @@
+node_modules
+package-lock.json
+yarn.lock
+*.result.css
+*.result.css.map

packages/color-helpers/.nvmrc

@@ -0,0 +1 @@
+v16.13.1

packages/color-helpers/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changes to Color Helpers
+
+### Unreleased (major)
+
+- Initial version

packages/color-helpers/LICENSE.md

@@ -0,0 +1,108 @@
+# CC0 1.0 Universal
+
+## Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator and
+subsequent owner(s) (each and all, an “owner”) of an original work of
+authorship and/or a database (each, a “Work”).
+
+Certain owners wish to permanently relinquish those rights to a Work for the
+purpose of contributing to a commons of creative, cultural and scientific works
+(“Commons”) that the public can reliably and without fear of later claims of
+infringement build upon, modify, incorporate in other works, reuse and
+redistribute as freely as possible in any form whatsoever and for any purposes,
+including without limitation commercial purposes. These owners may contribute
+to the Commons to promote the ideal of a free culture and the further
+production of creative, cultural and scientific works, or to gain reputation or
+greater distribution for their Work in part through the use and efforts of
+others.
+
+For these and/or other purposes and motivations, and without any expectation of
+additional consideration or compensation, the person associating CC0 with a
+Work (the “Affirmer”), to the extent that he or she is an owner of Copyright
+and Related Rights in the Work, voluntarily elects to apply CC0 to the Work and
+publicly distribute the Work under its terms, with knowledge of his or her
+Copyright and Related Rights in the Work and the meaning and intended legal
+effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+   protected by copyright and related or neighboring rights (“Copyright and
+   Related Rights”). Copyright and Related Rights include, but are not limited
+   to, the following:
+   1. the right to reproduce, adapt, distribute, perform, display, communicate,
+      and translate a Work;
+   2. moral rights retained by the original author(s) and/or performer(s);
+   3. publicity and privacy rights pertaining to a person’s image or likeness
+      depicted in a Work;
+   4. rights protecting against unfair competition in regards to a Work,
+      subject to the limitations in paragraph 4(i), below;
+   5. rights protecting the extraction, dissemination, use and reuse of data in
+      a Work;
+   6. database rights (such as those arising under Directive 96/9/EC of the
+      European Parliament and of the Council of 11 March 1996 on the legal
+      protection of databases, and under any national implementation thereof,
+      including any amended or successor version of such directive); and
+   7. other similar, equivalent or corresponding rights throughout the world
+      based on applicable law or treaty, and any national implementations
+      thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention of,
+   applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and
+   unconditionally waives, abandons, and surrenders all of Affirmer’s Copyright
+   and Related Rights and associated claims and causes of action, whether now
+   known or unknown (including existing as well as future claims and causes of
+   action), in the Work (i) in all territories worldwide, (ii) for the maximum
+   duration provided by applicable law or treaty (including future time
+   extensions), (iii) in any current or future medium and for any number of
+   copies, and (iv) for any purpose whatsoever, including without limitation
+   commercial, advertising or promotional purposes (the “Waiver”). Affirmer
+   makes the Waiver for the benefit of each member of the public at large and
+   to the detriment of Affirmer’s heirs and successors, fully intending that
+   such Waiver shall not be subject to revocation, rescission, cancellation,
+   termination, or any other legal or equitable action to disrupt the quiet
+   enjoyment of the Work by the public as contemplated by Affirmer’s express
+   Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason be
+   judged legally invalid or ineffective under applicable law, then the Waiver
+   shall be preserved to the maximum extent permitted taking into account
+   Affirmer’s express Statement of Purpose. In addition, to the extent the
+   Waiver is so judged Affirmer hereby grants to each affected person a
+   royalty-free, non transferable, non sublicensable, non exclusive,
+   irrevocable and unconditional license to exercise Affirmer’s Copyright and
+   Related Rights in the Work (i) in all territories worldwide, (ii) for the
+   maximum duration provided by applicable law or treaty (including future time
+   extensions), (iii) in any current or future medium and for any number of
+   copies, and (iv) for any purpose whatsoever, including without limitation
+   commercial, advertising or promotional purposes (the “License”). The License
+   shall be deemed effective as of the date CC0 was applied by Affirmer to the
+   Work. Should any part of the License for any reason be judged legally
+   invalid or ineffective under applicable law, such partial invalidity or
+   ineffectiveness shall not invalidate the remainder of the License, and in
+   such case Affirmer hereby affirms that he or she will not (i) exercise any
+   of his or her remaining Copyright and Related Rights in the Work or (ii)
+   assert any associated claims and causes of action with respect to the Work,
+   in either case contrary to Affirmer’s express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+   1. No trademark or patent rights held by Affirmer are waived, abandoned,
+      surrendered, licensed or otherwise affected by this document.
+   2. Affirmer offers the Work as-is and makes no representations or warranties
+      of any kind concerning the Work, express, implied, statutory or
+      otherwise, including without limitation warranties of title,
+      merchantability, fitness for a particular purpose, non infringement, or
+      the absence of latent or other defects, accuracy, or the present or
+      absence of errors, whether or not discoverable, all to the greatest
+      extent permissible under applicable law.
+   3. Affirmer disclaims responsibility for clearing rights of other persons
+      that may apply to the Work or any use thereof, including without
+      limitation any person’s Copyright and Related Rights in the Work.
+      Further, Affirmer disclaims responsibility for obtaining any necessary
+      consents, permissions or other rights required for any use of the Work.
+   4. Affirmer understands and acknowledges that Creative Commons is not a
+      party to this document and has no duty or obligation with respect to this
+      CC0 or use of the Work.
+
+For more information, please see
+http://creativecommons.org/publicdomain/zero/1.0/.

packages/color-helpers/README.md

@@ -0,0 +1,32 @@
+# Color Helpers
+
+[<img alt="npm version" src="https://img.shields.io/npm/v/@csstools/color-helpers.svg" height="20">][npm-url]
+[<img alt="Build Status" src="https://github.com/csstools/postcss-plugins/workflows/test/badge.svg" height="20">][cli-url]
+[<img alt="Discord" src="https://shields.io/badge/Discord-5865F2?logo=discord&logoColor=white">][discord]
+
+## Usage
+
+Add [Color Helpers] to your project:
+
+```bash
+npm install postcss @csstools/color-helpers --save-dev
+```
+
+This package exists to join all the different color functions scattered among the Colors 4 and Colors 5 plugins we maintain such as:
+
+* [PostCSS Color Function]
+* [PostCSS Lab Function]
+* [PostCSS OKLab Function]
+
+## Copyright
+
+This software or document includes material copied from or derived from https://github.com/w3c/csswg-drafts/tree/main/css-color-4. Copyright © 2022 W3C® (MIT, ERCIM, Keio, Beihang).
+
+[cli-url]: https://github.com/csstools/postcss-plugins/actions/workflows/test.yml?query=workflow/test
+[discord]: https://discord.gg/bUadyRwkJS
+[npm-url]: https://www.npmjs.com/package/@csstools/color-helpers
+
+[Color Helpers]: https://github.com/csstools/postcss-plugins/tree/main/packages/color-helpers
+[PostCSS Color Function]: https://github.com/csstools/postcss-plugins/tree/main/plugins/postcss-color-function
+[PostCSS Lab Function]: https://github.com/csstools/postcss-plugins/tree/main/plugins/postcss-lab-functionw
+[PostCSS OKLab Function]: https://github.com/csstools/postcss-plugins/tree/main/plugins/postcss-oklab-function

packages/color-helpers/dist/calculations/binary-search-gamut.d.ts

@@ -0,0 +1 @@
+export declare function binarySearchGamut(startOKLCH: Color, toDestination: (x: Color) => Color, fromDestination: (x: Color) => Color): Color;

packages/color-helpers/dist/calculations/contrast.d.ts

@@ -0,0 +1 @@
+export declare function contrast(RGB1: Color, RGB2: Color): number;

packages/color-helpers/dist/calculations/delta-EOK.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @description Calculate deltaE OK which is the simple root sum of squares
+ * @param {number[]} reference - Array of OKLab values: L as 0..1, a and b as -1..1
+ * @param {number[]} sample - Array of OKLab values: L as 0..1, a and b as -1..1
+ * @return {number} How different a color sample is from reference
+ *
+ * @license W3C https://www.w3.org/Consortium/Legal/2015/copyright-software-and-document
+ *
+ * @copyright This software or document includes material copied from or derived from https://github.com/w3c/csswg-drafts/blob/main/css-color-4/deltaEOK.js. Copyright © 2022 W3C® (MIT, ERCIM, Keio, Beihang).
+ *
+ * @see https://github.com/w3c/csswg-drafts/blob/main/css-color-4/deltaEOK.js
+ */
+export declare function deltaEOK(reference: Color, sample: Color): number;

packages/color-helpers/dist/calculations/index.d.ts

@@ -0,0 +1,6 @@
+export * from './binary-search-gamut';
+export * from './polar-premultiply';
+export * from './map-gamut';
+export * from './delta-EOK';
+export * from './contrast';
+export * from './multiply-matrices';

packages/color-helpers/dist/calculations/map-gamut.d.ts

@@ -0,0 +1 @@
+export declare function mapGamut(startOKLCH: Color, toDestination: (x: Color) => Color, fromDestination: (x: Color) => Color): Color;

plugins/postcss-oklab-function/dist/css-color-4/multiply-matrices.d.ts → packages/color-helpers/dist/calculations/multiply-matrices.d.ts

@@ -3,8 +3,7 @@
  * Warning: No error handling for incompatible dimensions!
  * @author Lea Verou 2020 MIT License
  *
- * @license W3C
- * https://www.w3.org/Consortium/Legal/2015/copyright-software-and-document
+ * @license W3C https://www.w3.org/Consortium/Legal/2015/copyright-software-and-document
  *
  * @copyright This software or document includes material copied from or derived from https://github.com/w3c/csswg-drafts/blob/main/css-color-4/multiply-matrices.js. Copyright © 2022 W3C® (MIT, ERCIM, Keio, Beihang).
  *

packages/color-helpers/dist/calculations/polar-premultiply.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Given a color in a cylindical polar colorspace and an alpha value
+ * return the premultiplied form. The index says which entry in the
+ * color array corresponds to hue angle for example, in OKLCH it
+ * would be 2 while in HSL it would be 0
+ *
+ * @param color
+ * @param alpha
+ * @param hueIndex
+ *
+ * @license W3C https://www.w3.org/Consortium/Legal/2015/copyright-software-and-document
+ *
+ * @copyright This software or document includes material copied from or derived from https://github.com/w3c/csswg-drafts/blob/main/css-color-4/conversions.js. Copyright © 2022 W3C® (MIT, ERCIM, Keio, Beihang).
+ */
+export declare function polarPremultiply(color: Color, alpha: number, hueIndex: number): Color;

packages/color-helpers/dist/conversions/a98-rgb-to-srgb.d.ts

@@ -0,0 +1 @@
+export declare function a98_RGB_to_sRGB(a98: Color): Color;

packages/color-helpers/dist/conversions/cie-xyz-50-to-srgb.d.ts

@@ -0,0 +1 @@
+export declare function cie_XYZ_50_to_sRGB(xyz: Color): Color;

packages/color-helpers/dist/conversions/cie-xyz-65-to-srgb.d.ts

@@ -0,0 +1 @@
+export declare function cie_XYZ_65_to_sRGB(xyz: Color): Color;

packages/color-helpers/dist/conversions/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const D50: number[];
+export declare const D65: number[];

packages/color-helpers/dist/conversions/d50-to-d65.d.ts

@@ -0,0 +1 @@
+export declare function D50_to_D65(XYZ: Color): Color;

packages/color-helpers/dist/conversions/d65-to-d50.d.ts

@@ -0,0 +1 @@
+export declare function D65_to_D50(XYZ: Color): Color;

packages/color-helpers/dist/conversions/gam-2020.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Convert an array of linear-light rec2020 RGB  in the range 0.0-1.0
+ * to gamma corrected form ITU-R BT.2020-2 p.4
+ *
+ * @license W3C https://www.w3.org/Consortium/Legal/2015/copyright-software-and-document
+ *
+ * @copyright This software or document includes material copied from or derived from https://github.com/w3c/csswg-drafts/blob/main/css-color-4/conversions.js. Copyright © 2022 W3C® (MIT, ERCIM, Keio, Beihang).
+ */
+export declare function gam_2020(RGB: Color): Color;

packages/color-helpers/dist/conversions/gam-a98rgb.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Convert an array of linear-light a98-rgb in the range 0.0-1.0
+ * to gamma corrected form. Negative values are also now accepted
+ *
+ * @license W3C https://www.w3.org/Consortium/Legal/2015/copyright-software-and-document
+ *
+ * @copyright This software or document includes material copied from or derived from https://github.com/w3c/csswg-drafts/blob/main/css-color-4/conversions.js. Copyright © 2022 W3C® (MIT, ERCIM, Keio, Beihang).
+ */
+export declare function gam_a98rgb(RGB: Color): Color;

packages/color-helpers/dist/conversions/gam-p3.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Convert an array of linear-light display-p3 RGB in the range 0.0-1.0
+ * to gamma corrected form
+ *
+ * @license W3C https://www.w3.org/Consortium/Legal/2015/copyright-software-and-document
+ *
+ * @copyright This software or document includes material copied from or derived from https://github.com/w3c/csswg-drafts/blob/main/css-color-4/conversions.js. Copyright © 2022 W3C® (MIT, ERCIM, Keio, Beihang).
+ */
+export declare function gam_P3(RGB: Color): Color;

packages/color-helpers/dist/conversions/gam-pro-photo.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Convert an array of linear-light prophoto-rgb in the range 0.0-1.0
+ * to gamma corrected form.
+ * Transfer curve is gamma 1.8 with a small linear portion.
+ *
+ * @license W3C https://www.w3.org/Consortium/Legal/2015/copyright-software-and-document
+ *
+ * @copyright This software or document includes material copied from or derived from https://github.com/w3c/csswg-drafts/blob/main/css-color-4/conversions.js. Copyright © 2022 W3C® (MIT, ERCIM, Keio, Beihang).
+ */
+export declare function gam_ProPhoto(RGB: Color): Color;

packages/color-helpers/dist/conversions/gam-srgb.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Convert an array of linear-light sRGB values in the range 0.0-1.0 to gamma corrected form
+ * Extended transfer function:
+ *  For negative values, linear portion extends on reflection
+ *  of axis, then uses reflected pow below that
+ *
+ * @license W3C https://www.w3.org/Consortium/Legal/2015/copyright-software-and-document
+ *
+ * @copyright This software or document includes material copied from or derived from https://github.com/w3c/csswg-drafts/blob/main/css-color-4/conversions.js. Copyright © 2022 W3C® (MIT, ERCIM, Keio, Beihang).
+ *
+ * @see https://en.wikipedia.org/wiki/SRGB
+ */
+export declare function gam_sRGB(RGB: Color): Color;

packages/color-helpers/dist/conversions/hsl-to-srgb.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @param {number} hue - Hue as degrees 0..360
+ * @param {number} sat - Saturation as percentage 0..100
+ * @param {number} light - Lightness as percentage 0..100
+ * @return {number[]} Array of RGB components 0..1
+ *
+ * @license W3C https://www.w3.org/Consortium/Legal/2015/copyright-software-and-document
+ *
+ * @copyright This software or document includes material copied from or derived from https://github.com/w3c/csswg-drafts/blob/main/css-color-4/hslToRgb.js. Copyright © 2022 W3C® (MIT, ERCIM, Keio, Beihang).
+ *
+ * @see https://github.com/w3c/csswg-drafts/blob/main/css-color-4/hslToRgb.js
+ */
+export declare function HSL_to_sRGB(HSL: Color): number[];

packages/color-helpers/dist/conversions/hue-to-rgb.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @license W3C https://www.w3.org/Consortium/Legal/2015/copyright-software-and-document
+ *
+ * @copyright This software or document includes material copied from or derived from https://github.com/w3c/csswg-drafts/blob/main/css-color-4/utilities.js. Copyright © 2022 W3C® (MIT, ERCIM, Keio, Beihang).
+ *
+ * @see https://github.com/w3c/csswg-drafts/blob/main/css-color-4/utilities.js
+ */
+export declare function hueToRGB(t1: number, t2: number, hue: number): number;

packages/color-helpers/dist/conversions/hwb-to-srgb.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @param {number} hue -  Hue as degrees 0..360
+ * @param {number} white -  Whiteness as percentage 0..100
+ * @param {number} black -  Blackness as percentage 0..100
+ * @return {number[]} Array of RGB components 0..1
+ *
+ * @license W3C https://www.w3.org/Consortium/Legal/2015/copyright-software-and-document
+ *
+ * @copyright This software or document includes material copied from or derived from https://github.com/w3c/csswg-drafts/blob/main/css-color-4/hwbToRgb.js. Copyright © 2022 W3C® (MIT, ERCIM, Keio, Beihang).
+ *
+ * @see https://github.com/w3c/csswg-drafts/blob/main/css-color-4/hwbToRgb.js
+ */
+export declare function HWB_to_sRGB(HWB: Color): number[];