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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/instanceutils",
-  "version": "13.17.0",
+  "version": "13.17.1",
   "description": "Utility functions involving instances in Roblox",
   "keywords": [
     "Roblox",
@@ -26,14 +26,14 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/brio": "^14.17.0",
-    "@quenty/loader": "^10.8.0",
-    "@quenty/maid": "^3.4.0",
-    "@quenty/rx": "^13.17.0",
-    "@quenty/symbol": "^3.4.0"
+    "@quenty/brio": "^14.17.1",
+    "@quenty/loader": "^10.8.1",
+    "@quenty/maid": "^3.4.1",
+    "@quenty/rx": "^13.17.1",
+    "@quenty/symbol": "^3.4.1"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e8ea56930e65322fcffc05a1556d5df988068f0b"
+  "gitHead": "78c3ac0ab08dd18085b6e6e6e4f745e76ed99f68"
 }

package/src/Shared/RxInstanceUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Utility functions to observe the state of Roblox. This is a very powerful way to query
 	Roblox's state.
@@ -29,15 +30,15 @@ local RxInstanceUtils = {}
 	@param propertyName string
 	@return Observable<T>
 ]=]
-function RxInstanceUtils.observeProperty(instance: Instance, propertyName: string)
+function RxInstanceUtils.observeProperty(instance: Instance, propertyName: string): Observable.Observable<any>
 	assert(typeof(instance) == "Instance", "'instance' should be of type Instance")
 	assert(type(propertyName) == "string", "'propertyName' should be of type string")
 
 	return Observable.new(function(sub)
 		local connection = instance:GetPropertyChangedSignal(propertyName):Connect(function()
-			sub:Fire(instance[propertyName], instance)
+			sub:Fire((instance :: any)[propertyName], instance)
 		end)
-		sub:Fire(instance[propertyName], instance)
+		sub:Fire((instance :: any)[propertyName], instance)
 
 		return connection
 	end)
@@ -49,12 +50,12 @@ end
 	@param instance Instance
 	@return Observable<Instance>
 ]=]
-function RxInstanceUtils.observeAncestry(instance: Instance)
+function RxInstanceUtils.observeAncestry(instance: Instance): Observable.Observable<Instance>
 	local startWithParent = Rx.start(function()
 		return instance, instance.Parent
 	end)
 
-	return startWithParent(Rx.fromSignal(instance.AncestryChanged))
+	return startWithParent(Rx.fromSignal(instance.AncestryChanged)) :: any
 end
 
 --[=[
@@ -64,14 +65,17 @@ end
 	@param className string
 	@return Observable<Brio<Instance>>
 ]=]
-function RxInstanceUtils.observeFirstAncestorBrio(instance: Instance, className: string)
+function RxInstanceUtils.observeFirstAncestorBrio(
+	instance: Instance,
+	className: string
+): Observable.Observable<Brio.Brio<Instance>>
 	assert(typeof(instance) == "Instance", "Bad instance")
 	assert(type(className) == "string", "Bad className")
 
 	return Observable.new(function(sub)
 		local maid = Maid.new()
 
-		local lastFound = nil
+		local lastFound: Instance? = nil
 		local function handleAncestryChanged()
 			local found = instance:FindFirstAncestorWhichIsA(className)
 
@@ -92,7 +96,7 @@ function RxInstanceUtils.observeFirstAncestorBrio(instance: Instance, className:
 		handleAncestryChanged()
 
 		return maid
-	end)
+	end) :: any
 end
 
 --[=[
@@ -102,10 +106,10 @@ end
 	@param instance Instance
 	@return Observable<Brio<Instance>>
 ]=]
-function RxInstanceUtils.observeParentBrio(instance: Instance)
+function RxInstanceUtils.observeParentBrio(instance: Instance): Observable.Observable<Brio.Brio<Instance>>
 	return RxInstanceUtils.observePropertyBrio(instance, "Parent", function(parent)
 		return parent ~= nil
-	end)
+	end) :: any
 end
 
 --[=[
@@ -115,7 +119,7 @@ end
 	@param className string
 	@return Observable<Instance?>
 ]=]
-function RxInstanceUtils.observeFirstAncestor(instance: Instance, className: string)
+function RxInstanceUtils.observeFirstAncestor(instance: Instance, className: string): Observable.Observable<Instance?>
 	assert(typeof(instance) == "Instance", "Bad instance")
 	assert(type(className) == "string", "Bad className")
 
@@ -136,8 +140,6 @@ function RxInstanceUtils.observeFirstAncestor(instance: Instance, className: str
 	end)
 end
 
