inibase 1.0.0-rc.55 → 1.0.0-rc.57

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Inibase
+Copyright (c) 2024 Inibase
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -10,8 +10,9 @@
 
 - **Lightweight** 🪶
 - **Minimalist** :white_circle: (but powerful)
-- **TypeScript** :large_blue_diamond:
+- **100% TypeScript** :large_blue_diamond:
 - **Super-Fast** :zap: (built-in caching system)
+- **ATOMIC** :lock: File lock for writing
 - **Built-in form-validation** included :sunglasses:
 - **Suitable for large data** :page_with_curl: (tested with 200K row)
 - **Support Compression** :eight_spoked_asterisk: (using built-in nodejs zlib)
@@ -25,7 +26,7 @@
 
 ```js
 import Inibase from "inibase";
-const db = new Inibase("database_name");
+const db = new Inibase("databaseName");
 
 // Get all items from "user" table
 const users = await db.get("user");
@@ -77,6 +78,21 @@ To simplify the idea, each database has tables, each table has columns, each col
 Ps: Testing by default with `user` table, with username, email, password fields _so results include password encryption process_
 
 
+## Config (.env)
+
+The `.env` file supports the following parameters (make sure to run commands with flag --env-file=.env)
+
+```ini
+# Auto generated secret key, will be using for encrypting the IDs
+INIBASE_SECRET=
+
+INIBASE_COMPRESSION=true
+INIBASE_CACHE=true
+
+# Prepend new items to the beginning of file 
+INIBASE_REVERSE=true
+```
+
 ## Roadmap
 
 - [x] Actions:
@@ -126,7 +142,7 @@ Ps: Testing by default with `user` table, with username, email, password fields
 
 ```js
 import Inibase from "inibase";
