pryv 3.14.2 → 3.15.0

package/README.md

@@ -131,6 +131,13 @@ Here is an implementation of the [Pryv.io authentication process](https://api.pr
           optIn: ['location']      // offered UNticked; the user opts in
           // a permission in neither list is optional and shown pre-selected
         },
+        // optional (core 2.0.0-rc.32+): cross-account messaging invites the
+        // user answers in the same sign-in (1 to 8). The ACCEPTED state then
+        // carries `cmcInvites`, one outcome per invite ({ acceptEventId, ... },
+        // { declined: true } or { reason }), a hint: the requester learns the
+        // truth from its own inbox. Declining a mandatory one refuses the sign-in
+        // (REFUSED, reasonId 'REFUSED_MANDATORY_CONSENT'). Ignored by older cores.
+        // cmcInvites: [{ capabilityUrl: invite.capabilityUrl, mandatory: true }],
         clientData: {
           'app-web-auth:description': {
             'type': 'note/txt', 'content': 'This is a consent message.'

package/package.json

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

package/src/Service.js

@@ -524,6 +524,8 @@ class Service {
     // all-or-nothing, which a caller may want to know before showing the
     // approve link.
     if (body.consent != null) envelope.consent = body.consent;
+    // Same for consent invites: echoed only by a core that understood them.
+    if (body.cmcInvites != null) envelope.cmcInvites = body.cmcInvites;
     // polling by key (pollAccessRequest, connectFromKey) then reaches the
     // core that holds the request
     pollUrls.remember(envelope.key, envelope.poll);

package/src/index.d.ts

@@ -891,6 +891,8 @@ declare module 'pryv' {
       pollRateMs: number;
       /** Echoed only by a core that understood `authRequest.consent`. */
       consent?: AuthRequestConsentForm;
+      /** Echoed only by a core that understood `authRequest.cmcInvites`. */
+      cmcInvites?: AuthCmcInvite[];
     }>;
     /**
      * Poll an access request once, by its full poll URL (recommended) or its
@@ -982,6 +984,35 @@ declare module 'pryv' {
     >;
   };
 
+  /**
+   * A cross-account messaging invite the user is asked to answer in the same
+   * authorisation request (`authRequest.cmcInvites`): the capability URL the
+   * app received, whether declining it refuses the whole request, and for
+   * which account it is accepted (`'target'`: the account the access is
+   * granted for, when the user acts for an account it manages).
+   */
+  export type AuthRequestCmcInvite = {
+    capabilityUrl: string;
+    mandatory?: boolean;
+    for?: 'self' | 'target';
+  };
+
+  /** An invite as the core echoes it back, with its defaults filled in. */
+  export type AuthCmcInvite = {
+    capabilityUrl: string;
+    mandatory: boolean;
+    for: 'self' | 'target';
+  };
+
+  /**
+   * What the auth page did with one invite, in the ACCEPTED body (one per
+   * invite, in order). A hint: the requester learns the truth from its inbox.
+   */
+  export type AuthCmcInviteOutcome =
+    | { acceptEventId: string; dataGrantAccessId?: string; acceptedFor?: 'self' }
+    | { declined: true }
+    | { reason: string };
+
   export type States =
     | 'ERROR'
     | 'LOADING'
@@ -1025,6 +1056,8 @@ declare module 'pryv' {
         defaultName: string;
       }>;
       consent?: AuthRequestConsentForm;
+      /** Present only when the request carried `cmcInvites` the core understood. */
+      cmcInvites?: AuthCmcInvite[];
       requestingAppId: string;
       returnURL?: string | null;
       serviceInfo?: ServiceInfo;
@@ -1055,6 +1088,8 @@ declare module 'pryv' {
       profile?: AuthProfile;
       /** One-time credential hand-off key (shared-secret delivery), in place of `token`. */
       handoff?: { type: 'shared-secret'; key: string };
+      /** What the auth page did with each invite of the request (a hint). */
+      cmcInvites?: AuthCmcInviteOutcome[];
     };
     SIGNOUT: {};
     SWITCHING: {
@@ -1089,6 +1124,7 @@ declare module 'pryv' {
     requestingAppId: string;
     requestedPermissions: AuthRequestedPermission[];
     consent?: AuthRequestConsentForm;
+    cmcInvites?: AuthCmcInvite[];
     lang?: string;
     returnURL?: string;
     clientData?: KeyValue;
@@ -1125,6 +1161,13 @@ declare module 'pryv' {
       languageCode?: string;
       requestedPermissions: AuthRequestedPermission[];
       consent?: AuthRequestConsent;
+      /**
+       * Cross-account messaging invites the user answers in the same
+       * sign-in (1 to 8). The ACCEPTED state carries one outcome per invite;
+       * a declined mandatory invite ends the request REFUSED with
+       * `reasonId: 'REFUSED_MANDATORY_CONSENT'`. An older core ignores the field.
+       */
+      cmcInvites?: AuthRequestCmcInvite[];
       /**
        * Where the sign-in happens: `'auto#'` (default, also when unset or
        * `false`) opens a popup on desktop and redirects on a phone or tablet;

package/src/lib/MfaRequiredError.js

@@ -41,6 +41,8 @@ class MfaRequiredError extends PryvError {
     this.id = (apiErr && apiErr.id) || 'mfa-required';
     this.status = response && response.status;
     this.response = { body, status: response && response.status };
+    // Read by name, but not printed with the error (like `innerObject`).
+    Object.defineProperty(this, 'mfaToken', { enumerable: false });
 
     if (Error.captureStackTrace) {
       Error.captureStackTrace(this, MfaRequiredError);

package/src/lib/PryvError.js

@@ -35,6 +35,10 @@ class PryvError extends Error {
     this.status = undefined;
     /** @type {{ body: any, status: number }|undefined} Raw response */
     this.response = undefined;
+    // `innerObject` and `response` hold raw platform answers: still readable and
+    // writable, but not enumerable, so `console.log(err)` does not print them.
+    Object.defineProperty(this, 'innerObject', { enumerable: false });
+    Object.defineProperty(this, 'response', { enumerable: false });
 
     if (Error.captureStackTrace) {
       Error.captureStackTrace(this, PryvError);

package/test/PryvError.test.js

@@ -71,4 +71,14 @@ describe('[PERX] PryvError', function () {
     expect(error.status).to.equal(502);
     expect(error.response).to.deep.equal({ body: undefined, status: 502 });
   });
+
+  it('[PERJ] innerObject and response are readable but not enumerable (not printed with the error)', function () {
+    const error = new PryvError('Outer', { id: 'invalid-access-token', secret: 'tok' });
+    error.response = { body: { secret: 'tok' }, status: 401 };
+    expect(error.innerObject.id).to.equal('invalid-access-token');
+    expect(error.response.status).to.equal(401);
+    expect(Object.keys(error)).to.not.include('innerObject');
+    expect(Object.keys(error)).to.not.include('response');
+    expect(require('util').inspect(error)).to.not.include('tok');
+  });
 });

package/test/Service.accessRequestConsent.test.js

@@ -108,4 +108,20 @@ describe('[ARQC] auth-request consent sidecar', function () {
     expect(envOld.key).to.equal('k2');
     expect(envOld).to.not.have.property('consent');
   });
+
+  it('[LCI3] posts cmcInvites verbatim and returns the echo a core sends, nothing when it does not', async function () {
+    const invites = [{ capabilityUrl: 'https://cap@doctor.test.local/', mandatory: true }];
+    const echo = [{ capabilityUrl: 'https://cap@doctor.test.local/', mandatory: true, for: 'self' }];
+    stubFetch({ key: 'k3', authUrl: 'https://auth/', poll: 'https://poll/k3', poll_rate_ms: 1000, cmcInvites: echo });
+    const service = new pryv.Service('https://reg.test.local/service/info');
+    const env = await service.startAccessRequest({ ...REQUEST, cmcInvites: invites });
+    expect(posted[0].cmcInvites).to.deep.equal(invites);
+    expect(env.cmcInvites).to.deep.equal(echo);
+    if (realFetch) { global.fetch = realFetch; realFetch = null; }
+
+    stubFetch({ key: 'k4', authUrl: 'https://auth/', poll: 'https://poll/k4', poll_rate_ms: 1000 });
+    const older = new pryv.Service('https://reg.test.local/service/info');
+    const envOld = await older.startAccessRequest({ ...REQUEST, cmcInvites: invites });
+    expect(envOld).to.not.have.property('cmcInvites');
+  });
 });

package/test/Service.mfa.test.js

@@ -115,5 +115,18 @@ describe('[MFLX] Service MFA', function () {
       );
       expect(err.method).to.equal(undefined);
     });
+
+    it('[MFEE] mfaToken and the raw response are readable but not printed with the error', function () {
+      const err = new pryv.MfaRequiredError(
+        'tok-secret-4',
+        { status: 200 },
+        { mfaToken: 'tok-secret-4' }
+      );
+      expect(err.mfaToken).to.equal('tok-secret-4');
+      expect(err.response.body.mfaToken).to.equal('tok-secret-4');
+      expect(Object.keys(err)).to.not.include('mfaToken');
+      expect(Object.keys(err)).to.not.include('response');
+      expect(require('util').inspect(err)).to.not.include('tok-secret-4');
+    });
   });
 });