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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/brio",
-  "version": "14.17.0",
+  "version": "14.17.1",
   "description": "Brios wrap an object and either are alive or dead",
   "keywords": [
     "Roblox",
@@ -26,14 +26,14 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/loader": "^10.8.0",
-    "@quenty/maid": "^3.4.0",
-    "@quenty/rx": "^13.17.0",
-    "@quenty/signal": "^7.10.0",
-    "@quenty/steputils": "^3.5.3"
+    "@quenty/loader": "^10.8.1",
+    "@quenty/maid": "^3.4.1",
+    "@quenty/rx": "^13.17.1",
+    "@quenty/signal": "^7.10.1",
+    "@quenty/steputils": "^3.5.4"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e8ea56930e65322fcffc05a1556d5df988068f0b"
+  "gitHead": "78c3ac0ab08dd18085b6e6e6e4f745e76ed99f68"
 }

package/src/Shared/Brio.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Brios wrap a value (or tuple of values) and are used to convey the lifetime of that
 	object. The brio is better than a maid, by providing the following constraints:
@@ -59,11 +60,19 @@
 local require = require(script.Parent.loader).load(script)
 
 local Maid = require("Maid")
-local GoodSignal = require("GoodSignal")
+local Signal = require("Signal")
 
 local Brio = {}
-Brio.ClassName = "Brio"
 Brio.__index = Brio
+Brio.ClassName = "Brio"
+
+export type Brio<T...> = typeof(setmetatable(
+	{} :: {
+		n: number?,
+		_diedEvent: Signal.Signal<T...>,
+	},
+	Brio
+))
 
 --[=[
 	Returns whether a value is a Brio.
@@ -74,7 +83,7 @@ Brio.__index = Brio
 	@param value any
 	@return boolean
 ]=]
-function Brio.isBrio(value)
+function Brio.isBrio(value: any): boolean
 	return type(value) == "table" and value.ClassName == "Brio"
 end
 
@@ -89,8 +98,8 @@ end
 	@param ... any -- Brio values
 	@return Brio
 ]=]
-function Brio.new(...) -- Wrap
-	return setmetatable(table.pack(...), Brio)
+function Brio.new<T...>(...: T...): Brio<T...>
+	return setmetatable(table.pack(...) :: any, Brio)
 end
 
 --[=[
@@ -101,8 +110,8 @@ end
 	@param ... any -- Brio values
 	@return Brio
 ]=]
-function Brio.delayed(time, ...)
-	local brio = Brio.new(...)
+function Brio.delayed<T...>(time: number, ...: T...): Brio<T...>
+	local brio: Brio<T...> = Brio.new(...)
 	task.delay(time, function()
 		brio:Kill()
 	end)
@@ -129,7 +138,7 @@ end
 
 	@return Signal
 ]=]
-function Brio:GetDiedSignal()
+function Brio.GetDiedSignal<T...>(self: Brio<T...>): Signal.Signal<T...>
 	if self:IsDead() then
 		error("Brio is dead")
 	end
@@ -138,8 +147,9 @@ function Brio:GetDiedSignal()
 		return self._diedEvent
 	end
 
-	self._diedEvent = GoodSignal.new()
-	return self._diedEvent
+	local diedEvent = Signal.new()
+	self._diedEvent = diedEvent
+	return diedEvent
 end
 
 --[=[
@@ -156,7 +166,7 @@ end
 
 	@return boolean
 ]=]
-function Brio:IsDead()
+function Brio.IsDead<T...>(self: Brio<T...>): boolean
 	return self.n == nil
 end
 
