@payloadcms/storage-s3 4.0.0-internal.e55ccef → 4.0.0-internal.ea6e8f8

package/README.md

@@ -15,7 +15,7 @@ pnpm add @payloadcms/storage-s3
 - Configure the `collections` object to specify which collections should use the AWS S3 adapter. The slug _must_ match one of your existing collection slugs.
 - The `config` object can be any [`S3ClientConfig`](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/s3) object (from [`@aws-sdk/client-s3`](https://github.com/aws/aws-sdk-js-v3)). _This is highly dependent on your AWS setup_. Check the AWS documentation for more information.
 - When enabled, this package will automatically set `disableLocalStorage` to `true` for each collection.
-- When deploying to Vercel, server uploads are limited with 4.5MB. Set `clientUploads` to `true` to do uploads directly on the client. You must allow CORS PUT method for the bucket to your website.
+- When deploying to Vercel, server uploads are limited to 4.5MB. Set `clientUploads` to `true` to use upload instructions and send files directly to S3. You must allow CORS `PUT` requests from your website.
 - Configure `signedDownloads` (either globally of per-collection in `collections`) to use [presigned URLs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-presigned-url.html) for files downloading. This can improve performance for large files (like videos) while still respecting your access control. Additionally, with `signedDownloads.shouldUseSignedURL` you can specify a condition whether Payload should use a presigned URL, if you want to use this feature only for specific files.
 
 ```ts

package/dist/adapter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../src/adapter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAC5D,OAAO,KAAK,EACV,OAAO,EACP,mBAAmB,EAEpB,MAAM,wCAAwC,CAAA;AAE/C,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAA;AAIzD,UAAU,mBAAmB;IAC3B,GAAG,CAAC,EAAE,SAAS,GAAG,aAAa,CAAA;IAC/B,MAAM,EAAE,MAAM,CAAA;IACd,aAAa,CAAC,EAAE,mBAAmB,CAAA;IACnC,MAAM,EAAE,cAAc,CAAA;IACtB,gBAAgB,EAAE,MAAM,EAAE,CAAA;IAC1B,eAAe,EAAE,qBAAqB,CAAA;IACtC,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B;AAED,wBAAgB,eAAe,CAAC,EAC9B,GAAG,EACH,MAAM,EACN,aAAa,EACb,MAAM,EACN,gBAAgB,EAChB,eAAe,EACf,oBAA4B,GAC7B,EAAE,mBAAmB,GAAG,OAAO,CAmE/B"}
+{"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../src/adapter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAC5D,OAAO,KAAK,EACV,OAAO,EACP,mBAAmB,EAGpB,MAAM,wCAAwC,CAAA;AAE/C,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAA;AAKzD,UAAU,mBAAmB;IAC3B,GAAG,CAAC,EAAE,SAAS,GAAG,aAAa,CAAA;IAC/B,MAAM,EAAE,MAAM,CAAA;IACd,aAAa,CAAC,EAAE,mBAAmB,CAAA;IACnC,MAAM,EAAE,cAAc,CAAA;IACtB,gBAAgB,EAAE,MAAM,EAAE,CAAA;IAC1B,eAAe,EAAE,qBAAqB,CAAA;IACtC,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B;AAED,wBAAgB,eAAe,CAAC,EAC9B,GAAG,EACH,MAAM,EACN,aAAa,EACb,MAAM,EACN,gBAAgB,EAChB,eAAe,EACf,oBAA4B,GAC7B,EAAE,mBAAmB,GAAG,OAAO,CAgF/B"}

package/dist/adapter.js

@@ -1,8 +1,29 @@
+import { generateUploadInstructions } from './generateUploadInstructions.js';
 import { generateURL } from './generateURL.js';
 export function createS3Adapter({ acl, bucket, clientUploads, config, getStorageClient, signedDownloads, useCompositePrefixes = false }) {
+    const deleteStoredFile = async ({ storageFilePath })=>{
+        const { deleteFile } = await import('./deleteFile.js');
+        return deleteFile({
+            bucket,
+            client: getStorageClient(),
+            storageFilePath
+        });
+    };
     return ({ collection, prefix = '' })=>({
             name: 's3',
-            clientUploads,
+            supportsTempFiles: true,
+            copyFile: async ({ from, req, to })=>{
+                const { copyS3File } = await import('./copyFile.js');
+                await copyS3File({
+                    acl,
+                    bucket,
+                    client: getStorageClient(),
+                    from,
+                    req,
+                    to
+                });
+            },
+            deleteFile: deleteStoredFile,
             generateURL: ({ filename, prefix: urlPrefix = '' })=>generateURL({
                     bucket,
                     collectionPrefix: prefix,
@@ -11,48 +32,49 @@ export function createS3Adapter({ acl, bucket, clientUploads, config, getStorage
                     prefix: urlPrefix,
                     useCompositePrefixes
                 }),
-            // Helpers below dynamic-import their @aws-sdk dependencies so the SDK only
-            // loads on the first request that actually needs it.
-            handleDelete: async ({ doc: { prefix: docPrefix = '' }, filename })=>{
-                const { deleteFile } = await import('./deleteFile.js');
-                return deleteFile({
+            uploadInstructions: {
+                enabled: Boolean(clientUploads),
+                generate: generateUploadInstructions({
+                    access: typeof clientUploads === 'object' ? clientUploads.access : undefined,
+                    acl,
                     bucket,
-                    client: getStorageClient(),
                     collectionPrefix: prefix,
-                    docPrefix,
-                    filename,
+                    getStorageClient,
                     useCompositePrefixes
-                });
+                }),
+                requiresUploadReceipt: true,
+                useInAdmin: true
             },
-            handleUpload: async ({ data, file })=>{
+            // Helpers below dynamic-import their @aws-sdk dependencies so the SDK only
+            // loads on the first request that actually needs it.
+            handleDelete: deleteStoredFile,
+            handleUpload: async ({ data, file, storageFilePath })=>{
                 const { uploadFile } = await import('./uploadFile.js');
                 await uploadFile({
                     acl,
                     bucket,
                     buffer: file.buffer,
                     client: getStorageClient(),
-                    collectionPrefix: prefix,
-                    docPrefix: data.prefix,
-                    filename: file.filename,
                     mimeType: file.mimeType,
-                    tempFilePath: file.tempFilePath,
-                    useCompositePrefixes
+                    storageFilePath,
+                    tempFilePath: file.tempFilePath
                 });
                 return data;
             },
-            staticHandler: async (req, { headers, params: { clientUploadContext, filename, prefix: prefixQueryParam } })=>{
+            staticHandler: async (req, { doc, headers, params: { filename, operation, uploadReference } })=>{
                 const { getFile } = await import('./getFile.js');
                 return getFile({
                     bucket,
                     client: getStorageClient(),
-                    clientUploadContext,
                     collection,
                     collectionPrefix: prefix,
+                    doc,
                     filename,
                     incomingHeaders: headers,
-                    prefixQueryParam,
+                    operation,
                     req,
                     signedDownloads,
+                    uploadReference,
                     useCompositePrefixes
                 });
             }

package/dist/adapter.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/adapter.ts"],"sourcesContent":["import type { S3, S3ClientConfig } from '@aws-sdk/client-s3'\nimport type {\n  Adapter,\n  ClientUploadsConfig,\n  GeneratedAdapter,\n} from '@payloadcms/plugin-cloud-storage/types'\n\nimport type { SignedDownloadsConfig } from './getFile.js'\n\nimport { generateURL } from './generateURL.js'\n\ninterface CreateS3AdapterArgs {\n  acl?: 'private' | 'public-read'\n  bucket: string\n  clientUploads?: ClientUploadsConfig\n  config: S3ClientConfig\n  getStorageClient: () => S3\n  signedDownloads: SignedDownloadsConfig\n  useCompositePrefixes?: boolean\n}\n\nexport function createS3Adapter({\n  acl,\n  bucket,\n  clientUploads,\n  config,\n  getStorageClient,\n  signedDownloads,\n  useCompositePrefixes = false,\n}: CreateS3AdapterArgs): Adapter {\n  return ({ collection, prefix = '' }): GeneratedAdapter => ({\n    name: 's3',\n    clientUploads,\n\n    generateURL: ({ filename, prefix: urlPrefix = '' }) =>\n      generateURL({\n        bucket,\n        collectionPrefix: prefix,\n        endpoint: config.endpoint,\n        filename,\n        prefix: urlPrefix,\n        useCompositePrefixes,\n      }),\n\n    // Helpers below dynamic-import their @aws-sdk dependencies so the SDK only\n    // loads on the first request that actually needs it.\n    handleDelete: async ({ doc: { prefix: docPrefix = '' }, filename }) => {\n      const { deleteFile } = await import('./deleteFile.js')\n      return deleteFile({\n        bucket,\n        client: getStorageClient(),\n        collectionPrefix: prefix,\n        docPrefix,\n        filename,\n        useCompositePrefixes,\n      })\n    },\n\n    handleUpload: async ({ data, file }) => {\n      const { uploadFile } = await import('./uploadFile.js')\n      await uploadFile({\n        acl,\n        bucket,\n        buffer: file.buffer,\n        client: getStorageClient(),\n        collectionPrefix: prefix,\n        docPrefix: data.prefix,\n        filename: file.filename,\n        mimeType: file.mimeType,\n        tempFilePath: file.tempFilePath,\n        useCompositePrefixes,\n      })\n\n      return data\n    },\n\n    staticHandler: async (\n      req,\n      { headers, params: { clientUploadContext, filename, prefix: prefixQueryParam } },\n    ) => {\n      const { getFile } = await import('./getFile.js')\n      return getFile({\n        bucket,\n        client: getStorageClient(),\n        clientUploadContext,\n        collection,\n        collectionPrefix: prefix,\n        filename,\n        incomingHeaders: headers,\n        prefixQueryParam,\n        req,\n        signedDownloads,\n        useCompositePrefixes,\n      })\n    },\n  })\n}\n"],"names":["generateURL","createS3Adapter","acl","bucket","clientUploads","config","getStorageClient","signedDownloads","useCompositePrefixes","collection","prefix","name","filename","urlPrefix","collectionPrefix","endpoint","handleDelete","doc","docPrefix","deleteFile","client","handleUpload","data","file","uploadFile","buffer","mimeType","tempFilePath","staticHandler","req","headers","params","clientUploadContext","prefixQueryParam","getFile","incomingHeaders"],"mappings":"AASA,SAASA,WAAW,QAAQ,mBAAkB;AAY9C,OAAO,SAASC,gBAAgB,EAC9BC,GAAG,EACHC,MAAM,EACNC,aAAa,EACbC,MAAM,EACNC,gBAAgB,EAChBC,eAAe,EACfC,uBAAuB,KAAK,EACR;IACpB,OAAO,CAAC,EAAEC,UAAU,EAAEC,SAAS,EAAE,EAAE,GAAwB,CAAA;YACzDC,MAAM;YACNP;YAEAJ,aAAa,CAAC,EAAEY,QAAQ,EAAEF,QAAQG,YAAY,EAAE,EAAE,GAChDb,YAAY;oBACVG;oBACAW,kBAAkBJ;oBAClBK,UAAUV,OAAOU,QAAQ;oBACzBH;oBACAF,QAAQG;oBACRL;gBACF;YAEF,2EAA2E;YAC3E,qDAAqD;YACrDQ,cAAc,OAAO,EAAEC,KAAK,EAAEP,QAAQQ,YAAY,EAAE,EAAE,EAAEN,QAAQ,EAAE;gBAChE,MAAM,EAAEO,UAAU,EAAE,GAAG,MAAM,MAAM,CAAC;gBACpC,OAAOA,WAAW;oBAChBhB;oBACAiB,QAAQd;oBACRQ,kBAAkBJ;oBAClBQ;oBACAN;oBACAJ;gBACF;YACF;YAEAa,cAAc,OAAO,EAAEC,IAAI,EAAEC,IAAI,EAAE;gBACjC,MAAM,EAAEC,UAAU,EAAE,GAAG,MAAM,MAAM,CAAC;gBACpC,MAAMA,WAAW;oBACftB;oBACAC;oBACAsB,QAAQF,KAAKE,MAAM;oBACnBL,QAAQd;oBACRQ,kBAAkBJ;oBAClBQ,WAAWI,KAAKZ,MAAM;oBACtBE,UAAUW,KAAKX,QAAQ;oBACvBc,UAAUH,KAAKG,QAAQ;oBACvBC,cAAcJ,KAAKI,YAAY;oBAC/BnB;gBACF;gBAEA,OAAOc;YACT;YAEAM,eAAe,OACbC,KACA,EAAEC,OAAO,EAAEC,QAAQ,EAAEC,mBAAmB,EAAEpB,QAAQ,EAAEF,QAAQuB,gBAAgB,EAAE,EAAE;gBAEhF,MAAM,EAAEC,OAAO,EAAE,GAAG,MAAM,MAAM,CAAC;gBACjC,OAAOA,QAAQ;oBACb/B;oBACAiB,QAAQd;oBACR0B;oBACAvB;oBACAK,kBAAkBJ;oBAClBE;oBACAuB,iBAAiBL;oBACjBG;oBACAJ;oBACAtB;oBACAC;gBACF;YACF;QACF,CAAA;AACF"}
+{"version":3,"sources":["../src/adapter.ts"],"sourcesContent":["import type { S3, S3ClientConfig } from '@aws-sdk/client-s3'\nimport type {\n  Adapter,\n  ClientUploadsConfig,\n  DeleteFile,\n  GeneratedAdapter,\n} from '@payloadcms/plugin-cloud-storage/types'\n\nimport type { SignedDownloadsConfig } from './getFile.js'\n\nimport { generateUploadInstructions } from './generateUploadInstructions.js'\nimport { generateURL } from './generateURL.js'\n\ninterface CreateS3AdapterArgs {\n  acl?: 'private' | 'public-read'\n  bucket: string\n  clientUploads?: ClientUploadsConfig\n  config: S3ClientConfig\n  getStorageClient: () => S3\n  signedDownloads: SignedDownloadsConfig\n  useCompositePrefixes?: boolean\n}\n\nexport function createS3Adapter({\n  acl,\n  bucket,\n  clientUploads,\n  config,\n  getStorageClient,\n  signedDownloads,\n  useCompositePrefixes = false,\n}: CreateS3AdapterArgs): Adapter {\n  const deleteStoredFile: DeleteFile = async ({ storageFilePath }) => {\n    const { deleteFile } = await import('./deleteFile.js')\n    return deleteFile({ bucket, client: getStorageClient(), storageFilePath })\n  }\n\n  return ({ collection, prefix = '' }): GeneratedAdapter => ({\n    name: 's3',\n    supportsTempFiles: true,\n\n    copyFile: async ({ from, req, to }) => {\n      const { copyS3File } = await import('./copyFile.js')\n      await copyS3File({ acl, bucket, client: getStorageClient(), from, req, to })\n    },\n    deleteFile: deleteStoredFile,\n\n    generateURL: ({ filename, prefix: urlPrefix = '' }) =>\n      generateURL({\n        bucket,\n        collectionPrefix: prefix,\n        endpoint: config.endpoint,\n        filename,\n        prefix: urlPrefix,\n        useCompositePrefixes,\n      }),\n\n    uploadInstructions: {\n      enabled: Boolean(clientUploads),\n      generate: generateUploadInstructions({\n        access: typeof clientUploads === 'object' ? clientUploads.access : undefined,\n        acl,\n        bucket,\n        collectionPrefix: prefix,\n        getStorageClient,\n        useCompositePrefixes,\n      }),\n      requiresUploadReceipt: true,\n      useInAdmin: true,\n    },\n\n    // Helpers below dynamic-import their @aws-sdk dependencies so the SDK only\n    // loads on the first request that actually needs it.\n    handleDelete: deleteStoredFile,\n\n    handleUpload: async ({ data, file, storageFilePath }) => {\n      const { uploadFile } = await import('./uploadFile.js')\n      await uploadFile({\n        acl,\n        bucket,\n        buffer: file.buffer,\n        client: getStorageClient(),\n        mimeType: file.mimeType,\n        storageFilePath,\n        tempFilePath: file.tempFilePath,\n      })\n\n      return data\n    },\n\n    staticHandler: async (\n      req,\n      { doc, headers, params: { filename, operation, uploadReference } },\n    ) => {\n      const { getFile } = await import('./getFile.js')\n      return getFile({\n        bucket,\n        client: getStorageClient(),\n        collection,\n        collectionPrefix: prefix,\n        doc,\n        filename,\n        incomingHeaders: headers,\n        operation,\n        req,\n        signedDownloads,\n        uploadReference,\n        useCompositePrefixes,\n      })\n    },\n  })\n}\n"],"names":["generateUploadInstructions","generateURL","createS3Adapter","acl","bucket","clientUploads","config","getStorageClient","signedDownloads","useCompositePrefixes","deleteStoredFile","storageFilePath","deleteFile","client","collection","prefix","name","supportsTempFiles","copyFile","from","req","to","copyS3File","filename","urlPrefix","collectionPrefix","endpoint","uploadInstructions","enabled","Boolean","generate","access","undefined","requiresUploadReceipt","useInAdmin","handleDelete","handleUpload","data","file","uploadFile","buffer","mimeType","tempFilePath","staticHandler","doc","headers","params","operation","uploadReference","getFile","incomingHeaders"],"mappings":"AAUA,SAASA,0BAA0B,QAAQ,kCAAiC;AAC5E,SAASC,WAAW,QAAQ,mBAAkB;AAY9C,OAAO,SAASC,gBAAgB,EAC9BC,GAAG,EACHC,MAAM,EACNC,aAAa,EACbC,MAAM,EACNC,gBAAgB,EAChBC,eAAe,EACfC,uBAAuB,KAAK,EACR;IACpB,MAAMC,mBAA+B,OAAO,EAAEC,eAAe,EAAE;QAC7D,MAAM,EAAEC,UAAU,EAAE,GAAG,MAAM,MAAM,CAAC;QACpC,OAAOA,WAAW;YAAER;YAAQS,QAAQN;YAAoBI;QAAgB;IAC1E;IAEA,OAAO,CAAC,EAAEG,UAAU,EAAEC,SAAS,EAAE,EAAE,GAAwB,CAAA;YACzDC,MAAM;YACNC,mBAAmB;YAEnBC,UAAU,OAAO,EAAEC,IAAI,EAAEC,GAAG,EAAEC,EAAE,EAAE;gBAChC,MAAM,EAAEC,UAAU,EAAE,GAAG,MAAM,MAAM,CAAC;gBACpC,MAAMA,WAAW;oBAAEnB;oBAAKC;oBAAQS,QAAQN;oBAAoBY;oBAAMC;oBAAKC;gBAAG;YAC5E;YACAT,YAAYF;YAEZT,aAAa,CAAC,EAAEsB,QAAQ,EAAER,QAAQS,YAAY,EAAE,EAAE,GAChDvB,YAAY;oBACVG;oBACAqB,kBAAkBV;oBAClBW,UAAUpB,OAAOoB,QAAQ;oBACzBH;oBACAR,QAAQS;oBACRf;gBACF;YAEFkB,oBAAoB;gBAClBC,SAASC,QAAQxB;gBACjByB,UAAU9B,2BAA2B;oBACnC+B,QAAQ,OAAO1B,kBAAkB,WAAWA,cAAc0B,MAAM,GAAGC;oBACnE7B;oBACAC;oBACAqB,kBAAkBV;oBAClBR;oBACAE;gBACF;gBACAwB,uBAAuB;gBACvBC,YAAY;YACd;YAEA,2EAA2E;YAC3E,qDAAqD;YACrDC,cAAczB;YAEd0B,cAAc,OAAO,EAAEC,IAAI,EAAEC,IAAI,EAAE3B,eAAe,EAAE;gBAClD,MAAM,EAAE4B,UAAU,EAAE,GAAG,MAAM,MAAM,CAAC;gBACpC,MAAMA,WAAW;oBACfpC;oBACAC;oBACAoC,QAAQF,KAAKE,MAAM;oBACnB3B,QAAQN;oBACRkC,UAAUH,KAAKG,QAAQ;oBACvB9B;oBACA+B,cAAcJ,KAAKI,YAAY;gBACjC;gBAEA,OAAOL;YACT;YAEAM,eAAe,OACbvB,KACA,EAAEwB,GAAG,EAAEC,OAAO,EAAEC,QAAQ,EAAEvB,QAAQ,EAAEwB,SAAS,EAAEC,eAAe,EAAE,EAAE;gBAElE,MAAM,EAAEC,OAAO,EAAE,GAAG,MAAM,MAAM,CAAC;gBACjC,OAAOA,QAAQ;oBACb7C;oBACAS,QAAQN;oBACRO;oBACAW,kBAAkBV;oBAClB6B;oBACArB;oBACA2B,iBAAiBL;oBACjBE;oBACA3B;oBACAZ;oBACAwC;oBACAvC;gBACF;YACF;QACF,CAAA;AACF"}

package/dist/copyFile.d.ts

@@ -0,0 +1,13 @@
+import type { S3 } from '@aws-sdk/client-s3';
+import type { PayloadRequest } from 'payload';
+type CopyS3FileArgs = {
+    acl?: 'private' | 'public-read';
+    bucket: string;
+    client: S3;
+    from: string;
+    req?: PayloadRequest;
+    to: string;
+};
+export declare const copyS3File: ({ acl, bucket, client, from, req, to, }: CopyS3FileArgs) => Promise<void>;
+export {};
+//# sourceMappingURL=copyFile.d.ts.map

package/dist/copyFile.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"copyFile.d.ts","sourceRoot":"","sources":["../src/copyFile.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,oBAAoB,CAAA;AAC5C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAE7C,KAAK,cAAc,GAAG;IACpB,GAAG,CAAC,EAAE,SAAS,GAAG,aAAa,CAAA;IAC/B,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,EAAE,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,CAAC,EAAE,cAAc,CAAA;IACpB,EAAE,EAAE,MAAM,CAAA;CACX,CAAA;AAKD,eAAO,MAAM,UAAU,4CAOpB,cAAc,KAAG,OAAO,CAAC,IAAI,CAyI/B,CAAA"}

package/dist/copyFile.js

@@ -0,0 +1,145 @@
+const singleCopyLimit = 5 * 1024 ** 3;
+const partSize = 256 * 1024 ** 2;
+export const copyS3File = async ({ acl, bucket, client, from, req, to })=>{
+    if (from === to) {
+        throw new Error('Storage copy requires different source and destination keys');
+    }
+    const source = await client.headObject({
+        Bucket: bucket,
+        Key: from
+    });
+    const size = source.ContentLength;
+    if (size === undefined) {
+        throw new Error('Storage source has no known length');
+    }
+    const copySource = `${encodeURIComponent(bucket)}/${from.split('/').map(encodeURIComponent).join('/')}`;
+    let hasCopied = false;
+    let destinationETag;
+    let destinationVersion;
+    try {
+        if (size <= singleCopyLimit) {
+            const copied = await client.copyObject({
+                ACL: acl,
+                Bucket: bucket,
+                CopySource: copySource,
+                CopySourceIfMatch: source.ETag,
+                IfNoneMatch: '*',
+                Key: to,
+                MetadataDirective: 'COPY',
+                ServerSideEncryption: source.ServerSideEncryption,
+                SSEKMSKeyId: source.SSEKMSKeyId,
+                TaggingDirective: 'COPY'
+            });
+            hasCopied = true;
+            destinationETag = copied.CopyObjectResult?.ETag;
+            destinationVersion = copied.VersionId;
+        } else {
+            const { TagSet = [] } = await client.getObjectTagging({
+                Bucket: bucket,
+                Key: from
+            });
+            const tagging = new URLSearchParams();
+            for (const tag of TagSet){
+                if (tag.Key && tag.Value !== undefined) {
+                    tagging.set(tag.Key, tag.Value);
+                }
+            }
+            const upload = await client.createMultipartUpload({
+                ACL: acl,
+                Bucket: bucket,
+                CacheControl: source.CacheControl,
+                ContentDisposition: source.ContentDisposition,
+                ContentEncoding: source.ContentEncoding,
+                ContentLanguage: source.ContentLanguage,
+                ContentType: source.ContentType,
+                Expires: source.Expires,
+                Key: to,
+                Metadata: source.Metadata,
+                ServerSideEncryption: source.ServerSideEncryption,
+                SSEKMSKeyId: source.SSEKMSKeyId,
+                StorageClass: source.StorageClass,
+                Tagging: tagging.size ? tagging.toString() : undefined
+            });
+            if (!upload.UploadId) {
+                throw new Error('S3 did not return a multipart upload ID');
+            }
+            try {
+                const parts = [];
+                for(let partNumber = 1, start = 0; start < size; start += partSize, partNumber++){
+                    const end = Math.min(start + partSize, size) - 1;
+                    const part = await client.uploadPartCopy({
+                        Bucket: bucket,
+                        CopySource: copySource,
+                        CopySourceIfMatch: source.ETag,
+                        CopySourceRange: `bytes=${start}-${end}`,
+                        Key: to,
+                        PartNumber: partNumber,
+                        UploadId: upload.UploadId
+                    });
+                    if (!part.CopyPartResult?.ETag) {
+                        throw new Error(`S3 copy part ${partNumber} did not return an ETag`);
+                    }
+                    parts.push({
+                        ETag: part.CopyPartResult.ETag,
+                        PartNumber: partNumber
+                    });
+                }
+                const copied = await client.completeMultipartUpload({
+                    Bucket: bucket,
+                    IfNoneMatch: '*',
+                    Key: to,
+                    MultipartUpload: {
+                        Parts: parts
+                    },
+                    UploadId: upload.UploadId
+                });
+                hasCopied = true;
+                destinationETag = copied.ETag;
+                destinationVersion = copied.VersionId;
+            } catch (err) {
+                try {
+                    await client.abortMultipartUpload({
+                        Bucket: bucket,
+                        Key: to,
+                        UploadId: upload.UploadId
+                    });
+                } catch (cleanupError) {
+                    req?.payload.logger.error({
+                        err: cleanupError,
+                        msg: `Failed to abort S3 multipart copy at ${bucket}/${to} (upload ${upload.UploadId})`
+                    });
+                }
+                throw err;
+            }
+        }
+        const destination = await client.headObject({
+            Bucket: bucket,
+            Key: to
+        });
+        if (destination.ContentLength !== size) {
+            throw new Error(`Copied storage object is not readable at its expected length: ${to}`);
+        }
+    } catch (err) {
+        if (hasCopied) {
+            try {
+                if (!destinationETag && (!destinationVersion || destinationVersion === 'null')) {
+                    throw new Error('S3 copy did not return an ETag or version for safe cleanup');
+                }
+                await client.deleteObject({
+                    Bucket: bucket,
+                    IfMatch: destinationETag,
+                    Key: to,
+                    VersionId: destinationVersion
+                });
+            } catch (cleanupError) {
+                req?.payload.logger.error({
+                    err: cleanupError,
+                    msg: `Failed to remove unsuccessful S3 copy at ${bucket}/${to}`
+                });
+            }
+        }
+        throw err;
+    }
+};
+
+//# sourceMappingURL=copyFile.js.map

package/dist/copyFile.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/copyFile.ts"],"sourcesContent":["import type { S3 } from '@aws-sdk/client-s3'\nimport type { PayloadRequest } from 'payload'\n\ntype CopyS3FileArgs = {\n  acl?: 'private' | 'public-read'\n  bucket: string\n  client: S3\n  from: string\n  req?: PayloadRequest\n  to: string\n}\n\nconst singleCopyLimit = 5 * 1024 ** 3\nconst partSize = 256 * 1024 ** 2\n\nexport const copyS3File = async ({\n  acl,\n  bucket,\n  client,\n  from,\n  req,\n  to,\n}: CopyS3FileArgs): Promise<void> => {\n  if (from === to) {\n    throw new Error('Storage copy requires different source and destination keys')\n  }\n\n  const source = await client.headObject({ Bucket: bucket, Key: from })\n  const size = source.ContentLength\n\n  if (size === undefined) {\n    throw new Error('Storage source has no known length')\n  }\n\n  const copySource = `${encodeURIComponent(bucket)}/${from.split('/').map(encodeURIComponent).join('/')}`\n\n  let hasCopied = false\n  let destinationETag: string | undefined\n  let destinationVersion: string | undefined\n\n  try {\n    if (size <= singleCopyLimit) {\n      const copied = await client.copyObject({\n        ACL: acl,\n        Bucket: bucket,\n        CopySource: copySource,\n        CopySourceIfMatch: source.ETag,\n        IfNoneMatch: '*',\n        Key: to,\n        MetadataDirective: 'COPY',\n        ServerSideEncryption: source.ServerSideEncryption,\n        SSEKMSKeyId: source.SSEKMSKeyId,\n        TaggingDirective: 'COPY',\n      })\n      hasCopied = true\n      destinationETag = copied.CopyObjectResult?.ETag\n      destinationVersion = copied.VersionId\n    } else {\n      const { TagSet = [] } = await client.getObjectTagging({ Bucket: bucket, Key: from })\n      const tagging = new URLSearchParams()\n\n      for (const tag of TagSet) {\n        if (tag.Key && tag.Value !== undefined) {\n          tagging.set(tag.Key, tag.Value)\n        }\n      }\n\n      const upload = await client.createMultipartUpload({\n        ACL: acl,\n        Bucket: bucket,\n        CacheControl: source.CacheControl,\n        ContentDisposition: source.ContentDisposition,\n        ContentEncoding: source.ContentEncoding,\n        ContentLanguage: source.ContentLanguage,\n        ContentType: source.ContentType,\n        Expires: source.Expires,\n        Key: to,\n        Metadata: source.Metadata,\n        ServerSideEncryption: source.ServerSideEncryption,\n        SSEKMSKeyId: source.SSEKMSKeyId,\n        StorageClass: source.StorageClass,\n        Tagging: tagging.size ? tagging.toString() : undefined,\n      })\n\n      if (!upload.UploadId) {\n        throw new Error('S3 did not return a multipart upload ID')\n      }\n\n      try {\n        const parts = []\n\n        for (let partNumber = 1, start = 0; start < size; start += partSize, partNumber++) {\n          const end = Math.min(start + partSize, size) - 1\n          const part = await client.uploadPartCopy({\n            Bucket: bucket,\n            CopySource: copySource,\n            CopySourceIfMatch: source.ETag,\n            CopySourceRange: `bytes=${start}-${end}`,\n            Key: to,\n            PartNumber: partNumber,\n            UploadId: upload.UploadId,\n          })\n\n          if (!part.CopyPartResult?.ETag) {\n            throw new Error(`S3 copy part ${partNumber} did not return an ETag`)\n          }\n\n          parts.push({ ETag: part.CopyPartResult.ETag, PartNumber: partNumber })\n        }\n\n        const copied = await client.completeMultipartUpload({\n          Bucket: bucket,\n          IfNoneMatch: '*',\n          Key: to,\n          MultipartUpload: { Parts: parts },\n          UploadId: upload.UploadId,\n        })\n        hasCopied = true\n        destinationETag = copied.ETag\n        destinationVersion = copied.VersionId\n      } catch (err) {\n        try {\n          await client.abortMultipartUpload({ Bucket: bucket, Key: to, UploadId: upload.UploadId })\n        } catch (cleanupError) {\n          req?.payload.logger.error({\n            err: cleanupError,\n            msg: `Failed to abort S3 multipart copy at ${bucket}/${to} (upload ${upload.UploadId})`,\n          })\n        }\n        throw err\n      }\n    }\n\n    const destination = await client.headObject({ Bucket: bucket, Key: to })\n\n    if (destination.ContentLength !== size) {\n      throw new Error(`Copied storage object is not readable at its expected length: ${to}`)\n    }\n  } catch (err) {\n    if (hasCopied) {\n      try {\n        if (!destinationETag && (!destinationVersion || destinationVersion === 'null')) {\n          throw new Error('S3 copy did not return an ETag or version for safe cleanup')\n        }\n        await client.deleteObject({\n          Bucket: bucket,\n          IfMatch: destinationETag,\n          Key: to,\n          VersionId: destinationVersion,\n        })\n      } catch (cleanupError) {\n        req?.payload.logger.error({\n          err: cleanupError,\n          msg: `Failed to remove unsuccessful S3 copy at ${bucket}/${to}`,\n        })\n      }\n    }\n    throw err\n  }\n}\n"],"names":["singleCopyLimit","partSize","copyS3File","acl","bucket","client","from","req","to","Error","source","headObject","Bucket","Key","size","ContentLength","undefined","copySource","encodeURIComponent","split","map","join","hasCopied","destinationETag","destinationVersion","copied","copyObject","ACL","CopySource","CopySourceIfMatch","ETag","IfNoneMatch","MetadataDirective","ServerSideEncryption","SSEKMSKeyId","TaggingDirective","CopyObjectResult","VersionId","TagSet","getObjectTagging","tagging","URLSearchParams","tag","Value","set","upload","createMultipartUpload","CacheControl","ContentDisposition","ContentEncoding","ContentLanguage","ContentType","Expires","Metadata","StorageClass","Tagging","toString","UploadId","parts","partNumber","start","end","Math","min","part","uploadPartCopy","CopySourceRange","PartNumber","CopyPartResult","push","completeMultipartUpload","MultipartUpload","Parts","err","abortMultipartUpload","cleanupError","payload","logger","error","msg","destination","deleteObject","IfMatch"],"mappings":"AAYA,MAAMA,kBAAkB,IAAI,QAAQ;AACpC,MAAMC,WAAW,MAAM,QAAQ;AAE/B,OAAO,MAAMC,aAAa,OAAO,EAC/BC,GAAG,EACHC,MAAM,EACNC,MAAM,EACNC,IAAI,EACJC,GAAG,EACHC,EAAE,EACa;IACf,IAAIF,SAASE,IAAI;QACf,MAAM,IAAIC,MAAM;IAClB;IAEA,MAAMC,SAAS,MAAML,OAAOM,UAAU,CAAC;QAAEC,QAAQR;QAAQS,KAAKP;IAAK;IACnE,MAAMQ,OAAOJ,OAAOK,aAAa;IAEjC,IAAID,SAASE,WAAW;QACtB,MAAM,IAAIP,MAAM;IAClB;IAEA,MAAMQ,aAAa,GAAGC,mBAAmBd,QAAQ,CAAC,EAAEE,KAAKa,KAAK,CAAC,KAAKC,GAAG,CAACF,oBAAoBG,IAAI,CAAC,MAAM;IAEvG,IAAIC,YAAY;IAChB,IAAIC;IACJ,IAAIC;IAEJ,IAAI;QACF,IAAIV,QAAQd,iBAAiB;YAC3B,MAAMyB,SAAS,MAAMpB,OAAOqB,UAAU,CAAC;gBACrCC,KAAKxB;gBACLS,QAAQR;gBACRwB,YAAYX;gBACZY,mBAAmBnB,OAAOoB,IAAI;gBAC9BC,aAAa;gBACblB,KAAKL;gBACLwB,mBAAmB;gBACnBC,sBAAsBvB,OAAOuB,oBAAoB;gBACjDC,aAAaxB,OAAOwB,WAAW;gBAC/BC,kBAAkB;YACpB;YACAb,YAAY;YACZC,kBAAkBE,OAAOW,gBAAgB,EAAEN;YAC3CN,qBAAqBC,OAAOY,SAAS;QACvC,OAAO;YACL,MAAM,EAAEC,SAAS,EAAE,EAAE,GAAG,MAAMjC,OAAOkC,gBAAgB,CAAC;gBAAE3B,QAAQR;gBAAQS,KAAKP;YAAK;YAClF,MAAMkC,UAAU,IAAIC;YAEpB,KAAK,MAAMC,OAAOJ,OAAQ;gBACxB,IAAII,IAAI7B,GAAG,IAAI6B,IAAIC,KAAK,KAAK3B,WAAW;oBACtCwB,QAAQI,GAAG,CAACF,IAAI7B,GAAG,EAAE6B,IAAIC,KAAK;gBAChC;YACF;YAEA,MAAME,SAAS,MAAMxC,OAAOyC,qBAAqB,CAAC;gBAChDnB,KAAKxB;gBACLS,QAAQR;gBACR2C,cAAcrC,OAAOqC,YAAY;gBACjCC,oBAAoBtC,OAAOsC,kBAAkB;gBAC7CC,iBAAiBvC,OAAOuC,eAAe;gBACvCC,iBAAiBxC,OAAOwC,eAAe;gBACvCC,aAAazC,OAAOyC,WAAW;gBAC/BC,SAAS1C,OAAO0C,OAAO;gBACvBvC,KAAKL;gBACL6C,UAAU3C,OAAO2C,QAAQ;gBACzBpB,sBAAsBvB,OAAOuB,oBAAoB;gBACjDC,aAAaxB,OAAOwB,WAAW;gBAC/BoB,cAAc5C,OAAO4C,YAAY;gBACjCC,SAASf,QAAQ1B,IAAI,GAAG0B,QAAQgB,QAAQ,KAAKxC;YAC/C;YAEA,IAAI,CAAC6B,OAAOY,QAAQ,EAAE;gBACpB,MAAM,IAAIhD,MAAM;YAClB;YAEA,IAAI;gBACF,MAAMiD,QAAQ,EAAE;gBAEhB,IAAK,IAAIC,aAAa,GAAGC,QAAQ,GAAGA,QAAQ9C,MAAM8C,SAAS3D,UAAU0D,aAAc;oBACjF,MAAME,MAAMC,KAAKC,GAAG,CAACH,QAAQ3D,UAAUa,QAAQ;oBAC/C,MAAMkD,OAAO,MAAM3D,OAAO4D,cAAc,CAAC;wBACvCrD,QAAQR;wBACRwB,YAAYX;wBACZY,mBAAmBnB,OAAOoB,IAAI;wBAC9BoC,iBAAiB,CAAC,MAAM,EAAEN,MAAM,CAAC,EAAEC,KAAK;wBACxChD,KAAKL;wBACL2D,YAAYR;wBACZF,UAAUZ,OAAOY,QAAQ;oBAC3B;oBAEA,IAAI,CAACO,KAAKI,cAAc,EAAEtC,MAAM;wBAC9B,MAAM,IAAIrB,MAAM,CAAC,aAAa,EAAEkD,WAAW,uBAAuB,CAAC;oBACrE;oBAEAD,MAAMW,IAAI,CAAC;wBAAEvC,MAAMkC,KAAKI,cAAc,CAACtC,IAAI;wBAAEqC,YAAYR;oBAAW;gBACtE;gBAEA,MAAMlC,SAAS,MAAMpB,OAAOiE,uBAAuB,CAAC;oBAClD1D,QAAQR;oBACR2B,aAAa;oBACblB,KAAKL;oBACL+D,iBAAiB;wBAAEC,OAAOd;oBAAM;oBAChCD,UAAUZ,OAAOY,QAAQ;gBAC3B;gBACAnC,YAAY;gBACZC,kBAAkBE,OAAOK,IAAI;gBAC7BN,qBAAqBC,OAAOY,SAAS;YACvC,EAAE,OAAOoC,KAAK;gBACZ,IAAI;oBACF,MAAMpE,OAAOqE,oBAAoB,CAAC;wBAAE9D,QAAQR;wBAAQS,KAAKL;wBAAIiD,UAAUZ,OAAOY,QAAQ;oBAAC;gBACzF,EAAE,OAAOkB,cAAc;oBACrBpE,KAAKqE,QAAQC,OAAOC,MAAM;wBACxBL,KAAKE;wBACLI,KAAK,CAAC,qCAAqC,EAAE3E,OAAO,CAAC,EAAEI,GAAG,SAAS,EAAEqC,OAAOY,QAAQ,CAAC,CAAC,CAAC;oBACzF;gBACF;gBACA,MAAMgB;YACR;QACF;QAEA,MAAMO,cAAc,MAAM3E,OAAOM,UAAU,CAAC;YAAEC,QAAQR;YAAQS,KAAKL;QAAG;QAEtE,IAAIwE,YAAYjE,aAAa,KAAKD,MAAM;YACtC,MAAM,IAAIL,MAAM,CAAC,8DAA8D,EAAED,IAAI;QACvF;IACF,EAAE,OAAOiE,KAAK;QACZ,IAAInD,WAAW;YACb,IAAI;gBACF,IAAI,CAACC,mBAAoB,CAAA,CAACC,sBAAsBA,uBAAuB,MAAK,GAAI;oBAC9E,MAAM,IAAIf,MAAM;gBAClB;gBACA,MAAMJ,OAAO4E,YAAY,CAAC;oBACxBrE,QAAQR;oBACR8E,SAAS3D;oBACTV,KAAKL;oBACL6B,WAAWb;gBACb;YACF,EAAE,OAAOmD,cAAc;gBACrBpE,KAAKqE,QAAQC,OAAOC,MAAM;oBACxBL,KAAKE;oBACLI,KAAK,CAAC,yCAAyC,EAAE3E,OAAO,CAAC,EAAEI,IAAI;gBACjE;YACF;QACF;QACA,MAAMiE;IACR;AACF,EAAC"}

package/dist/deleteFile.d.ts

@@ -2,11 +2,8 @@ import type * as AWS from '@aws-sdk/client-s3';
 interface DeleteArgs {
     bucket: string;
     client: AWS.S3;
-    collectionPrefix?: string;
-    docPrefix: string;
-    filename: string;
-    useCompositePrefixes?: boolean;
+    storageFilePath: string;
 }
-export declare function deleteFile({ bucket, client, collectionPrefix, docPrefix, filename, useCompositePrefixes, }: DeleteArgs): Promise<void>;
+export declare function deleteFile({ bucket, client, storageFilePath }: DeleteArgs): Promise<void>;
 export {};
 //# sourceMappingURL=deleteFile.d.ts.map

package/dist/deleteFile.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"deleteFile.d.ts","sourceRoot":"","sources":["../src/deleteFile.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,GAAG,MAAM,oBAAoB,CAAA;AAI9C,UAAU,UAAU;IAClB,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,GAAG,CAAC,EAAE,CAAA;IACd,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IAChB,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B;AAED,wBAAsB,UAAU,CAAC,EAC/B,MAAM,EACN,MAAM,EACN,gBAAqB,EACrB,SAAS,EACT,QAAQ,EACR,oBAA4B,GAC7B,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAY5B"}
+{"version":3,"file":"deleteFile.d.ts","sourceRoot":"","sources":["../src/deleteFile.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,GAAG,MAAM,oBAAoB,CAAA;AAE9C,UAAU,UAAU;IAClB,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,GAAG,CAAC,EAAE,CAAA;IACd,eAAe,EAAE,MAAM,CAAA;CACxB;AAED,wBAAsB,UAAU,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,eAAe,EAAE,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAK/F"}

package/dist/deleteFile.js

@@ -1,14 +1,7 @@
-import { getFileKey } from '@payloadcms/plugin-cloud-storage/utilities';
-export async function deleteFile({ bucket, client, collectionPrefix = '', docPrefix, filename, useCompositePrefixes = false }) {
-    const { fileKey } = getFileKey({
-        collectionPrefix,
-        docPrefix,
-        filename,
-        useCompositePrefixes
-    });
+export async function deleteFile({ bucket, client, storageFilePath }) {
     await client.deleteObject({
         Bucket: bucket,
-        Key: fileKey
+        Key: storageFilePath
     });
 }
 

package/dist/deleteFile.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/deleteFile.ts"],"sourcesContent":["import type * as AWS from '@aws-sdk/client-s3'\n\nimport { getFileKey } from '@payloadcms/plugin-cloud-storage/utilities'\n\ninterface DeleteArgs {\n  bucket: string\n  client: AWS.S3\n  collectionPrefix?: string\n  docPrefix: string\n  filename: string\n  useCompositePrefixes?: boolean\n}\n\nexport async function deleteFile({\n  bucket,\n  client,\n  collectionPrefix = '',\n  docPrefix,\n  filename,\n  useCompositePrefixes = false,\n}: DeleteArgs): Promise<void> {\n  const { fileKey } = getFileKey({\n    collectionPrefix,\n    docPrefix,\n    filename,\n    useCompositePrefixes,\n  })\n\n  await client.deleteObject({\n    Bucket: bucket,\n    Key: fileKey,\n  })\n}\n"],"names":["getFileKey","deleteFile","bucket","client","collectionPrefix","docPrefix","filename","useCompositePrefixes","fileKey","deleteObject","Bucket","Key"],"mappings":"AAEA,SAASA,UAAU,QAAQ,6CAA4C;AAWvE,OAAO,eAAeC,WAAW,EAC/BC,MAAM,EACNC,MAAM,EACNC,mBAAmB,EAAE,EACrBC,SAAS,EACTC,QAAQ,EACRC,uBAAuB,KAAK,EACjB;IACX,MAAM,EAAEC,OAAO,EAAE,GAAGR,WAAW;QAC7BI;QACAC;QACAC;QACAC;IACF;IAEA,MAAMJ,OAAOM,YAAY,CAAC;QACxBC,QAAQR;QACRS,KAAKH;IACP;AACF"}
+{"version":3,"sources":["../src/deleteFile.ts"],"sourcesContent":["import type * as AWS from '@aws-sdk/client-s3'\n\ninterface DeleteArgs {\n  bucket: string\n  client: AWS.S3\n  storageFilePath: string\n}\n\nexport async function deleteFile({ bucket, client, storageFilePath }: DeleteArgs): Promise<void> {\n  await client.deleteObject({\n    Bucket: bucket,\n    Key: storageFilePath,\n  })\n}\n"],"names":["deleteFile","bucket","client","storageFilePath","deleteObject","Bucket","Key"],"mappings":"AAQA,OAAO,eAAeA,WAAW,EAAEC,MAAM,EAAEC,MAAM,EAAEC,eAAe,EAAc;IAC9E,MAAMD,OAAOE,YAAY,CAAC;QACxBC,QAAQJ;QACRK,KAAKH;IACP;AACF"}

package/dist/generateURL.js

@@ -1,14 +1,14 @@
-import { getFileKey } from '@payloadcms/plugin-cloud-storage/utilities';
+import { buildStoragePathData } from '@payloadcms/plugin-cloud-storage/utilities';
 import path from 'path';
 export function generateURL({ bucket, collectionPrefix = '', endpoint, filename, prefix, useCompositePrefixes = false }) {
-    const { fileKey: rawFileKey } = getFileKey({
+    const { storageFilePath } = buildStoragePathData({
         collectionPrefix,
         docPrefix: prefix,
         filename,
         useCompositePrefixes
     });
-    const dir = path.posix.dirname(rawFileKey);
-    const encodedFilename = encodeURIComponent(path.posix.basename(rawFileKey));
+    const dir = path.posix.dirname(storageFilePath);
+    const encodedFilename = encodeURIComponent(path.posix.basename(storageFilePath));
     const fileKey = dir === '.' ? encodedFilename : path.posix.join(dir, encodedFilename);
     const stringifiedEndpoint = typeof endpoint === 'string' ? endpoint : endpoint?.toString();
     return `${stringifiedEndpoint}/${bucket}/${fileKey}`;

package/dist/generateURL.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/generateURL.ts"],"sourcesContent":["import type * as AWS from '@aws-sdk/client-s3'\n\nimport { getFileKey } from '@payloadcms/plugin-cloud-storage/utilities'\nimport path from 'path'\n\ninterface GenerateURLArgs {\n  bucket: string\n  collectionPrefix?: string\n  endpoint?: AWS.S3ClientConfig['endpoint']\n  filename: string\n  prefix: string\n  useCompositePrefixes?: boolean\n}\n\nexport function generateURL({\n  bucket,\n  collectionPrefix = '',\n  endpoint,\n  filename,\n  prefix,\n  useCompositePrefixes = false,\n}: GenerateURLArgs): string {\n  const { fileKey: rawFileKey } = getFileKey({\n    collectionPrefix,\n    docPrefix: prefix,\n    filename,\n    useCompositePrefixes,\n  })\n  const dir = path.posix.dirname(rawFileKey)\n  const encodedFilename = encodeURIComponent(path.posix.basename(rawFileKey))\n  const fileKey = dir === '.' ? encodedFilename : path.posix.join(dir, encodedFilename)\n\n  const stringifiedEndpoint = typeof endpoint === 'string' ? endpoint : endpoint?.toString()\n  return `${stringifiedEndpoint}/${bucket}/${fileKey}`\n}\n"],"names":["getFileKey","path","generateURL","bucket","collectionPrefix","endpoint","filename","prefix","useCompositePrefixes","fileKey","rawFileKey","docPrefix","dir","posix","dirname","encodedFilename","encodeURIComponent","basename","join","stringifiedEndpoint","toString"],"mappings":"AAEA,SAASA,UAAU,QAAQ,6CAA4C;AACvE,OAAOC,UAAU,OAAM;AAWvB,OAAO,SAASC,YAAY,EAC1BC,MAAM,EACNC,mBAAmB,EAAE,EACrBC,QAAQ,EACRC,QAAQ,EACRC,MAAM,EACNC,uBAAuB,KAAK,EACZ;IAChB,MAAM,EAAEC,SAASC,UAAU,EAAE,GAAGV,WAAW;QACzCI;QACAO,WAAWJ;QACXD;QACAE;IACF;IACA,MAAMI,MAAMX,KAAKY,KAAK,CAACC,OAAO,CAACJ;IAC/B,MAAMK,kBAAkBC,mBAAmBf,KAAKY,KAAK,CAACI,QAAQ,CAACP;IAC/D,MAAMD,UAAUG,QAAQ,MAAMG,kBAAkBd,KAAKY,KAAK,CAACK,IAAI,CAACN,KAAKG;IAErE,MAAMI,sBAAsB,OAAOd,aAAa,WAAWA,WAAWA,UAAUe;IAChF,OAAO,GAAGD,oBAAoB,CAAC,EAAEhB,OAAO,CAAC,EAAEM,SAAS;AACtD"}
+{"version":3,"sources":["../src/generateURL.ts"],"sourcesContent":["import type * as AWS from '@aws-sdk/client-s3'\n\nimport { buildStoragePathData } from '@payloadcms/plugin-cloud-storage/utilities'\nimport path from 'path'\n\ninterface GenerateURLArgs {\n  bucket: string\n  collectionPrefix?: string\n  endpoint?: AWS.S3ClientConfig['endpoint']\n  filename: string\n  prefix: string\n  useCompositePrefixes?: boolean\n}\n\nexport function generateURL({\n  bucket,\n  collectionPrefix = '',\n  endpoint,\n  filename,\n  prefix,\n  useCompositePrefixes = false,\n}: GenerateURLArgs): string {\n  const { storageFilePath } = buildStoragePathData({\n    collectionPrefix,\n    docPrefix: prefix,\n    filename,\n    useCompositePrefixes,\n  })\n  const dir = path.posix.dirname(storageFilePath)\n  const encodedFilename = encodeURIComponent(path.posix.basename(storageFilePath))\n  const fileKey = dir === '.' ? encodedFilename : path.posix.join(dir, encodedFilename)\n\n  const stringifiedEndpoint = typeof endpoint === 'string' ? endpoint : endpoint?.toString()\n  return `${stringifiedEndpoint}/${bucket}/${fileKey}`\n}\n"],"names":["buildStoragePathData","path","generateURL","bucket","collectionPrefix","endpoint","filename","prefix","useCompositePrefixes","storageFilePath","docPrefix","dir","posix","dirname","encodedFilename","encodeURIComponent","basename","fileKey","join","stringifiedEndpoint","toString"],"mappings":"AAEA,SAASA,oBAAoB,QAAQ,6CAA4C;AACjF,OAAOC,UAAU,OAAM;AAWvB,OAAO,SAASC,YAAY,EAC1BC,MAAM,EACNC,mBAAmB,EAAE,EACrBC,QAAQ,EACRC,QAAQ,EACRC,MAAM,EACNC,uBAAuB,KAAK,EACZ;IAChB,MAAM,EAAEC,eAAe,EAAE,GAAGT,qBAAqB;QAC/CI;QACAM,WAAWH;QACXD;QACAE;IACF;IACA,MAAMG,MAAMV,KAAKW,KAAK,CAACC,OAAO,CAACJ;IAC/B,MAAMK,kBAAkBC,mBAAmBd,KAAKW,KAAK,CAACI,QAAQ,CAACP;IAC/D,MAAMQ,UAAUN,QAAQ,MAAMG,kBAAkBb,KAAKW,KAAK,CAACM,IAAI,CAACP,KAAKG;IAErE,MAAMK,sBAAsB,OAAOd,aAAa,WAAWA,WAAWA,UAAUe;IAChF,OAAO,GAAGD,oBAAoB,CAAC,EAAEhB,OAAO,CAAC,EAAEc,SAAS;AACtD"}

package/dist/generateUploadInstructions.d.ts

@@ -0,0 +1,13 @@
+import type { S3 } from '@aws-sdk/client-s3';
+import type { GenerateUploadInstructions, UploadInstructionsAccess } from 'payload';
+interface Args {
+    access?: UploadInstructionsAccess;
+    acl?: 'private' | 'public-read';
+    bucket: string;
+    collectionPrefix: string;
+    getStorageClient: () => S3;
+    useCompositePrefixes?: boolean;
+}
+export declare const generateUploadInstructions: ({ access, acl, bucket, collectionPrefix, getStorageClient, useCompositePrefixes, }: Args) => GenerateUploadInstructions;
+export {};
+//# sourceMappingURL=generateUploadInstructions.d.ts.map

package/dist/generateUploadInstructions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateUploadInstructions.d.ts","sourceRoot":"","sources":["../src/generateUploadInstructions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,oBAAoB,CAAA;AAC5C,OAAO,KAAK,EAAE,0BAA0B,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAA;AAQnF,UAAU,IAAI;IACZ,MAAM,CAAC,EAAE,wBAAwB,CAAA;IACjC,GAAG,CAAC,EAAE,SAAS,GAAG,aAAa,CAAA;IAC/B,MAAM,EAAE,MAAM,CAAA;IACd,gBAAgB,EAAE,MAAM,CAAA;IACxB,gBAAgB,EAAE,MAAM,EAAE,CAAA;IAC1B,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B;AAED,eAAO,MAAM,0BAA0B,uFAOpC,IAAI,KAAG,0BA4ET,CAAA"}

package/dist/generateUploadInstructions.js

@@ -0,0 +1,70 @@
+import { PutObjectCommand } from '@aws-sdk/client-s3';
+import { getSignedUrl } from '@aws-sdk/s3-request-presigner';
+import { resolveSignedURLKey } from '@payloadcms/plugin-cloud-storage/utilities';
+import { Forbidden } from 'payload';
+import { assertClientUploadAllowed } from 'payload/internal';
+export const generateUploadInstructions = ({ access, acl, bucket, collectionPrefix, getStorageClient, useCompositePrefixes = false })=>{
+    return async ({ collectionSlug, docPrefix, filename, filesize, mimeType, overrideAccess, req })=>{
+        if (!overrideAccess && (access ? !await access({
+            collectionSlug,
+            req
+        }) : !req.user)) {
+            throw new Forbidden(req.t);
+        }
+        assertClientUploadAllowed({
+            collection: req.payload.collections[collectionSlug]?.config,
+            filename,
+            mimeType
+        });
+        let filesizeLimit = req.payload.config.upload.limits?.fileSize;
+        if (filesizeLimit === Infinity) {
+            filesizeLimit = undefined;
+        }
+        const { sanitizedFilename, storageFilePath, uploadReference } = await resolveSignedURLKey({
+            collectionPrefix,
+            collectionSlug,
+            docPrefix,
+            filename,
+            req,
+            useCompositePrefixes
+        });
+        const signableHeaders = new Set([
+            'content-type'
+        ]);
+        if (filesizeLimit) {
+            // Still force S3 to validate
+            signableHeaders.add('content-length');
+        }
+        const url = await getSignedUrl(getStorageClient(), new PutObjectCommand({
+            ACL: acl,
+            Bucket: bucket,
+            ContentLength: filesizeLimit ? Math.min(filesize, filesizeLimit) : undefined,
+            ContentType: mimeType,
+            IfNoneMatch: '*',
+            Key: storageFilePath
+        }), {
+            expiresIn: 600,
+            signableHeaders
+        });
+        return {
+            type: 'http',
+            file: {
+                filename: sanitizedFilename,
+                mimeType,
+                size: filesize,
+                uploadReference
+            },
+            request: {
+                headers: {
+                    'Content-Length': String(filesize),
+                    'Content-Type': mimeType,
+                    'If-None-Match': '*'
+                },
+                method: 'PUT',
+                url
+            }
+        };
+    };
+};
+
+//# sourceMappingURL=generateUploadInstructions.js.map

package/dist/generateUploadInstructions.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/generateUploadInstructions.ts"],"sourcesContent":["import type { S3 } from '@aws-sdk/client-s3'\nimport type { GenerateUploadInstructions, UploadInstructionsAccess } from 'payload'\n\nimport { PutObjectCommand } from '@aws-sdk/client-s3'\nimport { getSignedUrl } from '@aws-sdk/s3-request-presigner'\nimport { resolveSignedURLKey } from '@payloadcms/plugin-cloud-storage/utilities'\nimport { Forbidden } from 'payload'\nimport { assertClientUploadAllowed } from 'payload/internal'\n\ninterface Args {\n  access?: UploadInstructionsAccess\n  acl?: 'private' | 'public-read'\n  bucket: string\n  collectionPrefix: string\n  getStorageClient: () => S3\n  useCompositePrefixes?: boolean\n}\n\nexport const generateUploadInstructions = ({\n  access,\n  acl,\n  bucket,\n  collectionPrefix,\n  getStorageClient,\n  useCompositePrefixes = false,\n}: Args): GenerateUploadInstructions => {\n  return async ({\n    collectionSlug,\n    docPrefix,\n    filename,\n    filesize,\n    mimeType,\n    overrideAccess,\n    req,\n  }) => {\n    if (!overrideAccess && (access ? !(await access({ collectionSlug, req })) : !req.user)) {\n      throw new Forbidden(req.t)\n    }\n\n    assertClientUploadAllowed({\n      collection: req.payload.collections[collectionSlug]?.config,\n      filename,\n      mimeType,\n    })\n    let filesizeLimit = req.payload.config.upload.limits?.fileSize\n\n    if (filesizeLimit === Infinity) {\n      filesizeLimit = undefined\n    }\n\n    const { sanitizedFilename, storageFilePath, uploadReference } = await resolveSignedURLKey({\n      collectionPrefix,\n      collectionSlug,\n      docPrefix,\n      filename,\n      req,\n      useCompositePrefixes,\n    })\n\n    const signableHeaders = new Set<string>(['content-type'])\n\n    if (filesizeLimit) {\n      // Still force S3 to validate\n      signableHeaders.add('content-length')\n    }\n\n    const url = await getSignedUrl(\n      getStorageClient(),\n      new PutObjectCommand({\n        ACL: acl,\n        Bucket: bucket,\n        ContentLength: filesizeLimit ? Math.min(filesize, filesizeLimit) : undefined,\n        ContentType: mimeType,\n        IfNoneMatch: '*',\n        Key: storageFilePath,\n      }),\n      {\n        expiresIn: 600,\n        signableHeaders,\n      },\n    )\n\n    return {\n      type: 'http',\n      file: {\n        filename: sanitizedFilename,\n        mimeType,\n        size: filesize,\n        uploadReference,\n      },\n      request: {\n        headers: {\n          'Content-Length': String(filesize),\n          'Content-Type': mimeType,\n          'If-None-Match': '*',\n        },\n        method: 'PUT',\n        url,\n      },\n    }\n  }\n}\n"],"names":["PutObjectCommand","getSignedUrl","resolveSignedURLKey","Forbidden","assertClientUploadAllowed","generateUploadInstructions","access","acl","bucket","collectionPrefix","getStorageClient","useCompositePrefixes","collectionSlug","docPrefix","filename","filesize","mimeType","overrideAccess","req","user","t","collection","payload","collections","config","filesizeLimit","upload","limits","fileSize","Infinity","undefined","sanitizedFilename","storageFilePath","uploadReference","signableHeaders","Set","add","url","ACL","Bucket","ContentLength","Math","min","ContentType","IfNoneMatch","Key","expiresIn","type","file","size","request","headers","String","method"],"mappings":"AAGA,SAASA,gBAAgB,QAAQ,qBAAoB;AACrD,SAASC,YAAY,QAAQ,gCAA+B;AAC5D,SAASC,mBAAmB,QAAQ,6CAA4C;AAChF,SAASC,SAAS,QAAQ,UAAS;AACnC,SAASC,yBAAyB,QAAQ,mBAAkB;AAW5D,OAAO,MAAMC,6BAA6B,CAAC,EACzCC,MAAM,EACNC,GAAG,EACHC,MAAM,EACNC,gBAAgB,EAChBC,gBAAgB,EAChBC,uBAAuB,KAAK,EACvB;IACL,OAAO,OAAO,EACZC,cAAc,EACdC,SAAS,EACTC,QAAQ,EACRC,QAAQ,EACRC,QAAQ,EACRC,cAAc,EACdC,GAAG,EACJ;QACC,IAAI,CAACD,kBAAmBX,CAAAA,SAAS,CAAE,MAAMA,OAAO;YAAEM;YAAgBM;QAAI,KAAM,CAACA,IAAIC,IAAI,AAAD,GAAI;YACtF,MAAM,IAAIhB,UAAUe,IAAIE,CAAC;QAC3B;QAEAhB,0BAA0B;YACxBiB,YAAYH,IAAII,OAAO,CAACC,WAAW,CAACX,eAAe,EAAEY;YACrDV;YACAE;QACF;QACA,IAAIS,gBAAgBP,IAAII,OAAO,CAACE,MAAM,CAACE,MAAM,CAACC,MAAM,EAAEC;QAEtD,IAAIH,kBAAkBI,UAAU;YAC9BJ,gBAAgBK;QAClB;QAEA,MAAM,EAAEC,iBAAiB,EAAEC,eAAe,EAAEC,eAAe,EAAE,GAAG,MAAM/B,oBAAoB;YACxFO;YACAG;YACAC;YACAC;YACAI;YACAP;QACF;QAEA,MAAMuB,kBAAkB,IAAIC,IAAY;YAAC;SAAe;QAExD,IAAIV,eAAe;YACjB,6BAA6B;YAC7BS,gBAAgBE,GAAG,CAAC;QACtB;QAEA,MAAMC,MAAM,MAAMpC,aAChBS,oBACA,IAAIV,iBAAiB;YACnBsC,KAAK/B;YACLgC,QAAQ/B;YACRgC,eAAef,gBAAgBgB,KAAKC,GAAG,CAAC3B,UAAUU,iBAAiBK;YACnEa,aAAa3B;YACb4B,aAAa;YACbC,KAAKb;QACP,IACA;YACEc,WAAW;YACXZ;QACF;QAGF,OAAO;YACLa,MAAM;YACNC,MAAM;gBACJlC,UAAUiB;gBACVf;gBACAiC,MAAMlC;gBACNkB;YACF;YACAiB,SAAS;gBACPC,SAAS;oBACP,kBAAkBC,OAAOrC;oBACzB,gBAAgBC;oBAChB,iBAAiB;gBACnB;gBACAqC,QAAQ;gBACRhB;YACF;QACF;IACF;AACF,EAAC"}

package/dist/getFile.d.ts

@@ -1,5 +1,5 @@
 import type * as AWS from '@aws-sdk/client-s3';
-import type { CollectionConfig, PayloadRequest } from 'payload';
+import type { CollectionConfig, FileHandlerOperation, PayloadRequest, TypeWithID } from 'payload';
 export type SignedDownloadsConfig = {
     /** @default 7200 */
     expiresIn?: number;
@@ -12,16 +12,17 @@ export type SignedDownloadsConfig = {
 interface GetFileArgs {
     bucket: string;
     client: AWS.S3;
-    clientUploadContext?: unknown;
     collection: CollectionConfig;
     collectionPrefix?: string;
+    doc?: TypeWithID;
     filename: string;
     incomingHeaders?: Headers;
-    prefixQueryParam?: string;
+    operation?: FileHandlerOperation;
     req: PayloadRequest;
     signedDownloads: SignedDownloadsConfig;
+    uploadReference?: unknown;
     useCompositePrefixes?: boolean;
 }
-export declare function getFile({ bucket, client, clientUploadContext, collection, collectionPrefix, filename, incomingHeaders, prefixQueryParam, req, signedDownloads, useCompositePrefixes, }: GetFileArgs): Promise<Response>;
+export declare function getFile({ bucket, client, collection, collectionPrefix, doc, filename, incomingHeaders, operation, req, signedDownloads, uploadReference, useCompositePrefixes, }: GetFileArgs): Promise<Response>;
 export {};
 //# sourceMappingURL=getFile.d.ts.map

package/dist/getFile.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getFile.d.ts","sourceRoot":"","sources":["../src/getFile.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,GAAG,MAAM,oBAAoB,CAAA;AAC9C,OAAO,KAAK,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAW/D,MAAM,MAAM,qBAAqB,GAC7B;IACE,oBAAoB;IACpB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,kBAAkB,CAAC,CAAC,IAAI,EAAE;QACxB,UAAU,EAAE,gBAAgB,CAAA;QAC5B,QAAQ,EAAE,MAAM,CAAA;QAChB,GAAG,EAAE,cAAc,CAAA;KACpB,GAAG,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;CAC/B,GACD,OAAO,CAAA;AAEX,UAAU,WAAW;IACnB,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,GAAG,CAAC,EAAE,CAAA;IACd,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B,UAAU,EAAE,gBAAgB,CAAA;IAC5B,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,QAAQ,EAAE,MAAM,CAAA;IAChB,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,GAAG,EAAE,cAAc,CAAA;IACnB,eAAe,EAAE,qBAAqB,CAAA;IACtC,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B;AA8BD,wBAAsB,OAAO,CAAC,EAC5B,MAAM,EACN,MAAM,EACN,mBAAmB,EACnB,UAAU,EACV,gBAAqB,EACrB,QAAQ,EACR,eAAe,EACf,gBAAgB,EAChB,GAAG,EACH,eAAe,EACf,oBAA4B,GAC7B,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC,CA8JjC"}
+{"version":3,"file":"getFile.d.ts","sourceRoot":"","sources":["../src/getFile.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,GAAG,MAAM,oBAAoB,CAAA;AAC9C,OAAO,KAAK,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AAWjG,MAAM,MAAM,qBAAqB,GAC7B;IACE,oBAAoB;IACpB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,kBAAkB,CAAC,CAAC,IAAI,EAAE;QACxB,UAAU,EAAE,gBAAgB,CAAA;QAC5B,QAAQ,EAAE,MAAM,CAAA;QAChB,GAAG,EAAE,cAAc,CAAA;KACpB,GAAG,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;CAC/B,GACD,OAAO,CAAA;AAEX,UAAU,WAAW;IACnB,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,GAAG,CAAC,EAAE,CAAA;IACd,UAAU,EAAE,gBAAgB,CAAA;IAC5B,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,GAAG,CAAC,EAAE,UAAU,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,SAAS,CAAC,EAAE,oBAAoB,CAAA;IAChC,GAAG,EAAE,cAAc,CAAA;IACnB,eAAe,EAAE,qBAAqB,CAAA;IACtC,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B;AA8BD,wBAAsB,OAAO,CAAC,EAC5B,MAAM,EACN,MAAM,EACN,UAAU,EACV,gBAAqB,EACrB,GAAG,EACH,QAAQ,EACR,eAAe,EACf,SAAkB,EAClB,GAAG,EACH,eAAe,EACf,eAAe,EACf,oBAA4B,GAC7B,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC,CA+JjC"}