@mojaloop/sdk-scheme-adapter 12.2.3 → 13.0.1

package/src/InboundServer/handlers.js

@@ -159,7 +159,10 @@ const postQuotes = async (ctx) => {
             const sourceFspId = ctx.request.headers['fspiop-source'];
 
             // use the model to handle the request
-            const response = await model.quoteRequest(ctx.request.body, sourceFspId);
+            const response = await model.quoteRequest({
+                body: ctx.request.body,
+                headers: ctx.request.headers,
+            }, sourceFspId);
 
             // log the result
             ctx.state.logger.push({ response }).log('Inbound transfers model handled POST /quotes request');
@@ -196,7 +199,10 @@ const postTransfers = async (ctx) => {
             const sourceFspId = ctx.request.headers['fspiop-source'];
 
             // use the model to handle the request
-            const response = await model.prepareTransfer(ctx.request.body, sourceFspId);
+            const response = await model.prepareTransfer({
+                body: ctx.request.body,
+                headers: ctx.request.headers,
+            }, sourceFspId);
 
             // log the result
             ctx.state.logger.push({ response }).log('Inbound transfers model handled POST /transfers request');
@@ -299,8 +305,10 @@ const putAuthorizationsById = async (ctx) => {
     // publish an event onto the cache for subscribers to action
     await ctx.state.cache.publish(cacheId, {
         type: 'authorizationsResponse',
-        data: ctx.request.body,
-        headers: ctx.request.headers
+        data: {
+            body: ctx.request.body,
+            headers: ctx.request.headers
+        }
     });
     ctx.response.status = 200;
 };
@@ -313,7 +321,10 @@ const putParticipantsById = async (ctx) => {
     // publish an event onto the cache for subscribers to action
     await ctx.state.cache.publish(`ac_${ctx.state.path.params.ID}`, {
         type: 'accountsCreationSuccessfulResponse',
-        data: ctx.request.body
+        data: {
+            body: ctx.request.body,
+            headers: ctx.request.headers
+        }
     });
 
     ctx.response.status = 200;
@@ -327,7 +338,10 @@ const putParticipantsByIdError = async (ctx) => {
     // publish an event onto the cache for subscribers to action
     await ctx.state.cache.publish(`ac_${ctx.state.path.params.ID}`, {
         type: 'accountsCreationErrorResponse',
-        data: ctx.request.body
+        data: {
+            body: ctx.request.body,
+            headers: ctx.request.headers
+        }
     });
 
     ctx.response.status = 200;
@@ -347,7 +361,12 @@ const putParticipantsByTypeAndId = async (ctx) => {
 
         // publish an event onto the cache for subscribers to action
         const cacheId = `${idType}_${idValue}` + (idSubValue ? `_${idSubValue}` : '');
-        await ctx.state.cache.publish(cacheId, ctx.request.body);
+        await ctx.state.cache.publish(cacheId, {
+            data: {
+                body: ctx.request.body,
+                headers: ctx.request.headers
+            }
+        });
         ctx.response.status = 200;
     } else {
         // SDK does not make participants requests so we should not expect any calls to this method
@@ -370,7 +389,12 @@ const putParticipantsByTypeAndIdError = async(ctx) => {
     // the subscriber will notice the body contains an errorInformation property
     // and recognise it as an error response
     const cacheId = `${idType}_${idValue}` + (idSubValue ? `_${idSubValue}` : '');
-    await ctx.state.cache.publish(cacheId, ctx.request.body);
+    await ctx.state.cache.publish(cacheId, {
+        data: {
+            body: ctx.request.body,
+            headers: ctx.request.headers
+        }
+    });
 
     ctx.response.status = 200;
     ctx.response.body = '';
@@ -389,32 +413,10 @@ const putPartiesByTypeAndId = async (ctx) => {
     // publish an event onto the cache for subscribers to finish the action
     await PartiesModel.triggerDeferredJob({
         cache: ctx.state.cache,
-        message: ctx.request.body,
-        args: {
-            type: idType,
-            id: idValue,
-            subId: idSubValue
-        }
-    });
-
-    ctx.response.status = 200;
-};
-
-/**
- * Handles a PUT /parties/{Type}/{ID}/error request. This is an error response to a GET /parties/{Type}/{ID} request
- */
-const putPartiesByTypeAndIdError = async(ctx) => {
-    const idType = ctx.state.path.params.Type;
-    const idValue = ctx.state.path.params.ID;
-    const idSubValue = ctx.state.path.params.SubId;
-
-    // publish an event onto the cache for subscribers to action
-    // note that we publish the event the same way we publish a success PUT
-    // the subscriber will notice the body contains an errorInformation property
-    // and recognizes it as an error response
-    await PartiesModel.triggerDeferredJob({
-        cache: ctx.state.cache,
-        message: ctx.request.body,
+        message: {
+            headers: ctx.request.headers,
+            body: ctx.request.body
+        },
         args: {
             type: idType,
             id: idValue,
@@ -423,10 +425,8 @@ const putPartiesByTypeAndIdError = async(ctx) => {
     });
 
     ctx.response.status = 200;
-    ctx.response.body = '';
 };
 
-
 /**
  * Handles a PUT /quotes/{ID}. This is a response to a POST /quotes request
  */
@@ -437,14 +437,19 @@ const putQuoteById = async (ctx) => {
     // publish an event onto the cache for subscribers to action
     await ctx.state.cache.publish(`qt_${ctx.state.path.params.ID}`, {
         type: 'quoteResponse',
-        data: ctx.request.body,
-        headers: ctx.request.headers
+        data: {
+            body: ctx.request.body,
+            headers: ctx.request.headers
+        }
     });
 
     // duplicate publication until legacy code refactored
     await QuotesModel.triggerDeferredJob({
         cache: ctx.state.cache,
-        message: ctx.request.body,
+        message: {
+            headers: ctx.request.headers,
+            body: ctx.request.body
+        },
         args: {
             quoteId: ctx.state.path.params.ID
         }
@@ -464,7 +469,10 @@ const putQuotesByIdError = async (ctx) => {
     // publish an event onto the cache for subscribers to action
     await ctx.state.cache.publish(`qt_${ctx.state.path.params.ID}`, {
         type: 'quoteResponseError',
-        data: ctx.request.body
+        data: {
+            body: ctx.request.body,
+            headers: ctx.request.headers
+        }
     });
 
     // duplicate publication until legacy code refactored
@@ -524,8 +532,10 @@ const putTransactionRequestsById = async (ctx) => {
     // publish an event onto the cache for subscribers to action
     await ctx.state.cache.publish(`txnreq_${ctx.state.path.params.ID}`, {
         type: 'transactionRequestResponse',
-        data: ctx.request.body,
-        headers: ctx.request.headers
+        data: {
+            body: ctx.request.body,
+            headers: ctx.request.headers
+        }
     });
 
     ctx.response.status = 200;
@@ -541,12 +551,18 @@ const putTransfersById = async (ctx) => {
     // publish an event onto the cache for subscribers to action
     await ctx.state.cache.publish(`tf_${ctx.state.path.params.ID}`, {
         type: 'transferFulfil',
-        data: ctx.request.body
+        data: {
+            body: ctx.request.body,
+            headers: ctx.request.headers
+        }
     });
 
     await TransfersModel.triggerDeferredJob({
         cache: ctx.state.cache,
-        message: ctx.request.body,
+        message: {
+            body: ctx.request.body,
+            headers: ctx.request.headers
+        },
         args: {
             transferId: ctx.state.path.params.ID,
         }
@@ -583,6 +599,35 @@ const patchTransfersById = async (ctx) => {
         log('Inbound transfers model handled PATCH /transfers/{ID} request');
 };
 
+/**
+ * Handles a PUT /parties/{Type}/{ID}/error request. This is an error response to a GET /parties/{Type}/{ID} request
+ */
+const putPartiesByTypeAndIdError = async(ctx) => {
+    const idType = ctx.state.path.params.Type;
+    const idValue = ctx.state.path.params.ID;
+    const idSubValue = ctx.state.path.params.SubId;
+
+    // publish an event onto the cache for subscribers to action
+    // note that we publish the event the same way we publish a success PUT
+    // the subscriber will notice the body contains an errorInformation property
+    // and recognizes it as an error response
+    await PartiesModel.triggerDeferredJob({
+        cache: ctx.state.cache,
+        message: {
+            headers: ctx.request.headers,
+            body: ctx.request.body
+        },
+        args: {
+            type: idType,
+            id: idValue,
+            subId: idSubValue
+        }
+    });
+
+    ctx.response.status = 200;
+    ctx.response.body = '';
+};
+
 /**
  * Handles a PUT /transfers/{ID}/error. This is an error response to a POST /transfers request
  */
@@ -593,12 +638,18 @@ const putTransfersByIdError = async (ctx) => {
     // publish an event onto the cache for subscribers to action
     await ctx.state.cache.publish(`tf_${ctx.state.path.params.ID}`, {
         type: 'transferError',
-        data: ctx.request.body
+        data: {
+            body: ctx.request.body,
+            headers: ctx.request.headers
+        }
     });
 
     await TransfersModel.triggerDeferredJob({
         cache: ctx.state.cache,
-        message: ctx.request.body,
+        message: {
+            body: ctx.request.body,
+            headers: ctx.request.headers
+        },
         args: {
             transferId: ctx.state.path.params.ID,
         }
@@ -686,8 +737,10 @@ const putBulkQuotesById = async (ctx) => {
     // publish an event onto the cache for subscribers to action
     await ctx.state.cache.publish(`bulkQuotes_${ctx.state.path.params.ID}`, {
         type: 'bulkQuoteResponse',
-        data: ctx.request.body,
-        headers: ctx.request.headers
+        data: {
+            body: ctx.request.body,
+            headers: ctx.request.headers
+        }
     });
 
     ctx.response.status = 200;
@@ -700,7 +753,10 @@ const putBulkQuotesByIdError = async(ctx) => {
     // publish an event onto the cache for subscribers to action
     await ctx.state.cache.publish(`bulkQuotes_${ctx.state.path.params.ID}`, {
         type: 'bulkQuoteResponseError',
-        data: ctx.request.body
+        data: {
+            body: ctx.request.body,
+            headers: ctx.request.headers
+        }
     });
 
     ctx.response.status = 200;
@@ -785,8 +841,10 @@ const putBulkTransfersById = async (ctx) => {
     // publish an event onto the cache for subscribers to action
     await ctx.state.cache.publish(`bulkTransfer_${ctx.state.path.params.ID}`, {
         type: 'bulkTransferResponse',
-        data: ctx.request.body,
-        headers: ctx.request.headers
+        data: {
+            body: ctx.request.body,
+            headers: ctx.request.headers
+        }
     });
 
     ctx.response.status = 200;
@@ -799,13 +857,17 @@ const putBulkTransfersByIdError = async(ctx) => {
     // publish an event onto the cache for subscribers to action
     await ctx.state.cache.publish(`bulkTransfer_${ctx.state.path.params.ID}`, {
         type: 'bulkTransferResponseError',
-        data: ctx.request.body
+        data: {
+            body: ctx.request.body,
+            headers: ctx.request.headers
+        }
     });
 
     ctx.response.status = 200;
     ctx.response.body = '';
 };
 
+
 const healthCheck = async(ctx) => {
     ctx.response.status = 200;
     ctx.response.body = '';

package/src/OutboundServer/api.yaml

@@ -1002,6 +1002,12 @@ components:
           $ref: '#/components/schemas/extensionListEmptiable'
         transferRequestExtensions:
           $ref: '#/components/schemas/extensionListEmptiable'
+        skipPartyLookup:
+          description: >-
+            Set to true if supplying an FSPID for the payee party and no party
+            resolution is needed. This may be useful is a previous party
+            resolution has been performed.
+          type: boolean
     CorrelationId:
       title: CorrelationId
       type: string
@@ -1273,8 +1279,24 @@ components:
           $ref: '#/components/schemas/transferStatus'
         quoteId:
           $ref: '#/components/schemas/CorrelationId'
+        getPartiesResponse:
+          type: object
+          required:
+            - body
+          properties:
+            body:
+              type: object
+            headers:
+              type: object
         quoteResponse:
-          $ref: '#/components/schemas/QuotesIDPutResponse'
+          type: object
+          required:
+            - body
+          properties:
+            body:
+              $ref: '#/components/schemas/QuotesIDPutResponse'
+            headers:
+              type: object
         quoteResponseSource:
           type: string
           description: >
@@ -1283,7 +1305,14 @@ components:
             account in the case of a FOREX transfer. i.e. it may be a FOREX
             gateway.
         fulfil:
-          $ref: '#/components/schemas/TransfersIDPutResponse'
+          type: object
+          required:
+            - body
+          properties:
+            body:
+              $ref: '#/components/schemas/TransfersIDPutResponse'
+            headers:
+              type: object
         lastError:
           description: >
             Object representing the last error to occur during a transfer
@@ -1291,6 +1320,12 @@ components:
             entity in the scheme or an object representing other types of error
             e.g. exceptions that may occur inside the scheme adapter.
           $ref: '#/components/schemas/transferError'
+        skipPartyLookup:
+          description: >-
+            Set to true if supplying an FSPID for the payee party and no party
+            resolution is needed. This may be useful is a previous party
+            resolution has been performed.
+          type: boolean
     errorResponse:
       type: object
       properties:
@@ -1321,7 +1356,14 @@ components:
         currentState:
           $ref: '#/components/schemas/transferStatus'
         fulfil:
-          $ref: '#/components/schemas/TransfersIDPutResponse'
+          type: object
+          required:
+            - body
+          properties:
+            body:
+              $ref: '#/components/schemas/TransfersIDPutResponse'
+            headers:
+              type: object
     transferContinuationAcceptParty:
       type: object
       required:
@@ -1993,6 +2035,15 @@ components:
           $ref: '#/components/schemas/accountsCreationState'
         lastError:
           $ref: '#/components/schemas/transferError'
+        postAccountsResponse:
+          type: object
+          required:
+            - body
+          properties:
+            body:
+              type: object
+            headers:
+              type: object
     errorAccountsResponse:
       allOf:
         - $ref: '#/components/schemas/errorResponse'

package/src/OutboundServer/api_interfaces/openapi.d.ts

@@ -633,6 +633,8 @@ export interface components {
       note?: components["schemas"]["Note"];
       quoteRequestExtensions?: components["schemas"]["extensionListEmptiable"];
       transferRequestExtensions?: components["schemas"]["extensionListEmptiable"];
+      /** Set to true if supplying an FSPID for the payee party and no party resolution is needed. This may be useful is a previous party resolution has been performed. */
+      skipPartyLookup?: boolean;
     };
     /** Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘). */
     CorrelationId: string;
@@ -728,12 +730,24 @@ export interface components {
       note?: components["schemas"]["Note"];
       currentState?: components["schemas"]["transferStatus"];
       quoteId?: components["schemas"]["CorrelationId"];
-      quoteResponse?: components["schemas"]["QuotesIDPutResponse"];
+      getPartiesResponse?: {
+        body: { [key: string]: unknown };
+        headers?: { [key: string]: unknown };
+      };
+      quoteResponse?: {
+        body: components["schemas"]["QuotesIDPutResponse"];
+        headers?: { [key: string]: unknown };
+      };
       /** FSPID of the entity that supplied the quote response. This may not be the same as the FSPID of the entity which owns the end user account in the case of a FOREX transfer. i.e. it may be a FOREX gateway. */
       quoteResponseSource?: string;
-      fulfil?: components["schemas"]["TransfersIDPutResponse"];
+      fulfil?: {
+        body: components["schemas"]["TransfersIDPutResponse"];
+        headers?: { [key: string]: unknown };
+      };
       /** Object representing the last error to occur during a transfer process. This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter. */
       lastError?: components["schemas"]["transferError"];
+      /** Set to true if supplying an FSPID for the payee party and no party resolution is needed. This may be useful is a previous party resolution has been performed. */
+      skipPartyLookup?: boolean;
     };
     errorResponse: {
       /** Error code as string. */
@@ -747,7 +761,10 @@ export interface components {
     transferStatusResponse: {
       transferId: components["schemas"]["CorrelationId"];
       currentState: components["schemas"]["transferStatus"];
-      fulfil: components["schemas"]["TransfersIDPutResponse"];
+      fulfil: {
+        body: components["schemas"]["TransfersIDPutResponse"];
+        headers?: { [key: string]: unknown };
+      };
     };
     transferContinuationAcceptParty: {
       acceptParty: true;
@@ -1011,6 +1028,10 @@ export interface components {
       response?: components["schemas"]["accountCreationStatus"];
       currentState?: components["schemas"]["accountsCreationState"];
       lastError?: components["schemas"]["transferError"];
+      postAccountsResponse?: {
+        body: { [key: string]: unknown };
+        headers?: { [key: string]: unknown };
+      };
     };
     errorAccountsResponse: components["schemas"]["errorResponse"] & {
       executionState: components["schemas"]["accountsResponse"];

package/src/OutboundServer/api_template/components/schemas/accountsResponse.yaml

@@ -13,3 +13,12 @@ properties:
     $ref: ./accountsCreationState.yaml
   lastError:
     $ref: ./transferError.yaml
+  postAccountsResponse:
+    type: object
+    required:
+      - body
+    properties:
+      body:
+        type: object
+      headers:
+        type: object

package/src/OutboundServer/api_template/components/schemas/transferRequest.yaml

@@ -35,3 +35,6 @@ properties:
     $ref: ./extensionListEmptiable.yaml
   transferRequestExtensions:
     $ref: ./extensionListEmptiable.yaml
+  skipPartyLookup:
+    description: Set to true if supplying an FSPID for the payee party and no party resolution is needed. This may be useful is a previous party resolution has been performed.
+    type: boolean

package/src/OutboundServer/api_template/components/schemas/transferResponse.yaml

@@ -39,8 +39,24 @@ properties:
   quoteId:
     $ref: >-
       ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/CorrelationId.yaml
+  getPartiesResponse:
+    type: object
+    required:
+      - body
+    properties:
+      body:
+        type: object
+      headers:
+        type: object
   quoteResponse:
-    $ref: ./quote.yaml
+    type: object
+    required:
+      - body
+    properties:
+      body:
+        $ref: './quote.yaml'
+      headers:
+        type: object
   quoteResponseSource:
     type: string
     description: >
@@ -48,7 +64,14 @@ properties:
       same as the FSPID of the entity which owns the end user account in the
       case of a FOREX transfer. i.e. it may be a FOREX gateway.
   fulfil:
-    $ref: ./transferFulfilment.yaml
+      type: object
+      required:
+        - body
+      properties:
+        body:
+          $ref: ./transferFulfilment.yaml
+        headers:
+          type: object
   lastError:
     description: >
       Object representing the last error to occur during a transfer process.
@@ -56,3 +79,6 @@ properties:
       scheme or an object representing other types of error e.g. exceptions that
       may occur inside the scheme adapter.
     $ref: ./transferError.yaml
+  skipPartyLookup:
+    description: Set to true if supplying an FSPID for the payee party and no party resolution is needed. This may be useful is a previous party resolution has been performed.
+    type: boolean

package/src/OutboundServer/api_template/components/schemas/transferStatusResponse.yaml

@@ -10,4 +10,11 @@ properties:
   currentState:
     $ref: ./transferStatus.yaml
   fulfil:
-    $ref: ./transferFulfilment.yaml
+      type: object
+      required:
+        - body
+      properties:
+        body:
+          $ref: ./transferFulfilment.yaml
+        headers:
+          type: object

package/src/OutboundServer/handlers.js

@@ -112,6 +112,7 @@ const postTransfers = async (ctx) => {
             cache: ctx.state.cache,
             logger: ctx.state.logger,
             wso2: ctx.state.wso2,
+            metricsClient: ctx.state.metricsClient,
         });
 
         // initialize the transfer model and start it running
@@ -144,6 +145,7 @@ const getTransfers = async (ctx) => {
             cache: ctx.state.cache,
             logger: ctx.state.logger,
             wso2: ctx.state.wso2,
+            metricsClient: ctx.state.metricsClient,
         });
 
         // initialize the transfer model and start it running
@@ -172,6 +174,7 @@ const putTransfers = async (ctx) => {
             cache: ctx.state.cache,
             logger: ctx.state.logger,
             wso2: ctx.state.wso2,
+            metricsClient: ctx.state.metricsClient,
         });
 
         // TODO: check the incoming body to reject party or quote when requested to do so
@@ -179,7 +182,7 @@ const putTransfers = async (ctx) => {
         // load the transfer model from cache and start it running again
         await model.load(ctx.state.path.params.transferId);
 
-        const response = await model.run();
+        const response = await model.run(ctx.request.body);
 
         // return the result
         ctx.response.status = 200;

package/src/OutboundServer/index.js

@@ -28,12 +28,13 @@ const middlewares = require('./middlewares');
 const endpointRegex = /\/.*/g;
 
 class OutboundApi extends EventEmitter {
-    constructor(conf, logger, cache, validator) {
+    constructor(conf, logger, cache, validator, metricsClient) {
         super({ captureExceptions: true });
         this._logger = logger;
         this._api = new Koa();
         this._conf = conf;
         this._cache = cache;
+        this._metricsClient = metricsClient;
 
         this._wso2 = {
             auth: new WSO2Auth({
@@ -54,7 +55,7 @@ class OutboundApi extends EventEmitter {
         this._api.use(middlewares.createErrorHandler(this._logger));
         this._api.use(middlewares.createRequestIdGenerator());
         this._api.use(koaBody()); // outbound always expects application/json
-        this._api.use(middlewares.applyState({ cache, wso2: this._wso2, conf }));
+        this._api.use(middlewares.applyState({ cache, wso2: this._wso2, conf, metricsClient }));
         this._api.use(middlewares.createLogger(this._logger));
 
         //Note that we strip off any path on peerEndpoint config after the origin.
@@ -91,7 +92,7 @@ class OutboundApi extends EventEmitter {
 }
 
 class OutboundServer extends EventEmitter {
-    constructor(conf, logger, cache) {
+    constructor(conf, logger, cache, metricsClient) {
         super({ captureExceptions: true });
         this._validator = new Validate();
         this._conf = conf;
@@ -101,7 +102,8 @@ class OutboundServer extends EventEmitter {
             conf,
             this._logger.push({ component: 'api' }),
             cache,
-            this._validator
+            this._validator,
+            metricsClient
         );
         this._api.on('error', (...args) => {
             this.emit('error', ...args);

package/src/config.js

@@ -182,5 +182,5 @@ module.exports = {
     // the `transactionId` to retrieve the quote from cache
     allowDifferentTransferTransactionId: env.get('ALLOW_DIFFERENT_TRANSFER_TRANSACTION_ID').default('false').asBool(),
 
-    pm4mlEnabled: env.get('PM4ML_ENABLED').default('false').asBool()
+    pm4mlEnabled: env.get('PM4ML_ENABLED').default('false').asBool(),
 };