@quenty/userserviceutils 9.18.3-canary.550.afa1b3b.0 → 9.18.4-canary.11a5dcf.0

package/CHANGELOG.md

@@ -3,7 +3,23 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-## [9.18.3-canary.550.afa1b3b.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/userserviceutils@9.18.2...@quenty/userserviceutils@9.18.3-canary.550.afa1b3b.0) (2025-04-10)
+## [9.18.4-canary.11a5dcf.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/userserviceutils@9.18.3...@quenty/userserviceutils@9.18.4-canary.11a5dcf.0) (2025-05-10)
+
+
+### Bug Fixes
+
+* Additional type checking updates ([05ba29a](https://github.com/Quenty/NevermoreEngine/commit/05ba29a03efc9f3feed74b34f1d9dfb237496214))
+
+
+### Features
+
+* Add even more types ([b31717d](https://github.com/Quenty/NevermoreEngine/commit/b31717d8c9f7620c457f5018a2affa760a65334a))
+
+
+
+
+
+## [9.18.3](https://github.com/Quenty/NevermoreEngine/compare/@quenty/userserviceutils@9.18.2...@quenty/userserviceutils@9.18.3) (2025-04-10)
 
 **Note:** Version bump only for package @quenty/userserviceutils
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/userserviceutils",
-  "version": "9.18.3-canary.550.afa1b3b.0",
+  "version": "9.18.4-canary.11a5dcf.0",
   "description": "Utilities involving UserService in Roblox",
   "keywords": [
     "Roblox",
@@ -25,17 +25,17 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/aggregator": "1.4.3-canary.550.afa1b3b.0",
-    "@quenty/baseobject": "10.8.3-canary.550.afa1b3b.0",
-    "@quenty/loader": "10.8.3-canary.550.afa1b3b.0",
-    "@quenty/maid": "3.4.3-canary.550.afa1b3b.0",
+    "@quenty/aggregator": "1.4.4-canary.11a5dcf.0",
+    "@quenty/baseobject": "10.8.4-canary.11a5dcf.0",
+    "@quenty/loader": "10.8.4-canary.11a5dcf.0",
+    "@quenty/maid": "3.4.4-canary.11a5dcf.0",
     "@quenty/math": "2.7.3",
-    "@quenty/promise": "10.10.4-canary.550.afa1b3b.0",
-    "@quenty/rx": "13.17.3-canary.550.afa1b3b.0",
-    "@quenty/servicebag": "11.11.4-canary.550.afa1b3b.0"
+    "@quenty/promise": "10.10.5-canary.11a5dcf.0",
+    "@quenty/rx": "13.17.4-canary.11a5dcf.0",
+    "@quenty/servicebag": "11.11.5-canary.11a5dcf.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "afa1b3b99b862698c3ab46009497bd507150867c"
+  "gitHead": "11a5dcf7d4c7a0bfbf3337e97d30e8346ea09d3f"
 }

package/src/Shared/UserInfoAggregator.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Aggregates all requests into one big send request to deduplicate the request
 
@@ -8,24 +9,33 @@ local require = require(script.Parent.loader).load(script)
 
 local Aggregator = require("Aggregator")
 local BaseObject = require("BaseObject")
+local Observable = require("Observable")
+local Promise = require("Promise")
+local PromiseRetryUtils = require("PromiseRetryUtils")
 local Rx = require("Rx")
 local UserServiceUtils = require("UserServiceUtils")
-local PromiseRetryUtils = require("PromiseRetryUtils")
 
 local UserInfoAggregator = setmetatable({}, BaseObject)
 UserInfoAggregator.ClassName = "UserInfoAggregator"
 UserInfoAggregator.__index = UserInfoAggregator
 
-function UserInfoAggregator.new()
-	local self = setmetatable(BaseObject.new(), UserInfoAggregator)
+export type UserInfoAggregator = typeof(setmetatable(
+	{} :: {
+		_aggregator: Aggregator.Aggregator<UserServiceUtils.UserInfo>,
+	},
+	{} :: typeof({ __index = UserInfoAggregator })
+)) & BaseObject.BaseObject
+
+function UserInfoAggregator.new(): UserInfoAggregator
+	local self: UserInfoAggregator = setmetatable(BaseObject.new() :: any, UserInfoAggregator)
 
 	self._aggregator = self._maid:Add(Aggregator.new("UserServiceUtils.promiseUserInfosByUserIds", function(userIdList)
 		return PromiseRetryUtils.retry(function()
 			return UserServiceUtils.promiseUserInfosByUserIds(userIdList)
 		end, {
-			initialWaitTime = 10;
-			maxAttempts = 10;
-			printWarning = true;
+			initialWaitTime = 10,
+			maxAttempts = 10,
+			printWarning = true,
 		})
 	end))
 
@@ -39,7 +49,7 @@ end
 	@param userId number
 	@return Promise<UserInfo>
 ]=]
-function UserInfoAggregator:PromiseUserInfo(userId: number)
+function UserInfoAggregator:PromiseUserInfo(userId: number): Promise.Promise<UserServiceUtils.UserInfo>
 	assert(type(userId) == "number", "Bad userId")
 
 	return self._aggregator:Promise(userId)
@@ -51,7 +61,7 @@ end
 	@param userId number
 	@return Promise<string>
 ]=]
