assai 0.4.4 → 0.4.6

package/README.md

@@ -137,4 +137,11 @@ router.post('/', (req, res) => {
     })
     // ...
 })
-```
+```
+
+
+## Remarks
+
+This project can contain bugs and should not be used in production applications.
+
+If you do find a bug, please report it.

package/dist/src/factories/create_mongo_collection.d.mts

@@ -60,7 +60,7 @@ export function createMongoCollection<T extends import("../types.js").MongoDocum
      *
      * @param {import('mongodb').Filter<T>} query
      */
-    deleteMany: (query: import("mongodb").Filter<T>) => Promise<boolean>;
+    deleteMany: (query: import("mongodb").Filter<T>) => Promise<number>;
     /**
      * @param {import('mongodb').Filter<T>} query
      * @param {import('mongodb').UpdateFilter<T>} update
@@ -70,7 +70,7 @@ export function createMongoCollection<T extends import("../types.js").MongoDocum
      * @param {import('mongodb').Filter<T>} query
      * @param {import('mongodb').UpdateFilter<T>} update
      */
-    updateMany: (query: import("mongodb").Filter<T>, update: import("mongodb").UpdateFilter<T>) => Promise<boolean>;
+    updateMany: (query: import("mongodb").Filter<T>, update: import("mongodb").UpdateFilter<T>) => Promise<import("mongodb").UpdateResult<T>>;
 };
 export type IcollectionGetter<T extends import("../types.js").MongoDocument> = () => Promise<Collection<T>>;
 export type IcreateCollectionOptions<T extends import("../types.js").MongoDocument> = {
@@ -80,16 +80,34 @@ export type IcreateCollectionOptions<T extends import("../types.js").MongoDocume
      * This will be not be cached and will be used on every operation such as insertOne or findOne.
      *
      * If you wish to cache the collection object, see `cachableCollectionGetter`.
+     *
+     * Example:
+     * ```js
+     * collectionGetter: async () => await getMyCollection()
+     * ```
      */
     collectionGetter?: IcollectionGetter<T> | undefined;
     /**
      * Same as `collectionGetter`. But the object is cached.
+     *
+     * Example:
+     * ```js
+     * cachableCollectionGetter: async () => await getMyCollection()
+     * ```
      */
     cachableCollectionGetter?: IcollectionGetter<T> | undefined;
     /**
      * A custom connection string. If none is given, `process.env.DATABASE_URL` will be used.
      */
     connectionString?: string | undefined;
+    /**
+     * The name of the database.
+     */
+    dbName?: string | undefined;
+    /**
+     * The options used when initializing client.
+     */
+    options?: import("mongodb").DbOptions | undefined;
 };
 export type ICollection<T extends import("../types.js").MongoDocument> = Awaited<ReturnType<typeof createMongoCollection<T>>>;
 import { Collection } from 'mongodb';

package/dist/src/usecases/mongo/operation/delete_many.d.mts

@@ -7,5 +7,5 @@
 export function deleteMany<T extends import("../../../types.js").MongoDocument>({ query, getCollection }: {
     query: import("mongodb").Filter<T>;
     getCollection: () => Promise<Collection<T>>;
-}): Promise<boolean>;
+}): Promise<number>;
 import { Collection } from 'mongodb';

package/dist/src/usecases/mongo/operation/update_many.d.mts

@@ -9,5 +9,5 @@ export function updateMany<T extends import("../../../types.js").MongoDocument>(
     query: import("mongodb").Filter<T>;
     update: import("mongodb").UpdateFilter<T>;
     getCollection: () => Promise<Collection<T>>;
-}): Promise<boolean>;
+}): Promise<import("mongodb").UpdateResult<T>>;
 import { Collection } from 'mongodb';

package/dist/src/usecases/mongo/transformers/id/rename_find_options.d.mts

@@ -2,4 +2,7 @@
  *
  * @param {import('../../../../types.js').FindOptions<any ,any>} options
  */
