noblox-asset.js 7.4.0

package/lib/groups/getGroups.js

@@ -0,0 +1,82 @@
+// Includes
+const http = require('../util/http.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+// Args
+exports.required = ['userId']
+exports.optional = []
+
+// Docs
+/**
+ * ✅ Get the groups of a user.
+ * @category User
+ * @alias getGroups
+ * @param {number} userId - The id of the user.
+ * @returns {Promise<IGroupPartial[]>}
+ * @example const noblox = require("noblox.js")
+ * let groups = await noblox.getGroups(123456)
+**/
+
+// Define
+function getGroups (userId) {
+  return new Promise((resolve, reject) => {
+    const requests = [
+      constructRequest(`//groups.roblox.com/v2/users/${userId}/groups/roles`),
+      constructRequest(`//groups.roblox.com/v1/users/${userId}/groups/primary/role`)
+    ].map(promise => promise.then(
+      val => ({ status: 'fulfilled', value: val }),
+      rej => ({ status: 'rejected', reason: rej })
+    ))
+
+    const result = []
+
+    Promise.all(requests).then(async (promiseResponses) => {
+      let responses = promiseResponses.map(response => response.value)
+      const failedResponse = (responses[0].statusCode !== 200 || !responses[0].body) // we only check the first request because the second one errors if a primary is not set
+
+      if (failedResponse) {
+        reject(new RobloxAPIError(responses[0]))
+      }
+
+      responses = responses.map(r => r.body)
+
+      const groupRoleData = responses[0].data
+      if (groupRoleData) {
+        const primaryGroupId = responses[1] && responses[1].group && responses[1].group.id
+
+        const groupThumbails = await constructRequest(`https://thumbnails.roblox.com/v1/groups/icons?groupIds=${groupRoleData.map(data => data.group.id).join(',')}&size=150x150&format=Png&isCircular=false`)
+
+        groupRoleData.forEach(data => {
+          const insertion = {
+            Id: data.group.id,
+            Name: data.group.name,
+            MemberCount: data.group.memberCount,
+            IsPrimary: data.group.id === primaryGroupId,
+            Rank: data.role.rank,
+            Role: data.role.name,
+            RoleId: data.role.id,
+            EmblemUrl: groupThumbails.body.data.find(thumbnail => thumbnail.targetId === data.group.id).imageUrl
+          }
+          result.push(insertion)
+        })
+      }
+
+      resolve(result)
+    })
+  })
+}
+
+function constructRequest (url) {
+  return http({
+    url,
+    options: {
+      resolveWithFullResponse: true,
+      followRedirect: false,
+      json: true
+    }
+  })
+}
+
+exports.func = function (args) {
+  return getGroups(args.userId)
+}

package/lib/groups/getJoinRequest.js

@@ -0,0 +1,47 @@
+// Includes
+const http = require('../util/http.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+// Args
+exports.required = ['group', 'userId']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Gets a specific join request, given a user ID.
+ * @category Group
+ * @alias getJoinRequest
+ * @param {number} group - The id of the group.
+ * @param {number} userId - The user ID whose join request is wanted.
+ * @returns {(Promise<GroupJoinRequest>|Promise<null>)} A join request if one exists, or null.
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * const request = await noblox.getJoinRequest(4591072, 5903228)
+**/
+
+// Define
+function getJoinRequest (jar, group, userId) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: `//groups.roblox.com/v1/groups/${group}/join-requests/users/${userId}`,
+      options: {
+        method: 'GET',
+        jar,
+        resolveWithFullResponse: true
+      }
+    }
+    return http(httpOpt)
+      .then(function (res) {
+        if (res.statusCode === 200) {
+          resolve(JSON.parse(res.body) || null)
+        } else {
+          reject(new RobloxAPIError(res))
+        }
+      }).catch(error => reject(error))
+  })
+}
+
+exports.func = function (args) {
+  const jar = args.jar
+  return getJoinRequest(jar, args.group, args.userId)
+}

package/lib/groups/getJoinRequests.js

@@ -0,0 +1,53 @@
+// Includes
+const http = require('../util/http.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+// Args
+exports.required = ['group']
+exports.optional = ['sortOrder', 'limit', 'cursor', 'jar']
+
+// Docs
+/**
+ * 🔐 Get the join requests for a group.
+ * @category Group
+ * @alias getJoinRequests
+ * @param {number} group - The id of the group.
+ * @param {SortOrder=} sortOrder - The order to sort the requests by.
+ * @param {Limit=} limit - The maximum results per a page.
+ * @param {string=} cursor - The cursor for the next page.
+ * @returns {Promise<GroupJoinRequestsPage>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * const requests = await noblox.getJoinRequests(1, "Asc")
+**/
+
+// Define
+function getJoinRequests (jar, group, sortOrder, limit, cursor) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: `//groups.roblox.com/v1/groups/${group}/join-requests?limit=${limit}&sortOrder=${sortOrder}&cursor=${cursor}`,
+      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))
+  })
+}
+
+exports.func = function (args) {
+  const jar = args.jar
+  const sortOrder = args.sortOrder || 'Asc'
+  const limit = args.limit || (10).toString()
+  const cursor = args.cursor || ''
+  return getJoinRequests(jar, args.group, sortOrder, limit, cursor)
+}

