@thi.ng/imago 0.6.11 → 0.7.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-03-27T09:53:45Z
+- **Last updated**: 2024-04-01T13:12:06Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,12 @@ 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.
 
+## [0.7.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/imago@0.7.0) (2024-04-01)
+
+#### 🚀 Features
+
+- add ICC profile assignment op ([5d022cb](https://github.com/thi-ng/umbrella/commit/5d022cb))
+
 ## [0.6.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/imago@0.6.0) (2024-03-06)
 
 #### 🚀 Features

package/README.md

@@ -32,6 +32,7 @@
   - [gamma](#gamma)
   - [grayscale](#grayscale)
   - [hsbl](#hsbl)
+  - [icc](#icc)
   - [nest](#nest)
   - [output](#output)
     - [Templated output paths](#templated-output-paths)
@@ -227,6 +228,12 @@ Grayscale conversion
 
 Hue, saturation, brightness and lightness adjustments
 
+### icc
+
+Assign ICC profile (from preset: `p3`, `srgb`, `cmyk` or from file). Can only be
+given directly prior to [output](#output), overrides input ICC (if any) and only
+used if output format actually supports it.
+
 ### nest
 
 Performing nested branches/pipelines of operations with no effect on image state
@@ -344,7 +351,7 @@ For Node.js REPL:
 const imago = await import("@thi.ng/imago");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 4.82 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 4.93 KB
 
 ## Dependencies
 

package/api.d.ts

@@ -12,12 +12,18 @@ import type { AvifOptions, Blend, Exif, ExtendWith, FitEnum, GifOptions, Jp2Opti
  * ```
  */
 export type Gravity = "c" | "e" | "n" | "ne" | "nw" | "s" | "se" | "sw" | "w";
+/**
+ * See [thi.ng/pixel-dither](https://thi.ng/pixel-dither) for reference
+ */
 export type DitherMode = "atkinson" | "burkes" | "column" | "diffusion" | "floyd" | "jarvis" | "row" | "sierra" | "stucki" | "bayer";
 export type Dim = [number, number];
 export type Size = number | Dim;
 export type Sides = [number, number, number, number];
 export type SizeRef = "min" | "max" | "w" | "h" | "both";
 export type SizeUnit = "px" | "%";
+/**
+ * If given as array, the color is interpreted as `[r,g,b,a?]`
+ */
 export type Color = string | number[] | {
     r: number;
     g: number;
@@ -255,6 +261,17 @@ export interface HSBLSpec extends ProcSpec {
     b?: number;
     l?: number;
 }
+export interface ICCSpec extends ProcSpec {
+    op: "icc";
+    /**
+     * ICC profile preset name
+     */
+    profile?: "srgb" | "p3" | "cmyk";
+    /**
+     * ICC profile file path (can be relative)
+     */
+    path?: string;
+}
 export interface NestSpec extends ProcSpec {
     op: "nest";
     /**

package/index.d.ts

@@ -17,6 +17,7 @@ export * from "./ops/extend.js";
 export * from "./ops/gamma.js";
 export * from "./ops/grayscale.js";
 export * from "./ops/hsbl.js";
+export * from "./ops/icc.js";
 export * from "./ops/nest.js";
 export * from "./ops/output.js";
 export * from "./ops/resize.js";

package/index.js

@@ -17,6 +17,7 @@ export * from "./ops/extend.js";
 export * from "./ops/gamma.js";
 export * from "./ops/grayscale.js";
 export * from "./ops/hsbl.js";
+export * from "./ops/icc.js";
 export * from "./ops/nest.js";
 export * from "./ops/output.js";
 export * from "./ops/resize.js";

package/ops/icc.d.ts

@@ -0,0 +1,3 @@
+import type { Processor } from "../api.js";
+export declare const iccProc: Processor;
+//# sourceMappingURL=icc.d.ts.map

package/ops/icc.js

@@ -0,0 +1,17 @@
+import { illegalArgs } from "@thi.ng/errors";
+import { resolve } from "node:path";
+const iccProc = async (opts, src, ctx) => {
+  const $opts = opts;
+  if ($opts.profile) {
+    ctx.logger.info("setting ICC profile:", $opts.profile);
+    return [src.withIccProfile($opts.profile), false];
+  } else if ($opts.path) {
+    ctx.logger.info("setting ICC profile:", $opts.path);
+    ctx.opts.keepICC = false;
+    return [src.withIccProfile(resolve($opts.path)), false];
+  }
+  illegalArgs("require ICC profile name or path");
+};
+export {
+  iccProc
+};

package/ops.d.ts

@@ -1,4 +1,4 @@
-import type { BlurSpec, ColorLayer, CompLayer, CompSpec, CropSpec, DitherSpec, EXIFSpec, ExtendSpec, GammaSpec, GrayscaleSpec, HSBLSpec, ImgLayer, NestSpec, OutputSpec, ProcSpec, RawLayer, ResizeSpec, RotateSpec, SVGLayer, TextLayer } from "./api.js";
+import type { BlurSpec, ColorLayer, CompLayer, CompSpec, CropSpec, DitherSpec, EXIFSpec, ExtendSpec, GammaSpec, GrayscaleSpec, HSBLSpec, ICCSpec, ImgLayer, NestSpec, OutputSpec, ProcSpec, RawLayer, ResizeSpec, RotateSpec, SVGLayer, TextLayer } from "./api.js";
 /** @internal */
 export declare const defSpec: <T extends ProcSpec>(op: T["op"]) => (opts: Omit<T, "op">) => T;
 /** @internal */
@@ -64,6 +64,10 @@ export declare const grayscale: (opts: Omit<GrayscaleSpec, "op">) => GrayscaleSp
  * Creates a new {@link HSBLSpec} with given opts.
  */
 export declare const hsbl: (opts: Omit<HSBLSpec, "op">) => HSBLSpec;
+/**
+ * Creates a new {@link ICCSpec} with given opts.
+ */
+export declare const icc: (opts: Omit<ICCSpec, "op">) => ICCSpec;
 /**
  * Creates a new {@link NestSpec} with given opts.
  */

package/ops.js

@@ -14,6 +14,7 @@ const extend = defSpec("extend");
 const gamma = defSpec("gamma");
 const grayscale = defSpec("gray");
 const hsbl = defSpec("hsbl");
+const icc = defSpec("icc");
 const nest = defSpec("nest");
 const output = defSpec("output");
 const resize = defSpec("resize");
@@ -31,6 +32,7 @@ export {
   gamma,
   grayscale,
   hsbl,
+  icc,
   imageLayer,
   nest,
   output,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/imago",
-  "version": "0.6.11",
+  "version": "0.7.0",
   "description": "JSON & API-based declarative and extensible image processing trees/pipelines",
   "type": "module",
   "module": "./index.js",
@@ -64,6 +64,7 @@
     "bitmap",
     "blur",
     "color",
+    "conversion",
     "crop",
     "composite",
     "dither",
@@ -71,6 +72,7 @@
     "fileformat",
     "gif",
     "grayscale",
+    "icc",
     "image",
     "jpeg",
     "nested",
@@ -152,6 +154,9 @@
     "./ops/hsbl": {
       "default": "./ops/hsbl.js"
     },
+    "./ops/icc": {
+      "default": "./ops/icc.js"
+    },
     "./ops/nest": {
       "default": "./ops/nest.js"
     },
@@ -181,5 +186,5 @@
     "status": "alpha",
     "year": 2024
   },
-  "gitHead": "ce5ae2a322d50a7ce8ecccbd94fa55c496ba04fd\n"
+  "gitHead": "4fe9761724f29400047d749b8bb464360527c230\n"
 }

package/proc.js

@@ -12,6 +12,7 @@ import { extendProc } from "./ops/extend.js";
 import { gammaProc } from "./ops/gamma.js";
 import { grayscaleProc } from "./ops/grayscale.js";
 import { hsblProc } from "./ops/hsbl.js";
+import { iccProc } from "./ops/icc.js";
 import { nestProc } from "./ops/nest.js";
 import { outputProc } from "./ops/output.js";
 import { resizeProc } from "./ops/resize.js";
@@ -29,8 +30,8 @@ const processImage = async (src, specs, opts = {}, parentCtx) => {
     logger: opts.logger || LOGGER,
     size: [meta.width, meta.height],
     exif: parentCtx ? structuredClone(parentCtx.exif) : {},
-    meta,
-    opts
+    opts: { ...opts },
+    meta
   };
   if (!parentCtx) {
     if (meta.exif && opts.keepEXIF) {
@@ -79,6 +80,7 @@ const processor = defmulti(
     gamma: gammaProc,
     gray: grayscaleProc,
     hsbl: hsblProc,
+    icc: iccProc,
     nest: nestProc,
     output: outputProc,
     resize: resizeProc,