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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/adorneeboundingbox",
-  "version": "8.20.0",
+  "version": "8.20.1",
   "description": "Handles logic for reactive bounding box monitoring",
   "keywords": [
     "Roblox",
@@ -25,20 +25,20 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/baseobject": "^10.8.0",
-    "@quenty/brio": "^14.17.0",
-    "@quenty/draw": "^7.8.1",
-    "@quenty/instanceutils": "^13.17.0",
-    "@quenty/loader": "^10.8.0",
-    "@quenty/maid": "^3.4.0",
-    "@quenty/observablecollection": "^12.20.0",
-    "@quenty/rx": "^13.17.0",
-    "@quenty/selectionutils": "^8.17.0",
-    "@quenty/signal": "^7.10.0",
-    "@quenty/valueobject": "^13.17.0"
+    "@quenty/baseobject": "^10.8.1",
+    "@quenty/brio": "^14.17.1",
+    "@quenty/draw": "^7.8.2",
+    "@quenty/instanceutils": "^13.17.1",
+    "@quenty/loader": "^10.8.1",
+    "@quenty/maid": "^3.4.1",
+    "@quenty/observablecollection": "^12.20.1",
+    "@quenty/rx": "^13.17.1",
+    "@quenty/selectionutils": "^8.17.1",
+    "@quenty/signal": "^7.10.1",
+    "@quenty/valueobject": "^13.17.1"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e8ea56930e65322fcffc05a1556d5df988068f0b"
+  "gitHead": "78c3ac0ab08dd18085b6e6e6e4f745e76ed99f68"
 }

package/src/Shared/AdorneeBoundingBox.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	@class AdorneeBoundingBox
 ]=]
@@ -5,6 +6,7 @@
 local require = require(script.Parent.loader).load(script)
 
 local AdorneeModelBoundingBox = require("AdorneeModelBoundingBox")
+local AdorneePartBoundingBox = require("AdorneePartBoundingBox")
 local BaseObject = require("BaseObject")
 local Maid = require("Maid")
 local Rx = require("Rx")
@@ -12,14 +14,16 @@ local RxBrioUtils = require("RxBrioUtils")
 local RxInstanceUtils = require("RxInstanceUtils")
 local RxPartBoundingBoxUtils = require("RxPartBoundingBoxUtils")
 local ValueObject = require("ValueObject")
-local AdorneePartBoundingBox = require("AdorneePartBoundingBox")
+local _Observable = require("Observable")
 
 local AdorneeBoundingBox = setmetatable({}, BaseObject)
 AdorneeBoundingBox.ClassName = "AdorneeBoundingBox"
 AdorneeBoundingBox.__index = AdorneeBoundingBox
 
-function AdorneeBoundingBox.new(initialAdornee)
-	local self = setmetatable(BaseObject.new(), AdorneeBoundingBox)
+export type AdorneeBoundingBox = typeof(setmetatable({}, AdorneeBoundingBox))
+
+function AdorneeBoundingBox.new(initialAdornee: Instance): AdorneeBoundingBox
+	local self = setmetatable(BaseObject.new() :: any, AdorneeBoundingBox)
 
 	self._adornee = self._maid:Add(ValueObject.new(initialAdornee))
 	self._bbCFrame = self._maid:Add(ValueObject.new(nil))
@@ -41,7 +45,7 @@ function AdorneeBoundingBox.new(initialAdornee)
 	return self
 end
 
-function AdorneeBoundingBox:SetAdornee(adornee)
+function AdorneeBoundingBox:SetAdornee(adornee: Instance?): () -> ()
 	assert(typeof(adornee) == "Instance" or adornee == nil, "Bad adornee")
 
 	self._adornee.Value = adornee
@@ -53,18 +57,31 @@ function AdorneeBoundingBox:SetAdornee(adornee)
 	end
 end
 
