rimecms 0.31.5 → 0.32.1

package/dist/core/collections/upload/disk/save.server.js

@@ -1,190 +0,0 @@
-import { RimeError } from '../../../errors/index.js';
-import { normalizeFileName } from '../../../../util/file.js';
-import { pick } from '../../../../util/object.js';
-import { toCamelCase } from '../../../../util/string.js';
-import crypto from 'crypto';
-import { existsSync, readFileSync, statSync, writeFileSync } from 'fs';
-import path from 'path';
-import sharp from 'sharp';
-/**
- * Compares a buffer with an existing file to determine if they are identical
- * Uses file size as a quick check before comparing content hashes
- * @example
- * const identical = isSameFile(fileBuffer, '/path/to/file.jpg');
- * if (identical) {
- *   console.log('Files are the same');
- * }
- */
-const isSameFile = (buffer, filePath) => {
-    try {
-        // Check if file exists
-        if (!existsSync(filePath))
-            return false;
-        // Compare file sizes first (quick check)
-        const stats = statSync(filePath);
-        if (stats.size !== buffer.length)
-            return false;
-        // Compare content hash (more thorough check)
-        const existingFileBuffer = readFileSync(filePath);
-        const existingFileHash = crypto.createHash('md5').update(existingFileBuffer).digest('hex');
-        const newFileHash = crypto.createHash('md5').update(buffer).digest('hex');
-        return existingFileHash === newFileHash;
-    }
-    catch {
-        // If any error occurs during comparison, assume files are different
-        return false;
-    }
-};
-/**
- * Verifies if all image size variations already exist for a given base filename
- * Returns a record of size names to filenames if all exist, empty object otherwise
- * @example
- * const sizes = checkImageSizesExist('image', 'jpg', imageSizesConfig);
- * if (Object.keys(sizes).length > 0) {
- *   console.log('All image sizes already exist');
- * }
- */
-const checkImageSizesExist = (name, extension, imagesSizes) => {
-    const sizes = {};
-    for (const size of imagesSizes) {
-        const whString = `${size.width}x${size.height}`;
-        if (!size.out || !size.out.length) {
-            // Check if the resized image exists
-            const filename = `${name}-${toCamelCase(size.name)}-${whString}.${extension}`;
-            const filePath = path.resolve(process.cwd(), `static/medias/${filename}`);
-            if (!existsSync(filePath)) {
-                return {}; // If any size doesn't exist, return empty object
-            }
-            sizes[toCamelCase(size.name)] = filename;
-        }
-        else {
-            // Check if all format conversions exist
-            const convertedFilenames = [];
-            for (const format of size.out) {
-                const filename = `${name}-${toCamelCase(size.name)}-${whString}.${format}`;
-                const filePath = path.resolve(process.cwd(), `static/medias/${filename}`);
-                if (!existsSync(filePath)) {
-                    return {}; // If any format doesn't exist, return empty object
-                }
-                convertedFilenames.push(filename);
-            }
-            sizes[toCamelCase(size.name)] = convertedFilenames.join('|');
-        }
-    }
-    return sizes;
-};
-/**
- * Saves a file to disk with deduplication and generates image sizes if needed
- * Checks if identical file already exists before creating a new one
- * @example
- * const file = event.request.formData.get('file');
- * const { filename, imageSizes } = await saveFile(file, config.imageSizes);
- */
-export const saveFile = async (file, imagesSizes) => {
-    const { name: initialName, extension } = normalizeFileName(file.name);
-    let name = initialName;
-    let sizes = {};
-    let filename = `${name}.${extension}`;
-    let filePath = path.resolve(process.cwd(), `static/medias/${filename}`);
-    // Get buffer once to avoid multiple arrayBuffer() calls
-    const buffer = Buffer.from(await file.arrayBuffer());
-    // Check if file exists and is identical
-    if (existsSync(filePath) && isSameFile(buffer, filePath)) {
-        // File already exists and is identical
-        // Check if image sizes already exist
-        if (imagesSizes && file.type.includes('image') && !file.type.includes('svg')) {
-            const existingSizes = checkImageSizesExist(name, extension, imagesSizes);
-            // If all sizes exist, use them
-            if (Object.keys(existingSizes).length > 0) {
-                return { filename, imageSizes: existingSizes };
-            }
-            // Otherwise, we'll need to generate the sizes
-            sizes = await generateSizes({
-                name,
-                extension,
-                sizes: imagesSizes,
-                buffer
-            });
-        }
-        return { filename, imageSizes: sizes };
-    }
-    // File doesn't exist or is different, find a unique name
-    while (existsSync(filePath)) {
-        name += `-${new Date().getTime().toString()}`;
-        filename = `${name}.${extension}`;
-        filePath = path.resolve(process.cwd(), `static/medias/${filename}`);
-    }
-    try {
-        writeFileSync(filePath, buffer);
-        if (imagesSizes && file.type.includes('image') && !file.type.includes('svg')) {
-            sizes = await generateSizes({
-                name,
-                extension,
-                sizes: imagesSizes,
-                buffer
-            });
-        }
-    }
-    catch (error) {
-        throw new RimeError(RimeError.UPLOAD, `Error while processing file: ${error.message}`);
-    }
-    return { filename, imageSizes: sizes };
-};
-/**
- * Generates various image sizes based on configuration
- * Creates resized versions and format conversions as specified
- * @example
- * const sizes = await generateSizes({
- *   name: 'image',
- *   extension: 'jpg',
- *   sizes: imageSizesConfig,
- *   buffer: imageBuffer
- * });
- */
-export const generateSizes = async ({ sizes, buffer, name, extension }) => {
-    const imageSizes = {};
-    for (const size of sizes) {
-        const wh = pick(['width', 'height'], size);
-        const resizedImage = sharp(buffer).resize(wh);
-        const whString = `${wh.width || ''}${wh.height && wh.width ? 'x' : ''}${wh.height || ''}`;
-        // If no output formats specified, keep original format
-        if (!size.out?.length) {
-            let resizedBuffer;
-            const shouldApplyCompression = extension === 'jpg' || extension === 'webp';
-            if (shouldApplyCompression) {
-                const compression = size.compression || 60;
-                if (extension === 'jpg') {
-                    resizedBuffer = await resizedImage.jpeg({ quality: compression }).toBuffer();
-                }
-                else {
-                    resizedBuffer = await resizedImage.webp({ quality: compression }).toBuffer();
-                }
-            }
-            else {
-                resizedBuffer = await resizedImage.toBuffer();
-            }
-            const filename = `${name}-${toCamelCase(size.name)}-${whString}.${extension}`;
-            const filePath = path.resolve(process.cwd(), `static/medias/${filename}`);
-            writeFileSync(filePath, resizedBuffer);
-            imageSizes[toCamelCase(size.name)] = filename;
-            continue;
-        }
-        // Handle format conversions
-        const convertedFiles = await Promise.all(size.out.map(async (format) => {
-            const compression = size.compression || 60;
-            let convertedImage;
-            if (format === 'jpg') {
-                convertedImage = await resizedImage.jpeg({ quality: compression }).toBuffer();
-            }
-            else {
-                convertedImage = await resizedImage.webp({ quality: compression }).toBuffer();
-            }
-            const filename = `${name}-${toCamelCase(size.name)}-${whString}.${format}`;
-            const filePath = path.resolve(process.cwd(), `static/medias/${filename}`);
-            writeFileSync(filePath, convertedImage);
-            return filename;
-        }));
-        imageSizes[toCamelCase(size.name)] = convertedFiles.join('|');
-    }
-    return imageSizes;
-};

