Merge branch 'develop'

Author: batosai

docs/changelog.md

@@ -12,6 +12,7 @@
 * [config](/guide/essentials/configuration)
   * autodetect converter by default
   * options attribute is now deprecated
+  * [autoOrient](/guide/converters/image#auto-orient) is true by default
   * add [timeout](/guide/essentials/configuration#timeout-optional-default-30000ms)
 * update documentation
   * documentation v5
@@ -20,7 +21,11 @@
   * [migration page](/migration)
 
 
-> Released at *2025-07-14*
+> Released at *2025-08-18*
+
+## 4.1.0
+
+* add [autoOrient](/v4/guide/converters/image#auto-orient)
 
 ## 4.0.4
 

docs/guide/converters/image.md

@@ -87,6 +87,21 @@ declare module '@jrmc/adonis-attachment' {
 }
 ```
 
+## Auto-orient
+
+Auto-orient based on the EXIF Orientation tag, then remove the tag. Mirroring is supported and may infer the use of a flip operation. ([sharp doc](https://sharp.pixelplumbing.com/api-operation/#autoorient))
+`autoOrient` is true by default.
+
+```typescript
+const attachmentConfig = defineConfig({
+  converters: {
+    thumbnail: { // [!code focus:3]
+      autoOrient: false
+    }
+  }
+})
+```
+
 ## BlurHash
 
 The blurhash option is used to enable, disable, and customise the generation of blurhashes ([https://blurha.sh/](https://blurha.sh/)) for the variants. Blurhash generation is disabled by default.

docs/guide/essentials/configuration.md

@@ -27,13 +27,6 @@ declare module '@jrmc/adonis-attachment' {
 }
 ```
 
-## converters
-
-|OPTIONS:  | DESCRIPTIONS:            |
-| -------- | ------------------------ |
-|converter |Class for generate variant|
-|options   |Options converter         |
-
 ---
 
 ## preComputeUrl (optional, default false)

docs/migration.md

@@ -69,4 +69,28 @@ thumbnail: {
   },
 },
 ```
-:::
+:::
+
+- [autoOrient](/v4/guide/converters/image#auto-orient) is now true by default.
+
+If you do not want this option, please add it with the value false
+
+::: code-group
+```typescript [Now]
+thumbnail: {
+  resize: 300,
+  format: 'webp',
+  autoOrient: false,
+},
+```
+
+```typescript [Before]
+thumbnail: {
+  converter: () => import('@jrmc/adonis-attachment/converters/autodetect_converter'),
+  options: {
+    resize: 300,
+    format: 'webp',
+  },
+},
+```
+:::

docs/v4/guide/converters/image.md

@@ -95,6 +95,23 @@ declare module '@jrmc/adonis-attachment' {
 }
 ```
 
+## Auto-orient
+
+⚠️ [avalable in v4.1.0](/changelog#_4-1-0)
+
+Auto-orient based on the EXIF Orientation tag, then remove the tag. Mirroring is supported and may infer the use of a flip operation. ([sharp doc](https://sharp.pixelplumbing.com/api-operation/#autoorient))
+`autoOrient` is false by default.
+
+```typescript
+const attachmentConfig = defineConfig({
+  converters: {
+    thumbnail: { // [!code focus:3]
+      autoOrient: true
+    }
+  }
+})
+```
+
 ## BlurHash
 
 The blurhash option is used to enable, disable, and customise the generation of blurhashes ([https://blurha.sh/](https://blurha.sh/)) for the variants. Blurhash generation is disabled by default.

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@jrmc/adonis-attachment",
-  "version": "5.0.0-beta.6",
+  "version": "5.0.0-beta.7",
   "type": "module",
   "description": "Turn any field on your Lucid model to an attachment data type",
   "engines": {

package.json

@@ -16,15 +16,22 @@ export default class ImageConverter extends Converter {
     const sharp = await use('sharp')
     const resize = options?.resize || {}
     let format = options?.format || 'webp'
+    const autoOrient = options?.autoOrient ?? true
     let formatoptions = {}
 
     if (typeof format !== 'string') {
       formatoptions = format?.options
       format = format.format
     }
 
-    const buffer: Input = await sharp(input)
+    const image = sharp(input)
       .withMetadata()
+
+    if (autoOrient) {
+      image.autoOrient()
+    }
+
+    const buffer: Input = await image
       .resize(resize)
       .toFormat(format, formatoptions)
       .toBuffer()

src/converters/image_converter.ts

@@ -166,6 +166,7 @@ export type ConverterOptions = {
     | webp
     | avif
     | heif
+  autoOrient?: boolean
   blurhash?: boolean | BlurhashOptions
   startTime?: number
   startPage?: number

src/types/converter.ts

@@ -104,11 +104,17 @@ const attachmentConfig = defineConfig({
       //   }
       // }
 
+      /**
+      *
+      * https://sharp.pixelplumbing.com/api-operation/#autoorient
+      */
+      // autoOrient: false,
+
       /**
       * generation of blurhashes (default: true)
       * https://blurha.sh/
       */
-      // blurhash: true
+      // blurhash: true,
     }
   }
 })