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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/blend",
-  "version": "12.18.0",
+  "version": "12.18.1",
   "description": "Declarative UI system.",
   "keywords": [
     "Roblox",
@@ -27,24 +27,24 @@
     "access": "public"
   },
   "dependencies": {
-    "@quenty/acceltween": "^2.5.0",
-    "@quenty/brio": "^14.17.0",
-    "@quenty/ducktype": "^5.8.1",
-    "@quenty/instanceutils": "^13.17.0",
-    "@quenty/loader": "^10.8.0",
-    "@quenty/maid": "^3.4.0",
-    "@quenty/promise": "^10.10.1",
-    "@quenty/rx": "^13.17.0",
-    "@quenty/signal": "^7.10.0",
-    "@quenty/spring": "^10.8.1",
-    "@quenty/steputils": "^3.5.3",
-    "@quenty/string": "^3.3.1",
-    "@quenty/valuebaseutils": "^13.17.0",
-    "@quenty/valueobject": "^13.17.0"
+    "@quenty/acceltween": "^2.5.1",
+    "@quenty/brio": "^14.17.1",
+    "@quenty/ducktype": "^5.8.2",
+    "@quenty/instanceutils": "^13.17.1",
+    "@quenty/loader": "^10.8.1",
+    "@quenty/maid": "^3.4.1",
+    "@quenty/promise": "^10.10.2",
+    "@quenty/rx": "^13.17.1",
+    "@quenty/signal": "^7.10.1",
+    "@quenty/spring": "^10.8.2",
+    "@quenty/steputils": "^3.5.4",
+    "@quenty/string": "^3.3.2",
+    "@quenty/valuebaseutils": "^13.17.1",
+    "@quenty/valueobject": "^13.17.1"
   },
   "devDependencies": {
-    "@quenty/contentproviderutils": "^12.17.0",
-    "@quenty/playerthumbnailutils": "^10.10.1"
+    "@quenty/contentproviderutils": "^12.17.1",
+    "@quenty/playerthumbnailutils": "^10.10.2"
   },
-  "gitHead": "e8ea56930e65322fcffc05a1556d5df988068f0b"
+  "gitHead": "78c3ac0ab08dd18085b6e6e6e4f745e76ed99f68"
 }

package/src/Shared/Blend/Blend.lua

@@ -56,7 +56,7 @@ function Blend.New(className: string)
 			local instance = Instance.new(className)
 
 			if BlendDefaultProps[className] then
-				for key, value in pairs(BlendDefaultProps[className]) do
+				for key, value in BlendDefaultProps[className] do
 					instance[key] = value
 				end
 			end
@@ -77,10 +77,10 @@ end
 	Creates a new Blend State which is actually just a ValueObject underneath.
 
 	@param defaultValue T
-	@param checkType string | nil
+	@param checkType string?
 	@return ValueObject<T>
 ]=]
-function Blend.State(defaultValue, checkType)
+function Blend.State<T>(defaultValue: T, checkType: ValueObject.ValueObjectTypeArg?): ValueObject.ValueObject<T>
 	return ValueObject.new(defaultValue, checkType)
 end
 
@@ -93,10 +93,10 @@ end
 	@param observable Observable<T>
 	@return Observable<T>
 ]=]
-function Blend.Throttled(observable)
+function Blend.Throttled<T>(observable: Observable.Observable<T>): Observable.Observable<T>
 	return observable:Pipe({
-		Rx.throttleDefer();
-	})
+		Rx.throttleDefer(),
+	}) :: any
 end
 
 --[=[
@@ -108,27 +108,27 @@ end
 	@param observable Observable<T>
 	@return Observable<T>
 ]=]
-function Blend.Shared(observable)
+function Blend.Shared<T>(observable: Observable.Observable<T>): Observable.Observable<T>
 	return observable:Pipe({
-		Rx.cache();
-	})
+		Rx.cache() :: any,
+	}) :: any
 end
 
 function Blend.Dynamic(...)
