New Version 1.6.0

Author: mzralt

README.md

@@ -17,12 +17,8 @@
 </p>
 </div>
 
-## New version 1.5.0!
-- **findAndUpdate** function added!
-- **findAndDelete** function added!
-- **findOneAndUpdate** function added!
-- **findOneAndDelete** function added!
-- Added language support for bugs in find functions.
+## New version 1.6.0!
+- **findOne** function added!
 
 ## About
 - **Designed for Beginners:** The mzrdb module simplifies working with databases for new programmers. It provides an intuitive key-value interface, making data storage and retrieval a breeze.
@@ -103,9 +99,10 @@ await db.delByPriority('key', 1) // [ { mzr2: "value2" } ]
 await db.setByPriority('key', { new2: 'This Edited!' }, 1) // [ { new2: "This Edited!" } ]
 
 await db.find('key', { mzr: 'value' }) // [ { mzr: "value" } ]
+await db.findOne('key', { mzr: 'value' }) // { mzr: "value" }
 
 await db.findAndUpdate('key', { mzr: 'value' }, { mzr: 'value2' }) // [ { old: { mzr: "value" }, new: { mzr: "value2" } } ]
-await db.findAndDelete('key', { mzr: 'value' }) // [ { mzr: 'value' } ]
+await db.findAndDelete('key', { mzr: 'value' }) // [ { mzr: "value" } ]
 
 await db.findOneAndUpdate('key', { mzr: 'value' }) // { old: { mzr: "value" }, new: { mzr: "value2" } }
 await db.findOneAndDelete('key', { mzr: 'value' }) // { mzr: "value" }
@@ -136,7 +133,7 @@ await db.length() // 20 (Character count)
 
 db.ping // { read: "1ms", write: "2ms", average: "1.5ms" }
 db.size // 11 Bytes (Database size)
-db.version // 1.5.0 (Module version)
+db.version // 1.6.0 (Module version)
 ```
 
 ## All Local Adapter Methods
@@ -181,9 +178,10 @@ db.delByPriority('key', 1) // [ { mzr2: "value2" } ]
 db.setByPriority('key', { new2: 'This Edited!' }, 1) // [ { new2: "This Edited!" } ]
 
 db.find('key', { mzr: 'value' }) // [ { mzr: "value" } ]
+db.findOne('key', { mzr: 'value' }) // { mzr: "value" }
 
 db.findAndUpdate('key', { mzr: 'value' }, { mzr: 'value2' }) // [ { old: { mzr: "value" }, new: { mzr: "value2" } } ]
-db.findAndDelete('key', { mzr: 'value' }) // [ { mzr: 'value' } ]
+db.findAndDelete('key', { mzr: 'value' }) // [ { mzr: "value" } ]
 
 db.findOneAndUpdate('key', { mzr: 'value' }) // { old: { mzr: "value" }, new: { mzr: "value2" } }
 db.findOneAndDelete('key', { mzr: 'value' }) // { mzr: "value" }
@@ -211,7 +209,7 @@ db.length() // 20 (Character count)
 
 db.ping // { read: "1ms", write: "2ms", average: "1.5ms" }
 db.size // 11 Bytes (Database size)
-db.version // 1.5.0 (Module version)
+db.version // 1.6.0 (Module version)
 ```
 
 ## Contact & Support

adapters/bsondb.js

@@ -528,6 +528,21 @@ class BsonDB {
             throw new Error(this.message['errors']['noDocMatchedQuery']);
         };
     }
+
+    findOne(key, query) {
+        if (typeof key !== 'string' || key.trim() === '') {
+            throw new TypeError(this.message['errors']['nonEmptyString']);
+        };
+
+        if (typeof query !== 'object' || query === null) {
+            throw new TypeError(this.message['errors']['queryMustObjects']);
+        };
+
+        const data = this.get(key) || [];
+        if (!Array.isArray(data)) throw new Error(this.message['errors']['dataMustArray']);
+
+        return data.find(doc => Object.keys(query).every(queryKey => queryKey in doc && doc[queryKey] === query[queryKey])) || null;
+    }
 }
 
 module.exports = BsonDB;

adapters/jsondb.js

@@ -555,6 +555,21 @@ class JsonDB {
       throw new Error(this.message['errors']['noDocMatchedQuery']);
     };
   }
+
+  findOne(key, query) {
+    if (typeof key !== 'string' || key.trim() === '') {
+      throw new TypeError(this.message['errors']['nonEmptyString']);
+    };
+
+    if (typeof query !== 'object' || query === null) {
+      throw new TypeError(this.message['errors']['queryMustObjects']);
+    };
+
+    const data = this.get(key) || [];
+    if (!Array.isArray(data)) throw new Error(this.message['errors']['dataMustArray']);
+
+    return data.find(doc => Object.keys(query).every(queryKey => queryKey in doc && doc[queryKey] === query[queryKey])) || null;
+  }
 }
 
 module.exports = JsonDB;

