@quenty/settings 11.23.0 → 11.23.2-canary.547.11ae689.0

package/CHANGELOG.md

@@ -3,6 +3,29 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [11.23.2-canary.547.11ae689.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/settings@11.23.0...@quenty/settings@11.23.2-canary.547.11ae689.0) (2025-04-07)
+
+
+### Bug Fixes
+
+* Add types to packages ([2374fb2](https://github.com/Quenty/NevermoreEngine/commit/2374fb2b043cfbe0e9b507b3316eec46a4e353a0))
+* Bump package versions for republishing ([ba47c62](https://github.com/Quenty/NevermoreEngine/commit/ba47c62e32170bf74377b0c658c60b84306dc294))
+
+
+
+
+
+## [11.23.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/settings@11.23.0...@quenty/settings@11.23.1) (2025-04-07)
+
+
+### Bug Fixes
+
+* Add types to packages ([2374fb2](https://github.com/Quenty/NevermoreEngine/commit/2374fb2b043cfbe0e9b507b3316eec46a4e353a0))
+
+
+
+
+
 # [11.23.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/settings@11.22.5...@quenty/settings@11.23.0) (2025-04-02)
 
 **Note:** Version bump only for package @quenty/settings

package/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2014-2024 James Onnen (Quenty)
+Copyright (c) 2014-2025 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/settings",
-  "version": "11.23.0",
+  "version": "11.23.2-canary.547.11ae689.0",
   "description": "Centralized player settings service",
   "keywords": [
     "Roblox",
@@ -25,38 +25,38 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/attributeutils": "^14.17.0",
-    "@quenty/baseobject": "^10.8.0",
-    "@quenty/binder": "^14.19.0",
-    "@quenty/brio": "^14.17.0",
-    "@quenty/cmdrservice": "^13.22.0",
-    "@quenty/datastore": "^13.20.0",
-    "@quenty/ducktype": "^5.8.1",
-    "@quenty/enumutils": "^3.4.0",
-    "@quenty/instanceutils": "^13.17.0",
-    "@quenty/jsonutils": "^10.10.1",
-    "@quenty/loader": "^10.8.0",
-    "@quenty/maid": "^3.4.0",
-    "@quenty/observablecollection": "^12.20.0",
-    "@quenty/playerbinder": "^14.19.0",
-    "@quenty/playerutils": "^8.17.0",
-    "@quenty/remotefunctionutils": "^10.10.1",
-    "@quenty/remoting": "^12.18.0",
-    "@quenty/rx": "^13.17.0",
-    "@quenty/rxbinderutils": "^14.19.0",
-    "@quenty/rxsignal": "^7.17.0",
-    "@quenty/servicebag": "^11.11.1",
-    "@quenty/signal": "^7.10.0",
-    "@quenty/statestack": "^14.18.0",
-    "@quenty/string": "^3.3.1",
-    "@quenty/symbol": "^3.4.0",
-    "@quenty/table": "^3.7.1",
-    "@quenty/throttle": "^10.9.0",
-    "@quenty/tie": "^10.20.0",
-    "@quenty/valueobject": "^13.17.0"
+    "@quenty/attributeutils": "14.17.2-canary.547.11ae689.0",
+    "@quenty/baseobject": "10.8.2-canary.547.11ae689.0",
+    "@quenty/binder": "14.19.2-canary.547.11ae689.0",
+    "@quenty/brio": "14.17.2-canary.547.11ae689.0",
+    "@quenty/cmdrservice": "13.22.2-canary.547.11ae689.0",
+    "@quenty/datastore": "13.20.2-canary.547.11ae689.0",
+    "@quenty/ducktype": "5.8.3-canary.547.11ae689.0",
+    "@quenty/enumutils": "3.4.2-canary.547.11ae689.0",
+    "@quenty/instanceutils": "13.17.2-canary.547.11ae689.0",
+    "@quenty/jsonutils": "10.10.3-canary.547.11ae689.0",
+    "@quenty/loader": "10.8.2-canary.547.11ae689.0",
+    "@quenty/maid": "3.4.2-canary.547.11ae689.0",
+    "@quenty/observablecollection": "12.20.2-canary.547.11ae689.0",
+    "@quenty/playerbinder": "14.19.2-canary.547.11ae689.0",
+    "@quenty/playerutils": "8.17.2-canary.547.11ae689.0",
+    "@quenty/remotefunctionutils": "10.10.3-canary.547.11ae689.0",
+    "@quenty/remoting": "12.18.2-canary.547.11ae689.0",
+    "@quenty/rx": "13.17.2-canary.547.11ae689.0",
+    "@quenty/rxbinderutils": "14.19.2-canary.547.11ae689.0",
+    "@quenty/rxsignal": "7.17.2-canary.547.11ae689.0",
+    "@quenty/servicebag": "11.11.3-canary.547.11ae689.0",
+    "@quenty/signal": "7.10.2-canary.547.11ae689.0",
+    "@quenty/statestack": "14.18.2-canary.547.11ae689.0",
+    "@quenty/string": "3.3.3-canary.547.11ae689.0",
+    "@quenty/symbol": "3.4.2-canary.547.11ae689.0",
+    "@quenty/table": "3.7.3-canary.547.11ae689.0",
+    "@quenty/throttle": "10.9.2-canary.547.11ae689.0",
+    "@quenty/tie": "10.20.2-canary.547.11ae689.0",
+    "@quenty/valueobject": "13.17.2-canary.547.11ae689.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e8ea56930e65322fcffc05a1556d5df988068f0b"
+  "gitHead": "11ae6894c9c40c596e521dc1d2a71977af63752f"
 }

package/src/Client/Player/PlayerSettingsClient.lua

@@ -184,7 +184,7 @@ function PlayerSettingsClient:SetValue(settingName, value)
 	self._toReplicate[settingName] = PlayerSettingsUtils.encodeForNetwork(value)
 
 	if self._toReplicateCallbacks[settingName] then
-		for callback, _ in pairs(self._toReplicateCallbacks[settingName]) do
+		for callback, _ in self._toReplicateCallbacks[settingName] do
 			task.spawn(callback)
 		end
 	end

package/src/Client/SettingsServiceClient.lua

@@ -12,6 +12,7 @@ local Players = game:GetService("Players")
 
 local Maid = require("Maid")
 local SettingsCmdrUtils = require("SettingsCmdrUtils")
+local _ServiceBag = require("ServiceBag")
 
 local SettingsServiceClient = {}
 
@@ -20,7 +21,7 @@ local SettingsServiceClient = {}
 
 	@param serviceBag ServiceBag
 ]=]
-function SettingsServiceClient:Init(serviceBag)
+function SettingsServiceClient:Init(serviceBag: _ServiceBag.ServiceBag)
 	assert(not self._serviceBag, "Already initialized")
 	self._serviceBag = assert(serviceBag, "No serviceBag")
 	self._maid = Maid.new()
@@ -81,7 +82,7 @@ end
 	@param player Player
 	@return Observable<PlayerSettingsClient | nil>
 ]=]
-function SettingsServiceClient:ObservePlayerSettings(player)
+function SettingsServiceClient:ObservePlayerSettings(player: Player)
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 
 	return self._settingsDataService:ObservePlayerSettings(player)
@@ -93,7 +94,7 @@ end
 	@param player Player
 	@return Observable<Brio<PlayerSettingsClient>>
 ]=]
