@quenty/clienttranslator 9.0.0-canary.367.903617a.0 → 9.0.0

package/CHANGELOG.md

@@ -3,7 +3,112 @@
 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.367.903617a.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/clienttranslator@8.21.0...@quenty/clienttranslator@9.0.0-canary.367.903617a.0) (2023-06-09)
+# [9.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/clienttranslator@8.32.0...@quenty/clienttranslator@9.0.0) (2023-10-11)
+
+
+### Bug Fixes
+
+* Fix localization firing after close ([aa1ab9b](https://github.com/Quenty/NevermoreEngine/commit/aa1ab9b0a21f9eab19e159012931b0114b24cad0))
+* Fix localization table replication ([c1a7b0a](https://github.com/Quenty/NevermoreEngine/commit/c1a7b0a4105af1a9e6959d0836447ffb8835c0f2))
+
+
+### Features
+
+* JSONTranslator can exist on server and generate translation keys (improved ergonomics) ([84b84b5](https://github.com/Quenty/NevermoreEngine/commit/84b84b5587b9cfebad9b9bbda7694ba714188d9c))
+
+
+
+
+
+# [8.32.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/clienttranslator@8.31.0...@quenty/clienttranslator@8.32.0) (2023-09-21)
+
+**Note:** Version bump only for package @quenty/clienttranslator
+
+
+
+
+
+# [8.31.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/clienttranslator@8.30.0...@quenty/clienttranslator@8.31.0) (2023-09-04)
+
+**Note:** Version bump only for package @quenty/clienttranslator
+
+
+
+
+
+# [8.30.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/clienttranslator@8.29.0...@quenty/clienttranslator@8.30.0) (2023-08-23)
+
+**Note:** Version bump only for package @quenty/clienttranslator
+
+
+
+
+
+# [8.29.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/clienttranslator@8.28.0...@quenty/clienttranslator@8.29.0) (2023-08-01)
+
+**Note:** Version bump only for package @quenty/clienttranslator
+
+
+
+
+
+# [8.28.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/clienttranslator@8.27.0...@quenty/clienttranslator@8.28.0) (2023-07-28)
+
+**Note:** Version bump only for package @quenty/clienttranslator
+
+
+
+
+
+# [8.27.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/clienttranslator@8.26.0...@quenty/clienttranslator@8.27.0) (2023-07-25)
+
+**Note:** Version bump only for package @quenty/clienttranslator
+
+
+
+
+
+# [8.26.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/clienttranslator@8.25.0...@quenty/clienttranslator@8.26.0) (2023-07-23)
+
+**Note:** Version bump only for package @quenty/clienttranslator
+
+
+
+
+
+# [8.25.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/clienttranslator@8.24.1...@quenty/clienttranslator@8.25.0) (2023-07-15)
+
+**Note:** Version bump only for package @quenty/clienttranslator
+
+
+
+
+
+## [8.24.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/clienttranslator@8.24.0...@quenty/clienttranslator@8.24.1) (2023-07-11)
+
+**Note:** Version bump only for package @quenty/clienttranslator
+
+
+
+
+
+# [8.24.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/clienttranslator@8.23.0...@quenty/clienttranslator@8.24.0) (2023-07-10)
+
+**Note:** Version bump only for package @quenty/clienttranslator
+
+
+
+
+
+# [8.23.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/clienttranslator@8.22.0...@quenty/clienttranslator@8.23.0) (2023-06-17)
+
+**Note:** Version bump only for package @quenty/clienttranslator
+
+
+
+
+
+# [8.22.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/clienttranslator@8.21.0...@quenty/clienttranslator@8.22.0) (2023-06-05)
 
 **Note:** Version bump only for package @quenty/clienttranslator
 

package/README.md

@@ -23,6 +23,12 @@ npm install @quenty/clienttranslator --save
 ## Usage
 Usage is designed to be simple.
 
+## Easy-use scenario
+
+1. Call Translate(data, "blah") on anything
+2. Translation is magically replicated to clients and can be saved
+3. Only one place needed to save the data
+
 ## Adding localization files
 
 Add files to ReplicatedStorage/i18n. Files will be in string values, and be valid JSON. This allows lookup like this:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/clienttranslator",
-  "version": "9.0.0-canary.367.903617a.0",
+  "version": "9.0.0",
   "description": "Gets local translator for player",
   "keywords": [
     "Roblox",
@@ -25,17 +25,18 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/blend": "7.0.0-canary.367.903617a.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"
+    "@quenty/blend": "^7.0.0",
+    "@quenty/instanceutils": "^8.0.0",
+    "@quenty/loader": "^7.0.0",
+    "@quenty/maid": "^2.6.0",
+    "@quenty/promise": "^7.0.0",
+    "@quenty/pseudolocalize": "^3.2.0",
+    "@quenty/rx": "^8.0.0",
+    "@quenty/string": "^3.1.0",
+    "@quenty/table": "^3.3.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "903617ace784bce6cc7e0a15093ee50566bd9b54"
+  "gitHead": "fdeae46099587019ec5fc15317dc673aed379400"
 }

package/src/Shared/{JsonToLocalizationTable.lua → Conversion/JsonToLocalizationTable.lua}

@@ -11,7 +11,8 @@ local RunService = game:GetService("RunService")
 
 local JsonToLocalizationTable = {}
 
-local LOCALIZATION_TABLE_NAME = "GeneratedJSONTable"
+local LOCALIZATION_TABLE_NAME_CLIENT = "GeneratedJSONTable_Client"
+local LOCALIZATION_TABLE_NAME_SERVER = "GeneratedJSONTable_Server"
 
 --[[
 	Recursively iterates through the object to construct strings and add it to the localization table
@@ -69,11 +70,18 @@ end
 	@return string -- The locale
 ]=]
 function JsonToLocalizationTable.getOrCreateLocalizationTable()
-	local localizationTable = LocalizationService:FindFirstChild(LOCALIZATION_TABLE_NAME)
+	local localizationTableName
+	if RunService:IsServer() then
+		localizationTableName = LOCALIZATION_TABLE_NAME_SERVER
+	else
+		localizationTableName = LOCALIZATION_TABLE_NAME_CLIENT
+	end
+
+	local localizationTable = LocalizationService:FindFirstChild(localizationTableName)
 
 	if not localizationTable then
 		localizationTable = Instance.new("LocalizationTable")
-		localizationTable.Name = LOCALIZATION_TABLE_NAME
+		localizationTable.Name = localizationTableName
 
 		if RunService:IsRunning() then
 			localizationTable.Parent = LocalizationService

package/src/{Client → Shared}/JSONTranslator.lua

@@ -18,15 +18,16 @@ local require = require(script.Parent.loader).load(script)
 local Players = game:GetService("Players")
 local RunService = game:GetService("RunService")
 
+local Blend = require("Blend")
 local JsonToLocalizationTable = require("JsonToLocalizationTable")
-local PseudoLocalize = require("PseudoLocalize")
 local LocalizationServiceUtils = require("LocalizationServiceUtils")
-local Promise = require("Promise")
-local Observable = require("Observable")
 local Maid = require("Maid")
-local Blend = require("Blend")
+local Observable = require("Observable")
+local Promise = require("Promise")
+local PseudoLocalize = require("PseudoLocalize")
 local Rx = require("Rx")
 local RxInstanceUtils = require("RxInstanceUtils")
+local TranslationKeyUtils = require("TranslationKeyUtils")
 
 local JSONTranslator = {}
 JSONTranslator.ClassName = "JSONTranslator"
@@ -73,7 +74,7 @@ function JSONTranslator.new(translatorName, ...)
 	self._englishTranslator = self._localizationTable:GetTranslator("en")
 	self._fallbacks = {}
 
-	if RunService:IsRunning() then
+	if RunService:IsRunning() and RunService:IsClient() then
 		self._promiseTranslator = LocalizationServiceUtils.promiseTranslator(Players.LocalPlayer)
 	else
 		self._promiseTranslator = Promise.resolved(self._englishTranslator)
@@ -86,6 +87,10 @@ function JSONTranslator.new(translatorName, ...)
 	return self
 end
 
+function JSONTranslator:Init(serviceBag)
+	self._serviceBag = assert(serviceBag, "No serviceBag")
+end
+
 --[=[
 	Observes the current locale id for this translator.
 
@@ -126,6 +131,25 @@ function JSONTranslator:SetEntryValue(translationKey, source, context, localeId,
 	end
 end
 
+function JSONTranslator:ObserveTranslation(prefix, text, argData)
+	assert(type(prefix) == "string", "Bad text")
+	assert(type(text) == "string", "Bad text")
+
+	return self:ObserveFormatByKey(self:ToTranslationKey(prefix, text), argData)
+end
+
+function JSONTranslator:ToTranslationKey(prefix, text)
+	assert(type(prefix) == "string", "Bad text")
+	assert(type(text) == "string", "Bad text")
+
+	local translationKey = TranslationKeyUtils.getTranslationKey(prefix, text)
+	local context = ("automatic.%s"):format(translationKey)
+
+	self:SetEntryValue(translationKey, text, context, "en", text)
+
+	return translationKey
+end
+
 --[=[
 	Gets the current localeId of the translator if it's initialized, or a default if it is not.
 
@@ -136,7 +160,7 @@ function JSONTranslator:GetLocaleId()
 		local translator = self._promiseTranslator:Wait()
 		return translator.LocaleId
 	else
-		warn("[JSONTranslator] - Translator is not loaded yet, returning english")
+		warn("[JSONTranslator.GetLocaleId] - Translator is not loaded yet, returning english")
 		return "en"
 	end
 end
@@ -218,7 +242,7 @@ function JSONTranslator:ObserveFormatByKey(key, argData)
 	return Observable.new(function(sub)
 		local maid = Maid.new()
 
-		maid:GivePromise(self._promiseTranslator:Then(function(translator)
+		maid:GivePromise(self._promiseTranslator):Then(function(translator)
 			if argObservable then
 				maid:GiveTask(Rx.combineLatest({
 					localeId = RxInstanceUtils.observeProperty(translator, "LocaleId");
@@ -231,7 +255,7 @@ function JSONTranslator:ObserveFormatByKey(key, argData)
 					sub:Fire(self:FormatByKey(key, nil))
 				end))
 			end
-		end))
+		end)
 
 		return maid
 	end)
@@ -322,7 +346,7 @@ function JSONTranslator:_formatByKeyTestMode(key, args)
 	if err then
 		warn(err)
 	else
-		warn("Failed to localize '" .. key .. "'")
+		warn("[JSONTranslator._formatByKeyTestMode] - Failed to localize '" .. key .. "'")
 	end
 
 	return key

package/src/Shared/Utils/TranslationKeyUtils.lua

@@ -0,0 +1,18 @@
+--[=[
+	@class TranslationKeyUtils
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local String = require("String")
+
+local TranslationKeyUtils = {}
+
+function TranslationKeyUtils.getTranslationKey(prefix, text)
+	local firstWordsBeginning = string.sub(string.gsub(text, "%s", ""), 1, 20)
+	local firstWords = String.toLowerCamelCase(firstWordsBeginning)
+
+	return prefix .. "." .. firstWords
+end
+
+return TranslationKeyUtils