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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/deathreport",
-  "version": "10.21.0",
+  "version": "10.21.1-canary.545.2374fb2.0",
   "description": "Death report service which will track the deaths of players",
   "keywords": [
     "Roblox",
@@ -29,19 +29,19 @@
     "access": "public"
   },
   "dependencies": {
-    "@quenty/baseobject": "^10.8.0",
-    "@quenty/binder": "^14.19.0",
-    "@quenty/characterutils": "^12.18.0",
-    "@quenty/humanoidkillerutils": "^2.3.1",
-    "@quenty/loader": "^10.8.0",
-    "@quenty/maid": "^3.4.0",
-    "@quenty/playerhumanoidbinder": "^14.19.0",
-    "@quenty/remoting": "^12.18.0",
-    "@quenty/rx": "^13.17.0",
-    "@quenty/rxbinderutils": "^14.19.0",
-    "@quenty/servicebag": "^11.11.1",
-    "@quenty/signal": "^7.10.0",
-    "@quenty/table": "^3.7.1"
+    "@quenty/baseobject": "10.8.1-canary.545.2374fb2.0",
+    "@quenty/binder": "14.19.1-canary.545.2374fb2.0",
+    "@quenty/characterutils": "12.18.1-canary.545.2374fb2.0",
+    "@quenty/humanoidkillerutils": "2.3.2-canary.545.2374fb2.0",
+    "@quenty/loader": "10.8.1-canary.545.2374fb2.0",
+    "@quenty/maid": "3.4.1-canary.545.2374fb2.0",
+    "@quenty/playerhumanoidbinder": "14.19.1-canary.545.2374fb2.0",
+    "@quenty/remoting": "12.18.1-canary.545.2374fb2.0",
+    "@quenty/rx": "13.17.1-canary.545.2374fb2.0",
+    "@quenty/rxbinderutils": "14.19.1-canary.545.2374fb2.0",
+    "@quenty/servicebag": "11.11.2-canary.545.2374fb2.0",
+    "@quenty/signal": "7.10.1-canary.545.2374fb2.0",
+    "@quenty/table": "3.7.2-canary.545.2374fb2.0"
   },
-  "gitHead": "e8ea56930e65322fcffc05a1556d5df988068f0b"
+  "gitHead": "2374fb2b043cfbe0e9b507b3316eec46a4e353a0"
 }

package/src/Client/DeathReportServiceClient.lua

@@ -14,6 +14,7 @@ local DeathReportServiceConstants = require("DeathReportServiceConstants")
 local PromiseGetRemoteEvent = require("PromiseGetRemoteEvent")
 local DeathReportProcessor = require("DeathReportProcessor")
 local DeathReportUtils = require("DeathReportUtils")
+local _ServiceBag = require("ServiceBag")
 
 -- Note: don't make this too big without upgrading the way we handle the queue
 local MAX_DEATH_REPORTS = 5
@@ -27,7 +28,7 @@ DeathReportServiceClient.ServiceName = "DeathReportServiceClient"
 
 	@param serviceBag ServiceBag
 ]=]
-function DeathReportServiceClient:Init(serviceBag)
+function DeathReportServiceClient:Init(serviceBag: _ServiceBag.ServiceBag)
 	assert(not self._serviceBag, "Already initialized")
 	self._serviceBag = assert(serviceBag, "No serviceBag")
 	self._maid = Maid.new()

package/src/Client/Stats/PlayerDeathTrackerClient.lua

@@ -5,12 +5,13 @@
 local require = require(script.Parent.loader).load(script)
 
 local BaseObject = require("BaseObject")
+local _ServiceBag = require("ServiceBag")
 
 local PlayerDeathTrackerClient = setmetatable({}, BaseObject)
 PlayerDeathTrackerClient.ClassName = "PlayerDeathTrackerClient"
 PlayerDeathTrackerClient.__index = PlayerDeathTrackerClient
 
-function PlayerDeathTrackerClient.new(tracker, serviceBag)
+function PlayerDeathTrackerClient.new(tracker, serviceBag: _ServiceBag.ServiceBag)
 	local self = setmetatable(BaseObject.new(tracker), PlayerDeathTrackerClient)
 
 	self._serviceBag = assert(serviceBag, "No serviceBag")

package/src/Client/Stats/PlayerKillTrackerClient.lua

