haus-colour-names 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 hipuku
+
+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,37 @@
+# haus-colour-names
+
+31,900 named colours as data. No dependencies, no matching logic.
+
+The dataset is [meodai/color-names](https://github.com/meodai/color-names). This package
+carries it and normalises the hexes; the perceptual matching lives in
+[`haus-colour-utils`](../colour-utils), so a project that wants CIEDE2000 or WCAG contrast
+does not install 748KB of names to get them.
+
+```bash
+npm install haus-colour-names haus-colour-utils
+```
+
+```ts
+import { colourNameEntries } from 'haus-colour-names'
+import { createNamedColourMatcher } from 'haus-colour-utils'
+
+const nameColour = createNamedColourMatcher(colourNameEntries())
+
+nameColour('#4f84ba', 3)
+// [ { name: 'Blue Cola', hex: '#4a84c4', distance: 3.1 }, … ]
+```
+
+`haus-colour-utils` bundles 289 basic colour terms and uses them by default, so reach for
+this package when you want the exhaustive set.
+
+## API
+
+| Export | Type | What it is |
+|---|---|---|
+| `colourNameEntries()` | `() => ColourNameEntry[]` | The dataset as `{ hex, name }`, hexes normalised to `#rrggbb`. Built on first call, then reused. |
+| `colourNames` | `Record<string, string>` | The raw map. Keys are six hex digits with no `#`. |
+| `COLOUR_NAME_COUNT` | `number` | 31,900. |
+
+## Licence
+
+MIT for the package. The dataset is MIT, from meodai/color-names.

package/dist/index.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Named colour data.
+ *
+ * The meodai colour-names dataset: 31,900 hex values with a human name each.
+ * Data only, no dependencies and no matching logic, so a project that wants ΔE
+ * from haus-colour-utils does not pay 748KB for names it never asks about.
+ *
+ * Pair it with `createNamedColourMatcher` from haus-colour-utils:
+ *
+ *   import { colourNameEntries } from 'haus-colour-names'
+ *   import { createNamedColourMatcher } from 'haus-colour-utils'
+ *
+ *   const nameColour = createNamedColourMatcher(colourNameEntries())
+ *   nameColour('#4f84ba')  // [{ name: 'Blue Cola', hex: '#4a84c4', distance: 3.1 }, …]
+ */
+/** One dataset entry, with the hex normalised to `#rrggbb`. */
+interface ColourNameEntry {
+    hex: string;
+    name: string;
+}
+/**
+ * The dataset as stored: keys are six hex digits with no leading `#`, and a
+ * value that starts with a zero keeps it (`"00ffff"`), so a key is always six
+ * characters. Exposed for a consumer that wants the raw map.
+ */
+declare const colourNames: Record<string, string>;
+/** How many colours the dataset holds. */
+declare const COLOUR_NAME_COUNT: number;
+/**
+ * The dataset as `{ hex, name }` with hexes normalised to `#rrggbb`.
+ *
+ * Built on first call and then reused. Doing it at module load would cost every
+ * importer 31,900 string operations whether or not they name a colour.
+ */
+declare function colourNameEntries(): ColourNameEntry[];
+
+export { COLOUR_NAME_COUNT, type ColourNameEntry, colourNameEntries, colourNames };