helpers.ts

/*
 * Copyright (c) 2023, Salesforce, Inc.
 * All rights reserved.
 * SPDX-License-Identifier: BSD-3-Clause
 * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
 */

import {useCustomerId, useShopperBasketsMutation} from '../index'
import {useCustomerBaskets} from '../ShopperCustomers'
import {ApiClients, Argument} from '../types'
import {ShopperBasketsTypes} from 'commerce-sdk-isomorphic'
import {CLIENT_KEYS} from '../../constant'

const CLIENT_KEY = CLIENT_KEYS.SHOPPER_BASKETS
type Client = NonNullable<ApiClients[typeof CLIENT_KEY]>
type Basket = ShopperBasketsTypes.Basket

/**
 * This is a helper function for Basket Mutations.
 * useShopperBasketsMutationHelper.addItemToNewOrExistingBasket: is responsible for managing the process of adding an item to a basket.
 *  - If a basket already exists, add the item to the basket immediately.
 *  - If a basket does not exist, create a new basket using the createBasket mutation
 * and then add the item to the newly created basket using the addItemToBasket mutation.
 *
 * @example
 * import useShopperBasketsMutationHelper from '@salesforce/commerce-sdk-react'
 *
 * const Page = () => {
 *      const helpers = useShopperBasketsMutationHelper()
 *
 *      const addToCart = async () => {
 *          const productItems = [{id: 123, quantity: 2}]
 *          await basketMutationHelpers.addItemToNewOrExistingBasket(productItems)
 *      }
 *
 * }
 */
export function useShopperBasketsMutationHelper() {
    const customerId = useCustomerId()
    const {data: basketsData} = useCustomerBaskets(
        {parameters: {customerId}},
        {
            enabled: !!customerId
        }
    )
    const createBasket = useShopperBasketsMutation('createBasket')
    const addItemToBasketMutation = useShopperBasketsMutation('addItemToBasket')
    return {
        addItemToNewOrExistingBasket: async (
            productItem: Argument<Client['addItemToBasket']> extends {body: infer B} ? B : undefined
        ): Promise<Basket> => {
            if (basketsData && basketsData.total > 0) {
                // we know that if basketData.total > 0, current basket will always be available
                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
                const currentBasket = basketsData?.baskets && basketsData.baskets[0]!
                return await addItemToBasketMutation.mutateAsync({
                    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
                    parameters: {basketId: currentBasket!.basketId!},
                    body: productItem
                })
            } else {
                const data = await createBasket.mutateAsync({
                    body: {}
                })
                if (!data || !data.basketId) {
                    throw Error('Something is wrong. Please try again')
                } else {
                    return await addItemToBasketMutation.mutateAsync({
                        parameters: {basketId: data.basketId},
                        body: productItem
                    })
                }
            }
        }
    }
}