Adding permission buiilding to request

Author: perki

docs/hds-lib.js

@@ -5,6 +5,7 @@ import type { localizableText, localizableTextLanguages } from '../../types/loca
 
 
 declare type PermissionItem = {streamId: string, defaultName: string, level: string};
+declare type PermissionItemLight = {streamId: string, defaultName?: string, level?: string};
 
 const CURRENT_VERSION = 1;
 
@@ -25,6 +26,7 @@ export class CollectorRequest {
   #consent: localizableText;
   #requester: {name: string};
   #app: {id: string, url: string | null, data: any};
+  #permissionsExtra: Array<PermissionItemLight>;
   #permissions: Array<PermissionItem>;
   #sections: Array<CollectorRequestSection>;
 
@@ -34,6 +36,7 @@ export class CollectorRequest {
     this.#requester = { name: null };
     this.#app = { id: null, url: null, data: {} };
     this.#permissions = [];
+    this.#permissionsExtra = [];
     this.#sections = [];
     this.setContent(content);
   }
@@ -47,8 +50,6 @@ export class CollectorRequest {
     this.setContent(inviteEvent.content);
   }
 
-
-
   /**
    * Loadfrom status event from Collector
    * used by Collector only
@@ -106,22 +107,33 @@ export class CollectorRequest {
 
     // -- sections
     if (futureContent.sections != null) {
+      this.#sections = []; // reset sections
       for (const sectionData of futureContent.sections) {
-        const section = new CollectorRequestSection(sectionData.key, sectionData.type);
+        const section = this.createSection(sectionData.key, sectionData.type);
         section.setName(sectionData.name);
         section.addItemKeys(sectionData.itemKeys);
-        this.#sections.push(section);
       }
+      delete futureContent.sections;
     }
 
     // -- permissions
     if (futureContent.permissions) {
       this.#permissions = []; // reset permissions
       futureContent.permissions.forEach((p: PermissionItem)=> {
-        this.addPermissions(p.streamId, p.defaultName, p.level);
+        this.addPermission(p.streamId, p.defaultName, p.level);
       });
       delete futureContent.permissions;
     }
+
+    // -- permissionsExtra
+    if (futureContent.permissionsExtra) {
+      this.#permissionsExtra = []; // reset permissions Extra
+      futureContent.permissionsExtra.forEach((p: PermissionItem)=> {
+        this.addPermissionExtra(p);
+      });
+      delete futureContent.permissionsExtra;
+    }
+
     this.#extraContent = futureContent;
   }
 
@@ -152,6 +164,7 @@ export class CollectorRequest {
   get appCustomData() { return this.#app.data; }
 
   get permissions() { return this.#permissions; }
+  get permissionsExtra() { return this.#permissionsExtra; }
 
   // --- section --- //
 
@@ -162,20 +175,67 @@ export class CollectorRequest {
   get sectionsData () {
     const result = [];
     for (const section of this.#sections) {
-      result.push(section.getData());
+      const data = section.getData();
+      result.push(data);
     }
     return result;
   }
 
+  createSection (key: string, type: RequestSectionType) {
+    if (this.getSectionByKey(key) != null) throw new HDSLibError(`Section with key: ${key} already exists`)
+    const section = new CollectorRequestSection(key, type);
+    this.#sections.push(section);
+    return section;
+  }
+
   getSectionByKey (key: string) {
     return this.#sections.find((s) => (s.key === key));
   }
 
   // ---------- permissions ---------- //
-  addPermissions (streamId: string, defaultName: string, level: string) {
+  addPermissions (permissions: Array<{streamId: string, defaultName: string, level: string}>) {
+    for (const permission of permissions) {
+      this.addPermission(permission.streamId, permission.defaultName, permission.level);
+    }
+  }
+
+  addPermission (streamId: string, defaultName: string, level: string) {
     this.#permissions.push({streamId, defaultName, level});
   }
 
+  /**
+   * Add a static permission, not linked to itemKeys for other usages
+   * @param permission 
+   */
+  addPermissionExtra (permission: PermissionItemLight) {
+    // todo standard checks
+    this.#permissionsExtra.push(permission);
+  }
+
+  /**
+   * Reset permissions
+   */
+  resetPermissions() {
+    this.#permissions.splice(0, this.#permissions.length);
+  }
+
+  /**
+   * Rebuild permissions based on sections itemKeys and staticPermissions
+   */
+  buildPermissions () {
+    // 1- get all items form the questionnary sections
+    const itemKeys = [];
+    for (const section of this.sections) {
+      itemKeys.push(...section.itemKeys);
+    }
+    // 2 - get the permissions with eventual preRequest 
+    const preRequest = this.permissionsExtra || [];
+    const permissions = getModel().authorizations.forItemKeys(itemKeys, { preRequest });
+    // 3 - if no error araised - reset permissions
+    this.resetPermissions();
+    this.addPermissions(permissions);
+  }
+
   // ---------- sections ------------- //
 
   /**
@@ -190,6 +250,7 @@ export class CollectorRequest {
       requester: {
         name: this.requesterName
       },
+      permissionsExtra: this.permissionsExtra,
       permissions: this.permissions,
       app: {
         id: this.appId,

docs/hds-lib.js.map

@@ -1,12 +1,13 @@
 /* eslint-env mocha */
 const { assert } = require('./test-utils/deps-node');
-const { createUserAndPermissions, pryv, createUser, createUserPermissions } = require('./test-utils/pryvService');
+const { pryv, createUserPermissions } = require('./test-utils/pryvService');
 const AppManagingAccount = require('../src/appTemplates/AppManagingAccount');
 const AppClientAccount = require('../src/appTemplates/AppClientAccount');
 const Collector = require('../src/appTemplates/Collector');
 const CollectorClient = require('../src/appTemplates/CollectorClient');
 const { HDSLibError } = require('../src/errors');
 const { initHDSModel } = require('../src/index.js');
+const { helperNewAppAndUsers, helperNewInvite, helperNewAppManaging } = require('./test-utils/helpersAppTemplate.js');
 
 describe('[APTX] appTemplates', function () {
   this.timeout(10000);
@@ -512,80 +513,3 @@ describe('[APTX] appTemplates', function () {
     });
   });
 });
