@thi.ng/imago 0.4.0 → 0.4.1

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-02-27T20:35:06Z
+- **Last updated**: 2024-02-28T14:23:30Z
 - **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.4.1](https://github.com/thi-ng/umbrella/tree/@thi.ng/imago@0.4.1) (2024-02-28)
+
+#### 🩹 Bug fixes
+
+- fix typedarray input handling in processImage() ([075ecaa](https://github.com/thi-ng/umbrella/commit/075ecaa))
+
 ## [0.4.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/imago@0.4.0) (2024-02-27)
 
 #### 🚀 Features

package/README.md

@@ -309,7 +309,7 @@ For Node.js REPL:
 const imago = await import("@thi.ng/imago");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 4.16 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 4.15 KB
 
 ## Dependencies
 

package/api.d.ts

@@ -126,9 +126,22 @@ export interface OutputSpec extends ProcSpec {
     id: string;
     /**
      * Possibly templated output path. See {@link formatPath} for details.
+     * Ignored if {@link OutputSpec.blurhash} is being used.
      */
     path: string;
+    /**
+     * AVIF output options. See [Sharp docs](https://sharp.pixelplumbing.com/api-output#avif)
+     */
     avif?: AvifOptions;
+    /**
+     * If given, ONLY the blurhash of the image will be computed and stored in
+     * the `outputs` object returned by {@link processImage}. The
+     * {@link OutputSpec.path} will be ignored and no file will be written.
+     *
+     * @remarks
+     * Important: Ensure the image has already been downsized to ~50-500 pixels.
+     * Larger images are causing unnecessary & long processing...
+     */
     blurhash?: {
         /**
          * Blurhash detail setting in 1-9 range, possibly given separately for
@@ -138,11 +151,29 @@ export interface OutputSpec extends ProcSpec {
          */
         detail?: number | [number, number];
     };
+    /**
+     * GIF output options. See [Sharp docs](https://sharp.pixelplumbing.com/api-output#gif)
+     */
     gif?: GifOptions;
+    /**
+     * JPEG 2000 output options. See [Sharp docs](https://sharp.pixelplumbing.com/api-output#jp2)
+     */
     jp2?: Jp2Options;
+    /**
+     * JPEG output options. See [Sharp docs](https://sharp.pixelplumbing.com/api-output#jpeg)
+     */
     jpeg?: JpegOptions;
+    /**
+     * JPEG XL output options. See [Sharp docs](https://sharp.pixelplumbing.com/api-output#jxl)
+     */
     jxl?: JxlOptions;
+    /**
+     * PNG output options. See [Sharp docs](https://sharp.pixelplumbing.com/api-output#avif)
+     */
     png?: PngOptions;
+    /**
+     * Raw binary output options.
+     */
     raw?: boolean | {
         /**
          * If true, ensures the buffer has an alpha channel
@@ -154,8 +185,17 @@ export interface OutputSpec extends ProcSpec {
          */
         meta?: boolean;
     };
+    /**
+     * Tiled format output options. See [Sharp docs](https://sharp.pixelplumbing.com/api-output#tile)
+     */
     tile?: TileOptions;
+    /**
+     * TIFF output options. See [Sharp docs](https://sharp.pixelplumbing.com/api-output#tiff)
+     */
     tiff?: TiffOptions;
+    /**
+     * WebP output options. See [Sharp docs](https://sharp.pixelplumbing.com/api-output#webp)
+     */
     webp?: WebpOptions;
 }
 export interface ResizeSpec extends ProcSpec {

package/ops/output.js

@@ -1,8 +1,8 @@
 import { encode } from "@thi.ng/blurhash";
+import { isNumber, isPlainObject } from "@thi.ng/checks";
 import { writeFile, writeJSON } from "@thi.ng/file-io";
 import { join, resolve } from "node:path";
 import { formatPath } from "../path.js";
-import { isNumber, isPlainObject } from "@thi.ng/checks";
 const outputProc = async (spec, input, ctx) => {
   const opts = spec;
   const outDir = resolve(ctx.opts.outDir || ".");
@@ -106,8 +106,8 @@ const outputBlurHash = async (opts, output, ctx) => {
     dx,
     dy
   );
-  ctx.outputs[opts.id] = hash;
   ctx.logger.debug("computed blurhash:", hash);
+  ctx.outputs[opts.id] = hash;
 };
 export {
   outputProc

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/imago",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "description": "JSON & API-based declarative and extensible image processing trees/pipelines",
   "type": "module",
   "module": "./index.js",
@@ -39,19 +39,19 @@
     "@thi.ng/associative": "^6.3.43",
     "@thi.ng/blurhash": "^0.1.11",
     "@thi.ng/checks": "^3.5.0",
-    "@thi.ng/date": "^2.7.1",
+    "@thi.ng/date": "^2.7.2",
     "@thi.ng/defmulti": "^3.0.26",
     "@thi.ng/errors": "^2.4.18",
     "@thi.ng/file-io": "^1.3.4",
     "@thi.ng/logger": "^3.0.3",
-    "@thi.ng/pixel": "^6.1.12",
-    "@thi.ng/pixel-dither": "^1.1.110",
+    "@thi.ng/pixel": "^6.1.13",
+    "@thi.ng/pixel-dither": "^1.1.111",
     "@thi.ng/prefixes": "^2.3.10",
     "sharp": "^0.33.2"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.40.1",
-    "@thi.ng/vectors": "^7.10.12",
+    "@thi.ng/vectors": "^7.10.13",
     "esbuild": "^0.20.0",
     "rimraf": "^5.0.5",
     "typedoc": "^0.25.7",
@@ -126,5 +126,5 @@
     "status": "alpha",
     "year": 2024
   },
-  "gitHead": "41860743a21093aa13b6b7f4e36cd5e2e934d159\n"
+  "gitHead": "190d68e7f7524631b333cfdbf32c6a23be27c166\n"
 }

package/proc.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+import type { TypedArray } from "@thi.ng/api";
 import sharp, { type Sharp } from "sharp";
 import type { ImgProcCtx, ImgProcOpts, ProcSpec } from "./api.js";
 export declare const LOGGER: import("@thi.ng/logger").ProxyLogger;
@@ -17,7 +18,7 @@ export declare const LOGGER: import("@thi.ng/logger").ProxyLogger;
  * @param opts
  * @param parentCtx
  */
-export declare const processImage: (src: string | Buffer | Sharp, specs: ProcSpec[], opts?: Partial<ImgProcOpts>, parentCtx?: ImgProcCtx) => Promise<{
+export declare const processImage: (src: string | TypedArray | Buffer | ArrayBuffer | Sharp, specs: ProcSpec[], opts?: Partial<ImgProcOpts>, parentCtx?: ImgProcCtx) => Promise<{
     img: sharp.Sharp;
     meta: sharp.Metadata;
     outputs: Record<string, string>;

package/proc.js

@@ -1,5 +1,6 @@
 import { isArrayBufferView, isString } from "@thi.ng/checks";
 import { defmulti } from "@thi.ng/defmulti";
+import { createTempFile, deleteFile } from "@thi.ng/file-io";
 import { ROOT } from "@thi.ng/logger";
 import sharp, {} from "sharp";
 import { blurProc } from "./ops/blur.js";
@@ -16,10 +17,9 @@ import { outputProc } from "./ops/output.js";
 import { resizeProc } from "./ops/resize.js";
 import { rotateProc } from "./ops/rotate.js";
 import { ensureSize } from "./units.js";
-import { createTempFile, deleteFile } from "@thi.ng/file-io";
 const LOGGER = ROOT.childLogger("imgproc");
 const processImage = async (src, specs, opts = {}, parentCtx) => {
-  let img = isString(src) || isArrayBufferView(src.buffer) ? sharp(src) : src;
+  let img = isString(src) || isArrayBufferView(src) ? sharp(src) : src;
   const meta = await img.metadata();
   ensureSize(meta);
   const ctx = {