@payloadcms/plugin-cloud-storage 3.89.0 → 3.90.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -0
- package/dist/exports/client.d.ts +1 -1
- package/dist/exports/client.d.ts.map +1 -1
- package/dist/exports/client.js +1 -1
- package/dist/exports/client.js.map +1 -1
- package/dist/exports/utilities.d.ts +3 -2
- package/dist/exports/utilities.d.ts.map +1 -1
- package/dist/exports/utilities.js +3 -2
- package/dist/exports/utilities.js.map +1 -1
- package/dist/fields/getFields.d.ts.map +1 -1
- package/dist/fields/getFields.js +28 -1
- package/dist/fields/getFields.js.map +1 -1
- package/dist/hooks/afterChange.d.ts +3 -1
- package/dist/hooks/afterChange.d.ts.map +1 -1
- package/dist/hooks/afterChange.js +56 -9
- package/dist/hooks/afterChange.js.map +1 -1
- package/dist/hooks/afterChange.spec.js +150 -0
- package/dist/hooks/afterChange.spec.js.map +1 -0
- package/dist/hooks/afterDelete.d.ts +3 -1
- package/dist/hooks/afterDelete.d.ts.map +1 -1
- package/dist/hooks/afterDelete.js +16 -2
- package/dist/hooks/afterDelete.js.map +1 -1
- package/dist/hooks/afterRead.d.ts.map +1 -1
- package/dist/hooks/afterRead.js +13 -2
- package/dist/hooks/afterRead.js.map +1 -1
- package/dist/hooks/beforeChange.d.ts.map +1 -1
- package/dist/hooks/beforeChange.js +10 -1
- package/dist/hooks/beforeChange.js.map +1 -1
- package/dist/hooks/normalizeUploadPrefix.d.ts +11 -0
- package/dist/hooks/normalizeUploadPrefix.d.ts.map +1 -0
- package/dist/hooks/normalizeUploadPrefix.js +42 -0
- package/dist/hooks/normalizeUploadPrefix.js.map +1 -0
- package/dist/hooks/normalizeUploadPrefix.spec.js +154 -0
- package/dist/hooks/normalizeUploadPrefix.spec.js.map +1 -0
- package/dist/plugin.d.ts.map +1 -1
- package/dist/plugin.js +15 -6
- package/dist/plugin.js.map +1 -1
- package/dist/plugin.spec.js +166 -0
- package/dist/plugin.spec.js.map +1 -0
- package/dist/types.d.ts +23 -1
- package/dist/types.d.ts.map +1 -1
- package/dist/types.js.map +1 -1
- package/dist/utilities/assertReceiptMatchesFileKey.d.ts +15 -0
- package/dist/utilities/assertReceiptMatchesFileKey.d.ts.map +1 -0
- package/dist/utilities/assertReceiptMatchesFileKey.js +31 -0
- package/dist/utilities/assertReceiptMatchesFileKey.js.map +1 -0
- package/dist/utilities/buildPrefixWithObjectKey.d.ts +8 -0
- package/dist/utilities/buildPrefixWithObjectKey.d.ts.map +1 -0
- package/dist/utilities/buildPrefixWithObjectKey.js +13 -0
- package/dist/utilities/buildPrefixWithObjectKey.js.map +1 -0
- package/dist/utilities/buildStoragePathData.d.ts +55 -0
- package/dist/utilities/buildStoragePathData.d.ts.map +1 -0
- package/dist/utilities/buildStoragePathData.js +69 -0
- package/dist/utilities/buildStoragePathData.js.map +1 -0
- package/dist/utilities/buildStoragePathData.spec.js +254 -0
- package/dist/utilities/buildStoragePathData.spec.js.map +1 -0
- package/dist/utilities/getFilePrefix.d.ts +27 -11
- package/dist/utilities/getFilePrefix.d.ts.map +1 -1
- package/dist/utilities/getFilePrefix.js +75 -31
- package/dist/utilities/getFilePrefix.js.map +1 -1
- package/dist/utilities/getFilePrefix.spec.js +221 -35
- package/dist/utilities/getFilePrefix.spec.js.map +1 -1
- package/dist/utilities/resolveSignedURLKey.d.ts +11 -0
- package/dist/utilities/resolveSignedURLKey.d.ts.map +1 -1
- package/dist/utilities/resolveSignedURLKey.js +43 -8
- package/dist/utilities/resolveSignedURLKey.js.map +1 -1
- package/dist/utilities/resolveSignedURLKey.spec.js +56 -0
- package/dist/utilities/resolveSignedURLKey.spec.js.map +1 -0
- package/dist/utilities/sanitizePrefix.d.ts +2 -2
- package/dist/utilities/sanitizePrefix.js +4 -4
- package/dist/utilities/sanitizePrefix.js.map +1 -1
- package/dist/utilities/verifyClientUploadReceiptForFileKey.d.ts +20 -0
- package/dist/utilities/verifyClientUploadReceiptForFileKey.d.ts.map +1 -0
- package/dist/utilities/verifyClientUploadReceiptForFileKey.js +24 -0
- package/dist/utilities/verifyClientUploadReceiptForFileKey.js.map +1 -0
- package/dist/utilities/verifyClientUploadReceiptForFileKey.spec.js +108 -0
- package/dist/utilities/verifyClientUploadReceiptForFileKey.spec.js.map +1 -0
- package/package.json +4 -4
package/dist/hooks/afterRead.js
CHANGED
|
@@ -1,13 +1,24 @@
|
|
|
1
|
+
import { buildPrefixWithObjectKey } from '../utilities/buildPrefixWithObjectKey.js';
|
|
2
|
+
// The object's folder: semantic prefix + `_objectKey` segment.
|
|
3
|
+
const getObjectFolder = (data)=>{
|
|
4
|
+
const record = data ?? {};
|
|
5
|
+
return buildPrefixWithObjectKey({
|
|
6
|
+
objectKey: record._objectKey,
|
|
7
|
+
prefix: record.prefix
|
|
8
|
+
});
|
|
9
|
+
};
|
|
1
10
|
export const getAfterReadHook = ({ adapter, collection, disablePayloadAccessControl, generateFileURL, size })=>async ({ data, value })=>{
|
|
2
11
|
const filename = size ? data?.sizes?.[size.name]?.filename : data?.filename;
|
|
3
12
|
const prefix = data?.prefix;
|
|
13
|
+
// Direct-serve URLs encode the full location; the proxy resolves `_objectKey` server-side.
|
|
14
|
+
const objectFolder = getObjectFolder(data);
|
|
4
15
|
let url = value;
|
|
5
16
|
if (filename) {
|
|
6
17
|
if (generateFileURL) {
|
|
7
18
|
url = await generateFileURL({
|
|
8
19
|
collection,
|
|
9
20
|
filename,
|
|
10
|
-
prefix,
|
|
21
|
+
prefix: objectFolder,
|
|
11
22
|
size
|
|
12
23
|
});
|
|
13
24
|
} else if (disablePayloadAccessControl && adapter.generateURL) {
|
|
@@ -15,7 +26,7 @@ export const getAfterReadHook = ({ adapter, collection, disablePayloadAccessCont
|
|
|
15
26
|
collection,
|
|
16
27
|
data,
|
|
17
28
|
filename,
|
|
18
|
-
prefix
|
|
29
|
+
prefix: objectFolder
|
|
19
30
|
});
|
|
20
31
|
} else if (url && prefix) {
|
|
21
32
|
const separator = url.includes('?') ? '&' : '?';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/hooks/afterRead.ts"],"sourcesContent":["import type { CollectionConfig, FieldHook, ImageSize } from 'payload'\n\nimport type { GeneratedAdapter, GenerateFileURL } from '../types.js'\n\ninterface Args {\n adapter: GeneratedAdapter\n collection: CollectionConfig\n disablePayloadAccessControl?: boolean\n generateFileURL?: GenerateFileURL\n size?: ImageSize\n}\n\nexport const getAfterReadHook =\n ({ adapter, collection, disablePayloadAccessControl, generateFileURL, size }: Args): FieldHook =>\n async ({ data, value }) => {\n const filename = size ? data?.sizes?.[size.name]?.filename : data?.filename\n const prefix = data?.prefix\n let url = value\n\n if (filename) {\n if (generateFileURL) {\n url = await generateFileURL({\n collection,\n filename,\n prefix,\n size,\n })\n } else if (disablePayloadAccessControl && adapter.generateURL) {\n url = await adapter.generateURL({\n collection,\n data,\n filename,\n prefix,\n })\n } else if (url && prefix) {\n const separator = url.includes('?') ? '&' : '?'\n url = `${url}${separator}prefix=${encodeURIComponent(prefix)}`\n }\n }\n\n return url\n }\n"],"names":["getAfterReadHook","adapter","collection","disablePayloadAccessControl","generateFileURL","size","
|
|
1
|
+
{"version":3,"sources":["../../src/hooks/afterRead.ts"],"sourcesContent":["import type { CollectionConfig, FieldHook, ImageSize } from 'payload'\n\nimport type { GeneratedAdapter, GenerateFileURL } from '../types.js'\n\nimport { buildPrefixWithObjectKey } from '../utilities/buildPrefixWithObjectKey.js'\n\ninterface Args {\n adapter: GeneratedAdapter\n collection: CollectionConfig\n disablePayloadAccessControl?: boolean\n generateFileURL?: GenerateFileURL\n size?: ImageSize\n}\n\n// The object's folder: semantic prefix + `_objectKey` segment.\nconst getObjectFolder = (data: { _objectKey?: string; prefix?: string } | undefined): string => {\n const record = (data ?? {}) as { _objectKey?: string; prefix?: string }\n return buildPrefixWithObjectKey({ objectKey: record._objectKey, prefix: record.prefix })\n}\n\nexport const getAfterReadHook =\n ({ adapter, collection, disablePayloadAccessControl, generateFileURL, size }: Args): FieldHook =>\n async ({ data, value }) => {\n const filename = size ? data?.sizes?.[size.name]?.filename : data?.filename\n const prefix = data?.prefix\n // Direct-serve URLs encode the full location; the proxy resolves `_objectKey` server-side.\n const objectFolder = getObjectFolder(data)\n let url = value\n\n if (filename) {\n if (generateFileURL) {\n url = await generateFileURL({\n collection,\n filename,\n prefix: objectFolder,\n size,\n })\n } else if (disablePayloadAccessControl && adapter.generateURL) {\n url = await adapter.generateURL({\n collection,\n data,\n filename,\n prefix: objectFolder,\n })\n } else if (url && prefix) {\n const separator = url.includes('?') ? '&' : '?'\n url = `${url}${separator}prefix=${encodeURIComponent(prefix)}`\n }\n }\n\n return url\n }\n"],"names":["buildPrefixWithObjectKey","getObjectFolder","data","record","objectKey","_objectKey","prefix","getAfterReadHook","adapter","collection","disablePayloadAccessControl","generateFileURL","size","value","filename","sizes","name","objectFolder","url","generateURL","separator","includes","encodeURIComponent"],"mappings":"AAIA,SAASA,wBAAwB,QAAQ,2CAA0C;AAUnF,+DAA+D;AAC/D,MAAMC,kBAAkB,CAACC;IACvB,MAAMC,SAAUD,QAAQ,CAAC;IACzB,OAAOF,yBAAyB;QAAEI,WAAWD,OAAOE,UAAU;QAAEC,QAAQH,OAAOG,MAAM;IAAC;AACxF;AAEA,OAAO,MAAMC,mBACX,CAAC,EAAEC,OAAO,EAAEC,UAAU,EAAEC,2BAA2B,EAAEC,eAAe,EAAEC,IAAI,EAAQ,GAClF,OAAO,EAAEV,IAAI,EAAEW,KAAK,EAAE;QACpB,MAAMC,WAAWF,OAAOV,MAAMa,OAAO,CAACH,KAAKI,IAAI,CAAC,EAAEF,WAAWZ,MAAMY;QACnE,MAAMR,SAASJ,MAAMI;QACrB,2FAA2F;QAC3F,MAAMW,eAAehB,gBAAgBC;QACrC,IAAIgB,MAAML;QAEV,IAAIC,UAAU;YACZ,IAAIH,iBAAiB;gBACnBO,MAAM,MAAMP,gBAAgB;oBAC1BF;oBACAK;oBACAR,QAAQW;oBACRL;gBACF;YACF,OAAO,IAAIF,+BAA+BF,QAAQW,WAAW,EAAE;gBAC7DD,MAAM,MAAMV,QAAQW,WAAW,CAAC;oBAC9BV;oBACAP;oBACAY;oBACAR,QAAQW;gBACV;YACF,OAAO,IAAIC,OAAOZ,QAAQ;gBACxB,MAAMc,YAAYF,IAAIG,QAAQ,CAAC,OAAO,MAAM;gBAC5CH,MAAM,GAAGA,MAAME,UAAU,OAAO,EAAEE,mBAAmBhB,SAAS;YAChE;QACF;QAEA,OAAOY;IACT,EAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"beforeChange.d.ts","sourceRoot":"","sources":["../../src/hooks/beforeChange.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,SAAS,CAAA;AAErE,OAAO,KAAK,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;
|
|
1
|
+
{"version":3,"file":"beforeChange.d.ts","sourceRoot":"","sources":["../../src/hooks/beforeChange.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,SAAS,CAAA;AAErE,OAAO,KAAK,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAIpE,UAAU,IAAI;IACZ,OAAO,EAAE,gBAAgB,CAAA;IACzB,UAAU,EAAE,gBAAgB,CAAA;IAC5B,2BAA2B,CAAC,EAAE,OAAO,CAAA;IACrC,eAAe,CAAC,EAAE,eAAe,CAAA;IACjC,IAAI,CAAC,EAAE,SAAS,CAAA;CACjB;AAWD,eAAO,MAAM,mBAAmB,gFACgD,IAAI,KAAG,SA2BpF,CAAA"}
|
|
@@ -1,8 +1,17 @@
|
|
|
1
|
+
import { buildPrefixWithObjectKey } from '../utilities/buildPrefixWithObjectKey.js';
|
|
2
|
+
// The object's folder: semantic prefix + `_objectKey` segment.
|
|
3
|
+
const getObjectFolder = (data, originalDoc)=>{
|
|
4
|
+
const source = data ?? originalDoc ?? {};
|
|
5
|
+
return buildPrefixWithObjectKey({
|
|
6
|
+
objectKey: source._objectKey,
|
|
7
|
+
prefix: source.prefix
|
|
8
|
+
});
|
|
9
|
+
};
|
|
1
10
|
export const getBeforeChangeHook = ({ adapter, collection, disablePayloadAccessControl, generateFileURL, size })=>async ({ data, originalDoc, value })=>{
|
|
2
11
|
const newFilename = size ? data?.sizes?.[size.name]?.filename : data?.filename;
|
|
3
12
|
const originalFilename = size ? originalDoc?.sizes?.[size.name]?.filename : originalDoc?.filename;
|
|
4
13
|
const filename = newFilename || originalFilename;
|
|
5
|
-
const prefix = data
|
|
14
|
+
const prefix = getObjectFolder(data, originalDoc);
|
|
6
15
|
let url = value;
|
|
7
16
|
if (generateFileURL && filename) {
|
|
8
17
|
url = await generateFileURL({
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/hooks/beforeChange.ts"],"sourcesContent":["import type { CollectionConfig, FieldHook, ImageSize } from 'payload'\n\nimport type { GeneratedAdapter, GenerateFileURL } from '../types.js'\n\ninterface Args {\n adapter: GeneratedAdapter\n collection: CollectionConfig\n disablePayloadAccessControl?: boolean\n generateFileURL?: GenerateFileURL\n size?: ImageSize\n}\n\nexport const getBeforeChangeHook =\n ({ adapter, collection, disablePayloadAccessControl, generateFileURL, size }: Args): FieldHook =>\n async ({ data, originalDoc, value }) => {\n const newFilename = size ? data?.sizes?.[size.name]?.filename : data?.filename\n const originalFilename = size\n ? originalDoc?.sizes?.[size.name]?.filename\n : originalDoc?.filename\n const filename = newFilename || originalFilename\n const prefix = data
|
|
1
|
+
{"version":3,"sources":["../../src/hooks/beforeChange.ts"],"sourcesContent":["import type { CollectionConfig, FieldHook, ImageSize } from 'payload'\n\nimport type { GeneratedAdapter, GenerateFileURL } from '../types.js'\n\nimport { buildPrefixWithObjectKey } from '../utilities/buildPrefixWithObjectKey.js'\n\ninterface Args {\n adapter: GeneratedAdapter\n collection: CollectionConfig\n disablePayloadAccessControl?: boolean\n generateFileURL?: GenerateFileURL\n size?: ImageSize\n}\n\n// The object's folder: semantic prefix + `_objectKey` segment.\nconst getObjectFolder = (data: unknown, originalDoc: unknown): string => {\n const source = (data ?? originalDoc ?? {}) as { _objectKey?: string; prefix?: string }\n return buildPrefixWithObjectKey({\n objectKey: source._objectKey,\n prefix: source.prefix,\n })\n}\n\nexport const getBeforeChangeHook =\n ({ adapter, collection, disablePayloadAccessControl, generateFileURL, size }: Args): FieldHook =>\n async ({ data, originalDoc, value }) => {\n const newFilename = size ? data?.sizes?.[size.name]?.filename : data?.filename\n const originalFilename = size\n ? originalDoc?.sizes?.[size.name]?.filename\n : originalDoc?.filename\n const filename = newFilename || originalFilename\n const prefix = getObjectFolder(data, originalDoc)\n let url = value\n\n if (generateFileURL && filename) {\n url = await generateFileURL({\n collection,\n filename,\n prefix,\n size,\n })\n } else if (disablePayloadAccessControl && filename && adapter.generateURL) {\n url = await adapter.generateURL({\n collection,\n data: data || originalDoc,\n filename,\n prefix,\n })\n }\n\n return url\n }\n"],"names":["buildPrefixWithObjectKey","getObjectFolder","data","originalDoc","source","objectKey","_objectKey","prefix","getBeforeChangeHook","adapter","collection","disablePayloadAccessControl","generateFileURL","size","value","newFilename","sizes","name","filename","originalFilename","url","generateURL"],"mappings":"AAIA,SAASA,wBAAwB,QAAQ,2CAA0C;AAUnF,+DAA+D;AAC/D,MAAMC,kBAAkB,CAACC,MAAeC;IACtC,MAAMC,SAAUF,QAAQC,eAAe,CAAC;IACxC,OAAOH,yBAAyB;QAC9BK,WAAWD,OAAOE,UAAU;QAC5BC,QAAQH,OAAOG,MAAM;IACvB;AACF;AAEA,OAAO,MAAMC,sBACX,CAAC,EAAEC,OAAO,EAAEC,UAAU,EAAEC,2BAA2B,EAAEC,eAAe,EAAEC,IAAI,EAAQ,GAClF,OAAO,EAAEX,IAAI,EAAEC,WAAW,EAAEW,KAAK,EAAE;QACjC,MAAMC,cAAcF,OAAOX,MAAMc,OAAO,CAACH,KAAKI,IAAI,CAAC,EAAEC,WAAWhB,MAAMgB;QACtE,MAAMC,mBAAmBN,OACrBV,aAAaa,OAAO,CAACH,KAAKI,IAAI,CAAC,EAAEC,WACjCf,aAAae;QACjB,MAAMA,WAAWH,eAAeI;QAChC,MAAMZ,SAASN,gBAAgBC,MAAMC;QACrC,IAAIiB,MAAMN;QAEV,IAAIF,mBAAmBM,UAAU;YAC/BE,MAAM,MAAMR,gBAAgB;gBAC1BF;gBACAQ;gBACAX;gBACAM;YACF;QACF,OAAO,IAAIF,+BAA+BO,YAAYT,QAAQY,WAAW,EAAE;YACzED,MAAM,MAAMX,QAAQY,WAAW,CAAC;gBAC9BX;gBACAR,MAAMA,QAAQC;gBACde;gBACAX;YACF;QACF;QAEA,OAAOa;IACT,EAAC"}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type { CollectionBeforeChangeHook, FieldHook } from 'payload';
|
|
2
|
+
type Args = {
|
|
3
|
+
collectionPrefix?: string;
|
|
4
|
+
useCompositePrefixes?: boolean;
|
|
5
|
+
};
|
|
6
|
+
/** Persist new upload destinations without reinterpreting metadata-only updates. */
|
|
7
|
+
export declare const getNormalizeUploadPrefixHook: ({ collectionPrefix, useCompositePrefixes }: Args) => CollectionBeforeChangeHook;
|
|
8
|
+
/** Run last on the prefix field so user hooks cannot leave stale storage coordinates. */
|
|
9
|
+
export declare const getNormalizeUploadPrefixFieldHook: ({ collectionPrefix, useCompositePrefixes }: Args) => FieldHook;
|
|
10
|
+
export {};
|
|
11
|
+
//# sourceMappingURL=normalizeUploadPrefix.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"normalizeUploadPrefix.d.ts","sourceRoot":"","sources":["../../src/hooks/normalizeUploadPrefix.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,0BAA0B,EAAE,SAAS,EAAE,MAAM,SAAS,CAAA;AAIpE,KAAK,IAAI,GAAG;IACV,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B,CAAA;AAiBD,oFAAoF;AACpF,eAAO,MAAM,4BAA4B,+CACM,IAAI,KAAG,0BAiBnD,CAAA;AAEH,yFAAyF;AACzF,eAAO,MAAM,iCAAiC,+CACC,IAAI,KAAG,SAenD,CAAA"}
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
import { buildUploadPrefix } from '../utilities/buildStoragePathData.js';
|
|
2
|
+
/**
|
|
3
|
+
* A prefix the caller did not supply, or supplied unchanged, is left as stored so
|
|
4
|
+
* pre-upgrade files keep resolving to their original object keys. Anything the caller
|
|
5
|
+
* chooses is contained, because `prefix` is writable through the REST, GraphQL and
|
|
6
|
+
* Local APIs and the read path trusts whatever is persisted.
|
|
7
|
+
*/ const isPrefixSupplied = ({ storedPrefix, value })=>typeof value === 'string' && value !== (typeof storedPrefix === 'string' ? storedPrefix : '');
|
|
8
|
+
/** Persist new upload destinations without reinterpreting metadata-only updates. */ export const getNormalizeUploadPrefixHook = ({ collectionPrefix, useCompositePrefixes })=>({ data, originalDoc, req })=>{
|
|
9
|
+
if (req.context?.skipCloudStorage) {
|
|
10
|
+
return data;
|
|
11
|
+
}
|
|
12
|
+
if (!req.file && !isPrefixSupplied({
|
|
13
|
+
storedPrefix: originalDoc?.prefix,
|
|
14
|
+
value: data.prefix
|
|
15
|
+
})) {
|
|
16
|
+
return data;
|
|
17
|
+
}
|
|
18
|
+
data.prefix = buildUploadPrefix({
|
|
19
|
+
collectionPrefix,
|
|
20
|
+
docPrefix: typeof data.prefix === 'string' ? data.prefix : '',
|
|
21
|
+
useCompositePrefixes
|
|
22
|
+
}).sanitizedDocPrefix;
|
|
23
|
+
return data;
|
|
24
|
+
};
|
|
25
|
+
/** Run last on the prefix field so user hooks cannot leave stale storage coordinates. */ export const getNormalizeUploadPrefixFieldHook = ({ collectionPrefix, useCompositePrefixes })=>({ previousValue, req, value })=>{
|
|
26
|
+
if (req.context?.skipCloudStorage) {
|
|
27
|
+
return value;
|
|
28
|
+
}
|
|
29
|
+
if (!req.file && !isPrefixSupplied({
|
|
30
|
+
storedPrefix: previousValue,
|
|
31
|
+
value
|
|
32
|
+
})) {
|
|
33
|
+
return value;
|
|
34
|
+
}
|
|
35
|
+
return buildUploadPrefix({
|
|
36
|
+
collectionPrefix,
|
|
37
|
+
docPrefix: typeof value === 'string' ? value : '',
|
|
38
|
+
useCompositePrefixes
|
|
39
|
+
}).sanitizedDocPrefix;
|
|
40
|
+
};
|
|
41
|
+
|
|
42
|
+
//# sourceMappingURL=normalizeUploadPrefix.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../src/hooks/normalizeUploadPrefix.ts"],"sourcesContent":["import type { CollectionBeforeChangeHook, FieldHook } from 'payload'\n\nimport { buildUploadPrefix } from '../utilities/buildStoragePathData.js'\n\ntype Args = {\n collectionPrefix?: string\n useCompositePrefixes?: boolean\n}\n\n/**\n * A prefix the caller did not supply, or supplied unchanged, is left as stored so\n * pre-upgrade files keep resolving to their original object keys. Anything the caller\n * chooses is contained, because `prefix` is writable through the REST, GraphQL and\n * Local APIs and the read path trusts whatever is persisted.\n */\nconst isPrefixSupplied = ({\n storedPrefix,\n value,\n}: {\n storedPrefix: unknown\n value: unknown\n}): boolean =>\n typeof value === 'string' && value !== (typeof storedPrefix === 'string' ? storedPrefix : '')\n\n/** Persist new upload destinations without reinterpreting metadata-only updates. */\nexport const getNormalizeUploadPrefixHook =\n ({ collectionPrefix, useCompositePrefixes }: Args): CollectionBeforeChangeHook =>\n ({ data, originalDoc, req }) => {\n if (req.context?.skipCloudStorage) {\n return data\n }\n\n if (!req.file && !isPrefixSupplied({ storedPrefix: originalDoc?.prefix, value: data.prefix })) {\n return data\n }\n\n data.prefix = buildUploadPrefix({\n collectionPrefix,\n docPrefix: typeof data.prefix === 'string' ? data.prefix : '',\n useCompositePrefixes,\n }).sanitizedDocPrefix\n\n return data\n }\n\n/** Run last on the prefix field so user hooks cannot leave stale storage coordinates. */\nexport const getNormalizeUploadPrefixFieldHook =\n ({ collectionPrefix, useCompositePrefixes }: Args): FieldHook =>\n ({ previousValue, req, value }) => {\n if (req.context?.skipCloudStorage) {\n return value\n }\n\n if (!req.file && !isPrefixSupplied({ storedPrefix: previousValue, value })) {\n return value\n }\n\n return buildUploadPrefix({\n collectionPrefix,\n docPrefix: typeof value === 'string' ? value : '',\n useCompositePrefixes,\n }).sanitizedDocPrefix\n }\n"],"names":["buildUploadPrefix","isPrefixSupplied","storedPrefix","value","getNormalizeUploadPrefixHook","collectionPrefix","useCompositePrefixes","data","originalDoc","req","context","skipCloudStorage","file","prefix","docPrefix","sanitizedDocPrefix","getNormalizeUploadPrefixFieldHook","previousValue"],"mappings":"AAEA,SAASA,iBAAiB,QAAQ,uCAAsC;AAOxE;;;;;CAKC,GACD,MAAMC,mBAAmB,CAAC,EACxBC,YAAY,EACZC,KAAK,EAIN,GACC,OAAOA,UAAU,YAAYA,UAAW,CAAA,OAAOD,iBAAiB,WAAWA,eAAe,EAAC;AAE7F,kFAAkF,GAClF,OAAO,MAAME,+BACX,CAAC,EAAEC,gBAAgB,EAAEC,oBAAoB,EAAQ,GACjD,CAAC,EAAEC,IAAI,EAAEC,WAAW,EAAEC,GAAG,EAAE;QACzB,IAAIA,IAAIC,OAAO,EAAEC,kBAAkB;YACjC,OAAOJ;QACT;QAEA,IAAI,CAACE,IAAIG,IAAI,IAAI,CAACX,iBAAiB;YAAEC,cAAcM,aAAaK;YAAQV,OAAOI,KAAKM,MAAM;QAAC,IAAI;YAC7F,OAAON;QACT;QAEAA,KAAKM,MAAM,GAAGb,kBAAkB;YAC9BK;YACAS,WAAW,OAAOP,KAAKM,MAAM,KAAK,WAAWN,KAAKM,MAAM,GAAG;YAC3DP;QACF,GAAGS,kBAAkB;QAErB,OAAOR;IACT,EAAC;AAEH,uFAAuF,GACvF,OAAO,MAAMS,oCACX,CAAC,EAAEX,gBAAgB,EAAEC,oBAAoB,EAAQ,GACjD,CAAC,EAAEW,aAAa,EAAER,GAAG,EAAEN,KAAK,EAAE;QAC5B,IAAIM,IAAIC,OAAO,EAAEC,kBAAkB;YACjC,OAAOR;QACT;QAEA,IAAI,CAACM,IAAIG,IAAI,IAAI,CAACX,iBAAiB;YAAEC,cAAce;YAAed;QAAM,IAAI;YAC1E,OAAOA;QACT;QAEA,OAAOH,kBAAkB;YACvBK;YACAS,WAAW,OAAOX,UAAU,WAAWA,QAAQ;YAC/CG;QACF,GAAGS,kBAAkB;IACvB,EAAC"}
|
|
@@ -0,0 +1,154 @@
|
|
|
1
|
+
import { describe, expect, it } from 'vitest';
|
|
2
|
+
import { getFields } from '../fields/getFields.js';
|
|
3
|
+
import { getNormalizeUploadPrefixFieldHook, getNormalizeUploadPrefixHook } from './normalizeUploadPrefix.js';
|
|
4
|
+
const runHook = ({ data, originalDoc, req = {
|
|
5
|
+
context: {},
|
|
6
|
+
file: {}
|
|
7
|
+
} })=>getNormalizeUploadPrefixHook({
|
|
8
|
+
collectionPrefix: 'media'
|
|
9
|
+
})({
|
|
10
|
+
data,
|
|
11
|
+
originalDoc,
|
|
12
|
+
req
|
|
13
|
+
});
|
|
14
|
+
describe('new upload prefixes', ()=>{
|
|
15
|
+
it('should normalize after custom prefix field hooks', async ()=>{
|
|
16
|
+
const fields = getFields({
|
|
17
|
+
collection: {
|
|
18
|
+
fields: [
|
|
19
|
+
{
|
|
20
|
+
name: 'prefix',
|
|
21
|
+
type: 'text',
|
|
22
|
+
hooks: {
|
|
23
|
+
beforeChange: [
|
|
24
|
+
()=>'custom'
|
|
25
|
+
]
|
|
26
|
+
}
|
|
27
|
+
}
|
|
28
|
+
]
|
|
29
|
+
},
|
|
30
|
+
prefix: 'media'
|
|
31
|
+
});
|
|
32
|
+
const field = fields.find((field)=>'name' in field && field.name === 'prefix');
|
|
33
|
+
let value = 'original';
|
|
34
|
+
for (const hook of field.hooks?.beforeChange || []){
|
|
35
|
+
value = await hook({
|
|
36
|
+
value,
|
|
37
|
+
data: {
|
|
38
|
+
filename: 'file.png'
|
|
39
|
+
},
|
|
40
|
+
req: {
|
|
41
|
+
file: {},
|
|
42
|
+
context: {}
|
|
43
|
+
}
|
|
44
|
+
});
|
|
45
|
+
}
|
|
46
|
+
expect(value).toBe('media/custom');
|
|
47
|
+
});
|
|
48
|
+
it('should contain a prefix supplied with a file upload', async ()=>{
|
|
49
|
+
const result = await runHook({
|
|
50
|
+
data: {
|
|
51
|
+
filename: 'file.png',
|
|
52
|
+
prefix: 'legacy'
|
|
53
|
+
}
|
|
54
|
+
});
|
|
55
|
+
expect(result.prefix).toBe('media/legacy');
|
|
56
|
+
});
|
|
57
|
+
it('should leave internal cloud storage writes alone', async ()=>{
|
|
58
|
+
const result = await runHook({
|
|
59
|
+
data: {
|
|
60
|
+
filename: 'file.png',
|
|
61
|
+
prefix: 'legacy'
|
|
62
|
+
},
|
|
63
|
+
req: {
|
|
64
|
+
context: {
|
|
65
|
+
skipCloudStorage: true
|
|
66
|
+
},
|
|
67
|
+
file: {}
|
|
68
|
+
}
|
|
69
|
+
});
|
|
70
|
+
expect(result.prefix).toBe('legacy');
|
|
71
|
+
});
|
|
72
|
+
/**
|
|
73
|
+
* The `prefix` field is writable through the REST/GraphQL/Local API, so a request
|
|
74
|
+
* carrying no file must not be able to point a document at a foreign object.
|
|
75
|
+
*/ it('should contain a caller-supplied prefix on a metadata-only update', async ()=>{
|
|
76
|
+
const result = await runHook({
|
|
77
|
+
data: {
|
|
78
|
+
prefix: 'tenant-b/private'
|
|
79
|
+
},
|
|
80
|
+
originalDoc: {
|
|
81
|
+
prefix: 'media/legacy'
|
|
82
|
+
},
|
|
83
|
+
req: {
|
|
84
|
+
context: {}
|
|
85
|
+
}
|
|
86
|
+
});
|
|
87
|
+
expect(result.prefix).toBe('media/tenant-b/private');
|
|
88
|
+
});
|
|
89
|
+
it('should contain a caller-supplied prefix on a create without a file', async ()=>{
|
|
90
|
+
const result = await runHook({
|
|
91
|
+
data: {
|
|
92
|
+
prefix: 'tenant-b/private'
|
|
93
|
+
},
|
|
94
|
+
req: {
|
|
95
|
+
context: {}
|
|
96
|
+
}
|
|
97
|
+
});
|
|
98
|
+
expect(result.prefix).toBe('media/tenant-b/private');
|
|
99
|
+
});
|
|
100
|
+
it('should leave a stored prefix alone when the request omits it', async ()=>{
|
|
101
|
+
const result = await runHook({
|
|
102
|
+
data: {
|
|
103
|
+
filename: 'legacy.png'
|
|
104
|
+
},
|
|
105
|
+
originalDoc: {
|
|
106
|
+
prefix: 'legacy-invoices'
|
|
107
|
+
},
|
|
108
|
+
req: {
|
|
109
|
+
context: {}
|
|
110
|
+
}
|
|
111
|
+
});
|
|
112
|
+
expect(result.prefix).toBeUndefined();
|
|
113
|
+
});
|
|
114
|
+
it('should leave a stored prefix alone when the request repeats it unchanged', async ()=>{
|
|
115
|
+
const result = await runHook({
|
|
116
|
+
data: {
|
|
117
|
+
prefix: 'legacy-invoices'
|
|
118
|
+
},
|
|
119
|
+
originalDoc: {
|
|
120
|
+
prefix: 'legacy-invoices'
|
|
121
|
+
},
|
|
122
|
+
req: {
|
|
123
|
+
context: {}
|
|
124
|
+
}
|
|
125
|
+
});
|
|
126
|
+
expect(result.prefix).toBe('legacy-invoices');
|
|
127
|
+
});
|
|
128
|
+
describe('prefix field hook', ()=>{
|
|
129
|
+
const runFieldHook = ({ previousValue, req = {
|
|
130
|
+
context: {}
|
|
131
|
+
}, value })=>getNormalizeUploadPrefixFieldHook({
|
|
132
|
+
collectionPrefix: 'media'
|
|
133
|
+
})({
|
|
134
|
+
data: {},
|
|
135
|
+
previousValue,
|
|
136
|
+
req,
|
|
137
|
+
value
|
|
138
|
+
});
|
|
139
|
+
it('should contain a caller-supplied value without a file', async ()=>{
|
|
140
|
+
expect(await runFieldHook({
|
|
141
|
+
previousValue: 'media/legacy',
|
|
142
|
+
value: 'tenant-b/private'
|
|
143
|
+
})).toBe('media/tenant-b/private');
|
|
144
|
+
});
|
|
145
|
+
it('should leave an unchanged value alone', async ()=>{
|
|
146
|
+
expect(await runFieldHook({
|
|
147
|
+
previousValue: 'legacy-invoices',
|
|
148
|
+
value: 'legacy-invoices'
|
|
149
|
+
})).toBe('legacy-invoices');
|
|
150
|
+
});
|
|
151
|
+
});
|
|
152
|
+
});
|
|
153
|
+
|
|
154
|
+
//# sourceMappingURL=normalizeUploadPrefix.spec.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../src/hooks/normalizeUploadPrefix.spec.ts"],"sourcesContent":["import type { CollectionConfig, TextField } from 'payload'\n\nimport { describe, expect, it } from 'vitest'\n\nimport { getFields } from '../fields/getFields.js'\nimport {\n getNormalizeUploadPrefixFieldHook,\n getNormalizeUploadPrefixHook,\n} from './normalizeUploadPrefix.js'\n\nconst runHook = ({\n data,\n originalDoc,\n req = { context: {}, file: {} },\n}: {\n data: Record<string, unknown>\n originalDoc?: Record<string, unknown>\n req?: Record<string, unknown>\n}) =>\n getNormalizeUploadPrefixHook({ collectionPrefix: 'media' })({\n data,\n originalDoc,\n req,\n } as never)\n\ndescribe('new upload prefixes', () => {\n it('should normalize after custom prefix field hooks', async () => {\n const fields = getFields({\n collection: {\n fields: [{ name: 'prefix', type: 'text', hooks: { beforeChange: [() => 'custom'] } }],\n } as CollectionConfig,\n prefix: 'media',\n })\n const field = fields.find((field) => 'name' in field && field.name === 'prefix') as TextField\n let value = 'original'\n\n for (const hook of field.hooks?.beforeChange || []) {\n value = await hook({\n value,\n data: { filename: 'file.png' },\n req: { file: {}, context: {} },\n } as never)\n }\n\n expect(value).toBe('media/custom')\n })\n\n it('should contain a prefix supplied with a file upload', async () => {\n const result = await runHook({ data: { filename: 'file.png', prefix: 'legacy' } })\n\n expect(result.prefix).toBe('media/legacy')\n })\n\n it('should leave internal cloud storage writes alone', async () => {\n const result = await runHook({\n data: { filename: 'file.png', prefix: 'legacy' },\n req: { context: { skipCloudStorage: true }, file: {} },\n })\n\n expect(result.prefix).toBe('legacy')\n })\n\n /**\n * The `prefix` field is writable through the REST/GraphQL/Local API, so a request\n * carrying no file must not be able to point a document at a foreign object.\n */\n it('should contain a caller-supplied prefix on a metadata-only update', async () => {\n const result = await runHook({\n data: { prefix: 'tenant-b/private' },\n originalDoc: { prefix: 'media/legacy' },\n req: { context: {} },\n })\n\n expect(result.prefix).toBe('media/tenant-b/private')\n })\n\n it('should contain a caller-supplied prefix on a create without a file', async () => {\n const result = await runHook({\n data: { prefix: 'tenant-b/private' },\n req: { context: {} },\n })\n\n expect(result.prefix).toBe('media/tenant-b/private')\n })\n\n it('should leave a stored prefix alone when the request omits it', async () => {\n const result = await runHook({\n data: { filename: 'legacy.png' },\n originalDoc: { prefix: 'legacy-invoices' },\n req: { context: {} },\n })\n\n expect(result.prefix).toBeUndefined()\n })\n\n it('should leave a stored prefix alone when the request repeats it unchanged', async () => {\n const result = await runHook({\n data: { prefix: 'legacy-invoices' },\n originalDoc: { prefix: 'legacy-invoices' },\n req: { context: {} },\n })\n\n expect(result.prefix).toBe('legacy-invoices')\n })\n\n describe('prefix field hook', () => {\n const runFieldHook = ({\n previousValue,\n req = { context: {} },\n value,\n }: {\n previousValue?: string\n req?: Record<string, unknown>\n value: unknown\n }) =>\n getNormalizeUploadPrefixFieldHook({ collectionPrefix: 'media' })({\n data: {},\n previousValue,\n req,\n value,\n } as never)\n\n it('should contain a caller-supplied value without a file', async () => {\n expect(await runFieldHook({ previousValue: 'media/legacy', value: 'tenant-b/private' })).toBe(\n 'media/tenant-b/private',\n )\n })\n\n it('should leave an unchanged value alone', async () => {\n expect(\n await runFieldHook({ previousValue: 'legacy-invoices', value: 'legacy-invoices' }),\n ).toBe('legacy-invoices')\n })\n })\n})\n"],"names":["describe","expect","it","getFields","getNormalizeUploadPrefixFieldHook","getNormalizeUploadPrefixHook","runHook","data","originalDoc","req","context","file","collectionPrefix","fields","collection","name","type","hooks","beforeChange","prefix","field","find","value","hook","filename","toBe","result","skipCloudStorage","toBeUndefined","runFieldHook","previousValue"],"mappings":"AAEA,SAASA,QAAQ,EAAEC,MAAM,EAAEC,EAAE,QAAQ,SAAQ;AAE7C,SAASC,SAAS,QAAQ,yBAAwB;AAClD,SACEC,iCAAiC,EACjCC,4BAA4B,QACvB,6BAA4B;AAEnC,MAAMC,UAAU,CAAC,EACfC,IAAI,EACJC,WAAW,EACXC,MAAM;IAAEC,SAAS,CAAC;IAAGC,MAAM,CAAC;AAAE,CAAC,EAKhC,GACCN,6BAA6B;QAAEO,kBAAkB;IAAQ,GAAG;QAC1DL;QACAC;QACAC;IACF;AAEFT,SAAS,uBAAuB;IAC9BE,GAAG,oDAAoD;QACrD,MAAMW,SAASV,UAAU;YACvBW,YAAY;gBACVD,QAAQ;oBAAC;wBAAEE,MAAM;wBAAUC,MAAM;wBAAQC,OAAO;4BAAEC,cAAc;gCAAC,IAAM;6BAAS;wBAAC;oBAAE;iBAAE;YACvF;YACAC,QAAQ;QACV;QACA,MAAMC,QAAQP,OAAOQ,IAAI,CAAC,CAACD,QAAU,UAAUA,SAASA,MAAML,IAAI,KAAK;QACvE,IAAIO,QAAQ;QAEZ,KAAK,MAAMC,QAAQH,MAAMH,KAAK,EAAEC,gBAAgB,EAAE,CAAE;YAClDI,QAAQ,MAAMC,KAAK;gBACjBD;gBACAf,MAAM;oBAAEiB,UAAU;gBAAW;gBAC7Bf,KAAK;oBAAEE,MAAM,CAAC;oBAAGD,SAAS,CAAC;gBAAE;YAC/B;QACF;QAEAT,OAAOqB,OAAOG,IAAI,CAAC;IACrB;IAEAvB,GAAG,uDAAuD;QACxD,MAAMwB,SAAS,MAAMpB,QAAQ;YAAEC,MAAM;gBAAEiB,UAAU;gBAAYL,QAAQ;YAAS;QAAE;QAEhFlB,OAAOyB,OAAOP,MAAM,EAAEM,IAAI,CAAC;IAC7B;IAEAvB,GAAG,oDAAoD;QACrD,MAAMwB,SAAS,MAAMpB,QAAQ;YAC3BC,MAAM;gBAAEiB,UAAU;gBAAYL,QAAQ;YAAS;YAC/CV,KAAK;gBAAEC,SAAS;oBAAEiB,kBAAkB;gBAAK;gBAAGhB,MAAM,CAAC;YAAE;QACvD;QAEAV,OAAOyB,OAAOP,MAAM,EAAEM,IAAI,CAAC;IAC7B;IAEA;;;GAGC,GACDvB,GAAG,qEAAqE;QACtE,MAAMwB,SAAS,MAAMpB,QAAQ;YAC3BC,MAAM;gBAAEY,QAAQ;YAAmB;YACnCX,aAAa;gBAAEW,QAAQ;YAAe;YACtCV,KAAK;gBAAEC,SAAS,CAAC;YAAE;QACrB;QAEAT,OAAOyB,OAAOP,MAAM,EAAEM,IAAI,CAAC;IAC7B;IAEAvB,GAAG,sEAAsE;QACvE,MAAMwB,SAAS,MAAMpB,QAAQ;YAC3BC,MAAM;gBAAEY,QAAQ;YAAmB;YACnCV,KAAK;gBAAEC,SAAS,CAAC;YAAE;QACrB;QAEAT,OAAOyB,OAAOP,MAAM,EAAEM,IAAI,CAAC;IAC7B;IAEAvB,GAAG,gEAAgE;QACjE,MAAMwB,SAAS,MAAMpB,QAAQ;YAC3BC,MAAM;gBAAEiB,UAAU;YAAa;YAC/BhB,aAAa;gBAAEW,QAAQ;YAAkB;YACzCV,KAAK;gBAAEC,SAAS,CAAC;YAAE;QACrB;QAEAT,OAAOyB,OAAOP,MAAM,EAAES,aAAa;IACrC;IAEA1B,GAAG,4EAA4E;QAC7E,MAAMwB,SAAS,MAAMpB,QAAQ;YAC3BC,MAAM;gBAAEY,QAAQ;YAAkB;YAClCX,aAAa;gBAAEW,QAAQ;YAAkB;YACzCV,KAAK;gBAAEC,SAAS,CAAC;YAAE;QACrB;QAEAT,OAAOyB,OAAOP,MAAM,EAAEM,IAAI,CAAC;IAC7B;IAEAzB,SAAS,qBAAqB;QAC5B,MAAM6B,eAAe,CAAC,EACpBC,aAAa,EACbrB,MAAM;YAAEC,SAAS,CAAC;QAAE,CAAC,EACrBY,KAAK,EAKN,GACClB,kCAAkC;gBAAEQ,kBAAkB;YAAQ,GAAG;gBAC/DL,MAAM,CAAC;gBACPuB;gBACArB;gBACAa;YACF;QAEFpB,GAAG,yDAAyD;YAC1DD,OAAO,MAAM4B,aAAa;gBAAEC,eAAe;gBAAgBR,OAAO;YAAmB,IAAIG,IAAI,CAC3F;QAEJ;QAEAvB,GAAG,yCAAyC;YAC1CD,OACE,MAAM4B,aAAa;gBAAEC,eAAe;gBAAmBR,OAAO;YAAkB,IAChFG,IAAI,CAAC;QACT;IACF;AACF"}
|
package/dist/plugin.d.ts.map
CHANGED
|
@@ -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;
|
|
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;AAiB1D,eAAO,MAAM,kBAAkB,kBACb,aAAa,sBACZ,MAAM,KAAG,MA8LzB,CAAA"}
|
package/dist/plugin.js
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
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';
|
|
5
6
|
// This plugin extends all targeted collections by offloading uploaded files
|
|
6
7
|
// to cloud storage instead of solely storing files locally.
|
|
@@ -82,9 +83,6 @@ export const cloudStoragePlugin = (pluginOptions)=>(incomingConfig)=>{
|
|
|
82
83
|
});
|
|
83
84
|
}
|
|
84
85
|
const getSkipSafeFetchSetting = ()=>{
|
|
85
|
-
if (options.disablePayloadAccessControl) {
|
|
86
|
-
return true;
|
|
87
|
-
}
|
|
88
86
|
const isBooleanTrueSkipSafeFetch = typeof existingCollection.upload === 'object' && existingCollection.upload.skipSafeFetch === true;
|
|
89
87
|
const isAllowListSkipSafeFetch = typeof existingCollection.upload === 'object' && Array.isArray(existingCollection.upload.skipSafeFetch);
|
|
90
88
|
if (isBooleanTrueSkipSafeFetch) {
|
|
@@ -123,18 +121,26 @@ export const cloudStoragePlugin = (pluginOptions)=>(incomingConfig)=>{
|
|
|
123
121
|
...existingCollection.hooks?.afterChange || [],
|
|
124
122
|
getAfterChangeHook({
|
|
125
123
|
adapter,
|
|
126
|
-
collection: existingCollection
|
|
124
|
+
collection: existingCollection,
|
|
125
|
+
collectionPrefix: options.prefix,
|
|
126
|
+
useCompositePrefixes
|
|
127
127
|
})
|
|
128
128
|
],
|
|
129
129
|
afterDelete: [
|
|
130
130
|
...existingCollection.hooks?.afterDelete || [],
|
|
131
131
|
getAfterDeleteHook({
|
|
132
132
|
adapter,
|
|
133
|
-
collection: existingCollection
|
|
133
|
+
collection: existingCollection,
|
|
134
|
+
collectionPrefix: options.prefix,
|
|
135
|
+
useCompositePrefixes
|
|
134
136
|
})
|
|
135
137
|
],
|
|
136
138
|
beforeChange: [
|
|
137
139
|
...existingCollection.hooks?.beforeChange || [],
|
|
140
|
+
getNormalizeUploadPrefixHook({
|
|
141
|
+
collectionPrefix: options.prefix,
|
|
142
|
+
useCompositePrefixes
|
|
143
|
+
}),
|
|
138
144
|
getPreserveFileDataHook()
|
|
139
145
|
]
|
|
140
146
|
},
|
|
@@ -143,6 +149,7 @@ export const cloudStoragePlugin = (pluginOptions)=>(incomingConfig)=>{
|
|
|
143
149
|
adapter: adapter.name,
|
|
144
150
|
disableLocalStorage: typeof options.disableLocalStorage === 'boolean' ? options.disableLocalStorage : true,
|
|
145
151
|
handlers,
|
|
152
|
+
requiresClientUploadReceipt: adapter.requiresClientUploadReceipt,
|
|
146
153
|
skipSafeFetch: getSkipSafeFetchSetting()
|
|
147
154
|
}
|
|
148
155
|
};
|
|
@@ -150,7 +157,9 @@ export const cloudStoragePlugin = (pluginOptions)=>(incomingConfig)=>{
|
|
|
150
157
|
return existingCollection;
|
|
151
158
|
}),
|
|
152
159
|
onInit: async (payload)=>{
|
|
153
|
-
|
|
160
|
+
// Await each init so a provisioning failure fails Payload startup
|
|
161
|
+
// instead of becoming an unhandled rejection.
|
|
162
|
+
await Promise.all(initFunctions.map((fn)=>fn()));
|
|
154
163
|
if (config.onInit) {
|
|
155
164
|
await config.onInit(payload);
|
|
156
165
|
}
|
package/dist/plugin.js.map
CHANGED
|
@@ -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 { 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'\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<() => Promise<void> | 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 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 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 beforeChange: [\n ...(existingCollection.hooks?.beforeChange || []),\n getNormalizeUploadPrefixHook({\n collectionPrefix: options.prefix,\n useCompositePrefixes,\n }),\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 requiresClientUploadReceipt: adapter.requiresClientUploadReceipt,\n skipSafeFetch: getSkipSafeFetchSetting(),\n },\n }\n }\n\n return existingCollection\n }),\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","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","collectionPrefix","afterDelete","beforeChange","name","disableLocalStorage","requiresClientUploadReceipt","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;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,SAAStB,UAAU;gCACvBkB;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,gBAAmD,EAAE;QAE3D,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,SAAStB,UAAU;wBACvBkB;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,MAAMC,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/CtD,mBAAmB;oCACjBiB;oCACAC,YAAYJ;oCACZyC,kBAAkBxC,QAAQI,MAAM;oCAChCR;gCACF;6BACD;4BACD6C,aAAa;mCACP1C,mBAAmBuC,KAAK,EAAEG,eAAe,EAAE;gCAC/CvD,mBAAmB;oCACjBgB;oCACAC,YAAYJ;oCACZyC,kBAAkBxC,QAAQI,MAAM;oCAChCR;gCACF;6BACD;4BACD8C,cAAc;mCACR3C,mBAAmBuC,KAAK,EAAEI,gBAAgB,EAAE;gCAChDvD,6BAA6B;oCAC3BqD,kBAAkBxC,QAAQI,MAAM;oCAChCR;gCACF;gCACAR;6BACD;wBACH;wBACAyB,QAAQ;4BACN,GAAI,OAAOd,mBAAmBc,MAAM,KAAK,WAAWd,mBAAmBc,MAAM,GAAG,CAAC,CAAC;4BAClFX,SAASA,QAAQyC,IAAI;4BACrBC,qBACE,OAAO5C,QAAQ4C,mBAAmB,KAAK,YACnC5C,QAAQ4C,mBAAmB,GAC3B;4BACNhC;4BACAiC,6BAA6B3C,QAAQ2C,2BAA2B;4BAChEtB,eAAeF;wBACjB;oBACF;gBACF;gBAEA,OAAOtB;YACT;YACAW,QAAQ,OAAOoC;gBACb,kEAAkE;gBAClE,8CAA8C;gBAC9C,MAAMC,QAAQC,GAAG,CAACvC,cAAcX,GAAG,CAAC,CAACmD,KAAOA;gBAC5C,IAAIpD,OAAOa,MAAM,EAAE;oBACjB,MAAMb,OAAOa,MAAM,CAACoC;gBACtB;YACF;QACF;IACF,EAAC"}
|
|
@@ -0,0 +1,166 @@
|
|
|
1
|
+
import { createServer } from 'node:http';
|
|
2
|
+
import { getExternalFile } from 'payload/internal';
|
|
3
|
+
import { afterAll, afterEach, beforeAll, describe, expect, it, vi } from 'vitest';
|
|
4
|
+
import { cloudStoragePlugin } from './plugin.js';
|
|
5
|
+
const collectionSlug = 'media';
|
|
6
|
+
describe('cloudStoragePlugin external file fetching', ()=>{
|
|
7
|
+
const server = createServer((_req, res)=>{
|
|
8
|
+
res.writeHead(200, {
|
|
9
|
+
'Content-Length': '12',
|
|
10
|
+
'Content-Type': 'text/plain'
|
|
11
|
+
});
|
|
12
|
+
res.end('stored file\n');
|
|
13
|
+
});
|
|
14
|
+
let port;
|
|
15
|
+
beforeAll(async ()=>{
|
|
16
|
+
await new Promise((resolve)=>server.listen(0, resolve));
|
|
17
|
+
port = server.address().port;
|
|
18
|
+
});
|
|
19
|
+
afterEach(()=>{
|
|
20
|
+
vi.unstubAllEnvs();
|
|
21
|
+
});
|
|
22
|
+
afterAll(async ()=>{
|
|
23
|
+
await new Promise((resolve, reject)=>{
|
|
24
|
+
server.close((error)=>error ? reject(error) : resolve());
|
|
25
|
+
});
|
|
26
|
+
});
|
|
27
|
+
it('should filter private URLs when Payload file access control is disabled', async ()=>{
|
|
28
|
+
vi.stubEnv('NODE_ENV', 'production');
|
|
29
|
+
const uploadConfig = buildUploadConfig();
|
|
30
|
+
await expect(fetchExternalFile({
|
|
31
|
+
uploadConfig,
|
|
32
|
+
url: `http://127.0.0.1:${port}/file.txt`
|
|
33
|
+
})).rejects.toThrow('Blocked unsafe attempt to 127.0.0.1');
|
|
34
|
+
});
|
|
35
|
+
it('should allow private URLs when skipSafeFetch is explicitly true', async ()=>{
|
|
36
|
+
vi.stubEnv('NODE_ENV', 'production');
|
|
37
|
+
const uploadConfig = buildUploadConfig(true);
|
|
38
|
+
const file = await fetchExternalFile({
|
|
39
|
+
uploadConfig,
|
|
40
|
+
url: `http://127.0.0.1:${port}/file.txt`
|
|
41
|
+
});
|
|
42
|
+
expect(file.data.toString()).toBe('stored file\n');
|
|
43
|
+
});
|
|
44
|
+
it('should allow private URLs that match an explicit skipSafeFetch allowlist', async ()=>{
|
|
45
|
+
vi.stubEnv('NODE_ENV', 'production');
|
|
46
|
+
const uploadConfig = buildUploadConfig([
|
|
47
|
+
{
|
|
48
|
+
hostname: '127.0.0.1',
|
|
49
|
+
port: String(port),
|
|
50
|
+
protocol: 'http'
|
|
51
|
+
}
|
|
52
|
+
]);
|
|
53
|
+
const file = await fetchExternalFile({
|
|
54
|
+
uploadConfig,
|
|
55
|
+
url: `http://127.0.0.1:${port}/file.txt`
|
|
56
|
+
});
|
|
57
|
+
expect(file.data.toString()).toBe('stored file\n');
|
|
58
|
+
});
|
|
59
|
+
it('should allow localhost URLs outside production', async ()=>{
|
|
60
|
+
vi.stubEnv('NODE_ENV', 'development');
|
|
61
|
+
const uploadConfig = buildUploadConfig();
|
|
62
|
+
const file = await fetchExternalFile({
|
|
63
|
+
uploadConfig,
|
|
64
|
+
url: `http://localhost:${port}/file.txt`
|
|
65
|
+
});
|
|
66
|
+
expect(file.data.toString()).toBe('stored file\n');
|
|
67
|
+
});
|
|
68
|
+
});
|
|
69
|
+
function buildUploadConfig(skipSafeFetch) {
|
|
70
|
+
const config = cloudStoragePlugin({
|
|
71
|
+
collections: {
|
|
72
|
+
[collectionSlug]: {
|
|
73
|
+
adapter: ()=>({
|
|
74
|
+
handleDelete: async ()=>undefined,
|
|
75
|
+
handleUpload: async ()=>undefined,
|
|
76
|
+
name: 'test-adapter',
|
|
77
|
+
staticHandler: async ()=>new Response(null, {
|
|
78
|
+
status: 404
|
|
79
|
+
})
|
|
80
|
+
}),
|
|
81
|
+
disablePayloadAccessControl: true
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
})({
|
|
85
|
+
collections: [
|
|
86
|
+
{
|
|
87
|
+
fields: [],
|
|
88
|
+
slug: collectionSlug,
|
|
89
|
+
upload: typeof skipSafeFetch === 'undefined' ? true : {
|
|
90
|
+
skipSafeFetch
|
|
91
|
+
}
|
|
92
|
+
}
|
|
93
|
+
]
|
|
94
|
+
});
|
|
95
|
+
const uploadConfig = config.collections?.[0]?.upload;
|
|
96
|
+
if (!uploadConfig || typeof uploadConfig !== 'object') {
|
|
97
|
+
throw new Error('Expected an upload configuration');
|
|
98
|
+
}
|
|
99
|
+
return uploadConfig;
|
|
100
|
+
}
|
|
101
|
+
async function fetchExternalFile({ uploadConfig, url }) {
|
|
102
|
+
return getExternalFile({
|
|
103
|
+
data: {
|
|
104
|
+
filename: 'file.txt',
|
|
105
|
+
url
|
|
106
|
+
},
|
|
107
|
+
req: {
|
|
108
|
+
headers: new Headers(),
|
|
109
|
+
payload: {
|
|
110
|
+
config: {
|
|
111
|
+
cookiePrefix: 'payload'
|
|
112
|
+
}
|
|
113
|
+
}
|
|
114
|
+
},
|
|
115
|
+
uploadConfig
|
|
116
|
+
});
|
|
117
|
+
}
|
|
118
|
+
const adapter = ()=>({
|
|
119
|
+
handleDelete: ()=>undefined,
|
|
120
|
+
handleUpload: ()=>undefined,
|
|
121
|
+
name: 'test-adapter',
|
|
122
|
+
staticHandler: ()=>new Response()
|
|
123
|
+
});
|
|
124
|
+
describe('cloudStoragePlugin', ()=>{
|
|
125
|
+
it('should normalize a stored prefix during a server-mediated upload', async ()=>{
|
|
126
|
+
const config = cloudStoragePlugin({
|
|
127
|
+
collections: {
|
|
128
|
+
media: {
|
|
129
|
+
adapter
|
|
130
|
+
}
|
|
131
|
+
}
|
|
132
|
+
})({
|
|
133
|
+
collections: [
|
|
134
|
+
{
|
|
135
|
+
fields: [],
|
|
136
|
+
slug: 'media',
|
|
137
|
+
upload: true
|
|
138
|
+
}
|
|
139
|
+
]
|
|
140
|
+
});
|
|
141
|
+
const hooks = config.collections?.[0]?.hooks?.beforeChange || [];
|
|
142
|
+
const req = {
|
|
143
|
+
context: {},
|
|
144
|
+
file: {
|
|
145
|
+
mimetype: 'image/png',
|
|
146
|
+
name: 'photo.png',
|
|
147
|
+
size: 42
|
|
148
|
+
}
|
|
149
|
+
};
|
|
150
|
+
let data = {
|
|
151
|
+
filename: 'photo.png',
|
|
152
|
+
prefix: '/tenant/../acme'
|
|
153
|
+
};
|
|
154
|
+
for (const hook of hooks){
|
|
155
|
+
const result = await hook({
|
|
156
|
+
data,
|
|
157
|
+
operation: 'create',
|
|
158
|
+
req
|
|
159
|
+
});
|
|
160
|
+
data = result || data;
|
|
161
|
+
}
|
|
162
|
+
expect(data.prefix).toBe('tenant/acme');
|
|
163
|
+
});
|
|
164
|
+
});
|
|
165
|
+
|
|
166
|
+
//# sourceMappingURL=plugin.spec.js.map
|