inibase 1.0.0-rc.4 → 1.0.0-rc.6

package/README.md

@@ -2,7 +2,7 @@
 
 # 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)
+[![npmjs](https://img.shields.io/npm/dm/inibase.svg?style=flat)](https://www.npmjs.org/package/inibase) [![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)
 
 > File-based relational database, simple to use and can handle large data :fire:
 
@@ -21,7 +21,7 @@
 
 ```js
 import Inibase from "inibase";
-const db = new Inibase("/database_name");
+const db = new Inibase("database_name");
 
 // Get all items from "user" table
 const users = await db.get("user");
@@ -30,12 +30,12 @@ const users = await db.get("user");
 const users = await db.get("user", undefined, { page: 2, per_page: 15 });
 
 // Get only required columns to improve speed
-const users = await InibaseDB.get("user", undefined, {
+const users = await db.get("user", undefined, {
   columns: ["username", "address.street", "hobbies.*.name"],
 });
 
 // Get items from "user" table where "favoriteFoods" does not includes "Pizza"
-const users = await InibaseDB.get("user", { favoriteFoods: "![]Pizza" });
+const users = await db.get("user", { favoriteFoods: "![]Pizza" });
 ```
 
 If you like Inibase, please sponsor: [GitHub Sponsors](https://github.com/sponsors/inicontent) || [Paypal](https://paypal.me/KarimAmahtil).
@@ -50,11 +50,7 @@ Become a sponsor and have your company logo here 👉 [GitHub Sponsors](https://
 ## Install
 
 ```js
-// npm
-npm install inibase
-
-// pnpm
-pnpm add inibase
+<npm|pnpm> install inibase
 ```
 
 ## How it works?
@@ -342,6 +338,11 @@ const users = await db.get("user", { favoriteFoods: "[]Pizza" });
 //   },
 //   ...
 // ]
+
+// Get all "user" columns except "username" & "address.street"
+const users = await db.get("user", undefined, {
+  columns: ["!username", "!address.street"],
+});
 ```
 
 </details>
@@ -445,7 +446,7 @@ type Data = {
     - [x] Pagination
     - [x] Criteria
     - [x] Columns
-    - [ ] Order
+    - [ ] Order By
   - [x] POST
   - [x] PUT
   - [x] DELETE
@@ -460,7 +461,12 @@ type Data = {
   - [x] Object
   - [x] Array
   - [x] Password
-  - [ ] IP
+  - [x] IP
+  - [x] HTML
+  - [x] Id
+- [ ] TO-DO:
+  - [ ] Improve caching
+  - [ ] Commenting the code
 - [ ] Features:
   - [ ] Encryption
   - [ ] Compress data

package/file.ts

@@ -1,9 +1,23 @@
-import { createWriteStream, unlinkSync, renameSync, existsSync } from "fs";
-import { open } from "fs/promises";
-import { parse } from "path";
+import { createWriteStream, createReadStream, WriteStream } from "node:fs";
+import { open, unlink, rename, stat } from "node:fs/promises";
+import { Interface, createInterface } from "node:readline";
+import { parse } from "node:path";
 import { ComparisonOperator, FieldType } from ".";
 import Utils from "./utils";
 
+const doesSupportReadLines = () => {
+  const [major, minor, patch] = process.versions.node.split(".").map(Number);
+  return major >= 18 && minor >= 11;
+};
+
+export const isExists = async (path: string) => {
+  try {
+    await stat(path);
+    return true;
+  } catch {
+    return false;
+  }
+};
 export const encodeFileName = (fileName: string, extension?: string) => {
   return (
     fileName.replaceAll("%", "%25").replaceAll("*", "%") +
@@ -15,12 +29,99 @@ export const decodeFileName = (fileName: string) => {
   return fileName.replaceAll("%", "*").replaceAll("*25", "%");
 };
 
+export const encode = (
+  input: string | number | boolean | null | (string | number | boolean | null)[]
+) => {
+  const secureString = (input: string | number | boolean | null) => {
+    if (["true", "false"].includes(String(input))) return input ? 1 : 0;
+    return typeof input === "string"
+      ? decodeURIComponent(input)
+          .replaceAll("<", "&lt;")
+          .replaceAll(">", "&gt;")
+          .replaceAll(",", "%2C")
+          .replaceAll("|", "%7C")
+          .replaceAll("\n", "\\n")
+          .replaceAll("\r", "\\r")
+      : input;
+  };
+  return Array.isArray(input)
+    ? Utils.isArrayOfArrays(input)
+      ? (input as any[])
+          .map((_input) => _input.map(secureString).join(","))
+          .join("|")
+      : input.map(secureString).join(",")
+    : secureString(input);
+};
+
+export const decode = (
+  input: string | null | number,
+  fieldType?: FieldType | FieldType[],
+  fieldChildrenType?: FieldType | FieldType[]
+): string | number | boolean | null | (string | number | null | boolean)[] => {
+  if (!fieldType) return null;
+  const unSecureString = (input: string) =>
+    decodeURIComponent(input)
+      .replaceAll("&lt;", "<")
+      .replaceAll("&gt;", ">")
+      .replaceAll("%2C", ",")
+      .replaceAll("%7C", "|")
+      .replaceAll("\\n", "\n")
+      .replaceAll("\\r", "\r") || null;
+  if (input === null || input === "") return null;
+  if (Array.isArray(fieldType))
+    fieldType = Utils.detectFieldType(String(input), fieldType);
+  const decodeHelper = (value: string | number | any[]) => {
+    if (Array.isArray(value) && fieldType !== "array")
+      return value.map(decodeHelper);
+    switch (fieldType as FieldType) {
+      case "table":
+      case "number":
+        return isNaN(Number(value)) ? null : Number(value);
+      case "boolean":
+        return typeof value === "string" ? value === "true" : Boolean(value);
+      case "array":
+        if (!Array.isArray(value)) return [value];
+        if (fieldChildrenType)
+          return value.map(
+            (v) =>
+              decode(
+                v,
+                Array.isArray(fieldChildrenType)
+                  ? Utils.detectFieldType(v, fieldChildrenType)
+                  : fieldChildrenType
+              ) as string | number | boolean | null
+          );
+        else return value;
+      default:
+        return value;
+    }
+  };
+  return decodeHelper(
+    typeof input === "string"
+      ? input.includes(",")
+        ? input.includes("|")
+          ? input
+              .split("|")
+              .map((_input) => _input.split(",").map(unSecureString))
+          : input.split(",").map(unSecureString)
+        : unSecureString(input)
+      : input
+  );
+};
+
 export const get = async (
   filePath: string,
-  fieldType?: FieldType,
-  lineNumbers?: number | number[]
+  lineNumbers?: number | number[],
+  fieldType?: FieldType | FieldType[],
+  fieldChildrenType?: FieldType | FieldType[]
 ) => {
-  const file = await open(filePath);
+  let rl: Interface;
+  if (doesSupportReadLines()) rl = (await open(filePath)).readLines();
+  else
+    rl = createInterface({
+      input: createReadStream(filePath),
+      crlfDelay: Infinity,
+    });
   let lines: Record<
       number,
       | string
@@ -32,21 +133,23 @@ export const get = async (
     lineCount = 0;
 
   if (!lineNumbers) {
-    for await (const line of file.readLines())
-      lineCount++, (lines[lineCount] = Utils.decode(line, fieldType));
+    for await (const line of rl)
+      lineCount++,
+        (lines[lineCount] = decode(line, fieldType, fieldChildrenType));
   } else if (lineNumbers === -1) {
-    let lastLine;
-    for await (const line of file.readLines()) lineCount++, (lastLine = line);
-    if (lastLine) lines = { [lineCount]: Utils.decode(lastLine, fieldType) };
+    let lastLine: string;
+    for await (const line of rl) lineCount++, (lastLine = line);
+    if (lastLine)
+      lines = { [lineCount]: decode(lastLine, fieldType, fieldChildrenType) };
   } else {
     let lineNumbersArray = [
       ...(Array.isArray(lineNumbers) ? lineNumbers : [lineNumbers]),
     ];
-    for await (const line of file.readLines()) {
+    for await (const line of rl) {
       lineCount++;
       if (!lineNumbersArray.includes(lineCount)) continue;
       const indexOfLineCount = lineNumbersArray.indexOf(lineCount);
-      lines[lineCount] = Utils.decode(line, fieldType);
+      lines[lineCount] = decode(line, fieldType, fieldChildrenType);
       lineNumbersArray[indexOfLineCount] = 0;
       if (!lineNumbersArray.filter((lineN) => lineN !== 0).length) break;
     }
@@ -68,34 +171,44 @@ export const replace = async (
         string | boolean | number | null | (string | boolean | number | null)[]
       >
 ) => {
-  if (existsSync(filePath)) {
-    const file = await open(filePath, "w+"),
+  if (await isExists(filePath)) {
+    let rl: Interface, writeStream: WriteStream;
+    if (doesSupportReadLines()) {
+      const file = await open(filePath, "w+");
+      rl = file.readLines();
       writeStream = file.createWriteStream();
+    } else {
+      rl = createInterface({
+        input: createReadStream(filePath),
+        crlfDelay: Infinity,
+      });
+      writeStream = createWriteStream(filePath);
+    }
     if (typeof replacements === "object" && !Array.isArray(replacements)) {
       let lineCount = 0;
-      for await (const line of file.readLines()) {
+      for await (const line of rl) {
         lineCount++;
         writeStream.write(
-          (lineCount in replacements
-            ? Utils.encode(replacements[lineCount])
-            : line) + "\n"
+          (lineCount in replacements ? encode(replacements[lineCount]) : line) +
+            "\n"
         );
       }
     } else
-      for await (const _line of file.readLines())
-        writeStream.write(Utils.encode(replacements) + "\n");
+      for await (const _line of rl)
+        writeStream.write(encode(replacements) + "\n");
 
     writeStream.end();
   } else if (typeof replacements === "object" && !Array.isArray(replacements)) {
-    const file = await open(filePath, "w"),
-      writeStream = file.createWriteStream(),
-      largestLinesNumbers =
-        Math.max(...Object.keys(replacements).map(Number)) + 1;
+    let writeStream: WriteStream;
+    if (doesSupportReadLines())
+      writeStream = (await open(filePath, "w")).createWriteStream();
+    else writeStream = createWriteStream(filePath);
+    const largestLinesNumbers =
+      Math.max(...Object.keys(replacements).map(Number)) + 1;
     for (let lineCount = 1; lineCount < largestLinesNumbers; lineCount++) {
       writeStream.write(
-        (lineCount in replacements
-          ? Utils.encode(replacements[lineCount])
-          : "") + "\n"
+        (lineCount in replacements ? encode(replacements[lineCount]) : "") +
+          "\n"
       );
     }
     writeStream.end();
@@ -108,39 +221,52 @@ export const remove = async (
 ): Promise<void> => {
   let lineCount = 0;
 
-  const tempFilePath = `${filePath}.tmp`,
+  const tempFilePath = `${filePath}-${Date.now()}.tmp`,
     linesToDeleteArray = [
       ...(Array.isArray(linesToDelete) ? linesToDelete : [linesToDelete]),
-    ],
-    writeStream = createWriteStream(tempFilePath),
-    file = await open(filePath);
+    ];
+
+  let rl: Interface, writeStream: WriteStream;
+  if (doesSupportReadLines()) {
+    rl = (await open(filePath)).readLines();
+    writeStream = (await open(tempFilePath, "w+")).createWriteStream();
+  } else {
+    rl = createInterface({
+      input: createReadStream(filePath),
+      crlfDelay: Infinity,
+    });
+    writeStream = createWriteStream(tempFilePath);
+  }
 
-  for await (const line of file.readLines()) {
+  for await (const line of rl) {
     lineCount++;
     if (!linesToDeleteArray.includes(lineCount)) {
       writeStream.write(`${line}\n`);
     }
   }
-  writeStream.end();
-  writeStream.on("finish", () => {
-    unlinkSync(filePath); // Remove the original file
-    renameSync(tempFilePath, filePath); // Rename the temp file to the original file name
+  writeStream.end(async () => {
+    await unlink(filePath); // Remove the original file
+    await rename(tempFilePath, filePath); // Rename the temp file to the original file name
   });
 };
 
 export const count = async (filePath: string): Promise<number> => {
-  let lineCount = 0;
-
-  const file = await open(filePath);
+  let lineCount = 0,
+    rl: Interface;
+  if (doesSupportReadLines()) rl = (await open(filePath)).readLines();
+  else
+    rl = createInterface({
+      input: createReadStream(filePath),
+      crlfDelay: Infinity,
+    });
 
-  for await (const line of file.readLines()) lineCount++;
+  for await (const line of rl) lineCount++;
 
   return lineCount;
 };
 
 export const search = async (
   filePath: string,
-  fieldType: FieldType,
   operator: ComparisonOperator | ComparisonOperator[],
   comparedAtValue:
     | string
@@ -149,9 +275,12 @@ export const search = async (
     | null
     | (string | number | boolean | null)[],
   logicalOperator?: "and" | "or",
+  fieldType?: FieldType | FieldType[],
+  fieldChildrenType?: FieldType | FieldType[],
   limit?: number,
   offset?: number,
-  readWholeFile?: boolean
+  readWholeFile?: boolean,
+  secretKey?: string
 ): Promise<
   [
     Record<
@@ -166,7 +295,7 @@ export const search = async (
 > => {
   const handleComparisonOperator = (
     operator: ComparisonOperator,
-    value:
+    originalValue:
       | string
       | number
       | boolean
@@ -178,77 +307,85 @@ export const search = async (
       | boolean
       | null
       | (string | number | boolean | null)[],
-    fieldType: FieldType
+    fieldType?: FieldType | FieldType[],
+    fieldChildrenType?: FieldType | FieldType[]
   ): boolean => {
-    // check if not array or object
+    if (Array.isArray(fieldType))
+      fieldType = Utils.detectFieldType(String(originalValue), fieldType);
+    if (Array.isArray(comparedAtValue) && !["[]", "![]"].includes(operator))
+      return comparedAtValue.some((comparedAtValueSingle) =>
+        handleComparisonOperator(
+          operator,
+          originalValue,
+          comparedAtValueSingle,
+          fieldType
+        )
+      );
+    // check if not array or object // it can't be array or object!
     switch (operator) {
       case "=":
         switch (fieldType) {
           case "password":
-            return typeof value === "string" &&
+            return typeof originalValue === "string" &&
               typeof comparedAtValue === "string"
-              ? Utils.comparePassword(value, comparedAtValue)
+              ? Utils.comparePassword(originalValue, comparedAtValue)
               : false;
           case "boolean":
-            return Number(value) - Number(comparedAtValue) === 0;
+            return Number(originalValue) - Number(comparedAtValue) === 0;
+          case "id":
+            return secretKey && typeof comparedAtValue === "string"
+              ? Utils.decodeID(comparedAtValue as string, secretKey) ===
+                  originalValue
+              : comparedAtValue === originalValue;
           default:
-            return value === comparedAtValue;
+            return originalValue === comparedAtValue;
         }
       case "!=":
         return !handleComparisonOperator(
           "=",
-          value,
+          originalValue,
           comparedAtValue,
           fieldType
         );
       case ">":
-        return (
-          value !== null && comparedAtValue !== null && value > comparedAtValue
-        );
+        return originalValue > comparedAtValue;
       case "<":
-        return (
-          value !== null && comparedAtValue !== null && value < comparedAtValue
-        );
+        return originalValue < comparedAtValue;
       case ">=":
-        return (
-          value !== null && comparedAtValue !== null && value >= comparedAtValue
-        );
+        return originalValue >= comparedAtValue;
       case "<=":
-        return (
-          value !== null && comparedAtValue !== null && value <= comparedAtValue
-        );
+        return originalValue <= comparedAtValue;
       case "[]":
         return (
-          (Array.isArray(value) &&
+          (Array.isArray(originalValue) &&
             Array.isArray(comparedAtValue) &&
-            value.some(comparedAtValue.includes)) ||
-          (Array.isArray(value) &&
+            originalValue.some(comparedAtValue.includes)) ||
+          (Array.isArray(originalValue) &&
             !Array.isArray(comparedAtValue) &&
-            value.includes(comparedAtValue)) ||
-          (!Array.isArray(value) &&
+            originalValue.includes(comparedAtValue)) ||
+          (!Array.isArray(originalValue) &&
             Array.isArray(comparedAtValue) &&
-            comparedAtValue.includes(value))
+            comparedAtValue.includes(originalValue))
         );
       case "![]":
         return !handleComparisonOperator(
           "[]",
-          value,
+          originalValue,
           comparedAtValue,
           fieldType
         );
       case "*":
-        return (
-          value !== null &&
-          comparedAtValue !== null &&
-          new RegExp(
-            `^${comparedAtValue.toString().replace(/%/g, ".*")}$`,
-            "i"
-          ).test(value.toString())
-        );
+        return new RegExp(
+          `^${(String(comparedAtValue).includes("%")
+            ? String(comparedAtValue)
+            : "%" + String(comparedAtValue) + "%"
+          ).replace(/%/g, ".*")}$`,
+          "i"
+        ).test(String(originalValue));
       case "!*":
         return !handleComparisonOperator(
           "*",
-          value,
+          originalValue,
           comparedAtValue,
           fieldType
         );
@@ -266,13 +403,19 @@ export const search = async (
     > = {},
     lineCount = 0,
     foundItems = 0;
+  let rl: Interface;
+  if (doesSupportReadLines()) rl = (await open(filePath)).readLines();
+  else
+    rl = createInterface({
+      input: createReadStream(filePath),
+      crlfDelay: Infinity,
+    });
 
-  const file = await open(filePath),
-    columnName = decodeFileName(parse(filePath).name);
+  const columnName = decodeFileName(parse(filePath).name);
 
-  for await (const line of file.readLines()) {
+  for await (const line of rl) {
     lineCount++;
-    const decodedLine = Utils.decode(line, fieldType);
+    const decodedLine = decode(line, fieldType, fieldChildrenType);
     if (
       (Array.isArray(operator) &&
         Array.isArray(comparedAtValue) &&
@@ -318,10 +461,13 @@ export const search = async (
 
 export default class File {
   static get = get;
-  static count = count;
   static remove = remove;
   static search = search;
   static replace = replace;
+  static count = count;
+  static encode = encode;
+  static decode = decode;
   static encodeFileName = encodeFileName;
   static decodeFileName = decodeFileName;
+  static isExists = isExists;
 }