@storecraft/database-sql-base 1.0.23 → 1.2.5

package/src/con.shared.js

@@ -46,9 +46,9 @@ export const safe_trx = (k) => {
 
 
 /**
+ * @template {keyof Database} [T=(keyof Database)]  
  * @param {SQL} driver 
- * @param {QueryableTables} table_name 
- * 
+ * @param {T} table_name 
  * @returns {db_crud["count"]}
  */
 export const count_regular = (driver, table_name) => {
@@ -71,7 +71,6 @@ export const count_regular = (driver, table_name) => {
 }
 
 /**
- * 
  * @param {string} id_or_handle
  */
 export const where_id_or_handle_entity = (id_or_handle) => {
@@ -87,7 +86,6 @@ export const where_id_or_handle_entity = (id_or_handle) => {
 }
 
 /**
- * 
  * @param {string} id_or_handle
  */
 export const where_id_or_handle_table = (id_or_handle) => {
@@ -148,7 +146,9 @@ export const delete_entity_values_by_value_or_reporter_and_context = (
    */
   return (trx, value, reporter, context) => {
 
-    return trx.deleteFrom(entity_table_name).where(
+    return trx
+    .deleteFrom(entity_table_name)
+    .where(
       eb => eb.or(
         [
           value && eb('value', '=', value),
@@ -196,7 +196,9 @@ export const delete_entity_values_of_by_entity_id_or_handle_and_context = (
    * @param {string} [context=undefined] the context (another segment technique)
    */
   return (trx, entity_id, entity_handle=undefined, context=undefined) => {
-    return trx.deleteFrom(entity_table_name).where(
+    return trx
+    .deleteFrom(entity_table_name)
+    .where(
       eb => eb.or(
         [
           entity_id && eb('entity_id', '=', entity_id),
@@ -316,18 +318,18 @@ export const delete_media_of = delete_entity_values_of_by_entity_id_or_handle_an
 
 
 /**
- * @template {keyof Database} T
- * 
+ * @template {keyof Database} [T=(keyof Database)]
  * @param {Kysely<Database>} trx 
  * @param {T} table_name 
  * @param {InsertObject<Database, T> & {id: string, handle: string}} item values of the entity
- * 
  */
 export const regular_upsert_me = async (trx, table_name, item) => {
 
   // TODO: maybe use only `id`
-  await trx.deleteFrom(table_name).where(
-    eb => eb.or(
+  await trx
+  .deleteFrom(table_name)
+  .where(
+    (eb) => eb.or(
       [
         // @ts-ignore
         item?.id && eb('id', '=', item.id),
@@ -337,7 +339,10 @@ export const regular_upsert_me = async (trx, table_name, item) => {
     )
   ).execute();
 
-  return await trx.insertInto(table_name).values(item).executeTakeFirst()
+  return await trx
+  .insertInto(table_name)
+  .values(item)
+  .executeTakeFirst()
 }
 
 
@@ -725,26 +730,3 @@ export const select_values_of_entity_by_entity_id_or_handle =
   )
   .orderBy(`${entity_junction_table}.id`);
 }
-
-// /**
-//  * select the entity ids which are constrained by value or reporter
-//  * 
-//  * @param {ExpressionBuilder<Database>} eb 
-//  * @param {EntityTableKeys} entity_junction_table 
-//  * @param {string | ExpressionWrapper<Database>} value 
-//  * @param {string | ExpressionWrapper<Database>} [reporter] 
-//  */
-// export const select_entity_ids_by_value_or_reporter = 
-// (eb, entity_junction_table, value, reporter=undefined) => {
-//   return eb
-//     .selectFrom(entity_junction_table)
-//     .select(`${entity_junction_table}.entity_id`)
-//     .where(eb2 => eb2.or(
-//         [
-//           eb2(`${entity_junction_table}.value`, '=', value ?? reporter),
-//           eb2(`${entity_junction_table}.reporter`, '=', reporter ?? value),
-//         ]
-//       )
-//     )
-//     .orderBy(`${entity_junction_table}.entity_id`);
-// }

package/src/con.shipping.js

@@ -9,7 +9,7 @@ import { count_regular, delete_entity_values_by_value_or_reporter_and_context,
   insert_tags_of, regular_upsert_me, where_id_or_handle_table, 
   with_media, with_search, with_tags } from './con.shared.js'
 import { sanitize, sanitize_array } from './utils.funcs.js'
-import { query_to_eb, query_to_sort } from './utils.query.js'
+import { withQuery } from './utils.query.js'
 
 export const table_name = 'shipping_methods'
 
@@ -111,24 +111,22 @@ const remove = (driver) => {
 const list = (driver) => {
   return async (query) => {
 
-    const items = await driver.client
+    const items = await withQuery(
+      driver.client
       .selectFrom(table_name)
       .selectAll()
-      .select(eb => [
-        with_media(eb, eb.ref('shipping_methods.id'), driver.dialectType),
-        with_tags(eb, eb.ref('shipping_methods.id'), driver.dialectType),
-        with_search(eb, eb.ref('shipping_methods.id'), driver.dialectType),
-      ].filter(Boolean))
-      .where(
-        (eb) => {
-          return query_to_eb(eb, query, table_name);
-        }
-      )
-      .orderBy(query_to_sort(query, 'shipping_methods'))
-      .limit(query.limitToLast ?? query.limit ?? 10)
-      .execute();
+      .select(
+        eb => [
+          with_media(eb, eb.ref('shipping_methods.id'), driver.dialectType),
+          with_tags(eb, eb.ref('shipping_methods.id'), driver.dialectType),
+          with_search(eb, eb.ref('shipping_methods.id'), driver.dialectType),
+        ].filter(Boolean)
+      ),
+      query, table_name
+    ).execute();
 
-    if(query.limitToLast) items.reverse();
+    if(query.limitToLast) 
+      items.reverse();
     
     return sanitize_array(items);
   }

package/src/con.storefronts.js

@@ -20,7 +20,7 @@ import { delete_entity_values_of_by_entity_id_or_handle_and_context,
   products_with_variants,
   products_with_related_products} from './con.shared.js'
 import { sanitize, sanitize_array } from './utils.funcs.js'
-import { query_to_eb, query_to_sort } from './utils.query.js'
+import { withQuery } from './utils.query.js'
 
 export const table_name = 'storefronts'
 
@@ -193,7 +193,8 @@ const list = (driver) => {
     const expand_shipping = expand_all || expand.includes('shipping_methods');
     const expand_posts = expand_all || expand.includes('posts');
 
-    const items = await driver.client
+    const items = await withQuery(
+      driver.client
       .selectFrom(table_name)
       .selectAll()
       .select(eb => [
@@ -216,17 +217,12 @@ const list = (driver) => {
             eb, eb.ref('storefronts.id'), driver.dialectType
           ),
         ].filter(Boolean)
-      )
-      .where(
-        (eb) => {
-          return query_to_eb(eb, query, table_name);
-        }
-      )
-      .orderBy(query_to_sort(query, table_name))
-      .limit(query.limitToLast ?? query.limit ?? 10)
-      .execute();
+      ),
+      query, table_name
+    ).execute();
 
-    if(query.limitToLast) items.reverse();
+    if(query.limitToLast) 
+      items.reverse();
 
     return sanitize_array(items);
   }
@@ -268,7 +264,7 @@ const get_default_auto_generated_storefront = (driver) => {
             ]
           )
           .where('active', '=', 1)
-          .orderBy(['updated_at desc']),
+          .orderBy('updated_at', 'desc'),
           driver.dialectType
         ).as('collections'),
   
@@ -287,7 +283,7 @@ const get_default_auto_generated_storefront = (driver) => {
             ]
           )
           .where('active', '=', 1)
-          .orderBy(['updated_at desc'])
+          .orderBy('updated_at', 'desc')
           .limit(10),
           dialectType
         ).as('products'),
@@ -303,7 +299,7 @@ const get_default_auto_generated_storefront = (driver) => {
             ]
           )
           .where('active', '=', 1)
-          .orderBy(['updated_at desc']),
+          .orderBy('updated_at', 'desc'),
           dialectType
         ).as('discounts'),
   
@@ -318,7 +314,7 @@ const get_default_auto_generated_storefront = (driver) => {
             ]
           )
           .where('active', '=', 1)
-          .orderBy(['updated_at desc']),
+          .orderBy('updated_at', 'desc'),
           dialectType
         ).as('shipping_methods'),
   
@@ -333,13 +329,14 @@ const get_default_auto_generated_storefront = (driver) => {
             ]
           )
           .where('active', '=', 1)
-          .orderBy(['updated_at desc'])
+          .orderBy('updated_at', 'desc')
           .limit(3),
           dialectType
         ).as('posts'),
   
         stringArrayFrom(
-          eb.selectFrom('products')
+          eb
+          .selectFrom('products')
           .innerJoin(
             'entity_to_tags_projections', 
             'entity_to_tags_projections.entity_id', 

package/src/con.tags.js

@@ -8,7 +8,7 @@ import {
   with_media, with_search
 } from './con.shared.js'
 import { sanitize, sanitize_array } from './utils.funcs.js'
-import { query_to_eb, query_to_sort } from './utils.query.js'
+import { withQuery } from './utils.query.js'
 
 export const table_name = 'tags'
 
@@ -97,22 +97,21 @@ const remove = (driver) => {
 const list = (driver) => {
   return async (query) => {
 
-    const items = await driver.client
+    const items = await withQuery(
+      driver.client
       .selectFrom(table_name)
       .selectAll()
-      .select(eb => [
-        with_search(eb, eb.ref('tags.id'), driver.dialectType),
-      ].filter(Boolean))
-      .where(
-        (eb) => {
-          return query_to_eb(eb, query, table_name);
-        }
-      )
-      .orderBy(query_to_sort(query, table_name))
-      .limit(query.limitToLast ?? query.limit ?? 10)
-      .execute();
+      .select(
+        eb => [
+          with_search(eb, eb.ref('tags.id'), driver.dialectType),
+        ].filter(Boolean)
+      ),
+      query, table_name
+    ).execute();
+
+    if(query.limitToLast) 
+      items.reverse();
 
-    if(query.limitToLast) items.reverse();
     return sanitize_array(items);
   }
 }

package/src/con.templates.js

@@ -8,7 +8,7 @@ import { count_regular, delete_me, delete_search_of, insert_search_of,
   regular_upsert_me, safe_trx, where_id_or_handle_table, 
   with_search} from './con.shared.js'
 import { sanitize, sanitize_array } from './utils.funcs.js'
-import { query_to_eb, query_to_sort } from './utils.query.js'
+import { withQuery } from './utils.query.js'
 import { base64 } from '@storecraft/core/crypto';
 
 export const table_name = 'templates'
@@ -137,36 +137,33 @@ const remove = (driver) => {
 const list = (driver) => {
   return async (query) => {
 
-    const items = await driver.client
+    const items = await withQuery(
+      driver.client
       .selectFrom(table_name)
       .selectAll()
       .select(
         eb => [
           with_search(eb, eb.ref('templates.id'), driver.dialectType),
         ].filter(Boolean)
-      )
-      .where(
-        (eb) => {
-          return query_to_eb(eb, query, table_name);
-        }
-      )
-      .orderBy(query_to_sort(query, table_name))
-      .limit(query.limitToLast ?? query.limit ?? 10)
-      .execute()
-      .then(
-        (items) => {
-          return items.map(
-            (item) => {
-              item.template_html = decode_base64_if_needed(item.template_html);
-              item.template_text = decode_base64_if_needed(item.template_text);
-              item.template_subject = decode_base64_if_needed(item.template_subject);
-              return item;
-            }
-          )
-        }
-      );
+      ),
+      query, table_name
+    )
+    .execute()
+    .then(
+      (items) => {
+        return items.map(
+          (item) => {
+            item.template_html = decode_base64_if_needed(item.template_html);
+            item.template_text = decode_base64_if_needed(item.template_text);
+            item.template_subject = decode_base64_if_needed(item.template_subject);
+            return item;
+          }
+        )
+      }
+    );
 
-    if(query.limitToLast) items.reverse();
+    if(query.limitToLast) 
+      items.reverse();
     
     return sanitize_array(items);
   }

package/src/utils.query.OLD.js

@@ -0,0 +1,259 @@
+/**
+ * @import { ApiQuery, Cursor } from '@storecraft/core/api'
+ * @import { BOOLQL } from '@storecraft/core/vql/bool-ql'
+ * @import { Database } from '../types.sql.tables.js'
+ * @import { BinaryOperator, ExpressionBuilder } from 'kysely'
+ * @import {
+ *  DirectedOrderByStringReference, QueryableTables
+ * } from './utils.types.js'
+ */
+
+import { parse } from "@storecraft/core/vql/bool-ql";
+
+/**
+ * Convert an API Query cursor into mongo dialect, also sanitize.
+ * 
+ * 1. (a1, a2) >  (b1, b2) ==> (a1 > b1) || (a1=b1 & a2>b2)
+ * 2. (a1, a2) >= (b1, b2) ==> (a1 > b1) || (a1=b1 & a2>=b2)
+ * 3. (a1, a2, a3) >  (b1, b2, b3) ==> (a1 > b1) || (a1=b1 & a2>b2) || (a1=b1 & a2=b2 & a3>b3)
+ * 4. (a1, a2, a3) >= (b1, b2, b3) ==> (a1 > b1) || (a1=b1 & a2>b2) || (a1=b1 & a2=b2 & a3>=b3)
+ * 
+ * @param {ExpressionBuilder<Database>} eb 
+ * @param {Cursor} c 
+ * @param {'>' | '>=' | '<' | '<='} relation 
+ * @param {(x: [k: string, v: any]) => [k: string, v: any]} transformer 
+ * Your chance to change key and value
+ */
+export const query_cursor_to_eb = (
+  eb, c, relation, transformer=(x)=>x
+) => {
+
+  /** @type {BinaryOperator} */
+  let rel_key_1; // relation in last conjunction term in [0, n-1] disjunctions
+  /** @type {BinaryOperator} */
+  let rel_key_2; // relation in last conjunction term in last disjunction
+
+  if (relation==='>' || relation==='>=') {
+    rel_key_1 = rel_key_2 = '>';
+    if(relation==='>=')
+      rel_key_2='>=';
+  }
+  else if (relation==='<' || relation==='<=') {
+    rel_key_1 = rel_key_2 = '<';
+    if(relation==='<=')
+      rel_key_2='<=';
+  } else return undefined;
+
+  
+  const disjunctions = [];
+  // each disjunction clause
+  for (let ix = 0; ix < c.length; ix++) {
+    const is_last_disjunction = ix==c.length-1;
+    const conjunctions = [];
+    // each conjunction clause up until the last term (not inclusive)
+    for (let jx = 0; jx < ix; jx++) {
+      // the a_n=b_n
+      const r = transformer(c[jx]);
+      
+      // conjunctions.push({ [r[0]] : r[1] });
+      conjunctions.push(eb(r[0], '=', r[1]));
+    }
+
+    // Last conjunction term
+    const relation_key = is_last_disjunction ? rel_key_2 : rel_key_1;
+    const r = transformer(c[ix]);
+    // conjunctions.push({ [r[0]] : { [relation_key]: r[1] } });
+    conjunctions.push(eb(r[0], relation_key, r[1]));
+    // Add to disjunctions list
+    // disjunctions.push({ $and: conjunctions });
+    disjunctions.push(eb.and(conjunctions));
+  }
+
+  if(disjunctions.length==0)
+    return undefined;
+
+  // const result = {
+  //   $or: disjunctions
+  // };
+
+  return eb.or(disjunctions);
+
+  // return result;
+}
+
+
+/**
+ * @template {QueryableTables} T
+ * @param {ExpressionBuilder<Database>} eb 
+ * @param {BOOLQL.Node} node 
+ * @param {T} table_name 
+ */
+export const query_vql_node_to_eb = (eb, node, table_name) => {
+  if(node.op==='LEAF') {
+    // console.log('value', node.value)
+    return eb
+    .exists(
+      eb => eb
+      .selectFrom('entity_to_search_terms')
+      .select('id')
+      .where(
+        eb => eb.and(
+          [
+            eb.or(
+              [
+                eb(
+                  'entity_to_search_terms.entity_id', '=', 
+                  eb.ref(`${table_name}.id`)
+                ),
+                eb(
+                  `entity_to_search_terms.entity_handle`, '=', 
+                  eb.ref(`${table_name}.handle`)
+                ),
+              ]
+            ),
+            eb(
+              `entity_to_search_terms.value`, 'like', 
+              node.value.toLowerCase()
+            )
+          ]
+        )
+      )
+    )
+  }
+
+  let conjunctions = [];
+  for(let arg of node?.args) {
+    conjunctions.push(query_vql_node_to_eb(eb, arg, table_name));
+  }
+
+  switch (node.op) {
+    case '&':
+      return eb.and(conjunctions)
+    case '|':
+      return eb.or(conjunctions)
+    case '!':
+      return eb.not(conjunctions[0])
+    default:
+      throw new Error('VQL-failed')
+  }
+
+}
+
+
+/**
+ * 
+ * @param {[k: string, v: any]} kv 
+ * @param {keyof Database} table_name 
+ * @returns {[k: string, v: any]}  
+ */
+const transform_boolean_to_0_or_1 = (kv, table_name) => {
+
+  // console.log('transform_boolean_to_0_or_1', kv)
+  kv = [
+    table_name ? `${table_name}.${kv[0]}` : kv[0],
+    typeof kv[1] === 'boolean' ? (kv[1] ? 1 : 0) : kv[1]
+  ];
+
+  return kv;
+}
+
+/**
+ * Convert an API Query into dialect, also sanitize.
+ * 
+ * @template {any} [T=any]
+ * 
+ * @param {ExpressionBuilder<Database>} eb 
+ * @param {ApiQuery<T>} q 
+ * @param {QueryableTables} table_name 
+ * 
+ */
+export const query_to_eb = (eb, q={}, table_name) => {
+  const clauses = [];
+
+  const sort_sign = q.order === 'asc' ? 1 : -1;
+  const asc = sort_sign==1;
+  const transformer = (x) => transform_boolean_to_0_or_1(x, table_name);
+
+  // compute index clauses
+  // if(q.startAt) {
+  //   clauses.push(
+  //     query_cursor_to_eb(
+  //       eb, q.startAt, asc ? '>=' : '<=', transformer
+  //     )
+  //   );
+  // } else if(q.startAfter) {
+  //   clauses.push(
+  //     query_cursor_to_eb(
+  //       eb, q.startAfter, asc ? '>' : '<', transformer
+  //     )
+  //   );
+  // }
+
+  // if(q.endAt) {
+  //   clauses.push(
+  //     query_cursor_to_eb(
+  //       eb, q.endAt, asc ? '<=' : '>=', transformer
+  //     )
+  //   );
+  // } else if(q.endBefore) {
+  //   clauses.push(
+  //     query_cursor_to_eb(
+  //       eb, q.endBefore, asc ? '<' : '>', transformer
+  //     )
+  //   );
+  // }
+
+  // compute VQL clauses 
+  try {
+    if(q.vql && !q.vqlParsed) {
+      q.vqlParsed = parse(q.vql)
+    }
+  } catch(e) {
+    console.error('VQL parse error', e);
+  }
+
+  if(q.vqlParsed) {
+    const vql_clause = query_vql_node_to_eb(
+      eb, q.vqlParsed, table_name
+    );
+    vql_clause && 
+      clauses.push(vql_clause);
+  }
+
+  return eb.and(clauses);
+}
+
+const SIGN = {
+  '1': 'asc',
+  '-1': 'desc'
+}
+
+/**
+ * Convert an API Query into mongo dialect, also sanitize.
+ * @template {Record<string, any>} [Type=Record<string, any>]
+ * @template {keyof Database} [Table=keyof Database]
+ * 
+ * @param {ApiQuery<Type>} q 
+ * @param {Table} table 
+ * @returns {DirectedOrderByStringReference<Database, Table, Database[Table]>[]}
+ */
+export const query_to_sort = (q={}, table) => {
+  // const sort_sign = q.order === 'asc' ? 'asc' : 'desc';
+  // `reverse_sign=-1` means we need to reverse because of `limitToLast`
+  const reverse_sign = (q.limitToLast && !q.limit) ? -1 : 1;
+  const asc = q.order === 'asc';
+  const sort_sign = (asc ? 1 : -1) * reverse_sign;
+
+  // compute sort fields and order
+  const keys = q.sortBy?.length ? q.sortBy :  ['updated_at', 'id'];
+  const sort = keys.map(
+    s => table ? `${table}.${s} ${SIGN[sort_sign]}` : `${s} ${SIGN[sort_sign]}`
+  )
+  // it's too complicated to map each ket to table column.
+  // kysely was designed to do this in place
+  return (
+    /** @type {DirectedOrderByStringReference<Database, Table, Database[Table]>[]} */ (
+      sort
+    )
+  );
+}