@@ -5,12 +5,13 @@
 local require = require(script.Parent.loader).load(script)
 
 local BaseObject = require("BaseObject")
+local _ServiceBag = require("ServiceBag")
 
 local PlayerKillTrackerClient = setmetatable({}, BaseObject)
 PlayerKillTrackerClient.ClassName = "PlayerKillTrackerClient"
 PlayerKillTrackerClient.__index = PlayerKillTrackerClient
 
-function PlayerKillTrackerClient.new(tracker, serviceBag)
+function PlayerKillTrackerClient.new(tracker, serviceBag: _ServiceBag.ServiceBag)
 	local self = setmetatable(BaseObject.new(tracker), PlayerKillTrackerClient)
 
 	self._serviceBag = assert(serviceBag, "No serviceBag")

package/src/Server/DeathReportService.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Centralized death reporting service which can be used to track
 	deaths.
@@ -14,25 +15,41 @@ local DeathReportServiceConstants = require("DeathReportServiceConstants")
 local DeathReportUtils = require("DeathReportUtils")
 local Maid = require("Maid")
 local DeathReportProcessor = require("DeathReportProcessor")
+local _ServiceBag = require("ServiceBag")
+local _Observable = require("Observable")
 
 local DeathReportService = {}
 DeathReportService.ServiceName = "DeathReportService"
 
+export type DeathReportService = typeof(setmetatable(
+	{} :: {
+		_serviceBag: any,
+		_maid: Maid.Maid,
+		NewDeathReport: Signal.Signal<DeathReportUtils.DeathReport>,
+		_remoteEvent: RemoteEvent,
+		_reportProcessor: DeathReportProcessor.DeathReportProcessor,
+		_weaponDataRetrievers: { GetWeaponData },
+	},
+	{ __index = DeathReportService }
+))
+
+export type GetWeaponData = (humanoid: Humanoid) -> DeathReportUtils.WeaponData?
+
 --[=[
 	Initializes the DeathReportService. Should be done via [ServiceBag].
 
 	@param serviceBag ServiceBag
 ]=]
-function DeathReportService:Init(serviceBag)
+function DeathReportService.Init(self: DeathReportService, serviceBag: _ServiceBag.ServiceBag)
 	assert(not self._serviceBag, "Already initialized")
 	self._serviceBag = assert(serviceBag, "No serviceBag")
 	self._maid = Maid.new()
 
 	-- Internal
-	self._serviceBag:GetService(require("DeathReportBindersServer"))
+	self._serviceBag:GetService((require :: any)("DeathReportBindersServer"))
 
 	-- Export
-	self.NewDeathReport = self._maid:Add(Signal.new())
+	self.NewDeathReport = self._maid:Add(Signal.new()) :: any
 
 	-- State
 	self._remoteEvent = GetRemoteEvent(DeathReportServiceConstants.REMOTE_EVENT_NAME)
@@ -41,7 +58,7 @@ function DeathReportService:Init(serviceBag)
 	self._weaponDataRetrievers = {}
 end
 
-function DeathReportService:AddWeaponDataRetriever(getWeaponData)
+function DeathReportService.AddWeaponDataRetriever(self: DeathReportService, getWeaponData: GetWeaponData)
 	table.insert(self._weaponDataRetrievers, getWeaponData)
 
 	return function()
@@ -52,10 +69,10 @@ function DeathReportService:AddWeaponDataRetriever(getWeaponData)
 	end
 end
 
-function DeathReportService:FindWeaponData(humanoid)
+function DeathReportService.FindWeaponData(self: DeathReportService, humanoid: Humanoid): DeathReportUtils.WeaponData?
 	assert(typeof(humanoid) == "Instance", "Bad humanoid")
 
-	for _, item in pairs(self._weaponDataRetrievers) do
+	for _, item in self._weaponDataRetrievers do
 		local result = item(humanoid)
 		if result then
 			assert(DeathReportUtils.isWeaponData(result), "Failed to return valid weaponData")
@@ -73,7 +90,10 @@ end
 	@param player Player
 	@return Observable<DeathReport>
 ]=]
-function DeathReportService:ObservePlayerKillerReports(player)
+function DeathReportService.ObservePlayerKillerReports(
+	self: DeathReportService,
+	player: Player
+): _Observable.Observable<DeathReportUtils.DeathReport>
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 
 	return self._reportProcessor:ObservePlayerKillerReports(player)
