import type {RenderExtensionTarget} from '../extension-targets';
import type {CheckoutToken} from '../api/standard/standard';

import {useApi} from './api';
import {useSubscription} from './subscription';

/**
 * A stable id that represents the current checkout.
 *
 * Matches the `token` field in the [WebPixel checkout payload](https://shopify.dev/docs/api/pixels/customer-events#checkout)
 * and the `checkout_token` field in the [Admin REST API Order resource](https://shopify.dev/docs/api/admin-rest/unstable/resources/order#resource-object).
 */
export function useCheckoutToken<
  Target extends RenderExtensionTarget = RenderExtensionTarget,
>(): CheckoutToken | undefined {
  return useSubscription(useApi<Target>().checkoutToken);
}