package/dist/core/collections/upload/hooks/clean-up-files.server.d.ts

@@ -1,10 +0,0 @@
-/**
- * Hook executed before deleting a document to clean up associated files from storage.
- *
- * This hook performs the following operations:
- * 1. Retrieves the document ID from the deletion event
- * 2. Locates and removes all files associated with the document from storage
- * 3. Ensures no orphaned files remain after document deletion
- *
- */
-export declare const cleanUpFiles: import("../../../operations/hooks/index.server.js").Hook<"raw", "delete", "before">;

package/dist/core/collections/upload/hooks/clean-up-files.server.js

@@ -1,17 +0,0 @@
-import { cleanUpDocumentFile } from '../disk/delete.server.js';
-import { Hooks } from '../../../operations/hooks/index.server.js';
-/**
- * Hook executed before deleting a document to clean up associated files from storage.
- *
- * This hook performs the following operations:
- * 1. Retrieves the document ID from the deletion event
- * 2. Locates and removes all files associated with the document from storage
- * 3. Ensures no orphaned files remain after document deletion
- *
- */
-export const cleanUpFiles = Hooks.beforeDelete(async (args) => {
-    const config = args.config;
-    const id = args.context.params.id || '';
-    await cleanUpDocumentFile({ config, rime: args.event.locals.rime, id });
-    return args;
-});

