feat: add experimental image orientation fix

packages/core/package.json

@@ -32,6 +32,7 @@
     "dev": "rollup -cw",
     "build": "rollup -c",
     "test": "vitest run",
+    "test:watch": "vitest watch",
     "coverage": "vitest run --coverage"
   },
   "devDependencies": {

packages/core/src/__tests__/apply-transforms.spec.ts

@@ -30,7 +30,7 @@ describe('applyTransforms', () => {
     expect(metadata).not.toHaveProperty('iptc')
   })
 
-  it('metadata stripping can be disabled', async () => {
+  it('metadata stripping can be disabled via boolean', async () => {
     const t = vi.fn((i) => i)
 
     const { metadata } = await applyTransforms([t], img, false)
@@ -40,6 +40,16 @@ describe('applyTransforms', () => {
     expect(metadata).toHaveProperty('xmp')
   })
 
+  it('metadata stripping can be disabled via options object', async () => {
+    const t = vi.fn((i) => i)
+
+    const { metadata } = await applyTransforms([t], img, { removeMetadata: false })
+
+    expect(t).toBeCalled()
+    expect(metadata).toHaveProperty('icc')
+    expect(metadata).toHaveProperty('xmp')
+  })
+
   it('returns the image data & info', async () => {
     const t = vi.fn((i) => i)
 

packages/core/src/lib/apply-transforms.ts

@@ -1,15 +1,68 @@
 import type { Sharp } from 'sharp'
-import type { ImageTransformation, TransformResult } from '../types.js'
+import type { ApplyTransformsOptions, ImageTransformation, TransformResult } from '../types.js'
 import { METADATA } from './metadata.js'
+import sharp from 'sharp'
 
+const defaultOptions: ApplyTransformsOptions = {
+  removeMetadata: true
+}
+
+async function applyPreTransformOrientation(
+  transforms: ImageTransformation[],
+  image: Sharp,
+  opts: ApplyTransformsOptions
+) {
+  if (!opts.experimental?.preserveInitialOrientation) return image
+
+  const initialOrientation = image[METADATA].orientation
+  if (!initialOrientation || initialOrientation === 1) return image
+
+  let tempImage = image.clone()
+  tempImage[METADATA] = { ...image[METADATA] }
+
+  for (const transform of transforms) {
+    tempImage = await transform(tempImage)
+  }
+
+  const willFlip = !!tempImage[METADATA].flip
+  const willFlop = !!tempImage[METADATA].flop
+  const willRotate = !!tempImage[METADATA].rotate
+
+  image.rotate() // no args -> do the exif orientation
+
+  if (willFlip || willFlop || willRotate) {
+    image = sharp(await image.toBuffer())
+    image[METADATA] = { ...image[METADATA] }
+  }
+
+  return image
+}
+
+export async function applyTransforms(
+  transforms: ImageTransformation[],
+  image: Sharp,
+  options?: ApplyTransformsOptions
+): Promise<TransformResult>
 export async function applyTransforms(
   transforms: ImageTransformation[],
   image: Sharp,
-  removeMetadata = true
+  removeMetadata?: boolean
+): Promise<TransformResult>
+export async function applyTransforms(
+  transforms: ImageTransformation[],
+  image: Sharp,
+  optionsOrRemoveMetadata?: ApplyTransformsOptions | boolean
 ): Promise<TransformResult> {
+  const opts = {
+    ...defaultOptions,
+    ...(typeof optionsOrRemoveMetadata === 'boolean'
+      ? { removeMetadata: optionsOrRemoveMetadata }
+      : optionsOrRemoveMetadata)
+  }
+
   image[METADATA] = { ...(await image.metadata()) }
 
-  if (removeMetadata) {
+  if (opts.removeMetadata) {
     // delete the private metadata
     delete image[METADATA].exif
     delete image[METADATA].iptc
@@ -20,6 +73,8 @@ export async function applyTransforms(
     image.withMetadata()
   }
 
+  image = await applyPreTransformOrientation(transforms, image, opts)
+
   for (const transform of transforms) {
     image = await transform(image)
   }