@quenty/clienttranslator 9.1.1 → 9.2.0

package/CHANGELOG.md

@@ -3,6 +3,18 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [9.2.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/clienttranslator@9.1.1...@quenty/clienttranslator@9.2.0) (2023-12-14)
+
+
+### Features
+
+* Add support for roundingbehaviortypes.NONE and ([6869d9e](https://github.com/Quenty/NevermoreEngine/commit/6869d9e5b3a726fa3e15e6dbbfeedebdfcc71a3d))
+* Handle studio test mode localization numbers ([a30226d](https://github.com/Quenty/NevermoreEngine/commit/a30226d1d64cb2df89450d3d33b81d15192e61ff))
+
+
+
+
+
 ## [9.1.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/clienttranslator@9.1.0...@quenty/clienttranslator@9.1.1) (2023-10-28)
 
 **Note:** Version bump only for package @quenty/clienttranslator

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/clienttranslator",
-  "version": "9.1.1",
+  "version": "9.2.0",
   "description": "Gets local translator for player",
   "keywords": [
     "Roblox",
@@ -25,18 +25,18 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/blend": "^7.1.1",
-    "@quenty/instanceutils": "^8.1.1",
-    "@quenty/loader": "^7.0.0",
+    "@quenty/blend": "^7.2.0",
+    "@quenty/instanceutils": "^8.2.0",
+    "@quenty/loader": "^7.1.0",
     "@quenty/maid": "^2.6.0",
-    "@quenty/promise": "^7.0.0",
+    "@quenty/promise": "^7.1.0",
     "@quenty/pseudolocalize": "^3.2.0",
-    "@quenty/rx": "^8.1.1",
+    "@quenty/rx": "^8.2.0",
     "@quenty/string": "^3.1.0",
-    "@quenty/table": "^3.3.0"
+    "@quenty/table": "^3.4.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "440aca7ce2b50b74317ee05fdc0b8d1e58001af3"
+  "gitHead": "2c2dbbc0cb2fbb46b4f3270c559c63890fe18b26"
 }

package/src/Client/NumberLocalizationUtils.lua

@@ -180,6 +180,7 @@ localeInfos["tr-tr"] = {
 }
 
 -- Aliases for languages that use the same mappings.
+localeInfos["en"] = localeInfos["en-us"]
 localeInfos["en-gb"] = localeInfos["en-us"]
 localeInfos["es-mx"] = localeInfos["es-es"]
 
@@ -201,7 +202,7 @@ local function roundToSignificantDigits(number, significantDigits, roundingBehav
 	local offset = findDecimalOffset(number)
 	local multiplier = 10^(significantDigits + offset)
 	local significand
-	if roundingBehaviourType == RoundingBehaviourTypes.Truncate then
+	if roundingBehaviourType == RoundingBehaviourTypes.TRUNCATE then
 		significand = math.modf(number * multiplier)
 	else
 		significand = math.floor(number * multiplier + 0.5)
@@ -228,7 +229,7 @@ local function findDenominationEntry(localeInfo, number, roundingBehaviourType)
 	for i = #localeInfo, 2, -1 do
 		local entry = localeInfo[i]
 		local baseValue
-		if roundingBehaviourType == RoundingBehaviourTypes.Truncate then
+		if roundingBehaviourType == RoundingBehaviourTypes.TRUNCATE then
 			baseValue = entry[1]
 		else
 			baseValue = entry[1] - (localeInfo[i - 1][1]) / 2
@@ -260,13 +261,31 @@ function NumberLocalizationUtils.localize(number, locale)
     return number
 end
 
+--[=[
+	Abbreviates the number to a truncated amount in a localized way.
+
+	```lua
+	print(NumberLocalizationUtils.abbreviate(2500, "en-us", RoundingBehaviourTypes.ROUND_TO_CLOSEST, 3)) --> 2.5k
+	```
+
+	@param number number
+	@param locale string
+	@param roundingBehaviourType RoundingBehaviourType?
+	@param numSignificantDigits number?
+]=]
 function NumberLocalizationUtils.abbreviate(number, locale, roundingBehaviourType, numSignificantDigits)
+	assert(type(number) == "number", "Bad number")
+
+	if roundingBehaviourType == RoundingBehaviourTypes.NONE then
+		return NumberLocalizationUtils.localize(number, locale)
+	end
+
 	if number == 0 then
 		return "0"
 	end
 
 	if roundingBehaviourType == nil then
-		roundingBehaviourType = RoundingBehaviourTypes.RoundToClosest
+		roundingBehaviourType = RoundingBehaviourTypes.ROUND_TO_CLOSEST
 	end
 
 	if numSignificantDigits == nil then
@@ -290,11 +309,14 @@ function NumberLocalizationUtils.abbreviate(number, locale, roundingBehaviourTyp
 
 	-- trim to 1 decimal point
 	local trimmedQuotient
-	if roundingBehaviourType == RoundingBehaviourTypes.Truncate then
+	if roundingBehaviourType == RoundingBehaviourTypes.TRUNCATE then
 		trimmedQuotient = math.modf(significantQuotient * 10) / 10
-	else
+	elseif roundingBehaviourType == RoundingBehaviourTypes.ROUND_TO_CLOSEST then
 		trimmedQuotient = math.floor(significantQuotient * 10 + 0.5) / 10
+	else
+		error(string.format("[NumberLocalizationUtils.abbreviate] - Unknown roundingBehaviourType %q", tostring(roundingBehaviourType)))
 	end
+
 	local trimmedQuotientString = tostring(trimmedQuotient)
 
 	-- Split the string into integer and fraction parts

package/src/Client/NumberLocalizationUtils.spec.lua

@@ -1,7 +1,7 @@
 local require = require(script.Parent.loader).load(script)
 
 local NumberLocalizationUtils = require("NumberLocalizationUtils")
-local RoundingBehaviour = require("RoundingBehaviourTypes")
+local RoundingBehaviourTypes = require("RoundingBehaviourTypes")
 
 return function()
 
@@ -68,7 +68,7 @@ return function()
 	end)
 
 	describe("NumberLocalizationUtils.abbreviate", function()
-		it("should round towards zero when using RoundingBehaviour.Truncate", function()
+		it("should round towards zero when using RoundingBehaviourTypes.Truncate", function()
 			local roundToZeroMap = {
 				[0] = "0",
 				[1] = "1",
@@ -103,7 +103,7 @@ return function()
 			}
 
 			for input, output in pairs(roundToZeroMap) do
-				expect(NumberLocalizationUtils.abbreviate(input, "en-us", RoundingBehaviour.Truncate)).to.equal(output)
+				expect(NumberLocalizationUtils.abbreviate(input, "en-us", RoundingBehaviourTypes.TRUNCATE)).to.equal(output)
 			end
 		end)
 	end)

package/src/Client/RoundingBehaviourTypes.lua

@@ -7,6 +7,7 @@ local require = require(script.Parent.loader).load(script)
 local Table = require("Table")
 
 return Table.readonly({
-	RoundToClosest = "roundToClosest";
-	Truncate = "truncate";
+	ROUND_TO_CLOSEST = "roundToClosest";
+	TRUNCATE = "truncate";
+	NONE = "None"
 })