package/dist/core/collections/upload/hooks/convert-base64.server.d.ts

@@ -1,13 +0,0 @@
-/**
- * Hook executed before save/update operations to convert base64 encoded files to File objects.
- *
- * @description
- * This hook performs the following operations:
- * 1. Checks if the incoming document contains a base64 encoded file
- * 2. Converts it to a proper File object for disk storage
- * 3. Preserves or generates metadata (filename, size, type)
- *
- * @param args Hook arguments containing the document to process
- * @returns Updated args object with converted file data
- */
-export declare const castBase64ToFile: import("../../../operations/hooks/index.server.js").Hook<"upload", "create" | "update", "before">;

package/dist/core/collections/upload/hooks/convert-base64.server.js

@@ -1,36 +0,0 @@
-import { jsonFileToFile } from '../util/converter.server.js';
-import { RimeError } from '../../../errors/index.js';
-import { Hooks } from '../../../operations/hooks/index.server.js';
-import { isFile } from '../../../../util/file.js';
-/**
- * Hook executed before save/update operations to convert base64 encoded files to File objects.
- *
- * @description
- * This hook performs the following operations:
- * 1. Checks if the incoming document contains a base64 encoded file
- * 2. Converts it to a proper File object for disk storage
- * 3. Preserves or generates metadata (filename, size, type)
- *
- * @param args Hook arguments containing the document to process
- * @returns Updated args object with converted file data
- */
-export const castBase64ToFile = Hooks.beforeUpsert(async (args) => {
-    let data = args.data;
-    if (data?.file && !isFile(data.file)) {
-        try {
-            const { file, filename, filesize, mimeType } = jsonFileToFile(data.file);
-            data = {
-                ...data,
-                file,
-                filename: data.filename || filename,
-                filesize: data.filesize || filesize,
-                mimeType: data.mimeType || mimeType
-            };
-        }
-        catch (err) {
-            args.event.locals.rime.logger.error('Failed to convert base64 string to File object', err.message);
-            throw new RimeError(RimeError.UPLOAD, 'Unable to process file');
-        }
-    }
-    return { ...args, data };
-});

package/dist/core/collections/upload/hooks/extract-path.server.d.ts

@@ -1,6 +0,0 @@
-/**
- * Hook executed before save/update operations on {uploadSlug}_directories collections
- * the function normalize and validate path ({slug}_directories.id).
- * Then extract parent, name from the given path.
- */
-export declare const exctractPath: import("../../../operations/hooks/index.server.js").Hook<"directory", "create" | "update", "before">;

package/dist/core/collections/upload/hooks/extract-path.server.js

@@ -1,25 +0,0 @@
-import { RimeError } from '../../../errors/index.js';
-import { Hooks } from '../../../operations/hooks/index.server.js';
-import { trycatchSync } from '../../../../util/function.js';
-import { getSegments } from '../util/path.js';
-/**
- * Hook executed before save/update operations on {uploadSlug}_directories collections
- * the function normalize and validate path ({slug}_directories.id).
- * Then extract parent, name from the given path.
- */
-export const exctractPath = Hooks.beforeUpsert(async (args) => {
-    let data = args.data;
-    if (data?.id) {
-        const [error, segments] = trycatchSync(() => getSegments(data.id));
-        if (error) {
-            throw new RimeError(RimeError.INVALID_DATA, error.message);
-        }
-        data = {
-            ...data,
-            id: segments.path,
-            name: segments.name,
-            parent: segments.parent
-        };
-    }
-    return { ...args, data };
-});

