@payloadcms/storage-s3 3.0.0-alpha.62

package/LICENSE.md

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2018-2022 Payload CMS, LLC <info@payloadcms.com>
+Portions Copyright (c) Meta Platforms, Inc. and affiliates.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1 @@
+# Nodemailer Email Adapter

package/dist/generateURL.d.ts

@@ -0,0 +1,9 @@
+import type * as AWS from '@aws-sdk/client-s3';
+import type { GenerateURL } from '@payloadcms/plugin-cloud-storage/types';
+interface Args {
+    bucket: string;
+    config: AWS.S3ClientConfig;
+}
+export declare const getGenerateURL: ({ bucket, config: { endpoint } }: Args) => GenerateURL;
+export {};
+//# sourceMappingURL=generateURL.d.ts.map

package/dist/generateURL.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateURL.d.ts","sourceRoot":"","sources":["../src/generateURL.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,GAAG,MAAM,oBAAoB,CAAA;AAC9C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wCAAwC,CAAA;AAIzE,UAAU,IAAI;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,GAAG,CAAC,cAAc,CAAA;CAC3B;AAED,eAAO,MAAM,cAAc,qCACU,IAAI,KAAG,WAIzC,CAAA"}

package/dist/generateURL.js

@@ -0,0 +1,7 @@
+import path from 'path';
+export const getGenerateURL = ({ bucket, config: { endpoint } })=>({ filename, prefix = '' })=>{
+        const stringifiedEndpoint = typeof endpoint === 'string' ? endpoint : endpoint?.toString();
+        return `${stringifiedEndpoint}/${bucket}/${path.posix.join(prefix, filename)}`;
+    };
+
+//# sourceMappingURL=generateURL.js.map

package/dist/generateURL.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/generateURL.ts"],"sourcesContent":["import type * as AWS from '@aws-sdk/client-s3'\nimport type { GenerateURL } from '@payloadcms/plugin-cloud-storage/types'\n\nimport path from 'path'\n\ninterface Args {\n  bucket: string\n  config: AWS.S3ClientConfig\n}\n\nexport const getGenerateURL =\n  ({ bucket, config: { endpoint } }: Args): GenerateURL =>\n  ({ filename, prefix = '' }) => {\n    const stringifiedEndpoint = typeof endpoint === 'string' ? endpoint : endpoint?.toString()\n    return `${stringifiedEndpoint}/${bucket}/${path.posix.join(prefix, filename)}`\n  }\n"],"names":["path","getGenerateURL","bucket","config","endpoint","filename","prefix","stringifiedEndpoint","toString","posix","join"],"rangeMappings":";;;;","mappings":"AAGA,OAAOA,UAAU,OAAM;AAOvB,OAAO,MAAMC,iBACX,CAAC,EAAEC,MAAM,EAAEC,QAAQ,EAAEC,QAAQ,EAAE,EAAQ,GACvC,CAAC,EAAEC,QAAQ,EAAEC,SAAS,EAAE,EAAE;QACxB,MAAMC,sBAAsB,OAAOH,aAAa,WAAWA,WAAWA,UAAUI;QAChF,OAAO,CAAC,EAAED,oBAAoB,CAAC,EAAEL,OAAO,CAAC,EAAEF,KAAKS,KAAK,CAACC,IAAI,CAACJ,QAAQD,UAAU,CAAC;IAChF,EAAC"}

package/dist/handleDelete.d.ts

@@ -0,0 +1,9 @@
+import type * as AWS from '@aws-sdk/client-s3';
+import type { HandleDelete } from '@payloadcms/plugin-cloud-storage/types';
+interface Args {
+    bucket: string;
+    getStorageClient: () => AWS.S3;
+}
+export declare const getHandleDelete: ({ bucket, getStorageClient }: Args) => HandleDelete;
+export {};
+//# sourceMappingURL=handleDelete.d.ts.map

package/dist/handleDelete.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"handleDelete.d.ts","sourceRoot":"","sources":["../src/handleDelete.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,GAAG,MAAM,oBAAoB,CAAA;AAC9C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wCAAwC,CAAA;AAI1E,UAAU,IAAI;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,gBAAgB,EAAE,MAAM,GAAG,CAAC,EAAE,CAAA;CAC/B;AAED,eAAO,MAAM,eAAe,iCAAkC,IAAI,KAAG,YAOpE,CAAA"}

package/dist/handleDelete.js

