noblox-asset.js 7.4.0

package/lib/friends/sendFriendRequest.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 = ['userId']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Send a friend request to a user.
+ * @category User
+ * @alias sendFriendRequest
+ * @param {number} userId - The id of the user.
+ * @returns {Promise<void>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * noblox.sendFriendRequest(123456)
+**/
+
+// Define
+function sendFriendRequest (jar, token, userId) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: `//friends.roblox.com/v1/users/${userId}/request-friendship`,
+      options: {
+        method: 'POST',
+        jar,
+        headers: {
+          'X-CSRF-TOKEN': token,
+          'Content-Type': 'application/json'
+        },
+        resolveWithFullResponse: true
+      }
+    }
+    return http(httpOpt)
+      .then(function (res) {
+        if (res.statusCode === 200) {
+          resolve()
+        } else {
+          reject(new RobloxAPIError(res))
+        }
+      })
+  })
+}
+
+exports.func = function (args) {
+  const jar = args.jar
+  return getGeneralToken({ jar })
+    .then(function (xcsrf) {
+      return sendFriendRequest(jar, xcsrf, args.userId)
+    })
+}

package/lib/friends/unfollow.js

@@ -0,0 +1,53 @@
+// Includes
+const http = require('../util/http.js').func
+const getGeneralToken = require('../util/getGeneralToken.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+// Args
+exports.required = ['userId']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Unfollow a user.
+ * @category User
+ * @alias unfollow
+ * @param {number} userId - The id of the user.
+ * @returns {Promise<void>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * noblox.unfollow(123456)
+**/
+
+// Define
+function unfollow (jar, token, userId) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: `//friends.roblox.com/v1/users/${userId}/unfollow`,
+      options: {
+        method: 'POST',
+        jar,
+        headers: {
+          'X-CSRF-TOKEN': token
+        },
+        resolveWithFullResponse: true
+      }
+    }
+    return http(httpOpt)
+      .then(function (res) {
+        if (res.statusCode === 200) {
+          resolve()
+        } else {
+          reject(new RobloxAPIError(res))
+        }
+      })
+  })
+}
+
+exports.func = function (args) {
+  const jar = args.jar
+  return getGeneralToken({ jar })
+    .then(function (xcsrf) {
+      return unfollow(jar, xcsrf, args.userId)
+    })
+}

package/lib/games/addDeveloperProduct.js

