@quenty/transitionmodel 7.19.0 → 7.19.1-canary.545.2374fb2.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.
 
+## [7.19.1-canary.545.2374fb2.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/transitionmodel@7.19.0...@quenty/transitionmodel@7.19.1-canary.545.2374fb2.0) (2025-04-05)
+
+
+### Bug Fixes
+
+* Add types to packages ([2374fb2](https://github.com/Quenty/NevermoreEngine/commit/2374fb2b043cfbe0e9b507b3316eec46a4e353a0))
+
+
+
+
+
 # [7.19.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/transitionmodel@7.18.2...@quenty/transitionmodel@7.19.0) (2025-04-02)
 
 **Note:** Version bump only for package @quenty/transitionmodel

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/transitionmodel",
-  "version": "7.19.0",
+  "version": "7.19.1-canary.545.2374fb2.0",
   "description": "Helps with Gui visiblity showing and hiding",
   "keywords": [
     "Roblox",
@@ -25,22 +25,22 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/baseobject": "^10.8.0",
-    "@quenty/basicpane": "^13.17.0",
-    "@quenty/blend": "^12.18.0",
-    "@quenty/ducktype": "^5.8.1",
-    "@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/signal": "^7.10.0",
-    "@quenty/spring": "^10.8.1",
-    "@quenty/timedtween": "^7.18.0",
-    "@quenty/valueobject": "^13.17.0"
+    "@quenty/baseobject": "10.8.1-canary.545.2374fb2.0",
+    "@quenty/basicpane": "13.17.1-canary.545.2374fb2.0",
+    "@quenty/blend": "12.18.1-canary.545.2374fb2.0",
+    "@quenty/ducktype": "5.8.2-canary.545.2374fb2.0",
+    "@quenty/instanceutils": "13.17.1-canary.545.2374fb2.0",
+    "@quenty/loader": "10.8.1-canary.545.2374fb2.0",
+    "@quenty/maid": "3.4.1-canary.545.2374fb2.0",
+    "@quenty/promise": "10.10.2-canary.545.2374fb2.0",
+    "@quenty/rx": "13.17.1-canary.545.2374fb2.0",
+    "@quenty/signal": "7.10.1-canary.545.2374fb2.0",
+    "@quenty/spring": "10.8.2-canary.545.2374fb2.0",
+    "@quenty/timedtween": "7.18.1-canary.545.2374fb2.0",
+    "@quenty/valueobject": "13.17.1-canary.545.2374fb2.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e8ea56930e65322fcffc05a1556d5df988068f0b"
+  "gitHead": "2374fb2b043cfbe0e9b507b3316eec46a4e353a0"
 }

package/src/Shared/SpringTransitionModel.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	@class SpringTransitionModel
 ]=]
@@ -10,11 +11,30 @@ local SpringObject = require("SpringObject")
 local Promise = require("Promise")
 local Maid = require("Maid")
 local SpringUtils = require("SpringUtils")
+local _Observable = require("Observable")
+local _Signal = require("Signal")
 
 local SpringTransitionModel = setmetatable({}, BasicPane)
 SpringTransitionModel.ClassName = "SpringTransitionModel"
 SpringTransitionModel.__index = SpringTransitionModel
 
+export type SpringTransitionModel<T> = typeof(setmetatable(
+	{} :: {
+		_maid: Maid.Maid,
+		_showTarget: any,
+		_hideTarget: any,
+		_springObject: any,
+		_transitionModel: TransitionModel.TransitionModel,
+
+		-- From BasicPane
+		IsVisible: (self: SpringTransitionModel<T>) -> boolean,
+		SetVisible: (self: SpringTransitionModel<T>, isVisible: boolean, doNotAnimate: boolean?) -> (),
+		VisibleChanged: _Signal.Signal<boolean, boolean>,
+		Destroy: (self: SpringTransitionModel<T>) -> (),
+	},
+	SpringTransitionModel
+))
+
 --[=[
 	A transition model that has a spring underlying it. Very useful
 	for animations on tracks that need to be on a spring.
@@ -23,8 +43,8 @@ SpringTransitionModel.__index = SpringTransitionModel
 	@param hideTarget T? -- Defaults to 0*showTarget
 	@return SpringTransitionModel<T>
 ]=]
