@quenty/binder 14.19.3 → 14.19.4-canary.11a5dcf.0

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.
 
+## [14.19.4-canary.11a5dcf.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/binder@14.19.3...@quenty/binder@14.19.4-canary.11a5dcf.0) (2025-05-10)
+
+
+### Bug Fixes
+
+* Additional type checking updates ([05ba29a](https://github.com/Quenty/NevermoreEngine/commit/05ba29a03efc9f3feed74b34f1d9dfb237496214))
+
+
+
+
+
 ## [14.19.3](https://github.com/Quenty/NevermoreEngine/compare/@quenty/binder@14.19.2...@quenty/binder@14.19.3) (2025-04-10)
 
 **Note:** Version bump only for package @quenty/binder

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/binder",
-  "version": "14.19.3",
+  "version": "14.19.4-canary.11a5dcf.0",
   "description": "Utility object to Bind a class to Roblox object, and associated helper methods",
   "keywords": [
     "Roblox",
@@ -25,19 +25,19 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/baseobject": "^10.8.3",
-    "@quenty/brio": "^14.17.3",
-    "@quenty/instanceutils": "^13.17.3",
-    "@quenty/linkutils": "^13.17.3",
-    "@quenty/loader": "^10.8.3",
-    "@quenty/maid": "^3.4.3",
-    "@quenty/promise": "^10.10.4",
-    "@quenty/rx": "^13.17.3",
-    "@quenty/signal": "^7.10.3",
-    "@quenty/valueobject": "^13.17.3"
+    "@quenty/baseobject": "10.8.4-canary.11a5dcf.0",
+    "@quenty/brio": "14.17.4-canary.11a5dcf.0",
+    "@quenty/instanceutils": "13.17.4-canary.11a5dcf.0",
+    "@quenty/linkutils": "13.17.4-canary.11a5dcf.0",
+    "@quenty/loader": "10.8.4-canary.11a5dcf.0",
+    "@quenty/maid": "3.4.4-canary.11a5dcf.0",
+    "@quenty/promise": "10.10.5-canary.11a5dcf.0",
+    "@quenty/rx": "13.17.4-canary.11a5dcf.0",
+    "@quenty/signal": "7.10.4-canary.11a5dcf.0",
+    "@quenty/valueobject": "13.17.4-canary.11a5dcf.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "b06c070ae91d5dab7bd8de6e290ad2caabb15d8f"
+  "gitHead": "11a5dcf7d4c7a0bfbf3337e97d30e8346ea09d3f"
 }

package/src/Shared/Binder.lua

@@ -27,16 +27,16 @@
 
 local require = require(script.Parent.loader).load(script)
 
-local RunService = game:GetService("RunService")
 local CollectionService = game:GetService("CollectionService")
+local RunService = game:GetService("RunService")
 
 local Brio = require("Brio")
+local CancelToken = require("CancelToken")
 local Maid = require("Maid")
 local MaidTaskUtils = require("MaidTaskUtils")
 local Observable = require("Observable")
 local Promise = require("Promise")
 local Signal = require("Signal")
-local _CancelToken = require("CancelToken")
 
 local Binder = {}
 Binder.__index = Binder
@@ -602,7 +602,7 @@ end
 	@param cancelToken CancelToken?
 	@return Promise<T>
 ]=]
-function Binder.Promise<T>(self: Binder<T>, inst: Instance, cancelToken: _CancelToken.CancelToken?): Promise.Promise<T>
+function Binder.Promise<T>(self: Binder<T>, inst: Instance, cancelToken: CancelToken.CancelToken?): Promise.Promise<T>
 	assert(typeof(inst) == "Instance", "Argument 'inst' is not an Instance")
 
 	local class = self:Get(inst)

package/src/Shared/BinderGroup.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Groups binders together into a list, and allows binders to be dynamically
 	added or removed.
@@ -18,6 +19,17 @@ local BinderGroup = {}
 BinderGroup.ClassName = "BinderGroup"
 BinderGroup.__index = BinderGroup
 
