@quenty/clienttranslator 14.19.0 → 14.19.1

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [14.19.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/clienttranslator@14.19.0...@quenty/clienttranslator@14.19.1) (2025-04-05)
+
+
+### Bug Fixes
+
+* Add types to packages ([2374fb2](https://github.com/Quenty/NevermoreEngine/commit/2374fb2b043cfbe0e9b507b3316eec46a4e353a0))
+
+
+
+
+
 # [14.19.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/clienttranslator@14.18.2...@quenty/clienttranslator@14.19.0) (2025-04-02)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/clienttranslator",
-  "version": "14.19.0",
+  "version": "14.19.1",
   "description": "Gets local translator for player",
   "keywords": [
     "Roblox",
@@ -25,20 +25,20 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/blend": "^12.18.0",
-    "@quenty/instanceutils": "^13.17.0",
-    "@quenty/loader": "^10.8.0",
-    "@quenty/maid": "^3.4.0",
-    "@quenty/promise": "^10.10.1",
-    "@quenty/promisemaid": "^5.10.1",
-    "@quenty/pseudolocalize": "^3.4.0",
-    "@quenty/rx": "^13.17.0",
-    "@quenty/string": "^3.3.1",
-    "@quenty/table": "^3.7.1",
-    "@quenty/valueobject": "^13.17.0"
+    "@quenty/blend": "^12.18.1",
+    "@quenty/instanceutils": "^13.17.1",
+    "@quenty/loader": "^10.8.1",
+    "@quenty/maid": "^3.4.1",
+    "@quenty/promise": "^10.10.2",
+    "@quenty/promisemaid": "^5.10.2",
+    "@quenty/pseudolocalize": "^3.4.1",
+    "@quenty/rx": "^13.17.1",
+    "@quenty/string": "^3.3.2",
+    "@quenty/table": "^3.7.2",
+    "@quenty/valueobject": "^13.17.1"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e8ea56930e65322fcffc05a1556d5df988068f0b"
+  "gitHead": "78c3ac0ab08dd18085b6e6e6e4f745e76ed99f68"
 }

package/src/Shared/Conversion/LocalizationEntryParserUtils.lua

@@ -21,7 +21,7 @@ function LocalizationEntryParserUtils.decodeFromInstance(tableName, sourceLocale
 	local lookupTable = {}
 	local baseKey = ""
 
-	for _, descendant in pairs(folder:GetDescendants()) do
+	for _, descendant in folder:GetDescendants() do
 		if descendant:IsA("StringValue") then
 			local localeId = LocalizationEntryParserUtils._parseLocaleFromName(descendant.Name)
 			local decodedTable = HttpService:JSONDecode(descendant.Value)
@@ -36,7 +36,7 @@ function LocalizationEntryParserUtils.decodeFromInstance(tableName, sourceLocale
 	end
 
 	local results = {}
-	for _, item in pairs(lookupTable) do
+	for _, item in lookupTable do
 		table.insert(results, item)
 	end
 	return results
@@ -50,10 +50,17 @@ function LocalizationEntryParserUtils.decodeFromTable(tableName, localeId, dataT
 	local lookupTable = {}
 
 	local baseKey = ""
-	LocalizationEntryParserUtils._parseTableToResultsList(lookupTable, localeId, localeId, baseKey, dataTable, tableName)
+	LocalizationEntryParserUtils._parseTableToResultsList(
+		lookupTable,
+		localeId,
+		localeId,
+		baseKey,
+		dataTable,
+		tableName
+	)
 
 	local results = {}
-	for _, item in pairs(lookupTable) do
+	for _, item in lookupTable do
 		table.insert(results, item)
 	end
 	return results
@@ -75,7 +82,7 @@ function LocalizationEntryParserUtils._parseTableToResultsList(lookupTable, sour
 	assert(type(dataTable) == "table", "Bad dataTable")
 	assert(type(tableName) == "string", "Bad tableName")
 
-	for index, text in pairs(dataTable) do
+	for index, text in dataTable do
 		local key = baseKey .. index
 		if type(text) == "table" then
 			LocalizationEntryParserUtils._parseTableToResultsList(lookupTable, sourceLocaleId, localeId, key .. ".", text, tableName)
@@ -92,9 +99,9 @@ function LocalizationEntryParserUtils._parseTableToResultsList(lookupTable, sour
 					Values = {
 						[localeId] = text;
 					};
-				};
+				}
 
-				lookupTable[key] = found;
+				lookupTable[key] = found
 			end
 
 			-- Ensure assignment

package/src/Shared/JSONTranslator.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Utility function that loads a translator from a folder or a table.
 
@@ -27,16 +28,33 @@ local TranslationKeyUtils = require("TranslationKeyUtils")
 local TranslatorService = require("TranslatorService")
 local ValueObject = require("ValueObject")
 local NumberLocalizationUtils = require("NumberLocalizationUtils")
+local _ServiceBag = require("ServiceBag")
+local _Observable = require("Observable")
+local _Promise = require("Promise")
 
 local JSONTranslator = {}
 JSONTranslator.ClassName = "JSONTranslator"
 JSONTranslator.ServiceName = "JSONTranslator"
 JSONTranslator.__index = JSONTranslator
 
+export type JSONTranslator = typeof(setmetatable(
+	{} :: {
+		_maid: Maid.Maid,
+		_serviceBag: _ServiceBag.ServiceBag,
+		_translatorService: TranslatorService.TranslatorService,
+		_translatorName: string,
+		_entries: { [string]: any },
+		_localizationTable: any,
+		_localTranslator: ValueObject.ValueObject<any>,
+		_sourceTranslator: ValueObject.ValueObject<any>,
+	},
+	JSONTranslator
+))
+
 --[=[
 	Constructs a new JSONTranslator from the given args.
 
-	```lua
+	```
 	local translator = JSONTranslator.new("MyTranslator", en", {
 		actions = {
 			respawn = "Respawn {playerName}";
@@ -63,7 +81,7 @@ JSONTranslator.__index = JSONTranslator
 	@param dataTable table
 	@return JSONTranslator
 ]=]
-function JSONTranslator.new(translatorName, localeId, dataTable)
+function JSONTranslator.new(translatorName: string, localeId: string, dataTable): JSONTranslator
 	assert(type(translatorName) == "string", "Bad translatorName")
 
 	local self = setmetatable({}, JSONTranslator)
@@ -81,12 +99,12 @@ function JSONTranslator.new(translatorName, localeId, dataTable)
 		error("Must pass a localeId and dataTable")
 	end
 
-	return self
+	return self :: any
 end
 
-function JSONTranslator:Init(serviceBag)
+function JSONTranslator.Init(self: JSONTranslator, serviceBag: _ServiceBag.ServiceBag)
 	self._serviceBag = assert(serviceBag, "No serviceBag")
-	self._translatorService = self._serviceBag:GetService(TranslatorService)
+	self._translatorService = self._serviceBag:GetService(TranslatorService) :: any
 
 	self._maid = Maid.new()
 	self._localTranslator = self._maid:Add(ValueObject.new(nil))
@@ -94,8 +112,8 @@ function JSONTranslator:Init(serviceBag)
 
 	self._localizationTable = self._translatorService:GetLocalizationTable()
 
-	for _, item in pairs(self._entries) do
-		for localeId, text in pairs(item.Values) do
+	for _, item in self._entries do
+		for localeId, text in item.Values do
 			self._localizationTable:SetEntryValue(item.Key, item.Source, item.Context, localeId, text)
 		end
 		self._localizationTable:SetEntryExample(item.Key, item.Source, item.Context, item.Example)
@@ -105,84 +123,107 @@ function JSONTranslator:Init(serviceBag)
 	self._maid:GiveTask(self._translatorService:ObserveLocaleId():Subscribe(function(localeId)
 		self._localTranslator.Value = self._localizationTable:GetTranslator(localeId)
 	end))
-	self._maid:GiveTask(RxInstanceUtils.observeProperty(self._localizationTable, "SourceLocaleId"):Subscribe(function(localeId)
-		self._sourceTranslator.Value = self._localizationTable:GetTranslator(localeId)
-	end))
+	self._maid:GiveTask(
+		RxInstanceUtils.observeProperty(self._localizationTable, "SourceLocaleId"):Subscribe(function(localeId)
+			self._sourceTranslator.Value = self._localizationTable:GetTranslator(localeId)
+		end)
+	)
 end
 
-function JSONTranslator:ObserveNumber(number)
+function JSONTranslator.ObserveNumber(self: JSONTranslator, number: number): _Observable.Observable<string>
 	return Rx.combineLatest({
-		localeId = self:ObserveLocaleId();
-		number = number;
+		localeId = self:ObserveLocaleId(),
+		number = number,
 	}):Pipe({
 		Rx.map(function(state)
 			return NumberLocalizationUtils.localize(state.number, state.localeId)
-		end)
-	})
+		end) :: any,
+	}) :: any
 end
 
-function JSONTranslator:ObserveAbbreviatedNumber(number, roundingBehaviourType, numSignificantDigits)
+function JSONTranslator.ObserveAbbreviatedNumber(
+	self: JSONTranslator,
+	number: number,
+	roundingBehaviourType,
+	numSignificantDigits: number?
+)
 	return Rx.combineLatest({
-		localeId = self:ObserveLocaleId();
-		roundingBehaviourType = roundingBehaviourType;
-		numSignificantDigits = numSignificantDigits;
-		number = number;
+		localeId = self:ObserveLocaleId(),
+		roundingBehaviourType = roundingBehaviourType,
+		numSignificantDigits = numSignificantDigits,
+		number = number,
 	}):Pipe({
 		Rx.map(function(state)
 			return NumberLocalizationUtils.abbreviate(
 				state.number,
 				state.localeId,
 				state.roundingBehaviourType,
-				state.numSignificantDigits)
-		end)
+				state.numSignificantDigits
+			)
+		end) :: any,
 	})
 end
 
-
 --[=[
 	Observes the translated value
 	@param translationKey string
 	@param translationArgs table? -- May have observables (or convertable to observables) in it.
 	@return Observable<string>
 ]=]
-function JSONTranslator:ObserveFormatByKey(translationKey, translationArgs)
-	assert(self ~= JSONTranslator, "Construct a new version of this class to use it")
+function JSONTranslator.ObserveFormatByKey(
+	self: JSONTranslator,
+	translationKey: string,
+	translationArgs
+): _Observable.Observable<string>
+	assert((self :: any) ~= JSONTranslator, "Construct a new version of this class to use it")
 	assert(type(translationKey) == "string", "Key must be a string")
 
 	return Rx.combineLatest({
-		cloudTranslator = self:ObserveTranslator();
-		translationKey = translationKey;
-		translationArgs = self:_observeArgs(translationArgs);
+		cloudTranslator = self:ObserveTranslator(),
+		translationKey = translationKey,
+		translationArgs = self:_observeArgs(translationArgs),
 	}):Pipe({
-		Rx.switchMap(function(mainState)
+		Rx.switchMap(function(mainState): any
 			if mainState.cloudTranslator then
 				return self._translatorService:ObserveLocaleId():Pipe({
 					Rx.map(function()
-						return self:_doTranslation(mainState.cloudTranslator, mainState.translationKey, mainState.translationArgs)
-					end);
+						return self:_doTranslation(
+							mainState.cloudTranslator,
+							mainState.translationKey,
+							mainState.translationArgs
+						)
+					end) :: any,
 				})
 			end
 
 			-- Fall back to local or source translator
 			return Rx.combineLatest({
-				localTranslator = self._localTranslator:Observe();
-				sourceTranslator = self._sourceTranslator:Observe();
+				localTranslator = self._localTranslator:Observe(),
+				sourceTranslator = self._sourceTranslator:Observe(),
 			}):Pipe({
-				Rx.map(function(state)
+				Rx.map(function(state): string?
 					if state.localTranslator then
-						return self:_doTranslation(state.localTranslator, mainState.translationKey, mainState.translationArgs)
+						return self:_doTranslation(
+							state.localTranslator,
+							mainState.translationKey,
+							mainState.translationArgs
+						)
 					elseif state.sourceTranslator then
-						return self:_doTranslation(state.sourceTranslator, mainState.translationKey, mainState.translationArgs)
+						return self:_doTranslation(
+							state.sourceTranslator,
+							mainState.translationKey,
+							mainState.translationArgs
+						)
 					else
 						return nil
 					end
-				end);
+				end) :: any,
 				Rx.where(function(value)
 					return value ~= nil
-				end);
+				end) :: any,
 			})
-		end)
-	})
+		end) :: any,
+	}) :: any
 end
 
 --[=[
@@ -197,8 +238,8 @@ end
 	@param args table?
 	@return Promise<string>
 ]=]
