@quenty/valuebaseutils 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/valuebaseutils@13.17.0...@quenty/valuebaseutils@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/valuebaseutils@13.16.2...@quenty/valuebaseutils@13.17.0) (2025-04-02)
 
 **Note:** Version bump only for package @quenty/valuebaseutils

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/valuebaseutils",
-  "version": "13.17.0",
+  "version": "13.17.1",
   "description": "Provides utilities for working with valuesbase objects, like IntValue or ObjectValue in Roblox.",
   "keywords": [
     "Roblox",
@@ -25,15 +25,15 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/brio": "^14.17.0",
-    "@quenty/instanceutils": "^13.17.0",
-    "@quenty/loader": "^10.8.0",
-    "@quenty/promise": "^10.10.1",
-    "@quenty/rx": "^13.17.0",
-    "@quenty/rxsignal": "^7.17.0"
+    "@quenty/brio": "^14.17.1",
+    "@quenty/instanceutils": "^13.17.1",
+    "@quenty/loader": "^10.8.1",
+    "@quenty/promise": "^10.10.2",
+    "@quenty/rx": "^13.17.1",
+    "@quenty/rxsignal": "^7.17.1"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e8ea56930e65322fcffc05a1556d5df988068f0b"
+  "gitHead": "78c3ac0ab08dd18085b6e6e6e4f745e76ed99f68"
 }

package/src/Shared/RxValueBaseUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	@class RxValueBaseUtils
 ]=]
@@ -6,6 +7,8 @@ local require = require(script.Parent.loader).load(script)
 
 local RxInstanceUtils = require("RxInstanceUtils")
 local RxBrioUtils = require("RxBrioUtils")
+local _Observable = require("Observable")
+local _Brio = require("Brio")
 
 local RxValueBaseUtils = {}
 
@@ -18,19 +21,21 @@ local RxValueBaseUtils = {}
 	@param predicate callback -- Optional callback
 	@return Observable<Brio<any>>
 ]=]
-function RxValueBaseUtils.observeBrio(parent, className, name, predicate)
+function RxValueBaseUtils.observeBrio(
+	parent: Instance,
+	className: string,
+	name: string,
+	predicate: ((any) -> boolean)?
+): _Observable.Observable<_Brio.Brio<any>>
 	assert(typeof(parent) == "Instance", "Bad parent")
 	assert(type(className) == "string", "Bad className")
 	assert(type(name) == "string", "Bad naem")
 
-	return RxInstanceUtils.observeLastNamedChildBrio(parent, className, name)
-		:Pipe({
-			RxBrioUtils.switchMapBrio(function(valueObject)
-				return RxValueBaseUtils.observeValue(valueObject)
-			end),
-			RxBrioUtils.onlyLastBrioSurvives(),
-			predicate and RxBrioUtils.where(predicate) or nil;
-		})
+	return RxInstanceUtils.observeLastNamedChildBrio(parent, className, name):Pipe({
+		RxBrioUtils.switchMapBrio(RxValueBaseUtils.observeValue) :: any,
+		RxBrioUtils.onlyLastBrioSurvives() :: any,
+		if predicate then RxBrioUtils.where(predicate) else nil :: never,
+	}) :: any
 end
 
 --[=[
@@ -42,15 +47,19 @@ end
 	@param defaultValue any
 	@return Observable<any>
 ]=]
-function RxValueBaseUtils.observe(parent, className, name, defaultValue)
+function RxValueBaseUtils.observe(
+	parent: Instance,
+	className: string,
+	name: string,
+	defaultValue: any?
+): _Observable.Observable<any>
 	assert(typeof(parent) == "Instance", "Bad parent")
 	assert(type(className) == "string", "Bad className")
 	assert(type(name) == "string", "Bad name")
 
-	return RxValueBaseUtils.observeBrio(parent, className, name)
-		:Pipe({
-			RxBrioUtils.emitOnDeath(defaultValue)
-		})
+	return RxValueBaseUtils.observeBrio(parent, className, name):Pipe({
+		RxBrioUtils.emitOnDeath(defaultValue) :: any,
+	}) :: any
 end
 
 
