@quenty/settings 11.35.0 → 11.35.1

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.
 
+## [11.35.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/settings@11.35.0...@quenty/settings@11.35.1) (2026-01-05)
+
+
+### Bug Fixes
+
+* Adjust typing accordingly for settings system ([4a5438c](https://github.com/Quenty/NevermoreEngine/commit/4a5438c073276c3f1e870fcafb6632ba2dd8a8d8))
+
+
+
+
+
 # [11.35.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/settings@11.34.4...@quenty/settings@11.35.0) (2026-01-04)
 
 **Note:** Version bump only for package @quenty/settings

package/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2014-2025 James Onnen (Quenty)
+Copyright (c) 2014-2026 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.35.0",
+  "version": "11.35.1",
   "description": "Centralized player settings service",
   "keywords": [
     "Roblox",
@@ -27,38 +27,38 @@
   "dependencies": {
     "@quenty/attributeutils": "^14.21.0",
     "@quenty/baseobject": "^10.9.1",
-    "@quenty/binder": "^14.26.0",
+    "@quenty/binder": "^14.26.1",
     "@quenty/brio": "^14.21.0",
     "@quenty/canceltoken": "^11.13.4",
-    "@quenty/cmdrservice": "^13.30.0",
-    "@quenty/datastore": "^13.26.0",
+    "@quenty/cmdrservice": "^13.30.1",
+    "@quenty/datastore": "^13.26.1",
     "@quenty/ducktype": "^5.9.1",
     "@quenty/enumutils": "^3.4.3",
     "@quenty/instanceutils": "^13.21.0",
     "@quenty/jsonutils": "^10.12.4",
     "@quenty/loader": "^10.9.1",
     "@quenty/maid": "^3.5.1",
-    "@quenty/observablecollection": "^12.25.0",
-    "@quenty/playerbinder": "^14.26.0",
+    "@quenty/observablecollection": "^12.25.1",
+    "@quenty/playerbinder": "^14.26.1",
     "@quenty/playerutils": "^8.22.0",
     "@quenty/promise": "^10.12.4",
     "@quenty/remotefunctionutils": "^10.12.4",
     "@quenty/remoting": "^12.22.0",
     "@quenty/rx": "^13.21.0",
-    "@quenty/rxbinderutils": "^14.26.0",
+    "@quenty/rxbinderutils": "^14.26.1",
     "@quenty/rxsignal": "^7.21.0",
     "@quenty/servicebag": "^11.13.4",
     "@quenty/signal": "^7.11.3",
-    "@quenty/statestack": "^14.23.0",
+    "@quenty/statestack": "^14.23.1",
     "@quenty/string": "^3.3.4",
     "@quenty/symbol": "^3.5.0",
     "@quenty/table": "^3.9.0",
     "@quenty/throttle": "^10.10.1",
-    "@quenty/tie": "^10.27.0",
-    "@quenty/valueobject": "^13.22.0"
+    "@quenty/tie": "^10.27.1",
+    "@quenty/valueobject": "^13.22.1"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "22144a14aa443a177ff307edd3813a838f8c1d5f"
+  "gitHead": "5232cd2c58ca0dcdf591dd8ae78995211da2f3e2"
 }

package/src/Server/Player/PlayerSettings.lua

@@ -52,7 +52,7 @@ function PlayerSettings.new(folder: Folder, serviceBag: ServiceBag.ServiceBag):
 	return self
 end
 
-function PlayerSettings.EnsureInitialized(self: PlayerSettings, settingName: string, defaultValue)
+function PlayerSettings.EnsureInitialized<T>(self: PlayerSettings, settingName: string, defaultValue: T): ()
 	assert(DataStoreStringUtils.isValidUTF8(settingName), "Bad settingName")
 	assert(defaultValue ~= nil, "defaultValue cannot be nil")
 
@@ -68,7 +68,7 @@ function PlayerSettings.EnsureInitialized(self: PlayerSettings, settingName: str
 
 		-- Paranoid UTF8 check
 		if type(encoded) == "string" then
-			assert(DataStoreStringUtils.isValidUTF8(defaultValue), "Bad UTF8 defaultValue")
+			assert(DataStoreStringUtils.isValidUTF8(encoded), "Bad UTF8 defaultValue")
 		end
 
 		self._obj:SetAttribute(attributeName, encoded)

package/src/Shared/Player/PlayerSettingsBase.lua

@@ -9,11 +9,13 @@ local require = require(script.Parent.loader).load(script)
 
 local BaseObject = require("BaseObject")
 local DataStoreStringUtils = require("DataStoreStringUtils")
+local Observable = require("Observable")
 local PlayerSettingsUtils = require("PlayerSettingsUtils")
 local Rx = require("Rx")
 local RxAttributeUtils = require("RxAttributeUtils")
 local ServiceBag = require("ServiceBag")
 local SettingDefinition = require("SettingDefinition")
+local SettingProperty = require("SettingProperty")
 
 local PlayerSettingsBase = setmetatable({}, BaseObject)
 PlayerSettingsBase.ClassName = "PlayerSettingsBase"
@@ -65,16 +67,23 @@ end
 	consider using the setting definitions in a centralized location.
 
 	@param settingName string
-	@param defaultValue any
-	@return SettingProperty
+	@param defaultValue T
+	@return SettingProperty.SettingProperty<T>
 ]=]
-function PlayerSettingsBase.GetSettingProperty(self: PlayerSettingsBase, settingName: string, defaultValue)
+function PlayerSettingsBase.GetSettingProperty<T>(
+	self: PlayerSettingsBase,
+	settingName: string,
+	defaultValue: T
+): SettingProperty.SettingProperty<T>
 	assert(type(settingName) == "string", "Bad settingName")
 	assert(defaultValue ~= nil, "defaultValue cannot be nil")
 
 	self:EnsureInitialized(settingName, defaultValue)
 
-	return SettingDefinition.new(settingName, defaultValue):GetSettingProperty(self._serviceBag, self:GetPlayer())
+	local player = self:GetPlayer()
+	assert(player ~= nil, "No player found for settings")
+
+	return SettingDefinition.new(settingName, defaultValue):GetSettingProperty(self._serviceBag, player)
 end
 
 --[=[
@@ -84,7 +93,7 @@ end
 	@param defaultValue any
 	@return any
 ]=]
-function PlayerSettingsBase.GetValue(self: PlayerSettingsBase, settingName: string, defaultValue)
+function PlayerSettingsBase.GetValue<T>(self: PlayerSettingsBase, settingName: string, defaultValue: T): T
 	assert(type(settingName) == "string", "Bad settingName")
 	assert(defaultValue ~= nil, "defaultValue cannot be nil")
 	assert(DataStoreStringUtils.isValidUTF8(settingName), "Bad settingName")
@@ -108,7 +117,7 @@ end
 	@param value any
 	@return any
 ]=]
