@quenty/accessorytypeutils 1.0.1-canary.478.013677d.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.478.013677d.0 (2024-08-24)
+
+
+### Features
+
+* Add AccessoryTypeUtils ([dd92f34](https://github.com/Quenty/NevermoreEngine/commit/dd92f349d0331a92921046cdb3e446dad8052f10))

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2014-2024 James Onnen (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 @@
+## AccessoryTypeUtils
+
+<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>
+
+Utility methods for accessory types
+
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/AccessoryTypeUtilsUtils">View docs →</a></div>
+
+## Installation
+
+```
+npm install @quenty/accessorytypeutils --save
+```

package/default.project.json

@@ -0,0 +1,7 @@
+{
+  "name": "accessorytypeutils",
+  "globIgnorePaths": [ "**/.package-lock.json" ],
+  "tree": {
+    "$path": "src"
+  }
+}

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@quenty/accessorytypeutils",
+  "version": "1.0.1-canary.478.013677d.0",
+  "description": "Utility methods for accessory types",
+  "keywords": [
+    "Roblox",
+    "Nevermore",
+    "Lua",
+    "accessorytypeutils"
+  ],
+  "bugs": {
+    "url": "https://github.com/Quenty/NevermoreEngine/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Quenty/NevermoreEngine.git",
+    "directory": "src/accessorytypeutils/"
+  },
+  "funding": {
+    "type": "patreon",
+    "url": "https://www.patreon.com/quenty"
+  },
+  "license": "MIT",
+  "contributors": [
+    "Quenty"
+  ],
+  "dependencies": {
+    "@quenty/loader": "10.3.1-canary.478.013677d.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "013677ddf1f34b223c027d332d00450722b8fd41"
+}

package/src/Shared/AccessoryTypeUtils.lua

@@ -0,0 +1,73 @@
+--[=[
+	@class AccessoryTypeUtils
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local AvatarEditorService = game:GetService("AvatarEditorService")
+
+local AccessoryTypeUtils = {}
+
+function AccessoryTypeUtils.tryGetAccessoryType(avatarAssetType: AvatarAssetType): (AccessoryType?, string?)
+	if not avatarAssetType then
+		return nil, "No avatarAssetType"
+	end
+
+	local accessoryType
+	local ok, err = pcall(function()
+		accessoryType = AvatarEditorService:GetAccessoryType(avatarAssetType)
+	end)
+	if not ok then
+		return nil, err or "Failed to GetAccessoryType from avatarAssetType"
+	end
+
+	return accessoryType
+end
+
+function AccessoryTypeUtils.getAccessoryTypeFromName(accessoryType: string): AccessoryType
+	for _, enumItem in pairs(Enum.AccessoryType:GetEnumItems()) do
+		if enumItem.Name == accessoryType then
+			return enumItem
+		end
+	end
+
+	return Enum.AccessoryType.Unknown
+end
+
+--[=[
+	Converts an enum value (retrieved from MarketplaceService) into a proper enum if possible
+
+	@param assetTypeId number
+	@return AssetType | nl
+]=]
+function AccessoryTypeUtils.convertAssetTypeIdToAssetType(assetTypeId): AssetType
+	assert(type(assetTypeId) == "number", "Bad assetTypeId")
+
+	for _, enumItem in pairs(Enum.AssetType:GetEnumItems()) do
+		if enumItem.Value == assetTypeId then
+			return enumItem
+		end
+	end
+
+	return nil
+end
+
+--[=[
+	Converts an enum value (retrieved from MarketplaceService) into a proper enum if possible
+
+	@param assetTypeId number
+	@return AvatarAssetType | nil
+]=]
+function AccessoryTypeUtils.convertAssetTypeIdToAvatarAssetType(assetTypeId): AvatarAssetType
+	assert(type(assetTypeId) == "number", "Bad assetTypeId")
+
+	for _, enumItem in pairs(Enum.AvatarAssetType:GetEnumItems()) do
+		if enumItem.Value == assetTypeId then
+			return enumItem
+		end
+	end
+
+	return nil
+end
+
+return AccessoryTypeUtils

package/src/node_modules.project.json

@@ -0,0 +1,7 @@
+{
+  "name": "node_modules",
+  "globIgnorePaths": [ "**/.package-lock.json" ],
+  "tree": {
+    "$path": { "optional": "../node_modules" }
+  }
+}

package/test/default.project.json

@@ -0,0 +1,12 @@
+{
+  "name": "AccessoryTypeUtilsTest",
+  "globIgnorePaths": [ "**/.package-lock.json" ],
+  "tree": {
+    "$className": "DataModel",
+    "ServerScriptService": {
+      "accessorytypeutils": {
+        "$path": ".."
+      }
+    }
+  }
+}