mage-remote-run 0.1.0

package/lib/commands/stores.js

@@ -0,0 +1,113 @@
+import { createClient } from '../api/factory.js';
+import { printTable, handleError } from '../utils.js';
+import chalk from 'chalk';
+import inquirer from 'inquirer';
+
+export function registerStoresCommands(program) {
+    const stores = program.command('store').description('Manage store groups');
+
+    stores.command('list')
+        .action(async () => {
+            try {
+                const client = await createClient();
+                const data = await client.get('store/storeGroups');
+                const rows = data.map(s => [s.id, s.code, s.name, s.website_id, s.root_category_id]);
+                printTable(['ID', 'Code', 'Name', 'Web ID', 'Root Cat'], rows);
+            } catch (e) { handleError(e); }
+        });
+
+    stores.command('search <query>')
+        .action(async (query) => {
+            try {
+                const client = await createClient();
+                const data = await client.get('store/storeGroups');
+                const filtered = data.filter(s => s.name.includes(query) || s.code.includes(query));
+                const rows = filtered.map(s => [s.id, s.code, s.name]);
+                printTable(['ID', 'Code', 'Name'], rows);
+            } catch (e) { handleError(e); }
+        });
+
+    stores.command('delete <id>')
+        .action(async (id) => {
+            try {
+                const client = await createClient();
+                const { confirm } = await inquirer.prompt([{ type: 'confirm', name: 'confirm', message: `Delete Store Group ${id}?` }]);
+                if (!confirm) return;
+                await client.delete(`store/storeGroups/${id}`);
+                console.log(chalk.green(`Store Group ${id} deleted.`));
+            } catch (e) { handleError(e); }
+        });
+
+    stores.command('edit <id>')
+        .action(async (id) => {
+            try {
+                const client = await createClient();
+                const all = await client.get('store/storeGroups');
+                const current = all.find(s => s.id == id);
+                if (!current) throw new Error(`Store ${id} not found`);
+
+                const answers = await inquirer.prompt([
+                    { name: 'name', message: 'Name', default: current.name },
+                    { name: 'code', message: 'Code', default: current.code },
+                    { name: 'website_id', message: 'Website ID', default: current.website_id }
+                ]);
+
+                await client.put(`store/storeGroups/${id}`, { group: { id: parseInt(id), ...answers } });
+                console.log(chalk.green(`Store ${id} updated.`));
+            } catch (e) { handleError(e); }
+        });
+
+    // Store Views
+    const views = stores.command('view').description('Manage store views');
+
+    views.command('list')
+        .action(async () => {
+            try {
+                const client = await createClient();
+                const data = await client.get('store/storeViews');
+                const rows = data.map(v => [v.id, v.code, v.name, v.store_group_id, v.is_active]);
+                printTable(['ID', 'Code', 'Name', 'Group ID', 'Active'], rows);
+            } catch (e) { handleError(e); }
+        });
+
+    views.command('search <query>')
+        .action(async (query) => {
+            try {
+                const client = await createClient();
+                const data = await client.get('store/storeViews');
+                const filtered = data.filter(v => v.name.includes(query) || v.code.includes(query));
+                const rows = filtered.map(v => [v.id, v.code, v.name]);
+                printTable(['ID', 'Code', 'Name'], rows);
+            } catch (e) { handleError(e); }
+        });
+
+    views.command('delete <id>')
+        .action(async (id) => {
+            try {
+                const client = await createClient();
+                const { confirm } = await inquirer.prompt([{ type: 'confirm', name: 'confirm', message: `Delete Store View ${id}?` }]);
+                if (!confirm) return;
+                await client.delete(`store/storeViews/${id}`);
+                console.log(chalk.green(`Store View ${id} deleted.`));
+            } catch (e) { handleError(e); }
+        });
+
+    views.command('edit <id>')
+        .action(async (id) => {
+            try {
+                const client = await createClient();
+                const all = await client.get('store/storeViews');
+                const current = all.find(v => v.id == id);
+                if (!current) throw new Error(`View ${id} not found`);
+
+                const answers = await inquirer.prompt([
+                    { name: 'name', message: 'Name', default: current.name },
+                    { name: 'code', message: 'Code', default: current.code },
+                    { name: 'is_active', message: 'Is Active (0/1)', default: current.is_active }
+                ]);
+
+                await client.put(`store/storeViews/${id}`, { store: { id: parseInt(id), ...answers } });
+                console.log(chalk.green(`Store View ${id} updated.`));
+            } catch (e) { handleError(e); }
+        });
+}

