@payloadcms/plugin-cloud-storage 4.0.0-internal.5d5a2b2 → 4.0.0-internal.5e065b3

package/dist/plugin.js

@@ -1,6 +1,7 @@
 import { getFields } from './fields/getFields.js';
 import { getAfterChangeHook } from './hooks/afterChange.js';
 import { getAfterDeleteHook } from './hooks/afterDelete.js';
+import { getNormalizeUploadPrefixHook } from './hooks/normalizeUploadPrefix.js';
 import { getPreserveFileDataHook } from './hooks/preserveFileData.js';
 // This plugin extends all targeted collections by offloading uploaded files
 // to cloud storage instead of solely storing files locally.
@@ -9,148 +10,197 @@ import { getPreserveFileDataHook } from './hooks/preserveFileData.js';
 // 1. handleUpload, 2. handleDelete, 3. generateURL, 4. staticHandler
 // Optionally, the adapter can specify any Webpack config overrides if they are necessary.
 export const cloudStoragePlugin = (pluginOptions)=>(incomingConfig)=>{
-        const { alwaysInsertFields, collections: allCollectionOptions, enabled, useCompositePrefixes } = pluginOptions;
+        const { collections: allCollectionOptions, enabled, useCompositePrefixes } = pluginOptions;
         const config = {
             ...incomingConfig
         };
-        // If disabled but alwaysInsertFields is true, only insert fields without full plugin functionality
+        // If disabled, only insert fields (e.g. prefix) without full plugin functionality,
+        // so the collection schema stays consistent across environments.
         if (enabled === false) {
-            if (alwaysInsertFields) {
+            return {
+                ...config,
+                collections: (config.collections || []).map((existingCollection)=>{
+                    const options = allCollectionOptions[existingCollection.slug];
+                    if (options) {
+                        // If adapter is provided, use it to get fields
+                        const adapter = options.adapter ? options.adapter({
+                            collection: existingCollection,
+                            prefix: options.prefix
+                        }) : undefined;
+                        const fields = getFields({
+                            adapter,
+                            collection: existingCollection,
+                            disablePayloadAccessControl: options.disablePayloadAccessControl,
+                            generateFileURL: options.generateFileURL,
+                            prefix: options.prefix,
+                            useCompositePrefixes
+                        });
+                        return {
+                            ...existingCollection,
+                            fields
+                        };
+                    }
+                    return existingCollection;
+                })
+            };
+        }
+        const initFunctions = [];
+        const endpointPaths = new Map();
+        const 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);
+                }
+                let uploadInstructions;
+                if (adapter.uploadInstructions) {
+                    const { adminHandler, enabled, endpoint, ...instructions } = adapter.uploadInstructions;
+                    let endpointPath = endpointPaths.get(options.adapter);
+                    if (enabled && endpoint && !endpointPath) {
+                        const endpointCount = config.endpoints?.filter(({ path })=>path?.startsWith(endpoint.path)).length || 0;
+                        endpointPath = endpointCount ? `${endpoint.path}-${endpointCount}` : endpoint.path;
+                        config.endpoints ??= [];
+                        config.endpoints.push({
+                            handler: endpoint.handler,
+                            method: 'post',
+                            path: endpointPath
+                        });
+                        endpointPaths.set(options.adapter, endpointPath);
+                    }
+                    if (enabled && adminHandler) {
+                        config.admin ??= {};
+                        config.admin.components ??= {};
+                        config.admin.components.providers ??= [];
+                        config.admin.components.providers.push({
+                            clientProps: {
+                                collectionSlug: existingCollection.slug,
+                                endpointPath,
+                                prefix: options.prefix,
+                                props: adminHandler.props || {}
+                            },
+                            path: adminHandler.path
+                        });
+                    }
+                    if (enabled) {
+                        uploadInstructions = instructions;
+                    } else if (adminHandler) {
+                        /** Avoid importMap.js differences when client uploads vary between dev and production. */ config.admin ??= {};
+                        config.admin.dependencies ??= {};
+                        config.admin.dependencies[adminHandler.path] = {
+                            type: 'component',
+                            path: adminHandler.path
+                        };
+                    }
+                }
+                const fields = getFields({
+                    adapter,
+                    collection: existingCollection,
+                    disablePayloadAccessControl: options.disablePayloadAccessControl,
+                    generateFileURL: options.generateFileURL,
+                    prefix: options.prefix,
+                    useCompositePrefixes
+                });
+                const handlers = [
+                    ...typeof existingCollection.upload === 'object' && Array.isArray(existingCollection.upload.handlers) ? existingCollection.upload.handlers : []
+                ];
+                if (!options.disablePayloadAccessControl) {
+                    handlers.push(adapter.staticHandler);
+                // Else if disablePayloadAccessControl: true and upload instructions are used
+                // Build the "proxied" handler that responds only when addDataAndFileToRequest fetches the uploaded file
+                } else if (uploadInstructions) {
+                    handlers.push((req, args)=>{
+                        if ('uploadReference' in args.params) {
+                            return adapter.staticHandler(req, args);
+                        }
+                    });
+                }
+                const getSkipSafeFetchSetting = ()=>{
+                    const isBooleanTrueSkipSafeFetch = typeof existingCollection.upload === 'object' && existingCollection.upload.skipSafeFetch === true;
+                    const isAllowListSkipSafeFetch = typeof existingCollection.upload === 'object' && Array.isArray(existingCollection.upload.skipSafeFetch);
+                    if (isBooleanTrueSkipSafeFetch) {
+                        return true;
+                    } else if (isAllowListSkipSafeFetch) {
+                        const existingSkipSafeFetch = typeof existingCollection.upload === 'object' && Array.isArray(existingCollection.upload.skipSafeFetch) ? existingCollection.upload.skipSafeFetch : [];
+                        const hasExactLocalhostMatch = existingSkipSafeFetch.some((entry)=>{
+                            const entryKeys = Object.keys(entry);
+                            return entryKeys.length === 1 && entry.hostname === 'localhost';
+                        });
+                        const localhostEntry = process.env.NODE_ENV !== 'production' && !hasExactLocalhostMatch ? [
+                            {
+                                hostname: 'localhost'
+                            }
+                        ] : [];
+                        return [
+                            ...existingSkipSafeFetch,
+                            ...localhostEntry
+                        ];
+                    }
+                    if (process.env.NODE_ENV !== 'production') {
+                        return [
+                            {
+                                hostname: 'localhost'
+                            }
+                        ];
+                    }
+                    return false;
+                };
                 return {
-                    ...config,
-                    collections: (config.collections || []).map((existingCollection)=>{
-                        const options = allCollectionOptions[existingCollection.slug];
-                        if (options) {
-                            // If adapter is provided, use it to get fields
-                            const adapter = options.adapter ? options.adapter({
+                    ...existingCollection,
+                    fields,
+                    hooks: {
+                        ...existingCollection.hooks || {},
+                        afterChange: [
+                            ...existingCollection.hooks?.afterChange || [],
+                            getAfterChangeHook({
+                                adapter,
                                 collection: existingCollection,
-                                prefix: options.prefix
-                            }) : undefined;
-                            const fields = getFields({
+                                collectionPrefix: options.prefix,
+                                useCompositePrefixes
+                            })
+                        ],
+                        afterDelete: [
+                            ...existingCollection.hooks?.afterDelete || [],
+                            getAfterDeleteHook({
                                 adapter,
-                                alwaysInsertFields: true,
                                 collection: existingCollection,
-                                disablePayloadAccessControl: options.disablePayloadAccessControl,
-                                generateFileURL: options.generateFileURL,
-                                prefix: options.prefix,
+                                collectionPrefix: options.prefix,
                                 useCompositePrefixes
-                            });
-                            return {
-                                ...existingCollection,
-                                fields
-                            };
-                        }
-                        return existingCollection;
-                    })
+                            })
+                        ],
+                        beforeChange: [
+                            ...existingCollection.hooks?.beforeChange || [],
+                            getNormalizeUploadPrefixHook({
+                                collectionPrefix: options.prefix,
+                                useCompositePrefixes
+                            }),
+                            getPreserveFileDataHook()
+                        ]
+                    },
+                    upload: {
+                        ...typeof existingCollection.upload === 'object' ? existingCollection.upload : {},
+                        adapter: adapter.name,
+                        ...uploadInstructions && {
+                            uploadInstructions
+                        },
+                        disableLocalStorage: typeof options.disableLocalStorage === 'boolean' ? options.disableLocalStorage : true,
+                        handlers,
+                        skipSafeFetch: getSkipSafeFetchSetting()
+                    }
                 };
             }
