Introducing chat feature in request

Author: perki

js/appTemplates/CollectorRequest.d.ts

@@ -58,6 +58,11 @@ export declare class CollectorRequest {
     get appCustomData(): any;
     get permissions(): PermissionItem[];
     get permissionsExtra(): PermissionItemLight[];
+    get features(): {
+        chat?: {
+            type: "usernames" | "user";
+        };
+    };
     get sections(): Array<CollectorRequestSection>;
     get sectionsData(): any[];
     createSection(key: string, type: RequestSectionType): CollectorRequestSection;
@@ -81,6 +86,9 @@ export declare class CollectorRequest {
      * Rebuild permissions based on sections itemKeys and staticPermissions
      */
     buildPermissions(): void;
+    addChatFeature(settings?: {
+        type: 'usernames' | 'user';
+    }): void;
     /**
      * Return Content to comply with initial implementation as an object
      */
@@ -92,6 +100,11 @@ export declare class CollectorRequest {
         requester: {
             name: string;
         };
+        features: {
+            chat?: {
+                type: "usernames" | "user";
+            };
+        };
         permissionsExtra: PermissionItemLight[];
         permissions: PermissionItem[];
         app: {

js/appTemplates/CollectorRequest.d.ts.map

@@ -147,6 +147,7 @@ describe('[APTX] appTemplates', function () {
         consent: {
           en: 'This is a consent message'
         },
+        features: { },
         permissionsExtra: [],
         permissions: [
           { streamId: 'profile-name', defaultName: 'Name', level: 'read' },
@@ -379,6 +380,7 @@ describe('[APTX] appTemplates', function () {
         consent: {
           en: 'This is a consent message'
         },
+        features: { },
         permissions: [
           { streamId: 'profile-name', defaultName: 'Name', level: 'read' },
           {
@@ -421,6 +423,7 @@ describe('[APTX] appTemplates', function () {
         consent: {
           en: 'This is a consent message'
         },
+        features: { },
         permissionsExtra: [],
         permissions: [
           { streamId: 'profile-name', defaultName: 'Name', level: 'read' },
@@ -456,7 +459,8 @@ describe('[APTX] appTemplates', function () {
   });
 
   describe('[APEX] Errors ', () => {
-    it('[APEH] Collector.client handleIncoming Request Errors', async () => {
+    it('[APEH] Collector.client handleIncoming Request Errors', async function () {
+      this.timeout(20000);
       const new0 = await helperNewAppAndUsers('dummy', 'dummyApp', 'dummyC', 'dummyCApp');
       const inv0 = await helperNewInvite(new0.appManaging, new0.appClient, 'APEH');
 

js/appTemplates/CollectorRequest.js

@@ -5,6 +5,8 @@ const { helperNewAppManaging } = require('./test-utils/helpersAppTemplate');
 const { assert } = require('./test-utils/deps-node');
 
 describe('[APRX] appTemplates Requests', function () {
+  this.timeout(8000);
+
   before(async () => {
     await initHDSModel();
   });
@@ -50,6 +52,7 @@ describe('[APRX] appTemplates Requests', function () {
       consent: { en: 'Short Consent' },
       description: { en: 'Short Description' },
       requester: { name: 'Username APRC' },
+      features: {},
       permissionsExtra: [
         { streamId: 'profile', defaultName: 'Profile', level: 'read' },
         {
@@ -97,4 +100,56 @@ describe('[APRX] appTemplates Requests', function () {
     };
     assert.deepEqual(requestContent, expectedContent);
   });
+
+  it('[APRD] A request with chat', async () => {
+    const baseStreamId = 'aprd';
+    const { appManaging } = await helperNewAppManaging(baseStreamId, 'test-APRD');
+    const newCollector = await appManaging.createCollector('Invite test APRD');
+
+    const request = newCollector.request;
+    request.appId = 'dr-form';
+    request.appUrl = 'https://xxx.yyy';
+    request.title = { en: 'My title' };
+    request.requesterName = 'Username APRD';
+    request.description = { en: 'Short Description' };
+    request.consent = { en: 'Short Consent' };
+    request.addPermissionExtra({ streamId: 'profile' });
+    request.addChatFeature();
+
+    const sectionA = request.createSection('profile', 'permanent');
+    sectionA.setNameLocal('en', 'A');
+    sectionA.addItemKeys([
+      'profile-name',
+      'profile-surname'
+    ]);
+
+    // 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 APRD' },
+      features: { chat: { type: 'user' } },
+      permissionsExtra: [{ streamId: 'profile', defaultName: 'Profile', level: 'read' }],
+      permissions: [{ streamId: 'profile', defaultName: 'Profile', level: 'read' }],
+      app: { id: 'dr-form', url: 'https://xxx.yyy', data: {} },
+      sections: [
+        {
+          key: 'profile',
+          type: 'permanent',
+          name: { en: 'A' },
+          itemKeys: ['profile-name', 'profile-surname']
+        }
+      ],
+      id: requestContent.id
+    };
+    assert.deepEqual(requestContent, expectedContent);
+  });
 });

js/appTemplates/CollectorRequest.js.map

@@ -31,6 +31,7 @@ export class CollectorRequest {
   #permissionsExtra: Array<PermissionItemLight>;
   #permissions: Array<PermissionItem>;
   #sections: Array<CollectorRequestSection>;
+  #features: { chat?: { type: 'usernames' | 'user' } };
 
   #extraContent: any;
   constructor (content: any) {
@@ -40,6 +41,7 @@ export class CollectorRequest {
     this.#permissions = [];
     this.#permissionsExtra = [];
     this.#sections = [];
+    this.#features = {};
     this.setContent(content);
   }
 
@@ -135,6 +137,17 @@ export class CollectorRequest {
       });
       delete futureContent.permissionsExtra;
     }
+    // -- features
+    if (futureContent.features) {
+      if (futureContent.features.chat) {
+        this.addChatFeature(futureContent.features.chat);
+        delete futureContent.features.chat;
+      }
+      if (Object.keys(futureContent.features).length > 0) {
+        throw new HDSLibError('Found unkown features', futureContent.features);
+      }
+      delete futureContent.features;
+    }
 
     this.#extraContent = futureContent;
   }
@@ -167,6 +180,8 @@ export class CollectorRequest {
   get permissions () { return this.#permissions; }
   get permissionsExtra () { return this.#permissionsExtra; }
 
+  get features () { return this.#features; }
+
   // --- section --- //
 
   get sections (): Array<CollectorRequestSection> {
@@ -237,6 +252,12 @@ export class CollectorRequest {
     this.addPermissions(permissions);
   }
 
+  // ---------- features ------------- //
+  addChatFeature (settings: {type: 'usernames' | 'user'} = { type: 'user' }) {
+    if (!['user', 'usernames'].includes(settings.type)) throw new HDSLibError('Invalid chat type', settings);
+    this.#features.chat = settings;
+  }
+
   // ---------- sections ------------- //
 
   /**
@@ -251,6 +272,7 @@ export class CollectorRequest {
       requester: {
         name: this.requesterName
       },
+      features: this.features,
       permissionsExtra: this.permissionsExtra,
       permissions: this.permissions,
       app: {