@storecraft/database-sql-base 1.0.18 → 1.0.20

package/migrations.mysql/00000_init_tables.js

@@ -1,8 +1,7 @@
-import { CreateTableBuilder, Kysely } from 'kysely'
-
 /**
- * @typedef {import('../types.sql.tables.js').Database} Database
+ * @import { Database } from '../types.sql.tables.js'
  */
+import { CreateTableBuilder, Kysely } from 'kysely'
 
 /**
  * @template {string} TB

package/migrations.mysql/00004_update_previous_templates_with_subject.js

@@ -0,0 +1 @@
+export * from '../migrations.shared/00004_update_previous_templates_with_subject.js'

package/migrations.postgres/00000_init_tables.js

@@ -1,8 +1,7 @@
-import { CreateTableBuilder, Kysely } from 'kysely'
-
 /**
- * @typedef {import('../types.sql.tables.js').Database} Database
+ * @import { Database } from '../types.sql.tables.js'
  */
+import { CreateTableBuilder, Kysely } from 'kysely'
 
 /**
  * @template {string} TB

package/migrations.postgres/00004_update_previous_templates_with_subject.js

@@ -0,0 +1 @@
+export * from '../migrations.shared/00004_update_previous_templates_with_subject.js'

package/migrations.shared/00001_seed_email_templates.js

@@ -3,7 +3,7 @@
  */
 import { Kysely } from 'kysely'
 import { upsert } from '../src/con.templates.js'