@@ -167,7 +177,7 @@ end
 	brio.DEAD:ErrorIfDead() --> ERROR: [Brio.ErrorIfDead] - Brio is dead
 	```
 ]=]
-function Brio:ErrorIfDead()
+function Brio.ErrorIfDead<T...>(self: Brio<T...>)
 	if not self.n then
 		error("[Brio.ErrorIfDead] - Brio is dead")
 	end
@@ -192,7 +202,7 @@ end
 
 	@return Maid
 ]=]
-function Brio:ToMaid()
+function Brio.ToMaid<T...>(self: Brio<T...>): Maid.Maid
 	assert(self.n ~= nil, "Brio is dead")
 
 	local maid = Maid.new()
@@ -204,7 +214,7 @@ function Brio:ToMaid()
 	return maid
 end
 
-function Brio:ToMaidAndValue()
+function Brio.ToMaidAndValue<T...>(self: Brio<T...>): (any, T...)
 	return self:ToMaid(), self:GetValue()
 end
 
@@ -226,10 +236,10 @@ end
 
 	@return any
 ]=]
-function Brio:GetValue()
+function Brio.GetValue<T...>(self: Brio<T...>): T...
 	assert(self.n, "Brio is dead")
 
-	return unpack(self, 1, self.n)
+	return unpack(self :: any, 1, self.n)
 end
 
 --[=[
@@ -238,7 +248,7 @@ end
 	@since 3.6.0
 	@return { n: number, ... T }
 ]=]
-function Brio:GetPackedValues()
+function Brio.GetPackedValues<T...>(self: Brio<T...>)
 	assert(self.n, "Brio is dead")
 
 	return self
@@ -259,14 +269,14 @@ end
 	print(brio:GetValue()) --> ERROR: Brio is dead
 	```
 ]=]
-function Brio:Destroy()
+function Brio.Destroy<T...>(self: Brio<T...>)
 	if not self.n then
 		return
 	end
 
-	local diedEvent = self._diedEvent
+	local diedEvent: any = self._diedEvent
 
-	table.clear(self)
+	table.clear(self :: any)
 	table.freeze(self)
 
 	if diedEvent then

package/src/Shared/BrioUtils.lua

@@ -50,7 +50,7 @@ end
 ]=]
 function BrioUtils.aliveOnly(brios)
 	local alive = {}
-	for _, brio in pairs(brios) do
+	for _, brio in brios do
 		if not brio:IsDead() then
 			table.insert(alive, brio)
 		end
@@ -65,7 +65,7 @@ end
 	@return Brio<T>
 ]=]
 function BrioUtils.firstAlive(brios)
-	for _, brio in pairs(brios) do
+	for _, brio in brios do
 		if not brio:IsDead() then
 			return brio
 		end
@@ -84,7 +84,7 @@ function BrioUtils.flatten(brioTable)
 	local newValue = {}
 	local brios = {}
 
-	for key, brio in pairs(brioTable) do
+	for key, brio in brioTable do
 		if Brio.isBrio(brio) then
 			if brio:IsDead() then
 				return Brio.DEAD
@@ -109,7 +109,7 @@ end
 	@return Brio<U>
 ]=]
 function BrioUtils.first(brios, ...)
-	for _, brio in pairs(brios) do
+	for _, brio in brios do
 		if Brio.isBrio(brio) then
 			if brio:IsDead() then
 				return Brio.DEAD
@@ -120,7 +120,7 @@ function BrioUtils.first(brios, ...)
 	local maid = Maid.new()
 	local topBrio = Brio.new(...)
 
