@storecraft/database-mongodb 1.0.21 → 1.2.6

package/README.md

@@ -45,16 +45,15 @@ const app = new App()
     }
   )
 )
+.init();
 
-await app.init();
-await migrateToLatest(app.db, false);
-// create if not exists
-await app.vectorstore.createVectorIndex(false, false);
+await migrateToLatest(app.__show_me_everything.db, false);
+await app.__show_me_everything.vector_store.createVectorIndex();
 
-const server = http.createServer(app.handler).listen(
+http.createServer(app.handler).listen(
   8000,
   () => {
-    console.log(`Server is running on http://localhost:8000`);
+    app.print_banner('http://localhost:8000');
   }
 ); 
 

package/index.js

@@ -19,6 +19,7 @@ import { impl as storefronts } from './src/con.storefronts.js';
 import { impl as tags } from './src/con.tags.js';
 import { impl as templates } from './src/con.templates.js';
 import { impl as search } from './src/con.search.js';
+import { impl as chats } from './src/con.chats.js';
 export { migrateToLatest } from './migrate.js';
 export { MongoVectorStore } from './vector-store/index.js';
 
@@ -28,7 +29,7 @@ export { MongoVectorStore } from './vector-store/index.js';
 export class MongoDB {
 
   /** @satisfies {ENV<Config>} */
-  static EnvConfig = /** @type{const} */ ({
+  static EnvConfig = /** @type {const} */ ({
     db_name: 'MONGODB_NAME',
     url: 'MONGODB_URL',
   });
@@ -73,8 +74,8 @@ export class MongoDB {
 
     const c = this.#config;
 
-    c.db_name ??= app.platform.env[MongoDB.EnvConfig.db_name];
-    c.url ??= app.platform.env[MongoDB.EnvConfig.url] ?? 'main';
+    c.db_name ??= app.env[MongoDB.EnvConfig.db_name];
+    c.url ??= app.env[MongoDB.EnvConfig.url] ?? 'main';
 
     if(!this.config.db_name || !this.config.url) {
       throw new Error(
@@ -98,6 +99,7 @@ export class MongoDB {
       shipping_methods: shipping(this),
       templates: templates(this),
       search: search(this),
+      chats: chats(this),
     }
     
     this.#is_ready = true; 

package/migrations/00005_add_chats_collection.js

@@ -0,0 +1,57 @@
+import { Db, MongoClient } from 'mongodb';
+
+const collections = [
+  'chats'
+];
+
+/**
+ * @param {Db} db 
+ * @param {MongoClient} client 
+ */
+export async function up(db, client) {
+
+  const session = client.startSession();
+  try {
+    await session.withTransaction(async ($session) => {
+      for (const collection_name of collections) {
+
+        await db.createCollection(collection_name, {session: $session})
+        await db.collection(collection_name).dropIndexes({ session: $session });
+
+        await db.collection(collection_name).createIndexes(
+          [
+            {
+              key: { handle: 1 }, name: 'handle+', 
+              background: false, unique: true, sparse: true
+            }, 
+            {
+              key: { updated_at: 1, _id: 1 }, name: '(updated_at+, _id+)', 
+              background: false, sparse: true
+            }, 
+            {
+              key: { updated_at: -1, _id: -1 }, name: '(updated_at-, _id-)', 
+              background: false, sparse: true
+            }, 
+            {
+              key: { search: 1 }, name: '(search+)', 
+              background: false, sparse: true
+            }, 
+          ], {
+            session: $session
+          }
+        )
+      }
+
+    });
+  } finally {
+    await session.endSession();
+  }
+}
+
+/**
+ * 
+ * @param {Db} db 
+ * @param {MongoClient} client 
+ */
+export async function down(db, client) {
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storecraft/database-mongodb",
-  "version": "1.0.21",
+  "version": "1.2.6",
   "description": "Storecraft database driver for mongodb on node / bun / deno platform",
   "license": "MIT",
   "author": "Tomer Shalev (https://github.com/store-craft)",
@@ -36,8 +36,7 @@
     "database-mongodb:docker-compose-up": "docker compose -f ./tests/docker-compose.yml up -d ",
     "database-mongodb:test": "node ./tests/runner.test.js",
     "test": "npm run database-mongodb:test",
-    "prepublishOnly": "npm version patch --force",
-    "sc-publish": "npm publish"
+    "sc-publish": "npm version patch --force --no-git-tag-version && npm publish"
   },
   "dependencies": {
     "@storecraft/core": "^1.0.0",

package/src/con.chats.js

@@ -0,0 +1,119 @@
+/**
+ * @import { db_chats as db_col } from '@storecraft/core/database'
+ * @import { WithRelations } from './utils.types.js'
+ */
+import { Collection } from 'mongodb'
+import { MongoDB } from '../index.js'
+import { count_regular, get_regular, list_regular } from './con.shared.js'
+import { handle_or_id, to_objid } from './utils.funcs.js';
+import { 
+  add_search_terms_relation_on, delete_me, 
+  save_me, 
+} from './utils.relations.js';
+
+/**
+ * @param {MongoDB} d 
+ * @returns {Collection<WithRelations<db_col["$type_get"]>>}
+ */
+const col = (d) => d.collection('chats');
+
+/**
+ * @param {MongoDB} driver 
+ * @returns {db_col["upsert"]}
+ */
+const upsert = (driver) => {
+  return async (data, search_terms=[]) => {
+    data = {...data};
+    const objid = to_objid(data.id);
+    const session = driver.mongo_client.startSession();
+
+    try {
+      await session.withTransaction(
+        async () => {
+
+          // SEARCH
+          add_search_terms_relation_on(data, search_terms);
+
+          // SAVE ME
+          await save_me(driver, 'chats', objid, data, session);
+
+        }
+      );
+    } catch(e) {
+      console.log(e);
+      return false;
+    } finally {
+      await session.endSession();
+    }
+
+    return true;
+  }
+
+}
+/**
+ * @param {MongoDB} driver 
+ */
+const get = (driver) => get_regular(driver, col(driver));
+
+/**
+ * @param {MongoDB} driver 
+ * @returns {db_col["remove"]}
+ */
+const remove = (driver) => {
+  return async (id_or_handle) => {
+    const item = await col(driver).findOne(handle_or_id(id_or_handle));
+
+    if(!item) return;
+
+    const objid = to_objid(item.id)
+    const session = driver.mongo_client.startSession();
+
+    try {
+      await session.withTransaction(
+        async () => {
+
+          // DELETE ME
+          await delete_me(
+            driver, 'chats', objid, session
+          );
+
+        }
+      );
+    } catch(e) {
+      console.log(e);
+      return false;
+    } finally {
+      await session.endSession();
+    }
+
+    return true;
+  }
+
+}
+
+
+/**
+ * @param {MongoDB} driver 
+ */
+const list = (driver) => list_regular(driver, col(driver));
+
+/**
+ * @param {MongoDB} driver 
+ */
+const count = (driver) => count_regular(driver, col(driver));
+
+/** 
+ * @param {MongoDB} driver
+ * @return {db_col & { _col: ReturnType<col>}}
+ */
+export const impl = (driver) => {
+
+  return {
+    _col: col(driver),
+    get: get(driver),
+    upsert: upsert(driver),
+    remove: remove(driver),
+    list: list(driver),
+    count: count(driver),
+  }
+}

package/src/con.search.js

@@ -20,7 +20,8 @@ const tables = [
   'notifications',
   'discounts',
   'orders',
-  'templates'
+  'templates',
+  'chats'
 ]
 
 /**
@@ -40,7 +41,23 @@ const prefix_to_resource = {
   'tag': 'tags',
   'template': 'templates',
   'post': 'posts',
-  
+  'chat': 'chats',
+}
+
+const resource_to_props = {
+  'auth_users': ['id', 'handle'],
+  'collections': ['id', 'handle'],
+  'customers': ['id', 'handle'],
+  'discounts': ['id', 'handle', 'title'],
+  'images': ['id', 'handle', 'name'],
+  'orders': ['id'],
+  'products': ['id', 'handle', 'title'],
+  'shipping_methods': ['id', 'handle', 'title'],
+  'storefronts': ['id', 'handle', 'title'],
+  'tags': ['id', 'handle'],
+  'templates': ['id', 'handle', 'title'],
+  'posts': ['id', 'handle', 'title'],
+  'chats': ['id', 'customer_email', 'customer_id'],
 }
 
 /**
@@ -87,10 +104,15 @@ export const quicksearch = (driver) => {
       },
       {
         $project: { 
-          title: 1,
-          handle: 1,
-          // '_relations.search': 1,
           id: 1,
+          handle: 1,
+
+          title: 1,
+          name: 1,
+
+          customer_email: 1,
+          customer_id: 1,
+
           _id: 0
         }
       }

package/src/con.shared.js

@@ -23,9 +23,10 @@ import { add_search_terms_relation_on } from './utils.relations.js'
  * @template {Partial<withConcreteIdAndHandle<{}>>} G
  * @param {MongoDB} driver 
  * @param {Collection<G>} col 
+ * @param {(input: T) => T} [hook_pre_write=x=>x] 
  * @returns {db_crud<T, G>["upsert"]}
  */
-export const upsert_regular = (driver, col) => {
+export const upsert_regular = (driver, col, hook_pre_write=x=>x) => {
   
   return async (data, search_terms=[]) => {
 
@@ -64,7 +65,7 @@ export const upsert_regular = (driver, col) => {
           await col.insertOne(
             // @ts-ignore
             {
-              ...data,
+              ...hook_pre_write(data),
               _id: data.id ? to_objid(data.id) : undefined,
             },
             { 
@@ -180,9 +181,10 @@ export const expand_to_mongo_projection = (expand) => {
  * @template T, G
  * @param {MongoDB} driver 
  * @param {Collection<G>} col 
+ * @param {(input: G) => G} [hook_post=x=>x] 
  * @returns {db_crud<T, G>["get"]}
  */
-export const get_regular = (driver, col) => {
+export const get_regular = (driver, col, hook_post=x=>x) => {
   return async (id_or_handle, options) => {
     const filter = handle_or_id(id_or_handle);
 
@@ -203,7 +205,9 @@ export const get_regular = (driver, col) => {
     );
 
     return /** @type {G} */(
-      sanitize_one(res)
+      hook_post(
+        /** @type {G} */(sanitize_one(res))
+      )
     );
   }
 }

package/src/con.templates.js

@@ -7,6 +7,31 @@ import {
   count_regular, get_regular, list_regular, 
   remove_regular, upsert_regular 
 } from './con.shared.js'
+import { base64 } from '@storecraft/core/crypto';
+
+/**
+ * @description if `base64_` prefixed then decode the postfix and return it,
+ * otherwise, just return the original value.
+ * @param {string} 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;
+
+  return base64.decode(val.split('base64_').at(-1) ?? '');
+}
 
 /**
  * @param {MongoDB} d 
@@ -18,12 +43,38 @@ const col = (d) => d.collection('templates');
  * @param {MongoDB} driver 
  * @returns {db_col["upsert"]}
  */
-const upsert = (driver) => upsert_regular(driver, col(driver));
+const upsert = (driver) => upsert_regular(
+  driver, col(driver),
+  (before) => {
+    return before && {
+      ...before,
+      template_html: before?.template_html && 
+        encode_base64_if_needed(before?.template_html),
+      template_text: before?.template_text && 
+        encode_base64_if_needed(before?.template_text),
+      template_subject: before?.template_subject && 
+        encode_base64_if_needed(before?.template_subject),
+    }
+  },
+);
 
 /**
  * @param {MongoDB} driver 
  */
-const get = (driver) => get_regular(driver, col(driver));
+const get = (driver) => get_regular(
+  driver, col(driver),
+  (item) => {
+    return item && {
+      ...item,
+      template_html: item?.template_html && 
+        decode_base64_if_needed(item?.template_html),
+      template_text: item?.template_text && 
+        decode_base64_if_needed(item?.template_text),
+      template_subject: item?.template_subject && 
+        decode_base64_if_needed(item?.template_subject),
+    }
+  }
+);
 
 /**
  * @param {MongoDB} driver 

package/tests/runner.test.js

@@ -8,8 +8,8 @@ import { api } from '@storecraft/core/test-runner';
 // Main MongoDB test suite with the core test-runner for api layer
 //
 
-export const create_app = async () => {
-  const app = new App(
+export const create_app = () => {
+  return new App(
     {
       auth_admins_emails: ['admin@sc.com'],
       auth_secret_access_token: 'auth_secret_access_token',
@@ -26,24 +26,22 @@ export const create_app = async () => {
         url: process.env.MONGODB_URL,
       }
     )
-  )
-  
-  return app.init()
+  ).init();
 }
 
 async function test() {
-  const app = await create_app();
+  const app = create_app();
 
-  await migrateToLatest(app.db, false);
+  await migrateToLatest(app._.db, false);
  
   Object.entries(api).slice(0, -1).forEach(
     ([name, runner]) => {
-      runner.create(app).run();
+      runner.create(app._.app).run();
     }
   );
   
-  const last_test = Object.values(api).at(-1).create(app);
-  last_test.after(async ()=>{app.db.disconnect()});
+  const last_test = Object.values(api).at(-1).create(app._.app);
+  last_test.after(async ()=>{app._.db.disconnect()});
   last_test.run();
 }
 

package/tests/sandbox.js

@@ -16,21 +16,21 @@ export const create_app = async () => {
   )
   .withPlatform(new NodePlatform())
   .withDatabase(new MongoDB({ db_name: 'test'}))
+  .init();
   
-  await app.init();
-  await migrateToLatest(app.db, false);
+  await migrateToLatest(app.__show_me_everything.db, false);
   return app;
 }
 
 
 async function test() {
   const app = await create_app();
-
-  const sf = await app.db.resources.storefronts.get_default_auto_generated_storefront()
+  const db = app.__show_me_everything.db;
+  const sf = await db.resources.storefronts.get_default_auto_generated_storefront()
 
   console.log(JSON.stringify(sf, null, 2));
 
-  await app.db.disconnect();
+  await db.disconnect();
 }
 
 test();

package/vector-store/index.js

@@ -15,6 +15,7 @@ mongo_vectorSearch_pipeline,
  * } from 'mongodb'
  * @import { ENV } from '@storecraft/core';
  */
+import { truncate_or_pad_vector } from '@storecraft/core/ai/models/vector-stores/index.js';
 import { Collection } from 'mongodb';
 import { MongoClient, ServerApiVersion } from 'mongodb';
 
@@ -29,13 +30,12 @@ export const DEFAULT_INDEX_NAME = 'vector_store';
 /**
  * @description MongoDB Atlas Vector Store
  * {@link https://www.mongodb.com/docs/atlas/atlas-vector-search/vector-search-type/#:~:text=You%20can%20use%20the%20vectorSearch,to%20pre%2Dfilter%20your%20data.}
- * 
  * @implements {VectorStore}
  */
 export class MongoVectorStore {
 
   /** @satisfies {ENV<Config>} */
-  static EnvConfig = /** @type{const} */ ({
+  static EnvConfig = /** @type {const} */ ({
     db_name: 'MONGODB_VECTOR_STORE_DB_NAME',
     url: 'MONGODB_VECTOR_STORE_URL'
   });
@@ -94,10 +94,10 @@ export class MongoVectorStore {
 
   /** @type {VectorStore["onInit"]} */
   onInit = (app) => {
-    this.config.url ??= app.platform.env[MongoVectorStore.EnvConfig.url] 
-      ?? app.platform.env['MONGODB_URL']; 
-    this.config.db_name ??= app.platform.env[MongoVectorStore.EnvConfig.db_name] 
-      ?? app.platform.env['MONGODB_DB_NAME'] ?? 'main'; 
+    this.config.url ??= app.env[MongoVectorStore.EnvConfig.url] 
+      ?? app.env['MONGODB_URL']; 
+    this.config.db_name ??= app.env[MongoVectorStore.EnvConfig.db_name] 
+      ?? app.env['MONGODB_DB_NAME'] ?? 'main'; 
   }
 
   /** @type {VectorStore["embedder"]} */
@@ -117,7 +117,9 @@ export class MongoVectorStore {
       (doc, ix) => (
         {
           updated_at: new Date().toISOString(),
-          embedding: vectors[ix],
+          embedding: truncate_or_pad_vector(
+            vectors[ix], this.config.dimensions
+          ),
           metadata: doc.metadata,
           pageContent: doc.pageContent,
           [NAMESPACE_KEY]: doc.namespace,
@@ -164,6 +166,13 @@ export class MongoVectorStore {
       }
     );
 
+    if(!result) {
+      console.warn(
+        'MongoVectoreStore::upsertDocuments() - no result from embedder'
+      );
+      return;
+    }
+
     const vectors = result.content;
 
     return this.upsertVectors(
@@ -247,15 +256,41 @@ export class MongoVectorStore {
    * @param {boolean} [delete_index_if_exists_before=false] 
    * @returns {Promise<boolean>}
    */
-  createVectorIndex = async (disconnect_after_finish=true, delete_index_if_exists_before=false) => {
+  createVectorIndex = async (
+    disconnect_after_finish=true, 
+    delete_index_if_exists_before=false
+  ) => {
     if(delete_index_if_exists_before) {
       await this.deleteVectorIndex();
     }
-
+    
     const db = this.client.db(this.config.db_name);
     const collection_name = this.config.index_name;
+
+    { // skip if index already exists
+      const indices = await db
+      .collection(collection_name)
+      .listSearchIndexes()
+      .toArray();
+
+      if(indices?.length) {
+        const index = indices.find(
+          (index) => index.name === this.config.index_name
+        );
+        if(index) {
+          console.log('MongoVectorStore::createVectorIndex - index already exists, skipping');
+          if(disconnect_after_finish)
+            await this.client.close();
+
+          return true;
+        }
+      }
+    }
+
     // collection name will have the same name as the index
     await db.createCollection(collection_name);
+
+
     const index_result = await db.collection(collection_name).createSearchIndex(
       {
         name: this.config.index_name,

package/tests/query.vql.test.js

@@ -1,24 +0,0 @@
-import { test } from 'uvu';
-import * as assert from 'uvu/assert';
-import { query_vql_to_mongo_filter } from '../src/utils.query.js'
-
-//
-// TODO:
-// - [ ] Add tests for query_vql_to_mongo_filter
-// although it is tested as a black box in the main test file
-//
-test('query_vql_to_mongo_filter', async () => {
-  const vql_ast = {
-  };
-
-  const mongo = {
-  };
-
-  // const m1 = query_vql_to_mongo_filter(vql_ast);
-  
-  // console.log(JSON.stringify(m1, null, 2))
-
-  // assert.equal(m1, mongo);
-});
-
-test.run();