@storecraft/database-mongodb 1.0.1

package/src/con.shared.js

@@ -0,0 +1,333 @@
+import { Collection } from 'mongodb'
+import { MongoDB } from '../index.js'
+import { handle_or_id, isUndef, sanitize_array, 
+  sanitize_one, to_objid } from './utils.funcs.js'
+import { query_to_mongo } from './utils.query.js'
+import { report_document_media } from './con.images.js'
+import { add_search_terms_relation_on } from './utils.relations.js'
+
+
+/**
+ * @template {import('@storecraft/core/v-api').BaseType} T
+ * @template {import('@storecraft/core/v-api').BaseType} G
+ * 
+ * 
+ * @param {MongoDB} driver 
+ * @param {Collection<G>} col 
+ * 
+ * 
+ * @returns {import('@storecraft/core/v-database').db_crud<T, G>["upsert"]}
+ * 
+ */
+export const upsert_regular = (driver, col) => {
+  return async (data, search_terms=[]) => {
+
+    data = {...data};
+    
+    const session = driver.mongo_client.startSession();
+
+    try {
+      await session.withTransaction(
+        async () => {
+          // SEARCH
+          add_search_terms_relation_on(
+            data, 
+            [
+              ...search_terms
+            ]
+          );
+
+          const res = await col.replaceOne(
+            // @ts-ignore
+            { 
+              _id: to_objid(data.id) 
+            }, 
+            data,
+            { 
+              session, upsert: true 
+            }
+          );
+
+          ////
+          // REPORT IMAGES USAGE
+          ////
+          await report_document_media(driver)(data, session);
+        }
+      );
+    } catch(e) {
+      console.log(e);
+
+      return false;
+    } finally {
+      await session.endSession();
+    }
+
+    return true;
+  }
+}
+
+/**
+ * Extract relations names from item
+ * 
+ * 
+ * @template {import('./utils.relations.js').WithRelations<{}>} T
+ * 
+ * 
+ * @param {T} item
+ */
+export const get_relations_names = item => {
+  return Object.keys(item?._relations ?? {});
+}
+
+/**
+ * Expand relations in-place
+ * 
+ * 
+ * @template {any} T
+ * 
+ * 
+ * @param {import('./utils.relations.js').WithRelations<T>[]} items
+ * @param {import('@storecraft/core/v-api').ExpandQuery} [expand_query] 
+ * 
+ */
+export const expand = (items, expand_query=undefined) => {
+  
+  if(isUndef(expand_query) || !Array.isArray(items))
+    return items;
+
+  items = items.filter(Boolean)
+
+  const all = expand_query.includes('*');
+  
+  for(const item of items) {
+    expand_query = all ? get_relations_names(item) : expand_query;
+
+    for(const e of (expand_query ?? [])) {
+      // try to find embedded documents relations
+      const rel = item?._relations?.[e];
+      if(rel===undefined || rel===null)
+        continue;
+      
+      item[e] = [];
+
+      if(Array.isArray(rel)) {
+        item[e] = rel;
+      } else if(rel?.entries) {
+        // recurse
+        item[e] = sanitize_array(
+          expand(
+            Object.values(rel.entries),
+            ['*']
+          )
+        );
+      }
+    }
+  }
+
+  return items;
+}
+
+
+export const zeroed_relations = {
+  '_relations.discounts': 0,
+  '_relations.collections': 0,
+  '_relations.variants': 0,
+  '_relations.related_products': 0,
+  '_relations.search': 0,
+  '_relations.posts': 0,
+  '_relations.products': 0,
+  '_relations.shipping_methods': 0,
+} 
+
+
+/**
+ * 
+ * @param {import('@storecraft/core/v-database').RegularGetOptions["expand"]} expand 
+ */
+export const expand_to_mongo_projection = (expand) => {
+  let projection = {}
+
+  if(!expand?.includes('*')) {
+    projection = zeroed_relations;
+
+    expand?.forEach(
+      it => {
+        delete projection[`_relations.${it}`];
+      }
+    )
+  }
+
+  return projection;
+}
+
+/**
+ * @template T, G
+ * 
+ * 
+ * @param {MongoDB} driver 
+ * @param {Collection<G>} col 
+ * 
+ * 
+ * @returns {import('@storecraft/core/v-database').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>>} */
+    const res = await col.findOne(
+      filter,
+      {
+        projection: expand_to_mongo_projection(options?.expand)
+      }
+    );
+
+    // try to expand relations
+    expand([res], options?.expand);
+
+    return sanitize_one(res);
+  }
+}
+
+/**
+ * get bulk of items, ordered, if something is missing, `undefined`
+ * should be instead
+ * 
+ * 
+ * @template {import('@storecraft/core/v-api').idable} T
+ * @template {import('@storecraft/core/v-api').idable} G
+ * 
+ * 
+ * @param {MongoDB} driver 
+ * @param {Collection<G>} col 
+ * 
+ * 
+ * @returns {import('@storecraft/core/v-database').db_crud<T, G>["getBulk"]}
+ */
+export const get_bulk = (driver, col) => {
+  return async (ids, options) => {
+    const objids = ids.map(handle_or_id)
+                      .map(v => ('_id' in v) ? v._id : undefined)
+                      .filter(Boolean);
+
+
+
+    const res = await col.find(
+      // @ts-ignore
+      { 
+        $or: [
+          {
+            _id: { $in: objids } 
+          },
+          {
+            handle: { $in: ids } 
+          }
+        ]
+      }
+    ).toArray();
+
+    // try to expand relations
+    expand(res, options?.expand);
+    const sanitized = sanitize_array(res);
+// console.log('res', sanitized)
+    // now let's order them
+    return ids.map(
+      id => sanitized.find(s => s.id===id || s?.handle===id)
+    );
+    
+  }
+}
+
+
+/**
+ * @template T, G
+ * 
+ * 
+ * @param {MongoDB} driver 
+ * @param {Collection<G>} col 
+ * 
+ * 
+ * @returns {import('@storecraft/core/v-database').db_crud<T, G>["remove"]}
+ */
+export const remove_regular = (driver, col) => {
+  return async (id_or_handle) => {
+
+    const res = await col.deleteOne( 
+      handle_or_id(id_or_handle)
+    );
+
+    return res.acknowledged && res.deletedCount>0;
+  }
+}
+
+/**
+ * @template {any} T
+ * @template {any} G
+ * 
+ * 
+ * @param {MongoDB} driver 
+ * @param {Collection<G>} col 
+ * 
+ * 
+ * @returns {import('@storecraft/core/v-database').db_crud<T, G>["list"]}
+ */
+export const list_regular = (driver, col) => {
+  return async (query) => {
+
+    const { filter, sort, reverse_sign } = query_to_mongo(query);
+
+    // console.log('reverse_sign', reverse_sign)
+    // console.log('query', query)
+    // console.log('filter', JSON.stringify(filter, null, 2))
+    // console.log('sort', sort)
+    // console.log('expand', query?.expand)
+
+    /** @type {import('mongodb').WithId<G>[]} */
+    const items = await col.find(
+      filter,  {
+        sort, 
+        limit: reverse_sign==-1 ? query.limitToLast : query.limit,
+        projection: expand_to_mongo_projection(query?.expand)
+      }
+    ).toArray();
+
+    if(reverse_sign==-1) items.reverse();
+
+    // try expand relations, that were asked
+    const items_expended = expand(items, query?.expand);
+
+    const sanitized = sanitize_array(items_expended);
+
+    // console.log('sanitized', sanitized)
+
+    return sanitized;
+  }
+}
+
+/**
+ * @template {any} T
+ * @template {any} G
+ * 
+ * 
+ * @param {MongoDB} driver 
+ * @param {Collection<G>} col 
+ * 
+ * 
+ * @returns {import('@storecraft/core/v-database').db_crud<T, G>["count"]}
+ */
+export const count_regular = (driver, col) => {
+  return async (query) => {
+
+    const { filter } = query_to_mongo(query);
+
+    // console.log('query', query);
+    // console.log('filter', JSON.stringify(filter, null, 2));
+
+    const count = await col.countDocuments(
+      filter
+    );
+
+    return count;
+  }
+}
+

