noblox.ts 4.10.5

package/lib/groups/leaveGroup.js

@@ -0,0 +1,60 @@
+// Includes
+const http = require('../util/http.js').func
+const getCurrentUser = require('../util/getCurrentUser').func
+const getGeneralToken = require('../util/getGeneralToken.js').func
+
+// Args
+exports.required = ['group']
+exports.optional = []
+
+// Docs
+/**
+ * 🔐 Leave a group.
+ * @category Group
+ * @alias leaveGroup
+ * @param {number} group - The id of the group.
+ * @returns {Promise<void>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * noblox.leaveGroup(1)
+**/
+
+// Define
+function leaveGroup (group, jar, xcsrf, userId) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: `https://groups.roblox.com/v1/groups/${group}/users/${userId}`,
+      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))
+  })
+}
+
+exports.func = function (args) {
+  const jar = args.jar
+  return getGeneralToken({ jar: jar })
+    .then(async function (xcsrf) {
+      const currentUser = await getCurrentUser({ jar: jar })
+      return leaveGroup(args.group, args.jar, xcsrf, currentUser.UserID)
+    })
+}

package/lib/groups/onAuditLog.js

@@ -0,0 +1,62 @@
+// Includes
+const shortPoll = require('../util/shortPoll.js').func
+const getAuditLog = require('./getAuditLog.js').func
+
+// Args
+exports.required = ['group']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 An event for when an audit log event is added.
+ * @category Group
+ * @alias onAuditLog
+ * @param {number} group - The id of the group.
+ * @returns An EventEmitter that emits when an action is added to the audit log.
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * const auditEvent = noblox.onAuditLog(1)
+ * auditEvent.on("data", function(data) {
+ *  console.log("New action!", data)
+ * })
+ * auditEvent.on("error", function(err) {
+ *  console.error("Something went wrong: ", err)
+ *  // Handle error as needed
+ * })
+**/
+
+// Define
+exports.func = function (args) {
+  let empty = false
+  return shortPoll({
+    getLatest: function (latest) {
+      return getAuditLog({ group: args.group, jar: args.jar, sortOrder: 'Desc' })
+        .then(function (audit) {
+          const given = []
+          if (audit) {
+            for (const key in audit.data) {
+              if (Object.prototype.hasOwnProperty.call(audit.data, key)) {
+                const date = audit.data[key].created
+
+                if (date > latest) {
+                  latest = date
+                  given.push(audit.data[key])
+                }
+                empty = false
+              } else if (!empty) {
+                const date = new Date()
+                given.push({ audit: '', author: { name: '', id: '-1' }, date: date })
+                latest = date
+                empty = true
+              }
+            }
+            return {
+              latest: latest,
+              data: given
+            }
+          }
+        })
+    },
+    delay: 'onAuditLog'
+  })
+}

package/lib/groups/onJoinRequest.js

@@ -0,0 +1,63 @@
+// Includes
+const settings = require('../../settings.json')
+const shortPoll = require('../util/shortPoll.js').func
+const getJoinRequests = require('./getJoinRequests.js').func
+const promiseTimeout = require('../internal/timeout')
+
+// Args
+exports.required = ['group']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 An event for when someone makes a request to join the group.
+ * @category Group
+ * @alias onJoinRequest
+ * @param {number} group - The id of the group.
+ * @returns An EventEmitter that emits when someone tries to join.
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * const e = noblox.onJoinRequest()
+ * e.on("data", function(data) {
+ *  console.log("New request!", data)
+ * })
+ * e.on("error", function (err) {
+ *   ...
+ * })
+ **/
+
+async function getRequests (jar, group, cursor) {
+  const requests = []
+  const res = await promiseTimeout(getJoinRequests({ jar, group, cursor, limit: 100 }), settings.event.timeout, 'getRequests onJoinRequests internal')
+  requests.push.apply(requests, res.data)
+  if (res.nextPageCursor) {
+    requests.push.apply(requests, await getRequests(jar, group, res.nextPageCursor))
+  }
+  return requests
+}
+
+// Define
+exports.func = function (args) {
+  return shortPoll({
+    getLatest: function (latest) {
+      return getRequests(args.jar, args.group)
+        .then(function (requests) {
+          const given = []
+          for (const key in requests) {
+            if (Object.prototype.hasOwnProperty.call(requests, key)) {
+              const date = new Date(requests[key].created.slice(0, requests[key].created.lastIndexOf('.')))
+              if (date > latest) {
+                latest = date
+                given.push(requests[key])
+              }
+            }
+          }
+          return {
+            latest: latest,
+            data: given
+          }
+        })
+    },
+    delay: 'onJoinRequest'
+  })
+}

