saturon 0.2.1 → 0.2.3

package/LICENSE

@@ -1,7 +1,7 @@
-Copyright © 2025 Ganemede Labs
-
-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.
+Copyright © 2025 Ganemede Labs
+
+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,119 +1,121 @@
-# Saturon
-
-![npm](https://img.shields.io/npm/v/saturon)
-![npm](https://img.shields.io/npm/dw/saturon)
-![License](https://img.shields.io/npm/l/saturon)
-
-A runtime-extensible JavaScript library for parsing, converting, and manipulating colors with full CSS spec support.
-
-## 📋 Table of Contents
-
-- [Features](#-features)
-- [Installation](#-installation)
-- [Usage](#-usage)
-- [Examples](#-examples)
-- [Documentation](#-documentation)
-- [License](#-license)
-- [Contact](#-contact)
-
-## ✨ Features
-
-- **Full CSS Color 4/5 Parsing**
-- Infinite nested color functions (e.g. `color-mix(...)` inside `light-dark(...)`)
-- Converts between all modern color spaces (OKLab, Display-P3, Rec.2020, etc.)
-- High-precision color math for serious colorimetry
-- Powerful plugin system for custom color spaces and functions
-- Supports complex color syntaxes like `color(from hsl(240 none calc(-infinity) / 0.5) display-p3 r calc(g + b) 100 / alpha)`
-
-## 🔧 Installation
-
-```bash
-npm install saturon
-```
-
-## 🚀 Usage
-
-```js
-import { Color } from "saturon";
-
-// Parse any CSS color string
-const color = Color.from("#1481b8ff");
-
-// Access coordinates
-console.log(color.toArray()); // → [20, 129, 184, 1]
-
-// Convert to another format
-console.log(color.to("oklch", { units: true })); // → "oklch(0.57368 0.12258 238.41345deg)"
-
-// Access values in another color space
-console.log(color.in("lab").toObject({ precision: 1 })); // → { l: 50.5, a: -13.9, b: -37.6, alpha: 1 }
-
-// Modify components
-const modified = color.in("hsl").with({ l: (l) => l * 1.2 });
-console.log(modified.toString({ legacy: true })); // → "hsl(200, 80%, 48%)"
-```
-
-## 💡 Examples
-
-### Converting Colors
-
-```js
-const color = Color.from("hsl(337 100% 60%)");
-console.log(color.to("rgb")); // → rgb(255 51 129)
-console.log(color.to("hex-color")); // → #ff3381
-```
-
-### Manipulating Components
-
-```js
-const color = Color.from("hwb(255 7% 1%)");
-const hwb = color.with({ h: 100, b: (b) => b * 20 });
-console.log(hwb.toString()); // → hwb(100 7 20)
-```
-
-### Mixing Colors
-
-```js
-const red = Color.from("hsl(0, 100%, 50%)");
-const mixed = red.mix("hsl(120, 100%, 50%)");
-console.log(mixed.toString()); // → hsl(60 100 50)
-```
-
-### New Named Color Registration
-
-```js
-registerNamedColor("sunsetblush", [255, 94, 77]);
-const rgb = Color.from("rgb(255, 94, 77)");
-console.log(rgb.to("named-color")); // → sunsetblush
-```
-
-### New Color Function Registration
-
-```js
-const converter = {
-    components: {
-        i: { index: 0, value: [0, 1] },
-        ct: { index: 1, value: [-1, 1] },
-        cp: { index: 2, value: [-1, 1] },
-    },
-    bridge: "rgb",
-    toBridge: (ictcp: number[]) => [/* r, g, b */],
-    fromBridge: (rgb: number[]) => [/* i, ct, cp */],
-};
-
-registerColorFunction("ictcp", converter);
-const ictcp = Color.from("ictcp(0.2 0.2 -0.1)");
-console.log(ictcp.to("rgb")); // → rgb(6 7 90)
-```
-
-## 📚 Documentation
-
-Full documentation is available at [saturon.js.org](https://saturon.js.org).
-
-## 📜 License
-
-This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
-
-## 📧 Contact
-
-For inquiries or more information, you can reach out to us at [ganemedelabs@gmail.com](mailto:ganemedelabs@gmail.com).
+# Saturon
+
+![Version](https://img.shields.io/npm/v/saturon)
+![Downloads](https://img.shields.io/npm/dw/saturon)
+![License](https://img.shields.io/npm/l/saturon)
+
+A runtime-extensible JavaScript library for parsing, converting, and manipulating colors with full CSS spec support.
+
+## 📋 Table of Contents
+
+- [Features](#-features)
+- [Installation](#-installation)
+- [Usage](#-usage)
+- [Examples](#-examples)
+- [Documentation](#-documentation)
+- [License](#-license)
+- [Contact](#-contact)
+
+## ✨ Features
+
+- **Full CSS Color 4/5 Parsing**
+- Infinite nested color functions (e.g. `color-mix(...)` inside `light-dark(...)`)
+- Converts between all modern color spaces (OKLab, Display-P3, Rec.2020, etc.)
+- High-precision color math for serious colorimetry
+- Powerful plugin system for custom color spaces and functions
+- Supports complex color syntaxes like `color(from hsl(240 none calc(-infinity) / 0.5) display-p3 r calc(g + b) 100 / alpha)`
+
+## 🔧 Installation
+
+```bash
+npm install saturon
+# or
+yarn add saturon
+```
+
+## 🚀 Usage
+
+```js
+import { Color } from "saturon";
+
+// Parse any CSS color string
+const color = Color.from("#1481b8ff");
+
+// Access coordinates
+console.log(color.toArray()); // → [20, 129, 184, 1]
+
+// Convert to another format
+console.log(color.to("oklch", { units: true })); // → "oklch(0.57368 0.12258 238.41345deg)"
+
+// Access values in another color space
+console.log(color.in("lab").toObject({ precision: 1 })); // → { l: 50.5, a: -13.9, b: -37.6, alpha: 1 }
+
+// Modify components
+const modified = color.in("hsl").with({ l: (l) => l * 1.2 });
+console.log(modified.toString({ legacy: true })); // → "hsl(200, 80%, 48%)"
+```
+
+## 💡 Examples
+
+### Converting Colors
+
+```js
+const color = Color.from("hsl(337 100% 60%)");
+console.log(color.to("rgb")); // → rgb(255 51 129)
+console.log(color.to("hex-color")); // → #ff3381
+```
+
+### Manipulating Components
+
+```js
+const color = Color.from("hwb(255 7% 1%)");
+const hwb = color.with({ h: 100, b: (b) => b * 20 });
+console.log(hwb.toString()); // → hwb(100 7 20)
+```
+
+### Mixing Colors
+
+```js
+const red = Color.from("hsl(0, 100%, 50%)");
+const mixed = red.mix("hsl(120, 100%, 50%)");
+console.log(mixed.toString()); // → hsl(60 100 50)
+```
+
+### New Named Color Registration
+
+```js
+registerNamedColor("sunsetblush", [255, 94, 77]);
+const rgb = Color.from("rgb(255, 94, 77)");
+console.log(rgb.to("named-color")); // → sunsetblush
+```
+
+### New Color Function Registration
+
+```js
+const converter = {
+    components: {
+        i: { index: 0, value: [0, 1] },
+        ct: { index: 1, value: [-1, 1] },
+        cp: { index: 2, value: [-1, 1] },
+    },
+    bridge: "rgb",
+    toBridge: (ictcp: number[]) => [/* r, g, b */],
+    fromBridge: (rgb: number[]) => [/* i, ct, cp */],
+};
+
+registerColorFunction("ictcp", converter);
+const ictcp = Color.from("ictcp(0.2 0.2 -0.1)");
+console.log(ictcp.to("rgb")); // → rgb(6 7 90)
+```
+
+## 📚 Documentation
+
+Full documentation is available at [saturon.js.org](https://saturon.js.org).
+
+## 📜 License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+## 📧 Contact
+
+For inquiries or more information, you can reach out to us at [ganemedelabs@gmail.com](mailto:ganemedelabs@gmail.com).

package/dist/Color.d.ts

@@ -1,4 +1,4 @@
-import type { Component, MixOptions, ColorType, OutputType, FormattingOptions, NamedColor, ColorSpace, FitMethod, ColorModel, RandomOptions, GetOptions } from "./types.js";
+import type { Component, MixOptions, ColorType, OutputType, FormattingOptions, NamedColor, ColorSpace, FitMethod, ColorModel, RandomOptions, ComponentOptions } from "./types.js";
 /**
  * The `Color` class represents a dynamic CSS color object, allowing for the manipulation
  * and retrieval of colors in various formats (e.g., RGB, HEX, HSL).
@@ -82,7 +82,7 @@ export declare class Color<M extends ColorModel = ColorModel> {
      * @returns An object mapping each component (and alpha) to its numeric value.
      * @throws If the model has no defined components.
      */
-    toObject(options?: GetOptions): { [key in Component<M>]: number; };
+    toObject(options?: ComponentOptions): { [key in Component<M>]: number; };
     /**
      * Returns the color as an array of component values, optionally normalized and fitted.
      *
@@ -90,9 +90,9 @@ export declare class Color<M extends ColorModel = ColorModel> {
      * @returns An array of normalized color components and alpha.
      * @throws If the model has no defined components.
      */
-    toArray(options?: GetOptions): number[];
+    toArray(options?: ComponentOptions): number[];
     /**
-     * Returns a new `Color` instance with updated or replaced component values.
+     * Creates a new Color instance with modified component values.
      *
      * This method supports several flexible update styles:
      *
@@ -131,12 +131,14 @@ export declare class Color<M extends ColorModel = ColorModel> {
      * color.with(({ r, g, b }) => [r * 0.5, g * 0.5, b * 0.5, 1]);
      * ```
      *
-     * @param values - Either:
-     * - a partial object of component values,
-     * - an updater function returning an object or array,
-     * - or an array of new coordinates.
-     * @returns A new `Color` instance with updated values.
-     * @throws If the color model has no defined components.
+     * @template M - The color model type
+     * @param values - The new component values to apply. Can be:
+     *   - A partial object mapping component names to numbers or update functions
+     *   - A function that receives current components and returns partial updates or an array of values
+     *   - An array of new values corresponding to component indices
+     * @param normalize - Whether to normalize component values to their valid ranges. Defaults to `true`.
+     *   When `false`, values are not clamped or validated against their ranges.
+     * @returns A new Color instance with the updated component values
      */
     with(values: Partial<{
         [K in Component<M> | "alpha"]: number | ((prev: number) => number);
@@ -144,7 +146,7 @@ export declare class Color<M extends ColorModel = ColorModel> {
         [K in Component<M> | "alpha"]: number;
     }) => Partial<{
         [K in Component<M> | "alpha"]: number;
-    }> | (number | undefined)[]) | (number | undefined)[]): Color<M>;
+    }> | (number | undefined)[]) | (number | undefined)[], normalize?: boolean): Color<M>;
     /**
      * Mixes this color with another by a specified amount.
      *
@@ -163,6 +165,13 @@ export declare class Color<M extends ColorModel = ColorModel> {
      * @throws If the gamut is unsupported.
      */
     within(gamut: ColorSpace, method?: FitMethod): Color<M>;
+    /**
+     * Creates a new Color instance with values fitted to the color model's gamut.
+     *
+     * @param options - Configuration options for fitting
+     * @returns A new Color instance with fitted values
+     */
+    fit(options?: ComponentOptions): Color<M>;
     /**
      * Calculates the WCAG 2.1 contrast ratio between this color and another.
      *