inibase 2.0.0 → 2.0.1

package/dist/file.d.ts

@@ -113,6 +113,7 @@ export declare const search: (filePath: string, operator: ComparisonOperator | C
     databasePath?: string;
 }, limit?: number, offset?: number, readWholeFile?: boolean) => Promise<[Record<number, string | number | boolean | null | undefined | (string | number | boolean | null)[]> | null, number, Set<number> | null]>;
 export declare const sum: (fp: string, ln?: number | number[]) => Promise<number>;
+export declare const avg: (fp: string, ln?: number | number[]) => Promise<number>;
 export declare const min: (fp: string, ln?: number | number[]) => Promise<number>;
 export declare const max: (fp: string, ln?: number | number[]) => Promise<number>;
 export declare const getFileDate: (path: string) => Promise<Date>;

package/dist/file.js

@@ -132,7 +132,9 @@ const unSecureString = (input) => {
     // Fast path: the common case has no `\n` escape sequence, so avoid
     // allocating a replacement string (and a fresh RegExp) per cell.
     if (typeof input === "string")
-        return input.includes("\\n") ? input.replaceAll("\\n", "\n") || null : input;
+        return input.includes("\\n")
+            ? input.replaceAll("\\n", "\n") || null
+            : input;
     return null;
 };
 /**
@@ -831,11 +833,11 @@ export const search = async (filePath, operator, comparedAtValue, logicalOperato
     }
 };
 /**
- * Reads the file once and returns either the sum, min or max of the
+ * Reads the file once and returns either the sum, average, min or max of the
  * (optionally-selected) numeric lines.
  *
  * @param filePath   Absolute path of the column file (may be .gz-compressed).
- * @param wanted     Metric to compute: "sum" (default), "min" or "max".
+ * @param wanted     Metric to compute: "sum" (default), "avg", "min" or "max".
  * @param lineNumbers Specific line-number(s) to restrict the scan to.
  *
  * @returns Promise<number>  The requested metric, or 0 if no numeric value found.
@@ -864,7 +866,7 @@ async function reduceNumbers(filePath, wanted = "sum", lineNumbers) {
             if (Number.isNaN(num))
                 continue;
             processed++;
-            if (wanted === "sum") {
+            if (wanted === "sum" || wanted === "avg") {
                 sum += num;
             }
             else if (wanted === "min") {
@@ -885,10 +887,17 @@ async function reduceNumbers(filePath, wanted = "sum", lineNumbers) {
     }
     if (processed === 0)
         return 0; // nothing numeric found
-    return wanted === "sum" ? sum : wanted === "min" ? min : max;
+    return wanted === "sum"
+        ? sum
+        : wanted === "avg"
+            ? sum / processed
+            : wanted === "min"
+                ? min
+                : max;
 }
 /* Optional convenience wrappers (signatures unchanged) */
 export const sum = (fp, ln) => reduceNumbers(fp, "sum", ln);
+export const avg = (fp, ln) => reduceNumbers(fp, "avg", ln);
 export const min = (fp, ln) => reduceNumbers(fp, "min", ln);
 export const max = (fp, ln) => reduceNumbers(fp, "max", ln);
 export const getFileDate = (path) => stat(path)

package/dist/index.d.ts

