@storecraft/database-sql-base 1.0.12 → 1.0.14

package/src/con.templates.js

@@ -42,6 +42,7 @@ export const upsert = (client) => {
             created_at: item.created_at,
             updated_at: item.updated_at,
             id: item.id,
+            active: item.active ? 1 : 0,
             title: item.title,
             handle: item.handle,
             template_html: decode_if_base64(item.template_html),
@@ -95,7 +96,8 @@ const remove = (driver) => {
         async (trx) => {
             
           // entities
-          await delete_search_of(trx, id_or_handle);
+          await delete_search_of(trx, id_or_handle, id_or_handle, table_name);
+
           // delete me
           await delete_me(trx, table_name, id_or_handle);
         }

package/src/utils.funcs.js

@@ -1,5 +1,5 @@
 /**
- * @import { ReplaceValuesOfKeys } from './utils.types.js'
+ * @import { ReplaceValuesOfKeys, ReplaceValuesOfKeys2 } from './utils.types.js'
  */
 
 export const isDef = v => v!==undefined && v!==null;
@@ -29,7 +29,7 @@ export const delete_keys = (...keys) => {
  * Sanitize null/undefined valued keys
  * @template T
  * @param {T} o 
- * @return {ReplaceValuesOfKeys<T, 'active' | 'confirmed_mail', boolean>}
+ * @return {ReplaceValuesOfKeys2<T, 'active' | 'confirmed_mail', boolean>}
  */
 export const sanitize = o => {
   for (const key in o) {
@@ -39,6 +39,10 @@ export const sanitize = o => {
       delete o[key];
       continue;
     }
+    if(key.startsWith('_')) {
+      delete o[key];
+      continue;
+    }
     if(key==='active') {
       // @ts-ignore
       o[key] = Boolean(value);

package/src/utils.query.js

@@ -2,7 +2,7 @@
  * @import { ApiQuery, Cursor } from '@storecraft/core/api'
  * @import { VQL } from '@storecraft/core/vql'
  * @import { Database } from '../types.sql.tables.js'
- * @import { ExpressionBuilder } from 'kysely'
+ * @import { BinaryOperator, ExpressionBuilder } from 'kysely'
  */
 
 import { parse } from "@storecraft/core/vql";
@@ -22,7 +22,9 @@ import { parse } from "@storecraft/core/vql";
  */
 export const query_cursor_to_eb = (eb, c, relation, transformer=(x)=>x) => {
 
+  /** @type {BinaryOperator} */
   let rel_key_1; // relation in last conjunction term in [0, n-1] disjunctions
+  /** @type {BinaryOperator} */
   let rel_key_2; // relation in last conjunction term in last disjunction
 
   if (relation==='>' || relation==='>=') {
@@ -73,9 +75,8 @@ export const query_cursor_to_eb = (eb, c, relation, transformer=(x)=>x) => {
   // return result;
 }
 
-
 /**
- * @template {keyof Database} T
+ * @template {QueryableTables} T
  * @param {ExpressionBuilder<Database>} eb 
  * @param {VQL.Node} node 
  * @param {T} table_name 
@@ -125,7 +126,7 @@ export const query_vql_node_to_eb = (eb, node, table_name) => {
 /**
  * @param {ExpressionBuilder<Database>} eb 
  * @param {VQL.Node} root 
- * @param {keyof Database} table_name 
+ * @param {QueryableTables} table_name 
  */
 export const query_vql_to_eb = (eb, root, table_name) => {
   return root ? query_vql_node_to_eb(eb, root, table_name) : undefined;
@@ -135,26 +136,28 @@ export const query_vql_to_eb = (eb, root, table_name) => {
 /**
  * 
  * @param {[k: string, v: any]} kv 
+ * @param {keyof Database} table_name 
  * @returns {[k: string, v: any]}  
  */
-const transform_boolean_to_0_or_1 = (kv) => {
-  if(typeof kv[1] === 'boolean') {
-    return [
-      kv[0],
-      kv[1] ? 1 : 0
-    ]
-  }
+const transform_boolean_to_0_or_1 = (kv, table_name) => {
+
+  // console.log('transform_boolean_to_0_or_1', kv)
+  kv = [
+    table_name ? `${table_name}.${kv[0]}` : kv[0],
+    typeof kv[1] === 'boolean' ? (kv[1] ? 1 : 0) : kv[1]
+  ];
+
   return kv;
 }
 
 /**
- * Convert an API Query into mongo dialect, also sanitize.
+ * Convert an API Query into dialect, also sanitize.
  * 
  * @template {any} [T=any]
  * 
  * @param {ExpressionBuilder<Database>} eb 
  * @param {ApiQuery<T>} q 
- * @param {keyof Database} table_name 
+ * @param {QueryableTables} table_name 
  * 
  */
 export const query_to_eb = (eb, q={}, table_name) => {
@@ -162,18 +165,19 @@ export const query_to_eb = (eb, q={}, table_name) => {
 
   const sort_sign = q.order === 'asc' ? 1 : -1;
   const asc = sort_sign==1;
+  const transformer = (x) => transform_boolean_to_0_or_1(x, table_name);
 
   // compute index clauses
   if(q.startAt) {
-    clauses.push(query_cursor_to_eb(eb, q.startAt, asc ? '>=' : '<=', transform_boolean_to_0_or_1));
+    clauses.push(query_cursor_to_eb(eb, q.startAt, asc ? '>=' : '<=', transformer));
   } else if(q.startAfter) {
-    clauses.push(query_cursor_to_eb(eb, q.startAfter, asc ? '>' : '<', transform_boolean_to_0_or_1));
+    clauses.push(query_cursor_to_eb(eb, q.startAfter, asc ? '>' : '<', transformer));
   }
 
   if(q.endAt) {
-    clauses.push(query_cursor_to_eb(eb, q.endAt, asc ? '<=' : '>=', transform_boolean_to_0_or_1));
+    clauses.push(query_cursor_to_eb(eb, q.endAt, asc ? '<=' : '>=', transformer));
   } else if(q.endBefore) {
-    clauses.push(query_cursor_to_eb(eb, q.endBefore, asc ? '<' : '>', transform_boolean_to_0_or_1));
+    clauses.push(query_cursor_to_eb(eb, q.endBefore, asc ? '<' : '>', transformer));
   }
 
   // compute VQL clauses 
@@ -197,7 +201,7 @@ const SIGN = {
 // export type DirectedOrderByStringReference<DB, TB extends keyof DB, O> = `${StringReference<DB, TB> | (keyof O & string)} ${OrderByDirection}`;
 
 /**
- * @import {DirectedOrderByStringReference} from './utils.types.js'
+ * @import {DirectedOrderByStringReference, QueryableTables} from './utils.types.js'
  */
 // OE extends OrderByExpression<DB, TB, O>
 /**
@@ -219,9 +223,9 @@ export const query_to_sort = (q={}, table) => {
   // compute sort fields and order
   const keys = q.sortBy?.length ? q.sortBy :  ['updated_at', 'id'];
   const sort = keys.map(
-    s => `${s} ${SIGN[sort_sign]}`
+    s => table ? `${table}.${s} ${SIGN[sort_sign]}` : `${s} ${SIGN[sort_sign]}`
   )
   // it's too complicated to map each ket to table column.
   // kysely was designed to do this in place
-  return sort;
+  return (/** @type {DirectedOrderByStringReference<Database, Table, Database[Table]>[]} */ (sort));
 }

package/src/utils.types.d.ts

@@ -1,4 +1,7 @@
+import { App } from "@storecraft/core";
 import { StringReference } from "kysely";
+import { Database } from "../types.sql.tables.js";
+import { type ApiQuery } from "@storecraft/core/api";
 
 export type NoActive<T> = T extends {active:number} ? Omit<T, 'active'> & {active: boolean} : T;
 export type ReplaceValues<T, Find extends any=any, ReplaceWith extends any=any> = {
@@ -9,9 +12,31 @@ export type ReplaceValuesOfKeys<T, Find extends keyof T=keyof T, ReplaceWith ext
   [K in keyof T]: K extends Find ? ReplaceWith : T[K]
 };
 
+export type ReplaceValuesOfKeys2<T, Find extends keyof T=keyof T, ReplaceWith extends any=any> = {
+  [K in keyof T]: K extends Find ? ReplaceWith : ReplaceValuesOfKeys2<T[K], Find, ReplaceWith>
+};
+
+// export type ENV<T> = Partial<
+//   {
+//     readonly [K in keyof T]: T[K] extends (number | string | boolean | Function | any[]) ? string : ENV<T[K]>
+//     // readonly [K in keyof T]: T[K] extends (any[] | Function) ? string : T[K] extends Record<string, any> ? ENV<T[K]> : (string)
+//   }
+// >;
+
+  
 export type NO<T> = {
   [P in keyof T]: T[P]
 }
 
 export type OrderByDirection = 'asc' | 'desc';
 export type DirectedOrderByStringReference<DB, TB extends keyof DB, O> = `${StringReference<DB, TB> | (keyof O & string)} ${OrderByDirection}`;
+
+/**
+ * Those that are queryable with {@link ApiQuery} object
+ */
+export type QueryableTables = Exclude<
+  keyof Database,
+  'storefronts_to_other' | 'entity_to_media' | 'entity_to_tags_projections' | 
+  'entity_to_search_terms' | 'products_to_collections' | 'products_to_discounts' | 
+  'products_to_variants' | 'products_to_related_products'
+>;

package/tests/Untitled-1.sqlite3-query

@@ -0,0 +1,19 @@
+-- database: ../../../playground/node-libsql/data.db
+
+-- Use the ▷ button in the top right corner to run the entire file.
+
+SELECT 
+  -- products.id, 
+  -- products.handle, 
+  -- products_to_collections.reporter as collection,
+  -- products.*,
+  -- products_to_collections.*,
+  entity_to_tags_projections.value as tag 
+FROM products 
+INNER JOIN 
+  products_to_collections ON products.id = products_to_collections.entity_id
+INNER JOIN 
+  entity_to_tags_projections ON products.id = entity_to_tags_projections.entity_id
+WHERE products_to_collections.reporter = 'playstation-4-games'
+GROUP BY tag
+

package/tests/sandbox.js

@@ -0,0 +1,210 @@
+/**
+ * @import {Database} from '../types.sql.tables.js';
+ */
+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 { jsonArrayFrom, stringArrayFrom } from '../src/con.helpers.json.js';
+import { query_to_sort } from '../src/utils.query.js';
+import { products_with_collections, products_with_discounts, products_with_related_products, products_with_variants, with_media, with_tags } from '../src/con.shared.js';
+
+export const sqlite_dialect = new SqliteDialect({
+  database: async () => new SQLite(join(homedir(), 'db.sqlite')),
+});
+
+export const create_app = async () => {
+  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'
+    })
+  );
+ 
+  await app.init();
+  await migrateToLatest(app.db, false);
+  
+  return app;
+}
+
+/**
+ * @template {keyof Database} [T=keyof Database]
+ * @typedef {{}}
+ */
+
+/**
+ * @type {Record<keyof Database, (keyof Database['collections'])[]>}
+ */
+
+/**
+ * @type {{[K in keyof Database]?: (keyof Database[K])[]}}
+ */
+const resource_to_props = (
+  {
+    'collections': ['active', 'attributes', 'created_at', 'description', 'handle', 'id', 'published', 'title', 'updated_at'],
+    'discounts': ['active', 'application', 'attributes', 'created_at', 'description', 'handle', 'id', 'info', 'priority', 'published', 'title', 'updated_at'],
+    'products': ['active', 'attributes', 'compare_at_price', 'created_at', 'description', 'handle', 'id', 'isbn', 'parent_handle', 'parent_id', 'price', 'qty', 'title', 'updated_at', 'variant_hint', 'variants_options', 'video'],
+    'shipping_methods': ['active', 'attributes', 'created_at', 'description', 'handle', 'id', 'price', 'title', 'updated_at'],
+    'posts': ['active', 'attributes', 'created_at', 'description', 'handle', 'id', 'text', 'title', 'updated_at'],
+  }
+);
+
+
+async function test() {
+  const app = await create_app();
+  const client = app.db.client;
+  const limit = 0;
+  const items = await client.selectNoFrom(
+    eb => [
+      jsonArrayFrom(
+        eb
+        .selectFrom('collections')
+        .select(resource_to_props.collections)
+        .select(
+          eb => [
+            with_tags(eb, eb.ref('collections.id'), app.db.dialectType),
+            with_media(eb, eb.ref('collections.id'), app.db.dialectType),
+          ]
+        )
+        .where('active', '=', 1)
+        .orderBy(['updated_at asc'])
+        .limit(limit),
+        app.db.dialectType
+      ).as('collections'),
+
+      jsonArrayFrom(
+        eb
+        .selectFrom('products')
+        .select(resource_to_props.products)
+        .select(
+          eb => [
+            with_tags(eb, eb.ref('products.id'), app.db.dialectType),
+            with_media(eb, eb.ref('products.id'), app.db.dialectType),
+            products_with_collections(eb, eb.ref('products.id'), app.db.dialectType),
+            products_with_discounts(eb, eb.ref('products.id'), app.db.dialectType),
+            products_with_variants(eb, eb.ref('products.id'), app.db.dialectType),
+            products_with_related_products(eb, eb.ref('products.id'), app.db.dialectType),
+          ]
+        )
+        .where('active', '=', 1)
+        .orderBy(['updated_at asc'])
+        .limit(limit),
+        app.db.dialectType
+      ).as('products'),
+
+      jsonArrayFrom(
+        eb
+        .selectFrom('discounts')
+        .select(resource_to_props.discounts)
+        .select(
+          eb => [
+            with_tags(eb, eb.ref('discounts.id'), app.db.dialectType),
+            with_media(eb, eb.ref('discounts.id'), app.db.dialectType),
+          ]
+        )
+        .where('active', '=', 1)
+        .orderBy(['updated_at asc'])
+        .limit(limit),
+        app.db.dialectType
+      ).as('discounts'),
+
+      jsonArrayFrom(
+        eb
+        .selectFrom('shipping_methods')
+        .select(resource_to_props.shipping_methods)
+        .select(
+          eb => [
+            with_tags(eb, eb.ref('shipping_methods.id'), app.db.dialectType),
+            with_media(eb, eb.ref('shipping_methods.id'), app.db.dialectType),
+          ]
+        )
+        .where('active', '=', 1)
+        .orderBy(['updated_at asc'])
+        .limit(limit),
+        app.db.dialectType
+      ).as('shipping_methods'),
+
+      jsonArrayFrom(
+        eb
+        .selectFrom('posts')
+        .select(resource_to_props.posts)
+        .select(
+          eb => [
+            with_tags(eb, eb.ref('posts.id'), app.db.dialectType),
+            with_media(eb, eb.ref('posts.id'), app.db.dialectType),
+          ]
+        )
+        .where('active', '=', 1)
+        .orderBy(['updated_at asc'])
+        .limit(limit),
+        app.db.dialectType
+      ).as('posts'),
+
+      stringArrayFrom(
+        eb.selectFrom('products')
+        .innerJoin(
+          'products_to_collections', 
+          'products_to_collections.entity_id', 
+          'products.id'
+        )
+        .innerJoin(
+          'entity_to_tags_projections', 
+          'entity_to_tags_projections.entity_id', 
+          'products.id'
+        )
+        .select('entity_to_tags_projections.value as tag')
+        .groupBy('tag'),
+        app.db.dialectType
+      ).as('all_products_tags')
+    ]
+  )
+  .executeTakeFirst();
+
+  console.log(JSON.stringify(items, null, 2))
+}
+
+async function test2() {
+  const app = await create_app();
+  const client = app.db.client;
+  const items = await client.selectNoFrom(
+    eb => Object
+    .entries(resource_to_props)
+    .map(
+      /**
+       * @param {[keyof Database, (keyof Database[keyof Database])[]]} params
+       */
+      ([table_name, props]) => {
+        // console.log(table_name, props)
+        // props
+        return jsonArrayFrom(
+          eb
+          .selectFrom(table_name)
+          .select(props)
+          .orderBy(['updated_at asc'])
+          .limit(0),
+          app.db.dialectType
+        ).as(table_name)
+      }
+    )
+  )
+  .executeTakeFirst();
+
+  console.log(JSON.stringify(items, null, 2))
+}
+
+test();
+

package/types.sql.tables.d.ts

@@ -1,17 +1,15 @@
-import { AttributeType, AuthUserType, Role, TagType, 
+import { 
+  AttributeType, AuthUserType, Role, TagType, 
   CollectionType, ProductType, ShippingMethodType,
   VariantOption, PostType, CustomerType,
   VariantOptionSelection, OrderData, StorefrontType,
-  AddressType, ImageType,
-  OrderContact,
-  LineItem,
-  OrderStatus, DiscountType,
-  PricingData,
-  ValidationEntry,
+  AddressType, ImageType, OrderContact,
+  LineItem, OrderStatus, DiscountType,
+  PricingData, ValidationEntry,
   OrderPaymentGatewayData, NotificationType,
-  NotificationAction,
-  DiscountInfo,
-  DiscountApplicationEnum} from '@storecraft/core/api'
+  NotificationAction, DiscountInfo,
+  DiscountApplicationEnum
+} from '@storecraft/core/api'
 import {
   ColumnType,
   Generated,
@@ -61,48 +59,104 @@ export interface entity_to_value {
 }
 
 export interface entity_to_media extends entity_to_value {}
-export interface entity_to_tags_projections extends entity_to_value {}
+
+/**
+ * **Here**:
+ * - (`entity_id`, `entity_handle`) = (entity id, entity handle) of the resource for example (product id, product handle)
+ * - (`value`) = search term , for example 'game', 'shoes'
+ * - (`context`) = the resource name `tags` / `collections` / `products` / `posts` / `discounts` / `shipping` / `storefronts` / `notifications` / 'auth_users' etc...)
+ * 
+ * **Note**:
+ * - `entity_id` ALWAYS IDENTIFIES THE ENTITY
+ * - `entity_handle` DOES NOT IDENTIFY (imagine a product and collection with same handle)
+ * - `entity_handle` + `context` ALWAYS IDENTIFIES AN ENTITY
+ */
 export interface entity_to_search_terms extends entity_to_value {}
 
+/**
+ * Here:
+ * - (`entity_id`, `entity_handle`) = (entity id, entity handle) of the resource for example (product id, product handle)
+ * - (`value`) = search term , for example 'game', 'shoes'
+ * - (`context`) = the resource name `tags` / `collections` / `products` / `posts` / `discounts` / `shipping` / `storefronts` / `notifications` / 'auth_users' etc...)
+ * 
+ * Note:
+ * - `entity_id` ALWAYS IDENTIFIES AN ENTITY
+ * - `entity_handle` DOES NOT IDENTIFY AN ENTITY (imagine a product and collection with same handle)
+ * - `entity_handle` + `context` ALWAYS IDENTIFIES AN ENTITY
+ */
+export interface entity_to_tags_projections extends entity_to_value {}
+
 /**
  * here:
- * - entity_id, entity_handle = product id, product handle
- * - value, reporter = collection id,  collection handle
+ * - (`entity_id`, `entity_handle`) = (product id, product handle)
+ * - (`value`, `reporter`) = (collection id, collection handle)
+ * - (`context`) = NULL
+ * 
+ * NOTE:
+ * - `entity_id` ALWAYS IDENTIFIES AN ENTITY
+ * - `entity_handle` ALWAYS IDENTIFIES AN ENTITY
+ * - `value` ALWAYS IDENTIFIES AN ENTITY
+ * - `reporter` ALWAYS IDENTIFIES AN ENTITY
  */
 export interface products_to_collections extends entity_to_value {}
 
 /**
  * here:
- * - entity_id, entity_handle = product id, product handle
- * - value, reporter = discount id,  discount handle
+ * - (`entity_id`, `entity_handle`) = (product id, product handle)
+ * - (`value`, `reporter`) = (discount id,  discount handle)
+ * 
+ * NOTE:
+ * - `entity_id` ALWAYS IDENTIFIES AN ENTITY
+ * - `entity_handle` ALWAYS IDENTIFIES AN ENTITY
+ * - `value` ALWAYS IDENTIFIES AN ENTITY
+ * - `reporter` ALWAYS IDENTIFIES AN ENTITY
  */
 export interface products_to_discounts extends entity_to_value {}
 
 /**
  * here:
- * - (entity_id, entity_handle) = (parent product id, parent product handle)
- * - (value, reporter) = (variant product id,  variant product handle)
+ * - (`entity_id`, `entity_handle`) = (parent product id, parent product handle)
+ * - (`value`, `reporter`) = (variant product id,  variant product handle)
+ * 
+ * NOTE:
+ * - `entity_id` ALWAYS IDENTIFIES AN ENTITY
+ * - `entity_handle` ALWAYS IDENTIFIES AN ENTITY
+ * - `value` ALWAYS IDENTIFIES AN ENTITY
+ * - `reporter` ALWAYS IDENTIFIES AN ENTITY
  */
 export interface products_to_variants extends entity_to_value {}
 
 /**
  * here:
- * - (entity_id, entity_handle) = (parent product id, parent product handle)
- * - (value, reporter) = (related product id,  related product handle)
+ * - (`entity_id`, `entity_handle`) = (parent product id, parent product handle)
+ * - (`value`, `reporter`) = (related product id, related product handle)
+ * 
+ * NOTE:
+ * - `entity_id` ALWAYS IDENTIFIES AN ENTITY
+ * - `entity_handle` ALWAYS IDENTIFIES AN ENTITY
+ * - `value` ALWAYS IDENTIFIES AN ENTITY
+ * - `reporter` ALWAYS IDENTIFIES AN ENTITY
  */
 export interface products_to_related_products extends entity_to_value {}
 
 /**
  * storefronts to products/collections/posts/discounts/shipping
  * here:
- * - entity_id, entity_handle = storefront id, storefront handle
- * - value, reporter = other entity id,  other entity handle, i.e(product_id, product_handle)
- * - context = `products` / `collections` / `posts` / `discounts` / `shipping`
+ * - (entity_id, entity_handle) = (storefront id, storefront handle)
+ * - (value, reporter) = (other entity id,  other entity handle), i.e(product_id, product_handle)
+ * - (context) = `products` / `collections` / `posts` / `discounts` / `shipping`
  * 
  * This will probably be a small table hence everything is recorded in the same table.
  * Usually, a user will have:
  * - small number of storefronts
  * - small number of attached products/collections/posts/discounts/shipping per storefront
+ * 
+ * NOTE:
+ * - `entity_id` ALWAYS IDENTIFIES AN ENTITY
+ * - `entity_handle` ALWAYS IDENTIFIES AN ENTITY
+ * - `value` ALWAYS IDENTIFIES AN ENTITY
+ * - `reporter` DOES NOT IDENTIFY AN ENTITY (because you can have a product and a collection with the same handle for example)
+ * - `reporter` + `context` ALWAYS IDENTIFIES AN ENTITY (in case you need to delete)
  */
 export interface storefronts_to_other extends entity_to_value {}