package/src/con.shipping.js

@@ -0,0 +1,153 @@
+import { Collection } from 'mongodb'
+import { MongoDB } from '../index.js'
+import { count_regular, get_regular, list_regular } from './con.shared.js'
+import { handle_or_id, to_objid } from './utils.funcs.js';
+import { report_document_media } from './con.images.js';
+import { 
+  add_search_terms_relation_on, delete_me, 
+  remove_entry_from_all_connection_of_relation, save_me, 
+  update_entry_on_all_connection_of_relation 
+} from './utils.relations.js';
+
+/**
+ * @typedef {import('@storecraft/core/v-database').db_shipping} db_col
+ */
+
+/**
+ * @param {MongoDB} d 
+ * 
+ * 
+ * @returns {Collection<import('./utils.relations.js').WithRelations<db_col["$type_get"]>>}
+ */
+const col = (d) => d.collection('shipping_methods');
+
+/**
+ * @param {MongoDB} driver 
+ * 
+ * 
+ * @returns {db_col["upsert"]}
+ */
+const upsert = (driver) => {
+  return async (data, search_terms=[]) => {
+
+    data = {...data};
+
+    const objid = to_objid(data.id);
+    const session = driver.mongo_client.startSession();
+
+    try {
+      await session.withTransaction(
+        async () => {
+
+          // SEARCH
+          add_search_terms_relation_on(data, search_terms);
+          
+          ////
+          // STOREFRONTS --> SHIPPING RELATION
+          ////
+          await update_entry_on_all_connection_of_relation(
+            driver, 'storefronts', 'shipping_methods', objid, data, session
+          );
+
+          ////
+          // REPORT IMAGES USAGE
+          ////
+          await report_document_media(driver)(data, session);
+
+          // SAVE ME
+          await save_me(
+            driver, 'shipping_methods', objid, data, session
+          );
+
+        }
+      );
+    } catch(e) {
+      console.log(e);
+      return false;
+    } finally {
+      await session.endSession();
+    }
+
+    return true;
+  }
+
+}
+
+/**
+ * @param {MongoDB} driver 
+ */
+const get = (driver) => get_regular(driver, col(driver));
+
+/**
+ * @param {MongoDB} driver 
+ * 
+ * 
+ * @returns {db_col["remove"]}
+ */
+const remove = (driver) => {
+  return async (id_or_handle) => {
+    const item = await col(driver).findOne(handle_or_id(id_or_handle));
+
+    if(!item) return;
+
+    const objid = to_objid(item.id);
+    const session = driver.mongo_client.startSession();
+
+    try {
+      await session.withTransaction(
+        async () => {
+
+          ////
+          // STOREFRONTS --> SHIPPING RELATION
+          ////
+          await remove_entry_from_all_connection_of_relation(
+            driver, 'storefronts', 'shipping_methods', objid, session
+          );
+
+          // DELETE ME
+          await delete_me(
+            driver, 'shipping_methods', objid, session
+          );
+
+        }
+      );
+    } catch(e) {
+      console.log(e);
+      
+      return false;
+    } finally {
+      await session.endSession();
+    }
+
+    return true;
+  }
+
+}
+
+
+/**
+ * @param {MongoDB} driver 
+ */
+const list = (driver) => list_regular(driver, col(driver));
+
+/**
+ * @param {MongoDB} driver 
+ */
+const count = (driver) => count_regular(driver, col(driver));
+
+/** 
+ * @param {MongoDB} driver
+ * 
+ * 
+ * @return {db_col & { _col: ReturnType<col>}}
+ */
+export const impl = (driver) => {
+  return {
+    _col: col(driver),
+    get: get(driver),
+    upsert: upsert(driver),
+    remove: remove(driver),
+    list: list(driver),
+    count: count(driver),
+  }
+}

