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

package/src/hooks/beforeChange.ts

@@ -1,30 +1,59 @@
-import type { TypeWithID } from 'payload/dist/collections/config/types'
-import type { FileData } from 'payload/dist/uploads/types'
-import type { CollectionBeforeChangeHook, CollectionConfig } from 'payload/types'
-import type { GeneratedAdapter } from '../types'
-import { getIncomingFiles } from '../utilities/getIncomingFiles'
-
-interface Args {
-  collection: CollectionConfig
-  adapter: GeneratedAdapter
-}
-
-export const getBeforeChangeHook =
-  ({ collection, adapter }: Args): CollectionBeforeChangeHook<FileData & TypeWithID> =>
-  async ({ req, data }) => {
-    try {
-      const files = getIncomingFiles({ req, data })
-
-      const promises = files.map(async file => {
-        await adapter.handleUpload({ collection, data, req, file })
-      })
-
-      await Promise.all(promises)
-    } catch (err: unknown) {
-      req.payload.logger.error(
-        `There was an error while uploading files corresponding to the collection ${collection.slug} with filename ${data.filename}:`,
-      )
-      req.payload.logger.error(err)
-    }
-    return data
-  }
+import type { TypeWithID } from 'payload/dist/collections/config/types'
+import type { FileData } from 'payload/dist/uploads/types'
+import type { CollectionBeforeChangeHook, CollectionConfig } from 'payload/types'
+import type { GeneratedAdapter } from '../types'
+import { getIncomingFiles } from '../utilities/getIncomingFiles'
+
+interface Args {
+  collection: CollectionConfig
+  adapter: GeneratedAdapter
+}
+
+export const getBeforeChangeHook =
+  ({ collection, adapter }: Args): CollectionBeforeChangeHook<FileData & TypeWithID> =>
+  async ({ req, data, originalDoc }) => {
+    try {
+      const files = getIncomingFiles({ req, data })
+
+      if (files.length > 0) {
+        // If there is an original doc,
+        // And we have new files,
+        // We need to delete the old files before uploading new
+        if (originalDoc) {
+          let filesToDelete: string[] = []
+
+          if (typeof originalDoc?.filename === 'string') {
+            filesToDelete.push(originalDoc.filename)
+          }
+
+          if (typeof originalDoc.sizes === 'object') {
+            filesToDelete = filesToDelete.concat(
+              Object.values(originalDoc?.sizes || []).map(
+                resizedFileData => resizedFileData?.filename,
+              ),
+            )
+          }
+
+          const deletionPromises = filesToDelete.map(async filename => {
+            if (filename) {
+              await adapter.handleDelete({ collection, doc: originalDoc, req, filename })
+            }
+          })
+
+          await Promise.all(deletionPromises)
+        }
+
+        const promises = files.map(async file => {
+          await adapter.handleUpload({ collection, data, req, file })
+        })
+
+        await Promise.all(promises)
+      }
+    } catch (err: unknown) {
+      req.payload.logger.error(
+        `There was an error while uploading files corresponding to the collection ${collection.slug} with filename ${data.filename}:`,
+      )
+      req.payload.logger.error(err)
+    }
+    return data
+  }

package/src/index.ts

@@ -1 +1 @@
-export { cloudStorage } from './plugin'
+export { cloudStorage } from './plugin'

package/src/plugin.ts

