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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/statestack",
-  "version": "14.18.0",
+  "version": "14.18.1",
   "description": "Stack of values that allows multiple systems to enable or disable a state",
   "keywords": [
     "Roblox",
@@ -25,15 +25,15 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/baseobject": "^10.8.0",
-    "@quenty/brio": "^14.17.0",
-    "@quenty/loader": "^10.8.0",
-    "@quenty/maid": "^3.4.0",
-    "@quenty/rx": "^13.17.0",
-    "@quenty/valueobject": "^13.17.0"
+    "@quenty/baseobject": "^10.8.1",
+    "@quenty/brio": "^14.17.1",
+    "@quenty/loader": "^10.8.1",
+    "@quenty/maid": "^3.4.1",
+    "@quenty/rx": "^13.17.1",
+    "@quenty/valueobject": "^13.17.1"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e8ea56930e65322fcffc05a1556d5df988068f0b"
+  "gitHead": "78c3ac0ab08dd18085b6e6e6e4f745e76ed99f68"
 }

package/src/Shared/RxStateStackUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	@class RxStateStackUtils
 ]=]
@@ -14,10 +15,10 @@ local RxStateStackUtils = {}
 --[=[
 	Converts the observable of Brios into a statestack.
 
-	@param defaultValue T | nil
+	@param defaultValue T?
 	@return (source: Observable<Brio<T>>) -> Observable<T?>
 ]=]
-function RxStateStackUtils.topOfStack(defaultValue)
+function RxStateStackUtils.topOfStack<T>(defaultValue: T?): Observable.Transformer<(Brio.Brio<T>), (T)>
 	return function(source)
 		return Observable.new(function(sub)
 			local maid = Maid.new()
@@ -42,8 +43,7 @@ function RxStateStackUtils.topOfStack(defaultValue)
 			update()
 
 			return maid
-		end)
-
+		end) :: any
 	end
 end
 
@@ -54,8 +54,8 @@ end
 	@param observable Observable<Brio<T>>
 	@return StateStack<T>
 ]=]
-function RxStateStackUtils.createStateStack(observable)
-	local stateStack = StateStack.new(nil)
+function RxStateStackUtils.createStateStack<T>(observable: Observable.Observable<Brio.Brio<T>>): StateStack.StateStack<T>
+	local stateStack: StateStack.StateStack<T> = StateStack.new(nil) :: any
 
 	stateStack._maid:GiveTask(observable:Subscribe(function(value)
 		assert(Brio.isBrio(value), "Observable must emit brio")

package/src/Shared/StateStack.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Stack of values that allows multiple systems to enable or disable a state.
 
@@ -25,74 +26,89 @@ local require = require(script.Parent.loader).load(script)
 
 local BaseObject = require("BaseObject")
 local ValueObject = require("ValueObject")
+local _Brio = require("Brio")
+local _Signal = require("Signal")
+local _Observable = require("Observable")
+local _Maid = require("Maid")
 
 local StateStack = setmetatable({}, BaseObject)
 StateStack.ClassName = "StateStack"
 StateStack.__index = StateStack
 
+export type StateStack<T> = typeof(setmetatable(
+	{} :: {
+		_maid: _Maid.Maid,
+		_state: ValueObject.ValueObject<T>,
+		_defaultValue: T,
+		_stateStack: { { T } },
+		Changed: _Signal.Signal<T>,
+	},
+	{ __index = StateStack }
+))
+
 --[=[
 	Constructs a new StateStack.
 	@param defaultValue any -- The default value to use for the statestack.
-	@param checkType string | nil
+	@param checkType string?
 	@return StateStack
 ]=]
-function StateStack.new(defaultValue, checkType)
-	local self = setmetatable(BaseObject.new(), StateStack)
+function StateStack.new<T>(defaultValue: T, checkType): StateStack<T>
+	local self = setmetatable(BaseObject.new() :: any, StateStack)
 
 	self._state = self._maid:Add(ValueObject.new(defaultValue, checkType))
 	self._defaultValue = defaultValue
 	self._stateStack = {}
 
---[=[
+	--[=[
 	Fires with the new state
 	@prop Changed Signal<T>
 	@within StateStack
 ]=]
 	self.Changed = self._state.Changed
 
-	return self
+	return self :: StateStack<T>
 end
 
 --[=[
 	Gets the count of the stack
 	@return number
 ]=]
-function StateStack:GetCount()
+function StateStack.GetCount<T>(self: StateStack<T>): number
 	return #self._stateStack
 end
 
 --[=[
 	Gets the current state
-	@return T?
+	@return T
 ]=]
-function StateStack:GetState()
+function StateStack.GetState<T>(self: StateStack<T>): T
 	return self._state.Value
 end
 
 --[=[
 	Observes the current value of stack
-	@return Observable<T?>
+	@return Observable<T>
 ]=]
-function StateStack:Observe()
+function StateStack.Observe<T>(self: StateStack<T>): _Observable.Observable<T>
 	return self._state:Observe()
 end
 
 --[=[
 	Observes the current value of stack
 	@param predicate function
-	@return Observable<T?>
+	@return Observable<T>
 ]=]
-function StateStack:ObserveBrio(predicate)
+function StateStack.ObserveBrio<T>(self: StateStack<T>, predicate): _Observable.Observable<_Brio.Brio<T>>
 	return self._state:ObserveBrio(predicate)
 end
 
 --[=[
 	Pushes the current state onto the stack
-	@param state T?
+	@param state T
 	@return function -- Cleanup function to invoke
 ]=]
-function StateStack:PushState(state)
-	local data = { state }
+function StateStack.PushState<T>(self: StateStack<T>, state: T): (() -> ())?
+	local data: { T } = { state }
 	table.insert(self._stateStack, data)
 	self:_updateState()
 
@@ -109,9 +125,9 @@ end
 	@param brio Brio
 	@return function -- Cleanup function
 ]=]
-function StateStack:PushBrio(brio)
+function StateStack.PushBrio<T>(self: StateStack<T>, brio: _Brio.Brio<T>): (() -> ())?
 	if brio:IsDead() then
-		return
+		return nil
 	end
 
 	local maid, state = brio:ToMaidAndValue()
@@ -128,7 +144,7 @@ function StateStack:PushBrio(brio)
 	end
 end
 
-function StateStack:_popState(data)
+function StateStack._popState<T>(self: StateStack<T>, data: { T })
 	local index = table.find(self._stateStack, data)
 	if index then
 		table.remove(self._stateStack, index)
@@ -138,7 +154,7 @@ function StateStack:_popState(data)
 	end
 end
 
-function StateStack:_updateState()
+function StateStack._updateState<T>(self: StateStack<T>)
 	local dataContainer = self._stateStack[#self._stateStack]
 	if dataContainer == nil then
 		self._state.Value = self._defaultValue