@thi.ng/color-palettes 1.0.6 → 1.0.8

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2023-03-02T18:09:03Z
+- **Last updated**: 2023-03-14T13:27:19Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/color-palettes",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "description": "Collection of 200+ image based color themes & composable theme query filters",
   "type": "module",
   "module": "./index.js",
@@ -25,7 +25,7 @@
   "license": "Apache-2.0",
   "scripts": {
     "build": "yarn clean && tsc --declaration",
-    "clean": "rimraf '*.js' '*.d.ts' '*.map' doc",
+    "clean": "rimraf --glob '*.js' '*.d.ts' '*.map' doc",
     "doc": "typedoc --excludePrivate --excludeInternal --out doc src/index.ts",
     "doc:ae": "mkdir -p .ae/doc .ae/temp && api-extractor run --local --verbose",
     "doc:readme": "yarn doc:stats && tools:readme",
@@ -36,19 +36,19 @@
     "tool:swatches": "tools:node-esm tools/swatches.ts"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.7.3",
-    "@thi.ng/base-n": "^2.4.2",
-    "@thi.ng/checks": "^3.3.9",
-    "@thi.ng/color": "^5.4.2",
-    "@thi.ng/errors": "^2.2.12",
-    "@thi.ng/hex": "^2.3.6"
+    "@thi.ng/api": "^8.7.4",
+    "@thi.ng/base-n": "^2.4.3",
+    "@thi.ng/checks": "^3.3.10",
+    "@thi.ng/color": "^5.4.4",
+    "@thi.ng/errors": "^2.2.13",
+    "@thi.ng/hex": "^2.3.7"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.34.2",
-    "@thi.ng/testament": "^0.3.11",
-    "rimraf": "^4.1.2",
+    "@microsoft/api-extractor": "^7.34.4",
+    "@thi.ng/testament": "^0.3.13",
+    "rimraf": "^4.4.0",
     "tools": "^0.0.1",
-    "typedoc": "^0.23.24",
+    "typedoc": "^0.23.26",
     "typescript": "^4.9.5"
   },
   "keywords": [
@@ -90,5 +90,5 @@
     "parent": "@thi.ng/color",
     "year": 2021
   },
-  "gitHead": "8342900eedc77bb09edb8c544804578b71f8acc6\n"
+  "gitHead": "cc46c097a3a173fb1ef41f57a858d03037063141\n"
 }

package/query.d.ts

