Add type definitions

.gitignore

@@ -1,4 +1,5 @@
 *.sublime-workspace
+.idea/
 .DS_Store
 build/
 bundled/

check-dts/average.errors.ts

@@ -0,0 +1,23 @@
+import { average } from '../src/average';
+import type { Rgb } from '../src/rgb/types';
+
+// THROWS Expected 1-3 arguments, but got 0.
+const c1 = average();
+
+// THROWS Argument of type '[]' is not assignable to parameter of type 'NonEmptyArray<string | Color>'.
+const c2 = average([]);
+
+// THROWS No overload matches this call.
+const c3: Rgb = average(['#ff0000', '#0000ff'], undefined, {
+	r: 1
+});
+
+// THROWS No overload matches this call.
+const c4: Rgb = average(['#ff0000', '#0000ff'], 'hsl', {
+	r: () => 1
+});
+
+// THROWS Type 'Hsl' is missing the following properties from type 'Rgb': r, g, b
+const c5: Rgb = average(['#ff0000', '#0000ff'], 'hsl', {
+	h: () => 1
+});

check-dts/average.types.ts

@@ -0,0 +1,20 @@
+import { average } from '../src/average';
+import type { Rgb } from '../src/rgb/types';
+import type { Lch } from '../src/lch/types';
+import type { Oklab } from '../src/oklab/types';
+
+const c1: Rgb = average(['#ff0000', '#0000ff']);
+
+const c2: Lch = average(['#ff0000', '#0000ff'], 'lch');
+
+const c3: Lch = average(['#ff0000', '#0000ff'], 'lch', _ => 1);
+
+const c4: Rgb = average(['#ff0000', '#0000ff'], undefined, _ => 1);
+
+const c5: Rgb = average(['#ff0000', '#0000ff'], undefined, {
+	r: _ => 1
+});
+
+const c6: Oklab = average(['#ff0000', '#0000ff'], 'oklab', {
+	b: _ => 1
+});

check-dts/blend.errors.ts

@@ -0,0 +1,17 @@
+import blend from '../src/blend';
+import type { Rgb } from '../src/rgb/types';
+
+// THROWS Argument of type '[]' is not assignable to parameter of type 'NonEmptyArray<string | Color>'.
+const c1 = blend([]);
+
+// THROWS Type 'number' is not assignable to type 'string | Color'.
+const c2: Rgb = blend([12312]);
+
+const c3: Rgb = blend(
+	['white', 'rgba(0, 0, 0, 0.5)'],
+	// THROWS Argument of type '"darke"' is not assignable to parameter of type 'BlendTypes | BlendingFunction'.
+	'darke'
+);
+
+// THROWS Type 'Jab' is missing the following properties from type 'Rgb': r, g
+const c4: Rgb = blend(['white', 'rgba(0, 0, 0, 0.5)'], 'darken', 'jab');

check-dts/blend.types.ts

@@ -0,0 +1,15 @@
+import blend from '../src/blend';
+import type { Rgb } from '../src/rgb/types';
+import type { Jab } from '../src/jab/types';
+
+const c1: Rgb = blend([
+	{ mode: 'rgb', r: 1, g: 0, b: 0, alpha: 0.5 },
+	{ mode: 'rgb', r: 0, g: 0, b: 1, alpha: 0.5 }
+]);
+const c2: Rgb = blend(['white', 'rgba(0, 0, 0, 0.5)']);
+
+const c3: Rgb = blend(['white', 'rgba(0, 0, 0, 0.5)'], 'darken');
+const c4: Rgb = blend(['white', 'rgba(0, 0, 0, 0.5)'], b => b * 2);
+const c5: Rgb = blend(['white', 'rgba(0, 0, 0, 0.5)'], (b, s) => b + s);
+const c6: Rgb = blend(['white', 'rgba(0, 0, 0, 0.5)'], 'darken');
+const c7: Jab = blend(['white', 'rgba(0, 0, 0, 0.5)'], 'darken', 'jab');

