@adaptivestone/framework 4.7.0 → 4.8.1

package/coverage/sorter.js

@@ -0,0 +1,196 @@
+/* eslint-disable */
+var addSorting = (function() {
+    'use strict';
+    var cols,
+        currentSort = {
+            index: 0,
+            desc: false
+        };
+
+    // returns the summary table element
+    function getTable() {
+        return document.querySelector('.coverage-summary');
+    }
+    // returns the thead element of the summary table
+    function getTableHeader() {
+        return getTable().querySelector('thead tr');
+    }
+    // returns the tbody element of the summary table
+    function getTableBody() {
+        return getTable().querySelector('tbody');
+    }
+    // returns the th element for nth column
+    function getNthColumn(n) {
+        return getTableHeader().querySelectorAll('th')[n];
+    }
+
+    function onFilterInput() {
+        const searchValue = document.getElementById('fileSearch').value;
+        const rows = document.getElementsByTagName('tbody')[0].children;
+        for (let i = 0; i < rows.length; i++) {
+            const row = rows[i];
+            if (
+                row.textContent
+                    .toLowerCase()
+                    .includes(searchValue.toLowerCase())
+            ) {
+                row.style.display = '';
+            } else {
+                row.style.display = 'none';
+            }
+        }
+    }
+
+    // loads the search box
+    function addSearchBox() {
+        var template = document.getElementById('filterTemplate');
+        var templateClone = template.content.cloneNode(true);
+        templateClone.getElementById('fileSearch').oninput = onFilterInput;
+        template.parentElement.appendChild(templateClone);
+    }
+
+    // loads all columns
+    function loadColumns() {
+        var colNodes = getTableHeader().querySelectorAll('th'),
+            colNode,
+            cols = [],
+            col,
+            i;
+
+        for (i = 0; i < colNodes.length; i += 1) {
+            colNode = colNodes[i];
+            col = {
+                key: colNode.getAttribute('data-col'),
+                sortable: !colNode.getAttribute('data-nosort'),
+                type: colNode.getAttribute('data-type') || 'string'
+            };
+            cols.push(col);
+            if (col.sortable) {
+                col.defaultDescSort = col.type === 'number';
+                colNode.innerHTML =
+                    colNode.innerHTML + '<span class="sorter"></span>';
+            }
+        }
+        return cols;
+    }
+    // attaches a data attribute to every tr element with an object
+    // of data values keyed by column name
+    function loadRowData(tableRow) {
+        var tableCols = tableRow.querySelectorAll('td'),
+            colNode,
+            col,
+            data = {},
+            i,
+            val;
+        for (i = 0; i < tableCols.length; i += 1) {
+            colNode = tableCols[i];
+            col = cols[i];
+            val = colNode.getAttribute('data-value');
+            if (col.type === 'number') {
+                val = Number(val);
+            }
+            data[col.key] = val;
+        }
+        return data;
+    }
+    // loads all row data
+    function loadData() {
+        var rows = getTableBody().querySelectorAll('tr'),
+            i;
+
+        for (i = 0; i < rows.length; i += 1) {
+            rows[i].data = loadRowData(rows[i]);
+        }
+    }
+    // sorts the table using the data for the ith column
+    function sortByIndex(index, desc) {
+        var key = cols[index].key,
+            sorter = function(a, b) {
+                a = a.data[key];
+                b = b.data[key];
+                return a < b ? -1 : a > b ? 1 : 0;
+            },
+            finalSorter = sorter,
+            tableBody = document.querySelector('.coverage-summary tbody'),
+            rowNodes = tableBody.querySelectorAll('tr'),
+            rows = [],
+            i;
+
+        if (desc) {
+            finalSorter = function(a, b) {
+                return -1 * sorter(a, b);
+            };
+        }
+
+        for (i = 0; i < rowNodes.length; i += 1) {
+            rows.push(rowNodes[i]);
+            tableBody.removeChild(rowNodes[i]);
+        }
+
+        rows.sort(finalSorter);
+
+        for (i = 0; i < rows.length; i += 1) {
+            tableBody.appendChild(rows[i]);
+        }
+    }
+    // removes sort indicators for current column being sorted
+    function removeSortIndicators() {
+        var col = getNthColumn(currentSort.index),
+            cls = col.className;
+
+        cls = cls.replace(/ sorted$/, '').replace(/ sorted-desc$/, '');
+        col.className = cls;
+    }
+    // adds sort indicators for current column being sorted
+    function addSortIndicators() {
+        getNthColumn(currentSort.index).className += currentSort.desc
+            ? ' sorted-desc'
+            : ' sorted';
+    }
+    // adds event listeners for all sorter widgets
+    function enableUI() {
+        var i,
+            el,
+            ithSorter = function ithSorter(i) {
+                var col = cols[i];
+
+                return function() {
+                    var desc = col.defaultDescSort;
+
+                    if (currentSort.index === i) {
+                        desc = !currentSort.desc;
+                    }
+                    sortByIndex(i, desc);
+                    removeSortIndicators();
+                    currentSort.index = i;
+                    currentSort.desc = desc;
+                    addSortIndicators();
+                };
+            };
+        for (i = 0; i < cols.length; i += 1) {
+            if (cols[i].sortable) {
+                // add the click event handler on the th so users
+                // dont have to click on those tiny arrows
+                el = getNthColumn(i).querySelector('.sorter').parentElement;
+                if (el.addEventListener) {
+                    el.addEventListener('click', ithSorter(i));
+                } else {
+                    el.attachEvent('onclick', ithSorter(i));
+                }
+            }
+        }
+    }
+    // adds sorting functionality to the UI
+    return function() {
+        if (!getTable()) {
+            return;
+        }
+        cols = loadColumns();
+        loadData();
+        addSearchBox();
+        addSortIndicators();
+        enableUI();
+    };
+})();
+
+window.addEventListener('load', addSorting);