-            return config;
-        }
-        const initFunctions = [];
+            return existingCollection;
+        });
         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({
-                        adapter,
-                        collection: existingCollection,
-                        disablePayloadAccessControl: options.disablePayloadAccessControl,
-                        generateFileURL: options.generateFileURL,
-                        prefix: options.prefix,
-                        useCompositePrefixes
-                    });
-                    const handlers = [
-                        ...typeof existingCollection.upload === 'object' && Array.isArray(existingCollection.upload.handlers) ? existingCollection.upload.handlers : []
-                    ];
-                    if (!options.disablePayloadAccessControl) {
-                        handlers.push(adapter.staticHandler);
-                    // Else if disablePayloadAccessControl: true and clientUploads is used
-                    // Build the "proxied" handler that responses only when the file was requested by client upload in addDataAndFileToRequest
-                    } else if (adapter.clientUploads) {
-                        handlers.push((req, args)=>{
-                            if ('clientUploadContext' in args.params) {
-                                return adapter.staticHandler(req, args);
-                            }
-                        });
-                    }
-                    const getSkipSafeFetchSetting = ()=>{
-                        if (options.disablePayloadAccessControl) {
-                            return true;
-                        }
-                        const isBooleanTrueSkipSafeFetch = typeof existingCollection.upload === 'object' && existingCollection.upload.skipSafeFetch === true;
-                        const isAllowListSkipSafeFetch = typeof existingCollection.upload === 'object' && Array.isArray(existingCollection.upload.skipSafeFetch);
-                        if (isBooleanTrueSkipSafeFetch) {
-                            return true;
-                        } else if (isAllowListSkipSafeFetch) {
-                            const existingSkipSafeFetch = typeof existingCollection.upload === 'object' && Array.isArray(existingCollection.upload.skipSafeFetch) ? existingCollection.upload.skipSafeFetch : [];
-                            const hasExactLocalhostMatch = existingSkipSafeFetch.some((entry)=>{
-                                const entryKeys = Object.keys(entry);
-                                return entryKeys.length === 1 && entry.hostname === 'localhost';
-                            });
-                            const localhostEntry = process.env.NODE_ENV !== 'production' && !hasExactLocalhostMatch ? [
-                                {
-                                    hostname: 'localhost'
-                                }
-                            ] : [];
-                            return [
-                                ...existingSkipSafeFetch,
-                                ...localhostEntry
-                            ];
-                        }
-                        if (process.env.NODE_ENV !== 'production') {
-                            return [
-                                {
-                                    hostname: 'localhost'
-                                }
-                            ];
-                        }
-                        return false;
-                    };
-                    return {
-                        ...existingCollection,
-                        fields,
-                        hooks: {
-                            ...existingCollection.hooks || {},
-                            afterChange: [
-                                ...existingCollection.hooks?.afterChange || [],
-                                getAfterChangeHook({
-                                    adapter,
-                                    collection: existingCollection
-                                })
-                            ],
-                            afterDelete: [
-                                ...existingCollection.hooks?.afterDelete || [],
-                                getAfterDeleteHook({
-                                    adapter,
-                                    collection: existingCollection
-                                })
-                            ],
-                            beforeChange: [
-                                ...existingCollection.hooks?.beforeChange || [],
-                                getPreserveFileDataHook()
-                            ]
-                        },
-                        upload: {
-                            ...typeof existingCollection.upload === 'object' ? existingCollection.upload : {},
-                            adapter: adapter.name,
-                            disableLocalStorage: typeof options.disableLocalStorage === 'boolean' ? options.disableLocalStorage : true,
-                            handlers,
-                            skipSafeFetch: getSkipSafeFetchSetting()
-                        }
-                    };
-                }
-                return existingCollection;
-            }),
+            collections,
             onInit: async (payload)=>{
-                initFunctions.forEach((fn)=>fn());
+                // Await each init so a provisioning failure fails Payload startup
+                // instead of becoming an unhandled rejection.
+                await Promise.all(initFunctions.map((fn)=>fn()));
                 if (config.onInit) {
                     await config.onInit(payload);
                 }

package/dist/plugin.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/plugin.ts"],"sourcesContent":["import type { Config } from 'payload'\n\nimport type { AllowList, PluginOptions } from './types.js'\n\nimport { getFields } from './fields/getFields.js'\nimport { getAfterChangeHook } from './hooks/afterChange.js'\nimport { getAfterDeleteHook } from './hooks/afterDelete.js'\nimport { getPreserveFileDataHook } from './hooks/preserveFileData.js'\n\n// This plugin extends all targeted collections by offloading uploaded files\n// to cloud storage instead of solely storing files locally.\n\n// It is based on an adapter approach, where adapters can be written for any cloud provider.\n// Adapters are responsible for providing four actions that this plugin will use:\n// 1. handleUpload, 2. handleDelete, 3. generateURL, 4. staticHandler\n\n// Optionally, the adapter can specify any Webpack config overrides if they are necessary.\n\nexport const cloudStoragePlugin =\n  (pluginOptions: PluginOptions) =>\n  (incomingConfig: Config): Config => {\n    const {\n      alwaysInsertFields,\n      collections: allCollectionOptions,\n      enabled,\n      useCompositePrefixes,\n    } = pluginOptions\n    const config = { ...incomingConfig }\n\n    // If disabled but alwaysInsertFields is true, only insert fields without full plugin functionality\n    if (enabled === false) {\n      if (alwaysInsertFields) {\n        return {\n          ...config,\n          collections: (config.collections || []).map((existingCollection) => {\n            const options = allCollectionOptions[existingCollection.slug]\n\n            if (options) {\n              // If adapter is provided, use it to get fields\n              const adapter = options.adapter\n                ? options.adapter({\n                    collection: existingCollection,\n                    prefix: options.prefix,\n                  })\n                : undefined\n\n              const fields = getFields({\n                adapter,\n                alwaysInsertFields: true,\n                collection: existingCollection,\n                disablePayloadAccessControl: options.disablePayloadAccessControl,\n                generateFileURL: options.generateFileURL,\n                prefix: options.prefix,\n                useCompositePrefixes,\n              })\n\n              return {\n                ...existingCollection,\n                fields,\n              }\n            }\n\n            return existingCollection\n          }),\n        }\n      }\n\n      return config\n    }\n\n    const initFunctions: Array<() => void> = []\n\n    return {\n      ...config,\n      collections: (config.collections || []).map((existingCollection) => {\n        const options = allCollectionOptions[existingCollection.slug]\n\n        if (options?.adapter) {\n          const adapter = options.adapter({\n            collection: existingCollection,\n            prefix: options.prefix,\n          })\n\n          if (adapter.onInit) {\n            initFunctions.push(adapter.onInit)\n          }\n\n          const fields = getFields({\n            adapter,\n            collection: existingCollection,\n            disablePayloadAccessControl: options.disablePayloadAccessControl,\n            generateFileURL: options.generateFileURL,\n            prefix: options.prefix,\n            useCompositePrefixes,\n          })\n\n          const handlers = [\n            ...(typeof existingCollection.upload === 'object' &&\n            Array.isArray(existingCollection.upload.handlers)\n              ? existingCollection.upload.handlers\n              : []),\n          ]\n\n          if (!options.disablePayloadAccessControl) {\n            handlers.push(adapter.staticHandler)\n            // Else if disablePayloadAccessControl: true and clientUploads is used\n            // Build the \"proxied\" handler that responses only when the file was requested by client upload in addDataAndFileToRequest\n          } else if (adapter.clientUploads) {\n            handlers.push((req, args) => {\n              if ('clientUploadContext' in args.params) {\n                return adapter.staticHandler(req, args)\n              }\n            })\n          }\n\n          const getSkipSafeFetchSetting = (): AllowList | boolean => {\n            if (options.disablePayloadAccessControl) {\n              return true\n            }\n            const isBooleanTrueSkipSafeFetch =\n              typeof existingCollection.upload === 'object' &&\n              existingCollection.upload.skipSafeFetch === true\n\n            const isAllowListSkipSafeFetch =\n              typeof existingCollection.upload === 'object' &&\n              Array.isArray(existingCollection.upload.skipSafeFetch)\n\n            if (isBooleanTrueSkipSafeFetch) {\n              return true\n            } else if (isAllowListSkipSafeFetch) {\n              const existingSkipSafeFetch =\n                typeof existingCollection.upload === 'object' &&\n                Array.isArray(existingCollection.upload.skipSafeFetch)\n                  ? existingCollection.upload.skipSafeFetch\n                  : []\n\n              const hasExactLocalhostMatch = existingSkipSafeFetch.some((entry) => {\n                const entryKeys = Object.keys(entry)\n                return entryKeys.length === 1 && entry.hostname === 'localhost'\n              })\n\n              const localhostEntry =\n                process.env.NODE_ENV !== 'production' && !hasExactLocalhostMatch\n                  ? [{ hostname: 'localhost' }]\n                  : []\n\n              return [...existingSkipSafeFetch, ...localhostEntry]\n            }\n\n            if (process.env.NODE_ENV !== 'production') {\n              return [{ hostname: 'localhost' }]\n            }\n\n            return false\n          }\n\n          return {\n            ...existingCollection,\n            fields,\n            hooks: {\n              ...(existingCollection.hooks || {}),\n              afterChange: [\n                ...(existingCollection.hooks?.afterChange || []),\n                getAfterChangeHook({ adapter, collection: existingCollection }),\n              ],\n              afterDelete: [\n                ...(existingCollection.hooks?.afterDelete || []),\n                getAfterDeleteHook({ adapter, collection: existingCollection }),\n              ],\n              beforeChange: [\n                ...(existingCollection.hooks?.beforeChange || []),\n                getPreserveFileDataHook(),\n              ],\n            },\n            upload: {\n              ...(typeof existingCollection.upload === 'object' ? existingCollection.upload : {}),\n              adapter: adapter.name,\n              disableLocalStorage:\n                typeof options.disableLocalStorage === 'boolean'\n                  ? options.disableLocalStorage\n                  : true,\n              handlers,\n              skipSafeFetch: getSkipSafeFetchSetting(),\n            },\n          }\n        }\n\n        return existingCollection\n      }),\n      onInit: async (payload) => {\n        initFunctions.forEach((fn) => fn())\n        if (config.onInit) {\n          await config.onInit(payload)\n        }\n      },\n    }\n  }\n"],"names":["getFields","getAfterChangeHook","getAfterDeleteHook","getPreserveFileDataHook","cloudStoragePlugin","pluginOptions","incomingConfig","alwaysInsertFields","collections","allCollectionOptions","enabled","useCompositePrefixes","config","map","existingCollection","options","slug","adapter","collection","prefix","undefined","fields","disablePayloadAccessControl","generateFileURL","initFunctions","onInit","push","handlers","upload","Array","isArray","staticHandler","clientUploads","req","args","params","getSkipSafeFetchSetting","isBooleanTrueSkipSafeFetch","skipSafeFetch","isAllowListSkipSafeFetch","existingSkipSafeFetch","hasExactLocalhostMatch","some","entry","entryKeys","Object","keys","length","hostname","localhostEntry","process","env","NODE_ENV","hooks","afterChange","afterDelete","beforeChange","name","disableLocalStorage","payload","forEach","fn"],"mappings":"AAIA,SAASA,SAAS,QAAQ,wBAAuB;AACjD,SAASC,kBAAkB,QAAQ,yBAAwB;AAC3D,SAASC,kBAAkB,QAAQ,yBAAwB;AAC3D,SAASC,uBAAuB,QAAQ,8BAA6B;AAErE,4EAA4E;AAC5E,4DAA4D;AAE5D,4FAA4F;AAC5F,iFAAiF;AACjF,qEAAqE;AAErE,0FAA0F;AAE1F,OAAO,MAAMC,qBACX,CAACC,gBACD,CAACC;QACC,MAAM,EACJC,kBAAkB,EAClBC,aAAaC,oBAAoB,EACjCC,OAAO,EACPC,oBAAoB,EACrB,GAAGN;QACJ,MAAMO,SAAS;YAAE,GAAGN,cAAc;QAAC;QAEnC,mGAAmG;QACnG,IAAII,YAAY,OAAO;YACrB,IAAIH,oBAAoB;gBACtB,OAAO;oBACL,GAAGK,MAAM;oBACTJ,aAAa,AAACI,CAAAA,OAAOJ,WAAW,IAAI,EAAE,AAAD,EAAGK,GAAG,CAAC,CAACC;wBAC3C,MAAMC,UAAUN,oBAAoB,CAACK,mBAAmBE,IAAI,CAAC;wBAE7D,IAAID,SAAS;4BACX,+CAA+C;4BAC/C,MAAME,UAAUF,QAAQE,OAAO,GAC3BF,QAAQE,OAAO,CAAC;gCACdC,YAAYJ;gCACZK,QAAQJ,QAAQI,MAAM;4BACxB,KACAC;4BAEJ,MAAMC,SAASrB,UAAU;gCACvBiB;gCACAV,oBAAoB;gCACpBW,YAAYJ;gCACZQ,6BAA6BP,QAAQO,2BAA2B;gCAChEC,iBAAiBR,QAAQQ,eAAe;gCACxCJ,QAAQJ,QAAQI,MAAM;gCACtBR;4BACF;4BAEA,OAAO;gCACL,GAAGG,kBAAkB;gCACrBO;4BACF;wBACF;wBAEA,OAAOP;oBACT;gBACF;YACF;YAEA,OAAOF;QACT;QAEA,MAAMY,gBAAmC,EAAE;QAE3C,OAAO;YACL,GAAGZ,MAAM;YACTJ,aAAa,AAACI,CAAAA,OAAOJ,WAAW,IAAI,EAAE,AAAD,EAAGK,GAAG,CAAC,CAACC;gBAC3C,MAAMC,UAAUN,oBAAoB,CAACK,mBAAmBE,IAAI,CAAC;gBAE7D,IAAID,SAASE,SAAS;oBACpB,MAAMA,UAAUF,QAAQE,OAAO,CAAC;wBAC9BC,YAAYJ;wBACZK,QAAQJ,QAAQI,MAAM;oBACxB;oBAEA,IAAIF,QAAQQ,MAAM,EAAE;wBAClBD,cAAcE,IAAI,CAACT,QAAQQ,MAAM;oBACnC;oBAEA,MAAMJ,SAASrB,UAAU;wBACvBiB;wBACAC,YAAYJ;wBACZQ,6BAA6BP,QAAQO,2BAA2B;wBAChEC,iBAAiBR,QAAQQ,eAAe;wBACxCJ,QAAQJ,QAAQI,MAAM;wBACtBR;oBACF;oBAEA,MAAMgB,WAAW;2BACX,OAAOb,mBAAmBc,MAAM,KAAK,YACzCC,MAAMC,OAAO,CAAChB,mBAAmBc,MAAM,CAACD,QAAQ,IAC5Cb,mBAAmBc,MAAM,CAACD,QAAQ,GAClC,EAAE;qBACP;oBAED,IAAI,CAACZ,QAAQO,2BAA2B,EAAE;wBACxCK,SAASD,IAAI,CAACT,QAAQc,aAAa;oBACnC,sEAAsE;oBACtE,0HAA0H;oBAC5H,OAAO,IAAId,QAAQe,aAAa,EAAE;wBAChCL,SAASD,IAAI,CAAC,CAACO,KAAKC;4BAClB,IAAI,yBAAyBA,KAAKC,MAAM,EAAE;gCACxC,OAAOlB,QAAQc,aAAa,CAACE,KAAKC;4BACpC;wBACF;oBACF;oBAEA,MAAME,0BAA0B;wBAC9B,IAAIrB,QAAQO,2BAA2B,EAAE;4BACvC,OAAO;wBACT;wBACA,MAAMe,6BACJ,OAAOvB,mBAAmBc,MAAM,KAAK,YACrCd,mBAAmBc,MAAM,CAACU,aAAa,KAAK;wBAE9C,MAAMC,2BACJ,OAAOzB,mBAAmBc,MAAM,KAAK,YACrCC,MAAMC,OAAO,CAAChB,mBAAmBc,MAAM,CAACU,aAAa;wBAEvD,IAAID,4BAA4B;4BAC9B,OAAO;wBACT,OAAO,IAAIE,0BAA0B;4BACnC,MAAMC,wBACJ,OAAO1B,mBAAmBc,MAAM,KAAK,YACrCC,MAAMC,OAAO,CAAChB,mBAAmBc,MAAM,CAACU,aAAa,IACjDxB,mBAAmBc,MAAM,CAACU,aAAa,GACvC,EAAE;4BAER,MAAMG,yBAAyBD,sBAAsBE,IAAI,CAAC,CAACC;gCACzD,MAAMC,YAAYC,OAAOC,IAAI,CAACH;gCAC9B,OAAOC,UAAUG,MAAM,KAAK,KAAKJ,MAAMK,QAAQ,KAAK;4BACtD;4BAEA,MAAMC,iBACJC,QAAQC,GAAG,CAACC,QAAQ,KAAK,gBAAgB,CAACX,yBACtC;gCAAC;oCAAEO,UAAU;gCAAY;6BAAE,GAC3B,EAAE;4BAER,OAAO;mCAAIR;mCAA0BS;6BAAe;wBACtD;wBAEA,IAAIC,QAAQC,GAAG,CAACC,QAAQ,KAAK,cAAc;4BACzC,OAAO;gCAAC;oCAAEJ,UAAU;gCAAY;6BAAE;wBACpC;wBAEA,OAAO;oBACT;oBAEA,OAAO;wBACL,GAAGlC,kBAAkB;wBACrBO;wBACAgC,OAAO;4BACL,GAAIvC,mBAAmBuC,KAAK,IAAI,CAAC,CAAC;4BAClCC,aAAa;mCACPxC,mBAAmBuC,KAAK,EAAEC,eAAe,EAAE;gCAC/CrD,mBAAmB;oCAAEgB;oCAASC,YAAYJ;gCAAmB;6BAC9D;4BACDyC,aAAa;mCACPzC,mBAAmBuC,KAAK,EAAEE,eAAe,EAAE;gCAC/CrD,mBAAmB;oCAAEe;oCAASC,YAAYJ;gCAAmB;6BAC9D;4BACD0C,cAAc;mCACR1C,mBAAmBuC,KAAK,EAAEG,gBAAgB,EAAE;gCAChDrD;6BACD;wBACH;wBACAyB,QAAQ;4BACN,GAAI,OAAOd,mBAAmBc,MAAM,KAAK,WAAWd,mBAAmBc,MAAM,GAAG,CAAC,CAAC;4BAClFX,SAASA,QAAQwC,IAAI;4BACrBC,qBACE,OAAO3C,QAAQ2C,mBAAmB,KAAK,YACnC3C,QAAQ2C,mBAAmB,GAC3B;4BACN/B;4BACAW,eAAeF;wBACjB;oBACF;gBACF;gBAEA,OAAOtB;YACT;YACAW,QAAQ,OAAOkC;gBACbnC,cAAcoC,OAAO,CAAC,CAACC,KAAOA;gBAC9B,IAAIjD,OAAOa,MAAM,EAAE;oBACjB,MAAMb,OAAOa,MAAM,CAACkC;gBACtB;YACF;QACF;IACF,EAAC"}
+{"version":3,"sources":["../src/plugin.ts"],"sourcesContent":["import type { Config } from 'payload'\n\nimport type { Adapter, AllowList, PluginOptions } from './types.js'\n\nimport { getFields } from './fields/getFields.js'\nimport { getAfterChangeHook } from './hooks/afterChange.js'\nimport { getAfterDeleteHook } from './hooks/afterDelete.js'\nimport { getNormalizeUploadPrefixHook } from './hooks/normalizeUploadPrefix.js'\nimport { getPreserveFileDataHook } from './hooks/preserveFileData.js'\n\n// This plugin extends all targeted collections by offloading uploaded files\n// to cloud storage instead of solely storing files locally.\n\n// It is based on an adapter approach, where adapters can be written for any cloud provider.\n// Adapters are responsible for providing four actions that this plugin will use:\n// 1. handleUpload, 2. handleDelete, 3. generateURL, 4. staticHandler\n\n// Optionally, the adapter can specify any Webpack config overrides if they are necessary.\n\nexport const cloudStoragePlugin =\n  (pluginOptions: PluginOptions) =>\n  (incomingConfig: Config): Config => {\n    const { collections: allCollectionOptions, enabled, useCompositePrefixes } = pluginOptions\n    const config = { ...incomingConfig }\n\n    // If disabled, only insert fields (e.g. prefix) without full plugin functionality,\n    // so the collection schema stays consistent across environments.\n    if (enabled === false) {\n      return {\n        ...config,\n        collections: (config.collections || []).map((existingCollection) => {\n          const options = allCollectionOptions[existingCollection.slug]\n\n          if (options) {\n            // If adapter is provided, use it to get fields\n            const adapter = options.adapter\n              ? options.adapter({\n                  collection: existingCollection,\n                  prefix: options.prefix,\n                })\n              : undefined\n\n            const fields = getFields({\n              adapter,\n              collection: existingCollection,\n              disablePayloadAccessControl: options.disablePayloadAccessControl,\n              generateFileURL: options.generateFileURL,\n              prefix: options.prefix,\n              useCompositePrefixes,\n            })\n\n            return {\n              ...existingCollection,\n              fields,\n            }\n          }\n\n          return existingCollection\n        }),\n      }\n    }\n\n    const initFunctions: Array<() => Promise<void> | void> = []\n    const endpointPaths = new Map<Adapter, string>()\n\n    const collections = (config.collections || []).map((existingCollection) => {\n      const options = allCollectionOptions[existingCollection.slug]\n\n      if (options?.adapter) {\n        const adapter = options.adapter({\n          collection: existingCollection,\n          prefix: options.prefix,\n        })\n\n        if (adapter.onInit) {\n          initFunctions.push(adapter.onInit)\n        }\n\n        let uploadInstructions\n\n        if (adapter.uploadInstructions) {\n          const { adminHandler, enabled, endpoint, ...instructions } = adapter.uploadInstructions\n          let endpointPath = endpointPaths.get(options.adapter)\n\n          if (enabled && endpoint && !endpointPath) {\n            const endpointCount =\n              config.endpoints?.filter(({ path }) => path?.startsWith(endpoint.path)).length || 0\n\n            endpointPath = endpointCount ? `${endpoint.path}-${endpointCount}` : endpoint.path\n            config.endpoints ??= []\n            config.endpoints.push({\n              handler: endpoint.handler,\n              method: 'post',\n              path: endpointPath,\n            })\n            endpointPaths.set(options.adapter, endpointPath)\n          }\n\n          if (enabled && adminHandler) {\n            config.admin ??= {}\n            config.admin.components ??= {}\n            config.admin.components.providers ??= []\n            config.admin.components.providers.push({\n              clientProps: {\n                collectionSlug: existingCollection.slug,\n                endpointPath,\n                prefix: options.prefix,\n                props: adminHandler.props || {},\n              },\n              path: adminHandler.path,\n            })\n          }\n\n          if (enabled) {\n            uploadInstructions = instructions\n          } else if (adminHandler) {\n            /** Avoid importMap.js differences when client uploads vary between dev and production. */\n            config.admin ??= {}\n            config.admin.dependencies ??= {}\n            config.admin.dependencies[adminHandler.path] = {\n              type: 'component',\n              path: adminHandler.path,\n            }\n          }\n        }\n\n        const fields = getFields({\n          adapter,\n          collection: existingCollection,\n          disablePayloadAccessControl: options.disablePayloadAccessControl,\n          generateFileURL: options.generateFileURL,\n          prefix: options.prefix,\n          useCompositePrefixes,\n        })\n\n        const handlers = [\n          ...(typeof existingCollection.upload === 'object' &&\n          Array.isArray(existingCollection.upload.handlers)\n            ? existingCollection.upload.handlers\n            : []),\n        ]\n\n        if (!options.disablePayloadAccessControl) {\n          handlers.push(adapter.staticHandler)\n          // Else if disablePayloadAccessControl: true and upload instructions are used\n          // Build the \"proxied\" handler that responds only when addDataAndFileToRequest fetches the uploaded file\n        } else if (uploadInstructions) {\n          handlers.push((req, args) => {\n            if ('uploadReference' in args.params) {\n              return adapter.staticHandler(req, args)\n            }\n          })\n        }\n\n        const getSkipSafeFetchSetting = (): AllowList | boolean => {\n          const isBooleanTrueSkipSafeFetch =\n            typeof existingCollection.upload === 'object' &&\n            existingCollection.upload.skipSafeFetch === true\n\n          const isAllowListSkipSafeFetch =\n            typeof existingCollection.upload === 'object' &&\n            Array.isArray(existingCollection.upload.skipSafeFetch)\n\n          if (isBooleanTrueSkipSafeFetch) {\n            return true\n          } else if (isAllowListSkipSafeFetch) {\n            const existingSkipSafeFetch =\n              typeof existingCollection.upload === 'object' &&\n              Array.isArray(existingCollection.upload.skipSafeFetch)\n                ? existingCollection.upload.skipSafeFetch\n                : []\n\n            const hasExactLocalhostMatch = existingSkipSafeFetch.some((entry) => {\n              const entryKeys = Object.keys(entry)\n              return entryKeys.length === 1 && entry.hostname === 'localhost'\n            })\n\n            const localhostEntry =\n              process.env.NODE_ENV !== 'production' && !hasExactLocalhostMatch\n                ? [{ hostname: 'localhost' }]\n                : []\n\n            return [...existingSkipSafeFetch, ...localhostEntry]\n          }\n\n          if (process.env.NODE_ENV !== 'production') {\n            return [{ hostname: 'localhost' }]\n          }\n\n          return false\n        }\n\n        return {\n          ...existingCollection,\n          fields,\n          hooks: {\n            ...(existingCollection.hooks || {}),\n            afterChange: [\n              ...(existingCollection.hooks?.afterChange || []),\n              getAfterChangeHook({\n                adapter,\n                collection: existingCollection,\n                collectionPrefix: options.prefix,\n                useCompositePrefixes,\n              }),\n            ],\n            afterDelete: [\n              ...(existingCollection.hooks?.afterDelete || []),\n              getAfterDeleteHook({\n                adapter,\n                collection: existingCollection,\n                collectionPrefix: options.prefix,\n                useCompositePrefixes,\n              }),\n            ],\n            beforeChange: [\n              ...(existingCollection.hooks?.beforeChange || []),\n              getNormalizeUploadPrefixHook({\n                collectionPrefix: options.prefix,\n                useCompositePrefixes,\n              }),\n              getPreserveFileDataHook(),\n            ],\n          },\n          upload: {\n            ...(typeof existingCollection.upload === 'object' ? existingCollection.upload : {}),\n            adapter: adapter.name,\n            ...(uploadInstructions && {\n              uploadInstructions,\n            }),\n            disableLocalStorage:\n              typeof options.disableLocalStorage === 'boolean' ? options.disableLocalStorage : true,\n            handlers,\n            skipSafeFetch: getSkipSafeFetchSetting(),\n          },\n        }\n      }\n\n      return existingCollection\n    })\n\n    return {\n      ...config,\n      collections,\n      onInit: async (payload) => {\n        // Await each init so a provisioning failure fails Payload startup\n        // instead of becoming an unhandled rejection.\n        await Promise.all(initFunctions.map((fn) => fn()))\n        if (config.onInit) {\n          await config.onInit(payload)\n        }\n      },\n    }\n  }\n"],"names":["getFields","getAfterChangeHook","getAfterDeleteHook","getNormalizeUploadPrefixHook","getPreserveFileDataHook","cloudStoragePlugin","pluginOptions","incomingConfig","collections","allCollectionOptions","enabled","useCompositePrefixes","config","map","existingCollection","options","slug","adapter","collection","prefix","undefined","fields","disablePayloadAccessControl","generateFileURL","initFunctions","endpointPaths","Map","onInit","push","uploadInstructions","adminHandler","endpoint","instructions","endpointPath","get","endpointCount","endpoints","filter","path","startsWith","length","handler","method","set","admin","components","providers","clientProps","collectionSlug","props","dependencies","type","handlers","upload","Array","isArray","staticHandler","req","args","params","getSkipSafeFetchSetting","isBooleanTrueSkipSafeFetch","skipSafeFetch","isAllowListSkipSafeFetch","existingSkipSafeFetch","hasExactLocalhostMatch","some","entry","entryKeys","Object","keys","hostname","localhostEntry","process","env","NODE_ENV","hooks","afterChange","collectionPrefix","afterDelete","beforeChange","name","disableLocalStorage","payload","Promise","all","fn"],"mappings":"AAIA,SAASA,SAAS,QAAQ,wBAAuB;AACjD,SAASC,kBAAkB,QAAQ,yBAAwB;AAC3D,SAASC,kBAAkB,QAAQ,yBAAwB;AAC3D,SAASC,4BAA4B,QAAQ,mCAAkC;AAC/E,SAASC,uBAAuB,QAAQ,8BAA6B;AAErE,4EAA4E;AAC5E,4DAA4D;AAE5D,4FAA4F;AAC5F,iFAAiF;AACjF,qEAAqE;AAErE,0FAA0F;AAE1F,OAAO,MAAMC,qBACX,CAACC,gBACD,CAACC;QACC,MAAM,EAAEC,aAAaC,oBAAoB,EAAEC,OAAO,EAAEC,oBAAoB,EAAE,GAAGL;QAC7E,MAAMM,SAAS;YAAE,GAAGL,cAAc;QAAC;QAEnC,mFAAmF;QACnF,iEAAiE;QACjE,IAAIG,YAAY,OAAO;YACrB,OAAO;gBACL,GAAGE,MAAM;gBACTJ,aAAa,AAACI,CAAAA,OAAOJ,WAAW,IAAI,EAAE,AAAD,EAAGK,GAAG,CAAC,CAACC;oBAC3C,MAAMC,UAAUN,oBAAoB,CAACK,mBAAmBE,IAAI,CAAC;oBAE7D,IAAID,SAAS;wBACX,+CAA+C;wBAC/C,MAAME,UAAUF,QAAQE,OAAO,GAC3BF,QAAQE,OAAO,CAAC;4BACdC,YAAYJ;4BACZK,QAAQJ,QAAQI,MAAM;wBACxB,KACAC;wBAEJ,MAAMC,SAASrB,UAAU;4BACvBiB;4BACAC,YAAYJ;4BACZQ,6BAA6BP,QAAQO,2BAA2B;4BAChEC,iBAAiBR,QAAQQ,eAAe;4BACxCJ,QAAQJ,QAAQI,MAAM;4BACtBR;wBACF;wBAEA,OAAO;4BACL,GAAGG,kBAAkB;4BACrBO;wBACF;oBACF;oBAEA,OAAOP;gBACT;YACF;QACF;QAEA,MAAMU,gBAAmD,EAAE;QAC3D,MAAMC,gBAAgB,IAAIC;QAE1B,MAAMlB,cAAc,AAACI,CAAAA,OAAOJ,WAAW,IAAI,EAAE,AAAD,EAAGK,GAAG,CAAC,CAACC;YAClD,MAAMC,UAAUN,oBAAoB,CAACK,mBAAmBE,IAAI,CAAC;YAE7D,IAAID,SAASE,SAAS;gBACpB,MAAMA,UAAUF,QAAQE,OAAO,CAAC;oBAC9BC,YAAYJ;oBACZK,QAAQJ,QAAQI,MAAM;gBACxB;gBAEA,IAAIF,QAAQU,MAAM,EAAE;oBAClBH,cAAcI,IAAI,CAACX,QAAQU,MAAM;gBACnC;gBAEA,IAAIE;gBAEJ,IAAIZ,QAAQY,kBAAkB,EAAE;oBAC9B,MAAM,EAAEC,YAAY,EAAEpB,OAAO,EAAEqB,QAAQ,EAAE,GAAGC,cAAc,GAAGf,QAAQY,kBAAkB;oBACvF,IAAII,eAAeR,cAAcS,GAAG,CAACnB,QAAQE,OAAO;oBAEpD,IAAIP,WAAWqB,YAAY,CAACE,cAAc;wBACxC,MAAME,gBACJvB,OAAOwB,SAAS,EAAEC,OAAO,CAAC,EAAEC,IAAI,EAAE,GAAKA,MAAMC,WAAWR,SAASO,IAAI,GAAGE,UAAU;wBAEpFP,eAAeE,gBAAgB,GAAGJ,SAASO,IAAI,CAAC,CAAC,EAAEH,eAAe,GAAGJ,SAASO,IAAI;wBAClF1B,OAAOwB,SAAS,KAAK,EAAE;wBACvBxB,OAAOwB,SAAS,CAACR,IAAI,CAAC;4BACpBa,SAASV,SAASU,OAAO;4BACzBC,QAAQ;4BACRJ,MAAML;wBACR;wBACAR,cAAckB,GAAG,CAAC5B,QAAQE,OAAO,EAAEgB;oBACrC;oBAEA,IAAIvB,WAAWoB,cAAc;wBAC3BlB,OAAOgC,KAAK,KAAK,CAAC;wBAClBhC,OAAOgC,KAAK,CAACC,UAAU,KAAK,CAAC;wBAC7BjC,OAAOgC,KAAK,CAACC,UAAU,CAACC,SAAS,KAAK,EAAE;wBACxClC,OAAOgC,KAAK,CAACC,UAAU,CAACC,SAAS,CAAClB,IAAI,CAAC;4BACrCmB,aAAa;gCACXC,gBAAgBlC,mBAAmBE,IAAI;gCACvCiB;gCACAd,QAAQJ,QAAQI,MAAM;gCACtB8B,OAAOnB,aAAamB,KAAK,IAAI,CAAC;4BAChC;4BACAX,MAAMR,aAAaQ,IAAI;wBACzB;oBACF;oBAEA,IAAI5B,SAAS;wBACXmB,qBAAqBG;oBACvB,OAAO,IAAIF,cAAc;wBACvB,wFAAwF,GACxFlB,OAAOgC,KAAK,KAAK,CAAC;wBAClBhC,OAAOgC,KAAK,CAACM,YAAY,KAAK,CAAC;wBAC/BtC,OAAOgC,KAAK,CAACM,YAAY,CAACpB,aAAaQ,IAAI,CAAC,GAAG;4BAC7Ca,MAAM;4BACNb,MAAMR,aAAaQ,IAAI;wBACzB;oBACF;gBACF;gBAEA,MAAMjB,SAASrB,UAAU;oBACvBiB;oBACAC,YAAYJ;oBACZQ,6BAA6BP,QAAQO,2BAA2B;oBAChEC,iBAAiBR,QAAQQ,eAAe;oBACxCJ,QAAQJ,QAAQI,MAAM;oBACtBR;gBACF;gBAEA,MAAMyC,WAAW;uBACX,OAAOtC,mBAAmBuC,MAAM,KAAK,YACzCC,MAAMC,OAAO,CAACzC,mBAAmBuC,MAAM,CAACD,QAAQ,IAC5CtC,mBAAmBuC,MAAM,CAACD,QAAQ,GAClC,EAAE;iBACP;gBAED,IAAI,CAACrC,QAAQO,2BAA2B,EAAE;oBACxC8B,SAASxB,IAAI,CAACX,QAAQuC,aAAa;gBACnC,6EAA6E;gBAC7E,wGAAwG;gBAC1G,OAAO,IAAI3B,oBAAoB;oBAC7BuB,SAASxB,IAAI,CAAC,CAAC6B,KAAKC;wBAClB,IAAI,qBAAqBA,KAAKC,MAAM,EAAE;4BACpC,OAAO1C,QAAQuC,aAAa,CAACC,KAAKC;wBACpC;oBACF;gBACF;gBAEA,MAAME,0BAA0B;oBAC9B,MAAMC,6BACJ,OAAO/C,mBAAmBuC,MAAM,KAAK,YACrCvC,mBAAmBuC,MAAM,CAACS,aAAa,KAAK;oBAE9C,MAAMC,2BACJ,OAAOjD,mBAAmBuC,MAAM,KAAK,YACrCC,MAAMC,OAAO,CAACzC,mBAAmBuC,MAAM,CAACS,aAAa;oBAEvD,IAAID,4BAA4B;wBAC9B,OAAO;oBACT,OAAO,IAAIE,0BAA0B;wBACnC,MAAMC,wBACJ,OAAOlD,mBAAmBuC,MAAM,KAAK,YACrCC,MAAMC,OAAO,CAACzC,mBAAmBuC,MAAM,CAACS,aAAa,IACjDhD,mBAAmBuC,MAAM,CAACS,aAAa,GACvC,EAAE;wBAER,MAAMG,yBAAyBD,sBAAsBE,IAAI,CAAC,CAACC;4BACzD,MAAMC,YAAYC,OAAOC,IAAI,CAACH;4BAC9B,OAAOC,UAAU5B,MAAM,KAAK,KAAK2B,MAAMI,QAAQ,KAAK;wBACtD;wBAEA,MAAMC,iBACJC,QAAQC,GAAG,CAACC,QAAQ,KAAK,gBAAgB,CAACV,yBACtC;4BAAC;gCAAEM,UAAU;4BAAY;yBAAE,GAC3B,EAAE;wBAER,OAAO;+BAAIP;+BAA0BQ;yBAAe;oBACtD;oBAEA,IAAIC,QAAQC,GAAG,CAACC,QAAQ,KAAK,cAAc;wBACzC,OAAO;4BAAC;gCAAEJ,UAAU;4BAAY;yBAAE;oBACpC;oBAEA,OAAO;gBACT;gBAEA,OAAO;oBACL,GAAGzD,kBAAkB;oBACrBO;oBACAuD,OAAO;wBACL,GAAI9D,mBAAmB8D,KAAK,IAAI,CAAC,CAAC;wBAClCC,aAAa;+BACP/D,mBAAmB8D,KAAK,EAAEC,eAAe,EAAE;4BAC/C5E,mBAAmB;gCACjBgB;gCACAC,YAAYJ;gCACZgE,kBAAkB/D,QAAQI,MAAM;gCAChCR;4BACF;yBACD;wBACDoE,aAAa;+BACPjE,mBAAmB8D,KAAK,EAAEG,eAAe,EAAE;4BAC/C7E,mBAAmB;gCACjBe;gCACAC,YAAYJ;gCACZgE,kBAAkB/D,QAAQI,MAAM;gCAChCR;4BACF;yBACD;wBACDqE,cAAc;+BACRlE,mBAAmB8D,KAAK,EAAEI,gBAAgB,EAAE;4BAChD7E,6BAA6B;gCAC3B2E,kBAAkB/D,QAAQI,MAAM;gCAChCR;4BACF;4BACAP;yBACD;oBACH;oBACAiD,QAAQ;wBACN,GAAI,OAAOvC,mBAAmBuC,MAAM,KAAK,WAAWvC,mBAAmBuC,MAAM,GAAG,CAAC,CAAC;wBAClFpC,SAASA,QAAQgE,IAAI;wBACrB,GAAIpD,sBAAsB;4BACxBA;wBACF,CAAC;wBACDqD,qBACE,OAAOnE,QAAQmE,mBAAmB,KAAK,YAAYnE,QAAQmE,mBAAmB,GAAG;wBACnF9B;wBACAU,eAAeF;oBACjB;gBACF;YACF;YAEA,OAAO9C;QACT;QAEA,OAAO;YACL,GAAGF,MAAM;YACTJ;YACAmB,QAAQ,OAAOwD;gBACb,kEAAkE;gBAClE,8CAA8C;gBAC9C,MAAMC,QAAQC,GAAG,CAAC7D,cAAcX,GAAG,CAAC,CAACyE,KAAOA;gBAC5C,IAAI1E,OAAOe,MAAM,EAAE;oBACjB,MAAMf,OAAOe,MAAM,CAACwD;gBACtB;YACF;QACF;IACF,EAAC"}

package/dist/types.d.ts

@@ -1,25 +1,35 @@
-import type { CollectionConfig, Field, FileData, ImageSize, PayloadRequest, TypeWithID, UploadCollectionSlug } from 'payload';
+import type { CollectionConfig, Field, FileData, FileHandlerOperation, ImageSize, PayloadHandler, PayloadRequest, TypeWithID, UploadCollectionSlug, UploadInstructionsAccess, UploadInstructionsCapability } from 'payload';
+export type { FileHandlerOperation } from 'payload';
 export interface File {
     buffer: Buffer;
-    clientUploadContext?: unknown;
     filename: string;
     filesize: number;
     mimeType: string;
     tempFilePath?: string;
+    uploadReference?: unknown;
 }
-export type ClientUploadsAccess = (args: {
-    collectionSlug: UploadCollectionSlug;
-    req: PayloadRequest;
-}) => boolean | Promise<boolean>;
 export type ClientUploadsConfig = {
-    access?: ClientUploadsAccess;
+    access?: UploadInstructionsAccess;
 } | boolean;
+/**
+ * Reference to a client-uploaded object, returned by an upload handler and
+ * submitted with the document. Always carries the signed receipt; `prefix`
+ * locates the stored object.
+ */
+export type UploadReference = {
+    _objectKey?: string;
+    prefix: string;
+    signedReceipt: `${string}.${string}`;
+};
 export type HandleUpload = (args: {
-    clientUploadContext: unknown;
     collection: CollectionConfig;
     data: any;
     file: File;
     req: PayloadRequest;
+    /**
+     * Pre-resolved storage path (`_objectKey` folded in, contained beneath the collection prefix).
+     */
+    storageFilePath: string;
 }) => Partial<FileData & TypeWithID> | Promise<Partial<FileData & TypeWithID>> | Promise<void> | void;
 export interface TypeWithPrefix {
     prefix?: string;
@@ -29,6 +39,10 @@ export type HandleDelete = (args: {
     doc: FileData & TypeWithID & TypeWithPrefix;
     filename: string;
     req: PayloadRequest;
+    /**
+     * Pre-resolved storage path of the object to delete.
+     */
+    storageFilePath: string;
 }) => Promise<void> | void;
 export type GenerateURL = (args: {
     collection: CollectionConfig;
@@ -40,14 +54,14 @@ export type StaticHandler = (req: PayloadRequest, args: {
     doc?: TypeWithID;
     headers?: Headers;
     params: {
-        clientUploadContext?: unknown;
         collection: string;
         filename: string;
+        operation?: FileHandlerOperation;
         prefix?: string;
+        uploadReference?: unknown;
     };
 }) => Promise<Response> | Response;
 export interface GeneratedAdapter {
-    clientUploads?: ClientUploadsConfig;
     /**
      * Additional fields to be injected into the base collection and image sizes
      */
@@ -59,8 +73,20 @@ export interface GeneratedAdapter {
     handleDelete: HandleDelete;
     handleUpload: HandleUpload;
     name: string;
-    onInit?: () => void;
+    onInit?: () => Promise<void> | void;
     staticHandler: StaticHandler;
+    /** Generates upload instructions when supported. */
+    uploadInstructions?: {
+        adminHandler?: {
+            path: string;
+            props?: Record<string, unknown>;
+        };
+        enabled: boolean;
+        endpoint?: {
+            handler: PayloadHandler;
+            path: `/${string}`;
+        };
+    } & UploadInstructionsCapability;
 }
 export type Adapter = (args: {
     collection: CollectionConfig;
@@ -87,16 +113,6 @@ export interface CollectionOptions {
     prefix?: string;
 }
 export interface PluginOptions {
-    /**
-     * When enabled, fields (like the prefix field) will always be inserted into
-     * the collection schema regardless of whether the plugin is enabled. This
-     * ensures a consistent schema across all environments.
-     *
-     * This will be enabled by default in Payload v4.
-     *
-     * @default false
-     */
-    alwaysInsertFields?: boolean;
     collections: Partial<Record<UploadCollectionSlug, CollectionOptions>>;
     /**
      * Whether or not to enable the plugin

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAChB,KAAK,EACL,QAAQ,EACR,SAAS,EACT,cAAc,EACd,UAAU,EACV,oBAAoB,EACrB,MAAM,SAAS,CAAA;AAEhB,MAAM,WAAW,IAAI;IACnB,MAAM,EAAE,MAAM,CAAA;IACd,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED,MAAM,MAAM,mBAAmB,GAAG,CAAC,IAAI,EAAE;IACvC,cAAc,EAAE,oBAAoB,CAAA;IACpC,GAAG,EAAE,cAAc,CAAA;CACpB,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;AAEhC,MAAM,MAAM,mBAAmB,GAC3B;IACE,MAAM,CAAC,EAAE,mBAAmB,CAAA;CAC7B,GACD,OAAO,CAAA;AAEX,MAAM,MAAM,YAAY,GAAG,CAAC,IAAI,EAAE;IAChC,mBAAmB,EAAE,OAAO,CAAA;IAC5B,UAAU,EAAE,gBAAgB,CAAA;IAC5B,IAAI,EAAE,GAAG,CAAA;IACT,IAAI,EAAE,IAAI,CAAA;IACV,GAAG,EAAE,cAAc,CAAA;CACpB,KACG,OAAO,CAAC,QAAQ,GAAG,UAAU,CAAC,GAC9B,OAAO,CAAC,OAAO,CAAC,QAAQ,GAAG,UAAU,CAAC,CAAC,GACvC,OAAO,CAAC,IAAI,CAAC,GACb,IAAI,CAAA;AAER,MAAM,WAAW,cAAc;IAC7B,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,MAAM,YAAY,GAAG,CAAC,IAAI,EAAE;IAChC,UAAU,EAAE,gBAAgB,CAAA;IAC5B,GAAG,EAAE,QAAQ,GAAG,UAAU,GAAG,cAAc,CAAA;IAC3C,QAAQ,EAAE,MAAM,CAAA;IAChB,GAAG,EAAE,cAAc,CAAA;CACpB,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;AAE1B,MAAM,MAAM,WAAW,GAAG,CAAC,IAAI,EAAE;IAC/B,UAAU,EAAE,gBAAgB,CAAA;IAC5B,IAAI,EAAE,GAAG,CAAA;IACT,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,KAAK,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAA;AAE9B,MAAM,MAAM,aAAa,GAAG,CAC1B,GAAG,EAAE,cAAc,EACnB,IAAI,EAAE;IACJ,GAAG,CAAC,EAAE,UAAU,CAAA;IAChB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,MAAM,EAAE;QAAE,mBAAmB,CAAC,EAAE,OAAO,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;CACjG,KACE,OAAO,CAAC,QAAQ,CAAC,GAAG,QAAQ,CAAA;AAEjC,MAAM,WAAW,gBAAgB;IAC/B,aAAa,CAAC,EAAE,mBAAmB,CAAA;IACnC;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,EAAE,CAAA;IAChB;;OAEG;IACH,WAAW,CAAC,EAAE,WAAW,CAAA;IACzB,YAAY,EAAE,YAAY,CAAA;IAC1B,YAAY,EAAE,YAAY,CAAA;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,CAAC,EAAE,MAAM,IAAI,CAAA;IACnB,aAAa,EAAE,aAAa,CAAA;CAC7B;AAED,MAAM,MAAM,OAAO,GAAG,CAAC,IAAI,EAAE;IAAE,UAAU,EAAE,gBAAgB,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,KAAK,gBAAgB,CAAA;AAEnG,MAAM,MAAM,SAAS,GAAG,KAAK,CAAC;IAC5B,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAC,CAAA;AAEF,MAAM,MAAM,eAAe,GAAG,CAAC,IAAI,EAAE;IACnC,UAAU,EAAE,gBAAgB,CAAA;IAC5B,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,SAAS,CAAA;CACjB,KAAK,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAA;AAE9B,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,OAAO,GAAG,IAAI,CAAA;IACvB,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B,2BAA2B,CAAC,EAAE,IAAI,CAAA;IAClC,eAAe,CAAC,EAAE,eAAe,CAAA;IACjC,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,aAAa;IAC5B;;;;;;;;OAQG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B,WAAW,EAAE,OAAO,CAAC,MAAM,CAAC,oBAAoB,EAAE,iBAAiB,CAAC,CAAC,CAAA;IACrE;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;;;;;;;OAQG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAChB,KAAK,EACL,QAAQ,EACR,oBAAoB,EACpB,SAAS,EACT,cAAc,EACd,cAAc,EACd,UAAU,EACV,oBAAoB,EACpB,wBAAwB,EACxB,4BAA4B,EAC7B,MAAM,SAAS,CAAA;AAEhB,YAAY,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAEnD,MAAM,WAAW,IAAI;IACnB,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,eAAe,CAAC,EAAE,OAAO,CAAA;CAC1B;AAED,MAAM,MAAM,mBAAmB,GAAG;IAAE,MAAM,CAAC,EAAE,wBAAwB,CAAA;CAAE,GAAG,OAAO,CAAA;AAEjF;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,MAAM,EAAE,MAAM,CAAA;IACd,aAAa,EAAE,GAAG,MAAM,IAAI,MAAM,EAAE,CAAA;CACrC,CAAA;AAED,MAAM,MAAM,YAAY,GAAG,CAAC,IAAI,EAAE;IAChC,UAAU,EAAE,gBAAgB,CAAA;IAC5B,IAAI,EAAE,GAAG,CAAA;IACT,IAAI,EAAE,IAAI,CAAA;IACV,GAAG,EAAE,cAAc,CAAA;IACnB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAA;CACxB,KACG,OAAO,CAAC,QAAQ,GAAG,UAAU,CAAC,GAC9B,OAAO,CAAC,OAAO,CAAC,QAAQ,GAAG,UAAU,CAAC,CAAC,GACvC,OAAO,CAAC,IAAI,CAAC,GACb,IAAI,CAAA;AAER,MAAM,WAAW,cAAc;IAC7B,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,MAAM,YAAY,GAAG,CAAC,IAAI,EAAE;IAChC,UAAU,EAAE,gBAAgB,CAAA;IAC5B,GAAG,EAAE,QAAQ,GAAG,UAAU,GAAG,cAAc,CAAA;IAC3C,QAAQ,EAAE,MAAM,CAAA;IAChB,GAAG,EAAE,cAAc,CAAA;IACnB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAA;CACxB,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;AAE1B,MAAM,MAAM,WAAW,GAAG,CAAC,IAAI,EAAE;IAC/B,UAAU,EAAE,gBAAgB,CAAA;IAC5B,IAAI,EAAE,GAAG,CAAA;IACT,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,KAAK,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAA;AAE9B,MAAM,MAAM,aAAa,GAAG,CAC1B,GAAG,EAAE,cAAc,EACnB,IAAI,EAAE;IACJ,GAAG,CAAC,EAAE,UAAU,CAAA;IAChB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,MAAM,EAAE;QACN,UAAU,EAAE,MAAM,CAAA;QAClB,QAAQ,EAAE,MAAM,CAAA;QAChB,SAAS,CAAC,EAAE,oBAAoB,CAAA;QAChC,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,eAAe,CAAC,EAAE,OAAO,CAAA;KAC1B,CAAA;CACF,KACE,OAAO,CAAC,QAAQ,CAAC,GAAG,QAAQ,CAAA;AAEjC,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,EAAE,CAAA;IAChB;;OAEG;IACH,WAAW,CAAC,EAAE,WAAW,CAAA;IACzB,YAAY,EAAE,YAAY,CAAA;IAC1B,YAAY,EAAE,YAAY,CAAA;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;IACnC,aAAa,EAAE,aAAa,CAAA;IAC5B,oDAAoD;IACpD,kBAAkB,CAAC,EAAE;QACnB,YAAY,CAAC,EAAE;YACb,IAAI,EAAE,MAAM,CAAA;YACZ,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;SAChC,CAAA;QACD,OAAO,EAAE,OAAO,CAAA;QAChB,QAAQ,CAAC,EAAE;YACT,OAAO,EAAE,cAAc,CAAA;YACvB,IAAI,EAAE,IAAI,MAAM,EAAE,CAAA;SACnB,CAAA;KACF,GAAG,4BAA4B,CAAA;CACjC;AAED,MAAM,MAAM,OAAO,GAAG,CAAC,IAAI,EAAE;IAAE,UAAU,EAAE,gBAAgB,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,KAAK,gBAAgB,CAAA;AAEnG,MAAM,MAAM,SAAS,GAAG,KAAK,CAAC;IAC5B,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAC,CAAA;AAEF,MAAM,MAAM,eAAe,GAAG,CAAC,IAAI,EAAE;IACnC,UAAU,EAAE,gBAAgB,CAAA;IAC5B,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,SAAS,CAAA;CACjB,KAAK,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAA;AAE9B,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,OAAO,GAAG,IAAI,CAAA;IACvB,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B,2BAA2B,CAAC,EAAE,IAAI,CAAA;IAClC,eAAe,CAAC,EAAE,eAAe,CAAA;IACjC,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,aAAa;IAC5B,WAAW,EAAE,OAAO,CAAC,MAAM,CAAC,oBAAoB,EAAE,iBAAiB,CAAC,CAAC,CAAA;IACrE;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;;;;;;;OAQG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B"}

package/dist/types.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/types.ts"],"sourcesContent":["import type {\n  CollectionConfig,\n  Field,\n  FileData,\n  ImageSize,\n  PayloadRequest,\n  TypeWithID,\n  UploadCollectionSlug,\n} from 'payload'\n\nexport interface File {\n  buffer: Buffer\n  clientUploadContext?: unknown\n  filename: string\n  filesize: number\n  mimeType: string\n  tempFilePath?: string\n}\n\nexport type ClientUploadsAccess = (args: {\n  collectionSlug: UploadCollectionSlug\n  req: PayloadRequest\n}) => boolean | Promise<boolean>\n\nexport type ClientUploadsConfig =\n  | {\n      access?: ClientUploadsAccess\n    }\n  | boolean\n\nexport type HandleUpload = (args: {\n  clientUploadContext: unknown\n  collection: CollectionConfig\n  data: any\n  file: File\n  req: PayloadRequest\n}) =>\n  | Partial<FileData & TypeWithID>\n  | Promise<Partial<FileData & TypeWithID>>\n  | Promise<void>\n  | void\n\nexport interface TypeWithPrefix {\n  prefix?: string\n}\n\nexport type HandleDelete = (args: {\n  collection: CollectionConfig\n  doc: FileData & TypeWithID & TypeWithPrefix\n  filename: string\n  req: PayloadRequest\n}) => Promise<void> | void\n\nexport type GenerateURL = (args: {\n  collection: CollectionConfig\n  data: any\n  filename: string\n  prefix?: string\n}) => Promise<string> | string\n\nexport type StaticHandler = (\n  req: PayloadRequest,\n  args: {\n    doc?: TypeWithID\n    headers?: Headers\n    params: { clientUploadContext?: unknown; collection: string; filename: string; prefix?: string }\n  },\n) => Promise<Response> | Response\n\nexport interface GeneratedAdapter {\n  clientUploads?: ClientUploadsConfig\n  /**\n   * Additional fields to be injected into the base collection and image sizes\n   */\n  fields?: Field[]\n  /**\n   * Generates the public URL for a file\n   */\n  generateURL?: GenerateURL\n  handleDelete: HandleDelete\n  handleUpload: HandleUpload\n  name: string\n  onInit?: () => void\n  staticHandler: StaticHandler\n}\n\nexport type Adapter = (args: { collection: CollectionConfig; prefix?: string }) => GeneratedAdapter\n\nexport type AllowList = Array<{\n  hostname: string\n  pathname?: string\n  port?: string\n  protocol?: 'http' | 'https'\n  search?: string\n}>\n\nexport type GenerateFileURL = (args: {\n  collection: CollectionConfig\n  filename: string\n  prefix?: string\n  size?: ImageSize\n}) => Promise<string> | string\n\nexport interface CollectionOptions {\n  adapter: Adapter | null\n  disableLocalStorage?: boolean\n  disablePayloadAccessControl?: true\n  generateFileURL?: GenerateFileURL\n  prefix?: string\n}\n\nexport interface PluginOptions {\n  /**\n   * When enabled, fields (like the prefix field) will always be inserted into\n   * the collection schema regardless of whether the plugin is enabled. This\n   * ensures a consistent schema across all environments.\n   *\n   * This will be enabled by default in Payload v4.\n   *\n   * @default false\n   */\n  alwaysInsertFields?: boolean\n  collections: Partial<Record<UploadCollectionSlug, CollectionOptions>>\n  /**\n   * Whether or not to enable the plugin\n   *\n   * Default: true\n   */\n  enabled?: boolean\n  /**\n   * When true (compositional prefixes), the stored `prefix` field is only the\n   * document-level segment; the collection prefix comes from plugin options and\n   * must not be pre-filled as the field default.\n   *\n   * Set by storage adapters that support compositional prefixes (e.g. S3, Azure, R2, Vercel Blob, GCS).\n   *\n   * @default false\n   */\n  useCompositePrefixes?: boolean\n}\n"],"names":[],"mappings":"AA+GA,WA4BC"}
+{"version":3,"sources":["../src/types.ts"],"sourcesContent":["import type {\n  CollectionConfig,\n  Field,\n  FileData,\n  FileHandlerOperation,\n  ImageSize,\n  PayloadHandler,\n  PayloadRequest,\n  TypeWithID,\n  UploadCollectionSlug,\n  UploadInstructionsAccess,\n  UploadInstructionsCapability,\n} from 'payload'\n\nexport type { FileHandlerOperation } from 'payload'\n\nexport interface File {\n  buffer: Buffer\n  filename: string\n  filesize: number\n  mimeType: string\n  tempFilePath?: string\n  uploadReference?: unknown\n}\n\nexport type ClientUploadsConfig = { access?: UploadInstructionsAccess } | boolean\n\n/**\n * Reference to a client-uploaded object, returned by an upload handler and\n * submitted with the document. Always carries the signed receipt; `prefix`\n * locates the stored object.\n */\nexport type UploadReference = {\n  _objectKey?: string\n  prefix: string\n  signedReceipt: `${string}.${string}`\n}\n\nexport type HandleUpload = (args: {\n  collection: CollectionConfig\n  data: any\n  file: File\n  req: PayloadRequest\n  /**\n   * Pre-resolved storage path (`_objectKey` folded in, contained beneath the collection prefix).\n   */\n  storageFilePath: string\n}) =>\n  | Partial<FileData & TypeWithID>\n  | Promise<Partial<FileData & TypeWithID>>\n  | Promise<void>\n  | void\n\nexport interface TypeWithPrefix {\n  prefix?: string\n}\n\nexport type HandleDelete = (args: {\n  collection: CollectionConfig\n  doc: FileData & TypeWithID & TypeWithPrefix\n  filename: string\n  req: PayloadRequest\n  /**\n   * Pre-resolved storage path of the object to delete.\n   */\n  storageFilePath: string\n}) => Promise<void> | void\n\nexport type GenerateURL = (args: {\n  collection: CollectionConfig\n  data: any\n  filename: string\n  prefix?: string\n}) => Promise<string> | string\n\nexport type StaticHandler = (\n  req: PayloadRequest,\n  args: {\n    doc?: TypeWithID\n    headers?: Headers\n    params: {\n      collection: string\n      filename: string\n      operation?: FileHandlerOperation\n      prefix?: string\n      uploadReference?: unknown\n    }\n  },\n) => Promise<Response> | Response\n\nexport interface GeneratedAdapter {\n  /**\n   * Additional fields to be injected into the base collection and image sizes\n   */\n  fields?: Field[]\n  /**\n   * Generates the public URL for a file\n   */\n  generateURL?: GenerateURL\n  handleDelete: HandleDelete\n  handleUpload: HandleUpload\n  name: string\n  onInit?: () => Promise<void> | void\n  staticHandler: StaticHandler\n  /** Generates upload instructions when supported. */\n  uploadInstructions?: {\n    adminHandler?: {\n      path: string\n      props?: Record<string, unknown>\n    }\n    enabled: boolean\n    endpoint?: {\n      handler: PayloadHandler\n      path: `/${string}`\n    }\n  } & UploadInstructionsCapability\n}\n\nexport type Adapter = (args: { collection: CollectionConfig; prefix?: string }) => GeneratedAdapter\n\nexport type AllowList = Array<{\n  hostname: string\n  pathname?: string\n  port?: string\n  protocol?: 'http' | 'https'\n  search?: string\n}>\n\nexport type GenerateFileURL = (args: {\n  collection: CollectionConfig\n  filename: string\n  prefix?: string\n  size?: ImageSize\n}) => Promise<string> | string\n\nexport interface CollectionOptions {\n  adapter: Adapter | null\n  disableLocalStorage?: boolean\n  disablePayloadAccessControl?: true\n  generateFileURL?: GenerateFileURL\n  prefix?: string\n}\n\nexport interface PluginOptions {\n  collections: Partial<Record<UploadCollectionSlug, CollectionOptions>>\n  /**\n   * Whether or not to enable the plugin\n   *\n   * Default: true\n   */\n  enabled?: boolean\n  /**\n   * When true (compositional prefixes), the stored `prefix` field is only the\n   * document-level segment; the collection prefix comes from plugin options and\n   * must not be pre-filled as the field default.\n   *\n   * Set by storage adapters that support compositional prefixes (e.g. S3, Azure, R2, Vercel Blob, GCS).\n   *\n   * @default false\n   */\n  useCompositePrefixes?: boolean\n}\n"],"names":[],"mappings":"AA+IA,WAkBC"}

package/dist/utilities/buildPrefixWithObjectKey.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Joins the semantic prefix and the `_objectKey` segment into the object's folder; either may be empty.
+ */
+export declare const buildPrefixWithObjectKey: ({ objectKey, prefix, }: {
+    objectKey?: string;
+    prefix?: string;
+}) => string;
+//# sourceMappingURL=buildPrefixWithObjectKey.d.ts.map

package/dist/utilities/buildPrefixWithObjectKey.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"buildPrefixWithObjectKey.d.ts","sourceRoot":"","sources":["../../src/utilities/buildPrefixWithObjectKey.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,eAAO,MAAM,wBAAwB,2BAGlC;IACD,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,KAAG,MASH,CAAA"}

package/dist/utilities/buildPrefixWithObjectKey.js

@@ -0,0 +1,13 @@
+import { sanitizePrefix } from './sanitizePrefix.js';
+/**
+ * Joins the semantic prefix and the `_objectKey` segment into the object's folder; either may be empty.
+ */ export const buildPrefixWithObjectKey = ({ objectKey, prefix })=>{
+    const safePrefix = sanitizePrefix(prefix ?? '');
+    const safeObjectKey = sanitizePrefix(objectKey ?? '');
+    if (safePrefix && safeObjectKey) {
+        return `${safePrefix}/${safeObjectKey}`;
+    }
+    return safePrefix || safeObjectKey;
+};
+
+//# sourceMappingURL=buildPrefixWithObjectKey.js.map

package/dist/utilities/buildPrefixWithObjectKey.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/utilities/buildPrefixWithObjectKey.ts"],"sourcesContent":["import { sanitizePrefix } from './sanitizePrefix.js'\n\n/**\n * Joins the semantic prefix and the `_objectKey` segment into the object's folder; either may be empty.\n */\nexport const buildPrefixWithObjectKey = ({\n  objectKey,\n  prefix,\n}: {\n  objectKey?: string\n  prefix?: string\n}): string => {\n  const safePrefix = sanitizePrefix(prefix ?? '')\n  const safeObjectKey = sanitizePrefix(objectKey ?? '')\n\n  if (safePrefix && safeObjectKey) {\n    return `${safePrefix}/${safeObjectKey}`\n  }\n\n  return safePrefix || safeObjectKey\n}\n"],"names":["sanitizePrefix","buildPrefixWithObjectKey","objectKey","prefix","safePrefix","safeObjectKey"],"mappings":"AAAA,SAASA,cAAc,QAAQ,sBAAqB;AAEpD;;CAEC,GACD,OAAO,MAAMC,2BAA2B,CAAC,EACvCC,SAAS,EACTC,MAAM,EAIP;IACC,MAAMC,aAAaJ,eAAeG,UAAU;IAC5C,MAAME,gBAAgBL,eAAeE,aAAa;IAElD,IAAIE,cAAcC,eAAe;QAC/B,OAAO,GAAGD,WAAW,CAAC,EAAEC,eAAe;IACzC;IAEA,OAAOD,cAAcC;AACvB,EAAC"}

package/dist/utilities/buildStoragePathData.d.ts

@@ -0,0 +1,49 @@
+type BuildFilePathDataArgs = {
+    collectionPrefix?: string;
+    docPrefix?: string;
+    filename: string;
+    useCompositePrefixes?: boolean;
+};
+type BuildFilePathDataResult = {
+    sanitizedCollectionPrefix: string;
+    sanitizedDocPrefix: string;
+    sanitizedFilename: string;
+    /**
+     * The full path to the file within the storage backend.
+     */
+    storageFilePath: string;
+};
+export declare function isStoragePathWithinCollectionPrefix({ collectionPrefix, docPrefix, }: {
+    collectionPrefix?: string;
+    docPrefix: string;
+}): boolean;
+/**
+ * Resolves where a new upload must be stored, without needing a filename.
+ *
+ * In non-composite mode (useCompositePrefixes: false), docPrefix is treated as a complete prefix
+ * when it is already within collectionPrefix and is otherwise nested beneath collectionPrefix.
+ * In composite mode (useCompositePrefixes: true), the collection prefix is joined when the key is
+ * built, so the persisted document prefix stays relative to it.
+ *
+ * Prefix-only callers (such as the upload prefix hooks) use this directly; use
+ * {@link buildUploadStoragePathData} when a full object key is needed.
+ */
+export declare function buildUploadPrefix({ collectionPrefix, docPrefix, useCompositePrefixes, }: Omit<BuildFilePathDataArgs, 'filename'>): {
+    sanitizedCollectionPrefix: string;
+    sanitizedDocPrefix: string;
+    uploadPrefix: string;
+};
+/**
+ * Resolves a new upload destination beneath the configured collection prefix.
+ * Both prefixes are passed through {@link sanitizePrefix} so keys stay normalized.
+ */
+export declare function buildUploadStoragePathData({ collectionPrefix, docPrefix, filename, useCompositePrefixes, }: BuildFilePathDataArgs): BuildFilePathDataResult;
+/**
+ * Resolves the exact location represented by persisted upload metadata.
+ * Non-composite document prefixes historically override the collection prefix;
+ * keep that behavior for reads, URLs, and cleanup of pre-upgrade files.
+ * New writes must use buildUploadStoragePathData instead.
+ */
+export declare function buildStoragePathData({ collectionPrefix, docPrefix, filename, useCompositePrefixes, }: BuildFilePathDataArgs): BuildFilePathDataResult;
+export {};
+//# sourceMappingURL=buildStoragePathData.d.ts.map

package/dist/utilities/buildStoragePathData.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"buildStoragePathData.d.ts","sourceRoot":"","sources":["../../src/utilities/buildStoragePathData.ts"],"names":[],"mappings":"AAKA,KAAK,qBAAqB,GAAG;IAC3B,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,MAAM,CAAA;IAChB,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B,CAAA;AAED,KAAK,uBAAuB,GAAG;IAC7B,yBAAyB,EAAE,MAAM,CAAA;IACjC,kBAAkB,EAAE,MAAM,CAAA;IAC1B,iBAAiB,EAAE,MAAM,CAAA;IACzB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAA;CACxB,CAAA;AAED,wBAAgB,mCAAmC,CAAC,EAClD,gBAAgB,EAChB,SAAS,GACV,EAAE;IACD,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,SAAS,EAAE,MAAM,CAAA;CAClB,GAAG,OAAO,CAQV;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,iBAAiB,CAAC,EAChC,gBAAgB,EAChB,SAAS,EACT,oBAA4B,GAC7B,EAAE,IAAI,CAAC,qBAAqB,EAAE,UAAU,CAAC,GAAG;IAC3C,yBAAyB,EAAE,MAAM,CAAA;IACjC,kBAAkB,EAAE,MAAM,CAAA;IAC1B,YAAY,EAAE,MAAM,CAAA;CACrB,CAiBA;AAED;;;GAGG;AACH,wBAAgB,0BAA0B,CAAC,EACzC,gBAAgB,EAChB,SAAS,EACT,QAAQ,EACR,oBAA4B,GAC7B,EAAE,qBAAqB,GAAG,uBAAuB,CAkBjD;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,EACnC,gBAAgB,EAChB,SAAS,EACT,QAAQ,EACR,oBAA4B,GAC7B,EAAE,qBAAqB,GAAG,uBAAuB,CAcjD"}