@@ -0,0 +1,11 @@
+import path from 'path';
+export const getHandleDelete = ({ bucket, getStorageClient })=>{
+    return async ({ doc: { prefix = '' }, filename })=>{
+        await getStorageClient().deleteObject({
+            Bucket: bucket,
+            Key: path.posix.join(prefix, filename)
+        });
+    };
+};
+
+//# sourceMappingURL=handleDelete.js.map

package/dist/handleDelete.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/handleDelete.ts"],"sourcesContent":["import type * as AWS from '@aws-sdk/client-s3'\nimport type { HandleDelete } from '@payloadcms/plugin-cloud-storage/types'\n\nimport path from 'path'\n\ninterface Args {\n  bucket: string\n  getStorageClient: () => AWS.S3\n}\n\nexport const getHandleDelete = ({ bucket, getStorageClient }: Args): HandleDelete => {\n  return async ({ doc: { prefix = '' }, filename }) => {\n    await getStorageClient().deleteObject({\n      Bucket: bucket,\n      Key: path.posix.join(prefix, filename),\n    })\n  }\n}\n"],"names":["path","getHandleDelete","bucket","getStorageClient","doc","prefix","filename","deleteObject","Bucket","Key","posix","join"],"rangeMappings":";;;;;;;;","mappings":"AAGA,OAAOA,UAAU,OAAM;AAOvB,OAAO,MAAMC,kBAAkB,CAAC,EAAEC,MAAM,EAAEC,gBAAgB,EAAQ;IAChE,OAAO,OAAO,EAAEC,KAAK,EAAEC,SAAS,EAAE,EAAE,EAAEC,QAAQ,EAAE;QAC9C,MAAMH,mBAAmBI,YAAY,CAAC;YACpCC,QAAQN;YACRO,KAAKT,KAAKU,KAAK,CAACC,IAAI,CAACN,QAAQC;QAC/B;IACF;AACF,EAAC"}

package/dist/handleUpload.d.ts

@@ -0,0 +1,13 @@
+import type * as AWS from '@aws-sdk/client-s3';
+import type { HandleUpload } from '@payloadcms/plugin-cloud-storage/types';
+import type { CollectionConfig } from 'payload/types';
+interface Args {
+    acl?: 'private' | 'public-read';
+    bucket: string;
+    collection: CollectionConfig;
+    getStorageClient: () => AWS.S3;
+    prefix?: string;
+}
+export declare const getHandleUpload: ({ acl, bucket, getStorageClient, prefix, }: Args) => HandleUpload;
+export {};
+//# sourceMappingURL=handleUpload.d.ts.map

package/dist/handleUpload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"handleUpload.d.ts","sourceRoot":"","sources":["../src/handleUpload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,GAAG,MAAM,oBAAoB,CAAA;AAC9C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wCAAwC,CAAA;AAC1E,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAA;AAMrD,UAAU,IAAI;IACZ,GAAG,CAAC,EAAE,SAAS,GAAG,aAAa,CAAA;IAC/B,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,gBAAgB,CAAA;IAC5B,gBAAgB,EAAE,MAAM,GAAG,CAAC,EAAE,CAAA;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAID,eAAO,MAAM,eAAe,+CAKzB,IAAI,KAAG,YAqCT,CAAA"}

package/dist/handleUpload.js

@@ -0,0 +1,37 @@
+import { Upload } from '@aws-sdk/lib-storage';
+import fs from 'fs';
+import path from 'path';
+const multipartThreshold = 1024 * 1024 * 50 // 50MB
+;
+export const getHandleUpload = ({ acl, bucket, getStorageClient, prefix = '' })=>{
+    return async ({ data, file })=>{
+        const fileKey = path.posix.join(data.prefix || prefix, file.filename);
+        const fileBufferOrStream = file.tempFilePath ? fs.createReadStream(file.tempFilePath) : file.buffer;
+        if (file.buffer.length > 0 && file.buffer.length < multipartThreshold) {
+            await getStorageClient().putObject({
+                ACL: acl,
+                Body: fileBufferOrStream,
+                Bucket: bucket,
+                ContentType: file.mimeType,
+                Key: fileKey
+            });
+            return data;
+        }
+        const parallelUploadS3 = new Upload({
+            client: getStorageClient(),
+            params: {
+                ACL: acl,
+                Body: fileBufferOrStream,
+                Bucket: bucket,
+                ContentType: file.mimeType,
+                Key: fileKey
+            },
+            partSize: multipartThreshold,
+            queueSize: 4
+        });
+        await parallelUploadS3.done();
+        return data;
+    };
+};
+
+//# sourceMappingURL=handleUpload.js.map

