@quenty/gameconfig 12.24.0 → 12.24.1-canary.545.2374fb2.0

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.24.1-canary.545.2374fb2.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/gameconfig@12.24.0...@quenty/gameconfig@12.24.1-canary.545.2374fb2.0) (2025-04-05)
+
+
+### Bug Fixes
+
+* Add types to packages ([2374fb2](https://github.com/Quenty/NevermoreEngine/commit/2374fb2b043cfbe0e9b507b3316eec46a4e353a0))
+
+
+
+
+
 # [12.24.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/gameconfig@12.23.4...@quenty/gameconfig@12.24.0) (2025-04-02)
 
 **Note:** Version bump only for package @quenty/gameconfig

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/gameconfig",
-  "version": "12.24.0",
+  "version": "12.24.1-canary.545.2374fb2.0",
   "description": "Configuration service to specify Roblox badges, products, and other specific assets.",
   "keywords": [
     "Roblox",
@@ -27,31 +27,31 @@
     "access": "public"
   },
   "dependencies": {
-    "@quenty/attributeutils": "^14.17.0",
-    "@quenty/badgeutils": "^10.10.1",
-    "@quenty/baseobject": "^10.8.0",
-    "@quenty/binder": "^14.19.0",
-    "@quenty/brio": "^14.17.0",
-    "@quenty/clienttranslator": "^14.19.0",
-    "@quenty/cmdrservice": "^13.22.0",
-    "@quenty/instanceutils": "^13.17.0",
-    "@quenty/loader": "^10.8.0",
-    "@quenty/maid": "^3.4.0",
-    "@quenty/marketplaceutils": "^11.11.1",
-    "@quenty/observablecollection": "^12.20.0",
-    "@quenty/playerutils": "^8.17.0",
-    "@quenty/preferredparentutils": "^4.3.0",
-    "@quenty/promise": "^10.10.1",
-    "@quenty/pseudolocalize": "^3.4.0",
-    "@quenty/remotefunctionutils": "^10.10.1",
-    "@quenty/remoting": "^12.18.0",
-    "@quenty/rx": "^13.17.0",
-    "@quenty/rxbinderutils": "^14.19.0",
-    "@quenty/servicebag": "^11.11.1",
-    "@quenty/statestack": "^14.18.0",
-    "@quenty/string": "^3.3.1",
-    "@quenty/table": "^3.7.1",
-    "@quenty/valueobject": "^13.17.0"
+    "@quenty/attributeutils": "14.17.1-canary.545.2374fb2.0",
+    "@quenty/badgeutils": "10.10.2-canary.545.2374fb2.0",
+    "@quenty/baseobject": "10.8.1-canary.545.2374fb2.0",
+    "@quenty/binder": "14.19.1-canary.545.2374fb2.0",
+    "@quenty/brio": "14.17.1-canary.545.2374fb2.0",
+    "@quenty/clienttranslator": "14.19.1-canary.545.2374fb2.0",
+    "@quenty/cmdrservice": "13.22.1-canary.545.2374fb2.0",
+    "@quenty/instanceutils": "13.17.1-canary.545.2374fb2.0",
+    "@quenty/loader": "10.8.1-canary.545.2374fb2.0",
+    "@quenty/maid": "3.4.1-canary.545.2374fb2.0",
+    "@quenty/marketplaceutils": "11.11.2-canary.545.2374fb2.0",
+    "@quenty/observablecollection": "12.20.1-canary.545.2374fb2.0",
+    "@quenty/playerutils": "8.17.1-canary.545.2374fb2.0",
+    "@quenty/preferredparentutils": "4.3.1-canary.545.2374fb2.0",
+    "@quenty/promise": "10.10.2-canary.545.2374fb2.0",
+    "@quenty/pseudolocalize": "3.4.1-canary.545.2374fb2.0",
+    "@quenty/remotefunctionutils": "10.10.2-canary.545.2374fb2.0",
+    "@quenty/remoting": "12.18.1-canary.545.2374fb2.0",
+    "@quenty/rx": "13.17.1-canary.545.2374fb2.0",
+    "@quenty/rxbinderutils": "14.19.1-canary.545.2374fb2.0",
+    "@quenty/servicebag": "11.11.2-canary.545.2374fb2.0",
+    "@quenty/statestack": "14.18.1-canary.545.2374fb2.0",
+    "@quenty/string": "3.3.2-canary.545.2374fb2.0",
+    "@quenty/table": "3.7.2-canary.545.2374fb2.0",
+    "@quenty/valueobject": "13.17.1-canary.545.2374fb2.0"
   },
-  "gitHead": "e8ea56930e65322fcffc05a1556d5df988068f0b"
+  "gitHead": "2374fb2b043cfbe0e9b507b3316eec46a4e353a0"
 }

package/src/Client/Cmdr/GameConfigCommandServiceClient.lua

@@ -8,11 +8,12 @@ local GameConfigCmdrUtils = require("GameConfigCmdrUtils")
 local Maid = require("Maid")
 local RxStateStackUtils = require("RxStateStackUtils")
 local Rx = require("Rx")
+local _ServiceBag = require("ServiceBag")
 
 local GameConfigCommandServiceClient = {}
 GameConfigCommandServiceClient.ServiceName = "GameConfigCommandServiceClient"
 
-function GameConfigCommandServiceClient:Init(serviceBag)
+function GameConfigCommandServiceClient:Init(serviceBag: _ServiceBag.ServiceBag)
 	assert(not self._serviceBag, "Already initialized")
 	self._serviceBag = assert(serviceBag, "No serviceBag")
 	self._maid = Maid.new()

package/src/Client/Config/Asset/GameConfigAssetClient.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	@class GameConfigAssetClient
 ]=]