package/dist/core/collections/upload/hooks/handle-path-creation.server.d.ts

@@ -1,6 +0,0 @@
-/**
- * Hook executed before save/update operations on an upload collections
- * the function get the document _path and check if it exists,
- * if it doesn't it create {upload_slug}_directories entries recursively
- */
-export declare const handlePathCreation: import("../../../operations/hooks/index.server.js").Hook<"upload", "create" | "update", "before">;

package/dist/core/collections/upload/hooks/handle-path-creation.server.js

@@ -1,64 +0,0 @@
-import { UPLOAD_PATH } from '../../../constant.js';
-import { logger } from '../../../logger/index.server.js';
-import { withDirectoriesSuffix } from '../../../naming.js';
-import { Hooks } from '../../../operations/hooks/index.server.js';
-import { trycatch } from '../../../../util/function.js';
-import { getSegments } from '../util/path.js';
-/**
- * Hook executed before save/update operations on an upload collections
- * the function get the document _path and check if it exists,
- * if it doesn't it create {upload_slug}_directories entries recursively
- */
-export const handlePathCreation = Hooks.beforeUpsert(async (args) => {
-    const { rime } = args.event.locals;
-    const data = args.data;
-    const IS_CREATE_WITHOUT_PATH = !('_path' in args.data) && args.operation === 'create';
-    if (IS_CREATE_WITHOUT_PATH) {
-        args.data._path = 'root';
-    }
-    if (args.data._path) {
-        const directorySlug = withDirectoriesSuffix(args.config.slug);
-        const [, dir] = await trycatch(() => rime.collection(directorySlug).findById({
-            select: ['id'],
-            id: data._path
-        }));
-        if (dir)
-            return args;
-        // Use the getSegments utility to extract path information
-        const pathInfo = getSegments(data._path);
-        // Split the path into segments
-        const segments = pathInfo.path.split(UPLOAD_PATH.SEPARATOR);
-        // Process all segments, including root
-        let currentPath = '';
-        for (let i = 0; i < segments.length; i++) {
-            const segment = segments[i];
-            const parentPath = currentPath || null; // For root, parent is null
-            // Build the current path
-            currentPath = currentPath ? `${currentPath}${UPLOAD_PATH.SEPARATOR}${segment}` : segment;
-            // Check if this segment exists
-            const [, segExists] = await trycatch(() => rime.collection(directorySlug).findById({
-                select: ['id'],
-                id: currentPath
-            }));
-            // If the segment doesn't exist, create it
-            if (!segExists) {
-                const [createError] = await trycatch(() => rime.collection(directorySlug).create({
-                    data: {
-                        id: currentPath,
-                        parent: parentPath,
-                        name: segment,
-                        createdAt: new Date(),
-                        updatedAt: new Date()
-                    }
-                }));
-                if (createError) {
-                    logger.error(`Failed to create directory segment ${currentPath}`, createError);
-                    // If we can't create a segment, fall back to root
-                    args.data._path = UPLOAD_PATH.ROOT_NAME;
-                    return args;
-                }
-            }
-        }
-    }
-    return args;
-});

package/dist/core/collections/upload/hooks/populate-sizes.server.d.ts

@@ -1 +0,0 @@
-export declare const populateSizes: import("../../../operations/hooks/index.server.js").Hook<"raw", "read", "before">;

package/dist/core/collections/upload/hooks/populate-sizes.server.js