-function SpringTransitionModel.new(showTarget, hideTarget)
-	local self = setmetatable(BasicPane.new(), SpringTransitionModel)
+function SpringTransitionModel.new<T>(showTarget: T?, hideTarget: T?): SpringTransitionModel<T>
+	local self = setmetatable(BasicPane.new() :: any, SpringTransitionModel)
 
 	self._showTarget = showTarget or 1
 	self._hideTarget = hideTarget
@@ -51,7 +71,7 @@ end
 	@param showTarget T?
 	@param doNotAnimate boolean?
 ]=]
-function SpringTransitionModel:SetShowTarget(showTarget, doNotAnimate)
+function SpringTransitionModel.SetShowTarget<T>(self: SpringTransitionModel<T>, showTarget: T?, doNotAnimate: boolean?)
 	self._showTarget = SpringUtils.toLinearIfNeeded(showTarget or 1)
 
 	if self:IsVisible() then
@@ -67,7 +87,7 @@ end
 	@param hideTarget T?
 	@param doNotAnimate boolean?
 ]=]
-function SpringTransitionModel:SetHideTarget(hideTarget, doNotAnimate)
+function SpringTransitionModel.SetHideTarget<T>(self: SpringTransitionModel<T>, hideTarget: T?, doNotAnimate: boolean?)
 	self._hideTarget = hideTarget
 
 	if self:IsVisible() then
@@ -81,7 +101,7 @@ end
 	Returns true if showing is complete
 	@return boolean
 ]=]
-function SpringTransitionModel:IsShowingComplete()
+function SpringTransitionModel.IsShowingComplete<T>(self: SpringTransitionModel<T>): boolean
 	return self._transitionModel:IsShowingComplete()
 end
 
@@ -89,7 +109,7 @@ end
 	Returns true if hiding is complete
 	@return boolean
 ]=]
-function SpringTransitionModel:IsHidingComplete()
+function SpringTransitionModel.IsHidingComplete<T>(self: SpringTransitionModel<T>): boolean
 	return self._transitionModel:IsHidingComplete()
 end
 
@@ -97,7 +117,7 @@ end
 	Observe is showing is complete
 	@return Observable<boolean>
 ]=]
-function SpringTransitionModel:ObserveIsShowingComplete()
+function SpringTransitionModel.ObserveIsShowingComplete<T>(self: SpringTransitionModel<T>): _Observable.Observable<boolean>
 	return self._transitionModel:ObserveIsShowingComplete()
 end
 
@@ -105,7 +125,7 @@ end
 	Observe is hiding is complete
 	@return Observable<boolean>
 ]=]
-function SpringTransitionModel:ObserveIsHidingComplete()
+function SpringTransitionModel.ObserveIsHidingComplete<T>(self: SpringTransitionModel<T>): _Observable.Observable<boolean>
 	return self._transitionModel:ObserveIsHidingComplete()
 end
 
@@ -115,7 +135,7 @@ end
 	@param pane BasicPane
 	@return function -- Cleanup function
 ]=]
-function SpringTransitionModel:BindToPaneVisbility(pane)
+function SpringTransitionModel.BindToPaneVisbility<T>(self: SpringTransitionModel<T>, pane: BasicPane.BasicPane): () -> ()
 	local maid = Maid.new()
 
 	maid:GiveTask(pane.VisibleChanged:Connect(function(isVisible, doNotAnimate)
@@ -145,7 +165,7 @@ end
 
 	@return T
 ]=]
-function SpringTransitionModel:GetVelocity()
+function SpringTransitionModel.GetVelocity<T>(self: SpringTransitionModel<T>)
 	return self._springObject.Velocity
 end
 
@@ -155,7 +175,7 @@ end
 
 	@param epsilon number
 ]=]
-function SpringTransitionModel:SetEpsilon(epsilon)
+function SpringTransitionModel.SetEpsilon<T>(self: SpringTransitionModel<T>, epsilon: number)
 	assert(type(epsilon) == "number", "Bad epsilon")
 
 	self._springObject.Epsilon = epsilon
@@ -166,7 +186,7 @@ end
 
 	@param speed number
 ]=]
-function SpringTransitionModel:SetSpeed(speed)
+function SpringTransitionModel.SetSpeed<T>(self: SpringTransitionModel<T>, speed: number | _Observable.Observable<T>)
 	assert(type(speed) == "number", "Bad speed")
 
 	self._springObject.Speed = speed
@@ -177,7 +197,7 @@ end
 
 	@param damper number
 ]=]
-function SpringTransitionModel:SetDamper(damper)
+function SpringTransitionModel.SetDamper<T>(self: SpringTransitionModel<T>, damper: number | _Observable.Observable<T>)
 	assert(type(damper) == "number", "Bad damper")
 
 	self._springObject.Damper = damper
@@ -187,7 +207,7 @@ end
 	Observes the spring animating
 	@return Observable<T>
 ]=]
-function SpringTransitionModel:ObserveRenderStepped()
+function SpringTransitionModel.ObserveRenderStepped<T>(self: SpringTransitionModel<T>): _Observable.Observable<T>
 	return self._springObject:ObserveRenderStepped()
 end
 
@@ -196,7 +216,7 @@ end
 
 	@return Observable<T>
 ]=]
-function SpringTransitionModel:Observe()
+function SpringTransitionModel.Observe<T>(self: SpringTransitionModel<T>): _Observable.Observable<T>
 	return self._springObject:Observe()
 end
 
@@ -206,7 +226,7 @@ end
 	@param doNotAnimate boolean
 	@return Promise
 ]=]
-function SpringTransitionModel:PromiseShow(doNotAnimate)
+function SpringTransitionModel.PromiseShow<T>(self: SpringTransitionModel<T>, doNotAnimate: boolean?): Promise.Promise<()>
 	return self._transitionModel:PromiseShow(doNotAnimate)
 end
 
@@ -216,7 +236,7 @@ end
 	@param doNotAnimate boolean
 	@return Promise
 ]=]
-function SpringTransitionModel:PromiseHide(doNotAnimate)
+function SpringTransitionModel.PromiseHide<T>(self: SpringTransitionModel<T>, doNotAnimate: boolean?): Promise.Promise<()>
 	return self._transitionModel:PromiseHide(doNotAnimate)
 end
 
@@ -226,11 +246,18 @@ end
 	@param doNotAnimate boolean
 	@return Promise
 ]=]
-function SpringTransitionModel:PromiseToggle(doNotAnimate)
+function SpringTransitionModel.PromiseToggle<T>(
+	self: SpringTransitionModel<T>,
+	doNotAnimate: boolean?
+): Promise.Promise<()>
 	return self._transitionModel:PromiseToggle(doNotAnimate)
 end
 
-function SpringTransitionModel:_promiseShow(maid, doNotAnimate)
+function SpringTransitionModel._promiseShow<T>(
+	self: SpringTransitionModel<T>,
+	maid: Maid.Maid,
+	doNotAnimate: boolean?
+): Promise.Promise<()>
 	self._springObject:SetTarget(self._showTarget, doNotAnimate)
 
 	if doNotAnimate then
@@ -240,7 +267,11 @@ function SpringTransitionModel:_promiseShow(maid, doNotAnimate)
 	end
 end
 
-function SpringTransitionModel:_promiseHide(maid, doNotAnimate)
+function SpringTransitionModel._promiseHide<T>(
+	self: SpringTransitionModel<T>,
+	maid: Maid.Maid,
+	doNotAnimate: boolean?
+): Promise.Promise<()>
 	self._springObject:SetTarget(self:_computeHideTarget(), doNotAnimate)
 
 	if doNotAnimate then
@@ -250,11 +281,11 @@ function SpringTransitionModel:_promiseHide(maid, doNotAnimate)
 	end
 end
 
-function SpringTransitionModel:_computeHideTarget()
+function SpringTransitionModel._computeHideTarget<T>(self: SpringTransitionModel<T>): any
 	if self._hideTarget then
 		return SpringUtils.toLinearIfNeeded(self._hideTarget)
 	else
-		return 0*SpringUtils.toLinearIfNeeded(self._showTarget)
+		return 0 * SpringUtils.toLinearIfNeeded(self._showTarget) :: any
 	end
 end
 

package/src/Shared/Sustain/SustainModel.lua

@@ -54,7 +54,7 @@ end
 	@param isSustained boolean
 	@param doNotAnimate boolean? -- True if animation should be skipped
 ]=]
-function SustainModel:SetIsSustained(isSustained, doNotAnimate)
+function SustainModel:SetIsSustained(isSustained, doNotAnimate: boolean?)
 	assert(type(isSustained) == "boolean", "Bad isSustained")
 
 	if self._isSustained ~= isSustained then
@@ -68,7 +68,7 @@ end
 
 	@param doNotAnimate boolean? -- True if animation should be skipped
 ]=]
-function SustainModel:Sustain(doNotAnimate)
+function SustainModel:Sustain(doNotAnimate: boolean?)
 	self:SetIsSustained(true, doNotAnimate)
 end
 
@@ -77,7 +77,7 @@ end
 
 	@param doNotAnimate boolean? -- True if animation should be skipped
 ]=]
-function SustainModel:Stop(doNotAnimate)
+function SustainModel:Stop(doNotAnimate: boolean?)
 	self:SetIsSustained(false, doNotAnimate)
 end
 
@@ -89,7 +89,7 @@ end
 	@param doNotAnimate boolean? -- True if animation should be skipped
 	@return Promise
 ]=]
-function SustainModel:PromiseSustain(doNotAnimate)
+function SustainModel:PromiseSustain(doNotAnimate: boolean?)
 	self:Sustain(doNotAnimate)
 
 	return self:_promiseSustained()
@@ -118,7 +118,7 @@ function SustainModel:_promiseSustained()
 	return promise
 end
 
-function SustainModel:_executeSustain(doNotAnimate)
+function SustainModel:_executeSustain(doNotAnimate: boolean?)
 	local maid = Maid.new()
 
 	local promise = Promise.new()

package/src/Shared/Timed/TimedTransitionModel.lua

@@ -21,7 +21,7 @@ TimedTransitionModel.__index = TimedTransitionModel
 	@param transitionTime number? -- Optional
 	@return TimedTransitionModel<T>
 ]=]
-function TimedTransitionModel.new(transitionTime)
+function TimedTransitionModel.new(transitionTime: number?)
 	local self = setmetatable(BasicPane.new(), TimedTransitionModel)
 
 	self._transitionModel = self._maid:Add(TransitionModel.new())
@@ -40,7 +40,7 @@ function TimedTransitionModel.new(transitionTime)
 	return self
 end
 
-function TimedTransitionModel:SetTransitionTime(transitionTime)
+function TimedTransitionModel:SetTransitionTime(transitionTime: number)
 	self._timedTween:SetTransitionTime(transitionTime)
 end
 
@@ -48,7 +48,7 @@ end
 	Returns true if showing is complete
 	@return boolean
 ]=]
-function TimedTransitionModel:IsShowingComplete()
+function TimedTransitionModel:IsShowingComplete(): boolean
 	return self._transitionModel:IsShowingComplete()
 end
 
@@ -56,7 +56,7 @@ end
 	Returns true if hiding is complete
 	@return boolean
 ]=]
-function TimedTransitionModel:IsHidingComplete()
+function TimedTransitionModel:IsHidingComplete(): boolean
 	return self._transitionModel:IsHidingComplete()
 end
 
@@ -127,20 +127,20 @@ end
 --[=[
 	Shows the model and promises when the showing is complete.
 
-	@param doNotAnimate boolean
+	@param doNotAnimate boolean?
 	@return Promise
 ]=]
