@quenty/textserviceutils 13.18.0 → 13.18.1

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.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/textserviceutils@13.18.0...@quenty/textserviceutils@13.18.1) (2025-04-05)
+
+
+### Bug Fixes
+
+* Add types to packages ([2374fb2](https://github.com/Quenty/NevermoreEngine/commit/2374fb2b043cfbe0e9b507b3316eec46a4e353a0))
+
+
+
+
+
 # [13.18.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/textserviceutils@13.17.2...@quenty/textserviceutils@13.18.0) (2025-04-02)
 
 **Note:** Version bump only for package @quenty/textserviceutils

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/textserviceutils",
-  "version": "13.18.0",
+  "version": "13.18.1",
   "description": "Holds utilities involving the Roblox TextService and text fitting to size.",
   "keywords": [
     "Roblox",
@@ -30,10 +30,10 @@
     "access": "public"
   },
   "dependencies": {
-    "@quenty/blend": "^12.18.0",
-    "@quenty/loader": "^10.8.0",
-    "@quenty/promise": "^10.10.1",
-    "@quenty/rx": "^13.17.0"
+    "@quenty/blend": "^12.18.1",
+    "@quenty/loader": "^10.8.1",
+    "@quenty/promise": "^10.10.2",
+    "@quenty/rx": "^13.17.1"
   },
-  "gitHead": "e8ea56930e65322fcffc05a1556d5df988068f0b"
+  "gitHead": "78c3ac0ab08dd18085b6e6e6e4f745e76ed99f68"
 }

package/src/Shared/TextServiceUtils.lua

@@ -1,14 +1,16 @@
+--!strict
 --[=[
 	@class TextServiceUtils
 ]=]
 
-local TextService = game:GetService("TextService")
-
 local require = require(script.Parent.loader).load(script)
 
+local TextService = game:GetService("TextService")
+
 local Blend = require("Blend")
 local Promise = require("Promise")
 local Rx = require("Rx")
+local _Observable = require("Observable")
 
 local TextServiceUtils = {}
 
@@ -22,9 +24,9 @@ local TextServiceUtils = {}
 	@param textLabel TextLabel
 	@param text string
 	@param maxWidth number
-	@return Promise<Vector2>
+	@return Vector2
 ]=]
-function TextServiceUtils.getSizeForLabel(textLabel, text, maxWidth)
+function TextServiceUtils.getSizeForLabel(textLabel: TextLabel, text: string, maxWidth: number?): Vector2
 	assert(typeof(textLabel) == "Instance", "Bad textLabel")
 	assert(type(text) == "string", "Bad text")
 
@@ -34,15 +36,13 @@ function TextServiceUtils.getSizeForLabel(textLabel, text, maxWidth)
 	return TextService:GetTextSize(text, textLabel.TextSize, textLabel.Font, Vector2.new(maxWidth, 1e6))
 end
 
-
-
 --[=[
 	Promises the text bounds for the given parameters
 
 	@param params GetTextBoundsParams
 	@return Promise<Vector2>
 ]=]
-function TextServiceUtils.promiseTextBounds(params)
+function TextServiceUtils.promiseTextBounds(params: GetTextBoundsParams): Promise.Promise<Vector2>
 	assert(typeof(params) == "Instance" and params:IsA("GetTextBoundsParams"), "Bad params")
 
 	return Promise.spawn(function(resolve, reject)
@@ -59,6 +59,15 @@ function TextServiceUtils.promiseTextBounds(params)
 	end)
 end
 
+export type Props = {
+	Text: string | Instance,
+	TextSize: number,
+	Font: Enum.Font?,
+	FontFace: Font?,
+	MaxSize: Vector2?,
+	LineHeight: number?,
+}
+
 --[=[
 	Observes the current size for the current props. The properties
 	can be anything [Blend] would accept as an input. If FontFace is defined,
@@ -92,7 +101,7 @@ end
 	@param props table
 	@return Observable<Vector2> -- The text bounds reported
 ]=]
-function TextServiceUtils.observeSizeForLabelProps(props)
+function TextServiceUtils.observeSizeForLabelProps(props: Props): _Observable.Observable<Vector2>
 	assert(props.Text, "Bad props.Text")
 	assert(props.TextSize, "Bad props.TextSize")
 
@@ -108,7 +117,7 @@ function TextServiceUtils.observeSizeForLabelProps(props)
 		MaxSize = Blend.toPropertyObservable(props.MaxSize) or props.MaxSize or Vector2.new(1e6, 1e6),
 		LineHeight = Blend.toPropertyObservable(props.LineHeight) or 1,
 	}):Pipe({
-		Rx.switchMap(function(state)
+		Rx.switchMap(function(state: any): any
 			if typeof(state.FontFace) == "Font" then
 				-- Yes, our font may have to stream in
 				local params = Instance.new("GetTextBoundsParams")
@@ -119,15 +128,15 @@ function TextServiceUtils.observeSizeForLabelProps(props)
 
 				return Rx.fromPromise(TextServiceUtils.promiseTextBounds(params))
 			elseif typeof(state.Font) == "EnumItem" then
-				local size = TextService:GetTextSize(state.Text, state.TextSize, state.Font, state.MaxSize)
+				local size: Vector2 = TextService:GetTextSize(state.Text, state.TextSize, state.Font, state.MaxSize)
 
-				return Rx.of(Vector2.new(size.x, state.LineHeight*size.y))
+				return Rx.of(Vector2.new(size.X, state.LineHeight * size.Y))
 			else
 				warn("[TextServiceUtils.observeSizeForLabelProps] - Got neither FontFace or Font")
 				return Rx.of(Vector2.zero)
 			end
-		end)
-	})
+		end) :: any,
+	}) :: any
 end
 
 return TextServiceUtils