@@ -1,106 +0,0 @@
-import type { ColorPredicate, 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
- * {@link Theme} and returns true iff the given predicate succeeds for at least
- * `threshold` colors in the theme (all colors by default).
- *
- * @param pred
- * @param threshold
- */
-export declare const defFilter: (pred: ColorPredicate, threshold?: number) => ThemePredicate;
-/**
- * Higher order theme filter. Takes a number of theme predicate (e.g. those
- * provided by this package) and returns new predicate function which only
- * succeeds if *all* given predicates pass.
- *
- * @example
- * ```ts
- * // compose combined query filter
- * const pastels = comp(
- *   // require all theme colors to max 25% chroma
- *   filterChroma(0, 0.25),
- *   // require at least 3 theme colors to be min 50% luma
- *   filterLuma(0.5, 1, 3)
- * );
- *
- * [...cssThemes()].filter(pastels)
- * // [
- * //   [ '#453f38', '#746b5d', '#b39777', '#c1c2b2', '#e3dccf', '#f1ede7' ],
- * //   [ '#857b84', '#b1a7b0', '#d0c7d0', '#e7e0e8', '#faeceb', '#e4e9fa' ]
- * // ]
- * ```
- *
- * @param filters
-= */
-export declare const comp: (...filters: ThemePredicate[]) => ThemePredicate;
-/**
- * Theme predicate which ensures colors are within the given normalized hue
- * range ([0..1] interval). See {@link defFilter} for more details.
- *
- * @remarks
- * Internally converts colors to LCH (unless already the case). Therefore also
- * uses LCH hues (which are slightly offset compared to HSV/HSL).
- *
- * If `max < min`, the filter will consider hues in both the `[min..1] and
- * [0..max]` intervals (i.e. angular wraparound on color wheel).
- *
- * @param min
- * @param max
- * @param threshold
- */
-export declare const filterHue: (min: number, max: number, threshold?: number) => ThemePredicate;
-/**
- * Theme predicate which ensures colors are within the given normalized chroma
- * range ([0..1] interval). See {@link defFilter} for more details.
- *
- * @remarks
- * Internally converts colors to LCH (unless already the case).
- *
- * @param min
- * @param max
- * @param threshold
- */
-export declare const filterChroma: (min: number, max: number, threshold?: number) => ThemePredicate;
-/**
- * Theme predicate which ensures colors are within the given normalized
- * luminance range ([0..1] interval). See {@link defFilter} for more details.
- *
- * @param min
- * @param max
- * @param threshold
- */
-export declare const filterLuma: (min: number, max: number, threshold?: number) => ThemePredicate;
-/**
- * Theme predicate which ensures colors are within the given normalized distance
- * in LCH space.
- *
- * @remarks
- * Internally converts colors to LCH (unless already the case).
- *
- * See {@link defFilter} &
- * [`distLch()`](https://docs.thi.ng/umbrella/color/functions/distLch.html) for
- * more details.
- *
- * @param min
- * @param max
- * @param threshold
- */
-export declare const filterProximityLCH: (color: ThemeColor, eps: number, threshold?: number) => ThemePredicate;
-/**
- * Theme predicate which ensures colors are within the given normalized distance
- * in RGB space.
- *
- * @remarks
- * Internally converts colors to sRGB (unless already the case).
- *
- * See {@link defFilter} &
- * [`distEucledian3()`](https://docs.thi.ng/umbrella/color/functions/distEucledian3.html)
- * for more details.
- *
- * @param min
- * @param max
- * @param threshold
- */
-export declare const filterProximityRGB: (color: ThemeColor, eps: number, threshold?: number) => ThemePredicate;
-//# sourceMappingURL=query.d.ts.map

package/query.js

@@ -1,135 +0,0 @@
-import { distEucledian3, distLch } from "@thi.ng/color/distance";
-import { lch } from "@thi.ng/color/lch/lch";
-import { luminance } from "@thi.ng/color/luminance";
-import { srgb } from "@thi.ng/color/srgb/srgb";
-/**
- * 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
- * {@link Theme} and returns true iff the given predicate succeeds for at least
- * `threshold` colors in the theme (all colors by default).
- *
- * @param pred
- * @param threshold
- */
-export const defFilter = (pred, threshold) => (theme) => {
-    const $thresh = threshold ?? theme.length;
-    for (let i = theme.length, n = 0; i-- > 0;) {
-        if (pred(theme[i])) {
-            if (++n >= $thresh)
-                return true;
-        }
-    }
-    return false;
-};
-/**
- * Higher order theme filter. Takes a number of theme predicate (e.g. those
- * provided by this package) and returns new predicate function which only
- * succeeds if *all* given predicates pass.
- *
- * @example
- * ```ts
- * // compose combined query filter
- * const pastels = comp(
- *   // require all theme colors to max 25% chroma
- *   filterChroma(0, 0.25),
- *   // require at least 3 theme colors to be min 50% luma
- *   filterLuma(0.5, 1, 3)
- * );
- *
- * [...cssThemes()].filter(pastels)
- * // [
- * //   [ '#453f38', '#746b5d', '#b39777', '#c1c2b2', '#e3dccf', '#f1ede7' ],
- * //   [ '#857b84', '#b1a7b0', '#d0c7d0', '#e7e0e8', '#faeceb', '#e4e9fa' ]
- * // ]
- * ```
- *
- * @param filters
-= */
-export const comp = (...filters) => (theme) => filters.every((f) => f(theme));
-/**
- * Theme predicate which ensures colors are within the given normalized hue
- * range ([0..1] interval). See {@link defFilter} for more details.
- *
- * @remarks
- * Internally converts colors to LCH (unless already the case). Therefore also
- * uses LCH hues (which are slightly offset compared to HSV/HSL).
- *
- * If `max < min`, the filter will consider hues in both the `[min..1] and
- * [0..max]` intervals (i.e. angular wraparound on color wheel).
- *
- * @param min
- * @param max
- * @param threshold
- */
-export const filterHue = (min, max, threshold) => defFilter((col) => {
-    let hue = __isLCH(col) ? col[2] : lch(col)[2];
-    hue = hue - Math.floor(hue);
-    return min <= max ? hue >= min && hue <= max : hue >= min || hue <= max;
-}, threshold);
-/**
- * Theme predicate which ensures colors are within the given normalized chroma
- * range ([0..1] interval). See {@link defFilter} for more details.
- *
- * @remarks
- * Internally converts colors to LCH (unless already the case).
- *
- * @param min
- * @param max
- * @param threshold
- */
-export const filterChroma = (min, max, threshold) => defFilter((col) => {
-    const sat = __isLCH(col) ? col[1] : lch(col)[1];
-    return sat >= min && sat <= max;
-}, threshold);
-/**
- * Theme predicate which ensures colors are within the given normalized
- * luminance range ([0..1] interval). See {@link defFilter} for more details.
- *
- * @param min
- * @param max
- * @param threshold
- */
-export const filterLuma = (min, max, threshold) => defFilter((col) => {
-    const l = luminance(col);
-    return l >= min && l <= max;
-}, threshold);
-/**
- * Theme predicate which ensures colors are within the given normalized distance
- * in LCH space.
- *
- * @remarks
- * Internally converts colors to LCH (unless already the case).
- *
- * See {@link defFilter} &
- * [`distLch()`](https://docs.thi.ng/umbrella/color/functions/distLch.html) for
- * more details.
- *
- * @param min
- * @param max
- * @param threshold
- */
-export const filterProximityLCH = (color, eps, threshold) => {
-    const $color = __isLCH(color) ? color : lch(color);
-    return defFilter((x) => distLch($color, __isLCH(x) ? x : lch(x)) < eps, threshold);
-};
-/**
- * Theme predicate which ensures colors are within the given normalized distance
- * in RGB space.
- *
- * @remarks
- * Internally converts colors to sRGB (unless already the case).
- *
- * See {@link defFilter} &
- * [`distEucledian3()`](https://docs.thi.ng/umbrella/color/functions/distEucledian3.html)
- * for more details.
- *
- * @param min
- * @param max
- * @param threshold
- */
-export const filterProximityRGB = (color, eps, threshold) => {
-    const $color = __isRGB(color) ? color : srgb(color);
-    return defFilter((x) => distEucledian3($color, __isRGB(x) ? x : srgb(x)) < eps, threshold);
-};
-const __isLCH = (x) => typeof x !== "string" && x.mode === "lch";
-const __isRGB = (x) => typeof x !== "string" && x.mode === "srgb";

package/themes.d.ts

@@ -1,3 +0,0 @@
-export declare const themeAsSRGB: (id: number) => number[][];
-export declare const themeAsCSS: (id: number) => string[];
-//# sourceMappingURL=themes.d.ts.map

package/themes.js

@@ -1,24 +0,0 @@
-import { U24 } from "@thi.ng/hex";
-import { BINARY } from "./binary.js";
-export const themeAsSRGB = (id) => {
-    const theme = [];
-    id *= 18;
-    for (let i = 0; i < 6; i++, id += 3) {
-        theme.push([
-            BINARY[id] / 255,
-            BINARY[id + 1] / 255,
-            BINARY[id + 2] / 255,
-            1,
-        ]);
-    }
-    return theme;
-};
-export const themeAsCSS = (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]));
-    }
-    return theme;
-};