@payloadcms/storage-r2 4.0.0-canary.32 → 4.0.0-canary.34
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/adapter.d.ts.map +1 -1
- package/dist/adapter.js +9 -14
- package/dist/adapter.js.map +1 -1
- package/dist/client/R2ClientUploadHandler.d.ts.map +1 -1
- package/dist/client/R2ClientUploadHandler.js +7 -12
- package/dist/client/R2ClientUploadHandler.js.map +1 -1
- package/dist/deleteFile.d.ts +2 -5
- package/dist/deleteFile.d.ts.map +1 -1
- package/dist/deleteFile.js +2 -9
- package/dist/deleteFile.js.map +1 -1
- package/dist/getFile.d.ts +3 -3
- package/dist/getFile.d.ts.map +1 -1
- package/dist/getFile.js +14 -12
- package/dist/getFile.js.map +1 -1
- package/dist/handleMultiPartUpload.createOnly.spec.d.ts +2 -0
- package/dist/handleMultiPartUpload.createOnly.spec.d.ts.map +1 -0
- package/dist/handleMultiPartUpload.createOnly.spec.js +51 -0
- package/dist/handleMultiPartUpload.createOnly.spec.js.map +1 -0
- package/dist/handleMultiPartUpload.d.ts +1 -2
- package/dist/handleMultiPartUpload.d.ts.map +1 -1
- package/dist/handleMultiPartUpload.js +38 -22
- package/dist/handleMultiPartUpload.js.map +1 -1
- package/dist/handleMultiPartUpload.spec.d.ts +2 -0
- package/dist/handleMultiPartUpload.spec.d.ts.map +1 -0
- package/dist/handleMultiPartUpload.spec.js +177 -0
- package/dist/handleMultiPartUpload.spec.js.map +1 -0
- package/dist/index.d.ts +8 -7
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js.map +1 -1
- package/dist/staticHandler.spec.d.ts +2 -0
- package/dist/staticHandler.spec.d.ts.map +1 -0
- package/dist/staticHandler.spec.js +63 -0
- package/dist/staticHandler.spec.js.map +1 -0
- package/dist/types.d.ts +3 -4
- package/dist/types.d.ts.map +1 -1
- package/dist/types.js.map +1 -1
- package/dist/uploadFile.d.ts +2 -5
- package/dist/uploadFile.d.ts.map +1 -1
- package/dist/uploadFile.js +2 -9
- package/dist/uploadFile.js.map +1 -1
- package/package.json +4 -4
package/dist/adapter.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../src/adapter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,OAAO,EACP,mBAAmB,EAEpB,MAAM,wCAAwC,CAAA;AAE/C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAA;AAClD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAO1C,UAAU,mBAAmB;IAC3B,MAAM,EAAE,QAAQ,CAAA;IAChB,aAAa,CAAC,EAAE,mBAAmB,CAAA;IACnC,WAAW,EAAE,gBAAgB,CAAC,aAAa,CAAC,CAAA;IAC5C,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B;AAED,wBAAgB,eAAe,CAAC,EAC9B,MAAM,EACN,aAAa,EACb,WAAW,EACX,oBAA4B,GAC7B,EAAE,mBAAmB,GAAG,OAAO,
|
|
1
|
+
{"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../src/adapter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,OAAO,EACP,mBAAmB,EAEpB,MAAM,wCAAwC,CAAA;AAE/C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAA;AAClD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAO1C,UAAU,mBAAmB;IAC3B,MAAM,EAAE,QAAQ,CAAA;IAChB,aAAa,CAAC,EAAE,mBAAmB,CAAA;IACnC,WAAW,EAAE,gBAAgB,CAAC,aAAa,CAAC,CAAA;IAC5C,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B;AAED,wBAAgB,eAAe,CAAC,EAC9B,MAAM,EACN,aAAa,EACb,WAAW,EACX,oBAA4B,GAC7B,EAAE,mBAAmB,GAAG,OAAO,CA6D/B"}
|
package/dist/adapter.js
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import { deleteFile } from './deleteFile.js';
|
|
2
2
|
import { getFile } from './getFile.js';
|
|
3
|
-
import {
|
|
3
|
+
import { getHandleMultiPartUpload } from './handleMultiPartUpload.js';
|
|
4
4
|
import { uploadFile } from './uploadFile.js';
|
|
5
5
|
export function createR2Adapter({ bucket, clientUploads, collections, useCompositePrefixes = false }) {
|
|
6
|
-
const access = typeof clientUploads === 'object'
|
|
6
|
+
const access = typeof clientUploads === 'object' ? clientUploads.access : undefined;
|
|
7
7
|
const uploadInstructions = {
|
|
8
8
|
adminHandler: {
|
|
9
9
|
path: '@payloadcms/storage-r2/client#R2ClientUploadHandler'
|
|
@@ -28,34 +28,29 @@ export function createR2Adapter({ bucket, clientUploads, collections, useComposi
|
|
|
28
28
|
uploadReference: {}
|
|
29
29
|
}
|
|
30
30
|
}),
|
|
31
|
+
requiresUploadReceipt: true,
|
|
31
32
|
useInAdmin: true
|
|
32
33
|
};
|
|
33
34
|
return ({ collection, prefix = '' })=>({
|
|
34
35
|
name: 'r2',
|
|
35
36
|
uploadInstructions,
|
|
36
|
-
handleDelete: ({
|
|
37
|
+
handleDelete: ({ storageFilePath })=>deleteFile({
|
|
37
38
|
bucket,
|
|
38
|
-
|
|
39
|
-
docPrefix,
|
|
40
|
-
filename,
|
|
41
|
-
useCompositePrefixes
|
|
39
|
+
storageFilePath
|
|
42
40
|
}),
|
|
43
|
-
handleUpload: ({
|
|
41
|
+
handleUpload: ({ file, storageFilePath })=>uploadFile({
|
|
44
42
|
bucket,
|
|
45
43
|
buffer: file.buffer,
|
|
46
|
-
collectionPrefix: prefix,
|
|
47
|
-
docPrefix: data.prefix,
|
|
48
|
-
filename: file.filename,
|
|
49
44
|
mimeType: file.mimeType,
|
|
50
|
-
|
|
45
|
+
storageFilePath
|
|
51
46
|
}),
|
|
52
|
-
staticHandler: (req, { headers, params: { filename,
|
|
47
|
+
staticHandler: (req, { doc, headers, params: { filename, uploadReference } })=>getFile({
|
|
53
48
|
bucket,
|
|
54
49
|
collection,
|
|
50
|
+
doc,
|
|
55
51
|
filename,
|
|
56
52
|
incomingHeaders: headers,
|
|
57
53
|
prefix,
|
|
58
|
-
prefixQueryParam,
|
|
59
54
|
req,
|
|
60
55
|
uploadReference,
|
|
61
56
|
useCompositePrefixes
|
package/dist/adapter.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/adapter.ts"],"sourcesContent":["import type {\n Adapter,\n ClientUploadsConfig,\n GeneratedAdapter,\n} from '@payloadcms/plugin-cloud-storage/types'\n\nimport type { R2StorageOptions } from './index.js'\nimport type { R2Bucket } from './types.js'\n\nimport { deleteFile } from './deleteFile.js'\nimport { getFile } from './getFile.js'\nimport {
|
|
1
|
+
{"version":3,"sources":["../src/adapter.ts"],"sourcesContent":["import type {\n Adapter,\n ClientUploadsConfig,\n GeneratedAdapter,\n} from '@payloadcms/plugin-cloud-storage/types'\n\nimport type { R2StorageOptions } from './index.js'\nimport type { R2Bucket } from './types.js'\n\nimport { deleteFile } from './deleteFile.js'\nimport { getFile } from './getFile.js'\nimport { getHandleMultiPartUpload } from './handleMultiPartUpload.js'\nimport { uploadFile } from './uploadFile.js'\n\ninterface CreateR2AdapterArgs {\n bucket: R2Bucket\n clientUploads?: ClientUploadsConfig\n collections: R2StorageOptions['collections']\n useCompositePrefixes?: boolean\n}\n\nexport function createR2Adapter({\n bucket,\n clientUploads,\n collections,\n useCompositePrefixes = false,\n}: CreateR2AdapterArgs): Adapter {\n const access = typeof clientUploads === 'object' ? clientUploads.access : undefined\n const uploadInstructions: GeneratedAdapter['uploadInstructions'] = {\n adminHandler: {\n path: '@payloadcms/storage-r2/client#R2ClientUploadHandler',\n },\n enabled: Boolean(clientUploads),\n endpoint: {\n handler: getHandleMultiPartUpload({\n access,\n bucket,\n collections,\n useCompositePrefixes,\n }),\n path: '/storage-r2-multi-part-upload',\n },\n generate: ({ filename, filesize, mimeType }) => ({\n name: 'uploadToR2',\n type: 'dispatch',\n file: {\n filename,\n mimeType,\n size: filesize,\n uploadReference: {},\n },\n }),\n requiresUploadReceipt: true,\n useInAdmin: true,\n }\n\n return ({ collection, prefix = '' }): GeneratedAdapter => ({\n name: 'r2',\n uploadInstructions,\n\n handleDelete: ({ storageFilePath }) =>\n deleteFile({\n bucket,\n storageFilePath,\n }),\n\n handleUpload: ({ file, storageFilePath }) =>\n uploadFile({\n bucket,\n buffer: file.buffer,\n mimeType: file.mimeType,\n storageFilePath,\n }),\n\n staticHandler: (req, { doc, headers, params: { filename, uploadReference } }) =>\n getFile({\n bucket,\n collection,\n doc,\n filename,\n incomingHeaders: headers,\n prefix,\n req,\n uploadReference,\n useCompositePrefixes,\n }),\n })\n}\n"],"names":["deleteFile","getFile","getHandleMultiPartUpload","uploadFile","createR2Adapter","bucket","clientUploads","collections","useCompositePrefixes","access","undefined","uploadInstructions","adminHandler","path","enabled","Boolean","endpoint","handler","generate","filename","filesize","mimeType","name","type","file","size","uploadReference","requiresUploadReceipt","useInAdmin","collection","prefix","handleDelete","storageFilePath","handleUpload","buffer","staticHandler","req","doc","headers","params","incomingHeaders"],"mappings":"AASA,SAASA,UAAU,QAAQ,kBAAiB;AAC5C,SAASC,OAAO,QAAQ,eAAc;AACtC,SAASC,wBAAwB,QAAQ,6BAA4B;AACrE,SAASC,UAAU,QAAQ,kBAAiB;AAS5C,OAAO,SAASC,gBAAgB,EAC9BC,MAAM,EACNC,aAAa,EACbC,WAAW,EACXC,uBAAuB,KAAK,EACR;IACpB,MAAMC,SAAS,OAAOH,kBAAkB,WAAWA,cAAcG,MAAM,GAAGC;IAC1E,MAAMC,qBAA6D;QACjEC,cAAc;YACZC,MAAM;QACR;QACAC,SAASC,QAAQT;QACjBU,UAAU;YACRC,SAASf,yBAAyB;gBAChCO;gBACAJ;gBACAE;gBACAC;YACF;YACAK,MAAM;QACR;QACAK,UAAU,CAAC,EAAEC,QAAQ,EAAEC,QAAQ,EAAEC,QAAQ,EAAE,GAAM,CAAA;gBAC/CC,MAAM;gBACNC,MAAM;gBACNC,MAAM;oBACJL;oBACAE;oBACAI,MAAML;oBACNM,iBAAiB,CAAC;gBACpB;YACF,CAAA;QACAC,uBAAuB;QACvBC,YAAY;IACd;IAEA,OAAO,CAAC,EAAEC,UAAU,EAAEC,SAAS,EAAE,EAAE,GAAwB,CAAA;YACzDR,MAAM;YACNX;YAEAoB,cAAc,CAAC,EAAEC,eAAe,EAAE,GAChChC,WAAW;oBACTK;oBACA2B;gBACF;YAEFC,cAAc,CAAC,EAAET,IAAI,EAAEQ,eAAe,EAAE,GACtC7B,WAAW;oBACTE;oBACA6B,QAAQV,KAAKU,MAAM;oBACnBb,UAAUG,KAAKH,QAAQ;oBACvBW;gBACF;YAEFG,eAAe,CAACC,KAAK,EAAEC,GAAG,EAAEC,OAAO,EAAEC,QAAQ,EAAEpB,QAAQ,EAAEO,eAAe,EAAE,EAAE,GAC1EzB,QAAQ;oBACNI;oBACAwB;oBACAQ;oBACAlB;oBACAqB,iBAAiBF;oBACjBR;oBACAM;oBACAV;oBACAlB;gBACF;QACJ,CAAA;AACF"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"R2ClientUploadHandler.d.ts","sourceRoot":"","sources":["../../src/client/R2ClientUploadHandler.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAEV,kCAAkC,EAInC,MAAM,aAAa,CAAA;AAEpB,eAAO,MAAM,qBAAqB;;;;;;
|
|
1
|
+
{"version":3,"file":"R2ClientUploadHandler.d.ts","sourceRoot":"","sources":["../../src/client/R2ClientUploadHandler.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAEV,kCAAkC,EAInC,MAAM,aAAa,CAAA;AAEpB,eAAO,MAAM,qBAAqB;;;;;;iCAqFhC,CAAA"}
|
|
@@ -1,17 +1,12 @@
|
|
|
1
1
|
'use client';
|
|
2
|
-
import { createClientUploadHandler
|
|
2
|
+
import { createClientUploadHandler } from '@payloadcms/plugin-cloud-storage/client';
|
|
3
3
|
import { formatAdminURL } from 'payload/shared';
|
|
4
4
|
export const R2ClientUploadHandler = createClientUploadHandler({
|
|
5
5
|
name: 'uploadToR2',
|
|
6
|
-
handler: async ({ apiRoute, collectionSlug, docPrefix, endpointPath, file,
|
|
7
|
-
const { sanitizedDocPrefix } = getFileKey({
|
|
8
|
-
collectionPrefix: prefix,
|
|
9
|
-
docPrefix,
|
|
10
|
-
filename: file.name
|
|
11
|
-
});
|
|
6
|
+
handler: async ({ apiRoute, collectionSlug, docPrefix, endpointPath, file, props: { chunkSize = 5 * 1024 * 1024 }, serverURL, updateFilename })=>{
|
|
12
7
|
const params = {
|
|
13
8
|
collection: collectionSlug,
|
|
14
|
-
docPrefix
|
|
9
|
+
docPrefix,
|
|
15
10
|
fileName: file.name,
|
|
16
11
|
fileType: file.type
|
|
17
12
|
};
|
|
@@ -28,13 +23,14 @@ export const R2ClientUploadHandler = createClientUploadHandler({
|
|
|
28
23
|
if (!multipart.ok) {
|
|
29
24
|
throw new Error('Failed to initialize multipart upload');
|
|
30
25
|
}
|
|
31
|
-
const { filename: sanitizedFilename, ...multipartUpload } = await multipart.json();
|
|
26
|
+
const { filename: sanitizedFilename, uploadReference, ...multipartUpload } = await multipart.json();
|
|
32
27
|
if (sanitizedFilename && sanitizedFilename !== file.name) {
|
|
33
28
|
updateFilename(sanitizedFilename);
|
|
34
29
|
}
|
|
35
30
|
const multipartUploadedParts = [];
|
|
36
31
|
params.multipartId = multipartUpload.uploadId;
|
|
37
32
|
params.multipartKey = multipartUpload.key;
|
|
33
|
+
params.signedReceipt = uploadReference.signedReceipt;
|
|
38
34
|
const partTotal = Math.ceil(file.size / chunkSize);
|
|
39
35
|
for(let part = 1; part <= partTotal; part++){
|
|
40
36
|
const bytesEnd = Math.min(part * chunkSize, file.size);
|
|
@@ -68,10 +64,9 @@ export const R2ClientUploadHandler = createClientUploadHandler({
|
|
|
68
64
|
if (!complete.ok) {
|
|
69
65
|
throw new Error(`Failed to complete multipart upload`);
|
|
70
66
|
}
|
|
71
|
-
const key = await complete.text();
|
|
72
67
|
return {
|
|
73
|
-
|
|
74
|
-
|
|
68
|
+
prefix: uploadReference.prefix,
|
|
69
|
+
signedReceipt: uploadReference.signedReceipt
|
|
75
70
|
};
|
|
76
71
|
}
|
|
77
72
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/client/R2ClientUploadHandler.ts"],"sourcesContent":["'use client'\n\nimport { createClientUploadHandler
|
|
1
|
+
{"version":3,"sources":["../../src/client/R2ClientUploadHandler.ts"],"sourcesContent":["'use client'\n\nimport { createClientUploadHandler } from '@payloadcms/plugin-cloud-storage/client'\nimport { formatAdminURL } from 'payload/shared'\n\nimport type {\n R2MultipartUpload,\n R2StorageClientUploadHandlerParams,\n R2StorageMultipartUploadHandlerParams,\n R2StorageUploadReference,\n R2UploadedPart,\n} from '../types.js'\n\nexport const R2ClientUploadHandler = createClientUploadHandler<R2StorageClientUploadHandlerParams>({\n name: 'uploadToR2',\n handler: async ({\n apiRoute,\n collectionSlug,\n docPrefix,\n endpointPath,\n file,\n props: { chunkSize = 5 * 1024 * 1024 },\n serverURL,\n updateFilename,\n }): Promise<R2StorageUploadReference | undefined> => {\n const params: R2StorageMultipartUploadHandlerParams = {\n collection: collectionSlug,\n docPrefix,\n fileName: file.name,\n fileType: file.type,\n }\n const baseURL = formatAdminURL({\n apiRoute,\n path: endpointPath,\n serverURL,\n })\n\n const getEndpoint = () => `${baseURL}?${String(new URLSearchParams(params))}`\n\n // Initialize the multipart upload.\n const multipart = await fetch(getEndpoint(), { method: 'POST' })\n if (!multipart.ok) {\n throw new Error('Failed to initialize multipart upload')\n }\n\n const {\n filename: sanitizedFilename,\n uploadReference,\n ...multipartUpload\n } = (await multipart.json()) as {\n filename?: string\n uploadReference: R2StorageUploadReference\n } & Pick<R2MultipartUpload, 'key' | 'uploadId'>\n\n if (sanitizedFilename && sanitizedFilename !== file.name) {\n updateFilename(sanitizedFilename)\n }\n\n const multipartUploadedParts: R2UploadedPart[] = []\n\n params.multipartId = multipartUpload.uploadId\n params.multipartKey = multipartUpload.key\n params.signedReceipt = uploadReference.signedReceipt\n\n const partTotal = Math.ceil(file.size / chunkSize)\n\n for (let part = 1; part <= partTotal; part++) {\n const bytesEnd = Math.min(part * chunkSize, file.size)\n const bytesStart = (part - 1) * chunkSize\n\n params.multipartNumber = String(part)\n\n const body = file.slice(bytesStart, bytesEnd)\n const headers = {\n 'Content-Length': String(body.size),\n 'Content-Type': 'application/octet-stream',\n }\n const uploaded = await fetch(getEndpoint(), { body, headers, method: 'POST' })\n if (!uploaded.ok) {\n throw new Error(`Failed to upload part ${part} / ${partTotal}`)\n }\n\n multipartUploadedParts.push((await uploaded.json()) as R2UploadedPart)\n\n if (part === partTotal) {\n delete params.multipartNumber\n\n const body = JSON.stringify(multipartUploadedParts)\n const headers = { 'Content-Type': 'application/json' }\n const complete = await fetch(getEndpoint(), { body, headers, method: 'POST' })\n if (!complete.ok) {\n throw new Error(`Failed to complete multipart upload`)\n }\n\n return { prefix: uploadReference.prefix, signedReceipt: uploadReference.signedReceipt }\n }\n }\n },\n})\n"],"names":["createClientUploadHandler","formatAdminURL","R2ClientUploadHandler","name","handler","apiRoute","collectionSlug","docPrefix","endpointPath","file","props","chunkSize","serverURL","updateFilename","params","collection","fileName","fileType","type","baseURL","path","getEndpoint","String","URLSearchParams","multipart","fetch","method","ok","Error","filename","sanitizedFilename","uploadReference","multipartUpload","json","multipartUploadedParts","multipartId","uploadId","multipartKey","key","signedReceipt","partTotal","Math","ceil","size","part","bytesEnd","min","bytesStart","multipartNumber","body","slice","headers","uploaded","push","JSON","stringify","complete","prefix"],"mappings":"AAAA;AAEA,SAASA,yBAAyB,QAAQ,0CAAyC;AACnF,SAASC,cAAc,QAAQ,iBAAgB;AAU/C,OAAO,MAAMC,wBAAwBF,0BAA8D;IACjGG,MAAM;IACNC,SAAS,OAAO,EACdC,QAAQ,EACRC,cAAc,EACdC,SAAS,EACTC,YAAY,EACZC,IAAI,EACJC,OAAO,EAAEC,YAAY,IAAI,OAAO,IAAI,EAAE,EACtCC,SAAS,EACTC,cAAc,EACf;QACC,MAAMC,SAAgD;YACpDC,YAAYT;YACZC;YACAS,UAAUP,KAAKN,IAAI;YACnBc,UAAUR,KAAKS,IAAI;QACrB;QACA,MAAMC,UAAUlB,eAAe;YAC7BI;YACAe,MAAMZ;YACNI;QACF;QAEA,MAAMS,cAAc,IAAM,GAAGF,QAAQ,CAAC,EAAEG,OAAO,IAAIC,gBAAgBT,UAAU;QAE7E,mCAAmC;QACnC,MAAMU,YAAY,MAAMC,MAAMJ,eAAe;YAAEK,QAAQ;QAAO;QAC9D,IAAI,CAACF,UAAUG,EAAE,EAAE;YACjB,MAAM,IAAIC,MAAM;QAClB;QAEA,MAAM,EACJC,UAAUC,iBAAiB,EAC3BC,eAAe,EACf,GAAGC,iBACJ,GAAI,MAAMR,UAAUS,IAAI;QAKzB,IAAIH,qBAAqBA,sBAAsBrB,KAAKN,IAAI,EAAE;YACxDU,eAAeiB;QACjB;QAEA,MAAMI,yBAA2C,EAAE;QAEnDpB,OAAOqB,WAAW,GAAGH,gBAAgBI,QAAQ;QAC7CtB,OAAOuB,YAAY,GAAGL,gBAAgBM,GAAG;QACzCxB,OAAOyB,aAAa,GAAGR,gBAAgBQ,aAAa;QAEpD,MAAMC,YAAYC,KAAKC,IAAI,CAACjC,KAAKkC,IAAI,GAAGhC;QAExC,IAAK,IAAIiC,OAAO,GAAGA,QAAQJ,WAAWI,OAAQ;YAC5C,MAAMC,WAAWJ,KAAKK,GAAG,CAACF,OAAOjC,WAAWF,KAAKkC,IAAI;YACrD,MAAMI,aAAa,AAACH,CAAAA,OAAO,CAAA,IAAKjC;YAEhCG,OAAOkC,eAAe,GAAG1B,OAAOsB;YAEhC,MAAMK,OAAOxC,KAAKyC,KAAK,CAACH,YAAYF;YACpC,MAAMM,UAAU;gBACd,kBAAkB7B,OAAO2B,KAAKN,IAAI;gBAClC,gBAAgB;YAClB;YACA,MAAMS,WAAW,MAAM3B,MAAMJ,eAAe;gBAAE4B;gBAAME;gBAASzB,QAAQ;YAAO;YAC5E,IAAI,CAAC0B,SAASzB,EAAE,EAAE;gBAChB,MAAM,IAAIC,MAAM,CAAC,sBAAsB,EAAEgB,KAAK,GAAG,EAAEJ,WAAW;YAChE;YAEAN,uBAAuBmB,IAAI,CAAE,MAAMD,SAASnB,IAAI;YAEhD,IAAIW,SAASJ,WAAW;gBACtB,OAAO1B,OAAOkC,eAAe;gBAE7B,MAAMC,OAAOK,KAAKC,SAAS,CAACrB;gBAC5B,MAAMiB,UAAU;oBAAE,gBAAgB;gBAAmB;gBACrD,MAAMK,WAAW,MAAM/B,MAAMJ,eAAe;oBAAE4B;oBAAME;oBAASzB,QAAQ;gBAAO;gBAC5E,IAAI,CAAC8B,SAAS7B,EAAE,EAAE;oBAChB,MAAM,IAAIC,MAAM,CAAC,mCAAmC,CAAC;gBACvD;gBAEA,OAAO;oBAAE6B,QAAQ1B,gBAAgB0B,MAAM;oBAAElB,eAAeR,gBAAgBQ,aAAa;gBAAC;YACxF;QACF;IACF;AACF,GAAE"}
|
package/dist/deleteFile.d.ts
CHANGED
|
@@ -1,11 +1,8 @@
|
|
|
1
1
|
import type { R2Bucket } from './types.js';
|
|
2
2
|
interface DeleteFileArgs {
|
|
3
3
|
bucket: R2Bucket;
|
|
4
|
-
|
|
5
|
-
docPrefix: string;
|
|
6
|
-
filename: string;
|
|
7
|
-
useCompositePrefixes?: boolean;
|
|
4
|
+
storageFilePath: string;
|
|
8
5
|
}
|
|
9
|
-
export declare function deleteFile({ bucket,
|
|
6
|
+
export declare function deleteFile({ bucket, storageFilePath }: DeleteFileArgs): Promise<void>;
|
|
10
7
|
export {};
|
|
11
8
|
//# sourceMappingURL=deleteFile.d.ts.map
|
package/dist/deleteFile.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"deleteFile.d.ts","sourceRoot":"","sources":["../src/deleteFile.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"deleteFile.d.ts","sourceRoot":"","sources":["../src/deleteFile.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAE1C,UAAU,cAAc;IACtB,MAAM,EAAE,QAAQ,CAAA;IAChB,eAAe,EAAE,MAAM,CAAA;CACxB;AAED,wBAAsB,UAAU,CAAC,EAAE,MAAM,EAAE,eAAe,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAE3F"}
|
package/dist/deleteFile.js
CHANGED
|
@@ -1,12 +1,5 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
const { fileKey } = getFileKey({
|
|
4
|
-
collectionPrefix,
|
|
5
|
-
docPrefix,
|
|
6
|
-
filename,
|
|
7
|
-
useCompositePrefixes
|
|
8
|
-
});
|
|
9
|
-
await bucket.delete(fileKey);
|
|
1
|
+
export async function deleteFile({ bucket, storageFilePath }) {
|
|
2
|
+
await bucket.delete(storageFilePath);
|
|
10
3
|
}
|
|
11
4
|
|
|
12
5
|
//# sourceMappingURL=deleteFile.js.map
|
package/dist/deleteFile.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/deleteFile.ts"],"sourcesContent":["import
|
|
1
|
+
{"version":3,"sources":["../src/deleteFile.ts"],"sourcesContent":["import type { R2Bucket } from './types.js'\n\ninterface DeleteFileArgs {\n bucket: R2Bucket\n storageFilePath: string\n}\n\nexport async function deleteFile({ bucket, storageFilePath }: DeleteFileArgs): Promise<void> {\n await bucket.delete(storageFilePath)\n}\n"],"names":["deleteFile","bucket","storageFilePath","delete"],"mappings":"AAOA,OAAO,eAAeA,WAAW,EAAEC,MAAM,EAAEC,eAAe,EAAkB;IAC1E,MAAMD,OAAOE,MAAM,CAACD;AACtB"}
|
package/dist/getFile.d.ts
CHANGED
|
@@ -1,16 +1,16 @@
|
|
|
1
|
-
import type { CollectionConfig, PayloadRequest } from 'payload';
|
|
1
|
+
import type { CollectionConfig, PayloadRequest, TypeWithID } from 'payload';
|
|
2
2
|
import type { R2Bucket } from './types.js';
|
|
3
3
|
interface GetFileArgs {
|
|
4
4
|
bucket: R2Bucket;
|
|
5
5
|
collection: CollectionConfig;
|
|
6
|
+
doc?: TypeWithID;
|
|
6
7
|
filename: string;
|
|
7
8
|
incomingHeaders?: Headers;
|
|
8
9
|
prefix: string;
|
|
9
|
-
prefixQueryParam?: string;
|
|
10
10
|
req: PayloadRequest;
|
|
11
11
|
uploadReference?: unknown;
|
|
12
12
|
useCompositePrefixes?: boolean;
|
|
13
13
|
}
|
|
14
|
-
export declare function getFile({ bucket, collection, filename, incomingHeaders, prefix,
|
|
14
|
+
export declare function getFile({ bucket, collection, doc, filename, incomingHeaders, prefix, req, uploadReference, useCompositePrefixes, }: GetFileArgs): Promise<Response>;
|
|
15
15
|
export {};
|
|
16
16
|
//# sourceMappingURL=getFile.d.ts.map
|
package/dist/getFile.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"getFile.d.ts","sourceRoot":"","sources":["../src/getFile.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;
|
|
1
|
+
{"version":3,"file":"getFile.d.ts","sourceRoot":"","sources":["../src/getFile.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AAQ3E,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAE1C,UAAU,WAAW;IACnB,MAAM,EAAE,QAAQ,CAAA;IAChB,UAAU,EAAE,gBAAgB,CAAA;IAC5B,GAAG,CAAC,EAAE,UAAU,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,cAAc,CAAA;IACnB,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B;AAID,wBAAsB,OAAO,CAAC,EAC5B,MAAM,EACN,UAAU,EACV,GAAG,EACH,QAAQ,EACR,eAAe,EACf,MAAW,EACX,GAAG,EACH,eAAe,EACf,oBAA4B,GAC7B,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC,CAwHjC"}
|
package/dist/getFile.js
CHANGED
|
@@ -1,23 +1,25 @@
|
|
|
1
|
-
import { getFilePrefix as getDocPrefix
|
|
2
|
-
import { getRangeRequestInfo } from 'payload/internal';
|
|
1
|
+
import { buildStoragePathData, getFilePrefix as getDocPrefix } from '@payloadcms/plugin-cloud-storage/utilities';
|
|
2
|
+
import { getRangeRequestInfo, isXmlMimeType, uploadContentSecurityPolicy } from 'payload/internal';
|
|
3
3
|
const isMiniflare = process.env.NODE_ENV === 'development';
|
|
4
|
-
export async function getFile({ bucket, collection, filename, incomingHeaders, prefix = '',
|
|
4
|
+
export async function getFile({ bucket, collection, doc, filename, incomingHeaders, prefix = '', req, uploadReference, useCompositePrefixes = false }) {
|
|
5
5
|
try {
|
|
6
6
|
const docPrefix = await getDocPrefix({
|
|
7
7
|
collection,
|
|
8
|
+
collectionPrefix: prefix,
|
|
9
|
+
doc,
|
|
8
10
|
filename,
|
|
9
|
-
prefixQueryParam,
|
|
10
11
|
req,
|
|
11
|
-
uploadReference
|
|
12
|
+
uploadReference,
|
|
13
|
+
useCompositePrefixes
|
|
12
14
|
});
|
|
13
|
-
const {
|
|
15
|
+
const { storageFilePath } = buildStoragePathData({
|
|
14
16
|
collectionPrefix: prefix,
|
|
15
17
|
docPrefix,
|
|
16
18
|
filename,
|
|
17
19
|
useCompositePrefixes
|
|
18
20
|
});
|
|
19
21
|
// Get file size for range validation
|
|
20
|
-
const headObj = await bucket?.head(
|
|
22
|
+
const headObj = await bucket?.head(storageFilePath);
|
|
21
23
|
if (!headObj) {
|
|
22
24
|
return new Response(null, {
|
|
23
25
|
status: 404,
|
|
@@ -46,12 +48,12 @@ export async function getFile({ bucket, collection, filename, incomingHeaders, p
|
|
|
46
48
|
// Get object with range if needed
|
|
47
49
|
// Due to https://github.com/cloudflare/workers-sdk/issues/6047
|
|
48
50
|
// We cannot send a Headers instance to Miniflare
|
|
49
|
-
const obj = rangeResult.type === 'partial' && !isMiniflare ? await bucket?.get(
|
|
51
|
+
const obj = rangeResult.type === 'partial' && !isMiniflare ? await bucket?.get(storageFilePath, {
|
|
50
52
|
range: {
|
|
51
53
|
length: rangeResult.rangeEnd - rangeResult.rangeStart + 1,
|
|
52
54
|
offset: rangeResult.rangeStart
|
|
53
55
|
}
|
|
54
|
-
}) : await bucket?.get(
|
|
56
|
+
}) : await bucket?.get(storageFilePath);
|
|
55
57
|
if (!obj || obj.body == undefined) {
|
|
56
58
|
return new Response(null, {
|
|
57
59
|
status: 404,
|
|
@@ -85,10 +87,10 @@ export async function getFile({ bucket, collection, filename, incomingHeaders, p
|
|
|
85
87
|
} else {
|
|
86
88
|
obj.writeHttpMetadata(headers);
|
|
87
89
|
}
|
|
88
|
-
//
|
|
90
|
+
// Apply a restrictive policy to XML-family responses served through Payload.
|
|
89
91
|
const contentType = headers.get('Content-Type');
|
|
90
|
-
if (contentType
|
|
91
|
-
headers.set('Content-Security-Policy',
|
|
92
|
+
if (isXmlMimeType(contentType)) {
|
|
93
|
+
headers.set('Content-Security-Policy', uploadContentSecurityPolicy);
|
|
92
94
|
}
|
|
93
95
|
const etagFromHeaders = req.headers.get('etag') || req.headers.get('if-none-match');
|
|
94
96
|
if (collection.upload && typeof collection.upload === 'object' && typeof collection.upload.modifyResponseHeaders === 'function') {
|
package/dist/getFile.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/getFile.ts"],"sourcesContent":["import type { CollectionConfig, PayloadRequest } from 'payload'\n\nimport {\n getFilePrefix as getDocPrefix,\n
|
|
1
|
+
{"version":3,"sources":["../src/getFile.ts"],"sourcesContent":["import type { CollectionConfig, PayloadRequest, TypeWithID } from 'payload'\n\nimport {\n buildStoragePathData,\n getFilePrefix as getDocPrefix,\n} from '@payloadcms/plugin-cloud-storage/utilities'\nimport { getRangeRequestInfo, isXmlMimeType, uploadContentSecurityPolicy } from 'payload/internal'\n\nimport type { R2Bucket } from './types.js'\n\ninterface GetFileArgs {\n bucket: R2Bucket\n collection: CollectionConfig\n doc?: TypeWithID\n filename: string\n incomingHeaders?: Headers\n prefix: string\n req: PayloadRequest\n uploadReference?: unknown\n useCompositePrefixes?: boolean\n}\n\nconst isMiniflare = process.env.NODE_ENV === 'development'\n\nexport async function getFile({\n bucket,\n collection,\n doc,\n filename,\n incomingHeaders,\n prefix = '',\n req,\n uploadReference,\n useCompositePrefixes = false,\n}: GetFileArgs): Promise<Response> {\n try {\n const docPrefix = await getDocPrefix({\n collection,\n collectionPrefix: prefix,\n doc,\n filename,\n req,\n uploadReference,\n useCompositePrefixes,\n })\n\n const { storageFilePath } = buildStoragePathData({\n collectionPrefix: prefix,\n docPrefix,\n filename,\n useCompositePrefixes,\n })\n\n // Get file size for range validation\n const headObj = await bucket?.head(storageFilePath)\n if (!headObj) {\n return new Response(null, { status: 404, statusText: 'Not Found' })\n }\n\n const fileSize = headObj.size\n\n // Don't return large file uploads back to the client, or the Worker will run out of memory\n if (fileSize > 50 * 1024 * 1024 && uploadReference) {\n return new Response(null, { status: 200 })\n }\n\n // Handle range request\n const rangeHeader = req.headers.get('range')\n const rangeResult = getRangeRequestInfo({ fileSize, rangeHeader })\n\n if (rangeResult.type === 'invalid') {\n return new Response(null, {\n headers: new Headers(rangeResult.headers),\n status: rangeResult.status,\n })\n }\n\n // Get object with range if needed\n // Due to https://github.com/cloudflare/workers-sdk/issues/6047\n // We cannot send a Headers instance to Miniflare\n const obj =\n rangeResult.type === 'partial' && !isMiniflare\n ? await bucket?.get(storageFilePath, {\n range: {\n length: rangeResult.rangeEnd - rangeResult.rangeStart + 1,\n offset: rangeResult.rangeStart,\n },\n })\n : await bucket?.get(storageFilePath)\n\n if (!obj || obj.body == undefined) {\n return new Response(null, { status: 404, statusText: 'Not Found' })\n }\n\n let headers = new Headers(incomingHeaders)\n\n // Add range-related headers from the result\n for (const [headerKey, value] of Object.entries(rangeResult.headers)) {\n headers.append(headerKey, value)\n }\n\n // Add R2-specific headers\n if (isMiniflare) {\n // In development with Miniflare, manually set headers from httpMetadata\n const metadata = obj.httpMetadata\n if (metadata?.cacheControl) {\n headers.set('Cache-Control', metadata.cacheControl)\n }\n if (metadata?.contentDisposition) {\n headers.set('Content-Disposition', metadata.contentDisposition)\n }\n if (metadata?.contentEncoding) {\n headers.set('Content-Encoding', metadata.contentEncoding)\n }\n if (metadata?.contentLanguage) {\n headers.set('Content-Language', metadata.contentLanguage)\n }\n if (metadata?.contentType) {\n headers.set('Content-Type', metadata.contentType)\n }\n } else {\n obj.writeHttpMetadata(headers)\n }\n\n // Apply a restrictive policy to XML-family responses served through Payload.\n const contentType = headers.get('Content-Type')\n if (isXmlMimeType(contentType)) {\n headers.set('Content-Security-Policy', uploadContentSecurityPolicy)\n }\n\n const etagFromHeaders = req.headers.get('etag') || req.headers.get('if-none-match')\n\n if (\n collection.upload &&\n typeof collection.upload === 'object' &&\n typeof collection.upload.modifyResponseHeaders === 'function'\n ) {\n headers = collection.upload.modifyResponseHeaders({ headers }) || headers\n }\n\n if (etagFromHeaders && etagFromHeaders === obj.etag) {\n return new Response(null, {\n headers,\n status: 304,\n })\n }\n\n return new Response(obj.body, {\n headers,\n status: rangeResult.status,\n })\n } catch (_err: unknown) {\n return new Response('Internal Server Error', { status: 500 })\n }\n}\n"],"names":["buildStoragePathData","getFilePrefix","getDocPrefix","getRangeRequestInfo","isXmlMimeType","uploadContentSecurityPolicy","isMiniflare","process","env","NODE_ENV","getFile","bucket","collection","doc","filename","incomingHeaders","prefix","req","uploadReference","useCompositePrefixes","docPrefix","collectionPrefix","storageFilePath","headObj","head","Response","status","statusText","fileSize","size","rangeHeader","headers","get","rangeResult","type","Headers","obj","range","length","rangeEnd","rangeStart","offset","body","undefined","headerKey","value","Object","entries","append","metadata","httpMetadata","cacheControl","set","contentDisposition","contentEncoding","contentLanguage","contentType","writeHttpMetadata","etagFromHeaders","upload","modifyResponseHeaders","etag","_err"],"mappings":"AAEA,SACEA,oBAAoB,EACpBC,iBAAiBC,YAAY,QACxB,6CAA4C;AACnD,SAASC,mBAAmB,EAAEC,aAAa,EAAEC,2BAA2B,QAAQ,mBAAkB;AAgBlG,MAAMC,cAAcC,QAAQC,GAAG,CAACC,QAAQ,KAAK;AAE7C,OAAO,eAAeC,QAAQ,EAC5BC,MAAM,EACNC,UAAU,EACVC,GAAG,EACHC,QAAQ,EACRC,eAAe,EACfC,SAAS,EAAE,EACXC,GAAG,EACHC,eAAe,EACfC,uBAAuB,KAAK,EAChB;IACZ,IAAI;QACF,MAAMC,YAAY,MAAMlB,aAAa;YACnCU;YACAS,kBAAkBL;YAClBH;YACAC;YACAG;YACAC;YACAC;QACF;QAEA,MAAM,EAAEG,eAAe,EAAE,GAAGtB,qBAAqB;YAC/CqB,kBAAkBL;YAClBI;YACAN;YACAK;QACF;QAEA,qCAAqC;QACrC,MAAMI,UAAU,MAAMZ,QAAQa,KAAKF;QACnC,IAAI,CAACC,SAAS;YACZ,OAAO,IAAIE,SAAS,MAAM;gBAAEC,QAAQ;gBAAKC,YAAY;YAAY;QACnE;QAEA,MAAMC,WAAWL,QAAQM,IAAI;QAE7B,2FAA2F;QAC3F,IAAID,WAAW,KAAK,OAAO,QAAQV,iBAAiB;YAClD,OAAO,IAAIO,SAAS,MAAM;gBAAEC,QAAQ;YAAI;QAC1C;QAEA,uBAAuB;QACvB,MAAMI,cAAcb,IAAIc,OAAO,CAACC,GAAG,CAAC;QACpC,MAAMC,cAAc9B,oBAAoB;YAAEyB;YAAUE;QAAY;QAEhE,IAAIG,YAAYC,IAAI,KAAK,WAAW;YAClC,OAAO,IAAIT,SAAS,MAAM;gBACxBM,SAAS,IAAII,QAAQF,YAAYF,OAAO;gBACxCL,QAAQO,YAAYP,MAAM;YAC5B;QACF;QAEA,kCAAkC;QAClC,+DAA+D;QAC/D,iDAAiD;QACjD,MAAMU,MACJH,YAAYC,IAAI,KAAK,aAAa,CAAC5B,cAC/B,MAAMK,QAAQqB,IAAIV,iBAAiB;YACjCe,OAAO;gBACLC,QAAQL,YAAYM,QAAQ,GAAGN,YAAYO,UAAU,GAAG;gBACxDC,QAAQR,YAAYO,UAAU;YAChC;QACF,KACA,MAAM7B,QAAQqB,IAAIV;QAExB,IAAI,CAACc,OAAOA,IAAIM,IAAI,IAAIC,WAAW;YACjC,OAAO,IAAIlB,SAAS,MAAM;gBAAEC,QAAQ;gBAAKC,YAAY;YAAY;QACnE;QAEA,IAAII,UAAU,IAAII,QAAQpB;QAE1B,4CAA4C;QAC5C,KAAK,MAAM,CAAC6B,WAAWC,MAAM,IAAIC,OAAOC,OAAO,CAACd,YAAYF,OAAO,EAAG;YACpEA,QAAQiB,MAAM,CAACJ,WAAWC;QAC5B;QAEA,0BAA0B;QAC1B,IAAIvC,aAAa;YACf,wEAAwE;YACxE,MAAM2C,WAAWb,IAAIc,YAAY;YACjC,IAAID,UAAUE,cAAc;gBAC1BpB,QAAQqB,GAAG,CAAC,iBAAiBH,SAASE,YAAY;YACpD;YACA,IAAIF,UAAUI,oBAAoB;gBAChCtB,QAAQqB,GAAG,CAAC,uBAAuBH,SAASI,kBAAkB;YAChE;YACA,IAAIJ,UAAUK,iBAAiB;gBAC7BvB,QAAQqB,GAAG,CAAC,oBAAoBH,SAASK,eAAe;YAC1D;YACA,IAAIL,UAAUM,iBAAiB;gBAC7BxB,QAAQqB,GAAG,CAAC,oBAAoBH,SAASM,eAAe;YAC1D;YACA,IAAIN,UAAUO,aAAa;gBACzBzB,QAAQqB,GAAG,CAAC,gBAAgBH,SAASO,WAAW;YAClD;QACF,OAAO;YACLpB,IAAIqB,iBAAiB,CAAC1B;QACxB;QAEA,6EAA6E;QAC7E,MAAMyB,cAAczB,QAAQC,GAAG,CAAC;QAChC,IAAI5B,cAAcoD,cAAc;YAC9BzB,QAAQqB,GAAG,CAAC,2BAA2B/C;QACzC;QAEA,MAAMqD,kBAAkBzC,IAAIc,OAAO,CAACC,GAAG,CAAC,WAAWf,IAAIc,OAAO,CAACC,GAAG,CAAC;QAEnE,IACEpB,WAAW+C,MAAM,IACjB,OAAO/C,WAAW+C,MAAM,KAAK,YAC7B,OAAO/C,WAAW+C,MAAM,CAACC,qBAAqB,KAAK,YACnD;YACA7B,UAAUnB,WAAW+C,MAAM,CAACC,qBAAqB,CAAC;gBAAE7B;YAAQ,MAAMA;QACpE;QAEA,IAAI2B,mBAAmBA,oBAAoBtB,IAAIyB,IAAI,EAAE;YACnD,OAAO,IAAIpC,SAAS,MAAM;gBACxBM;gBACAL,QAAQ;YACV;QACF;QAEA,OAAO,IAAID,SAASW,IAAIM,IAAI,EAAE;YAC5BX;YACAL,QAAQO,YAAYP,MAAM;QAC5B;IACF,EAAE,OAAOoC,MAAe;QACtB,OAAO,IAAIrC,SAAS,yBAAyB;YAAEC,QAAQ;QAAI;IAC7D;AACF"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"handleMultiPartUpload.createOnly.spec.d.ts","sourceRoot":"","sources":["../src/handleMultiPartUpload.createOnly.spec.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
import { describe, expect, it, vi } from 'vitest';
|
|
2
|
+
import { getHandleMultiPartUpload } from './handleMultiPartUpload.js';
|
|
3
|
+
describe('getHandleMultiPartUpload', ()=>{
|
|
4
|
+
it('should reject multipart uploads when the object already exists', async ()=>{
|
|
5
|
+
const createMultipartUpload = vi.fn().mockResolvedValue({
|
|
6
|
+
key: 'reference.png',
|
|
7
|
+
uploadId: 'upload-id'
|
|
8
|
+
});
|
|
9
|
+
const bucket = {
|
|
10
|
+
createMultipartUpload,
|
|
11
|
+
head: vi.fn().mockResolvedValue({
|
|
12
|
+
key: 'reference.png'
|
|
13
|
+
})
|
|
14
|
+
};
|
|
15
|
+
const req = {
|
|
16
|
+
payload: {
|
|
17
|
+
collections: {
|
|
18
|
+
media: {
|
|
19
|
+
config: {
|
|
20
|
+
access: {},
|
|
21
|
+
upload: true
|
|
22
|
+
}
|
|
23
|
+
}
|
|
24
|
+
},
|
|
25
|
+
db: {
|
|
26
|
+
findOne: vi.fn().mockResolvedValue(null)
|
|
27
|
+
}
|
|
28
|
+
},
|
|
29
|
+
searchParams: new URLSearchParams({
|
|
30
|
+
collection: 'media',
|
|
31
|
+
fileName: 'reference.png',
|
|
32
|
+
fileType: 'image/png'
|
|
33
|
+
}),
|
|
34
|
+
user: {
|
|
35
|
+
id: 'user'
|
|
36
|
+
}
|
|
37
|
+
};
|
|
38
|
+
const handler = getHandleMultiPartUpload({
|
|
39
|
+
access: async ()=>true,
|
|
40
|
+
bucket,
|
|
41
|
+
collections: {
|
|
42
|
+
media: true
|
|
43
|
+
}
|
|
44
|
+
});
|
|
45
|
+
const response = await handler(req);
|
|
46
|
+
expect(response.status).toBe(412);
|
|
47
|
+
expect(createMultipartUpload).not.toHaveBeenCalled();
|
|
48
|
+
});
|
|
49
|
+
});
|
|
50
|
+
|
|
51
|
+
//# sourceMappingURL=handleMultiPartUpload.createOnly.spec.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/handleMultiPartUpload.createOnly.spec.ts"],"sourcesContent":["import type { PayloadRequest } from 'payload'\n\nimport { describe, expect, it, vi } from 'vitest'\n\nimport type { R2Bucket } from './types.js'\n\nimport { getHandleMultiPartUpload } from './handleMultiPartUpload.js'\n\ndescribe('getHandleMultiPartUpload', () => {\n it('should reject multipart uploads when the object already exists', async () => {\n const createMultipartUpload = vi.fn().mockResolvedValue({\n key: 'reference.png',\n uploadId: 'upload-id',\n })\n const bucket = {\n createMultipartUpload,\n head: vi.fn().mockResolvedValue({ key: 'reference.png' }),\n } as unknown as R2Bucket\n const req = {\n payload: {\n collections: {\n media: { config: { access: {}, upload: true } },\n },\n db: { findOne: vi.fn().mockResolvedValue(null) },\n },\n searchParams: new URLSearchParams({\n collection: 'media',\n fileName: 'reference.png',\n fileType: 'image/png',\n }),\n user: { id: 'user' },\n } as unknown as PayloadRequest\n const handler = getHandleMultiPartUpload({\n access: async () => true,\n bucket,\n collections: { media: true },\n })\n\n const response = await handler(req)\n\n expect(response.status).toBe(412)\n expect(createMultipartUpload).not.toHaveBeenCalled()\n })\n})\n"],"names":["describe","expect","it","vi","getHandleMultiPartUpload","createMultipartUpload","fn","mockResolvedValue","key","uploadId","bucket","head","req","payload","collections","media","config","access","upload","db","findOne","searchParams","URLSearchParams","collection","fileName","fileType","user","id","handler","response","status","toBe","not","toHaveBeenCalled"],"mappings":"AAEA,SAASA,QAAQ,EAAEC,MAAM,EAAEC,EAAE,EAAEC,EAAE,QAAQ,SAAQ;AAIjD,SAASC,wBAAwB,QAAQ,6BAA4B;AAErEJ,SAAS,4BAA4B;IACnCE,GAAG,kEAAkE;QACnE,MAAMG,wBAAwBF,GAAGG,EAAE,GAAGC,iBAAiB,CAAC;YACtDC,KAAK;YACLC,UAAU;QACZ;QACA,MAAMC,SAAS;YACbL;YACAM,MAAMR,GAAGG,EAAE,GAAGC,iBAAiB,CAAC;gBAAEC,KAAK;YAAgB;QACzD;QACA,MAAMI,MAAM;YACVC,SAAS;gBACPC,aAAa;oBACXC,OAAO;wBAAEC,QAAQ;4BAAEC,QAAQ,CAAC;4BAAGC,QAAQ;wBAAK;oBAAE;gBAChD;gBACAC,IAAI;oBAAEC,SAASjB,GAAGG,EAAE,GAAGC,iBAAiB,CAAC;gBAAM;YACjD;YACAc,cAAc,IAAIC,gBAAgB;gBAChCC,YAAY;gBACZC,UAAU;gBACVC,UAAU;YACZ;YACAC,MAAM;gBAAEC,IAAI;YAAO;QACrB;QACA,MAAMC,UAAUxB,yBAAyB;YACvCa,QAAQ,UAAY;YACpBP;YACAI,aAAa;gBAAEC,OAAO;YAAK;QAC7B;QAEA,MAAMc,WAAW,MAAMD,QAAQhB;QAE/BX,OAAO4B,SAASC,MAAM,EAAEC,IAAI,CAAC;QAC7B9B,OAAOI,uBAAuB2B,GAAG,CAACC,gBAAgB;IACpD;AACF"}
|
|
@@ -7,7 +7,6 @@ type Args = {
|
|
|
7
7
|
collections: R2StorageOptions['collections'];
|
|
8
8
|
useCompositePrefixes?: boolean;
|
|
9
9
|
};
|
|
10
|
-
export declare const
|
|
11
|
-
export declare const getHandleMultiPartUpload: ({ access, bucket, collections, useCompositePrefixes, }: Args) => PayloadHandler;
|
|
10
|
+
export declare const getHandleMultiPartUpload: ({ access, bucket, collections, useCompositePrefixes }: Args) => PayloadHandler;
|
|
12
11
|
export {};
|
|
13
12
|
//# sourceMappingURL=handleMultiPartUpload.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"handleMultiPartUpload.d.ts","sourceRoot":"","sources":["../src/handleMultiPartUpload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAA;
|
|
1
|
+
{"version":3,"file":"handleMultiPartUpload.d.ts","sourceRoot":"","sources":["../src/handleMultiPartUpload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAA;AAUvE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAA;AAClD,OAAO,KAAK,EAAE,QAAQ,EAAyD,MAAM,YAAY,CAAA;AAEjG,KAAK,IAAI,GAAG;IACV,MAAM,CAAC,EAAE,wBAAwB,CAAA;IACjC,MAAM,EAAE,QAAQ,CAAA;IAChB,WAAW,EAAE,gBAAgB,CAAC,aAAa,CAAC,CAAA;IAC5C,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B,CAAA;AAGD,eAAO,MAAM,wBAAwB,0DAC6B,IAAI,KAAG,cAkFtE,CAAA"}
|
|
@@ -1,44 +1,45 @@
|
|
|
1
1
|
import { resolveSignedURLKey } from '@payloadcms/plugin-cloud-storage/utilities';
|
|
2
2
|
import { APIError, Forbidden } from 'payload';
|
|
3
|
-
|
|
4
|
-
const collection = req.payload.collections[collectionSlug];
|
|
5
|
-
if (!collection?.config) {
|
|
6
|
-
throw new APIError(`Collection ${collectionSlug} not found`);
|
|
7
|
-
}
|
|
8
|
-
const createAccess = collection.config.access?.create;
|
|
9
|
-
return createAccess ? Boolean(await createAccess({
|
|
10
|
-
slug: collectionSlug,
|
|
11
|
-
req
|
|
12
|
-
})) : Boolean(req.user);
|
|
13
|
-
};
|
|
3
|
+
import { assertClientUploadAccess, assertClientUploadAllowed, verifyClientUploadReceipt } from 'payload/internal';
|
|
14
4
|
// Adapted from https://developers.cloudflare.com/r2/api/workers/workers-multipart-usage/
|
|
15
|
-
export const getHandleMultiPartUpload = ({ access
|
|
5
|
+
export const getHandleMultiPartUpload = ({ access, bucket, collections, useCompositePrefixes = false })=>async (req)=>{
|
|
16
6
|
const params = Object.fromEntries(req.searchParams);
|
|
17
7
|
const collectionSlug = params.collection;
|
|
18
8
|
const filetype = params.fileType;
|
|
9
|
+
await assertClientUploadAccess({
|
|
10
|
+
collectionSlug,
|
|
11
|
+
req
|
|
12
|
+
});
|
|
19
13
|
const collectionConfig = collections[collectionSlug];
|
|
20
14
|
if (!collectionConfig) {
|
|
21
15
|
throw new APIError(`Collection ${collectionSlug} was not found in R2 Storage options`);
|
|
22
16
|
}
|
|
23
|
-
if (!await access({
|
|
17
|
+
if (access && !await access({
|
|
24
18
|
collectionSlug,
|
|
25
19
|
req
|
|
26
20
|
})) {
|
|
27
21
|
throw new Forbidden(req.t);
|
|
28
22
|
}
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
collectionPrefix,
|
|
32
|
-
collectionSlug,
|
|
33
|
-
docPrefix: params.docPrefix ?? undefined,
|
|
23
|
+
assertClientUploadAllowed({
|
|
24
|
+
collection: req.payload.collections[collectionSlug]?.config,
|
|
34
25
|
filename: params.fileName,
|
|
35
|
-
|
|
36
|
-
useCompositePrefixes
|
|
26
|
+
mimeType: filetype
|
|
37
27
|
});
|
|
38
28
|
const multipartId = params.multipartId;
|
|
39
29
|
const multipartKey = params.multipartKey;
|
|
40
30
|
const multipartNumber = parseInt(params.multipartNumber || '');
|
|
31
|
+
const collectionPrefix = typeof collectionConfig === 'object' && collectionConfig.prefix || '';
|
|
41
32
|
if (multipartId && multipartKey) {
|
|
33
|
+
const receipt = verifyClientUploadReceipt({
|
|
34
|
+
collectionSlug,
|
|
35
|
+
req,
|
|
36
|
+
signedReceipt: params.signedReceipt
|
|
37
|
+
});
|
|
38
|
+
// The receipt binds the full storage key (including the per-upload _objectKey segment), so
|
|
39
|
+
// compare against it directly rather than recomputing from prefix + filename.
|
|
40
|
+
if (receipt.storageFilePath !== multipartKey) {
|
|
41
|
+
throw new APIError('Invalid upload reference.', 400);
|
|
42
|
+
}
|
|
42
43
|
const multipartUpload = bucket.resumeMultipartUpload(multipartKey, multipartId);
|
|
43
44
|
const request = req;
|
|
44
45
|
if (isNaN(multipartNumber)) {
|
|
@@ -53,8 +54,22 @@ export const getHandleMultiPartUpload = ({ access = defaultR2ClientUploadsAccess
|
|
|
53
54
|
return Response.json(uploadedPart);
|
|
54
55
|
}
|
|
55
56
|
} else {
|
|
57
|
+
const { sanitizedFilename, storageFilePath, uploadReference } = await resolveSignedURLKey({
|
|
58
|
+
collectionPrefix,
|
|
59
|
+
collectionSlug,
|
|
60
|
+
docPrefix: params.docPrefix ?? undefined,
|
|
61
|
+
filename: params.fileName,
|
|
62
|
+
req,
|
|
63
|
+
useCompositePrefixes
|
|
64
|
+
});
|
|
65
|
+
const existing = await bucket.head(storageFilePath);
|
|
66
|
+
if (existing) {
|
|
67
|
+
return new Response('Object already exists', {
|
|
68
|
+
status: 412
|
|
69
|
+
});
|
|
70
|
+
}
|
|
56
71
|
// Create multipart upload
|
|
57
|
-
const multipartUpload = await bucket.createMultipartUpload(
|
|
72
|
+
const multipartUpload = await bucket.createMultipartUpload(storageFilePath, {
|
|
58
73
|
httpMetadata: {
|
|
59
74
|
contentType: filetype
|
|
60
75
|
}
|
|
@@ -62,7 +77,8 @@ export const getHandleMultiPartUpload = ({ access = defaultR2ClientUploadsAccess
|
|
|
62
77
|
return Response.json({
|
|
63
78
|
filename: sanitizedFilename,
|
|
64
79
|
key: multipartUpload.key,
|
|
65
|
-
uploadId: multipartUpload.uploadId
|
|
80
|
+
uploadId: multipartUpload.uploadId,
|
|
81
|
+
uploadReference
|
|
66
82
|
});
|
|
67
83
|
}
|
|
68
84
|
};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/handleMultiPartUpload.ts"],"sourcesContent":["import type { PayloadHandler, UploadInstructionsAccess } from 'payload'\n\nimport { resolveSignedURLKey } from '@payloadcms/plugin-cloud-storage/utilities'\nimport { APIError, Forbidden } from 'payload'\n\nimport type { R2StorageOptions } from './index.js'\nimport type { R2Bucket, R2StorageMultipartUploadHandlerParams } from './types.js'\n\ntype Args = {\n access?: UploadInstructionsAccess\n bucket: R2Bucket\n collections: R2StorageOptions['collections']\n useCompositePrefixes?: boolean\n}\n\
|
|
1
|
+
{"version":3,"sources":["../src/handleMultiPartUpload.ts"],"sourcesContent":["import type { PayloadHandler, UploadInstructionsAccess } from 'payload'\n\nimport { resolveSignedURLKey } from '@payloadcms/plugin-cloud-storage/utilities'\nimport { APIError, Forbidden } from 'payload'\nimport {\n assertClientUploadAccess,\n assertClientUploadAllowed,\n verifyClientUploadReceipt,\n} from 'payload/internal'\n\nimport type { R2StorageOptions } from './index.js'\nimport type { R2Bucket, R2StorageMultipartUploadHandlerParams, R2UploadedPart } from './types.js'\n\ntype Args = {\n access?: UploadInstructionsAccess\n bucket: R2Bucket\n collections: R2StorageOptions['collections']\n useCompositePrefixes?: boolean\n}\n\n// Adapted from https://developers.cloudflare.com/r2/api/workers/workers-multipart-usage/\nexport const getHandleMultiPartUpload =\n ({ access, bucket, collections, useCompositePrefixes = false }: Args): PayloadHandler =>\n async (req) => {\n const params = Object.fromEntries(req.searchParams) as R2StorageMultipartUploadHandlerParams\n const collectionSlug = params.collection\n const filetype = params.fileType\n\n await assertClientUploadAccess({ collectionSlug, req })\n\n const collectionConfig = collections[collectionSlug]\n if (!collectionConfig) {\n throw new APIError(`Collection ${collectionSlug} was not found in R2 Storage options`)\n }\n\n if (access && !(await access({ collectionSlug, req }))) {\n throw new Forbidden(req.t)\n }\n\n assertClientUploadAllowed({\n collection: req.payload.collections[collectionSlug]?.config,\n filename: params.fileName,\n mimeType: filetype,\n })\n\n const multipartId = params.multipartId\n const multipartKey = params.multipartKey\n const multipartNumber = parseInt(params.multipartNumber || '')\n const collectionPrefix = (typeof collectionConfig === 'object' && collectionConfig.prefix) || ''\n\n if (multipartId && multipartKey) {\n const receipt = verifyClientUploadReceipt({\n collectionSlug,\n req,\n signedReceipt: params.signedReceipt,\n })\n // The receipt binds the full storage key (including the per-upload _objectKey segment), so\n // compare against it directly rather than recomputing from prefix + filename.\n if (receipt.storageFilePath !== multipartKey) {\n throw new APIError('Invalid upload reference.', 400)\n }\n const multipartUpload = bucket.resumeMultipartUpload(multipartKey, multipartId)\n const request = req as Request\n\n if (isNaN(multipartNumber)) {\n // Upload complete\n const object = await multipartUpload.complete((await request.json()) as R2UploadedPart[])\n return new Response(object.key, { status: 200 })\n } else {\n // Upload part\n const uploadedPart = await multipartUpload.uploadPart(\n multipartNumber,\n await request.arrayBuffer(),\n )\n return Response.json(uploadedPart)\n }\n } else {\n const { sanitizedFilename, storageFilePath, uploadReference } = await resolveSignedURLKey({\n collectionPrefix,\n collectionSlug,\n docPrefix: params.docPrefix ?? undefined,\n filename: params.fileName,\n req,\n useCompositePrefixes,\n })\n const existing = await bucket.head(storageFilePath)\n if (existing) {\n return new Response('Object already exists', { status: 412 })\n }\n\n // Create multipart upload\n const multipartUpload = await bucket.createMultipartUpload(storageFilePath, {\n httpMetadata: {\n contentType: filetype,\n },\n })\n\n return Response.json({\n filename: sanitizedFilename,\n key: multipartUpload.key,\n uploadId: multipartUpload.uploadId,\n uploadReference,\n })\n }\n }\n"],"names":["resolveSignedURLKey","APIError","Forbidden","assertClientUploadAccess","assertClientUploadAllowed","verifyClientUploadReceipt","getHandleMultiPartUpload","access","bucket","collections","useCompositePrefixes","req","params","Object","fromEntries","searchParams","collectionSlug","collection","filetype","fileType","collectionConfig","t","payload","config","filename","fileName","mimeType","multipartId","multipartKey","multipartNumber","parseInt","collectionPrefix","prefix","receipt","signedReceipt","storageFilePath","multipartUpload","resumeMultipartUpload","request","isNaN","object","complete","json","Response","key","status","uploadedPart","uploadPart","arrayBuffer","sanitizedFilename","uploadReference","docPrefix","undefined","existing","head","createMultipartUpload","httpMetadata","contentType","uploadId"],"mappings":"AAEA,SAASA,mBAAmB,QAAQ,6CAA4C;AAChF,SAASC,QAAQ,EAAEC,SAAS,QAAQ,UAAS;AAC7C,SACEC,wBAAwB,EACxBC,yBAAyB,EACzBC,yBAAyB,QACpB,mBAAkB;AAYzB,yFAAyF;AACzF,OAAO,MAAMC,2BACX,CAAC,EAAEC,MAAM,EAAEC,MAAM,EAAEC,WAAW,EAAEC,uBAAuB,KAAK,EAAQ,GACpE,OAAOC;QACL,MAAMC,SAASC,OAAOC,WAAW,CAACH,IAAII,YAAY;QAClD,MAAMC,iBAAiBJ,OAAOK,UAAU;QACxC,MAAMC,WAAWN,OAAOO,QAAQ;QAEhC,MAAMhB,yBAAyB;YAAEa;YAAgBL;QAAI;QAErD,MAAMS,mBAAmBX,WAAW,CAACO,eAAe;QACpD,IAAI,CAACI,kBAAkB;YACrB,MAAM,IAAInB,SAAS,CAAC,WAAW,EAAEe,eAAe,oCAAoC,CAAC;QACvF;QAEA,IAAIT,UAAU,CAAE,MAAMA,OAAO;YAAES;YAAgBL;QAAI,IAAK;YACtD,MAAM,IAAIT,UAAUS,IAAIU,CAAC;QAC3B;QAEAjB,0BAA0B;YACxBa,YAAYN,IAAIW,OAAO,CAACb,WAAW,CAACO,eAAe,EAAEO;YACrDC,UAAUZ,OAAOa,QAAQ;YACzBC,UAAUR;QACZ;QAEA,MAAMS,cAAcf,OAAOe,WAAW;QACtC,MAAMC,eAAehB,OAAOgB,YAAY;QACxC,MAAMC,kBAAkBC,SAASlB,OAAOiB,eAAe,IAAI;QAC3D,MAAME,mBAAmB,AAAC,OAAOX,qBAAqB,YAAYA,iBAAiBY,MAAM,IAAK;QAE9F,IAAIL,eAAeC,cAAc;YAC/B,MAAMK,UAAU5B,0BAA0B;gBACxCW;gBACAL;gBACAuB,eAAetB,OAAOsB,aAAa;YACrC;YACA,2FAA2F;YAC3F,8EAA8E;YAC9E,IAAID,QAAQE,eAAe,KAAKP,cAAc;gBAC5C,MAAM,IAAI3B,SAAS,6BAA6B;YAClD;YACA,MAAMmC,kBAAkB5B,OAAO6B,qBAAqB,CAACT,cAAcD;YACnE,MAAMW,UAAU3B;YAEhB,IAAI4B,MAAMV,kBAAkB;gBAC1B,kBAAkB;gBAClB,MAAMW,SAAS,MAAMJ,gBAAgBK,QAAQ,CAAE,MAAMH,QAAQI,IAAI;gBACjE,OAAO,IAAIC,SAASH,OAAOI,GAAG,EAAE;oBAAEC,QAAQ;gBAAI;YAChD,OAAO;gBACL,cAAc;gBACd,MAAMC,eAAe,MAAMV,gBAAgBW,UAAU,CACnDlB,iBACA,MAAMS,QAAQU,WAAW;gBAE3B,OAAOL,SAASD,IAAI,CAACI;YACvB;QACF,OAAO;YACL,MAAM,EAAEG,iBAAiB,EAAEd,eAAe,EAAEe,eAAe,EAAE,GAAG,MAAMlD,oBAAoB;gBACxF+B;gBACAf;gBACAmC,WAAWvC,OAAOuC,SAAS,IAAIC;gBAC/B5B,UAAUZ,OAAOa,QAAQ;gBACzBd;gBACAD;YACF;YACA,MAAM2C,WAAW,MAAM7C,OAAO8C,IAAI,CAACnB;YACnC,IAAIkB,UAAU;gBACZ,OAAO,IAAIV,SAAS,yBAAyB;oBAAEE,QAAQ;gBAAI;YAC7D;YAEA,0BAA0B;YAC1B,MAAMT,kBAAkB,MAAM5B,OAAO+C,qBAAqB,CAACpB,iBAAiB;gBAC1EqB,cAAc;oBACZC,aAAavC;gBACf;YACF;YAEA,OAAOyB,SAASD,IAAI,CAAC;gBACnBlB,UAAUyB;gBACVL,KAAKR,gBAAgBQ,GAAG;gBACxBc,UAAUtB,gBAAgBsB,QAAQ;gBAClCR;YACF;QACF;IACF,EAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"handleMultiPartUpload.spec.d.ts","sourceRoot":"","sources":["../src/handleMultiPartUpload.spec.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,177 @@
|
|
|
1
|
+
import { createClientUploadReceipt } from 'payload/internal';
|
|
2
|
+
import { describe, expect, it, vi } from 'vitest';
|
|
3
|
+
import { getHandleMultiPartUpload } from './handleMultiPartUpload.js';
|
|
4
|
+
const createRequest = (filename, mimeType)=>({
|
|
5
|
+
payload: {
|
|
6
|
+
collections: {
|
|
7
|
+
media: {
|
|
8
|
+
config: {
|
|
9
|
+
slug: 'media',
|
|
10
|
+
access: {},
|
|
11
|
+
upload: {
|
|
12
|
+
staticDir: '/tmp'
|
|
13
|
+
}
|
|
14
|
+
}
|
|
15
|
+
}
|
|
16
|
+
}
|
|
17
|
+
},
|
|
18
|
+
searchParams: new URLSearchParams({
|
|
19
|
+
collection: 'media',
|
|
20
|
+
fileName: filename,
|
|
21
|
+
fileType: mimeType
|
|
22
|
+
}),
|
|
23
|
+
user: {
|
|
24
|
+
id: 'user'
|
|
25
|
+
}
|
|
26
|
+
});
|
|
27
|
+
const createContinuationRequest = ({ multipartKey })=>{
|
|
28
|
+
const req = {
|
|
29
|
+
arrayBuffer: vi.fn().mockResolvedValue(new ArrayBuffer(0)),
|
|
30
|
+
user: {
|
|
31
|
+
id: 'user'
|
|
32
|
+
},
|
|
33
|
+
payload: {
|
|
34
|
+
collections: {
|
|
35
|
+
media: {
|
|
36
|
+
config: {
|
|
37
|
+
slug: 'media',
|
|
38
|
+
access: {},
|
|
39
|
+
upload: {
|
|
40
|
+
staticDir: '/tmp'
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
},
|
|
45
|
+
secret: 'test-secret'
|
|
46
|
+
}
|
|
47
|
+
};
|
|
48
|
+
const signedReceipt = createClientUploadReceipt({
|
|
49
|
+
collectionSlug: 'media',
|
|
50
|
+
filePrefix: 'media/documents',
|
|
51
|
+
filename: 'photo.png',
|
|
52
|
+
req,
|
|
53
|
+
storageFilePath: 'media/documents/photo.png'
|
|
54
|
+
});
|
|
55
|
+
req.searchParams = new URLSearchParams({
|
|
56
|
+
collection: 'media',
|
|
57
|
+
fileName: 'photo.png',
|
|
58
|
+
fileType: 'image/png',
|
|
59
|
+
multipartId: 'upload-id',
|
|
60
|
+
multipartKey,
|
|
61
|
+
multipartNumber: '1',
|
|
62
|
+
signedReceipt
|
|
63
|
+
});
|
|
64
|
+
return req;
|
|
65
|
+
};
|
|
66
|
+
describe('getHandleMultiPartUpload', ()=>{
|
|
67
|
+
it.each([
|
|
68
|
+
[
|
|
69
|
+
'reference.svg',
|
|
70
|
+
'image/svg+xml'
|
|
71
|
+
],
|
|
72
|
+
[
|
|
73
|
+
'reference.xml',
|
|
74
|
+
'application/xml'
|
|
75
|
+
]
|
|
76
|
+
])('should keep %s with %s in document uploads', async (filename, mimeType)=>{
|
|
77
|
+
const createMultipartUpload = vi.fn();
|
|
78
|
+
const handler = getHandleMultiPartUpload({
|
|
79
|
+
access: ()=>true,
|
|
80
|
+
bucket: {
|
|
81
|
+
createMultipartUpload
|
|
82
|
+
},
|
|
83
|
+
collections: {
|
|
84
|
+
media: {}
|
|
85
|
+
}
|
|
86
|
+
});
|
|
87
|
+
await expect(handler(createRequest(filename, mimeType))).rejects.toMatchObject({
|
|
88
|
+
status: 400
|
|
89
|
+
});
|
|
90
|
+
expect(createMultipartUpload).not.toHaveBeenCalled();
|
|
91
|
+
});
|
|
92
|
+
describe('continuation', ()=>{
|
|
93
|
+
const createHandler = ()=>{
|
|
94
|
+
const resumeMultipartUpload = vi.fn(()=>({
|
|
95
|
+
uploadPart: vi.fn().mockResolvedValue({
|
|
96
|
+
etag: 'etag',
|
|
97
|
+
partNumber: 1
|
|
98
|
+
})
|
|
99
|
+
}));
|
|
100
|
+
return {
|
|
101
|
+
handler: getHandleMultiPartUpload({
|
|
102
|
+
access: ()=>true,
|
|
103
|
+
bucket: {
|
|
104
|
+
resumeMultipartUpload
|
|
105
|
+
},
|
|
106
|
+
collections: {
|
|
107
|
+
media: {
|
|
108
|
+
prefix: 'media'
|
|
109
|
+
}
|
|
110
|
+
}
|
|
111
|
+
}),
|
|
112
|
+
resumeMultipartUpload
|
|
113
|
+
};
|
|
114
|
+
};
|
|
115
|
+
it('should reject a continuation key outside the receipt', async ()=>{
|
|
116
|
+
const { handler, resumeMultipartUpload } = createHandler();
|
|
117
|
+
await expect(handler(createContinuationRequest({
|
|
118
|
+
multipartKey: 'media-archive/photo.png'
|
|
119
|
+
}))).rejects.toMatchObject({
|
|
120
|
+
status: 400
|
|
121
|
+
});
|
|
122
|
+
expect(resumeMultipartUpload).not.toHaveBeenCalled();
|
|
123
|
+
});
|
|
124
|
+
it('should resume the upload issued by the receipt', async ()=>{
|
|
125
|
+
const { handler, resumeMultipartUpload } = createHandler();
|
|
126
|
+
const response = await handler(createContinuationRequest({
|
|
127
|
+
multipartKey: 'media/documents/photo.png'
|
|
128
|
+
}));
|
|
129
|
+
expect(response.status).toBe(200);
|
|
130
|
+
expect(resumeMultipartUpload).toHaveBeenCalledWith('media/documents/photo.png', 'upload-id');
|
|
131
|
+
});
|
|
132
|
+
});
|
|
133
|
+
it('rejects multipart uploads when the object already exists', async ()=>{
|
|
134
|
+
const createMultipartUpload = vi.fn();
|
|
135
|
+
const bucket = {
|
|
136
|
+
createMultipartUpload,
|
|
137
|
+
head: vi.fn().mockResolvedValue({
|
|
138
|
+
key: 'protected.png'
|
|
139
|
+
})
|
|
140
|
+
};
|
|
141
|
+
const req = {
|
|
142
|
+
payload: {
|
|
143
|
+
collections: {
|
|
144
|
+
media: {
|
|
145
|
+
config: {
|
|
146
|
+
access: {},
|
|
147
|
+
upload: true
|
|
148
|
+
}
|
|
149
|
+
}
|
|
150
|
+
},
|
|
151
|
+
db: {
|
|
152
|
+
findOne: vi.fn().mockResolvedValue(null)
|
|
153
|
+
}
|
|
154
|
+
},
|
|
155
|
+
searchParams: new URLSearchParams({
|
|
156
|
+
collection: 'media',
|
|
157
|
+
fileName: 'protected.png',
|
|
158
|
+
fileType: 'image/png'
|
|
159
|
+
}),
|
|
160
|
+
user: {
|
|
161
|
+
id: 'user'
|
|
162
|
+
}
|
|
163
|
+
};
|
|
164
|
+
const handler = getHandleMultiPartUpload({
|
|
165
|
+
access: async ()=>true,
|
|
166
|
+
bucket,
|
|
167
|
+
collections: {
|
|
168
|
+
media: true
|
|
169
|
+
}
|
|
170
|
+
});
|
|
171
|
+
const response = await handler(req);
|
|
172
|
+
expect(response.status).toBe(412);
|
|
173
|
+
expect(createMultipartUpload).not.toHaveBeenCalled();
|
|
174
|
+
});
|
|
175
|
+
});
|
|
176
|
+
|
|
177
|
+
//# sourceMappingURL=handleMultiPartUpload.spec.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/handleMultiPartUpload.spec.ts"],"sourcesContent":["import type { PayloadRequest } from 'payload'\n\nimport { createClientUploadReceipt } from 'payload/internal'\nimport { describe, expect, it, vi } from 'vitest'\n\nimport type { R2Bucket } from './types.js'\n\nimport { getHandleMultiPartUpload } from './handleMultiPartUpload.js'\n\nconst createRequest = (filename: string, mimeType: string) =>\n ({\n payload: {\n collections: {\n media: {\n config: {\n slug: 'media',\n access: {},\n upload: { staticDir: '/tmp' },\n },\n },\n },\n },\n searchParams: new URLSearchParams({\n collection: 'media',\n fileName: filename,\n fileType: mimeType,\n }),\n user: { id: 'user' },\n }) as unknown as PayloadRequest\n\nconst createContinuationRequest = ({ multipartKey }: { multipartKey: string }) => {\n const req = {\n arrayBuffer: vi.fn().mockResolvedValue(new ArrayBuffer(0)),\n user: { id: 'user' },\n payload: {\n collections: {\n media: { config: { slug: 'media', access: {}, upload: { staticDir: '/tmp' } } },\n },\n secret: 'test-secret',\n },\n } as unknown as PayloadRequest\n\n const signedReceipt = createClientUploadReceipt({\n collectionSlug: 'media',\n filePrefix: 'media/documents',\n filename: 'photo.png',\n req,\n storageFilePath: 'media/documents/photo.png',\n })\n\n ;(req as { searchParams?: URLSearchParams }).searchParams = new URLSearchParams({\n collection: 'media',\n fileName: 'photo.png',\n fileType: 'image/png',\n multipartId: 'upload-id',\n multipartKey,\n multipartNumber: '1',\n signedReceipt,\n })\n\n return req\n}\n\ndescribe('getHandleMultiPartUpload', () => {\n it.each([\n ['reference.svg', 'image/svg+xml'],\n ['reference.xml', 'application/xml'],\n ])('should keep %s with %s in document uploads', async (filename, mimeType) => {\n const createMultipartUpload = vi.fn()\n const handler = getHandleMultiPartUpload({\n access: () => true,\n bucket: { createMultipartUpload } as unknown as R2Bucket,\n collections: { media: {} },\n })\n\n await expect(handler(createRequest(filename, mimeType))).rejects.toMatchObject({\n status: 400,\n })\n expect(createMultipartUpload).not.toHaveBeenCalled()\n })\n\n describe('continuation', () => {\n const createHandler = () => {\n const resumeMultipartUpload = vi.fn(() => ({\n uploadPart: vi.fn().mockResolvedValue({ etag: 'etag', partNumber: 1 }),\n }))\n\n return {\n handler: getHandleMultiPartUpload({\n access: () => true,\n bucket: { resumeMultipartUpload } as unknown as R2Bucket,\n collections: { media: { prefix: 'media' } },\n }),\n resumeMultipartUpload,\n }\n }\n\n it('should reject a continuation key outside the receipt', async () => {\n const { handler, resumeMultipartUpload } = createHandler()\n\n await expect(\n handler(\n createContinuationRequest({\n multipartKey: 'media-archive/photo.png',\n }),\n ),\n ).rejects.toMatchObject({ status: 400 })\n expect(resumeMultipartUpload).not.toHaveBeenCalled()\n })\n\n it('should resume the upload issued by the receipt', async () => {\n const { handler, resumeMultipartUpload } = createHandler()\n\n const response = await handler(\n createContinuationRequest({\n multipartKey: 'media/documents/photo.png',\n }),\n )\n\n expect(response.status).toBe(200)\n expect(resumeMultipartUpload).toHaveBeenCalledWith('media/documents/photo.png', 'upload-id')\n })\n })\n\n it('rejects multipart uploads when the object already exists', async () => {\n const createMultipartUpload = vi.fn()\n const bucket = {\n createMultipartUpload,\n head: vi.fn().mockResolvedValue({ key: 'protected.png' }),\n } as unknown as R2Bucket\n const req = {\n payload: {\n collections: {\n media: { config: { access: {}, upload: true } },\n },\n db: { findOne: vi.fn().mockResolvedValue(null) },\n },\n searchParams: new URLSearchParams({\n collection: 'media',\n fileName: 'protected.png',\n fileType: 'image/png',\n }),\n user: { id: 'user' },\n } as unknown as PayloadRequest\n const handler = getHandleMultiPartUpload({\n access: async () => true,\n bucket,\n collections: { media: true },\n })\n\n const response = await handler(req)\n\n expect(response.status).toBe(412)\n expect(createMultipartUpload).not.toHaveBeenCalled()\n })\n})\n"],"names":["createClientUploadReceipt","describe","expect","it","vi","getHandleMultiPartUpload","createRequest","filename","mimeType","payload","collections","media","config","slug","access","upload","staticDir","searchParams","URLSearchParams","collection","fileName","fileType","user","id","createContinuationRequest","multipartKey","req","arrayBuffer","fn","mockResolvedValue","ArrayBuffer","secret","signedReceipt","collectionSlug","filePrefix","storageFilePath","multipartId","multipartNumber","each","createMultipartUpload","handler","bucket","rejects","toMatchObject","status","not","toHaveBeenCalled","createHandler","resumeMultipartUpload","uploadPart","etag","partNumber","prefix","response","toBe","toHaveBeenCalledWith","head","key","db","findOne"],"mappings":"AAEA,SAASA,yBAAyB,QAAQ,mBAAkB;AAC5D,SAASC,QAAQ,EAAEC,MAAM,EAAEC,EAAE,EAAEC,EAAE,QAAQ,SAAQ;AAIjD,SAASC,wBAAwB,QAAQ,6BAA4B;AAErE,MAAMC,gBAAgB,CAACC,UAAkBC,WACtC,CAAA;QACCC,SAAS;YACPC,aAAa;gBACXC,OAAO;oBACLC,QAAQ;wBACNC,MAAM;wBACNC,QAAQ,CAAC;wBACTC,QAAQ;4BAAEC,WAAW;wBAAO;oBAC9B;gBACF;YACF;QACF;QACAC,cAAc,IAAIC,gBAAgB;YAChCC,YAAY;YACZC,UAAUb;YACVc,UAAUb;QACZ;QACAc,MAAM;YAAEC,IAAI;QAAO;IACrB,CAAA;AAEF,MAAMC,4BAA4B,CAAC,EAAEC,YAAY,EAA4B;IAC3E,MAAMC,MAAM;QACVC,aAAavB,GAAGwB,EAAE,GAAGC,iBAAiB,CAAC,IAAIC,YAAY;QACvDR,MAAM;YAAEC,IAAI;QAAO;QACnBd,SAAS;YACPC,aAAa;gBACXC,OAAO;oBAAEC,QAAQ;wBAAEC,MAAM;wBAASC,QAAQ,CAAC;wBAAGC,QAAQ;4BAAEC,WAAW;wBAAO;oBAAE;gBAAE;YAChF;YACAe,QAAQ;QACV;IACF;IAEA,MAAMC,gBAAgBhC,0BAA0B;QAC9CiC,gBAAgB;QAChBC,YAAY;QACZ3B,UAAU;QACVmB;QACAS,iBAAiB;IACnB;IAEET,IAA2CT,YAAY,GAAG,IAAIC,gBAAgB;QAC9EC,YAAY;QACZC,UAAU;QACVC,UAAU;QACVe,aAAa;QACbX;QACAY,iBAAiB;QACjBL;IACF;IAEA,OAAON;AACT;AAEAzB,SAAS,4BAA4B;IACnCE,GAAGmC,IAAI,CAAC;QACN;YAAC;YAAiB;SAAgB;QAClC;YAAC;YAAiB;SAAkB;KACrC,EAAE,8CAA8C,OAAO/B,UAAUC;QAChE,MAAM+B,wBAAwBnC,GAAGwB,EAAE;QACnC,MAAMY,UAAUnC,yBAAyB;YACvCS,QAAQ,IAAM;YACd2B,QAAQ;gBAAEF;YAAsB;YAChC7B,aAAa;gBAAEC,OAAO,CAAC;YAAE;QAC3B;QAEA,MAAMT,OAAOsC,QAAQlC,cAAcC,UAAUC,YAAYkC,OAAO,CAACC,aAAa,CAAC;YAC7EC,QAAQ;QACV;QACA1C,OAAOqC,uBAAuBM,GAAG,CAACC,gBAAgB;IACpD;IAEA7C,SAAS,gBAAgB;QACvB,MAAM8C,gBAAgB;YACpB,MAAMC,wBAAwB5C,GAAGwB,EAAE,CAAC,IAAO,CAAA;oBACzCqB,YAAY7C,GAAGwB,EAAE,GAAGC,iBAAiB,CAAC;wBAAEqB,MAAM;wBAAQC,YAAY;oBAAE;gBACtE,CAAA;YAEA,OAAO;gBACLX,SAASnC,yBAAyB;oBAChCS,QAAQ,IAAM;oBACd2B,QAAQ;wBAAEO;oBAAsB;oBAChCtC,aAAa;wBAAEC,OAAO;4BAAEyC,QAAQ;wBAAQ;oBAAE;gBAC5C;gBACAJ;YACF;QACF;QAEA7C,GAAG,wDAAwD;YACzD,MAAM,EAAEqC,OAAO,EAAEQ,qBAAqB,EAAE,GAAGD;YAE3C,MAAM7C,OACJsC,QACEhB,0BAA0B;gBACxBC,cAAc;YAChB,KAEFiB,OAAO,CAACC,aAAa,CAAC;gBAAEC,QAAQ;YAAI;YACtC1C,OAAO8C,uBAAuBH,GAAG,CAACC,gBAAgB;QACpD;QAEA3C,GAAG,kDAAkD;YACnD,MAAM,EAAEqC,OAAO,EAAEQ,qBAAqB,EAAE,GAAGD;YAE3C,MAAMM,WAAW,MAAMb,QACrBhB,0BAA0B;gBACxBC,cAAc;YAChB;YAGFvB,OAAOmD,SAAST,MAAM,EAAEU,IAAI,CAAC;YAC7BpD,OAAO8C,uBAAuBO,oBAAoB,CAAC,6BAA6B;QAClF;IACF;IAEApD,GAAG,4DAA4D;QAC7D,MAAMoC,wBAAwBnC,GAAGwB,EAAE;QACnC,MAAMa,SAAS;YACbF;YACAiB,MAAMpD,GAAGwB,EAAE,GAAGC,iBAAiB,CAAC;gBAAE4B,KAAK;YAAgB;QACzD;QACA,MAAM/B,MAAM;YACVjB,SAAS;gBACPC,aAAa;oBACXC,OAAO;wBAAEC,QAAQ;4BAAEE,QAAQ,CAAC;4BAAGC,QAAQ;wBAAK;oBAAE;gBAChD;gBACA2C,IAAI;oBAAEC,SAASvD,GAAGwB,EAAE,GAAGC,iBAAiB,CAAC;gBAAM;YACjD;YACAZ,cAAc,IAAIC,gBAAgB;gBAChCC,YAAY;gBACZC,UAAU;gBACVC,UAAU;YACZ;YACAC,MAAM;gBAAEC,IAAI;YAAO;QACrB;QACA,MAAMiB,UAAUnC,yBAAyB;YACvCS,QAAQ,UAAY;YACpB2B;YACA/B,aAAa;gBAAEC,OAAO;YAAK;QAC7B;QAEA,MAAM0C,WAAW,MAAMb,QAAQd;QAE/BxB,OAAOmD,SAAST,MAAM,EAAEU,IAAI,CAAC;QAC7BpD,OAAOqC,uBAAuBM,GAAG,CAACC,gBAAgB;IACpD;AACF"}
|
package/dist/index.d.ts
CHANGED
|
@@ -24,14 +24,15 @@ export interface R2StorageOptions {
|
|
|
24
24
|
enabled?: boolean;
|
|
25
25
|
/**
|
|
26
26
|
* When true, the collection-level prefix and document-level prefix are combined
|
|
27
|
-
* (compositional). When false (default), document prefix
|
|
28
|
-
* prefix
|
|
27
|
+
* (compositional). When false (default), a document prefix already within the
|
|
28
|
+
* collection prefix is used as-is for new uploads; otherwise it is nested beneath it.
|
|
29
|
+
* Existing files retain their stored prefixes for reads, URLs, and cleanup.
|
|
29
30
|
*
|
|
30
|
-
* Example:
|
|
31
|
-
* - collection prefix: `
|
|
32
|
-
* - document prefix: `
|
|
33
|
-
* - resulting prefix with useCompositePrefixes=true: `
|
|
34
|
-
* - resulting prefix with useCompositePrefixes=false: `
|
|
31
|
+
* Example with a document prefix already contained by the collection prefix:
|
|
32
|
+
* - collection prefix: `uploads/`
|
|
33
|
+
* - document prefix: `uploads/documents/`
|
|
34
|
+
* - resulting prefix with useCompositePrefixes=true: `uploads/uploads/documents/`
|
|
35
|
+
* - resulting prefix with useCompositePrefixes=false: `uploads/documents/`
|
|
35
36
|
*
|
|
36
37
|
* @default false
|
|
37
38
|
*/
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,mBAAmB,EAEnB,iBAAiB,EAClB,MAAM,wCAAwC,CAAA;AAC/C,OAAO,KAAK,EAAU,cAAc,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAI3E,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAI1C,MAAM,WAAW,gBAAgB;IAC/B;;;;;;;;OAQG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAE5B,MAAM,EAAE,QAAQ,CAAA;IAChB;;OAEG;IACH,aAAa,CAAC,EAAE,mBAAmB,CAAA;IACnC;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC,MAAM,CAAC,oBAAoB,EAAE,IAAI,CAAC,iBAAiB,EAAE,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC,CAAA;IAC7F,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,mBAAmB,EAEnB,iBAAiB,EAClB,MAAM,wCAAwC,CAAA;AAC/C,OAAO,KAAK,EAAU,cAAc,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAI3E,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAI1C,MAAM,WAAW,gBAAgB;IAC/B;;;;;;;;OAQG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAE5B,MAAM,EAAE,QAAQ,CAAA;IAChB;;OAEG;IACH,aAAa,CAAC,EAAE,mBAAmB,CAAA;IACnC;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC,MAAM,CAAC,oBAAoB,EAAE,IAAI,CAAC,iBAAiB,EAAE,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC,CAAA;IAC7F,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;;;;;;;;;;;;OAaG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B;AAED,KAAK,gBAAgB,GAAG,CAAC,aAAa,EAAE,gBAAgB,KAAK,cAAc,CAAA;AAE3E,eAAO,MAAM,SAAS,EAAE,gBAyDtB,CAAA"}
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type {\n ClientUploadsConfig,\n PluginOptions as CloudStoragePluginOptions,\n CollectionOptions,\n} from '@payloadcms/plugin-cloud-storage/types'\nimport type { Config, StorageAdapter, UploadCollectionSlug } from 'payload'\n\nimport { cloudStoragePlugin } from '@payloadcms/plugin-cloud-storage'\n\nimport type { R2Bucket } from './types.js'\n\nimport { createR2Adapter } from './adapter.js'\n\nexport interface R2StorageOptions {\n /**\n * When enabled, fields (like the prefix field) will always be inserted into\n * the collection schema regardless of whether the plugin is enabled. This\n * ensures a consistent schema across all environments.\n *\n * This will be enabled by default in Payload v4.\n *\n * @default false\n */\n alwaysInsertFields?: boolean\n\n bucket: R2Bucket\n /**\n * Upload files in chunks through Payload before document creation.\n */\n clientUploads?: ClientUploadsConfig\n /**\n * Collection options to apply the R2 adapter to.\n */\n collections: Partial<Record<UploadCollectionSlug, Omit<CollectionOptions, 'adapter'> | true>>\n enabled?: boolean\n /**\n * When true, the collection-level prefix and document-level prefix are combined\n * (compositional). When false (default), document prefix
|
|
1
|
+
{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type {\n ClientUploadsConfig,\n PluginOptions as CloudStoragePluginOptions,\n CollectionOptions,\n} from '@payloadcms/plugin-cloud-storage/types'\nimport type { Config, StorageAdapter, UploadCollectionSlug } from 'payload'\n\nimport { cloudStoragePlugin } from '@payloadcms/plugin-cloud-storage'\n\nimport type { R2Bucket } from './types.js'\n\nimport { createR2Adapter } from './adapter.js'\n\nexport interface R2StorageOptions {\n /**\n * When enabled, fields (like the prefix field) will always be inserted into\n * the collection schema regardless of whether the plugin is enabled. This\n * ensures a consistent schema across all environments.\n *\n * This will be enabled by default in Payload v4.\n *\n * @default false\n */\n alwaysInsertFields?: boolean\n\n bucket: R2Bucket\n /**\n * Upload files in chunks through Payload before document creation.\n */\n clientUploads?: ClientUploadsConfig\n /**\n * Collection options to apply the R2 adapter to.\n */\n collections: Partial<Record<UploadCollectionSlug, Omit<CollectionOptions, 'adapter'> | true>>\n enabled?: boolean\n /**\n * When true, the collection-level prefix and document-level prefix are combined\n * (compositional). When false (default), a document prefix already within the\n * collection prefix is used as-is for new uploads; otherwise it is nested beneath it.\n * Existing files retain their stored prefixes for reads, URLs, and cleanup.\n *\n * Example with a document prefix already contained by the collection prefix:\n * - collection prefix: `uploads/`\n * - document prefix: `uploads/documents/`\n * - resulting prefix with useCompositePrefixes=true: `uploads/uploads/documents/`\n * - resulting prefix with useCompositePrefixes=false: `uploads/documents/`\n *\n * @default false\n */\n useCompositePrefixes?: boolean\n}\n\ntype R2StorageFactory = (r2StorageArgs: R2StorageOptions) => StorageAdapter\n\nexport const r2Storage: R2StorageFactory = (\n r2StorageOptions: R2StorageOptions,\n): StorageAdapter => ({\n name: 'r2',\n collections: Object.keys(r2StorageOptions.collections),\n init: (incomingConfig: Config): Config => {\n const adapter = createR2Adapter({\n bucket: r2StorageOptions.bucket,\n clientUploads: r2StorageOptions.clientUploads,\n collections: r2StorageOptions.collections,\n useCompositePrefixes: r2StorageOptions.useCompositePrefixes,\n })\n\n const isPluginDisabled = r2StorageOptions.enabled === false\n\n if (isPluginDisabled) {\n return incomingConfig\n }\n\n // Add adapter to each collection option object\n const collectionsWithAdapter: CloudStoragePluginOptions['collections'] = Object.entries(\n r2StorageOptions.collections,\n ).reduce(\n (acc, [slug, collOptions]) => ({\n ...acc,\n [slug]: {\n ...(collOptions === true ? {} : collOptions),\n adapter,\n },\n }),\n {} as Record<string, CollectionOptions>,\n )\n\n // Set disableLocalStorage: true for collections specified in the plugin options\n const config = {\n ...incomingConfig,\n collections: (incomingConfig.collections || []).map((collection) => {\n if (!collectionsWithAdapter[collection.slug]) {\n return collection\n }\n\n return {\n ...collection,\n upload: {\n ...(typeof collection.upload === 'object' ? collection.upload : {}),\n disableLocalStorage: true,\n },\n }\n }),\n }\n\n return cloudStoragePlugin({\n alwaysInsertFields: r2StorageOptions.alwaysInsertFields,\n collections: collectionsWithAdapter,\n useCompositePrefixes: r2StorageOptions.useCompositePrefixes,\n })(config)\n },\n})\n"],"names":["cloudStoragePlugin","createR2Adapter","r2Storage","r2StorageOptions","name","collections","Object","keys","init","incomingConfig","adapter","bucket","clientUploads","useCompositePrefixes","isPluginDisabled","enabled","collectionsWithAdapter","entries","reduce","acc","slug","collOptions","config","map","collection","upload","disableLocalStorage","alwaysInsertFields"],"mappings":"AAOA,SAASA,kBAAkB,QAAQ,mCAAkC;AAIrE,SAASC,eAAe,QAAQ,eAAc;AA2C9C,OAAO,MAAMC,YAA8B,CACzCC,mBACoB,CAAA;QACpBC,MAAM;QACNC,aAAaC,OAAOC,IAAI,CAACJ,iBAAiBE,WAAW;QACrDG,MAAM,CAACC;YACL,MAAMC,UAAUT,gBAAgB;gBAC9BU,QAAQR,iBAAiBQ,MAAM;gBAC/BC,eAAeT,iBAAiBS,aAAa;gBAC7CP,aAAaF,iBAAiBE,WAAW;gBACzCQ,sBAAsBV,iBAAiBU,oBAAoB;YAC7D;YAEA,MAAMC,mBAAmBX,iBAAiBY,OAAO,KAAK;YAEtD,IAAID,kBAAkB;gBACpB,OAAOL;YACT;YAEA,+CAA+C;YAC/C,MAAMO,yBAAmEV,OAAOW,OAAO,CACrFd,iBAAiBE,WAAW,EAC5Ba,MAAM,CACN,CAACC,KAAK,CAACC,MAAMC,YAAY,GAAM,CAAA;oBAC7B,GAAGF,GAAG;oBACN,CAACC,KAAK,EAAE;wBACN,GAAIC,gBAAgB,OAAO,CAAC,IAAIA,WAAW;wBAC3CX;oBACF;gBACF,CAAA,GACA,CAAC;YAGH,gFAAgF;YAChF,MAAMY,SAAS;gBACb,GAAGb,cAAc;gBACjBJ,aAAa,AAACI,CAAAA,eAAeJ,WAAW,IAAI,EAAE,AAAD,EAAGkB,GAAG,CAAC,CAACC;oBACnD,IAAI,CAACR,sBAAsB,CAACQ,WAAWJ,IAAI,CAAC,EAAE;wBAC5C,OAAOI;oBACT;oBAEA,OAAO;wBACL,GAAGA,UAAU;wBACbC,QAAQ;4BACN,GAAI,OAAOD,WAAWC,MAAM,KAAK,WAAWD,WAAWC,MAAM,GAAG,CAAC,CAAC;4BAClEC,qBAAqB;wBACvB;oBACF;gBACF;YACF;YAEA,OAAO1B,mBAAmB;gBACxB2B,oBAAoBxB,iBAAiBwB,kBAAkB;gBACvDtB,aAAaW;gBACbH,sBAAsBV,iBAAiBU,oBAAoB;YAC7D,GAAGS;QACL;IACF,CAAA,EAAE"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"staticHandler.spec.d.ts","sourceRoot":"","sources":["../src/staticHandler.spec.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
import { describe, expect, it, vi } from 'vitest';
|
|
2
|
+
import { createR2Adapter } from './adapter.js';
|
|
3
|
+
describe('static handler document locations', ()=>{
|
|
4
|
+
it('should read the checked document without another lookup', async ()=>{
|
|
5
|
+
const head = vi.fn(async ()=>({
|
|
6
|
+
size: 4
|
|
7
|
+
}));
|
|
8
|
+
const get = vi.fn(async ()=>({
|
|
9
|
+
body: 'file',
|
|
10
|
+
writeHttpMetadata: vi.fn()
|
|
11
|
+
}));
|
|
12
|
+
const adapter = createR2Adapter({
|
|
13
|
+
bucket: {
|
|
14
|
+
get,
|
|
15
|
+
head
|
|
16
|
+
},
|
|
17
|
+
collections: {
|
|
18
|
+
media: true
|
|
19
|
+
}
|
|
20
|
+
});
|
|
21
|
+
const find = vi.fn(async ()=>({
|
|
22
|
+
docs: [
|
|
23
|
+
{
|
|
24
|
+
prefix: 'database'
|
|
25
|
+
}
|
|
26
|
+
]
|
|
27
|
+
}));
|
|
28
|
+
const generatedAdapter = adapter({
|
|
29
|
+
collection: {
|
|
30
|
+
fields: [],
|
|
31
|
+
slug: 'media',
|
|
32
|
+
upload: {}
|
|
33
|
+
},
|
|
34
|
+
prefix: 'media'
|
|
35
|
+
});
|
|
36
|
+
const doc = {
|
|
37
|
+
id: 'authorized',
|
|
38
|
+
prefix: 'legacy'
|
|
39
|
+
};
|
|
40
|
+
const response = await generatedAdapter.staticHandler({
|
|
41
|
+
headers: new Headers(),
|
|
42
|
+
payload: {
|
|
43
|
+
find,
|
|
44
|
+
logger: {
|
|
45
|
+
error: vi.fn()
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
}, {
|
|
49
|
+
doc,
|
|
50
|
+
params: {
|
|
51
|
+
collection: 'media',
|
|
52
|
+
filename: 'original.png'
|
|
53
|
+
}
|
|
54
|
+
});
|
|
55
|
+
expect(response.status).toBe(200);
|
|
56
|
+
expect(await response.text()).toBe('file');
|
|
57
|
+
expect(head).toHaveBeenCalledWith('legacy/original.png');
|
|
58
|
+
expect(get).toHaveBeenCalledWith('legacy/original.png');
|
|
59
|
+
expect(find).not.toHaveBeenCalled();
|
|
60
|
+
});
|
|
61
|
+
});
|
|
62
|
+
|
|
63
|
+
//# sourceMappingURL=staticHandler.spec.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/staticHandler.spec.ts"],"sourcesContent":["import { describe, expect, it, vi } from 'vitest'\n\nimport { createR2Adapter } from './adapter.js'\n\ndescribe('static handler document locations', () => {\n it('should read the checked document without another lookup', async () => {\n const head = vi.fn(async () => ({ size: 4 }))\n const get = vi.fn(async () => ({ body: 'file', writeHttpMetadata: vi.fn() }))\n const adapter = createR2Adapter({\n bucket: { get, head } as never,\n collections: { media: true },\n })\n const find = vi.fn(async () => ({ docs: [{ prefix: 'database' }] }))\n const generatedAdapter = adapter({\n collection: {\n fields: [],\n slug: 'media',\n upload: {},\n },\n prefix: 'media',\n })\n const doc = {\n id: 'authorized',\n prefix: 'legacy',\n }\n const response = await generatedAdapter.staticHandler(\n {\n headers: new Headers(),\n payload: { find, logger: { error: vi.fn() } },\n } as never,\n {\n doc,\n params: { collection: 'media', filename: 'original.png' },\n },\n )\n\n expect(response.status).toBe(200)\n expect(await response.text()).toBe('file')\n expect(head).toHaveBeenCalledWith('legacy/original.png')\n expect(get).toHaveBeenCalledWith('legacy/original.png')\n expect(find).not.toHaveBeenCalled()\n })\n})\n"],"names":["describe","expect","it","vi","createR2Adapter","head","fn","size","get","body","writeHttpMetadata","adapter","bucket","collections","media","find","docs","prefix","generatedAdapter","collection","fields","slug","upload","doc","id","response","staticHandler","headers","Headers","payload","logger","error","params","filename","status","toBe","text","toHaveBeenCalledWith","not","toHaveBeenCalled"],"mappings":"AAAA,SAASA,QAAQ,EAAEC,MAAM,EAAEC,EAAE,EAAEC,EAAE,QAAQ,SAAQ;AAEjD,SAASC,eAAe,QAAQ,eAAc;AAE9CJ,SAAS,qCAAqC;IAC5CE,GAAG,2DAA2D;QAC5D,MAAMG,OAAOF,GAAGG,EAAE,CAAC,UAAa,CAAA;gBAAEC,MAAM;YAAE,CAAA;QAC1C,MAAMC,MAAML,GAAGG,EAAE,CAAC,UAAa,CAAA;gBAAEG,MAAM;gBAAQC,mBAAmBP,GAAGG,EAAE;YAAG,CAAA;QAC1E,MAAMK,UAAUP,gBAAgB;YAC9BQ,QAAQ;gBAAEJ;gBAAKH;YAAK;YACpBQ,aAAa;gBAAEC,OAAO;YAAK;QAC7B;QACA,MAAMC,OAAOZ,GAAGG,EAAE,CAAC,UAAa,CAAA;gBAAEU,MAAM;oBAAC;wBAAEC,QAAQ;oBAAW;iBAAE;YAAC,CAAA;QACjE,MAAMC,mBAAmBP,QAAQ;YAC/BQ,YAAY;gBACVC,QAAQ,EAAE;gBACVC,MAAM;gBACNC,QAAQ,CAAC;YACX;YACAL,QAAQ;QACV;QACA,MAAMM,MAAM;YACVC,IAAI;YACJP,QAAQ;QACV;QACA,MAAMQ,WAAW,MAAMP,iBAAiBQ,aAAa,CACnD;YACEC,SAAS,IAAIC;YACbC,SAAS;gBAAEd;gBAAMe,QAAQ;oBAAEC,OAAO5B,GAAGG,EAAE;gBAAG;YAAE;QAC9C,GACA;YACEiB;YACAS,QAAQ;gBAAEb,YAAY;gBAASc,UAAU;YAAe;QAC1D;QAGFhC,OAAOwB,SAASS,MAAM,EAAEC,IAAI,CAAC;QAC7BlC,OAAO,MAAMwB,SAASW,IAAI,IAAID,IAAI,CAAC;QACnClC,OAAOI,MAAMgC,oBAAoB,CAAC;QAClCpC,OAAOO,KAAK6B,oBAAoB,CAAC;QACjCpC,OAAOc,MAAMuB,GAAG,CAACC,gBAAgB;IACnC;AACF"}
|
package/dist/types.d.ts
CHANGED
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
* so Node's Blob/Buffer/Headers are accepted and we avoid strict Workers-only types.
|
|
5
5
|
*/
|
|
6
6
|
import type { R2Range } from '@cloudflare/workers-types/2023-07-01/index.js';
|
|
7
|
+
import type { UploadReference } from '@payloadcms/plugin-cloud-storage/types';
|
|
7
8
|
export type { R2Range };
|
|
8
9
|
export interface R2GetOptions {
|
|
9
10
|
[key: string]: any;
|
|
@@ -48,10 +49,7 @@ export interface R2UploadedPart {
|
|
|
48
49
|
etag: string;
|
|
49
50
|
partNumber: number;
|
|
50
51
|
}
|
|
51
|
-
export
|
|
52
|
-
key: string;
|
|
53
|
-
prefix: string;
|
|
54
|
-
}
|
|
52
|
+
export type R2StorageUploadReference = UploadReference;
|
|
55
53
|
export type R2StorageClientUploadHandlerParams = {
|
|
56
54
|
chunkSize?: number;
|
|
57
55
|
};
|
|
@@ -63,5 +61,6 @@ export type R2StorageMultipartUploadHandlerParams = {
|
|
|
63
61
|
multipartId?: string;
|
|
64
62
|
multipartKey?: string;
|
|
65
63
|
multipartNumber?: string;
|
|
64
|
+
signedReceipt?: string;
|
|
66
65
|
};
|
|
67
66
|
//# sourceMappingURL=types.d.ts.map
|
package/dist/types.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,+CAA+C,CAAA;
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,+CAA+C,CAAA;AAC5E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wCAAwC,CAAA;AAE7E,YAAY,EAAE,OAAO,EAAE,CAAA;AAEvB,MAAM,WAAW,YAAY;IAC3B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;IAClB,MAAM,CAAC,EAAE,GAAG,GAAG,OAAO,CAAA;IACtB,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB;AAED,MAAM,WAAW,QAAQ;IACvB,qBAAqB,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAA;IAC7E,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC9C,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,GAAG,YAAY,CAAC,CAAA;IACtE,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,GAAG,QAAQ,CAAC,CAAA;IAC3C,IAAI,CAAC,OAAO,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,CAAA;IACjC,GAAG,CACD,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,WAAW,GAAG,eAAe,GAAG,IAAI,GAAG,IAAI,GAAG,cAAc,GAAG,MAAM,EAC5E,OAAO,CAAC,EAAE,GAAG,GACZ,OAAO,CAAC,GAAG,CAAC,CAAA;IACf,qBAAqB,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,iBAAiB,CAAA;CACxE;AAED,UAAU,cAAc;IACtB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,WAAW,CAAC,EAAE,IAAI,CAAA;IAClB,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,YAAY,CAAC,EAAE,cAAc,CAAA;IACtC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,iBAAiB,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAAA;CAC1C;AAED,MAAM,WAAW,YAAa,SAAQ,QAAQ;IAC5C,IAAI,IAAI,IAAI,cAAc,CAAA;CAC3B;AAED,MAAM,WAAW,iBAAiB;IAChC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IACtB,QAAQ,CAAC,aAAa,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAA;IAC5D,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,UAAU,CACR,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,CAAC,WAAW,GAAG,eAAe,CAAC,GAAG,IAAI,GAAG,cAAc,GAAG,MAAM,EACvE,OAAO,CAAC,EAAE,GAAG,GACZ,OAAO,CAAC,cAAc,CAAC,CAAA;CAC3B;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,MAAM,wBAAwB,GAAG,eAAe,CAAA;AACtD,MAAM,MAAM,kCAAkC,GAAG;IAC/C,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,qCAAqC,GAAG;IAClD,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB,CAAA"}
|
package/dist/types.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/types.ts"],"sourcesContent":["/**\n * R2 API types compatible with both Node (Miniflare) and Cloudflare Workers.\n * R2Range is sourced from Cloudflare so it cannot drift; other types are our own\n * so Node's Blob/Buffer/Headers are accepted and we avoid strict Workers-only types.\n */\nimport type { R2Range } from '@cloudflare/workers-types/2023-07-01/index.js'\n\nexport type { R2Range }\n\nexport interface R2GetOptions {\n [key: string]: any\n onlyIf?: any | Headers\n range?: R2Range\n}\n\nexport interface R2Bucket {\n createMultipartUpload(key: string, options?: any): Promise<R2MultipartUpload>\n delete(keys: string | string[]): Promise<void>\n get(key: string, options?: R2GetOptions): Promise<null | R2ObjectBody>\n head(key: string): Promise<null | R2Object>\n list(options?: any): Promise<any>\n put(\n key: string,\n value: ArrayBuffer | ArrayBufferView | Blob | null | ReadableStream | string,\n options?: any,\n ): Promise<any>\n resumeMultipartUpload(key: string, uploadId: string): R2MultipartUpload\n}\n\ninterface R2HTTPMetadata {\n cacheControl?: string\n cacheExpiry?: Date\n contentDisposition?: string\n contentEncoding?: string\n contentLanguage?: string\n contentType?: string\n}\n\nexport interface R2Object {\n readonly etag: string\n readonly httpMetadata?: R2HTTPMetadata\n readonly key: string\n readonly size: number\n writeHttpMetadata(headers: Headers): void\n}\n\nexport interface R2ObjectBody extends R2Object {\n get body(): ReadableStream\n}\n\nexport interface R2MultipartUpload {\n abort(): Promise<void>\n complete(uploadedParts: R2UploadedPart[]): Promise<R2Object>\n readonly key: string\n readonly uploadId: string\n uploadPart(\n partNumber: number,\n value: (ArrayBuffer | ArrayBufferView) | Blob | ReadableStream | string,\n options?: any,\n ): Promise<R2UploadedPart>\n}\n\nexport interface R2UploadedPart {\n etag: string\n partNumber: number\n}\n\nexport
|
|
1
|
+
{"version":3,"sources":["../src/types.ts"],"sourcesContent":["/**\n * R2 API types compatible with both Node (Miniflare) and Cloudflare Workers.\n * R2Range is sourced from Cloudflare so it cannot drift; other types are our own\n * so Node's Blob/Buffer/Headers are accepted and we avoid strict Workers-only types.\n */\nimport type { R2Range } from '@cloudflare/workers-types/2023-07-01/index.js'\nimport type { UploadReference } from '@payloadcms/plugin-cloud-storage/types'\n\nexport type { R2Range }\n\nexport interface R2GetOptions {\n [key: string]: any\n onlyIf?: any | Headers\n range?: R2Range\n}\n\nexport interface R2Bucket {\n createMultipartUpload(key: string, options?: any): Promise<R2MultipartUpload>\n delete(keys: string | string[]): Promise<void>\n get(key: string, options?: R2GetOptions): Promise<null | R2ObjectBody>\n head(key: string): Promise<null | R2Object>\n list(options?: any): Promise<any>\n put(\n key: string,\n value: ArrayBuffer | ArrayBufferView | Blob | null | ReadableStream | string,\n options?: any,\n ): Promise<any>\n resumeMultipartUpload(key: string, uploadId: string): R2MultipartUpload\n}\n\ninterface R2HTTPMetadata {\n cacheControl?: string\n cacheExpiry?: Date\n contentDisposition?: string\n contentEncoding?: string\n contentLanguage?: string\n contentType?: string\n}\n\nexport interface R2Object {\n readonly etag: string\n readonly httpMetadata?: R2HTTPMetadata\n readonly key: string\n readonly size: number\n writeHttpMetadata(headers: Headers): void\n}\n\nexport interface R2ObjectBody extends R2Object {\n get body(): ReadableStream\n}\n\nexport interface R2MultipartUpload {\n abort(): Promise<void>\n complete(uploadedParts: R2UploadedPart[]): Promise<R2Object>\n readonly key: string\n readonly uploadId: string\n uploadPart(\n partNumber: number,\n value: (ArrayBuffer | ArrayBufferView) | Blob | ReadableStream | string,\n options?: any,\n ): Promise<R2UploadedPart>\n}\n\nexport interface R2UploadedPart {\n etag: string\n partNumber: number\n}\n\nexport type R2StorageUploadReference = UploadReference\nexport type R2StorageClientUploadHandlerParams = {\n chunkSize?: number\n}\n\nexport type R2StorageMultipartUploadHandlerParams = {\n collection: string\n docPrefix?: string\n fileName: string\n fileType: string\n multipartId?: string\n multipartKey?: string\n multipartNumber?: string\n signedReceipt?: string\n}\n"],"names":[],"mappings":"AAAA;;;;CAIC,GAqED,WASC"}
|
package/dist/uploadFile.d.ts
CHANGED
|
@@ -2,12 +2,9 @@ import type { R2Bucket } from './types.js';
|
|
|
2
2
|
interface UploadFileArgs {
|
|
3
3
|
bucket: R2Bucket;
|
|
4
4
|
buffer: Buffer;
|
|
5
|
-
collectionPrefix?: string;
|
|
6
|
-
docPrefix?: string;
|
|
7
|
-
filename: string;
|
|
8
5
|
mimeType: string;
|
|
9
|
-
|
|
6
|
+
storageFilePath: string;
|
|
10
7
|
}
|
|
11
|
-
export declare function uploadFile({ bucket, buffer,
|
|
8
|
+
export declare function uploadFile({ bucket, buffer, mimeType, storageFilePath, }: UploadFileArgs): Promise<void>;
|
|
12
9
|
export {};
|
|
13
10
|
//# sourceMappingURL=uploadFile.d.ts.map
|
package/dist/uploadFile.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"uploadFile.d.ts","sourceRoot":"","sources":["../src/uploadFile.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"uploadFile.d.ts","sourceRoot":"","sources":["../src/uploadFile.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAI1C,UAAU,cAAc;IACtB,MAAM,EAAE,QAAQ,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;IAChB,eAAe,EAAE,MAAM,CAAA;CACxB;AAED,wBAAsB,UAAU,CAAC,EAC/B,MAAM,EACN,MAAM,EACN,QAAQ,EACR,eAAe,GAChB,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAOhC"}
|
package/dist/uploadFile.js
CHANGED
|
@@ -1,17 +1,10 @@
|
|
|
1
|
-
import { getFileKey } from '@payloadcms/plugin-cloud-storage/utilities';
|
|
2
1
|
const isMiniflare = process.env.NODE_ENV === 'development';
|
|
3
|
-
export async function uploadFile({ bucket, buffer,
|
|
2
|
+
export async function uploadFile({ bucket, buffer, mimeType, storageFilePath }) {
|
|
4
3
|
// Read more: https://github.com/cloudflare/workers-sdk/issues/6047#issuecomment-2691217843
|
|
5
4
|
const body = isMiniflare ? new Blob([
|
|
6
5
|
buffer
|
|
7
6
|
]) : buffer;
|
|
8
|
-
|
|
9
|
-
collectionPrefix,
|
|
10
|
-
docPrefix,
|
|
11
|
-
filename,
|
|
12
|
-
useCompositePrefixes
|
|
13
|
-
});
|
|
14
|
-
await bucket.put(fileKey, body, {
|
|
7
|
+
await bucket.put(storageFilePath, body, {
|
|
15
8
|
httpMetadata: {
|
|
16
9
|
contentType: mimeType
|
|
17
10
|
}
|
package/dist/uploadFile.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/uploadFile.ts"],"sourcesContent":["import
|
|
1
|
+
{"version":3,"sources":["../src/uploadFile.ts"],"sourcesContent":["import type { R2Bucket } from './types.js'\n\nconst isMiniflare = process.env.NODE_ENV === 'development'\n\ninterface UploadFileArgs {\n bucket: R2Bucket\n buffer: Buffer\n mimeType: string\n storageFilePath: string\n}\n\nexport async function uploadFile({\n bucket,\n buffer,\n mimeType,\n storageFilePath,\n}: UploadFileArgs): Promise<void> {\n // Read more: https://github.com/cloudflare/workers-sdk/issues/6047#issuecomment-2691217843\n const body = isMiniflare ? new Blob([buffer]) : buffer\n\n await bucket.put(storageFilePath, body, {\n httpMetadata: { contentType: mimeType },\n })\n}\n"],"names":["isMiniflare","process","env","NODE_ENV","uploadFile","bucket","buffer","mimeType","storageFilePath","body","Blob","put","httpMetadata","contentType"],"mappings":"AAEA,MAAMA,cAAcC,QAAQC,GAAG,CAACC,QAAQ,KAAK;AAS7C,OAAO,eAAeC,WAAW,EAC/BC,MAAM,EACNC,MAAM,EACNC,QAAQ,EACRC,eAAe,EACA;IACf,2FAA2F;IAC3F,MAAMC,OAAOT,cAAc,IAAIU,KAAK;QAACJ;KAAO,IAAIA;IAEhD,MAAMD,OAAOM,GAAG,CAACH,iBAAiBC,MAAM;QACtCG,cAAc;YAAEC,aAAaN;QAAS;IACxC;AACF"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@payloadcms/storage-r2",
|
|
3
|
-
"version": "4.0.0-canary.
|
|
3
|
+
"version": "4.0.0-canary.34",
|
|
4
4
|
"description": "Payload storage adapter for Cloudflare R2",
|
|
5
5
|
"homepage": "https://payloadcms.com",
|
|
6
6
|
"repository": {
|
|
@@ -37,14 +37,14 @@
|
|
|
37
37
|
"dist"
|
|
38
38
|
],
|
|
39
39
|
"dependencies": {
|
|
40
|
-
"@payloadcms/plugin-cloud-storage": "4.0.0-canary.
|
|
40
|
+
"@payloadcms/plugin-cloud-storage": "4.0.0-canary.34"
|
|
41
41
|
},
|
|
42
42
|
"devDependencies": {
|
|
43
43
|
"@cloudflare/workers-types": "4.20260218.0",
|
|
44
|
-
"payload": "4.0.0-canary.
|
|
44
|
+
"payload": "4.0.0-canary.34"
|
|
45
45
|
},
|
|
46
46
|
"peerDependencies": {
|
|
47
|
-
"payload": "4.0.0-canary.
|
|
47
|
+
"payload": "4.0.0-canary.34"
|
|
48
48
|
},
|
|
49
49
|
"engines": {
|
|
50
50
|
"node": ">=24.15.0"
|