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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/characterutils",
-  "version": "12.18.0",
+  "version": "12.18.1",
   "description": "CharacterUtils",
   "keywords": [
     "Roblox",
@@ -25,16 +25,16 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/brio": "^14.17.0",
-    "@quenty/deferred": "^2.2.0",
-    "@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/brio": "^14.17.1",
+    "@quenty/deferred": "^2.2.1",
+    "@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"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e8ea56930e65322fcffc05a1556d5df988068f0b"
+  "gitHead": "78c3ac0ab08dd18085b6e6e6e4f745e76ed99f68"
 }

package/src/Shared/CharacterPromiseUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Utility for Roblox character objects that involve promises.
 	@class CharacterPromiseUtils
@@ -16,7 +17,7 @@ local CharacterPromiseUtils = {}
 	@param player Player
 	@return Promise<Model>
 ]=]
-function CharacterPromiseUtils.promiseCharacter(player)
+function CharacterPromiseUtils.promiseCharacter(player: Player): Promise.Promise<Model>
 	assert(typeof(player) == "Instance", "Bad player")
 
 	local promise = Promise.new()

package/src/Shared/CharacterUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	General character utility code.
 	@class CharacterUtils
@@ -71,7 +72,7 @@ end
 	```lua
 	local Players = game:GetService("Players")
 
-	for _, player in pairs(Players:GetPlayers()) do
+	for _, player in Players:GetPlayers() do
 		CharacterUtils.unequipTools(player)
 	end
 	```
@@ -108,7 +109,8 @@ end
 ]=]
 function CharacterUtils.getPlayerFromCharacter(descendant: Instance): Player?
 	local character = descendant
-	local player = Players:GetPlayerFromCharacter(character)
+	-- TODO: Only use models
+	local player = Players:GetPlayerFromCharacter(character :: any)
 
 	while not player do
 		if character.Parent then

package/src/Shared/RootPartUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Utility functions involving the root part
 	@class RootPartUtils
@@ -24,7 +25,7 @@ local MAX_YIELD_TIME = 60
 	@param humanoid Humanoid
 	@return Promise<BasePart>
 ]=]
-function RootPartUtils.promiseRootPart(humanoid: Humanoid)
+function RootPartUtils.promiseRootPart(humanoid: Humanoid): Promise.Promise<BasePart>
 	if humanoid.RootPart then
 		return Promise.resolved(humanoid.RootPart)
 	end

package/src/Shared/RxCharacterUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Utilities for observing characters and their humanoids.
 	@class RxCharacterUtils
@@ -22,7 +23,7 @@ local RxCharacterUtils = {}
 	@param player Player
 	@return Observable<Brio<Model>>
 ]=]
-function RxCharacterUtils.observeLastCharacterBrio(player: Player)
+function RxCharacterUtils.observeLastCharacterBrio(player: Player): Observable.Observable<Brio.Brio<Model>>
 	-- This assumes a player's 'Character' field is set to nil when
 	-- their character is destroyed, or when they leave the game.
 	return RxInstanceUtils.observePropertyBrio(player, "Character", function(character)
@@ -36,7 +37,7 @@ end
 	@param player Player
 	@return Observable<Model>
 ]=]
-function RxCharacterUtils.observeCharacter(player: Player)
+function RxCharacterUtils.observeCharacter(player: Player): Observable.Observable<Model>
 	return RxInstanceUtils.observeProperty(player, "Character")
 end
 
@@ -46,7 +47,7 @@ end
 	@param player Player
 	@return Observable<Brio<Model>>
 ]=]
-function RxCharacterUtils.observeCharacterBrio(player: Player)
+function RxCharacterUtils.observeCharacterBrio(player: Player): Observable.Observable<Brio.Brio<Model>>
 	return RxInstanceUtils.observePropertyBrio(player, "Character", function(character)
 		return character ~= nil
 	end)
@@ -58,28 +59,28 @@ end
 	@param instance Instance
 	@return Observable<boolean>
 ]=]
-function RxCharacterUtils.observeIsOfLocalCharacter(instance: Instance)
+function RxCharacterUtils.observeIsOfLocalCharacter(instance: Instance): Observable.Observable<boolean>
 	assert(typeof(instance) == "Instance", "Bad instance")
 
 	local localPlayer = Players.LocalPlayer
 	if not localPlayer then
 		warn("[RxCharacterUtils] - No localPlayer")
-		return Rx.EMPTY
+		return Rx.EMPTY :: any
 	end
 
 	return Rx.combineLatest({
 		character = RxCharacterUtils.observeLocalPlayerCharacter(),
 		_ancestry = RxInstanceUtils.observeAncestry(instance),
 	}):Pipe({
-		Rx.map(function(state)
+		Rx.map(function(state: any)
 			if state.character then
 				return instance == state.character or instance:IsDescendantOf(state.character)
 			else
 				return false
 			end
-		end),
-		Rx.distinct(),
-	})
+		end) :: any,
+		Rx.distinct() :: any,
+	}) :: any
 end
 
 --[=[
@@ -88,12 +89,12 @@ end
 	@param instance Instance
 	@return Observable<Brio<boolean>>
 ]=]
