mage-remote-run 0.16.0 → 0.18.0

package/lib/command-registry.js

@@ -10,6 +10,7 @@ import { registerTaxCommands } from './commands/tax.js';
 import { registerInventoryCommands } from './commands/inventory.js';
 import { registerAdobeIoEventsCommands } from './commands/adobe-io-events.js';
 import { registerWebhooksCommands } from './commands/webhooks.js';
+import { registerPurchaseOrderCartCommands } from './commands/purchase-order-cart.js';
 import { registerConsoleCommand } from './commands/console.js';
 
 export { registerConnectionCommands, registerConsoleCommand };
@@ -29,6 +30,7 @@ export function registerCoreCommands(program) {
 export function registerCloudCommands(program) {
   registerAdobeIoEventsCommands(program);
   registerCompanyCommands(program);
+  registerPurchaseOrderCartCommands(program);
   registerWebhooksCommands(program);
 }
 

package/lib/commands/company.js

@@ -132,4 +132,439 @@ Examples:
 
             } catch (e) { handleError(e); }
         });
+
+    //-------------------------------------------------------
+    // "company create" Command
+    //-------------------------------------------------------
+    company.command('create')
+        .description('Create a new company')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run company create
+`)
+        .action(async () => {
+            try {
+                const client = await createClient();
+                const { default: inquirer } = await import('inquirer');
+
+                // Prompt for basic info
+                const answers = await inquirer.prompt([
+                    { name: 'company_name', message: 'Company Name:' },
+                    { name: 'company_email', message: 'Company Email:' },
+                    { name: 'legal_name', message: 'Legal Name (optional):' },
+                    { name: 'vat_tax_id', message: 'VAT/Tax ID (optional):' },
+                    { name: 'reseller_id', message: 'Reseller ID (optional):' },
+                    { name: 'customer_group_id', message: 'Customer Group ID:', default: '1' },
+                    { name: 'sales_representative_id', message: 'Sales Representative ID (Admin User ID):', default: '1' },
+                    { name: 'email', message: 'Super Admin Email:' },
+                    { name: 'firstname', message: 'Super Admin First Name:' },
+                    { name: 'lastname', message: 'Super Admin Last Name:' }
+                ]);
+
+                // Address is required usually
+                const address = await inquirer.prompt([
+                    { name: 'street', message: 'Street:' },
+                    { name: 'city', message: 'City:' },
+                    { name: 'country_id', message: 'Country ID:', default: 'US' },
+                    { name: 'region', message: 'Region/State:' },
+                    { name: 'postcode', message: 'Postcode:' },
+                    { name: 'telephone', message: 'Telephone:' }
+                ]);
+
+                const payload = {
+                    company: {
+                        company_name: answers.company_name,
+                        company_email: answers.company_email,
+                        legal_name: answers.legal_name,
+                        vat_tax_id: answers.vat_tax_id,
+                        reseller_id: answers.reseller_id,
+                        customer_group_id: answers.customer_group_id,
+                        sales_representative_id: answers.sales_representative_id,
+                        super_user_id: 0, // 0 for new user
+                        street: [address.street],
+                        city: address.city,
+                        country_id: address.country_id,
+                        region: { region: address.region }, // Simplified
+                        postcode: address.postcode,
+                        telephone: address.telephone
+                    },
+                    company_admin: {
+                        email: answers.email,
+                        firstname: answers.firstname,
+                        lastname: answers.lastname
+                    }
+                };
+
+                // POST /V1/company/
+                const data = await client.post('V1/company', payload);
+                console.log(chalk.green(`✅ Company created with ID: ${data.id}`));
+            } catch (e) { handleError(e); }
+        });
+
+    //-------------------------------------------------------
+    // "company update" Command
+    //-------------------------------------------------------
+    company.command('update <companyId>')
+        .description('Update company details')
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run company update 123
+`)
+        .action(async (companyId) => {
+            try {
+                const client = await createClient();
+                const { default: inquirer } = await import('inquirer');
+
+                // First fetch data
+                let current;
+                try {
+                    current = await client.get(`V1/company/${companyId}`);
+                } catch (e) {
+                    throw new Error(`Company ${companyId} not found.`);
+                }
+
+                const answers = await inquirer.prompt([
+                    { name: 'company_name', message: 'Company Name:', default: current.company_name },
+                    { name: 'company_email', message: 'Company Email:', default: current.company_email },
+                    { name: 'sales_representative_id', message: 'Sales Rep ID:', default: String(current.sales_representative_id) },
+                    { name: 'customer_group_id', message: 'Customer Group ID:', default: String(current.customer_group_id) }
+                ]);
+
+                // Merge
+                const payload = {
+                    company: {
+                        ...current,
+                        ...answers
+                    }
+                };
+
+                await client.put(`V1/company/${companyId}`, payload);
+                console.log(chalk.green(`✅ Company ${companyId} updated.`));
+            } catch (e) { handleError(e); }
+        });
+
+    //-------------------------------------------------------
+    // "company delete" Command
+    //-------------------------------------------------------
+    company.command('delete <companyId>')
+        .description('Delete a company')
+        .option('--force', 'Force delete without confirmation')
+        .action(async (companyId, options) => {
+            try {
+                const client = await createClient();
+                const { default: inquirer } = await import('inquirer');
+
+                if (!options.force) {
+                    const { confirm } = await inquirer.prompt([{
+                        type: 'confirm',
+                        name: 'confirm',
+                        message: `Delete company ${companyId}?`,
+                        default: false
+                    }]);
+                    if (!confirm) return;
+                }
+
+                await client.delete(`V1/company/${companyId}`);
+                console.log(chalk.green(`✅ Company ${companyId} deleted.`));
+            } catch (e) { handleError(e); }
+        });
+
+    //-------------------------------------------------------
+    // "company structure" Command
+    //-------------------------------------------------------
+    company.command('structure <companyId>')
+        .description('Show company structure (hierarchy)')
+        .action(async (companyId) => {
+            try {
+                const client = await createClient();
+                // GET /V1/company/relations usually returns the user structure.
+                // However, without a specific hierarchy endpoint that is easy to visualize, we might just dump data.
+                const data = await client.get(`V1/company/${companyId}`);
+                console.log(chalk.bold(`Company Structure for ${data.company_name} (${data.id})`));
+                console.log('Hierarchy visualization requires more complex data. Showing basic info.');
+                console.log(`Parent ID: ${data.parent_id || 'None'}`);
+                console.log(`Legal Name: ${data.legal_name || '-'}`);
+            } catch (e) { handleError(e); }
+        });
+
+    //-------------------------------------------------------
+    // "company role" Group
+    //-------------------------------------------------------
+    const role = company.command('role').description('Manage company roles');
+
+    role.command('list')
+        .description('List roles')
+        .action(async () => {
+            try {
+                const client = await createClient();
+                // Assuming lists all roles visible to admin context
+                const data = await client.get('V1/company/role', { 'searchCriteria[pageSize]': 20 });
+                const items = data.items || [];
+                const rows = items.map(r => [r.role_id, r.role_name, r.company_id]);
+                console.log(chalk.bold(`Total Roles: ${data.total_count}`));
+                printTable(['ID', 'Name', 'Company ID'], rows);
+            } catch (e) { handleError(e); }
+        });
+
+    role.command('show <roleId>')
+        .description('Show role details')
+        .action(async (roleId) => {
+            try {
+                const client = await createClient();
+                const data = await client.get(`V1/company/role/${roleId}`);
+                console.log(chalk.bold(`\nRole: ${data.role_name} (ID: ${data.role_id})`));
+                if (data.permissions) {
+                    console.log(chalk.bold('\nPermissions:'));
+                    data.permissions.forEach(p => console.log(` - ${p.resource_id}: ${p.permission}`));
+                }
+            } catch (e) { handleError(e); }
+        });
+
+    //-------------------------------------------------------
+    // "company credit" Group
+    //-------------------------------------------------------
+    const credit = company.command('credit').description('Manage company credits');
+
+    credit.command('show <companyId>')
+        .description('Show credit for company')
+        .action(async (companyId) => {
+            try {
+                const client = await createClient();
+                const data = await client.get(`V1/companyCredits/company/${companyId}`);
+                console.log(chalk.bold(`\nCredit ID: ${data.id}`));
+                console.log(`Balance: ${data.balance} ${data.currency_code}`);
+                console.log(`Limit:   ${data.credit_limit} ${data.currency_code}`);
+                console.log(`Avail:   ${data.available_limit} ${data.currency_code}`);
+            } catch (e) { handleError(e); }
+        });
+
+    credit.command('history <companyId>')
+        .description('Show credit history')
+        .option('-p, --page <number>', 'Page number', '1')
+        .action(async (companyId, options) => {
+            try {
+                const client = await createClient();
+
+                // 1. Get Credit ID for the company
+                let creditData;
+                try {
+                    creditData = await client.get(`V1/companyCredits/company/${companyId}`);
+                } catch (e) {
+                    throw new Error(`Could not find credit profile for company ${companyId}`);
+                }
+                const creditId = creditData.id;
+
+                // 2. Search History by company_credit_id
+                const params = {
+                    'searchCriteria[filterGroups][0][filters][0][field]': 'company_credit_id',
+                    'searchCriteria[filterGroups][0][filters][0][value]': creditId,
+                    'searchCriteria[currentPage]': options.page,
+                    'searchCriteria[pageSize]': 20
+                };
+                const data = await client.get('V1/companyCredits/history', params);
+
+                if (data.total_count === 0) {
+                    console.log(chalk.yellow('No history found.'));
+                    return;
+                }
+
+                const typeMap = {
+                    1: 'Allocate',
+                    2: 'Reimburse',
+                    3: 'Purchase',
+                    4: 'Refund',
+                    5: 'Revert',
+                    6: 'Currency Update'
+                };
+                const rows = (data.items || []).map(h => [
+                    h.datetime,
+                    `${typeMap[h.type] || 'Unknown'} (${h.type})`,
+                    h.amount,
+                    h.balance,
+                    h.comment
+                ]);
+                console.log(chalk.bold(`Total Entries: ${data.total_count}`));
+                printTable(['Date', 'Type', 'Amount', 'Balance', 'Comment'], rows);
+            } catch (e) { handleError(e); }
+        });
+
+    credit.command('increase [creditId] [amount]')
+        .description('Increase balance')
+        .option('--currency <code >', 'Currency code')
+        .option('--type <number>', 'Operation Type (1=Allocate, 2=Reimburse, 4=Refund, 5=Revert)')
+        .option('--comment <text>', 'Comment', 'Manual increase')
+        .option('--po <number>', 'PO Number', '')
+        .action(async (creditId, amount, options) => {
+            try {
+                const client = await createClient();
+                const inquirer = (await import('inquirer')).default;
+                const { select } = await import('@inquirer/prompts');
+
+                let isInteractive = false;
+                if (!creditId) {
+                    isInteractive = true;
+                    const ans = await inquirer.prompt([{
+                        type: 'input',
+                        name: 'creditId',
+                        message: 'Enter Credit ID:'
+                    }]);
+                    creditId = ans.creditId;
+                }
+
+                if (!amount) {
+                    isInteractive = true;
+                    const ans = await inquirer.prompt([{
+                        type: 'input',
+                        name: 'amount',
+                        message: 'Enter Amount:'
+                    }]);
+                    amount = ans.amount;
+                }
+
+                // Operation Type Selection (if not provided)
+                let operationType = options.type;
+                if (!operationType) {
+                    if (isInteractive) {
+                        operationType = await select({
+                            message: 'Select Operation Type:',
+                            choices: [
+                                { name: 'Reimburse (2)', value: 2 },
+                                { name: 'Allocate (1)', value: 1 },
+                                { name: 'Refund (4)', value: 4 },
+                                { name: 'Revert (5)', value: 5 }
+                            ],
+                            default: 2
+                        });
+                    } else {
+                        operationType = 2;
+                    }
+                }
+
+                // 1. Get current credit details to find currency
+                let currency = options.currency;
+                if (!currency) {
+                    try {
+                        const creditData = await client.get(`V1/companyCredits/${creditId}`);
+                        currency = creditData.currency_code;
+                    } catch (e) {
+                        console.warn(chalk.yellow('Could not fetch credit details to determine currency. Using interactive prompt.'));
+                    }
+                }
+
+                if (!currency) {
+                    const ans = await inquirer.prompt([{
+                        type: 'input',
+                        name: 'currency',
+                        message: 'Enter currency code:',
+                        default: 'USD'
+                    }]);
+                    currency = ans.currency;
+                }
+
+                const payload = {
+                    value: parseFloat(amount),
+                    currency: currency,
+                    operationType: parseInt(operationType), // 1=Allocate, 2=Reimburse, 4=Refund, 5=Revert
+                    comment: options.comment,
+                    options: {
+                        purchase_order: options.po,
+                        order_increment: '',
+                        currency_display: currency,
+                        currency_base: currency
+                    }
+                };
+
+                await client.post(`V1/companyCredits/${creditId}/increaseBalance`, payload);
+                console.log(chalk.green(`✅ Credit ${creditId} increased by ${amount} ${currency}`));
+            } catch (e) { handleError(e); }
+        });
+
+    credit.command('decrease [creditId] [amount]')
+        .description('Decrease balance')
+        .option('--currency <code>', 'Currency code')
+        .option('--type <number>', 'Operation Type (3=Purchase)')
+        .option('--comment <text>', 'Comment', 'Manual decrease')
+        .option('--po <number>', 'PO Number', '')
+        .action(async (creditId, amount, options) => {
+            try {
+                const client = await createClient();
+                const inquirer = (await import('inquirer')).default;
+                const { select } = await import('@inquirer/prompts');
+
+                let isInteractive = false;
+                if (!creditId) {
+                    isInteractive = true;
+                    const ans = await inquirer.prompt([{
+                        type: 'input',
+                        name: 'creditId',
+                        message: 'Enter Credit ID:'
+                    }]);
+                    creditId = ans.creditId;
+                }
+
+                if (!amount) {
+                    isInteractive = true;
+                    const ans = await inquirer.prompt([{
+                        type: 'input',
+                        name: 'amount',
+                        message: 'Enter Amount:'
+                    }]);
+                    amount = ans.amount;
+                }
+
+                // Operation Type Selection (if not provided)
+                let operationType = options.type;
+                if (!operationType) {
+                    if (isInteractive) {
+                        operationType = await select({
+                            message: 'Select Operation Type:',
+                            choices: [
+                                { name: 'Purchase (3)', value: 3 },
+                                { name: 'Reimburse (2)', value: 2 }
+                            ],
+                            default: 3
+                        });
+                    } else {
+                        operationType = 3;
+                    }
+                }
+
+                // 1. Get current credit details to find currency
+                let currency = options.currency;
+                if (!currency) {
+                    try {
+                        const creditData = await client.get(`V1/companyCredits/${creditId}`);
+                        currency = creditData.currency_code;
+                    } catch (e) {
+                        console.warn(chalk.yellow('Could not fetch credit details to determine currency. Using interactive prompt.'));
+                    }
+                }
+
+                if (!currency) {
+                    const ans = await inquirer.prompt([{
+                        type: 'input',
+                        name: 'currency',
+                        message: 'Enter currency code:',
+                        default: 'USD'
+                    }]);
+                    currency = ans.currency;
+                }
+
+                const payload = {
+                    value: parseFloat(amount),
+                    currency: currency,
+                    operationType: parseInt(operationType),
+                    comment: options.comment,
+                    options: {
+                        purchase_order: options.po,
+                        order_increment: '',
+                        currency_display: currency,
+                        currency_base: currency
+                    }
+                };
+
+                await client.post(`V1/companyCredits/${creditId}/decreaseBalance`, payload);
+                console.log(chalk.green(`✅ Credit ${creditId} decreased by ${amount} ${currency}`));
+            } catch (e) { handleError(e); }
+        });
 }

