@quenty/chatproviderservice 4.2.1 → 4.3.0

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.
 
+# [4.3.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/chatproviderservice@4.2.1...@quenty/chatproviderservice@4.3.0) (2023-12-14)
+
+
+### Features
+
+* ChatProviderService can disable chat ([99d06db](https://github.com/Quenty/NevermoreEngine/commit/99d06db7c7f1a2b16d2cb5ae9c0a26c842f1270b))
+
+
+
+
+
 ## [4.2.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/chatproviderservice@4.2.0...@quenty/chatproviderservice@4.2.1) (2023-10-28)
 
 **Note:** Version bump only for package @quenty/chatproviderservice

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/chatproviderservice",
-  "version": "4.2.1",
+  "version": "4.3.0",
   "description": "Provide wrapper around chat system to allow tags to be set",
   "keywords": [
     "Roblox",
@@ -25,33 +25,34 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/attributeutils": "^9.1.1",
-    "@quenty/baseobject": "^7.0.0",
-    "@quenty/binder": "^9.1.1",
-    "@quenty/brio": "^9.1.1",
-    "@quenty/clienttranslator": "^9.1.1",
-    "@quenty/cmdrservice": "^8.2.1",
-    "@quenty/color3utils": "^6.1.1",
-    "@quenty/instanceutils": "^8.1.1",
-    "@quenty/loader": "^7.0.0",
-    "@quenty/localizedtextutils": "^7.1.1",
+    "@quenty/attributeutils": "^9.2.0",
+    "@quenty/baseobject": "^7.1.0",
+    "@quenty/binder": "^9.2.0",
+    "@quenty/brio": "^9.2.0",
+    "@quenty/clienttranslator": "^9.2.0",
+    "@quenty/cmdrservice": "^8.3.0",
+    "@quenty/color3utils": "^6.2.0",
+    "@quenty/datastore": "^8.2.0",
+    "@quenty/instanceutils": "^8.2.0",
+    "@quenty/loader": "^7.1.0",
+    "@quenty/localizedtextutils": "^7.2.0",
     "@quenty/maid": "^2.6.0",
-    "@quenty/permissionprovider": "^9.2.1",
-    "@quenty/playerbinder": "^9.1.1",
-    "@quenty/playerutils": "^3.2.1",
-    "@quenty/preferredparentutils": "^4.0.0",
-    "@quenty/promise": "^7.0.0",
+    "@quenty/permissionprovider": "^9.3.0",
+    "@quenty/playerbinder": "^9.2.0",
+    "@quenty/playerutils": "^3.3.0",
+    "@quenty/preferredparentutils": "^4.1.0",
+    "@quenty/promise": "^7.1.0",
     "@quenty/richtext": "^1.2.0",
-    "@quenty/rx": "^8.1.1",
-    "@quenty/rxbinderutils": "^9.1.1",
-    "@quenty/servicebag": "^7.0.0",
-    "@quenty/signal": "^3.0.0",
+    "@quenty/rx": "^8.2.0",
+    "@quenty/rxbinderutils": "^9.2.0",
+    "@quenty/servicebag": "^7.1.0",
+    "@quenty/signal": "^3.1.0",
     "@quenty/string": "^3.1.0",
-    "@quenty/table": "^3.3.0",
-    "@quenty/valueobject": "^8.1.1"
+    "@quenty/table": "^3.4.0",
+    "@quenty/valueobject": "^8.2.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "440aca7ce2b50b74317ee05fdc0b8d1e58001af3"
+  "gitHead": "2c2dbbc0cb2fbb46b4f3270c559c63890fe18b26"
 }

package/src/Client/Binders/ChatTagClient.lua

@@ -4,8 +4,8 @@
 
 local require = require(script.Parent.loader).load(script)
 
-local ChatTagBase = require("ChatTagBase")
 local Binder = require("Binder")
+local ChatTagBase = require("ChatTagBase")
 
 local ChatTagClient = setmetatable({}, ChatTagBase)
 ChatTagClient.ClassName = "ChatTagClient"

package/src/Client/ChatProviderServiceClient.lua

@@ -28,6 +28,7 @@ function ChatProviderServiceClient:Init(serviceBag)
 	-- Binders
 	self._serviceBag:GetService(require("ChatTagClient"))
 	self._serviceBag:GetService(require("ChatProviderTranslator"))
+	self._serviceBag:GetService(require("ChatProviderCommandServiceClient"))
 	self._hasChatTagsBinder = self._serviceBag:GetService(require("HasChatTagsClient"))
 end
 

package/src/Client/Commands/ChatProviderCommandServiceClient.lua

@@ -0,0 +1,56 @@
+--[=[
+	@class ChatProviderCommandServiceClient
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local Players = game:GetService("Players")
+
+local ChatTagCmdrUtils = require("ChatTagCmdrUtils")
+local Set = require("Set")
+local Maid = require("Maid")
+local String = require("String")
+
+local ChatProviderCommandServiceClient = {}
+ChatProviderCommandServiceClient.ServiceName = "ChatProviderCommandServiceClient"
+
+function ChatProviderCommandServiceClient:Init(serviceBag)
+	assert(not self._serviceBag, "Already initialized")
+	self._serviceBag = assert(serviceBag, "No serviceBag")
+	self._maid = Maid.new()
+
+	self._cmdrService = self._serviceBag:GetService(require("CmdrServiceClient"))
+	self._chatProviderServiceClient = self._serviceBag:GetService(require("ChatProviderServiceClient"))
+	self._chatTagBinder = self._serviceBag:GetService(require("ChatTagClient"))
+end
+
+function ChatProviderCommandServiceClient:Start()
+	self._cmdrService:PromiseCmdr():Then(function(cmdr)
+		ChatTagCmdrUtils.registerChatTagKeys(cmdr, self)
+
+		self:_registerChatCommand(cmdr)
+	end)
+end
+
+function ChatProviderCommandServiceClient:_registerChatCommand(cmdr)
+	self._maid:GiveTask(self._chatProviderServiceClient.MessageIncoming:Connect(function(textChatMessage)
+		if not (textChatMessage.TextSource and textChatMessage.TextSource.UserId == Players.LocalPlayer.UserId) then
+			return
+		end
+
+		if String.startsWith(textChatMessage.Text, "/cmdr")  then
+			cmdr:Show()
+		end
+	end))
+end
+
+function ChatProviderCommandServiceClient:GetChatTagKeyList()
+	local tagSet = {}
+	for chatTag, _ in pairs(self._chatTagBinder:GetAllSet()) do
+		local tagKey = chatTag.ChatTagKey.Value
+		tagSet[tagKey] = true
+	end
+	return Set.toList(tagSet)
+end
+
+return ChatProviderCommandServiceClient

package/src/Server/Binders/ChatTag.lua

@@ -15,8 +15,40 @@ function ChatTag.new(folder, serviceBag)
 	local self = setmetatable(ChatTagBase.new(folder), ChatTag)
 
 	self._serviceBag = assert(serviceBag, "No serviceBag")
+	self._playerDataStoreService = self._serviceBag:GetService(require("PlayerDataStoreService"))
+
+	self:_loadData()
 
 	return self
 end
 
+function ChatTag:_getPlayer()
+	return self._obj:FindFirstAncestorWhichIsA("Player")
+end
+
+function ChatTag:_loadData()
+	local player = self:_getPlayer()
+	if not player then
+		return
+	end
+
+	local tagKey = self.ChatTagKey.Value
+	if not tagKey then
+		return
+	end
+
+	self._maid:GivePromise(self._playerDataStoreService:PromiseDataStore(player))
+		:Then(function(dataStore)
+			return dataStore:GetSubStore("chatTags"):GetSubStore(tagKey)
+		end)
+		:Then(function(dataStore)
+			return dataStore:Load("UserDisabled", false)
+				:Then(function(userDisabled)
+					self.UserDisabled.Value = userDisabled
+
+					self._maid:GiveTask(dataStore:StoreOnValueChange("UserDisabled", self.UserDisabled))
+				end)
+		end)
+end
+
 return Binder.new("ChatTag", ChatTag)

package/src/Server/Binders/HasChatTags.lua

@@ -13,6 +13,7 @@ local HasChatTagsConstants = require("HasChatTagsConstants")
 local LocalizedTextUtils = require("LocalizedTextUtils")
 local PlayerBinder = require("PlayerBinder")
 local String = require("String")
+local BinderUtils = require("BinderUtils")
 
 local HasChatTags = setmetatable({}, HasChatTagsBase)
 HasChatTags.ClassName = "HasChatTags"
@@ -53,6 +54,7 @@ function HasChatTags:AddChatTag(chatTagData)
 
 	local tag = self._chatTagBinder:Create("Folder")
 	tag.Name = string.format("ChatTag_%s", String.toCamelCase(chatTagData.TagText))
+	tag:SetAttribute(ChatTagConstants.TAG_KEY_ATTRIBUTE, String.toCamelCase(chatTagData.TagText))
 	tag:SetAttribute(ChatTagConstants.TAG_TEXT_ATTRIBUTE, chatTagData.TagText)
 	tag:SetAttribute(ChatTagConstants.TAG_COLOR_ATTRIBUTE, chatTagData.TagColor)
 	tag:SetAttribute(ChatTagConstants.TAG_PRIORITY_ATTRIBUTE, chatTagData.TagPriority)
@@ -66,6 +68,18 @@ function HasChatTags:AddChatTag(chatTagData)
 	return tag
 end
 
+function HasChatTags:GetChatTagByKey(chatTagKey)
+	assert(type(chatTagKey) == "string", "Bad chatTagKey")
+
+	for _, item in pairs(BinderUtils.getChildren(self._chatTagBinder, self._chatTagsContainer)) do
+		if item.ChatTagKey.Value == chatTagKey then
+			return item
+		end
+	end
+
+	return nil
+end
+
 --[=[
 	Removes all chat tags from the player
 ]=]

package/src/Server/ChatProviderService.lua

@@ -31,6 +31,7 @@ function ChatProviderService:Init(serviceBag)
 	-- External
 	self._serviceBag:GetService(require("CmdrService"))
 	self._serviceBag:GetService(require("PermissionService"))
+	self._serviceBag:GetService(require("PlayerDataStoreService"))
 
 	-- Internal
 	self._serviceBag:GetService(require("ChatProviderCommandService"))
@@ -40,6 +41,8 @@ function ChatProviderService:Init(serviceBag)
 	self._serviceBag:GetService(require("ChatTag"))
 	self._hasChatTagsBinder = self._serviceBag:GetService(require("HasChatTags"))
 
+	-- note: normally we don't expose default APi surfaces like this with defaults, however, because this only affects developers and this
+	-- tends to significantly improve feedback we're leaving this default configuration in place.
 	self:SetDeveloperTag(ChatTagDataUtils.createChatTagData({
 		TagText = "(dev)";
 		LocalizedText = LocalizedTextUtils.create("chatTags.dev");

package/src/Server/Commands/ChatProviderCommandService.lua

@@ -4,8 +4,13 @@
 
 local require = require(script.Parent.loader).load(script)
 
-local PlayerUtils = require("PlayerUtils")
+local Players = game:GetService("Players")
+
+local ChatTagCmdrUtils = require("ChatTagCmdrUtils")
 local ChatTagDataUtils = require("ChatTagDataUtils")
+local PlayerUtils = require("PlayerUtils")
+local Set = require("Set")
+local Maid = require("Maid")
 
 local ChatProviderCommandService = {}
 ChatProviderCommandService.ServiceName = "ChatProviderCommandService"
@@ -13,19 +18,60 @@ ChatProviderCommandService.ServiceName = "ChatProviderCommandService"
 function ChatProviderCommandService:Init(serviceBag)
 	assert(not self._serviceBag, "Already initialized")
 	self._serviceBag = assert(serviceBag, "No serviceBag")
+	self._maid = Maid.new()
 
 	-- External
 	self._cmdrService = self._serviceBag:GetService(require("CmdrService"))
 
 	-- Internal
 	self._chatProviderService = self._serviceBag:GetService(require("ChatProviderService"))
+	self._chatTagBinder = self._serviceBag:GetService(require("ChatTag"))
+	self._hasChatTagsBinder = self._serviceBag:GetService(require("HasChatTags"))
 end
 
 function ChatProviderCommandService:Start()
 	self:_registerCommands()
+	self:_createActivateChatCommand()
+end
+
+function ChatProviderCommandService:_createActivateChatCommand()
+	local command = Instance.new("TextChatCommand")
+	command.Name = "OpenCmdrCommand"
+	command.PrimaryAlias = "/cmdr"
+
+	self._maid:GiveTask(command)
+	self._maid:GiveTask(command.Triggered:Connect(function(originTextSource, _unfilteredText)
+		local player = Players:GetPlayerByUserId(originTextSource.UserId)
+		if not player then
+			return
+		end
+
+		self._permissionService:PromiseIsAdmin(player):Then(function(isAdmin)
+			if isAdmin then
+				self._remoting.OpenCmdr:FireClient(player)
+			end
+		end)
+	end))
+
+	self._chatProviderService:AddChatCommand(command)
+end
+
+
+function ChatProviderCommandService:GetChatTagKeyList()
+	local tagSet = {}
+	for chatTag, _ in pairs(self._chatTagBinder:GetAllSet()) do
+		local tagKey = chatTag.ChatTagKey.Value
+		tagSet[tagKey] = true
+	end
+
+	return Set.toList(tagSet)
 end
 
 function ChatProviderCommandService:_registerCommands()
+	self._cmdrService:PromiseCmdr():Then(function(cmdr)
+		ChatTagCmdrUtils.registerChatTagKeys(cmdr, self)
+	end)
+
 	self._cmdrService:RegisterCommand({
 		Name = "add-chat-tag";
 		Aliases = { };
@@ -84,6 +130,50 @@ function ChatProviderCommandService:_registerCommands()
 
 		return string.format("Cleared chat tags on a player %q", PlayerUtils.formatName(player))
 	end)
+
+	self._cmdrService:RegisterCommand({
+		Name = "set-chat-tag-disabled";
+		Aliases = { };
+		Description = "Sets if a chat tag is disabled for a player. This will save.";
+		Group = "ChatTags";
+		Args = {
+			{
+				Name = "Target";
+				Type = "player";
+				Description = "Player to disable or enable the tag for";
+			},
+			{
+				Name = "TagKey";
+				Type = "chatTagKey";
+				Description = "Chat tag to disable";
+			},
+			{
+				Name = "ChatTagDisabled";
+				Type = "boolean";
+				Description = "Whether or not the tag is disabled";
+				Default = true;
+			},
+		};
+	}, function(_context, player, chatTagKey, chatTagDisabled)
+		local hasChatTags = self._hasChatTagsBinder:Get(player)
+
+		if not hasChatTags then
+			return string.format("%s does not have chat tags", PlayerUtils.formatName(player))
+		end
+
+		local chatTag = hasChatTags:GetChatTagByKey(chatTagKey)
+		if not chatTag then
+			return string.format("%s does not have a chat tag with that key", PlayerUtils.formatName(player))
+		end
+
+		chatTag.UserDisabled.Value = chatTagDisabled
+
+		return string.format("Chat tag %q on player %q `UserDisabled` set to %s", chatTagKey, PlayerUtils.formatName(player), tostring(chatTagDisabled))
+	end)
+end
+
+function ChatProviderCommandService:Destroy()
+	self._maid:DoCleaning()
 end
 
 return ChatProviderCommandService

package/src/Shared/Binders/ChatTagBase.lua

@@ -22,11 +22,15 @@ function ChatTagBase.new(obj)
 	self._chatTagColor = AttributeValue.new(self._obj, ChatTagConstants.TAG_COLOR_ATTRIBUTE, Color3.new(1, 1, 1))
 	self._chatTagPriority = AttributeValue.new(self._obj, ChatTagConstants.TAG_PRIORITY_ATTRIBUTE, 0)
 
+	self.UserDisabled = AttributeValue.new(self._obj, ChatTagConstants.USER_DISABLED_ATTRIBUTE, false)
+	self.ChatTagKey = AttributeValue.new(self._obj, ChatTagConstants.TAG_KEY_ATTRIBUTE, false)
+
 	return self
 end
 
 function ChatTagBase:ObserveChatTagData()
 	return Rx.combineLatest({
+		UserDisabled = self.UserDisabled:Observe();
 		TagText = self._chatTagText:Observe();
 		TagLocalizedText = self._chatTagLocalizedTextData:Observe():Pipe({
 			Rx.map(function(text)

package/src/Shared/Binders/HasChatTagsBase.lua

@@ -68,8 +68,14 @@ function HasChatTagsBase:_observeTagDataListBrio()
 		RxBrioUtils.switchMapBrio(function(child)
 			return RxBinderUtils.observeChildrenBrio(chatTagBinder, child);
 		end);
-		RxBrioUtils.switchMapBrio(function(chatTag)
-			return chatTag:ObserveChatTagData()
+		RxBrioUtils.flatMapBrio(function(chatTag)
+			return chatTag:ObserveChatTagData():Pipe({
+				RxBrioUtils.toBrio();
+				RxBrioUtils.onlyLastBrioSurvives();
+			})
+		end);
+		RxBrioUtils.where(function(chatTagData)
+			return not chatTagData.UserDisabled
 		end);
 		RxBrioUtils.reduceToAliveList()
 	})

package/src/Shared/ChatTagConstants.lua

@@ -9,6 +9,8 @@ local Table = require("Table")
 return Table.readonly({
 	TAG_TEXT_ATTRIBUTE = "TagText";
 	TAG_COLOR_ATTRIBUTE = "TagColor";
+	TAG_KEY_ATTRIBUTE = "ChatTagKey";
 	TAG_LOCALIZED_TEXT_ATTRIBUTE = "TagLocalizedText";
 	TAG_PRIORITY_ATTRIBUTE = "TagPriority";
+	USER_DISABLED_ATTRIBUTE = "UserDisabled";
 })

package/src/Shared/Commands/ChatTagCmdrUtils.lua

@@ -0,0 +1,29 @@
+--[=[
+	@class ChatTagCmdrUtils
+]=]
+
+local ChatTagCmdrUtils = {}
+
+function ChatTagCmdrUtils.registerChatTagKeys(cmdr, chatProviderService)
+	local chatTagKey = {
+		Transform = function(text)
+			local chatTagKeyList = chatProviderService:GetChatTagKeyList()
+			local find = cmdr.Util.MakeFuzzyFinder(chatTagKeyList)
+			return find(text)
+		end;
+		Validate = function(keys)
+			return #keys > 0, "No chat tag with that key could be found."
+		end,
+		Autocomplete = function(keys)
+			return keys
+		end,
+		Parse = function(keys)
+			return keys[1]
+		end;
+	}
+
+	cmdr.Registry:RegisterType("chatTagKey", chatTagKey)
+	cmdr.Registry:RegisterType("chatTagKeys", cmdr.Util.MakeListableType(chatTagKey))
+end
+
+return ChatTagCmdrUtils