npm - pryv - Versions diffs - 2.1.6 → 2.2.0 - Mend

pryv 2.1.6 → 2.2.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 (8) hide show

package/LICENSE.md CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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
@@ -59,10 +67,10 @@ This JavaScript library is meant to facilitate writing NodeJS and browser apps f
 #### Others distributions for browsers & extensions:
-- ES6: `https://api.pryv.com/lib-js/pryv-es6.js`
+- ES6: `https://api.pryv.com/lib-js/pryv-es6.js`
 - Bundle: (Socket.io + Monitor + Lib-js) `https://api.pryv.com/lib-js/pryv-socket.io-monitor.js`.
-  This library can be extended with two packages:
-  - Socket.io extension: [https://github.com/pryv/lib-js-socket.io](https://github.com/pryv/lib-js-socket.io)
+  This library can be extended with two packages:
+  - Socket.io extension: [https://github.com/pryv/lib-js-socket.io](https://github.com/pryv/lib-js-socket.io)
   - Monitor extension: [https://github.com/pryv/lib-js-monitor](https://github.com/pryv/lib-js-monitor)
 #### Example on code pen:
@@ -71,7 +79,7 @@ This JavaScript library is meant to facilitate writing NodeJS and browser apps f
 #### Node.js
-Install with:  `npm install pryv --save `
+Install with:  `npm install pryv --save `
 ```javascript
 const Pryv = require('pryv');
@@ -100,7 +108,7 @@ const connection = new Pryv.Connection(apiEndpoint);
 #### Within a WebPage with a login button
-The following code is an implementation of the [Pryv.io Authentication process](https://api.pryv.com/reference/#authenticate-your-app).
+The following code is an implementation of the [Pryv.io Authentication process](https://api.pryv.com/reference/#authenticate-your-app).
 ```html
 <!doctype html>
@@ -135,7 +143,7 @@ The following code is an implementation of the [Pryv.io Authentication process](
         // referer: 'my test with lib-js', // optional string to track registration source
       }
     };
     function pryvAuthStateChange(state) { // called each time the authentication state changed
       console.log('##pryvAuthStateChange', state);
       if (state.id === Pryv.Auth.AuthStates.AUTHORIZED) {
@@ -266,7 +274,7 @@ try {
 #### result:
 ```javascript
-{
+{
   eventsCount: 10000,
   meta:
   {
@@ -298,7 +306,7 @@ try {
 #### result:
 ```javascript
-{
+{
   eventDeletionsCount: 150,
   eventsCount: 10000,
   meta:
@@ -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
@@ -344,7 +368,7 @@ From an Input field
     'file0',
     document.getElementById('create-file').files[0]
 ) ;
   connection.createEventWithFormData(
     {
       type: 'file/attached',
@@ -378,9 +402,24 @@ 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
+### High Frequency Events
 Reference: [https://api.pryv.com/reference/#hf-events](https://api.pryv.com/reference/#hf-events)
@@ -436,9 +475,9 @@ A Pryv.io deployment is a unique "Service", as an example **Pryv Lab** is a serv
 It relies on the content of a **service information** configuration, See: [Service Information API reference](https://api.pryv.com/reference/#service-info)
-#### Pryv.Service
+#### Pryv.Service
-Exposes tools to interact with Pryv.io at a "Platform" level.
+Exposes tools to interact with Pryv.io at a "Platform" level.
 ##### Initizalization with a service info URL
@@ -453,7 +492,7 @@ Service information properties can be overriden with specific values. This might
 ```javascript
 const serviceInfoUrl = 'https://reg.pryv.me/service/info';
 const serviceCustomizations = {
-  name: 'Pryv Lab 2',
+  name: 'Pryv Lab 2',
   assets: {
     definitions: 'https://pryv.github.io/assets-pryv.me/index.json'
   }
@@ -465,7 +504,7 @@ const service = new Pryv.Service(serviceInfoUrl, serviceCustomizations);
 See: [Pryv.Service](https://pryv.github.io/js-lib/docs/Pryv.Service.html) for more details
-- `service.info()` - returns the content of the serviceInfo in a Promise
+- `service.info()` - returns the content of the serviceInfo in a Promise
   ```javascript
   // example: get the name of the platform
@@ -480,7 +519,7 @@ See: [Pryv.Service](https://pryv.github.io/js-lib/docs/Pryv.Service.html) for mo
 #### Pryv.Browser - retrieve serviceInfo from query URL
-A single Web App might need to be run on different Pryv.io platforms. This is the case of most Pryv.io demonstrators.
+A single Web App might need to be run on different Pryv.io platforms. This is the case of most Pryv.io demonstrators.
 The corresponding Pryv.io platform can be specified by providing the Service Information URL as query parameter `pryvServiceInfoUrl` as per the [Pryv App Guidelines](https://api.pryv.com/guides/app-guidelines/). It can be extracted using `Pryv.Browser.serviceInfoFromUrl()` .
@@ -488,7 +527,7 @@ Example of usage for web App with the url https://api.pryv.com/app-web-access/?p
 ```javascript
 let defaultServiceInfoUrl = 'https://reg.pryv.me/service/info';
-// if present override serviceInfoURL from URL query param "?pryvServiceInfoUrl=.."
+// if present override serviceInfoURL from URL query param "?pryvServiceInfoUrl=.."
 serviceInfoUrl = Pryv.Browser.serviceInfoFromUrl() || defaultServiceInfoUrl;
 (async function () {
@@ -539,7 +578,7 @@ async init () {
   // set cookie key for authorization data - browser only
   this._cookieKey = 'pryv-libjs-' + this.authSettings.authRequest.requestingAppId;
   // initialize controller
   this.auth = new AuthController(this.authSettings, this.service, this);
   await this.auth.init();
@@ -661,8 +700,8 @@ For a more advanced scenario, you can check the default button implementation at
 #### Redirect user to the authentication page
-There is a possibility that you would like to register the user in another page. You can check the [`./web-demos/auth-with-redirection.html`](./web-demos/auth-with-redirection.html) example.
-Also you can try the same code in [https://api.pryv.com/lib-js/demos/auth-with-redirection.html](https://api.pryv.com/lib-js/demos/auth-with-redirection.html).
+There is a possibility that you would like to register the user in another page. You can check the [`./web-demos/auth-with-redirection.html`](./web-demos/auth-with-redirection.html) example.
+Also you can try the same code in [https://api.pryv.com/lib-js/demos/auth-with-redirection.html](https://api.pryv.com/lib-js/demos/auth-with-redirection.html).
 Here is the explanation how to [launch web-demos locally](#launch-web-demos-locally)
 ### Launch web demos locally
@@ -674,22 +713,30 @@ You can find html examples in the [`./web-demos`](/web-demos) directory. You can
     ```bash
     npm run webserver
     ```
     and open an example with the following URL **https://l.rec.la:9443/demos/EXAMPLE_NAME.html**, like: [https://l.rec.la:9443/demos/auth.html](https://l.rec.la:9443/demos/auth.html)
 2. as a simple html file (service information must be passed as JSON to avoid CORS problem).
 # Change Log
+## 2.2.0
+- Added TypeScript typings – contribution from @ovesco
+## 2.1.7
+- Removed JSDOC dev dependency for security reason
 ## 2.1.0
 - UI separated from the Authentication logic
 - Extendable UI feature was added
-## 2.0.3
+## 2.0.3
-- Added Connection.username()
+- Added Connection.username()
 - Various dependencies upgrades
 - Fixing Origin header in Browser distribution
-## 2.0.1 Initial Release
+## 2.0.1 Initial Release

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "pryv",
-  "version": "2.1.6",
+  "version": "2.2.0",
   "homepage": "https://github.com/pryv/lib-js",
   "description": "Pryv Javascript Library",
   "keywords": [
@@ -17,11 +17,12 @@
     "name": "Pryv S.A."
   },
   "main": "src/index.js",
+  "types": "src/index.d.ts",
   "license": "BSD-3-Clause",
   "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 +39,19 @@
     }
   ],
   "dependencies": {
-    "superagent": "^5.2.2"
+    "superagent": "^7.0.2"
   },
   "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.6",
+    "@pryv/socket.io": "^1.0.6",
+    "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
     "cuid": "^2.1.8",
-    "jsdoc": "^3.6.6",
-    "mocha": "^6.2.3",
-    "node-fetch": "^2.6.0",
-    "nyc": "^14.1.1",
-    "rec-la": "latest",
+    "mocha": "^9.1.3",
+    "node-fetch": "^2.6.1",
+    "nyc": "^15.1.0",
+    "rec.la": "latest",
     "universal-url": "^2.0.0",
     "zombie": "^6.1.4"
   }

package/src/Connection.js CHANGED Viewed

@@ -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/src/index.d.ts ADDED Viewed

@@ -0,0 +1,845 @@
+declare module 'pryv' {
+  type Timestamp = number;
+  type Identifier = string;
+  type Level = 'read' | 'contribute' | 'manage' | 'create-only';
+  type KeyValue = { [key: string]: string | number };
+  type Attachment = {
+    id: Identifier;
+    fileName: string;
+    type: string;
+    size: number;
+    readToken: string;
+  };
+  type Stream = {
+    id: Identifier;
+    name: string;
+    parentId?: Identifier;
+    clientData?: KeyValue;
+    children: Identifier[];
+    trashed?: boolean;
+    created: Timestamp;
+    createdBy: Identifier;
+    modified: Timestamp;
+    modifiedBy: Identifier;
+  };
+  type Event = {
+    id: Identifier;
+    streamIds: Identifier[];
+    streamId: Identifier;
+    time: Timestamp;
+    duration?: Timestamp;
+    type: string;
+    content?: any;
+    tags?: string[];
+    description?: string;
+    attachments?: Attachment[];
+    clientData?: KeyValue;
+    trashed?: boolean;
+    created: Timestamp;
+    createdBy: Identifier;
+    modified: Timestamp;
+    modifiedBy: Identifier;
+  };
+  type Permission = {
+    streamId: Identifier;
+    level: Level;
+    feature?: 'selfRevoke';
+    setting?: 'forbidden';
+  };
+  type Access = {
+    id: Identifier;
+    token: string;
+    type?: 'personal' | 'app' | 'shared';
+    name: string;
+    deviceName?: string;
+    permissions: Permission[];
+    lastUsed?: Timestamp;
+    expireAfter?: number;
+    expires?: Timestamp;
+    deleted?: Timestamp;
+    clientData?: KeyValue;
+    created: Timestamp;
+    createdBy: Identifier;
+    modified: Timestamp;
+    modifiedBy: Identifier;
+  };
+  type FollowedSlice = {
+    id: Identifier;
+    name: string;
+    url: string;
+    accessToken: string;
+  };
+  type AccountInformation = {
+    username: string;
+    email: string;
+    language: string;
+    storageUsed: {
+      dbDocuments: number;
+      attachedFiles: number;
+    };
+  };
+  // HTTP only
+  type AuditLog = {
+    id: Identifier;
+    type: string;
+    time: Timestamp;
+    forwardedFor: string;
+    action: string;
+    query: string;
+    accessId: string;
+    status: number;
+    errorMessage?: string;
+    errorId?: string;
+  };
+  type HFSeries = {
+    format: 'flatJSON';
+    fields: string[];
+    points: Array<number | string>;
+  };
+  type Run = {
+    status: number;
+    timestamp: Timestamp;
+  };
+  type WebHook = {
+    id: Identifier;
+    accessId: Identifier;
+    url: string;
+    minIntervalMs: number;
+    maxRetries: number;
+    currentRetries: number;
+    state: 'active' | 'inactive';
+    runCount: number;
+    failCount: number;
+    lastRun: Run;
+    runs: Run[];
+    created: Timestamp;
+    createdBy: Identifier;
+    modified: Timestamp;
+    modifiedBy: Identifier;
+  };
+  type ItemDeletion = {
+    id: Identifier;
+    deleted?: Timestamp;
+  };
+  type Error = {
+    id: string;
+    message: string;
+    data?: any;
+    subErrors?: Error[];
+  };
+  type StreamsQuery = {
+    any?: Identifier[];
+    all?: Identifier[];
+    not?: Identifier[];
+  };
+  type EventQueryParams = {
+    fromTime: Timestamp;
+    toTime: Timestamp;
+    streams: string[];
+    tags: string[];
+    types: string[];
+    running: boolean;
+    sortAscending: boolean;
+    skip: number;
+    limit: number;
+    state: 'default' | 'trashed' | 'all';
+    modifiedSince: Timestamp;
+    includeDeletion: boolean;
+  };
+  type EventQueryParamsStreamQuery = Omit<EventQueryParams, 'streams'> & {
+    streams: string[] | StreamsQuery;
+  };
+  type EditMetadata = 'created' | 'createdBy' | 'modified' | 'modifiedBy';
+  export type ApiCallMethods = {
+    // mfa
+    'mfa.challenge': {
+      params: null;
+      res: {
+        message: string;
+      };
+    };
+    'mfa.recover': {
+      params: {
+        recoveryCode: string;
+        username: string;
+        password: string;
+        appId: string;
+      };
+      res: {
+        message: string;
+      };
+    };
+    // events
+    'events.get': {
+      params: Partial<EventQueryParamsStreamQuery>;
+      res: {
+        eventDeletions?: ItemDeletion[];
+        events: Event[];
+      };
+    };
+    'events.getOne': {
+      params: {
+        id: Identifier;
+        includeHistory?: boolean;
+      };
+      res: {
+        event: Event;
+        history?: Event[];
+      };
+    };
+    'events.create': {
+      params: Partial<Omit<Event, 'attachments' | EditMetadata>>;
+      res: {
+        event: Event;
+      };
+    };
+    'events.update': {
+      params: {
+        id: Identifier;
+        update: Partial<Omit<Event, 'id' | 'attachments' | EditMetadata>>;
+      };
+      res: {
+        event: Event;
+      };
+    };
+    'events.deleteAttachment': {
+      params: {
+        id: Identifier;
+        fileId: Identifier;
+      };
+      res: {
+        event: Event;
+      };
+    };
+    'events.delete': {
+      params: {
+        id: Identifier;
+      };
+      res: {
+        event: Event;
+      };
+    };
+    // HFS
+    'hfs.create': {
+      params: Partial<Omit<Event, 'attachments' | EditMetadata>>;
+      res: {
+        event: Event;
+      };
+    };
+    'hfs.update': {
+      params: {
+        id: Identifier;
+        update: Partial<Omit<Event, 'id' | 'attachments' | EditMetadata>>;
+      };
+      res: {
+        event: Event;
+      };
+    };
+    'hfs.delete': {
+      params: {
+        id: Identifier;
+      };
+      res: {
+        event: Event;
+      };
+    };
+    // Streams
+    'streams.get': {
+      params: {
+        parentId?: Identifier;
+        state?: 'default' | 'all';
+        includeDeletionsSince?: Timestamp;
+      };
+      res: {
+        streams: Stream[];
+        streamDeletions?: ItemDeletion[];
+      };
+    };
+    'streams.create': {
+      params: Partial<Omit<Stream, 'children' | EditMetadata>>;
+      res: {
+        stream: Stream;
+      };
+    };
+    'streams.update': {
+      params: {
+        id: Identifier;
+        update: Partial<Stream>;
+      };
+      res: {
+        stream: Stream;
+      };
+    };
+    'streams.delete': {
+      params: {
+        id: Identifier;
+        mergeEventsWithParents: 'true' | 'false';
+      };
+      res: {
+        stream: Stream;
+      };
+    };
+    // Accesses
+    'accesses.get': {
+      params: {
+        includeExpired?: boolean;
+        includeDeletions?: boolean;
+      };
+      res: {
+        accesses: Access[];
+        accessDeletions?: Access[];
+      };
+    };
+    'accesses.create': {
+      params: Partial<
+        Omit<Access, 'id' | 'lastUsed' | 'expires' | 'deleted' | EditMetadata>
+      >;
+      res: {
+        access: Access;
+      };
+    };
+    'accesses.delete': {
+      params: {
+        id: Identifier;
+      };
+      res: {
+        accessDeletion: ItemDeletion;
+        relatedDeletions?: ItemDeletion[];
+      };
+    };
+    'accesses.checkApp': {
+      params: {
+        requestingAppId: string;
+        deviceName?: string;
+        requestedPermissions: Array<Permission & { defaultName: string }>;
+      };
+      res: {
+        checkedPermissions?: Permission[];
+        mismatchingAccess?: Access;
+        matchingAccess?: Access;
+      };
+    };
+    getAccessInfo: {
+      params: null;
+      res: {
+        calls: KeyValue;
+        user: KeyValue;
+      };
+    };
+    // Webhooks
+    'webhooks.get': {
+      params: null;
+      res: {
+        webhooks: WebHook[];
+      };
+    };
+    'webhooks.getOne': {
+      params: {
+        id: Identifier;
+      };
+      res: {
+        webhook: WebHook;
+      };
+    };
+    'webhooks.create': {
+      params: {
+        webhook: Partial<Pick<WebHook, 'url' | 'state'>>;
+      };
+      res: {
+        webhook: WebHook;
+      };
+    };
+    'webhooks.update': {
+      params: {
+        id: Identifier;
+        update: Partial<Pick<WebHook, 'state'>>;
+      };
+      res: {
+        webhook: WebHook;
+      };
+    };
+    'webhooks.delete': {
+      params: {
+        id: Identifier;
+      };
+      res: {
+        webhookDeletion: ItemDeletion;
+      };
+    };
+    'webhooks.test': {
+      params: {
+        id: Identifier;
+      };
+      res: {
+        webhook: WebHook;
+      };
+    };
+    // Followed Slices
+    'followedSlices.get': {
+      params: null;
+      res: {
+        followedSlices: FollowedSlice[];
+      };
+    };
+    'followedSlices.create': {
+      params: Partial<Pick<FollowedSlice, 'name' | 'url' | 'accessToken'>>;
+      res: {
+        followedSlice: FollowedSlice;
+      };
+    };
+    'followedSlices.update': {
+      params: {
+        id: Identifier;
+        update: Partial<Pick<FollowedSlice, 'name' | 'url' | 'accessToken'>>;
+      };
+      res: {
+        followedSlice: FollowedSlice;
+      };
+    };
+    'followedSlices.delete': {
+      params: {
+        id: Identifier;
+      };
+      res: {
+        followedSliceDeletion: ItemDeletion;
+      };
+    };
+    // Profile sets
+    'profile.getApp': {
+      params: null;
+      res: {
+        profile: KeyValue;
+      };
+    };
+    'profile.updateApp': {
+      params: {
+        update: KeyValue;
+      };
+      res: {
+        profile: KeyValue;
+      };
+    };
+    'profile.getPublic': {
+      params: null;
+      res: {
+        profile: KeyValue;
+      };
+    };
+    'profile.updatePublic': {
+      params: {
+        update: KeyValue;
+      };
+      res: {
+        profile: KeyValue;
+      };
+    };
+    'profile.getPrivate': {
+      params: null;
+      res: {
+        profile: KeyValue;
+      };
+    };
+    'profile.updatePrivate': {
+      params: {
+        update: KeyValue;
+      };
+      res: {
+        profile: KeyValue;
+      };
+    };
+    // Account management
+    'account.get': {
+      params: null;
+      res: {
+        account: AccountInformation;
+      };
+    };
+    'account.update': {
+      params: {
+        update: Partial<Omit<AccountInformation, 'username'>>;
+      };
+      res: {
+        account: AccountInformation;
+      };
+    };
+    'account.changePassword': {
+      params: {
+        oldPassword: string;
+        newPassword: string;
+      };
+      res: null;
+    };
+    'account.requestPasswordReset': {
+      params: {
+        appId: string;
+      };
+      res: null;
+    };
+    'account.resetPassword': {
+      params: {
+        resetToken: string;
+        newPassword: string;
+        appId: string;
+      };
+      res: null;
+    };
+  };
+  type UnionToIntersection<U> = (
+    U extends any ? (k: U) => any : never
+  ) extends (k: infer I) => any
+    ? I
+    : never;
+  type ApiCallResultUnion = ApiCallMethods[keyof ApiCallMethods]['res'];
+  type ApiCallResultTypes = UnionToIntersection<
+    NonNullable<ApiCallResultUnion>
+  >;
+  type PossibleError = {
+    error?: Error;
+  };
+  type ApiCallResult<K extends keyof ApiCallMethods> =
+    ApiCallMethods[K]['res'] & PossibleError;
+  export type ApiCallResultHandler<K extends keyof ApiCallMethods> = (
+    result: ApiCallResult<K>,
+  ) => Promise<any>;
+  export type StreamedEventsHandler = (event: Event) => void;
+  type StreamedEventsResult = {
+    eventsCount?: number;
+    eventsDeletionsCount?: number;
+    meta: {
+      apiVersion: string;
+      serverTime: number;
+      serial: string;
+    };
+  };
+  export type EventFileCreationParams = Partial<
+    Omit<Event, 'attachments' | EditMetadata>
+  >;
+  export type ApiCall<K extends keyof ApiCallMethods = keyof ApiCallMethods> =
+    K extends keyof ApiCallMethods
+      ? {
+          method: K;
+          params: ApiCallMethods[K]['params'];
+          handleResult?: ApiCallResultHandler<K>;
+        }
+      : never;
+  export type TypedApiCallResult = ApiCallResultTypes & PossibleError;
+  export type ApiCallProgressHandler = (percentage: number) => void;
+  interface AccessInfo extends Access {
+    calls: KeyValue;
+    user: KeyValue;
+  }
+  type EventApiCallRes = {
+    event?: Event;
+  } & PossibleError;
+  export interface Connection {
+    new (pryvApiEndpoint: string, service?: Service): Connection;
+    get service(): Service;
+    username(): Promise<string>;
+    api<Calls extends ApiCall[] = ApiCall[]>(
+      apiCalls: Calls,
+      res?: ApiCallProgressHandler[],
+    ): Promise<Array<TypedApiCallResult>>;
+    getEventsStreamed(
+      queryParams: Partial<EventQueryParamsStreamQuery>,
+      forEachEvent: StreamedEventsHandler,
+    ): Promise<StreamedEventsResult>;
+    createEventWithFile(
+      params: EventFileCreationParams,
+      filePath: string | Buffer | Blob,
+    ): Promise<EventApiCallRes>;
+    createEventWithFormData(
+      params: EventFileCreationParams,
+      formData: FormData,
+    ): Promise<EventApiCallRes>;
+    createEventWithFileFromBuffer(
+      params: EventFileCreationParams,
+      bufferData: string | Buffer,
+      filename: string,
+    ): Promise<EventApiCallRes>;
+    addPointsToHFEvent(
+      id: Identifier,
+      fields: string[],
+      values: Array<string | number>,
+    ): Promise<void>;
+    accessInfo(): Promise<AccessInfo>;
+    post(
+      path: string,
+      data: Object | any[],
+      queryParams: Object,
+    ): Promise<Object | Object[]>;
+    get(path: string, queryParams: Object): Promise<Object | Object[]>;
+  }
+  export type serviceCustomizations = {
+    name?: string;
+    assets?: {
+      definitions?: string;
+    };
+  };
+  export type PryvServiceInfo = {
+    register: string;
+    access: string;
+    api: string;
+    name: string;
+    home: string;
+    support: string;
+    terms: string;
+    eventTypes: string;
+    version: string;
+  };
+  export type AssetsConfig = {
+    baseUrl: string;
+    href: string;
+    favicon: {
+      [key: string]: string;
+      default: string;
+    };
+    css: {
+      [key: string]: string;
+      default: string;
+    };
+    'lib-js': {
+      [key: string]: KeyValue | any;
+    };
+    [key: string]: any;
+  };
+  export interface Service {
+    new (
+      serviceInfoUrl: string,
+      serviceCustomizations?: serviceCustomizations,
+    ): Service;
+    info(forceFetch?: boolean): Promise<PryvServiceInfo>;
+    setServiceInfo(serviceInfo: Partial<PryvServiceInfo>): Promise<void>;
+    assets(forceFetch?: boolean): Promise<AssetsConfig>;
+    infoSync(): PryvServiceInfo | null;
+    apiEndpointFor(username: string, token: string): Promise<string>;
+    login(
+      username: string,
+      password: string,
+      appId: string,
+      originHeader?: string,
+    ): Promise<Connection>;
+  }
+  export type AuthRequestedPermission = {
+    streamId: Identifier;
+    defaultName: string;
+    level: Level;
+  };
+  export type States =
+    | 'LOADING'
+    | 'INITIALIZED'
+    | 'NEED_SIGNIN'
+    | 'ACCEPTED'
+    | 'SIGNOUT';
+  type ServiceInfo = {
+    access: string;
+    api: string;
+    assets: {
+      definitions: string;
+    };
+    eventTypes: string;
+    home: string;
+    name: string;
+    register: string;
+    serial: string;
+    support: string;
+    terms: string;
+    version: string;
+  };
+  type StateChangeTypes = {
+    LOADING: {};
+    INITIALIZED: {
+      serviceInfo: ServiceInfo;
+    };
+    NEED_SIGNIN: {
+      authUrl: string;
+      clientData: any;
+      code: number;
+      key: string;
+      lang: string;
+      oauthState: any;
+      poll: string;
+      poll_rate_ms: number;
+      requestedPermissions: Array<{
+        streamId: string;
+        level: Level;
+        defaultName: string;
+      }>;
+      requestingAppId: string;
+      returnUrl: any;
+      serviceInfo: ServiceInfo;
+    };
+    ACCEPTED: {
+      serviceInfo: ServiceInfo;
+      apiEndpoint: string;
+      username: string;
+      token: string;
+    };
+    SIGNOUT: {};
+  };
+  export type StateChange<K extends States> = StateChangeTypes[K] & {
+    id: K;
+    status: K;
+  };
+  export type AuthSettings = {
+    spanButtonID?: string;
+    onStateChange?: (state: StateChange<States>) => void;
+    returnURL?: string;
+    authRequest: {
+      requestingAppId: string;
+      languageCode?: string;
+      requestedPermissions: AuthRequestedPermission[];
+      returnUrl?: string | boolean;
+      referer?: string;
+      clientData?: Object;
+    };
+  };
+  type SetupAuth = (
+    settings: AuthSettings,
+    serviceInfoUrl: string,
+    serviceCustomizations?: serviceCustomizations,
+    humanInteraction?: any,
+  ) => Promise<Service>;
+  export type AuthStates = {
+    ERROR: 'ERROR';
+    LOADING: 'LOADING';
+    INITIALIZED: 'INITIALIZED';
+    NEED_SIGNIN: 'NEED_SIGNIN';
+    AUTHORIZED: 'ACCEPTED';
+    SIGNOUT: 'SIGNOUT';
+    REFUSED: 'REFUSED';
+  };
+  type AuthStatePayload = {
+    status: AuthStates[keyof AuthStates];
+    message?: string;
+  };
+  export interface CustomLoginButton {
+    init?: () => Promise<void>;
+    getAuthorizationData(): string;
+    onStateChange(state: AuthStatePayload): Promise<void>;
+    onClick(): void;
+    saveAuthorizationData?: (authData: string) => void;
+    deleteAuthorizationData?: () => Promise<void>;
+  }
+  export interface AuthController {
+    new (
+      authSettings: AuthSettings,
+      service: Service,
+      loginButton: CustomLoginButton,
+    ): AuthController;
+    init(): Promise<void>;
+    stopAuthRequest(msg: string): void;
+    handleClick(): Promise<void>;
+    getReturnURL(
+      returnURL: string,
+      windowLocationForTest: string,
+      navigatorForTests: string,
+    ): string | boolean;
+    startAuthRequest(): Promise<any>;
+    doPolling(): Promise<void>;
+    set state(newState: AuthStatePayload);
+    get state(): AuthStatePayload;
+  }
+  export interface Auth {
+    setupAuth: SetupAuth;
+    AuthStates: AuthStates;
+    AuthController: AuthController;
+  }
+  export interface CookieUtils {
+    set(cookieKey: string, value: any, expireInDays: number): void;
+    get(cookieKey: string): any;
+    del(cookieKey: string): void;
+  }
+  type getServiceInfoFromURL = (url: string) => string;
+  export interface Browser {
+    LoginButton: CustomLoginButton;
+    CookieUtils: CookieUtils;
+    AuthStates: AuthStates;
+    setupAuth: SetupAuth;
+    serviceInfoFromUrl: getServiceInfoFromURL;
+  }
+  type TokenAndApiEndpoint = {
+    endpoint: string;
+    token: string;
+  };
+  export interface utils {
+    isBrowser(): boolean;
+    extractTokenAndApiEndpoint(pryvApiEndpoint: string): TokenAndApiEndpoint;
+    buildPryvApiEndpoint(tokenAndApi: TokenAndApiEndpoint): string;
+    browserIsMobileOrTablet(navigator: string): boolean;
+    cleanURLFromPrYvParams(url: string): string;
+    getQueryParamsFromURL(url: string): KeyValue;
+  }
+  type version = string;
+  let Pryv: {
+    Service: Service;
+    Connection: Connection;
+    Auth: Auth;
+    Browser: Browser;
+    utils: utils;
+    version: version;
+  };
+  export default Pryv;
+}

package/test/Connection.test.js CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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/webpack.config.js CHANGED Viewed

@@ -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,
+      },
+    }
 	}
 ];