All files / src/hooks/mutations useUpdateShoppingListItemMutation.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                                                                                          3x 20x   20x   10x   9x 3x     3x     6x       6x 6x     4x        
// src/hooks/mutations/useUpdateShoppingListItemMutation.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';
import type { ShoppingListItem } from '../../types';
 
interface UpdateShoppingListItemParams {
  itemId: number;
  updates: Partial<
    Pick<ShoppingListItem, 'custom_item_name' | 'quantity' | 'is_purchased' | 'notes'>
  >;
}
 
/**
 * Mutation hook for updating a shopping list item.
 *
 * This hook provides automatic cache invalidation. When the mutation succeeds,
 * it invalidates the shopping-lists query to trigger a refetch of the updated list.
 *
 * You can update: custom_item_name, quantity, is_purchased, notes.
 *
 * @returns Mutation object with mutate function and state
 *
 * @example
 * ```tsx
 * const updateShoppingListItem = useUpdateShoppingListItemMutation();
 *
 * // Mark item as purchased
 * const handlePurchase = () => {
 *   updateShoppingListItem.mutate({
 *     itemId: 42,
 *     updates: { is_purchased: true }
 *   });
 * };
 *
 * // Update quantity
 * const handleQuantityChange = () => {
 *   updateShoppingListItem.mutate({
 *     itemId: 42,
 *     updates: { quantity: 3 }
 *   });
 * };
 * ```
 */
export const useUpdateShoppingListItemMutation = () => {
  const queryClient = useQueryClient();
 
  return useMutation({
    mutationFn: async ({ itemId, updates }: UpdateShoppingListItemParams) => {
      const response = await apiClient.updateShoppingListItem(itemId, updates);
 
      if (!response.ok) {
        const error = await response.json().catch(() => ({
          message: `Request failed with status ${response.status}`,
        }));
        throw new Error(error.message || 'Failed to update shopping list item');
      }
 
      return response.json();
    },
    onSuccess: () => {
      // Invalidate and refetch shopping lists to get the updated list
      queryClient.invalidateQueries({ queryKey: queryKeyBases.shoppingLists });
      notifySuccess('Shopping list item updated');
    },
    onError: (error: Error) => {
      notifyError(error.message || 'Failed to update shopping list item');
    },
  });
};