-const db = new Inibase("/database_name");
+const db = new Inibase("/databaseName");
 
 const user_schema = [
   {
@@ -271,7 +287,7 @@ Link two tables: "product" with "user"
 
 ```js
 import Inibase from "inibase";
-const db = new Inibase("/database_name");
+const db = new Inibase("/databaseName");
 
 const product_schema = [
   {
@@ -337,7 +353,7 @@ const product = await db.post("product", product_data);
 
 ```js
 import Inibase from "inibase";
-const db = new Inibase("/database_name");
+const db = new Inibase("/databaseName");
 
 // Get "user" by id
 const user = await db.get("user", "1d88385d4b1581f8fb059334dec30f4c");
@@ -415,7 +431,7 @@ const users = await db.get("user", undefined, {
 
 ```js
 import Inibase from "inibase";
-const db = new Inibase("/database_name");
+const db = new Inibase("/databaseName");
 
 // set "isActive" to "false" for all items in table "user"
 await db.put("user", { isActive: false });
@@ -434,7 +450,7 @@ await db.put("user", { isActive: false }, { isActive: true });
 
 ```js
 import Inibase from "inibase";
-const db = new Inibase("/database_name");
+const db = new Inibase("/databaseName");
 
 // delete all items in "user" table
 await db.delete("user");
@@ -453,7 +469,7 @@ await db.put("user", { isActive: false });
 
 ```js
 import Inibase from "inibase";
-const db = new Inibase("/database_name");
+const db = new Inibase("/databaseName");
 
 // get the sum of column "age" in "user" table
 await db.sum("user", "age");
@@ -469,7 +485,7 @@ await db.sum("user", ["age", ...], { isActive: false });
 
 ```js
 import Inibase from "inibase";
-const db = new Inibase("/database_name");
+const db = new Inibase("/databaseName");
 
 // get the biggest number of column "age" in "user" table
 await db.max("user", "age");
@@ -485,7 +501,7 @@ await db.max("user", ["age", ...], { isActive: false });
 
 ```js
 import Inibase from "inibase";
-const db = new Inibase("/database_name");
+const db = new Inibase("/databaseName");
 
 // get the smallest number of column "age" in "user" table
 await db.min("user", "age");
@@ -496,48 +512,6 @@ 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 (.env)
-
-The `.env` file supports the following parameters (make sure to run commands with flag --env-file=.env)
-
-```ini
-# Auto generated secret key, will be using for encrypting the IDs
-INIBASE_SECRET=
-
-INIBASE_COMPRESSION=true
-INIBASE_CACHE=true
-
-# Prepend new items to the beginning of file 
-INIBASE_REVERSE=true
-```
-
 ## License
 
 [MIT](./LICENSE)

package/dist/file.d.ts

@@ -142,4 +142,3 @@ 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>;

package/dist/file.js

@@ -4,7 +4,6 @@ import { Transform } from "node:stream";
 import { pipeline } from "node:stream/promises";
 import { createGzip, createGunzip, gunzipSync, gzipSync } from "node:zlib";
 import { join } from "node:path";
-import { Worker } from "node:worker_threads";
 import { detectFieldType, isArrayOfObjects, isJSON, isNumber, isObject, } from "./utils.js";
 import { encodeID, compare } from "./utils.server.js";
 import * as Config from "./config.js";
@@ -35,11 +34,9 @@ export const write = async (filePath, data, disableCompression = false) => {
         ? gzipSync(String(data))
         : String(data));
 };
-export const read = async (filePath, disableCompression = false) => {
-    return Config.isCompressionEnabled && !disableCompression
-        ? gunzipSync(await readFile(filePath)).toString()
-        : (await readFile(filePath)).toString();
-};
+export const read = async (filePath, disableCompression = false) => Config.isCompressionEnabled && !disableCompression
+    ? gunzipSync(await readFile(filePath)).toString()
+    : (await readFile(filePath)).toString();
 const _pipeline = async (rl, writeStream, transform) => {
     if (Config.isCompressionEnabled)
         await pipeline(rl, transform, createGzip(), writeStream);
@@ -52,18 +49,12 @@ const _pipeline = async (rl, writeStream, transform) => {
  * @param fileHandle - The file handle from which to create a read stream.
  * @returns A readline.Interface instance configured with the provided file stream.
  */
-const readLineInternface = (fileHandle) => {
-    const [major, minor, patch] = process.versions.node.split(".").map(Number);
-    return major > 18 ||
-        (major === 18 && minor >= 11 && !Config.isCompressionEnabled)
-        ? fileHandle.readLines()
-        : createInterface({
-            input: Config.isCompressionEnabled
-                ? fileHandle.createReadStream().pipe(createGunzip())
-                : fileHandle.createReadStream(),
-            crlfDelay: Number.POSITIVE_INFINITY,
-        });
-};
+const readLineInternface = (fileHandle) => createInterface({
+    input: Config.isCompressionEnabled
+        ? fileHandle.createReadStream().pipe(createGunzip())
+        : fileHandle.createReadStream(),
+    crlfDelay: Number.POSITIVE_INFINITY,
+});
 /**
  * Checks if a file or directory exists at the specified path.
  *
@@ -312,7 +303,7 @@ export const append = async (filePath, data) => {
                 rl = readLineInternface(fileHandle);
                 let isAppended = false;
                 await _pipeline(rl, fileTempHandle.createWriteStream(), new Transform({
-                    transform(line, encoding, callback) {
+                    transform(line, _, callback) {
                         if (!isAppended) {
                             isAppended = true;
                             return callback(null, `${Array.isArray(data) ? data.join("\n") : data}\n${line.length ? `${line}\n` : ""}`);
@@ -580,16 +571,3 @@ export const min = async (filePath, lineNumbers) => {
     await fileHandle.close();
     return min;
 };
-export function createWorker(functionName, arg) {
-    return new Promise((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}`);
-        });
-    });
-}

package/dist/index.d.ts

@@ -53,7 +53,6 @@ export default class Inibase {
     salt: Buffer;
     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" | "sort", arg: any[]): Promise<any>;
     private _schemaToIdsPath;
     setTableSchema(tableName: string, schema: Schema): Promise<void>;
     getTableSchema(tableName: string, encodeIDs?: boolean): Promise<Schema | undefined>;

package/dist/index.js

@@ -2,7 +2,6 @@ import { unlink, rename, mkdir, readdir } from "node:fs/promises";
 import { existsSync, appendFileSync, readFileSync } from "node:fs";
 import { join, parse } from "node:path";
 import { scryptSync, randomBytes } from "node:crypto";
-import { Worker } from "node:worker_threads";
 import { inspect } from "node:util";
 import Inison from "inison";
 import * as File from "./file.js";
@@ -62,26 +61,6 @@ export default class Inibase {
                 : errorMessage.replaceAll("{variable}", `'${variable.toString()}'`)
             : errorMessage.replaceAll("{variable}", ""));
     }
-    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);
-        });
-    }
     _schemaToIdsPath = (schema, prefix = "") => {
         const RETURN = {};
         for (const field of schema)
@@ -437,9 +416,8 @@ export default class Inibase {
                         Utils.isArrayOfObjects(children.children)).length) {
                         // one of children has array field type and has children array of object = Schema
                         for (const [index, item] of Object.entries((await this.getItemsFromSchema(tableName, field.children.filter((children) => children.type === "array" &&
-                            Utils.isArrayOfObjects(children.children)), linesNumber, options, `${(prefix ?? "") + field.key}.`)) ?? {})) {
+                            Utils.isArrayOfObjects(children.children)), linesNumber, options, `${(prefix ?? "") + field.key}.`)) ?? {}))
                             this._getItemsFromSchemaHelper(RETURN, item, index, field);