@@ -59,7 +68,7 @@ end
 	@param valueObject Instance
 	@return Observable<T>
 ]=]
-function RxValueBaseUtils.observeValue(valueObject)
+function RxValueBaseUtils.observeValue(valueObject): _Observable.Observable<any>
 	assert(typeof(valueObject) == "Instance", "Bad valueObject")
 
 	return RxInstanceUtils.observeProperty(valueObject, "Value")

package/src/Shared/ValueBaseUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Provides utilities for working with ValueBase objects, like [IntValue] or [ObjectValue] in Roblox.
 
@@ -7,39 +8,51 @@
 local ValueBaseUtils = {}
 
 local TYPE_TO_CLASSNAME_LOOKUP = {
-	["nil"] = "ObjectValue";
-	boolean = "BoolValue";
-	number = "NumberValue";
-	string = "StringValue";
-
-	BrickColor = "BrickColorValue";
-	CFrame = "CFrameValue";
-	Color3 = "Color3Value";
-	Instance = "ObjectValue";
-	Ray = "RayValue";
-	Vector3 = "Vector3Value";
+	["nil"] = "ObjectValue",
+	boolean = "BoolValue",
+	number = "NumberValue",
+	string = "StringValue",
+
+	BrickColor = "BrickColorValue",
+	CFrame = "CFrameValue",
+	Color3 = "Color3Value",
+	Instance = "ObjectValue",
+	Ray = "RayValue",
+	Vector3 = "Vector3Value",
 }
 
 local VALUE_BASE_TYPE_LOOKUP = {
-	BoolValue = "boolean";
-	NumberValue = "number";
-	IntValue = "number";
-	StringValue = "string";
-	BrickColorValue = "BrickColor";
-	CFrameValue = "CFrame";
-	Color3Value = "Color3";
-	ObjectValue = "Instance";
-	RayValue = "Ray";
-	Vector3Value = "Vector3";
+	BoolValue = "boolean",
+	NumberValue = "number",
+	IntValue = "number",
+	StringValue = "string",
+	BrickColorValue = "BrickColor",
+	CFrameValue = "CFrame",
+	Color3Value = "Color3",
+	ObjectValue = "Instance",
+	RayValue = "Ray",
+	Vector3Value = "Vector3",
 }
 
+export type ValueBaseType =
+	"BoolValue"
+	| "NumberValue"
+	| "IntValue"
+	| "StringValue"
+	| "BrickColorValue"
+	| "CFrameValue"
+	| "Color3Value"
+	| "ObjectValue"
+	| "RayValue"
+	| "Vector3Value"
+
 --[=[
 	Returns true if the value is a ValueBase instance
 
 	@param instance Instance
 	@return boolean
 ]=]
-function ValueBaseUtils.isValueBase(instance)
+function ValueBaseUtils.isValueBase(instance: Instance): boolean
 	return typeof(instance) == "Instance" and instance:IsA("ValueBase")
 end
 
@@ -49,7 +62,7 @@ end
 	@param valueBaseClassName string
 	@return string?
 ]=]
-function ValueBaseUtils.getValueBaseType(valueBaseClassName)
+function ValueBaseUtils.getValueBaseType(valueBaseClassName: ValueBaseType): string?
 	return VALUE_BASE_TYPE_LOOKUP[valueBaseClassName]
 end
 
@@ -59,7 +72,7 @@ end
 	@param luaType string
 	@return string?
 ]=]
-function ValueBaseUtils.getClassNameFromType(luaType)
+function ValueBaseUtils.getClassNameFromType(luaType: string): string?
 	return TYPE_TO_CLASSNAME_LOOKUP[luaType]
 end
 
@@ -72,7 +85,12 @@ end
 	@param defaultValue any?
 	@return Instance
 ]=]
-function ValueBaseUtils.getOrCreateValue(parent, instanceType, name, defaultValue)
+function ValueBaseUtils.getOrCreateValue(
+	parent: Instance,
+	instanceType: ValueBaseType,
+	name: string,
+	defaultValue
+): Instance
 	assert(typeof(parent) == "Instance", "Bad argument 'parent'")
 	assert(type(instanceType) == "string", "Bad argument 'instanceType'")
 	assert(type(name) == "string", "Bad argument 'name'")