-	return Blend.Computed(...)
-		:Pipe({
-			-- This switch map is relatively expensive, so we don't do this for defaul computed
-			-- and instead force the user to switch to another promise
-			Rx.switchMap(function(promise, ...)
-				if Promise.isPromise(promise) then
-					return Rx.fromPromise(promise)
-				elseif Observable.isObservable(promise) then
-					return promise
-				else
-					return Rx.of(promise, ...)
-				end
-			end)
-		})
+	-- stylua: ignore
+	return Blend.Computed(...):Pipe({
+		-- This switch map is relatively expensive, so we don't do this for defaul computed
+		-- and instead force the user to switch to another promise
+		Rx.switchMap(function(promise, ...)
+			if Promise.isPromise(promise) then
+				return Rx.fromPromise(promise) :: any
+			elseif Observable.isObservable(promise) then
+				return promise
+			else
+				return Rx.of(promise, ...)
+			end
+		end) :: any,
+	})
 end
 
 --[=[
@@ -174,7 +174,7 @@ function Blend.Computed(...)
 	else
 		local args = table.create(n - 1)
 
-		for i=1, n - 1 do
+		for i = 1, n - 1 do
 			local found = select(i, ...)
 			local observable = Blend.toPropertyObservable(found)
 			if observable then
@@ -184,12 +184,11 @@ function Blend.Computed(...)
 			end
 		end
 
-		return Rx.combineLatest(args)
-			:Pipe({
-				Rx.map(function(result)
-					return compute(unpack(result, 1, n - 1))
-				end);
-			})
+		return Rx.combineLatest(args):Pipe({
+			Rx.map(function(result)
+				return compute(unpack(result, 1, n - 1))
+			end),
+		})
 	end
 end
 
@@ -209,10 +208,10 @@ end
 	@param propertyName string
 	@return (instance: Instance) -> Observable
 ]=]
-function Blend.OnChange(propertyName)
+function Blend.OnChange(propertyName: string): (instance: Instance) -> Observable.Observable<any>
 	assert(type(propertyName) == "string", "Bad propertyName")
 
-	return function(instance)
+	return function(instance: Instance)
 		return RxInstanceUtils.observeProperty(instance, propertyName)
 	end
 end
@@ -235,7 +234,7 @@ end
 	@param eventName string
 	@return (instance: Instance) -> Observable
 ]=]
-function Blend.OnEvent(eventName)
+function Blend.OnEvent(eventName: string)
 	assert(type(eventName) == "string", "Bad eventName")
 
 	return function(instance)
@@ -281,7 +280,7 @@ function Blend.Attached(constructor)
 
 			return cleanup
 		end)
-	end;
+	end
 end
 
 --[=[
@@ -300,37 +299,40 @@ function Blend.ComputedPairs(source, compute)
 		local maidForKeys = Maid.new()
 		topMaid:GiveTask(maidForKeys)
 
-		topMaid:GiveTask(sourceObservable:Subscribe(function(newValue)
-			-- It's gotta be a table
-			assert(type(newValue) == "table", "Bad value emitted from source")
+		topMaid:GiveTask(
+			sourceObservable:Subscribe(function(newValue)
+				-- It's gotta be a table
+				assert(type(newValue) == "table", "Bad value emitted from source")
 
-			local excluded = {}
-			for key, _ in pairs(cache) do
-				excluded[key] = true
-			end
+				local excluded = {}
+				for key, _ in cache do
+					excluded[key] = true
+				end
 
-			for key, value in pairs(newValue) do
-				excluded[key] = nil
+				for key, value in newValue do
+					excluded[key] = nil
 
-				if cache[key] ~= value then
-					local innerMaid = Maid.new()
-					local result = compute(key, value, innerMaid)
+					if cache[key] ~= value then
+						local innerMaid = Maid.new()
+						local result = compute(key, value, innerMaid)
 
-					local brio = Brio.new(result)
-					innerMaid:GiveTask(brio)
+						local brio = Brio.new(result)
+						innerMaid:GiveTask(brio)
 
-					sub:Fire(brio)
+						sub:Fire(brio)
 
-					maidForKeys[key] = innerMaid
-					cache[key] = value
+						maidForKeys[key] = innerMaid
+						cache[key] = value
+					end
 				end
-			end
 
-			for key, _ in pairs(excluded) do
-				maidForKeys[key] = nil
-				cache[key] = nil
-			end
-		end), sub:GetFailComplete())
+				for key, _ in excluded do
+					maidForKeys[key] = nil
+					cache[key] = nil
+				end
+			end),
+			sub:GetFailComplete()
+		)
 
 		return topMaid
 	end)
@@ -410,7 +412,7 @@ end
 ]=]
 function Blend.Spring(source, speed, damper)
 	if not SpringObject then