package/dist/handleUpload.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/handleUpload.ts"],"sourcesContent":["import type * as AWS from '@aws-sdk/client-s3'\nimport type { HandleUpload } from '@payloadcms/plugin-cloud-storage/types'\nimport type { CollectionConfig } from 'payload/types'\n\nimport { Upload } from '@aws-sdk/lib-storage'\nimport fs from 'fs'\nimport path from 'path'\n\ninterface Args {\n  acl?: 'private' | 'public-read'\n  bucket: string\n  collection: CollectionConfig\n  getStorageClient: () => AWS.S3\n  prefix?: string\n}\n\nconst multipartThreshold = 1024 * 1024 * 50 // 50MB\n\nexport const getHandleUpload = ({\n  acl,\n  bucket,\n  getStorageClient,\n  prefix = '',\n}: Args): HandleUpload => {\n  return async ({ data, file }) => {\n    const fileKey = path.posix.join(data.prefix || prefix, file.filename)\n\n    const fileBufferOrStream = file.tempFilePath\n      ? fs.createReadStream(file.tempFilePath)\n      : file.buffer\n\n    if (file.buffer.length > 0 && file.buffer.length < multipartThreshold) {\n      await getStorageClient().putObject({\n        ACL: acl,\n        Body: fileBufferOrStream,\n        Bucket: bucket,\n        ContentType: file.mimeType,\n        Key: fileKey,\n      })\n\n      return data\n    }\n\n    const parallelUploadS3 = new Upload({\n      client: getStorageClient(),\n      params: {\n        ACL: acl,\n        Body: fileBufferOrStream,\n        Bucket: bucket,\n        ContentType: file.mimeType,\n        Key: fileKey,\n      },\n      partSize: multipartThreshold,\n      queueSize: 4,\n    })\n\n    await parallelUploadS3.done()\n\n    return data\n  }\n}\n"],"names":["Upload","fs","path","multipartThreshold","getHandleUpload","acl","bucket","getStorageClient","prefix","data","file","fileKey","posix","join","filename","fileBufferOrStream","tempFilePath","createReadStream","buffer","length","putObject","ACL","Body","Bucket","ContentType","mimeType","Key","parallelUploadS3","client","params","partSize","queueSize","done"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":"AAIA,SAASA,MAAM,QAAQ,uBAAsB;AAC7C,OAAOC,QAAQ,KAAI;AACnB,OAAOC,UAAU,OAAM;AAUvB,MAAMC,qBAAqB,OAAO,OAAO,GAAG,OAAO;;AAEnD,OAAO,MAAMC,kBAAkB,CAAC,EAC9BC,GAAG,EACHC,MAAM,EACNC,gBAAgB,EAChBC,SAAS,EAAE,EACN;IACL,OAAO,OAAO,EAAEC,IAAI,EAAEC,IAAI,EAAE;QAC1B,MAAMC,UAAUT,KAAKU,KAAK,CAACC,IAAI,CAACJ,KAAKD,MAAM,IAAIA,QAAQE,KAAKI,QAAQ;QAEpE,MAAMC,qBAAqBL,KAAKM,YAAY,GACxCf,GAAGgB,gBAAgB,CAACP,KAAKM,YAAY,IACrCN,KAAKQ,MAAM;QAEf,IAAIR,KAAKQ,MAAM,CAACC,MAAM,GAAG,KAAKT,KAAKQ,MAAM,CAACC,MAAM,GAAGhB,oBAAoB;YACrE,MAAMI,mBAAmBa,SAAS,CAAC;gBACjCC,KAAKhB;gBACLiB,MAAMP;gBACNQ,QAAQjB;gBACRkB,aAAad,KAAKe,QAAQ;gBAC1BC,KAAKf;YACP;YAEA,OAAOF;QACT;QAEA,MAAMkB,mBAAmB,IAAI3B,OAAO;YAClC4B,QAAQrB;YACRsB,QAAQ;gBACNR,KAAKhB;gBACLiB,MAAMP;gBACNQ,QAAQjB;gBACRkB,aAAad,KAAKe,QAAQ;gBAC1BC,KAAKf;YACP;YACAmB,UAAU3B;YACV4B,WAAW;QACb;QAEA,MAAMJ,iBAAiBK,IAAI;QAE3B,OAAOvB;IACT;AACF,EAAC"}

