@storecraft/database-sql-base 1.0.0 → 1.0.2

package/README.md

@@ -1,27 +1,45 @@
 # Storecraft `SQL` driver
 
+<div style="text-align:center">
+  <img src='https://storecraft.app/storecraft-color.svg' 
+       width='90%' />
+</div><hr/><br/>
+
 Official `SQL` driver for `StoreCraft` with the dialects abstracted with `Kysely` or your own drivers.
 
+```bash
+npm i @storecraft/database-sql-base
+```
+
 ## usage
 
 ```js
 import 'dotenv/config';
 import http from "node:http";
-import { join } from "node:path";
-import { homedir } from "node:os";
-
 import { App } from '@storecraft/core'
-import { NodePlatform } from '@storecraft/platform-node'
-import { MongoDB } from '@storecraft/database-mongodb-node'
-import { NodeLocalStorage } from '@storecraft/storage-node-local'
-
-let app = new App(
-  new NodePlatform(),
-  new MongoDB({ db_name: 'prod', url: '<MONGO-URL>'}),
-  new NodeLocalStorage(join(homedir(), 'tomer'))
-);
+import { NodePlatform } from '@storecraft/core/platform/node';
+import { SQL } from '@storecraft/database-sql-base'
+import { migrateToLatest } from '@storecraft/database-sql-base/migrate.js'
+import { NodeLocalStorage } from '@storecraft/core/storage/node'
+
+const app = new App(
+  {
+    auth_admins_emails: ['admin@sc.com'],
+    auth_secret_access_token: 'auth_secret_access_token',
+    auth_secret_refresh_token: 'auth_secret_refresh_token'
+  }
+)
+.withPlatform(new NodePlatform())
+.withDatabase(
+  new SQL({
+    dialect: sqlite_dialect, 
+    dialect_type: 'SQLITE'
+  })
+)
+.withStorage(new NodeLocalStorage('storage'))
 
 await app.init();
+await migrateToLatest(app.db, false);
  
 const server = http.createServer(app.handler).listen(
   8000,

package/index.js

@@ -1,3 +1,174 @@
-export * from './driver.js'
+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';
+import { impl as customers } from './src/con.customers.js';
+import { impl as discounts } from './src/con.discounts.js';
+import { impl as images } from './src/con.images.js';
+import { impl as notifications } from './src/con.notifications.js';
+import { impl as orders } from './src/con.orders.js';
+import { impl as posts } from './src/con.posts.js';
+import { impl as products } from './src/con.products.js';
+import { impl as shipping } from './src/con.shipping.js';
+import { impl as storefronts } from './src/con.storefronts.js';
+import { impl as tags } from './src/con.tags.js';
+import { impl as templates } from './src/con.templates.js';
+import { impl as search } from './src/con.search.js';
+import { Kysely, ParseJSONResultsPlugin } from 'kysely'
+import { SanitizePlugin } from './src/kysely.sanitize.plugin.js';
 
 
+/**
+ * @param {any} b 
+ * @param {string} msg 
+ */
+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}
+ */
+export class SQL {
+
+  /** @type {boolean} */ 
+  #_is_ready;
+
+  /** @type {App<any, any, any>} */ 
+  #_app;
+
+  /** @type {Config} */ 
+  #_config;
+
+  /** @type {Kysely<Database>} */ 
+  #_client;
+  
+  /** @type {db_driver["resources"]} */ 
+  #_resources;
+
+  /**
+   * 
+   * @param {Config} [config] config 
+   */
+  constructor(config) {
+    this.#_is_ready = false;
+    this.#_config = config;
+
+    assert(
+      this.#_config.dialect, 
+      'No Dialect found !'
+    );
+
+    assert(
+      this.#_config.dialect_type, 
+      'No Dialect Type specified !'
+    );
+
+    this.#_client = new Kysely(
+      {
+        dialect: this.#_config.dialect, 
+        plugins: [
+          new ParseJSONResultsPlugin(),
+          new SanitizePlugin()
+        ]
+      }
+    );
+  }
+
+  throwIfNotReady() {
+    assert(
+      this.isReady,
+      'Database not ready !!! you need to `.init()` it'
+    );
+  }
+
+  /**
+   * 
+   * @param {App<any, any, any>} app 
+   * 
+   * 
+   * @returns {Promise<this>}
+   */
+  async init(app) {
+    if(this.isReady)
+      return this;
+
+    this.#_app = app;
+    
+    this.#_resources = {
+      auth_users: auth_users(this),
+      collections: collections(this),
+      customers: customers(this),
+      discounts: discounts(this),
+      images: images(this),
+      notifications: notifications(this),
+      orders: orders(this),
+      posts: posts(this),
+      products: products(this),
+      storefronts: storefronts(this),
+      tags: tags(this),
+      shipping_methods: shipping(this),
+      templates: templates(this),
+      search: search(this),
+    }
+    
+    this.#_is_ready = true; 
+
+    return this;
+  }
+
+  async disconnect() {
+    await this.client.destroy();
+    return true;
+  }
+
+  /**
+   * `database` resources
+   */
+  get resources () {
+    return this.#_resources;
+  }
+  
+  get name() { 
+    return this?.config?.db_name ?? 'main'; 
+  }
+
+  get app() { 
+    return this.#_app; 
+  }
+
+  get client() { 
+    return this.#_client; 
+  }
+
+  get config() { 
+    return this.#_config; 
+  }
+
+  get isReady() { 
+    return this.#_is_ready; 
+  }
+
+  get dialectType() { 
+    return this.#_config.dialect_type; 
+  }
+
+  get isSqlite() { 
+    return this.dialectType==='SQLITE'; 
+  }
+
+  get isPostgres() { 
+    return this.dialectType==='POSTGRES'; 
+  }
+
+  get isMysql() { 
+    return this.dialectType==='MYSQL'; 
+  }
+
+}

package/{tsconfig.json → jsconfig.json}

@@ -1,11 +1,6 @@
 {
-  "compileOnSave": false,
   "compilerOptions": {
-    "noEmit": true,
-    "allowJs": true,
     "checkJs": true,
-    "target": "ESNext",
-    "resolveJsonModule": true,
     "moduleResolution": "NodeNext",
     "module": "NodeNext",
     "composite": true,
@@ -16,6 +11,7 @@
     "migrations.sqlite/*", 
     "migrations.postgres/*", 
     "migrations.mysql/*", 
+    "migrations.shared/*", 
     "tests/*.js"
   ]
 }

package/migrate.js

@@ -29,31 +29,37 @@ export async function migrateToLatest(db_driver, destroy_db_upon_completion=true
 
   current.driver = db_driver;
 
-  const migrator = new Migrator({
-    db,
-    provider: new FileMigrationProvider({
-      fs,
-      path,
-      migrationFolder: path.join(
-        __dirname, 
-        `migrations.${db_driver.dialectType.toLowerCase()}`
+  const migrator = new Migrator(
+    {
+      db,
+      provider: new FileMigrationProvider(
+        {
+          fs,
+          path,
+          migrationFolder: path.join(
+            __dirname, 
+            `migrations.${db_driver.dialectType.toLowerCase()}`
+          ),
+        }
       ),
-    }),
-  })
+    }
+  );
 
   const { error, results } = await migrator.migrateToLatest();
 
-  results?.forEach((it) => {
-    if (it.status === 'Success') {
-      console.log(
-        `migration "${it.migrationName}" was executed successfully`
+  results?.forEach(
+    (it) => {
+      if (it.status === 'Success') {
+        console.log(
+          `migration "${it.migrationName}" was executed successfully`
         );
-    } else if (it.status === 'Error') {
-      console.error(
-        `failed to execute migration "${it.migrationName}"`
+      } else if (it.status === 'Error') {
+        console.error(
+          `failed to execute migration "${it.migrationName}"`
         );
+      }
     }
-  })
+  );
 
   if (error) {
     console.error('failed to migrate')
@@ -62,5 +68,5 @@ export async function migrateToLatest(db_driver, destroy_db_upon_completion=true
   }
 
   if(destroy_db_upon_completion)
-    await db.destroy()
+    await db.destroy();
 }

package/migrations.mysql/00000_init_tables.js

@@ -30,7 +30,7 @@ const add_base_columns = tb => {
 const create_entity_to_value_table = (db, table_name) => {
 
   return db.schema
-    .createTable(table_name)
+    .createTable(table_name).ifNotExists()
     .addColumn('id', 'integer', 
         (col) => col.autoIncrement().primaryKey()
     )
@@ -47,7 +47,7 @@ const create_entity_to_value_table = (db, table_name) => {
  * @param {keyof Database} table_name 
  */
 const create_safe_table = (db, table_name) => {
-  return db.schema.createTable(table_name);
+  return db.schema.createTable(table_name).ifNotExists();
 }
 
 /**
@@ -56,7 +56,7 @@ const create_safe_table = (db, table_name) => {
  * @param {keyof Database} table_name 
  */
 const drop_safe_table = (db, table_name) => {
-  return db.schema.dropTable(table_name).execute();
+  return db.schema.dropTable(table_name).ifExists().execute();
 }
 
 /**
@@ -94,7 +94,7 @@ const create_base_indexes = async (db, table_name, include_id=true, include_hand
  * @param {keyof Pick<Database, 'entity_to_media' | 
  * 'entity_to_search_terms' | 'entity_to_tags_projections' | 
  * 'products_to_collections' | 'products_to_discounts' | 
- * 'products_to_variants' | 'storefronts_to_other'>} table_name 
+ * 'products_to_variants' | 'storefronts_to_other' | 'products_to_related_products'>} table_name 
  */
 const create_entity_table_indexes = async (db, table_name) => {
   await db.schema.createIndex(`index_${table_name}_entity_id`)
@@ -150,7 +150,8 @@ export async function up(db) {
     let tb = create_safe_table(db, 'templates');
     tb = add_base_columns(tb);
     tb = tb.addColumn('title', 'text');
-    tb = tb.addColumn('template', 'text');
+    tb = tb.addColumn('template_html', 'text');
+    tb = tb.addColumn('template_text', 'text');
     tb = tb.addColumn('reference_example_input', 'json');
     await tb.execute();
     await create_base_indexes(db, 'templates');

package/migrations.postgres/00000_init_tables.js

@@ -29,7 +29,7 @@ const add_base_columns = tb => {
 const create_entity_to_value_table = (db, table_name) => {
 
   return db.schema
-    .createTable(table_name)
+    .createTable(table_name).ifNotExists()
     .addColumn('id', 'bigserial', 
         (col) => col.primaryKey()
     )
@@ -46,7 +46,7 @@ const create_entity_to_value_table = (db, table_name) => {
  * @param {keyof Database} table_name 
  */
 const create_safe_table = (db, table_name) => {
-  return db.schema.createTable(table_name);
+  return db.schema.createTable(table_name).ifNotExists();
 }
 
 /**
@@ -55,7 +55,7 @@ const create_safe_table = (db, table_name) => {
  * @param {keyof Database} table_name 
  */
 const drop_safe_table = (db, table_name) => {
-  return db.schema.dropTable(table_name).execute();
+  return db.schema.dropTable(table_name).ifExists().execute();
 }
 
 /**
@@ -66,22 +66,22 @@ const drop_safe_table = (db, table_name) => {
  */
 const create_base_indexes = async (db, table_name, include_id=true, include_handle=true) => {
   if(include_id) {
-    await db.schema.createIndex(`index_${table_name}_id_updated_at_asc`)
+    await db.schema.createIndex(`index_${table_name}_id_updated_at_asc`).ifNotExists()
             .on(table_name)
             .columns(['id', 'updated_at asc'])
             .execute();
-    await db.schema.createIndex(`index_${table_name}_id_updated_at_desc`)
+    await db.schema.createIndex(`index_${table_name}_id_updated_at_desc`).ifNotExists()
             .on(table_name)
             .columns(['id', 'updated_at desc'])
             .execute();
   }
 
   if(include_handle) {
-    await db.schema.createIndex(`index_${table_name}_handle_updated_at_asc`)
+    await db.schema.createIndex(`index_${table_name}_handle_updated_at_asc`).ifNotExists()
             .on(table_name)
             .columns(['handle', 'updated_at asc'])
             .execute();
-    await db.schema.createIndex(`index_${table_name}_handle_updated_at_desc`)
+    await db.schema.createIndex(`index_${table_name}_handle_updated_at_desc`).ifNotExists()
             .on(table_name)
             .columns(['handle', 'updated_at desc'])
             .execute();
@@ -94,26 +94,26 @@ const create_base_indexes = async (db, table_name, include_id=true, include_hand
  * @param {keyof Pick<Database, 'entity_to_media' | 
  * 'entity_to_search_terms' | 'entity_to_tags_projections' | 
  * 'products_to_collections' | 'products_to_discounts' | 
- * 'products_to_variants' | 'storefronts_to_other'>} table_name 
+ * 'products_to_variants' | 'storefronts_to_other' | 'products_to_related_products'>} table_name 
  */
 const create_entity_table_indexes = async (db, table_name) => {
-  await db.schema.createIndex(`index_${table_name}_entity_id`)
+  await db.schema.createIndex(`index_${table_name}_entity_id`).ifNotExists()
            .on(table_name)
            .column('entity_id')
            .execute();
-  await db.schema.createIndex(`index_${table_name}_entity_handle`)
+  await db.schema.createIndex(`index_${table_name}_entity_handle`).ifNotExists()
            .on(table_name)
            .column('entity_handle')
            .execute();
-  await db.schema.createIndex(`index_${table_name}_value`)
+  await db.schema.createIndex(`index_${table_name}_value`).ifNotExists()
            .on(table_name)
            .column('value')
            .execute();
-  await db.schema.createIndex(`index_${table_name}_reporter`)
+  await db.schema.createIndex(`index_${table_name}_reporter`).ifNotExists()
            .on(table_name)
            .column('reporter')
            .execute();
-  await db.schema.createIndex(`index_${table_name}_context`)
+  await db.schema.createIndex(`index_${table_name}_context`).ifNotExists()
            .on(table_name)
            .column('context')
            .execute();
@@ -148,7 +148,8 @@ export async function up(db) {
     let tb = create_safe_table(db, 'templates');
     tb = add_base_columns(tb);
     tb = tb.addColumn('title', 'text');
-    tb = tb.addColumn('template', 'text');
+    tb = tb.addColumn('template_html', 'text');
+    tb = tb.addColumn('template_text', 'text');
     tb = tb.addColumn('reference_example_input', 'json');
     await tb.execute();
     await create_base_indexes(db, 'templates');