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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/attributeutils",
-  "version": "14.17.0",
+  "version": "14.17.1-canary.545.2374fb2.0",
   "description": "Provides utility functions to work with attributes in Roblox",
   "keywords": [
     "Roblox",
@@ -25,17 +25,17 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/brio": "^14.17.0",
-    "@quenty/canceltoken": "^11.11.1",
-    "@quenty/loader": "^10.8.0",
-    "@quenty/maid": "^3.4.0",
-    "@quenty/promise": "^10.10.1",
-    "@quenty/rx": "^13.17.0",
-    "@quenty/rxsignal": "^7.17.0",
-    "@quenty/symbol": "^3.4.0"
+    "@quenty/brio": "14.17.1-canary.545.2374fb2.0",
+    "@quenty/canceltoken": "11.11.2-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/rxsignal": "7.17.1-canary.545.2374fb2.0",
+    "@quenty/symbol": "3.4.1-canary.545.2374fb2.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e8ea56930e65322fcffc05a1556d5df988068f0b"
+  "gitHead": "2374fb2b043cfbe0e9b507b3316eec46a4e353a0"
 }

package/src/Shared/AttributeUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Provides utility functions to work with attributes in Roblox
 	@class AttributeUtils
@@ -17,26 +18,28 @@ end
 
 local AttributeUtils = {}
 
-local VALID_ATTRIBUTE_TYPES = {
-	["nil"] = true;
-	["string"] = true;
-	["boolean"] = true;
-	["number"] = true;
-	["UDim"] = true;
-	["UDim2"] = true;
-	["BrickColor"] = true;
-	["CFrame"] = true;
-	["Color3"] = true;
-	["Vector2"] = true;
-	["Vector3"] = true;
-	["NumberSequence"] = true;
-	["ColorSequence"] = true;
-	["IntValue"] = true;
-	["NumberRange"] = true;
-	["Rect"] = true;
-	["Font"] = true;
-	["EnumItem"] = true;
-}
+type ValidAttributeMap = { [string]: true }
+
+local VALID_ATTRIBUTE_TYPES: ValidAttributeMap = table.freeze({
+	["nil"] = true,
+	["string"] = true,
+	["boolean"] = true,
+	["number"] = true,
+	["UDim"] = true,
+	["UDim2"] = true,
+	["BrickColor"] = true,
+	["CFrame"] = true,
+	["Color3"] = true,
+	["Vector2"] = true,
+	["Vector3"] = true,
+	["NumberSequence"] = true,
+	["ColorSequence"] = true,
+	["IntValue"] = true,
+	["NumberRange"] = true,
+	["Rect"] = true,
+	["Font"] = true,
+	["EnumItem"] = true,
+} :: ValidAttributeMap)
 
 --[=[
 	Returns whether the attribute is a valid type or not for an attribute.
@@ -48,7 +51,7 @@ local VALID_ATTRIBUTE_TYPES = {
 	@param valueType string
 	@return boolean
 ]=]
-function AttributeUtils.isValidAttributeType(valueType)
+function AttributeUtils.isValidAttributeType(valueType: string): boolean
 	return VALID_ATTRIBUTE_TYPES[valueType] == true
 end
 
@@ -61,7 +64,7 @@ end
 	@param cancelToken CancelToken
 	@return Promise<any>
 ]=]
-function AttributeUtils.promiseAttribute(instance, attributeName, predicate, cancelToken)
+function AttributeUtils.promiseAttribute(instance: Instance, attributeName: string, predicate, cancelToken)
 	assert(typeof(instance) == "Instance", "Bad instance")
 	assert(type(attributeName) == "string", "Bad attributeName")
 	assert(CancelToken.isCancelToken(cancelToken) or cancelToken == nil, "Bad cancelToken")
@@ -99,7 +102,6 @@ function AttributeUtils.promiseAttribute(instance, attributeName, predicate, can
 	return promise
 end
 
-
 --[=[
 	Whenever the attribute is true, the binder will be bound, and when the
 	binder is bound, the attribute will be true.
@@ -109,7 +111,7 @@ end
 	@param binder Binder<T>
 	@return Maid
 ]=]
-function AttributeUtils.bindToBinder(instance, attributeName, binder)
+function AttributeUtils.bindToBinder(instance: Instance, attributeName: string, binder): Maid.Maid
 	assert(binder, "Bad binder")
 	assert(typeof(instance) == "Instance", "Bad instance")
 	assert(type(attributeName) == "string", "Bad attributeName")
@@ -174,7 +176,7 @@ end
 	@param default any
 	@return any? -- The value of the attribute
 ]=]
-function AttributeUtils.initAttribute(instance, attributeName, default)
+function AttributeUtils.initAttribute(instance: Instance, attributeName: string, default: any): any
 	assert(typeof(instance) == "Instance", "Bad instance")
 	assert(typeof(attributeName) == "string", "Bad attributeName")
 
