comprodls-sdk 2.83.0-alpha → 2.84.0

package/lib/config/index.js

@@ -139,6 +139,7 @@ exports.AUTH_API_URLS = {
     getParticularShadowClassAPI: '/org/{orgId}/shadow/classes/{extClassId}',
     classProductAssociation: '/org/{orgId}/classes/{classId}/associate-product/{productcode}',
     multiClassProductAssociations: '/org/{orgId}/classes/{classId}/associate-product/multi',
+    classMaterialAssociation: '/org/{orgId}/classes/{classId}/associate-materials/multi',
     enrollUsertoClass: '/org/{orgId}/classes/{classId}/enroll-user/{userId}',
     enrollSelftoClass: '/org/{orgId}/classes/{classId}/enroll-self',
     enrollMultiUserstoClass: '/org/{orgId}/classes/{classId}/enroll-user/multi',
@@ -321,8 +322,7 @@ exports.PRODUCT_API_URLS = {
 
 exports.XAPI_API_URLS = {
     postMultiStatements: '/{orgId}/statements/multi',
-    postExternalMultiStatements: '/{orgId}/external/statements/multi',
-    resetUserProductProgress: '/accounts/{accountId}/progress/user/product/reset'
+    postExternalMultiStatements: '/{orgId}/external/statements/multi'
 };
 
 exports.ATTEMPTS_API_URLS = {

package/lib/helpers/lib/errors.js

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

package/lib/services/auth/index.js

@@ -79,6 +79,8 @@ function auth() {
     createClassProductAssociation: createClassProductAssociation.bind(this),
     removeClassProductAssociation: removeClassProductAssociation.bind(this),
     createMultiClassProductAssociations: createMultiClassProductAssociations.bind(this),
+    associateMaterialsWithClass: associateMaterialsWithClass.bind(this),
+    unassociateMaterialsWithClass: unassociateMaterialsWithClass.bind(this),
     addItemsToShowcaseOfAClass: addItemsToShowcaseOfAClass.bind(this),
     deleteItemsFromShowcaseOfAClass: deleteItemsFromShowcaseOfAClass.bind(this),
 
@@ -1397,6 +1399,111 @@ function createClassProductAssociation(options) {
   return dfd.promise;
 }
 
+/**
+ * @param {
+ *   *classId: 'string',
+ *   *body: {
+ *     productcodes: ['string'],
+ *     bundlecodes: ['string'],
+ *   }
+ * } options
+ */
+function associateMaterialsWithClass(options) {
+  var self = this;
+  // Initializing promise
+  var dfd = q.defer();
+  // Validations
+  var err = helpers.validations.isAuthenticated(self.orgId, self.token);
+  if(err) { dfd.reject(err); }
+  else {
+    if(options && options.classId && options.body && (options.body.productcodes
+      || options.body.bundlecodes)) {
+      // Passed all validations, Contruct API url
+      var url = self.config.DEFAULT_HOSTS.AUTH +
+                self.config.AUTH_API_URLS.classMaterialAssociation;
+      url = helpers.api.constructAPIUrl(url, {
+        orgId: self.orgId, classId: options.classId
+      });
+      // 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); }
+
+      // Setup token in Authorization header
+      requestAPI = helpers.api.setupAPIToken(requestAPI, self.token);
+
+      requestAPI.agent(keepaliveAgent).end(function(err, response) {
+        if(err) {
+          err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
+          dfd.reject(err);
+        }
+        else { dfd.resolve(response.body); }
+      });
+    } else {
+      err = {};
+      err.message = err.description = 'classId or productcodes or bundlecodes not found in'
+        + 'request options.';
+      err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
+      dfd.reject(err);
+    }
+  }
+  return dfd.promise;
+}
+
+/**
+ * @param {
+ *   *classId: string,
+ *   *body: {
+ *    'productcodes' :['string'],
+ *    'bundlecodes' : ['string']
+ *    }
+ * } options
+ */
+function unassociateMaterialsWithClass(options) {
+  var self = this;
+  // Initializing promise
+  var dfd = q.defer();
+  // Validations
+  var err = helpers.validations.isAuthenticated(self.orgId, self.token);
+  if(err) { dfd.reject(err); }
+  else {
+    if(options && options.classId && options.body &&
+      (options.body.productcodes || options.body.bundlecodes)) {
+      // Passed all validations, Contruct API url
+      var url= self.config.DEFAULT_HOSTS.AUTH + self.config.AUTH_API_URLS.classMaterialAssociation;
+      url = helpers.api.constructAPIUrl(url, {
+        orgId: self.orgId, classId: options.classId
+      });
+      // Setup request with URL and Params
+      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); }
+
+      // Setup token in Authorization header
+      requestAPI = helpers.api.setupAPIToken(requestAPI, self.token);
+
+      requestAPI.agent(keepaliveAgent).end(function(err, response) {
+        if(err) {
+          err = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, err);
+          dfd.reject(err);
+        }
+        else { dfd.resolve(response.body); }
+      });
+    } else {
+      err = {};
+      const msg = 'classId or productcodes or bundlecodes not found in request options.';
+      err.message = msg;
+      err.description = msg;
+      err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
+      dfd.reject(err);
+    }
+  }
+  return dfd.promise;
+}
+
 //options = {
 //    classId: 'class uuid',
 //    productcode: 'product code'
@@ -2088,6 +2195,14 @@ function updateClass(options) {
           "productcode": "string",       //mandatory
           "title": ""
         }
+      ],
+      "bundles": [                      // optional
+        {
+          "bundlecode": "string",       //mandatory
+        },
+        {
+          "bundlecode": "string",       //mandatory
+        }
       ]
     }
   ],
