pryv 2.2.0 → 2.3.0

package/package.json

@@ -1,58 +1,24 @@
 {
   "name": "pryv",
-  "version": "2.2.0",
-  "homepage": "https://github.com/pryv/lib-js",
-  "description": "Pryv Javascript Library",
+  "version": "2.3.0",
+  "description": "Pryv JavaScript library",
   "keywords": [
-    "Pryv"
+    "Pryv",
+    "Pryv.io"
   ],
-  "repository": {
-    "type": "git",
-    "url": "git://github.com/pryv/lib-js"
-  },
+  "homepage": "https://github.com/pryv/lib-js",
   "bugs": {
     "url": "https://github.com/pryv/lib-js/issues"
   },
-  "author": {
-    "name": "Pryv S.A."
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/pryv/lib-js"
   },
+  "license": "BSD-3-Clause",
+  "author": "Pryv S.A. <info@pryv.com> (https://pryv.com)",
   "main": "src/index.js",
   "types": "src/index.d.ts",
-  "license": "BSD-3-Clause",
-  "scripts": {
-    "setup": "./scripts/setup-environment-dev.sh",
-    "build": "webpack --config webpack.config.js",
-    "doc": "npx jsdoc -c .jsdoc-conf.json",
-    "test": "mocha --reporter spec  test/**/*.test.js --timeout 3000",
-    "test-debug": "mocha --inpect-brk=40000 --reporter spec  test/**/*.test.js ",
-    "test:browser": "npm run build; ",
-    "cover": "nyc npm run test && npm run cover:report",
-    "cover:report": "nyc report --reporter=lcov --reporter=html",
-    "webserver": "./node_modules/.bin/rec-la ./dist 9443",
-    "gh-pages": "./scripts/upload.sh",
-    "clear": "rm -r dist/ && npm run setup"
-  },
-  "contributors": [
-    {
-      "name": "Pierre-Mikael Legris",
-      "email": "perki@pryv.com"
-    }
-  ],
   "dependencies": {
-    "superagent": "^7.0.2"
-  },
-  "devDependencies": {
-    "@pryv/lib-js-common": "github:pryv/lib-js-common#1.0.6",
-    "@pryv/monitor": "^1.0.6",
-    "@pryv/socket.io": "^1.0.6",
-    "chai": "^4.3.4",
-    "chai-as-promised": "^7.1.1",
-    "cuid": "^2.1.8",
-    "mocha": "^9.1.3",
-    "node-fetch": "^2.6.1",
-    "nyc": "^15.1.0",
-    "rec.la": "latest",
-    "universal-url": "^2.0.0",
-    "zombie": "^6.1.4"
+    "superagent": "^7.1.6"
   }
 }

package/src/Auth/AuthController.js

@@ -1,5 +1,8 @@
+/**
+ * @license
+ * [BSD-3-Clause](https://github.com/pryv/lib-js/blob/master/LICENSE)
+ */
 const utils = require('../utils');
-const Service = require('../Service');
 const AuthStates = require('./AuthStates');
 const Messages = require('./LoginMessages');
 
