inibase 1.0.0-rc.38 → 1.0.0-rc.39

package/README.md

@@ -105,6 +105,7 @@ Ps: Testing by default with `user` table, with username, email, password fields
   - [x] IP
   - [x] HTML
   - [x] Id
+  - [x] JSON
 - [ ] TO-DO:
   - [x] Improve caching
   - [x] Commenting the code
@@ -491,6 +492,33 @@ await db.min("user", ["age", ...], { isActive: false });
 
 </details>
 
+<details>
+<summary>createWorker</summary>
+
+```js
+import Inibase from "inibase";
+const db = new Inibase("/database_name");
+
+// POST 10,000 USER
+await Promise.all(
+  [...Array(10)]
+    .map((x, i) => i)
+    .map(
+      (_index) =>
+        db.createWorker("post", [
+          "user",
+          [...Array(1000)].map((_, i) => ({
+            username: `username_${i + 1}`,
+            email: `email_${i + 1}@test.com`,
+            password: `password_${i + 1}`,
+          })),
+        ])
+    )
+)
+```
+
+</details>
+
 ## Config
 
 The `.env` file supports the following parameters (make sure to run command with flag --env-file=.env)

package/dist/file.d.ts

@@ -17,10 +17,9 @@ export declare const isExists: (path: string) => Promise<boolean>;
  * If the input is a single value, it is directly secured.
  *
  * @param input - A value or array of values (string, number, boolean, null).
- * @param secretKey - Optional secret key for encoding, can be a string or Buffer.
  * @returns The secured and/or joined string.
  */
-export declare const encode: (input: string | number | boolean | null | (string | number | boolean | null)[], secretKey?: string | Buffer) => string | number | boolean | null;
+export declare const encode: (input: string | number | boolean | null | (string | number | boolean | null)[]) => string | number | boolean | null;
 /**
  * Decodes the input based on the specified field type(s) and an optional secret key.
  * Handles different formats of input, including strings, numbers, and their array representations.
@@ -143,6 +142,7 @@ export declare const max: (filePath: string, lineNumbers?: number | number[]) =>
  * Note: Decodes each line as a number using the 'decode' function. Considers only numerical values for determining the minimum.
  */
 export declare const min: (filePath: string, lineNumbers?: number | number[]) => Promise<number>;
+export declare function createWorker(functionName: "get" | "remove" | "search" | "replace" | "sum" | "min" | "max" | "append" | "count", arg: any[]): Promise<any>;
 /**
  * Asynchronously sorts the lines in a file in the specified direction.
  *
@@ -160,7 +160,7 @@ export default class File {
     static remove: (filePath: string, linesToDelete: number | number[]) => Promise<string[]>;
     static search: (filePath: string, operator: ComparisonOperator | ComparisonOperator[], comparedAtValue: string | number | boolean | (string | number | boolean | null)[] | null, logicalOperator?: "and" | "or" | undefined, fieldType?: FieldType | FieldType[] | undefined, fieldChildrenType?: FieldType | FieldType[] | undefined, limit?: number | undefined, offset?: number | undefined, readWholeFile?: boolean | undefined, secretKey?: string | Buffer | undefined) => Promise<[Record<number, string | number | boolean | (string | number | boolean | null)[] | null> | null, number, Set<number> | null]>;
     static replace: (filePath: string, replacements: string | number | boolean | (string | number | boolean | null)[] | Record<number, string | number | boolean | (string | number | boolean | null)[] | null> | null) => Promise<string[]>;
-    static encode: (input: string | number | boolean | (string | number | boolean | null)[] | null, secretKey?: string | Buffer | undefined) => string | number | boolean | null;
+    static encode: (input: string | number | boolean | (string | number | boolean | null)[] | null) => string | number | boolean | null;
     static decode: (input: string | number | null, fieldType?: FieldType | FieldType[] | undefined, fieldChildrenType?: FieldType | FieldType[] | undefined, secretKey?: string | Buffer | undefined) => string | number | boolean | (string | number | boolean | null)[] | null;
     static isExists: (path: string) => Promise<boolean>;
     static sum: (filePath: string, lineNumbers?: number | number[] | undefined) => Promise<number>;
@@ -172,4 +172,5 @@ export default class File {
     static read: (filePath: string, disableCompression?: boolean) => Promise<string>;
     static lock: (folderPath: string) => Promise<void>;
     static unlock: (folderPath: string) => Promise<void>;
+    static createWorker: typeof createWorker;
 }

package/dist/file.js

@@ -5,6 +5,7 @@ import { pipeline } from "node:stream/promises";
 import { createGzip, createGunzip, gzip as gzipAsync, gunzip as gunzipAsync, } from "node:zlib";
 import { promisify } from "node:util";
 import { join } from "node:path";
+import { Worker } from "node:worker_threads";
 import { detectFieldType, isArrayOfArrays, isNumber, isObject, isPassword, } from "./utils.js";
 import { encodeID, comparePassword } from "./utils.server.js";
 import Config from "./config.js";
@@ -144,10 +145,9 @@ const joinMultidimensionalArray = (arr, delimiter_index = 0) => {
  * If the input is a single value, it is directly secured.
  *
  * @param input - A value or array of values (string, number, boolean, null).
- * @param secretKey - Optional secret key for encoding, can be a string or Buffer.
  * @returns The secured and/or joined string.
  */
