xcraft-core-pickaxe 0.1.19 → 0.1.22

package/lib/examples.js

@@ -87,7 +87,6 @@ example1: {
 example2: {
   const userIds = ['user@toto', 'user@tata'];
   const builder = new QueryBuilder()
-    .db('test_db')
     .from('test_table', TestUserShape3)
     .fields(['firstname', 'age'])
     .where((user, $) =>
@@ -104,7 +103,6 @@ example2: {
 
 example3: {
   const builder = new QueryBuilder()
-    .db('test_db')
     .from('test_table', ActionShape(TestUserShape))
     .scope((row) => row.field('action').get('payload').get('state'))
     .fields(['firstname', 'age']);
@@ -119,7 +117,6 @@ example3: {
  */
 function queryAction(shape) {
   const builder = new QueryBuilder()
-    .db('test_db')
     .from('test_table', ActionShape(shape))
     .scope((row) => row.field('action').get('payload').get('state'));
   return /** @type {ScopedFromQuery<GetShape<T>>} */ (builder);

package/lib/join-operators.js

@@ -0,0 +1,21 @@
+const joinOperators = /** @type {const} */ ([
+  'join',
+  'left join',
+  'right join',
+  'full join',
+  'left outer join',
+  'right outer join',
+  'full outer join',
+  'inner join',
+  'cross join',
+  'natural join',
+  'natural left join',
+  'natural right join',
+  'natural full join',
+  'natural left outer join',
+  'natural right outer join',
+  'natural full outer join',
+  'natural inner join',
+]);
+
+module.exports = {joinOperators};

package/lib/operator-to-sql.js

@@ -32,9 +32,12 @@ const operators = {
     return 'NULL';
   },
 
-  field({field}, context) {
+  field({tableName, field}, context) {
     // Note: field is not validated
     if (typeof field === 'string') {
+      if (context.useTableNames && tableName) {
+        return `${tableName}.${field}`;
+      }
       return `${field}`;
     }
     return sql(field, context);
@@ -78,12 +81,25 @@ const operators = {
       .join(' || ')})`;
   },
 
+  stringLength({value}, context) {
+    return `LENGTH(${sql(value, context)})`;
+  },
+
+  substr({value, start, length}, context) {
+    const valueSql = sql(value, context);
+    const startSql = sql(start, context);
+    const lengthSql = length !== undefined ? `, ${sql(length, context)}` : '';
+    return `SUBSTR(${valueSql}, ${startSql}${lengthSql})`;
+  },
+
   eq({a, b}, context) {
-    return `${sql(a, context)} IS ${sql(b, context)}`;
+    const operator = context.equalOperator === '=' ? '=' : 'IS';
+    return `${sql(a, context)} ${operator} ${sql(b, context)}`;
   },
 
   neq({a, b}, context) {
-    return `${sql(a, context)} IS NOT ${sql(b, context)}`;
+    const operator = context.equalOperator === '=' ? '<>' : 'IS NOT';
+    return `${sql(a, context)} ${operator} ${sql(b, context)}`;
   },
 
   gte({a, b}, context) {
@@ -264,6 +280,8 @@ function getOperator(operatorOrPick) {
  * @typedef {{
  *   values: any[] | null,
  *   scope?: any,
+ *   useTableNames?: boolean,
+ *   equalOperator: 'IS' | '=',
  * }} OperatorToSqlContext
  */
 

package/lib/operators.js

@@ -41,9 +41,10 @@ const operators = {
     });
   },
 
-  field(field) {
+  field(field, tableName) {
     return /** @type {const} */ ({
       operator: 'field',
+      tableName,
       field,
     });
   },
@@ -79,6 +80,28 @@ const operators = {
     });
   },
 
+  stringLength(value) {
+    value = op(value);
+    return /** @type {const} */ ({
+      operator: 'stringLength',
+      value,
+    });
+  },
+
+  substr(value, start, length) {
+    value = op(value);
+    start = op(start);
+    if (length !== undefined) {
+      length = op(length);
+    }
+    return /** @type {const} */ ({
+      operator: 'substr',
+      value,
+      start,
+      length,
+    });
+  },
+
   eq(a, b) {
     a = op(a);
     b = op(b);
@@ -383,6 +406,9 @@ const operators = {
 /**
  * @typedef {Operators["count"] | Operators["avg"] | Operators["max"] | Operators["min"] | Operators["sum"] | Operators["groupArray"]} Aggregator
  */
+/**
+ * @typedef {Operators["eq"] | Operators["neq"] | Operators["and"] | Operators["or"] | Operators["not"] | Operators["gt"] | Operators["gte"] | Operators["lt"] | Operators["lte"] | Operators["in"] | Operators["includes"] | Operators["some"] | Operators["glob"] | Operators["like"] | Operators["match"]} BooleanOperator
+ */
 /**
  * @typedef {Operators["abs"] | Operators["plus"] | Operators["minus"]} MathOperator
  */

package/lib/picks.js

@@ -13,6 +13,10 @@ const {
   StringType,
   string,
   NumberType,
+  EnumerationType,
+  toObjectType,
+  boolean,
+  BooleanType,
 } = require('xcraft-core-stones');
 
 const $o = require('./operators.js');
@@ -21,6 +25,7 @@ const $o = require('./operators.js');
  * @typedef {import('./operators.js').Operators} Operators
  * @typedef {import('./operators.js').Operator} Operator
  * @typedef {import('./operators.js').Aggregator} Aggregator
+ * @typedef {import("./operators.js").BooleanOperator} BooleanOperator
  */
 
 /**
@@ -30,6 +35,10 @@ const $o = require('./operators.js');
  * @typedef {PathElement[]} Path
  */
 
+/**
+ * @typedef {ValuePick<BooleanType> | BooleanOperator} BooleanValue
+ */
+
 /**
  * @template T
  * @template {keyof T} K
@@ -39,7 +48,8 @@ const $o = require('./operators.js');
 /**
  * @typedef {{
  *   field: (keyof any) | SelectValues<Operators, "eachValue" | "eachKey" | "keys" | "values" | "length">,
- *   path: Path
+ *   path: Path,
+ *   tableName?: string
  * }} Context
  */
 
@@ -49,7 +59,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> : [T] extends [NumberType] ? NumberPick : 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 : [T] extends [StringType] ? StringPick : ValuePick<T>} PickOfType
  */
 /**
  * @template {AnyTypeOrShape} T
@@ -87,22 +97,33 @@ class ValuePick {
   }
 
   get value() {
-    const {field, path} = this.#context;
+    const {tableName, field, path} = this.#context;
     if (path.length > 0) {
-      return $o.get($o.field(field), path);
+      return $o.get($o.field(field, tableName), path);
     }
-    return $o.field(field);
+    return $o.field(field, tableName);
   }
 
   get type() {
     return this.#type;
   }
 
+  /**
+   * @template {AnyObjectShape} T
+   * @param {T} shape
+   */
+  asObject(shape) {
+    return new ObjectPick(toObjectType(shape), this.#context);
+  }
+
   /**
    * @param {t<T> | ValuePick<T>} value
    */
   eq(value) {
-    return $o.eq(this.value, value);
+    return new ValuePick(boolean, {
+      field: $o.eq(this.value, value),
+      path: [],
+    });
   }
 
   /**
@@ -147,6 +168,18 @@ class ValuePick {
     return $o.in(this.value, list);
   }
 
+  /**
+   * @param {any} value
+   */
+  match(value) {
+    return $o.match(this.value, value);
+  }
+}
+
+/**
+ * @extends {ValuePick<StringType>}
+ */
+class StringPick extends ValuePick {
   /**
    * @param {string | ValuePick<StringType>} value
    */
@@ -161,11 +194,22 @@ class ValuePick {
     return $o.glob(this.value, value);
   }
 
+  get length() {
+    return new NumberPick(number, {
+      field: $o.stringLength(this.value),
+      path: [],
+    });
+  }
+
   /**
-   * @param {any} value
+   * @param {number | ValuePick<NumberType>} start
+   * @param {number | ValuePick<NumberType>} [length]
    */
-  match(value) {
-    return $o.match(this.value, value);
+  substr(start, length) {
+    return new StringPick(string, {
+      field: $o.substr(this.value, start, length),
+      path: [],
+    });
   }
 }
 
@@ -174,21 +218,30 @@ class ValuePick {
  */
 class NumberPick extends ValuePick {
   abs() {
-    return $o.abs(this.value);
+    return new NumberPick(number, {
+      field: $o.abs(this.value),
+      path: [],
+    });
   }
 
   /**
    * @param {number | ValuePick<NumberType>} value
    */
   plus(value) {
-    return $o.plus(this.value, value);
+    return new NumberPick(number, {
+      field: $o.plus(this.value, value),
+      path: [],
+    });
   }
 
   /**
    * @param {number | ValuePick<NumberType>} value
    */
   minus(value) {
-    return $o.minus(this.value, value);
+    return new NumberPick(number, {
+      field: $o.minus(this.value, value),
+      path: [],
+    });
   }
 }
 
@@ -211,17 +264,21 @@ class ObjectPick {
   }
 
   get value() {
-    const {field, path} = this.#context;
+    const {tableName, field, path} = this.#context;
     if (path.length > 0) {
-      return $o.get($o.field(field), path);
+      return $o.get($o.field(field, tableName), path);
     }
-    return $o.field(field);
+    return $o.field(field, tableName);
   }
 
   get type() {
     return this.#type;
   }
 
+  toRowPick() {
+    return new RowPick(this.#type, this.#context);
+  }
+
   /**
    * @template {keyof T} K
    * @param {K} key
@@ -262,11 +319,11 @@ class RecordPick {
   }
 
   get value() {
-    const {field, path} = this.#context;
+    const {tableName, field, path} = this.#context;
     if (path.length > 0) {
-      return $o.get($o.field(field), path);
+      return $o.get($o.field(field, tableName), path);
     }
-    return $o.field(field);
+    return $o.field(field, tableName);
   }
 
   get type() {
@@ -375,11 +432,11 @@ class ArrayPick {
   }
 
   get value() {
-    const {field, path} = this.#context;
+    const {tableName, field, path} = this.#context;
     if (path.length > 0) {
-      return $o.get($o.field(field), path);
+      return $o.get($o.field(field, tableName), path);
     }
-    return $o.field(field);
+    return $o.field(field, tableName);
   }
 
   get type() {
@@ -412,7 +469,7 @@ class ArrayPick {
   }
 
   /**
-   * @param {(value: PickOf<T>) => Operator} func
+   * @param {(value: PickOf<T>) => BooleanValue} func
    */
   some(func) {
     return $o.some(
@@ -470,12 +527,16 @@ function isAnyPick(value) {
 class RowPick {
   /** @type {ObjectType<T>} */
   #type;
+  /** @type {Partial<Context>} */
+  #context;
 
   /**
    * @param {ObjectType<T>} type
+   * @param {Partial<Context>} context
    */
-  constructor(type) {
+  constructor(type, context) {
     this.#type = type;
+    this.#context = context;
   }
 
   /**
@@ -484,12 +545,29 @@ class RowPick {
    * @returns {PickOf<T[K]>}
    */
   field(fieldName) {
-    const context = {
-      field: fieldName,
-      path: [],
-    };
+    const context = this.#context.field
+      ? {
+          ...this.#context,
+          field: this.#context.field,
+          path: [...(this.#context.path ?? []), fieldName],
+        }
+      : {
+          ...this.#context,
+          field: fieldName,
+          path: [],
+        };
     return makePick(this.#type.properties[fieldName], context);
   }
+
+  /**
+   * Alias of field method to be symmetric with ObjectPick
+   * @template {keyof T} K
+   * @param {K} fieldName
+   * @returns {PickOf<T[K]>}
+   */
+  get(fieldName) {
+    return this.field(fieldName);
+  }
 }
 
 /**
@@ -515,6 +593,13 @@ function makeTypePick(type, context) {
   if (type instanceof NumberType) {
     return /** @type {any} */ (new NumberPick(type, context));
   }
+  if (
+    type instanceof StringType ||
+    (type instanceof EnumerationType &&
+      type.values.every((value) => typeof value === 'string'))
+  ) {
+    return /** @type {any} */ (new StringPick(type, context));
+  }
   return /** @type {any} */ (new ValuePick(type, context));
 }
 
@@ -532,10 +617,11 @@ function makePick(typeOrShape, context) {
 /**
  * @template {ObjectShape} T
  * @param {ObjectType<T>} type
+ * @param {string} [tableName]
  * @returns {RowPick<T>}
  */
-function rowPick(type) {
-  return new RowPick(type);
+function rowPick(type, tableName) {
+  return new RowPick(type, {tableName});
 }
 
 module.exports = {