@@ -0,0 +1,53 @@
+const http = require('../util/http.js').func
+const getGeneralToken = require('../util/getGeneralToken.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+exports.required = ['universeId', 'name', 'priceInRobux']
+exports.optional = ['description', 'jar']
+
+// Docs
+/**
+ * 🔐 Create a developer product.
+ * @category Game
+ * @alias addDeveloperProduct
+ * @param {number} universeId - The id of the universe.
+ * @param {string} name - The name of the developer product.
+ * @param {number} priceInRobux - The price of the product.
+ * @param {string=} description - The description of the developer product.
+ * @returns {Promise<DeveloperProductAddResult>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * noblox.addDeveloperProduct(1, "A Developer Product", 100, "A cool item.")
+**/
+
+const nextFunction = (jar, token, universeId, name, priceInRobux, description) => {
+  description = description || ''
+  return http({
+    url: '//apis.roblox.com/developer-products/v1/universes/' + universeId + '/developerproducts?name=' + name + '&description=' + description + '&priceInRobux=' + priceInRobux,
+    options: {
+      method: 'POST',
+      jar,
+      headers: {
+        'X-CSRF-TOKEN': token
+      },
+      resolveWithFullResponse: true
+    }
+  }).then(function (res) {
+    if (res.statusCode !== 200) {
+      throw new RobloxAPIError(res)
+    }
+    try {
+      return JSON.parse(res.body)
+    } catch (_) {
+      throw new Error('Failed to parse response body (not valid JSON)')
+    }
+  })
+}
+
+exports.func = (args) => {
+  const jar = args.jar
+
+  return getGeneralToken({ jar }).then((xcsrf) => {
+    return nextFunction(jar, xcsrf, args.universeId, args.name, args.priceInRobux, args.description)
+  })
+}

package/lib/games/configureGamePass.js

@@ -0,0 +1,126 @@
+// Includes
+const http = require('../util/http').func
+const getGeneralToken = require('../util/getGeneralToken').func
+const RobloxAPIError = require('../util/apiError')
+
+// Args
+exports.required = ['gamePassId', 'name']
+exports.optional = ['description', 'price', 'icon', 'jar']
+
+// Docs
+/**
+ * 🔐 Modifies an existing game pass.
+ * @category Game
+ * @alias configureGamePass
+ * @param {number} gamePassId - The id of the game pass.
+ * @param {string} name - The name of the game pass; skips name, description, and icon if set to "".
+ * @param {string=} description - The description of the game pass; description is updated when name is modified.
+ * @param {number|boolean=} price - The price of the game pass in Robux; sets to 'Off Sale' if 0, false, or a negative value; skips if true.
+ * @param {ReadStream=} icon - The read stream for the game pass icon being uploaded; .png, .jpg, .gif
+ * @returns {Promise<GamePassResponse>}
+ * @example const noblox = require("noblox.js")
+ * const fs = require("fs")
+ * // Login using your cookie
+ * noblox.configureGamePass(12345678, "Game Pass Title", "Game Pass Description", 1234, fs.createReadStream("./Image.png"))
+ **/
+
+// Define
+function configureGamePass (gamePassId, name, description, price, icon, jar, token) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: `//apis.roblox.com/game-passes/v1/game-passes/${gamePassId}/details`,
+      options: {
+        method: 'POST',
+        jar,
+        headers: {
+          'X-CSRF-TOKEN': token
+        },
+        resolveWithFullResponse: true,
+        formData: {
+          Name: name,
+          Description: description,
+          File: icon
+        }
+      }
+    }
+
+    // Skip updating name and description if name is empty.
+    if (!name) {
+      resolve({
+        gamePassId,
+        ...price
+      })
+    }
+
+    return http(httpOpt).then(function (res) {
+      if (res.statusCode === 200) {
+        resolve({
+          gamePassId,
+          name,
+          description: description || '',
+          ...price,
+          iconChanged: !!icon // Boolean Cast
+        })
+      } else {
+        reject(new RobloxAPIError(res))
+      }
+    }).catch(error => reject(error))
+  })
+}
+
+// Configuring the name/description and Robux must be done in separate calls, albeit to the same end-point.
+function configureRobux (args, token) {
+  const httpOpt = {
+    url: `//apis.roblox.com/game-passes/v1/game-passes/${args.gamePassId}/details`,
+    options: {
+      method: 'POST',
+      jar: args.jar,
+      headers: {
+        'X-CSRF-TOKEN': token
+      },
+      resolveWithFullResponse: true,
+      formData: {
+        IsForSale: (!!Math.max(args.price, 0)).toString(), // Boolean Cast
+        Price: Math.floor(args.price || 0).toString() // Prevent Decimals
+      }
+    }
+  }
+  return http(httpOpt).then(function (res) {
+    if (res.statusCode === 200) {
+      // Passing price as an object, so they can be omitted if configureRobux is not run.
+      return configureGamePass(
+        args.gamePassId,
+        args.name,
+        args.description,
+        {
+          price: Math.max(Math.floor(args.price || 0), 0),
+          isForSale: !!Math.max(args.price, 0)
+        },
+        args.icon,
+        args.jar,
+        token
+      )
+    } else {
+      if (res.statusCode === 403) {
+        throw new Error('You do not have permission to edit this game pass.')
+      } else {
+        throw new Error(res.body.errors || 'An unknown error occurred with status code ' + res.statusCode)
+      }
+    }
+  })
+}
+
+exports.func = function (args) {
+  const jar = args.jar
+
+  return getGeneralToken({
+    jar
+  }).then(function (token) {
+    // Needs to catch falsy input of `false` and `0` as they should change the gamepass to offsale; price updating will be skipped if undefined.
+    if (typeof (args.price) === 'boolean' || typeof (args.price) === 'number') {
+      return configureRobux(args, token)
+    } else {
+      return configureGamePass(args.gamePassId, args.name, args.description, undefined, args.icon, jar, token)
+    }
+  })
+}

