@quenty/basicpane 9.0.0 → 10.0.0

package/CHANGELOG.md

@@ -3,6 +3,58 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [10.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/basicpane@9.0.0...@quenty/basicpane@10.0.0) (2024-02-13)
+
+
+### Features
+
+* New loader (breaking changes), fixing loader issues  ([#439](https://github.com/Quenty/NevermoreEngine/issues/439)) ([3534345](https://github.com/Quenty/NevermoreEngine/commit/353434522918812953bd9f13fece73e27a4d034d))
+
+
+### BREAKING CHANGES
+
+* Standard loader
+
+Adds new loader version which replicates full structure instead of some partial structure. This allows us to have hot-reloading (in the future), as well as generally do less computation, handle dependencies more carefully, and other changes.
+
+This means you'll need to change you how require client-side modules, as we export a simple `loader` module instead of all modules available.
+
+Signed-off-by: James Onnen <jonnen0@gmail.com>
+
+* fix: Fix missing dependency in ResetService
+
+* feat: Add RxPhysicsUtils.observePartMass
+
+* fix: Fix package discovery for games
+
+* feat: Add UIAlignmentUtils.verticalToHorizontalAlignment(verticalAlignment) and UIAlignmentUtils.horizontalToVerticalAlignment(horizontalAlignment)
+
+* feat: AdorneeData:InitAttributes() does not require data as a  secondparameter
+
+* ci: Upgrade to new rojo 7.4.0
+
+* fix: Update loader to handle hoarcekat properly
+
+* docs: Fix spacing in Maid
+
+* fix: Add new ragdoll constants
+
+* fix: Compress influxDB sends
+
+* style: Errors use string.format
+
+* fix: Handle motor animations
+
+* ci: Upgrade rojo version
+
+* feat!: Maid no longer is includd in ValueObject.Changed event
+
+* docs: Fix docs
+
+
+
+
+
 # [9.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/basicpane@8.4.0...@quenty/basicpane@9.0.0) (2024-01-10)
 
 **Note:** Version bump only for package @quenty/basicpane

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/basicpane",
-  "version": "9.0.0",
+  "version": "10.0.0",
   "description": "Base UI object with visibility and a maid",
   "keywords": [
     "Roblox",
@@ -25,14 +25,16 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/brio": "^10.0.0",
-    "@quenty/loader": "^7.3.0",
-    "@quenty/maid": "^2.6.0",
-    "@quenty/rx": "^9.0.0",
-    "@quenty/signal": "^4.0.0"
+    "@quenty/brio": "^11.0.0",
+    "@quenty/ducktype": "^3.0.0",
+    "@quenty/loader": "^8.0.0",
+    "@quenty/maid": "^3.0.0",
+    "@quenty/rx": "^10.0.0",
+    "@quenty/signal": "^5.0.0",
+    "@quenty/valueobject": "^10.0.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "bf8135721716c976201cb82133e0186ea606b166"
+  "gitHead": "5736b108e4d23cd4c9e761bbe4cc9fed6fb32dfa"
 }

package/src/Shared/BasicPane.lua

@@ -23,7 +23,8 @@ local require = require(script.Parent.loader).load(script)
 
 local Signal = require("Signal")
 local Maid = require("Maid")
-local Observable = require("Observable")
+local DuckTypeUtils = require("DuckTypeUtils")
+local ValueObject = require("ValueObject")
 
 local BasicPane = {}
 BasicPane.__index = BasicPane
@@ -35,35 +36,9 @@ BasicPane.ClassName = "BasicPane"
 	@return boolean
 ]=]
 function BasicPane.isBasicPane(value)
-	return type(value) == "table"
-		and Maid.isMaid(value._maid)
-		and Signal.isSignal(value.VisibleChanged)
-		and type(value.SetVisible) == "function"
-		and type(value.IsVisible) == "function"
-		and type(value.Show) == "function"
-		and type(value.ObserveVisible) == "function"
-		and type(value.Hide) == "function"
-		and type(value.Toggle) == "function"
-		and type(value.Destroy) == "function"
+	return DuckTypeUtils.isImplementation(BasicPane, value)
 end
 
