@bigbinary/neeto-commons-frontend 2.1.26 → 2.1.28

package/utils.d.ts

@@ -421,4 +421,48 @@ export function getFromLocalStorage<T extends object>(key: string): T | null;
  * setToLocalStorage("token", "1234-5678-9101-1213");
  * @endexample
 */
-export function setToLocalStorage(key: string, value: any): void;
+export function setToLocalStorage(key: string, value: any): void;
+type CurrencyFormatterFunction = (amount: number | string, currency: string, options?: Intl.NumberFormatOptions) => string;
+/**
+ *
+ * currencyFormat is a utility which provides functions which formats a given
+ *
+ * number in currency formats based on the current user locale. Current user locale
+ *
+ * is based on dayjs.locale().
+ *
+ * withAmount accepts two arguments:
+ *
+ * All other functions accept three arguments:
+ *
+ * @example 
+ *
+ * import { currencyFormat } from "neetocommons/utils";
+ * 
+ * currencyFormat.withAmount(1000); // In `en` locale, returns "1,000.00"
+ * currencyFormat.withAmount(125, { maximumFractionDigits: 1 }); // In `en` locale, returns "125.0"
+ * 
+ * currencyFormat.withSymbol(1000, "USD"); // In `en` locale, returns "$1,000.00"
+ * currencyFormat.withSymbol(125, "USD", { maximumFractionDigits: 1 }); // In `en` locale, returns "$125.0"
+ * 
+ * currencyFormat.withCode(1000, "USD"); // In `en` locale, returns "1,000.00 USD"
+ * currencyFormat.withCode(125, "USD", { maximumFractionDigits: 1 }); // In `en` locale, returns "125.0 USD"
+ * 
+ * currencyFormat.withSymbolAndCode(1000, "INR"); // In `en` locale, returns "₹1,000.00 INR"
+ * currencyFormat.withSymbolAndCode(125, "INR", {
+ *   maximumFractionDigits: 1,
+ * }); // In `en` locale, returns "₹125.0 INR"
+ * 
+ * // `fr`
+ * currencyFormat.withSymbolAndCode(1000, "EUR"); // In `fr` locale, returns "1 000 € EUR"
+ * currencyFormat.withSymbolAndCode(125, "INR", {
+ *   maximumFractionDigits: 1,
+ * }); // In `fr` locale, returns "125,00 ₹ INR""
+ * @endexample
+*/
+export const currencyFormat: {
+  withAmount: (amount: number | string, options?: Intl.NumberFormatOptions) => string;
+  withSymbol: CurrencyFormatterFunction;
+  withCode: CurrencyFormatterFunction;
+  withSymbolAndCode: CurrencyFormatterFunction;
+};

package/utils.js

@@ -2519,8 +2519,8 @@ var lib = {
 };
 
 var _this = undefined;
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+function ownKeys$1(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+function _objectSpread$1(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys$1(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys$1(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 var withEventTargetValue = /*#__PURE__*/curry(function (func, event) {
   return func(event.target.value);
 });
@@ -2538,7 +2538,7 @@ var simulateApiCall = function simulateApiCall(result, error) {
         success: false,
         notice: i18next.t("neetoCommons.notice.errorOccurred")
       };
-      Math.random() < errorProbability ? reject(_objectSpread(_objectSpread({}, defaultErrorObj), error)) : resolve(result);
+      Math.random() < errorProbability ? reject(_objectSpread$1(_objectSpread$1({}, defaultErrorObj), error)) : resolve(result);
     }, delay);
   });
 };
@@ -2615,7 +2615,7 @@ var toLocale = function toLocale(number) {
 };
 var getQueryParams = function getQueryParams() {
   var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-  return lib.parse(location.search, _objectSpread({
+  return lib.parse(location.search, _objectSpread$1({
     ignoreQueryPrefix: true
   }, options));
 };
@@ -3225,5 +3225,45 @@ var createSubscription = function createSubscription(channelName, callbacks) {
   return subscription;
 };
 
-export { buildUrl, copyToClipboard, createSubscription, dateFormat, debounce, getFromLocalStorage, getQueryParams, getSubdomain, hasAllPermissions, hasAnyPermission, hasPermission, joinHyphenCase, resetAuthTokens, setToLocalStorage, simulateApiCall, timeFormat, toLocale, withEventTargetValue };
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+var getAmountWithSymbol = function getAmountWithSymbol(amount, options) {
+  var formatter = new Intl.NumberFormat(dayjs.locale(), _objectSpread({}, options));
+  return formatter.format(Number(amount));
+};
+var currencyFormat = {
+  withAmount: function withAmount(amount) {
+    var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {
+      minimumFractionDigits: 2
+    };
+    return getAmountWithSymbol(amount, _objectSpread({
+      style: undefined
+    }, options));
+  },
+  // 1000, { maximumFractionDigits: 1 } => 1,000.0
+  withSymbol: function withSymbol(amount, currency, options) {
+    return getAmountWithSymbol(amount, _objectSpread(_objectSpread({}, options), {}, {
+      style: "currency",
+      currency: currency
+    }));
+  },
+  // 1000, "INR", { maximumFractionDigits: 0 } => ₹1,000
+  withCode: function withCode(amount, currency) {
+    var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {
+      minimumFractionDigits: 2
+    };
+    return "".concat(getAmountWithSymbol(amount, _objectSpread(_objectSpread({}, options), {}, {
+      style: undefined
+    })), " ").concat(currency);
+  },
+  // 1000, "USD" => 1,000.00 USD
+  withSymbolAndCode: function withSymbolAndCode(amount, currency, options) {
+    return "".concat(getAmountWithSymbol(amount, _objectSpread(_objectSpread({}, options), {}, {
+      style: "currency",
+      currency: currency
+    })), " ").concat(currency);
+  } // 1000, "INR", { maximumFractionDigits: 0 } => ₹1,000 INR
+};
+
+export { buildUrl, copyToClipboard, createSubscription, currencyFormat, dateFormat, debounce, getFromLocalStorage, getQueryParams, getSubdomain, hasAllPermissions, hasAnyPermission, hasPermission, joinHyphenCase, resetAuthTokens, setToLocalStorage, simulateApiCall, timeFormat, toLocale, withEventTargetValue };
 //# sourceMappingURL=utils.js.map