@shopify/shop-minis-react/src/hooks/user/useSavedProducts.ts

React component library for Shopify Shop Minis with Tailwind CSS v4 support (source-only, requires TypeScript)

import {useShopActionInfiniteQuery} from '../../internal/reactQuery'
import {useShopActions} from '../../internal/useShopActions'
import {
  PaginatedDataHookOptionsBase,
  PaginatedDataHookReturnsBase,
  Product,
} from '../../types'

export interface UseSavedProductsParams extends PaginatedDataHookOptionsBase {
  includeSensitive?: boolean
}

export interface UseSavedProductsReturns extends PaginatedDataHookReturnsBase {
  products: Product[] | null
}

/**
 * Hook to fetch saved (favorited) products.
 * @param params - Options for the hook.
 */
export const useSavedProducts = (
  params?: UseSavedProductsParams
): UseSavedProductsReturns => {
  const {getSavedProducts} = useShopActions()
  const {skip, ...shopActionParams} = params ?? {}

  const {data, ...rest} = useShopActionInfiniteQuery(
    ['savedProducts', shopActionParams],
    getSavedProducts,
    shopActionParams,
    {skip}
  )

  return {
    ...rest,
    products: data,
  }
}