package/helpers/files.js

@@ -0,0 +1,75 @@
+const fs = require('node:fs').promises;
+const { join } = require('node:path');
+
+const getFilesPathWithInheritance = async ({
+  internalFolder,
+  externalFolder,
+  logger,
+  loggerFileType = '',
+  filter: { startWithCapital = true, notTests = true, notHidden = true } = {},
+}) => {
+  let [internalFiles, externalFiles] = await Promise.all([
+    fs.readdir(internalFolder, { recursive: true, withFileTypes: true }),
+    fs.readdir(externalFolder, { recursive: true, withFileTypes: true }),
+  ]);
+
+  const filterIndexFile = (fileDirent) => {
+    if (!fileDirent.isFile()) {
+      return false;
+    }
+    const fileArray = fileDirent.name.split('/');
+    const file = fileArray[fileArray.length - 1];
+    if (startWithCapital && file[0] !== file[0].toUpperCase()) {
+      // not start with capital
+      return false;
+    }
+    if (notTests && file.endsWith('.test.js')) {
+      return false;
+    }
+    if (notHidden && file[0] === '.') {
+      // not start with dot
+      return false;
+    }
+    return true;
+  };
+
+  internalFiles = internalFiles
+    .filter(filterIndexFile)
+    .map((fileDirent) =>
+      join(fileDirent.path, fileDirent.name).replace(`${internalFolder}/`, ''),
+    );
+  externalFiles = externalFiles
+    .filter(filterIndexFile)
+    .map((fileDirent) =>
+      join(fileDirent.path, fileDirent.name).replace(`${externalFolder}/`, ''),
+    );
+
+  const filesToLoad = [];
+  for (const file of internalFiles) {
+    if (externalFiles.includes(file)) {
+      logger(
+        `Skipping register INTERNAL file '${file}' ${
+          loggerFileType ? `of type ${loggerFileType}` : ''
+        } as it override by EXTERNAL ONE`,
+      );
+    } else {
+      filesToLoad.push({
+        path: `${internalFolder}/${file}`,
+        file,
+      });
+    }
+  }
+
+  for (const file of externalFiles) {
+    filesToLoad.push({
+      path: `${externalFolder}/${file}`,
+      file,
+    });
+  }
+  return filesToLoad;
+};
+
+module.exports = {
+  // eslint-disable-next-line import/prefer-default-export
+  getFilesPathWithInheritance,
+};

package/helpers/logger.js

@@ -0,0 +1,19 @@
+/* eslint-disable no-console */
+const levels = ['error', 'warn', 'info', 'http', 'verbose', 'debug', 'silly'];
+
+const consoleLogger = (level, message) => {
+  if (
+    !process.env.LOGGER_CONSOLE_LEVEL ||
+    levels.indexOf(process.env.LOGGER_CONSOLE_LEVEL) >= levels.indexOf(level)
+  ) {
+    if (console[level]) {
+      console[level](message);
+    } else {
+      console.log(message);
+    }
+  }
+};
+module.exports = {
+  levels,
+  consoleLogger,
+};

package/models/Migration.test.js

@@ -0,0 +1,19 @@
+import { describe, it, expect } from 'vitest';
+
+describe('migration model', () => {
+  it('migrationFile should be uniqe', async () => {
+    expect.assertions(1);
+    let errorCode;
+    const MigrationModel = global.server.app.getModel('Migration');
+    await MigrationModel.create({
+      migrationFile: 'a',
+    });
+    await MigrationModel.create({
+      migrationFile: 'a',
+    }).catch((e) => {
+      errorCode = e.code;
+    });
+
+    expect(errorCode).toBe(11000);
+  });
+});

package/models/User.test.js