check-dts/common.errors.ts

@@ -0,0 +1,7 @@
+import type { TakeColorChannels } from '../src/common';
+
+// THROWS Property 'l' is missing in type '{ h: number; s: number; }' but required in type 'TakeColorChannels<"hsl">'.
+const hsl1: TakeColorChannels<'hsl'> = { h: 30, s: 0.5 };
+
+// THROWS Property 's' is missing in type '{ l: number; }' but required in type 'TakeColorChannels<"hsl">'.
+const hsl2: TakeColorChannels<'hsl'> = { l: 1 };

check-dts/common.types.ts

@@ -0,0 +1,6 @@
+import type { TakeColorChannels } from '../src/common';
+
+const okhsl1: TakeColorChannels<'okhsl'> = { h: 30, s: 0.5, l: 1, alpha: 0.25 };
+const okhsl2: TakeColorChannels<'okhsl'> = { h: 30, s: 0.5, l: 1 };
+const okhsl3: TakeColorChannels<'okhsl'> = { s: 0.5, l: 1 };
+const hsl1: TakeColorChannels<'hsl'> = { s: 0.5, l: 1 };

check-dts/convertLrgbToRgb.types.ts

@@ -0,0 +1,4 @@
+import { convertLrgbToRgb, Rgb } from '../src';
+
+const r = convertLrgbToRgb({ r: 1, g: 1, b: 1 });
+const c: Rgb = r;

check-dts/converter.errors.ts

@@ -0,0 +1,8 @@
+import converter from '../src/converter';
+import type { Rgb } from '../src/rgb/types';
+
+// THROWS Type 'Rgb | undefined' is not assignable to type 'Rgb'.
+const case_1_expect_error: Rgb = converter()('#f0f0f0');
+
+// THROWS Type 'Lab | undefined' is not assignable to type 'Rgb'.
+const case_3_expect_error: Rgb = converter('lab')('#f0f0f0');

check-dts/converter.types.ts

@@ -0,0 +1,11 @@
+import converter from '../src/converter';
+import type { Lab } from '../src/lab/types';
+import type { Rgb } from '../src/rgb/types';
+import type { Color, Oklab } from '../src';
+
+const case_0_expect_success: Rgb | undefined = converter()('#f0f0f0');
+
+const case_2_expect_success: Lab | undefined = converter('lab')('#f0f0f0');
+
+declare const c: Color;
+const case_3_expect_success: Oklab = converter('oklab')(c);

check-dts/filters.types.ts

@@ -0,0 +1,10 @@
+import { filterBrightness } from '../src/filter';
+import type { Hsl } from '../src/hsl/types';
+
+const case_1_expect_success: Hsl = filterBrightness(1)({
+	mode: 'hsl',
+	h: 60,
+	s: 1,
+	l: 0.5,
+	alpha: 0.25
+});

check-dts/formatter.types.ts

@@ -0,0 +1,21 @@
+import { Color, formatCss, formatRgb, modeP3, P3, Rgb, useMode } from '../fn';
+
+declare const color: Rgb;
+const str: string = formatRgb(color);
+
+let p3 = useMode(modeP3);
+
+declare const color2: Color;
+const r2 = p3(color2);
+const str2 = formatCss(r2);
+
+declare const color3: string;
+const r3 = p3(color3);
+const tr3 = r3 === undefined ? formatCss(r3) : formatCss(r3);
+
+declare const color4: string;
+const r4 = p3(color4);
+const tr4 = formatCss(r4);
+
+declare const color5: Color;
+const r5: string = formatRgb(color);

check-dts/map.errors.ts