-function JSONTranslator:PromiseFormatByKey(translationKey, args)
-	assert(self ~= JSONTranslator, "Construct a new version of this class to use it")
+function JSONTranslator.PromiseFormatByKey(self: JSONTranslator, translationKey: string, args)
+	assert((self :: any) ~= JSONTranslator, "Construct a new version of this class to use it")
 	assert(type(translationKey) == "string", "Key must be a string")
 
 	-- Always waits for full translator to be loaded since we only get one shot
@@ -207,11 +248,20 @@ function JSONTranslator:PromiseFormatByKey(translationKey, args)
 	end)
 end
 
-function JSONTranslator:PromiseTranslator()
+--[=[
+	Returns a promise that will resolve once the Roblox translator is loaded from the cloud.
+	@return Promise<Translator>
+]=]
+function JSONTranslator.PromiseTranslator(self: JSONTranslator): _Promise.Promise<Translator>
 	return self._translatorService:PromiseTranslator()
 end
 
-function JSONTranslator:ObserveTranslator()
+--[=[
+	Observes the current Roblox translator for this translator.
+
+	@return Observable<Translator>
+]=]
+function JSONTranslator.ObserveTranslator(self: JSONTranslator): _Observable.Observable<Translator>
 	return self._translatorService:ObserveTranslator()
 end
 