@@ -2103,6 +2218,7 @@ function updateClass(options) {
         "students": true,
         "teachers": true,
         "products": true,
+        "bundles": true,
         "groups": true,
         "assigned_paths": true,
         "tags": true,
@@ -2143,6 +2259,7 @@ function updateClass(options) {
             }
           ],
           "products": [ { "productcode": "string" } ],
+          "bundles": [ { "bundlecode": "string" } ],
           "analyticsharingmodel": "string"                 // Valid values: ['NOINHERIT_SYNCBACK']
           "analytics_score_aggregation_type": "string",     // Valid values: ['best', 'first', 'last']
           "limits": {los: number, students: number}   // Optional field
@@ -2369,7 +2486,12 @@ function deleteAssignedPath(options) {
           item_type: 'string',  //mandatory, ['dls-internal','external']
           dls_product_code: 'string' //mandatory only if item_type is 'dls-internal'
         }
-      ]
+      ],
+      "rules": {},                // Optional
+      "context": {                // Optional (Needed for system event only)
+        "bundle-code": "string",
+        "space_key": "string"
+      }
     }
   }
 */
@@ -3134,6 +3256,7 @@ function deleteItemsFromShowcaseOfAClass(options){
  *  "students": true,
  *  "teachers": true,
  *  "products": true,
+ *  "bundles": true,
  *  "groups": true,
  *  "assigned_paths": true,
  *  "skip_assigned_path_create_notification": true,
@@ -3170,6 +3293,11 @@ function deleteItemsFromShowcaseOfAClass(options){
  *        "productcode": "string"
  *      }
  *    ],
+ *    "bundles": [
+ *      {
+ *        "bundlecode": "string"
+ *      }
+ *    ],
  *    "analyticsharingmodel": "NOINHERIT_SYNCBACK",
  *    "analytics_score_aggregation_type": "best",
  *    "limits": {

package/lib/services/pushX/index.js

@@ -80,11 +80,8 @@ function _connect(pubnubCW, options) {
       'publishKey': options.publishKey,
       'subscribeKey': options.subscribeKey,
       'ssl': true
-    },
-    'pollingEndpoint': options.pollingEndpoint,
-    'pollingIterations': options.pollingIterations || 10, // Default polling iterations is 10
-    'pollingInterval': options.pollingInterval, // Default polling interval is exponential backoff
-});
+    }
+  });
 }
 
 function _cleanup(pubnubCW) { pubnubCW.cleanup(); }

package/lib/services/pushX/pubnubClientWrapper.js

@@ -1,5 +1,4 @@
 var pubNub = require("pubnub");
-var request = require('superagent');
 var EventEmitter = require("events").EventEmitter;
 var helpers = require('../../helpers');
 
