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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/basicpane",
-  "version": "13.17.0",
+  "version": "13.17.1",
   "description": "Base UI object with visibility and a maid",
   "keywords": [
     "Roblox",
@@ -25,16 +25,16 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/brio": "^14.17.0",
-    "@quenty/ducktype": "^5.8.1",
-    "@quenty/loader": "^10.8.0",
-    "@quenty/maid": "^3.4.0",
-    "@quenty/rx": "^13.17.0",
-    "@quenty/signal": "^7.10.0",
-    "@quenty/valueobject": "^13.17.0"
+    "@quenty/brio": "^14.17.1",
+    "@quenty/ducktype": "^5.8.2",
+    "@quenty/loader": "^10.8.1",
+    "@quenty/maid": "^3.4.1",
+    "@quenty/rx": "^13.17.1",
+    "@quenty/signal": "^7.10.1",
+    "@quenty/valueobject": "^13.17.1"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e8ea56930e65322fcffc05a1556d5df988068f0b"
+  "gitHead": "78c3ac0ab08dd18085b6e6e6e4f745e76ed99f68"
 }

package/src/Shared/BasicPane.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Base UI object with visibility and a maid. BasicPane provides three points of utility.
 
@@ -21,22 +22,35 @@
 
 local require = require(script.Parent.loader).load(script)
 
-local Signal = require("Signal")
-local Maid = require("Maid")
 local DuckTypeUtils = require("DuckTypeUtils")
+local Maid = require("Maid")
+local Signal = require("Signal")
 local ValueObject = require("ValueObject")
+local _Brio = require("Brio")
+local _Observable = require("Observable")
+local _Rx = require("Rx")
 
 local BasicPane = {}
 BasicPane.ClassName = "BasicPane"
 BasicPane.__index = BasicPane
 
+export type BasicPane = typeof(setmetatable(
+	{} :: {
+		_maid: Maid.Maid,
+		_visible: ValueObject.ValueObject<boolean>,
+		Gui: GuiBase?,
+		VisibleChanged: Signal.Signal<(boolean, boolean)>,
+	},
+	BasicPane
+))
+
 --[=[
 	Constructs a new BasicPane with the .Gui property set.
 
 	@param gui GuiBase? -- Optional Gui object
 	@return BasicPane
 ]=]
-function BasicPane.new(gui)
+function BasicPane.new(gui: GuiBase?): BasicPane
 	local self = setmetatable({}, BasicPane)
 
 	self._maid = Maid.new()
@@ -69,7 +83,7 @@ function BasicPane.new(gui)
 		self.Gui = self._maid:Add(gui)
 	end
 
-	return self
+	return self :: any
 end
 
 --[=[
@@ -77,7 +91,7 @@ end
 	@param value any
 	@return boolean
 ]=]
-function BasicPane.isBasicPane(value)
+function BasicPane.isBasicPane(value: any): boolean
 	return DuckTypeUtils.isImplementation(BasicPane, value)
 end
 
@@ -87,7 +101,7 @@ end
 	@param isVisible boolean -- Whether or not the pane should be visible
 	@param doNotAnimate boolean? -- True if this visiblity should not animate
 ]=]
-function BasicPane:SetVisible(isVisible, doNotAnimate)
+function BasicPane.SetVisible(self: BasicPane, isVisible: boolean, doNotAnimate: boolean?)
 	assert(type(isVisible) == "boolean", "Bad isVisible")
 
 	self._visible:SetValue(isVisible, doNotAnimate)
@@ -98,7 +112,7 @@ end
 
 	@return Observable<boolean, boolean?>
 ]=]
-function BasicPane:ObserveVisible()
+function BasicPane.ObserveVisible(self: BasicPane): _Observable.Observable<boolean, boolean?>
 	return self._visible:Observe()
 end
 
@@ -108,7 +122,10 @@ end
 	@param predicate function | nil -- Optional predicate. If not includeded returns the value.
 	@return Observable<Brio<boolean>>
 ]=]
-function BasicPane:ObserveVisibleBrio(predicate)
+function BasicPane.ObserveVisibleBrio(
+	self: BasicPane,
+	predicate: _Rx.Predicate<boolean>?
+): _Observable.Observable<_Brio.Brio<boolean>?>
 	return self._visible:ObserveBrio(predicate or function(isVisible)
 		return isVisible
 	end)
@@ -118,7 +135,7 @@ end
 	Shows the pane
 	@param doNotAnimate boolean? -- True if this visiblity should not animate
 ]=]
-function BasicPane:Show(doNotAnimate)
+function BasicPane.Show(self: BasicPane, doNotAnimate: boolean?)
 	self:SetVisible(true, doNotAnimate)
 end
 
@@ -126,7 +143,7 @@ end
 	Hides the pane
 	@param doNotAnimate boolean? -- True if this visiblity should not animate
 ]=]
-function BasicPane:Hide(doNotAnimate)
+function BasicPane.Hide(self: BasicPane, doNotAnimate: boolean?)
 	self:SetVisible(false, doNotAnimate)
 end
 
@@ -134,7 +151,7 @@ end
 	Toggles the pane
 	@param doNotAnimate boolean? -- True if this visiblity should not animate
 ]=]
-function BasicPane:Toggle(doNotAnimate)
+function BasicPane.Toggle(self: BasicPane, doNotAnimate: boolean?)
 	self:SetVisible(not self._visible.Value, doNotAnimate)
 end
 
