@quenty/textfilterservice 13.18.3 → 13.18.4-canary.11a5dcf.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.
 
+## [13.18.4-canary.11a5dcf.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/textfilterservice@13.18.3...@quenty/textfilterservice@13.18.4-canary.11a5dcf.0) (2025-05-10)
+
+
+### Features
+
+* Add even more types ([b31717d](https://github.com/Quenty/NevermoreEngine/commit/b31717d8c9f7620c457f5018a2affa760a65334a))
+
+
+
+
+
 ## [13.18.3](https://github.com/Quenty/NevermoreEngine/compare/@quenty/textfilterservice@13.18.2...@quenty/textfilterservice@13.18.3) (2025-04-10)
 
 **Note:** Version bump only for package @quenty/textfilterservice

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/textfilterservice",
-  "version": "13.18.3",
+  "version": "13.18.4-canary.11a5dcf.0",
   "description": "Utility service that provides text filtering to the client",
   "keywords": [
     "Roblox",
@@ -27,15 +27,15 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/loader": "^10.8.3",
-    "@quenty/promise": "^10.10.4",
-    "@quenty/remoting": "^12.18.3",
-    "@quenty/rx": "^13.17.3",
-    "@quenty/table": "^3.7.4",
-    "@quenty/textfilterutils": "^10.10.4"
+    "@quenty/loader": "10.8.4-canary.11a5dcf.0",
+    "@quenty/promise": "10.10.5-canary.11a5dcf.0",
+    "@quenty/remoting": "12.18.4-canary.11a5dcf.0",
+    "@quenty/rx": "13.17.4-canary.11a5dcf.0",
+    "@quenty/table": "3.7.5-canary.11a5dcf.0",
+    "@quenty/textfilterutils": "10.10.5-canary.11a5dcf.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "b06c070ae91d5dab7bd8de6e290ad2caabb15d8f"
+  "gitHead": "11a5dcf7d4c7a0bfbf3337e97d30e8346ea09d3f"
 }

package/src/Client/TextFilterServiceClient.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	@class TextFilterServiceClient
 ]=]
@@ -6,10 +7,11 @@ local require = require(script.Parent.loader).load(script)
 
 local RunService = game:GetService("RunService")
 
+local Observable = require("Observable")
 local Promise = require("Promise")
 local PromiseGetRemoteFunction = require("PromiseGetRemoteFunction")
-local TextFilterServiceConstants = require("TextFilterServiceConstants")
 local Rx = require("Rx")
+local TextFilterServiceConstants = require("TextFilterServiceConstants")
 local TextFilterUtils = require("TextFilterUtils")
 
 local TextFilterServiceClient = {}
@@ -22,14 +24,15 @@ TextFilterServiceClient.ServiceName = "TextFilterServiceClient"
 	@param fromUserId number
 	@return Promise<string>
 ]=]
-function TextFilterServiceClient:PromiseNonChatStringForUser(text, fromUserId)
+function TextFilterServiceClient:PromiseNonChatStringForUser(text: string, fromUserId: number): Promise.Promise<string>
 	assert(type(text) == "string", "Bad text")
 	assert(type(fromUserId) == "number", "Bad fromUserId")
 
 	return self:_promiseInvokeRemoteFunction(
 		TextFilterServiceConstants.REQUEST_NON_CHAT_STRING_FOR_USER,
 		text,
-		fromUserId)
+		fromUserId
+	)
 end
 
 --[=[
@@ -39,14 +42,18 @@ end
 	@param fromUserId number
 	@return Promise<string>
 ]=]
-function TextFilterServiceClient:PromiseNonChatStringForBroadcast(text, fromUserId)
+function TextFilterServiceClient:PromiseNonChatStringForBroadcast(
+	text: string,
+	fromUserId: number
+): Promise.Promise<string>
 	assert(type(text) == "string", "Bad text")
 	assert(type(fromUserId) == "number", "Bad fromUserId")
 
 	return self:_promiseInvokeRemoteFunction(
 		TextFilterServiceConstants.REQUEST_NON_CHAT_STRING_FOR_BROADCAST,
 		text,
-		fromUserId)
+		fromUserId
+	)
 end
 
 --[=[
@@ -55,12 +62,13 @@ end
 	@param text string
 	@return Promise<string>
 ]=]