package/lib/games/getDeveloperProducts.js

@@ -0,0 +1,44 @@
+// Includes
+const http = require('../util/http.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+// Args
+exports.required = ['placeId']
+exports.optional = ['page', 'jar']
+
+// Docs
+/**
+ * 🔐 Returns the existing developer products in a specified game.
+ * @category Game
+ * @alias getDeveloperProducts
+ * @param {number} placeId - The ID of the place whose developer products you want to retrieve
+ * @param {number} [page=1] - Which page of developer products to return (pageSize is 50)
+ * @returns {Promise<DeveloperProductsResult>}
+ */
+
+function getDeveloperProducts (jar, placeId, page) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: `//api.roblox.com/developerproducts/list?placeid=${placeId}&page=${page}`,
+      options: {
+        method: 'GET',
+        jar,
+        resolveWithFullResponse: true
+      }
+    }
+    return http(httpOpt)
+      .then(function (res) {
+        if (res.statusCode === 200) {
+          resolve(JSON.parse(res.body))
+        } else {
+          reject(new RobloxAPIError(res))
+        }
+      })
+      .catch(error => reject(error))
+  })
+}
+
+// Define
+exports.func = function (args) {
+  return getDeveloperProducts(args.jar, args.placeId, args.page || 1)
+}

package/lib/games/getGameInstances.js

@@ -0,0 +1,31 @@
+// Includes
+const getPageResults = require('../util/getPageResults.js').func
+
+// Args
+exports.required = ['placeId']
+exports.optional = ['serverType', 'sortOrder', 'limit', 'jar']
+
+// Docs
+/**
+ * 🔓 Get the servers in a game.
+ * @category Game
+ * @alias getGameInstances
+ * @param {number} placeId - The id of the place.
+ * @param {("Public" | "Friend" | "VIP")=} [serverType=Public] - The type of server to get
+ * @param {SortOrder=} [sortOrder=Asc] - The order that the servers will be sorted by (Asc or Desc)
+ * @param {number=} [limit=∞] - The maximum number of results.
+ * @returns {Promise<GameInstance[]>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * const servers = await noblox.getGameInstances(1)
+**/
+
+// Define
+exports.func = function (args) {
+  return getPageResults({
+    jar: args.jar,
+    url: `//games.roblox.com/v1/games/${args.placeId}/servers/${args.serverType || 'Public'}`,
+    sortOrder: args.sortOrder,
+    limit: args.limit
+  })
+}

package/lib/games/getGamePasses.js

@@ -0,0 +1,39 @@
+// Includes
+const getPageResults = require('../util/getPageResults.js').func
+
+// Args
+exports.required = ['universeId']
+exports.optional = ['limit']
+
+// Docs
+/**
+ * ✅ Gets a game's game passes.
+ * @category Game
+ * @alias getGamePasses
+ * @param {number} universeId - The id of the universe.
+ * @param {Limit=} limit - The max number of game passes to return.
+ * @returns {Promise<GamePassData[]>}
+ * @example const noblox = require("noblox.js")
+ * const gamePasses = await noblox.getGamePasses(1686885941)
+**/
+
+// Define
+const getGamePasses = async (universeId, limit) => {
+  return getPageResults({
+    url: `//games.roblox.com/v1/games/${universeId}/game-passes`,
+    limit
+  }).catch(err => {
+    if (err.message === '404 The requested universe does not exist.') {
+      err.message += '\n\nYou are possibly providing a placeId instead of a universeId.\nUse getPlaceInfo() to retrieve the universeId: https://noblox.js.org/global.html#getPlaceInfo\n'
+      throw err
+    }
+    throw err
+  })
+}
+
+exports.func = function ({ universeId, limit }) {
+  if (isNaN(universeId)) {
+    throw new Error('The provided universe ID is not a number.')
+  }
+  return getGamePasses(universeId, limit)
+}

package/lib/games/getGameRevenue.js