-function SettingsServiceClient:ObservePlayerSettingsBrio(player)
+function SettingsServiceClient:ObservePlayerSettingsBrio(player: Player)
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 
 	return self._settingsDataService:ObservePlayerSettingsBrio(player)
@@ -105,7 +106,7 @@ end
 	@param player Player
 	@return PlayerSettingsClient | nil
 ]=]
-function SettingsServiceClient:GetPlayerSettings(player)
+function SettingsServiceClient:GetPlayerSettings(player: Player)
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 
 	return self._settingsDataService:GetPlayerSettings(player)
@@ -118,7 +119,7 @@ end
 	@param cancelToken CancellationToken
 	@return Promise<PlayerSettingsClient>
 ]=]
-function SettingsServiceClient:PromisePlayerSettings(player, cancelToken)
+function SettingsServiceClient:PromisePlayerSettings(player: Player, cancelToken)
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 
 	return self._settingsDataService:PromisePlayerSettings(player, cancelToken)

package/src/Server/Cmdr/SettingsCmdrService.lua

@@ -9,11 +9,12 @@ local require = require(script.Parent.loader).load(script)
 local PlayerUtils = require("PlayerUtils")
 local SettingsCmdrUtils = require("SettingsCmdrUtils")
 local Maid = require("Maid")
