noblox.ts 4.10.5

package/lib/groups/changeRank.js

@@ -0,0 +1,59 @@
+// Includes
+const setRank = require('./setRank.js').func
+const getRoles = require('./getRoles.js').func
+const getRankNameInGroup = require('./getRankNameInGroup.js').func
+
+// Args
+exports.required = ['group', 'target', 'change']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Change a user's rank.
+ * @category Group
+ * @alias changeRank
+ * @param {number} groupId - The id of the group.
+ * @param {number} target - The userId of the target.
+ * @param {number} change - The change in rank (1 = one rank higher, -1 = one rank lower)
+ * @returns {Promise<ChangeRankResult>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * noblox.changeRank(1, 2, -1)
+**/
+
+// Define
+exports.func = function (args) {
+  const group = args.group
+  const target = args.target
+  const amount = args.change
+  const jar = args.jar
+  return getRankNameInGroup({ group: group, userId: target })
+    .then(function (rank) {
+      if (rank === 'Guest') {
+        throw new Error('Target user is not in group')
+      }
+      return getRoles({ group: group })
+        .then(function (roles) {
+          for (let i = 0; i < roles.length; i++) {
+            const role = roles[i]
+            const thisRank = role.name
+
+            if (thisRank === rank) {
+              const change = i + amount
+              const found = roles[change]
+
+              if (!found) {
+                throw new Error('Rank change is out of range')
+              } else if (found.name === 'Guest' || found.rank === 0) {
+                throw new Error('Group members cannot be demoted to guest.')
+              }
+
+              return setRank({ group: group, target: target, rank: found.id, jar: jar })
+                .then(function () {
+                  return { newRole: found, oldRole: role }
+                })
+            }
+          }
+        })
+    })
+}

package/lib/groups/deleteWallPost.js

@@ -0,0 +1,64 @@
+// Includes
+const http = require('../util/http.js').func
+const getGeneralToken = require('../util/getGeneralToken.js').func
+
+// Args
+exports.required = ['group', ['postId', 'post']]
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Delete a wall post.
+ * @category Group
+ * @alias deleteWallPost
+ * @param {number} group - The id of the group.
+ * @param {number} postId - The id of the post to delete.
+ * @returns {Promise<void>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * noblox.deleteWallPost(1, 2)
+**/
+
+// Define
+function deleteWallPost (jar, token, group, postId) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: `//groups.roblox.com/v1/groups/${group}/wall/posts/${postId}`,
+      options: {
+        method: 'DELETE',
+        jar: jar,
+        headers: {
+          'X-CSRF-TOKEN': token
+        },
+        resolveWithFullResponse: true
+      }
+    }
+    return http(httpOpt)
+      .then(function (res) {
+        if (res.statusCode === 200) {
+          resolve()
+        } else {
+          const body = JSON.parse(res.body) || {}
+          if (body.errors && body.errors.length > 0) {
+            const errors = body.errors.map((e) => {
+              return e.message
+            })
+            reject(new Error(`${res.statusCode} ${errors.join(', ')}`))
+          }
+        }
+      }).catch(error => reject(error))
+  })
+}
+
+exports.func = function (args) {
+  const group = args.group
+  const jar = args.jar
+  return getGeneralToken({ jar: jar })
+    .then(function (xcsrf) {
+      if (args.post) {
+        return deleteWallPost(jar, xcsrf, group, args.post.id)
+      } else {
+        return deleteWallPost(jar, xcsrf, group, args.postId)
+      }
+    })
+}

package/lib/groups/deleteWallPostsByUser.js

@@ -0,0 +1,59 @@
+// Includes
+const http = require('../util/http.js').func
+const getGeneralToken = require('../util/getGeneralToken.js').func
+
+// Args
+exports.required = ['group', 'userId']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Removes all wall posts sent by the provided user.
+ * @category Group
+ * @alias deleteWallPostsByUser
+ * @param {number} group - The id of the group.
+ * @param {number} userId - The userId of the user having their posts removed.
+ * @returns {Promise<void>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * noblox.deleteWallPostsByUser(1, 2)
+ **/
+
+function deleteWallPostsByUser (group, userId, jar, xcsrf) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: `https://groups.roblox.com/v1/groups/${group}/wall/users/${userId}/posts`,
+      options: {
+        method: 'DELETE',
+        resolveWithFullResponse: true,
+        jar: jar,
+        headers: {
+          'X-CSRF-TOKEN': xcsrf
+        }
+      }
+    }
+
+    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))
+  })
+}
+
+// Define
+exports.func = function (args) {
+  const jar = args.jar
+  return getGeneralToken({ jar: jar })
+    .then(function (xcsrf) {
+      return deleteWallPostsByUser(args.group, args.userId, args.jar, xcsrf)
+    })
+}

package/lib/groups/demote.js