adapters/mongodb/index.js

@@ -515,6 +515,21 @@ class MongoDB extends Base {
             throw new Error(this.message['errors']['noDocMatchedQuery']);
         };
     }
+
+    async findOne(key, query) {
+        if (typeof key !== 'string' || key.trim() === '') {
+            throw new TypeError(this.message['errors']['nonEmptyString']);
+        };
+
+        if (typeof query !== 'object' || query === null) {
+            throw new TypeError(this.message['errors']['queryMustObjects']);
+        };
+
+        const data = await this.get(key) || [];
+        if (!Array.isArray(data)) throw new Error(this.message['errors']['dataMustArray']);
+
+        return data.find(doc => Object.keys(query).every(queryKey => queryKey in doc && doc[queryKey] === query[queryKey])) || null;
+    }
 }
 
 async function convertData(data) {

adapters/yamldb.js

@@ -563,6 +563,21 @@ class YamlDB {
       throw new Error(this.message['errors']['noDocMatchedQuery']);
     };
   }
+
+  findOne(key, query) {
+    if (typeof key !== 'string' || key.trim() === '') {
+      throw new TypeError(this.message['errors']['nonEmptyString']);
+    };
+
+    if (typeof query !== 'object' || query === null) {
+      throw new TypeError(this.message['errors']['queryMustObjects']);
+    };
+
+    const data = this.get(key) || [];
+    if (!Array.isArray(data)) throw new Error(this.message['errors']['dataMustArray']);
+
+    return data.find(doc => Object.keys(query).every(queryKey => queryKey in doc && doc[queryKey] === query[queryKey])) || null;
+  }
 }
 
 module.exports = YamlDB;

file/index.js

@@ -473,5 +473,11 @@ module.exports = {
     this.setOptions();
 
     return this.adapter.findOneAndDelete(key, query);
-  }
+  },
+
+  findOne(key, query) {
+    this.setOptions();
+
+    return this.adapter.findOne(key, query);
+  },
 }

package.json

@@ -37,5 +37,5 @@
     "type": "git",
     "url": "git+https://github.com/mzrcode/mzrdb.git"
   },
-  "version": "1.5.0"
+  "version": "1.6.0"
 }

test.js

@@ -1,21 +1,14 @@
 // const db = require('./file/index');
 // db.setAdapter('bsondb');
 
-/*
-db.push('test', { name: 'kaan', age: 20 });
-db.push('test', { name: 'emre', age: 19 });
-db.push('test', { name: 'emirhan', age: 18 });
-db.push('test', { name: 'burak', age: 17 });
-// */
-
 /*
 db.setAdapter('mongodb', {
     url: 'SECRET :)'
 });
 
 (async () => {
     // const a = await db.findAndUpdate('test', { name: 'kaan' }, { age: 21 });
-    // const a = await db.findAndDelete('test', { name: 'burak' });
+    // const a = await db.findAndDelete('test', { name: 'emre' });
 
     // const a = await db.findOneAndUpdate('test', { name: 'kaan' }, { age: 20 });
     // const a = await db.findOneAndDelete('test', { name: 'emirhan' });
@@ -25,7 +18,7 @@ db.setAdapter('mongodb', {
 })(); // */
 
 // const a = db.findAndUpdate('test', { name: 'kaan' }, { age: 21 });
-// const a = db.findAndDelete('test', { name: 'burak' });
+// const a = db.findAndDelete('test', { name: 'emre' });
 
 // const a = db.findOneAndUpdate('test', { name: 'kaan' }, { age: 21 });
 // const a = db.findOneAndDelete('test', { name: 'emirhan' });

typings/index.d.ts

@@ -440,5 +440,17 @@ export function findOneAndUpdate(key: string, query: object, update: object): {
 */
 export function findOneAndDelete(key: string, query: object): object;
 
+/**
+ * Finds the first document that matches the query from the specified key.
+ * @param {string} key - The key for the collection.
+ * @param {Object} query - The query object to match documents.
+ * @returns {Object | null} The first document that matches the query, or null if no document matches.
+ * @throws {TypeError} If the key is not a non-empty string or if the query is not an object.
+ * @throws {Error} If the data retrieved from the key is not an array.
+ * @example db.findOne('users', { name: 'Kaan' });
+*/
+export function findOne(key: string, query: Record<string, any>): Record<string, any> | null;
+
+
 export { del as delete };
 export { exports as export };