@cloudflare/util-formatters 2.6.13 → 2.7.1

package/CHANGELOG.md

@@ -3,6 +3,41 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.7.1](http://stash.cfops.it:7999/fe/stratus/compare/@cloudflare/util-formatters@2.7.0...@cloudflare/util-formatters@2.7.1) (2021-12-06)
+
+**Note:** Version bump only for package @cloudflare/util-formatters
+
+
+
+
+
+# [2.7.0](http://stash.cfops.it:7999/fe/stratus/compare/@cloudflare/util-formatters@2.6.15...@cloudflare/util-formatters@2.7.0) (2021-11-29)
+
+
+### Features
+
+* **stratus:** EW-5929 Integrate percentage view for chart legend ([7fecfd9](http://stash.cfops.it:7999/fe/stratus/commits/7fecfd9))
+
+
+
+
+
+## [2.6.15](http://stash.cfops.it:7999/fe/stratus/compare/@cloudflare/util-formatters@2.6.14...@cloudflare/util-formatters@2.6.15) (2021-11-23)
+
+**Note:** Version bump only for package @cloudflare/util-formatters
+
+
+
+
+
+## [2.6.14](http://stash.cfops.it:7999/fe/stratus/compare/@cloudflare/util-formatters@2.6.13...@cloudflare/util-formatters@2.6.14) (2021-11-22)
+
+**Note:** Version bump only for package @cloudflare/util-formatters
+
+
+
+
+
 ## [2.6.13](http://stash.cfops.it:7999/fe/stratus/compare/@cloudflare/util-formatters@2.6.10...@cloudflare/util-formatters@2.6.13) (2021-10-28)
 
 

package/dist/formatters.d.ts

@@ -41,7 +41,7 @@ export declare type CurrencyValue = number | string | undefined;
 export declare type CurrencyOptions = {
     locale: SupportedLocales;
 };
-export declare const formatCurrency: (value?: CurrencyValue, options?: CurrencyOptions) => string;
+export declare const formatCurrency: (value?: CurrencyValue, options?: CurrencyOptions, minimumFractionDigits?: number, maximumFractionDigits?: number) => string;
 /**
  * @param {Number} number
  * @param {String} locale
@@ -67,3 +67,5 @@ export declare const formatBits: (number: number, locale: SupportedLocales | und
  */
 export declare const formatNumberForAnalytics: (number: number, locale?: SupportedLocales, useSI?: boolean, decimalPlaces?: number, trimInsignificantZeros?: boolean) => string;
 export declare const capitalizeStr: (str: string) => string | undefined;
+export declare const formatPercentage: (value: number, total: number) => string;
+export declare const roundPercentage: (val: number, roundDecimalCases?: number, locale?: SupportedLocales) => string;

package/es/formatters.js

@@ -99,14 +99,13 @@ export const formatNumber = (number, locale = DEFAULT_LOCALE, abbreviate = false
 };
 export const formatCurrency = (value = 0, options = {
   locale: DEFAULT_LOCALE
-}) => {
+}, minimumFractionDigits = 2, maximumFractionDigits = 2) => {
   return Number(value).toLocaleString(options.locale, {
     style: 'currency',
     // We should *always* display the currency that was billed in (USD).
     currency: DEFAULT_CURRENCY,
-    // In the future—we can make these properties configurable.
-    minimumFractionDigits: 2,
-    maximumFractionDigits: 2
+    minimumFractionDigits,
+    maximumFractionDigits
   })
   /**
    * `Number.toLocaleString` with `style: 'currency'` behaves differently
@@ -164,4 +163,27 @@ export const formatBits = (number, locale = DEFAULT_LOCALE, includeDecimals, use
 export const formatNumberForAnalytics = (number, locale = DEFAULT_LOCALE, useSI = false, decimalPlaces = 2, trimInsignificantZeros = true) => {
   return formatNumber(number, locale, useSI, decimalPlaces, trimInsignificantZeros);
 };
-export const capitalizeStr = str => str && str.charAt(0).toUpperCase() + str.slice(1);
+export const capitalizeStr = str => str && str.charAt(0).toUpperCase() + str.slice(1);
+export const formatPercentage = (value, total) => `${Math.round(value * 100 / total * 100) / 100}%`;
+export const roundPercentage = (val, roundDecimalCases = 0, locale = DEFAULT_LOCALE) => {
+  const roundDiv = Math.pow(10, roundDecimalCases); // Treat ~0% and ~100% values specially so the precision is surfaced
+
+  let localizedString = '';
+
+  if (val > 99) {
+    // Edge case: between 99 and 100, produce values with precision like this:
+    // 99.999735 --> 99.9997
+    localizedString = localizeNumberWithPrecision(100 - +(100 - val).toPrecision(1), locale);
+  } else if (val < 1) {
+    // Edge case: between 0 and 1, produce values with the precision of one
+    // significant digit:
+    // 0.000273 --> 0.0003
+    localizedString = localizeNumberWithPrecision(+val.toPrecision(1), locale);
+  } else {
+    // In all other cases, round to the nearest integer:
+    // 78.612 --> 79
+    localizedString = formatNumberForAnalytics(val * roundDiv / roundDiv, locale, false, roundDecimalCases);
+  }
+
+  return localizedString + '%';
+};

package/lib/formatters.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.capitalizeStr = exports.formatNumberForAnalytics = exports.formatBits = exports.formatBytes = exports.formatCurrency = exports.formatNumber = exports.localizeNumberWithPrecision = exports.formatDate = exports.DateFormatters = void 0;
+exports.roundPercentage = exports.formatPercentage = exports.capitalizeStr = exports.formatNumberForAnalytics = exports.formatBits = exports.formatBytes = exports.formatCurrency = exports.formatNumber = exports.localizeNumberWithPrecision = exports.formatDate = exports.DateFormatters = void 0;
 
 var _d3Format = require("d3-format");
 
@@ -131,13 +131,14 @@ var formatCurrency = function formatCurrency() {
   var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {
     locale: DEFAULT_LOCALE
   };
+  var minimumFractionDigits = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : 2;
+  var maximumFractionDigits = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : 2;
   return Number(value).toLocaleString(options.locale, {
     style: 'currency',
     // We should *always* display the currency that was billed in (USD).
     currency: DEFAULT_CURRENCY,
-    // In the future—we can make these properties configurable.
-    minimumFractionDigits: 2,
-    maximumFractionDigits: 2
+    minimumFractionDigits: minimumFractionDigits,
+    maximumFractionDigits: maximumFractionDigits
   })
   /**
    * `Number.toLocaleString` with `style: 'currency'` behaves differently
@@ -220,4 +221,37 @@ var capitalizeStr = function capitalizeStr(str) {
   return str && str.charAt(0).toUpperCase() + str.slice(1);
 };
 
-exports.capitalizeStr = capitalizeStr;
+exports.capitalizeStr = capitalizeStr;
+
+var formatPercentage = function formatPercentage(value, total) {
+  return "".concat(Math.round(value * 100 / total * 100) / 100, "%");
+};
+
+exports.formatPercentage = formatPercentage;
+
+var roundPercentage = function roundPercentage(val) {
+  var roundDecimalCases = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 0;
+  var locale = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : DEFAULT_LOCALE;
+  var roundDiv = Math.pow(10, roundDecimalCases); // Treat ~0% and ~100% values specially so the precision is surfaced
+
+  var localizedString = '';
+
+  if (val > 99) {
+    // Edge case: between 99 and 100, produce values with precision like this:
+    // 99.999735 --> 99.9997
+    localizedString = localizeNumberWithPrecision(100 - +(100 - val).toPrecision(1), locale);
+  } else if (val < 1) {
+    // Edge case: between 0 and 1, produce values with the precision of one
+    // significant digit:
+    // 0.000273 --> 0.0003
+    localizedString = localizeNumberWithPrecision(+val.toPrecision(1), locale);
+  } else {
+    // In all other cases, round to the nearest integer:
+    // 78.612 --> 79
+    localizedString = formatNumberForAnalytics(val * roundDiv / roundDiv, locale, false, roundDecimalCases);
+  }
+
+  return localizedString + '%';
+};
+
+exports.roundPercentage = roundPercentage;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@cloudflare/util-formatters",
   "description": "",
-  "version": "2.6.13",
+  "version": "2.7.1",
   "types": "./dist/index.d.ts",
   "main": "lib/index.js",
   "module": "es/index.js",
@@ -21,5 +21,5 @@
     "d3-format": "^1.3.2",
     "moment": "^2.22.1"
   },
-  "gitHead": "a1a7ca299c6676e5222e50aee57bc5beedb44882"
+  "gitHead": "4c3f37862d999a25e55311f1103206767dc86d10"
 }