@@ -80,12 +98,20 @@ function ValueBaseUtils.getOrCreateValue(parent, instanceType, name, defaultValu
 	local foundChild = parent:FindFirstChild(name)
 	if foundChild then
 		if not foundChild:IsA(instanceType) then
-			warn(string.format("[ValueBaseUtils.getOrCreateValue] - Value of type %q of name %q is of type %q in %s instead", instanceType, name, foundChild.ClassName, foundChild:GetFullName()))
+			warn(
+				string.format(
+					"[ValueBaseUtils.getOrCreateValue] - Value of type %q of name %q is of type %q in %s instead",
+					instanceType,
+					name,
+					foundChild.ClassName,
+					foundChild:GetFullName()
+				)
+			)
 		end
 
 		return foundChild
 	else
-		local newChild = Instance.new(instanceType)
+		local newChild: any = Instance.new(instanceType)
 		newChild.Name = name
 		newChild.Value = defaultValue
 		newChild.Parent = parent
@@ -103,7 +129,7 @@ end
 	@param value any
 	@return any
 ]=]
-function ValueBaseUtils.setValue(parent, instanceType, name, value)
+function ValueBaseUtils.setValue(parent: Instance, instanceType: ValueBaseType, name: string, value: any)
 	assert(typeof(parent) == "Instance", "Bad argument 'parent'")
 	assert(type(instanceType) == "string", "Bad argument 'instanceType'")
 	assert(type(name) == "string", "Bad argument 'name'")
@@ -111,12 +137,20 @@ function ValueBaseUtils.setValue(parent, instanceType, name, value)
 	local foundChild = parent:FindFirstChild(name)
 	if foundChild then
 		if not foundChild:IsA(instanceType) then
-			warn(string.format("[ValueBaseUtils.setValue] - Value of type %q of name %q is of type %q in %s instead", instanceType, name, foundChild.ClassName, foundChild:GetFullName()))
+			warn(
+				string.format(
+					"[ValueBaseUtils.setValue] - Value of type %q of name %q is of type %q in %s instead",
+					instanceType,
+					name,
+					foundChild.ClassName,
+					foundChild:GetFullName()
+				)
+			)
 		end
 
-		foundChild.Value = value
+		(foundChild :: any).Value = value
 	else
-		local newChild = Instance.new(instanceType)
+		local newChild: any = Instance.new(instanceType)
 		newChild.Name = name
 		newChild.Value = value
 		newChild.Parent = parent
@@ -132,7 +166,7 @@ end
 	@param default any?
 	@return any
 ]=]
-function ValueBaseUtils.getValue(parent, instanceType, name, default)
+function ValueBaseUtils.getValue(parent: Instance, instanceType: ValueBaseType, name: string, default: any?)
 	assert(typeof(parent) == "Instance", "Bad argument 'parent'")
 	assert(type(instanceType) == "string", "Bad argument 'instanceType'")
 	assert(type(name) == "string", "Bad argument 'name'")
@@ -140,9 +174,17 @@ function ValueBaseUtils.getValue(parent, instanceType, name, default)
 	local foundChild = parent:FindFirstChild(name)
 	if foundChild then
 		if foundChild:IsA(instanceType) then
-			return foundChild.Value
+			return (foundChild :: any).Value
 		else
-			warn(string.format("[ValueBaseUtils.getValue] - Value of type %q of name %q is of type %q in %s instead", instanceType, name, foundChild.ClassName, foundChild:GetFullName()))
+			warn(
+				string.format(
+					"[ValueBaseUtils.getValue] - Value of type %q of name %q is of type %q in %s instead",
+					instanceType,
+					name,
+					foundChild.ClassName,
+					foundChild:GetFullName()
+				)
+			)
 			return nil
 		end
 	else
@@ -159,7 +201,7 @@ end
 	@return function
 	@return function
 ]=]