@@ -22,13 +21,6 @@ module.exports = function () {
     var _globalSubscription = [];
     var _globalSubscriptionStatus = {};
     var bStatusSubscribed = false;
-    /** ID of the setTimeout - used for Polling events when PubNub fails */
-    var _setTimeoutIDForPolling;
-    /** Timestamp from when the events need to be fetched */
-    var _startTimestampForPolling;
-    /** Counter for polling */
-    var _pollingCounter;
-    var bPollingInitiated = false;
 
     /** ###### END OF MODULE GLOBALS */
 
@@ -44,9 +36,6 @@ module.exports = function () {
         //Returning the adaptor (Plain Javascript object)
         return {
             "on": function (channelObj, handler) {
-                // If PubNub fails, we will fetch the events from this timestamp
-                _startTimestampForPolling = Date.now();
-
                 var pubNubChannel;
                 var channelContext = [];
 
@@ -75,9 +64,6 @@ module.exports = function () {
                     _eventEmitter.on(channelObj.channel, handler);
                     bStatusSubscribed = true;
                 }
-
-                // Clean up the old events
-                _checkOldBubbledEvents();
             },
             "getMySubscriptionStatus": __getMySubscriptionStatus
         };
@@ -91,10 +77,6 @@ module.exports = function () {
 
     var _translatePubnubStatus = function(status, options) {
         var channels = [], error, successObj;
-
-        // If polling has been initiated, ignore all punnub status
-        if (bPollingInitiated) return;
-
         switch (status.category) {
             case "PNConnectedCategory":
                 if(status.operation === "PNSubscribeOperation") {
@@ -156,10 +138,11 @@ module.exports = function () {
                 break;
             case "PNNetworkIssuesCategory":
                 if(status.operation === 'PNSubscribeOperation') {
-                    if(!options.accountId || !_userOptions.pollingEndpoint) {
+                    if(!options.accountId) {
                         error = {
-                            message: "Polling initiation error: Missing mandatory parameters to initiate polling operation - [accountId, pollingEndpoint]",
-                            status: status.statusCode
+                            message: "Missing mandatory parameters to initiate polling operation - accountId",
+                            status: status.statusCode,
+                            type: helpers.errors.ERROR_TYPES.POLLING_INITIATION,
                         };
                         error = new PUSHXError(helpers.errors.ERROR_CATEGORY.PUSHX, error);
                         _eventEmitter.emit('pushx_status', error);
@@ -173,9 +156,6 @@ module.exports = function () {
                          * The wrapper supports multiple channels, but the APP currently uses a single channel only.
                          * Polling will also limited to a single channel.
                          */
-                        _pollingCounter = 0;
-                        _pollForEvents();
-                        bPollingInitiated = true;
                     }
                 }
                 else {
@@ -188,8 +168,9 @@ module.exports = function () {
             default:
                 // Emit error for other status-category received from pubnub
                 error = {
-                    message: "PushX Error: unexpected error",
+                    message: "PushX Error",
                     status: status.statusCode,
+                    type: helpers.errors.ERROR_TYPES.UNEXPECTED_ERROR,
                     pushXError: status
                 };
                 error = new PUSHXError(helpers.errors.ERROR_CATEGORY.PUSHX, error);
@@ -226,7 +207,6 @@ module.exports = function () {
      * @returns PROMISE.
      */
     var __setup = function (userOptions) {
-
         var pubnubConfig = userOptions.pubnub;
         pubnubConfig.uuid = userOptions.userid;
         var accountId = userOptions.accountid;
@@ -265,169 +245,8 @@ module.exports = function () {
             _globalSubscription = [];
             bStatusSubscribed = false;
             _globalSubscriptionStatus = {};
-            bPollingInitiated = false;
         }
         _pubnubClient = undefined;
-
-        // Clear the Polling
-        if (_setTimeoutIDForPolling) {
-            clearTimeout(_setTimeoutIDForPolling);
-            // Setting the start time to now to clear the old events
-            _startTimestampForPolling = Date.now();
-            _checkOldBubbledEvents();
-            _setTimeoutIDForPolling = undefined;
-            _pollingCounter = undefined;
-            _startTimestampForPolling = undefined;
-        }
-    };
-
-    /**
-     * Polling function
-     */
-    var _pollForEvents = function () {
-        // Setup request params
-        var params = {
-            accountid: _userOptions.accountid,
-            channelname: _globalSubscription[0],
-            starttime: _startTimestampForPolling,
-            endtime: Date.now()
-        };
-
-        // Safe check to avoid poll for events if the channel name or start time is not set
-        // This handles an edge condition where the clearTimeout doesn't work as expected
-        if (!params.channelname || !params.starttime) {
-            return;
-        }
-
-        var requestAPI = request.get(_userOptions.pollingEndpoint).query(params);
-    
-        requestAPI
-            .end(function(error, response) {
-                
-                if (!error) {
-                    // Bubble the connected status
-                    if (_pollingCounter === 0) {
-                        // Set the status of the channel to subscribed
-                        if(_globalSubscriptionStatus[_globalSubscription[0]]) {
-                            _globalSubscriptionStatus[_globalSubscription[0]].status = 'subscribed';
-                        }
-
-                        var successObj = {
-                            category: 'PUSHX',
-                            type: 'CHANNEL_SUBSCRIPTION',
-                            status: 'SUCCESS',
-                            message: 'Success: Subscribed successfully.',
-                            httpcode: 200,
-                            data: {
-                                payload: {
-                                    channels: _globalSubscription
-                                },
-                                message: 'Success: Subscribed successfully.'
-                            }
-                        };
-                        _eventEmitter.emit('pushx_status', successObj);
-                    }
-
-                    // Bubble the received events
-                    _bubblePolledEvents(response.body);
-
-                    // Increase the counter
-                    _pollingCounter++;
-                }
-
-                // Polling will be done only for specific number of times
-                if (_pollingCounter > _userOptions.pollingIterations) {
-                    var error = {
-                        message: "Polling error: Polling limit exceeded",
-                        status: 429
-                    };
-                    error = new PUSHXError(helpers.errors.ERROR_CATEGORY.PUSHX, error);
-                    _eventEmitter.emit('pushx_status', error);
-                } else {
-                    var timeoutDelay;
-
-                    // If the polling interval is provided, use that
-                    if (_userOptions.pollingInterval) {
-                        timeoutDelay = _userOptions.pollingInterval * 60 * 1000;
-                    } else {
-                        // Else, use exponential backoff
-                        timeoutDelay = parseInt(Math.pow(1.3, _pollingCounter) * 10 * 1000, 10);
-                    }
-
-                    // Set timeout for next poll
-                    if (timeoutDelay) {
-                        _setTimeoutIDForPolling = setTimeout(_pollForEvents, timeoutDelay);
-                    }
-                }
-        });
-    };
-
-    /**
-     * Bubble the polled events to the FE APP
-     * @param {*} events - Events recieved from the polling endpoint 
-     */
-    var _bubblePolledEvents = function (events) {
-        // Load the old events from the session storage
-        var oldEventData = _checkOldBubbledEvents();
-
-        var oldEvents = oldEventData.events;
-        var sessionStorageKey = oldEventData.key;
-
-        for (var i = 0; i < events.entities.length; i++) {
-            var event = events.entities[i];
-            var eventId = event.pk + '_' + event.sk;
-
-            // Check if the event is already emitted
-            if (!oldEvents[eventId]) {
-                oldEvents[eventId] = event.context.start_time;
-
-                // Emit the event
-                _eventEmitter.emit(_globalSubscription[0], event);
-            }
-        }
-
-        // Save the bubbled events to session storage
-        sessionStorage.setItem(sessionStorageKey, JSON.stringify(oldEvents));
-    };
-
-    /**
-     * Check the old bubbled events and remove the events that are older than the start timestamp
-     * @returns {object} - Object containing the key and the events
-     */
-    var _checkOldBubbledEvents = function () {
-        var sessionStorageKey = 'comprodls.old_pushx_events.' + _userOptions.userid + '.' + _globalSubscription[0];
-        var oldEvents = sessionStorage.getItem(sessionStorageKey);
-
-        if (oldEvents) {
-            try {
-                oldEvents = JSON.parse(oldEvents);
-            } catch (e) {
-                oldEvents = {};
-            }
-
-            var oldEventIds = Object.keys(oldEvents);
-
-            // Remove the events that are older than the start timestamp
-            for (var i = 0; i < oldEventIds.length; i++) {
-                var oldEventId = oldEventIds[i];
-
-                if (oldEvents[oldEventId] < _startTimestampForPolling) {
-                    delete oldEvents[oldEventId];
-                }
-            }
-
-            // If the number of events has changed, save the events
-            if (oldEventIds.length !== Object.keys(oldEvents).length) {
-                sessionStorage.setItem(sessionStorageKey, JSON.stringify(oldEvents));
-            }
-        } else {
-            oldEvents = {};
-        }
-
-        return {
-            key: sessionStorageKey,
-            events: oldEvents
-        };
     };
 
     return { // Return public methods for the wrapper

package/lib/services/spaces/index.js

@@ -538,6 +538,7 @@ function provisionBulkSpaces(options) {
  *   clone_settings: {
  *     *src_ext_classid: 'string',
  *     products: boolean,
+ *     bundles: boolean,
  *     assigned_paths: boolean,
  *     ext_assigned_path_id_rule: 'string'  //enum: ['SRC_ID']
  *     advanced: {
@@ -551,6 +552,9 @@ function provisionBulkSpaces(options) {
  *       ],
  *       products: [
  *         { *productcode: 'string' },
+ *       ],
+ *       bundles: [
+ *         { *bundlecode: 'string' },
  *       ]
  *     }
  *   }

package/lib/services/xapi/index.js

@@ -42,8 +42,7 @@ function xapi(accountId) {
   this.accountId = accountId;
   return {
     postStatement: postStatements.bind(this),
-    postExternalStatements: postExternalStatements.bind(this),
-    resetUserProductProgress: resetUserProductProgress.bind(this)
+    postExternalStatements: postExternalStatements.bind(this)
   };
 }
 
@@ -232,44 +231,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/package.json

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