-function TextFilterServiceClient:PromisePreviewNonChatStringForBroadcast(text: string)
+function TextFilterServiceClient:PromisePreviewNonChatStringForBroadcast(text: string): Promise.Promise<string>
 	assert(type(text) == "string", "Bad text")
 
 	return self:_promiseInvokeRemoteFunction(
 		TextFilterServiceConstants.REQUEST_PREVIEW_NON_CHAT_STRING_FOR_BROADCAST,
-		text)
+		text
+	)
 end
 
 --[=[
@@ -69,8 +77,8 @@ end
 	@param text string
 	@return Promise<string>
 ]=]
-function TextFilterServiceClient:ObservePreviewNonChatStringForBroadcast(text)
-	return Rx.fromPromise(self:PromisePreviewNonChatStringForBroadcast(text))
+function TextFilterServiceClient:ObservePreviewNonChatStringForBroadcast(text: string): Observable.Observable<string>
+	return Rx.fromPromise(self:PromisePreviewNonChatStringForBroadcast(text)) :: any
 end
 
 function TextFilterServiceClient:_promiseInvokeRemoteFunction(request, text, ...)
@@ -83,32 +91,31 @@ function TextFilterServiceClient:_promiseInvokeRemoteFunction(request, text, ...
 		return self:_fakeTestFilter(text)
 	end
 
-	return self:_promiseRemoteFunction()
-		:Then(function(remoteFunction)
-			return Promise.spawn(function(resolve, reject)
-				local resultOk, result
-				local ok, err = pcall(function()
-					resultOk, result = remoteFunction:InvokeServer(request, text, table.unpack(args, 1, args.n))
-				end)
+	return self:_promiseRemoteFunction():Then(function(remoteFunction)
+		return Promise.spawn(function(resolve, reject)
+			local resultOk, result
+			local ok, err = pcall(function()
+				resultOk, result = remoteFunction:InvokeServer(request, text, table.unpack(args, 1, args.n))
+			end)
 
-				if not ok then
-					return reject(err)
-				end
+			if not ok then
+				return reject(err)
+			end
 
-				if not resultOk then
-					return reject(result or "Failed to get a valid result from server")
-				end
+			if not resultOk then
+				return reject(result or "Failed to get a valid result from server")
+			end
 
-				if type(result) ~= "string" then
-					return reject(err or result or "Failed to get string result from server")
-				end
+			if type(result) ~= "string" then
+				return reject(err or result or "Failed to get string result from server")
+			end
 
-				return resolve(TextFilterUtils.addBackInNewLinesAndWhitespace(text, result))
-			end)
+			return resolve(TextFilterUtils.addBackInNewLinesAndWhitespace(text, result))
 		end)
+	end)
 end
 
-function TextFilterServiceClient:_promiseRemoteFunction()
+function TextFilterServiceClient:_promiseRemoteFunction(): Promise.Promise<RemoteFunction>
 	if self._remoteFunctionPromise then
 		return self._remoteFunctionPromise
 	end
@@ -117,7 +124,7 @@ function TextFilterServiceClient:_promiseRemoteFunction()
 	return self._remoteFunctionPromise
 end
 
-function TextFilterServiceClient:_fakeTestFilter(text)
+function TextFilterServiceClient:_fakeTestFilter(text: string): Promise.Promise<string>
 	local filteredText = text
 	filteredText = string.gsub(filteredText, "[fF][uU][cC][kK]", "####")
 	filteredText = string.gsub(filteredText, "\n", "")
@@ -130,4 +137,4 @@ function TextFilterServiceClient:_fakeTestFilter(text)
 	end)
 end
 
-return TextFilterServiceClient
+return TextFilterServiceClient

package/src/Server/TextFilterService.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	@class TextFilterService
 ]=]
@@ -5,6 +6,7 @@
 local require = require(script.Parent.loader).load(script)
 
 local GetRemoteFunction = require("GetRemoteFunction")
+local Promise = require("Promise")
 local TextFilterServiceConstants = require("TextFilterServiceConstants")
 local TextFilterUtils = require("TextFilterUtils")
 
