particle-api-js 11.1.0 → 11.1.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "particle-api-js",
-  "version": "11.1.0",
+  "version": "11.1.2",
   "description": "Particle API Client",
   "main": "src/Particle.js",
   "scripts": {

package/src/EventStream.js

@@ -26,10 +26,12 @@ class EventStream extends EventEmitter {
 
             const isSecure = protocol === 'https:';
             const requestor = isSecure ? https : http;
+            const nonce = global.performance ? global.performance.now() : 0;
             const req = requestor.request({
                 hostname,
                 protocol,
-                path,
+                // Firefox has issues making multiple fetch requests with the same parameters so add a nonce
+                path: `${path}?nonce=${nonce}`,
                 headers: {
                     'Authorization': `Bearer ${this.token}`
                 },

package/src/Particle.js

@@ -22,12 +22,12 @@ class Particle {
      *
      * Create a new Particle object and call methods below on it.
      *
-     * @param {Object} options                  Options for this API call Options to be used for all requests (see [Defaults](../src/Defaults.js))
+     * @param {Object} options                   Options for this API call Options to be used for all requests (see [Defaults](../src/Defaults.js))
      * @param {string} [options.baseUrl]
      * @param {string} [options.clientSecret]
      * @param {string} [options.clientId]
      * @param {number} [options.tokenDuration]
-     * @param {string} [options.auth]           The access token. If not specified here, will have to be added to every request
+     * @param {string} [options.auth]            The access token. If not specified here, will have to be added to every request
      */
     constructor(options = {}){
         if (options.auth) {
@@ -37,6 +37,7 @@ class Particle {
         // todo - this seems a bit dangerous - would be better to put all options/context in a contained object
         Object.assign(this, Defaults, options);
         this.context = {};
+
         this.agent = new Agent(this.baseUrl);
     }
 
@@ -44,6 +45,25 @@ class Particle {
         return (name === 'tool' || name === 'project') && context !== undefined;
     }
 
+    /**
+     * @typedef {Object} ToolContext
+     * @property {string} name
+     * @property {string | number} [version]
+     * @property {Omit<ToolContext, 'components'>[]} [components]
+     */
+
+    /**
+     * @typedef {Record<string, string | number>} ProjectContext
+     * @property {string} name
+     */
+
+    /**
+     * Allows setting a tool or project context which will be sent as headers with every request.
+     * Tool- x-particle-tool
+     * Project- x-particle-project
+     * @param {'tool' | 'project'} name
+     * @param {ToolContext | ProjectContext | undefined} context
+     */
     setContext(name, context){
         if (context !== undefined){
             if (this._isValidContext(name, context)){

package/test/EventStream.spec.js

@@ -49,7 +49,7 @@ describe('EventStream', () => {
                 expect(http.request).to.have.been.calledWith({
                     hostname: 'hostname',
                     protocol: 'http:',
-                    path: '/path',
+                    path: '/path?nonce=0',
                     headers: {
                         'Authorization': 'Bearer token'
                     },