package/lib/commands/tax.js

@@ -0,0 +1,46 @@
+import { createClient } from '../api/factory.js';
+import { printTable, handleError } from '../utils.js';
+import chalk from 'chalk';
+
+export function registerTaxCommands(program) {
+    const tax = program.command('tax').description('Manage tax classes');
+
+    const taxClass = tax.command('class').description('Manage tax classes');
+
+    taxClass.command('list')
+        .description('List tax classes')
+        .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('taxClasses/search', params);
+                const rows = (data.items || []).map(tc => [
+                    tc.class_id,
+                    tc.class_name,
+                    tc.class_type
+                ]);
+                console.log(chalk.bold(`Total: ${data.total_count}, Page: ${options.page}, Size: ${options.size}`));
+                printTable(['ID', 'Name', 'Type'], rows);
+            } catch (e) { handleError(e); }
+        });
+
+    taxClass.command('show <id>')
+        .description('Show tax class details')
+        .action(async (id) => {
+            try {
+                const client = await createClient();
+                const data = await client.get(`taxClasses/${id}`);
+
+                console.log(chalk.bold.blue('\nTax Class Details:'));
+                console.log(`${chalk.bold('ID:')}   ${data.class_id}`);
+                console.log(`${chalk.bold('Name:')} ${data.class_name}`);
+                console.log(`${chalk.bold('Type:')} ${data.class_type}`);
+
+            } catch (e) { handleError(e); }
+        });
+}

package/lib/commands/websites.js

@@ -0,0 +1,76 @@
+import { createClient } from '../api/factory.js';
+import { printTable, handleError } from '../utils.js';
+import chalk from 'chalk';
+import inquirer from 'inquirer';
+
+export function registerWebsitesCommands(program) {
+    const websites = program.command('website').description('Manage websites');
+
+    websites.command('list')
+        .description('List all websites')
+        .action(async () => {
+            try {
+                const client = await createClient();
+                const data = await client.get('store/websites');
+                const rows = data.map(w => [w.id, w.code, w.name, w.default_group_id]);
+                printTable(['ID', 'Code', 'Name', 'Def Group ID'], rows);
+            } catch (e) { handleError(e); }
+        });
+
+    websites.command('search <query>')
+        .description('Search websites by code or name (local filter)')
+        .action(async (query) => {
+            try {
+                const client = await createClient();
+                const data = await client.get('store/websites');
+                const filtered = data.filter(w =>
+                    w.code.includes(query) || w.name.includes(query)
+                );
+                const rows = filtered.map(w => [w.id, w.code, w.name]);
+                printTable(['ID', 'Code', 'Name'], rows);
+            } catch (e) { handleError(e); }
+        });
+
+    websites.command('delete <id>')
+        .description('Delete a website by ID')
+        .action(async (id) => {
+            try {
+                const client = await createClient();
+                // Confirm
+                const { confirm } = await inquirer.prompt([{
+                    type: 'confirm',
+                    name: 'confirm',
+                    message: `Are you sure you want to delete website ID ${id}?`
+                }]);
+                if (!confirm) return;
+
+                await client.delete(`store/websites/${id}`);
+                console.log(chalk.green(`Website ${id} deleted.`));
+            } catch (e) { handleError(e); }
+        });
+
+    websites.command('edit <id>')
+        .description('Edit a website')
+        .action(async (id) => {
+            try {
+                const client = await createClient();
+                // Fetch current
+                // Actually Magento doesn't have a single GET /store/websites/:id easily publicly documented distinct from the list?
+                // But let's assume we fetch list and find it.
+                const all = await client.get('store/websites');
+                const current = all.find(w => w.id == id);
+                if (!current) throw new Error(`Website ${id} not found`);
+
+                const answers = await inquirer.prompt([
+                    { name: 'name', message: 'Name', default: current.name },
+                    { name: 'code', message: 'Code', default: current.code },
+                    { name: 'default_group_id', message: 'Group ID', default: current.default_group_id },
+                    { name: 'sort_order', message: 'Sort Order', default: current.sort_order }
+                ]);
+
+                // PUT /V1/store/websites/:id
+                await client.put(`store/websites/${id}`, { website: { id: parseInt(id), ...answers } });
+                console.log(chalk.green(`Website ${id} updated.`));
+            } catch (e) { handleError(e); }
+        });
+}

