pryv 2.4.5 → 2.4.7

package/README.md

@@ -199,7 +199,7 @@ try {
 ```js
 let count = 0;
 // the following will be called on each API method result it was provided for
-function handleResult(result) { console.log('Got result ' + count++ + ': ' + JSON.stringify(result)); }
+function handleResult(result, apiCall) { console.log('Got result ' + count++ + ': ' + JSON.stringify(result) + ' For call ' + JSON.stringify(apiCall)); }
 
 function progress(percentage) { console.log('Processed: ' + percentage + '%'); }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pryv",
-  "version": "2.4.5",
+  "version": "2.4.7",
   "description": "Pryv JavaScript library",
   "keywords": [
     "Pryv",
@@ -12,7 +12,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git://github.com/pryv/lib-js"
+    "url": "git://github.com/pryv/lib-js.git"
   },
   "license": "BSD-3-Clause",
   "author": "Pryv S.A. <info@pryv.com> (https://pryv.com)",

package/src/Connection.js

@@ -26,7 +26,7 @@ const browserGetEventStreamed = require('./lib/browser-getEventStreamed');
  * @param {pryv.Service} [service] - eventually initialize Connection with a Service
  */
 class Connection {
-  constructor(apiEndpoint, service) {
+  constructor (apiEndpoint, service) {
     const { token, endpoint } = utils.extractTokenAndAPIEndpoint(apiEndpoint);
     this.token = token;
     this.endpoint = endpoint;
@@ -34,7 +34,7 @@ class Connection {
     this.options.chunkSize = 1000;
     this._deltaTime = { value: 0, weight: 0 };
     if (service && !(service instanceof Service)) {
-      throw new Error("Invalid service param");
+      throw new Error('Invalid service param');
     }
     this._service = service;
   }
@@ -44,9 +44,9 @@ class Connection {
    * @readonly
    * @property {pryv.Service} service
    */
-  get service() {
+  get service () {
     if (this._service) return this._service;
-    this._service = new Service(this.endpoint + "service/info");
+    this._service = new Service(this.endpoint + 'service/info');
     return this._service;
   }
 
@@ -56,7 +56,7 @@ class Connection {
    * @param {*} arrayOfAPICalls
    * @param {*} progress
    */
-  async username() {
+  async username () {
     const accessInfo = await this.accessInfo();
     return accessInfo.user.username;
   }
@@ -65,8 +65,8 @@ class Connection {
    * get access info
    * It's async as it is constructed with get function.
    */
-  async accessInfo() {
-    return this.get("access-info", null);
+  async accessInfo () {
+    return this.get('access-info', null);
   }
 
   /**
@@ -77,9 +77,9 @@ class Connection {
    * @param {Function} [progress] Return percentage of progress (0 - 100);
    * @returns {Promise<Array>} Promise to Array of results matching each method call in order
    */
-  async api(arrayOfAPICalls, progress) {
-    function httpHandler(batchCall) {
-      return this.post("", batchCall);
+  async api (arrayOfAPICalls, progress) {
+    function httpHandler (batchCall) {
+      return this.post('', batchCall);
     }
     return await this._chunkedBatchCall(
       arrayOfAPICalls,
@@ -95,7 +95,7 @@ class Connection {
    * @param {string} [resultKey] - if given, returns the value or throws an error if not present
    * @throws {Error} if .error is present the response
    */
-  async apiOne(method, params = {}, expectedKey) {
+  async apiOne (method, params = {}, expectedKey) {
     const result = await this.api([{ method, params }]);
     if (
       result[0] == null ||
@@ -121,14 +121,14 @@ class Connection {
    * @param {boolean} [throwOnFail = true] - if set to false do not throw Error on failure
    * @param {Connection} [usingConnection] - specify which connection issues the revoke, might be necessary when selfRovke
    */
-  async revoke(throwOnFail = true, usingConnection) {
+  async revoke (throwOnFail = true, usingConnection) {
     usingConnection = usingConnection || this;
     let accessInfo = null;
     // get accessId
     try {
       accessInfo = await this.accessInfo();
     } catch (e) {
-      if (e.response?.body?.error?.id === "invalid-access-token") {
+      if (e.response?.body?.error?.id === 'invalid-access-token') {
         return null; // Already revoked OK..
       }
       if (throwOnFail) throw e;
@@ -136,8 +136,8 @@ class Connection {
     }
     // delete access
     try {
-      const result = usingConnection.apiOne("accesses.delete", {
-        id: accessInfo.id,
+      const result = usingConnection.apiOne('accesses.delete', {
+        id: accessInfo.id
       });
       return result;
     } catch (e) {
@@ -149,9 +149,9 @@ class Connection {
   /**
    * @private
    */
-  async _chunkedBatchCall(arrayOfAPICalls, progress, callHandler) {
+  async _chunkedBatchCall (arrayOfAPICalls, progress, callHandler) {
     if (!Array.isArray(arrayOfAPICalls)) {
-      throw new Error("Connection.api() takes an array as input");
+      throw new Error('Connection.api() takes an array as input');
     }
 
     const res = [];
@@ -170,7 +170,7 @@ class Connection {
       for (let i = cursor; i < cursorMax; i++) {
         thisBatch.push({
           method: arrayOfAPICalls[i].method,
-          params: arrayOfAPICalls[i].params,
+          params: arrayOfAPICalls[i].params
         });
       }
       const resRequest = await callHandler(thisBatch);
@@ -178,12 +178,12 @@ class Connection {
       // result checks
       if (!resRequest || !Array.isArray(resRequest.results)) {
         throw new Error(
-          "API call result is not an Array: " + JSON.stringify(resRequest)
+          'API call result is not an Array: ' + JSON.stringify(resRequest)
         );
       }
       if (resRequest.results.length !== thisBatch.length) {
         throw new Error(
-          "API call result Array does not match request: " +
+          'API call result Array does not match request: ' +
             JSON.stringify(resRequest)
         );
       }
@@ -193,7 +193,8 @@ class Connection {
         if (arrayOfAPICalls[i + cursor].handleResult) {
           await arrayOfAPICalls[i + cursor].handleResult.call(
             null,
-            resRequest.results[i]
+            resRequest.results[i],
+            thisBatch[i] // request
           );
         }
       }
@@ -213,7 +214,7 @@ class Connection {
    * @param {string} path
    * @returns {Promise<Array|Object>} Promise to result.body
    */
-  async post(path, data, queryParams) {
+  async post (path, data, queryParams) {
     const now = getTimestamp();
     const res = await this.postRaw(path, data, queryParams);
     this._handleMeta(res.body, now);
@@ -227,15 +228,15 @@ class Connection {
    * @param {string} path
    * @returns {request.superagent}  Promise from superagent's post request
    */
-  async postRaw(path, data, queryParams) {
+  async postRaw (path, data, queryParams) {
     return this._post(path).query(queryParams).send(data);
   }
 
-  _post(path) {
+  _post (path) {
     return utils.superagent
       .post(this.endpoint + path)
-      .set("Authorization", this.token)
-      .set("accept", "json");
+      .set('Authorization', this.token)
+      .set('accept', 'json');
   }
 
   /**
@@ -244,7 +245,7 @@ class Connection {
    * @param {string} path
    * @returns {Promise<Array|Object>}  Promise to result.body
    */
-  async get(path, queryParams) {
+  async get (path, queryParams) {
     const now = getTimestamp();
     const res = await this.getRaw(path, queryParams);
     this._handleMeta(res.body, now);
@@ -257,12 +258,12 @@ class Connection {
    * @param {string} path
    * @returns {request.superagent}  Promise from superagent's get request
    */
-  getRaw(path, queryParams) {
-    path = path || "";
+  getRaw (path, queryParams) {
+    path = path || '';
     return utils.superagent
       .get(this.endpoint + path)
-      .set("Authorization", this.token)
-      .set("accept", "json")
+      .set('Authorization', this.token)
+      .set('accept', 'json')
       .query(queryParams);
   }
 
@@ -270,14 +271,14 @@ class Connection {
    * ADD Data Points to HFEvent (flatJSON format)
    * https://api.pryv.com/reference/#add-hf-series-data-points
    */
-  async addPointsToHFEvent(eventId, fields, points) {
-    const res = await this.post("events/" + eventId + "/series", {
-      format: "flatJSON",
+  async addPointsToHFEvent (eventId, fields, points) {
+    const res = await this.post('events/' + eventId + '/series', {
+      format: 'flatJSON',
       fields: fields,
-      points: points,
+      points: points
     });
-    if (!res.status === "ok") {
-      throw new Error("Failed loading serie: " + JSON.stringify(res.status));
+    if (!res.status === 'ok') {
+      throw new Error('Failed loading serie: ' + JSON.stringify(res.status));
     }
     return res;
   }
@@ -290,26 +291,26 @@ class Connection {
    * @param {Function} forEachEvent Function taking one event as parameter. Will be called for each event
    * @returns {Promise<Object>} Promise to result.body transformed with `eventsCount: {count}` replacing `events: [...]`
    */
-  async getEventsStreamed(queryParams, forEachEvent) {
+  async getEventsStreamed (queryParams, forEachEvent) {
     const myParser = jsonParser(forEachEvent, queryParams.includeDeletions);
     let res = null;
-    if (typeof window === "undefined") {
+    if (typeof window === 'undefined') {
       // node
-      res = await this.getRaw("events", queryParams)
+      res = await this.getRaw('events', queryParams)
         .buffer(false)
         .parse(myParser);
     } else if (
-      typeof fetch !== "undefined" &&
-      !(typeof navigator !== "undefined" && navigator.product === "ReactNative")
+      typeof fetch !== 'undefined' &&
+      !(typeof navigator !== 'undefined' && navigator.product === 'ReactNative')
     ) {
       // browser supports fetch and it is not react native
       res = await browserGetEventStreamed(this, queryParams, myParser);
     } else {
       // browser no fetch supports
       console.log(
-        "WARNING: Browser does not support fetch() required by pryv.Connection.getEventsStreamed()"
+        'WARNING: Browser does not support fetch() required by pryv.Connection.getEventsStreamed()'
       );
-      res = await this.getRaw("events", queryParams);
+      res = await this.getRaw('events', queryParams);
       res.body.eventsCount = 0;
       if (res.body.events) {
         res.body.events.forEach(forEachEvent);
@@ -335,10 +336,10 @@ class Connection {
    * @param {Event} event
    * @param {string} filePath
    */
-  async createEventWithFile(event, filePath) {
-    const res = await this._post("events")
-      .field("event", JSON.stringify(event))
-      .attach("file", filePath);
+  async createEventWithFile (event, filePath) {
+    const res = await this._post('events')
+      .field('event', JSON.stringify(event))
+      .attach('file', filePath);
 
     const now = getTimestamp();
     this._handleMeta(res.body, now);
@@ -351,12 +352,12 @@ class Connection {
    * @param {Buffer|Blob} bufferData - Buffer for node, Blob for browser
    * @param {string} fileName
    */
-  async createEventWithFileFromBuffer(event, bufferData, filename) {
-    if (typeof window === "undefined") {
+  async createEventWithFileFromBuffer (event, bufferData, filename) {
+    if (typeof window === 'undefined') {
       // node
-      const res = await this._post("events")
-        .field("event", JSON.stringify(event))
-        .attach("file", bufferData, filename);
+      const res = await this._post('events')
+        .field('event', JSON.stringify(event))
+        .attach('file', bufferData, filename);
 
       const now = getTimestamp();
       this._handleMeta(res.body, now);
@@ -364,7 +365,7 @@ class Connection {
     } else {
       /* global FormData */
       const formData = new FormData();
-      formData.append("file", bufferData, filename);
+      formData.append('file', bufferData, filename);
       const body = await this.createEventWithFormData(event, formData);
       return body;
     }
@@ -376,9 +377,9 @@ class Connection {
    * @param {Event} event
    * @param {FormData} formData https://developer.mozilla.org/en-US/docs/Web/API/FormData/FormData
    */
-  async createEventWithFormData(event, formData) {
-    formData.append("event", JSON.stringify(event));
-    const res = await this._post("events").send(formData);
+  async createEventWithFormData (event, formData) {
+    formData.append('event', JSON.stringify(event));
+    const res = await this._post('events').send(formData);
     return res.body;
   }
 
@@ -388,7 +389,7 @@ class Connection {
    * @readonly
    * @property {number} deltaTime
    */
-  get deltaTime() {
+  get deltaTime () {
     return this._deltaTime.value;
   }
 
@@ -397,15 +398,14 @@ class Connection {
    * @readonly
    * @property {APIEndpoint} deltaTime
    */
-  get apiEndpoint() {
+  get apiEndpoint () {
     return utils.buildAPIEndpoint(this);
   }
 
   // private method that handle meta data parsing
-  _handleMeta(res, requestLocalTimestamp) {
-    if (!res.meta) throw new Error("Cannot find .meta in response.");
-    if (!res.meta.serverTime)
-      throw new Error("Cannot find .meta.serverTime in response.");
+  _handleMeta (res, requestLocalTimestamp) {
+    if (!res.meta) throw new Error('Cannot find .meta in response.');
+    if (!res.meta.serverTime) { throw new Error('Cannot find .meta.serverTime in response.'); }
 
     // update deltaTime and weight it
     this._deltaTime.value =

package/src/index.d.ts

@@ -17,7 +17,7 @@ declare module 'pryv' {
     name: string;
     parentId?: Identifier;
     clientData?: KeyValue;
-    children: Identifier[];
+    children: Stream[];
     trashed?: boolean;
     created: Timestamp;
     createdBy: Identifier;
@@ -530,7 +530,7 @@ declare module 'pryv' {
     APICallMethods[K]['res'] & PossibleError;
 
   export type APICallResultHandler<K extends keyof APICallMethods> = (
-    result: APICallResult<K>,
+    result: APICallResult<K>, apicall: APICall<K>
   ) => Promise<any>;
   export type StreamedEventsHandler = (event: Event) => void;
 
@@ -577,15 +577,15 @@ declare module 'pryv' {
       apiCalls: Calls,
       progress?: APICallProgressHandler,
     ): Promise<Array<TypedAPICallResult>>;
-    apiOne(
-      method: keyof APICallMethods, 
-      params: APICallMethods[keyof APICallMethods], 
-    ): Promise<TypedAPICallResult>;
-    apiOne(
-      method: keyof APICallMethods, 
-      params: APICallMethods[keyof APICallMethods], 
-      expectedKey: string
-    ): Promise<TypedAPICallResult[keyof TypedAPICallResult]>;
+    apiOne<T extends keyof APICallMethods>(
+      method: T, 
+      params: APICallMethods[T]['params'], 
+    ): Promise<APICallMethods[T]['res']>;
+    apiOne<T extends keyof APICallMethods, U extends keyof APICallMethods[T]['res']>(
+      method: T, 
+      params: APICallMethods[T]['params'], 
+      expectedKey: U
+    ): Promise<APICallMethods[T]['res'][U]>;
     getEventsStreamed(
       queryParams: Partial<EventQueryParamsStreamQuery>,
       forEachEvent: StreamedEventsHandler,

package/test/Connection.test.js

@@ -95,7 +95,7 @@ describe('Connection', () => {
       const res = await conn.apiOne('events.get');
       expect(res.events).to.exist;
     });
-     it('.apiOne("events.get")', async () => {
+    it('.apiOne("events.get")', async () => {
       const res = await conn.apiOne('events.get', {}, 'events');
       expect(Array.isArray(res)).to.equal(true);
     });
@@ -129,8 +129,9 @@ describe('Connection', () => {
       conn.options.chunkSize = 2;
 
       let resultsReceivedCount = 0;
-      function oneMoreResult (res) {
+      function oneMoreResult (res, apiCall) {
         expect(res.events).to.exist;
+        expect(apiCall.method).to.equal('events.get');
         resultsReceivedCount++;
       }