-import { templates } from '@storecraft/core/assets/seed-templates.js';
+import { templates } from '@storecraft/core/assets/seed-templates-v1.js';
 
 
 /**
@@ -12,6 +12,33 @@ import { templates } from '@storecraft/core/assets/seed-templates.js';
  */
 export async function up(db) {
   
+  //
+  // NOTE: seeding templates this way might be problematic. Basically,
+  // seeds should not be in the migration folder. But, because we have
+  // direct access to the database, we can seed the templates directly.
+  // But this may result with problems, because right now we use the 
+  // an `api` layer to seed the templates, which always assumes that we
+  // have the latest schema. So, if we change the schema, we need to change
+  // the seed templates as well. This is not a problem for now, but it may be.
+  // So, we need to be careful with this. If any issue arises, please just
+  // use kysely directly to seed the tempaltes according to the schema at
+  // that time.
+  //
+  // Example:
+  // - later on, we add a new column to the template table.
+  // - The `upsert` function always assumes that the schema is up to date.
+  // - So, if the upsert method assigns a value like a default value to the new column,
+  //   it will fail, because the column does not exist yet.
+  // - So, the solution for that, is to write our version of the upsert here.
+  // 
+  // NOTE 2:
+  // - It is always better to seperate the seed data from the migration files.
+  // - seeding always assumes that the schema is up to date.
+  // - It is more hustle for users to run seeds, which might evolve.
+  // - I can afford to run seeds in migration files, because i have direct access to the database,
+  //   as oppposed to ORM users etc.
+  //   
+  //
   for (const template of templates.slice(0)) {
     const result = await upsert(db)(template, template.search);
     if(!result)

package/migrations.shared/00002_seed_email_templates.js

@@ -1,17 +1,42 @@
+/**
+ * @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-v2.js';
 
-/**
- * @typedef {import('../types.sql.tables.js').Database} Database
- */
-
 /**
  * 
  * @param {Kysely<Database>} db 
  */
 export async function up(db) {
-  
+    //
+  // NOTE: seeding templates this way might be problematic. Basically,
+  // seeds should not be in the migration folder. But, because we have
+  // direct access to the database, we can seed the templates directly.
+  // But this may result with problems, because right now we use the 
+  // an `api` layer to seed the templates, which always assumes that we
+  // have the latest schema. So, if we change the schema, we need to change
+  // the seed templates as well. This is not a problem for now, but it may be.
+  // So, we need to be careful with this. If any issue arises, please just
+  // use kysely directly to seed the tempaltes according to the schema at
+  // that time.
+  //
+  // Example:
+  // - later on, we add a new column to the template table.
+  // - The `upsert` function always assumes that the schema is up to date.
+  // - So, if the upsert method assigns a value like a default value to the new column,
+  //   it will fail, because the column does not exist yet.
+  // - So, the solution for that, is to write our version of the upsert here.
+  // 
+  // NOTE 2:
+  // - It is always better to seperate the seed data from the migration files.
+  // - seeding always assumes that the schema is up to date.
+  // - It is more hustle for users to run seeds, which might evolve.
+  // - I can afford to run seeds in migration files, because i have direct access to the database,
+  //   as oppposed to ORM users etc.
+  //   
+  //
   for (const template of templates.slice(0)) {
     const result = await upsert(db)(template, template.search);
     if(!result)

package/migrations.shared/00004_update_previous_templates_with_subject.js

@@ -0,0 +1,39 @@
+/**
+ * @import { Database } from '../types.sql.tables.js'
+ */
+import { Kysely } from 'kysely'
+import { 
+  templates as templates_corrections 
+} from '@storecraft/core/assets/seed-templates-v3-update-previous-templates-with-subject.js';
+
+/**
+ * update templates with subject template
+ * @param {Kysely<Database>} db 
+ */
+export async function up(db) {
+  await db.schema
+  .alterTable('templates')
+  .addColumn('template_subject', 'text')
+  .execute();
+
+  for (const template of templates_corrections) {
+    await db
+    .updateTable('templates')
+    .set({
+      template_subject: template.template_subject,
+    })
+    .where('id', '=', template.id)
+    .executeTakeFirst();
+  }
+}
+
+/**
+ * 
+ * @param {Kysely<Database>} db 
+ */
+export async function down(db) {
+  await db.schema
+  .alterTable('templates')
+  .dropColumn('template_subject')
+  .execute();
+}

package/migrations.sqlite/00000_init_tables.js

@@ -1,8 +1,7 @@
-import { CreateTableBuilder, Kysely } from 'kysely'
-
 /**
- * @typedef {import('../types.sql.tables.js').Database} Database
+ * @import { Database } from '../types.sql.tables.js'
  */
+import { CreateTableBuilder, Kysely } from 'kysely'
 
 /**
  * @template {string} TB

package/migrations.sqlite/00004_update_previous_templates_with_subject.js

@@ -0,0 +1 @@
+export * from '../migrations.shared/00004_update_previous_templates_with_subject.js'

package/package.json

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

package/src/con.templates.js

@@ -19,7 +19,7 @@ export const table_name = 'templates'
  * @param {string} val 
  */
 const encode_base64_if_needed = val => {
-  if(val.startsWith('base64_'))
+  if(val?.startsWith('base64_'))
     return val;
 
   return 'base64_' + base64.encode(val);
@@ -31,7 +31,7 @@ const encode_base64_if_needed = val => {
  * @param {string} val 
  */
 const decode_base64_if_needed = val => {
-  if(!val.startsWith('base64_'))
+  if(!val?.startsWith('base64_'))
     return val;
 
   return base64.decode(val.split('base64_').at(-1) ?? '');
@@ -39,7 +39,6 @@ const decode_base64_if_needed = val => {
 
 /**
  * @param {Kysely<Database>} client 
- * 
  * @returns {db_col["upsert"]}
  */
 export const upsert = (client) => {
@@ -56,8 +55,9 @@ export const upsert = (client) => {
             active: item.active ? 1 : 0,
             title: item.title,
             handle: item.handle,
-            template_html: encode_base64_if_needed(item.template_html),
-            template_text: encode_base64_if_needed(item.template_text),
+            template_html: item.template_html && encode_base64_if_needed(item.template_html),
+            template_text: item.template_text && encode_base64_if_needed(item.template_text),
+            template_subject: item.template_subject && encode_base64_if_needed(item.template_subject),
             reference_example_input: JSON.stringify(item.reference_example_input ?? {})
           });
         }
@@ -74,11 +74,9 @@ export const upsert = (client) => {
 
 /**
  * @param {SQL} driver 
- * 
- * 
  * @returns {db_col["get"]}
  */
-const get = (driver) => {
+export const get = (driver) => {
   return (id_or_handle, options) => {
     return driver.client
     .selectFrom(table_name)
@@ -96,6 +94,7 @@ const get = (driver) => {
 
         item.template_html = decode_base64_if_needed(item.template_html);
         item.template_text = decode_base64_if_needed(item.template_text);
+        item.template_subject = decode_base64_if_needed(item.template_subject);
 
         return item;
       }
@@ -106,8 +105,6 @@ const get = (driver) => {
 
 /**
  * @param {SQL} driver 
- * 
- * 
  * @returns {db_col["remove"]}
  */
 const remove = (driver) => {
@@ -162,6 +159,7 @@ const list = (driver) => {
             (item) => {
               item.template_html = decode_base64_if_needed(item.template_html);
               item.template_text = decode_base64_if_needed(item.template_text);
+              item.template_subject = decode_base64_if_needed(item.template_subject);
               return item;
             }
           )

package/types.sql.tables.d.ts

@@ -190,6 +190,7 @@ export interface CollectionsTable extends Base {
 }
 
 export interface TemplatesTable extends Base {
+  template_subject?: string;
   template_html?: string;
   template_text?: string;
   reference_example_input?: JSONColumnType<object>;