feat: add narrowSymbol currency display support

Canmert Celikler · Canmert Celikler · commit 077fb3195da5 · 2024-03-25T15:47:00.000+03:00
(perf) move instance creation to the constructor. (feat) expose native formatter instance. (fix) merge NativeScript#24
diff --git a/package.json b/package.json
@@ -10,5 +10,8 @@
     "tns-platform-declarations": "~6.5.8",
     "tslint": "^6.1.0",
     "typescript": "^3.9.0"
+  },
+  "dependencies": {
+    "currency-symbol-map": "^5.1.0"
   }
 }
diff --git a/src/nativescript-intl.android.d.ts b/src/nativescript-intl.android.d.ts
@@ -1,11 +1,15 @@
 import common = require("./nativescript-intl-common");
 export declare class DateTimeFormat extends common.DateTimeFormat {
-    getNativePattern(patternDefinition: {
-        date?: string;
-        time?: string;
-    }, locale?: string): string;
+    getNativePattern(
+        patternDefinition: {
+            date?: string;
+            time?: string;
+        },
+        locale?: string
+    ): string;
     formatNative(pattern: string, locale?: string, date?: Date): string;
 }
 export declare class NumberFormat extends common.NumberFormat {
-    formatNative(value: number, locale?: string, options?: Intl.NumberFormatOptions, pattern?: string): any;
+    constructor(locale?: string, options?: Intl.NumberFormatOptions, pattern?: string);
+    formatNative(value: number): any;
 }
diff --git a/src/nativescript-intl.android.ts b/src/nativescript-intl.android.ts
@@ -1,9 +1,6 @@
-import {
-    DateTimeFormat as commonDateTimeFormat,
-    NumberFormat as commonNumberFormat,
-    FULL
-} from "./nativescript-intl-common";
+import { DateTimeFormat as commonDateTimeFormat, NumberFormat as commonNumberFormat, FULL } from "./nativescript-intl-common";
 import { NumberFormatOptions } from "./nativescript-intl";
+import getSymbolFromCurrency from "currency-symbol-map";
 
 let localesCache: Map<string, any> = new Map<string, any>();
 
