pryv 3.10.0 → 3.11.0

package/package.json

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

package/src/SharedSecrets.js

@@ -86,11 +86,12 @@ async function hmacSha256Hex (verifierSecret, message) {
  * @param {number} params.ttl seconds the secret stays redeemable (required)
  * @param {string} params.title shown to the account owner (required)
  * @param {Object} params.onConsumed `{ message, returnUrl? }` shown once spent
- * @param {*} params.secret the payload — any JSON value
+ * @param {*} params.secret the payload: any non-null JSON value (the server
+ *   refuses `null` and `undefined` with `shared-secret-missing-secret`)
  * @param {Object} [params.signature] `{ type: 'secret', value }` or
  *   `{ type: 'hmac-sha256', verifierSecret }`. For the HMAC form the key
  *   material is generated here so the proof can be bound before creation.
- * @returns {Promise<Object>} `{ id, key, expires, ... }` — `key` is returned
+ * @returns {Promise<Object>} `{ id, key, expires, ... }`; `key` is returned
  *   only here and cannot be recovered later.
  */
 async function create (connection, params) {

package/src/index.d.ts

@@ -172,12 +172,14 @@ declare module 'pryv' {
    * Thrown by `Service.login` when the platform returned `{ mfaToken }`
    * instead of `{ token }`. Carries the `mfaToken` so the consumer can
    * call `Service.mfaVerify(userId, err.mfaToken, code)` after prompting
-   * the user for their SMS code.
+   * the user for their code. `method` (when present) says which factor to
+   * prompt for: `'totp'` (authenticator app) or `'sms'`.
    */
   export class MfaRequiredError extends PryvError {
     constructor(mfaToken: string, response: Response, body?: any);
     name: 'MfaRequiredError';
     mfaToken: string;
+    method?: 'totp' | 'sms' | string;
   }
 
   /** Catalogue of Pryv API error ids (mirrors open-pryv.io ErrorIds.js). */

package/src/lib/MfaRequiredError.js

@@ -8,7 +8,10 @@ const PryvError = require('./PryvError');
 /**
  * Thrown by `Service.login` when the platform replied with `{ mfaToken }`
  * instead of `{ token }`. Consumers catch this, prompt the user for the
- * SMS code, then call `Service.mfaVerify(userId, err.mfaToken, code)`.
+ * code, then call `Service.mfaVerify(userId, err.mfaToken, code)`.
+ *
+ * `err.method` (when present) tells the app which factor to prompt for:
+ * `'totp'` (an authenticator-app code) or `'sms'` (a code sent by SMS).
  *
  *   try { conn = await service.login(u, p, app) }
  *   catch (err) {
@@ -33,6 +36,8 @@ class MfaRequiredError extends PryvError {
     this.name = 'MfaRequiredError';
     /** @type {string} */
     this.mfaToken = mfaToken;
+    /** @type {string|undefined} The MFA method to prompt for: 'totp' | 'sms'. */
+    this.method = body && body.mfaMethod;
     this.id = (apiErr && apiErr.id) || 'mfa-required';
     this.status = response && response.status;
     this.response = { body, status: response && response.status };

package/test/Service.mfa.test.js

@@ -90,5 +90,30 @@ describe('[MFLX] Service MFA', function () {
       expect(err.id).to.equal('custom-id');
       expect(err.message).to.equal('custom msg');
     });
+
+    it('[MERC] surfaces the MFA method from the API body when present', function () {
+      const totp = new pryv.MfaRequiredError(
+        'tok-1',
+        { status: 200 },
+        { mfaToken: 'tok-1', mfaMethod: 'totp' }
+      );
+      expect(totp.method).to.equal('totp');
+
+      const sms = new pryv.MfaRequiredError(
+        'tok-2',
+        { status: 200 },
+        { mfaToken: 'tok-2', mfaMethod: 'sms' }
+      );
+      expect(sms.method).to.equal('sms');
+    });
+
+    it('[MERD] leaves method undefined when the body omits it (older servers)', function () {
+      const err = new pryv.MfaRequiredError(
+        'tok-3',
+        { status: 200 },
+        { mfaToken: 'tok-3' }
+      );
+      expect(err.method).to.equal(undefined);
+    });
   });
 });

package/test/Service.test.js

@@ -82,8 +82,8 @@ describe('[SERX] Service', function () {
         if (isDnsLess) {
           expect(error.message).to.include('Unknown user');
         } else {
-          // fetch throws 'fetch failed'
-          expect(error.message).to.match(/Load failed|fetch failed|getaddrinfo ENOTFOUND|Request has been terminated/);
+          // fetch error message differs per environment (Chrome says 'Failed to fetch')
+          expect(error.message).to.match(/Load failed|fetch failed|Failed to fetch|getaddrinfo ENOTFOUND|Request has been terminated/);
         }
         return;
       }

package/test/SharedSecrets.test.js

@@ -89,7 +89,10 @@ describe('[SSEC] shared-secrets helper', function () {
     const seen = new Set();
     for (let i = 0; i < 50; i++) {
       const out = await SharedSecrets.create(conn, {
-        ttl: 60, title: 't', onConsumed: { message: 'm' }, secret: 1,
+        ttl: 60,
+        title: 't',
+        onConsumed: { message: 'm' },
+        secret: 1,
         signature: { type: 'hmac-sha256', verifierSecret: 'V' }
       });
       const { randomPart } = SharedSecrets.parseKey(out.key);

package/test/browser-index.html

@@ -2,17 +2,16 @@
 <html lang="en">
 <head>
   <title>Pryv JS lib browser tests</title>
-  <link rel="stylesheet" href="https://unpkg.com/mocha/mocha.css" />
+  <link rel="stylesheet" href="https://unpkg.com/mocha@10.8.2/mocha.css" />
 </head>
 
 <body>
   <div id="mocha"></div>
   <script src="https://unpkg.com/chai@4.3.7/chai.js"></script>
-  <script src="https://unpkg.com/mocha/mocha.js"></script>
+  <script src="https://unpkg.com/mocha@10.8.2/mocha.js"></script>
 
   <script class="mocha-init">
     mocha.setup('bdd');
-    mocha.setup({ignoreLeaks: true}); 
   </script>
 
   <!-- Files cf. webpack config -->