@@ -85,7 +105,10 @@ end
 	@param player Player
 	@return Observable<DeathReport>
 ]=]
-function DeathReportService:ObservePlayerDeathReports(player)
+function DeathReportService.ObservePlayerDeathReports(
+	self: DeathReportService,
+	player: Player
+): _Observable.Observable<DeathReportUtils.DeathReport>
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 
 	return self._reportProcessor:ObservePlayerDeathReports(player)
@@ -97,7 +120,10 @@ end
 	@param humanoid Humanoid
 	@return Observable<DeathReport>
 ]=]
-function DeathReportService:ObserveHumanoidKillerReports(humanoid)
+function DeathReportService.ObserveHumanoidKillerReports(
+	self: DeathReportService,
+	humanoid: Humanoid
+): _Observable.Observable<DeathReportUtils.DeathReport>
 	assert(typeof(humanoid) == "Instance" and humanoid:IsA("Humanoid"), "Bad humanoid")
 
 	return self._reportProcessor:ObserveHumanoidKillerReports(humanoid)
@@ -109,7 +135,10 @@ end
 	@param humanoid Humanoid
 	@return Observable<DeathReport>
 ]=]
-function DeathReportService:ObserveHumanoidDeathReports(humanoid)
+function DeathReportService.ObserveHumanoidDeathReports(
+	self: DeathReportService,
+	humanoid: Humanoid
+): _Observable.Observable<DeathReportUtils.DeathReport>
 	assert(typeof(humanoid) == "Instance" and humanoid:IsA("Humanoid"), "Bad humanoid")
 
 	return self._reportProcessor:ObserveHumanoidDeathReports(humanoid)
@@ -121,7 +150,10 @@ end
 	@param character Model
 	@return Observable<DeathReport>
 ]=]
-function DeathReportService:ObserveCharacterKillerReports(character)
+function DeathReportService.ObserveCharacterKillerReports(
+	self: DeathReportService,
+	character: Model
+): _Observable.Observable<DeathReportUtils.DeathReport>
 	assert(typeof(character) == "Instance" and character:IsA("Model"), "Bad character")
 
 	return self._reportProcessor:ObserveCharacterKillerReports(character)
@@ -133,7 +165,10 @@ end
 	@param character Model
 	@return Observable<DeathReport>
 ]=]
-function DeathReportService:ObserveCharacterDeathReports(character)
+function DeathReportService.ObserveCharacterDeathReports(
+	self: DeathReportService,
+	character: Model
+): _Observable.Observable<DeathReportUtils.DeathReport>
 	assert(typeof(character) == "Instance" and character:IsA("Model"), "Bad character")
 
 	return self._reportProcessor:ObserveCharacterDeathReports(character)
@@ -146,7 +181,11 @@ end
 	@param humanoid Humanoid -- Humanoid that died
 	@param weaponData WeaponData? -- Weapon data to report
 ]=]
-function DeathReportService:ReportHumanoidDeath(humanoid, weaponData)
+function DeathReportService.ReportHumanoidDeath(
+	self: DeathReportService,
+	humanoid: Humanoid,
+	weaponData: DeathReportUtils.WeaponData?
+)
 	assert(typeof(humanoid) == "Instance", "Bad humanoid")
 
 	local report = DeathReportUtils.fromDeceasedHumanoid(humanoid, weaponData or self:FindWeaponData(humanoid))
@@ -154,7 +193,7 @@ function DeathReportService:ReportHumanoidDeath(humanoid, weaponData)
 	self:ReportDeathReport(report)
 end
 
-function DeathReportService:ReportDeathReport(deathReport)
+function DeathReportService.ReportDeathReport(self: DeathReportService, deathReport: DeathReportUtils.DeathReport)
 	assert(DeathReportUtils.isDeathReport(deathReport), "Bad deathReport")
 
 	-- Notify services
@@ -166,7 +205,7 @@ function DeathReportService:ReportDeathReport(deathReport)
 	self._remoteEvent:FireAllClients(deathReport)
 end
 
-function DeathReportService:Destroy()
+function DeathReportService.Destroy(self: DeathReportService)
 	self._maid:DoCleaning()
 end
 

package/src/Server/DeathTrackedHumanoid.lua