-function AdorneeBoundingBox:ObserveBoundingBox()
+export type BoundingBoxData = {
+	CFrame: CFrame,
+	Size: Vector3,
+}
+
+--[=[
+	Observes the bounding box of the adornee
+	@return Observable<BoundingBoxData>
+]=]
+function AdorneeBoundingBox:ObserveBoundingBox(): _Observable.Observable<BoundingBoxData>
 	return Rx.combineLatest({
 		CFrame = self:ObserveCFrame(),
 		Size = self:ObserveSize(),
 	}):Pipe({
-		Rx.where(function(state)
+		Rx.where(function(state: any)
 			return state.CFrame and state.Size
-		end),
-	})
+		end) :: any,
+	}) :: any
 end
 
-function AdorneeBoundingBox:GetBoundingBox()
+--[=[
+	Gets the bounding box of the adornee
+	@return BoundingBoxData?
+]=]
+function AdorneeBoundingBox:GetBoundingBox(): BoundingBoxData?
 	local cframe = self._bbCFrame.Value
 	local size = self._bbSize.Value
 
@@ -82,7 +99,7 @@ end
 	Observes the cframe of the adornee
 	@return Observable<Vector3>
 ]=]
-function AdorneeBoundingBox:ObserveCFrame()
+function AdorneeBoundingBox:ObserveCFrame(): _Observable.Observable<CFrame>
 	return self._bbCFrame:Observe()
 end
 
@@ -90,7 +107,7 @@ end
 	Gets the CFrame of the adornee
 	@return Vector3
 ]=]
-function AdorneeBoundingBox:GetCFrame()
+function AdorneeBoundingBox:GetCFrame(): CFrame?
 	return self._bbCFrame.Value
 end
 
@@ -98,7 +115,7 @@ end
 	Observes the size of the adornee
 	@return Observable<Vector3>
 ]=]
-function AdorneeBoundingBox:ObserveSize()
+function AdorneeBoundingBox:ObserveSize(): _Observable.Observable<Vector3>
 	return self._bbSize:Observe()
 end
 
@@ -106,11 +123,11 @@ end
 	Gets the size of the adornee
 	@return Vector3
 ]=]
-function AdorneeBoundingBox:GetSize()
+function AdorneeBoundingBox:GetSize(): Vector3
 	return self._bbSize.Value
 end
 
-function AdorneeBoundingBox:_setup(maid, adornee)
+function AdorneeBoundingBox:_setup(maid: Maid.Maid, adornee: Instance)
 	if adornee:IsA("BasePart") then
 		maid:GiveTask(self:_setupPart(adornee))
 	elseif adornee:IsA("Model") then
@@ -133,7 +150,7 @@ function AdorneeBoundingBox:_setup(maid, adornee)
 	end
 end
 
-function AdorneeBoundingBox:_setupTool(tool)
+function AdorneeBoundingBox:_setupTool(tool: Tool): Maid.Maid
 	assert(typeof(tool) == "Instance" and tool:IsA("Tool"), "Bad tool")
 
 	local topMaid = Maid.new()
@@ -153,7 +170,7 @@ function AdorneeBoundingBox:_setupTool(tool)
 	return topMaid
 end
 
-function AdorneeBoundingBox:_setupModel(model)
+function AdorneeBoundingBox:_setupModel(model: Model): Maid.Maid
 	assert(typeof(model) == "Instance" and model:IsA("Model"), "Bad model")
 
 	local topMaid = Maid.new()
@@ -169,20 +186,19 @@ function AdorneeBoundingBox:_setupModel(model)
 	return topMaid
 end
 
-function AdorneeBoundingBox:_setupHumanoid(humanoid: Humanoid)
+function AdorneeBoundingBox:_setupHumanoid(humanoid: Humanoid): Maid.Maid
 	assert(typeof(humanoid) == "Instance" and humanoid:IsA("Humanoid"), "Bad humanoid")
 
 	local topMaid = Maid.new()
 
