@storecraft/database-mongodb 1.0.14 → 1.0.16

package/src/utils.funcs.js

@@ -1,3 +1,7 @@
+/**
+ * @import { WithRelations } from './utils.types.js';
+ * @import { Filter } from 'mongodb';
+ */
 import { ObjectId } from 'mongodb';
 
 /** @param {any} v */
@@ -14,11 +18,7 @@ export const delete_keys = (...keys) => {
 
   /**
    * @template T
-   * 
-   * 
    * @param {T} o
-   * 
-   * 
    * @returns {T}
    */
   return (o) => {
@@ -30,16 +30,9 @@ export const delete_keys = (...keys) => {
 
 /**
  * Sanitize hidden properties in-place
- * 
- * 
  * @template {object} T
- * 
- * 
  * @param {T} o 
- * 
- * 
  * @return {Omit<T, '_id' | '_relations'>}
- * 
  */
 export const sanitize_hidden = o => {
   if(!isDef(o))
@@ -53,27 +46,26 @@ export const sanitize_hidden = o => {
 }
 
 /**
- * 
- * @template T
- * 
- * 
+ * Sanitize hidden properties in-place recursively
+ * @template {object} T
  * @param {T} o 
- * 
- * 
- * @returns {T}
+ * @return {Omit<T, '_id' | '_relations'>}
  */
-export const delete_id = o => {
-  return delete_keys('_id')(o)
+export const sanitize_recursively = o => {
+  for(const k of Object.keys(o)) {
+    if(k.startsWith('_')) {
+      delete o[k];
+    } else if(typeof o[k] === 'object') {
+      sanitize_recursively(o[k]);
+    }
+  }
+  return o;
 }
 
 /**
- * 
  * Sanitize the mongo document before sending to client
- * 
  * @template T
- * 
- * 
- * @param {T} o 
+ * @param {WithRelations<T>} o 
  */
 export const sanitize_one = o => {
   return sanitize_hidden(o)
@@ -81,30 +73,31 @@ export const sanitize_one = o => {
 
 /**
  * Sanitize the mongo document before sending to client
- * 
  * @template T
- * 
- * 
- * @param {T[]} o 
- * 
+ * @param {WithRelations<T>[]} o 
  */
 export const sanitize_array = o => {
   return o?.map(sanitize_hidden);
 }
 
 /**
- * 
+ * @template T
+ * @param {T} o 
+ * @returns {T}
+ */
+export const delete_id = o => {
+  return delete_keys('_id')(o)
+}
+
+/**
  * @param {string} id 
- * 
  */
 export const to_objid = id => {
   return new ObjectId(id.split('_').at(-1))
 }
 
 /**
- * 
  * @param {string} id 
- * 
  */
 export const to_objid_safe = id => {
   try {
@@ -116,27 +109,20 @@ export const to_objid_safe = id => {
 }
 
 /**
+ * Create a `filter` for `object-id` or `handle`
  * @template {{handle?: string}} G
- * 
- * 
  * @param {string} handle_or_id 
- * 
- * 
- * @returns {import('mongodb').Filter<G>}
+ * @returns {Filter<G>}
  */
 export const handle_or_id = (handle_or_id) => {
-  return objid_or_else_filter(handle_or_id);
+  return objid_or_else_filter(handle_or_id, 'handle');
 }
 
 
 /**
  * @template {{handle?: string}} G
- * 
- * 
  * @param {string} id_or_else 
- * 
- * 
- * @returns {import('mongodb').Filter<G>}
+ * @returns {Filter<G>}
  */
 export const objid_or_else_filter = (id_or_else, else_key='handle') => {
   try {

package/src/utils.relations.js

@@ -1,7 +1,7 @@
 /**
  * @import { ID } from '@storecraft/core/database'
  * @import { BaseType } from '@storecraft/core/api'
- * @import { WithRelations } from './utils.relations.js'
+ * @import { Relation, WithRelations } from './utils.types.js'
  * @import { Filter } from 'mongodb'
  */
 
@@ -10,20 +10,6 @@ import { isDef, isUndef, to_objid } from './utils.funcs.js';
 import { MongoDB } from '../index.js';
 import { zeroed_relations } from './con.shared.js';
 
-/**
- * @template {any} T
- * 
- * @typedef {Object} Relation
- * @property {ObjectId[]} [ids]
- * @property {Record<ID, T>} [entries]
- */
-
-/**
- * @template {any} T
- * 
- * @typedef {T & { _relations? : Record<string, Relation<any>> }} WithRelations
- */
-
 /**
  * 
  * On upsert Create a relation on a given field that represents a relation.
@@ -259,12 +245,13 @@ export const update_specific_connection_of_relation = (
  * @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
+ * @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=[]
+  search_terms_to_remove=[], tags_to_remove=[]
 ) => {
   return driver.collection(collection).updateMany(
     { 
@@ -273,7 +260,8 @@ export const remove_entry_from_all_connection_of_relation = (
     { 
       $pull: {
         [`_relations.${relation_name}.ids`] : entry_objid,
-        '_relations.search': { $in : search_terms_to_remove }
+        '_relations.search': { $in : search_terms_to_remove },
+        'tags': { $in : tags_to_remove },
       },
       $unset: { 
         [`_relations.${relation_name}.entries.${entry_objid.toString()}`]: '' 

package/src/utils.types.d.ts

@@ -0,0 +1,12 @@
+import type { ID } from "@storecraft/core/database";
+import type { ObjectId, WithId } from "mongodb";
+
+export type Relation<T extends any = any> = {
+  ids?: ObjectId[];
+  entries?: Record<ID, T>;
+}
+
+export type WithRelations<T extends any = undefined> = {
+  _relations?: Record<string, Relation<any>>
+  _id?: ObjectId;
+} & T;

package/tests/docker-compose.yml

@@ -0,0 +1,23 @@
+services:
+  mongo1:
+    image: mongo:latest
+    container_name: test-mongodb
+    command: ["--replSet", "rs0", "--bind_ip_all", "--port", "27017"]
+    ports:
+      - 27017:27017
+    extra_hosts:
+      - "host.docker.internal:host-gateway"
+    healthcheck:
+      test: echo "try { rs.status() } catch (err) { rs.initiate({_id:'rs0',members:[{_id:0,host:'host.docker.internal:27017'}]}) }" | mongosh --port 27017 --quiet
+      interval: 5s
+      timeout: 30s
+      start_period: 0s
+      start_interval: 1s
+      retries: 30
+    volumes:
+      - "mongo1_data:/data/db"
+      - "mongo1_config:/data/configdb"
+
+volumes:
+  mongo1_data:
+  mongo1_config:

package/tests/runner.test.js

@@ -9,7 +9,9 @@ export const create_app = async () => {
     {
       auth_admins_emails: ['admin@sc.com'],
       auth_secret_access_token: 'auth_secret_access_token',
-      auth_secret_refresh_token: 'auth_secret_refresh_token'
+      auth_secret_refresh_token: 'auth_secret_refresh_token',
+      auth_secret_confirm_email_token: 'auth_secret_confirm_email_token',
+      auth_secret_forgot_password_token: 'auth_secret_forgot_password_token',
     }
   )
   .withPlatform(new NodePlatform())
@@ -22,22 +24,24 @@ export const create_app = async () => {
     )
   )
   
-  return app.init();
+  return app.init()
 }
 
 async function test() {
   const app = await create_app();
 
   await migrateToLatest(app.db, false);
-
+ 
   Object.entries(api).slice(0, -1).forEach(
     ([name, runner]) => {
       runner.create(app).run();
     }
   );
+  
   const last_test = Object.values(api).at(-1).create(app);
   last_test.after(async ()=>{app.db.disconnect()});
   last_test.run();
 }
 
+// twice
 test();

package/tests/{sandbox.test.js → sandbox.js}

@@ -1,7 +1,10 @@
+import 'dotenv/config';
 import { App } from '@storecraft/core';
 import { MongoDB } from '@storecraft/database-mongodb';
 import { migrateToLatest } from '@storecraft/database-mongodb/migrate.js';
 import { NodePlatform } from '@storecraft/core/platform/node';
+import { expand } from '../src/con.shared.js';
+import { sanitize_hidden, sanitize_recursively } from '../src/utils.funcs.js';
 
 export const create_app = async () => {
   const app = new App(
@@ -14,42 +17,20 @@ export const create_app = async () => {
   .withPlatform(new NodePlatform())
   .withDatabase(new MongoDB({ db_name: 'test'}))
   
-  return app.init();
+  await app.init();
+  await migrateToLatest(app.db, false);
+  return app;
 }
 
-/**
- * 
- * @template R
- * 
- * @param {(()=>Promise<R>) | (() => R)} fn 
- */
-const withTime = async (fn) => {
-  const n1 = Date.now() ;
-  const r = await fn();
-  const delta = Date.now() - n1;
-  console.log(delta);
-  return r;
-}
 
 async function test() {
-  const app = await withTime(create_app);
-
-  await migrateToLatest(app.db, false);
-
+  const app = await create_app();
 
-  const doit = async () => {
-    let items = await app.db.resources.search.quicksearch(
-      {
-        vql: '', 
-        sortBy: ['updated_at']
-      }
-    );
-    return items;
-  }
+  const sf = await app.db.resources.storefronts.get_default_auto_generated_storefront()
 
-  const items = await withTime(doit);
+  console.log(JSON.stringify(sf, null, 2));
 
-  // console.log('items ', items)
+  await app.db.disconnect();
 }
 
 test();

package/vector-store/index.js

@@ -53,21 +53,33 @@ export class MongoVectorStore {
    */
   constructor(config) {
     this.config = {
-      ...config,
-      index_name: config.index_name ?? 'vector_store',
-      similarity: config.similarity ?? 'cosine',
-      dimensions: config.dimensions ?? 1536,
-      options: config.options ?? {
+      index_name: DEFAULT_INDEX_NAME,
+      similarity: 'cosine',
+      dimensions: 1536,
+      options: {
         ignoreUndefined: true,
         serverApi: {
           version: ServerApiVersion.v1,
           strict: false,
           deprecationErrors: true,
         }
-      }
+      },
+      ...config,
     };
   }
 
+  get metric() {
+    switch(this.config.similarity) {
+      case 'cosine': return 'cosine';
+      case 'dotProduct': return 'dotproduct';
+      case 'euclidean': return 'euclidean';
+    }
+  };
+
+  get dimensions() {
+    return this.config.dimensions;
+  };
+
   get client() {
     if(!this.config.db_name || !this.config.url) {
       throw new Error('MongoVectorStore::client() - missing url or db_name');
@@ -81,8 +93,10 @@ export class MongoVectorStore {
 
   /** @type {VectorStore["onInit"]} */
   onInit = (app) => {
-    this.config.url ??= app.platform.env[MongoVectorStore.EnvConfig.url ?? 'MONGODB_URL']; 
-    this.config.db_name ??= app.platform.env[MongoVectorStore.EnvConfig.db_name ?? 'MONGODB_DB_NAME'] ?? 'main'; 
+    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'; 
   }
 
   /** @type {VectorStore["embedder"]} */