@storecraft/database-sql-base 1.0.14 → 1.0.16

package/kysely.aggregate.dialect.js

@@ -0,0 +1,148 @@
+/**
+ * @import { Driver, Dialect, DatabaseConnection, QueryResult } from 'kysely';
+ */
+import {
+  CompiledQuery,
+  Kysely,
+} from 'kysely';
+
+/**
+ * @typedef {object} Config
+ * @prop {Dialect} dialect
+ */
+
+/**
+ * @typedef {(query: CompiledQuery) => void} OnQueryInterface
+ */
+
+/**
+ * @description Official Storecraft Cloudflare D1 adapter on Worker
+ * 
+ * @implements {Dialect}
+ */
+export class AggregateDialect {
+
+  /** @type {CompiledQuery[]} */
+  queries = [];
+
+  /** @param {Config} config */
+  constructor(config) {
+    this.config = config;
+  }
+
+  createAdapter() { return this.config.dialect.createAdapter?.(); }
+  createDriver() { 
+    /** @type {OnQueryInterface} */
+    const onQuery = (query) => {
+      this.queries.push(query);
+    }
+    return new AggregateDriver(
+      this.config,
+      onQuery
+    ); 
+  }
+  createQueryCompiler() { return this.config.dialect.createQueryCompiler?.(); }
+
+  /**
+   * @param {Kysely<any>} db 
+   */
+  createIntrospector(db){
+    return this.config.dialect.createIntrospector?.(db);
+  }
+}
+
+
+/**
+ * @implements {Driver}
+ */
+class AggregateDriver {
+
+  /** 
+   * @param {Config} config 
+   * @param {OnQueryInterface} onQuery 
+   */
+  constructor(config, onQuery) {
+    this.onQuery = onQuery;
+    this.config = config;
+  }
+
+  async init() {}
+
+  async acquireConnection() {
+    return new AggregateConnection(
+      this.config,
+      this.onQuery
+    );
+  }
+
+  /**
+   * @param {AggregateConnection} conn 
+   */
+  beginTransaction(conn) { return conn.beginTransaction(); }
+
+  /**
+   * @param {AggregateConnection} conn 
+   */
+  commitTransaction(conn) {
+    return conn.commitTransaction();
+  }
+
+  /**
+   * @param {AggregateConnection} conn 
+   */
+  rollbackTransaction(conn){
+    return conn.rollbackTransaction();
+  }
+
+  /**
+   * @param {AggregateConnection} _conn 
+   */
+  async releaseConnection(_conn) {}
+
+  async destroy() {}
+}
+
+
+/**
+ * @implements {DatabaseConnection}
+ */
+class AggregateConnection {
+
+  /**
+   * @param {Config} config 
+   * @param {OnQueryInterface} onQuery 
+   */
+  constructor(config, onQuery) {
+    this.config = config;
+    this.onQuery = onQuery;
+  }
+
+  /**
+   * @template R result type
+   * @param {CompiledQuery} compiledQuery 
+   * @returns {Promise<QueryResult<R>>}
+   */
+  async executeQuery(compiledQuery) {
+    this.onQuery(compiledQuery);
+    return Promise.resolve(
+      {
+        rows: []
+      }
+    )
+  }
+  
+  async beginTransaction() {
+  }
+
+  async commitTransaction() {
+  }
+
+  async rollbackTransaction() {
+    return;
+  }
+
+  /** @type {DatabaseConnection["streamQuery"]} */
+  async *streamQuery(compiledQuery, chunkSize) {
+    throw new Error('D1 Driver does not support streaming');
+  }
+}

package/migrate.js

@@ -1,9 +1,15 @@
+/**
+ * @import { Database } from './types.sql.tables.js';
+ * @import { SqlDialectType } from './types.public.js';
+ * @import { Migration } from 'kysely';
+ */
 import { fileURLToPath } from "node:url";
 import * as path from 'path'
 import { promises as fs } from 'fs'
 import {
   Migrator,
   FileMigrationProvider,
+  Kysely,
 } from 'kysely'
 import { SQL } from "./index.js";
 
@@ -14,6 +20,36 @@ export const current = {
   driver: undefined
 }
 