package/lib/groups/getPlayers.js

@@ -0,0 +1,103 @@
+// Includes
+const http = require('../util/http.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+// Args
+exports.required = ['group', ['rolesetId']]
+exports.optional = ['sortOrder', 'limit', 'cursor', 'jar']
+
+// Docs
+/**
+ * ✅ Get the players in a group for a specific role.
+ * @category Group
+ * @alias getPlayers
+ * @param {number} group - The id of the group.
+ * @param {number | Array<number>} rolesetId - The roleset's id.
+ * @param {SortOrder=} sortOrder - The order to get the players in.
+ * @param {Limit=} limit - The maximum result per a page.
+ * @param {string=} cursor - The cursor for the next page.
+ * @returns {Promise<GroupUser[]>}
+ * @example const noblox = require("noblox.js")
+ * const players = await noblox.getPlayers(1, 1117747196)
+**/
+
+// Define
+function getPlayersInRoleOnPage (jar, group, rolesetId, sortOrder, limit, cursor) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: `//groups.roblox.com/v1/groups/${group}/roles/${rolesetId}/users?cursor=${cursor}&limit=${limit}&sortOrder=${sortOrder}`,
+      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))
+  })
+}
+
+function getPlayersInRole (jar, group, rolesetId, sortOrder, limit, cursor, currentPlayers) {
+  return new Promise((resolve, reject) => {
+    if (!currentPlayers) currentPlayers = []
+
+    getPlayersInRoleOnPage(jar, group, rolesetId, sortOrder, 100, cursor, currentPlayers)
+      .then(function (pageData) {
+        const nextPageCursor = pageData.nextPageCursor
+        const dataArray = pageData.data
+
+        if (!dataArray) return reject(new Error('Error while retrieving players!'))
+
+        currentPlayers = currentPlayers.concat(dataArray)
+
+        if (limit > 0 && currentPlayers.length >= limit) {
+          return resolve(currentPlayers.slice(0, limit))
+        } else if (nextPageCursor === null) {
+          return resolve(currentPlayers)
+        }
+
+        getPlayersInRole(jar, group, rolesetId, sortOrder, limit, nextPageCursor, currentPlayers)
+          .then(function (newCurrentPlayers) {
+            return resolve(newCurrentPlayers)
+          })
+      }).catch(error => reject(error))
+  })
+}
+
+async function getPlayersInRoles (jar, group, rolesetIds, sortOrder, limit, cursor) {
+  let currentPlayers = []
+
+  for (let i = 0; i < rolesetIds.length; i++) {
+    const rolesetId = rolesetIds[i]
+    const roleLimit = limit <= 0 ? limit : limit - currentPlayers.length
+
+    await getPlayersInRole(jar, group, rolesetId, sortOrder, roleLimit, cursor)
+      .then((newData) => {
+        currentPlayers = currentPlayers.concat(newData)
+      })
+      .catch((error) => {
+        throw new Error(error)
+      })
+
+    if (limit > 0 && currentPlayers.length >= limit) {
+      return currentPlayers
+    }
+  }
+
+  return currentPlayers
+}
+
+exports.func = function (args) {
+  const jar = args.jar
+  const rolesetIds = Array.isArray(args.rolesetId) ? args.rolesetId : [args.rolesetId]
+  const sortOrder = args.sortOrder || 'Desc'
+  const limit = args.limit || -1
+  const cursor = args.cursor || ''
+  return getPlayersInRoles(jar, args.group, rolesetIds, sortOrder, limit, cursor)
+}

package/lib/groups/getRankInGroup.js

