feat(core): mend arthmetics ops, thx @pacifiquem

Author: regisrex

README.md

@@ -21,14 +21,14 @@ To get started, first make sure you have the latest stable version of nodejs on
 
 **1. Install json-base dependecy with npm**  
 
-You have to install jsondb with npm, it's not currently available on other package managers like yarn, etc.
+You have to install json-base with npm, it's not currently available on other package managers like yarn, etc.
 ```bash
 $ npm install @ndzhwr/json-base
 ```
 
-**2. Initialize jsondb in your project**  
+**2. Initialize json-base in your project**  
 
-Initialize jsondb in your project. Open the root folder of your project in your terminal and initialize json-base. This will create a `database.json` file in the project.
+Initialize json-base in your project. Open the root folder of your project in your terminal and initialize json-base. This will create a `database.json` file in the project.
 
 ```bash
 $ npx json-base --init
@@ -55,7 +55,7 @@ Let's have a simple tutorial on how we can use this `json-base`. We're going to
 4. Adding data with add() api
 5. Deleting All data with delAll() api
 
-#### 0. Setting up jsondb in a project
+#### 0. Setting up json-base in a project
 Before starting to perform transactions to the database, let's 
 learn a little bit on the usage of the  CLI 
 ```

SECURITY.md

@@ -2,7 +2,7 @@
 
 ## Supported Versions
 
-The latest version of `jsondb` is secure
+The latest version of `json-base` is secure
 | Version | Supported          |
 | ------- | ------------------ |
 | 1.0.x   | :white_check_mark: |

cli/index.ts

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
+import chalk from "chalk"
+import { writeFileSync } from "fs"
 import process from "process"
-import {  writeFileSync } from "fs"
-import  chalk from "chalk"
 import { CreateFileError } from "../errors/errorHandler.js"
 
 
@@ -12,7 +12,7 @@ async function createFile(fileName: string, fileContent: string) {
     try {
         writeFileSync(fileName, fileContent)
         console.log(`Successfully created file ${fileName}`);
-    } catch (error : any) {
+    } catch (error: any) {
         throw new CreateFileError(error.message);
     }
 }
@@ -42,29 +42,28 @@ let exampleData: string = `
 }
 `
 
