@quenty/linkutils 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/linkutils@13.17.0...@quenty/linkutils@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/linkutils@13.16.2...@quenty/linkutils@13.17.0) (2025-04-02)
 
 **Note:** Version bump only for package @quenty/linkutils

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/linkutils",
-  "version": "13.17.0",
+  "version": "13.17.1",
   "description": "Utility functions for links. Links are object values pointing to other values!",
   "keywords": [
     "Roblox",
@@ -25,15 +25,15 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/brio": "^14.17.0",
-    "@quenty/instanceutils": "^13.17.0",
-    "@quenty/loader": "^10.8.0",
-    "@quenty/maid": "^3.4.0",
-    "@quenty/promise": "^10.10.1",
-    "@quenty/rx": "^13.17.0"
+    "@quenty/brio": "^14.17.1",
+    "@quenty/instanceutils": "^13.17.1",
+    "@quenty/loader": "^10.8.1",
+    "@quenty/maid": "^3.4.1",
+    "@quenty/promise": "^10.10.2",
+    "@quenty/rx": "^13.17.1"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e8ea56930e65322fcffc05a1556d5df988068f0b"
+  "gitHead": "78c3ac0ab08dd18085b6e6e6e4f745e76ed99f68"
 }

package/src/Shared/LinkUtils.lua

@@ -17,7 +17,7 @@ local LinkUtils = {}
 	@param to Instance
 	@return ObjectValue
 ]=]
-function LinkUtils.createLink(linkName, from, to)
+function LinkUtils.createLink(linkName: string, from: Instance, to: Instance): ObjectValue
 	assert(type(linkName) == "string", "Bad linkName")
 	assert(typeof(from) == "Instance", "Bad from")
 	assert(typeof(to) == "Instance", "Bad to")
@@ -37,13 +37,13 @@ end
 	@param from Instance
 	@return { Instance }
 ]=]
-function LinkUtils.getAllLinkValues(linkName, from)
+function LinkUtils.getAllLinkValues(linkName: string, from: Instance): { ObjectValue }
 	assert(type(linkName) == "string", "Bad linkName")
 	assert(typeof(from) == "Instance", "Bad from")
 
 	local linkValues = {}
 
-	for _, item in pairs(from:GetChildren()) do
+	for _, item in from:GetChildren() do
 		if item:IsA("ObjectValue") and item.Name == linkName then
 			local value = item.Value
 			if value then
@@ -55,7 +55,6 @@ function LinkUtils.getAllLinkValues(linkName, from)
 	return linkValues
 end
 
-
 --[=[
 	Ensures after operation a single link is pointed to the value, unless the value is "nil"
 	in which case no link will be set
@@ -63,16 +62,16 @@ end
 	@param linkName string
 	@param from Instance
 	@param to Instance
-	@return Instance | nil
+	@return Instance?
 ]=]
-function LinkUtils.setSingleLinkValue(linkName, from, to)
+function LinkUtils.setSingleLinkValue(linkName: string, from: Instance, to: Instance): ObjectValue?
 	assert(type(linkName) == "string", "Bad linkName")
 	assert(typeof(from) == "Instance", "Bad from")
 	assert(typeof(to) == "Instance" or to == nil, "Bad to")
 
 	if to then
 		local existingLink = nil
-		for _, link in pairs(from:GetChildren()) do
+		for _, link in from:GetChildren() do
 			if link:IsA("ObjectValue") and link.Name == linkName then
 				if existingLink then
 					link:Destroy()
@@ -89,7 +88,7 @@ function LinkUtils.setSingleLinkValue(linkName, from, to)
 
 		return LinkUtils.createLink(linkName, from, to)
 	else
-		for _, link in pairs(from:GetChildren()) do
+		for _, link in from:GetChildren() do
 			if link:IsA("ObjectValue") and link.Name == linkName then
 				link:Destroy()
 			end
@@ -99,19 +98,18 @@ function LinkUtils.setSingleLinkValue(linkName, from, to)
 	end
 end
 
-
 --[=[
 	Gets all links underneath an instance.
 	@param linkName string
 	@param from Instance
 	@return { ObjectValue }
 ]=]
-function LinkUtils.getAllLinks(linkName, from)
+function LinkUtils.getAllLinks(linkName: string, from: Instance): { ObjectValue }
 	assert(type(linkName) == "string", "Bad linkName")
 	assert(typeof(from) == "Instance", "Bad from")
 
 	local links = {}
-	for _, item in pairs(from:GetChildren()) do
+	for _, item in from:GetChildren() do
 		if item:IsA("ObjectValue") and item.Name == linkName then
 			table.insert(links, item)
 		end
@@ -124,9 +122,9 @@ end
 	Gets the first links value
 	@param linkName string
 	@param from Instance
-	@return { Instance }
+	@return Instance
 ]=]
-function LinkUtils.getLinkValue(linkName, from)
+function LinkUtils.getLinkValue(linkName: string, from: Instance): Instance?
 	assert(type(linkName) == "string", "Bad linkName")
 	assert(typeof(from) == "Instance", "Bad from")
 
