@quenty/settings 11.22.3 → 11.22.4

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [11.22.4](https://github.com/Quenty/NevermoreEngine/compare/@quenty/settings@11.22.3...@quenty/settings@11.22.4) (2025-03-21)
+
+**Note:** Version bump only for package @quenty/settings
+
+
+
+
+
 ## [11.22.3](https://github.com/Quenty/NevermoreEngine/compare/@quenty/settings@11.22.2...@quenty/settings@11.22.3) (2025-03-20)
 
 **Note:** Version bump only for package @quenty/settings

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/settings",
-  "version": "11.22.3",
+  "version": "11.22.4",
   "description": "Centralized player settings service",
   "keywords": [
     "Roblox",
@@ -25,38 +25,38 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/attributeutils": "^14.16.0",
+    "@quenty/attributeutils": "^14.16.1",
     "@quenty/baseobject": "^10.8.0",
-    "@quenty/binder": "^14.18.0",
-    "@quenty/brio": "^14.16.0",
-    "@quenty/cmdrservice": "^13.21.2",
-    "@quenty/datastore": "^13.19.1",
-    "@quenty/ducktype": "^5.8.0",
+    "@quenty/binder": "^14.18.1",
+    "@quenty/brio": "^14.16.1",
+    "@quenty/cmdrservice": "^13.21.3",
+    "@quenty/datastore": "^13.19.2",
+    "@quenty/ducktype": "^5.8.1",
     "@quenty/enumutils": "^3.4.0",
-    "@quenty/instanceutils": "^13.16.0",
-    "@quenty/jsonutils": "^10.10.0",
+    "@quenty/instanceutils": "^13.16.1",
+    "@quenty/jsonutils": "^10.10.1",
     "@quenty/loader": "^10.8.0",
     "@quenty/maid": "^3.4.0",
-    "@quenty/observablecollection": "^12.19.2",
-    "@quenty/playerbinder": "^14.18.0",
-    "@quenty/playerutils": "^8.16.0",
-    "@quenty/remotefunctionutils": "^10.10.0",
-    "@quenty/remoting": "^12.17.0",
-    "@quenty/rx": "^13.16.0",
-    "@quenty/rxbinderutils": "^14.18.0",
-    "@quenty/rxsignal": "^7.16.0",
-    "@quenty/servicebag": "^11.11.0",
+    "@quenty/observablecollection": "^12.19.3",
+    "@quenty/playerbinder": "^14.18.1",
+    "@quenty/playerutils": "^8.16.1",
+    "@quenty/remotefunctionutils": "^10.10.1",
+    "@quenty/remoting": "^12.17.1",
+    "@quenty/rx": "^13.16.1",
+    "@quenty/rxbinderutils": "^14.18.1",
+    "@quenty/rxsignal": "^7.16.1",
+    "@quenty/servicebag": "^11.11.1",
     "@quenty/signal": "^7.10.0",
-    "@quenty/statestack": "^14.17.0",
-    "@quenty/string": "^3.3.0",
+    "@quenty/statestack": "^14.17.1",
+    "@quenty/string": "^3.3.1",
     "@quenty/symbol": "^3.4.0",
-    "@quenty/table": "^3.7.0",
+    "@quenty/table": "^3.7.1",
     "@quenty/throttle": "^10.9.0",
-    "@quenty/tie": "^10.19.0",
-    "@quenty/valueobject": "^13.16.0"
+    "@quenty/tie": "^10.19.1",
+    "@quenty/valueobject": "^13.16.1"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "67863b6715e6da8dc1477d07f1ec048c76717bce"
+  "gitHead": "6b7c3e15e60cdb185986207b574e2b5591261e7a"
 }

package/src/Server/Cmdr/SettingsCmdrService.lua

@@ -1,4 +1,6 @@
 --[=[
+	Provides commands involving player settings
+
 	@class SettingsCmdrService
 ]=]
 
@@ -30,22 +32,22 @@ function SettingsCmdrService:_setupCommands()
 	end)
 
 	self._cmdrService:RegisterCommand({
-		Name = "restore-setting";
-		Aliases = { };
-		Description = "Restores the player setting to default.";
-		Group = "Settings";
+		Name = "restore-setting",
+		Aliases = {},
+		Description = "Restores the player setting to default.",
+		Group = "Settings",
 		Args = {
 			{
-				Name = "Players";
-				Type = "players";
-				Description = "Players to restore the default settings to.";
+				Name = "Players",
+				Type = "players",
+				Description = "Players to restore the default settings to.",
 			},
 			{
-				Name = "Settings";
-				Type = "settingDefinitions";
-				Description = "Settings to restore.";
-			}
-		};
+				Name = "Settings",
+				Type = "settingDefinitions",
+				Description = "Settings to restore.",
+			},
+		},
 	}, function(_context, players, settingsDefinitions)
 		local givenTo = {}
 