@@ -1,94 +1,101 @@
-import type { Config } from 'payload/config'
-import { extendWebpackConfig } from './webpack'
-import type { PluginOptions } from './types'
-import { getBeforeChangeHook } from './hooks/beforeChange'
-import { getAfterDeleteHook } from './hooks/afterDelete'
-import { getFields } from './fields/getFields'
-
-// This plugin extends all targeted collections by offloading uploaded files
-// to cloud storage instead of solely storing files locally.
-
-// It is based on an adapter approach, where adapters can be written for any cloud provider.
-// Adapters are responsible for providing four actions that this plugin will use:
-// 1. handleUpload, 2. handleDelete, 3. generateURL, 4. staticHandler
-
-// Optionally, the adapter can specify any Webpack config overrides if they are necessary.
-
-export const cloudStorage =
-  (pluginOptions: PluginOptions) =>
-  (config: Config): Config => {
-    const { collections: allCollectionOptions } = pluginOptions
-
-    const webpack = extendWebpackConfig({ options: pluginOptions, config })
-
-    const initFunctions: (() => void)[] = []
-
-    return {
-      ...config,
-      admin: {
-        ...(config.admin || {}),
-        webpack,
-      },
-      collections: (config.collections || []).map(existingCollection => {
-        const options = allCollectionOptions[existingCollection.slug]
-
-        if (options?.adapter) {
-          const adapter = options.adapter({
-            collection: existingCollection,
-            prefix: options.prefix,
-          })
-
-          if (adapter.onInit) initFunctions.push(adapter.onInit)
-
-          const fields = getFields({
-            collection: existingCollection,
-            disablePayloadAccessControl: options.disablePayloadAccessControl,
-            generateFileURL: options.generateFileURL,
-            prefix: options.prefix,
-            adapter,
-          })
-
-          const handlers = [
-            ...(typeof existingCollection.upload === 'object' &&
-            Array.isArray(existingCollection.upload.handlers)
-              ? existingCollection.upload.handlers
-              : []),
-          ]
-
-          if (!options.disablePayloadAccessControl) {
-            handlers.push(adapter.staticHandler)
-          }
-
-          return {
-            ...existingCollection,
-            upload: {
-              ...(typeof existingCollection.upload === 'object' ? existingCollection.upload : {}),
-              handlers,
-              disableLocalStorage:
-                typeof options.disableLocalStorage === 'boolean'
-                  ? options.disableLocalStorage
-                  : true,
-            },
-            hooks: {
-              ...(existingCollection.hooks || {}),
-              beforeChange: [
-                ...(existingCollection.hooks?.beforeChange || []),
-                getBeforeChangeHook({ adapter, collection: existingCollection }),
-              ],
-              afterDelete: [
-                ...(existingCollection.hooks?.afterDelete || []),
-                getAfterDeleteHook({ adapter, collection: existingCollection }),
-              ],
-            },
-            fields,
-          }
-        }
-
-        return existingCollection
-      }),
-      onInit: async payload => {
-        initFunctions.forEach(fn => fn())
-        if (config.onInit) await config.onInit(payload)
-      },
-    }
-  }
+import type { Config } from 'payload/config'
+import { extendWebpackConfig } from './webpack'
+import type { PluginOptions } from './types'
+import { getBeforeChangeHook } from './hooks/beforeChange'
+import { getAfterDeleteHook } from './hooks/afterDelete'
+import { getFields } from './fields/getFields'
+
+// This plugin extends all targeted collections by offloading uploaded files
+// to cloud storage instead of solely storing files locally.
+
+// It is based on an adapter approach, where adapters can be written for any cloud provider.
+// Adapters are responsible for providing four actions that this plugin will use:
+// 1. handleUpload, 2. handleDelete, 3. generateURL, 4. staticHandler
+
+// Optionally, the adapter can specify any Webpack config overrides if they are necessary.
+
+export const cloudStorage =
+  (pluginOptions: PluginOptions) =>
+  (incomingConfig: Config): Config => {
+    const { collections: allCollectionOptions, enabled } = pluginOptions
+    const config = { ...incomingConfig }
+
+    const webpack = extendWebpackConfig({ options: pluginOptions, config: incomingConfig })
+
+    config.admin = {
+      ...(config.admin || {}),
+      webpack,
+    }
+
+    // Return early if disabled. Only webpack config mods are applied.
+    if (enabled === false) {
+      return config
+    }
+
+    const initFunctions: Array<() => void> = []
+
+    return {
+      ...config,
+      collections: (config.collections || []).map(existingCollection => {
+        const options = allCollectionOptions[existingCollection.slug]
+
+        if (options?.adapter) {
+          const adapter = options.adapter({
+            collection: existingCollection,
+            prefix: options.prefix,
+          })
+
+          if (adapter.onInit) initFunctions.push(adapter.onInit)
+
+          const fields = getFields({
+            collection: existingCollection,
+            disablePayloadAccessControl: options.disablePayloadAccessControl,
+            generateFileURL: options.generateFileURL,
+            prefix: options.prefix,
+            adapter,
+          })
+
+          const handlers = [
+            ...(typeof existingCollection.upload === 'object' &&
+            Array.isArray(existingCollection.upload.handlers)
+              ? existingCollection.upload.handlers
+              : []),
+          ]
+
+          if (!options.disablePayloadAccessControl) {
+            handlers.push(adapter.staticHandler)
+          }
+
+          return {
+            ...existingCollection,
+            upload: {
+              ...(typeof existingCollection.upload === 'object' ? existingCollection.upload : {}),
+              handlers,
+              disableLocalStorage:
+                typeof options.disableLocalStorage === 'boolean'
+                  ? options.disableLocalStorage
+                  : true,
+            },
+            hooks: {
+              ...(existingCollection.hooks || {}),
+              beforeChange: [
+                ...(existingCollection.hooks?.beforeChange || []),
+                getBeforeChangeHook({ adapter, collection: existingCollection }),
+              ],
+              afterDelete: [
+                ...(existingCollection.hooks?.afterDelete || []),
+                getAfterDeleteHook({ adapter, collection: existingCollection }),
+              ],
+            },
+            fields,
+          }
+        }
+
+        return existingCollection
+      }),
+      onInit: async payload => {
+        initFunctions.forEach(fn => fn())
+        if (config.onInit) await config.onInit(payload)
+      },
+    }
+  }

