@quenty/localizedtextutils 12.17.0 → 12.17.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.
 
+## [12.17.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/localizedtextutils@12.17.0...@quenty/localizedtextutils@12.17.1) (2025-04-05)
+
+
+### Bug Fixes
+
+* Add types to packages ([2374fb2](https://github.com/Quenty/NevermoreEngine/commit/2374fb2b043cfbe0e9b507b3316eec46a4e353a0))
+
+
+
+
+
 # [12.17.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/localizedtextutils@12.16.2...@quenty/localizedtextutils@12.17.0) (2025-04-02)
 
 **Note:** Version bump only for package @quenty/localizedtextutils

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/localizedtextutils",
-  "version": "12.17.0",
+  "version": "12.17.1",
   "description": "Localized text utils which changes translationKey structures to shared locations",
   "keywords": [
     "Roblox",
@@ -28,10 +28,10 @@
     "access": "public"
   },
   "dependencies": {
-    "@quenty/attributeutils": "^14.17.0",
-    "@quenty/loader": "^10.8.0",
-    "@quenty/promisemaid": "^5.10.1",
-    "@quenty/rx": "^13.17.0"
+    "@quenty/attributeutils": "^14.17.1",
+    "@quenty/loader": "^10.8.1",
+    "@quenty/promisemaid": "^5.10.2",
+    "@quenty/rx": "^13.17.1"
   },
-  "gitHead": "e8ea56930e65322fcffc05a1556d5df988068f0b"
+  "gitHead": "78c3ac0ab08dd18085b6e6e6e4f745e76ed99f68"
 }

package/src/Shared/LocalizedTextUtils.lua

@@ -17,6 +17,7 @@ local LocalizedTextUtils = {}
 	@type TranslationArgs { [string]: LocalizedTextData | number | string }
 	@within LocalizedTextUtils
 ]=]
+export type TranslationArgs = { [string]: LocalizedTextData | number | string }
 
 --[=[
 	Valid localized text data
@@ -25,6 +26,10 @@ local LocalizedTextUtils = {}
 	.translationArgs TranslationArgs
 	@within LocalizedTextUtils
 ]=]
+export type LocalizedTextData = {
+	translationKey: string,
+	translationArgs: TranslationArgs,
+}
 
 --[=[
 	Creates a new localizedtextdata
@@ -32,13 +37,13 @@ local LocalizedTextUtils = {}
 	@param translationArgs TranslationArgs
 	@return LocalizedTextData
 ]=]
-function LocalizedTextUtils.create(translationKey, translationArgs)
+function LocalizedTextUtils.create(translationKey: string, translationArgs: TranslationArgs): LocalizedTextData
 	assert(type(translationKey) == "string", "Bad translationKey")
 	assert(type(translationArgs) == "table" or translationArgs == nil, "Bad translationArgs")
 
 	return {
-		translationKey = translationKey;
-		translationArgs = translationArgs;
+		translationKey = translationKey,
+		translationArgs = translationArgs,
 	}
 end
 
@@ -47,11 +52,10 @@ end
 	@param data any
 	@return boolean
 ]=]
-function LocalizedTextUtils.isLocalizedText(data)
+function LocalizedTextUtils.isLocalizedText(data: any): boolean
 	return type(data) == "table"
 		and type(data.translationKey) == "string"
-		and (type(data.translationArgs) == "table"
-			or data.translationArgs == nil)
+		and (type(data.translationArgs) == "table" or data.translationArgs == nil)
 end
 
 --[=[
@@ -62,20 +66,29 @@ end
 	@param extraArgs table?
 	@return string
 ]=]
-function LocalizedTextUtils.formatByKeyRecursive(translator, translationKey, translationArgs, extraArgs)
+function LocalizedTextUtils.formatByKeyRecursive(
+	translator: Translator,
+	translationKey: string,
+	translationArgs: TranslationArgs,
+	extraArgs
+)
 	assert(translator, "Bad translator")
 	assert(type(translationKey) == "string", "Bad translationKey")
 	assert(type(translationArgs) == "table" or translationArgs == nil, "Bad translationArgs")
 
 	local formattedArgs = {}
 	if translationArgs then
-		for name, value in pairs(translationArgs) do
+		for name, value in translationArgs do
 			if type(value) == "table" then
 				assert(value.translationKey, "Table, but no translationKey")
 
 				if value.translationArgs then