+local _ServiceBag = require("ServiceBag")
 
 local SettingsCmdrService = {}
 SettingsCmdrService.ServiceName = "SettingsCmdrService"
 
-function SettingsCmdrService:Init(serviceBag)
+function SettingsCmdrService:Init(serviceBag: _ServiceBag.ServiceBag)
 	assert(not self._serviceBag, "Already initialized")
 	self._serviceBag = assert(serviceBag, "No serviceBag")
 	self._maid = Maid.new()
@@ -51,9 +52,9 @@ function SettingsCmdrService:_setupCommands()
 	}, function(_context, players, settingsDefinitions)
 		local givenTo = {}
 
-		for _, player in pairs(players) do
+		for _, player in players do
 			local playerSettings = self._settingService:PromisePlayerSettings(player):Wait()
-			for _, settingDefinition in pairs(settingsDefinitions) do
+			for _, settingDefinition in settingsDefinitions do
 				playerSettings:RestoreDefault(settingDefinition:GetSettingName(), settingDefinition:GetDefaultValue())
 			end
 			table.insert(givenTo, PlayerUtils.formatName(player))

package/src/Server/Player/PlayerHasSettings.lua

@@ -16,7 +16,7 @@ local PlayerHasSettings = setmetatable({}, BaseObject)
 PlayerHasSettings.ClassName = "PlayerHasSettings"
 PlayerHasSettings.__index = PlayerHasSettings
 
-function PlayerHasSettings.new(player, serviceBag)
+function PlayerHasSettings.new(player: Player, serviceBag)
 	local self = setmetatable(BaseObject.new(player), PlayerHasSettings)
 
 	self._serviceBag = assert(serviceBag, "No serviceBag")
@@ -40,7 +40,7 @@ function PlayerHasSettings:_promiseLoadSettings()
 
 			return dataStore:Load("settings", {})
 				:Then(function(settings)
-					for settingName, value in pairs(settings) do
+					for settingName, value in settings do
 						local attributeName = PlayerSettingsUtils.getAttributeName(settingName)
 						self._settings:SetAttribute(attributeName, PlayerSettingsUtils.encodeForAttribute(value))
 					end

package/src/Server/Player/PlayerSettings.lua

@@ -75,7 +75,7 @@ end
 function PlayerSettings:_setSettingsMap(settingsMap)
 	assert(type(settingsMap) == "table", "Bad settingsMap")
 
-	for settingName, value in pairs(settingsMap) do
+	for settingName, value in settingsMap do
 		assert(type(settingName) == "string", "Bad key")
 
 		-- Avoid even letting these be set.

package/src/Server/SettingsService.lua

@@ -7,18 +7,19 @@
 local require = require(script.Parent.loader).load(script)
 
 local Maid = require("Maid")
+local _ServiceBag = require("ServiceBag")
 
 local SettingsService = {}
 SettingsService.ServiceName = "SettingsService"
 
-function SettingsService:Init(serviceBag)
+function SettingsService:Init(serviceBag: _ServiceBag.ServiceBag)
 	assert(not self._serviceBag, "Already initialized")
 	self._serviceBag = assert(serviceBag, "No serviceBag")
 	self._maid = Maid.new()
 
 	-- External
 	self._serviceBag:GetService(require("PlayerDataStoreService"))
-	self._serviceBag:GetService(require("SettingsCmdrService"))
+	self._serviceBag:GetService((require :: any)("SettingsCmdrService"))
 
 	-- Internal
 	self._settingsDataService = self._serviceBag:GetService(require("SettingsDataService"))

package/src/Shared/Cmdr/SettingsCmdrUtils.lua

@@ -18,24 +18,24 @@ function SettingsCmdrUtils.registerSettingDefinition(cmdr, serviceBag)
 		Transform = function(text)
 			local definitions = settingsDataService:GetSettingDefinitions()
 			local settingNames = {}
-			for _, settingDefinition in pairs(definitions) do
-				table.insert(settingNames, settingDefinition:GetSettingName())
-			end
+		for _, settingDefinition in definitions do
+			table.insert(settingNames, settingDefinition:GetSettingName())
+		end
 
-			local find = cmdr.Util.MakeFuzzyFinder(settingNames)
-			return find(text)
+		local find = cmdr.Util.MakeFuzzyFinder(settingNames)
+		return find(text)
 		end;
 		Validate = function(keys)
-			return #keys > 0, "No item model with that name could be found."
+		return #keys > 0, "No item model with that name could be found."
 		end,
 		Autocomplete = function(keys)
-			return keys
+		return keys
 		end,
 		Parse = function(keys)
-			local name = keys[1]
+		local name = keys[1]
 
-			local definitions = settingsDataService:GetSettingDefinitions()
-			for _, settingDefinition in pairs(definitions) do
+		local definitions = settingsDataService:GetSettingDefinitions()
+			for _, settingDefinition in definitions do
 				if settingDefinition:GetSettingName() == name then
 					return settingDefinition
 				end

package/src/Shared/Setting/SettingDefinition.lua

@@ -27,6 +27,7 @@ local SettingProperty = require("SettingProperty")
 local ServiceBag = require("ServiceBag")
 local DuckTypeUtils = require("DuckTypeUtils")
 local Maid = require("Maid")
+local _ServiceBag = require("ServiceBag")
 
 local SettingDefinition = {}
 SettingDefinition.ClassName = "SettingDefinition"
@@ -59,7 +60,7 @@ end
 
 	@param serviceBag ServiceBag
 ]=]
