b2b-platform-utils 1.1.5 → 1.1.6

package/localCache.js

@@ -6,6 +6,7 @@
  * Process-scoped in-memory key-value store for configuration.
  * - Backward compatible with existing API surface.
  * - Adds currency helpers with explicit opt-in ENV fallback.
+ * - Provides default GEO and Locale helpers for runtime consumers.
  *
  * Design goals:
  * 1) No side effects on import (ENV is read lazily, only if enabled).
@@ -27,6 +28,9 @@ let bufferChunkSize = 512000;
 /** @type {string} */
 const GEO_DEFAULT = 'WW';
 
+/** @type {string} */
+const LOCALE_DEFAULT = 'en-US';
+
 /** @type {boolean} */
 let envBaseCurrencyFallbackEnabled = false; // opt-in per process
 
@@ -46,6 +50,7 @@ function ensureCommonBag() {
 /**
  * Normalize to a 3-letter uppercase currency code.
  * Returns null if invalid.
+ *
  * @param {unknown} value
  * @returns {string|null}
  */
@@ -59,6 +64,7 @@ function normalizeCurrencyCode(value) {
 
 /**
  * Set a top-level key in the cache.
+ *
  * @param {string} key
  * @param {any} value
  */
@@ -68,6 +74,7 @@ function setValue(key, value) {
 
 /**
  * Get a top-level value from the cache.
+ *
  * @param {string} key
  * @returns {any|null}
  */
@@ -79,6 +86,7 @@ function getValue(key) {
 
 /**
  * Shallow-merge a config object into the cache.
+ *
  * @param {Record<string, any>} data
  */
 function applyConfig(data) {
@@ -91,6 +99,7 @@ function applyConfig(data) {
 
 /**
  * Return a direct reference to the whole cache (mutable).
+ *
  * @returns {Record<string, any>}
  */
 function getData() {
@@ -101,6 +110,7 @@ function getData() {
 
 /**
  * Return current microservice key.
+ *
  * @returns {string}
  */
 function getService() {
@@ -109,6 +119,7 @@ function getService() {
 
 /**
  * Override microservice key at runtime.
+ *
  * @param {string} key
  */
 function setService(key) {
@@ -119,6 +130,7 @@ function setService(key) {
 
 /**
  * Get configured buffer chunk size.
+ *
  * @returns {number}
  */
 function getBufferChunkSize() {
@@ -128,6 +140,7 @@ function getBufferChunkSize() {
 /**
  * Initialize environment/customer from process params.
  * Kept for compatibility with existing bootstrap flows.
+ *
  * @param {string[]} params
  */
 function parseInitConfig(params) {
@@ -139,6 +152,7 @@ function parseInitConfig(params) {
 
 /**
  * Return the "common" bag snapshot ({} if missing).
+ *
  * @returns {Record<string, any>}
  */
 function getCommonValue() {
@@ -151,16 +165,28 @@ function getCommonValue() {
 
 /**
  * Read GEODefault from "common" or return fallback.
+ *
  * @returns {string}
  */
 function getDefaultGEO() {
     return getValue('common')?.GEODefault || GEO_DEFAULT;
 }
 
+/**
+ * Read LocaleDefault from "common" or return fallback.
+ * Locale codes must follow the pattern: en-US, de-DE, pt-BR etc.
+ *
+ * @returns {string}
+ */
+function getDefaultLocale() {
+    return getValue('common')?.LocaleDefault || LOCALE_DEFAULT;
+}
+
 /**
  * Enable or disable ENV fallback for BaseCurrency.
  * When enabled and "common.BaseCurrency" is not set,
  * getBaseCurrency() will use process.env.BASE_CURRENCY.
+ *
  * @param {boolean} enabled
  */
 function enableEnvBaseCurrencyFallback(enabled = true) {
@@ -170,6 +196,7 @@ function enableEnvBaseCurrencyFallback(enabled = true) {
 /**
  * Get BaseCurrency from "common", otherwise (optionally) from ENV.
  * Returns null if nothing is set or valid.
+ *
  * @returns {string|null}
  */
 function getBaseCurrency() {
@@ -190,6 +217,7 @@ function getBaseCurrency() {
 
 /**
  * Explicitly set BaseCurrency into the "common" bag.
+ *
  * @param {string} code - 3-letter code, e.g., "USD", "EUR", "GBP".
  * @throws {Error} If code is invalid.
  */
@@ -222,6 +250,7 @@ module.exports = {
 
     // Domain helpers
     getDefaultGEO,
+    getDefaultLocale,
 
     // Currency helpers
     getBaseCurrency,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "b2b-platform-utils",
-  "version": "1.1.5",
+  "version": "1.1.6",
   "description": "Shared utilities for Node.js microservices: errors map, local cache, logger, numbers, dates, filesystem, media optimization, paginator, slugger, crypto wrapper, sanitize HTML, sorting.",
   "type": "commonjs",
   "license": "KingSizer",