@@ -220,7 +270,7 @@ end
 
 	@return Observable<string>
 ]=]
-function JSONTranslator:ObserveLocaleId()
+function JSONTranslator.ObserveLocaleId(self: JSONTranslator): _Observable.Observable<string>
 	return self._translatorService:ObserveLocaleId()
 end
 
@@ -235,7 +285,14 @@ end
 	@param localeId string
 	@param text string
 ]=]
-function JSONTranslator:SetEntryValue(translationKey, source, context, localeId, text)
+function JSONTranslator.SetEntryValue(
+	self: JSONTranslator,
+	translationKey: string,
+	source: string,
+	context: string,
+	localeId: string,
+	text: string
+)
 	assert(type(translationKey) == "string", "Bad translationKey")
 	assert(type(source) == "string", "Bad source")
 	assert(type(context) == "string", "Bad context")
@@ -245,18 +302,44 @@ function JSONTranslator:SetEntryValue(translationKey, source, context, localeId,
 	self._localizationTable:SetEntryValue(translationKey, source, context, localeId, text or source)
 
 	if RunService:IsStudio() then
-		self._localizationTable:SetEntryValue(translationKey, source, context, PseudoLocalize.getDefaultPseudoLocaleId(), PseudoLocalize.pseudoLocalize(text))
+		self._localizationTable:SetEntryValue(
+			translationKey,
+			source,
+			context,
+			PseudoLocalize.getDefaultPseudoLocaleId(),
+			PseudoLocalize.pseudoLocalize(text)
+		)
 	end
 end
 
-function JSONTranslator:ObserveTranslation(prefix, text, translationArgs)
+--[=[
+	Observes a translation key and formats it with the given args.
+
+	@param prefix string
+	@param text string
+	@param translationArgs table?
+	@return Observable<string>
+]=]
+function JSONTranslator.ObserveTranslation(
+	self: JSONTranslator,
+	prefix: string,
+	text: string,
+	translationArgs
+): _Observable.Observable<string>
 	assert(type(prefix) == "string", "Bad text")
 	assert(type(text) == "string", "Bad text")
 
 	return self:ObserveFormatByKey(self:ToTranslationKey(prefix, text), translationArgs)
 end
 
-function JSONTranslator:ToTranslationKey(prefix, text)
+--[=[
+	Converts the given prefix and text into a translation key.
+
+	@param prefix string
+	@param text string
+	@return string
+]=]
+function JSONTranslator.ToTranslationKey(self: JSONTranslator, prefix: string, text: string): string
 	assert(type(prefix) == "string", "Bad text")
 	assert(type(text) == "string", "Bad text")
 
@@ -274,16 +357,16 @@ end
 
 	@return string
 ]=]
-function JSONTranslator:GetLocaleId()
+function JSONTranslator.GetLocaleId(self: JSONTranslator): string
 	return self._translatorService:GetLocaleId()
 end
 
 --[=[
 	Gets the localization table the translation is using.
 
-	@return LocalizaitonTable
+	@return LocalizationTable
 ]=]
