@bgord/bun 0.22.0 → 0.22.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bgord/bun",
-  "version": "0.22.0",
+  "version": "0.22.1",
   "license": "MIT",
   "type": "module",
   "author": "Bartosz Gordon",

package/readme.md

@@ -62,6 +62,9 @@ src/
 ├── healthcheck.service.ts
 ├── http-logger.middleware.ts
 ├── i18n.service.ts
+├── image-alpha-noop.adapter.ts
+├── image-alpha-sharp.adapter.ts
+├── image-alpha.port.ts
 ├── image-blur-noop.adapter.ts
 ├── image-blur-sharp.adapter.ts
 ├── image-blur.port.ts
@@ -77,6 +80,9 @@ src/
 ├── image-info-noop.adapter.ts
 ├── image-info-sharp.adapter.ts
 ├── image-info.port.ts
+├── image-processor-noop.adapter.ts
+├── image-processor-sharp.adapter.ts
+├── image-processor.port.ts
 ├── image-resizer-noop.adapter.ts
 ├── image-resizer-sharp.adapter.ts
 ├── image-resizer.port.ts

package/src/image-alpha-noop.adapter.ts

@@ -0,0 +1,7 @@
+import type { ImageAlphaPort, ImageAlphaStrategy } from "./image-alpha.port";
+
+export class ImageAlphaNoopAdapter implements ImageAlphaPort {
+  async flatten(recipe: ImageAlphaStrategy) {
+    return recipe.strategy === "output_path" ? recipe.output : recipe.input;
+  }
+}

package/src/image-alpha-sharp.adapter.ts

@@ -0,0 +1,28 @@
+import fs from "node:fs/promises";
+import sharp from "sharp";
+import type { ImageAlphaPort, ImageAlphaStrategy } from "./image-alpha.port";
+
+export class ImageAlphaSharpAdapter implements ImageAlphaPort {
+  async flatten(recipe: ImageAlphaStrategy) {
+    const final = recipe.strategy === "output_path" ? recipe.output : recipe.input;
+
+    const filename = final.getFilename();
+    const temporary = final.withFilename(filename.withSuffix("-flattened"));
+
+    const extension = String(final.getFilename().getExtension());
+    const format = (extension === "jpg" ? "jpeg" : extension) as keyof sharp.FormatEnum;
+
+    const pipeline = sharp(recipe.input.get());
+    using _sharp_ = { [Symbol.dispose]: () => pipeline.destroy() };
+
+    await pipeline
+      .rotate()
+      .flatten({ background: recipe.background })
+      .toFormat(format)
+      .toFile(temporary.get());
+
+    await fs.rename(temporary.get(), final.get());
+
+    return final;
+  }
+}

package/src/image-alpha.port.ts

@@ -0,0 +1,22 @@
+import type * as tools from "@bgord/tools";
+
+type ImageAlphaBackground = string | { r: number; g: number; b: number; alpha?: number };
+
+type ImageAlphaOutputPathStrategy = {
+  strategy: "output_path";
+  input: tools.FilePathRelative | tools.FilePathAbsolute;
+  output: tools.FilePathRelative | tools.FilePathAbsolute;
+  background: ImageAlphaBackground;
+};
+
+type ImageAlphaInPlaceStrategy = {
+  strategy: "in_place";
+  input: tools.FilePathRelative | tools.FilePathAbsolute;
+  background: ImageAlphaBackground;
+};
+
+export type ImageAlphaStrategy = ImageAlphaInPlaceStrategy | ImageAlphaOutputPathStrategy;
+
+export interface ImageAlphaPort {
+  flatten(recipe: ImageAlphaStrategy): Promise<tools.FilePathRelative | tools.FilePathAbsolute>;
+}

package/src/image-processor-noop.adapter.ts

@@ -0,0 +1,10 @@
+import type * as tools from "@bgord/tools";
+import type { ImageProcessorPort, ImageProcessorStrategy } from "./image-processor.port";
+
+export class ImageProcessorNoopAdapter implements ImageProcessorPort {
+  async process(recipe: ImageProcessorStrategy): Promise<tools.FilePathRelative | tools.FilePathAbsolute> {
+    return recipe.strategy === "output_path"
+      ? recipe.output
+      : recipe.input.withFilename(recipe.input.getFilename().withExtension(recipe.to));
+  }
+}

