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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/funnels",
-  "version": "1.5.0",
+  "version": "1.5.1",
   "description": "Funnel utility class",
   "keywords": [
     "Roblox",
@@ -25,15 +25,15 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/adorneedata": "^7.18.0",
-    "@quenty/baseobject": "^10.8.0",
-    "@quenty/binder": "^14.19.0",
-    "@quenty/loader": "^10.8.0",
-    "@quenty/propertyvalue": "^7.17.0",
-    "@quenty/servicebag": "^11.11.1"
+    "@quenty/adorneedata": "^7.18.1",
+    "@quenty/baseobject": "^10.8.1",
+    "@quenty/binder": "^14.19.1",
+    "@quenty/loader": "^10.8.1",
+    "@quenty/propertyvalue": "^7.17.1",
+    "@quenty/servicebag": "^11.11.2"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e8ea56930e65322fcffc05a1556d5df988068f0b"
+  "gitHead": "78c3ac0ab08dd18085b6e6e6e4f745e76ed99f68"
 }

package/src/Server/Steps/FunnelStepLogger.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Server-side funnel logger
 
@@ -16,11 +17,22 @@ local FunnelStepLogger = setmetatable({}, BaseObject)
 FunnelStepLogger.ClassName = "FunnelStepLogger"
 FunnelStepLogger.__index = FunnelStepLogger
 
-function FunnelStepLogger.new(player, funnelName)
-	local self = setmetatable(BaseObject.new(), FunnelStepLogger)
+export type FunnelStepLogger = typeof(setmetatable(
+	{} :: {
+		_player: Player,
+		_stepTracker: FunnelStepTracker.FunnelStepTracker,
+		_funnelName: string,
+		_funnelSessionId: string,
+		_printDebugEnabled: boolean,
+	} & BaseObject.BaseObject,
+	{ __index = FunnelStepLogger }
+))
+
+function FunnelStepLogger.new(player: Player, funnelName: string): FunnelStepLogger
+	local self: any = setmetatable(BaseObject.new() :: any, FunnelStepLogger)
 
 	self._player = assert(player, "No player")
-	self._stepTracker = self._maid:Add(FunnelStepTracker.new())
+	self._stepTracker = self._maid:Add(FunnelStepTracker.new() :: any)
 	self._funnelName = assert(funnelName, "Bad funnelName")
 	self._funnelSessionId = HttpService:GenerateGUID(false)
 	self._printDebugEnabled = false
@@ -29,7 +41,7 @@ function FunnelStepLogger.new(player, funnelName)
 	if next(steps) then
 		-- Give us time to print if we need
 		self._maid:GiveTask(task.defer(function()
-			for stepNumber, stepName in pairs(steps) do
+			for stepNumber, stepName in steps do
 				self:_sendStep(stepNumber, stepName)
 			end
 		end))
@@ -42,24 +54,24 @@ function FunnelStepLogger.new(player, funnelName)
 	return self
 end
 
-function FunnelStepLogger:SetPrintDebugEnabled(debugEnabled)
+function FunnelStepLogger.SetPrintDebugEnabled(self: FunnelStepLogger, debugEnabled: boolean)
 	assert(type(debugEnabled) == "boolean", "Bad debugEnabled")
 
 	self._printDebugEnabled = debugEnabled
 end
 
-function FunnelStepLogger:LogStep(stepNumber, stepName)
+function FunnelStepLogger.LogStep(self: FunnelStepLogger, stepNumber: number, stepName: string)
 	assert(type(stepNumber) == "number", "Bad stepNumber")
 	assert(type(stepName) == "string", "Bad stepName")
 
 	self._stepTracker:LogStep(stepNumber, stepName)
 end
 
-function FunnelStepLogger:IsStepComplete(stepNumber)
+function FunnelStepLogger.IsStepComplete(self: FunnelStepLogger, stepNumber: number): boolean
 	return self._stepTracker:IsStepComplete(stepNumber)
 end
 