-		SpringObject = require("SpringObject")
+		SpringObject = (require :: any)("SpringObject")
 	end
 
 	return Observable.new(function(sub)
@@ -495,7 +497,7 @@ function Blend.toEventHandler(value)
 		-- IntValue, ObjectValue, et cetera
 		if ValueBaseUtils.isValueBase(value) then
 			return function(result)
-				value.Value = result
+				(value :: any).Value = result
 			end
 		end
 	elseif type(value) == "table" then
@@ -572,7 +574,7 @@ end
 	@param value any
 	@return Observable
 ]=]
-function Blend.Children(parent, value)
+function Blend.Children(parent: Instance, value)
 	assert(typeof(parent) == "Instance", "Bad parent")
 
 	local observe = Blend._observeChildren(value, parent)
@@ -601,10 +603,10 @@ end
 	@param value any
 	@return Observable
 ]=]
-function Blend.Tags(parent, value)
+function Blend.Tags(parent: Instance, value)
 	assert(typeof(parent) == "Instance", "Bad parent")
 
-	local observe = Blend._observeTags(value, parent)
+	local observe = Blend._observeTags(value)
 
 	if observe then
 		return observe:Pipe({
@@ -614,14 +616,13 @@ function Blend.Tags(parent, value)
 				else
 					error("Bad tag")
 				end
-			end);
+			end),
 		})
 	else
 		return Rx.EMPTY
 	end
 end
 
-
 function Blend._observeTags(tags)
 	if type(tags) == "string" then
 		return Rx.of(tags)
@@ -672,7 +673,7 @@ end
 	@param className string
 	@return function
 ]=]
-function Blend.Find(className)
+function Blend.Find(className: string)
 	assert(type(className) == "string", "Bad className")
 
 	return function(props)
@@ -705,17 +706,17 @@ function Blend.Find(className)
 				return propertyObservable:Pipe({
 					RxBrioUtils.switchToBrio(function(parent)
 						return parent ~= nil
-					end);
+					end),
 					RxBrioUtils.switchMapBrio(function(parent)
 						assert(typeof(parent) == "Instance", "Bad parent retrieved during find spec")
 
 						return RxInstanceUtils.observeChildrenOfNameBrio(parent, className, props.Name)
-					end);
-					Rx.flatMap(handleChildBrio);
+					end),
+					Rx.flatMap(handleChildBrio),
 				})
 			else
 				return RxInstanceUtils.observeChildrenOfNameBrio(props.Parent, className, props.Name):Pipe({
-					Rx.flatMap(handleChildBrio);
+					Rx.flatMap(handleChildBrio),
 				})
 			end
 		end
@@ -725,7 +726,7 @@ function Blend.Find(className)
 			-- TODO: Swap based upon name
 			-- TODO: Avoid assigning name
 			return RxInstanceUtils.observeChildrenOfNameBrio(parent, className, props.Name):Pipe({
-				Blend._mountToFinding(props);
+				Blend._mountToFinding(props),
 			})
 		end
 	end
@@ -749,7 +750,7 @@ function Blend._mountToFinding(props)
 
 		-- Avoid emitting anything else so we don't get cleaned up
 		return Rx.EMPTY
