@quenty/localizedtextutils 2.2.2-canary.4c04014.0 → 3.0.0

package/CHANGELOG.md

@@ -3,7 +3,18 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-## [2.2.2-canary.4c04014.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/localizedtextutils@2.2.1...@quenty/localizedtextutils@2.2.2-canary.4c04014.0) (2022-01-17)
+# [3.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/localizedtextutils@2.3.0...@quenty/localizedtextutils@3.0.0) (2022-03-06)
+
+
+### Features
+
+* Add LocalizedTextUtils.observeFormatByKeyRecursive and ensure that observation can occur of observable translatable objects ([feca173](https://github.com/Quenty/NevermoreEngine/commit/feca17331b27013552c095f830387c789a954f89))
+
+
+
+
+
+# [2.3.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/localizedtextutils@2.2.1...@quenty/localizedtextutils@2.3.0) (2022-01-17)
 
 **Note:** Version bump only for package @quenty/localizedtextutils
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/localizedtextutils",
-  "version": "2.2.2-canary.4c04014.0",
+  "version": "3.0.0",
   "description": "Localized text utils which changes translationKey structures to shared locations",
   "keywords": [
     "Roblox",
@@ -28,9 +28,9 @@
     "access": "public"
   },
   "dependencies": {
-    "@quenty/attributeutils": "4.2.2-canary.4c04014.0",
-    "@quenty/loader": "3.3.1-canary.4c04014.0",
-    "@quenty/rx": "3.7.2-canary.4c04014.0"
+    "@quenty/attributeutils": "^5.0.0",
+    "@quenty/loader": "^4.0.0",
+    "@quenty/rx": "^4.0.0"
   },
-  "gitHead": "4c040145693283525ba3f4c793cead7abee28fb2"
+  "gitHead": "dd428cab58282c975a4c082957dc8f58e3186905"
 }

package/src/Shared/LocalizedTextUtils.lua

@@ -58,28 +58,30 @@ end
 	Recursively formats the translated text.
 	@param translator Translator | JSONTranslator
 	@param translationKey string
-	@param translationArgs TranslationArgs
+	@param translationArgs TranslationArgs?
 	@param extraArgs table?
 	@return string
 ]=]
 function LocalizedTextUtils.formatByKeyRecursive(translator, translationKey, translationArgs, extraArgs)
 	assert(translator, "Bad translator")
 	assert(type(translationKey) == "string", "Bad translationKey")
-	assert(type(translationArgs) == "table", "Bad translationArgs")
+	assert(type(translationArgs) == "table" or translationArgs == nil, "Bad translationArgs")
 
 	local formattedArgs = {}
-	for name, value in pairs(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)
+	if translationArgs then
+		for name, value in pairs(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)
+				else
+					formattedArgs[name] = translator:FormatByKey(value.translationKey)
+				end
 			else
-				formattedArgs[name] = translator:FormatByKey(value.translationKey)
+				formattedArgs[name] = value
 			end
-		else
-			formattedArgs[name] = value
 		end
 	end
 
@@ -92,6 +94,47 @@ function LocalizedTextUtils.formatByKeyRecursive(translator, translationKey, tra
 	return translator:FormatByKey(translationKey, formattedArgs)
 end
 
+--[=[
+	Observes the recursively formatted translated text.
+
+	@param translator Translator | JSONTranslator
+	@param translationKey string
+	@param translationArgs TranslationArgs?
+	@param extraArgs table?
+	@return Observable<string>
+]=]
+function LocalizedTextUtils.observeFormatByKeyRecursive(translator, translationKey, 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
+			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)
+				else
+					observableFormattedArgs[name] = translator:ObserveFormatByKey(value.translationKey)
+				end
+			else
+				observableFormattedArgs[name] = value
+			end
+		end
+	end
+
+	if extraArgs then
+		for key, value in pairs(extraArgs) do
+			observableFormattedArgs[key] = value
+		end
+	end
+
+	return translator:ObserveFormatByKey(translationKey, observableFormattedArgs)
+end
+
 --[=[
 	Recursively formats the translated text
 	@param translator Translator | JSONTranslator
@@ -231,16 +274,20 @@ function LocalizedTextUtils.observeTranslation(translator, obj, attributeName, e
 
 	return RxAttributeUtils.observeAttribute(obj, attributeName, nil)
 		:Pipe({
-			Rx.map(function(encodedText)
+			Rx.switchMap(function(encodedText)
 				if type(encodedText) == "string" then
 					local localizedText = LocalizedTextUtils.fromJSON(encodedText)
 					if localizedText then
-						return LocalizedTextUtils.localizedTextToString(translator, localizedText, extraArgs)
+						return LocalizedTextUtils.observeFormatByKeyRecursive(
+							translator,
+							localizedText.translationKey,
+							localizedText.translationArgs,
+							extraArgs)
 					else
-						return nil
+						return Rx.of(nil)
 					end
 				else
-					return nil
+					return Rx.of(nil)
 				end
 			end);
 		})