-					formattedArgs[name] = LocalizedTextUtils
-						.formatByKeyRecursive(translator, value.translationKey, value.translationArgs, extraArgs)
+					formattedArgs[name] = LocalizedTextUtils.formatByKeyRecursive(
+						translator,
+						value.translationKey,
+						value.translationArgs,
+						extraArgs
+					)
 				else
 					formattedArgs[name] = translator:FormatByKey(value.translationKey)
 				end
@@ -86,7 +99,7 @@ function LocalizedTextUtils.formatByKeyRecursive(translator, translationKey, tra
 	end
 
 	if extraArgs then
-		for key, value in pairs(extraArgs) do
+		for key, value in extraArgs do
 			formattedArgs[key] = value
 		end
 	end
@@ -103,20 +116,29 @@ end
 	@param extraArgs table?
 	@return Observable<string>
 ]=]
-function LocalizedTextUtils.observeFormatByKeyRecursive(translator, translationKey, translationArgs, extraArgs)
+function LocalizedTextUtils.observeFormatByKeyRecursive(
+	translator,
+	translationKey: string,
+	translationArgs: TranslationArgs,
+	extraArgs
+)
 	assert(translator, "Bad translator")
 	assert(type(translationKey) == "string", "Bad translationKey")
 	assert(type(translationArgs) == "table" or translationArgs == nil, "Bad translationArgs")
 
 	local observableFormattedArgs = {}
 	if translationArgs then
-		for name, value in pairs(translationArgs) do
+		for name, value in translationArgs do
 			if type(value) == "table" then
 				assert(value.translationKey, "Table, but no translationKey")
 
 				if value.translationArgs then
-					observableFormattedArgs[name] = LocalizedTextUtils
-						.observeFormatByKeyRecursive(translator, value.translationKey, value.translationArgs, extraArgs)
+					observableFormattedArgs[name] = LocalizedTextUtils.observeFormatByKeyRecursive(
+						translator,
+						value.translationKey,
+						value.translationArgs,
+						extraArgs
+					)
 				else
 					observableFormattedArgs[name] = translator:ObserveFormatByKey(value.translationKey)
 				end
@@ -127,7 +149,7 @@ function LocalizedTextUtils.observeFormatByKeyRecursive(translator, translationK
 	end
 
 	if extraArgs then
-		for key, value in pairs(extraArgs) do
+		for key, value in extraArgs do
 			observableFormattedArgs[key] = value
 		end
 	end
@@ -143,7 +165,7 @@ end
 	@param extraArgs table?
 	@return Observable<string>
 ]=]
-function LocalizedTextUtils.observeLocalizedTextToString(translator, localizedText, extraArgs)
+function LocalizedTextUtils.observeLocalizedTextToString(translator, localizedText: LocalizedTextData, extraArgs)
 	assert(translator, "Bad translator")
 	assert(LocalizedTextUtils.isLocalizedText(localizedText), "No localizedText")
 
@@ -151,7 +173,8 @@ function LocalizedTextUtils.observeLocalizedTextToString(translator, localizedTe
 		translator,
 		localizedText.translationKey,
 		localizedText.translationArgs,
-		extraArgs)
+		extraArgs
+	)
 end
 
 --[=[
@@ -166,7 +189,7 @@ end
 	@param extraArgs table?
 	@return string
 ]=]
-function LocalizedTextUtils.localizedTextToString(translator, localizedText, extraArgs)
+function LocalizedTextUtils.localizedTextToString(translator, localizedText: LocalizedTextData, extraArgs)
 	assert(translator, "Bad translator")
 	assert(LocalizedTextUtils.isLocalizedText(localizedText), "No localizedText")
 
@@ -174,7 +197,8 @@ function LocalizedTextUtils.localizedTextToString(translator, localizedText, ext
 		translator,
 		localizedText.translationKey,
 		localizedText.translationArgs,
-		extraArgs)
+		extraArgs
+	)
 end
 
 --[=[
@@ -182,7 +206,7 @@ end
 	@param text string
 	@return LocalizedTextData?
 ]=]
-function LocalizedTextUtils.fromJSON(text)
+function LocalizedTextUtils.fromJSON(text: string): LocalizedTextData?
 	assert(type(text) == "string", "Bad text")
 
 	local decoded
