@pryv/monitor 1.0.6 → 2.3.0

package/src/browser-index.js

@@ -1,16 +1,18 @@
+/**
+ * @license
+ * [BSD-3-Clause](https://github.com/pryv/lib-js/blob/master/LICENSE)
+ */
 
-/*global Pryv*/
+/* global pryv */
 
 /**
  * This entry point is for Browser only
- * It extends "Pryv" with Monitor capabilities
+ * It extends `pryv` with Monitor capabilities
  */
-const extendsPryv = require('./index.js');
+const extendPryv = require('./index.js');
 (function () {
-  
-  if (Pryv == null) {
-    throw '"Pryv" is not accessible, add <script src="https://api.pryv.com/lib-js/pryv.js"></script> in your html file, before pryv-monitor.js';
+  if (pryv == null) {
+    throw new Error('"pryv" is not accessible, add <script src="https://api.pryv.com/lib-js/pryv.js"></script> in your html file, before pryv-monitor.js');
   }
-  extendsPryv(Pryv);
+  extendPryv(pryv);
 })();
-

package/src/index.js

@@ -1,26 +1,31 @@
+/**
+ * @license
+ * [BSD-3-Clause](https://github.com/pryv/lib-js/blob/master/LICENSE)
+ */
 const Monitor = require('./Monitor');
 const Changes = require('./lib/Changes');
 
 Monitor.Changes = Changes;
 
 /**
- * Load Monitor capabilities onto Pryv
- * @param {Pryv} Pryv - Pryv lib-js library @see https://github.com/pryv/lib-js
+ * Load Monitor capabilities onto `pryv`
+ * @param {pryv} pryv `pryv` library @see https://github.com/pryv/lib-js
  */
-module.exports = function(Pryv) {
-  console.log('Pryv version', Pryv.version);
+module.exports = function (pryv) {
+  console.log('Pryv version', pryv.version);
   // check version here
-  if (Pryv.Monitor) {
+  if (pryv.Monitor) {
     throw new Error('Monitor already loaded');
   }
   // sharing cross references
-  Pryv.Monitor = Monitor;
-  Monitor.Pryv = Pryv;
+  pryv.Monitor = Monitor;
+  // TODO: remove deprecated `Pryv` alias with next major version
+  Monitor.pryv = Monitor.Pryv = pryv;
   return Monitor;
-}
+};
 
 /**
- * @typedef Pryv.Monitor.Changes
+ * @typedef pryv.Monitor.Changes
  * @property {string} EVENT "event" fired on new or changed event
  * @property {string} EVENT_DELETE "eventDelete"
  * @property {string} STREAMS "streams"
@@ -29,11 +34,10 @@ module.exports = function(Pryv) {
  * @property {string} STOP "stop"
  */
 
-
 /**
  * A scope corresponding to EventGetParameters @see https://l.rec.la:4443/reference#get-events
  * Property `limit` cannot be specified;
- * @typedef {Object} Pryv.Monitor.Scope
+ * @typedef {Object} pryv.Monitor.Scope
  * @property {timestamp} [fromTime=TIMERANGE_MIN] (in seconds)
  * @property {timestamp} [toTime=TIMERANGE_MAX] (in seconds)
  * @property {string[]} [streams] - array of streamIds
@@ -45,4 +49,3 @@ module.exports = function(Pryv) {
  * @property {boolean} [includeDeletions]
  * @property {timestamp} modifiedSince - (in seconds) only events modified after this date
  */
-

package/src/lib/Changes.js

@@ -1,7 +1,11 @@
-/** 
- * Enum trigger messages 
+/**
+ * @license
+ * [BSD-3-Clause](https://github.com/pryv/lib-js/blob/master/LICENSE)
+ */
+/**
+ * Enum trigger messages
  * @readonly
- * @enum {Pryv.Monitor.Changes}
+ * @enum {pryv.Monitor.Changes}
  */
 const Changes = {
   EVENT: 'event',
@@ -12,4 +16,4 @@ const Changes = {
   STOP: 'stop'
 };
 
-module.exports = Changes;
+module.exports = Changes;

package/src/lib/updateEvents.js

@@ -1,14 +1,18 @@
+/**
+ * @license
+ * [BSD-3-Clause](https://github.com/pryv/lib-js/blob/master/LICENSE)
+ */
 const Changes = require('./Changes');
 
-module.exports = async function _updateEvents(monitor) {
-  function forEachEvent(event) {
+module.exports = async function _updateEvents (monitor) {
+  function forEachEvent (event) {
     // update eventsGetScope with "latest modified" information found
     if (event.modified > monitor.eventsGetScope.modifiedSince) {
       monitor.eventsGetScope.modifiedSince = event.modified;
     }
     if (event.deleted) {
-      // event.delete is actually the date it was deleted. 
-      // use it as "modified" information 
+      // event.delete is actually the date it was deleted.
+      // use it as "modified" information
       if (event.deleted > monitor.eventsGetScope.modifiedSince) {
         monitor.eventsGetScope.modifiedSince = event.deleted;
       }
@@ -22,4 +26,4 @@ module.exports = async function _updateEvents(monitor) {
   } catch (e) {
     monitor.emit(Changes.ERROR, e);
   }
-}
+};

package/src/lib/updateStreams.js

@@ -1,11 +1,15 @@
+/**
+ * @license
+ * [BSD-3-Clause](https://github.com/pryv/lib-js/blob/master/LICENSE)
+ */
 const Changes = require('./Changes');
 
-module.exports = async function _updateStreams(monitor) {
+module.exports = async function _updateStreams (monitor) {
   try {
     const result = await monitor.connection.get('streams');
-    if (!result.streams) { throw new Error('Invalid response ' + JSON.streams(result)) }
+    if (!result.streams) { throw new Error('Invalid response ' + JSON.streams(result)); }
     monitor.emit(Changes.STREAMS, result.streams);
   } catch (e) {
     monitor.emit(Changes.ERROR, e);
   }
-}
+};

package/test/load-helpers.js

@@ -0,0 +1,26 @@
+/**
+ * @license
+ * [BSD-3-Clause](https://github.com/pryv/lib-js/blob/master/LICENSE)
+ */
+/* global expect, pryv, testData */
+/* eslint-disable no-unused-expressions */
+
+require('../src')(pryv);
+const testStreamId = global.testStreamId = 'monitor-test';
+
+global.prepareAndCreateBaseStreams = async () => {
+  await testData.prepare();
+  global.apiEndpoint = testData.apiEndpointWithToken;
+  global.conn = new pryv.Connection(global.apiEndpoint);
+  const res = await global.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/test/monitor.test.js

@@ -1,49 +1,51 @@
-/*global 
-  Pryv, chai, should, testData, conn, apiEndpoint, prepareAndcreateBaseStreams
-*/
+/**
+ * @license
+ * [BSD-3-Clause](https://github.com/pryv/lib-js/blob/master/LICENSE)
+ */
+/* global describe, it, before, beforeEach, afterEach, expect, pryv, conn, apiEndpoint, prepareAndCreateBaseStreams */
 
-const Pryv = require("pryv");
+require('./load-helpers');
 
 describe('Monitor', function () {
   this.timeout(3000);
 
   before(async function () {
     this.timeout(5000);
-    await prepareAndcreateBaseStreams();
+    await prepareAndCreateBaseStreams();
   });
 
   describe('init', () => {
     it('can be initialized with an apiEndpoint', async () => {
-      const monitor = new Pryv.Monitor(apiEndpoint, { limit: 1 });
+      const monitor = new pryv.Monitor(apiEndpoint, { limit: 1 });
       await monitor.start();
     });
 
     it('can be initialized with a connection', async () => {
-      const monitor = new Pryv.Monitor(conn, { limit: 1 });
+      const monitor = new pryv.Monitor(conn, { limit: 1 });
       await monitor.start();
     });
 
     it('throw Error on invalid apiEndpoint', async () => {
-      const passed = true;
+      let passed = true;
       try {
-        const monitor = new Pryv.Monitor('BlipBlop', { limit: 1 });
+        /* eslint-disable-next-line no-unused-vars */
+        const monitor = new pryv.Monitor('BlipBlop', { limit: 1 });
         passed = false;
-      } catch(e) {
+      } catch (e) {
 
       }
       expect(passed).to.equal(true);
     });
-
   });
 
   describe('notifications', () => {
     let monitor = null;
     beforeEach(async () => {
-      monitor = new Pryv.Monitor(conn, { limit: 1 });
+      monitor = new pryv.Monitor(conn, { limit: 1 });
     });
 
     afterEach(async () => {
-      monitor.stop()
+      monitor.stop();
     });
 
     it('Load events at start', async function () {
@@ -56,22 +58,22 @@ describe('Monitor', function () {
         {
           method: 'events.create',
           params: {
-            streamId: testStreamId,
+            streamId: global.testStreamId,
             type: 'note/txt',
             content: 'hello monitor'
           }
         }
-      ])
-      await new Promise(r => setTimeout(r, 2000));
+      ]);
+      await new Promise(resolve => setTimeout(resolve, 2000));
       expect(count).to.be.gt(0);
     });
 
     it('Detect new events added', async function () {
-      let count = 0; 
+      let count = 0;
       await monitor.start();
 
       const eventData = {
-        streamId: testStreamId,
+        streamId: global.testStreamId,
         type: 'note/txt',
         content: 'hello monitor ' + new Date()
       };
@@ -80,17 +82,15 @@ describe('Monitor', function () {
         expect(event.content).to.equal(eventData.content);
         count++;
       });
-      const res = await conn.api([
+      await conn.api([
         {
           method: 'events.create',
           params: eventData
         }
       ]);
       await monitor.updateEvents(); // trigger refresh
-      await new Promise(r => setTimeout(r, 2000));
+      await new Promise(resolve => setTimeout(resolve, 2000));
       expect(count).to.be.gt(0);
     });
-
-
   });
 });

package/test/socket.test.js

@@ -1,26 +1,30 @@
-/*global
-  Pryv, chai, should, testData, conn, apiEndpoint, creaBaseStreams
-*/
-require('@pryv/socket.io')(Pryv);
+/**
+ * @license
+ * [BSD-3-Clause](https://github.com/pryv/lib-js/blob/master/LICENSE)
+ */
+/* global describe, it, before, expect, pryv, conn, apiEndpoint, prepareAndCreateBaseStreams */
 
-describe('Monitor + Socket.io', function () {
+require('./load-helpers');
+require('@pryv/socket.io')(pryv);
+
+describe('Monitor + Socket.IO', function () {
   this.timeout(3000);
 
   before(async () => {
-    await prepareAndcreateBaseStreams();
+    await prepareAndCreateBaseStreams();
   });
 
   describe('socket updates', function () {
     this.timeout(5000);
     it('Detect new events added', async function () {
-      const monitor = new Pryv.Monitor(apiEndpoint, { limit: 1 })
-        .addUpdateMethod(new Pryv.Monitor.UpdateMethod.Socket());
+      const monitor = new pryv.Monitor(apiEndpoint, { limit: 1 })
+        .addUpdateMethod(new pryv.Monitor.UpdateMethod.Socket());
       await monitor.start();
-    
+
       let count = 0;
 
       const eventData = {
-        streamId: testStreamId,
+        streamId: global.testStreamId,
         type: 'note/txt',
         content: 'hello monitor ' + new Date()
       };
@@ -29,33 +33,32 @@ describe('Monitor + Socket.io', function () {
         expect(event.content).to.equal(eventData.content);
         count++;
       });
-      await new Promise(r => setTimeout(r, 1000));
-      const res = await conn.api([
+      await new Promise(resolve => setTimeout(resolve, 1000));
+      await conn.api([
         {
           method: 'events.create',
           params: eventData
         }
       ]);
 
-      await new Promise(r => setTimeout(r, 2000));
+      await new Promise(resolve => setTimeout(resolve, 2000));
       monitor.stop();
       expect(count).to.be.gt(0);
-
     });
   });
 
   describe('stop', () => {
     it('Monitor stops when requested', async function () {
       this.timeout(4000);
-      const monitor = new Pryv.Monitor(apiEndpoint, { limit: 1 }).
-        addUpdateMethod(new Pryv.Monitor.UpdateMethod.Socket());
+      const monitor = new pryv.Monitor(apiEndpoint, { limit: 1 })
+        .addUpdateMethod(new pryv.Monitor.UpdateMethod.Socket());
       await monitor.start();
       let count = 0;
-      await new Promise(r => setTimeout(r, 1000));
+      await new Promise(resolve => setTimeout(resolve, 1000));
       monitor.stop();
 
       const eventData = {
-        streamId: testStreamId,
+        streamId: global.testStreamId,
         type: 'note/txt',
         content: 'hello monitor ' + new Date()
       };
@@ -63,16 +66,15 @@ describe('Monitor + Socket.io', function () {
       monitor.on('event', function (event) {
         count++;
       });
-      const res = await conn.api([
+      await conn.api([
         {
           method: 'events.create',
           params: eventData
         }
       ]);
 
-      await new Promise(r => setTimeout(r, 1000));
-      expect(count).to.equals(0);
+      await new Promise(resolve => setTimeout(resolve, 1000));
+      expect(count).to.equal(0);
     });
   });
-
 });

package/test/timer.test.js

@@ -1,38 +1,38 @@
-/*global
-  Pryv, chai, should, testData, conn, apiEndpoint, creaBaseStreams
-*/
-
-const testData = require("pryv/test/test-data");
-const Pryv = require("pryv");
+/**
+ * @license
+ * [BSD-3-Clause](https://github.com/pryv/lib-js/blob/master/LICENSE)
+ */
+/* global describe, it, before, expect, pryv, conn, apiEndpoint, prepareAndCreateBaseStreams */
 
+require('./load-helpers');
 
 describe('Monitor + EventsTimer', function () {
   this.timeout(3000);
 
   before(async () => {
-    await prepareAndcreateBaseStreams();
+    await prepareAndCreateBaseStreams();
   });
 
   describe('init', () => {
     it('throw error if timer is not inistialized with correct time', async () => {
-      const monitor = new Pryv.Monitor(apiEndpoint, { limit: 1 });
+      const monitor = new pryv.Monitor(apiEndpoint, { limit: 1 });
       try {
-        new Pryv.Monitor.UpdateMethod.EventsTimer(monitor, 'Rt');
+        /* eslint-disable-next-line no-new */
+        new pryv.Monitor.UpdateMethod.EventsTimer(monitor, 'Rt');
       } catch (e) {
         return expect(e.message).to.equal('Monitor timer refresh rate is not valid. It should be a number > 1');
       }
-      throw new Error('Should thow error')
+      throw new Error('Should thow error');
     });
   });
 
   describe('timer updates', () => {
     it('Detect new events added', async function () {
-      const monitor = new Pryv.Monitor(apiEndpoint, { limit: 1 })
-        .addUpdateMethod(new Pryv.Monitor.UpdateMethod.EventsTimer(1));
+      const monitor = new pryv.Monitor(apiEndpoint, { limit: 1 })
+        .addUpdateMethod(new pryv.Monitor.UpdateMethod.EventsTimer(1));
       await monitor.start();
       let count = 0;
 
-     
       // listener is added "after" so we don't get events loaded at start
       monitor.on('event', function (event) {
         expect(event.content).to.equal(eventData.content);
@@ -40,34 +40,33 @@ describe('Monitor + EventsTimer', function () {
       });
 
       const eventData = {
-        streamId: testStreamId,
+        streamId: global.testStreamId,
         type: 'note/txt',
         content: 'hello monitor ' + new Date()
       };
 
-      const res = await conn.api([
+      await conn.api([
         {
           method: 'events.create',
           params: eventData
         }
       ]);
 
-      await new Promise(r => setTimeout(r, 2000));
+      await new Promise(resolve => setTimeout(resolve, 2000));
       monitor.stop();
       expect(count).to.be.gt(0);
-
     });
   });
 
   describe('stop', () => {
     it('Monitor stops when requested', async function () {
       this.timeout(4000);
-      const monitor = await new Pryv.Monitor(apiEndpoint, { limit: 1 })
-        .addUpdateMethod(new Pryv.Monitor.UpdateMethod.EventsTimer(1));
+      const monitor = await new pryv.Monitor(apiEndpoint, { limit: 1 })
+        .addUpdateMethod(new pryv.Monitor.UpdateMethod.EventsTimer(1));
       await monitor.start();
 
       let count = 0;
-      await new Promise(r => setTimeout(r, 1000));
+      await new Promise(resolve => setTimeout(resolve, 1000));
       monitor.stop();
 
       // listener is added "after" so we don't get events loaded at start
@@ -76,21 +75,20 @@ describe('Monitor + EventsTimer', function () {
       });
 
       const eventData = {
-        streamId: testStreamId,
+        streamId: global.testStreamId,
         type: 'note/txt',
         content: 'hello monitor ' + new Date()
       };
 
-      const res = await conn.api([
+      await conn.api([
         {
           method: 'events.create',
           params: eventData
         }
       ]);
 
-      await new Promise(r => setTimeout(r, 1000));
-      expect(count).to.equals(0);
+      await new Promise(resolve => setTimeout(resolve, 1000));
+      expect(count).to.equal(0);
     });
   });
-
 });

package/.mocharc.js

@@ -1,11 +0,0 @@
-module.exports = {
-  diff: true,
-  extension: ['js'],
-  opts: false,
-  package: './package.json',
-  reporter: 'spec',
-  slow: 75,
-  timeout: 2000,
-  require: 'test/helpers.js',
-  ui: 'bdd'
-};

package/LICENSE.md

@@ -1,27 +0,0 @@
-Copyright (c) 2020, Pryv S.A.
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without modification,
-are permitted provided that the following conditions are met:
-
-- Redistributions of source code must retain the above copyright notice, this
-  list of conditions and the following disclaimer.
-
-- Redistributions in binary form must reproduce the above copyright notice, this
-  list of conditions and the following disclaimer in the documentation and/or
-  other materials provided with the distribution.
-
-- Neither the name of Pryv nor the names of its
-  contributors may be used to endorse or promote products derived from
-  this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
-ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
-ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.