@storecraft/database-mongodb 1.0.14 → 1.0.16

package/README.md

@@ -8,7 +8,7 @@
 [![MongoDB](https://github.com/store-craft/storecraft/actions/workflows/test.database-mongodb.yml/badge.svg)](https://github.com/store-craft/storecraft/actions/workflows/test.database-mongodb.yml)
 
 Official `mongodb` driver for `StoreCraft` on **Node.js** / **Deno** / **Bun** platforms.
-Also, an example of [Semantic Vector Search](https://www.mongodb.com/developer/products/atlas/semantic-search-mongodb-atlas-vector-search/) extension at `@storecraft/database-mongodb/vector-search-extension`
+Also, official support for mongo-db as vector store.
 
 ```bash
 npm i @storecraft/database-mongodb
@@ -24,23 +24,19 @@ import { NodePlatform } from '@storecraft/core/platform/node';
 import { MongoDB } from '@storecraft/database-mongodb'
 import { migrateToLatest } from '@storecraft/database-mongodb/migrate.js'
 import { NodeLocalStorage } from '@storecraft/core/storage/node'
-import { MongoVectorSearch } from '@storecraft/database-mongodb/vector-search-extension'
+import { MongoVectorStore } from '@storecraft/database-mongodb/vector-store'
 
-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'
-  }
-)
+const app = new App()
 .withPlatform(new NodePlatform())
-.withDatabase(new MongoDB({ db_name: 'test', url: '...', options: {}}))
-.withExtensions(
-  'mongo-vector-search': new MongoVectorSearch({ openai_key: process.env.OPENAI })
+.withDatabase(new MongoDB({}))
+.withVectorStore(
+  new MongoVectorStore({ embedder: new OpenAIEmbedder() })
 )
 
 await app.init();
 await migrateToLatest(app.db, false);
+// cerate if not exists
+await app.vectorstore.createVectorIndex(false, false);
 
 const server = http.createServer(app.handler).listen(
   8000,
@@ -51,60 +47,29 @@ const server = http.createServer(app.handler).listen(
 
 ```
 
-## (Recommended) setup semantic/ai vector search extension for products
-
-1. in [Atlas](https://cloud.mongodb.com/) dashboard, create a vector index (call it `vector_index`) for `products` collection:
-
-```json
-{
-  "fields": [
-    {
-      "numDimensions": 1536,
-      "path": "embedding",
-      "similarity": "cosine",
-      "type": "vector"
-    }
-  ]
-}
+## Testing Locally (I recommend to use `Atlas`)
+
+1. First start a `mongo-db` server
+First, make sure you have `docker` installed,
+Then, run
+
+```bash
+npm run database-mongodb:docker-compose-up
 ```
 
-2. Now, every upserted product will be eligible for semantic search by it's title + description.
-3. The extension is publicly available via HTTP (`POST` request)
-```js
-await fetch(
-  'http://localhost:8000/api/extensions/mongo-vector-search/search',
-  {
-    method: 'POST',
-    body: JSON.stringify(
-      {
-        query: 'I am interested in Nintendo related clothing, such as shirts',
-        limit: 1
-      }
-    )
-  }
-)
+2. create Environment
+
+create `.env` file with
+
+```bash
+MONGODB_URL="mongodb://127.0.0.1:27017/?replicaSet=rs0"
+MONGODB_NAME="main"
 ```
 
-returns `ProductType[]` array
-
-```json
-[
-  {
-    "title": "Super Mario T Shirt",
-    "handle": "super-mario-t-shirt",
-    "description": "This Super mario shirt is XL size and 
-    features a colorful print of Lugi and Mario.",
-    "media": [
-        "storage://images/super-mario-shirt_1738686680944_w_819_h_460.jpeg"
-    ],
-    "price": 100,
-    "qty": 1,
-    "active": true,
-    "id": "pr_67a240e4000000d34bcf0743",
-    "created_at": "2025-02-04T16:31:32.909Z",
-    "updated_at": "2025-02-04T16:58:25.286Z"
-  }
-]
+3. Run `tests/runner.test.js`
+
+```bash
+npm run database-mongodb:test
 ```
 
 

package/{vector-search-extension.js → example-extension/vector-search-extension.js}

@@ -1,7 +1,10 @@
 /**
+ * an older demo for extending storecraft with vector search.
+ * DO NOT USE this. Use the our official `MongoVectorSearch` insteas
+ * 
  * @import {extension} from '@storecraft/core/extensions'
  */
-import { MongoDB } from './index.js';
+import { MongoDB } from '../index.js';
 /**
  * 
  * @typedef {object} Config

package/index.js

@@ -68,6 +68,7 @@ export class MongoDB {
   constructor(config) {
     this.#is_ready = false;
     this.#config = {
+      db_name: 'main',
       options: {
         ignoreUndefined: true,
         serverApi: {
@@ -161,6 +162,10 @@ export class MongoDB {
     return this.#mongo_client;
   }
 
+  get db() {
+    return this.mongo_client.db(this.name);
+  }
+
   /**
    * 
    * @description Get the config object

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storecraft/database-mongodb",
-  "version": "1.0.14",
+  "version": "1.0.16",
   "description": "Storecraft database driver for mongodb on node / bun / deno platform",
   "license": "MIT",
   "author": "Tomer Shalev (https://github.com/store-craft)",
@@ -33,6 +33,7 @@
     }
   },
   "scripts": {
+    "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",

package/src/con.auth_users.js

@@ -6,6 +6,7 @@
 import { MongoDB } from '../index.js'
 import { Collection } from 'mongodb'
 import { 
+  handle_or_id,
   objid_or_else_filter, sanitize_one, to_objid_safe 
 } from './utils.funcs.js'
 import { 
@@ -62,32 +63,37 @@ const getByEmail = (driver) => {
 
 /**
  * @param {MongoDB} driver 
- * 
- * 
  * @returns {db_col["remove"]}
  */
 const remove = (driver) => {
-  return async (id) => {
+  return async (id_or_handle) => {
+
+    const session = driver.mongo_client.startSession();
+    try {
+      await session.withTransaction(
+        async () => {
+          const filter = handle_or_id(id_or_handle);
+          await col(driver).deleteOne(
+            filter,
+            { session }
+          );
+          // customer and auth_user have the same object-id and handle
+          // so we can use the same filter
+          await driver.resources.customers._col.deleteOne(
+            filter,
+            { session }
+          );
 
-    let filter;
-
-    {
-      if(to_objid_safe(id)) { 
-        filter = {
-          _id: to_objid_safe(id)
-        }
-      } else {
-        filter = {
-          email: id
         }
-      }
+      );
+    } catch(e) {
+      console.log(e);
+      return false;
+    } finally {
+      await session.endSession();
     }
 
-    const res = await col(driver).deleteOne(
-      filter
-    );
-
-    return Boolean(res.deletedCount)
+    return true;
   }
 }
 

package/src/con.collections.js

@@ -1,7 +1,7 @@
 /**
  * @import { db_collections as db_col } from '@storecraft/core/database'
  * @import { ProductType, VariantType } from '@storecraft/core/api'
- * @import { WithRelations } from './utils.relations.js'
+ * @import { WithRelations } from './utils.types.js'
  * @import { Filter } from 'mongodb'
  */
 
@@ -27,8 +27,6 @@ const transactionOptions = {
 
 /**
  * @param {MongoDB} d 
- * 
- * 
  * @returns {Collection<WithRelations<db_col["$type_get"]>>}
  */
 const col = (d) => d.collection('collections');
@@ -169,8 +167,6 @@ const count = (driver) => count_regular(driver, col(driver));
 
 /**
  * @param {MongoDB} driver 
- * 
- * 
  * @returns {db_col["list_collection_products"]}
  */
 const list_collection_products = (driver) => {
@@ -213,6 +209,72 @@ const list_collection_products = (driver) => {
   }
 }
 
+
+/**
+ * @param {MongoDB} driver 
+ * @returns {db_col["count_collection_products"]}
+ */
+const count_collection_products = (driver) => {
+  return async (handle_or_id, query) => {
+
+    const { 
+      filter: filter_query, sort, reverse_sign 
+    } = query_to_mongo(query);
+
+    /**
+     * @type {Filter<WithRelations<ProductType | VariantType>>
+     * }
+     */
+    const filter = {
+      $and: [
+        { '_relations.search': `col:${handle_or_id}` },
+      ]
+    };
+
+    // add the query filter
+    isDef(filter_query) && filter.$and.push(filter_query);
+
+    const count = await driver.resources.products._col.countDocuments(
+      filter
+    );
+
+    return count;
+  }
+}
+
+
+
+/**
+ * @param {MongoDB} driver 
+ * @returns {db_col["list_used_products_tags"]}
+ */
+const list_used_products_tags = (driver) => {
+  return async (handle_or_id) => {
+    const items = await driver.resources.products._col.find(
+      {
+        '_relations.search': `col:${handle_or_id}`
+      },
+      {
+        projection: {
+          tags: 1
+        }
+      }
+    ).toArray();
+
+    const set = (items ?? []).reduce(
+      (p, c) => {
+        c.tags.forEach(
+          (tag) => p.add(tag)
+        );
+        return p;
+      }, new Set()
+    )
+    // return array from set
+    return Array.from(set);
+  }
+}
+
+
 /** 
  * @param {MongoDB} driver
  * 
@@ -228,6 +290,8 @@ export const impl = (driver) => {
     remove: remove(driver),
     list: list(driver),
     count: count(driver),
-    list_collection_products: list_collection_products(driver) 
+    list_collection_products: list_collection_products(driver),
+    count_collection_products: count_collection_products(driver),
+    list_used_products_tags: list_used_products_tags(driver),
   }
 }

package/src/con.customers.js

@@ -1,7 +1,7 @@
 /**
  * @import { db_customers as db_col } from '@storecraft/core/database'
  * @import { OrderData } from '@storecraft/core/api'
- * @import { WithRelations } from './utils.relations.js'
+ * @import { WithRelations } from './utils.types.js'
  * @import { Filter } from 'mongodb'
  */
 
@@ -9,7 +9,7 @@ import { Collection, ObjectId } from 'mongodb'
 import { MongoDB } from '../index.js'
 import { count_regular, get_regular, list_regular, 
   upsert_regular } from './con.shared.js'
-import { isDef, sanitize_array, to_objid } from './utils.funcs.js'
+import { handle_or_id, isDef, sanitize_array, to_objid } from './utils.funcs.js'
 import { query_to_mongo } from './utils.query.js';
 
 /**
@@ -62,8 +62,6 @@ export const email_or_id = (email_or_id) => {
 
 /**
  * @param {MongoDB} driver 
- * 
- * 
  * @returns {db_col["remove"]}
  */
 const remove = (driver) => {
@@ -74,7 +72,7 @@ const remove = (driver) => {
       await session.withTransaction(
         async () => {
           const res = await col(driver).findOneAndDelete(
-            email_or_id(id),
+            handle_or_id(id),
             { session }
           );
       
@@ -120,10 +118,10 @@ const list_customer_orders = (driver) => {
 
     const { filter: filter_query, sort, reverse_sign } = query_to_mongo(query);
 
-    console.log('query', query)
-    console.log('filter', JSON.stringify(filter_query, null, 2))
-    console.log('sort', sort)
-    console.log('expand', query?.expand)
+    // console.log('query', query)
+    // console.log('filter', JSON.stringify(filter_query, null, 2))
+    // console.log('sort', sort)
+    // console.log('expand', query?.expand)
     
     /** @type {Filter<WithRelations<OrderData>>} */
     const filter = {
@@ -147,6 +145,34 @@ const list_customer_orders = (driver) => {
   }
 }
 
+/**
+ * @param {MongoDB} driver 
+ * @returns {db_col["count_customer_orders"]}
+ */
+const count_customer_orders = (driver) => {
+  return async (customer_id, query) => {
+
+    const { filter: filter_query } = query_to_mongo(query);
+
+    /** @type {Filter<WithRelations<OrderData>>} */
+    const filter = {
+      $and: [
+        {'_relations.search': `customer:${customer_id}` },
+      ]
+    };
+
+    // add the query filter
+    isDef(filter_query) && filter.$and.push(filter_query);
+
+    const count = await driver.resources.orders._col.countDocuments(
+      filter
+    );
+
+    return count;
+  }
+}
+
+
 /** 
  * @param {MongoDB} driver
  * 
@@ -163,6 +189,7 @@ export const impl = (driver) => {
     remove: remove(driver),
     list: list(driver),
     count: count(driver),
-    list_customer_orders: list_customer_orders(driver) 
+    list_customer_orders: list_customer_orders(driver),
+    count_customer_orders: count_customer_orders(driver),
   }
 }

package/src/con.discounts.js

@@ -1,7 +1,7 @@
 /**
  * @import { db_discounts as db_col } from '@storecraft/core/database'
  * @import { ProductType, VariantType } from '@storecraft/core/api'
- * @import { WithRelations } from './utils.relations.js'
+ * @import { WithRelations } from './utils.types.js'
  * @import { Filter } from 'mongodb'
  */
 
@@ -23,7 +23,10 @@ import {
   save_me, 
   update_entry_on_all_connection_of_relation 
 } from './utils.relations.js'
-
+import {
+  helper_compute_product_extra_search_keywords_because_of_discount_side_effect_for_db,
+  helper_compute_product_extra_tags_because_of_discount_side_effect_for_db
+} from '@storecraft/core/database'
 
 /**
  * @param {MongoDB} d 
@@ -54,16 +57,27 @@ const upsert = (driver) => {
           // SEARCH
           add_search_terms_relation_on(data, search_terms);
 
-          
           ////
           // PRODUCT --> DISCOUNTS RELATION
           ////
+          const extra_search_for_products = 
+            helper_compute_product_extra_search_keywords_because_of_discount_side_effect_for_db(
+              data
+            );
+
+          const extra_tags_for_products = 
+            helper_compute_product_extra_tags_because_of_discount_side_effect_for_db(
+              data
+            );
 
           // first remove discount from anywhere
           await remove_entry_from_all_connection_of_relation(
             driver, 'products', 'discounts', objid, session,
-            [
-              `discount:${data.handle}`, `discount:${data.id}`
+            [ // remove search terms
+              ...extra_search_for_products
+            ],
+            [ // remove tags
+              ...extra_tags_for_products
             ]
           );
           
@@ -77,8 +91,11 @@ const upsert = (driver) => {
                 $addToSet: { 
                   '_relations.discounts.ids': objid,
                   '_relations.search': { 
-                    $each : [ `discount:${data.handle}`, `discount:${data.id}` ]
-                  } 
+                    $each : extra_search_for_products
+                  },
+                  'tags': {
+                    $each : extra_tags_for_products
+                  }
                 },
                 
               },
@@ -145,13 +162,27 @@ const remove = (driver) => {
     try {
       await session.withTransaction(
         async () => {
+
+        const extra_search_for_products = 
+          helper_compute_product_extra_search_keywords_because_of_discount_side_effect_for_db(
+            item
+          );
+
+        const extra_tags_for_products = 
+          helper_compute_product_extra_tags_because_of_discount_side_effect_for_db(
+            item
+          );
+
           ////
           // PRODUCT -> DISCOUNTS RELATION
           ////
           await remove_entry_from_all_connection_of_relation(
             driver, 'products', 'discounts', objid, session,
             [
-              `discount:${item.handle}`, `discount:${item.id}`
+              ...extra_search_for_products
+            ],
+            [
+              ...extra_tags_for_products
             ]
           );
 
@@ -196,8 +227,6 @@ const count = (driver) => count_regular(driver, col(driver));
 
 /**
  * @param {MongoDB} driver 
- * 
- * 
  * @returns {db_col["list_discount_products"]}
  */
 const list_discount_products = (driver) => {
@@ -235,6 +264,67 @@ const list_discount_products = (driver) => {
   }
 }
 
+
+/**
+ * @param {MongoDB} driver 
+ * @returns {db_col["list_all_discount_products_tags"]}
+ */
+const list_all_discount_products_tags = (driver) => {
+  return async (handle_or_id) => {
+    const items = await driver.resources.products._col.find(
+      {
+        '_relations.search': `discount:${handle_or_id}`
+      },
+      {
+        projection: {
+          tags: 1
+        }
+      }
+    ).toArray();
+
+    const set = (items ?? []).reduce(
+      (p, c) => {
+        c.tags.forEach(
+          (tag) => p.add(tag)
+        );
+        return p;
+      }, new Set()
+    );
+    
+    // return array from set
+    return Array.from(set);
+  }
+}
+
+
+/**
+ * @param {MongoDB} driver 
+ * @returns {db_col["count_discount_products"]}
+ */
+const count_discount_products = (driver) => {
+  return async (handle_or_id, query) => {
+
+    const { filter: filter_query, sort, reverse_sign } = query_to_mongo(query);
+
+    /** @type {Filter<WithRelations<ProductType | VariantType>>} */
+    const filter = {
+      $and: [
+        { '_relations.search': `discount:${handle_or_id}` },
+      ]
+    };
+
+    // add the query filter
+    isDef(filter_query) && filter.$and.push(filter_query);
+
+    const count = await driver.resources.products._col.countDocuments(
+      filter
+    );
+
+    return count;
+  }
+}
+
+
 /** 
  * @param {MongoDB} driver
  * 
@@ -251,6 +341,8 @@ export const impl = (driver) => {
     remove: remove(driver),
     list: list(driver),
     count: count(driver),
-    list_discount_products: list_discount_products(driver)
+    list_discount_products: list_discount_products(driver),
+    list_all_discount_products_tags: list_all_discount_products_tags(driver),
+    count_discount_products: count_discount_products(driver)
   }
 }

package/src/con.posts.js

@@ -1,6 +1,6 @@
 /**
  * @import { db_posts as db_col } from '@storecraft/core/database'
- * @import { WithRelations } from './utils.relations.js'
+ * @import { WithRelations } from './utils.types.js'
  */
 
 import { Collection } from 'mongodb'