npm - pryv - Versions diffs - 2.1.8 → 2.3.0 - Mend

pryv 2.1.8 → 2.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (46) hide show

package/package.json +12 -45
package/src/Auth/AuthController.js +43 -50
package/src/Auth/AuthStates.js +12 -12
package/src/Auth/LoginMessages.js +17 -14
package/src/Auth/index.js +18 -15
package/src/Browser/CookieUtils.js +37 -27
package/src/Browser/LoginButton.js +42 -37
package/src/Browser/index.js +16 -42
package/src/Connection.js +102 -95
package/src/Service.js +47 -45
package/src/ServiceAssets.js +42 -34
package/src/browser-index-bundle.js +8 -0
package/src/browser-index.js +7 -0
package/src/index.d.ts +833 -0
package/src/index.js +20 -3
package/src/lib/browser-getEventStreamed.js +21 -19
package/src/lib/json-parser.js +23 -24
package/src/utils.js +55 -43
package/test/Browser.AuthController.test.js +19 -21
package/test/Browser.test.js +23 -26
package/test/Connection.test.js +164 -162
package/test/Service.test.js +30 -44
package/test/ServiceAssets.test.js +16 -22
package/test/browser-index.html +26 -0
package/test/utils.test.js +30 -35
package/.jsdoc-conf.json +0 -29
package/.mocharc.js +0 -13
package/LICENSE.md +0 -27
package/README.md +0 -723
package/scripts/setup-environment-dev.sh +0 -28
package/scripts/upload.sh +0 -15
package/src/Pryv.js +0 -19
package/src/index-socket.io-monitor.js +0 -4
package/src/index.html +0 -17
package/test/browser-index.js +0 -11
package/test/browser-tests.html +0 -31
package/test/helpers.js +0 -8
package/test/load-test-account.js +0 -108
package/test/test-data.js +0 -92
package/web-demos/auth-with-redirection.html +0 -72
package/web-demos/auth.html +0 -77
package/web-demos/custom-login-button.html +0 -158
package/web-demos/index.html +0 -186
package/web-demos/service-info.json +0 -13
package/web-demos/stream-examples.html +0 -80
package/webpack.config.js +0 -71

package/scripts/setup-environment-dev.sh DELETED Viewed

@@ -1,28 +0,0 @@
-#!/bin/sh
-# working dir fix
-scriptsFolder=$(cd $(dirname "$0"); pwd)
-cd $scriptsFolder/..
-# check for basic prerequisites
-hash git 2>&- || { echo >&2 "I require git."; exit 1; }
-hash npm 2>&- || { echo >&2 "I require Node and NPM."; exit 1; }
-echo "
-Installing Node modules if necessary...
-"
-npm install
-distFolder=dist
-if [ ! -d $distFolder ]
-then
-  echo "
-Setting up '$distFolder' folder for publishing to GitHub pages...
-"
-  git clone -b gh-pages git@github.com:pryv/lib-js.git $distFolder
-fi
-echo "
-OK!
-"

package/scripts/upload.sh DELETED Viewed

