@phun-ky/moebius 2.0.6 → 2.0.7

package/README.md

@@ -2,17 +2,18 @@
 
 ![logo](./public/images/logo/logo-ring.png)
 
-> Automatically generate color palettes!
+> Generate harmonious, customizable color palettes from a single base color - instantly and programmatically.
 
 [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-green.svg)](http://makeapullrequest.com) [![SemVer 2.0](https://img.shields.io/badge/SemVer-2.0-green.svg)](http://semver.org/spec/v2.0.0.html) ![npm version](https://img.shields.io/npm/v/@phun-ky/moebius) ![issues](https://img.shields.io/github/issues/phun-ky/moebius) ![license](https://img.shields.io/npm/l/@phun-ky/moebius) ![size](https://img.shields.io/bundlephobia/min/@phun-ky/moebius) ![npm](https://img.shields.io/npm/dm/%40phun-ky/moebius) ![GitHub Repo stars](https://img.shields.io/github/stars/phun-ky/moebius) [![codecov](https://codecov.io/gh/phun-ky/moebius/graph/badge.svg?token=VA91DL7ZLZ)](https://codecov.io/gh/phun-ky/moebius) [![build](https://github.com/phun-ky/moebius/actions/workflows/check.yml/badge.svg)](https://github.com/phun-ky/moebius/actions/workflows/check.yml)
 
 - [@phun-ky/moebius `möbius`](#phun-kymoebius-möbius)
   - [About](#about)
+  - [Features](#features)
   - [Demo](#demo)
   - [Install](#install)
-  - [API](#api)
+  - [Full API-reference](#full-api-reference)
   - [Usage](#usage)
-    - [Creating paletts](#creating-paletts)
+    - [Creating palettes](#creating-palettes)
       - [Default options](#default-options)
       - [Interpolate](#interpolate)
       - [Luminance shift](#luminance-shift)
@@ -36,7 +37,18 @@
 
 ## About
 
-@phun-ky/moebius (Möbius) was created to fit a need I had regarding color palette generation, and as a little challenge to myself. I was never happy with the current online palette generators, and I did not want a "set up" palette, I wanted something that was generated, ready to use, and something that I could use as inspiration on colors to choose from in my projects.
+Möbius is a color palette generation tool designed for developers and designers who need quick, consistent, and attractive color schemes. It supports a wide variety of palette types and exports color data in multiple formats — RGB, HSL, LAB, CMYK, and more - making it ideal for both web design and data visualization.
+
+## Features
+
+- Generate palettes using:
+  - Interpolation
+  - Luminance shifts
+  - Monochromatic, Complementary, Analogous, Triadic, Tetradic, etc.
+- Output in multiple color spaces: RGB, HSL, LCH, CMYK, etc.
+- Randomized or lightness-corrected options
+- Diverging palette support
+- TypeScript-friendly API
 
 ## Demo
 
@@ -48,9 +60,9 @@ You can check out a working CodePen where you can [adjust settings and colors he
 npm i -S @phun-ky/moebius
 ```
 
-## API
+## Full API-reference
 
-Go [here](https://github.com/phun-ky/moebius/blob/main/api/README.md) to read the full API documentation.
+You can find the full API documentation [here](https://github.com/phun-ky/moebius/blob/main/api/README.md).
 
 ## Usage
 
@@ -60,9 +72,15 @@ Import and run the required function:
 import Moebius from '@phun-ky/moebius';
 
 const { MoebiusColor, MoebiusPalettes } = await Moebius();
+
+const palette = new MoebiusPalettes({
+  baseColor: new MoebiusColor('#1e90ff')
+});
+
+console.log(palette.colors.interpolate); // ['#1e90ff', '#3298d8', ...]
 ```
 
-### Creating paletts
+### Creating palettes
 
 The main feature is the ability to create palettes with a given primary color and a secondary color (used for diverging palettes). You can also give the color to diverge to/from.
 

package/dist/moebius.d.ts

@@ -1,212 +1,3 @@
-/**
- * Represents a color object with various color representations.
- */
-interface MoebiusColorInterface {
-    color: MoebiusChromaColorInputType;
-    name: string;
-    hex: MoebiusColorValueHexType;
-    rgb: MoebiusColorValueRgbType;
-    hsl: MoebiusHSLObjectType;
-    hslFloat: MoebiusHSLObjectType;
-    rgbFloat: MoebiusRGBObjectType;
-    hwb: MoebiusHWBObjectType;
-    hsv: MoebiusHSVObjectType;
-    lab: MoebiusLABObjectType;
-    xyz: MoebiusXYZObjectType;
-    lch: MoebiusLCHObjectType;
-    oklch: MoebiusLCHObjectType;
-    hsi: MoebiusHSIObjectType;
-    oklab: MoebiusLABObjectType;
-    cmyk: MoebiusCMYKObjectType;
-}
-interface MoebiusPaletteInterface {
-    baseColor: MoebiusColorInterface;
-    secondaryColor: MoebiusColorInterface;
-    colors: Record<string, unknown> | MoebiusPaletteColorsInterface;
-    themes: Record<string, unknown> | MoebiusThemeColorsInterface;
-    defaultOptions: MoebiusPaletteDefaultOptionsType;
-    options: MoebiusPaletteOptionsType;
-    all: MoebiusColorValueHexType[];
-    accents: MoebiusPaletteAccentColorsInterface;
-}
-/**
- * Represents a palette of colors with different schemes.
- */
-interface MoebiusPaletteColorsInterface {
-    interpolate: MoebiusColorValueHexType[];
-    luminanceShift: MoebiusColorValueHexType[];
-    monochromatic: MoebiusColorValueHexType[];
-    complement: MoebiusColorValueHexType[];
-    split: MoebiusColorValueHexType[];
-    triadic: MoebiusColorValueHexType[];
-    tetradic: MoebiusColorValueHexType[];
-    pentadic: MoebiusColorValueHexType[];
-    hexadic: MoebiusColorValueHexType[];
-    analogous: MoebiusColorValueHexType[];
-}
-/**
- * Represents a palette of colors with different themes.
- */
-interface MoebiusThemeColorsInterface {
-    darkMode: Record<string, MoebiusColorValueHexType[]>;
-}
-/**
- * Represents a palette of accent colors with different schemes.
- */
-interface MoebiusPaletteAccentColorsInterface {
-    interpolate: MoebiusColorValueHexType[][];
-    luminanceShift: MoebiusColorValueHexType[][];
-    monochromatic: MoebiusColorValueHexType[][];
-    complement: MoebiusColorValueHexType[][];
-    split: MoebiusColorValueHexType[][];
-    triadic: MoebiusColorValueHexType[][];
-    tetradic: MoebiusColorValueHexType[][];
-    pentadic: MoebiusColorValueHexType[][];
-    hexadic: MoebiusColorValueHexType[][];
-    analogous: MoebiusColorValueHexType[][];
-}
-/**
- * Represents options for generating a color palette.
- */
-type MoebiusPaletteOptionsType = {
-    baseColor: MoebiusColorInterface;
-    secondaryColor: MoebiusColorInterface;
-    divergentColor?: MoebiusColorValueHexType;
-    diverging?: boolean;
-    bezier?: boolean;
-    randomOffset?: boolean;
-    correctLightness?: boolean;
-    noDuplicates?: boolean;
-    colorScaleMode?: string;
-    divergingColor?: string;
-    reverseDirection?: boolean;
-    numberOfColors?: number;
-};
-/**
- * Represents default options for generating a color palette.
- */
-type MoebiusPaletteDefaultOptionsType = {
-    divergentColor?: MoebiusColorValueHexType;
-    diverging: boolean;
-    bezier: boolean;
-    randomOffset: boolean;
-    correctLightness: boolean;
-    noDuplicates: boolean;
-    colorScaleMode: string;
-    reverseDirection: boolean;
-    numberOfColors?: number;
-};
-/**
- * Represents a color value in hexadecimal format.
- */
-type MoebiusColorValueHexType = `#${string}`;
-/**
- * Represents a color value in HSL format.
- */
-type MoebiusColorValueHslType = `hsl(${number}, ${string}, ${string})`;
-/**
- * Represents a color value in HSLA format.
- */
-type MoebiusColorValueHslaType = `hsl(${number}, ${string}, ${string}, ${number})`;
-/**
- * Represents a color value in RGB format.
- */
-type MoebiusColorValueRgbType = `rgb(${number}, ${number}, ${number})`;
-/**
- * Represents a color value in RGBA format.
- */
-type MoebiusColorValueRgbaType = `rgb(${number}, ${number}, ${number}, ${number})`;
-/**
- * Represents an RGB color object.
- */
-type MoebiusRGBObjectType = {
-    r: number;
-    g: number;
-    b: number;
-};
-/**
- * Represents an HSL color object.
- */
-type MoebiusHSLObjectType = {
-    h: number;
-    s: number;
-    l: number;
-};
-/**
- * Represents an HSV color object.
- */
-type MoebiusHSVObjectType = {
-    h: number;
-    s: number;
-    v: number;
-};
-/**
- * Represents an LCH color object.
- */
-type MoebiusLCHObjectType = {
-    l: number;
-    c: number;
-    h: number;
-};
-/**
- * Represents an HSI color object.
- */
-type MoebiusHSIObjectType = {
-    h: number;
-    s: number;
-    i: number;
-};
-/**
- * Represents an XYZ color object.
- */
-type MoebiusXYZObjectType = {
-    x: number;
-    y: number;
-    z: number;
-};
-/**
- * Represents an HWB color object.
- */
-type MoebiusHWBObjectType = {
-    h: number;
-    w: number;
-    b: number;
-};
-/**
- * Represents a LAB color object.
- */
-type MoebiusLABObjectType = {
-    l: number;
-    a: number;
-    b: number;
-};
-/**
- * Represents a CMYK color object.
- */
-type MoebiusCMYKObjectType = {
-    c: number;
-    m: number;
-    y: number;
-    k: number;
-};
-/**
- * Represents a color specification for nearest color matching.
- */
-interface NearestColorColorSpecInterface {
-    name: string;
-    source: string;
-    rgb: MoebiusRGBObjectType;
-}
-/**
- * Represents a color match for nearest color matching.
- */
-interface NearestColorColorMatchInterface {
-    name: string;
-    value: string;
-    rgb: MoebiusRGBObjectType;
-}
-type MoebiusChromaColorInputType = MoebiusCMYKObjectType | MoebiusLCHObjectType | MoebiusHSLObjectType | MoebiusColorValueHexType | string;
-
 /**
  * MoebiusColor class representing a color with various formats and conversions.
  *
@@ -526,18 +317,250 @@ declare class MoebiusSVGHelper {
     getColorPiePaths(colors: MoebiusColorValueHexType[][], size?: number): DocumentFragment;
 }
 
+/**
+ * Represents a color object with various color representations.
+ */
+interface MoebiusColorInterface {
+    color: MoebiusChromaColorInputType;
+    name: string;
+    hex: MoebiusColorValueHexType;
+    rgb: MoebiusColorValueRgbType;
+    hsl: MoebiusHSLObjectType;
+    hslFloat: MoebiusHSLObjectType;
+    rgbFloat: MoebiusRGBObjectType;
+    hwb: MoebiusHWBObjectType;
+    hsv: MoebiusHSVObjectType;
+    lab: MoebiusLABObjectType;
+    xyz: MoebiusXYZObjectType;
+    lch: MoebiusLCHObjectType;
+    oklch: MoebiusLCHObjectType;
+    hsi: MoebiusHSIObjectType;
+    oklab: MoebiusLABObjectType;
+    cmyk: MoebiusCMYKObjectType;
+}
+/**
+ * Describes a color with multiple representations and metadata.
+ */
 type MoebiusReturnType = Promise<{
     MoebiusColor: typeof MoebiusColor;
     MoebiusPalettes: typeof MoebiusPalettes;
     MoebiusSVGHelper: typeof MoebiusSVGHelper;
 }>;
 /**
- * Asynchronous function to initialize Moebius with required data
+ * Represents a full palette generated from a base/secondary color combination.
+ */
+interface MoebiusPaletteInterface {
+    baseColor: MoebiusColorInterface;
+    secondaryColor: MoebiusColorInterface;
+    colors: Record<string, unknown> | MoebiusPaletteColorsInterface;
+    themes: Record<string, unknown> | MoebiusThemeColorsInterface;
+    defaultOptions: MoebiusPaletteDefaultOptionsType;
+    options: MoebiusPaletteOptionsType;
+    all: MoebiusColorValueHexType[];
+    accents: MoebiusPaletteAccentColorsInterface;
+}
+/**
+ * Defines generated palette schemes (e.g., split, triadic).
+ */
+interface MoebiusPaletteColorsInterface {
+    interpolate: MoebiusColorValueHexType[];
+    luminanceShift: MoebiusColorValueHexType[];
+    monochromatic: MoebiusColorValueHexType[];
+    complement: MoebiusColorValueHexType[];
+    split: MoebiusColorValueHexType[];
+    triadic: MoebiusColorValueHexType[];
+    tetradic: MoebiusColorValueHexType[];
+    pentadic: MoebiusColorValueHexType[];
+    hexadic: MoebiusColorValueHexType[];
+    analogous: MoebiusColorValueHexType[];
+}
+/**
+ * Represents a palette of colors with different themes.
+ */
+interface MoebiusThemeColorsInterface {
+    darkMode: Record<string, MoebiusColorValueHexType[]>;
+}
+/**
+ * Represents a palette of accent colors with different schemes.
+ */
+interface MoebiusPaletteAccentColorsInterface {
+    interpolate: MoebiusColorValueHexType[][];
+    luminanceShift: MoebiusColorValueHexType[][];
+    monochromatic: MoebiusColorValueHexType[][];
+    complement: MoebiusColorValueHexType[][];
+    split: MoebiusColorValueHexType[][];
+    triadic: MoebiusColorValueHexType[][];
+    tetradic: MoebiusColorValueHexType[][];
+    pentadic: MoebiusColorValueHexType[][];
+    hexadic: MoebiusColorValueHexType[][];
+    analogous: MoebiusColorValueHexType[][];
+}
+/**
+ * Represents options for generating a color palette.
+ */
+type MoebiusPaletteOptionsType = {
+    baseColor: MoebiusColorInterface;
+    secondaryColor: MoebiusColorInterface;
+    divergentColor?: MoebiusColorValueHexType;
+    diverging?: boolean;
+    bezier?: boolean;
+    randomOffset?: boolean;
+    correctLightness?: boolean;
+    noDuplicates?: boolean;
+    colorScaleMode?: string;
+    divergingColor?: string;
+    reverseDirection?: boolean;
+    numberOfColors?: number;
+};
+/**
+ * Represents default options for generating a color palette.
+ */
+type MoebiusPaletteDefaultOptionsType = {
+    divergentColor?: MoebiusColorValueHexType;
+    diverging: boolean;
+    bezier: boolean;
+    randomOffset: boolean;
+    correctLightness: boolean;
+    noDuplicates: boolean;
+    colorScaleMode: string;
+    reverseDirection: boolean;
+    numberOfColors?: number;
+};
+/**
+ * A hex-based color string, e.g., '#ffcc00'.
+ */
+type MoebiusColorValueHexType = `#${string}`;
+/**
+ * HSL color value string, e.g., 'hsl(240, 100%, 50%)'.
+ */
+type MoebiusColorValueHslType = `hsl(${number}, ${string}, ${string})`;
+/**
+ * HSLA color value string, e.g., 'hsl(240, 100%, 50%, 0.5)'.
+ */
+type MoebiusColorValueHslaType = `hsl(${number}, ${string}, ${string}, ${number})`;
+/**
+ * RGB color value string, e.g., 'rgb(255, 0, 0)'.
+ */
+type MoebiusColorValueRgbType = `rgb(${number}, ${number}, ${number})`;
+/**
+ * RGBA color value string, e.g., 'rgb(255, 0, 0, 0.75)'.
+ */
+type MoebiusColorValueRgbaType = `rgb(${number}, ${number}, ${number}, ${number})`;
+/**
+ * RGB color object.
+ */
+type MoebiusRGBObjectType = {
+    r: number;
+    g: number;
+    b: number;
+};
+/**
+ * HSL color object.
+ */
+type MoebiusHSLObjectType = {
+    h: number;
+    s: number;
+    l: number;
+};
+/**
+ * HSV color object.
+ */
+type MoebiusHSVObjectType = {
+    h: number;
+    s: number;
+    v: number;
+};
+/**
+ * HSI color object.
+ */
+type MoebiusHSIObjectType = {
+    h: number;
+    s: number;
+    i: number;
+};
+/**
+ * HWB color object.
+ */
+type MoebiusHWBObjectType = {
+    h: number;
+    w: number;
+    b: number;
+};
+/**
+ * LAB color object.
+ */
+type MoebiusLABObjectType = {
+    l: number;
+    a: number;
+    b: number;
+};
+/**
+ * LCH color object.
+ */
+type MoebiusLCHObjectType = {
+    l: number;
+    c: number;
+    h: number;
+};
+/**
+ * XYZ color object.
+ */
+type MoebiusXYZObjectType = {
+    x: number;
+    y: number;
+    z: number;
+};
+/**
+ * CMYK color object.
+ */
+type MoebiusCMYKObjectType = {
+    c: number;
+    m: number;
+    y: number;
+    k: number;
+};
+/**
+ * A named color + metadata for nearest-color matching source.
+ */
+interface NearestColorColorSpecInterface {
+    name: string;
+    source: string;
+    rgb: MoebiusRGBObjectType;
+}
+/**
+ * A matched color name and its RGB/hex representation.
+ */
+interface NearestColorColorMatchInterface {
+    name: string;
+    value: string;
+    rgb: MoebiusRGBObjectType;
+}
+/**
+ * Input types accepted by Chroma or Moebius logic.
+ */
+type MoebiusChromaColorInputType = MoebiusCMYKObjectType | MoebiusLCHObjectType | MoebiusHSLObjectType | MoebiusColorValueHexType | string;
+
+/**
+ * Initializes and returns Moebius utilities with dynamic color naming support.
+ *
+ * This includes:
+ * - A subclass of `MoebiusColor` with nearest color name mapping
+ * - `MoebiusPalettes` for generating color palettes
+ * - `MoebiusSVGHelper` for generating SVG paths for colored pie slices.
+ *
  * @function
- * @returns {MoebiusReturnType} An object with Moebius classes
+ * @async
+ * @returns {Promise<MoebiusReturnType>} An object containing Moebius utility classes
  *
+ * @example
+ * ```ts
+ * const moebius = await Moebius();
+ * const color = new moebius.MoebiusColor('#abc123');
+ * console.log(color.name); // Closest color name, e.g., 'Avocado'
+ * ```
  */
 declare function Moebius(): MoebiusReturnType;
+//# sourceMappingURL=main.d.ts.map
 
 export { Moebius as default };
 export type { MoebiusCMYKObjectType, MoebiusChromaColorInputType, MoebiusColorInterface, MoebiusColorValueHexType, MoebiusColorValueHslType, MoebiusColorValueHslaType, MoebiusColorValueRgbType, MoebiusColorValueRgbaType, MoebiusHSIObjectType, MoebiusHSLObjectType, MoebiusHSVObjectType, MoebiusHWBObjectType, MoebiusLABObjectType, MoebiusLCHObjectType, MoebiusPaletteAccentColorsInterface, MoebiusPaletteColorsInterface, MoebiusPaletteDefaultOptionsType, MoebiusPaletteInterface, MoebiusPaletteOptionsType, MoebiusRGBObjectType, MoebiusReturnType, MoebiusThemeColorsInterface, MoebiusXYZObjectType, NearestColorColorMatchInterface, NearestColorColorSpecInterface };

package/dist/moebius.js

@@ -1,8 +1,8 @@
 /**
 * @phun-ky/moebius
-* Automatically generate color palettes!
+* @phun-ky/moebius is a versatile JavaScript library that automatically generates visually pleasing and customizable color palettes from a given base color. Whether you're building data visualizations, UIs, or design systems, Möbius offers various harmony modes (analogous, complementary, triadic, and more), smooth interpolation, luminance shifts, and diverging palette generation - all with extensive color format support and intuitive API design.
 * @author Alexander Vassbotn Røyne-Helgesen <alexander+github.com@phun-ky.net>
-* @version 2.0.6
+* @version 2.0.7
 * @license
 * Copyright (c) 2023 Alexander Vassbotn Røyne-Helgesen
 *