@quenty/settings 5.0.0-canary.331.7eefa75.0 → 5.0.0-canary.367.903617a.0

package/CHANGELOG.md

@@ -3,7 +3,119 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-# [5.0.0-canary.331.7eefa75.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/settings@4.14.0...@quenty/settings@5.0.0-canary.331.7eefa75.0) (2023-02-27)
+# [5.0.0-canary.367.903617a.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/settings@4.26.0...@quenty/settings@5.0.0-canary.367.903617a.0) (2023-06-09)
+
+**Note:** Version bump only for package @quenty/settings
+
+
+
+
+
+# [4.26.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/settings@4.25.0...@quenty/settings@4.26.0) (2023-05-26)
+
+
+### Bug Fixes
+
+* Fix dependencies ([67791a2](https://github.com/Quenty/NevermoreEngine/commit/67791a289c0956bf4947ac81bf792ee56496b3e8))
+
+
+### Features
+
+* Add cmdr support to settings ([43e1c25](https://github.com/Quenty/NevermoreEngine/commit/43e1c2550dd02ad95827bc93a20a5aa1ff5e5e4a))
+
+
+
+
+
+# [4.25.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/settings@4.24.0...@quenty/settings@4.25.0) (2023-05-08)
+
+**Note:** Version bump only for package @quenty/settings
+
+
+
+
+
+# [4.24.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/settings@4.23.0...@quenty/settings@4.24.0) (2023-04-20)
+
+**Note:** Version bump only for package @quenty/settings
+
+
+
+
+
+# [4.23.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/settings@4.22.1...@quenty/settings@4.23.0) (2023-04-10)
+
+**Note:** Version bump only for package @quenty/settings
+
+
+
+
+
+## [4.22.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/settings@4.22.0...@quenty/settings@4.22.1) (2023-04-07)
+
+**Note:** Version bump only for package @quenty/settings
+
+
+
+
+
+# [4.22.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/settings@4.21.0...@quenty/settings@4.22.0) (2023-04-06)
+
+**Note:** Version bump only for package @quenty/settings
+
+
+
+
+
+# [4.21.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/settings@4.20.0...@quenty/settings@4.21.0) (2023-04-03)
+
+**Note:** Version bump only for package @quenty/settings
+
+
+
+
+
+# [4.20.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/settings@4.19.0...@quenty/settings@4.20.0) (2023-03-31)
+
+**Note:** Version bump only for package @quenty/settings
+
+
+
+
+
+# [4.19.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/settings@4.18.0...@quenty/settings@4.19.0) (2023-03-31)
+
+**Note:** Version bump only for package @quenty/settings
+
+
+
+
+
+# [4.18.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/settings@4.17.0...@quenty/settings@4.18.0) (2023-03-06)
+
+**Note:** Version bump only for package @quenty/settings
+
+
+
+
+
+# [4.17.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/settings@4.16.0...@quenty/settings@4.17.0) (2023-03-05)
+
+**Note:** Version bump only for package @quenty/settings
+
+
+
+
+
+# [4.16.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/settings@4.15.0...@quenty/settings@4.16.0) (2023-03-03)
+
+**Note:** Version bump only for package @quenty/settings
+
+
+
+
+
+# [4.15.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/settings@4.14.0...@quenty/settings@4.15.0) (2023-02-27)
 
 **Note:** Version bump only for package @quenty/settings
 

package/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2014-2022 Quenty
+Copyright (c) 2014-2023 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": "5.0.0-canary.331.7eefa75.0",
+  "version": "5.0.0-canary.367.903617a.0",
   "description": "Centralized player settings service",
   "keywords": [
     "Roblox",
@@ -25,31 +25,33 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/attributeutils": "9.0.0-canary.331.7eefa75.0",
-    "@quenty/baseobject": "6.1.0",
-    "@quenty/binder": "9.0.0-canary.331.7eefa75.0",
-    "@quenty/datastore": "8.0.0-canary.331.7eefa75.0",
-    "@quenty/enumutils": "3.0.0",
-    "@quenty/jsonutils": "7.0.0-canary.331.7eefa75.0",
-    "@quenty/loader": "6.1.0",
-    "@quenty/maid": "2.4.0",
-    "@quenty/observablecollection": "6.0.0-canary.331.7eefa75.0",
-    "@quenty/playerbinder": "9.0.0-canary.331.7eefa75.0",
-    "@quenty/remotefunctionutils": "7.0.0-canary.331.7eefa75.0",
-    "@quenty/remoting": "7.0.0-canary.331.7eefa75.0",
-    "@quenty/rx": "8.0.0-canary.331.7eefa75.0",
-    "@quenty/rxbinderutils": "9.0.0-canary.331.7eefa75.0",
-    "@quenty/servicebag": "6.5.0",
-    "@quenty/signal": "2.3.0",
-    "@quenty/statestack": "9.0.0-canary.331.7eefa75.0",
+    "@quenty/attributeutils": "8.15.0",
+    "@quenty/baseobject": "6.2.1",
+    "@quenty/binder": "9.0.0-canary.367.903617a.0",
+    "@quenty/cmdrservice": "7.15.0",
+    "@quenty/datastore": "8.0.0-canary.367.903617a.0",
+    "@quenty/enumutils": "3.1.0",
+    "@quenty/jsonutils": "6.5.0",
+    "@quenty/loader": "6.2.1",
+    "@quenty/maid": "2.5.0",
+    "@quenty/observablecollection": "6.0.0-canary.367.903617a.0",
+    "@quenty/playerbinder": "9.0.0-canary.367.903617a.0",
+    "@quenty/playerutils": "2.15.0",
+    "@quenty/remotefunctionutils": "6.6.0",
+    "@quenty/remoting": "6.5.0",
+    "@quenty/rx": "7.11.0",
+    "@quenty/rxbinderutils": "9.0.0-canary.367.903617a.0",
+    "@quenty/servicebag": "6.7.0",
+    "@quenty/signal": "2.4.0",
+    "@quenty/statestack": "9.0.0-canary.367.903617a.0",
     "@quenty/string": "3.1.0",
     "@quenty/symbol": "2.2.0",
     "@quenty/table": "3.2.0",
-    "@quenty/throttle": "6.1.0",
-    "@quenty/valueobject": "8.0.0-canary.331.7eefa75.0"
+    "@quenty/throttle": "6.2.1",
+    "@quenty/valueobject": "8.0.0-canary.367.903617a.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "7eefa756f8bd892b1210349a8133d6d56992dffb"
+  "gitHead": "903617ace784bce6cc7e0a15093ee50566bd9b54"
 }

package/src/Client/SettingsServiceClient.lua

@@ -12,6 +12,8 @@ local Players = game:GetService("Players")
 
 local PlayerSettingsUtils = require("PlayerSettingsUtils")
 local Rx = require("Rx")
+local Maid = require("Maid")
+local SettingsCmdrUtils = require("SettingsCmdrUtils")
 
 local SettingsServiceClient = {}
 
@@ -23,12 +25,20 @@ local SettingsServiceClient = {}
 function SettingsServiceClient:Init(serviceBag)
 	assert(not self._serviceBag, "Already initialized")
 	self._serviceBag = assert(serviceBag, "No serviceBag")
+	self._maid = Maid.new()
+
+	-- External
+	self._serviceBag:GetService(require("CmdrServiceClient"))
 
 	-- Internal
 	self._serviceBag:GetService(require("SettingRegistryServiceShared")):RegisterSettingService(self)
 	self._binders = self._serviceBag:GetService(require("SettingsBindersClient"))
 end
 
+function SettingsServiceClient:Start()
+	self:_setupCmdr()
+end
+
 --[=[
 	Gets the local player settings
 	@return PlayerSettingsClient | nil
@@ -118,4 +128,17 @@ function SettingsServiceClient:PromisePlayerSettings(player, cancelToken)
 	}), cancelToken)
 end
 
+
+function SettingsServiceClient:_setupCmdr()
+	local cmdrServiceClient = self._serviceBag:GetService(require("CmdrServiceClient"))
+
+	self._maid:GivePromise(cmdrServiceClient:PromiseCmdr()):Then(function(cmdr)
+		SettingsCmdrUtils.registerSettingDefinition(cmdr, self._serviceBag)
+	end)
+end
+
+function SettingsServiceClient:Destroy()
+	self._maid:DoCleaning()
+end
+
 return SettingsServiceClient

package/src/Server/Cmdr/SettingsCmdrService.lua

@@ -0,0 +1,69 @@
+--[=[
+	@class SettingsCmdrService
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local PlayerUtils = require("PlayerUtils")
+local SettingsCmdrUtils = require("SettingsCmdrUtils")
+local Maid = require("Maid")
+
+local SettingsCmdrService = {}
+SettingsCmdrService.ServiceName = "SettingsCmdrService"
+
+function SettingsCmdrService:Init(serviceBag)
+	assert(not self._serviceBag, "Already initialized")
+	self._serviceBag = assert(serviceBag, "No serviceBag")
+	self._maid = Maid.new()
+
+	self._cmdrService = self._serviceBag:GetService(require("CmdrService"))
+	self._settingService = self._serviceBag:GetService(require("SettingsService"))
+end
+
+function SettingsCmdrService:Start()
+	self:_setupCommands()
+end
+
+function SettingsCmdrService:_setupCommands()
+	self._maid:GivePromise(self._cmdrService:PromiseCmdr()):Then(function(cmdr)
+		SettingsCmdrUtils.registerSettingDefinition(cmdr, self._serviceBag)
+	end)
+
+	self._cmdrService:RegisterCommand({
+		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 = "Settings";
+				Type = "settingDefinitions";
+				Description = "Settings to restore.";
+			}
+		};
+	}, function(_context, players, settingsDefinitions)
+		local givenTo = {}
+
+		for _, player in pairs(players) do
+			local playerSettings = self._settingService:PromisePlayerSettings(player):Wait()
+			for _, settingDefinition in pairs(settingsDefinitions) do
+				playerSettings:RestoreDefault(settingDefinition:GetSettingName(), settingDefinition:GetDefaultValue())
+			end
+			table.insert(givenTo, PlayerUtils.formatName(player))
+		end
+
+		return ("Reset settings for %s"):format(table.concat(givenTo, ", "))
+	end)
+end
+
+function SettingsCmdrService:Destroy()
+	self._maid:DoCleaning()
+end
+
+
+return SettingsCmdrService

package/src/Server/SettingsService.lua

@@ -6,15 +6,19 @@ local require = require(script.Parent.loader).load(script)
 
 local PlayerSettingsUtils = require("PlayerSettingsUtils")
 local Rx = require("Rx")
+local Maid = require("Maid")
 
 local SettingsService = {}
 
 function SettingsService:Init(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"))
+
 
 	-- Internal
 	self._binders = self._serviceBag:GetService(require("SettingsBindersServer"))
@@ -49,4 +53,8 @@ function SettingsService:PromisePlayerSettings(player, cancelToken)
 	}), cancelToken)
 end
 
+function SettingsService:Destroy()
+	self._maid:DoCleaning()
+end
+
 return SettingsService

package/src/Shared/Cmdr/SettingsCmdrUtils.lua

@@ -0,0 +1,53 @@
+--[=[
+	@class SettingsCmdrUtils
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local ServiceBag = require("ServiceBag")
+local SettingRegistryServiceShared = require("SettingRegistryServiceShared")
+
+local SettingsCmdrUtils = {}
+
+function SettingsCmdrUtils.registerSettingDefinition(cmdr, serviceBag)
+	assert(ServiceBag.isServiceBag(serviceBag), "Bad serviceBag")
+
+	local settingRegistryService = serviceBag:GetService(SettingRegistryServiceShared)
+
+	local settingDefinitionType = {
+		Transform = function(text)
+			local definitions = settingRegistryService:GetSettingDefinitions()
+			local settingNames = {}
+			for _, settingDefinition in pairs(definitions) do
+				table.insert(settingNames, settingDefinition:GetSettingName())
+			end
+
+			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."
+		end,
+		Autocomplete = function(keys)
+			return keys
+		end,
+		Parse = function(keys)
+			local name = keys[1]
+
+			local definitions = settingRegistryService:GetSettingDefinitions()
+			for _, settingDefinition in pairs(definitions) do
+				if settingDefinition:GetSettingName() == name then
+					return settingDefinition
+				end
+			end
+
+			return nil
+		end;
+	}
+
+	cmdr.Registry:RegisterType("settingDefinition", settingDefinitionType)
+	cmdr.Registry:RegisterType("settingDefinitions", cmdr.Util.MakeListableType(settingDefinitionType))
+end
+
+
+return SettingsCmdrUtils

package/src/Shared/SettingRegistryServiceShared.lua

@@ -30,6 +30,10 @@ function SettingRegistryServiceShared:Init(serviceBag)
 	self._maid:GiveTask(self._settingDefinitions)
 end
 
+function SettingRegistryServiceShared:GetSettingDefinitions()
+	return self._settingDefinitions:GetList()
+end
+
 --[=[
 	Registers the shared setting service for this bridge