@@ -7,19 +8,29 @@ local require = require(script.Parent.loader).load(script)
 local GameConfigAssetBase = require("GameConfigAssetBase")
 local GameConfigTranslator = require("GameConfigTranslator")
 local Rx = require("Rx")
+local _ServiceBag = require("ServiceBag")
+local _JSONTranslator = require("JSONTranslator")
 
 local GameConfigAssetClient = setmetatable({}, GameConfigAssetBase)
 GameConfigAssetClient.ClassName = "GameConfigAssetClient"
 GameConfigAssetClient.__index = GameConfigAssetClient
 
+export type GameConfigAssetClient = typeof(setmetatable(
+	{} :: {
+		_serviceBag: _ServiceBag.ServiceBag,
+		_configTranslator: _JSONTranslator.JSONTranslator,
+	},
+	GameConfigAssetClient
+)) & GameConfigAssetBase.GameConfigAssetBase
+
 --[=[
 	Constructs a new GameConfigAssetClient.
-	@param obj Instance
+	@param folder Folder
 	@param serviceBag ServiceBag
 	@return GameConfigAssetClient
 ]=]
-function GameConfigAssetClient.new(obj, serviceBag)
-	local self = setmetatable(GameConfigAssetBase.new(obj, serviceBag), GameConfigAssetClient)
+function GameConfigAssetClient.new(folder: Folder, serviceBag: _ServiceBag.ServiceBag): GameConfigAssetClient
+	local self = setmetatable(GameConfigAssetBase.new(folder, serviceBag) :: any, GameConfigAssetClient)
 
 	self._serviceBag = assert(serviceBag, "No serviceBag")
 	self._configTranslator = self._serviceBag:GetService(GameConfigTranslator)

package/src/Client/GameConfigBindersClient.lua

@@ -8,6 +8,6 @@ local BinderProvider = require("BinderProvider")
 local Binder = require("Binder")
 
 return BinderProvider.new(script.Name, function(self, serviceBag)
-	self:Add(Binder.new("GameConfig", require("GameConfigClient"), serviceBag))
-	self:Add(Binder.new("GameConfigAsset", require("GameConfigAssetClient"), serviceBag))
+	self:Add(Binder.new("GameConfig", (require :: any)("GameConfigClient"), serviceBag))
+	self:Add(Binder.new("GameConfigAsset", (require :: any)("GameConfigAssetClient"), serviceBag))
 end)

package/src/Client/GameConfigServiceClient.lua

@@ -6,11 +6,12 @@ local require = require(script.Parent.loader).load(script)
 
 local Maid = require("Maid")
 local GameConfigPicker = require("GameConfigPicker")
+local _ServiceBag = require("ServiceBag")
 
 local GameConfigServiceClient = {}
 GameConfigServiceClient.ServiceName = "GameConfigServiceClient"
 
-function GameConfigServiceClient:Init(serviceBag)
+function GameConfigServiceClient:Init(serviceBag: _ServiceBag.ServiceBag)
 	assert(not self._serviceBag, "Already initialized")
 	self._serviceBag = assert(serviceBag, "No serviceBag")
 	self._maid = Maid.new()
