pryv 3.6.0 → 3.7.0

package/README.md

@@ -733,7 +733,15 @@ Assuming browser files are built and everything is up-to-date, including the REA
 ```
 just version <version>
 ```
-to update the version number of the lib and add-ons in lockstep, git commit and tag included
+to update the version number of the lib and add-ons in lockstep. This only edits the `package.json` files — **commit and tag manually**:
+
+```
+git commit -am "<version>"
+git tag -a <version> -m "<version>"
+git push && git push --tags
+```
+
+Tags are bare version numbers (e.g. `3.6.0`, no `v` prefix); every npm publish must have a matching pushed tag so npm, `package.json` and GitHub stay cross-checkable.
 
 ```
 just publish-npm

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pryv",
-  "version": "3.6.0",
+  "version": "3.7.0",
   "description": "Pryv JavaScript library",
   "keywords": [
     "Pryv",

package/src/Browser/LoginButton.js

@@ -126,6 +126,11 @@ class LoginButton {
           error: e
         };
       }
+      // The prYv* params are one-shot; leaving them in the visible URL
+      // puts stale auth state into bookmarks / copied links.
+      if (window.history && typeof window.history.replaceState === 'function') {
+        window.history.replaceState(null, '', utils.cleanURLFromPrYvParams(url));
+      }
     }
 
     function retrievePollUrl (url) {

package/src/Service.js

@@ -406,9 +406,9 @@ class Service {
         email: opts.email,
         hosting,
         language,
-        invitationToken
+        invitationToken,
+        ...(opts.referer != null && { referer: opts.referer })
       };
-      if (opts.referer != null) payload.referer = opts.referer;
     } else {
       url = serviceInfo.register + 'user';
       payload = {
@@ -418,9 +418,9 @@ class Service {
         email: opts.email,
         hosting,
         languageCode: language,
-        invitationtoken: invitationToken
+        invitationtoken: invitationToken,
+        ...(opts.referer != null && { referer: opts.referer })
       };
-      if (opts.referer != null) payload.referer = opts.referer;
     }
     const { response, body } = await utils.fetchPost(url, payload);
     if (!response.ok) throw PryvError.fromApiResponse(response, body);
@@ -629,6 +629,7 @@ const Connection = require('./Connection');
  * @property {string} support The email or URL of the support page.
  * @property {string} terms The terms and conditions, in plain text or the URL displaying them.
  * @property {string} eventTypes The URL of the list of validated event types.
+ * @property {string} [version] The platform version.
  * @property {Object} [assets] Holder for service specific Assets (icons, css, ...)
  * @property {string} [assets.definitions] URL to json object with assets definitions
  * @property {Object} [features] Platform feature flags

package/src/index.d.ts

@@ -100,20 +100,6 @@ declare module 'pryv' {
     };
   };
 
-  // HTTP only
-  type AuditLog = {
-    id: Identifier;
-    type: string;
-    time: Timestamp;
-    forwardedFor: string;
-    action: string;
-    query: string;
-    accessId: string;
-    status: number;
-    errorMessage?: string;
-    errorId?: string;
-  };
-
   export type HFSeries = {
     format: 'flatJSON';
     fields: string[];

package/src/lib/getEventStreamed.js

@@ -33,6 +33,7 @@ async function getEventStreamed (conn, queryParam, parser) {
   /**
    * Holds results from the parser
    */
+  /** @type {(Error & { rawResponse?: string }) | undefined} */
   let errResult;
   let bodyObjectResult;
   /**

package/test/LoginButton.urlCleanup.test.js

@@ -0,0 +1,44 @@
+/**
+ * @license
+ * [BSD-3-Clause](https://github.com/pryv/lib-js/blob/master/LICENSE)
+ */
+/* global describe, it, before, after, expect, JSDOM */
+
+const LoginButton = require('../src/Browser/LoginButton');
+const utils = require('../src/utils');
+
+describe('[LBRU] LoginButton URL cleanup after redirect', function () {
+  const PAGE_URL = 'http://localhost/app?x=1&prYvpoll=http%3A%2F%2Flocalhost%2Fpoll%2Fkey123&prYvstatus=ACCEPTED';
+  let dom;
+  let cleanupDom = false;
+  let originalFetchGet;
+
+  before(() => {
+    if (typeof document === 'undefined') {
+      cleanupDom = true;
+      dom = new JSDOM('<!DOCTYPE html><body></body>', { url: PAGE_URL });
+      global.document = dom.window.document;
+      global.window = dom.window;
+      global.location = dom.window.location;
+      global.navigator = { userAgent: 'Safari' };
+    }
+    originalFetchGet = utils.fetchGet;
+    utils.fetchGet = async () => ({ body: { status: 'ACCEPTED' } });
+  });
+
+  after(() => {
+    utils.fetchGet = originalFetchGet;
+    if (!cleanupDom) return;
+    delete global.document;
+    delete global.window;
+    delete global.location;
+    delete global.navigator;
+  });
+
+  it('[LBR1] strips consumed prYv* params from the visible URL', async () => {
+    const authController = { serviceInfo: {} };
+    await LoginButton.prototype.finishAuthProcessAfterRedirection.call({}, authController);
+    expect(authController.state).to.eql({ status: 'ACCEPTED' });
+    expect(global.window.location.href).to.equal('http://localhost/app?x=1');
+  });
+});