pryv 2.1.5 → 2.1.9

package/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2020, Pryv S.A.
+Copyright (c) 2020-2021, Pryv S.A.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,

package/README.md

@@ -7,11 +7,19 @@ This JavaScript library is meant to facilitate writing NodeJS and browser apps f
 *Prerequisites*: Node 12
 
 - Setup: `npm run setup`
+
 - Build pryv.js library for browsers: `npm run build`, the result is published in `./dist`
+
 - Build documentation: `npm run doc`, the result is published in `./dist/docs`
+
+  Note: as per v2.1.7 `jsdoc` dev dependency has been removed from package.json .. it should be installed with `npm install jsoc --dev` 
+
 - Node Tests: `npm run test`
+
 - Coverage: `npm run cover`, the result is visible in `./coverage`
+
 - Browser tests: **build**, then `npm run webserver` and open [https://l.rec.la:9443/tests/browser-tests.html?pryvServiceInfoUrl=https://zouzou.com/service/info](https://l.rec.la:9443/tests/browser-tests.html?pryvServiceInfoUrl=https://zouzou.com/service/info)
+
 - Update on CDN: After running **setup** and **build** scripts, run `npm run gh-pages ${COMMIT_MESSAGE}`. If this fails, run `npm run clear` to rebuild a fresh `dist/` folder
 
 ## Usage
@@ -331,6 +339,22 @@ const result = await connection.createEventWithFile(
 );
 ```
 
+or from a Buffer
+
+```javascript
+const filePath = './test/my_image.png';
+const bufferData = fs.readFileSync(filePath);
+
+const result = await connection.createEventWithFileFromBuffer(
+  {
+    type: 'picture/attached',
+    streamId: 'data'
+  },
+  bufferData, 
+  'my_image.png' // filename
+);
+```
+
 #### Browser
 
 From an Input field
@@ -378,6 +402,21 @@ connect.createEventWithFormData(
     // handle result here
   }
 );
+
+// -- alternative with a filename
+
+connect.createEventWithFileFromBuffer(
+  {
+    type: 'file/attached',
+    streamId: 'data'
+  },
+  blob, 'filename.txt')  // here we can directly use the blob
+  .then(function (res, err) {
+    // handle result here
+  }
+);
+
+
 ```
 
 ### High Frequency Events 
@@ -681,6 +720,10 @@ You can find html examples in the [`./web-demos`](/web-demos) directory. You can
 
 # Change Log
 
+## 2.1.7
+
+- Removed JSDOC dev dependency for security reason
+
 ## 2.1.0
 
 - UI separated from the Authentication logic
@@ -692,4 +735,4 @@ You can find html examples in the [`./web-demos`](/web-demos) directory. You can
 - Various dependencies upgrades
 - Fixing Origin header in Browser distribution
 
-## 2.0.1 Initial Release 
+## 2.0.1 Initial Release 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pryv",
-  "version": "2.1.5",
+  "version": "2.1.9",
   "homepage": "https://github.com/pryv/lib-js",
   "description": "Pryv Javascript Library",
   "keywords": [
@@ -21,7 +21,7 @@
   "scripts": {
     "setup": "./scripts/setup-environment-dev.sh",
     "build": "webpack --config webpack.config.js",
-    "doc": "node node_modules/jsdoc/jsdoc.js -c .jsdoc-conf.json",
+    "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; ",
@@ -38,20 +38,19 @@
     }
   ],
   "dependencies": {
-    "superagent": "^5.2.2"
+    "superagent": "^6.1.0"
   },
   "devDependencies": {
-    "@pryv/lib-js-common": "git+https://github.com/pryv/lib-js-common.git#1.0.3",
-    "@pryv/monitor": "^1.0.2",
-    "@pryv/socket.io": "^1.0.2",
-    "chai": "^4.2.0",
+    "@pryv/lib-js-common": "github:pryv/lib-js-common#1.0.6",
+    "@pryv/monitor": "^1.0.5",
+    "@pryv/socket.io": "^1.0.5",
+    "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
     "cuid": "^2.1.8",
-    "jsdoc": "^3.6.6",
-    "mocha": "^6.2.3",
+    "mocha": "^9.1.3",
     "node-fetch": "^2.6.0",
-    "nyc": "^14.1.1",
-    "rec-la": "latest",
+    "nyc": "^15.1.0",
+    "rec.la": "latest",
     "universal-url": "^2.0.0",
     "zombie": "^6.1.4"
   }

package/src/Browser/LoginButton.js

@@ -154,7 +154,8 @@ async function startLoginScreen (loginButton, authUrl) {
     loginButton.popup = window.open(authUrl, 'prYv Sign-in', features);
   
   if (!loginButton.popup) {
-    loginButton.auth.stopAuthRequest('FAILED_TO_OPEN_WINDOW');
+    // loginButton.auth.stopAuthRequest('FAILED_TO_OPEN_WINDOW');
+    console.log('Pop-up blocked. A second click should allow it.');
   } else if (window.focus) {
     loginButton.popup.focus();
   }

package/src/Connection.js

@@ -257,6 +257,23 @@ class Connection {
     return res.body
   }
 
+  /**
+   * Create an event from a Buffer
+   * NODE.jS ONLY
+   * @param {Event} event
+   * @param {Buffer} bufferData
+   * @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
+  }
+
   /**
  * Create an event with attached formData
  * !! BROWSER ONLY

package/test/Connection.test.js

@@ -5,6 +5,13 @@ let conn = null;
 const { URL, URLSearchParams } = require('universal-url');
 const cuid = require('cuid');
 
+const isNode = (typeof window === 'undefined');
+
+let readFileSync;
+if (isNode) { // node
+  readFileSync = require('fs').readFileSync;
+}
+
 describe('Connection', () => {
 
   before(async function () {
@@ -183,35 +190,85 @@ describe('Connection', () => {
   });
 
   describe('Attachements', () => {
-    it('Create event with attachemnt', async () => {
-      let res = null;
+    it('Node Only: Create event with attachment from file', async function () {
+      if (!isNode) { this.skip(); }
+      const res = await conn.createEventWithFile({
+        type: 'picture/attached',
+        streamId: 'data'
+      }, './test/Y.png');
 
-      if (typeof window === 'undefined') { // node
 
-        res = await conn.createEventWithFile({
+      should.exist(res);
+      should.exist(res.event);
+      should.exist(res.event.attachments);
+      res.event.attachments.length.should.equal(1);
+      res.event.attachments[0].size.should.equal(14798);
+      res.event.attachments[0].type.should.equal('image/png');
+      res.event.attachments[0].fileName.should.equal('Y.png');
+    });
+
+    it('Node Only: Create event with attachment from Buffer', async function () {
+      if (!isNode) { this.skip(); }
+    
+        const fileData = readFileSync('./test/Y.png');
+        const res = await conn.createEventWithFileFromBuffer({
           type: 'picture/attached',
           streamId: 'data'
-        }, './test/Y.png');
+        }, fileData, 'Y.png');
 
-      } else { // browser
-        const formData = new FormData();
-        var blob = new Blob(['Hello'], { type: "text/txt" });
-        formData.append("webmasterfile", blob);
+        should.exist(res);
+        should.exist(res.event);
+        should.exist(res.event.attachments);
+        res.event.attachments.length.should.equal(1);
+        res.event.attachments[0].size.should.equal(14798);
+        res.event.attachments[0].type.should.equal('image/png');
+        res.event.attachments[0].fileName.should.equal('Y.png');
 
-        res = await conn.createEventWithFormData({
-          type: 'file/attached',
+    });
+
+    it('Browser Only: Create event with attachment from Buffer', async function () {
+      if (isNode) { this.skip(); }
+      
+        const blob = new Blob(['Hello'], { type: "text/txt" });
+        const res = await conn.createEventWithFileFromBuffer({
+          type: 'picture/attached',
           streamId: 'data'
-        }, formData);
+        }, blob, 'Hello.txt');
+
+        should.exist(res);
+        should.exist(res.event);
+        console.log(res.event);
+        should.exist(res.event.attachments);
+        res.event.attachments.length.should.equal(1);
+        res.event.attachments[0].size.should.equal(5);
+        res.event.attachments[0].type.should.equal('text/txt');
+        res.event.attachments[0].fileName.should.equal('Hello.txt');
+        
+    });
+    
+    it('Browser Only: Create event with attachment formData', async function () {
+      if (isNode) { this.skip(); }
 
-      }
+      const formData = new FormData();
+      const blob = new Blob(['Hello'], { type: "text/txt" });
+      formData.append("webmasterfile", blob);
+
+      const res = await conn.createEventWithFormData({
+        type: 'file/attached',
+        streamId: 'data'
+      }, formData);
 
 
       should.exist(res);
       should.exist(res.event);
       should.exist(res.event.attachments);
       res.event.attachments.length.should.equal(1);
-
+      res.event.attachments[0].size.should.equal(5);
+      res.event.attachments[0].type.should.equal('text/txt');
+      res.event.attachments[0].fileName.should.equal('blob');
     });
+
+
   });
 
   describe('HF events', () => {
@@ -301,14 +358,14 @@ describe('Connection', () => {
       });
 
       it('no-events ', async () => {
-        const queryParams = { fromTime: 0, toTime: now, tags: ['RANDOM-123'] };
+        const queryParams = { fromTime: 0, toTime: now, types: ['type/unexistent'] };
         function forEachEvent(event) { }
         const res = await conn.getEventsStreamed(queryParams, forEachEvent);
         expect(0).to.equal(res.eventsCount);
       });
 
       it('no-events includeDeletions', async () => {
-        const queryParams = { fromTime: 0, toTime: now, tags: ['RANDOM-123'], includeDeletions: true, modifiedSince: 0 };
+        const queryParams = { fromTime: 0, toTime: now, types: ['type/unexistent'], includeDeletions: true, modifiedSince: 0 };
         function forEachEvent(event) { }
         const res = await conn.getEventsStreamed(queryParams, forEachEvent);
         expect(0).to.equal(res.eventsCount);
@@ -406,19 +463,6 @@ describe('Connection', () => {
       should.equal(newUser.access.name, accessInfoUser.name);
     });
 
-    it('has same permissions', () => {
-      should.exist(accessInfoUser);
-      should.exist(accessInfoUser.permissions);
-      let lengthPermission = accessInfoUser.permissions.length;
-      should.equal(newUser.access.permissions.length, lengthPermission);
-      for (let i = 0; i < lengthPermission; i++) {
-        should.exist(accessInfoUser.permissions[i].streamId);
-        should.equal(newUser.access.permissions[i].streamId, accessInfoUser.permissions[i].streamId);
-        should.exist(accessInfoUser.permissions[i].level);
-        should.equal(newUser.access.permissions[i].level, accessInfoUser.permissions[i].level);
-      }
-    });
-
     it('has same token', () => {
       should.exist(accessInfoUser.token);
       should.equal(newUser.access.token, accessInfoUser.token);

package/test/test-data.js

@@ -61,9 +61,12 @@ async function prepare() {
       });
   }
   const apiEndpoint = serviceInfo.api.replace('{username}', username);
+  
   // login user
+  const headers = {};
+  if (typeof window === 'undefined') { headers.Origin = 'https://l.rec.la'; }; // node only
   const loginRes = await superagent.post(apiEndpoint + 'auth/login')
-    .set('Origin', 'https://l.rec.la')
+    .set(headers)
     .send({ username: username, password: username, appId: 'js-lib-test' });
 
   // create data stream

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

@@ -125,7 +125,7 @@
         loginButton.popup = window.open(authUrl, 'Your custom Sign-in pop-up', features);
 
       if (!loginButton.popup) {
-        console.log('Failed to open window');
+        console.log('Pop-up blocked. A second click should allow it.');
       } else if (window.focus) {
         loginButton.popup.focus();
       }

package/webpack.config.js

@@ -24,7 +24,7 @@ module.exports = [
 	{ // es5 version
 		mode: 'production',
 		entry: {
-			'pryv': ['core-js/stable', './src/index.js'],
+			'pryv': ['./src/index.js'],
 		},
 		output: {
 			filename: '[name].js',
@@ -38,7 +38,7 @@ module.exports = [
 	{ // es5 version including socket.io and monitors
 		mode: 'production',
 		entry: {
-			'pryv-socket.io-monitor': ['core-js/stable', './src/index-socket.io-monitor.js'],
+			'pryv-socket.io-monitor': ['./src/index-socket.io-monitor.js'],
 		},
 		output: {
 			filename: '[name].js',
@@ -47,7 +47,13 @@ module.exports = [
 			library: 'Pryv'
 		},
 		devtool: 'source-map',
-		module: webpackBabelConfig
+		module: webpackBabelConfig,
+    resolve: {
+      fallback: {
+          'fs': false,
+          'path': false,
+      },
+    }
 	},
 	{ // browser test suite (es6)
 		mode: 'development',
@@ -61,11 +67,17 @@ module.exports = [
 			library: 'browserTest'
 		},
 		plugins: [
-			new webpack.IgnorePlugin(/zombie/),
+			new webpack.IgnorePlugin({resourceRegExp: /zombie/}),
 			new CopyPlugin({ patterns: [
 				{ from: 'test/browser-tests.html' },
 			]})
 		],
 		devtool: 'source-map',
+    resolve: {
+      fallback: {
+          'fs': false,
+          'path': false,
+      },
+    }
 	}
 ];