-
-/**
- * function helperNewAppManaging
- */
-async function helperNewAppManaging (baseStreamIdManager, appName, managingUser = null) {
-  // -- managing
-  const initialStreams = [{ id: 'applications', name: 'Applications' }, { id: baseStreamIdManager, name: appName, parentId: 'applications' }];
-  const permissionsManager = [{ streamId: baseStreamIdManager, level: 'manage' }];
-  if (!managingUser) {
-    managingUser = await createUserAndPermissions(null, permissionsManager, initialStreams, appName);
-  } else {
-    // replace managing user with new permissions set
-    managingUser = await createUserPermissions(managingUser, permissionsManager, initialStreams, appName);
-  }
-  const connection = new pryv.Connection(managingUser.appApiEndpoint);
-  const appManaging = await AppManagingAccount.newFromConnection(baseStreamIdManager, connection);
-  return { managingUser, appManaging };
-}
-
-/**
- * helper to generate a new managing user and new client user
- */
-async function helperNewAppClient (baseStreamIdClient, appClientName) {
-  // -- receiving user
-  const clientUser = await createUser();
-  const permissionsClient = [{ streamId: '*', level: 'manage' }];
-  const clientUserResultPermissions = await createUserPermissions(clientUser, permissionsClient, [], appClientName);
-  const appClient = await AppClientAccount.newFromApiEndpoint(baseStreamIdClient, clientUserResultPermissions.appApiEndpoint, appClientName);
-  return { clientUser, clientUserResultPermissions, appClient };
-}
-
-/**
- * helper to generate a new managing user and new client user
- */
-async function helperNewAppAndUsers (baseStreamIdManager, appName, baseStreamIdClient, appClientName) {
-  const res = {};
-  const resManager = await helperNewAppManaging(baseStreamIdManager, appName);
-  const resClient = await helperNewAppClient(baseStreamIdClient, appClientName);
-  Object.assign(res, resManager);
-  Object.assign(res, resClient);
-  return res;
-}
-
-/**
- * heper to generate a new collector and invite for this managing application
- * @param {AppManagingAccount} appManaging
- * @returns {Object}
- */
-async function helperNewInvite (appManaging, appClient, code) {
-  code = code || Math.floor(Math.random() * 1000);
-  const collector = await appManaging.createCollector('Invite test ' + code);
-
-  // set request content
-  const requestContent = {
-    version: 0,
-    requester: { name: 'Test requester name' },
-    title: { en: 'Title of the request' },
-    description: { en: 'Short Description' },
-    consent: { en: 'This is a consent message' },
-    permissions: [{ streamId: 'profile-name', defaultName: 'Name', level: 'read' }],
-    app: { id: 'test-app', url: 'https://xxx.yyy', data: { } }
-  };
-  collector.request.setContent(requestContent);
-
-  await collector.save();
-  await collector.publish();
-  // create invite
-  const options = { customData: { hello: 'bob' } };
-  const invite = await collector.createInvite('Invite One', options);
-  const inviteSharingData = await invite.getSharingData();
-  assert.equal(inviteSharingData.apiEndpoint, await collector.sharingApiEndpoint());
-
-  // Invitee receives the invite
-  const collectorClient = await appClient.handleIncomingRequest(inviteSharingData.apiEndpoint, inviteSharingData.eventId);
-
-  return { collector, invite, collectorClient, inviteSharingData };
-}