package/lib/groups/onJoinRequestHandle.js

@@ -0,0 +1,105 @@
+// Includes
+const settings = require('../../settings.json')
+const shortPoll = require('../util/shortPoll.js').func
+const getJoinRequests = require('./getJoinRequests.js').func
+const handleJoinRequest = require('./handleJoinRequest.js').func
+const promiseTimeout = require('../internal/timeout')
+
+// Args
+exports.required = ['group']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 An event for when someone is added to the join requests, which allows you to handle the join request as part of a
+ * screening process. Emits all join requests and waits until all of them have been resolved by firing the handle event
+ * with the request and either true or false. You can also pass a third argument callback to handle to execute once the
+ * join request has been handled.
+ * Once all requests on a page have been resolved, the next page is collected. Make sure that all join requests are handled in some way.
+ * Because this function has to wait for input, it does handle timeouts but does them within the function as opposed to within shortPoll.
+ *
+ * The use of this function is generally pretty complex. If it is not as working as you expect, you may actually be wanting
+ * to use `onJoinRequest`.
+ * @category Group
+ * @alias onJoinRequestHandle
+ * @param {number} group - The id of the group.
+ * @returns An EventEmitter that emits when someone tries to join.
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ *
+ * var blacklist = [1, 261]
+ * var evt = noblox.onJoinRequestHandle(18)
+ * evt.on('data', function (request) {
+ * noblox.getIdFromUsername(request.username).then(function (id) {
+ * for (var i = 0; i < blacklist.length; i++) {
+ *    if (blacklist[i] === id) {
+ *      evt.emit('handle', request, false);
+ *      return;
+ *    }
+ *  }
+ *  evt.emit('handle', request, true, function () {
+ *    console.log(`Welcome ${id} to the group`)
+ *  });
+ *});
+ *});
+**/
+
+async function getRequests (jar, group, cursor) {
+  const requests = []
+  const res = await promiseTimeout(getJoinRequests({ jar, group, cursor, limit: 100 }), settings.event.timeout)
+  requests.push.apply(requests, res.data)
+  if (res.nextPageCursor) {
+    requests.push.apply(requests, await getRequests(jar, group, res.nextPageCursor))
+  }
+  return requests
+}
+
+// Define
+exports.func = function (args) {
+  const group = args.group
+  const jar = args.jar
+  function getLatest (latest, evt) {
+    return getRequests(jar, group)
+      .then(function (requests) {
+        const complete = {
+          data: [],
+          latest: -2,
+          repeat: requests.length >= 20
+        }
+        let handled = 0
+        let promise
+        if (requests.length > 0) {
+          promise = new Promise(function (resolve, reject) {
+            evt.on('handle', function (request, accept, callback) {
+              const id = request.requester.userId
+              handleJoinRequest({ jar: jar, group, userId: id, accept: accept })
+                .then(function () {
+                  handled++
+                  if (callback) {
+                    callback()
+                  }
+                  if (handled === requests.length) {
+                    evt.removeAllListeners('handle')
+                    resolve(complete)
+                  }
+                })
+                .catch(reject)
+            })
+          })
+        }
+        for (let i = 0; i < requests.length; i++) {
+          const request = requests[i]
+          evt.emit('data', request)
+        }
+        if (requests.length > 0) {
+          return promise
+        }
+        return complete
+      })
+  }
+  return shortPoll({
+    getLatest: getLatest,
+    delay: 'onJoinRequestHandle',
+    timeout: -1
+  })
+}

package/lib/groups/onShout.js

@@ -0,0 +1,57 @@
+// Includes
+const shortPoll = require('../util/shortPoll.js').func
+const getShout = require('./getShout.js').func
+
+// Args
+exports.required = ['group']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 An event for when the shout is changed.
+ * @category Group
+ * @alias onShout
+ * @param {number} group - The id of the group.
+ * @returns An EventEmitter that emits when someone shouts.
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * const shoutEvent = noblox.onShout(1)
+ * shoutEvent.on("data", function(data) {
+ *  console.log("New Shout!", data)
+ * })
+ * shoutEvent.on("error", function(err) {
+ *  console.error("Something went wrong: ", err)
+ *  // Handle error as needed
+ * })
+**/
+
+// Define
+exports.func = function (args) {
+  let empty = false
+  return shortPoll({
+    getLatest: function (latest) {
+      return getShout({ group: args.group, jar: args.jar })
+        .then(function (shout) {
+          const given = []
+          if (shout) {
+            const date = new Date(shout.updated.slice(0, shout.updated.lastIndexOf('.')))
+            if (date > latest) {
+              latest = date
+              given.push(shout)
+            }
+            empty = false
+          } else if (!empty) {
+            const date = new Date()
+            given.push({ message: '', author: { name: '', id: '-1' }, date: date })
+            latest = date
+            empty = true
+          }
+          return {
+            latest: latest,
+            data: given
+          }
+        })
+    },
+    delay: 'onShout'
+  })
+}

