@mojaloop/central-services-shared 18.1.1 → 18.1.2-snapshot.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mojaloop/central-services-shared",
-  "version": "18.1.1",
+  "version": "18.1.2-snapshot.0",
   "description": "Shared code for mojaloop central services",
   "license": "Apache-2.0",
   "author": "ModusBox",
@@ -76,13 +76,13 @@
     "audit-ci": "^6.6.1",
     "base64url": "3.0.1",
     "chance": "1.1.11",
-    "npm-check-updates": "16.13.3",
+    "npm-check-updates": "16.14.2",
     "nyc": "15.1.0",
     "pre-commit": "1.2.2",
     "proxyquire": "2.1.3",
     "replace": "^1.2.2",
     "rewire": "7.0.0",
-    "sinon": "15.2.0",
+    "sinon": "16.0.0",
     "standard": "17.1.0",
     "standard-version": "9.5.0",
     "tap-spec": "^5.0.0",

package/src/util/kafka/index.js

@@ -159,8 +159,9 @@ const getKafkaConfig = (kafkaConfig, flow, functionality, action) => {
  * @param {string} participantName - The participant name
  * @param {string} functionality - the functionality flow. Example: 'transfer' ie: note the case of text
  * @param {string} action - the action that applies to the flow. Example: 'prepare' ie: note the case of text
- * @param {number} partition - optional partition to produce to
- * @param {*} opaqueKey - optional opaque token, which gets passed along to your delivery reports
+ * @param {string} [key] - optional key that allows partitioning it occur
+ * @param {number} [partition] - optional partition to produce to
+ * @param {*} [opaqueKey] - optional opaque token, which gets passed along to your delivery reports
  *
  * @returns {object} - Returns newly created participant topicConfig
  */
@@ -179,10 +180,10 @@ const createParticipantTopicConf = (template, participantName, functionality, ac
  * @param {string} template - The template for that needs to be populated
  * @param {string} functionality - the functionality flow. Example: 'transfer' ie: note the case of text
  * @param {string} action - the action that applies to the flow. Example: 'prepare' ie: note the case of text
- * @param {string} key - optional key that allows partitioning it occur
- * @param {number} partition - optional partition to produce to
- * @param {*} opaqueKey - optional opaque token, which gets passed along to your delivery reports
- * @param {string} topicNameOverride - optional topic name override that skips topic name rendering
+ * @param {string} [key] - optional key that allows partitioning it occur
+ * @param {number} [partition] - optional partition to produce to
+ * @param {*} [opaqueKey] - optional opaque token, which gets passed along to your delivery reports
+ * @param {string} [topicNameOverride] - optional topic name override that skips topic name rendering
  *
  * @returns {object} - Returns newly created general topicConfig
  */
@@ -222,9 +223,9 @@ const getFunctionalityAction = (functionality, action) => {
  * @param {string} action - the action that applies to the flow. Example: 'prepare' ie: note the case of text
  * @param {object} message - a list of messages to consume for the relevant topic
  * @param {object} state - state of the message being produced
- * @param {string} key - optional key that allows partitioning it occur
- * @param {object} span - the span for event logging
- * @param {string} topicNameOverride - optional topic name override that skips topic name rendering
+ * @param {string} [key] - optional key that allows partitioning it occur
+ * @param {object} [span] - the span for event logging
+ * @param {string} [topicNameOverride] - optional topic name override that skips topic name rendering
  *
  * @returns {object} - Returns a boolean: true if successful, or throws and error if failed
  */