saturon 0.2.1 → 0.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/LICENSE +7 -7
  2. package/README.md +121 -119
  3. package/package.json +127 -127
package/LICENSE CHANGED
@@ -1,7 +1,7 @@
1
- Copyright © 2025 Ganemede Labs
2
-
3
- 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:
4
-
5
- The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
6
-
7
- 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.
1
+ Copyright © 2025 Ganemede Labs
2
+
3
+ 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:
4
+
5
+ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
6
+
7
+ 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 CHANGED
@@ -1,119 +1,121 @@
1
- # Saturon
2
-
3
- ![npm](https://img.shields.io/npm/v/saturon)
4
- ![npm](https://img.shields.io/npm/dw/saturon)
5
- ![License](https://img.shields.io/npm/l/saturon)
6
-
7
- A runtime-extensible JavaScript library for parsing, converting, and manipulating colors with full CSS spec support.
8
-
9
- ## 📋 Table of Contents
10
-
11
- - [Features](#-features)
12
- - [Installation](#-installation)
13
- - [Usage](#-usage)
14
- - [Examples](#-examples)
15
- - [Documentation](#-documentation)
16
- - [License](#-license)
17
- - [Contact](#-contact)
18
-
19
- ## ✨ Features
20
-
21
- - **Full CSS Color 4/5 Parsing**
22
- - Infinite nested color functions (e.g. `color-mix(...)` inside `light-dark(...)`)
23
- - Converts between all modern color spaces (OKLab, Display-P3, Rec.2020, etc.)
24
- - High-precision color math for serious colorimetry
25
- - Powerful plugin system for custom color spaces and functions
26
- - Supports complex color syntaxes like `color(from hsl(240 none calc(-infinity) / 0.5) display-p3 r calc(g + b) 100 / alpha)`
27
-
28
- ## 🔧 Installation
29
-
30
- ```bash
31
- npm install saturon
32
- ```
33
-
34
- ## 🚀 Usage
35
-
36
- ```js
37
- import { Color } from "saturon";
38
-
39
- // Parse any CSS color string
40
- const color = Color.from("#1481b8ff");
41
-
42
- // Access coordinates
43
- console.log(color.toArray()); // → [20, 129, 184, 1]
44
-
45
- // Convert to another format
46
- console.log(color.to("oklch", { units: true })); // → "oklch(0.57368 0.12258 238.41345deg)"
47
-
48
- // Access values in another color space
49
- console.log(color.in("lab").toObject({ precision: 1 })); // → { l: 50.5, a: -13.9, b: -37.6, alpha: 1 }
50
-
51
- // Modify components
52
- const modified = color.in("hsl").with({ l: (l) => l * 1.2 });
53
- console.log(modified.toString({ legacy: true })); // → "hsl(200, 80%, 48%)"
54
- ```
55
-
56
- ## 💡 Examples
57
-
58
- ### Converting Colors
59
-
60
- ```js
61
- const color = Color.from("hsl(337 100% 60%)");
62
- console.log(color.to("rgb")); // → rgb(255 51 129)
63
- console.log(color.to("hex-color")); // → #ff3381
64
- ```
65
-
66
- ### Manipulating Components
67
-
68
- ```js
69
- const color = Color.from("hwb(255 7% 1%)");
70
- const hwb = color.with({ h: 100, b: (b) => b * 20 });
71
- console.log(hwb.toString()); // → hwb(100 7 20)
72
- ```
73
-
74
- ### Mixing Colors
75
-
76
- ```js
77
- const red = Color.from("hsl(0, 100%, 50%)");
78
- const mixed = red.mix("hsl(120, 100%, 50%)");
79
- console.log(mixed.toString()); // → hsl(60 100 50)
80
- ```
81
-
82
- ### New Named Color Registration
83
-
84
- ```js
85
- registerNamedColor("sunsetblush", [255, 94, 77]);
86
- const rgb = Color.from("rgb(255, 94, 77)");
87
- console.log(rgb.to("named-color")); // → sunsetblush
88
- ```
89
-
90
- ### New Color Function Registration
91
-
92
- ```js
93
- const converter = {
94
- components: {
95
- i: { index: 0, value: [0, 1] },
96
- ct: { index: 1, value: [-1, 1] },
97
- cp: { index: 2, value: [-1, 1] },
98
- },
99
- bridge: "rgb",
100
- toBridge: (ictcp: number[]) => [/* r, g, b */],
101
- fromBridge: (rgb: number[]) => [/* i, ct, cp */],
102
- };
103
-
104
- registerColorFunction("ictcp", converter);
105
- const ictcp = Color.from("ictcp(0.2 0.2 -0.1)");
106
- console.log(ictcp.to("rgb")); // → rgb(6 7 90)
107
- ```
108
-
109
- ## 📚 Documentation
110
-
111
- Full documentation is available at [saturon.js.org](https://saturon.js.org).
112
-
113
- ## 📜 License
114
-
115
- This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
116
-
117
- ## 📧 Contact
118
-
119
- For inquiries or more information, you can reach out to us at [ganemedelabs@gmail.com](mailto:ganemedelabs@gmail.com).
1
+ # Saturon
2
+
3
+ ![Version](https://img.shields.io/npm/v/saturon)
4
+ ![Downloads](https://img.shields.io/npm/dw/saturon)
5
+ ![License](https://img.shields.io/npm/l/saturon)
6
+
7
+ A runtime-extensible JavaScript library for parsing, converting, and manipulating colors with full CSS spec support.
8
+
9
+ ## 📋 Table of Contents
10
+
11
+ - [Features](#-features)
12
+ - [Installation](#-installation)
13
+ - [Usage](#-usage)
14
+ - [Examples](#-examples)
15
+ - [Documentation](#-documentation)
16
+ - [License](#-license)
17
+ - [Contact](#-contact)
18
+
19
+ ## ✨ Features
20
+
21
+ - **Full CSS Color 4/5 Parsing**
22
+ - Infinite nested color functions (e.g. `color-mix(...)` inside `light-dark(...)`)
23
+ - Converts between all modern color spaces (OKLab, Display-P3, Rec.2020, etc.)
24
+ - High-precision color math for serious colorimetry
25
+ - Powerful plugin system for custom color spaces and functions
26
+ - Supports complex color syntaxes like `color(from hsl(240 none calc(-infinity) / 0.5) display-p3 r calc(g + b) 100 / alpha)`
27
+
28
+ ## 🔧 Installation
29
+
30
+ ```bash
31
+ npm install saturon
32
+ # or
33
+ yarn add saturon
34
+ ```
35
+
36
+ ## 🚀 Usage
37
+
38
+ ```js
39
+ import { Color } from "saturon";
40
+
41
+ // Parse any CSS color string
42
+ const color = Color.from("#1481b8ff");
43
+
44
+ // Access coordinates
45
+ console.log(color.toArray()); // → [20, 129, 184, 1]
46
+
47
+ // Convert to another format
48
+ console.log(color.to("oklch", { units: true })); // → "oklch(0.57368 0.12258 238.41345deg)"
49
+
50
+ // Access values in another color space
51
+ console.log(color.in("lab").toObject({ precision: 1 })); // → { l: 50.5, a: -13.9, b: -37.6, alpha: 1 }
52
+
53
+ // Modify components
54
+ const modified = color.in("hsl").with({ l: (l) => l * 1.2 });
55
+ console.log(modified.toString({ legacy: true })); // → "hsl(200, 80%, 48%)"
56
+ ```
57
+
58
+ ## 💡 Examples
59
+
60
+ ### Converting Colors
61
+
62
+ ```js
63
+ const color = Color.from("hsl(337 100% 60%)");
64
+ console.log(color.to("rgb")); // → rgb(255 51 129)
65
+ console.log(color.to("hex-color")); // → #ff3381
66
+ ```
67
+
68
+ ### Manipulating Components
69
+
70
+ ```js
71
+ const color = Color.from("hwb(255 7% 1%)");
72
+ const hwb = color.with({ h: 100, b: (b) => b * 20 });
73
+ console.log(hwb.toString()); // → hwb(100 7 20)
74
+ ```
75
+
76
+ ### Mixing Colors
77
+
78
+ ```js
79
+ const red = Color.from("hsl(0, 100%, 50%)");
80
+ const mixed = red.mix("hsl(120, 100%, 50%)");
81
+ console.log(mixed.toString()); // → hsl(60 100 50)
82
+ ```
83
+
84
+ ### New Named Color Registration
85
+
86
+ ```js
87
+ registerNamedColor("sunsetblush", [255, 94, 77]);
88
+ const rgb = Color.from("rgb(255, 94, 77)");
89
+ console.log(rgb.to("named-color")); // → sunsetblush
90
+ ```
91
+
92
+ ### New Color Function Registration
93
+
94
+ ```js
95
+ const converter = {
96
+ components: {
97
+ i: { index: 0, value: [0, 1] },
98
+ ct: { index: 1, value: [-1, 1] },
99
+ cp: { index: 2, value: [-1, 1] },
100
+ },
101
+ bridge: "rgb",
102
+ toBridge: (ictcp: number[]) => [/* r, g, b */],
103
+ fromBridge: (rgb: number[]) => [/* i, ct, cp */],
104
+ };
105
+
106
+ registerColorFunction("ictcp", converter);
107
+ const ictcp = Color.from("ictcp(0.2 0.2 -0.1)");
108
+ console.log(ictcp.to("rgb")); // → rgb(6 7 90)
109
+ ```
110
+
111
+ ## 📚 Documentation
112
+
113
+ Full documentation is available at [saturon.js.org](https://saturon.js.org).
114
+
115
+ ## 📜 License
116
+
117
+ This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
118
+
119
+ ## 📧 Contact
120
+
121
+ For inquiries or more information, you can reach out to us at [ganemedelabs@gmail.com](mailto:ganemedelabs@gmail.com).
package/package.json CHANGED
@@ -1,127 +1,127 @@
1
- {
2
- "name": "saturon",
3
- "version": "0.2.1",
4
- "description": "A runtime-extensible JavaScript library for parsing, converting, and manipulating colors with full CSS spec support.",
5
- "type": "module",
6
- "private": false,
7
- "author": "ganemedelabs",
8
- "license": "MIT",
9
- "main": "dist/index.js",
10
- "module": "dist/index.js",
11
- "types": "dist/index.d.ts",
12
- "unpkg": "dist/index.umd.js",
13
- "jsdelivr": "dist/index.umd.js",
14
- "exports": {
15
- ".": {
16
- "import": "./dist/index.js",
17
- "types": "./dist/index.d.ts"
18
- },
19
- "./config": {
20
- "import": "./dist/config.js",
21
- "types": "./dist/config.d.ts"
22
- },
23
- "./Color": {
24
- "import": "./dist/Color.js",
25
- "types": "./dist/Color.d.ts"
26
- },
27
- "./types": {
28
- "import": "./dist/types.js",
29
- "types": "./dist/types.d.ts"
30
- },
31
- "./utils": {
32
- "import": "./dist/utils.js",
33
- "types": "./dist/utils.d.ts"
34
- },
35
- "./converters": {
36
- "import": "./dist/converters.js",
37
- "types": "./dist/converters.d.ts"
38
- },
39
- "./math": {
40
- "import": "./dist/math.js",
41
- "types": "./dist/math.d.ts"
42
- }
43
- },
44
- "typesVersions": {
45
- "*": {
46
- "index.d.ts": [
47
- "dist/index.d.ts"
48
- ],
49
- "config.d.ts": [
50
- "dist/config.d.ts"
51
- ],
52
- "Color.d.ts": [
53
- "dist/Color.d.ts"
54
- ],
55
- "types.d.ts": [
56
- "dist/types.d.ts"
57
- ],
58
- "utils.d.ts": [
59
- "dist/utils.d.ts"
60
- ],
61
- "converters.d.ts": [
62
- "dist/converters.d.ts"
63
- ],
64
- "math.d.ts": [
65
- "dist/math.d.ts"
66
- ]
67
- }
68
- },
69
- "sideEffects": false,
70
- "repository": {
71
- "type": "git",
72
- "url": "https://github.com/ganemedelabs/saturon.git"
73
- },
74
- "bugs": {
75
- "url": "https://github.com/ganemedelabs/saturon/issues"
76
- },
77
- "homepage": "https://github.com/ganemedelabs/saturon#readme",
78
- "scripts": {
79
- "build": "tsc && esbuild dist/index.js --bundle --format=iife --global-name=Saturon --outfile=dist/index.umd.js && esbuild dist/index.js --bundle --minify --format=iife --global-name=Saturon --outfile=dist/index.umd.min.js",
80
- "test": "jest",
81
- "lint": "eslint .",
82
- "lint:fix": "eslint --fix .",
83
- "format": "prettier --write \"./**/*.{js,ts,json}\""
84
- },
85
- "files": [
86
- "dist",
87
- "README.md",
88
- "LICENSE",
89
- "package.json"
90
- ],
91
- "keywords": [
92
- "color-converter",
93
- "css-colors",
94
- "w3c",
95
- "color",
96
- "color-base",
97
- "hex-color",
98
- "named-color",
99
- "color-function",
100
- "light-dark",
101
- "color-mix",
102
- "transparent",
103
- "contrast-color",
104
- "device-cmyk",
105
- "currentcolor",
106
- "system-color"
107
- ],
108
- "devDependencies": {
109
- "@eslint/compat": "^1.4.0",
110
- "@eslint/eslintrc": "^3.3.1",
111
- "@eslint/js": "^9.37.0",
112
- "@types/jest": "^30.0.0",
113
- "@types/node": "^24.6.2",
114
- "@typescript-eslint/eslint-plugin": "^8.45.0",
115
- "@typescript-eslint/parser": "^8.45.0",
116
- "esbuild": "^0.25.11",
117
- "eslint": "^9.37.0",
118
- "eslint-config-prettier": "^10.1.8",
119
- "eslint-plugin-prettier": "^5.5.4",
120
- "jest": "^30.2.0",
121
- "jiti": "^2.6.1",
122
- "prettier": "^3.6.2",
123
- "ts-jest": "^29.4.4",
124
- "ts-node": "^10.9.2",
125
- "typescript": "^5.9.3"
126
- }
127
- }
1
+ {
2
+ "name": "saturon",
3
+ "version": "0.2.2",
4
+ "description": "A runtime-extensible JavaScript library for parsing, converting, and manipulating colors with full CSS spec support.",
5
+ "type": "module",
6
+ "private": false,
7
+ "author": "ganemedelabs",
8
+ "license": "MIT",
9
+ "main": "dist/index.js",
10
+ "module": "dist/index.js",
11
+ "types": "dist/index.d.ts",
12
+ "unpkg": "dist/index.umd.js",
13
+ "jsdelivr": "dist/index.umd.js",
14
+ "exports": {
15
+ ".": {
16
+ "import": "./dist/index.js",
17
+ "types": "./dist/index.d.ts"
18
+ },
19
+ "./config": {
20
+ "import": "./dist/config.js",
21
+ "types": "./dist/config.d.ts"
22
+ },
23
+ "./Color": {
24
+ "import": "./dist/Color.js",
25
+ "types": "./dist/Color.d.ts"
26
+ },
27
+ "./types": {
28
+ "import": "./dist/types.js",
29
+ "types": "./dist/types.d.ts"
30
+ },
31
+ "./utils": {
32
+ "import": "./dist/utils.js",
33
+ "types": "./dist/utils.d.ts"
34
+ },
35
+ "./converters": {
36
+ "import": "./dist/converters.js",
37
+ "types": "./dist/converters.d.ts"
38
+ },
39
+ "./math": {
40
+ "import": "./dist/math.js",
41
+ "types": "./dist/math.d.ts"
42
+ }
43
+ },
44
+ "typesVersions": {
45
+ "*": {
46
+ "index.d.ts": [
47
+ "dist/index.d.ts"
48
+ ],
49
+ "config.d.ts": [
50
+ "dist/config.d.ts"
51
+ ],
52
+ "Color.d.ts": [
53
+ "dist/Color.d.ts"
54
+ ],
55
+ "types.d.ts": [
56
+ "dist/types.d.ts"
57
+ ],
58
+ "utils.d.ts": [
59
+ "dist/utils.d.ts"
60
+ ],
61
+ "converters.d.ts": [
62
+ "dist/converters.d.ts"
63
+ ],
64
+ "math.d.ts": [
65
+ "dist/math.d.ts"
66
+ ]
67
+ }
68
+ },
69
+ "sideEffects": false,
70
+ "repository": {
71
+ "type": "git",
72
+ "url": "https://github.com/ganemedelabs/saturon.git"
73
+ },
74
+ "bugs": {
75
+ "url": "https://github.com/ganemedelabs/saturon/issues"
76
+ },
77
+ "homepage": "https://github.com/ganemedelabs/saturon#readme",
78
+ "scripts": {
79
+ "build": "tsc && esbuild dist/index.js --bundle --format=iife --global-name=Saturon --outfile=dist/index.umd.js && esbuild dist/index.js --bundle --minify --format=iife --global-name=Saturon --outfile=dist/index.umd.min.js",
80
+ "test": "jest",
81
+ "lint": "eslint .",
82
+ "lint:fix": "eslint --fix .",
83
+ "format": "prettier --write \"./**/*.{js,ts,json}\""
84
+ },
85
+ "files": [
86
+ "dist",
87
+ "README.md",
88
+ "LICENSE",
89
+ "package.json"
90
+ ],
91
+ "keywords": [
92
+ "color-converter",
93
+ "css-colors",
94
+ "w3c",
95
+ "color",
96
+ "color-base",
97
+ "hex-color",
98
+ "named-color",
99
+ "color-function",
100
+ "light-dark",
101
+ "color-mix",
102
+ "transparent",
103
+ "contrast-color",
104
+ "device-cmyk",
105
+ "currentcolor",
106
+ "system-color"
107
+ ],
108
+ "devDependencies": {
109
+ "@eslint/compat": "^1.4.0",
110
+ "@eslint/eslintrc": "^3.3.1",
111
+ "@eslint/js": "^9.37.0",
112
+ "@types/jest": "^30.0.0",
113
+ "@types/node": "^24.6.2",
114
+ "@typescript-eslint/eslint-plugin": "^8.45.0",
115
+ "@typescript-eslint/parser": "^8.45.0",
116
+ "esbuild": "^0.25.11",
117
+ "eslint": "^9.37.0",
118
+ "eslint-config-prettier": "^10.1.8",
119
+ "eslint-plugin-prettier": "^5.5.4",
120
+ "jest": "^30.2.0",
121
+ "jiti": "^2.6.1",
122
+ "prettier": "^3.6.2",
123
+ "ts-jest": "^29.4.4",
124
+ "ts-node": "^10.9.2",
125
+ "typescript": "^5.9.3"
126
+ }
127
+ }