npm - payload - Versions diffs - 4.0.0-internal.4cbdd50 → 4.0.0-internal.4e1f822 - Mend

payload 4.0.0-internal.4cbdd50 → 4.0.0-internal.4e1f822

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1347) hide show

package/dist/uploads/stagedUpload.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"sources":["../../src/uploads/stagedUpload.ts"],"sourcesContent":["import { jwtVerify } from 'jose'\nimport { randomUUID } from 'node:crypto'\nimport fs from 'node:fs/promises'\nimport os from 'node:os'\nimport path from 'node:path'\n\nimport type { PayloadHandler } from '../config/types.js'\nimport type { PayloadRequest } from '../types/index.js'\nimport type { File, UploadInstructions, UploadInstructionsRequest } from './types.js'\n\nimport { jwtSign } from '../auth/jwt.js'\nimport { APIError, Forbidden } from '../errors/index.js'\nimport { formatAdminURL } from '../utilities/formatAdminURL.js'\nimport { checkFileRestrictions } from './checkFileRestrictions.js'\n\n/**\n * Creates a signed, one-hour URL where the client can send the file bytes. The returned file value\n * is later passed to a document create or update request.\n */\nexport const generateStagedUploadInstructions = async ({\n collectionSlug,\n docPrefix,\n filename,\n filesize,\n mimeType,\n req,\n}: { req: PayloadRequest } & UploadInstructionsRequest): Promise<UploadInstructions> => {\n await removeExpiredUploads(req, collectionSlug)\n\n const { token: uploadId } = await jwtSign({\n fieldsToSign: {\n id: randomUUID(),\n collectionSlug,\n docPrefix,\n filename,\n filesize,\n mimeType,\n user: getUser(req),\n },\n secret: req.payload.secret,\n tokenExpiration,\n })\n\n return {\n type: 'http',\n file: {\n filename,\n mimeType,\n size: filesize,\n uploadReference: { uploadId },\n },\n request: {\n headers: {\n 'Content-Length': String(filesize),\n 'Content-Type': mimeType,\n },\n method: 'PUT',\n url: formatAdminURL({\n apiRoute: req.payload.config.routes.api,\n path: `/upload-instructions/${uploadId}`,\n serverURL: req.payload.config.serverURL,\n }),\n },\n }\n}\n\n/**\n * Saves the bytes sent to a signed upload URL. The file is written as a partial file first and only\n * becomes available when its size exactly matches the size in the upload ID.\n */\nexport const uploadStagedFile: PayloadHandler = async (req) => {\n const upload = await verifyUploadID(req, req.routeParams?.uploadId)\n const directory = await getUploadDirectory(req, upload.collectionSlug)\n const uploadPath = path.join(directory, upload.id)\n const temporaryPath = `${uploadPath}.${randomUUID()}.part`\n const file = await fs.open(temporaryPath, 'wx')\n let uploadedSize = 0\n\n try {\n try {\n const reader = req.body?.getReader()\n\n while (reader) {\n const { done, value } = await reader.read()\n\n if (done) {\n break\n }\n\n uploadedSize += value.byteLength\n if (uploadedSize > upload.filesize) {\n throw new APIError('Uploaded file is larger than expected.', 400)\n }\n\n let offset = 0\n while (offset < value.byteLength) {\n const { bytesWritten } = await file.write(value, offset)\n offset += bytesWritten\n }\n }\n\n if (uploadedSize !== upload.filesize) {\n throw new APIError('Uploaded file size does not match the expected size.', 400)\n }\n } finally {\n await file.close()\n }\n\n const collection = req.payload.collections[upload.collectionSlug]!.config\n await checkFileRestrictions({\n collection,\n file: {\n name: upload.filename,\n data: Buffer.alloc(0),\n mimetype: upload.mimeType,\n size: upload.filesize,\n tempFilePath: temporaryPath,\n },\n req,\n })\n\n await fs.rename(temporaryPath, uploadPath)\n } catch (error) {\n await fs.rm(temporaryPath, { force: true })\n throw error\n }\n\n return new Response(null, { status: 204 })\n}\n\n/** Removes a temporary upload that the client no longer needs. */\nexport const deleteStagedFile: PayloadHandler = async (req) => {\n const upload = await verifyUploadID(req, req.routeParams?.uploadId)\n const directory = await getUploadDirectory(req, upload.collectionSlug)\n\n await fs.rm(path.join(directory, upload.id), { force: true })\n\n return new Response(null, { status: 204 })\n}\n\n/**\n * Loads a completed staged file for a document request. Only the same user and collection can use\n * it, and the temporary file is deleted after it is read.\n */\nexport const getStagedFile = async ({\n collectionSlug,\n req,\n uploadReference,\n}: {\n collectionSlug: string\n req: PayloadRequest\n uploadReference: unknown\n}): Promise<File> => {\n if (\n !uploadReference ||\n typeof uploadReference !== 'object' ||\n Array.isArray(uploadReference) ||\n !('uploadId' in uploadReference) ||\n typeof uploadReference.uploadId !== 'string'\n ) {\n throw new APIError('Invalid staged upload.', 400)\n }\n\n const { uploadId } = uploadReference\n const upload = await verifyUploadID(req, uploadId)\n\n if (upload.collectionSlug !== collectionSlug || upload.user !== getUser(req)) {\n throw new Forbidden(req.t)\n }\n\n const directory = await getUploadDirectory(req, upload.collectionSlug)\n const tempFilePath = path.join(directory, upload.id)\n let data: Buffer\n\n try {\n data = await fs.readFile(tempFilePath)\n } catch {\n throw new APIError('Staged upload was not found.', 400)\n }\n\n if (data.length !== upload.filesize) {\n await fs.rm(tempFilePath, { force: true })\n throw new APIError('Staged upload is incomplete.', 400)\n }\n\n await fs.rm(tempFilePath, { force: true })\n\n return {\n name: upload.filename,\n data,\n mimetype: upload.mimeType,\n size: data.length,\n }\n}\n\n/**\n * Staged uploads hold a file temporarily until a document create or update uses it. The signed\n * upload ID remembers which file and user the upload belongs to.\n */\nconst tokenExpiration = 60 * 60\n\n/** The file details stored inside the signed upload ID. */\ntype StagedUploadToken = {\n id: string\n user: null | string\n} & UploadInstructionsRequest\n\nconst getUser = (req: PayloadRequest) =>\n req.user ? `${req.user.collection}:${String(req.user.id)}` : null\n\n/** Returns the hidden folder where temporary uploads for this collection are stored. */\nconst getUploadDirectory = async (req: PayloadRequest, collectionSlug: string) => {\n const upload = req.payload.collections[collectionSlug]?.config.upload\n const directory = path.resolve(\n upload && !upload.disableLocalStorage\n ? upload.staticDir || collectionSlug\n : req.payload.config.upload.tempFileDir || os.tmpdir(),\n '.payload-staged-uploads',\n )\n\n await fs.mkdir(directory, { recursive: true })\n\n return directory\n}\n\n/** Removes temporary files older than the one-hour upload window. */\nconst removeExpiredUploads = async (req: PayloadRequest, collectionSlug: string) => {\n const directory = await getUploadDirectory(req, collectionSlug)\n const expiresBefore = Date.now() - tokenExpiration * 1000\n\n for (const filename of await fs.readdir(directory)) {\n const filePath = path.join(directory, filename)\n const stats = await fs.stat(filePath).catch(() => null)\n\n if (stats && stats.mtimeMs < expiresBefore) {\n await fs.rm(filePath, { force: true })\n }\n }\n}\n\n/** Verifies that an upload ID was signed by Payload, has not expired, and contains valid details. */\nconst verifyUploadID = async (\n req: PayloadRequest,\n uploadID: unknown,\n): Promise<StagedUploadToken> => {\n try {\n if (typeof uploadID !== 'string') {\n throw new Error()\n }\n\n const secret = new TextEncoder().encode(req.payload.secret)\n const { payload } = await jwtVerify<StagedUploadToken>(uploadID, secret)\n\n if (\n typeof payload.id !== 'string' ||\n !/^[\\da-f-]{36}$/i.test(payload.id) ||\n typeof payload.collectionSlug !== 'string' ||\n typeof payload.filename !== 'string' ||\n !Number.isSafeInteger(payload.filesize) ||\n payload.filesize < 0 ||\n typeof payload.mimeType !== 'string' ||\n (payload.user !== null && typeof payload.user !== 'string')\n ) {\n throw new Error()\n }\n\n return payload as StagedUploadToken\n } catch {\n throw new APIError('Invalid or expired staged upload.', 400)\n }\n}\n"],"names":["jwtVerify","randomUUID","fs","os","path","jwtSign","APIError","Forbidden","formatAdminURL","checkFileRestrictions","generateStagedUploadInstructions","collectionSlug","docPrefix","filename","filesize","mimeType","req","removeExpiredUploads","token","uploadId","fieldsToSign","id","user","getUser","secret","payload","tokenExpiration","type","file","size","uploadReference","request","headers","String","method","url","apiRoute","config","routes","api","serverURL","uploadStagedFile","upload","verifyUploadID","routeParams","directory","getUploadDirectory","uploadPath","join","temporaryPath","open","uploadedSize","reader","body","getReader","done","value","read","byteLength","offset","bytesWritten","write","close","collection","collections","name","data","Buffer","alloc","mimetype","tempFilePath","rename","error","rm","force","Response","status","deleteStagedFile","getStagedFile","Array","isArray","t","readFile","length","resolve","disableLocalStorage","staticDir","tempFileDir","tmpdir","mkdir","recursive","expiresBefore","Date","now","readdir","filePath","stats","stat","catch","mtimeMs","uploadID","Error","TextEncoder","encode","test","Number","isSafeInteger"],"mappings":"AAAA,SAASA,SAAS,QAAQ,OAAM;AAChC,SAASC,UAAU,QAAQ,cAAa;AACxC,OAAOC,QAAQ,mBAAkB;AACjC,OAAOC,QAAQ,UAAS;AACxB,OAAOC,UAAU,YAAW;AAM5B,SAASC,OAAO,QAAQ,iBAAgB;AACxC,SAASC,QAAQ,EAAEC,SAAS,QAAQ,qBAAoB;AACxD,SAASC,cAAc,QAAQ,iCAAgC;AAC/D,SAASC,qBAAqB,QAAQ,6BAA4B;AAElE;;;CAGC,GACD,OAAO,MAAMC,mCAAmC,OAAO,EACrDC,cAAc,EACdC,SAAS,EACTC,QAAQ,EACRC,QAAQ,EACRC,QAAQ,EACRC,GAAG,EACiD;IACpD,MAAMC,qBAAqBD,KAAKL;IAEhC,MAAM,EAAEO,OAAOC,QAAQ,EAAE,GAAG,MAAMd,QAAQ;QACxCe,cAAc;YACZC,IAAIpB;YACJU;YACAC;YACAC;YACAC;YACAC;YACAO,MAAMC,QAAQP;QAChB;QACAQ,QAAQR,IAAIS,OAAO,CAACD,MAAM;QAC1BE;IACF;IAEA,OAAO;QACLC,MAAM;QACNC,MAAM;YACJf;YACAE;YACAc,MAAMf;YACNgB,iBAAiB;gBAAEX;YAAS;QAC9B;QACAY,SAAS;YACPC,SAAS;gBACP,kBAAkBC,OAAOnB;gBACzB,gBAAgBC;YAClB;YACAmB,QAAQ;YACRC,KAAK3B,eAAe;gBAClB4B,UAAUpB,IAAIS,OAAO,CAACY,MAAM,CAACC,MAAM,CAACC,GAAG;gBACvCnC,MAAM,CAAC,qBAAqB,EAAEe,UAAU;gBACxCqB,WAAWxB,IAAIS,OAAO,CAACY,MAAM,CAACG,SAAS;YACzC;QACF;IACF;AACF,EAAC;AAED;;;CAGC,GACD,OAAO,MAAMC,mBAAmC,OAAOzB;IACrD,MAAM0B,SAAS,MAAMC,eAAe3B,KAAKA,IAAI4B,WAAW,EAAEzB;IAC1D,MAAM0B,YAAY,MAAMC,mBAAmB9B,KAAK0B,OAAO/B,cAAc;IACrE,MAAMoC,aAAa3C,KAAK4C,IAAI,CAACH,WAAWH,OAAOrB,EAAE;IACjD,MAAM4B,gBAAgB,GAAGF,WAAW,CAAC,EAAE9C,aAAa,KAAK,CAAC;IAC1D,MAAM2B,OAAO,MAAM1B,GAAGgD,IAAI,CAACD,eAAe;IAC1C,IAAIE,eAAe;IAEnB,IAAI;QACF,IAAI;YACF,MAAMC,SAASpC,IAAIqC,IAAI,EAAEC;YAEzB,MAAOF,OAAQ;gBACb,MAAM,EAAEG,IAAI,EAAEC,KAAK,EAAE,GAAG,MAAMJ,OAAOK,IAAI;gBAEzC,IAAIF,MAAM;oBACR;gBACF;gBAEAJ,gBAAgBK,MAAME,UAAU;gBAChC,IAAIP,eAAeT,OAAO5B,QAAQ,EAAE;oBAClC,MAAM,IAAIR,SAAS,0CAA0C;gBAC/D;gBAEA,IAAIqD,SAAS;gBACb,MAAOA,SAASH,MAAME,UAAU,CAAE;oBAChC,MAAM,EAAEE,YAAY,EAAE,GAAG,MAAMhC,KAAKiC,KAAK,CAACL,OAAOG;oBACjDA,UAAUC;gBACZ;YACF;YAEA,IAAIT,iBAAiBT,OAAO5B,QAAQ,EAAE;gBACpC,MAAM,IAAIR,SAAS,wDAAwD;YAC7E;QACF,SAAU;YACR,MAAMsB,KAAKkC,KAAK;QAClB;QAEA,MAAMC,aAAa/C,IAAIS,OAAO,CAACuC,WAAW,CAACtB,OAAO/B,cAAc,CAAC,CAAE0B,MAAM;QACzE,MAAM5B,sBAAsB;YAC1BsD;YACAnC,MAAM;gBACJqC,MAAMvB,OAAO7B,QAAQ;gBACrBqD,MAAMC,OAAOC,KAAK,CAAC;gBACnBC,UAAU3B,OAAO3B,QAAQ;gBACzBc,MAAMa,OAAO5B,QAAQ;gBACrBwD,cAAcrB;YAChB;YACAjC;QACF;QAEA,MAAMd,GAAGqE,MAAM,CAACtB,eAAeF;IACjC,EAAE,OAAOyB,OAAO;QACd,MAAMtE,GAAGuE,EAAE,CAACxB,eAAe;YAAEyB,OAAO;QAAK;QACzC,MAAMF;IACR;IAEA,OAAO,IAAIG,SAAS,MAAM;QAAEC,QAAQ;IAAI;AAC1C,EAAC;AAED,gEAAgE,GAChE,OAAO,MAAMC,mBAAmC,OAAO7D;IACrD,MAAM0B,SAAS,MAAMC,eAAe3B,KAAKA,IAAI4B,WAAW,EAAEzB;IAC1D,MAAM0B,YAAY,MAAMC,mBAAmB9B,KAAK0B,OAAO/B,cAAc;IAErE,MAAMT,GAAGuE,EAAE,CAACrE,KAAK4C,IAAI,CAACH,WAAWH,OAAOrB,EAAE,GAAG;QAAEqD,OAAO;IAAK;IAE3D,OAAO,IAAIC,SAAS,MAAM;QAAEC,QAAQ;IAAI;AAC1C,EAAC;AAED;;;CAGC,GACD,OAAO,MAAME,gBAAgB,OAAO,EAClCnE,cAAc,EACdK,GAAG,EACHc,eAAe,EAKhB;IACC,IACE,CAACA,mBACD,OAAOA,oBAAoB,YAC3BiD,MAAMC,OAAO,CAAClD,oBACd,CAAE,CAAA,cAAcA,eAAc,KAC9B,OAAOA,gBAAgBX,QAAQ,KAAK,UACpC;QACA,MAAM,IAAIb,SAAS,0BAA0B;IAC/C;IAEA,MAAM,EAAEa,QAAQ,EAAE,GAAGW;IACrB,MAAMY,SAAS,MAAMC,eAAe3B,KAAKG;IAEzC,IAAIuB,OAAO/B,cAAc,KAAKA,kBAAkB+B,OAAOpB,IAAI,KAAKC,QAAQP,MAAM;QAC5E,MAAM,IAAIT,UAAUS,IAAIiE,CAAC;IAC3B;IAEA,MAAMpC,YAAY,MAAMC,mBAAmB9B,KAAK0B,OAAO/B,cAAc;IACrE,MAAM2D,eAAelE,KAAK4C,IAAI,CAACH,WAAWH,OAAOrB,EAAE;IACnD,IAAI6C;IAEJ,IAAI;QACFA,OAAO,MAAMhE,GAAGgF,QAAQ,CAACZ;IAC3B,EAAE,OAAM;QACN,MAAM,IAAIhE,SAAS,gCAAgC;IACrD;IAEA,IAAI4D,KAAKiB,MAAM,KAAKzC,OAAO5B,QAAQ,EAAE;QACnC,MAAMZ,GAAGuE,EAAE,CAACH,cAAc;YAAEI,OAAO;QAAK;QACxC,MAAM,IAAIpE,SAAS,gCAAgC;IACrD;IAEA,MAAMJ,GAAGuE,EAAE,CAACH,cAAc;QAAEI,OAAO;IAAK;IAExC,OAAO;QACLT,MAAMvB,OAAO7B,QAAQ;QACrBqD;QACAG,UAAU3B,OAAO3B,QAAQ;QACzBc,MAAMqC,KAAKiB,MAAM;IACnB;AACF,EAAC;AAED;;;CAGC,GACD,MAAMzD,kBAAkB,KAAK;AAQ7B,MAAMH,UAAU,CAACP,MACfA,IAAIM,IAAI,GAAG,GAAGN,IAAIM,IAAI,CAACyC,UAAU,CAAC,CAAC,EAAE9B,OAAOjB,IAAIM,IAAI,CAACD,EAAE,GAAG,GAAG;AAE/D,sFAAsF,GACtF,MAAMyB,qBAAqB,OAAO9B,KAAqBL;IACrD,MAAM+B,SAAS1B,IAAIS,OAAO,CAACuC,WAAW,CAACrD,eAAe,EAAE0B,OAAOK;IAC/D,MAAMG,YAAYzC,KAAKgF,OAAO,CAC5B1C,UAAU,CAACA,OAAO2C,mBAAmB,GACjC3C,OAAO4C,SAAS,IAAI3E,iBACpBK,IAAIS,OAAO,CAACY,MAAM,CAACK,MAAM,CAAC6C,WAAW,IAAIpF,GAAGqF,MAAM,IACtD;IAGF,MAAMtF,GAAGuF,KAAK,CAAC5C,WAAW;QAAE6C,WAAW;IAAK;IAE5C,OAAO7C;AACT;AAEA,mEAAmE,GACnE,MAAM5B,uBAAuB,OAAOD,KAAqBL;IACvD,MAAMkC,YAAY,MAAMC,mBAAmB9B,KAAKL;IAChD,MAAMgF,gBAAgBC,KAAKC,GAAG,KAAKnE,kBAAkB;IAErD,KAAK,MAAMb,YAAY,CAAA,MAAMX,GAAG4F,OAAO,CAACjD,UAAS,EAAG;QAClD,MAAMkD,WAAW3F,KAAK4C,IAAI,CAACH,WAAWhC;QACtC,MAAMmF,QAAQ,MAAM9F,GAAG+F,IAAI,CAACF,UAAUG,KAAK,CAAC,IAAM;QAElD,IAAIF,SAASA,MAAMG,OAAO,GAAGR,eAAe;YAC1C,MAAMzF,GAAGuE,EAAE,CAACsB,UAAU;gBAAErB,OAAO;YAAK;QACtC;IACF;AACF;AAEA,mGAAmG,GACnG,MAAM/B,iBAAiB,OACrB3B,KACAoF;IAEA,IAAI;QACF,IAAI,OAAOA,aAAa,UAAU;YAChC,MAAM,IAAIC;QACZ;QAEA,MAAM7E,SAAS,IAAI8E,cAAcC,MAAM,CAACvF,IAAIS,OAAO,CAACD,MAAM;QAC1D,MAAM,EAAEC,OAAO,EAAE,GAAG,MAAMzB,UAA6BoG,UAAU5E;QAEjE,IACE,OAAOC,QAAQJ,EAAE,KAAK,YACtB,CAAC,kBAAkBmF,IAAI,CAAC/E,QAAQJ,EAAE,KAClC,OAAOI,QAAQd,cAAc,KAAK,YAClC,OAAOc,QAAQZ,QAAQ,KAAK,YAC5B,CAAC4F,OAAOC,aAAa,CAACjF,QAAQX,QAAQ,KACtCW,QAAQX,QAAQ,GAAG,KACnB,OAAOW,QAAQV,QAAQ,KAAK,YAC3BU,QAAQH,IAAI,KAAK,QAAQ,OAAOG,QAAQH,IAAI,KAAK,UAClD;YACA,MAAM,IAAI+E;QACZ;QAEA,OAAO5E;IACT,EAAE,OAAM;QACN,MAAM,IAAInB,SAAS,qCAAqC;IAC1D;AACF"}

