queryKeyHelpers.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 {ShopperBasketsV2} from 'commerce-sdk-isomorphic'
import {Argument, ExcludeTail} from '../types'
import {pickValidParams} from '../utils'

// We must use a client with no parameters in order to have required/optional match the API spec
type Client = ShopperBasketsV2<{shortCode: string}>
type Params<T extends keyof QueryKeys> = Partial<Argument<Client[T]>['parameters']>
export type QueryKeys = {
    getBasket: [
        '/commerce-sdk-react',
        '/organizations/',
        string | undefined,
        '/baskets/v2/',
        string | undefined,
        Params<'getBasket'>
    ]
    getPaymentMethodsForBasket: [
        '/commerce-sdk-react',
        '/organizations/',
        string | undefined,
        '/baskets/v2/',
        string | undefined,
        '/payment-methods',
        Params<'getPaymentMethodsForBasket'>
    ]
    getPriceBooksForBasket: [
        '/commerce-sdk-react',
        '/organizations/',
        string | undefined,
        '/baskets/v2/',
        string | undefined,
        '/price-books',
        Params<'getPriceBooksForBasket'>
    ]
    getShippingMethodsForShipment: [
        '/commerce-sdk-react',
        '/organizations/',
        string | undefined,
        '/baskets/v2/',
        string | undefined,
        '/shipments/',
        string | undefined,
        '/shipping-methods',
        Params<'getShippingMethodsForShipment'>
    ]
    getTaxesFromBasket: [
        '/commerce-sdk-react',
        '/organizations/',
        string | undefined,
        '/baskets/v2/',
        string | undefined,
        '/taxes',
        Params<'getTaxesFromBasket'>
    ]
}

// This is defined here, rather than `types.ts`, because it relies on `Client` and `QueryKeys`,
// and making those generic would add too much complexity.
type QueryKeyHelper<T extends keyof QueryKeys> = {
    /** Generates the path component of the query key for an endpoint. */
    path: (params: Params<T>) => ExcludeTail<QueryKeys[T]>
    /** Generates the full query key for an endpoint. */
    queryKey: (params: Params<T>) => QueryKeys[T]
}

export const getBasket: QueryKeyHelper<'getBasket'> = {
    path: (params) => [
        '/commerce-sdk-react',
        '/organizations/',
        params?.organizationId,
        '/baskets/v2/',
        params?.basketId
    ],
    queryKey: (params: Params<'getBasket'>) => {
        return [
            ...getBasket.path(params),
            pickValidParams(params || {}, ShopperBasketsV2.paramKeys.getBasket)
        ]
    }
}

export const getPaymentMethodsForBasket: QueryKeyHelper<'getPaymentMethodsForBasket'> = {
    path: (params) => [
        '/commerce-sdk-react',
        '/organizations/',
        params?.organizationId,
        '/baskets/v2/',
        params?.basketId,
        '/payment-methods'
    ],
    queryKey: (params: Params<'getPaymentMethodsForBasket'>) => {
        return [
            ...getPaymentMethodsForBasket.path(params),
            pickValidParams(params || {}, ShopperBasketsV2.paramKeys.getPaymentMethodsForBasket)
        ]
    }
}

export const getPriceBooksForBasket: QueryKeyHelper<'getPriceBooksForBasket'> = {
    path: (params) => [
        '/commerce-sdk-react',
        '/organizations/',
        params?.organizationId,
        '/baskets/v2/',
        params?.basketId,
        '/price-books'
    ],
    queryKey: (params: Params<'getPriceBooksForBasket'>) => {
        return [
            ...getPriceBooksForBasket.path(params),
            pickValidParams(params || {}, ShopperBasketsV2.paramKeys.getPriceBooksForBasket)
        ]
    }
}

export const getShippingMethodsForShipment: QueryKeyHelper<'getShippingMethodsForShipment'> = {
    path: (params) => [
        '/commerce-sdk-react',
        '/organizations/',
        params?.organizationId,
        '/baskets/v2/',
        params?.basketId,
        '/shipments/',
        params?.shipmentId,
        '/shipping-methods'
    ],
    queryKey: (params: Params<'getShippingMethodsForShipment'>) => {
        return [
            ...getShippingMethodsForShipment.path(params),
            pickValidParams(params || {}, ShopperBasketsV2.paramKeys.getShippingMethodsForShipment)
        ]
    }
}

export const getTaxesFromBasket: QueryKeyHelper<'getTaxesFromBasket'> = {
    path: (params) => [
        '/commerce-sdk-react',
        '/organizations/',
        params?.organizationId,
        '/baskets/v2/',
        params?.basketId,
        '/taxes'
    ],
    queryKey: (params: Params<'getTaxesFromBasket'>) => {
        return [
            ...getTaxesFromBasket.path(params),
            pickValidParams(params || {}, ShopperBasketsV2.paramKeys.getTaxesFromBasket)
        ]
    }
}