@formatjs/ecma402-abstract 2.2.5 → 2.3.0

package/lib/NumberFormat/format_to_parts.js

@@ -1,6 +1,9 @@
+import Decimal from 'decimal.js';
+import { TEN } from '../constants';
 import { S_UNICODE_REGEX } from '../regex.generated';
-import { ToRawFixed } from './ToRawFixed';
 import { digitMapping } from './digit-mapping.generated';
+import { GetUnsignedRoundingMode } from './GetUnsignedRoundingMode';
+import { ToRawFixed } from './ToRawFixed';
 // This is from: unicode-12.1.0/General_Category/Symbol/regex.js
 // IE11 does not support unicode flag, otherwise this is just /\p{S}/u.
 // /^\p{S}/u
@@ -115,9 +118,9 @@ export default function formatToParts(numberResult, data, pl, options) {
         switch (part) {
             case '{0}': {
                 // We only need to handle scientific and engineering notation here.
-                numberParts.push.apply(numberParts, paritionNumberIntoParts(symbols, numberResult, notation, exponent, numberingSystem, 
+                numberParts.push.apply(numberParts, partitionNumberIntoParts(symbols, numberResult, notation, exponent, numberingSystem, 
                 // If compact number pattern exists, do not insert group separators.
-                !compactNumberPattern && Boolean(options.useGrouping), decimalNumberPattern, style));
+                !compactNumberPattern && Boolean(options.useGrouping), decimalNumberPattern, style, options.roundingIncrement, GetUnsignedRoundingMode(options.roundingMode, sign === -1)));
                 break;
             }
             case '-':
@@ -160,7 +163,7 @@ export default function formatToParts(numberResult, data, pl, options) {
                 var unitName = void 0;
                 var currencyNameData = data.currencies[options.currency];
                 if (currencyNameData) {
-                    unitName = selectPlural(pl, numberResult.roundedNumber * Math.pow(10, exponent), currencyNameData.displayName);
+                    unitName = selectPlural(pl, numberResult.roundedNumber.times(TEN.pow(exponent)).toNumber(), currencyNameData.displayName);
                 }
                 else {
                     // Fallback for unknown currency
@@ -197,7 +200,7 @@ export default function formatToParts(numberResult, data, pl, options) {
             var unitPattern = void 0;
             if (unitData) {
                 // Simple unit pattern
-                unitPattern = selectPlural(pl, numberResult.roundedNumber * Math.pow(10, exponent), data.units.simple[unit][unitDisplay]);
+                unitPattern = selectPlural(pl, numberResult.roundedNumber.times(TEN.pow(exponent)).toNumber(), data.units.simple[unit][unitDisplay]);
             }
             else {
                 // See: http://unicode.org/reports/tr35/tr35-general.html#perUnitPatterns
@@ -205,7 +208,7 @@ export default function formatToParts(numberResult, data, pl, options) {
                 // Implementation note: we are not following TR-35 here because we need to format to parts!
                 var _b = unit.split('-per-'), numeratorUnit = _b[0], denominatorUnit = _b[1];
                 unitData = data.units.simple[numeratorUnit];
-                var numeratorUnitPattern = selectPlural(pl, numberResult.roundedNumber * Math.pow(10, exponent), data.units.simple[numeratorUnit][unitDisplay]);
+                var numeratorUnitPattern = selectPlural(pl, numberResult.roundedNumber.times(TEN.pow(exponent)).toNumber(), data.units.simple[numeratorUnit][unitDisplay]);
                 var perUnitPattern = data.units.simple[denominatorUnit].perUnit[unitDisplay];
                 if (perUnitPattern) {
                     // perUnitPattern exists, combine it with numeratorUnitPattern
@@ -251,7 +254,7 @@ export default function formatToParts(numberResult, data, pl, options) {
 }
 // A subset of https://tc39.es/ecma402/#sec-partitionnotationsubpattern
 // Plus the exponent parts handling.
-function paritionNumberIntoParts(symbols, numberResult, notation, exponent, numberingSystem, useGrouping, 
+function partitionNumberIntoParts(symbols, numberResult, notation, exponent, numberingSystem, useGrouping, 
 /**
  * This is the decimal number pattern without signs or symbols.
  * It is used to infer the group size when `useGrouping` is true.
@@ -259,14 +262,14 @@ function paritionNumberIntoParts(symbols, numberResult, notation, exponent, numb
  * A typical value looks like "#,##0.00" (primary group size is 3).
  * Some locales like Hindi has secondary group size of 2 (e.g. "#,##,##0.00").
  */
-decimalNumberPattern, style) {
+decimalNumberPattern, style, roundingIncrement, unsignedRoundingMode) {
     var result = [];
     // eslint-disable-next-line prefer-const
     var n = numberResult.formattedString, x = numberResult.roundedNumber;
-    if (isNaN(x)) {
+    if (x.isNaN()) {
         return [{ type: 'nan', value: n }];
     }
-    else if (!isFinite(x)) {
+    else if (!x.isFinite()) {
         return [{ type: 'infinity', value: n }];
     }
     var digitReplacementTable = digitMapping[numberingSystem];
@@ -291,7 +294,8 @@ decimalNumberPattern, style) {
     // unless the rounded number is greater than 10000:
     //   NumberFormat('de', {notation: 'compact', compactDisplay: 'short'}).format(1234) //=> "1234"
     //   NumberFormat('de').format(1234) //=> "1.234"
-    if (useGrouping && (notation !== 'compact' || x >= 10000)) {
+    if (useGrouping &&
+        (notation !== 'compact' || x.greaterThanOrEqualTo(10000))) {
         // a. Let groupSepSymbol be the implementation-, locale-, and numbering system-dependent (ILND) String representing the grouping separator.
         // For currency we should use `currencyGroup` instead of generic `group`
         var groupSepSymbol = style === 'currency' && symbols.currencyGroup != null
@@ -346,13 +350,13 @@ decimalNumberPattern, style) {
         result.push({ type: 'decimal', value: decimalSepSymbol }, { type: 'fraction', value: fraction });
     }
     if ((notation === 'scientific' || notation === 'engineering') &&
-        isFinite(x)) {
+        x.isFinite()) {
         result.push({ type: 'exponentSeparator', value: symbols.exponential });
         if (exponent < 0) {
             result.push({ type: 'exponentMinusSign', value: symbols.minusSign });
             exponent = -exponent;
         }
-        var exponentResult = ToRawFixed(exponent, 0, 0);
+        var exponentResult = ToRawFixed(new Decimal(exponent), 0, 0, roundingIncrement, unsignedRoundingMode);
         result.push({
             type: 'exponentInteger',
             value: exponentResult.formattedString,
@@ -398,7 +402,7 @@ function getCompactDisplayPattern(numberResult, pl, data, style, compactDisplay,
         if (!compactPluralRules) {
             return null;
         }
-        pattern = selectPlural(pl, roundedNumber, compactPluralRules);
+        pattern = selectPlural(pl, roundedNumber.toNumber(), compactPluralRules);
     }
     else {
         var byNumberingSystem = data.numbers.decimal;
@@ -408,7 +412,7 @@ function getCompactDisplayPattern(numberResult, pl, data, style, compactDisplay,
         if (!compactPlaralRule) {
             return null;
         }
-        pattern = selectPlural(pl, roundedNumber, compactPlaralRule);
+        pattern = selectPlural(pl, roundedNumber.toNumber(), compactPlaralRule);
     }
     // See https://unicode.org/reports/tr35/tr35-numbers.html#Compact_Number_Formats
     // > If the value is precisely “0”, either explicit or defaulted, then the normal number format

package/lib/constants.d.ts

@@ -0,0 +1,4 @@
+import Decimal from 'decimal.js';
+export declare const TEN: Decimal;
+export declare const ZERO: Decimal;
+export declare const NEGATIVE_ZERO: Decimal;

package/lib/constants.js

@@ -0,0 +1,4 @@
+import Decimal from 'decimal.js';
+export var TEN = new Decimal(10);
+export var ZERO = new Decimal(0);
+export var NEGATIVE_ZERO = new Decimal(-0);

package/lib/index.d.ts

@@ -30,7 +30,7 @@ export * from './NumberFormat/ToRawFixed';
 export * from './NumberFormat/ToRawPrecision';
 export * from './PartitionPattern';
 export * from './SupportedLocales';
-export { createDataProperty, defineProperty, getInternalSlot, getMagnitude, getMultiInternalSlots, isLiteralPart, setInternalSlot, setMultiInternalSlots, } from './utils';
+export { createDataProperty, defineProperty, getInternalSlot, getMultiInternalSlots, isLiteralPart, setInternalSlot, setMultiInternalSlots, } from './utils';
 export type { LiteralPart } from './utils';
 export * from './262';
 export { isMissingLocaleDataError } from './data';
@@ -42,3 +42,4 @@ export * from './types/number';
 export * from './types/plural-rules';
 export * from './types/relative-time';
 export { createMemoizedDateTimeFormat, createMemoizedListFormat, createMemoizedLocale, createMemoizedNumberFormat, createMemoizedPluralRules, invariant, } from './utils';
+export { ZERO } from './constants';

package/lib/index.js

@@ -30,7 +30,7 @@ export * from './NumberFormat/ToRawFixed';
 export * from './NumberFormat/ToRawPrecision';
 export * from './PartitionPattern';
 export * from './SupportedLocales';
-export { createDataProperty, defineProperty, getInternalSlot, getMagnitude, getMultiInternalSlots, isLiteralPart, setInternalSlot, setMultiInternalSlots, } from './utils';
+export { createDataProperty, defineProperty, getInternalSlot, getMultiInternalSlots, isLiteralPart, setInternalSlot, setMultiInternalSlots, } from './utils';
 export * from './262';
 export { isMissingLocaleDataError } from './data';
 export * from './types/date-time';
@@ -40,3 +40,4 @@ export * from './types/number';
 export * from './types/plural-rules';
 export * from './types/relative-time';
 export { createMemoizedDateTimeFormat, createMemoizedListFormat, createMemoizedLocale, createMemoizedNumberFormat, createMemoizedPluralRules, invariant, } from './utils';
+export { ZERO } from './constants';

package/lib/types/number.d.ts

@@ -1,3 +1,4 @@
+import Decimal from 'decimal.js';
 import { LocaleData } from './core';
 import { LDMLPluralRule } from './plural-rules';
 export type NumberFormatNotation = 'standard' | 'scientific' | 'engineering' | 'compact';
@@ -13,17 +14,22 @@ export interface NumberFormatDigitOptions {
     minimumFractionDigits?: number;
     maximumFractionDigits?: number;
     roundingPriority?: RoundingPriorityType;
+    roundingIncrement?: number;
+    roundingMode?: RoundingModeType;
+    trailingZeroDisplay?: TrailingZeroDisplay;
 }
 export interface NumberFormatDigitInternalSlots {
     minimumIntegerDigits: number;
-    minimumSignificantDigits?: number;
-    maximumSignificantDigits?: number;
+    minimumSignificantDigits: number;
+    maximumSignificantDigits: number;
     roundingType: NumberFormatRoundingType;
-    minimumFractionDigits?: number;
-    maximumFractionDigits?: number;
-    notation?: NumberFormatNotation;
-    roundingIncrement?: number;
-    trailingZeroDisplay?: TrailingZeroDisplay;
+    minimumFractionDigits: number;
+    maximumFractionDigits: number;
+    notation: NumberFormatNotation;
+    roundingIncrement: number;
+    roundingMode: RoundingModeType;
+    trailingZeroDisplay: TrailingZeroDisplay;
+    roundingPriority: RoundingPriorityType;
 }
 export type RawNumberLocaleData = LocaleData<NumberFormatLocaleInternalData>;
 export interface NumberFormatLocaleInternalData {
@@ -106,8 +112,9 @@ export type LDMLPluralRuleMap<T> = Omit<Partial<Record<LDMLPluralRule, T>>, 'oth
 };
 export interface RawNumberFormatResult {
     formattedString: string;
-    roundedNumber: number;
+    roundedNumber: Decimal;
     integerDigitsCount: number;
+    roundingMagnitude: number;
 }
 export type NumberFormatOptionsLocaleMatcher = 'lookup' | 'best fit';
 export type NumberFormatOptionsStyle = 'decimal' | 'percent' | 'currency' | 'unit';
@@ -135,7 +142,7 @@ export interface NumberFormatInternal extends NumberFormatDigitInternalSlots {
     boundFormat?: Intl.NumberFormat['format'];
     numberingSystem: string;
     dataLocaleData: NumberFormatLocaleInternalData;
-    roundingMode?: RoundingModeType;
+    roundingMode: RoundingModeType;
 }
 export type NumberFormatOptions = Omit<Intl.NumberFormatOptions, 'signDisplay' | 'useGrouping'> & NumberFormatDigitOptions & {
     localeMatcher?: NumberFormatOptionsLocaleMatcher;

package/lib/utils.d.ts

@@ -1,8 +1,3 @@
-/**
- * Cannot do Math.log(x) / Math.log(10) bc if IEEE floating point issue
- * @param x number
- */
-export declare function getMagnitude(x: number): number;
 export declare function repeat(s: string, times: number): string;
 export declare function setInternalSlot<Instance extends object, Internal extends object, Field extends keyof Internal>(map: WeakMap<Instance, Internal>, pl: Instance, field: Field, value: NonNullable<Internal>[Field]): void;
 export declare function setMultiInternalSlots<Instance extends object, Internal extends object, K extends keyof Internal>(map: WeakMap<Instance, Internal>, pl: Instance, props: Pick<NonNullable<Internal>, K>): void;

package/lib/utils.js

@@ -1,14 +1,5 @@
 import { __spreadArray } from "tslib";
 import { memoize, strategies } from '@formatjs/fast-memoize';
-/**
- * Cannot do Math.log(x) / Math.log(10) bc if IEEE floating point issue
- * @param x number
- */
-export function getMagnitude(x) {
-    // Cannot count string length via Number.toString because it may use scientific notation
-    // for very small or very large numbers.
-    return Math.floor(Math.log(x) * Math.LOG10E);
-}
 export function repeat(s, times) {
     if (typeof s.repeat === 'function') {
         return s.repeat(times);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@formatjs/ecma402-abstract",
-  "version": "2.2.5",
+  "version": "2.3.0",
   "description": "A collection of implementation for ECMAScript abstract operations",
   "keywords": [
     "intl",
@@ -14,9 +14,10 @@
     "format"
   ],
   "dependencies": {
+    "decimal.js": "10",
     "tslib": "2",
-    "@formatjs/fast-memoize": "2.2.4",
-    "@formatjs/intl-localematcher": "0.5.8"
+    "@formatjs/fast-memoize": "2.2.5",
+    "@formatjs/intl-localematcher": "0.5.9"
   },
   "author": "Long Ho <holevietlong@gmail.com",
   "bugs": {

package/types/number.d.ts

@@ -1,3 +1,4 @@
+import Decimal from 'decimal.js';
 import { LocaleData } from './core';
 import { LDMLPluralRule } from './plural-rules';
 export type NumberFormatNotation = 'standard' | 'scientific' | 'engineering' | 'compact';
@@ -13,17 +14,22 @@ export interface NumberFormatDigitOptions {
     minimumFractionDigits?: number;
     maximumFractionDigits?: number;
     roundingPriority?: RoundingPriorityType;
+    roundingIncrement?: number;
+    roundingMode?: RoundingModeType;
+    trailingZeroDisplay?: TrailingZeroDisplay;
 }
 export interface NumberFormatDigitInternalSlots {
     minimumIntegerDigits: number;
-    minimumSignificantDigits?: number;
-    maximumSignificantDigits?: number;
+    minimumSignificantDigits: number;
+    maximumSignificantDigits: number;
     roundingType: NumberFormatRoundingType;
-    minimumFractionDigits?: number;
-    maximumFractionDigits?: number;
-    notation?: NumberFormatNotation;
-    roundingIncrement?: number;
-    trailingZeroDisplay?: TrailingZeroDisplay;
+    minimumFractionDigits: number;
+    maximumFractionDigits: number;
+    notation: NumberFormatNotation;
+    roundingIncrement: number;
+    roundingMode: RoundingModeType;
+    trailingZeroDisplay: TrailingZeroDisplay;
+    roundingPriority: RoundingPriorityType;
 }
 export type RawNumberLocaleData = LocaleData<NumberFormatLocaleInternalData>;
 export interface NumberFormatLocaleInternalData {
@@ -106,8 +112,9 @@ export type LDMLPluralRuleMap<T> = Omit<Partial<Record<LDMLPluralRule, T>>, 'oth
 };
 export interface RawNumberFormatResult {
     formattedString: string;
-    roundedNumber: number;
+    roundedNumber: Decimal;
     integerDigitsCount: number;
+    roundingMagnitude: number;
 }
 export type NumberFormatOptionsLocaleMatcher = 'lookup' | 'best fit';
 export type NumberFormatOptionsStyle = 'decimal' | 'percent' | 'currency' | 'unit';
@@ -135,7 +142,7 @@ export interface NumberFormatInternal extends NumberFormatDigitInternalSlots {
     boundFormat?: Intl.NumberFormat['format'];
     numberingSystem: string;
     dataLocaleData: NumberFormatLocaleInternalData;
-    roundingMode?: RoundingModeType;
+    roundingMode: RoundingModeType;
 }
 export type NumberFormatOptions = Omit<Intl.NumberFormatOptions, 'signDisplay' | 'useGrouping'> & NumberFormatDigitOptions & {
     localeMatcher?: NumberFormatOptionsLocaleMatcher;

package/utils.d.ts

@@ -1,8 +1,3 @@
-/**
- * Cannot do Math.log(x) / Math.log(10) bc if IEEE floating point issue
- * @param x number
- */
-export declare function getMagnitude(x: number): number;
 export declare function repeat(s: string, times: number): string;
 export declare function setInternalSlot<Instance extends object, Internal extends object, Field extends keyof Internal>(map: WeakMap<Instance, Internal>, pl: Instance, field: Field, value: NonNullable<Internal>[Field]): void;
 export declare function setMultiInternalSlots<Instance extends object, Internal extends object, K extends keyof Internal>(map: WeakMap<Instance, Internal>, pl: Instance, props: Pick<NonNullable<Internal>, K>): void;

package/utils.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createMemoizedListFormat = exports.createMemoizedLocale = exports.createMemoizedPluralRules = exports.createMemoizedDateTimeFormat = exports.createMemoizedNumberFormat = exports.UNICODE_EXTENSION_SEQUENCE_REGEX = void 0;
-exports.getMagnitude = getMagnitude;
 exports.repeat = repeat;
 exports.setInternalSlot = setInternalSlot;
 exports.setMultiInternalSlots = setMultiInternalSlots;
@@ -13,15 +12,6 @@ exports.createDataProperty = createDataProperty;
 exports.invariant = invariant;
 var tslib_1 = require("tslib");
 var fast_memoize_1 = require("@formatjs/fast-memoize");
-/**
- * Cannot do Math.log(x) / Math.log(10) bc if IEEE floating point issue
- * @param x number
- */
-function getMagnitude(x) {
-    // Cannot count string length via Number.toString because it may use scientific notation
-    // for very small or very large numbers.
-    return Math.floor(Math.log(x) * Math.LOG10E);
-}
 function repeat(s, times) {
     if (typeof s.repeat === 'function') {
         return s.repeat(times);