@quenty/marketplaceutils 3.3.0 → 3.4.0-canary.241.a4e8214.0

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.4.0-canary.241.a4e8214.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/marketplaceutils@3.3.1...@quenty/marketplaceutils@3.4.0-canary.241.a4e8214.0) (2022-01-03)
+
+**Note:** Version bump only for package @quenty/marketplaceutils
+
+
+
+
+
+## [3.3.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/marketplaceutils@3.3.0...@quenty/marketplaceutils@3.3.1) (2021-12-30)
+
+**Note:** Version bump only for package @quenty/marketplaceutils
+
+
+
+
+
 # [3.3.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/marketplaceutils@3.2.0...@quenty/marketplaceutils@3.3.0) (2021-12-18)
 
 **Note:** Version bump only for package @quenty/marketplaceutils

package/README.md

@@ -1,10 +1,10 @@
 ## MarketplaceUtils
 <div align="center">
-  <a href="http://quenty.github.io/api/">
-    <img src="https://img.shields.io/badge/docs-website-green.svg" alt="Documentation" />
+  <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/badge/discord-nevermore-blue.svg" alt="Discord" />
+    <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" />
@@ -13,17 +13,9 @@
 
 Provides utility methods for MarketplaceService
 
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/MarketplaceUtils">View docs →</a></div>
+
 ## Installation
 ```
 npm install @quenty/marketplaceutils --save
-```
-
-## Usage
-Usage is designed to be simple.
-
-### `MarketplaceUtils.promiseProductInfo(assetId, infoType)`
-
-### `MarketplaceUtils.promiseUserOwnsGamePass(userId, gamePassId)`
-
-### `MarketplaceUtils.promisePlayerOwnsAsset(player, assetId)`
-
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/marketplaceutils",
-  "version": "3.3.0",
+  "version": "3.4.0-canary.241.a4e8214.0",
   "description": "Provides utility methods for MarketplaceService",
   "keywords": [
     "Roblox",
@@ -26,11 +26,11 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/loader": "^3.1.1",
-    "@quenty/promise": "^3.3.0"
+    "@quenty/loader": "3.2.0-canary.241.a4e8214.0",
+    "@quenty/promise": "3.4.0-canary.241.a4e8214.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "6eb398e9fb81191f0815885f807ab0cb3bb9bad1"
+  "gitHead": "a4e821471f35998d63f38a4f4a578e07b4e79035"
 }

package/src/Shared/MarketplaceUtils.lua

@@ -1,5 +1,7 @@
---- Provides utility methods for MarketplaceService
--- @module MarketplaceUtils
+--[=[
+	Provides utility methods for MarketplaceService
+	@class MarketplaceUtils
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -9,6 +11,62 @@ local Promise = require("Promise")
 
 local MarketplaceUtils = {}
 
+--[=[
+	Product info about the creator. See [MarketplaceService.GetProductInfo].
+	@interface CreatorProductInfo
+	.CreatorType string -- Either User or Group
+	.CreatorTargetId number -- The ID of the creator user or group
+	.Name string -- The name/username of the creator
+	.Id number -- (Use CreatorTargetId instead)
+	@within MarketplaceUtils
+]=]
+
+--[=[
+	Product info result for assets.
+	@interface AssetProductInfo
+	.Creator CreatorProductInfo -- A table of information describing the creator of the asset
+	.AssetId number -- If InfoType was Asset, this is the ID of the given asset.
+	.AssetTypeId number -- The type of asset (e.g. place, model, shirt)*
+	.IsForSale boolean -- Describes whether the asset is purchasable
+	.IsLimited boolean -- Describes whether the asset is a "limited item" that is no longer (if ever) sold
+	.IsLimitedUnique boolean -- Describes whether the asset is a "limited unique" ("Limited U") item
+	.IsNew boolean -- Describes whether the asset is marked as "new" in the catalog
+	.Remaining number -- The remaining number of items a limited unique item may be sold
+	.Sales number -- The number of items the asset has been sold
+	.Name string -- The name shown on the asset's page
+	.Description string -- The description as shown on the asset's page; can be nil if blank
+	.PriceInRobux number -- The cost of purchasing the asset using Robux
+	.Created string -- Timestamp of when the asset was created, e.g. 2018-08-01T17:55:11.98Z
+	.Updated string -- Timestamp of when the asset was last updated by its creator, e.g. 2018-08-01T17:55:11.98Z
+	.ContentRatingTypeId number -- Indicates whether the item is marked as 13+ in catalog
+	.MinimumMembershipLevel number -- The minimum subscription level necessary to purchase the item
+	.IsPublicDomain boolean -- Describes whether the asset can be taken for free
+	@within MarketplaceUtils
+]=]
+
+--[=[
+	Product info result for gamepasses.
+	@interface GamepassOrDeveloperProductInfo
+	.Creator CreatorProductInfo -- A table of information describing the creator of the asset
+	.ProductId number -- If the InfoType was Product, this is the product ID
+	.IconImageAssetId number -- This is the asset ID of the product/pass icon, or 0 if there isn't one
+	.Name string -- The name shown on the asset's page
+	.Description string -- The description as shown on the asset's page; can be nil if blank
+	.PriceInRobux number -- The cost of purchasing the asset using Robux
+	.Created string -- Timestamp of when the asset was created, e.g. 2018-08-01T17:55:11.98Z
+	.Updated string -- Timestamp of when the asset was last updated by its creator, e.g. 2018-08-01T17:55:11.98Z
+	.ContentRatingTypeId number -- Indicates whether the item is marked as 13+ in catalog
+	.MinimumMembershipLevel number -- The minimum subscription level necessary to purchase the item
+	.IsPublicDomain boolean -- Describes whether the asset can be taken for free
+	@within MarketplaceUtils
+]=]
+
+--[=[
+	Wraps [MarketplaceService.GetProductInfo] and retrieves information about
+	@param assetId number
+	@param infoType InfoType
+	@return Promise<AssetProductInfo | GamepassOrDeveloperProductInfo>
+]=]
 function MarketplaceUtils.promiseProductInfo(assetId, infoType)
 	assert(type(assetId) == "number", "Bad assetId")
 	assert(typeof(infoType) == "EnumItem", "Bad infoType")
@@ -29,6 +87,12 @@ function MarketplaceUtils.promiseProductInfo(assetId, infoType)
 	end)
 end
 
+--[=[
+	Retrieves whether a player owns a gamepass.
+	@param userId number
+	@param gamePassId number
+	@return Promise<boolean>
+]=]
 function MarketplaceUtils.promiseUserOwnsGamePass(userId, gamePassId)
 	assert(typeof(userId) == "number", "Bad userId")
 	assert(type(gamePassId) == "number", "Bad gamePassId")
@@ -48,7 +112,12 @@ function MarketplaceUtils.promiseUserOwnsGamePass(userId, gamePassId)
 	end)
 end
 
--- Such as a hat or some other item!
+--[=[
+	Retrieves whether a player owns an asset, such as a hat or some other item.
+	@param player Player
+	@param assetId number
+	@return Promise<boolean>
+]=]
 function MarketplaceUtils.promisePlayerOwnsAsset(player, assetId)
 	assert(typeof(player) == "Instance", "Bad player")
 	assert(type(assetId) == "number", "Bad assetId")
@@ -68,5 +137,4 @@ function MarketplaceUtils.promisePlayerOwnsAsset(player, assetId)
 	end)
 end
 
-
-return MarketplaceUtils
+return MarketplaceUtils