-function FunnelStepLogger:_sendStep(stepNumber, stepName)
+function FunnelStepLogger._sendStep(self: FunnelStepLogger, stepNumber: number, stepName: string)
 	AnalyticsService:LogFunnelStepEvent(self._player, self._funnelName, self._funnelSessionId, stepNumber, stepName)
 
 	if self._printDebugEnabled then

package/src/Shared/Steps/FunnelStepTracker.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	@class FunnelStepTracker
 ]=]
@@ -6,28 +7,52 @@ local require = require(script.Parent.loader).load(script)
 
 local Signal = require("Signal")
 local BaseObject = require("BaseObject")
+local _Maid = require("Maid")
 
 local FunnelStepTracker = setmetatable({}, BaseObject)
 FunnelStepTracker.ClassName = "FunnelStepTracker"
 FunnelStepTracker.__index = FunnelStepTracker
 
-function FunnelStepTracker.new()
-	local self = setmetatable(BaseObject.new(), FunnelStepTracker)
+export type FunnelStepTracker = typeof(setmetatable(
+	{} :: {
+		_maid: _Maid.Maid,
+		_stepsLogged: { [number]: string },
+		StepLogged: Signal.Signal<number, string>,
+	},
+	{ __index = FunnelStepTracker }
+))
+
+--[=[
+	Constructs a new FunnelStepTracker
+
+	@return FunnelStepTracker
+]=]
+function FunnelStepTracker.new(): FunnelStepTracker
+	local self: FunnelStepTracker = setmetatable(BaseObject.new() :: any, FunnelStepTracker)
 
 	self._stepsLogged = {}
 
-	self.StepLogged = self._maid:Add(Signal.new())
+	self.StepLogged = self._maid:Add(Signal.new() :: any)
 
 	return self
 end
 
-function FunnelStepTracker:LogStep(stepNumber, stepName)
+--[=[
+	Logs a step
+]=]
+function FunnelStepTracker.LogStep(self: FunnelStepTracker, stepNumber: number, stepName: string): ()
 	assert(type(stepNumber) == "number", "Bad stepNumber")
 	assert(type(stepName) == "string", "Bad stepName")
 
 	if self._stepsLogged[stepNumber] then
 		if self._stepsLogged[stepNumber] ~= stepName then
-			error(string.format("[FunnelStepTracker.LogStep] - Trying to log step with 2 separate names, %q and %q", self._stepsLogged[stepNumber], stepNumber))
+			error(
+				string.format(
+					"[FunnelStepTracker.LogStep] - Trying to log step with 2 separate names, %q and %d",
+					self._stepsLogged[stepNumber],
+					stepNumber
+				)
+			)
 		end
 
 		return
@@ -38,17 +63,31 @@ function FunnelStepTracker:LogStep(stepNumber, stepName)
 	self.StepLogged:Fire(stepNumber, stepName)
 end
 
-function FunnelStepTracker:IsStepComplete(stepNumber)
+--[=[
+	Returns true if the step is complete
+
+	@param stepNumber number
+	@return string?
+]=]
+function FunnelStepTracker.IsStepComplete(self: FunnelStepTracker, stepNumber: number): boolean
 	assert(type(stepNumber) == "number", "Bad stepNumber")
 
 	return self._stepsLogged[stepNumber] ~= nil
 end
 
-function FunnelStepTracker:GetLoggedSteps()
+--[=[
+	Gets the logged steps
+
+	@return { [number]: string }
+]=]
+function FunnelStepTracker.GetLoggedSteps(self: FunnelStepTracker): { [number]: string }
 	return table.clone(self._stepsLogged)
 end
 
-function FunnelStepTracker:ClearLoggedSteps()
+--[=[
+	Clears all logged steps
+]=]
+function FunnelStepTracker.ClearLoggedSteps(self: FunnelStepTracker)
 	table.clear(self._stepsLogged)
 end