feat: allow metadata removal to be toggled by option

JonasKruckenberg · Mar 30, 2021 · 5d0c781 · 5d0c781
1 parent c03f5a3
commit 5d0c781
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 12 deletions.
diff --git a/packages/core/src/lib/apply-transforms.ts b/packages/core/src/lib/apply-transforms.ts
@@ -2,13 +2,16 @@ import { Sharp } from "sharp"
 import { ImageTransformation, TransformResult } from "../types"
 import { METADATA } from "./metadata"
 
-export async function applyTransforms(transforms: ImageTransformation[], image: Sharp): Promise<TransformResult> {
+export async function applyTransforms(transforms: ImageTransformation[], image: Sharp, removeMetadata: boolean = true): Promise<TransformResult> {
     image[METADATA] = await image.metadata()
 
-    // delete the xmp buffer to not leak private metadata
-    delete image[METADATA].xmp
-    delete image[METADATA].exif
-    delete image[METADATA].iptc
+    if(removeMetadata) {
+        // delete the private metadata
+        delete image[METADATA].exif
+        delete image[METADATA].iptc
+        delete image[METADATA].xmp
+        delete image[METADATA].tifftagPhotoshop
+    }
 
     image = transforms.reduce((img, transform) => transform(img), image)
 

diff --git a/packages/vite/README.md b/packages/vite/README.md
@@ -111,6 +111,15 @@ See the section [Custom output formats](#custom-output-formats) for details.
 Settings this option to true disables all warnings produced by this plugin.
 
 **`default`** false
+
+### removeMetadata
+
+• **removeMetadata**: *boolean*
+
+Wether to remove potentially private metadata from the image, such as exif tags etc.
+
+**`default`** true
+
 ## Contributing
 
 Feel free to dive in! [Open an issue](https://github.com/JonasKruckenberg/vite-imagetools/issues/new) or submit PRs!

diff --git a/packages/vite/src/index.ts b/packages/vite/src/index.ts
@@ -1,16 +1,16 @@
 import { Plugin, ResolvedConfig } from "vite";
-import { parseURL, loadImageFromDisk, builtins, resolveConfigs, applyTransforms, generateTransforms, getMetadata, generateImageID } from 'imagetools-core'
+import { parseURL, loadImage, builtins, resolveConfigs, applyTransforms, generateTransforms, getMetadata, generateImageID } from 'imagetools-core'
 import { basename, extname, join } from 'path'
 import { createFilter, dataToEsm } from "@rollup/pluginutils";
 import { builtinOutputFormats, urlFormat } from './output-formats'
 import MagicString from 'magic-string'
 import { OutputFormat, PluginOptions } from "./types";
-import { createHash } from 'crypto'
 
 const defaultOptions: PluginOptions = {
     include: '**\/*.{heic,heif,avif,jpeg,jpg,png,tiff,webp,gif}?*',
     exclude: 'public\/**\/*',
-    silent: false
+    silent: false,
+    removeMetadata: true
 }
 
 export default function imagetools(userOptions: Partial<PluginOptions> = {}): Plugin {
@@ -43,15 +43,15 @@ export default function imagetools(userOptions: Partial<PluginOptions> = {}): Pl
             const parameters = parseURL(src)
             const imageConfigs = resolveConfigs(parameters)
 
-            const img = loadImageFromDisk(src.pathname)
+            const img = loadImage(src.pathname)
 
             const outputMetadatas = []
 
             for (const config of imageConfigs) {
                 const id = generateImageID(src, config)
 
                 const { transforms } = generateTransforms(config, transformFactories)
-                const { image, metadata } = await applyTransforms(transforms, img)
+                const { image, metadata } = await applyTransforms(transforms, img, pluginOptions.removeMetadata)
 
                 generatedImages.set(id, image)
 
@@ -72,8 +72,6 @@ export default function imagetools(userOptions: Partial<PluginOptions> = {}): Pl
                 outputMetadatas.push(metadata)
             }
 
-            // console.log(outputMetadatas);
-
             let outputFormat: OutputFormat = urlFormat
 
             for (const [key, format] of Object.entries(outputFormats)) {
@@ -93,6 +91,10 @@ export default function imagetools(userOptions: Partial<PluginOptions> = {}): Pl
 
                     const image = generatedImages.get(id)
 
+                    if(pluginOptions.removeMetadata === false) {
+                        image.withMetadata()
+                    }
+
                     res.setHeader('Content-Type', `image/${getMetadata(image, 'format')}`)
                     res.setHeader('Cache-Control', 'max-age=360000')
                     return image.clone().pipe(res)

diff --git a/packages/vite/src/types.ts b/packages/vite/src/types.ts
@@ -34,4 +34,10 @@ export interface PluginOptions {
      * @default false
      */
     silent: boolean
+
+    /**
+     * Wether to remove potentially private metadata from the image, such as exif tags etc.
+     * @default true
+     */
+    removeMetadata: boolean
 }