@@ -194,7 +196,7 @@ end
 	@param default T?
 	@return T?
 ]=]
-function AttributeUtils.getAttribute(instance, attributeName, default)
+function AttributeUtils.getAttribute(instance: Instance, attributeName: string, default: any): any
 	local value = instance:GetAttribute(attributeName)
 	if value == nil then
 		return default
@@ -211,7 +213,7 @@ end
 function AttributeUtils.removeAllAttributes(instance: Instance)
 	assert(typeof(instance) == "Instance", "Bad instance")
 
-	for key, _ in pairs(instance:GetAttributes()) do
+	for key, _ in instance:GetAttributes() do
 		instance:SetAttribute(key, nil)
 	end
 end

package/src/Shared/AttributeValue.lua

@@ -20,11 +20,28 @@
 local require = require(script.Parent.loader).load(script)
 
 local RxAttributeUtils = require("RxAttributeUtils")
+local _Observable = require("Observable")
+local _Brio = require("Brio")
+local _Rx = require("Rx")
 
 local AttributeValue = {}
 AttributeValue.ClassName = "AttributeValue"
 AttributeValue.__index = AttributeValue
 
+export type AttributeValue<T> = typeof(setmetatable(
+	{} :: {
+		_object: Instance,
+		_attributeName: string,
+		_defaultValue: T?,
+
+		-- Public
+		Value: T?,
+		AttributeName: string,
+		Changed: RBXScriptSignal<(T)>,
+	},
+	AttributeValue
+))
+
 --[=[
 	Constructs a new AttributeValue. If a defaultValue that is not nil
 	is defined, then this value will be set on the Roblox object.
@@ -34,21 +51,21 @@ AttributeValue.__index = AttributeValue
 	@param defaultValue T?
 	@return AttributeValue<T>
 ]=]
-function AttributeValue.new(object, attributeName, defaultValue)
+function AttributeValue.new<T>(object: Instance, attributeName: string, defaultValue: any?): AttributeValue<T>
 	assert(typeof(object) == "Instance", "Bad object")
 	assert(type(attributeName) == "string", "Bad attributeName")
 
 	local self = {
-		_object = object;
-		_attributeName = attributeName;
-		_defaultValue = defaultValue;
+		_object = object,
+		_attributeName = attributeName,
+		_defaultValue = defaultValue,
 	}
 
 	if defaultValue ~= nil and self._object:GetAttribute(self._attributeName) == nil then
 		self._object:SetAttribute(rawget(self, "_attributeName"), defaultValue)
 	end
 
-	return setmetatable(self, AttributeValue)
+	return setmetatable(self, AttributeValue) :: any
 end
 
 --[=[
@@ -57,7 +74,10 @@ end
 	@param condition function | nil
 	@return Observable<Brio<any>>
 ]=]
-function AttributeValue:ObserveBrio(condition)
+function AttributeValue.ObserveBrio<T>(
+	self: AttributeValue<T>,
+	condition: _Rx.Predicate<T>?
+): _Observable.Observable<_Brio.Brio<any>>
 	return RxAttributeUtils.observeAttributeBrio(self._object, self._attributeName, condition)
 end
 
@@ -65,8 +85,8 @@ end
 	Observes an attribute on an instance.
 	@return Observable<any>
 ]=]
-function AttributeValue:Observe()
-	return RxAttributeUtils.observeAttribute(self._object, self._attributeName, rawget(self, "_defaultValue"))
+function AttributeValue.Observe<T>(self: AttributeValue<T>): _Observable.Observable<T?>
+	return RxAttributeUtils.observeAttribute(self._object, self._attributeName, rawget(self :: any, "_defaultValue"))
 end
 
 --[=[
@@ -82,12 +102,12 @@ end
 	@prop Changed Signal<()>
 	@within AttributeValue
 ]=]
-function AttributeValue:__index(index)
+function AttributeValue.__index<T>(self: AttributeValue<T>, index)
 	if AttributeValue[index] then
 		return AttributeValue[index]
 	elseif index == "Value" then
-		local result = self._object:GetAttribute(rawget(self, "_attributeName"))
-		local default = rawget(self, "_defaultValue")
+		local result = self._object:GetAttribute(rawget(self :: any, "_attributeName"))
+		local default = rawget(self :: any, "_defaultValue")
 		if result == nil then
 			return default
 		else
@@ -96,15 +116,17 @@ function AttributeValue:__index(index)
 	elseif index == "Changed" then
 		return self._object:GetAttributeChangedSignal(self._attributeName)
 	elseif index == "AttributeName" then
-		return rawget(self, "_attributeName")
+		return rawget(self :: any, "_attributeName")
 	else
 		error(string.format("%q is not a member of AttributeValue", tostring(index)))
 	end
 end
 
