inibase 1.0.0-rc.5 → 1.0.0-rc.7

package/README.md

@@ -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?
@@ -389,60 +385,6 @@ await db.put("user", { isActive: false });
 
 </details>
 
-## Typescript
-
-<details>
-<summary>Schema</summary>
-
-```js
-type Schema = Field[];
-type Field = {
-  id?: string | number | null | undefined,
-  key: string,
-  required?: boolean,
-} & (
-  | {
-      type: Exclude<FieldType, "array" | "object">,
-      required?: boolean,
-    }
-  | {
-      type: "array",
-      children: FieldType | FieldType[] | Schema,
-    }
-  | {
-      type: "object",
-      children: Schema,
-    }
-);
-type FieldType =
-  | "string"
-  | "number"
-  | "boolean"
-  | "date"
-  | "email"
-  | "url"
-  | "table"
-  | "object"
-  | "array"
-  | "password";
-```
-
-</details>
-
-<details>
-<summary>Data</summary>
-
-```js
-type Data = {
-  id?: number | string,
-  [key: string]: any,
-  created_at?: Date,
-  updated_at?: Date,
-};
-```
-
-</details>
-
 ## Roadmap
 
 - [x] Actions:
@@ -465,9 +407,9 @@ type Data = {
   - [x] Object
   - [x] Array
   - [x] Password
-  - [ ] IP
-  - [ ] HTML
-  - [ ] Markdown
+  - [x] IP
+  - [x] HTML
+  - [x] Id
 - [ ] TO-DO:
   - [ ] Improve caching
   - [ ] Commenting the code

package/file.ts

@@ -1,22 +1,24 @@
-import {
-  createWriteStream,
-  unlinkSync,
-  renameSync,
-  existsSync,
-  createReadStream,
-  WriteStream,
-} from "fs";
-import { open } from "fs/promises";
-import { Interface, createInterface } from "readline";
-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";
+import { detectFieldType, isArrayOfArrays, isNumber } from "./utils";
+import { encodeID, decodeID, comparePassword } from "./utils.server";
 
 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("*", "%") +
@@ -29,7 +31,13 @@ export const decodeFileName = (fileName: string) => {
 };
 
 export const encode = (
-  input: string | number | boolean | null | (string | number | boolean | null)[]
+  input:
+    | string
+    | number
+    | boolean
+    | null
+    | (string | number | boolean | null)[],
+  secretKey?: string | Buffer
 ) => {
   const secureString = (input: string | number | boolean | null) => {
     if (["true", "false"].includes(String(input))) return input ? 1 : 0;
@@ -44,7 +52,7 @@ export const encode = (
       : input;
   };
   return Array.isArray(input)
-    ? Utils.isArrayOfArrays(input)
+    ? isArrayOfArrays(input)
       ? (input as any[])
           .map((_input) => _input.map(secureString).join(","))
           .join("|")
@@ -55,7 +63,8 @@ export const encode = (
 export const decode = (
   input: string | null | number,
   fieldType?: FieldType | FieldType[],
-  fieldChildrenType?: FieldType | FieldType[]
+  fieldChildrenType?: FieldType | FieldType[],
+  secretKey?: string | Buffer
 ): string | number | boolean | null | (string | number | null | boolean)[] => {
   if (!fieldType) return null;
   const unSecureString = (input: string) =>
@@ -68,29 +77,34 @@ export const decode = (
       .replaceAll("\\r", "\r") || null;
   if (input === null || input === "") return null;
   if (Array.isArray(fieldType))
-    fieldType = Utils.detectFieldType(String(input), fieldType);
+    fieldType = 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);
+        return isNumber(value) ? Number(value) : null;
       case "boolean":
         return typeof value === "string" ? value === "true" : Boolean(value);
       case "array":
-        if (!Array.isArray(value)) return null;
+        if (!Array.isArray(value)) return [value];
+
         if (fieldChildrenType)
           return value.map(
             (v) =>
               decode(
                 v,
                 Array.isArray(fieldChildrenType)
-                  ? Utils.detectFieldType(v, fieldChildrenType)
-                  : fieldChildrenType
+                  ? detectFieldType(v, fieldChildrenType)
+                  : fieldChildrenType,
+                undefined,
+                secretKey
               ) as string | number | boolean | null
           );
         else return value;
+      case "id":
+        return isNumber(value) ? encodeID(value as number, secretKey) : value;
       default:
         return value;
     }
@@ -103,6 +117,16 @@ export const decode = (
               .split("|")
               .map((_input) => _input.split(",").map(unSecureString))
           : input.split(",").map(unSecureString)
+        : input.includes("|")
+        ? input
+            .split("|")
+            .map((_input) => [
+              _input
+                ? fieldType === "array"
+                  ? [unSecureString(_input)]
+                  : unSecureString(_input)
+                : null,
+            ])
         : unSecureString(input)
       : input
   );
@@ -112,8 +136,20 @@ export const get = async (
   filePath: string,
   lineNumbers?: number | number[],
   fieldType?: FieldType | FieldType[],
-  fieldChildrenType?: FieldType | FieldType[]
-) => {
+  fieldChildrenType?: FieldType | FieldType[],
+  secretKey?: string | Buffer
+): Promise<
+  [
+    Record<
+      number,
+      | string
+      | number
+      | boolean
+      | (string | number | boolean | (string | number | boolean)[])[]
+    > | null,
+    number
+  ]
+> => {
   let rl: Interface;
   if (doesSupportReadLines()) rl = (await open(filePath)).readLines();
   else
@@ -134,12 +170,19 @@ export const get = async (
   if (!lineNumbers) {
     for await (const line of rl)
       lineCount++,
-        (lines[lineCount] = decode(line, fieldType, fieldChildrenType));
+        (lines[lineCount] = decode(
+          line,
+          fieldType,
+          fieldChildrenType,
+          secretKey
+        ));
   } else if (lineNumbers === -1) {
     let lastLine: string;
     for await (const line of rl) lineCount++, (lastLine = line);
     if (lastLine)
-      lines = { [lineCount]: decode(lastLine, fieldType, fieldChildrenType) };
+      lines = {
+        [lineCount]: decode(lastLine, fieldType, fieldChildrenType, secretKey),
+      };
   } else {
     let lineNumbersArray = [
       ...(Array.isArray(lineNumbers) ? lineNumbers : [lineNumbers]),
@@ -148,13 +191,13 @@ export const get = async (
       lineCount++;
       if (!lineNumbersArray.includes(lineCount)) continue;
       const indexOfLineCount = lineNumbersArray.indexOf(lineCount);
-      lines[lineCount] = decode(line, fieldType, fieldChildrenType);
+      lines[lineCount] = decode(line, fieldType, fieldChildrenType, secretKey);
       lineNumbersArray[indexOfLineCount] = 0;
       if (!lineNumbersArray.filter((lineN) => lineN !== 0).length) break;
     }
   }
 
-  return lines ?? null;
+  return [lines ?? null, lineCount];
 };
 
 export const replace = async (
@@ -168,9 +211,10 @@ export const replace = async (
     | Record<
         number,
         string | boolean | number | null | (string | boolean | number | null)[]
-      >
+      >,
+  secretKey?: string | Buffer
 ) => {
-  if (existsSync(filePath)) {
+  if (await isExists(filePath)) {
     let rl: Interface, writeStream: WriteStream;
     if (doesSupportReadLines()) {
       const file = await open(filePath, "w+");
@@ -188,13 +232,14 @@ export const replace = async (
       for await (const line of rl) {
         lineCount++;
         writeStream.write(
-          (lineCount in replacements ? encode(replacements[lineCount]) : line) +
-            "\n"
+          (lineCount in replacements
+            ? encode(replacements[lineCount], secretKey)
+            : line) + "\n"
         );
       }
     } else
       for await (const _line of rl)
-        writeStream.write(encode(replacements) + "\n");
+        writeStream.write(encode(replacements, secretKey) + "\n");
 
     writeStream.end();
   } else if (typeof replacements === "object" && !Array.isArray(replacements)) {
@@ -206,8 +251,9 @@ export const replace = async (
       Math.max(...Object.keys(replacements).map(Number)) + 1;
     for (let lineCount = 1; lineCount < largestLinesNumbers; lineCount++) {
       writeStream.write(
-        (lineCount in replacements ? encode(replacements[lineCount]) : "") +
-          "\n"
+        (lineCount in replacements
+          ? encode(replacements[lineCount], secretKey)
+          : "") + "\n"
       );
     }
     writeStream.end();
@@ -220,7 +266,7 @@ 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]),
     ];
@@ -243,10 +289,9 @@ export const remove = async (
       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
   });
 };
 
@@ -279,7 +324,8 @@ export const search = async (
   fieldChildrenType?: FieldType | FieldType[],
   limit?: number,
   offset?: number,
-  readWholeFile?: boolean
+  readWholeFile?: boolean,
+  secretKey?: string | Buffer
 ): Promise<
   [
     Record<
@@ -310,7 +356,16 @@ export const search = async (
     fieldChildrenType?: FieldType | FieldType[]
   ): boolean => {
     if (Array.isArray(fieldType))
-      fieldType = Utils.detectFieldType(String(originalValue), fieldType);
+      fieldType = 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 "=":
@@ -318,14 +373,16 @@ export const search = async (
           case "password":
             return typeof originalValue === "string" &&
               typeof comparedAtValue === "string"
-              ? Utils.comparePassword(originalValue, comparedAtValue)
+              ? comparePassword(originalValue, comparedAtValue)
               : false;
           case "boolean":
             return Number(originalValue) - Number(comparedAtValue) === 0;
+          case "id":
+            return secretKey && typeof comparedAtValue === "string"
+              ? decodeID(comparedAtValue as string, secretKey) === originalValue
+              : comparedAtValue === originalValue;
           default:
-            return Array.isArray(comparedAtValue)
-              ? comparedAtValue.some((value) => originalValue === value)
-              : originalValue === comparedAtValue;
+            return originalValue === comparedAtValue;
         }
       case "!=":
         return !handleComparisonOperator(
@@ -335,21 +392,13 @@ export const search = async (
           fieldType
         );
       case ">":
-        return Array.isArray(comparedAtValue)
-          ? comparedAtValue.some((value) => originalValue > value)
-          : originalValue > comparedAtValue;
+        return originalValue > comparedAtValue;
       case "<":
-        return Array.isArray(comparedAtValue)
-          ? comparedAtValue.some((value) => originalValue < value)
-          : originalValue < comparedAtValue;
+        return originalValue < comparedAtValue;
       case ">=":
-        return Array.isArray(comparedAtValue)
-          ? comparedAtValue.some((value) => originalValue >= value)
-          : originalValue >= comparedAtValue;
+        return originalValue >= comparedAtValue;
       case "<=":
-        return Array.isArray(comparedAtValue)
-          ? comparedAtValue.some((value) => originalValue <= value)
-          : originalValue <= comparedAtValue;
+        return originalValue <= comparedAtValue;
       case "[]":
         return (
           (Array.isArray(originalValue) &&
@@ -370,23 +419,13 @@ export const search = async (
           fieldType
         );
       case "*":
-        return Array.isArray(comparedAtValue)
-          ? comparedAtValue.some((value) =>
-              new RegExp(
-                `^${(String(value).includes("%")
-                  ? String(value)
-                  : "%" + String(value) + "%"
-                ).replace(/%/g, ".*")}$`,
-                "i"
-              ).test(String(originalValue))
-            )
-          : new RegExp(
-              `^${(String(comparedAtValue).includes("%")
-                ? String(comparedAtValue)
-                : "%" + String(comparedAtValue) + "%"
-              ).replace(/%/g, ".*")}$`,
-              "i"
-            ).test(String(originalValue));
+        return new RegExp(
+          `^${(String(comparedAtValue).includes("%")
+            ? String(comparedAtValue)
+            : "%" + String(comparedAtValue) + "%"
+          ).replace(/%/g, ".*")}$`,
+          "i"
+        ).test(String(originalValue));
       case "!*":
         return !handleComparisonOperator(
           "*",
@@ -420,7 +459,7 @@ export const search = async (
 
   for await (const line of rl) {
     lineCount++;
-    const decodedLine = decode(line, fieldType, fieldChildrenType);
+    const decodedLine = decode(line, fieldType, fieldChildrenType, secretKey);
     if (
       (Array.isArray(operator) &&
         Array.isArray(comparedAtValue) &&
@@ -474,4 +513,5 @@ export default class File {
   static decode = decode;
   static encodeFileName = encodeFileName;
   static decodeFileName = decodeFileName;
+  static isExists = isExists;
 }