payload/dist/uploads/getSafeFilename.js

Node, React, Headless CMS and Application Framework built on Next.js

import sanitize from 'sanitize-filename';
import { docWithFilenameExists } from './docWithFilenameExists.js';
import { fileExists } from './fileExists.js';
/**
 * Increments a filename by appending or incrementing a numeric suffix.
 * @example
 * incrementName('file.jpg') // 'file-1.jpg'
 * incrementName('file-1.jpg') // 'file-2.jpg'
 * incrementName('file-99.jpg') // 'file-100.jpg'
 */ export const incrementName = (name)=>{
    const extension = name.split('.').pop();
    const baseFilename = sanitize(name.substring(0, name.lastIndexOf('.')) || name);
    let incrementedName = baseFilename;
    const regex = /(.*)-(\d+)$/;
    const found = baseFilename.match(regex);
    if (found === null) {
        incrementedName += '-1';
    } else {
        const matchedName = found[1];
        const matchedNumber = found[2];
        const incremented = Number(matchedNumber) + 1;
        incrementedName = `${matchedName}-${incremented}`;
    }
    return `${incrementedName}.${extension}`;
};
/**
 * Generates a safe, unique filename by checking for conflicts in both the database
 * and filesystem. If a conflict exists, it increments a numeric suffix until a
 * unique name is found.
 *
 * @param args.collectionSlug - The slug of the upload collection
 * @param args.desiredFilename - The original filename to make safe
 * @param args.prefix - Optional prefix path for cloud storage adapters
 * @param args.req - The Payload request object
 * @param args.staticPath - The filesystem path where uploads are stored
 * @returns A unique filename that doesn't conflict with existing files
 *
 * @example
 * // If 'photo.jpg' already exists, returns 'photo-1.jpg'
 * const safeName = await getSafeFileName({
 *   collectionSlug: 'media',
 *   desiredFilename: 'photo.jpg',
 *   req,
 *   staticPath: '/uploads/media',
 * })
 */ export async function getSafeFileName({ collectionSlug, desiredFilename, prefix, req, staticPath }) {
    let modifiedFilename = desiredFilename;
    while(await docWithFilenameExists({
        collectionSlug,
        filename: modifiedFilename,
        path: staticPath,
        prefix,
        req
    }) || await fileExists(`${staticPath}/${modifiedFilename}`)){
        modifiedFilename = incrementName(modifiedFilename);
    }
    return modifiedFilename;
}

//# sourceMappingURL=getSafeFilename.js.map