nextjs-cms 0.5.9 → 0.5.11

package/dist/core/fields/photo.js

@@ -1,410 +1,410 @@
-import { baseFieldConfigSchema } from "./field.js";
-import { entityKind } from "../helpers.js";
-import * as z from 'zod';
-import sharp from 'sharp';
-import path from 'path';
-import fs from 'fs';
-import { customAlphabet } from 'nanoid';
-import { FileField } from "./fileField.js";
-import { humanReadableFileSize } from "../../utils.js";
-import { getCMSConfig } from "../config.js";
-const cmsConfig = getCMSConfig();
-const sizeSchema = z.strictObject({
-    width: z.number().describe('Image width in pixels'),
-    height: z.number().describe('Image height in pixels'),
-    /**
-     * @true The image will not have dimensions constraints,
-     * and will be cropped to fit the specified dimensions
-     *
-     * @false The user will be forced to upload an image with the specified dimensions
-     *
-     * @example
-     * size: {
-     *   width: 1200,
-     *   height: 450,
-     *   crop: true, // No constraints
-     *   }
-     */
-    crop: z.boolean().describe('Whether to crop the image to fit dimensions'),
-});
-const thumbnailSchema = z.strictObject({
-    width: z.number().describe('Thumbnail width in pixels'),
-    height: z.number().describe('Thumbnail height in pixels'),
-    crop: z.boolean().describe('Whether to crop the thumbnail'),
-    quality: z.number().optional().describe('Thumbnail quality (0-100)'),
-});
-const maxFileSizeSchema = z.strictObject({
-    size: z.number().describe('Maximum file size'),
-    unit: z.enum(['kb', 'mb']).describe('Size unit'),
-});
-const configSchema = z.strictObject({
-    /** Whether to add watermark to images */
-    watermark: z.boolean().nullable().optional(),
-    blurPlaceholder: z.boolean().nullable().optional(),
-    size: sizeSchema.optional(),
-    thumbnail: thumbnailSchema.optional(),
-    /**
-     * Maximum file size
-     * @example
-     * maxFileSize: {
-     *    size: 512,
-     *    unit: 'kb',
-     *    }
-     */
-    maxFileSize: maxFileSizeSchema.optional(),
-    /**
-     * Allowed image types
-     * @example
-     * type: ['jpeg', 'png', 'webp']
-     * @default ['jpeg']
-     * @link https://sharp.pixelplumbing.com/api-output#toformat
-     * @hint 'jpg' is an alias for 'jpeg'
-     */
-    type: z.array(z.enum(['jpeg', 'jpg', 'png', 'webp'])).optional(),
-    /**
-     * Remove the extension from the file name
-     * @default true
-     */
-    removeExtension: z.boolean().optional(),
-});
-export class PhotoField extends FileField {
-    static [entityKind] = 'PhotoField';
-    watermark;
-    blurPlaceholder;
-    size;
-    maxFileSize;
-    mimeType;
-    extensions;
-    thumbnail;
-    removeExtension;
-    uploadsFolder = cmsConfig.files.upload.uploadPath;
-    /**
-     * _file is the file object if it's present
-     * Whereas the value is the path to the file
-     */
-    _file = undefined;
-    _sharpImage = undefined;
-    _folder;
-    _allowedExtensions;
-    constructor(config, file) {
-        super(config, 'photo');
-        if (file) {
-            this._file = file;
-        }
-        this.watermark = config.watermark;
-        this.blurPlaceholder = config.blurPlaceholder;
-        this.size = config.size;
-        this.maxFileSize = config.maxFileSize ?? { size: 2, unit: 'mb' };
-        this.thumbnail = config.thumbnail ?? cmsConfig.files.images.thumbnail;
-        this.removeExtension = config.removeExtension ?? true;
-        this.extensions = config.type ?? ['jpeg'];
-        /**
-         * Replace 'jpg' with 'jpeg'
-         */
-        this.extensions = this.extensions.map((e) => (e === 'jpg' ? 'jpeg' : e));
-        /**
-         * Extract the mime types from the extensions
-         */
-        this.mimeType = this.extensions.map((e) => {
-            if (e === 'jpeg')
-                return 'image/jpeg';
-            if (e === 'png')
-                return 'image/png';
-            if (e === 'webp')
-                return 'image/webp';
-            throw new Error(`Invalid image extension provided: ${e}`);
-        });
-        /**
-         * Set the allowed extensions, add jpg if jpeg is present
-         */
-        this._allowedExtensions = this.extensions;
-        if (this.extensions.includes('jpeg')) {
-            this._allowedExtensions.push('jpg');
-        }
-    }
-    exportForClient() {
-        return {
-            ...super.exportForClient(),
-            thumbnail: this.thumbnail,
-            // watermark: this.watermark,
-            // blurPlaceholder: this.blurPlaceholder,
-            size: this.size,
-            maxFileSize: this.maxFileSize,
-            extensions: this._allowedExtensions,
-            mimeType: this.mimeType,
-        };
-    }
-    /**
-     * Write the file to the disk
-     */
-    async writeToFile() {
-        if (!this._folder) {
-            throw new Error(`${this.label}: Folder is not set. Make sure to set the folder by calling postSubmit() before writing the file to disk`);
-        }
-        if (!this._sharpImage) {
-            throw new Error(`${this.label}: Image is not set. Make sure to call prepareForSubmission() before writing the file to disk`);
-        }
-        try {
-            /**
-             * If .photos, and 'sectionName' folders don't exist, create them
-             */
-            const photosFolder = path.join(this.uploadsFolder, '.photos', this._folder);
-            const thumbsFolder = path.join(this.uploadsFolder, '.thumbs', this._folder);
-            if (!fs.existsSync(photosFolder)) {
-                fs.mkdirSync(photosFolder, { recursive: true });
-            }
-            if (!fs.existsSync(thumbsFolder)) {
-                fs.mkdirSync(thumbsFolder, { recursive: true });
-            }
-            /**
-             * Check if the image needs to be resized and write the file to disk
-             */
-            if (this.size && this.size.crop) {
-                await this._sharpImage
-                    .clone()
-                    .resize({
-                    width: this.size.width,
-                    height: this.size.height,
-                    fit: 'cover',
-                })
-                    .webp()
-                    .toFile(path.join(this.uploadsFolder, '.photos', this._folder, this.value));
-            }
-            else {
-                await this._sharpImage
-                    .clone()
-                    .toFile(path.join(this.uploadsFolder, '.photos', this._folder, this.value));
-            }
-            /**
-             * Also, write a thumbnail
-             */
-            await this._sharpImage
-                .clone()
-                .resize({
-                width: this.thumbnail.width,
-                height: this.thumbnail.height,
-                fit: this.thumbnail.crop ? 'cover' : 'contain',
-            })
-                .webp({
-                quality: this.thumbnail.quality || 80,
-            })
-                .toFile(path.join(this.uploadsFolder, '.thumbs', this._folder, this.value));
-        }
-        catch (error) {
-            throw new Error(`${this.label}: Error writing file to disk  ${error.message}`);
-        }
-    }
-    async postSubmit(folder) {
-        if (!this._file)
-            return;
-        this._folder = folder;
-        await this.writeToFile();
-    }
-    async postSubmitRollback() {
-        if (!this._file)
-            return;
-        if (!this._folder) {
-            throw new Error(`${this.label}: Folder is not set. Make sure to set the folder before writing the file to disk`);
-        }
-        try {
-            const pathToFile = path.join(this.uploadsFolder, '.photos', this._folder, this.value);
-            await fs.promises.unlink(pathToFile);
-        }
-        catch (error) {
-            throw new Error(`${this.label}: Error deleting file from disk`);
-        }
-    }
-    /**
-     * Get the value of the field
-     */
-    getValue() {
-        return this.value;
-    }
-    setFileName(value) {
-        this.value = value;
-    }
-    setValue(value) {
-        if (typeof value === 'string') {
-            this.setFileName(value);
-            return;
-        }
-        this.setFile(value);
-    }
-    setFile(file) {
-        if (!file || file.size === 0 || file.name?.trim() === '')
-            return;
-        this._file = file;
-    }
-    checkRequired() {
-        /**
-         * Check if the field is required
-         * If it is, check if the file is present
-         * If it's not, throw an error
-         */
-        if (this.required) {
-            if (!this._file?.type || !this._file?.name || !this._file?.size) {
-                throw new Error(`Field ${this.label} is required`);
-            }
-        }
-    }
-    /**
-     * Prepare the field for submission
-     */
-    async prepareForSubmission() {
-        /**
-         * Check if the file is present
-         */
-        if (!this._file)
-            return;
-        /**
-         * Check extension
-         */
-        let ext = this._file.name.split('.').pop();
-        // Treat jpg as jpeg
-        if (ext === 'jpg')
-            ext = 'jpeg';
-        if (!ext || !this.extensions.includes(ext)) {
-            throw new Error(`${this.label}: Invalid file type or extension. Allowed extensions: ${this.extensions.join(', ')}`);
-        }
-        /**
-         * Construct the image
-         */
-        const arrayBuffer = await this._file.arrayBuffer();
-        const buffer = Buffer.from(arrayBuffer);
-        /**
-         * Check mime type
-         */
-        if (!this.mimeType.includes(this._file.type)) {
-            throw new Error(`${this.label}: Invalid file type or extension. Allowed extensions: ${this.extensions.join(', ')}`);
-        }
-        /**
-         * Check actual mime type
-         */
-        const { fileTypeFromBuffer } = await import('file-type');
-        const actualMimeType = await fileTypeFromBuffer(buffer);
-        if (!actualMimeType ||
-            !this.extensions.includes(actualMimeType.ext) ||
-            !this.mimeType.includes(actualMimeType.mime)) {
-            throw new Error(`${this.label}: Invalid file type or extension. Allowed extensions: ${this.extensions.join(', ')}`);
-        }
-        /**
-         * Disable caching for the image to avoid unlink issues
-         */
-        sharp.cache({ files: 0 });
-        sharp.cache(false);
-        const image = sharp(buffer);
-        /**
-         * Get the metadata
-         * Fast access to (uncached) image metadata without decoding any compressed pixel data.
-         * This is read from the header of the input image.
-         * It does not take into consideration any operations to be applied to the output image, such as resize or rotate.
-         * @link: https://sharp.pixelplumbing.com/api-input#metadata
-         */
-        const metadata = await image.metadata();
-        /**
-         * Check the actual file size (buffer size)
-         */
-        const fileSize = buffer.length;
-        if (!fileSize || !metadata.size) {
-            throw new Error(`Field ${this.label} is required`);
-        }
-        /**
-         * Check the file size
-         */
-        if (fileSize > this.maxFileSize.size * (this.maxFileSize.unit === 'kb' ? 1024 : 1024 * 1024)) {
-            throw new Error(`${this.label}: File size (${humanReadableFileSize(fileSize)}) exceeds the maximum allowed size of ${this.maxFileSize.size} ${this.maxFileSize.unit}`);
-        }
-        /**
-         * Don't just trust the file extension
-         * Check the format
-         */
-        if (!metadata.format || !this.extensions.includes(metadata.format)) {
-            throw new Error(`${this.label}: Invalid file type or extension. Allowed extensions: ${this.extensions.join(', ')}`);
-        }
-        /**
-         * Check stat
-         */
-        try {
-            await image.stats();
-        }
-        catch (error) {
-            throw new Error(`File is corrupted`);
-        }
-        /**
-         * Convert the image to webp
-         */
-        try {
-            image.toFormat('webp').withExif({});
-        }
-        catch (error) {
-            throw new Error(`File is corrupted`);
-        }
-        /**
-         * Check the size
-         */
-        if (this.size) {
-            /**
-             * Check if the image does not need to be cropped (dimensions are constrained)
-             */
-            if (!this.size.crop) {
-                /**
-                 * Just resize the image?
-                 */
-                /**
-                 * Check if the size matches the required size
-                 */
-                if (metadata.width !== this.size.width || metadata.height !== this.size.height) {
-                    throw new Error(`${this.label}: Uploaded image size (${metadata.width}x${metadata.height} pixels) does not match the required size: ${this.size.width}x${this.size.height} pixels`);
-                }
-            }
-        }
-        /**
-         * Generate a random name for the file
-         */
-        this.value = customAlphabet('1234567890abcdef', 21)();
-        this.value = this.removeExtension ? this.value : this.value + '.webp';
-        /*if (saveFilesWithExtensions) {
-            /!**
-             * Currently we're forcing webp output.
-             * I've to add the ability for developers to choose the output format
-             *!/
-            this.value += '.webp'
-        }*/
-        /**
-         * Set the sharp image
-         */
-        this._sharpImage = image;
-    }
-}
-const optionsSchema = z.strictObject({
-    ...baseFieldConfigSchema.shape,
-    ...configSchema.shape,
-});
-const photoFieldConfigSchema = z.strictObject({
-    ...optionsSchema.shape,
-    type: z.literal('photo').describe('The type of the field'),
-    build: z.function().output(z.instanceof(PhotoField)).describe('Build a PhotoField instance from this config'),
-});
-/**
- * Helper function to create a photo field configuration
- * Returns a config object with a build() method that can be serialized and used anywhere
- * @param field
- */
-export function photoField(field) {
-    /**
-     * Validate the field config
-     */
-    const result = optionsSchema.safeParse(field);
-    if (!result.success) {
-        throw new Error(`[Field: ${field.name}]: ${z.prettifyError(result.error)}`);
-    }
-    const config = {
-        ...field,
-        type: 'photo',
-        build() {
-            // Use the original field config directly (it doesn't have build() method)
-            return new PhotoField(field);
-        },
-    };
-    return config;
-}
+import { baseFieldConfigSchema } from './field.js';
+import { entityKind } from '../helpers/index.js';
+import * as z from 'zod';
+import sharp from 'sharp';
+import path from 'path';
+import fs from 'fs';
+import { customAlphabet } from 'nanoid';
+import { FileField } from './fileField.js';
+import { humanReadableFileSize } from '../../utils/index.js';
+import { getCMSConfig } from '../config/index.js';
+const cmsConfig = getCMSConfig();
+const sizeSchema = z.strictObject({
+    width: z.number().describe('Image width in pixels'),
+    height: z.number().describe('Image height in pixels'),
+    /**
+     * @true The image will not have dimensions constraints,
+     * and will be cropped to fit the specified dimensions
+     *
+     * @false The user will be forced to upload an image with the specified dimensions
+     *
+     * @example
+     * size: {
+     *   width: 1200,
+     *   height: 450,
+     *   crop: true, // No constraints
+     *   }
+     */
+    crop: z.boolean().describe('Whether to crop the image to fit dimensions'),
+});
+const thumbnailSchema = z.strictObject({
+    width: z.number().describe('Thumbnail width in pixels'),
+    height: z.number().describe('Thumbnail height in pixels'),
+    crop: z.boolean().describe('Whether to crop the thumbnail'),
+    quality: z.number().optional().describe('Thumbnail quality (0-100)'),
+});
+const maxFileSizeSchema = z.strictObject({
+    size: z.number().describe('Maximum file size'),
+    unit: z.enum(['kb', 'mb']).describe('Size unit'),
+});
+const configSchema = z.strictObject({
+    /** Whether to add watermark to images */
+    watermark: z.boolean().nullable().optional(),
+    blurPlaceholder: z.boolean().nullable().optional(),
+    size: sizeSchema.optional(),
+    thumbnail: thumbnailSchema.optional(),
+    /**
+     * Maximum file size
+     * @example
+     * maxFileSize: {
+     *    size: 512,
+     *    unit: 'kb',
+     *    }
+     */
+    maxFileSize: maxFileSizeSchema.optional(),
+    /**
+     * Allowed image types
+     * @example
+     * type: ['jpeg', 'png', 'webp']
+     * @default ['jpeg']
+     * @link https://sharp.pixelplumbing.com/api-output#toformat
+     * @hint 'jpg' is an alias for 'jpeg'
+     */
+    type: z.array(z.enum(['jpeg', 'jpg', 'png', 'webp'])).optional(),
+    /**
+     * Remove the extension from the file name
+     * @default true
+     */
+    removeExtension: z.boolean().optional(),
+});
+export class PhotoField extends FileField {
+    static [entityKind] = 'PhotoField';
+    watermark;
+    blurPlaceholder;
+    size;
+    maxFileSize;
+    mimeType;
+    extensions;
+    thumbnail;
+    removeExtension;
+    uploadsFolder = cmsConfig.files.upload.uploadPath;
+    /**
+     * _file is the file object if it's present
+     * Whereas the value is the path to the file
+     */
+    _file = undefined;
+    _sharpImage = undefined;
+    _folder;
+    _allowedExtensions;
+    constructor(config, file) {
+        super(config, 'photo');
+        if (file) {
+            this._file = file;
+        }
+        this.watermark = config.watermark;
+        this.blurPlaceholder = config.blurPlaceholder;
+        this.size = config.size;
+        this.maxFileSize = config.maxFileSize ?? { size: 2, unit: 'mb' };
+        this.thumbnail = config.thumbnail ?? cmsConfig.files.images.thumbnail;
+        this.removeExtension = config.removeExtension ?? true;
+        this.extensions = config.type ?? ['jpeg'];
+        /**
+         * Replace 'jpg' with 'jpeg'
+         */
+        this.extensions = this.extensions.map((e) => (e === 'jpg' ? 'jpeg' : e));
+        /**
+         * Extract the mime types from the extensions
+         */
+        this.mimeType = this.extensions.map((e) => {
+            if (e === 'jpeg')
+                return 'image/jpeg';
+            if (e === 'png')
+                return 'image/png';
+            if (e === 'webp')
+                return 'image/webp';
+            throw new Error(`Invalid image extension provided: ${e}`);
+        });
+        /**
+         * Set the allowed extensions, add jpg if jpeg is present
+         */
+        this._allowedExtensions = this.extensions;
+        if (this.extensions.includes('jpeg')) {
+            this._allowedExtensions.push('jpg');
+        }
+    }
+    exportForClient() {
+        return {
+            ...super.exportForClient(),
+            thumbnail: this.thumbnail,
+            // watermark: this.watermark,
+            // blurPlaceholder: this.blurPlaceholder,
+            size: this.size,
+            maxFileSize: this.maxFileSize,
+            extensions: this._allowedExtensions,
+            mimeType: this.mimeType,
+        };
+    }
+    /**
+     * Write the file to the disk
+     */
+    async writeToFile() {
+        if (!this._folder) {
+            throw new Error(`${this.label}: Folder is not set. Make sure to set the folder by calling postSubmit() before writing the file to disk`);
+        }
+        if (!this._sharpImage) {
+            throw new Error(`${this.label}: Image is not set. Make sure to call prepareForSubmission() before writing the file to disk`);
+        }
+        try {
+            /**
+             * If .photos, and 'sectionName' folders don't exist, create them
+             */
+            const photosFolder = path.join(this.uploadsFolder, '.photos', this._folder);
+            const thumbsFolder = path.join(this.uploadsFolder, '.thumbs', this._folder);
+            if (!fs.existsSync(photosFolder)) {
+                fs.mkdirSync(photosFolder, { recursive: true });
+            }
+            if (!fs.existsSync(thumbsFolder)) {
+                fs.mkdirSync(thumbsFolder, { recursive: true });
+            }
+            /**
+             * Check if the image needs to be resized and write the file to disk
+             */
+            if (this.size && this.size.crop) {
+                await this._sharpImage
+                    .clone()
+                    .resize({
+                    width: this.size.width,
+                    height: this.size.height,
+                    fit: 'cover',
+                })
+                    .webp()
+                    .toFile(path.join(this.uploadsFolder, '.photos', this._folder, this.value));
+            }
+            else {
+                await this._sharpImage
+                    .clone()
+                    .toFile(path.join(this.uploadsFolder, '.photos', this._folder, this.value));
+            }
+            /**
+             * Also, write a thumbnail
+             */
+            await this._sharpImage
+                .clone()
+                .resize({
+                width: this.thumbnail.width,
+                height: this.thumbnail.height,
+                fit: this.thumbnail.crop ? 'cover' : 'contain',
+            })
+                .webp({
+                quality: this.thumbnail.quality || 80,
+            })
+                .toFile(path.join(this.uploadsFolder, '.thumbs', this._folder, this.value));
+        }
+        catch (error) {
+            throw new Error(`${this.label}: Error writing file to disk  ${error.message}`);
+        }
+    }
+    async postSubmit(folder) {
+        if (!this._file)
+            return;
+        this._folder = folder;
+        await this.writeToFile();
+    }
+    async postSubmitRollback() {
+        if (!this._file)
+            return;
+        if (!this._folder) {
+            throw new Error(`${this.label}: Folder is not set. Make sure to set the folder before writing the file to disk`);
+        }
+        try {
+            const pathToFile = path.join(this.uploadsFolder, '.photos', this._folder, this.value);
+            await fs.promises.unlink(pathToFile);
+        }
+        catch (error) {
+            throw new Error(`${this.label}: Error deleting file from disk`);
+        }
+    }
+    /**
+     * Get the value of the field
+     */
+    getValue() {
+        return this.value;
+    }
+    setFileName(value) {
+        this.value = value;
+    }
+    setValue(value) {
+        if (typeof value === 'string') {
+            this.setFileName(value);
+            return;
+        }
+        this.setFile(value);
+    }
+    setFile(file) {
+        if (!file || file.size === 0 || file.name?.trim() === '')
+            return;
+        this._file = file;
+    }
+    checkRequired() {
+        /**
+         * Check if the field is required
+         * If it is, check if the file is present
+         * If it's not, throw an error
+         */
+        if (this.required) {
+            if (!this._file?.type || !this._file?.name || !this._file?.size) {
+                throw new Error(`Field ${this.label} is required`);
+            }
+        }
+    }
+    /**
+     * Prepare the field for submission
+     */
+    async prepareForSubmission() {
+        /**
+         * Check if the file is present
+         */
+        if (!this._file)
+            return;
+        /**
+         * Check extension
+         */
+        let ext = this._file.name.split('.').pop();
+        // Treat jpg as jpeg
+        if (ext === 'jpg')
+            ext = 'jpeg';
+        if (!ext || !this.extensions.includes(ext)) {
+            throw new Error(`${this.label}: Invalid file type or extension. Allowed extensions: ${this.extensions.join(', ')}`);
+        }
+        /**
+         * Construct the image
+         */
+        const arrayBuffer = await this._file.arrayBuffer();
+        const buffer = Buffer.from(arrayBuffer);
+        /**
+         * Check mime type
+         */
+        if (!this.mimeType.includes(this._file.type)) {
+            throw new Error(`${this.label}: Invalid file type or extension. Allowed extensions: ${this.extensions.join(', ')}`);
+        }
+        /**
+         * Check actual mime type
+         */
+        const { fileTypeFromBuffer } = await import('file-type');
+        const actualMimeType = await fileTypeFromBuffer(buffer);
+        if (!actualMimeType ||
+            !this.extensions.includes(actualMimeType.ext) ||
+            !this.mimeType.includes(actualMimeType.mime)) {
+            throw new Error(`${this.label}: Invalid file type or extension. Allowed extensions: ${this.extensions.join(', ')}`);
+        }
+        /**
+         * Disable caching for the image to avoid unlink issues
+         */
+        sharp.cache({ files: 0 });
+        sharp.cache(false);
+        const image = sharp(buffer);
+        /**
+         * Get the metadata
+         * Fast access to (uncached) image metadata without decoding any compressed pixel data.
+         * This is read from the header of the input image.
+         * It does not take into consideration any operations to be applied to the output image, such as resize or rotate.
+         * @link: https://sharp.pixelplumbing.com/api-input#metadata
+         */
+        const metadata = await image.metadata();
+        /**
+         * Check the actual file size (buffer size)
+         */
+        const fileSize = buffer.length;
+        if (!fileSize || !metadata.size) {
+            throw new Error(`Field ${this.label} is required`);
+        }
+        /**
+         * Check the file size
+         */
+        if (fileSize > this.maxFileSize.size * (this.maxFileSize.unit === 'kb' ? 1024 : 1024 * 1024)) {
+            throw new Error(`${this.label}: File size (${humanReadableFileSize(fileSize)}) exceeds the maximum allowed size of ${this.maxFileSize.size} ${this.maxFileSize.unit}`);
+        }
+        /**
+         * Don't just trust the file extension
+         * Check the format
+         */
+        if (!metadata.format || !this.extensions.includes(metadata.format)) {
+            throw new Error(`${this.label}: Invalid file type or extension. Allowed extensions: ${this.extensions.join(', ')}`);
+        }
+        /**
+         * Check stat
+         */
+        try {
+            await image.stats();
+        }
+        catch (error) {
+            throw new Error(`File is corrupted`);
+        }
+        /**
+         * Convert the image to webp
+         */
+        try {
+            image.toFormat('webp').withExif({});
+        }
+        catch (error) {
+            throw new Error(`File is corrupted`);
+        }
+        /**
+         * Check the size
+         */
+        if (this.size) {
+            /**
+             * Check if the image does not need to be cropped (dimensions are constrained)
+             */
+            if (!this.size.crop) {
+                /**
+                 * Just resize the image?
+                 */
+                /**
+                 * Check if the size matches the required size
+                 */
+                if (metadata.width !== this.size.width || metadata.height !== this.size.height) {
+                    throw new Error(`${this.label}: Uploaded image size (${metadata.width}x${metadata.height} pixels) does not match the required size: ${this.size.width}x${this.size.height} pixels`);
+                }
+            }
+        }
+        /**
+         * Generate a random name for the file
+         */
+        this.value = customAlphabet('1234567890abcdef', 21)();
+        this.value = this.removeExtension ? this.value : this.value + '.webp';
+        /*if (saveFilesWithExtensions) {
+            /!**
+             * Currently we're forcing webp output.
+             * I've to add the ability for developers to choose the output format
+             *!/
+            this.value += '.webp'
+        }*/
+        /**
+         * Set the sharp image
+         */
+        this._sharpImage = image;
+    }
+}
+const optionsSchema = z.strictObject({
+    ...baseFieldConfigSchema.shape,
+    ...configSchema.shape,
+});
+const photoFieldConfigSchema = z.strictObject({
+    ...optionsSchema.shape,
+    type: z.literal('photo').describe('The type of the field'),
+    build: z.function().output(z.instanceof(PhotoField)).describe('Build a PhotoField instance from this config'),
+});
+/**
+ * Helper function to create a photo field configuration
+ * Returns a config object with a build() method that can be serialized and used anywhere
+ * @param field
+ */
+export function photoField(field) {
+    /**
+     * Validate the field config
+     */
+    const result = optionsSchema.safeParse(field);
+    if (!result.success) {
+        throw new Error(`[Field: ${field.name}]: ${z.prettifyError(result.error)}`);
+    }
+    const config = {
+        ...field,
+        type: 'photo',
+        build() {
+            // Use the original field config directly (it doesn't have build() method)
+            return new PhotoField(field);
+        },
+    };
+    return config;
+}