@storecraft/database-sql-base 1.0.11 → 1.0.12

package/index.js

@@ -1,3 +1,10 @@
+/**
+ * @import { db_driver } from '@storecraft/core/database'
+ * @import { Database } from './types.sql.tables.js'
+ * @import { Config } from './types.public.js'
+ * @import { Dialect } from 'kysely'
+ */
+
 import { App } from '@storecraft/core';
 import { impl as auth_users } from './src/con.auth_users.js';
 import { impl as collections } from './src/con.collections.js';
@@ -25,15 +32,10 @@ const assert = (b, msg) => {
   if(!Boolean(b)) throw new Error(msg);
 }
 
-/**
- * @typedef {import('./types.public.d.ts').Config} Config
- * @typedef {import('./types.sql.tables.d.ts').Database} Database
- * @typedef {import('kysely').Dialect} Dialect
- * @typedef {import('@storecraft/core/database').db_driver} db_driver
-*/
 
 /**
- * @implements {db_driver}
+ * @template {Config} [ConfigType=Config]
+ * @implements {db_driver<ConfigType>}
  */
 export class SQL {
 
@@ -43,7 +45,7 @@ export class SQL {
   /** @type {App<any, any, any>} */ 
   #_app;
 
-  /** @type {Config} */ 
+  /** @type {ConfigType} */ 
   #_config;
 
   /** @type {Kysely<Database>} */ 
@@ -54,7 +56,7 @@ export class SQL {
 
   /**
    * 
-   * @param {Config} [config] config 
+   * @param {ConfigType} [config] config 
    */
   constructor(config) {
     this.#_is_ready = false;
@@ -69,16 +71,6 @@ export class SQL {
       this.#_config.dialect_type, 
       'No Dialect Type specified !'
     );
-
-    this.#_client = new Kysely(
-      {
-        dialect: this.#_config.dialect, 
-        plugins: [
-          new ParseJSONResultsPlugin(),
-          new SanitizePlugin()
-        ]
-      }
-    );
   }
 
   throwIfNotReady() {
@@ -89,13 +81,9 @@ export class SQL {
   }
 
   /**
-   * 
-   * @param {App<any, any, any>} app 
-   * 
-   * 
-   * @returns {Promise<this>}
+   * @type {db_driver["init"]}
    */
-  async init(app) {
+  init(app) {
     if(this.isReady)
       return this;
 
@@ -144,6 +132,16 @@ export class SQL {
   }
 
   get client() { 
+    this.#_client = this.#_client ?? new Kysely(
+      {
+        dialect: this.config.dialect, 
+        plugins: [
+          new ParseJSONResultsPlugin(),
+          new SanitizePlugin()
+        ]
+      }
+    );
+
     return this.#_client; 
   }
 

package/migrations.mysql/00002_seed_email_templates.js

@@ -0,0 +1 @@
+export * from '../migrations.shared/00002_seed_email_templates.js'

package/migrations.postgres/00002_seed_email_templates.js

@@ -0,0 +1 @@
+export * from '../migrations.shared/00002_seed_email_templates.js'

package/migrations.shared/00002_seed_email_templates.js

@@ -0,0 +1,27 @@
+import { Kysely } from 'kysely'
+import { upsert } from '../src/con.templates.js'
+import { templates } from '@storecraft/core/assets/seed-templates-v2.js';
+
+/**
+ * @typedef {import('../types.sql.tables.js').Database} Database
+ */
+
+/**
+ * 
+ * @param {Kysely<Database>} db 
+ */
+export async function up(db) {
+  
+  for (const template of templates.slice(0)) {
+    const result = await upsert(db)(template, template.search);
+    if(!result)
+      throw new Error('Failed to write a template object')
+  }
+}
+
+/**
+ * 
+ * @param {Kysely<Database>} db 
+ */
+export async function down(db) {
+}

package/migrations.sqlite/00002_seed_email_templates.js

@@ -0,0 +1 @@
+export * from '../migrations.shared/00002_seed_email_templates.js'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storecraft/database-sql-base",
-  "version": "1.0.11",
+  "version": "1.0.12",
   "description": "Official SQL Database driver for storecraft",
   "license": "MIT",
   "author": "Tomer Shalev (https://github.com/store-craft)",

package/src/con.auth_users.js

@@ -1,14 +1,14 @@
+/**
+ * @import { db_auth_users as db_col } from '@storecraft/core/database'
+ */
 import { SQL } from '../index.js'
 import { sanitize, sanitize_array } from './utils.funcs.js'
 import { 
-  count_regular, delete_me, insert_search_of, insert_tags_of, regular_upsert_me, 
-  where_id_or_handle_table, with_media, with_tags
+  count_regular, delete_me, insert_search_of, insert_tags_of, 
+  regular_upsert_me, where_id_or_handle_table, with_media, with_tags
 } from './con.shared.js'
 import { query_to_eb, query_to_sort } from './utils.query.js';
 
-/**
- * @typedef {import('@storecraft/core/database').db_auth_users} db_col
- */
 
 export const table_name = 'auth_users';
 

package/src/con.collections.js

@@ -1,3 +1,6 @@
+/**
+ * @import { db_collections as db_col } from '@storecraft/core/database'
+ */
 import { SQL } from '../index.js'
 import { report_document_media } from './con.images.js'
 import { delete_entity_values_by_value_or_reporter, delete_me, 
@@ -12,9 +15,6 @@ 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_collections} db_col
- */
 export const table_name = 'collections'
 
 /**

package/src/con.customers.js

@@ -1,3 +1,6 @@
+/**
+ * @import { db_customers as db_col } from '@storecraft/core/database'
+ */
 import { SQL } from '../index.js'
 import { report_document_media } from './con.images.js'
 import { count_regular, delete_me, delete_media_of, delete_search_of, 
@@ -7,9 +10,6 @@ import { count_regular, delete_me, delete_media_of, delete_search_of,
 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_customers} db_col
- */
 export const table_name = 'customers'
 
 /**

package/src/con.discounts.js

@@ -1,3 +1,6 @@
+/**
+ * @import { db_discounts as db_col } from '@storecraft/core/database'
+ */
 import { enums } from '@storecraft/core/api'
 import { SQL } from '../index.js'
 import { discount_to_conjunctions } from './con.discounts.utils.js'
@@ -12,9 +15,6 @@ import { sanitize, sanitize_array } from './utils.funcs.js'
 import { query_to_eb, query_to_sort } from './utils.query.js'
 import { report_document_media } from './con.images.js'
 
-/**
- * @typedef {import('@storecraft/core/database').db_discounts} db_col
- */
 export const table_name = 'discounts'
 
 /**

package/src/con.discounts.utils.js

@@ -1,11 +1,20 @@
+/**
+ * @import { 
+ *  DiscountType, FilterValue_p_in_price_range, FilterValue_p_not_in_collections, 
+ *  FilterValue_p_in_collections, FilterValue_p_not_in_tags, FilterValue_p_in_tags, 
+ *  FilterValue_p_in_products, FilterValue_p_not_in_products 
+ * } from '@storecraft/core/api'
+ * @import { Database } from '../types.sql.tables.js'
+ * @import { ExpressionBuilder, BinaryOperator } from 'kysely'
+ */
 import { enums } from "@storecraft/core/api";
 
-/** @param {import("@storecraft/core/api").DiscountType} d */
+/** @param {DiscountType} d */
 const is_order_discount = d => {
   return (d.info.details.meta.id===enums.DiscountMetaEnum.order.id);
 }
 
-/** @param {import("@storecraft/core/api").DiscountType} d */
+/** @param {DiscountType} d */
 const is_automatic_discount = d => {
   return (d.application.id===enums.DiscountApplicationEnum.Auto.id);
 }
@@ -14,10 +23,9 @@ const extract_abs_number = v => {
   return v && !isNaN(v) && v!==Infinity && Math.abs(v);
 }
 /**
- * @typedef {import("../index.js").Database} Database
- * @param {import("kysely").ExpressionBuilder<Database, 'products'>} eb 
+ * @param {ExpressionBuilder<Database, 'products'>} eb 
  * @param {keyof Pick<Database, 'entity_to_tags_projections' | 'products_to_collections'>} table 
- * @param {import("kysely").BinaryOperator} op 
+ * @param {BinaryOperator} op 
  * @param {string[]} value 
  */
 const eb_in = (eb, table, op, value) => {
@@ -42,8 +50,8 @@ const eb_in = (eb, table, op, value) => {
 /**
  * create a mongodb conjunctions clauses from discount, intended
  * for filtering.
- * @param {import("kysely").ExpressionBuilder<Database, 'products'>} eb 
- * @param {import("@storecraft/core/api").DiscountType} d 
+ * @param {ExpressionBuilder<Database, 'products'>} eb 
+ * @param {DiscountType} d 
  */
 export const discount_to_conjunctions = (eb, d) => {
   // discount has to be product discount + automatic + active + has filters
@@ -67,7 +75,7 @@ export const discount_to_conjunctions = (eb, d) => {
       case enums.FilterMetaEnum.p_in_products.op:
         {
           
-          const cast = /** @type {import("@storecraft/core/api").FilterValue_p_in_products} */ (
+          const cast = /** @type {FilterValue_p_in_products} */ (
             Array.isArray(filter?.value) ? filter.value : []
           );
 
@@ -82,7 +90,7 @@ export const discount_to_conjunctions = (eb, d) => {
       case enums.FilterMetaEnum.p_not_in_products.op:
         {
           
-          const cast = /** @type {import("@storecraft/core/api").FilterValue_p_not_in_products} */ (
+          const cast = /** @type {FilterValue_p_not_in_products} */ (
             Array.isArray(filter?.value) ? filter.value : []
           );
 
@@ -97,7 +105,7 @@ export const discount_to_conjunctions = (eb, d) => {
       case enums.FilterMetaEnum.p_in_tags.op:
         {
           
-          const cast = /** @type {import("@storecraft/core/api").FilterValue_p_in_tags} */(
+          const cast = /** @type {FilterValue_p_in_tags} */(
             Array.isArray(filter?.value) ? filter.value : []
           );
           
@@ -111,7 +119,7 @@ export const discount_to_conjunctions = (eb, d) => {
         break;
       case enums.FilterMetaEnum.p_not_in_tags.op:
         {
-          const cast = /** @type {import("@storecraft/core/api").FilterValue_p_not_in_tags} */ (
+          const cast = /** @type {FilterValue_p_not_in_tags} */ (
             Array.isArray(filter?.value) ? filter.value : []
           );
 
@@ -127,7 +135,7 @@ export const discount_to_conjunctions = (eb, d) => {
         break;
       case enums.FilterMetaEnum.p_in_collections.op:
         {
-          const cast = /** @type {import("@storecraft/core/api").FilterValue_p_in_collections} */ (
+          const cast = /** @type {FilterValue_p_in_collections} */ (
             Array.isArray(filter?.value) ? filter.value : []
           );
 
@@ -142,7 +150,7 @@ export const discount_to_conjunctions = (eb, d) => {
         break;
       case enums.FilterMetaEnum.p_not_in_collections.op:
         {
-          const cast = /** @type {import("@storecraft/core/api").FilterValue_p_not_in_collections} */ (
+          const cast = /** @type {FilterValue_p_not_in_collections} */ (
             Array.isArray(filter?.value) ? filter.value : []
           );
 
@@ -158,7 +166,7 @@ export const discount_to_conjunctions = (eb, d) => {
         break;
       case enums.FilterMetaEnum.p_in_price_range.op:
         {
-          const cast = /** @type {import("@storecraft/core/api").FilterValue_p_in_price_range} */ (
+          const cast = /** @type {FilterValue_p_in_price_range} */ (
             {
               from: 0,
               to: Number.POSITIVE_INFINITY,

package/src/con.images.js

@@ -1,3 +1,8 @@
+/**
+ * @import { db_images as db_col } from '@storecraft/core/database'
+ * @import { Database } from '../types.sql.tables.js'
+ */
+
 import { func } from '@storecraft/core/api'
 import { SQL } from '../index.js'
 import { count_regular, delete_me, delete_search_of, 
@@ -11,9 +16,6 @@ import {
   image_url_to_handle, image_url_to_name 
 } from '@storecraft/core/api/con.images.logic.js'
 
-/**
- * @typedef {import('@storecraft/core/database').db_images} db_col
- */
 export const table_name = 'images'
 
 /**
@@ -106,7 +108,7 @@ const remove = (driver) => {
  */
 export const report_document_media = (driver) => {
   /**
-   * @param {Transaction<import('../index.js').Database>} [transaction]
+   * @param {Transaction<Database>} [transaction]
    */
   return async (item, transaction) => {
     if(!(item?.media?.length))
@@ -114,7 +116,7 @@ export const report_document_media = (driver) => {
   
     /**
      * 
-   * @param {Transaction<import('../index.js').Database>} trx
+   * @param {Transaction<Database>} trx
      */
     const doit = async (trx) => {
       const dates = func.apply_dates({});

package/src/con.notifications.js

@@ -1,3 +1,6 @@
+/**
+ * @import { db_notifications 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, 
@@ -5,9 +8,6 @@ import { count_regular, delete_me, delete_search_of,
 import { sanitize_array } from './utils.funcs.js'
 import { query_to_eb, query_to_sort } from './utils.query.js'
 
-/**
- * @typedef {import('@storecraft/core/database').db_notifications} db_col
- */
 export const table_name = 'notifications'
 
 /**

package/src/con.orders.js

@@ -1,3 +1,7 @@
+/**
+ * @import { db_orders as db_col } from '@storecraft/core/database'
+ */
+
 import { SQL } from '../index.js'
 import { report_document_media } from './con.images.js'
 import { count_regular, delete_me, delete_media_of, delete_search_of, 
@@ -7,9 +11,6 @@ import { count_regular, delete_me, delete_media_of, delete_search_of,
 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_orders} db_col
- */
 export const table_name = 'orders'
 
 /**

package/src/con.posts.js

@@ -1,3 +1,7 @@
+/**
+ * @import { db_posts as db_col } from '@storecraft/core/database'
+ */
+
 import { SQL } from '../index.js'
 import { stringArrayFrom } from './con.helpers.json.js'
 import { report_document_media } from './con.images.js'
@@ -9,9 +13,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_posts} db_col
- */
 export const table_name = 'posts'
 
 /**

package/src/con.products.js

@@ -1,3 +1,9 @@
+/**
+ * @import { ProductType, VariantType } from '@storecraft/core/api'
+ * @import { db_products as db_col } from '@storecraft/core/database'
+ * @import { Database } from '../types.sql.tables.js'
+ */
+
 import { enums } from '@storecraft/core/api'
 import { SQL } from '../index.js'
 import { delete_entity_values_of_by_entity_id_or_handle, delete_me, delete_media_of, 
@@ -19,9 +25,6 @@ import { report_document_media } from './con.images.js'
 import { union } from '@storecraft/core/api/utils.func.js'
 
 
-/**
- * @typedef {import('@storecraft/core/database').db_products} db_col
- */
 export const table_name = 'products'
 
 /**
@@ -263,10 +266,8 @@ const getBulk = (driver) => {
  */
 const remove_internal = (driver) => {
   /**
-   * @param {import('@storecraft/core/api').ProductType | 
-   *  import('@storecraft/core/api').VariantType
-   * } product
-   * @param {Transaction<import('../index.js').Database>} trx
+   * @param {ProductType | VariantType} product
+   * @param {Transaction<Database>} trx
    */
   return async (product, trx) => {
     // entities

package/src/con.search.js

@@ -1,15 +1,14 @@
-import { SQL } from '../index.js'
-import { jsonArrayFrom } from './con.helpers.json.js';
-import { query_to_eb, query_to_sort } from './utils.query.js';
-
 /**
- * @typedef {import('@storecraft/core/database').search} db_col
+ * @import { QuickSearchResult } from '@storecraft/core/api'
+ * @import { search as db_col, db_driver } from '@storecraft/core/database'
  */
 
-
+import { SQL } from '../index.js'
+import { jsonArrayFrom } from './con.helpers.json.js';
+import { query_to_eb, query_to_sort } from './utils.query.js';
 
 /**
- * @type {(keyof import('@storecraft/core/database').db_driver["resources"])[]}
+ * @type {(keyof db_driver["resources"])[]}
  */
 const tables = [
   'tags',
@@ -27,7 +26,7 @@ const tables = [
 ]
 
 /**
- * @type {Record<string, keyof import('@storecraft/core/database').db_driver["resources"]>}
+ * @type {Record<string, keyof db_driver["resources"]>}
  */
 const prefix_to_resource = {
   'au': 'auth_users',
@@ -65,7 +64,7 @@ const resource_to_props = {
  * 
  * @param {string} id 
  * 
- * @returns {keyof import('@storecraft/core/database').db_driver["resources"]}
+ * @returns {keyof db_driver["resources"]}
  */
 export const id_to_resource = id => {
   let result = undefined;
@@ -121,7 +120,7 @@ export const quicksearch = (driver) => {
     )
     
     
-    const items = (/** @type {import('@storecraft/core/api').QuickSearchResult} */(
+    const items = (/** @type {QuickSearchResult} */(
       await sts.executeTakeFirst())
     );