@@ -0,0 +1,45 @@
+// Includes
+const http = require('../util/http.js').func
+const cache = require('../cache')
+const RobloxAPIError = require('../util/apiError.js')
+
+// Args
+exports.required = ['group', 'userId']
+
+// Docs
+/**
+ * ✅ Get the user's rank in the group.
+ * @category Group
+ * @alias getRankInGroup
+ * @param {number} group - The id of the group.
+ * @param {number} userId - The id of the user.
+ * @returns {Promise<number>}
+ * @example const noblox = require("noblox.js")
+ * const rankId = await noblox.getRankInGroup(1, 1)
+**/
+
+// Define
+function getRankInGroup (groupId, userId) {
+  if (typeof groupId === 'string') {
+    if (!isNaN(groupId)) {
+      // It's a number in a string
+      groupId = parseInt(groupId, 10)
+    } else {
+      throw new Error('Group id should be a number')
+    }
+  }
+  return http({ url: `//groups.roblox.com/v2/users/${userId}/groups/roles`, options: { json: true, resolveWithFullResponse: true } }).then((res) => {
+    if (res.statusCode !== 200) throw new RobloxAPIError(res)
+
+    const groupObject = res.body.data.find((info) => groupId === info.group.id)
+
+    return groupObject ? parseInt(groupObject.role.rank) : 0
+  })
+}
+
+exports.func = function (args) {
+  const id = args.userId
+  return cache.wrap('Rank', id, function () {
+    return getRankInGroup(args.group, id)
+  })
+}

package/lib/groups/getRankNameInGroup.js

@@ -0,0 +1,44 @@
+// Includes
+const http = require('../util/http.js').func
+const cache = require('../cache')
+const RobloxAPIError = require('../util/apiError.js')
+
+// Args
+exports.required = ['group', 'userId']
+
+// Docs
+/**
+ * ✅ Get a user's rank name in a group.
+ * @category Group
+ * @alias getRankNameInGroup
+ * @param {number} group - The id of the group.
+ * @param {number} userId - The id of the user.
+ * @returns {Promise<string>}
+ * @example const noblox = require("noblox.js")
+ * const rankName = await noblox.getRankNameInGroup(1, 1)
+**/
+
+// Define
+function getRankNameInGroup (group, userId) {
+  if (typeof group === 'string') {
+    if (!isNaN(group)) {
+      // It's a number in a string
+      group = parseInt(group, 10)
+    } else {
+      throw new Error('Group id should be a number')
+    }
+  }
+  return http({ url: `//groups.roblox.com/v2/users/${userId}/groups/roles`, options: { json: true, resolveWithFullResponse: true } }).then((res) => {
+    if (res.statusCode !== 200) throw new RobloxAPIError(res)
+    const groupObject = res.body.data.find((info) => group === info.group.id)
+
+    return groupObject ? groupObject.role.name : 'Guest'
+  })
+}
+
+exports.func = function (args) {
+  const id = args.userId
+  return cache.wrap('Rank', id + 'Name', function () {
+    return getRankNameInGroup(args.group, id)
+  })
+}

package/lib/groups/getRole.js

@@ -0,0 +1,64 @@
+// Dependencies
+const entities = require('entities')
+
+// Includes
+const getRoles = require('./getRoles.js').func
+
+// Args
+exports.required = ['group', 'roleQuery']
+exports.optional = []
+
+// Docs
+/**
+ * ✅ Get a role in a group.
+ * @category Group
+ * @alias getRole
+ * @param {number | Array<number>} group - The ID of the group or an array of roles to query.
+ * @param {number | string} roleQuery - The rank of a role, the name of the role, or roleset ID.
+ * @returns {Promise<Role>}
+ * @example const noblox = require("noblox.js")
+ * const customerRole = await noblox.getRole(1, "Customer")
+**/
+
+// Define
+function getRole (roles, roleQuery) {
+  return new Promise((resolve, reject) => {
+    const result = []
+
+    for (let i = 0; i < roles.length; i++) {
+      const role = roles[i]
+      let find
+      if (typeof roleQuery === 'number' && roleQuery <= 255) {
+        find = role.rank
+      } else if (typeof roleQuery === 'string') {
+        find = entities.decodeHTML(role.name)
+      } else if (typeof roleQuery === 'number' || roleQuery > 255) {
+        find = role.id
+      }
+
+      if (roleQuery === find) {
+        result.push(role)
+      }
+    }
+
+    if (result.length === 1) {
+      resolve(result[0])
+    } else if (result.length > 1) {
+      reject(new Error(`There are two or more roles with the rank ${roleQuery}. You must specify the role name.`))
+    } else {
+      reject(new Error('Role not found with provided query.'))
+    }
+  })
+}
+
+exports.func = function (args) {
+  if (typeof args.group === 'number' || typeof args.group === 'string') {
+    return getRoles({ group: parseInt(args.group, 10) }).then(function (roles) {
+      return getRole(roles, args.roleQuery)
+    })
+  } else if (typeof args.group === 'object') {
+    return getRole(args.group, args.roleQuery)
+  } else {
+    throw new Error('Please provide a valid group or an array of roles to query.')
+  }
+}

package/lib/groups/getRolePermissions.js