-export type Predicate = (value: Instance) -> boolean
-
 --[=[
 	Returns a brio of the property value
 
@@ -146,7 +148,11 @@ export type Predicate = (value: Instance) -> boolean
 	@param predicate ((value: T) -> boolean)? -- Optional filter
 	@return Observable<Brio<T>>
 ]=]
-function RxInstanceUtils.observePropertyBrio(instance: Instance, propertyName: string, predicate: Predicate?)
+function RxInstanceUtils.observePropertyBrio(
+	instance: Instance,
+	propertyName: string,
+	predicate: Rx.Predicate<any>?
+): Observable.Observable<Brio.Brio<any>>
 	assert(typeof(instance) == "Instance", "Bad instance")
 	assert(type(propertyName) == "string", "Bad propertyName")
 	assert(type(predicate) == "function" or predicate == nil, "Bad predicate")
@@ -156,7 +162,7 @@ function RxInstanceUtils.observePropertyBrio(instance: Instance, propertyName: s
 		local lastValue = UNSET_VALUE
 
 		local function handlePropertyChanged()
-			local propertyValue = instance[propertyName]
+			local propertyValue = (instance :: any)[propertyName]
 
 			-- Deferred events can cause multiple values to be queued at once
 			-- but we operate at this post-deferred layer, so lets only output
@@ -165,7 +171,7 @@ function RxInstanceUtils.observePropertyBrio(instance: Instance, propertyName: s
 				lastValue = propertyValue
 
 				if not predicate or predicate(propertyValue) then
-					local brio = Brio.new(instance[propertyName])
+					local brio = Brio.new((instance :: any)[propertyName])
 
 					maid._lastBrio = brio
 
@@ -183,7 +189,7 @@ function RxInstanceUtils.observePropertyBrio(instance: Instance, propertyName: s
 		handlePropertyChanged()
 
 		return maid
-	end)
+	end) :: any
 end
 
 --[=[
@@ -194,7 +200,11 @@ end
 	@param name string
 	@return Observable<Brio<Instance>>
 ]=]
-function RxInstanceUtils.observeLastNamedChildBrio(parent: Instance, className: string, name: string)
+function RxInstanceUtils.observeLastNamedChildBrio(
+	parent: Instance,
+	className: string,
+	name: string
+): Observable.Observable<Brio.Brio<Instance>>
 	assert(typeof(parent) == "Instance", "Bad parent")
 	assert(type(className) == "string", "Bad className")
 	assert(type(name) == "string", "Bad name")
@@ -202,7 +212,7 @@ function RxInstanceUtils.observeLastNamedChildBrio(parent: Instance, className:
 	return Observable.new(function(sub)
 		local topMaid = Maid.new()
 
-		local function handleChild(child)
+		local function handleChild(child: Instance)
 			if not child:IsA(className) then
 				return
 			end
@@ -232,12 +242,12 @@ function RxInstanceUtils.observeLastNamedChildBrio(parent: Instance, className:
 			topMaid[child] = nil
 		end))
 
-		for _, child in pairs(parent:GetChildren()) do
+		for _, child in parent:GetChildren() do
 			handleChild(child)
 		end
 
 		return topMaid
-	end)
+	end) :: any
 end
 
 --[=[
@@ -248,7 +258,11 @@ end
 	@param name string
 	@return Observable<Brio<Instance>>
 ]=]
-function RxInstanceUtils.observeChildrenOfNameBrio(parent: Instance, className: string, name: string)
+function RxInstanceUtils.observeChildrenOfNameBrio(
+	parent: Instance,
+	className: string,
+	name: string
+): Observable.Observable<Brio.Brio<Instance>>
 	assert(typeof(parent) == "Instance", "Bad parent")
 	assert(type(className) == "string", "Bad className")
 	assert(type(name) == "string", "Bad name")
@@ -256,7 +270,7 @@ function RxInstanceUtils.observeChildrenOfNameBrio(parent: Instance, className:
 	return Observable.new(function(sub)
 		local topMaid = Maid.new()
 
-		local function handleChild(child)
+		local function handleChild(child: Instance)
 			if not child:IsA(className) then
 				return
 			end
@@ -285,12 +299,12 @@ function RxInstanceUtils.observeChildrenOfNameBrio(parent: Instance, className:
 			topMaid[child] = nil
 		end))
 
-		for _, child in pairs(parent:GetChildren()) do
+		for _, child in parent:GetChildren() do
 			handleChild(child)
 		end
 
 		return topMaid
-	end)
+	end) :: any
 end
 
 --[=[
@@ -298,9 +312,12 @@ end
 
 	@param parent Instance
 	@param className string
-	@return Observable<Instance>
+	@return Observable<Brio<Instance>>
 ]=]
