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

package/.circleci/config.yml

@@ -48,7 +48,7 @@ defaults_npm_publish_release: &defaults_npm_publish_release
 defaults_export_version_from_package: &defaults_export_version_from_package
   name: Format the changelog into the github release body and get release tag
   command: |
-    git diff --no-indent-heuristic master~1 HEAD CHANGELOG.md | sed -n '/^+[^+]/ s/^+//p' > /tmp/changes
+    git diff --no-indent-heuristic main~1 HEAD CHANGELOG.md | sed -n '/^+[^+]/ s/^+//p' > /tmp/changes
     echo 'export RELEASE_CHANGES=`cat /tmp/changes`' >> $BASH_ENV
     echo 'export RELEASE_TAG=`cat package-lock.json | jq -r .version`' >> $BASH_ENV
 
@@ -512,7 +512,7 @@ workflows:
               ignore:
                 - /feature*/
                 - /bugfix*/
-      # New commits to master release automatically
+      # New commits to main release automatically
       - release:
           context: org-global
           requires:
@@ -526,7 +526,7 @@ workflows:
           filters:
             branches:
               only:
-                - master
+                - main
                 - /release\/v.*/
       - github-release:
           context: org-global
@@ -535,7 +535,7 @@ workflows:
           filters:
             branches:
               only:
-                - master
+                - main
                 - /release\/v.*/
       - publish:
           context: org-global

package/.versionrc

@@ -0,0 +1,15 @@
+{
+  "types": [
+    {"type": "feat", "section": "Features"},
+    {"type": "fix", "section": "Bug Fixes"},
+    {"type": "docs", "section": "Documentation"},
+    {"type": "style", "section": "Styling"},
+    {"type": "refactor", "section": "Refactors"},
+    {"type": "perf", "section": "Performance"},
+    {"type": "test", "section": "Tests"},
+    {"type": "build", "section": "Build System"},
+    {"type": "ci", "section": "CI"},
+    {"type": "chore", "section": "Chore"},
+    {"type": "revert", "section": "Reverts"}
+  ]
+}

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 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.1.1](https://github.com/mojaloop/central-services-shared/compare/v18.1.0...v18.1.1) (2023-09-12)
+
+
+### Chore
+
+* migrate master to main ([#352](https://github.com/mojaloop/central-services-shared/issues/352)) ([80aeece](https://github.com/mojaloop/central-services-shared/commit/80aeecee5657ddb2243b18536d1045efb044bb17))
+
 ## [18.1.0](https://github.com/mojaloop/central-services-shared/compare/v18.0.0...v18.1.0) (2023-09-06)
 
 

package/README.md

@@ -1,5 +1,5 @@
 # central-services-shared
-[![Git Commit](https://img.shields.io/github/last-commit/mojaloop/central-services-shared.svg?style=flat)](https://github.com/mojaloop/central-services-shared/commits/master)
+[![Git Commit](https://img.shields.io/github/last-commit/mojaloop/central-services-shared.svg?style=flat)](https://github.com/mojaloop/central-services-shared/commits/main)
 [![Git Releases](https://img.shields.io/github/release/mojaloop/central-services-shared.svg?style=flat)](https://github.com/mojaloop/central-services-shared/releases)
 [![Npm Version](https://img.shields.io/npm/v/@mojaloop/central-services-shared.svg?style=flat)](https://www.npmjs.com/package/@mojaloop/central-services-shared)
 [![NPM Vulnerabilities](https://img.shields.io/snyk/vulnerabilities/npm/@mojaloop/central-services-shared.svg?style=flat)](https://www.npmjs.com/package/@mojaloop/central-services-shared)
@@ -31,26 +31,26 @@ As part of our CI/CD process, we use a combination of CircleCI, standard-version
 npm package and github-release CircleCI orb to automatically trigger our releases
 and image builds. This process essentially mimics a manual tag and release.
 
-On a merge to master, CircleCI is configured to use the mojaloopci github account
+On a merge to main, CircleCI is configured to use the mojaloopci github account
 to push the latest generated CHANGELOG and package version number.
 
-Once those changes are pushed, CircleCI will pull the updated master, tag and
+Once those changes are pushed, CircleCI will pull the updated main, tag and
 push a release triggering another subsequent build that also publishes a docker image.
 
 ### Potential problems
 
-* There is a case where the merge to master workflow will resolve successfully, triggering
+* There is a case where the merge to main workflow will resolve successfully, triggering
   a release. Then that tagged release workflow subsequently failing due to the image scan,
   audit check, vulnerability check or other "live" checks.
 
-  This will leave master without an associated published build. Fixes that require
+  This will leave main without an associated published build. Fixes that require
   a new merge will essentially cause a skip in version number or require a clean up
-  of the master branch to the commit before the CHANGELOG and bump.
+  of the main branch to the commit before the CHANGELOG and bump.
 
   This may be resolved by relying solely on the previous checks of the
-  merge to master workflow to assume that our tagged release is of sound quality.
+  merge to main workflow to assume that our tagged release is of sound quality.
   We are still mulling over this solution since catching bugs/vulnerabilities/etc earlier
   is a boon.
 
-* It is unknown if a race condition might occur with multiple merges with master in
+* It is unknown if a race condition might occur with multiple merges with main in
   quick succession, but this is a suspected edge case.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mojaloop/central-services-shared",
-  "version": "18.1.0",
+  "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.2",
+    "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
  */