-function JSONTranslator:GetLocalizationTable()
+function JSONTranslator.GetLocalizationTable(self: JSONTranslator): LocalizationTable
 	return self._localizationTable
 end
 
@@ -291,7 +374,7 @@ end
 	Returns a promise that will resolve once the translator is loaded from the cloud.
 	@return Promise
 ]=]
-function JSONTranslator:PromiseLoaded()
+function JSONTranslator.PromiseLoaded(self: JSONTranslator): _Promise.Promise<()>
 	return self:PromiseTranslator()
 end
 
@@ -307,8 +390,8 @@ end
 	@param args table?
 	@return string
 ]=]
-function JSONTranslator:FormatByKey(translationKey, args)
-	assert(self ~= JSONTranslator, "Construct a new version of this class to use it")
+function JSONTranslator.FormatByKey(self: JSONTranslator, translationKey: string, args): string
+	assert((self :: any) ~= JSONTranslator, "Construct a new version of this class to use it")
 	assert(type(translationKey) == "string", "Key must be a string")
 
 	local translator = self._translatorService:GetTranslator()
@@ -319,24 +402,29 @@ function JSONTranslator:FormatByKey(translationKey, args)
 	return self:_doTranslation(translator, translationKey, args)
 end
 
-function JSONTranslator:_observeArgs(translationArgs)
+function JSONTranslator._observeArgs(_self: JSONTranslator, translationArgs): _Observable.Observable<any>
 	if translationArgs == nil then
 		return Rx.of(nil)
 	end
 
 	local args = {}
-	for argKey, value in pairs(translationArgs) do
+	for argKey, value in translationArgs do
 		args[argKey] = Blend.toPropertyObservable(value) or Rx.of(value)
 	end
 
 	return Rx.combineLatest(args)
 end
 
-function JSONTranslator:_doTranslation(translator, translationKey, args)
+function JSONTranslator._doTranslation(
+	self: JSONTranslator,
+	translator: Translator,
+	translationKey: string,
+	args
+): string
 	assert(typeof(translator) == "Instance", "Bad translator")
 	assert(type(translationKey) == "string", "Bad translationKey")
 
-	local translation
+	local translation: string
 	local ok, err = pcall(function()
 		translation = translator:FormatByKey(translationKey, args)
 	end)
@@ -371,7 +459,7 @@ function JSONTranslator:_doTranslation(translator, translationKey, args)
 		end)
 	end
 
-	if ok and not err then
+	if ok and not err and translation then
 		return translation
 	end
 
@@ -382,9 +470,9 @@ end
 	Cleans up the translator and deletes the localization table if it exists.
 	Should be called by [ServiceBag]
 ]=]
-function JSONTranslator:Destroy()
+function JSONTranslator.Destroy(self: JSONTranslator)
 	self._maid:DoCleaning()
-	setmetatable(self, nil)
+	setmetatable(self :: any, nil)
 end
 
 return JSONTranslator

package/src/Shared/Numbers/NumberLocalizationUtils.lua

