comprodls-sdk 2.90.3-development → 2.92.0-thor

package/lib/services/xapi/index.js

@@ -23,10 +23,6 @@
  * Functions for calling xAPI.
  ************************************************************/
 
-/*********************************
- * Setting Up Module Entry Point  
- **********************************/
-
 var q = require('q');
 var request = require('superagent');
 
@@ -42,74 +38,13 @@ function xapi(accountId) {
   this.accountId = accountId;
   return {
     postStatement: postStatements.bind(this),
-    postExternalStatements: postExternalStatements.bind(this),
-    resetUserProductProgress: resetUserProductProgress.bind(this)
+    postExternalStatements: postExternalStatements.bind(this)
   };
 }
 
-/*
-options = {
-  actor: {
-    uuid: 'string', // userid of user posting statement / 'me'
-    group: 'string' // (optional)
-  },
-  product: { // optional
-    code: 'string',
-    title: 'string' // (optional)
-    ext-item: boolean  // (optional, all items in entities will be treated as external items, hence no progress JSON update for them)
-  },
-  classid: 'string', // (optional) Specify if posting via class,
-  space_key: 'string'// (optional)
-
-  entities: [{
-    assigned_path_id: 'string' //optional, assigned-path of a class
-    timestamp: 0,
-    verb: 'string', // [redo | evaluated | launched | interacted | completed | answered | attempted | scored | submitted']
-          //('redo' verb can only be sent by teacher, admin and superadmin )
-    model: 'string', // (optional) model hierarchy of resource if available
-    item-code: 'string', // item-code of resource(optional)
-    user_data: {
-        documentid: 'string',
-        folderid: 'string',
-        action: 'create/update/delete',
-        type: 'string',
-        payload: 'string'
-    },
-    timespent: 0, // (optional)
-    activity_status: 'string', // (optional) ['in_process', 'timed_out', 'completed']
-    result: { // (optional)
-      response: {
-          audioPath: 'string',
-          text: 'string',
-          link: [
-            {
-              url: 'string',
-              title: 'string',
-              description: 'string'
-            }
-          ],
-          attribs: {}
-      },
-      score: { // optional
-        min: 0,
-        scaled: 0,
-        max: 0,
-        raw: 0
-      },
-      comment: 'string', // optional
-      questions: [{ // optional
-        question-code: 'string',
-        status-progress: 'string',  // [not_attempted | in_progress]
-        status-evaluation: 'string' // [not_applicable | partially_correct | correct | incorrect]
-      }]
-    },
-    link-statementid: 'string' // required in case of verb = evaluated
-  }],
-  platform: {
-    ua: 'string',
-    sessionid: 'string'
-  }
-};
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/08_XAPI-Adapter#poststatementsparams
 */
 function postStatements(options) {
   var self = this;
@@ -149,64 +84,9 @@ function postStatements(options) {
   return dfd.promise;
 }
 
-/*
-options = {
-  actor: {
-    ext_user_id: 'string', // (optional) who triggered the action - EXTERNAL_SYSTEM in case of verb = evaluated_external
-    uuid: 'string' // who triggered the action - EXTERNAL_SYSTEM in case of verb = evaluated_external
-  },
-  product: {
-    code: 'string',
-    title: 'string' // (optional)
-    ext-item: boolean  // (optional, all items in entities will be treated as external items, hence no progress JSON update for them)
-  },
-  student_userid: "string", // (optional when verb = submitted_external) ON whom is the action taking place
-  student_ext_user_id: "string", // (optional when verb = submitted_external) ON whom is the action taking place
-  classid: 'string', // (optional) Specify if posting via class
-  space_key: 'string', // (optional)
-  platform: {
-    ua: "string"
-  },
-  group: {           // (optional)
-    id: "string"
-  }
-  entities: [{
-    assigned_path_id: 'string' //(optional) assigned-path of a class
-    timestamp: 0,
-    verb: 'string', // [evaluated_external, submitted_external]
-    model: 'string', // (optional) model hierarchy of resource if available
-    item-code: 'string', // item-code of resource
-    timespent: 0, // (optional)
-    part: integer, // (mandatory only for verb = evaluated_external)
-    submission_order: integer, //  [1, 2, 3]
-    result: { // (optional)
-      "response": {
-        "text": "string",
-        "audioPath": "string",
-        "link": [
-          {
-            "url": "string",
-            "title": "string",
-            "description": "string"
-          }
-        ]
-      },
-      "score": {
-        "min": 0,
-        "scaled": 0,
-        "max": 0,
-        "raw": 0
-      },
-      "comment": "string",  // (optional)
-      "ext_data": "string", // (optional)
-      questions: [{         // (optional)
-        question-code: 'string',
-        status-progress: 'string',  // [not_attempted | in_progress]
-        status-evaluation: 'string' // [not_applicable | partially_correct | correct | incorrect]
-      }]
-    }
-  }]
-}
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/08_XAPI-Adapter#postexternalstatementsparams
 */
 function postExternalStatements(options) {
   var self = this;
@@ -232,44 +112,3 @@ function postExternalStatements(options) {
   });
   return dfd.promise;
 }
