add problem-report message type (#311)

* add problem-report message type

Author: volodymyr-basiuk

.eslintrc.js

@@ -10,7 +10,7 @@ module.exports = {
         ...spellcheckerRule,
         cspell: {
           ...cspellConfig,
-          ignoreWords: ['unmarshal', 'JUvpllMEYUZ2joO59UNui_XYDqxVqiFLLAJ8klWuPBw', 'gdwj', 'fwor', 'multichain', "ETHWEI", "ETHGWEI", "didcomm"]
+          ignoreWords: ['unmarshal', 'JUvpllMEYUZ2joO59UNui_XYDqxVqiFLLAJ8klWuPBw', 'gdwj', 'fwor', 'multichain', "ETHWEI", "ETHGWEI", "didcomm", "pthid"]
         }
       }
     ]

src/iden3comm/constants.ts

@@ -55,7 +55,9 @@ export const PROTOCOL_MESSAGE_TYPE = Object.freeze({
     `${DIDCOMM_PROTOCOL}discover-features/2.0/queries` as const,
   // DiscoveryProtocolDiscloseMessageType is type for didcomm discovery protocol disclose
   DISCOVERY_PROTOCOL_DISCLOSE_MESSAGE_TYPE:
-    `${DIDCOMM_PROTOCOL}discover-features/2.0/disclose` as const
+    `${DIDCOMM_PROTOCOL}discover-features/2.0/disclose` as const,
+  // ProblemReportMessageType is type for didcomm problem report
+  PROBLEM_REPORT_MESSAGE_TYPE: `${DIDCOMM_PROTOCOL}report-problem/2.0/problem-report` as const
 });
 
 /**

src/iden3comm/handlers/index.ts

@@ -8,3 +8,4 @@ export * from './credential-proposal';
 export * from './message-handler';
 export * from './payment';
 export * from './discovery-protocol';
+export * from './problem-report';

src/iden3comm/handlers/problem-report.ts

@@ -0,0 +1,41 @@
+import * as uuid from 'uuid';
+import { ProblemReportMessage } from '../types/protocol/problem-report';
+import { MediaType, PROTOCOL_MESSAGE_TYPE } from '../constants';
+
+/**
+ * @beta
+ * createProblemReportMessage is a function to create didcomm protocol problem report message
+ * @param pthid - parent thread id
+ * @param code - problem report code
+ * @param opts - problem report options
+ * @returns `ProblemReportMessage`
+ */
+export function createProblemReportMessage(
+  pthid: string,
+  code: string,
+  opts?: {
+    comment?: string;
+    ack?: string[];
+    args?: string[];
+    escalate_to?: string;
+    from?: string;
+    to?: string;
+  }
+): ProblemReportMessage {
+  const uuidv4 = uuid.v4();
+  return {
+    id: uuidv4,
+    pthid: pthid,
+    typ: MediaType.PlainMessage,
+    type: PROTOCOL_MESSAGE_TYPE.PROBLEM_REPORT_MESSAGE_TYPE,
+    ack: opts?.ack,
+    body: {
+      code: code,
+      comment: opts?.comment,
+      args: opts?.args,
+      escalate_to: opts?.escalate_to
+    },
+    from: opts?.from,
+    to: opts?.to
+  };
+}

src/iden3comm/types/index.ts

@@ -8,6 +8,7 @@ export * from './protocol/proposal-request';
 export * from './protocol/payment';
 export * from './protocol/accept-profile';
 export * from './protocol/discovery-protocol';
+export * from './protocol/problem-report';
 
 export * from './packer';
 export * from './models';

src/iden3comm/types/protocol/problem-report.ts

@@ -0,0 +1,18 @@
+import { PROTOCOL_MESSAGE_TYPE } from '../../constants';
+import { BasicMessage } from '../packer';
+
+/** ProblemReportMessage is struct for problem report message */
+export type ProblemReportMessage = BasicMessage & {
+  body: ProblemReportMessageBody;
+  pthid: string;
+  ack?: string[];
+  type: typeof PROTOCOL_MESSAGE_TYPE.PROBLEM_REPORT_MESSAGE_TYPE;
+};
+
+/** ProblemReportMessageBody is struct for problem report message body */
+export type ProblemReportMessageBody = {
+  code: string;
+  comment?: string;
+  args?: string[];
+  escalate_to?: string;
+};

tests/handlers/problem-report.test.ts

@@ -0,0 +1,43 @@
+import { describe } from 'mocha';
+import { createProblemReportMessage } from '../../src';
+import { expect } from 'chai';
+
+describe('Problem Report Handler', () => {
+  it('should create problem report', () => {
+    const example = `{
+        "typ": "application/iden3comm-plain-json",
+        "type": "https://didcomm.org/report-problem/2.0/problem-report",
+        "pthid": "5333207e-7338-4ab3-ac34-bf9a20dab6ab",
+        "ack": [
+            "23b610b3-aec8-4d1c-8a75-3b22e5483fb0",
+            "86fe7cc6-adcd-4530-8e07-92c060b427c8"
+        ],
+        "body": {
+            "code": "e.me.remote-server-down",
+            "comment": "Remote server {1} is down when connecting from {2}",
+            "args": [
+                "https://remote-server.org",
+                "https://my-server.org"
+            ],
+            "escalate_to": "[email protected]"
+        },
+        "from": "did:polygonid:polygon:mumbai:2qJG6RYgN1u6v7JAYSdfixSwktnZ7hMzd4t21SCdNu",
+        "to": "did:polygonid:polygon:mumbai:2qFroxB5kwgCxgVrNGUM6EW3khJgCdHHnKTr3VnTcp"
+    }`;
+    const problemReport = createProblemReportMessage(
+      '5333207e-7338-4ab3-ac34-bf9a20dab6ab',
+      'e.me.remote-server-down',
+      {
+        from: 'did:polygonid:polygon:mumbai:2qJG6RYgN1u6v7JAYSdfixSwktnZ7hMzd4t21SCdNu',
+        to: 'did:polygonid:polygon:mumbai:2qFroxB5kwgCxgVrNGUM6EW3khJgCdHHnKTr3VnTcp',
+        args: ['https://remote-server.org', 'https://my-server.org'],
+        escalate_to: '[email protected]',
+        ack: ['23b610b3-aec8-4d1c-8a75-3b22e5483fb0', '86fe7cc6-adcd-4530-8e07-92c060b427c8'],
+        comment: 'Remote server {1} is down when connecting from {2}'
+      }
+    );
+    delete problemReport.id;
+    const expected = JSON.parse(example);
+    expect(problemReport).to.be.deep.equal(expected);
+  });
+});