package/lib/config.js

@@ -0,0 +1,54 @@
+import fs from 'fs';
+import path from 'path';
+import envPaths from 'env-paths';
+import { mkdirp } from 'mkdirp';
+
+const paths = envPaths('mage-remote-run', { suffix: '' });
+const CONFIG_DIR = paths.config;
+const CONFIG_FILE = path.join(CONFIG_DIR, 'config.json');
+
+export async function loadConfig() {
+    try {
+        if (!fs.existsSync(CONFIG_FILE)) {
+            return { profiles: {}, activeProfile: null };
+        }
+        const data = fs.readFileSync(CONFIG_FILE, 'utf-8');
+        return JSON.parse(data);
+    } catch (e) {
+        console.error("Error loading config:", e.message);
+        return { profiles: {}, activeProfile: null };
+    }
+}
+
+export async function saveConfig(config) {
+    try {
+        await mkdirp(CONFIG_DIR);
+        fs.writeFileSync(CONFIG_FILE, JSON.stringify(config, null, 2));
+        console.log(`Configuration saved to ${CONFIG_FILE}`);
+    } catch (e) {
+        console.error("Error saving config:", e.message);
+        throw e;
+    }
+}
+
+export async function addProfile(name, settings) {
+    const config = await loadConfig();
+    config.profiles[name] = settings;
+    // Set as active if it's the first one
+    if (!config.activeProfile) {
+        config.activeProfile = name;
+    }
+    await saveConfig(config);
+}
+
+export async function getActiveProfile() {
+    const config = await loadConfig();
+    if (!config.activeProfile || !config.profiles[config.activeProfile]) {
+        return null;
+    }
+    return config.profiles[config.activeProfile];
+}
+
+export function getConfigPath() {
+    return CONFIG_FILE;
+}

package/lib/prompts.js