-function ValueBaseUtils.createGetSet(instanceType, name)
+function ValueBaseUtils.createGetSet(instanceType: ValueBaseType, name: string)
 	assert(type(instanceType) == "string", "Bad argument 'instanceType'")
 	assert(type(name) == "string", "Bad argument 'name'")
 

package/src/Shared/ValueBaseValue.lua

@@ -12,12 +12,41 @@ local Rx = require("Rx")
 local RxSignal = require("RxSignal")
 local RxValueBaseUtils = require("RxValueBaseUtils")
 local ValueBaseUtils = require("ValueBaseUtils")
+local _Observable = require("Observable")
+local _Brio = require("Brio")
 
 local ValueBaseValue = {}
 ValueBaseValue.ClassName = "ValueBaseValue"
 ValueBaseValue.__index = ValueBaseValue
 
-function ValueBaseValue.new(parent, className, name, defaultValue)
+export type ValueBaseValue = typeof(setmetatable(
+	{} :: {
+		_parent: Instance,
+		_className: ValueBaseUtils.ValueBaseType,
+		_name: string,
+		_defaultValue: any?,
+		Value: any?,
+		Changed: RxSignal.RxSignal<any>,
+	},
+	ValueBaseValue
+))
+
+--[=[
+	Constructs a ValueBaseValue object. This is a wrapper around the value base
+	underneath the parent. It will create the value base if it does not exist.
+
+	@param parent Instance
+	@param className string
+	@param name string
+	@param defaultValue any?
+	@return ValueBaseValue
+]=]
+function ValueBaseValue.new(
+	parent: Instance,
+	className: ValueBaseUtils.ValueBaseType,
+	name: string,
+	defaultValue: any?
+): ValueBaseValue
 	assert(typeof(parent) == "Instance", "Bad argument 'parent'")
 	assert(type(className) == "string", "Bad argument 'className'")
 	assert(type(name) == "string", "Bad argument 'name'")
@@ -34,23 +63,38 @@ function ValueBaseValue.new(parent, className, name, defaultValue)
 		ValueBaseUtils.getOrCreateValue(parent, self._className, self._name, self._defaultValue)
 	end
 
-	return setmetatable(self, ValueBaseValue)
+	return setmetatable(self, ValueBaseValue) :: any
 end
 
-function ValueBaseValue:ObserveBrio(predicate)
+--[=[
+	Observes the value base value. This will return a brio of the value base
+	underneath the parent.
+
+	@param predicate ((any) -> boolean)? -- Optional callback
+	@return Observable<Brio<any>>
+]=]
+function ValueBaseValue.ObserveBrio(
+	self: ValueBaseValue,
+	predicate: Rx.Predicate<any>?
+): _Observable.Observable<_Brio.Brio<any>>
 	return RxValueBaseUtils.observeBrio(self._parent, self._className, self._name, predicate)
 end
 
-function ValueBaseValue:Observe()
+--[=[
+	Observes the value base value's
+
+	@return Observable<any>
+]=]
+function ValueBaseValue.Observe(self: ValueBaseValue): _Observable.Observable<any>
 	return RxValueBaseUtils.observe(self._parent, self._className, self._name, self._defaultValue)
 end
 
-function ValueBaseValue:__index(index)
+(ValueBaseValue :: any).__index = function(self: any, index)
 	if index == "Value" then
 		return ValueBaseUtils.getValue(self._parent, self._className, self._name, self._defaultValue)
 	elseif index == "Changed" then
 		return RxSignal.new(self:Observe():Pipe({
-			Rx.skip(1)
+			Rx.skip(1),
 		}))
 	elseif ValueBaseValue[index] or index == "_defaultValue" then
 		return ValueBaseValue[index]
@@ -59,7 +103,7 @@ function ValueBaseValue:__index(index)
 	end
 end
 
-function ValueBaseValue:__newindex(index, value)
+function ValueBaseValue.__newindex(self: ValueBaseValue, index, value)
 	if index == "Value" then
 		ValueBaseUtils.setValue(self._parent, self._className, self._name, value)
 	else