+export type BinderConstructorValidator = (constructor: Binder.BinderConstructor<any>) -> boolean
+
+export type BinderGroup = typeof(setmetatable(
+	{} :: {
+		_binders: { Binder.Binder<any> },
+		_bindersByTag: { [string]: Binder.Binder<any> },
+		_validateConstructor: BinderConstructorValidator?,
+		BinderAdded: Signal.Signal<Binder.Binder<any>>,
+	},
+	{} :: typeof({ __index = BinderGroup })
+))
 --[=[
 	Constructs a new BinderGroup
 
@@ -25,14 +37,14 @@ BinderGroup.__index = BinderGroup
 	@param validateConstructor (constructor: any) -> boolean -- Validates a binder matches T
 	@return BinderGroup<T>
 ]=]
-function BinderGroup.new(binders, validateConstructor)
-	local self = setmetatable({}, BinderGroup)
+function BinderGroup.new(binders: { Binder.Binder<any> }, validateConstructor: BinderConstructorValidator?): BinderGroup
+	local self: BinderGroup = setmetatable({} :: any, BinderGroup)
 
 	self._binders = {}
 	self._bindersByTag = {}
 	self._validateConstructor = validateConstructor
 
-	self.BinderAdded = Signal.new()
+	self.BinderAdded = Signal.new() :: any
 
 	self:AddList(binders)
 
@@ -44,13 +56,13 @@ end
 
 	@param binders { Binder<T> }
 ]=]
-function BinderGroup:AddList(binders: { any })
+function BinderGroup.AddList(self: BinderGroup, binders: { Binder.Binder<any> })
 	assert(type(binders) == "table", "Bad binders")
 
 	-- Assume to be using osyris's typechecking library,
 	-- we have an optional constructor to validate binder classes.
 	for _, binder in binders do
-		self:Add(binder)
+		self:Add(binder :: any)
 	end
 end
 
@@ -59,7 +71,7 @@ end
 
 	@param binder Binder<T>
 ]=]
-function BinderGroup:Add(binder)
+function BinderGroup.Add(self: BinderGroup, binder: Binder.Binder<any>)
 	assert(Binder.isBinder(binder), "Binder is not a binder")
 
 	if self._validateConstructor then
@@ -84,12 +96,12 @@ end
 	Do not modify the list of binders returned here
 	:::
 
-	@return { T }
+	@return { Binder.Binder<any> }
 ]=]
-function BinderGroup:GetBinders()
+function BinderGroup.GetBinders(self: BinderGroup): { Binder.Binder<any> }
 	assert(self._binders, "No self._binders")
 
 	return self._binders
 end
 
-return BinderGroup
+return BinderGroup

package/src/Shared/BinderGroupProvider.lua

@@ -96,4 +96,4 @@ function BinderGroupProvider:Destroy()
 	-- Do nothing
 end
 
-return BinderGroupProvider
+return BinderGroupProvider

package/src/Shared/BinderProvider.lua

@@ -5,8 +5,8 @@
 
 local require = require(script.Parent.loader).load(script)
 
-local Promise = require("Promise")
 local Maid = require("Maid")
+local Promise = require("Promise")
 
 local BinderProvider = {}
 BinderProvider.ClassName = "BinderProvider"
@@ -90,15 +90,14 @@ function BinderProvider:PromiseBinder(binderName)
 		end
 	end
 
-	return self._bindersAddedPromise
-		:Then(function()
-			local binder = self:Get(binderName)
-			if binder then
-				return binder
-			else
-				return Promise.rejected()
-			end
-		end)
+	return self._bindersAddedPromise:Then(function()
+		local binder = self:Get(binderName)
+		if binder then
+			return binder
+		else
+			return Promise.rejected()
+		end
+	end)
 end
 
 --[=[
@@ -209,4 +208,4 @@ function BinderProvider:Destroy()
 	self._binders = nil
 end
 
-return BinderProvider
+return BinderProvider

package/src/Shared/BinderProvider.spec.lua

@@ -2,7 +2,8 @@
 	@class BinderProvider.spec.lua
 ]]
 
-local require = require(game:GetService("ServerScriptService"):FindFirstChild("LoaderUtils", true).Parent).bootstrapStory(script)
+local require =
+	require(game:GetService("ServerScriptService"):FindFirstChild("LoaderUtils", true).Parent).bootstrapStory(script)
 
 local Binder = require("Binder")
 local BinderProvider = require("BinderProvider")
@@ -22,7 +23,7 @@ describe("BinderProvider.new()", function()
 			assert(arg == 12345, "Bad arg")
 
 			self:Add(Binder.new("Test", function()
-				return { Destroy = function() end; }
+				return { Destroy = function() end }
 			end))
 		end)
 