-function PlayerSettingsBase.SetValue(self: PlayerSettingsBase, settingName: string, value)
+function PlayerSettingsBase.SetValue<T>(self: PlayerSettingsBase, settingName: string, value: T): ()
 	assert(type(settingName) == "string", "Bad settingName")
 	assert(DataStoreStringUtils.isValidUTF8(settingName), "Bad settingName")
 
@@ -124,7 +133,11 @@ end
 	@param defaultValue any
 	@return Observable<any>
 ]=]
-function PlayerSettingsBase.ObserveValue(self: PlayerSettingsBase, settingName: string, defaultValue)
+function PlayerSettingsBase.ObserveValue<T>(
+	self: PlayerSettingsBase,
+	settingName: string,
+	defaultValue: T
+): Observable.Observable<T>
 	assert(type(settingName) == "string", "Bad settingName")
 	assert(defaultValue ~= nil, "defaultValue cannot be nil")
 	assert(DataStoreStringUtils.isValidUTF8(settingName), "Bad settingName")
@@ -144,7 +157,7 @@ end
 	@param settingName string
 	@param defaultValue T
 ]=]
-function PlayerSettingsBase.RestoreDefault(self: PlayerSettingsBase, settingName: string, defaultValue)
+function PlayerSettingsBase.RestoreDefault<T>(self: PlayerSettingsBase, settingName: string, defaultValue: T): ()
 	assert(type(settingName) == "string", "Bad settingName")
 	assert(DataStoreStringUtils.isValidUTF8(settingName), "Bad settingName")
 
