comprodls-sdk 2.90.3-development → 2.91.0-thor

package/lib/helpers/lib/api/index.js

@@ -17,105 +17,30 @@
  * is strictly forbidden unless prior written permission is obtained
  * from Compro Technologies Pvt. Ltd..
  ***************************************************************************/
-/***********************************************************
- * comproDLS SDK Generic API Caller
- * This module provides generic function(s) to call any comproDLS API. 
- * The generic approach for calling API(s) require a prior knowledge of 
- * the specific URLs and parameters (as per the API documentation). 
- ************************************************************/
-var request = require('superagent');
-var q = require('q');
-var format = require("string-template");
+var format = require('string-template');
 
-var config = require('../../../config');
-var helpers = require('../../../helpers');
-var errors = require('../errors');
-var DLSError = errors.DLSError;
-var validations = require('./validations');
-
-/*********************************
- * Setting up Exports/Public functions
- **********************************/
-exports.genericAPICaller = genericAPICaller;
 exports.constructAPIUrl = constructAPIUrl;
 exports.setupAPIToken = setupAPIToken;
-exports.addClassIdQueryParam = addClassIdQueryParam
-
-/*********************************
- * Public Function definitions
- **********************************/
-
-//Generic comproDLS API caller
-function genericAPICaller(apiName, method, url, params) {
-    var self = this;
-    var dfd = q.defer();
-
-    //Validation
-    var err = validations.genericAPICaller(apiName, method, url, params) || helpers.validations.isAuthenticated(self.orgId, self.token);
-    if (err) {
-        dfd.reject(err);
-    } else {
-
-        //Passed all validations, setup API Url and parameters
-        var url = config.DEFAULT_HOSTS[apiName.toUpperCase()] + url;
-
-        //Setup Delete method for superagent
-        if (method === 'DELETE') {
-            method = 'DEL';            
-        }
-       
-        var requestAPI = request(method, url);
-
-        //Setting token in Authorization header
-        requestAPI = setupAPIToken(requestAPI, self.token);
 
-        //Setup request parameters
-        if (Object.keys(params).length) {
-            if (method === 'GET' || method === 'HEAD') {
-                requestAPI = requestAPI.query(params);
-            } else {
-                requestAPI = requestAPI.send(params);
-            }
-        }
-
-        //Call Specified API
-        requestAPI.end(function(err, response) {
-            if (err) {
-                err = new DLSError(errors.ERROR_TYPES.API_ERROR, err);
-                dfd.reject(err);
-            } else {
-                dfd.resolve(response.body);
-            }
-        });
-    }
-    return dfd.promise;
-};
-
-/*********************************************************
-* This function constructs the url of comproDLS API.
-* Options: JSON Object having actual values to replace in API URLs
-* Following are valid feilds in options object:
-  {
-     "orgId" : "",
-     "productId" : "",
-     "userId" : "",
-     "activityId" : "",
-     "attemptId" : "",
-     "questionId" : ""
-  }
-*********************************************************/
+/**
+ * This function constructs the url of comproDLS API.
+ * @param {String} url - comproDLS API URL with placeholders
+ * @param {Object} options - JSON Object having actual values to replace in API URLs
+ * @returns
+ */
 function constructAPIUrl(url, options) {
-    return format(url, options);
+  return format(url, options);
 };
 
-function addClassIdQueryParam(url, classId) {
-    var queryParam = '';
-    if(typeof(classId) !== "undefined" && classId !== null)
-        queryParam = '?classId=' + classId;
-    return url + queryParam;
-};
-
-//This function sets up comproDLS API token in request header
+/**
+ * [Deprecated] This function is no longer needed. Use requestLayer functions instead,
+ * as the API token is now automatically handled by requestLayer.
+ *
+ * This function sets up the API token in the request header.
+ * @param {Object} request - The request object to which the token will be added
+ * @param {Object} token - The token object containing the access_token
+ * @returns {*} The modified request object with the Authorization header set
+ */
 function setupAPIToken(request, token) {
-    return request.set('Authorization', token.access_token);
-};
+  return request.set('Authorization', token.access_token);
+};

package/lib/helpers/lib/errors.js

@@ -17,113 +17,108 @@
  * is strictly forbidden unless prior written permission is obtained
  * from Compro Technologies Pvt. Ltd..
  ***************************************************************************/