-const jsondb = `JSONDB`
+const title = `json-base`
 
 const usage = `
-\t Usage of JSONDB cli
-\t npx jsondb  <command>
+\t Usage of json-base cli
+\t npx json-base  <command>
 \t Commands : 
-\t \t --version : Prints the npm version of jsondb
+\t \t --version : Prints the npm version of json-base
 \t \t --init    : Initialize database.json in your project
 \t \t --help    : Show this help message
 `
 
 switch (args[0]) {
     case '--init':
-        console.log(chalk.bold.white.bgBlue(`\t ${ jsondb } \t`))
+        console.log(chalk.bold.white.bgBlue(`\t ${title} \t`))
         console.log("Initializing database.json in your project...")
-            createFile('database.json', exampleData)
-            console.log( chalk.greenBright("💥 Created database.json successfully"))
-            console.log(chalk.yellowBright("Happy coding  :)"))
-            process.exit(1)
-            break;
+        createFile('database.json', exampleData)
+        console.log(chalk.greenBright("💥 Created database.json successfully"))
+        console.log(chalk.yellowBright("Happy coding  :)"))
+        process.exit(1)
     case '--help':
     case undefined:
-    case null :
+    case null:
     default:
         console.log(usage)
         console.log(chalk.yellowBright("\t\tHappy coding  :)"))

index.ts

@@ -1,11 +1,44 @@
+
+import add from './scripts/add.js'
+import del from './scripts/del.js'
+import delAll from './scripts/delAll.js'
+import get from './scripts/get.js'
+import set from './scripts/set.js'
+
+
 /**
- * JSONDB : A simple json dbms with an orm,
- *          for nodejs, compatible with js and ts.
+ * # 📦JSON-BASE 
+ * **a lightweight odm for json file inspired by prisma**
  * 
- * Author : Regis NDIZIHIWE
+ * 
+ * Use json file as your database on the backend, json-base create the database json file for you and also provides you with a lightweight ORM to perform transactions on your database.
+ * @repository https://github.com/regisrex/json-base
+ * @license MIT
+ * @version 0.1.6
+ * @example
+ * ```
+ *  import  { add } from 'json-base'
+ *  (async function(){
+ *      await add({
+        collection : "posts",
+        data : {
+            id  : 1 ,
+            userId : 1 ,
+            photo :  "https://linkto.img",
+            caption : "The quick brown fox"
+        }
+    })
+ * }())
+ * ```
+ * 
+ * @author  Regis NDIZIHIWE <https://regisndizihiwe.me>
  */
-export * from './scripts/get.js'
-export * from './scripts/set.js'
-export * from './scripts/del.js'
-export * from './scripts/add.js'
+export default {
+    add,
+    del,
+    get,
+    set,
+    delAll
+}
+
 // export * from './scripts/delAll.js'

package.json

@@ -1,19 +1,19 @@
 {
   "name": "@ndzhwr/json-base",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "main": "dist/index.js",
-  "description": "A simple json-as-db tool with an orm,  for nodejs, compatible with js and ts.",
+  "description": "a lightweight odm for json file inspired by prisma",
   "files": [
     "/dist"
   ],
   "author": {
     "name": "Regis NDIZIHIWE",
     "email": "[email protected]",
-    "url": "https://github.com/ndzhwr"
+    "url": "https://github.com/regisreex"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/ndzhwr/json-base.git"
+    "url": "git+https://github.com/ndzhwr/json-base.git"
   },
   "engines": {
     "node": ">=8.10.0"

scripts/add.ts

@@ -30,7 +30,7 @@ interface AddDataProps {
  * }())
  * ```
  */
-export async function add(params: AddDataProps) : Promise<any> {
+export default async function add(params: AddDataProps) : Promise<any> {
     try {
         const jsonDB: {} | any = JSON.parse(await getJSONDb())
 

scripts/del.ts

@@ -26,7 +26,7 @@ interface DeleteParams {
  * }())
  * ```
  */
-export async function del(params: DeleteParams): Promise<void> {
+export default async function del(params: DeleteParams): Promise<void> {
     try {
         const where_clause = Object.entries(params.where)
         const jsonDB = JSON.parse(await getJSONDb())

scripts/delAll.ts

@@ -1,7 +1,7 @@
 import { getJSONDb } from "../utils/getJSONDb.js";
 import { setJSONDb } from "../utils/setJSONDb.js";
 
-export async function delAll() {
+export default async function delAll() {
   try {
     const jsonDB = JSON.parse(await getJSONDb());
     jsonDB["db"] = {};

scripts/get.ts

@@ -31,7 +31,7 @@ export interface GetDataProps extends GetDataOptions {
  * }())
  * ```
  */
-export async function get(params: GetDataProps): Promise<any> {
+export default async function get(params: GetDataProps): Promise<any> {
   let data_to_return: any;
   if (!params.collection) {
     throw new MissingParamError("collection");
@@ -41,7 +41,7 @@ export async function get(params: GetDataProps): Promise<any> {
   if (params.where) {
     const where_data = Object.entries(params.where);
     for (let i: number = 0; i < where_data.length; i++) {
-      const [field, filter]:[any, any] = where_data[i];
+      const [field, filter]: [any, any] = where_data[i];
       if (typeof filter === "object") {
         const filterEntries = Object.entries(filter);
         let data: any = data_to_return;

scripts/set.ts

@@ -2,10 +2,10 @@ import { CollectionNotFoundError, DuplicationError, MissingParamError, NotFoundE
 import { getJSONDb } from "../utils/getJSONDb.js";
 import { setJSONDb } from "../utils/setJSONDb.js";
 
-interface  SetDataProps  {
-    collection : string
-    where : any ,
-    data : any
+interface SetDataProps {
+    collection: string
+    where: any,
+    data: any
 }
 /**
  * ### set()
@@ -28,38 +28,37 @@ interface  SetDataProps  {
     })
  * ```
  */
-export async function set(params: SetDataProps) : Promise<void> {
+export default async function set(params: SetDataProps): Promise<void> {
     try {
-        
-        if(!params.collection || !params.where || !params.data ){
+
+        if (!params.collection || !params.where || !params.data) {
             throw new MissingParamError("Some requiered parameters for the set function was not added")
         }
-        
+
         // const collection =  await getCollection(params.collection)
         const where_clause = Object.entries(params.where)
-        const jsonDB :  any  = JSON.parse(await getJSONDb())
+        const jsonDB: any = JSON.parse(await getJSONDb())
         const coll = jsonDB['db'][`${params.collection}`]
-        if(!coll)
+        if (!coll)
             throw new CollectionNotFoundError(`${params.collection}`)
-        const datum  = coll.filter(( collection : any) =>  collection[`${where_clause[0][0]}`] == `${where_clause[0][1]}`)
-        if(!datum){
+        const datum = coll.filter((collection: any) => collection[`${where_clause[0][0]}`] == `${where_clause[0][1]}`)
+        if (!datum) {
             throw new NotFoundError(`Datum with '${where_clause[0][0]}' set to '${where_clause[0][1]}' was not found in '${params.collection}' Collection`)
         }
-        if(datum.length > 1)
-        {
+        if (datum.length > 1) {
             throw new DuplicationError(`Found 2 elements with the same '${where_clause[0][0]}' set to '${where_clause[0][1]}'`)
         }
-        
+
         const data_clause = Object.entries(params.data)
-        
-        const document =  datum[0] ;
-        for(let i : number = 0 ; i <  data_clause.length ; i++){
+
+        const document = datum[0];
+        for (let i: number = 0; i < data_clause.length; i++) {
             document[`${data_clause[i][0]}`] = `${data_clause[i][1]}`
         }
         setJSONDb(JSON.stringify(jsonDB))
-    } catch (err : any) {
+    } catch (err: any) {
         throw new Error(err.message)
     }
 
-    
+
 }