package/lib/groups/onWallPost.js

@@ -0,0 +1,58 @@
+// Includes
+const shortPoll = require('../util/shortPoll.js').func
+const getWall = require('./getWall.js').func
+
+// Args
+exports.required = ['group']
+exports.optional = ['view', 'jar']
+
+// Docs
+/**
+ * 🔐 An event for when someone posts on the group wall.
+ * @category Group
+ * @alias onWallPost
+ * @param {number} group - The id of the group.
+ * @returns An EventEmitter that emits when someone posts on the group wall.
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * const wallpostEvent = noblox.onWallPost(1)
+ * wallpostEvent.on("data", function(data) {
+ *  console.log("New post!", data)
+ * })
+ * wallpostEvent.on("error", function(err) {
+ *  console.error("Something went wrong: ", err)
+ *  // Handle error as needed
+ * })
+**/
+
+// Define
+exports.func = function (args) {
+  const group = args.group
+  const jar = args.jar
+  const view = args.view
+  return shortPoll({
+    getLatest: function (latest) {
+      return getWall({ group: group, jar: jar, sortOrder: 'Desc' })
+        .then(function (wall) {
+          const posts = wall.data
+          const given = []
+          for (let i = posts.length - 1; i >= 0; i--) {
+            const post = posts[i]
+            const id = post.id
+            if (id > latest) {
+              latest = id
+              if (view) {
+                post.view = wall.views[post.parent.page]
+              }
+              given.push(post)
+            }
+          }
+          return {
+            latest: latest,
+            data: given
+          }
+        })
+    },
+    delay: 'onWallPost'
+  })
+}

package/lib/groups/promote.js

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

package/lib/groups/searchGroups.js

@@ -0,0 +1,32 @@
+// Includes
+const getPageResults = require('../util/getPageResults.js').func
+
+// Args
+exports.required = ['keyword']
+exports.optional = ['prioritizeExactMatch', 'limit']
+
+// Docs
+/**
+ * ✅ Searches for groups by a given search term.
+ * @category Group
+ * @alias searchGroups
+ * @param {string} keyword - The keyword or search term to search by.
+ * @param {boolean} [prioritizeExactMatch=false] - Whether or not to prioritize the exact match for the keyword
+ * @param {number} [limit=100] - The maximum number of groups to return. Supply 0 to apply no limit, returning all results.
+ * Note: This may significantly increase the time to execute and return potentially thousands of results.
+ * @returns {Promise<GroupSearchItem[]>}
+ * @example const noblox = require("noblox.js")
+ * const groupInfo = await noblox.searchGroups("noblox.js");
+ **/
+
+// Define
+exports.func = async function (args) {
+  const results = await getPageResults({
+    url: '//groups.roblox.com/v1/groups/search',
+    query: { keyword: args.keyword, prioritizeExactMatch: args.prioritizeExactMatch || false },
+    // If limit is 0, pass undefined for infinite results. Otherwise, default to 100.
+    limit: args.limit === 0 ? undefined : (args.limit || 100)
+  })
+  // Parse updated/created to Date objects.
+  return results.map((g) => ({ created: new Date(g.created), updated: new Date(g.updated), ...g }))
+}

package/lib/groups/setGroupDescription.js