-	end);
+	end)
 end
 
 --[=[
@@ -802,7 +803,7 @@ end
 	@param parent Instance
 	@return Observable<Instance>
 ]=]
-function Blend.Instance(parent)
+function Blend.Instance(parent: Instance): Observable.Observable<Instance>
 	return Observable.new(function(sub)
 		sub:Fire(parent)
 	end)
@@ -865,9 +866,9 @@ function Blend.Single(observable)
 	end)
 end
 
-function Blend._safeCleanupInstance(result)
+function Blend._safeCleanupInstance(result: Instance)
 	-- Unparent all children incase we want to resurrect them
-	for _, child in pairs(result:GetChildren()) do
+	for _, child in result:GetChildren() do
 		child.Parent = nil
 	end
 	result:Destroy()
@@ -1048,7 +1049,7 @@ function Blend._observeChildren(value, parent)
 
 	if type(value) == "table" and not getmetatable(value) then
 		local observables = {}
-		for key, item in pairs(value) do
+		for key, item in value do
 			local observe = Blend._observeChildren(item, parent)
 			if observe then
 				table.insert(observables, observe)
@@ -1101,7 +1102,7 @@ end
 	@param props table
 	@return Maid
 ]=]
-function Blend.mount(instance, props)
+function Blend.mount(instance: Instance, props)
 	assert(typeof(instance) == "Instance", "Bad instance")
 
 	local maid = Maid.new()
@@ -1110,7 +1111,7 @@ function Blend.mount(instance, props)
 	local dependentObservables = {}
 	local children = {}
 
-	for key, value in pairs(props) do
+	for key, value in props do
 		if type(key) == "string" then
 			if key == "Parent" then
 				parent = value
@@ -1153,7 +1154,7 @@ function Blend.mount(instance, props)
 	end
 
 	-- Subscribe dependentObservables (which includes adding children)
-	for _, event in pairs(dependentObservables) do
+	for _, event in dependentObservables do
 		maid:GiveTask(event[1]:Subscribe(Blend.toEventHandler(event[2])))
 	end
 

package/src/Shared/Blend/SpringObject.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	This is like a [Spring], but it can be observed, and emits events. It handles [Observable]s and
 
@@ -6,7 +7,7 @@
 
 local require = require(script.Parent.loader).load(script)
 
-local RunService= game:GetService("RunService")
+local RunService = game:GetService("RunService")
 
 local Blend = require("Blend")
 local DuckTypeUtils = require("DuckTypeUtils")
@@ -22,6 +23,53 @@ local SpringObject = {}
 SpringObject.ClassName = "SpringObject"
 SpringObject.__index = SpringObject
 
+export type SpringObject<T> = typeof(setmetatable(
+	{} :: {
+		-- Public
+		Changed: Signal.Signal<()>,
+		Observe: (self: SpringObject<T>) -> Observable.Observable<T>,
+		ObserveRenderStepped: (self: SpringObject<T>) -> Observable.Observable<T>,
+		ObserveTarget: (self: SpringObject<T>) -> Observable.Observable<T>,
+		ObserveVelocityOnRenderStepped: (self: SpringObject<T>) -> Observable.Observable<T>,
+		PromiseFinished: (self: SpringObject<T>, signal: RBXScriptSignal?) -> Promise.Promise<boolean>,
+		ObserveVelocityOnSignal: (self: SpringObject<T>, signal: RBXScriptSignal) -> Observable.Observable<T>,
+		ObserveOnSignal: (self: SpringObject<T>, signal: RBXScriptSignal) -> Observable.Observable<T>,
+		IsAnimating: (self: SpringObject<T>) -> boolean,
+		Impulse: (self: SpringObject<T>, velocity: T) -> (),
+		SetTarget: (self: SpringObject<T>, target: T, doNotAnimate: boolean?) -> () -> (),
+		SetVelocity: (self: SpringObject<T>, velocity: T) -> (),
+		SetPosition: (self: SpringObject<T>, position: T) -> (),
+		SetDamper: (self: SpringObject<T>, damper: number | Observable.Observable<number>) -> (),
+		SetSpeed: (self: SpringObject<T>, speed: number | Observable.Observable<number>) -> (),
+		SetClock: (self: SpringObject<T>, clock: Spring.SpringClock) -> (),
+		SetEpsilon: (self: SpringObject<T>, epsilon: number) -> (),
+		TimeSkip: (self: SpringObject<T>, delta: number) -> (),
+		Destroy: (self: SpringObject<T>) -> (),
+
+		-- Properties
+		Value: T,
+		Position: T,
+		p: T,
+		Velocity: T,
+		v: T,
+		Target: T,
+		t: T,
+		Damper: number,
+		d: number,
+		Speed: number,
+		s: number,
+		Clock: Spring.SpringClock,
+		Epsilon: number,
+
+		-- Members
+		_maid: Maid.Maid,
+		_epsilon: number,
+		_currentSpring: Spring.Spring<T>,
+		_initInfo: { Clock: () -> number, Damper: number, Speed: number },
+	},
+	SpringObject
+))
+
 --[=[
 	Constructs a new SpringObject.
 
@@ -36,14 +84,14 @@ SpringObject.__index = SpringObject
 	@param damper number | Observable<number> | NumberValue | any
 	@return Spring<T>
 ]=]