package/dist/uploads/types.d.ts CHANGED Viewed

@@ -1,6 +1,7 @@
 import type { ResizeOptions, Sharp, SharpOptions } from 'sharp';
 import type { CollectionConfig, TypeWithID } from '../collections/config/types.js';
 import type { PayloadComponent } from '../config/types.js';
+import type { UploadCollectionSlug } from '../index.js';
 import type { PayloadRequest } from '../types/index.js';
 import type { WithMetadata } from './optionallyAppendMetadata.js';
 export type FileSize = {
@@ -50,7 +51,7 @@ export type GenerateImageName = (args: {
     sizeName: string;
     width: number;
 }) => string;
-export type ImageSize = {
+type ImageSizeBase = {
     /**
      * Admin UI options that control how this image size appears in list views.
      */
@@ -69,16 +70,21 @@ export type ImageSize = {
             groupBy?: boolean;
         };
     };
-    /**
-     * @deprecated prefer position
-     */
-    crop?: string;
-    formatOptions?: ImageUploadFormatOptions;
     /**
      * Generate a custom name for the file of this image size.
      */
     generateImageName?: GenerateImageName;
     name: string;
+};
+/**
+ * Image size options implemented by Payload's default Sharp image processor.
+ */
+export type SharpImageSizeOptions = {
+    /**
+     * @deprecated prefer position
+     */
+    crop?: string;
+    formatOptions?: ImageUploadFormatOptions;
     trimOptions?: ImageUploadTrimOptions;
     /**
      * When an uploaded image is smaller than the defined image size, we have 3 options:
@@ -91,6 +97,23 @@ export type ImageSize = {
      */
     withoutEnlargement?: ResizeOptions['withoutEnlargement'];
 } & Omit<ResizeOptions, 'withoutEnlargement'>;
+/**
+ * Interface to be module-augmented by image processing providers.
+ *
+ * When no provider is registered, ImageSize uses SharpImageSizeOptions.
+ * When providers are registered, ImageSize uses their registered options instead.
+ *
+ * @example
+ * declare module 'payload' {
+ *   interface RegisteredImageSizeOptions {
+ *     myProvider: MyProviderImageSizeOptions
+ *   }
+ * }
+ */
+export interface RegisteredImageSizeOptions {
+}
+type ImageSizeOptions = keyof RegisteredImageSizeOptions extends never ? SharpImageSizeOptions : RegisteredImageSizeOptions[keyof RegisteredImageSizeOptions];
+export type ImageSize = ImageSizeBase & ImageSizeOptions;
 export type GetAdminThumbnail = (args: {
     doc: Record<string, unknown>;
 }) => false | null | string;
@@ -105,12 +128,33 @@ export type FileAllowList = Array<{
     extensions: string[];
     mimeType: string;
 }>;
+export type UploadFilePreviewClientProps = {
+    filename: string;
+    filesize: number;
+    /** Resolved URL of the file (data.url). */
+    fileSrc: string;
+    height?: number;
+    mimeType: string;
+    width?: number;
+};
+type UploadFilePreviewMap = {
+    [mimeTypePattern: string]: PayloadComponent;
+};
 type Admin = {
     components?: {
         /**
          * The Controls component to extend the upload controls in the admin panel.
          */
         controls?: PayloadComponent[];
+        /**
+         * A custom component to render in place of the default Thumbnail in the upload side panel.
+         *
+         * Can be a single PayloadComponent (renders for all MIME types) or a Record keyed by
+         * MIME type patterns. Pattern resolution priority: exact match → category wildcard
+         * (e.g. `video/*`) → universal fallback (`*`). Falls back to the default Thumbnail
+         * when nothing matches.
+         */
+        filePreview?: PayloadComponent | UploadFilePreviewMap;
     };
 };
 export type UploadConfig = {
@@ -213,10 +257,10 @@ export type UploadConfig = {
         doc: TypeWithID;
         headers?: Headers;
         params: {
-            clientUploadContext?: unknown;
             collection: string;
             filename: string;
             prefix?: string;
+            uploadReference?: unknown;
         };
     }) => Promise<Response> | Promise<void> | Response | void)[];
     /**
@@ -268,6 +312,11 @@ export type UploadConfig = {
      */
     staticDir?: string;
     trimOptions?: ImageUploadTrimOptions;
