@squeditor/squeditor-framework 1.0.1 → 1.0.3

package/scripts/package-customer.js

@@ -16,10 +16,11 @@ try {
     ffmpeg = require(path.join(projectRoot, 'node_modules/fluent-ffmpeg'));
 } catch (e) { }
 
-const customerBuildDir = path.join(projectRoot, 'build-customer-package');
+const customerBuildDir = path.join(projectRoot, config.name || 'customer-package');
 const distDir = path.join(projectRoot, 'dist');
 const srcDir = path.join(projectRoot, 'src');
-const zipName = config.dist.zipName ? config.dist.zipName.replace('.zip', '-customer.zip') : 'customer-package.zip';
+// Derive ZIP name from config.name directly to avoid double-suffix issues
+const zipName = (config.name || 'customer-package') + '.zip';
 const zipPath = path.join(projectRoot, zipName);
 
 const mediaConfig = config.media || {};
@@ -116,40 +117,61 @@ async function walkAndProcessMedia(currentSrc, currentDest, baseDir) {
 async function createCustomerPackage() {
     console.log('[Squeditor] 📦 Assembling Customer Package...');
 
+    if (path.resolve(customerBuildDir) === path.resolve(projectRoot)) {
+        console.error(`[Squeditor] 🚨 CRITICAL ERROR: customerBuildDir resolves to the active project workspace root!`);
+        console.error(`[Squeditor] Aborting immediately to prevent recursive deletion. Please update 'name' in your squeditor.config.js so it does not target the parent folder (e.g., avoid '../folder-name').`);
+        process.exit(1);
+    }
+
     if (fs.existsSync(customerBuildDir)) {
         try {
-            execSync(`rm -rf "${customerBuildDir}"`);
+            fs.rmSync(customerBuildDir, { recursive: true, force: true });
         } catch (e) {
-            console.warn(`   - ⚠️  Warning: Could not fully clean ${customerBuildDir}. You may need to run 'sudo rm -rf' on it manually.`);
+            console.warn(`   - ⚠️  Warning: Could not fully clean ${customerBuildDir}. You may need to remove it manually.`);
         }
     }
     if (fs.existsSync(zipPath)) {
         fs.unlinkSync(zipPath);
     }
 
-    fs.mkdirSync(path.join(customerBuildDir, 'src/assets'), { recursive: true });
+    fs.mkdirSync(path.join(customerBuildDir, 'dist/assets'), { recursive: true });
 
-    console.log('   - Copying compiled HTML to src/');
+    console.log('   - Copying compiled HTML to dist/ and src/');
     const distHtmlFiles = fs.readdirSync(distDir).filter(file => file.endsWith('.html'));
+    fs.mkdirSync(path.join(customerBuildDir, 'src'), { recursive: true });
 
     distHtmlFiles.forEach(file => {
         let htmlContent = fs.readFileSync(path.join(distDir, file), 'utf8');
-        htmlContent = htmlContent.replace(
-            /<link rel="stylesheet" href="assets\/css\/main_css\.css">/g,
-            '<link rel="stylesheet" href="assets/scss/main.scss">'
-        );
-        htmlContent = htmlContent.replace(
-            /<script src="assets\/js\/uikit-components\.js"><\/script>/g,
-            '<script type="module" src="assets/js/uikit-components.js"></script>'
-        );
-        fs.writeFileSync(path.join(customerBuildDir, 'src', file), htmlContent);
+        // dist/ gets production HTML referencing compiled CSS
+        fs.writeFileSync(path.join(customerBuildDir, 'dist', file), htmlContent);
+        // src/ gets dev HTML: rewrite CSS refs to raw SCSS for Vite HMR
+        let devHtml = htmlContent;
+        devHtml = devHtml.replace(/href="assets\/css\/main\.min\.css"/g, 'href="assets/scss/main.scss"');
+        devHtml = devHtml.replace(/href="assets\/css\/tailwind\.css"/g, 'href="assets/css/tailwind.css"');
+        fs.writeFileSync(path.join(customerBuildDir, 'src', file), devHtml);
     });
 
-    console.log('   - Copying necessary assets to src/assets');
+    console.log('   - Copying necessary developer source files to src/assets');
     fs.mkdirSync(path.join(customerBuildDir, 'src/assets/css'), { recursive: true });
+    // Also copy dist production files
+    fs.mkdirSync(path.join(customerBuildDir, 'dist/assets/css'), { recursive: true });
+    
     fs.copyFileSync(path.join(distDir, 'assets/css/tailwind.css'), path.join(customerBuildDir, 'src/assets/css/tailwind.css'));
+    fs.copyFileSync(path.join(distDir, 'assets/css/tailwind.css'), path.join(customerBuildDir, 'dist/assets/css/tailwind.css'));
+    
     if (fs.existsSync(path.join(distDir, 'assets/css/squeditor-icons.css'))) {
         fs.copyFileSync(path.join(distDir, 'assets/css/squeditor-icons.css'), path.join(customerBuildDir, 'src/assets/css/squeditor-icons.css'));
+        fs.copyFileSync(path.join(distDir, 'assets/css/squeditor-icons.css'), path.join(customerBuildDir, 'dist/assets/css/squeditor-icons.css'));
+    }
+    
+    if (fs.existsSync(path.join(distDir, 'assets/css/main.min.css'))) {
+        fs.copyFileSync(path.join(distDir, 'assets/css/main.min.css'), path.join(customerBuildDir, 'dist/assets/css/main.min.css'));
+    }
+
+    // slider.min.css contains the slider library CSS (Splide/Swiper)
+    if (fs.existsSync(path.join(distDir, 'assets/css/slider.min.css'))) {
+        fs.copyFileSync(path.join(distDir, 'assets/css/slider.min.css'), path.join(customerBuildDir, 'src/assets/css/slider.min.css'));
+        fs.copyFileSync(path.join(distDir, 'assets/css/slider.min.css'), path.join(customerBuildDir, 'dist/assets/css/slider.min.css'));
     }
 
     fs.cpSync(path.join(srcDir, 'assets/scss'), path.join(customerBuildDir, 'src/assets/scss'), { recursive: true });
@@ -167,13 +189,19 @@ async function createCustomerPackage() {
     }
 
     fs.mkdirSync(path.join(customerBuildDir, 'src/assets/js'), { recursive: true });
+    fs.mkdirSync(path.join(customerBuildDir, 'dist/assets/js'), { recursive: true });
     fs.copyFileSync(path.join(distDir, 'assets/js/uikit-components.js'), path.join(customerBuildDir, 'src/assets/js/uikit-components.js'));
+    fs.copyFileSync(path.join(distDir, 'assets/js/uikit-components.js'), path.join(customerBuildDir, 'dist/assets/js/uikit-components.js'));
     fs.copyFileSync(path.join(distDir, 'assets/js/main.js'), path.join(customerBuildDir, 'src/assets/js/main.js'));
+    fs.copyFileSync(path.join(distDir, 'assets/js/main.js'), path.join(customerBuildDir, 'dist/assets/js/main.js'));
 
     const staticDistPath = path.join(distDir, 'assets/static');
-    const staticCustomerPath = path.join(customerBuildDir, 'src/assets/static');
+    const staticCustomerSourcePath = path.join(customerBuildDir, 'src/assets/static');
+    const staticCustomerDistPath = path.join(customerBuildDir, 'dist/assets/static');
     if (fs.existsSync(staticDistPath)) {
-        await walkAndProcessMedia(staticDistPath, staticCustomerPath, staticDistPath);
+        await walkAndProcessMedia(staticDistPath, staticCustomerSourcePath, staticDistPath);
+        // Also move these final processed media assets directly from src/ back to dist/
+        fs.cpSync(staticCustomerSourcePath, staticCustomerDistPath, { recursive: true });
     }
 
     console.log('   - Generating lean package.json and vite.config.js');
@@ -256,13 +284,16 @@ ${rollupInputs}            },
     const postcssConfig = `module.exports = {\n  plugins: {\n    tailwindcss: {},\n    autoprefixer: {},\n  },\n}`;
     fs.writeFileSync(path.join(customerBuildDir, 'postcss.config.js'), postcssConfig);
 
-    const readmeContent = `# ${config.name} - Customer Package\n\nThis package contains everything you need to use, customize, and deploy your template.\n\n## Directory Structure\n- \`src/\`: Source HTML files.\n- \`src/assets/\`: Source files for customization (SCSS, JS, Images).\n\n## How to Customize Styles\n1. Install dependencies: \`npm install\`\n2. Run live development server: \`npm run dev\`\n3. Build production assets: \`npm run build\`\n`;
+    const readmeContent = `# ${config.name} - Customer Package\n\nThis package contains everything you need to use, customize, and deploy your template.\n\n## Directory Structure\n- \`src/\`: Developer Source files (\`npm run dev\` needed).\n- \`dist/\`: Production-ready compiled HTML snapshot (Drop into any hosting).\n\n## How to Customize Styles\n1. Install dependencies: \`npm install\`\n2. Run live development server: \`npm run dev\`\n3. Edit styles in \`src/assets/scss/main.scss\`\n4. Build production assets to \`dist/\`: \`npm run build\`\n`;
     fs.writeFileSync(path.join(customerBuildDir, 'README.md'), readmeContent);
 
+    // Format customer HTML files with Prettier (fallback in case snapshot.js Prettier was skipped)
     try {
         console.log('   - Formatting customer HTML files with Prettier...');
-        execSync('npx prettier --write "src/**/*.html" --print-width 10000 --tab-width 4', { cwd: customerBuildDir, stdio: 'ignore' });
-    } catch (e) { }
+        execSync('npx prettier --write "src/**/*.html" "dist/**/*.html" --print-width 10000 --tab-width 4', { cwd: customerBuildDir, stdio: 'ignore' });
+    } catch (e) {
+        console.warn('   - ⚠️  Prettier formatting skipped.');
+    }
 
     console.log(`[Squeditor] 📦 Zipping Customer Package to ${zipName}...`);
     try {

package/scripts/package-dist.js

@@ -20,7 +20,7 @@ try {
     // Explicitly clean up any .DS_Store files that might have been created by the OS
     execSync(`find "${distDir}" -name ".DS_Store" -delete`, { stdio: 'inherit' });
     execSync(`cd "${distDir}" && zip -r -9 "${zipPath}" . -x "*.DS_Store" -x "*/.DS_Store"`, { stdio: 'inherit' });
-    console.log(`[Squeditor] ✅ Customer Ready: ${zipName}`);
+    console.log(`[Squeditor] ✅ Dist ZIP Ready: ${zipName}`);
 } catch (e) {
     console.error(`[Squeditor] ❌ Failed to create ZIP archive using system zip.`, e);
 }

package/scripts/scaffold.js

@@ -26,17 +26,17 @@ if (fs.existsSync(targetDir)) {
     process.exit(1);
 }
 
-function copyDirectory(src, dest) {
+function copyDirectory(src, dest, ignoreList = []) {
     fs.mkdirSync(dest, { recursive: true });
     const entries = fs.readdirSync(src, { withFileTypes: true });
 
     for (const entry of entries) {
-        if (entry.name === '.DS_Store') continue;
+        if (entry.name === '.DS_Store' || ignoreList.includes(entry.name)) continue;
         const srcPath = path.join(src, entry.name);
         const destPath = path.join(dest, entry.name);
 
         if (entry.isDirectory()) {
-            copyDirectory(srcPath, destPath);
+            copyDirectory(srcPath, destPath, ignoreList);
         } else {
             // Must use copyFileSync to preserve binary data (fonts, images)
             fs.copyFileSync(srcPath, destPath);
@@ -45,6 +45,19 @@ function copyDirectory(src, dest) {
 }
 
 console.log(`[Squeditor] Scaffolding new project: ${projectName}...`);
+
+// 1. Copy the framework core
+const frameworkSourceDir = path.join(__dirname, '..');
+const frameworkTargetDir = path.resolve(process.cwd(), 'squeditor-framework');
+
+if (!fs.existsSync(frameworkTargetDir)) {
+    console.log(`[Squeditor] Installing local framework core at ./squeditor-framework...`);
+    // Pass the name of the target directory to the ignore list to prevent infinite loop
+    const ignoreCoreList = ['project-template', 'showcase', 'node_modules', '.git', '.github', 'squeditor-framework'];
+    copyDirectory(frameworkSourceDir, frameworkTargetDir, ignoreCoreList);
+}
+
+// 2. Copy the project template
 copyDirectory(sourceDir, targetDir);
 
 // Update package.json name
@@ -59,8 +72,8 @@ if (fs.existsSync(pkgJsonPath)) {
 const configPath = path.join(targetDir, 'squeditor.config.js');
 if (fs.existsSync(configPath)) {
     let configContent = fs.readFileSync(configPath, 'utf8');
-    configContent = configContent.replace(/name:\s*['"][^'"]+['"]/, `name: '${projectName}'`);
-    configContent = configContent.replace(/zipName:\s*['"][^'"]+['"]/, `zipName: '${projectName}.zip'`);
+    configContent = configContent.replace(/name:\s*['"][^'"]+['"]/, `name: '${projectName}-customer'`);
+    configContent = configContent.replace(/zipName:\s*['"][^'"]+['"]/, `zipName: '${projectName}-customer.zip'`);
     fs.writeFileSync(configPath, configContent);
 }
 

package/scripts/snapshot.js

@@ -1,49 +1,114 @@
 const fs = require('fs');
 const path = require('path');
 const http = require('http');
-const { spawn } = require('child_process');
+const { spawn, execSync } = require('child_process');
 
 const projectRoot = process.cwd();
 const config = require(path.join(projectRoot, 'squeditor.config.js'));
+const resolvePages = require('./utils/resolve-pages');
+const getAvailablePort = require('./get-port');
 
-const { baseUrl, pages, outputDir, rewriteExtension } = config.snapshot;
+const { outputDir, rewriteExtension } = config.snapshot;
 const distDir = path.join(projectRoot, outputDir);
 
-fs.mkdirSync(distDir, { recursive: true });
+// Build a reverse lookup: pagePath -> themeKey
+// This allows snapshot.pages to be the AUTHORITATIVE list while themes are applied per-page
+function buildThemeLookup() {
+    const lookup = {};
+    if (config.themes) {
+        for (const [themeKey, theme] of Object.entries(config.themes)) {
+            const resolvedThemePages = resolvePages(theme.pages || [], projectRoot);
+            for (const p of resolvedThemePages) {
+                lookup[p] = { themeKey, distSubfolder: theme.distSubfolder || '' };
+            }
+        }
+    }
+    return lookup;
+}
 
-// Start PHP built-in server
-const phpServer = spawn('php', [
-    '-S', '127.0.0.1:' + config.devServer.port,
-    '-t', path.join(projectRoot, 'src')
-], {
-    stdio: 'ignore',
-    env: { ...process.env, SQUEDITOR_SNAPSHOT: '1' }
-});
+// Poll the PHP server until it responds (max ~10 seconds)
+function waitForServer(url, maxRetries = 50, interval = 200) {
+    return new Promise((resolve, reject) => {
+        let attempts = 0;
+        const check = () => {
+            http.get(url, (res) => {
+                resolve();
+            }).on('error', () => {
+                attempts++;
+                if (attempts >= maxRetries) {
+                    reject(new Error('PHP server failed to start within timeout'));
+                } else {
+                    setTimeout(check, interval);
+                }
+            });
+        };
+        check();
+    });
+}
+
+async function runSnapshot() {
+    fs.mkdirSync(distDir, { recursive: true });
 
-// Wait for PHP server to start
-setTimeout(async () => {
-    console.log('[Squeditor] 📸 Starting snapshot...');
+    // Use a dynamic port to avoid collisions with a running dev server
+    const snapshotPort = await getAvailablePort(config.devServer.port + 100);
+    const snapshotBaseUrl = `http://127.0.0.1:${snapshotPort}`;
 
-    const themes = config.themes || { default: { pages: config.snapshot.pages, distSubfolder: '' } };
+    // Resolve dev-router path for proper .html and extensionless URL handling
+    const fwRoot = path.resolve(projectRoot, config.framework);
+    const devRouterPath = path.join(fwRoot, 'scripts/dev-router.php');
+
+    // Start PHP built-in server WITH the dev-router
+    const phpServer = spawn('php', [
+        '-S', `127.0.0.1:${snapshotPort}`,
+        '-t', path.join(projectRoot, 'src'),
+        devRouterPath
+    ], {
+        stdio: 'ignore',
+        env: { ...process.env, SQUEDITOR_SNAPSHOT: '1' }
+    });
 
-    for (const [themeKey, theme] of Object.entries(themes)) {
-        const themeDistDir = path.join(distDir, theme.distSubfolder || '');
-        fs.mkdirSync(themeDistDir, { recursive: true });
+    try {
+        // Wait for PHP server to be ready instead of a fixed timeout
+        await waitForServer(snapshotBaseUrl);
 
-        for (const pagePath of theme.pages) {
+        console.log('[Squeditor] 📸 Starting snapshot...');
+
+        // snapshot.pages is the AUTHORITATIVE list of pages to capture
+        const allPages = resolvePages(config.snapshot.pages || ['*'], projectRoot);
+        const themeLookup = buildThemeLookup();
+
+        for (const pagePath of allPages) {
             try {
+                // Determine which theme applies to this page (default if not in any theme)
+                const themeInfo = themeLookup[pagePath] || { themeKey: 'default', distSubfolder: '' };
+                const { themeKey, distSubfolder } = themeInfo;
+
                 console.log(`[Squeditor] Fetching ${pagePath} (Theme: ${themeKey})...`);
-                const urlToFetch = `${baseUrl}${pagePath}?theme=${themeKey}&snapshot=1`;
+
+                // Resolve fetch URI: '/' -> '/index.php'
+                let fetchUri = pagePath;
+                if (fetchUri === '/') fetchUri = '/index.php';
+
+                const normalizedPagePath = fetchUri.startsWith('/') ? fetchUri : `/${fetchUri}`;
+                const urlToFetch = `${snapshotBaseUrl}${normalizedPagePath}?theme=${themeKey}&snapshot=1`;
                 const html = await fetchPage(urlToFetch);
-                const rewrittenHtml = rewriteLinks(html);
 
-                // Remove leading slash for local save path
-                let savePath = pagePath.startsWith('/') ? pagePath.slice(1) : pagePath;
-                if (savePath === '') savePath = 'index.html';
-                if (rewriteExtension && savePath.endsWith('.php')) {
-                    savePath = savePath.replace(/\.php$/, '.html');
+                // Construct save path
+                let savePath = pagePath;
+                if (savePath === '/' || savePath === '') {
+                    savePath = 'index.html';
+                } else {
+                    savePath = savePath.startsWith('/') ? savePath.slice(1) : savePath;
+                    if (rewriteExtension && savePath.endsWith('.php')) {
+                        savePath = savePath.replace(/\.php$/, '.html');
+                    }
                 }
 
+                const themeDistDir = path.join(distDir, distSubfolder);
+                fs.mkdirSync(themeDistDir, { recursive: true });
+
+                const rewrittenHtml = rewriteLinks(html, savePath, distSubfolder);
+
                 const fullPath = path.join(themeDistDir, savePath);
                 fs.mkdirSync(path.dirname(fullPath), { recursive: true });
                 fs.writeFileSync(fullPath, rewrittenHtml);
@@ -51,15 +116,32 @@ setTimeout(async () => {
                 console.error(`[Squeditor] Failed to snapshot ${pagePath}:`, err.message);
             }
         }
+
+        // Format all generated HTML with Prettier
+        try {
+            console.log('[Squeditor] 💅 Formatting dist HTML with Prettier...');
+            execSync(`npx prettier --write "${outputDir}/**/*.html" --print-width 10000 --tab-width 4`, { cwd: projectRoot, stdio: 'ignore' });
+        } catch (e) {
+            console.warn('[Squeditor] ⚠️  Prettier formatting skipped (not installed or errored).');
+        }
+
+        console.log('[Squeditor] 🏁 Snapshot complete.');
+    } finally {
+        phpServer.kill();
     }
+}
 
-    phpServer.kill();
-    console.log('[Squeditor] 🏁 Snapshot complete.');
-}, 1500);
+runSnapshot().catch(err => {
+    console.error('[Squeditor] ❌ Snapshot failed:', err.message);
+    process.exit(1);
+});
 
 function fetchPage(url) {
     return new Promise((resolve, reject) => {
         http.get(url, (res) => {
+            if (res.statusCode < 200 || res.statusCode >= 300) {
+                return reject(new Error(`Status Code: ${res.statusCode} for ${url}`));
+            }
             let data = '';
             res.on('data', chunk => data += chunk);
             res.on('end', () => resolve(data));
@@ -67,8 +149,27 @@ function fetchPage(url) {
     });
 }
 
-function rewriteLinks(html) {
-    if (!rewriteExtension) return html;
-    // Replace .php hrefs with .html
-    return html.replace(/href="([^"]*?)\.php([^"]*?)"/g, 'href="$1.html$2"');
+function rewriteLinks(html, savePath, distSubfolder) {
+    let result = html;
+    
+    // Calculate relative path back to dist root
+    const subfolderDepth = distSubfolder ? distSubfolder.split('/').filter(Boolean).length : 0;
+    const savePathDepth = path.dirname(savePath) === '.' ? 0 : path.dirname(savePath).split('/').length;
+    
+    const totalDepth = subfolderDepth + savePathDepth;
+    const prefix = totalDepth > 0 ? '../'.repeat(totalDepth) : '';
+
+    // Rewrite root-relative and purely relative references to depth-adjusted references
+    result = result.replace(/(href|src)=["']\/?([^"']+)["']/g, (match, attr, targetPath) => {
+        if (targetPath.startsWith('http') || targetPath.startsWith('//') || targetPath.startsWith('#')) {
+            return match;
+        }
+        return `${attr}="${prefix}${targetPath}"`;
+    });
+
+    if (rewriteExtension) {
+        result = result.replace(/href=["']([^"']*?)\.php([^"']*?)["']/g, 'href="$1.html$2"');
+    }
+    
+    return result;
 }

package/scripts/utils/resolve-pages.js

@@ -0,0 +1,47 @@
+const fs = require('fs');
+const path = require('path');
+
+module.exports = function resolvePages(pagesConfig, projectRoot) {
+    if (!pagesConfig || !Array.isArray(pagesConfig)) return [];
+    
+    // Check if any element has a glob (* or !)
+    const hasGlob = pagesConfig.some(p => p.includes('*') || p.startsWith('!'));
+    
+    if (hasGlob) {
+        let micromatch;
+        try {
+            micromatch = require(path.join(projectRoot, 'node_modules/micromatch'));
+        } catch (e) {
+            console.warn('[Squeditor] micromatch not found. Please run npm install.');
+            return [];
+        }
+
+        const srcDir = path.join(projectRoot, 'src');
+        if (!fs.existsSync(srcDir)) return [];
+        
+        // Exclude known non-page PHP files that should never be snapshotted
+        const NON_PAGE_FILES = ['init.php'];
+        const allFiles = fs.readdirSync(srcDir)
+            .filter(f => f.endsWith('.php') && !NON_PAGE_FILES.includes(f));
+        
+        // Micromatch expects naked filenames logically. 
+        // We ensure config patterns like '/' become 'index.php' for matching, 
+        // and remove leading slashes so they match naked filenames natively.
+        const normalizedConfig = pagesConfig.map(p => {
+            if (p === '/') return 'index.php';
+            if (p.startsWith('/')) return p.slice(1);
+            return p;
+        });
+        
+        const matched = micromatch(allFiles, normalizedConfig);
+        
+        // Convert back to URL-style paths that the rest of the application expects
+        return matched.map(f => f === 'index.php' ? '/' : `/${f}`);
+    } else {
+        // Direct explicit list (legacy map support)
+        return pagesConfig.map(p => {
+            if (p === '/') return '/';
+            return p.startsWith('/') ? p : `/${p}`;
+        });
+    }
+};