@@ -142,7 +159,7 @@ end
 	Returns if the pane is visible
 	@return boolean
 ]=]
-function BasicPane:IsVisible()
+function BasicPane.IsVisible(self: BasicPane): boolean
 	return self._visible.Value
 end
 
@@ -150,10 +167,10 @@ end
 	Cleans up the BasicPane, invoking Maid:DoCleaning() on the BasicPane and
 	setting the metatable to nil.
 ]=]
-function BasicPane:Destroy()
-	self._maid:DoCleaning()
-	self._maid = nil
-	setmetatable(self, nil)
+function BasicPane.Destroy(self: BasicPane)
+	(self :: any)._maid:DoCleaning();
+	(self :: any)._maid = nil
+	setmetatable(self :: any, nil)
 end
 
 return BasicPane

package/src/Shared/BasicPaneUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	@class BasicPaneUtils
 ]=]
@@ -9,6 +10,7 @@ local Maid = require("Maid")
 local Rx = require("Rx")
 local BasicPane = require("BasicPane")
 local Brio = require("Brio")
+local _Subscription = require("Subscription")
 
 local BasicPaneUtils = {}
 
@@ -24,12 +26,14 @@ local BasicPaneUtils = {}
 	@param basicPane BasicPane
 	@return Observable<boolean>
 ]=]
-function BasicPaneUtils.observeVisible(basicPane)
+function BasicPaneUtils.observeVisible(basicPane: BasicPane.BasicPane): Observable.Observable<boolean>
 	assert(BasicPane.isBasicPane(basicPane), "Bad BasicPane")
 
 	return basicPane:ObserveVisible()
 end
 
+export type CreateBasicPane = (maid: Maid.Maid) -> BasicPane.BasicPane
+
 --[=[
 	Shows the basic pane only when the emitting observable is visible. This
 	allows the basic pane 1 second to hide. If the pane gets reshown in that
@@ -55,14 +59,13 @@ end
 	@param createBasicPane (maid: Maid) -> BasicPane
 	@return (source: Observable<boolean>) -> Observable<Brio<GuiBase>>
 ]=]
-function BasicPaneUtils.whenVisibleBrio(createBasicPane)
-	return function(source)
-		return Observable.new(function(sub)
+function BasicPaneUtils.whenVisibleBrio(createBasicPane: CreateBasicPane) --: Observable.Transformer<(boolean), (Brio.Brio<GuiBase>)>
+	return function(source: Observable.Observable<boolean>): Observable.Observable<Brio.Brio<GuiBase>>
+		return Observable.new(function(sub: _Subscription.Subscription<Brio.Brio<GuiBase>>)
 			local maid = Maid.new()
+			local currentPane: BasicPane.BasicPane? = nil
 
-			local currentPane = nil
-
-			local function ensurePane()
+			local function ensurePane(): BasicPane.BasicPane
 				if currentPane then
 					return currentPane
 				end
@@ -73,7 +76,7 @@ function BasicPaneUtils.whenVisibleBrio(createBasicPane)
 				assert(BasicPane.isBasicPane(basicPane), "Bad BasicPane")
 				paneMaid:GiveTask(basicPane)
 
-				local brio = Brio.new(basicPane.Gui)
+				local brio: Brio.Brio<GuiBase> = Brio.new(basicPane.Gui) :: any
 				paneMaid:GiveTask(brio)
 
 				do
@@ -89,10 +92,10 @@ function BasicPaneUtils.whenVisibleBrio(createBasicPane)
 				maid._currentPaneMaid = paneMaid
 				sub:Fire(brio)
 
-				return currentPane
+				return currentPane :: any
 			end
 
-			maid:GiveTask(source:Subscribe(function(isVisible)
+			maid:GiveTask(source:Subscribe(function(isVisible: boolean)
 				if isVisible then
 					maid._hideTask = nil
 					ensurePane():Show()
@@ -108,7 +111,7 @@ function BasicPaneUtils.whenVisibleBrio(createBasicPane)
 			end))
 
 			return maid
-		end)
+		end) :: any
 	end
 end
 
@@ -118,15 +121,15 @@ end
 	@param basicPane BasicPane
 	@return Observable<number>
 ]=]
-function BasicPaneUtils.observePercentVisible(basicPane)
+function BasicPaneUtils.observePercentVisible(basicPane: BasicPane.BasicPane): Observable.Observable<number>
 	assert(BasicPane.isBasicPane(basicPane), "Bad BasicPane")
 
 	return BasicPaneUtils.observeVisible(basicPane):Pipe({
-		Rx.map(function(visible)
+		Rx.map(function(visible: boolean): number
 			return visible and 1 or 0
-		end);
-		Rx.startWith({0}); -- Ensure fade in every time.
-	})
+		end) :: any,
+		Rx.startWith({ 0 }) :: any, -- Ensure fade in every time.
+	}) :: any
 end
 
 --[=[
@@ -148,12 +151,12 @@ end)
 	@param basicPane BasicPane
 	@return Observable<boolean>
 ]=]
-function BasicPaneUtils.observeShow(basicPane)
+function BasicPaneUtils.observeShow(basicPane: BasicPane.BasicPane): Observable.Observable<boolean>
 	return BasicPaneUtils.observeVisible(basicPane):Pipe({
 		Rx.where(function(isVisible)
 			return isVisible
-		end)
-	})
+		end) :: any,
+	}) :: any
 end
 
-return BasicPaneUtils
+return BasicPaneUtils