mage-remote-run 0.2.5 → 0.3.0

package/bin/mage-remote-run.js

@@ -25,6 +25,7 @@ import { registerOrdersCommands } from '../lib/commands/orders.js';
 import { registerEavCommands } from '../lib/commands/eav.js';
 import { registerProductsCommands } from '../lib/commands/products.js';
 import { registerTaxCommands } from '../lib/commands/tax.js';
+import { registerInventoryCommands } from '../lib/commands/inventory.js';
 
 registerConnectionCommands(program);
 registerWebsitesCommands(program);
@@ -34,6 +35,7 @@ registerOrdersCommands(program);
 registerEavCommands(program);
 registerProductsCommands(program);
 registerTaxCommands(program);
+registerInventoryCommands(program);
 
 function resolveCommandMatch(parent, token) {
     const tokenLower = token.toLowerCase();

package/lib/api/spec-loader.js

@@ -1,9 +1,11 @@
 import { OpenAPIClientAxios } from 'openapi-client-axios';
 import fs from 'fs';
 import path from 'path';
+import { fileURLToPath } from 'url';
 
 // Locate specs relative to project root (assuming we are in lib/api)
-const SPEC_DIR = path.resolve(process.cwd(), 'api-specs/2.4.8');
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const SPEC_DIR = path.resolve(__dirname, '../../api-specs/2.4.8');
 
 export function loadSpec(type) {
     let specFile;

package/lib/commands/customers.js

@@ -193,4 +193,23 @@ export function registerCustomersCommands(program) {
                 }
             }
         });
+    const groups = customers.command('group').description('Manage customer groups');
+
+    groups.command('list')
+        .description('List customer groups')
+        .option('-p, --page <number>', 'Page number', '1')
+        .option('-s, --size <number>', 'Page size', '20')
+        .action(async (options) => {
+            try {
+                const client = await createClient();
+                const params = {
+                    'searchCriteria[currentPage]': options.page,
+                    'searchCriteria[pageSize]': options.size
+                };
+                const data = await client.get('V1/customerGroups/search', params);
+                const rows = (data.items || []).map(g => [g.id, g.code, g.tax_class_id]);
+                console.log(chalk.bold(`Total: ${data.total_count}, Page: ${options.page}, Size: ${options.size}`));
+                printTable(['ID', 'Code', 'Tax Class ID'], rows);
+            } catch (e) { handleError(e); }
+        });
 }

package/lib/commands/inventory.js

@@ -0,0 +1,91 @@
+
+import { createClient } from '../api/factory.js';
+import { printTable, handleError } from '../utils.js';
+import chalk from 'chalk';
+
+export function registerInventoryCommands(program) {
+    const inventory = program.command('inventory').description('Manage inventory');
+
+    const stock = inventory.command('stock').description('Manage inventory stocks');
+
+    stock.command('list')
+        .description('List inventory stocks')
+        .action(async () => {
+            try {
+                const client = await createClient();
+                const data = await client.get('V1/inventory/stocks', {
+                    'searchCriteria[currentPage]': 1,
+                    'searchCriteria[pageSize]': 50
+                });
+                // Check if result is items array or object with items
+                const items = data.items ? data.items : data;
+                const rows = (Array.isArray(items) ? items : []).map(s => [s.stock_id, s.name]);
+                printTable(['ID', 'Name'], rows);
+            } catch (e) { handleError(e); }
+        });
+
+    stock.command('show <stockId>')
+        .description('Show stock details')
+        .action(async (stockId) => {
+            try {
+                const client = await createClient();
+                const data = await client.get(`V1/inventory/stocks/${stockId}`);
+                console.log(chalk.bold.blue('\n📦 Stock Information'));
+                console.log(chalk.gray('━'.repeat(60)));
+                console.log(`  ${chalk.bold('ID:')}             ${data.stock_id}`);
+                console.log(`  ${chalk.bold('Name:')}           ${data.name}`);
+                if (data.extension_attributes && data.extension_attributes.sales_channels) {
+                    console.log(chalk.bold('\n📢 Sales Channels'));
+                    data.extension_attributes.sales_channels.forEach(sc => {
+                        console.log(`  Type: ${sc.type}, Code: ${sc.code}`);
+                    });
+                }
+                console.log('');
+            } catch (e) { handleError(e); }
+        });
+
+    inventory.command('resolve-stock <type> <code>')
+        .description('Resolve stock for a sales channel')
+        .action(async (type, code) => {
+            try {
+                const client = await createClient();
+                const stock = await client.get(`V1/inventory/stock-resolver/${type}/${code}`);
+                console.log(chalk.bold(`Resolved Stock ID: ${stock.stock_id}`));
+            } catch (e) { handleError(e); }
+        });
+
+    const source = inventory.command('source').description('Manage inventory sources');
+
+    source.command('list')
+        .description('List inventory sources')
+        .option('-p, --page <number>', 'Page number', '1')
+        .option('-s, --size <number>', 'Page size', '20')
+        .action(async (options) => {
+            try {
+                const client = await createClient();
+                const params = {
+                    'searchCriteria[currentPage]': options.page,
+                    'searchCriteria[pageSize]': options.size
+                };
+                const data = await client.get('V1/inventory/sources', params);
+                const items = data.items ? data.items : [];
+                const rows = (Array.isArray(items) ? items : []).map(s => [s.source_code, s.name, s.enabled ? 'Yes' : 'No', s.postcode]);
+                console.log(chalk.bold(`Total: ${data.total_count}, Page: ${options.page}, Size: ${options.size}`));
+                printTable(['Code', 'Name', 'Enabled', 'Postcode'], rows);
+            } catch (e) { handleError(e); }
+        });
+
+    const ssa = source.command('selection-algorithm').description('Manage source selection algorithms');
+
+    ssa.command('list')
+        .description('List available source selection algorithms')
+        .action(async () => {
+            try {
+                const client = await createClient();
+                const data = await client.get('V1/inventory/source-selection-algorithm-list');
+                const items = data.items ? data.items : data;
+                const rows = (Array.isArray(items) ? items : []).map(a => [a.code, a.title, a.description]);
+                printTable(['Code', 'Title', 'Description'], rows);
+            } catch (e) { handleError(e); }
+        });
+}

