account-lookup-service 15.6.0-iso.17 → 15.6.0-iso.18

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "account-lookup-service",
   "description": "Account Lookup Service is used to validate Party and Participant lookups.",
-  "version": "15.6.0-iso.17",
+  "version": "15.6.0-iso.18",
   "license": "Apache-2.0",
   "author": "ModusBox",
   "contributors": [
@@ -148,7 +148,7 @@
   "devDependencies": {
     "@types/jest": "29.5.14",
     "audit-ci": "^7.1.0",
-    "axios": "1.7.8",
+    "axios": "1.7.9",
     "axios-retry": "^4.5.0",
     "docdash": "2.0.2",
     "dotenv": "^16.4.7",

package/src/interface/api-swagger-iso20022-parties.yaml

@@ -890,13 +890,14 @@ components:
   schemas:
     CorrelationId:
       title: CorrelationId
-      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
       type: string
-      description: 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, that is restricted by a regular expression
-        for interoperability reasons. An UUID is always 36 characters long, 32 hexadecimal
-        symbols and 4 dashes (‘-‘).
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$|^[0-9A-HJKMNP-TV-Z]{26}$
+      description: >-
+        Identifier that correlates all messages of the same sequence.
+        The supported identifiers formats are for
+        lowercase [UUID](https://datatracker.ietf.org/doc/html/rfc9562) and
+        uppercase [ULID](https://github.com/ulid/spec)
+      example: 'b51ec534-ee48-4575-b6a9-ead2955b8069'
     Currency:
       title: CurrencyEnum
       maxLength: 3

package/src/interface/api-swagger.yaml

@@ -889,13 +889,14 @@ components:
   schemas:
     CorrelationId:
       title: CorrelationId
-      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
       type: string
-      description: 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, that is restricted by a regular expression
-        for interoperability reasons. An UUID is always 36 characters long, 32 hexadecimal
-        symbols and 4 dashes (‘-‘).
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$|^[0-9A-HJKMNP-TV-Z]{26}$
+      description: >-
+        Identifier that correlates all messages of the same sequence.
+        The supported identifiers formats are for
+        lowercase [UUID](https://datatracker.ietf.org/doc/html/rfc9562) and
+        uppercase [ULID](https://github.com/ulid/spec)
+      example: 'b51ec534-ee48-4575-b6a9-ead2955b8069'
     Currency:
       title: CurrencyEnum
       maxLength: 3

package/test/fixtures/index.js

@@ -9,14 +9,15 @@ const headersDto = ({
   destination = 'toDfsp',
   proxy = '',
   date = '2024-05-24 08:52:19',
-  accept
+  accept,
+  contentType
 } = {}) => Object.freeze({
   [Headers.FSPIOP.SOURCE]: source,
   ...(destination && { [Headers.FSPIOP.DESTINATION]: destination }),
   ...(proxy && { [Headers.FSPIOP.PROXY]: proxy }),
   date,
   accept,
-  'content-type': accept
+  'content-type': contentType || accept
 })
 
 const protocolVersionsDto = () => ({
@@ -40,22 +41,29 @@ const partiesCallHeadersDto = ({
   destination,
   proxy,
   date,
-  accept: 'application/vnd.interoperability.parties+json;version=1.1'
+  accept: interopHeader('parties', '1'),
+  contentType: interopHeader('parties', '1.1')
 })
 
 const participantsCallHeadersDto = ({
   source,
   destination,
   proxy,
-  date
+  date,
+  acceptVersion = '1',
+  contentTypeVersion = '1.1'
 } = {}) => headersDto({
   source,
   destination,
   proxy,
   date,
-  accept: 'application/vnd.interoperability.participants+json;version=1'
+  accept: interopHeader('participants', acceptVersion),
+  contentType: interopHeader('participants', contentTypeVersion)
 })
 
+// todo: add ISO mode support
+const interopHeader = (resource, version = '1') => `application/vnd.interoperability.${resource}+json;version=${version}`
+
 const oracleRequestResponseDto = ({
   partyList = [{ fspId: 'dfspFromOracle' }]
 } = {}) => ({
@@ -83,6 +91,20 @@ const putPartiesSuccessResponseDto = ({
   }
 })
 
+const postParticipantsPayloadDto = ({
+  requestId = randomUUID(), // '01JE8SG3F4WNHY8B9876THQ344',
+  partyList = [{
+    partyIdType: 'MSISDN',
+    partyIdentifier: '123456',
+    fspId: 'fspId123'
+  }],
+  currency = 'XXX'
+} = {}) => Object.freeze({
+  requestId,
+  partyList,
+  ...(currency && { currency })
+})
+
 const errorCallbackResponseDto = ({
   errorCode = '1234',
   errorDescription = 'Error description',
@@ -124,8 +146,10 @@ module.exports = {
   participantsCallHeadersDto,
   oracleRequestResponseDto,
   putPartiesSuccessResponseDto,
+  postParticipantsPayloadDto,
   errorCallbackResponseDto,
   mockAlsRequestDto,
   protocolVersionsDto,
-  mockHapiRequestDto
+  mockHapiRequestDto,
+  interopHeader
 }

package/test/unit/api/participants.test.js

@@ -36,6 +36,7 @@ const initServer = require('../../../src/server').initializeApi
 const Helper = require('../../util/helper')
 const Db = require('../../../src/lib/db')
 const Config = require('../../../src/lib/config')
+const fixtures = require('../../fixtures')
 
 Logger.isDebugEnabled = jest.fn(() => true)
 Logger.isErrorEnabled = jest.fn(() => true)
@@ -44,14 +45,14 @@ let sandbox
 let server
 
 describe('/participants', () => {
-  beforeEach(async () => {
+  beforeAll(async () => {
     sandbox = Sinon.createSandbox()
     sandbox.stub(Db, 'connect').returns(Promise.resolve({}))
     Config.API_PORT = await getPort()
     server = await initServer(Config)
   })
 
-  afterEach(async () => {
+  afterAll(async () => {
     await server.stop()
     sandbox.restore()
   })
@@ -103,6 +104,38 @@ describe('/participants', () => {
 
     // Assert
     expect(response.statusCode).toBe(400)
-    await server.stop()
+  })
+
+  it('should validate requestId in UUID format', async () => {
+    const reqOptions = {
+      method: 'post',
+      url: '/participants',
+      headers: fixtures.participantsCallHeadersDto(),
+      payload: fixtures.postParticipantsPayloadDto()
+    }
+    const response = await server.inject(reqOptions)
+    expect(response.statusCode).toBe(200)
+  })
+
+  it('should validate requestId in ULID format', async () => {
+    const reqOptions = {
+      method: 'post',
+      url: '/participants',
+      headers: fixtures.participantsCallHeadersDto(),
+      payload: fixtures.postParticipantsPayloadDto({ requestId: '01JE8SG3F4WNHY8B9876THQ344' })
+    }
+    const response = await server.inject(reqOptions)
+    expect(response.statusCode).toBe(200)
+  })
+
+  it('should fail requestId validation', async () => {
+    const reqOptions = {
+      method: 'post',
+      url: '/participants',
+      headers: fixtures.participantsCallHeadersDto(),
+      payload: fixtures.postParticipantsPayloadDto({ requestId: 'wrong format' })
+    }
+    const response = await server.inject(reqOptions)
+    expect(response.statusCode).toBe(400)
   })
 })