comprodls-sdk 2.54.2 → 2.55.1

package/lib/comprodls.js

@@ -33,7 +33,6 @@ var xapi = require('./services/xapi');
 var attempts = require('./services/attempts');
 var pushX = require('./services/pushX');
 var pub = require('./services/pub');
-var lrs = require('./services/lrs');
 var spaces = require('./services/spaces');
 var spacesextn = require('./services/spacesextn');
 var config = require('./config');
@@ -138,7 +137,6 @@ comproDLS.prototype.Product = product;
 comproDLS.prototype.Xapi = xapi;
 comproDLS.prototype.Attempts = attempts;
 comproDLS.prototype.Pub = pub;
-comproDLS.prototype.LRS = lrs;
 comproDLS.prototype.PushX = pushX;
 comproDLS.prototype.Spaces = spaces;
 comproDLS.prototype.SpacesExtn = spacesextn;

package/lib/config/index.js

@@ -350,7 +350,8 @@ exports.INTEGRATIONS_API_URLS = {
 
 exports.DRIVE_API_URLS = {
   getAParticularDocument: '/accounts/{accountid}/users/{extuserid}/documents/{documentid}',
-  getAllDocumentsInAFolder: '/accounts/{accountid}/users/{extuserid}/documents'
+  getAllDocumentsInAFolder: '/accounts/{accountid}/users/{extuserid}/documents',
+  documents: '/accounts/{accountid}/users/{userid}/documents/multi'
 };
 
 exports.TAXONOMY_API_URLS = {

package/lib/services/drive/index.js

@@ -29,19 +29,28 @@
 
 var q = require('q');
 var request = require('superagent');
+var Agent = require('agentkeepalive');
 
 var helpers = require('../../helpers');
 var DLSError = helpers.errors.DLSError;
 
 module.exports = documents;
 
+var keepaliveAgent = new Agent({
+  timeout: 60000,
+  freeSocketTimeout: 30000
+});
+
 /*********************************
  * Public Function definitions
  **********************************/
 function documents() {
   return {
     getAParticularDocument: getAParticularDocument.bind(this),
-    getAllDocumentsInAFolder: getAllDocumentsInAFolder.bind(this)
+    getAllDocumentsInAFolder: getAllDocumentsInAFolder.bind(this),
+    createMultipleDocuments: createMultipleDocuments.bind(this),
+    updateMultipleDocuments: updateMultipleDocuments.bind(this),
+    deleteMultipleDocuments: deleteMultipleDocuments.bind(this),
   };
 }
 
@@ -142,3 +151,181 @@ function getAllDocumentsInAFolder(options) {
   }
   return dfd.promise;
 }
+
+/*
+  options = {
+    accountid: 'string',          // mandatory
+    extuserid: 'string',          // mandatory
+    body: {                       // mandatory
+      orgid: 'string',            // mandatory
+      classid: 'string',
+      productcode: 'string',      // mandatory
+      dls_user_id: 'string',      // mandatory
+      entities: [                 // mandatory (Min length 1)
+        {
+          item_code: 'string',
+          folderid: 'string',     // mandatory
+          documentid: 'string',   // mandatory
+          tag: 'string',
+          timestamp: <epoch>,     // mandatory
+          ttl: <number>,          // optional, default - 3 months
+          data: {}                // mandatory, state JSON
+        },
+        ...
+      ]
+    }
+  }
+*/
+function createMultipleDocuments(options) {
+  var self = this;
+  var dfd = q.defer();
+
+  if (options && options.accountid && options.extuserid && options.body) {
+    // Passed all validations, Contruct API url
+
+    var url = self.config.DEFAULT_HOSTS.DRIVE + self.config.DRIVE_API_URLS.documents;
+    url = helpers.api.constructAPIUrl(url, {
+      accountid: options.accountid, userid: options.extuserid
+    });
+
+    // Setup request with URL and Params
+    var requestAPI = request.post(url)
+      .set('Content-Type', 'application/json')
+      .set('Accept', 'application/json')
+      .send(options.body);
+
+    if (self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
+
+    requestAPI
+      .agent(keepaliveAgent)
+      .end(function(error, response) {
+        if (error) {
+          var 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 = 'Mandatory param - accountid, extuserid or body' +
+      ' not found in request options.';
+    err = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, err);
+    dfd.reject(err);
+  }
+  return dfd.promise;
+}
+
+/*
+  options = {
+    accountid: 'string',          // mandatory
+    extuserid: 'string',          // mandatory
+    body: {                       // mandatory
+      entities: [                 // mandatory (Min length 1)
+        {
+          folderid: 'string',     // mandatory
+          documentid: 'string',   // mandatory
+          timestamp: <epoch>,     // mandatory
+          ttl: <number>,
+          data: {}
+        },
+        ...
+      ]
+    }
+  }
+*/
+function updateMultipleDocuments(options) {
+  // Initializing promise
+  var deferred = q.defer();
+  var self = this;
+  var error = {};
+
+  if (options && options.accountid && options.extuserid && options.body) {
+    // Passed all validations, Contruct API url
+    var url = self.config.DEFAULT_HOSTS.DRIVE + self.config.DRIVE_API_URLS.documents;
+
+    url = helpers.api.constructAPIUrl(url, {
+      accountid: options.accountid, userid: options.extuserid
+    });
+
+    // Setup request with URL and Params
+    var requestAPI = request.put(url)
+      .set('Content-Type', 'application/json')
+      .set('Accept', 'application/json')
+      .send(options.body);
+
+    if (self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
+
+    requestAPI
+      .agent(keepaliveAgent)
+      .end(function(error, response) {
+        if (error) {
+          error = new DLSError(helpers.errors.ERROR_TYPES.API_ERROR, error);
+          deferred.reject(error);
+        } else {
+          deferred.resolve(response.body);
+        }
+      });
+  } else {
+    error.message = error.description = 'Mandatory param - accountid, extuserid or body' +
+      ' not found in the request options.';
+    error = new DLSError(helpers.errors.ERROR_TYPES.SDK_ERROR, error);
+    deferred.reject(error);
+  }
+
+  return deferred.promise;
+}
+
+/*
+  options = {
+    accountid: 'string',        // mandatory
+    extuserid: 'string',        // mandatory
+    body: {                     // mandatory
+      entities: [               // mandatory (Min length 1)
+        {
+          folderid: 'string',   // mandatory
+          documentid: 'string', // mandatory
+        },
+        ...
+      ]
+    }
+  }
+*/
+function deleteMultipleDocuments(options) {
+  var self = this;
+  var dfd = q.defer();
+
+  if (options && options.accountid && options.extuserid && options.body) {
+    // Passed all validations, Contruct API url
+    var url = self.config.DEFAULT_HOSTS.DRIVE + self.config.DRIVE_API_URLS.documents;
+    url = helpers.api.constructAPIUrl(url, {
+      accountid: options.accountid, userid: options.extuserid
+    });
+
+    // Setup request with URL and Params
+    var requestAPI = request.delete(url)
+      .set('Content-Type', 'application/json')
+      .set('Accept', 'application/json')
+      .send(options.body);
+
+    if (self.traceid) { requestAPI.set('X-Amzn-Trace-Id', self.traceid); }
+
+    requestAPI
+      .agent(keepaliveAgent)
+      .end(function (error, response) {
+        if (error) {
+          var 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 = 'Mandatory param - accountid, extuserid or body' +
+      ' 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.54.2",
+  "version": "2.55.1",
   "author": {
     "name": "Compro Technologies Private Limited",
     "url": "http://www.comprotechnologies.com/"
@@ -18,7 +18,6 @@
     "q": "~1.4.1",
     "string-template": "^1.0.0",
     "superagent": "2.0.0",
-    "tincanjs": "^0.50.0",
     "validate.js": "^0.9.0"
   },
   "devDependencies": {