mage-remote-run 1.2.0 → 1.3.0

package/lib/commands/customers-actions.js

@@ -215,6 +215,7 @@ export async function confirmCustomerAction(customerId, options) {
 export async function listCustomerGroupsAction(options) {
     try {
         const client = await createClient();
+        const headers = getFormatHeaders(options);
 
         const { params: filterParams } = buildSearchCriteria(options);
         const { params: sortParams } = buildSortCriteria(options);
@@ -224,7 +225,12 @@ export async function listCustomerGroupsAction(options) {
             ...filterParams,
             ...sortParams
         };
-        const data = await client.get('V1/customerGroups/search', params);
+        const data = await client.get('V1/customerGroups/search', params, { headers });
+
+        if (formatOutput(options, data)) {
+            return;
+        }
+
         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);

package/lib/commands/customers.js

@@ -87,12 +87,13 @@ Examples:
 
   const groups = customers.command('group').description('Manage customer groups');
 
-  addSortOption(addFilterOption(addPaginationOptions(groups.command('list')
-    .description('List customer groups'))))
+  addFormatOption(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 --format json
   $ mage-remote-run customer group list --filter "code=%VIP%"
   $ mage-remote-run customer group list --sort "code:ASC"
 `)

package/lib/commands/stores-actions.js

@@ -1,5 +1,5 @@
 import { createClient } from '../api/factory.js';
-import { printTable, handleError, getFormatHeaders, formatOutput } from '../utils.js';
+import { printTable, handleError, getFormatHeaders, formatOutput, applyLocalSearchCriteria } from '../utils.js';
 import chalk from 'chalk';
 import inquirer from 'inquirer';
 
@@ -10,11 +10,13 @@ export async function listStoreGroupsAction(options) {
 
         const data = await client.get('V1/store/storeGroups', {}, { headers });
 
-        if (formatOutput(options, data)) {
+        let result = applyLocalSearchCriteria(data, options);
+
+        if (formatOutput(options, result)) {
             return;
         }
 
-        const rows = data.map(s => [s.id, s.code, s.name, s.website_id, s.root_category_id]);
+        const rows = result.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);
@@ -72,11 +74,13 @@ export async function listStoreViewsAction(options) {
 
         const data = await client.get('V1/store/storeViews', {}, { headers });
 
-        if (formatOutput(options, data)) {
+        let result = applyLocalSearchCriteria(data, options);
+
+        if (formatOutput(options, result)) {
             return;
         }
 
-        const rows = data.map(v => [v.id, v.code, v.name, v.store_group_id, v.is_active]);
+        const rows = result.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);

package/lib/commands/stores.js

@@ -9,19 +9,20 @@ import {
   searchStoreGroupsAction,
   searchStoreViewsAction
 } from './stores-actions.js';
-import { addFormatOption } from '../utils.js';
+import { addFormatOption, addFilterOption, addSortOption, addPaginationOptions } from '../utils.js';
 
 export function registerStoresCommands(program) {
   const stores = program.command('store').description('Manage stores');
 
   const groups = stores.command('group').description('Manage store groups');
 
-  addFormatOption(groups.command('list')
-    .description('List store groups'))
+  addFormatOption(addSortOption(addFilterOption(addPaginationOptions(groups.command('list')
+    .description('List store groups')))))
     .addHelpText('after', `
 Examples:
   $ mage-remote-run store group list
   $ mage-remote-run store group list --format json
+  $ mage-remote-run store group list --filter "code=%main%"
 `)
     .action(listStoreGroupsAction);
 
@@ -51,12 +52,13 @@ Examples:
 
   const views = stores.command('view').description('Manage store views');
 
-  addFormatOption(views.command('list')
-    .description('List store views'))
+  addFormatOption(addSortOption(addFilterOption(addPaginationOptions(views.command('list')
+    .description('List store views')))))
     .addHelpText('after', `
 Examples:
   $ mage-remote-run store view list
   $ mage-remote-run store view list --format json
+  $ mage-remote-run store view list --filter "code=%en%"
 `)
     .action(listStoreViewsAction);
 

package/lib/commands/websites-actions.js

@@ -1,4 +1,4 @@
-import { printTable, handleError, getFormatHeaders, formatOutput } from '../utils.js';
+import { printTable, handleError, getFormatHeaders, formatOutput, applyLocalSearchCriteria } from '../utils.js';
 import { createClient } from '../api/factory.js';
 import chalk from 'chalk';
 import inquirer from 'inquirer';
@@ -10,11 +10,13 @@ export async function listWebsitesAction(options) {
 
         const data = await client.get('V1/store/websites', {}, { headers });
 
-        if (formatOutput(options, data)) {
+        let result = applyLocalSearchCriteria(data, options);
+
+        if (formatOutput(options, result)) {
             return;
         }
 
-        const rows = data.map(w => [w.id, w.code, w.name, w.default_group_id]);
+        const rows = result.map(w => [w.id, w.code, w.name, w.default_group_id]);
         printTable(['ID', 'Code', 'Name', 'Def Group ID'], rows);
     } catch (e) {
         handleError(e);

package/lib/commands/websites.js

@@ -4,13 +4,13 @@ import {
   listWebsitesAction,
   searchWebsitesAction
 } from './websites-actions.js';
-import { addFormatOption } from '../utils.js';
+import { addFormatOption, addFilterOption, addSortOption, addPaginationOptions } from '../utils.js';
 
 export function registerWebsitesCommands(program) {
   const websites = program.command('website').description('Manage websites');
 
-  addFormatOption(websites.command('list')
-    .description('List all websites'))
+  addFormatOption(addSortOption(addFilterOption(addPaginationOptions(websites.command('list')
+    .description('List all websites')))))
     .addHelpText('after', `
 Examples:
   $ mage-remote-run website list

package/lib/utils.js

@@ -238,3 +238,112 @@ export function formatOutput(options, data) {
     return false;
 }
 
+export function applyLocalSearchCriteria(data, options) {
+    let result = [...data];
+
+    if (options.filter && options.filter.length > 0) {
+        options.filter.forEach(group => {
+            const orFilters = group.split(/\s*\|\|\s*/);
+            result = result.filter(item => {
+                return orFilters.some(f => {
+                    const match = f.match(/^([\w\.]+)(?::([a-z!]+))?(?:(<=|>=|<|>|=|!=|!~|~|\?|!|@@)(.*))?$/);
+                    if (!match) return false;
+
+                    const field = match[1];
+                    const opString = match[2];
+                    const shorthand = match[3];
+                    let value = match[4] || '';
+
+                    let condition = 'eq';
+                    if (opString) {
+                        condition = opString === '!in' ? 'nin' : opString;
+                    } else if (shorthand) {
+                        switch (shorthand) {
+                            case '>': condition = 'gt'; break;
+                            case '<': condition = 'lt'; break;
+                            case '>=': condition = 'gteq'; break;
+                            case '<=': condition = 'lteq'; break;
+                            case '!=': condition = 'neq'; break;
+                            case '~': condition = 'like'; break;
+                            case '!~': condition = 'nlike'; break;
+                            case '@@': condition = 'finset'; break;
+                            case '?': condition = 'null'; value = '1'; break;
+                            case '!': condition = 'notnull'; value = '1'; break;
+                            default: condition = 'eq';
+                        }
+                    }
+
+                    if ((condition === 'like' || condition === 'nlike') && value.includes('*')) {
+                        value = value.replaceAll('*', '%');
+                    }
+
+                    const itemValue = item[field];
+                    const strItemVal = String(itemValue || '').toLowerCase();
+                    const strVal = String(value).toLowerCase();
+                    const numItemVal = Number(itemValue);
+                    const numVal = Number(value);
+
+                    switch (condition) {
+                        case 'eq': return String(itemValue) === String(value);
+                        case 'neq': return String(itemValue) !== String(value);
+                        case 'gt': return numItemVal > numVal;
+                        case 'gteq': return numItemVal >= numVal;
+                        case 'lt': return numItemVal < numVal;
+                        case 'lteq': return numItemVal <= numVal;
+                        case 'like':
+                            const regexFromLike = new RegExp('^' + strVal.replace(/%/g, '.*') + '$', 'i');
+                            return regexFromLike.test(strItemVal);
+                        case 'nlike':
+                            const nregexFromLike = new RegExp('^' + strVal.replace(/%/g, '.*') + '$', 'i');
+                            return !nregexFromLike.test(strItemVal);
+                        case 'in':
+                            return String(value).split(',').map(s => s.trim()).includes(String(itemValue));
+                        case 'nin':
+                            return !String(value).split(',').map(s => s.trim()).includes(String(itemValue));
+                        case 'null': return itemValue === null || itemValue === undefined;
+                        case 'notnull': return itemValue !== null && itemValue !== undefined;
+                        case 'finset':
+                            return String(itemValue).split(',').map(s => s.trim()).includes(String(value));
+                        default: return false;
+                    }
+                });
+            });
+        });
+    }
+
+    if (options.sort && options.sort.length > 0) {
+        options.sort.forEach(s => {
+            const parts = s.split(':');
+            const field = parts[0];
+            const direction = parts.length > 1 ? parts[1].toUpperCase() : 'ASC';
+            result.sort((a, b) => {
+                if (a[field] < b[field]) return direction === 'ASC' ? -1 : 1;
+                if (a[field] > b[field]) return direction === 'ASC' ? 1 : -1;
+                return 0;
+            });
+        });
+    } else if (options.sortBy) {
+        const field = options.sortBy;
+        const direction = (options.sortOrder || 'ASC').toUpperCase();
+        result.sort((a, b) => {
+            if (a[field] < b[field]) return direction === 'ASC' ? -1 : 1;
+            if (a[field] > b[field]) return direction === 'ASC' ? 1 : -1;
+            return 0;
+        });
+    }
+
+    if (options.page && options.size) {
+        // Technically addPaginationOptions sets defaults
+        const page = parseInt(options.page || 1, 10);
+        const size = parseInt(options.size || 20, 10);
+        const start = (page - 1) * size;
+        result = result.slice(start, start + size);
+    } else if (options.page || options.size) {
+        const page = parseInt(options.page || 1, 10);
+        const size = parseInt(options.size || 20, 10);
+        const start = (page - 1) * size;
+        result = result.slice(start, start + size);
+    }
+
+    return result;
+}

package/package.json

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