package/src/types.ts

@@ -1,73 +1,79 @@
-import type { NextFunction, Response } from 'express'
-import type { TypeWithID } from 'payload/dist/collections/config/types'
-import type { FileData, ImageSize } from 'payload/dist/uploads/types'
-import type { CollectionConfig, PayloadRequest } from 'payload/types'
-import type { Configuration as WebpackConfig } from 'webpack'
-
-export interface File {
-  buffer: Buffer
-  filename: string
-  filesize: number
-  mimeType: string
-  tempFilePath?: string
-}
-
-export type HandleUpload = (args: {
-  collection: CollectionConfig
-  req: PayloadRequest
-  data: any
-  file: File
-}) => Promise<void> | void
-
-export interface TypeWithPrefix {
-  prefix?: string
-}
-
-export type HandleDelete = (args: {
-  collection: CollectionConfig
-  req: PayloadRequest
-  doc: TypeWithID & FileData & TypeWithPrefix
-  filename: string
-}) => Promise<void> | void
-
-export type GenerateURL = (args: {
-  filename: string
-  collection: CollectionConfig
-  prefix?: string
-}) => string | Promise<string>
-
-export type StaticHandler = (
-  req: PayloadRequest,
-  res: Response,
-  next: NextFunction,
-) => Promise<unknown> | unknown
-
-export interface GeneratedAdapter {
-  handleUpload: HandleUpload
-  handleDelete: HandleDelete
-  generateURL: GenerateURL
-  staticHandler: StaticHandler
-  webpack?: (config: WebpackConfig) => WebpackConfig
-  onInit?: () => void
-}
-
-export type Adapter = (args: { collection: CollectionConfig; prefix?: string }) => GeneratedAdapter
-
-export type GenerateFileURL = (args: {
-  collection: CollectionConfig
-  filename: string
-  prefix?: string
-  size?: ImageSize
-}) => Promise<string> | string
-
-export interface CollectionOptions {
-  disableLocalStorage?: boolean
-  disablePayloadAccessControl?: true
-  generateFileURL?: GenerateFileURL
-  prefix?: string
-  adapter: Adapter | null
-}
-
-export interface PluginOptions {
-  collections: Record<string, CollectionOptions>
-}
+import type { NextFunction, Response } from 'express'
+import type { TypeWithID } from 'payload/dist/collections/config/types'
+import type { FileData, ImageSize } from 'payload/dist/uploads/types'
+import type { CollectionConfig, PayloadRequest } from 'payload/types'
+import type { Configuration as WebpackConfig } from 'webpack'
+
+export interface File {
+  buffer: Buffer
+  filename: string
+  filesize: number
+  mimeType: string
+  tempFilePath?: string
+}
+
+export type HandleUpload = (args: {
+  collection: CollectionConfig
+  req: PayloadRequest
+  data: any
+  file: File
+}) => Promise<void> | void
+
+export interface TypeWithPrefix {
+  prefix?: string
+}
+
+export type HandleDelete = (args: {
+  collection: CollectionConfig
+  req: PayloadRequest
+  doc: TypeWithID & FileData & TypeWithPrefix
+  filename: string
+}) => Promise<void> | void
+
+export type GenerateURL = (args: {
+  filename: string
+  collection: CollectionConfig
+  prefix?: string
+}) => string | Promise<string>
+
+export type StaticHandler = (
+  req: PayloadRequest,
+  res: Response,
+  next: NextFunction,
+) => Promise<unknown> | unknown
+
+export interface GeneratedAdapter {
+  handleUpload: HandleUpload
+  handleDelete: HandleDelete
+  generateURL: GenerateURL
+  staticHandler: StaticHandler
+  webpack?: (config: WebpackConfig) => WebpackConfig
+  onInit?: () => void
+}
+
+export type Adapter = (args: { collection: CollectionConfig; prefix?: string }) => GeneratedAdapter
+
+export type GenerateFileURL = (args: {
+  collection: CollectionConfig
+  filename: string
+  prefix?: string
+  size?: ImageSize
+}) => Promise<string> | string
+
+export interface CollectionOptions {
+  disableLocalStorage?: boolean
+  disablePayloadAccessControl?: true
+  generateFileURL?: GenerateFileURL
+  prefix?: string
+  adapter: Adapter | null
+}
+
+export interface PluginOptions {
+  /**
+   * Whether or not to enable the plugin
+   *
+   * Default: true
+   */
+  enabled?: boolean
+  collections: Record<string, CollectionOptions>
+}