-export const encode = (input, secretKey) => {
+export const encode = (input) => {
     // Use the optimized secureArray and joinMultidimensionalArray functions.
     return Array.isArray(input)
         ? joinMultidimensionalArray(secureArray(input))
@@ -217,6 +217,8 @@ const decodeHelper = (value, fieldType, fieldChildrenType, secretKey) => {
     if (Array.isArray(value) && fieldType !== "array")
         return value.map((v) => decodeHelper(v, fieldType, fieldChildrenType, secretKey));
     switch (fieldType) {
+        case "json":
+            return JSON.parse(value);
         case "number":
             return isNumber(value) ? Number(value) : null;
         case "boolean":
@@ -761,6 +763,19 @@ export const min = async (filePath, lineNumbers) => {
     await fileHandle.close();
     return min;
 };
+export function createWorker(functionName, arg) {
+    return new Promise(function (resolve, reject) {
+        const worker = new Worker("./dist/file.thread.js", {
+            workerData: { functionName, arg },
+        });
+        worker.on("message", (data) => {
+            resolve(data);
+        });
+        worker.on("error", (msg) => {
+            reject(`An error ocurred: ${msg}`);
+        });
+    });
+}
 /**
  * Asynchronously sorts the lines in a file in the specified direction.
  *
@@ -790,4 +805,5 @@ export default class File {
     static read = read;
     static lock = lock;
     static unlock = unlock;
+    static createWorker = createWorker;
 }

package/dist/file.thread.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/file.thread.js

@@ -0,0 +1,5 @@
+import { parentPort, workerData } from "node:worker_threads";
+import File from "./file.js";
+const { functionName, arg } = workerData;
+// @ts-ignore
+File[functionName](...arg).then((res) => parentPort.postMessage(res));

package/dist/index.d.ts

@@ -5,7 +5,7 @@ export interface Data {
     createdAt?: number;
     updatedAt?: number;
 }
-export type FieldType = "string" | "number" | "boolean" | "date" | "email" | "url" | "table" | "object" | "array" | "password" | "html" | "ip" | "id";
+export type FieldType = "string" | "number" | "boolean" | "date" | "email" | "url" | "table" | "object" | "array" | "password" | "html" | "ip" | "json" | "id";
 type FieldDefault = {
     id?: string | number;
     key: string;
@@ -62,10 +62,12 @@ export default class Inibase {
     database: string;
     table: string | null;
     pageInfo: Record<string, pageInfo>;
+    private isThreadEnabled;
     private totalItems;
     salt: Buffer;
-    constructor(database: string, mainFolder?: string);
+    constructor(database: string, mainFolder?: string, _table?: string | null, _totalItems?: Record<string, number>, _pageInfo?: Record<string, pageInfo>, _isThreadEnabled?: boolean);
     private throwError;
+    createWorker(functionName: "get" | "post" | "put" | "delete" | "sum" | "min" | "max", arg: any[]): Promise<any>;
     private _decodeIdFromSchema;
     private _schemaToIdsPath;
     setTableSchema(tableName: string, schema: Schema): Promise<void>;

package/dist/index.js

@@ -1,26 +1,27 @@
 import { unlink, rename, mkdir, readdir } from "node:fs/promises";
 import { existsSync, appendFileSync } from "node:fs";
 import { join } from "node:path";
-import { cpus } from "node:os";
 import { scryptSync, randomBytes } from "node:crypto";
+import { Worker } from "node:worker_threads";
 import File from "./file.js";
 import Utils from "./utils.js";
 import UtilsServer from "./utils.server.js";
 import Config from "./config.js";
-process.env.UV_THREADPOOL_SIZE = cpus().length.toString();
 export default class Inibase {
     folder;
     database;
     table;
     pageInfo;
+    isThreadEnabled = false;
     totalItems;
     salt;
-    constructor(database, mainFolder = ".") {
+    constructor(database, mainFolder = ".", _table = null, _totalItems = {}, _pageInfo = {}, _isThreadEnabled = false) {
         this.database = database;
         this.folder = mainFolder;
-        this.table = null;
-        this.totalItems = {};
-        this.pageInfo = {};
+        this.table = _table;
+        this.totalItems = _totalItems;
+        this.pageInfo = _pageInfo;
+        this.isThreadEnabled = _isThreadEnabled;
         if (!existsSync(".env") || !process.env.INIBASE_SECRET) {
             this.salt = scryptSync(randomBytes(16), randomBytes(16), 32);
             appendFileSync(".env", `\nINIBASE_SECRET=${this.salt.toString("hex")}\n`);
@@ -53,6 +54,26 @@ export default class Inibase {
         }
         return new Error(errorMessage);
     }
+    async createWorker(functionName, arg) {
+        return new Promise((resolve, reject) => {
+            const worker = new Worker("./dist/index.thread.js", {
+                workerData: {
+                    _constructor: [
+                        this.database,
+                        this.folder,
+                        this.table,
+                        this.totalItems,
+                        this.pageInfo,
+                        true, // enable Thread
+                    ],
+                    functionName,
+                    arg,
+                },
+            });
+            worker.on("message", resolve);
+            worker.on("error", reject);
+        });
+    }
     _decodeIdFromSchema = (schema) => schema.map((field) => {
         if ((field.type === "array" || field.type === "object") &&
             field.children &&
@@ -159,7 +180,7 @@ export default class Inibase {
                         !Utils.isArrayOfObjects(field.children)
                         ? field.children
                         : undefined))
-                    throw this.throwError("INVALID_TYPE", field.key + " " + field.type + " " + data[field.key]);
+                    throw this.throwError("INVALID_TYPE", [field.key, field.type]);
                 if ((field.type === "array" || field.type === "object") &&
                     field.children &&
                     Utils.isArrayOfObjects(field.children))
@@ -239,6 +260,8 @@ export default class Inibase {
                 return Utils.isNumber(value)
                     ? value
                     : UtilsServer.decodeID(value, this.salt);
+            case "json":
+                return JSON.stringify(value);
             default:
                 return value;
         }
@@ -784,7 +807,9 @@ export default class Inibase {
                 throw this.throwError("NO_DATA");
             RETURN = this.formatData(RETURN, schema);
             const pathesContents = this.joinPathesContents(join(tablePath), Array.isArray(RETURN) ? RETURN.toReversed() : RETURN);
-            await Promise.all(Object.entries(pathesContents).map(async ([path, content]) => renameList.push(await File.append(path, content))));
+            await Promise.all(Object.entries(pathesContents).map(async ([path, content]) => renameList.push(this.isThreadEnabled
+                ? await File.createWorker("append", [path, content])
+                : await File.append(path, content))));
             await Promise.all(renameList.map(async ([tempPath, filePath]) => rename(tempPath, filePath)));
             renameList = [];
             if (Config.isCacheEnabled) {
@@ -838,7 +863,9 @@ export default class Inibase {
                     });
                 try {
                     await File.lock(join(tablePath, ".tmp"));
-                    await Promise.all(Object.entries(pathesContents).map(async ([path, content]) => renameList.push(await File.replace(path, content))));
+                    await Promise.all(Object.entries(pathesContents).map(async ([path, content]) => renameList.push(this.isThreadEnabled
+                        ? await File.createWorker("replace", [path, content])
+                        : await File.replace(path, content))));
                     await Promise.all(renameList.map(async ([tempPath, filePath]) => rename(tempPath, filePath)));
                     if (Config.isCacheEnabled)
                         await this.clearCache(join(tablePath, ".tmp"));
@@ -878,7 +905,9 @@ export default class Inibase {
                 ]));
                 try {
                     await File.lock(join(tablePath, ".tmp"));
-                    await Promise.all(Object.entries(pathesContents).map(async ([path, content]) => renameList.push(await File.replace(path, content))));
+                    await Promise.all(Object.entries(pathesContents).map(async ([path, content]) => renameList.push(this.isThreadEnabled
+                        ? await File.createWorker("replace", [path, content])
+                        : await File.replace(path, content))));
                     await Promise.all(renameList.map(async ([tempPath, filePath]) => rename(tempPath, filePath)));
                     renameList = [];
                     if (Config.isCacheEnabled)
@@ -946,7 +975,12 @@ export default class Inibase {
                         throw this.throwError("NO_ITEMS", tableName);
                     try {
                         await File.lock(join(tablePath, ".tmp"));
-                        await Promise.all(files.map(async (file) => renameList.push(await File.remove(join(tablePath, file), where))));
+                        await Promise.all(files.map(async (file) => renameList.push(this.isThreadEnabled
+                            ? await File.createWorker("remove", [
+                                join(tablePath, file),
+                                where,
+                            ])
+                            : await File.remove(join(tablePath, file), where))));
                         await Promise.all(renameList.map(async ([tempPath, filePath]) => rename(tempPath, filePath)));
                         if (Config.isCacheEnabled) {
                             await this.clearCache(tablePath);

package/dist/index.thread.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/index.thread.js

@@ -0,0 +1,6 @@
+import Inibase from "./index.js";
+import { parentPort, workerData } from "node:worker_threads";
+const { _constructor, functionName, arg } = workerData;
+// @ts-ignore
+new Inibase(..._constructor)[functionName](...arg)
+    .then((res) => parentPort?.postMessage(res));

package/dist/utils.js

@@ -210,6 +210,24 @@ export const isDate = (input) => !isNaN(new Date(input).getTime()) || !isNaN(Dat
 export const isValidID = (input) => {
     return typeof input === "string" && input.length === 32;
 };
+/**
+ * Checks if a given string is a valid JSON.
+ *
+ * @param {string} str - The string to be checked.
+ * @returns {boolean} Returns true if the string is valid JSON, otherwise false.
+ */
+function isJSON(str) {
+    try {
+        // Attempt to parse the string as JSON
+        JSON.parse(str);
+        // If parsing succeeds, return true
+        return true;
+    }
+    catch (error) {
+        // If an error occurs during parsing, return false
+        return false;
+    }
+}
 /**
  * Identifies and returns properties that have changed between two objects.
  *
@@ -257,8 +275,10 @@ export const detectFieldType = (input, availableTypes) => {
             return "url";
         else if (availableTypes.includes("password") && isPassword(input))
             return "password";
-        else if (availableTypes.includes("date") && isDate(input))
-            return "date";
+        else if (availableTypes.includes("json") && isJSON(input))
+            return "json";
+        else if (availableTypes.includes("json") && isDate(input))
+            return "json";
         else if (availableTypes.includes("string") && isString(input))
             return "string";
         else if (availableTypes.includes("ip") && isIP(input))
@@ -323,6 +343,8 @@ export const validateFieldType = (value, fieldType, fieldChildrenType) => {
                 return isNumber(value) || isValidID(value);
         case "id":
             return isNumber(value) || isValidID(value);
+        case "json":
+            return isJSON(value) || Array.isArray(value) || isObject(value);
         default:
             return false;
     }

package/dist/utils.server.d.ts

@@ -53,7 +53,7 @@ export declare const addIdToSchema: (schema: Schema, oldIndex: number | undefine
     key: string;
     required?: boolean | undefined;
 } & {
-    type: "string" | "number" | "boolean" | "id" | "url" | "html" | "table" | "email" | "date" | "password" | "ip";
+    type: "string" | "number" | "boolean" | "id" | "url" | "html" | "table" | "email" | "json" | "date" | "password" | "ip";
     children?: undefined;
 }) | ({
     id?: string | number | undefined;
@@ -68,7 +68,7 @@ export declare const addIdToSchema: (schema: Schema, oldIndex: number | undefine
     required?: boolean | undefined;
 } & {
     type: "array";
-    children: "string" | "number" | "boolean" | "object" | "id" | "url" | "html" | "table" | "email" | "date" | "password" | "ip" | Schema | ("string" | "number" | "boolean" | "object" | "id" | "url" | "html" | "table" | "email" | "date" | "password" | "ip")[];
+    children: "string" | "number" | "boolean" | "object" | "id" | "url" | "html" | "table" | "email" | "json" | "date" | "password" | "ip" | Schema | ("string" | "number" | "boolean" | "object" | "id" | "url" | "html" | "table" | "email" | "json" | "date" | "password" | "ip")[];
 }))[];
 export declare const hashObject: (obj: any) => string;
 export default class UtilsServer {
@@ -82,7 +82,7 @@ export default class UtilsServer {
         key: string;
         required?: boolean | undefined;
     } & {
-        type: "string" | "number" | "boolean" | "id" | "url" | "html" | "table" | "email" | "date" | "password" | "ip";
+        type: "string" | "number" | "boolean" | "id" | "url" | "html" | "table" | "email" | "json" | "date" | "password" | "ip";
         children?: undefined;
     }) | ({
         id?: string | number | undefined;
@@ -97,7 +97,7 @@ export default class UtilsServer {
         required?: boolean | undefined;
     } & {
         type: "array";
-        children: "string" | "number" | "boolean" | "object" | "id" | "url" | "html" | "table" | "email" | "date" | "password" | "ip" | Schema | ("string" | "number" | "boolean" | "object" | "id" | "url" | "html" | "table" | "email" | "date" | "password" | "ip")[];
+        children: "string" | "number" | "boolean" | "object" | "id" | "url" | "html" | "table" | "email" | "json" | "date" | "password" | "ip" | Schema | ("string" | "number" | "boolean" | "object" | "id" | "url" | "html" | "table" | "email" | "json" | "date" | "password" | "ip")[];
     }))[];
     static hashObject: (obj: any) => string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "inibase",
-  "version": "1.0.0-rc.38",
+  "version": "1.0.0-rc.39",
   "author": {
     "name": "Karim Amahtil",
     "email": "karim.amahtil@gmail.com"
@@ -9,7 +9,9 @@
   "main": "./dist/index.js",
   "exports": {
     ".": "./dist/index.js",
+    "./thread": "./dist/index.thread.js",
     "./file": "./dist/file.js",
+    "./file.thread": "./dist/file.thread.js",
     "./config": "./dist/config.js",
     "./utils": "./dist/utils.js",
     "./utils.server": "./dist/utils.server.js"
@@ -51,9 +53,15 @@
   "types": "./dist",
   "typesVersions": {
     "*": {
+      "thread": [
+        "./dist/index.thread.d.ts"
+      ],
       "file": [
         "./dist/file.d.ts"
       ],
+      "file.thread": [
+        "./dist/file.thread.d.ts"
+      ],
       "utils": [
         "./dist/utils.d.ts"
       ],