@@ -231,6 +231,16 @@ export default class Inibase {
      */
     sum(tableName: string, columns: string, where?: number | string | (number | string)[] | Criteria): Promise<number>;
     sum(tableName: string, columns: string[], where?: number | string | (number | string)[] | Criteria): Promise<Record<string, number>>;
+    /**
+     * Generate average of column(s) in a table
+     *
+     * @param {string} tableName
+     * @param {string} columns
+     * @param {(number | string | (number | string)[] | Criteria)} [where]
+     * @return {*}  {Promise<number | Record<string, number>>}
+     */
+    avg(tableName: string, columns: string, where?: number | string | (number | string)[] | Criteria): Promise<number>;
+    avg(tableName: string, columns: string[], where?: number | string | (number | string)[] | Criteria): Promise<Record<string, number>>;
     /**
      * Generate max of column(s) in a table
      *

package/dist/index.js

@@ -536,6 +536,8 @@ export default class Inibase {
                         ? value
                         : Number(value.trim())
                     : 0;
+            case "date":
+                return Utils.dateToTimestamp(value);
             case "id":
                 return Utils.isNumber(value)
                     ? value
@@ -842,9 +844,7 @@ export default class Inibase {
                 key: field.key,
                 config: {
                     ...field,
-                    type: field.key === "id" && decodeID
-                        ? "number"
-                        : field.type,
+                    type: field.key === "id" && decodeID ? "number" : field.type,
                     databasePath: this.databasePath,
                 },
             });
@@ -1326,16 +1326,15 @@ export default class Inibase {
                 const itemsIDs = Object.values((await File.get(join(tablePath, `id${this.getFileExtension(tableName)}`), lineNumbers, { key: "BLABLA", type: "number" })) ?? {}).map(Number);
                 awkCommand = `awk '${itemsIDs.map((id) => `$1 == ${id}`).join(" || ")}'`;
             }
+            // perPage < 0 means "no limit": select every line instead of
+            // generating an empty awk window (with perPage -1 the old code
+            // produced `awk ''`, which prints nothing and the empty stdout
+            // decoded into a single hollow row).
             else
-                // perPage < 0 means "no limit": select every line instead of
-                // generating an empty awk window (with perPage -1 the old code
-                // produced `awk ''`, which prints nothing and the empty stdout
-                // decoded into a single hollow row).
                 awkCommand =
                     options.perPage < 0
                         ? "awk '1'"
-                        : `awk '${Array.from({ length: options.perPage }, (_, index) => (options.page - 1) *
-                            options.perPage +
+                        : `awk '${Array.from({ length: options.perPage }, (_, index) => (options.page - 1) * options.perPage +
                             index +
                             1)
                             .map((lineNumber) => `NR==${lineNumber}`)
@@ -1455,8 +1454,7 @@ export default class Inibase {
             let countItems = 0;
             const isDecodeID = globalConfig[this.databasePath].tables?.get(tableName)?.config
                 .decodeID === true &&
-                !globalConfig[this.databasePath].tables?.get(tableName)?.config
-                    .prepend;
+                !globalConfig[this.databasePath].tables?.get(tableName)?.config.prepend;
             if (isDecodeID &&
                 this.idDensity.get(tableName) &&
                 Ids.every(Utils.isNumber)) {
@@ -1976,6 +1974,30 @@ export default class Inibase {
         }
         return columns.length > 1 ? RETURN : Object.values(RETURN)[0];
     }
+    async avg(tableName, columns, where) {
+        this.validateName(tableName);
+        if (!Array.isArray(columns))
+            columns = [columns];
+        for (const column of columns)
+            this.validateName(column);
+        await this.throwErrorIfTableEmpty(tableName);
+        const RETURN = {};
+        const tablePath = join(this.databasePath, tableName);
+        for await (const column of columns) {
+            const columnPath = join(tablePath, `${column}${this.getFileExtension(tableName)}`);
+            if (await File.isExists(columnPath)) {
+                if (where) {
+                    const lineNumbers = await this.get(tableName, where, undefined, undefined, true);
+                    RETURN[column] = lineNumbers
+                        ? await File.avg(columnPath, lineNumbers)
+                        : 0;
+                }
+                else
+                    RETURN[column] = await File.avg(columnPath);
+            }
+        }
+        return columns.length > 1 ? RETURN : Object.values(RETURN)[0];
+    }
     async max(tableName, columns, where) {
         this.validateName(tableName);
         if (!Array.isArray(columns))

package/dist/utils.d.ts

@@ -115,7 +115,8 @@ export declare const isPassword: (input: unknown) => input is string;
  * @param input - The input to be checked, can be of any type.
  * @returns A boolean indicating whether the input is a valid date.
  */
-export declare const isDate: (input: unknown) => input is Date | number;
+export declare const dateToTimestamp: (input: unknown) => number | null;
+export declare const isDate: (input: unknown) => boolean;
 /**
  * Checks if the input is a valid ID.
  *

package/dist/utils.js

@@ -163,20 +163,36 @@ export const isPassword = (input) => typeof input === "string" && input.length =
  * @param input - The input to be checked, can be of any type.
  * @returns A boolean indicating whether the input is a valid date.
  */
-export const isDate = (input) => {
+export const dateToTimestamp = (input) => {
     // Check if the input is null, undefined, or an empty string
     if (input == null || input === "")
-        return false;
+        return null;
+    if (typeof input === "string") {
+        const match = /^(\d{4})-(\d{2})-(\d{2})$/.exec(input);
+        if (match) {
+            const year = Number(match[1]);
+            const month = Number(match[2]);
+            const day = Number(match[3]);
+            const timestamp = Date.UTC(year, month - 1, day);
+            const date = new Date(timestamp);
+            return date.getUTCFullYear() === year &&
+                date.getUTCMonth() === month - 1 &&
+                date.getUTCDate() === day
+                ? timestamp
+                : null;
+        }
+    }
     // Convert to number and check if it's a valid number
     const numTimestamp = Number(input);
     // Check if the converted number is NaN or not finite
     if (Number.isNaN(numTimestamp) || !Number.isFinite(numTimestamp))
-        return false;
+        return null;
     // Create a Date object from the timestamp
     const date = new Date(numTimestamp);
     // Check if the date is valid
-    return date.getTime() === numTimestamp;
+    return date.getTime() === numTimestamp ? numTimestamp : null;
 };
+export const isDate = (input) => dateToTimestamp(input) !== null;
 /**
  * Checks if the input is a valid ID.
  *

package/package.json

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