mcp-grocy 2.2.0 → 2.5.0

package/build/tools/inventory/handlers.js

@@ -1,4 +1,5 @@
 import { BaseToolHandler } from '../base.js';
+import { ValidationError } from '../../utils/errors.js';
 import Fuse from 'fuse.js';
 export class InventoryToolHandlers extends BaseToolHandler {
     // ==================== PRODUCT MANAGEMENT ====================
@@ -46,8 +47,13 @@ export class InventoryToolHandlers extends BaseToolHandler {
             const stockEntries = await this.apiCall(`/stock/products/${productId}/entries`);
             // Define essential fields for stock entries
             const entryFields = [
-                'id', 'amount', 'best_before_date', 'purchased_date',
-                'stock_id', 'note', 'location_id'
+                'id',
+                'amount',
+                'best_before_date',
+                'purchased_date',
+                'stock_id',
+                'note',
+                'location_id',
             ];
             // Filter entries to only include essential fields
             const filteredEntries = Array.isArray(stockEntries)
@@ -68,7 +74,7 @@ export class InventoryToolHandlers extends BaseToolHandler {
             const { locationId } = args || {};
             this.validateRequired({ locationId }, ['locationId']);
             const data = await this.apiCall(`stock`, 'GET', undefined, {
-                queryParams: { 'query[]': `location_id=${locationId}` }
+                queryParams: { 'query[]': `location_id=${locationId}` },
             });
             return this.createSuccess(data);
         });
@@ -97,7 +103,7 @@ export class InventoryToolHandlers extends BaseToolHandler {
             this.validateRequired({ productId, amount }, ['productId', 'amount']);
             const body = {
                 amount,
-                transaction_type: spoiled ? 'inventory-correction' : 'consume'
+                transaction_type: spoiled ? 'inventory-correction' : 'consume',
             };
             if (locationId)
                 body.location_id = locationId;
@@ -112,11 +118,16 @@ export class InventoryToolHandlers extends BaseToolHandler {
     transferProduct = async (args) => {
         return this.executeToolHandler(async () => {
             const { productId, amount, fromLocationId, toLocationId, note } = args || {};
-            this.validateRequired({ productId, amount, fromLocationId, toLocationId }, ['productId', 'amount', 'fromLocationId', 'toLocationId']);
+            this.validateRequired({ productId, amount, fromLocationId, toLocationId }, [
+                'productId',
+                'amount',
+                'fromLocationId',
+                'toLocationId',
+            ]);
             const body = {
                 amount,
                 location_id_from: fromLocationId,
-                location_id_to: toLocationId
+                location_id_to: toLocationId,
             };
             if (note)
                 body.note = note;
@@ -157,7 +168,7 @@ export class InventoryToolHandlers extends BaseToolHandler {
             const [productsResponse, locationsResponse, quantityUnitsResponse] = await Promise.all([
                 this.apiCall('/objects/products'),
                 this.apiCall('/objects/locations'),
-                this.apiCall('/objects/quantity_units')
+                this.apiCall('/objects/quantity_units'),
             ]);
             const products = Array.isArray(productsResponse) ? productsResponse : [];
             const locations = Array.isArray(locationsResponse) ? locationsResponse : [];
@@ -165,7 +176,7 @@ export class InventoryToolHandlers extends BaseToolHandler {
             const fuseOptions = {
                 keys: [
                     { name: 'name', weight: 1.0 },
-                    { name: 'description', weight: 0.3 }
+                    { name: 'description', weight: 0.3 },
                 ],
                 threshold: 0.6,
                 distance: 100,
@@ -176,7 +187,7 @@ export class InventoryToolHandlers extends BaseToolHandler {
                 useExtendedSearch: false,
                 isCaseSensitive: false,
                 shouldSort: true,
-                findAllMatches: false
+                findAllMatches: false,
             };
             const fuse = new Fuse(products, fuseOptions);
             const fuseResults = fuse.search(productName);
@@ -184,13 +195,13 @@ export class InventoryToolHandlers extends BaseToolHandler {
                 ...result.item,
                 matchScore: Math.round((1 - result.score) * 100),
                 fuseScore: result.score,
-                matches: result.matches
+                matches: result.matches,
             }));
             if (productMatches.length === 0) {
                 const permissiveFuse = new Fuse(products, {
                     ...fuseOptions,
                     threshold: 0.8,
-                    distance: 200
+                    distance: 200,
                 });
                 const permissiveResults = permissiveFuse.search(productName);
                 productMatches = permissiveResults.map((result) => ({
@@ -198,14 +209,14 @@ export class InventoryToolHandlers extends BaseToolHandler {
                     matchScore: Math.round((1 - result.score) * 100),
                     fuseScore: result.score,
                     matches: result.matches,
-                    isPermissiveMatch: true
+                    isPermissiveMatch: true,
                 }));
             }
             productMatches = productMatches.slice(0, 5);
             if (productMatches.length === 0) {
                 return this.createError(`No products found matching "${productName}"`, {
                     suggestion: 'Try a different product name or check the spelling',
-                    availableProducts: products.slice(0, 10).map((p) => p.name)
+                    availableProducts: products.slice(0, 10).map((p) => p.name),
                 });
             }
             const enrichedMatches = await Promise.all(productMatches.map(async (product) => {
@@ -222,7 +233,7 @@ export class InventoryToolHandlers extends BaseToolHandler {
                         amount: stockItem.amount,
                         bestBeforeDate: stockItem.best_before_date,
                         stockId: stockItem.id,
-                        locationId: parseInt(stockItem.location_id)
+                        locationId: parseInt(stockItem.location_id),
                     };
                 });
                 stockEntries.sort((a, b) => {
@@ -235,9 +246,7 @@ export class InventoryToolHandlers extends BaseToolHandler {
                     return new Date(a.bestBeforeDate).getTime() - new Date(b.bestBeforeDate).getTime();
                 });
                 const unit = quantityUnits.find((u) => u.id == product.qu_id_stock);
-                const unitInfo = unit
-                    ? { id: unit.id, name: unit.name }
-                    : { id: null, name: 'pieces' };
+                const unitInfo = unit ? { id: unit.id, name: unit.name } : { id: null, name: 'pieces' };
                 const hasMultipleLocations = stockEntries.length > 1 &&
                     new Set(stockEntries.map((entry) => entry.locationId)).size > 1;
                 const locationInstructions = hasMultipleLocations
@@ -249,14 +258,14 @@ export class InventoryToolHandlers extends BaseToolHandler {
                     stockEntries: stockEntries,
                     totalStockAmount: productEntries.reduce((sum, s) => sum + parseFloat(s.amount || 0), 0),
                     unit: unitInfo,
-                    locationInstructions
+                    locationInstructions,
                 };
             }));
             return this.createSuccess({
                 message: `Found ${enrichedMatches.length} product matches for "${productName}" (ordered from most likely to least likely match)`,
                 productMatches: enrichedMatches,
                 allAvailableLocations: locations.map((l) => ({ id: l.id, name: l.name })),
-                instructions: 'Review the matches above. Use the exact productId and locationId from this data for any product operations (inventory_stock_entry_consume, inventory_stock_entry_transfer, inventory_transactions_purchase, inventory_transactions_adjust, etc.).'
+                instructions: 'Review the matches above. Use the exact productId and locationId from this data for any product operations (inventory_stock_entry_consume, inventory_stock_entry_transfer, inventory_transactions_purchase, inventory_transactions_adjust, etc.).',
             });
         });
     };
@@ -274,10 +283,10 @@ export class InventoryToolHandlers extends BaseToolHandler {
             this.validateRequired({ stockId, productId }, ['stockId', 'productId']);
             const stockEntryResponse = await this.apiCall(`/stock/entry/${stockId}`);
             if (!stockEntryResponse || !stockEntryResponse.product_id) {
-                throw new Error(`Could not resolve product ID from stock entry ${stockId}`);
+                throw new ValidationError(`Could not resolve product ID from stock entry ${stockId}`, 'printStockEntryLabel');
             }
             if (stockEntryResponse.product_id !== productId) {
-                throw new Error(`Product ID mismatch: stock entry ${stockId} belongs to product ${stockEntryResponse.product_id}, but ${productId} was provided`);
+                throw new ValidationError(`Product ID mismatch: stock entry ${stockId} belongs to product ${stockEntryResponse.product_id}, but ${productId} was provided`, 'printStockEntryLabel');
             }
             const result = await this.apiCall(`/stock/entry/${stockId}/printlabel`);
             return this.createSuccess(result, 'Stock entry label printed successfully');
@@ -289,7 +298,7 @@ export class InventoryToolHandlers extends BaseToolHandler {
         if (stockAmounts.length === 1) {
             const amount = stockAmounts[0];
             if (typeof amount !== 'number' || amount <= 0) {
-                throw new Error(`Invalid amount: ${amount}`);
+                throw new ValidationError(`Invalid amount: ${amount}`, 'splitStockEntry');
             }
             const note = `${originalEntry.note || ''} - ${originalEntry.id} - 1`;
             await this.apiCall(`/stock/entry/${originalEntry.id}`, 'PUT', {
@@ -298,20 +307,20 @@ export class InventoryToolHandlers extends BaseToolHandler {
                 note: note,
                 best_before_date: originalEntry.best_before_date,
                 purchased_date: originalEntry.purchased_date,
-                location_id: originalEntry.location_id
+                location_id: originalEntry.location_id,
             });
             splitEntries.push({
                 stockId: originalEntry.id,
                 amount: amount,
                 type: 'updated',
-                unit: getUnitForm(amount)
+                unit: getUnitForm(amount),
             });
         }
         else {
             for (let i = 0; i < stockAmounts.length; i++) {
                 const amount = stockAmounts[i];
                 if (typeof amount !== 'number' || amount <= 0) {
-                    throw new Error(`Invalid amount at index ${i}: ${amount}`);
+                    throw new ValidationError(`Invalid amount at index ${i}: ${amount}`, 'splitStockEntry');
                 }
                 const note = `${originalEntry.note || ''} - ${originalEntry.id} - ${i + 1}`;
                 if (i === 0) {
@@ -321,13 +330,13 @@ export class InventoryToolHandlers extends BaseToolHandler {
                         note: note,
                         best_before_date: originalEntry.best_before_date,
                         purchased_date: originalEntry.purchased_date,
-                        location_id: originalEntry.location_id
+                        location_id: originalEntry.location_id,
                     });
                     splitEntries.push({
                         stockId: originalEntry.id,
                         amount,
                         type: 'updated',
-                        unit: getUnitForm(amount)
+                        unit: getUnitForm(amount),
                     });
                 }
                 else {
@@ -337,21 +346,20 @@ export class InventoryToolHandlers extends BaseToolHandler {
                         purchased_date: originalEntry.purchased_date,
                         transaction_type: 'purchase',
                         location_id: originalEntry.location_id,
-                        note: note
+                        note: note,
                     });
                     const stockId = createResponse[0].stock_id || createResponse[0].id;
                     const stockResponse = await this.apiCall('/objects/stock');
                     const stockEntries = Array.isArray(stockResponse) ? stockResponse : [];
-                    const actualStockEntry = stockEntries.find((entry) => entry.product_id === originalEntry.product_id &&
-                        entry.stock_id === stockId);
+                    const actualStockEntry = stockEntries.find((entry) => entry.product_id === originalEntry.product_id && entry.stock_id === stockId);
                     if (!actualStockEntry) {
-                        throw new Error(`Could not find created stock entry with product_id ${originalEntry.product_id} and stock_id ${stockId}`);
+                        throw new ValidationError(`Could not find created stock entry with product_id ${originalEntry.product_id} and stock_id ${stockId}`, 'splitStockEntry');
                     }
                     splitEntries.push({
                         stockId: actualStockEntry.id,
                         amount,
                         type: 'created',
-                        unit: getUnitForm(amount)
+                        unit: getUnitForm(amount),
                     });
                 }
             }
@@ -364,16 +372,16 @@ export class InventoryToolHandlers extends BaseToolHandler {
             this.validateRequired({ stockId, productId, amount }, ['stockId', 'productId', 'amount']);
             const stockEntryResponse = await this.apiCall(`/stock/entry/${stockId}`);
             if (!stockEntryResponse || !stockEntryResponse.product_id) {
-                throw new Error(`Could not resolve product ID from stock entry ${stockId}`);
+                throw new ValidationError(`Could not resolve product ID from stock entry ${stockId}`, 'consumeStockEntry');
             }
             if (stockEntryResponse.product_id !== productId) {
-                throw new Error(`Product ID mismatch: stock entry ${stockId} belongs to product ${stockEntryResponse.product_id}, but ${productId} was provided`);
+                throw new ValidationError(`Product ID mismatch: stock entry ${stockId} belongs to product ${stockEntryResponse.product_id}, but ${productId} was provided`, 'consumeStockEntry');
             }
             const body = {
                 amount,
                 spoiled,
                 stock_entry_id: stockEntryResponse.stock_id,
-                location_id: stockEntryResponse.location_id
+                location_id: stockEntryResponse.location_id,
             };
             if (note)
                 body.note = note;
@@ -384,20 +392,25 @@ export class InventoryToolHandlers extends BaseToolHandler {
     transferStockEntry = async (args) => {
         return this.executeToolHandler(async () => {
             const { stockId, productId, amount, locationIdTo, note } = args || {};
-            this.validateRequired({ stockId, productId, amount, locationIdTo }, ['stockId', 'productId', 'amount', 'locationIdTo']);
+            this.validateRequired({ stockId, productId, amount, locationIdTo }, [
+                'stockId',
+                'productId',
+                'amount',
+                'locationIdTo',
+            ]);
             const stockEntryResponse = await this.apiCall(`/stock/entry/${stockId}`);
             if (!stockEntryResponse || !stockEntryResponse.product_id) {
-                throw new Error(`Could not resolve product ID from stock entry ${stockId}`);
+                throw new ValidationError(`Could not resolve product ID from stock entry ${stockId}`, 'transferStockEntry');
             }
             if (stockEntryResponse.product_id !== productId) {
-                throw new Error(`Product ID mismatch: stock entry ${stockId} belongs to product ${stockEntryResponse.product_id}, but ${productId} was provided`);
+                throw new ValidationError(`Product ID mismatch: stock entry ${stockId} belongs to product ${stockEntryResponse.product_id}, but ${productId} was provided`, 'transferStockEntry');
             }
             const body = {
                 amount,
                 location_id_from: stockEntryResponse.location_id,
                 location_id_to: locationIdTo,
                 transaction_type: 'transfer',
-                stock_entry_id: stockEntryResponse.stock_id
+                stock_entry_id: stockEntryResponse.stock_id,
             };
             if (note)
                 body.note = note;
@@ -411,15 +424,15 @@ export class InventoryToolHandlers extends BaseToolHandler {
             this.validateRequired({ stockId, productId, amount }, ['stockId', 'productId', 'amount']);
             const stockEntryResponse = await this.apiCall(`/stock/entry/${stockId}`);
             if (!stockEntryResponse || !stockEntryResponse.product_id) {
-                throw new Error(`Could not resolve product ID from stock entry ${stockId}`);
+                throw new ValidationError(`Could not resolve product ID from stock entry ${stockId}`, 'openStockEntry');
             }
             if (stockEntryResponse.product_id !== productId) {
-                throw new Error(`Product ID mismatch: stock entry ${stockId} belongs to product ${stockEntryResponse.product_id}, but ${productId} was provided`);
+                throw new ValidationError(`Product ID mismatch: stock entry ${stockId} belongs to product ${stockEntryResponse.product_id}, but ${productId} was provided`, 'openStockEntry');
             }
             const body = {
                 amount,
                 stock_entry_id: stockEntryResponse.stock_id,
-                location_id: stockEntryResponse.location_id
+                location_id: stockEntryResponse.location_id,
             };
             if (note)
                 body.note = note;

package/build/tools/inventory/index.js

@@ -26,7 +26,7 @@ export const inventoryModule = {
         // Granular Stock Entry Operations
         inventory_stock_entry_consume: handlers.consumeStockEntry,
         inventory_stock_entry_transfer: handlers.transferStockEntry,
-        inventory_stock_entry_open: handlers.openStockEntry
-    }
+        inventory_stock_entry_open: handlers.openStockEntry,
+    },
 };
 export * from './definitions.js';

package/build/tools/module-loader.js

@@ -23,9 +23,9 @@ export class ModuleLoader {
         try {
             const toolsDir = __dirname;
             this.discoveredFolders = readdirSync(toolsDir, { withFileTypes: true })
-                .filter(dirent => dirent.isDirectory())
-                .filter(dirent => !dirent.name.startsWith('.') && dirent.name !== 'node_modules')
-                .map(dirent => dirent.name);
+                .filter((dirent) => dirent.isDirectory())
+                .filter((dirent) => !dirent.name.startsWith('.') && dirent.name !== 'node_modules')
+                .map((dirent) => dirent.name);
             logger.module(`Discovered ${this.discoveredFolders.length} tool folders`);
         }
         catch (error) {
@@ -41,7 +41,7 @@ export class ModuleLoader {
         const folders = this.discoverFolders();
         const toolModules = [];
         // Load modules in parallel for better performance
-        const loadPromises = folders.map(folder => this.loadModule(folder));
+        const loadPromises = folders.map((folder) => this.loadModule(folder));
         const results = await Promise.allSettled(loadPromises);
         results.forEach((result, index) => {
             const folder = folders[index];
@@ -51,7 +51,7 @@ export class ModuleLoader {
             }
             else if (result.status === 'rejected') {
                 logger.debug(`Failed to load module ${folder}`, 'MODULE', {
-                    error: result.reason
+                    error: result.reason,
                 });
             }
         });
@@ -97,11 +97,14 @@ export class ModuleLoader {
      * Check if an export looks like a ToolModule
      */
     static isToolModule(obj) {
-        return obj &&
-            typeof obj === 'object' &&
-            Array.isArray(obj.definitions) &&
-            typeof obj.handlers === 'object' &&
-            obj.definitions.length > 0;
+        if (obj === null || typeof obj !== 'object') {
+            return false;
+        }
+        const m = obj;
+        return (Array.isArray(m.definitions) &&
+            m.definitions.length > 0 &&
+            typeof m.handlers === 'object' &&
+            m.handlers !== null);
     }
     /**
      * Get module from cache
@@ -125,7 +128,7 @@ export class ModuleLoader {
         return {
             total: this.moduleCache.size,
             loaded,
-            errors
+            errors,
         };
     }
 }
@@ -146,6 +149,6 @@ export async function createToolRegistry() {
         getDefinitions: () => definitions,
         getHandler: (name) => handlers[name],
         getValidator: (name) => validators[name],
-        getToolNames: () => definitions.map(def => def.name)
+        getToolNames: () => definitions.map((def) => def.name),
     };
 }