@@ -38,145 +38,145 @@ local localeInfos = {}
 localeInfos["en-us"] = {
 	[DECIMAL_SEPARATOR] = ".",
 	[GROUP_DELIMITER] = ",",
-	{ 1, "", },
-	{ 1e3, "K", },
-	{ 1e6, "M", },
-	{ 1e9, "B", },
+	{ 1, "" },
+	{ 1e3, "K" },
+	{ 1e6, "M" },
+	{ 1e9, "B" },
 }
 
 localeInfos["es-es"] = {
 	[DECIMAL_SEPARATOR] = ",",
 	[GROUP_DELIMITER] = ".",
-	{ 1, "", },
-	{ 1e3, " mil", },
-	{ 1e6, " M", },
+	{ 1, "" },
+	{ 1e3, " mil" },
+	{ 1e6, " M" },
 }
 
 localeInfos["fr-fr"] = {
 	[DECIMAL_SEPARATOR] = ",",
 	[GROUP_DELIMITER] = " ",
-	{ 1, "", },
-	{ 1e3, " k", },
-	{ 1e6, " M", },
-	{ 1e9, " Md", },
+	{ 1, "" },
+	{ 1e3, " k" },
+	{ 1e6, " M" },
+	{ 1e9, " Md" },
 }
 
 localeInfos["de-de"] = {
 	[DECIMAL_SEPARATOR] = ",",
 	[GROUP_DELIMITER] = " ",
-	{ 1, "", },
-	{ 1e3, " Tsd.", },
-	{ 1e6, " Mio.", },
-	{ 1e9, " Mrd.", },
+	{ 1, "" },
+	{ 1e3, " Tsd." },
+	{ 1e6, " Mio." },
+	{ 1e9, " Mrd." },
 }
 
 localeInfos["pt-br"] = {
 	[DECIMAL_SEPARATOR] = ",",
 	[GROUP_DELIMITER] = ".",
-	{ 1, "", },
-	{ 1e3, " mil", },
-	{ 1e6, " mi", },
-	{ 1e9, " bi", },
+	{ 1, "" },
+	{ 1e3, " mil" },
+	{ 1e6, " mi" },
+	{ 1e9, " bi" },
 }
 
 localeInfos["zh-cn"] = {
 	[DECIMAL_SEPARATOR] = ".",
 	[GROUP_DELIMITER] = ",", -- Chinese commonly uses 3 digit groupings, despite 10000s rule
-	{ 1, "", },
-	{ 1e3, "千", },
-	{ 1e4, "万", },
-	{ 1e8, "亿", },
+	{ 1, "" },
+	{ 1e3, "千" },
+	{ 1e4, "万" },
+	{ 1e8, "亿" },
 }
 
 localeInfos["zh-cjv"] = {
 	[DECIMAL_SEPARATOR] = ".",
 	[GROUP_DELIMITER] = ",",
-	{ 1, "", },
-	{ 1e3, "千", },
-	{ 1e4, "万", },
-	{ 1e8, "亿", },
+	{ 1, "" },
+	{ 1e3, "千" },
+	{ 1e4, "万" },
+	{ 1e8, "亿" },
 }
 
 localeInfos["zh-tw"] = {
 	[DECIMAL_SEPARATOR] = ".",
 	[GROUP_DELIMITER] = ",",
-	{ 1, "", },
-	{ 1e3, "千", },
-	{ 1e4, "萬", },
-	{ 1e8, "億", },
+	{ 1, "" },
+	{ 1e3, "千" },
+	{ 1e4, "萬" },
+	{ 1e8, "億" },
 }
 
 localeInfos["ko-kr"] = {
 	[DECIMAL_SEPARATOR] = ".",
 	[GROUP_DELIMITER] = ",",
-	{ 1, "", },
-	{ 1e3, "천", },
-	{ 1e4, "만", },
-	{ 1e8, "억", },
+	{ 1, "" },
+	{ 1e3, "천" },
+	{ 1e4, "만" },
+	{ 1e8, "억" },
 }
 
 localeInfos["ja-jp"] = {
 	[DECIMAL_SEPARATOR] = ".",
 	[GROUP_DELIMITER] = ",",
-	{ 1, "", },
-	{ 1e3, "千", },
-	{ 1e4, "万", },
-	{ 1e8, "億", },
+	{ 1, "" },
+	{ 1e3, "千" },
+	{ 1e4, "万" },
+	{ 1e8, "億" },
 }
 
 localeInfos["it-it"] = {
 	[DECIMAL_SEPARATOR] = ",",
 	[GROUP_DELIMITER] = " ",
-	{ 1, "", },
-	{ 1e3, " mila", },
-	{ 1e6, " Mln", },
-	{ 1e9, " Mld", },
+	{ 1, "" },
+	{ 1e3, " mila" },
+	{ 1e6, " Mln" },
+	{ 1e9, " Mld" },
 }
 
 localeInfos["ru-ru"] = {
 	[DECIMAL_SEPARATOR] = ",",
 	[GROUP_DELIMITER] = ".",
-	{ 1, "", },
-	{ 1e3, " тыс", },
-	{ 1e6, " млн", },
-	{ 1e9, " млрд", },
+	{ 1, "" },
+	{ 1e3, " тыс" },
+	{ 1e6, " млн" },
+	{ 1e9, " млрд" },
 }
 
 localeInfos["id-id"] = {
 	[DECIMAL_SEPARATOR] = ",",
 	[GROUP_DELIMITER] = ".",
-	{ 1, "", },
-	{ 1e3, " rb", },
-	{ 1e6, " jt", },
-	{ 1e9, " M", },
+	{ 1, "" },
+	{ 1e3, " rb" },
+	{ 1e6, " jt" },
+	{ 1e9, " M" },
 }
 
 localeInfos["vi-vn"] = {
 	[DECIMAL_SEPARATOR] = ".",
 	[GROUP_DELIMITER] = " ",
-	{ 1, "", },
-	{ 1e3, " N", },
-	{ 1e6, " Tr", },
-	{ 1e9, " T", },
+	{ 1, "" },
+	{ 1e3, " N" },
+	{ 1e6, " Tr" },
+	{ 1e9, " T" },
 }
 
 localeInfos["th-th"] = {
 	[DECIMAL_SEPARATOR] = ".",
 	[GROUP_DELIMITER] = ",",
-	{ 1, "", },
-	{ 1e3, " พ", },
-	{ 1e4, " ม", },
-	{ 1e5, " ส", },
-	{ 1e6, " ล", },
+	{ 1, "" },
+	{ 1e3, " พ" },
+	{ 1e4, " ม" },
+	{ 1e5, " ส" },
+	{ 1e6, " ล" },
 }
 
 localeInfos["tr-tr"] = {
 	[DECIMAL_SEPARATOR] = ",",
 	[GROUP_DELIMITER] = ".",
-	{ 1, "", },
-	{ 1e3, " B", },
-	{ 1e6, " Mn", },
-	{ 1e9, " Mr", },
+	{ 1, "" },
+	{ 1e3, " B" },
+	{ 1e6, " Mn" },
+	{ 1e9, " Mr" },
 }
 
 -- Aliases for languages that use the same mappings.
@@ -184,12 +184,12 @@ localeInfos["en"] = localeInfos["en-us"]
 localeInfos["en-gb"] = localeInfos["en-us"]
 localeInfos["es-mx"] = localeInfos["es-es"]
 
-local function findDecimalPointIndex(numberStr)
+local function findDecimalPointIndex(numberStr: string)
 	return string.find(numberStr, "%.") or #numberStr + 1
 end
 
 -- Find the base 10 offset needed to make 0.1 <= abs(number) < 1
-local function findDecimalOffset(number)
+local function findDecimalOffset(number: number)
 	if number == 0 then
 		return 0
 	end
@@ -198,19 +198,23 @@ local function findDecimalOffset(number)
 	return -(offsetToOnesRange + 1) -- Offset one more (or less) digit
 end
 
-local function roundToSignificantDigits(number, significantDigits, roundingBehaviourType)
+local function roundToSignificantDigits(
+	number: number,
+	significantDigits: number,
+	roundingBehaviourType: RoundingBehaviourTypes.RoundingBehaviourType
+)
 	local offset = findDecimalOffset(number)
-	local multiplier = 10^(significantDigits + offset)
+	local multiplier = 10 ^ (significantDigits + offset)
 	local significand
 	if roundingBehaviourType == RoundingBehaviourTypes.TRUNCATE then
 		significand = math.modf(number * multiplier)
 	else
 		significand = math.floor(number * multiplier + 0.5)
 	end