-function SettingDefinition:Init(serviceBag)
+function SettingDefinition:Init(serviceBag: _ServiceBag.ServiceBag)
 	assert(serviceBag, "No serviceBag")
 	assert(not self._maid, "Already initialized")
 
@@ -76,7 +77,7 @@ end
 	@param player Player
 	@return T
 ]=]
-function SettingDefinition:Get(player)
+function SettingDefinition:Get(player: Player)
 	assert(typeof(player) == "Instance" and player:IsA("Player") or player == nil, "Bad player")
 	assert(self._serviceBag, "Retrieve from serviceBag")
 
@@ -89,7 +90,7 @@ end
 	@param player Player
 	@param value T
 ]=]
-function SettingDefinition:Set(player, value)
+function SettingDefinition:Set(player: Player, value)
 	assert(typeof(player) == "Instance" and player:IsA("Player") or player == nil, "Bad player")
 	assert(self._serviceBag, "Retrieve from serviceBag")
 
@@ -102,7 +103,7 @@ end
 	@param player Player
 	@return Promise<T>
 ]=]
-function SettingDefinition:Promise(player)
+function SettingDefinition:Promise(player: Player)
 	assert(typeof(player) == "Instance" and player:IsA("Player") or player == nil, "Bad player")
 	assert(self._serviceBag, "Retrieve from serviceBag")
 
@@ -116,7 +117,7 @@ end
 	@param value T
 	@return Promise<T>
 ]=]
-function SettingDefinition:PromiseSet(player, value)
+function SettingDefinition:PromiseSet(player: Player, value)
 	assert(typeof(player) == "Instance" and player:IsA("Player") or player == nil, "Bad player")
 	assert(self._serviceBag, "Retrieve from serviceBag")
 
@@ -129,7 +130,7 @@ end
 	@param player Player
 	@return Promise<T>
 ]=]
-function SettingDefinition:Observe(player)
+function SettingDefinition:Observe(player: Player)
 	assert(typeof(player) == "Instance" and player:IsA("Player") or player == nil, "Bad player")
 	assert(self._serviceBag, "Retrieve from serviceBag")
 
@@ -142,7 +143,7 @@ end
 	@param value any
 	@return boolean
 ]=]
-function SettingDefinition.isSettingDefinition(value)
+function SettingDefinition.isSettingDefinition(value: any): boolean
 	return DuckTypeUtils.isImplementation(SettingDefinition, value)
 end
 
@@ -153,7 +154,7 @@ end
 	@param player Player
 	@return SettingProperty<T>
 ]=]
-function SettingDefinition:GetSettingProperty(serviceBag, player)
+function SettingDefinition:GetSettingProperty(serviceBag, player: Player)
 	assert(ServiceBag.isServiceBag(serviceBag), "Bad serviceBag")
 	assert(typeof(player) == "Instance" and player:IsA("Player") or player == nil, "Bad player")
 
@@ -178,7 +179,7 @@ end
 	Retrieves the default name of the setting
 	@return string
 ]=]
