@mojaloop/sdk-scheme-adapter 17.0.1 → 17.0.2-snapshot.12

package/src/lib/model/OutboundTransfersModel.js

@@ -15,7 +15,8 @@ const { uuid } = require('uuidv4');
 const StateMachine = require('javascript-state-machine');
 const { Ilp, MojaloopRequests } = require('@mojaloop/sdk-standard-components');
 const shared = require('./lib/shared');
-const { BackendError, TransferStateEnum } = require('./common');
+const { BackendError, SDKStateEnum } = require('./common');
+const FSPIOPTransferStateEnum = require('@mojaloop/central-services-shared').Enum.Transfers.TransferState;
 const PartiesModel = require('./PartiesModel');
 
 /**
@@ -685,7 +686,7 @@ class OutboundTransfersModel {
                     if(this._checkIlp && !this._ilp.validateFulfil(fulfil.body.fulfilment, this.data.quoteResponse.body.condition)) {
                         throw new Error('Invalid fulfilment received from peer DFSP.');
                     }
-                    if(this._sendFinalNotificationIfRequested && fulfil.body.transferState === 'RESERVED') {
+                    if(this._sendFinalNotificationIfRequested && fulfil.body.transferState === FSPIOPTransferStateEnum.RESERVED) {
                         // we need to send a PATCH notification back to say we have committed the transfer.
                         // Note that this is normally a switch only responsibility but the capability is
                         // implemented here to support testing use cases where the mojaloop-connector is
@@ -695,7 +696,7 @@ class OutboundTransfersModel {
                         // we will use the current server time as committed timestamp.
                         const patchNotification = {
                             completedTimestamp: (new Date()).toISOString(),
-                            transferState: 'COMMITTED',
+                            transferState: FSPIOPTransferStateEnum.COMMITTED,
                         };
                         const res = this._requests.patchTransfers(this.data.transferId,
                             patchNotification, this.data.quoteResponseSource);
@@ -885,28 +886,28 @@ class OutboundTransfersModel {
 
         switch(this.data.currentState) {
             case 'payeeResolved':
-                resp.currentState = TransferStateEnum.WAITING_FOR_PARTY_ACCEPTANCE;
+                resp.currentState = SDKStateEnum.WAITING_FOR_PARTY_ACCEPTANCE;
                 break;
 
             case 'quoteReceived':
-                resp.currentState = TransferStateEnum.WAITING_FOR_QUOTE_ACCEPTANCE;
+                resp.currentState = SDKStateEnum.WAITING_FOR_QUOTE_ACCEPTANCE;
                 break;
 
             case 'succeeded':
-                resp.currentState = TransferStateEnum.COMPLETED;
+                resp.currentState = SDKStateEnum.COMPLETED;
                 break;
 
             case 'aborted':
-                resp.currentState = TransferStateEnum.ABORTED;
+                resp.currentState = SDKStateEnum.ABORTED;
                 break;
 
             case 'errored':
-                resp.currentState = TransferStateEnum.ERROR_OCCURRED;
+                resp.currentState = SDKStateEnum.ERROR_OCCURRED;
                 break;
 
             default:
                 this._logger.log(`Transfer model response being returned from an unexpected state: ${this.data.currentState}. Returning ERROR_OCCURRED state`);
-                resp.currentState = TransferStateEnum.ERROR_OCCURRED;
+                resp.currentState = SDKStateEnum.ERROR_OCCURRED;
                 break;
         }
 

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

@@ -10,17 +10,6 @@
 
 '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);
@@ -45,6 +34,5 @@ class BackendError extends Error {
 
 
 module.exports = {
-    BackendError,
-    TransferStateEnum,
+    BackendError
 };

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

@@ -0,0 +1,30 @@
+
+/**************************************************************************
+ *  (C) Copyright ModusBox Inc. 2019 - All rights reserved.               *
+ *                                                                        *
+ *  This file is made available under the terms of the license agreement  *
+ *  specified in the corresponding source code repository.                *
+ *                                                                        *
+ *  ORIGINAL AUTHOR:                                                      *
+ *       Yevhen Kyriukha - yevhen.kyriukha@modusbox.com                   *
+ **************************************************************************/
+
+'use strict';
+
+// NOTE: Stick all common SDK ENUMS here. SDKStateEnum is the first attempt at consolidating and cleaning up ENUMS in the SDK.
+
+const SDKStateEnum = {
+    WAITING_FOR_ACTION: 'WAITING_FOR_ACTION',
+    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',
+};
+
+module.exports = {
+    SDKStateEnum,
+};

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

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

