@payloadcms/figma 0.0.1-alpha.8 → 0.1.0-alpha.0

package/dist/utils/payload-config-modifier.js

@@ -1,21 +1,22 @@
 import pc from 'picocolors';
-import { Project } from 'ts-morph';
+import { IndentationText, Project } from 'ts-morph';
 import { formatFile } from './formatter.js';
 import * as log from './log.js';
+import { getAddCommand, getRunCommand } from './package-manager.js';
 import { addFigmaProperty, applyModifications, detectRequiredChanges } from './payload-config-ast.js';
 import { findPayloadConfig } from './payload-config-finder.js';
-import { checkPackageInstalled, installPackage, uninstallPackage } from './payload-package-check.js';
+import { checkPackageInstalled, getPayloadVersion, installPackages, uninstallPackages } from './payload-package-check.js';
 import { runTypeScriptCheck } from './typescript-validator.js';
+import { getOwnVersion } from './version-check.js';
 /**
  * Main orchestrator for payload config modification
  * Checks package, detects needed changes, applies modifications
  */ export async function ensurePayloadFigmaConfig(projectPath, packageManager, figmaConfig) {
     const changes = [];
     const warnings = [];
-    let modified = false;
+    let astModified = false;
     try {
         log.debug(`Starting payload config modification for: ${projectPath}`);
-        // 1. Find config file
         const configPath = await findPayloadConfig(projectPath);
         if (!configPath) {
             log.debug(`Config file not found in: ${projectPath}`);
@@ -27,44 +28,28 @@ import { runTypeScriptCheck } from './typescript-validator.js';
             };
         }
         log.debug(`Found config file: ${configPath}`);
-        // 2. Check/install @payloadcms/figma package
-        const isInstalled = await checkPackageInstalled(projectPath, '@payloadcms/figma');
-        if (!isInstalled) {
-            log.debug('@payloadcms/figma not installed, attempting installation...');
-            try {
-                await installPackage(projectPath, '@payloadcms/figma', packageManager);
-                changes.push('Installed @payloadcms/figma');
-                modified = true;
-                log.debug('@payloadcms/figma installed successfully');
-            } catch (error) {
-                log.debug(`Failed to install @payloadcms/figma: ${error instanceof Error ? error.message : 'Unknown error'}`);
-                return {
-                    changes: [],
-                    error: 'Failed to install @payloadcms/figma',
-                    modified: false,
-                    success: false
-                };
-            }
-        } else {
-            log.debug('@payloadcms/figma already installed');
-        }
-        // 3. Parse config with ts-morph
+        // Pin @payloadcms/* packages to the project's payload version when possible.
+        const payloadVersion = await getPayloadVersion(projectPath);
+        log.debug(`Detected payload version: ${payloadVersion || 'unknown'}`);
+        // Parse first so a malformed config fails fast before we touch node_modules.
         log.debug('Parsing config file with ts-morph...');
         const project = new Project({
+            manipulationSettings: {
+                indentationText: IndentationText.TwoSpaces,
+                useTrailingCommas: true
+            },
             skipAddingFilesFromTsConfig: true
         });
         const sourceFile = project.addSourceFileAtPath(configPath);
-        // 4. Detect required changes
         log.debug('Detecting required changes...');
         const detection = detectRequiredChanges(sourceFile);
         log.debug(`Detection results: needsImportChange=${detection.needsImportChange}, hasAlias=${detection.hasAlias}, hasBuildConfig=${detection.hasBuildConfig}`);
-        // Handle failure modes
         if (detection.hasAlias) {
             log.debug('Config uses import alias (e.g., buildConfig as X)');
             return {
                 changes,
                 error: 'Config uses import alias - manual modification required',
-                modified,
+                modified: false,
                 success: false
             };
         }
@@ -73,25 +58,95 @@ import { runTypeScriptCheck } from './typescript-validator.js';
             return {
                 changes,
                 error: 'Config structure not recognized (no buildConfig call found)',
-                modified,
+                modified: false,
                 success: false
             };
         }
