@storecraft/database-sql-base 1.0.11 → 1.0.12

package/src/con.shared.js

@@ -1,4 +1,9 @@
-// @ts-ignore
+/**
+ * @import { db_crud } from '@storecraft/core/database'
+ * @import { Database } from '../types.sql.tables.js'
+ * @import { ExpressionBuilder, InsertObject } from 'kysely'
+ * @import { SqlDialectType } from '../types.public.js'
+ */
 import { ExpressionWrapper, InsertQueryBuilder, Kysely, Transaction } from 'kysely'
 import { jsonArrayFrom, stringArrayFrom } from './con.helpers.json.js'
 import { SQL } from '../index.js';
@@ -43,7 +48,7 @@ export const safe_trx = (k) => {
  * @param {SQL} driver 
  * @param {keyof Database} table_name 
  * 
- * @returns {import('@storecraft/core/database').db_crud["count"]}
+ * @returns {db_crud["count"]}
  */
 export const count_regular = (driver, table_name) => {
   return async (query) => {
@@ -70,7 +75,7 @@ export const count_regular = (driver, table_name) => {
  */
 export const where_id_or_handle_entity = (id_or_handle) => {
   /**
-   * @param {import('kysely').ExpressionBuilder<Database>} eb 
+   * @param {ExpressionBuilder<Database>} eb 
    */
   return (eb) => eb.or(
     [
@@ -86,7 +91,7 @@ export const where_id_or_handle_entity = (id_or_handle) => {
  */
 export const where_id_or_handle_table = (id_or_handle) => {
   /**
-   * @param {import('kysely').ExpressionBuilder<Database>} eb 
+   * @param {ExpressionBuilder<Database>} eb 
    */
   return (eb) => eb.or(
     [
@@ -139,7 +144,7 @@ export const delete_entity_values_of_by_entity_id_or_handle =
 (entity_table_name) => {
   /**
    * 
-   * @param {Kysely<import('../index.js').Database>} trx 
+   * @param {Kysely<Database>} trx 
    * @param {string} entity_id delete by id
    * @param {string} [entity_handle=entity_id] delete by handle
    */
@@ -262,17 +267,13 @@ export const delete_tags_of = delete_entity_values_of_by_entity_id_or_handle('en
 export const delete_search_of = delete_entity_values_of_by_entity_id_or_handle('entity_to_search_terms');
 export const delete_media_of = delete_entity_values_of_by_entity_id_or_handle('entity_to_media');
 
-/**
- * @typedef {import('../index.js').Database} Database
- */
-
 
 /**
  * @template {keyof Database} T
  * 
  * @param {Kysely<Database>} trx 
  * @param {T} table_name 
- * @param {import('kysely').InsertObject<Database, T> & {id: string, handle: string}} item values of the entity
+ * @param {InsertObject<Database, T> & {id: string, handle: string}} item values of the entity
  * 
  */
 export const regular_upsert_me = async (trx, table_name, item) => {
@@ -308,9 +309,9 @@ export const delete_me = async (trx, table_name, id_or_handle) => {
 
 /**
  * 
- * @param {import('kysely').ExpressionBuilder<Database>} eb 
+ * @param {ExpressionBuilder<Database>} eb 
  * @param {string | ExpressionWrapper<Database>} id_or_handle 
- * @param {import('../types.public.d.ts').SqlDialectType} sql_type 
+ * @param {SqlDialectType} sql_type 
  */
 export const with_tags = (eb, id_or_handle, sql_type) => {
   return stringArrayFrom(
@@ -322,9 +323,9 @@ export const with_tags = (eb, id_or_handle, sql_type) => {
 
 /**
  * 
- * @param {import('kysely').ExpressionBuilder<Database>} eb 
+ * @param {ExpressionBuilder<Database>} eb 
  * @param {string | ExpressionWrapper<Database>} id_or_handle 
- * @param {import('../types.public.d.ts').SqlDialectType} sql_type 
+ * @param {SqlDialectType} sql_type 
  */
 export const with_search = (eb, id_or_handle, sql_type) => {
   return stringArrayFrom(
@@ -336,9 +337,9 @@ export const with_search = (eb, id_or_handle, sql_type) => {
 
 /**
  * 
- * @param {import('kysely').ExpressionBuilder<Database>} eb 
+ * @param {ExpressionBuilder<Database>} eb 
  * @param {string | ExpressionWrapper<Database>} id_or_handle 
- * @param {import('../types.public.d.ts').SqlDialectType} sql_type 
+ * @param {SqlDialectType} sql_type 
  */
 export const with_media = (eb, id_or_handle, sql_type) => {
   return stringArrayFrom(
@@ -352,9 +353,9 @@ export const with_media = (eb, id_or_handle, sql_type) => {
 /**
  * select as json array collections of a product
  * 
- * @param {import('kysely').ExpressionBuilder<Database, 'products'>} eb 
+ * @param {ExpressionBuilder<Database, 'products'>} eb 
  * @param {string | ExpressionWrapper<Database>} product_id_or_handle 
- * @param {import('../types.public.d.ts').SqlDialectType} sql_type 
+ * @param {SqlDialectType} sql_type 
  */
 export const products_with_collections = (eb, product_id_or_handle, sql_type) => {
   return jsonArrayFrom(
@@ -383,9 +384,9 @@ export const products_with_collections = (eb, product_id_or_handle, sql_type) =>
 /**
  * select as json array collections of a product
  * 
- * @param {import('kysely').ExpressionBuilder<Database, 'products'>} eb 
+ * @param {ExpressionBuilder<Database, 'products'>} eb 
  * @param {string | ExpressionWrapper<Database>} product_id_or_handle 
- * @param {import('../types.public.d.ts').SqlDialectType} sql_type 
+ * @param {SqlDialectType} sql_type 
  */
 export const products_with_discounts = (eb, product_id_or_handle, sql_type) => {
   return jsonArrayFrom(
@@ -417,9 +418,9 @@ export const products_with_discounts = (eb, product_id_or_handle, sql_type) => {
 /**
  * select as json array collections of a product
  * 
- * @param {import('kysely').ExpressionBuilder<Database, 'products'>} eb 
+ * @param {ExpressionBuilder<Database, 'products'>} eb 
  * @param {string | ExpressionWrapper<Database>} product_id_or_handle 
- * @param {import('../types.public.d.ts').SqlDialectType} sql_type 
+ * @param {SqlDialectType} sql_type 
  */
 export const products_with_variants = (eb, product_id_or_handle, sql_type) => {
   return jsonArrayFrom(
@@ -455,9 +456,9 @@ export const products_with_variants = (eb, product_id_or_handle, sql_type) => {
 /**
  * select as json array collections of a product
  * 
- * @param {import('kysely').ExpressionBuilder<Database, 'products'>} eb 
+ * @param {ExpressionBuilder<Database, 'products'>} eb 
  * @param {string | ExpressionWrapper<Database>} product_id_or_handle 
- * @param {import('../types.public.d.ts').SqlDialectType} sql_type 
+ * @param {SqlDialectType} sql_type 
  */
 export const products_with_related_products = (eb, product_id_or_handle, sql_type) => {
   return jsonArrayFrom(
@@ -494,9 +495,9 @@ export const products_with_related_products = (eb, product_id_or_handle, sql_typ
 /**
  * select as json array collections of a product
  * 
- * @param {import('kysely').ExpressionBuilder<Database, 'storefronts'>} eb 
+ * @param {ExpressionBuilder<Database, 'storefronts'>} eb 
  * @param {string | ExpressionWrapper<Database>} sf_id_or_handle 
- * @param {import('../types.public.d.ts').SqlDialectType} sql_type 
+ * @param {SqlDialectType} sql_type 
  */
 export const storefront_with_collections = (eb, sf_id_or_handle, sql_type) => {
   return jsonArrayFrom(
@@ -525,9 +526,9 @@ export const storefront_with_collections = (eb, sf_id_or_handle, sql_type) => {
 /**
  * select as json array collections of a product
  * 
- * @param {import('kysely').ExpressionBuilder<Database>} eb 
+ * @param {ExpressionBuilder<Database>} eb 
  * @param {string | ExpressionWrapper<Database>} sf_id_or_handle 
- * @param {import('../types.public.d.ts').SqlDialectType} sql_type 
+ * @param {SqlDialectType} sql_type 
  */
 export const storefront_with_products = (eb, sf_id_or_handle, sql_type) => {
   return jsonArrayFrom(
@@ -563,9 +564,9 @@ export const storefront_with_products = (eb, sf_id_or_handle, sql_type) => {
 /**
  * select as json array collections of a product
  * 
- * @param {import('kysely').ExpressionBuilder<Database>} eb 
+ * @param {ExpressionBuilder<Database>} eb 
  * @param {string | ExpressionWrapper<Database>} sf_id_or_handle 
- * @param {import('../types.public.d.ts').SqlDialectType} sql_type 
+ * @param {SqlDialectType} sql_type 
  */
 export const storefront_with_discounts = (eb, sf_id_or_handle, sql_type) => {
   return jsonArrayFrom(
@@ -597,9 +598,9 @@ export const storefront_with_discounts = (eb, sf_id_or_handle, sql_type) => {
 /**
  * select as json array collections of a product
  * 
- * @param {import('kysely').ExpressionBuilder<Database>} eb 
+ * @param {ExpressionBuilder<Database>} eb 
  * @param {string | ExpressionWrapper<Database>} sf_id_or_handle 
- * @param {import('../types.public.d.ts').SqlDialectType} sql_type 
+ * @param {SqlDialectType} sql_type 
  */
 export const storefront_with_posts = (eb, sf_id_or_handle, sql_type) => {
   return jsonArrayFrom(
@@ -628,9 +629,9 @@ export const storefront_with_posts = (eb, sf_id_or_handle, sql_type) => {
 /**
  * select as json array collections of a product
  * 
- * @param {import('kysely').ExpressionBuilder<Database>} eb 
+ * @param {ExpressionBuilder<Database>} eb 
  * @param {string | ExpressionWrapper<Database>} sf_id_or_handle 
- * @param {import('../types.public.d.ts').SqlDialectType} sql_type 
+ * @param {SqlDialectType} sql_type 
  */
 export const storefront_with_shipping = (eb, sf_id_or_handle, sql_type) => {
   return jsonArrayFrom(
@@ -659,7 +660,7 @@ export const storefront_with_shipping = (eb, sf_id_or_handle, sql_type) => {
 /**
  * select all the entity values by entity id or handle
  * 
- * @param {import('kysely').ExpressionBuilder<Database>} eb 
+ * @param {ExpressionBuilder<Database>} eb 
  * @param {EntityTableKeys} entity_junction_table 
  * @param {string | ExpressionWrapper<Database>} entity_id_or_handle 
  */
@@ -681,7 +682,7 @@ export const select_values_of_entity_by_entity_id_or_handle =
 /**
  * select the entity ids which are constrained by value or reporter
  * 
- * @param {import('kysely').ExpressionBuilder<Database>} eb 
+ * @param {ExpressionBuilder<Database>} eb 
  * @param {EntityTableKeys} entity_junction_table 
  * @param {string | ExpressionWrapper<Database>} value 
  * @param {string | ExpressionWrapper<Database>} [reporter] 

package/src/con.shipping.js

@@ -1,3 +1,6 @@
+/**
+ * @import { db_shipping as db_col } from '@storecraft/core/database'
+ */
 import { SQL } from '../index.js'
 import { report_document_media } from './con.images.js'
 import { count_regular, delete_entity_values_by_value_or_reporter, 
@@ -8,9 +11,6 @@ import { count_regular, delete_entity_values_by_value_or_reporter,
 import { sanitize, sanitize_array } from './utils.funcs.js'
 import { query_to_eb, query_to_sort } from './utils.query.js'
 
-/**
- * @typedef {import('@storecraft/core/database').db_shipping} db_col
- */
 export const table_name = 'shipping_methods'
 
 /**
@@ -59,11 +59,11 @@ const get = (driver) => {
       .selectFrom(table_name)
       .selectAll()
       .select(eb => [
-        with_media(eb, id_or_handle, driver.dialectType),
-        with_tags(eb, id_or_handle, driver.dialectType),
-        with_search(eb, id_or_handle, driver.dialectType),
-      ]
-      .filter(Boolean))
+          with_media(eb, id_or_handle, driver.dialectType),
+          with_tags(eb, id_or_handle, driver.dialectType),
+          with_search(eb, id_or_handle, driver.dialectType),
+        ].filter(Boolean)
+      )
       .where(where_id_or_handle_table(id_or_handle))
       .executeTakeFirst();
     

package/src/con.storefronts.js

@@ -1,3 +1,6 @@
+/**
+ * @import { db_storefronts as db_col } from '@storecraft/core/database'
+ */
 import { SQL } from '../index.js'
 import { report_document_media } from './con.images.js'
 import { delete_entity_values_of_by_entity_id_or_handle, 
@@ -13,9 +16,6 @@ import { delete_entity_values_of_by_entity_id_or_handle,
 import { sanitize, sanitize_array } from './utils.funcs.js'
 import { query_to_eb, query_to_sort } from './utils.query.js'
 
-/**
- * @typedef {import('@storecraft/core/database').db_storefronts} db_col
- */
 export const table_name = 'storefronts'
 
 /**

package/src/con.tags.js

@@ -1,12 +1,14 @@
+/**
+ * @import { db_tags as db_col } from '@storecraft/core/database'
+ */
 import { SQL } from '../index.js'
 import { count_regular, delete_me, delete_search_of, insert_search_of, 
-  regular_upsert_me, where_id_or_handle_table } from './con.shared.js'
+  regular_upsert_me, where_id_or_handle_table, 
+  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'
 
-/**
- * @typedef {import('@storecraft/core/database').db_tags} db_col
- */
 export const table_name = 'tags'
 
 /**
@@ -47,6 +49,10 @@ const get = (driver) => {
     return driver.client
     .selectFrom(table_name)
     .selectAll()
+    .select(eb => [
+        with_search(eb, id_or_handle, driver.dialectType),
+      ].filter(Boolean)
+    )
     .where(where_id_or_handle_table(id_or_handle))
     .executeTakeFirst()
     .then(sanitize);
@@ -90,6 +96,9 @@ const list = (driver) => {
     const items = await 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);

package/src/con.templates.js

@@ -1,14 +1,16 @@
+/**
+ * @import { db_templates as db_col } from '@storecraft/core/database'
+ * @import { Database } from '../types.sql.tables.js'
+ */
 import { Kysely } from 'kysely'
 import { SQL } from '../index.js'
 import { count_regular, delete_me, delete_search_of, insert_search_of, 
-  regular_upsert_me, safe_trx, where_id_or_handle_table } from './con.shared.js'
+  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 { base64 } from '@storecraft/core/crypto';
 
-/**
- * @typedef {import('@storecraft/core/database').db_templates} db_col
- */
 export const table_name = 'templates'
 
 /**
@@ -25,8 +27,7 @@ const decode_if_base64 = val => {
 }
 
 /**
- * @param {Kysely<import('../index.js').Database>} client 
- * 
+ * @param {Kysely<Database>} client 
  * 
  * @returns {db_col["upsert"]}
  */
@@ -70,6 +71,10 @@ const get = (driver) => {
     return driver.client
     .selectFrom(table_name)
     .selectAll()
+    .select(eb => [
+        with_search(eb, id_or_handle, driver.dialectType),
+      ].filter(Boolean)
+    )
     .where(where_id_or_handle_table(id_or_handle))
     .executeTakeFirst()
     .then(sanitize);
@@ -115,6 +120,11 @@ const list = (driver) => {
     const items = await 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);

package/src/kysely.sanitize.plugin.js

@@ -1,3 +1,9 @@
+/**
+ * @import { 
+ *  KyselyPlugin, PluginTransformQueryArgs, RootOperationNode, 
+ *  PluginTransformResultArgs, QueryResult, UnknownRow 
+ * } from 'kysely'
+ */
 import { sanitize } from './utils.funcs.js';
 
 /**
@@ -6,20 +12,16 @@ import { sanitize } from './utils.funcs.js';
  * - sanitize `undefined` and `null` values
  * - `active` keys will be transformed to `boolean`
  * 
- * 
- * @typedef {import('kysely').KyselyPlugin} KyselyPlugin
- * 
- * 
  * @implements {KyselyPlugin}
  */
 export class SanitizePlugin {
 
   /**
    * 
-   * @param {import('kysely').PluginTransformQueryArgs} args 
+   * @param {PluginTransformQueryArgs} args 
    * 
    * 
-   * @returns {import('kysely').RootOperationNode}
+   * @returns {RootOperationNode}
    */
   transformQuery(args) {
     return args.node;
@@ -27,10 +29,10 @@ export class SanitizePlugin {
 
   /**
    * 
-   * @param {import('kysely').PluginTransformResultArgs} args 
+   * @param {PluginTransformResultArgs} args 
    * 
    * 
-   * @returns {Promise<import('kysely').QueryResult<import('kysely').UnknownRow>>}
+   * @returns {Promise<QueryResult<UnknownRow>>}
    */
   transformResult(args){
     sanitize(args.result.rows);

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);
 
@@ -25,7 +29,7 @@ export const delete_keys = (...keys) => {
  * Sanitize null/undefined valued keys
  * @template T
  * @param {T} o 
- * @return {import("./utils.types.js").ReplaceValuesOfKeys<T, 'active' | 'confirmed_mail', boolean>}
+ * @return {ReplaceValuesOfKeys<T, 'active' | 'confirmed_mail', boolean>}
  */
 export const sanitize = o => {
   for (const key in o) {

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
  */
@@ -73,8 +76,8 @@ export const query_cursor_to_eb = (eb, c, relation, transformer=(x)=>x) => {
 
 /**
  * @template {keyof Database} T
- * @param {import("kysely").ExpressionBuilder<Database>} eb 
- * @param {import("@storecraft/core/vql").VQL.Node} node 
+ * @param {ExpressionBuilder<Database>} eb 
+ * @param {VQL.Node} node 
  * @param {T} table_name 
  */
 export const query_vql_node_to_eb = (eb, node, table_name) => {
@@ -120,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) => {
@@ -149,8 +152,8 @@ const transform_boolean_to_0_or_1 = (kv) => {
  * 
  * @template {any} [T=any]
  * 
- * @param {import("kysely").ExpressionBuilder<Database>} eb 
- * @param {import("@storecraft/core/api").ApiQuery<T>} q 
+ * @param {ExpressionBuilder<Database>} eb 
+ * @param {ApiQuery<T>} q 
  * @param {keyof Database} table_name 
  * 
  */
@@ -202,7 +205,7 @@ const SIGN = {
  * @template {Record<string, any>} [Type=Record<string, any>]
  * @template {keyof Database} [Table=keyof Database]
  * 
- * @param {import("@storecraft/core/api").ApiQuery<Type>} q 
+ * @param {ApiQuery<Type>} q 
  * @param {Table} table 
  * @returns {DirectedOrderByStringReference<Database, Table, Database[Table]>[]}
  */

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`