-function RxCharacterUtils.observeIsOfLocalCharacterBrio(instance: Instance)
+function RxCharacterUtils.observeIsOfLocalCharacterBrio(instance: Instance): Observable.Observable<Brio.Brio<boolean>>
 	return RxCharacterUtils.observeIsOfLocalCharacter(instance):Pipe({
 		RxBrioUtils.switchToBrio(function(value)
 			return value
 		end),
-	})
+	}) :: any
 end
 
 --[=[
@@ -101,17 +102,17 @@ end
 
 	@return Observable<Model>
 ]=]
-function RxCharacterUtils.observeLocalPlayerCharacter()
+function RxCharacterUtils.observeLocalPlayerCharacter(): Observable.Observable<Model>
 	return RxInstanceUtils.observeProperty(Players, "LocalPlayer"):Pipe({
-		Rx.switchMap(function(player)
+		Rx.switchMap(function(player: Player?): any
 			if player then
 				return RxCharacterUtils.observeCharacter(player)
 			else
 				return Rx.of(nil)
 			end
-		end),
-		Rx.distinct(),
-	})
+		end) :: any,
+		Rx.distinct() :: any,
+	}) :: any
 end
 
 --[=[
@@ -119,12 +120,12 @@ end
 	@param player Player
 	@return Observable<Brio<Humanoid>>
 ]=]
-function RxCharacterUtils.observeLastHumanoidBrio(player: Player)
+function RxCharacterUtils.observeLastHumanoidBrio(player: Player): Observable.Observable<Brio.Brio<Humanoid>>
 	return RxCharacterUtils.observeLastCharacterBrio(player):Pipe({
-		RxBrioUtils.switchMapBrio(function(character)
+		RxBrioUtils.switchMapBrio(function(character: Model)
 			return RxInstanceUtils.observeLastNamedChildBrio(character, "Humanoid", "Humanoid")
-		end),
-	})
+		end) :: any,
+	}) :: any
 end
 
 --[[
@@ -134,7 +135,7 @@ end
 	@param humanoid Humanoid
 	@return Observable<Brio<Humanoid>>
 ]]
-local function observeHumanoidLifetimeAsBrio(humanoid: Humanoid)
+local function observeHumanoidLifetimeAsBrio(humanoid: Humanoid): Observable.Observable<Brio.Brio<Humanoid>>
 	return Observable.new(function(sub)
 		local function onDeath()
 			sub:Complete()
@@ -154,7 +155,7 @@ local function observeHumanoidLifetimeAsBrio(humanoid: Humanoid)
 			onDeath()
 			return nil
 		end
-	end)
+	end) :: any
 end
 
 --[=[
@@ -181,12 +182,12 @@ end
 	@param player Player
 	@return Observable<Brio<Humanoid>>
 ]=]
-function RxCharacterUtils.observeLastAliveHumanoidBrio(player: Player)
+function RxCharacterUtils.observeLastAliveHumanoidBrio(player: Player): Observable.Observable<Brio.Brio<Humanoid>>
 	return RxCharacterUtils.observeLastHumanoidBrio(player):Pipe({
 		RxBrioUtils.switchMapBrio(function(humanoid)
 			return observeHumanoidLifetimeAsBrio(humanoid)
-		end),
-	})
+		end) :: any,
+	}) :: any
 end
 
 return RxCharacterUtils

package/src/Shared/RxRootPartUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	@class RxRootPartUtils
 ]=]
@@ -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 RxRootPartUtils = {}
 
@@ -13,27 +16,27 @@ local RxRootPartUtils = {}
 	Observes the last humanoid root part of a character
 
 	@param character Model
-	@return Brio<BasePart>
+	@return Observable<Brio<BasePart>>
 ]=]
-function RxRootPartUtils.observeHumanoidRootPartBrio(character: Model)
+function RxRootPartUtils.observeHumanoidRootPartBrio(character: Model): _Observable.Observable<_Brio.Brio<BasePart>>
 	-- let's make a reasonable assumption here about name not changing
 	return RxInstanceUtils.observeChildrenBrio(character, function(part)
 		return part:IsA("BasePart") and part.Name == "HumanoidRootPart"
-	end)
+	end) :: any
 end
 
 --[=[
 	Observes the last humanoid root part of a character
 
 	@param humanoid Humanoid
-	@return Brio<BasePart>
+	@return Observvable<Brio<BasePart>>
 ]=]
-function RxRootPartUtils.observeHumanoidRootPartBrioFromHumanoid(humanoid: Humanoid)
+function RxRootPartUtils.observeHumanoidRootPartBrioFromHumanoid(humanoid: Humanoid): _Observable.Observable<_Brio.Brio<BasePart>>
 	return RxInstanceUtils.observeParentBrio(humanoid):Pipe({
-		RxBrioUtils.switchMapBrio(function(character)
+		RxBrioUtils.switchMapBrio(function(character: Model)
 			return RxRootPartUtils.observeHumanoidRootPartBrio(character)
-		end),
-	})
+		end) :: any,
+	}) :: any
 end
 
 return RxRootPartUtils