noblox.ts 4.10.5

package/lib/develop/configureItem.js

@@ -0,0 +1,142 @@
+// Includes
+const http = require('../util/http.js').func
+const getGeneralToken = require('../util/getGeneralToken.js').func
+
+// 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: jar,
+      headers: {
+        'X-CSRF-TOKEN': token
+      },
+      json: {
+        name: name,
+        description: description,
+        enableComments: enableComments,
+        genres: genreSelection || ['All'],
+        isCopyingAllowed: typeof (sellForRobux) === 'boolean' ? sellForRobux : null
+      }
+    }
+  }).then(function (json) {
+    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 Error(json.errors[0].message)
+    }
+  })
+}
+
+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
+        }
+      }
+    }
+  })
+    .then(function (json) {
+      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
+                }
+              }
+            }
+          }).then((err) => {
+            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)
+        }
+        throw new Error(`An unknown error occurred: [${json.errors[0].code}] ${json.errors[0].message}`)
+      }
+    })
+}
+
+function runWithToken (args) {
+  const jar = args.jar
+  return getGeneralToken({
+    jar: 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,53 @@
+// Includes
+const http = require('../util/http.js').func
+const getGeneralToken = require('../util/getGeneralToken.js').func
+
+// 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(({ statusCode, body }) => {
+      if (statusCode === 200) {
+        resolve(body)
+      } else if (body && body.errors) {
+        reject(new Error(`[${statusCode}] ${body.errors[0].message} | universeId: ${universeId}, settings: ${JSON.stringify(settings)} ${body.errors.field ? ` | ${body.errors.field} is incorrect` : ''}`))
+      } else {
+        reject(new Error(`An unknown error occurred with updateUniverse() | [${statusCode}] universeId: ${universeId}, settings: ${JSON.stringify(settings)}`))
+      }
+    }).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,55 @@
+// Includes
+const http = require('../util/http.js').func
+const getGeneralToken = require('../util/getGeneralToken.js').func
+
+// 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(({ statusCode, body }) => {
+      if (statusCode === 200) {
+        resolve()
+      } else if (body && body.errors) {
+        reject(new Error(`[${statusCode}] ${body.errors[0].message} | universeId: ${universeId}, isPublic: ${isPublic} ${body.errors.field ? ` | ${body.errors.field} is incorrect` : ''}`))
+      } else {
+        reject(new Error(`An unknown error occurred with updateUniverseAccess() | [${statusCode}] universeId: ${universeId}, isPublic: ${isPublic}`))
+      }
+    }).catch(error => reject(error))
+  })
+}
+
+exports.func = function ({ universeId, isPublic, jar }) {
+  return getGeneralToken({ jar })
+    .then((token) => {
+      return updateUniverseAccess(universeId, isPublic, jar, token)
+    })
+}

package/lib/economy/buy.js

@@ -0,0 +1,99 @@
+// Includes
+const http = require('../util/http.js').func
+const getProductInfo = require('../asset/getProductInfo.js').func
+const getGeneralToken = require('../util/getGeneralToken.js').func
+
+// Args
+exports.required = [['asset', 'product']]
+exports.optional = ['price', 'jar']
+
+// Docs
+/**
+ * 🔐 Buy an asset from the marketplace.
+ * @category Assets
+ * @param {number} asset - The ID of the product.
+ * @param {number=} price - The price of the product.
+ * @returns {Promise<BuyAssetResponse>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * noblox.buy(1117747196)
+**/
+
+// Define
+function buy (jar, token, product, price) {
+  const robux = product.PriceInRobux || 0
+  const productId = product.ProductId
+  if (price) {
+    if (typeof price === 'number') {
+      if (robux !== price) {
+        throw new Error('Price requirement not met. Requested price: ' + price + ' Actual price: ' + robux)
+      }
+    } else if (typeof price === 'object') {
+      const high = price.high
+      const low = price.low
+      if (high) {
+        if (robux > high) {
+          throw new Error('Price requirement not met. Requested price: <=' + high + ' Actual price: ' + robux)
+        }
+      }
+      if (low) {
+        if (robux < low) {
+          throw new Error('Price requirement not met. Requested price: >=' + low + ' Actual price: ' + robux)
+        }
+      }
+    }
+  }
+  const httpOpt = {
+    url: '//economy.roblox.com/v1/purchases/products/' + productId,
+    options: {
+      method: 'POST',
+      jar: jar,
+      headers: {
+        'X-CSRF-TOKEN': token
+      },
+      json: {
+        expectedCurrency: 1,
+        expectedPrice: robux,
+        expectedSellerId: product.Creator.Id
+      }
+    }
+  }
+  return http(httpOpt)
+    .then(function (json) {
+      let err = json.errorMsg
+      if (json.reason === 'InsufficientFunds') {
+        err = 'You need ' + json.shortfallPrice + ' more robux to purchase this item.'
+      } else if (json.errorMsg) {
+        err = json.errorMsg
+      }
+      if (!err) {
+        return { productId, price: robux }
+      } else {
+        throw new Error(err)
+      }
+    })
+}
+
+function runWithToken (args) {
+  const jar = args.jar
+  return getGeneralToken({
+    jar: jar
+  })
+    .then(function (token) {
+      return buy(jar, token, args.product, args.price)
+    })
+}
+
+exports.func = function (args) {
+  if (!args.product) {
+    return getProductInfo({
+      asset: args.asset
+    })
+      .then(function (product) {
+        args.product = product
+        return runWithToken(args)
+      })
+  } else {
+    return runWithToken(args)
+  }
+}

