@payloadcms/storage-s3 4.0.0-internal.d28e9fb → 4.0.0-internal.d3909a9

package/dist/getFile.js

@@ -1,7 +1,7 @@
 import { GetObjectCommand } from '@aws-sdk/client-s3';
 import { getSignedUrl } from '@aws-sdk/s3-request-presigner';
-import { getFilePrefix as getDocPrefix, getFileKey } from '@payloadcms/plugin-cloud-storage/utilities';
-import { getRangeRequestInfo } from 'payload/internal';
+import { buildStoragePathData, getFilePrefix as getDocPrefix } from '@payloadcms/plugin-cloud-storage/utilities';
+import { getRangeRequestInfo, isXmlMimeType, uploadContentSecurityPolicy } from 'payload/internal';
 const isNodeReadableStream = (body)=>{
     return typeof body === 'object' && body !== null && 'pipe' in body && typeof body.pipe === 'function' && 'destroy' in body && typeof body.destroy === 'function';
 };
@@ -14,7 +14,8 @@ const abortRequestAndDestroyStream = ({ abortController, object })=>{
         object.Body.destroy();
     }
 };
-export async function getFile({ bucket, client, clientUploadContext, collection, collectionPrefix = '', filename, incomingHeaders, prefixQueryParam, req, signedDownloads, useCompositePrefixes = false }) {
+export async function getFile({ bucket, client, collection, collectionPrefix = '', doc, filename, incomingHeaders, operation = 'read', req, signedDownloads, uploadReference, useCompositePrefixes = false }) {
+    const isTransformSource = operation === 'transform';
     let object = undefined;
     let streamed = false;
     const abortController = new AbortController();
@@ -28,19 +29,21 @@ export async function getFile({ bucket, client, clientUploadContext, collection,
     }
     try {
         const docPrefix = await getDocPrefix({
-            clientUploadContext,
             collection,
+            collectionPrefix,
+            doc,
             filename,
-            prefixQueryParam,
-            req
+            req,
+            uploadReference,
+            useCompositePrefixes
         });
-        const { fileKey: key } = getFileKey({
+        const { storageFilePath } = buildStoragePathData({
             collectionPrefix,
             docPrefix,
             filename,
             useCompositePrefixes
         });
-        if (signedDownloads && !clientUploadContext) {
+        if (signedDownloads && !uploadReference && !isTransformSource) {
             let useSignedURL = true;
             if (typeof signedDownloads === 'object' && typeof signedDownloads.shouldUseSignedURL === 'function') {
                 useSignedURL = await signedDownloads.shouldUseSignedURL({
@@ -52,7 +55,7 @@ export async function getFile({ bucket, client, clientUploadContext, collection,
             if (useSignedURL) {
                 const command = new GetObjectCommand({
                     Bucket: bucket,
-                    Key: key
+                    Key: storageFilePath
                 });
                 const signedUrl = await getSignedUrl(client, command, typeof signedDownloads === 'object' ? signedDownloads : {
                     expiresIn: 7200
@@ -60,10 +63,9 @@ export async function getFile({ bucket, client, clientUploadContext, collection,
                 return Response.redirect(signedUrl, 302);
             }
         }
-        // Get file size first for range validation and to set Content-Length header before streaming
         const headObject = await client.headObject({
             Bucket: bucket,
-            Key: key
+            Key: storageFilePath
         });
         const fileSize = headObject.ContentLength;
         if (!fileSize) {
@@ -71,8 +73,7 @@ export async function getFile({ bucket, client, clientUploadContext, collection,
                 status: 500
             });
         }
-        // Handle range request
-        const rangeHeader = req.headers.get('range');
+        const rangeHeader = isTransformSource ? null : req.headers.get('range');
         const rangeResult = getRangeRequestInfo({
             fileSize,
             rangeHeader
@@ -85,7 +86,6 @@ export async function getFile({ bucket, client, clientUploadContext, collection,
         }
         const rangeForS3 = rangeResult.type === 'partial' ? `bytes=${rangeResult.rangeStart}-${rangeResult.rangeEnd}` : undefined;
         let headers = new Headers(incomingHeaders);
-        // Add range-related headers from the result
         for (const [headerKey, value] of Object.entries(rangeResult.headers)){
             headers.append(headerKey, value);
         }
@@ -93,18 +93,18 @@ export async function getFile({ bucket, client, clientUploadContext, collection,
         if (headObject.ETag) {
             headers.append('ETag', headObject.ETag);
         }
-        // Add Content-Security-Policy header for SVG files to prevent executable code
-        if (headObject.ContentType === 'image/svg+xml') {
-            headers.append('Content-Security-Policy', "script-src 'none'");
+        // Apply a restrictive policy to XML-family responses served through Payload.
+        if (isXmlMimeType(headObject.ContentType)) {
+            headers.append('Content-Security-Policy', uploadContentSecurityPolicy);
         }
         const etagFromHeaders = req.headers.get('etag') || req.headers.get('if-none-match');
         const objectEtag = headObject.ETag;
-        if (collection.upload && typeof collection.upload === 'object' && typeof collection.upload.modifyResponseHeaders === 'function') {
+        if (!isTransformSource && collection.upload && typeof collection.upload === 'object' && typeof collection.upload.modifyResponseHeaders === 'function') {
             headers = collection.upload.modifyResponseHeaders({
                 headers
             }) || headers;
         }
-        if (etagFromHeaders && etagFromHeaders === objectEtag) {
+        if (!isTransformSource && etagFromHeaders && etagFromHeaders === objectEtag) {
             return new Response(null, {
                 headers,
                 status: 304
@@ -112,7 +112,7 @@ export async function getFile({ bucket, client, clientUploadContext, collection,
         }
         object = await client.getObject({
             Bucket: bucket,
-            Key: key,
+            Key: storageFilePath,
             Range: rangeForS3
         }, {
             abortSignal: abortController.signal
@@ -125,7 +125,7 @@ export async function getFile({ bucket, client, clientUploadContext, collection,
         }
         if (!isNodeReadableStream(object.Body)) {
             req.payload.logger.error({
-                key,
+                key: storageFilePath,
                 msg: 'S3 object body is not a readable stream'
             });
             return new Response('Internal Server Error', {
@@ -136,7 +136,7 @@ export async function getFile({ bucket, client, clientUploadContext, collection,
         stream.on('error', (err)=>{
             req.payload.logger.error({
                 err,
-                key,
+                key: storageFilePath,
                 msg: 'Error while streaming S3 object (aborting)'
             });
             abortRequestAndDestroyStream({

package/dist/getFile.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/getFile.ts"],"sourcesContent":["import type * as AWS from '@aws-sdk/client-s3'\nimport type { CollectionConfig, PayloadRequest } from 'payload'\nimport type { Readable } from 'stream'\n\nimport { GetObjectCommand } from '@aws-sdk/client-s3'\nimport { getSignedUrl } from '@aws-sdk/s3-request-presigner'\nimport {\n  getFilePrefix as getDocPrefix,\n  getFileKey,\n} from '@payloadcms/plugin-cloud-storage/utilities'\nimport { getRangeRequestInfo } from 'payload/internal'\n\nexport type SignedDownloadsConfig =\n  | {\n      /** @default 7200 */\n      expiresIn?: number\n      shouldUseSignedURL?(args: {\n        collection: CollectionConfig\n        filename: string\n        req: PayloadRequest\n      }): boolean | Promise<boolean>\n    }\n  | boolean\n\ninterface GetFileArgs {\n  bucket: string\n  client: AWS.S3\n  clientUploadContext?: unknown\n  collection: CollectionConfig\n  collectionPrefix?: string\n  filename: string\n  incomingHeaders?: Headers\n  prefixQueryParam?: string\n  req: PayloadRequest\n  signedDownloads: SignedDownloadsConfig\n  useCompositePrefixes?: boolean\n}\n\nconst isNodeReadableStream = (body: AWS.GetObjectOutput['Body']): body is Readable => {\n  return (\n    typeof body === 'object' &&\n    body !== null &&\n    'pipe' in body &&\n    typeof body.pipe === 'function' &&\n    'destroy' in body &&\n    typeof body.destroy === 'function'\n  )\n}\n\nconst abortRequestAndDestroyStream = ({\n  abortController,\n  object,\n}: {\n  abortController: AbortController\n  object?: AWS.GetObjectOutput\n}) => {\n  try {\n    abortController.abort()\n  } catch {\n    /* noop */\n  }\n  if (object?.Body && isNodeReadableStream(object.Body)) {\n    object.Body.destroy()\n  }\n}\n\nexport async function getFile({\n  bucket,\n  client,\n  clientUploadContext,\n  collection,\n  collectionPrefix = '',\n  filename,\n  incomingHeaders,\n  prefixQueryParam,\n  req,\n  signedDownloads,\n  useCompositePrefixes = false,\n}: GetFileArgs): Promise<Response> {\n  let object: AWS.GetObjectOutput | undefined = undefined\n  let streamed = false\n\n  const abortController = new AbortController()\n  if (req.signal) {\n    req.signal.addEventListener('abort', () => {\n      abortRequestAndDestroyStream({ abortController, object })\n    })\n  }\n\n  try {\n    const docPrefix = await getDocPrefix({\n      clientUploadContext,\n      collection,\n      filename,\n      prefixQueryParam,\n      req,\n    })\n\n    const { fileKey: key } = getFileKey({\n      collectionPrefix,\n      docPrefix,\n      filename,\n      useCompositePrefixes,\n    })\n\n    if (signedDownloads && !clientUploadContext) {\n      let useSignedURL = true\n      if (\n        typeof signedDownloads === 'object' &&\n        typeof signedDownloads.shouldUseSignedURL === 'function'\n      ) {\n        useSignedURL = await signedDownloads.shouldUseSignedURL({ collection, filename, req })\n      }\n\n      if (useSignedURL) {\n        const command = new GetObjectCommand({ Bucket: bucket, Key: key })\n        const signedUrl = await getSignedUrl(\n          client,\n          command,\n          typeof signedDownloads === 'object' ? signedDownloads : { expiresIn: 7200 },\n        )\n        return Response.redirect(signedUrl, 302)\n      }\n    }\n\n    // Get file size first for range validation and to set Content-Length header before streaming\n    const headObject = await client.headObject({\n      Bucket: bucket,\n      Key: key,\n    })\n    const fileSize = headObject.ContentLength\n\n    if (!fileSize) {\n      return new Response('Internal Server Error', { status: 500 })\n    }\n\n    // Handle range request\n    const rangeHeader = req.headers.get('range')\n    const rangeResult = getRangeRequestInfo({ fileSize, rangeHeader })\n\n    if (rangeResult.type === 'invalid') {\n      return new Response(null, {\n        headers: new Headers(rangeResult.headers),\n        status: rangeResult.status,\n      })\n    }\n\n    const rangeForS3 =\n      rangeResult.type === 'partial'\n        ? `bytes=${rangeResult.rangeStart}-${rangeResult.rangeEnd}`\n        : undefined\n\n    let headers = new Headers(incomingHeaders)\n\n    // Add range-related headers from the result\n    for (const [headerKey, value] of Object.entries(rangeResult.headers)) {\n      headers.append(headerKey, value)\n    }\n\n    headers.append('Content-Type', String(headObject.ContentType))\n    if (headObject.ETag) {\n      headers.append('ETag', headObject.ETag)\n    }\n\n    // Add Content-Security-Policy header for SVG files to prevent executable code\n    if (headObject.ContentType === 'image/svg+xml') {\n      headers.append('Content-Security-Policy', \"script-src 'none'\")\n    }\n\n    const etagFromHeaders = req.headers.get('etag') || req.headers.get('if-none-match')\n    const objectEtag = headObject.ETag\n\n    if (\n      collection.upload &&\n      typeof collection.upload === 'object' &&\n      typeof collection.upload.modifyResponseHeaders === 'function'\n    ) {\n      headers = collection.upload.modifyResponseHeaders({ headers }) || headers\n    }\n\n    if (etagFromHeaders && etagFromHeaders === objectEtag) {\n      return new Response(null, {\n        headers,\n        status: 304,\n      })\n    }\n\n    object = await client.getObject(\n      {\n        Bucket: bucket,\n        Key: key,\n        Range: rangeForS3,\n      },\n      { abortSignal: abortController.signal },\n    )\n\n    if (!object.Body) {\n      return new Response(null, { status: 404, statusText: 'Not Found' })\n    }\n\n    if (!isNodeReadableStream(object.Body)) {\n      req.payload.logger.error({\n        key,\n        msg: 'S3 object body is not a readable stream',\n      })\n      return new Response('Internal Server Error', { status: 500 })\n    }\n\n    const stream = object.Body\n    stream.on('error', (err: Error) => {\n      req.payload.logger.error({\n        err,\n        key,\n        msg: 'Error while streaming S3 object (aborting)',\n      })\n      abortRequestAndDestroyStream({ abortController, object })\n    })\n\n    streamed = true\n    return new Response(stream, { headers, status: rangeResult.status })\n  } catch (err) {\n    if (\n      err &&\n      typeof err === 'object' &&\n      (('name' in err && (err.name === 'NoSuchKey' || err.name === 'NotFound')) ||\n        ('httpStatusCode' in err && err.httpStatusCode === 404))\n    ) {\n      return new Response(null, { status: 404, statusText: 'Not Found' })\n    }\n    req.payload.logger.error(err)\n    return new Response('Internal Server Error', { status: 500 })\n  } finally {\n    if (!streamed) {\n      abortRequestAndDestroyStream({ abortController, object })\n    }\n  }\n}\n"],"names":["GetObjectCommand","getSignedUrl","getFilePrefix","getDocPrefix","getFileKey","getRangeRequestInfo","isNodeReadableStream","body","pipe","destroy","abortRequestAndDestroyStream","abortController","object","abort","Body","getFile","bucket","client","clientUploadContext","collection","collectionPrefix","filename","incomingHeaders","prefixQueryParam","req","signedDownloads","useCompositePrefixes","undefined","streamed","AbortController","signal","addEventListener","docPrefix","fileKey","key","useSignedURL","shouldUseSignedURL","command","Bucket","Key","signedUrl","expiresIn","Response","redirect","headObject","fileSize","ContentLength","status","rangeHeader","headers","get","rangeResult","type","Headers","rangeForS3","rangeStart","rangeEnd","headerKey","value","Object","entries","append","String","ContentType","ETag","etagFromHeaders","objectEtag","upload","modifyResponseHeaders","getObject","Range","abortSignal","statusText","payload","logger","error","msg","stream","on","err","name","httpStatusCode"],"mappings":"AAIA,SAASA,gBAAgB,QAAQ,qBAAoB;AACrD,SAASC,YAAY,QAAQ,gCAA+B;AAC5D,SACEC,iBAAiBC,YAAY,EAC7BC,UAAU,QACL,6CAA4C;AACnD,SAASC,mBAAmB,QAAQ,mBAAkB;AA4BtD,MAAMC,uBAAuB,CAACC;IAC5B,OACE,OAAOA,SAAS,YAChBA,SAAS,QACT,UAAUA,QACV,OAAOA,KAAKC,IAAI,KAAK,cACrB,aAAaD,QACb,OAAOA,KAAKE,OAAO,KAAK;AAE5B;AAEA,MAAMC,+BAA+B,CAAC,EACpCC,eAAe,EACfC,MAAM,EAIP;IACC,IAAI;QACFD,gBAAgBE,KAAK;IACvB,EAAE,OAAM;IACN,QAAQ,GACV;IACA,IAAID,QAAQE,QAAQR,qBAAqBM,OAAOE,IAAI,GAAG;QACrDF,OAAOE,IAAI,CAACL,OAAO;IACrB;AACF;AAEA,OAAO,eAAeM,QAAQ,EAC5BC,MAAM,EACNC,MAAM,EACNC,mBAAmB,EACnBC,UAAU,EACVC,mBAAmB,EAAE,EACrBC,QAAQ,EACRC,eAAe,EACfC,gBAAgB,EAChBC,GAAG,EACHC,eAAe,EACfC,uBAAuB,KAAK,EAChB;IACZ,IAAId,SAA0Ce;IAC9C,IAAIC,WAAW;IAEf,MAAMjB,kBAAkB,IAAIkB;IAC5B,IAAIL,IAAIM,MAAM,EAAE;QACdN,IAAIM,MAAM,CAACC,gBAAgB,CAAC,SAAS;YACnCrB,6BAA6B;gBAAEC;gBAAiBC;YAAO;QACzD;IACF;IAEA,IAAI;QACF,MAAMoB,YAAY,MAAM7B,aAAa;YACnCe;YACAC;YACAE;YACAE;YACAC;QACF;QAEA,MAAM,EAAES,SAASC,GAAG,EAAE,GAAG9B,WAAW;YAClCgB;YACAY;YACAX;YACAK;QACF;QAEA,IAAID,mBAAmB,CAACP,qBAAqB;YAC3C,IAAIiB,eAAe;YACnB,IACE,OAAOV,oBAAoB,YAC3B,OAAOA,gBAAgBW,kBAAkB,KAAK,YAC9C;gBACAD,eAAe,MAAMV,gBAAgBW,kBAAkB,CAAC;oBAAEjB;oBAAYE;oBAAUG;gBAAI;YACtF;YAEA,IAAIW,cAAc;gBAChB,MAAME,UAAU,IAAIrC,iBAAiB;oBAAEsC,QAAQtB;oBAAQuB,KAAKL;gBAAI;gBAChE,MAAMM,YAAY,MAAMvC,aACtBgB,QACAoB,SACA,OAAOZ,oBAAoB,WAAWA,kBAAkB;oBAAEgB,WAAW;gBAAK;gBAE5E,OAAOC,SAASC,QAAQ,CAACH,WAAW;YACtC;QACF;QAEA,6FAA6F;QAC7F,MAAMI,aAAa,MAAM3B,OAAO2B,UAAU,CAAC;YACzCN,QAAQtB;YACRuB,KAAKL;QACP;QACA,MAAMW,WAAWD,WAAWE,aAAa;QAEzC,IAAI,CAACD,UAAU;YACb,OAAO,IAAIH,SAAS,yBAAyB;gBAAEK,QAAQ;YAAI;QAC7D;QAEA,uBAAuB;QACvB,MAAMC,cAAcxB,IAAIyB,OAAO,CAACC,GAAG,CAAC;QACpC,MAAMC,cAAc9C,oBAAoB;YAAEwC;YAAUG;QAAY;QAEhE,IAAIG,YAAYC,IAAI,KAAK,WAAW;YAClC,OAAO,IAAIV,SAAS,MAAM;gBACxBO,SAAS,IAAII,QAAQF,YAAYF,OAAO;gBACxCF,QAAQI,YAAYJ,MAAM;YAC5B;QACF;QAEA,MAAMO,aACJH,YAAYC,IAAI,KAAK,YACjB,CAAC,MAAM,EAAED,YAAYI,UAAU,CAAC,CAAC,EAAEJ,YAAYK,QAAQ,EAAE,GACzD7B;QAEN,IAAIsB,UAAU,IAAII,QAAQ/B;QAE1B,4CAA4C;QAC5C,KAAK,MAAM,CAACmC,WAAWC,MAAM,IAAIC,OAAOC,OAAO,CAACT,YAAYF,OAAO,EAAG;YACpEA,QAAQY,MAAM,CAACJ,WAAWC;QAC5B;QAEAT,QAAQY,MAAM,CAAC,gBAAgBC,OAAOlB,WAAWmB,WAAW;QAC5D,IAAInB,WAAWoB,IAAI,EAAE;YACnBf,QAAQY,MAAM,CAAC,QAAQjB,WAAWoB,IAAI;QACxC;QAEA,8EAA8E;QAC9E,IAAIpB,WAAWmB,WAAW,KAAK,iBAAiB;YAC9Cd,QAAQY,MAAM,CAAC,2BAA2B;QAC5C;QAEA,MAAMI,kBAAkBzC,IAAIyB,OAAO,CAACC,GAAG,CAAC,WAAW1B,IAAIyB,OAAO,CAACC,GAAG,CAAC;QACnE,MAAMgB,aAAatB,WAAWoB,IAAI;QAElC,IACE7C,WAAWgD,MAAM,IACjB,OAAOhD,WAAWgD,MAAM,KAAK,YAC7B,OAAOhD,WAAWgD,MAAM,CAACC,qBAAqB,KAAK,YACnD;YACAnB,UAAU9B,WAAWgD,MAAM,CAACC,qBAAqB,CAAC;gBAAEnB;YAAQ,MAAMA;QACpE;QAEA,IAAIgB,mBAAmBA,oBAAoBC,YAAY;YACrD,OAAO,IAAIxB,SAAS,MAAM;gBACxBO;gBACAF,QAAQ;YACV;QACF;QAEAnC,SAAS,MAAMK,OAAOoD,SAAS,CAC7B;YACE/B,QAAQtB;YACRuB,KAAKL;YACLoC,OAAOhB;QACT,GACA;YAAEiB,aAAa5D,gBAAgBmB,MAAM;QAAC;QAGxC,IAAI,CAAClB,OAAOE,IAAI,EAAE;YAChB,OAAO,IAAI4B,SAAS,MAAM;gBAAEK,QAAQ;gBAAKyB,YAAY;YAAY;QACnE;QAEA,IAAI,CAAClE,qBAAqBM,OAAOE,IAAI,GAAG;YACtCU,IAAIiD,OAAO,CAACC,MAAM,CAACC,KAAK,CAAC;gBACvBzC;gBACA0C,KAAK;YACP;YACA,OAAO,IAAIlC,SAAS,yBAAyB;gBAAEK,QAAQ;YAAI;QAC7D;QAEA,MAAM8B,SAASjE,OAAOE,IAAI;QAC1B+D,OAAOC,EAAE,CAAC,SAAS,CAACC;YAClBvD,IAAIiD,OAAO,CAACC,MAAM,CAACC,KAAK,CAAC;gBACvBI;gBACA7C;gBACA0C,KAAK;YACP;YACAlE,6BAA6B;gBAAEC;gBAAiBC;YAAO;QACzD;QAEAgB,WAAW;QACX,OAAO,IAAIc,SAASmC,QAAQ;YAAE5B;YAASF,QAAQI,YAAYJ,MAAM;QAAC;IACpE,EAAE,OAAOgC,KAAK;QACZ,IACEA,OACA,OAAOA,QAAQ,YACd,CAAA,AAAC,UAAUA,OAAQA,CAAAA,IAAIC,IAAI,KAAK,eAAeD,IAAIC,IAAI,KAAK,UAAS,KACnE,oBAAoBD,OAAOA,IAAIE,cAAc,KAAK,GAAG,GACxD;YACA,OAAO,IAAIvC,SAAS,MAAM;gBAAEK,QAAQ;gBAAKyB,YAAY;YAAY;QACnE;QACAhD,IAAIiD,OAAO,CAACC,MAAM,CAACC,KAAK,CAACI;QACzB,OAAO,IAAIrC,SAAS,yBAAyB;YAAEK,QAAQ;QAAI;IAC7D,SAAU;QACR,IAAI,CAACnB,UAAU;YACblB,6BAA6B;gBAAEC;gBAAiBC;YAAO;QACzD;IACF;AACF"}
+{"version":3,"sources":["../src/getFile.ts"],"sourcesContent":["import type * as AWS from '@aws-sdk/client-s3'\nimport type { CollectionConfig, FileHandlerOperation, PayloadRequest, TypeWithID } from 'payload'\nimport type { Readable } from 'stream'\n\nimport { GetObjectCommand } from '@aws-sdk/client-s3'\nimport { getSignedUrl } from '@aws-sdk/s3-request-presigner'\nimport {\n  buildStoragePathData,\n  getFilePrefix as getDocPrefix,\n} from '@payloadcms/plugin-cloud-storage/utilities'\nimport { getRangeRequestInfo, isXmlMimeType, uploadContentSecurityPolicy } from 'payload/internal'\n\nexport type SignedDownloadsConfig =\n  | {\n      /** @default 7200 */\n      expiresIn?: number\n      shouldUseSignedURL?(args: {\n        collection: CollectionConfig\n        filename: string\n        req: PayloadRequest\n      }): boolean | Promise<boolean>\n    }\n  | boolean\n\ninterface GetFileArgs {\n  bucket: string\n  client: AWS.S3\n  collection: CollectionConfig\n  collectionPrefix?: string\n  doc?: TypeWithID\n  filename: string\n  incomingHeaders?: Headers\n  operation?: FileHandlerOperation\n  req: PayloadRequest\n  signedDownloads: SignedDownloadsConfig\n  uploadReference?: unknown\n  useCompositePrefixes?: boolean\n}\n\nconst isNodeReadableStream = (body: AWS.GetObjectOutput['Body']): body is Readable => {\n  return (\n    typeof body === 'object' &&\n    body !== null &&\n    'pipe' in body &&\n    typeof body.pipe === 'function' &&\n    'destroy' in body &&\n    typeof body.destroy === 'function'\n  )\n}\n\nconst abortRequestAndDestroyStream = ({\n  abortController,\n  object,\n}: {\n  abortController: AbortController\n  object?: AWS.GetObjectOutput\n}) => {\n  try {\n    abortController.abort()\n  } catch {\n    /* noop */\n  }\n  if (object?.Body && isNodeReadableStream(object.Body)) {\n    object.Body.destroy()\n  }\n}\n\nexport async function getFile({\n  bucket,\n  client,\n  collection,\n  collectionPrefix = '',\n  doc,\n  filename,\n  incomingHeaders,\n  operation = 'read',\n  req,\n  signedDownloads,\n  uploadReference,\n  useCompositePrefixes = false,\n}: GetFileArgs): Promise<Response> {\n  const isTransformSource = operation === 'transform'\n  let object: AWS.GetObjectOutput | undefined = undefined\n  let streamed = false\n\n  const abortController = new AbortController()\n  if (req.signal) {\n    req.signal.addEventListener('abort', () => {\n      abortRequestAndDestroyStream({ abortController, object })\n    })\n  }\n\n  try {\n    const docPrefix = await getDocPrefix({\n      collection,\n      collectionPrefix,\n      doc,\n      filename,\n      req,\n      uploadReference,\n      useCompositePrefixes,\n    })\n\n    const { storageFilePath } = buildStoragePathData({\n      collectionPrefix,\n      docPrefix,\n      filename,\n      useCompositePrefixes,\n    })\n\n    if (signedDownloads && !uploadReference && !isTransformSource) {\n      let useSignedURL = true\n      if (\n        typeof signedDownloads === 'object' &&\n        typeof signedDownloads.shouldUseSignedURL === 'function'\n      ) {\n        useSignedURL = await signedDownloads.shouldUseSignedURL({ collection, filename, req })\n      }\n\n      if (useSignedURL) {\n        const command = new GetObjectCommand({ Bucket: bucket, Key: storageFilePath })\n        const signedUrl = await getSignedUrl(\n          client,\n          command,\n          typeof signedDownloads === 'object' ? signedDownloads : { expiresIn: 7200 },\n        )\n        return Response.redirect(signedUrl, 302)\n      }\n    }\n\n    const headObject = await client.headObject({\n      Bucket: bucket,\n      Key: storageFilePath,\n    })\n    const fileSize = headObject.ContentLength\n\n    if (!fileSize) {\n      return new Response('Internal Server Error', { status: 500 })\n    }\n\n    const rangeHeader = isTransformSource ? null : req.headers.get('range')\n    const rangeResult = getRangeRequestInfo({ fileSize, rangeHeader })\n\n    if (rangeResult.type === 'invalid') {\n      return new Response(null, {\n        headers: new Headers(rangeResult.headers),\n        status: rangeResult.status,\n      })\n    }\n\n    const rangeForS3 =\n      rangeResult.type === 'partial'\n        ? `bytes=${rangeResult.rangeStart}-${rangeResult.rangeEnd}`\n        : undefined\n\n    let headers = new Headers(incomingHeaders)\n\n    for (const [headerKey, value] of Object.entries(rangeResult.headers)) {\n      headers.append(headerKey, value)\n    }\n\n    headers.append('Content-Type', String(headObject.ContentType))\n    if (headObject.ETag) {\n      headers.append('ETag', headObject.ETag)\n    }\n\n    // Apply a restrictive policy to XML-family responses served through Payload.\n    if (isXmlMimeType(headObject.ContentType)) {\n      headers.append('Content-Security-Policy', uploadContentSecurityPolicy)\n    }\n\n    const etagFromHeaders = req.headers.get('etag') || req.headers.get('if-none-match')\n    const objectEtag = headObject.ETag\n\n    if (\n      !isTransformSource &&\n      collection.upload &&\n      typeof collection.upload === 'object' &&\n      typeof collection.upload.modifyResponseHeaders === 'function'\n    ) {\n      headers = collection.upload.modifyResponseHeaders({ headers }) || headers\n    }\n\n    if (!isTransformSource && etagFromHeaders && etagFromHeaders === objectEtag) {\n      return new Response(null, {\n        headers,\n        status: 304,\n      })\n    }\n\n    object = await client.getObject(\n      {\n        Bucket: bucket,\n        Key: storageFilePath,\n        Range: rangeForS3,\n      },\n      { abortSignal: abortController.signal },\n    )\n\n    if (!object.Body) {\n      return new Response(null, { status: 404, statusText: 'Not Found' })\n    }\n\n    if (!isNodeReadableStream(object.Body)) {\n      req.payload.logger.error({\n        key: storageFilePath,\n        msg: 'S3 object body is not a readable stream',\n      })\n      return new Response('Internal Server Error', { status: 500 })\n    }\n\n    const stream = object.Body\n    stream.on('error', (err: Error) => {\n      req.payload.logger.error({\n        err,\n        key: storageFilePath,\n        msg: 'Error while streaming S3 object (aborting)',\n      })\n      abortRequestAndDestroyStream({ abortController, object })\n    })\n\n    streamed = true\n    return new Response(stream, { headers, status: rangeResult.status })\n  } catch (err) {\n    if (\n      err &&\n      typeof err === 'object' &&\n      (('name' in err && (err.name === 'NoSuchKey' || err.name === 'NotFound')) ||\n        ('httpStatusCode' in err && err.httpStatusCode === 404))\n    ) {\n      return new Response(null, { status: 404, statusText: 'Not Found' })\n    }\n    req.payload.logger.error(err)\n    return new Response('Internal Server Error', { status: 500 })\n  } finally {\n    if (!streamed) {\n      abortRequestAndDestroyStream({ abortController, object })\n    }\n  }\n}\n"],"names":["GetObjectCommand","getSignedUrl","buildStoragePathData","getFilePrefix","getDocPrefix","getRangeRequestInfo","isXmlMimeType","uploadContentSecurityPolicy","isNodeReadableStream","body","pipe","destroy","abortRequestAndDestroyStream","abortController","object","abort","Body","getFile","bucket","client","collection","collectionPrefix","doc","filename","incomingHeaders","operation","req","signedDownloads","uploadReference","useCompositePrefixes","isTransformSource","undefined","streamed","AbortController","signal","addEventListener","docPrefix","storageFilePath","useSignedURL","shouldUseSignedURL","command","Bucket","Key","signedUrl","expiresIn","Response","redirect","headObject","fileSize","ContentLength","status","rangeHeader","headers","get","rangeResult","type","Headers","rangeForS3","rangeStart","rangeEnd","headerKey","value","Object","entries","append","String","ContentType","ETag","etagFromHeaders","objectEtag","upload","modifyResponseHeaders","getObject","Range","abortSignal","statusText","payload","logger","error","key","msg","stream","on","err","name","httpStatusCode"],"mappings":"AAIA,SAASA,gBAAgB,QAAQ,qBAAoB;AACrD,SAASC,YAAY,QAAQ,gCAA+B;AAC5D,SACEC,oBAAoB,EACpBC,iBAAiBC,YAAY,QACxB,6CAA4C;AACnD,SAASC,mBAAmB,EAAEC,aAAa,EAAEC,2BAA2B,QAAQ,mBAAkB;AA6BlG,MAAMC,uBAAuB,CAACC;IAC5B,OACE,OAAOA,SAAS,YAChBA,SAAS,QACT,UAAUA,QACV,OAAOA,KAAKC,IAAI,KAAK,cACrB,aAAaD,QACb,OAAOA,KAAKE,OAAO,KAAK;AAE5B;AAEA,MAAMC,+BAA+B,CAAC,EACpCC,eAAe,EACfC,MAAM,EAIP;IACC,IAAI;QACFD,gBAAgBE,KAAK;IACvB,EAAE,OAAM;IACN,QAAQ,GACV;IACA,IAAID,QAAQE,QAAQR,qBAAqBM,OAAOE,IAAI,GAAG;QACrDF,OAAOE,IAAI,CAACL,OAAO;IACrB;AACF;AAEA,OAAO,eAAeM,QAAQ,EAC5BC,MAAM,EACNC,MAAM,EACNC,UAAU,EACVC,mBAAmB,EAAE,EACrBC,GAAG,EACHC,QAAQ,EACRC,eAAe,EACfC,YAAY,MAAM,EAClBC,GAAG,EACHC,eAAe,EACfC,eAAe,EACfC,uBAAuB,KAAK,EAChB;IACZ,MAAMC,oBAAoBL,cAAc;IACxC,IAAIX,SAA0CiB;IAC9C,IAAIC,WAAW;IAEf,MAAMnB,kBAAkB,IAAIoB;IAC5B,IAAIP,IAAIQ,MAAM,EAAE;QACdR,IAAIQ,MAAM,CAACC,gBAAgB,CAAC,SAAS;YACnCvB,6BAA6B;gBAAEC;gBAAiBC;YAAO;QACzD;IACF;IAEA,IAAI;QACF,MAAMsB,YAAY,MAAMhC,aAAa;YACnCgB;YACAC;YACAC;YACAC;YACAG;YACAE;YACAC;QACF;QAEA,MAAM,EAAEQ,eAAe,EAAE,GAAGnC,qBAAqB;YAC/CmB;YACAe;YACAb;YACAM;QACF;QAEA,IAAIF,mBAAmB,CAACC,mBAAmB,CAACE,mBAAmB;YAC7D,IAAIQ,eAAe;YACnB,IACE,OAAOX,oBAAoB,YAC3B,OAAOA,gBAAgBY,kBAAkB,KAAK,YAC9C;gBACAD,eAAe,MAAMX,gBAAgBY,kBAAkB,CAAC;oBAAEnB;oBAAYG;oBAAUG;gBAAI;YACtF;YAEA,IAAIY,cAAc;gBAChB,MAAME,UAAU,IAAIxC,iBAAiB;oBAAEyC,QAAQvB;oBAAQwB,KAAKL;gBAAgB;gBAC5E,MAAMM,YAAY,MAAM1C,aACtBkB,QACAqB,SACA,OAAOb,oBAAoB,WAAWA,kBAAkB;oBAAEiB,WAAW;gBAAK;gBAE5E,OAAOC,SAASC,QAAQ,CAACH,WAAW;YACtC;QACF;QAEA,MAAMI,aAAa,MAAM5B,OAAO4B,UAAU,CAAC;YACzCN,QAAQvB;YACRwB,KAAKL;QACP;QACA,MAAMW,WAAWD,WAAWE,aAAa;QAEzC,IAAI,CAACD,UAAU;YACb,OAAO,IAAIH,SAAS,yBAAyB;gBAAEK,QAAQ;YAAI;QAC7D;QAEA,MAAMC,cAAcrB,oBAAoB,OAAOJ,IAAI0B,OAAO,CAACC,GAAG,CAAC;QAC/D,MAAMC,cAAcjD,oBAAoB;YAAE2C;YAAUG;QAAY;QAEhE,IAAIG,YAAYC,IAAI,KAAK,WAAW;YAClC,OAAO,IAAIV,SAAS,MAAM;gBACxBO,SAAS,IAAII,QAAQF,YAAYF,OAAO;gBACxCF,QAAQI,YAAYJ,MAAM;YAC5B;QACF;QAEA,MAAMO,aACJH,YAAYC,IAAI,KAAK,YACjB,CAAC,MAAM,EAAED,YAAYI,UAAU,CAAC,CAAC,EAAEJ,YAAYK,QAAQ,EAAE,GACzD5B;QAEN,IAAIqB,UAAU,IAAII,QAAQhC;QAE1B,KAAK,MAAM,CAACoC,WAAWC,MAAM,IAAIC,OAAOC,OAAO,CAACT,YAAYF,OAAO,EAAG;YACpEA,QAAQY,MAAM,CAACJ,WAAWC;QAC5B;QAEAT,QAAQY,MAAM,CAAC,gBAAgBC,OAAOlB,WAAWmB,WAAW;QAC5D,IAAInB,WAAWoB,IAAI,EAAE;YACnBf,QAAQY,MAAM,CAAC,QAAQjB,WAAWoB,IAAI;QACxC;QAEA,6EAA6E;QAC7E,IAAI7D,cAAcyC,WAAWmB,WAAW,GAAG;YACzCd,QAAQY,MAAM,CAAC,2BAA2BzD;QAC5C;QAEA,MAAM6D,kBAAkB1C,IAAI0B,OAAO,CAACC,GAAG,CAAC,WAAW3B,IAAI0B,OAAO,CAACC,GAAG,CAAC;QACnE,MAAMgB,aAAatB,WAAWoB,IAAI;QAElC,IACE,CAACrC,qBACDV,WAAWkD,MAAM,IACjB,OAAOlD,WAAWkD,MAAM,KAAK,YAC7B,OAAOlD,WAAWkD,MAAM,CAACC,qBAAqB,KAAK,YACnD;YACAnB,UAAUhC,WAAWkD,MAAM,CAACC,qBAAqB,CAAC;gBAAEnB;YAAQ,MAAMA;QACpE;QAEA,IAAI,CAACtB,qBAAqBsC,mBAAmBA,oBAAoBC,YAAY;YAC3E,OAAO,IAAIxB,SAAS,MAAM;gBACxBO;gBACAF,QAAQ;YACV;QACF;QAEApC,SAAS,MAAMK,OAAOqD,SAAS,CAC7B;YACE/B,QAAQvB;YACRwB,KAAKL;YACLoC,OAAOhB;QACT,GACA;YAAEiB,aAAa7D,gBAAgBqB,MAAM;QAAC;QAGxC,IAAI,CAACpB,OAAOE,IAAI,EAAE;YAChB,OAAO,IAAI6B,SAAS,MAAM;gBAAEK,QAAQ;gBAAKyB,YAAY;YAAY;QACnE;QAEA,IAAI,CAACnE,qBAAqBM,OAAOE,IAAI,GAAG;YACtCU,IAAIkD,OAAO,CAACC,MAAM,CAACC,KAAK,CAAC;gBACvBC,KAAK1C;gBACL2C,KAAK;YACP;YACA,OAAO,IAAInC,SAAS,yBAAyB;gBAAEK,QAAQ;YAAI;QAC7D;QAEA,MAAM+B,SAASnE,OAAOE,IAAI;QAC1BiE,OAAOC,EAAE,CAAC,SAAS,CAACC;YAClBzD,IAAIkD,OAAO,CAACC,MAAM,CAACC,KAAK,CAAC;gBACvBK;gBACAJ,KAAK1C;gBACL2C,KAAK;YACP;YACApE,6BAA6B;gBAAEC;gBAAiBC;YAAO;QACzD;QAEAkB,WAAW;QACX,OAAO,IAAIa,SAASoC,QAAQ;YAAE7B;YAASF,QAAQI,YAAYJ,MAAM;QAAC;IACpE,EAAE,OAAOiC,KAAK;QACZ,IACEA,OACA,OAAOA,QAAQ,YACd,CAAA,AAAC,UAAUA,OAAQA,CAAAA,IAAIC,IAAI,KAAK,eAAeD,IAAIC,IAAI,KAAK,UAAS,KACnE,oBAAoBD,OAAOA,IAAIE,cAAc,KAAK,GAAG,GACxD;YACA,OAAO,IAAIxC,SAAS,MAAM;gBAAEK,QAAQ;gBAAKyB,YAAY;YAAY;QACnE;QACAjD,IAAIkD,OAAO,CAACC,MAAM,CAACC,KAAK,CAACK;QACzB,OAAO,IAAItC,SAAS,yBAAyB;YAAEK,QAAQ;QAAI;IAC7D,SAAU;QACR,IAAI,CAAClB,UAAU;YACbpB,6BAA6B;gBAAEC;gBAAiBC;YAAO;QACzD;IACF;AACF"}

package/dist/index.d.ts

@@ -1,22 +1,12 @@
+import type { S3ClientConfig } from '@aws-sdk/client-s3';
 import type { ClientUploadsConfig, CollectionOptions } from '@payloadcms/plugin-cloud-storage/types';
-import type { Plugin, UploadCollectionSlug } from 'payload';
-import * as AWS from '@aws-sdk/client-s3';
+import type { StorageAdapter, UploadCollectionSlug } from 'payload';
 import type { SignedDownloadsConfig } from './getFile.js';
 export type S3StorageOptions = {
     /**
      * Access control list for uploaded files.
      */
     acl?: 'private' | 'public-read';
-    /**
-     * When enabled, fields (like the prefix field) will always be inserted into
-     * the collection schema regardless of whether the plugin is enabled. This
-     * ensures a consistent schema across all environments.
-     *
-     * This will be enabled by default in Payload v4.
-     *
-     * @default false
-     */
-    alwaysInsertFields?: boolean;
     /**
      * Bucket name to upload files to.
      *
@@ -31,7 +21,7 @@ export type S3StorageOptions = {
      */
     clientCacheKey?: string;
     /**
-     * Do uploads directly on the client to bypass limits on Vercel. You must allow CORS PUT method for the bucket to your website.
+     * Upload directly to S3 instead of through Payload. You must allow CORS PUT requests from your website.
      */
     clientUploads?: ClientUploadsConfig;
     /**
@@ -45,7 +35,7 @@ export type S3StorageOptions = {
      *
      * [AWS.S3ClientConfig Docs](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-s3/interfaces/s3clientconfig.html)
      */
-    config: AWS.S3ClientConfig;
+    config: S3ClientConfig;
     /**
      * Whether or not to disable local storage
      *
@@ -64,20 +54,21 @@ export type S3StorageOptions = {
     signedDownloads?: SignedDownloadsConfig;
     /**
      * When true, the collection-level prefix and document-level prefix are combined
-     * (compositional). When false (default), document prefix overrides collection
-     * prefix entirely.
+     * (compositional). When false (default), a document prefix already within the
+     * collection prefix is used as-is for new uploads; otherwise it is nested beneath it.
+     * Existing files retain their stored prefixes for reads, URLs, and cleanup.
      *
-     * Example:
-     * - collection prefix: `collection-prefix/`
-     * - document prefix: `document-prefix/`
-     * - resulting prefix with useCompositePrefixes=true: `collection-prefix/document-prefix/`
-     * - resulting prefix with useCompositePrefixes=false: `document-prefix/`
+     * Example with a document prefix already contained by the collection prefix:
+     * - collection prefix: `uploads/`
+     * - document prefix: `uploads/documents/`
+     * - resulting prefix with useCompositePrefixes=true: `uploads/uploads/documents/`
+     * - resulting prefix with useCompositePrefixes=false: `uploads/documents/`
      *
      * @default false
      */
     useCompositePrefixes?: boolean;
 };
-type S3StoragePlugin = (storageS3Args: S3StorageOptions) => Plugin;
-export declare const s3Storage: S3StoragePlugin;
+type S3StorageFactory = (storageS3Args: S3StorageOptions) => StorageAdapter;
+export declare const s3Storage: S3StorageFactory;
 export {};
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,mBAAmB,EAEnB,iBAAiB,EAClB,MAAM,wCAAwC,CAAA;AAE/C,OAAO,KAAK,EAAU,MAAM,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAEnE,OAAO,KAAK,GAAG,MAAM,oBAAoB,CAAA;AAIzC,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAA;AAKzD,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,GAAG,CAAC,EAAE,SAAS,GAAG,aAAa,CAAA;IAE/B;;;;;;;;OAQG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAE5B;;;;OAIG;IAEH,MAAM,EAAE,MAAM,CAAA;IAEd;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,mBAAmB,CAAA;IACnC;;OAEG;IACH,WAAW,EAAE,OAAO,CAClB,MAAM,CACJ,oBAAoB,EAClB,CAAC;QACC,eAAe,CAAC,EAAE,qBAAqB,CAAA;KACxC,GAAG,IAAI,CAAC,iBAAiB,EAAE,SAAS,CAAC,CAAC,GACvC,IAAI,CACP,CACF,CAAA;IACD;;;;OAIG;IACH,MAAM,EAAE,GAAG,CAAC,cAAc,CAAA;IAE1B;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAE7B;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;OAEG;IACH,eAAe,CAAC,EAAE,qBAAqB,CAAA;IACvC;;;;;;;;;;;;OAYG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B,CAAA;AAED,KAAK,eAAe,GAAG,CAAC,aAAa,EAAE,gBAAgB,KAAK,MAAM,CAAA;AAelE,eAAO,MAAM,SAAS,EAAE,eAmIrB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AACxD,OAAO,KAAK,EACV,mBAAmB,EAEnB,iBAAiB,EAClB,MAAM,wCAAwC,CAAA;AAE/C,OAAO,KAAK,EAAU,cAAc,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAK3E,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAA;AAIzD,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,GAAG,CAAC,EAAE,SAAS,GAAG,aAAa,CAAA;IAE/B;;;;OAIG;IAEH,MAAM,EAAE,MAAM,CAAA;IAEd;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,mBAAmB,CAAA;IACnC;;OAEG;IACH,WAAW,EAAE,OAAO,CAClB,MAAM,CACJ,oBAAoB,EAClB,CAAC;QACC,eAAe,CAAC,EAAE,qBAAqB,CAAA;KACxC,GAAG,IAAI,CAAC,iBAAiB,EAAE,SAAS,CAAC,CAAC,GACvC,IAAI,CACP,CACF,CAAA;IACD;;;;OAIG;IACH,MAAM,EAAE,cAAc,CAAA;IAEtB;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAE7B;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;OAEG;IACH,eAAe,CAAC,EAAE,qBAAqB,CAAA;IACvC;;;;;;;;;;;;;OAaG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B,CAAA;AAED,KAAK,gBAAgB,GAAG,CAAC,aAAa,EAAE,gBAAgB,KAAK,cAAc,CAAA;AAe3E,eAAO,MAAM,SAAS,EAAE,gBA8GtB,CAAA"}

package/dist/index.js

@@ -1,8 +1,6 @@
-import * as AWS from '@aws-sdk/client-s3';
+import { S3 } from '@aws-sdk/client-s3';
 import { cloudStoragePlugin } from '@payloadcms/plugin-cloud-storage';
-import { initClientUploads } from '@payloadcms/plugin-cloud-storage/utilities';
 import { createS3Adapter } from './adapter.js';
-import { getGenerateSignedURLHandler } from './generateSignedURL.js';
 const s3Clients = new Map();
 const defaultRequestHandlerOpts = {
     httpAgent: {
@@ -14,38 +12,25 @@ const defaultRequestHandlerOpts = {
         maxSockets: 100
     }
 };
-export const s3Storage = (s3StorageOptions)=>(incomingConfig)=>{
-        const cacheKey = s3StorageOptions.clientCacheKey || `s3:${s3StorageOptions.bucket}`;
-        const getStorageClient = ()=>{
-            if (s3Clients.has(cacheKey)) {
+export const s3Storage = (s3StorageOptions)=>({
+        name: 's3',
+        collections: Object.keys(s3StorageOptions.collections),
+        init: (incomingConfig)=>{
+            const cacheKey = s3StorageOptions.clientCacheKey || `s3:${s3StorageOptions.bucket}`;
+            const isPluginDisabled = s3StorageOptions.enabled === false;
+            const getStorageClient = ()=>{
+                if (s3Clients.has(cacheKey)) {
+                    return s3Clients.get(cacheKey);
+                }
+                s3Clients.set(cacheKey, new S3({
+                    requestHandler: defaultRequestHandlerOpts,
+                    ...s3StorageOptions.config ?? {}
+                }));
                 return s3Clients.get(cacheKey);
-            }
-            s3Clients.set(cacheKey, new AWS.S3({
-                requestHandler: defaultRequestHandlerOpts,
-                ...s3StorageOptions.config ?? {}
-            }));
-            return s3Clients.get(cacheKey);
-        };
-        const isPluginDisabled = s3StorageOptions.enabled === false;
-        initClientUploads({
-            clientHandler: '@payloadcms/storage-s3/client#S3ClientUploadHandler',
-            collections: s3StorageOptions.collections,
-            config: incomingConfig,
-            enabled: !isPluginDisabled && Boolean(s3StorageOptions.clientUploads),
-            serverHandler: getGenerateSignedURLHandler({
-                access: typeof s3StorageOptions.clientUploads === 'object' ? s3StorageOptions.clientUploads.access : undefined,
-                acl: s3StorageOptions.acl,
-                bucket: s3StorageOptions.bucket,
-                collections: s3StorageOptions.collections,
-                getStorageClient,
-                useCompositePrefixes: s3StorageOptions.useCompositePrefixes
-            }),
-            serverHandlerPath: '/storage-s3-generate-signed-url'
-        });
-        if (isPluginDisabled) {
-            // If alwaysInsertFields is true, still call cloudStoragePlugin to insert fields
-            if (s3StorageOptions.alwaysInsertFields) {
-                // Build collections with adapter: null since plugin is disabled
+            };
+            if (isPluginDisabled) {
+                // Still call cloudStoragePlugin with adapter: null so fields (like prefix) are
+                // inserted into the schema, keeping it consistent across environments.
                 const collectionsWithoutAdapter = Object.entries(s3StorageOptions.collections).reduce((acc, [slug, collOptions])=>({
                         ...acc,
                         [slug]: {
@@ -54,60 +39,57 @@ export const s3Storage = (s3StorageOptions)=>(incomingConfig)=>{
                         }
                     }), {});
                 return cloudStoragePlugin({
-                    alwaysInsertFields: true,
                     collections: collectionsWithoutAdapter,
                     enabled: false,
                     useCompositePrefixes: s3StorageOptions.useCompositePrefixes
                 })(incomingConfig);
             }
-            return incomingConfig;
-        }
-        // Determine signedDownloads for this collection
-        const resolveSignedDownloads = (slug)=>{
-            const collectionStorageConfig = s3StorageOptions.collections[slug];
-            let signedDownloads = typeof collectionStorageConfig === 'object' ? collectionStorageConfig.signedDownloads ?? false : null;
-            if (signedDownloads === null) {
-                signedDownloads = s3StorageOptions.signedDownloads ?? false;
-            }
-            return signedDownloads;
-        };
-        // Add adapter to each collection option object
-        const collectionsWithAdapter = Object.entries(s3StorageOptions.collections).reduce((acc, [slug, collOptions])=>({
-                ...acc,
-                [slug]: {
-                    ...collOptions === true ? {} : collOptions,
-                    adapter: createS3Adapter({
-                        acl: s3StorageOptions.acl,
-                        bucket: s3StorageOptions.bucket,
-                        clientUploads: s3StorageOptions.clientUploads,
-                        config: s3StorageOptions.config,
-                        getStorageClient,
-                        signedDownloads: resolveSignedDownloads(slug),
-                        useCompositePrefixes: s3StorageOptions.useCompositePrefixes
-                    })
+            // Determine signedDownloads for this collection
+            const resolveSignedDownloads = (slug)=>{
+                const collectionStorageConfig = s3StorageOptions.collections[slug];
+                let signedDownloads = typeof collectionStorageConfig === 'object' ? collectionStorageConfig.signedDownloads ?? false : null;
+                if (signedDownloads === null) {
+                    signedDownloads = s3StorageOptions.signedDownloads ?? false;
                 }
-            }), {});
-        // Set disableLocalStorage: true for collections specified in the plugin options
-        const config = {
-            ...incomingConfig,
-            collections: (incomingConfig.collections || []).map((collection)=>{
-                if (!collectionsWithAdapter[collection.slug]) {
-                    return collection;
-                }
-                return {
-                    ...collection,
-                    upload: {
-                        ...typeof collection.upload === 'object' ? collection.upload : {},
-                        disableLocalStorage: true
+                return signedDownloads;
+            };
+            // Add adapter to each collection option object
+            const collectionsWithAdapter = Object.entries(s3StorageOptions.collections).reduce((acc, [slug, collOptions])=>({
+                    ...acc,
+                    [slug]: {
+                        ...collOptions === true ? {} : collOptions,
+                        adapter: createS3Adapter({
+                            acl: s3StorageOptions.acl,
+                            bucket: s3StorageOptions.bucket,
+                            clientUploads: s3StorageOptions.clientUploads,
+                            config: s3StorageOptions.config,
+                            getStorageClient,
+                            signedDownloads: resolveSignedDownloads(slug),
+                            useCompositePrefixes: s3StorageOptions.useCompositePrefixes
+                        })
+                    }
+                }), {});
+            // Set disableLocalStorage: true for collections specified in the plugin options
+            const config = {
+                ...incomingConfig,
+                collections: (incomingConfig.collections || []).map((collection)=>{
+                    if (!collectionsWithAdapter[collection.slug]) {
+                        return collection;
                     }
-                };
-            })
-        };
-        return cloudStoragePlugin({
-            alwaysInsertFields: s3StorageOptions.alwaysInsertFields,
-            collections: collectionsWithAdapter,
-            useCompositePrefixes: s3StorageOptions.useCompositePrefixes
-        })(config);
-    };
+                    return {
+                        ...collection,
+                        upload: {
+                            ...typeof collection.upload === 'object' ? collection.upload : {},
+                            disableLocalStorage: true
+                        }
+                    };
+                })
+            };
+            return cloudStoragePlugin({
+                collections: collectionsWithAdapter,
+                useCompositePrefixes: s3StorageOptions.useCompositePrefixes
+            })(config);
+        }
+    });
 
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type {\n  ClientUploadsConfig,\n  PluginOptions as CloudStoragePluginOptions,\n  CollectionOptions,\n} from '@payloadcms/plugin-cloud-storage/types'\nimport type { NodeHttpHandlerOptions } from '@smithy/node-http-handler'\nimport type { Config, Plugin, UploadCollectionSlug } from 'payload'\n\nimport * as AWS from '@aws-sdk/client-s3'\nimport { cloudStoragePlugin } from '@payloadcms/plugin-cloud-storage'\nimport { initClientUploads } from '@payloadcms/plugin-cloud-storage/utilities'\n\nimport type { SignedDownloadsConfig } from './getFile.js'\n\nimport { createS3Adapter } from './adapter.js'\nimport { getGenerateSignedURLHandler } from './generateSignedURL.js'\n\nexport type S3StorageOptions = {\n  /**\n   * Access control list for uploaded files.\n   */\n  acl?: 'private' | 'public-read'\n\n  /**\n   * When enabled, fields (like the prefix field) will always be inserted into\n   * the collection schema regardless of whether the plugin is enabled. This\n   * ensures a consistent schema across all environments.\n   *\n   * This will be enabled by default in Payload v4.\n   *\n   * @default false\n   */\n  alwaysInsertFields?: boolean\n\n  /**\n   * Bucket name to upload files to.\n   *\n   * Must follow [AWS S3 bucket naming conventions](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html).\n   */\n\n  bucket: string\n\n  /**\n   * Optional cache key to identify the S3 storage client instance.\n   * If not provided, a default key will be used.\n   *\n   * @default `s3:containerName`\n   */\n  clientCacheKey?: string\n\n  /**\n   * Do uploads directly on the client to bypass limits on Vercel. You must allow CORS PUT method for the bucket to your website.\n   */\n  clientUploads?: ClientUploadsConfig\n  /**\n   * Collection options to apply the S3 adapter to.\n   */\n  collections: Partial<\n    Record<\n      UploadCollectionSlug,\n      | ({\n          signedDownloads?: SignedDownloadsConfig\n        } & Omit<CollectionOptions, 'adapter'>)\n      | true\n    >\n  >\n  /**\n   * AWS S3 client configuration. Highly dependent on your AWS setup.\n   *\n   * [AWS.S3ClientConfig Docs](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-s3/interfaces/s3clientconfig.html)\n   */\n  config: AWS.S3ClientConfig\n\n  /**\n   * Whether or not to disable local storage\n   *\n   * @default true\n   */\n  disableLocalStorage?: boolean\n\n  /**\n   * Whether or not to enable the plugin\n   *\n   * Default: true\n   */\n  enabled?: boolean\n  /**\n   * Use pre-signed URLs for files downloading. Can be overriden per-collection.\n   */\n  signedDownloads?: SignedDownloadsConfig\n  /**\n   * When true, the collection-level prefix and document-level prefix are combined\n   * (compositional). When false (default), document prefix overrides collection\n   * prefix entirely.\n   *\n   * Example:\n   * - collection prefix: `collection-prefix/`\n   * - document prefix: `document-prefix/`\n   * - resulting prefix with useCompositePrefixes=true: `collection-prefix/document-prefix/`\n   * - resulting prefix with useCompositePrefixes=false: `document-prefix/`\n   *\n   * @default false\n   */\n  useCompositePrefixes?: boolean\n}\n\ntype S3StoragePlugin = (storageS3Args: S3StorageOptions) => Plugin\n\nconst s3Clients = new Map<string, AWS.S3>()\n\nconst defaultRequestHandlerOpts: NodeHttpHandlerOptions = {\n  httpAgent: {\n    keepAlive: true,\n    maxSockets: 100,\n  },\n  httpsAgent: {\n    keepAlive: true,\n    maxSockets: 100,\n  },\n}\n\nexport const s3Storage: S3StoragePlugin =\n  (s3StorageOptions: S3StorageOptions) =>\n  (incomingConfig: Config): Config => {\n    const cacheKey = s3StorageOptions.clientCacheKey || `s3:${s3StorageOptions.bucket}`\n\n    const getStorageClient: () => AWS.S3 = () => {\n      if (s3Clients.has(cacheKey)) {\n        return s3Clients.get(cacheKey)!\n      }\n\n      s3Clients.set(\n        cacheKey,\n        new AWS.S3({\n          requestHandler: defaultRequestHandlerOpts,\n          ...(s3StorageOptions.config ?? {}),\n        }),\n      )\n\n      return s3Clients.get(cacheKey)!\n    }\n\n    const isPluginDisabled = s3StorageOptions.enabled === false\n\n    initClientUploads({\n      clientHandler: '@payloadcms/storage-s3/client#S3ClientUploadHandler',\n      collections: s3StorageOptions.collections,\n      config: incomingConfig,\n      enabled: !isPluginDisabled && Boolean(s3StorageOptions.clientUploads),\n      serverHandler: getGenerateSignedURLHandler({\n        access:\n          typeof s3StorageOptions.clientUploads === 'object'\n            ? s3StorageOptions.clientUploads.access\n            : undefined,\n        acl: s3StorageOptions.acl,\n        bucket: s3StorageOptions.bucket,\n        collections: s3StorageOptions.collections,\n        getStorageClient,\n        useCompositePrefixes: s3StorageOptions.useCompositePrefixes,\n      }),\n      serverHandlerPath: '/storage-s3-generate-signed-url',\n    })\n\n    if (isPluginDisabled) {\n      // If alwaysInsertFields is true, still call cloudStoragePlugin to insert fields\n      if (s3StorageOptions.alwaysInsertFields) {\n        // Build collections with adapter: null since plugin is disabled\n        const collectionsWithoutAdapter: CloudStoragePluginOptions['collections'] = Object.entries(\n          s3StorageOptions.collections,\n        ).reduce(\n          (acc, [slug, collOptions]) => ({\n            ...acc,\n            [slug]: {\n              ...(collOptions === true ? {} : collOptions),\n              adapter: null,\n            },\n          }),\n          {} as Record<string, CollectionOptions>,\n        )\n\n        return cloudStoragePlugin({\n          alwaysInsertFields: true,\n          collections: collectionsWithoutAdapter,\n          enabled: false,\n          useCompositePrefixes: s3StorageOptions.useCompositePrefixes,\n        })(incomingConfig)\n      }\n\n      return incomingConfig\n    }\n\n    // Determine signedDownloads for this collection\n    const resolveSignedDownloads = (slug: string): SignedDownloadsConfig => {\n      const collectionStorageConfig = s3StorageOptions.collections[slug]\n\n      let signedDownloads: null | SignedDownloadsConfig =\n        typeof collectionStorageConfig === 'object'\n          ? (collectionStorageConfig.signedDownloads ?? false)\n          : null\n\n      if (signedDownloads === null) {\n        signedDownloads = s3StorageOptions.signedDownloads ?? false\n      }\n\n      return signedDownloads\n    }\n\n    // Add adapter to each collection option object\n    const collectionsWithAdapter: CloudStoragePluginOptions['collections'] = Object.entries(\n      s3StorageOptions.collections,\n    ).reduce(\n      (acc, [slug, collOptions]) => ({\n        ...acc,\n        [slug]: {\n          ...(collOptions === true ? {} : collOptions),\n          adapter: createS3Adapter({\n            acl: s3StorageOptions.acl,\n            bucket: s3StorageOptions.bucket,\n            clientUploads: s3StorageOptions.clientUploads,\n            config: s3StorageOptions.config,\n            getStorageClient,\n            signedDownloads: resolveSignedDownloads(slug),\n            useCompositePrefixes: s3StorageOptions.useCompositePrefixes,\n          }),\n        },\n      }),\n      {} as Record<string, CollectionOptions>,\n    )\n\n    // Set disableLocalStorage: true for collections specified in the plugin options\n    const config = {\n      ...incomingConfig,\n      collections: (incomingConfig.collections || []).map((collection) => {\n        if (!collectionsWithAdapter[collection.slug]) {\n          return collection\n        }\n\n        return {\n          ...collection,\n          upload: {\n            ...(typeof collection.upload === 'object' ? collection.upload : {}),\n            disableLocalStorage: true,\n          },\n        }\n      }),\n    }\n\n    return cloudStoragePlugin({\n      alwaysInsertFields: s3StorageOptions.alwaysInsertFields,\n      collections: collectionsWithAdapter,\n      useCompositePrefixes: s3StorageOptions.useCompositePrefixes,\n    })(config)\n  }\n"],"names":["AWS","cloudStoragePlugin","initClientUploads","createS3Adapter","getGenerateSignedURLHandler","s3Clients","Map","defaultRequestHandlerOpts","httpAgent","keepAlive","maxSockets","httpsAgent","s3Storage","s3StorageOptions","incomingConfig","cacheKey","clientCacheKey","bucket","getStorageClient","has","get","set","S3","requestHandler","config","isPluginDisabled","enabled","clientHandler","collections","Boolean","clientUploads","serverHandler","access","undefined","acl","useCompositePrefixes","serverHandlerPath","alwaysInsertFields","collectionsWithoutAdapter","Object","entries","reduce","acc","slug","collOptions","adapter","resolveSignedDownloads","collectionStorageConfig","signedDownloads","collectionsWithAdapter","map","collection","upload","disableLocalStorage"],"mappings":"AAQA,YAAYA,SAAS,qBAAoB;AACzC,SAASC,kBAAkB,QAAQ,mCAAkC;AACrE,SAASC,iBAAiB,QAAQ,6CAA4C;AAI9E,SAASC,eAAe,QAAQ,eAAc;AAC9C,SAASC,2BAA2B,QAAQ,yBAAwB;AA6FpE,MAAMC,YAAY,IAAIC;AAEtB,MAAMC,4BAAoD;IACxDC,WAAW;QACTC,WAAW;QACXC,YAAY;IACd;IACAC,YAAY;QACVF,WAAW;QACXC,YAAY;IACd;AACF;AAEA,OAAO,MAAME,YACX,CAACC,mBACD,CAACC;QACC,MAAMC,WAAWF,iBAAiBG,cAAc,IAAI,CAAC,GAAG,EAAEH,iBAAiBI,MAAM,EAAE;QAEnF,MAAMC,mBAAiC;YACrC,IAAIb,UAAUc,GAAG,CAACJ,WAAW;gBAC3B,OAAOV,UAAUe,GAAG,CAACL;YACvB;YAEAV,UAAUgB,GAAG,CACXN,UACA,IAAIf,IAAIsB,EAAE,CAAC;gBACTC,gBAAgBhB;gBAChB,GAAIM,iBAAiBW,MAAM,IAAI,CAAC,CAAC;YACnC;YAGF,OAAOnB,UAAUe,GAAG,CAACL;QACvB;QAEA,MAAMU,mBAAmBZ,iBAAiBa,OAAO,KAAK;QAEtDxB,kBAAkB;YAChByB,eAAe;YACfC,aAAaf,iBAAiBe,WAAW;YACzCJ,QAAQV;YACRY,SAAS,CAACD,oBAAoBI,QAAQhB,iBAAiBiB,aAAa;YACpEC,eAAe3B,4BAA4B;gBACzC4B,QACE,OAAOnB,iBAAiBiB,aAAa,KAAK,WACtCjB,iBAAiBiB,aAAa,CAACE,MAAM,GACrCC;gBACNC,KAAKrB,iBAAiBqB,GAAG;gBACzBjB,QAAQJ,iBAAiBI,MAAM;gBAC/BW,aAAaf,iBAAiBe,WAAW;gBACzCV;gBACAiB,sBAAsBtB,iBAAiBsB,oBAAoB;YAC7D;YACAC,mBAAmB;QACrB;QAEA,IAAIX,kBAAkB;YACpB,gFAAgF;YAChF,IAAIZ,iBAAiBwB,kBAAkB,EAAE;gBACvC,gEAAgE;gBAChE,MAAMC,4BAAsEC,OAAOC,OAAO,CACxF3B,iBAAiBe,WAAW,EAC5Ba,MAAM,CACN,CAACC,KAAK,CAACC,MAAMC,YAAY,GAAM,CAAA;wBAC7B,GAAGF,GAAG;wBACN,CAACC,KAAK,EAAE;4BACN,GAAIC,gBAAgB,OAAO,CAAC,IAAIA,WAAW;4BAC3CC,SAAS;wBACX;oBACF,CAAA,GACA,CAAC;gBAGH,OAAO5C,mBAAmB;oBACxBoC,oBAAoB;oBACpBT,aAAaU;oBACbZ,SAAS;oBACTS,sBAAsBtB,iBAAiBsB,oBAAoB;gBAC7D,GAAGrB;YACL;YAEA,OAAOA;QACT;QAEA,gDAAgD;QAChD,MAAMgC,yBAAyB,CAACH;YAC9B,MAAMI,0BAA0BlC,iBAAiBe,WAAW,CAACe,KAAK;YAElE,IAAIK,kBACF,OAAOD,4BAA4B,WAC9BA,wBAAwBC,eAAe,IAAI,QAC5C;YAEN,IAAIA,oBAAoB,MAAM;gBAC5BA,kBAAkBnC,iBAAiBmC,eAAe,IAAI;YACxD;YAEA,OAAOA;QACT;QAEA,+CAA+C;QAC/C,MAAMC,yBAAmEV,OAAOC,OAAO,CACrF3B,iBAAiBe,WAAW,EAC5Ba,MAAM,CACN,CAACC,KAAK,CAACC,MAAMC,YAAY,GAAM,CAAA;gBAC7B,GAAGF,GAAG;gBACN,CAACC,KAAK,EAAE;oBACN,GAAIC,gBAAgB,OAAO,CAAC,IAAIA,WAAW;oBAC3CC,SAAS1C,gBAAgB;wBACvB+B,KAAKrB,iBAAiBqB,GAAG;wBACzBjB,QAAQJ,iBAAiBI,MAAM;wBAC/Ba,eAAejB,iBAAiBiB,aAAa;wBAC7CN,QAAQX,iBAAiBW,MAAM;wBAC/BN;wBACA8B,iBAAiBF,uBAAuBH;wBACxCR,sBAAsBtB,iBAAiBsB,oBAAoB;oBAC7D;gBACF;YACF,CAAA,GACA,CAAC;QAGH,gFAAgF;QAChF,MAAMX,SAAS;YACb,GAAGV,cAAc;YACjBc,aAAa,AAACd,CAAAA,eAAec,WAAW,IAAI,EAAE,AAAD,EAAGsB,GAAG,CAAC,CAACC;gBACnD,IAAI,CAACF,sBAAsB,CAACE,WAAWR,IAAI,CAAC,EAAE;oBAC5C,OAAOQ;gBACT;gBAEA,OAAO;oBACL,GAAGA,UAAU;oBACbC,QAAQ;wBACN,GAAI,OAAOD,WAAWC,MAAM,KAAK,WAAWD,WAAWC,MAAM,GAAG,CAAC,CAAC;wBAClEC,qBAAqB;oBACvB;gBACF;YACF;QACF;QAEA,OAAOpD,mBAAmB;YACxBoC,oBAAoBxB,iBAAiBwB,kBAAkB;YACvDT,aAAaqB;YACbd,sBAAsBtB,iBAAiBsB,oBAAoB;QAC7D,GAAGX;IACL,EAAC"}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type { S3ClientConfig } from '@aws-sdk/client-s3'\nimport type {\n  ClientUploadsConfig,\n  PluginOptions as CloudStoragePluginOptions,\n  CollectionOptions,\n} from '@payloadcms/plugin-cloud-storage/types'\nimport type { NodeHttpHandlerOptions } from '@smithy/node-http-handler'\nimport type { Config, StorageAdapter, UploadCollectionSlug } from 'payload'\n\nimport { S3 } from '@aws-sdk/client-s3'\nimport { cloudStoragePlugin } from '@payloadcms/plugin-cloud-storage'\n\nimport type { SignedDownloadsConfig } from './getFile.js'\n\nimport { createS3Adapter } from './adapter.js'\n\nexport type S3StorageOptions = {\n  /**\n   * Access control list for uploaded files.\n   */\n  acl?: 'private' | 'public-read'\n\n  /**\n   * Bucket name to upload files to.\n   *\n   * Must follow [AWS S3 bucket naming conventions](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html).\n   */\n\n  bucket: string\n\n  /**\n   * Optional cache key to identify the S3 storage client instance.\n   * If not provided, a default key will be used.\n   *\n   * @default `s3:containerName`\n   */\n  clientCacheKey?: string\n\n  /**\n   * Upload directly to S3 instead of through Payload. You must allow CORS PUT requests from your website.\n   */\n  clientUploads?: ClientUploadsConfig\n  /**\n   * Collection options to apply the S3 adapter to.\n   */\n  collections: Partial<\n    Record<\n      UploadCollectionSlug,\n      | ({\n          signedDownloads?: SignedDownloadsConfig\n        } & Omit<CollectionOptions, 'adapter'>)\n      | true\n    >\n  >\n  /**\n   * AWS S3 client configuration. Highly dependent on your AWS setup.\n   *\n   * [AWS.S3ClientConfig Docs](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-s3/interfaces/s3clientconfig.html)\n   */\n  config: S3ClientConfig\n\n  /**\n   * Whether or not to disable local storage\n   *\n   * @default true\n   */\n  disableLocalStorage?: boolean\n\n  /**\n   * Whether or not to enable the plugin\n   *\n   * Default: true\n   */\n  enabled?: boolean\n  /**\n   * Use pre-signed URLs for files downloading. Can be overriden per-collection.\n   */\n  signedDownloads?: SignedDownloadsConfig\n  /**\n   * When true, the collection-level prefix and document-level prefix are combined\n   * (compositional). When false (default), a document prefix already within the\n   * collection prefix is used as-is for new uploads; otherwise it is nested beneath it.\n   * Existing files retain their stored prefixes for reads, URLs, and cleanup.\n   *\n   * Example with a document prefix already contained by the collection prefix:\n   * - collection prefix: `uploads/`\n   * - document prefix: `uploads/documents/`\n   * - resulting prefix with useCompositePrefixes=true: `uploads/uploads/documents/`\n   * - resulting prefix with useCompositePrefixes=false: `uploads/documents/`\n   *\n   * @default false\n   */\n  useCompositePrefixes?: boolean\n}\n\ntype S3StorageFactory = (storageS3Args: S3StorageOptions) => StorageAdapter\n\nconst s3Clients = new Map<string, S3>()\n\nconst defaultRequestHandlerOpts: NodeHttpHandlerOptions = {\n  httpAgent: {\n    keepAlive: true,\n    maxSockets: 100,\n  },\n  httpsAgent: {\n    keepAlive: true,\n    maxSockets: 100,\n  },\n}\n\nexport const s3Storage: S3StorageFactory = (\n  s3StorageOptions: S3StorageOptions,\n): StorageAdapter => ({\n  name: 's3',\n  collections: Object.keys(s3StorageOptions.collections),\n  init: (incomingConfig: Config): Config => {\n    const cacheKey = s3StorageOptions.clientCacheKey || `s3:${s3StorageOptions.bucket}`\n\n    const isPluginDisabled = s3StorageOptions.enabled === false\n\n    const getStorageClient: () => S3 = () => {\n      if (s3Clients.has(cacheKey)) {\n        return s3Clients.get(cacheKey)!\n      }\n\n      s3Clients.set(\n        cacheKey,\n        new S3({\n          requestHandler: defaultRequestHandlerOpts,\n          ...(s3StorageOptions.config ?? {}),\n        }),\n      )\n\n      return s3Clients.get(cacheKey)!\n    }\n\n    if (isPluginDisabled) {\n      // Still call cloudStoragePlugin with adapter: null so fields (like prefix) are\n      // inserted into the schema, keeping it consistent across environments.\n      const collectionsWithoutAdapter: CloudStoragePluginOptions['collections'] = Object.entries(\n        s3StorageOptions.collections,\n      ).reduce(\n        (acc, [slug, collOptions]) => ({\n          ...acc,\n          [slug]: {\n            ...(collOptions === true ? {} : collOptions),\n            adapter: null,\n          },\n        }),\n        {} as Record<string, CollectionOptions>,\n      )\n\n      return cloudStoragePlugin({\n        collections: collectionsWithoutAdapter,\n        enabled: false,\n        useCompositePrefixes: s3StorageOptions.useCompositePrefixes,\n      })(incomingConfig)\n    }\n\n    // Determine signedDownloads for this collection\n    const resolveSignedDownloads = (slug: string): SignedDownloadsConfig => {\n      const collectionStorageConfig = s3StorageOptions.collections[slug]\n\n      let signedDownloads: null | SignedDownloadsConfig =\n        typeof collectionStorageConfig === 'object'\n          ? (collectionStorageConfig.signedDownloads ?? false)\n          : null\n\n      if (signedDownloads === null) {\n        signedDownloads = s3StorageOptions.signedDownloads ?? false\n      }\n\n      return signedDownloads\n    }\n\n    // Add adapter to each collection option object\n    const collectionsWithAdapter: CloudStoragePluginOptions['collections'] = Object.entries(\n      s3StorageOptions.collections,\n    ).reduce(\n      (acc, [slug, collOptions]) => ({\n        ...acc,\n        [slug]: {\n          ...(collOptions === true ? {} : collOptions),\n          adapter: createS3Adapter({\n            acl: s3StorageOptions.acl,\n            bucket: s3StorageOptions.bucket,\n            clientUploads: s3StorageOptions.clientUploads,\n            config: s3StorageOptions.config,\n            getStorageClient,\n            signedDownloads: resolveSignedDownloads(slug),\n            useCompositePrefixes: s3StorageOptions.useCompositePrefixes,\n          }),\n        },\n      }),\n      {} as Record<string, CollectionOptions>,\n    )\n\n    // Set disableLocalStorage: true for collections specified in the plugin options\n    const config = {\n      ...incomingConfig,\n      collections: (incomingConfig.collections || []).map((collection) => {\n        if (!collectionsWithAdapter[collection.slug]) {\n          return collection\n        }\n\n        return {\n          ...collection,\n          upload: {\n            ...(typeof collection.upload === 'object' ? collection.upload : {}),\n            disableLocalStorage: true,\n          },\n        }\n      }),\n    }\n\n    return cloudStoragePlugin({\n      collections: collectionsWithAdapter,\n      useCompositePrefixes: s3StorageOptions.useCompositePrefixes,\n    })(config)\n  },\n})\n"],"names":["S3","cloudStoragePlugin","createS3Adapter","s3Clients","Map","defaultRequestHandlerOpts","httpAgent","keepAlive","maxSockets","httpsAgent","s3Storage","s3StorageOptions","name","collections","Object","keys","init","incomingConfig","cacheKey","clientCacheKey","bucket","isPluginDisabled","enabled","getStorageClient","has","get","set","requestHandler","config","collectionsWithoutAdapter","entries","reduce","acc","slug","collOptions","adapter","useCompositePrefixes","resolveSignedDownloads","collectionStorageConfig","signedDownloads","collectionsWithAdapter","acl","clientUploads","map","collection","upload","disableLocalStorage"],"mappings":"AASA,SAASA,EAAE,QAAQ,qBAAoB;AACvC,SAASC,kBAAkB,QAAQ,mCAAkC;AAIrE,SAASC,eAAe,QAAQ,eAAc;AAmF9C,MAAMC,YAAY,IAAIC;AAEtB,MAAMC,4BAAoD;IACxDC,WAAW;QACTC,WAAW;QACXC,YAAY;IACd;IACAC,YAAY;QACVF,WAAW;QACXC,YAAY;IACd;AACF;AAEA,OAAO,MAAME,YAA8B,CACzCC,mBACoB,CAAA;QACpBC,MAAM;QACNC,aAAaC,OAAOC,IAAI,CAACJ,iBAAiBE,WAAW;QACrDG,MAAM,CAACC;YACL,MAAMC,WAAWP,iBAAiBQ,cAAc,IAAI,CAAC,GAAG,EAAER,iBAAiBS,MAAM,EAAE;YAEnF,MAAMC,mBAAmBV,iBAAiBW,OAAO,KAAK;YAEtD,MAAMC,mBAA6B;gBACjC,IAAIpB,UAAUqB,GAAG,CAACN,WAAW;oBAC3B,OAAOf,UAAUsB,GAAG,CAACP;gBACvB;gBAEAf,UAAUuB,GAAG,CACXR,UACA,IAAIlB,GAAG;oBACL2B,gBAAgBtB;oBAChB,GAAIM,iBAAiBiB,MAAM,IAAI,CAAC,CAAC;gBACnC;gBAGF,OAAOzB,UAAUsB,GAAG,CAACP;YACvB;YAEA,IAAIG,kBAAkB;gBACpB,+EAA+E;gBAC/E,uEAAuE;gBACvE,MAAMQ,4BAAsEf,OAAOgB,OAAO,CACxFnB,iBAAiBE,WAAW,EAC5BkB,MAAM,CACN,CAACC,KAAK,CAACC,MAAMC,YAAY,GAAM,CAAA;wBAC7B,GAAGF,GAAG;wBACN,CAACC,KAAK,EAAE;4BACN,GAAIC,gBAAgB,OAAO,CAAC,IAAIA,WAAW;4BAC3CC,SAAS;wBACX;oBACF,CAAA,GACA,CAAC;gBAGH,OAAOlC,mBAAmB;oBACxBY,aAAagB;oBACbP,SAAS;oBACTc,sBAAsBzB,iBAAiByB,oBAAoB;gBAC7D,GAAGnB;YACL;YAEA,gDAAgD;YAChD,MAAMoB,yBAAyB,CAACJ;gBAC9B,MAAMK,0BAA0B3B,iBAAiBE,WAAW,CAACoB,KAAK;gBAElE,IAAIM,kBACF,OAAOD,4BAA4B,WAC9BA,wBAAwBC,eAAe,IAAI,QAC5C;gBAEN,IAAIA,oBAAoB,MAAM;oBAC5BA,kBAAkB5B,iBAAiB4B,eAAe,IAAI;gBACxD;gBAEA,OAAOA;YACT;YAEA,+CAA+C;YAC/C,MAAMC,yBAAmE1B,OAAOgB,OAAO,CACrFnB,iBAAiBE,WAAW,EAC5BkB,MAAM,CACN,CAACC,KAAK,CAACC,MAAMC,YAAY,GAAM,CAAA;oBAC7B,GAAGF,GAAG;oBACN,CAACC,KAAK,EAAE;wBACN,GAAIC,gBAAgB,OAAO,CAAC,IAAIA,WAAW;wBAC3CC,SAASjC,gBAAgB;4BACvBuC,KAAK9B,iBAAiB8B,GAAG;4BACzBrB,QAAQT,iBAAiBS,MAAM;4BAC/BsB,eAAe/B,iBAAiB+B,aAAa;4BAC7Cd,QAAQjB,iBAAiBiB,MAAM;4BAC/BL;4BACAgB,iBAAiBF,uBAAuBJ;4BACxCG,sBAAsBzB,iBAAiByB,oBAAoB;wBAC7D;oBACF;gBACF,CAAA,GACA,CAAC;YAGH,gFAAgF;YAChF,MAAMR,SAAS;gBACb,GAAGX,cAAc;gBACjBJ,aAAa,AAACI,CAAAA,eAAeJ,WAAW,IAAI,EAAE,AAAD,EAAG8B,GAAG,CAAC,CAACC;oBACnD,IAAI,CAACJ,sBAAsB,CAACI,WAAWX,IAAI,CAAC,EAAE;wBAC5C,OAAOW;oBACT;oBAEA,OAAO;wBACL,GAAGA,UAAU;wBACbC,QAAQ;4BACN,GAAI,OAAOD,WAAWC,MAAM,KAAK,WAAWD,WAAWC,MAAM,GAAG,CAAC,CAAC;4BAClEC,qBAAqB;wBACvB;oBACF;gBACF;YACF;YAEA,OAAO7C,mBAAmB;gBACxBY,aAAa2B;gBACbJ,sBAAsBzB,iBAAiByB,oBAAoB;YAC7D,GAAGR;QACL;IACF,CAAA,EAAE"}

package/dist/uploadFile.d.ts

@@ -4,13 +4,10 @@ interface UploadArgs {
     bucket: string;
     buffer: Buffer;
     client: AWS.S3;
-    collectionPrefix?: string;
-    docPrefix?: string;
-    filename: string;
     mimeType: string;
+    storageFilePath: string;
     tempFilePath?: string;
-    useCompositePrefixes?: boolean;
 }
-export declare function uploadFile({ acl, bucket, buffer, client, collectionPrefix, docPrefix, filename, mimeType, tempFilePath, useCompositePrefixes, }: UploadArgs): Promise<void>;
+export declare function uploadFile({ acl, bucket, buffer, client, mimeType, storageFilePath, tempFilePath, }: UploadArgs): Promise<void>;
 export {};
 //# sourceMappingURL=uploadFile.d.ts.map

package/dist/uploadFile.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"uploadFile.d.ts","sourceRoot":"","sources":["../src/uploadFile.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,GAAG,MAAM,oBAAoB,CAAA;AAM9C,UAAU,UAAU;IAClB,GAAG,CAAC,EAAE,SAAS,GAAG,aAAa,CAAA;IAC/B,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,GAAG,CAAC,EAAE,CAAA;IACd,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B;AAID,wBAAsB,UAAU,CAAC,EAC/B,GAAG,EACH,MAAM,EACN,MAAM,EACN,MAAM,EACN,gBAAqB,EACrB,SAAS,EACT,QAAQ,EACR,QAAQ,EACR,YAAY,EACZ,oBAA4B,GAC7B,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAoC5B"}
+{"version":3,"file":"uploadFile.d.ts","sourceRoot":"","sources":["../src/uploadFile.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,GAAG,MAAM,oBAAoB,CAAA;AAK9C,UAAU,UAAU;IAClB,GAAG,CAAC,EAAE,SAAS,GAAG,aAAa,CAAA;IAC/B,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,GAAG,CAAC,EAAE,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;IAChB,eAAe,EAAE,MAAM,CAAA;IACvB,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAID,wBAAsB,UAAU,CAAC,EAC/B,GAAG,EACH,MAAM,EACN,MAAM,EACN,MAAM,EACN,QAAQ,EACR,eAAe,EACf,YAAY,GACb,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CA6B5B"}

package/dist/uploadFile.js

@@ -1,15 +1,8 @@
 import { Upload } from '@aws-sdk/lib-storage';
-import { getFileKey } from '@payloadcms/plugin-cloud-storage/utilities';
 import fs from 'fs';
 const multipartThreshold = 1024 * 1024 * 50 // 50MB
 ;
-export async function uploadFile({ acl, bucket, buffer, client, collectionPrefix = '', docPrefix, filename, mimeType, tempFilePath, useCompositePrefixes = false }) {
-    const { fileKey } = getFileKey({
-        collectionPrefix,
-        docPrefix,
-        filename,
-        useCompositePrefixes
-    });
+export async function uploadFile({ acl, bucket, buffer, client, mimeType, storageFilePath, tempFilePath }) {
     const fileBufferOrStream = tempFilePath ? fs.createReadStream(tempFilePath) : buffer;
     if (buffer.length > 0 && buffer.length < multipartThreshold) {
         await client.putObject({
@@ -17,7 +10,7 @@ export async function uploadFile({ acl, bucket, buffer, client, collectionPrefix
             Body: fileBufferOrStream,
             Bucket: bucket,
             ContentType: mimeType,
-            Key: fileKey
+            Key: storageFilePath
         });
         return;
     }
@@ -28,7 +21,7 @@ export async function uploadFile({ acl, bucket, buffer, client, collectionPrefix
             Body: fileBufferOrStream,
             Bucket: bucket,
             ContentType: mimeType,
-            Key: fileKey
+            Key: storageFilePath
         },
         partSize: multipartThreshold,
         queueSize: 4

package/dist/uploadFile.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/uploadFile.ts"],"sourcesContent":["import type * as AWS from '@aws-sdk/client-s3'\n\nimport { Upload } from '@aws-sdk/lib-storage'\nimport { getFileKey } from '@payloadcms/plugin-cloud-storage/utilities'\nimport fs from 'fs'\n\ninterface UploadArgs {\n  acl?: 'private' | 'public-read'\n  bucket: string\n  buffer: Buffer\n  client: AWS.S3\n  collectionPrefix?: string\n  docPrefix?: string\n  filename: string\n  mimeType: string\n  tempFilePath?: string\n  useCompositePrefixes?: boolean\n}\n\nconst multipartThreshold = 1024 * 1024 * 50 // 50MB\n\nexport async function uploadFile({\n  acl,\n  bucket,\n  buffer,\n  client,\n  collectionPrefix = '',\n  docPrefix,\n  filename,\n  mimeType,\n  tempFilePath,\n  useCompositePrefixes = false,\n}: UploadArgs): Promise<void> {\n  const { fileKey } = getFileKey({\n    collectionPrefix,\n    docPrefix,\n    filename,\n    useCompositePrefixes,\n  })\n\n  const fileBufferOrStream = tempFilePath ? fs.createReadStream(tempFilePath) : buffer\n\n  if (buffer.length > 0 && buffer.length < multipartThreshold) {\n    await client.putObject({\n      ACL: acl,\n      Body: fileBufferOrStream,\n      Bucket: bucket,\n      ContentType: mimeType,\n      Key: fileKey,\n    })\n\n    return\n  }\n\n  const parallelUploadS3 = new Upload({\n    client,\n    params: {\n      ACL: acl,\n      Body: fileBufferOrStream,\n      Bucket: bucket,\n      ContentType: mimeType,\n      Key: fileKey,\n    },\n    partSize: multipartThreshold,\n    queueSize: 4,\n  })\n\n  await parallelUploadS3.done()\n}\n"],"names":["Upload","getFileKey","fs","multipartThreshold","uploadFile","acl","bucket","buffer","client","collectionPrefix","docPrefix","filename","mimeType","tempFilePath","useCompositePrefixes","fileKey","fileBufferOrStream","createReadStream","length","putObject","ACL","Body","Bucket","ContentType","Key","parallelUploadS3","params","partSize","queueSize","done"],"mappings":"AAEA,SAASA,MAAM,QAAQ,uBAAsB;AAC7C,SAASC,UAAU,QAAQ,6CAA4C;AACvE,OAAOC,QAAQ,KAAI;AAenB,MAAMC,qBAAqB,OAAO,OAAO,GAAG,OAAO;;AAEnD,OAAO,eAAeC,WAAW,EAC/BC,GAAG,EACHC,MAAM,EACNC,MAAM,EACNC,MAAM,EACNC,mBAAmB,EAAE,EACrBC,SAAS,EACTC,QAAQ,EACRC,QAAQ,EACRC,YAAY,EACZC,uBAAuB,KAAK,EACjB;IACX,MAAM,EAAEC,OAAO,EAAE,GAAGd,WAAW;QAC7BQ;QACAC;QACAC;QACAG;IACF;IAEA,MAAME,qBAAqBH,eAAeX,GAAGe,gBAAgB,CAACJ,gBAAgBN;IAE9E,IAAIA,OAAOW,MAAM,GAAG,KAAKX,OAAOW,MAAM,GAAGf,oBAAoB;QAC3D,MAAMK,OAAOW,SAAS,CAAC;YACrBC,KAAKf;YACLgB,MAAML;YACNM,QAAQhB;YACRiB,aAAaX;YACbY,KAAKT;QACP;QAEA;IACF;IAEA,MAAMU,mBAAmB,IAAIzB,OAAO;QAClCQ;QACAkB,QAAQ;YACNN,KAAKf;YACLgB,MAAML;YACNM,QAAQhB;YACRiB,aAAaX;YACbY,KAAKT;QACP;QACAY,UAAUxB;QACVyB,WAAW;IACb;IAEA,MAAMH,iBAAiBI,IAAI;AAC7B"}
+{"version":3,"sources":["../src/uploadFile.ts"],"sourcesContent":["import type * as AWS from '@aws-sdk/client-s3'\n\nimport { Upload } from '@aws-sdk/lib-storage'\nimport fs from 'fs'\n\ninterface UploadArgs {\n  acl?: 'private' | 'public-read'\n  bucket: string\n  buffer: Buffer\n  client: AWS.S3\n  mimeType: string\n  storageFilePath: string\n  tempFilePath?: string\n}\n\nconst multipartThreshold = 1024 * 1024 * 50 // 50MB\n\nexport async function uploadFile({\n  acl,\n  bucket,\n  buffer,\n  client,\n  mimeType,\n  storageFilePath,\n  tempFilePath,\n}: UploadArgs): Promise<void> {\n  const fileBufferOrStream = tempFilePath ? fs.createReadStream(tempFilePath) : buffer\n\n  if (buffer.length > 0 && buffer.length < multipartThreshold) {\n    await client.putObject({\n      ACL: acl,\n      Body: fileBufferOrStream,\n      Bucket: bucket,\n      ContentType: mimeType,\n      Key: storageFilePath,\n    })\n\n    return\n  }\n\n  const parallelUploadS3 = new Upload({\n    client,\n    params: {\n      ACL: acl,\n      Body: fileBufferOrStream,\n      Bucket: bucket,\n      ContentType: mimeType,\n      Key: storageFilePath,\n    },\n    partSize: multipartThreshold,\n    queueSize: 4,\n  })\n\n  await parallelUploadS3.done()\n}\n"],"names":["Upload","fs","multipartThreshold","uploadFile","acl","bucket","buffer","client","mimeType","storageFilePath","tempFilePath","fileBufferOrStream","createReadStream","length","putObject","ACL","Body","Bucket","ContentType","Key","parallelUploadS3","params","partSize","queueSize","done"],"mappings":"AAEA,SAASA,MAAM,QAAQ,uBAAsB;AAC7C,OAAOC,QAAQ,KAAI;AAYnB,MAAMC,qBAAqB,OAAO,OAAO,GAAG,OAAO;;AAEnD,OAAO,eAAeC,WAAW,EAC/BC,GAAG,EACHC,MAAM,EACNC,MAAM,EACNC,MAAM,EACNC,QAAQ,EACRC,eAAe,EACfC,YAAY,EACD;IACX,MAAMC,qBAAqBD,eAAeT,GAAGW,gBAAgB,CAACF,gBAAgBJ;IAE9E,IAAIA,OAAOO,MAAM,GAAG,KAAKP,OAAOO,MAAM,GAAGX,oBAAoB;QAC3D,MAAMK,OAAOO,SAAS,CAAC;YACrBC,KAAKX;YACLY,MAAML;YACNM,QAAQZ;YACRa,aAAaV;YACbW,KAAKV;QACP;QAEA;IACF;IAEA,MAAMW,mBAAmB,IAAIpB,OAAO;QAClCO;QACAc,QAAQ;YACNN,KAAKX;YACLY,MAAML;YACNM,QAAQZ;YACRa,aAAaV;YACbW,KAAKV;QACP;QACAa,UAAUpB;QACVqB,WAAW;IACb;IAEA,MAAMH,iBAAiBI,IAAI;AAC7B"}