@payloadcms/plugin-cloud-storage 4.0.0-canary.32 → 4.0.0-canary.34

package/dist/utilities/getFilePrefix.js

@@ -1,46 +1,86 @@
+import { buildPrefixWithObjectKey } from './buildPrefixWithObjectKey.js';
+import { buildUploadStoragePathData } from './buildStoragePathData.js';
 import { sanitizePrefix } from './sanitizePrefix.js';
 /**
- * Resolves the file prefix from the highest-priority available source and
- * always returns a sanitized value.
+ * Resolves the folder a stored object lives under (semantic `prefix` plus `_objectKey`).
  *
- * Resolution order:
- * 1. `prefixQueryParam`
- * 2. `uploadReference.prefix`
- * 3. Stored document `prefix` from the database
- *
- * Resolved values are passed through `sanitizePrefix`.
- */ export async function getFilePrefix({ collection, filename, prefixQueryParam, req, uploadReference }) {
-    if (typeof prefixQueryParam === 'string') {
-        return sanitizePrefix(prefixQueryParam);
+ * An already-authorized `doc` wins outright. Otherwise an `uploadReference` is used (its
+ * `prefix` re-contained with {@link buildUploadStoragePathData}, since it hasn't been verified against
+ * a signed receipt by every adapter). Otherwise the document is resolved with
+ * `overrideAccess: false`, any query-param prefix only narrows that lookup, and `_objectKey`
+ * is read from the resolved document via `showHiddenFields`.
+ */ export async function getFilePrefix({ collection, collectionPrefix, doc, filename, prefixQueryParam, req, uploadReference, useCompositePrefixes = false }) {
+    // The serve path already loaded and authorized this document — trust it over any
+    // client-supplied upload reference or query prefix.
+    if (doc) {
+        return buildPrefixWithObjectKey({
+            objectKey: doc._objectKey,
+            prefix: doc.prefix
+        });
     }
-    // Prioritize the upload reference prefix if there is one.
+    // Upload instructions call handlers without a document yet. Re-contain the claimed
+    // prefix — it hasn't been verified against a signed receipt by every adapter.
     if (uploadReference && typeof uploadReference === 'object' && 'prefix' in uploadReference && typeof uploadReference.prefix === 'string') {
-        return sanitizePrefix(uploadReference.prefix);
+        const referenceObjectKey = '_objectKey' in uploadReference ? uploadReference._objectKey : undefined;
+        const containedPrefix = buildUploadStoragePathData({
+            collectionPrefix,
+            docPrefix: uploadReference.prefix,
+            filename,
+            useCompositePrefixes
+        }).sanitizedDocPrefix;
+        return buildPrefixWithObjectKey({
+            objectKey: referenceObjectKey,
+            prefix: containedPrefix
+        });
     }
+    // Reads without a query prefix or read-access constraints skip the endpoint's document lookup.
     const imageSizes = collection?.upload?.imageSizes || [];
+    const filenameClause = {
+        or: [
+            {
+                filename: {
+                    equals: filename
+                }
+            },
+            ...imageSizes.map((imageSize)=>({
+                    [`sizes.${imageSize.name}.filename`]: {
+                        equals: filename
+                    }
+                }))
+        ]
+    };
+    // Only filter by prefix when the collection persists a `prefix` field (querying a missing field throws).
+    const hasPrefixField = collection.fields?.some((field)=>'name' in field && field.name === 'prefix');
+    const where = typeof prefixQueryParam === 'string' && hasPrefixField ? {
+        and: [
+            filenameClause,
+            {
+                prefix: {
+                    equals: sanitizePrefix(prefixQueryParam)
+                }
+            }
+        ]
+    } : filenameClause;
     const files = await req.payload.find({
         collection: collection.slug,
         depth: 0,
         draft: true,
         limit: 1,
+        overrideAccess: false,
         pagination: false,
-        where: {
-            or: [
-                {
-                    filename: {
-                        equals: filename
-                    }
-                },
-                ...imageSizes.map((imageSize)=>({
-                        [`sizes.${imageSize.name}.filename`]: {
-                            equals: filename
-                        }
-                    }))
-            ]
-        }
+        req,
+        select: {
+            _objectKey: true,
+            prefix: true
+        },
+        showHiddenFields: true,
+        where
+    });
+    const found = files?.docs?.[0];
+    return buildPrefixWithObjectKey({
+        objectKey: found?._objectKey,
+        prefix: found?.prefix
     });
-    const prefix = files?.docs?.[0]?.prefix;
-    return prefix ? sanitizePrefix(prefix) : '';
 }
 
 //# sourceMappingURL=getFilePrefix.js.map

package/dist/utilities/getFilePrefix.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/utilities/getFilePrefix.ts"],"sourcesContent":["import type { CollectionConfig, PayloadRequest, UploadConfig } from 'payload'\n\nimport { sanitizePrefix } from './sanitizePrefix.js'\n\n/**\n * Resolves the file prefix from the highest-priority available source and\n * always returns a sanitized value.\n *\n * Resolution order:\n * 1. `prefixQueryParam`\n * 2. `uploadReference.prefix`\n * 3. Stored document `prefix` from the database\n *\n * Resolved values are passed through `sanitizePrefix`.\n */\nexport async function getFilePrefix({\n  collection,\n  filename,\n  prefixQueryParam,\n  req,\n  uploadReference,\n}: {\n  collection: CollectionConfig\n  filename: string\n  prefixQueryParam?: string\n  req: PayloadRequest\n  uploadReference?: unknown\n}): Promise<string> {\n  if (typeof prefixQueryParam === 'string') {\n    return sanitizePrefix(prefixQueryParam)\n  }\n\n  // Prioritize the upload reference prefix if there is one.\n  if (\n    uploadReference &&\n    typeof uploadReference === 'object' &&\n    'prefix' in uploadReference &&\n    typeof uploadReference.prefix === 'string'\n  ) {\n    return sanitizePrefix(uploadReference.prefix)\n  }\n\n  const imageSizes = (collection?.upload as UploadConfig)?.imageSizes || []\n\n  const files = await req.payload.find({\n    collection: collection.slug,\n    depth: 0,\n    draft: true,\n    limit: 1,\n    pagination: false,\n    where: {\n      or: [\n        {\n          filename: { equals: filename },\n        },\n        ...imageSizes.map((imageSize) => ({\n          [`sizes.${imageSize.name}.filename`]: { equals: filename },\n        })),\n      ],\n    },\n  })\n  const prefix = files?.docs?.[0]?.prefix\n  return prefix ? sanitizePrefix(prefix as string) : ''\n}\n"],"names":["sanitizePrefix","getFilePrefix","collection","filename","prefixQueryParam","req","uploadReference","prefix","imageSizes","upload","files","payload","find","slug","depth","draft","limit","pagination","where","or","equals","map","imageSize","name","docs"],"mappings":"AAEA,SAASA,cAAc,QAAQ,sBAAqB;AAEpD;;;;;;;;;;CAUC,GACD,OAAO,eAAeC,cAAc,EAClCC,UAAU,EACVC,QAAQ,EACRC,gBAAgB,EAChBC,GAAG,EACHC,eAAe,EAOhB;IACC,IAAI,OAAOF,qBAAqB,UAAU;QACxC,OAAOJ,eAAeI;IACxB;IAEA,0DAA0D;IAC1D,IACEE,mBACA,OAAOA,oBAAoB,YAC3B,YAAYA,mBACZ,OAAOA,gBAAgBC,MAAM,KAAK,UAClC;QACA,OAAOP,eAAeM,gBAAgBC,MAAM;IAC9C;IAEA,MAAMC,aAAa,AAACN,YAAYO,QAAyBD,cAAc,EAAE;IAEzE,MAAME,QAAQ,MAAML,IAAIM,OAAO,CAACC,IAAI,CAAC;QACnCV,YAAYA,WAAWW,IAAI;QAC3BC,OAAO;QACPC,OAAO;QACPC,OAAO;QACPC,YAAY;QACZC,OAAO;YACLC,IAAI;gBACF;oBACEhB,UAAU;wBAAEiB,QAAQjB;oBAAS;gBAC/B;mBACGK,WAAWa,GAAG,CAAC,CAACC,YAAe,CAAA;wBAChC,CAAC,CAAC,MAAM,EAAEA,UAAUC,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE;4BAAEH,QAAQjB;wBAAS;oBAC3D,CAAA;aACD;QACH;IACF;IACA,MAAMI,SAASG,OAAOc,MAAM,CAAC,EAAE,EAAEjB;IACjC,OAAOA,SAASP,eAAeO,UAAoB;AACrD"}
+{"version":3,"sources":["../../src/utilities/getFilePrefix.ts"],"sourcesContent":["import type { CollectionConfig, PayloadRequest, TypeWithID, UploadConfig } from 'payload'\n\nimport { buildPrefixWithObjectKey } from './buildPrefixWithObjectKey.js'\nimport { buildUploadStoragePathData } from './buildStoragePathData.js'\nimport { sanitizePrefix } from './sanitizePrefix.js'\n\n/**\n * Resolves the folder a stored object lives under (semantic `prefix` plus `_objectKey`).\n *\n * An already-authorized `doc` wins outright. Otherwise an `uploadReference` is used (its\n * `prefix` re-contained with {@link buildUploadStoragePathData}, since it hasn't been verified against\n * a signed receipt by every adapter). Otherwise the document is resolved with\n * `overrideAccess: false`, any query-param prefix only narrows that lookup, and `_objectKey`\n * is read from the resolved document via `showHiddenFields`.\n */\nexport async function getFilePrefix({\n  collection,\n  collectionPrefix,\n  doc,\n  filename,\n  prefixQueryParam,\n  req,\n  uploadReference,\n  useCompositePrefixes = false,\n}: {\n  collection: CollectionConfig\n  collectionPrefix?: string\n  doc?: { _objectKey?: string; prefix?: string } & TypeWithID\n  filename: string\n  /**\n   * Only narrows the access-controlled fallback lookup below; never trusted or\n   * returned directly. Prefer passing the access-checked document as `doc` instead.\n   */\n  prefixQueryParam?: string\n  req: PayloadRequest\n  uploadReference?: unknown\n  useCompositePrefixes?: boolean\n}): Promise<string> {\n  // The serve path already loaded and authorized this document — trust it over any\n  // client-supplied upload reference or query prefix.\n  if (doc) {\n    return buildPrefixWithObjectKey({ objectKey: doc._objectKey, prefix: doc.prefix })\n  }\n\n  // Upload instructions call handlers without a document yet. Re-contain the claimed\n  // prefix — it hasn't been verified against a signed receipt by every adapter.\n  if (\n    uploadReference &&\n    typeof uploadReference === 'object' &&\n    'prefix' in uploadReference &&\n    typeof uploadReference.prefix === 'string'\n  ) {\n    const referenceObjectKey =\n      '_objectKey' in uploadReference\n        ? (uploadReference as { _objectKey?: string })._objectKey\n        : undefined\n    const containedPrefix = buildUploadStoragePathData({\n      collectionPrefix,\n      docPrefix: uploadReference.prefix,\n      filename,\n      useCompositePrefixes,\n    }).sanitizedDocPrefix\n    return buildPrefixWithObjectKey({ objectKey: referenceObjectKey, prefix: containedPrefix })\n  }\n\n  // Reads without a query prefix or read-access constraints skip the endpoint's document lookup.\n  const imageSizes = (collection?.upload as UploadConfig)?.imageSizes || []\n\n  const filenameClause = {\n    or: [\n      {\n        filename: { equals: filename },\n      },\n      ...imageSizes.map((imageSize) => ({\n        [`sizes.${imageSize.name}.filename`]: { equals: filename },\n      })),\n    ],\n  }\n\n  // Only filter by prefix when the collection persists a `prefix` field (querying a missing field throws).\n  const hasPrefixField = collection.fields?.some(\n    (field) => 'name' in field && field.name === 'prefix',\n  )\n  const where =\n    typeof prefixQueryParam === 'string' && hasPrefixField\n      ? { and: [filenameClause, { prefix: { equals: sanitizePrefix(prefixQueryParam) } }] }\n      : filenameClause\n\n  const files = await req.payload.find({\n    collection: collection.slug,\n    depth: 0,\n    draft: true,\n    limit: 1,\n    overrideAccess: false,\n    pagination: false,\n    req,\n    select: {\n      _objectKey: true,\n      prefix: true,\n    },\n    showHiddenFields: true,\n    where,\n  })\n\n  const found = files?.docs?.[0] as { _objectKey?: string; prefix?: string } | undefined\n  return buildPrefixWithObjectKey({ objectKey: found?._objectKey, prefix: found?.prefix })\n}\n"],"names":["buildPrefixWithObjectKey","buildUploadStoragePathData","sanitizePrefix","getFilePrefix","collection","collectionPrefix","doc","filename","prefixQueryParam","req","uploadReference","useCompositePrefixes","objectKey","_objectKey","prefix","referenceObjectKey","undefined","containedPrefix","docPrefix","sanitizedDocPrefix","imageSizes","upload","filenameClause","or","equals","map","imageSize","name","hasPrefixField","fields","some","field","where","and","files","payload","find","slug","depth","draft","limit","overrideAccess","pagination","select","showHiddenFields","found","docs"],"mappings":"AAEA,SAASA,wBAAwB,QAAQ,gCAA+B;AACxE,SAASC,0BAA0B,QAAQ,4BAA2B;AACtE,SAASC,cAAc,QAAQ,sBAAqB;AAEpD;;;;;;;;CAQC,GACD,OAAO,eAAeC,cAAc,EAClCC,UAAU,EACVC,gBAAgB,EAChBC,GAAG,EACHC,QAAQ,EACRC,gBAAgB,EAChBC,GAAG,EACHC,eAAe,EACfC,uBAAuB,KAAK,EAc7B;IACC,iFAAiF;IACjF,oDAAoD;IACpD,IAAIL,KAAK;QACP,OAAON,yBAAyB;YAAEY,WAAWN,IAAIO,UAAU;YAAEC,QAAQR,IAAIQ,MAAM;QAAC;IAClF;IAEA,mFAAmF;IACnF,8EAA8E;IAC9E,IACEJ,mBACA,OAAOA,oBAAoB,YAC3B,YAAYA,mBACZ,OAAOA,gBAAgBI,MAAM,KAAK,UAClC;QACA,MAAMC,qBACJ,gBAAgBL,kBACZ,AAACA,gBAA4CG,UAAU,GACvDG;QACN,MAAMC,kBAAkBhB,2BAA2B;YACjDI;YACAa,WAAWR,gBAAgBI,MAAM;YACjCP;YACAI;QACF,GAAGQ,kBAAkB;QACrB,OAAOnB,yBAAyB;YAAEY,WAAWG;YAAoBD,QAAQG;QAAgB;IAC3F;IAEA,+FAA+F;IAC/F,MAAMG,aAAa,AAAChB,YAAYiB,QAAyBD,cAAc,EAAE;IAEzE,MAAME,iBAAiB;QACrBC,IAAI;YACF;gBACEhB,UAAU;oBAAEiB,QAAQjB;gBAAS;YAC/B;eACGa,WAAWK,GAAG,CAAC,CAACC,YAAe,CAAA;oBAChC,CAAC,CAAC,MAAM,EAAEA,UAAUC,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE;wBAAEH,QAAQjB;oBAAS;gBAC3D,CAAA;SACD;IACH;IAEA,yGAAyG;IACzG,MAAMqB,iBAAiBxB,WAAWyB,MAAM,EAAEC,KACxC,CAACC,QAAU,UAAUA,SAASA,MAAMJ,IAAI,KAAK;IAE/C,MAAMK,QACJ,OAAOxB,qBAAqB,YAAYoB,iBACpC;QAAEK,KAAK;YAACX;YAAgB;gBAAER,QAAQ;oBAAEU,QAAQtB,eAAeM;gBAAkB;YAAE;SAAE;IAAC,IAClFc;IAEN,MAAMY,QAAQ,MAAMzB,IAAI0B,OAAO,CAACC,IAAI,CAAC;QACnChC,YAAYA,WAAWiC,IAAI;QAC3BC,OAAO;QACPC,OAAO;QACPC,OAAO;QACPC,gBAAgB;QAChBC,YAAY;QACZjC;QACAkC,QAAQ;YACN9B,YAAY;YACZC,QAAQ;QACV;QACA8B,kBAAkB;QAClBZ;IACF;IAEA,MAAMa,QAAQX,OAAOY,MAAM,CAAC,EAAE;IAC9B,OAAO9C,yBAAyB;QAAEY,WAAWiC,OAAOhC;QAAYC,QAAQ+B,OAAO/B;IAAO;AACxF"}

package/dist/utilities/getFilePrefix.spec.js

@@ -7,61 +7,188 @@ const makeReq = (docs = [])=>({
             })
         }
     });