-	return significand / multiplier;
+	return significand / multiplier
 end
 
-local function addGroupDelimiters(numberStr, delimiter)
+local function addGroupDelimiters(numberStr, delimiter: string): string
 	local formatted = numberStr
 	local delimiterSubStr = string.format("%%1%s%%2", delimiter)
 	while true do
@@ -223,7 +227,7 @@ local function addGroupDelimiters(numberStr, delimiter)
 	return formatted
 end
 
-local function findDenominationEntry(localeInfo, number, roundingBehaviourType)
+local function findDenominationEntry(localeInfo, number: number, roundingBehaviourType)
 	local denominationEntry = localeInfo[1] -- Default to base denominations
 	local absOfNumber = math.abs(number)
 	for i = #localeInfo, 2, -1 do
@@ -232,7 +236,7 @@ local function findDenominationEntry(localeInfo, number, roundingBehaviourType)
 		if roundingBehaviourType == RoundingBehaviourTypes.TRUNCATE then
 			baseValue = entry[1]
 		else
-			baseValue = entry[1] - (localeInfo[i - 1][1]) / 2
+			baseValue = entry[1] - localeInfo[i - 1][1] / 2
 		end
 		if baseValue <= absOfNumber then
 			denominationEntry = entry
@@ -242,7 +246,7 @@ local function findDenominationEntry(localeInfo, number, roundingBehaviourType)
 	return denominationEntry
 end
 
-function NumberLocalizationUtils.localize(number, locale)
+function NumberLocalizationUtils.localize(number: number, locale: string): string
 	if number == 0 then
 		return "0"
 	end
@@ -250,15 +254,20 @@ function NumberLocalizationUtils.localize(number, locale)
 	local localeInfo = localeInfos[locale]
 	if not localeInfo then
 		localeInfo = localeInfos[DEFAULT_LOCALE]
-		warn(string.format("[NumberLocalizationUtils] - Locale not found: '%s', reverting to '%s' instead.",
-			tostring(locale), DEFAULT_LOCALE))
+		warn(
+			string.format(
+				"[NumberLocalizationUtils] - Locale not found: '%s', reverting to '%s' instead.",
+				tostring(locale),
+				DEFAULT_LOCALE
+			)
+		)
 	end
 
-    if localeInfo.groupDelimiter then
-        return addGroupDelimiters(number, localeInfo.groupDelimiter)
-    end
+	if localeInfo.groupDelimiter then
+		return addGroupDelimiters(number, localeInfo.groupDelimiter)
+	end
 
-    return number
+	return tostring(number)
 end
 
 --[=[
@@ -272,11 +281,14 @@ end
 	@param locale string
 	@param roundingBehaviourType RoundingBehaviourType?
 	@param numSignificantDigits number?
+	@return string
 ]=]
-function NumberLocalizationUtils.abbreviate(number, locale, roundingBehaviourType, numSignificantDigits)
+function NumberLocalizationUtils.abbreviate(number: number, locale: string, roundingBehaviourType: RoundingBehaviourTypes.RoundingBehaviourType?, numSignificantDigits: number?): string
 	assert(type(number) == "number", "Bad number")
+	local roundingBehavior = roundingBehaviourType or RoundingBehaviourTypes.ROUND_TO_CLOSEST
+	local significantDigits = numSignificantDigits or 3
 
-	if roundingBehaviourType == RoundingBehaviourTypes.NONE then
+	if roundingBehavior == RoundingBehaviourTypes.NONE then
 		return NumberLocalizationUtils.localize(number, locale)
 	end
 
