@storecraft/database-sqlite 1.0.1

package/README.md

@@ -0,0 +1,148 @@
+# Storecraft `SQLite` driver
+
+<div style="text-align:center">
+  <img src='https://storecraft.app/storecraft-color.svg' 
+       width='90%'' />
+</div><hr/><br/>
+
+Official `SQLite` driver for `StoreCraft` using `better-sqlite` package.
+
+```bash
+npm i @storecraft/database-sqlite
+```
+
+## 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/platforms/node';
+import { SQLite } from '@storecraft/database-sqlite'
+import { migrateToLatest } from '@storecraft/database-sql-base/migrate.js'
+import { NodeLocalStorage } from '@storecraft/storage-local/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 SQLite(
+    { 
+      filename: join(homedir(), 'db.sqlite') 
+    }
+  )
+)
+.withStorage(new NodeLocalStorage(join(homedir(), 'tomer')))
+
+await app.init();
+await migrateToLatest(app.db, false);
+ 
+const server = http.createServer(app.handler).listen(
+  8000,
+  () => {
+    console.log(`Server is running on http://localhost:8000`);
+  }
+); 
+
+```
+
+## Testing Locally
+
+### **SQLite**
+1. Simply `runner.sqlite-local.test.js`
+```bash
+npm run test:sqlite
+```
+
+### **Postgres**
+1. First setup a `postgres` server
+```bash
+docker pull postgres
+docker run --name some-postgres -e POSTGRES_USER=admin -e POSTGRES_PASSWORD=admin \
+          -e PGDATA=/var/lib/postgresql/data/pgdata \
+	        -v $(pwd):/var/lib/postgresql/data \
+          -p 5432:5432 -d postgres
+```
+
+2. create Environment
+create `.env` file with
+```bash
+POSTGRES_USER='user'
+POSTGRES_PASSWORD='password'
+POSTGRES_PORT=5432
+POSTGRES_HOST='localhost'
+```
+
+3. Run `runner.postgres-local.test.js`
+```bash
+npm run test:postgres
+```
+
+### **MySQL**
+1. First setup a `mysql` server
+```zsh
+docker pull mysql
+docker run --name mysql \
+           -v $(pwd):/etc/mysql/conf.d \
+           -v /my/own/datadir:/var/lib/mysql \
+           -e MYSQL_ROOT_PASSWORD=admin -e MYSQL_ROOT_HOST=localhost \
+           -e MYSQL_DATABASE=main -e MYSQL_USER=admin -e MYSQL_PASSWORD=admin \
+           -p 8080:3306 -d mysql
+```
+
+2. create Environment
+create `.env` file with
+```bash
+MYSQL_USER='root'
+MYSQL_ROOT_PASSWORD='password'
+MYSQL_PORT=8080
+MYSQL_HOST='localhost'
+```
+
+3. Run `runner.mysql-local.test.js`
+```bash
+npm run test:mysql
+```
+
+### **MSSQL** (Currently NOT SUPPORTED, waiting for votes on that one)
+Work in progress, i will probably not continue with this.
+
+1. First setup a `mysql` server
+```zsh
+docker pull mcr.microsoft.com/mssql/server
+# use this For OSX with M1 chips
+docker pull mcr.microsoft.com/azure-sql-edge:latest
+docker run --name some-mssql \
+           -e ACCEPT_EULA=Y -e MSSQL_SA_PASSWORD='Abcd1234!?' \
+           -v $(pwd):/var/opt/mssql \
+           -p 1433:1433 \
+           -d mcr.microsoft.com/azure-sql-edge:latest
+
+```
+
+2. create Environment
+create `.env` file with
+```bash
+MYSQL_USER='root'
+MYSQL_ROOT_PASSWORD='password'
+MYSQL_PORT=8080
+MYSQL_HOST='localhost'
+```
+
+3. Run `runner.mysql-local.test.js`
+```bash
+npm run test:mysql
+```
+
+
+```text
+Author: Tomer Shalev <tomer.shalev@gmail.com>
+```

package/index.js

@@ -0,0 +1,30 @@
+import { SQL } from '@storecraft/database-sql-base';
+import { SqliteDialect } from 'kysely';
+import BetterSQLite from 'better-sqlite3';
+
+
+/**
+ * @description `better-sqlite` driver for storecraft
+ * 
+ */
+export class SQLite extends SQL {
+
+  /**
+   * 
+   * @param {import('./types.public.d.ts').Config} [config] config 
+   */
+  constructor(config) {
+    super(
+      {
+        dialect_type: 'SQLITE',
+        dialect: new SqliteDialect(
+          {
+            database: async () => new BetterSQLite(config.filename, config.options)
+          }
+        ),
+      }
+    );
+
+  }
+
+}

package/migrate.js

@@ -0,0 +1,5 @@
+export { migrateToLatest } from '@storecraft/database-sql-base/migrate.js';
+
+
+
+

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@storecraft/database-sqlite",
+  "version": "1.0.1",
+  "description": "Official SQLite Database driver for storecraft",
+  "license": "MIT",
+  "author": "Tomer Shalev (https://github.com/store-craft)",
+  "homepage": "https://github.com/store-craft/storecraft",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/store-craft/storecraft.git",
+    "directory": "packages/databases/database-sqlite"
+  },
+  "keywords": [
+    "commerce",
+    "dashboard",
+    "code",
+    "storecraft"
+  ],
+  "type": "module",
+  "main": "index.js",
+  "types": "types.public.d.ts",
+  "scripts": {
+    "test": "uvu -c",
+    "database-sqlite:test": "node ./tests/runner.test.js",
+    "database-sqlite:publish": "npm publish --access public"
+  },
+  "dependencies": {
+    "@storecraft/core": "^1.0.0",
+    "@storecraft/database-sql-base": "^1.0.0",
+    "@types/better-sqlite3": "^7.6.9",
+    "kysely": "^0.27.2"
+  },
+  "devDependencies": {
+    "@storecraft/platforms": "^1.0.0",
+    "@storecraft/test-runner": "^1.0.0",
+    "@types/node": "^20.11.0",
+    "dotenv": "^16.3.1",
+    "uvu": "^0.5.6"
+  }
+}

package/src/con.auth_users.js

@@ -0,0 +1,160 @@
+import { SQL } from '../index.js'
+import { 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} from './con.shared.js'
+import { query_to_eb, query_to_sort } from './utils.query.js';
+
+/**
+ * @typedef {import('@storecraft/core/v-database').db_auth_users} db_col
+ */
+
+export const table_name = 'auth_users';
+
+/**
+ * @param {SQL} driver 
+ * @returns {db_col["upsert"]}
+ */
+const upsert = (driver) => {
+
+  return async (item, search_terms=[]) => {
+    const c = driver.client;
+    try {
+      const t = await c.transaction().execute(
+        async (trx) => {
+
+          await insert_tags_of(trx, item.tags, item.id, item.email, table_name);
+          await insert_search_of(trx, search_terms, item.id, item.email, table_name);
+
+          return await regular_upsert_me(trx, table_name, {
+            confirmed_mail: item.confirmed_mail ? 1 : 0,
+            email: item.email,
+            handle: item.email,
+            password: item.password,
+            created_at: item.created_at,
+            updated_at: item.updated_at,
+            id: item.id,
+            roles: JSON.stringify(item.roles),
+          });
+        }
+      );
+      return t.numInsertedOrUpdatedRows>0;
+    } catch(e) {
+      console.log(e);
+      return false;
+    }
+    return true;
+  }
+}
+
+/**
+ * @param {SQL} driver 
+ * @returns {db_col["get"]}
+ */
+const get = (driver) => {
+  return (id_or_email, options) => {
+    return driver.client
+      .selectFrom(table_name)
+      .selectAll()
+      .where(where_id_or_handle_table(id_or_email))
+      .executeTakeFirst();
+  }
+}
+
+
+/**
+ * @param {SQL} driver 
+ * @returns {db_col["getByEmail"]}
+ */
+const getByEmail = (driver) => {
+  return (email) => {
+    return driver.client
+      .selectFrom('auth_users')
+      .selectAll().where('email', '=', email)
+      .executeTakeFirst();
+  }
+}
+
+/**
+ * @param {SQL} driver 
+ * @returns {db_col["remove"]}
+ */
+const remove = (driver) => {
+  return async (id_or_email) => {
+    try {
+      await driver.client.transaction().execute(
+        async (trx) => {
+            
+          // entities
+          // delete me
+          await delete_me(trx, table_name, id_or_email);
+        }
+      );
+    } catch(e) {
+      console.log(e);
+      return false;
+    }
+    return true;
+  }
+}
+/**
+ * @param {SQL} driver 
+ * @returns {db_col["removeByEmail"]}
+ */
+const removeByEmail = (driver) => {
+  return async (email) => {
+    const r = await driver.client
+      .deleteFrom('auth_users')
+      .where('email', '=', email)
+      .executeTakeFirst();
+    return r.numDeletedRows>0;
+  }
+}
+
+/**
+ * @param {SQL} driver 
+ * 
+ * 
+ * @returns {db_col["list"]}
+ */
+const list = (driver) => {
+  return async (query) => {
+
+    const items = await driver.client.selectFrom(table_name)
+      .selectAll()
+      .select(eb => [
+        with_tags(eb, eb.ref('auth_users.id'), driver.dialectType),
+        with_media(eb, eb.ref('auth_users.id'), driver.dialectType),
+      ])
+      .where(
+        (eb) => {
+          return query_to_eb(eb, query, table_name);
+        }
+      )
+      .orderBy(query_to_sort(query))
+      .limit(query.limitToLast ?? query.limit ?? 10)
+      .execute();
+
+    if(query.limitToLast) items.reverse();
+
+    return items;
+  }
+}
+
+/** 
+ * @param {SQL} driver
+ * @return {db_col}}
+ * */
+export const impl = (driver) => {
+
+  return {
+    get: get(driver),
+    getByEmail: getByEmail(driver),
+    upsert: upsert(driver),
+    remove: remove(driver),
+    removeByEmail: removeByEmail(driver),
+    list: list(driver),
+    count: count_regular(driver, table_name),
+  }
+}

package/src/con.collections.js

@@ -0,0 +1,197 @@
+import { SQL } from '../index.js'
+import { report_document_media } from './con.images.js'
+import { delete_entity_values_by_value_or_reporter, delete_me, 
+  delete_media_of, delete_search_of, delete_tags_of, 
+  insert_media_of, insert_search_of, insert_tags_of, 
+  select_entity_ids_by_value_or_reporter, 
+  regular_upsert_me, where_id_or_handle_table, 
+  with_media, with_tags, 
+  count_regular} from './con.shared.js'
+import { sanitize_array } from './utils.funcs.js'
+import { query_to_eb, query_to_sort } from './utils.query.js'
+
+
+/**
+ * @typedef {import('@storecraft/core/v-database').db_collections} db_col
+ */
+export const table_name = 'collections'
+
+/**
+ * @param {SQL} driver 
+ * @returns {db_col["upsert"]}
+ */
+const upsert = (driver) => {
+  return async (item, search_terms) => {
+    const c = driver.client;
+    try {
+      const t = await driver.client.transaction().execute(
+        async (trx) => {
+
+          // entities
+          await insert_tags_of(trx, item.tags, item.id, item.handle, table_name);
+          await insert_search_of(trx, search_terms, item.id, item.handle, table_name);
+          await insert_media_of(trx, item.media, item.id, item.handle, table_name);
+          await report_document_media(driver)(item, trx);
+          // main
+          await regular_upsert_me(trx, table_name, {
+            created_at: item.created_at,
+            updated_at: item.updated_at,
+            id: item.id,
+            handle: item.handle,
+            active: item.active ? 1 : 0,
+            attributes: JSON.stringify(item.attributes),
+            description: item.description,
+            published: item.published,
+            title: item.title
+          });
+        }
+      );
+    } catch(e) {
+      console.log(e);
+      return false;
+    }
+    return true;
+  }
+}
+
+
+/**
+ * @param {SQL} driver 
+ * @returns {db_col["get"]}
+ */
+const get = (driver) => {
+  return (id_or_handle, options) => {
+
+    return driver.client
+      .selectFrom(table_name)
+      .selectAll('collections')
+      .select(eb => [
+        with_tags(eb, eb.ref('collections.id'), driver.dialectType),
+        with_media(eb, eb.ref('collections.id'), driver.dialectType)
+      ])
+      .where(where_id_or_handle_table(id_or_handle))
+    //  .compile()
+      .executeTakeFirst();
+  }
+}
+
+
+/**
+ * @param {SQL} driver 
+ * @returns {db_col["remove"]}
+ */
+const remove = (driver) => {
+  return async (id_or_handle) => {
+    try {
+      await driver.client.transaction().execute(
+        async (trx) => {
+            
+          // entities
+          await delete_tags_of(trx, id_or_handle);
+          await delete_search_of(trx, id_or_handle);
+          await delete_media_of(trx, id_or_handle);
+          // PRODUCTS -> COLLECTIONS
+          await delete_entity_values_by_value_or_reporter('products_to_collections')(
+            trx, id_or_handle, id_or_handle
+          );
+          // STOREFRONT => COLLECTIONS
+          await delete_entity_values_by_value_or_reporter('storefronts_to_other')(
+            trx, id_or_handle, id_or_handle
+          );
+
+          // delete me
+          await delete_me(trx, table_name, id_or_handle);
+        }
+      );
+
+    } catch(e) {
+      console.log(e);
+      return false;
+    }
+    return true;
+  }
+}
+
+/**
+ * @param {SQL} driver 
+ * @returns {db_col["list"]}
+ */
+const list = (driver) => {
+  return async (query) => {
+
+    const items = await driver.client.selectFrom(table_name)
+      .selectAll()
+      .select(eb => [
+        with_tags(eb, eb.ref('collections.id'), driver.dialectType),
+        with_media(eb, eb.ref('collections.id'), driver.dialectType),
+      ])
+      .where(
+        (eb) => {
+          return query_to_eb(eb, query, table_name);
+        }
+      )
+      .orderBy(query_to_sort(query))
+      .limit(query.limitToLast ?? query.limit ?? 10)
+      .execute();
+
+    if(query.limitToLast) items.reverse();
+
+    return sanitize_array(items);
+  }
+}
+
+/**
+ * @param {SQL} driver 
+ * @returns {db_col["list_collection_products"]}
+ */
+const list_collection_products = (driver) => {
+  return async (handle_or_id, query={}) => {
+
+    const items = await driver.client
+      .selectFrom('products')
+      .selectAll()
+      .select(eb => [
+        with_media(eb, eb.ref('products.id'), driver.dialectType),
+        with_tags(eb, eb.ref('products.id'), driver.dialectType),
+      ])
+      .where(
+        (eb) => eb.and(
+          [
+            query_to_eb(eb, query, 'products'),
+            eb('products.id', 'in', 
+              eb => select_entity_ids_by_value_or_reporter( // select all the product ids by collection id
+                eb, 'products_to_collections', handle_or_id
+              )
+            )
+          ].filter(Boolean)
+        )
+      )
+      .orderBy(query_to_sort(query))
+      .limit(query.limitToLast ?? query.limit ?? 10)
+      .execute();
+
+    if(query.limitToLast) items.reverse();
+
+    return sanitize_array(items);
+  }
+}
+
+/** 
+ * @param {SQL} driver
+ * 
+ * 
+ * @return {db_col}}
+ * */
+export const impl = (driver) => {
+
+  return {
+
+    get: get(driver),
+    upsert: upsert(driver),
+    remove: remove(driver),
+    list: list(driver),
+    list_collection_products: list_collection_products(driver),
+    count: count_regular(driver, table_name),
+
+  }
+}