@@ -20,7 +21,7 @@ function GameConfigServiceClient:Init(serviceBag)
 	self._serviceBag:GetService(require("MarketplaceServiceCache"))
 
 	-- Internal
-	self._serviceBag:GetService(require("GameConfigCommandServiceClient"))
+	self._serviceBag:GetService((require :: any)("GameConfigCommandServiceClient"))
 	self._serviceBag:GetService(require("GameConfigTranslator"))
 	self._serviceBag:GetService(require("GameConfigDataService"))
 	self._binders = self._serviceBag:GetService(require("GameConfigBindersClient"))

package/src/Server/Cmdr/GameConfigCommandService.lua

@@ -10,11 +10,12 @@ local TeleportService = game:GetService("TeleportService")
 local GameConfigCmdrUtils = require("GameConfigCmdrUtils")
 local BadgeUtils = require("BadgeUtils")
 local PlayerUtils = require("PlayerUtils")
+local _ServiceBag = require("ServiceBag")
 
 local GameConfigCommandService = {}
 GameConfigCommandService.ServiceName = "GameConfigCommandService"
 
-function GameConfigCommandService:Init(serviceBag)
+function GameConfigCommandService:Init(serviceBag: _ServiceBag.ServiceBag)
 	assert(not self._serviceBag, "Already initialized")
 	self._serviceBag = assert(serviceBag, "No serviceBag")
 
@@ -54,8 +55,8 @@ function GameConfigCommandService:_registerCommands()
 	}, function(_context, players, badgeIds)
 		local givenTo = {}
 
-		for _, player in pairs(players) do
-			for _, badgeId in pairs(badgeIds) do
+		for _, player in players do
+			for _, badgeId in badgeIds do
 				BadgeUtils.promiseAwardBadge(player, badgeId)
 				table.insert(givenTo, string.format("%s badge %d", PlayerUtils.formatName(player), badgeId))
 			end
@@ -96,7 +97,7 @@ function GameConfigCommandService:_registerCommands()
 		context:Reply("Commencing teleport...")
 
 		if jobId then
-			for _, player in pairs(players) do
+			for _, player in players do
 				TeleportService:TeleportToPlaceInstance(placeId, jobId, player)
 			end
 		else

package/src/Server/Config/Config/GameConfig.lua

@@ -15,7 +15,7 @@ local GameConfig = setmetatable({}, GameConfigBase)
 GameConfig.ClassName = "GameConfig"
 GameConfig.__index = GameConfig
 
-function GameConfig.new(obj, serviceBag)
+function GameConfig.new(obj: Instance, serviceBag)
 	local self = setmetatable(GameConfigBase.new(obj), GameConfig)
 
 	self._serviceBag = assert(serviceBag, "No serviceBag")

package/src/Server/GameConfigBindersServer.lua

@@ -8,6 +8,6 @@ local BinderProvider = require("BinderProvider")
 local Binder = require("Binder")
 
 return BinderProvider.new(script.Name, function(self, serviceBag)
-	self:Add(Binder.new("GameConfig", require("GameConfig"), serviceBag))
-	self:Add(Binder.new("GameConfigAsset", require("GameConfigAsset"), serviceBag))
+	self:Add(Binder.new("GameConfig", (require :: any)("GameConfig"), serviceBag))
+	self:Add(Binder.new("GameConfigAsset", (require :: any)("GameConfigAsset"), serviceBag))
 end)

package/src/Server/GameConfigService.lua

@@ -14,15 +14,27 @@ local GameConfigAssetUtils = require("GameConfigAssetUtils")
 local GameConfigAssetTypeUtils = require("GameConfigAssetTypeUtils")
 local GameConfigAssetTypes = require("GameConfigAssetTypes")
 local GameConfigServiceConstants = require("GameConfigServiceConstants")
+local _ServiceBag = require("ServiceBag")
 
 local GameConfigService = {}
 GameConfigService.ServiceName = "GameConfigService"
 
+export type GameConfigService = typeof(setmetatable(
+	{} :: {
+		_serviceBag: _ServiceBag.ServiceBag,
+		_maid: Maid.Maid,
+		_binders: any, -- Binders
+		_configPicker: GameConfigPicker.GameConfigPicker,
+		_getPreferredParent: () -> Instance,
+	},
+	{ __index = GameConfigService }
+))
+
 --[=[
 	Initializes the configuration service. Should be done via [ServiceBag].
 	@param serviceBag ServiceBag
 ]=]
