@mojaloop/api-snippets 17.6.0 → 17.7.0-snapshot.1

package/lib/sdk-scheme-adapter/v2_1_0/outbound/openapi.d.ts

@@ -896,7 +896,7 @@ export interface components {
         }[];
         /**
          * CorrelationId
-         * @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](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 (‘-‘).
+         * @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
          */
         CorrelationId: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mojaloop/api-snippets",
-  "version": "17.6.0",
+  "version": "17.7.0-snapshot.1",
   "description": "Mojaloop API specification reusable snippets",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -94,14 +94,14 @@
     "@types/responselike": "^1.0.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "^19.4.1",
-    "@commitlint/config-conventional": "^19.4.1",
+    "@commitlint/cli": "^19.5.0",
+    "@commitlint/config-conventional": "^19.5.0",
     "@redocly/openapi-cli": "^1.0.0-beta.95",
     "@redocly/cli": "^1.5.0",
-    "@types/jest": "^29.5.12",
+    "@types/jest": "^29.5.13",
     "@types/js-yaml": "^4.0.9",
-    "@typescript-eslint/eslint-plugin": "^8.4.0",
-    "@typescript-eslint/parser": "^8.4.0",
+    "@typescript-eslint/eslint-plugin": "^8.6.0",
+    "@typescript-eslint/parser": "^8.6.0",
     "audit-ci": "^7.1.0",
     "browser-sync": "^3.0.2",
     "diff": "^7.0.0",
@@ -115,11 +115,11 @@
     "eslint-plugin-prettier": "^5.2.1",
     "eslint-plugin-promise": "^6.2.0",
     "eslint-plugin-standard": "^5.0.0",
-    "husky": "9.1.5",
+    "husky": "9.1.6",
     "jest": "^29.7.0",
     "jest-junit": "^16.0.0",
     "lint-staged": "^15.2.10",
-    "npm-check-updates": "^17.1.1",
+    "npm-check-updates": "^17.1.2",
     "prettier": "^3.3.3",
     "standard-version": "^9.5.0",
     "swagger-cli": "^4.0.4",

package/sdk-bulk.yaml

@@ -952,15 +952,11 @@ components:
     CorrelationId:
       title: CorrelationId
       type: string
-      pattern: >-
-        ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
-      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](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 (‘-‘).
+      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
     transferStatus:
       type: string

package/sdk-scheme-adapter/v2_1_0/backend/openapi.yaml

@@ -603,8 +603,8 @@ components:
         - RECEIVE
       type: string
     bulkQuoteId:
-      description: A Mojaloop API bulk quote identifier (UUID).
-      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+      description: A Mojaloop API bulk quote identifier (UUID/ULID).
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}|[0-9A-HJKMNP-TV-Z]{26}$
       type: string
     bulkQuoteRequest:
       description: A request for a bulk quote.
@@ -649,8 +649,8 @@ components:
         - individualQuoteResults
       type: object
     bulkTransferId:
-      description: A Mojaloop API transfer identifier (UUID).
-      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+      description: A Mojaloop API transfer identifier (UUID/ULID).
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}|[0-9A-HJKMNP-TV-Z]{26}$
       type: string
     bulkTransferRequest:
       properties:
@@ -1092,8 +1092,8 @@ components:
         - DEVICE
       type: string
     quoteId:
-      description: A Mojaloop API quote identifier (UUID).
-      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+      description: A Mojaloop API quote identifier (UUID/ULID).
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}|[0-9A-HJKMNP-TV-Z]{26}$
       type: string
     quoteRequest:
       description: A request for a quote for transfer from the DFSP backend.
@@ -1213,7 +1213,7 @@ components:
       type: string
     transactionId:
       description: ID of the transaction, the ID is decided by the Payer FSP during the creation of the quote.
-      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}|[0-9A-HJKMNP-TV-Z]{26}$
       type: string
     transactionRequest:
       description: A request for a pull based transfer.
@@ -1258,8 +1258,8 @@ components:
         - initiatorType
       type: object
     transactionRequestId:
-      description: A Mojaloop API transaction request identifier (UUID).
-      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+      description: A Mojaloop API transaction request identifier (UUID/ULID).
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}|[0-9A-HJKMNP-TV-Z]{26}$
       type: string
     transactionRequestResponse:
       description: A response to a request for a quote.
@@ -1352,8 +1352,8 @@ components:
         - timestamp
       type: object
     transferId:
-      description: A Mojaloop API transfer identifier (UUID).
-      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+      description: A Mojaloop API transfer identifier (UUID/ULID).
+      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}|[0-9A-HJKMNP-TV-Z]{26}$
       type: string
     transferParty:
       properties:

package/sdk-scheme-adapter/v2_1_0/components/schemas/CorrelationId.yaml