package/test/config/integration.env

@@ -26,8 +26,8 @@ JWS_SIGN=false
 JWS_SIGN_PUT_PARTIES=false
 
 # Path to JWS signing key (private key of THIS DFSP)
-JWS_SIGNING_KEY_PATH=/jwsSigningKey.key
-JWS_VERIFICATION_KEYS_DIRECTORY=/jwsVerificationKeys
+JWS_SIGNING_KEY_PATH=secrets/jwsSigningKey.key
+JWS_VERIFICATION_KEYS_DIRECTORY=secrets/jwsVerificationKeys
 
 # Location of certs and key required for TLS
 # IN_CA_CERT_PATH=./secrets/cacert.pem

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

@@ -2,6 +2,7 @@
 
 const axios = require('axios');
 const env = require('../../testEnv');
+const { SDKStateEnum } = require('../../../../src/lib/model/common');
 
 jest.dontMock('redis');
 
@@ -12,7 +13,7 @@ describe('/parties', () => {
         const res = await axios.get(getPartiesURI);
 
         expect(res.status).toEqual(200);
-        expect(res.data.currentState).toEqual('COMPLETED');
+        expect(res.data.currentState).toEqual(SDKStateEnum.COMPLETED);
         expect(typeof res.data.party).toEqual('object');
         expect(typeof res.data.party.body).toEqual('object');
         expect(typeof res.data.party.headers).toEqual('object');

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

@@ -4,6 +4,8 @@ const axios = require('axios');
 const { uuid } = require('uuidv4');
 const env = require('../../testEnv');
 const quotesPostRequest = require('./data/quotesPostRequest.json');
+const { SDKStateEnum } = require('../../../../src/lib/model/common');
+
 
 jest.dontMock('redis');
 
@@ -28,7 +30,7 @@ describe('/quotes', () => {
         });
 
         expect(res.status).toEqual(200);
-        expect(res.data.currentState).toEqual('COMPLETED');
+        expect(res.data.currentState).toEqual(SDKStateEnum.COMPLETED);
         expect(typeof res.data.quotes).toEqual('object');
         expect(typeof res.data.quotes.body).toEqual('object');
         expect(typeof res.data.quotes.headers).toEqual('object');

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

@@ -4,6 +4,7 @@ const axios = require('axios');
 const { uuid } = require('uuidv4');
 const env = require('../../testEnv');
 const transfersPostRequest = require('./data/transfersPostRequest.json');
+const { SDKStateEnum } = require('../../../../src/lib/model/common');
 
 jest.dontMock('redis');
 
@@ -37,7 +38,7 @@ describe('/simpleTransfers', () => {
         });
 
         expect(res.status).toEqual(200);
-        expect(res.data.currentState).toEqual('COMPLETED');
+        expect(res.data.currentState).toEqual(SDKStateEnum.COMPLETED);
         expect(typeof res.data.transfer).toEqual('object');
         expect(typeof res.data.transfer.body).toEqual('object');
         expect(typeof res.data.transfer.headers).toEqual('object');

package/test/unit/inboundApi/handlers.test.js

@@ -22,6 +22,8 @@ const mockArguments = require('./data/mockArguments');
 const mockTransactionRequestData = require('./data/mockTransactionRequest');
 const { Logger } = require('@mojaloop/sdk-standard-components');
 
+const FSPIOPTransferStateEnum = require('@mojaloop/central-services-shared').Enum.Transfers.TransferState;
+
 describe('Inbound API handlers:', () => {
     let mockArgs;
     let mockTransactionRequest;
@@ -549,7 +551,7 @@ describe('Inbound API handlers:', () => {
 
                     },
                     body: {
-                        transferState: 'COMMITTED',
+                        transferState: FSPIOPTransferStateEnum.COMMITTED,
                         completedTimestamp: '2020-08-18T09:39:33.552Z'
                     }
                 },

package/test/unit/lib/model/AccountsModel.test.js

@@ -19,6 +19,7 @@ const { AccountsModel } = require('~/lib/model');
 
 const StateMachine = require('javascript-state-machine');
 const { MojaloopRequests, Logger } = require('@mojaloop/sdk-standard-components');
+const { SDKStateEnum } = require('../../../../src/lib/model/common');
 
 const defaultConfig = require('./data/defaultConfig');
 const transferRequest = require('./data/transferRequest');
@@ -83,7 +84,7 @@ describe('AccountsModel', () => {
             (Math.floor(count / MAX_ITEMS_PER_REQUEST) + ((count % MAX_ITEMS_PER_REQUEST) ? 1 : 0));
         expect(MojaloopRequests.__postParticipants).toHaveBeenCalledTimes(expectedRequestsCount);
 
-        expect(result.currentState).toBe('COMPLETED');
+        expect(result.currentState).toBe(SDKStateEnum.COMPLETED);
         expect(StateMachine.__instance.state).toBe('succeeded');
     }
 

package/test/unit/lib/model/InboundTransfersModel.test.js

@@ -31,6 +31,10 @@ const notificationToPayee = require('./data/notificationToPayee');
 const notificationAbortedToPayee = require('./data/notificationAbortedToPayee');
 const notificationReservedToPayee = require('./data/notificationReservedToPayee');
 
+const { SDKStateEnum } = require('../../../../src/lib/model/common');
+const FSPIOPTransferStateEnum = require('@mojaloop/central-services-shared').Enum.Transfers.TransferState;
+const FSPIOPBulkTransferStateEnum = require('@mojaloop/central-services-shared').Enum.Transfers.BulkTransferState;
+
 describe('inboundModel', () => {
     let config;
     let mockArgs;
@@ -324,7 +328,7 @@ describe('inboundModel', () => {
             const call = MojaloopRequests.__putTransfers.mock.calls[0];
             expect(call[0]).toEqual(TRANSFER_ID);
             expect(call[1]).toEqual(getTransfersMojaloopResponse);
-            expect(call[1].transferState).toEqual('COMMITTED');
+            expect(call[1].transferState).toEqual(FSPIOPTransferStateEnum.COMMITTED);
         });
 
         test('getTransfer should not return fulfillment from payer', async () => {
@@ -345,7 +349,7 @@ describe('inboundModel', () => {
             const call = MojaloopRequests.__putTransfers.mock.calls[0];
             expect(call[0]).toEqual(TRANSFER_ID);
             expect(call[1]).toEqual({...getTransfersMojaloopResponse, fulfilment: undefined});
-            expect(call[1].transferState).toEqual('COMMITTED');
+            expect(call[1].transferState).toEqual(FSPIOPTransferStateEnum.COMMITTED);
         });
 
         test('getTransfer should return not found error', async () => {
@@ -601,7 +605,7 @@ describe('inboundModel', () => {
             const call = MojaloopRequests.__putBulkTransfers.mock.calls[0];
             expect(call[0]).toEqual(BULK_TRANSFER_ID);
             expect(call[1]).toEqual(getBulkTransfersMojaloopResponse);
-            expect(call[1].bulkTransferState).toEqual('COMMITTED');
+            expect(call[1].bulkTransferState).toEqual(FSPIOPBulkTransferStateEnum.COMPLETED);
         });
 
         test('getBulkTransfer should not return fulfillment from payer', async () => {
@@ -621,7 +625,7 @@ describe('inboundModel', () => {
 
             const call = MojaloopRequests.__putBulkTransfers.mock.calls[0];
             expect(call[0]).toEqual(BULK_TRANSFER_ID);
-            expect(call[1].bulkTransferState).toEqual('COMMITTED');
+            expect(call[1].bulkTransferState).toEqual(FSPIOPBulkTransferStateEnum.COMPLETED);
             const expectedResponse = {...getBulkTransfersMojaloopResponse};
             expectedResponse.individualTransferResults[0].fulfilment = undefined;
             expect(call[1]).toMatchObject(expectedResponse);
@@ -738,7 +742,7 @@ describe('inboundModel', () => {
             const notif = JSON.parse(JSON.stringify(notificationToPayee));
 
             const expectedRequest = {
-                currentState: 'COMPLETED',
+                currentState: SDKStateEnum.COMPLETED,
                 finalNotification: notif.data,
             };
 
@@ -760,7 +764,7 @@ describe('inboundModel', () => {
             const notif = JSON.parse(JSON.stringify(notificationAbortedToPayee));
 
             const expectedRequest = {
-                currentState: 'ABORTED',
+                currentState: SDKStateEnum.ABORTED,
                 finalNotification: notif.data,
             };
 

package/test/unit/lib/model/OutboundBulkQuotesModel.test.js

@@ -20,6 +20,8 @@ const Model = require('~/lib/model').OutboundBulkQuotesModel;
 const { MojaloopRequests, Logger } = require('@mojaloop/sdk-standard-components');
 const StateMachine = require('javascript-state-machine');
 
+const { SDKStateEnum } = require('../../../../src/lib/model/common');
+
 const defaultConfig = require('./data/defaultConfig');
 const bulkQuoteRequest = require('./data/bulkQuoteRequest');
 const bulkQuoteResponseTemplate = require('./data/bulkQuoteResponse');
@@ -74,7 +76,7 @@ describe('OutboundBulkQuotesModel', () => {
             await expect(model.run()).rejects.toThrowError(expectError);
         } else {
             const result = await model.run();
-            await expect(result.currentState).toBe('COMPLETED');
+            await expect(result.currentState).toBe(SDKStateEnum.COMPLETED);
         }
     }
 
@@ -139,7 +141,7 @@ describe('OutboundBulkQuotesModel', () => {
         expect(MojaloopRequests.__getBulkQuotes).toHaveBeenCalledTimes(1);
 
         // check we stopped at succeeded state
-        expect(result.currentState).toBe('COMPLETED');
+        expect(result.currentState).toBe(SDKStateEnum.COMPLETED);
         expect(StateMachine.__instance.state).toBe('succeeded');
     });
 
@@ -174,7 +176,7 @@ describe('OutboundBulkQuotesModel', () => {
         expect(MojaloopRequests.__postBulkQuotes).toHaveBeenCalledTimes(1);
 
         // check we stopped at 'succeeded' state
-        expect(result.currentState).toBe('COMPLETED');
+        expect(result.currentState).toBe(SDKStateEnum.COMPLETED);
         expect(StateMachine.__instance.state).toBe('succeeded');
     });
 

package/test/unit/lib/model/OutboundBulkTransfersModel.test.js

@@ -19,6 +19,7 @@ const Model = require('~/lib/model').OutboundBulkTransfersModel;
 
 const { MojaloopRequests, Logger } = require('@mojaloop/sdk-standard-components');
 const StateMachine = require('javascript-state-machine');
+const { SDKStateEnum } = require('../../../../src/lib/model/common');
 
 const defaultConfig = require('./data/defaultConfig');
 const bulkTransferRequest = require('./data/bulkTransferRequest');
@@ -70,7 +71,7 @@ describe('outboundBulkTransferModel', () => {
             await expect(model.run()).rejects.toThrowError(expectError);
         } else {
             const result = await model.run();
-            await expect(result.currentState).toBe('COMPLETED');
+            await expect(result.currentState).toBe(SDKStateEnum.COMPLETED);
         }
     }
 
@@ -136,7 +137,7 @@ describe('outboundBulkTransferModel', () => {
         expect(MojaloopRequests.__postBulkTransfers).toHaveBeenCalledTimes(1);
 
         // check we stopped at succeeded state
-        expect(result.currentState).toBe('COMPLETED');
+        expect(result.currentState).toBe(SDKStateEnum.COMPLETED);
         expect(StateMachine.__instance.state).toBe('succeeded');
     });
 
@@ -168,7 +169,7 @@ describe('outboundBulkTransferModel', () => {
         expect(MojaloopRequests.__getBulkTransfers).toHaveBeenCalledTimes(1);
 
         // check we stopped at succeeded state
-        expect(result.currentState).toBe('COMPLETED');
+        expect(result.currentState).toBe(SDKStateEnum.COMPLETED);
         expect(StateMachine.__instance.state).toBe('succeeded');
     });
 

package/test/unit/lib/model/OutboundRequestToPayModel.test.js

@@ -20,6 +20,7 @@ const PartiesModel = require('~/lib/model').PartiesModel;
 
 const { MojaloopRequests, Logger } = require('@mojaloop/sdk-standard-components');
 const StateMachine = require('javascript-state-machine');
+const { SDKStateEnum } = require('../../../../src/lib/model/common');
 
 const defaultConfig = require('./data/defaultConfig');
 const requestToPayRequest = require('./data/requestToPayRequest');
@@ -124,7 +125,7 @@ describe('outboundModel', () => {
         expect(MojaloopRequests.__postTransactionRequests).toHaveBeenCalledTimes(1);
 
         // check we stopped at payeeResolved state
-        expect(result.currentState).toBe('COMPLETED');
+        expect(result.currentState).toBe(SDKStateEnum.COMPLETED);
         expect(result.requestToPayState).toBe('RECEIVED');
         expect(StateMachine.__instance.state).toBe('succeeded');
     });
@@ -157,7 +158,7 @@ describe('outboundModel', () => {
         const result = await resultPromise;
 
         // check we stopped at payeeResolved state
-        expect(result.currentState).toBe('WAITING_FOR_PARTY_ACCEPTANCE');
+        expect(result.currentState).toBe(SDKStateEnum.WAITING_FOR_PARTY_ACCEPTANCE);
         expect(StateMachine.__instance.state).toBe('payeeResolved');
     });
 

package/test/unit/lib/model/OutboundRequestToPayTransferModel.test.js

@@ -19,6 +19,7 @@ const Model = require('~/lib/model').OutboundRequestToPayTransferModel;
 
 const { MojaloopRequests, Logger } = require('@mojaloop/sdk-standard-components');
 const StateMachine = require('javascript-state-machine');
+const { SDKStateEnum } = require('../../../../src/lib/model/common');
 
 const defaultConfig = require('./data/defaultConfig');
 const requestToPayTransferRequest = require('./data/requestToPayTransferRequest');
@@ -154,7 +155,7 @@ describe('outboundRequestToPayTransferModel', () => {
         expect(MojaloopRequests.__postTransfers).toHaveBeenCalledTimes(1);
 
         // check we stopped at payeeResolved state
-        expect(result.currentState).toBe('COMPLETED');
+        expect(result.currentState).toBe(SDKStateEnum.COMPLETED);
         expect(StateMachine.__instance.state).toBe('succeeded');
     });
 
@@ -183,7 +184,7 @@ describe('outboundRequestToPayTransferModel', () => {
     //     let result = await resultPromise;
 
     //     // check we stopped at quoteReceived state
-    //     expect(result.currentState).toBe('WAITING_FOR_QUOTE_ACCEPTANCE');
+    //     expect(result.currentState).toBe(SDKStateEnum.WAITING_FOR_QUOTE_ACCEPTANCE);
     //     expect(StateMachine.__instance.state).toBe('quoteReceived');
 
     //     const requestToPayTransactionId = requestToPayTransferRequest.requestToPayTransactionId;
@@ -235,7 +236,7 @@ describe('outboundRequestToPayTransferModel', () => {
     //     result = await resultPromise;
 
     //     // check we stopped at quoteReceived state
-    //     expect(result.currentState).toBe('COMPLETED');
+    //     expect(result.currentState).toBe(SDKStateEnum.COMPLETED);
     //     expect(StateMachine.__instance.state).toBe('succeeded');
 
     // });