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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/uiobjectutils",
-  "version": "6.16.0",
+  "version": "6.16.1",
   "description": "UI object utils library for Roblox",
   "keywords": [
     "Roblox",
@@ -28,11 +28,11 @@
     "access": "public"
   },
   "dependencies": {
-    "@quenty/brio": "^14.17.0",
-    "@quenty/enumutils": "^3.4.0",
-    "@quenty/instanceutils": "^13.17.0",
-    "@quenty/loader": "^10.8.0",
-    "@quenty/rx": "^13.17.0"
+    "@quenty/brio": "^14.17.1",
+    "@quenty/enumutils": "^3.4.1",
+    "@quenty/instanceutils": "^13.17.1",
+    "@quenty/loader": "^10.8.1",
+    "@quenty/rx": "^13.17.1"
   },
-  "gitHead": "e8ea56930e65322fcffc05a1556d5df988068f0b"
+  "gitHead": "78c3ac0ab08dd18085b6e6e6e4f745e76ed99f68"
 }

package/src/Client/GuiInteractionUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	@class GuiInteractionUtils
 ]=]
@@ -7,6 +8,8 @@ local require = require(script.Parent.loader).load(script)
 local RxInstanceUtils = require("RxInstanceUtils")
 local Rx = require("Rx")
 local RxBrioUtils = require("RxBrioUtils")
+local _Observable = require("Observable")
+local _Brio = require("Brio")
 
 local GuiInteractionUtils = {}
 
@@ -16,7 +19,7 @@ local GuiInteractionUtils = {}
 	@param gui GuiObject
 	@return Observable<boolean>
 ]=]
-function GuiInteractionUtils.observeInteractionEnabled(gui: GuiObject)
+function GuiInteractionUtils.observeInteractionEnabled(gui: GuiObject): _Observable.Observable<boolean>
 	assert(typeof(gui) == "Instance" and gui:IsA("GuiObject"), "Bad gui")
 
 	return Rx.combineLatest({
@@ -27,9 +30,9 @@ function GuiInteractionUtils.observeInteractionEnabled(gui: GuiObject)
 		Rx.map(function(state)
 			return state.visible and state.guiState ~= Enum.GuiState.NonInteractable and state.dataModel and true
 				or false
-		end),
-		Rx.distinct(),
-	})
+		end) :: any,
+		Rx.distinct() :: any,
+	}) :: any
 end
 
 --[=[
@@ -37,16 +40,16 @@ end
 	interaction.
 
 	@param gui GuiObject
-	@return Observable<Brio>
+	@return Observable<Brio<true>>
 ]=]
-function GuiInteractionUtils.observeInteractionEnabledBrio(gui: GuiObject)
+function GuiInteractionUtils.observeInteractionEnabledBrio(gui: GuiObject): _Observable.Observable<_Brio.Brio<true>>
 	assert(typeof(gui) == "Instance" and gui:IsA("GuiObject"), "Bad gui")
 
 	return GuiInteractionUtils.observeInteractionEnabled(gui):Pipe({
 		RxBrioUtils.switchToBrio(function(canInteract)
 			return canInteract
-		end),
-	})
+		end) :: any,
+	}) :: any
 end
 
 return GuiInteractionUtils

package/src/Client/PlayerGuiUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Helper methods for finding and retrieving the [PlayerGui] instance
 	@class PlayerGuiUtils

package/src/Client/RxClippedRectUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Helper functions to observe parts of a Gui that are clipped or not
 
@@ -8,16 +9,23 @@ local require = require(script.Parent.loader).load(script)
 
 local Rx = require("Rx")
 local RxInstanceUtils = require("RxInstanceUtils")
+local _Observable = require("Observable")
 
 local RxClippedRectUtils = {}
 
+type State = {
+	absolutePosition: Vector2,
+	absoluteSize: Vector2,
+	parentRect: Rect?,
+}
+
 --[=[
 	Observes the clipped rect for the given Gui
 
 	@param gui Gui
 	@return Observable<Rect>
 ]=]
-function RxClippedRectUtils.observeClippedRect(gui: GuiObject)
+function RxClippedRectUtils.observeClippedRect(gui: GuiObject): _Observable.Observable<Rect>
 	assert(typeof(gui) == "Instance" and gui:IsA("GuiObject"), "Bad GuiBase2d")
 
 	-- At least use our object's size here...
@@ -26,28 +34,34 @@ function RxClippedRectUtils.observeClippedRect(gui: GuiObject)
 		absoluteSize = RxInstanceUtils.observeProperty(gui, "AbsoluteSize"),
 		parentRect = RxClippedRectUtils._observeParentClippedRect(gui),
 	}):Pipe({
-		Rx.map(function(state)
+		Rx.map(function(state: State)
 			if state.parentRect then
 				return RxClippedRectUtils._computeClippedRect(state)
 			else
 				return Rect.new(Vector2.zero, Vector2.zero)
 			end
-		end),
-		Rx.distinct(),
-	})
+		end) :: any,
+		Rx.distinct() :: any,
+	}) :: any
 end
 
 local function clampVector2(value: Vector2): Vector2
 	return Vector2.new(math.clamp(value.X, 0, 1), math.clamp(value.Y, 0, 1))
 end
 