-function GameConfigService:Init(serviceBag)
+function GameConfigService:Init(serviceBag: _ServiceBag.ServiceBag)
 	assert(not self._serviceBag, "Already initialized")
 	self._serviceBag = assert(serviceBag, "No serviceBag")
 	self._maid = Maid.new()
@@ -32,13 +44,14 @@ function GameConfigService:Init(serviceBag)
 	self._serviceBag:GetService(require("MarketplaceServiceCache"))
 
 	-- Internal
-	self._serviceBag:GetService(require("GameConfigCommandService"))
+	self._serviceBag:GetService((require :: any)("GameConfigCommandService"))
 	self._serviceBag:GetService(require("GameConfigDataService"))
 	self._serviceBag:GetService(require("GameConfigTranslator"))
 	self._binders = self._serviceBag:GetService(require("GameConfigBindersServer"))
 
 	-- Setup picker
-	self._configPicker = self._maid:Add(GameConfigPicker.new(self._serviceBag, self._binders.GameConfig, self._binders.GameConfigAsset))
+	self._configPicker =
+		self._maid:Add(GameConfigPicker.new(self._serviceBag, self._binders.GameConfig, self._binders.GameConfigAsset))
 
 	self._getPreferredParent = PreferredParentUtils.createPreferredParentRetriever(ReplicatedStorage, "GameConfigs")
 
@@ -58,7 +71,7 @@ end
 	@param assetKey string -- Key name to use for the badge
 	@param badgeId number -- Cloud id
 ]=]
-function GameConfigService:AddBadge(assetKey, badgeId)
+function GameConfigService:AddBadge(assetKey: string, badgeId: number)
 	self:AddTypedAsset(GameConfigAssetTypes.BADGE, assetKey, badgeId)
 end
 
@@ -67,7 +80,7 @@ end
 	@param assetKey string -- Key name to use for the product
 	@param productId number -- Cloud id
 ]=]
-function GameConfigService:AddProduct(assetKey, productId)
+function GameConfigService:AddProduct(assetKey: string, productId: number)
 	self:AddTypedAsset(GameConfigAssetTypes.PRODUCT, assetKey, productId)
 end
 
@@ -76,7 +89,7 @@ end
 	@param assetKey string -- Key name to use for the pass
 	@param passId number -- Cloud id
 ]=]
-function GameConfigService:AddPass(assetKey, passId)
+function GameConfigService:AddPass(assetKey: string, passId: number)
 	self:AddTypedAsset(GameConfigAssetTypes.PASS, assetKey, passId)
 end
 
@@ -85,7 +98,7 @@ end
 	@param assetKey string -- Key name to use for the place
 	@param placeId number -- Cloud id
 ]=]
-function GameConfigService:AddPlace(assetKey, placeId)
+function GameConfigService:AddPlace(assetKey: string, placeId: number)
 	self:AddTypedAsset(GameConfigAssetTypes.PLACE, assetKey, placeId)
 end
 
@@ -94,7 +107,7 @@ end
 	@param assetKey string -- Key name to use for the asset
 	@param assetId number -- Cloud id
 ]=]
-function GameConfigService:AddAsset(assetKey, assetId)
+function GameConfigService:AddAsset(assetKey: string, assetId)
 	self:AddTypedAsset(GameConfigAssetTypes.ASSET, assetKey, assetId)
 end
 
@@ -103,7 +116,7 @@ end
 	@param assetKey string -- Key name to use for the asset
 	@param subscriptionId string -- Cloud id
 ]=]
-function GameConfigService:AddSubscription(assetKey, subscriptionId)
+function GameConfigService:AddSubscription(assetKey: string, subscriptionId)
 	self:AddTypedAsset(GameConfigAssetTypes.SUBSCRIPTION, assetKey, subscriptionId)
 end
 
@@ -112,7 +125,7 @@ end
 	@param assetKey string -- Key name to use for the bundle
 	@param bundleId number -- Cloud id
 ]=]
-function GameConfigService:AddBundle(assetKey, bundleId)
+function GameConfigService:AddBundle(assetKey: string, bundleId)
 	self:AddTypedAsset(GameConfigAssetTypes.BUNDLE, assetKey, bundleId)
 end
 
@@ -123,7 +136,7 @@ end
 	@param assetKey string -- Key name to use for the bundle
 	@param assetId number -- Cloud id
 ]=]