-function SpringObject.new(target, speed, damper)
+function SpringObject.new<T>(target: T, speed, damper): SpringObject<T>
 	local self = setmetatable({
-		_maid = Maid.new();
-		_epsilon = 1e-6;
-		Changed = Signal.new();
+		_maid = Maid.new(),
+		_epsilon = 1e-6,
+		Changed = Signal.new(),
 	}, SpringObject)
 
---[=[
+	--[=[
 	Event fires when the spring value changes
 	@prop Changed Signal<()> -- Fires whenever the spring initially changes state
 	@within SpringObject
@@ -65,7 +113,7 @@ function SpringObject.new(target, speed, damper)
 		self.Damper = damper
 	end
 
-	return self
+	return self :: any
 end
 
 --[=[
@@ -73,7 +121,7 @@ end
 	@param value any
 	@return boolean
 ]=]
-function SpringObject.isSpringObject(value)
+function SpringObject.isSpringObject(value: any): boolean
 	return DuckTypeUtils.isImplementation(SpringObject, value)
 end
 
@@ -186,7 +234,7 @@ function SpringObject:ObserveVelocityOnSignal(signal)
 			if animating then
 				sub:Fire(SpringUtils.fromLinearIfNeeded(currentSpring.Velocity))
 			else
-				sub:Fire(SpringUtils.fromLinearIfNeeded(0*currentSpring.Velocity))
+				sub:Fire(SpringUtils.fromLinearIfNeeded(0 * currentSpring.Velocity))
 			end
 
 			return animating
@@ -232,7 +280,7 @@ end
 	Returns true when we're animating
 	@return boolean -- True if animating
 ]=]
-function SpringObject:IsAnimating()
+function SpringObject:IsAnimating(): boolean
 	local currentSpring = rawget(self, "_currentSpring")
 	if not currentSpring then
 		return false
@@ -261,16 +309,14 @@ end
 	@param target T -- The target to set
 	@param doNotAnimate boolean? -- Whether or not to animate
 ]=]
-function SpringObject:SetTarget(target, doNotAnimate)
+function SpringObject:SetTarget<T>(target: T, doNotAnimate: boolean?)
 	assert(target ~= nil, "Bad target")
 
 	local observable = Blend.toPropertyObservable(target)
 	if not observable then
 		self._maid._targetSub = nil
 		self:_applyTarget(target, doNotAnimate)
-		return function()
-
-		end
+		return function() end
 	end
 
 	local sub
@@ -300,7 +346,7 @@ function SpringObject:SetTarget(target, doNotAnimate)
 	end
 end
 
