@quenty/transitionmodel 7.19.3 → 7.19.4-canary.559.339cfa7.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.4-canary.559.339cfa7.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/transitionmodel@7.19.3...@quenty/transitionmodel@7.19.4-canary.559.339cfa7.0) (2025-05-10)
+
+
+### Bug Fixes
+
+* Additional type checking updates ([05ba29a](https://github.com/Quenty/NevermoreEngine/commit/05ba29a03efc9f3feed74b34f1d9dfb237496214))
+
+
+
+
+
 ## [7.19.3](https://github.com/Quenty/NevermoreEngine/compare/@quenty/transitionmodel@7.19.2...@quenty/transitionmodel@7.19.3) (2025-04-10)
 
 **Note:** Version bump only for package @quenty/transitionmodel

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/transitionmodel",
-  "version": "7.19.3",
+  "version": "7.19.4-canary.559.339cfa7.0",
   "description": "Helps with Gui visiblity showing and hiding",
   "keywords": [
     "Roblox",
@@ -25,22 +25,22 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/baseobject": "^10.8.3",
-    "@quenty/basicpane": "^13.17.3",
-    "@quenty/blend": "^12.18.3",
-    "@quenty/ducktype": "^5.8.4",
-    "@quenty/instanceutils": "^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/spring": "^10.8.4",
-    "@quenty/timedtween": "^7.18.3",
-    "@quenty/valueobject": "^13.17.3"
+    "@quenty/baseobject": "10.8.4-canary.559.339cfa7.0",
+    "@quenty/basicpane": "13.17.4-canary.559.339cfa7.0",
+    "@quenty/blend": "12.18.4-canary.559.339cfa7.0",
+    "@quenty/ducktype": "5.8.5-canary.559.339cfa7.0",
+    "@quenty/instanceutils": "13.17.4-canary.559.339cfa7.0",
+    "@quenty/loader": "10.8.4-canary.559.339cfa7.0",
+    "@quenty/maid": "3.4.4-canary.559.339cfa7.0",
+    "@quenty/promise": "10.10.5-canary.559.339cfa7.0",
+    "@quenty/rx": "13.17.4-canary.559.339cfa7.0",
+    "@quenty/signal": "7.10.4-canary.559.339cfa7.0",
+    "@quenty/spring": "10.8.5-canary.559.339cfa7.0",
+    "@quenty/timedtween": "7.18.4-canary.559.339cfa7.0",
+    "@quenty/valueobject": "13.17.4-canary.559.339cfa7.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "b06c070ae91d5dab7bd8de6e290ad2caabb15d8f"
+  "gitHead": "339cfa778736f08768ed7305041f6221faa35bfc"
 }

package/src/Shared/SpringTransitionModel.lua

@@ -6,13 +6,12 @@
 local require = require(script.Parent.loader).load(script)
 
 local BasicPane = require("BasicPane")
-local TransitionModel = require("TransitionModel")
-local SpringObject = require("SpringObject")
-local Promise = require("Promise")
 local Maid = require("Maid")
+local Observable = require("Observable")
+local Promise = require("Promise")
+local SpringObject = require("SpringObject")
 local SpringUtils = require("SpringUtils")
-local _Observable = require("Observable")
-local _Signal = require("Signal")
+local TransitionModel = require("TransitionModel")
 
 local SpringTransitionModel = setmetatable({}, BasicPane)
 SpringTransitionModel.ClassName = "SpringTransitionModel"
@@ -110,7 +109,7 @@ end
 	Observe is showing is complete
 	@return Observable<boolean>
 ]=]
-function SpringTransitionModel.ObserveIsShowingComplete<T>(self: SpringTransitionModel<T>): _Observable.Observable<boolean>
+function SpringTransitionModel.ObserveIsShowingComplete<T>(self: SpringTransitionModel<T>): Observable.Observable<boolean>
 	return self._transitionModel:ObserveIsShowingComplete()
 end
 
@@ -118,7 +117,7 @@ end
 	Observe is hiding is complete
 	@return Observable<boolean>
 ]=]
-function SpringTransitionModel.ObserveIsHidingComplete<T>(self: SpringTransitionModel<T>): _Observable.Observable<boolean>
+function SpringTransitionModel.ObserveIsHidingComplete<T>(self: SpringTransitionModel<T>): Observable.Observable<boolean>
 	return self._transitionModel:ObserveIsHidingComplete()
 end
 
