groupcore-utils 2.0.0 → 2.2.0

package/README.md

@@ -324,6 +324,19 @@ Initialize db with this and pass the object to the CRUD class constructor
    */   
 ```
 
+### RBAC
+```
+  require('@groupcollab/core-utils/rbac')
+
+  /**
+   * @method validateAction()
+   * @description validate the action to be carried out
+   * @param {number} id - the main id
+   * @param {number} compareId - id to be compared
+   * @returns {Promise<void>}
+   */
+```
+
 ### Testing
 ```
 npm run test

package/database/crud.js

@@ -121,4 +121,39 @@ module.exports = class {
   query({ statement }) {
     return this.db.query(statement);
   }
+
+  /**
+   * @method join
+   * @description join two or more tables during db query
+   * @param tables {array} - list of tables to join, object in the shape {table: <string>, fields: <array>}
+   * @param joins {array} - list of the joins in the shape {table: <string>, id: <string>}
+   * @param whereClauses {array} - list of where clauses in the shape {table: <string>, key: <string>, value: <string|integer>}
+   * @param mainTable {string} -  the main table from the to join others
+   * @param mainId {string} - the id to join on the main table, expected to be the primary key if the main table
+   */
+  join({ tables = [], joins = [], whereClauses = [], mainTable, mainId }) {
+    // build join query
+    let query = 'select ';
+    tables.forEach((table) => {
+      table.fields.forEach((field) => {
+        query += `${table.table}.${field}, `;
+      });
+    });
+
+    query += `from ${mainTable} `;
+
+    joins.forEach((join) => {
+      query += `inner join ${join.table} on ${mainTable}.${mainId} = ${join.table}.${join.id} `;
+    });
+
+    query += ' where ';
+    whereClauses.forEach((clause) => {
+      query += `${clause.table}.${clause.key} = ${clause.value} `;
+    });
+
+    query = query.replace(', from', ' from');
+    query = query.replace(' where', 'where');
+
+    return query.trim();
+  }
 };

package/database/crud.spec.js

@@ -0,0 +1,36 @@
+const Crud = require('./crud');
+
+test('should generate the join right query - 2 tables', () => {
+  const tables = [
+    { table: 'users', fields: ['name', 'address'] },
+    { table: 'categories', fields: ['name'] },
+  ];
+
+  const joins = [{ table: 'categories', id: 'user' }];
+
+  const whereClauses = [{ table: 'users', key: 'id', value: 10 }];
+  const query = new Crud({ dbTable: 'test', db: 'test' }).join({ tables, joins, whereClauses, mainTable: 'users', mainId: 'id' });
+
+  expect(query).toBe('select users.name, users.address, categories.name from users inner join categories on users.id = categories.user where users.id = 10');
+});
+
+test('should generate the right join query - 3 tables', () => {
+  const tables = [
+    { table: 'users', fields: ['name', 'address'] },
+    { table: 'categories', fields: ['name'] },
+    { table: 'ages', fields: ['age'], id: 'user' },
+  ];
+
+  const joins = [
+    { table: 'categories', id: 'user' },
+    { table: 'ages', id: 'user' },
+  ];
+
+  const whereClauses = [{ table: 'users', key: 'id', value: 10 }];
+
+  const query = new Crud({ dbTable: 'test', db: 'test' }).join({ tables, joins, whereClauses, mainTable: 'users', mainId: 'id' });
+
+  expect(query).toBe(
+    'select users.name, users.address, categories.name, ages.age from users inner join categories on users.id = categories.user inner join ages on users.id = ages.user where users.id = 10'
+  );
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "groupcore-utils",
-  "version": "2.0.0",
+  "version": "2.2.0",
   "description": "Utilities for working with some core features",
   "main": "Utils.js",
   "scripts": {

package/rbac/index.js

@@ -0,0 +1,32 @@
+const EasyRbac = require('easy-rbac');
+
+module.exports = class {
+  /**
+   * @method validateAction()
+   * @description validate the action to be carried out
+   * @param {number} id - the main id
+   * @param {number} compareId - id to be compared
+   * @returns {Promise<void>}
+   */
+  async validateAction({ id, compareId }) {
+    const rbac = new EasyRbac({
+      user: {
+        can: [
+          {
+            name: 'do',
+            when: async (params) => params.id === params.compareId,
+          },
+        ],
+      },
+    });
+
+    const response = await rbac.can('user', 'do', {
+      id,
+      compareId,
+    });
+
+    if (!response) {
+      throw new Error('User not authorized to perform this action!');
+    }
+  }
+};