@thi.ng/color 5.0.2 → 5.1.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2022-04-07T14:17:30Z
+- **Last updated**: 2022-06-09T16:14:01Z
 - **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.
 
+## [5.1.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/color@5.1.0) (2022-06-09)
+
+#### 🚀 Features
+
+- update multiColorGradient() ([f47a59d](https://github.com/thi-ng/umbrella/commit/f47a59d))
+  - add support for automatic conversion to packed ARGB/ABGR ints
+    (for use with indexed color models in [@thi.ng/pixel](https://github.com/thi-ng/umbrella/tree/main/packages/pixel))
+
 # [5.0.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/color@5.0.0) (2022-03-11)
 
 #### 🛑 Breaking changes

package/color-range.d.ts

@@ -26,7 +26,7 @@ export declare const COLOR_RANGES: Record<ColorRangePreset, ColorRange>;
  * @param range -
  * @param opts -
  */
-export declare const colorFromRange: (range: ColorRange | keyof typeof COLOR_RANGES, opts?: Partial<Pick<ColorRangeOpts, "variance" | "eps" | "rnd">> | undefined) => LCH;
+export declare const colorFromRange: (range: ColorRange | keyof typeof COLOR_RANGES, opts?: Partial<Pick<ColorRangeOpts, "variance" | "eps" | "rnd">>) => LCH;
 /**
  * Generator version of {@link colorFromRange}, by default yielding an infinite
  * sequence of random colors based on given range, base color (optional) and

package/cosine-gradients.d.ts

@@ -32,7 +32,7 @@ export declare const cosineColor: (spec: CosGradientSpec, t: number) => Color;
  * @param spec -
  * @param tx -
  */
-export declare const cosineGradient: (n: number, spec: CosGradientSpec, tx?: FnU<import("@thi.ng/vectors").Vec, import("@thi.ng/vectors").Vec> | undefined) => Color[];
+export declare const cosineGradient: (n: number, spec: CosGradientSpec, tx?: FnU<Color>) => Color[];
 /**
  * Similar to {@link cosineGradient}, but writes results into `buffer` from
  * given `offset` and component/element strides. Returns buffer.

package/gradients.d.ts

@@ -3,7 +3,10 @@ import type { TypedColor } from "./api.js";
 import type { GradientOpts } from "./api/gradients.js";
 /**
  * Similar to {@link multiCosineGradient}, but using any number of gradient
- * color stops and isn't limited to RGB, but for arbitrary color types.
+ * color stops and isn't limited to RGB, but for arbitrary color types. The
+ * optional `isABGR` boolean arg can be used to autoconvert resulting colors
+ * into packed ARGB (false) or ABGR (true) integers. If that arg is given, an
+ * array of numbers will be returned.
  *
  * @remarks
  * @see {@link @thi.ng/transducers#tween}
@@ -38,8 +41,10 @@ import type { GradientOpts } from "./api/gradients.js";
  * ```
  *
  * @param opts -
+ * @param isABGR -
  */
-export declare const multiColorGradient: <T extends TypedColor<any>>(opts: GradientOpts<T>) => T[];
+export declare function multiColorGradient<T extends TypedColor<any>>(opts: GradientOpts<T>): T[];
+export declare function multiColorGradient<T extends TypedColor<any>>(opts: GradientOpts<T>, isABGR: boolean): number[];
 /**
  * Similar to {@link multiColorGradient}, but writes results into `buffer` from
  * given `offset` and component/element strides. Returns buffer.

package/gradients.js

@@ -1,45 +1,15 @@
 import { tween } from "@thi.ng/transducers/tween";
 import { setS4 } from "@thi.ng/vectors/sets";
+import { intArgb32Abgr32 } from "./int/int-int.js";
+import { argb32 } from "./int/int.js";
 import { mix as $mix } from "./mix.js";
-/**
- * Similar to {@link multiCosineGradient}, but using any number of gradient
- * color stops and isn't limited to RGB, but for arbitrary color types.
- *
- * @remarks
- * @see {@link @thi.ng/transducers#tween}
- *
- * @example
- * ```ts
- * gradient = multiColorGradient({
- *   num: 100,
- *   // LAB color stops
- *   stops: [
- *     // pink red
- *     [0, lch(0.8, 0.8, 0)],
- *     // green
- *     [1 / 3, lch(0.8, 0.8, 1 / 3)],
- *     // blue
- *     [2 / 3, lch(0.8, 0.8, 2 / 3)],
- *     // gray
- *     [1, lch(0.8, 0, 1)],
- *   ]
- * });
- *
- * // write gradient as SVG swatches
- * writeFileSync(
- *   `export/lch-multigradient.svg`,
- *   serialize(
- *     svg(
- *       { width: 500, height: 50, convert: true },
- *       swatchesH(gradient, 5, 50)
- *     )
- *   )
- * );
- * ```
- *
- * @param opts -
- */
-export const multiColorGradient = (opts) => [...gradient(opts)];
+export function multiColorGradient(opts, isABGR) {
+    const cols = [...gradient(opts)];
+    if (isABGR === undefined)
+        return cols;
+    const rgba = cols.map((x) => argb32(x)[0]);
+    return isABGR ? rgba.map(intArgb32Abgr32) : rgba;
+}
 /**
  * Similar to {@link multiColorGradient}, but writes results into `buffer` from
  * given `offset` and component/element strides. Returns buffer.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/color",
-  "version": "5.0.2",
+  "version": "5.1.0",
   "description": "Array-based color types, CSS parsing, conversions, transformations, declarative theme generation, gradients, presets",
   "type": "module",
   "module": "./index.js",
@@ -36,27 +36,27 @@
     "tool:swatches": "tools:node-esm tools/index.ts"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.3.5",
-    "@thi.ng/arrays": "^2.2.1",
-    "@thi.ng/binary": "^3.2.1",
-    "@thi.ng/checks": "^3.1.5",
-    "@thi.ng/compare": "^2.1.5",
-    "@thi.ng/compose": "^2.1.5",
-    "@thi.ng/defmulti": "^2.1.5",
-    "@thi.ng/errors": "^2.1.5",
-    "@thi.ng/math": "^5.3.1",
-    "@thi.ng/random": "^3.2.5",
-    "@thi.ng/strings": "^3.3.3",
-    "@thi.ng/transducers": "^8.3.1",
-    "@thi.ng/vectors": "^7.5.2"
+    "@thi.ng/api": "^8.3.7",
+    "@thi.ng/arrays": "^2.2.4",
+    "@thi.ng/binary": "^3.2.3",
+    "@thi.ng/checks": "^3.2.0",
+    "@thi.ng/compare": "^2.1.7",
+    "@thi.ng/compose": "^2.1.7",
+    "@thi.ng/defmulti": "^2.1.7",
+    "@thi.ng/errors": "^2.1.7",
+    "@thi.ng/math": "^5.3.3",
+    "@thi.ng/random": "^3.3.1",
+    "@thi.ng/strings": "^3.3.5",
+    "@thi.ng/transducers": "^8.3.4",
+    "@thi.ng/vectors": "^7.5.5"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.19.4",
-    "@thi.ng/testament": "^0.2.5",
+    "@microsoft/api-extractor": "^7.25.0",
+    "@thi.ng/testament": "^0.2.8",
     "rimraf": "^3.0.2",
     "tools": "^0.0.1",
-    "typedoc": "^0.22.13",
-    "typescript": "^4.6.2"
+    "typedoc": "^0.22.17",
+    "typescript": "^4.7.3"
   },
   "keywords": [
     "color",
@@ -421,5 +421,5 @@
       "vectors"
     ]
   },
-  "gitHead": "542bf14bd0c7a56b4e6297718189eea772a824b7\n"
+  "gitHead": "9e516d30a1a537e027a6b3d78bf9121bc5831d31\n"
 }

package/strategies.d.ts

@@ -7,7 +7,7 @@ import { LCH } from "./lch/lch.js";
  * @param deltaL -
  * @param deltaC -
  */
-export declare const complementaryStrategy: (src: LCH, deltaL?: number | undefined, deltaC?: number | undefined) => LCH[];
+export declare const complementaryStrategy: (src: LCH, deltaL?: number, deltaC?: number) => LCH[];
 /**
  * Returns array of `src` color and 2 neighboring colors, each ±rotated by
  * normalized `theta` and possibly adjusted via optional `deltaL` and `deltaC`
@@ -18,7 +18,7 @@ export declare const complementaryStrategy: (src: LCH, deltaL?: number | undefin
  * @param deltaL -
  * @param deltaC -
  */
-export declare const analogStrategy: (src: LCH, theta?: number, deltaL?: number | undefined, deltaC?: number | undefined) => LCH[];
+export declare const analogStrategy: (src: LCH, theta?: number, deltaL?: number, deltaC?: number) => LCH[];
 /**
  * Similar to {@link splitComplementaryStrategy}. Returns array of `src` color,
  * its complementary color and 2 of that colors' neighbors, each ±rotated by
@@ -30,7 +30,7 @@ export declare const analogStrategy: (src: LCH, theta?: number, deltaL?: number
  * @param deltaL -
  * @param deltaC -
  */
-export declare const splitAnalogStrategy: (src: LCH, theta?: number, deltaL?: number | undefined, deltaC?: number | undefined) => LCH[];
+export declare const splitAnalogStrategy: (src: LCH, theta?: number, deltaL?: number, deltaC?: number) => LCH[];
 /**
  * Similar to {@link splitAnalogStrategy}. Returns array of `src` color and 2
  * neighbors of its complementary color, each ±rotated by normalized `theta`
@@ -42,7 +42,7 @@ export declare const splitAnalogStrategy: (src: LCH, theta?: number, deltaL?: nu
  * @param deltaL -
  * @param deltaC -
  */
-export declare const splitComplementaryStrategy: (src: LCH, theta?: number, deltaL?: number | undefined, deltaC?: number | undefined) => LCH[];
+export declare const splitComplementaryStrategy: (src: LCH, theta?: number, deltaL?: number, deltaC?: number) => LCH[];
 /**
  * Returns array of 5 colors all sharing same hue and chromacity of given `src`
  * color, but with these luminance settings: 0.0, 0.25, 0.5, 0.75, 1.0. Chroma
@@ -62,7 +62,7 @@ export declare const monochromeStrategy: (src: LCH, deltaC?: number) => LCH[];
  * @param deltaL -
  * @param deltaC -
  */
-export declare const triadicStrategy: (src: LCH, deltaL?: number | undefined, deltaC?: number | undefined) => LCH[];
+export declare const triadicStrategy: (src: LCH, deltaL?: number, deltaC?: number) => LCH[];
 /**
  * Returns array of `src` color and 3 other colors whose hues form a rectangle,
  * using `theta` to define the angular separation. The hues are at: `src`,
@@ -75,7 +75,7 @@ export declare const triadicStrategy: (src: LCH, deltaL?: number | undefined, de
  * @param deltaL -
  * @param deltaC -
  */
-export declare const tetradicStrategy: (src: LCH, theta?: number, deltaL?: number | undefined, deltaC?: number | undefined) => LCH[];
+export declare const tetradicStrategy: (src: LCH, theta?: number, deltaL?: number, deltaC?: number) => LCH[];
 /**
  * Version of {@link tetradicStrategy} with an hardcoded `theta` of 1/4 to
  * produce 4 colors with hues uniformly distributed on the color wheel (possibly
@@ -86,5 +86,5 @@ export declare const tetradicStrategy: (src: LCH, theta?: number, deltaL?: numbe
  * @param deltaL -
  * @param deltaC -
  */
-export declare const squareStrategy: (src: LCH, deltaL?: number | undefined, deltaC?: number | undefined) => LCH[];
+export declare const squareStrategy: (src: LCH, deltaL?: number, deltaC?: number) => LCH[];
 //# sourceMappingURL=strategies.d.ts.map

package/swatches.d.ts

@@ -1,8 +1,8 @@
 import type { Fn2, IObjectOf } from "@thi.ng/api";
 import type { ReadonlyColor } from "./api.js";
 export declare const swatches: (cols: (ReadonlyColor | string)[], shapeFn: Fn2<ReadonlyColor | string, number, any[]>, attribs?: IObjectOf<any>) => (string | IObjectOf<any>)[];
-export declare const swatchesH: (cols: (ReadonlyColor | string)[], w?: number, h?: number, gap?: number, attribs?: IObjectOf<any> | undefined) => (string | IObjectOf<any>)[];
-export declare const dotsH: (cols: (ReadonlyColor | string)[], r?: number, gap?: number, attribs?: IObjectOf<any> | undefined) => (string | IObjectOf<any>)[];
+export declare const swatchesH: (cols: (ReadonlyColor | string)[], w?: number, h?: number, gap?: number, attribs?: IObjectOf<any>) => (string | IObjectOf<any>)[];
+export declare const dotsH: (cols: (ReadonlyColor | string)[], r?: number, gap?: number, attribs?: IObjectOf<any>) => (string | IObjectOf<any>)[];
 export declare const swatchesV: (cols: (ReadonlyColor | string)[], w?: number, h?: number, gap?: number, attribs?: IObjectOf<any>) => (string | IObjectOf<any>)[];
-export declare const dotsV: (cols: (ReadonlyColor | string)[], r?: number, gap?: number, attribs?: IObjectOf<any> | undefined) => (string | IObjectOf<any>)[];
+export declare const dotsV: (cols: (ReadonlyColor | string)[], r?: number, gap?: number, attribs?: IObjectOf<any>) => (string | IObjectOf<any>)[];
 //# sourceMappingURL=swatches.d.ts.map