@@ -136,7 +134,13 @@ function LinkUtils.getLinkValue(linkName, from)
 	end
 
 	if not objectValue:IsA("ObjectValue") then
-		warn(string.format("[LinkUtils.getLinkValue] - Bad link %q not an object value, from %q", objectValue:GetFullName(), from:GetFullName()))
+		warn(
+			string.format(
+				"[LinkUtils.getLinkValue] - Bad link %q not an object value, from %q",
+				objectValue:GetFullName(),
+				from:GetFullName()
+			)
+		)
 		return nil
 	end
 
@@ -150,7 +154,7 @@ end
 	@param from Instance
 	@return Promise<Instance>
 ]=]
-function LinkUtils.promiseLinkValue(maid, linkName, from)
+function LinkUtils.promiseLinkValue(maid, linkName: string, from: Instance)
 	assert(maid, "Bad maid")
 	assert(type(linkName) == "string", "Bad linkName")
 	assert(typeof(from) == "Instance", "Bad from")
@@ -158,7 +162,7 @@ function LinkUtils.promiseLinkValue(maid, linkName, from)
 	local childPromise = promiseChild(from, linkName)
 	maid:GiveTask(childPromise)
 
-	return childPromise:Then(function(objectValue)
+	return childPromise:Then(function(objectValue: ObjectValue)
 		local promise = promisePropertyValue(objectValue, "Value")
 		maid:GiveTask(promise)
 

package/src/Shared/RxLinkUtils.lua

@@ -14,21 +14,20 @@ local RxInstanceUtils = require("RxInstanceUtils")
 local RxLinkUtils = {}
 
 -- Emits valid links in format Brio.new(link, linkValue)
-function RxLinkUtils.observeValidLinksBrio(linkName, parent)
+function RxLinkUtils.observeValidLinksBrio(linkName: string, parent: Instance)
 	assert(type(linkName) == "string", "linkName should be 'string'")
 	assert(typeof(parent) == "Instance", "parent should be 'Instance'")
 
-	return RxInstanceUtils.observeChildrenBrio(parent)
-		:Pipe({
-			Rx.flatMap(function(brio)
-				local instance = brio:GetValue()
-				if not instance:IsA("ObjectValue") then
-					return Rx.EMPTY
-				end
-
-				return RxBrioUtils.completeOnDeath(brio, RxLinkUtils.observeValidityBrio(linkName, instance))
-			end);
-		})
+	return RxInstanceUtils.observeChildrenBrio(parent):Pipe({
+		Rx.flatMap(function(brio)
+			local instance: Instance = brio:GetValue()
+			if not instance:IsA("ObjectValue") then
+				return Rx.EMPTY
+			end
+
+			return RxBrioUtils.completeOnDeath(brio, RxLinkUtils.observeValidityBrio(linkName, instance))
+		end),
+	})
 end
 
 --[=[
@@ -38,23 +37,22 @@ end
 	@param parent Instance
 	@return Brio<Instance>
 ]=]
-function RxLinkUtils.observeLinkValueBrio(linkName, parent)
+function RxLinkUtils.observeLinkValueBrio(linkName: string, parent: Instance)
 	assert(type(linkName) == "string", "linkName should be 'string'")
 	assert(typeof(parent) == "Instance", "parent should be 'Instance'")
 
-	return RxInstanceUtils.observeChildrenOfNameBrio(parent, "ObjectValue", linkName)
-		:Pipe({
-			RxBrioUtils.flatMapBrio(function(instance)
-				return RxInstanceUtils.observePropertyBrio(instance, "Value", function(value)
-					return value ~= nil
-				end)
+	return RxInstanceUtils.observeChildrenOfNameBrio(parent, "ObjectValue", linkName):Pipe({
+		RxBrioUtils.flatMapBrio(function(instance)
+			return RxInstanceUtils.observePropertyBrio(instance, "Value", function(value: Instance?)
+				return value ~= nil
 			end)
-		})
+		end),
+	})
 end
 
 -- Fires off everytime the link is reconfigured into a valid link
 -- Fires with link, linkValue
-function RxLinkUtils.observeValidityBrio(linkName, link)
+function RxLinkUtils.observeValidityBrio(linkName: string, link: Instance)
 	assert(typeof(link) == "Instance" and link:IsA("ObjectValue"), "Bad link")
 	assert(type(linkName) == "string", "Bad linkName")
 
@@ -72,15 +70,12 @@ function RxLinkUtils.observeValidityBrio(linkName, link)
 			sub:Fire(newValid)
 		end
 
-		maid:GiveTask(link:GetPropertyChangedSignal("Value")
-			:Connect(updateValidity))
-		maid:GiveTask(link:GetPropertyChangedSignal("Name")
-			:Connect(updateValidity))
+		maid:GiveTask(link:GetPropertyChangedSignal("Value"):Connect(updateValidity))
+		maid:GiveTask(link:GetPropertyChangedSignal("Name"):Connect(updateValidity))
 		updateValidity()
 
 		return maid
 	end)
 end
 
-
-return RxLinkUtils
+return RxLinkUtils