@payloadcms/storage-s3 3.86.0-internal.ac46214 → 4.0.0-internal.1f9ae9a
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 +3 -3
- package/dist/adapter.d.ts.map +1 -1
- package/dist/adapter.js +13 -7
- package/dist/adapter.js.map +1 -1
- package/dist/client/S3ClientUploadHandler.d.ts.map +1 -1
- package/dist/generateSignedURL.d.ts +2 -2
- package/dist/generateSignedURL.d.ts.map +1 -1
- package/dist/generateSignedURL.js +2 -2
- package/dist/generateSignedURL.js.map +1 -1
- package/dist/index.d.ts +5 -5
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +93 -89
- package/dist/index.js.map +1 -1
- package/package.json +5 -5
package/dist/adapter.d.ts
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
|
-
import type
|
|
1
|
+
import type { S3, S3ClientConfig } from '@aws-sdk/client-s3';
|
|
2
2
|
import type { Adapter, ClientUploadsConfig } from '@payloadcms/plugin-cloud-storage/types';
|
|
3
3
|
import type { SignedDownloadsConfig } from './getFile.js';
|
|
4
4
|
interface CreateS3AdapterArgs {
|
|
5
5
|
acl?: 'private' | 'public-read';
|
|
6
6
|
bucket: string;
|
|
7
7
|
clientUploads?: ClientUploadsConfig;
|
|
8
|
-
config:
|
|
9
|
-
getStorageClient: () =>
|
|
8
|
+
config: S3ClientConfig;
|
|
9
|
+
getStorageClient: () => S3;
|
|
10
10
|
signedDownloads: SignedDownloadsConfig;
|
|
11
11
|
useCompositePrefixes?: boolean;
|
|
12
12
|
}
|
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,
|
|
1
|
+
{"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../src/adapter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAC5D,OAAO,KAAK,EACV,OAAO,EACP,mBAAmB,EAEpB,MAAM,wCAAwC,CAAA;AAE/C,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAA;AAIzD,UAAU,mBAAmB;IAC3B,GAAG,CAAC,EAAE,SAAS,GAAG,aAAa,CAAA;IAC/B,MAAM,EAAE,MAAM,CAAA;IACd,aAAa,CAAC,EAAE,mBAAmB,CAAA;IACnC,MAAM,EAAE,cAAc,CAAA;IACtB,gBAAgB,EAAE,MAAM,EAAE,CAAA;IAC1B,eAAe,EAAE,qBAAqB,CAAA;IACtC,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B;AAED,wBAAgB,eAAe,CAAC,EAC9B,GAAG,EACH,MAAM,EACN,aAAa,EACb,MAAM,EACN,gBAAgB,EAChB,eAAe,EACf,oBAA4B,GAC7B,EAAE,mBAAmB,GAAG,OAAO,CAmE/B"}
|
package/dist/adapter.js
CHANGED
|
@@ -1,7 +1,4 @@
|
|
|
1
|
-
import { deleteFile } from './deleteFile.js';
|
|
2
1
|
import { generateURL } from './generateURL.js';
|
|
3
|
-
import { getFile } from './getFile.js';
|
|
4
|
-
import { uploadFile } from './uploadFile.js';
|
|
5
2
|
export function createS3Adapter({ acl, bucket, clientUploads, config, getStorageClient, signedDownloads, useCompositePrefixes = false }) {
|
|
6
3
|
return ({ collection, prefix = '' })=>({
|
|
7
4
|
name: 's3',
|
|
@@ -14,15 +11,21 @@ export function createS3Adapter({ acl, bucket, clientUploads, config, getStorage
|
|
|
14
11
|
prefix: urlPrefix,
|
|
15
12
|
useCompositePrefixes
|
|
16
13
|
}),
|
|
17
|
-
|
|
14
|
+
// Helpers below dynamic-import their @aws-sdk dependencies so the SDK only
|
|
15
|
+
// loads on the first request that actually needs it.
|
|
16
|
+
handleDelete: async ({ doc: { prefix: docPrefix = '' }, filename })=>{
|
|
17
|
+
const { deleteFile } = await import('./deleteFile.js');
|
|
18
|
+
return deleteFile({
|
|
18
19
|
bucket,
|
|
19
20
|
client: getStorageClient(),
|
|
20
21
|
collectionPrefix: prefix,
|
|
21
22
|
docPrefix,
|
|
22
23
|
filename,
|
|
23
24
|
useCompositePrefixes
|
|
24
|
-
})
|
|
25
|
+
});
|
|
26
|
+
},
|
|
25
27
|
handleUpload: async ({ data, file })=>{
|
|
28
|
+
const { uploadFile } = await import('./uploadFile.js');
|
|
26
29
|
await uploadFile({
|
|
27
30
|
acl,
|
|
28
31
|
bucket,
|
|
@@ -37,7 +40,9 @@ export function createS3Adapter({ acl, bucket, clientUploads, config, getStorage
|
|
|
37
40
|
});
|
|
38
41
|
return data;
|
|
39
42
|
},
|
|
40
|
-
staticHandler: (req, { headers, params: { clientUploadContext, filename, prefix: prefixQueryParam } })=>
|
|
43
|
+
staticHandler: async (req, { headers, params: { clientUploadContext, filename, prefix: prefixQueryParam } })=>{
|
|
44
|
+
const { getFile } = await import('./getFile.js');
|
|
45
|
+
return getFile({
|
|
41
46
|
bucket,
|
|
42
47
|
client: getStorageClient(),
|
|
43
48
|
clientUploadContext,
|
|
@@ -49,7 +54,8 @@ export function createS3Adapter({ acl, bucket, clientUploads, config, getStorage
|
|
|
49
54
|
req,
|
|
50
55
|
signedDownloads,
|
|
51
56
|
useCompositePrefixes
|
|
52
|
-
})
|
|
57
|
+
});
|
|
58
|
+
}
|
|
53
59
|
});
|
|
54
60
|
}
|
|
55
61
|
|
package/dist/adapter.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/adapter.ts"],"sourcesContent":["import type
|
|
1
|
+
{"version":3,"sources":["../src/adapter.ts"],"sourcesContent":["import type { S3, S3ClientConfig } from '@aws-sdk/client-s3'\nimport type {\n Adapter,\n ClientUploadsConfig,\n GeneratedAdapter,\n} from '@payloadcms/plugin-cloud-storage/types'\n\nimport type { SignedDownloadsConfig } from './getFile.js'\n\nimport { generateURL } from './generateURL.js'\n\ninterface CreateS3AdapterArgs {\n acl?: 'private' | 'public-read'\n bucket: string\n clientUploads?: ClientUploadsConfig\n config: S3ClientConfig\n getStorageClient: () => S3\n signedDownloads: SignedDownloadsConfig\n useCompositePrefixes?: boolean\n}\n\nexport function createS3Adapter({\n acl,\n bucket,\n clientUploads,\n config,\n getStorageClient,\n signedDownloads,\n useCompositePrefixes = false,\n}: CreateS3AdapterArgs): Adapter {\n return ({ collection, prefix = '' }): GeneratedAdapter => ({\n name: 's3',\n clientUploads,\n\n generateURL: ({ filename, prefix: urlPrefix = '' }) =>\n generateURL({\n bucket,\n collectionPrefix: prefix,\n endpoint: config.endpoint,\n filename,\n prefix: urlPrefix,\n useCompositePrefixes,\n }),\n\n // Helpers below dynamic-import their @aws-sdk dependencies so the SDK only\n // loads on the first request that actually needs it.\n handleDelete: async ({ doc: { prefix: docPrefix = '' }, filename }) => {\n const { deleteFile } = await import('./deleteFile.js')\n return deleteFile({\n bucket,\n client: getStorageClient(),\n collectionPrefix: prefix,\n docPrefix,\n filename,\n useCompositePrefixes,\n })\n },\n\n handleUpload: async ({ data, file }) => {\n const { uploadFile } = await import('./uploadFile.js')\n await uploadFile({\n acl,\n bucket,\n buffer: file.buffer,\n client: getStorageClient(),\n collectionPrefix: prefix,\n docPrefix: data.prefix,\n filename: file.filename,\n mimeType: file.mimeType,\n tempFilePath: file.tempFilePath,\n useCompositePrefixes,\n })\n\n return data\n },\n\n staticHandler: async (\n req,\n { headers, params: { clientUploadContext, filename, prefix: prefixQueryParam } },\n ) => {\n const { getFile } = await import('./getFile.js')\n return getFile({\n bucket,\n client: getStorageClient(),\n clientUploadContext,\n collection,\n collectionPrefix: prefix,\n filename,\n incomingHeaders: headers,\n prefixQueryParam,\n req,\n signedDownloads,\n useCompositePrefixes,\n })\n },\n })\n}\n"],"names":["generateURL","createS3Adapter","acl","bucket","clientUploads","config","getStorageClient","signedDownloads","useCompositePrefixes","collection","prefix","name","filename","urlPrefix","collectionPrefix","endpoint","handleDelete","doc","docPrefix","deleteFile","client","handleUpload","data","file","uploadFile","buffer","mimeType","tempFilePath","staticHandler","req","headers","params","clientUploadContext","prefixQueryParam","getFile","incomingHeaders"],"mappings":"AASA,SAASA,WAAW,QAAQ,mBAAkB;AAY9C,OAAO,SAASC,gBAAgB,EAC9BC,GAAG,EACHC,MAAM,EACNC,aAAa,EACbC,MAAM,EACNC,gBAAgB,EAChBC,eAAe,EACfC,uBAAuB,KAAK,EACR;IACpB,OAAO,CAAC,EAAEC,UAAU,EAAEC,SAAS,EAAE,EAAE,GAAwB,CAAA;YACzDC,MAAM;YACNP;YAEAJ,aAAa,CAAC,EAAEY,QAAQ,EAAEF,QAAQG,YAAY,EAAE,EAAE,GAChDb,YAAY;oBACVG;oBACAW,kBAAkBJ;oBAClBK,UAAUV,OAAOU,QAAQ;oBACzBH;oBACAF,QAAQG;oBACRL;gBACF;YAEF,2EAA2E;YAC3E,qDAAqD;YACrDQ,cAAc,OAAO,EAAEC,KAAK,EAAEP,QAAQQ,YAAY,EAAE,EAAE,EAAEN,QAAQ,EAAE;gBAChE,MAAM,EAAEO,UAAU,EAAE,GAAG,MAAM,MAAM,CAAC;gBACpC,OAAOA,WAAW;oBAChBhB;oBACAiB,QAAQd;oBACRQ,kBAAkBJ;oBAClBQ;oBACAN;oBACAJ;gBACF;YACF;YAEAa,cAAc,OAAO,EAAEC,IAAI,EAAEC,IAAI,EAAE;gBACjC,MAAM,EAAEC,UAAU,EAAE,GAAG,MAAM,MAAM,CAAC;gBACpC,MAAMA,WAAW;oBACftB;oBACAC;oBACAsB,QAAQF,KAAKE,MAAM;oBACnBL,QAAQd;oBACRQ,kBAAkBJ;oBAClBQ,WAAWI,KAAKZ,MAAM;oBACtBE,UAAUW,KAAKX,QAAQ;oBACvBc,UAAUH,KAAKG,QAAQ;oBACvBC,cAAcJ,KAAKI,YAAY;oBAC/BnB;gBACF;gBAEA,OAAOc;YACT;YAEAM,eAAe,OACbC,KACA,EAAEC,OAAO,EAAEC,QAAQ,EAAEC,mBAAmB,EAAEpB,QAAQ,EAAEF,QAAQuB,gBAAgB,EAAE,EAAE;gBAEhF,MAAM,EAAEC,OAAO,EAAE,GAAG,MAAM,MAAM,CAAC;gBACjC,OAAOA,QAAQ;oBACb/B;oBACAiB,QAAQd;oBACR0B;oBACAvB;oBACAK,kBAAkBJ;oBAClBE;oBACAuB,iBAAiBL;oBACjBG;oBACAJ;oBACAtB;oBACAC;gBACF;YACF;QACF,CAAA;AACF"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"S3ClientUploadHandler.d.ts","sourceRoot":"","sources":["../../src/client/S3ClientUploadHandler.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,qBAAqB;;;;;;;
|
|
1
|
+
{"version":3,"file":"S3ClientUploadHandler.d.ts","sourceRoot":"","sources":["../../src/client/S3ClientUploadHandler.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,qBAAqB;;;;;;;iCA6DhC,CAAA"}
|
|
@@ -1,13 +1,13 @@
|
|
|
1
|
+
import type { S3 } from '@aws-sdk/client-s3';
|
|
1
2
|
import type { ClientUploadsAccess } from '@payloadcms/plugin-cloud-storage/types';
|
|
2
3
|
import type { PayloadHandler } from 'payload';
|
|
3
|
-
import * as AWS from '@aws-sdk/client-s3';
|
|
4
4
|
import type { S3StorageOptions } from './index.js';
|
|
5
5
|
interface Args {
|
|
6
6
|
access?: ClientUploadsAccess;
|
|
7
7
|
acl?: 'private' | 'public-read';
|
|
8
8
|
bucket: string;
|
|
9
9
|
collections: S3StorageOptions['collections'];
|
|
10
|
-
getStorageClient: () =>
|
|
10
|
+
getStorageClient: () => S3;
|
|
11
11
|
useCompositePrefixes?: boolean;
|
|
12
12
|
}
|
|
13
13
|
export declare const getGenerateSignedURLHandler: ({ access, acl, bucket, collections, getStorageClient, useCompositePrefixes, }: Args) => PayloadHandler;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"generateSignedURL.d.ts","sourceRoot":"","sources":["../src/generateSignedURL.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,
|
|
1
|
+
{"version":3,"file":"generateSignedURL.d.ts","sourceRoot":"","sources":["../src/generateSignedURL.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,oBAAoB,CAAA;AAC5C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,wCAAwC,CAAA;AACjF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAO7C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAA;AAMlD,UAAU,IAAI;IACZ,MAAM,CAAC,EAAE,mBAAmB,CAAA;IAC5B,GAAG,CAAC,EAAE,SAAS,GAAG,aAAa,CAAA;IAC/B,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,EAAE,gBAAgB,CAAC,aAAa,CAAC,CAAA;IAC5C,gBAAgB,EAAE,MAAM,EAAE,CAAA;IAC1B,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B;AAID,eAAO,MAAM,2BAA2B,GAAI,+EAOzC,IAAI,KAAG,cA4ET,CAAA"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import
|
|
1
|
+
import { PutObjectCommand } from '@aws-sdk/client-s3';
|
|
2
2
|
import { getSignedUrl } from '@aws-sdk/s3-request-presigner';
|
|
3
3
|
import { resolveSignedURLKey } from '@payloadcms/plugin-cloud-storage/utilities';
|
|
4
4
|
import { APIError, Forbidden } from 'payload';
|
|
@@ -43,7 +43,7 @@ export const getGenerateSignedURLHandler = ({ access = defaultAccess, acl, bucke
|
|
|
43
43
|
// Still force S3 to validate
|
|
44
44
|
signableHeaders.add('content-length');
|
|
45
45
|
}
|
|
46
|
-
const url = await getSignedUrl(getStorageClient(), new
|
|
46
|
+
const url = await getSignedUrl(getStorageClient(), new PutObjectCommand({
|
|
47
47
|
ACL: acl,
|
|
48
48
|
Bucket: bucket,
|
|
49
49
|
ContentLength: filesizeLimit ? Math.min(filesize, filesizeLimit) : undefined,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/generateSignedURL.ts"],"sourcesContent":["import type { ClientUploadsAccess } from '@payloadcms/plugin-cloud-storage/types'\nimport type { PayloadHandler } from 'payload'\n\nimport
|
|
1
|
+
{"version":3,"sources":["../src/generateSignedURL.ts"],"sourcesContent":["import type { S3 } from '@aws-sdk/client-s3'\nimport type { ClientUploadsAccess } from '@payloadcms/plugin-cloud-storage/types'\nimport type { PayloadHandler } from 'payload'\n\nimport { PutObjectCommand } from '@aws-sdk/client-s3'\nimport { getSignedUrl } from '@aws-sdk/s3-request-presigner'\nimport { resolveSignedURLKey } from '@payloadcms/plugin-cloud-storage/utilities'\nimport { APIError, Forbidden } from 'payload'\n\nimport type { S3StorageOptions } from './index.js'\n\nconst bytesToMB = (bytes: number) => {\n return bytes / 1024 / 1024\n}\n\ninterface Args {\n access?: ClientUploadsAccess\n acl?: 'private' | 'public-read'\n bucket: string\n collections: S3StorageOptions['collections']\n getStorageClient: () => S3\n useCompositePrefixes?: boolean\n}\n\nconst defaultAccess: Args['access'] = ({ req }) => !!req.user\n\nexport const getGenerateSignedURLHandler = ({\n access = defaultAccess,\n acl,\n bucket,\n collections,\n getStorageClient,\n useCompositePrefixes = false,\n}: Args): PayloadHandler => {\n return async (req) => {\n if (!req.json) {\n throw new APIError('Content-Type expected to be application/json', 400)\n }\n\n let filesizeLimit = req.payload.config.upload.limits?.fileSize\n\n if (filesizeLimit === Infinity) {\n filesizeLimit = undefined\n }\n\n const { collectionSlug, docPrefix, filename, filesize, mimeType } = (await req.json()) as {\n collectionSlug: string\n docPrefix?: string\n filename: string\n filesize: number\n mimeType: string\n }\n\n const collectionS3Config = collections[collectionSlug]\n if (!collectionS3Config) {\n throw new APIError(`Collection ${collectionSlug} was not found in S3 options`)\n }\n\n const collectionPrefix =\n (typeof collectionS3Config === 'object' && collectionS3Config.prefix) || ''\n\n if (!(await access({ collectionSlug, req }))) {\n throw new Forbidden()\n }\n\n const { fileKey, sanitizedDocPrefix, sanitizedFilename } = await resolveSignedURLKey({\n collectionPrefix,\n collectionSlug,\n docPrefix,\n filename,\n req,\n useCompositePrefixes,\n })\n\n const signableHeaders = new Set<string>()\n\n if (filesizeLimit) {\n if (filesize > filesizeLimit) {\n throw new APIError(\n `Exceeded file size limit. Limit: ${bytesToMB(filesizeLimit).toFixed(2)}MB, got: ${bytesToMB(filesize).toFixed(2)}MB`,\n 400,\n )\n }\n\n // Still force S3 to validate\n signableHeaders.add('content-length')\n }\n\n const url = await getSignedUrl(\n getStorageClient(),\n new PutObjectCommand({\n ACL: acl,\n Bucket: bucket,\n ContentLength: filesizeLimit ? Math.min(filesize, filesizeLimit) : undefined,\n ContentType: mimeType,\n Key: fileKey,\n }),\n {\n expiresIn: 600,\n signableHeaders,\n },\n )\n\n return Response.json({\n docPrefix: sanitizedDocPrefix,\n filename: sanitizedFilename,\n url,\n })\n }\n}\n"],"names":["PutObjectCommand","getSignedUrl","resolveSignedURLKey","APIError","Forbidden","bytesToMB","bytes","defaultAccess","req","user","getGenerateSignedURLHandler","access","acl","bucket","collections","getStorageClient","useCompositePrefixes","json","filesizeLimit","payload","config","upload","limits","fileSize","Infinity","undefined","collectionSlug","docPrefix","filename","filesize","mimeType","collectionS3Config","collectionPrefix","prefix","fileKey","sanitizedDocPrefix","sanitizedFilename","signableHeaders","Set","toFixed","add","url","ACL","Bucket","ContentLength","Math","min","ContentType","Key","expiresIn","Response"],"mappings":"AAIA,SAASA,gBAAgB,QAAQ,qBAAoB;AACrD,SAASC,YAAY,QAAQ,gCAA+B;AAC5D,SAASC,mBAAmB,QAAQ,6CAA4C;AAChF,SAASC,QAAQ,EAAEC,SAAS,QAAQ,UAAS;AAI7C,MAAMC,YAAY,CAACC;IACjB,OAAOA,QAAQ,OAAO;AACxB;AAWA,MAAMC,gBAAgC,CAAC,EAAEC,GAAG,EAAE,GAAK,CAAC,CAACA,IAAIC,IAAI;AAE7D,OAAO,MAAMC,8BAA8B,CAAC,EAC1CC,SAASJ,aAAa,EACtBK,GAAG,EACHC,MAAM,EACNC,WAAW,EACXC,gBAAgB,EAChBC,uBAAuB,KAAK,EACvB;IACL,OAAO,OAAOR;QACZ,IAAI,CAACA,IAAIS,IAAI,EAAE;YACb,MAAM,IAAId,SAAS,gDAAgD;QACrE;QAEA,IAAIe,gBAAgBV,IAAIW,OAAO,CAACC,MAAM,CAACC,MAAM,CAACC,MAAM,EAAEC;QAEtD,IAAIL,kBAAkBM,UAAU;YAC9BN,gBAAgBO;QAClB;QAEA,MAAM,EAAEC,cAAc,EAAEC,SAAS,EAAEC,QAAQ,EAAEC,QAAQ,EAAEC,QAAQ,EAAE,GAAI,MAAMtB,IAAIS,IAAI;QAQnF,MAAMc,qBAAqBjB,WAAW,CAACY,eAAe;QACtD,IAAI,CAACK,oBAAoB;YACvB,MAAM,IAAI5B,SAAS,CAAC,WAAW,EAAEuB,eAAe,4BAA4B,CAAC;QAC/E;QAEA,MAAMM,mBACJ,AAAC,OAAOD,uBAAuB,YAAYA,mBAAmBE,MAAM,IAAK;QAE3E,IAAI,CAAE,MAAMtB,OAAO;YAAEe;YAAgBlB;QAAI,IAAK;YAC5C,MAAM,IAAIJ;QACZ;QAEA,MAAM,EAAE8B,OAAO,EAAEC,kBAAkB,EAAEC,iBAAiB,EAAE,GAAG,MAAMlC,oBAAoB;YACnF8B;YACAN;YACAC;YACAC;YACApB;YACAQ;QACF;QAEA,MAAMqB,kBAAkB,IAAIC;QAE5B,IAAIpB,eAAe;YACjB,IAAIW,WAAWX,eAAe;gBAC5B,MAAM,IAAIf,SACR,CAAC,iCAAiC,EAAEE,UAAUa,eAAeqB,OAAO,CAAC,GAAG,SAAS,EAAElC,UAAUwB,UAAUU,OAAO,CAAC,GAAG,EAAE,CAAC,EACrH;YAEJ;YAEA,6BAA6B;YAC7BF,gBAAgBG,GAAG,CAAC;QACtB;QAEA,MAAMC,MAAM,MAAMxC,aAChBc,oBACA,IAAIf,iBAAiB;YACnB0C,KAAK9B;YACL+B,QAAQ9B;YACR+B,eAAe1B,gBAAgB2B,KAAKC,GAAG,CAACjB,UAAUX,iBAAiBO;YACnEsB,aAAajB;YACbkB,KAAKd;QACP,IACA;YACEe,WAAW;YACXZ;QACF;QAGF,OAAOa,SAASjC,IAAI,CAAC;YACnBU,WAAWQ;YACXP,UAAUQ;YACVK;QACF;IACF;AACF,EAAC"}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
+
import type { S3ClientConfig } from '@aws-sdk/client-s3';
|
|
1
2
|
import type { ClientUploadsConfig, CollectionOptions } from '@payloadcms/plugin-cloud-storage/types';
|
|
2
|
-
import type {
|
|
3
|
-
import * as AWS from '@aws-sdk/client-s3';
|
|
3
|
+
import type { StorageAdapter, UploadCollectionSlug } from 'payload';
|
|
4
4
|
import type { SignedDownloadsConfig } from './getFile.js';
|
|
5
5
|
export type S3StorageOptions = {
|
|
6
6
|
/**
|
|
@@ -45,7 +45,7 @@ export type S3StorageOptions = {
|
|
|
45
45
|
*
|
|
46
46
|
* [AWS.S3ClientConfig Docs](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-s3/interfaces/s3clientconfig.html)
|
|
47
47
|
*/
|
|
48
|
-
config:
|
|
48
|
+
config: S3ClientConfig;
|
|
49
49
|
/**
|
|
50
50
|
* Whether or not to disable local storage
|
|
51
51
|
*
|
|
@@ -77,7 +77,7 @@ export type S3StorageOptions = {
|
|
|
77
77
|
*/
|
|
78
78
|
useCompositePrefixes?: boolean;
|
|
79
79
|
};
|
|
80
|
-
type
|
|
81
|
-
export declare const s3Storage:
|
|
80
|
+
type S3StorageFactory = (storageS3Args: S3StorageOptions) => StorageAdapter;
|
|
81
|
+
export declare const s3Storage: S3StorageFactory;
|
|
82
82
|
export {};
|
|
83
83
|
//# sourceMappingURL=index.d.ts.map
|
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;AAE/C,OAAO,KAAK,EAAU,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AACxD,OAAO,KAAK,EACV,mBAAmB,EAEnB,iBAAiB,EAClB,MAAM,wCAAwC,CAAA;AAE/C,OAAO,KAAK,EAAU,cAAc,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAM3E,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAA;AAKzD,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,GAAG,CAAC,EAAE,SAAS,GAAG,aAAa,CAAA;IAE/B;;;;;;;;OAQG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAE5B;;;;OAIG;IAEH,MAAM,EAAE,MAAM,CAAA;IAEd;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,mBAAmB,CAAA;IACnC;;OAEG;IACH,WAAW,EAAE,OAAO,CAClB,MAAM,CACJ,oBAAoB,EAClB,CAAC;QACC,eAAe,CAAC,EAAE,qBAAqB,CAAA;KACxC,GAAG,IAAI,CAAC,iBAAiB,EAAE,SAAS,CAAC,CAAC,GACvC,IAAI,CACP,CACF,CAAA;IACD;;;;OAIG;IACH,MAAM,EAAE,cAAc,CAAA;IAEtB;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAE7B;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;OAEG;IACH,eAAe,CAAC,EAAE,qBAAqB,CAAA;IACvC;;;;;;;;;;;;OAYG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B,CAAA;AAED,KAAK,gBAAgB,GAAG,CAAC,aAAa,EAAE,gBAAgB,KAAK,cAAc,CAAA;AAe3E,eAAO,MAAM,SAAS,EAAE,gBAuItB,CAAA"}
|
package/dist/index.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import
|
|
1
|
+
import { S3 } from '@aws-sdk/client-s3';
|
|
2
2
|
import { cloudStoragePlugin } from '@payloadcms/plugin-cloud-storage';
|
|
3
3
|
import { initClientUploads } from '@payloadcms/plugin-cloud-storage/utilities';
|
|
4
4
|
import { createS3Adapter } from './adapter.js';
|
|
@@ -14,100 +14,104 @@ const defaultRequestHandlerOpts = {
|
|
|
14
14
|
maxSockets: 100
|
|
15
15
|
}
|
|
16
16
|
};
|
|
17
|
-
export const s3Storage = (s3StorageOptions)=>(
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
17
|
+
export const s3Storage = (s3StorageOptions)=>({
|
|
18
|
+
name: 's3',
|
|
19
|
+
collections: Object.keys(s3StorageOptions.collections),
|
|
20
|
+
init: (incomingConfig)=>{
|
|
21
|
+
const cacheKey = s3StorageOptions.clientCacheKey || `s3:${s3StorageOptions.bucket}`;
|
|
22
|
+
const isPluginDisabled = s3StorageOptions.enabled === false;
|
|
23
|
+
const getStorageClient = ()=>{
|
|
24
|
+
if (s3Clients.has(cacheKey)) {
|
|
25
|
+
return s3Clients.get(cacheKey);
|
|
26
|
+
}
|
|
27
|
+
s3Clients.set(cacheKey, new S3({
|
|
28
|
+
requestHandler: defaultRequestHandlerOpts,
|
|
29
|
+
...s3StorageOptions.config ?? {}
|
|
30
|
+
}));
|
|
21
31
|
return s3Clients.get(cacheKey);
|
|
22
|
-
}
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
...s3StorageOptions.config ?? {}
|
|
26
|
-
}));
|
|
27
|
-
return s3Clients.get(cacheKey);
|
|
28
|
-
};
|
|
29
|
-
const isPluginDisabled = s3StorageOptions.enabled === false;
|
|
30
|
-
initClientUploads({
|
|
31
|
-
clientHandler: '@payloadcms/storage-s3/client#S3ClientUploadHandler',
|
|
32
|
-
collections: s3StorageOptions.collections,
|
|
33
|
-
config: incomingConfig,
|
|
34
|
-
enabled: !isPluginDisabled && Boolean(s3StorageOptions.clientUploads),
|
|
35
|
-
serverHandler: getGenerateSignedURLHandler({
|
|
36
|
-
access: typeof s3StorageOptions.clientUploads === 'object' ? s3StorageOptions.clientUploads.access : undefined,
|
|
37
|
-
acl: s3StorageOptions.acl,
|
|
38
|
-
bucket: s3StorageOptions.bucket,
|
|
32
|
+
};
|
|
33
|
+
initClientUploads({
|
|
34
|
+
clientHandler: '@payloadcms/storage-s3/client#S3ClientUploadHandler',
|
|
39
35
|
collections: s3StorageOptions.collections,
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
// Build collections with adapter: null since plugin is disabled
|
|
49
|
-
const collectionsWithoutAdapter = Object.entries(s3StorageOptions.collections).reduce((acc, [slug, collOptions])=>({
|
|
50
|
-
...acc,
|
|
51
|
-
[slug]: {
|
|
52
|
-
...collOptions === true ? {} : collOptions,
|
|
53
|
-
adapter: null
|
|
54
|
-
}
|
|
55
|
-
}), {});
|
|
56
|
-
return cloudStoragePlugin({
|
|
57
|
-
alwaysInsertFields: true,
|
|
58
|
-
collections: collectionsWithoutAdapter,
|
|
59
|
-
enabled: false,
|
|
36
|
+
config: incomingConfig,
|
|
37
|
+
enabled: !isPluginDisabled && Boolean(s3StorageOptions.clientUploads),
|
|
38
|
+
serverHandler: getGenerateSignedURLHandler({
|
|
39
|
+
access: typeof s3StorageOptions.clientUploads === 'object' ? s3StorageOptions.clientUploads.access : undefined,
|
|
40
|
+
acl: s3StorageOptions.acl,
|
|
41
|
+
bucket: s3StorageOptions.bucket,
|
|
42
|
+
collections: s3StorageOptions.collections,
|
|
43
|
+
getStorageClient,
|
|
60
44
|
useCompositePrefixes: s3StorageOptions.useCompositePrefixes
|
|
61
|
-
})
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
adapter: createS3Adapter({
|
|
80
|
-
acl: s3StorageOptions.acl,
|
|
81
|
-
bucket: s3StorageOptions.bucket,
|
|
82
|
-
clientUploads: s3StorageOptions.clientUploads,
|
|
83
|
-
config: s3StorageOptions.config,
|
|
84
|
-
getStorageClient,
|
|
85
|
-
signedDownloads: resolveSignedDownloads(slug),
|
|
45
|
+
}),
|
|
46
|
+
serverHandlerPath: '/storage-s3-generate-signed-url'
|
|
47
|
+
});
|
|
48
|
+
if (isPluginDisabled) {
|
|
49
|
+
// If alwaysInsertFields is true, still call cloudStoragePlugin to insert fields
|
|
50
|
+
if (s3StorageOptions.alwaysInsertFields) {
|
|
51
|
+
// Build collections with adapter: null since plugin is disabled
|
|
52
|
+
const collectionsWithoutAdapter = Object.entries(s3StorageOptions.collections).reduce((acc, [slug, collOptions])=>({
|
|
53
|
+
...acc,
|
|
54
|
+
[slug]: {
|
|
55
|
+
...collOptions === true ? {} : collOptions,
|
|
56
|
+
adapter: null
|
|
57
|
+
}
|
|
58
|
+
}), {});
|
|
59
|
+
return cloudStoragePlugin({
|
|
60
|
+
alwaysInsertFields: true,
|
|
61
|
+
collections: collectionsWithoutAdapter,
|
|
62
|
+
enabled: false,
|
|
86
63
|
useCompositePrefixes: s3StorageOptions.useCompositePrefixes
|
|
87
|
-
})
|
|
64
|
+
})(incomingConfig);
|
|
88
65
|
}
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
66
|
+
return incomingConfig;
|
|
67
|
+
}
|
|
68
|
+
// Determine signedDownloads for this collection
|
|
69
|
+
const resolveSignedDownloads = (slug)=>{
|
|
70
|
+
const collectionStorageConfig = s3StorageOptions.collections[slug];
|
|
71
|
+
let signedDownloads = typeof collectionStorageConfig === 'object' ? collectionStorageConfig.signedDownloads ?? false : null;
|
|
72
|
+
if (signedDownloads === null) {
|
|
73
|
+
signedDownloads = s3StorageOptions.signedDownloads ?? false;
|
|
96
74
|
}
|
|
97
|
-
return
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
75
|
+
return signedDownloads;
|
|
76
|
+
};
|
|
77
|
+
// Add adapter to each collection option object
|
|
78
|
+
const collectionsWithAdapter = Object.entries(s3StorageOptions.collections).reduce((acc, [slug, collOptions])=>({
|
|
79
|
+
...acc,
|
|
80
|
+
[slug]: {
|
|
81
|
+
...collOptions === true ? {} : collOptions,
|
|
82
|
+
adapter: createS3Adapter({
|
|
83
|
+
acl: s3StorageOptions.acl,
|
|
84
|
+
bucket: s3StorageOptions.bucket,
|
|
85
|
+
clientUploads: s3StorageOptions.clientUploads,
|
|
86
|
+
config: s3StorageOptions.config,
|
|
87
|
+
getStorageClient,
|
|
88
|
+
signedDownloads: resolveSignedDownloads(slug),
|
|
89
|
+
useCompositePrefixes: s3StorageOptions.useCompositePrefixes
|
|
90
|
+
})
|
|
91
|
+
}
|
|
92
|
+
}), {});
|
|
93
|
+
// Set disableLocalStorage: true for collections specified in the plugin options
|
|
94
|
+
const config = {
|
|
95
|
+
...incomingConfig,
|
|
96
|
+
collections: (incomingConfig.collections || []).map((collection)=>{
|
|
97
|
+
if (!collectionsWithAdapter[collection.slug]) {
|
|
98
|
+
return collection;
|
|
102
99
|
}
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
100
|
+
return {
|
|
101
|
+
...collection,
|
|
102
|
+
upload: {
|
|
103
|
+
...typeof collection.upload === 'object' ? collection.upload : {},
|
|
104
|
+
disableLocalStorage: true
|
|
105
|
+
}
|
|
106
|
+
};
|
|
107
|
+
})
|
|
108
|
+
};
|
|
109
|
+
return cloudStoragePlugin({
|
|
110
|
+
alwaysInsertFields: s3StorageOptions.alwaysInsertFields,
|
|
111
|
+
collections: collectionsWithAdapter,
|
|
112
|
+
useCompositePrefixes: s3StorageOptions.useCompositePrefixes
|
|
113
|
+
})(config);
|
|
114
|
+
}
|
|
115
|
+
});
|
|
112
116
|
|
|
113
117
|
//# sourceMappingURL=index.js.map
|
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 { NodeHttpHandlerOptions } from '@smithy/node-http-handler'\nimport type { Config, Plugin, UploadCollectionSlug } from 'payload'\n\nimport * as AWS from '@aws-sdk/client-s3'\nimport { cloudStoragePlugin } from '@payloadcms/plugin-cloud-storage'\nimport { initClientUploads } from '@payloadcms/plugin-cloud-storage/utilities'\n\nimport type { SignedDownloadsConfig } from './getFile.js'\n\nimport { createS3Adapter } from './adapter.js'\nimport { getGenerateSignedURLHandler } from './generateSignedURL.js'\n\nexport type S3StorageOptions = {\n /**\n * Access control list for uploaded files.\n */\n acl?: 'private' | 'public-read'\n\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 /**\n * Bucket name to upload files to.\n *\n * Must follow [AWS S3 bucket naming conventions](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html).\n */\n\n bucket: string\n\n /**\n * Optional cache key to identify the S3 storage client instance.\n * If not provided, a default key will be used.\n *\n * @default `s3:containerName`\n */\n clientCacheKey?: string\n\n /**\n * Do uploads directly on the client to bypass limits on Vercel. You must allow CORS PUT method for the bucket to your website.\n */\n clientUploads?: ClientUploadsConfig\n /**\n * Collection options to apply the S3 adapter to.\n */\n collections: Partial<\n Record<\n UploadCollectionSlug,\n | ({\n signedDownloads?: SignedDownloadsConfig\n } & Omit<CollectionOptions, 'adapter'>)\n | true\n >\n >\n /**\n * AWS S3 client configuration. Highly dependent on your AWS setup.\n *\n * [AWS.S3ClientConfig Docs](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-s3/interfaces/s3clientconfig.html)\n */\n config: AWS.S3ClientConfig\n\n /**\n * Whether or not to disable local storage\n *\n * @default true\n */\n disableLocalStorage?: boolean\n\n /**\n * Whether or not to enable the plugin\n *\n * Default: true\n */\n enabled?: boolean\n /**\n * Use pre-signed URLs for files downloading. Can be overriden per-collection.\n */\n signedDownloads?: SignedDownloadsConfig\n /**\n * When true, the collection-level prefix and document-level prefix are combined\n * (compositional). When false (default), document prefix overrides collection\n * prefix entirely.\n *\n * Example:\n * - collection prefix: `collection-prefix/`\n * - document prefix: `document-prefix/`\n * - resulting prefix with useCompositePrefixes=true: `collection-prefix/document-prefix/`\n * - resulting prefix with useCompositePrefixes=false: `document-prefix/`\n *\n * @default false\n */\n useCompositePrefixes?: boolean\n}\n\ntype S3StoragePlugin = (storageS3Args: S3StorageOptions) => Plugin\n\nconst s3Clients = new Map<string, AWS.S3>()\n\nconst defaultRequestHandlerOpts: NodeHttpHandlerOptions = {\n httpAgent: {\n keepAlive: true,\n maxSockets: 100,\n },\n httpsAgent: {\n keepAlive: true,\n maxSockets: 100,\n },\n}\n\nexport const s3Storage: S3StoragePlugin =\n (s3StorageOptions: S3StorageOptions) =>\n (incomingConfig: Config): Config => {\n const cacheKey = s3StorageOptions.clientCacheKey || `s3:${s3StorageOptions.bucket}`\n\n const getStorageClient: () => AWS.S3 = () => {\n if (s3Clients.has(cacheKey)) {\n return s3Clients.get(cacheKey)!\n }\n\n s3Clients.set(\n cacheKey,\n new AWS.S3({\n requestHandler: defaultRequestHandlerOpts,\n ...(s3StorageOptions.config ?? {}),\n }),\n )\n\n return s3Clients.get(cacheKey)!\n }\n\n const isPluginDisabled = s3StorageOptions.enabled === false\n\n initClientUploads({\n clientHandler: '@payloadcms/storage-s3/client#S3ClientUploadHandler',\n collections: s3StorageOptions.collections,\n config: incomingConfig,\n enabled: !isPluginDisabled && Boolean(s3StorageOptions.clientUploads),\n serverHandler: getGenerateSignedURLHandler({\n access:\n typeof s3StorageOptions.clientUploads === 'object'\n ? s3StorageOptions.clientUploads.access\n : undefined,\n acl: s3StorageOptions.acl,\n bucket: s3StorageOptions.bucket,\n collections: s3StorageOptions.collections,\n getStorageClient,\n useCompositePrefixes: s3StorageOptions.useCompositePrefixes,\n }),\n serverHandlerPath: '/storage-s3-generate-signed-url',\n })\n\n if (isPluginDisabled) {\n // If alwaysInsertFields is true, still call cloudStoragePlugin to insert fields\n if (s3StorageOptions.alwaysInsertFields) {\n // Build collections with adapter: null since plugin is disabled\n const collectionsWithoutAdapter: CloudStoragePluginOptions['collections'] = Object.entries(\n s3StorageOptions.collections,\n ).reduce(\n (acc, [slug, collOptions]) => ({\n ...acc,\n [slug]: {\n ...(collOptions === true ? {} : collOptions),\n adapter: null,\n },\n }),\n {} as Record<string, CollectionOptions>,\n )\n\n return cloudStoragePlugin({\n alwaysInsertFields: true,\n collections: collectionsWithoutAdapter,\n enabled: false,\n useCompositePrefixes: s3StorageOptions.useCompositePrefixes,\n })(incomingConfig)\n }\n\n return incomingConfig\n }\n\n // Determine signedDownloads for this collection\n const resolveSignedDownloads = (slug: string): SignedDownloadsConfig => {\n const collectionStorageConfig = s3StorageOptions.collections[slug]\n\n let signedDownloads: null | SignedDownloadsConfig =\n typeof collectionStorageConfig === 'object'\n ? (collectionStorageConfig.signedDownloads ?? false)\n : null\n\n if (signedDownloads === null) {\n signedDownloads = s3StorageOptions.signedDownloads ?? false\n }\n\n return signedDownloads\n }\n\n // Add adapter to each collection option object\n const collectionsWithAdapter: CloudStoragePluginOptions['collections'] = Object.entries(\n s3StorageOptions.collections,\n ).reduce(\n (acc, [slug, collOptions]) => ({\n ...acc,\n [slug]: {\n ...(collOptions === true ? {} : collOptions),\n adapter: createS3Adapter({\n acl: s3StorageOptions.acl,\n bucket: s3StorageOptions.bucket,\n clientUploads: s3StorageOptions.clientUploads,\n config: s3StorageOptions.config,\n getStorageClient,\n signedDownloads: resolveSignedDownloads(slug),\n useCompositePrefixes: s3StorageOptions.useCompositePrefixes,\n }),\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: s3StorageOptions.alwaysInsertFields,\n collections: collectionsWithAdapter,\n useCompositePrefixes: s3StorageOptions.useCompositePrefixes,\n })(config)\n }\n"],"names":["AWS","cloudStoragePlugin","initClientUploads","createS3Adapter","getGenerateSignedURLHandler","s3Clients","Map","defaultRequestHandlerOpts","httpAgent","keepAlive","maxSockets","httpsAgent","s3Storage","s3StorageOptions","incomingConfig","cacheKey","clientCacheKey","bucket","getStorageClient","has","get","set","S3","requestHandler","config","isPluginDisabled","enabled","clientHandler","collections","Boolean","clientUploads","serverHandler","access","undefined","acl","useCompositePrefixes","serverHandlerPath","alwaysInsertFields","collectionsWithoutAdapter","Object","entries","reduce","acc","slug","collOptions","adapter","resolveSignedDownloads","collectionStorageConfig","signedDownloads","collectionsWithAdapter","map","collection","upload","disableLocalStorage"],"mappings":"AAQA,YAAYA,SAAS,qBAAoB;AACzC,SAASC,kBAAkB,QAAQ,mCAAkC;AACrE,SAASC,iBAAiB,QAAQ,6CAA4C;AAI9E,SAASC,eAAe,QAAQ,eAAc;AAC9C,SAASC,2BAA2B,QAAQ,yBAAwB;AA6FpE,MAAMC,YAAY,IAAIC;AAEtB,MAAMC,4BAAoD;IACxDC,WAAW;QACTC,WAAW;QACXC,YAAY;IACd;IACAC,YAAY;QACVF,WAAW;QACXC,YAAY;IACd;AACF;AAEA,OAAO,MAAME,YACX,CAACC,mBACD,CAACC;QACC,MAAMC,WAAWF,iBAAiBG,cAAc,IAAI,CAAC,GAAG,EAAEH,iBAAiBI,MAAM,EAAE;QAEnF,MAAMC,mBAAiC;YACrC,IAAIb,UAAUc,GAAG,CAACJ,WAAW;gBAC3B,OAAOV,UAAUe,GAAG,CAACL;YACvB;YAEAV,UAAUgB,GAAG,CACXN,UACA,IAAIf,IAAIsB,EAAE,CAAC;gBACTC,gBAAgBhB;gBAChB,GAAIM,iBAAiBW,MAAM,IAAI,CAAC,CAAC;YACnC;YAGF,OAAOnB,UAAUe,GAAG,CAACL;QACvB;QAEA,MAAMU,mBAAmBZ,iBAAiBa,OAAO,KAAK;QAEtDxB,kBAAkB;YAChByB,eAAe;YACfC,aAAaf,iBAAiBe,WAAW;YACzCJ,QAAQV;YACRY,SAAS,CAACD,oBAAoBI,QAAQhB,iBAAiBiB,aAAa;YACpEC,eAAe3B,4BAA4B;gBACzC4B,QACE,OAAOnB,iBAAiBiB,aAAa,KAAK,WACtCjB,iBAAiBiB,aAAa,CAACE,MAAM,GACrCC;gBACNC,KAAKrB,iBAAiBqB,GAAG;gBACzBjB,QAAQJ,iBAAiBI,MAAM;gBAC/BW,aAAaf,iBAAiBe,WAAW;gBACzCV;gBACAiB,sBAAsBtB,iBAAiBsB,oBAAoB;YAC7D;YACAC,mBAAmB;QACrB;QAEA,IAAIX,kBAAkB;YACpB,gFAAgF;YAChF,IAAIZ,iBAAiBwB,kBAAkB,EAAE;gBACvC,gEAAgE;gBAChE,MAAMC,4BAAsEC,OAAOC,OAAO,CACxF3B,iBAAiBe,WAAW,EAC5Ba,MAAM,CACN,CAACC,KAAK,CAACC,MAAMC,YAAY,GAAM,CAAA;wBAC7B,GAAGF,GAAG;wBACN,CAACC,KAAK,EAAE;4BACN,GAAIC,gBAAgB,OAAO,CAAC,IAAIA,WAAW;4BAC3CC,SAAS;wBACX;oBACF,CAAA,GACA,CAAC;gBAGH,OAAO5C,mBAAmB;oBACxBoC,oBAAoB;oBACpBT,aAAaU;oBACbZ,SAAS;oBACTS,sBAAsBtB,iBAAiBsB,oBAAoB;gBAC7D,GAAGrB;YACL;YAEA,OAAOA;QACT;QAEA,gDAAgD;QAChD,MAAMgC,yBAAyB,CAACH;YAC9B,MAAMI,0BAA0BlC,iBAAiBe,WAAW,CAACe,KAAK;YAElE,IAAIK,kBACF,OAAOD,4BAA4B,WAC9BA,wBAAwBC,eAAe,IAAI,QAC5C;YAEN,IAAIA,oBAAoB,MAAM;gBAC5BA,kBAAkBnC,iBAAiBmC,eAAe,IAAI;YACxD;YAEA,OAAOA;QACT;QAEA,+CAA+C;QAC/C,MAAMC,yBAAmEV,OAAOC,OAAO,CACrF3B,iBAAiBe,WAAW,EAC5Ba,MAAM,CACN,CAACC,KAAK,CAACC,MAAMC,YAAY,GAAM,CAAA;gBAC7B,GAAGF,GAAG;gBACN,CAACC,KAAK,EAAE;oBACN,GAAIC,gBAAgB,OAAO,CAAC,IAAIA,WAAW;oBAC3CC,SAAS1C,gBAAgB;wBACvB+B,KAAKrB,iBAAiBqB,GAAG;wBACzBjB,QAAQJ,iBAAiBI,MAAM;wBAC/Ba,eAAejB,iBAAiBiB,aAAa;wBAC7CN,QAAQX,iBAAiBW,MAAM;wBAC/BN;wBACA8B,iBAAiBF,uBAAuBH;wBACxCR,sBAAsBtB,iBAAiBsB,oBAAoB;oBAC7D;gBACF;YACF,CAAA,GACA,CAAC;QAGH,gFAAgF;QAChF,MAAMX,SAAS;YACb,GAAGV,cAAc;YACjBc,aAAa,AAACd,CAAAA,eAAec,WAAW,IAAI,EAAE,AAAD,EAAGsB,GAAG,CAAC,CAACC;gBACnD,IAAI,CAACF,sBAAsB,CAACE,WAAWR,IAAI,CAAC,EAAE;oBAC5C,OAAOQ;gBACT;gBAEA,OAAO;oBACL,GAAGA,UAAU;oBACbC,QAAQ;wBACN,GAAI,OAAOD,WAAWC,MAAM,KAAK,WAAWD,WAAWC,MAAM,GAAG,CAAC,CAAC;wBAClEC,qBAAqB;oBACvB;gBACF;YACF;QACF;QAEA,OAAOpD,mBAAmB;YACxBoC,oBAAoBxB,iBAAiBwB,kBAAkB;YACvDT,aAAaqB;YACbd,sBAAsBtB,iBAAiBsB,oBAAoB;QAC7D,GAAGX;IACL,EAAC"}
|
|
1
|
+
{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type { S3ClientConfig } from '@aws-sdk/client-s3'\nimport type {\n ClientUploadsConfig,\n PluginOptions as CloudStoragePluginOptions,\n CollectionOptions,\n} from '@payloadcms/plugin-cloud-storage/types'\nimport type { NodeHttpHandlerOptions } from '@smithy/node-http-handler'\nimport type { Config, StorageAdapter, UploadCollectionSlug } from 'payload'\n\nimport { S3 } from '@aws-sdk/client-s3'\nimport { cloudStoragePlugin } from '@payloadcms/plugin-cloud-storage'\nimport { initClientUploads } from '@payloadcms/plugin-cloud-storage/utilities'\n\nimport type { SignedDownloadsConfig } from './getFile.js'\n\nimport { createS3Adapter } from './adapter.js'\nimport { getGenerateSignedURLHandler } from './generateSignedURL.js'\n\nexport type S3StorageOptions = {\n /**\n * Access control list for uploaded files.\n */\n acl?: 'private' | 'public-read'\n\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 /**\n * Bucket name to upload files to.\n *\n * Must follow [AWS S3 bucket naming conventions](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html).\n */\n\n bucket: string\n\n /**\n * Optional cache key to identify the S3 storage client instance.\n * If not provided, a default key will be used.\n *\n * @default `s3:containerName`\n */\n clientCacheKey?: string\n\n /**\n * Do uploads directly on the client to bypass limits on Vercel. You must allow CORS PUT method for the bucket to your website.\n */\n clientUploads?: ClientUploadsConfig\n /**\n * Collection options to apply the S3 adapter to.\n */\n collections: Partial<\n Record<\n UploadCollectionSlug,\n | ({\n signedDownloads?: SignedDownloadsConfig\n } & Omit<CollectionOptions, 'adapter'>)\n | true\n >\n >\n /**\n * AWS S3 client configuration. Highly dependent on your AWS setup.\n *\n * [AWS.S3ClientConfig Docs](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-s3/interfaces/s3clientconfig.html)\n */\n config: S3ClientConfig\n\n /**\n * Whether or not to disable local storage\n *\n * @default true\n */\n disableLocalStorage?: boolean\n\n /**\n * Whether or not to enable the plugin\n *\n * Default: true\n */\n enabled?: boolean\n /**\n * Use pre-signed URLs for files downloading. Can be overriden per-collection.\n */\n signedDownloads?: SignedDownloadsConfig\n /**\n * When true, the collection-level prefix and document-level prefix are combined\n * (compositional). When false (default), document prefix overrides collection\n * prefix entirely.\n *\n * Example:\n * - collection prefix: `collection-prefix/`\n * - document prefix: `document-prefix/`\n * - resulting prefix with useCompositePrefixes=true: `collection-prefix/document-prefix/`\n * - resulting prefix with useCompositePrefixes=false: `document-prefix/`\n *\n * @default false\n */\n useCompositePrefixes?: boolean\n}\n\ntype S3StorageFactory = (storageS3Args: S3StorageOptions) => StorageAdapter\n\nconst s3Clients = new Map<string, S3>()\n\nconst defaultRequestHandlerOpts: NodeHttpHandlerOptions = {\n httpAgent: {\n keepAlive: true,\n maxSockets: 100,\n },\n httpsAgent: {\n keepAlive: true,\n maxSockets: 100,\n },\n}\n\nexport const s3Storage: S3StorageFactory = (\n s3StorageOptions: S3StorageOptions,\n): StorageAdapter => ({\n name: 's3',\n collections: Object.keys(s3StorageOptions.collections),\n init: (incomingConfig: Config): Config => {\n const cacheKey = s3StorageOptions.clientCacheKey || `s3:${s3StorageOptions.bucket}`\n\n const isPluginDisabled = s3StorageOptions.enabled === false\n\n const getStorageClient: () => S3 = () => {\n if (s3Clients.has(cacheKey)) {\n return s3Clients.get(cacheKey)!\n }\n\n s3Clients.set(\n cacheKey,\n new S3({\n requestHandler: defaultRequestHandlerOpts,\n ...(s3StorageOptions.config ?? {}),\n }),\n )\n\n return s3Clients.get(cacheKey)!\n }\n\n initClientUploads({\n clientHandler: '@payloadcms/storage-s3/client#S3ClientUploadHandler',\n collections: s3StorageOptions.collections,\n config: incomingConfig,\n enabled: !isPluginDisabled && Boolean(s3StorageOptions.clientUploads),\n serverHandler: getGenerateSignedURLHandler({\n access:\n typeof s3StorageOptions.clientUploads === 'object'\n ? s3StorageOptions.clientUploads.access\n : undefined,\n acl: s3StorageOptions.acl,\n bucket: s3StorageOptions.bucket,\n collections: s3StorageOptions.collections,\n getStorageClient,\n useCompositePrefixes: s3StorageOptions.useCompositePrefixes,\n }),\n serverHandlerPath: '/storage-s3-generate-signed-url',\n })\n\n if (isPluginDisabled) {\n // If alwaysInsertFields is true, still call cloudStoragePlugin to insert fields\n if (s3StorageOptions.alwaysInsertFields) {\n // Build collections with adapter: null since plugin is disabled\n const collectionsWithoutAdapter: CloudStoragePluginOptions['collections'] = Object.entries(\n s3StorageOptions.collections,\n ).reduce(\n (acc, [slug, collOptions]) => ({\n ...acc,\n [slug]: {\n ...(collOptions === true ? {} : collOptions),\n adapter: null,\n },\n }),\n {} as Record<string, CollectionOptions>,\n )\n\n return cloudStoragePlugin({\n alwaysInsertFields: true,\n collections: collectionsWithoutAdapter,\n enabled: false,\n useCompositePrefixes: s3StorageOptions.useCompositePrefixes,\n })(incomingConfig)\n }\n\n return incomingConfig\n }\n\n // Determine signedDownloads for this collection\n const resolveSignedDownloads = (slug: string): SignedDownloadsConfig => {\n const collectionStorageConfig = s3StorageOptions.collections[slug]\n\n let signedDownloads: null | SignedDownloadsConfig =\n typeof collectionStorageConfig === 'object'\n ? (collectionStorageConfig.signedDownloads ?? false)\n : null\n\n if (signedDownloads === null) {\n signedDownloads = s3StorageOptions.signedDownloads ?? false\n }\n\n return signedDownloads\n }\n\n // Add adapter to each collection option object\n const collectionsWithAdapter: CloudStoragePluginOptions['collections'] = Object.entries(\n s3StorageOptions.collections,\n ).reduce(\n (acc, [slug, collOptions]) => ({\n ...acc,\n [slug]: {\n ...(collOptions === true ? {} : collOptions),\n adapter: createS3Adapter({\n acl: s3StorageOptions.acl,\n bucket: s3StorageOptions.bucket,\n clientUploads: s3StorageOptions.clientUploads,\n config: s3StorageOptions.config,\n getStorageClient,\n signedDownloads: resolveSignedDownloads(slug),\n useCompositePrefixes: s3StorageOptions.useCompositePrefixes,\n }),\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: s3StorageOptions.alwaysInsertFields,\n collections: collectionsWithAdapter,\n useCompositePrefixes: s3StorageOptions.useCompositePrefixes,\n })(config)\n },\n})\n"],"names":["S3","cloudStoragePlugin","initClientUploads","createS3Adapter","getGenerateSignedURLHandler","s3Clients","Map","defaultRequestHandlerOpts","httpAgent","keepAlive","maxSockets","httpsAgent","s3Storage","s3StorageOptions","name","collections","Object","keys","init","incomingConfig","cacheKey","clientCacheKey","bucket","isPluginDisabled","enabled","getStorageClient","has","get","set","requestHandler","config","clientHandler","Boolean","clientUploads","serverHandler","access","undefined","acl","useCompositePrefixes","serverHandlerPath","alwaysInsertFields","collectionsWithoutAdapter","entries","reduce","acc","slug","collOptions","adapter","resolveSignedDownloads","collectionStorageConfig","signedDownloads","collectionsWithAdapter","map","collection","upload","disableLocalStorage"],"mappings":"AASA,SAASA,EAAE,QAAQ,qBAAoB;AACvC,SAASC,kBAAkB,QAAQ,mCAAkC;AACrE,SAASC,iBAAiB,QAAQ,6CAA4C;AAI9E,SAASC,eAAe,QAAQ,eAAc;AAC9C,SAASC,2BAA2B,QAAQ,yBAAwB;AA6FpE,MAAMC,YAAY,IAAIC;AAEtB,MAAMC,4BAAoD;IACxDC,WAAW;QACTC,WAAW;QACXC,YAAY;IACd;IACAC,YAAY;QACVF,WAAW;QACXC,YAAY;IACd;AACF;AAEA,OAAO,MAAME,YAA8B,CACzCC,mBACoB,CAAA;QACpBC,MAAM;QACNC,aAAaC,OAAOC,IAAI,CAACJ,iBAAiBE,WAAW;QACrDG,MAAM,CAACC;YACL,MAAMC,WAAWP,iBAAiBQ,cAAc,IAAI,CAAC,GAAG,EAAER,iBAAiBS,MAAM,EAAE;YAEnF,MAAMC,mBAAmBV,iBAAiBW,OAAO,KAAK;YAEtD,MAAMC,mBAA6B;gBACjC,IAAIpB,UAAUqB,GAAG,CAACN,WAAW;oBAC3B,OAAOf,UAAUsB,GAAG,CAACP;gBACvB;gBAEAf,UAAUuB,GAAG,CACXR,UACA,IAAIpB,GAAG;oBACL6B,gBAAgBtB;oBAChB,GAAIM,iBAAiBiB,MAAM,IAAI,CAAC,CAAC;gBACnC;gBAGF,OAAOzB,UAAUsB,GAAG,CAACP;YACvB;YAEAlB,kBAAkB;gBAChB6B,eAAe;gBACfhB,aAAaF,iBAAiBE,WAAW;gBACzCe,QAAQX;gBACRK,SAAS,CAACD,oBAAoBS,QAAQnB,iBAAiBoB,aAAa;gBACpEC,eAAe9B,4BAA4B;oBACzC+B,QACE,OAAOtB,iBAAiBoB,aAAa,KAAK,WACtCpB,iBAAiBoB,aAAa,CAACE,MAAM,GACrCC;oBACNC,KAAKxB,iBAAiBwB,GAAG;oBACzBf,QAAQT,iBAAiBS,MAAM;oBAC/BP,aAAaF,iBAAiBE,WAAW;oBACzCU;oBACAa,sBAAsBzB,iBAAiByB,oBAAoB;gBAC7D;gBACAC,mBAAmB;YACrB;YAEA,IAAIhB,kBAAkB;gBACpB,gFAAgF;gBAChF,IAAIV,iBAAiB2B,kBAAkB,EAAE;oBACvC,gEAAgE;oBAChE,MAAMC,4BAAsEzB,OAAO0B,OAAO,CACxF7B,iBAAiBE,WAAW,EAC5B4B,MAAM,CACN,CAACC,KAAK,CAACC,MAAMC,YAAY,GAAM,CAAA;4BAC7B,GAAGF,GAAG;4BACN,CAACC,KAAK,EAAE;gCACN,GAAIC,gBAAgB,OAAO,CAAC,IAAIA,WAAW;gCAC3CC,SAAS;4BACX;wBACF,CAAA,GACA,CAAC;oBAGH,OAAO9C,mBAAmB;wBACxBuC,oBAAoB;wBACpBzB,aAAa0B;wBACbjB,SAAS;wBACTc,sBAAsBzB,iBAAiByB,oBAAoB;oBAC7D,GAAGnB;gBACL;gBAEA,OAAOA;YACT;YAEA,gDAAgD;YAChD,MAAM6B,yBAAyB,CAACH;gBAC9B,MAAMI,0BAA0BpC,iBAAiBE,WAAW,CAAC8B,KAAK;gBAElE,IAAIK,kBACF,OAAOD,4BAA4B,WAC9BA,wBAAwBC,eAAe,IAAI,QAC5C;gBAEN,IAAIA,oBAAoB,MAAM;oBAC5BA,kBAAkBrC,iBAAiBqC,eAAe,IAAI;gBACxD;gBAEA,OAAOA;YACT;YAEA,+CAA+C;YAC/C,MAAMC,yBAAmEnC,OAAO0B,OAAO,CACrF7B,iBAAiBE,WAAW,EAC5B4B,MAAM,CACN,CAACC,KAAK,CAACC,MAAMC,YAAY,GAAM,CAAA;oBAC7B,GAAGF,GAAG;oBACN,CAACC,KAAK,EAAE;wBACN,GAAIC,gBAAgB,OAAO,CAAC,IAAIA,WAAW;wBAC3CC,SAAS5C,gBAAgB;4BACvBkC,KAAKxB,iBAAiBwB,GAAG;4BACzBf,QAAQT,iBAAiBS,MAAM;4BAC/BW,eAAepB,iBAAiBoB,aAAa;4BAC7CH,QAAQjB,iBAAiBiB,MAAM;4BAC/BL;4BACAyB,iBAAiBF,uBAAuBH;4BACxCP,sBAAsBzB,iBAAiByB,oBAAoB;wBAC7D;oBACF;gBACF,CAAA,GACA,CAAC;YAGH,gFAAgF;YAChF,MAAMR,SAAS;gBACb,GAAGX,cAAc;gBACjBJ,aAAa,AAACI,CAAAA,eAAeJ,WAAW,IAAI,EAAE,AAAD,EAAGqC,GAAG,CAAC,CAACC;oBACnD,IAAI,CAACF,sBAAsB,CAACE,WAAWR,IAAI,CAAC,EAAE;wBAC5C,OAAOQ;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,OAAOtD,mBAAmB;gBACxBuC,oBAAoB3B,iBAAiB2B,kBAAkB;gBACvDzB,aAAaoC;gBACbb,sBAAsBzB,iBAAiByB,oBAAoB;YAC7D,GAAGR;QACL;IACF,CAAA,EAAE"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@payloadcms/storage-s3",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "4.0.0-internal.1f9ae9a",
|
|
4
4
|
"description": "Payload storage adapter for Amazon S3",
|
|
5
5
|
"homepage": "https://payloadcms.com",
|
|
6
6
|
"repository": {
|
|
@@ -40,17 +40,17 @@
|
|
|
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": "
|
|
43
|
+
"@payloadcms/plugin-cloud-storage": "4.0.0-internal.1f9ae9a"
|
|
44
44
|
},
|
|
45
45
|
"devDependencies": {
|
|
46
46
|
"@smithy/node-http-handler": "4.0.3",
|
|
47
|
-
"payload": "
|
|
47
|
+
"payload": "4.0.0-internal.1f9ae9a"
|
|
48
48
|
},
|
|
49
49
|
"peerDependencies": {
|
|
50
|
-
"payload": "
|
|
50
|
+
"payload": "4.0.0-internal.1f9ae9a"
|
|
51
51
|
},
|
|
52
52
|
"engines": {
|
|
53
|
-
"node": "
|
|
53
|
+
"node": ">=24.15.0"
|
|
54
54
|
},
|
|
55
55
|
"scripts": {
|
|
56
56
|
"build": "pnpm build:types && pnpm build:swc",
|