package/dist/index.d.ts

@@ -0,0 +1,41 @@
+import type { CollectionOptions } from '@payloadcms/plugin-cloud-storage/types';
+import type { Plugin } from 'payload/config';
+import * as AWS from '@aws-sdk/client-s3';
+export type S3StorageOptions = {
+    /**
+     * Access control list for uploaded files.
+     */
+    acl?: 'private' | 'public-read';
+    /**
+     * Bucket name to upload files to.
+     *
+     * Must follow [AWS S3 bucket naming conventions](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html).
+     */
+    bucket: string;
+    /**
+     * Collection options to apply the S3 adapter to.
+     */
+    collections: Record<string, Omit<CollectionOptions, 'adapter'> | true>;
+    /**
+     * AWS S3 client configuration. Highly dependent on your AWS setup.
+     *
+     * [AWS.S3ClientConfig Docs](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-s3/interfaces/s3clientconfig.html)
+     */
+    config: AWS.S3ClientConfig;
+    /**
+     * Whether or not to disable local storage
+     *
+     * @default true
+     */
+    disableLocalStorage?: boolean;
+    /**
+     * Whether or not to enable the plugin
+     *
+     * Default: true
+     */
+    enabled?: boolean;
+};
+type S3StoragePlugin = (storageS3Args: S3StorageOptions) => Plugin;
+export declare const s3Storage: S3StoragePlugin;
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAGV,iBAAiB,EAElB,MAAM,wCAAwC,CAAA;AAC/C,OAAO,KAAK,EAAU,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAEpD,OAAO,KAAK,GAAG,MAAM,oBAAoB,CAAA;AAQzC,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IAEH,GAAG,CAAC,EAAE,SAAS,GAAG,aAAa,CAAA;IAC/B;;;;OAIG;IAEH,MAAM,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,iBAAiB,EAAE,SAAS,CAAC,GAAG,IAAI,CAAC,CAAA;IACtE;;;;OAIG;IACH,MAAM,EAAE,GAAG,CAAC,cAAc,CAAA;IAE1B;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAE7B;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,CAAA;AAED,KAAK,eAAe,GAAG,CAAC,aAAa,EAAE,gBAAgB,KAAK,MAAM,CAAA;AAElE,eAAO,MAAM,SAAS,EAAE,eA0BrB,CAAA"}

package/dist/index.js

