@quenty/attributeutils 6.1.0 → 6.2.0

package/CHANGELOG.md

@@ -3,6 +3,18 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [6.2.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/attributeutils@6.1.0...@quenty/attributeutils@6.2.0) (2022-07-31)
+
+
+### Features
+
+* Add AttributeUtils.isValidAttributeType(valueType) ([b77392b](https://github.com/Quenty/NevermoreEngine/commit/b77392b4e373c297fdc7b79bd26ef218ac327f18))
+* Add RxAttributeUtils.observeAttributeBrio API call ([e0e827f](https://github.com/Quenty/NevermoreEngine/commit/e0e827fcf9a17c4ff0ecad0209bcc976912ae3b5))
+
+
+
+
+
 # [6.1.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/attributeutils@6.0.0...@quenty/attributeutils@6.1.0) (2022-06-21)
 
 **Note:** Version bump only for package @quenty/attributeutils

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/attributeutils",
-  "version": "6.1.0",
+  "version": "6.2.0",
   "description": "Provides utility functions to work with attributes in Roblox",
   "keywords": [
     "Roblox",
@@ -25,12 +25,14 @@
     "Quenty"
   ],
   "dependencies": {
+    "@quenty/brio": "^6.2.0",
     "@quenty/loader": "^5.0.0",
-    "@quenty/maid": "^2.3.0",
-    "@quenty/rx": "^5.1.0"
+    "@quenty/maid": "^2.4.0",
+    "@quenty/rx": "^5.2.0",
+    "@quenty/symbol": "^2.1.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "c8732cc5dea767b3ff362db43137e2a16da7bc0d"
+  "gitHead": "e31b3a35aa475bb5699a24898a8639e107165b36"
 }

package/src/Shared/AttributeUtils.lua

@@ -11,6 +11,37 @@ local Maid = require("Maid")
 
 local AttributeUtils = {}
 
+local VALID_ATTRIBUTE_TYPES = {
+	["nil"] = true;
+	["string"] = true;
+	["boolean"] = true;
+	["number"] = true;
+	["UDim"] = true;
+	["UDim2"] = true;
+	["BrickColor"] = true;
+	["Color3"] = true;
+	["Vector2"] = true;
+	["Vector3"] = true;
+	["NumberSequence"] = true;
+	["ColorSequence"] = true;
+	["NumberRange"] = true;
+	["Rect"] = true;
+}
+
+--[=[
+	Returns whether the attribute is a valid type or not for an attribute.
+
+	```lua
+	print(AttributeUtils.isValidAttributeType(typeof("hi"))) --> true
+	```
+
+	@param valueType string
+	@return boolean
+]=]
+function AttributeUtils.isValidAttributeType(valueType)
+	return VALID_ATTRIBUTE_TYPES[valueType] == true
+end
+
 --[=[
 	Whenever the attribute is true, the binder will be bound, and when the
 	binder is bound, the attribute will be true.

package/src/Shared/RxAttributeUtils.lua

@@ -5,8 +5,12 @@
 
 local require = require(script.Parent.loader).load(script)
 
-local Observable = require("Observable")
+local Brio = require("Brio")
 local Maid = require("Maid")
+local Observable = require("Observable")
+local Symbol = require("Symbol")
+
+local UNSET_VALUE = Symbol.named("unsetValue")
 
 local RxAttributeUtils = {}
 
@@ -24,17 +28,62 @@ function RxAttributeUtils.observeAttribute(instance, attributeName, defaultValue
 	return Observable.new(function(sub)
 		local maid = Maid.new()
 
-		local function update()
-			local value = instance:GetAttribute(attributeName)
-			if value == nil then
+		local function handleAttributeChanged()
+			local attributeValue = instance:GetAttribute(attributeName)
+			if attributeValue == nil then
 				sub:Fire(defaultValue)
 			else
-				sub:Fire(value)
+				sub:Fire(attributeValue)
+			end
+		end
+
+		maid:GiveTask(instance:GetAttributeChangedSignal(attributeName):Connect(handleAttributeChanged))
+		handleAttributeChanged()
+
+		return maid
+	end)
+end
+
+--[=[
+	Observes an attribute on an instance with a conditional statement.
+	@param instance Instance
+	@param attributeName string
+	@param condition function
+	@return Observable<Brio<any>>
+]=]
+function RxAttributeUtils.observeAttributeBrio(instance, attributeName, condition)
+	assert(typeof(instance) == "Instance", "Bad instance")
+	assert(type(attributeName) == "string", "Bad attributeName")
+
+	return Observable.new(function(sub)
+		local maid = Maid.new()
+		local lastValue = UNSET_VALUE
+
+		local function handleAttributeChanged()
+			local attributeValue = instance:GetAttribute(attributeName)
+
+			-- Deferred events can cause multiple values to be queued at once
+			-- but we operate at this post-deferred layer, so lets only output
+			-- reflected values.
+			if lastValue ~= attributeValue then
+				lastValue = attributeValue
+
+				if not condition or condition(attributeValue) then
+					local brio = Brio.new(attributeValue)
+					maid._lastBrio = brio
+
+					-- The above line can cause us to be overwritten so make sure before firing.
+					if maid._lastBrio == brio then
+						sub:Fire(brio)
+					end
+				else
+					maid._lastBrio = nil
+				end
 			end
 		end
 
-		maid:GiveTask(instance:GetAttributeChangedSignal(attributeName):Connect(update))
-		update()
+		maid:GiveTask(instance:GetAttributeChangedSignal(attributeName):Connect(handleAttributeChanged))
+		handleAttributeChanged()
 
 		return maid
 	end)