@quenty/rbxthumb 1.1.0 → 1.2.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.
 
+# [1.2.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/rbxthumb@1.1.0...@quenty/rbxthumb@1.2.0) (2023-02-27)
+
+
+### Features
+
+* Add RbxThumbUtils.avatarItemTypeToThumbnailType(avatarItemType) ([496f505](https://github.com/Quenty/NevermoreEngine/commit/496f5057b35e653ff5ef47e48330490644f8d6e4))
+
+
+
+
+
 # 1.1.0 (2022-10-30)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/rbxthumb",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Wraps the rbxthumb URL api surface.",
   "keywords": [
     "Roblox",
@@ -28,5 +28,9 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "14f4c0bcf449d395411ef413c38fd09669e5d6c0"
+  "dependencies": {
+    "@quenty/loader": "^6.1.0",
+    "@quenty/table": "^3.2.0"
+  },
+  "gitHead": "67ba3f581ff4eb7272de9607e578969ce9ae5a8e"
 }

package/src/Shared/RbxThumbUtils.lua

@@ -6,6 +6,10 @@
 	@class RbxThumbUtils
 ]=]
 
+local require = require(script.Parent.loader).load(script)
+
+local RbxThumbnailTypes = require("RbxThumbnailTypes")
+
 local RbxThumbUtils = {}
 
 --[=[
@@ -25,7 +29,7 @@ local RbxThumbUtils = {}
 	"GroupIcon"         150x150, 420x420
 	"Outfit"            150x150, 420x420
 
-	@param thumbnailType ThumbnailType
+	@param thumbnailType RbxThumbnailTypes
 	@param targetId number
 	@param width number
 	@param height number
@@ -40,6 +44,21 @@ function RbxThumbUtils.getThumbnailUrl(thumbnailType, targetId, width, height)
 	return string.format("rbxthumb://type=%s&id=%d&w=%d&h=%d", thumbnailType, targetId, width, height)
 end
 
+--[=[
+	Converts an AvatarItemType to a string thumbnailType for thumbnail generation
+	@param avatarItemType AvatarItemType
+	@return string
+]=]
+function RbxThumbUtils.avatarItemTypeToThumbnailType(avatarItemType)
+	if avatarItemType == Enum.AvatarItemType.Asset then
+		return RbxThumbnailTypes.ASSET
+	elseif avatarItemType == Enum.AvatarItemType.Bundle then
+		return RbxThumbnailTypes.BUNDLE
+	else
+		error("Unknown avatarItemType")
+	end
+end
+
 --[=[
 	Gets a Asset URL for use in an image label or other rendering application.
 
@@ -56,7 +75,7 @@ function RbxThumbUtils.getAssetThumbnailUrl(targetId, width, height)
 	width = width or 150
 	height = height or 150
 
-	return RbxThumbUtils.getThumbnailUrl("Asset", targetId, width, height)
+	return RbxThumbUtils.getThumbnailUrl(RbxThumbnailTypes.ASSET, targetId, width, height)
 end
 
 --[=[
@@ -75,7 +94,7 @@ function RbxThumbUtils.getAvatarThumbnailUrl(targetId, width, height)
 	width = width or 150
 	height = height or 150
 
-	return RbxThumbUtils.getThumbnailUrl("Avatar", targetId, width, height)
+	return RbxThumbUtils.getThumbnailUrl(RbxThumbnailTypes.AVATAR, targetId, width, height)
 end
 
 --[=[
@@ -94,7 +113,7 @@ function RbxThumbUtils.getAvatarHeadShotThumbnailUrl(targetId, width, height)
 	width = width or 150
 	height = height or 150
 
-	return RbxThumbUtils.getThumbnailUrl("AvatarHeadShot", targetId, width, height)
+	return RbxThumbUtils.getThumbnailUrl(RbxThumbnailTypes.AVATAR_HEAD_SHOT, targetId, width, height)
 end
 
 --[=[
@@ -113,7 +132,7 @@ function RbxThumbUtils.getBadgeIconThumbnailUrl(targetId, width, height)
 	width = width or 150
 	height = height or 150
 
-	return RbxThumbUtils.getThumbnailUrl("BadgeIcon", targetId, width, height)
+	return RbxThumbUtils.getThumbnailUrl(RbxThumbnailTypes.BADGE, targetId, width, height)
 end
 
 --[=[
@@ -132,7 +151,7 @@ function RbxThumbUtils.getBundleThumbnailThumbnailUrl(targetId, width, height)
 	width = width or 150
 	height = height or 150
 
-	return RbxThumbUtils.getThumbnailUrl("BundleThumbnail", targetId, width, height)
+	return RbxThumbUtils.getThumbnailUrl(RbxThumbnailTypes.BUNDLE, targetId, width, height)
 end
 
 --[=[
@@ -151,7 +170,7 @@ function RbxThumbUtils.getGameIconThumbnailUrl(targetId, width, height)
 	width = width or 150
 	height = height or 150
 
-	return RbxThumbUtils.getThumbnailUrl("GameIcon", targetId, width, height)
+	return RbxThumbUtils.getThumbnailUrl(RbxThumbnailTypes.GAME_ICON, targetId, width, height)
 end
 
 --[=[
@@ -170,7 +189,7 @@ function RbxThumbUtils.getGamePassThumbnailUrl(targetId, width, height)
 	width = width or 150
 	height = height or 150
 
-	return RbxThumbUtils.getThumbnailUrl("GamePass", targetId, width, height)
+	return RbxThumbUtils.getThumbnailUrl(RbxThumbnailTypes.GAME_PASS, targetId, width, height)
 end
 
 --[=[
@@ -189,7 +208,7 @@ function RbxThumbUtils.getGroupIconThumbnailUrl(targetId, width, height)
 	width = width or 150
 	height = height or 150
 
-	return RbxThumbUtils.getThumbnailUrl("GroupIcon", targetId, width, height)
+	return RbxThumbUtils.getThumbnailUrl(RbxThumbnailTypes.GROUP_ICON, targetId, width, height)
 end
 
 --[=[
@@ -208,7 +227,7 @@ function RbxThumbUtils.getOutfitThumbnailUrl(targetId, width, height)
 	width = width or 150
 	height = height or 150
 
-	return RbxThumbUtils.getThumbnailUrl("Outfit", targetId, width, height)
+	return RbxThumbUtils.getThumbnailUrl(RbxThumbnailTypes.OUTFIT, targetId, width, height)
 end
 
 

package/src/Shared/RbxThumbnailTypes.lua

@@ -0,0 +1,20 @@
+--[=[
+	Canonical RbxThumbnailTypes
+	@class RbxThumbnailTypes
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local Table = require("Table")
+
+return Table.readonly({
+	ASSET = "Asset";
+	AVATAR = "Avatar";
+	AVATAR_HEAD_SHOT = "AvatarHeadShot";
+	BADGE = "BadgeIcon";
+	BUNDLE = "BundleThumbnail";
+	GAME_ICON = "GameIcon";
+	GAME_PASS = "GamePass";
+	GROUP_ICON = "GroupIcon";
+	OUTFIT = "Outfit";
+})