Chore: Add Examples (#9)

* changes

* increase code coverage and create utils library

* add examples for 1.0 and 2.0

* cleanup examples and update readme

* change module version

* change version

* fix lint warnings

Author: lukaszMycs

.eslintrc.js

@@ -1,10 +1,12 @@
 module.exports = {
   "plugins": [
-    "suitescript"
+    "suitescript", "jest"
   ],
   "extends": "airbnb-base",
   "env": {
+    browser: true,
     "jest": true,
+    "jasmine": true,
     "suitescript/suitescript2": true,
     "suitescript/suitescript1": true
   },

Examples/1.0/exampleClientScript.js

@@ -0,0 +1,43 @@
+require('../../index')({});
+
+/**
+   * Save Record Function
+   * @returns {Boolean}
+  */
+function saveRecord() {
+  try {
+    if (nlapiGetRecordType().toString() !== 'salesorder') {
+      return true;
+    }
+    const subId = parseInt(nlapiGetFieldValue('subsidiary'), 10);
+
+
+    // Do not trigger for polish subsidiary and custom orders
+    if (subId === 1) {
+      return true;
+    }
+    const confirmMessage = "Do you want to auto approve this order?\nIf yes click on 'Ok' button.\nIf not please click on 'Cancel' button";
+    // eslint-disable-next-line no-restricted-globals, no-alert
+    if (confirm(confirmMessage)) {
+      nlapiSetFieldValue('custbody_mycs_auto_approva_manual_ord', 'T');
+    }
+
+    return true;
+  } catch (e) {
+    let details = '';
+    if (e instanceof nlobjError) {
+      details = `${e.getCode()}\n${e.getDetails()}`;
+    } else {
+      details = e.toString();
+    }
+
+    // eslint-disable-next-line no-alert
+    alert(`Unexpected Error occured: ${details}`);
+    return true;
+  }
+}
+if (typeof module !== 'undefined' && module.exports) {
+  module.exports = {
+    saveRecord,
+  };
+}

Examples/1.0/exampleClientScript.test.js

@@ -0,0 +1,61 @@
+const fileUnderTest = require('./exampleClientScript');
+
+describe('salesorder_CL', () => {
+  describe('saveRecord()', () => {
+    it('should set field value  for subsidiary greater than 1 after user confirmation', () => {
+      const values = {
+        subsidiary: random(2, 10),
+      };
+      const spyRecordType = spyOn(global, 'nlapiGetRecordType').and.returnValue('salesorder');
+      const spyGetValue = spyOn(global, 'nlapiGetFieldValue').and.callFake(fieldName => values[fieldName]);
+      const spySet = spyOn(global, 'nlapiSetFieldValue').and.callThrough();
+      const spyAlert = spyOn(window, 'alert').and.callThrough();
+      const spyConfirm = spyOn(window, 'confirm').and.returnValue(true);
+      const result = fileUnderTest.saveRecord();
+      expect(spyRecordType).toHaveBeenCalled();
+      expect(spyGetValue).toHaveBeenCalledWith('subsidiary');
+      expect(spyConfirm).toHaveBeenCalledWith(
+        'Do you want to auto approve this order?\nIf yes click on \'Ok\' button.\nIf not please click on \'Cancel\' button',
+      );
+      expect(spyAlert).not.toHaveBeenCalled();
+      expect(spySet).toHaveBeenCalledWith('custbody_mycs_auto_approva_manual_ord', 'T');
+      expect(result).toEqual(true);
+    });
+    it('should not display confirm and retun true for subsidiary 1 ', () => {
+      const values = {
+        subsidiary: 1,
+      };
+      const spyRecordType = spyOn(global, 'nlapiGetRecordType').and.returnValue('salesorder');
+      const spyGetValue = spyOn(global, 'nlapiGetFieldValue').and.callFake(fieldName => values[fieldName]);
+      const spyAlert = spyOn(window, 'alert').and.callThrough();
+      const spyConfirm = spyOn(window, 'confirm').and.callThrough();
+      const result = fileUnderTest.saveRecord();
+      expect(spyRecordType).toHaveBeenCalled();
+      expect(spyGetValue).toHaveBeenCalledWith('subsidiary');
+      expect(spyConfirm).not.toHaveBeenCalled();
+      expect(spyAlert).not.toHaveBeenCalled();
+      expect(result).toEqual(true);
+    });
+    it('should display alert in case of Javascript error', () => {
+      const spyRecordType = spyOn(global, 'nlapiGetRecordType').and.returnValue('salesorder');
+      spyOn(global, 'nlapiGetFieldValue').and.throwError('Test');
+      const spyAlert = spyOn(window, 'alert').and.callThrough();
+      const result = fileUnderTest.saveRecord();
+      expect(spyRecordType).toHaveBeenCalled();
+      expect(spyAlert).toHaveBeenCalledWith(expect.stringContaining('Unexpected Error occured:'));
+      expect(result).toEqual(true);
+    });
+    it('should display alert in case of NetSuite error', () => {
+      spyOn(global, 'nlapiGetFieldValue').and.callFake(() => {
+        // eslint-disable-next-line new-cap
+        throw new nlobjError('Test');
+      });
+      const spyRecordType = spyOn(global, 'nlapiGetRecordType').and.returnValue('salesorder');
+      const spyAlert = spyOn(window, 'alert').and.callThrough();
+      const result = fileUnderTest.saveRecord();
+      expect(spyRecordType).toHaveBeenCalled();
+      expect(spyAlert).toHaveBeenCalledWith(expect.stringContaining('Unexpected Error occured:'));
+      expect(result).toEqual(true);
+    });
+  });
+});

Examples/2.0/exampleClientScript.js

@@ -0,0 +1,53 @@
+/**
+ * @NApiVersion 2.x
+ * @NScriptType ClientScript
+ */
+
+/**
+  * This is an example of client script file.
+  * In corresponding .test.js file you can find a way how to test it
+  * of course with our ns-suitescript-mocks
+  */
+
+// Line below is required only becasue we are in the same repository as the library,
+// normally define is added to globally once you import our library and follow setup instructions
+const { define } = require('../../index')({});
+
+// eslint-disable-next-line import/no-amd
+define(['N/ui/message'], (msg) => {
+  /**
+     * Page Init function to show message after form submit
+     *
+     * @param {N/context} context Module
+     * @returns {boolean}
+     */
+  function pageInit(context) {
+    // eslint-disable-next-line prefer-destructuring
+    const currentRecord = context.currentRecord;
+    const myMsg = msg.create({
+      title: 'Checkbox was checked',
+      message: 'Checkbox was checked!',
+      type: msg.Type.CONFIRMATION,
+    });
+    const showMessage = currentRecord.getValue({
+      fieldId: 'messageonpost',
+    });
+    if (showMessage) {
+      myMsg.show({
+        duration: 5000,
+      });
+    }
+
+    return true;
+  }
+  // required for node
+  if (typeof module !== 'undefined' && module.exports) {
+    module.exports = {
+      pageInit,
+      message: msg,
+    };
+  }
+  return {
+    pageInit,
+  };
+});

Examples/2.0/exampleClientScript.test.js

@@ -0,0 +1,72 @@
+const fileUnderTest = require('./exampleClientScript');
+
+const defaultValues = {
+  tranid: '12121',
+  custbody_mycs_ship_method: 23,
+  shipstatus: 'B',
+  custbodysps_packagedetails: 'test',
+};
+const fulfillmentRecord = nlapiCreateRecord('itemfulfillment', defaultValues);
+const context = {
+  currentRecord: fulfillmentRecord,
+};
+
+describe('exampleClientScript.js', () => {
+  describe('pageInit', () => {
+    it('should return true', () => {
+      const result = fileUnderTest.pageInit(context);
+      expect(result).toBe(true);
+    });
+    it('should call create message method', () => {
+      // eslint-disable-next-line prefer-destructuring
+      const message = fileUnderTest.message;
+      const spyMesage = spyOn(message, 'create');
+      fileUnderTest.pageInit(context);
+      expect(spyMesage).toHaveBeenLastCalledWith({
+        title: 'Checkbox was checked',
+        message: 'Checkbox was checked!',
+        type: 'confirmation',
+      });
+    });
+    it('should show message if checkbox is checked', () => {
+      // eslint-disable-next-line prefer-destructuring
+      const message = fileUnderTest.message;
+      const createdMessage = message.create({
+        title: 'Checkbox was checked',
+        message: 'Checkbox was checked!',
+        type: 'confirmation',
+      });
+      context.currentRecord.setFieldValue('messageonpost', true);
+      const spyMesage = spyOn(message, 'create').and.returnValue(createdMessage);
+      const spyShow = spyOn(createdMessage, 'show');
+      fileUnderTest.pageInit(context);
+      expect(spyMesage).toHaveBeenCalledWith({
+        title: 'Checkbox was checked',
+        message: 'Checkbox was checked!',
+        type: 'confirmation',
+      });
+      expect(spyShow).toHaveBeenCalledWith({
+        duration: 5000,
+      });
+    });
+    it('should show not message if checkbox is not checked', () => {
+      // eslint-disable-next-line prefer-destructuring
+      const message = fileUnderTest.message;
+      const createdMessage = message.create({
+        message: 'Email with CSV was sent to your mailbox!',
+        title: 'Email has been sent.',
+        type: 'confirmation',
+      });
+      context.currentRecord.setFieldValue('messageonpost', false);
+      const spyMesage = spyOn(message, 'create').and.returnValue(createdMessage);
+      const spyShow = spyOn(createdMessage, 'show');
+      fileUnderTest.pageInit(context);
+      expect(spyMesage).toHaveBeenCalledWith({
+        title: 'Checkbox was checked',
+        message: 'Checkbox was checked!',
+        type: 'confirmation',
+      });
+      expect(spyShow).not.toHaveBeenCalled();
+    });
+  });
+});

README.md

@@ -43,7 +43,7 @@ global.mockups = netsuiteMocks.nsMockups;
 
 3. Write your code and use these mocks
 
-`Examples will come soon`
+`Examples can be found in 'Examples folder in repo!'`
 
 ## Contribute 💻
 
@@ -68,9 +68,9 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
 
 ## Roadmap 🛣
 
-- add examples for jest
+- ~~add examples for jest~~
 - cleanup mycs occurences
-- add tests for the repo
+- ~~add tests for the repo~~
 - automate release process
 - add example for other test frameworks
 

SuiteScriptMockup1.0/nsmockup-1.0.js

@@ -2,6 +2,7 @@ const _ = require('lodash');
 const moment = require('moment');
 const record = require('../Utils/record');
 const file = require('../N/file');
+const { random } = require('../Utils/utils');
 
 const showLogs = false;
 /**

Tests/SuiteScriptMockup1.0/nsmockup-1.0.test.js

@@ -21,6 +21,17 @@ describe('Testing nsmockup-1.0 library', () => {
       expect(fileUnderTest.nlapiGetContext()).toMatchObject(expected);
     });
   });
+  describe('nlapiSearchRecord', () => {
+    it('Should return an array', () => {
+      expect(fileUnderTest.nlapiSearchRecord()).toEqual(expect.any(Array));
+    });
+  });
+  describe('nlapiLookupField', () => {
+    it('Should return a string', () => {
+      expect(fileUnderTest.nlapiLookupField()).toEqual(expect.any(String));
+    });
+  });
+
   describe('nlobjError', () => {
     it('Should create nlobjError object', () => {
       // eslint-disable-next-line new-cap

Tests/Utils/utils.test.js

@@ -0,0 +1,14 @@
+/**
+ * Tests for utils library
+ *
+ */
+
+const fileUnderTest = require('../../Utils/utils');
+
+describe('Testing utils library', () => {
+  describe('random', () => {
+    it('Should return integer', () => {
+      expect(fileUnderTest.random(1, 10)).toEqual(expect.any(Number));
+    });
+  });
+});

Utils/utils.js

@@ -0,0 +1,4 @@
+
+module.exports = {
+  random: (min, max) => Math.floor(Math.random() * (max - min + 1)) + min,
+};