-export function renameFindOptions(options?: import('../../../../types.js').FindOptions<any, any>): void;
+export function renameFindOptions(options?: import('../../../../types.js').FindOptions<any, any>): {
+    projection: any;
+    sort: any;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "assai",
-  "version": "0.4.4",
+  "version": "0.4.6",
   "repository": {
     "url": "https://github.com/TimeLord2010/assai",
     "type": "git"

package/src/factories/create_mongo_collection.mjs

@@ -25,7 +25,10 @@ export function createMongoCollection(name, options = {}) {
     let _collection = null
 
     async function getCollection() {
-        const { connectionString, cachableCollectionGetter, collectionGetter } = options
+        const {
+            connectionString, dbName, options: createOptions,
+            cachableCollectionGetter, collectionGetter
+        } = options
 
         // Connection getter from options
         if (collectionGetter != null) return await collectionGetter()
@@ -41,7 +44,7 @@ export function createMongoCollection(name, options = {}) {
 
         // Default connection getter
         const client = await getClient({ connectionString })
-        let db = client.db()
+        let db = client.db(dbName, createOptions)
         /** @type {Collection<T>} */
         _collection = db.collection(name)
         return _collection
@@ -129,11 +132,25 @@ export function createMongoCollection(name, options = {}) {
  *
  * If you wish to cache the collection object, see `cachableCollectionGetter`.
  *
+ * Example:
+ * ```js
+ * collectionGetter: async () => await getMyCollection()
+ * ```
+ *
  * @property {IcollectionGetter<T>} [options.cachableCollectionGetter]
  * Same as `collectionGetter`. But the object is cached.
  *
+ * Example:
+ * ```js
+ * cachableCollectionGetter: async () => await getMyCollection()
+ * ```
+ *
  * @property {string} [options.connectionString]
  * A custom connection string. If none is given, `process.env.DATABASE_URL` will be used.
+ *
+ * @property {string} [dbName] The name of the database.
+ *
+ * @property {import('mongodb').DbOptions} [options] The options used when initializing client.
  */
 
 /**

package/src/usecases/mongo/operation/count.mjs

@@ -8,7 +8,7 @@ import { renameToMongoId, stringsIntoId } from '../transformers/index.mjs'
  * @param {import('mongodb').Filter<T>} [params.query]
  */
 export async function count({ getCollection, query }) {
-    renameToMongoId(query)
+    query = renameToMongoId(query)
     stringsIntoId(query)
 
     const col = await getCollection()

package/src/usecases/mongo/operation/delete_many.mjs

@@ -8,9 +8,9 @@ import { renameToMongoId, stringsIntoId } from '../transformers/index.mjs'
  * @param {() => Promise<Collection<T>>} parameter.getCollection
  */
 export async function deleteMany({ query, getCollection }) {
-    renameToMongoId(query)
+    query = renameToMongoId(query)
     stringsIntoId(query)
     const col = await getCollection()
     const r = await col.deleteMany(query)
-    return r.deletedCount > 0
+    return r.deletedCount
 }

package/src/usecases/mongo/operation/delete_one.mjs

@@ -9,7 +9,7 @@ import { renameToMongoId, stringsIntoId } from '../transformers/index.mjs'
  * @returns {Promise<boolean>}
  */
 export async function deleteOne({ query, getCollection }) {
-    renameToMongoId(query)
+    query = renameToMongoId(query)
     stringsIntoId(query)
     const col = await getCollection()
     const r = await col.deleteOne(query)

package/src/usecases/mongo/operation/find.mjs

@@ -17,8 +17,8 @@ import {
  * @returns {Promise<T[]>}
  */
 export async function find({ getCollection, query, options }) {
-    renameToMongoId(query)
-    renameFindOptions(options)
+    query = renameToMongoId(query)
+    options = renameFindOptions(options)
 
     stringsIntoId(query)
 

package/src/usecases/mongo/operation/insert_many.mjs

@@ -10,9 +10,14 @@ import { renameToMongoId, stringsIntoId } from '../transformers/index.mjs'
  */
 export async function insertMany({ docs, getCollection }) {
     if (docs.length == 0) return []
-    for (const doc of docs) {
-        renameToMongoId(doc)
-        stringsIntoId(doc)
+
+    // We need to clone the array to prevent the function from changing the original input object.
+    // This is necessary since we change the objects inside the array to rename the "id" to "_id".
+    docs = [...docs]
+
+    for (let i = 0; i < docs.length; i++) {
+        docs[i] = renameToMongoId(docs[i])
+        stringsIntoId(docs[i])
     }
     const col = await getCollection()
     const result = await col.insertMany(

package/src/usecases/mongo/operation/insert_one.mjs

@@ -9,7 +9,7 @@ import { renameToMongoId, stringsIntoId } from '../transformers/index.mjs'
  * @returns {Promise<T>}
  */
 export async function insertOne({ doc, getCollection }) {
-    renameToMongoId(doc)
+    doc = renameToMongoId(doc)
     stringsIntoId(doc)
     const col = await getCollection()
     const result = await col.insertOne(

package/src/usecases/mongo/operation/update_many.mjs

@@ -9,10 +9,10 @@ import { renameToMongoId, stringsIntoId } from '../transformers/index.mjs'
  * @param {() => Promise<Collection<T>>} param.getCollection
  */
 export async function updateMany({ query, update, getCollection }) {
-    renameToMongoId(query)
+    query = renameToMongoId(query)
     stringsIntoId(query)
     stringsIntoId(update)
     const col = await getCollection()
     const r = await col.updateMany(query, update)
-    return r.matchedCount > 0
+    return r
 }

package/src/usecases/mongo/operation/update_one.mjs

@@ -9,7 +9,7 @@ import { renameToMongoId, stringsIntoId } from '../transformers/index.mjs'
  * @param {() => Promise<Collection<T>>} param.getCollection
  */
 export async function updateOne({ query, update, getCollection }) {
-    renameToMongoId(query)
+    query = renameToMongoId(query)
     stringsIntoId(query)
     stringsIntoId(update)
     const col = await getCollection()

package/src/usecases/mongo/test/manage_mock_registry.mjs

@@ -20,16 +20,18 @@ export function manageMockRegistry({ tag, ...rest } = {}, {
     const name = rest.name ?? fakerPT_BR.person.fullName()
 
     before(async () => {
+        /** @type {import('./mock_get_collection.mjs').ItestCollection} */
+        const doc = {
+            id,
+            createdAt: new Date(),
+            tag,
+            name: name,
+            ...rest,
+        }
         await insertOne({
             // @ts-ignore
             getCollection: mockGetCollection,
-            doc: {
-                id,
-                createdAt: new Date(),
-                tag,
-                name: name,
-                ...rest,
-            },
+            doc: doc,
         })
     })
 

package/src/usecases/mongo/transformers/id/rename_find_options.mjs

@@ -5,6 +5,8 @@ import { renameToMongoId } from './index.mjs'
  * @param {import('../../../../types.js').FindOptions<any ,any>} options
  */
 export function renameFindOptions(options = {}) {
-    renameToMongoId(options.projection)
-    renameToMongoId(options.sort)
+    return {
+        projection: renameToMongoId(options.projection),
+        sort: renameToMongoId(options.sort)
+    }
 }

package/src/usecases/mongo/transformers/id/rename_to_dev_id.mjs

@@ -7,10 +7,8 @@ export function renameToDevId(obj) {
     if (!obj) return obj
     let { _id, ...rest } = obj
     if (!_id) return obj
-    delete obj['_id']
-    // if (_id instanceof ObjectId) {
-    //     _id = _id.toHexString()
-    // }
-    obj.id = _id
-    return obj
+    return {
+        id: _id,
+        ...rest
+    }
 }

package/src/usecases/mongo/transformers/id/rename_to_mongo_id.mjs

@@ -7,10 +7,8 @@ export function renameToMongoId(obj) {
     if (!obj) return obj
     let { id, ...rest } = obj
     if (!id) return obj
-    delete obj['id']
-    // if (_id instanceof ObjectId) {
-    //     _id = _id.toHexString()
-    // }
-    obj._id = id
-    return obj
+    return {
+        _id: id,
+        ...rest
+    }
 }

package/src/usecases/mongo/transformers/object_id/strings_into_id.mjs

@@ -15,6 +15,9 @@ export function stringsIntoId(obj) {
     if (isObjectIdString(obj)) return new ObjectId(obj)
     if (typeof obj != 'object') return obj
     if (Array.isArray(obj)) {
+        // We clone the array to prevent the original array reference to change.
+        obj = [...obj]
+
         for (let i = 0; i < obj.length; i++) {
             const item = obj[i]
             obj[i] = stringsIntoId(item)