package/lib/economy/getGroupFunds.js

@@ -0,0 +1,43 @@
+// Includes
+const http = require('../util/http.js').func
+
+// 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: jar,
+      resolveWithFullResponse: true
+    }
+  })
+    .then(({ statusCode, body }) => {
+      const { robux, errors } = JSON.parse(body)
+      if (statusCode === 200) {
+        return robux
+      } else if (statusCode === 400 || statusCode === 403) {
+        throw new Error(`${errors[0].message} | groupId: ${group}`)
+      } else {
+        throw new Error(`An unknown error occurred with getGroupFunds() | [${statusCode}] groupId: ${group}`)
+      }
+    })
+}
+
+exports.func = function ({ group, jar }) {
+  return getGroupFunds(group, jar)
+}

package/lib/economy/getGroupRevenueSummary.js

@@ -0,0 +1,48 @@
+// Includes
+const http = require('../util/http.js').func
+
+// 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: jar,
+      resolveWithFullResponse: true
+    }
+  })
+    .then(({ statusCode, body }) => {
+      const { errors } = JSON.parse(body)
+      if (statusCode === 200) {
+        return JSON.parse(body)
+      } else if (statusCode === 400) {
+        throw new Error(`${errors[0].message} | group: ${group}, timeFrame: ${timeFrame}`)
+      } else if (statusCode === 401) {
+        throw new Error(`${errors[0].message} (Are you logged in?) | group: ${group}, timeFrame: ${timeFrame}`)
+      } else if (statusCode === 403) {
+        throw new Error('Insufficient permissions: "Spend group funds" role permissions required')
+      } else {
+        throw new Error(`An unknown error occurred with getGroupRevenueSummary() | [${statusCode}] group: ${group}, timeFrame: ${timeFrame}`)
+      }
+    })
+}
+
+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,54 @@
+// Includes
+const http = require('../util/http').func
+
+// 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(({ body, statusCode }) => {
+    const { errors } = JSON.parse(body)
+    if (statusCode === 200) {
+      try {
+        const resaleData = JSON.parse(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
+      } catch (err) {
+        throw new Error(`An unknown error occurred with getResaleData() | [${statusCode}] assetId: ${assetId}`)
+      }
+    } else if (statusCode === 400) {
+      throw new Error(`${errors[0].message} | assetId: ${assetId}`)
+    } else {
+      throw new Error(`An unknown error occurred with getResaleData() | [${statusCode}] assetId: ${assetId}`)
+    }
+  })
+}
+
+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/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: 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
+  })
+}

package/lib/economy/onGroupTransaction.js

@@ -0,0 +1,74 @@
+// Includes
+const shortPoll = require('../util/shortPoll.js').func
+const getGroupTransactions = require('./getGroupTransactions.js').func
+
+// Args
+exports.required = ['groupId', 'transactionType']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 An event for when a group transaction is made, for example a purchase. This event has a rate of one request per 60
+ * sec, which is more than the typical 10 seconds. This is due to the unusually low rate limit on the transactions
+ * endpoint.
+ *
+ * Note: The `created` field returned by this event will always have 0 milliseconds. This is due to a quirk on Roblox's side:
+ * These millisecond values fluctuate, meaning the event can misfire. Removing them avoids this problem.
+ * @category Group
+ * @alias onGroupTransaction
+ * @param {number} groupId - The id of the group.
+ * @param {("Sale" | "Purchase" | "AffiliateSale" | "DevEx" | "GroupPayout" | "AdImpressionPayout")} transactionType - The transaction type.
+ * @returns An EventEmitter that emits when a transaction is made.
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * const transactionEvent = noblox.onGroupTransaction(1)
+ * transactionEvent.on("data", function(data) {
+ *  console.log("New Transaction!", data)
+ * })
+ * transactionEvent.on("error", function(err) {
+ *  console.error("Something went wrong: ", err)
+ *  // Handle error as needed
+ * })
+ **/
+
+// Define
+exports.func = function (args) {
+  let empty = true
+  return shortPoll({
+    getLatest: function (latest) {
+      return getGroupTransactions({ group: args.groupId, jar: args.jar, transactionType: args.transactionType })
+        .then(function (transactions) {
+          const given = []
+          // This method works much in the same way as onAuditLog. We remove some of the precision from transaction dates
+          // Because Roblox has a habit of being imprecise and varying the milliseconds of a given transaction/log item
+          // across different requests - and this causes duplicate fires.
+          if (transactions) {
+            for (const key in transactions) {
+              if (Object.prototype.hasOwnProperty.call(transactions, key)) {
+                const date = transactions[key].created
+                date.setMilliseconds(0)
+
+                if (date > latest) {
+                  latest = date
+                  given.push(transactions[key])
+                }
+                empty = false
+              } else if (!empty) {
+                const date = new Date()
+                date.setMilliseconds(0)
+
+                given.push({ date: date })
+                latest = date
+                empty = true
+              }
+            }
+            return {
+              latest: latest,
+              data: given
+            }
+          }
+        })
+    },
+    delay: 'onGroupTransaction'
+  })
+}