assai 0.4.3 → 0.4.5

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

@@ -10,7 +10,7 @@
  * @param {string} name
  * @param {IcreateCollectionOptions<T>} [options]
  */
-export function createMongoCollection<T extends import("../types.js").MongoDocument>(name: string, options?: IcreateCollectionOptions<T> | undefined): Promise<{
+export function createMongoCollection<T extends import("../types.js").MongoDocument>(name: string, options?: IcreateCollectionOptions<T> | undefined): {
     /**
      * Returns the native driver.
      */
@@ -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,8 +70,8 @@ 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "assai",
-  "version": "0.4.3",
+  "version": "0.4.5",
   "repository": {
     "url": "https://github.com/TimeLord2010/assai",
     "type": "git"
@@ -9,7 +9,7 @@
   "main": "index.mjs",
   "types": "dist/index.d.mts",
   "scripts": {
-    "prepare": "tsc -p ./jsconfig.prod.json",
+    "prepare": "rm -rf dist && tsc -p ./jsconfig.prod.json",
     "start": "node --env-file=.env index.mjs",
     "test": "node --env-file=.env --test"
   },

package/src/factories/create_mongo_collection.mjs

@@ -19,13 +19,16 @@ import {
  * @param {string} name
  * @param {IcreateCollectionOptions<T>} [options]
  */
-export async function createMongoCollection(name, options = {}) {
+export function createMongoCollection(name, options = {}) {
 
     /** @type {Collection<T> | null} */
     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 async 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 async 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/delete_many.mjs

@@ -12,5 +12,5 @@ export async function deleteMany({ query, getCollection }) {
     stringsIntoId(query)
     const col = await getCollection()
     const r = await col.deleteMany(query)
-    return r.deletedCount > 0
+    return r.deletedCount
 }

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

@@ -14,5 +14,5 @@ export async function updateMany({ query, update, getCollection }) {
     stringsIntoId(update)
     const col = await getCollection()
     const r = await col.updateMany(query, update)
-    return r.matchedCount > 0
+    return r
 }

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,
         })
     })