@@ -0,0 +1,57 @@
+import * as AWS from '@aws-sdk/client-s3';
+import { cloudStorage } from '@payloadcms/plugin-cloud-storage';
+import { getGenerateURL } from './generateURL.js';
+import { getHandleDelete } from './handleDelete.js';
+import { getHandleUpload } from './handleUpload.js';
+import { getHandler } from './staticHandler.js';
+export const s3Storage = (s3StorageOptions)=>(incomingConfig)=>{
+        if (s3StorageOptions.enabled === false) {
+            return incomingConfig;
+        }
+        const adapter = s3StorageInternal(s3StorageOptions);
+        // Add adapter to each collection option object
+        const collectionsWithAdapter = Object.entries(s3StorageOptions.collections).reduce((acc, [slug, collOptions])=>({
+                ...acc,
+                [slug]: {
+                    ...collOptions === true ? {} : collOptions,
+                    adapter
+                }
+            }), {});
+        return cloudStorage({
+            collections: collectionsWithAdapter
+        })(incomingConfig);
+    };
+function s3StorageInternal({ acl, bucket, config = {} }) {
+    return ({ collection, prefix })=>{
+        let storageClient = null;
+        const getStorageClient = ()=>{
+            if (storageClient) return storageClient;
+            storageClient = new AWS.S3(config);
+            return storageClient;
+        };
+        return {
+            generateURL: getGenerateURL({
+                bucket,
+                config
+            }),
+            handleDelete: getHandleDelete({
+                bucket,
+                getStorageClient
+            }),
+            handleUpload: getHandleUpload({
+                acl,
+                bucket,
+                collection,
+                getStorageClient,
+                prefix
+            }),
+            staticHandler: getHandler({
+                bucket,
+                collection,
+                getStorageClient
+            })
+        };
+    };
+}
+
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type {\n  Adapter,\n  PluginOptions as CloudStoragePluginOptions,\n  CollectionOptions,\n  GeneratedAdapter,\n} from '@payloadcms/plugin-cloud-storage/types'\nimport type { Config, Plugin } from 'payload/config'\n\nimport * as AWS from '@aws-sdk/client-s3'\nimport { cloudStorage } from '@payloadcms/plugin-cloud-storage'\n\nimport { getGenerateURL } from './generateURL.js'\nimport { getHandleDelete } from './handleDelete.js'\nimport { getHandleUpload } from './handleUpload.js'\nimport { getHandler } from './staticHandler.js'\n\nexport type S3StorageOptions = {\n  /**\n   * Access control list for uploaded files.\n   */\n\n  acl?: 'private' | 'public-read'\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   * Collection options to apply the S3 adapter to.\n   */\n  collections: Record<string, Omit<CollectionOptions, 'adapter'> | true>\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\ntype S3StoragePlugin = (storageS3Args: S3StorageOptions) => Plugin\n\nexport const s3Storage: S3StoragePlugin =\n  (s3StorageOptions: S3StorageOptions) =>\n  (incomingConfig: Config): Config => {\n    if (s3StorageOptions.enabled === false) {\n      return incomingConfig\n    }\n\n    const adapter = s3StorageInternal(s3StorageOptions)\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,\n        },\n      }),\n      {} as Record<string, CollectionOptions>,\n    )\n\n    return cloudStorage({\n      collections: collectionsWithAdapter,\n    })(incomingConfig)\n  }\n\nfunction s3StorageInternal({ acl, bucket, config = {} }: S3StorageOptions): Adapter {\n  return ({ collection, prefix }): GeneratedAdapter => {\n    let storageClient: AWS.S3 | null = null\n    const getStorageClient: () => AWS.S3 = () => {\n      if (storageClient) return storageClient\n      storageClient = new AWS.S3(config)\n      return storageClient\n    }\n\n    return {\n      generateURL: getGenerateURL({ bucket, config }),\n      handleDelete: getHandleDelete({ bucket, getStorageClient }),\n      handleUpload: getHandleUpload({\n        acl,\n        bucket,\n        collection,\n        getStorageClient,\n        prefix,\n      }),\n      staticHandler: getHandler({ bucket, collection, getStorageClient }),\n    }\n  }\n}\n"],"names":["AWS","cloudStorage","getGenerateURL","getHandleDelete","getHandleUpload","getHandler","s3Storage","s3StorageOptions","incomingConfig","enabled","adapter","s3StorageInternal","collectionsWithAdapter","Object","entries","collections","reduce","acc","slug","collOptions","acl","bucket","config","collection","prefix","storageClient","getStorageClient","S3","generateURL","handleDelete","handleUpload","staticHandler"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":"AAQA,YAAYA,SAAS,qBAAoB;AACzC,SAASC,YAAY,QAAQ,mCAAkC;AAE/D,SAASC,cAAc,QAAQ,mBAAkB;AACjD,SAASC,eAAe,QAAQ,oBAAmB;AACnD,SAASC,eAAe,QAAQ,oBAAmB;AACnD,SAASC,UAAU,QAAQ,qBAAoB;AA4C/C,OAAO,MAAMC,YACX,CAACC,mBACD,CAACC;QACC,IAAID,iBAAiBE,OAAO,KAAK,OAAO;YACtC,OAAOD;QACT;QAEA,MAAME,UAAUC,kBAAkBJ;QAElC,+CAA+C;QAC/C,MAAMK,yBAAmEC,OAAOC,OAAO,CACrFP,iBAAiBQ,WAAW,EAC5BC,MAAM,CACN,CAACC,KAAK,CAACC,MAAMC,YAAY,GAAM,CAAA;gBAC7B,GAAGF,GAAG;gBACN,CAACC,KAAK,EAAE;oBACN,GAAIC,gBAAgB,OAAO,CAAC,IAAIA,WAAW;oBAC3CT;gBACF;YACF,CAAA,GACA,CAAC;QAGH,OAAOT,aAAa;YAClBc,aAAaH;QACf,GAAGJ;IACL,EAAC;AAEH,SAASG,kBAAkB,EAAES,GAAG,EAAEC,MAAM,EAAEC,SAAS,CAAC,CAAC,EAAoB;IACvE,OAAO,CAAC,EAAEC,UAAU,EAAEC,MAAM,EAAE;QAC5B,IAAIC,gBAA+B;QACnC,MAAMC,mBAAiC;YACrC,IAAID,eAAe,OAAOA;YAC1BA,gBAAgB,IAAIzB,IAAI2B,EAAE,CAACL;YAC3B,OAAOG;QACT;QAEA,OAAO;YACLG,aAAa1B,eAAe;gBAAEmB;gBAAQC;YAAO;YAC7CO,cAAc1B,gBAAgB;gBAAEkB;gBAAQK;YAAiB;YACzDI,cAAc1B,gBAAgB;gBAC5BgB;gBACAC;gBACAE;gBACAG;gBACAF;YACF;YACAO,eAAe1B,WAAW;gBAAEgB;gBAAQE;gBAAYG;YAAiB;QACnE;IACF;AACF"}