@@ -201,7 +225,7 @@ end
 	@param localizedText LocalizedTextData
 	@return string?
 ]=]
-function LocalizedTextUtils.toJSON(localizedText)
+function LocalizedTextUtils.toJSON(localizedText: LocalizedTextData): string
 	assert(LocalizedTextUtils.isLocalizedText(localizedText), "Bad localizedText")
 
 	local localized = HttpService:JSONEncode(localizedText)
@@ -214,9 +238,13 @@ end
 	@param attributeName string
 	@param translationKey string
 	@param translationArgs TranslationArgs
-	@return LocalizedTextData
 ]=]
-function LocalizedTextUtils.setFromAttribute(obj, attributeName, translationKey, translationArgs)
+function LocalizedTextUtils.setFromAttribute(
+	obj: Instance,
+	attributeName: string,
+	translationKey: string,
+	translationArgs: TranslationArgs
+)
 	assert(typeof(obj) == "Instance", "Bad obj")
 	assert(type(attributeName) == "string", "Bad attributeName")
 
@@ -230,7 +258,7 @@ end
 	@param attributeName string
 	@return LocalizedTextData
 ]=]
-function LocalizedTextUtils.getFromAttribute(obj, attributeName)
+function LocalizedTextUtils.getFromAttribute(obj: Instance, attributeName: string): LocalizedTextData?
 	assert(typeof(obj) == "Instance", "Bad obj")
 	assert(type(attributeName) == "string", "Bad attributeName")
 
@@ -250,7 +278,12 @@ end
 	@param extraArgs table?
 	@return string?
 ]=]
-function LocalizedTextUtils.getTranslationFromAttribute(translator, obj, attributeName, extraArgs)
+function LocalizedTextUtils.getTranslationFromAttribute(
+	translator,
+	obj: Instance,
+	attributeName: string,
+	extraArgs
+): string?
 	assert(translator, "Bad translator")
 	assert(typeof(obj) == "Instance", "Bad obj")
 	assert(type(attributeName) == "string", "Bad attributeName")
@@ -270,7 +303,12 @@ end
 	@param defaultTranslationKey string
 	@param defaultTranslationArgs table?
 ]=]
-function LocalizedTextUtils.initializeAttribute(obj, attributeName, defaultTranslationKey, defaultTranslationArgs)
+function LocalizedTextUtils.initializeAttribute(
+	obj,
+	attributeName: string,
+	defaultTranslationKey,
+	defaultTranslationArgs
+)
 	assert(typeof(obj) == "Instance", "Bad obj")
 	assert(type(attributeName) == "string", "Bad attributeName")
 	assert(type(defaultTranslationKey) == "string", "Bad defaultTranslationKey")
@@ -291,30 +329,30 @@ end
 	@param extraArgs table?
 	@return Observable<string?>
 ]=]
-function LocalizedTextUtils.observeTranslation(translator, obj, attributeName, extraArgs)
+function LocalizedTextUtils.observeTranslation(translator, obj: Instance, attributeName: string, extraArgs)
 	assert(translator, "Bad translator")
 	assert(typeof(obj) == "Instance", "Bad obj")
 	assert(type(attributeName) == "string", "Bad attributeName")
 
-	return RxAttributeUtils.observeAttribute(obj, attributeName, nil)
-		:Pipe({
-			Rx.switchMap(function(encodedText)
-				if type(encodedText) == "string" then
-					local localizedText = LocalizedTextUtils.fromJSON(encodedText)
-					if localizedText then
-						return LocalizedTextUtils.observeFormatByKeyRecursive(
-							translator,
-							localizedText.translationKey,
-							localizedText.translationArgs,
-							extraArgs)
-					else
-						return Rx.of(nil)
-					end
+	return RxAttributeUtils.observeAttribute(obj, attributeName, nil):Pipe({
+		Rx.switchMap(function(encodedText): any
+			if type(encodedText) == "string" then
+				local localizedText = LocalizedTextUtils.fromJSON(encodedText)
+				if localizedText then
+					return LocalizedTextUtils.observeFormatByKeyRecursive(
+						translator,
+						localizedText.translationKey,
+						localizedText.translationArgs,
+						extraArgs
+					)
 				else
 					return Rx.of(nil)
 				end
-			end);
-		})
+			else
+				return Rx.of(nil)
+			end
+		end) :: any,
+	}) :: any
 end
 
 return LocalizedTextUtils