groupcore-utils 3.0.3 → 4.0.0

package/.eslintrc.json

@@ -9,17 +9,17 @@
     "ecmaVersion": 12
   },
   "rules": {
-    "no-underscore-dangle": "off",
-    "class-methods-use-this": "off",
-    "no-console": "off",
-    "jest/no-hooks": "off",
-    "jest/no-test-return-statement": "off",
-    "jest/prefer-strict-equal": "off",
-    "consistent-return": "off",
-    "array-callback-return": "off",
-    "no-param-reassign": "off",
-    "no-restricted-syntax": "off",
-    "prefer-destructuring": "off",
-    "no-case-declarations": "off"
+//    "no-underscore-dangle": "off",
+//    "class-methods-use-this": "off",
+//    "no-console": "off",
+//    "jest/no-hooks": "off",
+//    "jest/no-test-return-statement": "off",
+//    "jest/prefer-strict-equal": "off",
+//    "consistent-return": "off",
+//    "array-callback-return": "off",
+//    "no-param-reassign": "off",
+//    "no-restricted-syntax": "off",
+//    "prefer-destructuring": "off",
+//    "no-case-declarations": "off"
   }
 }

package/Utils.js

@@ -1,6 +1,5 @@
 const axios = require('axios');
-const _isEmpty = require('lodash').isEmpty;
-const _isUndefined = require('lodash').isUndefined;
+const { isEmpty, isUndefined } = require('lodash');
 
 class Utils {
   /**
@@ -9,7 +8,7 @@ class Utils {
    * @param {string} apiToken - The Core API token to authenticate and authorize access
    * @param {string} apiUrl - The Core API URL provided during Core setup
    */
-  constructor({ projectId, apiToken, apiUrl }) {
+  constructor(projectId, apiToken, apiUrl) {
     this.project = projectId;
     this.token = apiToken;
     this.apiUrl = apiUrl;
@@ -23,10 +22,10 @@ class Utils {
    * @param {number} [leadId=null] - The lead ID, if the addLead method is called before submission
    * @returns {Promise}
    */
-  submitForm({ formData, formId, email, leadId = 0 }) {
+  submitForm(formData, formId, email, leadId = 0) {
     return new Promise((resolve, reject) => {
-      if (_isEmpty(formData) || _isEmpty(String(formId)) || _isEmpty(email)) {
-        reject({ error: 'Missing some required params' });
+      if (isEmpty(formData) || isEmpty(String(formId)) || isEmpty(email)) {
+        reject(new Error('Missing some required params'));
         return;
       }
 
@@ -47,7 +46,7 @@ class Utils {
           resolve(response);
         })
         .catch(() => {
-          reject({ error: 'API error' });
+          reject(new Error('API error'));
         });
     });
   }
@@ -62,22 +61,22 @@ class Utils {
    * @param {string} [attachmentUrl] - The location of the attachment. Optional if hasAttachment is false
    * @returns {Promise}
    */
-  sendMail({ recipientEmail, subject, htmlBody, hasAttachment = false, attachmentFilename, attachmentUrl }) {
+  sendMail(recipientEmail, subject, htmlBody, attachmentFilename, attachmentUrl, hasAttachment = false) {
     return new Promise((resolve, reject) => {
       if (hasAttachment) {
-        if (_isEmpty(attachmentFilename) || _isEmpty(attachmentUrl)) {
-          reject({ error: 'Some missing params. If hasAttachment is true, both attachmentFilename and attachmentUrl are required' });
+        if (isEmpty(attachmentFilename) || isEmpty(attachmentUrl)) {
+          reject(new Error('Some missing params. If hasAttachment is true, both attachmentFilename and attachmentUrl are required'));
           return;
         }
       }
 
       if (!hasAttachment && (attachmentFilename || attachmentUrl)) {
-        reject({ error: 'If hasAttachment is false, both attachmentFilename and attachmentUrl cannot be accepted' });
+        reject(new Error('If hasAttachment is false, both attachmentFilename and attachmentUrl cannot be accepted'));
         return;
       }
 
-      if (_isEmpty(recipientEmail) || _isEmpty(subject) || _isEmpty(htmlBody)) {
-        reject({ error: 'Missing some required params' });
+      if (isEmpty(recipientEmail) || isEmpty(subject) || isEmpty(htmlBody)) {
+        reject(new Error('Missing some required params'));
         return;
       }
 
@@ -99,7 +98,7 @@ class Utils {
           resolve(response);
         })
         .catch(() => {
-          reject({ error: 'API error' });
+          reject(new Error('API error'));
         });
     });
   }
@@ -112,10 +111,10 @@ class Utils {
    * @param {string} email - The email address of the lead
    * @returns {Promise}
    */
-  addLead({ firstname, lastname, phone = null, email }) {
+  addLead(firstname, lastname, email, phone) {
     return new Promise((resolve, reject) => {
-      if (_isEmpty(firstname) || _isEmpty(lastname) || _isEmpty(email)) {
-        reject({ error: 'Missing some required params' });
+      if (isEmpty(firstname) || isEmpty(lastname) || isEmpty(email)) {
+        reject(new Error('Missing some required params'));
         return;
       }
 
@@ -127,7 +126,7 @@ class Utils {
           firstname,
           lastname,
           email,
-          phone,
+          phone: phone || null,
         },
         headers: {
           token: this.token,
@@ -137,7 +136,7 @@ class Utils {
           resolve(response);
         })
         .catch(() => {
-          reject({ error: 'API error' });
+          reject(new Error('API error'));
         });
     });
   }
@@ -147,10 +146,10 @@ class Utils {
    * @param {number} groupId - The ID of the Core inventory group
    * @returns {Promise}
    */
-  async getGroupInventory({ groupId }) {
+  async getGroupInventory(groupId) {
     return new Promise((resolve, reject) => {
-      if (_isUndefined(groupId)) {
-        reject({ error: 'Missing some required params' });
+      if (isUndefined(groupId)) {
+        reject(new Error('Missing some required params'));
         return;
       }
 
@@ -165,7 +164,7 @@ class Utils {
           resolve(response.data[0]);
         })
         .catch(() => {
-          reject({ error: 'API error' });
+          reject(new Error('API error'));
         });
     });
   }
@@ -175,10 +174,10 @@ class Utils {
    * @param {number} groupId - The ID of the Core inventory group
    * @returns {Promise}
    */
-  async getSectionContent({ groupId }) {
+  async getSectionContent(groupId) {
     return new Promise((resolve, reject) => {
-      if (_isUndefined(groupId)) {
-        reject({ error: 'Missing some required params' });
+      if (isUndefined(groupId)) {
+        reject(new Error('Missing some required params'));
         return;
       }
 
@@ -193,7 +192,7 @@ class Utils {
           resolve(response.data);
         })
         .catch(() => {
-          reject({ error: 'API error' });
+          reject(new Error('API error'));
         });
     });
   }

package/communication/mail.js

@@ -1,4 +1,4 @@
-const nodemailer = require("nodemailer");
+const nodemailer = require('nodemailer');
 
 module.exports = class {
   /**
@@ -8,14 +8,14 @@ module.exports = class {
    * @param username {string} - smtp username
    * @param password {password} - smtp password
    */
-  constructor({ hostname, port, username, password }) {
+  constructor(hostname, port, username, password) {
     this.hostname = hostname;
     this.port = port;
     this.username = username;
     this.password = password;
   }
 
-  async _init() {
+  async init() {
     this.transporter = nodemailer.createTransport({
       host: this.hostname,
       port: this.port,
@@ -40,15 +40,15 @@ module.exports = class {
    * @param from {string} - sender email address
    * @returns {Promise<*>}
    */
-  async send({ email, subject, message, attachment = null, from }) {
-    await this._init();
+  async send(email, subject, message, from, attachment) {
+    await this.init();
 
     return this.transporter.sendMail({
       subject,
       from,
       to: email,
       html: message,
-      attachments: attachment,
+      attachments: attachment || null,
     });
   }
 };

package/database/crud.js

@@ -7,7 +7,7 @@ module.exports = class {
    * @param {string} dbTable - name of the table
    * @param {object} db - the initialised db instance
    */
-  constructor({ dbTable, db }) {
+  constructor(dbTable, db) {
     this.dbTable = dbTable;
     this.db = db;
   }
@@ -16,12 +16,10 @@ module.exports = class {
    * @method create()
    * @description Insert values into db
    * @param {Object} data - the key value pair of the data to be inserted into the db
-   * @param {Boolean} unique - if set to true, ensure no duplication of data during creation
-   * @param {Array} ignore - fields to ignore when checking for unique values
    * @returns {Promise | string | Object} - resolves if successfully and rejects if there's an error
    */
 
-  async create({ data }) {
+  async create(data) {
     const fields = Object.keys(data).join(',');
 
     const rawValues = [];
@@ -44,9 +42,9 @@ module.exports = class {
    * @param {Array} orderBy - explicitly specify the order, either asc or desc
    * @returns {Promise}
    */
-  read({ where, orderBy }) {
+  read(where = false, orderBy = []) {
     if (where && !_.has(where, 'fields')) {
-      return this.readV1({ where, orderBy });
+      return this.readV1(where, orderBy);
     }
 
     let query;
@@ -79,7 +77,7 @@ module.exports = class {
   }
 
   // should be deprecated soon
-  readV1({ where, orderBy }) {
+  readV1(where = false, orderBy = false) {
     let query;
 
     if (orderBy) {
@@ -104,26 +102,21 @@ module.exports = class {
    * @param {number} id - id in where clause
    * @returns {Promise}
    */
-  update({ data, id }) {
+  update(data, id) {
     // variable to hold the dynamic part of the update sql query
     let updateQuery = '';
 
     // set this to be used inside the map function to check when we get to the last index key so that we dont add the comma to the last key in the generated sql query
-    const count = Object.keys(data).length - 1; // adding -1 because we are taking out 'id' in the filter method
     Object.keys(data)
       .filter((key) => key !== 'id')
-      .forEach((key, i) => {
-        if (count - i === 1) {
-          updateQuery += `${key} = '${escapeQuotes(data[key])}'`;
-        } else {
-          updateQuery += `${key} = '${escapeQuotes(data[key])}', `;
-        }
+      .forEach((key) => {
+        updateQuery += `${key} = '${escapeQuotes(data[key])}', `;
         return true;
       });
 
     const query = `update ${this.dbTable} set ${updateQuery} where id = '${id}'`;
 
-    return this.db.query(query);
+    return this.db.query(query.replace(',  where', ' where')); // using replace to remove the last comma before the where clause
   }
 
   /**
@@ -132,18 +125,18 @@ module.exports = class {
    * @param {number} id - id of data to deleted
    * @returns {Promise}
    */
-  delete({ id }) {
+  delete(id) {
     return this.db.query(`delete from ${this.dbTable} where id = '${id}'`);
   }
 
   /**
    * @method query()
    * @description make a custom db query
-   * @param {string} statement - SQL query
+   * @param {string} query - SQL query
    * @returns {Promise}
    */
   // eslint-disable-next-line class-methods-use-this
-  query({ statement }) {
-    return this.db.query(statement);
+  query(query) {
+    return this.db.query(query);
   }
 };

package/database/init.js

@@ -1,4 +1,4 @@
-const mysql = require("mysql");
+const mysql = require('mysql');
 
 module.exports = class {
   /**
@@ -9,7 +9,7 @@ module.exports = class {
    * @param {string} db - db name
    * @param {string} socket - path to a unix domain socket to connect to. when used host and port are ignored
    */
-  constructor({ host, user, password, db, socket }) {
+  constructor(host, user, password, db, socket) {
     this.host = host;
     this.user = user;
     this.password = password;

package/package.json

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

package/rbac/index.js

@@ -8,7 +8,7 @@ module.exports = class {
    * @param {number} compareId - id to be compared
    * @returns {Promise<void>}
    */
-  async validateAction({ id, compareId }) {
+  static async validateAction(id, compareId) {
     const rbac = new EasyRbac({
       user: {
         can: [

package/rest/index.js

@@ -6,19 +6,14 @@ module.exports = {
    * @description send a GET request
    * @param {string} url - api url
    * @param {object} headers - headers to be added to request
-   * @returns {AxiosPromise<any>}
+   * @returns {Promise<any>}
    */
-  async get({ url, headers }) {
-    try {
-      return axios({
-        url,
-        headers,
-        method: 'get',
-      });
-    } catch (err) {
-      console.log('Axios GET Error:', err.message);
-      throw err;
-    }
+  async get(url, headers = []) {
+    return axios({
+      url,
+      headers,
+      method: 'get',
+    });
   },
 
   /**
@@ -27,20 +22,15 @@ module.exports = {
    * @param {string} url - api url
    * @param {object} data - payload
    * @param {object} headers - headers to be added to request
-   * @returns {AxiosPromise<any>}
+   * @returns {Promise<any>}
    */
-  async post({ url, data, headers }) {
-    try {
-      return axios({
-        url,
-        data,
-        headers,
-        method: 'post',
-      });
-    } catch (err) {
-      console.log('Axios POST Error:', err.message);
-      throw err;
-    }
+  async post(url, data, headers = []) {
+    return axios({
+      url,
+      data,
+      headers,
+      method: 'post',
+    });
   },
 
   /**
@@ -49,20 +39,15 @@ module.exports = {
    * @param {string} url - api url
    * @param {object} data - payload
    * @param {object} headers - headers to be added to request
-   * @returns {AxiosPromise<any>}
+   * @returns {Promise<any>}
    */
-  async put({ url, data, headers }) {
-    try {
-      return axios({
-        url,
-        data,
-        headers,
-        method: 'put',
-      });
-    } catch (err) {
-      console.log('Axios PUT Error:', err.message);
-      throw err;
-    }
+  async put(url, data, headers = []) {
+    return axios({
+      url,
+      data,
+      headers,
+      method: 'put',
+    });
   },
 
   /**
@@ -71,39 +56,29 @@ module.exports = {
    * @param {string} url - api url
    * @param {object} data - payload
    * @param {object} headers - headers to be added to request
-   * @returns {AxiosPromise<any>}
+   * @returns {Promise<any>}
    */
-  async patch({ url, data, headers }) {
-    try {
-      return axios({
-        url,
-        data,
-        headers,
-        method: 'patch',
-      });
-    } catch (err) {
-      console.log('Axios PUT Error:', err.message);
-      throw err;
-    }
+  async patch(url, data, headers = []) {
+    return axios({
+      url,
+      data,
+      headers,
+      method: 'patch',
+    });
   },
 
   /**
    * @method delete()
    * @description send DELETE request
-   * @param {string} urls - api url
+   * @param {string} url - api url
    * @param {object} headers - headers to be added to request
-   * @returns {AxiosPromise<any>}
+   * @returns {Promise<any>}
    */
-  async delete({ url, headers }) {
-    try {
-      return axios({
-        url,
-        headers,
-        method: 'delete',
-      });
-    } catch (err) {
-      console.log('Axios DELETE Error:', err.message);
-      throw err;
-    }
+  async delete(url, headers = []) {
+    return axios({
+      url,
+      headers,
+      method: 'delete',
+    });
   },
 };

package/security/encryption.js

@@ -14,7 +14,7 @@ module.exports = class {
    * @param {string} text - text to be hashed
    * @returns {*}
    */
-  hash({ text }) {
+  hash(text) {
     return bcrypt.hashSync(text, bcrypt.genSaltSync(this.saltRounds));
   }
 
@@ -25,7 +25,7 @@ module.exports = class {
    * @param {string} text - the text to be compared with the hash
    * @returns {*}
    */
-  verify({ hash, text }) {
+  static verify(hash, text) {
     return bcrypt.compareSync(text, hash);
   }
 };

package/security/jwt.js

@@ -3,10 +3,10 @@ const jwt = require('jsonwebtoken');
 module.exports = class {
   /**
    * @description constructor
-   * @param {string} jwtKey - jwt key
+   * @param {string} key - jwt key
    */
-  constructor({ jwtKey }) {
-    this.jwtKey = jwtKey;
+  constructor(key) {
+    this.key = key;
   }
 
   /**
@@ -15,17 +15,17 @@ module.exports = class {
    * @param {object} payload - payload to be tokenized
    * @returns {*}
    */
-  jwtSign({ payload }) {
-    return jwt.sign(payload, this.jwtKey);
+  sign(payload) {
+    return jwt.sign(payload, this.key);
   }
 
   /**
    * @method jwtDecode()
    * @description decode a JWT token
    * @param {string} token - JWT token to be decoded
-   * @returns {{payload: any, signature: *, header: *}|*|SourceMapPayload|TokenPayload}
+   * @returns {{payload: any, signature: *, header: *}}
    */
-  jwtDecode({ token }) {
+  static decode(token) {
     return jwt.decode(token);
   }
 
@@ -35,7 +35,7 @@ module.exports = class {
    * @param {string} token - token to be verified
    * @returns {*}
    */
-  jwtVerify({ token }) {
-    return jwt.verify(token, this.jwtKey);
+  verify(token) {
+    return jwt.verify(token, this.key);
   }
 };

package/test-utils/mocks/response.js

@@ -1,14 +1,14 @@
 module.exports = class {
   constructor() {
-    jest.spyOn(this, "send").mockImplementation((body) => body);
-    jest.spyOn(this, "status").mockImplementation(() => this);
+    jest.spyOn(this, 'send').mockImplementation((body) => body);
+    jest.spyOn(this, 'status').mockImplementation(() => this);
   }
 
-  send() {
+  static send() {
     return true;
   }
 
-  status() {
+  static status() {
     return true;
   }
 };

package/timestamp/index.js

@@ -6,7 +6,7 @@ module.exports = class {
    * @description returns the present unix timestamp
    * @returns {number}
    */
-  now() {
+  static now() {
     return moment().unix();
   }
 
@@ -17,7 +17,7 @@ module.exports = class {
    * @param {string} format - the format to use, default is 'MMMM DD, YYYY'
    * @returns {string}
    */
-  unixToDate({ unix, format = 'MMMM DD, YYYY' }) {
+  static unixToDate(unix, format) {
     return moment.unix(unix).format(format);
   }
 
@@ -28,7 +28,7 @@ module.exports = class {
    * @param {string} format - the format of the date
    * @returns {number}
    */
-  dateToUnix({ date, format }) {
+  static dateToUnix(date, format) {
     return moment(date, format).valueOf() / 1000;
   }
 
@@ -38,7 +38,7 @@ module.exports = class {
    * @param {string} unix - unix timestamp
    * @returns {number}
    */
-  unixToStartOfDay(unix) {
+  static unixToStartOfDay(unix) {
     return new Date(unix * 1000).setHours(0, 0, 0, 0) / 1000;
   }
 
@@ -48,7 +48,7 @@ module.exports = class {
    * @param {string} unix - unix timestamp
    * @returns {number}
    */
-  unixToEndOfDay(unix) {
+  static unixToEndOfDay(unix) {
     return new Date(unix * 1000).setHours(23, 59, 59, 999) / 1000;
   }
 
@@ -58,8 +58,8 @@ module.exports = class {
    * @param {string} time - time to be converted
    * @returns {number}
    */
-  toSeconds(time) {
-    time = time.split(':');
-    return time[0] * 3600 + time[1] * 60;
+  static toSeconds(time) {
+    const splitTime = time.split(':');
+    return splitTime[0] * 3600 + splitTime[1] * 60;
   }
 };