package/src/utilities/getFilePrefix.ts

@@ -1,26 +1,26 @@
-import type { CollectionConfig, PayloadRequest } from 'payload/types'
-import { IncomingUploadType } from 'payload/dist/uploads/types'
-
-export async function getFilePrefix({
-  req,
-  collection,
-}: {
-  req: PayloadRequest
-  collection: CollectionConfig
-}): Promise<string> {
-  const imageSizes = (collection?.upload as IncomingUploadType)?.imageSizes || []
-  const files = await req.payload.find({
-    collection: collection.slug,
-    where: {
-      or: [
-        {
-          filename: { equals: req.params.filename },
-        },
-        ...imageSizes.map(imageSize => ({
-          [`sizes.${imageSize.name}.filename`]: { equals: req.params.filename },
-        })),
-      ],
-    },
-  })
-  return files?.docs?.[0]?.prefix || ''
-}
+import type { CollectionConfig, PayloadRequest } from 'payload/types'
+import { IncomingUploadType } from 'payload/dist/uploads/types'
+
+export async function getFilePrefix({
+  req,
+  collection,
+}: {
+  req: PayloadRequest
+  collection: CollectionConfig
+}): Promise<string> {
+  const imageSizes = (collection?.upload as IncomingUploadType)?.imageSizes || []
+  const files = await req.payload.find({
+    collection: collection.slug,
+    where: {
+      or: [
+        {
+          filename: { equals: req.params.filename },
+        },
+        ...imageSizes.map(imageSize => ({
+          [`sizes.${imageSize.name}.filename`]: { equals: req.params.filename },
+        })),
+      ],
+    },
+  })
+  return files?.docs?.[0]?.prefix || ''
+}

package/src/utilities/getIncomingFiles.ts

