@payloadcms/storage-s3 3.42.0 → 3.43.0-internal.c5bbc84
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/README.md +9 -0
- package/dist/staticHandler.d.ts +6 -1
- package/dist/staticHandler.d.ts.map +1 -1
- package/dist/staticHandler.js +19 -9
- package/dist/staticHandler.js.map +1 -1
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -16,6 +16,7 @@ pnpm add @payloadcms/storage-s3
|
|
|
16
16
|
- The `config` object can be any [`S3ClientConfig`](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/s3) object (from [`@aws-sdk/client-s3`](https://github.com/aws/aws-sdk-js-v3)). _This is highly dependent on your AWS setup_. Check the AWS documentation for more information.
|
|
17
17
|
- When enabled, this package will automatically set `disableLocalStorage` to `true` for each collection.
|
|
18
18
|
- When deploying to Vercel, server uploads are limited with 4.5MB. Set `clientUploads` to `true` to do uploads directly on the client. You must allow CORS PUT method for the bucket to your website.
|
|
19
|
+
- Configure `signedDownloads` (either globally of per-collection in `collections`) to use [presigned URLs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-presigned-url.html) for files downloading. This can improve performance for large files (like videos) while still respecting your access control. Additionally, with `signedDownloads.shouldUseSignedURL` you can specify a condition whether Payload should use a presigned URL, if you want to use this feature only for specific files.
|
|
19
20
|
|
|
20
21
|
```ts
|
|
21
22
|
import { s3Storage } from '@payloadcms/storage-s3'
|
|
@@ -31,6 +32,14 @@ export default buildConfig({
|
|
|
31
32
|
'media-with-prefix': {
|
|
32
33
|
prefix,
|
|
33
34
|
},
|
|
35
|
+
'media-with-presigned-downloads': {
|
|
36
|
+
// Filter only mp4 files
|
|
37
|
+
signedDownloads: {
|
|
38
|
+
shouldUseSignedURL: ({ collection, filename, req }) => {
|
|
39
|
+
return filename.endsWith('.mp4')
|
|
40
|
+
},
|
|
41
|
+
},
|
|
42
|
+
},
|
|
34
43
|
},
|
|
35
44
|
bucket: process.env.S3_BUCKET,
|
|
36
45
|
config: {
|
package/dist/staticHandler.d.ts
CHANGED
|
@@ -1,9 +1,14 @@
|
|
|
1
1
|
import type * as AWS from '@aws-sdk/client-s3';
|
|
2
2
|
import type { StaticHandler } from '@payloadcms/plugin-cloud-storage/types';
|
|
3
|
-
import type { CollectionConfig } from 'payload';
|
|
3
|
+
import type { CollectionConfig, PayloadRequest } from 'payload';
|
|
4
4
|
export type SignedDownloadsConfig = {
|
|
5
5
|
/** @default 7200 */
|
|
6
6
|
expiresIn?: number;
|
|
7
|
+
shouldUseSignedURL?(args: {
|
|
8
|
+
collection: CollectionConfig;
|
|
9
|
+
filename: string;
|
|
10
|
+
req: PayloadRequest;
|
|
11
|
+
}): boolean | Promise<boolean>;
|
|
7
12
|
} | boolean;
|
|
8
13
|
interface Args {
|
|
9
14
|
bucket: string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"staticHandler.d.ts","sourceRoot":"","sources":["../src/staticHandler.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,GAAG,MAAM,oBAAoB,CAAA;AAC9C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wCAAwC,CAAA;AAC3E,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAA;AAQ/
|
|
1
|
+
{"version":3,"file":"staticHandler.d.ts","sourceRoot":"","sources":["../src/staticHandler.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,GAAG,MAAM,oBAAoB,CAAA;AAC9C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wCAAwC,CAAA;AAC3E,OAAO,KAAK,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAQ/D,MAAM,MAAM,qBAAqB,GAC7B;IACE,oBAAoB;IACpB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,kBAAkB,CAAC,CAAC,IAAI,EAAE;QACxB,UAAU,EAAE,gBAAgB,CAAA;QAC5B,QAAQ,EAAE,MAAM,CAAA;QAChB,GAAG,EAAE,cAAc,CAAA;KACpB,GAAG,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;CAC/B,GACD,OAAO,CAAA;AAEX,UAAU,IAAI;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,gBAAgB,CAAA;IAC5B,gBAAgB,EAAE,MAAM,GAAG,CAAC,EAAE,CAAA;IAC9B,eAAe,CAAC,EAAE,qBAAqB,CAAA;CACxC;AA8BD,eAAO,MAAM,UAAU,+DAKpB,IAAI,KAAG,aAoFT,CAAA"}
|
package/dist/staticHandler.js
CHANGED
|
@@ -32,15 +32,25 @@ export const getHandler = ({ bucket, collection, getStorageClient, signedDownloa
|
|
|
32
32
|
});
|
|
33
33
|
const key = path.posix.join(prefix, filename);
|
|
34
34
|
if (signedDownloads && !clientUploadContext) {
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
}
|
|
43
|
-
|
|
35
|
+
let useSignedURL = true;
|
|
36
|
+
if (typeof signedDownloads === 'object' && typeof signedDownloads.shouldUseSignedURL === 'function') {
|
|
37
|
+
useSignedURL = await signedDownloads.shouldUseSignedURL({
|
|
38
|
+
collection,
|
|
39
|
+
filename,
|
|
40
|
+
req
|
|
41
|
+
});
|
|
42
|
+
}
|
|
43
|
+
if (useSignedURL) {
|
|
44
|
+
const command = new GetObjectCommand({
|
|
45
|
+
Bucket: bucket,
|
|
46
|
+
Key: key
|
|
47
|
+
});
|
|
48
|
+
const signedUrl = await getSignedUrl(// @ts-expect-error mismatch versions
|
|
49
|
+
getStorageClient(), command, typeof signedDownloads === 'object' ? signedDownloads : {
|
|
50
|
+
expiresIn: 7200
|
|
51
|
+
});
|
|
52
|
+
return Response.redirect(signedUrl);
|
|
53
|
+
}
|
|
44
54
|
}
|
|
45
55
|
object = await getStorageClient().getObject({
|
|
46
56
|
Bucket: bucket,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/staticHandler.ts"],"sourcesContent":["import type * as AWS from '@aws-sdk/client-s3'\nimport type { StaticHandler } from '@payloadcms/plugin-cloud-storage/types'\nimport type { CollectionConfig } from 'payload'\nimport type { Readable } from 'stream'\n\nimport { GetObjectCommand } from '@aws-sdk/client-s3'\nimport { getSignedUrl } from '@aws-sdk/s3-request-presigner'\nimport { getFilePrefix } from '@payloadcms/plugin-cloud-storage/utilities'\nimport path from 'path'\n\nexport type SignedDownloadsConfig =\n | {\n /** @default 7200 */\n expiresIn?: number\n }\n | boolean\n\ninterface Args {\n bucket: string\n collection: CollectionConfig\n getStorageClient: () => AWS.S3\n signedDownloads?: SignedDownloadsConfig\n}\n\n// Type guard for NodeJS.Readable streams\nconst isNodeReadableStream = (body: unknown): body is Readable => {\n return (\n typeof body === 'object' &&\n body !== null &&\n 'pipe' in body &&\n typeof (body as any).pipe === 'function' &&\n 'destroy' in body &&\n typeof (body as any).destroy === 'function'\n )\n}\n\nconst destroyStream = (object: AWS.GetObjectOutput | undefined) => {\n if (object?.Body && isNodeReadableStream(object.Body)) {\n object.Body.destroy()\n }\n}\n\n// Convert a stream into a promise that resolves with a Buffer\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nconst streamToBuffer = async (readableStream: any) => {\n const chunks = []\n for await (const chunk of readableStream) {\n chunks.push(typeof chunk === 'string' ? Buffer.from(chunk) : chunk)\n }\n return Buffer.concat(chunks)\n}\n\nexport const getHandler = ({\n bucket,\n collection,\n getStorageClient,\n signedDownloads,\n}: Args): StaticHandler => {\n return async (req, { params: { clientUploadContext, filename } }) => {\n let object: AWS.GetObjectOutput | undefined = undefined\n try {\n const prefix = await getFilePrefix({ clientUploadContext, collection, filename, req })\n\n const key = path.posix.join(prefix, filename)\n\n if (signedDownloads && !clientUploadContext) {\n const command = new GetObjectCommand({ Bucket: bucket, Key: key })\n
|
|
1
|
+
{"version":3,"sources":["../src/staticHandler.ts"],"sourcesContent":["import type * as AWS from '@aws-sdk/client-s3'\nimport type { StaticHandler } from '@payloadcms/plugin-cloud-storage/types'\nimport type { CollectionConfig, PayloadRequest } from 'payload'\nimport type { Readable } from 'stream'\n\nimport { GetObjectCommand } from '@aws-sdk/client-s3'\nimport { getSignedUrl } from '@aws-sdk/s3-request-presigner'\nimport { getFilePrefix } from '@payloadcms/plugin-cloud-storage/utilities'\nimport path from 'path'\n\nexport type SignedDownloadsConfig =\n | {\n /** @default 7200 */\n expiresIn?: number\n shouldUseSignedURL?(args: {\n collection: CollectionConfig\n filename: string\n req: PayloadRequest\n }): boolean | Promise<boolean>\n }\n | boolean\n\ninterface Args {\n bucket: string\n collection: CollectionConfig\n getStorageClient: () => AWS.S3\n signedDownloads?: SignedDownloadsConfig\n}\n\n// Type guard for NodeJS.Readable streams\nconst isNodeReadableStream = (body: unknown): body is Readable => {\n return (\n typeof body === 'object' &&\n body !== null &&\n 'pipe' in body &&\n typeof (body as any).pipe === 'function' &&\n 'destroy' in body &&\n typeof (body as any).destroy === 'function'\n )\n}\n\nconst destroyStream = (object: AWS.GetObjectOutput | undefined) => {\n if (object?.Body && isNodeReadableStream(object.Body)) {\n object.Body.destroy()\n }\n}\n\n// Convert a stream into a promise that resolves with a Buffer\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nconst streamToBuffer = async (readableStream: any) => {\n const chunks = []\n for await (const chunk of readableStream) {\n chunks.push(typeof chunk === 'string' ? Buffer.from(chunk) : chunk)\n }\n return Buffer.concat(chunks)\n}\n\nexport const getHandler = ({\n bucket,\n collection,\n getStorageClient,\n signedDownloads,\n}: Args): StaticHandler => {\n return async (req, { params: { clientUploadContext, filename } }) => {\n let object: AWS.GetObjectOutput | undefined = undefined\n try {\n const prefix = await getFilePrefix({ clientUploadContext, collection, filename, req })\n\n const key = path.posix.join(prefix, filename)\n\n if (signedDownloads && !clientUploadContext) {\n let useSignedURL = true\n if (\n typeof signedDownloads === 'object' &&\n typeof signedDownloads.shouldUseSignedURL === 'function'\n ) {\n useSignedURL = await signedDownloads.shouldUseSignedURL({ collection, filename, req })\n }\n\n if (useSignedURL) {\n const command = new GetObjectCommand({ Bucket: bucket, Key: key })\n const signedUrl = await getSignedUrl(\n // @ts-expect-error mismatch versions\n getStorageClient(),\n command,\n typeof signedDownloads === 'object' ? signedDownloads : { expiresIn: 7200 },\n )\n return Response.redirect(signedUrl)\n }\n }\n\n object = await getStorageClient().getObject({\n Bucket: bucket,\n Key: key,\n })\n\n if (!object.Body) {\n return new Response(null, { status: 404, statusText: 'Not Found' })\n }\n\n const etagFromHeaders = req.headers.get('etag') || req.headers.get('if-none-match')\n const objectEtag = object.ETag\n\n if (etagFromHeaders && etagFromHeaders === objectEtag) {\n return new Response(null, {\n headers: new Headers({\n 'Accept-Ranges': String(object.AcceptRanges),\n 'Content-Length': String(object.ContentLength),\n 'Content-Type': String(object.ContentType),\n ETag: String(object.ETag),\n }),\n status: 304,\n })\n }\n\n // On error, manually destroy stream to close socket\n if (object.Body && isNodeReadableStream(object.Body)) {\n const stream = object.Body\n stream.on('error', (err) => {\n req.payload.logger.error({\n err,\n key,\n msg: 'Error streaming S3 object, destroying stream',\n })\n stream.destroy()\n })\n }\n\n const bodyBuffer = await streamToBuffer(object.Body)\n\n return new Response(bodyBuffer, {\n headers: new Headers({\n 'Accept-Ranges': String(object.AcceptRanges),\n 'Content-Length': String(object.ContentLength),\n 'Content-Type': String(object.ContentType),\n ETag: String(object.ETag),\n }),\n status: 200,\n })\n } catch (err) {\n req.payload.logger.error(err)\n return new Response('Internal Server Error', { status: 500 })\n } finally {\n destroyStream(object)\n }\n }\n}\n"],"names":["GetObjectCommand","getSignedUrl","getFilePrefix","path","isNodeReadableStream","body","pipe","destroy","destroyStream","object","Body","streamToBuffer","readableStream","chunks","chunk","push","Buffer","from","concat","getHandler","bucket","collection","getStorageClient","signedDownloads","req","params","clientUploadContext","filename","undefined","prefix","key","posix","join","useSignedURL","shouldUseSignedURL","command","Bucket","Key","signedUrl","expiresIn","Response","redirect","getObject","status","statusText","etagFromHeaders","headers","get","objectEtag","ETag","Headers","String","AcceptRanges","ContentLength","ContentType","stream","on","err","payload","logger","error","msg","bodyBuffer"],"mappings":"AAKA,SAASA,gBAAgB,QAAQ,qBAAoB;AACrD,SAASC,YAAY,QAAQ,gCAA+B;AAC5D,SAASC,aAAa,QAAQ,6CAA4C;AAC1E,OAAOC,UAAU,OAAM;AAqBvB,yCAAyC;AACzC,MAAMC,uBAAuB,CAACC;IAC5B,OACE,OAAOA,SAAS,YAChBA,SAAS,QACT,UAAUA,QACV,OAAO,AAACA,KAAaC,IAAI,KAAK,cAC9B,aAAaD,QACb,OAAO,AAACA,KAAaE,OAAO,KAAK;AAErC;AAEA,MAAMC,gBAAgB,CAACC;IACrB,IAAIA,QAAQC,QAAQN,qBAAqBK,OAAOC,IAAI,GAAG;QACrDD,OAAOC,IAAI,CAACH,OAAO;IACrB;AACF;AAEA,8DAA8D;AAC9D,8DAA8D;AAC9D,MAAMI,iBAAiB,OAAOC;IAC5B,MAAMC,SAAS,EAAE;IACjB,WAAW,MAAMC,SAASF,eAAgB;QACxCC,OAAOE,IAAI,CAAC,OAAOD,UAAU,WAAWE,OAAOC,IAAI,CAACH,SAASA;IAC/D;IACA,OAAOE,OAAOE,MAAM,CAACL;AACvB;AAEA,OAAO,MAAMM,aAAa,CAAC,EACzBC,MAAM,EACNC,UAAU,EACVC,gBAAgB,EAChBC,eAAe,EACV;IACL,OAAO,OAAOC,KAAK,EAAEC,QAAQ,EAAEC,mBAAmB,EAAEC,QAAQ,EAAE,EAAE;QAC9D,IAAIlB,SAA0CmB;QAC9C,IAAI;YACF,MAAMC,SAAS,MAAM3B,cAAc;gBAAEwB;gBAAqBL;gBAAYM;gBAAUH;YAAI;YAEpF,MAAMM,MAAM3B,KAAK4B,KAAK,CAACC,IAAI,CAACH,QAAQF;YAEpC,IAAIJ,mBAAmB,CAACG,qBAAqB;gBAC3C,IAAIO,eAAe;gBACnB,IACE,OAAOV,oBAAoB,YAC3B,OAAOA,gBAAgBW,kBAAkB,KAAK,YAC9C;oBACAD,eAAe,MAAMV,gBAAgBW,kBAAkB,CAAC;wBAAEb;wBAAYM;wBAAUH;oBAAI;gBACtF;gBAEA,IAAIS,cAAc;oBAChB,MAAME,UAAU,IAAInC,iBAAiB;wBAAEoC,QAAQhB;wBAAQiB,KAAKP;oBAAI;oBAChE,MAAMQ,YAAY,MAAMrC,aACtB,qCAAqC;oBACrCqB,oBACAa,SACA,OAAOZ,oBAAoB,WAAWA,kBAAkB;wBAAEgB,WAAW;oBAAK;oBAE5E,OAAOC,SAASC,QAAQ,CAACH;gBAC3B;YACF;YAEA7B,SAAS,MAAMa,mBAAmBoB,SAAS,CAAC;gBAC1CN,QAAQhB;gBACRiB,KAAKP;YACP;YAEA,IAAI,CAACrB,OAAOC,IAAI,EAAE;gBAChB,OAAO,IAAI8B,SAAS,MAAM;oBAAEG,QAAQ;oBAAKC,YAAY;gBAAY;YACnE;YAEA,MAAMC,kBAAkBrB,IAAIsB,OAAO,CAACC,GAAG,CAAC,WAAWvB,IAAIsB,OAAO,CAACC,GAAG,CAAC;YACnE,MAAMC,aAAavC,OAAOwC,IAAI;YAE9B,IAAIJ,mBAAmBA,oBAAoBG,YAAY;gBACrD,OAAO,IAAIR,SAAS,MAAM;oBACxBM,SAAS,IAAII,QAAQ;wBACnB,iBAAiBC,OAAO1C,OAAO2C,YAAY;wBAC3C,kBAAkBD,OAAO1C,OAAO4C,aAAa;wBAC7C,gBAAgBF,OAAO1C,OAAO6C,WAAW;wBACzCL,MAAME,OAAO1C,OAAOwC,IAAI;oBAC1B;oBACAN,QAAQ;gBACV;YACF;YAEA,oDAAoD;YACpD,IAAIlC,OAAOC,IAAI,IAAIN,qBAAqBK,OAAOC,IAAI,GAAG;gBACpD,MAAM6C,SAAS9C,OAAOC,IAAI;gBAC1B6C,OAAOC,EAAE,CAAC,SAAS,CAACC;oBAClBjC,IAAIkC,OAAO,CAACC,MAAM,CAACC,KAAK,CAAC;wBACvBH;wBACA3B;wBACA+B,KAAK;oBACP;oBACAN,OAAOhD,OAAO;gBAChB;YACF;YAEA,MAAMuD,aAAa,MAAMnD,eAAeF,OAAOC,IAAI;YAEnD,OAAO,IAAI8B,SAASsB,YAAY;gBAC9BhB,SAAS,IAAII,QAAQ;oBACnB,iBAAiBC,OAAO1C,OAAO2C,YAAY;oBAC3C,kBAAkBD,OAAO1C,OAAO4C,aAAa;oBAC7C,gBAAgBF,OAAO1C,OAAO6C,WAAW;oBACzCL,MAAME,OAAO1C,OAAOwC,IAAI;gBAC1B;gBACAN,QAAQ;YACV;QACF,EAAE,OAAOc,KAAK;YACZjC,IAAIkC,OAAO,CAACC,MAAM,CAACC,KAAK,CAACH;YACzB,OAAO,IAAIjB,SAAS,yBAAyB;gBAAEG,QAAQ;YAAI;QAC7D,SAAU;YACRnC,cAAcC;QAChB;IACF;AACF,EAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@payloadcms/storage-s3",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.43.0-internal.c5bbc84",
|
|
4
4
|
"description": "Payload storage adapter for Amazon S3",
|
|
5
5
|
"homepage": "https://payloadcms.com",
|
|
6
6
|
"repository": {
|
|
@@ -40,14 +40,14 @@
|
|
|
40
40
|
"@aws-sdk/client-s3": "^3.614.0",
|
|
41
41
|
"@aws-sdk/lib-storage": "^3.614.0",
|
|
42
42
|
"@aws-sdk/s3-request-presigner": "^3.614.0",
|
|
43
|
-
"@payloadcms/plugin-cloud-storage": "3.
|
|
43
|
+
"@payloadcms/plugin-cloud-storage": "3.43.0-internal.c5bbc84"
|
|
44
44
|
},
|
|
45
45
|
"devDependencies": {
|
|
46
46
|
"@smithy/node-http-handler": "4.0.3",
|
|
47
|
-
"payload": "3.
|
|
47
|
+
"payload": "3.43.0-internal.c5bbc84"
|
|
48
48
|
},
|
|
49
49
|
"peerDependencies": {
|
|
50
|
-
"payload": "3.
|
|
50
|
+
"payload": "3.43.0-internal.c5bbc84"
|
|
51
51
|
},
|
|
52
52
|
"engines": {
|
|
53
53
|
"node": "^18.20.2 || >=20.9.0"
|