@@ -59,7 +59,7 @@ describe('user model', () => {
         userEmail,
         'wrongPassword',
       );
-      expect(user).toBe(false);
+      expect(user).toBeFalsy();
     });
 
     it('should NOT with wrong email', async () => {
@@ -69,7 +69,7 @@ describe('user model', () => {
         'not@exists.com',
         userPassword,
       );
-      expect(user).toBe(false);
+      expect(user).toBeFalsy();
     });
   });
 
@@ -80,7 +80,7 @@ describe('user model', () => {
       const user = await global.server.app
         .getModel('User')
         .getUserByToken('fake one');
-      expect(user).toBe(false);
+      expect(user).toBeFalsy();
     });
 
     it('should  work for VALID token', async () => {

package/modules/AbstractController.js

@@ -227,9 +227,7 @@ class AbstractController extends Base {
               });
             }
             return routeObject.handler.call(this, req, res, next).catch((e) => {
-              this.logger.error(e.message);
-              // eslint-disable-next-line no-console
-              console.error(e);
+              this.logger.error(e);
               return res.status(500).json({
                 message:
                   'Platform error. Please check later or contact support',

package/modules/Base.js

@@ -1,5 +1,4 @@
-const fs = require('node:fs').promises;
-const { join, normalize } = require('node:path');
+const { getFilesPathWithInheritance } = require('../helpers/files');
 
 class Base {
   #realLogger = null;
@@ -36,60 +35,11 @@ class Base {
   }
 
   async getFilesPathWithInheritance(internalFolder, externalFolder) {
-    async function rreaddir(dir, allFiles = []) {
-      const files = (await fs.readdir(dir)).map((f) => join(dir, f));
-      allFiles.push(...files);
-      await Promise.all(
-        files.map(async (f) => {
-          if ((await fs.stat(f)).isDirectory()) {
-            allFiles.pop();
-            return rreaddir(f, allFiles);
-          }
-          return null;
-        }),
-      );
-      return allFiles.map((file) => file.replace(`${normalize(dir)}/`, ''));
-    }
-
-    let [internalFiles, externalFiles] = await Promise.all([
-      rreaddir(internalFolder),
-      rreaddir(externalFolder),
-    ]);
-
-    const filterIndexFile = (fileName) => {
-      const fileArray = fileName.split('/');
-      const file = fileArray[fileArray.length - 1];
-      return (
-        file[0] === file[0].toUpperCase() && // Start with capital
-        file[0] !== '.' && // not start with dot
-        !file.includes('.test.js') // not test files
-      );
-    };
-
-    internalFiles = internalFiles.filter(filterIndexFile);
-    externalFiles = externalFiles.filter(filterIndexFile);
-
-    const filesToLoad = [];
-    for (const file of internalFiles) {
-      if (externalFiles.includes(file)) {
-        this.logger.verbose(
-          `Skipping register INTERNAL file ${file} as it override by EXTERNAL ONE`,
-        );
-      } else {
-        filesToLoad.push({
-          path: `${internalFolder}/${file}`,
-          file,
-        });
-      }
-    }
-
-    for (const file of externalFiles) {
-      filesToLoad.push({
-        path: `${externalFolder}/${file}`,
-        file,
-      });
-    }
-    return filesToLoad;
+    return getFilesPathWithInheritance({
+      internalFolder,
+      externalFolder,
+      logger: (text) => this.logger.verbose(text),
+    });
   }
 
   /**

package/modules/BaseCli.js

@@ -47,11 +47,8 @@ class Cli extends Base {
       );
       return false;
     }
-    // TODO wait until https://github.com/nodejs/node/issues/35889
     const { default: Command } = await import(this.commands[command]);
 
-    // const Command = require(this.commands[command]);
-
     const c = new Command(this.app, this.commands, args);
     let result = false;
 

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@adaptivestone/framework",
-  "version": "4.7.0",
+  "version": "4.8.1",
   "description": "Adaptive stone node js framework",
   "main": "index.js",
   "engines": {
-    "node": ">=18.0.0"
+    "node": ">=18.17.0"
   },
   "repository": {
     "type": "git",
@@ -55,6 +55,7 @@
     "eslint": "^8.0.0",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-prettier": "^5.0.0",
     "eslint-plugin-vitest": "^0.3.1",
     "husky": "^8.0.0",
     "lint-staged": "^14.0.0",

package/server.d.ts

@@ -45,6 +45,20 @@ declare class Server {
    */
   startServer(callbackBefore404?: Promise<null>): Promise<null>;
 
+  /**
+   * Do an initialization (config reading,  etc)
+   * @returns {Promise}
+   */
+  init(
+    options: { isSkipModelInit: boolean } = { isSkipModelInit: false },
+  ): Promise<boolean>;
+
+  /**
+   * Load model and init them
+   * @returns {Promise}
+   */
+  initAllModels(): Promise<void>;
+
   /**
    * Return config from {configName} (file name) on config folder.
    * Support cache and updating confing into cache