-function RxInstanceUtils.observeChildrenOfClassBrio(parent: Instance, className: string)
+function RxInstanceUtils.observeChildrenOfClassBrio(
+	parent: Instance,
+	className: string
+): Observable.Observable<Brio.Brio<Instance>>
 	assert(typeof(parent) == "Instance", "Bad parent")
 	assert(type(className) == "string", "Bad className")
 
@@ -316,14 +333,17 @@ end
 	@param predicate ((value: Instance) -> boolean)? -- Optional filter
 	@return Observable<Brio<Instance>>
 ]=]
-function RxInstanceUtils.observeChildrenBrio(parent: Instance, predicate: Predicate?)
+function RxInstanceUtils.observeChildrenBrio(
+	parent: Instance,
+	predicate: Rx.Predicate<Instance>?
+): Observable.Observable<Brio.Brio<Instance>>
 	assert(typeof(parent) == "Instance", "Bad parent")
 	assert(type(predicate) == "function" or predicate == nil, "Bad predicate")
 
 	return Observable.new(function(sub)
 		local maid = Maid.new()
 
-		local function handleChild(child)
+		local function handleChild(child: Instance)
 			if not predicate or predicate(child) then
 				local value = Brio.new(child)
 				maid[child] = value
@@ -336,12 +356,12 @@ function RxInstanceUtils.observeChildrenBrio(parent: Instance, predicate: Predic
 			maid[child] = nil
 		end))
 
-		for _, child in pairs(parent:GetChildren()) do
+		for _, child in parent:GetChildren() do
 			handleChild(child)
 		end
 
 		return maid
-	end)
+	end) :: any
 end
 
 --[=[
@@ -351,7 +371,10 @@ end
 	@param predicate ((value: Instance) -> boolean)? -- Optional filter
 	@return Observable<Instance, boolean>
 ]=]
-function RxInstanceUtils.observeDescendants(parent: Instance, predicate: Predicate?)
+function RxInstanceUtils.observeDescendants(
+	parent: Instance,
+	predicate: Rx.Predicate<Instance>?
+): Observable.Observable<Instance, boolean>
 	assert(typeof(parent) == "Instance", "Bad parent")
 	assert(type(predicate) == "function" or predicate == nil, "Bad predicate")
 
@@ -374,12 +397,12 @@ function RxInstanceUtils.observeDescendants(parent: Instance, predicate: Predica
 			end
 		end))
 
-		for _, descendant in pairs(parent:GetDescendants()) do
+		for _, descendant in parent:GetDescendants() do
 			handleDescendant(descendant)
 		end
 
 		return maid
-	end)
+	end) :: any
 end
 
 --[=[
@@ -389,7 +412,10 @@ end
 	@param predicate ((value: Instance) -> boolean)? -- Optional filter
 	@return Observable<Brio<Instance>>
 ]=]
-function RxInstanceUtils.observeDescendantsBrio(parent: Instance, predicate: Predicate?)
+function RxInstanceUtils.observeDescendantsBrio(
+	parent: Instance,
+	predicate: Rx.Predicate<Instance>?
+): Observable.Observable<Brio.Brio<Instance>>
 	assert(typeof(parent) == "Instance", "Bad parent")
 	assert(type(predicate) == "function" or predicate == nil, "Bad predicate")
 
@@ -409,12 +435,12 @@ function RxInstanceUtils.observeDescendantsBrio(parent: Instance, predicate: Pre
 			maid[descendant] = nil
 		end))
 
-		for _, descendant in pairs(parent:GetDescendants()) do
+		for _, descendant in parent:GetDescendants() do
 			handleDescendant(descendant)
 		end
 
 		return maid
-	end)
+	end) :: any
 end
 
 --[=[
@@ -424,11 +450,11 @@ end
 	@param className string
 	@return Observable<Instance>
 ]=]
-function RxInstanceUtils.observeDescendantsOfClassBrio(parent: Instance, className: string)
+function RxInstanceUtils.observeDescendantsOfClassBrio(parent: Instance, className: string): Observable.Observable<Brio.Brio<Instance>>
 	assert(typeof(parent) == "Instance", "Bad parent")
 	assert(type(className) == "string", "Bad className")
 
-	return RxInstanceUtils.observeDescendantsBrio(parent, function(child)
+	return RxInstanceUtils.observeDescendantsBrio(parent, function(child: Instance)
 		return child:IsA(className)
 	end)
 end