@payloadcms/transformer-sharp 4.0.0-internal.58473b9

package/dist/transformFile.spec.js

@@ -0,0 +1,259 @@
+import sharp from 'sharp';
+import { describe, expect, it } from 'vitest';
+import { createTransformFile } from './transformFile.js';
+const makeReq = ()=>({});
+const toBuffer = async (file)=>Buffer.from(await file.arrayBuffer());
+const makeImageBuffer = async ({ background = {
+    b: 0,
+    g: 128,
+    r: 255
+}, height, width })=>sharp({
+        create: {
+            background,
+            channels: 3,
+            height,
+            width
+        }
+    }).png().toBuffer();
+/**
+ * A two-colour image split along `splitAxis` (red/blue halves) — proves the
+ * focal-point extract region in `transformSize` lands where the math says,
+ * not just that the output dimensions are right.
+ */ const makeTwoColorImage = async ({ height, splitAxis, width })=>{
+    const raw = Buffer.alloc(width * height * 3);
+    for(let y = 0; y < height; y++){
+        for(let x = 0; x < width; x++){
+            const idx = (y * width + x) * 3;
+            const isFirstHalf = splitAxis === 'x' ? x < width / 2 : y < height / 2;
+            if (isFirstHalf) {
+                raw[idx] = 255; // red
+            } else {
+                raw[idx + 2] = 255; // blue
+            }
+        }
+    }
+    return sharp(raw, {
+        raw: {
+            channels: 3,
+            height,
+            width
+        }
+    }).png().toBuffer();
+};
+const sampleRawPixel = ({ data, info, x, y })=>{
+    const idx = (y * info.width + x) * info.channels;
+    return {
+        b: data[idx + 2],
+        g: data[idx + 1],
+        r: data[idx]
+    };
+};
+describe('createTransformFile', ()=>{
+    describe('main (transformMain)', ()=>{
+        it('should trim uniform-colour padding from the main file', async ()=>{
+            const square = await makeImageBuffer({
+                background: {
+                    b: 0,
+                    g: 0,
+                    r: 0
+                },
+                height: 20,
+                width: 20
+            });
+            const framed = await sharp({
+                create: {
+                    background: {
+                        b: 255,
+                        g: 255,
+                        r: 255
+                    },
+                    channels: 3,
+                    height: 60,
+                    width: 60
+                }
+            }).composite([
+                {
+                    input: square,
+                    left: 20,
+                    top: 20
+                }
+            ]).png().toBuffer();
+            const file = new File([
+                framed
+            ], 'photo.png', {
+                type: 'image/png'
+            });
+            const transformFile = createTransformFile({
+                sharpDependency: sharp
+            });
+            const result = await transformFile({
+                file,
+                options: {
+                    collectionUpload: {
+                        trimOptions: {}
+                    },
+                    kind: 'main'
+                },
+                req: makeReq()
+            });
+            const metadata = await sharp(await toBuffer(result.file)).metadata();
+            expect(metadata.width).toBe(20);
+            expect(metadata.height).toBe(20);
+        });
+        it.each([
+            // Re-applied by default, so the 40x40 crop is resized down to 20x20.
+            {
+                expectedSize: 20,
+                resizeOptions: {
+                    fit: 'cover',
+                    height: 20,
+                    width: 20
+                }
+            },
+            {
+                expectedSize: 40,
+                resizeOptions: {
+                    height: 20,
+                    width: 20,
+                    withoutEnlargement: true
+                }
+            }
+        ])('should re-apply resizeOptions to the crop output unless withoutEnlargement is set (%#)', async ({ expectedSize, resizeOptions })=>{
+            const buffer = await makeImageBuffer({
+                height: 100,
+                width: 100
+            });
+            const file = new File([
+                buffer
+            ], 'photo.png', {
+                type: 'image/png'
+            });
+            const transformFile = createTransformFile({
+                sharpDependency: sharp
+            });
+            const result = await transformFile({
+                file,
+                options: {
+                    collectionUpload: {
+                        resizeOptions
+                    },
+                    crop: {
+                        cropData: {
+                            height: 40,
+                            unit: '%',
+                            width: 40,
+                            x: 25,
+                            y: 25
+                        },
+                        heightInPixels: 40,
+                        originalDimensions: {
+                            height: 100,
+                            width: 100
+                        },
+                        widthInPixels: 40
+                    },
+                    kind: 'main'
+                },
+                req: makeReq()
+            });
+            const metadata = await sharp(await toBuffer(result.file)).metadata();
+            expect(metadata.width).toBe(expectedSize);
+            expect(metadata.height).toBe(expectedSize);
+        });
+    });
+    describe('size (transformSize)', ()=>{
+        // Each original forces one resize-priority branch, and a focal point at 80% pushes the
+        // 50px extract window against the clamped far edge, so a correct crop is entirely blue.
+        it.each([
+            {
+                focalPoint: {
+                    x: 80,
+                    y: 50
+                },
+                original: {
+                    height: 100,
+                    splitAxis: 'x',
+                    width: 200
+                },
+                samples: [
+                    {
+                        x: 10,
+                        y: 25
+                    },
+                    {
+                        x: 40,
+                        y: 25
+                    }
+                ]
+            },
+            {
+                focalPoint: {
+                    x: 50,
+                    y: 80
+                },
+                original: {
+                    height: 200,
+                    splitAxis: 'y',
+                    width: 100
+                },
+                samples: [
+                    {
+                        x: 25,
+                        y: 10
+                    },
+                    {
+                        x: 25,
+                        y: 40
+                    }
+                ]
+            }
+        ])('should extract the focal-point region along the $original.splitAxis axis', async ({ focalPoint, original, samples })=>{
+            const buffer = await makeTwoColorImage(original);
+            const file = new File([
+                buffer
+            ], 'photo.png', {
+                type: 'image/png'
+            });
+            const transformFile = createTransformFile({
+                sharpDependency: sharp
+            });
+            const result = await transformFile({
+                file,
+                options: {
+                    collectionUpload: {},
+                    focalPoint,
+                    imageResizeConfig: {
+                        name: 'thumb',
+                        height: 50,
+                        width: 50
+                    },
+                    kind: 'size',
+                    originalDimensions: {
+                        height: original.height,
+                        width: original.width
+                    }
+                },
+                req: makeReq()
+            });
+            const { data, info } = await sharp(await toBuffer(result.file)).raw().toBuffer({
+                resolveWithObject: true
+            });
+            expect(info.width).toBe(50);
+            expect(info.height).toBe(50);
+            for (const { x, y } of samples){
+                expect(sampleRawPixel({
+                    data,
+                    info,
+                    x,
+                    y
+                })).toEqual({
+                    b: 255,
+                    g: 0,
+                    r: 0
+                });
+            }
+        });
+    });
+});
+
+//# sourceMappingURL=transformFile.spec.js.map

