@quenty/badgeutils 3.6.0 → 4.0.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.
 
+# [4.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/badgeutils@3.6.0...@quenty/badgeutils@4.0.0) (2022-03-06)
+
+
+### Features
+
+* Move BadgeUtils to shared, add API to get badge info ([f9fc12d](https://github.com/Quenty/NevermoreEngine/commit/f9fc12d9d465dbbb9345d216789a8faf98430172))
+
+
+
+
+
 # [3.6.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/badgeutils@3.5.1...@quenty/badgeutils@3.6.0) (2022-01-17)
 
 **Note:** Version bump only for package @quenty/badgeutils

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/badgeutils",
-  "version": "3.6.0",
+  "version": "4.0.0",
   "description": "Utility functions involving badges on Roblox",
   "keywords": [
     "Roblox",
@@ -25,11 +25,11 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/loader": "^3.4.0",
-    "@quenty/promise": "^3.6.0"
+    "@quenty/loader": "^4.0.0",
+    "@quenty/promise": "^4.0.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "c094ba8f4e128cdff08919d89de226d3d65247ce"
+  "gitHead": "dd428cab58282c975a4c082957dc8f58e3186905"
 }

package/src/Shared/BadgeUtils.lua

@@ -0,0 +1,74 @@
+--[=[
+	Utility functions involving badges on Roblox
+	@class BadgeUtils
+]=]
+
+local BadgeService = game:GetService("BadgeService")
+
+local require = require(script.Parent.loader).load(script)
+
+local Promise = require("Promise")
+
+local BadgeUtils = {}
+
+--[=[
+	@interface BadgeInfoDictionary
+	.Name string -- The name of the badge.
+	.Description string -- The description of the badge.
+	.IconImageId int64 -- The asset ID of the image for the badge.
+	.IsEnabled bool -- Indicates whether the badge is available to be awarded.
+	@within BadgeUtils
+]=]
+
+--[=[
+	Tries to reward a player to a badge inside of a promise.
+
+	@server
+	@param player Player
+	@param badgeId number
+	@return Promise
+]=]
+function BadgeUtils.promiseAwardBadge(player, badgeId)
+	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
+	assert(type(badgeId) == "number", "Bad badgeId")
+
+	return Promise.spawn(function(resolve, reject)
+		local ok, err = pcall(function()
+			BadgeService:AwardBadge(player.UserId, badgeId)
+		end)
+
+		if not ok then
+			return reject(err)
+		end
+
+		return resolve(true)
+	end)
+end
+
+--[=[
+	Gets the badge info for the given badgeId.
+
+	@param badgeId number
+	@return Promise<BadgeInfoDictionary>
+]=]
+function BadgeUtils.promiseBadgeInfo(badgeId)
+	assert(type(badgeId) == "number", "Bad badgeId")
+
+	return Promise.spawn(function(resolve, reject)
+		local data
+		local ok, err = pcall(function()
+			data = BadgeService:GetBadgeInfoAsync(badgeId)
+		end)
+
+		if not ok then
+			return reject(err)
+		end
+		if not type(data) == "table" then
+			return reject("Failed to get a table of data of badgeInfo")
+		end
+
+		return resolve(data)
+	end)
+end
+
+return BadgeUtils

package/src/Server/BadgeUtils.lua

@@ -1,38 +0,0 @@
---[=[
-	Utility functions involving badges on Roblox
-	@class BadgeUtils
-]=]
-
-local BadgeService = game:GetService("BadgeService")
-
-local require = require(script.Parent.loader).load(script)
-
-local Promise = require("Promise")
-
-local BadgeUtils = {}
-
---[=[
-	Tries to reward a player to a badge inside of a promise.
-
-	@param player Player
-	@param badgeId number
-	@return Promise
-]=]
-function BadgeUtils.promiseAwardBadge(player, badgeId)
-	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
-	assert(type(badgeId) == "number", "Bad badgeId")
-
-	return Promise.spawn(function(resolve, reject)
-		local ok, err = pcall(function()
-			BadgeService:AwardBadge(player.UserId, badgeId)
-		end)
-
-		if not ok then
-			return reject(err)
-		end
-
-		return resolve(true)
-	end)
-end
-
-return BadgeUtils