@@ -0,0 +1,65 @@
+// Includes
+const http = require('../util/http.js').func
+const getGeneralToken = require('../util/getGeneralToken.js').func
+
+// Args
+exports.required = ['group']
+exports.optional = ['description', 'jar']
+
+// Docs
+/**
+ * 🔐 Update a group description
+ * @category Group
+ * @alias setGroupDescription
+ * @param {number} group - The id of the group.
+ * @param {string=} [description=""] - The new description for the group
+ * @returns {Promise<GroupDescriptionResult>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * noblox.setGroupDescription(1, "Group Description!")
+ **/
+
+function changeGroupDesc (group, description = '', jar, xcsrf) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: `https://groups.roblox.com/v1/groups/${group}/description`,
+      options: {
+        method: 'PATCH',
+        resolveWithFullResponse: true,
+        json: {
+          description
+        },
+        jar: jar,
+        headers: {
+          'X-CSRF-TOKEN': xcsrf
+        }
+      }
+    }
+
+    return http(httpOpt)
+      .then(function (res) {
+        if (res.statusCode === 200) {
+          resolve(res.body)
+        } else {
+          const body = 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}`))
+          }
+        }
+      })
+  })
+}
+
+// Define
+exports.func = function (args) {
+  const jar = args.jar
+  return getGeneralToken({ jar: jar })
+    .then(function (xcsrf) {
+      return changeGroupDesc(args.group, args.description, args.jar, xcsrf)
+    })
+}

package/lib/groups/setGroupName.js

@@ -0,0 +1,66 @@
+// Includes
+const http = require('../util/http.js').func
+const getGeneralToken = require('../util/getGeneralToken.js').func
+
+// Args
+exports.required = ['group', 'name']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Update a group name. This method will trigger a Robux charge to your account, and can only be performed by the group
+ * owner.
+ * @category Group
+ * @alias setGroupName
+ * @param {number} group - The id of the group.
+ * @param {string=} name - The new name for the group
+ * @returns {Promise<GroupNameResult>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * noblox.setGroupName(1, "Cool group")
+ **/
+
+function changeGroupName (group, name, jar, xcsrf) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: `https://groups.roblox.com/v1/groups/${group}/name`,
+      options: {
+        method: 'PATCH',
+        resolveWithFullResponse: true,
+        json: {
+          name
+        },
+        jar: jar,
+        headers: {
+          'X-CSRF-TOKEN': xcsrf
+        }
+      }
+    }
+
+    return http(httpOpt)
+      .then(function (res) {
+        if (res.statusCode === 200) {
+          resolve(res.body)
+        } else {
+          const body = 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}`))
+          }
+        }
+      })
+  })
+}
+
+// Define
+exports.func = function (args) {
+  const jar = args.jar
+  return getGeneralToken({ jar: jar })
+    .then(function (xcsrf) {
+      return changeGroupName(args.group, args.name, args.jar, xcsrf)
+    })
+}

package/lib/groups/setRank.js

@@ -0,0 +1,79 @@
+// Includes
+const http = require('../util/http.js').func
+const getGeneralToken = require('../util/getGeneralToken.js').func
+const getRole = require('./getRole.js').func
+
+// Args
+exports.required = ['group', 'target', 'rank']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Change a user's rank.
+ * @category Group
+ * @alias setRank
+ * @param {number} group - The id of the group.
+ * @param {number} target - The id of the user whose rank is being changed.
+ * @param {number | string | Role} rank - The rank, roleset ID, name of the role, or the actual Role itself.
+ * @returns {Promise<Role>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * noblox.setRank(1, 1, "Customer")
+**/
+
+// Define
+function setRank (jar, xcsrf, group, target, role) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: `//groups.roblox.com/v1/groups/${group}/users/${target}`,
+      options: {
+        resolveWithFullResponse: true,
+        method: 'PATCH',
+        jar: jar,
+        headers: {
+          'Content-Type': 'application/json',
+          'X-CSRF-TOKEN': xcsrf
+        },
+        body: JSON.stringify({
+          roleId: role.id
+        })
+      }
+    }
+    return http(httpOpt)
+      .then(function (res) {
+        if (res.statusCode === 200) {
+          resolve(role)
+        } 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))
+  })
+}
+
+function runWithToken (args) {
+  const jar = args.jar
+  return getGeneralToken({ jar: jar })
+    .then(function (xcsrf) {
+      return setRank(jar, xcsrf, args.group, args.target, args.role)
+    })
+}
+
+exports.func = function (args) {
+  if (typeof args.rank === 'object') { // assumes they gave Role
+    args.role = args.rank
+    return runWithToken(args)
+  } else if (typeof args.rank === 'number' || typeof args.rank === 'string') {
+    return getRole({ group: args.group, roleQuery: args.rank }).then((role) => {
+      args.role = role
+      return runWithToken(args)
+    })
+  } else {
+    throw new Error('Please provide either a Role, rank, or role name to change the user\'s rank to')
+  }
+}