All files / src/hooks/mutations useDeleteShoppingListMutation.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                                                                  3x 12x   12x   6x   5x 3x     3x     2x       2x 2x     4x        
// src/hooks/mutations/useDeleteShoppingListMutation.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 DeleteShoppingListParams {
  listId: number;
}
 
/**
 * Mutation hook for deleting 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.
 *
 * @returns Mutation object with mutate function and state
 *
 * @example
 * ```tsx
 * const deleteShoppingList = useDeleteShoppingListMutation();
 *
 * const handleDelete = (listId: number) => {
 *   deleteShoppingList.mutate(
 *     { listId },
 *     {
 *       onSuccess: () => console.log('Deleted!'),
 *       onError: (error) => console.error(error),
 *     }
 *   );
 * };
 * ```
 */
export const useDeleteShoppingListMutation = () => {
  const queryClient = useQueryClient();
 
  return useMutation({
    mutationFn: async ({ listId }: DeleteShoppingListParams) => {
      const response = await apiClient.deleteShoppingList(listId);
 
      if (!response.ok) {
        const error = await response.json().catch(() => ({
          message: `Request failed with status ${response.status}`,
        }));
        throw new Error(error.message || 'Failed to delete shopping list');
      }
 
      return response.json();
    },
    onSuccess: () => {
      // Invalidate and refetch shopping lists to get the updated list
      queryClient.invalidateQueries({ queryKey: queryKeyBases.shoppingLists });
      notifySuccess('Shopping list deleted');
    },
    onError: (error: Error) => {
      notifyError(error.message || 'Failed to delete shopping list');
    },
  });
};