groupcore-utils 1.0.1 → 1.2.3

package/Utils.js

@@ -1,16 +1,30 @@
 const axios = require('axios');
 const _isEmpty = require('lodash').isEmpty;
+const _isUndefined = require('lodash').isUndefined;
 
 class Utils {
+  /**
+   * The project-specific details when creating an instance. All details can be gotten from your Core account
+   * @param {number} projectId - The Core project ID
+   * @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 }) {
     this.project = projectId;
     this.token = apiToken;
     this.apiUrl = apiUrl;
   }
 
+  /**
+   * Submit a form to the Core Lead Management module
+   * @param {object} formData - Key-value pair of all form fields to be submitted
+   * @param {number} formId - The ID of the Core form for the submission
+   * @param {string} email - The email address of the submitter
+   * @param {number} [leadId=null] - The lead ID, if the addLead method is called before submission
+   * @returns {Object.<{error: string}>|Promise.<Object.<{insertId: number}>>} - Returns an error or a promise that resolves to an object
+   */
   submitForm({ formData, formId, email, leadId = 0 }) {
     if (_isEmpty(formData) || _isEmpty(String(formId)) || _isEmpty(email)) {
-      console.log('got here');
       return { error: 'Missing some required params' };
     }
 
@@ -29,6 +43,16 @@ class Utils {
     });
   }
 
+  /**
+   * Send an email message from your Core account.
+   * @param {string} recipientEmail - Email address of recipient
+   * @param {string} subject - Subject of the email
+   * @param {string} htmlBody - HTML body of the email message
+   * @param {boolean} [hasAttachment] - Specify if an attachment will be sent with the email
+   * @param {string} [attachmentFilename] - Choose the filename of the attachment. Optional if hasAttachment is false
+   * @param {string} [attachmentUrl] - The location of the attachment. Optional if hasAttachment is false
+   * @returns {Object.<{error: string}>|Promise.<Object.<{insertId: number}>>} - Returns an error or a promise that resolves to an object
+   */
   sendMail({ recipientEmail, subject, htmlBody, hasAttachment = false, attachmentFilename, attachmentUrl }) {
     if (hasAttachment) {
       if (_isEmpty(attachmentFilename) || _isEmpty(attachmentUrl)) {
@@ -60,6 +84,14 @@ class Utils {
     });
   }
 
+  /**
+   * Add a lead to the Core Lead Management module
+   * @param {string} firstname - The first name of the lead
+   * @param {string} lastname - The last name of the lead
+   * @param {string} phone - The phone number of the lead
+   * @param {string} email - The email address of the lead
+   * @returns {Object.<{error: string}>|Promise.<Object.<{insertId: number}>>} - Returns an error or a promise that resolves to an object
+   */
   addLead({ firstname, lastname, phone = null, email }) {
     if (_isEmpty(firstname) || _isEmpty(lastname) || _isEmpty(email)) {
       return { error: 'Missing some required params' };
@@ -80,6 +112,31 @@ class Utils {
       },
     });
   }
+
+  /**
+   * get inventory by group
+   * @param {number} groupId - The ID of the Core inventory group
+   * @returns {Object.<{error: string}>|Promise.<Object>} - Returns an error or a promise that resolves to an object
+   */
+  async getGroupInventory({ groupId }) {
+    if (_isUndefined(groupId)) {
+      return { error: 'Missing some required params' };
+    }
+
+    try {
+      const response = await axios({
+        method: 'GET',
+        url: `${this.apiUrl}/inv/groups?id=${groupId}`,
+        headers: {
+          token: this.token,
+        },
+      });
+
+      return response.data[0];
+    } catch (e) {
+      return { error: 'API error' };
+    }
+  }
 }
 
 module.exports = Utils;

package/Utils.spec.js

@@ -89,3 +89,35 @@ describe('Testing Utils.addLead()', () => {
     expect(response).toEqual(error);
   });
 });
+
+describe('Testing Utils.getGroupInventory', () => {
+  it('Should return the right response', async () => {
+    axios.mockResolvedValue([
+      {
+        id: 13,
+        item: '{"item":"test","price":12.34}',
+        inventoryGroup: 6,
+        status: 0,
+        dateAdded: 0,
+        cost: 8,
+        data: {
+          test: 'test',
+        },
+      },
+    ]);
+
+    const response = await util.getGroupInventory({ groupId: 6 });
+    expect(response.id).toEqual(13);
+  });
+
+  it('Should validate the group ID param', async () => {
+    const response = await util.getGroupInventory({ groups: 6 });
+    expect(response).toEqual({ error: 'Missing some required params' });
+  });
+
+  it('Should catch any errors during API call', async () => {
+    axios.mockRejectedValue();
+    const response = await util.getGroupInventory({ groupId: 6 });
+    expect(response).toEqual({ error: 'API error' });
+  });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "groupcore-utils",
-  "version": "1.0.1",
+  "version": "1.2.3",
   "description": "Utilities for working with some Core features",
   "main": "Utils.js",
   "scripts": {
@@ -8,20 +8,20 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/TheGroupC/groupcore-utils.git"
+    "url": "https://bitbucket.org/thegroupc/groupcore-utils/src/master"
   },
-  "author": "Ken Sawyerr",
+  "author": "Ken",
   "license": "ISC",
   "bugs": {
-    "url": "https://github.com/TheGroupC/groupcore-utils/issues"
+    "url": "https://bitbucket.org/thegroupc/groupcore-utils/src/master"
   },
-  "homepage": "https://github.com/TheGroupC/groupcore-utils#readme",
+  "homepage": "https://bitbucket.org/thegroupc/groupcore-utils/src/master",
   "dependencies": {
     "axios": "^0.23.0",
-    "lodash": "^4.17.21",
-    "prettier": "^2.4.1"
+    "lodash": "^4.17.21"
   },
   "devDependencies": {
-    "jest": "^27.2.5"
+    "jest": "^27.2.5",
+    "prettier": "^2.4.1"
   }
 }