@payloadcms/plugin-cloud-storage 4.0.0-internal.c2b57ce → 4.0.0-internal.c6494b5

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.
Files changed (99) hide show
  1. package/LICENSE.md +1 -1
  2. package/README.md +2 -0
  3. package/dist/client/createClientUploadHandler.d.ts +8 -7
  4. package/dist/client/createClientUploadHandler.d.ts.map +1 -1
  5. package/dist/client/createClientUploadHandler.js +26 -22
  6. package/dist/client/createClientUploadHandler.js.map +1 -1
  7. package/dist/exports/client.d.ts +2 -0
  8. package/dist/exports/client.d.ts.map +1 -1
  9. package/dist/exports/client.js +2 -0
  10. package/dist/exports/client.js.map +1 -1
  11. package/dist/exports/utilities.d.ts +1 -2
  12. package/dist/exports/utilities.d.ts.map +1 -1
  13. package/dist/exports/utilities.js +1 -2
  14. package/dist/exports/utilities.js.map +1 -1
  15. package/dist/fields/getFields.d.ts +1 -5
  16. package/dist/fields/getFields.d.ts.map +1 -1
  17. package/dist/fields/getFields.js +118 -24
  18. package/dist/fields/getFields.js.map +1 -1
  19. package/dist/hooks/afterChange.d.ts +5 -1
  20. package/dist/hooks/afterChange.d.ts.map +1 -1
  21. package/dist/hooks/afterChange.js +140 -24
  22. package/dist/hooks/afterChange.js.map +1 -1
  23. package/dist/hooks/afterDelete.d.ts +3 -1
  24. package/dist/hooks/afterDelete.d.ts.map +1 -1
  25. package/dist/hooks/afterDelete.js +26 -4
  26. package/dist/hooks/afterDelete.js.map +1 -1
  27. package/dist/hooks/afterRead.d.ts +6 -1
  28. package/dist/hooks/afterRead.d.ts.map +1 -1
  29. package/dist/hooks/afterRead.js +34 -7
  30. package/dist/hooks/afterRead.js.map +1 -1
  31. package/dist/hooks/beforeChange.d.ts +2 -1
  32. package/dist/hooks/beforeChange.d.ts.map +1 -1
  33. package/dist/hooks/beforeChange.js +18 -4
  34. package/dist/hooks/beforeChange.js.map +1 -1
  35. package/dist/hooks/normalizeUploadPrefix.d.ts +11 -0
  36. package/dist/hooks/normalizeUploadPrefix.d.ts.map +1 -0
  37. package/dist/hooks/normalizeUploadPrefix.js +42 -0
  38. package/dist/hooks/normalizeUploadPrefix.js.map +1 -0
  39. package/dist/hooks/publicOriginalURL.d.ts +8 -0
  40. package/dist/hooks/publicOriginalURL.d.ts.map +1 -0
  41. package/dist/hooks/publicOriginalURL.js +34 -0
  42. package/dist/hooks/publicOriginalURL.js.map +1 -0
  43. package/dist/plugin.d.ts.map +1 -1
  44. package/dist/plugin.js +203 -128
  45. package/dist/plugin.js.map +1 -1
  46. package/dist/types.d.ts +60 -21
  47. package/dist/types.d.ts.map +1 -1
  48. package/dist/types.js.map +1 -1
  49. package/dist/utilities/buildPrefixWithObjectKey.d.ts +8 -0
  50. package/dist/utilities/buildPrefixWithObjectKey.d.ts.map +1 -0
  51. package/dist/utilities/buildPrefixWithObjectKey.js +13 -0
  52. package/dist/utilities/buildPrefixWithObjectKey.js.map +1 -0
  53. package/dist/utilities/buildStoragePathData.d.ts +49 -0
  54. package/dist/utilities/buildStoragePathData.d.ts.map +1 -0
  55. package/dist/utilities/buildStoragePathData.js +67 -0
  56. package/dist/utilities/buildStoragePathData.js.map +1 -0
  57. package/dist/utilities/createFileOperations.d.ts +13 -0
  58. package/dist/utilities/createFileOperations.d.ts.map +1 -0
  59. package/dist/utilities/createFileOperations.js +258 -0
  60. package/dist/utilities/createFileOperations.js.map +1 -0
  61. package/dist/utilities/getFilePrefix.d.ts +16 -11
  62. package/dist/utilities/getFilePrefix.d.ts.map +1 -1
  63. package/dist/utilities/getFilePrefix.js +86 -31
  64. package/dist/utilities/getFilePrefix.js.map +1 -1
  65. package/dist/utilities/getIncomingFiles.js +4 -4
  66. package/dist/utilities/getIncomingFiles.js.map +1 -1
  67. package/dist/utilities/getStorageLocationSelect.d.ts +9 -0
  68. package/dist/utilities/getStorageLocationSelect.d.ts.map +1 -0
  69. package/dist/utilities/getStorageLocationSelect.js +54 -0
  70. package/dist/utilities/getStorageLocationSelect.js.map +1 -0
  71. package/dist/utilities/resolveSignedURLKey.d.ts +13 -2
  72. package/dist/utilities/resolveSignedURLKey.d.ts.map +1 -1
  73. package/dist/utilities/resolveSignedURLKey.js +53 -11
  74. package/dist/utilities/resolveSignedURLKey.js.map +1 -1
  75. package/dist/utilities/sanitizePrefix.d.ts +1 -9
  76. package/dist/utilities/sanitizePrefix.d.ts.map +1 -1
  77. package/dist/utilities/sanitizePrefix.js +1 -21
  78. package/dist/utilities/sanitizePrefix.js.map +1 -1
  79. package/package.json +6 -6
  80. package/dist/admin/fields/getFields.d.ts +0 -17
  81. package/dist/admin/fields/getFields.d.ts.map +0 -1
  82. package/dist/admin/fields/getFields.js +0 -98
  83. package/dist/admin/fields/getFields.js.map +0 -1
  84. package/dist/admin/index.d.ts +0 -4
  85. package/dist/admin/index.d.ts.map +0 -1
  86. package/dist/admin/index.js +0 -34
  87. package/dist/admin/index.js.map +0 -1
  88. package/dist/utilities/getFileKey.d.ts +0 -22
  89. package/dist/utilities/getFileKey.d.ts.map +0 -1
  90. package/dist/utilities/getFileKey.js +0 -23
  91. package/dist/utilities/getFileKey.js.map +0 -1
  92. package/dist/utilities/getFileKey.spec.js +0 -174
  93. package/dist/utilities/getFileKey.spec.js.map +0 -1
  94. package/dist/utilities/getFilePrefix.spec.js +0 -105
  95. package/dist/utilities/getFilePrefix.spec.js.map +0 -1
  96. package/dist/utilities/initClientUploads.d.ts +0 -13
  97. package/dist/utilities/initClientUploads.d.ts.map +0 -1
  98. package/dist/utilities/initClientUploads.js +0 -63
  99. package/dist/utilities/initClientUploads.js.map +0 -1
