noblox-asset.js 7.4.0

package/lib/develop/configureItem.js

@@ -0,0 +1,210 @@
+// Includes
+const http = require('../util/http.js').func
+const getGeneralToken = require('../util/getGeneralToken.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+// Args
+exports.required = ['id', 'name', 'description']
+exports.optional = ['enableComments', 'sellForRobux', 'genreSelection', 'jar']
+
+// Docs
+/**
+ * 🔐 Configure an asset.
+ * @category Develop
+ * @alias configureItem
+ * @param {number} assetId - The id of the asset.
+ * @param {string} name - The new name of the asset.
+ * @param {string} description - The new description of the asset.
+ * @param {boolean=} enableComments - Enable comments on your asset.
+ * @param {number|boolean=} [sellForRobux=false] - The amount of robux to sell for; use a number for sellable assets, boolean for copyable assets
+ * @param {string=} [genreSelection="All"] - The genre of your asset.
+ * @returns {Promise<ConfigureItemResponse>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * noblox.configureItem(1117747196, "Item", "A cool item.", false, 100)
+**/
+
+// Define
+function configure (jar, token, id, name, description, enableComments, sellForRobux, genreSelection, sellingPrice) {
+  return http({
+    url: '//develop.roblox.com/v1/assets/' + id,
+    options: {
+      method: 'PATCH',
+      jar,
+      headers: {
+        'X-CSRF-TOKEN': token
+      },
+      json: {
+        name,
+        description,
+        enableComments,
+        genres: genreSelection || ['All'],
+        isCopyingAllowed: typeof (sellForRobux) === 'boolean' ? sellForRobux : null
+      },
+      resolveWithFullResponse: true
+    }
+  }).then(function (res) {
+    const json = JSON.parse(res.body)
+
+    if (!json.errors) {
+      const response = {
+        name,
+        description,
+        assetId: id
+      }
+      if (typeof sellForRobux === 'boolean') {
+        response.isCopyingAllowed = sellForRobux
+      } else {
+        response.price = sellingPrice || 0
+      }
+      return response
+    } else {
+      if (json.errors[0].code === 13) { // "Only a marketplace asset can be updated with IsCopyingAllowed."
+        throw new Error('Attempting to make a sellable asset copyable; it must be sold for robux. (Use a number for sellForRobux.)')
+      }
+      throw new RobloxAPIError(res)
+    }
+  })
+}
+
+function configureRobux (args) {
+  return http({
+    url: '//itemconfiguration.roblox.com/v1/assets/' + args.id + '/release',
+    options: {
+      method: 'POST',
+      jar: args.jar,
+      headers: {
+        'X-CSRF-TOKEN': args.token
+      },
+      json: {
+        saleStatus: args.sellForRobux ? 'OnSale' : 'OffSale',
+        priceConfiguration: {
+          priceInRobux: args.sellForRobux || 0
+        }
+      },
+      resolveWithFullResponse: true
+    }
+  })
+    .then(function (res) {
+      const json = res.body
+
+      if (!json.errors) {
+        return configure(args.jar, args.token, args.id, args.name, args.description, args.enableComments, args.sellForRobux, args.genreSelection, args.sellForRobux)
+      } else {
+        // Code 6: "Asset is released"; caused when changing the price of an on-sale asset from non-zero to non-zero
+        if (json.errors[0].code === 6) {
+          return http({
+            url: '//itemconfiguration.roblox.com/v1/assets/' + args.id + '/update-price',
+            options: {
+              method: 'POST',
+              jar: args.jar,
+              headers: {
+                'X-CSRF-TOKEN': args.token
+              },
+              json: {
+                priceConfiguration: {
+                  priceInRobux: args.sellForRobux
+                }
+              },
+              resolveWithFullResponse: true
+            }
+          }).then((res) => {
+            const err = res.body
+            if (!err.errors) {
+              return configure(args.jar, args.token, args.id, args.name, args.description, args.enableComments, args.sellForRobux, args.genreSelection, args.sellForRobux)
+            } else {
+              throw new Error(json.errors[0].message)
+            }
+          })
+        } else if (json.errors[0].code === 3) { // "Cannot release the associated asset type" - caused by copyable asset using sellForRobux: 2 or greater
+          // Throw an error as the developer may have intended to sell the asset for robux instead of making it free.
+          throw new Error('Attempting to sell a copyable asset for robux; it can only be made free. (Use true for sellForRobux.)')
+        } else if (json.errors[0].code === 20) { // "Cannot set the associated asset type to remove-from-release" - caused by copyable asset using sellForRobux: 0
+          // Continue and ignore the error as the intended outcome makes the asset private; set sellForRobux from 0 to false
+          return configure(args.jar, args.token, args.id, args.name, args.description, args.enableComments, args.sellForRobux, args.genreSelection, !!args.sellForRobux)
+        } else if (json.errors[0].code === 37) { // "AssetIsLimited" - Use the newer endpoint to update price and sale status
+          return http({
+            url: '//catalog.roblox.com/v1/catalog/items/details',
+            options: {
+              method: 'POST',
+              jar: args.jar,
+              json: {
+                items: [
+                  {
+                    id: args.id,
+                    itemType: 1
+                  }
+                ]
+              },
+              resolveWithFullResponse: true
+            }
+          }).then((response) => {
+            if (!response.ok) throw new Error(response.body)
+
+            const { collectibleItemId, price } = JSON.parse(response.body)
+
+            if (!collectibleItemId) throw new Error(`The publishing fee for asset ${args.id} has not been paid, you must do this in order to change or set the price.`)
+
+            return http({
+              url: `//itemconfiguration.roblox.com/v1/collectibles/${collectibleItemId}`,
+              options: {
+                method: 'PATCH',
+                jar: args.jar,
+                headers: {
+                  'X-CSRF-Token': args.token
+                },
+                json: {
+                  isFree: false,
+                  priceInRobux: args.sellForRobux || price,
+                  priceOffset: 0,
+                  quantityLimitPerUser: 0,
+                  resaleRestriction: 2,
+                  saleLocationConfiguration: {
+                    places: [],
+                    saleLocationType: 1
+                  },
+                  saleStatus: args.sellForRobux > 0 ? 0 : 1
+                },
+                resolveWithFullResponse: true
+              }
+            }).then((response) => {
+              if (!response.ok) throw new RobloxAPIError(response)
+
+              return {
+                name: args.name,
+                assetId: args.id,
+                description: args.description,
+                price: args.sellForRobux,
+                isCopyingAllowed: null
+              }
+            })
+          })
+        } else if (json.errors[0].code === 40) { // "Use collecibles publishing endpoint." - Publishing fee has not been paid for this asset
+          throw new Error(`The publishing fee for asset ${args.id} has not been paid, you must pay the fee before setting or updating the price.`)
+        }
+        throw new RobloxAPIError(res)
+      }
+    })
+}
+
+function runWithToken (args) {
+  const jar = args.jar
+  return getGeneralToken({
+    jar
+  })
+    .then(function (token) {
+      if (typeof (args.sellForRobux) === 'number') {
+        if (args.sellForRobux < 2 && args.sellForRobux !== 0) {
+          throw new Error('Assets cannot be sold for less than 2R.')
+        }
+        args.token = token
+        return configureRobux(args)
+      } else {
+        return configure(args.jar, token, args.id, args.name, args.description, args.enableComments, args.sellForRobux, args.genreSelection)
+      }
+    })
+}
+
+exports.func = function (args) {
+  return runWithToken(args)
+}

package/lib/develop/updateUniverse.js

@@ -0,0 +1,52 @@
+// Includes
+const http = require('../util/http.js').func
+const getGeneralToken = require('../util/getGeneralToken.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+// Args
+exports.required = ['universeId', 'settings']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Modifies a universe's settings
+ * @category Develop
+ * @alias updateUniverse
+ * @param {number} universeId - The universeId of the experience
+ * @param {UniverseSettings} settings - The settings to update
+ * @returns {Promise<UpdateUniverseResponse>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * noblox.updateUniverse(2421261122, { name: "The best game ever!" })
+**/
+
+// Define
+function updateUniverse (universeId, settings, jar, token) {
+  return new Promise((resolve, reject) => {
+    return http({
+      url: `//develop.roblox.com/v1/universes/${universeId}/configuration`,
+      options: {
+        method: 'PATCH',
+        jar,
+        headers: {
+          'X-CSRF-TOKEN': token
+        },
+        json: settings,
+        resolveWithFullResponse: true
+      }
+    }).then((res) => {
+      if (res.statusCode === 200) {
+        resolve(res.body)
+      } else {
+        reject(new RobloxAPIError(res))
+      }
+    }).catch(reject)
+  })
+}
+
+exports.func = function ({ universeId, settings, jar }) {
+  return getGeneralToken({ jar })
+    .then((token) => {
+      return updateUniverse(universeId, settings, jar, token)
+    })
+}

package/lib/develop/updateUniverseAccess.js

@@ -0,0 +1,54 @@
+// Includes
+const http = require('../util/http.js').func
+const getGeneralToken = require('../util/getGeneralToken.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+// Args
+exports.required = ['universeId', 'isPublic']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Modifies a universe's public access setting
+ * @category Develop
+ * @alias updateUniverseAccess
+ * @param {number} universeId - The universeId of the experience
+ * @param {boolean=} isPublic - The visibility and access of the universe; shuts down all running instances if set to false
+ * @returns {Promise<void>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * noblox.updateUniverseAccess(2421261122, true)
+**/
+
+// Define
+function updateUniverseAccess (universeId, isPublic, jar, token) {
+  return new Promise((resolve, reject) => {
+    return http({
+      url: `//develop.roblox.com/v1/universes/${universeId}/${isPublic ? 'activate' : 'deactivate'}`,
+      options: {
+        method: 'POST',
+        jar,
+        headers: {
+          'X-CSRF-TOKEN': token
+        },
+        json: {
+          universeId
+        },
+        resolveWithFullResponse: true
+      }
+    }).then((res) => {
+      if (res.statusCode === 200) {
+        resolve()
+      } else {
+        reject(new RobloxAPIError(res))
+      }
+    }).catch(error => reject(error))
+  })
+}
+
+exports.func = function ({ universeId, isPublic, jar }) {
+  return getGeneralToken({ jar })
+    .then((token) => {
+      return updateUniverseAccess(universeId, isPublic, jar, token)
+    })
+}

package/lib/economy/getGroupFunds.js

@@ -0,0 +1,42 @@
+// Includes
+const http = require('../util/http.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+// Args
+exports.required = ['group']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔓 Gets the amount of robux in a group.
+ * @category Group
+ * @alias getGroupFunds
+ * @param {number} group - The id of the group
+ * @returns {Promise<number>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie (optional if group funds are public)
+ * let robux = await noblox.getGroupFunds(9997719)
+**/
+
+// Define
+function getGroupFunds (group, jar) {
+  return http({
+    url: `//economy.roblox.com/v1/groups/${group}/currency`,
+    options: {
+      jar,
+      resolveWithFullResponse: true
+    }
+  })
+    .then((res) => {
+      const { robux } = JSON.parse(res.body)
+      if (res.statusCode === 200) {
+        return robux
+      } else {
+        throw new RobloxAPIError(res)
+      }
+    })
+}
+
+exports.func = function ({ group, jar }) {
+  return getGroupFunds(group, jar)
+}

package/lib/economy/getGroupPayoutEligibility.js

@@ -0,0 +1,55 @@
+// Includes
+const http = require('../util/http.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+// Args
+exports.required = ['group', 'members']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Get if a user can be paid from group funds.
+ * @category Group
+ * @alias getGroupPayoutEligibility
+ * @param {number} group - The id of the group.
+ * @param {number[]} members - The members to check payout status for.
+ * @returns {Promise<PayoutAllowedList>}
+ * @example const noblox = require("noblox.js")
+ * // Log in with cookie
+ * const payoutStatus = await noblox.getGroupPayoutEligibility(1, [2])
+ **/
+
+// Define
+function getGroupPayoutEligibility (group, members, jar) {
+  const memberList = []
+
+  for (const member of members) {
+    memberList.push(`userIds=${member}`)
+  }
+
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: `https://economy.roblox.com/v1/groups/${group}/users-payout-eligibility?${memberList.join('&')}`,
+      options: {
+        method: 'GET',
+        resolveWithFullResponse: true,
+        jar
+      }
+    }
+
+    return http(httpOpt)
+      .then(function (res) {
+        const responseData = JSON.parse(res.body)
+        if (res.statusCode !== 200) {
+          reject(new RobloxAPIError(res))
+        } else {
+          resolve(responseData)
+        }
+      })
+      .catch(error => reject(error))
+  })
+}
+
+exports.func = function (args) {
+  return getGroupPayoutEligibility(args.group, args.members, args.jar)
+}

package/lib/economy/getGroupRevenueSummary.js

@@ -0,0 +1,42 @@
+// Includes
+const http = require('../util/http.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+// Args
+exports.required = ['groupId']
+exports.optional = ['timeFrame', 'jar']
+
+// Docs
+/**
+ * 🔐 Gets recent Robux revenue summary for a group; shows pending Robux. | Requires "Spend group funds" permissions.
+ * @category Group
+ * @alias getGroupRevenueSummary
+ * @param {number} groupId - The group id to get Robux summary for.
+ * @param {("Day" | "Week" | "Month" | "Year")=} [timeFrame="Month"] - The time frame to get for.
+ * @returns {Promise<RevenueSummaryResponse>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * let revenueSummary = await noblox.getGroupRevenueSummary(9997719, "Year")
+**/
+
+// Define
+function getGroupRevenueSummary (group, timeFrame, jar) {
+  return http({
+    url: `//economy.roblox.com/v1/groups/${group}/revenue/summary/${timeFrame}`,
+    options: {
+      jar,
+      resolveWithFullResponse: true
+    }
+  })
+    .then((res) => {
+      if (res.statusCode === 200) {
+        return JSON.parse(res.body)
+      } else {
+        throw new RobloxAPIError(res)
+      }
+    })
+}
+
+exports.func = function ({ groupId, timeFrame = 'Month', jar }) {
+  return getGroupRevenueSummary(groupId, timeFrame, jar)
+}

package/lib/economy/getGroupTransactions.js

@@ -0,0 +1,32 @@
+const getPageResults = require('../util/getPageResults.js').func
+
+exports.required = ['group']
+exports.optional = ['transactionType', 'limit', 'sortOrder', 'jar']
+
+// Docs
+/**
+ * 🔐 Get a group's transactions.
+ * @category Group
+ * @alias getGroupTransactions
+ * @param {number} group - The id of the group.
+ * @param {("Sale" | "Purchase" | "AffiliateSale" | "DevEx" | "GroupPayout" | "AdImpressionPayout")} [transactionType=Sale] - The transaction type.
+ * @param {number} limit - The number of transactions being fetched in total.
+ * @param {SortOrder=} [sortOrder=Asc] - The cursor for the next page.
+ * @returns {Promise<TransactionItem[]>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * const transactions = await noblox.getGroupTransactions(1, "Sale")
+**/
+
+// Define
+exports.func = function (args) {
+  return getPageResults({
+    jar: args.jar,
+    url: `//economy.roblox.com/v2/groups/${args.group}/transactions`,
+    query: {
+      transactionType: args.transactionType || 'Sale'
+    },
+    sortOrder: args.sortOrder || 'Asc',
+    limit: args.limit
+  })
+}

package/lib/economy/getResaleData.js

@@ -0,0 +1,48 @@
+// Includes
+const http = require('../util/http').func
+const RobloxAPIError = require('../util/apiError')
+
+// Args
+exports.required = ['assetId']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * ✅ Get the recent sale history (price and volume per day for 180 days) of a limited asset.
+ * @category Assets
+ * @alias getResaleData
+ * @param {number} assetId - The id of the asset.
+ * @returns {Promise<ResaleDataResponse>}
+ * @example const noblox = require("noblox.js")
+ * const resaleData = await noblox.getResaleData(20573078)
+**/
+
+// Define
+const getResaleData = async (assetId) => {
+  return http({
+    url: `//economy.roblox.com/v1/assets/${assetId}/resale-data`,
+    options: {
+      resolveWithFullResponse: true
+    }
+  }).then((res) => {
+    if (res.statusCode === 200) {
+      const resaleData = JSON.parse(res.body)
+      for (const priceDataPoint of resaleData.priceDataPoints) {
+        priceDataPoint.date = new Date(priceDataPoint.date)
+      }
+      for (const volumeDataPoint of resaleData.volumeDataPoints) {
+        volumeDataPoint.date = new Date(volumeDataPoint.date)
+      }
+      return resaleData
+    } else {
+      throw new RobloxAPIError(res)
+    }
+  })
+}
+
+exports.func = function ({ assetId }) {
+  if (isNaN(assetId)) {
+    throw new Error('The provided assetId is not a number.')
+  }
+  return getResaleData(assetId)
+}

package/lib/economy/getResellers.js

@@ -0,0 +1,35 @@
+// Includes
+const getPageResults = require('../util/getPageResults.js').func
+
+// Args
+exports.required = ['assetId']
+exports.optional = ['limit', 'jar']
+
+// Docs
+/**
+ * 🔐 Gets available resale copies of a limited asset.
+ * @category Assets
+ * @alias getResellers
+ * @param {number} assetId - The id of the asset.
+ * @param {Limit=} limit - The max number of resellers to return.
+ * @returns {Promise<ResellerData[]>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * const resellers = await noblox.getResellers(20573078)
+**/
+
+// Define
+const getResellers = async (assetId, limit, jar) => {
+  return getPageResults({
+    url: `//economy.roblox.com/v1/assets/${assetId}/resellers`,
+    limit,
+    jar
+  })
+}
+
+exports.func = function ({ assetId, limit, jar }) {
+  if (isNaN(assetId)) {
+    throw new Error('The provided assetId ID is not a number.')
+  }
+  return getResellers(assetId, limit, jar)
+}

package/lib/economy/getUserFunds.js

@@ -0,0 +1,43 @@
+// Includes
+const http = require('../util/http.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+// Args
+exports.required = ['userId']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔓 Gets the amount of robux for the authenticated user.
+ * @category User
+ * @param {number} userId - Must match the userId of the authenticated user
+ * @alias getUserFunds
+ * @returns {Promise<number>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * const currentUser = await noblox.setCookie(process.env.ROBLOXCOOKIE)
+ * const robux = await noblox.getUserFunds(currentUser.id)
+ */
+
+// Define
+function getUserFunds (userId, jar) {
+  return http({
+    url: `//economy.roblox.com/v1/users/${userId}/currency`,
+    options: {
+      jar,
+      resolveWithFullResponse: true
+    }
+  })
+    .then((res) => {
+      const { robux } = JSON.parse(res.body)
+      if (res.statusCode === 200) {
+        return robux
+      } else {
+        throw new RobloxAPIError(res)
+      }
+    })
+}
+
+exports.func = function ({ userId, jar }) {
+  return getUserFunds(userId, jar)
+}

package/lib/economy/getUserTransactions.js

@@ -0,0 +1,34 @@
+const getPageResults = require('../util/getPageResults.js').func
+const getCurrentUser = require('../util/getCurrentUser.js').func
+
+exports.required = []
+exports.optional = ['transactionType', 'limit', 'sortOrder', 'jar']
+
+// Docs
+/**
+ * 🔐 Get a user's transactions.
+ * @category User
+ * @alias getUserTransactions
+ * @param {("Sale" | "Purchase" | "AffiliateSale" | "DevEx" | "GroupPayout" | "AdImpressionPayout")} [transactionType=Sale] - The type of transactions being fetched.
+ * @param {number} limit - The number of transactions being fetched in total.
+ * @param {SortOrder=} [sortOrder=Asc] - The cursor for the next page.
+ * @returns {Promise<TransactionItem[]>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * let transactions = await noblox.getUserTransactions("Sale", 10)
+**/
+
+exports.func = async function (args) {
+  const jar = args.jar
+  const currentUser = await getCurrentUser({ jar })
+  // return getTransactions(currentUser.UserID, transactionType, limit, cursor)
+  return getPageResults({
+    jar: args.jar,
+    url: `//economy.roblox.com/v2/users/${currentUser.UserID}/transactions`,
+    query: {
+      transactionType: args.transactionType || 'Sale'
+    },
+    sortOrder: args.sortOrder || 'Asc',
+    limit: args.limit
+  })
+}