@thi.ng/color 5.6.54 → 5.7.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-08-10T15:03:07Z
+- **Last updated**: 2024-08-19T13:45:57Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,15 @@ See [Conventional Commits](https://conventionalcommits.org/) for commit guidelin
 **Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
 and/or version bumps of transitive dependencies.
 
+## [5.7.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/color@5.7.0) (2024-08-19)
+
+#### 🚀 Features
+
+- add setDefaultCSSConversions(), update css() ([2d9e505](https://github.com/thi-ng/umbrella/commit/2d9e505))
+  - add setDefaultCSSConversions() to set default CSS color conversion rules
+  - update css() to use current configured default instead of CSS_LEVEL3
+  - add/update docs
+
 ### [5.6.47](https://github.com/thi-ng/umbrella/tree/@thi.ng/color@5.6.47) (2024-06-29)
 
 #### 🩹 Bug fixes

package/README.md

@@ -7,7 +7,7 @@
 [![Mastodon Follow](https://img.shields.io/mastodon/follow/109331703950160316?domain=https%3A%2F%2Fmastodon.thi.ng&style=social)](https://mastodon.thi.ng/@toxi)
 
 > [!NOTE]
-> This is one of 198 standalone projects, maintained as part
+> This is one of 199 standalone projects, maintained as part
 > of the [@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo
 > and anti-framework.
 >

package/css/css.d.ts

@@ -1,12 +1,37 @@
 import type { Fn } from "@thi.ng/api";
 import type { ColorMode, IParsedColor, MaybeColor } from "../api.js";
 export type CSSConversions = Partial<Record<ColorMode, Fn<any, string>>>;
+/**
+ * CSS Color Module Level 3 compatible color conversion rules.
+ *
+ * @remarks
+ * Initial default setting for {@link css}. Also see
+ * {@link setDefaultCSSConversions} to change default.
+ *
+ * Reference:
+ * - https://www.w3.org/TR/css-color-3/
+ */
 export declare const CSS_LEVEL3: CSSConversions;
 /**
  * Extended set of direct CSS conversions for use with CSS Color Module Level 4.
- * Based on {@link CSS_LEVEL3}.
+ * Based on {@link CSS_LEVEL3} and used for {@link css}.
+ *
+ * @remarks
+ * Use {@link setDefaultCSSConversions} to use as default.
+ *
+ * Reference:
+ * - https://www.w3.org/TR/css-color-4/
  */
 export declare const CSS_LEVEL4: CSSConversions;
+/**
+ * Sets the default set of {@link CSSConversions} functions used by {@link css}.
+ * The default is {@link CSS_LEVEL3}, but {@link CSS_LEVEL4} is also available
+ * and will provide better (direct) support for newer color spaces like
+ * {@link lch}, {@link oklab} or {@link oklch}.
+ *
+ * @param fns
+ */
+export declare const setDefaultCSSConversions: (fns: CSSConversions) => Partial<Record<ColorMode, Fn<any, string>>>;
 /**
  * Takes a color in one of the following formats and tries to convert it to a
  * CSS string.
@@ -20,7 +45,8 @@ export declare const CSS_LEVEL4: CSSConversions;
  * - string (passthrough)
  *
  * If CSS Color Module Level 4 support is desired, pass {@link CSS_LEVEL4} as
- * 2nd argument.
+ * 2nd argument or call {@link setDefaultCSSConversions}. If no `cssTarget` is
+ * given, uses current configured default (initially {@link CSS_LEVEL3}).
  *
  * If no direct conversion route for a given source color mode exists, the color
  * will be first converted to sRGB and serialized as such.

package/css/css.js

@@ -34,7 +34,9 @@ const CSS_LEVEL4 = {
   oklab: oklabCss,
   oklch: oklchCss
 };
-const css = (src, cssTarget = CSS_LEVEL3) => {
+let CSS_DEFAULT = CSS_LEVEL3;
+const setDefaultCSSConversions = (fns) => CSS_DEFAULT = fns;
+const css = (src, cssTarget = CSS_DEFAULT) => {
   let asCss;
   return isString(src) ? src : isNumber(src) ? intArgb32Css(src) : src.mode ? (asCss = cssTarget[src.mode]) ? asCss(src) : cssTarget.rgb(
     convert([], src, "rgb", src.mode)
@@ -43,5 +45,6 @@ const css = (src, cssTarget = CSS_LEVEL3) => {
 export {
   CSS_LEVEL3,
   CSS_LEVEL4,
-  css
+  css,
+  setDefaultCSSConversions
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/color",
-  "version": "5.6.54",
+  "version": "5.7.0",
   "description": "Array-based color types, CSS parsing, conversions, transformations, declarative theme generation, gradients, presets",
   "type": "module",
   "module": "./index.js",
@@ -40,19 +40,19 @@
     "tool:tangle": "../../node_modules/.bin/tangle src/**/*.ts"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.11.8",
-    "@thi.ng/arrays": "^2.9.14",
-    "@thi.ng/binary": "^3.4.31",
-    "@thi.ng/checks": "^3.6.10",
-    "@thi.ng/compare": "^2.4.0",
-    "@thi.ng/compose": "^3.0.11",
-    "@thi.ng/defmulti": "^3.0.46",
-    "@thi.ng/errors": "^2.5.14",
-    "@thi.ng/math": "^5.11.7",
-    "@thi.ng/random": "^4.0.2",
-    "@thi.ng/strings": "^3.8.3",
-    "@thi.ng/transducers": "^9.1.0",
-    "@thi.ng/vectors": "^7.11.8"
+    "@thi.ng/api": "^8.11.9",
+    "@thi.ng/arrays": "^2.10.0",
+    "@thi.ng/binary": "^3.4.32",
+    "@thi.ng/checks": "^3.6.11",
+    "@thi.ng/compare": "^2.4.1",
+    "@thi.ng/compose": "^3.0.12",
+    "@thi.ng/defmulti": "^3.0.47",
+    "@thi.ng/errors": "^2.5.15",
+    "@thi.ng/math": "^5.11.8",
+    "@thi.ng/random": "^4.0.3",
+    "@thi.ng/strings": "^3.8.4",
+    "@thi.ng/transducers": "^9.2.0",
+    "@thi.ng/vectors": "^7.11.10"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.47.5",
@@ -444,5 +444,5 @@
       "vectors"
     ]
   },
-  "gitHead": "e914ebbd81c56783c39cf746548c547cbacadc96\n"
+  "gitHead": "bfbc227cf5ca2d3c2984b3d4713eebd6225cbd54\n"
 }