@@ -0,0 +1,48 @@
+const http = require('../util/http.js').func
+const getGeneralToken = require('../util/getGeneralToken.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+exports.required = ['placeId', 'type', 'granularity']
+exports.optional = ['jar']
+
+/**
+ * 🔐 Get the Game Revenue data.
+ * @category Game
+ * @alias getGameRevenue
+ * @param {number} placeId - The id of the game.
+ * @param {"Revenue" | "RevenuePerVisit" | "AverageVisitLength" | "Visits"} type - The type of revenue. Options: Revenue, RevenuePerVisit, AverageVisitLength, Visits
+ * @param {"Hourly" | "Daily" | "Monthly"} granularity - The type of revenue. Options: Hourly, Daily, Monthly
+ * @returns {Promise<GameRevenueResponse>}
+ * @example const noblox = require("noblox.js")
+ * const gameRevenue = await noblox.getGameRevenue(936068308, "Revenue", "Hourly");
+**/
+
+function getGameRevenue (placeId, type, granularity, jar, token) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: `//develop.roblox.com/v1/places/${placeId}/stats/${type}?granularity=${granularity}`,
+      options: {
+        method: 'GET',
+        jar,
+        headers: {
+          'X-CSRF-TOKEN': token
+        },
+        resolveWithFullResponse: true
+      }
+    }
+    return http(httpOpt)
+      .then(function (res) {
+        if (res.statusCode === 200) resolve(JSON.parse(res.body))
+        else reject(new RobloxAPIError(res))
+      })
+      .catch(function (err) { console.error(err); reject(err) })
+  })
+}
+
+exports.func = function (args) {
+  const jar = args.jar
+  return getGeneralToken({ jar })
+    .then(function (xcsrf) {
+      return getGameRevenue(args.placeId, args.type, args.granularity, jar, xcsrf)
+    })
+}

package/lib/games/getGameSocialLinks.js

