@quenty/textfilterservice 7.10.0 → 7.11.0

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [7.11.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/textfilterservice@7.10.0...@quenty/textfilterservice@7.11.0) (2023-08-01)
+
+
+### Bug Fixes
+
+* Fix missing Rx dependency in TextFilterService ([22c1326](https://github.com/Quenty/NevermoreEngine/commit/22c13268d17b838cd1baebac3000ecb93bafc905))
+
+
+### Features
+
+* Ensure we add back in whitespace after filtering ([632e1e0](https://github.com/Quenty/NevermoreEngine/commit/632e1e0d383ea90b67d81f8edd8bc8dd9b874d68))
+
+
+
+
+
 # [7.10.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/textfilterservice@7.9.1...@quenty/textfilterservice@7.10.0) (2023-07-28)
 
 **Note:** Version bump only for package @quenty/textfilterservice

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/textfilterservice",
-  "version": "7.10.0",
+  "version": "7.11.0",
   "description": "Utility service that provides text filtering to the client",
   "keywords": [
     "Roblox",
@@ -30,11 +30,12 @@
     "@quenty/loader": "^6.2.1",
     "@quenty/promise": "^6.7.0",
     "@quenty/remoting": "^6.9.0",
+    "@quenty/rx": "^7.14.0",
     "@quenty/table": "^3.2.0",
-    "@quenty/textfilterutils": "^6.7.0"
+    "@quenty/textfilterutils": "^6.8.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "539b6bcf1266fb18e143059d08381654cca200bd"
+  "gitHead": "839b4d929e4d6154aadf719f1ecfb9add4c8b247"
 }

package/src/Client/TextFilterServiceClient.lua

@@ -9,10 +9,19 @@ local RunService = game:GetService("RunService")
 local Promise = require("Promise")
 local PromiseGetRemoteFunction = require("PromiseGetRemoteFunction")
 local TextFilterServiceConstants = require("TextFilterServiceConstants")
+local Rx = require("Rx")
+local TextFilterUtils = require("TextFilterUtils")
 
 local TextFilterServiceClient = {}
 TextFilterServiceClient.ServiceName = "TextFilterServiceClient"
 
+--[=[
+	Filters a non-chat string for a user
+
+	@param text string
+	@param fromUserId number
+	@return Promise<string>
+]=]
 function TextFilterServiceClient:PromiseNonChatStringForUser(text, fromUserId)
 	assert(type(text) == "string", "Bad text")
 	assert(type(fromUserId) == "number", "Bad fromUserId")
@@ -23,6 +32,13 @@ function TextFilterServiceClient:PromiseNonChatStringForUser(text, fromUserId)
 		fromUserId)
 end
 
+--[=[
+	Filters a non-chat string for a broadcast
+
+	@param text string
+	@param fromUserId number
+	@return Promise<string>
+]=]
 function TextFilterServiceClient:PromiseNonChatStringForBroadcast(text, fromUserId)
 	assert(type(text) == "string", "Bad text")
 	assert(type(fromUserId) == "number", "Bad fromUserId")
@@ -33,6 +49,12 @@ function TextFilterServiceClient:PromiseNonChatStringForBroadcast(text, fromUser
 		fromUserId)
 end
 
+--[=[
+	Filters a preview-non-chat string for a broadcast
+
+	@param text string
+	@return Promise<string>
+]=]
 function TextFilterServiceClient:PromisePreviewNonChatStringForBroadcast(text)
 	assert(type(text) == "string", "Bad text")
 
@@ -41,6 +63,16 @@ function TextFilterServiceClient:PromisePreviewNonChatStringForBroadcast(text)
 		text)
 end
 
+--[=[
+	Observes a non-chat string preview for broadcast
+
+	@param text string
+	@return Promise<string>
+]=]
+function TextFilterServiceClient:ObservePreviewNonChatStringForBroadcast(text)
+	return Rx.fromPromise(self:PromisePreviewNonChatStringForBroadcast(text))
+end
+
 function TextFilterServiceClient:_promiseInvokeRemoteFunction(request, text, ...)
 	assert(type(request) == "string", "Bad request")
 	assert(type(text) == "string", "Bad text")
@@ -71,7 +103,7 @@ function TextFilterServiceClient:_promiseInvokeRemoteFunction(request, text, ...
 					return reject(err or result or "Failed to get string result from server")
 				end
 
-				return resolve(result)
+				return resolve(TextFilterUtils.addBackInNewLinesAndWhitespace(text, result))
 			end)
 		end)
 end
@@ -86,12 +118,14 @@ function TextFilterServiceClient:_promiseRemoteFunction()
 end
 
 function TextFilterServiceClient:_fakeTestFilter(text)
-	text = text:gsub("[fF][uU][cC][kK]", "####")
+	local filteredText = text
+	filteredText = filteredText:gsub("[fF][uU][cC][kK]", "####")
+	filteredText = filteredText:gsub("\n", "")
 
 	return Promise.spawn(function(resolve, _)
 		-- Simulate testing
 		task.delay(0.5, function()
-			resolve(text)
+			resolve(TextFilterUtils.addBackInNewLinesAndWhitespace(text, filteredText))
 		end)
 	end)
 end