@@ -0,0 +1,66 @@
+import { mapper } from '../src/map';
+import type { Rgb } from '../src/rgb/types';
+import type { Hsl } from '../src/hsl/types';
+import type { Okhsv } from '../src/okhsv/types';
+
+const doubler = mapper(v => {
+	return v * 2;
+});
+
+// THROWS Type 'Rgb' is missing the following properties from type 'Hsl': s, l
+const case_3_expect_error: Hsl = doubler({
+	mode: 'hsl',
+	h: 0,
+	s: 0,
+	l: 0
+});
+
+// THROWS Type 'Rgb | undefined' is not assignable to type 'Hsl | undefined'
+const case_5_expect_error: Hsl | undefined = doubler('hsl(0, 100%, 50%)');
+
+const increaser = mapper(v => v + 10, null);
+
+// THROWS Type 'Color | undefined' is not assignable to type 'Okhsv | undefined'
+const case_6_expect_error: Okhsv | undefined = increaser(
+	'color(--okhsv 29.2338851923426 0.9995219692256307 0.9999999999999997)'
+);
+
+const decreaser = mapper(v => v - 10, undefined);
+
+// THROWS Type 'Rgb | undefined' is not assignable to type 'Okhsv | undefined'
+const case_9_expect_error: Okhsv | undefined = decreaser(
+	'color(--okhsv 29.2338851923426 0.9995219692256307 0.9999999999999997)'
+);
+
+// THROWS Type 'Rgb' is not assignable to type 'Hsl'
+const case_10_expect_error: Hsl = decreaser({
+	mode: 'hsl',
+	h: 1,
+	s: 1,
+	l: 1
+});
+
+const tripler = mapper(v => {
+	return v * 3;
+}, 'hsl');
+
+// THROWS Type 'Hsl | undefined' is not assignable to type 'Hsl'
+const case_13_expect_error: Hsl = tripler('hsla(240, 100%, 50%, 50%)');
+
+// THROWS Type 'Rgb | undefined' is not assignable to type 'Rgb'
+const case_8_1_expect_error: Rgb = decreaser(
+	'color(--okhsv 29.2338851923426 0.9995219692256307 0.9999999999999997)'
+);
+
+const oner = mapper(
+	(_v, _ch, conv_color, mode) => {
+		// THROWS Type 'Rgb' is not assignable to type 'Hsl'
+		const check_1_expect_error: Hsl = conv_color;
+
+		// THROWS Type '"rgb"' is not assignable to type '"hsl"'
+		const check_3_expect_error: 'hsl' = mode;
+		return 1;
+	},
+	undefined,
+	true
+);

check-dts/map.types.ts

@@ -0,0 +1,66 @@
+import { mapper } from '../src/map';
+import type { Rgb } from '../src/rgb/types';
+import type { Hsl } from '../src/hsl/types';
+import type { Color } from '../src/common';
+
+const doubler = mapper(v => {
+	return v * 2;
+});
+
+const case_1_expect_success: Rgb = doubler({
+	mode: 'rgb',
+	r: 0,
+	b: 0,
+	g: 0
+});
+
+const case_2_expect_success: Rgb = doubler({
+	mode: 'hsl',
+	h: 0,
+	s: 0,
+	l: 0
+});
+
+const case_4_expect_success: Rgb | undefined = doubler('hsl(0, 100%, 50%)');
+
+const increaser = mapper(v => v + 10, null);
+
+const case_5_expect_success: Color | undefined = increaser(
+	'color(--okhsv 29.2338851923426 0.9995219692256307 0.9999999999999997)'
+);
+
+const case_7_expect_success: Hsl = increaser({
+	mode: 'hsl',
+	h: 0,
+	s: 0,
+	l: 0
+});
+
+const decreaser = mapper(v => v - 10, undefined);
+
+const case_8_expect_success: Rgb | undefined = decreaser(
+	'color(--okhsv 29.2338851923426 0.9995219692256307 0.9999999999999997)'
+);
+
+const tripler = mapper(v => {
+	return v * 3;
+}, 'hsl');
+
+const case_11_expect_success: Hsl | undefined = tripler('#3690');
+const case_12_expect_success: Hsl = tripler({
+	h: 240,
+	s: 1,
+	l: 0.5,
+	mode: 'hsl',
+	alpha: 0.5
+});
+
+const oner = mapper(
+	(_v, _ch, conv_color, mode) => {
+		const check_0_expect_success: Rgb = conv_color;
+		const check_2_expect_success: 'rgb' = mode;
+		return 1;
+	},
+	undefined,
+	true
+);

