@storecraft/database-mongodb 1.0.16 → 1.0.17

package/README.md

@@ -1,4 +1,4 @@
-# Storecraft MongoDB driver for Node.js
+# Storecraft MongoDB driver for node / deno / bun
 
 <div style="text-align:center">
   <img src='https://storecraft.app/storecraft-color.svg' 
@@ -28,14 +28,27 @@ import { MongoVectorStore } from '@storecraft/database-mongodb/vector-store'
 
 const app = new App()
 .withPlatform(new NodePlatform())
-.withDatabase(new MongoDB({}))
+.withDatabase(
+  new MongoDB(
+    {
+      url: process.env.MONGODB_URL,
+      db_name: process.env.MONGODB_NAME,
+    }
+  )
+)
 .withVectorStore(
-  new MongoVectorStore({ embedder: new OpenAIEmbedder() })
+  new MongoVectorStore(
+    { 
+      embedder: new OpenAIEmbedder(),
+      url: process.env.MONGODB_VECTOR_STORE_URL ?? process.env.MONGODB_URL,
+      db_name: process.env.MONGODB_VECTOR_STORE_DB_NAME ?? process.env.MONGODB_NAME,
+    }
+  )
 )
 
 await app.init();
 await migrateToLatest(app.db, false);
-// cerate if not exists
+// create if not exists
 await app.vectorstore.createVectorIndex(false, false);
 
 const server = http.createServer(app.handler).listen(
@@ -47,6 +60,35 @@ const server = http.createServer(app.handler).listen(
 
 ```
 
+
+Storecraft will search the following `env` variables
+
+```bash
+MONGODB_NAME=main
+MONGODB_URL='mongodb-connection-string'
+
+// also, this will default into `MONGODB_NAME`
+MONGODB_VECTOR_STORE_DB_NAME=vector-store
+// also, this will default into `MONGODB_URL`
+MONGODB_VECTOR_STORE_URL='mongodb-connection-string'
+```
+
+So, you can instantiate with empty config
+
+```ts
+.withDatabase(
+  new MongoDB()
+)
+.withVectorStore(
+  new MongoVectorStore(
+    {
+      embedder: new OpenAIEmbedder(),
+    }
+  )
+)
+```
+
+
 ## Testing Locally (I recommend to use `Atlas`)
 
 1. First start a `mongo-db` server

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storecraft/database-mongodb",
-  "version": "1.0.16",
+  "version": "1.0.17",
   "description": "Storecraft database driver for mongodb on node / bun / deno platform",
   "license": "MIT",
   "author": "Tomer Shalev (https://github.com/store-craft)",

package/vector-store/index.js

@@ -68,6 +68,7 @@ export class MongoVectorStore {
     };
   }
 
+  /** @type {VectorStore["metric"]} */
   get metric() {
     switch(this.config.similarity) {
       case 'cosine': return 'cosine';
@@ -76,6 +77,7 @@ export class MongoVectorStore {
     }
   };
 
+  /** @type {VectorStore["dimensions"]} */
   get dimensions() {
     return this.config.dimensions;
   };

package/vector-store/types.d.ts

@@ -1,7 +1,9 @@
 
 import type { AIEmbedder } from '@storecraft/core/ai';
 import type { MongoClientOptions } from 'mongodb';
-export * from './index.js';
+export { 
+  MongoVectorStore, DEFAULT_INDEX_NAME, EMBEDDING_KEY_PATH, NAMESPACE_KEY 
+} from './index.js';
 
 export type Config = {
   /**