comprodls-sdk 2.56.0 → 2.58.0

package/lib/config/index.js

@@ -40,6 +40,9 @@ exports.REALM_HOSTS = {
       ANALYTICS: 'http://internal-dls-global-prod1-1755536919.us-west-2.elb.amazonaws.com/lb-analytics',
       INTEGRATION: 'http://internal-dls-global-prod1-1755536919.us-west-2.elb.amazonaws.com/lb-integrations',
       DRIVE: 'http://internal-dls-global-prod1-1755536919.us-west-2.elb.amazonaws.com/lb-drive'
+    },
+    DEVELOPMENT: {
+      ANALYTICS: 'http://localhost:4000'
     }
   },
   ASGARD: {

package/lib/services/analytics/index.js

@@ -1489,7 +1489,9 @@ function getQuestionProgressByLearningObjective(questionsArray) {
     "classid": "string", // required
     "status_active": <boolean>,
     "status_not_started": <boolean>,
-    "status_expired": <boolean>
+    "status_expired": <boolean>,
+    "limit": integer,    // Number of entities to be fetched
+    "cursor": "string"   // cursor to get next set of assignments
   };
 */
 function getAllAssignedPathsOfClass(options) {
@@ -1509,7 +1511,9 @@ function getAllAssignedPathsOfClass(options) {
         classid: options.classid,
         status_not_started: options.status_not_started,
         status_active: options.status_active,
-        status_expired: options.status_expired
+        status_expired: options.status_expired,
+        limit: options.limit,
+        cursor: options.cursor
       };
 
       // Setup request with URL and Params
@@ -1521,7 +1525,9 @@ function getAllAssignedPathsOfClass(options) {
       // setting up traceid
       if(self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
 
-      requestAPI.end(function (error, response) {
+      requestAPI
+      .agent(keepaliveAgent)
+      .end(function (error, response) {
         if(error) {
           err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, error);
           dfd.reject(err);
@@ -1598,7 +1604,9 @@ function getAssignedPathAnalytics(options) {
     "status_not_started": <boolean>,
     "status_expired": <boolean>,
     "progress" : "true/false",
-    "group" : "true/false"
+    "group" : "true/false",
+    "limit": integer,    // Number of entities to be fetched
+    "cursor": "string"   // cursor to get next set of assignments
   };
 */
 function getMyAssignedPathsOfClass(options) {
@@ -1620,6 +1628,8 @@ function getMyAssignedPathsOfClass(options) {
       if(options.status_not_started) { queryParams.status_not_started =  options.status_not_started; }
       if(options.status_active) { queryParams.status_active =  options.status_active; }
       if(options.status_expired) { queryParams.status_expired =  options.status_expired; }
+      if(options.limit) { queryParams.limit =  options.limit; }
+      if(options.cursor) { queryParams.cursor =  options.cursor; }
 
       // Setup request with URL and Params
       var requestAPI = request.get(url).query(queryParams);
@@ -1629,7 +1639,9 @@ function getMyAssignedPathsOfClass(options) {
       // setting up traceid
       if(self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
 
-      requestAPI.end(function (error, response) {
+      requestAPI
+      .agent(keepaliveAgent)
+      .end(function (error, response) {
         if(error) {
           err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, error);
           dfd.reject(err);

package/lib/services/auth/index.js

@@ -682,7 +682,9 @@ function getUserClasses(options) {
     requestAPI = helpers.api.setupAPIToken(requestAPI, self.token);
 
     // Call GET ALL USER Api
-    requestAPI.end(function(err, response) {
+    requestAPI
+    .agent(keepaliveAgent)
+    .end(function(err, response) {
       if(err) {
         err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
         dfd.reject(err);
@@ -1182,7 +1184,9 @@ function getAllClasses(options) {
         requestAPI = helpers.api.setupAPIToken(requestAPI, self.token);
 
         //Call GET ALL USER Api
-        requestAPI.end(function(err, response) {
+        requestAPI
+          .agent(keepaliveAgent)
+          .end(function(err, response) {
             if(err) {
               var esErrOptions = { type: helpers.errors.ERROR_TYPES.API_ERROR, err: err };
               var error = converter.convertElasticsearchErrResponse(esErrOptions);
@@ -1227,6 +1231,10 @@ function getAllClasses(options) {
                   teacherCount: classEntity.teacherCount
                 };
 
+                if(classEntity.limits){
+                  classObj.limits = classEntity.limits;
+                }
+
                 /**
                  * Add class-tag association specific fields
                  */
@@ -1663,7 +1671,9 @@ function enrollUsertoClass(options) {
       requestAPI = helpers.api.setupAPIToken(requestAPI, self.token);
 
       //Call GET Product by it's code Api
-      requestAPI.end(function(err, response) {
+      requestAPI
+      .agent(keepaliveAgent)
+      .end(function(err, response) {
         if(err) {
           err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
           dfd.reject(err);
@@ -1716,7 +1726,9 @@ function enrollSelftoClass(options) {
       requestAPI = helpers.api.setupAPIToken(requestAPI, self.token);
 
       //Call GET Product by it's code Api
-      requestAPI.end(function(err, response) {
+      requestAPI
+      .agent(keepaliveAgent)
+      .end(function(err, response) {
         if(err) {
           err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
           dfd.reject(err);
@@ -1772,7 +1784,9 @@ function enrollMultiUserstoClass(options) {
       requestAPI = helpers.api.setupAPIToken(requestAPI, self.token);
 
       //Call GET Product by it's code Api
-      requestAPI.end(function(err, response) {
+      requestAPI
+      .agent(keepaliveAgent)
+      .end(function(err, response) {
         if(err) {
           err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
           dfd.reject(err);
@@ -1917,6 +1931,7 @@ function encodeURLParameter(options) {
  * ext_data: {}                              // Optional
  * analyticsharingmodel: ''                  // Optional - Valid values: ['NOINHERIT_SYNCBACK']
  * analytics_score_aggregation_type: ''      // Optional - Valid values: ['best'/'first'/'last']
+ * limits: {"los": number, "students": number}   // Optional field
  * }
  */
 function createClass(options) {
@@ -1954,7 +1969,9 @@ function createClass(options) {
             //Setup token in Authorization header
             requestAPI = helpers.api.setupAPIToken(requestAPI, self.token);
 
-            requestAPI.end(function(err, response) {
+            requestAPI
+            .agent(keepaliveAgent)
+            .end(function(err, response) {
                 if(err) {
                     err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
                     dfd.reject(err);
@@ -1981,6 +1998,7 @@ function createClass(options) {
 //    description: '',    //Optional field
 //    ext_data: ''        //Optional field
 //    analytics_score_aggregation_type: ''      // Optional - Valid values: ['best'/'first'/'last']
+//    limits: {"los": number, "students": number}   // Optional field
 //}
 function updateClass(options) {
     var self = this;
@@ -2006,7 +2024,9 @@ function updateClass(options) {
             //Setup token in Authorization header
             requestAPI = helpers.api.setupAPIToken(requestAPI, self.token);
 
-            requestAPI.end(function(err, response) {
+            requestAPI
+            .agent(keepaliveAgent)
+            .end(function(err, response) {
                 if(err) {
                     err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
                     dfd.reject(err);
@@ -2040,6 +2060,7 @@ function updateClass(options) {
       "model": "STRICT",
       "analyticsharingmodel":"NOINHERIT_SYNCBACK"  // optional
       "analytics_score_aggregation_type":"first/best/last"  // optional
+      limits: {los: number, students: number}   // Optional field
       "owner": {
         "userid": "string" //Mandatory if model is 'STRICT'
       },
@@ -2084,6 +2105,7 @@ function updateClass(options) {
         "analyticsharingmodel": true,
         "analytics_score_aggregation_type": true,
         "ext_data": true,
+        "limits": true,
         "advanced": {
           "students": [
             {
@@ -2117,7 +2139,8 @@ function updateClass(options) {
           ],
           "products": [ { "productcode": "string" } ],
           "analyticsharingmodel": "string"                 // Valid values: ['NOINHERIT_SYNCBACK']
-          "analytics_score_aggregation_type": "string"     // Valid values: ['best', 'first', 'last']
+          "analytics_score_aggregation_type": "string",     // Valid values: ['best', 'first', 'last']
+          "limits": {los: number, students: number}   // Optional field
         }
       }
     }
@@ -2150,7 +2173,9 @@ function createMultipleClasses(options) {
       //Setup token in Authorization header
       requestAPI = helpers.api.setupAPIToken(requestAPI, self.token);
 
-      requestAPI.end(function (err, response) {
+      requestAPI
+      .agent(keepaliveAgent)
+      .end(function (err, response) {
         if (err) {
           err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
           dfd.reject(err);
@@ -2327,12 +2352,18 @@ function deleteAssignedPath(options) {
   options = {
     classid: 'string' //mandatory
     assignedpathid: 'string' //mandatory
-    data:
-      {
-        title: 'string' //optional
-        startdate: 'string' //optional
-        duedate: 'string' //optional
-      }
+    data: {
+      title: 'string' //optional
+      startdate: 'string' //optional
+      duedate: 'string' //optional
+      items: [  //optional
+        {
+          item-code: 'string',  //mandatory
+          item_type: 'string',  //mandatory, ['dls-internal','external']
+          dls_product_code: 'string' //mandatory only if item_type is 'dls-internal'
+        }
+      ]
+    }
   }
 */
 function updateAssignedPath(options) {
@@ -2355,7 +2386,9 @@ function updateAssignedPath(options) {
       //Setup token in Authorization header
       requestAPI = helpers.api.setupAPIToken(requestAPI, self.token);
 
-      requestAPI.end(function (error, response) {
+      requestAPI
+        .agent(keepaliveAgent)
+        .end(function (error, response) {
         if(error) {
           err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, error);
           dfd.reject(err);
@@ -3117,7 +3150,9 @@ function cloneClass(options) {
       //Setup token in Authorization header
       requestAPI = helpers.api.setupAPIToken(requestAPI, self.token);
 
-      requestAPI.end(function(err, response) {
+      requestAPI
+      .agent(keepaliveAgent)
+      .end(function(err, response) {
         if(err) {
           err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
           dfd.reject(err);

package/lib/services/spaces/index.js

@@ -524,26 +524,34 @@ function provisionBulkSpaces(options) {
  *     *startdate: <epoch>,
  *     *enddate: <epoch>,
  *     description: 'string',
- *     ext_data: {}
+ *     ext_data: {},
+ *     limits: {
+ *       *los: 0,
+ *       *students: 0
+ *     }
+ *   },
+ *   checkLimits: {
+ *     student: 0,
+ *     teacher: 0
+ *   },
+ *   clone_settings: {
+ *     *src_ext_classid: 'string',
+ *     products: boolean,
+ *     assigned_paths: boolean,
+ *     advanced: {
+ *       assigned_paths: [                  //length > 0 if assigned_paths flag is true
+ *         {
+ *           *ext_assignedpathid: 'string',
+ *           *assigned_path_id: 'string',
+ *           startdate: 0,
+ *           *duedate: 0
+ *         },
+ *       ],
+ *       products: [
+ *         { *productcode: 'string' },
+ *       ]
+ *     }
  *   }
- *  clone_settings: {
- *    *src_ext_classid: 'string',
- *    products: boolean,
- *    assigned_paths: boolean,
- *    advanced: {
- *      assigned_paths: [                  //length > 0 if assigned_paths flag is true
- *        {
- *          *ext_assignedpathid: 'string',
- *          *assigned_path_id: 'string',
- *          startdate: 0,
- *          *duedate: 0
- *        },
- *      ],
- *      products: [
- *        { *productcode: 'string' },
- *      ]
- *    }
- *  }
  * }
  */
 function shadowProvision(options) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "comprodls-sdk",
   "description": "comproDLS SDK for JavaScript",
-  "version": "2.56.0",
+  "version": "2.58.0",
   "author": {
     "name": "Compro Technologies Private Limited",
     "url": "http://www.comprotechnologies.com/"