package/dist/staticHandler.d.ts

@@ -0,0 +1,11 @@
+import type * as AWS from '@aws-sdk/client-s3';
+import type { StaticHandler } from '@payloadcms/plugin-cloud-storage/types';
+import type { CollectionConfig } from 'payload/types';
+interface Args {
+    bucket: string;
+    collection: CollectionConfig;
+    getStorageClient: () => AWS.S3;
+}
+export declare const getHandler: ({ bucket, collection, getStorageClient }: Args) => StaticHandler;
+export {};
+//# sourceMappingURL=staticHandler.d.ts.map

package/dist/staticHandler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"staticHandler.d.ts","sourceRoot":"","sources":["../src/staticHandler.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,GAAG,MAAM,oBAAoB,CAAA;AAC9C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wCAAwC,CAAA;AAC3E,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAA;AAKrD,UAAU,IAAI;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,gBAAgB,CAAA;IAC5B,gBAAgB,EAAE,MAAM,GAAG,CAAC,EAAE,CAAA;CAC/B;AAYD,eAAO,MAAM,UAAU,6CAA8C,IAAI,KAAG,aA8B3E,CAAA"}

package/dist/staticHandler.js

@@ -0,0 +1,49 @@
+import { getFilePrefix } from '@payloadcms/plugin-cloud-storage/utilities';
+import path from 'path';
+// Convert a stream into a promise that resolves with a Buffer
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const streamToBuffer = async (readableStream)=>{
+    const chunks = [];
+    for await (const chunk of readableStream){
+        chunks.push(typeof chunk === 'string' ? Buffer.from(chunk) : chunk);
+    }
+    return Buffer.concat(chunks);
+};
+export const getHandler = ({ bucket, collection, getStorageClient })=>{
+    return async (req, { params: { filename } })=>{
+        try {
+            const prefix = await getFilePrefix({
+                collection,
+                filename,
+                req
+            });
+            const object = await getStorageClient().getObject({
+                Bucket: bucket,
+                Key: path.posix.join(prefix, filename)
+            });
+            if (!object.Body) {
+                return new Response(null, {
+                    status: 404,
+                    statusText: 'Not Found'
+                });
+            }
+            const bodyBuffer = await streamToBuffer(object.Body);
+            return new Response(bodyBuffer, {
+                headers: new Headers({
+                    'Accept-Ranges': String(object.AcceptRanges),
+                    'Content-Length': String(object.ContentLength),
+                    'Content-Type': String(object.ContentType),
+                    ETag: String(object.ETag)
+                }),
+                status: 200
+            });
+        } catch (err) {
+            req.payload.logger.error(err);
+            return new Response('Internal Server Error', {
+                status: 500
+            });
+        }
+    };
+};
+
+//# sourceMappingURL=staticHandler.js.map

