@thi.ng/imago 1.4.15 → 1.5.0

package/README.md

@@ -33,6 +33,7 @@
   - [grayscale](#grayscale)
   - [hsbl](#hsbl)
   - [icc](#icc)
+  - [maxsize](#maxsize)
   - [nest](#nest)
   - [output](#output)
     - [Templated output paths](#templated-output-paths)
@@ -234,6 +235,11 @@ 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.
 
+### maxsize
+
+Conditional version of [resize](#resize) operator, only applied if one of the
+sides exceeds the configured size limit.
+
 ### nest
 
 Performing nested branches/pipelines of operations with no effect on image state
@@ -375,7 +381,7 @@ For Node.js REPL:
 const imago = await import("@thi.ng/imago");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 5.20 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 5.31 KB
 
 ## Dependencies
 

package/api.d.ts

@@ -283,6 +283,14 @@ export interface ICCSpec extends ProcSpec {
      */
     path?: string;
 }
+export interface MaxSizeSpec extends Omit<ResizeSpec, "op" | "size" | "unit"> {
+    op: "maxsize";
+    /**
+     * Max. image size in pixels. If given as number, the longest side will be
+     * used.
+     */
+    maxSize: Size;
+}
 export interface NestSpec extends ProcSpec {
     op: "nest";
     /**

package/index.d.ts

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

package/index.js

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

package/ops/maxsize.d.ts

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

package/ops/maxsize.js

@@ -0,0 +1,30 @@
+import { isNumber } from "@thi.ng/checks";
+import { resizeProc } from "./resize.js";
+const maxsizeProc = async (spec, input, ctx) => {
+  const { maxSize } = spec;
+  const [width, height] = ctx.size;
+  const result = [input, false];
+  if (isNumber(maxSize)) {
+    if (width > maxSize || height > maxSize)
+      return resizeProc(
+        { ...spec, size: maxSize, unit: "px" },
+        input,
+        ctx
+      );
+  } else {
+    const [maxW, maxH] = maxSize;
+    const resizeWidth = maxW > 0 && width > maxW;
+    const resizeHeight = maxH > 0 && height > maxH;
+    const specW = { ...spec, size: [maxW, -1], unit: "px" };
+    const specH = { ...specW, size: [-1, maxH] };
+    if (width >= height) {
+      return resizeWidth ? resizeProc(specW, input, ctx) : resizeHeight ? resizeProc(specH, input, ctx) : result;
+    } else {
+      return resizeHeight ? resizeProc(specH, input, ctx) : resizeWidth ? resizeProc(specW, input, ctx) : result;
+    }
+  }
+  return result;
+};
+export {
+  maxsizeProc
+};

package/ops.d.ts

@@ -1,4 +1,4 @@
-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";
+import type { BlurSpec, ColorLayer, CompLayer, CompSpec, CropSpec, DitherSpec, EXIFSpec, ExtendSpec, GammaSpec, GrayscaleSpec, HSBLSpec, ICCSpec, ImgLayer, MaxSizeSpec, 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 */
@@ -68,6 +68,10 @@ 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 MaxSizeSpec} with given opts.
+ */
+export declare const maxsize: (opts: Omit<MaxSizeSpec, "op">) => MaxSizeSpec;
 /**
  * Creates a new {@link NestSpec} with given opts.
  */

package/ops.js

@@ -15,6 +15,7 @@ const gamma = defSpec("gamma");
 const grayscale = defSpec("gray");
 const hsbl = defSpec("hsbl");
 const icc = defSpec("icc");
+const maxsize = defSpec("maxsize");
 const nest = defSpec("nest");
 const output = defSpec("output");
 const resize = defSpec("resize");
@@ -34,6 +35,7 @@ export {
   hsbl,
   icc,
   imageLayer,
+  maxsize,
   nest,
   output,
   rawLayer,

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@thi.ng/imago",
-	"version": "1.4.15",
+	"version": "1.5.0",
 	"description": "JSON & API-based declarative and extensible image processing trees/pipelines",
 	"type": "module",
 	"module": "./index.js",
@@ -160,6 +160,9 @@
 		"./ops/icc": {
 			"default": "./ops/icc.js"
 		},
+		"./ops/maxsize": {
+			"default": "./ops/maxsize.js"
+		},
 		"./ops/nest": {
 			"default": "./ops/nest.js"
 		},
@@ -189,5 +192,5 @@
 		"status": "alpha",
 		"year": 2024
 	},
-	"gitHead": "74b6f319d8f52c9266d97f616be5298a6a5b96e4\n"
+	"gitHead": "88d4b13485639f44b3c5cb5e0a73e0a3490eba85\n"
 }

package/proc.js

@@ -13,6 +13,7 @@ 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 { maxsizeProc } from "./ops/maxsize.js";
 import { nestProc } from "./ops/nest.js";
 import { outputProc } from "./ops/output.js";
 import { resizeProc } from "./ops/resize.js";
@@ -93,6 +94,7 @@ const processor = defmulti(
     gray: grayscaleProc,
     hsbl: hsblProc,
     icc: iccProc,
+    maxsize: maxsizeProc,
     nest: nestProc,
     output: outputProc,
     resize: resizeProc,