package/dist/transformFile.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/transformFile.spec.ts"],"sourcesContent":["import type { PayloadRequest } from 'payload'\n\nimport sharp from 'sharp'\nimport { describe, expect, it } from 'vitest'\n\nimport type { SharpUploadTaskOptions } from './types.js'\n\nimport { createTransformFile } from './transformFile.js'\n\nconst makeReq = (): PayloadRequest => ({}) as PayloadRequest\n\nconst toBuffer = async (file: File): Promise<Buffer> => Buffer.from(await file.arrayBuffer())\n\nconst makeImageBuffer = async ({\n  background = { b: 0, g: 128, r: 255 },\n  height,\n  width,\n}: {\n  background?: { b: number; g: number; r: number }\n  height: number\n  width: number\n}): Promise<Buffer> =>\n  sharp({ create: { background, channels: 3, height, width } })\n    .png()\n    .toBuffer()\n\n/**\n * A two-colour image split along `splitAxis` (red/blue halves) — proves the\n * focal-point extract region in `transformSize` lands where the math says,\n * not just that the output dimensions are right.\n */\nconst makeTwoColorImage = async ({\n  height,\n  splitAxis,\n  width,\n}: {\n  height: number\n  splitAxis: 'x' | 'y'\n  width: number\n}): Promise<Buffer> => {\n  const raw = Buffer.alloc(width * height * 3)\n\n  for (let y = 0; y < height; y++) {\n    for (let x = 0; x < width; x++) {\n      const idx = (y * width + x) * 3\n      const isFirstHalf = splitAxis === 'x' ? x < width / 2 : y < height / 2\n\n      if (isFirstHalf) {\n        raw[idx] = 255 // red\n      } else {\n        raw[idx + 2] = 255 // blue\n      }\n    }\n  }\n\n  return sharp(raw, { raw: { channels: 3, height, width } })\n    .png()\n    .toBuffer()\n}\n\nconst sampleRawPixel = ({\n  data,\n  info,\n  x,\n  y,\n}: {\n  data: Buffer\n  info: { channels: number; width: number }\n  x: number\n  y: number\n}): { b: number; g: number; r: number } => {\n  const idx = (y * info.width + x) * info.channels\n  return { b: data[idx + 2]!, g: data[idx + 1]!, r: data[idx]! }\n}\n\ndescribe('createTransformFile', () => {\n  describe('main (transformMain)', () => {\n    it('should trim uniform-colour padding from the main file', async () => {\n      const square = await makeImageBuffer({\n        background: { b: 0, g: 0, r: 0 },\n        height: 20,\n        width: 20,\n      })\n      const framed = await sharp({\n        create: { background: { b: 255, g: 255, r: 255 }, channels: 3, height: 60, width: 60 },\n      })\n        .composite([{ input: square, left: 20, top: 20 }])\n        .png()\n        .toBuffer()\n      const file = new File([framed], 'photo.png', { type: 'image/png' })\n      const transformFile = createTransformFile({ sharpDependency: sharp })\n\n      const result = await transformFile({\n        file,\n        options: {\n          collectionUpload: { trimOptions: {} },\n          kind: 'main',\n        } satisfies SharpUploadTaskOptions,\n        req: makeReq(),\n      })\n\n      const metadata = await sharp(await toBuffer(result.file!)).metadata()\n      expect(metadata.width).toBe(20)\n      expect(metadata.height).toBe(20)\n    })\n\n    it.each([\n      // Re-applied by default, so the 40x40 crop is resized down to 20x20.\n      { expectedSize: 20, resizeOptions: { fit: 'cover' as const, height: 20, width: 20 } },\n      { expectedSize: 40, resizeOptions: { height: 20, width: 20, withoutEnlargement: true } },\n    ])(\n      'should re-apply resizeOptions to the crop output unless withoutEnlargement is set (%#)',\n      async ({ expectedSize, resizeOptions }) => {\n        const buffer = await makeImageBuffer({ height: 100, width: 100 })\n        const file = new File([buffer], 'photo.png', { type: 'image/png' })\n        const transformFile = createTransformFile({ sharpDependency: sharp })\n\n        const result = await transformFile({\n          file,\n          options: {\n            collectionUpload: { resizeOptions },\n            crop: {\n              cropData: { height: 40, unit: '%', width: 40, x: 25, y: 25 },\n              heightInPixels: 40,\n              originalDimensions: { height: 100, width: 100 },\n              widthInPixels: 40,\n            },\n            kind: 'main',\n          } satisfies SharpUploadTaskOptions,\n          req: makeReq(),\n        })\n\n        const metadata = await sharp(await toBuffer(result.file!)).metadata()\n        expect(metadata.width).toBe(expectedSize)\n        expect(metadata.height).toBe(expectedSize)\n      },\n    )\n  })\n\n  describe('size (transformSize)', () => {\n    // Each original forces one resize-priority branch, and a focal point at 80% pushes the\n    // 50px extract window against the clamped far edge, so a correct crop is entirely blue.\n    it.each([\n      {\n        focalPoint: { x: 80, y: 50 },\n        original: { height: 100, splitAxis: 'x' as const, width: 200 },\n        samples: [\n          { x: 10, y: 25 },\n          { x: 40, y: 25 },\n        ],\n      },\n      {\n        focalPoint: { x: 50, y: 80 },\n        original: { height: 200, splitAxis: 'y' as const, width: 100 },\n        samples: [\n          { x: 25, y: 10 },\n          { x: 25, y: 40 },\n        ],\n      },\n    ])(\n      'should extract the focal-point region along the $original.splitAxis axis',\n      async ({ focalPoint, original, samples }) => {\n        const buffer = await makeTwoColorImage(original)\n        const file = new File([buffer], 'photo.png', { type: 'image/png' })\n        const transformFile = createTransformFile({ sharpDependency: sharp })\n\n        const result = await transformFile({\n          file,\n          options: {\n            collectionUpload: {},\n            focalPoint,\n            imageResizeConfig: { name: 'thumb', height: 50, width: 50 },\n            kind: 'size',\n            originalDimensions: { height: original.height, width: original.width },\n          } satisfies SharpUploadTaskOptions,\n          req: makeReq(),\n        })\n\n        const { data, info } = await sharp(await toBuffer(result.file!))\n          .raw()\n          .toBuffer({ resolveWithObject: true })\n        expect(info.width).toBe(50)\n        expect(info.height).toBe(50)\n        for (const { x, y } of samples) {\n          expect(sampleRawPixel({ data, info, x, y })).toEqual({ b: 255, g: 0, r: 0 })\n        }\n      },\n    )\n  })\n})\n"],"names":["sharp","describe","expect","it","createTransformFile","makeReq","toBuffer","file","Buffer","from","arrayBuffer","makeImageBuffer","background","b","g","r","height","width","create","channels","png","makeTwoColorImage","splitAxis","raw","alloc","y","x","idx","isFirstHalf","sampleRawPixel","data","info","square","framed","composite","input","left","top","File","type","transformFile","sharpDependency","result","options","collectionUpload","trimOptions","kind","req","metadata","toBe","each","expectedSize","resizeOptions","fit","withoutEnlargement","buffer","crop","cropData","unit","heightInPixels","originalDimensions","widthInPixels","focalPoint","original","samples","imageResizeConfig","name","resolveWithObject","toEqual"],"mappings":"AAEA,OAAOA,WAAW,QAAO;AACzB,SAASC,QAAQ,EAAEC,MAAM,EAAEC,EAAE,QAAQ,SAAQ;AAI7C,SAASC,mBAAmB,QAAQ,qBAAoB;AAExD,MAAMC,UAAU,IAAuB,CAAA,CAAC,CAAA;AAExC,MAAMC,WAAW,OAAOC,OAAgCC,OAAOC,IAAI,CAAC,MAAMF,KAAKG,WAAW;AAE1F,MAAMC,kBAAkB,OAAO,EAC7BC,aAAa;IAAEC,GAAG;IAAGC,GAAG;IAAKC,GAAG;AAAI,CAAC,EACrCC,MAAM,EACNC,KAAK,EAKN,GACCjB,MAAM;QAAEkB,QAAQ;YAAEN;YAAYO,UAAU;YAAGH;YAAQC;QAAM;IAAE,GACxDG,GAAG,GACHd,QAAQ;AAEb;;;;CAIC,GACD,MAAMe,oBAAoB,OAAO,EAC/BL,MAAM,EACNM,SAAS,EACTL,KAAK,EAKN;IACC,MAAMM,MAAMf,OAAOgB,KAAK,CAACP,QAAQD,SAAS;IAE1C,IAAK,IAAIS,IAAI,GAAGA,IAAIT,QAAQS,IAAK;QAC/B,IAAK,IAAIC,IAAI,GAAGA,IAAIT,OAAOS,IAAK;YAC9B,MAAMC,MAAM,AAACF,CAAAA,IAAIR,QAAQS,CAAAA,IAAK;YAC9B,MAAME,cAAcN,cAAc,MAAMI,IAAIT,QAAQ,IAAIQ,IAAIT,SAAS;YAErE,IAAIY,aAAa;gBACfL,GAAG,CAACI,IAAI,GAAG,KAAI,MAAM;YACvB,OAAO;gBACLJ,GAAG,CAACI,MAAM,EAAE,GAAG,KAAI,OAAO;YAC5B;QACF;IACF;IAEA,OAAO3B,MAAMuB,KAAK;QAAEA,KAAK;YAAEJ,UAAU;YAAGH;YAAQC;QAAM;IAAE,GACrDG,GAAG,GACHd,QAAQ;AACb;AAEA,MAAMuB,iBAAiB,CAAC,EACtBC,IAAI,EACJC,IAAI,EACJL,CAAC,EACDD,CAAC,EAMF;IACC,MAAME,MAAM,AAACF,CAAAA,IAAIM,KAAKd,KAAK,GAAGS,CAAAA,IAAKK,KAAKZ,QAAQ;IAChD,OAAO;QAAEN,GAAGiB,IAAI,CAACH,MAAM,EAAE;QAAGb,GAAGgB,IAAI,CAACH,MAAM,EAAE;QAAGZ,GAAGe,IAAI,CAACH,IAAI;IAAE;AAC/D;AAEA1B,SAAS,uBAAuB;IAC9BA,SAAS,wBAAwB;QAC/BE,GAAG,yDAAyD;YAC1D,MAAM6B,SAAS,MAAMrB,gBAAgB;gBACnCC,YAAY;oBAAEC,GAAG;oBAAGC,GAAG;oBAAGC,GAAG;gBAAE;gBAC/BC,QAAQ;gBACRC,OAAO;YACT;YACA,MAAMgB,SAAS,MAAMjC,MAAM;gBACzBkB,QAAQ;oBAAEN,YAAY;wBAAEC,GAAG;wBAAKC,GAAG;wBAAKC,GAAG;oBAAI;oBAAGI,UAAU;oBAAGH,QAAQ;oBAAIC,OAAO;gBAAG;YACvF,GACGiB,SAAS,CAAC;gBAAC;oBAAEC,OAAOH;oBAAQI,MAAM;oBAAIC,KAAK;gBAAG;aAAE,EAChDjB,GAAG,GACHd,QAAQ;YACX,MAAMC,OAAO,IAAI+B,KAAK;gBAACL;aAAO,EAAE,aAAa;gBAAEM,MAAM;YAAY;YACjE,MAAMC,gBAAgBpC,oBAAoB;gBAAEqC,iBAAiBzC;YAAM;YAEnE,MAAM0C,SAAS,MAAMF,cAAc;gBACjCjC;gBACAoC,SAAS;oBACPC,kBAAkB;wBAAEC,aAAa,CAAC;oBAAE;oBACpCC,MAAM;gBACR;gBACAC,KAAK1C;YACP;YAEA,MAAM2C,WAAW,MAAMhD,MAAM,MAAMM,SAASoC,OAAOnC,IAAI,GAAIyC,QAAQ;YACnE9C,OAAO8C,SAAS/B,KAAK,EAAEgC,IAAI,CAAC;YAC5B/C,OAAO8C,SAAShC,MAAM,EAAEiC,IAAI,CAAC;QAC/B;QAEA9C,GAAG+C,IAAI,CAAC;YACN,qEAAqE;YACrE;gBAAEC,cAAc;gBAAIC,eAAe;oBAAEC,KAAK;oBAAkBrC,QAAQ;oBAAIC,OAAO;gBAAG;YAAE;YACpF;gBAAEkC,cAAc;gBAAIC,eAAe;oBAAEpC,QAAQ;oBAAIC,OAAO;oBAAIqC,oBAAoB;gBAAK;YAAE;SACxF,EACC,0FACA,OAAO,EAAEH,YAAY,EAAEC,aAAa,EAAE;YACpC,MAAMG,SAAS,MAAM5C,gBAAgB;gBAAEK,QAAQ;gBAAKC,OAAO;YAAI;YAC/D,MAAMV,OAAO,IAAI+B,KAAK;gBAACiB;aAAO,EAAE,aAAa;gBAAEhB,MAAM;YAAY;YACjE,MAAMC,gBAAgBpC,oBAAoB;gBAAEqC,iBAAiBzC;YAAM;YAEnE,MAAM0C,SAAS,MAAMF,cAAc;gBACjCjC;gBACAoC,SAAS;oBACPC,kBAAkB;wBAAEQ;oBAAc;oBAClCI,MAAM;wBACJC,UAAU;4BAAEzC,QAAQ;4BAAI0C,MAAM;4BAAKzC,OAAO;4BAAIS,GAAG;4BAAID,GAAG;wBAAG;wBAC3DkC,gBAAgB;wBAChBC,oBAAoB;4BAAE5C,QAAQ;4BAAKC,OAAO;wBAAI;wBAC9C4C,eAAe;oBACjB;oBACAf,MAAM;gBACR;gBACAC,KAAK1C;YACP;YAEA,MAAM2C,WAAW,MAAMhD,MAAM,MAAMM,SAASoC,OAAOnC,IAAI,GAAIyC,QAAQ;YACnE9C,OAAO8C,SAAS/B,KAAK,EAAEgC,IAAI,CAACE;YAC5BjD,OAAO8C,SAAShC,MAAM,EAAEiC,IAAI,CAACE;QAC/B;IAEJ;IAEAlD,SAAS,wBAAwB;QAC/B,uFAAuF;QACvF,wFAAwF;QACxFE,GAAG+C,IAAI,CAAC;YACN;gBACEY,YAAY;oBAAEpC,GAAG;oBAAID,GAAG;gBAAG;gBAC3BsC,UAAU;oBAAE/C,QAAQ;oBAAKM,WAAW;oBAAcL,OAAO;gBAAI;gBAC7D+C,SAAS;oBACP;wBAAEtC,GAAG;wBAAID,GAAG;oBAAG;oBACf;wBAAEC,GAAG;wBAAID,GAAG;oBAAG;iBAChB;YACH;YACA;gBACEqC,YAAY;oBAAEpC,GAAG;oBAAID,GAAG;gBAAG;gBAC3BsC,UAAU;oBAAE/C,QAAQ;oBAAKM,WAAW;oBAAcL,OAAO;gBAAI;gBAC7D+C,SAAS;oBACP;wBAAEtC,GAAG;wBAAID,GAAG;oBAAG;oBACf;wBAAEC,GAAG;wBAAID,GAAG;oBAAG;iBAChB;YACH;SACD,EACC,4EACA,OAAO,EAAEqC,UAAU,EAAEC,QAAQ,EAAEC,OAAO,EAAE;YACtC,MAAMT,SAAS,MAAMlC,kBAAkB0C;YACvC,MAAMxD,OAAO,IAAI+B,KAAK;gBAACiB;aAAO,EAAE,aAAa;gBAAEhB,MAAM;YAAY;YACjE,MAAMC,gBAAgBpC,oBAAoB;gBAAEqC,iBAAiBzC;YAAM;YAEnE,MAAM0C,SAAS,MAAMF,cAAc;gBACjCjC;gBACAoC,SAAS;oBACPC,kBAAkB,CAAC;oBACnBkB;oBACAG,mBAAmB;wBAAEC,MAAM;wBAASlD,QAAQ;wBAAIC,OAAO;oBAAG;oBAC1D6B,MAAM;oBACNc,oBAAoB;wBAAE5C,QAAQ+C,SAAS/C,MAAM;wBAAEC,OAAO8C,SAAS9C,KAAK;oBAAC;gBACvE;gBACA8B,KAAK1C;YACP;YAEA,MAAM,EAAEyB,IAAI,EAAEC,IAAI,EAAE,GAAG,MAAM/B,MAAM,MAAMM,SAASoC,OAAOnC,IAAI,GAC1DgB,GAAG,GACHjB,QAAQ,CAAC;gBAAE6D,mBAAmB;YAAK;YACtCjE,OAAO6B,KAAKd,KAAK,EAAEgC,IAAI,CAAC;YACxB/C,OAAO6B,KAAKf,MAAM,EAAEiC,IAAI,CAAC;YACzB,KAAK,MAAM,EAAEvB,CAAC,EAAED,CAAC,EAAE,IAAIuC,QAAS;gBAC9B9D,OAAO2B,eAAe;oBAAEC;oBAAMC;oBAAML;oBAAGD;gBAAE,IAAI2C,OAAO,CAAC;oBAAEvD,GAAG;oBAAKC,GAAG;oBAAGC,GAAG;gBAAE;YAC5E;QACF;IAEJ;AACF"}

package/dist/types.d.ts

@@ -0,0 +1,150 @@
+import type { FocalPoint, ImageSize, PayloadRequest, ProbedImageSize, UploadCollectionSlug, UploadEdits } from 'payload';
+import type { FitEnum, ResizeOptions, Sharp, Metadata as SharpMetadata, SharpOptions } from 'sharp';
+/**
+ * Params sent to the sharp `toFormat()` function
+ * @link https://sharp.pixelplumbing.com/api-output#toformat
+ */
+export type ImageUploadFormatOptions = {
+    format: Parameters<Sharp['toFormat']>[0];
+    options?: Parameters<Sharp['toFormat']>[1];
+};
+/**
+ * Params sent to the sharp trim() function
+ * @link https://sharp.pixelplumbing.com/api-resize#trim
+ */
+export type ImageUploadTrimOptions = Parameters<Sharp['trim']>[0];
+export type WithMetadata = ((options: {
+    metadata: SharpMetadata;
+    req: PayloadRequest;
+}) => Promise<boolean>) | boolean;
+/**
+ * Image size options implemented by Payload's default Sharp image processor.
+ */
+export type SharpImageSizeOptions = {
+    /**
+     * @deprecated prefer position
+     */
+    crop?: string;
+    formatOptions?: ImageUploadFormatOptions;
+    trimOptions?: ImageUploadTrimOptions;
+    /** Image sizes generated for each upload, stored under the document's `variants`. */
+    variants?: ImageSize[];
+    /**
+     * When an uploaded image is smaller than the defined image size, we have 3 options:
+     *
+     * `undefined | false | true`
+     *
+     * 1. `undefined` [default]: uploading images with smaller width AND height than the image size will return null
+     * 2. `false`: always enlarge images to the image size
+     * 3. `true`: if the image is smaller than the image size, return the original image
+     */
+    withoutEnlargement?: ResizeOptions['withoutEnlargement'];
+} & Omit<ResizeOptions, 'withoutEnlargement'>;
+declare module 'payload' {
+    interface RegisteredImageSizeOptions {
+        sharp: SharpImageSizeOptions;
+    }
+}
+/**
+ * A collection's Sharp-owned upload-time settings, authored via
+ * `sharpTransformer({ collections: { <slug>: {...} } })`. `init()` writes a
+ * narrowed, Sharp-agnostic projection of `variants`/`crop`/`focalPoint`
+ * back onto the sanitized collection's `upload` config for core's own use (Admin UI,
+ * field generation); this richer shape is what the transformer itself reads.
+ */
+export type SharpCollectionConfig = {
+    constructorOptions?: SharpOptions;
+    crop?: boolean;
+    focalPoint?: boolean;
+    formatOptions?: ImageUploadFormatOptions;
+    resizeOptions?: ResizeOptions;
+    trimOptions?: ImageUploadTrimOptions;
+    /** Image sizes generated for each upload, stored under the document's `variants`. */
+    variants?: ImageSize[];
+    withMetadata?: WithMetadata;
+};
+/**
+ * Matches core's (soon-removed) `SharpDependency` shape, for advanced injection
+ * of a compatible custom Sharp build or version via `sharpTransformer({ sharp })`.
+ */
+export type SharpDependency = (input?: ArrayBuffer | Buffer | Float32Array | Float64Array | Int8Array | Int16Array | Int32Array | string | Uint8Array | Uint8ClampedArray | Uint16Array | Uint32Array, options?: SharpOptions) => Sharp;
+export type SharpDynamicDefaults = {
+    /** @default 'cover' */
+    fit?: keyof FitEnum;
+    /** @default 4096 */
+    maxHeight?: number;
+    /**
+     * Total output pixels, counted across every frame of an animated image.
+     * @default 16_777_216
+     */
+    maxPixels?: number;
+    /** @default 4096 */
+    maxWidth?: number;
+    /** @default 'center' */
+    position?: ResizeOptions['position'];
+    /** @default false */
+    withoutEnlargement?: boolean;
+};
+/**
+ * Enables request-time resizing and tunes its limits. `collections` restricts it
+ * to the listed upload collections; omit it to allow every upload collection.
+ */
+export type SharpDynamicOptions = {
+    collections?: UploadCollectionSlug[];
+} & SharpDynamicDefaults;
+/**
+ * The result of parsing a request's dynamic resize query parameters.
+ * `isRouted: false` means none of the recognized parameters were present at
+ * all — an ordinary file read, not a dynamic transformation attempt.
+ */
+export type DynamicResizeParseResult = {
+    error: string;
+    isRouted: true;
+    valid: false;
+} | {
+    height?: number;
+    isRouted: true;
+    valid: true;
+    width?: number;
+    withoutEnlargement?: boolean;
+} | {
+    isRouted: false;
+};
+export type SharpTransformerOptions = {
+    /** Per-collection upload-time image processing settings. */
+    collections?: Partial<Record<UploadCollectionSlug, SharpCollectionConfig>>;
+    /**
+     * Request-time resizing via `?width=`/`?height=` on the file endpoint. `true`
+     * enables it with default limits for every upload collection; an object enables
+     * it with custom limits, optionally restricted to specific collections.
+     *
+     * @default false
+     */
+    dynamic?: boolean | SharpDynamicOptions;
+    /** Inject a compatible custom Sharp build or version. Defaults to the bundled dependency. */
+    sharp?: SharpDependency;
+    /** @default 'sharp' */
+    slug?: string;
+};
+/**
+ * `options` for the one-file-in/one-file-out `transformFile` primitive, computed
+ * by `prepareLegacyUpload` for each task it hands to the injected `transform`
+ * callback: the main file (optionally a crop), or one named legacy image size.
+ */
+export type SharpUploadTaskOptions = {
+    collectionUpload: SharpCollectionConfig;
+    crop?: {
+        cropData: NonNullable<UploadEdits['crop']>;
+        heightInPixels: number;
+        originalDimensions: ProbedImageSize;
+        widthInPixels: number;
+    };
+    kind: 'main';
+} | {
+    collectionUpload: SharpCollectionConfig;
+    focalPoint?: FocalPoint;
+    imageResizeConfig: ImageSize;
+    kind: 'size';
+    originalDimensions: ProbedImageSize;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,UAAU,EACV,SAAS,EACT,cAAc,EACd,eAAe,EACf,oBAAoB,EACpB,WAAW,EACZ,MAAM,SAAS,CAAA;AAChB,OAAO,KAAK,EAAE,OAAO,EAAE,aAAa,EAAE,KAAK,EAAE,QAAQ,IAAI,aAAa,EAAE,YAAY,EAAE,MAAM,OAAO,CAAA;AAEnG;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,MAAM,EAAE,UAAU,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IACxC,OAAO,CAAC,EAAE,UAAU,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;CAC3C,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;AAEjE,MAAM,MAAM,YAAY,GACpB,CAAC,CAAC,OAAO,EAAE;IAAE,QAAQ,EAAE,aAAa,CAAC;IAAC,GAAG,EAAE,cAAc,CAAA;CAAE,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC,GACjF,OAAO,CAAA;AAEX;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,aAAa,CAAC,EAAE,wBAAwB,CAAA;IACxC,WAAW,CAAC,EAAE,sBAAsB,CAAA;IACpC,qFAAqF;IACrF,QAAQ,CAAC,EAAE,SAAS,EAAE,CAAA;IACtB;;;;;;;;OAQG;IACH,kBAAkB,CAAC,EAAE,aAAa,CAAC,oBAAoB,CAAC,CAAA;CACzD,GAAG,IAAI,CAAC,aAAa,EAAE,oBAAoB,CAAC,CAAA;AAE7C,OAAO,QAAQ,SAAS,CAAC;IACvB,UAAU,0BAA0B;QAClC,KAAK,EAAE,qBAAqB,CAAA;KAC7B;CACF;AAED;;;;;;GAMG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,kBAAkB,CAAC,EAAE,YAAY,CAAA;IACjC,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,aAAa,CAAC,EAAE,wBAAwB,CAAA;IACxC,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B,WAAW,CAAC,EAAE,sBAAsB,CAAA;IACpC,qFAAqF;IACrF,QAAQ,CAAC,EAAE,SAAS,EAAE,CAAA;IACtB,YAAY,CAAC,EAAE,YAAY,CAAA;CAC5B,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,CAC5B,KAAK,CAAC,EACF,WAAW,GACX,MAAM,GACN,YAAY,GACZ,YAAY,GACZ,SAAS,GACT,UAAU,GACV,UAAU,GACV,MAAM,GACN,UAAU,GACV,iBAAiB,GACjB,WAAW,GACX,WAAW,EACf,OAAO,CAAC,EAAE,YAAY,KACnB,KAAK,CAAA;AAEV,MAAM,MAAM,oBAAoB,GAAG;IACjC,uBAAuB;IACvB,GAAG,CAAC,EAAE,MAAM,OAAO,CAAA;IACnB,oBAAoB;IACpB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,oBAAoB;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,wBAAwB;IACxB,QAAQ,CAAC,EAAE,aAAa,CAAC,UAAU,CAAC,CAAA;IACpC,qBAAqB;IACrB,kBAAkB,CAAC,EAAE,OAAO,CAAA;CAC7B,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,WAAW,CAAC,EAAE,oBAAoB,EAAE,CAAA;CACrC,GAAG,oBAAoB,CAAA;AAExB;;;;GAIG;AACH,MAAM,MAAM,wBAAwB,GAChC;IACE,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,IAAI,CAAA;IACd,KAAK,EAAE,KAAK,CAAA;CACb,GACD;IACE,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,IAAI,CAAA;IACd,KAAK,EAAE,IAAI,CAAA;IACX,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,kBAAkB,CAAC,EAAE,OAAO,CAAA;CAC7B,GACD;IACE,QAAQ,EAAE,KAAK,CAAA;CAChB,CAAA;AAEL,MAAM,MAAM,uBAAuB,GAAG;IACpC,4DAA4D;IAC5D,WAAW,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,oBAAoB,EAAE,qBAAqB,CAAC,CAAC,CAAA;IAC1E;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,mBAAmB,CAAA;IACvC,6FAA6F;IAC7F,KAAK,CAAC,EAAE,eAAe,CAAA;IACvB,uBAAuB;IACvB,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAC9B;IACE,gBAAgB,EAAE,qBAAqB,CAAA;IACvC,IAAI,CAAC,EAAE;QACL,QAAQ,EAAE,WAAW,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAA;QAC1C,cAAc,EAAE,MAAM,CAAA;QACtB,kBAAkB,EAAE,eAAe,CAAA;QACnC,aAAa,EAAE,MAAM,CAAA;KACtB,CAAA;IACD,IAAI,EAAE,MAAM,CAAA;CACb,GACD;IACE,gBAAgB,EAAE,qBAAqB,CAAA;IACvC,UAAU,CAAC,EAAE,UAAU,CAAA;IACvB,iBAAiB,EAAE,SAAS,CAAA;IAC5B,IAAI,EAAE,MAAM,CAAA;IACZ,kBAAkB,EAAE,eAAe,CAAA;CACpC,CAAA"}

package/dist/types.js

@@ -0,0 +1,7 @@
+/**
+ * `options` for the one-file-in/one-file-out `transformFile` primitive, computed
+ * by `prepareLegacyUpload` for each task it hands to the injected `transform`
+ * callback: the main file (optionally a crop), or one named legacy image size.
+ */ export { };
+
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/types.ts"],"sourcesContent":["import type {\n  FocalPoint,\n  ImageSize,\n  PayloadRequest,\n  ProbedImageSize,\n  UploadCollectionSlug,\n  UploadEdits,\n} from 'payload'\nimport type { FitEnum, ResizeOptions, Sharp, Metadata as SharpMetadata, SharpOptions } from 'sharp'\n\n/**\n * Params sent to the sharp `toFormat()` function\n * @link https://sharp.pixelplumbing.com/api-output#toformat\n */\nexport type ImageUploadFormatOptions = {\n  format: Parameters<Sharp['toFormat']>[0]\n  options?: Parameters<Sharp['toFormat']>[1]\n}\n\n/**\n * Params sent to the sharp trim() function\n * @link https://sharp.pixelplumbing.com/api-resize#trim\n */\nexport type ImageUploadTrimOptions = Parameters<Sharp['trim']>[0]\n\nexport type WithMetadata =\n  | ((options: { metadata: SharpMetadata; req: PayloadRequest }) => Promise<boolean>)\n  | boolean\n\n/**\n * Image size options implemented by Payload's default Sharp image processor.\n */\nexport type SharpImageSizeOptions = {\n  /**\n   * @deprecated prefer position\n   */\n  crop?: string // comes from sharp package\n  formatOptions?: ImageUploadFormatOptions\n  trimOptions?: ImageUploadTrimOptions\n  /** Image sizes generated for each upload, stored under the document's `variants`. */\n  variants?: ImageSize[]\n  /**\n   * When an uploaded image is smaller than the defined image size, we have 3 options:\n   *\n   * `undefined | false | true`\n   *\n   * 1. `undefined` [default]: uploading images with smaller width AND height than the image size will return null\n   * 2. `false`: always enlarge images to the image size\n   * 3. `true`: if the image is smaller than the image size, return the original image\n   */\n  withoutEnlargement?: ResizeOptions['withoutEnlargement']\n} & Omit<ResizeOptions, 'withoutEnlargement'>\n\ndeclare module 'payload' {\n  interface RegisteredImageSizeOptions {\n    sharp: SharpImageSizeOptions\n  }\n}\n\n/**\n * A collection's Sharp-owned upload-time settings, authored via\n * `sharpTransformer({ collections: { <slug>: {...} } })`. `init()` writes a\n * narrowed, Sharp-agnostic projection of `variants`/`crop`/`focalPoint`\n * back onto the sanitized collection's `upload` config for core's own use (Admin UI,\n * field generation); this richer shape is what the transformer itself reads.\n */\nexport type SharpCollectionConfig = {\n  constructorOptions?: SharpOptions\n  crop?: boolean\n  focalPoint?: boolean\n  formatOptions?: ImageUploadFormatOptions\n  resizeOptions?: ResizeOptions\n  trimOptions?: ImageUploadTrimOptions\n  /** Image sizes generated for each upload, stored under the document's `variants`. */\n  variants?: ImageSize[]\n  withMetadata?: WithMetadata\n}\n\n/**\n * Matches core's (soon-removed) `SharpDependency` shape, for advanced injection\n * of a compatible custom Sharp build or version via `sharpTransformer({ sharp })`.\n */\nexport type SharpDependency = (\n  input?:\n    | ArrayBuffer\n    | Buffer\n    | Float32Array\n    | Float64Array\n    | Int8Array\n    | Int16Array\n    | Int32Array\n    | string\n    | Uint8Array\n    | Uint8ClampedArray\n    | Uint16Array\n    | Uint32Array,\n  options?: SharpOptions,\n) => Sharp\n\nexport type SharpDynamicDefaults = {\n  /** @default 'cover' */\n  fit?: keyof FitEnum\n  /** @default 4096 */\n  maxHeight?: number\n  /**\n   * Total output pixels, counted across every frame of an animated image.\n   * @default 16_777_216\n   */\n  maxPixels?: number\n  /** @default 4096 */\n  maxWidth?: number\n  /** @default 'center' */\n  position?: ResizeOptions['position']\n  /** @default false */\n  withoutEnlargement?: boolean\n}\n\n/**\n * Enables request-time resizing and tunes its limits. `collections` restricts it\n * to the listed upload collections; omit it to allow every upload collection.\n */\nexport type SharpDynamicOptions = {\n  collections?: UploadCollectionSlug[]\n} & SharpDynamicDefaults\n\n/**\n * The result of parsing a request's dynamic resize query parameters.\n * `isRouted: false` means none of the recognized parameters were present at\n * all — an ordinary file read, not a dynamic transformation attempt.\n */\nexport type DynamicResizeParseResult =\n  | {\n      error: string\n      isRouted: true\n      valid: false\n    }\n  | {\n      height?: number\n      isRouted: true\n      valid: true\n      width?: number\n      withoutEnlargement?: boolean\n    }\n  | {\n      isRouted: false\n    }\n\nexport type SharpTransformerOptions = {\n  /** Per-collection upload-time image processing settings. */\n  collections?: Partial<Record<UploadCollectionSlug, SharpCollectionConfig>>\n  /**\n   * Request-time resizing via `?width=`/`?height=` on the file endpoint. `true`\n   * enables it with default limits for every upload collection; an object enables\n   * it with custom limits, optionally restricted to specific collections.\n   *\n   * @default false\n   */\n  dynamic?: boolean | SharpDynamicOptions\n  /** Inject a compatible custom Sharp build or version. Defaults to the bundled dependency. */\n  sharp?: SharpDependency\n  /** @default 'sharp' */\n  slug?: string\n}\n\n/**\n * `options` for the one-file-in/one-file-out `transformFile` primitive, computed\n * by `prepareLegacyUpload` for each task it hands to the injected `transform`\n * callback: the main file (optionally a crop), or one named legacy image size.\n */\nexport type SharpUploadTaskOptions =\n  | {\n      collectionUpload: SharpCollectionConfig\n      crop?: {\n        cropData: NonNullable<UploadEdits['crop']>\n        heightInPixels: number\n        originalDimensions: ProbedImageSize\n        widthInPixels: number\n      }\n      kind: 'main'\n    }\n  | {\n      collectionUpload: SharpCollectionConfig\n      focalPoint?: FocalPoint\n      imageResizeConfig: ImageSize\n      kind: 'size'\n      originalDimensions: ProbedImageSize\n    }\n"],"names":[],"mappings":"AAoKA;;;;CAIC,GACD,WAiBK"}

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@payloadcms/transformer-sharp",
+  "version": "4.0.0-internal.58473b9",
+  "description": "Official Sharp-based file transformer for Payload: request-time image resizing and upload-time image processing",
+  "homepage": "https://payloadcms.com",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/payloadcms/payload.git",
+    "directory": "packages/transformer-sharp"
+  },
+  "license": "MIT",
+  "author": "Payload <dev@payloadcms.com> (https://payloadcms.com)",
+  "maintainers": [
+    {
+      "name": "Payload",
+      "email": "info@payloadcms.com",
+      "url": "https://payloadcms.com"
+    }
+  ],
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "sharp": "0.35.4"
+  },
+  "devDependencies": {
+    "payload": "4.0.0-internal.58473b9"
+  },
+  "peerDependencies": {
+    "payload": "4.0.0-internal.58473b9"
+  },
+  "engines": {
+    "node": ">=24.15.0"
+  },
+  "scripts": {
+    "build": "pnpm build:types && pnpm build:swc",
+    "build:clean": "find . \\( -type d \\( -name build -o -name dist -o -name .cache \\) -o -type f -name tsconfig.tsbuildinfo \\) -exec rm -rf {} + && pnpm build",
+    "build:debug": "pnpm build",
+    "build:swc": "swc ./src -d ./dist --config-file .swcrc --strip-leading-paths",
+    "build:types": "tsc --emitDeclarationOnly --outDir dist",
+    "clean": "rimraf -g {dist,*.tsbuildinfo}",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix"
+  }
+}