@quenty/clienttranslator 9.0.0-canary.331.7eefa75.0 → 9.0.0-canary.367.e9fdcbc.0

package/CHANGELOG.md

@@ -3,7 +3,131 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-# [9.0.0-canary.331.7eefa75.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/clienttranslator@8.10.0...@quenty/clienttranslator@9.0.0-canary.331.7eefa75.0) (2023-02-27)
+# [9.0.0-canary.367.e9fdcbc.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/clienttranslator@8.21.0...@quenty/clienttranslator@9.0.0-canary.367.e9fdcbc.0) (2023-06-05)
+
+**Note:** Version bump only for package @quenty/clienttranslator
+
+
+
+
+
+# [8.21.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/clienttranslator@8.20.0...@quenty/clienttranslator@8.21.0) (2023-05-26)
+
+
+### Bug Fixes
+
+* Fix localization warnings ([3e98cd7](https://github.com/Quenty/NevermoreEngine/commit/3e98cd7135a0d174b4a6f1059b6a2f9fc03b9d6f))
+
+
+
+
+
+# [8.20.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/clienttranslator@8.19.0...@quenty/clienttranslator@8.20.0) (2023-05-08)
+
+**Note:** Version bump only for package @quenty/clienttranslator
+
+
+
+
+
+# [8.19.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/clienttranslator@8.18.1...@quenty/clienttranslator@8.19.0) (2023-04-10)
+
+**Note:** Version bump only for package @quenty/clienttranslator
+
+
+
+
+
+## [8.18.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/clienttranslator@8.18.0...@quenty/clienttranslator@8.18.1) (2023-04-07)
+
+**Note:** Version bump only for package @quenty/clienttranslator
+
+
+
+
+
+# [8.18.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/clienttranslator@8.17.0...@quenty/clienttranslator@8.18.0) (2023-04-06)
+
+**Note:** Version bump only for package @quenty/clienttranslator
+
+
+
+
+
+# [8.17.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/clienttranslator@8.16.0...@quenty/clienttranslator@8.17.0) (2023-04-03)
+
+**Note:** Version bump only for package @quenty/clienttranslator
+
+
+
+
+
+# [8.16.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/clienttranslator@8.15.0...@quenty/clienttranslator@8.16.0) (2023-03-31)
+
+**Note:** Version bump only for package @quenty/clienttranslator
+
+
+
+
+
+# [8.15.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/clienttranslator@8.14.1...@quenty/clienttranslator@8.15.0) (2023-03-31)
+
+**Note:** Version bump only for package @quenty/clienttranslator
+
+
+
+
+
+## [8.14.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/clienttranslator@8.14.0...@quenty/clienttranslator@8.14.1) (2023-03-28)
+
+
+### Bug Fixes
+
+* Localization changes on localeId change ([551ce0b](https://github.com/Quenty/NevermoreEngine/commit/551ce0bb8a99f165529ec33d2130f4b65c01d8e8))
+
+
+
+
+
+# [8.14.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/clienttranslator@8.13.1...@quenty/clienttranslator@8.14.0) (2023-03-28)
+
+
+### Features
+
+* Add JSONTranslator:SetEntryValue(translationKey, source, context, localeId, text) ([3790994](https://github.com/Quenty/NevermoreEngine/commit/3790994ec62aceb475b7cddf7b2c30166dc27f96))
+
+
+
+
+
+## [8.13.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/clienttranslator@8.13.0...@quenty/clienttranslator@8.13.1) (2023-03-08)
+
+
+### Bug Fixes
+
+* Fix localization not swapping in soft shutdown if locale swaps ([ee93043](https://github.com/Quenty/NevermoreEngine/commit/ee93043b7da1511f6b86ce33040b422eb9cd6216))
+
+
+
+
+
+# [8.13.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/clienttranslator@8.12.0...@quenty/clienttranslator@8.13.0) (2023-03-06)
+
+**Note:** Version bump only for package @quenty/clienttranslator
+
+
+
+
+
+# [8.12.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/clienttranslator@8.11.0...@quenty/clienttranslator@8.12.0) (2023-03-05)
+
+**Note:** Version bump only for package @quenty/clienttranslator
+
+
+
+
+
+# [8.11.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/clienttranslator@8.10.0...@quenty/clienttranslator@8.11.0) (2023-02-27)
 
 **Note:** Version bump only for package @quenty/clienttranslator
 

package/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2014-2022 Quenty
+Copyright (c) 2014-2023 James Onnen (Quenty)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/clienttranslator",
-  "version": "9.0.0-canary.331.7eefa75.0",
+  "version": "9.0.0-canary.367.e9fdcbc.0",
   "description": "Gets local translator for player",
   "keywords": [
     "Roblox",
@@ -25,17 +25,17 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/blend": "7.0.0-canary.331.7eefa75.0",
-    "@quenty/instanceutils": "8.0.0-canary.331.7eefa75.0",
-    "@quenty/loader": "6.1.0",
-    "@quenty/maid": "2.4.0",
-    "@quenty/promise": "7.0.0-canary.331.7eefa75.0",
-    "@quenty/pseudolocalize": "4.0.0-canary.331.7eefa75.0",
-    "@quenty/rx": "8.0.0-canary.331.7eefa75.0",
+    "@quenty/blend": "7.0.0-canary.367.e9fdcbc.0",
+    "@quenty/instanceutils": "7.14.0",
+    "@quenty/loader": "6.2.1",
+    "@quenty/maid": "2.5.0",
+    "@quenty/promise": "6.5.0",
+    "@quenty/pseudolocalize": "3.2.0",
+    "@quenty/rx": "7.11.0",
     "@quenty/table": "3.2.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "7eefa756f8bd892b1210349a8133d6d56992dffb"
+  "gitHead": "e9fdcbc6ea1d46e068bf42a08b833099e9005259"
 }

package/src/Client/JSONTranslator.lua

@@ -44,6 +44,13 @@ JSONTranslator.__index = JSONTranslator
 	})
 
 	print(translator:FormatByKey("actions.respawn"), { playerName = "Quenty"}) --> Respawn Quenty
+
+	-- Observing is preferred
+	maid:GiveTask(translator:ObserveFormatByKey("actions.respawn", {
+		playerName = RxInstanceUtils.observeProperty(player, "DisplayName");
+	}):Subscribe(function(text)
+		print(text) --> "Respawn Quenty"
+	end)
 	```
 
 	```lua
@@ -92,6 +99,33 @@ function JSONTranslator:ObserveLocaleId()
 	})
 end
 
+--[=[
+	Adds an entry value to the localization table itself. This can be useful
+	for ensuring pseudo localization and/or generating localization values
+	from the game data itself.
+
+	@param translationKey string
+	@param source string
+	@param context string
+	@param localeId string
+	@param text string
+]=]
+function JSONTranslator:SetEntryValue(translationKey, source, context, localeId, text)
+	assert(type(translationKey) == "string", "Bad translationKey")
+	assert(type(source) == "string", "Bad source")
+	assert(type(context) == "string", "Bad context")
+	assert(type(localeId) == "string", "Bad localeId")
+	assert(type(text) == "string", "Bad text")
+
+	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))
+	end
+end
+
 --[=[
 	Gets the current localeId of the translator if it's initialized, or a default if it is not.
 
@@ -184,13 +218,18 @@ function JSONTranslator:ObserveFormatByKey(key, argData)
 	return Observable.new(function(sub)
 		local maid = Maid.new()
 
-		maid:GivePromise(self._promiseTranslator:Then(function()
+		maid:GivePromise(self._promiseTranslator:Then(function(translator)
 			if argObservable then
-				maid:GiveTask(argObservable:Subscribe(function(args)
-					sub:Fire(self:FormatByKey(key, args))
+				maid:GiveTask(Rx.combineLatest({
+					localeId = RxInstanceUtils.observeProperty(translator, "LocaleId");
+					args = argObservable;
+				}):Subscribe(function(state)
+					sub:Fire(self:FormatByKey(key, state.args))
 				end))
 			else
-				sub:Fire(self:FormatByKey(key, nil))
+				maid:GiveTask(RxInstanceUtils.observeProperty(translator, "LocaleId"):Subscribe(function()
+					sub:Fire(self:FormatByKey(key, nil))
+				end))
 			end
 		end))
 

package/src/Client/LocalizationServiceUtils.lua

@@ -40,17 +40,20 @@ function LocalizationServiceUtils.promiseTranslator(player)
 		timeout = 0.5
 	end
 
+	local rejectedCauseOfTimeout = false
 	task.delay(timeout, function()
 		if not asyncTranslatorPromise:IsPending() then
 			return
 		end
+
+		rejectedCauseOfTimeout = true
 		asyncTranslatorPromise:Reject(
 			("GetTranslatorForPlayerAsync is still pending after %f, using local table")
 			:format(timeout))
 	end)
 
 	return asyncTranslatorPromise:Catch(function(err)
-		if err ~= ERROR_PUBLISH_REQUIRED then
+		if err ~= ERROR_PUBLISH_REQUIRED and not rejectedCauseOfTimeout then
 			warn(("[LocalizationServiceUtils.promiseTranslator] - %s"):format(tostring(err)))
 		end