-	topMaid:GiveTask(RxInstanceUtils.observePropertyBrio(humanoid, "Parent", function(parent)
-		return parent ~= nil and parent:IsA("Model")
+	topMaid:GiveTask(RxInstanceUtils.observePropertyBrio(humanoid, "Parent", function(parent: Instance)
+		return parent:IsA("Model")
 	end):Subscribe(function(brio)
 		if brio:IsDead() then
 			return
 		end
 
-		local maid = brio:ToMaid()
-		local model = brio:GetValue()
+		local maid, model = brio:ToMaidAndValue()
 
 		maid:GiveTask(self:_setupModel(model))
 	end))
@@ -190,7 +206,7 @@ function AdorneeBoundingBox:_setupHumanoid(humanoid: Humanoid)
 	return topMaid
 end
 
-function AdorneeBoundingBox:_setupAttachment(attachment)
+function AdorneeBoundingBox:_setupAttachment(attachment: Attachment): Maid.Maid
 	assert(typeof(attachment) == "Instance" and attachment:IsA("Attachment"), "Bad attachment")
 
 	local maid = Maid.new()
@@ -207,9 +223,9 @@ function AdorneeBoundingBox:_setupAttachment(attachment)
 						partCFrame = RxPartBoundingBoxUtils.observePartCFrame(parent),
 						attachmentCFrame = RxInstanceUtils.observeProperty(attachment, "CFrame"),
 					}):Pipe({
-						Rx.map(function(state)
+						Rx.map(function(state: any)
 							return state.partCFrame * state.attachmentCFrame
-						end),
+						end) :: any,
 					})
 				else
 					return Rx.of(nil)
@@ -224,7 +240,7 @@ function AdorneeBoundingBox:_setupAttachment(attachment)
 	return maid
 end
 
-function AdorneeBoundingBox:_setupPart(part)
+function AdorneeBoundingBox:_setupPart(part: BasePart): Maid.Maid
 	assert(typeof(part) == "Instance" and part:IsA("BasePart"), "Bad part")
 
 	local maid = Maid.new()

package/src/Shared/AdorneeModelBoundingBox.lua

@@ -12,12 +12,13 @@ local ObservableSet = require("ObservableSet")
 local Rx = require("Rx")
 local RxInstanceUtils = require("RxInstanceUtils")
 local ValueObject = require("ValueObject")
+local _Observable = require("Observable")
 
 local AdorneeModelBoundingBox = setmetatable({}, BaseObject)
 AdorneeModelBoundingBox.ClassName = "AdorneeModelBoundingBox"
 AdorneeModelBoundingBox.__index = AdorneeModelBoundingBox
 
-function AdorneeModelBoundingBox.new(model)
+function AdorneeModelBoundingBox.new(model: Model)
 	local self = setmetatable(BaseObject.new(model), AdorneeModelBoundingBox)
 
 	self._bbCFrame = self._maid:Add(ValueObject.new(nil))
@@ -41,33 +42,39 @@ function AdorneeModelBoundingBox.new(model)
 		self._isDirty.Value = true
 	end))
 
-	self._maid:GiveTask(self._isDirty:Observe():Pipe({
-		Rx.where(function(value)
-			return value
-		end);
-		Rx.throttleDefer();
-	}):Subscribe(function()
-		debug.profilebegin("modelboundingbox")
-		self._isDirty.Value = false
-
-		local bbCFrame, bbSize = self._obj:GetBoundingBox()
-		self._bbSize.Value = bbSize
-		self._bbCFrame.Value = bbCFrame
-		debug.profileend()
-	end))
-
-	self._maid:GiveTask(self._unanchoredPartsSet:ObserveCount():Pipe({
-		Rx.map(function(value)
-			return value > 0
-		end);
-		Rx.distinct();
-	}):Subscribe(function(hasUnanchoredParts)
-		if hasUnanchoredParts then
-			self._maid._current = self:_setupUnanchoredLoop()
-		else
-			self._maid._current = nil
-		end
-	end))
+	self._maid:GiveTask(self._isDirty
+		:Observe()
+		:Pipe({
+			Rx.where(function(value)
+				return value
+			end),
+			Rx.throttleDefer(),
+		})
+		:Subscribe(function()
+			debug.profilebegin("modelboundingbox")
+			self._isDirty.Value = false
+
+			local bbCFrame, bbSize = self._obj:GetBoundingBox()
+			self._bbSize.Value = bbSize
+			self._bbCFrame.Value = bbCFrame
+			debug.profileend()
+		end))
+
+	self._maid:GiveTask(self._unanchoredPartsSet
+		:ObserveCount()
+		:Pipe({
+			Rx.map(function(value)
+				return value > 0
+			end),
+			Rx.distinct(),
+		})
+		:Subscribe(function(hasUnanchoredParts)
+			if hasUnanchoredParts then
+				self._maid._current = self:_setupUnanchoredLoop()
+			else
+				self._maid._current = nil
+			end
+		end))
 
 	return self
 end
