@thi.ng/color-palettes 1.3.0 → 1.4.1

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-06-21T19:34:38Z
+- **Last updated**: 2024-07-06T12:02:18Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,14 @@ 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.
 
+## [1.4.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/color-palettes@1.4.0) (2024-06-29)
+
+#### 🚀 Features
+
+- add filteredThemes() ([58a9712](https://github.com/thi-ng/umbrella/commit/58a9712))
+- update asCSS/Int/LCH/RGB() args ([9aa2f43](https://github.com/thi-ng/umbrella/commit/9aa2f43))
+  - accept existing themes (array of colors) as arg (in addition to theme IDs)
+
 ## [1.3.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/color-palettes@1.3.0) (2024-06-21)
 
 #### 🚀 Features

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 193 standalone projects, maintained as part
+> This is one of 188 standalone projects, maintained as part
 > of the [@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo
 > and anti-framework.
 >
@@ -281,7 +281,7 @@ For Node.js REPL:
 const cp = await import("@thi.ng/color-palettes");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 4.80 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 4.92 KB
 
 ## Dependencies
 

package/filter.d.ts

@@ -1,4 +1,4 @@
-import type { ColorPredicate, ThemeColor, ThemePredicate } from "./api.js";
+import type { ColorPredicate, Theme, ThemeColor, ThemePredicate } from "./api.js";
 /**
  * Higher order theme filter. Takes a predicate function which will be applied
  * to a single {@link ThemeColor}. Returns a new function which accepts a single
@@ -106,4 +106,20 @@ export declare const proximityLCH: (color: ThemeColor, eps: number, threshold?:
  * @param threshold
  */
 export declare const proximityRGB: (color: ThemeColor, eps: number, threshold?: number) => ThemePredicate;
+/**
+ * Similar to {@link rgbThemes}, {@link themeIDs} etc., but for filtering custom
+ * themes (i.e. arrays of colors), using provided filter predicate(s) or theme
+ * indices. This way the composable filter predicates of this package can also
+ * be used for user-defined themes (i.e. not limited to those presets included
+ * in this package)
+ *
+ * @remarks
+ * If `idOnly` is enabled/true, only the IDs/indices of matching themes are
+ * returned (rather than the corresponding themes themselves).
+ *
+ * @param preds
+ * @param themes
+ */
+export declare function filteredThemes<T extends Theme>(preds: ThemePredicate[] | number[], themes: T[]): IterableIterator<T>;
+export declare function filteredThemes<T extends Theme>(preds: ThemePredicate[] | number[], themes: T[], idOnly: true): IterableIterator<number>;
 //# sourceMappingURL=filter.d.ts.map

package/filter.js

@@ -44,10 +44,22 @@ const proximityRGB = (color, eps, threshold) => {
 };
 const __isLCH = (x) => !isPrimitive(x) && x.mode === "lch";
 const __isRGB = (x) => !isPrimitive(x) && x.mode === "srgb";
+function* filteredThemes(preds, themes, idOnly = false) {
+  if (preds.length && typeof preds[0] === "function") {
+    const pred = compFilter(...preds);
+    for (let i = 0; i < themes.length; i++) {
+      const theme = themes[i];
+      if (pred(theme)) yield idOnly ? i : theme;
+    }
+  } else {
+    for (let id of preds) yield idOnly ? id : themes[id];
+  }
+}
 export {
   chroma,
   compFilter,
   defFilter,
+  filteredThemes,
   hue,
   luma,
   proximityLCH,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/color-palettes",
-  "version": "1.3.0",
+  "version": "1.4.1",
   "description": "Collection of 200+ image based color themes & composable theme query filters",
   "type": "module",
   "module": "./index.js",
@@ -38,18 +38,18 @@
     "tool:tangle": "../../node_modules/.bin/tangle src/**/*.ts"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.11.3",
-    "@thi.ng/base-n": "^2.7.15",
-    "@thi.ng/checks": "^3.6.5",
-    "@thi.ng/color": "^5.6.46",
-    "@thi.ng/errors": "^2.5.8",
-    "@thi.ng/hex": "^2.3.47"
+    "@thi.ng/api": "^8.11.5",
+    "@thi.ng/base-n": "^2.7.17",
+    "@thi.ng/checks": "^3.6.7",
+    "@thi.ng/color": "^5.6.48",
+    "@thi.ng/errors": "^2.5.10",
+    "@thi.ng/hex": "^2.3.49"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.47.0",
-    "esbuild": "^0.21.5",
-    "typedoc": "^0.25.13",
-    "typescript": "^5.5.2"
+    "esbuild": "^0.23.0",
+    "typedoc": "^0.26.3",
+    "typescript": "^5.5.3"
   },
   "keywords": [
     "css",
@@ -90,5 +90,5 @@
     "parent": "@thi.ng/color",
     "year": 2021
   },
-  "gitHead": "154c95cf9d6bab32174498ec3b5b5d87e42be7f9\n"
+  "gitHead": "70f493d9ccc97c5df5dda7e808e96cd1691097fc\n"
 }

package/theme.d.ts

@@ -1,37 +1,44 @@
-import type { LCHTheme, RGBTheme, ThemePredicate } from "./api.js";
+import type { LCHTheme, RGBTheme, Theme, ThemePredicate } from "./api.js";
 /**
- * Returns theme for given ID as CSS hex colors. If `reverse` is true (default:
- * false), the theme colors will be returned in reverse order.
+ * Returns given `theme` (array of colors or theme preset ID) as CSS hex colors.
+ * If `reverse` is true (default: false), the theme colors will be returned in
+ * reverse order.
  *
- * @param id
+ * @param theme
  * @param reverse
  */
-export declare const asCSS: (id: number, reverse?: boolean) => string[];
+export declare const asCSS: (theme: number | Theme, reverse?: boolean) => string[];
 /**
- * Returns theme for given ID as packed ARGB integers (alpha channel will always
- * be set to 0xff). If `reverse` is true (default: false), the theme colors will
- * be returned in reverse order.
+ * Returns given `theme` (array of colors or theme preset ID) as packed ARGB
+ * integers. If `reverse` is true (default: false), the theme colors will be
+ * returned in reverse order.
  *
- * @param id
+ * @remarks
+ * If given a theme ID, the alpha channel of all colors will always be set to
+ * `0xff`.
+ *
+ * @param theme
  * @param reverse
  */
-export declare const asInt: (id: number, reverse?: boolean) => number[];
+export declare const asInt: (theme: number | Theme, reverse?: boolean) => number[];
 /**
- * Returns theme for given ID as thi.ng/color LCH color vectors. If `reverse` is
- * true (default: false), the theme colors will be returned in reverse order.
+ * Returns given `theme` (array of colors or theme preset ID) as thi.ng/color
+ * LCH color vectors. If `reverse` is true (default: false), the theme colors
+ * will be returned in reverse order.
  *
- * @param id
+ * @param theme
  * @param reverse
  */
-export declare const asLCH: (id: number, reverse?: boolean) => LCHTheme;
+export declare const asLCH: (theme: number | Theme, reverse?: boolean) => LCHTheme;
 /**
- * Returns theme for given ID as thi.ng/color sRGB color vectors. If `reverse`
- * is true (default: false), the theme colors will be returned in reverse order.
+ * Returns given `theme` (array of colors or theme preset ID) sRGB color
+ * vectors. If `reverse` is true (default: false), the theme colors will be
+ * returned in reverse order.
  *
- * @param id
+ * @param theme
  * @param reverse
  */
-export declare const asRGB: (id: number, reverse?: boolean) => RGBTheme;
+export declare const asRGB: (theme: number | Theme, reverse?: boolean) => RGBTheme;
 /**
  * Yields iterator of CSS themes (via {@link asCSS}). Yields all
  * themes unless specific theme IDs or filter predicates are provided.

package/theme.js

@@ -1,47 +1,67 @@
+import { isNumber } from "@thi.ng/checks/is-number";
+import { css } from "@thi.ng/color/css/css";
+import { argb32 } from "@thi.ng/color/int/int";
 import { lch } from "@thi.ng/color/lch/lch";
 import { srgb } from "@thi.ng/color/srgb/srgb";
 import { assert } from "@thi.ng/errors/assert";
 import { U24 } from "@thi.ng/hex";
 import { BINARY, NUM_THEMES } from "./binary.js";
 import { compFilter } from "./filter.js";
-const asCSS = (id, reverse = false) => {
-  __ensureID(id);
-  const theme = [];
-  id *= 18;
-  for (let i = 0; i < 6; i++, id += 3) {
-    theme.push(
-      "#" + U24(BINARY[id] << 16 | BINARY[id + 1] << 8 | BINARY[id + 2])
-    );
+const asCSS = (theme, reverse = false) => {
+  let res;
+  if (isNumber(theme)) {
+    __ensureID(theme);
+    theme *= 18;
+    res = [];
+    for (let i = 0; i < 6; i++, theme += 3) {
+      res.push("#" + U24(__read(theme)));
+    }
+  } else {
+    res = theme.map((x) => css(x));
+  }
+  return reverse ? res.reverse() : res;
+};
+const asInt = (theme, reverse = false) => {
+  let res;
+  if (isNumber(theme)) {
+    __ensureID(theme);
+    theme *= 18;
+    res = [];
+    for (let i = 0; i < 6; i++, theme += 3) {
+      res.push(__read(theme));
+    }
+  } else {
+    res = theme.map((x) => argb32(x).deref()[0]);
   }
-  return reverse ? theme.reverse() : theme;
+  return reverse ? res.reverse() : res;
 };
-const asInt = (id, reverse = false) => {
-  __ensureID(id);
-  const theme = [];
-  id *= 18;
-  for (let i = 0; i < 6; i++, id += 3) {
-    theme.push(
-      (4278190080 | BINARY[id] << 16 | BINARY[id + 1] << 8 | BINARY[id + 2]) >>> 0
-    );
+const asLCH = (theme, reverse = false) => {
+  if (isNumber(theme)) {
+    return asRGB(theme, reverse).map((x) => lch(x));
   }
-  return reverse ? theme.reverse() : theme;
+  const res = theme.map((x) => lch(x));
+  return reverse ? res.reverse() : res;
 };
-const asLCH = (id, reverse = false) => asRGB(id, reverse).map((x) => lch(x));
-const asRGB = (id, reverse = false) => {
-  __ensureID(id);
-  const theme = [];
-  id *= 18;
-  for (let i = 0; i < 6; i++, id += 3) {
-    theme.push(
-      srgb(
-        BINARY[id] / 255,
-        BINARY[id + 1] / 255,
-        BINARY[id + 2] / 255,
-        1
-      )
-    );
+const asRGB = (theme, reverse = false) => {
+  let res;
+  if (isNumber(theme)) {
+    __ensureID(theme);
+    theme *= 18;
+    res = [];
+    for (let i = 0; i < 6; i++, theme += 3) {
+      res.push(
+        srgb(
+          BINARY[theme] / 255,
+          BINARY[theme + 1] / 255,
+          BINARY[theme + 2] / 255,
+          1
+        )
+      );
+    }
+  } else {
+    res = theme.map((x) => srgb(x));
   }
-  return reverse ? theme.reverse() : theme;
+  return reverse ? res.reverse() : res;
 };
 const cssThemes = (...preds) => __themes(asCSS, preds);
 const intThemes = (...preds) => __themes(asInt, preds);
@@ -62,6 +82,7 @@ function* __themes(fn, preds, idOnly = false) {
   }
 }
 const __ensureID = (id) => assert(id >= 0 && id < NUM_THEMES, `invalid theme ID`);
+const __read = (i) => (4278190080 | BINARY[i] << 16 | BINARY[i + 1] << 8 | BINARY[i + 2]) >>> 0;
 export {
   asCSS,
   asInt,