docs/tests-browser.js

@@ -0,0 +1,100 @@
+/* eslint-env mocha */
+
+const { initHDSModel } = require('../src');
+const { helperNewAppManaging } = require('./test-utils/helpersAppTemplate');
+const { assert } = require('./test-utils/deps-node');
+
+describe('[APRX] appTemplates Requests', function () {
+  before(async () => {
+    await initHDSModel();
+  });
+  it('[APRC] Compute a simple request', async () => {
+    const baseStreamId = 'aprc';
+    const { appManaging } = await helperNewAppManaging(baseStreamId, 'test-APRC');
+    const newCollector = await appManaging.createCollector('Invite test APCV');
+
+    const request = newCollector.request;
+    request.appId = 'dr-form';
+    request.appUrl = 'https://xxx.yyy';
+    request.title = { en: 'My title' };
+    request.requesterName = 'Username APRC';
+    request.description = { en: 'Short Description' };
+    request.consent = { en: 'Short Consent' };
+    request.addPermissionExtra({ streamId: 'profile' });
+    request.addPermissionExtra({ streamId: 'fertility' });
+
+    const sectionA = request.createSection('profile', 'permanent');
+    sectionA.setNameLocal('en', 'A');
+    sectionA.addItemKeys([
+      'profile-name',
+      'profile-surname',
+      'profile-sex',
+      'family-children-count',
+      'fertility-miscarriages-count'
+    ]);
+
+    const sectionB = request.createSection('history', 'recurring');
+    sectionB.setNameLocal('en', 'B');
+    sectionB.addItemKeys([
+      'fertility-ttc-tta',
+      'body-weight'
+    ]);
+    // build permissions needed
+    request.buildPermissions();
+    const requestContent = request.content;
+    assert.ok(requestContent.id.startsWith(baseStreamId), 'id should start with the basetreamid of the manager');
+
+    const expectedContent = {
+      version: 1,
+      title: { en: 'My title' },
+      consent: { en: 'Short Consent' },
+      description: { en: 'Short Description' },
+      requester: { name: 'Username APRC' },
+      permissionsExtra: [
+        { streamId: 'profile', defaultName: 'Profile', level: 'read' },
+        {
+          streamId: 'fertility',
+          defaultName: 'Fertility',
+          level: 'read'
+        }
+      ],
+      permissions: [
+        { streamId: 'profile', defaultName: 'Profile', level: 'read' },
+        { streamId: 'fertility', defaultName: 'Fertility', level: 'read' },
+        {
+          streamId: 'family-children',
+          defaultName: 'Children',
+          level: 'read'
+        },
+        {
+          streamId: 'body-weight',
+          defaultName: 'Body Weight',
+          level: 'read'
+        }
+      ],
+      app: { id: 'dr-form', url: 'https://xxx.yyy', data: {} },
+      sections: [
+        {
+          key: 'profile',
+          type: 'permanent',
+          name: { en: 'A' },
+          itemKeys: [
+            'profile-name',
+            'profile-surname',
+            'profile-sex',
+            'family-children-count',
+            'fertility-miscarriages-count'
+          ]
+        },
+        {
+          key: 'history',
+          type: 'recurring',
+          name: { en: 'B' },
+          itemKeys: ['fertility-ttc-tta', 'body-weight']
+        }
+      ],
+      id: requestContent.id
+    };
+    assert.deepEqual(requestContent, expectedContent);
+  });
+});