@automattic/number-formatters 1.0.0-alpha.1 → 1.0.0-alpha.2

package/CHANGELOG.md

@@ -4,6 +4,15 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
+## [1.0.0-alpha.2] - 2025-04-10
+### Changed
+- Adjust relative imports in TypeScript sources to use correct extensions after enabling TypeScript's new `rewriteRelativeImportExtensions` option. The built JS should be unaffected, so this is not a breaking change. [#42990]
+- Convert build to common-js [#42982]
+
+## [1.0.0-alpha.1] - 2025-04-10
+### Changed
+- Internal updates.
+
 ## [1.0.0-alpha.1] - 2025-04-07
 ### Added
 - initial release [#42639]
@@ -20,4 +29,5 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 - Initial release
 - Basic number formatting functionality
 
+[1.0.0-alpha.2]: https://github.com/Automattic/number-formatters/compare/1.0.0-alpha.1...1.0.0-alpha.2
 [1.0.0-alpha.1]: https://github.com/Automattic/number-formatters/compare/0.1.0...1.0.0-alpha.1

package/dist/constants.js

@@ -1,2 +1,5 @@
-export const FALLBACK_LOCALE = 'en';
-export const FALLBACK_CURRENCY = 'USD';
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FALLBACK_CURRENCY = exports.FALLBACK_LOCALE = void 0;
+exports.FALLBACK_LOCALE = 'en';
+exports.FALLBACK_CURRENCY = 'USD';

package/dist/create-number-formatters.d.ts

@@ -1,4 +1,4 @@
-import type { FormatCurrency, FormatNumber, GetCurrencyObject } from './types.js';
+import type { FormatCurrency, FormatNumber, GetCurrencyObject } from './types.ts';
 export interface NumberFormatters {
     /**
      * Sets the locale for number formatting

package/dist/create-number-formatters.js

@@ -1,7 +1,9 @@
-import { getSettings } from '@wordpress/date';
-import { FALLBACK_LOCALE } from './constants.js';
-import { numberFormatCurrency, getCurrencyObject as getCurrencyObjectFromCurrencyFormatter, } from './number-format-currency/index.js';
-import { numberFormat, numberFormatCompact } from './number-format.js';
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const date_1 = require("@wordpress/date");
+const constants_ts_1 = require("./constants.js");
+const index_ts_1 = require("./number-format-currency/index.js");
+const number_format_ts_1 = require("./number-format.js");
 /**
  * Creates a NumberFormatters instance that provides number and currency formatting functionality with locale awareness
  * @return {NumberFormatters} A NumberFormatters instance
@@ -29,17 +31,17 @@ function createNumberFormatters() {
      * @return {string} The locale to use for formatting.
      */
     const getBrowserSafeLocale = () => {
-        const { l10n: { locale: localeFromUserSettings }, } = getSettings();
+        const { l10n: { locale: localeFromUserSettings }, } = (0, date_1.getSettings)();
         return (localeState ??
             (localeFromUserSettings || global?.window?.navigator?.language) ??
-            FALLBACK_LOCALE).split('_')[0];
+            constants_ts_1.FALLBACK_LOCALE).split('_')[0];
     };
     const setGeoLocation = (geoLocation) => {
         geoLocationState = geoLocation;
     };
     const formatNumber = (number, { decimals = 0, forceLatin = true, numberFormatOptions = {} } = {}) => {
         try {
-            const formatter = numberFormat({
+            const formatter = (0, number_format_ts_1.numberFormat)({
                 browserSafeLocale: getBrowserSafeLocale(),
                 decimals,
                 forceLatin,
@@ -53,7 +55,7 @@ function createNumberFormatters() {
     };
     const formatNumberCompact = (number, { decimals = 0, forceLatin = true, numberFormatOptions = {} } = {}) => {
         try {
-            const formatter = numberFormatCompact({
+            const formatter = (0, number_format_ts_1.numberFormatCompact)({
                 browserSafeLocale: getBrowserSafeLocale(),
                 decimals,
                 forceLatin,
@@ -66,7 +68,7 @@ function createNumberFormatters() {
         }
     };
     const formatCurrency = (number, currency, { stripZeros = false, isSmallestUnit = false, signForPositive = false, forceLatin = true } = {}) => {
-        return numberFormatCurrency({
+        return (0, index_ts_1.numberFormatCurrency)({
             number,
             currency,
             browserSafeLocale: getBrowserSafeLocale(),
@@ -78,7 +80,7 @@ function createNumberFormatters() {
         });
     };
     const getCurrencyObject = (number, currency, { stripZeros = false, isSmallestUnit = false, signForPositive = false, forceLatin = true } = {}) => {
-        return getCurrencyObjectFromCurrencyFormatter({
+        return (0, index_ts_1.getCurrencyObject)({
             number,
             currency,
             browserSafeLocale: getBrowserSafeLocale(),
@@ -98,4 +100,4 @@ function createNumberFormatters() {
         getCurrencyObject,
     };
 }
-export default createNumberFormatters;
+exports.default = createNumberFormatters;

package/dist/get-cached-formatter.js

@@ -1,6 +1,12 @@
-import debugFactory from 'debug';
-import { FALLBACK_LOCALE } from './constants.js';
-const debug = debugFactory('number-formatters:get-cached-formatter');
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCachedFormatter = getCachedFormatter;
+const debug_1 = __importDefault(require("debug"));
+const constants_ts_1 = require("./constants.js");
+const debug = (0, debug_1.default)('number-formatters:get-cached-formatter');
 const formatterCache = new Map();
 /**
  * Get a cached formatter for a given locale and options.
@@ -11,7 +17,7 @@ const formatterCache = new Map();
  * @param  params.retries        - The number of retries to attempt if the formatter is not created.
  * @return {Intl.NumberFormat} A cached formatter for the given locale and options.
  */
-export function getCachedFormatter({ locale, fallbackLocale = FALLBACK_LOCALE, options, retries = 1, }) {
+function getCachedFormatter({ locale, fallbackLocale = constants_ts_1.FALLBACK_LOCALE, options, retries = 1, }) {
     const cacheKey = JSON.stringify([locale, options]);
     try {
         return (formatterCache.get(cacheKey) ??

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import createNumberFormatters from './create-number-formatters.js';
-export declare const setLocale: (locale: string) => void, setGeoLocation: (geoLocation: string) => void, formatNumber: import("./types.js").FormatNumber, formatNumberCompact: import("./types.js").FormatNumber, formatCurrency: import("./types.js").FormatCurrency, getCurrencyObject: import("./types.js").GetCurrencyObject;
+import createNumberFormatters from './create-number-formatters.ts';
+export declare const setLocale: (locale: string) => void, setGeoLocation: (geoLocation: string) => void, formatNumber: import("./types.ts").FormatNumber, formatNumberCompact: import("./types.ts").FormatNumber, formatCurrency: import("./types.ts").FormatCurrency, getCurrencyObject: import("./types.ts").GetCurrencyObject;
 export { createNumberFormatters };
-export * from './types.js';
+export * from './types.ts';

package/dist/index.js

@@ -1,7 +1,27 @@
-import createNumberFormatters from './create-number-formatters.js';
-const defaultFormatter = createNumberFormatters();
-export const { setLocale, setGeoLocation, formatNumber, formatNumberCompact, formatCurrency, getCurrencyObject, } = defaultFormatter;
-export { createNumberFormatters };
-export * from './types.js';
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createNumberFormatters = exports.getCurrencyObject = exports.formatCurrency = exports.formatNumberCompact = exports.formatNumber = exports.setGeoLocation = exports.setLocale = void 0;
+const create_number_formatters_ts_1 = __importDefault(require("./create-number-formatters.js"));
+exports.createNumberFormatters = create_number_formatters_ts_1.default;
+const defaultFormatter = (0, create_number_formatters_ts_1.default)();
+exports.setLocale = defaultFormatter.setLocale, exports.setGeoLocation = defaultFormatter.setGeoLocation, exports.formatNumber = defaultFormatter.formatNumber, exports.formatNumberCompact = defaultFormatter.formatNumberCompact, exports.formatCurrency = defaultFormatter.formatCurrency, exports.getCurrencyObject = defaultFormatter.getCurrencyObject;
+__exportStar(require("./types.js"), exports);
 // We can optionally export the formatters individually if we want to use them in a more granular way.
 // export { numberFormat, numberFormatCompact, numberFormatCurrency, getCurrencyObject };

package/dist/number-format-currency/currencies.d.ts

@@ -1,2 +1,2 @@
-import type { CurrencyOverride } from '../types.js';
+import type { CurrencyOverride } from '../types.ts';
 export declare const defaultCurrencyOverrides: Record<string, CurrencyOverride>;

package/dist/number-format-currency/currencies.js

@@ -1,4 +1,7 @@
-export const defaultCurrencyOverrides = {
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultCurrencyOverrides = void 0;
+exports.defaultCurrencyOverrides = {
     AED: {
         symbol: 'د.إ.‏',
     },

package/dist/number-format-currency/index.d.ts

@@ -1,4 +1,4 @@
-import type { CurrencyObject, NumberFormatCurrencyParams } from '../types.js';
+import type { CurrencyObject, NumberFormatCurrencyParams } from '../types.ts';
 /**
  * Formats money with a given currency code.
  *

package/dist/number-format-currency/index.js

@@ -1,8 +1,14 @@
-import debugFactory from 'debug';
-import { FALLBACK_CURRENCY } from '../constants.js';
-import { getCachedFormatter } from '../get-cached-formatter.js';
-import { defaultCurrencyOverrides } from './currencies.js';
-const debug = debugFactory('number-formatters:number-format-currency');
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCurrencyObject = exports.numberFormatCurrency = void 0;
+const debug_1 = __importDefault(require("debug"));
+const constants_ts_1 = require("../constants.js");
+const get_cached_formatter_ts_1 = require("../get-cached-formatter.js");
+const currencies_ts_1 = require("./currencies.js");
+const debug = (0, debug_1.default)('number-formatters:number-format-currency');
 /**
  * Retrieves the currency override for a given currency.
  * If the currency is USD and the user is not in the US, it will return `US$`.
@@ -14,7 +20,7 @@ function getCurrencyOverride(currency, geoLocation) {
     if (currency === 'USD' && geoLocation && geoLocation !== '' && geoLocation !== 'US') {
         return { symbol: 'US$' };
     }
-    return defaultCurrencyOverrides[currency];
+    return currencies_ts_1.defaultCurrencyOverrides[currency];
 }
 /**
  * Returns a valid currency code based on a shortlist of currency codes.
@@ -25,8 +31,8 @@ function getCurrencyOverride(currency, geoLocation) {
  */
 function getValidCurrency(currency, geoLocation) {
     if (!getCurrencyOverride(currency, geoLocation)) {
-        debug(`getValidCurrency was called with a non-existent currency "${currency}"; falling back to ${FALLBACK_CURRENCY}`);
-        return FALLBACK_CURRENCY;
+        debug(`getValidCurrency was called with a non-existent currency "${currency}"; falling back to ${constants_ts_1.FALLBACK_CURRENCY}`);
+        return constants_ts_1.FALLBACK_CURRENCY;
     }
     return currency;
 }
@@ -75,7 +81,7 @@ function getCurrencyFormatter({ number, currency, browserSafeLocale, forceLatin
         }),
         ...(signForPositive && { signDisplay: 'exceptZero' }),
     };
-    return getCachedFormatter({
+    return (0, get_cached_formatter_ts_1.getCachedFormatter)({
         locale,
         options: numberFormatOptions,
     });
@@ -204,6 +210,7 @@ const numberFormatCurrency = ({ number, browserSafeLocale, currency, stripZeros,
         }
     }, '');
 };
+exports.numberFormatCurrency = numberFormatCurrency;
 /**
  * Returns a formatted price object which can be used to manually render a
  * formatted currency (eg: if you wanted to render the currency symbol in a
@@ -314,4 +321,4 @@ const getCurrencyObject = ({ number, browserSafeLocale, currency, stripZeros, is
         hasNonZeroFraction,
     };
 };
-export { numberFormatCurrency, getCurrencyObject };
+exports.getCurrencyObject = getCurrencyObject;

package/dist/number-format.d.ts

@@ -1,4 +1,4 @@
-import type { NumberFormatParams } from './types.js';
+import type { NumberFormatParams } from './types.ts';
 /**
  * Formats numbers using locale settings and/or passed options.
  * @param  params                     - The parameters for the number formatter.

package/dist/number-format.js

@@ -1,4 +1,7 @@
-import { getCachedFormatter } from './get-cached-formatter.js';
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.numberFormatCompact = exports.numberFormat = void 0;
+const get_cached_formatter_ts_1 = require("./get-cached-formatter.js");
 /**
  * Formats numbers using locale settings and/or passed options.
  * @param  params                     - The parameters for the number formatter.
@@ -33,8 +36,9 @@ const numberFormat = ({ browserSafeLocale, decimals = 0, forceLatin = true, numb
         maximumFractionDigits: decimals, // maximumFractionDigits default is the greater between minimumFractionDigits and 3
         ...numberFormatOptions,
     };
-    return getCachedFormatter({ locale, options });
+    return (0, get_cached_formatter_ts_1.getCachedFormatter)({ locale, options });
 };
+exports.numberFormat = numberFormat;
 /**
  * Convenience method for formatting numbers in a compact notation e.g. 1K, 1M, etc.
  * Basically sets `notation: 'compact'` and `maximumFractionDigits: 1` in the options.
@@ -52,4 +56,4 @@ const numberFormatCompact = ({ numberFormatOptions = {}, ...params }) => numberF
         ...numberFormatOptions,
     },
 });
-export { numberFormat, numberFormatCompact };
+exports.numberFormatCompact = numberFormatCompact;

package/dist/types.js

@@ -1 +1,2 @@
-export {};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@automattic/number-formatters",
-	"version": "1.0.0-alpha.1",
+	"version": "1.0.0-alpha.2",
 	"description": "Number formatting utilities",
 	"author": "Automattic",
 	"license": "GPL-2.0-or-later",
@@ -27,7 +27,6 @@
 		"jest-environment-jsdom": "29.7.0",
 		"typescript": "5.8.2"
 	},
-	"type": "module",
 	"exports": {
 		".": {
 			"types": "./dist/index.d.ts",

package/src/create-number-formatters.ts

@@ -1,11 +1,11 @@
 import { getSettings } from '@wordpress/date';
-import { FALLBACK_LOCALE } from './constants.js';
+import { FALLBACK_LOCALE } from './constants.ts';
 import {
 	numberFormatCurrency,
 	getCurrencyObject as getCurrencyObjectFromCurrencyFormatter,
-} from './number-format-currency/index.js';
-import { numberFormat, numberFormatCompact } from './number-format.js';
-import type { CurrencyObject, FormatCurrency, FormatNumber, GetCurrencyObject } from './types.js';
+} from './number-format-currency/index.ts';
+import { numberFormat, numberFormatCompact } from './number-format.ts';
+import type { CurrencyObject, FormatCurrency, FormatNumber, GetCurrencyObject } from './types.ts';
 
 // Since global is used inside createNumberFormatters, we need to declare it for TS
 declare const global: typeof globalThis;

package/src/get-cached-formatter.ts

@@ -1,5 +1,5 @@
 import debugFactory from 'debug';
-import { FALLBACK_LOCALE } from './constants.js';
+import { FALLBACK_LOCALE } from './constants.ts';
 
 const debug = debugFactory( 'number-formatters:get-cached-formatter' );
 

package/src/index.ts

@@ -1,4 +1,4 @@
-import createNumberFormatters from './create-number-formatters.js';
+import createNumberFormatters from './create-number-formatters.ts';
 
 const defaultFormatter = createNumberFormatters();
 
@@ -13,7 +13,7 @@ export const {
 
 export { createNumberFormatters };
 
-export * from './types.js';
+export * from './types.ts';
 
 // We can optionally export the formatters individually if we want to use them in a more granular way.
 // export { numberFormat, numberFormatCompact, numberFormatCurrency, getCurrencyObject };

package/src/number-format-currency/currencies.ts

@@ -1,4 +1,4 @@
-import type { CurrencyOverride } from '../types.js';
+import type { CurrencyOverride } from '../types.ts';
 
 export const defaultCurrencyOverrides: Record< string, CurrencyOverride > = {
 	AED: {

package/src/number-format-currency/index.ts

@@ -1,8 +1,8 @@
 import debugFactory from 'debug';
-import { FALLBACK_CURRENCY } from '../constants.js';
-import { getCachedFormatter } from '../get-cached-formatter.js';
-import { defaultCurrencyOverrides } from './currencies.js';
-import type { CurrencyOverride, CurrencyObject, NumberFormatCurrencyParams } from '../types.js';
+import { FALLBACK_CURRENCY } from '../constants.ts';
+import { getCachedFormatter } from '../get-cached-formatter.ts';
+import { defaultCurrencyOverrides } from './currencies.ts';
+import type { CurrencyOverride, CurrencyObject, NumberFormatCurrencyParams } from '../types.ts';
 
 const debug = debugFactory( 'number-formatters:number-format-currency' );
 

package/src/number-format.ts

@@ -1,5 +1,5 @@
-import { getCachedFormatter } from './get-cached-formatter.js';
-import type { NumberFormatParams } from './types.js';
+import { getCachedFormatter } from './get-cached-formatter.ts';
+import type { NumberFormatParams } from './types.ts';
 
 /**
  * Formats numbers using locale settings and/or passed options.