@@ -65,5 +67,4 @@ function SettingsCmdrService:Destroy()
 	self._maid:DoCleaning()
 end
 
-
-return SettingsCmdrService
+return SettingsCmdrService

package/src/Server/SettingsService.lua

@@ -1,4 +1,6 @@
 --[=[
+	Provides a service for managing centralized player settings. See [SettingsDataService] for the data service.
+
 	@class SettingsService
 ]=]
 
@@ -26,32 +28,60 @@ function SettingsService:Init(serviceBag)
 	self._serviceBag:GetService(require("PlayerSettings"))
 end
 
-function SettingsService:ObservePlayerSettingsBrio(player)
+--[=[
+	Observes the settings for a player using Brio.
+
+	@param player Player
+	@return Observable<Brio<PlayerSettings>>
+]=]
+function SettingsService:ObservePlayerSettingsBrio(player: Player)
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 
 	return self._settingsDataService:ObservePlayerSettingsBrio(player)
 end
 
-function SettingsService:ObservePlayerSettings(player)
+--[=[
+	Observes the settings for a player.
+
+	@param player Player
+	@return Observable<PlayerSettings>
+]=]
+function SettingsService:ObservePlayerSettings(player: Player)
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 
 	return self._settingsDataService:ObservePlayerSettings(player)
 end
 
-function SettingsService:GetPlayerSettings(player)
+--[=[
+	Obtains the settings for a player.
+
+	@param player Player
+	@return PlayerSettings
+]=]
+function SettingsService:GetPlayerSettings(player: Player)
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 
 	return self._settingsDataService:GetPlayerSettings(player)
 end
 
-function SettingsService:PromisePlayerSettings(player, cancelToken)
+--[=[
+	Promises the settings for a player.
+
+	@param player Player
+	@param cancelToken CancelToken?
+	@return Promise<PlayerSettings>
+]=]
+function SettingsService:PromisePlayerSettings(player: Player, cancelToken)
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 
 	return self._settingsDataService:PromisePlayerSettings(player, cancelToken)
 end
 
+--[=[
+	Cleans up the settings service
+]=]
 function SettingsService:Destroy()
 	self._maid:DoCleaning()
 end
 
-return SettingsService
+return SettingsService

package/src/Shared/SettingsDataService.lua

@@ -44,14 +44,14 @@ function SettingsDataService:_getPlayerSettingsCacheMap()
 	self._playerSettingsCacheMap = self._maid:Add(ObservableMap.new())
 	self._hydratedPlayersMaid = self._maid:Add(Maid.new())
 
