mage-remote-run 0.32.0 → 1.1.0

package/lib/commands/cart-actions.js

@@ -1,5 +1,8 @@
 import { createClient } from '../api/factory.js';
-import { printTable, handleError } from '../utils.js';
+import {
+    printTable, handleError, buildPaginationCriteria,
+    getFormatHeaders, formatOutput, buildSearchCriteria, buildSortCriteria
+} from '../utils.js';
 import chalk from 'chalk';
 
 function printAddress(addr) {
@@ -34,18 +37,11 @@ function printAddress(addr) {
 export async function showCartAction(cartId, options) {
     try {
         const client = await createClient();
-        const headers = {};
-        if (options.format === 'json') headers.Accept = 'application/json';
-        else if (options.format === 'xml') headers.Accept = 'application/xml';
+        const headers = getFormatHeaders(options);
 
         const data = await client.get(`V1/carts/${cartId}`, {}, { headers });
 
-        if (options.format === 'json') {
-            console.log(JSON.stringify(data, null, 2));
-            return;
-        }
-        if (options.format === 'xml') {
-            console.log(data);
+        if (formatOutput(options, data)) {
             return;
         }
 
@@ -126,47 +122,20 @@ export async function showCartAction(cartId, options) {
 export async function listCartsAction(options) {
     try {
         const client = await createClient();
-        const headers = {};
-        if (options.format === 'json') headers.Accept = 'application/json';
-        else if (options.format === 'xml') headers.Accept = 'application/xml';
+        const headers = getFormatHeaders(options);
+
+        const { params: filterParams } = buildSearchCriteria(options);
+        const { params: sortParams } = buildSortCriteria(options);
 
         const params = {
-            'searchCriteria[currentPage]': options.page,
-            'searchCriteria[pageSize]': options.size
+            ...buildPaginationCriteria(options),
+            ...filterParams,
+            ...sortParams
         };
 
-        if (options.filter && options.filter.length > 0) {
-            options.filter.forEach((f, idx) => {
-                const parts = f.split(':');
-                const field = parts[0];
-                const value = parts[1];
-                const condition = parts[2] || 'eq';
-
-                params[`searchCriteria[filter_groups][${idx}][filters][0][field]`] = field;
-                params[`searchCriteria[filter_groups][${idx}][filters][0][value]`] = value;
-                params[`searchCriteria[filter_groups][${idx}][filters][0][condition_type]`] = condition;
-            });
-        }
-
-        if (options.sort && options.sort.length > 0) {
-            options.sort.forEach((s, idx) => {
-                const parts = s.split(':');
-                const field = parts[0];
-                const direction = parts[1] || 'ASC';
-
-                params[`searchCriteria[sortOrders][${idx}][field]`] = field;
-                params[`searchCriteria[sortOrders][${idx}][direction]`] = direction;
-            });
-        }
-
         const data = await client.get('V1/carts/search', params, { headers });
 
-        if (options.format === 'json') {
-            console.log(JSON.stringify(data, null, 2));
-            return;
-        }
-        if (options.format === 'xml') {
-            console.log(data);
+        if (formatOutput(options, data)) {
             return;
         }
 

package/lib/commands/cart.js

@@ -1,31 +1,32 @@
 import { listCartsAction, showCartAction } from './cart-actions.js';
 
+import {
+  addPaginationOptions,
+  addFormatOption,
+  addFilterOption,
+  addSortOption
+} from '../utils.js';
+
 export function registerCartCommands(program) {
-    const carts = program.command('cart').description('Manage carts');
+  const carts = program.command('cart').description('Manage carts');
 
-    carts.command('show <cartId>')
-        .description('Show detailed cart information')
-        .option('-f, --format <type>', 'Output format (text, json, xml)', 'text')
-        .addHelpText('after', `
+  addFormatOption(carts.command('show <cartId>')
+    .description('Show detailed cart information'))
+    .addHelpText('after', `
 Examples:
   $ mage-remote-run cart show 123
   $ mage-remote-run cart show 123 --format json
 `)
-        .action(showCartAction);
+    .action(showCartAction);
 
-    carts.command('list')
-        .description('List carts')
-        .option('-p, --page <number>', 'Page number', '1')
-        .option('-s, --size <number>', 'Page size', '20')
-        .option('-f, --format <type>', 'Output format (text, json, xml)', 'text')
-        .option('--filter <filter...>', 'Filter options (e.g. "field:value:condition_type" or "field:value")', [])
-        .option('--sort <sort...>', 'Sort options (e.g. "field:direction")', [])
-        .addHelpText('after', `
+  addFormatOption(addSortOption(addFilterOption(addPaginationOptions(carts.command('list')
+    .description('List carts')))))
+    .addHelpText('after', `
 Examples:
   $ mage-remote-run cart list
   $ mage-remote-run cart list --page 2 --size 50
-  $ mage-remote-run cart list --filter "is_active:1"
+  $ mage-remote-run cart list --filter "is_active=1"
   $ mage-remote-run cart list --sort "created_at:DESC"
 `)
-        .action(listCartsAction);
+    .action(listCartsAction);
 }

package/lib/commands/company-actions.js

@@ -1,29 +1,27 @@
 import { createClient } from '../api/factory.js';
-import { printTable, handleError } from '../utils.js';
+import {
+    printTable, handleError, buildPaginationCriteria,
+    getFormatHeaders, formatOutput, buildSearchCriteria, buildSortCriteria
+} from '../utils.js';
 import { COMPANY_CREATE_QUESTIONS, getAddressQuestions, getCompanyUpdateQuestions } from '../prompts/company.js';
 import chalk from 'chalk';
 
 export async function listCompaniesAction(options) {
     try {
         const client = await createClient();
-        const headers = {};
-        if (options.format === 'json') headers['Accept'] = 'application/json';
-        else if (options.format === 'xml') headers['Accept'] = 'application/xml';
+        const headers = getFormatHeaders(options);
+
+        const { params: filterParams } = buildSearchCriteria(options);
+        const { params: sortParams } = buildSortCriteria(options);
 
         const params = {
-            'searchCriteria[currentPage]': options.page,
-            'searchCriteria[pageSize]': options.size,
-            'searchCriteria[sortOrders][0][field]': options.sortBy,
-            'searchCriteria[sortOrders][0][direction]': options.sortOrder
+            ...buildPaginationCriteria(options),
+            ...filterParams,
+            ...sortParams
         };
         const data = await client.get('V1/company', params, { headers });
 
-        if (options.format === 'json') {
-            console.log(JSON.stringify(data, null, 2));
-            return;
-        }
-        if (options.format === 'xml') {
-            console.log(data);
+        if (formatOutput(options, data)) {
             return;
         }
 
@@ -43,9 +41,7 @@ export async function listCompaniesAction(options) {
 export async function showCompanyAction(companyId, 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 headers = getFormatHeaders(options);
 
         let data;
         try {
@@ -54,12 +50,7 @@ export async function showCompanyAction(companyId, options) {
             throw new Error(`Company '${companyId}' not found.`);
         }
 
-        if (options.format === 'json') {
-            console.log(JSON.stringify(data, null, 2));
-            return;
-        }
-        if (options.format === 'xml') {
-            console.log(data);
+        if (formatOutput(options, data)) {
             return;
         }
 
@@ -204,11 +195,20 @@ export async function structureCompanyAction(companyId) {
     } catch (e) { handleError(e); }
 }
 
-export async function listRolesAction() {
+export async function listRolesAction(options) {
     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 { params: filterParams } = buildSearchCriteria(options);
+        const { params: sortParams } = buildSortCriteria(options);
+
+        const params = {
+            ...buildPaginationCriteria(options),
+            ...filterParams,
+            ...sortParams
+        };
+
+        const data = await client.get('V1/company/role', params);
         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}`));
@@ -253,11 +253,16 @@ export async function historyCreditAction(companyId, options) {
         const creditId = creditData.id;
 
         // 2. Search History by company_credit_id
+        options.filter = options.filter || [];
+        options.filter.push(`company_credit_id=${creditId}`);
+
+        const { params: filterParams } = buildSearchCriteria(options);
+        const { params: sortParams } = buildSortCriteria(options);
+
         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
+            ...buildPaginationCriteria(options),
+            ...filterParams,
+            ...sortParams
         };
         const data = await client.get('V1/companyCredits/history', params);
 

package/lib/commands/company.js

@@ -13,34 +13,36 @@ import {
     decreaseCreditAction
 } from './company-actions.js';
 
+import {
+    addPaginationOptions,
+    addFormatOption,
+    addFilterOption,
+    addSortOption
+} from '../utils.js';
+
 export function registerCompanyCommands(program) {
     const company = program.command('company').description('Manage companies');
 
     //-------------------------------------------------------
     // "company list" Command
     //-------------------------------------------------------
-    company.command('list')
-        .description('List companies')
-        .option('-p, --page <number>', 'Page number', '1')
-        .option('-s, --size <number>', 'Page size', '20')
-        .option('--sort-by <field>', 'Field to sort by', 'entity_id')
-        .option('--sort-order <order>', 'Sort order (ASC, DESC)', 'ASC')
-        .option('-f, --format <type>', 'Output format (text, json, xml)', 'text')
+    addFormatOption(addSortOption(addFilterOption(addPaginationOptions(company.command('list')
+        .description('List companies')))))
         .addHelpText('after', `
 Examples:
   $ mage-remote-run company list
   $ mage-remote-run company list --page 2 --size 50
-  $ mage-remote-run company list --sort-by company_name --sort-order DESC
   $ mage-remote-run company list --format json
+  $ mage-remote-run company list --filter "status=1"
+  $ mage-remote-run company list --sort "company_name:ASC"
 `)
         .action(listCompaniesAction);
 
     //-------------------------------------------------------
     // "company show" Command
     //-------------------------------------------------------
-    company.command('show <companyId>')
-        .description('Show company details')
-        .option('-f, --format <type>', 'Output format (text, json, xml)', 'text')
+    addFormatOption(company.command('show <companyId>')
+        .description('Show company details'))
         .addHelpText('after', `
 Examples:
   $ mage-remote-run company show 123
@@ -95,8 +97,14 @@ function registerRoleCommands(company) {
     //-------------------------------------------------------
     const role = company.command('role').description('Manage company roles');
 
-    role.command('list')
-        .description('List roles')
+    addSortOption(addFilterOption(addPaginationOptions(role.command('list')
+        .description('List roles'))))
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run company role list
+  $ mage-remote-run company role list --filter "role_name=%Admin%"
+  $ mage-remote-run company role list --sort "role_name:ASC"
+`)
         .action(listRolesAction);
 
     role.command('show <roleId>')
@@ -114,9 +122,14 @@ function registerCreditCommands(company) {
         .description('Show credit for company')
         .action(showCreditAction);
 
-    credit.command('history <companyId>')
-        .description('Show credit history')
-        .option('-p, --page <number>', 'Page number', '1')
+    addSortOption(addFilterOption(addPaginationOptions(credit.command('history <companyId>')
+        .description('Show credit history'))))
+        .addHelpText('after', `
+Examples:
+  $ mage-remote-run company credit history 123
+  $ mage-remote-run company credit history 123 --filter "type=1"
+  $ mage-remote-run company credit history 123 --sort "datetime:DESC"
+`)
         .action(historyCreditAction);
 
     credit.command('increase [creditId] [amount]')

package/lib/commands/customers-actions.js

@@ -1,27 +1,27 @@
 import { createClient } from '../api/factory.js';
-import { printTable, handleError } from '../utils.js';
+import {
+    printTable, handleError, buildPaginationCriteria,
+    getFormatHeaders, formatOutput, buildSearchCriteria, buildSortCriteria
+} from '../utils.js';
 import chalk from 'chalk';
 import inquirer from 'inquirer';
 
 export async function listCustomersAction(options) {
     try {
         const client = await createClient();
-        const headers = {};
-        if (options.format === 'json') headers.Accept = 'application/json';
-        else if (options.format === 'xml') headers.Accept = 'application/xml';
+        const headers = getFormatHeaders(options);
+
+        const { params: filterParams } = buildSearchCriteria(options);
+        const { params: sortParams } = buildSortCriteria(options);
 
         const params = {
-            'searchCriteria[currentPage]': options.page,
-            'searchCriteria[pageSize]': options.size
+            ...buildPaginationCriteria(options),
+            ...filterParams,
+            ...sortParams
         };
         const data = await client.get('V1/customers/search', params, { headers });
 
-        if (options.format === 'json') {
-            console.log(JSON.stringify(data, null, 2));
-            return;
-        }
-        if (options.format === 'xml') {
-            console.log(data);
+        if (formatOutput(options, data)) {
             return;
         }
 
@@ -105,18 +105,11 @@ export async function editCustomerAction(id) {
 export async function showCustomerAction(customerId, options) {
     try {
         const client = await createClient();
-        const headers = {};
-        if (options.format === 'json') headers.Accept = 'application/json';
-        else if (options.format === 'xml') headers.Accept = 'application/xml';
+        const headers = getFormatHeaders(options);
 
         const data = await client.get(`V1/customers/${customerId}`, {}, { headers });
 
-        if (options.format === 'json') {
-            console.log(JSON.stringify(data, null, 2));
-            return;
-        }
-        if (options.format === 'xml') {
-            console.log(data);
+        if (formatOutput(options, data)) {
             return;
         }
 
@@ -222,9 +215,14 @@ export async function confirmCustomerAction(customerId, options) {
 export async function listCustomerGroupsAction(options) {
     try {
         const client = await createClient();
+
+        const { params: filterParams } = buildSearchCriteria(options);
+        const { params: sortParams } = buildSortCriteria(options);
+
         const params = {
-            'searchCriteria[currentPage]': options.page,
-            'searchCriteria[pageSize]': options.size
+            ...buildPaginationCriteria(options),
+            ...filterParams,
+            ...sortParams
         };
         const data = await client.get('V1/customerGroups/search', params);
         const rows = (data.items || []).map(g => [g.id, g.code, g.tax_class_id]);

package/lib/commands/customers.js

@@ -1,95 +1,100 @@
 import {
-    confirmCustomerAction,
-    createCustomerAction,
-    deleteCustomerAction,
-    editCustomerAction,
-    listCustomerGroupsAction,
-    listCustomersAction,
-    searchCustomersAction,
-    showCustomerAction
+  confirmCustomerAction,
+  createCustomerAction,
+  deleteCustomerAction,
+  editCustomerAction,
+  listCustomerGroupsAction,
+  listCustomersAction,
+  searchCustomersAction,
+  showCustomerAction
 } from './customers-actions.js';
 
+import {
+  addPaginationOptions,
+  addFormatOption,
+  addFilterOption,
+  addSortOption
+} from '../utils.js';
+
 export function registerCustomersCommands(program) {
-    const customers = program.command('customer').description('Manage customers');
+  const customers = program.command('customer').description('Manage customers');
 
-    customers.command('list')
-        .description('List customers')
-        .option('-p, --page <number>', 'Page number', '1')
-        .option('-s, --size <number>', 'Page size', '20')
-        .option('-f, --format <type>', 'Output format (text, json, xml)', 'text')
-        .addHelpText('after', `
+  addFormatOption(addSortOption(addFilterOption(addPaginationOptions(customers.command('list')
+    .description('List customers')))))
+    .addHelpText('after', `
 Examples:
   $ mage-remote-run customer list
   $ mage-remote-run customer list --page 2 --size 50
   $ mage-remote-run customer list --format json
+  $ mage-remote-run customer list --filter "email=%@example.com%" --filter "group_id=1"
+  $ mage-remote-run customer list --sort "firstname:ASC" --sort "created_at:DESC"
 `)
-        .action(listCustomersAction);
+    .action(listCustomersAction);
 
-    customers.command('search <query>')
-        .description('Search customers by email')
-        .addHelpText('after', `
+  customers.command('search <query>')
+    .description('Search customers by email')
+    .addHelpText('after', `
 Examples:
   $ mage-remote-run customer search "john@example.com"
 `)
-        .action(searchCustomersAction);
+    .action(searchCustomersAction);
 
-    customers.command('create')
-        .description('Create a new customer')
-        .addHelpText('after', `
+  customers.command('create')
+    .description('Create a new customer')
+    .addHelpText('after', `
 Examples:
   $ mage-remote-run customer create
 `)
-        .action(createCustomerAction);
+    .action(createCustomerAction);
 
-    customers.command('edit <id>')
-        .description('Edit a customer')
-        .addHelpText('after', `
+  customers.command('edit <id>')
+    .description('Edit a customer')
+    .addHelpText('after', `
 Examples:
   $ mage-remote-run customer edit 123
 `)
-        .action(editCustomerAction);
+    .action(editCustomerAction);
 
-    customers.command('show <customerId>')
-        .description('Show detailed customer information')
-        .option('-f, --format <type>', 'Output format (text, json, xml)', 'text')
-        .addHelpText('after', `
+  addFormatOption(customers.command('show <customerId>')
+    .description('Show detailed customer information'))
+    .addHelpText('after', `
 Examples:
   $ mage-remote-run customer show 123
   $ mage-remote-run customer show 123 --format json
 `)
-        .action(showCustomerAction);
+    .action(showCustomerAction);
 
-    customers.command('delete <customerId>')
-        .description('Delete a customer')
-        .option('--force', 'Force delete without confirmation')
-        .addHelpText('after', `
+  customers.command('delete <customerId>')
+    .description('Delete a customer')
+    .option('--force', 'Force delete without confirmation')
+    .addHelpText('after', `
 Examples:
   $ mage-remote-run customer delete 123
   $ mage-remote-run customer delete 123 --force
 `)
-        .action(deleteCustomerAction);
+    .action(deleteCustomerAction);
 
-    customers.command('confirm [customerId]')
-        .description('Resend customer confirmation email')
-        .option('--redirect-url <url>', 'Redirect URL after confirmation')
-        .addHelpText('after', `
+  customers.command('confirm [customerId]')
+    .description('Resend customer confirmation email')
+    .option('--redirect-url <url>', 'Redirect URL after confirmation')
+    .addHelpText('after', `
 Examples:
   $ mage-remote-run customer confirm 123
   $ mage-remote-run customer confirm 123 --redirect-url "https://example.com/login"
   $ mage-remote-run customer confirm
 `)
-        .action(confirmCustomerAction);
+    .action(confirmCustomerAction);
 
-    const groups = customers.command('group').description('Manage customer groups');
+  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')
-        .addHelpText('after', `
+  addSortOption(addFilterOption(addPaginationOptions(groups.command('list')
+    .description('List customer groups'))))
+    .addHelpText('after', `
 Examples:
   $ mage-remote-run customer group list
   $ mage-remote-run customer group list --page 1 --size 50
+  $ mage-remote-run customer group list --filter "code=%VIP%"
+  $ mage-remote-run customer group list --sort "code:ASC"
 `)
-        .action(listCustomerGroupsAction);
+    .action(listCustomerGroupsAction);
 }

package/lib/commands/eav-actions.js

@@ -1,26 +1,26 @@
 import { createClient } from '../api/factory.js';
-import { printTable, handleError } from '../utils.js';
+import {
+    printTable, handleError, buildPaginationCriteria,
+    getFormatHeaders, formatOutput, buildSearchCriteria, buildSortCriteria
+} from '../utils.js';
 import chalk from 'chalk';
 
 export async function listAttributeSetsAction(options) {
     try {
         const client = await createClient();
-        const headers = {};
-        if (options.format === 'json') headers.Accept = 'application/json';
-        else if (options.format === 'xml') headers.Accept = 'application/xml';
+        const headers = getFormatHeaders(options);
+
+        const { params: filterParams } = buildSearchCriteria(options);
+        const { params: sortParams } = buildSortCriteria(options);
 
         const params = {
-            'searchCriteria[currentPage]': options.page,
-            'searchCriteria[pageSize]': options.size
+            ...buildPaginationCriteria(options),
+            ...filterParams,
+            ...sortParams
         };
         const data = await client.get('V1/eav/attribute-sets/list', params, { headers });
 
-        if (options.format === 'json') {
-            console.log(JSON.stringify(data, null, 2));
-            return;
-        }
-        if (options.format === 'xml') {
-            console.log(data);
+        if (formatOutput(options, data)) {
             return;
         }
 
@@ -37,10 +37,15 @@ export async function listAttributeSetsAction(options) {
     }
 }
 
-export async function showAttributeSetAction(id) {
+export async function showAttributeSetAction(id, options) {
     try {
         const client = await createClient();
-        const data = await client.get(`V1/eav/attribute-sets/${id}`);
+        const headers = getFormatHeaders(options);
+        const data = await client.get(`V1/eav/attribute-sets/${id}`, {}, { headers });
+
+        if (formatOutput(options, data)) {
+            return;
+        }
 
         console.log(chalk.bold.blue('\nAttribute Set Details:'));
         console.log(`${chalk.bold('ID:')}             ${data.attribute_set_id}`);

package/lib/commands/eav.js

@@ -1,26 +1,32 @@
 import { listAttributeSetsAction, showAttributeSetAction } from './eav-actions.js';
 
+import {
+  addPaginationOptions,
+  addFormatOption,
+  addFilterOption,
+  addSortOption
+} from '../utils.js';
+
 export function registerEavCommands(program) {
-    const eav = program.command('eav').description('Manage EAV attributes and sets');
-    const attributeSets = eav.command('attribute-set').description('Manage attribute sets');
+  const eav = program.command('eav').description('Manage EAV attributes and sets');
+  const attributeSets = eav.command('attribute-set').description('Manage attribute sets');
 
-    attributeSets.command('list')
-        .description('List all attribute sets')
-        .option('-p, --page <number>', 'Page number', '1')
-        .option('-s, --size <number>', 'Page size', '20')
-        .option('-f, --format <type>', 'Output format (text, json, xml)', 'text')
-        .addHelpText('after', `
+  addFormatOption(addSortOption(addFilterOption(addPaginationOptions(attributeSets.command('list')
+    .description('List all attribute sets')))))
+    .addHelpText('after', `
 Examples:
   $ mage-remote-run eav attribute-set list
   $ mage-remote-run eav attribute-set list --page 1 --size 50
+  $ mage-remote-run eav attribute-set list --filter "attribute_set_name=%Default%"
+  $ mage-remote-run eav attribute-set list --sort "sort_order:ASC"
 `)
-        .action(listAttributeSetsAction);
+    .action(listAttributeSetsAction);
 
-    attributeSets.command('show <id>')
-        .description('Show attribute set details')
-        .addHelpText('after', `
+  addFormatOption(attributeSets.command('show <id>')
+    .description('Show attribute set details'))
+    .addHelpText('after', `
 Examples:
   $ mage-remote-run eav attribute-set show 4
 `)
-        .action(showAttributeSetAction);
+    .action(showAttributeSetAction);
 }