@@ -179,7 +178,7 @@ end
 
 	@param speed number
 ]=]
-function SpringTransitionModel.SetSpeed<T>(self: SpringTransitionModel<T>, speed: number | _Observable.Observable<T>)
+function SpringTransitionModel.SetSpeed<T>(self: SpringTransitionModel<T>, speed: number | Observable.Observable<T>)
 	assert(type(speed) == "number", "Bad speed")
 
 	self._springObject.Speed = speed
@@ -190,7 +189,7 @@ end
 
 	@param damper number
 ]=]
-function SpringTransitionModel.SetDamper<T>(self: SpringTransitionModel<T>, damper: number | _Observable.Observable<T>)
+function SpringTransitionModel.SetDamper<T>(self: SpringTransitionModel<T>, damper: number | Observable.Observable<T>)
 	assert(type(damper) == "number", "Bad damper")
 
 	self._springObject.Damper = damper
@@ -200,7 +199,7 @@ end
 	Observes the spring animating
 	@return Observable<T>
 ]=]
-function SpringTransitionModel.ObserveRenderStepped<T>(self: SpringTransitionModel<T>): _Observable.Observable<T>
+function SpringTransitionModel.ObserveRenderStepped<T>(self: SpringTransitionModel<T>): Observable.Observable<T>
 	return self._springObject:ObserveRenderStepped()
 end
 
@@ -209,7 +208,7 @@ end
 
 	@return Observable<T>
 ]=]
-function SpringTransitionModel.Observe<T>(self: SpringTransitionModel<T>): _Observable.Observable<T>
+function SpringTransitionModel.Observe<T>(self: SpringTransitionModel<T>): Observable.Observable<T>
 	return self._springObject:Observe()
 end
 
@@ -282,4 +281,4 @@ function SpringTransitionModel._computeHideTarget<T>(self: SpringTransitionModel
 	end
 end
 
-return SpringTransitionModel
+return SpringTransitionModel

package/src/Shared/Sustain/SustainModel.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	A sustain model is much like a [TransitionModel] but is responsible for
 	sustaining some animation or state. Useful to represent the sustained state
@@ -17,14 +18,25 @@ local SustainModel = setmetatable({}, BaseObject)
 SustainModel.ClassName = "SustainModel"
 SustainModel.__index = SustainModel
 
-function SustainModel.new()
-	local self = setmetatable(BaseObject.new(), SustainModel)
+export type SustainCallback = (Maid.Maid, boolean?) -> Promise.Promise<()> | any
+
+export type SustainModel = typeof(setmetatable(
+	{} :: {
+		_isSustained: boolean,
+		_sustainCallback: SustainCallback?,
+		_maid: Maid.Maid,
+		SustainChanged: Signal.Signal<(boolean, boolean?)>,
+	},
+	{} :: typeof({ __index = SustainModel })
+)) & BaseObject.BaseObject
+
+function SustainModel.new(): SustainModel
+	local self: SustainModel = setmetatable(BaseObject.new() :: any, SustainModel)
 
 	self._isSustained = false
 	self._sustainCallback = nil
 
-	self.SustainChanged = Signal.new() -- :Fire(isSustained, doNotAnimate)
-	self._maid:GiveTask(self.SustainChanged)
+	self.SustainChanged = self._maid:Add(Signal.new() :: any) -- :Fire(isSustained, doNotAnimate)
 
 	self._maid:GiveTask(self.SustainChanged:Connect(function(isSustained, doNotAnimate)
 		if isSustained then
@@ -42,7 +54,7 @@ end
 
 	@param sustainCallback function? -- Callback which should return a promise
 ]=]
-function SustainModel:SetPromiseSustain(sustainCallback)
+function SustainModel.SetPromiseSustain(self: SustainModel, sustainCallback: SustainCallback?)
 	assert(type(sustainCallback) == "function" or sustainCallback == nil, "Bad sustainCallback")
 
 	self._sustainCallback = sustainCallback
@@ -54,7 +66,7 @@ end
 	@param isSustained boolean
 	@param doNotAnimate boolean? -- True if animation should be skipped
 ]=]
