@storecraft/database-mongodb 1.0.12 → 1.0.14

package/src/con.posts.js

@@ -1,3 +1,8 @@
+/**
+ * @import { db_posts as db_col } from '@storecraft/core/database'
+ * @import { WithRelations } from './utils.relations.js'
+ */
+
 import { Collection } from 'mongodb'
 import { MongoDB } from '../index.js'
 import { count_regular, get_regular, list_regular } from './con.shared.js'
@@ -18,7 +23,7 @@ import {
  * @param {MongoDB} d 
  * 
  * 
- * @returns {Collection<import('./utils.relations.js').WithRelations<db_col["$type_get"]>>}
+ * @returns {Collection<WithRelations<db_col["$type_get"]>>}
  */
 const col = (d) => d.collection('posts');
 

package/src/con.products.js

@@ -1,3 +1,10 @@
+/**
+ * @import { db_products as db_col, RegularGetOptions } from '@storecraft/core/database'
+ * @import { ProductType, VariantType } from '@storecraft/core/api'
+ * @import { WithRelations } from './utils.relations.js'
+ * @import { Filter, AnyBulkWriteOperation } from 'mongodb'
+ */
+
 import { Collection } from 'mongodb'
 import { MongoDB } from '../index.js'
 import { 
@@ -25,18 +32,11 @@ import {
   test_product_filters_against_product 
 } from '@storecraft/core/api/con.pricing.logic.js'
 
-/**
- * @typedef {import('@storecraft/core/database').db_products} db_col
- */
-
 /**
  * @param {MongoDB} d 
  * 
  * 
- * @returns {Collection<
- *  import('./utils.relations.js').WithRelations<db_col["$type_get"]>
- * >}
- * 
+ * @returns {Collection<WithRelations<db_col["$type_get"]>>}
  */
 const col = (d) => d.collection('products');
 
@@ -304,7 +304,7 @@ const count = (driver) => count_regular(driver, col(driver));
  */
 const list_product_collections = (driver) => {
   return async (product) => {
-    /** @type {import('@storecraft/core/database').RegularGetOptions} */
+    /** @type {RegularGetOptions} */
     const options = {
       expand: ['collections']
     };
@@ -329,7 +329,7 @@ const list_product_collections = (driver) => {
  */
 const list_product_variants = (driver) => {
   return async (product) => {
-    /** @type {import('@storecraft/core/database').RegularGetOptions} */
+    /** @type {RegularGetOptions} */
     const options = {
       expand: ['variants']
     };
@@ -380,7 +380,7 @@ const list_related_products = (driver) => {
  */
 const list_product_discounts = (driver) => {
   return async (product) => {
-    /** @type {import('@storecraft/core/database').RegularGetOptions} */
+    /** @type {RegularGetOptions} */
     const options = {
       expand: ['discounts']
     };
@@ -462,12 +462,7 @@ const changeStockOfBy = (driver) => {
   return async (product_ids_or_handles, deltas) => {
 
     /** 
-     * @type {import('mongodb').AnyBulkWriteOperation<
-     *  import('./utils.relations.js').WithRelations<
-     *    import('@storecraft/core/api').ProductType | 
-     *    import('@storecraft/core/api').VariantType
-     *  >
-     * >[]} 
+     * @type {AnyBulkWriteOperation<WithRelations<ProductType | VariantType>>[]}
      */
     let ops = []
 

package/src/con.search.js

@@ -1,14 +1,14 @@
-import { MongoDB } from '../index.js'
-import { query_to_mongo } from './utils.query.js';
-
 /**
- * @typedef {import('@storecraft/core/database').search} db_col
+ * @import { search as db_col, db_driver } from '@storecraft/core/database'
+ * @import { QuickSearchResource, QuickSearchResult } from '@storecraft/core/api'
  */
 
+import { MongoDB } from '../index.js'
+import { query_to_mongo } from './utils.query.js';
 
 
 /**
- * @type {(keyof import('@storecraft/core/database').db_driver["resources"])[]}
+ * @type {(keyof db_driver["resources"])[]}
  */
 const tables = [
   'tags',
@@ -26,7 +26,7 @@ const tables = [
 ]
 
 /**
- * @type {Record<string, keyof import('@storecraft/core/database').db_driver["resources"]>}
+ * @type {Record<string, keyof db_driver["resources"]>}
  */
 const prefix_to_resource = {
   'au': 'auth_users',
@@ -49,7 +49,7 @@ const prefix_to_resource = {
  * 
  * @param {string} id 
  * 
- * @returns {keyof import('@storecraft/core/database').db_driver["resources"]}
+ * @returns {keyof db_driver["resources"]}
  */
 export const id_to_resource = id => {
   let result = undefined;
@@ -102,28 +102,29 @@ export const quicksearch = (driver) => {
 
     const db = driver.mongo_client.db(driver.name);
     
-    /** @type {import('@storecraft/core/api').QuickSearchResource[]} */ 
-    const items = await db.collection(tables_filtered[0]).aggregate(
-      [
-        ...pipeline,
-        ...tables_filtered.slice(1).map(
-          t => (
-            {
-              $unionWith: {
-                coll: t,
-                pipeline: pipeline
+    
+    const items = /** @type {QuickSearchResource[]} */ (
+      await db.collection(tables_filtered[0]).aggregate(
+        [
+          ...pipeline,
+          ...tables_filtered.slice(1).map(
+            t => (
+              {
+                $unionWith: {
+                  coll: t,
+                  pipeline: pipeline
+                }
               }
-            }
+            )
           )
-        )
-      ], 
-      {
-        
-      }
-    ).toArray();
+        ], 
+        {
+        }
+      ).toArray()
+    );
 
 
-    /** @type {import('@storecraft/core/api').QuickSearchResult} */
+    /** @type {QuickSearchResult} */
     const result = {};
 
     items.reduce(

package/src/con.shared.js

@@ -1,3 +1,11 @@
+/**
+ * @import { db_crud, RegularGetOptions } from '@storecraft/core/database'
+ * @import { ApiQuery, BaseType, Cursor, ExpandQuery, QuickSearchResource, QuickSearchResult, Tuple, withOptionalID } from '@storecraft/core/api'
+ * @import { VQL } from '@storecraft/core/vql'
+ * @import { WithRelations } from './utils.relations.js'
+ * @import { WithId } from 'mongodb'
+ */
+
 import { Collection } from 'mongodb'
 import { MongoDB } from '../index.js'
 import { handle_or_id, isUndef, sanitize_array, 
@@ -8,18 +16,16 @@ import { add_search_terms_relation_on } from './utils.relations.js'
 
 
 /**
- * @template {import('@storecraft/core/api').BaseType} T
- * @template {import('@storecraft/core/api').BaseType} G
- * 
+ * @template {BaseType} T
+ * @template {BaseType} G
  * 
  * @param {MongoDB} driver 
  * @param {Collection<G>} col 
  * 
- * 
- * @returns {import('@storecraft/core/database').db_crud<T, G>["upsert"]}
- * 
+ * @returns {db_crud<T, G>["upsert"]}
  */
 export const upsert_regular = (driver, col) => {
+  
   return async (data, search_terms=[]) => {
 
     data = {...data};
@@ -82,13 +88,10 @@ export const get_relations_names = item => {
 /**
  * Expand relations in-place
  * 
- * 
  * @template {any} T
  * 
- * 
- * @param {import('./utils.relations.js').WithRelations<T>[]} items
- * @param {import('@storecraft/core/api').ExpandQuery} [expand_query] 
- * 
+ * @param {WithRelations<T>[]} items
+ * @param {ExpandQuery<T>} [expand_query] 
  */
 export const expand = (items, expand_query=undefined) => {
   
@@ -100,9 +103,9 @@ export const expand = (items, expand_query=undefined) => {
   const all = expand_query.includes('*');
   
   for(const item of items) {
-    expand_query = all ? get_relations_names(item) : expand_query;
+    const what_to_expand = all ? get_relations_names(item) : expand_query;
 
-    for(const e of (expand_query ?? [])) {
+    for(const e of (what_to_expand ?? [])) {
       // try to find embedded documents relations
       const rel = item?._relations?.[e];
       if(rel===undefined || rel===null)
@@ -141,8 +144,8 @@ export const zeroed_relations = {
 
 
 /**
- * 
- * @param {import('@storecraft/core/database').RegularGetOptions["expand"]} expand 
+ * @template T
+ * @param {ExpandQuery<T>} expand 
  */
 export const expand_to_mongo_projection = (expand) => {
   let projection = {}
@@ -163,18 +166,16 @@ export const expand_to_mongo_projection = (expand) => {
 /**
  * @template T, G
  * 
- * 
  * @param {MongoDB} driver 
  * @param {Collection<G>} col 
  * 
- * 
- * @returns {import('@storecraft/core/database').db_crud<T, G>["get"]}
+ * @returns {db_crud<T, G>["get"]}
  */
 export const get_regular = (driver, col) => {
   return async (id_or_handle, options) => {
     const filter = handle_or_id(id_or_handle);
 
-    /** @type {import('./utils.relations.js').WithRelations<import('mongodb').WithId<G>>} */
+    /** @type {WithRelations<WithId<G>>} */
     const res = await col.findOne(
       filter,
       {
@@ -194,15 +195,15 @@ export const get_regular = (driver, col) => {
  * should be instead
  * 
  * 
- * @template {import('@storecraft/core/api').idable} T
- * @template {import('@storecraft/core/api').idable} G
+ * @template {withOptionalID} T
+ * @template {withOptionalID} G
  * 
  * 
  * @param {MongoDB} driver 
  * @param {Collection<G>} col 
  * 
  * 
- * @returns {import('@storecraft/core/database').db_crud<T, G>["getBulk"]}
+ * @returns {db_crud<T, G>["getBulk"]}
  */
 export const get_bulk = (driver, col) => {
   return async (ids, options) => {
@@ -247,7 +248,7 @@ export const get_bulk = (driver, col) => {
  * @param {Collection<G>} col 
  * 
  * 
- * @returns {import('@storecraft/core/database').db_crud<T, G>["remove"]}
+ * @returns {db_crud<T, G>["remove"]}
  */
 export const remove_regular = (driver, col) => {
   return async (id_or_handle) => {
@@ -261,15 +262,15 @@ export const remove_regular = (driver, col) => {
 }
 
 /**
- * @template {any} T
- * @template {any} G
+ * @template T
+ * @template G
  * 
  * 
  * @param {MongoDB} driver 
  * @param {Collection<G>} col 
  * 
  * 
- * @returns {import('@storecraft/core/database').db_crud<T, G>["list"]}
+ * @returns {db_crud<T, G>["list"]}
  */
 export const list_regular = (driver, col) => {
   return async (query) => {
@@ -282,7 +283,7 @@ export const list_regular = (driver, col) => {
     // console.log('sort', sort)
     // console.log('expand', query?.expand)
 
-    /** @type {import('mongodb').WithId<G>[]} */
+    /** @type {WithRelations<WithId<G>>[]} */
     const items = await col.find(
       filter,  {
         sort, 
@@ -295,7 +296,7 @@ export const list_regular = (driver, col) => {
 
     // try expand relations, that were asked
     const items_expended = expand(items, query?.expand);
-
+    
     const sanitized = sanitize_array(items_expended);
 
     // console.log('sanitized', sanitized)
@@ -313,7 +314,7 @@ export const list_regular = (driver, col) => {
  * @param {Collection<G>} col 
  * 
  * 
- * @returns {import('@storecraft/core/database').db_crud<T, G>["count"]}
+ * @returns {db_crud<T, G>["count"]}
  */
 export const count_regular = (driver, col) => {
   return async (query) => {

package/src/con.shipping.js

@@ -1,3 +1,8 @@
+/**
+ * @import { db_shipping as db_col } from '@storecraft/core/database'
+ * @import { WithRelations } from './utils.relations.js'
+ */
+
 import { Collection } from 'mongodb'
 import { MongoDB } from '../index.js'
 import { count_regular, get_regular, list_regular } from './con.shared.js'
@@ -9,15 +14,11 @@ import {
   update_entry_on_all_connection_of_relation 
 } from './utils.relations.js';
 
-/**
- * @typedef {import('@storecraft/core/database').db_shipping} db_col
- */
-
 /**
  * @param {MongoDB} d 
  * 
  * 
- * @returns {Collection<import('./utils.relations.js').WithRelations<db_col["$type_get"]>>}
+ * @returns {Collection<WithRelations<db_col["$type_get"]>>}
  */
 const col = (d) => d.collection('shipping_methods');
 

package/src/con.storefronts.js

@@ -1,3 +1,10 @@
+/**
+ * @import { 
+ *  db_storefronts as db_col, RegularGetOptions 
+ * } from '@storecraft/core/database'
+ * @import { WithRelations } from './utils.relations.js'
+ */
+
 import { Collection } from 'mongodb'
 import { MongoDB } from '../index.js'
 import { count_regular, get_regular, list_regular, 
@@ -8,18 +15,10 @@ import {
 } from './utils.relations.js';
 import { report_document_media } from './con.images.js';
 
-/**
- * @typedef {import('@storecraft/core/database').db_storefronts} db_col
- */
-
 /**
  * @param {MongoDB} d 
  * 
- * 
- * @returns {Collection<
- *  import('./utils.relations.js').WithRelations<db_col["$type_get"]>>
- * }
- * 
+ * @returns {Collection<WithRelations<db_col["$type_get"]>>}
  */
 const col = (d) => d.collection('storefronts');
 
@@ -113,7 +112,7 @@ const count = (driver) => count_regular(driver, col(driver));
  */
 const list_storefront_products = (driver) => {
   return async (product) => {
-    /** @type {import('@storecraft/core/database').RegularGetOptions} */
+    /** @type {RegularGetOptions} */
     const options = {
       expand: ['products']
     };
@@ -132,7 +131,7 @@ const list_storefront_products = (driver) => {
  */
 const list_storefront_collections = (driver) => {
   return async (product) => {
-    /** @type {import('@storecraft/core/database').RegularGetOptions} */
+    /** @type {RegularGetOptions} */
     const options = {
       expand: ['collections']
     };
@@ -151,7 +150,7 @@ const list_storefront_collections = (driver) => {
  */
 const list_storefront_discounts = (driver) => {
   return async (product) => {
-    /** @type {import('@storecraft/core/database').RegularGetOptions} */
+    /** @type {RegularGetOptions} */
     const options = {
       expand: ['discounts']
     };
@@ -169,7 +168,7 @@ const list_storefront_discounts = (driver) => {
  */
 const list_storefront_shipping_methods = (driver) => {
   return async (product) => {
-    /** @type {import('@storecraft/core/database').RegularGetOptions} */
+    /** @type {RegularGetOptions} */
     const options = {
       expand: ['shipping_methods']
     };
@@ -188,7 +187,7 @@ const list_storefront_shipping_methods = (driver) => {
  */
 const list_storefront_posts = (driver) => {
   return async (product) => {
-    /** @type {import('@storecraft/core/database').RegularGetOptions} */
+    /** @type {RegularGetOptions} */
     const options = {
       expand: ['posts']
     };

package/src/con.tags.js

@@ -1,13 +1,12 @@
+/**
+ * @import { db_tags as db_col } from '@storecraft/core/database'
+ */
+
 import { Collection } from 'mongodb'
 import { MongoDB } from '../index.js'
 import { count_regular, get_regular, list_regular, 
   remove_regular, upsert_regular } from './con.shared.js'
 
-/**
- * @typedef {import('@storecraft/core/database').db_tags} db_col
- */
-
-
 /**
  * @param {MongoDB} d 
  * 

package/src/con.templates.js

@@ -1,13 +1,12 @@
+/**
+ * @import { db_templates as db_col } from '@storecraft/core/database'
+ */
+
 import { Collection } from 'mongodb'
 import { MongoDB } from '../index.js'
 import { count_regular, get_regular, list_regular, 
   remove_regular, upsert_regular } from './con.shared.js'
 
-/**
- * @typedef {import('@storecraft/core/database').db_templates} db_col
- */
-
-
 /**
  * @param {MongoDB} d 
  * 

package/src/utils.funcs.js

@@ -140,10 +140,12 @@ export const handle_or_id = (handle_or_id) => {
  */
 export const objid_or_else_filter = (id_or_else, else_key='handle') => {
   try {
+    // @ts-ignore
     return {
       _id: to_objid(id_or_else)
     }
   } catch (e) {
+    // @ts-ignore
     return {
       [else_key]: id_or_else
     }

package/src/utils.query.js

@@ -1,3 +1,8 @@
+/**
+ * @import { ApiQuery, Cursor, Tuple } from '@storecraft/core/api'
+ * @import { VQL } from '@storecraft/core/vql'
+ */
+
 import { to_objid } from "./utils.funcs.js";
 import { parse } from "@storecraft/core/vql";
 
@@ -17,7 +22,7 @@ let a = {
  * 4. (a1, a2, a3) >= (b1, b2, b3) ==> (a1 > b1) || (a1=b1 & a2>b2) || (a1=b1 & a2=b2 & a3>=b3)
  * 
  * 
- * @param {import("@storecraft/core/api").Cursor} c 
+ * @param {Cursor} c 
  * @param {'>' | '>=' | '<' | '<='} relation 
  * @param {(x: [k: string, v: any]) => [k: string, v: any]} transformer 
  * Your chance to change key and value
@@ -70,7 +75,7 @@ export const query_cursor_to_mongo = (c, relation, transformer=(x)=>x) => {
 }
 
 /**
- * @param {import("@storecraft/core/vql").VQL.Node} node 
+ * @param {VQL.Node} node 
  */
 export const query_vql_node_to_mongo = node => {
   if(node.op==='LEAF') {
@@ -106,7 +111,7 @@ export const query_vql_node_to_mongo = node => {
 
 /**
  * 
- * @param {import("@storecraft/core/vql").VQL.Node} root 
+ * @param {VQL.Node} root 
  */
 export const query_vql_to_mongo = root => {
   return root ? query_vql_node_to_mongo(root) : undefined;
@@ -115,23 +120,21 @@ export const query_vql_to_mongo = root => {
 /**
  * Let's transform ids into mongo ids
  * 
- * 
- * @param {import("@storecraft/core/api").Tuple<string>} c a cursor record
- * 
+ * @param {Tuple} c a cursor record
  * 
  * @returns {[k: string, v: any]}
  */
 const transform = c => {
   if(c[0]!=='id') 
     return c;
-  return [ '_id', to_objid(c[1]) ];
+  return [ '_id', to_objid(String(c[1])) ];
 }
 
 /**
  * Convert an API Query into mongo dialect, also sanitize.
  * 
  * 
- * @param {import("@storecraft/core/api").ApiQuery} q 
+ * @param {ApiQuery<any>} q 
  */
 export const query_to_mongo = (q) => {
   try {

package/src/utils.relations.js

@@ -1,3 +1,10 @@
+/**
+ * @import { ID } from '@storecraft/core/database'
+ * @import { BaseType } from '@storecraft/core/api'
+ * @import { WithRelations } from './utils.relations.js'
+ * @import { Filter } from 'mongodb'
+ */
+
 import { ClientSession, ObjectId } from 'mongodb';
 import { isDef, isUndef, to_objid } from './utils.funcs.js';
 import { MongoDB } from '../index.js';
@@ -6,12 +13,9 @@ import { zeroed_relations } from './con.shared.js';
 /**
  * @template {any} T
  * 
- * 
  * @typedef {Object} Relation
  * @property {ObjectId[]} [ids]
- * @property {Record<
- *  import('@storecraft/core/database').ID, T>
- * } [entries]
+ * @property {Record<ID, T>} [entries]
  */
 
 /**
@@ -27,7 +31,7 @@ import { zeroed_relations } from './con.shared.js';
  * Basically creates an ids array and embedded documents for fast retrival.
  * 
  * 
- * @template {import('@storecraft/core/api').BaseType} T
+ * @template {BaseType} T
  * 
  * 
  * @param {MongoDB} driver our driver
@@ -50,7 +54,7 @@ export const create_explicit_relation = async (
   if(isUndef(value))
     return data;
    
-  /** @type {import('@storecraft/core/api').BaseType[]} */
+  /** @type {BaseType[]} */
   const items = Array.isArray(value) ? value : [value];
 
   /** @type {WithRelations<any>} */
@@ -328,7 +332,7 @@ export const remove_specific_connection_of_relation = (
  * @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 
+ * @param {Filter<any>} 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

package/types.public.d.ts

@@ -1,6 +1,6 @@
 import { MongoClientOptions } from 'mongodb';
 
-export { MongoDB, migrateToLatest } from './index.js';
+export { MongoDB, migrateToLatest, MongoVectorStore } from './index.js';
 
 export type Config = {
   /**
@@ -12,6 +12,7 @@ export type Config = {
   /** 
    * @description the name of the database, if absent, will be infered at init
    * with env `app.platform.env.MONGODB_NAME` 
+   * @default 'main'
    */
   db_name?: string;
 
@@ -19,4 +20,5 @@ export type Config = {
    * @description mongo client options 
    */
   options?: MongoClientOptions;
-}
+}
+