@@ -42,4 +43,4 @@ describe("BinderProvider.new()", function()
 	if provider then
 		provider:Destroy()
 	end
-end)
+end)

package/src/Shared/BinderUtils.lua

@@ -1,10 +1,15 @@
+--!strict
 --[=[
 	Utility methods for the binder object.
 	@class BinderUtils
 ]=]
 
+local require = require(script.Parent.loader).load(script)
+
 local CollectionService = game:GetService("CollectionService")
 
+local Binder = require("Binder")
+
 local BinderUtils = {}
 
 --[=[
@@ -15,7 +20,7 @@ local BinderUtils = {}
 	@param child Instance
 	@return T?
 ]=]
-function BinderUtils.findFirstAncestor(binder, child)
+function BinderUtils.findFirstAncestor<T>(binder: Binder.Binder<T>, child: Instance): T?
 	assert(type(binder) == "table", "Binder must be binder")
 	assert(typeof(child) == "Instance", "Child parameter must be instance")
 
@@ -38,7 +43,7 @@ end
 	@param parent Instance
 	@return T?
 ]=]
-function BinderUtils.findFirstChild(binder, parent)
+function BinderUtils.findFirstChild<T>(binder: Binder.Binder<T>, parent: Instance): T?
 	assert(type(binder) == "table", "Binder must be binder")
 	assert(typeof(parent) == "Instance", "Parent parameter must be instance")
 
@@ -59,7 +64,7 @@ end
 	@param parent Instance
 	@return {T}
 ]=]
-function BinderUtils.getChildren(binder, parent)
+function BinderUtils.getChildren<T>(binder: Binder.Binder<T>, parent: Instance): { T }
 	assert(type(binder) == "table", "Binder must be binder")
 	assert(typeof(parent) == "Instance", "Parent parameter must be instance")
 
@@ -82,13 +87,14 @@ end
 	@param bindersList { Binder<any> }
 	@return { [string]: Binder<any> }
 ]=]
-function BinderUtils.mapBinderListToTable(bindersList)
+function BinderUtils.mapBinderListToTable<T>(bindersList: { Binder.Binder<T> }): { [string]: Binder.Binder<T> }
 	assert(type(bindersList) == "table", "bindersList must be a table of binders")
 
-	local tags = {}
+	local tags: { [string]: Binder.Binder<T> } = {}
 	for _, binder in bindersList do
-		tags[binder:GetTag()] = binder
+		tags[(binder :: any):GetTag()] = binder :: any
 	end
+
 	return tags
 end
 
@@ -105,7 +111,7 @@ end
 	@param instanceList { Instance }
 	@return { T }
 ]=]
-function BinderUtils.getMappedFromList(tagsMap, instanceList)
+function BinderUtils.getMappedFromList<T>(tagsMap: { [string]: Binder.Binder<T> }, instanceList: { Instance }): { T }
 	local objects = {}
 
 	for _, instance in instanceList do
@@ -130,7 +136,7 @@ end
 	@param parent Instance
 	@return { T }
 ]=]
-function BinderUtils.getChildrenOfBinders(bindersList, parent)
+function BinderUtils.getChildrenOfBinders<T>(bindersList: { Binder.Binder<T> }, parent: Instance): { T }
 	assert(type(bindersList) == "table", "bindersList must be a table of binders")
 	assert(typeof(parent) == "Instance", "Parent parameter must be instance")
 
@@ -146,7 +152,7 @@ end
 	@param parent Instance
 	@return {T}
 ]=]
-function BinderUtils.getLinkedChildren(binder, linkName, parent)
+function BinderUtils.getLinkedChildren<T>(binder: Binder.Binder<T>, linkName: string, parent: Instance): { T }
 	local seen = {}
 	local objects = {}
 	for _, item in parent:GetChildren() do
@@ -177,7 +183,7 @@ end
 	@param parent Instance
 	@return {T}
 ]=]
-function BinderUtils.getDescendants(binder, parent)
+function BinderUtils.getDescendants<T>(binder: Binder.Binder<T>, parent: Instance): { T }
 	assert(type(binder) == "table", "Binder must be binder")
 	assert(typeof(parent) == "Instance", "Parent parameter must be instance")
 
@@ -191,5 +197,4 @@ function BinderUtils.getDescendants(binder, parent)
 	return objects
 end
 
