@mojaloop/sdk-scheme-adapter 12.2.2 → 13.0.0

package/src/lib/model/common/BackendError.js

@@ -10,6 +10,17 @@
 
 'use strict';
 
+const TransferStateEnum = {
+    'WAITING_FOR_PARTY_ACCEPTANCE': 'WAITING_FOR_PARTY_ACCEPTANCE',
+    'QUOTE_REQUEST_RECEIVED': 'QUOTE_REQUEST_RECEIVED',
+    'WAITING_FOR_QUOTE_ACCEPTANCE': 'WAITING_FOR_QUOTE_ACCEPTANCE',
+    'PREPARE_RECEIVED': 'PREPARE_RECEIVED',
+    'ERROR_OCCURRED': 'ERROR_OCCURRED',
+    'COMPLETED': 'COMPLETED',
+    'ABORTED': 'ABORTED',
+    'RESERVED': 'RESERVED',
+};
+
 class BackendError extends Error {
     constructor(msg, httpStatusCode) {
         super(msg);
@@ -17,10 +28,23 @@ class BackendError extends Error {
     }
 
     toJSON() {
-        // return shallow clone of `this`, from `this` are only taken enumerable owned properties
-        return Object.assign({}, this);
-        
+        const ret = {
+            httpStatusCode: this.httpStatusCode
+        };
+
+        // copy across any other properties
+        for(let prop in this) {
+            if(this.hasOwnProperty(prop)) {
+                ret[prop] = this[prop];
+            }
+        }
+
+        return ret;
     }
 }
 
-module.exports = BackendError;
+
+module.exports = {
+    BackendError,
+    TransferStateEnum,
+};

package/src/lib/model/common/index.js

@@ -9,10 +9,11 @@
  **************************************************************************/
 
 'use strict';
-const BackendError = require('./BackendError');
+const { BackendError, TransferStateEnum } = require('./BackendError');
 const PersistentStateMachine = require('./PersistentStateMachine');
 
 module.exports = {
     BackendError,
+    TransferStateEnum,
     PersistentStateMachine
 };

package/src/lib/validate.js

@@ -24,7 +24,7 @@ const { Errors } = require('@mojaloop/sdk-standard-components');
 const Ajv = require('ajv');
 const ajv = new Ajv({ allErrors: true, coerceTypes: true, strict: false });
 
-const httpMethods = ['get', 'head', 'post', 'put', 'delete', 'connnect', 'options', 'trace', 'patch'];
+const httpMethods = ['get', 'head', 'post', 'put', 'delete', 'connect', 'options', 'trace', 'patch'];
 
 // Create a json schema in the format we've chosen to use
 const createSchema = (pathValue, methodValue) => {
@@ -186,7 +186,7 @@ class Validator {
 
             if(firstError.keyword === 'required') {
                 // this is a missing required property; there is a specific mojaloop api spec error code for this
-                err = new Errors.MojaloopFSPIOPError(firstError, util.format('Request failed validation', 
+                err = new Errors.MojaloopFSPIOPError(firstError, util.format('Request failed validation',
                     validationResult), null, Errors.MojaloopApiErrorCodes.MISSING_ELEMENT);
 
                 // overwrite the defaul error message with something more useful

package/test/__mocks__/@mojaloop/sdk-standard-components.js

@@ -40,6 +40,7 @@ class MockMojaloopRequests extends MojaloopRequests {
         this.postBulkTransfers = MockMojaloopRequests.__postBulkTransfers;
         this.putBulkTransfers = MockMojaloopRequests.__putBulkTransfers;
         this.putBulkTransfersError = MockMojaloopRequests.__putBulkTransfersError;
+        this.patchTransfers = MockMojaloopRequests.__patchTransfers;
     }
 }
 MockMojaloopRequests.__postParticipants = jest.fn(() => Promise.resolve());
@@ -63,7 +64,7 @@ MockMojaloopRequests.__getBulkTransfers = jest.fn(() => Promise.resolve());
 MockMojaloopRequests.__postBulkTransfers = jest.fn(() => Promise.resolve());
 MockMojaloopRequests.__putBulkTransfers = jest.fn(() => Promise.resolve());
 MockMojaloopRequests.__putBulkTransfersError = jest.fn(() => Promise.resolve());
-
+MockMojaloopRequests.__patchTransfers = jest.fn(() => Promise.resolve());
 
 class MockIlp {
     constructor(config) {
@@ -146,5 +147,5 @@ module.exports = {
     },
     Errors,
     WSO2Auth,
-    Logger
+    Logger,
 };

package/test/__mocks__/redis.js

@@ -26,6 +26,10 @@ class RedisClient extends redisMock.RedisClient {
         }
     }
 
+    config(...args) {
+        this._executeCallback(...args);
+    }
+
     subscribe(...args) {
         super.subscribe(...args);
         this._executeCallback(...args);

package/test/config/integration.env

@@ -132,6 +132,11 @@ TRANSFERS_ENDPOINT=ml-testing-toolkit:5000
 # The fulfilment will be generated from the provided ILP packet, and must hash to the provided condition.
 ALLOW_TRANSFER_WITHOUT_QUOTE=false
 
+# To enable request for notification on fulfiled transfer
+RESERVE_NOTIFICATION=true
+# resources API versions should be string in format: "resourceOneName=1.0,resourceTwoName=1.1"
+RESOURCE_VERSIONS="transfers=1.1,participants=1.1"
+
 # Management API websocket connection settings.
 # The Management API uses this for exchanging connector management messages.
 MGMT_API_WS_URL=127.0.0.1

package/test/integration/lib/Outbound/parties.test.js

@@ -13,7 +13,7 @@ describe('/parties', () => {
 
         expect(res.status).toEqual(200);
         expect(res.data.currentState).toEqual('COMPLETED');
-        expect(typeof res.data.party).toEqual('object');
+        expect(typeof res.data.body.party).toEqual('object');
     });
 
     test('get - timeout', (done) => {

package/test/unit/ControlServer/index.js

@@ -11,7 +11,7 @@
 
 const ws = require('ws');
 const jsonPatch = require('fast-json-patch');
-const randomPhrase = require('~/lib/randomphrase');
+const { generateSlug } = require('random-word-slugs');
 const { getInternalEventEmitter, INTERNAL_EVENTS } = require('./events');
 
 const ControlServerEventEmitter = getInternalEventEmitter();
@@ -58,7 +58,7 @@ const deserialise = (msg) => {
 };
 
 
-const buildMsg = (verb, msg, data, id = randomPhrase()) => serialise({
+const buildMsg = (verb, msg, data, id = generateSlug(4)) => serialise({
     verb,
     msg,
     data,
@@ -197,7 +197,7 @@ class Server extends ws.Server {
      * @param {object} params Updated configuration
      */
     async broadcastConfigChange(updatedConfig) {
-        const updateConfMsg = build.CONFIGURATION.PATCH({}, updatedConfig, randomPhrase());
+        const updateConfMsg = build.CONFIGURATION.PATCH({}, updatedConfig, generateSlug(4));
         const errorLogger = (socket, message) => (err) =>
             this._logger
                 .push({ message, ip: this._clientData.get(socket).ip, err })

package/test/unit/InboundServer.test.js

@@ -51,7 +51,7 @@ describe('Inbound Server', () => {
             await supertest(svr._server)
                 .put('/parties/MSISDN/123456789')
                 .send(putPartiesBody)
-                .set('content-type', 'application/vnd.interoperability.parties+json;version=1.0')
+                .set('content-type', 'application/vnd.interoperability.parties+json;version=1.1')
                 .set('fspiop-http-method', 'PUT')
                 .set('fspiop-uri', '/parties/MSISDN/123456789')
                 .set('date', new Date().toISOString());
@@ -93,7 +93,7 @@ describe('Inbound Server', () => {
             testPartiesJwsValidation(false, true, 0));
 
         test('processes parties request with valid content-type headers successfully', async () => {
-            await testPartiesHeaderValidation('application/vnd.interoperability.parties+json;version=1.0', 200);
+            await testPartiesHeaderValidation('application/vnd.interoperability.parties+json;version=1.1', 200);
         });
 
         test('returns error on invalid parties content-type headers', async () => {
@@ -108,7 +108,7 @@ describe('Inbound Server', () => {
                 }
             );
             await testPartiesHeaderValidation(
-                'application/vnd.interoperability.test+json;version=1.0',
+                'application/vnd.interoperability.test+json;version=1.1',
                 400,
                 {
                     'errorInformation': {
@@ -148,7 +148,7 @@ describe('Inbound Server', () => {
                 .post('/quotes')
                 .send(postQuotesBody)
                 .set(commonHttpHeaders)
-                .set('content-type', 'application/vnd.interoperability.quotes+json;version=1.0')
+                .set('content-type', 'application/vnd.interoperability.quotes+json;version=1.1')
                 .set('fspiop-http-method', 'POST')
                 .set('fspiop-uri', '/quotes')
                 .set('date', new Date().toISOString());
@@ -183,7 +183,7 @@ describe('Inbound Server', () => {
             testQuotesJwsValidation(true, true, 1));
 
         test('processes quotes request with valid content-type headers successfully', async () => {
-            await testQuotesHeaderValidation('application/vnd.interoperability.quotes+json;version=1.0', 202);
+            await testQuotesHeaderValidation('application/vnd.interoperability.quotes+json;version=1.1', 202);
         });
 
         test('returns error on invalid quotes content-type headers', async () => {
@@ -198,7 +198,7 @@ describe('Inbound Server', () => {
                 }
             );
             await testQuotesHeaderValidation(
-                'application/vnd.interoperability.parties+json;version=1.0',
+                'application/vnd.interoperability.parties+json;version=1.1',
                 400,
                 {
                     'errorInformation': {
@@ -239,7 +239,7 @@ describe('Inbound Server', () => {
                 .put('/participants/00000000-0000-1000-a000-000000000002')
                 .send(putParticipantsBody)
                 .set(commonHttpHeaders)
-                .set('content-type', 'application/vnd.interoperability.participants+json;version=1.0')
+                .set('content-type', 'application/vnd.interoperability.participants+json;version=1.1')
                 .set('fspiop-http-method', 'PUT')
                 .set('fspiop-uri', '/participants/00000000-0000-1000-a000-000000000002')
                 .set('date', new Date().toISOString());
@@ -274,7 +274,7 @@ describe('Inbound Server', () => {
             testParticipantsJwsValidation(false, false, 0));
 
         test('processes participants request with valid content-type headers successfully', async () => {
-            await testParticipantsHeaderValidation('application/vnd.interoperability.participants+json;version=1.0', 200);
+            await testParticipantsHeaderValidation('application/vnd.interoperability.participants+json;version=1.1', 200);
         });
 
         test('returns error on invalid participants content-type headers', async () => {
@@ -289,7 +289,7 @@ describe('Inbound Server', () => {
                 }
             );
             await testParticipantsHeaderValidation(
-                'application/vnd.interoperability.parties+json;version=1.0',
+                'application/vnd.interoperability.parties+json;version=1.1',
                 400,
                 {
                     'errorInformation': {
@@ -334,7 +334,7 @@ describe('Inbound Server', () => {
         });
 
         async function testTlsServer(enableTls) {
-            defConfig.mutualTLS.inboundRequests.enabled = enableTls;
+            defConfig.inbound.tls.mutualTLS.enabled = enableTls;
             const logger = new Logger.Logger({ stringify: () => '' });
             const cache = new Cache({ ...defConfig.cacheConfig, logger: logger.push({ component: 'cache' }) });
             const server = new InboundServer(defConfig, logger, cache);

package/test/unit/TestServer.test.js

@@ -104,7 +104,7 @@ describe('Test Server', () => {
             .put(`/parties/MSISDN/${MSISDN}`)
             .send(putPartiesBody)
             .set(commonHttpHeaders)
-            .set('content-type', 'application/vnd.interoperability.parties+json;version=1.0')
+            .set('content-type', 'application/vnd.interoperability.parties+json;version=1.1')
             .set('fspiop-http-method', 'PUT')
             .set('fspiop-uri', `/parties/MSISDN/${MSISDN}`)
             .set('date', new Date().toISOString());
@@ -119,7 +119,7 @@ describe('Test Server', () => {
             .post('/quotes')
             .send(postQuotesBody)
             .set(commonHttpHeaders)
-            .set('content-type', 'application/vnd.interoperability.quotes+json;version=1.0')
+            .set('content-type', 'application/vnd.interoperability.quotes+json;version=1.1')
             .set('fspiop-http-method', 'POST')
             .set('fspiop-uri', '/quotes')
             .set('date', new Date().toISOString());
@@ -136,7 +136,7 @@ describe('Test Server', () => {
             .put(`/participants/${participantId}`)
             .send(putParticipantsBody)
             .set(commonHttpHeaders)
-            .set('content-type', 'application/vnd.interoperability.participants+json;version=1.0')
+            .set('content-type', 'application/vnd.interoperability.participants+json;version=1.1')
             .set('fspiop-http-method', 'PUT')
             .set('fspiop-uri', `/participants/${participantId}`)
             .set('date', new Date().toISOString());
@@ -159,7 +159,7 @@ describe('Test Server', () => {
 
         const headers = {
             ...commonHttpHeaders,
-            'content-type': 'application/vnd.interoperability.participants+json;version=1.0',
+            'content-type': 'application/vnd.interoperability.participants+json;version=1.1',
             'fspiop-http-method': 'PUT',
             'fspiop-uri': `/participants/${participantId}`,
             'date': new Date().toISOString(),
@@ -231,7 +231,7 @@ describe('Test Server', () => {
     test('WebSocket /requests and / endpoint triggers send to client when callback received to inbound server', async () => {
         const headers = {
             ...commonHttpHeaders,
-            'content-type': 'application/vnd.interoperability.quotes+json;version=1.0',
+            'content-type': 'application/vnd.interoperability.quotes+json;version=1.1',
             'fspiop-http-method': 'POST',
             'fspiop-uri': '/quotes',
             'date': new Date().toISOString(),
@@ -270,8 +270,7 @@ describe('Test Server', () => {
             .send(postQuotesBody)
             .set(headers);
 
-        // Called twice for the quote request, once for the fulfilment
-        expect(inboundServer._api._cache.set).toHaveBeenCalledTimes(3);
+        expect(inboundServer._api._cache.set).toHaveBeenCalledTimes(4);
         expect(inboundServer._api._cache.set).toHaveBeenCalledWith(
             `${testServer._wsapi._cache.REQUEST_PREFIX}${postQuotesBody.quoteId}`,
             {
@@ -304,7 +303,7 @@ describe('Test Server', () => {
     test('Websocket / endpoint receives both callbacks and requests', async () => {
         const quoteRequestHeaders = {
             ...commonHttpHeaders,
-            'content-type': 'application/vnd.interoperability.quotes+json;version=1.0',
+            'content-type': 'application/vnd.interoperability.quotes+json;version=1.1',
             'fspiop-http-method': 'POST',
             'fspiop-uri': '/quotes',
             'date': new Date().toISOString(),
@@ -332,8 +331,7 @@ describe('Test Server', () => {
             .send(postQuotesBody)
             .set(quoteRequestHeaders);
 
-        // Called twice for the quote request, once for the fulfilment
-        expect(inboundServer._api._cache.set).toHaveBeenCalledTimes(3);
+        expect(inboundServer._api._cache.set).toHaveBeenCalledTimes(4);
         expect(inboundServer._api._cache.set).toHaveBeenCalledWith(
             `${testServer._wsapi._cache.REQUEST_PREFIX}${postQuotesBody.quoteId}`,
             {
@@ -362,7 +360,7 @@ describe('Test Server', () => {
 
         const putParticipantsHeaders = {
             ...commonHttpHeaders,
-            'content-type': 'application/vnd.interoperability.participants+json;version=1.0',
+            'content-type': 'application/vnd.interoperability.participants+json;version=1.1',
             'fspiop-http-method': 'PUT',
             'fspiop-uri': `/participants/${participantId}`,
             'date': new Date().toISOString(),
@@ -375,8 +373,8 @@ describe('Test Server', () => {
 
         // Called thrice for the quote request earlier in this test, another time now for the put
         // participants request
-        expect(inboundServer._api._cache.set).toHaveBeenCalledTimes(4);
-        expect(inboundServer._api._cache.set.mock.calls[3]).toEqual([
+        expect(inboundServer._api._cache.set).toHaveBeenCalledTimes(5);
+        expect(inboundServer._api._cache.set.mock.calls[4]).toEqual([
             `${testServer._wsapi._cache.CALLBACK_PREFIX}${participantId}`,
             {
                 data: putParticipantsBody,

package/test/unit/api/accounts/data/postAccountsErrorMojaloopResponse.json

@@ -1,5 +1,15 @@
 {
+  "message": "Got an error response creating accounts: {\n  errorInformation: { errorCode: '3204', errorDescription: 'Party not found' }\n}",
+  "statusCode": "3204",
   "executionState": {
+    "postAccountsResponse": {
+      "body": {
+        "errorInformation": {
+          "errorCode": "3204",
+          "errorDescription": "Party not found"
+        }
+      }
+    },
     "accounts": [
       {
         "currency": "USD",
@@ -19,7 +29,5 @@
     },
     "modelId": "00000000-0000-1000-8000-000000000001",
     "response": []
-  },
-  "message": "Got an error response creating accounts: {\n  errorInformation: { errorCode: '3204', errorDescription: 'Party not found' }\n}",
-  "statusCode": "3204"
+  }
 }

package/test/unit/api/accounts/data/postAccountsSuccessResponse.json

@@ -8,6 +8,20 @@
   ],
   "currentState": "COMPLETED",
   "modelId": "00000000-0000-1000-8000-000000000001",
+  "postAccountsResponse": {
+    "body": {
+      "currency": "USD",
+      "partyList": [
+        {
+          "partyId": {
+            "fspId": "mojaloop-sdk",
+            "partyIdType": "MSISDN",
+            "partyIdentifier": "123456789"
+          }
+        }
+      ]
+    }
+  },
   "response": [
     {
       "idType": "MSISDN",

package/test/unit/api/accounts/data/postAccountsSuccessResponseWithError1.json

@@ -8,6 +8,19 @@
   ],
   "currentState": "COMPLETED",
   "modelId": "00000000-0000-1000-8000-000000000001",
+  "postAccountsResponse": {
+    "body": {
+      "partyList": [
+        {
+          "partyId": {
+            "fspId": "mojaloop-sdk",
+            "partyIdType": "MSISDN",
+            "partyIdentifier": "123456789"
+          }
+        }
+      ]
+    }
+  },
   "response": [
     {
       "error": {

package/test/unit/api/accounts/data/postAccountsSuccessResponseWithError2.json

@@ -8,6 +8,24 @@
   ],
   "currentState": "COMPLETED",
   "modelId": "00000000-0000-1000-8000-000000000001",
+  "postAccountsResponse": {
+    "body": {
+      "currency": "USD",
+      "partyList": [
+        {
+          "errorInformation": {
+            "errorCode": "3204",
+            "errorDescription": "Party not found"
+          },
+          "partyId": {
+            "fspId": "mojaloop-sdk",
+            "partyIdType": "MSISDN",
+            "partyIdentifier": "123456789"
+          }
+        }
+      ]
+    }
+  },
   "response": [
     {
       "error": {

package/test/unit/api/accounts/utils.js

@@ -36,7 +36,7 @@ function createPostAccountsTester({ reqInbound, reqOutbound, apiSpecsOutbound })
             return reqInbound.put(putUrl)
                 .send(putBody)
                 .set('Date', new Date().toISOString())
-                .set('content-type', 'application/vnd.interoperability.participants+json;version=1.0')
+                .set('content-type', 'application/vnd.interoperability.participants+json;version=1.1')
                 .set('fspiop-source', 'mojaloop-sdk')
                 .expect(200);
         };
@@ -50,6 +50,20 @@ function createPostAccountsTester({ reqInbound, reqOutbound, apiSpecsOutbound })
         const res = await reqOutbound.post('/accounts').send(postAccountsBody);
         const {body} = res;
         expect(res.statusCode).toEqual(responseCode);
+
+        // remove elements of the response we do not want/need to compare for correctness.
+        // timestamps on requests/responses for example will be set by the HTTP framework
+        // and we dont want to compare against static values.
+        if (body.executionState) {
+            if(body.executionState.postAccountsResponse) {
+                delete body.executionState.postAccountsResponse.headers;
+            }
+        }
+
+        if(body.postAccountsResponse) {
+            delete body.postAccountsResponse.headers;
+        }
+
         expect(body).toEqual(responseBody);
         const responseValidator = new OpenAPIResponseValidator(apiSpecsOutbound.paths['/accounts'].post);
         const err = responseValidator.validateResponse(responseCode, body);

package/test/unit/api/transfers/data/getTransfersCommittedResponse.json

@@ -1,21 +1,24 @@
 {
   "currentState": "COMPLETED",
+  "direction": "OUTBOUND",
   "fulfil": {
-    "completedTimestamp": "2017-11-15T14:16:09.663+01:00",
-    "extensionList": {
-      "extension": [
-        {
-          "key": "treskey1",
-          "value": "tresvalue1"
-        },
-        {
-          "key": "treskey2",
-          "value": "tresvalue2"
-        }
-      ]
-    },
-    "fulfilment": "87mm1reS3SAi8oIWXgBkLmgWc1MkZ_yLbFDX5XAdo5o",
-    "transferState": "COMMITTED"
+    "body": {
+      "completedTimestamp": "2017-11-15T14:16:09.663+01:00",
+      "extensionList": {
+        "extension": [
+          {
+            "key": "treskey1",
+            "value": "tresvalue1"
+          },
+          {
+            "key": "treskey2",
+            "value": "tresvalue2"
+          }
+        ]
+      },
+      "fulfilment": "87mm1reS3SAi8oIWXgBkLmgWc1MkZ_yLbFDX5XAdo5o",
+      "transferState": "COMMITTED"
+    }
   },
   "transferId": "00000000-0000-1000-8000-000000000001"
 }

package/test/unit/api/transfers/data/getTransfersErrorNotFound.json

@@ -3,6 +3,7 @@
   "statusCode": "3208",
   "transferState": {
     "currentState": "ERROR_OCCURRED",
+    "direction": "OUTBOUND",
     "lastError": {
       "httpStatusCode": 500,
       "mojaloopError": {

package/test/unit/api/transfers/data/postTransfersErrorMojaloopResponse.json

@@ -2,6 +2,7 @@
   "message": "Got an error response resolving party: {\n  errorInformation: { errorCode: '3204', errorDescription: 'Party not found' }\n}",
   "statusCode": "3204",
   "transferState": {
+    "direction": "OUTBOUND",
     "amount": "100",
     "amountType": "SEND",
     "currency": "USD",
@@ -11,6 +12,14 @@
       "idType": "MSISDN",
       "idValue": "123456789"
     },
+    "getPartiesResponse": {
+      "body": {
+        "errorInformation": {
+          "errorCode": "3204",
+          "errorDescription": "Party not found"
+        }
+      }
+    },
     "homeTransactionId": "123ABC",
     "lastError": {
       "httpStatusCode": 500,

package/test/unit/api/transfers/data/postTransfersErrorTimeoutResponse.json

@@ -5,6 +5,7 @@
     "amount": "100",
     "amountType": "SEND",
     "currency": "USD",
+    "direction": "OUTBOUND",
     "currentState": "ERROR_OCCURRED",
     "from": {
       "displayName": "John Doe",