@@ -284,41 +296,43 @@ function NumberLocalizationUtils.abbreviate(number, locale, roundingBehaviourTyp
 		return "0"
 	end
 
-	if roundingBehaviourType == nil then
-		roundingBehaviourType = RoundingBehaviourTypes.ROUND_TO_CLOSEST
-	end
-
-	if numSignificantDigits == nil then
-		numSignificantDigits = 3
-	end
-
 	local localeInfo = localeInfos[locale]
 	if not localeInfo then
 		localeInfo = localeInfos[DEFAULT_LOCALE]
-		warn(string.format("[NumberLocalizationUtils] - Locale not found: '%s', reverting to '%s' instead.",
-			tostring(locale), DEFAULT_LOCALE))
+		warn(
+			string.format(
+				"[NumberLocalizationUtils] - Locale not found: '%s', reverting to '%s' instead.",
+				tostring(locale),
+				DEFAULT_LOCALE
+			)
+		)
 	end
 
 	-- select which denomination we are going to use
-	local denominationEntry = findDenominationEntry(localeInfo, number, roundingBehaviourType)
+	local denominationEntry = findDenominationEntry(localeInfo, number, roundingBehavior)
 	local baseValue = denominationEntry[1]
 	local symbol = denominationEntry[2]
 
 	-- Round to required significant digits
-	local significantQuotient = roundToSignificantDigits(number / baseValue, numSignificantDigits, roundingBehaviourType)
+	local significantQuotient = roundToSignificantDigits(number / baseValue, significantDigits, roundingBehavior)
 
 	-- trim decimal points
 	local trimmedQuotientString
 	local symbolsAboveDecimal = math.ceil(math.log10(significantQuotient))
-	local maxDecimals = math.max(1, numSignificantDigits - symbolsAboveDecimal)
+	local maxDecimals = math.max(1, significantDigits - symbolsAboveDecimal)
 	local trimmedQuotient
-	local roundingFactor = 10^maxDecimals
-	if roundingBehaviourType == RoundingBehaviourTypes.TRUNCATE then
+	local roundingFactor = 10 ^ maxDecimals
+	if roundingBehavior == RoundingBehaviourTypes.TRUNCATE then
 		trimmedQuotient = math.modf(significantQuotient * roundingFactor) / roundingFactor
-	elseif roundingBehaviourType == RoundingBehaviourTypes.ROUND_TO_CLOSEST then
+	elseif roundingBehavior == RoundingBehaviourTypes.ROUND_TO_CLOSEST then
 		trimmedQuotient = math.floor(significantQuotient * roundingFactor + 0.5) / roundingFactor
 	else
-		error(string.format("[NumberLocalizationUtils.abbreviate] - Unknown roundingBehaviourType %q", tostring(roundingBehaviourType)))
+		error(
+			string.format(
+				"[NumberLocalizationUtils.abbreviate] - Unknown roundingBehaviourType %q",
+				tostring(roundingBehavior)
+			)
+		)
 	end
 
 	trimmedQuotientString = tostring(trimmedQuotient)
@@ -340,4 +354,4 @@ function NumberLocalizationUtils.abbreviate(number, locale, roundingBehaviourTyp
 	end
 end
 
-return NumberLocalizationUtils
+return NumberLocalizationUtils

package/src/Shared/Numbers/NumberLocalizationUtils.spec.lua

@@ -8,13 +8,13 @@ local describe = Jest.Globals.describe
 local expect = Jest.Globals.expect
 local it = Jest.Globals.it
 
-local function checkLocale(locale, responseMapping)
-	for input, output in pairs(responseMapping) do
+local function checkLocale(locale: string, responseMapping)
+	for input, output in responseMapping do
 		expect(NumberLocalizationUtils.localize(input, locale)).toBe(output)
 	end
 end
 
-local function checkValid_en_zh(locale)
+local function checkValid_en_zh(locale: string)
 	checkLocale(locale, {
 		[0] = "0",
 		[1] = "1",
@@ -105,8 +105,8 @@ describe("NumberLocalizationUtils.abbreviate", function()
 			[-1499.99] = "-1.4K",
 		}
 
-		for input, output in pairs(roundToZeroMap) do
+		for input, output in roundToZeroMap do
 			expect(NumberLocalizationUtils.abbreviate(input, "en-us", RoundingBehaviourTypes.TRUNCATE)).toBe(output)
 		end
 	end)
-end)
+end)

package/src/Shared/Numbers/RoundingBehaviourTypes.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	@class RoundingBehaviourTypes
 ]=]
@@ -6,8 +7,16 @@ local require = require(script.Parent.loader).load(script)
 
 local Table = require("Table")
 
+export type RoundingBehaviourType = "roundToClosest" | "truncate" | "None"
+
+export type RoundingBehaviourTypeMap = {
+	ROUND_TO_CLOSEST: "roundToClosest",
+	TRUNCATE: "truncate",
+	NONE: "none",
+}
+
 return Table.readonly({
-	ROUND_TO_CLOSEST = "roundToClosest";
-	TRUNCATE = "truncate";
-	NONE = "None"
-})
+	ROUND_TO_CLOSEST = "roundToClosest",
+	TRUNCATE = "truncate",
+	NONE = "none",
+} :: RoundingBehaviourTypeMap)

package/src/Shared/TranslatorService.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Handles selecting the right locale/translator for Studio, and Roblox games.
 
@@ -10,17 +11,33 @@ local Players = game:GetService("Players")
 local RunService = game:GetService("RunService")
 local LocalizationService = game:GetService("LocalizationService")
 
-local RxInstanceUtils = require("RxInstanceUtils")
-local Rx = require("Rx")
 local LocalizationServiceUtils = require("LocalizationServiceUtils")
-local ValueObject = require("ValueObject")
 local Maid = require("Maid")
 local Promise = require("Promise")
+local Rx = require("Rx")
+local RxInstanceUtils = require("RxInstanceUtils")
+local ValueObject = require("ValueObject")
+local _Observable = require("Observable")
+local _ServiceBag = require("ServiceBag")
 
 local TranslatorService = {}
 TranslatorService.ServiceName = "TranslatorService"
 
-function TranslatorService:Init(serviceBag)
+export type TranslatorService = typeof(setmetatable(
+	{} :: {
+		_maid: Maid.Maid,
+		_serviceBag: _ServiceBag.ServiceBag,
+		_translator: ValueObject.ValueObject<Translator>,
+		_localizationTable: LocalizationTable?,
+		_pendingTranslatorPromise: Promise.Promise<Translator>?,
+		_localeIdValue: ValueObject.ValueObject<string>?,
+		_loadedPlayerObservable: _Observable.Observable<Player>?,
+		_loadedPlayer: Player?,
+	},
+	{ __index = TranslatorService }
+))
+
+function TranslatorService.Init(self: TranslatorService, serviceBag: _ServiceBag.ServiceBag)
 	assert(not self._serviceBag, "Already initialized")
 	self._serviceBag = assert(serviceBag, "No serviceBag")
 	self._maid = Maid.new()
@@ -29,7 +46,7 @@ function TranslatorService:Init(serviceBag)
 	self._translator:Mount(self:_observeTranslatorImpl())
 end
 
-function TranslatorService:GetLocalizationTable()
+function TranslatorService.GetLocalizationTable(self: TranslatorService): LocalizationTable
 	if self._localizationTable then
 		return self._localizationTable
 	end
@@ -47,7 +64,7 @@ function TranslatorService:GetLocalizationTable()
 	return localizationTable
 end
 
-function TranslatorService:_getLocalizationTableName()
+function TranslatorService._getLocalizationTableName(_self: TranslatorService): string
 	if RunService:IsServer() then
 		return "GeneratedJSONTable_Server"
 	else
@@ -60,7 +77,7 @@ end
 
 	@return Observable<Translator>
 ]=]
-function TranslatorService:ObserveTranslator()
+function TranslatorService.ObserveTranslator(self: TranslatorService): _Observable.Observable<Translator>
 	return self._translator:Observe()
 end
 