@@ -20,7 +17,7 @@ function getNativeLocale(locale?: string) {
         if (firstHypenIndex > -1) {
             lang = locale.substr(0, firstHypenIndex);
             let nextHypenIndex = locale.substr(firstHypenIndex + 1).indexOf("-");
-            country = locale.substr(firstHypenIndex + 1, (nextHypenIndex > -1) ? nextHypenIndex : undefined);
+            country = locale.substr(firstHypenIndex + 1, nextHypenIndex > -1 ? nextHypenIndex : undefined);
         } else {
             lang = locale;
         }
@@ -37,7 +34,13 @@ function getNativeLocale(locale?: string) {
 }
 
 export class DateTimeFormat extends commonDateTimeFormat {
-    public getNativePattern(patternDefinition: {date?: string, time?: string}, locale?: string): string {
+    public getNativePattern(
+        patternDefinition: {
+            date?: string;
+            time?: string;
+        },
+        locale?: string
+    ): string {
         let result = "";
         let flag = 0;
         let nativeLocale;
@@ -69,8 +72,7 @@ export class DateTimeFormat extends commonDateTimeFormat {
                 break;
             case 3:
                 // date + locale
-                dateFormat =
-                java.text.DateFormat.getDateInstance(patternDefinition.date === FULL ? 0 : 3, nativeLocale);
+                dateFormat = java.text.DateFormat.getDateInstance(patternDefinition.date === FULL ? 0 : 3, nativeLocale);
                 break;
             case 4:
                 // only time we always use long pattern using default locale
@@ -86,8 +88,7 @@ export class DateTimeFormat extends commonDateTimeFormat {
                 break;
             case 7:
                 // locale + date + time
-                dateFormat =
-                java.text.DateFormat.getDateTimeInstance(patternDefinition.date === FULL ? 0 : 3, 1, nativeLocale);
+                dateFormat = java.text.DateFormat.getDateTimeInstance(patternDefinition.date === FULL ? 0 : 3, 1, nativeLocale);
                 break;
             default:
                 break;
@@ -97,14 +98,11 @@ export class DateTimeFormat extends commonDateTimeFormat {
     }
 
     public formatNative(pattern: string, locale?: string, date?: Date): string {
-        let sdf = locale ?
-            new java.text.SimpleDateFormat(pattern, getNativeLocale(locale)) :
-            new java.text.SimpleDateFormat(pattern);
+        let sdf = locale ? new java.text.SimpleDateFormat(pattern, getNativeLocale(locale)) : new java.text.SimpleDateFormat(pattern);
         return sdf.format(date ? new java.util.Date(date.valueOf()) : new java.util.Date()).toString();
     }
 }
 
-
 // style?: string;
 // currency?: string;
 // currencyDisplay?: string;
@@ -113,69 +111,78 @@ export class DateTimeFormat extends commonDateTimeFormat {
 // minimumFractionDigits?: number;
 // maximumFractionDigits?: number;
 export class NumberFormat extends commonNumberFormat {
-    public formatNative(value: number, locale?: string, options?: NumberFormatOptions, pattern?: string) {
-        let numberFormat;
+    public numberFormat: java.text.DecimalFormat | java.text.NumberFormat | any;
+    constructor(locale?: string, options?: NumberFormatOptions, pattern?: string) {
+        super(locale, options, pattern);
         if (pattern) {
-            numberFormat = new java.text.DecimalFormat(pattern);
+            this.numberFormat = new java.text.DecimalFormat(pattern);
         } else {
-            if (options) {
+            if (options && options.style) {
                 switch (options.style.toLowerCase()) {
                     case "decimal":
-                        numberFormat = java.text.NumberFormat.getNumberInstance(getNativeLocale(locale));
+                        this.numberFormat = java.text.NumberFormat.getNumberInstance(getNativeLocale(locale));
                         break;
                     case "percent":
-                        numberFormat = java.text.NumberFormat.getPercentInstance(getNativeLocale(locale));
+                        this.numberFormat = java.text.NumberFormat.getPercentInstance(getNativeLocale(locale));
                         break;
                     case "currency":
-                        numberFormat = java.text.NumberFormat.getCurrencyInstance(getNativeLocale(locale));
+                        this.numberFormat = java.text.NumberFormat.getCurrencyInstance(getNativeLocale(locale));
                         if (options.currency !== void 0) {
-                            numberFormat.setCurrency(java.util.Currency.getInstance(options.currency));
+                            this.numberFormat.setCurrency(java.util.Currency.getInstance(options.currency));
                         }
                         break;
                     default:
-                        numberFormat = java.text.NumberFormat.getNumberInstance(getNativeLocale(locale));
+                        this.numberFormat = java.text.NumberFormat.getNumberInstance(getNativeLocale(locale));
                         break;
                 }
             } else {
-                numberFormat = java.text.NumberFormat.getNumberInstance(getNativeLocale(locale));
+                this.numberFormat = java.text.NumberFormat.getNumberInstance(getNativeLocale(locale));
             }
         }
 
         if (options && options.minimumIntegerDigits !== void 0) {
-            numberFormat.setMinimumIntegerDigits(options.minimumIntegerDigits);
+            this.numberFormat.setMinimumIntegerDigits(options.minimumIntegerDigits);
         }
 
         if (options && options.minimumFractionDigits !== void 0) {
-            numberFormat.setMinimumFractionDigits(options.minimumFractionDigits);
+            this.numberFormat.setMinimumFractionDigits(options.minimumFractionDigits);
         }
 
         if (options && options.maximumFractionDigits !== void 0) {
-            numberFormat.setMaximumFractionDigits(options.maximumFractionDigits);
+            this.numberFormat.setMaximumFractionDigits(options.maximumFractionDigits);
         }
 
         if (options && options.useGrouping !== void 0) {
-            numberFormat.setGroupingUsed(options.useGrouping);
+            this.numberFormat.setGroupingUsed(options.useGrouping);
+        }
+
+        let decimalFormatSymbols = locale
+            ? new java.text.DecimalFormatSymbols(getNativeLocale(locale))
+            : new java.text.DecimalFormatSymbols();
+
+        if (options && options.currency !== void 0) {
+            decimalFormatSymbols.setCurrency(java.util.Currency.getInstance(options.currency));
+            // Use a narrow format symbol ("$100" rather than "US$100") (https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#narrowsymbol)
+            if (options && options.currencyDisplay === "narrowSymbol") {
+                const currencySymbol = getSymbolFromCurrency(options.currency);
+                if (currencySymbol) decimalFormatSymbols.setCurrencySymbol(currencySymbol);
+            }
         }
 
-        let decimalFormatSymbols = locale ?
-            new java.text.DecimalFormatSymbols(getNativeLocale(locale)) :
-            new java.text.DecimalFormatSymbols();
-        numberFormat.setDecimalFormatSymbols(decimalFormatSymbols);
+        this.numberFormat.setDecimalFormatSymbols(decimalFormatSymbols);
 
-        if (options && (options.style.toLowerCase() === "currency" && options.currencyDisplay === "code")) {
+        if (options && options.style.toLowerCase() === "currency" && options.currencyDisplay === "code") {
             if (!pattern) {
-                let currrentPattern = numberFormat.toPattern();
+                let currrentPattern = this.numberFormat.toPattern();
                 // this will display currency code instead of currency symbol
                 currrentPattern = currrentPattern.replace("¤", "¤¤");
-                numberFormat = new java.text.DecimalFormat(currrentPattern);
-                numberFormat.setDecimalFormatSymbols(decimalFormatSymbols);
-            }
-
-            if (options.currency !== void 0) {
-                decimalFormatSymbols.setCurrency(java.util.Currency.getInstance(options.currency));
+                this.numberFormat = new java.text.DecimalFormat(currrentPattern);
+                this.numberFormat.setDecimalFormatSymbols(decimalFormatSymbols);
             }
         }
+    }
 
-        return numberFormat.format(value);
+    public formatNative(value: number) {
+        return this.numberFormat.format(value);
     }
 }
diff --git a/src/nativescript-intl.ios.d.ts b/src/nativescript-intl.ios.d.ts
@@ -1,11 +1,15 @@
 import common = require("./nativescript-intl-common");
 export declare class DateTimeFormat extends common.DateTimeFormat {
-    getNativePattern(patternDefinition: {
-        date?: string;
-        time?: string;
-    }, locale?: string): string;
+    getNativePattern(
+        patternDefinition: {
+            date?: string;
+            time?: string;
+        },
+        locale?: string
+    ): string;
     formatNative(pattern: string, locale?: string, date?: Date): string;
 }
 export declare class NumberFormat extends common.NumberFormat {
-    formatNative(value: number, locale?: string, options?: Intl.NumberFormatOptions, pattern?: string): string;
+    constructor(locale?: string, options?: Intl.NumberFormatOptions, pattern?: string);
+    formatNative(value: number): string;
 }
diff --git a/src/nativescript-intl.ios.ts b/src/nativescript-intl.ios.ts
@@ -1,20 +1,15 @@
-import {
-    DateTimeFormat as commonDateTimeFormat,
-    NumberFormat as commonNumberFormat,
-    FULL
-} from "./nativescript-intl-common";
+import { DateTimeFormat as commonDateTimeFormat, NumberFormat as commonNumberFormat, FULL } from "./nativescript-intl-common";
 import { NumberFormatOptions } from "./nativescript-intl";
+import getSymbolFromCurrency from "currency-symbol-map";
 
 export class DateTimeFormat extends commonDateTimeFormat {
-    public getNativePattern(patternDefinition: {date?: string, time?: string}, locale?: string): string {
+    public getNativePattern(patternDefinition: { date?: string; time?: string }, locale?: string): string {
         let dateFormatter = NSDateFormatter.new();
         if (locale) {
             dateFormatter.locale = NSLocale.alloc().initWithLocaleIdentifier(locale);
         }
         if (patternDefinition.date) {
-            dateFormatter.dateStyle = patternDefinition.date === FULL ?
-                NSDateFormatterStyle.FullStyle :
-                NSDateFormatterStyle.ShortStyle;
+            dateFormatter.dateStyle = patternDefinition.date === FULL ? NSDateFormatterStyle.FullStyle : NSDateFormatterStyle.ShortStyle;
         }
         if (patternDefinition.time) {
             dateFormatter.timeStyle = NSDateFormatterStyle.LongStyle;
@@ -43,61 +38,68 @@ export class DateTimeFormat extends commonDateTimeFormat {
 // minimumFractionDigits?: number;
 // maximumFractionDigits?: number;
 export class NumberFormat extends commonNumberFormat {
-    public formatNative(value: number, locale?: string, options?: NumberFormatOptions, pattern?: string) {
-        let numberFormat = NSNumberFormatter.new();
+    public numberFormat: NSNumberFormatter;
+    constructor(locale?: string, options?: NumberFormatOptions, pattern?: string) {
+        super(locale, options, pattern);
+        this.numberFormat = NSNumberFormatter.new();
         if (locale) {
-            numberFormat.locale = NSLocale.alloc().initWithLocaleIdentifier(locale);
+            this.numberFormat.locale = NSLocale.alloc().initWithLocaleIdentifier(locale);
         }
-        if (options) {
+        if (options && options.style) {
             switch (options.style.toLowerCase()) {
                 case "decimal":
-                    numberFormat.numberStyle = NSNumberFormatterStyle.DecimalStyle;
+                    this.numberFormat.numberStyle = NSNumberFormatterStyle.DecimalStyle;
                     break;
                 case "percent":
-                    numberFormat.numberStyle = NSNumberFormatterStyle.PercentStyle;
+                    this.numberFormat.numberStyle = NSNumberFormatterStyle.PercentStyle;
                     break;
                 case "currency":
-                    numberFormat.numberStyle = NSNumberFormatterStyle.CurrencyStyle;
+                    this.numberFormat.numberStyle = NSNumberFormatterStyle.CurrencyStyle;
                     if (options.currency !== void 0) {
-                        numberFormat.currencyCode = options.currency;
+                        this.numberFormat.currencyCode = options.currency;
+                        if (options && options.currencyDisplay === "narrowSymbol") {
+                            const currencySymbol = getSymbolFromCurrency(options.currency);
+                            if (currencySymbol) this.numberFormat.currencySymbol = currencySymbol;
+                        }
                     }
                     break;
                 default:
-                    numberFormat.numberStyle = NSNumberFormatterStyle.DecimalStyle;
+                    this.numberFormat.numberStyle = NSNumberFormatterStyle.DecimalStyle;
                     break;
             }
         } else {
-            numberFormat.numberStyle = NSNumberFormatterStyle.DecimalStyle;
+            this.numberFormat.numberStyle = NSNumberFormatterStyle.DecimalStyle;
         }
 
         if (options && options.minimumIntegerDigits !== void 0) {
-            numberFormat.minimumIntegerDigits = options.minimumIntegerDigits;
+            this.numberFormat.minimumIntegerDigits = options.minimumIntegerDigits;
         }
 
         if (options && options.minimumFractionDigits !== void 0) {
-            numberFormat.minimumFractionDigits = options.minimumFractionDigits;
+            this.numberFormat.minimumFractionDigits = options.minimumFractionDigits;
         }
 
         if (options && options.maximumFractionDigits !== void 0) {
-            numberFormat.maximumFractionDigits = options.maximumFractionDigits;
+            this.numberFormat.maximumFractionDigits = options.maximumFractionDigits;
         }
 
         if (options && options.useGrouping !== void 0) {
-            numberFormat.usesGroupingSeparator = options.useGrouping;
+            this.numberFormat.usesGroupingSeparator = options.useGrouping;
         }
 
         if (pattern) {
-            numberFormat.positiveFormat = pattern;
+            this.numberFormat.positiveFormat = pattern;
         } else {
-            if (options && (options.style.toLowerCase() === "currency" && options.currencyDisplay === "code")) {
-                let tempPattern = numberFormat.positiveFormat;
+            if (options && options.style && options.style.toLowerCase() === "currency" && options.currencyDisplay === "code") {
+                let tempPattern = this.numberFormat.positiveFormat;
                 // this will display currency code instead of currency symbol
                 tempPattern = tempPattern.replace("¤", "¤¤");
-                numberFormat.positiveFormat = tempPattern;
+                this.numberFormat.positiveFormat = tempPattern;
             }
         }
+    }
 
-        // return numberFormat.stringFromNumber(NSNumber.alloc().initWithDouble(value));
-        return numberFormat.stringFromNumber(value);
+    public formatNative(value: number) {
+        return this.numberFormat.stringFromNumber(value);
     }
 }
diff --git a/src/tsconfig.json b/src/tsconfig.json
@@ -9,14 +9,9 @@
         "preserveConstEnums": true,
         "sourceMap": false,
         "declaration": false,
-        "lib": [
-            "es2017"
-        ]
+        "allowSyntheticDefaultImports": true,
+        "lib": ["es2017"]
     },
-    "include": [
-        "./**/*.ts",
-        "./**/*.d.ts",
-        "!./node_modules/**/*.ts"
-    ],
+    "include": ["./**/*.ts", "./**/*.d.ts", "!./node_modules/**/*.ts"],
     "exclude": []
 }

Original file line number	Diff line number	Diff line change
`@@ -10,5 +10,8 @@`
`10`	`10`	`"tns-platform-declarations": "~6.5.8",`
`11`	`11`	`"tslint": "^6.1.0",`
`12`	`12`	`"typescript": "^3.9.0"`
	`13`	`+ },`
	`14`	`+ "dependencies": {`
	`15`	`+ "currency-symbol-map": "^5.1.0"`
`13`	`16`	`}`
`14`	`17`	`}`