@payloadcms/transformer-sharp 4.0.0-beta.0 → 4.0.0-beta.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/createTransformUpload.d.ts +14 -0
- package/dist/createTransformUpload.d.ts.map +1 -0
- package/dist/{prepareLegacyUpload.js → createTransformUpload.js} +15 -24
- package/dist/createTransformUpload.js.map +1 -0
- package/dist/{prepareLegacyUpload.spec.js → createTransformUpload.spec.js} +12 -24
- package/dist/createTransformUpload.spec.js.map +1 -0
- package/dist/initSharpCollections.d.ts +6 -6
- package/dist/initSharpCollections.d.ts.map +1 -1
- package/dist/initSharpCollections.js +14 -58
- package/dist/initSharpCollections.js.map +1 -1
- package/dist/initSharpCollections.spec.js +20 -7
- package/dist/initSharpCollections.spec.js.map +1 -1
- package/dist/readSavedTransforms.d.ts +14 -0
- package/dist/readSavedTransforms.d.ts.map +1 -0
- package/dist/readSavedTransforms.js +42 -0
- package/dist/readSavedTransforms.js.map +1 -0
- package/dist/sharpTransformer.d.ts.map +1 -1
- package/dist/sharpTransformer.js +14 -6
- package/dist/sharpTransformer.js.map +1 -1
- package/dist/sharpTransformer.spec.js +30 -0
- package/dist/sharpTransformer.spec.js.map +1 -1
- package/dist/transformFile.d.ts +4 -4
- package/dist/transformFile.d.ts.map +1 -1
- package/dist/transformFile.js +31 -16
- package/dist/transformFile.js.map +1 -1
- package/dist/transformFile.spec.js +210 -24
- package/dist/transformFile.spec.js.map +1 -1
- package/dist/types.d.ts +23 -13
- package/dist/types.d.ts.map +1 -1
- package/dist/types.js +3 -2
- package/dist/types.js.map +1 -1
- package/package.json +17 -19
- package/dist/prepareLegacyUpload.d.ts +0 -14
- package/dist/prepareLegacyUpload.d.ts.map +0 -1
- package/dist/prepareLegacyUpload.js.map +0 -1
- package/dist/prepareLegacyUpload.spec.js.map +0 -1
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import type { UploadTransformerInternal } from 'payload/internal';
|
|
2
|
+
import type { SharpCollectionConfig, SharpDependency } from './types.js';
|
|
3
|
+
/**
|
|
4
|
+
* Creates the Sharp bridge's `transformUpload`. When core calls it, it plans the upload tasks (the
|
|
5
|
+
* main file, optionally cropped, and every configured image size), runs each one through the
|
|
6
|
+
* injected `transform` callback exactly once, and reads the size of each result. Reads the
|
|
7
|
+
* Sharp-owned config from `sharpTransformer({ collections })` at factory-construction time — not
|
|
8
|
+
* from the sanitized collection, which only gets the narrowed projection `init()` writes back.
|
|
9
|
+
*/
|
|
10
|
+
export declare function createTransformUpload({ collections, sharpDependency, }: {
|
|
11
|
+
collections: Partial<Record<string, SharpCollectionConfig>>;
|
|
12
|
+
sharpDependency: SharpDependency;
|
|
13
|
+
}): NonNullable<UploadTransformerInternal['transformUpload']>;
|
|
14
|
+
//# sourceMappingURL=createTransformUpload.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"createTransformUpload.d.ts","sourceRoot":"","sources":["../src/createTransformUpload.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAwB,yBAAyB,EAAE,MAAM,kBAAkB,CAAA;AAEvF,OAAO,KAAK,EAAE,qBAAqB,EAAE,eAAe,EAA0B,MAAM,YAAY,CAAA;AAsBhG;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CAAC,EACpC,WAAW,EACX,eAAe,GAChB,EAAE;IACD,WAAW,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC,CAAA;IAC3D,eAAe,EAAE,eAAe,CAAA;CACjC,GAAG,WAAW,CAAC,yBAAyB,CAAC,iBAAiB,CAAC,CAAC,CAqF5D"}
|
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
import { isNumber } from 'payload/shared';
|
|
2
1
|
import { canResizeImage } from './canResizeImage.js';
|
|
3
2
|
import { createSharpFromFile } from './createSharpFromFile.js';
|
|
4
3
|
import { getImageResizeAction } from './getImageResizeAction.js';
|
|
@@ -20,16 +19,15 @@ import { sanitizeResizeConfig } from './sanitizeResizeConfig.js';
|
|
|
20
19
|
}
|
|
21
20
|
}
|
|
22
21
|
/**
|
|
23
|
-
*
|
|
24
|
-
* configured
|
|
25
|
-
* exactly once
|
|
26
|
-
* at factory-construction time — not
|
|
27
|
-
* the narrowed projection `init()` writes back.
|
|
28
|
-
*/ export function
|
|
29
|
-
return async ({ collectionSlug, file, req, transform
|
|
22
|
+
* Creates the Sharp bridge's `transformUpload`. When core calls it, it plans the upload tasks (the
|
|
23
|
+
* main file, optionally cropped, and every configured image size), runs each one through the
|
|
24
|
+
* injected `transform` callback exactly once, and reads the size of each result. Reads the
|
|
25
|
+
* Sharp-owned config from `sharpTransformer({ collections })` at factory-construction time — not
|
|
26
|
+
* from the sanitized collection, which only gets the narrowed projection `init()` writes back.
|
|
27
|
+
*/ export function createTransformUpload({ collections, sharpDependency }) {
|
|
28
|
+
return async function transformUpload({ collectionSlug, cropSize, file, req, transform }) {
|
|
30
29
|
const collectionUpload = collections[collectionSlug] ?? {};
|
|
31
30
|
const fileSupportsResize = canResizeImage(file.type);
|
|
32
|
-
const cropData = uploadEdits && typeof uploadEdits === 'object' && 'crop' in uploadEdits ? uploadEdits.crop : undefined;
|
|
33
31
|
let originalDimensions;
|
|
34
32
|
if (fileSupportsResize) {
|
|
35
33
|
const originalMeta = await tryProbe(file, sharpDependency);
|
|
@@ -42,18 +40,14 @@ import { sanitizeResizeConfig } from './sanitizeResizeConfig.js';
|
|
|
42
40
|
}
|
|
43
41
|
// Unreadable dimensions can't be cropped/resized — treat as non-resizable rather than failing the upload.
|
|
44
42
|
const canProcessAsImage = fileSupportsResize && originalDimensions !== undefined;
|
|
45
|
-
|
|
46
|
-
cropData,
|
|
47
|
-
heightInPixels: uploadEdits.heightInPixels,
|
|
48
|
-
originalDimensions,
|
|
49
|
-
widthInPixels: uploadEdits.widthInPixels
|
|
50
|
-
} : undefined;
|
|
43
|
+
// `transformFile` reads the crop from `doc._transforms`. It needs the original's size for it.
|
|
51
44
|
const mainResultFile = await transform({
|
|
52
45
|
fieldPath: 'filename',
|
|
53
46
|
options: {
|
|
54
47
|
collectionUpload,
|
|
55
|
-
|
|
56
|
-
kind: 'main'
|
|
48
|
+
cropSize,
|
|
49
|
+
kind: 'main',
|
|
50
|
+
originalDimensions
|
|
57
51
|
}
|
|
58
52
|
});
|
|
59
53
|
const mainResult = await describeResult({
|
|
@@ -70,16 +64,13 @@ import { sanitizeResizeConfig } from './sanitizeResizeConfig.js';
|
|
|
70
64
|
const focalPointEnabled = effectiveFocalPoint !== false;
|
|
71
65
|
const variants = collectionUpload.variants;
|
|
72
66
|
if (canProcessAsImage && Array.isArray(variants) && originalDimensions) {
|
|
73
|
-
const focalPoint = focalPointEnabled && uploadEdits?.focalPoint ? {
|
|
74
|
-
x: isNumber(uploadEdits.focalPoint.x) ? Math.round(uploadEdits.focalPoint.x) : 50,
|
|
75
|
-
y: isNumber(uploadEdits.focalPoint.y) ? Math.round(uploadEdits.focalPoint.y) : 50
|
|
76
|
-
} : undefined;
|
|
77
67
|
const sizeResults = await mapWithBoundedConcurrency(variants, async (rawConfig)=>{
|
|
78
68
|
const imageResizeConfig = sanitizeResizeConfig(rawConfig);
|
|
79
69
|
const fieldPath = `variants.${imageResizeConfig.name}`;
|
|
80
70
|
const resizeAction = getImageResizeAction({
|
|
81
71
|
dimensions: originalDimensions,
|
|
82
|
-
|
|
72
|
+
// Whether a size may use a focal point. `transformFile` uses one only when it is saved.
|
|
73
|
+
hasFocalPoint: focalPointEnabled,
|
|
83
74
|
imageResizeConfig
|
|
84
75
|
});
|
|
85
76
|
if (resizeAction === 'omit') {
|
|
@@ -90,8 +81,8 @@ import { sanitizeResizeConfig } from './sanitizeResizeConfig.js';
|
|
|
90
81
|
const sizeResultFile = await transform({
|
|
91
82
|
fieldPath,
|
|
92
83
|
options: {
|
|
84
|
+
canUseFocalPoint: resizeAction === 'resizeWithFocalPoint',
|
|
93
85
|
collectionUpload,
|
|
94
|
-
focalPoint: resizeAction === 'resizeWithFocalPoint' ? focalPoint : undefined,
|
|
95
86
|
imageResizeConfig,
|
|
96
87
|
kind: 'size',
|
|
97
88
|
originalDimensions
|
|
@@ -136,4 +127,4 @@ async function describeResult({ fieldPath, fileSupportsResize, resultFile, sharp
|
|
|
136
127
|
};
|
|
137
128
|
}
|
|
138
129
|
|
|
139
|
-
//# sourceMappingURL=
|
|
130
|
+
//# sourceMappingURL=createTransformUpload.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/createTransformUpload.ts"],"sourcesContent":["import type { ProbedImageSize } from 'payload'\nimport type { UploadTransformation, UploadTransformerInternal } from 'payload/internal'\n\nimport type { SharpCollectionConfig, SharpDependency, SharpUploadTaskOptions } from './types.js'\n\nimport { canResizeImage } from './canResizeImage.js'\nimport { createSharpFromFile } from './createSharpFromFile.js'\nimport { getImageResizeAction } from './getImageResizeAction.js'\nimport { mapWithBoundedConcurrency } from './mapWithBoundedConcurrency.js'\nimport { sanitizeResizeConfig } from './sanitizeResizeConfig.js'\n\n/**\n * Sharp throws on truncated/header-only files. Returns `undefined` instead —\n * matching core's dependency-free probe — since unreadable dimensions shouldn't fail the upload.\n */\nasync function tryProbe(file: File, sharpDependency: SharpDependency) {\n try {\n const sharpFile = await createSharpFromFile({ file, sharpDependency })\n const metadata = await sharpFile.metadata()\n return metadata.width && metadata.height ? metadata : undefined\n } catch {\n return undefined\n }\n}\n\n/**\n * Creates the Sharp bridge's `transformUpload`. When core calls it, it plans the upload tasks (the\n * main file, optionally cropped, and every configured image size), runs each one through the\n * injected `transform` callback exactly once, and reads the size of each result. Reads the\n * Sharp-owned config from `sharpTransformer({ collections })` at factory-construction time — not\n * from the sanitized collection, which only gets the narrowed projection `init()` writes back.\n */\nexport function createTransformUpload({\n collections,\n sharpDependency,\n}: {\n collections: Partial<Record<string, SharpCollectionConfig>>\n sharpDependency: SharpDependency\n}): NonNullable<UploadTransformerInternal['transformUpload']> {\n return async function transformUpload({ collectionSlug, cropSize, file, req, transform }) {\n const collectionUpload = collections[collectionSlug] ?? {}\n\n const fileSupportsResize = canResizeImage(file.type)\n\n let originalDimensions: ProbedImageSize | undefined\n\n if (fileSupportsResize) {\n const originalMeta = await tryProbe(file, sharpDependency)\n if (originalMeta) {\n originalDimensions = { height: originalMeta.height, width: originalMeta.width }\n }\n }\n\n // Unreadable dimensions can't be cropped/resized — treat as non-resizable rather than failing the upload.\n const canProcessAsImage = fileSupportsResize && originalDimensions !== undefined\n\n // `transformFile` reads the crop from `doc._transforms`. It needs the original's size for it.\n const mainResultFile = await transform({\n fieldPath: 'filename',\n options: {\n collectionUpload,\n cropSize,\n kind: 'main',\n originalDimensions,\n } satisfies SharpUploadTaskOptions,\n })\n\n const mainResult = await describeResult({\n fieldPath: 'filename',\n fileSupportsResize: canProcessAsImage,\n resultFile: mainResultFile,\n sharpDependency,\n })\n\n const results: UploadTransformation[] = [mainResult]\n\n // Same precedence `init()` applies: Sharp's setting, else the collection's own `focalPoint`.\n const effectiveFocalPoint =\n collectionUpload.focalPoint ??\n req.payload.collections[collectionSlug]?.config.upload?.focalPoint\n const focalPointEnabled = effectiveFocalPoint !== false\n const variants = collectionUpload.variants\n\n if (canProcessAsImage && Array.isArray(variants) && originalDimensions) {\n const sizeResults = await mapWithBoundedConcurrency(variants, async (rawConfig) => {\n const imageResizeConfig = sanitizeResizeConfig(rawConfig)\n const fieldPath = `variants.${imageResizeConfig.name}` as const\n\n const resizeAction = getImageResizeAction({\n dimensions: originalDimensions,\n // Whether a size may use a focal point. `transformFile` uses one only when it is saved.\n hasFocalPoint: focalPointEnabled,\n imageResizeConfig,\n })\n\n if (resizeAction === 'omit') {\n return { fieldPath } satisfies UploadTransformation\n }\n\n const sizeResultFile = await transform({\n fieldPath,\n options: {\n canUseFocalPoint: resizeAction === 'resizeWithFocalPoint',\n collectionUpload,\n imageResizeConfig,\n kind: 'size',\n originalDimensions,\n } satisfies SharpUploadTaskOptions,\n })\n\n return describeResult({\n fieldPath,\n fileSupportsResize: true,\n resultFile: sizeResultFile,\n sharpDependency,\n })\n })\n\n results.push(...sizeResults)\n }\n\n return results\n }\n}\n\nasync function describeResult({\n fieldPath,\n fileSupportsResize,\n resultFile,\n sharpDependency,\n}: {\n fieldPath: UploadTransformation['fieldPath']\n fileSupportsResize: boolean\n resultFile: File\n sharpDependency: SharpDependency\n}): Promise<UploadTransformation> {\n if (!fileSupportsResize) {\n return { fieldPath, file: resultFile, mimeType: resultFile.type }\n }\n\n const meta = await tryProbe(resultFile, sharpDependency)\n\n if (!meta) {\n return { fieldPath, file: resultFile, mimeType: resultFile.type }\n }\n\n // `tryProbe` never sets `animated: true`, so `meta.height` is already the\n // single-frame height — do not divide by page count here.\n return {\n fieldPath,\n file: resultFile,\n height: meta.height,\n mimeType: resultFile.type,\n width: meta.width,\n }\n}\n"],"names":["canResizeImage","createSharpFromFile","getImageResizeAction","mapWithBoundedConcurrency","sanitizeResizeConfig","tryProbe","file","sharpDependency","sharpFile","metadata","width","height","undefined","createTransformUpload","collections","transformUpload","collectionSlug","cropSize","req","transform","collectionUpload","fileSupportsResize","type","originalDimensions","originalMeta","canProcessAsImage","mainResultFile","fieldPath","options","kind","mainResult","describeResult","resultFile","results","effectiveFocalPoint","focalPoint","payload","config","upload","focalPointEnabled","variants","Array","isArray","sizeResults","rawConfig","imageResizeConfig","name","resizeAction","dimensions","hasFocalPoint","sizeResultFile","canUseFocalPoint","push","mimeType","meta"],"mappings":"AAKA,SAASA,cAAc,QAAQ,sBAAqB;AACpD,SAASC,mBAAmB,QAAQ,2BAA0B;AAC9D,SAASC,oBAAoB,QAAQ,4BAA2B;AAChE,SAASC,yBAAyB,QAAQ,iCAAgC;AAC1E,SAASC,oBAAoB,QAAQ,4BAA2B;AAEhE;;;CAGC,GACD,eAAeC,SAASC,IAAU,EAAEC,eAAgC;IAClE,IAAI;QACF,MAAMC,YAAY,MAAMP,oBAAoB;YAAEK;YAAMC;QAAgB;QACpE,MAAME,WAAW,MAAMD,UAAUC,QAAQ;QACzC,OAAOA,SAASC,KAAK,IAAID,SAASE,MAAM,GAAGF,WAAWG;IACxD,EAAE,OAAM;QACN,OAAOA;IACT;AACF;AAEA;;;;;;CAMC,GACD,OAAO,SAASC,sBAAsB,EACpCC,WAAW,EACXP,eAAe,EAIhB;IACC,OAAO,eAAeQ,gBAAgB,EAAEC,cAAc,EAAEC,QAAQ,EAAEX,IAAI,EAAEY,GAAG,EAAEC,SAAS,EAAE;QACtF,MAAMC,mBAAmBN,WAAW,CAACE,eAAe,IAAI,CAAC;QAEzD,MAAMK,qBAAqBrB,eAAeM,KAAKgB,IAAI;QAEnD,IAAIC;QAEJ,IAAIF,oBAAoB;YACtB,MAAMG,eAAe,MAAMnB,SAASC,MAAMC;YAC1C,IAAIiB,cAAc;gBAChBD,qBAAqB;oBAAEZ,QAAQa,aAAab,MAAM;oBAAED,OAAOc,aAAad,KAAK;gBAAC;YAChF;QACF;QAEA,0GAA0G;QAC1G,MAAMe,oBAAoBJ,sBAAsBE,uBAAuBX;QAEvE,8FAA8F;QAC9F,MAAMc,iBAAiB,MAAMP,UAAU;YACrCQ,WAAW;YACXC,SAAS;gBACPR;gBACAH;gBACAY,MAAM;gBACNN;YACF;QACF;QAEA,MAAMO,aAAa,MAAMC,eAAe;YACtCJ,WAAW;YACXN,oBAAoBI;YACpBO,YAAYN;YACZnB;QACF;QAEA,MAAM0B,UAAkC;YAACH;SAAW;QAEpD,6FAA6F;QAC7F,MAAMI,sBACJd,iBAAiBe,UAAU,IAC3BjB,IAAIkB,OAAO,CAACtB,WAAW,CAACE,eAAe,EAAEqB,OAAOC,QAAQH;QAC1D,MAAMI,oBAAoBL,wBAAwB;QAClD,MAAMM,WAAWpB,iBAAiBoB,QAAQ;QAE1C,IAAIf,qBAAqBgB,MAAMC,OAAO,CAACF,aAAajB,oBAAoB;YACtE,MAAMoB,cAAc,MAAMxC,0BAA0BqC,UAAU,OAAOI;gBACnE,MAAMC,oBAAoBzC,qBAAqBwC;gBAC/C,MAAMjB,YAAY,CAAC,SAAS,EAAEkB,kBAAkBC,IAAI,EAAE;gBAEtD,MAAMC,eAAe7C,qBAAqB;oBACxC8C,YAAYzB;oBACZ,wFAAwF;oBACxF0B,eAAeV;oBACfM;gBACF;gBAEA,IAAIE,iBAAiB,QAAQ;oBAC3B,OAAO;wBAAEpB;oBAAU;gBACrB;gBAEA,MAAMuB,iBAAiB,MAAM/B,UAAU;oBACrCQ;oBACAC,SAAS;wBACPuB,kBAAkBJ,iBAAiB;wBACnC3B;wBACAyB;wBACAhB,MAAM;wBACNN;oBACF;gBACF;gBAEA,OAAOQ,eAAe;oBACpBJ;oBACAN,oBAAoB;oBACpBW,YAAYkB;oBACZ3C;gBACF;YACF;YAEA0B,QAAQmB,IAAI,IAAIT;QAClB;QAEA,OAAOV;IACT;AACF;AAEA,eAAeF,eAAe,EAC5BJ,SAAS,EACTN,kBAAkB,EAClBW,UAAU,EACVzB,eAAe,EAMhB;IACC,IAAI,CAACc,oBAAoB;QACvB,OAAO;YAAEM;YAAWrB,MAAM0B;YAAYqB,UAAUrB,WAAWV,IAAI;QAAC;IAClE;IAEA,MAAMgC,OAAO,MAAMjD,SAAS2B,YAAYzB;IAExC,IAAI,CAAC+C,MAAM;QACT,OAAO;YAAE3B;YAAWrB,MAAM0B;YAAYqB,UAAUrB,WAAWV,IAAI;QAAC;IAClE;IAEA,0EAA0E;IAC1E,0DAA0D;IAC1D,OAAO;QACLK;QACArB,MAAM0B;QACNrB,QAAQ2C,KAAK3C,MAAM;QACnB0C,UAAUrB,WAAWV,IAAI;QACzBZ,OAAO4C,KAAK5C,KAAK;IACnB;AACF"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { describe, expect, it, vi } from 'vitest';
|
|
2
|
-
import {
|
|
2
|
+
import { createTransformUpload } from './createTransformUpload.js';
|
|
3
3
|
const sharpDependency = ()=>({
|
|
4
4
|
metadata: async ()=>({
|
|
5
5
|
height: 1000,
|
|
@@ -19,13 +19,13 @@ const makeReq = ({ focalPoint })=>({
|
|
|
19
19
|
}
|
|
20
20
|
}
|
|
21
21
|
});
|
|
22
|
-
const
|
|
22
|
+
const runTransformUpload = async ({ collectionFocalPoint, sharpConfig })=>{
|
|
23
23
|
const transform = vi.fn(async (_task)=>new File([
|
|
24
24
|
'x'
|
|
25
25
|
], 'image.png', {
|
|
26
26
|
type: 'image/png'
|
|
27
27
|
}));
|
|
28
|
-
await
|
|
28
|
+
await createTransformUpload({
|
|
29
29
|
collections: {
|
|
30
30
|
media: sharpConfig
|
|
31
31
|
},
|
|
@@ -40,16 +40,10 @@ const runPrepareUpload = async ({ collectionFocalPoint, sharpConfig })=>{
|
|
|
40
40
|
req: makeReq({
|
|
41
41
|
focalPoint: collectionFocalPoint
|
|
42
42
|
}),
|
|
43
|
-
transform
|
|
44
|
-
uploadEdits: {
|
|
45
|
-
focalPoint: {
|
|
46
|
-
x: 10,
|
|
47
|
-
y: 90
|
|
48
|
-
}
|
|
49
|
-
}
|
|
43
|
+
transform
|
|
50
44
|
});
|
|
51
45
|
const sizeTask = transform.mock.calls.map(([task])=>task.options).find((options)=>options.kind === 'size');
|
|
52
|
-
return sizeTask?.kind === 'size' ? sizeTask.
|
|
46
|
+
return sizeTask?.kind === 'size' ? sizeTask.canUseFocalPoint : undefined;
|
|
53
47
|
};
|
|
54
48
|
const variants = [
|
|
55
49
|
{
|
|
@@ -58,31 +52,25 @@ const variants = [
|
|
|
58
52
|
width: 400
|
|
59
53
|
}
|
|
60
54
|
];
|
|
61
|
-
describe('
|
|
55
|
+
describe('createTransformUpload', ()=>{
|
|
62
56
|
it.each([
|
|
63
57
|
{
|
|
64
58
|
collectionFocalPoint: false,
|
|
65
|
-
expected:
|
|
59
|
+
expected: false,
|
|
66
60
|
sharpFocalPoint: undefined
|
|
67
61
|
},
|
|
68
62
|
{
|
|
69
63
|
collectionFocalPoint: false,
|
|
70
|
-
expected:
|
|
71
|
-
x: 10,
|
|
72
|
-
y: 90
|
|
73
|
-
},
|
|
64
|
+
expected: true,
|
|
74
65
|
sharpFocalPoint: true
|
|
75
66
|
},
|
|
76
67
|
{
|
|
77
68
|
collectionFocalPoint: undefined,
|
|
78
|
-
expected:
|
|
79
|
-
x: 10,
|
|
80
|
-
y: 90
|
|
81
|
-
},
|
|
69
|
+
expected: true,
|
|
82
70
|
sharpFocalPoint: undefined
|
|
83
71
|
}
|
|
84
|
-
])('should
|
|
85
|
-
expect(await
|
|
72
|
+
])('should let sizes use a saved focal point when Sharp ($sharpFocalPoint) or else the collection ($collectionFocalPoint) enables it', async ({ collectionFocalPoint, expected, sharpFocalPoint })=>{
|
|
73
|
+
expect(await runTransformUpload({
|
|
86
74
|
collectionFocalPoint,
|
|
87
75
|
sharpConfig: {
|
|
88
76
|
focalPoint: sharpFocalPoint,
|
|
@@ -92,4 +80,4 @@ describe('createPrepareLegacyUpload', ()=>{
|
|
|
92
80
|
});
|
|
93
81
|
});
|
|
94
82
|
|
|
95
|
-
//# sourceMappingURL=
|
|
83
|
+
//# sourceMappingURL=createTransformUpload.spec.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/createTransformUpload.spec.ts"],"sourcesContent":["import type { PayloadRequest } from 'payload'\nimport type { UploadTransformTask } from 'payload/internal'\n\nimport { describe, expect, it, vi } from 'vitest'\n\nimport type { SharpCollectionConfig, SharpDependency, SharpUploadTaskOptions } from './types.js'\n\nimport { createTransformUpload } from './createTransformUpload.js'\n\nconst sharpDependency = (() => ({\n metadata: async () => ({ height: 1000, width: 1000 }),\n})) as unknown as SharpDependency\n\nconst makeReq = ({ focalPoint }: { focalPoint?: boolean }): PayloadRequest =>\n ({\n payload: { collections: { media: { config: { upload: { focalPoint } } } } },\n }) as unknown as PayloadRequest\n\nconst runTransformUpload = async ({\n collectionFocalPoint,\n sharpConfig,\n}: {\n collectionFocalPoint?: boolean\n sharpConfig: SharpCollectionConfig\n}) => {\n const transform = vi.fn(\n async (_task: UploadTransformTask) => new File(['x'], 'image.png', { type: 'image/png' }),\n )\n\n await createTransformUpload({ collections: { media: sharpConfig }, sharpDependency })({\n collectionSlug: 'media',\n file: new File(['x'], 'image.png', { type: 'image/png' }),\n req: makeReq({ focalPoint: collectionFocalPoint }),\n transform,\n })\n\n const sizeTask = transform.mock.calls\n .map(([task]) => task.options as SharpUploadTaskOptions)\n .find((options) => options.kind === 'size')\n\n return sizeTask?.kind === 'size' ? sizeTask.canUseFocalPoint : undefined\n}\n\nconst variants = [{ name: 'card', height: 200, width: 400 }]\n\ndescribe('createTransformUpload', () => {\n it.each([\n { collectionFocalPoint: false, expected: false, sharpFocalPoint: undefined },\n { collectionFocalPoint: false, expected: true, sharpFocalPoint: true },\n { collectionFocalPoint: undefined, expected: true, sharpFocalPoint: undefined },\n ])(\n 'should let sizes use a saved focal point when Sharp ($sharpFocalPoint) or else the collection ($collectionFocalPoint) enables it',\n async ({ collectionFocalPoint, expected, sharpFocalPoint }) => {\n expect(\n await runTransformUpload({\n collectionFocalPoint,\n sharpConfig: { focalPoint: sharpFocalPoint, variants },\n }),\n ).toEqual(expected)\n },\n )\n})\n"],"names":["describe","expect","it","vi","createTransformUpload","sharpDependency","metadata","height","width","makeReq","focalPoint","payload","collections","media","config","upload","runTransformUpload","collectionFocalPoint","sharpConfig","transform","fn","_task","File","type","collectionSlug","file","req","sizeTask","mock","calls","map","task","options","find","kind","canUseFocalPoint","undefined","variants","name","each","expected","sharpFocalPoint","toEqual"],"mappings":"AAGA,SAASA,QAAQ,EAAEC,MAAM,EAAEC,EAAE,EAAEC,EAAE,QAAQ,SAAQ;AAIjD,SAASC,qBAAqB,QAAQ,6BAA4B;AAElE,MAAMC,kBAAmB,IAAO,CAAA;QAC9BC,UAAU,UAAa,CAAA;gBAAEC,QAAQ;gBAAMC,OAAO;YAAK,CAAA;IACrD,CAAA;AAEA,MAAMC,UAAU,CAAC,EAAEC,UAAU,EAA4B,GACtD,CAAA;QACCC,SAAS;YAAEC,aAAa;gBAAEC,OAAO;oBAAEC,QAAQ;wBAAEC,QAAQ;4BAAEL;wBAAW;oBAAE;gBAAE;YAAE;QAAE;IAC5E,CAAA;AAEF,MAAMM,qBAAqB,OAAO,EAChCC,oBAAoB,EACpBC,WAAW,EAIZ;IACC,MAAMC,YAAYhB,GAAGiB,EAAE,CACrB,OAAOC,QAA+B,IAAIC,KAAK;YAAC;SAAI,EAAE,aAAa;YAAEC,MAAM;QAAY;IAGzF,MAAMnB,sBAAsB;QAAEQ,aAAa;YAAEC,OAAOK;QAAY;QAAGb;IAAgB,GAAG;QACpFmB,gBAAgB;QAChBC,MAAM,IAAIH,KAAK;YAAC;SAAI,EAAE,aAAa;YAAEC,MAAM;QAAY;QACvDG,KAAKjB,QAAQ;YAAEC,YAAYO;QAAqB;QAChDE;IACF;IAEA,MAAMQ,WAAWR,UAAUS,IAAI,CAACC,KAAK,CAClCC,GAAG,CAAC,CAAC,CAACC,KAAK,GAAKA,KAAKC,OAAO,EAC5BC,IAAI,CAAC,CAACD,UAAYA,QAAQE,IAAI,KAAK;IAEtC,OAAOP,UAAUO,SAAS,SAASP,SAASQ,gBAAgB,GAAGC;AACjE;AAEA,MAAMC,WAAW;IAAC;QAAEC,MAAM;QAAQ/B,QAAQ;QAAKC,OAAO;IAAI;CAAE;AAE5DR,SAAS,yBAAyB;IAChCE,GAAGqC,IAAI,CAAC;QACN;YAAEtB,sBAAsB;YAAOuB,UAAU;YAAOC,iBAAiBL;QAAU;QAC3E;YAAEnB,sBAAsB;YAAOuB,UAAU;YAAMC,iBAAiB;QAAK;QACrE;YAAExB,sBAAsBmB;YAAWI,UAAU;YAAMC,iBAAiBL;QAAU;KAC/E,EACC,oIACA,OAAO,EAAEnB,oBAAoB,EAAEuB,QAAQ,EAAEC,eAAe,EAAE;QACxDxC,OACE,MAAMe,mBAAmB;YACvBC;YACAC,aAAa;gBAAER,YAAY+B;gBAAiBJ;YAAS;QACvD,IACAK,OAAO,CAACF;IACZ;AAEJ"}
|
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
import type { Config } from 'payload';
|
|
2
2
|
import type { SharpCollectionConfig } from './types.js';
|
|
3
3
|
/**
|
|
4
|
-
*
|
|
5
|
-
*
|
|
6
|
-
* `
|
|
7
|
-
*
|
|
8
|
-
* generation and Admin UI keep working without knowing about Sharp.
|
|
4
|
+
* Registers the `variants` of `sharpTransformer({ collections })` with `registerUploadVariants`,
|
|
5
|
+
* which checks each collection and size name. Then writes `crop`/`focalPoint`/
|
|
6
|
+
* `hasImageAdjustments` onto each targeted collection's sanitized `upload` config, so core's own
|
|
7
|
+
* field generation and Admin UI keep working without knowing about Sharp.
|
|
9
8
|
*/
|
|
10
|
-
export declare function initSharpCollections({ collections, config, }: {
|
|
9
|
+
export declare function initSharpCollections({ collections, config, transformerSlug, }: {
|
|
11
10
|
collections: Partial<Record<string, SharpCollectionConfig>>;
|
|
12
11
|
config: Config;
|
|
12
|
+
transformerSlug: string;
|
|
13
13
|
}): Config;
|
|
14
14
|
//# sourceMappingURL=initSharpCollections.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"initSharpCollections.d.ts","sourceRoot":"","sources":["../src/initSharpCollections.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAyB,MAAM,SAAS,CAAA;
|
|
1
|
+
{"version":3,"file":"initSharpCollections.d.ts","sourceRoot":"","sources":["../src/initSharpCollections.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAyB,MAAM,SAAS,CAAA;AAI5D,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAA;AAEvD;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,EACnC,WAAW,EACX,MAAM,EACN,eAAe,GAChB,EAAE;IACD,WAAW,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC,CAAA;IAC3D,MAAM,EAAE,MAAM,CAAA;IACd,eAAe,EAAE,MAAM,CAAA;CACxB,GAAG,MAAM,CAqCT"}
|
|
@@ -1,57 +1,18 @@
|
|
|
1
|
-
|
|
2
|
-
'filename',
|
|
3
|
-
'mimeType',
|
|
4
|
-
'filesize',
|
|
5
|
-
'width',
|
|
6
|
-
'height',
|
|
7
|
-
'url',
|
|
8
|
-
'thumbnailURL',
|
|
9
|
-
'variants',
|
|
10
|
-
'focalX',
|
|
11
|
-
'focalY'
|
|
12
|
-
];
|
|
1
|
+
import { registerUploadVariants } from 'payload';
|
|
13
2
|
/**
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
* `
|
|
17
|
-
*
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
}
|
|
25
|
-
const collection = config.collections?.find((candidate)=>candidate.slug === slug);
|
|
26
|
-
if (!collection) {
|
|
27
|
-
errors.push(`sharpTransformer collections."${slug}" does not match any configured collection slug.`);
|
|
28
|
-
continue;
|
|
29
|
-
}
|
|
30
|
-
if (!collection.upload) {
|
|
31
|
-
errors.push(`sharpTransformer collections."${slug}" targets a collection whose \`upload\` option is not set. Enable uploads on "${slug}" first.`);
|
|
32
|
-
continue;
|
|
33
|
-
}
|
|
34
|
-
const seenSizeNames = new Set();
|
|
35
|
-
for (const size of sharpConfig.variants ?? []){
|
|
36
|
-
if (typeof size.name !== 'string' || size.name.trim().length === 0) {
|
|
37
|
-
errors.push(`sharpTransformer collections."${slug}".variants has an entry missing a valid \`name\`.`);
|
|
38
|
-
continue;
|
|
39
|
-
}
|
|
40
|
-
if (seenSizeNames.has(size.name)) {
|
|
41
|
-
errors.push(`sharpTransformer collections."${slug}".variants has a duplicate size name: "${size.name}".`);
|
|
42
|
-
}
|
|
43
|
-
seenSizeNames.add(size.name);
|
|
44
|
-
if (RESERVED_IMAGE_SIZE_NAMES.includes(size.name)) {
|
|
45
|
-
errors.push(`sharpTransformer collections."${slug}".variants uses reserved name "${size.name}", which collides with a built-in upload field. Choose a different name.`);
|
|
46
|
-
}
|
|
47
|
-
}
|
|
48
|
-
}
|
|
49
|
-
if (errors.length > 0) {
|
|
50
|
-
throw new Error(`Invalid \`sharpTransformer({ collections })\` configuration:\n${errors.join('\n')}`);
|
|
51
|
-
}
|
|
3
|
+
* Registers the `variants` of `sharpTransformer({ collections })` with `registerUploadVariants`,
|
|
4
|
+
* which checks each collection and size name. Then writes `crop`/`focalPoint`/
|
|
5
|
+
* `hasImageAdjustments` onto each targeted collection's sanitized `upload` config, so core's own
|
|
6
|
+
* field generation and Admin UI keep working without knowing about Sharp.
|
|
7
|
+
*/ export function initSharpCollections({ collections, config, transformerSlug }) {
|
|
8
|
+
const registeredConfig = registerUploadVariants({
|
|
9
|
+
collections,
|
|
10
|
+
config,
|
|
11
|
+
transformerSlug
|
|
12
|
+
});
|
|
52
13
|
// Write onto copies, never the caller's config or collection objects: a rebuilt config (e.g. on
|
|
53
14
|
// a dev reload) would otherwise see `upload.variants` on the collection and reject it as authored.
|
|
54
|
-
const sanitizedCollections =
|
|
15
|
+
const sanitizedCollections = registeredConfig.collections?.map((collection)=>{
|
|
55
16
|
const sharpConfig = collections[collection.slug];
|
|
56
17
|
if (!sharpConfig || !collection.upload) {
|
|
57
18
|
return collection;
|
|
@@ -63,12 +24,7 @@ const RESERVED_IMAGE_SIZE_NAMES = [
|
|
|
63
24
|
// unset Sharp option can't silently re-enable a collection's `crop: false`.
|
|
64
25
|
crop: sharpConfig.crop ?? authoredUpload.crop,
|
|
65
26
|
focalPoint: sharpConfig.focalPoint ?? authoredUpload.focalPoint,
|
|
66
|
-
hasImageAdjustments: Boolean(sharpConfig.resizeOptions || sharpConfig.formatOptions || sharpConfig.trimOptions || sharpConfig.constructorOptions || sharpConfig.withMetadata)
|
|
67
|
-
variants: sharpConfig.variants?.map(({ name, admin, generateImageName })=>({
|
|
68
|
-
name,
|
|
69
|
-
admin,
|
|
70
|
-
generateImageName
|
|
71
|
-
}))
|
|
27
|
+
hasImageAdjustments: Boolean(sharpConfig.resizeOptions || sharpConfig.formatOptions || sharpConfig.trimOptions || sharpConfig.constructorOptions || sharpConfig.withMetadata)
|
|
72
28
|
};
|
|
73
29
|
return {
|
|
74
30
|
...collection,
|
|
@@ -76,7 +32,7 @@ const RESERVED_IMAGE_SIZE_NAMES = [
|
|
|
76
32
|
};
|
|
77
33
|
});
|
|
78
34
|
return {
|
|
79
|
-
...
|
|
35
|
+
...registeredConfig,
|
|
80
36
|
collections: sanitizedCollections
|
|
81
37
|
};
|
|
82
38
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/initSharpCollections.ts"],"sourcesContent":["import type { Config, SanitizedUploadConfig } from 'payload'\n\nimport
|
|
1
|
+
{"version":3,"sources":["../src/initSharpCollections.ts"],"sourcesContent":["import type { Config, SanitizedUploadConfig } from 'payload'\n\nimport { registerUploadVariants } from 'payload'\n\nimport type { SharpCollectionConfig } from './types.js'\n\n/**\n * Registers the `variants` of `sharpTransformer({ collections })` with `registerUploadVariants`,\n * which checks each collection and size name. Then writes `crop`/`focalPoint`/\n * `hasImageAdjustments` onto each targeted collection's sanitized `upload` config, so core's own\n * field generation and Admin UI keep working without knowing about Sharp.\n */\nexport function initSharpCollections({\n collections,\n config,\n transformerSlug,\n}: {\n collections: Partial<Record<string, SharpCollectionConfig>>\n config: Config\n transformerSlug: string\n}): Config {\n const registeredConfig = registerUploadVariants({\n collections,\n config,\n transformerSlug,\n })\n\n // Write onto copies, never the caller's config or collection objects: a rebuilt config (e.g. on\n // a dev reload) would otherwise see `upload.variants` on the collection and reject it as authored.\n const sanitizedCollections = registeredConfig.collections?.map((collection) => {\n const sharpConfig = collections[collection.slug]\n\n if (!sharpConfig || !collection.upload) {\n return collection\n }\n\n const authoredUpload = typeof collection.upload === 'object' ? collection.upload : {}\n\n const upload: Partial<SanitizedUploadConfig> = {\n ...authoredUpload,\n // Sharp's setting wins when given; otherwise keep the collection's own, so an\n // unset Sharp option can't silently re-enable a collection's `crop: false`.\n crop: sharpConfig.crop ?? authoredUpload.crop,\n focalPoint: sharpConfig.focalPoint ?? authoredUpload.focalPoint,\n hasImageAdjustments: Boolean(\n sharpConfig.resizeOptions ||\n sharpConfig.formatOptions ||\n sharpConfig.trimOptions ||\n sharpConfig.constructorOptions ||\n sharpConfig.withMetadata,\n ),\n }\n\n return { ...collection, upload }\n })\n\n return { ...registeredConfig, collections: sanitizedCollections }\n}\n"],"names":["registerUploadVariants","initSharpCollections","collections","config","transformerSlug","registeredConfig","sanitizedCollections","map","collection","sharpConfig","slug","upload","authoredUpload","crop","focalPoint","hasImageAdjustments","Boolean","resizeOptions","formatOptions","trimOptions","constructorOptions","withMetadata"],"mappings":"AAEA,SAASA,sBAAsB,QAAQ,UAAS;AAIhD;;;;;CAKC,GACD,OAAO,SAASC,qBAAqB,EACnCC,WAAW,EACXC,MAAM,EACNC,eAAe,EAKhB;IACC,MAAMC,mBAAmBL,uBAAuB;QAC9CE;QACAC;QACAC;IACF;IAEA,gGAAgG;IAChG,mGAAmG;IACnG,MAAME,uBAAuBD,iBAAiBH,WAAW,EAAEK,IAAI,CAACC;QAC9D,MAAMC,cAAcP,WAAW,CAACM,WAAWE,IAAI,CAAC;QAEhD,IAAI,CAACD,eAAe,CAACD,WAAWG,MAAM,EAAE;YACtC,OAAOH;QACT;QAEA,MAAMI,iBAAiB,OAAOJ,WAAWG,MAAM,KAAK,WAAWH,WAAWG,MAAM,GAAG,CAAC;QAEpF,MAAMA,SAAyC;YAC7C,GAAGC,cAAc;YACjB,8EAA8E;YAC9E,4EAA4E;YAC5EC,MAAMJ,YAAYI,IAAI,IAAID,eAAeC,IAAI;YAC7CC,YAAYL,YAAYK,UAAU,IAAIF,eAAeE,UAAU;YAC/DC,qBAAqBC,QACnBP,YAAYQ,aAAa,IACzBR,YAAYS,aAAa,IACzBT,YAAYU,WAAW,IACvBV,YAAYW,kBAAkB,IAC9BX,YAAYY,YAAY;QAE5B;QAEA,OAAO;YAAE,GAAGb,UAAU;YAAEG;QAAO;IACjC;IAEA,OAAO;QAAE,GAAGN,gBAAgB;QAAEH,aAAaI;IAAqB;AAClE"}
|
|
@@ -1,7 +1,14 @@
|
|
|
1
1
|
import { describe, expect, it } from 'vitest';
|
|
2
2
|
import { initSharpCollections } from './initSharpCollections.js';
|
|
3
3
|
const makeConfig = (collections)=>({
|
|
4
|
-
collections
|
|
4
|
+
collections,
|
|
5
|
+
upload: {
|
|
6
|
+
transformers: [
|
|
7
|
+
{
|
|
8
|
+
slug: 'sharp'
|
|
9
|
+
}
|
|
10
|
+
]
|
|
11
|
+
}
|
|
5
12
|
});
|
|
6
13
|
const uploadCollection = ({ slug, upload = {} })=>({
|
|
7
14
|
slug,
|
|
@@ -12,7 +19,8 @@ describe('initSharpCollections', ()=>{
|
|
|
12
19
|
const config = makeConfig(undefined);
|
|
13
20
|
expect(()=>initSharpCollections({
|
|
14
21
|
collections: {},
|
|
15
|
-
config
|
|
22
|
+
config,
|
|
23
|
+
transformerSlug: 'sharp'
|
|
16
24
|
})).not.toThrow();
|
|
17
25
|
});
|
|
18
26
|
it.each([
|
|
@@ -47,7 +55,8 @@ describe('initSharpCollections', ()=>{
|
|
|
47
55
|
collections: {
|
|
48
56
|
media: sharpConfig
|
|
49
57
|
},
|
|
50
|
-
config
|
|
58
|
+
config,
|
|
59
|
+
transformerSlug: 'sharp'
|
|
51
60
|
});
|
|
52
61
|
expect(result.collections?.[0]?.upload).toMatchObject(expected);
|
|
53
62
|
});
|
|
@@ -73,7 +82,8 @@ describe('initSharpCollections', ()=>{
|
|
|
73
82
|
]
|
|
74
83
|
}
|
|
75
84
|
},
|
|
76
|
-
config
|
|
85
|
+
config,
|
|
86
|
+
transformerSlug: 'sharp'
|
|
77
87
|
});
|
|
78
88
|
expect(result.collections?.[0]?.upload).toMatchObject({
|
|
79
89
|
variants: [
|
|
@@ -112,7 +122,8 @@ describe('initSharpCollections', ()=>{
|
|
|
112
122
|
collections: {
|
|
113
123
|
[slug]: {}
|
|
114
124
|
},
|
|
115
|
-
config
|
|
125
|
+
config,
|
|
126
|
+
transformerSlug: 'sharp'
|
|
116
127
|
})).toThrow(new RegExp(`"${slug}"`));
|
|
117
128
|
});
|
|
118
129
|
it.each([
|
|
@@ -158,7 +169,8 @@ describe('initSharpCollections', ()=>{
|
|
|
158
169
|
variants: variants
|
|
159
170
|
}
|
|
160
171
|
},
|
|
161
|
-
config
|
|
172
|
+
config,
|
|
173
|
+
transformerSlug: 'sharp'
|
|
162
174
|
})).toThrow(error);
|
|
163
175
|
});
|
|
164
176
|
it('should allow a variants entry with neither width nor height (format-only/pass-through size)', ()=>{
|
|
@@ -177,7 +189,8 @@ describe('initSharpCollections', ()=>{
|
|
|
177
189
|
]
|
|
178
190
|
}
|
|
179
191
|
},
|
|
180
|
-
config
|
|
192
|
+
config,
|
|
193
|
+
transformerSlug: 'sharp'
|
|
181
194
|
})).not.toThrow();
|
|
182
195
|
});
|
|
183
196
|
});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/initSharpCollections.spec.ts"],"sourcesContent":["import type { Config } from 'payload'\n\nimport { describe, expect, it } from 'vitest'\n\nimport type { SharpCollectionConfig } from './types.js'\n\nimport { initSharpCollections } from './initSharpCollections.js'\n\nconst makeConfig = (collections: Config['collections']): Config =>\n ({\n collections,\n }) as unknown as Config\n\nconst uploadCollection = ({\n slug,\n upload = {},\n}: {\n slug: string\n upload?: boolean | Record<string, unknown>\n}) => ({ slug, upload }) as unknown as NonNullable<Config['collections']>[number]\n\ndescribe('initSharpCollections', () => {\n it('should not throw when the config has no collections', () => {\n const config = makeConfig(undefined)\n\n expect(()
|
|
1
|
+
{"version":3,"sources":["../src/initSharpCollections.spec.ts"],"sourcesContent":["import type { Config } from 'payload'\n\nimport { describe, expect, it } from 'vitest'\n\nimport type { SharpCollectionConfig } from './types.js'\n\nimport { initSharpCollections } from './initSharpCollections.js'\n\nconst makeConfig = (collections: Config['collections']): Config =>\n ({\n collections,\n upload: { transformers: [{ slug: 'sharp' }] },\n }) as unknown as Config\n\nconst uploadCollection = ({\n slug,\n upload = {},\n}: {\n slug: string\n upload?: boolean | Record<string, unknown>\n}) => ({ slug, upload }) as unknown as NonNullable<Config['collections']>[number]\n\ndescribe('initSharpCollections', () => {\n it('should not throw when the config has no collections', () => {\n const config = makeConfig(undefined)\n\n expect(() =>\n initSharpCollections({ collections: {}, config, transformerSlug: 'sharp' }),\n ).not.toThrow()\n })\n\n it.each([\n { expected: { crop: false, focalPoint: false }, sharpConfig: {} },\n { expected: { crop: true, focalPoint: true }, sharpConfig: { crop: true, focalPoint: true } },\n ])(\n \"should let Sharp's crop and focalPoint override the collection's only when set (%#)\",\n ({ expected, sharpConfig }) => {\n const config = makeConfig([\n uploadCollection({ slug: 'media', upload: { crop: false, focalPoint: false } }),\n ])\n\n const result = initSharpCollections({\n collections: { media: sharpConfig },\n config,\n transformerSlug: 'sharp',\n })\n\n expect(result.collections?.[0]?.upload).toMatchObject(expected)\n },\n )\n\n it('should write variants onto a copy, leaving the caller config untouched', () => {\n const authoredCollection = uploadCollection({ slug: 'media', upload: { staticDir: 'media' } })\n const authoredCollections = [authoredCollection]\n const config = makeConfig(authoredCollections)\n\n const result = initSharpCollections({\n collections: { media: { variants: [{ name: 'thumbnail', width: 100 }] } },\n config,\n transformerSlug: 'sharp',\n })\n\n expect(result.collections?.[0]?.upload).toMatchObject({\n variants: [{ name: 'thumbnail' }],\n staticDir: 'media',\n })\n expect(result).not.toBe(config)\n expect(result.collections?.[0]).not.toBe(authoredCollection)\n expect(config.collections).toBe(authoredCollections)\n expect(authoredCollection.upload).toEqual({ staticDir: 'media' })\n })\n\n it.each([\n { collection: uploadCollection({ slug: 'media' }), slug: 'missing' },\n { collection: uploadCollection({ slug: 'posts', upload: false }), slug: 'posts' },\n ])(\n 'should throw when the configured collection \"$slug\" is missing or not upload-enabled',\n ({ collection, slug }) => {\n const config = makeConfig([collection])\n\n expect(() =>\n initSharpCollections({ collections: { [slug]: {} }, config, transformerSlug: 'sharp' }),\n ).toThrow(new RegExp(`\"${slug}\"`))\n },\n )\n\n it.each([\n {\n error: /duplicate/i,\n variants: [\n { name: 'square', width: 100 },\n { name: 'square', width: 200 },\n ],\n },\n { error: /reserved/i, variants: [{ name: 'filename', width: 100 }] },\n { error: /name/i, variants: [{ width: 100 }] },\n ])('should reject invalid variants ($error)', ({ error, variants }) => {\n const config = makeConfig([uploadCollection({ slug: 'media' })])\n\n expect(() =>\n initSharpCollections({\n collections: { media: { variants: variants as SharpCollectionConfig['variants'] } },\n config,\n transformerSlug: 'sharp',\n }),\n ).toThrow(error)\n })\n\n it('should allow a variants entry with neither width nor height (format-only/pass-through size)', () => {\n const config = makeConfig([uploadCollection({ slug: 'media' })])\n\n expect(() =>\n initSharpCollections({\n collections: { media: { variants: [{ name: 'noDimensions' }] } },\n config,\n transformerSlug: 'sharp',\n }),\n ).not.toThrow()\n })\n})\n"],"names":["describe","expect","it","initSharpCollections","makeConfig","collections","upload","transformers","slug","uploadCollection","config","undefined","transformerSlug","not","toThrow","each","expected","crop","focalPoint","sharpConfig","result","media","toMatchObject","authoredCollection","staticDir","authoredCollections","variants","name","width","toBe","toEqual","collection","RegExp","error"],"mappings":"AAEA,SAASA,QAAQ,EAAEC,MAAM,EAAEC,EAAE,QAAQ,SAAQ;AAI7C,SAASC,oBAAoB,QAAQ,4BAA2B;AAEhE,MAAMC,aAAa,CAACC,cACjB,CAAA;QACCA;QACAC,QAAQ;YAAEC,cAAc;gBAAC;oBAAEC,MAAM;gBAAQ;aAAE;QAAC;IAC9C,CAAA;AAEF,MAAMC,mBAAmB,CAAC,EACxBD,IAAI,EACJF,SAAS,CAAC,CAAC,EAIZ,GAAM,CAAA;QAAEE;QAAMF;IAAO,CAAA;AAEtBN,SAAS,wBAAwB;IAC/BE,GAAG,uDAAuD;QACxD,MAAMQ,SAASN,WAAWO;QAE1BV,OAAO,IACLE,qBAAqB;gBAAEE,aAAa,CAAC;gBAAGK;gBAAQE,iBAAiB;YAAQ,IACzEC,GAAG,CAACC,OAAO;IACf;IAEAZ,GAAGa,IAAI,CAAC;QACN;YAAEC,UAAU;gBAAEC,MAAM;gBAAOC,YAAY;YAAM;YAAGC,aAAa,CAAC;QAAE;QAChE;YAAEH,UAAU;gBAAEC,MAAM;gBAAMC,YAAY;YAAK;YAAGC,aAAa;gBAAEF,MAAM;gBAAMC,YAAY;YAAK;QAAE;KAC7F,EACC,uFACA,CAAC,EAAEF,QAAQ,EAAEG,WAAW,EAAE;QACxB,MAAMT,SAASN,WAAW;YACxBK,iBAAiB;gBAAED,MAAM;gBAASF,QAAQ;oBAAEW,MAAM;oBAAOC,YAAY;gBAAM;YAAE;SAC9E;QAED,MAAME,SAASjB,qBAAqB;YAClCE,aAAa;gBAAEgB,OAAOF;YAAY;YAClCT;YACAE,iBAAiB;QACnB;QAEAX,OAAOmB,OAAOf,WAAW,EAAE,CAAC,EAAE,EAAEC,QAAQgB,aAAa,CAACN;IACxD;IAGFd,GAAG,0EAA0E;QAC3E,MAAMqB,qBAAqBd,iBAAiB;YAAED,MAAM;YAASF,QAAQ;gBAAEkB,WAAW;YAAQ;QAAE;QAC5F,MAAMC,sBAAsB;YAACF;SAAmB;QAChD,MAAMb,SAASN,WAAWqB;QAE1B,MAAML,SAASjB,qBAAqB;YAClCE,aAAa;gBAAEgB,OAAO;oBAAEK,UAAU;wBAAC;4BAAEC,MAAM;4BAAaC,OAAO;wBAAI;qBAAE;gBAAC;YAAE;YACxElB;YACAE,iBAAiB;QACnB;QAEAX,OAAOmB,OAAOf,WAAW,EAAE,CAAC,EAAE,EAAEC,QAAQgB,aAAa,CAAC;YACpDI,UAAU;gBAAC;oBAAEC,MAAM;gBAAY;aAAE;YACjCH,WAAW;QACb;QACAvB,OAAOmB,QAAQP,GAAG,CAACgB,IAAI,CAACnB;QACxBT,OAAOmB,OAAOf,WAAW,EAAE,CAAC,EAAE,EAAEQ,GAAG,CAACgB,IAAI,CAACN;QACzCtB,OAAOS,OAAOL,WAAW,EAAEwB,IAAI,CAACJ;QAChCxB,OAAOsB,mBAAmBjB,MAAM,EAAEwB,OAAO,CAAC;YAAEN,WAAW;QAAQ;IACjE;IAEAtB,GAAGa,IAAI,CAAC;QACN;YAAEgB,YAAYtB,iBAAiB;gBAAED,MAAM;YAAQ;YAAIA,MAAM;QAAU;QACnE;YAAEuB,YAAYtB,iBAAiB;gBAAED,MAAM;gBAASF,QAAQ;YAAM;YAAIE,MAAM;QAAQ;KACjF,EACC,wFACA,CAAC,EAAEuB,UAAU,EAAEvB,IAAI,EAAE;QACnB,MAAME,SAASN,WAAW;YAAC2B;SAAW;QAEtC9B,OAAO,IACLE,qBAAqB;gBAAEE,aAAa;oBAAE,CAACG,KAAK,EAAE,CAAC;gBAAE;gBAAGE;gBAAQE,iBAAiB;YAAQ,IACrFE,OAAO,CAAC,IAAIkB,OAAO,CAAC,CAAC,EAAExB,KAAK,CAAC,CAAC;IAClC;IAGFN,GAAGa,IAAI,CAAC;QACN;YACEkB,OAAO;YACPP,UAAU;gBACR;oBAAEC,MAAM;oBAAUC,OAAO;gBAAI;gBAC7B;oBAAED,MAAM;oBAAUC,OAAO;gBAAI;aAC9B;QACH;QACA;YAAEK,OAAO;YAAaP,UAAU;gBAAC;oBAAEC,MAAM;oBAAYC,OAAO;gBAAI;aAAE;QAAC;QACnE;YAAEK,OAAO;YAASP,UAAU;gBAAC;oBAAEE,OAAO;gBAAI;aAAE;QAAC;KAC9C,EAAE,2CAA2C,CAAC,EAAEK,KAAK,EAAEP,QAAQ,EAAE;QAChE,MAAMhB,SAASN,WAAW;YAACK,iBAAiB;gBAAED,MAAM;YAAQ;SAAG;QAE/DP,OAAO,IACLE,qBAAqB;gBACnBE,aAAa;oBAAEgB,OAAO;wBAAEK,UAAUA;oBAA8C;gBAAE;gBAClFhB;gBACAE,iBAAiB;YACnB,IACAE,OAAO,CAACmB;IACZ;IAEA/B,GAAG,+FAA+F;QAChG,MAAMQ,SAASN,WAAW;YAACK,iBAAiB;gBAAED,MAAM;YAAQ;SAAG;QAE/DP,OAAO,IACLE,qBAAqB;gBACnBE,aAAa;oBAAEgB,OAAO;wBAAEK,UAAU;4BAAC;gCAAEC,MAAM;4BAAe;yBAAE;oBAAC;gBAAE;gBAC/DjB;gBACAE,iBAAiB;YACnB,IACAC,GAAG,CAACC,OAAO;IACf;AACF"}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import type { Crop, Document, FocalPoint } from 'payload';
|
|
2
|
+
/** The crop saved in `doc._transforms`, or `undefined` when there is none. */
|
|
3
|
+
export declare function getSavedCrop({ doc }: {
|
|
4
|
+
doc?: Document;
|
|
5
|
+
}): Omit<Crop, 'unit'> | undefined;
|
|
6
|
+
/**
|
|
7
|
+
* The focal point saved in `doc._transforms`, rounded to whole percent as `focalX`/`focalY` are.
|
|
8
|
+
* A document saved before `_transforms` existed has only `focalX`/`focalY`. Payload does not save
|
|
9
|
+
* a focal point at the center, so `focalX`/`focalY` at the center also mean "no focal point".
|
|
10
|
+
*/
|
|
11
|
+
export declare function getSavedFocalPoint({ doc }: {
|
|
12
|
+
doc?: Document;
|
|
13
|
+
}): FocalPoint | undefined;
|
|
14
|
+
//# sourceMappingURL=readSavedTransforms.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"readSavedTransforms.d.ts","sourceRoot":"","sources":["../src/readSavedTransforms.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AAIzD,8EAA8E;AAC9E,wBAAgB,YAAY,CAAC,EAAE,GAAG,EAAE,EAAE;IAAE,GAAG,CAAC,EAAE,QAAQ,CAAA;CAAE,GAAG,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,SAAS,CAYxF;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,EAAE,GAAG,EAAE,EAAE;IAAE,GAAG,CAAC,EAAE,QAAQ,CAAA;CAAE,GAAG,UAAU,GAAG,SAAS,CAYtF"}
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
import { isNumber } from 'payload/shared';
|
|
2
|
+
/** The crop saved in `doc._transforms`, or `undefined` when there is none. */ export function getSavedCrop({ doc }) {
|
|
3
|
+
const crop = getTransforms({
|
|
4
|
+
doc
|
|
5
|
+
})?.crop;
|
|
6
|
+
if (crop && isNumber(crop.height) && isNumber(crop.width) && isNumber(crop.x) && isNumber(crop.y)) {
|
|
7
|
+
return {
|
|
8
|
+
height: crop.height,
|
|
9
|
+
width: crop.width,
|
|
10
|
+
x: crop.x,
|
|
11
|
+
y: crop.y
|
|
12
|
+
};
|
|
13
|
+
}
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* The focal point saved in `doc._transforms`, rounded to whole percent as `focalX`/`focalY` are.
|
|
17
|
+
* A document saved before `_transforms` existed has only `focalX`/`focalY`. Payload does not save
|
|
18
|
+
* a focal point at the center, so `focalX`/`focalY` at the center also mean "no focal point".
|
|
19
|
+
*/ export function getSavedFocalPoint({ doc }) {
|
|
20
|
+
const focalPoint = getTransforms({
|
|
21
|
+
doc
|
|
22
|
+
})?.focalPoint;
|
|
23
|
+
if (focalPoint && isNumber(focalPoint.x) && isNumber(focalPoint.y)) {
|
|
24
|
+
return {
|
|
25
|
+
x: Math.round(focalPoint.x),
|
|
26
|
+
y: Math.round(focalPoint.y)
|
|
27
|
+
};
|
|
28
|
+
}
|
|
29
|
+
if (isNumber(doc?.focalX) && isNumber(doc?.focalY)) {
|
|
30
|
+
const legacyFocalPoint = {
|
|
31
|
+
x: Math.round(doc.focalX),
|
|
32
|
+
y: Math.round(doc.focalY)
|
|
33
|
+
};
|
|
34
|
+
return legacyFocalPoint.x === 50 && legacyFocalPoint.y === 50 ? undefined : legacyFocalPoint;
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
function getTransforms({ doc }) {
|
|
38
|
+
const transforms = doc?._transforms;
|
|
39
|
+
return transforms && typeof transforms === 'object' && !Array.isArray(transforms) ? transforms : undefined;
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
//# sourceMappingURL=readSavedTransforms.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/readSavedTransforms.ts"],"sourcesContent":["import type { Crop, Document, FocalPoint } from 'payload'\n\nimport { isNumber } from 'payload/shared'\n\n/** The crop saved in `doc._transforms`, or `undefined` when there is none. */\nexport function getSavedCrop({ doc }: { doc?: Document }): Omit<Crop, 'unit'> | undefined {\n const crop = getTransforms({ doc })?.crop\n\n if (\n crop &&\n isNumber(crop.height) &&\n isNumber(crop.width) &&\n isNumber(crop.x) &&\n isNumber(crop.y)\n ) {\n return { height: crop.height, width: crop.width, x: crop.x, y: crop.y }\n }\n}\n\n/**\n * The focal point saved in `doc._transforms`, rounded to whole percent as `focalX`/`focalY` are.\n * A document saved before `_transforms` existed has only `focalX`/`focalY`. Payload does not save\n * a focal point at the center, so `focalX`/`focalY` at the center also mean \"no focal point\".\n */\nexport function getSavedFocalPoint({ doc }: { doc?: Document }): FocalPoint | undefined {\n const focalPoint = getTransforms({ doc })?.focalPoint\n\n if (focalPoint && isNumber(focalPoint.x) && isNumber(focalPoint.y)) {\n return { x: Math.round(focalPoint.x), y: Math.round(focalPoint.y) }\n }\n\n if (isNumber(doc?.focalX) && isNumber(doc?.focalY)) {\n const legacyFocalPoint = { x: Math.round(doc.focalX), y: Math.round(doc.focalY) }\n\n return legacyFocalPoint.x === 50 && legacyFocalPoint.y === 50 ? undefined : legacyFocalPoint\n }\n}\n\nfunction getTransforms({ doc }: { doc?: Document }):\n | {\n crop?: Partial<Record<keyof Omit<Crop, 'unit'>, unknown>>\n focalPoint?: { x?: unknown; y?: unknown }\n }\n | undefined {\n const transforms = doc?._transforms\n\n return transforms && typeof transforms === 'object' && !Array.isArray(transforms)\n ? transforms\n : undefined\n}\n"],"names":["isNumber","getSavedCrop","doc","crop","getTransforms","height","width","x","y","getSavedFocalPoint","focalPoint","Math","round","focalX","focalY","legacyFocalPoint","undefined","transforms","_transforms","Array","isArray"],"mappings":"AAEA,SAASA,QAAQ,QAAQ,iBAAgB;AAEzC,4EAA4E,GAC5E,OAAO,SAASC,aAAa,EAAEC,GAAG,EAAsB;IACtD,MAAMC,OAAOC,cAAc;QAAEF;IAAI,IAAIC;IAErC,IACEA,QACAH,SAASG,KAAKE,MAAM,KACpBL,SAASG,KAAKG,KAAK,KACnBN,SAASG,KAAKI,CAAC,KACfP,SAASG,KAAKK,CAAC,GACf;QACA,OAAO;YAAEH,QAAQF,KAAKE,MAAM;YAAEC,OAAOH,KAAKG,KAAK;YAAEC,GAAGJ,KAAKI,CAAC;YAAEC,GAAGL,KAAKK,CAAC;QAAC;IACxE;AACF;AAEA;;;;CAIC,GACD,OAAO,SAASC,mBAAmB,EAAEP,GAAG,EAAsB;IAC5D,MAAMQ,aAAaN,cAAc;QAAEF;IAAI,IAAIQ;IAE3C,IAAIA,cAAcV,SAASU,WAAWH,CAAC,KAAKP,SAASU,WAAWF,CAAC,GAAG;QAClE,OAAO;YAAED,GAAGI,KAAKC,KAAK,CAACF,WAAWH,CAAC;YAAGC,GAAGG,KAAKC,KAAK,CAACF,WAAWF,CAAC;QAAE;IACpE;IAEA,IAAIR,SAASE,KAAKW,WAAWb,SAASE,KAAKY,SAAS;QAClD,MAAMC,mBAAmB;YAAER,GAAGI,KAAKC,KAAK,CAACV,IAAIW,MAAM;YAAGL,GAAGG,KAAKC,KAAK,CAACV,IAAIY,MAAM;QAAE;QAEhF,OAAOC,iBAAiBR,CAAC,KAAK,MAAMQ,iBAAiBP,CAAC,KAAK,KAAKQ,YAAYD;IAC9E;AACF;AAEA,SAASX,cAAc,EAAEF,GAAG,EAAsB;IAMhD,MAAMe,aAAaf,KAAKgB;IAExB,OAAOD,cAAc,OAAOA,eAAe,YAAY,CAACE,MAAMC,OAAO,CAACH,cAClEA,aACAD;AACN"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sharpTransformer.d.ts","sourceRoot":"","sources":["../src/sharpTransformer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAkD,iBAAiB,EAAE,MAAM,SAAS,CAAA;AAChG,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,kBAAkB,CAAA;AAKrE,OAAO,KAAK,EAAE,oBAAoB,EAAuB,uBAAuB,EAAE,MAAM,YAAY,CAAA;AAiBpG,wBAAgB,2BAA2B,CACzC,SAAS,CAAC,EAAE,oBAAoB,GAC/B,QAAQ,CAAC,oBAAoB,CAAC,CAShC;AAgBD;;;GAGG;AACH,wBAAgB,gBAAgB,CAC9B,OAAO,GAAE,uBAA4B,GACpC,6BAA6B,GAAG,iBAAiB,
|
|
1
|
+
{"version":3,"file":"sharpTransformer.d.ts","sourceRoot":"","sources":["../src/sharpTransformer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAkD,iBAAiB,EAAE,MAAM,SAAS,CAAA;AAChG,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,kBAAkB,CAAA;AAKrE,OAAO,KAAK,EAAE,oBAAoB,EAAuB,uBAAuB,EAAE,MAAM,YAAY,CAAA;AAiBpG,wBAAgB,2BAA2B,CACzC,SAAS,CAAC,EAAE,oBAAoB,GAC/B,QAAQ,CAAC,oBAAoB,CAAC,CAShC;AAgBD;;;GAGG;AACH,wBAAgB,gBAAgB,CAC9B,OAAO,GAAE,uBAA4B,GACpC,6BAA6B,GAAG,iBAAiB,CAqDnD"}
|