build-query-string.js

/* @flow */
import type { ServiceBuilderDefaultParams } from 'types/sdk'

/**
 * Build the query string with the given parameters.
 *
 * @param  {Object} params - An object with query / search parameters.
 * @throws If argument is missing.
 * @return {string} The fully encoded query string.
 */
export default function buildQueryString(
  params: ServiceBuilderDefaultParams
): string {
  if (!params) throw new Error('Missing options object to build query string.')

  const {
    query,
    pagination,
    search,
    expand,
    staged,
    priceCurrency,
    priceCountry,
    priceCustomerGroup,
    priceChannel,
    searchKeywords,
    version,
    customerId,
    cartId,
    location,
    dataErasure,
    applyOrderEditTo,
  } = params
  let queryString = []

  if (customerId) queryString.push(`customerId=${customerId}`)

  if (cartId) queryString.push(`cartId=${cartId}`)

  if (typeof staged === 'boolean')
    queryString.push(`staged=${staged.toString()}`)

  if (priceCurrency) queryString.push(`priceCurrency=${priceCurrency}`)

  if (priceCountry) queryString.push(`priceCountry=${priceCountry}`)

  if (priceCustomerGroup)
    queryString.push(`priceCustomerGroup=${priceCustomerGroup}`)

  if (priceChannel) queryString.push(`priceChannel=${priceChannel}`)

  if (expand && expand.length)
    queryString = queryString.concat(
      expand.map((e: string): string => `expand=${e}`)
    )

  if (query) {
    const { operator, where } = query
    const whereParams = where.join(encodeURIComponent(` ${operator} `))
    if (whereParams) queryString.push(`where=${whereParams}`)
  }

  if (location) {
    const { country, currency, state } = location
    if (country) queryString.push(`country=${country}`)
    if (currency) queryString.push(`currency=${currency}`)
    if (state) queryString.push(`state=${state}`)
  }

  if (pagination) {
    const { page, perPage, sort, withTotal } = pagination
    if (typeof perPage === 'number') queryString.push(`limit=${perPage}`)
    if (page) {
      const limitParam = perPage || 20
      const offsetParam = limitParam * (page - 1)
      queryString.push(`offset=${offsetParam}`)
    }
    if (sort && sort.length)
      queryString = queryString.concat(
        sort.map((s: string): string => `sort=${s}`)
      )

    if (typeof withTotal === 'boolean')
      queryString.push(`withTotal=${String(withTotal)}`)
  }

  if (search) {
    const {
      text,
      fuzzy,
      fuzzyLevel,
      markMatchingVariants,
      facet,
      filter,
      filterByQuery,
      filterByFacets,
    } = search

    if (text) queryString.push(`text.${text.lang}=${text.value}`)
    if (fuzzy) queryString.push('fuzzy=true')
    if (fuzzyLevel) queryString.push(`fuzzyLevel=${fuzzyLevel}`)
    queryString.push(`markMatchingVariants=${markMatchingVariants.toString()}`)

    facet.forEach((f: string): number => queryString.push(`facet=${f}`))
    filter.forEach((f: string): number => queryString.push(`filter=${f}`))
    filterByQuery.forEach((f: string): number =>
      queryString.push(`filter.query=${f}`)
    )
    filterByFacets.forEach((f: string): number =>
      queryString.push(`filter.facets=${f}`)
    )
  }

  if (searchKeywords)
    searchKeywords.forEach((f: { lang: string, value: string }): number =>
      queryString.push(`searchKeywords.${f.lang}=${f.value}`)
    )

  if (version) queryString.push(`version=${version}`)

  if (dataErasure) queryString.push(dataErasure)

  if (applyOrderEditTo) queryString.push(`/${applyOrderEditTo}/apply`)

  return queryString.join('&')
}