-        // 5. Apply modifications
+        // Compute the full install/uninstall diff up front so each can run as a
+        // single package-manager call. npm leaves node_modules transient between
+        // back-to-back calls, which causes generate:importmap to silently miss
+        // subpath components — batching avoids that intermediate state.
+        const packagesToInstall = [];
+        const packagesToUninstall = [];
+        const figmaInstalled = await checkPackageInstalled(projectPath, '@payloadcms/figma');
+        if (!figmaInstalled) {
+            const figmaVersion = await getOwnVersion();
+            packagesToInstall.push({
+                name: '@payloadcms/figma',
+                changeMessage: 'Installed @payloadcms/figma',
+                version: figmaVersion
+            });
+        }
+        const editorIsDefault = !detection.editorProperty || detection.editorProperty.isDefault;
+        if (editorIsDefault) {
+            const hasLexical = await checkPackageInstalled(projectPath, '@payloadcms/richtext-lexical');
+            if (!hasLexical) {
+                packagesToInstall.push({
+                    name: '@payloadcms/richtext-lexical',
+                    changeMessage: 'Installed @payloadcms/richtext-lexical (default editor)',
+                    version: payloadVersion
+                });
+            }
+        } else {
+            log.debug(`Custom editor detected (${detection.editorProperty?.importSource}) - skipping lexical installation`);
+        }
+        const hasCloudStorage = await checkPackageInstalled(projectPath, '@payloadcms/plugin-cloud-storage');
+        if (!hasCloudStorage) {
+            packagesToInstall.push({
+                name: '@payloadcms/plugin-cloud-storage',
+                changeMessage: 'Installed @payloadcms/plugin-cloud-storage',
+                version: payloadVersion
+            });
+        }
+        if (detection.dbProperty) {
+            packagesToUninstall.push(detection.dbProperty.importSource);
+        }
+        if (detection.sharpProperty) {
+            packagesToUninstall.push('sharp');
+        }
+        if (packagesToInstall.length > 0) {
+            log.debug(`Installing ${packagesToInstall.length} packages in a single operation: ${packagesToInstall.map((p)=>p.name).join(', ')}`);
+            try {
+                await installPackages(projectPath, packagesToInstall.map(({ name, version })=>({
+                        name,
+                        version
+                    })), packageManager);
+                for (const { changeMessage } of packagesToInstall){
+                    changes.push(changeMessage);
+                }
+            } catch (error) {
+                const errorMessage = error instanceof Error ? error.message : 'Unknown error';
+                log.debug(`Batched install failed: ${errorMessage}`);
+                const figmaInBatch = packagesToInstall.some((p)=>p.name === '@payloadcms/figma');
+                if (figmaInBatch) {
+                    // Without @payloadcms/figma the rewritten config would import a
+                    // missing package, so abort before touching the file.
+                    return {
+                        changes: [],
+                        error: 'Failed to install @payloadcms/figma',
+                        modified: false,
+                        success: false
+                    };
+                }
+                // Lexical and cloud-storage are non-fatal — payload still loads without
+                // them, so warn (with package names) and continue.
+                const failedNames = packagesToInstall.map((p)=>p.name).join(', ');
+                warnings.push(`Could not install dependencies (${failedNames}) — install them manually. Details: ${errorMessage}`);
+            }
+        }
         log.debug('Applying modifications...');
         const modResult = applyModifications(sourceFile, detection);
         if (modResult.modified) {
             changes.push(...modResult.changes);
-            modified = true;
+            astModified = true;
             log.debug(`Applied ${modResult.changes.length} modifications`);
         }
