comprodls-sdk 2.112.0-thor.1 → 2.113.0

package/lib/config/index.js

@@ -154,7 +154,6 @@ exports.AUTH_API_URLS = {
   validateSpaceCode: '/accounts/{accountid}/space-code/validate',
   validateClassCode: '/accounts/{accountid}/class-code/validate',
   joinInstituteSpace: '/accounts/{accountid}/join-institute-space',
-  provisionStudentInInstitutionalSpace: '/accounts/{accountid}/student/join-institute-space',
   provisionSpacesToStudent: '/accounts/{accountId}/student/provision-spaces',
   provisionSpacesToTeacher: '/accounts/{accountId}/teacher/provision-spaces',
   shadowProvision: '/org/{orgId}/shadow-provision',
@@ -237,7 +236,6 @@ exports.AUTHEXTN_API_URLS = {
 
   //Space related API
   entitleBulkUsersToProducts: '/accounts/{accountid}/entitle-users/bulk',
-  deleteUserAccount : '/accounts/{accountid}/ext-users/{ext_user_id}',
 
   // Assigned Path APIs
   userAssignedPaths: '/org/{orgid}/classes/{classid}/assigned-paths/{assignedpathid}/enroll-user/multi',
@@ -281,11 +279,7 @@ exports.ANALYTICS_API_URLS = {
   getClassCustomComponentUserSubmission: '/{orgId}/class/custom-component/class-record/evaluations',
 
   //CrossProductAggregation Related APIs
-  getCrossProductAggregation: '/{orgId}/class/cross-product-aggregation',
-
-  // MAP Aggregation Related APIs
-  getStudentAggregation: '/{orgId}/student/aggregation',
-  getTeacherAggregation: '/{orgId}/teacher/aggregation'
+  getCrossProductAggregation: '/{orgId}/class/cross-product-aggregation'
 };
 
 exports.PRODUCT_API_URLS = {
@@ -339,8 +333,7 @@ exports.INTEGRATIONS_API_URLS = {
   auditTrail: '/accounts/{accountId}/audit-trail',
   customEvents: '/accounts/{accountId}/custom-events',
   schedules: '/accounts/{accountId}/context/{context}/schedule',
-  particularSchedule: '/accounts/{accountId}/context/{context}/schedule/{scheduleId}',
-  lifecycleEvents: '/accounts/{accountId}/lifecycle-events'
+  particularSchedule: '/accounts/{accountId}/context/{context}/schedule/{scheduleId}'
 };
 
 exports.DRIVE_API_URLS = {

package/lib/helpers/lib/errors.js

@@ -27,9 +27,7 @@
 var ERROR_TYPES = {
   API_ERROR: 'API_ERROR',
   SDK_ERROR: 'SDK_ERROR',
-  CHANNEL_SUBSCRIPTION: 'CHANNEL_SUBSCRIPTION',
-  UNEXPECTED_ERROR: 'UNEXPECTED_ERROR',
-  POLLING_INITIATION: 'POLLING_INITIATION'
+  CHANNEL_SUBSCRIPTION: 'CHANNEL_SUBSCRIPTION'
 };
 
 var ERROR_CATEGORY = {

package/lib/helpers/lib/validator.js

@@ -22,129 +22,13 @@
  * 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;
 
-/*********************************
- * Core validator utilities
- * Each validator follows the signature:
- *   fn(field, value, options) → DLSError | undefined
- *
- * - field   : the constraint key name e.g. 'organization', 'token', 'token.access_token'
- * - value   : the value from the options object for that field
- * - options : the rule config, can be `true` or `{ message: '...' }`
- *             For `contains`, options is a string or array of required keys.
- *
- * Returning a DLSError which stops validation immediately.
- * Returning undefined means the check passed.
- **********************************/
-var validators = {
-  /**
-   * Fails if value is null, undefined, or blank/whitespace-only string or empty object.
-   */
-  presence: function(field, value, options) {
-    if (value === undefined || value === null || value === '' ||
-      (typeof value == 'string' && value.trim() === '') ||
-      (typeof value == 'object' && Object.keys(value).length === 0)
-    ) {
-      return createError(options.message || field + ' can\'t be blank');
-    }
-  },
-
-  /**
-   * Fails if value is not a string.
-   */
-  isString: function(field, value, options) {
-    if (typeof value !== 'string') {
-      return createError(options.message || field + ' is not a valid string');
-    }
-  },
-
-  /**
-   * Fails if value is not an object.
-   */
-  isObject: function(field, value, options) {
-    if (typeof value !== 'object' || Array.isArray(value)) {
-      return createError(options.message || field + ' is not a valid object');
-    }
-  },
-
-  /**
-   * Fails if the object does not have the required key(s).
-   */
-  contains: function(field, value, options) {
-    var keys = Array.isArray(options) ? options : typeof options === 'string' ? [options] : [];
-
-    for (var i = 0; i < keys.length; i++) {
-      var requiredKey = keys[i];
-
-      if (!value.hasOwnProperty(requiredKey)) {
-        return createError(options.message || field + ' does not contain ' + requiredKey);
-      }
-    }
-  }
-};
-
-/*********************************
- * Core validate function
- *
- * Iterates over each field in constraints, resolves its value from options,
- * then runs each rule's validator function in order.
- * Returns the first error encountered or undefined if all pass.
- *
- * @param {Object} options     - The input object to validate
- * @param {Object} constraints - Map of field names to their rule constraints
- * @returns {DLSError | undefined}
- **********************************/
-function validate(options, constraints) {
-  for (var field in constraints) {
-    var fieldConstraintsObj = constraints[field];
-    var value = getValue(options, field);
-
-    for (var ruleName in fieldConstraintsObj) {
-      var ruleOptions = fieldConstraintsObj[ruleName];
-      var validatorFn = validators[ruleName];
-
-      if (!validatorFn) { continue; }
-
-      // Pass field name, field value, and field's rule constraint value to the validator function
-      var error = validatorFn(field, value, ruleOptions);
-      if (error) { return error; }
-    }
-  }
-
-  return undefined;
-}
-
-/*********************************
- * Private helpers
- **********************************/
-function getValue(obj, path) {
-  var keys = path.split('.');
-  var result = obj;
-
-  for (var i = 0; i < keys.length; i++) {
-    if (result === undefined || result === null) { return undefined; }
-    result = result[keys[i]];
-  }
-
-  return result;
-}
-
-function createError(message) {
-  var msg = message || 'Validation error';
-  msg = msg.charAt(0).toUpperCase() + msg.slice(1);
-
-  return new DLSError(errors.ERROR_TYPES.SDK_ERROR, {
-    message: msg,
-    description: msg
-  });
-}
-
-/*********************************
- * Exported auth validators
- **********************************/
+exports.validate = validate;
+exports.isAuthenticated = validateIsAuthenticated;
+exports.isAuthenticatedV2 = validateIsAuthenticatedV2;
 
 /**
  * This function validates if the SDK instance is authenticated.
@@ -161,10 +45,22 @@ function validateIsAuthenticatedV2(orgId, token) {
   return new DLSError(errors.ERROR_TYPES.SDK_ERROR, errObj);
 };
 
+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;
+  }
+};
+
 /**
- * Validates if SDK instance is authenticated by checking presence of orgId and token.
- * @param {String} orgId - Organization ID
- * @param {Object} token - Token object { access_token: 'string' }
+ * This function is deprecated. Please use validateIsAuthenticatedV2 instead.
  */
 function validateIsAuthenticated(orgId, token) {
   var validate_options = {
@@ -172,21 +68,47 @@ function validateIsAuthenticated(orgId, token) {
     'token': token
   };
 
-  var errMsg = 'SDK Instance does not have valid orgid or token. ' +
-    'Please authenticate using authWithCredentials or authWithToken method.';
-
   var validate_constraints = {
     'organization': {
-      'presence': { 'message': errMsg }
+      'presence': {
+        'message' : '^SDK Instance does not have valid orgid or token. Please authenticate using authWithCredentials or authWithToken method.'
+      }
     },
     'token': {
-      'presence': { 'message': errMsg }
+      'presence': {
+        'message' : '^SDK Instance does not have valid orgid or token. Please authenticate using authWithCredentials or authWithToken method.'
+      }
     }
   };
 
   return validate(validate_options, validate_constraints);
 };
 
-exports.validate = validate;
-exports.isAuthenticated = validateIsAuthenticated;
-exports.isAuthenticatedV2 = validateIsAuthenticatedV2;
+/*********************************
+ * 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;
+    }
+  }
+};

package/lib/services/analytics/index.js

@@ -27,7 +27,6 @@ var q = require('q');
 var request = require('superagent');
 var Agent = require('agentkeepalive');
 
-var requestLayer = require('../../helpers/lib/requestLayer');
 var helpers = require('../../helpers');
 var DLSError = helpers.errors.DLSError;
 
@@ -74,11 +73,7 @@ function analytics() {
     getClassCustomComponentUserSubmission: getClassCustomComponentUserSubmission.bind(this),
 
     //CrossProductAggregation Related APIs
-    getCrossProductAggregation: getCrossProductAggregation.bind(this),
-
-    //MAP Aggregation Related APIs
-    getStudentAggregation: getStudentAggregation.bind(this),
-    getTeacherAggregation: getTeacherAggregation.bind(this)
+    getCrossProductAggregation: getCrossProductAggregation.bind(this)
   };
 }
 
@@ -1368,80 +1363,3 @@ function getCrossProductAggregation(options) {
   }
   return dfd.promise;
 }
-
-/**
- * Wiki Link for SDK params
- * https://github.com/comprodls/comprodls-sdk-js/wiki/06_ANALYTICS-Adapter#getstudentaggregationparams
- */
-function getStudentAggregation(options) {
-  var self = this;
-
-  let err = {};
-
-  // Validations
-  if(!(options && options.studentid && options.courseid)) {
-    err.message = err.description = 'Mandatory params: studentid/courseid' +
-      ' not found in request options.';
-    return Promise.reject(new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err));
-  } else {
-    // Passed all validations, Constructing URL
-    var url = self.config.DEFAULT_HOSTS.ANALYTICS + 
-              self.config.ANALYTICS_API_URLS.getStudentAggregation;
-    url = helpers.api.constructAPIUrl(url, { orgId: self.orgId });
-
-    // Setup Query Params
-    var queryParams = { courseId: options.courseid, studentId: options.studentid };
-
-    // Prepare request parameters & execute request
-    let reqOptions = {
-      params: queryParams,
-      headers: { traceid: self.traceid, token: self.token }
-    };
-    return requestLayer.get(url, reqOptions)
-    .then(function (response) {
-      return response.body;
-    })
-    .catch(function (err) {
-      throw new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
-    });
-  }
-
-}
-
-/**
- * Wiki Link for SDK params
- * https://github.com/comprodls/comprodls-sdk-js/wiki/06_ANALYTICS-Adapter#getteacheraggregationparams
- */
-function getTeacherAggregation(options) {
-  var self = this;
-
-  let err = {};
-
-  // Validations
-  if(!(options && options.teacherid)) {
-    err.message = err.description = 'Mandatory params: teacherid not found in request options.';
-    return Promise.reject(new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err));
-  } else {
-    // Passed all validations, Constructing URL
-    var url = self.config.DEFAULT_HOSTS.ANALYTICS +
-              self.config.ANALYTICS_API_URLS.getTeacherAggregation;
-    url = helpers.api.constructAPIUrl(url, { orgId: self.orgId });
-
-    // Setup Query Params
-    var queryParams = { teacherId: options.teacherid, studentId: options.studentid };
-
-    // Prepare request parameters & execute request
-    let reqOptions = {
-      params: queryParams,
-      headers: { traceid: self.traceid, token: self.token }
-    };
-    return requestLayer.get(url, reqOptions)
-    .then(function (response) {
-      return response.body;
-    })
-    .catch(function (err) {
-      throw new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
-    });
-  }
-
-}

package/lib/services/integrations/index.js

@@ -27,7 +27,6 @@ var q = require('q');
 var request = require('superagent');
 var Agent = require('agentkeepalive');
 
-var requestLayer = require('../../helpers/lib/requestLayer');
 var helpers = require('../../helpers');
 var converter = require('../../helpers/lib/api/converter');
 
@@ -53,8 +52,7 @@ function integrations(accountId) {
     createSchedule: createSchedule.bind(this),
     getSchedule: getSchedule.bind(this),
     updateSchedule: updateSchedule.bind(this),
-    deleteSchedule: deleteSchedule.bind(this),
-    publishLifecycleEvent: publishLifecycleEvent.bind(this)
+    deleteSchedule: deleteSchedule.bind(this)
   };
 }
 
@@ -480,39 +478,3 @@ function deleteSchedule(options) {
 
   return deferred.promise;
 }
-
-/**
- * Wiki Link for SDK params
- * https://github.com/comprodls/comprodls-sdk-js/wiki/22_Integrations-Adapter#publishlifecycleeventparams
- */
-function publishLifecycleEvent(options) {
-  let self = this;
-
-  // Validate productcode
-  if (!(options && options.category && options.action && options.timestamp &&
-      options.data && options.ext_actor_id)) {
-    let err = {};
-    err.message = err.description = 'Mandatory params: category/action/timestamp' +
-      '/data/ext_actor_id not found in request options.';
-    return Promise.reject(new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err));
-  }
-
-  // Construct API URL
-  let url = helpers.api.constructAPIUrl(
-    self.config.DEFAULT_HOSTS.INTEGRATION + self.config.INTEGRATIONS_API_URLS.lifecycleEvents,
-    { accountId: self.accountId }
-  );
-
-  // Prepare request parameters & execute request
-  let reqOptions = {
-    params: options,
-    headers: { traceid: self.traceid }
-  };
-  return requestLayer.post(url, reqOptions)
-  .then(function (response) {
-    return response.body;
-  })
-  .catch(function (err) {
-    throw new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
-  });
-}

package/lib/services/spaces/index.js

@@ -277,45 +277,39 @@ function changeSpaceCode(options) {
  */
 function joinInstituteSpace(options) {
   var self = this;
+  // Initializing promise
+  var dfd = q.defer();
 
-  return new Promise(function(resolve, reject) {
-    if (options && options.ext_user_id && options.ext_role) {
-      // Passed all validations, Contruct API url
-
-      var url;
-      if (options.ext_role === 'student') {
-        url = self.config.DEFAULT_HOSTS.AUTH +
-          self.config.AUTH_API_URLS.provisionStudentInInstitutionalSpace;
-      }
-      else {
-        url = self.config.DEFAULT_HOSTS.AUTH + self.config.AUTH_API_URLS.joinInstituteSpace;
-      }
-      url = helpers.api.constructAPIUrl(url, { accountid : self.accountId });
+  if(options && options.ext_user_id &&
+      options.ext_role && options.space_code)
+  {
+    // Passed all validations, Contruct API url
+    var url = self.config.DEFAULT_HOSTS.AUTH +
+                               self.config.AUTH_API_URLS.joinInstituteSpace;
+    url = helpers.api.constructAPIUrl(url, { accountid : self.accountId });
 
-      // Setup request with URL and Params
-      var requestAPI = request.post(url)
+    // Setup request with URL and Params
+    var requestAPI = request.post(url)
                      .set('Content-Type', 'application/json')
-                     .set('Accept', 'application/json');
-      if(self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
+                     .set('Accept', 'application/json')
+                     .send(options);
+    if(self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
 
-      requestAPI
-      .send(options)
-      .agent(keepaliveAgent)
-      .end(function(error, response) {
-        if (error) {
-          var err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, error);
-          reject(err);
-        }
-        else { resolve(response.body); }
-      });
-    } else {
-      var err = {};
-      err.message = err.description = 'ext_user_id or ext_role not found' +
-        ' in request options.';
-      err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
-      reject(err);
-    }
-  });
+    requestAPI.end(function(error, response) {
+      if(error) {
+        err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, error);
+        dfd.reject(err);
+      }
+      else { dfd.resolve(response.body); }
+    });
+  } else {
+    var err = {};
+    err.message = err.description = 'ext_user_id or ext_role or space_code not found in request options.';
+    err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
+    dfd.reject(err);
+  }
+
+  return dfd.promise;
 }
 
 /**
@@ -855,7 +849,6 @@ function updateUserInformation(options) {
     };
     if(options.ref_id) { bodyParams.ref_id = options.ref_id; }
     if(options.ext_email) { bodyParams.ext_email = options.ext_email; }
-    if(options.ext_username) { bodyParams.ext_username = options.ext_username; }
     if(options.ext_first_name) { bodyParams.ext_first_name = options.ext_first_name; }
     if(options.ext_last_name) { bodyParams.ext_last_name = options.ext_last_name; }
     if(options.address) { bodyParams.address = options.address; }

package/lib/services/spacesextn/index.js

@@ -42,8 +42,7 @@ function spacesextn(accountId) {
   this.accountId = accountId;
   return {
     entitleBulkUsersToProducts: entitleBulkUsersToProducts.bind(this),
-    setupUser: setupUser.bind(this),
-    deleteUserAccount : deleteUserAccount.bind(this)
+    setupUser: setupUser.bind(this)
   };
 }
 
@@ -130,47 +129,3 @@ function setupUser(options) {
   }
   return deferred.promise;
 }
-
-/**
- * Wiki Link for SDK params
- * https://github.com/comprodls/comprodls-sdk-js/wiki/04_AUTH-Adapter#getuserprofileparams
- */
-function deleteUserAccount(options) {
-  var self = this;
-  return new Promise(function(resolve, reject) {
-
-    if (options.ext_user_id && options.body) {
-      //Passed all validations, Contruct API url
-      var url = self.config.DEFAULT_HOSTS.AUTHEXTN +
-        self.config.AUTHEXTN_API_URLS.deleteUserAccount;
-      url = helpers.api.constructAPIUrl(url, {
-        accountid: self.accountId,
-        ext_user_id: options.ext_user_id,
-      });
-
-      // Setup request
-      var requestAPI = request.delete(url)
-        .set('Content-Type', 'application/json')
-        .set('Accept', 'application/json');
-      if (self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
-
-      requestAPI
-        .send(options.body)
-        .agent(keepaliveAgent)
-        .end(function(error, response) {
-          if (error) {
-            var err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, error);
-            reject(err);
-          } else {
-            resolve(response.body);
-          }
-        });
-    } else {
-      var err = {};
-      err.description = 'Mandatory field \'ext_user_id\' or \'body\' in request options.';
-      err.message = err.description;
-      err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
-      reject(err);
-    }
-  });
-}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "comprodls-sdk",
   "description": "comproDLS SDK for JavaScript",
-  "version": "2.112.0-thor.1",
+  "version": "2.113.0",
   "author": {
     "name": "Compro Technologies Private Limited",
     "url": "http://www.comprotechnologies.com/"
@@ -16,7 +16,8 @@
     "pubnub": "7.5.0",
     "q": "~1.4.1",
     "string-template": "^1.0.0",
-    "superagent": "3.8.3"
+    "superagent": "3.8.3",
+    "validate.js": "^0.9.0"
   },
   "devDependencies": {
     "grunt": "^0.4.5",