@thi.ng/imago 0.7.9 → 0.8.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-06-29T09:28:36Z
+- **Last updated**: 2024-07-06T12:02:19Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,16 @@ 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.8.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/imago@0.8.0) (2024-07-06)
+
+#### 🚀 Features
+
+- make output path optional, record img buffer ([90258b2](https://github.com/thi-ng/umbrella/commit/90258b2))
+  - update OutputSpec.path handling
+  - if no path given, record encoded img buffer itself in outputs
+  - update outputProc() & __outputRaw()
+  - update docs
+
 ### [0.7.8](https://github.com/thi-ng/umbrella/tree/@thi.ng/imago@0.7.8) (2024-06-21)
 
 #### ♻️ Refactoring

package/README.md

@@ -7,7 +7,7 @@
 [![Mastodon Follow](https://img.shields.io/mastodon/follow/109331703950160316?domain=https%3A%2F%2Fmastodon.thi.ng&style=social)](https://mastodon.thi.ng/@toxi)
 
 > [!NOTE]
-> This is one of 189 standalone projects, maintained as part
+> This is one of 188 standalone projects, maintained as part
 > of the [@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo
 > and anti-framework.
 >
@@ -258,6 +258,9 @@ Alternatively, a
 the image can be computed and stored in the outputs. In this case, no file will
 be written.
 
+For all other formats, if no output path is provided in the spec, no file will
+be written, but the encoded image buffer itself will be recorded in the outputs.
+
 #### Templated output paths
 
 Output paths can contain `{id}`-templated parts which will be replaced/expanded.
@@ -357,7 +360,7 @@ For Node.js REPL:
 const imago = await import("@thi.ng/imago");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 4.92 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 4.95 KB
 
 ## Dependencies
 

package/api.d.ts

@@ -289,7 +289,12 @@ export interface OutputSpec extends ProcSpec {
     id: string;
     /**
      * Possibly templated output path. See {@link formatPath} for details.
-     * Ignored if {@link OutputSpec.blurhash} is being used, otherwise **required**.
+     * Ignored if {@link OutputSpec.blurhash} is being used.
+     *
+     * Otherwise, if given, the image will be written to the result path and the
+     * path stored in the `outputs` object returned by {@link processImage}. If
+     * no path is given, no file will be written and the encoded image buffer
+     * itself will be recorded in `outputs`.
      */
     path?: string;
     /**
@@ -447,7 +452,7 @@ export interface ImgProcCtx {
      * Paths of all exported images, keyed by IDs given via {@link OutputSpec} /
      * {@link output}.
      */
-    outputs: Record<string, string>;
+    outputs: Record<string, string | Buffer>;
     /**
      * See {@link ImgProcOpts.env} for details/comments.
      */

package/ops/output.js

@@ -61,29 +61,37 @@ const outputProc = async (spec, input, ctx) => {
   if (opts.tile) output = output.tile(opts.tile);
   if (format) output = output.toFormat(format);
   const result = await output.toBuffer();
-  const path = join(
-    outDir,
-    formatPath(opts.path, ctx, spec, result)
-  );
-  writeFile(path, result, null, ctx.logger);
-  ctx.outputs[opts.id] = path;
+  if (opts.path !== void 0) {
+    const path = join(
+      outDir,
+      formatPath(opts.path, ctx, spec, result)
+    );
+    writeFile(path, result, null, ctx.logger);
+    ctx.outputs[opts.id] = path;
+  } else {
+    ctx.outputs[opts.id] = result;
+  }
   return [input, false];
 };
 const __outputRaw = async (opts, output, ctx, outDir) => {
   const { alpha = false, meta = false } = isPlainObject(opts.raw) ? opts.raw : {};
   if (alpha) output = output.ensureAlpha();
   const { data, info } = await output.raw().toBuffer({ resolveWithObject: true });
-  const path = join(outDir, formatPath(opts.path, ctx, opts, data));
-  writeFile(path, data, null, ctx.logger);
-  ctx.outputs[opts.id] = path;
-  if (meta) {
-    writeJSON(
-      path + ".meta.json",
-      { ...info, exif: ctx.exif },
-      void 0,
-      void 0,
-      ctx.logger
-    );
+  if (opts.path !== void 0) {
+    const path = join(outDir, formatPath(opts.path, ctx, opts, data));
+    writeFile(path, data, null, ctx.logger);
+    ctx.outputs[opts.id] = path;
+    if (meta) {
+      writeJSON(
+        path + ".meta.json",
+        { ...info, exif: ctx.exif },
+        void 0,
+        void 0,
+        ctx.logger
+      );
+    }
+  } else {
+    ctx.outputs[opts.id] = data;
   }
 };
 const __outputBlurHash = async (opts, output, ctx) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/imago",
-  "version": "0.7.9",
+  "version": "0.8.0",
   "description": "JSON & API-based declarative and extensible image processing trees/pipelines",
   "type": "module",
   "module": "./index.js",
@@ -36,26 +36,26 @@
     "tool:tangle": "../../node_modules/.bin/tangle src/**/*.ts"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.11.4",
-    "@thi.ng/associative": "^6.3.62",
-    "@thi.ng/blurhash": "^0.1.26",
-    "@thi.ng/checks": "^3.6.6",
-    "@thi.ng/date": "^2.7.20",
-    "@thi.ng/defmulti": "^3.0.41",
-    "@thi.ng/errors": "^2.5.9",
-    "@thi.ng/file-io": "^2.1.4",
-    "@thi.ng/logger": "^3.0.14",
-    "@thi.ng/pixel": "^6.1.34",
-    "@thi.ng/pixel-dither": "^1.1.132",
-    "@thi.ng/prefixes": "^2.3.21",
+    "@thi.ng/api": "^8.11.5",
+    "@thi.ng/associative": "^6.3.63",
+    "@thi.ng/blurhash": "^0.1.27",
+    "@thi.ng/checks": "^3.6.7",
+    "@thi.ng/date": "^2.7.21",
+    "@thi.ng/defmulti": "^3.0.42",
+    "@thi.ng/errors": "^2.5.10",
+    "@thi.ng/file-io": "^2.1.5",
+    "@thi.ng/logger": "^3.0.15",
+    "@thi.ng/pixel": "^6.1.35",
+    "@thi.ng/pixel-dither": "^1.1.133",
+    "@thi.ng/prefixes": "^2.3.22",
     "sharp": "^0.33.4"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.47.0",
-    "@thi.ng/vectors": "^7.11.1",
-    "esbuild": "^0.21.5",
-    "typedoc": "^0.25.13",
-    "typescript": "^5.5.2"
+    "@thi.ng/vectors": "^7.11.2",
+    "esbuild": "^0.23.0",
+    "typedoc": "^0.26.3",
+    "typescript": "^5.5.3"
   },
   "keywords": [
     "avif",
@@ -185,5 +185,5 @@
     "status": "alpha",
     "year": 2024
   },
-  "gitHead": "7b950c112fba0b2e7c450765b15624c3382f1354\n"
+  "gitHead": "70f493d9ccc97c5df5dda7e808e96cd1691097fc\n"
 }

package/proc.d.ts

@@ -22,7 +22,7 @@ export declare const processImage: (src: string | BufferLike | ArrayBuffer | Sha
     img: sharp.Sharp;
     meta: sharp.Metadata;
     env: import("@thi.ng/api").IObjectOf<any>;
-    outputs: Record<string, string>;
+    outputs: Record<string, string | Buffer>;
 }>;
 /**
  * Extensible polymorphic function performing a single image processing step.