+type ClippedRectState = {
+	visibleRect: Rect,
+	absolutePosition: Vector2,
+	absoluteSize: Vector2,
+}
+
 --[=[
 	Observes the clipped rect for the given Gui, but in scale coordinates
 
 	@param gui Gui
 	@return Observable<Rect>
 ]=]
-function RxClippedRectUtils.observeClippedRectInScale(gui: GuiObject)
+function RxClippedRectUtils.observeClippedRectInScale(gui: GuiObject): _Observable.Observable<Rect>
 	assert(typeof(gui) == "Instance" and gui:IsA("GuiObject"), "Bad GuiBase2d")
 
 	return Rx.combineLatest({
@@ -55,8 +69,8 @@ function RxClippedRectUtils.observeClippedRectInScale(gui: GuiObject)
 		absoluteSize = RxInstanceUtils.observeProperty(gui, "AbsoluteSize"),
 		visibleRect = RxClippedRectUtils.observeClippedRect(gui),
 	}):Pipe({
-		Rx.map(function(state)
-			if state.absoluteSize.x == 0 or state.absoluteSize.y == 0 then
+		Rx.map(function(state: ClippedRectState): Rect
+			if state.absoluteSize.X == 0 or state.absoluteSize.Y == 0 then
 				return Rect.new(Vector2.zero, Vector2.zero)
 			end
 
@@ -70,12 +84,12 @@ function RxClippedRectUtils.observeClippedRectInScale(gui: GuiObject)
 			local size = clampVector2(visibleSize / ourSize)
 			local bottomRight = topLeft + size
 			return Rect.new(topLeft, bottomRight)
-		end),
-		Rx.distinct(),
-	})
+		end) :: any,
+		Rx.distinct() :: any,
+	}) :: any
 end
 
-function RxClippedRectUtils._observeClippedRectImpl(gui: GuiObject)
+function RxClippedRectUtils._observeClippedRectImpl(gui: GuiObject): _Observable.Observable<Rect>
 	if gui:IsA("GuiObject") then
 		return RxInstanceUtils.observeProperty(gui, "ClipsDescendants"):Pipe({
 			Rx.switchMap(function(clipDescendants)
@@ -90,10 +104,10 @@ function RxClippedRectUtils._observeClippedRectImpl(gui: GuiObject)
 				}):Pipe({
 					Rx.map(function(state)
 						return RxClippedRectUtils._computeClippedRect(state)
-					end),
-				})
-			end),
-		})
+					end) :: any,
+				}) :: any
+			end) :: any,
+		}) :: any
 	else
 		if not gui:IsA("LayerCollector") then
 			warn(
@@ -111,12 +125,12 @@ function RxClippedRectUtils._observeClippedRectImpl(gui: GuiObject)
 		}):Pipe({
 			Rx.map(function(state)
 				return RxClippedRectUtils._computeClippedRect(state)
-			end),
-		})
+			end) :: any,
+		}) :: any
 	end
 end
 
-function RxClippedRectUtils._computeClippedRect(state)
+function RxClippedRectUtils._computeClippedRect(state: State): Rect
 	if not state.parentRect then
 		return Rect.new(state.absolutePosition, state.absolutePosition + state.absoluteSize)
 	end
@@ -126,11 +140,11 @@ function RxClippedRectUtils._computeClippedRect(state)
 
 	local parentMin = state.parentRect.Min
 	local parentMax = state.parentRect.Max
-	local topLeftX = math.max(topLeft.x, parentMin.x)
-	local topLeftY = math.max(topLeft.y, parentMin.y)
+	local topLeftX = math.max(topLeft.X, parentMin.X)
+	local topLeftY = math.max(topLeft.Y, parentMin.Y)
 
-	local bottomRightX = math.min(bottomRight.x, parentMax.x)
-	local bottomRightY = math.min(bottomRight.y, parentMax.y)
+	local bottomRightX = math.min(bottomRight.X, parentMax.X)
+	local bottomRightY = math.min(bottomRight.Y, parentMax.Y)
 
 	-- negative sizes not allowed...
 	local sizeX = math.max(0, bottomRightX - topLeftX)
@@ -139,18 +153,18 @@ function RxClippedRectUtils._computeClippedRect(state)
 	return Rect.new(topLeftX, topLeftY, topLeftX + sizeX, topLeftY + sizeY)
 end
 
-function RxClippedRectUtils._observeParentClippedRect(gui: GuiBase2d)
+function RxClippedRectUtils._observeParentClippedRect(gui: GuiBase2d): _Observable.Observable<Rect?>
 	assert(typeof(gui) == "Instance" and gui:IsA("GuiBase2d"), "Bad GuiBase2d")
 
 	return RxInstanceUtils.observeFirstAncestor(gui, "GuiObject"):Pipe({
-		Rx.switchMap(function(parent)
+		Rx.switchMap(function(parent: GuiObject): any
 			if parent then
 				return RxClippedRectUtils._observeClippedRectImpl(parent)
 			else
 				return Rx.of(nil)
 			end
-		end),
-	})
+		end) :: any,
+	}) :: any
 end
 
 return RxClippedRectUtils

