noblox.ts 4.10.5

package/lib/avatar/outfits.js

@@ -0,0 +1,37 @@
+const http = require('../util/http.js').func
+
+exports.required = ['userId']
+exports.optional = ['page', 'itemsPerPage']
+
+// Docs
+/**
+ * ✅ Get a user's outfits.
+ * @category Avatar
+ * @alias outfits
+ * @param {number} userId - The userId of the user.
+ * @param {number=} page - The page to index.
+ * @param {number=} itemsPerPage - The number of results on each page.
+ * @returns {Promise<GetOutfitsResult>}
+ * @example const noblox = require("noblox.js")
+ * const outfits = await noblox.outfits(1)
+**/
+
+exports.func = (args) => {
+  const userId = args.userId
+  const page = parseInt(args.page) ? parseInt(args.page) : '*'
+  const itemsPerPage = parseInt(args.itemsPerPage) ? parseInt(args.itemsPerPage) : '*'
+
+  return http({
+    url: '//avatar.roblox.com/v1/users/' + userId + '/outfits?page=' + page + '&itemsPerPage=' + itemsPerPage,
+    options: {
+      method: 'GET',
+      resolveWithFullResponse: true
+    }
+  }).then((res) => {
+    if (res.statusCode === 200) {
+      return JSON.parse(res.body)
+    } else {
+      throw new Error('User does not exist')
+    }
+  })
+}

package/lib/avatar/redrawAvatar.js

@@ -0,0 +1,48 @@
+const http = require('../util/http.js').func
+const getGeneralToken = require('../util/getGeneralToken.js').func
+
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Redraw your avatar.
+ * @category Avatar
+ * @alias redrawAvatar
+ * @returns {Promise<void>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * noblox.redrawAvatar()
+**/
+
+function redrawAvatar (jar, token) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: '//avatar.roblox.com/v1/avatar/redraw-thumbnail',
+      options: {
+        method: 'POST',
+        jar: jar,
+        headers: {
+          'X-CSRF-TOKEN': token
+        },
+        resolveWithFullResponse: true
+      }
+    }
+    return http(httpOpt).then((res) => {
+      if (res.statusCode === 200) {
+        resolve()
+      } else if (res.statusCode === 429) {
+        reject(new Error('Redraw avatar floodchecked'))
+      } else {
+        reject(new Error('Redraw avatar failed'))
+      }
+    }).catch(error => reject(error))
+  })
+}
+
+exports.func = (args) => {
+  const jar = args.jar
+
+  return getGeneralToken({ jar: jar }).then((xcsrf) => {
+    return redrawAvatar(jar, xcsrf)
+  })
+}

package/lib/avatar/removeAssetId.js

@@ -0,0 +1,55 @@
+const http = require('../util/http.js').func
+const getGeneralToken = require('../util/getGeneralToken.js').func
+
+exports.required = ['assetId']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Removes an asset from your avatar.
+ * @category Avatar
+ * @alias removeAssetId
+ * @param {number} assetId - The assetId to remove.
+ * @returns {Promise<void>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * noblox.removeAssetId(1)
+**/
+
+function removeAssetId (assetId, jar, xcsrf) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: 'https://avatar.roblox.com/v1/avatar/assets/' + assetId + '/remove',
+      options: {
+        method: 'POST',
+        jar: jar,
+        headers: {
+          'X-CSRF-TOKEN': xcsrf
+        },
+        resolveWithFullResponse: true
+      }
+    }
+
+    return http(httpOpt)
+      .then(function (res) {
+        const responseData = JSON.parse(res.body)
+        if (res.statusCode !== 200) {
+          let error = 'An unknown error has occurred.'
+          if (responseData && responseData.errors) {
+            error = responseData.errors.map((e) => e.message).join('\n')
+          }
+          reject(new Error(error))
+        } else {
+          resolve()
+        }
+      }).catch(error => reject(error))
+  })
+}
+
+exports.func = (args) => {
+  const jar = args.jar
+
+  return getGeneralToken({ jar: jar }).then((xcsrf) => {
+    return removeAssetId(args.assetId, jar, xcsrf)
+  })
+}

package/lib/avatar/setAvatarBodyColors.js