-function UserInfoAggregator:PromiseDisplayName(userId: number)
+function UserInfoAggregator:PromiseDisplayName(userId: number): Promise.Promise<string>
 	assert(type(userId) == "number", "Bad userId")
 
 	return self._aggregator:Promise(userId):Then(function(userInfo)
@@ -65,7 +75,7 @@ end
 	@param userId number
 	@return Promise<string>
 ]=]
-function UserInfoAggregator:PromiseUsername(userId: number)
+function UserInfoAggregator:PromiseUsername(userId: number): Promise.Promise<string>
 	assert(type(userId) == "number", "Bad userId")
 
 	return self._aggregator:Promise(userId):Then(function(userInfo)
@@ -79,7 +89,7 @@ end
 	@param userId number
 	@return Promise<boolean>
 ]=]
-function UserInfoAggregator:PromiseHasVerifiedBadge(userId: number)
+function UserInfoAggregator:PromiseHasVerifiedBadge(userId: number): Promise.Promise<boolean>
 	assert(type(userId) == "number", "Bad userId")
 
 	return self._aggregator:Promise(userId):Then(function(userInfo)
@@ -93,7 +103,7 @@ end
 	@param userId number
 	@return Observable<UserInfo>
 ]=]
-function UserInfoAggregator:ObserveUserInfo(userId: number)
+function UserInfoAggregator:ObserveUserInfo(userId: number): Observable.Observable<UserServiceUtils.UserInfo>
 	assert(type(userId) == "number", "Bad userId")
 
 	return self._aggregator:Observe(userId)
@@ -105,7 +115,7 @@ end
 	@param userId number
 	@return Observable<string>
 ]=]
-function UserInfoAggregator:ObserveDisplayName(userId: number)
+function UserInfoAggregator:ObserveDisplayName(userId: number): Observable.Observable<string>
 	assert(type(userId) == "number", "Bad userId")
 
 	return self._aggregator:Observe(userId):Pipe({
@@ -121,7 +131,7 @@ end
 	@param userId number
 	@return Observable<string>
 ]=]
-function UserInfoAggregator:ObserveUsername(userId: number)
+function UserInfoAggregator:ObserveUsername(userId: number): Observable.Observable<string>
 	assert(type(userId) == "number", "Bad userId")
 
 	return self._aggregator:Observe(userId):Pipe({
@@ -137,14 +147,14 @@ end
 	@param userId number
 	@return Observable<boolean>
 ]=]
-function UserInfoAggregator:ObserveHasVerifiedBadge(userId: number)
+function UserInfoAggregator:ObserveHasVerifiedBadge(userId: number): Observable.Observable<boolean>
 	assert(type(userId) == "number", "Bad userId")
 
 	return self._aggregator:Observe(userId):Pipe({
 		Rx.map(function(userInfo)
 			return userInfo.HasVerifiedBadge
-		end)
+		end),
 	})
 end
 
-return UserInfoAggregator
+return UserInfoAggregator

package/src/Shared/UserInfoService.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Centralized provider for user info so we can coordinate web requests.
 
@@ -6,14 +7,17 @@
 
 local require = require(script.Parent.loader).load(script)
 
-local UserInfoAggregator = require("UserInfoAggregator")
 local Maid = require("Maid")
-local _ServiceBag = require("ServiceBag")
+local Observable = require("Observable")
+local Promise = require("Promise")
+local ServiceBag = require("ServiceBag")
+local UserInfoAggregator = require("UserInfoAggregator")
+local UserServiceUtils = require("UserServiceUtils")
 
 local UserInfoService = {}
 UserInfoService.ServiceName = "UserInfoService"
 
-function UserInfoService:Init(serviceBag: _ServiceBag.ServiceBag)
+function UserInfoService:Init(serviceBag: ServiceBag.ServiceBag)
 	assert(not self._serviceBag, "Already initialized")
 	self._serviceBag = assert(serviceBag, "No serviceBag")
 	self._maid = Maid.new()
@@ -28,8 +32,8 @@ end
 	@param userId number
 	@return Promise<UserInfo>
 ]=]
-function UserInfoService:PromiseUserInfo(userId: number)
-    assert(type(userId) == "number", "Bad userId")
+function UserInfoService:PromiseUserInfo(userId: number): Promise.Promise<UserServiceUtils.UserInfo>
+	assert(type(userId) == "number", "Bad userId")
 
 	return self._aggregator:PromiseUserInfo(userId)
 end
@@ -40,8 +44,8 @@ end
 	@param userId number
 	@return Observable<UserInfo>
 ]=]
