@d3plus/color 3.0.16 → 3.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 D3plus
+
+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

@@ -1,5 +1,8 @@
 # @d3plus/color
-  
+
+[![NPM version](https://img.shields.io/npm/v/@d3plus/color.svg)](https://www.npmjs.com/package/@d3plus/color)
+[![codecov](https://codecov.io/gh/d3plus/d3plus/graph/badge.svg?flag=color)](https://codecov.io/gh/d3plus/d3plus/flags)
+
 Color functions that extent the ability of d3-color.
 
 ## Installing
@@ -7,10 +10,10 @@ Color functions that extent the ability of d3-color.
 If using npm, `npm install @d3plus/color`. Otherwise, you can download the [latest release from GitHub](https://github.com/d3plus/d3plus/releases/latest) or load from a [CDN](https://cdn.jsdelivr.net/npm/@d3plus/color).
 
 ```js
-import modules from "@d3plus/color";
+import {*} from "@d3plus/color";
 ```
 
-In vanilla JavaScript, a `d3plus` global is exported from the pre-bundled version:
+In a vanilla environment, a `d3plus` global is exported from the pre-bundled version:
 
 ```html
 <script src="https://cdn.jsdelivr.net/npm/@d3plus/color"></script>
@@ -21,90 +24,215 @@ In vanilla JavaScript, a `d3plus` global is exported from the pre-bundled versio
 
 ## Examples
 
-Live examples can be found on [d3plus.org](https://d3plus.org/), which includes a collection of example visualizations using @d3plus/react.
+Live examples can be found on [d3plus.org](https://d3plus.org/), which includes a collection of example visualizations using [@d3plus/react](https://github.com/d3plus/d3plus/tree/main/packages/react).
 
 ## API Reference
 
-##### 
-* [colorAdd](#colorAdd) - Adds two colors together.
-* [colorAssign](#colorAssign) - Assigns a color to a value using a predefined set of defaults.
-* [colorContrast](#colorContrast) - A set of default color values used when assigning colors based on data.
-* [colorLegible](#colorLegible) - Darkens a color so that it will appear legible on a white background.
-* [colorLighter](#colorLighter) - Similar to d3.color.brighter, except that this also reduces saturation so that colors don't appear neon.
-* [colorSubtract](#colorSubtract) - Subtracts one color from another.
+| Functions | Description |
+| --- | --- |
+| [`colorAdd`](#coloradd) | Adds two colors together. |
+| [`colorAssign`](#colorassign) | Assigns a color to a value using a predefined set of defaults. |
+| [`colorContrast`](#colorcontrast) | A set of default color values used when assigning colors based on data. |
+| [`colorLegible`](#colorlegible) | Darkens a color so that it will appear legible on a white background. |
+| [`colorLighter`](#colorlighter) | Similar to d3.color.brighter, except that this also reduces saturation so that colors don't appear neon. |
+| [`colorSubtract`](#colorsubtract) | Subtracts one color from another. |
+
+| Variables | Description |
+| --- | --- |
+| [`colorDefaults`](#colordefaults) | A set of default color values used when assigning colors based on data. |
+
+| Interfaces | Description |
+| --- | --- |
+| [`ColorDefaults`](#colordefaults) |  |
+
+## Functions
+
+<a id="coloradd"></a>
 
-##### 
-* [colorDefaults](#colorDefaults) - A set of default color values used when assigning colors based on data.
+### colorAdd()
 
----
+> **colorAdd**(`c1`: `string`, `c2`: `string`, `o1?`: `number`, `o2?`: `number`): `string`
 
-<a name="colorAdd"></a>
-#### d3plus.**colorAdd**(c1, c2, [o1], [o2]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/color/src/add.js#L3)
+Defined in: [add.ts:10](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/color/src/add.ts#L10)
 
 Adds two colors together.
 
+#### Parameters
+
+| Parameter | Type | Default | Description |
+| ------ | ------ | ------ | ------ |
+| `c1` | `string` | *required* | The first color, a valid CSS color string. |
+| `c2` | `string` | *required* | The second color, also a valid CSS color string. |
+| `o1` | `number` | `1` | Value from 0 to 1 of the first color's opacity. |
+| `o2` | `number` | `1` | Value from 0 to 1 of the first color's opacity. |
+
+#### Returns
+
+`string`
+
+***
+
+<a id="colorassign"></a>
 
-This is a global function
+### colorAssign()
 
----
+> **colorAssign**(`c`: `string` \| `boolean` \| `null` \| `undefined`, `u?`: `Partial`\<[`ColorDefaults`](#colordefaults)\>): `string`
 
-<a name="colorAssign"></a>
-#### d3plus.**colorAssign**(c, [u]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/color/src/assign.js#L4)
+Defined in: [assign.ts:9](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/color/src/assign.ts#L9)
 
 Assigns a color to a value using a predefined set of defaults.
 
+#### Parameters
 
-This is a global function
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `c` | `string` \| `boolean` \| `null` \| *required* | A valid CSS color string. |
+| `u` | `Partial`\<[`ColorDefaults`](#colordefaults)\> | An object containing overrides of the default colors. |
 
----
+#### Returns
 
-<a name="colorContrast"></a>
-#### d3plus.**colorContrast**(c, [u]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/color/src/contrast.js#L4)
+`string`
+
+***
+
+<a id="colorcontrast"></a>
+
+### colorContrast()
+
+> **colorContrast**(`c`: `string`, `u?`: `Partial`\<[`ColorDefaults`](#colordefaults)\>): `string`
+
+Defined in: [contrast.ts:9](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/color/src/contrast.ts#L9)
 
 A set of default color values used when assigning colors based on data.
 
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `c` | `string` | A valid CSS color string. |
+| `u` | `Partial`\<[`ColorDefaults`](#colordefaults)\> | An object containing overrides of the default colors. |
+
+#### Returns
+
+`string`
+
+***
+
+<a id="colorlegible"></a>
 
-This is a global function
+### colorLegible()
 
----
+> **colorLegible**(`c`: `string`): `string`
 
-<a name="colorLegible"></a>
-#### d3plus.**colorLegible**(c) [<>](https://github.com/d3plus/d3plus/blob/main/packages/color/src/legible.js#L3)
+Defined in: [legible.ts:7](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/color/src/legible.ts#L7)
 
 Darkens a color so that it will appear legible on a white background.
 
+#### Parameters
 
-This is a global function
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `c` | `string` | A valid CSS color string. |
 
----
+#### Returns
 
-<a name="colorLighter"></a>
-#### d3plus.**colorLighter**(c, [i]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/color/src/lighter.js#L3)
+`string`
+
+***
+
+<a id="colorlighter"></a>
+
+### colorLighter()
+
+> **colorLighter**(`c`: `string`, `i?`: `number`): `string`
+
+Defined in: [lighter.ts:8](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/color/src/lighter.ts#L8)
 
 Similar to d3.color.brighter, except that this also reduces saturation so that colors don't appear neon.
 
+#### Parameters
+
+| Parameter | Type | Default | Description |
+| ------ | ------ | ------ | ------ |
+| `c` | `string` | *required* | A valid CSS color string. |
+| `i` | `number` | `0.5` | Strength of the lightening effect, from 0 to 1. |
 
-This is a global function
+#### Returns
 
----
+`string`
 
-<a name="colorSubtract"></a>
-#### d3plus.**colorSubtract**(c1, c2, [o1], [o2]) [<>](https://github.com/d3plus/d3plus/blob/main/packages/color/src/subtract.js#L3)
+***
+
+<a id="colorsubtract"></a>
+
+### colorSubtract()
+
+> **colorSubtract**(`c1`: `string`, `c2`: `string`, `o1?`: `number`, `o2?`: `number`): `string`
+
+Defined in: [subtract.ts:10](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/color/src/subtract.ts#L10)
 
 Subtracts one color from another.
 
+#### Parameters
+
+| Parameter | Type | Default | Description |
+| ------ | ------ | ------ | ------ |
+| `c1` | `string` | *required* | The base color, a valid CSS color string. |
+| `c2` | `string` | *required* | The color to remove from the base color, also a valid CSS color string. |
+| `o1` | `number` | `1` | Value from 0 to 1 of the first color's opacity. |
+| `o2` | `number` | `1` | Value from 0 to 1 of the first color's opacity. |
 
-This is a global function
+#### Returns
 
----
+`string`
 
-<a name="colorDefaults"></a>
-#### **colorDefaults** [<>](https://github.com/d3plus/d3plus/blob/main/packages/color/src/defaults.js#L5)
+## Variables
+
+<a id="colordefaults-1"></a>
+
+### colorDefaults
+
+> `const` **colorDefaults**: [`ColorDefaults`](#colordefaults)
+
+Defined in: [defaults.ts:37](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/color/src/defaults.ts#L37)
 
 A set of default color values used when assigning colors based on data.
 
+#### Default Value
+
+```
+{
+  dark: "#495057",
+  light: "#f8f9fa",
+  missing: "#ced4da",
+  off: "#c92a2a",
+  on: "#2b8a3e",
+  scale: d3.scaleOrdinal().range([
+    "#364fc7", "#fab005", "#c92a2a",
+    "#2b8a3e", "#fd7e14", "#862e9c",
+    "#15aabf", "#e64980", "#82c91e",
+    "#74c0fc", "#faa2c1", "#c0eb75",
+    "#b197fc", "#c5f6fa", "#ffe8cc",
+    "#d3f9d8", "#f3d9fa", "#ffe3e3"
+  ])
+}
+```
+
+## Interfaces
+
+<a id="colordefaults"></a>
+
+### ColorDefaults
 
-This is a global namespace
+Defined in: [defaults.ts:6](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/color/src/defaults.ts#L6)
 
----
+#### Properties
 
+| Property | Type | Defined in |
+| ------ | ------ | ------ |
+| <a id="property-dark"></a> `dark` | `string` | [defaults.ts:7](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/color/src/defaults.ts#L7) |
+| <a id="property-light"></a> `light` | `string` | [defaults.ts:8](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/color/src/defaults.ts#L8) |
+| <a id="property-missing"></a> `missing` | `string` | [defaults.ts:9](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/color/src/defaults.ts#L9) |
+| <a id="property-off"></a> `off` | `string` | [defaults.ts:10](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/color/src/defaults.ts#L10) |
+| <a id="property-on"></a> `on` | `string` | [defaults.ts:11](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/color/src/defaults.ts#L11) |
+| <a id="property-scale"></a> `scale` | `ScaleOrdinal`\<`string`, `string`\> | [defaults.ts:12](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/color/src/defaults.ts#L12) |

package/es/src/add.js

@@ -1,22 +1,18 @@
 import { hsl } from "d3-color";
 /**
-    @function colorAdd
-    @desc Adds two colors together.
-    @param {String} c1 The first color, a valid CSS color string.
-    @param {String} c2 The second color, also a valid CSS color string.
-    @param {String} [o1 = 1] Value from 0 to 1 of the first color's opacity.
-    @param {String} [o2 = 1] Value from 0 to 1 of the first color's opacity.
-    @returns {String}
+    Adds two colors together.
+    @param c1 The first color, a valid CSS color string.
+    @param c2 The second color, also a valid CSS color string.
+    @param o1 Value from 0 to 1 of the first color's opacity.
+    @param o2 Value from 0 to 1 of the first color's opacity.
 */ export default function(c1, c2) {
     var o1 = arguments.length > 2 && arguments[2] !== void 0 ? arguments[2] : 1, o2 = arguments.length > 3 && arguments[3] !== void 0 ? arguments[3] : 1;
-    c1 = hsl(c1);
-    c2 = hsl(c2);
-    var d = Math.abs(c2.h * o2 - c1.h * o1);
+    var hsl1 = hsl(c1);
+    var hsl2 = hsl(c2);
+    var d = Math.abs(hsl2.h * o2 - hsl1.h * o1);
     if (d > 180) d -= 360;
-    var h = (Math.min(c1.h, c2.h) + d / 2) % 360;
-    var l = c1.l + (c2.l * o2 - c1.l * o1) / 2, s = c1.s + (c2.s * o2 - c1.s * o1) / 2;
-    // a = o1 + (o2 - o1) / 2;
+    var h = (Math.min(hsl1.h, hsl2.h) + d / 2) % 360;
+    var l = hsl1.l + (hsl2.l * o2 - hsl1.l * o1) / 2, s = hsl1.s + (hsl2.s * o2 - hsl1.s * o1) / 2;
     if (h < 0) h += 360;
     return hsl("hsl(".concat(h, ",").concat(s * 100, "%,").concat(l * 100, "%)")).toString();
-// return hsl(`hsl(${h},${s * 100}%,${l * 100}%,${a})`).toString();
 }

package/es/src/assign.js

@@ -1,22 +1,22 @@
 import { color } from "d3-color";
-import { getColor } from "./defaults.js";
+import defaults from "./defaults.js";
 /**
-    @function colorAssign
-    @desc Assigns a color to a value using a predefined set of defaults.
-    @param {String} c A valid CSS color string.
-    @param {Object} [u = defaults] An object containing overrides of the default colors.
-    @returns {String}
+    Assigns a color to a value using a predefined set of defaults.
+    @param c A valid CSS color string.
+    @param u An object containing overrides of the default colors.
 */ export default function(c) {
     var u = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : {};
     // If the value is null or undefined, set to grey.
     if ([
         null,
-        void 0
-    ].indexOf(c) >= 0) return getColor("missing", u);
-    else if (c === true) return getColor("on", u);
-    else if (c === false) return getColor("off", u);
-    var p = color(c);
-    // If the value is not a valid color string, use the color scale.
-    if (!p) return getColor("scale", u)(c);
-    return c.toString();
+        undefined
+    ].indexOf(c) >= 0) return u["missing"] || defaults["missing"];
+    else if (c === true) return u["on"] || defaults["on"];
+    else if (c === false) return u["off"] || defaults["off"];
+    else {
+        var p = color(c);
+        // If the value is not a valid color string, use the color scale.
+        if (!p) return (u["scale"] || defaults["scale"])(c);
+        return c;
+    }
 }

package/es/src/contrast.js

@@ -1,14 +1,12 @@
-import { getColor } from "./defaults.js";
+import defaults from "./defaults.js";
 import { rgb } from "d3-color";
 /**
-    @function colorContrast
-    @desc A set of default color values used when assigning colors based on data.
-    @param {String} c A valid CSS color string.
-    @param {Object} [u = defaults] An object containing overrides of the default colors.
-    @returns {String}
+    A set of default color values used when assigning colors based on data.
+    @param c A valid CSS color string.
+    @param u An object containing overrides of the default colors.
 */ export default function(c) {
     var u = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : {};
-    c = rgb(c);
-    var yiq = (c.r * 299 + c.g * 587 + c.b * 114) / 1000;
-    return yiq >= 128 ? getColor("dark", u) : getColor("light", u);
+    var rgbColor = rgb(c);
+    var yiq = (rgbColor.r * 299 + rgbColor.g * 587 + rgbColor.b * 114) / 1000;
+    return yiq >= 128 ? u["dark"] || defaults["dark"] : u["light"] || defaults["light"];
 }

package/es/src/defaults.js

@@ -1,10 +1,29 @@
 import { scaleOrdinal } from "d3-scale";
+// @ts-ignore
 import pkg from "open-color/open-color.js";
 var openColor = pkg.theme;
 /**
-    @namespace {Object} colorDefaults
-    @desc A set of default color values used when assigning colors based on data.
-*/ var defaults = {
+ * A set of default color values used when assigning colors based on data.
+ *
+ * @defaultValue
+ * ```
+ * {
+ *   dark: "#495057",
+ *   light: "#f8f9fa",
+ *   missing: "#ced4da",
+ *   off: "#c92a2a",
+ *   on: "#2b8a3e",
+ *   scale: d3.scaleOrdinal().range([
+ *     "#364fc7", "#fab005", "#c92a2a",
+ *     "#2b8a3e", "#fd7e14", "#862e9c",
+ *     "#15aabf", "#e64980", "#82c91e",
+ *     "#74c0fc", "#faa2c1", "#c0eb75",
+ *     "#b197fc", "#c5f6fa", "#ffe8cc",
+ *     "#d3f9d8", "#f3d9fa", "#ffe3e3"
+ *   ])
+ * }
+ * ```
+ */ var defaults = {
     dark: openColor.colors.gray[700],
     light: openColor.colors.gray[50],
     missing: openColor.colors.gray[400],
@@ -31,12 +50,4 @@ var openColor = pkg.theme;
         openColor.colors.red[100]
     ])
 };
-/**
-    Returns a color based on a key, whether it is present in a user supplied object or in the default object.
-    @returns {String}
-    @private
-*/ export function getColor(k) {
-    var u = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : {};
-    return k in u ? u[k] : k in defaults ? defaults[k] : defaults.missing;
-}
 export default defaults;

package/es/src/legible.js

@@ -1,14 +1,12 @@
 import { hsl } from "d3-color";
 /**
-    @function colorLegible
-    @desc Darkens a color so that it will appear legible on a white background.
-    @param {String} c A valid CSS color string.
-    @returns {String}
+    Darkens a color so that it will appear legible on a white background.
+    @param c A valid CSS color string.
 */ export default function(c) {
-    c = hsl(c);
-    if (c.l > 0.45) {
-        if (c.s > 0.8) c.s = 0.8;
-        c.l = 0.45;
+    var hslColor = hsl(c);
+    if (hslColor.l > 0.45) {
+        if (hslColor.s > 0.8) hslColor.s = 0.8;
+        hslColor.l = 0.45;
     }
-    return c.toString();
+    return hslColor.toString();
 }

package/es/src/lighter.js

@@ -1,15 +1,13 @@
 import { hsl } from "d3-color";
 /**
-    @function colorLighter
-    @desc Similar to d3.color.brighter, except that this also reduces saturation so that colors don't appear neon.
-    @param {String} c A valid CSS color string.
-    @param {String} [i = 0.5] A value from 0 to 1 dictating the strength of the function.
-    @returns {String}
+    Similar to d3.color.brighter, except that this also reduces saturation so that colors don't appear neon.
+    @param c A valid CSS color string.
+    @param i Strength of the lightening effect, from 0 to 1.
 */ export default function(c) {
     var i = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : 0.5;
-    c = hsl(c);
-    i *= 1 - c.l;
-    c.l += i;
-    c.s -= i;
-    return c.toString();
+    var hslColor = hsl(c);
+    i *= 1 - hslColor.l;
+    hslColor.l += i;
+    hslColor.s -= i;
+    return hslColor.toString();
 }

package/es/src/subtract.js

@@ -1,20 +1,18 @@
 import { hsl } from "d3-color";
 /**
-    @function colorSubtract
-    @desc Subtracts one color from another.
-    @param {String} c1 The base color, a valid CSS color string.
-    @param {String} c2 The color to remove from the base color, also a valid CSS color string.
-    @param {String} [o1 = 1] Value from 0 to 1 of the first color's opacity.
-    @param {String} [o2 = 1] Value from 0 to 1 of the first color's opacity.
-    @returns {String}
+    Subtracts one color from another.
+    @param c1 The base color, a valid CSS color string.
+    @param c2 The color to remove from the base color, also a valid CSS color string.
+    @param o1 Value from 0 to 1 of the first color's opacity.
+    @param o2 Value from 0 to 1 of the first color's opacity.
 */ export default function(c1, c2) {
     var o1 = arguments.length > 2 && arguments[2] !== void 0 ? arguments[2] : 1, o2 = arguments.length > 3 && arguments[3] !== void 0 ? arguments[3] : 1;
-    c1 = hsl(c1);
-    c2 = hsl(c2);
-    var d = c2.h * o2 - c1.h * o1;
+    var hsl1 = hsl(c1);
+    var hsl2 = hsl(c2);
+    var d = hsl2.h * o2 - hsl1.h * o1;
     if (Math.abs(d) > 180) d -= 360;
-    var h = (c1.h - d) % 360;
-    var l = c1.l - (c2.l * o2 - c1.l * o1) / 2, s = c1.s - (c2.s * o2 - c1.s * o1) / 2;
+    var h = (hsl1.h - d) % 360;
+    var l = hsl1.l - (hsl2.l * o2 - hsl1.l * o1) / 2, s = hsl1.s - (hsl2.s * o2 - hsl1.s * o1) / 2;
     // a = o1 - (o2 - o1) / 2;
     if (h < 0) h += 360;
     return hsl("hsl(".concat(h, ",").concat(s * 100, "%,").concat(l * 100, "%)")).toString();

package/package.json

@@ -1,18 +1,25 @@
 {
   "name": "@d3plus/color",
-  "version": "3.0.16",
+  "version": "3.1.1",
   "description": "Color functions that extent the ability of d3-color.",
   "license": "MIT",
   "type": "module",
-  "exports": "./es/index.js",
+  "types": "./types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./types/index.d.ts",
+      "default": "./es/index.js"
+    }
+  },
   "browser": "./umd/d3plus-color.full.js",
   "engines": {
-    "node": ">=18"
+    "node": ">=20"
   },
   "sideEffects": false,
   "files": [
     "umd",
-    "es"
+    "es",
+    "types"
   ],
   "homepage": "https://d3plus.org",
   "repository": {
@@ -27,15 +34,17 @@
     "data",
     "visualization"
   ],
-  "scripts": {
-    "build:esm": "node ../../scripts/build-esm.js",
-    "build:umd": "node ../../scripts/build-umd.js",
-    "dev": "node ../../scripts/dev.js",
-    "test": "eslint index.js src/**/*.js && eslint --global=it test && mocha 'test/**/*-test.js'"
-  },
   "dependencies": {
     "d3-color": "^3.1.0",
     "d3-scale": "^4.0.2",
     "open-color": "^1.9.1"
+  },
+  "scripts": {
+    "build:esm": "node ../../scripts/build-esm.js",
+    "build:types": "tsc",
+    "build:umd": "node ../../scripts/build-umd.js",
+    "dev": "node ../../scripts/dev.js",
+    "test": "eslint index.ts src/**/*.ts && eslint --global=it test && mocha 'test/**/*-test.js'",
+    "test:coverage": "c8 -r text -r lcov --src src mocha 'test/**/*-test.js'"
   }
 }

package/types/index.d.ts

@@ -0,0 +1,8 @@
+export { default as colorAdd } from "./src/add.js";
+export { default as colorAssign } from "./src/assign.js";
+export { default as colorContrast } from "./src/contrast.js";
+export { default as colorDefaults } from "./src/defaults.js";
+export { default as colorLegible } from "./src/legible.js";
+export { default as colorLighter } from "./src/lighter.js";
+export { default as colorSubtract } from "./src/subtract.js";
+export type { ColorDefaults } from "./src/defaults.js";

package/types/src/add.d.ts

@@ -0,0 +1,8 @@
+/**
+    Adds two colors together.
+    @param c1 The first color, a valid CSS color string.
+    @param c2 The second color, also a valid CSS color string.
+    @param o1 Value from 0 to 1 of the first color's opacity.
+    @param o2 Value from 0 to 1 of the first color's opacity.
+*/
+export default function (c1: string, c2: string, o1?: number, o2?: number): string;

package/types/src/assign.d.ts

@@ -0,0 +1,7 @@
+import { ColorDefaults } from "./defaults.js";
+/**
+    Assigns a color to a value using a predefined set of defaults.
+    @param c A valid CSS color string.
+    @param u An object containing overrides of the default colors.
+*/
+export default function (c: string | boolean | null | undefined, u?: Partial<ColorDefaults>): string;

package/types/src/contrast.d.ts

@@ -0,0 +1,7 @@
+import { ColorDefaults } from "./defaults.js";
+/**
+    A set of default color values used when assigning colors based on data.
+    @param c A valid CSS color string.
+    @param u An object containing overrides of the default colors.
+*/
+export default function (c: string, u?: Partial<ColorDefaults>): string;

package/types/src/defaults.d.ts

@@ -0,0 +1,33 @@
+import { ScaleOrdinal } from "d3-scale";
+export interface ColorDefaults {
+    dark: string;
+    light: string;
+    missing: string;
+    off: string;
+    on: string;
+    scale: ScaleOrdinal<string, string>;
+}
+/**
+ * A set of default color values used when assigning colors based on data.
+ *
+ * @defaultValue
+ * ```
+ * {
+ *   dark: "#495057",
+ *   light: "#f8f9fa",
+ *   missing: "#ced4da",
+ *   off: "#c92a2a",
+ *   on: "#2b8a3e",
+ *   scale: d3.scaleOrdinal().range([
+ *     "#364fc7", "#fab005", "#c92a2a",
+ *     "#2b8a3e", "#fd7e14", "#862e9c",
+ *     "#15aabf", "#e64980", "#82c91e",
+ *     "#74c0fc", "#faa2c1", "#c0eb75",
+ *     "#b197fc", "#c5f6fa", "#ffe8cc",
+ *     "#d3f9d8", "#f3d9fa", "#ffe3e3"
+ *   ])
+ * }
+ * ```
+ */
+declare const defaults: ColorDefaults;
+export default defaults;