-function SustainModel:SetIsSustained(isSustained, doNotAnimate: boolean?)
+function SustainModel.SetIsSustained(self: SustainModel, isSustained: boolean, doNotAnimate: boolean?)
 	assert(type(isSustained) == "boolean", "Bad isSustained")
 
 	if self._isSustained ~= isSustained then
@@ -68,7 +80,7 @@ end
 
 	@param doNotAnimate boolean? -- True if animation should be skipped
 ]=]
-function SustainModel:Sustain(doNotAnimate: boolean?)
+function SustainModel.Sustain(self: SustainModel, doNotAnimate: boolean?)
 	self:SetIsSustained(true, doNotAnimate)
 end
 
@@ -77,7 +89,7 @@ end
 
 	@param doNotAnimate boolean? -- True if animation should be skipped
 ]=]
-function SustainModel:Stop(doNotAnimate: boolean?)
+function SustainModel.Stop(self: SustainModel, doNotAnimate: boolean?)
 	self:SetIsSustained(false, doNotAnimate)
 end
 
@@ -89,13 +101,13 @@ end
 	@param doNotAnimate boolean? -- True if animation should be skipped
 	@return Promise
 ]=]
-function SustainModel:PromiseSustain(doNotAnimate: boolean?)
+function SustainModel.PromiseSustain(self: SustainModel, doNotAnimate: boolean?): Promise.Promise<()>
 	self:Sustain(doNotAnimate)
 
 	return self:_promiseSustained()
 end
 
-function SustainModel:_promiseSustained()
+function SustainModel._promiseSustained(self: SustainModel): Promise.Promise<()>
 	if not self._isSustained then
 		return Promise.resolved()
 	end
@@ -118,11 +130,9 @@ function SustainModel:_promiseSustained()
 	return promise
 end
 
-function SustainModel:_executeSustain(doNotAnimate: boolean?)
+function SustainModel._executeSustain(self: SustainModel, doNotAnimate: boolean?): ()
 	local maid = Maid.new()
-
-	local promise = Promise.new()
-	maid:GiveTask(promise)
+	local promise = maid:Add(Promise.new())
 
 	if self._sustainCallback then
 		local result = self._sustainCallback(maid, doNotAnimate)
@@ -130,7 +140,12 @@ function SustainModel:_executeSustain(doNotAnimate: boolean?)
 			promise:Resolve(result)
 		else
 			promise:Reject()
-			error(string.format("[SustainModel] - Expected promise to be returned from sustainCallback, got %q", tostring(result)))
+			error(
+				string.format(
+					"[SustainModel] - Expected promise to be returned from sustainCallback, got %q",
+					tostring(result)
+				)
+			)
 		end
 	end
 
@@ -141,5 +156,4 @@ function SustainModel:_executeSustain(doNotAnimate: boolean?)
 	self._maid._sustaining = maid
 end
 
-
-return SustainModel
+return SustainModel

package/src/Shared/Timed/TimedTransitionModel.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	@class TimedTransitionModel
 ]=]
@@ -5,24 +6,33 @@
 local require = require(script.Parent.loader).load(script)
 
 local BasicPane = require("BasicPane")
-local TransitionModel = require("TransitionModel")
-local TimedTween = require("TimedTween")
-local Promise = require("Promise")
 local Maid = require("Maid")
+local Observable = require("Observable")
+local Promise = require("Promise")
+local TimedTween = require("TimedTween")
+local TransitionModel = require("TransitionModel")
 
 local TimedTransitionModel = setmetatable({}, BasicPane)
 TimedTransitionModel.ClassName = "TimedTransitionModel"
 TimedTransitionModel.__index = TimedTransitionModel
 
+export type TimedTransitionModel = typeof(setmetatable(
+	{} :: {
+		_transitionModel: TransitionModel.TransitionModel,
+		_timedTween: TimedTween.TimedTween,
+	},
+	{} :: typeof({ __index = TimedTransitionModel })
+)) & BasicPane.BasicPane
+
 --[=[
 	A transition model that has a spring underlying it. Very useful
 	for animations on tracks that need to be on a spring.
 
 	@param transitionTime number? -- Optional
-	@return TimedTransitionModel<T>
+	@return TimedTransitionModel
 ]=]
-function TimedTransitionModel.new(transitionTime: number?)
-	local self = setmetatable(BasicPane.new(), TimedTransitionModel)
+function TimedTransitionModel.new(transitionTime: number?): TimedTransitionModel
+	local self: TimedTransitionModel = setmetatable(BasicPane.new() :: any, TimedTransitionModel)
 
 	self._transitionModel = self._maid:Add(TransitionModel.new())
 	self._transitionModel:BindToPaneVisbility(self)
@@ -40,7 +50,12 @@ function TimedTransitionModel.new(transitionTime: number?)
 	return self
 end
 
-function TimedTransitionModel:SetTransitionTime(transitionTime: number)
+--[=[
+	Sets the transition time
+
+	@param transitionTime number
+]=]
+function TimedTransitionModel.SetTransitionTime(self: TimedTransitionModel, transitionTime: number)
 	self._timedTween:SetTransitionTime(transitionTime)
 end
 
@@ -48,7 +63,7 @@ end
 	Returns true if showing is complete
 	@return boolean
 ]=]
-function TimedTransitionModel:IsShowingComplete(): boolean
+function TimedTransitionModel.IsShowingComplete(self: TimedTransitionModel): boolean
 	return self._transitionModel:IsShowingComplete()
 end
 
@@ -56,7 +71,7 @@ end
 	Returns true if hiding is complete
 	@return boolean
 ]=]
-function TimedTransitionModel:IsHidingComplete(): boolean
+function TimedTransitionModel.IsHidingComplete(self: TimedTransitionModel): boolean
 	return self._transitionModel:IsHidingComplete()
 end
 
@@ -64,7 +79,7 @@ end
 	Observe is showing is complete
 	@return Observable<boolean>
 ]=]
-function TimedTransitionModel:ObserveIsShowingComplete()
+function TimedTransitionModel.ObserveIsShowingComplete(self: TimedTransitionModel): Observable.Observable<boolean>
 	return self._transitionModel:ObserveIsShowingComplete()
 end
 
@@ -72,7 +87,7 @@ end
 	Observe is hiding is complete
 	@return Observable<boolean>
 ]=]
-function TimedTransitionModel:ObserveIsHidingComplete()
+function TimedTransitionModel.ObserveIsHidingComplete(self: TimedTransitionModel): Observable.Observable<boolean>
 	return self._transitionModel:ObserveIsHidingComplete()
 end
 
@@ -82,7 +97,7 @@ end
 	@param pane BasicPane
 	@return function -- Cleanup function
 ]=]
-function TimedTransitionModel:BindToPaneVisbility(pane)
+function TimedTransitionModel.BindToPaneVisbility(self: TimedTransitionModel, pane: BasicPane.BasicPane): () -> ()
 	local maid = Maid.new()
 
 	maid:GiveTask(pane.VisibleChanged:Connect(function(isVisible, doNotAnimate)
@@ -109,18 +124,18 @@ end
 
 --[=[
 	Observes the spring animating
-	@return Observable<T>
+	@return Observable<number>
 ]=]
-function TimedTransitionModel:ObserveRenderStepped()
+function TimedTransitionModel.ObserveRenderStepped(self: TimedTransitionModel): Observable.Observable<number>
 	return self._timedTween:ObserveRenderStepped()
 end
 
 --[=[
 	Alias to spring transition model observation!
 
-	@return Observable<T>
+	@return Observable<number>
 ]=]
-function TimedTransitionModel:Observe()
+function TimedTransitionModel.Observe(self: TimedTransitionModel): Observable.Observable<number>
 	return self._timedTween:Observe()
 end
 
@@ -130,7 +145,7 @@ end
 	@param doNotAnimate boolean?
 	@return Promise
 ]=]
-function TimedTransitionModel:PromiseShow(doNotAnimate: boolean?)
+function TimedTransitionModel.PromiseShow(self: TimedTransitionModel, doNotAnimate: boolean?): Promise.Promise<()>
 	return self._transitionModel:PromiseShow(doNotAnimate)
 end
 
@@ -140,7 +155,7 @@ end
 	@param doNotAnimate boolean?
 	@return Promise
 ]=]
-function TimedTransitionModel:PromiseHide(doNotAnimate: boolean?)
+function TimedTransitionModel.PromiseHide(self: TimedTransitionModel, doNotAnimate: boolean?): Promise.Promise<()>
 	return self._transitionModel:PromiseHide(doNotAnimate)
 end
 
@@ -150,11 +165,15 @@ end
 	@param doNotAnimate boolean
 	@return Promise
 ]=]
-function TimedTransitionModel:PromiseToggle(doNotAnimate: boolean?)
+function TimedTransitionModel.PromiseToggle(self: TimedTransitionModel, doNotAnimate: boolean?): Promise.Promise<()>
 	return self._transitionModel:PromiseToggle(doNotAnimate)
 end
 
-function TimedTransitionModel:_promiseShow(maid, doNotAnimate: boolean?)
+function TimedTransitionModel._promiseShow(
+	self: TimedTransitionModel,
+	maid,
+	doNotAnimate: boolean?
+): Promise.Promise<()>
 	self._timedTween:Show(doNotAnimate)
 
 	if doNotAnimate then
@@ -164,7 +183,11 @@ function TimedTransitionModel:_promiseShow(maid, doNotAnimate: boolean?)
 	end
 end
 
-function TimedTransitionModel:_promiseHide(maid, doNotAnimate: boolean?)
+function TimedTransitionModel._promiseHide(
+	self: TimedTransitionModel,
+	maid: Maid.Maid,
+	doNotAnimate: boolean?
+): Promise.Promise<()>
 	self._timedTween:Hide(doNotAnimate)
 
 	if doNotAnimate then
@@ -174,5 +197,4 @@ function TimedTransitionModel:_promiseHide(maid, doNotAnimate: boolean?)
 	end
 end
 
-
-return TimedTransitionModel
+return TimedTransitionModel

package/src/Shared/TransitionModel.lua

@@ -9,12 +9,11 @@
 local require = require(script.Parent.loader).load(script)
 
 local BasicPane = require("BasicPane")
-local Promise = require("Promise")
+local DuckTypeUtils = require("DuckTypeUtils")
 local Maid = require("Maid")
+local Observable = require("Observable")
+local Promise = require("Promise")
 local ValueObject = require("ValueObject")
-local DuckTypeUtils = require("DuckTypeUtils")
-local _Signal = require("Signal")
-local _Observable = require("Observable")
 
 local TransitionModel = setmetatable({}, BasicPane)
 TransitionModel.ClassName = "TransitionModel"
@@ -132,7 +131,7 @@ end
 	Observe is showing is complete
 	@return Observable<boolean>
 ]=]
-function TransitionModel.ObserveIsShowingComplete(self: TransitionModel): _Observable.Observable<boolean>
+function TransitionModel.ObserveIsShowingComplete(self: TransitionModel): Observable.Observable<boolean>
 	return self._isShowingComplete:Observe()
 end
 
@@ -140,7 +139,7 @@ end
 	Observe is hiding is complete
 	@return Observable<boolean>
 ]=]
-function TransitionModel.ObserveIsHidingComplete(self: TransitionModel): _Observable.Observable<boolean>
+function TransitionModel.ObserveIsHidingComplete(self: TransitionModel): Observable.Observable<boolean>
 	return self._isHidingComplete:Observe()
 end
 
@@ -304,7 +303,12 @@ function TransitionModel._executeHide(self: TransitionModel, doNotAnimate: boole
 			promise:Resolve(result)
 		else
 			promise:Reject()
-			error(string.format("[TransitionModel] - Expected promise to be returned from hideCallback, got %q", tostring(result)))
+			error(
+				string.format(
+					"[TransitionModel] - Expected promise to be returned from hideCallback, got %q",
+					tostring(result)
+				)
+			)
 		end
 	else
 		-- Immediately resolve
@@ -322,4 +326,4 @@ function TransitionModel._executeHide(self: TransitionModel, doNotAnimate: boole
 	end
 end
 
-return TransitionModel
+return TransitionModel

package/src/Shared/TransitionUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	@class TransitionUtils
 ]=]
@@ -19,11 +20,11 @@ local TransitionUtils = {}
 	@param value any
 	@return boolean
 ]=]
-function TransitionUtils.isTransition(value)
+function TransitionUtils.isTransition(value: any): boolean
 	return BasicPane.isBasicPane(value)
 		and type(value.PromiseShow) == "function"
 		and type(value.PromiseHide) == "function"
 		and type(value.PromiseToggle) == "function"
 end
 
-return TransitionUtils
+return TransitionUtils