@@ -7,11 +10,10 @@ const Messages = require('./LoginMessages');
  * @private
  */
 class AuthController {
-
   /**
-   * 
-   * @param {*} settings 
-   * @param {*} service 
+   *
+   * @param {*} settings
+   * @param {*} service
    */
   constructor (settings, service, loginButton) {
     this.settings = settings;
@@ -24,20 +26,20 @@ class AuthController {
     this.service = service;
 
     // probably remove
-    this.languageCode = this.settings.authRequest.languageCode || 'en';    
+    this.languageCode = this.settings.authRequest.languageCode || 'en';
     this.messages = Messages(this.languageCode);
 
     this.loginButton = loginButton;
 
     function validateSettings (settings) {
       if (!settings) { throw new Error('settings cannot be null'); }
-      // -- settings 
+      // -- settings
       if (!settings.authRequest) { throw new Error('Missing settings.authRequest'); }
-  
-      // -- Extract returnURL 
+
+      // -- Extract returnURL
       settings.authRequest.returnURL =
         this.getReturnURL(settings.authRequest.returnURL);
-  
+
       if (!settings.authRequest.requestingAppId) {
         throw new Error('Missing settings.authRequest.requestingAppId');
       }
@@ -49,14 +51,14 @@ class AuthController {
 
   /**
    * async function to call right after instanciating object
-   * 
-   * @returns {PryvService}
+   *
+   * @returns {Service}
    */
   async init () {
     this.serviceInfo = this.service.infoSync();
     this.state = { status: AuthStates.LOADING };
     this.assets = await loadAssets(this);
-    
+
     const loginButton = this.loginButton;
     // initialize human interaction interface
     if (loginButton != null) {
@@ -66,14 +68,14 @@ class AuthController {
     }
 
     // if auto login is not prompted
-    if (this.state.status != AuthStates.AUTHORIZED) {
-      this.state = { status: AuthStates.INITIALIZED, serviceInfo: this.serviceInfo};
+    if (this.state.status !== AuthStates.AUTHORIZED) {
+      this.state = { status: AuthStates.INITIALIZED, serviceInfo: this.serviceInfo };
     }
 
     if (loginButton != null && loginButton.finishAuthProcessAfterRedirection != null) {
       await loginButton.finishAuthProcessAfterRedirection(this);
     }
-    
+
     return this.service;
   }
 
@@ -93,14 +95,14 @@ class AuthController {
     } else if (isInitialized.call(this)) {
       this.startAuthRequest();
     } else if (isNeedSignIn.call(this)) {
-      // reopen popup
-      this.state = this.state;
+      // reopen popup (HACK for now: set to private property to avoid self-assignment)
+      this.state = this._state;
     } else {
       console.log('Unhandled action in "handleClick()" for status:', this.state.status);
     }
 
     function isAuthorized () {
-      return this.state.status == AuthStates.AUTHORIZED;
+      return this.state.status === AuthStates.AUTHORIZED;
     }
     function isInitialized () {
       return this.state.status === AuthStates.INITIALIZED;
@@ -112,10 +114,10 @@ class AuthController {
 
   /**
    * Used only to retrieve returnUrl in browser environments
-   * 
-   * @param {*} returnURL 
-   * @param {*} windowLocationForTest 
-   * @param {*} navigatorForTests 
+   *
+   * @param {*} returnURL
+   * @param {*} windowLocationForTest
+   * @param {*} navigatorForTests
    */
   getReturnURL (
     returnURL,
@@ -127,24 +129,19 @@ class AuthController {
     returnURL = returnURL || RETURN_URL_AUTO + '#';
 
     // check the trailer
-    let trailer = returnURL.slice(-1);
+    const trailer = returnURL.slice(-1);
     if ('#&?'.indexOf(trailer) < 0) {
       throw new Error('Pryv access: Last character of --returnURL setting-- is not ' +
         '"?", "&" or "#": ' + returnURL);
     }
     // auto mode for desktop
-    if (
-      returnUrlIsAuto(returnURL) &&
-      !utils.browserIsMobileOrTablet(navigatorForTests)
-    ) {
+    if (returnUrlIsAuto(returnURL) &&
+        !utils.browserIsMobileOrTablet(navigatorForTests)) {
       return false;
-    } else if (
-      // auto mode for mobile or self
-      (returnUrlIsAuto(returnURL) &&
-        utils.browserIsMobileOrTablet(navigatorForTests)
-      )
-      || returnURL.indexOf('self') === 0
-    ) {
+    // auto mode for mobile or self
+    } else if ((returnUrlIsAuto(returnURL) &&
+                utils.browserIsMobileOrTablet(navigatorForTests)) ||
+               returnURL.indexOf('self') === 0) {
       // set self as return url?
       // eventually clean-up current url from previous pryv returnURL
       const locationHref = windowLocationForTest || window.location.href;
@@ -159,9 +156,9 @@ class AuthController {
 
   async startAuthRequest () {
     this.state = await postAccess.call(this);
-    
+
     await doPolling.call(this);
-    
+
     async function postAccess () {
       try {
         const res = await utils.superagent
@@ -178,22 +175,21 @@ class AuthController {
       }
     }
 
-    async function doPolling() {
+    async function doPolling () {
       if (this.state.status !== AuthStates.NEED_SIGNIN) {
         return;
       }
       const pollResponse = await pollAccess(this.state.poll);
-      
+
       if (pollResponse.status === AuthStates.NEED_SIGNIN) {
         setTimeout(await doPolling.bind(this), this.state.poll_rate_ms);
       } else {
         this.state = pollResponse;
       }
 
-      async function pollAccess(pollUrl) {
+      async function pollAccess (pollUrl) {
         try {
-          const res = await utils.superagent
-            .get(pollUrl)
+          const res = await utils.superagent.get(pollUrl);
           return res.body;
         } catch (e) {
           if (e.response &&
@@ -207,21 +203,18 @@ class AuthController {
         }
       }
     }
-
-    
   }
 
   // -------------- state listeners ---------------------
   set state (newState) {
-
     // retro-compatibility for lib-js < 2.0.9
     newState.id = newState.status;
 
     this._state = newState;
 
-    this.stateChangeListeners.map((listener) => {
+    this.stateChangeListeners.forEach((listener) => {
       try {
-        listener(this.state)
+        listener(this.state);
       } catch (e) {
         console.log('Error during set state ()', e);
       }
@@ -243,13 +236,13 @@ async function checkAutoLogin (authController) {
 
   const storedCredentials = await loginButton.getAuthorizationData();
   if (storedCredentials != null) {
-    authController.state = Object.assign({}, {status: AuthStates.AUTHORIZED}, storedCredentials);
+    authController.state = Object.assign({}, { status: AuthStates.AUTHORIZED }, storedCredentials);
   }
 }
 
 // ------------------ ACTIONS  ----------- //
 
-async function loadAssets(authController) {
+async function loadAssets (authController) {
   let loadedAssets = {};
   try {
     loadedAssets = await authController.service.assets();
@@ -259,7 +252,7 @@ async function loadAssets(authController) {
       if (thisMessages.LOADING) {
         authController.messages = Messages(authController.languageCode, thisMessages);
       } else {
-        console.log("WARNING Messages cannot be loaded using defaults: ", thisMessages)
+        console.log('WARNING Messages cannot be loaded using defaults: ', thisMessages);
       }
     }
   } catch (e) {

package/src/Auth/AuthStates.js

@@ -1,20 +1,20 @@
-
-
 /**
- * Enum Possible states: ERROR, LOADING, INITIALIZED, AUTHORIZED, SIGNOUT
+ * @license
+ * [BSD-3-Clause](https://github.com/pryv/lib-js/blob/master/LICENSE)
+ */
+/**
+ * The possible auth states:
+ * ERROR, LOADING, INITIALIZED, NEED_SIGNIN, AUTHORIZED, SIGNOUT, REFUSED
  * @readonly
  * @enum {string}
- * @memberof Pryv.Browser
+ * @memberof pryv.Browser
  */
-const AuthState = {
-  ERROR : 'ERROR',
-  LOADING : 'LOADING',
+module.exports = {
+  ERROR: 'ERROR',
+  LOADING: 'LOADING',
   INITIALIZED: 'INITIALIZED',
   NEED_SIGNIN: 'NEED_SIGNIN',
   AUTHORIZED: 'ACCEPTED',
   SIGNOUT: 'SIGNOUT',
-  REFUSED: 'REFUSED',
-} 
-
-
-module.exports = AuthState 
+  REFUSED: 'REFUSED'
+};

package/src/Auth/LoginMessages.js

@@ -1,29 +1,32 @@
+/**
+ * @license
+ * [BSD-3-Clause](https://github.com/pryv/lib-js/blob/master/LICENSE)
+ */
+module.exports = get;
+
 const Messages = {
   LOADING: {
-    'en': '...'
+    en: '...'
   },
   ERROR: {
-    'en': 'Error',
-    'fr': 'Erreur',
+    en: 'Error',
+    fr: 'Erreur'
   },
   LOGIN: {
-    'en': 'Signin',
-    'fr': 'Login'
+    en: 'Signin',
+    fr: 'Login'
   },
   SIGNOUT_CONFIRM: {
-    'en': 'Logout ?',
-    'fr': 'Se deconnecter ?'
+    en: 'Logout?',
+    fr: 'Se déconnecter ?'
   }
-}
+};
 
-function get(languageCode, definitions) {
+function get (languageCode, definitions) {
   const myMessages = definitions || Messages;
   const res = {};
-  Object.keys(myMessages).map((key) => {
-    res[key] = myMessages[key][languageCode] || myMessages[key]['en'];
+  Object.keys(myMessages).forEach((key) => {
+    res[key] = myMessages[key][languageCode] || myMessages[key].en;
   });
   return res;
 }
-
-
-module.exports = get;

package/src/Auth/index.js

@@ -1,43 +1,46 @@
+/**
+ * @license
+ * [BSD-3-Clause](https://github.com/pryv/lib-js/blob/master/LICENSE)
+ */
 const AuthController = require('./AuthController');
 const AuthStates = require('./AuthStates');
 const LoginButton = require('../Browser/LoginButton');
 const Service = require('../Service');
 
 /**
- * @memberof Pryv
- * @namespace Pryv.Auth
+ * @memberof pryv
+ * @namespace pryv.Auth
  */
+module.exports = {
+  setupAuth,
+  AuthStates,
+  AuthController
+};
 
 /**
  * Start an authentication process
  *
- * @memberof Pryv.Auth
+ * @memberof pryv.Auth
  * @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 {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}
+ * @param {Object} [serviceCustomizations] override properties of serviceInfoUrl
+ * @returns {pryv.Service}
  */
 async function setupAuth (settings, serviceInfoUrl, serviceCustomizations, HumanInteraction = LoginButton) {
   const service = new Service(serviceInfoUrl, serviceCustomizations);
-  await service.info()
+  await service.info();
 
   const humanInteraction = new HumanInteraction(settings, service);
   await humanInteraction.init();
 
   return service;
 }
-
-module.exports = {
-  setupAuth: setupAuth,
-  AuthStates: AuthStates,
-  AuthController: AuthController,
-}

package/src/Browser/CookieUtils.js

@@ -1,51 +1,61 @@
+/**
+ * @license
+ * [BSD-3-Clause](https://github.com/pryv/lib-js/blob/master/LICENSE)
+ */
 
 const utils = require('../utils');
+
 /**
- * @memberof Pryv.Browser
- * @namespace Pryv.Browser.CookieUtils
+ * @memberof pryv.Browser
+ * @namespace pryv.Browser.CookieUtils
  */
+module.exports = {
+  get,
+  set,
+  del
+};
 
 /**
-  * Set a Local cookier
-  * @memberof Pryv.Browser.CookieUtils
+  * Set a local cookie
+  * @memberof pryv.Browser.CookieUtils
   * @param {string} cookieKey - The key for the cookie
-  * @param {mixed} value - The Value 
+  * @param {mixed} value - The Value
   * @param {number} expireInDays - Expiration date in days from now
   */
-function set(cookieKey, value, expireInDays) {
-  if (! utils.isBrowser()) return;
+function set (cookieKey, value, expireInDays) {
+  if (!utils.isBrowser()) return;
   expireInDays = expireInDays || 365;
-  var myDate = new Date();
-  var hostName = window.location.hostname;
-  var path = window.location.pathname;
+  const myDate = new Date();
+  const hostName = window.location.hostname;
+  const path = window.location.pathname;
   myDate.setDate(myDate.getDate() + expireInDays);
-  var cookieStr = encodeURIComponent(cookieKey) + '=' + encodeURIComponent(JSON.stringify(value))
-    + ';expires=' + myDate.toGMTString()
-    + ';domain=.' + hostName + ';path=' + path;
-    // do not add SameSite when removing a cookie
+  let cookieStr = encodeURIComponent(cookieKey) + '=' +
+    encodeURIComponent(JSON.stringify(value)) +
+    ';expires=' + myDate.toGMTString() +
+    ';domain=.' + hostName + ';path=' + path;
+  // do not add SameSite when removing a cookie
   if (expireInDays >= 0) cookieStr += ';SameSite=Strict';
   document.cookie = cookieStr;
 }
-exports.set = set;
 
 /**
- * returns the value of a local cookie
- * @memberof Pryv.Browser.CookieUtils
+ * Return the value of a local cookie
+ * @memberof pryv.Browser.CookieUtils
  * @param cookieKey - The key
  */
-exports.get = function get(cookieKey) {
+function get (cookieKey) {
   const name = encodeURIComponent(cookieKey);
-  if (! utils.isBrowser()) return;
-  var value = "; " + document.cookie;
-  var parts = value.split("; " + name + "=");
-  if (parts.length == 2) return JSON.parse(decodeURIComponent(parts.pop().split(";").shift()));
+  if (!utils.isBrowser()) return;
+  const value = '; ' + document.cookie;
+  const parts = value.split('; ' + name + '=');
+  if (parts.length === 2) return JSON.parse(decodeURIComponent(parts.pop().split(';').shift()));
 }
 
 /**
- * delete a local cookie
- * @memberof Pryv.Browser.CookieUtils
+ * Delete a local cookie
+ * @memberof pryv.Browser.CookieUtils
  * @param cookieKey - The key
  */
-exports.del = function del(cookieKey) {
-  set(cookieKey, {deleted: true}, -1);
-}
+function del (cookieKey) {
+  set(cookieKey, { deleted: true }, -1);
+}