check-dts/modes.errors.ts

@@ -0,0 +1,5 @@
+import { converters } from '../src/modes';
+import type { Cubehelix, Rgb } from '../src';
+
+// THROWS Type '((c: Omit<Cubehelix, "mode">) => Rgb) | undefined' is not assignable to type '(c: Omit<Cubehelix, "mode">) => Rgb'
+const c1: (c: Omit<Cubehelix, 'mode'>) => Rgb = converters.cubehelix.rgb;

check-dts/modes.types.ts

@@ -0,0 +1,5 @@
+import { converters } from '../src/modes';
+import type { Cubehelix, Rgb } from '../src';
+
+const c1: ((c: Omit<Cubehelix, 'mode'>) => Rgb) | undefined =
+	converters.cubehelix.rgb;

check-dts/named.types.ts

@@ -0,0 +1,3 @@
+import { colorsNamed } from '../fn';
+
+const s: 0xa0522d = colorsNamed.sienna;

check-dts/random.errors.ts

@@ -0,0 +1,31 @@
+import random from '../src/random';
+import type { Rgb } from '../src/rgb/types';
+import type { Yiq } from '../src/yiq/types';
+import type { Hsl } from '../src/hsl/types';
+
+// THROWS No overload matches this call
+const c1 = random('1');
+
+// THROWS Type 'Rgb' is not assignable to type 'Hsl'
+const c2: Hsl = random();
+
+// THROWS Type 'Hsi' is missing the following properties from type 'Rgb': r, g, b
+const c3: Rgb = random('hsi');
+
+// THROWS No overload matches this call
+const c4: Yiq = random('yiq', {
+	r: [1, 2]
+});
+
+// THROWS No overload matches this call
+const c5: Yiq = random('yiq', {
+	y: []
+});
+
+// THROWS No overload matches this call
+const c6: Yiq = random('yiq', {
+	y: [1]
+});
+
+// THROWS No overload matches this call
+const c7 = random(undefined, { h: [0, 1] });

check-dts/random.types.ts

@@ -0,0 +1,27 @@
+import random from '../src/random';
+import type { Rgb } from '../src/rgb/types';
+import type { Yiq } from '../src/yiq/types';
+
+const c1 = random();
+
+const c2: Rgb = random();
+
+const c3: Rgb = random('rgb');
+
+const c4: Yiq = random('yiq');
+
+const c5: Yiq = random('yiq', {
+	y: 1
+});
+
+const c6: Yiq = random('yiq', {
+	y: [0, 1]
+});
+
+const c7 = random(undefined, {
+	r: 1
+});
+
+const c8 = random(undefined, {
+	r: [0, 1]
+});

docs/resources.md

@@ -16,6 +16,7 @@ These projects add more functionality to Culori, but they're separate as to keep
 
 -   [Moqups](https://moqups.com) — all our color-manipulation functions are handled by Culori.
 -   [Schemist](https://github.com/felixgirault/schemist) — color schemes builder backed by Culori.
+-   [OKLCH & LCH Color Picker](https://github.com/evilmartians/oklch-picker) — color picker and converter for Oklab and Lab color space backed by Culori.
 -   [Color Name API](https://github.com/meodai/color-name-api) — a REST API for color names that makes use Culori's [differenceCiede2000](https://culorijs.org/api/#differenceCiede2000) to return a fitting name for every color.
 
 Does your product/project use Culori? Create a PR and add yourself to this list.

example/README.md

@@ -0,0 +1,6 @@
+Execute following command
+
+```shell
+cd ./example
+npx ts-node --esm main.ts
+```