All files / src/hooks/mutations useAddShoppingListItemMutation.ts

100% Statements 12/12
100% Branches 6/6
100% Functions 5/5
100% Lines 11/11

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73                                                                                            3x 16x   16x   8x   6x 3x     3x     3x       3x 3x     5x        
// src/hooks/mutations/useAddShoppingListItemMutation.ts
import { useMutation, useQueryClient } from '@tanstack/react-query';
import * as apiClient from '../../services/apiClient';
import { notifySuccess, notifyError } from '../../services/notificationService';
import { queryKeyBases } from '../../config/queryKeys';
 
interface AddShoppingListItemParams {
  listId: number;
  item: {
    masterItemId?: number;
    customItemName?: string;
  };
}
 
/**
 * Mutation hook for adding an item to a shopping list.
 *
 * This hook provides automatic cache invalidation. When the mutation succeeds,
 * it invalidates the shopping-lists query to trigger a refetch of the updated list.
 *
 * Items can be added by either masterItemId (for master grocery items) or
 * customItemName (for custom items not in the master list).
 *
 * @returns Mutation object with mutate function and state
 *
 * @example
 * ```tsx
 * const addShoppingListItem = useAddShoppingListItemMutation();
 *
 * // Add master item
 * const handleAddMasterItem = () => {
 *   addShoppingListItem.mutate({
 *     listId: 1,
 *     item: { masterItemId: 42 }
 *   });
 * };
 *
 * // Add custom item
 * const handleAddCustomItem = () => {
 *   addShoppingListItem.mutate({
 *     listId: 1,
 *     item: { customItemName: 'Special Brand Milk' }
 *   });
 * };
 * ```
 */
export const useAddShoppingListItemMutation = () => {
  const queryClient = useQueryClient();
 
  return useMutation({
    mutationFn: async ({ listId, item }: AddShoppingListItemParams) => {
      const response = await apiClient.addShoppingListItem(listId, item);
 
      if (!response.ok) {
        const error = await response.json().catch(() => ({
          message: `Request failed with status ${response.status}`,
        }));
        throw new Error(error.message || 'Failed to add item to shopping list');
      }
 
      return response.json();
    },
    onSuccess: () => {
      // Invalidate and refetch shopping lists to get the updated list
      queryClient.invalidateQueries({ queryKey: queryKeyBases.shoppingLists });
      notifySuccess('Item added to shopping list');
    },
    onError: (error: Error) => {
      notifyError(error.message || 'Failed to add item to shopping list');
    },
  });
};