@@ -28,7 +30,7 @@ function TextFilterService:_handleServerInvoke(...)
 	return true, filteredName
 end
 
-function TextFilterService:_turnRequestToPromise(player, request, ...)
+function TextFilterService:_turnRequestToPromise(player: Player, request: string, ...)
 	assert(player, "Bad player")
 	assert(type(request) == "string", "Bad request")
 
@@ -43,16 +45,21 @@ function TextFilterService:_turnRequestToPromise(player, request, ...)
 	end
 end
 
-function TextFilterService:_promiseNonChatStringForUser(player, text, fromUserId)
+function TextFilterService:_promiseNonChatStringForUser(
+	player: Player,
+	text: string,
+	fromUserId: number
+): Promise.Promise<string>
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 	assert(type(text) == "string", "Bad text")
 	assert(type(fromUserId) == "number", "Bad fromUserId")
 
 	return TextFilterUtils.promiseNonChatStringForUserAsync(
-			text,
-			fromUserId,
-			player.UserId,
-			Enum.TextFilterContext.PublicChat)
+		text,
+		fromUserId,
+		player.UserId,
+		Enum.TextFilterContext.PublicChat
+	)
 		:Catch(function(_)
 			-- Error occurs due to player having left the game, but we still need to display their text, so let's fallback
 			-- to this text
@@ -60,15 +67,16 @@ function TextFilterService:_promiseNonChatStringForUser(player, text, fromUserId
 		end)
 end
 
-function TextFilterService:_promiseNonChatStringForBroadcast(player, text, fromUserId)
+function TextFilterService:_promiseNonChatStringForBroadcast(
+	player: Player,
+	text: string,
+	fromUserId: number
+): Promise.Promise<string>
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 	assert(type(text) == "string", "Bad text")
 	assert(type(fromUserId) == "number", "Bad fromUserId")
 
-	return TextFilterUtils.promiseNonChatStringForBroadcast(
-			text,
-			fromUserId,
-			Enum.TextFilterContext.PublicChat)
+	return TextFilterUtils.promiseNonChatStringForBroadcast(text, fromUserId, Enum.TextFilterContext.PublicChat)
 		:Catch(function(_)
 			-- Error occurs due to player having left the game, but we still need to display their text, so let's fallback
 			-- to this text
@@ -76,7 +84,10 @@ function TextFilterService:_promiseNonChatStringForBroadcast(player, text, fromU
 		end)
 end
 
-function TextFilterService:_promisePreviewNonChatStringForBroadcast(player, text)
+function TextFilterService:_promisePreviewNonChatStringForBroadcast(
+	player: Player,
+	text: string
+): Promise.Promise<string>
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 	assert(type(text) == "string", "Bad text")
 
@@ -84,4 +95,4 @@ function TextFilterService:_promisePreviewNonChatStringForBroadcast(player, text
 	return TextFilterUtils.promiseLegacyChatFilter(player, text)
 end
 
-return TextFilterService
+return TextFilterService

package/src/Shared/TextFilterServiceConstants.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	@class TextFilterServiceConstants
 ]=]
@@ -7,9 +8,9 @@ local require = require(script.Parent.loader).load(script)
 local Table = require("Table")
 
 return Table.readonly({
-	REMOTE_FUNCTION_NAME = "TextFilterServiceRemoteFunction";
+	REMOTE_FUNCTION_NAME = "TextFilterServiceRemoteFunction",
 
-	REQUEST_NON_CHAT_STRING_FOR_USER = "NonChatStringForUser";
-	REQUEST_NON_CHAT_STRING_FOR_BROADCAST = "NonChatStringForBroadcast";
-	REQUEST_PREVIEW_NON_CHAT_STRING_FOR_BROADCAST = "PreviewNonChatStringForBroadcast";
-})
+	REQUEST_NON_CHAT_STRING_FOR_USER = "NonChatStringForUser",
+	REQUEST_NON_CHAT_STRING_FOR_BROADCAST = "NonChatStringForBroadcast",
+	REQUEST_PREVIEW_NON_CHAT_STRING_FOR_BROADCAST = "PreviewNonChatStringForBroadcast",
+})