@@ -0,0 +1 @@
1
+ {"version":3,"file":"publicOriginalURL.d.ts","sourceRoot":"","sources":["../../src/hooks/publicOriginalURL.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,uBAAuB,EAAE,gBAAgB,EAAwB,MAAM,SAAS,CAAA;AAE9F,OAAO,KAAK,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAIpE,eAAO,MAAM,wBAAwB,8CAKhC;IACD,OAAO,EAAE,gBAAgB,CAAA;IACzB,UAAU,EAAE,gBAAgB,CAAA;IAC5B,eAAe,CAAC,EAAE,eAAe,CAAA;CAClC,KAAG,uBAsBH,CAAA"}
@@ -0,0 +1,34 @@
1
+ import { buildPrefixWithObjectKey } from '../utilities/buildPrefixWithObjectKey.js';
2
+ export const getPublicOriginalURLHook = ({ adapter, collection, generateFileURL })=>async ({ doc })=>{
3
+ const upload = doc;
4
+ const filename = upload.original?.filename;
5
+ if (!filename) {
6
+ return doc;
7
+ }
8
+ if (upload.original?.url && !upload.original.url.startsWith('/')) {
9
+ return doc;
10
+ }
11
+ const prefix = buildPrefixWithObjectKey({
12
+ objectKey: upload.original?._objectKey,
13
+ prefix: upload.original?.prefix
14
+ });
15
+ const url = generateFileURL ? await generateFileURL({
16
+ collection,
17
+ filename,
18
+ prefix
19
+ }) : await adapter.generateURL?.({
20
+ collection,
21
+ data: upload,
22
+ filename,
23
+ prefix
24
+ });
25
+ return url ? {
26
+ ...doc,
27
+ original: {
28
+ ...upload.original,
29
+ url
30
+ }
31
+ } : doc;
32
+ };
33
+
34
+ //# sourceMappingURL=publicOriginalURL.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../src/hooks/publicOriginalURL.ts"],"sourcesContent":["import type { CollectionAfterReadHook, CollectionConfig, FileData, TypeWithID } from 'payload'\n\nimport type { GeneratedAdapter, GenerateFileURL } from '../types.js'\n\nimport { buildPrefixWithObjectKey } from '../utilities/buildPrefixWithObjectKey.js'\n\nexport const getPublicOriginalURLHook =\n ({\n adapter,\n collection,\n generateFileURL,\n }: {\n adapter: GeneratedAdapter\n collection: CollectionConfig\n generateFileURL?: GenerateFileURL\n }): CollectionAfterReadHook =>\n async ({ doc }) => {\n const upload = doc as { _objectKey?: string; prefix?: string } & FileData & TypeWithID\n const filename = upload.original?.filename\n\n if (!filename) {\n return doc\n }\n\n if (upload.original?.url && !upload.original.url.startsWith('/')) {\n return doc\n }\n\n const prefix = buildPrefixWithObjectKey({\n objectKey: upload.original?._objectKey,\n prefix: upload.original?.prefix,\n })\n const url = generateFileURL\n ? await generateFileURL({ collection, filename, prefix })\n : await adapter.generateURL?.({ collection, data: upload, filename, prefix })\n\n return url ? { ...doc, original: { ...upload.original, url } } : doc\n }\n"],"names":["buildPrefixWithObjectKey","getPublicOriginalURLHook","adapter","collection","generateFileURL","doc","upload","filename","original","url","startsWith","prefix","objectKey","_objectKey","generateURL","data"],"mappings":"AAIA,SAASA,wBAAwB,QAAQ,2CAA0C;AAEnF,OAAO,MAAMC,2BACX,CAAC,EACCC,OAAO,EACPC,UAAU,EACVC,eAAe,EAKhB,GACD,OAAO,EAAEC,GAAG,EAAE;QACZ,MAAMC,SAASD;QACf,MAAME,WAAWD,OAAOE,QAAQ,EAAED;QAElC,IAAI,CAACA,UAAU;YACb,OAAOF;QACT;QAEA,IAAIC,OAAOE,QAAQ,EAAEC,OAAO,CAACH,OAAOE,QAAQ,CAACC,GAAG,CAACC,UAAU,CAAC,MAAM;YAChE,OAAOL;QACT;QAEA,MAAMM,SAASX,yBAAyB;YACtCY,WAAWN,OAAOE,QAAQ,EAAEK;YAC5BF,QAAQL,OAAOE,QAAQ,EAAEG;QAC3B;QACA,MAAMF,MAAML,kBACR,MAAMA,gBAAgB;YAAED;YAAYI;YAAUI;QAAO,KACrD,MAAMT,QAAQY,WAAW,GAAG;YAAEX;YAAYY,MAAMT;YAAQC;YAAUI;QAAO;QAE7E,OAAOF,MAAM;YAAE,GAAGJ,GAAG;YAAEG,UAAU;gBAAE,GAAGF,OAAOE,QAAQ;gBAAEC;YAAI;QAAE,IAAIJ;IACnE,EAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAErC,OAAO,KAAK,EAAa,aAAa,EAAE,MAAM,YAAY,CAAA;AAgB1D,eAAO,MAAM,kBAAkB,GAC5B,eAAe,aAAa,MAC5B,gBAAgB,MAAM,KAAG,MAgLzB,CAAA"}
1
+ {"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAErC,OAAO,KAAK,EAAsB,aAAa,EAAE,MAAM,YAAY,CAAA;AAoBnE,eAAO,MAAM,kBAAkB,kBACb,aAAa,sBACZ,MAAM,KAAG,MA+PzB,CAAA"}
package/dist/plugin.js CHANGED
@@ -1,7 +1,11 @@
1
1
  import { getFields } from './fields/getFields.js';
2
2
  import { getAfterChangeHook } from './hooks/afterChange.js';
3
3
  import { getAfterDeleteHook } from './hooks/afterDelete.js';
4
+ import { getNormalizeUploadPrefixHook } from './hooks/normalizeUploadPrefix.js';
4
5
  import { getPreserveFileDataHook } from './hooks/preserveFileData.js';
6
+ import { getPublicOriginalURLHook } from './hooks/publicOriginalURL.js';
7
+ import { createFileOperations } from './utilities/createFileOperations.js';
8
+ import { getStorageLocationSelect } from './utilities/getStorageLocationSelect.js';
5
9
  // This plugin extends all targeted collections by offloading uploaded files
6
10
  // to cloud storage instead of solely storing files locally.
7
11
  // It is based on an adapter approach, where adapters can be written for any cloud provider.
@@ -9,148 +13,219 @@ import { getPreserveFileDataHook } from './hooks/preserveFileData.js';
9
13
  // 1. handleUpload, 2. handleDelete, 3. generateURL, 4. staticHandler
10
14
  // Optionally, the adapter can specify any Webpack config overrides if they are necessary.
11
15
  export const cloudStoragePlugin = (pluginOptions)=>(incomingConfig)=>{
12
- const { alwaysInsertFields, collections: allCollectionOptions, enabled, useCompositePrefixes } = pluginOptions;
16
+ const { collections: allCollectionOptions, enabled, useCompositePrefixes } = pluginOptions;
13
17
  const config = {
14
18
  ...incomingConfig
15
19
  };
16
- // If disabled but alwaysInsertFields is true, only insert fields without full plugin functionality
20
+ // If disabled, only insert fields (e.g. prefix) without full plugin functionality,
21
+ // so the collection schema stays consistent across environments.
17
22
  if (enabled === false) {
18
- if (alwaysInsertFields) {
19
- return {
20
- ...config,
21
- collections: (config.collections || []).map((existingCollection)=>{
22
- const options = allCollectionOptions[existingCollection.slug];
23
- if (options) {
24
- // If adapter is provided, use it to get fields
25
- const adapter = options.adapter ? options.adapter({
26
- collection: existingCollection,
27
- prefix: options.prefix
28
- }) : undefined;
29
- const fields = getFields({
30
- adapter,
31
- alwaysInsertFields: true,
32
- collection: existingCollection,
33
- disablePayloadAccessControl: options.disablePayloadAccessControl,
34
- generateFileURL: options.generateFileURL,
35
- prefix: options.prefix,
36
- useCompositePrefixes
37
- });
38
- return {
39
- ...existingCollection,
40
- fields
41
- };
42
- }
43
- return existingCollection;
44
- })
45
- };
46
- }
47
- return config;
23
+ return {
24
+ ...config,
25
+ collections: (config.collections || []).map((existingCollection)=>{
26
+ const options = allCollectionOptions[existingCollection.slug];
27
+ if (options) {
28
+ // If adapter is provided, use it to get fields
29
+ const adapter = options.adapter ? options.adapter({
30
+ collection: existingCollection,
31
+ prefix: options.prefix
32
+ }) : undefined;
33
+ const fields = getFields({
34
+ adapter,
35
+ collection: existingCollection,
36
+ disablePayloadAccessControl: options.disablePayloadAccessControl,
37
+ generateFileURL: options.generateFileURL,
38
+ prefix: options.prefix,
39
+ useCompositePrefixes
40
+ });
41
+ return {
42
+ ...existingCollection,
43
+ fields
44
+ };
45
+ }
46
+ return existingCollection;
47
+ })
48
+ };
48
49
  }
49
50
  const initFunctions = [];
50
- return {
51
- ...config,
52
- collections: (config.collections || []).map((existingCollection)=>{
53
- const options = allCollectionOptions[existingCollection.slug];
54
- if (options?.adapter) {
55
- const adapter = options.adapter({
56
- collection: existingCollection,
57
- prefix: options.prefix
58
- });
59
- if (adapter.onInit) {
60
- initFunctions.push(adapter.onInit);
51
+ const endpointPaths = new Map();
52
+ const collections = (config.collections || []).map((existingCollection)=>{
53
+ const options = allCollectionOptions[existingCollection.slug];
54
+ if (options?.adapter) {
55
+ const adapter = options.adapter({
56
+ collection: existingCollection,
57
+ prefix: options.prefix
58
+ });
59
+ if (adapter.onInit) {
60
+ initFunctions.push(adapter.onInit);
61
+ }
62
+ let uploadInstructions;
63
+ if (adapter.uploadInstructions) {
64
+ const { adminHandler, enabled, endpoint, ...instructions } = adapter.uploadInstructions;
65
+ let endpointPath = endpointPaths.get(options.adapter);
66
+ if (enabled && endpoint && !endpointPath) {
67
+ const endpointCount = config.endpoints?.filter(({ path })=>path?.startsWith(endpoint.path)).length || 0;
68
+ endpointPath = endpointCount ? `${endpoint.path}-${endpointCount}` : endpoint.path;
69
+ config.endpoints ??= [];
70
+ config.endpoints.push({
71
+ handler: endpoint.handler,
72
+ method: 'post',
73
+ path: endpointPath
74
+ });
75
+ endpointPaths.set(options.adapter, endpointPath);
61
76
  }
62
- const fields = getFields({
63
- adapter,
64
- collection: existingCollection,
65
- disablePayloadAccessControl: options.disablePayloadAccessControl,
66
- generateFileURL: options.generateFileURL,
67
- prefix: options.prefix,
68
- useCompositePrefixes
69
- });
70
- const handlers = [
71
- ...typeof existingCollection.upload === 'object' && Array.isArray(existingCollection.upload.handlers) ? existingCollection.upload.handlers : []
72
- ];
73
- if (!options.disablePayloadAccessControl) {
74
- handlers.push(adapter.staticHandler);
75
- // Else if disablePayloadAccessControl: true and clientUploads is used
76
- // Build the "proxied" handler that responses only when the file was requested by client upload in addDataAndFileToRequest
77
- } else if (adapter.clientUploads) {
78
- handlers.push((req, args)=>{
79
- if ('clientUploadContext' in args.params) {
80
- return adapter.staticHandler(req, args);
81
- }
77
+ if (enabled && adminHandler) {
78
+ config.admin ??= {};
79
+ config.admin.components ??= {};
80
+ config.admin.components.providers ??= [];
81
+ config.admin.components.providers.push({
82
+ clientProps: {
83
+ collectionSlug: existingCollection.slug,
84
+ endpointPath,
85
+ prefix: options.prefix,
86
+ props: adminHandler.props || {}
87
+ },
88
+ path: adminHandler.path
82
89
  });
83
90
  }
84
- const getSkipSafeFetchSetting = ()=>{
85
- if (options.disablePayloadAccessControl) {
86
- return true;
87
- }
88
- const isBooleanTrueSkipSafeFetch = typeof existingCollection.upload === 'object' && existingCollection.upload.skipSafeFetch === true;
89
- const isAllowListSkipSafeFetch = typeof existingCollection.upload === 'object' && Array.isArray(existingCollection.upload.skipSafeFetch);
90
- if (isBooleanTrueSkipSafeFetch) {
91
- return true;
92
- } else if (isAllowListSkipSafeFetch) {
93
- const existingSkipSafeFetch = typeof existingCollection.upload === 'object' && Array.isArray(existingCollection.upload.skipSafeFetch) ? existingCollection.upload.skipSafeFetch : [];
94
- const hasExactLocalhostMatch = existingSkipSafeFetch.some((entry)=>{
95
- const entryKeys = Object.keys(entry);
96
- return entryKeys.length === 1 && entry.hostname === 'localhost';
97
- });
98
- const localhostEntry = process.env.NODE_ENV !== 'production' && !hasExactLocalhostMatch ? [
99
- {
100
- hostname: 'localhost'
101
- }
102
- ] : [];
103
- return [
104
- ...existingSkipSafeFetch,
105
- ...localhostEntry
106
- ];
107
- }
108
- if (process.env.NODE_ENV !== 'production') {
109
- return [
110
- {
111
- hostname: 'localhost'
112
- }
113
- ];
91
+ if (enabled) {
92
+ uploadInstructions = instructions;
93
+ } else if (adminHandler) {
94
+ /** Avoid importMap.js differences when client uploads vary between dev and production. */ config.admin ??= {};
95
+ config.admin.dependencies ??= {};
96
+ config.admin.dependencies[adminHandler.path] = {
97
+ type: 'component',
98
+ path: adminHandler.path
99
+ };
100
+ }
101
+ }
102
+ const fields = getFields({
103
+ adapter,
104
+ collection: existingCollection,
105
+ disablePayloadAccessControl: options.disablePayloadAccessControl,
106
+ generateFileURL: options.generateFileURL,
107
+ prefix: options.prefix,
108
+ useCompositePrefixes
109
+ });
110
+ const handlers = [
111
+ ...typeof existingCollection.upload === 'object' && Array.isArray(existingCollection.upload.handlers) ? existingCollection.upload.handlers : []
112
+ ];
113
+ if (!options.disablePayloadAccessControl) {
114
+ handlers.push(adapter.staticHandler);
115
+ // Public files still need a server path when Payload reads them for a transform.
116
+ } else {
117
+ handlers.push((req, args)=>{
118
+ if ('uploadReference' in args.params || args.params.operation === 'transform') {
119
+ return adapter.staticHandler(req, args);
114
120
  }
115
- return false;
116
- };
117
- return {
118
- ...existingCollection,
119
- fields,
120
- hooks: {
121
- ...existingCollection.hooks || {},
122
- afterChange: [
123
- ...existingCollection.hooks?.afterChange || [],
124
- getAfterChangeHook({
125
- adapter,
126
- collection: existingCollection
127
- })
128
- ],
129
- afterDelete: [
130
- ...existingCollection.hooks?.afterDelete || [],
131
- getAfterDeleteHook({
121
+ });
122
+ }
123
+ const getSkipSafeFetchSetting = ()=>{
124
+ const isBooleanTrueSkipSafeFetch = typeof existingCollection.upload === 'object' && existingCollection.upload.skipSafeFetch === true;
125
+ const isAllowListSkipSafeFetch = typeof existingCollection.upload === 'object' && Array.isArray(existingCollection.upload.skipSafeFetch);
126
+ if (isBooleanTrueSkipSafeFetch) {
127
+ return true;
128
+ } else if (isAllowListSkipSafeFetch) {
129
+ const existingSkipSafeFetch = typeof existingCollection.upload === 'object' && Array.isArray(existingCollection.upload.skipSafeFetch) ? existingCollection.upload.skipSafeFetch : [];
130
+ const hasExactLocalhostMatch = existingSkipSafeFetch.some((entry)=>{
131
+ const entryKeys = Object.keys(entry);
132
+ return entryKeys.length === 1 && entry.hostname === 'localhost';
133
+ });
134
+ const localhostEntry = process.env.NODE_ENV !== 'production' && !hasExactLocalhostMatch ? [
135
+ {
136
+ hostname: 'localhost'
137
+ }
138
+ ] : [];
139
+ return [
140
+ ...existingSkipSafeFetch,
141
+ ...localhostEntry
142
+ ];
143
+ }
144
+ if (process.env.NODE_ENV !== 'production') {
145
+ return [
146
+ {
147
+ hostname: 'localhost'
148
+ }
149
+ ];
150
+ }
151
+ return false;
152
+ };
153
+ return {
154
+ ...existingCollection,
155
+ fields,
156
+ hooks: {
157
+ ...existingCollection.hooks || {},
158
+ afterChange: [
159
+ ...existingCollection.hooks?.afterChange || [],
160
+ getAfterChangeHook({
161
+ adapter,
162
+ collection: existingCollection,
163
+ collectionPrefix: options.prefix,
164
+ disablePayloadAccessControl: options.disablePayloadAccessControl,
165
+ hasCustomFileURL: Boolean(options.generateFileURL),
166
+ useCompositePrefixes
167
+ })
168
+ ],
169
+ afterDelete: [
170
+ ...existingCollection.hooks?.afterDelete || [],
171
+ getAfterDeleteHook({
172
+ adapter,
173
+ collection: existingCollection,
174
+ collectionPrefix: options.prefix,
175
+ useCompositePrefixes
176
+ })
177
+ ],
178
+ afterRead: [
179
+ ...existingCollection.hooks?.afterRead || [],
180
+ ...options.disablePayloadAccessControl && (options.generateFileURL || adapter.generateURL) ? [
181
+ getPublicOriginalURLHook({
132
182
  adapter,
133
- collection: existingCollection
183
+ collection: existingCollection,
184
+ generateFileURL: options.generateFileURL
134
185
  })
135
- ],
136
- beforeChange: [
137
- ...existingCollection.hooks?.beforeChange || [],
138
- getPreserveFileDataHook()
139
- ]
186
+ ] : []
187
+ ],
188
+ beforeChange: [
189
+ ...existingCollection.hooks?.beforeChange || [],
190
+ getNormalizeUploadPrefixHook({
191
+ collectionPrefix: options.prefix,
192
+ useCompositePrefixes
193
+ }),
194
+ getPreserveFileDataHook()
195
+ ]
196
+ },
197
+ select: getStorageLocationSelect({
198
+ select: existingCollection.select
199
+ }),
200
+ upload: {
201
+ ...typeof existingCollection.upload === 'object' ? existingCollection.upload : {},
202
+ adapter: adapter.name,
203
+ fileOperations: createFileOperations({
204
+ adapter,
205
+ collection: existingCollection,
206
+ collectionPrefix: options.prefix,
207
+ disablePayloadAccessControl: options.disablePayloadAccessControl,
208
+ generateFileURL: options.generateFileURL,
209
+ useCompositePrefixes
210
+ }),
211
+ ...uploadInstructions && {
212
+ uploadInstructions
140
213
  },
141
- upload: {
142
- ...typeof existingCollection.upload === 'object' ? existingCollection.upload : {},
143
- adapter: adapter.name,
144
- disableLocalStorage: typeof options.disableLocalStorage === 'boolean' ? options.disableLocalStorage : true,
145
- handlers,
146
- skipSafeFetch: getSkipSafeFetchSetting()
147
- }
148
- };
149
- }
150
- return existingCollection;
151
- }),
214
+ disableLocalStorage: typeof options.disableLocalStorage === 'boolean' ? options.disableLocalStorage : true,
215
+ handlers,
216
+ skipSafeFetch: getSkipSafeFetchSetting()
217
+ }
218
+ };
219
+ }
220
+ return existingCollection;
221
+ });
222
+ return {
223
+ ...config,
224
+ collections,
152
225
  onInit: async (payload)=>{
153
- initFunctions.forEach((fn)=>fn());
226
+ // Await each init so a provisioning failure fails Payload startup
227
+ // instead of becoming an unhandled rejection.
228
+ await Promise.all(initFunctions.map((fn)=>fn()));
154
229
  if (config.onInit) {
155
230
  await config.onInit(payload);
156
231
  }
@@ -1 +1 @@
1
- {"version":3,"sources":["../src/plugin.ts"],"sourcesContent":["import type { Config } from 'payload'\n\nimport type { AllowList, PluginOptions } from './types.js'\n\nimport { getFields } from './fields/getFields.js'\nimport { getAfterChangeHook } from './hooks/afterChange.js'\nimport { getAfterDeleteHook } from './hooks/afterDelete.js'\nimport { getPreserveFileDataHook } from './hooks/preserveFileData.js'\n\n// This plugin extends all targeted collections by offloading uploaded files\n// to cloud storage instead of solely storing files locally.\n\n// It is based on an adapter approach, where adapters can be written for any cloud provider.\n// Adapters are responsible for providing four actions that this plugin will use:\n// 1. handleUpload, 2. handleDelete, 3. generateURL, 4. staticHandler\n\n// Optionally, the adapter can specify any Webpack config overrides if they are necessary.\n\nexport const cloudStoragePlugin =\n (pluginOptions: PluginOptions) =>\n (incomingConfig: Config): Config => {\n const {\n alwaysInsertFields,\n collections: allCollectionOptions,\n enabled,\n useCompositePrefixes,\n } = pluginOptions\n const config = { ...incomingConfig }\n\n // If disabled but alwaysInsertFields is true, only insert fields without full plugin functionality\n if (enabled === false) {\n if (alwaysInsertFields) {\n return {\n ...config,\n collections: (config.collections || []).map((existingCollection) => {\n const options = allCollectionOptions[existingCollection.slug]\n\n if (options) {\n // If adapter is provided, use it to get fields\n const adapter = options.adapter\n ? options.adapter({\n collection: existingCollection,\n prefix: options.prefix,\n })\n : undefined\n\n const fields = getFields({\n adapter,\n alwaysInsertFields: true,\n collection: existingCollection,\n disablePayloadAccessControl: options.disablePayloadAccessControl,\n generateFileURL: options.generateFileURL,\n prefix: options.prefix,\n useCompositePrefixes,\n })\n\n return {\n ...existingCollection,\n fields,\n }\n }\n\n return existingCollection\n }),\n }\n }\n\n return config\n }\n\n const initFunctions: Array<() => void> = []\n\n return {\n ...config,\n collections: (config.collections || []).map((existingCollection) => {\n const options = allCollectionOptions[existingCollection.slug]\n\n if (options?.adapter) {\n const adapter = options.adapter({\n collection: existingCollection,\n prefix: options.prefix,\n })\n\n if (adapter.onInit) {\n initFunctions.push(adapter.onInit)\n }\n\n const fields = getFields({\n adapter,\n collection: existingCollection,\n disablePayloadAccessControl: options.disablePayloadAccessControl,\n generateFileURL: options.generateFileURL,\n prefix: options.prefix,\n useCompositePrefixes,\n })\n\n const handlers = [\n ...(typeof existingCollection.upload === 'object' &&\n Array.isArray(existingCollection.upload.handlers)\n ? existingCollection.upload.handlers\n : []),\n ]\n\n if (!options.disablePayloadAccessControl) {\n handlers.push(adapter.staticHandler)\n // Else if disablePayloadAccessControl: true and clientUploads is used\n // Build the \"proxied\" handler that responses only when the file was requested by client upload in addDataAndFileToRequest\n } else if (adapter.clientUploads) {\n handlers.push((req, args) => {\n if ('clientUploadContext' in args.params) {\n return adapter.staticHandler(req, args)\n }\n })\n }\n\n const getSkipSafeFetchSetting = (): AllowList | boolean => {\n if (options.disablePayloadAccessControl) {\n return true\n }\n const isBooleanTrueSkipSafeFetch =\n typeof existingCollection.upload === 'object' &&\n existingCollection.upload.skipSafeFetch === true\n\n const isAllowListSkipSafeFetch =\n typeof existingCollection.upload === 'object' &&\n Array.isArray(existingCollection.upload.skipSafeFetch)\n\n if (isBooleanTrueSkipSafeFetch) {\n return true\n } else if (isAllowListSkipSafeFetch) {\n const existingSkipSafeFetch =\n typeof existingCollection.upload === 'object' &&\n Array.isArray(existingCollection.upload.skipSafeFetch)\n ? existingCollection.upload.skipSafeFetch\n : []\n\n const hasExactLocalhostMatch = existingSkipSafeFetch.some((entry) => {\n const entryKeys = Object.keys(entry)\n return entryKeys.length === 1 && entry.hostname === 'localhost'\n })\n\n const localhostEntry =\n process.env.NODE_ENV !== 'production' && !hasExactLocalhostMatch\n ? [{ hostname: 'localhost' }]\n : []\n\n return [...existingSkipSafeFetch, ...localhostEntry]\n }\n\n if (process.env.NODE_ENV !== 'production') {\n return [{ hostname: 'localhost' }]\n }\n\n return false\n }\n\n return {\n ...existingCollection,\n fields,\n hooks: {\n ...(existingCollection.hooks || {}),\n afterChange: [\n ...(existingCollection.hooks?.afterChange || []),\n getAfterChangeHook({ adapter, collection: existingCollection }),\n ],\n afterDelete: [\n ...(existingCollection.hooks?.afterDelete || []),\n getAfterDeleteHook({ adapter, collection: existingCollection }),\n ],\n beforeChange: [\n ...(existingCollection.hooks?.beforeChange || []),\n getPreserveFileDataHook(),\n ],\n },\n upload: {\n ...(typeof existingCollection.upload === 'object' ? existingCollection.upload : {}),\n adapter: adapter.name,\n disableLocalStorage:\n typeof options.disableLocalStorage === 'boolean'\n ? options.disableLocalStorage\n : true,\n handlers,\n skipSafeFetch: getSkipSafeFetchSetting(),\n },\n }\n }\n\n return existingCollection\n }),\n onInit: async (payload) => {\n initFunctions.forEach((fn) => fn())\n if (config.onInit) {\n await config.onInit(payload)\n }\n },\n }\n }\n"],"names":["getFields","getAfterChangeHook","getAfterDeleteHook","getPreserveFileDataHook","cloudStoragePlugin","pluginOptions","incomingConfig","alwaysInsertFields","collections","allCollectionOptions","enabled","useCompositePrefixes","config","map","existingCollection","options","slug","adapter","collection","prefix","undefined","fields","disablePayloadAccessControl","generateFileURL","initFunctions","onInit","push","handlers","upload","Array","isArray","staticHandler","clientUploads","req","args","params","getSkipSafeFetchSetting","isBooleanTrueSkipSafeFetch","skipSafeFetch","isAllowListSkipSafeFetch","existingSkipSafeFetch","hasExactLocalhostMatch","some","entry","entryKeys","Object","keys","length","hostname","localhostEntry","process","env","NODE_ENV","hooks","afterChange","afterDelete","beforeChange","name","disableLocalStorage","payload","forEach","fn"],"mappings":"AAIA,SAASA,SAAS,QAAQ,wBAAuB;AACjD,SAASC,kBAAkB,QAAQ,yBAAwB;AAC3D,SAASC,kBAAkB,QAAQ,yBAAwB;AAC3D,SAASC,uBAAuB,QAAQ,8BAA6B;AAErE,4EAA4E;AAC5E,4DAA4D;AAE5D,4FAA4F;AAC5F,iFAAiF;AACjF,qEAAqE;AAErE,0FAA0F;AAE1F,OAAO,MAAMC,qBACX,CAACC,gBACD,CAACC;QACC,MAAM,EACJC,kBAAkB,EAClBC,aAAaC,oBAAoB,EACjCC,OAAO,EACPC,oBAAoB,EACrB,GAAGN;QACJ,MAAMO,SAAS;YAAE,GAAGN,cAAc;QAAC;QAEnC,mGAAmG;QACnG,IAAII,YAAY,OAAO;YACrB,IAAIH,oBAAoB;gBACtB,OAAO;oBACL,GAAGK,MAAM;oBACTJ,aAAa,AAACI,CAAAA,OAAOJ,WAAW,IAAI,EAAE,AAAD,EAAGK,GAAG,CAAC,CAACC;wBAC3C,MAAMC,UAAUN,oBAAoB,CAACK,mBAAmBE,IAAI,CAAC;wBAE7D,IAAID,SAAS;4BACX,+CAA+C;4BAC/C,MAAME,UAAUF,QAAQE,OAAO,GAC3BF,QAAQE,OAAO,CAAC;gCACdC,YAAYJ;gCACZK,QAAQJ,QAAQI,MAAM;4BACxB,KACAC;4BAEJ,MAAMC,SAASrB,UAAU;gCACvBiB;gCACAV,oBAAoB;gCACpBW,YAAYJ;gCACZQ,6BAA6BP,QAAQO,2BAA2B;gCAChEC,iBAAiBR,QAAQQ,eAAe;gCACxCJ,QAAQJ,QAAQI,MAAM;gCACtBR;4BACF;4BAEA,OAAO;gCACL,GAAGG,kBAAkB;gCACrBO;4BACF;wBACF;wBAEA,OAAOP;oBACT;gBACF;YACF;YAEA,OAAOF;QACT;QAEA,MAAMY,gBAAmC,EAAE;QAE3C,OAAO;YACL,GAAGZ,MAAM;YACTJ,aAAa,AAACI,CAAAA,OAAOJ,WAAW,IAAI,EAAE,AAAD,EAAGK,GAAG,CAAC,CAACC;gBAC3C,MAAMC,UAAUN,oBAAoB,CAACK,mBAAmBE,IAAI,CAAC;gBAE7D,IAAID,SAASE,SAAS;oBACpB,MAAMA,UAAUF,QAAQE,OAAO,CAAC;wBAC9BC,YAAYJ;wBACZK,QAAQJ,QAAQI,MAAM;oBACxB;oBAEA,IAAIF,QAAQQ,MAAM,EAAE;wBAClBD,cAAcE,IAAI,CAACT,QAAQQ,MAAM;oBACnC;oBAEA,MAAMJ,SAASrB,UAAU;wBACvBiB;wBACAC,YAAYJ;wBACZQ,6BAA6BP,QAAQO,2BAA2B;wBAChEC,iBAAiBR,QAAQQ,eAAe;wBACxCJ,QAAQJ,QAAQI,MAAM;wBACtBR;oBACF;oBAEA,MAAMgB,WAAW;2BACX,OAAOb,mBAAmBc,MAAM,KAAK,YACzCC,MAAMC,OAAO,CAAChB,mBAAmBc,MAAM,CAACD,QAAQ,IAC5Cb,mBAAmBc,MAAM,CAACD,QAAQ,GAClC,EAAE;qBACP;oBAED,IAAI,CAACZ,QAAQO,2BAA2B,EAAE;wBACxCK,SAASD,IAAI,CAACT,QAAQc,aAAa;oBACnC,sEAAsE;oBACtE,0HAA0H;oBAC5H,OAAO,IAAId,QAAQe,aAAa,EAAE;wBAChCL,SAASD,IAAI,CAAC,CAACO,KAAKC;4BAClB,IAAI,yBAAyBA,KAAKC,MAAM,EAAE;gCACxC,OAAOlB,QAAQc,aAAa,CAACE,KAAKC;4BACpC;wBACF;oBACF;oBAEA,MAAME,0BAA0B;wBAC9B,IAAIrB,QAAQO,2BAA2B,EAAE;4BACvC,OAAO;wBACT;wBACA,MAAMe,6BACJ,OAAOvB,mBAAmBc,MAAM,KAAK,YACrCd,mBAAmBc,MAAM,CAACU,aAAa,KAAK;wBAE9C,MAAMC,2BACJ,OAAOzB,mBAAmBc,MAAM,KAAK,YACrCC,MAAMC,OAAO,CAAChB,mBAAmBc,MAAM,CAACU,aAAa;wBAEvD,IAAID,4BAA4B;4BAC9B,OAAO;wBACT,OAAO,IAAIE,0BAA0B;4BACnC,MAAMC,wBACJ,OAAO1B,mBAAmBc,MAAM,KAAK,YACrCC,MAAMC,OAAO,CAAChB,mBAAmBc,MAAM,CAACU,aAAa,IACjDxB,mBAAmBc,MAAM,CAACU,aAAa,GACvC,EAAE;4BAER,MAAMG,yBAAyBD,sBAAsBE,IAAI,CAAC,CAACC;gCACzD,MAAMC,YAAYC,OAAOC,IAAI,CAACH;gCAC9B,OAAOC,UAAUG,MAAM,KAAK,KAAKJ,MAAMK,QAAQ,KAAK;4BACtD;4BAEA,MAAMC,iBACJC,QAAQC,GAAG,CAACC,QAAQ,KAAK,gBAAgB,CAACX,yBACtC;gCAAC;oCAAEO,UAAU;gCAAY;6BAAE,GAC3B,EAAE;4BAER,OAAO;mCAAIR;mCAA0BS;6BAAe;wBACtD;wBAEA,IAAIC,QAAQC,GAAG,CAACC,QAAQ,KAAK,cAAc;4BACzC,OAAO;gCAAC;oCAAEJ,UAAU;gCAAY;6BAAE;wBACpC;wBAEA,OAAO;oBACT;oBAEA,OAAO;wBACL,GAAGlC,kBAAkB;wBACrBO;wBACAgC,OAAO;4BACL,GAAIvC,mBAAmBuC,KAAK,IAAI,CAAC,CAAC;4BAClCC,aAAa;mCACPxC,mBAAmBuC,KAAK,EAAEC,eAAe,EAAE;gCAC/CrD,mBAAmB;oCAAEgB;oCAASC,YAAYJ;gCAAmB;6BAC9D;4BACDyC,aAAa;mCACPzC,mBAAmBuC,KAAK,EAAEE,eAAe,EAAE;gCAC/CrD,mBAAmB;oCAAEe;oCAASC,YAAYJ;gCAAmB;6BAC9D;4BACD0C,cAAc;mCACR1C,mBAAmBuC,KAAK,EAAEG,gBAAgB,EAAE;gCAChDrD;6BACD;wBACH;wBACAyB,QAAQ;4BACN,GAAI,OAAOd,mBAAmBc,MAAM,KAAK,WAAWd,mBAAmBc,MAAM,GAAG,CAAC,CAAC;4BAClFX,SAASA,QAAQwC,IAAI;4BACrBC,qBACE,OAAO3C,QAAQ2C,mBAAmB,KAAK,YACnC3C,QAAQ2C,mBAAmB,GAC3B;4BACN/B;4BACAW,eAAeF;wBACjB;oBACF;gBACF;gBAEA,OAAOtB;YACT;YACAW,QAAQ,OAAOkC;gBACbnC,cAAcoC,OAAO,CAAC,CAACC,KAAOA;gBAC9B,IAAIjD,OAAOa,MAAM,EAAE;oBACjB,MAAMb,OAAOa,MAAM,CAACkC;gBACtB;YACF;QACF;IACF,EAAC"}
1
+ {"version":3,"sources":["../src/plugin.ts"],"sourcesContent":["import type { Config } from 'payload'\n\nimport type { Adapter, AllowList, PluginOptions } from './types.js'\n\nimport { getFields } from './fields/getFields.js'\nimport { getAfterChangeHook } from './hooks/afterChange.js'\nimport { getAfterDeleteHook } from './hooks/afterDelete.js'\nimport { getNormalizeUploadPrefixHook } from './hooks/normalizeUploadPrefix.js'\nimport { getPreserveFileDataHook } from './hooks/preserveFileData.js'\nimport { getPublicOriginalURLHook } from './hooks/publicOriginalURL.js'\nimport { createFileOperations } from './utilities/createFileOperations.js'\nimport { getStorageLocationSelect } from './utilities/getStorageLocationSelect.js'\n\n// This plugin extends all targeted collections by offloading uploaded files\n// to cloud storage instead of solely storing files locally.\n\n// It is based on an adapter approach, where adapters can be written for any cloud provider.\n// Adapters are responsible for providing four actions that this plugin will use:\n// 1. handleUpload, 2. handleDelete, 3. generateURL, 4. staticHandler\n\n// Optionally, the adapter can specify any Webpack config overrides if they are necessary.\n\nexport const cloudStoragePlugin =\n (pluginOptions: PluginOptions) =>\n (incomingConfig: Config): Config => {\n const { collections: allCollectionOptions, enabled, useCompositePrefixes } = pluginOptions\n const config = { ...incomingConfig }\n\n // If disabled, only insert fields (e.g. prefix) without full plugin functionality,\n // so the collection schema stays consistent across environments.\n if (enabled === false) {\n return {\n ...config,\n collections: (config.collections || []).map((existingCollection) => {\n const options = allCollectionOptions[existingCollection.slug]\n\n if (options) {\n // If adapter is provided, use it to get fields\n const adapter = options.adapter\n ? options.adapter({\n collection: existingCollection,\n prefix: options.prefix,\n })\n : undefined\n\n const fields = getFields({\n adapter,\n collection: existingCollection,\n disablePayloadAccessControl: options.disablePayloadAccessControl,\n generateFileURL: options.generateFileURL,\n prefix: options.prefix,\n useCompositePrefixes,\n })\n\n return {\n ...existingCollection,\n fields,\n }\n }\n\n return existingCollection\n }),\n }\n }\n\n const initFunctions: Array<() => Promise<void> | void> = []\n const endpointPaths = new Map<Adapter, string>()\n\n const collections = (config.collections || []).map((existingCollection) => {\n const options = allCollectionOptions[existingCollection.slug]\n\n if (options?.adapter) {\n const adapter = options.adapter({\n collection: existingCollection,\n prefix: options.prefix,\n })\n\n if (adapter.onInit) {\n initFunctions.push(adapter.onInit)\n }\n\n let uploadInstructions\n\n if (adapter.uploadInstructions) {\n const { adminHandler, enabled, endpoint, ...instructions } = adapter.uploadInstructions\n let endpointPath = endpointPaths.get(options.adapter)\n\n if (enabled && endpoint && !endpointPath) {\n const endpointCount =\n config.endpoints?.filter(({ path }) => path?.startsWith(endpoint.path)).length || 0\n\n endpointPath = endpointCount ? `${endpoint.path}-${endpointCount}` : endpoint.path\n config.endpoints ??= []\n config.endpoints.push({\n handler: endpoint.handler,\n method: 'post',\n path: endpointPath,\n })\n endpointPaths.set(options.adapter, endpointPath)\n }\n\n if (enabled && adminHandler) {\n config.admin ??= {}\n config.admin.components ??= {}\n config.admin.components.providers ??= []\n config.admin.components.providers.push({\n clientProps: {\n collectionSlug: existingCollection.slug,\n endpointPath,\n prefix: options.prefix,\n props: adminHandler.props || {},\n },\n path: adminHandler.path,\n })\n }\n\n if (enabled) {\n uploadInstructions = instructions\n } else if (adminHandler) {\n /** Avoid importMap.js differences when client uploads vary between dev and production. */\n config.admin ??= {}\n config.admin.dependencies ??= {}\n config.admin.dependencies[adminHandler.path] = {\n type: 'component',\n path: adminHandler.path,\n }\n }\n }\n\n const fields = getFields({\n adapter,\n collection: existingCollection,\n disablePayloadAccessControl: options.disablePayloadAccessControl,\n generateFileURL: options.generateFileURL,\n prefix: options.prefix,\n useCompositePrefixes,\n })\n\n const handlers = [\n ...(typeof existingCollection.upload === 'object' &&\n Array.isArray(existingCollection.upload.handlers)\n ? existingCollection.upload.handlers\n : []),\n ]\n\n if (!options.disablePayloadAccessControl) {\n handlers.push(adapter.staticHandler)\n // Public files still need a server path when Payload reads them for a transform.\n } else {\n handlers.push((req, args) => {\n if ('uploadReference' in args.params || args.params.operation === 'transform') {\n return adapter.staticHandler(req, args)\n }\n })\n }\n\n const getSkipSafeFetchSetting = (): AllowList | boolean => {\n const isBooleanTrueSkipSafeFetch =\n typeof existingCollection.upload === 'object' &&\n existingCollection.upload.skipSafeFetch === true\n\n const isAllowListSkipSafeFetch =\n typeof existingCollection.upload === 'object' &&\n Array.isArray(existingCollection.upload.skipSafeFetch)\n\n if (isBooleanTrueSkipSafeFetch) {\n return true\n } else if (isAllowListSkipSafeFetch) {\n const existingSkipSafeFetch =\n typeof existingCollection.upload === 'object' &&\n Array.isArray(existingCollection.upload.skipSafeFetch)\n ? existingCollection.upload.skipSafeFetch\n : []\n\n const hasExactLocalhostMatch = existingSkipSafeFetch.some((entry) => {\n const entryKeys = Object.keys(entry)\n return entryKeys.length === 1 && entry.hostname === 'localhost'\n })\n\n const localhostEntry =\n process.env.NODE_ENV !== 'production' && !hasExactLocalhostMatch\n ? [{ hostname: 'localhost' }]\n : []\n\n return [...existingSkipSafeFetch, ...localhostEntry]\n }\n\n if (process.env.NODE_ENV !== 'production') {\n return [{ hostname: 'localhost' }]\n }\n\n return false\n }\n\n return {\n ...existingCollection,\n fields,\n hooks: {\n ...(existingCollection.hooks || {}),\n afterChange: [\n ...(existingCollection.hooks?.afterChange || []),\n getAfterChangeHook({\n adapter,\n collection: existingCollection,\n collectionPrefix: options.prefix,\n disablePayloadAccessControl: options.disablePayloadAccessControl,\n hasCustomFileURL: Boolean(options.generateFileURL),\n useCompositePrefixes,\n }),\n ],\n afterDelete: [\n ...(existingCollection.hooks?.afterDelete || []),\n getAfterDeleteHook({\n adapter,\n collection: existingCollection,\n collectionPrefix: options.prefix,\n useCompositePrefixes,\n }),\n ],\n afterRead: [\n ...(existingCollection.hooks?.afterRead || []),\n ...(options.disablePayloadAccessControl &&\n (options.generateFileURL || adapter.generateURL)\n ? [\n getPublicOriginalURLHook({\n adapter,\n collection: existingCollection,\n generateFileURL: options.generateFileURL,\n }),\n ]\n : []),\n ],\n beforeChange: [\n ...(existingCollection.hooks?.beforeChange || []),\n getNormalizeUploadPrefixHook({\n collectionPrefix: options.prefix,\n useCompositePrefixes,\n }),\n getPreserveFileDataHook(),\n ],\n },\n select: getStorageLocationSelect({ select: existingCollection.select }),\n upload: {\n ...(typeof existingCollection.upload === 'object' ? existingCollection.upload : {}),\n adapter: adapter.name,\n fileOperations: createFileOperations({\n adapter,\n collection: existingCollection,\n collectionPrefix: options.prefix,\n disablePayloadAccessControl: options.disablePayloadAccessControl,\n generateFileURL: options.generateFileURL,\n useCompositePrefixes,\n }),\n ...(uploadInstructions && {\n uploadInstructions,\n }),\n disableLocalStorage:\n typeof options.disableLocalStorage === 'boolean' ? options.disableLocalStorage : true,\n handlers,\n skipSafeFetch: getSkipSafeFetchSetting(),\n },\n }\n }\n\n return existingCollection\n })\n\n return {\n ...config,\n collections,\n onInit: async (payload) => {\n // Await each init so a provisioning failure fails Payload startup\n // instead of becoming an unhandled rejection.\n await Promise.all(initFunctions.map((fn) => fn()))\n if (config.onInit) {\n await config.onInit(payload)\n }\n },\n }\n }\n"],"names":["getFields","getAfterChangeHook","getAfterDeleteHook","getNormalizeUploadPrefixHook","getPreserveFileDataHook","getPublicOriginalURLHook","createFileOperations","getStorageLocationSelect","cloudStoragePlugin","pluginOptions","incomingConfig","collections","allCollectionOptions","enabled","useCompositePrefixes","config","map","existingCollection","options","slug","adapter","collection","prefix","undefined","fields","disablePayloadAccessControl","generateFileURL","initFunctions","endpointPaths","Map","onInit","push","uploadInstructions","adminHandler","endpoint","instructions","endpointPath","get","endpointCount","endpoints","filter","path","startsWith","length","handler","method","set","admin","components","providers","clientProps","collectionSlug","props","dependencies","type","handlers","upload","Array","isArray","staticHandler","req","args","params","operation","getSkipSafeFetchSetting","isBooleanTrueSkipSafeFetch","skipSafeFetch","isAllowListSkipSafeFetch","existingSkipSafeFetch","hasExactLocalhostMatch","some","entry","entryKeys","Object","keys","hostname","localhostEntry","process","env","NODE_ENV","hooks","afterChange","collectionPrefix","hasCustomFileURL","Boolean","afterDelete","afterRead","generateURL","beforeChange","select","name","fileOperations","disableLocalStorage","payload","Promise","all","fn"],"mappings":"AAIA,SAASA,SAAS,QAAQ,wBAAuB;AACjD,SAASC,kBAAkB,QAAQ,yBAAwB;AAC3D,SAASC,kBAAkB,QAAQ,yBAAwB;AAC3D,SAASC,4BAA4B,QAAQ,mCAAkC;AAC/E,SAASC,uBAAuB,QAAQ,8BAA6B;AACrE,SAASC,wBAAwB,QAAQ,+BAA8B;AACvE,SAASC,oBAAoB,QAAQ,sCAAqC;AAC1E,SAASC,wBAAwB,QAAQ,0CAAyC;AAElF,4EAA4E;AAC5E,4DAA4D;AAE5D,4FAA4F;AAC5F,iFAAiF;AACjF,qEAAqE;AAErE,0FAA0F;AAE1F,OAAO,MAAMC,qBACX,CAACC,gBACD,CAACC;QACC,MAAM,EAAEC,aAAaC,oBAAoB,EAAEC,OAAO,EAAEC,oBAAoB,EAAE,GAAGL;QAC7E,MAAMM,SAAS;YAAE,GAAGL,cAAc;QAAC;QAEnC,mFAAmF;QACnF,iEAAiE;QACjE,IAAIG,YAAY,OAAO;YACrB,OAAO;gBACL,GAAGE,MAAM;gBACTJ,aAAa,AAACI,CAAAA,OAAOJ,WAAW,IAAI,EAAE,AAAD,EAAGK,GAAG,CAAC,CAACC;oBAC3C,MAAMC,UAAUN,oBAAoB,CAACK,mBAAmBE,IAAI,CAAC;oBAE7D,IAAID,SAAS;wBACX,+CAA+C;wBAC/C,MAAME,UAAUF,QAAQE,OAAO,GAC3BF,QAAQE,OAAO,CAAC;4BACdC,YAAYJ;4BACZK,QAAQJ,QAAQI,MAAM;wBACxB,KACAC;wBAEJ,MAAMC,SAASxB,UAAU;4BACvBoB;4BACAC,YAAYJ;4BACZQ,6BAA6BP,QAAQO,2BAA2B;4BAChEC,iBAAiBR,QAAQQ,eAAe;4BACxCJ,QAAQJ,QAAQI,MAAM;4BACtBR;wBACF;wBAEA,OAAO;4BACL,GAAGG,kBAAkB;4BACrBO;wBACF;oBACF;oBAEA,OAAOP;gBACT;YACF;QACF;QAEA,MAAMU,gBAAmD,EAAE;QAC3D,MAAMC,gBAAgB,IAAIC;QAE1B,MAAMlB,cAAc,AAACI,CAAAA,OAAOJ,WAAW,IAAI,EAAE,AAAD,EAAGK,GAAG,CAAC,CAACC;YAClD,MAAMC,UAAUN,oBAAoB,CAACK,mBAAmBE,IAAI,CAAC;YAE7D,IAAID,SAASE,SAAS;gBACpB,MAAMA,UAAUF,QAAQE,OAAO,CAAC;oBAC9BC,YAAYJ;oBACZK,QAAQJ,QAAQI,MAAM;gBACxB;gBAEA,IAAIF,QAAQU,MAAM,EAAE;oBAClBH,cAAcI,IAAI,CAACX,QAAQU,MAAM;gBACnC;gBAEA,IAAIE;gBAEJ,IAAIZ,QAAQY,kBAAkB,EAAE;oBAC9B,MAAM,EAAEC,YAAY,EAAEpB,OAAO,EAAEqB,QAAQ,EAAE,GAAGC,cAAc,GAAGf,QAAQY,kBAAkB;oBACvF,IAAII,eAAeR,cAAcS,GAAG,CAACnB,QAAQE,OAAO;oBAEpD,IAAIP,WAAWqB,YAAY,CAACE,cAAc;wBACxC,MAAME,gBACJvB,OAAOwB,SAAS,EAAEC,OAAO,CAAC,EAAEC,IAAI,EAAE,GAAKA,MAAMC,WAAWR,SAASO,IAAI,GAAGE,UAAU;wBAEpFP,eAAeE,gBAAgB,GAAGJ,SAASO,IAAI,CAAC,CAAC,EAAEH,eAAe,GAAGJ,SAASO,IAAI;wBAClF1B,OAAOwB,SAAS,KAAK,EAAE;wBACvBxB,OAAOwB,SAAS,CAACR,IAAI,CAAC;4BACpBa,SAASV,SAASU,OAAO;4BACzBC,QAAQ;4BACRJ,MAAML;wBACR;wBACAR,cAAckB,GAAG,CAAC5B,QAAQE,OAAO,EAAEgB;oBACrC;oBAEA,IAAIvB,WAAWoB,cAAc;wBAC3BlB,OAAOgC,KAAK,KAAK,CAAC;wBAClBhC,OAAOgC,KAAK,CAACC,UAAU,KAAK,CAAC;wBAC7BjC,OAAOgC,KAAK,CAACC,UAAU,CAACC,SAAS,KAAK,EAAE;wBACxClC,OAAOgC,KAAK,CAACC,UAAU,CAACC,SAAS,CAAClB,IAAI,CAAC;4BACrCmB,aAAa;gCACXC,gBAAgBlC,mBAAmBE,IAAI;gCACvCiB;gCACAd,QAAQJ,QAAQI,MAAM;gCACtB8B,OAAOnB,aAAamB,KAAK,IAAI,CAAC;4BAChC;4BACAX,MAAMR,aAAaQ,IAAI;wBACzB;oBACF;oBAEA,IAAI5B,SAAS;wBACXmB,qBAAqBG;oBACvB,OAAO,IAAIF,cAAc;wBACvB,wFAAwF,GACxFlB,OAAOgC,KAAK,KAAK,CAAC;wBAClBhC,OAAOgC,KAAK,CAACM,YAAY,KAAK,CAAC;wBAC/BtC,OAAOgC,KAAK,CAACM,YAAY,CAACpB,aAAaQ,IAAI,CAAC,GAAG;4BAC7Ca,MAAM;4BACNb,MAAMR,aAAaQ,IAAI;wBACzB;oBACF;gBACF;gBAEA,MAAMjB,SAASxB,UAAU;oBACvBoB;oBACAC,YAAYJ;oBACZQ,6BAA6BP,QAAQO,2BAA2B;oBAChEC,iBAAiBR,QAAQQ,eAAe;oBACxCJ,QAAQJ,QAAQI,MAAM;oBACtBR;gBACF;gBAEA,MAAMyC,WAAW;uBACX,OAAOtC,mBAAmBuC,MAAM,KAAK,YACzCC,MAAMC,OAAO,CAACzC,mBAAmBuC,MAAM,CAACD,QAAQ,IAC5CtC,mBAAmBuC,MAAM,CAACD,QAAQ,GAClC,EAAE;iBACP;gBAED,IAAI,CAACrC,QAAQO,2BAA2B,EAAE;oBACxC8B,SAASxB,IAAI,CAACX,QAAQuC,aAAa;gBACnC,iFAAiF;gBACnF,OAAO;oBACLJ,SAASxB,IAAI,CAAC,CAAC6B,KAAKC;wBAClB,IAAI,qBAAqBA,KAAKC,MAAM,IAAID,KAAKC,MAAM,CAACC,SAAS,KAAK,aAAa;4BAC7E,OAAO3C,QAAQuC,aAAa,CAACC,KAAKC;wBACpC;oBACF;gBACF;gBAEA,MAAMG,0BAA0B;oBAC9B,MAAMC,6BACJ,OAAOhD,mBAAmBuC,MAAM,KAAK,YACrCvC,mBAAmBuC,MAAM,CAACU,aAAa,KAAK;oBAE9C,MAAMC,2BACJ,OAAOlD,mBAAmBuC,MAAM,KAAK,YACrCC,MAAMC,OAAO,CAACzC,mBAAmBuC,MAAM,CAACU,aAAa;oBAEvD,IAAID,4BAA4B;wBAC9B,OAAO;oBACT,OAAO,IAAIE,0BAA0B;wBACnC,MAAMC,wBACJ,OAAOnD,mBAAmBuC,MAAM,KAAK,YACrCC,MAAMC,OAAO,CAACzC,mBAAmBuC,MAAM,CAACU,aAAa,IACjDjD,mBAAmBuC,MAAM,CAACU,aAAa,GACvC,EAAE;wBAER,MAAMG,yBAAyBD,sBAAsBE,IAAI,CAAC,CAACC;4BACzD,MAAMC,YAAYC,OAAOC,IAAI,CAACH;4BAC9B,OAAOC,UAAU7B,MAAM,KAAK,KAAK4B,MAAMI,QAAQ,KAAK;wBACtD;wBAEA,MAAMC,iBACJC,QAAQC,GAAG,CAACC,QAAQ,KAAK,gBAAgB,CAACV,yBACtC;4BAAC;gCAAEM,UAAU;4BAAY;yBAAE,GAC3B,EAAE;wBAER,OAAO;+BAAIP;+BAA0BQ;yBAAe;oBACtD;oBAEA,IAAIC,QAAQC,GAAG,CAACC,QAAQ,KAAK,cAAc;wBACzC,OAAO;4BAAC;gCAAEJ,UAAU;4BAAY;yBAAE;oBACpC;oBAEA,OAAO;gBACT;gBAEA,OAAO;oBACL,GAAG1D,kBAAkB;oBACrBO;oBACAwD,OAAO;wBACL,GAAI/D,mBAAmB+D,KAAK,IAAI,CAAC,CAAC;wBAClCC,aAAa;+BACPhE,mBAAmB+D,KAAK,EAAEC,eAAe,EAAE;4BAC/ChF,mBAAmB;gCACjBmB;gCACAC,YAAYJ;gCACZiE,kBAAkBhE,QAAQI,MAAM;gCAChCG,6BAA6BP,QAAQO,2BAA2B;gCAChE0D,kBAAkBC,QAAQlE,QAAQQ,eAAe;gCACjDZ;4BACF;yBACD;wBACDuE,aAAa;+BACPpE,mBAAmB+D,KAAK,EAAEK,eAAe,EAAE;4BAC/CnF,mBAAmB;gCACjBkB;gCACAC,YAAYJ;gCACZiE,kBAAkBhE,QAAQI,MAAM;gCAChCR;4BACF;yBACD;wBACDwE,WAAW;+BACLrE,mBAAmB+D,KAAK,EAAEM,aAAa,EAAE;+BACzCpE,QAAQO,2BAA2B,IACtCP,CAAAA,QAAQQ,eAAe,IAAIN,QAAQmE,WAAW,AAAD,IAC1C;gCACElF,yBAAyB;oCACvBe;oCACAC,YAAYJ;oCACZS,iBAAiBR,QAAQQ,eAAe;gCAC1C;6BACD,GACD,EAAE;yBACP;wBACD8D,cAAc;+BACRvE,mBAAmB+D,KAAK,EAAEQ,gBAAgB,EAAE;4BAChDrF,6BAA6B;gCAC3B+E,kBAAkBhE,QAAQI,MAAM;gCAChCR;4BACF;4BACAV;yBACD;oBACH;oBACAqF,QAAQlF,yBAAyB;wBAAEkF,QAAQxE,mBAAmBwE,MAAM;oBAAC;oBACrEjC,QAAQ;wBACN,GAAI,OAAOvC,mBAAmBuC,MAAM,KAAK,WAAWvC,mBAAmBuC,MAAM,GAAG,CAAC,CAAC;wBAClFpC,SAASA,QAAQsE,IAAI;wBACrBC,gBAAgBrF,qBAAqB;4BACnCc;4BACAC,YAAYJ;4BACZiE,kBAAkBhE,QAAQI,MAAM;4BAChCG,6BAA6BP,QAAQO,2BAA2B;4BAChEC,iBAAiBR,QAAQQ,eAAe;4BACxCZ;wBACF;wBACA,GAAIkB,sBAAsB;4BACxBA;wBACF,CAAC;wBACD4D,qBACE,OAAO1E,QAAQ0E,mBAAmB,KAAK,YAAY1E,QAAQ0E,mBAAmB,GAAG;wBACnFrC;wBACAW,eAAeF;oBACjB;gBACF;YACF;YAEA,OAAO/C;QACT;QAEA,OAAO;YACL,GAAGF,MAAM;YACTJ;YACAmB,QAAQ,OAAO+D;gBACb,kEAAkE;gBAClE,8CAA8C;gBAC9C,MAAMC,QAAQC,GAAG,CAACpE,cAAcX,GAAG,CAAC,CAACgF,KAAOA;gBAC5C,IAAIjF,OAAOe,MAAM,EAAE;oBACjB,MAAMf,OAAOe,MAAM,CAAC+D;gBACtB;YACF;QACF;IACF,EAAC"}
package/dist/types.d.ts CHANGED
@@ -1,25 +1,35 @@
1
- import type { CollectionConfig, Field, FileData, ImageSize, PayloadRequest, TypeWithID, UploadCollectionSlug } from 'payload';
1
+ import type { CollectionConfig, Field, FileData, FileHandlerOperation, ImageSize, PayloadHandler, PayloadRequest, SanitizedCollectionConfig, TypeWithID, UploadCollectionSlug, UploadInstructionsAccess, UploadInstructionsCapability } from 'payload';
2
+ export type { FileHandlerOperation } from 'payload';
2
3
  export interface File {
3
4
  buffer: Buffer;
4
- clientUploadContext?: unknown;
5
5
  filename: string;
6
6
  filesize: number;
7
7
  mimeType: string;
8
8
  tempFilePath?: string;
9
+ uploadReference?: unknown;
9
10
  }
10
- export type ClientUploadsAccess = (args: {
11
- collectionSlug: UploadCollectionSlug;
12
- req: PayloadRequest;
13
- }) => boolean | Promise<boolean>;
14
11
  export type ClientUploadsConfig = {
15
- access?: ClientUploadsAccess;
12
+ access?: UploadInstructionsAccess;
16
13
  } | boolean;
14
+ /**
15
+ * Reference to a client-uploaded object, returned by an upload handler and
16
+ * submitted with the document. Always carries the signed receipt; `prefix`
17
+ * locates the stored object.
18
+ */
19
+ export type UploadReference = {
20
+ _objectKey?: string;
21
+ prefix: string;
22
+ signedReceipt: `${string}.${string}`;
23
+ };
17
24
  export type HandleUpload = (args: {
18
- clientUploadContext: unknown;
19
25
  collection: CollectionConfig;
20
26
  data: any;
21
27
  file: File;
22
28
  req: PayloadRequest;
29
+ /**
30
+ * Pre-resolved storage path (`_objectKey` folded in, contained beneath the collection prefix).
31
+ */
32
+ storageFilePath: string;
23
33
  }) => Partial<FileData & TypeWithID> | Promise<Partial<FileData & TypeWithID>> | Promise<void> | void;
24
34
  export interface TypeWithPrefix {
25
35
  prefix?: string;
@@ -29,7 +39,28 @@ export type HandleDelete = (args: {
29
39
  doc: FileData & TypeWithID & TypeWithPrefix;
30
40
  filename: string;
31
41
  req: PayloadRequest;
42
+ /**
43
+ * Pre-resolved storage path of the object to delete.
44
+ */
45
+ storageFilePath: string;
46
+ }) => Promise<void> | void;
47
+ /** Deletes a stored object without requiring a saved document. */
48
+ export type DeleteFile = (args: {
49
+ collection: CollectionConfig;
50
+ req: PayloadRequest;
51
+ /** Complete storage path, with prefixes and `_objectKey` already resolved. */
52
+ storageFilePath: string;
32
53
  }) => Promise<void> | void;
54
+ /** Complete storage keys are resolved before invoking a provider operation. */
55
+ export type FileOperationArgs = {
56
+ collection: SanitizedCollectionConfig;
57
+ from: string;
58
+ mimeType?: string;
59
+ req: PayloadRequest;
60
+ to: string;
61
+ };
62
+ export type CopyFile = (args: FileOperationArgs) => Promise<void>;
63
+ export type MoveFile = (args: FileOperationArgs) => Promise<void>;
33
64
  export type GenerateURL = (args: {
34
65
  collection: CollectionConfig;
35
66
  data: any;
@@ -40,14 +71,17 @@ export type StaticHandler = (req: PayloadRequest, args: {
40
71
  doc?: TypeWithID;
41
72
  headers?: Headers;
42
73
  params: {
43
- clientUploadContext?: unknown;
44
74
  collection: string;
45
75
  filename: string;
76
+ operation?: FileHandlerOperation;
46
77
  prefix?: string;
78
+ uploadReference?: unknown;
47
79
  };
48
80
  }) => Promise<Response> | Response;
49
81
  export interface GeneratedAdapter {
50
- clientUploads?: ClientUploadsConfig;
82
+ /** Preserve object metadata and fail if `to` already exists. Rename retains `from` for history. */
83
+ copyFile: CopyFile;
84
+ deleteFile: DeleteFile;
51
85
  /**
52
86
  * Additional fields to be injected into the base collection and image sizes
53
87
  */
@@ -58,9 +92,24 @@ export interface GeneratedAdapter {
58
92
  generateURL?: GenerateURL;
59
93
  handleDelete: HandleDelete;
60
94
  handleUpload: HandleUpload;
95
+ moveFile?: MoveFile;
61
96
  name: string;
62
- onInit?: () => void;
97
+ onInit?: () => Promise<void> | void;
63
98
  staticHandler: StaticHandler;
99
+ /** Reads source files by path when staging server-mediated uploads. */
100
+ supportsTempFiles?: boolean;
101
+ /** Generates upload instructions when supported. */
102
+ uploadInstructions?: {
103
+ adminHandler?: {
104
+ path: string;
105
+ props?: Record<string, unknown>;
106
+ };
107
+ enabled: boolean;
108
+ endpoint?: {
109
+ handler: PayloadHandler;
110
+ path: `/${string}`;
111
+ };
112
+ } & UploadInstructionsCapability;
64
113
  }
65
114
  export type Adapter = (args: {
66
115
  collection: CollectionConfig;
@@ -87,16 +136,6 @@ export interface CollectionOptions {
87
136
  prefix?: string;
88
137
  }
89
138
  export interface PluginOptions {
90
- /**
91
- * When enabled, fields (like the prefix field) will always be inserted into
92
- * the collection schema regardless of whether the plugin is enabled. This
93
- * ensures a consistent schema across all environments.
94
- *
95
- * This will be enabled by default in Payload v4.
96
- *
97
- * @default false
98
- */
99
- alwaysInsertFields?: boolean;
100
139
  collections: Partial<Record<UploadCollectionSlug, CollectionOptions>>;
101
140
  /**
102
141
  * Whether or not to enable the plugin