@@ -0,0 +1,25 @@
+// Includes
+const changeRank = require('./changeRank.js').func
+
+// Args
+exports.required = ['group', 'target']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Demote a user.
+ * @category Group
+ * @alias demote
+ * @param {number} group - The id of the group.
+ * @param {number} target - The userId of the user being demoted.
+ * @returns {Promise<ChangeRankResult>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * noblox.demote(1, 2)
+**/
+
+// Define
+exports.func = function (args) {
+  args.change = -1
+  return changeRank(args)
+}

package/lib/groups/exile.js

@@ -0,0 +1,59 @@
+// Includes
+const http = require('../util/http.js').func
+const getGeneralToken = require('../util/getGeneralToken.js').func
+
+// Args
+exports.required = ['group', 'target']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Exile a user from a group.
+ * @category Group
+ * @alias exile
+ * @param {number} group - The id of the group.
+ * @param {number} target - The userId of the user being exiled.
+ * @returns {Promise<void>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * noblox.exile(1, 2)
+**/
+
+function exileUser (group, target, jar, xcsrf) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: `https://groups.roblox.com/v1/groups/${group}/users/${target}`,
+      options: {
+        method: 'DELETE',
+        resolveWithFullResponse: true,
+        jar: jar,
+        headers: {
+          'X-CSRF-TOKEN': xcsrf
+        }
+      }
+    }
+
+    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))
+  })
+}
+
+// Define
+exports.func = function (args) {
+  const jar = args.jar
+  return getGeneralToken({ jar: jar })
+    .then(function (xcsrf) {
+      return exileUser(args.group, args.target, args.jar, xcsrf)
+    })
+}

package/lib/groups/getAuditLog.js

@@ -0,0 +1,67 @@
+// Includes
+const http = require('../util/http.js').func
+
+exports.required = ['group']
+exports.optional = ['actionType', 'userId', 'sortOrder', 'limit', 'cursor', 'jar']
+
+// Docs
+/**
+ * 🔐 Get the audit log for the group.
+ * @category Group
+ * @alias getAuditLog
+ * @param {number} group - The id of the group.
+ * @param {("DeletePost" | "RemoveMember" | "AcceptJoinRequest" | "DeclineJoinRequest" | "PostStatus" | "ChangeRank" | "BuyAd" | "SendAllyRequest" | "CreateEnemy" | "AcceptAllyRequest" | "DeclineAllyRequest" | "DeleteAlly" | "DeleteEnemy" | "AddGroupPlace" | "RemoveGroupPlace" | "CreateItems" | "ConfigureItems" | "SpendGroupFunds" | "ChangeOwner" | "Delete" | "AdjustCurrencyAmounts" | "Abandon" | "Claim" | "Rename" | "ChangeDescription" | "InviteToClan" | "KickFromClan" | "CancelClanInvite" | "BuyClan" | "CreateGroupAsset" | "UpdateGroupAsset" | "ConfigureGroupAsset" | "RevertGroupAsset" | "CreateGroupDeveloperProduct" | "ConfigureGroupGame" | "Lock" | "Unlock" | "CreateGamePass" | "CreateBadge" | "ConfigureBadge" | "SavePlace" | "PublishPlace")=} actionType - The action type to filter for.
+ * @param {number=} userId - The user's id to filter for.
+ * @param {SortOrder=} sortOrder - The order to sort the logs by.
+ * @param {Limit=} limit - The maximum logs per a page.
+ * @param {string=} cursor - The cursor for the page.
+ * @returns {Promise<AuditPage>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * const rankLogs = await noblox.getAuditLog(1, "ChangeRank", 2, "Asc")
+**/
+
+function getAuditLog (group, actionType, userId, sortOrder, limit, cursor, jar) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: `https://groups.roblox.com/v1/groups/${group}/audit-log?actionType=${actionType}&cursor=${cursor}&limit=${limit}&sortOrder=${sortOrder}&userId=${userId}`,
+      options: {
+        method: 'GET',
+        resolveWithFullResponse: true,
+        jar: jar
+      }
+    }
+
+    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 {
+          responseData.data = responseData.data.map((entry) => {
+            // We need to set milliseconds to 0 because Roblox does this fascinating thing
+            // Where they vary the ms value on each request, for an existing action.
+            entry.created = new Date(entry.created)
+            entry.created.setMilliseconds(0)
+            return entry
+          })
+          resolve(responseData)
+        }
+      }).catch(error => reject(error))
+  })
+}
+
+// Define
+exports.func = function (args) {
+  const jar = args.jar
+  const actionType = args.actionType || ''
+  const userId = args.userId || ''
+  const sortOrder = args.sortOrder || 'Asc'
+  const limit = args.limit || (100).toString()
+  const cursor = args.cursor || ''
+  return getAuditLog(args.group, actionType, userId, sortOrder, limit, cursor, jar)
+}

package/lib/groups/getGroup.js