-
-return BinderUtils
+return BinderUtils

package/src/Shared/Collection/BoundChildCollection.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Tracks child of type of a binder.
 	@class BoundChildCollection
@@ -6,37 +7,51 @@
 local require = require(script.Parent.loader).load(script)
 
 local BaseObject = require("BaseObject")
+local Binder = require("Binder")
+local Set = require("Set")
 local Signal = require("Signal")
 
 local BoundChildCollection = setmetatable({}, BaseObject)
 BoundChildCollection.ClassName = "BoundChildCollection"
 BoundChildCollection.__index = BoundChildCollection
 
+export type BoundChildCollection<T> = typeof(setmetatable(
+	{} :: {
+		_binder: Binder.Binder<T>,
+		_parent: Instance,
+		_classes: Set.Set<T>,
+		ClassAdded: Signal.Signal<T>,
+		ClassRemoved: Signal.Signal<T>,
+		_size: number,
+	},
+	{} :: typeof({ __index = BoundChildCollection })
+)) & BaseObject.BaseObject
+
 --[=[
 	Constructcs a new BoundChildCollection.
 	@param binder Binder<T>
 	@param parent Instance
 	@return BoundChildCollection<T>
 ]=]
-function BoundChildCollection.new(binder, parent: Instance)
-	local self = setmetatable(BaseObject.new(), BoundChildCollection)
+function BoundChildCollection.new<T>(binder: Binder.Binder<T>, parent: Instance): BoundChildCollection<T>
+	local self: BoundChildCollection<T> = setmetatable(BaseObject.new() :: any, BoundChildCollection)
 
 	self._binder = binder or error("No binder")
 	self._parent = parent or error("No parent")
 
---[=[
+	--[=[
 	Fires on class addition
 	@prop ClassAdded Signal<T>
 	@within BoundChildCollection
 ]=]
-	self.ClassAdded = self._maid:Add(Signal.new()) -- :Fire(class)
+	self.ClassAdded = self._maid:Add(Signal.new() :: any) -- :Fire(class)
 
---[=[
+	--[=[
 	Fires on class removal
 	@prop ClassRemoved Signal<T>
 	@within BoundChildCollection
 ]=]
-	self.ClassRemoved = self._maid:Add(Signal.new()) -- :Fire(class)
+	self.ClassRemoved = self._maid:Add(Signal.new() :: any) -- :Fire(class)
 
 	self._classes = {} -- [class] = true
 	self._size = 0
@@ -58,7 +73,7 @@ end
 	@param class T
 	@return boolean? -- true if the class exists, nil otherwise
 ]=]
-function BoundChildCollection:HasClass(class)
+function BoundChildCollection.HasClass<T>(self: BoundChildCollection<T>, class: T): boolean
 	return self._classes[class]
 end
 
@@ -66,7 +81,7 @@ end
 	Gets the size
 	@return number
 ]=]
-function BoundChildCollection:GetSize()
+function BoundChildCollection.GetSize<T>(self: BoundChildCollection<T>): number
 	return self._size
 end
 
@@ -79,7 +94,7 @@ end
 
 	@return { [T] = true } -- The set
 ]=]
-function BoundChildCollection:GetSet()
+function BoundChildCollection.GetSet<T>(self: BoundChildCollection<T>): Set.Set<T>
 	return self._classes
 end
 
@@ -87,7 +102,7 @@ end
 	Slow than :GetSet(), but adds them in an ordered list
 	@return { T }
 ]=]
-function BoundChildCollection:GetClasses()
+function BoundChildCollection.GetClasses<T>(self: BoundChildCollection<T>): { T }
 	local list = {}
 	for class, _ in self._classes do
 		table.insert(list, class)
@@ -95,7 +110,7 @@ function BoundChildCollection:GetClasses()
 	return list
 end
 
-function BoundChildCollection:_startTracking()
+function BoundChildCollection._startTracking<T>(self: BoundChildCollection<T>)
 	self._maid:GiveTask(self._parent.ChildAdded:Connect(function(child)
 		self:_addChild(child)
 	end))
@@ -110,7 +125,7 @@ function BoundChildCollection:_startTracking()
 	end
 end
 
-function BoundChildCollection:_addChild(inst, doNotFire)
+function BoundChildCollection._addChild<T>(self: BoundChildCollection<T>, inst: Instance, doNotFire: boolean?): ()
 	local class = self._binder:Get(inst)
 	if not class then
 		return
