@quenty/settings 11.53.2 → 11.54.0

package/CHANGELOG.md

@@ -3,6 +3,26 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [11.54.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/settings@11.53.3...@quenty/settings@11.54.0) (2026-07-14)
+
+### Bug Fixes
+
+- add [@within](https://github.com/within) for moonwave on SettingDefinitionProvider \_\_index; cast Tie :Implement receiver ([388e3f8](https://github.com/Quenty/NevermoreEngine/commit/388e3f8c658b14d991b2328776d6cac5b11501c0))
+- cast Tie interface at :Implement sites to dodge flaky symlink-nominal analyze errors ([17f54f8](https://github.com/Quenty/NevermoreEngine/commit/17f54f87c6d449386570b8a409175dc2d6d02016))
+- **lint:** resolve selene unused-self and Rx shadowing from --!strict conversions ([3f4a085](https://github.com/Quenty/NevermoreEngine/commit/3f4a085911808146f10a2435efbe9e89dff8edff))
+- **settings:** cast cmdr handle to dodge flaky symlink-nominal analyze error ([bdaf1b4](https://github.com/Quenty/NevermoreEngine/commit/bdaf1b45f24882af05f40a941f48eb5b125eac84))
+- **settings:** cast cmdr service handle for strict CmdrServiceClient ([18b38b3](https://github.com/Quenty/NevermoreEngine/commit/18b38b3d4ceb3f1c9476015f545822a78f34747f))
+
+### Features
+
+- **settings:** convert package to --!strict ([5a93f97](https://github.com/Quenty/NevermoreEngine/commit/5a93f9791f9dcdc4843c3ada174ddc130e071104))
+
+## [11.53.3](https://github.com/Quenty/NevermoreEngine/compare/@quenty/settings@11.53.2...@quenty/settings@11.53.3) (2026-06-15)
+
+### Bug Fixes
+
+- Async guard ([7b793d9](https://github.com/Quenty/NevermoreEngine/commit/7b793d91973d137b18c0eac95b99ca27796b7a89))
+
 ## [11.53.2](https://github.com/Quenty/NevermoreEngine/compare/@quenty/settings@11.53.1...@quenty/settings@11.53.2) (2026-06-03)
 
 **Note:** Version bump only for package @quenty/settings

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/settings",
-  "version": "11.53.2",
+  "version": "11.54.0",
   "description": "Centralized player settings service",
   "keywords": [
     "Roblox",
@@ -30,11 +30,11 @@
   "dependencies": {
     "@quenty/attributeutils": "14.30.1",
     "@quenty/baseobject": "10.13.0",
-    "@quenty/binder": "14.36.1",
+    "@quenty/binder": "14.37.0",
     "@quenty/brio": "14.30.1",
     "@quenty/canceltoken": "11.19.1",
-    "@quenty/cmdrservice": "13.45.2",
-    "@quenty/datastore": "13.39.1",
+    "@quenty/cmdrservice": "13.46.0",
+    "@quenty/datastore": "13.40.0",
     "@quenty/ducktype": "5.11.0",
     "@quenty/enumutils": "3.4.6",
     "@quenty/instanceutils": "13.30.1",
@@ -42,14 +42,14 @@
     "@quenty/loader": "10.11.0",
     "@quenty/maid": "3.9.0",
     "@quenty/nevermore-test-runner": "1.4.0",
-    "@quenty/observablecollection": "12.38.1",
-    "@quenty/playerbinder": "14.36.1",
+    "@quenty/observablecollection": "12.39.0",
+    "@quenty/playerbinder": "14.37.0",
     "@quenty/playerutils": "8.32.1",
     "@quenty/promise": "10.18.1",
     "@quenty/remotefunctionutils": "10.18.1",
     "@quenty/remoting": "12.32.1",
     "@quenty/rx": "13.28.3",
-    "@quenty/rxbinderutils": "14.36.1",
+    "@quenty/rxbinderutils": "14.37.0",
     "@quenty/rxsignal": "7.28.3",
     "@quenty/servicebag": "11.18.1",
     "@quenty/signal": "7.13.1",
@@ -58,12 +58,12 @@
     "@quenty/symbol": "3.5.2",
     "@quenty/table": "3.9.2",
     "@quenty/throttle": "10.12.2",
-    "@quenty/tie": "10.40.1",
+    "@quenty/tie": "10.41.0",
     "@quenty/valueobject": "13.31.1",
     "@quentystudios/jest-lua": "3.10.0-quenty.2"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "1acafc712ce34f5dbaa70bb23b16da95e9cd3f82"
+  "gitHead": "13f0162f4971a77378e55e9b7236aea94f0dd3a8"
 }

package/src/Client/Player/PlayerSettingsClient.lua

@@ -28,14 +28,32 @@ local ValueObject = require("ValueObject")
 
 local UNSET_VALUE = Symbol.named("unsetValue")
 
-local PlayerSettingsClient = setmetatable({}, PlayerSettingsBase)
+local PlayerSettingsClient = {}
 PlayerSettingsClient.ClassName = "PlayerSettingsClient"
 PlayerSettingsClient.__index = PlayerSettingsClient
+-- Runtime inheritance only. Typing the metatable target as `any` keeps the old solver from
+-- chasing the full PlayerSettingsBase type here, which otherwise overflows its complexity
+-- budget ("Code is too complex"). The inherited surface is supplied structurally below.
+setmetatable(PlayerSettingsClient :: any, PlayerSettingsBase)
+
+-- Only the dynamic remoting member this class touches.
+type RemotingLike = {
+	RequestUpdateSettings: any,
+}
+
+-- Minimal structural surface inherited from PlayerSettingsBase that this class uses. See the
+-- setmetatable note above for why we don't intersect PlayerSettingsBase.PlayerSettingsBase.
+type PlayerSettingsBaseLike = {
+	_obj: Folder,
+	_maid: Maid.Maid,
+	GetPlayer: (self: any) -> Player?,
+	Destroy: (self: any) -> (),
+}
 
 export type PlayerSettingsClient =
 	typeof(setmetatable(
 		{} :: {
-			_remoting: Remoting.Remoting,
+			_remoting: RemotingLike,
 			_pendingReplicationDataInTransit: ValueObject.ValueObject<any>,
 			_toReplicate: { [any]: any? }?,
 			_toReplicateCallbacks: { [string]: { [any]: any } },
@@ -44,7 +62,7 @@ export type PlayerSettingsClient =
 		},
 		{} :: typeof({ __index = PlayerSettingsClient })
 	))
-	& PlayerSettingsBase.PlayerSettingsBase
+	& PlayerSettingsBaseLike
 
 --[=[
 	See [SettingsBindersClient] and [SettingsServiceClient] on how to properly use this class.
@@ -58,7 +76,7 @@ function PlayerSettingsClient.new(folder: Folder, serviceBag: ServiceBag.Service
 		setmetatable(PlayerSettingsBase.new(folder, serviceBag) :: any, PlayerSettingsClient)
 
 	if self:GetPlayer() == Players.LocalPlayer then
-		self._remoting = self._maid:Add(Remoting.new(self._obj, "PlayerSettings", Remoting.Realms.CLIENT))
+		self._remoting = self._maid:Add(Remoting.new(self._obj, "PlayerSettings", Remoting.Realms.CLIENT)) :: any
 
 		self._toReplicate = nil
 		self._toReplicateCallbacks = {}
@@ -74,7 +92,7 @@ function PlayerSettingsClient.new(folder: Folder, serviceBag: ServiceBag.Service
 			self:_sendSettings()
 		end, { leading = true, trailing = true }))
 
-		self._maid:GiveTask(PlayerSettingsInterface.Client:Implement(self._obj, self))
+		self._maid:GiveTask((PlayerSettingsInterface :: any).Client:Implement(self._obj, self))
 	end
 
 	return self
@@ -99,7 +117,7 @@ function PlayerSettingsClient.GetValue<T>(self: PlayerSettingsClient, settingNam
 		return PlayerSettingsUtils.decodeForNetwork(pending[settingName])
 	end
 
-	return getmetatable(PlayerSettingsClient).GetValue(self, settingName, defaultValue)
+	return (getmetatable(PlayerSettingsClient :: any) :: any).GetValue(self, settingName, defaultValue)
 end
 
 --[=[
@@ -116,7 +134,11 @@ function PlayerSettingsClient.ObserveValue<T>(
 ): Observable.Observable<T>
 	assert(type(settingName) == "string", "Bad settingName")
 
-	local baseObservable = getmetatable(PlayerSettingsClient).ObserveValue(self, settingName, defaultValue)
+	local baseObservable = (getmetatable(PlayerSettingsClient :: any) :: any).ObserveValue(
+		self,
+		settingName,
+		defaultValue
+	)
 
 	-- We need to register our own replication checkers...
 	return Observable.new(function(sub)

package/src/Client/SettingsServiceClient.lua

@@ -167,7 +167,7 @@ end
 function SettingsServiceClient._setupCmdr(self: SettingsServiceClient)
 	local cmdrServiceClient = self._serviceBag:GetService(require("CmdrServiceClient"))
 
-	self._maid:GivePromise(cmdrServiceClient:PromiseCmdr()):Then(function(cmdr)
+	self._maid:GivePromise((cmdrServiceClient :: any):PromiseCmdr()):Then(function(cmdr)
 		SettingsCmdrUtils.registerSettingDefinition(cmdr, self._serviceBag)
 	end)
 end

package/src/Server/Cmdr/SettingsCmdrService.lua

@@ -1,4 +1,4 @@
---!nonstrict
+--!strict
 --[=[
 	Provides commands involving player settings
 
@@ -15,8 +15,18 @@ local SettingsCmdrUtils = require("SettingsCmdrUtils")
 local SettingsCmdrService = {}
 SettingsCmdrService.ServiceName = "SettingsCmdrService"
 
-function SettingsCmdrService:Init(serviceBag: ServiceBag.ServiceBag)
-	assert(not self._serviceBag, "Already initialized")
+export type SettingsCmdrService = typeof(setmetatable(
+	{} :: {
+		_serviceBag: ServiceBag.ServiceBag,
+		_maid: Maid.Maid,
+		_cmdrService: any,
+		_settingService: any,
+	},
+	{} :: typeof({ __index = SettingsCmdrService })
+))
+
+function SettingsCmdrService.Init(self: SettingsCmdrService, serviceBag: ServiceBag.ServiceBag): ()
+	assert(not (self :: any)._serviceBag, "Already initialized")
 	self._serviceBag = assert(serviceBag, "No serviceBag")
 	self._maid = Maid.new()
 
@@ -24,11 +34,11 @@ function SettingsCmdrService:Init(serviceBag: ServiceBag.ServiceBag)
 	self._settingService = self._serviceBag:GetService(require("SettingsService"))
 end
 
-function SettingsCmdrService:Start()
+function SettingsCmdrService.Start(self: SettingsCmdrService): ()
 	self:_setupCommands()
 end
 
-function SettingsCmdrService:_setupCommands()
+function SettingsCmdrService._setupCommands(self: SettingsCmdrService): ()
 	self._maid:GivePromise(self._cmdrService:PromiseCmdr()):Then(function(cmdr)
 		SettingsCmdrUtils.registerSettingDefinition(cmdr, self._serviceBag)
 	end)
@@ -65,7 +75,7 @@ function SettingsCmdrService:_setupCommands()
 	end)
 end
 
-function SettingsCmdrService:Destroy()
+function SettingsCmdrService.Destroy(self: SettingsCmdrService): ()
 	self._maid:DoCleaning()
 end
 

package/src/Server/Player/PlayerHasSettings.lua

@@ -1,4 +1,4 @@
---!nonstrict
+--!strict
 --[=[
 	@class PlayerHasSettings
 ]=]
@@ -22,34 +22,37 @@ export type PlayerHasSettings =
 	typeof(setmetatable(
 		{} :: {
 			_serviceBag: ServiceBag.ServiceBag,
-			_playerSettingsBinder: PlayerSettings.PlayerSettings,
+			_playerSettingsBinder: any,
 			_playerDataStoreService: PlayerDataStoreService.PlayerDataStoreService,
+			_settings: Folder?,
 		},
 		{} :: typeof({ __index = PlayerHasSettings })
 	))
 	& BaseObject.BaseObject
 
-function PlayerHasSettings.new(player: Player, serviceBag)
-	local self = setmetatable(BaseObject.new(player), PlayerHasSettings)
+function PlayerHasSettings.new(player: Player, serviceBag: ServiceBag.ServiceBag): PlayerHasSettings
+	local self: PlayerHasSettings = setmetatable(BaseObject.new(player) :: any, PlayerHasSettings)
 
 	self._serviceBag = assert(serviceBag, "No serviceBag")
 	self._playerSettingsBinder = self._serviceBag:GetService(PlayerSettings)
-	self._playerDataStoreService = self._serviceBag:GetService(PlayerDataStoreService)
+	self._playerDataStoreService = self._serviceBag:GetService(PlayerDataStoreService) :: any
 
 	self:_promiseLoadSettings()
 
 	return self
 end
 
-function PlayerHasSettings:_promiseLoadSettings()
+function PlayerHasSettings._promiseLoadSettings(self: PlayerHasSettings): ()
 	self._settings = PlayerSettingsUtils.create()
 	self._maid:GiveTask(function()
-		self._settings:Destroy()
+		if self._settings then
+			self._settings:Destroy()
+		end
 		self._settings = nil
 	end)
 
-	self._maid
-		:GivePromise(self._playerDataStoreService:PromiseDataStore(self._obj))
+	local loadPromise = self._maid:GivePromise(self._playerDataStoreService:PromiseDataStore(self._obj :: Player));
+	(loadPromise :: any)
 		:Then(function(dataStore)
 			-- Ensure we've fully loaded before we parent.
 			-- This should ensure the cache is mostly instant.
@@ -57,6 +60,10 @@ function PlayerHasSettings:_promiseLoadSettings()
 			local subStore = dataStore:GetSubStore("settings")
 
 			return dataStore:Load("settings", {}):Then(function(settings)
+				if not self._settings then
+					return
+				end
+
 				for settingName, value in settings do
 					local attributeName = PlayerSettingsUtils.getAttributeName(settingName)
 					self._settings:SetAttribute(attributeName, PlayerSettingsUtils.encodeForAttribute(value))
@@ -78,11 +85,15 @@ function PlayerHasSettings:_promiseLoadSettings()
 		end)
 end
 
-function PlayerHasSettings:_handleAttributeChanged(subStore, attributeName)
+function PlayerHasSettings._handleAttributeChanged(self: PlayerHasSettings, subStore: any, attributeName: string): ()
 	if not PlayerSettingsUtils.isSettingAttribute(attributeName) then
 		return
 	end
 
+	if not self._settings then
+		return
+	end
+
 	-- Write the new value
 	local settingName = PlayerSettingsUtils.getSettingName(attributeName)
 	if not DataStoreStringUtils.isValidUTF8(settingName) then
@@ -105,4 +116,4 @@ function PlayerHasSettings:_handleAttributeChanged(subStore, attributeName)
 	subStore:Store(settingName, newValue)
 end
 
-return PlayerBinder.new("PlayerHasSettings", PlayerHasSettings)
+return PlayerBinder.new("PlayerHasSettings", PlayerHasSettings :: any) :: PlayerBinder.PlayerBinder<PlayerHasSettings>

package/src/Server/Player/PlayerSettings.lua

@@ -6,7 +6,10 @@
 local require = require(script.Parent.loader).load(script)
 
 local Binder = require("Binder")
+local Brio = require("Brio")
 local DataStoreStringUtils = require("DataStoreStringUtils")
+local Maid = require("Maid")
+local Observable = require("Observable")
 local PlayerSettingsBase = require("PlayerSettingsBase")
 local PlayerSettingsConstants = require("PlayerSettingsConstants")
 local PlayerSettingsInterface = require("PlayerSettingsInterface")
@@ -15,20 +18,44 @@ local Remoting = require("Remoting")
 local ServiceBag = require("ServiceBag")
 local SettingsDataService = require("SettingsDataService")
 
-local PlayerSettings = setmetatable({}, PlayerSettingsBase)
+local PlayerSettings = {}
 PlayerSettings.ClassName = "PlayerSettings"
 PlayerSettings.__index = PlayerSettings
+-- Runtime inheritance only. Typing the metatable target as `any` keeps the old solver from
+-- chasing the full PlayerSettingsBase type here, which otherwise overflows its complexity
+-- budget ("Code is too complex"). The inherited surface is supplied structurally below.
+setmetatable(PlayerSettings :: any, PlayerSettingsBase)
+
+-- Minimal structural surface of SettingsDataService that this class actually uses. Embedding
+-- the full SettingsDataService metatable type blows up the old solver, so we type only what
+-- we call here.
+type SettingsDataServiceLike = {
+	ObserveRegisteredDefinitionsBrio: (self: SettingsDataServiceLike) -> Observable.Observable<Brio.Brio<any>>,
+}
+
+-- Only the dynamic remoting member this class touches.
+type RemotingLike = {
+	RequestUpdateSettings: any,
+}
+
+-- Minimal structural surface inherited from PlayerSettingsBase that this class uses. See the
+-- setmetatable note above for why we don't intersect PlayerSettingsBase.PlayerSettingsBase.
+type PlayerSettingsBaseLike = {
+	_obj: Folder,
+	_maid: Maid.Maid,
+	GetPlayer: (self: any) -> Player?,
+}
 
 export type PlayerSettings =
 	typeof(setmetatable(
 		{} :: {
 			_serviceBag: ServiceBag.ServiceBag,
-			_remoting: Remoting.Remoting,
-			_settingsDataService: SettingsDataService.SettingsDataService,
+			_remoting: RemotingLike,
+			_settingsDataService: SettingsDataServiceLike,
 		},
 		{} :: typeof({ __index = PlayerSettings })
 	))
-	& PlayerSettingsBase.PlayerSettingsBase
+	& PlayerSettingsBaseLike
 
 export type SettingsMap = { [string]: any }
 
@@ -49,7 +76,7 @@ function PlayerSettings.new(folder: Folder, serviceBag: ServiceBag.ServiceBag):
 		self:EnsureInitialized(value:GetSettingName(), value:GetDefaultValue())
 	end))
 
-	self._maid:GiveTask(PlayerSettingsInterface.Server:Implement(self._obj, self))
+	self._maid:GiveTask((PlayerSettingsInterface :: any).Server:Implement(self._obj, self))
 
 	return self
 end
@@ -78,7 +105,7 @@ function PlayerSettings.EnsureInitialized<T>(self: PlayerSettings, settingName:
 end
 
 function PlayerSettings._setupRemoting(self: PlayerSettings): ()
-	self._remoting = self._maid:Add(Remoting.new(self._obj, "PlayerSettings", Remoting.Realms.SERVER))
+	self._remoting = self._maid:Add(Remoting.new(self._obj, "PlayerSettings", Remoting.Realms.SERVER)) :: any
 
 	self._maid:Add(self._remoting.RequestUpdateSettings:Bind(function(player: Player, settingsMap: SettingsMap)
 		assert(self:GetPlayer() == player, "Bad player")

package/src/Server/SettingsService.lua

@@ -1,4 +1,4 @@
---!nonstrict
+--!strict
 --[=[
 	Provides a service for managing centralized player settings. See [SettingsDataService] for the data service.
 
@@ -7,14 +7,27 @@
 
 local require = require(script.Parent.loader).load(script)
 
+local Brio = require("Brio")
 local Maid = require("Maid")
+local Observable = require("Observable")
+local Promise = require("Promise")
 local ServiceBag = require("ServiceBag")
+local SettingsDataService = require("SettingsDataService")
 
 local SettingsService = {}
 SettingsService.ServiceName = "SettingsService"
 
-function SettingsService:Init(serviceBag: ServiceBag.ServiceBag)
-	assert(not self._serviceBag, "Already initialized")
+export type SettingsService = typeof(setmetatable(
+	{} :: {
+		_serviceBag: ServiceBag.ServiceBag,
+		_maid: Maid.Maid,
+		_settingsDataService: SettingsDataService.SettingsDataService,
+	},
+	{} :: typeof({ __index = SettingsService })
+))
+
+function SettingsService.Init(self: SettingsService, serviceBag: ServiceBag.ServiceBag): ()
+	assert(not (self :: any)._serviceBag, "Already initialized")
 	self._serviceBag = assert(serviceBag, "No serviceBag")
 	self._maid = Maid.new()
 
@@ -23,7 +36,7 @@ function SettingsService:Init(serviceBag: ServiceBag.ServiceBag)
 	self._serviceBag:GetService((require :: any)("SettingsCmdrService"))
 
 	-- Internal
-	self._settingsDataService = self._serviceBag:GetService(require("SettingsDataService"))
+	self._settingsDataService = self._serviceBag:GetService(require("SettingsDataService")) :: any
 
 	-- Binders
 	self._serviceBag:GetService(require("PlayerHasSettings"))
@@ -36,7 +49,10 @@ end
 	@param player Player
 	@return Observable<Brio<PlayerSettings>>
 ]=]
-function SettingsService:ObservePlayerSettingsBrio(player: Player)
+function SettingsService.ObservePlayerSettingsBrio(
+	self: SettingsService,
+	player: Player
+): Observable.Observable<Brio.Brio<any>>
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 
 	return self._settingsDataService:ObservePlayerSettingsBrio(player)
@@ -48,7 +64,7 @@ end
 	@param player Player
 	@return Observable<PlayerSettings>
 ]=]
-function SettingsService:ObservePlayerSettings(player: Player)
+function SettingsService.ObservePlayerSettings(self: SettingsService, player: Player): Observable.Observable<any>
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 
 	return self._settingsDataService:ObservePlayerSettings(player)
@@ -60,7 +76,7 @@ end
 	@param player Player
 	@return PlayerSettings
 ]=]
-function SettingsService:GetPlayerSettings(player: Player)
+function SettingsService.GetPlayerSettings(self: SettingsService, player: Player): any
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 
 	return self._settingsDataService:GetPlayerSettings(player)
@@ -73,7 +89,11 @@ end
 	@param cancelToken CancelToken?
 	@return Promise<PlayerSettings>
 ]=]
-function SettingsService:PromisePlayerSettings(player: Player, cancelToken)
+function SettingsService.PromisePlayerSettings(
+	self: SettingsService,
+	player: Player,
+	cancelToken: any?
+): Promise.Promise<any>
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 
 	return self._settingsDataService:PromisePlayerSettings(player, cancelToken)
@@ -82,7 +102,7 @@ end
 --[=[
 	Cleans up the settings service
 ]=]
-function SettingsService:Destroy()
+function SettingsService.Destroy(self: SettingsService): ()
 	self._maid:DoCleaning()
 end
 

package/src/Shared/Cmdr/SettingsCmdrUtils.lua

@@ -1,4 +1,4 @@
---!nonstrict
+--!strict
 --[=[
 	@class SettingsCmdrUtils
 ]=]
@@ -10,10 +10,10 @@ local SettingsDataService = require("SettingsDataService")
 
 local SettingsCmdrUtils = {}
 
-function SettingsCmdrUtils.registerSettingDefinition(cmdr, serviceBag: ServiceBag.ServiceBag)
+function SettingsCmdrUtils.registerSettingDefinition(cmdr: any, serviceBag: ServiceBag.ServiceBag): ()
 	assert(ServiceBag.isServiceBag(serviceBag), "Bad serviceBag")
 
-	local settingsDataService = serviceBag:GetService(SettingsDataService)
+	local settingsDataService: any = serviceBag:GetService(SettingsDataService)
 
 	local settingDefinitionType = {
 		Transform = function(text)

package/src/Shared/Setting/SettingDefinition.lua

@@ -81,7 +81,9 @@ function SettingDefinition.Init<T>(self: SettingDefinition<T>, serviceBag: Servi
 	self._serviceBag = assert(serviceBag, "No serviceBag")
 
 	local settingsDataService = self._serviceBag:GetService(SettingsDataService)
-	self._maid:GiveTask(settingsDataService:RegisterSettingDefinition(self))
+	-- Same SettingsDataService type resolved via two symlink require paths reads as
+	-- nominally distinct to the old solver; cast the receiver to dodge the false mismatch.
+	self._maid:GiveTask((settingsDataService :: any):RegisterSettingDefinition(self))
 end
 
 --[=[

package/src/Shared/Setting/SettingDefinitionProvider.lua

@@ -1,4 +1,4 @@
---!nonstrict
+--!strict
 --[=[
 	Provides settings in bulk, and can be initialized by a [ServiceBag]. See [SettingDefinition] for
 	more details on how to use this.
@@ -36,6 +36,17 @@ SettingDefinitionProvider.ClassName = "SettingDefinitionProvider"
 SettingDefinitionProvider.ServiceName = "SettingDefinitionProvider"
 SettingDefinitionProvider.__index = SettingDefinitionProvider
 
+export type SettingDefinitionProvider = typeof(setmetatable(
+	{} :: {
+		_settingDefinitionList: { SettingDefinition.SettingDefinition<any> },
+		_lookup: { [string]: SettingDefinition.SettingDefinition<any> },
+		_maid: Maid.Maid,
+		_serviceBag: ServiceBag.ServiceBag,
+		_initializedDefinitionLookup: { [any]: SettingDefinition.SettingDefinition<any> },
+	},
+	{} :: typeof({ __index = SettingDefinitionProvider })
+))
+
 --[=[
 	Constructs a new provider with a list of [SettingDefinition]'s.
 
@@ -68,8 +79,8 @@ SettingDefinitionProvider.__index = SettingDefinitionProvider
 	@param settingDefinitions { SettingDefinition }
 	@return SettingDefinitionProvider
 ]=]
-function SettingDefinitionProvider.new(settingDefinitions)
-	local self = setmetatable({}, SettingDefinitionProvider)
+function SettingDefinitionProvider.new(settingDefinitions: { [any]: any }): SettingDefinitionProvider
+	local self: SettingDefinitionProvider = setmetatable({} :: any, SettingDefinitionProvider)
 
 	self._settingDefinitionList = {}
 	self._lookup = {}
@@ -78,7 +89,7 @@ function SettingDefinitionProvider.new(settingDefinitions)
 		if type(key) == "number" then
 			assert(SettingDefinition.isSettingDefinition(key), "Bad settingDefinition")
 
-			self:_addSettingDefinition(key)
+			self:_addSettingDefinition(key :: any)
 		elseif type(key) == "string" then
 			if SettingDefinition.isSettingDefinition(value) then
 				self:_addSettingDefinition(value)
@@ -94,7 +105,10 @@ function SettingDefinitionProvider.new(settingDefinitions)
 	return self
 end
 
-function SettingDefinitionProvider:_addSettingDefinition(settingDefinition)
+function SettingDefinitionProvider._addSettingDefinition(
+	self: SettingDefinitionProvider,
+	settingDefinition: SettingDefinition.SettingDefinition<any>
+): ()
 	assert(SettingDefinition.isSettingDefinition(settingDefinition), "Bad settingDefinition")
 
 	table.insert(self._settingDefinitionList, settingDefinition)
@@ -106,9 +120,9 @@ end
 
 	@param serviceBag ServiceBag
 ]=]
-function SettingDefinitionProvider:Init(serviceBag: ServiceBag.ServiceBag)
+function SettingDefinitionProvider.Init(self: SettingDefinitionProvider, 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")
@@ -117,18 +131,20 @@ function SettingDefinitionProvider:Init(serviceBag: ServiceBag.ServiceBag)
 
 	-- Register our setting definitions
 	for _, settingDefinition in self._settingDefinitionList do
-		local initialized = self._serviceBag:GetService(settingDefinition)
-		self._initializedDefinitionLookup[settingDefinition] = initialized
+		local rawSettingDefinition = settingDefinition :: any
+		local initialized = self._serviceBag:GetService(rawSettingDefinition)
+		self._initializedDefinitionLookup[rawSettingDefinition] = initialized
 
 		-- Store lookup to overcome metatable lookup
-		self[settingDefinition:GetSettingName()] = initialized
+		local rawSelf = self :: any
+		rawSelf[rawSettingDefinition:GetSettingName()] = initialized
 	end
 end
 
 --[=[
 	Starts the provider. Empty.
 ]=]
-function SettingDefinitionProvider:Start()
+function SettingDefinitionProvider.Start(_self: SettingDefinitionProvider): ()
 	-- Empty, to prevent us from erroring on service bag init
 end
 
@@ -137,7 +153,9 @@ end
 
 	@return { SettingDefinition }
 ]=]
-function SettingDefinitionProvider:GetSettingDefinitions()
+function SettingDefinitionProvider.GetSettingDefinitions(
+	self: SettingDefinitionProvider
+): { SettingDefinition.SettingDefinition<any> }
 	if self._serviceBag then
 		local copy = table.clone(self._settingDefinitionList)
 
@@ -171,8 +189,9 @@ end
 
 	@param index string
 	@return SettingDefinition
+	@within SettingDefinitionProvider
 ]=]
-function SettingDefinitionProvider:__index(index)
+(SettingDefinitionProvider :: any).__index = function(self: any, index: any)
 	if index == nil then
 		error("[SettingDefinitionProvider] - Cannot index provider with nil value")
 	elseif SettingDefinitionProvider[index] then
@@ -186,7 +205,7 @@ function SettingDefinitionProvider:__index(index)
 	then
 		return rawget(self, index)
 	elseif type(index) == "string" then
-		local lookup = rawget(self, "_lookup")
+		local lookup = rawget(self, "_lookup") :: any
 		local settingDefinition = lookup[index]
 		if not settingDefinition then
 			error(string.format("Bad index %q into SettingDefinitionProvider", tostring(index)))
@@ -208,7 +227,10 @@ end
 	@param settingName string
 	@return SettingDefinition
 ]=]
-function SettingDefinitionProvider:Get(settingName: string)
+function SettingDefinitionProvider.Get(
+	self: SettingDefinitionProvider,
+	settingName: string
+): SettingDefinition.SettingDefinition<any>?
 	assert(type(settingName) == "string", "Bad settingName")
 
 	local found = self._lookup[settingName]
@@ -226,7 +248,7 @@ end
 --[=[
 	Cleans up the setting registration
 ]=]
-function SettingDefinitionProvider:Destroy()
+function SettingDefinitionProvider.Destroy(self: SettingDefinitionProvider): ()
 	self._maid:DoCleaning()
 end
 

package/src/Shared/SettingsDataService.lua

@@ -1,4 +1,4 @@
---!nonstrict
+--!strict
 --[=[
 	Shared between client and server, letting us centralize definitions in one place.
 
@@ -9,21 +9,29 @@ local require = require(script.Parent.loader).load(script)
 
 local Players = game:GetService("Players")
 
+local Brio = require("Brio")
 local Maid = require("Maid")
+local Observable = require("Observable")
 local ObservableMap = require("ObservableMap")
 local ObservableSet = require("ObservableSet")
 local PlayerSettingsInterface = require("PlayerSettingsInterface")
+local Promise = require("Promise")
 local Rx = require("Rx")
 local RxBrioUtils = require("RxBrioUtils")
 local RxInstanceUtils = require("RxInstanceUtils")
 local ServiceBag = require("ServiceBag")
 
 local SettingsDataService = {}
+SettingsDataService.ServiceName = "SettingsDataService"
 
 export type SettingsDataService = typeof(setmetatable(
 	{} :: {
 		_serviceBag: ServiceBag.ServiceBag,
 		_maid: Maid.Maid,
+		_tieRealmService: any,
+		_settingDefinitions: ObservableSet.ObservableSet<any>,
+		_playerSettingsCacheMap: ObservableMap.ObservableMap<Player, any>,
+		_hydratedPlayersMaid: Maid.Maid,
 	},
 	{} :: typeof({ __index = SettingsDataService })
 ))
@@ -33,8 +41,8 @@ export type SettingsDataService = typeof(setmetatable(
 
 	@param serviceBag ServiceBag
 ]=]
-function SettingsDataService:Init(serviceBag: ServiceBag.ServiceBag)
-	assert(not self._serviceBag, "Already initialized")
+function SettingsDataService.Init(self: SettingsDataService, serviceBag: ServiceBag.ServiceBag): ()
+	assert(not (self :: any)._serviceBag, "Already initialized")
 	self._serviceBag = assert(serviceBag, "No serviceBag")
 	self._maid = Maid.new()
 
@@ -45,23 +53,28 @@ function SettingsDataService:Init(serviceBag: ServiceBag.ServiceBag)
 	self._settingDefinitions = self._maid:Add(ObservableSet.new())
 end
 
-function SettingsDataService:_getPlayerSettingsCacheMap()
+function SettingsDataService._getPlayerSettingsCacheMap(
+	self: SettingsDataService
+): ObservableMap.ObservableMap<Player, any>
 	-- Avoid hydrating
 	if self._playerSettingsCacheMap then
 		return self._playerSettingsCacheMap
 	end
 
-	self._playerSettingsCacheMap = self._maid:Add(ObservableMap.new())
+	self._playerSettingsCacheMap = self._maid:Add(ObservableMap.new() :: ObservableMap.ObservableMap<Player, any>)
 	self._hydratedPlayersMaid = self._maid:Add(Maid.new())
 
 	self._maid:GiveTask(Players.PlayerRemoving:Connect(function(player: Player)
 		self._hydratedPlayersMaid[player] = nil
 	end))
 
-	return self._playerSettingsCacheMap
+	return (self._playerSettingsCacheMap :: any) :: ObservableMap.ObservableMap<Player, any>
 end
 
-function SettingsDataService:_getPlayerSettingsMapForPlayer(player: Player)
+function SettingsDataService._getPlayerSettingsMapForPlayer(
+	self: SettingsDataService,
+	player: Player
+): ObservableMap.ObservableMap<Player, any>
 	local playerSettingsCacheMap = self:_getPlayerSettingsCacheMap()
 
 	if self._hydratedPlayersMaid[player] then
@@ -75,19 +88,19 @@ function SettingsDataService:_getPlayerSettingsMapForPlayer(player: Player)
 	return playerSettingsCacheMap
 end
 
-function SettingsDataService:_hydrateCacheForPlayer(player: Player)
+function SettingsDataService._hydrateCacheForPlayer(self: SettingsDataService, player: Player): Maid.Maid
 	local playerMaid = Maid.new()
 
-	playerMaid:GiveTask(RxInstanceUtils.observeChildrenBrio(player, function(value)
+	playerMaid:GiveTask((RxInstanceUtils.observeChildrenBrio(player, function(value): any
 		-- We really only care about this, and we can assume we have the tag immediately
 		return value:HasTag("PlayerSettings")
-	end)
+	end) :: any)
 		:Pipe({
-			RxBrioUtils.flatMapBrio(function(playerSettingsInstance)
+			RxBrioUtils.flatMapBrio(function(playerSettingsInstance): any
 				return PlayerSettingsInterface:ObserveBrio(playerSettingsInstance, self._tieRealmService:GetTieRealm())
 			end),
 		})
-		:Subscribe(function(brio)
+		:Subscribe(function(brio): ()
 			if brio:IsDead() then
 				return
 			end
@@ -104,7 +117,7 @@ end
 
 	@return { SettingDefinition }
 ]=]
-function SettingsDataService:GetSettingDefinitions()
+function SettingsDataService.GetSettingDefinitions(self: SettingsDataService): { any }
 	return self._settingDefinitions:GetList()
 end
 
@@ -114,7 +127,7 @@ end
 	@param definition SettingDefinition
 	@return callback -- Cleanup callback
 ]=]
-function SettingsDataService:RegisterSettingDefinition(definition)
+function SettingsDataService.RegisterSettingDefinition(self: SettingsDataService, definition: any): () -> ()
 	assert(definition, "No definition")
 
 	return self._settingDefinitions:Add(definition)
@@ -125,7 +138,9 @@ end
 
 	@return Observable<Brio<SettingDefinition>>
 ]=]
-function SettingsDataService:ObserveRegisteredDefinitionsBrio()
+function SettingsDataService.ObserveRegisteredDefinitionsBrio(
+	self: SettingsDataService
+): Observable.Observable<Brio.Brio<any>>
 	return self._settingDefinitions:ObserveItemsBrio()
 end
 
@@ -135,10 +150,16 @@ end
 	@param player Player
 	@return Observable<PlayerSettingsBase>
 ]=]
-function SettingsDataService:ObservePlayerSettings(player: Player)
+function SettingsDataService.ObservePlayerSettings(
+	self: SettingsDataService,
+	player: Player
+): Observable.Observable<any>
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 
-	return self:_getPlayerSettingsMapForPlayer(player):ObserveAtKey(player, self._tieRealmService:GetTieRealm())
+	return (self:_getPlayerSettingsMapForPlayer(player) :: any):ObserveAtKey(
+		player,
+		self._tieRealmService:GetTieRealm()
+	)
 end
 
 --[=[
@@ -147,8 +168,14 @@ end
 	@param player Player
 	@return Observable<Brio<PlayerSettingsClient>>
 ]=]
-function SettingsDataService:ObservePlayerSettingsBrio(player: Player)
-	return self:_getPlayerSettingsMapForPlayer(player):ObserveAtKeyBrio(player, self._tieRealmService:GetTieRealm())
+function SettingsDataService.ObservePlayerSettingsBrio(
+	self: SettingsDataService,
+	player: Player
+): Observable.Observable<Brio.Brio<any>>
+	return (self:_getPlayerSettingsMapForPlayer(player) :: any):ObserveAtKeyBrio(
+		player,
+		self._tieRealmService:GetTieRealm()
+	)
 end
 
 --[=[
@@ -158,12 +185,16 @@ end
 	@param cancelToken CancelToken
 	@return Promise<PlayerSettingsBase>
 ]=]
-function SettingsDataService:PromisePlayerSettings(player: Player, cancelToken)
+function SettingsDataService.PromisePlayerSettings(
+	self: SettingsDataService,
+	player: Player,
+	cancelToken: any
+): Promise.Promise<any>
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 
 	return Rx.toPromise(
-		self:ObservePlayerSettings(player):Pipe({
-			Rx.where(function(playerSettings)
+		(self:ObservePlayerSettings(player) :: any):Pipe({
+			Rx.where(function(playerSettings): any
 				return playerSettings ~= nil
 			end),
 		}),
@@ -177,7 +208,7 @@ end
 	@param player Player
 	@return Promise<PlayerSettingsBase>
 ]=]
-function SettingsDataService:GetPlayerSettings(player: Player)
+function SettingsDataService.GetPlayerSettings(self: SettingsDataService, player: Player): any
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 
 	return self:_getPlayerSettingsMapForPlayer(player):Get(player)
@@ -186,7 +217,7 @@ end
 --[=[
 	Cleans up the shared registry service
 ]=]
-function SettingsDataService:Destroy()
+function SettingsDataService.Destroy(self: SettingsDataService): ()
 	self._maid:DoCleaning()
 end