package/lib/commands/console.js

@@ -18,12 +18,14 @@ export function registerConsoleCommand(program) {
                 console.log(chalk.gray('Debug mode enabled'));
             }
 
-            console.log(chalk.bold.blue('Mage Remote Run Interactive Console'));
-            console.log(chalk.gray('Type your commands directly or write JS code.'));
-            console.log(chalk.gray('Global variables available: client (async factory), config, chalk'));
-            console.log(chalk.gray('Example JS: await (await client()).get("V1/store/websites")'));
-            console.log(chalk.gray('Type "list" to see available commands.'));
-            console.log(chalk.gray('Type .exit to quit.\n'));
+            if (process.env.NODE_ENV !== 'test') {
+                console.log(chalk.bold.blue('Mage Remote Run Interactive Console'));
+                console.log(chalk.gray('Type your commands directly or write JS code.'));
+                console.log(chalk.gray('Global variables available: client (async factory), config, chalk'));
+                console.log(chalk.gray('Example JS: await (await client()).get("V1/store/websites")'));
+                console.log(chalk.gray('Type "list" to see available commands.'));
+                console.log(chalk.gray('Type .exit to quit.\n'));
+            }
 
             // State for the REPL
             let localProgram;

package/lib/commands/purchase-order-cart.js

@@ -0,0 +1,63 @@
+import { createClient } from '../api/factory.js';
+import { printTable, handleError } from '../utils.js';
+import chalk from 'chalk';
+
+export function registerPurchaseOrderCartCommands(program) {
+    const poCart = program.command('po-cart').description('Manage Purchase Order Carts');
+
+    //-------------------------------------------------------
+    // "po-cart totals" Command
+    //-------------------------------------------------------
+    poCart.command('totals <cartId>')
+        .description('Get purchase order cart totals')
+        .action(async (cartId) => {
+            try {
+                const client = await createClient();
+                const data = await client.get(`V1/purchase-order-carts/${cartId}/totals`);
+
+                console.log(chalk.bold('Totals:'));
+                const rows = (data.total_segments || []).map(t => [t.title, t.value]);
+                printTable(['Title', 'Value'], rows);
+
+                console.log(chalk.bold(`\nGrand Total: ${data.grand_total} ${data.quote_currency_code}`));
+            } catch (e) { handleError(e); }
+        });
+
+    //-------------------------------------------------------
+    // "po-cart shipping-methods" Command
+    //-------------------------------------------------------
+    poCart.command('shipping-methods <cartId>')
+        .description('Estimate shipping methods (requires address ID)')
+        .requiredOption('--address-id <id>', 'Address ID to estimate for')
+        .action(async (cartId, options) => {
+            try {
+                const client = await createClient();
+                const payload = { addressId: options.addressId };
+                const data = await client.post(`V1/purchase-order-carts/${cartId}/estimate-shipping-methods-by-address-id`, payload);
+
+                console.log(chalk.bold('Shipping Methods:'));
+                const rows = data.map(m => [m.carrier_title, m.method_title, m.amount, m.price_excl_tax]);
+                printTable(['Carrier', 'Method', 'Amount', 'Price Excl Tax'], rows);
+            } catch (e) { handleError(e); }
+        });
+
+    //-------------------------------------------------------
+    // "po-cart payment-info" Command
+    //-------------------------------------------------------
+    poCart.command('payment-info <cartId>')
+        .description('Get payment information')
+        .action(async (cartId) => {
+            try {
+                const client = await createClient();
+                const data = await client.get(`V1/purchase-order-carts/${cartId}/payment-information`);
+
+                console.log(chalk.bold('Payment Methods:'));
+                const methods = data.payment_methods || [];
+                methods.forEach(m => console.log(`- ${m.title} (${m.code})`));
+
+                console.log(chalk.bold('\nTotals:'));
+                const totals = data.totals || {};
+                console.log(`Grand Total: ${totals.grand_total} ${totals.quote_currency_code}`);
+            } catch (e) { handleError(e); }
+        });
+}