@@ -1,45 +0,0 @@
-import { Hooks } from '../../../operations/hooks/index.server.js';
-export const populateSizes = Hooks.beforeRead(async (args) => {
-    const config = args.config;
-    const doc = args.doc;
-    if ('imageSizes' in config.upload && config.upload.imageSizes && doc.filename) {
-        doc.sizes = {};
-        for (const size of config.upload.imageSizes) {
-            if (doc[size.name]) {
-                // Handle multiple formats
-                const formats = doc[size.name].split('|');
-                // Multiple formats
-                if (formats.length > 1) {
-                    formats.forEach((format) => {
-                        const extension = format.split('.').pop();
-                        doc.sizes[`${size.name}_${extension}`] = `/medias/${format}`;
-                    });
-                    // Single format
-                }
-                else {
-                    doc.sizes[size.name] = `/medias/${formats[0]}`;
-                }
-                delete doc[size.name];
-            }
-            else {
-                // Default case: use original file as string
-                doc.sizes[size.name] = `/medias/${doc.filename}`;
-            }
-        }
-        // Add the _thumbnail prop
-        if ('thumbnail' in doc.sizes) {
-            doc._thumbnail = doc.sizes.thumbnail;
-        }
-        else {
-            const thumbnailKey = Object.keys(doc.sizes).find((sizeName) => sizeName.startsWith('thumbnail'));
-            if (thumbnailKey) {
-                doc._thumbnail = doc.sizes[thumbnailKey];
-            }
-            else {
-                doc._thumbnail = `/medias/${doc.filename}`;
-            }
-        }
-    }
-    doc.url = doc.filename ? `/medias/${doc.filename}` : null;
-    return { ...args, doc };
-});

package/dist/core/collections/upload/hooks/process-file-upload.server.d.ts

@@ -1,20 +0,0 @@
-/**
- * Hook that handles file upload processing and image resizing operations.
- *
- * @description
- * This hook performs the following operations:
- * 1. For new files:
- *    - Saves the uploaded file to storage
- *    - Generates different image sizes if configured
- *    - Updates document with file metadata and image variations
- *
- * 2. For file updates:
- *    - Removes old files from storage
- *    - Processes new file as above
- *
- * 3. For file deletions:
- *    - Removes files from storage
- *    - Cleans up image variations
- *    - Nullifies related document fields
- */
-export declare const processFileUpload: import("../../../operations/hooks/index.server.js").Hook<"upload", "create" | "update", "before">;

package/dist/core/collections/upload/hooks/process-file-upload.server.js

@@ -1,60 +0,0 @@
-import { cleanUpDocumentFile } from '../disk/delete.server.js';
-import { saveFile } from '../disk/save.server.js';
-import { Hooks } from '../../../operations/hooks/index.server.js';
-import { omit } from '../../../../util/object.js';
-import { toCamelCase } from '../../../../util/string.js';
-import { isUploadConfig } from '../util/config.js';
-/**
- * Hook that handles file upload processing and image resizing operations.
- *
- * @description
- * This hook performs the following operations:
- * 1. For new files:
- *    - Saves the uploaded file to storage
- *    - Generates different image sizes if configured
- *    - Updates document with file metadata and image variations
- *
- * 2. For file updates:
- *    - Removes old files from storage
- *    - Processes new file as above
- *
- * 3. For file deletions:
- *    - Removes files from storage
- *    - Cleans up image variations
- *    - Nullifies related document fields
- */
-export const processFileUpload = Hooks.beforeUpsert(async (args) => {
-    const { operation, config, event } = args;
-    const { rime } = event.locals;
-    if (!isUploadConfig(config))
-        throw new Error('Should never throw');
-    let data = args.data || {};
-    const hasSizeConfig = 'imageSizes' in config.upload && Array.isArray(config.upload.imageSizes);
-    const sizesConfig = hasSizeConfig ? config.upload.imageSizes : [];
-    if (data.file) {
-        if (operation === 'update' && args.context.originalDoc) {
-            await cleanUpDocumentFile({ config, rime, id: args.context.originalDoc.id });
-        }
-        const { filename, imageSizes } = await saveFile(data.file, sizesConfig);
-        data = {
-            ...omit(['file'], data),
-            filename,
-            ...imageSizes
-        };
-    }
-    // If data.file is explicitly set to null : delete file
-    if (data.file === null) {
-        // delete files
-        if (operation === 'update' && args.context.originalDoc) {
-            await cleanUpDocumentFile({ config, rime, id: args.context.originalDoc.id });
-        }
-        // update data for DB update
-        for (const size of sizesConfig) {
-            data = {
-                ...data,
-                [toCamelCase(size.name)]: null
-            };
-        }
-    }
-    return { ...args, data };
-});