-
-/*options = {
-    userid: 'string',
-    productcode: 'string',
-    actorid: 'string'
-}*/
-function resetUserProductProgress(options) {
-  var self = this;
-  // Initializing promise
-  var dfd = q.defer();
-  var err = {};
-  if(options && options.userid && options.productcode && options.actorid) {
-
-    // Passed all validations, Contruct API url
-    var url = self.config.DEFAULT_HOSTS.XAPI + self.config.XAPI_API_URLS.resetUserProductProgress;
-    url = helpers.api.constructAPIUrl(url, { accountId : self.accountId });
-
-    // Setup request with URL and Params
-    var requestAPI = request.delete(url)
-                    .set('Content-Type', 'application/json')
-                    .set('Accept', 'application/json')
-                    .send(options);
-
-    if(self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
-
-    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 {
-    err.message = err.description = 'userid, productcode or actorid not found in request options.';
-    err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
-    dfd.reject(err);
-  }
-
-  return dfd.promise;
-}

package/lib/token/index.js

@@ -17,6 +17,7 @@
  * is strictly forbidden unless prior written permission is obtained
  * from Compro Technologies Pvt. Ltd..
  ***************************************************************************/
+
 /***********************************************************
  * comproDLS SDK Token Manager Module
  * Provides Token managements functions for the SDK
@@ -28,87 +29,92 @@ var helpers = require('../helpers');
 var DLSError = helpers.errors.DLSError;
 var validations = require('./validations');
 
-/*************************************
- * Setting up Exports/Public functions
- *************************************/
 exports.authWithExtUser = authWithExtUser;
 exports.authWithToken = authWithToken;
 
+
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/02_Authentication-and-Tokens#authwithextuser
+ */
 function authWithExtUser(organizationId, options) {
-    var self = this;
-    var dfd = q.defer();
+  var self = this;
+  var dfd = q.defer();
 
-    //Validation
-    var err = validations.validateAuthWithExtUser(organizationId, options);
-    if (err) {
-        dfd.reject(err);
-    } else {
-        //Passed all Validations, Setup the GET TOKEN API URL.
-        var url = this.config.DEFAULT_HOSTS['AUTH'] + this.config.AUTH_API_URLS.getExtUserTokenAPI;
-        url = helpers.api.constructAPIUrl(url, {"orgId" : organizationId});
+  //Validation
+  var err = validations.validateAuthWithExtUser(organizationId, options);
+  if (err) {
+    dfd.reject(err);
+  } else {
+    //Passed all Validations, Setup the GET TOKEN API URL.
+    var url = this.config.DEFAULT_HOSTS['AUTH'] + this.config.AUTH_API_URLS.getExtUserTokenAPI;
+    url = helpers.api.constructAPIUrl(url, {'orgId' : organizationId});
 
-        //Setup Credentials
-        var params = {
-            "ext_user_id": options.ext_user_id
+    //Setup Credentials
+    var params = {
+      'ext_user_id': options.ext_user_id
+    };
+    //Call the comproDLS GET TOKEN API
+    request.post(url).send(params).end(function(err, response) {
+      if (err) {
+        //API Error, Construct Standard SDK error response
+        err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
+        dfd.reject(err);
+      } else {
+        //Success, Extract the Token & Other useful information
+        var token = {
+          'access_token': response.body.access_token
+        };
+        var user = response.body.user;
+        var responseObj = {
+          'token': token,
+          'user': user,
+          'metrics': response.body.metrics
         };
-        //Call the comproDLS GET TOKEN API
-        request.post(url).send(params).end(function(err, response) {
-            if (err) {
-                //API Error, Construct Standard SDK error response
-                err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
-                dfd.reject(err);
-            } else {
-
-                //Success, Extract the Token & Other useful information
-                var token = {
-                    'access_token': response.body.access_token
-                };
-                var user = response.body.user;
-                var responseObj = {
-                    'token': token,
-                    'user': user,
-                    'metrics': response.body.metrics
-                }
 
-                //Setting token and organisationid in comproDLS instance
-                self.token = token;
-                self.orgId = user.org.id;
+        //Setting token and organisationid in comproDLS instance
+        self.token = token;
+        self.orgId = user.org.id;
 
-                dfd.resolve(responseObj);
-            }
-        });
-    }
-    return dfd.promise;
+        dfd.resolve(responseObj);
+      }
+    });
+  }
+  return dfd.promise;
 };
 
+/**
+ * Wiki Link for SDK params
+ * https://github.com/comprodls/comprodls-sdk-js/wiki/02_Authentication-and-Tokens#authwithtoken
+ */
 function authWithToken(organizationId, token, options) {
-    var self = this;
-    var dfd = q.defer();
+  var self = this;
+  var dfd = q.defer();
 
-    //Validation
-    var err = validations.authWithToken(organizationId, token ,options);
-    if (err) {
-        dfd.reject(err);
-    } else {
+  //Validation
+  var err = validations.authWithToken(organizationId, token ,options);
+  if (err) {
+    dfd.reject(err);
+  } else {
 
-        //Setting token and organisationid in comproDLS instance
-        self.token = token;
-        self.orgId = organizationId;
+    //Setting token and organisationid in comproDLS instance
+    self.token = token;
+    self.orgId = organizationId;
 
-        if (options && options.getuserdetails) {
-            self.Auth().getUserProfile().then(function(response) {
-                var responseObj = {
-                    'token': self.token,
-                    'user': response
-                }
-                dfd.resolve(responseObj);
-            }, function(err) {
-                err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
-                dfd.reject(err);
-            });
-        } else {
-            dfd.resolve(self.token);
-        }
+    if (options && options.getuserdetails) {
+      self.Auth().getUserProfile().then(function(response) {
+        var responseObj = {
+          'token': self.token,
+          'user': response
+        };
+        dfd.resolve(responseObj);
+      }, function(err) {
+        err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
+        dfd.reject(err);
+      });
+    } else {
+      dfd.resolve(self.token);
     }
-    return dfd.promise;
+  }
+  return dfd.promise;
 };

package/lib/token/validations.js

@@ -17,15 +17,13 @@
  * is strictly forbidden unless prior written permission is obtained
  * from Compro Technologies Pvt. Ltd..
  ***************************************************************************/
+
 /***********************************************************
  * comproDLS Token Module Validations
  * This module contains validations for token manager module.
  ************************************************************/
 var validate = require('../helpers').validations.validate;
 
-/****************************************************
- * Setting up Exports/Public variables 
- *****************************************************/
 exports.authWithToken = validateAuthWithToken;
 exports.validateAuthWithExtUser = validateAuthWithExtUser;
 
@@ -33,56 +31,55 @@ exports.validateAuthWithExtUser = validateAuthWithExtUser;
  * Public Function definitions
  **********************************/
 function validateAuthWithToken(organizationId, token ,options) {
-    var validate_options = {
-        'organization': organizationId,
-        'token': token,
-        'options': options
-    };
+  var validate_options = {
+    'organization': organizationId,
+    'token': token,
+    'options': options
+  };
 
-    var validate_constraints = {
-        "organization": {
-            "isString": true,
-            "presence": true
-        },
-        "token": {
-            "isObject": true,
-            "presence": true,
-            "contains": ["access_token"]
-        },
-        "token.access_token": {
-            "isString": true,
-            "presence": true
-        },
-        "options": {
-            "isObject": true
-        }
-    };
+  var validate_constraints = {
+    'organization': {
+      'isString': true,
+      'presence': true
+    },
+    'token': {
+      'isObject': true,
+      'presence': true,
+      'contains': ['access_token']
+    },
+    'token.access_token': {
+      'isString': true,
+      'presence': true
+    },
+    'options': {
+      'isObject': true
+    }
+  };
 
-    return validate(validate_options, validate_constraints);
+  return validate(validate_options, validate_constraints);
 };
 
 function validateAuthWithExtUser(organizationId, options) {
-    var validate_options = {
-        'organization': organizationId,
-        'options': options
-    };
+  var validate_options = {
+    'organization': organizationId,
+    'options': options
+  };
 
-    var validate_constraints = {
-        "organization": {
-            "isString": true,
-            "presence": true
-        },
-        "options": {
-            "isObject": true,
-            "presence": true,
-            "contains": ["ext_user_id"]
-        },
-        "options.ext_user_id": {
-            "isString": true,
-            "presence": true
-        }
-    };
+  var validate_constraints = {
+    'organization': {
+      'isString': true,
+      'presence': true
+    },
+    'options': {
+      'isObject': true,
+      'presence': true,
+      'contains': ['ext_user_id']
+    },
+    'options.ext_user_id': {
+      'isString': true,
+      'presence': true
+    }
+  };
 
-    return validate(validate_options, validate_constraints);
+  return validate(validate_options, validate_constraints);
 };
-

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "comprodls-sdk",
   "description": "comproDLS SDK for JavaScript",
-  "version": "2.90.3-development",
+  "version": "2.92.0-thor",
   "author": {
     "name": "Compro Technologies Private Limited",
     "url": "http://www.comprotechnologies.com/"
@@ -13,7 +13,6 @@
   },
   "dependencies": {
     "agentkeepalive": "4.2.0",
-    "extend": "3.0.2",
     "pubnub": "7.5.0",
     "q": "~1.4.1",
     "string-template": "^1.0.0",
@@ -24,7 +23,7 @@
     "grunt": "^0.4.5",
     "grunt-browserify": "^4.0.1",
     "grunt-contrib-clean": "^1.0.0",
-    "grunt-contrib-uglify": "^0.11.1",
+    "grunt-contrib-uglify": "4.0.1",
     "semver": "^5.1.0",
     "shelljs": "^0.6.0"
   }

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

@@ -1,73 +0,0 @@
-/*************************************************************************
- *
- * 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/utils.js

@@ -1,24 +0,0 @@
-/*************************************************************************
- *
- * 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";