inibase 1.0.0-rc.0 → 1.0.0-rc.4

package/README.md

@@ -1,6 +1,6 @@
-![Inibase banner](./.github/assets/banner.jpg)
+[![Inibase banner](./.github/assets/banner.jpg)](https://github.com/inicontent/inibase)
 
-# Inibase
+# Inibase :pencil:
 
 [![npmjs](https://img.shields.io/npm/dm/inibase.svg?style=flat)](https://www.npmjs.org/package/inibase) [![Node.js Version](https://img.shields.io/badge/node-18.11.0-blue)](https://nodejs.org/) [![License](https://img.shields.io/github/license/inicontent/inibase.svg?style=flat&colorA=18181B&colorB=28CF8D)](./LICENSE) [![Activity](https://img.shields.io/github/commit-activity/m/inicontent/inibase)](https://github.com/inicontent/inibase/pulse) [![GitHub stars](https://img.shields.io/github/stars/inicontent/inibase?style=social)](https://github.com/inicontent/inibase)
 
@@ -8,12 +8,13 @@
 
 ## Features
 
-- **Lightweight** 🪶 (~50kb)
+- **Lightweight** 🪶 (~60kb)
 - **Minimalist** :white_circle:
 - **TypeScript** :large_blue_diamond:
 - **Super-Fast** :turtle:
 - **Suitable for large data** :page_with_curl:
 - **Safe** :lock:
+- **Easy to use** :hourglass:
 - **...** and much more :rocket:
 
 ## Usage
@@ -54,14 +55,16 @@ npm install inibase
 
 // pnpm
 pnpm add inibase
-
-// yarn
-yarn add inibase
 ```
 
+## How it works?
+
+To semplify the idea, each database has tables, each table has columns, each column will be stored in a seperated file. When POSTing new data, it will be appended to each columns file as new line. When GETing data, the file will be readed line-by-line so it can handle large data (without consuming a lot of resources)
+
 ## Examples
 
-#### POST
+<details>
+<summary>POST</summary>
 
 ```js
 import Inibase from "inibase";
@@ -268,7 +271,10 @@ const product = await db.post("product", product_data);
 // ]
 ```
 
-#### GET
+</details>
+
+<details>
+<summary>GET</summary>
 
 ```js
 import Inibase from "inibase";
@@ -338,7 +344,10 @@ const users = await db.get("user", { favoriteFoods: "[]Pizza" });
 // ]
 ```
 
-#### PUT
+</details>
+
+<details>
+<summary>PUT</summary>
 
 ```js
 import Inibase from "inibase";
@@ -354,7 +363,10 @@ await db.put("user", { isActive: false }, "1d88385d4b1581f8fb059334dec30f4c");
 await db.put("user", { isActive: false }, { isActive: true });
 ```
 
-#### DELETE
+</details>
+
+<details>
+<summary>DELETE</summary>
 
 ```js
 import Inibase from "inibase";
@@ -370,46 +382,62 @@ await db.put("user", "1d88385d4b1581f8fb059334dec30f4c");
 await db.put("user", { isActive: false });
 ```
 
+</details>
+
 ## Typescript
 
-#### Schema
+<details>
+<summary>Schema</summary>
 
 ```js
-type FieldType =
-  | "string"
-  | "number"
-  | "boolean"
-  | "date"
-  | "email"
-  | "url"
-  | "table"
-  | "object"
-  | "array";
-type Field =
+type Schema = Field[];
+type Field = {
+  id?: string | number | null | undefined,
+  key: string,
+  required?: boolean,
+} & (
   | {
-      id?: string | number | null | undefined,
-      key: string,
       type: Exclude<FieldType, "array" | "object">,
       required?: boolean,
     }
   | {
-      id?: string | number | null | undefined,
-      key: string,
       type: "array",
-      required?: boolean,
       children: FieldType | FieldType[] | Schema,
     }
   | {
-      id?: string | number | null | undefined,
-      key: string,
       type: "object",
-      required?: boolean,
       children: Schema,
-    };
+    }
+);
+type FieldType =
+  | "string"
+  | "number"
+  | "boolean"
+  | "date"
+  | "email"
+  | "url"
+  | "table"
+  | "object"
+  | "array"
+  | "password";
+```
 
-type Schema = Field[];
+</details>
+
+<details>
+<summary>Data</summary>
+
+```js
+type Data = {
+  id?: number | string,
+  [key: string]: any,
+  created_at?: Date,
+  updated_at?: Date,
+};
 ```
 
+</details>
+
 ## Roadmap
 
 - [x] Actions:
@@ -431,9 +459,12 @@ type Schema = Field[];
   - [x] Table
   - [x] Object
   - [x] Array
-  - [ ] Password
+  - [x] Password
   - [ ] IP
-- [ ] Suggest [new feature +](https://github.com/inicontent/inibase/discussions/new?category=ideas)
+- [ ] Features:
+  - [ ] Encryption
+  - [ ] Compress data
+  - [ ] Suggest [new feature +](https://github.com/inicontent/inibase/discussions/new?category=ideas)
 
 ## License
 

package/file.ts

@@ -183,11 +183,17 @@ export const search = async (
     // check if not array or object
     switch (operator) {
       case "=":
-        return fieldType === "password" &&
-          typeof value === "string" &&
-          typeof comparedAtValue === "string"
-          ? Utils.comparePassword(value, comparedAtValue)
-          : value === comparedAtValue;
+        switch (fieldType) {
+          case "password":
+            return typeof value === "string" &&
+              typeof comparedAtValue === "string"
+              ? Utils.comparePassword(value, comparedAtValue)
+              : false;
+          case "boolean":
+            return Number(value) - Number(comparedAtValue) === 0;
+          default:
+            return value === comparedAtValue;
+        }
       case "!=":
         return !handleComparisonOperator(
           "=",
@@ -268,8 +274,7 @@ export const search = async (
     lineCount++;
     const decodedLine = Utils.decode(line, fieldType);
     if (
-      decodedLine &&
-      ((Array.isArray(operator) &&
+      (Array.isArray(operator) &&
         Array.isArray(comparedAtValue) &&
         ((logicalOperator &&
           logicalOperator === "or" &&
@@ -289,13 +294,13 @@ export const search = async (
               fieldType
             )
           ))) ||
-        (!Array.isArray(operator) &&
-          handleComparisonOperator(
-            operator,
-            decodedLine,
-            comparedAtValue,
-            fieldType
-          )))
+      (!Array.isArray(operator) &&
+        handleComparisonOperator(
+          operator,
+          decodedLine,
+          comparedAtValue,
+          fieldType
+        ))
     ) {
       foundItems++;
       if (offset && foundItems < offset) continue;

package/index.ts

@@ -18,7 +18,6 @@ export { File, Utils };
 export type Data = {
   id?: number | string;
   [key: string]: any;
-  [id: number]: any;
   created_at?: Date;
   updated_at?: Date;
 };
@@ -32,29 +31,26 @@ export type FieldType =
   | "url"
   | "table"
   | "object"
-  | "password"
-  | "array";
-type Field =
+  | "array"
+  | "password";
+type Field = {
+  id?: string | number | null | undefined;
+  key: string;
+  required?: boolean;
+} & (
   | {
-      id?: string | number | null | undefined;
-      key: string;
       type: Exclude<FieldType, "array" | "object">;
       required?: boolean;
     }
   | {
-      id?: string | number | null | undefined;
-      key: string;
       type: "array";
-      required?: boolean;
       children: FieldType | FieldType[] | Schema;
     }
   | {
-      id?: string | number | null | undefined;
-      key: string;
       type: "object";
-      required?: boolean;
       children: Schema;
-    };
+    }
+);
 
 export type Schema = Field[];
 
@@ -83,13 +79,23 @@ type pageInfo = {
 
 export type Criteria =
   | {
-      [logic in "and" | "or"]?: Criteria;
+      [logic in "and" | "or"]?: Criteria | (string | number | boolean | null)[];
     }
   | {
       [key: string]: string | number | boolean | Criteria;
     }
   | null;
 
+declare global {
+  type Entries<T> = {
+    [K in keyof T]: [K, T[K]];
+  }[keyof T][];
+
+  interface ObjectConstructor {
+    entries<T extends object>(o: T): Entries<T>;
+  }
+}
+
 export default class Inibase {
   public database: string;
   public databasePath: string;
@@ -567,7 +573,7 @@ export default class Inibase {
           (data as Data[]).map((single_data) => CombineData(single_data))
         );
       else {
-        for (const [key, value] of Object.entries(data)) {
+        for (const [key, value] of Object.entries(data as Data)) {
           if (Utils.isObject(value))
             Object.assign(RETURN, CombineData(value, `${key}.`));
           else if (Array.isArray(value)) {
@@ -667,8 +673,8 @@ export default class Inibase {
       schema: Schema,
       linesNumber: number[],
       prefix?: string
-    ): Promise<Data> => {
-      let RETURN: Data = {};
+    ) => {
+      let RETURN: Record<number, Data> = {};
       for (const field of schema) {
         if (
           (field.type === "array" || field.type === "object") &&
@@ -706,7 +712,12 @@ export default class Inibase {
               )) ?? {}
             ).forEach(([index, item]) => {
               if (!RETURN[index]) RETURN[index] = {};
-              RETURN[index][field.key] = item;
+              RETURN[index][field.key] =
+                field.type === "array" &&
+                Utils.isObject(item) &&
+                Object.values(item).every((i) => i === null)
+                  ? []
+                  : item;
             });
           }
         } else if (field.type === "table") {
@@ -808,7 +819,7 @@ export default class Inibase {
         )) ?? {}
       );
       if (RETURN.length && !Array.isArray(where)) RETURN = RETURN[0];
-    } else if (typeof where === "object" && !Array.isArray(where)) {
+    } else if (Utils.isObject(where)) {
       // Criteria
       const FormatObjectCriteriaValue = (
         value: string
@@ -855,11 +866,14 @@ export default class Inibase {
       const applyCriteria = async (
         criteria?: Criteria,
         allTrue?: boolean
-      ): Promise<Data | null> => {
-        let RETURN: Data = {};
+      ): Promise<Record<number, Data> | null> => {
+        let RETURN: Record<number, Data> = {};
         if (!criteria) return null;
-        if (criteria.and && typeof criteria.and === "object") {
-          const searchResult = await applyCriteria(criteria.and, true);
+        if (criteria.and && Utils.isObject(criteria.and)) {
+          const searchResult = await applyCriteria(
+            criteria.and as Criteria,
+            true
+          );
           if (searchResult) {
             RETURN = Utils.deepMerge(
               RETURN,
@@ -875,108 +889,112 @@ export default class Inibase {
           } else return null;
         }
 
-        if (criteria.or && typeof criteria.or === "object") {
-          const searchResult = await applyCriteria(criteria.or);
+        if (criteria.or && Utils.isObject(criteria.or)) {
+          const searchResult = await applyCriteria(criteria.or as Criteria);
           delete criteria.or;
           if (searchResult) RETURN = Utils.deepMerge(RETURN, searchResult);
         }
 
-        let index = -1;
-        for (const [key, value] of Object.entries(criteria)) {
-          index++;
-          if (
-            allTrue &&
-            index > 0 &&
-            (!Object.keys(RETURN).length ||
-              Object.values(RETURN).every(
-                (item) => Object.keys(item).length >= index
-              ))
-          )
-            break;
-          let searchOperator:
-              | ComparisonOperator
-              | ComparisonOperator[]
-              | undefined = undefined,
-            searchComparedAtValue:
-              | string
-              | number
-              | boolean
-              | null
-              | (string | number | boolean | null)[]
-              | undefined = undefined,
-            searchLogicalOperator: "and" | "or" | undefined = undefined;
-          if (typeof value === "object") {
-            if (value?.or && Array.isArray(value.or)) {
-              const searchCriteria = value.or
-                .map(
-                  (
-                    single_or
-                  ): [ComparisonOperator, string | number | boolean | null] =>
-                    typeof single_or === "string"
-                      ? FormatObjectCriteriaValue(single_or)
-                      : ["=", single_or]
+        if (Object.keys(criteria).length > 0) {
+          allTrue = true;
+          let index = -1;
+          for (const [key, value] of Object.entries(criteria)) {
+            index++;
+            let searchOperator:
+                | ComparisonOperator
+                | ComparisonOperator[]
+                | undefined = undefined,
+              searchComparedAtValue:
+                | string
+                | number
+                | boolean
+                | null
+                | (string | number | boolean | null)[]
+                | undefined = undefined,
+              searchLogicalOperator: "and" | "or" | undefined = undefined;
+            if (Utils.isObject(value)) {
+              if (
+                (value as Criteria)?.or &&
+                Array.isArray((value as Criteria).or)
+              ) {
+                const searchCriteria = (
+                  (value as Criteria).or as (string | number | boolean)[]
                 )
-                .filter((a) => a) as [ComparisonOperator, string | number][];
-              if (searchCriteria.length > 0) {
-                searchOperator = searchCriteria.map(
-                  (single_or) => single_or[0]
-                );
-                searchComparedAtValue = searchCriteria.map(
-                  (single_or) => single_or[1]
-                );
-                searchLogicalOperator = "or";
+                  .map(
+                    (
+                      single_or
+                    ): [ComparisonOperator, string | number | boolean | null] =>
+                      typeof single_or === "string"
+                        ? FormatObjectCriteriaValue(single_or)
+                        : ["=", single_or]
+                  )
+                  .filter((a) => a) as [ComparisonOperator, string | number][];
+                if (searchCriteria.length > 0) {
+                  searchOperator = searchCriteria.map(
+                    (single_or) => single_or[0]
+                  );
+                  searchComparedAtValue = searchCriteria.map(
+                    (single_or) => single_or[1]
+                  );
+                  searchLogicalOperator = "or";
+                }
+                delete (value as Criteria).or;
               }
-              delete value.or;
-            }
-            if (value?.and && Array.isArray(value.and)) {
-              const searchCriteria = value.and
+              if (
+                (value as Criteria)?.and &&
+                Array.isArray((value as Criteria).and)
+              ) {
+                const searchCriteria = (
+                  (value as Criteria).and as (string | number | boolean)[]
+                )
+                  .map(
+                    (
+                      single_and
+                    ): [ComparisonOperator, string | number | boolean | null] =>
+                      typeof single_and === "string"
+                        ? FormatObjectCriteriaValue(single_and)
+                        : ["=", single_and]
+                  )
+                  .filter((a) => a) as [ComparisonOperator, string | number][];
+                if (searchCriteria.length > 0) {
+                  searchOperator = searchCriteria.map(
+                    (single_and) => single_and[0]
+                  );
+                  searchComparedAtValue = searchCriteria.map(
+                    (single_and) => single_and[1]
+                  );
+                  searchLogicalOperator = "and";
+                }
+                delete (value as Criteria).and;
+              }
+            } else if (Array.isArray(value)) {
+              const searchCriteria = value
                 .map(
                   (
-                    single_and
+                    single
                   ): [ComparisonOperator, string | number | boolean | null] =>
-                    typeof single_and === "string"
-                      ? FormatObjectCriteriaValue(single_and)
-                      : ["=", single_and]
+                    typeof single === "string"
+                      ? FormatObjectCriteriaValue(single)
+                      : ["=", single]
                 )
                 .filter((a) => a) as [ComparisonOperator, string | number][];
               if (searchCriteria.length > 0) {
-                searchOperator = searchCriteria.map(
-                  (single_and) => single_and[0]
-                );
+                searchOperator = searchCriteria.map((single) => single[0]);
                 searchComparedAtValue = searchCriteria.map(
-                  (single_and) => single_and[1]
+                  (single) => single[1]
                 );
                 searchLogicalOperator = "and";
               }
-              delete value.and;
-            }
-          } else if (Array.isArray(value)) {
-            const searchCriteria = value
-              .map(
-                (
-                  single
-                ): [ComparisonOperator, string | number | boolean | null] =>
-                  typeof single === "string"
-                    ? FormatObjectCriteriaValue(single)
-                    : ["=", single]
-              )
-              .filter((a) => a) as [ComparisonOperator, string | number][];
-            if (searchCriteria.length > 0) {
-              searchOperator = searchCriteria.map((single) => single[0]);
-              searchComparedAtValue = searchCriteria.map((single) => single[1]);
-              searchLogicalOperator = "and";
-            }
-          } else if (typeof value === "string") {
-            const ComparisonOperatorValue = FormatObjectCriteriaValue(value);
-            if (ComparisonOperatorValue) {
-              searchOperator = ComparisonOperatorValue[0];
-              searchComparedAtValue = ComparisonOperatorValue[1];
+            } else if (typeof value === "string") {
+              const ComparisonOperatorValue = FormatObjectCriteriaValue(value);
+              if (ComparisonOperatorValue) {
+                searchOperator = ComparisonOperatorValue[0];
+                searchComparedAtValue = ComparisonOperatorValue[1];
+              }
+            } else {
+              searchOperator = "=";
+              searchComparedAtValue = value as number | boolean;
             }
-          } else {
-            searchOperator = "=";
-            searchComparedAtValue = value;
-          }
-          if (searchOperator && searchComparedAtValue) {
             const [searchResult, totlaItems] = await File.search(
               join(
                 this.databasePath,
@@ -996,12 +1014,20 @@ export default class Inibase {
               if (!this.pageInfoArray[key]) this.pageInfoArray[key] = {};
               this.pageInfoArray[key].total_items = totlaItems;
             }
+            if (allTrue && index > 0) {
+              if (!Object.keys(RETURN).length) RETURN = {};
+              RETURN = Object.fromEntries(
+                Object.entries(RETURN).filter(
+                  ([_index, item]) => Object.keys(item).length > index
+                )
+              );
+              if (!Object.keys(RETURN).length) RETURN = {};
+            }
           }
         }
-        return Object.keys(RETURN).length > 0 ? RETURN : null;
+        return Object.keys(RETURN).length ? RETURN : null;
       };
-
-      RETURN = await applyCriteria(where);
+      RETURN = await applyCriteria(where as Criteria);
       if (RETURN) {
         if (onlyLinesNumbers) return Object.keys(RETURN).map(Number);
         const alreadyExistsColumns = Object.keys(Object.values(RETURN)[0]).map(
@@ -1039,22 +1065,30 @@ export default class Inibase {
         );
       }
     }
-    return RETURN
-      ? Utils.isArrayOfObjects(RETURN)
-        ? (RETURN as Data[]).map((data: Data) => {
-            data.id = this.encodeID(data.id as number);
-            return data;
-          })
-        : {
-            ...(RETURN as Data),
-            id: this.encodeID((RETURN as Data).id as number),
-          }
-      : null;
+    if (
+      !RETURN ||
+      (Utils.isObject(RETURN) && !Object.keys(RETURN).length) ||
+      (Array.isArray(RETURN) && !RETURN.length)
+    )
+      return null;
+    return Utils.isArrayOfObjects(RETURN)
+      ? (RETURN as Data[]).map((data: Data) => {
+          data.id = this.encodeID(data.id as number);
+          return data;
+        })
+      : {
+          ...(RETURN as Data),
+          id: this.encodeID((RETURN as Data).id as number),
+        };
   }
 
   public async post(
     tableName: string,
-    data: Data | Data[]
+    data: Data | Data[],
+    options: Options = {
+      page: 1,
+      per_page: 15,
+    }
   ): Promise<Data | Data[] | null> {
     const schema = this.getTableSchema(tableName);
     let RETURN: Data | Data[] | null | undefined;
@@ -1092,12 +1126,14 @@ export default class Inibase {
         (Array.isArray(content) ? content.join("\n") : content ?? "") + "\n",
         "utf8"
       );
-    return Utils.isArrayOfObjects(RETURN)
-      ? RETURN.map((data: Data) => {
-          data.id = this.encodeID(data.id as number);
-          return data;
-        })
-      : { ...RETURN, id: this.encodeID((RETURN as Data).id as number) };
+
+    return this.get(
+      tableName,
+      Utils.isArrayOfObjects(RETURN)
+        ? RETURN.map((data: Data) => data.id)
+        : ((RETURN as Data).id as number),
+      options
+    );
   }
 
   public async put(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "inibase",
-  "version": "1.0.0-rc.0",
+  "version": "1.0.0-rc.4",
   "description": "File-based Relational Database for large data",
   "main": "index.ts",
   "repository": {