package/dist/core/collections/upload/hooks/update-directory-children.server.d.ts

@@ -1,2 +0,0 @@
-export declare const prepareDirectoryChildren: import("../../../operations/hooks/index.server.js").Hook<"directory", "update", "before">;
-export declare const updateDirectoryChildren: import("../../../operations/hooks/index.server.js").Hook<"directory", "update", "after">;

package/dist/core/collections/upload/hooks/update-directory-children.server.js

@@ -1,41 +0,0 @@
-import { RimeError } from '../../../errors/index.js';
-import { Hooks } from '../../../operations/hooks/index.server.js';
-import { trycatch } from '../../../../util/function.js';
-import { eq } from 'drizzle-orm';
-export const prepareDirectoryChildren = Hooks.beforeUpdate(async (args) => {
-    const data = args.data;
-    const { event, config, context } = args;
-    const originalDoc = context.originalDoc;
-    if (!originalDoc)
-        throw new RimeError(RimeError.OPERATION_ERROR, 'missing originalDoc @prepareDirectoryChildren');
-    const db = event.locals.rime.adapter.db;
-    if (data.id) {
-        const table = event.locals.rime.adapter.getTable(config.slug);
-        //@ts-ignore
-        const children = await db.query[config.slug].findMany({
-            where: eq(table.parent, `${originalDoc.id}`)
-        });
-        const updates = children.map((childDir) => {
-            return {
-                id: childDir.id,
-                data: {
-                    id: `${childDir.parent.replace(originalDoc.id, data.id)}:${childDir.name}`
-                }
-            };
-        });
-        args.context.directoriesUpdates = updates;
-    }
-    return args;
-});
-export const updateDirectoryChildren = Hooks.afterUpdate(async (args) => {
-    const { event, config } = args;
-    const collection = event.locals.rime.collection(config.slug);
-    const updates = args.context.directoriesUpdates || [];
-    for (const update of updates) {
-        const [error] = await trycatch(() => collection.updateById(update));
-        if (error) {
-            throw new RimeError(RimeError.OPERATION_ERROR, 'Error when updating child directories');
-        }
-    }
-    return args;
-});

package/dist/core/collections/upload/upload.d.ts

@@ -1,16 +0,0 @@
-import type { GenericDoc } from '../../../types.js';
-import type { UploadPath } from './util/path.js';
-
-export type JsonFile = {
-  base64: string;
-  filename?: string;
-  mimeType?: string;
-  filesize?: number;
-  lastModified?: number;
-};
-
-export type Directory = GenericDoc & {
-  id: UploadPath;
-  name: string;
-  parent: UploadPath | null;
-};

package/dist/core/collections/upload/util/config.d.ts

@@ -1,16 +0,0 @@
-import type { UploadConfig } from '../../../config/types.js';
-export type WithUpload<T extends {
-    upload?: boolean | UploadConfig;
-}> = T & {
-    upload: UploadConfig;
-};
-/**
- * Type guard to check if a configuration has upload capabilities
- * @example
- * if (isUploadConfig(collection)) {
- *   // Handle upload-specific functionality
- * }
- */
-export declare function isUploadConfig<C extends {
-    upload?: UploadConfig;
-}>(config: C): config is WithUpload<C>;

package/dist/core/collections/upload/util/converter.server.d.ts

@@ -1,16 +0,0 @@
-import type { JsonFile } from '../upload.js';
-export declare const jsonFileToFile: (jsonFile: JsonFile) => {
-    filename: string;
-    mimeType: string;
-    filesize: string;
-    file: File;
-};
-export declare function filePathToBase64(filePath: string): Promise<string>;
-/**
- * Convert a filepath to a File like object
- * @param filePath - Absolute path to the file
- * @returns A File-like object with necessary properties and methods
- * @example
- * const file = await filePathToFile('/path/to/image.jpg');
- */
-export declare function filePathToFile(filePath: string): Promise<File>;