@mojaloop/central-services-shared 18.8.0-snapshot.0 → 18.9.0

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [18.9.0](https://github.com/mojaloop/central-services-shared/compare/v18.8.0...v18.9.0) (2024-09-18)
+
+
+### Features
+
+* ulid generator ([#401](https://github.com/mojaloop/central-services-shared/issues/401)) ([080f55b](https://github.com/mojaloop/central-services-shared/commit/080f55b1f2782b4797f72ebfbe17d77a18094f2a))
+
+## [18.8.0](https://github.com/mojaloop/central-services-shared/compare/v18.7.6...v18.8.0) (2024-09-17)
+
+
+### Features
+
+* **csi/643:** add fx-notify event for patch fxTransfer updates ([#400](https://github.com/mojaloop/central-services-shared/issues/400)) ([8be247a](https://github.com/mojaloop/central-services-shared/commit/8be247a8b3258838fae590ea4572ef5f5237e5bb))
+
 ### [18.7.6](https://github.com/mojaloop/central-services-shared/compare/v18.7.5...v18.7.6) (2024-09-12)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mojaloop/central-services-shared",
-  "version": "18.8.0-snapshot.0",
+  "version": "18.9.0",
   "description": "Shared code for mojaloop central services",
   "license": "Apache-2.0",
   "author": "ModusBox",
@@ -71,6 +71,7 @@
     "rc": "1.2.8",
     "shins": "2.6.0",
     "uuid4": "2.0.3",
+    "ulidx": "2.4.1",
     "widdershins": "^4.0.1",
     "yaml": "2.5.1"
   },
@@ -80,7 +81,7 @@
     "audit-ci": "^7.1.0",
     "base64url": "3.0.1",
     "chance": "1.1.12",
-    "npm-check-updates": "17.1.1",
+    "npm-check-updates": "17.1.2",
     "nyc": "17.0.0",
     "pre-commit": "1.2.2",
     "proxyquire": "2.1.3",

package/src/util/id.js

@@ -24,6 +24,7 @@
  ******/
 
 const crypto = require('crypto')
+const { monotonicFactory, ulid } = require('ulidx')
 
 const generators = {
   // generate UUID compliant with https://datatracker.ietf.org/doc/html/rfc9562
@@ -34,7 +35,9 @@ const generators = {
       const random = crypto.randomUUID()
       return `${timestamp.substring(0, 8)}-${timestamp.substring(8, 12)}-7${random.substring(15, 36)}`
     }
-  })[version]
+  })[version],
+  // monotonic parameter ensures ULIDs are generated in order when called at the same or older seed millisecond
+  ulid: ({ monotonic = true }) => monotonic ? monotonicFactory() : ulid
 }
 
 module.exports = ({ type = 'uuid', ...config } = {}) => generators[type](config)

package/test/unit/util/id.test.js

@@ -27,6 +27,7 @@ const Test = require('tapes')(require('tape'))
 const Sinon = require('sinon')
 const idGenerator = require('../../../src/util/id')
 const uuidRegex = version => new RegExp(`[a-f0-9]{8}-[a-f0-9]{4}-${version}[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}`)
+const ulidRegex = /^[0-9A-HJKMNP-TV-Z]{26}$/
 
 Test('Id util', idTest => {
   let sandbox
@@ -52,6 +53,20 @@ Test('Id util', idTest => {
       test.match(uuid7(), uuidRegex(7))
       test.end()
     })
+    generateSha256Test.test('generate ULID monotonic by default', test => {
+      const ulid = idGenerator({ type: 'ulid' })
+      test.match(ulid(), ulidRegex)
+      const idList = Array.from({ length: 100 }, () => ulid())
+      test.ok(idList.slice().sort().join('') === idList.join(''), 'ULIDs should be monotonic')
+      test.end()
+    })
+    generateSha256Test.test('generate ULID non-monotonic', test => {
+      const ulid = idGenerator({ type: 'ulid', monotonic: false })
+      test.match(ulid(), ulidRegex)
+      const idList = Array.from({ length: 100 }, () => ulid())
+      test.ok(idList.slice().sort().join('') !== idList.join(''), 'ULIDs should not be monotonic')
+      test.end()
+    })
     generateSha256Test.test('generate UUID v7 by default', test => {
       const uuid = idGenerator()
       test.match(uuid(), uuidRegex(7))