@@ -69,7 +86,7 @@ end
 
 	@return Observable<Translator>
 ]=]
-function TranslatorService:PromiseTranslator()
+function TranslatorService.PromiseTranslator(self: TranslatorService): Promise.Promise<Translator>
 	local found = self._translator.Value
 	if found then
 		return Promise.resolved(found)
@@ -95,7 +112,7 @@ function TranslatorService:PromiseTranslator()
 		end
 	end)
 
-	maid:GiveTask(self._translator:Observe():Subscribe(function(translator)
+	maid:GiveTask(self._translator:Observe():Subscribe(function(translator: Translator)
 		if translator then
 			promise:Resolve(translator)
 		end
@@ -109,7 +126,7 @@ end
 
 	@return Translator?
 ]=]
-function TranslatorService:GetTranslator()
+function TranslatorService.GetTranslator(self: TranslatorService): Translator?
 	return self._translator.Value
 end
 
@@ -118,34 +135,34 @@ end
 
 	@return Observable<string>
 ]=]
-function TranslatorService:ObserveLocaleId()
+function TranslatorService.ObserveLocaleId(self: TranslatorService): _Observable.Observable<string>
 	if self._localeIdValue then
 		return self._localeIdValue:Observe()
 	end
 
-	self._localeIdValue = self._maid:Add(ValueObject.new("en-us", "string"))
+	local valueObject = self._maid:Add(ValueObject.new("en-us", "string"))
 
-	self._localeIdValue:Mount(self._translator:Observe():Pipe({
-		Rx.switchMap(function(translator)
+	valueObject:Mount(self._translator:Observe():Pipe({
+		Rx.switchMap(function(translator: Translator): any
 			if translator then
 				return RxInstanceUtils.observeProperty(translator, "LocaleId")
 			else
 				-- Fallback
 				return self:_observeLoadedPlayer():Pipe({
-					Rx.switchMap(function(player)
+					Rx.switchMap(function(player: Player)
 						if player then
 							return RxInstanceUtils.observeProperty(player, "LocaleId")
 						else
 							return RxInstanceUtils.observeProperty(LocalizationService, "RobloxLocaleId")
 						end
-					end)
+					end) :: any,
 				})
 			end
-		end);
-		Rx.distinct();
+		end) :: any,
+		Rx.distinct(),
 	}))
-
-	return self._localeIdValue:Observe()
+	self._localeIdValue = valueObject
+	return valueObject:Observe()
 end
 
 --[=[
@@ -153,7 +170,7 @@ end
 
 	@return string
 ]=]
-function TranslatorService:GetLocaleId()
+function TranslatorService.GetLocaleId(self: TranslatorService): string
 	local found = self._translator.Value
 	if found then
 		return found.LocaleId
@@ -168,52 +185,53 @@ function TranslatorService:GetLocaleId()
 	end
 end
 
-function TranslatorService:_observeTranslatorImpl()
+function TranslatorService._observeTranslatorImpl(self: TranslatorService): _Observable.Observable<Translator>
 	return self:_observeLoadedPlayer():Pipe({
-		Rx.switchMap(function(loadedPlayer)
+		Rx.switchMap(function(loadedPlayer: Player): any
 			if loadedPlayer then
 				return Rx.fromPromise(LocalizationServiceUtils.promisePlayerTranslator(loadedPlayer))
 			end
 
 			return RxInstanceUtils.observeProperty(LocalizationService, "RobloxLocaleId"):Pipe({
-				Rx.switchMap(function(localeId)
+				Rx.switchMap(function(localeId: string): any
 					-- This can actually take a while (20-30 seconds)
 					return Rx.fromPromise(LocalizationServiceUtils.promiseTranslatorForLocale(localeId))
-				end)
+				end) :: any,
 			})
-		end);
-	})
+		end) :: any,
+	}) :: any
 end
 
-function TranslatorService:_observeLoadedPlayer()
+function TranslatorService._observeLoadedPlayer(self: TranslatorService): _Observable.Observable<Player>
 	if self._loadedPlayerObservable then
 		return self._loadedPlayerObservable
 	end
 
-	self._loadedPlayerObservable = RxInstanceUtils.observeProperty(Players, "LocalPlayer"):Pipe({
-		Rx.switchMap(function(player)
+	local observable: any = RxInstanceUtils.observeProperty(Players, "LocalPlayer"):Pipe({
+		Rx.switchMap(function(player: Player): any
 			if not player then
 				return Rx.of(nil)
 			end
 
 			return RxInstanceUtils.observeProperty(player, "LocaleId"):Pipe({
-				Rx.map(function(localeId)
+				Rx.map(function(localeId): Player?
 					if localeId == "" then
 						return nil
 					else
 						return player
 					end
-				end);
+				end) :: any,
 			})
-		end);
-		Rx.distinct();
-		Rx.cache();
+		end) :: any,
+		Rx.distinct() :: any,
+		Rx.cache() :: any,
 	})
+	self._loadedPlayerObservable = observable
 
-	return self._loadedPlayerObservable
+	return observable
 end
 
-function TranslatorService:Destroy()
+function TranslatorService.Destroy(self: TranslatorService)
 	self._maid:DoCleaning()
 end
 

package/src/Shared/Utils/LocalizationServiceUtils.lua

@@ -39,7 +39,7 @@ function LocalizationServiceUtils.promiseTranslatorForLocale(localeId)
 	end)
 end
 
-function LocalizationServiceUtils.promisePlayerTranslator(player)
+function LocalizationServiceUtils.promisePlayerTranslator(player: Player)
 	local promiseTranslator = Promise.spawn(function(resolve, reject)
 		local translator = nil
 		local ok, err = pcall(function()