@storecraft/database-sql-base 1.0.10 → 1.0.12

package/src/utils.funcs.js

@@ -1,3 +1,7 @@
+/**
+ * @import { ReplaceValuesOfKeys } from './utils.types.js'
+ */
+
 export const isDef = v => v!==undefined && v!==null;
 export const isUndef = v => !isDef(v);
 
@@ -19,14 +23,13 @@ export const delete_keys = (...keys) => {
   }
 }
 
+
+
 /**
  * Sanitize null/undefined valued keys
- * 
- * 
- * @template {Record<string, any>} T
- * 
- * 
+ * @template T
  * @param {T} o 
+ * @return {ReplaceValuesOfKeys<T, 'active' | 'confirmed_mail', boolean>}
  */
 export const sanitize = o => {
   for (const key in o) {
@@ -37,12 +40,19 @@ export const sanitize = o => {
       continue;
     }
     if(key==='active') {
+      // @ts-ignore
+      o[key] = Boolean(value);
+    }
+    else if(key==='confirmed_mail') {
+      // @ts-ignore
       o[key] = Boolean(value);
     }
     else if(key==='price') {
+      // @ts-ignore
       o[key] = parseFloat(value);
     }
     else if(key==='compare_at_price') {
+      // @ts-ignore
       o[key] = parseFloat(value);
     }
     else if(typeof value === 'object') {
@@ -50,6 +60,7 @@ export const sanitize = o => {
     }
   }
 
+  // @ts-ignore
   return o;
 }
 
@@ -62,10 +73,11 @@ export const sanitize = o => {
  * @param {T[]} arr 
  */
 export const sanitize_array = arr => {
+  const xx = []
   for(const p of arr) {
-    sanitize(p);
+    xx.push(sanitize(p));
   }
-  return arr;
+  return xx;
 }
 
 /**

package/src/utils.query.js

@@ -1,5 +1,8 @@
 /**
- * @typedef {import("../index.js").Database} Database
+ * @import { ApiQuery, Cursor } from '@storecraft/core/api'
+ * @import { VQL } from '@storecraft/core/vql'
+ * @import { Database } from '../types.sql.tables.js'
+ * @import { ExpressionBuilder } from 'kysely'
  */
 
 import { parse } from "@storecraft/core/vql";
@@ -12,8 +15,8 @@ import { parse } from "@storecraft/core/vql";
  * 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 {import("kysely").ExpressionBuilder<Database>} eb 
- * @param {import("@storecraft/core/api").Cursor} c 
+ * @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
  */
@@ -72,9 +75,10 @@ export const query_cursor_to_eb = (eb, c, relation, transformer=(x)=>x) => {
 
 
 /**
- * @param {import("kysely").ExpressionBuilder<Database>} eb 
- * @param {import("@storecraft/core/vql").VQL.Node} node 
- * @param {keyof Database} table_name 
+ * @template {keyof Database} T
+ * @param {ExpressionBuilder<Database>} eb 
+ * @param {VQL.Node} node 
+ * @param {T} table_name 
  */
 export const query_vql_node_to_eb = (eb, node, table_name) => {
   if(node.op==='LEAF') {
@@ -119,8 +123,8 @@ export const query_vql_node_to_eb = (eb, node, table_name) => {
 }
 
 /**
- * @param {import("kysely").ExpressionBuilder<Database>} eb 
- * @param {import("@storecraft/core/vql").VQL.Node} root 
+ * @param {ExpressionBuilder<Database>} eb 
+ * @param {VQL.Node} root 
  * @param {keyof Database} table_name 
  */
 export const query_vql_to_eb = (eb, root, table_name) => {
@@ -146,9 +150,10 @@ const transform_boolean_to_0_or_1 = (kv) => {
 /**
  * Convert an API Query into mongo dialect, also sanitize.
  * 
+ * @template {any} [T=any]
  * 
- * @param {import("kysely").ExpressionBuilder<Database>} eb 
- * @param {import("@storecraft/core/api").ApiQuery} q 
+ * @param {ExpressionBuilder<Database>} eb 
+ * @param {ApiQuery<T>} q 
  * @param {keyof Database} table_name 
  * 
  */
@@ -189,12 +194,22 @@ const SIGN = {
   '-1': 'desc'
 }
 
+// export type DirectedOrderByStringReference<DB, TB extends keyof DB, O> = `${StringReference<DB, TB> | (keyof O & string)} ${OrderByDirection}`;
+
+/**
+ * @import {DirectedOrderByStringReference} from './utils.types.js'
+ */
+// OE extends OrderByExpression<DB, TB, O>
 /**
  * Convert an API Query into mongo dialect, also sanitize.
+ * @template {Record<string, any>} [Type=Record<string, any>]
+ * @template {keyof Database} [Table=keyof Database]
  * 
- * @param {import("@storecraft/core/api").ApiQuery} q 
+ * @param {ApiQuery<Type>} q 
+ * @param {Table} table 
+ * @returns {DirectedOrderByStringReference<Database, Table, Database[Table]>[]}
  */
-export const query_to_sort = (q={}) => {
+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;
@@ -202,9 +217,11 @@ export const query_to_sort = (q={}) => {
   const sort_sign = (asc ? 1 : -1) * reverse_sign;
 
   // compute sort fields and order
-  const sort = (q.sortBy?.length ? q.sortBy :  ['updated_at', 'id']).map(
+  const keys = q.sortBy?.length ? q.sortBy :  ['updated_at', 'id'];
+  const sort = keys.map(
     s => `${s} ${SIGN[sort_sign]}`
   )
-  
+  // it's too complicated to map each ket to table column.
+  // kysely was designed to do this in place
   return sort;
 }

package/src/utils.types.d.ts

@@ -0,0 +1,17 @@
+import { StringReference } from "kysely";
+
+export type NoActive<T> = T extends {active:number} ? Omit<T, 'active'> & {active: boolean} : T;
+export type ReplaceValues<T, Find extends any=any, ReplaceWith extends any=any> = {
+  [K in keyof T]: T[K] extends Find ? ReplaceWith : T[K]
+};
+
+export type ReplaceValuesOfKeys<T, Find extends keyof T=keyof T, ReplaceWith extends any=any> = {
+  [K in keyof T]: K extends Find ? ReplaceWith : T[K]
+};
+
+export type NO<T> = {
+  [P in keyof T]: T[P]
+}
+
+export type OrderByDirection = 'asc' | 'desc';
+export type DirectedOrderByStringReference<DB, TB extends keyof DB, O> = `${StringReference<DB, TB> | (keyof O & string)} ${OrderByDirection}`;

package/types.public.d.ts

@@ -7,7 +7,7 @@ export type SqlDialectType = 'SQLITE' | 'POSTGRES' | 'MYSQL';
 /**
  * The Storecraft SQL config
  */
-export type Config = {
+export type Config<DialectType extends Dialect = Dialect> = {
   /**
    * @description Database name
    * 
@@ -18,7 +18,7 @@ export type Config = {
   /**
    * @description The `Kysely` dialect
    */
-  dialect: Dialect,
+  dialect: DialectType,
 
   /**
    * @description The type of the sql dialect `SQLITE`, `POSTGRES`, `MYSQL`

package/types.sql.tables.d.ts

@@ -240,7 +240,7 @@ export interface DiscountsTable extends Base {
   /** details and filters of the discount */
   info: JSONColumnType<DiscountInfo>;
   /** discount application (automatic and coupons) */
-  application: JSONColumnType<DiscountApplicationEnum>;
+  application: JSONColumnType<DiscountApplicationEnum[keyof DiscountApplicationEnum]>;
   /** internal usage, the application type id */
   _application_id: number;
   /** internal usage, the discount type id */

package/migrations.mssql/00000_init_tables.js

@@ -1,268 +0,0 @@
-import { CreateTableBuilder, Kysely } from 'kysely'
-
-/**
- * @typedef {import('../types.sql.tables.js').Database} Database
- */
-
-/**
- * @template {string} TB
- * @template {string} B
- * @param {CreateTableBuilder<TB, B>} tb 
- */
-const add_base_columns = tb => {
-  return tb
-    .addColumn('id', 'VARCHAR(256)', (col) =>
-      col.primaryKey()
-    )
-    .addColumn('handle', 'VARCHAR(256)', (col) => col.unique())
-    .addColumn('created_at', 'text')
-    .addColumn('updated_at', 'text')
-    .addColumn('attributes', 'VARCHAR(MAX)')
-    .addColumn('description', 'text')
-    .addColumn('active', 'integer')
-}
-
-/**
- * @param {Kysely<Database>} db
- * @param {keyof Database} table_name
- */
-const create_entity_to_value_table = (db, table_name) => {
-
-  return db.schema
-    .createTable(table_name)
-    .addColumn('id', 'integer', 
-        (col) => col.autoIncrement().primaryKey()
-    )
-    .addColumn('entity_id', 'VARCHAR(256)', col => col.notNull())
-    .addColumn('entity_handle', 'VARCHAR(256)')
-    .addColumn('value', 'VARCHAR(256)')
-    .addColumn('reporter', 'VARCHAR(256)')
-    .addColumn('context', 'VARCHAR(256)')
-}
-
-/**
- * 
- * @param {Kysely<Database>} db 
- * @param {keyof Database} table_name 
- */
-const create_safe_table = (db, table_name) => {
-  return db.schema.createTable(table_name);
-}
-
-/**
- * 
- * @param {Kysely<Database>} db 
- * @param {keyof Database} table_name 
- */
-const drop_safe_table = (db, table_name) => {
-  return db.schema.dropTable(table_name).execute();
-}
-
-/**
- * 
- * @param {Kysely<Database>} db 
- */
-export async function up(db) {
-  { // auth_users
-    let tb = create_safe_table(db, 'auth_users');
-    tb = add_base_columns(tb);
-    tb = tb
-      .addColumn('email', 'VARCHAR(256)', (col) => col.unique())
-      .addColumn('password', 'text')
-      .addColumn('roles', 'VARCHAR(MAX)')
-      .addColumn('confirmed_mail', 'integer');
-    await tb.execute();
-  }
-
-  { // tags
-    let tb = create_safe_table(db, 'tags');
-    tb = add_base_columns(tb);
-    tb = tb.addColumn('values', 'VARCHAR(MAX)');
-    await tb.execute();
-  }
-
-  { // collections
-    let tb = create_safe_table(db, 'collections');
-    tb = add_base_columns(tb);
-    tb = tb
-      .addColumn('title', 'text')
-      .addColumn('published', 'text')
-    await tb.execute();
-  }
-
-  { // products
-    let tb = create_safe_table(db, 'products');
-    tb = add_base_columns(tb);
-    tb = tb
-      .addColumn('title', 'text')
-      .addColumn('video', 'text')
-      .addColumn('price', 'numeric')
-      .addColumn('compare_at_price', 'numeric')
-      .addColumn('qty', 'integer')
-      .addColumn('variants_options', 'VARCHAR(MAX)')
-      .addColumn('parent_handle', 'text')
-      .addColumn('parent_id', 'text')
-      .addColumn('variant_hint', 'VARCHAR(MAX)')
-    await tb.execute();
-  }
-
-  { // products_to_collections
-    let tb = create_entity_to_value_table(db, 'products_to_collections')
-    await tb.execute();
-  }
-
-  { // products_to_discounts
-    let tb = create_entity_to_value_table(db, 'products_to_discounts')
-    await tb.execute();
-  }
-  
-  { // products_to_variants
-    let tb = create_entity_to_value_table(db, 'products_to_variants')
-    await tb.execute();
-  }
-
-  { // shipping_methods
-    let tb = create_safe_table(db, 'shipping_methods');
-    tb = add_base_columns(tb);
-    tb = tb.addColumn('title', 'text')
-      .addColumn('price', 'numeric')
-    await tb.execute();
-  }
-
-  { // posts
-    let tb = create_safe_table(db, 'posts');
-    tb = add_base_columns(tb);
-    tb = tb
-      .addColumn('title', 'text')
-      .addColumn('text', 'text')
-    await tb.execute();
-  }
-
-  { // customers
-    let tb = create_safe_table(db, 'customers');
-    tb = add_base_columns(tb);
-    tb = tb
-      .addColumn('email', 'VARCHAR(256)', (col) => col.unique())
-      .addColumn('auth_id', 'VARCHAR(256)', (col) => col.unique())
-      .addColumn('firstname', 'text')
-      .addColumn('lastname', 'text')
-      .addColumn('phone_number', 'text')
-      .addColumn('address', 'VARCHAR(MAX)')
-    await tb.execute();
-  }
-
-  { // orders
-    let tb = create_safe_table(db, 'orders');
-    tb = add_base_columns(tb);
-    tb = tb
-      .addColumn('contact', 'VARCHAR(MAX)')
-      .addColumn('address', 'VARCHAR(MAX)')
-      .addColumn('line_items', 'VARCHAR(MAX)')
-      .addColumn('notes', 'text')
-      .addColumn('shipping_method', 'VARCHAR(MAX)')
-      .addColumn('status', 'VARCHAR(MAX)')
-      .addColumn('pricing', 'VARCHAR(MAX)')
-      .addColumn('validation', 'VARCHAR(MAX)')
-      .addColumn('payment_gateway', 'VARCHAR(MAX)')
-      .addColumn('coupons', 'VARCHAR(MAX)')
-      .addColumn('_customer_id', 'text')
-      .addColumn('_customer_email', 'text')
-      .addColumn('_status_payment_id', 'integer')
-      .addColumn('_status_checkout_id', 'integer')
-      .addColumn('_status_fulfillment_id', 'integer')
-    
-    await tb.execute();
-  }
-
-  { // storefronts
-    let tb = create_safe_table(db, 'storefronts');
-    tb = add_base_columns(tb);
-    tb = tb
-      .addColumn('title', 'text')
-      .addColumn('video', 'text')
-      .addColumn('published', 'text')
-    await tb.execute();
-  }
-
-  { // storefronts_to_other
-    let tb = create_entity_to_value_table(db, 'storefronts_to_other')
-    await tb.execute();
-  }
-
-  { // notifications
-    let tb = create_safe_table(db, 'notifications');
-    tb = add_base_columns(tb);
-    tb = tb
-      .addColumn('message', 'text')
-      .addColumn('author', 'text')
-      .addColumn('actions', 'VARCHAR(MAX)')
-    await tb.execute();
-  } 
-
-  { // images
-    let tb = create_safe_table(db, 'images');
-    tb = add_base_columns(tb);
-    tb = tb
-      .addColumn('name', 'text')
-      .addColumn('url', 'text')
-    await tb.execute();
-  } 
-
-  { // discounts
-    let tb = create_safe_table(db, 'discounts');
-    tb = add_base_columns(tb);
-    tb = tb
-      .addColumn('title', 'text')
-      .addColumn('published', 'text')
-      .addColumn('priority', 'integer')
-      .addColumn('info', 'json')
-      .addColumn('application', 'VARCHAR(MAX)')
-      .addColumn('_application_id', 'integer')
-      .addColumn('_discount_type_id', 'integer')
-    await tb.execute();
-  } 
-
-  { // entity_to_tags_projections
-    let tb = create_entity_to_value_table(db, 'entity_to_tags_projections')
-    await tb.execute();
-  }
-
-  { // entity_to_search_terms
-    let tb = create_entity_to_value_table(db, 'entity_to_search_terms')
-    await tb.execute();
-  }
-
-  { // entity_to_media
-    let tb = create_entity_to_value_table(db, 'entity_to_media')
-    await tb.execute();
-  }
-
-}
-
-/**
- * 
- * @param {Kysely<Database>} db 
- */
-export async function down(db) {
-  await Promise.all([
-    drop_safe_table(db, 'auth_users'),
-    drop_safe_table(db, 'tags'),
-    drop_safe_table(db, 'collections'),
-    drop_safe_table(db, 'customers'),
-    drop_safe_table(db, 'discounts'),
-    drop_safe_table(db, 'images'),
-    drop_safe_table(db, 'notifications'),
-    drop_safe_table(db, 'orders'),
-    drop_safe_table(db, 'posts'),
-    drop_safe_table(db, 'shipping_methods'),
-    drop_safe_table(db, 'products'),
-    drop_safe_table(db, 'products_to_collections'),
-    drop_safe_table(db, 'products_to_discounts'),
-    drop_safe_table(db, 'products_to_variants'),
-    drop_safe_table(db, 'storefronts'),
-    drop_safe_table(db, 'storefronts_to_other'),
-    drop_safe_table(db, 'entity_to_media'),
-    drop_safe_table(db, 'entity_to_search_terms'),
-    drop_safe_table(db, 'entity_to_tags_projections'),
-  ]);
-}