-function AttributeValue:__newindex(index, value)
+function AttributeValue.__newindex<T>(self: AttributeValue<T>, index, value)
 	if index == "Value" then
-		self._object:SetAttribute(rawget(self, "_attributeName"), value)
+		self._object:SetAttribute(rawget(self :: any, "_attributeName"), value)
+	elseif index == "AttributeName" then
+		error("Cannot set AttributeName")
 	else
 		error(string.format("%q is not a member of AttributeValue", tostring(index)))
 	end

package/src/Shared/RxAttributeUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Utility functions involving attributes.
 	@class RxAttributeUtils
@@ -9,6 +10,7 @@ local Brio = require("Brio")
 local Maid = require("Maid")
 local Observable = require("Observable")
 local Symbol = require("Symbol")
+local _Rx = require("Rx")
 
 local UNSET_VALUE = Symbol.named("unsetValue")
 
@@ -21,7 +23,11 @@ local RxAttributeUtils = {}
 	@param defaultValue any?
 	@return Observable<any>
 ]=]
-function RxAttributeUtils.observeAttribute(instance, attributeName, defaultValue)
+function RxAttributeUtils.observeAttribute<T>(
+	instance: Instance,
+	attributeName: string,
+	defaultValue: T?
+): Observable.Observable<T>
 	assert(typeof(instance) == "Instance", "Bad instance")
 	assert(type(attributeName) == "string", "Bad attributeName")
 
@@ -39,7 +45,7 @@ function RxAttributeUtils.observeAttribute(instance, attributeName, defaultValue
 		handleAttributeChanged()
 
 		return connection
-	end)
+	end) :: any
 end
 
 --[=[
@@ -47,15 +53,15 @@ end
 	@param instance Instance
 	@return Observable<Brio<string>>
 ]=]
-function RxAttributeUtils.observeAttributeKeysBrio(instance)
+function RxAttributeUtils.observeAttributeKeysBrio(instance: Instance): Observable.Observable<Brio.Brio<string>>
 	assert(typeof(instance) == "Instance", "Bad instance")
 
 	return Observable.new(function(sub)
 		local maid = Maid.new()
 
-		local attributeNameToBrio = {}
+		local attributeNameToBrio: { [string]: any } = {}
 
-		local function handleAttributeChanged(attributeName, attributeValue)
+		local function handleAttributeChanged(attributeName: string, attributeValue: any)
 			if attributeValue == nil then
 				local brio = attributeNameToBrio[attributeName]
 				if brio then
@@ -64,7 +70,7 @@ function RxAttributeUtils.observeAttributeKeysBrio(instance)
 				end
 			else
 				if not attributeNameToBrio[attributeName] then
-					local brio = Brio.new(attributeName)
+					local brio: any = Brio.new(attributeName)
 					attributeNameToBrio[attributeName] = brio
 					maid[brio] = brio
 					sub:Fire(brio)
@@ -86,7 +92,7 @@ function RxAttributeUtils.observeAttributeKeysBrio(instance)
 		end
 
 		return maid
-	end)
+	end) :: any
 end
 
 --[=[
@@ -95,7 +101,7 @@ end
 	@param instance Instance
 	@return Observable<string>
 ]=]
-function RxAttributeUtils.observeAttributeKeys(instance)
+function RxAttributeUtils.observeAttributeKeys(instance: Instance): Observable.Observable<string>
 	assert(typeof(instance) == "Instance", "Bad instance")
 
 	return Observable.new(function(sub)
@@ -114,7 +120,7 @@ function RxAttributeUtils.observeAttributeKeys(instance)
 		end
 
 		return maid
-	end)
+	end) :: any
 end
 
 --[=[
@@ -124,7 +130,7 @@ end
 	@param condition function | nil
 	@return Observable<Brio<any>>
 ]=]
-function RxAttributeUtils.observeAttributeBrio(instance, attributeName, condition)
+function RxAttributeUtils.observeAttributeBrio<T>(instance: Instance, attributeName: string, condition: _Rx.Predicate<T>?): Observable.Observable<Brio.Brio<T>>
 	assert(typeof(instance) == "Instance", "Bad instance")
 	assert(type(attributeName) == "string", "Bad attributeName")
 
@@ -141,7 +147,7 @@ function RxAttributeUtils.observeAttributeBrio(instance, attributeName, conditio
 			if lastValue ~= attributeValue then
 				lastValue = attributeValue
 
-				if not condition or condition(attributeValue) then
+				if not condition or condition(attributeValue :: T) then
 					local brio = Brio.new(attributeValue)
 					maid._lastBrio = brio
 
@@ -159,7 +165,7 @@ function RxAttributeUtils.observeAttributeBrio(instance, attributeName, conditio
 		handleAttributeChanged()
 
 		return maid
-	end)
+	end) :: any
 end
 
 return RxAttributeUtils