npm - @pryv/monitor - Versions diffs - 1.0.6 → 2.3.0 - Mend

@pryv/monitor 1.0.6 → 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 (24) hide show

package/README.md +103 -133
package/package.json +12 -24
package/src/Monitor.js +28 -28
package/src/UpdateMethod/EventsTimer.js +8 -4
package/src/UpdateMethod/Socket.js +10 -9
package/src/UpdateMethod/UpdateMethod.js +11 -7
package/src/UpdateMethod/index.js +5 -2
package/src/browser-index.js +10 -8
package/src/index.js +15 -12
package/src/lib/Changes.js +8 -4
package/src/lib/updateEvents.js +9 -5
package/src/lib/updateStreams.js +7 -3
package/test/load-helpers.js +26 -0
package/test/monitor.test.js +22 -22
package/test/socket.test.js +24 -22
package/test/timer.test.js +23 -25
package/.mocharc.js +0 -11
package/LICENSE.md +0 -27
package/examples/index.html +0 -231
package/examples/screenshot.png +0 -0
package/examples/simplemonitor.js +0 -32
package/scripts/setup-environment-dev.sh +0 -28
package/test/helpers.js +0 -30
package/webpack.config.js +0 -37

package/examples/index.html DELETED Viewed

@@ -1,231 +0,0 @@
-<!doctype html>
-<html>
-  <!--
-    This file is moved in dist/ during build process.
-    It should be opened in the same directory than pryv-monitor.js built
-  -->
-<head>
-  <meta charset="UTF-8" />
-  <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
-  <meta http-equiv="X-UA-Compatible" content="ie=edge" />
-  <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/css/bootstrap.min.css"
-    integrity="sha384-9aIt2nRpC12Uk9gS9baDl411NQApFmC26EwAOH8WgZl5MYYxFfc+NcPb1dKGj7Sk" crossorigin="anonymous">
-  <link rel="stylesheet" type="text/css" href="https://api.pryv.com/style/pryv.min.css">
-  <link rel="stylesheet" type="text/css" href="https://fonts.googleapis.com/css?family=Roboto:300,400">
-  <title>Pryv Monitor - Javascript</title>
-  <script src="https://api.pryv.com/lib-js/pryv.js"></script>
-  <script src="https://api.pryv.com/lib-js-socket.io/pryv-socket.io.js"></script>
-  <script src="pryv-monitor.js"></script>
-</head>
-<body>
-  <div class="container">
-    <h1>Monitor - Pryv Examples</h1>
-    <span id="pryv-button"></span>
-    <br>
-    This example illustrates the creation, update and deletion of events as well as the monitoring of data changes (i.e.
-    real time updates). You can open a second page of this fiddle and verify that actions on either page are reflected on
-    the other.
-    <div class="card">
-      <div class="card-body">
-        <h2 class="card-title">Actions</h2>
-        <h5>Create</h5>
-        <input type='text' id='create-content' placeholder='Content' value='Example content' />
-        <button onClick='createNoteEvent()'>Create note event</button>
-        <h5>Update</h5>
-        <input type='text' id='update-id' placeholder='Event id' value='' />
-        <input type='text' id='update-content' placeholder='Updated content' value='Updated example content' />
-        <button onClick='updateNoteEvent()'>Update event</button>
-        <h5>Delete</h5>
-        <input type='text' id='delete-id' placeholder='Event id' value='' />
-        <button onClick='deleteNoteEvent()'>Trash event (2x to delete)</button>
-      </div>
-    </div>
-    <table width=100%>
-      <tr>
-        <td>
-          <div class="card">
-            <div class="card-body">
-              <h2 class="card-title">Console</h2>
-              <textarea id='console' cols=45 rows=20></textarea>
-          </div>
-        </td>
-        <td>
-          <div class="card">
-            <div class="card-body">
-              <h2 class="card-title">Monitor Events</h2>
-              <textarea id='monitor-console' cols=45 rows=20></textarea>
-            </div>
-          </div>
-        </td>
-      </tr>
-    </table>
-    <br>
-    <small>Source code of this demo app on <a
-        href="https://github.com/pryv/lib-js-monitor.io/blob/master/examples/index.html">GitHub</a></small>
-    </div>
-</body>
-<script>
-  // --- usual boiler plate
-  //-- UI Elements
- var $createContent = document.getElementById('create-content'),
-    $updateId = document.getElementById('update-id'),
-    $updateContent = document.getElementById('update-content'),
-    $deleteId = document.getElementById('delete-id'),
-    $console = document.getElementById('console'),
-    $monitorConsole = document.getElementById('monitor-console');
-  //-- Connection will be updated upon login
-  var connection = null;
-  var authSettings = {
-    spanButtonID: 'pryv-button', // span id the DOM that will be replaced by the Service specific button
-    onStateChange: pryvAuthStateChange, // event Listener for Authentication steps
-    authRequest: { // See: https://api.pryv.com/reference/#auth-request
-      requestingAppId: 'lib-js-monitor',
-      languageCode: 'en', // optional (default english)
-      requestedPermissions: [
-        {
-          streamId: 'test',
-          defaultName: 'Test',
-          level: 'manage'
-        }
-      ],
-      clientData: {
-        'app-web-auth:description': {
-          'type': 'note/txt', 'content': 'I\'m monitoring changes, creating, updating and deleting notes in test.'
-        }
-      }
-    }
-  };
-  function pryvAuthStateChange(state) { // called each time the authentication state changed
-    logToConsole('##pryvAuthStateChange ' + state.id);
-    if (state.id === Pryv.Browser.AuthStates.AUTHORIZED) {
-      connection = new Pryv.Connection(state.apiEndpoint);
-      logToConsole('# Auth succeeded for user ' + connection.apiEndpoint);
-      initializeMonitor();
-    }
-    if (state.id === Pryv.Browser.AuthStates.LOGOUT) {
-      connection = null;
-      logToConsole('# Logout');
-      closeMonitor();
-    }
-  }
-  function resToJSON(res) {
-    if (res.error || (res.event == null)) {
-      if (res.eventDeletion == null)
-        return "Error: " + JSON.stringify(res);
-       return res.eventDeletion.id;
-    }
-    return res.event.id;
-  }
-  async function createNoteEvent() {
-    if (connection == null) { return alert('Please sign in first.'); }
-    const res = await connection.api([{
-      method: 'events.create',
-      params: {
-        streamId: 'test',
-        type: 'note/txt',
-        content: $createContent.value
-      }
-    }]);
-    logToConsole('# ACTION Creating event: ' + resToJSON(res[0]));
-  }
-  async function updateNoteEvent() {
-    if (!connection) { return alert('Please sign in first.'); }
-    const res = await connection.api([{
-      method: 'events.update',
-      params: {
-        id: $updateId.value,
-        update: {
-          content: $updateContent.value
-        }
-      }
-    }]);
-    logToConsole('# ACTION Updating event: ' + resToJSON(res[0]));
-  }
-  async function deleteNoteEvent() {
-      if (!connection) { return alert('Please sign in first.'); }
-      const res = await connection.api([{
-        method: 'events.delete',
-        params: {
-          id: $deleteId.value,
-        }
-      }]);
-      logToConsole('# ACTION Deleting event: ' + resToJSON(res[0]));
-    }
-  function logToConsole(text) {
-    $console.value += text + '\n';
-    $console.scrollTop = $console.scrollHeight;
-  }
-  function logToMonitor(text) {
-    $monitorConsole.value += text + '\n';
-    $monitorConsole.scrollTop = $console.scrollHeight;
-  }
-  // following the APP GUIDELINES: https://api.pryv.com/guides/app-guidelines/
-  (async function () {
-    const serviceInfoUrl = Pryv.Browser.serviceInfoFromUrl() || 'https://reg.pryv.me/service/info';
-    var service = await Pryv.Browser.setupAuth(authSettings, serviceInfoUrl);
-  })();
-   // --- monitor specific
-  let monitor = null;
-  /**
-   * close monitor
-   */
-  function closeMonitor() {
-    if (monitor == null) return;
-    try {
-      monitor.close();
-    } catch (e) {}
-    monitor = null;
-    logToConsole("# Closed Monitor");
-  }
-   /**
-    *
-    */
-  function initializeMonitor() {
-   new Pryv.Monitor(connection, { limit: 2 })
-      .on(Pryv.Monitor.Changes.EVENT_DELETE, function (event) {
-        logToMonitor("> Event-DELETE: " + event.id);
-      })
-      .on(Pryv.Monitor.Changes.EVENT, function (event) {
-        logToMonitor("> Event-CHANGE-or-ADD: " + event.id + '\n - ' + event.content);
-      })
-      .on(Pryv.Monitor.Changes.STREAMS, function (streams) {
-        logToMonitor('> Event-STREAMS');
-      })
-      .on(Pryv.Monitor.Changes.STOP, function () {
-        logToMonitor('> Event-STOP');
-      })
-      .on(Pryv.Monitor.Changes.READY, function () {
-        logToMonitor('> Event-READY');
-      })
-      .on(Pryv.Monitor.Changes.ERROR, function (error) {
-        logToMonitor('> Event-ERROR: \n' + error);
-      })
-      // uncomment / comment one of the two following line to switch
-      // between EventsTimer or Socket updater
-      //.addUpdateMethod(new Pryv.Monitor.UpdateMethod.EventsTimer(2000))
-      .addUpdateMethod(new Pryv.Monitor.UpdateMethod.Socket())
-      .start();
-    logToConsole("# Monitor Started");
-  }
-</script>
-</html>