@@ -1,10 +1,9 @@
 title: CorrelationId
 type: string
-pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
+pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][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 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 (‘-‘).
+  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

package/thirdparty/v1_0/openapi3/thirdparty-dfsp-api.yaml

@@ -260,8 +260,11 @@ paths:
                 consentRequestId:
                   title: CorrelationId
                   type: string
-                  pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$'
-                  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](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 (‘-‘).'
+                  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
                 userId:
                   type: string
@@ -1129,7 +1132,7 @@ paths:
                           title: FIDOPublicKeyCredentialAttestation
                           type: object
                           description: |
-                            A data model representing a FIDO Attestation result. Derived from 
+                            A data model representing a FIDO Attestation result. Derived from
                             [`PublicKeyCredential` Interface](https://w3c.github.io/webauthn/#iface-pkcredential).
 
                             The `PublicKeyCredential` interface represents the below fields with
@@ -1852,7 +1855,7 @@ paths:
                             [RFC 3696](https://tools.ietf.org/html/rfc3696).
                             - PERSONAL_ID - A personal identifier is used as reference to a participant.
                             Examples of personal identification are passport number, birth certificate
-                            number, and national registration number. The identifier number is added in 
+                            number, and national registration number. The identifier number is added in
                             the PartyIdentifier element. The personal identifier type is added in the
                             PartySubIdOrType element.
                             - BUSINESS - A specific Business (for example, an organization or a company)
@@ -1876,12 +1879,12 @@ paths:
                             PartySubIdOrType element for identifying an account under an Alias defined
                             by the PartyIdentifier.
                             - CONSENT - A Consent represents an agreement between a PISP, a Customer and
-                            a DFSP which allows the PISP permission to perform actions on behalf of the 
-                            customer. A Consent has an authoritative source: either the DFSP who issued 
+                            a DFSP which allows the PISP permission to perform actions on behalf of the
+                            customer. A Consent has an authoritative source: either the DFSP who issued
                             the Consent, or an Auth Service which administers the Consent.
                             - THIRD_PARTY_LINK - A Third Party Link represents an agreement between a PISP,
-                            a DFSP, and a specific Customer's account at the DFSP. The content of the link 
-                            is created by the DFSP at the time when it gives permission to the PISP for 
+                            a DFSP, and a specific Customer's account at the DFSP. The content of the link
+                            is created by the DFSP at the time when it gives permission to the PISP for
                             specific access to a given account.
                           example: PERSONAL_ID
                         partyIdentifier:

package/thirdparty/v1_0/openapi3/thirdparty-pisp-api.yaml

@@ -254,8 +254,11 @@ paths:
                 consentRequestId:
                   title: CorrelationId
                   type: string
-                  pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$'
-                  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](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 (‘-‘).'
+                  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
                 userId:
                   type: string
@@ -976,7 +979,7 @@ paths:
                           title: FIDOPublicKeyCredentialAttestation
                           type: object
                           description: |
-                            A data model representing a FIDO Attestation result. Derived from 
+                            A data model representing a FIDO Attestation result. Derived from
                             [`PublicKeyCredential` Interface](https://w3c.github.io/webauthn/#iface-pkcredential).
 
                             The `PublicKeyCredential` interface represents the below fields with
@@ -1732,7 +1735,7 @@ paths:
                             [RFC 3696](https://tools.ietf.org/html/rfc3696).
                             - PERSONAL_ID - A personal identifier is used as reference to a participant.
                             Examples of personal identification are passport number, birth certificate
-                            number, and national registration number. The identifier number is added in 
+                            number, and national registration number. The identifier number is added in
                             the PartyIdentifier element. The personal identifier type is added in the
                             PartySubIdOrType element.
                             - BUSINESS - A specific Business (for example, an organization or a company)
@@ -1756,12 +1759,12 @@ paths:
                             PartySubIdOrType element for identifying an account under an Alias defined
                             by the PartyIdentifier.
                             - CONSENT - A Consent represents an agreement between a PISP, a Customer and
-                            a DFSP which allows the PISP permission to perform actions on behalf of the 
-                            customer. A Consent has an authoritative source: either the DFSP who issued 
+                            a DFSP which allows the PISP permission to perform actions on behalf of the
+                            customer. A Consent has an authoritative source: either the DFSP who issued
                             the Consent, or an Auth Service which administers the Consent.
                             - THIRD_PARTY_LINK - A Third Party Link represents an agreement between a PISP,
-                            a DFSP, and a specific Customer's account at the DFSP. The content of the link 
-                            is created by the DFSP at the time when it gives permission to the PISP for 
+                            a DFSP, and a specific Customer's account at the DFSP. The content of the link
+                            is created by the DFSP at the time when it gives permission to the PISP for
                             specific access to a given account.
                           example: PERSONAL_ID
                         partyIdentifier: