inibase 1.0.0-rc.5 → 1.0.0-rc.6

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?
@@ -465,9 +461,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,14 +1,7 @@
-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";
 
@@ -17,6 +10,14 @@ const doesSupportReadLines = () => {
   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("*", "%") +
@@ -79,7 +80,7 @@ export const decode = (
       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) =>
@@ -170,7 +171,7 @@ export const replace = async (
         string | boolean | number | null | (string | boolean | number | null)[]
       >
 ) => {
-  if (existsSync(filePath)) {
+  if (await isExists(filePath)) {
     let rl: Interface, writeStream: WriteStream;
     if (doesSupportReadLines()) {
       const file = await open(filePath, "w+");
@@ -220,7 +221,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 +244,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 +279,8 @@ export const search = async (
   fieldChildrenType?: FieldType | FieldType[],
   limit?: number,
   offset?: number,
-  readWholeFile?: boolean
+  readWholeFile?: boolean,
+  secretKey?: string
 ): Promise<
   [
     Record<
@@ -311,6 +312,15 @@ export const search = async (
   ): boolean => {
     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 "=":
@@ -322,10 +332,13 @@ export const search = async (
               : false;
           case "boolean":
             return Number(originalValue) - Number(comparedAtValue) === 0;
+          case "id":
+            return secretKey && typeof comparedAtValue === "string"
+              ? Utils.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 +348,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 +375,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(
           "*",
@@ -474,4 +469,5 @@ export default class File {
   static decode = decode;
   static encodeFileName = encodeFileName;
   static decodeFileName = decodeFileName;
+  static isExists = isExists;
 }

package/index.test.ts

@@ -2,9 +2,8 @@ import Inibase, { Schema, Data } from "./index";
 import { join } from "node:path";
 // import os from "os";
 // Create a new instance of Inibase with the database path
-const db = new Inibase("inibase", join("..", "inicontent", "databases"));
+const db = new Inibase("inicontent", join("..", "inicontent", "databases"));
 
-// test with edited schema
 const schema_1: Schema = [
   {
     key: "username",
@@ -12,236 +11,193 @@ const schema_1: Schema = [
     required: true,
   },
   {
-    key: "email",
-    type: "string",
+    key: "password",
+    type: "password",
     required: true,
   },
   {
-    key: "age",
-    type: "number",
+    key: "email",
+    type: "email",
     required: true,
   },
   {
-    key: "isActive",
-    type: "boolean",
-  },
-  {
-    key: "hobbies",
-    type: "array",
-    children: [
-      {
-        key: "name",
-        type: "string",
-      },
-      {
-        key: "level",
-        type: "string",
-      },
-    ],
-  },
-  {
-    key: "favoriteFoods",
-    type: "array",
-    children: "string",
-  },
-  {
-    key: "address",
-    type: "object",
-    children: [
-      {
-        key: "street",
-        type: "string",
-      },
-      {
-        key: "city",
-        type: "string",
-      },
-      {
-        key: "country",
-        type: "string",
-      },
-    ],
+    key: "role",
+    type: "string",
+    required: true,
   },
 ];
 
 const data_1: Data = [
   {
-    id: 1,
-    username: "user1",
-    email: "user1@example.com",
-    age: 25,
-    isActive: true,
-    hobbies: [
-      { name: "Reading", level: "Intermediate" },
-      { name: "Cooking", level: "Beginner" },
-    ],
-    favoriteFoods: ["Pizza", "Sushi", "Chocolate"],
-    address: {
-      street: "123 Main St",
-      city: "Exampleville",
-      country: "Sampleland",
-    },
+    username: "admin",
+    password: "admina",
+    email: "karim.amahtil@gmail.com",
+    role: "admin",
   },
   {
-    id: 2,
-    username: "user2",
-    email: "user2@example.com",
-    age: 30,
-    isActive: false,
-    hobbies: [
-      { name: "Gardening", level: "Advanced" },
-      { name: "Photography", level: "Intermediate" },
-    ],
-    favoriteFoods: ["Burgers", null, "Salad"],
-    address: {
-      street: "456 Elm Rd",
-      city: "Testington",
-      country: "Demo Country",
-    },
+    username: "kamatil",
+    password: "admina",
+    email: "karim.amahtil21@gmail.com",
+    role: "user",
   },
   {
-    id: 3,
-    username: "user3",
-    email: "user3@example.com",
-    age: 22,
-    isActive: true,
-    hobbies: [
-      { name: "Painting", level: "Beginner" },
-      { name: "Hiking", level: null },
-    ],
-    favoriteFoods: ["Pasta", "Fruit", "Cakes"],
-    address: {
-      street: "789 Oak Ave",
-      city: "Sampletown",
-      country: "Testland",
-    },
+    username: "tvonthego",
+    password: "azqswx",
+    email: "vip72abdo@gmail.com",
+    role: "user",
   },
 ];
 
 const schema_2: Schema = [
   {
-    key: "title",
+    key: "name",
     type: "string",
     required: true,
   },
   {
-    key: "price",
-    type: "number",
-  },
-  {
-    key: "user",
-    type: "table",
+    key: "slug",
+    type: "string",
     required: true,
   },
-];
-
-const data_2 = [
-  {
-    title: "Product 1",
-    price: 16,
-    user: 1,
-  },
   {
-    title: "Product 2",
-    price: 10,
-    user: 2,
+    key: "icon",
+    type: "url",
+    required: false,
   },
-];
-
-const schema_3: Schema = [
   {
-    key: "orderN",
-    type: "number",
+    key: "languages",
+    type: "array",
+    children: "string",
+    required: false,
   },
   {
-    key: "isActive",
-    type: "boolean",
+    key: "allowed_domains",
+    type: "array",
+    children: "url",
+    required: false,
   },
   {
-    key: "products",
+    key: "tables",
     type: "array",
     children: [
       {
         key: "name",
         type: "string",
+        required: true,
+      },
+      {
+        key: "slug",
+        type: "string",
+        required: true,
+      },
+      {
+        key: "allowed_methods",
+        type: "array",
+        children: [
+          {
+            key: "role",
+            type: "string",
+            required: true,
+          },
+          {
+            key: "methods",
+            type: "string",
+            required: true,
+          },
+        ],
+        required: true,
       },
       {
-        key: "variants",
+        key: "schema",
         type: "array",
         children: [
           {
-            key: "name",
+            key: "id",
+            type: "id",
+            required: true,
+          },
+          {
+            key: "subtype",
+            type: "string",
+          },
+          {
+            key: "accept",
+            type: "array",
+            children: "string",
+          },
+          {
+            key: "search",
+            type: "array",
+            children: "string",
+          },
+          {
+            key: "label",
+            type: "array",
+            children: "string",
+          },
+          {
+            key: "image",
             type: "string",
           },
           {
-            key: "price",
-            type: "number",
+            key: "values",
+            type: "array",
+            children: "string",
           },
         ],
       },
     ],
   },
+  {
+    key: "user",
+    type: ["array", "table"],
+    children: "table",
+    required: false,
+  },
 ];
 
-const data_3 = {
-  orderN: 5,
-  isActive: true,
-  products: [
-    {
-      name: "Product 1",
-      variants: [
-        {
-          name: "Variant 1",
-          price: 10,
-        },
-        {
-          name: "Variant 2",
-          price: 15,
-        },
-      ],
-    },
-    {
-      name: "Product 2",
-      variants: [
-        {
-          name: "Variant 3",
-          price: 78,
-        },
-        {
-          name: "Variant 4",
-          price: 456,
-        },
-      ],
-    },
-  ],
-};
-
-try {
-  // const DATA = await db.post("user", data_1);
-  // const DATA = await db.get("user", { favoriteFoods: "![]Pizza" });
-  // db.setTableSchema("user", schema_1);
-  // const DATA = await db.get("product", "4", {
-  //   columns: [
-  //     "title",
-  //     "user",
-  //     "user.username",
-  //     "user.address.street",
-  //     "user.hobbies.*.name",
-  //   ],
-  // });
-  // return os.platform();
-  // const DATA = await db.get("user", {
-  //   "hobbies.*.name": "*Reading,",
-  // });
-  // db.setTableSchema("order", schema_3);
-  const DATA = await db.get("product", "7a6f37d12fac6d4dd082a69e92fc1f07", {
-    columns: [
-      "!user.favoriteFoods",
-      "!user.username",
-      "*",
-      "!user.hobbies.*.name",
+const data_2 = [
+  {
+    name: "Inicontent",
+    slug: "inicontent",
+    allowed_domains: ["http://localhost:3000"],
+    tables: [
+      {
+        name: "User",
+        slug: "user",
+        allowed_methods: [
+          {
+            role: "user",
+            methods: "cru",
+          },
+          {
+            role: "guest",
+            methods: "c",
+          },
+        ],
+      },
+      {
+        name: "Database",
+        slug: "database",
+        allowed_methods: [
+          {
+            role: "user",
+            methods: "crud",
+          },
+          {
+            role: "guest",
+            methods: "c",
+          },
+        ],
+      },
     ],
-  });
+    user: 1,
+  },
+];
+try {
+  // db.setTableSchema("database", schema_2);
+  // const DATA = await db.post("database", data_2);
+  const DATA = await db.get("database", "4f928b04e660de92dc904580055dbe23");
   console.log(JSON.stringify(DATA, null, 4));
 } catch (er) {
   console.log(er);