-function GameConfigService:AddTypedAsset(assetType, assetKey, assetId)
+function GameConfigService:AddTypedAsset(assetType: GameConfigAssetTypes.GameConfigAssetType, assetKey: string, assetId: number)
 	assert(GameConfigAssetTypeUtils.isAssetType(assetType), "Bad assetType")
 	assert(type(assetKey) == "string", "Bad assetKey")
 	assert(type(assetId) == "number", "Bad assetId")
@@ -155,7 +168,7 @@ function GameConfigService:GetPreferredParent()
 end
 
 function GameConfigService:_getOrCreateDefaultGameConfig()
-	for _, item in pairs(self._binders.GameConfig:GetAll()) do
+	for _, item in self._binders.GameConfig:GetAll() do
 		if item:GetGameId() == game.GameId then
 			return item:GetFolder()
 		end

package/src/Server/Mantle/MantleConfigProvider.lua

@@ -11,6 +11,7 @@ local GameConfigService = require("GameConfigService")
 local GameConfigUtils = require("GameConfigUtils")
 local String = require("String")
 local Maid = require("Maid")
+local _ServiceBag = require("ServiceBag")
 
 local MantleConfigProvider = {}
 MantleConfigProvider.ClassName = "MantleConfigProvider"
@@ -24,13 +25,13 @@ function MantleConfigProvider.new(container)
 	return self
 end
 
-function MantleConfigProvider:Init(serviceBag)
+function MantleConfigProvider:Init(serviceBag: _ServiceBag.ServiceBag)
 	self._serviceBag = assert(serviceBag, "No serviceBag")
 	self._gameConfigService = self._serviceBag:GetService(GameConfigService)
 	self._gameConfigBindersServer = self._serviceBag:GetService(GameConfigBindersServer)
 	self._maid = Maid.new()
 
-	for _, item in pairs(self._container:GetChildren()) do
+	for _, item in self._container:GetChildren() do
 		if item:IsA("ModuleScript") then
 			self:_loadConfig(item)
 		end
@@ -97,7 +98,7 @@ function MantleConfigProvider:_parseDataToConfig(mantleConfigData, name)
 		asset.Parent = GameConfigUtils.getOrCreateAssetFolder(gameConfig, assetType)
 	end
 
-	for key, value in pairs(mantleConfigData) do
+	for key, value in mantleConfigData do
 		if type(value) == "table" then
 			addAsset("badge", GameConfigAssetTypes.BADGE, key, value)
 			addAsset("pass", GameConfigAssetTypes.PASS, key, value)

package/src/Shared/Cmdr/GameConfigCmdrUtils.lua

@@ -12,23 +12,24 @@ function GameConfigCmdrUtils.registerAssetTypes(cmdr, configPicker)
 	assert(cmdr, "Bad cmdr")
 	assert(configPicker, "Bad configPicker")
 
-	for _, assetType in pairs(GameConfigAssetTypes) do
+	for _, assetType in GameConfigAssetTypes do
 		GameConfigCmdrUtils.registerAssetType(cmdr, configPicker, assetType)
 	end
 end
 
-function GameConfigCmdrUtils.registerAssetType(cmdr, configPicker, assetType)
+function GameConfigCmdrUtils.registerAssetType(cmdr, configPicker, assetType: GameConfigAssetTypes.GameConfigAssetType)
 	assert(cmdr, "Bad cmdr")
 	assert(type(assetType) == "string", "Bad assetType")
 	assert(configPicker, "Bad configPicker")
 
+	--stylua: ignore
 	local assetIdDefinition = {
 		Transform = function(text)
 			local allAssets = configPicker:GetAllActiveAssetsOfType(assetType)
 			local assetKeys = {}
 
 			-- TODO: Translate too?
-			for _, assetConfig in pairs(allAssets) do
+			for _, assetConfig in allAssets do
 				table.insert(assetKeys, assetConfig:GetAssetKey())
 			end
 
@@ -47,7 +48,7 @@ function GameConfigCmdrUtils.registerAssetType(cmdr, configPicker, assetType)
 		end,
 		Autocomplete = function(keys)
 			local stringified = {}
-			for _, item in pairs(keys) do
+			for _, item in keys do
 				table.insert(stringified, tostring(item))
 			end
 			return stringified
@@ -62,6 +63,8 @@ function GameConfigCmdrUtils.registerAssetType(cmdr, configPicker, assetType)
 			if asset then
 				return asset:GetAssetId()
 			end
+
+			return nil
 		end;
 	}