@@ -11,7 +11,7 @@ local DeathTrackedHumanoid = setmetatable({}, BaseObject)
 DeathTrackedHumanoid.ClassName = "DeathTrackedHumanoid"
 DeathTrackedHumanoid.__index = DeathTrackedHumanoid
 
-function DeathTrackedHumanoid.new(humanoid, serviceBag)
+function DeathTrackedHumanoid.new(humanoid: Humanoid, serviceBag)
 	local self = setmetatable(BaseObject.new(humanoid), DeathTrackedHumanoid)
 
 	self._serviceBag = assert(serviceBag, "No serviceBag")

package/src/Server/Stats/PlayerDeathTracker.lua

@@ -6,12 +6,13 @@ local require = require(script.Parent.loader).load(script)
 
 local BaseObject = require("BaseObject")
 local DeathReportService = require("DeathReportService")
+local _ServiceBag = require("ServiceBag")
 
 local PlayerDeathTracker = setmetatable({}, BaseObject)
 PlayerDeathTracker.ClassName = "PlayerDeathTracker"
 PlayerDeathTracker.__index = PlayerDeathTracker
 
-function PlayerDeathTracker.new(scoreObject, serviceBag)
+function PlayerDeathTracker.new(scoreObject, serviceBag: _ServiceBag.ServiceBag)
 	local self = setmetatable(BaseObject.new(scoreObject), PlayerDeathTracker)
 
 	self._serviceBag = assert(serviceBag, "No serviceBag")

package/src/Server/Stats/PlayerKillTracker.lua

@@ -6,12 +6,13 @@ local require = require(script.Parent.loader).load(script)
 
 local BaseObject = require("BaseObject")
 local DeathReportService = require("DeathReportService")
+local _ServiceBag = require("ServiceBag")
 
 local PlayerKillTracker = setmetatable({}, BaseObject)
 PlayerKillTracker.ClassName = "PlayerKillTracker"
 PlayerKillTracker.__index = PlayerKillTracker
 
-function PlayerKillTracker.new(scoreObject, serviceBag)
+function PlayerKillTracker.new(scoreObject, serviceBag: _ServiceBag.ServiceBag)
 	local self = setmetatable(BaseObject.new(scoreObject), PlayerKillTracker)
 
 	self._serviceBag = assert(serviceBag, "No serviceBag")
@@ -20,10 +21,12 @@ function PlayerKillTracker.new(scoreObject, serviceBag)
 	self._player = self._obj.Parent
 	assert(self._player and self._player:IsA("Player"), "Bad player")
 
-	self._maid:GiveTask(self._deathReportService:ObservePlayerKillerReports(self._player):Subscribe(function(deathReport)
-		assert(deathReport.killerPlayer == self._player, "Bad player")
-		self._obj.Value = self._obj.Value + 1
-	end))
+	self._maid:GiveTask(
+		self._deathReportService:ObservePlayerKillerReports(self._player):Subscribe(function(deathReport)
+			assert(deathReport.killerPlayer == self._player, "Bad player")
+			self._obj.Value = self._obj.Value + 1
+		end)
+	)
 
 	return self
 end
@@ -32,11 +35,11 @@ function PlayerKillTracker:GetKillValue()
 	return self._obj
 end
 
-function PlayerKillTracker:GetPlayer()
+function PlayerKillTracker:GetPlayer(): Player
 	return self._obj.Parent
 end
 
-function PlayerKillTracker:GetKills()
+function PlayerKillTracker:GetKills(): number
 	return self._obj.Value
 end
 

package/src/Server/Stats/PlayerKillTrackerAssigner.lua

@@ -10,12 +10,13 @@ local BaseObject = require("BaseObject")
 local Maid = require("Maid")
 local PlayerKillTrackerUtils = require("PlayerKillTrackerUtils")
 local DeathReportBindersServer = require("DeathReportBindersServer")
+local _ServiceBag = require("ServiceBag")
 
 local PlayerKillTrackerAssigner = setmetatable({}, BaseObject)
 PlayerKillTrackerAssigner.ClassName = "PlayerKillTrackerAssigner"
 PlayerKillTrackerAssigner.__index = PlayerKillTrackerAssigner
 