+export const read_files_in_folder = async (folder='') => {
+  const files = await fs.readdir(folder);
+  return files.filter(file => file.endsWith('.js'));
+}
+
+/**
+ * @param {SqlDialectType} dialect_type
+ */
+export const get_migrations = async (dialect_type='SQLITE') => {
+  const folder = 'migrations.' + dialect_type.toLowerCase();
+  const files = await fs.readdir(path.join(__dirname, folder));
+
+  /** @type {Record<string, Migration>} */
+  const migrations = {};
+
+  for (const file of files) {
+    if(file.endsWith('.js')) {
+      const migration = await import(path.join(__dirname, folder, file));
+      migrations[file] = migration;
+    }
+  }
+
+  return migrations;
+}
+
+console.log(
+  await get_migrations()
+)
+
+
 /**
  * 
  * @param {SQL} db_driver 
@@ -23,7 +59,7 @@ export async function migrateToLatest(db_driver, destroy_db_upon_completion=true
   if(!db_driver?.client)
     throw new Error('No Kysely client found !!!');
 
-  console.log('Resolving migrations')
+  console.log('Resolving migrations. This may take 2 minutes ...')
 
   let db = db_driver.client;
 
@@ -63,7 +99,7 @@ export async function migrateToLatest(db_driver, destroy_db_upon_completion=true
 
   if (error) {
     console.error('failed to migrate')
-    console.error(error)
+    console.error(JSON.stringify(error, null, 2))
     process.exit(1)
   }
 

package/migrations.shared/00001_seed_email_templates.js

@@ -1,10 +1,10 @@
+/**
+ * @import { Database } from '../types.sql.tables.js'
+ */
 import { Kysely } from 'kysely'
 import { upsert } from '../src/con.templates.js'
 import { templates } from '@storecraft/core/assets/seed-templates.js';
 
-/**
- * @typedef {import('../types.sql.tables.js').Database} Database
- */
 
 /**
  * 

package/migrations.shared/00003_alter_auth_users.js

@@ -9,15 +9,18 @@ import { Kysely } from 'kysely'
  */
 export async function up(db) {
 
-  await db.schema
-  .alterTable('auth_users')
-  .addColumn('firstname', 'text')
-  .execute();
-
-  await db.schema
-  .alterTable('auth_users')
-  .addColumn('lastname', 'text')
-  .execute();
+  try {
+    await db.schema
+    .alterTable('auth_users')
+    .addColumn('firstname', 'text')
+    .execute();
+  
+    await db.schema
+    .alterTable('auth_users')
+    .addColumn('lastname', 'text')
+    .execute();
+  } catch (e) {
+  }
 }
 
 /**
@@ -25,13 +28,16 @@ export async function up(db) {
  * @param {Kysely<Database>} db 
  */
 export async function down(db) {
-  await db.schema
-  .alterTable('auth_users')
-  .dropColumn('firstname')
-  .execute();
-
-  await db.schema
-  .alterTable('auth_users')
-  .dropColumn('lastname')
-  .execute();
+  try {
+    await db.schema
+    .alterTable('auth_users')
+    .dropColumn('firstname')
+    .execute();
+  
+    await db.schema
+    .alterTable('auth_users')
+    .dropColumn('lastname')
+    .execute();
+  } catch (e) {
+  }
 }

package/package.json

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

package/src/con.templates.js

@@ -18,12 +18,23 @@ export const table_name = 'templates'
  * otherwise, just return the original value.
  * @param {string} val 
  */