@@ -1,15 +0,0 @@
-#!/bin/sh
-set -e
-# working dir fix
-scriptsFolder=$(cd $(dirname "$0"); pwd)
-cd $scriptsFolder/..
-if [ $# -eq 0 ]
-  then
-  echo "No commit message was provided, please provide a message as argument for readability";
-  exit 1;
-fi
-cd dist && git add . && git add -u . && git commit -m "$1" && git push

package/src/Pryv.js DELETED Viewed

@@ -1,19 +0,0 @@
-/**
- * Pryv library
- * @version 1.0
- * @exports Pryv
- * @property {Pryv.Service} Service - To interact with Pryv.io at a "Platform level"
- * @property {Pryv.Connection} Connection - To interact with an individual's (user) data set
- * @property {Pryv.Browser} Browser - Browser Tools - Access request helpers and visuals (button)
- * @property {Pryv.utils} utils - Exposes **superagent** for HTTP calls and tools to manipulate Pryv's Api Endpoints
- */
-module.exports = {
-  Service: require('./Service'),
-  Connection: require('./Connection'),
-  Auth: require('./Auth'),
-  Browser: require('./Browser'),
-  utils: require('./utils'),
-  version: require('../package.json').version
-}

package/src/index-socket.io-monitor.js DELETED Viewed

@@ -1,4 +0,0 @@
-const Pryv = require('./Pryv');
-require('@pryv/socket.io')(Pryv);
-require('@pryv/monitor')(Pryv);
-module.exports = Pryv;

package/src/index.html DELETED Viewed

@@ -1,17 +0,0 @@
-<!doctype html>
-<html>
-<head>
-  <title>Pryv - Light - Javascript Lib</title>
-  <script src="./print.bundle.js"></script>
-</head>
-<body>
-  -
-  <script src="./bundle.js"></script>
-  +
-  <script src="./app.bundle.js"></script>
-</body>
-</html>

package/test/browser-index.js DELETED Viewed

@@ -1,11 +0,0 @@
-/**
- * Entry Point for WebPack to build test series to be run in browser
- */
-//mocha.setup({ ignoreLeaks: true });
-require('./utils.test.js');
-require('./Connection.test.js');
-require('./Service.test.js');
-require('./ServiceAssets.test.js');
-require('./Browser.test.js');
-require('./Browser.AuthController.test.js');

package/test/browser-tests.html DELETED Viewed

@@ -1,31 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>Pryv Javascrip Lib - Browser Tests </title>
-  <link rel="stylesheet" href="https://unpkg.com/mocha/mocha.css" />
-</head>
-<body>
-  <div id="mocha"></div>
-  <script src="https://unpkg.com/chai/chai.js"></script>
-  <script src="https://unpkg.com/mocha/mocha.js"></script>
-  <script class="mocha-init">
-    mocha.setup('bdd');
-    mocha.checkLeaks();
-  </script>
-  <script src="../pryv.js"></script>
-  <!-- load code you want to test here -->
-  <!-- ------------------------------------ -->
-  <script type="text/javascript" src="browser-tests.js"></script>
-  <!-- ------------------------------------ -->
-  <!-- load your test files here -->
-  <script>
-    mocha.run();
-  </script>
-</body>
-</html>

package/test/helpers.js DELETED Viewed

@@ -1,8 +0,0 @@
-/**
- * Loaded by .mocharc.js for node tests
- */
-const chai = require('chai');
-const Pryv = require('../src');
-global.chai = chai;
-global.Pryv = Pryv;
-global.Browser = require('zombie');

package/test/load-test-account.js DELETED Viewed

@@ -1,108 +0,0 @@
-const testData = require('./test-data.js');
-const Pryv = require('../src');
-const conn = new Pryv.Connection(testData.apiEndpointWithToken);
-const TEST_DATA_VERSION = "v1";
-// -- check if account is already loaded
-const res = conn.api([{
-  "method": "events.get",
-  "params": {
-    "streams": ["data"],
-    "types": ["test/version"],
-    "limit": 1
-  }
-}]).then((res, err) => {
-  if (res[0].events[0] && res[0].events[0].content === TEST_DATA_VERSION) {
-    console.log('TEST ACCOUNT IS UP TO DATE');
-  } else {
-    doLoad();
-  }
-});
-function doLoad() {
-  let query = [
-    { // trash eventual stream data
-      "method": "streams.delete",
-      "params": {
-        "id": "data",
-        "mergeEventsWithParent": false
-      }
-    },
-    { // clear from trash eventual stream data
-      "method": "streams.delete",
-      "params": {
-        "id": "data",
-        "mergeEventsWithParent": false
-      }
-    },
-    {
-      "method": "streams.create",
-      "params": {
-        "id": "data",
-        "name": "Test Data",
-        "clientData": {
-          "pryv-browser:charts": {
-            "mass/kg": {
-              "settings": {
-                "color": "#1abc9c",
-                "style": "line",
-                "transform": "none",
-                "interval": "auto"
-              }
-            }
-          }
-        }
-      }
-    },
-    {
-      "method": "events.create",
-      "params": {
-        "streamId": "data",
-        "type": "test/version",
-        "content": TEST_DATA_VERSION
-      }
-    }
-  ];
-  const now = (new Date()).getTime() / 1000;
-  const steps = 60 * 60 ; // 1 hours
-  for (let i = 0; i < 10000; i++) {
-    query.push(
-      {
-        "method": "events.create",
-        "params": {
-          "time": now - i * steps,
-          "streamId": "data",
-          "type": "mass/kg",
-          "content": Math.sin(i / 180)
-        }
-      }
-    )
-  }
-  const res = conn.api(query).then((res, err) => {
-    trashFirst200DeleteFirst100(res).then((res2, err2) => {
-      console.log(res2);
-    });
-  });
-}
-async function trashFirst200DeleteFirst100(res) {
-  const query = [];
-  for (let i = 5; i < 205; i++) {
-    const k = (i < 105) ? 2 : 1;
-    for (j = 0; j < k; j++) { // do twice for the firsts 100
-      console.log(res[i]);
-      query.push({
-        "method": "events.delete",
-        "params": {
-          "id": res[i].event.id
-        }
-      });
-    }
-  }
-  return await conn.api(query);
-}

package/test/test-data.js DELETED Viewed

@@ -1,92 +0,0 @@
-const superagent = require('superagent');
-const username = 'jslibtest5';
-const serviceInfoUrl = 'https://reg.pryv.me/service/info';
-//const serviceInfoUrl = 'https://l.rec.la:4443/reg/service/info';
-/**
- * Data used for tests
- */
-const testData = {
-  username: username,
-  password: username,
-  serviceInfoUrl: serviceInfoUrl,
-  token: null,
-  serviceInfo: null,
-  apiEndpoint: null,
-  apiEndpointWithToken: null
-}
-async function prepare() {
-  if (testData.token != null) return testData;
-  console.log('Preparing test Data..');
-  // fetch serviceInfo
-  const serviceInfo = (await superagent.get(serviceInfoUrl)).body;
-  if (serviceInfo.api == null) throw 'Invalid service Info ' + JSON.stringify(serviceInfo);
-  // test if user exists
-  const userExists = (await superagent.get(serviceInfo.register + username + '/check_username')).body;
-  if (typeof userExists.reserved === 'undefined') throw 'Invalid user exists ' + JSON.stringify(userExists);
-  let hostingCandidate = null;
-  if (! userExists.reserved) { // create user
-    // get available hosting
-    const hostings = (await superagent.get(serviceInfo.register + 'hostings').set('accept', 'json')).body;
-    findOneHostingKey(hostings, 'N');
-    function findOneHostingKey(o, parentKey) {
-      for (const key of Object.keys(o)) {
-        if (parentKey === 'hostings') {
-          hostingCandidate = key;
-          return key;
-        }
-        if (typeof o[key] !== 'string')
-             findOneHostingKey(o[key], key);
-      }
-    };
-    if (hostingCandidate == null) throw 'Cannot find hosting in: ' + JSON.stringify(hostings);
-    const hosting = hostingCandidate;
-    // create user
-    await superagent.post(serviceInfo.register + 'user')
-      .send({
-        appid: 'js-lib-test',
-        hosting: hosting,
-        username: username,
-        password: username,
-        email: username + '@pryv.io',
-        invitationtoken: 'enjoy',
-        languageCode: 'en',
-        referer: 'test-suite'
-      });
-  }
-  const apiEndpoint = serviceInfo.api.replace('{username}', username);
-  // login user
-  const loginRes = await superagent.post(apiEndpoint + 'auth/login')
-    .set('Origin', 'https://l.rec.la')
-    .send({ username: username, password: username, appId: 'js-lib-test' });
-  // create data stream
-  try {
-    const streamRes = await superagent.post(apiEndpoint + 'streams').set('authorization', loginRes.body.token).send(
-      {
-        id: 'data',
-        name: 'Data'
-      }
-    )
-  } catch (e) {
-  }
-  if ((loginRes.body == null) || (loginRes.body.token == null)) throw 'Failed login process during testData prepare' + loginRes.text;
-  testData.serviceInfo = serviceInfo;
-  testData.token = loginRes.body.token;
-  const regexAPIandToken = /(.+):\/\/(.+)/gm;
-  const res = regexAPIandToken.exec(apiEndpoint);
-  testData.apiEndpointWithToken = res[1] + '://' + testData.token + '@' + res[2];
-  testData.apiEndpoint = apiEndpoint;
-}
-testData.prepare = prepare;
-module.exports = testData;

package/web-demos/auth-with-redirection.html DELETED Viewed

@@ -1,72 +0,0 @@
-<!doctype html>
-<html>
-<head>
-  <title>Auth with redirection - Pryv JS lib</title>
-  <script src="../pryv.js"></script>
-  <meta content="text/html;charset=utf-8" http-equiv="Content-Type">
-  <meta content="utf-8" http-equiv="encoding">
-</head>
-<body>
-  <span id="pryv-button"></span>
-  <script>
-    let authSettings = {
-      spanButtonID: 'pryv-button', // span id the DOM that will be replaced by the Service specific button
-      onStateChange: function pryvAuthStateChange(state) { // called each time the authentication state changed
-        switch(state.id) {
-          case Pryv.Auth.AuthStates.LOADING:
-            console.log('Loading service information...');
-            break;
-          case Pryv.Auth.AuthStates.INITIALIZED:
-            console.log('Service information is retrieved so authorization can start. You can display login / registration screen or redirect to the our hosted app - web - auth application.');
-            break;
-          case Pryv.Auth.AuthStates.AUTHORIZED:
-            console.log('User is authorized and can access his personal data');
-            break;
-          case Pryv.Auth.AuthStates.SIGNOUT:
-            console.log('User just logged off, please delete all the session related data');
-            break;
-          case Pryv.Auth.AuthStates.ERROR:
-            console.log('Error:', state?.message);
-            break;
-          }
-      }, // event Listener for Authentication steps
-      authRequest: { // See: https://api.pryv.com/reference/#auth-request
-        requestingAppId: 'lib-js-test',
-        languageCode: 'fr', // optional (default english)
-        returnURL: 'auto#',
-        requestedPermissions: [{
-          streamId: 'test',
-          defaultName: 'Test',
-          level: 'read',
-        }],
-        // the login page where user will be redirected
-        returnURL: 'https://l.rec.la:9443/demos/auth-with-redirection.html#'
-      }
-    };
-    const serviceInfoUrl = null; // 'https://api.pryv.com/lib-js/demos/service-info.json';
-    const serviceInfoJson = {
-      "register": "https://reg.pryv.me",
-      "access": "https://access.pryv.me/access",
-      "api": "https://{username}.pryv.me/",
-      "name": "Pryv Lab",
-      "home": "https://www.pryv.com",
-     "support": "https://pryv.com/helpdesk",
-      "terms": "https://pryv.com/pryv-lab-terms-of-use/",
-      "eventTypes": "https://api.pryv.com/event-types/flat.json",
-      "assets": {
-        "definitions": "https://pryv.github.io/assets-pryv.me/index.json"
-     }};
-    (async function () {
-      let service = await Pryv.Auth.setupAuth(
-        authSettings,
-        serviceInfoUrl,
-        serviceInfoJson
-        );
-    })();
-  </script>
-</body>
-</html>

package/web-demos/auth.html DELETED Viewed

@@ -1,77 +0,0 @@
-<!doctype html>
-<html>
-<head>
-  <title>Auth - Pryv JS lib</title>
-  <script src="../pryv.js"></script>
-  <meta content="text/html;charset=utf-8" http-equiv="Content-Type">
-  <meta content="utf-8" http-equiv="encoding">
-</head>
-<body>
-  <span id="pryv-button"></span>
-  <script>
-    const authSettings = {
-      spanButtonID: 'pryv-button', // span id the DOM that will be replaced by the Service specific button
-      onStateChange: function pryvAuthStateChange(state) { // called each time the authentication state changed
-        switch(state.id) {
-          case Pryv.Auth.AuthStates.LOADING:
-            console.log('Loading service information...');
-            break;
-          case Pryv.Auth.AuthStates.INITIALIZED:
-            console.log('Service information is retrieved so authorization can start. You can display login / registration screen or redirect to the our hosted app - web - auth application.');
-            break;
-          case Pryv.Auth.AuthStates.AUTHORIZED:
-            console.log('User is authorized and can access his personal data');
-            break;
-          case Pryv.Auth.AuthStates.SIGNOUT:
-            console.log('User just logged off, please delete all the session related data');
-            break;
-          case Pryv.Auth.AuthStates.ERROR:
-            console.log('Error:', state?.message);
-            break;
-          }
-      }, // event Listener for Authentication steps
-      authRequest: { // See: https://api.pryv.com/reference/#auth-request
-        requestingAppId: 'lib-js-test',
-        requestedPermissions: [
-          {
-            streamId: 'test',
-            defaultName: 'test',
-            level: 'manage'
-          }
-        ],
-        clientData: {
-          'app-web-auth:description': {
-            'type': 'note/txt',
-            'content': 'This is a consent message.'
-          }
-        },
-        // referer: 'my test with lib-js', // optional string to track registration source
-      }
-    };
-    const serviceInfoUrl = null;// 'https://api.pryv.com/lib-js/demos/service-info.json';
-    const serviceInfoJson = {
-      "register": "https://reg.pryv.me",
-      "access": "https://access.pryv.me/access",
-      "api": "https://{username}.pryv.me/",
-      "name": "Pryv Lab",
-      "home": "https://www.pryv.com",
-      "support": "https://pryv.com/helpdesk",
-      "terms": "https://pryv.com/pryv-lab-terms-of-use/",
-      "eventTypes": "https://api.pryv.com/event-types/flat.json",
-      "assets": {
-        "definitions": "https://pryv.github.io/assets-pryv.me/index.json"
-    }};
-    (async function () {
-      service = await Pryv.Auth.setupAuth(
-        authSettings,
-        serviceInfoUrl,
-        serviceInfoJson
-        );
-    })();
-  </script>
-</body>
-</html>

package/web-demos/custom-login-button.html DELETED Viewed

@@ -1,158 +0,0 @@
-<!doctype html>
-<html>
-<head>
-  <title>Custom Login button - Pryv JS lib</title>
-  <script src="../pryv.js"></script>
-  <meta content="text/html;charset=utf-8" http-equiv="Content-Type">
-  <meta content="utf-8" http-equiv="encoding">
-</head>
-<body>
-  <button type="button" id="pryv-button">My custom button</button>
-  <script>
-    const authSettings = {
-      spanButtonID: 'pryv-button', // span id the DOM that will be replaced by the Service specific button
-      authRequest: { // See: https://api.pryv.com/reference/#auth-request
-        requestingAppId: 'custom-login-button-example',
-        requestedPermissions: [
-          {
-            streamId: 'test',
-            defaultName: 'test',
-            level: 'manage'
-          }
-        ]
-      }
-    };
-  class MyLoginButton {
-    constructor(authSettings, service) {
-      this.authSettings = authSettings;
-      this.service = service;
-      this.serviceInfo = service.infoSync();
-    }
-    async init() {
-      const loginButtonSpan = document.getElementById(this.authSettings.spanButtonID);
-      loginButtonSpan.addEventListener('click', this.onClick.bind(this));
-      this.loginButtonSpan = loginButtonSpan;
-      this._cookieKey = 'pryv-libjs-' + this.authSettings.authRequest.requestingAppId;
-      this.auth = new Pryv.Auth.AuthController(this.authSettings, this.service, this);
-      await this.auth.init();
-    }
-    onClick() {
-      this.auth.handleClick();
-    }
-    async onStateChange (state) {
-      switch (state.status) {
-        case Pryv.Auth.AuthStates.LOADING:
-          this.text = 'Loading visual assets';
-          break;
-        case Pryv.Auth.AuthStates.INITIALIZED:
-          this.text = 'Sign into: ' + this.serviceInfo.name;
-          break;
-        case Pryv.Auth.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;
-            return;
-          } else {
-            startLoginScreen(this, loginUrl);
-          }
-          break;
-        case Pryv.Auth.AuthStates.AUTHORIZED:
-          this.text = 'Signed in as ' + state.username;
-          this.saveAuthorizationData({
-            apiEndpoint: state.apiEndpoint,
-            username: state.username
-          });
-          break;
-        case Pryv.Auth.AuthStates.SIGNOUT:
-          const message = 'Do you wish to sign out?';
-          if (confirm(message)) {
-            this.deleteAuthorizationData();
-            this.auth.init();
-          }
-          break;
-        case Pryv.Auth.AuthStates.ERROR:
-          this.text = getErrorMessage(this, state.message);
-          break;
-        default:
-          console.log('WARNING Unhandled state for Login: ' + state.status);
-      }
-      if (this.loginButtonSpan) {
-        this.loginButtonSpan.innerHTML = this.text;
-      }
-    }
-    saveAuthorizationData(authData) {
-      console.log('You should save this object to the storage', authData);
-    }
-    getAuthorizationData() {
-      return Pryv.Browser.CookieUtils.get(this._cookieKey);
-    }
-    async deleteAuthorizationData() {
-      console.log('You should delete saved data from the storage');
-    }
-  }
-  function startLoginScreen(loginButton, authUrl) {
-      console.log('My custom popup that is huge:');
-      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 = 900,
-        height = 500,
-        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, 'Your custom Sign-in pop-up', features);
-      if (!loginButton.popup) {
-        console.log('Pop-up blocked. A second click should allow it.');
-      } else if (window.focus) {
-        loginButton.popup.focus();
-      }
-    }
-  const serviceInfoUrl = null; // 'https://api.pryv.com/lib-js/demos/service-info.json';
-  const serviceInfoJson = {
-    "register": "https://reg.pryv.me",
-    "access": "https://access.pryv.me/access",
-    "api": "https://{username}.pryv.me/",
-    "name": "Pryv Lab",
-    "home": "https://www.pryv.com",
-    "support": "https://pryv.com/helpdesk",
-    "terms": "https://pryv.com/pryv-lab-terms-of-use/",
-    "eventTypes": "https://api.pryv.com/event-types/flat.json",
-    "assets": {
-      "definitions": "https://pryv.github.io/assets-pryv.me/index.json"
-  }};
-  (async function () {
-    let service = await Pryv.Auth.setupAuth(
-      authSettings,
-      serviceInfoUrl,
-      serviceInfoJson,
-      MyLoginButton,
-      );
-  })();
-  </script>
-</body>
-</html>