@magentrix-corp/magentrix-cli 1.3.16 → 1.3.17

package/utils/cli/helpers/compare.js

@@ -1,282 +1,282 @@
-import path from 'path';
-import chalk from 'chalk'; // For pretty colors, install with `npm install chalk`
-import { compareLocalAndRemote } from '../../compare.js';
-import inquirer from 'inquirer';
-import { mapRecordToFile } from '../writeRecords.js';
-import { withSpinner } from '../../spinner.js';
-import { meqlQuery } from '../../magentrix/api/meqlQuery.js';
-import readline from 'readline';
-
-/**
- * Logs a formatted, user-friendly status message for a single file, given its sync comparison result.
- *
- * @param {string} relativePath - File path relative to root directory.
- * @param {Object} statusResult - Result object from compareLocalAndRemote.
- * @returns {boolean} True if an issue was found (not 'in_sync' or 'missing'), otherwise false.
- */
-export function logFileStatus(relativePath, statusResult) {
-    const fileDisplay = chalk.bold.blue(relativePath);
-
-    switch (statusResult.status) {
-        case 'in_sync':
-            // Uncomment to show successes:
-            // console.log(chalk.green(`✓ ${fileDisplay} is up to date.`));
-            return false;
-        case 'behind':
-            console.log(
-                chalk.yellow(`⚠️  ${fileDisplay} is OUTDATED:`) +
-                `\n   Local version is older than the server version, but contents are identical.\n` +
-                `   Consider pulling the latest metadata from the server.`
-            );
-            return true;
-        case 'conflict':
-            console.log(
-                chalk.red(`🛑 ${fileDisplay} has a CONFLICT:`) +
-                `\n   Local file is behind the remote, AND both were edited differently.\n` +
-                `   Resolve this conflict before pushing or pulling.`
-            );
-            return true;
-        case 'ahead':
-            console.log(
-                chalk.yellow(`⚠️  ${fileDisplay} is AHEAD:`) +
-                `\n   Local file was modified after the remote version, and contents differ.\n` +
-                `   You may want to push your changes to the server.`
-            );
-            return true;
-        case 'ahead_identical':
-            console.log(
-                chalk.yellow(`⚠️  ${fileDisplay} is AHEAD (identical):`) +
-                `\n   Local file has a newer timestamp, but contents match remote.\n` +
-                `   This could be a system clock drift.`
-            );
-            return true;
-        case 'content_differs':
-            console.log(
-                chalk.red(`🛑 ${fileDisplay} CONTENT MISMATCH:`) +
-                `\n   File timestamps match, but contents differ!\n` +
-                `   This is unusual—please investigate.`
-            );
-            return true;
-        case 'missing':
-            // Not an error, file will be downloaded.
-            // Uncomment if you want to notify about downloads:
-            console.log(
-                chalk.yellow(`⚠️  ${fileDisplay} is MISSING:`) +
-                `\n   Local file has been removed.`
-            );
-
-            // console.log(chalk.cyan(`⬇️  ${fileDisplay} will be downloaded from the server.`));
-            return true;
-        default:
-            console.log(
-                chalk.magenta(`❓  ${fileDisplay} has an unknown status: ${statusResult.status}`)
-            );
-            return true;
-    }
-}
-
-/**
- * Compares all local files in a specified root directory against their remote versions,
- * then logs user-friendly, formatted status messages for any files that are not in sync.
- *
- * - Uses logFileStatus to handle message formatting for each file.
- * - Only logs files that require attention; in-sync files are silent by default.
- * - If no issues are found, logs a celebratory success message.
- * - Intended for CLI status or sync-check commands.
- *
- * @param {string} rootDir
- *        The local root directory where your files are stored (e.g., './export').
- * @param {Array<Object>} fileRecords
- *        Array of remote file descriptors to compare. Each object should include:
- *        - {string} relativePath: File path relative to rootDir (e.g. 'Controllers/Foo.ctrl')
- *        - {string} content: Latest file content from the server
- *        - {string} ModifiedOn: Last modified date/time on server (ISO string)
- *
- * @returns {void}
- *
- * @example
- * const filesFromServer = [
- *   {
- *     relativePath: "Controllers/AccountController.ctrl",
- *     content: "...",
- *     ModifiedOn: "2025-07-10T18:00:00.000Z"
- *   },
- *   // ...
- * ];
- * compareAllFilesAndLogStatus('./export', filesFromServer);
- */
-export function compareAllFilesAndLogStatus(rootDir, fileRecords) {
-    let numIssues = 0;
-
-    console.log();
-
-    for (const record of fileRecords) {
-        const localFilePath = path.join(rootDir, record.relativePath);
-
-        const result = compareLocalAndRemote(localFilePath, {
-            content: record.Content,
-            ...record
-        });
-
-        // Use the single-file logger and aggregate if any issues found
-        const hadIssue = logFileStatus(record.relativePath, result);
-        if (hadIssue) numIssues++;
-    }
-
-    if (numIssues === 0) {
-        console.log(chalk.green.bold('\n🎉 All files are up to date and in sync!\n'));
-    }
-}
-
-/**
- * Checks local vs remote Magentrix file status and warns on conflicts/out-of-sync.
- * If issues are found, blocks execution unless `forceContinue` is true.
- * If not forced, user can press any key to continue, or ESC to abort.
- *
- * @param {string} rootDir
- * @param {string} instanceUrl
- * @param {string} token
- * @param {boolean} [forceContinue=false]
- */
-export async function showCurrentConflicts(rootDir, instanceUrl, token, forceContinue = false) {
-    const queries = [
-        {
-            name: "ActiveClass",
-            query: "SELECT Id,Body,Name,CreatedOn,Description,ModifiedOn,Type FROM ActiveClass",
-            contentField: "Body",
-        },
-        {
-            name: "ActivePage",
-            query: "SELECT Id,Content,Name,CreatedOn,Description,ModifiedOn,Type FROM ActivePage",
-            contentField: "Content",
-        },
-    ];
-
-    console.log(chalk.cyan.bold('🔍 Checking local files vs remote Magentrix...'));
-    console.log(chalk.gray('------------------------------------------------'));
-
-    const [activeClassResult, activePageResult] = await withSpinner(
-        chalk.gray('Retrieving files from server...'),
-        async () => Promise.all(
-            queries.map(q => meqlQuery(instanceUrl, token, q.query))
-        )
-    );
-
-    const activeClassRecords = (activeClassResult.Records || []).map(record => {
-        record.Content = record.Body;
-        delete record.Body;
-        return record;
-    });
-    const activePageRecords = (activePageResult.Records || []);
-    const allRecords = [...activeClassRecords, ...activePageRecords].map(mapRecordToFile);
-
-    let warningCount = 0;
-    console.log();
-
-    for (const record of allRecords) {
-        if (record?.error) {
-            continue;
-        }
-
-        const status = compareLocalAndRemote(
-            path.join(rootDir, record.relativePath),
-            { ...record, content: record.Content }
-        );
-
-        const hasIssue = logFileStatus(record.relativePath, status);
-        if (hasIssue) warningCount++;
-    }
-
-    if (warningCount > 0) {
-        console.log();
-        console.log(
-            chalk.yellow.bold(`⚠️  Conflict${warningCount > 1 ? 's' : ''} detected!`) +
-            chalk.yellow('\n   These are just warnings, but you should resolve them before continuing.')
-        );
-        console.log(
-            chalk.yellow('\n👉 To sync and resolve conflicts, run: ') +
-            chalk.cyan.bold('magentrix pull')
-        );
-        console.log(chalk.gray('------------------------------------------------'));
-
-        if (!forceContinue) {
-            await new Promise((resolve) => {
-                process.stdout.write(
-                    chalk.yellow(
-                        '\nPress any key to continue, or press ESC to abort... '
-                    )
-                );
-
-                // Set raw mode so we capture a single key, including ESC
-                process.stdin.setRawMode(true);
-                process.stdin.resume();
-                process.stdin.once('data', (data) => {
-                    process.stdin.setRawMode(false);
-                    process.stdin.pause();
-                    // ESC key is 27 in Buffer
-                    if (data.length === 1 && data[0] === 27) {
-                        console.log(chalk.red.bold('\nAborted due to unresolved conflicts.\n'));
-                        process.exit(1);
-                    } else {
-                        // Continue
-                        process.stdout.write('\n');
-                        resolve();
-                    }
-                });
-            });
-        }
-    } else {
-        console.log();
-        console.log(chalk.green.bold('🎉 All local files are in sync with the server!'));
-        console.log(chalk.gray('------------------------------------------------'));
-    }
-}
-
-
-
-/**
- * Presents all files with conflicts and prompts the user for a global resolution action.
- *
- * @param {Array<{relativePath: string, status: string}>} fileIssues
- * @returns {Promise<'skip'|'overwrite'|'diff'|'accept_ours'|'accept_theirs'|'manual'>}
- */
-export async function promptConflictResolution(fileIssues) {
-    if (!fileIssues.length) return 'skip';
-
-    // Add spacing instead of clearing (clearing causes flickering with progress tracker)
-    console.log('\n');
-    console.log(chalk.gray('─'.repeat(48)));
-    console.log(
-        chalk.bold.yellow(
-            `${fileIssues.length} file${fileIssues.length > 1 ? 's' : ''} require conflict resolution:\n`
-        )
-    );
-
-    fileIssues.forEach((file, i) => {
-        console.log(
-            chalk.cyan(`${i + 1}.`) +
-            ' ' +
-            chalk.bold(file.relativePath) +
-            chalk.gray(` [${file.status}]`)
-        );
-    });
-
-    console.log();
-
-    // Present actions menu
-    const { action } = await inquirer.prompt([
-        {
-            type: 'list',
-            name: 'action',
-            message: chalk.green('Choose how to resolve these conflicts:'),
-            choices: [
-                { name: 'Replace local files with server versions (discard my changes)', value: 'overwrite' },
-                { name: 'Automatically merge changes (may require manual edits if conflicts remain)', value: 'merge' },
-                { name: 'Review each conflict and choose (see diffs)', value: 'diff' },
-                { name: 'Do nothing for now (skip conflicted files)', value: 'skip' }
-            ]
-        },
-    ]);
-
-    return action;
-}
+import path from 'path';
+import chalk from 'chalk'; // For pretty colors, install with `npm install chalk`
+import { compareLocalAndRemote } from '../../compare.js';
+import inquirer from 'inquirer';
+import { mapRecordToFile } from '../writeRecords.js';
+import { withSpinner } from '../../spinner.js';
+import { meqlQuery } from '../../magentrix/api/meqlQuery.js';
+import readline from 'readline';
+
+/**
+ * Logs a formatted, user-friendly status message for a single file, given its sync comparison result.
+ *
+ * @param {string} relativePath - File path relative to root directory.
+ * @param {Object} statusResult - Result object from compareLocalAndRemote.
+ * @returns {boolean} True if an issue was found (not 'in_sync' or 'missing'), otherwise false.
+ */
+export function logFileStatus(relativePath, statusResult) {
+    const fileDisplay = chalk.bold.blue(relativePath);
+
+    switch (statusResult.status) {
+        case 'in_sync':
+            // Uncomment to show successes:
+            // console.log(chalk.green(`✓ ${fileDisplay} is up to date.`));
+            return false;
+        case 'behind':
+            console.log(
+                chalk.yellow(`⚠️  ${fileDisplay} is OUTDATED:`) +
+                `\n   Local version is older than the server version, but contents are identical.\n` +
+                `   Consider pulling the latest metadata from the server.`
+            );
+            return true;
+        case 'conflict':
+            console.log(
+                chalk.red(`🛑 ${fileDisplay} has a CONFLICT:`) +
+                `\n   Local file is behind the remote, AND both were edited differently.\n` +
+                `   Resolve this conflict before pushing or pulling.`
+            );
+            return true;
+        case 'ahead':
+            console.log(
+                chalk.yellow(`⚠️  ${fileDisplay} is AHEAD:`) +
+                `\n   Local file was modified after the remote version, and contents differ.\n` +
+                `   You may want to push your changes to the server.`
+            );
+            return true;
+        case 'ahead_identical':
+            console.log(
+                chalk.yellow(`⚠️  ${fileDisplay} is AHEAD (identical):`) +
+                `\n   Local file has a newer timestamp, but contents match remote.\n` +
+                `   This could be a system clock drift.`
+            );
+            return true;
+        case 'content_differs':
+            console.log(
+                chalk.red(`🛑 ${fileDisplay} CONTENT MISMATCH:`) +
+                `\n   File timestamps match, but contents differ!\n` +
+                `   This is unusual—please investigate.`
+            );
+            return true;
+        case 'missing':
+            // Not an error, file will be downloaded.
+            // Uncomment if you want to notify about downloads:
+            console.log(
+                chalk.yellow(`⚠️  ${fileDisplay} is MISSING:`) +
+                `\n   Local file has been removed.`
+            );
+
+            // console.log(chalk.cyan(`⬇️  ${fileDisplay} will be downloaded from the server.`));
+            return true;
+        default:
+            console.log(
+                chalk.magenta(`❓  ${fileDisplay} has an unknown status: ${statusResult.status}`)
+            );
+            return true;
+    }
+}
+
+/**
+ * Compares all local files in a specified root directory against their remote versions,
+ * then logs user-friendly, formatted status messages for any files that are not in sync.
+ *
+ * - Uses logFileStatus to handle message formatting for each file.
+ * - Only logs files that require attention; in-sync files are silent by default.
+ * - If no issues are found, logs a celebratory success message.
+ * - Intended for CLI status or sync-check commands.
+ *
+ * @param {string} rootDir
+ *        The local root directory where your files are stored (e.g., './export').
+ * @param {Array<Object>} fileRecords
+ *        Array of remote file descriptors to compare. Each object should include:
+ *        - {string} relativePath: File path relative to rootDir (e.g. 'Controllers/Foo.ctrl')
+ *        - {string} content: Latest file content from the server
+ *        - {string} ModifiedOn: Last modified date/time on server (ISO string)
+ *
+ * @returns {void}
+ *
+ * @example
+ * const filesFromServer = [
+ *   {
+ *     relativePath: "Controllers/AccountController.ctrl",
+ *     content: "...",
+ *     ModifiedOn: "2025-07-10T18:00:00.000Z"
+ *   },
+ *   // ...
+ * ];
+ * compareAllFilesAndLogStatus('./export', filesFromServer);
+ */
+export function compareAllFilesAndLogStatus(rootDir, fileRecords) {
+    let numIssues = 0;
+
+    console.log();
+
+    for (const record of fileRecords) {
+        const localFilePath = path.join(rootDir, record.relativePath);
+
+        const result = compareLocalAndRemote(localFilePath, {
+            content: record.Content,
+            ...record
+        });
+
+        // Use the single-file logger and aggregate if any issues found
+        const hadIssue = logFileStatus(record.relativePath, result);
+        if (hadIssue) numIssues++;
+    }
+
+    if (numIssues === 0) {
+        console.log(chalk.green.bold('\n🎉 All files are up to date and in sync!\n'));
+    }
+}
+
+/**
+ * Checks local vs remote Magentrix file status and warns on conflicts/out-of-sync.
+ * If issues are found, blocks execution unless `forceContinue` is true.
+ * If not forced, user can press any key to continue, or ESC to abort.
+ *
+ * @param {string} rootDir
+ * @param {string} instanceUrl
+ * @param {string} token
+ * @param {boolean} [forceContinue=false]
+ */
+export async function showCurrentConflicts(rootDir, instanceUrl, token, forceContinue = false) {
+    const queries = [
+        {
+            name: "ActiveClass",
+            query: "SELECT Id,Body,Name,CreatedOn,Description,ModifiedOn,Type FROM ActiveClass",
+            contentField: "Body",
+        },
+        {
+            name: "ActivePage",
+            query: "SELECT Id,Content,Name,CreatedOn,Description,ModifiedOn,Type FROM ActivePage",
+            contentField: "Content",
+        },
+    ];
+
+    console.log(chalk.cyan.bold('🔍 Checking local files vs remote Magentrix...'));
+    console.log(chalk.gray('------------------------------------------------'));
+
+    const [activeClassResult, activePageResult] = await withSpinner(
+        chalk.gray('Retrieving files from server...'),
+        async () => Promise.all(
+            queries.map(q => meqlQuery(instanceUrl, token, q.query))
+        )
+    );
+
+    const activeClassRecords = (activeClassResult.Records || []).map(record => {
+        record.Content = record.Body;
+        delete record.Body;
+        return record;
+    });
+    const activePageRecords = (activePageResult.Records || []);
+    const allRecords = [...activeClassRecords, ...activePageRecords].map(mapRecordToFile);
+
+    let warningCount = 0;
+    console.log();
+
+    for (const record of allRecords) {
+        if (record?.error) {
+            continue;
+        }
+
+        const status = compareLocalAndRemote(
+            path.join(rootDir, record.relativePath),
+            { ...record, content: record.Content }
+        );
+
+        const hasIssue = logFileStatus(record.relativePath, status);
+        if (hasIssue) warningCount++;
+    }
+
+    if (warningCount > 0) {
+        console.log();
+        console.log(
+            chalk.yellow.bold(`⚠️  Conflict${warningCount > 1 ? 's' : ''} detected!`) +
+            chalk.yellow('\n   These are just warnings, but you should resolve them before continuing.')
+        );
+        console.log(
+            chalk.yellow('\n👉 To sync and resolve conflicts, run: ') +
+            chalk.cyan.bold('magentrix pull')
+        );
+        console.log(chalk.gray('------------------------------------------------'));
+
+        if (!forceContinue) {
+            await new Promise((resolve) => {
+                process.stdout.write(
+                    chalk.yellow(
+                        '\nPress any key to continue, or press ESC to abort... '
+                    )
+                );
+
+                // Set raw mode so we capture a single key, including ESC
+                process.stdin.setRawMode(true);
+                process.stdin.resume();
+                process.stdin.once('data', (data) => {
+                    process.stdin.setRawMode(false);
+                    process.stdin.pause();
+                    // ESC key is 27 in Buffer
+                    if (data.length === 1 && data[0] === 27) {
+                        console.log(chalk.red.bold('\nAborted due to unresolved conflicts.\n'));
+                        process.exit(1);
+                    } else {
+                        // Continue
+                        process.stdout.write('\n');
+                        resolve();
+                    }
+                });
+            });
+        }
+    } else {
+        console.log();
+        console.log(chalk.green.bold('🎉 All local files are in sync with the server!'));
+        console.log(chalk.gray('------------------------------------------------'));
+    }
+}
+
+
+
+/**
+ * Presents all files with conflicts and prompts the user for a global resolution action.
+ *
+ * @param {Array<{relativePath: string, status: string}>} fileIssues
+ * @returns {Promise<'skip'|'overwrite'|'diff'|'accept_ours'|'accept_theirs'|'manual'>}
+ */
+export async function promptConflictResolution(fileIssues) {
+    if (!fileIssues.length) return 'skip';
+
+    // Add spacing instead of clearing (clearing causes flickering with progress tracker)
+    console.log('\n');
+    console.log(chalk.gray('─'.repeat(48)));
+    console.log(
+        chalk.bold.yellow(
+            `${fileIssues.length} file${fileIssues.length > 1 ? 's' : ''} require conflict resolution:\n`
+        )
+    );
+
+    fileIssues.forEach((file, i) => {
+        console.log(
+            chalk.cyan(`${i + 1}.`) +
+            ' ' +
+            chalk.bold(file.relativePath) +
+            chalk.gray(` [${file.status}]`)
+        );
+    });
+
+    console.log();
+
+    // Present actions menu
+    const { action } = await inquirer.prompt([
+        {
+            type: 'list',
+            name: 'action',
+            message: chalk.green('Choose how to resolve these conflicts:'),
+            choices: [
+                { name: 'Replace local files with server versions (discard my changes)', value: 'overwrite' },
+                { name: 'Automatically merge changes (may require manual edits if conflicts remain)', value: 'merge' },
+                { name: 'Review each conflict and choose (see diffs)', value: 'diff' },
+                { name: 'Do nothing for now (skip conflicted files)', value: 'skip' }
+            ]
+        },
+    ]);
+
+    return action;
+}