@storecraft/database-sql-base 1.0.16 → 1.0.18

package/kysely.aggregate.dialect.js

@@ -16,7 +16,17 @@ import {
  */
 
 /**
- * @description Official Storecraft Cloudflare D1 adapter on Worker
+ * @description A special dialect that aggregates / records queries.
+ * This is useful for
+ * - testing / debugging
+ * - generating migration files for cloud based databases 
+ * such as `libsql` / `turso` / `d1`
+ * 
+ * NOTE: 
+ * - This dialect does not support transactions
+ * - This is only useful for non-interactive queries, which are
+ * basically transactions, that do not depend on results of previous queries.
+ * Which is the philosophy of `storecraft` and is quite common in migrations.
  * 
  * @implements {Dialect}
  */

package/migrate.js

@@ -37,25 +37,26 @@ export const get_migrations = async (dialect_type='SQLITE') => {
 
   for (const file of files) {
     if(file.endsWith('.js')) {
+      const file_name = file.split('.').slice(0, -1).join('.');
       const migration = await import(path.join(__dirname, folder, file));
-      migrations[file] = migration;
+      migrations[file_name] = migration;
     }
   }
 
   return migrations;
 }
 
-console.log(
-  await get_migrations()
-)
+// console.log(
+//   await get_migrations()
+// )
 
 
 /**
  * 
  * @param {SQL} db_driver 
- * @param {boolean} [destroy_db_upon_completion=true] 
+ * @param {boolean} [release_db_upon_completion=true] 
  */
-export async function migrateToLatest(db_driver, destroy_db_upon_completion=true) {
+export async function migrateToLatest(db_driver, release_db_upon_completion=true) {
   if(!db_driver?.client)
     throw new Error('No Kysely client found !!!');
 
@@ -103,6 +104,41 @@ export async function migrateToLatest(db_driver, destroy_db_upon_completion=true
     process.exit(1)
   }
 
-  if(destroy_db_upon_completion)
+  if(release_db_upon_completion)
     await db.destroy();
 }
+
+
+/**
+ * @description Just for education and debugging, do not use !!!
+ * @param {string} stmt 
+ * @param {any[] | Record<string, any>} params 
+ */
+export const prepare_and_bind = (stmt='', params=[]) => {
+  const params_object = Array.isArray(params) ? 
+    params.reduce((a, v, idx) => ({ ...a, [idx+1]: v}), {}) : 
+    params; 
+
+  let current = 0;
+  let result = ''
+  let index_run = 1;
+  for (let m of stmt.matchAll(/\?[0-9]*/g)) {
+    result += stmt.slice(current, m.index);
+  
+    const match_string = m[0];
+    let index_access = match_string.length > 1 ? 
+      Number(match_string.slice(1)) : 
+      index_run;
+  
+    result += "'" + params_object[index_access] + "'";
+  
+    current = m.index + m[0].length;
+    index_run+=1;
+  }
+  
+  result += stmt.slice(current);
+
+  return result;
+}
+
+

package/migrations.shared/00003_alter_auth_users.js

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

package/package.json

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

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

@@ -10,7 +10,7 @@ import { homedir } from 'node:os';
 import { join } from 'node:path';
 
 export const sqlite_dialect = new SqliteDialect({
-  database: async () => new SQLite(join(homedir(), 'db.sqlite')),
+  database: async () => new SQLite(':memory:'),
 });
 
 export const create_app = async () => {

package/tests/aggregate.js

@@ -1,38 +0,0 @@
-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();