package/dist/staticHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/staticHandler.ts"],"sourcesContent":["import type * as AWS from '@aws-sdk/client-s3'\nimport type { StaticHandler } from '@payloadcms/plugin-cloud-storage/types'\nimport type { CollectionConfig } from 'payload/types'\n\nimport { getFilePrefix } from '@payloadcms/plugin-cloud-storage/utilities'\nimport path from 'path'\n\ninterface Args {\n  bucket: string\n  collection: CollectionConfig\n  getStorageClient: () => AWS.S3\n}\n\n// Convert a stream into a promise that resolves with a Buffer\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nconst streamToBuffer = async (readableStream: any) => {\n  const chunks = []\n  for await (const chunk of readableStream) {\n    chunks.push(typeof chunk === 'string' ? Buffer.from(chunk) : chunk)\n  }\n  return Buffer.concat(chunks)\n}\n\nexport const getHandler = ({ bucket, collection, getStorageClient }: Args): StaticHandler => {\n  return async (req, { params: { filename } }) => {\n    try {\n      const prefix = await getFilePrefix({ collection, filename, req })\n\n      const object = await getStorageClient().getObject({\n        Bucket: bucket,\n        Key: path.posix.join(prefix, filename),\n      })\n\n      if (!object.Body) {\n        return new Response(null, { status: 404, statusText: 'Not Found' })\n      }\n\n      const bodyBuffer = await streamToBuffer(object.Body)\n\n      return new Response(bodyBuffer, {\n        headers: new Headers({\n          'Accept-Ranges': String(object.AcceptRanges),\n          'Content-Length': String(object.ContentLength),\n          'Content-Type': String(object.ContentType),\n          ETag: String(object.ETag),\n        }),\n        status: 200,\n      })\n    } catch (err) {\n      req.payload.logger.error(err)\n      return new Response('Internal Server Error', { status: 500 })\n    }\n  }\n}\n"],"names":["getFilePrefix","path","streamToBuffer","readableStream","chunks","chunk","push","Buffer","from","concat","getHandler","bucket","collection","getStorageClient","req","params","filename","prefix","object","getObject","Bucket","Key","posix","join","Body","Response","status","statusText","bodyBuffer","headers","Headers","String","AcceptRanges","ContentLength","ContentType","ETag","err","payload","logger","error"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":"AAIA,SAASA,aAAa,QAAQ,6CAA4C;AAC1E,OAAOC,UAAU,OAAM;AAQvB,8DAA8D;AAC9D,8DAA8D;AAC9D,MAAMC,iBAAiB,OAAOC;IAC5B,MAAMC,SAAS,EAAE;IACjB,WAAW,MAAMC,SAASF,eAAgB;QACxCC,OAAOE,IAAI,CAAC,OAAOD,UAAU,WAAWE,OAAOC,IAAI,CAACH,SAASA;IAC/D;IACA,OAAOE,OAAOE,MAAM,CAACL;AACvB;AAEA,OAAO,MAAMM,aAAa,CAAC,EAAEC,MAAM,EAAEC,UAAU,EAAEC,gBAAgB,EAAQ;IACvE,OAAO,OAAOC,KAAK,EAAEC,QAAQ,EAAEC,QAAQ,EAAE,EAAE;QACzC,IAAI;YACF,MAAMC,SAAS,MAAMjB,cAAc;gBAAEY;gBAAYI;gBAAUF;YAAI;YAE/D,MAAMI,SAAS,MAAML,mBAAmBM,SAAS,CAAC;gBAChDC,QAAQT;gBACRU,KAAKpB,KAAKqB,KAAK,CAACC,IAAI,CAACN,QAAQD;YAC/B;YAEA,IAAI,CAACE,OAAOM,IAAI,EAAE;gBAChB,OAAO,IAAIC,SAAS,MAAM;oBAAEC,QAAQ;oBAAKC,YAAY;gBAAY;YACnE;YAEA,MAAMC,aAAa,MAAM1B,eAAegB,OAAOM,IAAI;YAEnD,OAAO,IAAIC,SAASG,YAAY;gBAC9BC,SAAS,IAAIC,QAAQ;oBACnB,iBAAiBC,OAAOb,OAAOc,YAAY;oBAC3C,kBAAkBD,OAAOb,OAAOe,aAAa;oBAC7C,gBAAgBF,OAAOb,OAAOgB,WAAW;oBACzCC,MAAMJ,OAAOb,OAAOiB,IAAI;gBAC1B;gBACAT,QAAQ;YACV;QACF,EAAE,OAAOU,KAAK;YACZtB,IAAIuB,OAAO,CAACC,MAAM,CAACC,KAAK,CAACH;YACzB,OAAO,IAAIX,SAAS,yBAAyB;gBAAEC,QAAQ;YAAI;QAC7D;IACF;AACF,EAAC"}

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@payloadcms/storage-s3",
+  "version": "3.0.0-alpha.62",
+  "description": "Payload storage adapter for Amazon S3",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/payloadcms/payload.git",
+    "directory": "packages/storage-s3"
+  },
+  "license": "MIT",
+  "homepage": "https://payloadcms.com",
+  "author": "Payload CMS, Inc.",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "dependencies": {
+    "@payloadcms/plugin-cloud-storage": "3.0.0-alpha.62"
+  },
+  "devDependencies": {
+    "@aws-sdk/client-s3": "^3.525.0",
+    "@aws-sdk/lib-storage": "^3.525.0",
+    "payload": "3.0.0-alpha.62"
+  },
+  "peerDependencies": {
+    "payload": "3.0.0-alpha.62"
+  },
+  "engines": {
+    "node": ">=18.20.2"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "pnpm build:swc && pnpm build:types",
+    "build:swc": "swc ./src -d ./dist --config-file .swcrc",
+    "build:types": "tsc --emitDeclarationOnly --outDir dist",
+    "build:clean": "find . \\( -type d \\( -name build -o -name dist -o -name .cache \\) -o -type f -name tsconfig.tsbuildinfo \\) -exec rm -rf {} + && pnpm build",
+    "clean": "rimraf {dist,*.tsbuildinfo}"
+  }
+}