-function TimedTransitionModel:PromiseShow(doNotAnimate)
+function TimedTransitionModel:PromiseShow(doNotAnimate: boolean?)
 	return self._transitionModel:PromiseShow(doNotAnimate)
 end
 
 --[=[
 	Hides the model and promises when the showing is complete.
 
-	@param doNotAnimate boolean
+	@param doNotAnimate boolean?
 	@return Promise
 ]=]
-function TimedTransitionModel:PromiseHide(doNotAnimate)
+function TimedTransitionModel:PromiseHide(doNotAnimate: boolean?)
 	return self._transitionModel:PromiseHide(doNotAnimate)
 end
 
@@ -150,11 +150,11 @@ end
 	@param doNotAnimate boolean
 	@return Promise
 ]=]
-function TimedTransitionModel:PromiseToggle(doNotAnimate)
+function TimedTransitionModel:PromiseToggle(doNotAnimate: boolean?)
 	return self._transitionModel:PromiseToggle(doNotAnimate)
 end
 
-function TimedTransitionModel:_promiseShow(maid, doNotAnimate)
+function TimedTransitionModel:_promiseShow(maid, doNotAnimate: boolean?)
 	self._timedTween:Show(doNotAnimate)
 
 	if doNotAnimate then
@@ -164,7 +164,7 @@ function TimedTransitionModel:_promiseShow(maid, doNotAnimate)
 	end
 end
 
-function TimedTransitionModel:_promiseHide(maid, doNotAnimate)
+function TimedTransitionModel:_promiseHide(maid, doNotAnimate: boolean?)
 	self._timedTween:Hide(doNotAnimate)
 
 	if doNotAnimate then

package/src/Shared/TransitionModel.lua

@@ -12,11 +12,28 @@ local Promise = require("Promise")
 local Maid = require("Maid")
 local ValueObject = require("ValueObject")
 local DuckTypeUtils = require("DuckTypeUtils")
+local _Signal = require("Signal")
+local _Observable = require("Observable")
 
 local TransitionModel = setmetatable({}, BasicPane)
 TransitionModel.ClassName = "TransitionModel"
 TransitionModel.__index = TransitionModel
 
+export type TransitionModel = typeof(setmetatable(
+	{} :: {
+		_isShowingComplete: ValueObject.ValueObject<boolean>,
+		_isHidingComplete: ValueObject.ValueObject<boolean>,
+
+		-- From BasicPane
+		_maid: Maid.Maid,
+		IsVisible: (self: TransitionModel) -> boolean,
+		SetVisible: (self: TransitionModel, isVisible: boolean, doNotAnimate: boolean?) -> (),
+		VisibleChanged: _Signal.Signal<boolean, boolean>,
+		Destroy: (self: TransitionModel) -> (),
+	},
+	TransitionModel
+))
+
 --[=[
 	A transition model that takes a set amount of time to show
 	and hide. Can be used just like a [BasicPane] (in fact, it
@@ -25,7 +42,7 @@ TransitionModel.__index = TransitionModel
 
 	@return TransitionModel
 ]=]
-function TransitionModel.new()
+function TransitionModel.new(): TransitionModel
 	local self = setmetatable(BasicPane.new(), TransitionModel)
 
 	self._isShowingComplete = self._maid:Add(ValueObject.new(false, "boolean"))
@@ -51,7 +68,7 @@ end
 	@param value any
 	@return boolean
 ]=]
-function TransitionModel.isTransitionModel(value)
+function TransitionModel.isTransitionModel(value: any): boolean
 	return DuckTypeUtils.isImplementation(TransitionModel, value)
 end
 
@@ -61,7 +78,7 @@ end
 	@param doNotAnimate boolean
 	@return Promise
 ]=]
-function TransitionModel:PromiseShow(doNotAnimate)
+function TransitionModel:PromiseShow(doNotAnimate: boolean?): Promise.Promise<()>
 	local promise = self:_promiseIsShown()
 
 	self:Show(doNotAnimate)
@@ -75,7 +92,7 @@ end
 	@param doNotAnimate boolean
 	@return Promise
 ]=]
