@storecraft/database-mongodb 1.0.20 → 1.0.21

package/src/con.search.js

@@ -2,11 +2,9 @@
  * @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 db_driver["resources"])[]}
  */
@@ -46,9 +44,7 @@ const prefix_to_resource = {
 }
 
 /**
- * 
  * @param {string} id 
- * 
  * @returns {keyof db_driver["resources"]}
  */
 export const id_to_resource = id => {
@@ -65,8 +61,6 @@ export const id_to_resource = id => {
 
 /**
  * @param {MongoDB} driver 
- * 
- * 
  * @returns {db_col["quicksearch"]}
  */
 export const quicksearch = (driver) => {
@@ -151,10 +145,8 @@ export const quicksearch = (driver) => {
 
 /** 
  * @param {MongoDB} driver
- * 
- * 
  * @return {db_col}
- * */
+ */
 export const impl = (driver) => {
 
   return {

package/src/con.shared.js

@@ -1,27 +1,28 @@
 /**
- * @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 { db_crud, withConcreteId, withConcreteIdAndHandle } from '@storecraft/core/database'
+ * @import { 
+ *  BaseType, ExpandQuery, withOptionalID 
+ * } from '@storecraft/core/api'
  * @import { WithRelations } from './utils.types.js'
  * @import { WithId } from 'mongodb'
  */
-
 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 { 
+  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 {BaseType} T
- * @template {BaseType} G
- * 
+ * @description Upsert function for MongoDB
+ * @template {Partial<withConcreteIdAndHandle<{}>>} T
+ * @template {Partial<withConcreteIdAndHandle<{}>>} G
  * @param {MongoDB} driver 
  * @param {Collection<G>} col 
- * 
  * @returns {db_crud<T, G>["upsert"]}
  */
 export const upsert_regular = (driver, col) => {
@@ -72,20 +73,6 @@ export const upsert_regular = (driver, col) => {
 
           );
 
-          // const res = await col.replaceOne(
-          //   // @ts-ignore
-          //   { 
-          //     $or: [
-          //       data.id && { _id: to_objid(data.id) },
-          //       data.handle && { handle: data.handle }
-          //     ].filter(Boolean)
-          //   }, 
-          //   data,
-          //   { 
-          //     session, upsert: true 
-          //   }
-          // );
-
           ////
           // REPORT IMAGES USAGE
           ////
@@ -105,7 +92,7 @@ export const upsert_regular = (driver, col) => {
 }
 
 /**
- * Extract relations names from item
+ * @description Extract relations names from item
  * @template {WithRelations<{}>} T
  * @param {T} item
  */
@@ -114,10 +101,8 @@ export const get_relations_names = item => {
 }
 
 /**
- * Expand relations in-place
- * 
+ * @description Expand relations in-place
  * @template {any} T
- * 
  * @param {WithRelations<T>[]} items
  * @param {ExpandQuery<T>} [expand_query] 
  */
@@ -224,7 +209,7 @@ export const get_regular = (driver, col) => {
 }
 
 /**
- * get bulk of items, ordered, if something is missing, `undefined`
+ * @description get bulk of items, ordered, if something is missing, `undefined`
  * should be instead
  * @template {withOptionalID} T
  * @template {withOptionalID} G
@@ -234,11 +219,10 @@ export const get_regular = (driver, col) => {
  */
 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 objids = ids
+    .map(handle_or_id)
+    .map(v => ('_id' in v) ? v._id : undefined)
+    .filter(Boolean);
 
     const res = /** @type {(WithRelations<WithId<G>>)[]} */ (
       await col.find(
@@ -264,7 +248,6 @@ export const get_bulk = (driver, col) => {
       )
     );
     
-    
     const sanitized = /** @type {G[]} */(
       /** @type {unknown} */(
         sanitize_array(res)
@@ -273,7 +256,9 @@ export const get_bulk = (driver, col) => {
 
     // now let's order them
     return ids.map(
-      id => sanitized.find(s => s.id===id || s?.['handle']===id)
+      id => sanitized.find(
+        s => s.id===id || s?.['handle']===id
+      )
     );
     
   }
@@ -282,12 +267,8 @@ export const get_bulk = (driver, col) => {
 
 /**
  * @template T, G
- * 
- * 
  * @param {MongoDB} driver 
  * @param {Collection<G>} col 
- * 
- * 
  * @returns {db_crud<T, G>["remove"]}
  */
 export const remove_regular = (driver, col) => {
@@ -321,7 +302,8 @@ export const list_regular = (driver, col) => {
 
     /** @type {WithRelations<WithId<G>>[]} */
     const items = await col.find(
-      filter,  {
+      filter, 
+      {
         sort, 
         limit: reverse_sign==-1 ? query.limitToLast : query.limit,
         projection: expand_to_mongo_projection(query?.expand)
@@ -349,12 +331,8 @@ export const list_regular = (driver, col) => {
 /**
  * @template {any} T
  * @template {any} G
- * 
- * 
  * @param {MongoDB} driver 
  * @param {Collection<G>} col 
- * 
- * 
  * @returns {db_crud<T, G>["count"]}
  */
 export const count_regular = (driver, col) => {

package/src/con.shipping.js

@@ -2,7 +2,6 @@
  * @import { db_shipping as db_col } from '@storecraft/core/database'
  * @import { WithRelations } from './utils.types.js'
  */
-
 import { Collection } from 'mongodb'
 import { MongoDB } from '../index.js'
 import { count_regular, get_regular, list_regular } from './con.shared.js'
@@ -22,8 +21,6 @@ const col = (d) => d.collection('shipping_methods');
 
 /**
  * @param {MongoDB} driver 
- * 
- * 
  * @returns {db_col["upsert"]}
  */
 const upsert = (driver) => {
@@ -79,8 +76,6 @@ const get = (driver) => get_regular(driver, col(driver));
 
 /**
  * @param {MongoDB} driver 
- * 
- * 
  * @returns {db_col["remove"]}
  */
 const remove = (driver) => {
@@ -136,8 +131,6 @@ const count = (driver) => count_regular(driver, col(driver));
 
 /** 
  * @param {MongoDB} driver
- * 
- * 
  * @return {db_col & { _col: ReturnType<col>}}
  */
 export const impl = (driver) => {

package/src/con.storefronts.js

@@ -5,12 +5,13 @@
  * @import { StorefrontType } from '@storecraft/core/api'
  * @import { WithRelations } from './utils.types.js'
  */
-
 import { Collection } from 'mongodb'
 import { MongoDB } from '../index.js'
-import { count_regular, expand, get_regular, list_regular, 
-  remove_regular } from './con.shared.js'
-import { sanitize_array, sanitize_recursively, to_objid } from './utils.funcs.js'
+import { 
+  count_regular, expand, get_regular, list_regular, 
+  remove_regular 
+} from './con.shared.js'
+import { sanitize_recursively, to_objid } from './utils.funcs.js'
 import { 
   add_search_terms_relation_on, create_explicit_relation, save_me 
 } from './utils.relations.js';
@@ -24,8 +25,6 @@ const col = (d) => d.collection('storefronts');
 
 /**
  * @param {MongoDB} driver 
- * 
- * 
  * @return {db_col["upsert"]}
  */
 const upsert = (driver) => {
@@ -223,10 +222,8 @@ const get_default_auto_generated_storefront = (driver) => {
 
 /** 
  * @param {MongoDB} driver
- * 
- * 
  * @return {db_col & { _col: ReturnType<col>}}
- * */
+ */
 export const impl = (driver) => {
 
   return {

package/src/con.tags.js

@@ -1,23 +1,21 @@
 /**
  * @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'
+import { Collection } from 'mongodb';
+import { MongoDB } from '../index.js';
+import { 
+  count_regular, get_regular, list_regular, 
+  remove_regular, upsert_regular 
+} from './con.shared.js';
 
 /**
  * @param {MongoDB} d 
- * 
- * 
  * @returns {Collection<db_col["$type_get"]>}
  */
 const col = (d) => d.collection('tags');
 
 /**
  * @param {MongoDB} driver 
- * 
  * @returns {db_col["upsert"]}
  */
 const upsert = (driver) => upsert_regular(driver, col(driver));
@@ -44,10 +42,8 @@ const count = (driver) => count_regular(driver, col(driver));
 
 /** 
  * @param {MongoDB} driver
- * 
- * 
  * @return {db_col & { _col: ReturnType<col>}}
- * */
+ */
 export const impl = (driver) => {
 
   return {

package/src/con.templates.js

@@ -1,23 +1,21 @@
 /**
  * @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'
+import { 
+  count_regular, get_regular, list_regular, 
+  remove_regular, upsert_regular 
+} from './con.shared.js'
 
 /**
  * @param {MongoDB} d 
- * 
- * 
  * @returns {Collection<db_col["$type_get"]>}
  */
 const col = (d) => d.collection('templates');
 
 /**
  * @param {MongoDB} driver 
- * 
  * @returns {db_col["upsert"]}
  */
 const upsert = (driver) => upsert_regular(driver, col(driver));
@@ -44,8 +42,6 @@ const count = (driver) => count_regular(driver, col(driver));
 
 /** 
  * @param {MongoDB} driver
- * 
- * 
  * @return {db_col & { _col: ReturnType<col>}}
  * */
 export const impl = (driver) => {

package/src/utils.funcs.js

@@ -11,7 +11,6 @@ export const isDef = v => v!==undefined && v!==null;
 export const isUndef = v => !isDef(v);
 
 /**
- * 
  * @param  {...any} keys 
  */
 export const delete_keys = (...keys) => {
@@ -29,7 +28,7 @@ export const delete_keys = (...keys) => {
 }
 
 /**
- * Sanitize hidden properties in-place
+ * @description Sanitize hidden properties in-place
  * @template {object} T
  * @param {T} o 
  * @return {Omit<T, '_id' | '_relations'>}
@@ -46,7 +45,7 @@ export const sanitize_hidden = o => {
 }
 
 /**
- * Sanitize hidden properties in-place recursively
+ * @description Sanitize hidden properties in-place recursively
  * @template {object} T
  * @param {T} o 
  * @return {Omit<T, '_id' | '_relations'>}
@@ -63,7 +62,7 @@ export const sanitize_recursively = o => {
 }
 
 /**
- * Sanitize the mongo document before sending to client
+ * @description Sanitize the mongo document before sending to client
  * @template T
  * @param {WithRelations<T>} o 
  */
@@ -72,7 +71,7 @@ export const sanitize_one = o => {
 }
 
 /**
- * Sanitize the mongo document before sending to client
+ * @description Sanitize the mongo document before sending to client
  * @template T
  * @param {WithRelations<T>[]} o 
  */
@@ -109,7 +108,7 @@ export const to_objid_safe = id => {
 }
 
 /**
- * Create a `filter` for `object-id` or `handle`
+ * @description Create a `filter` for `object-id` or `handle`
  * @template {{handle?: string}} G
  * @param {string} handle_or_id 
  * @returns {Filter<G>}