refactor: update images manager

Author: spartan-vutrannguyen

apps/studio/electron/main/assets/images.ts

@@ -3,38 +3,87 @@ import { DefaultSettings } from '@onlook/models/constants';
 import { promises as fs, readFileSync } from 'fs';
 import mime from 'mime-lite';
 import path from 'path';
+import { detectRouterType } from '../pages';
+
+const SUPPORTED_IMAGE_EXTENSIONS = ['.jpg', '.jpeg', '.png', '.gif', '.webp', '.svg', '.ico'];
+const MAX_FILENAME_LENGTH = 255;
+const VALID_FILENAME_REGEX = /^[a-zA-Z0-9-_. ]+$/;
+
+async function getImageFolderPath(projectRoot: string, folder?: string): Promise<string> {
+    if (folder) {
+        return path.join(projectRoot, folder);
+    }
+
+    const routerType = await detectRouterType(projectRoot);
+    return routerType?.basePath
+        ? routerType.basePath
+        : path.join(projectRoot, DefaultSettings.IMAGE_FOLDER);
+}
+
+// Helper function to validate and process image file
+function processImageFile(filePath: string, folder: string): ImageContentData {
+    const image = readFileSync(filePath, { encoding: 'base64' });
+    const mimeType = mime.getType(filePath) || 'application/octet-stream';
+
+    return {
+        fileName: path.basename(filePath),
+        content: `data:${mimeType};base64,${image}`,
+        mimeType,
+        folder,
+    };
+}
 
 async function scanImagesDirectory(projectRoot: string): Promise<ImageContentData[]> {
-    const imagesPath = path.join(projectRoot, DefaultSettings.IMAGE_FOLDER);
     const images: ImageContentData[] = [];
 
+    const publicImagesPath = path.join(projectRoot, DefaultSettings.IMAGE_FOLDER);
     try {
-        const entries = await fs.readdir(imagesPath, { withFileTypes: true });
-
-        for (const entry of entries) {
-            if (entry.isFile()) {
-                const extension = path.extname(entry.name).toLowerCase();
-                // Common image extensions
-                if (
-                    ['.jpg', '.jpeg', '.png', '.gif', '.webp', '.svg', '.ico'].includes(extension)
-                ) {
-                    const imagePath = path.join(imagesPath, entry.name);
-                    const image = readFileSync(imagePath, { encoding: 'base64' });
-                    const mimeType = mime.getType(imagePath) || 'application/octet-stream';
-                    images.push({
-                        fileName: entry.name,
-                        content: `data:${mimeType};base64,${image}`,
-                        mimeType,
-                    });
-                }
+        const publicEntries = await fs.readdir(publicImagesPath, { withFileTypes: true });
+        for (const entry of publicEntries) {
+            if (
+                entry.isFile() &&
+                SUPPORTED_IMAGE_EXTENSIONS.includes(path.extname(entry.name).toLowerCase())
+            ) {
+                const imagePath = path.join(publicImagesPath, entry.name);
+                images.push(processImageFile(imagePath, DefaultSettings.IMAGE_FOLDER));
             }
         }
+    } catch (error) {
+        console.error('Error scanning public images directory:', error);
+    }
 
-        return images;
+    // Scan app directory images
+    const appDir = path.join(projectRoot, 'app');
+    try {
+        const appImages = await findImagesInDirectory(appDir);
+        for (const imagePath of appImages) {
+            images.push(processImageFile(imagePath, 'app'));
+        }
     } catch (error) {
-        console.error('Error scanning images directory:', error);
-        return [];
+        console.error('Error scanning app directory images:', error);
     }
+
+    return images;
+}
+
+async function findImagesInDirectory(dirPath: string): Promise<string[]> {
+    const imageFiles: string[] = [];
+    const entries = await fs.readdir(dirPath, { withFileTypes: true });
+
+    for (const entry of entries) {
+        const fullPath = path.join(dirPath, entry.name);
+
+        if (entry.isDirectory() && !entry.name.startsWith('.') && entry.name !== 'node_modules') {
+            imageFiles.push(...(await findImagesInDirectory(fullPath)));
+        } else if (
+            entry.isFile() &&
+            SUPPORTED_IMAGE_EXTENSIONS.includes(path.extname(entry.name).toLowerCase())
+        ) {
+            imageFiles.push(fullPath);
+        }
+    }
+
+    return imageFiles;
 }
 
 export async function scanNextJsImages(projectRoot: string): Promise<ImageContentData[]> {
@@ -72,16 +121,15 @@ async function getUniqueFileName(imageFolder: string, fileName: string): Promise
 }
 
 export async function saveImageToProject(
-    projectFolder: string,
-    content: string,
-    fileName: string,
+    projectRoot: string,
+    image: ImageContentData,
 ): Promise<string> {
     try {
-        const imageFolder = path.join(projectFolder, DefaultSettings.IMAGE_FOLDER);
-        const uniqueFileName = await getUniqueFileName(imageFolder, fileName);
+        const imageFolder = await getImageFolderPath(projectRoot, image.folder);
+        const uniqueFileName = await getUniqueFileName(imageFolder, image.fileName);
         const imagePath = path.join(imageFolder, uniqueFileName);
 
-        const buffer = Buffer.from(content, 'base64');
+        const buffer = Buffer.from(image.content, 'base64');
         await fs.writeFile(imagePath, buffer);
         return imagePath;
     } catch (error) {
@@ -92,11 +140,11 @@ export async function saveImageToProject(
 
 export async function deleteImageFromProject(
     projectRoot: string,
-    imageName: string,
+    image: ImageContentData,
 ): Promise<string> {
     try {
-        const imageFolder = path.join(projectRoot, DefaultSettings.IMAGE_FOLDER);
-        const imagePath = path.join(imageFolder, imageName);
+        const imageFolder = await getImageFolderPath(projectRoot, image.folder);
+        const imagePath = path.join(imageFolder, image.fileName);
         await fs.unlink(imagePath);
         return imagePath;
     } catch (error) {
@@ -107,32 +155,28 @@ export async function deleteImageFromProject(
 
 export async function renameImageInProject(
     projectRoot: string,
-    imageName: string,
+    image: ImageContentData,
     newName: string,
 ): Promise<string> {
-    if (!imageName || !newName) {
+    if (!image.fileName || !newName) {
         throw new Error('Image name and new name are required');
     }
 
-    const imageFolder = path.join(projectRoot, DefaultSettings.IMAGE_FOLDER);
-    const oldImagePath = path.join(imageFolder, imageName);
+    const imageFolder = await getImageFolderPath(projectRoot, image.folder);
+    const oldImagePath = path.join(imageFolder, image.fileName);
     const newImagePath = path.join(imageFolder, newName);
 
     try {
         await validateRename(oldImagePath, newImagePath);
         await fs.rename(oldImagePath, newImagePath);
-
-        await updateImageReferences(projectRoot, imageName, newName);
+        await updateImageReferences(projectRoot, image.fileName, newName);
         return newImagePath;
     } catch (error) {
         console.error('Error renaming image:', error);
         throw error;
     }
 }
 
-const MAX_FILENAME_LENGTH = 255;
-const VALID_FILENAME_REGEX = /^[a-zA-Z0-9-_. ]+$/;
-
 async function validateRename(oldImagePath: string, newImagePath: string): Promise<void> {
     try {
         await fs.access(oldImagePath);

apps/studio/electron/main/events/asset.ts

@@ -6,6 +6,7 @@ import {
     deleteImageFromProject,
     renameImageInProject,
 } from '../assets/images';
+import type { ImageContentData } from '@onlook/models/actions';
 
 export function listenForAssetMessages() {
     ipcMain.handle(MainChannels.SCAN_IMAGES_IN_PROJECT, async (_event, projectRoot: string) => {
@@ -19,31 +20,49 @@ export function listenForAssetMessages() {
             _event,
             {
                 projectFolder,
-                content,
-                fileName,
+                image,
             }: {
                 projectFolder: string;
-                content: string;
-                fileName: string;
+                image: ImageContentData;
             },
         ) => {
-            const imagePath = await saveImageToProject(projectFolder, content, fileName);
+            const imagePath = await saveImageToProject(projectFolder, image);
             return imagePath;
         },
     );
 
     ipcMain.handle(
         MainChannels.DELETE_IMAGE_FROM_PROJECT,
-        async (_event, projectRoot: string, imageName: string) => {
-            const imagePath = await deleteImageFromProject(projectRoot, imageName);
+        async (
+            _event,
+            {
+                projectFolder,
+                image,
+            }: {
+                projectFolder: string;
+                image: ImageContentData;
+            },
+        ) => {
+            const imagePath = await deleteImageFromProject(projectFolder, image);
             return imagePath;
         },
     );
 
     ipcMain.handle(
         MainChannels.RENAME_IMAGE_IN_PROJECT,
-        async (_event, projectRoot: string, imageName: string, newName: string) => {
-            const imagePath = await renameImageInProject(projectRoot, imageName, newName);
+        async (
+            _event,
+            {
+                projectFolder,
+                image,
+                newName,
+            }: {
+                projectFolder: string;
+                image: ImageContentData;
+                newName: string;
+            },
+        ) => {
+            const imagePath = await renameImageInProject(projectFolder, image, newName);
             return imagePath;
         },
     );

apps/studio/src/components/Modals/Settings/Site/Favicon.tsx

@@ -108,14 +108,11 @@ export const Favicon = forwardRef<
                 onDragOver={handleDragOver}
                 onDragLeave={handleDragLeave}
                 onDrop={handleDrop}
-                style={{
-                    backgroundImage: selectedImage ? `url(${selectedImage})` : 'none',
-                }}
             >
                 <input
                     ref={fileInputRef}
                     type="file"
-                    accept="image/*"
+                    accept=".ico"
                     className="hidden"
                     id="favicon-upload"
                     onChange={handleFileSelect}

apps/studio/src/components/Modals/Settings/Site/index.tsx

@@ -1,6 +1,8 @@
 import { useEditorEngine, useProjectsManager } from '@/components/Context';
 import { useMetadataForm } from '@/hooks/useMetadataForm';
-import { DefaultSettings, type PageMetadata } from '@onlook/models';
+import { DefaultSettings, type ImageContentData, type PageMetadata } from '@onlook/models';
+import { MainChannels } from '@onlook/models/constants';
+import { invokeMainChannel } from '@/lib/utils';
 import { toast } from '@onlook/ui/use-toast';
 import { observer } from 'mobx-react-lite';
 import { useState } from 'react';
@@ -53,10 +55,44 @@ export const SiteTab = observer(() => {
             }
 
             if (uploadedFavicon) {
-                await editorEngine.image.upload(uploadedFavicon);
-                const faviconPath = `/${DefaultSettings.IMAGE_FOLDER.replace(/^public\//, '')}/${uploadedFavicon.name}`;
+                // Delete old favicon if it exists
+                if (siteSetting?.icons?.icon) {
+                    const oldFavicon = editorEngine.image.assets.find(
+                        (image) => image.fileName === 'favicon.ico',
+                    );
+                    if (oldFavicon) {
+                        try {
+                            await invokeMainChannel(MainChannels.DELETE_IMAGE_FROM_PROJECT, {
+                                projectFolder: project.folderPath,
+                                image: oldFavicon,
+                            });
+                        } catch (error) {
+                            console.warn('Failed to delete old favicon:', error);
+                        }
+                    }
+                }
+
+                const buffer = await uploadedFavicon.arrayBuffer();
+                const base64String = btoa(
+                    new Uint8Array(buffer).reduce(
+                        (data, byte) => data + String.fromCharCode(byte),
+                        '',
+                    ),
+                );
+
+                const image: ImageContentData = {
+                    content: base64String,
+                    fileName: 'favicon.ico',
+                    mimeType: 'image/x-icon',
+                };
+
+                await invokeMainChannel(MainChannels.SAVE_IMAGE_TO_PROJECT, {
+                    projectFolder: project.folderPath,
+                    image,
+                });
+
                 updatedMetadata.icons = {
-                    icon: faviconPath,
+                    icon: '/favicon.ico',
                 };
             }
             if (uploadedImage) {
@@ -86,6 +122,8 @@ export const SiteTab = observer(() => {
             });
 
             await editorEngine.pages.updateMetadataPage('/', updatedMetadata);
+            await editorEngine.image.scanImages();
+
             setUploadedFavicon(null);
             setIsDirty(false);
             toast({