-function TransitionModel:PromiseHide(doNotAnimate)
+function TransitionModel:PromiseHide(doNotAnimate: boolean?): Promise.Promise<()>
 	local promise = self:_promiseIsHidden()
 
 	self:Hide(doNotAnimate)
@@ -89,7 +106,7 @@ end
 	@param doNotAnimate boolean
 	@return Promise
 ]=]
-function TransitionModel:PromiseToggle(doNotAnimate)
+function TransitionModel:PromiseToggle(doNotAnimate: boolean?): Promise.Promise<()>
 	if self:IsVisible() then
 		return self:PromiseShow(doNotAnimate)
 	else
@@ -99,17 +116,17 @@ end
 
 --[=[
 	Returns true if showing is complete
-	@return boolean
+	@return boolean?
 ]=]
-function TransitionModel:IsShowingComplete()
+function TransitionModel:IsShowingComplete(): boolean
 	return self._isShowingComplete.Value
 end
 
 --[=[
 	Returns true if hiding is complete
-	@return boolean
+	@return boolean?
 ]=]
-function TransitionModel:IsHidingComplete()
+function TransitionModel:IsHidingComplete(): boolean?
 	return self._isHidingComplete.Value
 end
 
@@ -117,7 +134,7 @@ end
 	Observe is showing is complete
 	@return Observable<boolean>
 ]=]
-function TransitionModel:ObserveIsShowingComplete()
+function TransitionModel:ObserveIsShowingComplete(): _Observable.Observable<boolean>
 	return self._isShowingComplete:Observe()
 end
 
@@ -125,7 +142,7 @@ end
 	Observe is hiding is complete
 	@return Observable<boolean>
 ]=]
-function TransitionModel:ObserveIsHidingComplete()
+function TransitionModel:ObserveIsHidingComplete(): _Observable.Observable<boolean>
 	return self._isHidingComplete:Observe()
 end
 
@@ -135,7 +152,7 @@ end
 	@param pane BasicPane
 	@return function -- Cleanup function
 ]=]
-function TransitionModel:BindToPaneVisbility(pane)
+function TransitionModel:BindToPaneVisbility(pane: BasicPane.BasicPane): () -> ()
 	local maid = Maid.new()
 
 	maid:GiveTask(pane.VisibleChanged:Connect(function(isVisible, doNotAnimate)
@@ -178,7 +195,7 @@ function TransitionModel:SetPromiseHide(hideCallback)
 	self._hideCallback = hideCallback
 end
 
-function TransitionModel:_promiseIsShown()
+function TransitionModel:_promiseIsShown(): Promise.Promise<()>
 	if self._isShowingComplete.Value then
 		return Promise.resolved()
 	end
@@ -207,8 +224,7 @@ function TransitionModel:_promiseIsShown()
 	return promise
 end
 
-
-function TransitionModel:_promiseIsHidden()
+function TransitionModel:_promiseIsHidden(): Promise.Promise<()>
 	if self._isHidingComplete.Value then
 		return Promise.resolved()
 	end
@@ -237,7 +253,7 @@ function TransitionModel:_promiseIsHidden()
 	return promise
 end
 
-function TransitionModel:_executeShow(doNotAnimate)
+function TransitionModel:_executeShow(doNotAnimate: boolean?)
 	self._maid._transition = nil
 
 	local maid = Maid.new()
@@ -252,7 +268,12 @@ function TransitionModel:_executeShow(doNotAnimate)
 			promise:Resolve(result)
 		else
 			promise:Reject()
-			error(string.format("[TransitionModel] - Expected promise to be returned from showCallback, got %q", tostring(result)))
+			error(
+				string.format(
+					"[TransitionModel] - Expected promise to be returned from showCallback, got %q",
+					tostring(result)
+				)
+			)
 		end
 	else
 		-- Immediately resolve
@@ -270,7 +291,7 @@ function TransitionModel:_executeShow(doNotAnimate)
 	end
 end
 
-function TransitionModel:_executeHide(doNotAnimate)
+function TransitionModel:_executeHide(doNotAnimate: boolean?)
 	self._maid._transition = nil
 
 	local maid = Maid.new()