@electrovir/color 0.0.0

package/LICENSE-CC0

@@ -0,0 +1,121 @@
+CC0 1.0 Universal
+
+Creative Commons Legal Code
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+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:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. 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
+vii. 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.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. 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.
+ c. 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.
+ d. 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.

package/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 electrovir
+
+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,50 @@
+# @electrovir/color
+
+A color package that wraps [the `culori` package](https://www.npmjs.com/package/culori) with an _extremely_ simple API for color string parsing and color space/model conversion. It is primarily built for https://electrovir.github.io/color-picker-app.
+
+-   Conversion examples: https://electrovir.github.io/color
+-   Reference docs: https://electrovir.github.io/color/docs
+
+## Install
+
+```sh
+npm i @electrovir/color
+```
+
+## Usage
+
+All functionality is accessed through the [`Color`](https://electrovir.github.io/color/docs/classes/Color.html) class:
+
+<!-- example-link: src/readme-examples/color.example.ts -->
+
+```TypeScript
+import {Color} from '@electrovir/color';
+
+/** Create a new color instance by parsing any valid CSS color string. */
+const color = new Color('#123');
+
+/** Update an individual color format's coordinate */
+color.set({
+    hsl: {
+        h: 100,
+    },
+});
+
+/** Access the color values in multiple formats. */
+console.info(color.hex); // #1c3311
+console.info(color.rgb); // {r: 28, g: 51, b: 17}
+console.info(color.lab); // {l: 18.6, a: -15, b: 18}
+
+/** Express the color value as a valid CSS string. */
+console.info(color.toCss().hsl); // hsl(100 50 13.3)
+```
+
+### Supported color formats / spaces
+
+-   [RGB](https://developer.mozilla.org/docs/Web/CSS/color_value/rgb)
+-   [HSL](https://developer.mozilla.org/docs/Web/CSS/color_value/hsl)
+-   [HWB](https://developer.mozilla.org/docs/Web/CSS/color_value/hwb)
+-   [LAB](https://developer.mozilla.org/docs/Web/CSS/color_value/lab)
+-   [LCH](https://developer.mozilla.org/docs/Web/CSS/color_value/lch)
+-   [Oklab](https://developer.mozilla.org/docs/Web/CSS/color_value/oklab)
+-   [Oklch](https://developer.mozilla.org/docs/Web/CSS/color_value/oklch)

package/dist/color-formats.d.ts

@@ -0,0 +1,254 @@
+import { type PartialWithUndefined, type UnionToIntersection, type Values } from '@augment-vir/common';
+/**
+ * A hex color string.
+ *
+ * @category Internal
+ */
+export type HexColor = `#${string}`;
+/**
+ * An individual definition for a single color format coordinate (like `h` or `s` or `r` or `g`).
+ *
+ * @category Internal
+ */
+export type ColorCoordinateDefinition = {
+    min: number;
+    max: number;
+} & PartialWithUndefined<{
+    /**
+     * The number of digits to round this coordinate to.
+     *
+     * @default 0
+     */
+    digits?: number | undefined;
+    /**
+     * A factor to multiple the values in the `Color` class by.
+     *
+     * @default 1
+     */
+    factor?: number | undefined;
+    suffix?: string;
+}>;
+/**
+ * A single color format definition.
+ *
+ * @category Internal
+ */
+export type ColorFormatDefinition<ColorSpace extends string = string> = {
+    coords: Record<string, ColorCoordinateDefinition>;
+    /** This name for this color to be used in `Colorjs.to()`. Defaults to the color format key. */
+    colorSpace: ColorSpace;
+};
+/**
+ * All raw supported color formats.
+ *
+ * @category Internal
+ */
+export declare const rawColorFormats: {
+    readonly rgb: {
+        readonly coords: {
+            readonly r: {
+                readonly min: 0;
+                readonly max: 255;
+                readonly factor: 255;
+            };
+            readonly g: {
+                readonly min: 0;
+                readonly max: 255;
+                readonly factor: 255;
+            };
+            readonly b: {
+                readonly min: 0;
+                readonly max: 255;
+                readonly factor: 255;
+            };
+        };
+        readonly colorSpace: "rgb";
+    };
+    readonly hsl: {
+        readonly coords: {
+            readonly h: {
+                readonly min: 0;
+                readonly max: 360;
+            };
+            readonly s: {
+                readonly min: 0;
+                readonly max: 100;
+                readonly factor: 100;
+                readonly digits: 1;
+            };
+            readonly l: {
+                readonly min: 0;
+                readonly max: 100;
+                readonly factor: 100;
+                readonly digits: 1;
+            };
+        };
+        readonly colorSpace: "rgb";
+    };
+    readonly hwb: {
+        readonly coords: {
+            readonly h: {
+                readonly min: 0;
+                readonly max: 360;
+            };
+            readonly w: {
+                readonly min: 0;
+                readonly max: 100;
+                readonly factor: 100;
+                readonly digits: 1;
+            };
+            readonly b: {
+                readonly min: 0;
+                readonly max: 100;
+                readonly factor: 100;
+                readonly digits: 1;
+            };
+        };
+        readonly colorSpace: "rgb";
+    };
+    readonly lab: {
+        readonly coords: {
+            readonly l: {
+                readonly min: 0;
+                readonly max: 100;
+                readonly digits: 1;
+            };
+            readonly a: {
+                readonly min: -128;
+                readonly max: 127;
+            };
+            readonly b: {
+                readonly min: -128;
+                readonly max: 127;
+            };
+        };
+        readonly colorSpace: "lab";
+    };
+    readonly lch: {
+        readonly coords: {
+            readonly l: {
+                readonly min: 0;
+                readonly max: 100;
+                readonly digits: 1;
+            };
+            readonly c: {
+                readonly min: 0;
+                readonly max: 230;
+            };
+            readonly h: {
+                readonly min: 0;
+                readonly max: 360;
+            };
+        };
+        readonly colorSpace: "lab";
+    };
+    readonly oklab: {
+        readonly coords: {
+            readonly l: {
+                readonly min: 0;
+                readonly max: 1;
+                readonly digits: 3;
+            };
+            readonly a: {
+                readonly min: -0.5;
+                readonly max: 0.5;
+                readonly digits: 3;
+            };
+            readonly b: {
+                readonly min: -0.5;
+                readonly max: 0.5;
+                readonly digits: 3;
+            };
+        };
+        readonly colorSpace: "oklab";
+    };
+    readonly oklch: {
+        readonly coords: {
+            readonly l: {
+                readonly min: 0;
+                readonly max: 1;
+                readonly digits: 3;
+            };
+            readonly c: {
+                readonly min: 0;
+                readonly max: 0.4;
+                readonly digits: 3;
+            };
+            readonly h: {
+                readonly min: 0;
+                readonly max: 360;
+                readonly digits: 1;
+            };
+        };
+        readonly colorSpace: "oklab";
+    };
+};
+/**
+ * All supported color format names. This can be used as an enum.
+ *
+ * @category Internal
+ */
+export declare const ColorFormatName: { [FormatName in ColorFormatName]: FormatName; };
+/**
+ * All supported color format names. This can be used as an enum.
+ *
+ * @category Internal
+ */
+export type ColorFormatName = keyof typeof rawColorFormats;
+/**
+ * List the color coordinate keys (like `r` or `g` or `b`) for each supported color format in a
+ * union.
+ *
+ * @category Internal
+ */
+export type ColorCoordsByFormat = {
+    [FormatName in ColorFormatName]: keyof (typeof rawColorFormats)[FormatName]['coords'];
+};
+/**
+ * Type for {@link colorFormats}.
+ *
+ * @category Internal
+ */
+export type ColorFormats = Readonly<{
+    [FormatName in ColorFormatName]: ColorFormatDefinition<'colorSpace' extends keyof (typeof rawColorFormats)[FormatName] ? Extract<(typeof rawColorFormats)[FormatName], {
+        colorSpace: any;
+    }>['colorSpace'] : FormatName>;
+}>;
+/**
+ * All supported color formats.
+ *
+ * @category Color Format
+ */
+export declare const colorFormats: ColorFormats;
+/**
+ * All available color space names.
+ *
+ * @category Internal
+ */
+export type ColorSpaceName = Values<typeof rawColorFormats>['colorSpace'];
+/**
+ * All value types for all supported color formats.
+ *
+ * @category Internal
+ */
+export type ColorValues = {
+    [FormatName in ColorFormatName]: Record<keyof (typeof rawColorFormats)[FormatName]['coords'], number>;
+};
+/**
+ * All color formats grouped by their color space.
+ *
+ * @category Color Format
+ */
+export declare const colorSpaces: Record<"rgb" | "lab" | "oklab", Record<"rgb" | "hsl" | "hwb" | "lab" | "lch" | "oklab" | "oklch", ColorFormatDefinition<string>>>;
+/**
+ * All color format names in an array.
+ *
+ * @category Internal
+ */
+export declare const colorFormatNames: ColorFormatName[];
+/**
+ * All possible coordinate names for all supported color formats in a union.
+ *
+ * @category Internal
+ */
+export type ColorCoordinateName = keyof UnionToIntersection<Values<typeof rawColorFormats>['coords']>;

package/dist/color-formats.js

@@ -0,0 +1,175 @@
+import { getObjectTypedEntries, getObjectTypedKeys, getOrSet, mapObjectValues, } from '@augment-vir/common';
+/**
+ * All raw supported color formats.
+ *
+ * @category Internal
+ */
+export const rawColorFormats = {
+    rgb: {
+        coords: {
+            r: {
+                min: 0,
+                max: 255,
+                factor: 255,
+            },
+            g: {
+                min: 0,
+                max: 255,
+                factor: 255,
+            },
+            b: {
+                min: 0,
+                max: 255,
+                factor: 255,
+            },
+        },
+        colorSpace: 'rgb',
+    },
+    hsl: {
+        coords: {
+            h: {
+                min: 0,
+                max: 360,
+            },
+            s: {
+                min: 0,
+                max: 100,
+                factor: 100,
+                digits: 1,
+            },
+            l: {
+                min: 0,
+                max: 100,
+                factor: 100,
+                digits: 1,
+            },
+        },
+        colorSpace: 'rgb',
+    },
+    hwb: {
+        coords: {
+            h: {
+                min: 0,
+                max: 360,
+            },
+            w: {
+                min: 0,
+                max: 100,
+                factor: 100,
+                digits: 1,
+            },
+            b: {
+                min: 0,
+                max: 100,
+                factor: 100,
+                digits: 1,
+            },
+        },
+        colorSpace: 'rgb',
+    },
+    lab: {
+        coords: {
+            l: {
+                min: 0,
+                max: 100,
+                digits: 1,
+            },
+            a: {
+                min: -128,
+                max: 127,
+            },
+            b: {
+                min: -128,
+                max: 127,
+            },
+        },
+        colorSpace: 'lab',
+    },
+    lch: {
+        coords: {
+            l: {
+                min: 0,
+                max: 100,
+                digits: 1,
+            },
+            c: {
+                min: 0,
+                max: 230,
+            },
+            h: {
+                min: 0,
+                max: 360,
+            },
+        },
+        colorSpace: 'lab',
+    },
+    oklab: {
+        coords: {
+            l: {
+                min: 0,
+                max: 1,
+                digits: 3,
+            },
+            a: {
+                min: -0.5,
+                max: 0.5,
+                digits: 3,
+            },
+            b: {
+                min: -0.5,
+                max: 0.5,
+                digits: 3,
+            },
+        },
+        colorSpace: 'oklab',
+    },
+    oklch: {
+        coords: {
+            l: {
+                min: 0,
+                max: 1,
+                digits: 3,
+            },
+            c: {
+                min: 0,
+                max: 0.4,
+                digits: 3,
+            },
+            h: {
+                min: 0,
+                max: 360,
+                digits: 1,
+            },
+        },
+        colorSpace: 'oklab',
+    },
+};
+/**
+ * All supported color format names. This can be used as an enum.
+ *
+ * @category Internal
+ */
+export const ColorFormatName = mapObjectValues(rawColorFormats, (colorName) => colorName);
+/**
+ * All supported color formats.
+ *
+ * @category Color Format
+ */
+export const colorFormats = rawColorFormats;
+/**
+ * All color formats grouped by their color space.
+ *
+ * @category Color Format
+ */
+export const colorSpaces = getObjectTypedEntries(colorFormats).reduce((accum, [colorFormatName, colorFormatDefinition,]) => {
+    getOrSet(accum, colorFormatDefinition.colorSpace, () => {
+        return {};
+    })[colorFormatName] = colorFormatDefinition;
+    return accum;
+}, {});
+/**
+ * All color format names in an array.
+ *
+ * @category Internal
+ */
+export const colorFormatNames = getObjectTypedKeys(colorFormats);