package/src/con.storefronts.js

@@ -0,0 +1,223 @@
+import { Collection } from 'mongodb'
+import { MongoDB } from '../index.js'
+import { count_regular, get_regular, list_regular, 
+  remove_regular } from './con.shared.js'
+import { sanitize_array, to_objid } from './utils.funcs.js'
+import { 
+  add_search_terms_relation_on, create_explicit_relation, save_me 
+} from './utils.relations.js';
+import { report_document_media } from './con.images.js';
+
+/**
+ * @typedef {import('@storecraft/core/v-database').db_storefronts} db_col
+ */
+
+/**
+ * @param {MongoDB} d 
+ * 
+ * 
+ * @returns {Collection<
+ *  import('./utils.relations.js').WithRelations<db_col["$type_get"]>>
+ * }
+ * 
+ */
+const col = (d) => d.collection('storefronts');
+
+/**
+ * @param {MongoDB} driver 
+ * 
+ * 
+ * @return {db_col["upsert"]}
+ */
+const upsert = (driver) => {
+  return async (data, search_terms=[]) => {
+    data = {...data};
+
+    const session = driver.mongo_client.startSession();
+
+    try {
+      await session.withTransaction(
+        async () => {
+          ////
+          // PRODUCTS/COLLECTIONS/DISCOUNTS/SHIPPING/POSTS RELATIONS (explicit)
+          ////
+          let replacement = await create_explicit_relation(
+            driver, data, 'products', 'products', true
+          );
+          replacement = await create_explicit_relation(
+            driver, replacement, 'collections', 'collections', true
+          );
+          replacement = await create_explicit_relation(
+            driver, replacement, 'discounts', 'discounts', true
+          );
+          replacement = await create_explicit_relation(
+            driver, replacement, 'shipping_methods', 'shipping_methods', true
+          );
+          replacement = await create_explicit_relation(
+            driver, replacement, 'posts', 'posts', true
+          );
+
+          // SEARCH
+          add_search_terms_relation_on(replacement, search_terms);
+
+          ////
+          // REPORT IMAGES USAGE
+          ////
+          await report_document_media(driver)(replacement, session);
+          
+          // SAVE ME
+          await save_me(
+            driver, 'storefronts', to_objid(data.id), replacement, session
+          );
+
+        }
+      );
+    } catch (e) {
+      console.log(e);
+      
+      return false;
+    } finally {
+      await session.endSession();
+    }
+
+    return true;
+  }
+
+}
+
+/**
+ * @param {MongoDB} driver 
+ */
+const get = (driver) => get_regular(driver, col(driver));
+
+/**
+ * @param {MongoDB} driver 
+ */
+const remove = (driver) => remove_regular(driver, col(driver));
+
+/**
+ * @param {MongoDB} driver 
+ */
+const list = (driver) => list_regular(driver, col(driver));
+
+/**
+ * @param {MongoDB} driver 
+ */
+const count = (driver) => count_regular(driver, col(driver));
+
+/**
+ * @param {MongoDB} driver 
+ * 
+ * 
+ * @returns {db_col["list_storefront_products"]}
+ */
+const list_storefront_products = (driver) => {
+  return async (product) => {
+    /** @type {import('@storecraft/core/v-database').RegularGetOptions} */
+    const options = {
+      expand: ['products']
+    };
+
+    const item = await get_regular(driver, col(driver))(product, options);
+
+    return sanitize_array(item?.products ?? []);
+  }
+}
+
+/**
+ * @param {MongoDB} driver 
+ * 
+ * 
+ * @returns {db_col["list_storefront_collections"]}
+ */
+const list_storefront_collections = (driver) => {
+  return async (product) => {
+    /** @type {import('@storecraft/core/v-database').RegularGetOptions} */
+    const options = {
+      expand: ['collections']
+    };
+
+    const item = await get_regular(driver, col(driver))(product, options);
+
+    return sanitize_array(item?.collections ?? []);
+  }
+}
+
+/**
+ * @param {MongoDB} driver 
+ * 
+ * 
+ * @returns {db_col["list_storefront_discounts"]}
+ */
+const list_storefront_discounts = (driver) => {
+  return async (product) => {
+    /** @type {import('@storecraft/core/v-database').RegularGetOptions} */
+    const options = {
+      expand: ['discounts']
+    };
+
+    const item = await get_regular(driver, col(driver))(product, options);
+
+    return sanitize_array(item?.discounts ?? []);
+  }
+}
+
+/**
+ * @param {MongoDB} driver 
+ * 
+ * @returns {db_col["list_storefront_shipping_methods"]}
+ */
+const list_storefront_shipping_methods = (driver) => {
+  return async (product) => {
+    /** @type {import('@storecraft/core/v-database').RegularGetOptions} */
+    const options = {
+      expand: ['shipping_methods']
+    };
+
+    const item = await get_regular(driver, col(driver))(product, options);
+
+    return sanitize_array(item?.shipping_methods ?? []);
+  }
+}
+
+/**
+ * @param {MongoDB} driver 
+ * 
+ * 
+ * @returns {db_col["list_storefront_posts"]}
+ */
+const list_storefront_posts = (driver) => {
+  return async (product) => {
+    /** @type {import('@storecraft/core/v-database').RegularGetOptions} */
+    const options = {
+      expand: ['posts']
+    };
+
+    const item = await get_regular(driver, col(driver))(product, options);
+
+    return sanitize_array(item?.posts ?? []);
+  }
+}
+
+/** 
+ * @param {MongoDB} driver
+ * 
+ * 
+ * @return {db_col & { _col: ReturnType<col>}}
+ * */
+export const impl = (driver) => {
+
+  return {
+    _col: col(driver),
+    get: get(driver),
+    upsert: upsert(driver),
+    remove: remove(driver),
+    list: list(driver),
+    count: count(driver),
+    list_storefront_products: list_storefront_products(driver),
+    list_storefront_collections: list_storefront_collections(driver),
+    list_storefront_discounts: list_storefront_discounts(driver),
+    list_storefront_shipping_methods: list_storefront_shipping_methods(driver),
+    list_storefront_posts: list_storefront_posts(driver),
+  }
+}