evrythng/src/util/buildParams.js

Official Javascript SDK for the EVRYTHNG API.

import isPlainObject from 'lodash-es/isPlainObject'

const SPECIALS = ['&', '|', '!', '>', '<', '=', '~', '(', ')', ',']
const SPECIALS_REGEXP = new RegExp(`[${SPECIALS.join('\\')}]`, 'g')
const SPECIALS_ESCAPE = '\\$&'

/**
 * Build url safe parameter string if an object provided.
 *
 * @export
 * @param {(Object | string)} [params] key-value object or final query string
 * @param {boolean} [useEncoding] whether to skip encoding
 * @returns {string}
 */
export default function buildParams (params = {}, useEncoding = true) {
  return isPlainObject(params)
    ? Object.entries(params).map(buildParam(useEncoding)).join('&')
    : params
}

/**
 * Returns reducer function that adds the encoded key-value params to
 * accumulator.
 *
 * @param {boolean} useEncoding
 * @returns {Function}
 */
function buildParam (useEncoding) {
  const encode = uriEncoder(useEncoding)
  return ([key, value]) => {
    return `${encode(key)}=${encode(buildParams(value))}`
  }
}

/**
 * Returns function that encodes values using encodeURIComponent.
 *
 * @param {boolean} useEncoding
 * @returns {Function}
 */
function uriEncoder (useEncoding) {
  return (value) => (useEncoding ? encodeURIComponent(value) : escapeSpecials(value))
}

/**
 * Escape special characters in value with the backslash (\) character.
 *
 * @param {string} value
 * @returns {string}
 */
function escapeSpecials (value) {
  return value.replace(SPECIALS_REGEXP, SPECIALS_ESCAPE)
}