@storecraft/database-mongodb 1.0.20 → 1.2.5

package/src/utils.relations.js

@@ -1,25 +1,19 @@
 /**
- * @import { ID } from '@storecraft/core/database'
  * @import { BaseType } from '@storecraft/core/api'
  * @import { Relation, WithRelations } from './utils.types.js'
- * @import { Filter } from 'mongodb'
+ * @import { Collection, Filter } from 'mongodb'
  */
-
 import { ClientSession, ObjectId } from 'mongodb';
 import { isDef, isUndef, to_objid } from './utils.funcs.js';
 import { MongoDB } from '../index.js';
 import { zeroed_relations } from './con.shared.js';
 
 /**
- * 
- * On upsert Create a relation on a given field that represents a relation.
- * for example, each product specifies collections it belongs to.
- * Basically creates an ids array and embedded documents for fast retrival.
- * 
- * 
+ * @description On upsert Create a relation on a given 
+ * field that represents a relation. for example, each 
+ * product specifies collections it belongs to. Basically 
+ * creates an ids array and embedded documents for fast retrival.
  * @template {BaseType} T
- * 
- * 
  * @param {MongoDB} driver our driver
  * @param {T} data data to create the connection from
  * @param {string} fieldName the field name, that represents 
@@ -27,8 +21,6 @@ import { zeroed_relations } from './con.shared.js';
  * @param {string} belongsToCollection which collection 
  * does the field relate to
  * @param {boolean} [reload=false] re-retrive documents ?
- * 
- * 
  * @returns {Promise<WithRelations<T>>}
  */
 export const create_explicit_relation = async (
@@ -50,11 +42,16 @@ export const create_explicit_relation = async (
   /** @type {Relation<any>} */
   const relation = data_with_rel._relations[fieldName] = {};
 
-  relation.ids = items.filter(i => isDef(i?.id)).map(c => to_objid(c.id));
+  relation.ids = items
+  .filter(i => isDef(i?.id))
+  .map(c => to_objid(c.id));
+
   relation.entries = {};
 
   if(reload) {
-    const entries = await driver.collection(belongsToCollection).find(
+    const entries = await driver
+    .collection(belongsToCollection)
+    .find(
       { 
         _id: { 
           $in : relation.ids 
@@ -76,7 +73,9 @@ export const create_explicit_relation = async (
 
   } else {
     relation.entries = Object.fromEntries(
-      items.map(it => [it.id.split('_').at(-1), it])
+      items.map(
+        it => [it.id.split('_').at(-1), it]
+      )
     );
   }
 
@@ -87,17 +86,14 @@ export const create_explicit_relation = async (
 }
 
 /**
- * Create a `search` relation on the document (embed it)
- * 
+ * @description Create a `search` relation on the document (embed it)
  * @template {Object.<string, any>} T
- * 
  * @param {WithRelations<T>} data 
  * @param {string[]} terms 
- * 
  */
 export const add_search_terms_relation_on = (data, terms=[]) => {
   if(!data)
-    return;
+    return undefined;
 
   if(!Array.isArray(terms))
     throw new Error('terms is not an array !');
@@ -112,12 +108,9 @@ export const add_search_terms_relation_on = (data, terms=[]) => {
 
 
 /**
- * 
- * Update an `entry` on all of it's connections in the `relation`.
+ * @description Update an `entry` on all of it's connections in the `relation`.
  * Suppose, we have a many-to-x relation, then we update `x` on
  * all of these many connections at once.
- * 
- * 
  * @param {MongoDB} driver mongodb driver instance
  * @param {string} collection the collection from which the `relation` is from
  * @param {string} relation_name the `relation` name
@@ -126,7 +119,6 @@ export const add_search_terms_relation_on = (data, terms=[]) => {
  * @param {ClientSession} [session] client `session` for atomicity purposes
  * @param {string[]} [search_terms_to_add=[]] Extra `search` terms to add
  * to all the affected connections
- * 
  */
 export const update_entry_on_all_connection_of_relation = (
   driver, collection, relation_name, entry_objid, entry, session,
@@ -155,23 +147,20 @@ export const update_entry_on_all_connection_of_relation = (
 
 
 /**
- * 
- * Update / Create an `entry` on a specific connection, that is 
- * found by `mongodb` filter in the `relation`.
+ * @description Update / Create an `entry` on a specific connection, 
+ * that is found by `mongodb` filter in the `relation`.
  * Suppose, we have a many-to-x relation, then we create a new
  * connection a-to-x
- * 
- * 
  * @param {MongoDB} driver mongodb driver instance
  * @param {string} collection the collection from which the `relation` is from
  * @param {string} relation_name the `relation` name
- * @param {import('mongodb').Filter<any>} from_object_filter the proper `ObjectId` of the from connection
+ * @param {import('mongodb').Filter<any>} from_object_filter 
+ * the proper `ObjectId` of the from connection
  * @param {ObjectId} entry_objid the proper `ObjectId` of the entry
  * @param {object} entry the entry data
  * @param {ClientSession} [session] client `session` for atomicity purposes
  * @param {string[]} [search_terms_to_add=[]] Extra `search` terms to add
  * to the affected connection
- * 
  */
 export const update_specific_connection_of_relation_with_filter = (
   driver, collection, relation_name, from_object_filter, 
@@ -198,12 +187,9 @@ export const update_specific_connection_of_relation_with_filter = (
 }
 
 /**
- * 
- * Update / Create an `entry` on a specific connection in the `relation`.
- * Suppose, we have a many-to-x relation, then we create a new
- * connection a-to-x
- * 
- * 
+ * @description Update / Create an `entry` on a specific connection 
+ * in the `relation`. Suppose, we have a many-to-x relation, then we 
+ * create a new connection a-to-x
  * @param {MongoDB} driver mongodb driver instance
  * @param {string} collection the collection from which the `relation` is from
  * @param {string} relation_name the `relation` name
@@ -213,7 +199,6 @@ export const update_specific_connection_of_relation_with_filter = (
  * @param {ClientSession} [session] client `session` for atomicity purposes
  * @param {string[]} [search_terms_to_add=[]] Extra `search` terms to add
  * to the affected connection
- * 
  */
 export const update_specific_connection_of_relation = (
   driver, collection, relation_name, from_objid, entry_objid, 
@@ -233,12 +218,9 @@ export const update_specific_connection_of_relation = (
 
 
 /**
- * 
- * Remove an `entry` from all of it's connections in the `relation`.
- * Suppose, we have a many-to-x relation, then we remove `x` from
- * all these many connections at once.
- * 
- * 
+ * @description Remove an `entry` from all of it's connections 
+ * in the `relation`. Suppose, we have a many-to-x relation, then 
+ * we remove `x` from all these many connections at once.
  * @param {MongoDB} driver mongodb driver instance
  * @param {string} collection the collection from which the `relation` is from
  * @param {string} relation_name the `relation` name
@@ -247,13 +229,14 @@ export const update_specific_connection_of_relation = (
  * @param {string[]} [search_terms_to_remove=[]] Extra `search` terms to remove
  * @param {string[]} [tags_to_remove=[]] Extra `tags` terms to remove
  * from all the connections
- * 
  */
 export const remove_entry_from_all_connection_of_relation = (
   driver, collection, relation_name, entry_objid, session,
   search_terms_to_remove=[], tags_to_remove=[]
 ) => {
-  return driver.collection(collection).updateMany(
+  return /** @type {Collection<{}>} */(driver
+  .collection(collection))
+  .updateMany(
     { 
       [`_relations.${relation_name}.ids`] : entry_objid 
     },
@@ -276,12 +259,9 @@ export const remove_entry_from_all_connection_of_relation = (
 
 
 /**
- * 
- * Remove an `entry` from a specific connection in the `relation`.
- * Suppose, we have a a-to-x relation, then we remove `x` from
- * `a` connection.
- * 
- * 
+ * @description Remove an `entry` from a specific connection in 
+ * the `relation`. Suppose, we have a a-to-x relation, then we remove 
+ * `x` from `a` connection.
  * @param {MongoDB} driver mongodb driver instance
  * @param {string} collection the collection from which the `relation` is from
  * @param {string} relation_name the `relation` name
@@ -290,7 +270,6 @@ export const remove_entry_from_all_connection_of_relation = (
  * @param {ClientSession} [session] client `session` for atomicity purposes
  * @param {string[]} [search_terms_to_remove=[]] Extra `search` terms to remove
  * from the affected connection
- * 
  */
 export const remove_specific_connection_of_relation = (
   driver, collection, relation_name, from_objid, entry_objid, session,
@@ -309,31 +288,27 @@ export const remove_specific_connection_of_relation = (
 
 
 /**
- * 
- * Remove an `entry` from a specific connection in the `relation`.
+ * @description Remove an `entry` from a specific connection in the `relation`.
  * Suppose, we have a a-to-x relation, then we remove `x` from
- * `a` connection. 
- * 
- * We locate `a` by a `mongodb` filter
- * 
- * 
+ * `a` connection. We locate `a` by a `mongodb` filter
  * @param {MongoDB} driver mongodb driver instance
  * @param {string} collection the collection from which the `relation` is from
  * @param {string} relation_name the `relation` name
- * @param {Filter<any>} from_object_filter 
+ * @param {Filter<{}>} from_object_filter 
  * `mongodb` Filter to locate the first document, the from part of the connection
  * @param {ObjectId} entry_objid the proper `ObjectId` of the entry
  * @param {ClientSession} [session] client `session` for atomicity purposes
  * @param {string[]} [search_terms_to_remove=[]] Extra `search` terms to remove
  * from the affected connection
- * 
  */
 export const remove_specific_connection_of_relation_with_filter = (
   driver, collection, relation_name, from_object_filter, entry_objid, session,
   search_terms_to_remove
 ) => {
 
-  return driver.collection(collection).updateOne(
+  return /** @type {Collection<{}>} */(driver
+  .collection(collection))
+  .updateOne(
     from_object_filter,
     { 
       $pull: {
@@ -353,16 +328,12 @@ export const remove_specific_connection_of_relation_with_filter = (
 
 
 /**
- * 
- * A simple `save` (using **Mongo** `replaceOne`)
- * 
- * 
+ * @description A simple `save` (using **Mongo** `replaceOne`)
  * @param {MongoDB} driver `mongodb` driver
  * @param {string} collection the `collection` to save into
  * @param {ObjectId} object_id the `object id` of the item
  * @param {object} document the document data
  * @param {ClientSession} [session] client `session` for atomicity purposes
- * 
  */
 export const save_me = (driver, collection, object_id, document, session) => {
   return driver.collection(collection).replaceOne(
@@ -375,20 +346,16 @@ export const save_me = (driver, collection, object_id, document, session) => {
       upsert: true 
     }
   );
-
 }
 
 
 /**
- * 
- * A simple `delete` (using **Mongo** `deleteOne`) with `session` transaction
- * 
- * 
+ * @description A simple `delete` (using **Mongo** `deleteOne`) 
+ * with `session` transaction
  * @param {MongoDB} driver `mongodb` driver
  * @param {string} collection the `collection` to save into
  * @param {ObjectId} object_id the `object id` of the item
  * @param {ClientSession} [session] client `session` for atomicity purposes
- * 
  */
 export const delete_me = (driver, collection, object_id, session) => {
   return driver.collection(collection).deleteOne(

package/tests/runner.test.js

@@ -4,7 +4,11 @@ import { MongoDB, migrateToLatest } from '@storecraft/database-mongodb';
 import { NodePlatform } from '@storecraft/core/platform/node';
 import { api } from '@storecraft/core/test-runner';
 
-export const create_app = async () => {
+//
+// Main MongoDB test suite with the core test-runner for api layer
+//
+
+export const create_app = () => {
   const app = new App(
     {
       auth_admins_emails: ['admin@sc.com'],
@@ -24,13 +28,13 @@ export const create_app = async () => {
     )
   )
   
-  return app.init()
+  return app.init().__show_me_everything.app;
 }
 
 async function test() {
-  const app = await create_app();
+  const app = create_app();
 
-  await migrateToLatest(app.db, false);
+  await migrateToLatest(app.__show_me_everything.db, false);
  
   Object.entries(api).slice(0, -1).forEach(
     ([name, runner]) => {
@@ -39,7 +43,7 @@ async function test() {
   );
   
   const last_test = Object.values(api).at(-1).create(app);
-  last_test.after(async ()=>{app.db.disconnect()});
+  last_test.after(async ()=>{app.__show_me_everything.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,7 +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';
 
@@ -30,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'
   });
@@ -95,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"]} */
@@ -118,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,
@@ -165,6 +166,13 @@ export class MongoVectorStore {
       }
     );
 
+    if(!result) {
+      console.warn(
+        'MongoVectoreStore::upsertDocuments() - no result from embedder'
+      );
+      return;
+    }
+
     const vectors = result.content;
 
     return this.upsertVectors(
@@ -248,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,