assai 2.0.0 → 2.1.1

package/package.json

@@ -1,39 +1,40 @@
-{
-  "name": "assai",
-  "version": "2.0.0",
-  "repository": {
-    "url": "https://github.com/TimeLord2010/assai",
-    "type": "git"
-  },
-  "description": "A simple mongodb wrapper to make mongo even easier to work with.",
-  "main": "index.mjs",
-  "types": "dist/index.d.mts",
-  "scripts": {
-    "prepare": "rm -rf dist && tsc -p ./jsconfig.prod.json",
-    "start": "node --env-file=.env index.mjs",
-    "test": "node --test"
-  },
-  "keywords": [
-    "mongodb",
-    "orm"
-  ],
-  "files": [
-    "index.mjs",
-    "src/",
-    "dist",
-    "!src/**/*.test.mjs",
-    "jsconfig.json",
-    "jsconfig.prod.json"
-  ],
-  "author": "Vinícius Gabriel",
-  "license": "ISC",
-  "dependencies": {
-    "mongodb": "^7.0.0"
-  },
-  "devDependencies": {
-    "@faker-js/faker": "^8.4.1",
-    "@types/node": "^20.12.7",
-    "mongodb-memory-server": "^10.0.0",
-    "typescript": "^5.4.5"
-  }
-}
+{
+  "name": "assai",
+  "version": "2.1.1",
+  "repository": {
+    "url": "https://github.com/TimeLord2010/assai",
+    "type": "git"
+  },
+  "description": "A simple mongodb wrapper to make mongo even easier to work with.",
+  "main": "index.mjs",
+  "types": "dist/index.d.mts",
+  "scripts": {
+    "prepare": "rm -rf dist && tsc -p ./jsconfig.prod.json",
+    "start": "node --env-file=.env index.mjs",
+    "test": "node --test",
+    "check": "tsc -p jsconfig.json"
+  },
+  "keywords": [
+    "mongodb",
+    "orm"
+  ],
+  "files": [
+    "index.mjs",
+    "src/",
+    "dist",
+    "!src/**/*.test.mjs",
+    "jsconfig.json",
+    "jsconfig.prod.json"
+  ],
+  "author": "Vinícius Gabriel",
+  "license": "ISC",
+  "peerDependencies": {
+    "mongodb": ">=4.0.0"
+  },
+  "devDependencies": {
+    "@faker-js/faker": "^8.4.1",
+    "@types/node": "^20.12.7",
+    "mongodb-memory-server": "^10.0.0",
+    "typescript": "^5.4.5"
+  }
+}

package/src/__test/manage_mock_database.mjs

@@ -1,25 +1,25 @@
-import { MongoMemoryServer } from 'mongodb-memory-server'
-import { after, before } from 'node:test'
-import { closeClient } from '../usecases/mongo/mongo_client.mjs'
-
-/**
- * Starts a memory version of the mongodb server on a random free port.
- *
- * This method will also automatically close the connection with the database.
- */
-export function manageMockDatabase() {
-    /** @type {null | MongoMemoryServer} */
-    let server = null
-
-    before(async () => {
-        server = await MongoMemoryServer.create()
-        const uri = server.getUri('test')
-        process.env.DATABASE_URL = uri
-    })
-
-    after(async () => {
-        await closeClient()
-        await server?.stop()
-        process.exit()
-    })
+import { MongoMemoryServer } from 'mongodb-memory-server'
+import { after, before } from 'node:test'
+import { closeClient } from '../usecases/mongo/mongo_client.mjs'
+
+/**
+ * Starts a memory version of the mongodb server on a random free port.
+ *
+ * This method will also automatically close the connection with the database.
+ */
+export function manageMockDatabase() {
+    /** @type {null | MongoMemoryServer} */
+    let server = null
+
+    before(async () => {
+        server = await MongoMemoryServer.create()
+        const uri = server.getUri('test')
+        process.env.DATABASE_URL = uri
+    })
+
+    after(async () => {
+        await closeClient()
+        await server?.stop()
+        process.exit()
+    })
 }

package/src/__test/manage_mock_registry.mjs

@@ -1,55 +1,55 @@
-import { fakerPT_BR } from '@faker-js/faker'
-import { ObjectId } from 'mongodb'
-import { after, before } from 'node:test'
-import { generateNewId } from '../usecases/mongo/generate_new_id.mjs'
-import { closeClient } from '../usecases/mongo/mongo_client.mjs'
-import { deleteOne } from '../usecases/mongo/operation/delete_one.mjs'
-import { insertOne } from '../usecases/mongo/operation/insert_one.mjs'
-import { mockGetCollection } from './mock_get_collection.mjs'
-
-/**
- *
- * @param {import('./mock_get_collection.mjs').ItestCollection} param
- * @param {object} options
- * @param {boolean} [options.deleteAtEnd]
- */
-export function manageMockRegistry({ tag, ...rest } = {}, {
-    deleteAtEnd = true
-} = {}) {
-
-    const id = generateNewId()
-    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: doc,
-        })
-    })
-
-    after(async () => {
-        if (deleteAtEnd) {
-            await deleteOne({
-                query: {
-                    _id: ObjectId.createFromHexString(id)
-                },
-                // @ts-ignore
-                getCollection: mockGetCollection,
-            })
-        }
-        await closeClient()
-    })
-
-    return {
-        id, name
-    }
+import { fakerPT_BR } from '@faker-js/faker'
+import { ObjectId } from 'mongodb'
+import { after, before } from 'node:test'
+import { generateNewId } from '../usecases/mongo/generate_new_id.mjs'
+import { closeClient } from '../usecases/mongo/mongo_client.mjs'
+import { deleteOne } from '../usecases/mongo/operation/delete_one.mjs'
+import { insertOne } from '../usecases/mongo/operation/insert_one.mjs'
+import { mockGetCollection } from './mock_get_collection.mjs'
+
+/**
+ *
+ * @param {import('./mock_get_collection.mjs').ItestCollection} param
+ * @param {object} options
+ * @param {boolean} [options.deleteAtEnd]
+ */
+export function manageMockRegistry({ tag, ...rest } = {}, {
+    deleteAtEnd = true
+} = {}) {
+
+    const id = generateNewId()
+    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: doc,
+        })
+    })
+
+    after(async () => {
+        if (deleteAtEnd) {
+            await deleteOne({
+                query: {
+                    _id: ObjectId.createFromHexString(id)
+                },
+                // @ts-ignore
+                getCollection: mockGetCollection,
+            })
+        }
+        await closeClient()
+    })
+
+    return {
+        id, name
+    }
 }