package/lib/utils.js

@@ -11,7 +11,33 @@ export function printTable(headers, data) {
 }
 
 export function handleError(error) {
-    console.error(chalk.red('Error:'), error.message);
+    let message = error.message;
+
+    // specific handling for Magento API Errors which are often JSON stringified
+    // Format: "API Error 404: {...}"
+    const apiErrorMatch = message.match(/^API Error (\d+): (.+)$/);
+    if (apiErrorMatch) {
+        const statusCode = apiErrorMatch[1];
+        const jsonPart = apiErrorMatch[2];
+        try {
+            const parsed = JSON.parse(jsonPart);
+            if (parsed.message) {
+                let prettyMessage = parsed.message;
+                if (parsed.parameters) {
+                    // Substitute %fieldName with values
+                    Object.keys(parsed.parameters).forEach(key => {
+                        prettyMessage = prettyMessage.replace(new RegExp(`%${key}`, 'g'), parsed.parameters[key]);
+                    });
+                }
+                message = `${prettyMessage}`;
+                // Optional: append status code if not 200? The user request just showed the clean message.
+            }
+        } catch (e) {
+            // If parsing fails, keep original message
+        }
+    }
+
+    console.error(chalk.red('Error:'), message);
     if (process.env.DEBUG) {
         console.error(error);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mage-remote-run",
-  "version": "0.16.0",
+  "version": "0.18.0",
   "description": "The remote swiss army knife for Magento Open Source, Mage-OS, Adobe Commerce",
   "main": "index.js",
   "scripts": {