-function PlayerKillTrackerAssigner.new(serviceBag)
+function PlayerKillTrackerAssigner.new(serviceBag: _ServiceBag.ServiceBag)
 	local self = setmetatable(BaseObject.new(), PlayerKillTrackerAssigner)
 
 	self._serviceBag = assert(serviceBag, "No serviceBag")
@@ -30,14 +31,14 @@ function PlayerKillTrackerAssigner.new(serviceBag)
 		self:_handlePlayerRemoving(player)
 	end))
 
-	for _, player in pairs(Players:GetPlayers()) do
+	for _, player in Players:GetPlayers() do
 		self:_handlePlayerAdded(player)
 	end
 
 	return self
 end
 
-function PlayerKillTrackerAssigner:GetPlayerKills(player)
+function PlayerKillTrackerAssigner:GetPlayerKills(player: Player)
 	local tracker = self:GetPlayerKillTracker(player)
 	if tracker then
 		return tracker:GetKills()
@@ -46,7 +47,7 @@ function PlayerKillTrackerAssigner:GetPlayerKills(player)
 	end
 end
 
-function PlayerKillTrackerAssigner:GetPlayerKillTracker(player)
+function PlayerKillTrackerAssigner:GetPlayerKillTracker(player: Player)
 	local trackerInstance = self._killTrackers[player]
 	if trackerInstance then
 		return self._deathReportBindersServer.PlayerKillTracker:Get(trackerInstance)

package/src/Shared/DeathReportProcessor.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Handles shared observable subscription tables for the client and server
 
@@ -11,31 +12,33 @@ local Players = game:GetService("Players")
 local BaseObject = require("BaseObject")
 local ObservableSubscriptionTable = require("ObservableSubscriptionTable")
 local DeathReportUtils = require("DeathReportUtils")
+local _Observable = require("Observable")
 
 local DeathReportProcessor = setmetatable({}, BaseObject)
 DeathReportProcessor.ClassName = "DeathReportProcessor"
 DeathReportProcessor.__index = DeathReportProcessor
 
-function DeathReportProcessor.new()
-	local self = setmetatable(BaseObject.new(), DeathReportProcessor)
-
-	self._playerKillerSubTable = ObservableSubscriptionTable.new()
-	self._maid:GiveTask(self._playerKillerSubTable)
-
-	self._playerDeathSubTable = ObservableSubscriptionTable.new()
-	self._maid:GiveTask(self._playerDeathSubTable)
-
-	self._humanoidKillerSubTable = ObservableSubscriptionTable.new()
-	self._maid:GiveTask(self._humanoidKillerSubTable)
-
-	self._humanoidDeathSubTable = ObservableSubscriptionTable.new()
-	self._maid:GiveTask(self._humanoidDeathSubTable)
-
-	self._characterKillerSubTable = ObservableSubscriptionTable.new()
-	self._maid:GiveTask(self._characterKillerSubTable)
-
-	self._characterDeathSubTable = ObservableSubscriptionTable.new()
-	self._maid:GiveTask(self._characterDeathSubTable)
+export type DeathReportProcessor = typeof(setmetatable(
+	{} :: {
+		_playerKillerSubTable: ObservableSubscriptionTable.ObservableSubscriptionTable<DeathReportUtils.DeathReport>,
+		_playerDeathSubTable: ObservableSubscriptionTable.ObservableSubscriptionTable<DeathReportUtils.DeathReport>,
+		_humanoidKillerSubTable: ObservableSubscriptionTable.ObservableSubscriptionTable<DeathReportUtils.DeathReport>,
+		_humanoidDeathSubTable: ObservableSubscriptionTable.ObservableSubscriptionTable<DeathReportUtils.DeathReport>,
+		_characterKillerSubTable: ObservableSubscriptionTable.ObservableSubscriptionTable<DeathReportUtils.DeathReport>,
+		_characterDeathSubTable: ObservableSubscriptionTable.ObservableSubscriptionTable<DeathReportUtils.DeathReport>,
+	},
+	{ __index = DeathReportProcessor }
+))
+
+function DeathReportProcessor.new(): DeathReportProcessor
+	local self = setmetatable(BaseObject.new() :: any, DeathReportProcessor)
+
+	self._playerKillerSubTable = self._maid:Add(ObservableSubscriptionTable.new())
+	self._playerDeathSubTable = self._maid:Add(ObservableSubscriptionTable.new())
+	self._humanoidKillerSubTable = self._maid:Add(ObservableSubscriptionTable.new())
+	self._humanoidDeathSubTable = self._maid:Add(ObservableSubscriptionTable.new())
+	self._characterKillerSubTable = self._maid:Add(ObservableSubscriptionTable.new())
+	self._characterDeathSubTable = self._maid:Add(ObservableSubscriptionTable.new())
 
 	self._maid:GiveTask(Players.PlayerRemoving:Connect(function(player)
 		self._playerKillerSubTable:Complete(player)
@@ -51,7 +54,10 @@ end
 	@param player Player
 	@return Observable<DeathReport>
 ]=]