package/src/__test/mock_get_collection.mjs

@@ -1,21 +1,23 @@
-import { Collection, ObjectId } from 'mongodb'
-import { getClient } from '../usecases/mongo/mongo_client.mjs'
-
-export async function mockGetCollection(collectionName = 'test') {
-    const client = await getClient()
-    const db = client.db()
-    /** @type {Collection<ItestCollection>} */
-    const collection = db.collection(collectionName)
-    return collection
-}
-
-/**
- * @typedef {object} ItestCollection
- * @property {ObjectId} [_id]
- * @property {string} [id]
- * @property {string} [name]
- * @property {string | ObjectId} [tag]
- * @property {Date} [createdAt]
- * @property {object[]} [posts]
- * @property {object} [address]
+import { Collection, ObjectId } from 'mongodb'
+import { getClient } from '../usecases/mongo/mongo_client.mjs'
+
+export async function mockGetCollection(collectionName = 'test') {
+    const client = await getClient()
+    const db = client.db()
+    /** @type {Collection<ItestCollection>} */
+    const collection = db.collection(collectionName)
+    return collection
+}
+
+/**
+ * @typedef {object} ItestCollection
+ * @property {ObjectId} [_id]
+ * @property {string} [id]
+ * @property {string} [name]
+ * @property {string | ObjectId} [tag]
+ * @property {Date} [createdAt]
+ * @property {object[]} [posts]
+ * @property {number} [score]
+ * @property {string} [group]
+ * @property {object} [address]
  */

package/src/data/errors/operation_fail.mjs

@@ -1,10 +1,10 @@
-export class OperationFail extends Error {
-
-    /**
-     *
-     * @param {string} msg
-     */
-    constructor(msg) {
-        super(msg)
-    }
+export class OperationFail extends Error {
+
+    /**
+     *
+     * @param {string} msg
+     */
+    constructor(msg) {
+        super(msg)
+    }
 }

package/src/data/errors/unsupported_error.mjs

@@ -1,10 +1,10 @@
-export class NotImplemented extends Error {
-
-    /**
-     *
-     * @param {string} msg
-     */
-    constructor(msg) {
-        super(msg)
-    }
+export class NotImplemented extends Error {
+
+    /**
+     *
+     * @param {string} msg
+     */
+    constructor(msg) {
+        super(msg)
+    }
 }

package/src/data/interfaces/mongo_operator.mjs

@@ -1,3 +1,3 @@
-/**
- * @typedef {'$eq' | '$lt' | '$lte'} ImongoOperator
+/**
+ * @typedef {'$eq' | '$lt' | '$lte'} ImongoOperator
  */

package/src/data/interfaces/native_collection.mjs

@@ -1,28 +1,28 @@
-/**
- * @template {import('mongodb').Document} T
- * @typedef {object} InativeCollection
- * @property {InativeInsertOne<T>} insertOne
- * @property {InativeDeleteOne<T>} deleteOne
- * @property {InativeUpdateOne<T>} updateOne
- */
-
-/**
- * @template {import('mongodb').Document} T
- * @callback InativeInsertOne
- * @param {import('../../types.js').Optional<T, '_id'>} data
- * @returns {Promise<any>}
- */
-
-/**
- * @template {import('mongodb').Document} T
- * @callback InativeDeleteOne
- * @param {import('mongodb').Filter<T>} filter
- * @returns {Promise<any>}
- */
-
-/**
- * @template {import('mongodb').Document} T
- * @callback InativeUpdateOne
- * @param {import('mongodb').Filter<T>} filter
- * @param {import('mongodb').UpdateFilter<T>} update
+/**
+ * @template {import('mongodb').Document} T
+ * @typedef {object} InativeCollection
+ * @property {InativeInsertOne<T>} insertOne
+ * @property {InativeDeleteOne<T>} deleteOne
+ * @property {InativeUpdateOne<T>} updateOne
+ */
+
+/**
+ * @template {import('mongodb').Document} T
+ * @callback InativeInsertOne
+ * @param {import('../../types.js').Optional<T, '_id'>} data
+ * @returns {Promise<any>}
+ */
+
+/**
+ * @template {import('mongodb').Document} T
+ * @callback InativeDeleteOne
+ * @param {import('mongodb').Filter<T>} filter
+ * @returns {Promise<any>}
+ */
+
+/**
+ * @template {import('mongodb').Document} T
+ * @callback InativeUpdateOne
+ * @param {import('mongodb').Filter<T>} filter
+ * @param {import('mongodb').UpdateFilter<T>} update
  */