-function UserInfoService:ObserveUserInfo(userId: number)
-    assert(type(userId) == "number", "Bad userId")
+function UserInfoService:ObserveUserInfo(userId: number): Observable.Observable<UserServiceUtils.UserInfo>
+	assert(type(userId) == "number", "Bad userId")
 
 	return self._aggregator:ObserveUserInfo(userId)
 end
@@ -52,8 +56,8 @@ end
 	@param userId number
 	@return Promise<string>
 ]=]
-function UserInfoService:PromiseDisplayName(userId: number)
-    assert(type(userId) == "number", "Bad userId")
+function UserInfoService:PromiseDisplayName(userId: number): Promise.Promise<string>
+	assert(type(userId) == "number", "Bad userId")
 
 	return self._aggregator:PromiseDisplayName(userId)
 end
@@ -64,8 +68,8 @@ end
 	@param userId number
 	@return Promise<string>
 ]=]
-function UserInfoService:PromiseUsername(userId: number)
-    assert(type(userId) == "number", "Bad userId")
+function UserInfoService:PromiseUsername(userId: number): Promise.Promise<string>
+	assert(type(userId) == "number", "Bad userId")
 
 	return self._aggregator:PromiseUsername(userId)
 end
@@ -76,15 +80,14 @@ end
 	@param userId number
 	@return Observable<string>
 ]=]
-function UserInfoService:ObserveDisplayName(userId: number)
-    assert(type(userId) == "number", "Bad userId")
+function UserInfoService:ObserveDisplayName(userId: number): Observable.Observable<UserServiceUtils.UserInfo>
+	assert(type(userId) == "number", "Bad userId")
 
 	return self._aggregator:ObserveDisplayName(userId)
 end
 
-
 function UserInfoService:Destroy()
 	self._maid:DoCleaning()
 end
 
-return UserInfoService
+return UserInfoService

package/src/Shared/UserServiceUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Wraps [UserService] API calls with [Promise].
 
@@ -20,6 +21,12 @@ local UserServiceUtils = {}
 	.HasVerifiedBadge boolean -- The HasVerifiedBadge value associated with the user.
 	@within UserServiceUtils
 ]=]
+export type UserInfo = {
+	Id: number,
+	Username: string,
+	DisplayName: string,
+	HasVerifiedBadge: boolean,
+}
 
 --[=[
 	Wraps UserService:GetUserInfosByUserIdsAsync(userIds)
@@ -31,7 +38,7 @@ local UserServiceUtils = {}
 	@param userIds { number }
 	@return Promise<{ UserInfo }>
 ]=]
-function UserServiceUtils.promiseUserInfosByUserIds(userIds)
+function UserServiceUtils.promiseUserInfosByUserIds(userIds: { number }): Promise.Promise<{ UserInfo }>
 	assert(type(userIds) == "table", "Bad userIds")
 
 	return Promise.spawn(function(resolve, reject)
@@ -61,19 +68,18 @@ end
 	@param userId number
 	@return Promise<UserInfo>
 ]=]
-function UserServiceUtils.promiseUserInfo(userId)
+function UserServiceUtils.promiseUserInfo(userId: number): Promise.Promise<UserInfo>
 	assert(type(userId) == "number", "Bad userId")
 
-	return UserServiceUtils.promiseUserInfosByUserIds({ userId })
-		:Then(function(infos)
-			local userInfo = infos[1]
+	return UserServiceUtils.promiseUserInfosByUserIds({ userId }):Then(function(infos)
+		local userInfo = infos[1]
 
-			if not userInfo then
-				return Promise.rejected("Failed to retrieve data for userId")
-			end
+		if not userInfo then
+			return Promise.rejected("Failed to retrieve data for userId")
+		end
 
-			return userInfo
-		end)
+		return userInfo
+	end)
 end
 
 --[=[
@@ -86,13 +92,12 @@ end
 	@param userId number
 	@return Promise<string>
 ]=]
-function UserServiceUtils.promiseDisplayName(userId)
+function UserServiceUtils.promiseDisplayName(userId: number): Promise.Promise<string>
 	assert(type(userId) == "number", "Bad userId")
 
-	return UserServiceUtils.promiseUserInfo(userId)
-		:Then(function(userInfo)
-			return userInfo.DisplayName
-		end)
+	return UserServiceUtils.promiseUserInfo(userId):Then(function(userInfo)
+		return userInfo.DisplayName
+	end)
 end
 
 --[=[
@@ -105,13 +110,12 @@ end
 	@param userId number
 	@return Promise<string>
 ]=]
-function UserServiceUtils.promiseUserName(userId)
+function UserServiceUtils.promiseUserName(userId: number): Promise.Promise<string>
 	assert(type(userId) == "number", "Bad userId")
 
-	return UserServiceUtils.promiseUserInfo(userId)
-		:Then(function(userInfo)
-			return userInfo.Username
-		end)
+	return UserServiceUtils.promiseUserInfo(userId):Then(function(userInfo)
+		return userInfo.Username
+	end)
 end
 
-return UserServiceUtils
+return UserServiceUtils