xcraft-core-pickaxe 0.1.4 → 0.1.6

package/lib/operator-to-sql.js

@@ -21,6 +21,9 @@ const operators = {
     if (typeof value === 'boolean') {
       return value ? 'TRUE' : 'FALSE';
     }
+    if (!values) {
+      return escape(value);
+    }
     values.push(value);
     return '?';
   },
@@ -121,6 +124,24 @@ const operators = {
     return `(${sqlConditions.join(' OR ')})`;
   },
 
+  abs({value}, values) {
+    return `ABS(${sql(value, values)})`;
+  },
+
+  plus({values: list}, values) {
+    return `(${list
+      .map((value) => sql(value, values))
+      .filter(Boolean)
+      .join(' + ')})`;
+  },
+
+  minus({values: list}, values) {
+    return `(${list
+      .map((value) => sql(value, values))
+      .filter(Boolean)
+      .join(' - ')})`;
+  },
+
   length({list}, values) {
     return `json_array_length(${sql(list, values)})`;
   },
@@ -174,6 +195,33 @@ const operators = {
   desc({value}, values) {
     return `${sql(value, values)} DESC`;
   },
+
+  count({field, distinct}, values) {
+    if (!field) {
+      return `COUNT(*)`;
+    }
+    return `COUNT(${distinct ? 'DISTINCT ' : ''}${sql(field, values)})`;
+  },
+
+  avg({field}, values) {
+    return `AVG(${sql(field, values)})`;
+  },
+
+  max({field}, values) {
+    return `MAX(${sql(field, values)})`;
+  },
+
+  min({field}, values) {
+    return `MIN(${sql(field, values)})`;
+  },
+
+  sum({field, distinct}, values) {
+    return `SUM(${distinct ? 'DISTINCT ' : ''}${sql(field, values)})`;
+  },
+
+  groupArray({field}, values) {
+    return `json_group_array(${sql(field, values)})`;
+  },
 };
 
 /**
@@ -189,7 +237,7 @@ function getOperator(operatorOrPick) {
 
 /**
  * @param {Operator | AnyPick} operatorOrPick
- * @param {any[]} values
+ * @param {any[] | null} values
  * @returns {string}
  */
 function sql(operatorOrPick, values) {

package/lib/operators.js

@@ -1,5 +1,13 @@
+/* eslint-disable jsdoc/require-returns */
 // @ts-check
 
+const {number, array} = require('xcraft-core-stones');
+
+/**
+ * @template {AnyTypeOrShape} T
+ * @typedef {import("./picks.js").ValuePick<T>} ValuePick
+ */
+
 function op(value) {
   if (value === null) {
     return operators.null();
@@ -160,6 +168,33 @@ const operators = {
     });
   },
 
+  abs(value) {
+    value = op(value);
+    return /** @type {const} */ ({
+      operator: 'abs',
+      type: number,
+      value,
+    });
+  },
+
+  plus(...values) {
+    values = values.map(op);
+    return /** @type {const} */ ({
+      operator: 'plus',
+      type: number,
+      values,
+    });
+  },
+
+  minus(...values) {
+    values = values.map(op);
+    return /** @type {const} */ ({
+      operator: 'minus',
+      type: number,
+      values,
+    });
+  },
+
   length(list) {
     return /** @type {const} */ ({
       operator: 'length',
@@ -223,6 +258,75 @@ const operators = {
       value,
     });
   },
+
+  count(field, distinct) {
+    return /** @type {const} */ ({
+      operator: 'count',
+      type: number,
+      field,
+      distinct,
+    });
+  },
+
+  /**
+   * @template {AnyTypeOrShape} T
+   * @param {ValuePick<T>} field
+   */
+  avg(field) {
+    return /** @type {const} */ ({
+      operator: 'avg',
+      type: field.type,
+      field: field.value,
+    });
+  },
+
+  /**
+   * @template {AnyTypeOrShape} T
+   * @param {ValuePick<T>} field
+   */
+  max(field) {
+    return /** @type {const} */ ({
+      operator: 'max',
+      type: field.type,
+      field: field.value,
+    });
+  },
+
+  /**
+   * @template {AnyTypeOrShape} T
+   * @param {ValuePick<T>} field
+   */
+  min(field) {
+    return /** @type {const} */ ({
+      operator: 'min',
+      type: field.type,
+      field: field.value,
+    });
+  },
+
+  /**
+   * @template {AnyTypeOrShape} T
+   * @param {ValuePick<T>} field
+   */
+  sum(field) {
+    return /** @type {const} */ ({
+      operator: 'sum',
+      type: field.type,
+      field: field.value,
+    });
+  },
+
+  /**
+   * @template {AnyTypeOrShape} T
+   * @param {ValuePick<T>} field
+   */
+  groupArray(field) {
+    return /** @type {const} */ ({
+      operator: 'groupArray',
+      type: array(field.type),
+      field: field.value,
+    });
+  },
 };
 
 /**

package/lib/picks.js

@@ -12,6 +12,7 @@ const {
   number,
   StringType,
   string,
+  NumberType,
 } = require('xcraft-core-stones');
 
 const $o = require('./operators.js');
@@ -49,7 +50,7 @@ const $o = require('./operators.js');
 
 /**
  * @template {Type} T
- * @typedef { [T] extends [ArrayType<infer V>] ? ArrayPick<V> : [T] extends [ObjectType<infer S>] ? ObjectPick<S> : [T] extends [ObjectMapType<infer V>] ? RecordPick<StringType,V> : [T] extends [RecordType<infer K,infer V>] ? RecordPick<K,V> : ValuePick<T>} PickOfType
+ * @typedef { [T] extends [ArrayType<infer V>] ? ArrayPick<V> : [T] extends [ObjectType<infer S>] ? ObjectPick<S> : [T] extends [ObjectMapType<infer V>] ? RecordPick<StringType,V> : [T] extends [RecordType<infer K,infer V>] ? RecordPick<K,V> : [T] extends [NumberType] ? NumberPick : ValuePick<T>} PickOfType
  */
 /**
  * @template {AnyTypeOrShape} T
@@ -155,6 +156,29 @@ class ValuePick {
   }
 }
 
+/**
+ * @extends {ValuePick<NumberType>}
+ */
+class NumberPick extends ValuePick {
+  abs() {
+    return $o.abs(this.value);
+  }
+
+  /**
+   * @param {number | ValuePick<NumberType>} value
+   */
+  plus(value) {
+    return $o.plus(this.value, value);
+  }
+
+  /**
+   * @param {number | ValuePick<NumberType>} value
+   */
+  minus(value) {
+    return $o.minus(this.value, value);
+  }
+}
+
 /**
  * @template {ObjectShape} T
  */
@@ -340,7 +364,7 @@ class ArrayPick {
   }
 
   get length() {
-    return new ValuePick(number, {
+    return new NumberPick(number, {
       field: $o.length(this.value),
       path: [],
     });
@@ -437,6 +461,9 @@ function makeTypePick(type, context) {
   if (type instanceof RecordType) {
     return /** @type {any} */ (new RecordPick(type, context));
   }
+  if (type instanceof NumberType) {
+    return /** @type {any} */ (new NumberPick(type, context));
+  }
   return /** @type {any} */ (new ValuePick(type, context));
 }
 

package/lib/query-builder.js

@@ -28,6 +28,28 @@ const {queryToSql} = require('./query-to-sql.js');
  * @typedef {import("./picks.js").Path} Path
  */
 
+/**
+ * @typedef {Operators["count"] | Operators["avg"] | Operators["max"] | Operators["min"] | Operators["sum"] | Operators["groupArray"]} Aggregator
+ */
+/**
+ * @typedef {Operators["abs"] | Operators["plus"] | Operators["minus"]} MathOperator
+ */
+
+/**
+ * @typedef {AnyPick | Aggregator | MathOperator} SelectValue
+ */
+/**
+ * @template T
+ * @typedef {T extends SelectValue ? T["type"]: never} SelectValueType
+ */
+/**
+ * @typedef {Record<string, SelectValue> | [SelectValue, ...SelectValue[]]} SelectResult
+ */
+/**
+ * @template {SelectResult} T
+ * @typedef {{[K in keyof T]: t<SelectValueType<T[K]>>}} QueryResultOf
+ */
+
 /**
  * @typedef {ValuePick<any> | Operators["desc"] | Operators["asc"]} OrderByValue
  */
@@ -35,15 +57,21 @@ const {queryToSql} = require('./query-to-sql.js');
  * @typedef {OrderByValue | OrderByValue[]} OrderByResult
  */
 
+/**
+ * @typedef {ValuePick<any> | ValuePick<any>[]} GroupByResult
+ */
+
 /**
  * @typedef {{
  *   db: string,
  *   from: string,
  *   scope?: ObjectPick<any>
- *   select: Record<string, AnyPick>,
+ *   select: SelectResult,
  *   selectOneField?: boolean,
+ *   distinct?: boolean,
  *   where?: Operator,
- *   orderBy?: OrderByResult
+ *   orderBy?: OrderByResult,
+ *   groupBy?: GroupByResult
  * }} QueryObj
  */
 
@@ -76,7 +104,10 @@ class FinalQuery {
   }
 
   #useRaw() {
-    return Boolean(this.#queryParts.selectOneField);
+    return (
+      Array.isArray(this.#queryParts.select) ||
+      Boolean(this.#queryParts.selectOneField)
+    );
   }
 
   #getStatement() {
@@ -156,6 +187,10 @@ class FinalQuery {
     return this.#queryParts;
   }
 
+  sql() {
+    return queryToSql(this.#queryParts, false).sql;
+  }
+
   /**
    * @returns {R | undefined}
    */
@@ -173,6 +208,24 @@ class FinalQuery {
     return Array.from(this.#getStatement().iterate(), mapRow);
   }
 
+  #resultIsEntry() {
+    return (
+      Array.isArray(this.#queryParts.select) &&
+      this.#queryParts.select.length === 2
+    );
+  }
+
+  /**
+   * @returns {R extends [infer K, infer V] ? Record<K,V> : never}
+   */
+  toObject() {
+    if (!this.#resultIsEntry()) {
+      throw new Error('Select result must be a [key,value] entry');
+    }
+    const entries = /** @type {[any, any]} */ (this.all());
+    return /** @type {any} */ (Object.fromEntries(entries));
+  }
+
   /**
    * @returns {Generator<R>}
    */
@@ -206,6 +259,17 @@ class ScopedSelectQuery extends FinalQuery {
     this.#queryParts = queryParts;
   }
 
+  /**
+   * @returns {ScopedSelectQuery<T,R>}
+   */
+  distinct() {
+    const queryParts = {
+      ...this.#queryParts,
+      distinct: true,
+    };
+    return new ScopedSelectQuery(this.#database, this.#type, queryParts);
+  }
+
   /**
    * @param {(obj: ObjectPick<T>, $: typeof operators) => Operator} fct
    * @returns {ScopedSelectQuery<T,R>}
@@ -231,6 +295,19 @@ class ScopedSelectQuery extends FinalQuery {
     };
     return new ScopedSelectQuery(this.#database, this.#type, queryParts);
   }
+
+  /**
+   * @param {(obj: ObjectPick<T>, $: typeof operators) => GroupByResult} fct
+   * @returns {ScopedSelectQuery<T,R>}
+   */
+  groupBy(fct) {
+    const scope = this.#queryParts.scope;
+    const queryParts = {
+      ...this.#queryParts,
+      groupBy: fct(scope, operators),
+    };
+    return new ScopedSelectQuery(this.#database, this.#type, queryParts);
+  }
 }
 
 /**
@@ -255,6 +332,17 @@ class SelectQuery extends FinalQuery {
     this.#queryParts = queryParts;
   }
 
+  /**
+   * @returns {SelectQuery<T,R>}
+   */
+  distinct() {
+    const queryParts = {
+      ...this.#queryParts,
+      distinct: true,
+    };
+    return new SelectQuery(this.#database, this.#type, queryParts);
+  }
+
   /**
    * @param {(obj: RowPick<T>, $: typeof operators) => Operator} fct
    * @returns {SelectQuery<T,R>}
@@ -271,7 +359,7 @@ class SelectQuery extends FinalQuery {
   }
 
   /**
-   * @param {(obj: RowPick<T>, $: typeof operators) => ValuePick<any> | ValuePick<any>[]} fct
+   * @param {(obj: RowPick<T>, $: typeof operators) => OrderByResult} fct
    * @returns {SelectQuery<T,R>}
    */
   orderBy(fct) {
@@ -281,6 +369,18 @@ class SelectQuery extends FinalQuery {
     };
     return new SelectQuery(this.#database, this.#type, queryParts);
   }
+
+  /**
+   * @param {(obj: RowPick<T>, $: typeof operators) => GroupByResult} fct
+   * @returns {SelectQuery<T,R>}
+   */
+  groupBy(fct) {
+    const queryParts = {
+      ...this.#queryParts,
+      groupBy: fct(rowPick(this.#type), operators),
+    };
+    return new SelectQuery(this.#database, this.#type, queryParts);
+  }
 }
 
 /**
@@ -336,15 +436,15 @@ class ScopedFromQuery {
   }
 
   /**
-   * @template {Record<string, AnyPick>} R
-   * @param {(obj: ObjectPick<T>) => R} fct
-   * @returns {ScopedSelectQuery<T, t<{[K in keyof R]: R[K]["type"]}>>}
+   * @template {SelectResult} R
+   * @param {(obj: ObjectPick<T>, $: typeof operators) => R} fct
+   * @returns {ScopedSelectQuery<T, QueryResultOf<R>>}
    */
   select(fct) {
     const scope = this.#queryParts.scope;
     const queryParts = {
       ...this.#queryParts,
-      select: fct(scope),
+      select: fct(scope, operators),
     };
     return new ScopedSelectQuery(this.#database, this.#type, queryParts);
   }
@@ -414,14 +514,14 @@ class FromQuery {
   }
 
   /**
-   * @template {Record<string, AnyPick>} R
-   * @param {(obj: RowPick<T>) => R} fct
-   * @returns {SelectQuery<T, t<{[K in keyof R]: R[K]["type"]}>>}
+   * @template {SelectResult} R
+   * @param {(obj: RowPick<T>, $: typeof operators) => R} fct
+   * @returns {SelectQuery<T, QueryResultOf<R>>}
    */
   select(fct) {
     const queryParts = {
       ...this.#queryParts,
-      select: fct(rowPick(this.#type)),
+      select: fct(rowPick(this.#type), operators),
     };
     return new SelectQuery(this.#database, this.#type, queryParts);
   }

package/lib/query-to-sql.js

@@ -7,10 +7,13 @@ const {sql} = require('./operator-to-sql.js');
 
 /**
  * @param {QueryObj["select"]} select
- * @param {any[]} values
+ * @param {any[] | null} values
  * @returns {string}
  */
 function selectFields(select, values) {
+  if (Array.isArray(select)) {
+    return select.map((value) => sql(value, values)).join(', ');
+  }
   return Object.entries(select)
     .map(([name, value]) => `${sql(value, values)} AS ${name}`)
     .join(', ');
@@ -18,7 +21,7 @@ function selectFields(select, values) {
 
 /**
  * @param {NonNullable<QueryObj["orderBy"]>} orderBy
- * @param {any[]} values
+ * @param {any[] | null} values
  * @returns {string}
  */
 function orderByFields(orderBy, values) {
@@ -28,13 +31,27 @@ function orderByFields(orderBy, values) {
   return sql(orderBy, values);
 }
 
+/**
+ * @param {NonNullable<QueryObj["groupBy"]>} groupBy
+ * @param {any[] | null} values
+ * @returns {string}
+ */
+function groupByFields(groupBy, values) {
+  if (Array.isArray(groupBy)) {
+    return groupBy.map((value) => sql(value, values)).join(', ');
+  }
+  return sql(groupBy, values);
+}
+
 /**
  * @param {QueryObj} query
- * @returns {{sql: string, values: any[]}}
+ * @param {boolean} [useBindedValues=true]
+ * @returns {{sql: string, values: any[] | null}}
  */
-function queryToSql(query) {
-  const values = [];
-  let result = `SELECT ${selectFields(query.select, values)}`;
+function queryToSql(query, useBindedValues = true) {
+  const values = useBindedValues ? [] : null;
+  const distinct = query.distinct ? 'DISTINCT ' : '';
+  let result = `SELECT ${distinct}${selectFields(query.select, values)}`;
   result += '\n' + `FROM ${query.from}`;
   if (query.where) {
     result += '\n' + `WHERE ${sql(query.where, values)}`;
@@ -42,6 +59,9 @@ function queryToSql(query) {
   if (query.orderBy) {
     result += '\n' + `ORDER BY ${orderByFields(query.orderBy, values)}`;
   }
+  if (query.groupBy) {
+    result += '\n' + `GROUP BY ${groupByFields(query.groupBy, values)}`;
+  }
   return {sql: result, values};
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xcraft-core-pickaxe",
-  "version": "0.1.4",
+  "version": "0.1.6",
   "description": "Query builder",
   "main": "index.js",
   "scripts": {