pryv 2.2.0 → 2.3.2

package/src/Browser/LoginButton.js

@@ -1,16 +1,20 @@
+/**
+ * @license
+ * [BSD-3-Clause](https://github.com/pryv/lib-js/blob/master/LICENSE)
+ */
 const Cookies = require('./CookieUtils');
 const AuthStates = require('../Auth/AuthStates');
 const AuthController = require('../Auth/AuthController');
-const Service = require('../Service');
 const Messages = require('../Auth/LoginMessages');
 const utils = require('../utils');
 
+/* global location, confirm */
+
 /**
- * @memberof Pryv.Browser
+ * @memberof pryv.Browser
  */
 class LoginButton {
-
-  constructor(authSettings, service) {
+  constructor (authSettings, service) {
     this.authSettings = authSettings;
     this.service = service;
     this.serviceInfo = service.infoSync();
@@ -22,14 +26,14 @@ class LoginButton {
   async init () {
     // initialize button visuals
     setupButton(this);
-    this.languageCode = this.authSettings.authRequest.languageCode || 'en';    
+    this.languageCode = this.authSettings.authRequest.languageCode || 'en';
     this.messages = Messages(this.languageCode);
     if (this.loginButtonText) {
       await loadAssets(this);
     }
     // set cookie key for authorization data
     this._cookieKey = 'pryv-libjs-' + this.authSettings.authRequest.requestingAppId;
-    
+
     // initialize controller
     this.auth = new AuthController(this.authSettings, this.service, this);
     await this.auth.init();
@@ -49,15 +53,16 @@ class LoginButton {
       case AuthStates.INITIALIZED:
         this.text = getInitializedMessage(this, this.serviceInfo.name);
         break;
-      case AuthStates.NEED_SIGNIN:
+      case AuthStates.NEED_SIGNIN: {
         const loginUrl = state.authUrl || state.url; // url is deprecated
-        if (this.authSettings.authRequest.returnURL) { // open on same page (no Popup) 
-          location.href = loginUrl; 
+        if (this.authSettings.authRequest.returnURL) { // open on same page (no Popup)
+          location.href = loginUrl;
           return;
         } else {
           startLoginScreen(this, loginUrl);
         }
         break;
+      }
       case AuthStates.AUTHORIZED:
         this.text = state.username;
         this.saveAuthorizationData({
@@ -65,13 +70,14 @@ class LoginButton {
           username: state.username
         });
         break;
-      case AuthStates.SIGNOUT:
+      case AuthStates.SIGNOUT: {
         const message = this.messages.SIGNOUT_CONFIRM ? this.messages.SIGNOUT_CONFIRM : 'Logout ?';
         if (confirm(message)) {
           this.deleteAuthorizationData();
           this.auth.init();
         }
         break;
+      }
       case AuthStates.ERROR:
         this.text = getErrorMessage(this, state.message);
         break;
@@ -88,7 +94,7 @@ class LoginButton {
   }
 
   saveAuthorizationData (authData) {
-    Cookies.set(this._cookieKey,authData);
+    Cookies.set(this._cookieKey, authData);
   }
 
   async deleteAuthorizationData () {
@@ -97,7 +103,7 @@ class LoginButton {
 
   /**
    * not mandatory to implement as non-browsers don't have this behaviour
-   * @param {*} authController 
+   * @param {*} authController
    */
   async finishAuthProcessAfterRedirection (authController) {
     // this step should be applied only for the browser
@@ -105,7 +111,7 @@ class LoginButton {
 
     // 3. Check if there is a prYvkey as result of "out of page login"
     const url = window.location.href;
-    let pollUrl = retrievePollUrl(url);
+    const pollUrl = retrievePollUrl(url);
     if (pollUrl !== null) {
       try {
         const res = await utils.superagent.get(pollUrl);
@@ -133,26 +139,26 @@ class LoginButton {
   }
 }
 
+module.exports = LoginButton;
+
 async function startLoginScreen (loginButton, authUrl) {
-  let screenX = typeof window.screenX !== 'undefined' ? window.screenX : window.screenLeft,
-    screenY = typeof window.screenY !== 'undefined' ? window.screenY : window.screenTop,
-    outerWidth = typeof window.outerWidth !== 'undefined' ?
-      window.outerWidth : document.body.clientWidth,
-    outerHeight = typeof window.outerHeight !== 'undefined' ?
-      window.outerHeight : (document.body.clientHeight - 22),
-    width = 400,
-    height = 620,
-    left = parseInt(screenX + ((outerWidth - width) / 2), 10),
-    top = parseInt(screenY + ((outerHeight - height) / 2.5), 10),
-    features = (
-      'width=' + width +
-      ',height=' + height +
-      ',left=' + left +
-      ',top=' + top +
-      ',scrollbars=yes'
-    );
-    loginButton.popup = window.open(authUrl, 'prYv Sign-in', features);
-  
+  const screenX = typeof window.screenX !== 'undefined' ? window.screenX : window.screenLeft;
+  const screenY = typeof window.screenY !== 'undefined' ? window.screenY : window.screenTop;
+  const outerWidth = typeof window.outerWidth !== 'undefined' ? window.outerWidth : document.body.clientWidth;
+  const outerHeight = typeof window.outerHeight !== 'undefined' ? window.outerHeight : (document.body.clientHeight - 22);
+  const width = 400;
+  const height = 620;
+  const left = parseInt(screenX + ((outerWidth - width) / 2), 10);
+  const top = parseInt(screenY + ((outerHeight - height) / 2.5), 10);
+  const features = (
+    'width=' + width +
+    ',height=' + height +
+    ',left=' + left +
+    ',top=' + top +
+    ',scrollbars=yes'
+  );
+  loginButton.popup = window.open(authUrl, 'prYv Sign-in', features);
+
   if (!loginButton.popup) {
     // loginButton.auth.stopAuthRequest('FAILED_TO_OPEN_WINDOW');
     console.log('Pop-up blocked. A second click should allow it.');
@@ -161,13 +167,13 @@ async function startLoginScreen (loginButton, authUrl) {
   }
 }
 
-function setupButton(loginBtn) {
+function setupButton (loginBtn) {
   loginBtn.loginButtonSpan = document.getElementById(loginBtn.authSettings.spanButtonID);
 
   if (!loginBtn.loginButtonSpan) {
-    console.log('WARNING: Pryv.Browser initialized with no spanButtonID');
+    console.log('WARNING: pryv.Browser initialized with no spanButtonID');
   } else {
-    // up to the time the button is loaded use the Span to display eventual 
+    // up to the time the button is loaded use the Span to display eventual
     // error messages
     loginBtn.loginButtonText = loginBtn.loginButtonSpan;
 
@@ -179,12 +185,11 @@ function setupButton(loginBtn) {
 /**
  * Loads the style from the service info
  */
-async function loadAssets(loginBtn) {
+async function loadAssets (loginBtn) {
   const assets = await loginBtn.service.assets();
   loginBtn.loginButtonSpan.innerHTML = await assets.loginButtonGetHTML();
   loginBtn.loginButtonText = document.getElementById('pryv-access-btn-text');
 }
-module.exports = LoginButton;
 
 function getErrorMessage (loginButton, message) {
   return loginButton.messages.ERROR + ': ' + message;

package/src/Browser/index.js

@@ -1,55 +1,29 @@
+/**
+ * @license
+ * [BSD-3-Clause](https://github.com/pryv/lib-js/blob/master/LICENSE)
+ */
 const LoginButton = require('./LoginButton');
 const CookieUtils = require('./CookieUtils');
-const Service = require('../Service');
 const utils = require('../utils');
 
 /**
- * @memberof Pryv
- * @namespace Pryv.Browser
- */
-
-/**
- * Start an authentication process
- * @memberof Pryv.Browser
- * @param {Object} settings
- * @param {Object} settings.authRequest See https://api.pryv.com/reference/#data-structure-access
- * @param {string} [settings.authRequest.languageCode] Language code, as per LoginButton Messages: 'en', 'fr
- * @param {string} settings.authRequest.requestingAppId Application id, ex: 'my-app'
- * @param {Object} settings.authRequest.requestedPermissions
- * @param {string | boolean} settings.authRequest.returnURL : false, // set this if you don't want a popup
- * @param {string} [settings.authRequest.referer] To track registration source 
- * @param {string} settings.spanButtonID set and <span> id in DOM to insert default login button or null for custom
- * @param {Browser.AuthStateChangeHandler} settings.onStateChange
- * @param {string} [settings.returnURL=auto#]  Set to "self#" to disable popup and force using the same page. Set a custom url when process is finished (specific use cases). Should always end by # ? or &
- * @param {string} serviceInfoUrl
- * @param {Object} [serviceCustomizations] override properties of serviceInfoUrl 
- * @returns {Pryv.Service}
+ * @memberof pryv
+ * @namespace pryv.Browser
  */
-async function setupAuth (settings, serviceInfoUrl, serviceCustomizations, HumanInteraction = LoginButton) {
-
-  let service = new Service(serviceInfoUrl, serviceCustomizations);
-  await service.info()
-
-  const humanInteraction = new HumanInteraction(settings, service);
-  await HumanInteraction.init();
-
-  return service;
-}
+module.exports = {
+  LoginButton,
+  CookieUtils,
+  // retro-compatibility for lib-js < 2.0.9
+  AuthStates: require('../Auth/AuthStates'),
+  setupAuth: require('../Auth').setupAuth,
+  serviceInfoFromUrl: getServiceInfoFromURL
+};
 
 /**
  * Util to grab parameters from url query string
- * @param {*} url 
+ * @param {*} url
  */
 function getServiceInfoFromURL (url) {
   const queryParams = utils.getQueryParamsFromURL(url || window.location.href);
-  return queryParams['pryvServiceInfoUrl'];
+  return queryParams.pryvServiceInfoUrl;
 }
-
-module.exports = {
-  LoginButton: LoginButton,
-  CookieUtils: CookieUtils,
-  // retro-compatibility for lib-js < 2.0.9
-  AuthStates: require('../Auth/AuthStates'),
-  setupAuth: require('../Auth').setupAuth,
-  serviceInfoFromUrl: getServiceInfoFromURL
-};

package/src/Connection.js

@@ -1,61 +1,62 @@
-
+/**
+ * @license
+ * [BSD-3-Clause](https://github.com/pryv/lib-js/blob/master/LICENSE)
+ */
 const utils = require('./utils.js');
-
 const jsonParser = require('./lib/json-parser');
-
 const browserGetEventStreamed = require('./lib/browser-getEventStreamed');
 
-
 /**
  * @class Connection
  * A connection is an authenticated link to a Pryv.io account.
- * 
+ *
  * @type {TokenAndEndpoint}
  *
  * @example
  * create a connection for the user 'tom' on 'pryv.me' backend with the token 'TTZycvBTiq'
- * const conn = new Pryv.Connection('https://TTZycvBTiq@tom.pryv.me');
+ * const conn = new pryv.Connection('https://TTZycvBTiq@tom.pryv.me');
  *
  * @property {string} [token]
  * @property {string} endpoint
- * @memberof Pryv
- * 
+ * @memberof pryv
+ *
  * @constructor
- * @this {Connection} 
- * @param {PryvApiEndpoint} pryvApiEndpoint
- * @param {Pryv.Service} [service] - eventually initialize Connection with a Service
+ * @this {Connection}
+ * @param {APIEndpoint} apiEndpoint
+ * @param {pryv.Service} [service] - eventually initialize Connection with a Service
  */
 class Connection {
-
-  constructor(pryvApiEndpoint, service) {
-    const { token, endpoint } = utils.extractTokenAndApiEndpoint(pryvApiEndpoint);
+  constructor (apiEndpoint, service) {
+    const { token, endpoint } = utils.extractTokenAndAPIEndpoint(apiEndpoint);
     this.token = token;
     this.endpoint = endpoint;
     this.options = {};
     this.options.chunkSize = 1000;
     this._deltaTime = { value: 0, weight: 0 };
-    if (! service instanceof Service) { throw new Error('Invalid service param'); }
+    if (service && !(service instanceof Service)) {
+      throw new Error('Invalid service param');
+    }
     this._service = service;
   }
 
   /**
-   * get Pryv.Service object relative to this connection
+   * get pryv.Service object relative to this connection
    * @readonly
-   * @property {Pryv.Service} service
+   * @property {pryv.Service} service
    */
-  get service() {
+  get service () {
     if (this._service) return this._service;
     this._service = new Service(this.endpoint + 'service/info');
     return this._service;
   }
 
   /**
-   * get username. 
+   * get username.
    * It's async as in it constructed from access info
-   * @param {*} arrayOfAPICalls 
-   * @param {*} progress 
+   * @param {*} arrayOfAPICalls
+   * @param {*} progress
    */
-  async username() {
+  async username () {
     const accessInfo = await this.accessInfo();
     return accessInfo.user.username;
   }
@@ -64,8 +65,8 @@ class Connection {
    * get access info
    * It's async as it is constructed with get function.
    */
-  async accessInfo(){
-    return this.get("access-info", null);
+  async accessInfo () {
+    return this.get('access-info', null);
   }
 
   /**
@@ -76,19 +77,19 @@ class Connection {
    * @param {Function} [progress] Return percentage of progress (0 - 100);
    * @returns {Promise<Array>} Promise to Array of results matching each method call in order
    */
-  async api(arrayOfAPICalls, progress) {
-    function httpHandler(batchCall) {
+  async api (arrayOfAPICalls, progress) {
+    function httpHandler (batchCall) {
       return this.post('', batchCall);
-    };
+    }
     return await this._chunkedBatchCall(arrayOfAPICalls, progress, httpHandler.bind(this));
   }
 
   /**
    * @private
    */
-  async _chunkedBatchCall(arrayOfAPICalls, progress, callHandler) {
-    if (! Array.isArray(arrayOfAPICalls)) {
-      throw new Error('Pryv.api() takes an array as input');
+  async _chunkedBatchCall (arrayOfAPICalls, progress, callHandler) {
+    if (!Array.isArray(arrayOfAPICalls)) {
+      throw new Error('Connection.api() takes an array as input');
     }
 
     const res = [];
@@ -97,86 +98,85 @@ class Connection {
       const thisBatch = [];
       const cursorMax = Math.min(cursor + this.options.chunkSize, arrayOfAPICalls.length);
       // copy only method and params into a back call to be exuted
-      for (let i = cursor; i < cursorMax ; i++) {      
-        thisBatch.push({ method: arrayOfAPICalls[i].method, params: arrayOfAPICalls[i].params});
+      for (let i = cursor; i < cursorMax; i++) {
+        thisBatch.push({ method: arrayOfAPICalls[i].method, params: arrayOfAPICalls[i].params });
       }
       const resRequest = await callHandler(thisBatch);
-      
+
       // result checks
-      if (! resRequest || ! Array.isArray(resRequest.results)) {
+      if (!resRequest || !Array.isArray(resRequest.results)) {
         throw new Error('API call result is not an Array: ' + JSON.stringify(resRequest));
       }
-      if (resRequest.results.length != thisBatch.length) {
+      if (resRequest.results.length !== thisBatch.length) {
         throw new Error('API call result Array does not match request: ' + JSON.stringify(resRequest));
       }
 
-
-      // eventually call handleResult 
+      // eventually call handleResult
       for (let i = 0; i < resRequest.results.length; i++) {
         if (arrayOfAPICalls[i + cursor].handleResult) {
           await arrayOfAPICalls[i + cursor].handleResult.call(null, resRequest.results[i]);
         }
       }
-      Array.prototype.push.apply(res, resRequest.results)
-      percent =  Math.round(100 * res.length / arrayOfAPICalls.length);
+      Array.prototype.push.apply(res, resRequest.results);
+      percent = Math.round(100 * res.length / arrayOfAPICalls.length);
       if (progress) { progress(percent, res); }
     }
     return res;
   }
 
   /**
-   * Post to API return results  
-   * @param {(Array | Object)} data 
+   * Post to API return results
+   * @param {(Array | Object)} data
    * @param {Object} queryParams
-   * @param {string} path 
-   * @returns {Promise<Array|Object>}  Promise to result.body
+   * @param {string} path
+   * @returns {Promise<Array|Object>} Promise to result.body
    */
-  async post(path, data, queryParams) {
-    const now = Date.now() / 1000;
+  async post (path, data, queryParams) {
+    const now = getTimestamp();
     const res = await this.postRaw(path, data, queryParams);
     this._handleMeta(res.body, now);
     return res.body;
   }
 
   /**
-   * Raw Post to API return superagent object  
-   * @param {Array | Object} data 
+   * Raw Post to API return superagent object
+   * @param {Array | Object} data
    * @param {Object} queryParams
-   * @param {string} path 
+   * @param {string} path
    * @returns {request.superagent}  Promise from superagent's post request
    */
-  async postRaw(path, data, queryParams) {
+  async postRaw (path, data, queryParams) {
     return this._post(path)
       .query(queryParams)
       .send(data);
   }
 
-   _post(path) {
+  _post (path) {
     return utils.superagent.post(this.endpoint + path)
       .set('Authorization', this.token)
       .set('accept', 'json');
   }
 
   /**
-   * Post to API return results  
+   * Post to API return results
    * @param {Object} queryParams
-   * @param {string} path 
+   * @param {string} path
    * @returns {Promise<Array|Object>}  Promise to result.body
    */
-  async get(path, queryParams) {
-    const now = Date.now() / 1000;
+  async get (path, queryParams) {
+    const now = getTimestamp();
     const res = await this.getRaw(path, queryParams);
     this._handleMeta(res.body, now);
-    return res.body
+    return res.body;
   }
 
   /**
    * Raw Get to API return superagent object
-   * @param {Object} queryParams 
-   * @param {string} path 
+   * @param {Object} queryParams
+   * @param {string} path
    * @returns {request.superagent}  Promise from superagent's get request
    */
-  getRaw(path, queryParams) {
+  getRaw (path, queryParams) {
     path = path || '';
     return utils.superagent.get(this.endpoint + path)
       .set('Authorization', this.token)
@@ -188,7 +188,7 @@ class Connection {
    * ADD Data Points to HFEvent (flatJSON format)
    * https://api.pryv.com/reference/#add-hf-series-data-points
    */
-  async addPointsToHFEvent(eventId, fields, points) {
+  async addPointsToHFEvent (eventId, fields, points) {
     const res = await this.post('events/' + eventId + '/series',
       {
         format: 'flatJSON',
@@ -202,26 +202,24 @@ class Connection {
   }
 
   /**
-   * Streamed get Event. 
-   * Fallbacks to not streamed, for browsers that does not support `fetch()` API 
+   * Streamed get Event.
+   * Fallbacks to not streamed, for browsers that does not support `fetch()` API
    * @see https://api.pryv.com/reference/#get-events
    * @param {Object} queryParams See `events.get` parameters
-   * @param {Function} forEachEvent Function taking one event as parameter. Will be called for each event 
+   * @param {Function} forEachEvent Function taking one event as parameter. Will be called for each event
    * @returns {Promise<Object>} Promise to result.body transformed with `eventsCount: {count}` replacing `events: [...]`
    */
-  async getEventsStreamed(queryParams, forEachEvent) {
+  async getEventsStreamed (queryParams, forEachEvent) {
     const myParser = jsonParser(forEachEvent, queryParams.includeDeletions);
     let res = null;
     if (typeof window === 'undefined') { // node
       res = await this.getRaw('events', queryParams)
         .buffer(false)
         .parse(myParser);
-
-    } else if (typeof fetch !== 'undefined' && !(typeof navigator != 'undefined' && navigator.product == 'ReactNative')) { // browser supports fetch and it is not react native
+    } else if (typeof fetch !== 'undefined' && !(typeof navigator !== 'undefined' && navigator.product === 'ReactNative')) { // browser supports fetch and it is not react native
       res = await browserGetEventStreamed(this, queryParams, myParser);
-
     } else { // browser no fetch supports
-      console.log('WARNING: Browser does not support fetch() required by Pryv.Connection.getEventsStreamed()');
+      console.log('WARNING: Browser does not support fetch() required by pryv.Connection.getEventsStreamed()');
       res = await this.getRaw('events', queryParams);
       res.body.eventsCount = 0;
       if (res.body.events) {
@@ -229,16 +227,16 @@ class Connection {
         res.body.eventsCount += res.body.events.length;
         delete res.body.events;
       }
-      if (res.body.eventDeletions) { // deletions are in a seprated Array 
+      if (res.body.eventDeletions) { // deletions are in a seprated Array
         res.body.eventDeletions.forEach(forEachEvent);
         res.body.eventsCount += res.body.eventDeletions.length;
         delete res.body.eventDeletions;
       }
     }
 
-    const now = Date.now() / 1000;
+    const now = getTimestamp();
     this._handleMeta(res.body, now);
-    return res.body
+    return res.body;
   }
 
   /**
@@ -247,31 +245,38 @@ class Connection {
    * @param {Event} event
    * @param {string} filePath
    */
-  async createEventWithFile(event, filePath) {
+  async createEventWithFile (event, filePath) {
     const res = await this._post('events')
       .field('event', JSON.stringify(event))
       .attach('file', filePath);
 
-    const now = Date.now() / 1000;
+    const now = getTimestamp();
     this._handleMeta(res.body, now);
-    return res.body
+    return res.body;
   }
 
   /**
    * Create an event from a Buffer
-   * NODE.jS ONLY
    * @param {Event} event
-   * @param {Buffer} bufferData
+   * @param {Buffer|Blob} bufferData - Buffer for node, Blob for browser
    * @param {string} fileName
    */
-   async createEventWithFileFromBuffer(event, bufferData, filename) {
-    const res = await this._post('events')
-      .field('event', JSON.stringify(event))
-      .attach('file', bufferData, filename);
-
-    const now = Date.now() / 1000;
-    this._handleMeta(res.body, now);
-    return res.body
+  async createEventWithFileFromBuffer (event, bufferData, filename) {
+    if (typeof window === 'undefined') { // node
+      const res = await this._post('events')
+        .field('event', JSON.stringify(event))
+        .attach('file', bufferData, filename);
+
+      const now = getTimestamp();
+      this._handleMeta(res.body, now);
+      return res.body;
+    } else {
+      /* global FormData */
+      const formData = new FormData();
+      formData.append('file', bufferData, filename);
+      const body = await this.createEventWithFormData(event, formData);
+      return body;
+    }
   }
 
   /**
@@ -280,10 +285,10 @@ class Connection {
  * @param {Event} event
  * @param {FormData} formData https://developer.mozilla.org/en-US/docs/Web/API/FormData/FormData
  */
-  async createEventWithFormData(event, formData) {
+  async createEventWithFormData (event, formData) {
     formData.append('event', JSON.stringify(event));
     const res = await this._post('events').send(formData);
-    return res.body
+    return res.body;
   }
 
   /**
@@ -292,33 +297,35 @@ class Connection {
    * @readonly
    * @property {number} deltaTime
    */
-  get deltaTime() {
+  get deltaTime () {
     return this._deltaTime.value;
   }
 
   /**
-   * Pryv API Endpoint of this connection
+   * API Endpoint of this connection
    * @readonly
-   * @property {PryvApiEndpoint} deltaTime
+   * @property {APIEndpoint} deltaTime
    */
-  get apiEndpoint() {
-    return utils.buildPryvApiEndpoint(this);
+  get apiEndpoint () {
+    return utils.buildAPIEndpoint(this);
   }
 
   // private method that handle meta data parsing
-    _handleMeta(res, requestLocalTimestamp) {
+  _handleMeta (res, requestLocalTimestamp) {
     if (!res.meta) throw new Error('Cannot find .meta in response.');
     if (!res.meta.serverTime) throw new Error('Cannot find .meta.serverTime in response.');
 
-    // update deltaTime and weight it 
+    // update deltaTime and weight it
     this._deltaTime.value = (this._deltaTime.value * this._deltaTime.weight + res.meta.serverTime - requestLocalTimestamp) / ++this._deltaTime.weight;
   }
-
 }
 
-
 module.exports = Connection;
 
+function getTimestamp () {
+  return Date.now() / 1000;
+}
+
 // service is require "after" to allow circular require
 const Service = require('./Service');
 
@@ -328,4 +335,4 @@ const Service = require('./Service');
  * @property {string} method - The method id
  * @property {(Object|Array)}  params - The call parameters as required by the method.
  * @property {(Function|Promise)} [handleResult] - Will be called with the result corresponding to this specific call.
- */
+ */