@@ -0,0 +1,99 @@
+import { input, select, password, confirm } from '@inquirer/prompts';
+
+export async function askForProfileSettings(defaults = {}) {
+    const type = await select({
+        message: 'System Type:',
+        default: defaults.type,
+        choices: [
+            { name: 'Magento Open Source (On-Premises)', value: 'magento-os' },
+            { name: 'Mage-OS (On-Premises)', value: 'mage-os' },
+            { name: 'Adobe Commerce (On-Premises)', value: 'ac-on-prem' },
+            { name: 'Adobe Commerce Cloud (PaaS)', value: 'ac-cloud-paas' },
+            { name: 'Adobe Commerce as a Cloud Service (SaaS)', value: 'ac-saas' }
+        ]
+    });
+
+    const url = await input({
+        message: 'Instance URL (e.g., https://magento.test):',
+        default: defaults.url,
+        validate: value => value ? true : 'URL is required'
+    });
+
+    let authConfig = {};
+
+    if (type === 'ac-saas') {
+        const clientId = await input({
+            message: 'Client ID:',
+            default: defaults.auth?.clientId,
+            validate: value => value ? true : 'Client ID is required'
+        });
+
+        const clientSecret = await password({
+            message: 'Client Secret:',
+            description: defaults.auth?.clientSecret ? '(Leave empty to keep current)' : undefined,
+            validate: value => (value || defaults.auth?.clientSecret) ? true : 'Client Secret is required'
+        });
+
+        // If user entered nothing but we have default, use default.
+        // Inquirer password prompt with default returns default if empty.
+        // We just need to make sure we don't return empty string if default missed.
+        // Actually, inquirer returns default.
+
+        authConfig = { clientId, clientSecret: clientSecret || defaults.auth?.clientSecret };
+    } else {
+        const method = await select({
+            message: 'Authentication Method:',
+            default: defaults.auth?.method,
+            choices: [
+                { name: 'Bearer Token', value: 'bearer' },
+                { name: 'OAuth 1.0a', value: 'oauth1' }
+            ]
+        });
+
+        if (method === 'bearer') {
+            const token = await password({
+                message: 'Access Token:',
+                description: defaults.auth?.token ? '(Leave empty to keep current)' : undefined,
+                validate: value => (value || defaults.auth?.token) ? true : 'Token is required'
+            });
+            authConfig = { method: 'bearer', token: token || defaults.auth?.token };
+        } else {
+            const consumerKey = await input({
+                message: 'Consumer Key:',
+                default: defaults.auth?.consumerKey
+            });
+
+            const consumerSecret = await password({
+                message: 'Consumer Secret:',
+                description: defaults.auth?.consumerSecret ? '(Leave empty to keep current)' : undefined,
+                validate: value => (value || defaults.auth?.consumerSecret) ? true : 'Consumer Secret is required'
+            });
+
+            const accessToken = await password({
+                message: 'Access Token:',
+                description: defaults.auth?.accessToken ? '(Leave empty to keep current)' : undefined,
+                validate: value => (value || defaults.auth?.accessToken) ? true : 'Access Token is required'
+            });
+
+            const tokenSecret = await password({
+                message: 'Token Secret:',
+                description: defaults.auth?.tokenSecret ? '(Leave empty to keep current)' : undefined,
+                validate: value => (value || defaults.auth?.tokenSecret) ? true : 'Token Secret is required'
+            });
+
+            authConfig = {
+                method: 'oauth1',
+                consumerKey,
+                consumerSecret: consumerSecret || defaults.auth?.consumerSecret,
+                accessToken: accessToken || defaults.auth?.accessToken,
+                tokenSecret: tokenSecret || defaults.auth?.tokenSecret
+            };
+        }
+    }
+
+    return {
+        type,
+        url,
+        auth: authConfig
+    };
+}

package/lib/utils.js

@@ -0,0 +1,18 @@
+import chalk from 'chalk';
+import Table from 'cli-table3';
+
+export function printTable(headers, data) {
+    const table = new Table({
+        head: headers.map(h => chalk.cyan(h)),
+        style: { head: [] }
+    });
+    data.forEach(row => table.push(row));
+    console.log(table.toString());
+}
+
+export function handleError(error) {
+    console.error(chalk.red('Error:'), error.message);
+    if (process.env.DEBUG) {
+        console.error(error);
+    }
+}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "mage-remote-run",
+  "version": "0.1.0",
+  "description": "The remote swiss army knife for Magento Open Source, Mage-OS, Adobe Commerce",
+  "main": "index.js",
+  "scripts": {
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest",
+    "start": "node bin/mage-remote-run.js",
+    "release": "release-it"
+  },
+  "keywords": [],
+  "author": {
+    "name": "Christian Münch",
+    "email": "christian@muench.dev",
+    "url": "https://muench.dev"
+  },
+  "license": "MIT",
+  "type": "module",
+  "bin": {
+    "mage-remote-run": "./bin/mage-remote-run.js"
+  },
+  "files": [
+    "bin/*",
+    "lib/*",
+    "**/api-specs/*",
+    "!**/*.test.js"
+  ],
+  "dependencies": {
+    "@inquirer/prompts": "^8.1.0",
+    "axios": "^1.13.2",
+    "chalk": "^5.6.2",
+    "cli-table3": "^0.6.5",
+    "commander": "^14.0.2",
+    "env-paths": "^3.0.0",
+    "inquirer": "^13.1.0",
+    "mkdirp": "^3.0.1",
+    "oauth-1.0a": "^2.2.6",
+    "openapi-client-axios": "^7.8.0"
+  },
+  "devDependencies": {
+    "jest": "^30.2.0"
+  }
+}