-                        }
                         field.children = field.children.filter((children) => children.type !== "array" ||
                             !Utils.isArrayOfObjects(children.children));
                     }
@@ -536,7 +514,8 @@ export default class Inibase {
                 }
             }
             else if (field.type === "table") {
-                if ((await File.isExists(join(this.folder, this.database, field.key))) &&
+                if (field.table &&
+                    (await File.isExists(join(this.folder, this.database, field.table))) &&
                     (await File.isExists(join(tablePath, `${(prefix ?? "") + field.key}.inib`)))) {
                     if (options.columns)
                         options.columns = options.columns
@@ -548,7 +527,7 @@ export default class Inibase {
                             if (!RETURN[index])
                                 RETURN[index] = {};
                             RETURN[index][field.key] = item
-                                ? await this.get(field.key, item, options)
+                                ? await this.get(field.table, item, options)
                                 : this.getDefaultValue(field);
                         }));
                 }
@@ -869,9 +848,7 @@ export default class Inibase {
                     ? RETURN.toReversed()
                     : RETURN
                 : RETURN);
-            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(Object.entries(pathesContents).map(async ([path, content]) => renameList.push(await File.append(path, content))));
             await Promise.all(renameList.map(async ([tempPath, filePath]) => rename(tempPath, filePath)));
             renameList = [];
             totalItems += Array.isArray(RETURN) ? RETURN.length : 1;
@@ -935,9 +912,7 @@ export default class Inibase {
                     const replacementObject = {};
                     for (const index of [...Array(totalItems)].keys())
                         replacementObject[`${index + 1}`] = content;
-                    renameList.push(this.isThreadEnabled
-                        ? await File.createWorker("replace", [path, replacementObject])
-                        : await File.replace(path, replacementObject));
+                    renameList.push(await File.replace(path, replacementObject));
                 }));
                 await Promise.all(renameList.map(async ([tempPath, filePath]) => rename(tempPath, filePath)));
                 if (Config.isCacheEnabled)
@@ -975,9 +950,7 @@ export default class Inibase {
                 .join("."));
             try {
                 await File.lock(join(tablePath, ".tmp"), keys);
-                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(Object.entries(pathesContents).map(async ([path, content]) => renameList.push(await File.replace(path, content))));
                 await Promise.all(renameList.map(async ([tempPath, filePath]) => rename(tempPath, filePath)));
                 renameList = [];
                 if (Config.isCacheEnabled)
@@ -1033,12 +1006,7 @@ export default class Inibase {
                     throw this.throwError("NO_RESULTS", tableName);
                 try {
                     await File.lock(join(tablePath, ".tmp"));
-                    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(files.map(async (file) => renameList.push(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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "inibase",
-  "version": "1.0.0-rc.55",
+  "version": "1.0.0-rc.57",
   "author": {
     "name": "Karim Amahtil",
     "email": "karim.amahtil@gmail.com"
@@ -9,9 +9,7 @@
   "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"
@@ -56,15 +54,9 @@
       ".": [
         "./dist/index.d.ts"
       ],
-      "thread": [
-        "./dist/index.thread.d.ts"
-      ],
       "file": [
         "./dist/file.d.ts"
       ],
-      "file.thread": [
-        "./dist/file.thread.d.ts"
-      ],
       "utils": [
         "./dist/utils.d.ts"
       ],
@@ -77,15 +69,14 @@
     }
   },
   "devDependencies": {
-    "@types/node": "^20.10.6",
-    "tinybench": "^2.6.0",
-    "typescript": "^5.3.3"
+    "@types/node": "^20.12.11",
+    "tinybench": "^2.6.0"
   },
   "dependencies": {
     "inison": "^1.0.0-rc.2"
   },
   "scripts": {
-    "build": "npx tsc",
+    "build": "tsc",
     "test": "npx tsx watch --expose-gc --env-file=.env ./index.test",
     "benchmark": "npx tsx --env-file=.env ./benchmark/index",
     "benchmark:single": "npx tsx --expose-gc --env-file=.env ./benchmark/single",

package/dist/file.thread.d.ts

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

package/dist/file.thread.js

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

package/dist/index.thread.d.ts

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

package/dist/index.thread.js

@@ -1,6 +0,0 @@
-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));