package/lib/commands/products.js

@@ -5,7 +5,141 @@ import chalk from 'chalk';
 export function registerProductsCommands(program) {
     const products = program.command('product').description('Manage products');
 
-    products.command('types')
+    products.command('list')
+        .description('List products')
+        .option('-p, --page <number>', 'Page number', '1')
+        .option('-s, --size <number>', 'Page size', '20')
+        .option('--sort-by <attribute>', 'Attribute to sort by', 'id')
+        .option('--sort-order <order>', 'Sort order (ASC or DESC)', 'ASC')
+        .action(async (options) => {
+            try {
+                const client = await createClient();
+                const params = {
+                    'searchCriteria[currentPage]': options.page,
+                    'searchCriteria[pageSize]': options.size,
+                    'searchCriteria[sortOrders][0][field]': options.sortBy,
+                    'searchCriteria[sortOrders][0][direction]': options.sortOrder
+                };
+                const data = await client.get('V1/products', params);
+                const rows = (data.items || []).map(p => [p.id, p.sku, p.name, p.type_id, p.price]);
+                console.log(chalk.bold(`Total: ${data.total_count}, Page: ${options.page}, Size: ${options.size}`));
+                printTable(['ID', 'SKU', 'Name', 'Type', 'Price'], rows);
+            } catch (e) { handleError(e); }
+        });
+
+    products.command('show <sku>')
+        .description('Show product details')
+        .option('-f, --format <type>', 'Output format (text, json, xml)', 'text')
+        .action(async (sku, options) => {
+            try {
+                const client = await createClient();
+                let headers = {};
+                if (options.format === 'json') headers['Accept'] = 'application/json';
+                else if (options.format === 'xml') headers['Accept'] = 'application/xml';
+
+                let data;
+                try {
+                    // SKU in URL needs to be encoded, but typically client libraries handle it if properly used.
+                    // However, we are constructing URL manually. encodeURIComponent is safer.
+                    data = await client.get(`V1/products/${encodeURIComponent(sku)}`, {}, { headers });
+                } catch (e) {
+                    throw new Error(`Product '${sku}' not found.`);
+                }
+
+                if (options.format === 'json') {
+                    console.log(JSON.stringify(data, null, 2));
+                    return;
+                }
+                if (options.format === 'xml') {
+                    console.log(data);
+                    return;
+                }
+
+                console.log(chalk.bold.blue('\n📦 Product Information'));
+                console.log(chalk.gray('━'.repeat(60)));
+
+                // General
+                console.log(chalk.bold('\nℹ️  General Information'));
+                console.log(`  ${chalk.bold('ID:')}             ${data.id}`);
+                console.log(`  ${chalk.bold('SKU:')}            ${data.sku}`);
+                console.log(`  ${chalk.bold('Name:')}           ${data.name}`);
+                console.log(`  ${chalk.bold('Type:')}           ${data.type_id}`);
+                console.log(`  ${chalk.bold('Set ID:')}         ${data.attribute_set_id}`);
+                console.log(`  ${chalk.bold('Created At:')}     ${data.created_at}`);
+                console.log(`  ${chalk.bold('Updated At:')}     ${data.updated_at}`);
+
+                // Pricing
+                console.log(chalk.bold('\n💰 Pricing'));
+                console.log(`  ${chalk.bold('Price:')}          ${data.price}`);
+                // Simple checks for special price if available in standard fields or attributes
+                const specialPrice = data.custom_attributes && data.custom_attributes.find(a => a.attribute_code === 'special_price');
+                if (specialPrice) {
+                    console.log(`  ${chalk.bold('Special Price:')}  ${specialPrice.value}`);
+                }
+                if (data.tier_prices && data.tier_prices.length > 0) {
+                    console.log(`  ${chalk.bold('Tier Prices:')}    ${data.tier_prices.length} defined`);
+                }
+
+                // Stock (Simple check via extension attributes usually)
+                if (data.extension_attributes && data.extension_attributes.stock_item) {
+                    const stock = data.extension_attributes.stock_item;
+                    console.log(chalk.bold('\n📦 Stock'));
+                    console.log(`  ${chalk.bold('In Stock:')}       ${stock.is_in_stock ? chalk.green('Yes') : chalk.red('No')}`);
+                    console.log(`  ${chalk.bold('Quantity:')}       ${stock.qty}`);
+                }
+
+                // Content
+                const { convert } = await import('html-to-text');
+                const description = data.custom_attributes && data.custom_attributes.find(a => a.attribute_code === 'description');
+                const shortDescription = data.custom_attributes && data.custom_attributes.find(a => a.attribute_code === 'short_description');
+
+                if (description || shortDescription) {
+                    console.log(chalk.bold('\n📝 Content'));
+                    if (shortDescription) {
+                        console.log(chalk.bold.underline('Short Description:'));
+                        console.log(convert(shortDescription.value, { wordwrap: 80 }));
+                        console.log('');
+                    }
+                    if (description) {
+                        console.log(chalk.bold.underline('Description:'));
+                        console.log(convert(description.value, { wordwrap: 80 }));
+                        console.log('');
+                    }
+                }
+
+                // Custom Attributes
+                if (data.custom_attributes && data.custom_attributes.length > 0) {
+                    const ignoredAttributes = ['description', 'short_description', 'special_price', 'category_ids', 'url_key'];
+                    const visibleAttributes = data.custom_attributes.filter(a => !ignoredAttributes.includes(a.attribute_code));
+
+                    if (visibleAttributes.length > 0) {
+                        console.log(chalk.bold('\n📋 Additional Attributes'));
+                        const attrRows = visibleAttributes
+                            .filter(a => typeof a.value !== 'object') // Skip complex objects for now
+                            .map(a => [a.attribute_code, a.value]);
+
+                        if (attrRows.length > 0) {
+                            printTable(['Attribute', 'Value'], attrRows);
+                        }
+                    }
+                }
+
+                // Media
+                if (data.media_gallery_entries && data.media_gallery_entries.length > 0) {
+                    console.log(chalk.bold('\n🖼️  Media'));
+                    data.media_gallery_entries.forEach(entry => {
+                        console.log(`  [${entry.media_type}] ${entry.file} (${entry.label || 'No Label'})`);
+                    });
+                }
+
+                console.log(chalk.gray('━'.repeat(60)));
+
+            } catch (e) { handleError(e); }
+        });
+
+    const types = products.command('type').description('Manage product types');
+
+    types.command('list')
         .description('List available product types')
         .action(async () => {
             try {

package/lib/config.js

@@ -5,8 +5,9 @@ import { mkdirp } from 'mkdirp';
 
 const paths = envPaths('mage-remote-run', { suffix: '' });
 const CONFIG_DIR = paths.config;
+const CACHE_DIR = paths.cache;
 const CONFIG_FILE = path.join(CONFIG_DIR, 'config.json');
-const TOKEN_CACHE_FILE = path.join(CONFIG_DIR, 'token-cache.json');
+const TOKEN_CACHE_FILE = path.join(CACHE_DIR, 'token-cache.json');
 
 export async function loadConfig() {
     try {
@@ -69,7 +70,7 @@ export async function loadTokenCache() {
 
 export async function saveTokenCache(cache) {
     try {
-        await mkdirp(CONFIG_DIR);
+        await mkdirp(CACHE_DIR);
         fs.writeFileSync(TOKEN_CACHE_FILE, JSON.stringify(cache, null, 2));
     } catch (e) {
         console.error("Error saving token cache:", e.message);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mage-remote-run",
-  "version": "0.2.5",
+  "version": "0.3.0",
   "description": "The remote swiss army knife for Magento Open Source, Mage-OS, Adobe Commerce",
   "main": "index.js",
   "scripts": {
@@ -36,6 +36,7 @@
     "cli-table3": "^0.6.5",
     "commander": "^14.0.2",
     "env-paths": "^3.0.0",
+    "html-to-text": "^9.0.5",
     "inquirer": "^13.1.0",
     "mkdirp": "^3.0.1",
     "oauth-1.0a": "^2.2.6",