-const decode_if_base64 = val => {
+const encode_base64_if_needed = val => {
+  if(val.startsWith('base64_'))
+    return val;
+
+  return 'base64_' + base64.encode(val);
+}
+
+/**
+ * @description if `base64_` prefixed then decode the postfix and return it,
+ * otherwise, just return the original value.
+ * @param {string} val 
+ */
+const decode_base64_if_needed = val => {
   if(!val.startsWith('base64_'))
     return val;
 
-  const b64 = val.split('base64_').at(1) ?? '';
-  return base64.decode(b64);
+  return base64.decode(val.split('base64_').at(-1) ?? '');
 }
 
 /**
@@ -45,8 +56,8 @@ export const upsert = (client) => {
             active: item.active ? 1 : 0,
             title: item.title,
             handle: item.handle,
-            template_html: decode_if_base64(item.template_html),
-            template_text: decode_if_base64(item.template_text),
+            template_html: encode_base64_if_needed(item.template_html),
+            template_text: encode_base64_if_needed(item.template_text),
             reference_example_input: JSON.stringify(item.reference_example_input ?? {})
           });
         }
@@ -78,7 +89,17 @@ const get = (driver) => {
     )
     .where(where_id_or_handle_table(id_or_handle))
     .executeTakeFirst()
-    .then(sanitize);
+    .then(sanitize)
+    .then(
+      (item) => {
+        if(!item) return null;
+
+        item.template_html = decode_base64_if_needed(item.template_html);
+        item.template_text = decode_base64_if_needed(item.template_text);
+
+        return item;
+      }
+    )
   }
 }
 
@@ -134,7 +155,18 @@ const list = (driver) => {
       )
       .orderBy(query_to_sort(query, table_name))
       .limit(query.limitToLast ?? query.limit ?? 10)
-      .execute();
+      .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);
+              return item;
+            }
+          )
+        }
+      );
 
     if(query.limitToLast) items.reverse();
     

package/tests/aggregate.js

@@ -0,0 +1,38 @@
+import 'dotenv/config';
+import { App } from '@storecraft/core';
+import { SQL } from '@storecraft/database-sql-base';
+import { migrateToLatest } from '@storecraft/database-sql-base/migrate.js';
+import { NodePlatform } from '@storecraft/core/platform/node';
+import { api } from '@storecraft/core/test-runner'
+import SQLite from 'better-sqlite3'
+import { SqliteDialect } from 'kysely';
+import { homedir } from 'node:os';
+import { join } from 'node:path';
+import { up } from '../migrations.sqlite/00000_init_tables.js'
+import { AggregateDialect } from '../kysely.aggregate.dialect.js'
+
+export const sqlite_dialect = new SqliteDialect(
+  {
+    database: async () => new SQLite(join(homedir(), 'db.sqlite')),
+  }
+);
+
+export const test = async () => {
+  const aggregate_dialect = new AggregateDialect(
+    {
+      dialect: sqlite_dialect,
+    }
+  );
+
+  const db = new SQL({
+    dialect: aggregate_dialect,
+    dialect_type: 'SQLITE'
+  });
+
+  await up(db.client);
+
+  const queries = aggregate_dialect.queries;
+  console.log({queries})
+
+}
+test();

package/tests/runner.mysql-local.test.js

@@ -22,7 +22,9 @@ export const create_app = async () => {
     {
       auth_admins_emails: ['admin@sc.com'],
       auth_secret_access_token: 'auth_secret_access_token',
-      auth_secret_refresh_token: 'auth_secret_refresh_token'
+      auth_secret_refresh_token: 'auth_secret_refresh_token',
+      auth_secret_confirm_email_token: 'auth_secret_confirm_email_token',
+      auth_secret_forgot_password_token: 'auth_secret_forgot_password_token',
     }
   )
   .withPlatform(new NodePlatform())

package/tests/runner.postgres-local.test.js

@@ -22,7 +22,9 @@ export const create_app = async () => {
     {
       auth_admins_emails: ['admin@sc.com'],
       auth_secret_access_token: 'auth_secret_access_token',
-      auth_secret_refresh_token: 'auth_secret_refresh_token'
+      auth_secret_refresh_token: 'auth_secret_refresh_token',
+      auth_secret_confirm_email_token: 'auth_secret_confirm_email_token',
+      auth_secret_forgot_password_token: 'auth_secret_forgot_password_token',
     }
   )
   .withPlatform(new NodePlatform())

package/tests/runner.sqlite-local.test.js

@@ -18,7 +18,9 @@ export const create_app = async () => {
     {
       auth_admins_emails: ['admin@sc.com'],
       auth_secret_access_token: 'auth_secret_access_token',
-      auth_secret_refresh_token: 'auth_secret_refresh_token'
+      auth_secret_refresh_token: 'auth_secret_refresh_token',
+      auth_secret_confirm_email_token: 'auth_secret_confirm_email_token',
+      auth_secret_forgot_password_token: 'auth_secret_forgot_password_token',
     }
   )
   .withPlatform(new NodePlatform())