@@ -1,44 +1,44 @@
-import type { FileData } from 'payload/dist/uploads/types'
-import type { PayloadRequest } from 'payload/types'
-import type { File } from '../types'
-
-export function getIncomingFiles({
-  req,
-  data,
-}: {
-  data: Partial<FileData>
-  req: PayloadRequest
-}): File[] {
-  const file = req.files?.file
-
-  let files: File[] = []
-
-  if (file && data.filename && data.mimeType) {
-    const mainFile: File = {
-      filename: data.filename,
-      mimeType: data.mimeType,
-      buffer: file.data,
-      tempFilePath: file.tempFilePath,
-      filesize: file.size,
-    }
-
-    files = [mainFile]
-
-    if (data?.sizes) {
-      Object.entries(data.sizes).forEach(([key, resizedFileData]) => {
-        if (req.payloadUploadSizes?.[key] && data.mimeType) {
-          files = files.concat([
-            {
-              filename: `${resizedFileData.filename}`,
-              mimeType: data.mimeType,
-              buffer: req.payloadUploadSizes[key],
-              filesize: req.payloadUploadSizes[key].length,
-            },
-          ])
-        }
-      })
-    }
-  }
-
-  return files
-}
+import type { FileData } from 'payload/dist/uploads/types'
+import type { PayloadRequest } from 'payload/types'
+import type { File } from '../types'
+
+export function getIncomingFiles({
+  req,
+  data,
+}: {
+  data: Partial<FileData>
+  req: PayloadRequest
+}): File[] {
+  const file = req.files?.file
+
+  let files: File[] = []
+
+  if (file && data.filename && data.mimeType) {
+    const mainFile: File = {
+      filename: data.filename,
+      mimeType: data.mimeType,
+      buffer: file.data,
+      tempFilePath: file.tempFilePath,
+      filesize: file.size,
+    }
+
+    files = [mainFile]
+
+    if (data?.sizes) {
+      Object.entries(data.sizes).forEach(([key, resizedFileData]) => {
+        if (req.payloadUploadSizes?.[key] && data.mimeType) {
+          files = files.concat([
+            {
+              filename: `${resizedFileData.filename}`,
+              mimeType: data.mimeType,
+              buffer: req.payloadUploadSizes[key],
+              filesize: req.payloadUploadSizes[key].length,
+            },
+          ])
+        }
+      })
+    }
+  }
+
+  return files
+}

package/src/utilities/getRangeFromHeader.ts

@@ -1,27 +1,27 @@
-import type { BlockBlobClient } from '@azure/storage-blob'
-import parseRange from 'range-parser'
-
-const getRangeFromHeader = async (
-  blockBlobClient: BlockBlobClient,
-  rangeHeader?: string,
-): Promise<{ start: number; end: number | undefined }> => {
-  const fullRange = { start: 0, end: undefined }
-
-  if (!rangeHeader) {
-    return fullRange
-  }
-
-  const size = await blockBlobClient.getProperties().then(props => props.contentLength)
-  if (size === undefined) {
-    return fullRange
-  }
-
-  const range = parseRange(size, rangeHeader)
-  if (range === -1 || range === -2 || range.type !== 'bytes' || range.length !== 1) {
-    return fullRange
-  }
-
-  return range[0]
-}
-
-export default getRangeFromHeader
+import type { BlockBlobClient } from '@azure/storage-blob'
+import parseRange from 'range-parser'
+
+const getRangeFromHeader = async (
+  blockBlobClient: BlockBlobClient,
+  rangeHeader?: string,
+): Promise<{ start: number; end: number | undefined }> => {
+  const fullRange = { start: 0, end: undefined }
+
+  if (!rangeHeader) {
+    return fullRange
+  }
+
+  const size = await blockBlobClient.getProperties().then(props => props.contentLength)
+  if (size === undefined) {
+    return fullRange
+  }
+
+  const range = parseRange(size, rangeHeader)
+  if (range === -1 || range === -2 || range.type !== 'bytes' || range.length !== 1) {
+    return fullRange
+  }
+
+  return range[0]
+}
+
+export default getRangeFromHeader