+    /**
+     * Adapter-provided upload instructions.
+     * @internal
+     */
+    uploadInstructions?: UploadInstructionsCapability;
     /**
      * Optionally append metadata to the image during processing.
      *
@@ -280,7 +329,53 @@ export type UploadConfig = {
      */
     withMetadata?: WithMetadata;
 };
+export type UploadInstructionsAccess = (args: {
+    collectionSlug: UploadCollectionSlug;
+    req: PayloadRequest;
+}) => boolean | Promise<boolean>;
+export type UploadInstructionsRequest = {
+    collectionSlug: UploadCollectionSlug;
+    docPrefix?: string;
+    filename: string;
+    filesize: number;
+    mimeType: string;
+};
+export type UploadInstructions = {
+    file: {
+        collectionSlug?: UploadCollectionSlug;
+        filename: string;
+        mimeType: string;
+        size: number;
+        uploadReference: Record<string, unknown>;
+    };
+} & ({
+    data?: unknown;
+    name: string;
+    type: 'dispatch';
+} | {
+    request: {
+        headers?: Record<string, string>;
+        method: 'POST' | 'PUT';
+        url: string;
+    };
+    type: 'http';
+});
+export type GenerateUploadInstructions = (args: {
+    overrideAccess?: boolean;
+    req: PayloadRequest;
+} & UploadInstructionsRequest) => Promise<UploadInstructions> | UploadInstructions;
+export type UploadInstructionsCapability = {
+    /** Generates upload instructions. The generator or supporting endpoint must check access. */
+    generate: GenerateUploadInstructions;
+    /**
+     * Whether the Admin panel should use these instructions before saving a document.
+     * This can still be useful when upload chunks pass through Payload.
+     */
+    useInAdmin: boolean;
+};
 export type checkFileRestrictionsParams = {
+    /** Set to false when the file bytes have not been uploaded yet. */
+    checkFileContents?: boolean;
     collection: CollectionConfig;
     file: File;
     req: PayloadRequest;
@@ -319,6 +414,16 @@ export type FileToSave = {
      * The path to save the file.
      */
     path: string;
+} | {
+    /**
+     * The path to save the file.
+     */
+    path: string;
+    /**
+     * An existing file on disk to copy to `path`, instead of `buffer` - avoids loading a file
+     * that's already on disk (e.g. a temp file) fully into memory just to write it back out.
+     */
+    sourcePath: string;
 };
 type Crop = {
     height: number;

package/dist/uploads/types.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/uploads/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,OAAO,CAAA;AAE/D,OAAO,KAAK,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAA;AAClF,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AAC1D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AACvD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAA;AAEjE,MAAM,MAAM,QAAQ,GAAG;IACrB,QAAQ,EAAE,IAAI,GAAG,MAAM,CAAA;IACvB,QAAQ,EAAE,IAAI,GAAG,MAAM,CAAA;IACvB,MAAM,EAAE,IAAI,GAAG,MAAM,CAAA;IACrB,QAAQ,EAAE,IAAI,GAAG,MAAM,CAAA;IACvB,GAAG,EAAE,IAAI,GAAG,MAAM,CAAA;IAClB,KAAK,EAAE,IAAI,GAAG,MAAM,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,SAAS,GAAG;IACtB,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,SAAS,CAAA;IAChB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,MAAM,EAAE,UAAU,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IACxC,OAAO,CAAC,EAAE,UAAU,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;CAC3C,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;AAEjE,MAAM,MAAM,iBAAiB,GAAG,CAAC,IAAI,EAAE;IACrC,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,MAAM,CAAA;IACd,YAAY,EAAE,MAAM,CAAA;IACpB,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,MAAM,CAAA;CACd,KAAK,MAAM,CAAA;AAEZ,~~MAAM~~,~~MAAM~~,~~SAAS,~~GAAG;~~IACtB~~;;OAEG;IACH,KAAK,CAAC,EAAE;QACN;;;;;;;WAOG;QACH,QAAQ,CAAC,EAAE;YACT,MAAM,CAAC,EAAE,OAAO,CAAA;YAChB,MAAM,CAAC,EAAE,OAAO,CAAA;YAChB,OAAO,CAAC,EAAE,OAAO,CAAA;SAClB,CAAA;KACF,CAAA;IACD;;OAEG;IACH,~~IAAI~~,CAAC,EAAE,~~MAAM~~,CAAA;~~IACb~~,~~aAAa~~,~~CAAC,~~EAAE,~~wBAAwB~~,CAAA;~~IACxC~~;;OAEG;IACH,~~iBAAiB~~,CAAC,EAAE,~~iBAAiB~~,CAAA;~~IACrC~~,~~IAAI~~,EAAE,~~MAAM~~,CAAA;~~IACZ~~,WAAW,CAAC,EAAE,sBAAsB,CAAA;IACpC;;;;;;;;OAQG;IACH,kBAAkB,CAAC,EAAE,aAAa,CAAC,oBAAoB,CAAC,CAAA;CACzD,GAAG,IAAI,CAAC,aAAa,EAAE,oBAAoB,CAAC,CAAA;AAE7C,MAAM,MAAM,iBAAiB,GAAG,CAAC,IAAI,EAAE;IAAE,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAAE,KAAK,KAAK,GAAG,IAAI,GAAG,MAAM,CAAA;AAEjG,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,aAAa,GAAG,KAAK,CAAC;IAChC,UAAU,EAAE,MAAM,EAAE,CAAA;IACpB,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAC,CAAA;AAEF,KAAK,KAAK,GAAG;IACX,UAAU,CAAC,EAAE;QACX;;WAEG;QACH,QAAQ,CAAC,EAAE,gBAAgB,EAAE,CAAA;~~KAC9B~~,CAAA;CACF,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACzB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAA;IACb;;;;QAII;IACJ,cAAc,CAAC,EAAE,iBAAiB,GAAG,MAAM,CAAA;IAC3C;;;;;;OAMG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAA;IAClC;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,YAAY,CAAA;IACjC;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,CAAA;IACd;;;OAGG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB;;;;;;;;;;OAUG;IACH,wBAAwB,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACtF;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,EAAE,CAAA;IAChC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAA;IAC/B;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,wBAAwB,CAAA;IACxC;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,CAAC,CACV,GAAG,EAAE,cAAc,EACnB,IAAI,EAAE;QACJ,GAAG,EAAE,UAAU,CAAA;QACf,OAAO,CAAC,EAAE,OAAO,CAAA;QACjB,MAAM,EAAE;YACN,~~mBAAmB~~,~~CAAC,~~EAAE,~~OAAO~~,CAAA;~~YAC7B~~,~~UAAU~~,EAAE,MAAM,CAAA;~~YAClB~~,~~QAAQ~~,EAAE,MAAM,CAAA;~~YAChB~~,~~MAAM~~,CAAC,EAAE,~~MAAM~~,CAAA;~~SAChB~~,CAAA;KACF,KACE,OAAO,CAAC,QAAQ,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,QAAQ,GAAG,IAAI,CAAC,EAAE,CAAA;IAC3D;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAA;IAC/B;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,UAAU,CAAC,EAAE,SAAS,EAAE,CAAA;IACxB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;IACpB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,EAAE;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,KAAK,OAAO,GAAG,IAAI,CAAA;IAC7E;;;;;;OAMG;IACH,QAAQ,CAAC,EACL;QACE,SAAS,EAAE,SAAS,CAAA;KACrB,GACD,KAAK,CAAA;IACT;;;;OAIG;IACH,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B;;;OAGG;IACH,aAAa,CAAC,EAAE,SAAS,GAAG,OAAO,CAAA;IACnC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,WAAW,CAAC,EAAE,sBAAsB,CAAA;IACpC;;;;;;;;;OASG;IACH,YAAY,CAAC,EAAE,YAAY,CAAA;CAC5B,CAAA;AACD,MAAM,MAAM,2BAA2B,GAAG;IACxC,UAAU,EAAE,gBAAgB,CAAA;IAC5B,IAAI,EAAE,IAAI,CAAA;IACV,GAAG,EAAE,cAAc,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC,SAAS,EAAE,YAAY,CAAC,WAAW,CAAC,CAAA;CACrC,GAAG,YAAY,CAAA;AAEhB,MAAM,MAAM,IAAI,GAAG;IACjB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,UAAU,~~GAAG~~;~~IACvB~~;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;~~AAED~~,KAAK,IAAI,GAAG;IACV,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,GAAG,GAAG,IAAI,CAAA;IAChB,KAAK,EAAE,MAAM,CAAA;IACb,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;CACV,CAAA;AAED,MAAM,MAAM,UAAU,GAAG;IACvB,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;CACV,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,CAAC,EAAE,IAAI,CAAA;IACX,UAAU,CAAC,EAAE,UAAU,CAAA;IACvB,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB,CAAA"}
1	+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/uploads/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,OAAO,CAAA;AAE/D,OAAO,KAAK,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAA;AAClF,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AAC1D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAA;AACvD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AACvD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAA;AAEjE,MAAM,MAAM,QAAQ,GAAG;IACrB,QAAQ,EAAE,IAAI,GAAG,MAAM,CAAA;IACvB,QAAQ,EAAE,IAAI,GAAG,MAAM,CAAA;IACvB,MAAM,EAAE,IAAI,GAAG,MAAM,CAAA;IACrB,QAAQ,EAAE,IAAI,GAAG,MAAM,CAAA;IACvB,GAAG,EAAE,IAAI,GAAG,MAAM,CAAA;IAClB,KAAK,EAAE,IAAI,GAAG,MAAM,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,SAAS,GAAG;IACtB,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,SAAS,CAAA;IAChB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,MAAM,EAAE,UAAU,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IACxC,OAAO,CAAC,EAAE,UAAU,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;CAC3C,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;AAEjE,MAAM,MAAM,iBAAiB,GAAG,CAAC,IAAI,EAAE;IACrC,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,MAAM,CAAA;IACd,YAAY,EAAE,MAAM,CAAA;IACpB,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,MAAM,CAAA;CACd,KAAK,MAAM,CAAA;AAEZ,KAAK,aAAa,GAAG;IACnB;;OAEG;IACH,KAAK,CAAC,EAAE;QACN;;;;;;;WAOG;QACH,QAAQ,CAAC,EAAE;YACT,MAAM,CAAC,EAAE,OAAO,CAAA;YAChB,MAAM,CAAC,EAAE,OAAO,CAAA;YAChB,OAAO,CAAC,EAAE,OAAO,CAAA;SAClB,CAAA;KACF,CAAA;IACD;;OAEG;IACH,iBAAiB,CAAC,EAAE,iBAAiB,CAAA;IACrC,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,aAAa,CAAC,EAAE,wBAAwB,CAAA;IACxC,WAAW,CAAC,EAAE,sBAAsB,CAAA;IACpC;;;;;;;;OAQG;IACH,kBAAkB,CAAC,EAAE,aAAa,CAAC,oBAAoB,CAAC,CAAA;CACzD,GAAG,IAAI,CAAC,aAAa,EAAE,oBAAoB,CAAC,CAAA;AAE7C;;;;;;;;;;;;GAYG;AAEH,MAAM,WAAW,0BAA0B;CAAG;AAE9C,KAAK,gBAAgB,GAAG,MAAM,0BAA0B,SAAS,KAAK,GAClE,qBAAqB,GACrB,0BAA0B,CAAC,MAAM,0BAA0B,CAAC,CAAA;AAEhE,MAAM,MAAM,SAAS,GAAG,aAAa,GAAG,gBAAgB,CAAA;AAExD,MAAM,MAAM,iBAAiB,GAAG,CAAC,IAAI,EAAE;IAAE,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAAE,KAAK,KAAK,GAAG,IAAI,GAAG,MAAM,CAAA;AAEjG,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,aAAa,GAAG,KAAK,CAAC;IAChC,UAAU,EAAE,MAAM,EAAE,CAAA;IACpB,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAC,CAAA;AAEF,MAAM,MAAM,4BAA4B,GAAG;IACzC,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,2CAA2C;IAC3C,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,CAAA;AAED,KAAK,oBAAoB,GAAG;IAC1B,CAAC,eAAe,EAAE,MAAM,GAAG,gBAAgB,CAAA;CAC5C,CAAA;AAED,KAAK,KAAK,GAAG;IACX,UAAU,CAAC,EAAE;QACX;;WAEG;QACH,QAAQ,CAAC,EAAE,gBAAgB,EAAE,CAAA;QAC7B;;;;;;;WAOG;QACH,WAAW,CAAC,EAAE,gBAAgB,GAAG,oBAAoB,CAAA;KACtD,CAAA;CACF,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACzB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAA;IACb;;;;QAII;IACJ,cAAc,CAAC,EAAE,iBAAiB,GAAG,MAAM,CAAA;IAC3C;;;;;;OAMG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAA;IAClC;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,YAAY,CAAA;IACjC;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,CAAA;IACd;;;OAGG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB;;;;;;;;;;OAUG;IACH,wBAAwB,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACtF;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,EAAE,CAAA;IAChC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAA;IAC/B;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,wBAAwB,CAAA;IACxC;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,CAAC,CACV,GAAG,EAAE,cAAc,EACnB,IAAI,EAAE;QACJ,GAAG,EAAE,UAAU,CAAA;QACf,OAAO,CAAC,EAAE,OAAO,CAAA;QACjB,MAAM,EAAE;YACN,UAAU,EAAE,MAAM,CAAA;YAClB,QAAQ,EAAE,MAAM,CAAA;YAChB,MAAM,CAAC,EAAE,MAAM,CAAA;YACf,eAAe,CAAC,EAAE,OAAO,CAAA;SAC1B,CAAA;KACF,KACE,OAAO,CAAC,QAAQ,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,QAAQ,GAAG,IAAI,CAAC,EAAE,CAAA;IAC3D;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAA;IAC/B;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,UAAU,CAAC,EAAE,SAAS,EAAE,CAAA;IACxB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;IACpB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,EAAE;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,KAAK,OAAO,GAAG,IAAI,CAAA;IAC7E;;;;;;OAMG;IACH,QAAQ,CAAC,EACL;QACE,SAAS,EAAE,SAAS,CAAA;KACrB,GACD,KAAK,CAAA;IACT;;;;OAIG;IACH,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B;;;OAGG;IACH,aAAa,CAAC,EAAE,SAAS,GAAG,OAAO,CAAA;IACnC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,WAAW,CAAC,EAAE,sBAAsB,CAAA;IACpC;;;OAGG;IACH,kBAAkB,CAAC,EAAE,4BAA4B,CAAA;IACjD;;;;;;;;;OASG;IACH,YAAY,CAAC,EAAE,YAAY,CAAA;CAC5B,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG,CAAC,IAAI,EAAE;IAC5C,cAAc,EAAE,oBAAoB,CAAA;IACpC,GAAG,EAAE,cAAc,CAAA;CACpB,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;AAEhC,MAAM,MAAM,yBAAyB,GAAG;IACtC,cAAc,EAAE,oBAAoB,CAAA;IACpC,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE;QACJ,cAAc,CAAC,EAAE,oBAAoB,CAAA;QACrC,QAAQ,EAAE,MAAM,CAAA;QAChB,QAAQ,EAAE,MAAM,CAAA;QAChB,IAAI,EAAE,MAAM,CAAA;QACZ,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KACzC,CAAA;CACF,GAAG,CACA;IACE,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,UAAU,CAAA;CACjB,GACD;IACE,OAAO,EAAE;QACP,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QAChC,MAAM,EAAE,MAAM,GAAG,KAAK,CAAA;QACtB,GAAG,EAAE,MAAM,CAAA;KACZ,CAAA;IACD,IAAI,EAAE,MAAM,CAAA;CACb,CACJ,CAAA;AAED,MAAM,MAAM,0BAA0B,GAAG,CACvC,IAAI,EAAE;IAAE,cAAc,CAAC,EAAE,OAAO,CAAC;IAAC,GAAG,EAAE,cAAc,CAAA;CAAE,GAAG,yBAAyB,KAChF,OAAO,CAAC,kBAAkB,CAAC,GAAG,kBAAkB,CAAA;AAErD,MAAM,MAAM,4BAA4B,GAAG;IACzC,6FAA6F;IAC7F,QAAQ,EAAE,0BAA0B,CAAA;IACpC;;;OAGG;IACH,UAAU,EAAE,OAAO,CAAA;CACpB,CAAA;AACD,MAAM,MAAM,2BAA2B,GAAG;IACxC,mEAAmE;IACnE,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B,UAAU,EAAE,gBAAgB,CAAA;IAC5B,IAAI,EAAE,IAAI,CAAA;IACV,GAAG,EAAE,cAAc,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC,SAAS,EAAE,YAAY,CAAC,WAAW,CAAC,CAAA;CACrC,GAAG,YAAY,CAAA;AAEhB,MAAM,MAAM,IAAI,GAAG;IACjB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,UAAU,GAClB;IACE;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;CACb,GACD;IACE;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAA;CACnB,CAAA;AAEL,KAAK,IAAI,GAAG;IACV,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,GAAG,GAAG,IAAI,CAAA;IAChB,KAAK,EAAE,MAAM,CAAA;IACb,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;CACV,CAAA;AAED,MAAM,MAAM,UAAU,GAAG;IACvB,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;CACV,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,CAAC,EAAE,IAAI,CAAA;IACX,UAAU,CAAC,EAAE,UAAU,CAAA;IACvB,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB,CAAA"}

package/dist/uploads/types.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"sources":["../../src/uploads/types.ts"],"sourcesContent":["import type { ResizeOptions, Sharp, SharpOptions } from 'sharp'\n\nimport type { CollectionConfig, TypeWithID } from '../collections/config/types.js'\nimport type { PayloadComponent } from '../config/types.js'\nimport type { PayloadRequest } from '../types/index.js'\nimport type { WithMetadata } from './optionallyAppendMetadata.js'\n\nexport type FileSize = {\n filename: null \| string\n filesize: null \| number\n height: null \| number\n mimeType: null \| string\n url: null \| string\n width: null \| number\n}\n\nexport type FileSizes = {\n [size: string]: FileSize\n}\n\nexport type FileData = {\n filename: string\n filesize: number\n focalX?: number\n focalY?: number\n height: number\n mimeType: string\n sizes: FileSizes\n tempFilePath?: string\n url?: string\n width: number\n}\n\nexport type ProbedImageSize = {\n height: number\n width: number\n}\n\n/*\n Params sent to the sharp `toFormat()` function\n * @link https://sharp.pixelplumbing.com/api-output#toformat\n /\nexport type ImageUploadFormatOptions = {\n format: Parameters<Sharp['toFormat']>[0]\n options?: Parameters<Sharp['toFormat']>[1]\n}\n\n/\n Params sent to the sharp trim() function\n * @link https://sharp.pixelplumbing.com/api-resize#trim\n /\nexport type ImageUploadTrimOptions = Parameters<Sharp['trim']>[0]\n\nexport type GenerateImageName = (args: {\n extension: string\n height: number\n originalName: string\n sizeName: string\n width: number\n}) => string\n\nexport type ImageSize = {\n /\n Admin UI options that control how this image size appears in list views.\n /\n admin?: {\n /\n Controls visibility of this image size in the collection list view.\n * Defaults to hiding the image size from columns, filters, and group-by to reduce noise.\n \n - `column` — whether to hide this size from selectable list columns. @default false\n * - `filter` — whether to hide this size from filter options. @default false\n * - `groupBy` — whether to hide this size from group-by options. @default false\n /\n disabled?: {\n column?: boolean\n filter?: boolean\n groupBy?: boolean\n }\n }\n /\n @deprecated prefer position\n /\n crop?: string // comes from sharp package\n formatOptions?: ImageUploadFormatOptions\n /\n Generate a custom name for the file of this image size.\n /\n generateImageName?: GenerateImageName\n name: string\n trimOptions?: ImageUploadTrimOptions\n /\n When an uploaded image is smaller than the defined image size, we have 3 options:\n \n `undefined \| false \| true`\n \n 1. `undefined` [default]: uploading images with smaller width AND height than the image size will return null\n * 2. `false`: always enlarge images to the image size\n * 3. `true`: if the image is smaller than the image size, return the original image\n /\n withoutEnlargement?: ResizeOptions['withoutEnlargement']\n} & Omit<ResizeOptions, 'withoutEnlargement'>\n\nexport type GetAdminThumbnail = (args: { doc: Record<string, unknown> }) => false \| null \| string\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 FileAllowList = Array<{\n extensions: string[]\n mimeType: string\n}>\n\ntype Admin = {\n components?: {\n /\n The Controls component to extend the upload controls in the admin panel.\n /\n controls?: PayloadComponent[]\n }\n}\n\nexport type UploadConfig = {\n /\n The adapter name to use for uploads. Used for storage adapter telemetry.\n * @default undefined\n /\n adapter?: string\n /\n The admin configuration for the upload field.\n /\n admin?: Admin\n /\n Represents an admin thumbnail, which can be either a React component or a string.\n * - If a string, it should be one of the image size names.\n * - A function that generates a fully qualified URL for the thumbnail, receives the doc as the only argument.\n /\n adminThumbnail?: GetAdminThumbnail \| string\n /\n * Allow restricted file types known to be problematic.\n * - If set to `true`, it will allow all file types.\n * - If set to `false`, it will not allow file types and extensions known to be problematic.\n * - This setting is overriden by the `mimeTypes` option.\n * @default false\n /\n allowRestrictedFileTypes?: boolean\n /\n Enables bulk upload of files from the list view.\n * @default true\n /\n bulkUpload?: boolean\n /\n Appends a cache tag to the image URL when fetching the thumbnail in the admin panel. It may be desirable to disable this when hosting via CDNs with strict parameters.\n \n @default true\n /\n cacheTags?: boolean\n /\n Sharp constructor options to be passed to the uploaded file.\n * @link https://sharp.pixelplumbing.com/api-constructor/#sharp\n /\n constructorOptions?: SharpOptions\n /\n Enables cropping of images.\n * @default true\n /\n crop?: boolean\n /\n Disable the ability to save files to disk.\n * @default false\n /\n disableLocalStorage?: boolean\n /\n Enable displaying preview of the uploaded file in Upload fields related to this Collection.\n * Can be locally overridden by `displayPreview` option in Upload field.\n * @default false\n /\n displayPreview?: boolean\n /\n \n * Accepts existing headers and returns the headers after filtering or modifying.\n * If using this option, you should handle the removal of any sensitive cookies\n * (like payload-prefixed cookies) to prevent leaking session information to external\n * services. By default, Payload automatically filters out payload-prefixed cookies\n * when this option is NOT defined.\n \n Useful for adding custom headers to fetch from external providers.\n * @default undefined\n /\n externalFileHeaderFilter?: (headers: Record<string, string>) => Record<string, string>\n /\n Field slugs to use for a compound index instead of the default filename index.\n /\n filenameCompoundIndex?: string[]\n /\n Require files to be uploaded when creating a document.\n * @default true\n /\n filesRequiredOnCreate?: boolean\n /\n Enables focal point positioning for image manipulation.\n * @default true\n /\n focalPoint?: boolean\n /\n Format options for the uploaded file. Formatting image sizes needs to be done within each formatOptions individually.\n /\n formatOptions?: ImageUploadFormatOptions\n /\n Custom handlers to run when a file is fetched.\n \n - If a handler returns a Response, the response will be sent to the client and no further handlers will be run.\n * - If a handler returns null, the next handler will be run.\n * - If no handlers return a response the file will be returned by default.\n \n @link https://sharp.pixelplumbing.com/api-output/#toformat\n * @default undefined\n /\n handlers?: ((\n req: PayloadRequest,\n args: {\n doc: TypeWithID\n headers?: Headers\n params: {\n clientUploadContext?: unknown\n collection: string\n filename: string\n prefix?: string\n }\n },\n ) => Promise<Response> \| Promise<void> \| Response \| void)[]\n /\n Set to `true` to prevent the admin UI from showing file inputs during document creation, useful for programmatic file generation.\n /\n hideFileInputOnCreate?: boolean\n /\n Set to `true` to prevent the admin UI having a way to remove an existing file while editing.\n /\n hideRemoveFile?: boolean\n imageSizes?: ImageSize[]\n /\n Restrict mimeTypes in the file picker. Array of valid mime types or mimetype wildcards\n * @example ['image/', 'application/pdf']\n @default undefined\n /\n mimeTypes?: string[]\n /\n Ability to modify the response headers fetching a file.\n * @default undefined\n /\n modifyResponseHeaders?: ({ headers }: { headers: Headers }) => Headers \| void\n /\n Controls the behavior of pasting/uploading files from URLs.\n * If set to `false`, fetching from remote URLs is disabled.\n * If an `allowList` is provided, server-side fetching will be enabled for specified URLs.\n \n @default true (client-side fetching enabled)\n /\n pasteURL?:\n \| {\n allowList: AllowList\n }\n \| false\n /\n Sharp resize options for the original image.\n * @link https://sharp.pixelplumbing.com/api-resize#resize\n * @default undefined\n /\n resizeOptions?: ResizeOptions\n /\n Skip safe fetch when using server-side fetching for external files from these URLs.\n * @default false\n /\n skipSafeFetch?: AllowList \| boolean\n /\n The directory to serve static files from. Defaults to collection slug.\n * @default undefined\n /\n staticDir?: string\n trimOptions?: ImageUploadTrimOptions\n /\n Optionally append metadata to the image during processing.\n \n Can be a boolean or a function.\n \n If true, metadata will be appended to the image.\n * If false, no metadata will be appended.\n * If a function, it will receive an object containing the metadata and should return a boolean indicating whether to append the metadata.\n * @default false\n /\n withMetadata?: WithMetadata\n}\nexport type checkFileRestrictionsParams = {\n collection: CollectionConfig\n file: File\n req: PayloadRequest\n}\n\nexport type SanitizedUploadConfig = {\n staticDir: UploadConfig['staticDir']\n} & UploadConfig\n\nexport type File = {\n /\n The buffer of the file.\n /\n data: Buffer\n /\n The mimetype of the file.\n /\n mimetype: string\n /\n The name of the file.\n /\n name: string\n /\n The size of the file in bytes.\n /\n size: number\n /\n Path to the temp file on disk when useTempFiles is enabled. In this case file.data will be an empty buffer.\n /\n tempFilePath?: string\n}\n\nexport type FileToSave = {\n /\n The buffer of the file.\n /\n buffer: Buffer\n /\n The path to save the file.\n */\n path: string\n}\n\ntype Crop = {\n height: number\n unit: '%' \| 'px'\n width: number\n x: number\n y: number\n}\n\nexport type FocalPoint = {\n x: number\n y: number\n}\n\nexport type UploadEdits = {\n crop?: Crop\n focalPoint?: FocalPoint\n heightInPixels?: number\n widthInPixels?: number\n}\n"],"names":[],"mappings":"AAkWA,WAKC"}
1	+ {"version":3,"sources":["../../src/uploads/types.ts"],"sourcesContent":["import type { ResizeOptions, Sharp, SharpOptions } from 'sharp'\n\nimport type { CollectionConfig, TypeWithID } from '../collections/config/types.js'\nimport type { PayloadComponent } from '../config/types.js'\nimport type { UploadCollectionSlug } from '../index.js'\nimport type { PayloadRequest } from '../types/index.js'\nimport type { WithMetadata } from './optionallyAppendMetadata.js'\n\nexport type FileSize = {\n filename: null \| string\n filesize: null \| number\n height: null \| number\n mimeType: null \| string\n url: null \| string\n width: null \| number\n}\n\nexport type FileSizes = {\n [size: string]: FileSize\n}\n\nexport type FileData = {\n filename: string\n filesize: number\n focalX?: number\n focalY?: number\n height: number\n mimeType: string\n sizes: FileSizes\n tempFilePath?: string\n url?: string\n width: number\n}\n\nexport type ProbedImageSize = {\n height: number\n width: number\n}\n\n/*\n Params sent to the sharp `toFormat()` function\n * @link https://sharp.pixelplumbing.com/api-output#toformat\n /\nexport type ImageUploadFormatOptions = {\n format: Parameters<Sharp['toFormat']>[0]\n options?: Parameters<Sharp['toFormat']>[1]\n}\n\n/\n Params sent to the sharp trim() function\n * @link https://sharp.pixelplumbing.com/api-resize#trim\n /\nexport type ImageUploadTrimOptions = Parameters<Sharp['trim']>[0]\n\nexport type GenerateImageName = (args: {\n extension: string\n height: number\n originalName: string\n sizeName: string\n width: number\n}) => string\n\ntype ImageSizeBase = {\n /\n Admin UI options that control how this image size appears in list views.\n /\n admin?: {\n /\n Controls visibility of this image size in the collection list view.\n * Defaults to hiding the image size from columns, filters, and group-by to reduce noise.\n \n - `column` — whether to hide this size from selectable list columns. @default false\n * - `filter` — whether to hide this size from filter options. @default false\n * - `groupBy` — whether to hide this size from group-by options. @default false\n /\n disabled?: {\n column?: boolean\n filter?: boolean\n groupBy?: boolean\n }\n }\n /\n Generate a custom name for the file of this image size.\n /\n generateImageName?: GenerateImageName\n name: string\n}\n\n/\n Image size options implemented by Payload's default Sharp image processor.\n /\nexport type SharpImageSizeOptions = {\n /\n @deprecated prefer position\n /\n crop?: string // comes from sharp package\n formatOptions?: ImageUploadFormatOptions\n trimOptions?: ImageUploadTrimOptions\n /\n When an uploaded image is smaller than the defined image size, we have 3 options:\n \n `undefined \| false \| true`\n \n 1. `undefined` [default]: uploading images with smaller width AND height than the image size will return null\n * 2. `false`: always enlarge images to the image size\n * 3. `true`: if the image is smaller than the image size, return the original image\n /\n withoutEnlargement?: ResizeOptions['withoutEnlargement']\n} & Omit<ResizeOptions, 'withoutEnlargement'>\n\n/\n Interface to be module-augmented by image processing providers.\n \n When no provider is registered, ImageSize uses SharpImageSizeOptions.\n * When providers are registered, ImageSize uses their registered options instead.\n \n @example\n * declare module 'payload' {\n * interface RegisteredImageSizeOptions {\n * myProvider: MyProviderImageSizeOptions\n * }\n * }\n /\n// eslint-disable-next-line @typescript-eslint/no-empty-object-type -- Intentionally empty so image processing providers can augment it.\nexport interface RegisteredImageSizeOptions {}\n\ntype ImageSizeOptions = keyof RegisteredImageSizeOptions extends never\n ? SharpImageSizeOptions\n : RegisteredImageSizeOptions[keyof RegisteredImageSizeOptions]\n\nexport type ImageSize = ImageSizeBase & ImageSizeOptions\n\nexport type GetAdminThumbnail = (args: { doc: Record<string, unknown> }) => false \| null \| string\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 FileAllowList = Array<{\n extensions: string[]\n mimeType: string\n}>\n\nexport type UploadFilePreviewClientProps = {\n filename: string\n filesize: number\n /* Resolved URL of the file (data.url). /\n fileSrc: string\n height?: number\n mimeType: string\n width?: number\n}\n\ntype UploadFilePreviewMap = {\n [mimeTypePattern: string]: PayloadComponent\n}\n\ntype Admin = {\n components?: {\n /\n The Controls component to extend the upload controls in the admin panel.\n /\n controls?: PayloadComponent[]\n /\n A custom component to render in place of the default Thumbnail in the upload side panel.\n \n Can be a single PayloadComponent (renders for all MIME types) or a Record keyed by\n * MIME type patterns. Pattern resolution priority: exact match → category wildcard\n * (e.g. `video/`) → universal fallback (``). Falls back to the default Thumbnail\n * when nothing matches.\n /\n filePreview?: PayloadComponent \| UploadFilePreviewMap\n }\n}\n\nexport type UploadConfig = {\n /\n The adapter name to use for uploads. Used for storage adapter telemetry.\n * @default undefined\n /\n adapter?: string\n /\n The admin configuration for the upload field.\n /\n admin?: Admin\n /\n Represents an admin thumbnail, which can be either a React component or a string.\n * - If a string, it should be one of the image size names.\n * - A function that generates a fully qualified URL for the thumbnail, receives the doc as the only argument.\n /\n adminThumbnail?: GetAdminThumbnail \| string\n /\n * Allow restricted file types known to be problematic.\n * - If set to `true`, it will allow all file types.\n * - If set to `false`, it will not allow file types and extensions known to be problematic.\n * - This setting is overriden by the `mimeTypes` option.\n * @default false\n /\n allowRestrictedFileTypes?: boolean\n /\n Enables bulk upload of files from the list view.\n * @default true\n /\n bulkUpload?: boolean\n /\n Appends a cache tag to the image URL when fetching the thumbnail in the admin panel. It may be desirable to disable this when hosting via CDNs with strict parameters.\n \n @default true\n /\n cacheTags?: boolean\n /\n Sharp constructor options to be passed to the uploaded file.\n * @link https://sharp.pixelplumbing.com/api-constructor/#sharp\n /\n constructorOptions?: SharpOptions\n /\n Enables cropping of images.\n * @default true\n /\n crop?: boolean\n /\n Disable the ability to save files to disk.\n * @default false\n /\n disableLocalStorage?: boolean\n /\n Enable displaying preview of the uploaded file in Upload fields related to this Collection.\n * Can be locally overridden by `displayPreview` option in Upload field.\n * @default false\n /\n displayPreview?: boolean\n /\n \n * Accepts existing headers and returns the headers after filtering or modifying.\n * If using this option, you should handle the removal of any sensitive cookies\n * (like payload-prefixed cookies) to prevent leaking session information to external\n * services. By default, Payload automatically filters out payload-prefixed cookies\n * when this option is NOT defined.\n \n Useful for adding custom headers to fetch from external providers.\n * @default undefined\n /\n externalFileHeaderFilter?: (headers: Record<string, string>) => Record<string, string>\n /\n Field slugs to use for a compound index instead of the default filename index.\n /\n filenameCompoundIndex?: string[]\n /\n Require files to be uploaded when creating a document.\n * @default true\n /\n filesRequiredOnCreate?: boolean\n /\n Enables focal point positioning for image manipulation.\n * @default true\n /\n focalPoint?: boolean\n /\n Format options for the uploaded file. Formatting image sizes needs to be done within each formatOptions individually.\n /\n formatOptions?: ImageUploadFormatOptions\n /\n Custom handlers to run when a file is fetched.\n \n - If a handler returns a Response, the response will be sent to the client and no further handlers will be run.\n * - If a handler returns null, the next handler will be run.\n * - If no handlers return a response the file will be returned by default.\n \n @link https://sharp.pixelplumbing.com/api-output/#toformat\n * @default undefined\n /\n handlers?: ((\n req: PayloadRequest,\n args: {\n doc: TypeWithID\n headers?: Headers\n params: {\n collection: string\n filename: string\n prefix?: string\n uploadReference?: unknown\n }\n },\n ) => Promise<Response> \| Promise<void> \| Response \| void)[]\n /\n Set to `true` to prevent the admin UI from showing file inputs during document creation, useful for programmatic file generation.\n /\n hideFileInputOnCreate?: boolean\n /\n Set to `true` to prevent the admin UI having a way to remove an existing file while editing.\n /\n hideRemoveFile?: boolean\n imageSizes?: ImageSize[]\n /\n Restrict mimeTypes in the file picker. Array of valid mime types or mimetype wildcards\n * @example ['image/', 'application/pdf']\n @default undefined\n /\n mimeTypes?: string[]\n /\n Ability to modify the response headers fetching a file.\n * @default undefined\n /\n modifyResponseHeaders?: ({ headers }: { headers: Headers }) => Headers \| void\n /\n Controls the behavior of pasting/uploading files from URLs.\n * If set to `false`, fetching from remote URLs is disabled.\n * If an `allowList` is provided, server-side fetching will be enabled for specified URLs.\n \n @default true (client-side fetching enabled)\n /\n pasteURL?:\n \| {\n allowList: AllowList\n }\n \| false\n /\n Sharp resize options for the original image.\n * @link https://sharp.pixelplumbing.com/api-resize#resize\n * @default undefined\n /\n resizeOptions?: ResizeOptions\n /\n Skip safe fetch when using server-side fetching for external files from these URLs.\n * @default false\n /\n skipSafeFetch?: AllowList \| boolean\n /\n The directory to serve static files from. Defaults to collection slug.\n * @default undefined\n /\n staticDir?: string\n trimOptions?: ImageUploadTrimOptions\n /\n Adapter-provided upload instructions.\n * @internal\n /\n uploadInstructions?: UploadInstructionsCapability\n /\n Optionally append metadata to the image during processing.\n \n Can be a boolean or a function.\n \n If true, metadata will be appended to the image.\n * If false, no metadata will be appended.\n * If a function, it will receive an object containing the metadata and should return a boolean indicating whether to append the metadata.\n * @default false\n /\n withMetadata?: WithMetadata\n}\n\nexport type UploadInstructionsAccess = (args: {\n collectionSlug: UploadCollectionSlug\n req: PayloadRequest\n}) => boolean \| Promise<boolean>\n\nexport type UploadInstructionsRequest = {\n collectionSlug: UploadCollectionSlug\n docPrefix?: string\n filename: string\n filesize: number\n mimeType: string\n}\n\nexport type UploadInstructions = {\n file: {\n collectionSlug?: UploadCollectionSlug\n filename: string\n mimeType: string\n size: number\n uploadReference: Record<string, unknown>\n }\n} & (\n \| {\n data?: unknown\n name: string\n type: 'dispatch'\n }\n \| {\n request: {\n headers?: Record<string, string>\n method: 'POST' \| 'PUT'\n url: string\n }\n type: 'http'\n }\n)\n\nexport type GenerateUploadInstructions = (\n args: { overrideAccess?: boolean; req: PayloadRequest } & UploadInstructionsRequest,\n) => Promise<UploadInstructions> \| UploadInstructions\n\nexport type UploadInstructionsCapability = {\n /* Generates upload instructions. The generator or supporting endpoint must check access. /\n generate: GenerateUploadInstructions\n /\n Whether the Admin panel should use these instructions before saving a document.\n * This can still be useful when upload chunks pass through Payload.\n /\n useInAdmin: boolean\n}\nexport type checkFileRestrictionsParams = {\n /* Set to false when the file bytes have not been uploaded yet. /\n checkFileContents?: boolean\n collection: CollectionConfig\n file: File\n req: PayloadRequest\n}\n\nexport type SanitizedUploadConfig = {\n staticDir: UploadConfig['staticDir']\n} & UploadConfig\n\nexport type File = {\n /\n The buffer of the file.\n /\n data: Buffer\n /\n The mimetype of the file.\n /\n mimetype: string\n /\n The name of the file.\n /\n name: string\n /\n The size of the file in bytes.\n /\n size: number\n /\n Path to the temp file on disk when useTempFiles is enabled. In this case file.data will be an empty buffer.\n /\n tempFilePath?: string\n}\n\nexport type FileToSave =\n \| {\n /\n The buffer of the file.\n /\n buffer: Buffer\n /\n The path to save the file.\n /\n path: string\n }\n \| {\n /\n The path to save the file.\n /\n path: string\n /\n An existing file on disk to copy to `path`, instead of `buffer` - avoids loading a file\n * that's already on disk (e.g. a temp file) fully into memory just to write it back out.\n */\n sourcePath: string\n }\n\ntype Crop = {\n height: number\n unit: '%' \| 'px'\n width: number\n x: number\n y: number\n}\n\nexport type FocalPoint = {\n x: number\n y: number\n}\n\nexport type UploadEdits = {\n crop?: Crop\n focalPoint?: FocalPoint\n heightInPixels?: number\n widthInPixels?: number\n}\n"],"names":[],"mappings":"AA4dA,WAKC"}

package/dist/uploads/unlinkTempFiles.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"unlinkTempFiles.d.ts","sourceRoot":"","sources":["../../src/uploads/unlinkTempFiles.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAA;AAC/E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAA;AACzD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AAIvD,KAAK,IAAI,GAAG;IACV,gBAAgB,EAAE,yBAAyB,CAAA;IAC3C,MAAM,EAAE,eAAe,CAAA;IACvB,GAAG,EAAE,cAAc,CAAA;CACpB,CAAA;AACD;;GAEG;AACH,eAAO,MAAM,eAAe,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC,IAAI,~~CAezD~~,CAAA"}
1	+ {"version":3,"file":"unlinkTempFiles.d.ts","sourceRoot":"","sources":["../../src/uploads/unlinkTempFiles.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAA;AAC/E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAA;AACzD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AAIvD,KAAK,IAAI,GAAG;IACV,gBAAgB,EAAE,yBAAyB,CAAA;IAC3C,MAAM,EAAE,eAAe,CAAA;IACvB,GAAG,EAAE,cAAc,CAAA;CACpB,CAAA;AACD;;GAEG;AACH,eAAO,MAAM,eAAe,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC,IAAI,CAqBzD,CAAA"}

package/dist/uploads/unlinkTempFiles.js CHANGED Viewed

@@ -3,8 +3,12 @@ import { mapAsync } from '../utilities/mapAsync.js';
 /**
  * Cleanup temp files after operation lifecycle
  */ export const unlinkTempFiles = async ({ collectionConfig, config, req })=>{
-    if (config.upload?.useTempFiles && collectionConfig.upload) {
-        const { file } = req;
+    const { file } = req;
+    // A file fetched from a client-upload reference always gets its own temp file for
+    // post-processing (see getFileFromUploadInstructions.ts), regardless of the global
+    // useTempFiles setting, so it must always be cleaned up here too.
+    const isClientUploadTempFile = Boolean(file?.uploadReference);
+    if (collectionConfig.upload && (config.upload?.useTempFiles || isClientUploadTempFile)) {
         const fileArray = [
             {
                 file

package/dist/uploads/unlinkTempFiles.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"sources":["../../src/uploads/unlinkTempFiles.ts"],"sourcesContent":["import fs from 'fs/promises'\n\nimport type { SanitizedCollectionConfig } from '../collections/config/types.js'\nimport type { SanitizedConfig } from '../config/types.js'\nimport type { PayloadRequest } from '../types/index.js'\n\nimport { mapAsync } from '../utilities/mapAsync.js'\n\ntype Args = {\n collectionConfig: SanitizedCollectionConfig\n config: SanitizedConfig\n req: PayloadRequest\n}\n/*\n Cleanup temp files after operation lifecycle\n */\nexport const unlinkTempFiles: (args: Args) => Promise<void> = async ({\n collectionConfig,\n config,\n req,\n}) => {\n if ~~(config.~~upload~~?.useTempFiles~~ && ~~collectionConfig~~.~~upload~~) {\n const { file } = ~~req~~\n const fileArray = [{ file }]\n await mapAsync(fileArray, async ({ file }) => {\n // Still need this check because this will not be populated if using local API\n if (file?.tempFilePath) {\n await fs.unlink(file.tempFilePath)\n }\n })\n }\n}\n"],"names":["fs","mapAsync","unlinkTempFiles","collectionConfig","config","req","~~upload~~","~~useTempFiles~~","~~file~~","fileArray","tempFilePath","unlink"],"mappings":"AAAA,OAAOA,QAAQ,cAAa;AAM5B,SAASC,QAAQ,QAAQ,2BAA0B;AAOnD;;CAEC,GACD,OAAO,MAAMC,kBAAiD,OAAO,EACnEC,gBAAgB,EAChBC,MAAM,EACNC,GAAG,EACJ;IACC,~~IAAID,OAAOE,~~MAAM,EAAEC,~~gBAAgBJ~~,~~iBAAiBG~~,~~MAAM~~,~~EAAE~~;~~QAC1D~~,MAAM,~~EAAEE~~,~~IAAI~~,~~EAAE~~,~~GAAGH~~;~~QACjB~~,~~MAAMI~~,YAAY;YAAC;~~gBAAED~~;YAAK;SAAE;QAC5B,~~MAAMP~~,~~SAASQ~~,WAAW,OAAO,~~EAAED~~,IAAI,EAAE;YACvC,8EAA8E;YAC9E,IAAIA,~~MAAME~~,cAAc;gBACtB,~~MAAMV~~,~~GAAGW~~,MAAM,~~CAACH~~,~~KAAKE~~,YAAY;YACnC;QACF;IACF;AACF,EAAC"}
1	+ {"version":3,"sources":["../../src/uploads/unlinkTempFiles.ts"],"sourcesContent":["import fs from 'fs/promises'\n\nimport type { SanitizedCollectionConfig } from '../collections/config/types.js'\nimport type { SanitizedConfig } from '../config/types.js'\nimport type { PayloadRequest } from '../types/index.js'\n\nimport { mapAsync } from '../utilities/mapAsync.js'\n\ntype Args = {\n collectionConfig: SanitizedCollectionConfig\n config: SanitizedConfig\n req: PayloadRequest\n}\n/*\n Cleanup temp files after operation lifecycle\n */\nexport const unlinkTempFiles: (args: Args) => Promise<void> = async ({\n collectionConfig,\n config,\n req,\n}) => {\n const { file } = req\n\n // A file fetched from a client-upload reference always gets its own temp file for\n // post-processing (see getFileFromUploadInstructions.ts), regardless of the global\n // useTempFiles setting, so it must always be cleaned up here too.\n const isClientUploadTempFile = Boolean(file?.uploadReference)\n\n if (collectionConfig.upload && (config.upload?.useTempFiles \|\| isClientUploadTempFile)) {\n const fileArray = [{ file }]\n await mapAsync(fileArray, async ({ file }) => {\n // Still need this check because this will not be populated if using local API\n if (file?.tempFilePath) {\n await fs.unlink(file.tempFilePath)\n }\n })\n }\n}\n"],"names":["fs","mapAsync","unlinkTempFiles","collectionConfig","config","req","file","isClientUploadTempFile","Boolean","uploadReference","upload","useTempFiles","fileArray","tempFilePath","unlink"],"mappings":"AAAA,OAAOA,QAAQ,cAAa;AAM5B,SAASC,QAAQ,QAAQ,2BAA0B;AAOnD;;CAEC,GACD,OAAO,MAAMC,kBAAiD,OAAO,EACnEC,gBAAgB,EAChBC,MAAM,EACNC,GAAG,EACJ;IACC,MAAM,EAAEC,IAAI,EAAE,GAAGD;IAEjB,kFAAkF;IAClF,mFAAmF;IACnF,kEAAkE;IAClE,MAAME,yBAAyBC,QAAQF,MAAMG;IAE7C,IAAIN,iBAAiBO,MAAM,IAAKN,CAAAA,OAAOM,MAAM,EAAEC,gBAAgBJ,sBAAqB,GAAI;QACtF,MAAMK,YAAY;YAAC;gBAAEN;YAAK;SAAE;QAC5B,MAAML,SAASW,WAAW,OAAO,EAAEN,IAAI,EAAE;YACvC,8EAA8E;YAC9E,IAAIA,MAAMO,cAAc;gBACtB,MAAMb,GAAGc,MAAM,CAACR,KAAKO,YAAY;YACnC;QACF;IACF;AACF,EAAC"}

package/dist/uploads/unlinkTempFiles.spec.js ADDED Viewed

@@ -0,0 +1,71 @@
+import { beforeEach, describe, expect, it, vi } from 'vitest';
+const unlinkMock = vi.fn().mockResolvedValue(undefined);
+vi.mock('fs/promises', ()=>({
+        default: {
+            unlink: unlinkMock
+        }
+    }));
+const { unlinkTempFiles } = await import('./unlinkTempFiles.js');
+const collectionConfig = {
+    upload: {}
+};
+const createReq = (tempFilePath, uploadReference)=>({
+        file: {
+            data: Buffer.alloc(0),
+            mimetype: 'video/mp4',
+            name: 'video.mp4',
+            size: 10,
+            tempFilePath,
+            ...uploadReference ? {
+                uploadReference
+            } : {}
+        }
+    });
+describe('unlinkTempFiles', ()=>{
+    beforeEach(()=>{
+        vi.clearAllMocks();
+    });
+    it('deletes a temp file created from a client-upload reference even when global useTempFiles is off', async ()=>{
+        const req = createReq('/tmp/payload-client-upload-abc', {
+            key: 'media/video.mp4'
+        });
+        await unlinkTempFiles({
+            collectionConfig,
+            config: {
+                upload: {
+                    useTempFiles: false
+                }
+            },
+            req
+        });
+        expect(unlinkMock).toHaveBeenCalledWith('/tmp/payload-client-upload-abc');
+    });
+    it('does not delete an unrelated temp file when useTempFiles is off and there is no upload reference', async ()=>{
+        const req = createReq('/tmp/some-other-temp-file');
+        await unlinkTempFiles({
+            collectionConfig,
+            config: {
+                upload: {
+                    useTempFiles: false
+                }
+            },
+            req
+        });
+        expect(unlinkMock).not.toHaveBeenCalled();
+    });
+    it('still deletes temp files for regular multipart uploads when useTempFiles is on', async ()=>{
+        const req = createReq('/tmp/multipart-temp-file');
+        await unlinkTempFiles({
+            collectionConfig,
+            config: {
+                upload: {
+                    useTempFiles: true
+                }
+            },
+            req
+        });
+        expect(unlinkMock).toHaveBeenCalledWith('/tmp/multipart-temp-file');
+    });
+});
+//# sourceMappingURL=unlinkTempFiles.spec.js.map

package/dist/uploads/unlinkTempFiles.spec.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"sources":["../../src/uploads/unlinkTempFiles.spec.ts"],"sourcesContent":["import type { SanitizedCollectionConfig } from '../collections/config/types.js'\nimport type { SanitizedConfig } from '../config/types.js'\nimport type { PayloadRequest } from '../types/index.js'\n\nimport { beforeEach, describe, expect, it, vi } from 'vitest'\n\nconst unlinkMock = vi.fn().mockResolvedValue(undefined)\n\nvi.mock('fs/promises', () => ({\n default: { unlink: unlinkMock },\n}))\n\nconst { unlinkTempFiles } = await import('./unlinkTempFiles.js')\n\nconst collectionConfig = { upload: {} } as unknown as SanitizedCollectionConfig\n\nconst createReq = (tempFilePath: string, uploadReference?: unknown): PayloadRequest =>\n ({\n file: {\n data: Buffer.alloc(0),\n mimetype: 'video/mp4',\n name: 'video.mp4',\n size: 10,\n tempFilePath,\n ...(uploadReference ? { uploadReference } : {}),\n },\n }) as unknown as PayloadRequest\n\ndescribe('unlinkTempFiles', () => {\n beforeEach(() => {\n vi.clearAllMocks()\n })\n\n it('deletes a temp file created from a client-upload reference even when global useTempFiles is off', async () => {\n const req = createReq('/tmp/payload-client-upload-abc', { key: 'media/video.mp4' })\n\n await unlinkTempFiles({\n collectionConfig,\n config: { upload: { useTempFiles: false } } as unknown as SanitizedConfig,\n req,\n })\n\n expect(unlinkMock).toHaveBeenCalledWith('/tmp/payload-client-upload-abc')\n })\n\n it('does not delete an unrelated temp file when useTempFiles is off and there is no upload reference', async () => {\n const req = createReq('/tmp/some-other-temp-file')\n\n await unlinkTempFiles({\n collectionConfig,\n config: { upload: { useTempFiles: false } } as unknown as SanitizedConfig,\n req,\n })\n\n expect(unlinkMock).not.toHaveBeenCalled()\n })\n\n it('still deletes temp files for regular multipart uploads when useTempFiles is on', async () => {\n const req = createReq('/tmp/multipart-temp-file')\n\n await unlinkTempFiles({\n collectionConfig,\n config: { upload: { useTempFiles: true } } as unknown as SanitizedConfig,\n req,\n })\n\n expect(unlinkMock).toHaveBeenCalledWith('/tmp/multipart-temp-file')\n })\n})\n"],"names":["beforeEach","describe","expect","it","vi","unlinkMock","fn","mockResolvedValue","undefined","mock","default","unlink","unlinkTempFiles","collectionConfig","upload","createReq","tempFilePath","uploadReference","file","data","Buffer","alloc","mimetype","name","size","clearAllMocks","req","key","config","useTempFiles","toHaveBeenCalledWith","not","toHaveBeenCalled"],"mappings":"AAIA,SAASA,UAAU,EAAEC,QAAQ,EAAEC,MAAM,EAAEC,EAAE,EAAEC,EAAE,QAAQ,SAAQ;AAE7D,MAAMC,aAAaD,GAAGE,EAAE,GAAGC,iBAAiB,CAACC;AAE7CJ,GAAGK,IAAI,CAAC,eAAe,IAAO,CAAA;QAC5BC,SAAS;YAAEC,QAAQN;QAAW;IAChC,CAAA;AAEA,MAAM,EAAEO,eAAe,EAAE,GAAG,MAAM,MAAM,CAAC;AAEzC,MAAMC,mBAAmB;IAAEC,QAAQ,CAAC;AAAE;AAEtC,MAAMC,YAAY,CAACC,cAAsBC,kBACtC,CAAA;QACCC,MAAM;YACJC,MAAMC,OAAOC,KAAK,CAAC;YACnBC,UAAU;YACVC,MAAM;YACNC,MAAM;YACNR;YACA,GAAIC,kBAAkB;gBAAEA;YAAgB,IAAI,CAAC,CAAC;QAChD;IACF,CAAA;AAEFhB,SAAS,mBAAmB;IAC1BD,WAAW;QACTI,GAAGqB,aAAa;IAClB;IAEAtB,GAAG,mGAAmG;QACpG,MAAMuB,MAAMX,UAAU,kCAAkC;YAAEY,KAAK;QAAkB;QAEjF,MAAMf,gBAAgB;YACpBC;YACAe,QAAQ;gBAAEd,QAAQ;oBAAEe,cAAc;gBAAM;YAAE;YAC1CH;QACF;QAEAxB,OAAOG,YAAYyB,oBAAoB,CAAC;IAC1C;IAEA3B,GAAG,oGAAoG;QACrG,MAAMuB,MAAMX,UAAU;QAEtB,MAAMH,gBAAgB;YACpBC;YACAe,QAAQ;gBAAEd,QAAQ;oBAAEe,cAAc;gBAAM;YAAE;YAC1CH;QACF;QAEAxB,OAAOG,YAAY0B,GAAG,CAACC,gBAAgB;IACzC;IAEA7B,GAAG,kFAAkF;QACnF,MAAMuB,MAAMX,UAAU;QAEtB,MAAMH,gBAAgB;YACpBC;YACAe,QAAQ;gBAAEd,QAAQ;oBAAEe,cAAc;gBAAK;YAAE;YACzCH;QACF;QAEAxB,OAAOG,YAAYyB,oBAAoB,CAAC;IAC1C;AACF"}

package/dist/uploads/uploadFiles.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"uploadFiles.d.ts","sourceRoot":"","sources":["../../src/uploads/uploadFiles.ts"],"names":[],"mappings":"~~AAAA~~,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAC1C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AACvD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAK5C,eAAO,MAAM,WAAW,~~GACtB~~,~~SAAS,~~OAAO,~~EAChB~~,~~OAAO,~~UAAU,EAAE,~~EACnB~~,~~KAAK,~~cAAc,KAClB,OAAO,CAAC,IAAI,~~CAWd~~,CAAA"}
1	+ {"version":3,"file":"uploadFiles.d.ts","sourceRoot":"","sources":["../../src/uploads/uploadFiles.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAC1C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AACvD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAK5C,eAAO,MAAM,WAAW,YACb,OAAO,SACT,UAAU,EAAE,OACd,cAAc,KAClB,OAAO,CAAC,IAAI,CAed,CAAA"}

package/dist/uploads/uploadFiles.js CHANGED Viewed

@@ -1,9 +1,14 @@
+import fs from 'fs/promises';
 import { FileUploadError } from '../errors/index.js';
 import { saveBufferToFile } from './saveBufferToFile.js';
 export const uploadFiles = async (payload, files, req)=>{
     try {
-        await Promise.all(files.map(async ({ buffer, path })=>{
-            await saveBufferToFile(buffer, path);
+        await Promise.all(files.map(async (file)=>{
+            if ('sourcePath' in file) {
+                await fs.copyFile(file.sourcePath, file.path);
+            } else {
+                await saveBufferToFile(file.buffer, file.path);
+            }
         }));
     } catch (err) {
         payload.logger.error(err);

package/dist/uploads/uploadFiles.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"sources":["../../src/uploads/uploadFiles.ts"],"sourcesContent":["import type { Payload } from '../index.js'\nimport type { PayloadRequest } from '../types/index.js'\nimport type { FileToSave } from './types.js'\n\nimport { FileUploadError } from '../errors/index.js'\nimport { saveBufferToFile } from './saveBufferToFile.js'\n\nexport const uploadFiles = async (\n payload: Payload,\n files: FileToSave[],\n req: PayloadRequest,\n): Promise<void> => {\n try {\n await Promise.all(\n files.map(async ({ ~~buffer~~, path }) => {\n await saveBufferToFile(buffer, path)\n }),\n )\n } catch (err) {\n payload.logger.error(err)\n throw new FileUploadError(req.t)\n }\n}\n"],"names":["FileUploadError","saveBufferToFile","uploadFiles","payload","files","req","Promise","all","map","~~buffer~~","path","err","logger","error","t"],"mappings":"~~AAIA~~,~~SAASA~~,eAAe,QAAQ,qBAAoB;AACpD,SAASC,gBAAgB,QAAQ,wBAAuB;AAExD,OAAO,MAAMC,cAAc,OACzBC,SACAC,OACAC;IAEA,IAAI;QACF,MAAMC,QAAQC,GAAG,CACfH,MAAMI,GAAG,CAAC,~~OAAO~~,~~EAAEC~~,MAAM,~~EAAEC~~,IAAI,~~EAAE~~;~~YAC/B~~,~~MAAMT~~,iBAAiBQ,~~QAAQC~~;~~QACjC~~;IAEJ,EAAE,~~OAAOC~~,KAAK;~~QACZR~~,~~QAAQS~~,MAAM,CAACC,KAAK,CAACF;QACrB,MAAM,~~IAAIX~~,gBAAgBK,~~IAAIS~~,CAAC;IACjC;AACF,EAAC"}
1	+ {"version":3,"sources":["../../src/uploads/uploadFiles.ts"],"sourcesContent":["import fs from 'fs/promises'\n\nimport type { Payload } from '../index.js'\nimport type { PayloadRequest } from '../types/index.js'\nimport type { FileToSave } from './types.js'\n\nimport { FileUploadError } from '../errors/index.js'\nimport { saveBufferToFile } from './saveBufferToFile.js'\n\nexport const uploadFiles = async (\n payload: Payload,\n files: FileToSave[],\n req: PayloadRequest,\n): Promise<void> => {\n try {\n await Promise.all(\n files.map(async (file) => {\n if ('sourcePath' in file) {\n await fs.copyFile(file.sourcePath, file.path)\n } else {\n await saveBufferToFile(file.buffer, file.path)\n }\n }),\n )\n } catch (err) {\n payload.logger.error(err)\n throw new FileUploadError(req.t)\n }\n}\n"],"names":["fs","FileUploadError","saveBufferToFile","uploadFiles","payload","files","req","Promise","all","map","file","copyFile","sourcePath","path","buffer","err","logger","error","t"],"mappings":"AAAA,OAAOA,QAAQ,cAAa;AAM5B,SAASC,eAAe,QAAQ,qBAAoB;AACpD,SAASC,gBAAgB,QAAQ,wBAAuB;AAExD,OAAO,MAAMC,cAAc,OACzBC,SACAC,OACAC;IAEA,IAAI;QACF,MAAMC,QAAQC,GAAG,CACfH,MAAMI,GAAG,CAAC,OAAOC;YACf,IAAI,gBAAgBA,MAAM;gBACxB,MAAMV,GAAGW,QAAQ,CAACD,KAAKE,UAAU,EAAEF,KAAKG,IAAI;YAC9C,OAAO;gBACL,MAAMX,iBAAiBQ,KAAKI,MAAM,EAAEJ,KAAKG,IAAI;YAC/C;QACF;IAEJ,EAAE,OAAOE,KAAK;QACZX,QAAQY,MAAM,CAACC,KAAK,CAACF;QACrB,MAAM,IAAId,gBAAgBK,IAAIY,CAAC;IACjC;AACF,EAAC"}

package/dist/uploads/uploadFiles.spec.js ADDED Viewed

@@ -0,0 +1,44 @@
+import { beforeEach, describe, expect, it, vi } from 'vitest';
+const copyFileMock = vi.fn().mockResolvedValue(undefined);
+const writeFileMock = vi.fn().mockResolvedValue(undefined);
+vi.mock('fs/promises', ()=>({
+        default: {
+            copyFile: copyFileMock,
+            writeFile: writeFileMock
+        }
+    }));
+const { uploadFiles } = await import('./uploadFiles.js');
+describe('uploadFiles', ()=>{
+    const payload = {
+        logger: {
+            error: vi.fn()
+        }
+    };
+    const req = {};
+    beforeEach(()=>{
+        vi.clearAllMocks();
+    });
+    it('writes a buffer entry to disk', async ()=>{
+        const buffer = Buffer.from('hello');
+        await uploadFiles(payload, [
+            {
+                buffer,
+                path: '/tmp/media/hello.txt'
+            }
+        ], req);
+        expect(writeFileMock).toHaveBeenCalledWith('/tmp/media/hello.txt', buffer);
+        expect(copyFileMock).not.toHaveBeenCalled();
+    });
+    it('copies a sourcePath entry directly, without reading it into memory', async ()=>{
+        await uploadFiles(payload, [
+            {
+                path: '/tmp/media/video.mp4',
+                sourcePath: '/tmp/payload-client-upload-abc'
+            }
+        ], req);
+        expect(copyFileMock).toHaveBeenCalledWith('/tmp/payload-client-upload-abc', '/tmp/media/video.mp4');
+        expect(writeFileMock).not.toHaveBeenCalled();
+    });
+});
+//# sourceMappingURL=uploadFiles.spec.js.map

package/dist/uploads/uploadFiles.spec.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"sources":["../../src/uploads/uploadFiles.spec.ts"],"sourcesContent":["import type { Payload } from '../index.js'\nimport type { PayloadRequest } from '../types/index.js'\n\nimport { beforeEach, describe, expect, it, vi } from 'vitest'\n\nconst copyFileMock = vi.fn().mockResolvedValue(undefined)\nconst writeFileMock = vi.fn().mockResolvedValue(undefined)\n\nvi.mock('fs/promises', () => ({\n default: {\n copyFile: copyFileMock,\n writeFile: writeFileMock,\n },\n}))\n\nconst { uploadFiles } = await import('./uploadFiles.js')\n\ndescribe('uploadFiles', () => {\n const payload = { logger: { error: vi.fn() } } as unknown as Payload\n const req = {} as unknown as PayloadRequest\n\n beforeEach(() => {\n vi.clearAllMocks()\n })\n\n it('writes a buffer entry to disk', async () => {\n const buffer = Buffer.from('hello')\n\n await uploadFiles(payload, [{ buffer, path: '/tmp/media/hello.txt' }], req)\n\n expect(writeFileMock).toHaveBeenCalledWith('/tmp/media/hello.txt', buffer)\n expect(copyFileMock).not.toHaveBeenCalled()\n })\n\n it('copies a sourcePath entry directly, without reading it into memory', async () => {\n await uploadFiles(\n payload,\n [{ path: '/tmp/media/video.mp4', sourcePath: '/tmp/payload-client-upload-abc' }],\n req,\n )\n\n expect(copyFileMock).toHaveBeenCalledWith(\n '/tmp/payload-client-upload-abc',\n '/tmp/media/video.mp4',\n )\n expect(writeFileMock).not.toHaveBeenCalled()\n })\n})\n"],"names":["beforeEach","describe","expect","it","vi","copyFileMock","fn","mockResolvedValue","undefined","writeFileMock","mock","default","copyFile","writeFile","uploadFiles","payload","logger","error","req","clearAllMocks","buffer","Buffer","from","path","toHaveBeenCalledWith","not","toHaveBeenCalled","sourcePath"],"mappings":"AAGA,SAASA,UAAU,EAAEC,QAAQ,EAAEC,MAAM,EAAEC,EAAE,EAAEC,EAAE,QAAQ,SAAQ;AAE7D,MAAMC,eAAeD,GAAGE,EAAE,GAAGC,iBAAiB,CAACC;AAC/C,MAAMC,gBAAgBL,GAAGE,EAAE,GAAGC,iBAAiB,CAACC;AAEhDJ,GAAGM,IAAI,CAAC,eAAe,IAAO,CAAA;QAC5BC,SAAS;YACPC,UAAUP;YACVQ,WAAWJ;QACb;IACF,CAAA;AAEA,MAAM,EAAEK,WAAW,EAAE,GAAG,MAAM,MAAM,CAAC;AAErCb,SAAS,eAAe;IACtB,MAAMc,UAAU;QAAEC,QAAQ;YAAEC,OAAOb,GAAGE,EAAE;QAAG;IAAE;IAC7C,MAAMY,MAAM,CAAC;IAEblB,WAAW;QACTI,GAAGe,aAAa;IAClB;IAEAhB,GAAG,iCAAiC;QAClC,MAAMiB,SAASC,OAAOC,IAAI,CAAC;QAE3B,MAAMR,YAAYC,SAAS;YAAC;gBAAEK;gBAAQG,MAAM;YAAuB;SAAE,EAAEL;QAEvEhB,OAAOO,eAAee,oBAAoB,CAAC,wBAAwBJ;QACnElB,OAAOG,cAAcoB,GAAG,CAACC,gBAAgB;IAC3C;IAEAvB,GAAG,sEAAsE;QACvE,MAAMW,YACJC,SACA;YAAC;gBAAEQ,MAAM;gBAAwBI,YAAY;YAAiC;SAAE,EAChFT;QAGFhB,OAAOG,cAAcmB,oBAAoB,CACvC,kCACA;QAEFtB,OAAOO,eAAegB,GAAG,CAACC,gBAAgB;IAC5C;AACF"}

package/dist/utilities/addDataAndFileToRequest.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"addDataAndFileToRequest.d.ts","sourceRoot":"","sources":["../../src/utilities/addDataAndFileToRequest.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;~~AAKvD~~,KAAK,uBAAuB,GAAG,CAAC,GAAG,EAAE,cAAc,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;AAErE;;GAEG;AACH,eAAO,MAAM,uBAAuB,EAAE,~~uBAwGrC~~,CAAA"}
1	+ {"version":3,"file":"addDataAndFileToRequest.d.ts","sourceRoot":"","sources":["../../src/utilities/addDataAndFileToRequest.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AAOvD,KAAK,uBAAuB,GAAG,CAAC,GAAG,EAAE,cAAc,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;AAErE;;GAEG;AACH,eAAO,MAAM,uBAAuB,EAAE,uBA4ErC,CAAA"}

package/dist/utilities/addDataAndFileToRequest.js CHANGED Viewed

@@ -1,5 +1,6 @@
 import { APIError } from '../errors/APIError.js';
 import { processMultipartFormdata } from '../uploads/fetchAPI-multipart/index.js';
+import { getFileFromUploadInstructions } from '../uploads/getFileFromUploadInstructions.js';
 /**
  * Mutates the Request, appending 'data' and 'file' if found
  */ export const addDataAndFileToRequest = async (req)=>{
@@ -50,50 +51,22 @@ import { processMultipartFormdata } from '../uploads/fetchAPI-multipart/index.js
                 req.data = JSON.parse(fields._payload);
             }
             if (!req.file && fields?.file && typeof fields?.file === 'string') {
-                let clientUploadContext, collectionSlug, filename, mimeType, size;
+                let uploadedFile;
                 try {
-                    ;
-                    ({ clientUploadContext, collectionSlug, filename, mimeType, size } = JSON.parse(fields.file));
+                    uploadedFile = JSON.parse(fields.file);
                 } catch  {
                     throw new APIError('A file name is required.', 400);
                 }
-                const uploadConfig = req.payload.collections[collectionSlug].config.upload;
-                if (!uploadConfig.handlers) {
-                    throw new APIError('uploadConfig.handlers is not present for ' + collectionSlug);
+                const collectionSlug = typeof req.routeParams?.collection === 'string' ? req.routeParams.collection : uploadedFile.collectionSlug;
+                const uploadConfig = collectionSlug ? req.payload.collections[collectionSlug]?.config.upload : undefined;
+                if (!collectionSlug || !uploadConfig) {
+                    throw new APIError('Invalid upload collection.', 400);
                 }
-                let response = null;
-                let error;
-                for (const handler of uploadConfig.handlers){
-                    try {
-                        const result = await handler(req, {
-                            doc: null,
-                            params: {
-                                clientUploadContext,
-                                collection: collectionSlug,
-                                filename
-                            }
-                        });
-                        if (result) {
-                            response = result;
-                        }
-                    // If we couldn't get the file from that handler, save the error and try other.
-                    } catch (err) {
-                        error = err;
-                    }
-                }
-                if (!response) {
-                    if (error) {
-                        payload.logger.error(error);
-                    }
-                    throw new APIError('Expected response from the upload handler.');
-                }
-                req.file = {
-                    name: filename,
-                    clientUploadContext,
-                    data: Buffer.from(await response.arrayBuffer()),
-                    mimetype: response.headers.get('Content-Type') || mimeType,
-                    size
-                };
+                req.file = await getFileFromUploadInstructions({
+                    collectionSlug,
+                    file: uploadedFile,
+                    req
+                });
             }
         }
     }