@@ -83,7 +90,7 @@ function AdorneeModelBoundingBox:_setupUnanchoredLoop()
 	return maid
 end
 
-function AdorneeModelBoundingBox:_handlePart(topMaid, part)
+function AdorneeModelBoundingBox:_handlePart(topMaid, part: BasePart)
 	topMaid:GiveTask(RxInstanceUtils.observePropertyBrio(part, "Anchored", function(isAnchored)
 		return not isAnchored
 	end):Subscribe(function(brio)
@@ -112,15 +119,15 @@ function AdorneeModelBoundingBox:_observeBasisChanged()
 			else
 				return RxInstanceUtils.observeProperty(self._obj, "WorldPivot")
 			end
-		end)
+		end),
 	})
 end
 
-function AdorneeModelBoundingBox:ObserveCFrame()
+function AdorneeModelBoundingBox:ObserveCFrame(): _Observable.Observable<CFrame>
 	return self._bbCFrame:Observe()
 end
 
-function AdorneeModelBoundingBox:ObserveSize()
+function AdorneeModelBoundingBox:ObserveSize(): _Observable.Observable<Vector3>
 	return self._bbSize:Observe()
 end
 

package/src/Shared/AdorneePartBoundingBox.lua

@@ -9,12 +9,13 @@ local RunService = game:GetService("RunService")
 local BaseObject = require("BaseObject")
 local ValueObject = require("ValueObject")
 local RxInstanceUtils = require("RxInstanceUtils")
+local _Observable = require("Observable")
 
 local AdorneePartBoundingBox = setmetatable({}, BaseObject)
 AdorneePartBoundingBox.ClassName = "AdorneePartBoundingBox"
 AdorneePartBoundingBox.__index = AdorneePartBoundingBox
 
-function AdorneePartBoundingBox.new(part)
+function AdorneePartBoundingBox.new(part: BasePart)
 	assert(typeof(part) == "Instance" and part:IsA("BasePart"), "Bad part")
 
 	local self = setmetatable(BaseObject.new(part), AdorneePartBoundingBox)
@@ -55,11 +56,11 @@ function AdorneePartBoundingBox:_setupUnanchoredLoop(maid)
 	end))
 end
 
-function AdorneePartBoundingBox:ObserveCFrame()
+function AdorneePartBoundingBox:ObserveCFrame(): _Observable.Observable<CFrame>
 	return self._bbCFrame:Observe()
 end
 
-function AdorneePartBoundingBox:ObserveSize()
+function AdorneePartBoundingBox:ObserveSize(): _Observable.Observable<Vector3>
 	return self._bbSize:Observe()
 end
 

package/src/Shared/RxPartBoundingBoxUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	@class RxPartBoundingBoxUtils
 ]=]
@@ -5,13 +6,14 @@
 local require = require(script.Parent.loader).load(script)
 
 local RxInstanceUtils = require("RxInstanceUtils")
+local _Observable = require("Observable")
 
 local RxPartBoundingBoxUtils = {}
 
-function RxPartBoundingBoxUtils.observePartCFrame(part)
+function RxPartBoundingBoxUtils.observePartCFrame(part: BasePart): _Observable.Observable<CFrame>
 	assert(typeof(part) == "Instance" and part:IsA("BasePart"), "Bad part")
 
-	return RxInstanceUtils.observeProperty(part, "CFrame")
+	return RxInstanceUtils.observeProperty(part, "CFrame") :: any
 end
 
 return RxPartBoundingBoxUtils