@@ -0,0 +1,60 @@
+const http = require('../util/http.js').func
+const getGeneralToken = require('../util/getGeneralToken.js').func
+
+exports.required = ['headColorId', 'torsoColorId', 'rightArmColorId', 'leftArmColorId', 'rightLegColorId', 'leftLegColorId']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Set the colors of your avatar.
+ * @category Avatar
+ * @alias setAvatarBodyColors
+ * @param {number} headColorId - The [BrickColor Code]{@link https://developer.roblox.com/en-us/articles/BrickColor-Codes} of the head.
+ * @param {number} torsoColorId - The [BrickColor Code]{@link https://developer.roblox.com/en-us/articles/BrickColor-Codes} of the torso.
+ * @param {number} rightArmColorId - The [BrickColor Code]{@link https://developer.roblox.com/en-us/articles/BrickColor-Codes} of the right arm.
+ * @param {number} leftArmColorId - The [BrickColor Code]{@link https://developer.roblox.com/en-us/articles/BrickColor-Codes} of the left arm.
+ * @param {number} rightLegColorId - The [BrickColor Code]{@link https://developer.roblox.com/en-us/articles/BrickColor-Codes} of the right leg.
+ * @param {number} leftLegColorId - The [BrickColor Code]{@link https://developer.roblox.com/en-us/articles/BrickColor-Codes} of the left leg.
+ * @returns {Promise<void>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * noblox.setAvatarBodyColors(125, 125, 125, 125, 125, 125)
+**/
+
+const nextFunction = (jar, token, headColorId, torsoColorId, rightArmColorId, leftArmColorId, rightLegColorId, leftLegColorId) => {
+  return http({
+    url: '//avatar.roblox.com/v1/avatar/set-body-colors',
+    options: {
+      method: 'POST',
+      jar: jar,
+      headers: {
+        'X-CSRF-TOKEN': token
+      },
+      json: {
+        headColorId: headColorId,
+        torsoColorId: torsoColorId,
+        rightArmColorId: rightArmColorId,
+        leftArmColorId: leftArmColorId,
+        rightLegColorId: rightLegColorId,
+        leftLegColorId: leftLegColorId
+      },
+      resolveWithFullResponse: true
+    }
+  }).then((res) => {
+    if (res.statusCode === 200) {
+      if (!res.body.success) {
+        throw new Error(res.body)
+      }
+    } else {
+      throw new Error('Set body colors failed')
+    }
+  })
+}
+
+exports.func = (args) => {
+  const jar = args.jar
+
+  return getGeneralToken({ jar: jar }).then((xcsrf) => {
+    return nextFunction(jar, xcsrf, args.headColorId, args.torsoColorId, args.rightArmColorId, args.leftArmColorId, args.rightLegColorId, args.leftLegColorId)
+  })
+}

package/lib/avatar/setAvatarScales.js

@@ -0,0 +1,60 @@
+const http = require('../util/http.js').func
+const getGeneralToken = require('../util/getGeneralToken.js').func
+
+exports.required = ['height', 'width', 'head']
+exports.optional = ['depth', 'proportion', 'bodyType', 'jar']
+
+// Docs
+/**
+ * 🔐 Set the scale of your avatar.
+ * @category Avatar
+ * @alias setAvatarScales
+ * @param {number} height - The height scale of the avatar.
+ * @param {number} width - The width scale of the avatar.
+ * @param {number} head - The head scale of the avatar.
+ * @param {number=} depth - The depth scale of the avatar.
+ * @param {number=} proportion - The proportion scale of the avatar.
+ * @param {number=} bodyType - The body type scale of the avatar.
+ * @returns {Promise<void>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * noblox.setAvatarScales(1, 1, 1, 1, 1, 1)
+**/
+
+const nextFunction = (jar, token, height, width, head, depth, proportion, bodyType) => {
+  return http({
+    url: '//avatar.roblox.com/v1/avatar/set-scales',
+    options: {
+      method: 'POST',
+      jar: jar,
+      headers: {
+        'X-CSRF-TOKEN': token
+      },
+      json: {
+        height: height,
+        width: width,
+        head: head,
+        depth: depth,
+        proportion: proportion,
+        bodyType: bodyType
+      },
+      resolveWithFullResponse: true
+    }
+  }).then((res) => {
+    if (res.statusCode === 200) {
+      if (!res.body.success) {
+        throw new Error(res.body)
+      }
+    } else {
+      throw new Error('Set avatar scale failed')
+    }
+  })
+}
+
+exports.func = (args) => {
+  const jar = args.jar
+
+  return getGeneralToken({ jar: jar }).then((xcsrf) => {
+    return nextFunction(jar, xcsrf, args.height, args.width, args.head, args.depth, args.proportion, args.bodyType)
+  })
+}

package/lib/avatar/setPlayerAvatarType.js

@@ -0,0 +1,50 @@
+const http = require('../util/http.js').func
+const getGeneralToken = require('../util/getGeneralToken.js').func
+
+exports.required = ['avatarType']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Set the type of your avatar.
+ * @category Avatar
+ * @alias setPlayerAvatarType
+ * @param {PlayerAvatarType} avatarType - The type of your avatar. (R6 or R15)
+ * @returns {Promise<void>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * noblox.setPlayerAvatarType("R6")
+**/
+
+const nextFunction = (jar, token, avatarType) => {
+  return http({
+    url: '//avatar.roblox.com/v1/avatar/set-player-avatar-type',
+    options: {
+      method: 'POST',
+      jar: jar,
+      headers: {
+        'X-CSRF-TOKEN': token
+      },
+      json: {
+        playerAvatarType: avatarType
+      },
+      resolveWithFullResponse: true
+    }
+  }).then((res) => {
+    if (res.statusCode === 200) {
+      if (!res.body.success) {
+        throw new Error(res.body)
+      }
+    } else {
+      throw new Error('Set avatar type failed')
+    }
+  })
+}
+
+exports.func = (args) => {
+  const jar = args.jar
+
+  return getGeneralToken({ jar: jar }).then((xcsrf) => {
+    return nextFunction(jar, xcsrf, args.avatarType)
+  })
+}

package/lib/avatar/setWearingAssets.js

@@ -0,0 +1,50 @@
+const http = require('../util/http.js').func
+const getGeneralToken = require('../util/getGeneralToken.js').func
+
+exports.required = ['assetIds']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Set the assets your avatar is wearing.
+ * @category Avatar
+ * @alias setWearingAssets
+ * @param {Array<number>} assetIds - An array of asset IDs to wear.
+ * @returns {Promise<void>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * noblox.setWearingAssets([1, 2, 3])
+**/
+
+const nextFunction = (jar, token, assetIds) => {
+  return http({
+    url: '//avatar.roblox.com/v1/avatar/set-wearing-assets',
+    options: {
+      method: 'POST',
+      jar: jar,
+      headers: {
+        'X-CSRF-TOKEN': token
+      },
+      json: {
+        assetIds: assetIds
+      },
+      resolveWithFullResponse: true
+    }
+  }).then((res) => {
+    if (res.statusCode === 200) {
+      if (!res.body.success) {
+        throw new Error('Invalid assets: ' + res.body.invalidAssetIds.join(', '))
+      }
+    } else {
+      throw new Error('Wear assets failed')
+    }
+  })
+}
+
+exports.func = (args) => {
+  const jar = args.jar
+
+  return getGeneralToken({ jar: jar }).then((xcsrf) => {
+    return nextFunction(jar, xcsrf, args.assetIds)
+  })
+}

package/lib/avatar/wearAssetId.js

@@ -0,0 +1,55 @@
+const http = require('../util/http.js').func
+const getGeneralToken = require('../util/getGeneralToken.js').func
+
+exports.required = ['assetId']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Wear a specific asset.
+ * @category Avatar
+ * @alias wearAssetId
+ * @param {number} assetId - The assetId to wear.
+ * @returns {Promise<void>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * noblox.wearAssetId(1117747196)
+**/
+
+function wearAssetId (assetId, jar, xcsrf) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: 'https://avatar.roblox.com/v1/avatar/assets/' + assetId + '/wear',
+      options: {
+        method: 'POST',
+        jar: jar,
+        headers: {
+          'X-CSRF-TOKEN': xcsrf
+        },
+        resolveWithFullResponse: true
+      }
+    }
+
+    return http(httpOpt)
+      .then(function (res) {
+        const responseData = JSON.parse(res.body)
+        if (res.statusCode !== 200) {
+          let error = 'An unknown error has occurred.'
+          if (responseData && responseData.errors) {
+            error = responseData.errors.map((e) => e.message).join('\n')
+          }
+          reject(new Error(error))
+        } else {
+          resolve()
+        }
+      }).catch(error => reject(error))
+  })
+}
+
+exports.func = (args) => {
+  const jar = args.jar
+
+  return getGeneralToken({ jar: jar }).then((xcsrf) => {
+    return wearAssetId(args.assetId, jar, xcsrf)
+  })
+}

package/lib/badges/getAwardedTimestamps.js

@@ -0,0 +1,52 @@
+// Includes
+const http = require('../util/http').func
+
+// Args
+exports.required = ['userId', 'badgeId']
+
+// Docs
+/**
+ * ✅ Get the time the badge was awarded to a user.
+ * @category Badges
+ * @alias getAwardedTimestamps
+ * @param {number} userId - The userId of the user.
+ * @param {Array<number>} badgeId - The ids of the badges.
+ * @returns {Promise<UserBadgeStats>}
+ * @example const noblox = require("noblox.js")
+ * const badges = await noblox.getAwardedTimestamps(1, [1, 2, 3])
+**/
+
+// Define
+const getAwardedTimestamps = (userId, badgeId) => {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: `https://badges.roblox.com/v1/users/${userId}/badges/awarded-dates?badgeIds=${badgeId.join(',')}`,
+      options: {
+        method: 'GET',
+        resolveWithFullResponse: true
+      }
+    }
+
+    return http(httpOpt)
+      .then(function (res) {
+        const responseData = JSON.parse(res.body)
+        if (res.statusCode !== 200) {
+          let error = 'An unknown error has occurred.'
+          if (responseData && responseData.errors) {
+            error = responseData.errors.map((e) => e.message).join('\n')
+          }
+          reject(new Error(error))
+        } else {
+          resolve(responseData)
+        }
+      })
+  })
+}
+
+exports.func = async (args) => {
+  if (isNaN(args.userId)) {
+    throw new Error('The provided User ID is not a number.')
+  }
+
+  return getAwardedTimestamps(args.userId, args.badgeId)
+}

package/lib/badges/getBadgeInfo.js

@@ -0,0 +1,43 @@
+// Includes
+const http = require('../util/http').func
+
+// Args
+exports.required = ['badgeId']
+
+// Docs
+/**
+ * ✅ Get the info of a badge.
+ * @category Badges
+ * @alias getBadgeInfo
+ * @param {number} badgeId - The badge's id.
+ * @returns {Promise<BadgeInfo>}
+ * @example const noblox = require("noblox.js")
+ * const badgeInfo = await noblox.getBadgeInfo(1)
+**/
+
+// Define
+const badgeInfo = async (id) => {
+  return http({
+    url: `https://badges.roblox.com/v1/badges/${id}`,
+    options: {
+      resolveWithFullResponse: true,
+      method: 'GET'
+    }
+  }).then(res => {
+    if (res.statusCode === 200) {
+      const json = JSON.parse(res.body)
+      json.created = new Date(json.created)
+      json.updated = new Date(json.updated)
+      return json
+    } else {
+      throw new Error('Badge is invalid or does not exist.')
+    }
+  })
+}
+
+exports.func = async (args) => {
+  if (isNaN(args.badgeId)) {
+    throw new Error('The provided Badge ID is not a number.')
+  }
+  return badgeInfo(args.badgeId)
+}

package/lib/badges/getGameBadges.js

@@ -0,0 +1,62 @@
+// Includes
+const http = require('../util/http').func
+
+// Args
+exports.required = ['universeId']
+exports.optional = ['limit', 'cursor', 'sortOrder']
+
+// Docs
+/**
+ * ✅ Get the badges in a specific game.
+ * @category Game
+ * @alias getGameBadges
+ * @param {number} universeId - The id of the universe.
+ * @param {Limit=} limit - The max number of badges to return.
+ * @param {string=} cursor - The page cursor.
+ * @param {SortOrder=} sortOrder - The order to sort badges in. (Asc/Desc)
+ * @returns {Promise<BadgeInfo>}
+ * @example const noblox = require("noblox.js")
+ * const badges = await noblox.getGameBadges(1)
+**/
+
+// Define
+const gameBadges = async (id, limit, cursor, order) => {
+  return http({
+    url: `https://badges.roblox.com/v1/universes/${id}/badges?limit=${limit}&cursor=${cursor}&sortOrder=${order}`,
+    options: {
+      resolveWithFullResponse: true,
+      method: 'GET'
+    }
+  }).then(res => {
+    if (res.statusCode === 200) {
+      const json = JSON.parse(res.body)
+      json.data.map(badge => {
+        badge.created = new Date(badge.created)
+        badge.updated = new Date(badge.updated)
+        return badge
+      })
+      return json.data
+    } else {
+      throw new Error('The game is invalid or does not exist.')
+    }
+  })
+}
+exports.func = async (args) => {
+  if (isNaN(args.universeId)) {
+    throw new Error('The provided Universe ID is not a number.')
+  };
+  if (args.limit) {
+    if (![10, 25, 50, 100].includes(args.limit)) {
+      throw new Error('The allowed values are: 10, 25, 50 and 100.')
+    };
+  };
+  if (args.sortOrder) {
+    if (args.sortOrder.toLowerCase() !== 'asc' && args.sortOrder.toLowerCase() !== 'desc') {
+      throw new Error('Invalid sort order type.')
+    }
+  }
+  const limit = args.limit || 10
+  const sortOrder = args.sortOrder || 'Asc'
+  const cursor = args.cursor || ''
+  return gameBadges(args.universeId, limit, cursor, sortOrder)
+}

package/lib/badges/getPlayerBadges.js

@@ -0,0 +1,28 @@
+// Includes
+const getPageResults = require('../util/getPageResults.js').func
+
+// Args
+exports.required = ['userId']
+exports.optional = ['limit', 'sortOrder', 'jar']
+
+// Docs
+/**
+ * ✅ Get the badges that a user has.
+ * @category User
+ * @alias getPlayerBadges
+ * @param {number} userId - The id of the user whose badges are being fetched.
+ * @param {number} [limit=10] - The amount of badges being returned each request.
+ * @param {SortOrder=} [sortOrder=Asc] - The order that the data will be returned in (Asc or Desc)
+ * @returns {Promise<Array<PlayerBadges>>}
+ * @example const noblox = require("noblox.js")
+ * let badges = noblox.getPlayerBadges(123456, 10, "Asc")
+**/
+
+exports.func = async (args) => {
+  return getPageResults({
+    jar: args.jar,
+    url: `//badges.roblox.com/v1/users/${args.userId}/badges`,
+    sortOrder: args.sortOrder,
+    limit: args.limit
+  })
+}

package/lib/badges/updateBadgeInfo.js

@@ -0,0 +1,80 @@
+// Includes
+const http = require('../util/http').func
+const getGeneralToken = require('../util/getGeneralToken.js').func
+
+// Args
+exports.required = ['badgeId']
+exports.optional = ['name', 'description', 'enabled', 'jar']
+
+// Docs
+/**
+ * 🔐 Configure a badge.
+ * @category Badges
+ * @alias updateBadgeInfo
+ * @param {number} badgeId - The badge's id.
+ * @param {string=} name - The new name of the badge.
+ * @param {string=} description - The new description of the badge.
+ * @param {boolean=} enabled - If the badge is enabled.
+ * @returns {Promise<void>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * noblox.updateBadgeInfo(1, "Badge", "A cool badge.", true)
+**/
+
+// Define
+const updateInfo = (id, name, desc, enabled, xcrsf, jar) => {
+  return http({
+    url: `https://badges.roblox.com/v1/badges/${id}`,
+    options: {
+      resolveWithFullResponse: true,
+      method: 'PATCH',
+      jar: jar,
+      headers: {
+        'Content-Type': 'application/json',
+        'X-CSRF-TOKEN': xcrsf
+      },
+      body: JSON.stringify({
+        name: name,
+        description: desc,
+        enabled: enabled
+      })
+    }
+  }).then(res => {
+    if (res.statusCode === 200) {
+      return JSON.parse(res.body)
+    } else if (res.statusCode === 400) {
+      throw new Error('Text moderated.')
+    } else if (res.statusCode === 401) {
+      throw new Error('Authorization has been denied for this request.')
+    } else if (res.statusCode === 403) {
+      throw new Error('Token Validation failed or you do not have permission to manage this badge.')
+    } else if (res.statusCode === 404) {
+      throw new Error('Badge is invalid or does not exist.')
+    }
+  })
+}
+
+exports.func = async (args) => {
+  if (isNaN(args.badgeId)) {
+    throw new Error('The provided Badge ID is not a number.')
+  }
+  if (args.name) {
+    if (typeof args.name !== 'string') throw new Error('The name must be a string.')
+  } else if (args.description) {
+    if (typeof args.description !== 'string') throw new Error('The description must be a string.')
+  }
+
+  if (args.enabled) {
+    if (typeof args.enabled !== 'boolean') {
+      throw new Error('Enabled must be a boolean.')
+    }
+  }
+
+  const name = args.name || ''
+  const description = args.description || ''
+  const enabled = args.enabled || true
+  const jar = args.jar
+
+  const xcsrf = await getGeneralToken({ jar: jar })
+  return updateInfo(args.badgeId, name, description, enabled, xcsrf, jar)
+}