-function SettingDefinition:GetSettingName()
+function SettingDefinition:GetSettingName(): string
 	return self._settingName
 end
 

package/src/Shared/Setting/SettingDefinitionProvider.lua

@@ -28,6 +28,7 @@ local require = require(script.Parent.loader).load(script)
 
 local Maid = require("Maid")
 local SettingDefinition = require("SettingDefinition")
+local _ServiceBag = require("ServiceBag")
 
 local SettingDefinitionProvider = {}
 SettingDefinitionProvider.ClassName = "SettingDefinitionProvider"
@@ -72,7 +73,7 @@ function SettingDefinitionProvider.new(settingDefinitions)
 	self._settingDefinitionList = {}
 	self._lookup = {}
 
-	for key, value in pairs(settingDefinitions) do
+	for key, value in settingDefinitions do
 		if type(key) == "number" then
 			assert(SettingDefinition.isSettingDefinition(key), "Bad settingDefinition")
 
@@ -104,7 +105,7 @@ end
 
 	@param serviceBag ServiceBag
 ]=]
-function SettingDefinitionProvider:Init(serviceBag)
+function SettingDefinitionProvider:Init(serviceBag: _ServiceBag.ServiceBag)
 	assert(serviceBag, "No serviceBag")
 	assert(not self._maid, "Already initialized")
 
@@ -114,7 +115,7 @@ function SettingDefinitionProvider:Init(serviceBag)
 	self._initializedDefinitionLookup = {}
 
 	-- Register our setting definitions
-	for _, settingDefinition in pairs(self._settingDefinitionList) do
+	for _, settingDefinition in self._settingDefinitionList do
 		local initialized = self._serviceBag:GetService(settingDefinition)
 		self._initializedDefinitionLookup[settingDefinition] = initialized
 
@@ -139,7 +140,7 @@ function SettingDefinitionProvider:GetSettingDefinitions()
 	if self._serviceBag then
 		local copy = table.clone(self._settingDefinitionList)
 
-		for key, settingDefinition in pairs(copy) do
+		for key, settingDefinition in copy do
 			copy[key] = assert(self._initializedDefinitionLookup[settingDefinition], "Missing settingDefinition")
 		end
 
@@ -205,7 +206,7 @@ end
 	@param settingName string
 	@return SettingDefinition
 ]=]
-function SettingDefinitionProvider:Get(settingName)
+function SettingDefinitionProvider:Get(settingName: string)
 	assert(type(settingName) == "string", "Bad settingName")
 
 	local found = self._lookup[settingName]

package/src/Shared/SettingsDataService.lua

@@ -15,6 +15,7 @@ local PlayerSettingsInterface = require("PlayerSettingsInterface")
 local Rx = require("Rx")
 local RxBrioUtils = require("RxBrioUtils")
 local RxInstanceUtils = require("RxInstanceUtils")
+local _ServiceBag = require("ServiceBag")
 
 local SettingsDataService = {}
 
@@ -23,7 +24,7 @@ local SettingsDataService = {}
 
 	@param serviceBag ServiceBag
 ]=]
-function SettingsDataService:Init(serviceBag)
+function SettingsDataService:Init(serviceBag: _ServiceBag.ServiceBag)
 	assert(not self._serviceBag, "Already initialized")
 	self._serviceBag = assert(serviceBag, "No serviceBag")
 	self._maid = Maid.new()

package/test/scripts/Server/ServerMain.server.lua

@@ -24,14 +24,12 @@ bridge:RegisterSettingDefinition(volumeDefinition)
 local rumbleDefinition = SettingDefinition.new("Rumble", true)
 bridge:RegisterSettingDefinition(rumbleDefinition)
 
-
-local function handlePlayer(player)
+local function handlePlayer(player: Player)
 	local volume = volumeDefinition:GetSettingProperty(serviceBag, player)
 
-	volume:PromiseValue()
-		:Then(function(value)
-			print(value)
-		end)
+	volume:PromiseValue():Then(function(value)
+		print(value)
+	end)
 
 	-- volume:PromiseSetValue(0.5)
 	-- 	:Then(function()
@@ -40,7 +38,7 @@ local function handlePlayer(player)
 end
 
 game.Players.PlayerAdded:Connect(handlePlayer)
-for _, player in pairs(game.Players:GetPlayers()) do
+for _, player in game.Players:GetPlayers() do
 	handlePlayer(player)
 end