package/src/Client/UIAlignmentUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Utility methods for working with horizontal and vertical alignment
 	@class UIAlignmentUtils
@@ -5,37 +6,37 @@
 
 local UIAlignmentUtils = {}
 
-local HORIZONTAL_ALIGNMENT = {
+local HORIZONTAL_ALIGNMENT: { [Enum.HorizontalAlignment]: number } = {
 	[Enum.HorizontalAlignment.Left] = 0,
 	[Enum.HorizontalAlignment.Center] = 0.5,
 	[Enum.HorizontalAlignment.Right] = 1,
 }
 
-local HORIZONTAL_BIAS = {
+local HORIZONTAL_BIAS: { [Enum.HorizontalAlignment]: number } = {
 	[Enum.HorizontalAlignment.Left] = -1,
 	[Enum.HorizontalAlignment.Center] = 0,
 	[Enum.HorizontalAlignment.Right] = 1,
 }
 
-local VERTICAL_ALIGNMENT = {
+local VERTICAL_ALIGNMENT: { [Enum.VerticalAlignment]: number } = {
 	[Enum.VerticalAlignment.Top] = 0,
 	[Enum.VerticalAlignment.Center] = 0.5,
 	[Enum.VerticalAlignment.Bottom] = 1,
 }
 
-local VERTICAL_BIAS = {
+local VERTICAL_BIAS: { [Enum.VerticalAlignment]: number } = {
 	[Enum.VerticalAlignment.Top] = -1,
 	[Enum.VerticalAlignment.Center] = 0,
 	[Enum.VerticalAlignment.Bottom] = 1,
 }
 
-local VERTICAL_TO_HORIZONTAL = {
+local VERTICAL_TO_HORIZONTAL: { [Enum.VerticalAlignment]: Enum.HorizontalAlignment } = {
 	[Enum.VerticalAlignment.Top] = Enum.HorizontalAlignment.Left,
 	[Enum.VerticalAlignment.Center] = Enum.HorizontalAlignment.Center,
 	[Enum.VerticalAlignment.Bottom] = Enum.HorizontalAlignment.Right,
 }
 
-local HORIZONTAL_TO_VERTICAL = {
+local HORIZONTAL_TO_VERTICAL: { [Enum.HorizontalAlignment]: Enum.VerticalAlignment } = {
 	[Enum.HorizontalAlignment.Left] = Enum.VerticalAlignment.Top,
 	[Enum.HorizontalAlignment.Center] = Enum.VerticalAlignment.Center,
 	[Enum.HorizontalAlignment.Right] = Enum.VerticalAlignment.Bottom,
@@ -50,10 +51,10 @@ local HORIZONTAL_TO_VERTICAL = {
 function UIAlignmentUtils.toNumber(alignment: Enum.HorizontalAlignment | Enum.VerticalAlignment): number
 	assert(alignment, "Bad alignment")
 
-	if HORIZONTAL_ALIGNMENT[alignment] then
-		return HORIZONTAL_ALIGNMENT[alignment]
-	elseif VERTICAL_ALIGNMENT[alignment] then
-		return VERTICAL_ALIGNMENT[alignment]
+	if HORIZONTAL_ALIGNMENT[alignment :: any] then
+		return HORIZONTAL_ALIGNMENT[alignment :: any]
+	elseif VERTICAL_ALIGNMENT[alignment :: any] then
+		return VERTICAL_ALIGNMENT[alignment :: any]
 	else
 		error(string.format("[UIAlignmentUtils.toNumber] - Bad alignment %q", tostring(alignment)))
 	end
@@ -112,10 +113,10 @@ end
 function UIAlignmentUtils.toBias(alignment: Enum.HorizontalAlignment | Enum.VerticalAlignment): number
 	assert(alignment, "Bad alignment")
 
-	if HORIZONTAL_BIAS[alignment] then
-		return HORIZONTAL_BIAS[alignment]
-	elseif VERTICAL_BIAS[alignment] then
-		return VERTICAL_BIAS[alignment]
+	if HORIZONTAL_BIAS[alignment :: any] then
+		return HORIZONTAL_BIAS[alignment :: any]
+	elseif VERTICAL_BIAS[alignment :: any] then
+		return VERTICAL_BIAS[alignment :: any]
 	else
 		error(string.format("[UIAlignmentUtils.toBias] - Bad alignment %q", tostring(alignment)))
 	end

package/src/Client/UIRotationUtils.lua

@@ -3,8 +3,6 @@
 	@class UIRotationUtils
 ]=]
 
-local require = require(script.Parent.loader).load(script)
-
 local UIRotationUtils = {}
 
 --[=[