-function DeathReportProcessor:ObservePlayerKillerReports(player)
+function DeathReportProcessor.ObservePlayerKillerReports(
+	self: DeathReportProcessor,
+	player: Player
+): _Observable.Observable<DeathReportUtils.DeathReport>
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 
 	return self._playerKillerSubTable:Observe(player)
@@ -63,7 +69,10 @@ end
 	@param player Player
 	@return Observable<DeathReport>
 ]=]
-function DeathReportProcessor:ObservePlayerDeathReports(player)
+function DeathReportProcessor.ObservePlayerDeathReports(
+	self: DeathReportProcessor,
+	player: Player
+): _Observable.Observable<DeathReportUtils.DeathReport>
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 
 	return self._playerDeathSubTable:Observe(player)
@@ -75,7 +84,10 @@ end
 	@param humanoid Humanoid
 	@return Observable<DeathReport>
 ]=]
-function DeathReportProcessor:ObserveHumanoidDeathReports(humanoid)
+function DeathReportProcessor.ObserveHumanoidDeathReports(
+	self: DeathReportProcessor,
+	humanoid: Humanoid
+): _Observable.Observable<DeathReportUtils.DeathReport>
 	assert(typeof(humanoid) == "Instance" and humanoid:IsA("Humanoid"), "Bad humanoid")
 
 	return self._humanoidDeathSubTable:Observe(humanoid)
@@ -87,7 +99,10 @@ end
 	@param humanoid Humanoid
 	@return Observable<DeathReport>
 ]=]
-function DeathReportProcessor:ObserveHumanoidKillerReports(humanoid)
+function DeathReportProcessor.ObserveHumanoidKillerReports(
+	self: DeathReportProcessor,
+	humanoid: Humanoid
+): _Observable.Observable<DeathReportUtils.DeathReport>
 	assert(typeof(humanoid) == "Instance" and humanoid:IsA("Humanoid"), "Bad humanoid")
 
 	return self._humanoidKillerSubTable:Observe(humanoid)
@@ -99,7 +114,10 @@ end
 	@param character Model
 	@return Observable<DeathReport>
 ]=]
-function DeathReportProcessor:ObserveCharacterKillerReports(character)
+function DeathReportProcessor.ObserveCharacterKillerReports(
+	self: DeathReportProcessor,
+	character: Model
+): _Observable.Observable<DeathReportUtils.DeathReport>
 	assert(typeof(character) == "Instance" and character:IsA("Model"), "Bad character")
 
 	return self._characterKillerSubTable:Observe(character)
@@ -111,7 +129,10 @@ end
 	@param character Model
 	@return Observable<DeathReport>
 ]=]
-function DeathReportProcessor:ObserveCharacterDeathReports(character)
+function DeathReportProcessor.ObserveCharacterDeathReports(
+	self: DeathReportProcessor,
+	character: Model
+): _Observable.Observable<DeathReportUtils.DeathReport>
 	assert(typeof(character) == "Instance" and character:IsA("Model"), "Bad character")
 
 	return self._characterDeathSubTable:Observe(character)
@@ -123,7 +144,7 @@ end
 
 	@param deathReport DeathReport
 ]=]
-function DeathReportProcessor:HandleDeathReport(deathReport)
+function DeathReportProcessor.HandleDeathReport(self: DeathReportProcessor,deathReport: DeathReportUtils.DeathReport)
 	assert(DeathReportUtils.isDeathReport(deathReport), "Bad deathreport")
 
 	if deathReport.killerPlayer then

package/src/Shared/DeathReportUtils.lua

@@ -18,14 +18,29 @@ local DeathReportUtils = {}
 	@param weaponData WeaponData
 	@return DeathReport
 ]=]