@@ -0,0 +1,42 @@
+// Includes
+const http = require('../util/http.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+// Args
+exports.required = ['universeId']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Get the social link data associated with a game.
+ * @category Game
+ * @alias getGameSocialLinks
+ * @param {number} universeId - The universe id of the game.
+ * @returns {Promise<SocialLinkResponse[]>}
+ * @see [getPlaceInfo()](global.html#getPlaceInfo) - can be used to convert a placeId to a universeId
+ * @example const noblox = require("noblox.js")
+ * const gameSocialLinks = await noblox.getGameSocialLinks(2615802125)
+**/
+
+// Define
+function getGameSocialLinks (universeId, jar) {
+  return http({
+    url: `//games.roblox.com/v1/games/${universeId}/social-links/list`,
+    options: {
+      jar,
+      resolveWithFullResponse: true
+    }
+  })
+    .then((res) => {
+      const { data } = JSON.parse(res.body)
+      if (res.statusCode === 200) {
+        return data
+      } else {
+        throw new RobloxAPIError(res)
+      }
+    })
+}
+
+exports.func = function ({ universeId, jar }) {
+  return getGameSocialLinks(universeId, jar)
+}

package/lib/games/getGroupGames.js

@@ -0,0 +1,30 @@
+// Includes
+const getPageResults = require('../util/getPageResults.js').func
+
+// Args
+exports.required = ['groupId']
+exports.optional = ['accessFilter', 'sortOrder', 'limit']
+
+// Docs
+/**
+ * ✅ Get a group's games.
+ * @category Group
+ * @alias getGroupGames
+ * @param {number} groupId - The id of the group.
+ * @param {("All" | "Public" | "Private")=} [accessFilter=All] - Filtering games via access level.
+ * @param {SortOrder=} [sortOrder=Asc] - The order results are sorted in.
+ * @param {Limit=} [limit=∞] - The maximum number of games to return
+ * @returns {Promise<GroupGameInfo[]>}
+ * @example const noblox = require("noblox.js")
+ * const groupGames = await noblox.getGroupGames({groupId: 1, accessFilter: 'All', sortOrder: 'Asc', limit: '100'})
+**/
+
+// Define
+exports.func = function (args) {
+  return getPageResults({
+    url: `//games.roblox.com/v2/groups/${args.groupId}/games`,
+    query: { accessFilter: args.accessFilter || 'All' },
+    sortOrder: args.sortOrder || 'Asc',
+    limit: args.limit
+  })
+}

package/lib/games/getPlaceInfo.js

@@ -0,0 +1,47 @@
+// Includes
+const http = require('../util/http.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+// Args
+exports.required = ['placeId']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔓 Get the info for a universe.
+ * @category Game
+ * @alias getPlaceInfo
+ * @param {number | Array<number>} universeId - The id(s) of the place(s).
+ * @returns {Promise<PlaceInformation[]>}
+ * @example const noblox = require("noblox.js")
+ * const universeInfo = await noblox.getPlaceInfo([ 10905034443 ])
+**/
+
+function getPlaceInfo (placeIds, jar) {
+  return new Promise((resolve, reject) => {
+    if (typeof (placeIds) === 'number') placeIds = [placeIds]
+
+    const httpOpt = {
+      url: `//games.roblox.com/v1/games/multiget-place-details?placeIds=${placeIds.join(',')}`,
+      options: {
+        json: true,
+        resolveWithFullResponse: true,
+        jar,
+        method: 'GET'
+      }
+    }
+
+    return http(httpOpt)
+      .then(function (res) {
+        if (res.statusCode === 200) {
+          resolve(res.body)
+        } else {
+          reject(new RobloxAPIError(res))
+        }
+      }).catch(reject)
+  })
+}
+
+exports.func = function (args) {
+  return getPlaceInfo(args.placeId, args.jar)
+}

package/lib/games/getUniverseInfo.js

@@ -0,0 +1,50 @@
+const http = require('../util/http.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+exports.required = ['universeId']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔓 Get the info for a universe.
+ * @category Game
+ * @alias getUniverseInfo
+ * @param {number | Array<number>} universeId - The id(s) of the universe(s).
+ * @returns {Promise<UniverseInformation[]>}
+ * @example const noblox = require("noblox.js")
+ * const universeInfo = await noblox.getUniverseInfo([ 2152417643 ])
+**/
+
+function getUniverseInfo (universeIds, jar) {
+  return new Promise((resolve, reject) => {
+    if (typeof (universeIds) === 'number') universeIds = [universeIds]
+
+    const httpOpt = {
+      url: `//games.roblox.com/v1/games?universeIds=${universeIds.join(',')}`,
+      options: {
+        json: true,
+        resolveWithFullResponse: true,
+        jar,
+        method: 'GET'
+      }
+    }
+
+    return http(httpOpt)
+      .then(function (res) {
+        if (res.statusCode === 200) {
+          resolve(res.body.data.map((universe) => {
+            universe.created = new Date(universe.created)
+            universe.updated = new Date(universe.updated)
+
+            return universe
+          }))
+        } else {
+          reject(new RobloxAPIError(res))
+        }
+      }).catch(reject)
+  })
+}
+
+exports.func = function (args) {
+  return getUniverseInfo(args.universeId, args.jar)
+}

package/lib/games/publishToTopic.js

@@ -0,0 +1,52 @@
+const http = require('../util/http.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+exports.required = ['universeId', 'topic', 'data']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * ☁️ Publish a message to a subscribed topic.
+ * @category Game
+ * @alias publishToTopic
+ * @param {number} universeId - The id of the universe.
+ * @param {string} topic - The name of the topic.
+ * @param {Object | string} data - The data to post.
+ * @returns {Promise<boolean>}
+ * @example const noblox = require("noblox.js")
+ * const data = { targetUser: 123456789, staffMember: 1210019099, action: "Kick" }
+ *
+ * await noblox.publishToTopic(2152417643, "ModerateUser", data)
+**/
+
+function publishToTopic (universeId, topic, data, jar) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: `//apis.roblox.com/messaging-service/v1/universes/${universeId}/topics/${topic}`,
+      options: {
+        json: true,
+        resolveWithFullResponse: true,
+        jar,
+        method: 'POST',
+        body: { message: JSON.stringify(data) },
+        headers: {
+          'Content-Type': 'application/json'
+        }
+      }
+    }
+
+    return http(httpOpt)
+      .then(function (res) {
+        if (res.statusCode === 200) {
+          resolve(true)
+        } else {
+          reject(new RobloxAPIError(res))
+        }
+      })
+      .catch(reject)
+  })
+}
+
+exports.func = function (args) {
+  return publishToTopic(args.universeId, args.topic, args.data, args.jar)
+}