@@ -119,7 +134,7 @@ function BoundChildCollection:_addChild(inst, doNotFire)
 	self:_addClass(class, doNotFire)
 end
 
-function BoundChildCollection:_handleNewClassBound(class, inst)
+function BoundChildCollection._handleNewClassBound<T>(self: BoundChildCollection<T>, class: T, inst: Instance): ()
 	if inst.Parent ~= self._parent then
 		return
 	end
@@ -127,7 +142,7 @@ function BoundChildCollection:_handleNewClassBound(class, inst)
 	self:_addClass(class)
 end
 
-function BoundChildCollection:_removeChild(inst)
+function BoundChildCollection._removeChild<T>(self: BoundChildCollection<T>, inst: Instance): ()
 	local class = self._binder:Get(inst)
 	if not class then
 		return
@@ -136,7 +151,7 @@ function BoundChildCollection:_removeChild(inst)
 	self:_removeClass(class)
 end
 
-function BoundChildCollection:_addClass(class, doNotFire)
+function BoundChildCollection._addClass<T>(self: BoundChildCollection<T>, class: T, doNotFire: boolean?): ()
 	if self._classes[class] then
 		return
 	end
@@ -148,7 +163,7 @@ function BoundChildCollection:_addClass(class, doNotFire)
 	end
 end
 
-function BoundChildCollection:_removeClass(class)
+function BoundChildCollection._removeClass<T>(self: BoundChildCollection<T>, class: T): ()
 	if not self._classes[class] then
 		return
 	end
@@ -158,4 +173,4 @@ function BoundChildCollection:_removeClass(class)
 	self.ClassRemoved:Fire(class)
 end
 
-return BoundChildCollection
+return BoundChildCollection

package/src/Shared/Promise/promiseBoundClass.lua

@@ -7,8 +7,8 @@
 local require = require(script.Parent.loader).load(script)
 
 local Binder = require("Binder")
-local _Promise = require("Promise")
-local _CancelToken = require("CancelToken")
+local CancelToken = require("CancelToken")
+local Promise = require("Promise")
 
 --[=[
 	Returns a promise that resolves when the class is bound to the instance.
@@ -19,9 +19,9 @@ local _CancelToken = require("CancelToken")
 	@function promiseBoundClass
 	@within promiseBoundClass
 ]=]
-return function<T>(binder: Binder.Binder<T>, inst: Instance, cancelToken: _CancelToken.CancelToken?): _Promise.Promise<T>
+return function<T>(binder: Binder.Binder<T>, inst: Instance, cancelToken: CancelToken.CancelToken?): Promise.Promise<T>
 	assert(Binder.isBinder(binder), "'binder' must be table")
 	assert(typeof(inst) == "Instance", "'inst' must be instance")
 
 	return binder:Promise(inst, cancelToken)
-end
+end

package/src/Shared/Trackers/BoundAncestorTracker.lua

@@ -6,14 +6,13 @@
 local require = require(script.Parent.loader).load(script)
 
 local BaseObject = require("BaseObject")
-local ValueObject = require("ValueObject")
 local BinderUtils = require("BinderUtils")
+local ValueObject = require("ValueObject")
 
 local BoundAncestorTracker = setmetatable({}, BaseObject)
 BoundAncestorTracker.ClassName = "BoundAncestorTracker"
 BoundAncestorTracker.__index = BoundAncestorTracker
 
-
 --[=[
 Constructs a new BoundAncestorTracker
 
@@ -27,7 +26,7 @@ function BoundAncestorTracker.new(binder, child)
 	self._child = child or error("No child")
 	self._binder = binder or error("No binder")
 
---[=[
+	--[=[
 	@prop Class ValueObject<T>
 	@readonly
 	@within BoundAncestorTracker
@@ -68,4 +67,4 @@ function BoundAncestorTracker:_update()
 	self.Class.Value = BinderUtils.findFirstAncestor(self._binder, parent)
 end
 
-return BoundAncestorTracker
+return BoundAncestorTracker

package/src/Shared/Trackers/BoundParentTracker.lua

@@ -48,4 +48,4 @@ function BoundParentTracker:_update()
 	self.Class.Value = self._binder:Get(parent)
 end
 
-return BoundParentTracker
+return BoundParentTracker