-function DeathReportUtils.fromDeceasedHumanoid(humanoid: Humanoid, weaponData)
+function DeathReportUtils.fromDeceasedHumanoid(humanoid: Humanoid, weaponData: WeaponData?)
 	assert(DeathReportUtils.isWeaponData(weaponData) or weaponData == nil, "Bad weaponData")
 
 	local killerHumanoid = HumanoidKillerUtils.getKillerHumanoidOfHumanoid(humanoid)
-	return DeathReportUtils.create(humanoid.Parent, killerHumanoid, weaponData)
+	local character = humanoid.Parent
+	return DeathReportUtils.create(character, killerHumanoid, weaponData)
 end
 
-function DeathReportUtils.create(adornee: Instance, killerAdornee, weaponData)
+export type WeaponData = {
+	weaponInstance: Instance?,
+}
+export type DeathReport = {
+	type: "deathReport",
+	adornee: Instance,
+	humanoid: Humanoid?,
+	player: Player?,
+	killerAdornee: Instance?,
+	killerHumanoid: Humanoid?,
+	killerPlayer: Player?,
+	weaponData: WeaponData,
+}
+
+function DeathReportUtils.create(adornee: Instance, killerAdornee: Instance?, weaponData: WeaponData?): DeathReport
 	assert(typeof(adornee) == "Instance", "Bad adornee")
 
 	local humanoid
@@ -53,7 +68,7 @@ end
 	@param deathReport any
 	@return boolean
 ]=]
-function DeathReportUtils.isDeathReport(deathReport)
+function DeathReportUtils.isDeathReport(deathReport: any): boolean
 	return type(deathReport) == "table" and deathReport.type == "deathReport"
 end
 
@@ -74,7 +89,7 @@ end
 	@param weaponInstance Instance?
 	@return WeaponData
 ]=]
-function DeathReportUtils.createWeaponData(weaponInstance)
+function DeathReportUtils.createWeaponData(weaponInstance: Instance?): WeaponData
 	assert(typeof(weaponInstance) == "Instance" or weaponInstance == nil, "Bad weaponInstance")
 
 	return {
@@ -88,7 +103,7 @@ end
 	@param deathReport DeathReport
 	@return string
 ]=]
-function DeathReportUtils.getDeadDisplayName(deathReport)
+function DeathReportUtils.getDeadDisplayName(deathReport: DeathReport): string?
 	if deathReport.player then
 		return deathReport.player.DisplayName
 	elseif deathReport.humanoid then
@@ -113,7 +128,7 @@ end
 	@param player Player
 	@return string
 ]=]
-function DeathReportUtils.involvesPlayer(deathReport, player)
+function DeathReportUtils.involvesPlayer(deathReport: DeathReport, player: Player): boolean
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 
 	return (deathReport.player == player) or (deathReport.killerPlayer == player)
@@ -125,7 +140,7 @@ end
 	@param deathReport DeathReport
 	@return string?
 ]=]
-function DeathReportUtils.getKillerDisplayName(deathReport)
+function DeathReportUtils.getKillerDisplayName(deathReport: DeathReport): string?
 	if deathReport.killerPlayer then
 		assert(deathReport.killerPlayer:IsA("Player"), "Bad player")
 		return deathReport.killerPlayer.DisplayName
@@ -148,7 +163,7 @@ end
 	@param deathReport DeathReport
 	@return Color3?
 ]=]
-function DeathReportUtils.getDeadColor(deathReport)
+function DeathReportUtils.getDeadColor(deathReport: DeathReport): Color3?
 	if deathReport.player then
 		local team = deathReport.player.Team
 		if team then
@@ -165,7 +180,7 @@ end
 	@param deathReport DeathReport
 	@return Color3?
 ]=]
-function DeathReportUtils.getKillerColor(deathReport)
+function DeathReportUtils.getKillerColor(deathReport: DeathReport): Color3?
 	if deathReport.killerPlayer then
 		local team = deathReport.killerPlayer.Team
 		if team then
@@ -180,7 +195,7 @@ end
 	Gets the default color of a death report to use.
 	@return Color3
 ]=]
-function DeathReportUtils.getDefaultColor()
+function DeathReportUtils.getDefaultColor(): Color3
 	return DEFAULT_COLOR
 end