next-sql/lib/builder.js

Next-gen SQL connector, easy way to query SQL and create relationship linked object.

/** @typedef { import('./') } xsql */
/** @typedef { import('../clients/mysql').Row } Row */

const is = require('./is')

/** @typedef { {[key: string]: any } } KeyValuePair */
/** @typedef {("="|"<"|">"|"<="|"=>"|"<>"|"like"|"between"|"in"|"find_in_set"|"not"|"not like"|"not between"|"not in"|"is not")} Operator */
/** @typedef {("AND"|"OR")} Connector */

/** @enum {string} */
const TYPE = {
  BRACKET_START: 'BRACKET_START',
  BRACKET_END: 'BRACKET_END',
  NORMAL: 'NORMAL',
  RAW: 'RAW',
}

/**
 * @typedef {Object} Condition
 * @property {TYPE} type
 * @property {string} field
 * @property {Operator} operator
 * @property {Connector} connector
 */

/**
 * @this xsql
 * @param {Condition} condition
 */
function _addCondition(condition) {
  this._state.conditions.push(condition)
}
/**
 * @this xsql
 * @param {(string|KeyValuePair|(q: xsql) => {})} input
 * @param {Operator} operator
 */
function _addWhereClause(input, operator, value, connector = 'AND') {
  if (is.fn(input)) {
    this._addCondition({ type: TYPE.BRACKET_START, connector })
    input(this)
    this._addCondition({ type: TYPE.BRACKET_END })
    return this
  }
  if (is.string(input) && is.array(operator)) {
    this._addCondition({
      type: TYPE.RAW,
      field: input,
      value: operator,
      connector,
    })
    return this
  }
  if (is.plainObject(input)) {
    Object.keys(input).forEach((key) => {
      this._addCondition({
        type: TYPE.NORMAL,
        field: key,
        operator: '=',
        value: input[key],
        connector,
      })
    })
    return this
  }
  this._addCondition({
    type: TYPE.NORMAL,
    field: input,
    operator: operator.toLowerCase(),
    value,
    connector,
  })
  return this
}

/**
 * ```js
 * xsql()
 *   .where({ id: 1 })
 *   .where('id', '=', 1)
 *   .where('id', '>', 1)
 *   .where('id', 'find_in_set', 1)
 *   .where('id', 'between', [1,2])
 *   .where('id', 'in', [1,2])
 *   .where('name', 'like', '%john%')
 *   .where('id = ? AND age > ?', [1, 18])
 *   .where('money > 0', [])
 *   .where('MATCH(title, content) AGAINST(? IN NATURAL LANGUAGE MODE)', [keyword])
 * ```
 * @this xsql
 * @param {(string|KeyValuePair|(q: xsql) => {})} input
 * @param {Operator|Array} operator
 * @param {*} value
 * @returns {xsql}
 */
function where(input, operator, value) {
  return this._addWhereClause(input, operator, value)
}

/** @type {where} */
function and(input, operator, value) {
  return this._addWhereClause(input, operator, value)
}

/** @type {where} */
function or(input, operator, value) {
  return this._addWhereClause(input, operator, value, 'OR')
}

/**
 * @this xsql
 * @param {('*'|string|string[])} input
 */
function select(input = '*') {
  this._state.select = is.array(input)
    ? input.join(', ')
    : input
  return this
}

/**
 * Before fetch relationship
 * @this xsql
 * @param { (row: Row) => Row } cb
 */
function filter(cb) {
  this._state.filter = cb
  return this
}

/**
 * After fetch relationship
 * @this xsql
 * @param { (row: Row) => Row } cb
 */
function map(cb) {
  this._state.map = cb
  return this
}

/**
 * @this xsql
 * @param {('*'|string|string[])} input
 */
function groupBy(input) {
  this._state.groupBy = is.array(input)
    ? input.join(', ')
    : input
  return this
}

/**
 * @this xsql
 * @param {('*'|string)} input
 */
function having(input) {
  this._state.having = input
  return this
}

/**
 * @this xsql
 * @param {('*'|string|string[])} input
 */
function orderBy(input) {
  this._state.orderBy = is.array(input)
    ? input.join(', ')
    : input
  return this
}

/**
 * @this xsql
 * @param {number} input
 */
function limit(input) {
  this._state.limit = input
  return this
}

/**
 * @this xsql
 * @param {number} input
 */
function offset(input) {
  this._state.offset = input
  return this
}

/**
 * @this xsql
 * @param {boolean} input
 */
function log(input) {
  this._state.log = input
  return this
}

/**
 * @this xsql
 * @param {(q:xsql)=>void} extendsFn
 */
function extend(extendsFn) {
  extendsFn(this)
  return this
}

module.exports = {
  TYPE,
  _addCondition,
  _addWhereClause,
  where,
  and,
  or,
  select,
  filter,
  map,
  groupBy,
  having,
  orderBy,
  limit,
  offset,
  log,
  extend,
}