comprodls-sdk 2.12.0 → 2.12.1

package/lib/helpers/lib/api/validations.js

@@ -1,73 +1,73 @@
-/*************************************************************************
- *
- * 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..
- ***************************************************************************/
-/***********************************************************
- * comproDLS APIS Module Validations
- * This module contains validations for APIS module.
- ************************************************************/
-var validate = require('../validator').validate;
-
-/****************************************************
- * Setting up Exports/Public variables 
- *****************************************************/
-exports.genericAPICaller = validateGenericAPICaller;
-
-/*********************************
- * Public Function definitions
- **********************************/
-function validateGenericAPICaller(apiName, method, url, params) {
-    var validate_options = {
-        'apiName': apiName,
-        'method': method,
-        'url': url,
-        'params':params
-    };
-
-    var validate_constraints = {
-        "apiName" : {
-            "isString" : true,
-            "presence" : true,
-            "inclusion": {
-                "within" : ["AUTH" , "PRODUCT" , "COLLAB" , "ANALYTICS" , "ACTIVITY" , "XAPI"],
-                "message": "^Enter a valid API Name"
-            }
-        },
-        "method" : {
-            "isString" : true,
-            "presence" : true,
-            "inclusion": {
-                "within" : ["GET" , "POST" , "PUT" , "DELETE"],
-                "message": "^Enter a valid HTTP method"
-            }
-        },
-        "url" : {
-            "isString" : true,
-            "presence" : true,
-            "format": {
-                "pattern": "^/.*$",
-                "message": "^Url should start with a /"
-            }
-        },
-        "params" : {
-            "isObject" : true
-        }
-    };
-
-    return validate(validate_options, validate_constraints);
+/*************************************************************************
+ *
+ * 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..
+ ***************************************************************************/
+/***********************************************************
+ * comproDLS APIS Module Validations
+ * This module contains validations for APIS module.
+ ************************************************************/
+var validate = require('../validator').validate;
+
+/****************************************************
+ * Setting up Exports/Public variables 
+ *****************************************************/
+exports.genericAPICaller = validateGenericAPICaller;
+
+/*********************************
+ * Public Function definitions
+ **********************************/
+function validateGenericAPICaller(apiName, method, url, params) {
+    var validate_options = {
+        'apiName': apiName,
+        'method': method,
+        'url': url,
+        'params':params
+    };
+
+    var validate_constraints = {
+        "apiName" : {
+            "isString" : true,
+            "presence" : true,
+            "inclusion": {
+                "within" : ["AUTH" , "PRODUCT" , "COLLAB" , "ANALYTICS" , "ACTIVITY" , "XAPI"],
+                "message": "^Enter a valid API Name"
+            }
+        },
+        "method" : {
+            "isString" : true,
+            "presence" : true,
+            "inclusion": {
+                "within" : ["GET" , "POST" , "PUT" , "DELETE"],
+                "message": "^Enter a valid HTTP method"
+            }
+        },
+        "url" : {
+            "isString" : true,
+            "presence" : true,
+            "format": {
+                "pattern": "^/.*$",
+                "message": "^Url should start with a /"
+            }
+        },
+        "params" : {
+            "isObject" : true
+        }
+    };
+
+    return validate(validate_options, validate_constraints);
 };

package/lib/helpers/lib/errors.js

@@ -1,129 +1,129 @@
-/*************************************************************************
- *
- * 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..
- ***************************************************************************/
-/***********************************************************
- * comproDLS SDK Error Helper Module
- * This module contains helper functions for Error management
- ************************************************************/
-
-//All possible Error types in SDK
-var ERROR_TYPES = {
-    "API_ERROR": "API_ERROR",
-    "SDK_ERROR": "SDK_ERROR",
-    "CHANNEL_SUBSCRIPTION": "CHANNEL_SUBSCRIPTION"
-};
-
-var ERROR_CATEGORY = {
-    PUSHX: 'PUSHX'
-};
-
-
-var ERROR_STATUS = {
-    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]"
-*          }
-******************************************/
-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 + ' ';
-                }
-            }
-
-            // Add request_id
-            if(err.response.body.server) {
-                this.server = err.response.body.server;
-            }
-
-        } 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.';
-    }
-};
+/*************************************************************************
+ *
+ * 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..
+ ***************************************************************************/
+/***********************************************************
+ * comproDLS SDK Error Helper Module
+ * This module contains helper functions for Error management
+ ************************************************************/
+
+//All possible Error types in SDK
+var ERROR_TYPES = {
+    "API_ERROR": "API_ERROR",
+    "SDK_ERROR": "SDK_ERROR",
+    "CHANNEL_SUBSCRIPTION": "CHANNEL_SUBSCRIPTION"
+};
+
+var ERROR_CATEGORY = {
+    PUSHX: 'PUSHX'
+};
+
+
+var ERROR_STATUS = {
+    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]"
+*          }
+******************************************/
+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 + ' ';
+                }
+            }
+
+            // Add request_id
+            if(err.response.body.server) {
+                this.server = err.response.body.server;
+            }
+
+        } 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.';
+    }
+};

package/lib/helpers/lib/utils.js

@@ -1,24 +1,24 @@
-/*************************************************************************
- *
- * 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..
- ***************************************************************************/
-/***********************************************************
- * comproDLS SDK Util Module
- * This module provides Utility functions for SDK
- ************************************************************/
+/*************************************************************************
+ *
+ * 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..
+ ***************************************************************************/
+/***********************************************************
+ * comproDLS SDK Util Module
+ * This module provides Utility functions for SDK
+ ************************************************************/
 exports.isBrowser = typeof window !== "undefined";

package/lib/helpers/lib/validator.js

@@ -1,101 +1,101 @@
-/*************************************************************************
- *
- * 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..
- ***************************************************************************/
-/***********************************************************
- * comproDLS SDK Validator Helper Module
- * This module contains validation helper functions for comproDLS SDK
- ************************************************************/
-var validator = require("validate.js");
-var errors = require('./errors');
-var DLSError = errors.DLSError;
-
-
-/****************************************************
- * Setting up Exports/Public functions
- *****************************************************/
-exports.validate = validate;
-exports.isAuthenticated = validateIsAuthenticated;
-
-/*********************************
- * 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;
-    }
-};
-
-function validateIsAuthenticated(orgId, 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."
-            }
-        }
-    };
-
-    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";
-    }
-};
-
-validator.validators.isObject = function(value, options) {
-    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;
-        }
-    }
+/*************************************************************************
+ *
+ * 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..
+ ***************************************************************************/
+/***********************************************************
+ * comproDLS SDK Validator Helper Module
+ * This module contains validation helper functions for comproDLS SDK
+ ************************************************************/
+var validator = require("validate.js");
+var errors = require('./errors');
+var DLSError = errors.DLSError;
+
+
+/****************************************************
+ * Setting up Exports/Public functions
+ *****************************************************/
+exports.validate = validate;
+exports.isAuthenticated = validateIsAuthenticated;
+
+/*********************************
+ * 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;
+    }
+};
+
+function validateIsAuthenticated(orgId, 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."
+            }
+        }
+    };
+
+    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";
+    }
+};
+
+validator.validators.isObject = function(value, options) {
+    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;
+        }
+    }
 };