@payloadcms/plugin-cloud-storage 1.0.15 → 1.0.17-beta.0

package/src/adapters/s3/index.ts

@@ -1,38 +1,38 @@
-import * as AWS from '@aws-sdk/client-s3'
-import type { Adapter, GeneratedAdapter } from '../../types'
-import { getGenerateURL } from './generateURL'
-import { getHandler } from './staticHandler'
-import { getHandleDelete } from './handleDelete'
-import { getHandleUpload } from './handleUpload'
-import { extendWebpackConfig } from './webpack'
-
-export interface Args {
-  config: AWS.S3ClientConfig
-  bucket: string
-  acl?: 'private' | 'public-read'
-}
-
-export const s3Adapter =
-  ({ config, bucket, acl }: Args): Adapter =>
-  ({ 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 {
-      handleUpload: getHandleUpload({
-        collection,
-        getStorageClient,
-        bucket,
-        acl,
-        prefix,
-      }),
-      handleDelete: getHandleDelete({ getStorageClient, bucket }),
-      generateURL: getGenerateURL({ bucket, config }),
-      staticHandler: getHandler({ bucket, getStorageClient, collection }),
-      webpack: extendWebpackConfig,
-    }
-  }
+import * as AWS from '@aws-sdk/client-s3'
+import type { Adapter, GeneratedAdapter } from '../../types'
+import { getGenerateURL } from './generateURL'
+import { getHandler } from './staticHandler'
+import { getHandleDelete } from './handleDelete'
+import { getHandleUpload } from './handleUpload'
+import { extendWebpackConfig } from './webpack'
+
+export interface Args {
+  config: AWS.S3ClientConfig
+  bucket: string
+  acl?: 'private' | 'public-read'
+}
+
+export const s3Adapter =
+  ({ config, bucket, acl }: Args): Adapter =>
+  ({ 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 {
+      handleUpload: getHandleUpload({
+        collection,
+        getStorageClient,
+        bucket,
+        acl,
+        prefix,
+      }),
+      handleDelete: getHandleDelete({ getStorageClient, bucket }),
+      generateURL: getGenerateURL({ bucket, config }),
+      staticHandler: getHandler({ bucket, getStorageClient, collection }),
+      webpack: extendWebpackConfig,
+    }
+  }

package/src/adapters/s3/mock.js

@@ -1,9 +1,9 @@
-exports.S3 = () => null
-exports.Upload = () => null
-
-exports.HeadObjectCommand = () => null
-exports.PutObjectCommand = () => null
-exports.UploadPartCommand = () => null
-exports.CreateMultipartUploadCommand = () => null
-exports.CompleteMultipartUploadCommand = () => null
-exports.PutObjectTaggingCommand = () => null
+exports.S3 = () => null
+exports.Upload = () => null
+
+exports.HeadObjectCommand = () => null
+exports.PutObjectCommand = () => null
+exports.UploadPartCommand = () => null
+exports.CreateMultipartUploadCommand = () => null
+exports.CompleteMultipartUploadCommand = () => null
+exports.PutObjectTaggingCommand = () => null

package/src/adapters/s3/staticHandler.ts

@@ -1,40 +1,41 @@
-import path from 'path'
-import type { Readable } from 'stream'
-import type * as AWS from '@aws-sdk/client-s3'
-import type { CollectionConfig } from 'payload/types'
-import type { StaticHandler } from '../../types'
-import { getFilePrefix } from '../../utilities/getFilePrefix'
-
-interface Args {
-  getStorageClient: () => AWS.S3
-  bucket: string
-  collection: CollectionConfig
-}
-
-export const getHandler = ({ getStorageClient, bucket, collection }: Args): StaticHandler => {
-  return async (req, res, next) => {
-    try {
-      const prefix = await getFilePrefix({ req, collection })
-
-      const object = await getStorageClient().getObject({
-        Bucket: bucket,
-        Key: path.posix.join(prefix, req.params.filename),
-      })
-
-      res.set({
-        'Content-Length': object.ContentLength,
-        'Content-Type': object.ContentType,
-        ETag: object.ETag,
-      })
-
-      if (object?.Body) {
-        return (object.Body as Readable).pipe(res)
-      }
-
-      return next()
-    } catch (err: unknown) {
-      req.payload.logger.error(err)
-      return next()
-    }
-  }
-}
+import path from 'path'
+import type { Readable } from 'stream'
+import type * as AWS from '@aws-sdk/client-s3'
+import type { CollectionConfig } from 'payload/types'
+import type { StaticHandler } from '../../types'
+import { getFilePrefix } from '../../utilities/getFilePrefix'
+
+interface Args {
+  getStorageClient: () => AWS.S3
+  bucket: string
+  collection: CollectionConfig
+}
+
+export const getHandler = ({ getStorageClient, bucket, collection }: Args): StaticHandler => {
+  return async (req, res, next) => {
+    try {
+      const prefix = await getFilePrefix({ req, collection })
+
+      const object = await getStorageClient().getObject({
+        Bucket: bucket,
+        Key: path.posix.join(prefix, req.params.filename),
+      })
+
+      res.set({
+        'Accept-Ranges': object.AcceptRanges,
+        'Content-Length': object.ContentLength,
+        'Content-Type': object.ContentType,
+        ETag: object.ETag,
+      })
+
+      if (object?.Body) {
+        return (object.Body as Readable).pipe(res)
+      }
+
+      return next()
+    } catch (err: unknown) {
+      req.payload.logger.error(err)
+      return next()
+    }
+  }
+}

package/src/adapters/s3/webpack.ts

@@ -6,6 +6,10 @@ export const extendWebpackConfig = (existingWebpackConfig: WebpackConfig): Webpa
     ...existingWebpackConfig,
     resolve: {
       ...(existingWebpackConfig.resolve || {}),
+      fallback: {
+        ...(existingWebpackConfig.resolve?.fallback ? existingWebpackConfig.resolve.fallback : {}),
+        stream: false,
+      },
       alias: {
         ...(existingWebpackConfig.resolve?.alias ? existingWebpackConfig.resolve.alias : {}),
         '@aws-sdk/client-s3': path.resolve(__dirname, './mock.js'),

package/src/fields/getFields.ts

@@ -1,155 +1,155 @@
-import path from 'path'
-import type { GroupField, TextField } from 'payload/dist/fields/config/types'
-import type { CollectionConfig, Field } from 'payload/types'
-import { getAfterReadHook } from '../hooks/afterRead'
-import type { GeneratedAdapter, GenerateFileURL } from '../types'
-
-interface Args {
-  collection: CollectionConfig
-  disablePayloadAccessControl?: true
-  generateFileURL?: GenerateFileURL
-  prefix?: string
-  adapter: GeneratedAdapter
-}
-
-export const getFields = ({
-  adapter,
-  collection,
-  disablePayloadAccessControl,
-  generateFileURL,
-  prefix,
-}: Args): Field[] => {
-  const baseURLField: Field = {
-    name: 'url',
-    label: 'URL',
-    type: 'text',
-    admin: {
-      readOnly: true,
-      hidden: true,
-    },
-  }
-
-  const basePrefixField: Field = {
-    name: 'prefix',
-    type: 'text',
-    admin: {
-      readOnly: true,
-      hidden: true,
-    },
-  }
-
-  const fields = [...collection.fields]
-
-  // Inject a hook into all URL fields to generate URLs
-
-  let existingURLFieldIndex = -1
-
-  const existingURLField = fields.find((existingField, i) => {
-    if ('name' in existingField && existingField.name === 'url') {
-      existingURLFieldIndex = i
-      return true
-    }
-    return false
-  }) as TextField
-
-  if (existingURLFieldIndex > -1) {
-    fields.splice(existingURLFieldIndex, 1)
-  }
-
-  fields.push({
-    ...baseURLField,
-    ...(existingURLField || {}),
-    hooks: {
-      afterRead: [
-        getAfterReadHook({ adapter, collection, disablePayloadAccessControl, generateFileURL }),
-        ...(existingURLField?.hooks?.afterRead || []),
-      ],
-    },
-  })
-
-  if (typeof collection.upload === 'object' && collection.upload.imageSizes) {
-    let existingSizesFieldIndex = -1
-
-    const existingSizesField = fields.find((existingField, i) => {
-      if ('name' in existingField && existingField.name === 'sizes') {
-        existingSizesFieldIndex = i
-        return true
-      }
-
-      return false
-    }) as GroupField
-
-    if (existingSizesFieldIndex > -1) {
-      fields.splice(existingSizesFieldIndex, 1)
-    }
-
-    const sizesField: Field = {
-      ...(existingSizesField || {}),
-      name: 'sizes',
-      type: 'group',
-      admin: {
-        hidden: true,
-      },
-      fields: collection.upload.imageSizes.map(size => {
-        const existingSizeField = existingSizesField?.fields.find(
-          existingField => 'name' in existingField && existingField.name === size.name,
-        ) as GroupField
-
-        const existingSizeURLField = existingSizeField?.fields.find(
-          existingField => 'name' in existingField && existingField.name === 'url',
-        ) as GroupField
-
-        return {
-          ...existingSizeField,
-          name: size.name,
-          type: 'group',
-          fields: [
-            {
-              ...(existingSizeURLField || {}),
-              ...baseURLField,
-              hooks: {
-                afterRead: [
-                  getAfterReadHook({
-                    adapter,
-                    collection,
-                    size,
-                    disablePayloadAccessControl,
-                    generateFileURL,
-                  }),
-                  ...(existingSizeURLField?.hooks?.afterRead || []),
-                ],
-              },
-            },
-          ],
-        }
-      }),
-    }
-
-    fields.push(sizesField)
-  }
-
-  // If prefix is enabled, save it to db
-  if (prefix) {
-    let existingPrefixFieldIndex = -1
-
-    const existingPrefixField = fields.find((existingField, i) => {
-      if ('name' in existingField && existingField.name === 'prefix') {
-        existingPrefixFieldIndex = i
-        return true
-      }
-      return false
-    }) as TextField
-
-    if (existingPrefixFieldIndex > -1) {
-      fields.splice(existingPrefixFieldIndex, 1)
-    }
-
-    fields.push({
-      ...basePrefixField,
-      ...(existingPrefixField || {}),
-      defaultValue: path.posix.join(prefix),
-    })
-  }
-
-  return fields
-}
+import path from 'path'
+import type { GroupField, TextField } from 'payload/dist/fields/config/types'
+import type { CollectionConfig, Field } from 'payload/types'
+import { getAfterReadHook } from '../hooks/afterRead'
+import type { GeneratedAdapter, GenerateFileURL } from '../types'
+
+interface Args {
+  collection: CollectionConfig
+  disablePayloadAccessControl?: true
+  generateFileURL?: GenerateFileURL
+  prefix?: string
+  adapter: GeneratedAdapter
+}
+
+export const getFields = ({
+  adapter,
+  collection,
+  disablePayloadAccessControl,
+  generateFileURL,
+  prefix,
+}: Args): Field[] => {
+  const baseURLField: Field = {
+    name: 'url',
+    label: 'URL',
+    type: 'text',
+    admin: {
+      readOnly: true,
+      hidden: true,
+    },
+  }
+
+  const basePrefixField: Field = {
+    name: 'prefix',
+    type: 'text',
+    admin: {
+      readOnly: true,
+      hidden: true,
+    },
+  }
+
+  const fields = [...collection.fields]
+
+  // Inject a hook into all URL fields to generate URLs
+
+  let existingURLFieldIndex = -1
+
+  const existingURLField = fields.find((existingField, i) => {
+    if ('name' in existingField && existingField.name === 'url') {
+      existingURLFieldIndex = i
+      return true
+    }
+    return false
+  }) as TextField
+
+  if (existingURLFieldIndex > -1) {
+    fields.splice(existingURLFieldIndex, 1)
+  }
+
+  fields.push({
+    ...baseURLField,
+    ...(existingURLField || {}),
+    hooks: {
+      afterRead: [
+        getAfterReadHook({ adapter, collection, disablePayloadAccessControl, generateFileURL }),
+        ...(existingURLField?.hooks?.afterRead || []),
+      ],
+    },
+  })
+
+  if (typeof collection.upload === 'object' && collection.upload.imageSizes) {
+    let existingSizesFieldIndex = -1
+
+    const existingSizesField = fields.find((existingField, i) => {
+      if ('name' in existingField && existingField.name === 'sizes') {
+        existingSizesFieldIndex = i
+        return true
+      }
+
+      return false
+    }) as GroupField
+
+    if (existingSizesFieldIndex > -1) {
+      fields.splice(existingSizesFieldIndex, 1)
+    }
+
+    const sizesField: Field = {
+      ...(existingSizesField || {}),
+      name: 'sizes',
+      type: 'group',
+      admin: {
+        hidden: true,
+      },
+      fields: collection.upload.imageSizes.map(size => {
+        const existingSizeField = existingSizesField?.fields.find(
+          existingField => 'name' in existingField && existingField.name === size.name,
+        ) as GroupField
+
+        const existingSizeURLField = existingSizeField?.fields.find(
+          existingField => 'name' in existingField && existingField.name === 'url',
+        ) as GroupField
+
+        return {
+          ...existingSizeField,
+          name: size.name,
+          type: 'group',
+          fields: [
+            {
+              ...(existingSizeURLField || {}),
+              ...baseURLField,
+              hooks: {
+                afterRead: [
+                  getAfterReadHook({
+                    adapter,
+                    collection,
+                    size,
+                    disablePayloadAccessControl,
+                    generateFileURL,
+                  }),
+                  ...(existingSizeURLField?.hooks?.afterRead || []),
+                ],
+              },
+            },
+          ],
+        }
+      }),
+    }
+
+    fields.push(sizesField)
+  }
+
+  // If prefix is enabled, save it to db
+  if (prefix) {
+    let existingPrefixFieldIndex = -1
+
+    const existingPrefixField = fields.find((existingField, i) => {
+      if ('name' in existingField && existingField.name === 'prefix') {
+        existingPrefixFieldIndex = i
+        return true
+      }
+      return false
+    }) as TextField
+
+    if (existingPrefixFieldIndex > -1) {
+      fields.splice(existingPrefixFieldIndex, 1)
+    }
+
+    fields.push({
+      ...basePrefixField,
+      ...(existingPrefixField || {}),
+      defaultValue: path.posix.join(prefix),
+    })
+  }
+
+  return fields
+}

package/src/hooks/afterDelete.ts

@@ -1,35 +1,35 @@
-import type { TypeWithID } from 'payload/dist/globals/config/types'
-import type { FileData } from 'payload/dist/uploads/types'
-import type { CollectionAfterDeleteHook, CollectionConfig } from 'payload/types'
-import type { GeneratedAdapter, TypeWithPrefix } from '../types'
-
-interface Args {
-  collection: CollectionConfig
-  adapter: GeneratedAdapter
-}
-
-export const getAfterDeleteHook = ({
-  collection,
-  adapter,
-}: Args): CollectionAfterDeleteHook<FileData & TypeWithID & TypeWithPrefix> => {
-  return async ({ req, doc }) => {
-    try {
-      const filesToDelete: string[] = [
-        doc.filename,
-        ...Object.values(doc?.sizes || []).map(resizedFileData => resizedFileData?.filename),
-      ]
-
-      const promises = filesToDelete.map(async filename => {
-        await adapter.handleDelete({ collection, doc, req, filename })
-      })
-
-      await Promise.all(promises)
-    } catch (err: unknown) {
-      req.payload.logger.error(
-        `There was an error while deleting files corresponding to the ${collection.labels?.singular} with ID ${doc.id}:`,
-      )
-      req.payload.logger.error(err)
-    }
-    return doc
-  }
-}
+import type { TypeWithID } from 'payload/dist/globals/config/types'
+import type { FileData } from 'payload/dist/uploads/types'
+import type { CollectionAfterDeleteHook, CollectionConfig } from 'payload/types'
+import type { GeneratedAdapter, TypeWithPrefix } from '../types'
+
+interface Args {
+  collection: CollectionConfig
+  adapter: GeneratedAdapter
+}
+
+export const getAfterDeleteHook = ({
+  collection,
+  adapter,
+}: Args): CollectionAfterDeleteHook<FileData & TypeWithID & TypeWithPrefix> => {
+  return async ({ req, doc }) => {
+    try {
+      const filesToDelete: string[] = [
+        doc.filename,
+        ...Object.values(doc?.sizes || []).map(resizedFileData => resizedFileData?.filename),
+      ]
+
+      const promises = filesToDelete.map(async filename => {
+        if (filename) await adapter.handleDelete({ collection, doc, req, filename })
+      })
+
+      await Promise.all(promises)
+    } catch (err: unknown) {
+      req.payload.logger.error(
+        `There was an error while deleting files corresponding to the ${collection.labels?.singular} with ID ${doc.id}:`,
+      )
+      req.payload.logger.error(err)
+    }
+    return doc
+  }
+}

package/src/hooks/afterRead.ts

@@ -1,38 +1,38 @@
-import type { ImageSize } from 'payload/dist/uploads/types'
-import type { CollectionConfig, FieldHook } from 'payload/types'
-import type { GeneratedAdapter, GenerateFileURL } from '../types'
-
-interface Args {
-  collection: CollectionConfig
-  adapter: GeneratedAdapter
-  disablePayloadAccessControl?: boolean
-  size?: ImageSize
-  generateFileURL?: GenerateFileURL
-}
-
-export const getAfterReadHook =
-  ({ collection, adapter, size, disablePayloadAccessControl, generateFileURL }: Args): FieldHook =>
-  async ({ data, value }) => {
-    const filename = size ? data?.sizes?.[size.name]?.filename : data?.filename
-    const prefix = data?.prefix
-    let url = value
-
-    if (disablePayloadAccessControl && filename) {
-      url = await adapter.generateURL({
-        collection,
-        filename,
-        prefix,
-      })
-    }
-
-    if (generateFileURL) {
-      url = await generateFileURL({
-        collection,
-        filename,
-        prefix,
-        size,
-      })
-    }
-
-    return url
-  }
+import type { ImageSize } from 'payload/dist/uploads/types'
+import type { CollectionConfig, FieldHook } from 'payload/types'
+import type { GeneratedAdapter, GenerateFileURL } from '../types'
+
+interface Args {
+  collection: CollectionConfig
+  adapter: GeneratedAdapter
+  disablePayloadAccessControl?: boolean
+  size?: ImageSize
+  generateFileURL?: GenerateFileURL
+}
+
+export const getAfterReadHook =
+  ({ collection, adapter, size, disablePayloadAccessControl, generateFileURL }: Args): FieldHook =>
+  async ({ data, value }) => {
+    const filename = size ? data?.sizes?.[size.name]?.filename : data?.filename
+    const prefix = data?.prefix
+    let url = value
+
+    if (disablePayloadAccessControl && filename) {
+      url = await adapter.generateURL({
+        collection,
+        filename,
+        prefix,
+      })
+    }
+
+    if (generateFileURL) {
+      url = await generateFileURL({
+        collection,
+        filename,
+        prefix,
+        size,
+      })
+    }
+
+    return url
+  }