package/examples/screenshot.png DELETED Viewed

Binary file

package/examples/simplemonitor.js DELETED Viewed

@@ -1,32 +0,0 @@
-const Pryv = require('pryv');
-require('@pryv/socket.io')(Pryv);
-require('../src/')(Pryv);
-const apiEndpoint = 'https://ck60yn9yv00011hd3vu1ocpi7@jslibtest.pryv.me';
-(async () => {
-  const monitor = await (new Pryv.Monitor(apiEndpoint, { limit: 20 })
-    .on(Pryv.Monitor.Changes.EVENT_DELETE, function (event) {
-      console.log('> Delete event', event);
-    })
-    .on(Pryv.Monitor.Changes.EVENT, function (event) {
-      console.log('> New event', event);
-    })
-    .on(Pryv.Monitor.Changes.STREAMS, function (streams) {
-      console.log('> New streams', streams);
-    })
-    .on(Pryv.Monitor.Changes.STOP, function () {
-      console.log('> Event-STOP');
-    })
-    .on(Pryv.Monitor.Changes.READY, function () {
-      console.log('> Event-READY');
-    })
-    .on(Pryv.Monitor.Changes.ERROR, function (error) {
-      console.log('> Event-ERROR: \n' + error);
-    })
-    //.addUpdateMethod(new Pryv.Monitor.UpdateMethod.EventsTimer(1000))
-    .addUpdateMethod(new Pryv.Monitor.UpdateMethod.Socket())
-  ).start();
-})();

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-monitor.git $distFolder
-fi
-echo "
-OK!
-"

