@payloadcms/storage-s3 3.0.0-alpha.63 → 3.0.0-beta.12
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/index.d.ts.map +1 -1
- package/dist/index.js +17 -1
- package/dist/index.js.map +1 -1
- package/package.json +4 -4
- package/src/index.ts +0 -109
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,EAGV,iBAAiB,EAElB,MAAM,wCAAwC,CAAA;AAC/C,OAAO,KAAK,EAAU,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAEpD,OAAO,KAAK,GAAG,MAAM,oBAAoB,CAAA;AAQzC,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IAEH,GAAG,CAAC,EAAE,SAAS,GAAG,aAAa,CAAA;IAC/B;;;;OAIG;IAEH,MAAM,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,iBAAiB,EAAE,SAAS,CAAC,GAAG,IAAI,CAAC,CAAA;IACtE;;;;OAIG;IACH,MAAM,EAAE,GAAG,CAAC,cAAc,CAAA;IAE1B;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAE7B;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,CAAA;AAED,KAAK,eAAe,GAAG,CAAC,aAAa,EAAE,gBAAgB,KAAK,MAAM,CAAA;AAElE,eAAO,MAAM,SAAS,EAAE,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAGV,iBAAiB,EAElB,MAAM,wCAAwC,CAAA;AAC/C,OAAO,KAAK,EAAU,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAEpD,OAAO,KAAK,GAAG,MAAM,oBAAoB,CAAA;AAQzC,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IAEH,GAAG,CAAC,EAAE,SAAS,GAAG,aAAa,CAAA;IAC/B;;;;OAIG;IAEH,MAAM,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,iBAAiB,EAAE,SAAS,CAAC,GAAG,IAAI,CAAC,CAAA;IACtE;;;;OAIG;IACH,MAAM,EAAE,GAAG,CAAC,cAAc,CAAA;IAE1B;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAE7B;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,CAAA;AAED,KAAK,eAAe,GAAG,CAAC,aAAa,EAAE,gBAAgB,KAAK,MAAM,CAAA;AAElE,eAAO,MAAM,SAAS,EAAE,eA4CrB,CAAA"}
|
package/dist/index.js
CHANGED
|
@@ -17,9 +17,25 @@ export const s3Storage = (s3StorageOptions)=>(incomingConfig)=>{
|
|
|
17
17
|
adapter
|
|
18
18
|
}
|
|
19
19
|
}), {});
|
|
20
|
+
// Set disableLocalStorage: true for collections specified in the plugin options
|
|
21
|
+
const config = {
|
|
22
|
+
...incomingConfig,
|
|
23
|
+
collections: (incomingConfig.collections || []).map((collection)=>{
|
|
24
|
+
if (!collectionsWithAdapter[collection.slug]) {
|
|
25
|
+
return collection;
|
|
26
|
+
}
|
|
27
|
+
return {
|
|
28
|
+
...collection,
|
|
29
|
+
upload: {
|
|
30
|
+
...typeof collection.upload === 'object' ? collection.upload : {},
|
|
31
|
+
disableLocalStorage: true
|
|
32
|
+
}
|
|
33
|
+
};
|
|
34
|
+
})
|
|
35
|
+
};
|
|
20
36
|
return cloudStorage({
|
|
21
37
|
collections: collectionsWithAdapter
|
|
22
|
-
})(
|
|
38
|
+
})(config);
|
|
23
39
|
};
|
|
24
40
|
function s3StorageInternal({ acl, bucket, config = {} }) {
|
|
25
41
|
return ({ collection, prefix })=>{
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type {\n Adapter,\n PluginOptions as CloudStoragePluginOptions,\n CollectionOptions,\n GeneratedAdapter,\n} from '@payloadcms/plugin-cloud-storage/types'\nimport type { Config, Plugin } from 'payload/config'\n\nimport * as AWS from '@aws-sdk/client-s3'\nimport { cloudStorage } from '@payloadcms/plugin-cloud-storage'\n\nimport { getGenerateURL } from './generateURL.js'\nimport { getHandleDelete } from './handleDelete.js'\nimport { getHandleUpload } from './handleUpload.js'\nimport { getHandler } from './staticHandler.js'\n\nexport type S3StorageOptions = {\n /**\n * Access control list for uploaded files.\n */\n\n acl?: 'private' | 'public-read'\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 * Collection options to apply the S3 adapter to.\n */\n collections: Record<string, Omit<CollectionOptions, 'adapter'> | true>\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\ntype S3StoragePlugin = (storageS3Args: S3StorageOptions) => Plugin\n\nexport const s3Storage: S3StoragePlugin =\n (s3StorageOptions: S3StorageOptions) =>\n (incomingConfig: Config): Config => {\n if (s3StorageOptions.enabled === false) {\n return incomingConfig\n }\n\n const adapter = s3StorageInternal(s3StorageOptions)\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,\n },\n }),\n {} as Record<string, CollectionOptions>,\n )\n\n return cloudStorage({\n collections: collectionsWithAdapter,\n })(
|
|
1
|
+
{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type {\n Adapter,\n PluginOptions as CloudStoragePluginOptions,\n CollectionOptions,\n GeneratedAdapter,\n} from '@payloadcms/plugin-cloud-storage/types'\nimport type { Config, Plugin } from 'payload/config'\n\nimport * as AWS from '@aws-sdk/client-s3'\nimport { cloudStorage } from '@payloadcms/plugin-cloud-storage'\n\nimport { getGenerateURL } from './generateURL.js'\nimport { getHandleDelete } from './handleDelete.js'\nimport { getHandleUpload } from './handleUpload.js'\nimport { getHandler } from './staticHandler.js'\n\nexport type S3StorageOptions = {\n /**\n * Access control list for uploaded files.\n */\n\n acl?: 'private' | 'public-read'\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 * Collection options to apply the S3 adapter to.\n */\n collections: Record<string, Omit<CollectionOptions, 'adapter'> | true>\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\ntype S3StoragePlugin = (storageS3Args: S3StorageOptions) => Plugin\n\nexport const s3Storage: S3StoragePlugin =\n (s3StorageOptions: S3StorageOptions) =>\n (incomingConfig: Config): Config => {\n if (s3StorageOptions.enabled === false) {\n return incomingConfig\n }\n\n const adapter = s3StorageInternal(s3StorageOptions)\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,\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 cloudStorage({\n collections: collectionsWithAdapter,\n })(config)\n }\n\nfunction s3StorageInternal({ acl, bucket, config = {} }: S3StorageOptions): Adapter {\n return ({ collection, prefix }): GeneratedAdapter => {\n let storageClient: AWS.S3 | null = null\n const getStorageClient: () => AWS.S3 = () => {\n if (storageClient) return storageClient\n storageClient = new AWS.S3(config)\n return storageClient\n }\n\n return {\n generateURL: getGenerateURL({ bucket, config }),\n handleDelete: getHandleDelete({ bucket, getStorageClient }),\n handleUpload: getHandleUpload({\n acl,\n bucket,\n collection,\n getStorageClient,\n prefix,\n }),\n staticHandler: getHandler({ bucket, collection, getStorageClient }),\n }\n }\n}\n"],"names":["AWS","cloudStorage","getGenerateURL","getHandleDelete","getHandleUpload","getHandler","s3Storage","s3StorageOptions","incomingConfig","enabled","adapter","s3StorageInternal","collectionsWithAdapter","Object","entries","collections","reduce","acc","slug","collOptions","config","map","collection","upload","disableLocalStorage","acl","bucket","prefix","storageClient","getStorageClient","S3","generateURL","handleDelete","handleUpload","staticHandler"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":"AAQA,YAAYA,SAAS,qBAAoB;AACzC,SAASC,YAAY,QAAQ,mCAAkC;AAE/D,SAASC,cAAc,QAAQ,mBAAkB;AACjD,SAASC,eAAe,QAAQ,oBAAmB;AACnD,SAASC,eAAe,QAAQ,oBAAmB;AACnD,SAASC,UAAU,QAAQ,qBAAoB;AA4C/C,OAAO,MAAMC,YACX,CAACC,mBACD,CAACC;QACC,IAAID,iBAAiBE,OAAO,KAAK,OAAO;YACtC,OAAOD;QACT;QAEA,MAAME,UAAUC,kBAAkBJ;QAElC,+CAA+C;QAC/C,MAAMK,yBAAmEC,OAAOC,OAAO,CACrFP,iBAAiBQ,WAAW,EAC5BC,MAAM,CACN,CAACC,KAAK,CAACC,MAAMC,YAAY,GAAM,CAAA;gBAC7B,GAAGF,GAAG;gBACN,CAACC,KAAK,EAAE;oBACN,GAAIC,gBAAgB,OAAO,CAAC,IAAIA,WAAW;oBAC3CT;gBACF;YACF,CAAA,GACA,CAAC;QAGH,gFAAgF;QAChF,MAAMU,SAAS;YACb,GAAGZ,cAAc;YACjBO,aAAa,AAACP,CAAAA,eAAeO,WAAW,IAAI,EAAE,AAAD,EAAGM,GAAG,CAAC,CAACC;gBACnD,IAAI,CAACV,sBAAsB,CAACU,WAAWJ,IAAI,CAAC,EAAE;oBAC5C,OAAOI;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,OAAOvB,aAAa;YAClBc,aAAaH;QACf,GAAGQ;IACL,EAAC;AAEH,SAAST,kBAAkB,EAAEc,GAAG,EAAEC,MAAM,EAAEN,SAAS,CAAC,CAAC,EAAoB;IACvE,OAAO,CAAC,EAAEE,UAAU,EAAEK,MAAM,EAAE;QAC5B,IAAIC,gBAA+B;QACnC,MAAMC,mBAAiC;YACrC,IAAID,eAAe,OAAOA;YAC1BA,gBAAgB,IAAI5B,IAAI8B,EAAE,CAACV;YAC3B,OAAOQ;QACT;QAEA,OAAO;YACLG,aAAa7B,eAAe;gBAAEwB;gBAAQN;YAAO;YAC7CY,cAAc7B,gBAAgB;gBAAEuB;gBAAQG;YAAiB;YACzDI,cAAc7B,gBAAgB;gBAC5BqB;gBACAC;gBACAJ;gBACAO;gBACAF;YACF;YACAO,eAAe7B,WAAW;gBAAEqB;gBAAQJ;gBAAYO;YAAiB;QACnE;IACF;AACF"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@payloadcms/storage-s3",
|
|
3
|
-
"version": "3.0.0-
|
|
3
|
+
"version": "3.0.0-beta.12",
|
|
4
4
|
"description": "Payload storage adapter for Amazon S3",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -21,15 +21,15 @@
|
|
|
21
21
|
}
|
|
22
22
|
},
|
|
23
23
|
"dependencies": {
|
|
24
|
-
"@payloadcms/plugin-cloud-storage": "3.0.0-
|
|
24
|
+
"@payloadcms/plugin-cloud-storage": "3.0.0-beta.12"
|
|
25
25
|
},
|
|
26
26
|
"devDependencies": {
|
|
27
27
|
"@aws-sdk/client-s3": "^3.525.0",
|
|
28
28
|
"@aws-sdk/lib-storage": "^3.525.0",
|
|
29
|
-
"payload": "3.0.0-
|
|
29
|
+
"payload": "3.0.0-beta.12"
|
|
30
30
|
},
|
|
31
31
|
"peerDependencies": {
|
|
32
|
-
"payload": "3.0.0-
|
|
32
|
+
"payload": "3.0.0-beta.12"
|
|
33
33
|
},
|
|
34
34
|
"engines": {
|
|
35
35
|
"node": ">=18.20.2"
|
package/src/index.ts
DELETED
|
@@ -1,109 +0,0 @@
|
|
|
1
|
-
import type {
|
|
2
|
-
Adapter,
|
|
3
|
-
PluginOptions as CloudStoragePluginOptions,
|
|
4
|
-
CollectionOptions,
|
|
5
|
-
GeneratedAdapter,
|
|
6
|
-
} from '@payloadcms/plugin-cloud-storage/types'
|
|
7
|
-
import type { Config, Plugin } from 'payload/config'
|
|
8
|
-
|
|
9
|
-
import * as AWS from '@aws-sdk/client-s3'
|
|
10
|
-
import { cloudStorage } from '@payloadcms/plugin-cloud-storage'
|
|
11
|
-
|
|
12
|
-
import { getGenerateURL } from './generateURL.js'
|
|
13
|
-
import { getHandleDelete } from './handleDelete.js'
|
|
14
|
-
import { getHandleUpload } from './handleUpload.js'
|
|
15
|
-
import { getHandler } from './staticHandler.js'
|
|
16
|
-
|
|
17
|
-
export type S3StorageOptions = {
|
|
18
|
-
/**
|
|
19
|
-
* Access control list for uploaded files.
|
|
20
|
-
*/
|
|
21
|
-
|
|
22
|
-
acl?: 'private' | 'public-read'
|
|
23
|
-
/**
|
|
24
|
-
* Bucket name to upload files to.
|
|
25
|
-
*
|
|
26
|
-
* Must follow [AWS S3 bucket naming conventions](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html).
|
|
27
|
-
*/
|
|
28
|
-
|
|
29
|
-
bucket: string
|
|
30
|
-
|
|
31
|
-
/**
|
|
32
|
-
* Collection options to apply the S3 adapter to.
|
|
33
|
-
*/
|
|
34
|
-
collections: Record<string, Omit<CollectionOptions, 'adapter'> | true>
|
|
35
|
-
/**
|
|
36
|
-
* AWS S3 client configuration. Highly dependent on your AWS setup.
|
|
37
|
-
*
|
|
38
|
-
* [AWS.S3ClientConfig Docs](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-s3/interfaces/s3clientconfig.html)
|
|
39
|
-
*/
|
|
40
|
-
config: AWS.S3ClientConfig
|
|
41
|
-
|
|
42
|
-
/**
|
|
43
|
-
* Whether or not to disable local storage
|
|
44
|
-
*
|
|
45
|
-
* @default true
|
|
46
|
-
*/
|
|
47
|
-
disableLocalStorage?: boolean
|
|
48
|
-
|
|
49
|
-
/**
|
|
50
|
-
* Whether or not to enable the plugin
|
|
51
|
-
*
|
|
52
|
-
* Default: true
|
|
53
|
-
*/
|
|
54
|
-
enabled?: boolean
|
|
55
|
-
}
|
|
56
|
-
|
|
57
|
-
type S3StoragePlugin = (storageS3Args: S3StorageOptions) => Plugin
|
|
58
|
-
|
|
59
|
-
export const s3Storage: S3StoragePlugin =
|
|
60
|
-
(s3StorageOptions: S3StorageOptions) =>
|
|
61
|
-
(incomingConfig: Config): Config => {
|
|
62
|
-
if (s3StorageOptions.enabled === false) {
|
|
63
|
-
return incomingConfig
|
|
64
|
-
}
|
|
65
|
-
|
|
66
|
-
const adapter = s3StorageInternal(s3StorageOptions)
|
|
67
|
-
|
|
68
|
-
// Add adapter to each collection option object
|
|
69
|
-
const collectionsWithAdapter: CloudStoragePluginOptions['collections'] = Object.entries(
|
|
70
|
-
s3StorageOptions.collections,
|
|
71
|
-
).reduce(
|
|
72
|
-
(acc, [slug, collOptions]) => ({
|
|
73
|
-
...acc,
|
|
74
|
-
[slug]: {
|
|
75
|
-
...(collOptions === true ? {} : collOptions),
|
|
76
|
-
adapter,
|
|
77
|
-
},
|
|
78
|
-
}),
|
|
79
|
-
{} as Record<string, CollectionOptions>,
|
|
80
|
-
)
|
|
81
|
-
|
|
82
|
-
return cloudStorage({
|
|
83
|
-
collections: collectionsWithAdapter,
|
|
84
|
-
})(incomingConfig)
|
|
85
|
-
}
|
|
86
|
-
|
|
87
|
-
function s3StorageInternal({ acl, bucket, config = {} }: S3StorageOptions): Adapter {
|
|
88
|
-
return ({ collection, prefix }): GeneratedAdapter => {
|
|
89
|
-
let storageClient: AWS.S3 | null = null
|
|
90
|
-
const getStorageClient: () => AWS.S3 = () => {
|
|
91
|
-
if (storageClient) return storageClient
|
|
92
|
-
storageClient = new AWS.S3(config)
|
|
93
|
-
return storageClient
|
|
94
|
-
}
|
|
95
|
-
|
|
96
|
-
return {
|
|
97
|
-
generateURL: getGenerateURL({ bucket, config }),
|
|
98
|
-
handleDelete: getHandleDelete({ bucket, getStorageClient }),
|
|
99
|
-
handleUpload: getHandleUpload({
|
|
100
|
-
acl,
|
|
101
|
-
bucket,
|
|
102
|
-
collection,
|
|
103
|
-
getStorageClient,
|
|
104
|
-
prefix,
|
|
105
|
-
}),
|
|
106
|
-
staticHandler: getHandler({ bucket, collection, getStorageClient }),
|
|
107
|
-
}
|
|
108
|
-
}
|
|
109
|
-
}
|