@quenty/rbxthumb 1.0.1-canary.299.5bb1fa6.0

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## 1.0.1-canary.299.5bb1fa6.0 (2022-10-30)
+
+
+### Features
+
+* Add rbxthumb package ([19d94d3](https://github.com/Quenty/NevermoreEngine/commit/19d94d36755a560ae68081138286cffc25f134b3))

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2014-2022 Quenty
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,23 @@
+## RbxThumb
+<div align="center">
+  <a href="http://quenty.github.io/NevermoreEngine/">
+    <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/docs.yml/badge.svg" alt="Documentation status" />
+  </a>
+  <a href="https://discord.gg/mhtGUS8">
+    <img src="https://img.shields.io/discord/385151591524597761?color=5865F2&label=discord&logo=discord&logoColor=white" alt="Discord" />
+  </a>
+  <a href="https://github.com/Quenty/NevermoreEngine/actions">
+    <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/build.yml/badge.svg" alt="Build and release status" />
+  </a>
+</div>
+
+Wraps the rbxthumb URL api surface to generate a URL for a thumbnail on the cloud.
+
+These thumbnails are automatically batched for performance.
+
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/RbxThumbUtils">View docs →</a></div>
+
+## Installation
+```
+npm install @quenty/rbxthumb --save
+```

package/default.project.json

@@ -0,0 +1,6 @@
+{
+  "name": "rbxthumb",
+  "tree": {
+    "$path": "src"
+  }
+}

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@quenty/rbxthumb",
+  "version": "1.0.1-canary.299.5bb1fa6.0",
+  "description": "Wraps the rbxthumb URL api surface.",
+  "keywords": [
+    "Roblox",
+    "Nevermore",
+    "Lua",
+    "Thumbnail",
+    "rbxthumb"
+  ],
+  "bugs": {
+    "url": "https://github.com/Quenty/NevermoreEngine/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Quenty/NevermoreEngine.git",
+    "directory": "src/rbxthumb/"
+  },
+  "funding": {
+    "type": "patreon",
+    "url": "https://www.patreon.com/quenty"
+  },
+  "license": "MIT",
+  "contributors": [
+    "Quenty"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "5bb1fa6256a59039e42cdc1b2433929c9b3e6adb"
+}

package/src/Shared/RbxThumbUtils.lua

@@ -0,0 +1,215 @@
+--[=[
+	Wraps the rbxthumb URL api surface to generate a URL for a thumbnail on the cloud.
+
+	These thumbnails are automatically batched for performance.
+
+	@class RbxThumbUtils
+]=]
+
+local RbxThumbUtils = {}
+
+--[=[
+	Gets a thumbnail URL for a given content type and id
+
+	https://devforum.roblox.com/t/new-contentid-format-for-easy-thumbnail-loading/357335
+	https://create.roblox.com/docs/studio/asset-types#rbxthumb
+
+	Type:               Supported Sizes:
+	"Asset"             150x150, 420x420
+	"Avatar"            100x100, 352x352, 720x720
+	"AvatarHeadShot"    48x48,   60x60,   150x150
+	"BadgeIcon"         150x150
+	"BundleThumbnail"   150x150, 420x420
+	"GameIcon"          50x50,   150x150
+	"GamePass"          150x150
+	"GroupIcon"         150x150, 420x420
+	"Outfit"            150x150, 420x420
+
+	@param thumbnailType ThumbnailType
+	@param targetId number
+	@param width number
+	@param height number
+	@return string
+]=]
+function RbxThumbUtils.getThumbnailUrl(thumbnailType, targetId, width, height)
+	assert(type(thumbnailType) == "string", "Bad thumbnailType")
+	assert(type(targetId) == "number", "Bad targetId")
+	assert(type(width) == "number", "Bad width")
+	assert(type(height) == "number", "Bad height")
+
+	return string.format("rbxthumb://type=%s&id=%d&w=%d&h=%d", thumbnailType, targetId, width, height)
+end
+
+--[=[
+	Gets a Asset URL for use in an image label or other rendering application.
+
+	Supported sizes: 150x150, 420x420
+
+	@param targetId number
+	@param width number?
+	@param height number?
+	@return string
+]=]
+function RbxThumbUtils.getAssetThumbnailUrl(targetId, width, height)
+	assert(type(targetId) == "number", "Bad targetId")
+
+	width = width or 150
+	height = height or 150
+
+	return RbxThumbUtils.getThumbnailUrl("Asset", targetId, width, height)
+end
+
+--[=[
+	Gets a Avatar URL for use in an image label or other rendering application.
+
+	Supported sizes: 100x100, 352x352, 720x720
+
+	@param targetId number
+	@param width number?
+	@param height number?
+	@return string
+]=]
+function RbxThumbUtils.getAvatarThumbnailUrl(targetId, width, height)
+	assert(type(targetId) == "number", "Bad targetId")
+
+	width = width or 150
+	height = height or 150
+
+	return RbxThumbUtils.getThumbnailUrl("Avatar", targetId, width, height)
+end
+
+--[=[
+	Gets a AvatarHeadShot URL for use in an image label or other rendering application.
+
+	Supported sizes: 48x48, 60x60, 150x150
+
+	@param targetId number
+	@param width number?
+	@param height number?
+	@return string
+]=]
+function RbxThumbUtils.getAvatarHeadShotThumbnailUrl(targetId, width, height)
+	assert(type(targetId) == "number", "Bad targetId")
+
+	width = width or 150
+	height = height or 150
+
+	return RbxThumbUtils.getThumbnailUrl("AvatarHeadShot", targetId, width, height)
+end
+
+--[=[
+	Gets a BadgeIcon URL for use in an image label or other rendering application.
+
+	Supported sizes: 150x150
+
+	@param targetId number
+	@param width number?
+	@param height number?
+	@return string
+]=]
+function RbxThumbUtils.getBadgeIconThumbnailUrl(targetId, width, height)
+	assert(type(targetId) == "number", "Bad targetId")
+
+	width = width or 150
+	height = height or 150
+
+	return RbxThumbUtils.getThumbnailUrl("BadgeIcon", targetId, width, height)
+end
+
+--[=[
+	Gets a BundleThumbnail URL for use in an image label or other rendering application.
+
+	Supported sizes: 150x150, 420x420
+
+	@param targetId number
+	@param width number?
+	@param height number?
+	@return string
+]=]
+function RbxThumbUtils.getBundleThumbnailThumbnailUrl(targetId, width, height)
+	assert(type(targetId) == "number", "Bad targetId")
+
+	width = width or 150
+	height = height or 150
+
+	return RbxThumbUtils.getThumbnailUrl("BundleThumbnail", targetId, width, height)
+end
+
+--[=[
+	Gets a GameIcon URL for use in an image label or other rendering application.
+
+	Supported sizes: 50x50, 150x150
+
+	@param targetId number
+	@param width number?
+	@param height number?
+	@return string
+]=]
+function RbxThumbUtils.getGameIconThumbnailUrl(targetId, width, height)
+	assert(type(targetId) == "number", "Bad targetId")
+
+	width = width or 150
+	height = height or 150
+
+	return RbxThumbUtils.getThumbnailUrl("GameIcon", targetId, width, height)
+end
+
+--[=[
+	Gets a GamePass URL for use in an image label or other rendering application.
+
+	Supported sizes: 150x150
+
+	@param targetId number
+	@param width number?
+	@param height number?
+	@return string
+]=]
+function RbxThumbUtils.getGamePassThumbnailUrl(targetId, width, height)
+	assert(type(targetId) == "number", "Bad targetId")
+
+	width = width or 150
+	height = height or 150
+
+	return RbxThumbUtils.getThumbnailUrl("GamePass", targetId, width, height)
+end
+
+--[=[
+	Gets a GroupIcon URL for use in an image label or other rendering application.
+
+	Supported sizes: 150x150, 420x420
+
+	@param targetId number
+	@param width number?
+	@param height number?
+	@return string
+]=]
+function RbxThumbUtils.getGroupIconThumbnailUrl(targetId, width, height)
+	assert(type(targetId) == "number", "Bad targetId")
+
+	width = width or 150
+	height = height or 150
+
+	return RbxThumbUtils.getThumbnailUrl("GroupIcon", targetId, width, height)
+end
+
+--[=[
+	Gets a Outfit URL for use in an image label or other rendering application.
+
+	Supported sizes: 150x150, 420x420
+
+	@param targetId number
+	@param width number?
+	@param height number?
+	@return string
+]=]
+function RbxThumbUtils.getOutfitThumbnailUrl(targetId, width, height)
+	assert(type(targetId) == "number", "Bad targetId")
+
+	width = width or 150
+	height = height or 150
+
+	return RbxThumbUtils.getThumbnailUrl("Outfit", targetId, width, height)
+end
+
+
+return RbxThumbUtils