-	self._maid:GiveTask(Players.PlayerRemoving:Connect(function(player)
+	self._maid:GiveTask(Players.PlayerRemoving:Connect(function(player: Player)
 		self._hydratedPlayersMaid[player] = nil
 	end))
 
 	return self._playerSettingsCacheMap
 end
 
-function SettingsDataService:_getPlayerSettingsMapForPlayer(player)
+function SettingsDataService:_getPlayerSettingsMapForPlayer(player: Player)
 	local playerSettingsCacheMap = self:_getPlayerSettingsCacheMap()
 
 	if self._hydratedPlayersMaid[player] then
@@ -65,28 +65,35 @@ function SettingsDataService:_getPlayerSettingsMapForPlayer(player)
 	return playerSettingsCacheMap
 end
 
-function SettingsDataService:_hydrateCacheForPlayer(player)
+function SettingsDataService:_hydrateCacheForPlayer(player: Player)
 	local playerMaid = Maid.new()
 
 	playerMaid:GiveTask(RxInstanceUtils.observeChildrenBrio(player, function(value)
 		-- We really only care about this, and we can assume we have the tag immediately
 		return value:HasTag("PlayerSettings")
-	end):Pipe({
-		RxBrioUtils.flatMapBrio(function(playerSettingsInstance)
-			return PlayerSettingsInterface:ObserveBrio(playerSettingsInstance, self._tieRealmService:GetTieRealm())
-		end)
-	}):Subscribe(function(brio)
-		if brio:IsDead() then
-			return
-		end
-
-		local maid, playerSettings = brio:ToMaidAndValue()
-		maid:GiveTask(self._playerSettingsCacheMap:Set(playerSettings:GetPlayer(), playerSettings))
-	end))
+	end)
+		:Pipe({
+			RxBrioUtils.flatMapBrio(function(playerSettingsInstance)
+				return PlayerSettingsInterface:ObserveBrio(playerSettingsInstance, self._tieRealmService:GetTieRealm())
+			end),
+		})
+		:Subscribe(function(brio)
+			if brio:IsDead() then
+				return
+			end
+
+			local maid, playerSettings = brio:ToMaidAndValue()
+			maid:GiveTask(self._playerSettingsCacheMap:Set(playerSettings:GetPlayer(), playerSettings))
+		end))
 
 	return playerMaid
 end
 
+--[=[
+	Gets the setting definitions
+
+	@return { SettingDefinition }
+]=]
 function SettingsDataService:GetSettingDefinitions()
 	return self._settingDefinitions:GetList()
 end
@@ -112,7 +119,6 @@ function SettingsDataService:ObserveRegisteredDefinitionsBrio()
 	return self._settingDefinitions:ObserveItemsBrio()
 end
 
-
 --[=[
 	Observes the player's settings
 
@@ -131,7 +137,7 @@ end
 	@param player Player
 	@return Observable<Brio<PlayerSettingsClient>>
 ]=]
-function SettingsDataService:ObservePlayerSettingsBrio(player)
+function SettingsDataService:ObservePlayerSettingsBrio(player: Player)
 	return self:_getPlayerSettingsMapForPlayer(player):ObserveAtKeyBrio(player, self._tieRealmService:GetTieRealm())
 end
 
@@ -142,14 +148,17 @@ end
 	@param cancelToken CancelToken
 	@return Promise<PlayerSettingsBase>
 ]=]
-function SettingsDataService:PromisePlayerSettings(player, cancelToken)
+function SettingsDataService:PromisePlayerSettings(player: Player, cancelToken)
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 
-	return  Rx.toPromise(self:ObservePlayerSettings(player):Pipe({
-		Rx.where(function(playerSettings)
-			return playerSettings ~= nil
-		end)
-	}), cancelToken)
+	return Rx.toPromise(
+		self:ObservePlayerSettings(player):Pipe({
+			Rx.where(function(playerSettings)
+				return playerSettings ~= nil
+			end),
+		}),
+		cancelToken
+	)
 end
 
 --[=[
@@ -158,7 +167,7 @@ end
 	@param player Player
 	@return Promise<PlayerSettingsBase>
 ]=]
-function SettingsDataService:GetPlayerSettings(player)
+function SettingsDataService:GetPlayerSettings(player: Player)
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 
 	return self:_getPlayerSettingsMapForPlayer(player):Get(player)
@@ -171,4 +180,4 @@ function SettingsDataService:Destroy()
 	self._maid:DoCleaning()
 end
 
-return SettingsDataService
+return SettingsDataService