+
 /***********************************************************
  * comproDLS SDK Error Helper Module
  * This module contains helper functions for Error management
  ************************************************************/
 
-//All possible Error types in SDK
+// All possible Error types in SDK
 var ERROR_TYPES = {
-    "API_ERROR": "API_ERROR",
-    "SDK_ERROR": "SDK_ERROR",
-    "CHANNEL_SUBSCRIPTION": "CHANNEL_SUBSCRIPTION"
+  API_ERROR: 'API_ERROR',
+  SDK_ERROR: 'SDK_ERROR',
+  CHANNEL_SUBSCRIPTION: 'CHANNEL_SUBSCRIPTION',
+  UNEXPECTED_ERROR: 'UNEXPECTED_ERROR',
+  POLLING_INITIATION: 'POLLING_INITIATION'
 };
 
 var ERROR_CATEGORY = {
-    PUSHX: 'PUSHX'
+  PUSHX: 'PUSHX'
 };
 
-
 var ERROR_STATUS = {
-    ERROR: 'ERROR'
+  ERROR: 'ERROR'
 };
 
-/****************************************************
- * Setting up Exports/Public functions and variables
- *****************************************************/
 exports.DLSError = DLSError;
 exports.PUSHXError = PUSHXError;
 exports.ERROR_TYPES = ERROR_TYPES;
 exports.ERROR_CATEGORY = ERROR_CATEGORY;
 