package/src/index.ts

@@ -0,0 +1,109 @@
+import type {
+  Adapter,
+  PluginOptions as CloudStoragePluginOptions,
+  CollectionOptions,
+  GeneratedAdapter,
+} from '@payloadcms/plugin-cloud-storage/types'
+import type { Config, Plugin } from 'payload/config'
+
+import * as AWS from '@aws-sdk/client-s3'
+import { cloudStorage } from '@payloadcms/plugin-cloud-storage'
+
+import { getGenerateURL } from './generateURL.js'
+import { getHandleDelete } from './handleDelete.js'
+import { getHandleUpload } from './handleUpload.js'
+import { getHandler } from './staticHandler.js'
+
+export type S3StorageOptions = {
+  /**
+   * Access control list for uploaded files.
+   */
+
+  acl?: 'private' | 'public-read'
+  /**
+   * Bucket name to upload files to.
+   *
+   * Must follow [AWS S3 bucket naming conventions](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html).
+   */
+
+  bucket: string
+
+  /**
+   * Collection options to apply the S3 adapter to.
+   */
+  collections: Record<string, Omit<CollectionOptions, 'adapter'> | true>
+  /**
+   * AWS S3 client configuration. Highly dependent on your AWS setup.
+   *
+   * [AWS.S3ClientConfig Docs](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-s3/interfaces/s3clientconfig.html)
+   */
+  config: AWS.S3ClientConfig
+
+  /**
+   * Whether or not to disable local storage
+   *
+   * @default true
+   */
+  disableLocalStorage?: boolean
+
+  /**
+   * Whether or not to enable the plugin
+   *
+   * Default: true
+   */
+  enabled?: boolean
+}
+
+type S3StoragePlugin = (storageS3Args: S3StorageOptions) => Plugin
+
+export const s3Storage: S3StoragePlugin =
+  (s3StorageOptions: S3StorageOptions) =>
+  (incomingConfig: Config): Config => {
+    if (s3StorageOptions.enabled === false) {
+      return incomingConfig
+    }
+
+    const adapter = s3StorageInternal(s3StorageOptions)
+
+    // Add adapter to each collection option object
+    const collectionsWithAdapter: CloudStoragePluginOptions['collections'] = Object.entries(
+      s3StorageOptions.collections,
+    ).reduce(
+      (acc, [slug, collOptions]) => ({
+        ...acc,
+        [slug]: {
+          ...(collOptions === true ? {} : collOptions),
+          adapter,
+        },
+      }),
+      {} as Record<string, CollectionOptions>,
+    )
+
+    return cloudStorage({
+      collections: collectionsWithAdapter,
+    })(incomingConfig)
+  }
+
+function s3StorageInternal({ acl, bucket, config = {} }: S3StorageOptions): Adapter {
+  return ({ collection, prefix }): GeneratedAdapter => {
+    let storageClient: AWS.S3 | null = null
+    const getStorageClient: () => AWS.S3 = () => {
+      if (storageClient) return storageClient
+      storageClient = new AWS.S3(config)
+      return storageClient
+    }
+
+    return {
+      generateURL: getGenerateURL({ bucket, config }),
+      handleDelete: getHandleDelete({ bucket, getStorageClient }),
+      handleUpload: getHandleUpload({
+        acl,
+        bucket,
+        collection,
+        getStorageClient,
+        prefix,
+      }),
+      staticHandler: getHandler({ bucket, collection, getStorageClient }),
+    }
+  }
+}