@@ -158,7 +171,7 @@ end
 	@param settingName string
 	@param defaultValue any
 ]=]
-function PlayerSettingsBase.EnsureInitialized(_self: PlayerSettingsBase, settingName: string, defaultValue)
+function PlayerSettingsBase.EnsureInitialized<T>(_self: PlayerSettingsBase, settingName: string, defaultValue: T): ()
 	assert(type(settingName) == "string", "Bad settingName")
 	assert(defaultValue ~= nil, "defaultValue cannot be nil")
 	assert(DataStoreStringUtils.isValidUTF8(settingName), "Bad settingName")

package/src/Shared/Setting/SettingDefinition.lua

@@ -1,4 +1,4 @@
---!nonstrict
+--!strict
 --[=[
 	These settings definitions are used to define a setting and register them on both the client and server. See
 	[SettingDefinitionProvider] for more details on grouping these.
@@ -25,6 +25,8 @@ local Players = game:GetService("Players")
 
 local DuckTypeUtils = require("DuckTypeUtils")
 local Maid = require("Maid")
+local Observable = require("Observable")
+local Promise = require("Promise")
 local ServiceBag = require("ServiceBag")
 local SettingProperty = require("SettingProperty")
 local SettingsDataService = require("SettingsDataService")
@@ -34,6 +36,17 @@ SettingDefinition.ClassName = "SettingDefinition"
 SettingDefinition.ServiceName = "SettingDefinition"
 SettingDefinition.__index = SettingDefinition
 
+export type SettingDefinition<T> = typeof(setmetatable(
+	{} :: {
+		_settingName: string,
+		_defaultValue: T,
+		_maid: Maid.Maid,
+		_serviceBag: ServiceBag.ServiceBag,
+		ServiceName: string,
+	},
+	{} :: typeof({ __index = SettingDefinition })
+))
+
 --[=[
 	Constructs a new setting definition which defines the name and the defaultValue
 
@@ -41,11 +54,11 @@ SettingDefinition.__index = SettingDefinition
 	@param defaultValue T
 	@return SettingDefinition<T>
 ]=]
-function SettingDefinition.new(settingName, defaultValue)
+function SettingDefinition.new<T>(settingName: string, defaultValue: T): SettingDefinition<T>
 	assert(type(settingName) == "string", "Bad settingName")
 	assert(defaultValue ~= nil, "DefaultValue cannot be nil")
 
-	local self = setmetatable({}, SettingDefinition)
+	local self: SettingDefinition<T> = setmetatable({} :: any, SettingDefinition)
 
 	self._settingName = settingName
 	self._defaultValue = defaultValue
@@ -60,9 +73,9 @@ end
 
 	@param serviceBag ServiceBag
 ]=]
-function SettingDefinition:Init(serviceBag: ServiceBag.ServiceBag)
+function SettingDefinition.Init<T>(self: SettingDefinition<T>, serviceBag: ServiceBag.ServiceBag)
 	assert(serviceBag, "No serviceBag")
-	assert(not self._maid, "Already initialized")
+	assert(not (self :: any)._maid, "Already initialized")
 
 	self._maid = Maid.new()
 	self._serviceBag = assert(serviceBag, "No serviceBag")
@@ -77,11 +90,11 @@ end
 	@param player Player
 	@return T
 ]=]
-function SettingDefinition:Get(player: Player)
+function SettingDefinition.Get<T>(self: SettingDefinition<T>, player: Player): T
 	assert(typeof(player) == "Instance" and player:IsA("Player") or player == nil, "Bad player")
 	assert(self._serviceBag, "Retrieve from serviceBag")
 
-	return self:GetSettingProperty(self._serviceBag, player):GetValue()
+	return self:GetSettingProperty(self._serviceBag, player).Value
 end
 
 --[=[
@@ -90,7 +103,7 @@ end
 	@param player Player
 	@param value T
 ]=]
