xcraft-core-pickaxe 0.1.6 → 0.1.9

package/lib/operator-to-sql.js

@@ -166,6 +166,15 @@ const operators = {
     )`;
   },
 
+  query({query}, values) {
+    const {queryToSql} = require('./query-to-sql.js');
+    return `(${queryToSql(query, values).sql})`;
+  },
+
+  each({value}, values) {
+    return `json_each(${sql(value, values)})`;
+  },
+
   eachValue(_, values) {
     return 'json_each.value';
   },

package/lib/operators.js

@@ -19,6 +19,10 @@ function op(value) {
   if (type === 'object' && 'operator' in value) {
     return value;
   }
+  const {ValuePick} = require('./picks.js');
+  if (value instanceof ValuePick) {
+    return value.value;
+  }
 
   throw new Error(`Bad value '${value}'`);
 }
@@ -219,6 +223,20 @@ const operators = {
     });
   },
 
+  query(query) {
+    return /** @type {const} */ ({
+      operator: 'query',
+      query,
+    });
+  },
+
+  each(value) {
+    return /** @type {const} */ ({
+      operator: 'each',
+      value,
+    });
+  },
+
   eachValue() {
     return /** @type {const} */ ({
       operator: 'eachValue',
@@ -342,4 +360,11 @@ const operators = {
  * @typedef {Values<{[k in keyof typeof operators] : ReturnType<typeof operators[k]>}>} Operator
  */
 
+/**
+ * @typedef {Operators["count"] | Operators["avg"] | Operators["max"] | Operators["min"] | Operators["sum"] | Operators["groupArray"]} Aggregator
+ */
+/**
+ * @typedef {Operators["abs"] | Operators["plus"] | Operators["minus"]} MathOperator
+ */
+
 module.exports = operators;

package/lib/picks.js

@@ -19,9 +19,8 @@ const $o = require('./operators.js');
 
 /**
  * @typedef {import('./operators.js').Operators} Operators
- */
-/**
  * @typedef {import('./operators.js').Operator} Operator
+ * @typedef {import('./operators.js').Aggregator} Aggregator
  */
 
 /**
@@ -301,6 +300,27 @@ class RecordPick {
     return $o.not(this.some((...args) => $o.not(func(...args))));
   }
 
+  /**
+   * @param {(value: PickOf<V>, key: PickOf<K>) => Aggregator} fct
+   */
+  select(fct) {
+    return $o.query({
+      from: $o.each(this.value),
+      select: [
+        fct(
+          makePick(this.#type.valuesType, {
+            field: $o.eachValue(),
+            path: [],
+          }),
+          makePick(this.#type.keysType, {
+            field: $o.eachKey(),
+            path: [],
+          })
+        ),
+      ],
+    });
+  }
+
   /**
    * @returns {ArrayPick<K>}
    */
@@ -398,6 +418,23 @@ class ArrayPick {
   every(func) {
     return $o.not(this.some((...args) => $o.not(func(...args))));
   }
+
+  /**
+   * @param {(value: PickOf<T>) => Aggregator} fct
+   */
+  select(fct) {
+    return $o.query({
+      from: $o.each(this.value),
+      select: [
+        fct(
+          makePick(this.#type.valuesType, {
+            field: $o.eachValue(),
+            path: [],
+          })
+        ),
+      ],
+    });
+  }
 }
 
 /**

package/lib/query-builder.js

@@ -6,34 +6,21 @@ const {
   toObjectType,
   ObjectMapType,
   RecordType,
+  object,
 } = require('xcraft-core-stones');
 const operators = require('./operators.js');
 const {rowPick, ValuePick, RowPick, ObjectPick} = require('./picks.js');
 const {queryToSql} = require('./query-to-sql.js');
-/**
- * @typedef {import("./operators.js").Operator} Operator
- */
 /**
  * @typedef {import("./operators.js").Operators} Operators
+ * @typedef {import("./operators.js").Operator} Operator
+ * @typedef {import("./operators.js").Aggregator} Aggregator
+ * @typedef {import("./operators.js").MathOperator} MathOperator
  */
 
-/**
- * @template {AnyTypeOrShape} T
- * @typedef {import("./picks.js").PickOf<T>} PickOf
- */
 /**
  * @typedef {import("./picks.js").AnyPick} AnyPick
  */
-/**
- * @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
@@ -72,6 +59,8 @@ const {queryToSql} = require('./query-to-sql.js');
  *   where?: Operator,
  *   orderBy?: OrderByResult,
  *   groupBy?: GroupByResult
+ *   limit?: number
+ *   offset?: number
  * }} QueryObj
  */
 
@@ -127,6 +116,7 @@ class FinalQuery {
     if (
       type instanceof ArrayType ||
       type instanceof ObjectType ||
+      type === object ||
       type instanceof ObjectMapType ||
       type instanceof RecordType
     ) {
@@ -188,7 +178,7 @@ class FinalQuery {
   }
 
   sql() {
-    return queryToSql(this.#queryParts, false).sql;
+    return queryToSql(this.#queryParts, null).sql;
   }
 
   /**
@@ -308,6 +298,30 @@ class ScopedSelectQuery extends FinalQuery {
     };
     return new ScopedSelectQuery(this.#database, this.#type, queryParts);
   }
+
+  /**
+   * @param {number} count
+   * @returns {ScopedSelectQuery<T,R>}
+   */
+  limit(count) {
+    const queryParts = {
+      ...this.#queryParts,
+      limit: count,
+    };
+    return new ScopedSelectQuery(this.#database, this.#type, queryParts);
+  }
+
+  /**
+   * @param {number} count
+   * @returns {ScopedSelectQuery<T,R>}
+   */
+  offset(count) {
+    const queryParts = {
+      ...this.#queryParts,
+      offset: count,
+    };
+    return new ScopedSelectQuery(this.#database, this.#type, queryParts);
+  }
 }
 
 /**
@@ -381,6 +395,30 @@ class SelectQuery extends FinalQuery {
     };
     return new SelectQuery(this.#database, this.#type, queryParts);
   }
+
+  /**
+   * @param {number} count
+   * @returns {SelectQuery<T,R>}
+   */
+  limit(count) {
+    const queryParts = {
+      ...this.#queryParts,
+      limit: count,
+    };
+    return new SelectQuery(this.#database, this.#type, queryParts);
+  }
+
+  /**
+   * @param {number} count
+   * @returns {SelectQuery<T,R>}
+   */
+  offset(count) {
+    const queryParts = {
+      ...this.#queryParts,
+      offset: count,
+    };
+    return new SelectQuery(this.#database, this.#type, queryParts);
+  }
 }
 
 /**

package/lib/query-to-sql.js

@@ -45,14 +45,16 @@ function groupByFields(groupBy, values) {
 
 /**
  * @param {QueryObj} query
- * @param {boolean} [useBindedValues=true]
+ * @param {any[] | null} [values]
  * @returns {{sql: string, values: any[] | null}}
  */
-function queryToSql(query, useBindedValues = true) {
-  const values = useBindedValues ? [] : null;
+function queryToSql(query, values = []) {
   const distinct = query.distinct ? 'DISTINCT ' : '';
+  // Note: query.from is not validated
+  const from =
+    typeof query.from === 'string' ? query.from : sql(query.from, values);
   let result = `SELECT ${distinct}${selectFields(query.select, values)}`;
-  result += '\n' + `FROM ${query.from}`;
+  result += '\n' + `FROM ${from}`;
   if (query.where) {
     result += '\n' + `WHERE ${sql(query.where, values)}`;
   }
@@ -62,6 +64,18 @@ function queryToSql(query, useBindedValues = true) {
   if (query.groupBy) {
     result += '\n' + `GROUP BY ${groupByFields(query.groupBy, values)}`;
   }
+  if (query.limit) {
+    if (!Number.isInteger(query.limit)) {
+      throw new Error(`Bad limit '${query.limit}'`);
+    }
+    result += '\n' + `LIMIT ${query.limit}`;
+  }
+  if (query.offset) {
+    if (!Number.isInteger(query.offset)) {
+      throw new Error(`Bad offset '${query.offset}'`);
+    }
+    result += '\n' + `OFFSET ${query.offset}`;
+  }
   return {sql: result, values};
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xcraft-core-pickaxe",
-  "version": "0.1.6",
+  "version": "0.1.9",
   "description": "Query builder",
   "main": "index.js",
   "scripts": {
@@ -22,7 +22,7 @@
   "devDependencies": {
     "prettier": "2.0.4",
     "xcraft-dev-prettier": "^2.0.0",
-    "xcraft-dev-rules": "^4.1.0"
+    "xcraft-dev-rules": "^4.3.0"
   },
   "prettier": "xcraft-dev-prettier"
 }