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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/friendutils",
-  "version": "12.17.0",
+  "version": "12.17.1",
   "description": "Utlity functions to help find friends of a user. Also contains utility to make testing in studio easier.",
   "keywords": [
     "Roblox",
@@ -25,14 +25,14 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/brio": "^14.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/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/FriendUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Utlity functions to help find friends of a user. Also contains utility to make testing in studio easier.
 	@class FriendUtils
@@ -19,6 +20,12 @@ local FriendUtils = {}
 	.IsOnline bool -- If the friend is currently online
 	@within FriendUtils
 ]=]
+export type FriendData = {
+	Id: number,
+	Username: string,
+	DisplayName: string,
+	IsOnline: boolean,
+}
 
 --[=[
 	Returns the current studio users friends
@@ -31,9 +38,8 @@ local FriendUtils = {}
 	```
 	@return Promise<{ FriendData }>
 ]=]
-function FriendUtils.promiseAllStudioFriends()
-	return FriendUtils.promiseCurrentStudioUserId()
-		:Then(FriendUtils.promiseAllFriends)
+function FriendUtils.promiseAllStudioFriends(): Promise.Promise<{ FriendData }>
+	return FriendUtils.promiseCurrentStudioUserId():Then(FriendUtils.promiseAllFriends)
 end
 
 --[=[
@@ -41,9 +47,9 @@ end
 	@param friends { FriendData }
 	@return { FriendData }
 ]=]
-function FriendUtils.onlineFriends(friends)
+function FriendUtils.onlineFriends(friends: { FriendData }): { FriendData }
 	local onlineFriends = {}
-	for _, friend in pairs(friends) do
+	for _, friend in friends do
 		if friend.IsOnline then
 			table.insert(onlineFriends, friend)
 		end
@@ -56,14 +62,14 @@ end
 	@param friends { FriendData }
 	@return { FriendData }
 ]=]
-function FriendUtils.friendsNotInGame(friends)
+function FriendUtils.friendsNotInGame(friends: { FriendData }): { FriendData }
 	local userIdsInGame = {}
-	for _, player in pairs(Players:GetPlayers()) do
+	for _, player in Players:GetPlayers() do
 		userIdsInGame[player.UserId] = true
 	end
 
 	local onlineFriends = {}
-	for _, friend in pairs(friends) do
+	for _, friend in friends do
 		if not userIdsInGame[friend.Id] then
 			table.insert(onlineFriends, friend)
 		end
@@ -77,26 +83,25 @@ end
 	@param limitMaxFriends number? -- Optional max friends
 	@return Promise<{ FriendData }>
 ]=]
-function FriendUtils.promiseAllFriends(userId, limitMaxFriends)
+function FriendUtils.promiseAllFriends(userId: number, limitMaxFriends: number?): Promise.Promise<{ FriendData }>
 	assert(userId, "Bad userId")
 
-	return FriendUtils.promiseFriendPages(userId)
-		:Then(function(pages)
-			return Promise.spawn(function(resolve, _)
-				local users = {}
+	return FriendUtils.promiseFriendPages(userId):Then(function(pages)
+		return Promise.spawn(function(resolve, _)
+			local users = {}
 
-				for userData in FriendUtils.iterateFriendsYielding(pages) do
-					table.insert(users, userData)
+			for userData in FriendUtils.iterateFriendsYielding(pages) do
+				table.insert(users, userData)
 
-					-- Exit quickly!
-					if limitMaxFriends and #users >= limitMaxFriends then
-						return resolve(users)
-					end
+				-- Exit quickly!
+				if limitMaxFriends and #users >= limitMaxFriends then
+					return resolve(users)
 				end
+			end
 
-				return resolve(users)
-			end)
+			return resolve(users)
 		end)
+	end)
 end
 
 --[=[
@@ -104,7 +109,7 @@ end
 	@param userId number
 	@return Promise<FriendPages>
 ]=]
-function FriendUtils.promiseFriendPages(userId)
+function FriendUtils.promiseFriendPages(userId: number): Promise.Promise<FriendPages>
 	assert(type(userId) == "number", "Bad userId")
 
 	return Promise.spawn(function(resolve, reject)
@@ -127,12 +132,12 @@ end
 	@param pages FriendPages
 	@return () => FrienData? -- Iterator
 ]=]
-function FriendUtils.iterateFriendsYielding(pages)
+function FriendUtils.iterateFriendsYielding(pages: FriendPages): () -> FriendData?
 	assert(pages, "Bad pages")
 
 	return coroutine.wrap(function()
 		while true do
-			for _, userData in pairs(pages:GetCurrentPage()) do
+			for _, userData in pages:GetCurrentPage() do
 				assert(type(userData.Id) == "number", "Bad userData.Id")
 				assert(type(userData.Username) == "string", "Bad userData.Username")
 				assert(type(userData.IsOnline) == "boolean", "Bad userData.IsOnline")
@@ -157,7 +162,7 @@ end
 
 	@return Promise<number>
 ]=]
-function FriendUtils.promiseStudioServiceUserId()
+function FriendUtils.promiseStudioServiceUserId(): Promise.Promise<number>
 	return Promise.new(function(resolve, reject)
 		local userId
 		local ok, err = pcall(function()
@@ -180,7 +185,7 @@ end
 	Gets the current studio user's user id.
 	@return Promise<number>
 ]=]
-function FriendUtils.promiseCurrentStudioUserId()
+function FriendUtils.promiseCurrentStudioUserId(): Promise.Promise<number>
 	return FriendUtils.promiseStudioServiceUserId()
 		:Catch(function(...)
 			warn(...)

package/src/Shared/RxFriendUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Utilities for observing the local player's friends.
 
@@ -24,7 +25,7 @@ local RxFriendUtils = {}
 	@param player Player?
 	@return Observable<Brio<Player>>
 ]=]
-function RxFriendUtils.observeFriendsInServerAsBrios(player: Player?)
+function RxFriendUtils.observeFriendsInServerAsBrios(player: Player?): Observable.Observable<Brio.Brio<Player>>
 	player = player or Players.LocalPlayer
 
 	assert(typeof(player) == "Instance", "Bad player")
@@ -37,7 +38,7 @@ function RxFriendUtils.observeFriendsInServerAsBrios(player: Player?)
 	return Observable.new(function(sub)
 		local maid = Maid.new()
 
-		local function handleFriendState(otherPlayer: Player, isFriendsWith)
+		local function handleFriendState(otherPlayer: Player, isFriendsWith: boolean)
 			if otherPlayer == Players.LocalPlayer then
 				return
 			end
@@ -105,7 +106,7 @@ function RxFriendUtils.observeFriendsInServerAsBrios(player: Player?)
 		end
 
 		return maid
-	end)
+	end) :: any
 end
 
 return RxFriendUtils