inibase 1.1.10 → 1.1.11

package/README.md

@@ -97,6 +97,7 @@ interface {
   compression: boolean;
   cache: boolean;
   prepend: boolean;
+  decodeID: boolean;
 }
 ```
 
@@ -236,7 +237,8 @@ const db = new Inibase("/databaseName");
 const userTableConfig = {
   compression: true,
   cache: true,
-  prepend: false
+  prepend: false,
+  decodeID: false
 }
 
 const userTableSchema = [

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import "dotenv/config";
 export interface Data {
-    id?: string;
+    id?: string | number;
     [key: string]: any;
     createdAt?: number;
     updatedAt?: number;
@@ -27,6 +27,7 @@ export interface Config {
     compression?: boolean;
     cache?: boolean;
     prepend?: boolean;
+    decodeID?: boolean;
 }
 export interface TableObject {
     schema?: Schema;
@@ -134,11 +135,11 @@ export default class Inibase {
      * @param {boolean} [onlyLinesNumbers]
      * @return {*}  {(Promise<Data | number | (Data | number)[] | null>)}
      */
-    get<TData extends Record<string, any> & Partial<Data>>(tableName: string, where: string | number | (string | number)[] | Criteria | undefined, options: Options | undefined, onlyOne: true, onlyLinesNumbers?: false): Promise<(Data & TData) | null>;
-    get<TData extends Record<string, any> & Partial<Data>>(tableName: string, where: string | number, options?: Options, onlyOne?: boolean, onlyLinesNumbers?: false): Promise<(Data & TData) | null>;
-    get<TData extends Record<string, any> & Partial<Data>>(tableName: string, where?: string | number | (string | number)[] | Criteria, options?: Options, onlyOne?: boolean, onlyLinesNumbers?: false): Promise<(Data & TData)[] | null>;
-    get<TData extends Record<string, any> & Partial<Data>>(tableName: string, where: string | number | (string | number)[] | Criteria | undefined, options: Options | undefined, onlyOne: false | undefined, onlyLinesNumbers: true): Promise<number[] | null>;
-    get<TData extends Record<string, any> & Partial<Data>>(tableName: string, where: string | number | (string | number)[] | Criteria | undefined, options: Options | undefined, onlyOne: true, onlyLinesNumbers: true): Promise<number | null>;
+    get<TData extends Record<string, any> & Partial<Data>>(tableName: string, where: string | number | (string | number)[] | Criteria | undefined, options: Options | undefined, onlyOne: true, onlyLinesNumbers?: false, _whereIsLinesNumbers?: boolean): Promise<(Data & TData) | null>;
+    get<TData extends Record<string, any> & Partial<Data>>(tableName: string, where: string | number, options?: Options, onlyOne?: boolean, onlyLinesNumbers?: false, _whereIsLinesNumbers?: boolean): Promise<(Data & TData) | null>;
+    get<TData extends Record<string, any> & Partial<Data>>(tableName: string, where?: string | number | (string | number)[] | Criteria, options?: Options, onlyOne?: boolean, onlyLinesNumbers?: false, _whereIsLinesNumbers?: boolean): Promise<(Data & TData)[] | null>;
+    get<TData extends Record<string, any> & Partial<Data>>(tableName: string, where: string | number | (string | number)[] | Criteria | undefined, options: Options | undefined, onlyOne: false | undefined, onlyLinesNumbers: true, _whereIsLinesNumbers?: boolean): Promise<number[] | null>;
+    get<TData extends Record<string, any> & Partial<Data>>(tableName: string, where: string | number | (string | number)[] | Criteria | undefined, options: Options | undefined, onlyOne: true, onlyLinesNumbers: true, _whereIsLinesNumbers?: boolean): Promise<number | null>;
     /**
      * Create new item(s) in a table
      *
@@ -161,10 +162,10 @@ export default class Inibase {
      * @param {boolean} [returnUpdatedData]
      * @return {*}  {Promise<Data | Data[] | null | undefined | void>}
      */
-    put<TData extends Record<string, any> & Partial<Data>>(tableName: string, data?: (Data & TData) | (Data & TData)[], where?: number | string | (number | string)[] | Criteria | undefined, options?: Options | undefined, returnUpdatedData?: false): Promise<void>;
-    put<TData extends Record<string, any> & Partial<Data>>(tableName: string, data: Data & TData, where: number | string | (number | string)[] | Criteria | undefined, options: Options | undefined, returnUpdatedData: true | boolean): Promise<(Data & TData) | null>;
-    put<TData extends Record<string, any> & Partial<Data>>(tableName: string, data: (Data & TData)[], where: number | string | (number | string)[] | Criteria | undefined, options: Options | undefined, returnUpdatedData: true | boolean): Promise<(Data & TData)[] | null>;
-    put<TData extends Record<string, any> & Partial<Data>>(tableName: string, data: (Data & TData) | (Data & TData)[], where: number | string | (number | string)[] | Criteria | undefined, options: Options | undefined, returnUpdatedData: true | boolean): Promise<(Data & TData) | (Data & TData)[] | null>;
+    put<TData extends Record<string, any> & Partial<Data>>(tableName: string, data?: (Data & TData) | (Data & TData)[], where?: number | string | (number | string)[] | Criteria | undefined, options?: Options | undefined, returnUpdatedData?: false, _whereIsLinesNumbers?: boolean): Promise<void>;
+    put<TData extends Record<string, any> & Partial<Data>>(tableName: string, data: Data & TData, where: number | string | (number | string)[] | Criteria | undefined, options: Options | undefined, returnUpdatedData: true | boolean, _whereIsLinesNumbers?: boolean): Promise<(Data & TData) | null>;
+    put<TData extends Record<string, any> & Partial<Data>>(tableName: string, data: (Data & TData)[], where: number | string | (number | string)[] | Criteria | undefined, options: Options | undefined, returnUpdatedData: true | boolean, _whereIsLinesNumbers?: boolean): Promise<(Data & TData)[] | null>;
+    put<TData extends Record<string, any> & Partial<Data>>(tableName: string, data: (Data & TData) | (Data & TData)[], where: number | string | (number | string)[] | Criteria | undefined, options: Options | undefined, returnUpdatedData: true | boolean, _whereIsLinesNumbers?: boolean): Promise<(Data & TData) | (Data & TData)[] | null>;
     /**
      * Delete item(s) in a table
      *
@@ -172,7 +173,7 @@ export default class Inibase {
      * @param {(number | string | (number | string)[] | Criteria)} [where]
      * @return {boolean | null}  {(Promise<boolean | null>)}
      */
-    delete(tableName: string, where?: number | string | (number | string)[] | Criteria, _id?: string | string[]): Promise<boolean | null>;
+    delete(tableName: string, where?: number | string | (number | string)[] | Criteria, _whereIsLinesNumbers?: boolean): Promise<boolean | null>;
     /**
      * Generate sum of column(s) in a table
      *

package/dist/index.js

@@ -158,6 +158,7 @@ export default class Inibase {
                 compression: process.env.INIBASE_COMPRESSION == "true",
                 cache: process.env.INIBASE_CACHE === "true",
                 prepend: process.env.INIBASE_PREPEND === "true",
+                decodeID: process.env.INIBASE_ENCODEID === "true",
             };
         if (config) {
             if (config.compression)
@@ -251,6 +252,13 @@ export default class Inibase {
                     await unlink(join(tablePath, ".cache.config"));
                 }
             }
+            if (config.decodeID !== undefined &&
+                config.decodeID !== table.config.decodeID) {
+                if (config.decodeID)
+                    await writeFile(join(tablePath, ".decodeID.config"), "");
+                else
+                    await unlink(join(tablePath, ".decodeID.config"));
+            }
             if (config.prepend !== undefined &&
                 config.prepend !== table.config.prepend) {
                 await UtilsServer.execFile("find", [
@@ -302,6 +310,7 @@ export default class Inibase {
                     compression: await File.isExists(join(tablePath, ".compression.config")),
                     cache: await File.isExists(join(tablePath, ".cache.config")),
                     prepend: await File.isExists(join(tablePath, ".prepend.config")),
+                    decodeID: await File.isExists(join(tablePath, ".decodeID.config")),
                 },
             });
         return this.tablesMap.get(tableName);
@@ -717,7 +726,9 @@ export default class Inibase {
     async processSimpleField(tableName, field, linesNumber, RETURN, _options, prefix) {
         const fieldPath = join(this.databasePath, tableName, `${prefix ?? ""}${field.key}${this.getFileExtension(tableName)}`);
         if (await File.isExists(fieldPath)) {
-            const items = await File.get(fieldPath, linesNumber, field.type, field.children, this.salt);
+            const items = await File.get(fieldPath, linesNumber, field.key === "id" && this.tablesMap.get(tableName).config.decodeID
+                ? "number"
+                : field.type, field.children, this.salt);
             if (items) {
                 for (const [index, item] of Object.entries(items)) {
                     if (typeof item === "undefined")
@@ -1062,7 +1073,7 @@ export default class Inibase {
     async get(tableName, where, options = {
         page: 1,
         perPage: 15,
-    }, onlyOne, onlyLinesNumbers) {
+    }, onlyOne, onlyLinesNumbers, _whereIsLinesNumbers) {
         const tablePath = join(this.databasePath, tableName);
         // Ensure options.columns is an array
         if (options.columns) {
@@ -1193,8 +1204,9 @@ export default class Inibase {
             if (!this.totalItems.has(`${tableName}-*`))
                 this.totalItems.set(`${tableName}-*`, pagination[1]);
         }
-        else if ((Array.isArray(where) && where.every(Utils.isNumber)) ||
-            Utils.isNumber(where)) {
+        else if (((Array.isArray(where) && where.every(Utils.isNumber)) ||
+            Utils.isNumber(where)) &&
+            (_whereIsLinesNumbers || !this.tablesMap.get(tableName).config.decodeID)) {
             // "where" in this case, is the line(s) number(s) and not id(s)
             let lineNumbers = where;
             if (!Array.isArray(lineNumbers))
@@ -1208,7 +1220,11 @@ export default class Inibase {
             if (RETURN?.length && !Array.isArray(where))
                 RETURN = RETURN[0];
         }
-        else if ((Array.isArray(where) && where.every(Utils.isValidID)) ||
+        else if ((!_whereIsLinesNumbers &&
+            this.tablesMap.get(tableName).config.decodeID &&
+            ((Array.isArray(where) && where.every(Utils.isNumber)) ||
+                Utils.isNumber(where))) ||
+            (Array.isArray(where) && where.every(Utils.isValidID)) ||
             Utils.isValidID(where)) {
             let Ids = where;
             if (!Array.isArray(Ids))
@@ -1245,7 +1261,7 @@ export default class Inibase {
                     return onlyOne ? Number(cachedItems[0]) : cachedItems.map(Number);
                 return this.get(tableName, cachedItems
                     .slice((options.page - 1) * options.perPage, options.page * options.perPage)
-                    .map(Number), options, onlyOne);
+                    .map(Number), options, onlyOne, undefined, true);
             }
             const [LineNumberDataMap, linesNumbers] = await this.applyCriteria(tableName, options, where);
             if (LineNumberDataMap && linesNumbers?.size) {
@@ -1279,6 +1295,15 @@ export default class Inibase {
             totalPages: Math.ceil(greatestTotalItems / options.perPage),
             total: greatestTotalItems,
         };
+        // if (this.tablesMap.get(tableName).config.decodeID) {
+        // 	if (Array.isArray(RETURN)) {
+        // 		for (let index = 0; index < RETURN.length; index++)
+        // 			RETURN[index].id = UtilsServer.decodeID(
+        // 				RETURN[index].id as string,
+        // 				this.salt,
+        // 			);
+        // 	} else RETURN.id = UtilsServer.decodeID(RETURN.id as string, this.salt);
+        // }
         return onlyOne && Array.isArray(RETURN) ? RETURN[0] : RETURN;
     }
     async post(tableName, data, options, returnPostedData) {
@@ -1344,7 +1369,8 @@ export default class Inibase {
                         ? clonedData
                             .map((_, index) => this.totalItems.get(`${tableName}-*`) - index)
                             .toReversed()
-                        : this.totalItems.get(`${tableName}-*`), options, !Utils.isArrayOfObjects(clonedData));
+                        : this.totalItems.get(`${tableName}-*`), options, !Utils.isArrayOfObjects(clonedData), // return only one item if data is not array of objects
+                undefined, true);
         }
         finally {
             if (renameList.length)
@@ -1355,7 +1381,7 @@ export default class Inibase {
     async put(tableName, data, where, options = {
         page: 1,
         perPage: 15,
-    }, returnUpdatedData) {
+    }, returnUpdatedData, _whereIsLinesNumbers) {
         const renameList = [];
         const tablePath = join(this.databasePath, tableName);
         await this.throwErrorIfTableEmpty(tableName);
@@ -1398,13 +1424,9 @@ export default class Inibase {
                 await File.unlock(join(tablePath, ".tmp"));
             }
         }
-        else if ((Array.isArray(where) && where.every(Utils.isValidID)) ||
-            Utils.isValidID(where)) {
-            const lineNumbers = await this.get(tableName, where, undefined, undefined, true);
-            return this.put(tableName, clonedData, lineNumbers, options, false);
-        }
-        else if ((Array.isArray(where) && where.every(Utils.isNumber)) ||
-            Utils.isNumber(where)) {
+        else if (((Array.isArray(where) && where.every(Utils.isNumber)) ||
+            Utils.isNumber(where)) &&
+            (_whereIsLinesNumbers || !this.tablesMap.get(tableName).config.decodeID)) {
             // "where" in this case, is the line(s) number(s) and not id(s)
             await this.validateData(tableName, clonedData, true);
             clonedData = this.formatData(clonedData, this.tablesMap.get(tableName).schema, true);
@@ -1432,7 +1454,7 @@ export default class Inibase {
                 if (this.tablesMap.get(tableName).config.cache)
                     await this.clearCache(tableName);
                 if (returnUpdatedData)
-                    return this.get(tableName, where, options, !Array.isArray(where));
+                    return this.get(tableName, where, options, !Array.isArray(where), undefined, true);
             }
             finally {
                 if (renameList.length)
@@ -1440,10 +1462,19 @@ export default class Inibase {
                 await File.unlock(join(tablePath, ".tmp"), keys);
             }
         }
+        else if ((!_whereIsLinesNumbers &&
+            this.tablesMap.get(tableName).config.decodeID &&
+            ((Array.isArray(where) && where.every(Utils.isNumber)) ||
+                Utils.isNumber(where))) ||
+            (Array.isArray(where) && where.every(Utils.isValidID)) ||
+            Utils.isValidID(where)) {
+            const lineNumbers = await this.get(tableName, where, undefined, undefined, true);
+            return this.put(tableName, clonedData, lineNumbers, options, false, true);
+        }
         else if (Utils.isObject(where)) {
             const lineNumbers = await this.get(tableName, where, undefined, undefined, true);
             if (lineNumbers)
-                return this.put(tableName, clonedData, lineNumbers, options, returnUpdatedData);
+                return this.put(tableName, clonedData, lineNumbers, options, returnUpdatedData, true);
         }
         else
             throw this.createError("INVALID_PARAMETERS");
@@ -1455,7 +1486,7 @@ export default class Inibase {
      * @param {(number | string | (number | string)[] | Criteria)} [where]
      * @return {boolean | null}  {(Promise<boolean | null>)}
      */
-    async delete(tableName, where, _id) {
+    async delete(tableName, where, _whereIsLinesNumbers) {
         const tablePath = join(this.databasePath, tableName);
         await this.throwErrorIfTableEmpty(tableName);
         if (!where) {
@@ -1483,13 +1514,9 @@ export default class Inibase {
                 await File.unlock(join(tablePath, ".tmp"));
             }
         }
-        if ((Array.isArray(where) && where.every(Utils.isValidID)) ||
-            Utils.isValidID(where)) {
-            const lineNumbers = await this.get(tableName, where, undefined, undefined, true);
-            return this.delete(tableName, lineNumbers, where);
-        }
-        if ((Array.isArray(where) && where.every(Utils.isNumber)) ||
-            Utils.isNumber(where)) {
+        if (((Array.isArray(where) && where.every(Utils.isNumber)) ||
+            Utils.isNumber(where)) &&
+            (_whereIsLinesNumbers || !this.tablesMap.get(tableName).config.decodeID)) {
             // "where" in this case, is the line(s) number(s) and not id(s)
             const files = (await readdir(tablePath))?.filter((fileName) => fileName.endsWith(this.getFileExtension(tableName)));
             if (files.length) {
@@ -1529,10 +1556,19 @@ export default class Inibase {
                 }
             }
         }
-        else if (Utils.isObject(where)) {
+        if ((!_whereIsLinesNumbers &&
+            this.tablesMap.get(tableName).config.decodeID &&
+            ((Array.isArray(where) && where.every(Utils.isNumber)) ||
+                Utils.isNumber(where))) ||
+            (Array.isArray(where) && where.every(Utils.isValidID)) ||
+            Utils.isValidID(where)) {
+            const lineNumbers = await this.get(tableName, where, undefined, undefined, true);
+            return this.delete(tableName, lineNumbers, true);
+        }
+        if (Utils.isObject(where)) {
             const lineNumbers = await this.get(tableName, where, undefined, undefined, true);
             if (lineNumbers)
-                return this.delete(tableName, lineNumbers);
+                return this.delete(tableName, lineNumbers, true);
         }
         else
             throw this.createError("INVALID_PARAMETERS");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "inibase",
-  "version": "1.1.10",
+  "version": "1.1.11",
   "type": "module",
   "author": {
     "name": "Karim Amahtil",