-function SettingDefinition:Set(player: Player, value)
+function SettingDefinition.Set<T>(self: SettingDefinition<T>, player: Player, value: T): ()
 	assert(typeof(player) == "Instance" and player:IsA("Player") or player == nil, "Bad player")
 	assert(self._serviceBag, "Retrieve from serviceBag")
 
@@ -103,7 +116,7 @@ end
 	@param player Player
 	@return Promise<T>
 ]=]
-function SettingDefinition:Promise(player: Player)
+function SettingDefinition.Promise<T>(self: SettingDefinition<T>, player: Player): Promise.Promise<T>
 	assert(typeof(player) == "Instance" and player:IsA("Player") or player == nil, "Bad player")
 	assert(self._serviceBag, "Retrieve from serviceBag")
 
@@ -117,7 +130,7 @@ end
 	@param value T
 	@return Promise<T>
 ]=]
-function SettingDefinition:PromiseSet(player: Player, value)
+function SettingDefinition.PromiseSet<T>(self: SettingDefinition<T>, player: Player, value: T): Promise.Promise<()>
 	assert(typeof(player) == "Instance" and player:IsA("Player") or player == nil, "Bad player")
 	assert(self._serviceBag, "Retrieve from serviceBag")
 
@@ -130,7 +143,7 @@ end
 	@param player Player
 	@return Promise<T>
 ]=]
-function SettingDefinition:Observe(player: Player)
+function SettingDefinition.Observe<T>(self: SettingDefinition<T>, player: Player): Observable.Observable<T>
 	assert(typeof(player) == "Instance" and player:IsA("Player") or player == nil, "Bad player")
 	assert(self._serviceBag, "Retrieve from serviceBag")
 
@@ -154,7 +167,11 @@ end
 	@param player Player
 	@return SettingProperty<T>
 ]=]
-function SettingDefinition:GetSettingProperty(serviceBag, player: Player)
+function SettingDefinition.GetSettingProperty<T>(
+	self: SettingDefinition<T>,
+	serviceBag: ServiceBag.ServiceBag,
+	player: Player
+): SettingProperty.SettingProperty<T>
 	assert(ServiceBag.isServiceBag(serviceBag), "Bad serviceBag")
 	assert(typeof(player) == "Instance" and player:IsA("Player") or player == nil, "Bad player")
 
@@ -169,7 +186,10 @@ end
 	@param serviceBag ServiceBag
 	@return SettingProperty<T>
 ]=]
-function SettingDefinition:GetLocalPlayerSettingProperty(serviceBag)
+function SettingDefinition.GetLocalPlayerSettingProperty<T>(
+	self: SettingDefinition<T>,
+	serviceBag: ServiceBag.ServiceBag
+): SettingProperty.SettingProperty<T>
 	assert(ServiceBag.isServiceBag(serviceBag), "Bad serviceBag")
 
 	return self:GetSettingProperty(serviceBag, Players.LocalPlayer)
@@ -179,7 +199,7 @@ end
 	Retrieves the default name of the setting
 	@return string
 ]=]
-function SettingDefinition:GetSettingName(): string
+function SettingDefinition.GetSettingName<T>(self: SettingDefinition<T>): string
 	return self._settingName
 end
 
@@ -187,11 +207,11 @@ end
 	Retrieves the default value for the setting
 	@return T
 ]=]
-function SettingDefinition:GetDefaultValue()
+function SettingDefinition.GetDefaultValue<T>(self: SettingDefinition<T>): T
 	return self._defaultValue
 end
 
-function SettingDefinition:Destroy()
+function SettingDefinition.Destroy<T>(self: SettingDefinition<T>): ()
 	self._maid:DoCleaning()
 end
 

package/src/Shared/Setting/SettingProperty.lua

@@ -130,7 +130,7 @@ end
 
 	@param value T
 ]=]
-function SettingProperty.SetValue<T>(self: SettingProperty<T>, value: T)
+function SettingProperty.SetValue<T>(self: SettingProperty<T>, value: T): ()
 	local settings = self:_getPlayerSettings()
 	if settings then
 		settings:SetValue(self._definition:GetSettingName(), value)