package/src/image-processor-sharp.adapter.ts

@@ -0,0 +1,49 @@
+import fs from "node:fs/promises";
+import type * as tools from "@bgord/tools";
+import sharp from "sharp";
+import type { ImageProcessorPort, ImageProcessorStrategy } from "./image-processor.port";
+
+export class ImageProcessorSharpAdapter implements ImageProcessorPort {
+  private static readonly DEFAULT_QUALITY = 85;
+
+  async process(recipe: ImageProcessorStrategy): Promise<tools.FilePathRelative | tools.FilePathAbsolute> {
+    const final =
+      recipe.strategy === "output_path"
+        ? recipe.output
+        : recipe.input.withFilename(recipe.input.getFilename().withExtension(recipe.to));
+
+    const temporary = final.withFilename(final.getFilename().withSuffix("-processed"));
+
+    const finalExtension = final.getFilename().getExtension();
+    const encoder = (finalExtension === "jpg" ? "jpeg" : finalExtension) as keyof sharp.FormatEnum;
+
+    const quality = recipe.quality ?? ImageProcessorSharpAdapter.DEFAULT_QUALITY;
+
+    const pipeline = sharp(recipe.input.get());
+    using _sharp_ = { [Symbol.dispose]: () => pipeline.destroy() };
+
+    let processor = pipeline.rotate();
+
+    if (recipe.background) {
+      processor = processor.flatten({ background: recipe.background as any });
+    }
+
+    processor = processor.resize({
+      width: recipe.maxSide,
+      height: recipe.maxSide,
+      fit: "inside",
+      withoutEnlargement: true,
+    });
+
+    processor = processor.toFormat(encoder, { quality });
+
+    await processor.toFile(temporary.get());
+    await fs.rename(temporary.get(), final.get());
+
+    if (recipe.strategy === "in_place" && final.get() !== recipe.input.get()) {
+      await fs.unlink(recipe.input.get());
+    }
+
+    return final;
+  }
+}

package/src/image-processor.port.ts

@@ -0,0 +1,28 @@
+import type * as tools from "@bgord/tools";
+
+type ImageBackground = string | { r: number; g: number; b: number; alpha?: number };
+
+type ImageProcessorOutputPathStrategy = {
+  strategy: "output_path";
+  input: tools.FilePathRelative | tools.FilePathAbsolute;
+  output: tools.FilePathRelative | tools.FilePathAbsolute;
+  maxSide: number;
+  to: tools.ExtensionType;
+  quality?: number;
+  background?: ImageBackground;
+};
+
+type ImageProcessorInPlaceStrategy = {
+  strategy: "in_place";
+  input: tools.FilePathRelative | tools.FilePathAbsolute;
+  maxSide: number;
+  to: tools.ExtensionType;
+  quality?: number;
+  background?: ImageBackground;
+};
+
+export type ImageProcessorStrategy = ImageProcessorInPlaceStrategy | ImageProcessorOutputPathStrategy;
+
+export interface ImageProcessorPort {
+  process(recipe: ImageProcessorStrategy): Promise<tools.FilePathRelative | tools.FilePathAbsolute>;
+}

package/src/index.ts

@@ -35,6 +35,9 @@ export * from "./gzip.service";
 export * from "./healthcheck.service";
 export * from "./http-logger.middleware";
 export * from "./i18n.service";
+export * from "./image-alpha.port";
+export * from "./image-alpha-noop.adapter";
+export * from "./image-alpha-sharp.adapter";
 export * from "./image-blur.port";
 export * from "./image-blur-noop.adapter";
 export * from "./image-blur-sharp.adapter";
@@ -50,6 +53,9 @@ export * from "./image-formatter-sharp.adapter";
 export * from "./image-info.port";
 export * from "./image-info-noop.adapter";
 export * from "./image-info-sharp.adapter";
+export * from "./image-processor.port";
+export * from "./image-processor-noop.adapter";
+export * from "./image-processor-sharp.adapter";
 export * from "./image-resizer.port";
 export * from "./image-resizer-noop.adapter";
 export * from "./image-resizer-sharp.adapter";