-function SpringObject:_applyTarget(unconverted, doNotAnimate)
+function SpringObject:_applyTarget(unconverted, doNotAnimate: boolean?)
 	local converted = SpringUtils.toLinearIfNeeded(unconverted)
 	self:_getSpringForType(converted):SetTarget(converted, doNotAnimate)
 	self.Changed:Fire()
@@ -328,7 +374,7 @@ end
 function SpringObject:_applyVelocity(unconverted)
 	local converted = SpringUtils.toLinearIfNeeded(unconverted)
 
-	self:_getSpringForType(0*converted).Velocity = converted
+	self:_getSpringForType(0 * (converted :: any)).Velocity = converted
 	self.Changed:Fire()
 end
 
@@ -377,8 +423,8 @@ function SpringObject:SetDamper(damper)
 	end
 end
 
-function SpringObject:_applyDamper(unconverted)
-	assert(type(unconverted) == "number", "Bad damper")
+function SpringObject:_applyDamper(unconverted: number)
+	assert(type(unconverted) == "number", "Bad unconverted")
 
 	local currentSpring = rawget(self, "_currentSpring")
 	if currentSpring then
@@ -410,8 +456,8 @@ function SpringObject:SetSpeed(speed)
 	end
 end
 
-function SpringObject:_applySpeed(unconverted)
-	assert(type(unconverted) == "number", "Bad damper")
+function SpringObject:_applySpeed(unconverted: number)
+	assert(type(unconverted) == "number", "Bad unconverted")
 
 	local currentSpring = rawget(self, "_currentSpring")
 	if currentSpring then
@@ -428,7 +474,7 @@ end
 
 	@param clock () -> (number)
 ]=]
-function SpringObject:SetClock(clock)
+function SpringObject:SetClock(clock: Spring.SpringClock)
 	assert(type(clock) == "function", "Bad clock clock")
 
 	local currentSpring = rawget(self, "_currentSpring")
@@ -446,7 +492,7 @@ end
 
 	@param epsilon number
 ]=]
-function SpringObject:SetEpsilon(epsilon)
+function SpringObject:SetEpsilon(epsilon: number)
 	assert(type(epsilon) == "number", "Bad epsilon")
 
 	rawset(self, "_epsilon", epsilon)
@@ -459,7 +505,7 @@ end
 	@param delta number -- Time to skip forwards
 	@return ()
 ]=]
-function SpringObject:TimeSkip(delta)
+function SpringObject:TimeSkip(delta: number)
 	assert(type(delta) == "number", "Bad delta")
 
 	local currentSpring = rawget(self, "_currentSpring")
@@ -471,7 +517,7 @@ function SpringObject:TimeSkip(delta)
 	self.Changed:Fire()
 end
 
-function SpringObject:__index(index)
+(SpringObject :: any).__index = function(self, index)
 	local currentSpring = rawget(self, "_currentSpring")
 
 	if SpringObject[index] then
@@ -498,19 +544,19 @@ function SpringObject:__index(index)
 		if currentSpring then
 			return currentSpring.Damper
 		else
-			return self:_getInitInfo().Damper
+			return (self :: any):_getInitInfo().Damper
 		end
 	elseif index == "Speed" or index == "s" then
 		if currentSpring then
 			return currentSpring.Speed
 		else
-			return self:_getInitInfo().Speed
+			return (self :: any):_getInitInfo().Speed
 		end
 	elseif index == "Clock" then
 		if currentSpring then
 			return currentSpring.Clock
 		else
-			return self:_getInitInfo().Clock
+			return (self :: any):_getInitInfo().Clock
 		end
 	elseif index == "Epsilon" then
 		return self._epsilon

package/src/Shared/Test/BlendComputePairs.story.lua

@@ -23,7 +23,7 @@ return function(target)
 				Size = UDim2.new(0, 100, 0, 20);
 				[Blend.OnEvent "Activated"] = function()
 					local newState = {}
-					for _, item in pairs(state.Value) do
+					for _, item in state.Value do
 						table.insert(newState, item)
 					end
 					table.insert(newState, string.char(string.byte("a") + #newState))