-        // 6. Add figma property if config provided and doesn't exist
         if (figmaConfig && !detection.figmaObjectExists) {
             log.debug('Adding figma property to buildConfig...');
             const figmaResult = addFigmaProperty(sourceFile, figmaConfig);
             if (figmaResult.modified) {
                 changes.push(...figmaResult.changes);
-                modified = true;
+                astModified = true;
                 log.debug(`Added figma property`);
             } else {
                 log.debug('Figma property not added (may already exist)');
@@ -99,46 +154,39 @@ import { runTypeScriptCheck } from './typescript-validator.js';
         } else if (detection.figmaObjectExists) {
             log.debug('Figma property already exists, skipping');
         }
-        // Save file if any modifications were made
-        if (modified) {
+        if (astModified) {
+            sourceFile.formatText({
+                indentSize: 2,
+                tabSize: 2
+            });
             await sourceFile.save();
             log.debug('Config file saved');
-            // 7. Uninstall orphaned packages
-            const packagesToUninstall = [];
-            if (detection.dbProperty) {
-                packagesToUninstall.push(detection.dbProperty.importSource);
-            }
-            if (detection.editorProperty?.isDefault) {
-                packagesToUninstall.push(detection.editorProperty.importSource);
-            }
-            if (packagesToUninstall.length > 0) {
-                log.debug(`Uninstalling ${packagesToUninstall.length} orphaned packages...`);
-            }
-            for (const pkg of packagesToUninstall){
-                try {
-                    await uninstallPackage(projectPath, pkg, packageManager);
-                    changes.push(`Uninstalled ${pkg}`);
-                    log.debug(`Uninstalled ${pkg}`);
-                } catch (error) {
-                    log.debug(`Failed to uninstall ${pkg}: ${error instanceof Error ? error.message : 'Unknown error'}`);
-                // Don't fail on uninstall errors - orphaned package is better than broken config
-                }
-            }
-            // 8. Format file
             log.debug('Formatting config file...');
             const formatResult = await formatFile(configPath, packageManager);
             if (!formatResult.success && formatResult.warning) {
                 warnings.push(formatResult.warning);
                 log.debug(`Formatting warning: ${formatResult.warning}`);
             }
-            // 9. Run TypeScript validation
             log.debug('Running TypeScript validation...');
             const tsResult = await runTypeScriptCheck(projectPath, packageManager);
             if (!tsResult.success && tsResult.errors.length > 0) {
-                warnings.push("TypeScript validation found issues - run 'pnpm build' for details");
+                warnings.push(`TypeScript validation found issues - run '${getRunCommand(packageManager)} build' for details`);
                 log.debug(`TypeScript validation found ${tsResult.errors.length} issues`);
             }
-        } else {
+        }
+        if (packagesToUninstall.length > 0) {
+            log.debug(`Uninstalling ${packagesToUninstall.length} orphaned packages: ${packagesToUninstall.join(', ')}`);
+            const uninstallResult = await uninstallPackages(projectPath, packagesToUninstall, packageManager);
+            if (uninstallResult.success) {
+                for (const pkg of packagesToUninstall){
+                    changes.push(`Uninstalled ${pkg}`);
+                }
+            } else {
+                warnings.push(`Could not uninstall ${uninstallResult.failedPackages.join(', ')} — they may remain as orphaned dependencies in package.json`);
+            }
+        }
+        const modified = astModified || changes.length > 0;
+        if (!modified) {
             log.debug('No modifications needed - config already correct');
         }
         log.debug('Payload config modification completed successfully');
@@ -156,17 +204,17 @@ import { runTypeScriptCheck } from './typescript-validator.js';
         return {
             changes,
             error: error instanceof Error ? error.message : 'Unknown error occurred',
-            modified,
+            modified: astModified,
             success: false
         };
     }
 }
 /**
  * Display manual configuration instructions
- */ export function displayManualInstructions(reason) {
+ */ export function displayManualInstructions(reason, packageManager = 'npm') {
     const leftLineWrap = (message)=>{
         // Add '┌  ' prefix to first line, '│  ' to subsequent lines, and '└  ' to last line
-        return message.split('\n').map((line, index, arr)=>{
+        return message.split(/\r?\n/).map((line, index, arr)=>{
             if (index === 0) {
                 return `${pc.dim('┌  ')}${line}`;
             } else if (index === arr.length - 1) {
@@ -185,7 +233,7 @@ ${pc.bold('Required changes:')}
 
 1. Replace buildConfig import:
    ${pc.dim('- FROM: ')}${pc.cyan("import { buildConfig } from 'payload'")}
-   ${pc.dim('- TO:   ')}${pc.cyan("import { buildConfig } from '@payloadcms/figma'")}
+   ${pc.dim('- TO:   ')}${pc.cyan("import { buildFigmaConfig } from '@payloadcms/figma'")}
 
 2. Remove these properties from buildConfig():
    • db
@@ -193,11 +241,9 @@ ${pc.bold('Required changes:')}
    • editor (if using default lexicalEditor())
 
 3. Install package:
-   ${pc.cyan('pnpm add @payloadcms/figma')}
+   ${pc.cyan(`${getAddCommand(packageManager)} @payloadcms/figma`)}
 
 Then run: ${pc.cyan('npx @payloadcms/figma init')}`);
     // eslint-disable-next-line no-console
     console.log(message);
 }
-
-//# sourceMappingURL=payload-config-modifier.js.map

package/dist/utils/payload-package-check.d.ts

@@ -1,15 +1,40 @@
 import type { PackageManager } from './package-manager.js';
+export type PackageSpec = {
+    name: string;
+    version?: string;
+};
+export type UninstallResult = {
+    failedPackages: string[];
+    success: boolean;
+};
 /**
  * Check if a package is installed in dependencies (not devDependencies)
  */
 export declare function checkPackageInstalled(projectPath: string, packageName: string): Promise<boolean>;
+/**
+ * Get the payload version from project's package.json (without range specifiers)
+ * Returns the clean version number (e.g., "3.71.1") or undefined if not found
+ */
+export declare function getPayloadVersion(projectPath: string): Promise<string | undefined>;
 /**
  * Install a package as a production dependency
+ * @param version - Version to install (without caret). Defaults to 'latest'.
+ */
+export declare function installPackage(projectPath: string, packageName: string, packageManager: PackageManager, version?: string): Promise<void>;
+/**
+ * Install multiple packages as production dependencies in a single package-manager call.
+ * No-op when packages is empty. Throws on failure with exit code and truncated stderr.
  */
-export declare function installPackage(projectPath: string, packageName: string, packageManager: PackageManager): Promise<void>;
+export declare function installPackages(projectPath: string, packages: PackageSpec[], packageManager: PackageManager): Promise<void>;
 /**
  * Uninstall a package
  * Does not throw on failure - orphaned package is better than broken config
  */
-export declare function uninstallPackage(projectPath: string, packageName: string, packageManager: PackageManager): Promise<void>;
-//# sourceMappingURL=payload-package-check.d.ts.map
+export declare function uninstallPackage(projectPath: string, packageName: string, packageManager: PackageManager): Promise<UninstallResult>;
+/**
+ * Uninstall multiple packages in a single package-manager call.
+ * No-op when packageNames is empty. Does not throw — orphaned packages are
+ * preferable to a crash mid-config-rewrite. Returns a success flag so callers
+ * can avoid claiming "Uninstalled X" when the package manager actually failed.
+ */
+export declare function uninstallPackages(projectPath: string, packageNames: string[], packageManager: PackageManager): Promise<UninstallResult>;

package/dist/utils/payload-package-check.js

@@ -1,4 +1,4 @@
-import { spawn } from 'child_process';
+import spawn from 'cross-spawn';
 import fs from 'fs/promises';
 import path from 'path';
 import * as log from './log.js';
@@ -18,27 +18,58 @@ import * as log from './log.js';
         return false;
     }
 }
+/**
+ * Get the payload version from project's package.json (without range specifiers)
+ * Returns the clean version number (e.g., "3.71.1") or undefined if not found
+ */ export async function getPayloadVersion(projectPath) {
+    try {
+        const pkgJsonPath = path.join(projectPath, 'package.json');
+        const pkgJsonContent = await fs.readFile(pkgJsonPath, 'utf-8');
+        const pkgJson = JSON.parse(pkgJsonContent);
+        const rawVersion = pkgJson.dependencies?.payload || pkgJson.devDependencies?.payload;
+        if (!rawVersion) {
+            return undefined;
+        }
+        // Strip range specifiers (^, ~, >=, etc.) to get clean version
+        return rawVersion.replace(/^[\^~>=<]+/, '');
+    } catch  {
+        return undefined;
+    }
+}
 /**
  * Install a package as a production dependency
- */ export async function installPackage(projectPath, packageName, packageManager) {
+ * @param version - Version to install (without caret). Defaults to 'latest'.
+ */ export async function installPackage(projectPath, packageName, packageManager, version = 'latest') {
+    return installPackages(projectPath, [
+        {
+            name: packageName,
+            version
+        }
+    ], packageManager);
+}
+/**
+ * Install multiple packages as production dependencies in a single package-manager call.
+ * No-op when packages is empty. Throws on failure with exit code and truncated stderr.
+ */ export async function installPackages(projectPath, packages, packageManager) {
+    if (packages.length === 0) {
+        return;
+    }
     return new Promise((resolve, reject)=>{
         const command = packageManager;
+        const packageSpecs = packages.map(({ name, version })=>name.endsWith('.tgz') ? name : `${name}@${version ?? 'latest'}`);
+        const installVerb = packageManager === 'npm' ? 'install' : 'add';
+        // -E pins exact version
         const args = [
-            'add',
-            packageName
+            installVerb,
+            '-E',
+            ...packageSpecs
         ];
-        // npm uses 'install' instead of 'add'
-        if (packageManager === 'npm') {
-            args[0] = 'install';
-        }
         log.debug(`Running: ${command} ${args.join(' ')} in ${projectPath}`);
         let stderr = '';
         const child = spawn(command, args, {
             cwd: projectPath,
-            shell: true,
             stdio: 'pipe'
         });
-        // Capture stderr for debug logging
         if (child.stderr) {
             child.stderr.on('data', (data)=>{
                 stderr += data.toString();
@@ -50,15 +81,17 @@ import * as log from './log.js';
         });
         child.on('close', (code)=>{
             if (code === 0) {
-                log.debug(`Successfully installed ${packageName}`);
+                log.debug(`Successfully installed ${packageSpecs.join(', ')}`);
                 resolve();
-            } else {
-                log.debug(`Failed to install ${packageName} (exit code: ${code})`);
-                if (stderr) {
-                    log.debug(`stderr: ${stderr}`);
-                }
-                reject(new Error(`Failed to install ${packageName}`));
+                return;
+            }
+            log.debug(`Batched install failed (exit code: ${code})`);
+            if (stderr) {
+                log.debug(`stderr: ${stderr}`);
             }
+            const truncatedStderr = stderr.trim().slice(-500);
+            const detail = truncatedStderr ? `\n${truncatedStderr}` : '';
+            reject(new Error(`Failed to install: ${packageSpecs.join(', ')} (exit code ${code})${detail}`));
         });
     });
 }
@@ -66,32 +99,58 @@ import * as log from './log.js';
  * Uninstall a package
  * Does not throw on failure - orphaned package is better than broken config
  */ export async function uninstallPackage(projectPath, packageName, packageManager) {
+    return uninstallPackages(projectPath, [
+        packageName
+    ], packageManager);
+}
+/**
+ * Uninstall multiple packages in a single package-manager call.
+ * No-op when packageNames is empty. Does not throw — orphaned packages are
+ * preferable to a crash mid-config-rewrite. Returns a success flag so callers
+ * can avoid claiming "Uninstalled X" when the package manager actually failed.
+ */ export async function uninstallPackages(projectPath, packageNames, packageManager) {
+    if (packageNames.length === 0) {
+        return {
+            failedPackages: [],
+            success: true
+        };
+    }
     return new Promise((resolve)=>{
         const command = packageManager;
         const args = [
-            'remove',
-            packageName
+            packageManager === 'npm' ? 'uninstall' : 'remove',
+            ...packageNames
         ];
-        // npm uses 'uninstall' instead of 'remove'
-        if (packageManager === 'npm') {
-            args[0] = 'uninstall';
-        }
         log.debug(`Running: ${command} ${args.join(' ')} in ${projectPath}`);
         const child = spawn(command, args, {
             cwd: projectPath,
-            shell: true,
             stdio: 'pipe'
         });
+        child.on('error', (error)=>{
+            log.debug(`Spawn error for ${command}: ${error.message}`);
+            resolve({
+                failedPackages: [
+                    ...packageNames
+                ],
+                success: false
+            });
+        });
         child.on('close', (code)=>{
             if (code === 0) {
-                log.debug(`Successfully uninstalled ${packageName}`);
-            } else {
-                log.debug(`Failed to uninstall ${packageName} (exit code: ${code}), continuing anyway`);
+                log.debug(`Successfully uninstalled ${packageNames.join(', ')}`);
+                resolve({
+                    failedPackages: [],
+                    success: true
+                });
+                return;
             }
-            // Always resolve, even on error
-            resolve();
+            log.debug(`Batched uninstall failed (exit code: ${code}), continuing anyway`);
+            resolve({
+                failedPackages: [
+                    ...packageNames
+                ],
+                success: false
+            });
         });
     });
 }
-
-//# sourceMappingURL=payload-package-check.js.map

package/dist/utils/project.d.ts

@@ -2,6 +2,8 @@
  * Project detection and scaffolding utilities
  */
 import type { ProjectInfo } from '../types/config.js';
+import type { TemplateSource } from './download-template.js';
+import type { PackageManager } from './package-manager.js';
 /**
  * Detect if current directory has a Payload project
  *
@@ -10,7 +12,7 @@ import type { ProjectInfo } from '../types/config.js';
  */
 export declare function detectPayloadProject(projectPath?: string): Promise<ProjectInfo>;
 /**
- * Validate Payload version (must be 3.x)
+ * Validate Payload version (must be 4.x or newer)
  *
  * @param version - Version string from package.json
  * @returns True if version is valid
@@ -21,8 +23,11 @@ export declare function validatePayloadVersion(version: string): boolean;
  *
  * @param projectPath - Path where to create the project
  * @param projectName - Name for the project
+ * @param packageManager - Package manager to use
+ * @param templateSource - Optional template source override
+ * @param payloadVersion - npm dist-tag or explicit version for core payload packages (default 'canary')
  */
-export declare function scaffoldProject(projectPath: string, projectName: string): Promise<void>;
+export declare function scaffoldProject(projectPath: string, projectName: string, packageManager?: PackageManager, templateSource?: Partial<TemplateSource>, payloadVersion?: string): Promise<void>;
 /**
  * Initialize git repository after all setup is complete
  *
@@ -38,7 +43,7 @@ export declare function initializeGitRepo(projectPath: string): void;
  * @param packageManager - Package manager to use
  * @returns Promise that resolves when installation completes
  */
-export declare function installDependencies(projectPath: string, packageManager?: 'npm' | 'pnpm' | 'yarn'): Promise<void>;
+export declare function installDependencies(projectPath: string, packageManager?: PackageManager): Promise<void>;
 /**
  * Check if required dependencies are installed
  *
@@ -55,4 +60,3 @@ export declare function hasRequiredDependencies(projectPath: string): Promise<bo
  * @returns True if in project directory
  */
 export declare function isInProjectDirectory(projectPath?: string): Promise<boolean>;
-//# sourceMappingURL=project.d.ts.map