@quenty/clienttranslator 14.19.3 → 14.19.4-canary.11a5dcf.0

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [14.19.4-canary.11a5dcf.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/clienttranslator@14.19.3...@quenty/clienttranslator@14.19.4-canary.11a5dcf.0) (2025-05-10)
+
+
+### Bug Fixes
+
+* Additional type checking updates ([05ba29a](https://github.com/Quenty/NevermoreEngine/commit/05ba29a03efc9f3feed74b34f1d9dfb237496214))
+
+
+### Features
+
+* Add even more types ([b31717d](https://github.com/Quenty/NevermoreEngine/commit/b31717d8c9f7620c457f5018a2affa760a65334a))
+
+
+
+
+
 ## [14.19.3](https://github.com/Quenty/NevermoreEngine/compare/@quenty/clienttranslator@14.19.2...@quenty/clienttranslator@14.19.3) (2025-04-10)
 
 **Note:** Version bump only for package @quenty/clienttranslator

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/clienttranslator",
-  "version": "14.19.3",
+  "version": "14.19.4-canary.11a5dcf.0",
   "description": "Gets local translator for player",
   "keywords": [
     "Roblox",
@@ -25,20 +25,20 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/blend": "^12.18.3",
-    "@quenty/instanceutils": "^13.17.3",
-    "@quenty/loader": "^10.8.3",
-    "@quenty/maid": "^3.4.3",
-    "@quenty/promise": "^10.10.4",
-    "@quenty/promisemaid": "^5.10.4",
-    "@quenty/pseudolocalize": "^3.4.2",
-    "@quenty/rx": "^13.17.3",
-    "@quenty/string": "^3.3.3",
-    "@quenty/table": "^3.7.4",
-    "@quenty/valueobject": "^13.17.3"
+    "@quenty/blend": "12.18.4-canary.11a5dcf.0",
+    "@quenty/instanceutils": "13.17.4-canary.11a5dcf.0",
+    "@quenty/loader": "10.8.4-canary.11a5dcf.0",
+    "@quenty/maid": "3.4.4-canary.11a5dcf.0",
+    "@quenty/promise": "10.10.5-canary.11a5dcf.0",
+    "@quenty/promisemaid": "5.10.5-canary.11a5dcf.0",
+    "@quenty/pseudolocalize": "3.4.3-canary.11a5dcf.0",
+    "@quenty/rx": "13.17.4-canary.11a5dcf.0",
+    "@quenty/string": "3.3.3",
+    "@quenty/table": "3.7.5-canary.11a5dcf.0",
+    "@quenty/valueobject": "13.17.4-canary.11a5dcf.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "b06c070ae91d5dab7bd8de6e290ad2caabb15d8f"
+  "gitHead": "11a5dcf7d4c7a0bfbf3337e97d30e8346ea09d3f"
 }

package/src/Shared/Conversion/LocalizationEntryParserUtils.lua

@@ -14,7 +14,7 @@ local PseudoLocalize = require("PseudoLocalize")
 
 local LocalizationEntryParserUtils = {}
 
-function LocalizationEntryParserUtils.decodeFromInstance(tableName, sourceLocaleId, folder)
+function LocalizationEntryParserUtils.decodeFromInstance(tableName: string, sourceLocaleId: string, folder: Instance)
 	assert(type(tableName) == "string", "Bad tableName")
 	assert(typeof(folder) == "Instance", "Bad folder")
 
@@ -26,12 +26,26 @@ function LocalizationEntryParserUtils.decodeFromInstance(tableName, sourceLocale
 			local localeId = LocalizationEntryParserUtils._parseLocaleFromName(descendant.Name)
 			local decodedTable = HttpService:JSONDecode(descendant.Value)
 
-			LocalizationEntryParserUtils._parseTableToResultsList(lookupTable, sourceLocaleId, localeId, baseKey, decodedTable, tableName)
+			LocalizationEntryParserUtils._parseTableToResultsList(
+				lookupTable,
+				sourceLocaleId,
+				localeId,
+				baseKey,
+				decodedTable,
+				tableName
+			)
 		elseif descendant:IsA("ModuleScript") then
 			local localeId = LocalizationEntryParserUtils._parseLocaleFromName(descendant.Name)
 			local decodedTable = require(descendant)
 
-			LocalizationEntryParserUtils._parseTableToResultsList(lookupTable, sourceLocaleId, localeId, baseKey, decodedTable, tableName)
+			LocalizationEntryParserUtils._parseTableToResultsList(
+				lookupTable,
+				sourceLocaleId,
+				localeId,
+				baseKey,
+				decodedTable,
+				tableName
+			)
 		end
 	end
 
@@ -42,7 +56,7 @@ function LocalizationEntryParserUtils.decodeFromInstance(tableName, sourceLocale
 	return results
 end
 
-function LocalizationEntryParserUtils.decodeFromTable(tableName, localeId, dataTable)
+function LocalizationEntryParserUtils.decodeFromTable(tableName: string, localeId: string, dataTable)
 	assert(type(tableName) == "string", "Bad tableName")
 	assert(type(localeId) == "string", "Bad localeId")
 	assert(type(dataTable) == "table", "Bad dataTable")
@@ -66,15 +80,22 @@ function LocalizationEntryParserUtils.decodeFromTable(tableName, localeId, dataT
 	return results
 end
 
-function LocalizationEntryParserUtils._parseLocaleFromName(name)
+function LocalizationEntryParserUtils._parseLocaleFromName(name: string)
 	if string.sub(name, -5) == ".json" then
-		return string.sub(name, 1, #name-5)
+		return string.sub(name, 1, #name - 5)
 	else
 		return name
 	end
 end
 
-function LocalizationEntryParserUtils._parseTableToResultsList(lookupTable, sourceLocaleId, localeId, baseKey, dataTable, tableName)
+function LocalizationEntryParserUtils._parseTableToResultsList(
+	lookupTable,
+	sourceLocaleId: string,
+	localeId: string,
+	baseKey: string,
+	dataTable,
+	tableName: string
+)
 	assert(type(lookupTable) == "table", "Bad lookupTable")
 	assert(type(sourceLocaleId) == "string", "Bad sourceLocaleId")
 	assert(type(localeId) == "string", "Bad localeId")
@@ -85,20 +106,27 @@ function LocalizationEntryParserUtils._parseTableToResultsList(lookupTable, sour
 	for index, text in dataTable do
 		local key = baseKey .. index
 		if type(text) == "table" then
-			LocalizationEntryParserUtils._parseTableToResultsList(lookupTable, sourceLocaleId, localeId, key .. ".", text, tableName)
+			LocalizationEntryParserUtils._parseTableToResultsList(
+				lookupTable,
+				sourceLocaleId,
+				localeId,
+				key .. ".",
+				text,
+				tableName
+			)
 		elseif type(text) == "string" then
 			local found = lookupTable[key]
 			if found then
 				found.Values[localeId] = text
 			else
 				found = {
-					Example = text;
-					Key = key;
-					Context = string.format("[TEMP] - Generated from %s with key %s", tableName, key);
-					Source = text; -- Tempt!
+					Example = text,
+					Key = key,
+					Context = string.format("[TEMP] - Generated from %s with key %s", tableName, key),
+					Source = text, -- Tempt!
 					Values = {
-						[localeId] = text;
-					};
+						[localeId] = text,
+					},
 				}
 
 				lookupTable[key] = found
@@ -121,4 +149,4 @@ function LocalizationEntryParserUtils._parseTableToResultsList(lookupTable, sour
 	end
 end
 
-return LocalizationEntryParserUtils
+return LocalizationEntryParserUtils

package/src/Shared/JSONTranslator.lua

@@ -21,16 +21,16 @@ local RunService = game:GetService("RunService")
 local Blend = require("Blend")
 local LocalizationEntryParserUtils = require("LocalizationEntryParserUtils")
 local Maid = require("Maid")
+local NumberLocalizationUtils = require("NumberLocalizationUtils")
+local Observable = require("Observable")
+local Promise = require("Promise")
 local PseudoLocalize = require("PseudoLocalize")
 local Rx = require("Rx")
 local RxInstanceUtils = require("RxInstanceUtils")
+local ServiceBag = require("ServiceBag")
 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"
@@ -40,7 +40,7 @@ JSONTranslator.__index = JSONTranslator
 export type JSONTranslator = typeof(setmetatable(
 	{} :: {
 		_maid: Maid.Maid,
-		_serviceBag: _ServiceBag.ServiceBag,
+		_serviceBag: ServiceBag.ServiceBag,
 		_translatorService: TranslatorService.TranslatorService,
 		_translatorName: string,
 		_entries: { [string]: any },
@@ -102,7 +102,7 @@ function JSONTranslator.new(translatorName: string, localeId: string, dataTable)
 	return self :: any
 end
 
-function JSONTranslator.Init(self: JSONTranslator, serviceBag: _ServiceBag.ServiceBag)
+function JSONTranslator.Init(self: JSONTranslator, serviceBag: ServiceBag.ServiceBag)
 	self._serviceBag = assert(serviceBag, "No serviceBag")
 	self._translatorService = self._serviceBag:GetService(TranslatorService) :: any
 
@@ -130,7 +130,7 @@ function JSONTranslator.Init(self: JSONTranslator, serviceBag: _ServiceBag.Servi
 	)
 end
 
-function JSONTranslator.ObserveNumber(self: JSONTranslator, number: number): _Observable.Observable<string>
+function JSONTranslator.ObserveNumber(self: JSONTranslator, number: number): Observable.Observable<string>
 	return Rx.combineLatest({
 		localeId = self:ObserveLocaleId(),
 		number = number,
@@ -174,7 +174,7 @@ function JSONTranslator.ObserveFormatByKey(
 	self: JSONTranslator,
 	translationKey: string,
 	translationArgs
-): _Observable.Observable<string>
+): 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")
 
@@ -252,7 +252,7 @@ end
 	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>
+function JSONTranslator.PromiseTranslator(self: JSONTranslator): Promise.Promise<Translator>
 	return self._translatorService:PromiseTranslator()
 end
 
@@ -261,7 +261,7 @@ end
 
 	@return Observable<Translator>
 ]=]
-function JSONTranslator.ObserveTranslator(self: JSONTranslator): _Observable.Observable<Translator>
+function JSONTranslator.ObserveTranslator(self: JSONTranslator): Observable.Observable<Translator>
 	return self._translatorService:ObserveTranslator()
 end
 
@@ -270,7 +270,7 @@ end
 
 	@return Observable<string>
 ]=]
-function JSONTranslator.ObserveLocaleId(self: JSONTranslator): _Observable.Observable<string>
+function JSONTranslator.ObserveLocaleId(self: JSONTranslator): Observable.Observable<string>
 	return self._translatorService:ObserveLocaleId()
 end
 
@@ -325,7 +325,7 @@ function JSONTranslator.ObserveTranslation(
 	prefix: string,
 	text: string,
 	translationArgs
-): _Observable.Observable<string>
+): Observable.Observable<string>
 	assert(type(prefix) == "string", "Bad text")
 	assert(type(text) == "string", "Bad text")
 
@@ -374,7 +374,7 @@ end
 	Returns a promise that will resolve once the translator is loaded from the cloud.
 	@return Promise
 ]=]
-function JSONTranslator.PromiseLoaded(self: JSONTranslator): _Promise.Promise<()>
+function JSONTranslator.PromiseLoaded(self: JSONTranslator): Promise.Promise<()>
 	return self:PromiseTranslator()
 end
 
@@ -402,7 +402,7 @@ function JSONTranslator.FormatByKey(self: JSONTranslator, translationKey: string
 	return self:_doTranslation(translator, translationKey, args)
 end
 
-function JSONTranslator._observeArgs(_self: JSONTranslator, translationArgs): _Observable.Observable<any>
+function JSONTranslator._observeArgs(_self: JSONTranslator, translationArgs): Observable.Observable<any>
 	if translationArgs == nil then
 		return Rx.of(nil)
 	end
@@ -475,4 +475,4 @@ function JSONTranslator.Destroy(self: JSONTranslator)
 	setmetatable(self :: any, nil)
 end
 
-return JSONTranslator
+return JSONTranslator

package/src/Shared/Numbers/NumberLocalizationUtils.lua

@@ -227,7 +227,11 @@ local function addGroupDelimiters(numberStr, delimiter: string): string
 	return formatted
 end
 
-local function findDenominationEntry(localeInfo, number: number, roundingBehaviourType)
+local function findDenominationEntry(
+	localeInfo,
+	number: number,
+	roundingBehaviourType: RoundingBehaviourTypes.RoundingBehaviourType
+)
 	local denominationEntry = localeInfo[1] -- Default to base denominations
 	local absOfNumber = math.abs(number)
 	for i = #localeInfo, 2, -1 do
@@ -283,7 +287,12 @@ end
 	@param numSignificantDigits number?
 	@return string
 ]=]
-function NumberLocalizationUtils.abbreviate(number: number, locale: string, roundingBehaviourType: RoundingBehaviourTypes.RoundingBehaviourType?, numSignificantDigits: number?): string
+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

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

@@ -1,4 +1,5 @@
-local require = require(game:GetService("ServerScriptService"):FindFirstChild("LoaderUtils", true).Parent).bootstrapStory(script)
+local require =
+	require(game:GetService("ServerScriptService"):FindFirstChild("LoaderUtils", true).Parent).bootstrapStory(script)
 
 local Jest = require("Jest")
 local NumberLocalizationUtils = require("NumberLocalizationUtils")

package/src/Shared/TranslatorService.lua

@@ -7,18 +7,18 @@
 
 local require = require(script.Parent.loader).load(script)
 
+local LocalizationService = game:GetService("LocalizationService")
 local Players = game:GetService("Players")
 local RunService = game:GetService("RunService")
-local LocalizationService = game:GetService("LocalizationService")
 
 local LocalizationServiceUtils = require("LocalizationServiceUtils")
 local Maid = require("Maid")
+local Observable = require("Observable")
 local Promise = require("Promise")
 local Rx = require("Rx")
 local RxInstanceUtils = require("RxInstanceUtils")
+local ServiceBag = require("ServiceBag")
 local ValueObject = require("ValueObject")
-local _Observable = require("Observable")
-local _ServiceBag = require("ServiceBag")
 
 local TranslatorService = {}
 TranslatorService.ServiceName = "TranslatorService"
@@ -26,18 +26,18 @@ TranslatorService.ServiceName = "TranslatorService"
 export type TranslatorService = typeof(setmetatable(
 	{} :: {
 		_maid: Maid.Maid,
-		_serviceBag: _ServiceBag.ServiceBag,
+		_serviceBag: ServiceBag.ServiceBag,
 		_translator: ValueObject.ValueObject<Translator>,
 		_localizationTable: LocalizationTable?,
 		_pendingTranslatorPromise: Promise.Promise<Translator>?,
 		_localeIdValue: ValueObject.ValueObject<string>?,
-		_loadedPlayerObservable: _Observable.Observable<Player>?,
+		_loadedPlayerObservable: Observable.Observable<Player>?,
 		_loadedPlayer: Player?,
 	},
 	{} :: typeof({ __index = TranslatorService })
 ))
 
-function TranslatorService.Init(self: TranslatorService, serviceBag: _ServiceBag.ServiceBag)
+function TranslatorService.Init(self: TranslatorService, serviceBag: ServiceBag.ServiceBag)
 	assert(not self._serviceBag, "Already initialized")
 	self._serviceBag = assert(serviceBag, "No serviceBag")
 	self._maid = Maid.new()
@@ -77,7 +77,7 @@ end
 
 	@return Observable<Translator>
 ]=]
-function TranslatorService.ObserveTranslator(self: TranslatorService): _Observable.Observable<Translator>
+function TranslatorService.ObserveTranslator(self: TranslatorService): Observable.Observable<Translator>
 	return self._translator:Observe()
 end
 
@@ -135,7 +135,7 @@ end
 
 	@return Observable<string>
 ]=]
-function TranslatorService.ObserveLocaleId(self: TranslatorService): _Observable.Observable<string>
+function TranslatorService.ObserveLocaleId(self: TranslatorService): Observable.Observable<string>
 	if self._localeIdValue then
 		return self._localeIdValue:Observe()
 	end
@@ -185,7 +185,7 @@ function TranslatorService.GetLocaleId(self: TranslatorService): string
 	end
 end
 
-function TranslatorService._observeTranslatorImpl(self: TranslatorService): _Observable.Observable<Translator>
+function TranslatorService._observeTranslatorImpl(self: TranslatorService): Observable.Observable<Translator>
 	return self:_observeLoadedPlayer():Pipe({
 		Rx.switchMap(function(loadedPlayer: Player): any
 			if loadedPlayer then
@@ -202,7 +202,7 @@ function TranslatorService._observeTranslatorImpl(self: TranslatorService): _Obs
 	}) :: any
 end
 
-function TranslatorService._observeLoadedPlayer(self: TranslatorService): _Observable.Observable<Player>
+function TranslatorService._observeLoadedPlayer(self: TranslatorService): Observable.Observable<Player>
 	if self._loadedPlayerObservable then
 		return self._loadedPlayerObservable
 	end
@@ -235,4 +235,4 @@ function TranslatorService.Destroy(self: TranslatorService)
 	self._maid:DoCleaning()
 end
 
-return TranslatorService
+return TranslatorService

package/src/Shared/Utils/LocalizationServiceUtils.lua

@@ -74,4 +74,4 @@ function LocalizationServiceUtils.promisePlayerTranslator(player: Player)
 	end)
 end
 
-return LocalizationServiceUtils
+return LocalizationServiceUtils

package/src/Shared/Utils/TranslationKeyUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	@class TranslationKeyUtils
 ]=]
@@ -8,11 +9,18 @@ local String = require("String")
 
 local TranslationKeyUtils = {}
 
-function TranslationKeyUtils.getTranslationKey(prefix, text)
+--[=[
+	Converts a string to a translation key in a fixed format, with a maximum length
+
+	@param prefix string
+	@param text string
+	@return string
+]=]
+function TranslationKeyUtils.getTranslationKey(prefix: string, text: string): string
 	local firstWordsBeginning = string.sub(string.gsub(text, "%s", ""), 1, 20)
 	local firstWords = String.toLowerCamelCase(firstWordsBeginning)
 
 	return prefix .. "." .. firstWords
 end
 
-return TranslationKeyUtils
+return TranslationKeyUtils