@@ -0,0 +1,57 @@
+// Includes
+const http = require('../util/http.js').func
+
+// Args
+exports.required = ['groupId']
+exports.optional = []
+
+// Docs
+/**
+ * ✅ Get a group's info.
+ * @category Group
+ * @alias getGroup
+ * @param {number} groupId - The id of the group.
+ * @returns {Promise<Group>}
+ * @example const noblox = require("noblox.js")
+ * const groupInfo = await noblox.getGroup(1)
+**/
+
+// Define
+function getGroup (groupId) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: `//groups.roblox.com/v1/groups/${groupId}`,
+      options: {
+        method: 'GET',
+        resolveWithFullResponse: true
+      }
+    }
+    return http(httpOpt)
+      .then(function (res) {
+        if (res.statusCode === 200) {
+          const body = JSON.parse(res.body)
+
+          if (body.shout) {
+            body.shout.created = new Date(body.shout.created)
+            body.shout.updated = new Date(body.shout.updated)
+          }
+
+          resolve(body)
+        } else {
+          const body = JSON.parse(res.body) || {}
+          if (body.errors && body.errors.length > 0) {
+            const errors = body.errors.map((e) => {
+              return e.message
+            })
+            reject(new Error(`${res.statusCode} ${errors.join(', ')}`))
+          } else {
+            reject(new Error(`${res.statusCode} ${res.body}`))
+          }
+        }
+      }).catch(error => reject(error))
+  })
+}
+
+exports.func = function (args) {
+  return getGroup(args.groupId)
+}

package/lib/groups/getGroupSocialLinks.js

@@ -0,0 +1,44 @@
+// Includes
+const http = require('../util/http.js').func
+
+// Args
+exports.required = ['groupId']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Get the social link data associated with a group.
+ * @category Group
+ * @alias getGroupSocialLinks
+ * @param {number} groupId - The id of the group.
+ * @returns {Promise<SocialLinkResponse[]>}
+ * @example const noblox = require("noblox.js")
+ * const groupSocialLinks = await noblox.getGroupSocialLinks(9997719)
+**/
+
+// Define
+function getGroupSocialLinks (groupId, jar) {
+  return http({
+    url: `//groups.roblox.com/v1/groups/${groupId}/social-links`,
+    options: {
+      jar: jar,
+      resolveWithFullResponse: true
+    }
+  })
+    .then(({ statusCode, body }) => {
+      const { errors, data } = JSON.parse(body)
+      if (statusCode === 200 && data) {
+        return data
+      } else if (statusCode === 400 || statusCode === 403 || statusCode === 404) {
+        throw new Error(`${errors[0].message} | groupId: ${groupId}`)
+      } else if (statusCode === 401) {
+        throw new Error(`${errors[0].message} (Are you logged in?) | groupId: ${groupId}`)
+      } else {
+        throw new Error(`An unknown error occurred with getGroupSocialLinks() | [${statusCode}] groupId: ${groupId}`)
+      }
+    })
+}
+
+exports.func = function ({ groupId, jar }) {
+  return getGroupSocialLinks(groupId, jar)
+}

package/lib/groups/getGroups.js

@@ -0,0 +1,88 @@
+// Includes
+const http = require('../util/http.js').func
+
+// 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) {
+        const body = responses[0].body || {}
+        if (body.errors && body.errors.length > 0) {
+          const errors = body.errors.map((e) => {
+            return e.message
+          })
+          reject(new Error(`${responses[0].statusCode} ${errors.join(', ')}`))
+        }
+        reject(new Error('The provided user ID is not valid.'))
+      }
+
+      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: url,
+    options: {
+      resolveWithFullResponse: true,
+      followRedirect: false,
+      json: true
+    }
+  })
+}
+
+exports.func = function (args) {
+  return getGroups(args.userId)
+}

package/lib/groups/getJoinRequest.js

@@ -0,0 +1,52 @@
+// Includes
+const http = require('../util/http.js').func
+
+// 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: jar,
+        resolveWithFullResponse: true
+      }
+    }
+    return http(httpOpt)
+      .then(function (res) {
+        if (res.statusCode === 200) {
+          resolve(JSON.parse(res.body) || null)
+        } else {
+          const body = JSON.parse(res.body) || {}
+          if (body.errors && body.errors.length > 0) {
+            const errors = body.errors.map((e) => {
+              return e.message
+            })
+            reject(new Error(`${res.statusCode} ${errors.join(', ')}`))
+          }
+        }
+      }).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,58 @@
+// Includes
+const http = require('../util/http.js').func
+
+// 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: jar,
+        resolveWithFullResponse: true
+      }
+    }
+    return http(httpOpt)
+      .then(function (res) {
+        if (res.statusCode === 200) {
+          resolve(JSON.parse(res.body))
+        } else {
+          const body = JSON.parse(res.body) || {}
+          if (body.errors && body.errors.length > 0) {
+            const errors = body.errors.map((e) => {
+              return e.message
+            })
+            reject(new Error(`${res.statusCode} ${errors.join(', ')}`))
+          }
+        }
+      })
+      .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)
+}