---[=[
-	Gui object which can be reparented or whatever
-
-	@prop Gui Instance?
-	@within BasicPane
-]=]
---[=[
-	Fires whenever visibility changes. FIres with isVisible, doNotAnimate, and a maid which
-	has the lifetime of the visibility.
-
-	:::info
-	Do not use the Maid if you want the code to work in Deferred signal mode.
-	:::
-
-	@prop VisibleChanged Signal<boolean, boolean, Maid>
-	@within BasicPane
-]=]
 
 --[=[
 	Constructs a new BasicPane with the .Gui property set.
@@ -75,16 +50,33 @@ function BasicPane.new(gui)
 	local self = setmetatable({}, BasicPane)
 
 	self._maid = Maid.new()
-	self.Maid = self._maid
+	self._visible = self._maid:Add(ValueObject.new(false, "boolean"))
+
+	--[=[
+		Fires whenever visibility changes. FIres with isVisible, doNotAnimate, and a maid which
+		has the lifetime of the visibility.
 
-	self._visible = false
+		:::info
+		Do not use the Maid if you want the code to work in Deferred signal mode.
+		:::
 
-	self.VisibleChanged = self._maid:Add(Signal.new()) -- :Fire(isVisible, doNotAnimate, maid)
+		@prop VisibleChanged Signal<boolean, boolean>
+		@within BasicPane
+	]=]
+	self.VisibleChanged = self._maid:Add(Signal.new()) -- :Fire(isVisible, doNotAnimate)
+
+	self._maid:GiveTask(self._visible.Changed:Connect(function(isVisible, _, doNotAnimate)
+		self.VisibleChanged:Fire(isVisible, doNotAnimate)
+	end))
 
 	if gui then
-		self._gui = gui
-		self.Gui = gui
-		self._maid:GiveTask(gui)
+		--[=[
+			Gui object which can be reparented or whatever
+
+			@prop Gui Instance?
+			@within BasicPane
+		]=]
+		self.Gui = self._maid:Add(gui)
 	end
 
 	return self
@@ -99,25 +91,27 @@ end
 function BasicPane:SetVisible(isVisible, doNotAnimate)
 	assert(type(isVisible) == "boolean", "Bad isVisible")
 
-	if self._visible ~= isVisible then
-		self._visible = isVisible
-
-		local maid = Maid.new()
-		self._maid._paneVisibleMaid = maid
-		self.VisibleChanged:Fire(self._visible, doNotAnimate, maid)
-	end
+	self._visible:SetValue(isVisible, doNotAnimate)
 end
 
+--[=[
+	Returns an observable that observes visibility
+
+	@return Observable<boolean>
+]=]
 function BasicPane:ObserveVisible()
-	return Observable.new(function(sub)
-		local maid = Maid.new()
+	return self._visible:Observe()
+end
 
-		maid:GiveTask(self.VisibleChanged:Connect(function(isVisible, doNotAnimate)
-			sub:Fire(isVisible, doNotAnimate)
-		end))
-		sub:Fire(self:IsVisible())
+--[=[
+	Returns an observable that observes visibility
 
-		return maid
+	@param predicate function | nil -- Optional predicate. If not includeded returns the value.
+	@return Observable<Brio<boolean>>
+]=]
+function BasicPane:ObserveVisibleBrio(predicate)
+	return self._visible:ObserveBrio(predicate or function(value)
+		return value
 	end)
 end
 
@@ -142,7 +136,7 @@ end
 	@param doNotAnimate boolean? -- True if this visiblity should not animate
 ]=]
 function BasicPane:Toggle(doNotAnimate)
-	self:SetVisible(not self._visible, doNotAnimate)
+	self:SetVisible(not self._visible.Value, doNotAnimate)
 end
 
 --[=[
@@ -150,7 +144,7 @@ end
 	@return boolean
 ]=]
 function BasicPane:IsVisible()
-	return self._visible
+	return self._visible.Value
 end
 
 --[=[

package/src/Shared/BasicPaneUtils.lua

@@ -27,16 +27,7 @@ local BasicPaneUtils = {}
 function BasicPaneUtils.observeVisible(basicPane)
 	assert(BasicPane.isBasicPane(basicPane), "Bad BasicPane")
 
-	return Observable.new(function(sub)
-		local maid = Maid.new()
-
-		maid:GiveTask(basicPane.VisibleChanged:Connect(function(isVisible)
-			sub:Fire(isVisible)
-		end))
-		sub:Fire(basicPane:IsVisible())
-
-		return maid
-	end)
+	return basicPane:ObserveVisible()
 end
 
 --[=[