-/*****************************************
-* Constructor for the DLS error object
-* Parameters:
-*   type: Error Type. Possible values are SDK_ERROR and API_ERROR
-*   err: JSON Error object. This can be:
-*      1. HTTP Error Object returned by comproDLS APIs (In case of API_ERROR)
-*      2. Custom Error Object(SDK_ERROR or Custom API_ERROR) with following structure  
-*         {
-*            "message":"[String]",
-*            "description":"[String]"
-*          }
-******************************************/
+/**
+ * Constructor for the DLS error object
+ * Parameters:
+ *  type: Error Type. Possible values are SDK_ERROR and API_ERROR
+ *  err: JSON Error object. This can be:
+ *    1. HTTP Error Object returned by comproDLS APIs (In case of API_ERROR)
+ *    2. Custom Error Object(SDK_ERROR or Custom API_ERROR) with following structure
+ *       {
+ *         message: 'string',
+ *         description: 'string'
+ *       }
+ */
 function DLSError(type, err) {
-    /* 
-     * We assume only two types of errors: SDK_ERROR (default) 
-     * or API_ERROR
-     */
-    this.type = type;
-    if (type === ERROR_TYPES.API_ERROR) {
-        
-        //Depending on type of error (HTTP response or Custom) deal with different formats of the err object
-        var msg, desc;
-        if(err.response != undefined) {
-            msg = err.response.body.message || err.response.body.dbErrorBody || err.response.body.code;
-            desc = err.response.body.dbErrorDescription;
-
-            // Add swagger errors
-            if(err.response.body.results && err.response.body.results.errors) {
-                msg = '';
-                for(var idx in err.response.body.results.errors) {
-                    msg += err.response.body.results.errors[idx].message + ' ';
-                }
-            }
+  // We assume only two types of errors: SDK_ERROR (default) or API_ERROR
+  this.type = type;
+  if (type === ERROR_TYPES.API_ERROR) {
 
-            // Add request_id
-            if(err.response.body.server) {
-                this.server = err.response.body.server;
-            }
+    // Handling error on the basis of type of error (HTTP response or Custom)
+    var msg, desc;
+    if(err.response != undefined) {
+      msg = err.response.body.message || err.response.body.dbErrorBody || err.response.body.code;
+      desc = err.response.body.dbErrorDescription;
 
-        } else {
-            msg = err.message ? err.message : "";
-            desc = err.description ? err.description : "";
+      // Add swagger errors
+      if (err.response.body.results && err.response.body.results.errors) {
+        msg = '';
+        for (var idx in err.response.body.results.errors) {
+            msg += err.response.body.results.errors[idx].message + ' ';
         }
+      }
 
-        //Set the message and description
-        this.message = msg;
-        this.description = desc;
-    }
-    else if(type === ERROR_TYPES.PUSHX_ERROR) {
+      // Add request_id
+      if (err.response.body.server) {
+        this.server = err.response.body.server;
+      }
 
-        //Set the message and description
-        this.message = err.message;
-        this.data = err;
-    }
-    else {
-        this.message = err.message ? err.message : "";
-        this.description = err.description ? err.description : "";
-        delete err.message;
-        delete err.description;
-        this.data = err;
-    }
-    
-    if (type === ERROR_TYPES.API_ERROR || type === ERROR_TYPES.PUSHX_ERROR) {
-        this.httpcode = err.status;
+    } else {
+      msg = err.message ? err.message : '';
+      desc = err.description ? err.description : '';
     }
+
+    //Set the message and description
+    this.message = msg;
+    this.description = desc;
+  }
+  else if (type === ERROR_TYPES.PUSHX_ERROR) {
+    //Set the message and description
+    this.message = err.message;
+    this.data = err;
+  }
+  else {
+    this.message = err.message ? err.message : '';
+    this.description = err.description ? err.description : '';
+    delete err.message;
+    delete err.description;
+    this.data = err;
+  }
+
+  if (type === ERROR_TYPES.API_ERROR || type === ERROR_TYPES.PUSHX_ERROR) {
+    this.httpcode = err.status;
+  }
 };
 
 function PUSHXError(category, error) {
-
-    if (category === ERROR_CATEGORY.PUSHX) {
-        this.category = ERROR_CATEGORY.PUSHX;
-        this.type = ERROR_TYPES.CHANNEL_SUBSCRIPTION;
-        this.status = ERROR_STATUS.ERROR;
-        this.message = error.message;
-        this.data = error;
-        this.httpcode = (error.errorDetails && error.errorDetails.statusCode) ? error.errorDetails.statusCode : 500;
-    }
-    else {
-        this.message = 'PUSHXError called for incorrect category.';
-    }
+  if (category === ERROR_CATEGORY.PUSHX) {
+    this.category = ERROR_CATEGORY.PUSHX;
+    this.type = error.type || ERROR_TYPES.CHANNEL_SUBSCRIPTION;
+    this.status = ERROR_STATUS.ERROR;
+    this.message = error.message;
+    this.data = error;
+    this.httpcode = (error.errorDetails && error.errorDetails.statusCode) ?
+      error.errorDetails.statusCode : 500;
+  }
+  else {
+    this.message = 'PUSHXError called for incorrect category.';
+  }
 };

package/lib/helpers/lib/requestLayer.js

@@ -0,0 +1,154 @@
+/*************************************************************************
+ *
+ * COMPRO CONFIDENTIAL
+ * __________________
+ *
+ *  [2015] - [2020] Compro Technologies Private Limited
+ *  All Rights Reserved.
+ *
+ * NOTICE:  All information contained herein is, and remains
+ * the property of Compro Technologies Private Limited. The
+ * intellectual and technical concepts contained herein are
+ * proprietary to Compro Technologies Private Limited and may
+ * be covered by U.S. and Foreign Patents, patents in process,
+ * and are protected by trade secret or copyright law.
+ *
+ * Dissemination of this information or reproduction of this material
+ * is strictly forbidden unless prior written permission is obtained
+ * from Compro Technologies Pvt. Ltd..
+ ***************************************************************************/
+
+var Request = require('superagent');
+var Agent = require('agentkeepalive');
+
+var keepaliveAgent = new Agent({
+  timeout: 60000,
+  freeSocketTimeout: 30000
+});
+
+/**
+ * Sends an HTTP GET request to the specified URL with query parameters and optional headers.
+ *
+ * @param {string} url - The endpoint to send the request to.
+ * @param {Object} options.params - Query parameters to append to the URL.
+ * @param {Object} options.headers - Optional headers including traceid and token.
+ */
+function getRequest(url, options) {
+  var params = options.params, headers = options.headers;
+
+  return new Promise(function (resolve, reject) {
+    // Setup request with URL and Params
+    var requestAPI = Request.get(url)
+      .set('Accept', 'application/json')
+      .query(params);
+
+    // Setting headers in the request.
+    if (headers) {
+      if (headers.traceid) { requestAPI.set('X-Amzn-Trace-Id', headers.traceid); }
+      if (headers.token) { requestAPI.set('Authorization', headers.token.access_token); }
+    }
+
+    requestAPI
+    .agent(keepaliveAgent)
+    .then(function (res) { resolve(res); })
+    .catch(function (err) { reject(err); });
+  });
+}
+
+/**
+ * Sends an HTTP POST request to the specified URL with a JSON body and optional headers.
+ *
+ * @param {string} url - The endpoint to send the request to.
+ * @param {Object} options.params - Payload to be sent in the request body.
+ * @param {Object} options.headers - Optional headers including traceid and token.
+ */
+function postRequest(url, options) {
+  var params = options.params, headers = options.headers;
+
+  return new Promise(function (resolve, reject) {
+    //Setup request with URL and Params
+    var requestAPI = Request.post(url)
+      .set('Content-Type', 'application/json')
+      .set('Accept', 'application/json')
+      .send(params);
+
+    // Setting headers in the request.
+    if (headers) {
+      if (headers.traceid) { requestAPI.set('X-Amzn-Trace-Id', headers.traceid); }
+      if (headers.token) { requestAPI.set('Authorization', headers.token.access_token); }
+    }
+
+    requestAPI
+    .agent(keepaliveAgent)
+    .then(function (res) { resolve(res); })
+    .catch(function (err) { reject(err); });
+  });
+}
+
+/**
+ * Sends an HTTP PUT request to the specified URL with a JSON body and optional headers.
+ *
+ * @param {string} url - The endpoint to send the request to.
+ * @param {Object} options.params - Payload to be sent in the request body.
+ * @param {Object} options.headers - Optional headers including traceid and token.
+ */
+function putRequest(url, options) {
+  var params = options.params, headers = options.headers;
+
+  return new Promise(function (resolve, reject) {
+    //Setup request with URL and Params
+    var requestAPI = Request.put(url)
+      .set('Content-Type', 'application/json')
+      .set('Accept', 'application/json')
+      .send(params);
+
+    // Setting headers in the request.
+    if (headers) {
+      if (headers.traceid) { requestAPI.set('X-Amzn-Trace-Id', headers.traceid); }
+      if (headers.token) { requestAPI.set('Authorization', headers.token.access_token); }
+    }
+
+    requestAPI
+    .agent(keepaliveAgent)
+    .then(function (res) { resolve(res); })
+    .catch(function (err) { reject(err); });
+  });
+}
+
+/**
+ * Sends an HTTP DELETE request to the specified URL with optional payload and headers.
+ *
+ * @param {string} url - The endpoint to send the request to.
+ * @param {Object} options.params - Payload to be sent in the request body (optional).
+ * @param {Object} options.headers - Optional headers including traceid and token.
+ */
+function deleteRequest(url, options) {
+  var params = options.params, headers = options.headers;
+
+  return new Promise(function (resolve, reject) {
+    //Setup request with URL and Params
+    var requestAPI = Request.delete(url)
+      .set('Content-Type', 'application/json')
+      .set('Accept', 'application/json')
+      .send(params);
+
+
+    // Setting headers in the request.
+    if (headers) {
+      if (headers.traceid) { requestAPI.set('X-Amzn-Trace-Id', headers.traceid); }
+      if (headers.token) { requestAPI.set('Authorization', headers.token.access_token); }
+    }
+
+    requestAPI
+    .agent(keepaliveAgent)
+    .then(function (res) { resolve(res); })
+    .catch(function (err) { reject(err); });
+  });
+}
+
+module.exports = {
+  get: getRequest,
+  post: postRequest,
+  put: putRequest,
+  delete: deleteRequest
+};

package/lib/helpers/lib/validator.js

@@ -17,85 +17,98 @@
  * is strictly forbidden unless prior written permission is obtained
  * from Compro Technologies Pvt. Ltd..
  ***************************************************************************/
+
 /***********************************************************
  * comproDLS SDK Validator Helper Module
  * This module contains validation helper functions for comproDLS SDK
  ************************************************************/
-var validator = require("validate.js");
+var validator = require('validate.js');
 var errors = require('./errors');
 var DLSError = errors.DLSError;
 
-
-/****************************************************
- * Setting up Exports/Public functions
- *****************************************************/
 exports.validate = validate;
 exports.isAuthenticated = validateIsAuthenticated;
+exports.isAuthenticatedV2 = validateIsAuthenticatedV2;
+
+/**
+ * This function validates if the SDK instance is authenticated.
+ * It checks if the orgId and token are present.
+ * @param {String} orgId - Organization ID
+ * @param {Object} token - Token object { access_token: 'string' }
+ */
+function validateIsAuthenticatedV2(orgId, token) {
+  if (orgId && token) { return; }
+
+  var errMsg = 'SDK Instance does not have valid orgid or token. ' +
+    'Please authenticate using authWithCredentials or authWithToken method.';
+  var errObj = { message: errMsg, description: errMsg};
+  return new DLSError(errors.ERROR_TYPES.SDK_ERROR, errObj);
+};
 
-/*********************************
- * Public Function definitions
- **********************************/
 function validate(options, constraints) {
-    var err = {};
-    var validation_errors = validator(options, constraints);
-    if (validation_errors) {
-        for (var validation_error in validation_errors) {
-            err.message = err.description = validation_errors[validation_error][0];
-            err = new DLSError(errors.ERROR_TYPES.SDK_ERROR, err);
-            return err;
-        }
-    } else {
-        return undefined;
+  var err = {};
+  var validation_errors = validator(options, constraints);
+  if (validation_errors) {
+    for (var validation_error in validation_errors) {
+      err.message = err.description = validation_errors[validation_error][0];
+      err = new DLSError(errors.ERROR_TYPES.SDK_ERROR, err);
+      return err;
     }
+  } else {
+    return undefined;
+  }
 };
 
+/**
+ * This function is deprecated. Please use validateIsAuthenticatedV2 instead.
+ */
 function validateIsAuthenticated(orgId, token) {
-    var validate_options = {
-        'organization': orgId,
-        'token': token
-    };
+  var validate_options = {
+    'organization': orgId,
+    'token': token
+  };
 
-    var validate_constraints = {
-        "organization": {
-            "presence": {
-                "message" : "^SDK Instance does not have valid orgid or token. Please authenticate using authWithCredentials or authWithToken method."
-            }
-        },
-        "token": {
-            "presence": {
-                "message" : "^SDK Instance does not have valid orgid or token. Please authenticate using authWithCredentials or authWithToken method."
-            }
-        }
-    };
+  var validate_constraints = {
+    'organization': {
+      'presence': {
+        'message' : '^SDK Instance does not have valid orgid or token. Please authenticate using authWithCredentials or authWithToken method.'
+      }
+    },
+    'token': {
+      'presence': {
+        'message' : '^SDK Instance does not have valid orgid or token. Please authenticate using authWithCredentials or authWithToken method.'
+      }
+    }
+  };
 
-    return validate(validate_options, validate_constraints);
+  return validate(validate_options, validate_constraints);
 };
 
 /*********************************
  * Private Function definitions
  **********************************/
 validator.validators.isString = function(value, options) {
-    if (!validator.isString(value)) {
-        return options.message || "is not a valid string";
-    }
+  if (!validator.isString(value)) {
+    return options.message || 'is not a valid string';
+  }
 };
 
 validator.validators.isObject = function(value, options) {
-    if (!validator.isObject(value)) {
-        return options.message || "is not a valid object";
-    }
+  if (!validator.isObject(value)) {
+    return options.message || 'is not a valid object';
+  }
 };
 
 validator.validators.contains = function(value, options) {
-    if (validator.isArray(options)) {
-        for (var key in options) {
-            if (!value || !value.hasOwnProperty(options[key])) {
-                return options.message || "does not contain " + options[key];
-            }
-        }
-    } else if (validator.isString(options)) {
-        if (!value || !value.hasOwnProperty(options)) {
-            return options.message || "does not contain " + options;
-        }
+  if (validator.isArray(options)) {
+    for (var key in options) {
+      if (!value || !value.hasOwnProperty(options[key])) {
+        return options.message || 'does not contain ' + options[key];
+      }
+    }
+  } else if (validator.isString(options)) {
+    if (!value || !value.hasOwnProperty(options)) {
+      return options.message || 'does not contain ' + options;
     }
-};
+  }
+};