-const makeCollection = ()=>({
+const makeCollection = ({ hasPrefixField = false } = {})=>({
         slug: 'media',
+        fields: hasPrefixField ? [
+            {
+                name: 'prefix',
+                type: 'text'
+            }
+        ] : [],
         upload: {}
     });
+const whereOf = (req)=>JSON.stringify(req.payload.find.mock.calls[0][0].where);
 describe('getFilePrefix', ()=>{
-    describe('prefixQueryParam shortcut', ()=>{
-        it('should return prefixQueryParam immediately without querying the database', async ()=>{
+    it('prefers an already-authorized document over an upload reference or query prefix', async ()=>{
+        const req = makeReq([
+            {
+                prefix: 'db-prefix'
+            }
+        ]);
+        const doc = {
+            id: '1',
+            prefix: 'invoices'
+        };
+        const result = await getFilePrefix({
+            collection: makeCollection(),
+            collectionPrefix: 'media',
+            doc,
+            filename: 'logo.png',
+            prefixQueryParam: 'query-prefix',
+            req,
+            uploadReference: {
+                prefix: 'reference-prefix'
+            }
+        });
+        expect(result).toBe('invoices');
+        expect(req.payload.find).not.toHaveBeenCalled();
+    });
+    it('does not fall back to a lookup when the checked document has no prefix', async ()=>{
+        const req = makeReq([
+            {
+                prefix: 'db-prefix'
+            }
+        ]);
+        const result = await getFilePrefix({
+            collection: makeCollection(),
+            collectionPrefix: 'media',
+            doc: {
+                id: '1'
+            },
+            filename: 'logo.png',
+            req
+        });
+        expect(result).toBe('');
+        expect(req.payload.find).not.toHaveBeenCalled();
+    });
+    it('contains an upload reference prefix beneath the collection prefix', async ()=>{
+        const req = makeReq();
+        const result = await getFilePrefix({
+            collection: makeCollection(),
+            collectionPrefix: 'media',
+            filename: 'file.png',
+            req,
+            uploadReference: {
+                prefix: 'invoices'
+            }
+        });
+        expect(result).toBe('media/invoices');
+        expect(req.payload.find).not.toHaveBeenCalled();
+    });
+    describe('verified upload reference (trusted)', ()=>{
+        it('folds the object key into the prefix and skips the database', async ()=>{
             const req = makeReq();
             const result = await getFilePrefix({
                 collection: makeCollection(),
-                prefixQueryParam: 'uuid-prefix',
                 filename: 'logo.png',
-                req
+                req,
+                uploadReference: {
+                    _objectKey: 'abc123',
+                    prefix: 'documents'
+                }
             });
-            expect(result).toBe('uuid-prefix');
+            expect(result).toBe('documents/abc123');
             expect(req.payload.find).not.toHaveBeenCalled();
         });
-        it('should return an empty string when prefixQueryParam is an empty string', async ()=>{
+        it('returns the prefix alone when the reference has no object key', async ()=>{
             const req = makeReq();
             const result = await getFilePrefix({
                 collection: makeCollection(),
-                prefixQueryParam: '',
+                filename: 'logo.png',
+                req,
+                uploadReference: {
+                    prefix: 'documents'
+                }
+            });
+            expect(result).toBe('documents');
+        });
+    });
+    describe('authorized document (trusted)', ()=>{
+        it('folds the object key into the document prefix and skips the database', async ()=>{
+            const req = makeReq([
+                {
+                    prefix: 'db-prefix'
+                }
+            ]);
+            const result = await getFilePrefix({
+                collection: makeCollection(),
+                doc: {
+                    id: '1',
+                    _objectKey: 'abc123',
+                    prefix: 'doc-prefix'
+                },
                 filename: 'logo.png',
                 req
             });
-            expect(result).toBe('');
+            expect(result).toBe('doc-prefix/abc123');
             expect(req.payload.find).not.toHaveBeenCalled();
         });
-        it('should reject multi-encoded values', async ()=>{
+        it('returns the document prefix alone when it has no object key', async ()=>{
             const req = makeReq();
             const result = await getFilePrefix({
                 collection: makeCollection(),
-                prefixQueryParam: '%252e%252e%252fsecret%252f..%252fok',
+                doc: {
+                    id: '1',
+                    prefix: 'doc-prefix'
+                },
                 filename: 'logo.png',
                 req
             });
-            expect(result).toBe('');
-            expect(req.payload.find).not.toHaveBeenCalled();
+            expect(result).toBe('doc-prefix');
         });
-        it('should reject malformed percent-encoding', async ()=>{
+        it('sanitizes the document prefix', async ()=>{
             const req = makeReq();
             const result = await getFilePrefix({
                 collection: makeCollection(),
-                prefixQueryParam: '%E0%A4%A',
+                doc: {
+                    id: '1',
+                    prefix: '../secret'
+                },
                 filename: 'logo.png',
                 req
             });
-            expect(result).toBe('');
-            expect(req.payload.find).not.toHaveBeenCalled();
+            expect(result).toBe('secret');
         });
     });
-    describe('database fallback', ()=>{
-        it('should query the database when prefixQueryParam is not provided', async ()=>{
+    describe('access-controlled database resolution', ()=>{
+        it('does NOT short-circuit on a client-supplied prefix — the access-controlled query still runs', async ()=>{
             const req = makeReq([
                 {
+                    _objectKey: 'abc123',
+                    prefix: 'documents'
+                }
+            ]);
+            await getFilePrefix({
+                collection: makeCollection({
+                    hasPrefixField: true
+                }),
+                filename: 'logo.png',
+                prefixQueryParam: 'documents',
+                req
+            });
+            expect(req.payload.find).toHaveBeenCalledOnce();
+        });
+        it('queries with access control enabled and hidden fields', async ()=>{
+            const req = makeReq([
+                {
+                    prefix: 'db-prefix'
+                }
+            ]);
+            await getFilePrefix({
+                collection: makeCollection(),
+                filename: 'logo.png',
+                req
+            });
+            expect(req.payload.find).toHaveBeenCalledWith(expect.objectContaining({
+                overrideAccess: false,
+                req,
+                showHiddenFields: true
+            }));
+        });
+        it('folds the stored object key into the resolved prefix', async ()=>{
+            const req = makeReq([
+                {
+                    _objectKey: 'abc123',
                     prefix: 'db-prefix'
                 }
             ]);
@@ -70,10 +197,9 @@ describe('getFilePrefix', ()=>{
                 filename: 'logo.png',
                 req
             });
-            expect(result).toBe('db-prefix');
-            expect(req.payload.find).toHaveBeenCalledOnce();
+            expect(result).toBe('db-prefix/abc123');
         });
-        it('should return empty string when no document is found', async ()=>{
+        it('returns an empty string when no document is found', async ()=>{
             const req = makeReq([]);
             const result = await getFilePrefix({
                 collection: makeCollection(),
@@ -82,22 +208,39 @@ describe('getFilePrefix', ()=>{
             });
             expect(result).toBe('');
         });
-        it('should prioritize the upload reference prefix over the database query', async ()=>{
+    });
+    describe('client prefix as a disambiguation filter only', ()=>{
+        it('adds the prefix filter when the collection persists a prefix field', async ()=>{
             const req = makeReq([
                 {
-                    prefix: 'db-prefix'
+                    prefix: 'documents'
                 }
             ]);
-            const result = await getFilePrefix({
-                collection: makeCollection(),
-                uploadReference: {
-                    prefix: 'context-prefix'
-                },
+            await getFilePrefix({
+                collection: makeCollection({
+                    hasPrefixField: true
+                }),
                 filename: 'logo.png',
+                prefixQueryParam: 'documents',
                 req
             });
-            expect(result).toBe('context-prefix');
-            expect(req.payload.find).not.toHaveBeenCalled();
+            expect(whereOf(req)).toContain('prefix');
+        });
+        it('omits the prefix filter when the collection has no prefix field', async ()=>{
+            const req = makeReq([
+                {
+                    prefix: ''
+                }
+            ]);
+            await getFilePrefix({
+                collection: makeCollection({
+                    hasPrefixField: false
+                }),
+                filename: 'logo.png',
+                prefixQueryParam: 'anything',
+                req
+            });
+            expect(whereOf(req)).not.toContain('prefix');
         });
     });
 });

package/dist/utilities/getFilePrefix.spec.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/utilities/getFilePrefix.spec.ts"],"sourcesContent":["import { describe, expect, it, vi } from 'vitest'\n\nimport type { CollectionConfig, PayloadRequest } from 'payload'\n\nimport { getFilePrefix } from './getFilePrefix.js'\n\nconst makeReq = (docs: unknown[] = []) =>\n  ({\n    payload: {\n      find: vi.fn().mockResolvedValue({ docs }),\n    },\n  }) as unknown as PayloadRequest\n\nconst makeCollection = (): CollectionConfig =>\n  ({ slug: 'media', upload: {} }) as unknown as CollectionConfig\n\ndescribe('getFilePrefix', () => {\n  describe('prefixQueryParam shortcut', () => {\n    it('should return prefixQueryParam immediately without querying the database', async () => {\n      const req = makeReq()\n\n      const result = await getFilePrefix({\n        collection: makeCollection(),\n        prefixQueryParam: 'uuid-prefix',\n        filename: 'logo.png',\n        req,\n      })\n\n      expect(result).toBe('uuid-prefix')\n      expect(req.payload.find).not.toHaveBeenCalled()\n    })\n\n    it('should return an empty string when prefixQueryParam is an empty string', async () => {\n      const req = makeReq()\n\n      const result = await getFilePrefix({\n        collection: makeCollection(),\n        prefixQueryParam: '',\n        filename: 'logo.png',\n        req,\n      })\n\n      expect(result).toBe('')\n      expect(req.payload.find).not.toHaveBeenCalled()\n    })\n\n    it('should reject multi-encoded values', async () => {\n      const req = makeReq()\n\n      const result = await getFilePrefix({\n        collection: makeCollection(),\n        prefixQueryParam: '%252e%252e%252fsecret%252f..%252fok',\n        filename: 'logo.png',\n        req,\n      })\n\n      expect(result).toBe('')\n      expect(req.payload.find).not.toHaveBeenCalled()\n    })\n\n    it('should reject malformed percent-encoding', async () => {\n      const req = makeReq()\n\n      const result = await getFilePrefix({\n        collection: makeCollection(),\n        prefixQueryParam: '%E0%A4%A',\n        filename: 'logo.png',\n        req,\n      })\n\n      expect(result).toBe('')\n      expect(req.payload.find).not.toHaveBeenCalled()\n    })\n  })\n\n  describe('database fallback', () => {\n    it('should query the database when prefixQueryParam is not provided', async () => {\n      const req = makeReq([{ prefix: 'db-prefix' }])\n\n      const result = await getFilePrefix({\n        collection: makeCollection(),\n        filename: 'logo.png',\n        req,\n      })\n\n      expect(result).toBe('db-prefix')\n      expect(req.payload.find).toHaveBeenCalledOnce()\n    })\n\n    it('should return empty string when no document is found', async () => {\n      const req = makeReq([])\n\n      const result = await getFilePrefix({\n        collection: makeCollection(),\n        filename: 'logo.png',\n        req,\n      })\n\n      expect(result).toBe('')\n    })\n\n    it('should prioritize the upload reference prefix over the database query', async () => {\n      const req = makeReq([{ prefix: 'db-prefix' }])\n\n      const result = await getFilePrefix({\n        collection: makeCollection(),\n        uploadReference: { prefix: 'context-prefix' },\n        filename: 'logo.png',\n        req,\n      })\n\n      expect(result).toBe('context-prefix')\n      expect(req.payload.find).not.toHaveBeenCalled()\n    })\n  })\n})\n"],"names":["describe","expect","it","vi","getFilePrefix","makeReq","docs","payload","find","fn","mockResolvedValue","makeCollection","slug","upload","req","result","collection","prefixQueryParam","filename","toBe","not","toHaveBeenCalled","prefix","toHaveBeenCalledOnce","uploadReference"],"mappings":"AAAA,SAASA,QAAQ,EAAEC,MAAM,EAAEC,EAAE,EAAEC,EAAE,QAAQ,SAAQ;AAIjD,SAASC,aAAa,QAAQ,qBAAoB;AAElD,MAAMC,UAAU,CAACC,OAAkB,EAAE,GAClC,CAAA;QACCC,SAAS;YACPC,MAAML,GAAGM,EAAE,GAAGC,iBAAiB,CAAC;gBAAEJ;YAAK;QACzC;IACF,CAAA;AAEF,MAAMK,iBAAiB,IACpB,CAAA;QAAEC,MAAM;QAASC,QAAQ,CAAC;IAAE,CAAA;AAE/Bb,SAAS,iBAAiB;IACxBA,SAAS,6BAA6B;QACpCE,GAAG,4EAA4E;YAC7E,MAAMY,MAAMT;YAEZ,MAAMU,SAAS,MAAMX,cAAc;gBACjCY,YAAYL;gBACZM,kBAAkB;gBAClBC,UAAU;gBACVJ;YACF;YAEAb,OAAOc,QAAQI,IAAI,CAAC;YACpBlB,OAAOa,IAAIP,OAAO,CAACC,IAAI,EAAEY,GAAG,CAACC,gBAAgB;QAC/C;QAEAnB,GAAG,0EAA0E;YAC3E,MAAMY,MAAMT;YAEZ,MAAMU,SAAS,MAAMX,cAAc;gBACjCY,YAAYL;gBACZM,kBAAkB;gBAClBC,UAAU;gBACVJ;YACF;YAEAb,OAAOc,QAAQI,IAAI,CAAC;YACpBlB,OAAOa,IAAIP,OAAO,CAACC,IAAI,EAAEY,GAAG,CAACC,gBAAgB;QAC/C;QAEAnB,GAAG,sCAAsC;YACvC,MAAMY,MAAMT;YAEZ,MAAMU,SAAS,MAAMX,cAAc;gBACjCY,YAAYL;gBACZM,kBAAkB;gBAClBC,UAAU;gBACVJ;YACF;YAEAb,OAAOc,QAAQI,IAAI,CAAC;YACpBlB,OAAOa,IAAIP,OAAO,CAACC,IAAI,EAAEY,GAAG,CAACC,gBAAgB;QAC/C;QAEAnB,GAAG,4CAA4C;YAC7C,MAAMY,MAAMT;YAEZ,MAAMU,SAAS,MAAMX,cAAc;gBACjCY,YAAYL;gBACZM,kBAAkB;gBAClBC,UAAU;gBACVJ;YACF;YAEAb,OAAOc,QAAQI,IAAI,CAAC;YACpBlB,OAAOa,IAAIP,OAAO,CAACC,IAAI,EAAEY,GAAG,CAACC,gBAAgB;QAC/C;IACF;IAEArB,SAAS,qBAAqB;QAC5BE,GAAG,mEAAmE;YACpE,MAAMY,MAAMT,QAAQ;gBAAC;oBAAEiB,QAAQ;gBAAY;aAAE;YAE7C,MAAMP,SAAS,MAAMX,cAAc;gBACjCY,YAAYL;gBACZO,UAAU;gBACVJ;YACF;YAEAb,OAAOc,QAAQI,IAAI,CAAC;YACpBlB,OAAOa,IAAIP,OAAO,CAACC,IAAI,EAAEe,oBAAoB;QAC/C;QAEArB,GAAG,wDAAwD;YACzD,MAAMY,MAAMT,QAAQ,EAAE;YAEtB,MAAMU,SAAS,MAAMX,cAAc;gBACjCY,YAAYL;gBACZO,UAAU;gBACVJ;YACF;YAEAb,OAAOc,QAAQI,IAAI,CAAC;QACtB;QAEAjB,GAAG,yEAAyE;YAC1E,MAAMY,MAAMT,QAAQ;gBAAC;oBAAEiB,QAAQ;gBAAY;aAAE;YAE7C,MAAMP,SAAS,MAAMX,cAAc;gBACjCY,YAAYL;gBACZa,iBAAiB;oBAAEF,QAAQ;gBAAiB;gBAC5CJ,UAAU;gBACVJ;YACF;YAEAb,OAAOc,QAAQI,IAAI,CAAC;YACpBlB,OAAOa,IAAIP,OAAO,CAACC,IAAI,EAAEY,GAAG,CAACC,gBAAgB;QAC/C;IACF;AACF"}
+{"version":3,"sources":["../../src/utilities/getFilePrefix.spec.ts"],"sourcesContent":["import type { CollectionConfig, PayloadRequest } from 'payload'\n\nimport { describe, expect, it, vi } from 'vitest'\n\nimport { getFilePrefix } from './getFilePrefix.js'\n\nconst makeReq = (docs: unknown[] = []) =>\n  ({\n    payload: {\n      find: vi.fn().mockResolvedValue({ docs }),\n    },\n  }) as unknown as PayloadRequest\n\nconst makeCollection = ({\n  hasPrefixField = false,\n}: { hasPrefixField?: boolean } = {}): CollectionConfig =>\n  ({\n    slug: 'media',\n    fields: hasPrefixField ? [{ name: 'prefix', type: 'text' }] : [],\n    upload: {},\n  }) as unknown as CollectionConfig\n\nconst whereOf = (req: PayloadRequest) =>\n  JSON.stringify(\n    (req.payload.find as unknown as { mock: { calls: [{ where: unknown }][] } }).mock.calls[0][0]\n      .where,\n  )\n\ndescribe('getFilePrefix', () => {\n  it('prefers an already-authorized document over an upload reference or query prefix', async () => {\n    const req = makeReq([{ prefix: 'db-prefix' }])\n    const doc = { id: '1', prefix: 'invoices' }\n\n    const result = await getFilePrefix({\n      collection: makeCollection(),\n      collectionPrefix: 'media',\n      doc,\n      filename: 'logo.png',\n      prefixQueryParam: 'query-prefix',\n      req,\n      uploadReference: { prefix: 'reference-prefix' },\n    })\n\n    expect(result).toBe('invoices')\n    expect(req.payload.find).not.toHaveBeenCalled()\n  })\n\n  it('does not fall back to a lookup when the checked document has no prefix', async () => {\n    const req = makeReq([{ prefix: 'db-prefix' }])\n\n    const result = await getFilePrefix({\n      collection: makeCollection(),\n      collectionPrefix: 'media',\n      doc: { id: '1' },\n      filename: 'logo.png',\n      req,\n    })\n\n    expect(result).toBe('')\n    expect(req.payload.find).not.toHaveBeenCalled()\n  })\n\n  it('contains an upload reference prefix beneath the collection prefix', async () => {\n    const req = makeReq()\n\n    const result = await getFilePrefix({\n      collection: makeCollection(),\n      collectionPrefix: 'media',\n      filename: 'file.png',\n      req,\n      uploadReference: { prefix: 'invoices' },\n    })\n\n    expect(result).toBe('media/invoices')\n    expect(req.payload.find).not.toHaveBeenCalled()\n  })\n\n  describe('verified upload reference (trusted)', () => {\n    it('folds the object key into the prefix and skips the database', async () => {\n      const req = makeReq()\n\n      const result = await getFilePrefix({\n        collection: makeCollection(),\n        filename: 'logo.png',\n        req,\n        uploadReference: { _objectKey: 'abc123', prefix: 'documents' },\n      })\n\n      expect(result).toBe('documents/abc123')\n      expect(req.payload.find).not.toHaveBeenCalled()\n    })\n\n    it('returns the prefix alone when the reference has no object key', async () => {\n      const req = makeReq()\n\n      const result = await getFilePrefix({\n        collection: makeCollection(),\n        filename: 'logo.png',\n        req,\n        uploadReference: { prefix: 'documents' },\n      })\n\n      expect(result).toBe('documents')\n    })\n  })\n\n  describe('authorized document (trusted)', () => {\n    it('folds the object key into the document prefix and skips the database', async () => {\n      const req = makeReq([{ prefix: 'db-prefix' }])\n\n      const result = await getFilePrefix({\n        collection: makeCollection(),\n        doc: { id: '1', _objectKey: 'abc123', prefix: 'doc-prefix' },\n        filename: 'logo.png',\n        req,\n      })\n\n      expect(result).toBe('doc-prefix/abc123')\n      expect(req.payload.find).not.toHaveBeenCalled()\n    })\n\n    it('returns the document prefix alone when it has no object key', async () => {\n      const req = makeReq()\n\n      const result = await getFilePrefix({\n        collection: makeCollection(),\n        doc: { id: '1', prefix: 'doc-prefix' },\n        filename: 'logo.png',\n        req,\n      })\n\n      expect(result).toBe('doc-prefix')\n    })\n\n    it('sanitizes the document prefix', async () => {\n      const req = makeReq()\n\n      const result = await getFilePrefix({\n        collection: makeCollection(),\n        doc: { id: '1', prefix: '../secret' },\n        filename: 'logo.png',\n        req,\n      })\n\n      expect(result).toBe('secret')\n    })\n  })\n\n  describe('access-controlled database resolution', () => {\n    it('does NOT short-circuit on a client-supplied prefix — the access-controlled query still runs', async () => {\n      const req = makeReq([{ _objectKey: 'abc123', prefix: 'documents' }])\n\n      await getFilePrefix({\n        collection: makeCollection({ hasPrefixField: true }),\n        filename: 'logo.png',\n        prefixQueryParam: 'documents',\n        req,\n      })\n\n      expect(req.payload.find).toHaveBeenCalledOnce()\n    })\n\n    it('queries with access control enabled and hidden fields', async () => {\n      const req = makeReq([{ prefix: 'db-prefix' }])\n\n      await getFilePrefix({\n        collection: makeCollection(),\n        filename: 'logo.png',\n        req,\n      })\n\n      expect(req.payload.find).toHaveBeenCalledWith(\n        expect.objectContaining({ overrideAccess: false, req, showHiddenFields: true }),\n      )\n    })\n\n    it('folds the stored object key into the resolved prefix', async () => {\n      const req = makeReq([{ _objectKey: 'abc123', prefix: 'db-prefix' }])\n\n      const result = await getFilePrefix({\n        collection: makeCollection(),\n        filename: 'logo.png',\n        req,\n      })\n\n      expect(result).toBe('db-prefix/abc123')\n    })\n\n    it('returns an empty string when no document is found', async () => {\n      const req = makeReq([])\n\n      const result = await getFilePrefix({\n        collection: makeCollection(),\n        filename: 'logo.png',\n        req,\n      })\n\n      expect(result).toBe('')\n    })\n  })\n\n  describe('client prefix as a disambiguation filter only', () => {\n    it('adds the prefix filter when the collection persists a prefix field', async () => {\n      const req = makeReq([{ prefix: 'documents' }])\n\n      await getFilePrefix({\n        collection: makeCollection({ hasPrefixField: true }),\n        filename: 'logo.png',\n        prefixQueryParam: 'documents',\n        req,\n      })\n\n      expect(whereOf(req)).toContain('prefix')\n    })\n\n    it('omits the prefix filter when the collection has no prefix field', async () => {\n      const req = makeReq([{ prefix: '' }])\n\n      await getFilePrefix({\n        collection: makeCollection({ hasPrefixField: false }),\n        filename: 'logo.png',\n        prefixQueryParam: 'anything',\n        req,\n      })\n\n      expect(whereOf(req)).not.toContain('prefix')\n    })\n  })\n})\n"],"names":["describe","expect","it","vi","getFilePrefix","makeReq","docs","payload","find","fn","mockResolvedValue","makeCollection","hasPrefixField","slug","fields","name","type","upload","whereOf","req","JSON","stringify","mock","calls","where","prefix","doc","id","result","collection","collectionPrefix","filename","prefixQueryParam","uploadReference","toBe","not","toHaveBeenCalled","_objectKey","toHaveBeenCalledOnce","toHaveBeenCalledWith","objectContaining","overrideAccess","showHiddenFields","toContain"],"mappings":"AAEA,SAASA,QAAQ,EAAEC,MAAM,EAAEC,EAAE,EAAEC,EAAE,QAAQ,SAAQ;AAEjD,SAASC,aAAa,QAAQ,qBAAoB;AAElD,MAAMC,UAAU,CAACC,OAAkB,EAAE,GAClC,CAAA;QACCC,SAAS;YACPC,MAAML,GAAGM,EAAE,GAAGC,iBAAiB,CAAC;gBAAEJ;YAAK;QACzC;IACF,CAAA;AAEF,MAAMK,iBAAiB,CAAC,EACtBC,iBAAiB,KAAK,EACO,GAAG,CAAC,CAAC,GACjC,CAAA;QACCC,MAAM;QACNC,QAAQF,iBAAiB;YAAC;gBAAEG,MAAM;gBAAUC,MAAM;YAAO;SAAE,GAAG,EAAE;QAChEC,QAAQ,CAAC;IACX,CAAA;AAEF,MAAMC,UAAU,CAACC,MACfC,KAAKC,SAAS,CACZ,AAACF,IAAIZ,OAAO,CAACC,IAAI,CAA4Dc,IAAI,CAACC,KAAK,CAAC,EAAE,CAAC,EAAE,CAC1FC,KAAK;AAGZxB,SAAS,iBAAiB;IACxBE,GAAG,mFAAmF;QACpF,MAAMiB,MAAMd,QAAQ;YAAC;gBAAEoB,QAAQ;YAAY;SAAE;QAC7C,MAAMC,MAAM;YAAEC,IAAI;YAAKF,QAAQ;QAAW;QAE1C,MAAMG,SAAS,MAAMxB,cAAc;YACjCyB,YAAYlB;YACZmB,kBAAkB;YAClBJ;YACAK,UAAU;YACVC,kBAAkB;YAClBb;YACAc,iBAAiB;gBAAER,QAAQ;YAAmB;QAChD;QAEAxB,OAAO2B,QAAQM,IAAI,CAAC;QACpBjC,OAAOkB,IAAIZ,OAAO,CAACC,IAAI,EAAE2B,GAAG,CAACC,gBAAgB;IAC/C;IAEAlC,GAAG,0EAA0E;QAC3E,MAAMiB,MAAMd,QAAQ;YAAC;gBAAEoB,QAAQ;YAAY;SAAE;QAE7C,MAAMG,SAAS,MAAMxB,cAAc;YACjCyB,YAAYlB;YACZmB,kBAAkB;YAClBJ,KAAK;gBAAEC,IAAI;YAAI;YACfI,UAAU;YACVZ;QACF;QAEAlB,OAAO2B,QAAQM,IAAI,CAAC;QACpBjC,OAAOkB,IAAIZ,OAAO,CAACC,IAAI,EAAE2B,GAAG,CAACC,gBAAgB;IAC/C;IAEAlC,GAAG,qEAAqE;QACtE,MAAMiB,MAAMd;QAEZ,MAAMuB,SAAS,MAAMxB,cAAc;YACjCyB,YAAYlB;YACZmB,kBAAkB;YAClBC,UAAU;YACVZ;YACAc,iBAAiB;gBAAER,QAAQ;YAAW;QACxC;QAEAxB,OAAO2B,QAAQM,IAAI,CAAC;QACpBjC,OAAOkB,IAAIZ,OAAO,CAACC,IAAI,EAAE2B,GAAG,CAACC,gBAAgB;IAC/C;IAEApC,SAAS,uCAAuC;QAC9CE,GAAG,+DAA+D;YAChE,MAAMiB,MAAMd;YAEZ,MAAMuB,SAAS,MAAMxB,cAAc;gBACjCyB,YAAYlB;gBACZoB,UAAU;gBACVZ;gBACAc,iBAAiB;oBAAEI,YAAY;oBAAUZ,QAAQ;gBAAY;YAC/D;YAEAxB,OAAO2B,QAAQM,IAAI,CAAC;YACpBjC,OAAOkB,IAAIZ,OAAO,CAACC,IAAI,EAAE2B,GAAG,CAACC,gBAAgB;QAC/C;QAEAlC,GAAG,iEAAiE;YAClE,MAAMiB,MAAMd;YAEZ,MAAMuB,SAAS,MAAMxB,cAAc;gBACjCyB,YAAYlB;gBACZoB,UAAU;gBACVZ;gBACAc,iBAAiB;oBAAER,QAAQ;gBAAY;YACzC;YAEAxB,OAAO2B,QAAQM,IAAI,CAAC;QACtB;IACF;IAEAlC,SAAS,iCAAiC;QACxCE,GAAG,wEAAwE;YACzE,MAAMiB,MAAMd,QAAQ;gBAAC;oBAAEoB,QAAQ;gBAAY;aAAE;YAE7C,MAAMG,SAAS,MAAMxB,cAAc;gBACjCyB,YAAYlB;gBACZe,KAAK;oBAAEC,IAAI;oBAAKU,YAAY;oBAAUZ,QAAQ;gBAAa;gBAC3DM,UAAU;gBACVZ;YACF;YAEAlB,OAAO2B,QAAQM,IAAI,CAAC;YACpBjC,OAAOkB,IAAIZ,OAAO,CAACC,IAAI,EAAE2B,GAAG,CAACC,gBAAgB;QAC/C;QAEAlC,GAAG,+DAA+D;YAChE,MAAMiB,MAAMd;YAEZ,MAAMuB,SAAS,MAAMxB,cAAc;gBACjCyB,YAAYlB;gBACZe,KAAK;oBAAEC,IAAI;oBAAKF,QAAQ;gBAAa;gBACrCM,UAAU;gBACVZ;YACF;YAEAlB,OAAO2B,QAAQM,IAAI,CAAC;QACtB;QAEAhC,GAAG,iCAAiC;YAClC,MAAMiB,MAAMd;YAEZ,MAAMuB,SAAS,MAAMxB,cAAc;gBACjCyB,YAAYlB;gBACZe,KAAK;oBAAEC,IAAI;oBAAKF,QAAQ;gBAAY;gBACpCM,UAAU;gBACVZ;YACF;YAEAlB,OAAO2B,QAAQM,IAAI,CAAC;QACtB;IACF;IAEAlC,SAAS,yCAAyC;QAChDE,GAAG,+FAA+F;YAChG,MAAMiB,MAAMd,QAAQ;gBAAC;oBAAEgC,YAAY;oBAAUZ,QAAQ;gBAAY;aAAE;YAEnE,MAAMrB,cAAc;gBAClByB,YAAYlB,eAAe;oBAAEC,gBAAgB;gBAAK;gBAClDmB,UAAU;gBACVC,kBAAkB;gBAClBb;YACF;YAEAlB,OAAOkB,IAAIZ,OAAO,CAACC,IAAI,EAAE8B,oBAAoB;QAC/C;QAEApC,GAAG,yDAAyD;YAC1D,MAAMiB,MAAMd,QAAQ;gBAAC;oBAAEoB,QAAQ;gBAAY;aAAE;YAE7C,MAAMrB,cAAc;gBAClByB,YAAYlB;gBACZoB,UAAU;gBACVZ;YACF;YAEAlB,OAAOkB,IAAIZ,OAAO,CAACC,IAAI,EAAE+B,oBAAoB,CAC3CtC,OAAOuC,gBAAgB,CAAC;gBAAEC,gBAAgB;gBAAOtB;gBAAKuB,kBAAkB;YAAK;QAEjF;QAEAxC,GAAG,wDAAwD;YACzD,MAAMiB,MAAMd,QAAQ;gBAAC;oBAAEgC,YAAY;oBAAUZ,QAAQ;gBAAY;aAAE;YAEnE,MAAMG,SAAS,MAAMxB,cAAc;gBACjCyB,YAAYlB;gBACZoB,UAAU;gBACVZ;YACF;YAEAlB,OAAO2B,QAAQM,IAAI,CAAC;QACtB;QAEAhC,GAAG,qDAAqD;YACtD,MAAMiB,MAAMd,QAAQ,EAAE;YAEtB,MAAMuB,SAAS,MAAMxB,cAAc;gBACjCyB,YAAYlB;gBACZoB,UAAU;gBACVZ;YACF;YAEAlB,OAAO2B,QAAQM,IAAI,CAAC;QACtB;IACF;IAEAlC,SAAS,iDAAiD;QACxDE,GAAG,sEAAsE;YACvE,MAAMiB,MAAMd,QAAQ;gBAAC;oBAAEoB,QAAQ;gBAAY;aAAE;YAE7C,MAAMrB,cAAc;gBAClByB,YAAYlB,eAAe;oBAAEC,gBAAgB;gBAAK;gBAClDmB,UAAU;gBACVC,kBAAkB;gBAClBb;YACF;YAEAlB,OAAOiB,QAAQC,MAAMwB,SAAS,CAAC;QACjC;QAEAzC,GAAG,mEAAmE;YACpE,MAAMiB,MAAMd,QAAQ;gBAAC;oBAAEoB,QAAQ;gBAAG;aAAE;YAEpC,MAAMrB,cAAc;gBAClByB,YAAYlB,eAAe;oBAAEC,gBAAgB;gBAAM;gBACnDmB,UAAU;gBACVC,kBAAkB;gBAClBb;YACF;YAEAlB,OAAOiB,QAAQC,MAAMgB,GAAG,CAACQ,SAAS,CAAC;QACrC;IACF;AACF"}

package/dist/utilities/resolveSignedURLKey.d.ts

@@ -1,4 +1,5 @@
 import type { PayloadRequest } from 'payload';
+import type { UploadReference } from '../types.js';
 type Args = {
     collectionPrefix?: string;
     collectionSlug: string;
@@ -12,13 +13,23 @@ type Args = {
  * the filename via {@link getSafeFileName} so a duplicate upload does not
  * overwrite an existing blob.
  *
+ * A unique per-upload segment is included in the storage key so each issued
+ * key is distinct. The stored `filename` stays clean and the semantic `prefix`
+ * stays exactly what the collection configured — the per-upload entropy is
+ * persisted separately in `_objectKey`.
+ *
  * The resolved `sanitizedFilename` is returned so the browser-side handler
  * can update the form via `updateFilename`.
+ *
+ * The semantic prefix is resolved with {@link buildUploadPrefix} and the final
+ * key with {@link buildUploadStoragePathData}, so the receipt only ever signs a key
+ * beneath the configured collection prefix.
  */
 export declare function resolveSignedURLKey({ collectionPrefix, collectionSlug, docPrefix, filename, req, useCompositePrefixes, }: Args): Promise<{
-    fileKey: string;
     sanitizedDocPrefix: string;
     sanitizedFilename: string;
+    storageFilePath: string;
+    uploadReference: UploadReference;
 }>;
 export {};
 //# sourceMappingURL=resolveSignedURLKey.d.ts.map

package/dist/utilities/resolveSignedURLKey.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"resolveSignedURLKey.d.ts","sourceRoot":"","sources":["../../src/utilities/resolveSignedURLKey.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAM7C,KAAK,IAAI,GAAG;IACV,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,cAAc,EAAE,MAAM,CAAA;IACtB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,MAAM,CAAA;IAChB,GAAG,EAAE,cAAc,CAAA;IACnB,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B,CAAA;AAED;;;;;;;GAOG;AACH,wBAAsB,mBAAmB,CAAC,EACxC,gBAAqB,EACrB,cAAc,EACd,SAAS,EACT,QAAQ,EACR,GAAG,EACH,oBAA4B,GAC7B,EAAE,IAAI;;;;GAgBN"}
+{"version":3,"file":"resolveSignedURLKey.d.ts","sourceRoot":"","sources":["../../src/utilities/resolveSignedURLKey.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAM7C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAIlD,KAAK,IAAI,GAAG;IACV,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,cAAc,EAAE,MAAM,CAAA;IACtB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,MAAM,CAAA;IAChB,GAAG,EAAE,cAAc,CAAA;IACnB,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B,CAAA;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAsB,mBAAmB,CAAC,EACxC,gBAAqB,EACrB,cAAc,EACd,SAAS,EACT,QAAQ,EACR,GAAG,EACH,oBAA4B,GAC7B,EAAE,IAAI,GAAG,OAAO,CAAC;IAChB,kBAAkB,EAAE,MAAM,CAAA;IAC1B,iBAAiB,EAAE,MAAM,CAAA;IACzB,eAAe,EAAE,MAAM,CAAA;IACvB,eAAe,EAAE,eAAe,CAAA;CACjC,CAAC,CAyCD"}

package/dist/utilities/resolveSignedURLKey.js

@@ -1,29 +1,63 @@
-import { getSafeFileName } from 'payload/internal';
-import { getFileKey } from './getFileKey.js';
+import { randomUUID } from 'node:crypto';
+import { createClientUploadReceipt, getSafeFileName } from 'payload/internal';
+import { getSanitizedUploadFilename } from 'payload/shared';
+import { buildUploadPrefix, buildUploadStoragePathData } from './buildStoragePathData.js';
 /**
  * Resolves the storage key for an upload-instructions request, deduping
  * the filename via {@link getSafeFileName} so a duplicate upload does not
  * overwrite an existing blob.
  *
+ * A unique per-upload segment is included in the storage key so each issued
+ * key is distinct. The stored `filename` stays clean and the semantic `prefix`
+ * stays exactly what the collection configured — the per-upload entropy is
+ * persisted separately in `_objectKey`.
+ *
  * The resolved `sanitizedFilename` is returned so the browser-side handler
  * can update the form via `updateFilename`.
+ *
+ * The semantic prefix is resolved with {@link buildUploadPrefix} and the final
+ * key with {@link buildUploadStoragePathData}, so the receipt only ever signs a key
+ * beneath the configured collection prefix.
  */ export async function resolveSignedURLKey({ collectionPrefix = '', collectionSlug, docPrefix, filename, req, useCompositePrefixes = false }) {
+    // Sanitize with the same helper generateFileData uses for the DB filename so the storage key
+    // and doc.filename stay in sync (#16694).
     const sanitizedFilename = await getSafeFileName({
         collectionSlug,
-        desiredFilename: filename,
-        prefix: docPrefix,
+        desiredFilename: getSanitizedUploadFilename(filename),
         req
     });
-    const { fileKey, sanitizedDocPrefix } = getFileKey({
+    const rawBaseDocPrefix = useCompositePrefixes ? docPrefix : docPrefix || collectionPrefix;
+    const { sanitizedDocPrefix } = buildUploadPrefix({
+        collectionPrefix,
+        docPrefix: rawBaseDocPrefix,
+        useCompositePrefixes
+    });
+    const _objectKey = randomUUID();
+    // Per-upload segment lives in the key; it is persisted in `_objectKey`, keeping `prefix` semantic.
+    const keyedDocPrefix = sanitizedDocPrefix ? `${sanitizedDocPrefix}/${_objectKey}` : _objectKey;
+    const { storageFilePath } = buildUploadStoragePathData({
         collectionPrefix,
-        docPrefix,
+        docPrefix: keyedDocPrefix,
         filename: sanitizedFilename,
         useCompositePrefixes
     });
+    const uploadReference = {
+        _objectKey,
+        prefix: sanitizedDocPrefix,
+        signedReceipt: createClientUploadReceipt({
+            _objectKey,
+            collectionSlug,
+            filename: sanitizedFilename,
+            filePrefix: sanitizedDocPrefix,
+            req,
+            storageFilePath
+        })
+    };
     return {
-        fileKey,
         sanitizedDocPrefix,
-        sanitizedFilename
+        sanitizedFilename,
+        storageFilePath,
+        uploadReference
     };
 }
 

package/dist/utilities/resolveSignedURLKey.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/utilities/resolveSignedURLKey.ts"],"sourcesContent":["import type { PayloadRequest } from 'payload'\n\nimport { getSafeFileName } from 'payload/internal'\n\nimport { getFileKey } from './getFileKey.js'\n\ntype Args = {\n  collectionPrefix?: string\n  collectionSlug: string\n  docPrefix?: string\n  filename: string\n  req: PayloadRequest\n  useCompositePrefixes?: boolean\n}\n\n/**\n * Resolves the storage key for an upload-instructions request, deduping\n * the filename via {@link getSafeFileName} so a duplicate upload does not\n * overwrite an existing blob.\n *\n * The resolved `sanitizedFilename` is returned so the browser-side handler\n * can update the form via `updateFilename`.\n */\nexport async function resolveSignedURLKey({\n  collectionPrefix = '',\n  collectionSlug,\n  docPrefix,\n  filename,\n  req,\n  useCompositePrefixes = false,\n}: Args) {\n  const sanitizedFilename = await getSafeFileName({\n    collectionSlug,\n    desiredFilename: filename,\n    prefix: docPrefix,\n    req,\n  })\n\n  const { fileKey, sanitizedDocPrefix } = getFileKey({\n    collectionPrefix,\n    docPrefix,\n    filename: sanitizedFilename,\n    useCompositePrefixes,\n  })\n\n  return { fileKey, sanitizedDocPrefix, sanitizedFilename }\n}\n"],"names":["getSafeFileName","getFileKey","resolveSignedURLKey","collectionPrefix","collectionSlug","docPrefix","filename","req","useCompositePrefixes","sanitizedFilename","desiredFilename","prefix","fileKey","sanitizedDocPrefix"],"mappings":"AAEA,SAASA,eAAe,QAAQ,mBAAkB;AAElD,SAASC,UAAU,QAAQ,kBAAiB;AAW5C;;;;;;;CAOC,GACD,OAAO,eAAeC,oBAAoB,EACxCC,mBAAmB,EAAE,EACrBC,cAAc,EACdC,SAAS,EACTC,QAAQ,EACRC,GAAG,EACHC,uBAAuB,KAAK,EACvB;IACL,MAAMC,oBAAoB,MAAMT,gBAAgB;QAC9CI;QACAM,iBAAiBJ;QACjBK,QAAQN;QACRE;IACF;IAEA,MAAM,EAAEK,OAAO,EAAEC,kBAAkB,EAAE,GAAGZ,WAAW;QACjDE;QACAE;QACAC,UAAUG;QACVD;IACF;IAEA,OAAO;QAAEI;QAASC;QAAoBJ;IAAkB;AAC1D"}
+{"version":3,"sources":["../../src/utilities/resolveSignedURLKey.ts"],"sourcesContent":["import type { PayloadRequest } from 'payload'\n\nimport { randomUUID } from 'node:crypto'\nimport { createClientUploadReceipt, getSafeFileName } from 'payload/internal'\nimport { getSanitizedUploadFilename } from 'payload/shared'\n\nimport type { UploadReference } from '../types.js'\n\nimport { buildUploadPrefix, buildUploadStoragePathData } from './buildStoragePathData.js'\n\ntype Args = {\n  collectionPrefix?: string\n  collectionSlug: string\n  docPrefix?: string\n  filename: string\n  req: PayloadRequest\n  useCompositePrefixes?: boolean\n}\n\n/**\n * Resolves the storage key for an upload-instructions request, deduping\n * the filename via {@link getSafeFileName} so a duplicate upload does not\n * overwrite an existing blob.\n *\n * A unique per-upload segment is included in the storage key so each issued\n * key is distinct. The stored `filename` stays clean and the semantic `prefix`\n * stays exactly what the collection configured — the per-upload entropy is\n * persisted separately in `_objectKey`.\n *\n * The resolved `sanitizedFilename` is returned so the browser-side handler\n * can update the form via `updateFilename`.\n *\n * The semantic prefix is resolved with {@link buildUploadPrefix} and the final\n * key with {@link buildUploadStoragePathData}, so the receipt only ever signs a key\n * beneath the configured collection prefix.\n */\nexport async function resolveSignedURLKey({\n  collectionPrefix = '',\n  collectionSlug,\n  docPrefix,\n  filename,\n  req,\n  useCompositePrefixes = false,\n}: Args): Promise<{\n  sanitizedDocPrefix: string\n  sanitizedFilename: string\n  storageFilePath: string\n  uploadReference: UploadReference\n}> {\n  // Sanitize with the same helper generateFileData uses for the DB filename so the storage key\n  // and doc.filename stay in sync (#16694).\n  const sanitizedFilename = await getSafeFileName({\n    collectionSlug,\n    desiredFilename: getSanitizedUploadFilename(filename),\n    req,\n  })\n\n  const rawBaseDocPrefix = useCompositePrefixes ? docPrefix : docPrefix || collectionPrefix\n  const { sanitizedDocPrefix } = buildUploadPrefix({\n    collectionPrefix,\n    docPrefix: rawBaseDocPrefix,\n    useCompositePrefixes,\n  })\n\n  const _objectKey = randomUUID()\n  // Per-upload segment lives in the key; it is persisted in `_objectKey`, keeping `prefix` semantic.\n  const keyedDocPrefix = sanitizedDocPrefix ? `${sanitizedDocPrefix}/${_objectKey}` : _objectKey\n\n  const { storageFilePath } = buildUploadStoragePathData({\n    collectionPrefix,\n    docPrefix: keyedDocPrefix,\n    filename: sanitizedFilename,\n    useCompositePrefixes,\n  })\n\n  const uploadReference = {\n    _objectKey,\n    prefix: sanitizedDocPrefix,\n    signedReceipt: createClientUploadReceipt({\n      _objectKey,\n      collectionSlug,\n      filename: sanitizedFilename,\n      filePrefix: sanitizedDocPrefix,\n      req,\n      storageFilePath,\n    }),\n  }\n\n  return { sanitizedDocPrefix, sanitizedFilename, storageFilePath, uploadReference }\n}\n"],"names":["randomUUID","createClientUploadReceipt","getSafeFileName","getSanitizedUploadFilename","buildUploadPrefix","buildUploadStoragePathData","resolveSignedURLKey","collectionPrefix","collectionSlug","docPrefix","filename","req","useCompositePrefixes","sanitizedFilename","desiredFilename","rawBaseDocPrefix","sanitizedDocPrefix","_objectKey","keyedDocPrefix","storageFilePath","uploadReference","prefix","signedReceipt","filePrefix"],"mappings":"AAEA,SAASA,UAAU,QAAQ,cAAa;AACxC,SAASC,yBAAyB,EAAEC,eAAe,QAAQ,mBAAkB;AAC7E,SAASC,0BAA0B,QAAQ,iBAAgB;AAI3D,SAASC,iBAAiB,EAAEC,0BAA0B,QAAQ,4BAA2B;AAWzF;;;;;;;;;;;;;;;;CAgBC,GACD,OAAO,eAAeC,oBAAoB,EACxCC,mBAAmB,EAAE,EACrBC,cAAc,EACdC,SAAS,EACTC,QAAQ,EACRC,GAAG,EACHC,uBAAuB,KAAK,EACvB;IAML,6FAA6F;IAC7F,0CAA0C;IAC1C,MAAMC,oBAAoB,MAAMX,gBAAgB;QAC9CM;QACAM,iBAAiBX,2BAA2BO;QAC5CC;IACF;IAEA,MAAMI,mBAAmBH,uBAAuBH,YAAYA,aAAaF;IACzE,MAAM,EAAES,kBAAkB,EAAE,GAAGZ,kBAAkB;QAC/CG;QACAE,WAAWM;QACXH;IACF;IAEA,MAAMK,aAAajB;IACnB,mGAAmG;IACnG,MAAMkB,iBAAiBF,qBAAqB,GAAGA,mBAAmB,CAAC,EAAEC,YAAY,GAAGA;IAEpF,MAAM,EAAEE,eAAe,EAAE,GAAGd,2BAA2B;QACrDE;QACAE,WAAWS;QACXR,UAAUG;QACVD;IACF;IAEA,MAAMQ,kBAAkB;QACtBH;QACAI,QAAQL;QACRM,eAAerB,0BAA0B;YACvCgB;YACAT;YACAE,UAAUG;YACVU,YAAYP;YACZL;YACAQ;QACF;IACF;IAEA,OAAO;QAAEH;QAAoBH;QAAmBM;QAAiBC;IAAgB;AACnF"}