-	for _, brio in pairs(brios) do
+	for _, brio in brios do
 		if Brio.isBrio(brio) then
 			maid:GiveTask(brio:GetDiedSignal():Connect(function()
 				topBrio:Kill()

package/src/Shared/RxBrioUtils.lua

@@ -206,7 +206,7 @@ function RxBrioUtils.reduceToAliveList(selectFromBrio)
 				aliveBrios = BrioUtils.aliveOnly(aliveBrios)
 				local values = {}
 				if selectFromBrio then
-					for _, brio in pairs(aliveBrios) do
+					for _, brio in aliveBrios do
 						-- Hope for no side effects
 						local value = selectFromBrio(brio:GetValue())
 						assert(value ~= nil, "Bad value")
@@ -214,7 +214,7 @@ function RxBrioUtils.reduceToAliveList(selectFromBrio)
 						table.insert(values, value)
 					end
 				else
-					for _, brio in pairs(aliveBrios) do
+					for _, brio in aliveBrios do
 						local value = brio:GetValue()
 						assert(value ~= nil, "Bad value")
 
@@ -489,7 +489,7 @@ function RxBrioUtils.flatCombineLatest(observables)
 	assert(type(observables) == "table", "Bad observables")
 
 	local newObservables = {}
-	for key, observable in pairs(observables) do
+	for key, observable in observables do
 		if Observable.isObservable(observable) then
 			newObservables[key] = RxBrioUtils.flattenToValueAndNil(observable)
 		else
@@ -576,11 +576,11 @@ function RxBrioUtils.map(project)
 				table.insert(brios, (...))
 				args = (...):GetPackedValues()
 			else
-				args = {[1] = ...}
+				args = { [1] = ... }
 			end
 		else
 			args = {}
-			for index, item in pairs({...}) do
+			for index, item in { ... } do
 				if Brio.isBrio(item) then
 					table.insert(brios, item)
 					args[index] = item:GetValue() -- we lose data here, but I think this is fine
@@ -593,7 +593,7 @@ function RxBrioUtils.map(project)
 
 		local results = table.pack(project(table.unpack(args, 1, args.n)))
 		local transformedResults = {}
-		for i=1, results.n do
+		for i = 1, results.n do
 			local item = results[i]
 			if Brio.isBrio(item) then
 				table.insert(brios, item) -- add all subsequent brios into this table...
@@ -614,7 +614,7 @@ function RxBrioUtils._mapResult(brio)
 			return BrioUtils.withOtherValues(brio)
 		elseif n == 1 then
 			if Brio.isBrio(...) then
-				return BrioUtils.first({brio, (...)}, (...):GetValue())
+				return BrioUtils.first({ brio, (...) }, (...):GetValue())
 			else
 				return BrioUtils.withOtherValues(brio, ...)
 			end
@@ -622,7 +622,7 @@ function RxBrioUtils._mapResult(brio)
 			local brios = { brio }
 			local args = {}
 
-			for index, item in pairs({...}) do
+			for index, item in {...} do
 				if Brio.isBrio(item) then
 					table.insert(brios, item)
 					args[index] = item:GetValue() -- we lose data here, but I think this is fine
@@ -677,25 +677,29 @@ function RxBrioUtils.toEmitOnDeathObservable(brio, emitOnDeathValue)
 			if brio:IsDead() then
 				sub:Fire(emitOnDeathValue)
 				sub:Complete()
-			else
-				sub:Fire(brio:GetValue())
 
-				-- Firing killed the subscription
-				if not sub:IsPending() then
-					return
-				end
+				return nil
+			end
 
-				-- Firing this event actually killed the brio
-				if brio:IsDead() then
-					sub:Fire(emitOnDeathValue)
-					sub:Complete()
-				else
-					return brio:GetDiedSignal():Connect(function()
-						sub:Fire(emitOnDeathValue)
-						sub:Complete()
-					end)
-				end
+			sub:Fire(brio:GetValue())
+
+			-- Firing killed the subscription
+			if not sub:IsPending() then
+				return nil
+			end
+
+			-- Firing this event actually killed the brio
+			if brio:IsDead() then
+				sub:Fire(emitOnDeathValue)
+				sub:Complete()
+
+				return nil
 			end
+
+			return brio:GetDiedSignal():Connect(function()
+				sub:Fire(emitOnDeathValue)
+				sub:Complete()
+			end)
 		end)
 	end
 end
@@ -722,7 +726,7 @@ end
 function RxBrioUtils.emitOnDeath(emitOnDeathValue)
 	return Rx.switchMap(function(brio)
 		return RxBrioUtils.toEmitOnDeathObservable(brio, emitOnDeathValue)
-	end);
+	end)
 end
 
 --[=[