@@ -0,0 +1,48 @@
+// Includes
+const http = require('../util/http.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+exports.required = ['group', 'rolesetId']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Get the permissions for a role.
+ * @category Group
+ * @alias getRolePermissions
+ * @param {number} group - The id of the group.
+ * @param {number} rolesetId - The rolesetId of the role.
+ * @returns {Promise<RolePermissions>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * const rolePermissions = await noblox.getRolePermissions(1, 1117747196)
+**/
+
+function getRolePermissions (group, rolesetId, jar) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: `https://groups.roblox.com/v1/groups/${group}/roles/${rolesetId}/permissions`,
+      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))
+  })
+}
+
+// Define
+exports.func = function (args) {
+  const jar = args.jar
+  return getRolePermissions(args.group, args.rolesetId, jar)
+}

package/lib/groups/getRoles.js

@@ -0,0 +1,53 @@
+// Includes
+const http = require('../util/http.js').func
+const cache = require('../cache')
+const RobloxAPIError = require('../util/apiError.js')
+
+// Args
+exports.required = ['group']
+
+// Docs
+/**
+ * ✅ Get the roles in a group.
+ * @category Group
+ * @alias getRoles
+ * @param {number} group - The id of the group.
+ * @returns {Promise<Role[]>}
+ * @example const noblox = require("noblox.js")
+ * const roles = await noblox.getRoles(1)
+**/
+
+// Define
+function getRoles (group) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: `https://groups.roblox.com/v1/groups/${group}/roles`,
+      options: {
+        method: 'GET',
+        resolveWithFullResponse: true
+      }
+    }
+    return http(httpOpt)
+      .then(function (res) {
+        const responseData = JSON.parse(res.body)
+        if (res.statusCode !== 200) {
+          reject(new RobloxAPIError(res))
+        } else {
+          let roles = responseData.roles
+          roles = roles.sort((a, b) => a.rank - b.rank)
+          for (let i = 0; i < roles.length; i++) {
+            const role = roles[i]
+            role.ID = role.id
+          }
+          resolve(roles)
+        }
+      }).catch(error => reject(error))
+  })
+}
+
+exports.func = function (args) {
+  const group = args.group
+  return cache.wrap('Roles', group, function () {
+    return getRoles(group)
+  })
+}

package/lib/groups/getShout.js

@@ -0,0 +1,47 @@
+// Includes
+const http = require('../util/http.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+// Args
+exports.required = ['group']
+exports.optional = []
+
+// Docs
+/**
+ * 🔓 Get the group's shout.
+ * @category Group
+ * @alias getShout
+ * @param {number} group - The id of the group.
+ * @returns {Promise<GroupShout>}
+ * @example const noblox = require("noblox.js")
+ * const groupShout = await noblox.getShout(1)
+**/
+
+// Define
+function getShout (group, jar) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: `https://groups.roblox.com/v1/groups/${group}`,
+      options: {
+        method: 'GET',
+        resolveWithFullResponse: true,
+        jar
+      }
+    }
+
+    return http(httpOpt)
+      .then(function (res) {
+        const responseData = JSON.parse(res.body)
+        if (res.statusCode !== 400) {
+          reject(new RobloxAPIError(res))
+        } else {
+          resolve(responseData.shout)
+        }
+      })
+      .catch(error => reject(error))
+  })
+}
+
+exports.func = function (args) {
+  return getShout(args.group, args.jar)
+}

package/lib/groups/getWall.js

@@ -0,0 +1,56 @@
+const http = require('../util/http.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+exports.required = ['group']
+exports.optional = ['sortOrder', 'limit', 'cursor', 'jar']
+
+// Docs
+/**
+ * 🔓 Get the posts on the group wall.
+ * @category Group
+ * @alias getWall
+ * @param {number} group - The id of the group.
+ * @param {SortOrder=} sortOrder - The order to get the players in.
+ * @param {Limit=} limit - The maximum result per a page.
+ * @param {string=} cursor - The cursor for the next page.
+ * @returns {Promise<WallPostPage>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * const wallPosts = await noblox.getWall(1)
+**/
+
+function getPosts (group, sortOrder, limit, cursor, jar) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: `https://groups.roblox.com/v2/groups/${group}/wall/posts?limit=${limit}&sortOrder=${sortOrder}&cursor=${cursor}`,
+      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 {
+          responseData.data = responseData.data.map((entry) => {
+            entry.created = new Date(entry.created)
+            entry.updated = new Date(entry.updated)
+            return entry
+          })
+          resolve(responseData)
+        }
+      }).catch(error => reject(error))
+  })
+}
+
+// Define
+exports.func = function (args) {
+  const sortOrder = args.sortOrder || 'Asc'
+  const limit = args.limit || 100
+  const cursor = args.cursor || ''
+  return getPosts(args.group, sortOrder, limit, cursor, args.jar)
+}