package/test/helpers.js DELETED Viewed

@@ -1,30 +0,0 @@
-/**
- * Loaded by .mocharc.js for node tests
- */
-const chai = require('chai');
-const Pryv = require('pryv');
-require('../src')(Pryv); // Loading Monitor on Pryv
-const testData = require('../node_modules/pryv/test/test-data.js');
-global.chai = chai;
-global.Pryv = Pryv;
-global.testData = testData;
-global.should = chai.should();
-global.expect = chai.expect;
-global.testStreamId = testStreamId = 'monitor-test';
-global.prepareAndcreateBaseStreams = async () => {
-  await testData.prepare();
-  global.apiEndpoint = testData.apiEndpointWithToken;
-  global.conn = new Pryv.Connection(apiEndpoint);
-  const res = await conn.api([{
-    method: 'streams.create',
-    params: {
-      id: testStreamId,
-      name: testStreamId
-    }
-  }]);
-  expect(res[0]).to.exist;
-  if (res[0].stream) return;
-  expect(res[0].error).to.exist;
-  expect(res[0].error.id).to.equal('item-already-exists');
-}

package/webpack.config.js DELETED Viewed

@@ -1,37 +0,0 @@
-const path = require('path');
-const CopyPlugin = require('copy-webpack-plugin');
-const { webpackBabelConfig } = require('@pryv/lib-js-common');
-module.exports = [
-	{ // es6 not transpiled version
-		mode: 'production',
-		entry: {
-			'pryv-monitor': './src/browser-index.js'
-		},
-		output: {
-			filename: '[name]-es6.js',
-			path: path.resolve(__dirname, 'dist')
-		},
-		devtool: 'source-map'
-	},
-	{ // es5  version
-		mode: 'production',
-		entry: {
-			'pryv-monitor': ['core-js/stable','./src/browser-index.js']
-		},
-		output: {
-			filename: '[name].js',
-			path: path.resolve(__dirname, 'dist')
-		},
-		plugins: [
-			new CopyPlugin({
-				patterns: [
-					{ from: 'examples/index.html', to: 'index.html' },
-				],
-			}),
-		],
-		module: webpackBabelConfig,
-		devtool: 'source-map'
-	}
-];