noblox.ts 4.10.5

package/examples/cleanWall.js

@@ -0,0 +1,110 @@
+/**
+ * About:
+ * Deletes group wall posts with optional filtering.
+ *
+ * NOTE: By default, this will delete all wall posts. Change the body of shouldDelete to alter this behaviour.
+ */
+
+// Settings
+const cookie = process.env.COOKIE || '' // Roblox account .ROBLOSECURITY cookie
+const options = {
+  group: 0, // Group ID
+  sortOrder: 'Asc' // Sort order: "Asc" or "Desc"
+}
+
+function shouldDelete (wallPost) {
+  /*
+  if (wallPost.poster === null) {
+    return true // Deleted posts from deleted users
+  } else if (wallPost.poster.username === "Bob") {
+    return true // Delete posts from Bob
+  } else if (wallPost.body.toLowerCase().includes("noob")) {
+    return true // Delete post containing "noob", case insensitive
+  }
+
+  return false
+  */
+
+  return true // Delete all posts
+}
+
+// Dependencies
+const noblox = require('noblox.js')
+const logUpdate = require('log-update')
+
+// Main
+let scanning = true
+const posts = {
+  scanned: 0,
+  filtered: 0,
+  deleted: 0,
+  failed: 0
+}
+
+async function getWallPage (getWallOptions, cursor) {
+  getWallOptions.limit = 100
+  getWallOptions.cursor = cursor || ''
+
+  const wallPage = await noblox.getWall(getWallOptions)
+
+  return wallPage
+}
+
+function filterWallPosts (wallPosts) {
+  const filteredPostIDs = []
+
+  for (const wallPost of wallPosts) {
+    if (shouldDelete(wallPost)) {
+      posts.filtered++
+      filteredPostIDs.push(wallPost.id)
+    }
+  }
+
+  return filteredPostIDs
+}
+
+function deleteWallPosts (wallPostIDs) {
+  wallPostIDs.forEach((wallPostID) => {
+    const deleteWallPostOptions = {
+      group: options.group,
+      id: wallPostID
+    }
+
+    noblox.deleteWallPost(deleteWallPostOptions)
+      .then(() => {
+        posts.deleted++
+      })
+      .catch((e) => {
+        posts.failed++
+      })
+  })
+}
+
+noblox.setCookie(cookie)
+  .then(async () => {
+    console.time('Time taken')
+
+    const logUpdater = setInterval(() => {
+      logUpdate(`Scanned: ${posts.scanned}\nFiltered: ${posts.filtered}\nDeleted: ${posts.deleted}\nFailed: ${posts.failed}`)
+
+      if (!scanning && posts.deleted + posts.failed === posts.filtered) {
+        clearInterval(logUpdater)
+
+        console.timeEnd('Time taken')
+      }
+    }, 100)
+
+    let wallPage = await getWallPage(options)
+    posts.scanned += wallPage.data.length
+
+    deleteWallPosts(filterWallPosts(wallPage.data))
+
+    while (wallPage.nextPageCursor !== null) {
+      wallPage = await getWallPage(options, wallPage.nextPageCursor)
+      posts.scanned += wallPage.data.length
+
+      deleteWallPosts(filterWallPosts(wallPage.data))
+    }
+
+    scanning = false
+  })

package/examples/revertRanks.js

@@ -0,0 +1,100 @@
+/**
+ * About:
+ * Reverts all rank change actions of a group after a specified date, with the option to filter by user.
+ */
+
+// Settings
+const cookie = process.env.COOKIE || '' // Roblox account .ROBLOSECURITY cookie
+const options = {
+  group: 0, // Group ID
+  userId: -1, // Revert rank changes made by this specified user - NOTE: When <= 0 any rank changes will be reverted
+  afterDate: new Date('2021-01-01 00:00 CDT') // Date after which any rank changes will be reverted
+}
+
+// Dependencies
+const noblox = require('noblox.js')
+const logUpdate = require('log-update')
+
+// Main
+let scanning = true
+const logItems = {
+  scanned: 0,
+  filtered: 0,
+  reverted: 0,
+  failed: 0
+}
+
+async function getAuditLogPage (getAuditLogOptions, cursor) {
+  getAuditLogOptions.cursor = cursor || ''
+
+  const auditLogPage = await noblox.getAuditLog(getAuditLogOptions)
+
+  return auditLogPage
+}
+
+function filterAuditLogItems (auditLogItems) {
+  const filteredAuditLogItems = []
+
+  for (const auditLogItem of auditLogItems) {
+    if (Date.parse(auditLogItem.created) > options.afterDate) {
+      logItems.filtered++
+      filteredAuditLogItems.push(auditLogItem.description)
+    }
+  }
+
+  return filteredAuditLogItems
+}
+
+async function revertAuditLogItems (auditLogItems) {
+  for (const auditLogItem of auditLogItems) {
+    const setRankOptions = {
+      group: options.group,
+      target: auditLogItem.TargetId,
+      rank: auditLogItem.OldRoleSetId
+    }
+
+    await noblox.setRank(setRankOptions)
+      .then(() => {
+        logItems.reverted++
+      })
+      .catch((e) => {
+        logItems.failed++
+      })
+  }
+}
+
+noblox.setCookie(cookie)
+  .then(async () => {
+    console.time('Time taken')
+
+    const logUpdater = setInterval(() => {
+      logUpdate(`Scanned: ${logItems.scanned}\nFiltered: ${logItems.filtered}\nReverted: ${logItems.reverted}\nFailed: ${logItems.failed}`)
+
+      if (!scanning && logItems.reverted + logItems.failed === logItems.filtered) {
+        clearInterval(logUpdater)
+
+        console.timeEnd('Time taken')
+      }
+    }, 100)
+
+    const getAuditLogOptions = {
+      group: options.group,
+      actionType: 'changeRank',
+      userId: options.userId > 0 ? options.userId : null,
+      limit: 100
+    }
+
+    let auditLogPage = await getAuditLogPage(getAuditLogOptions)
+    logItems.scanned += auditLogPage.data.length
+
+    await revertAuditLogItems(filterAuditLogItems(auditLogPage.data))
+
+    while (auditLogPage.nextPageCursor !== null && Date.parse(auditLogPage.data[auditLogPage.data.length - 1].created) > options.afterDate) {
+      auditLogPage = await getAuditLogPage(getAuditLogOptions, auditLogPage.nextPageCursor)
+      logItems.scanned += auditLogPage.data.length
+
+      await revertAuditLogItems(filterAuditLogItems(auditLogPage.data))
+    }
+
+    scanning = false
+  })

package/examples/savePlayers.js

@@ -0,0 +1,119 @@
+/**
+ * About:
+ * Saves group players to a JSON file with optional filtering.
+ *
+ * NOTE: By default, this will save all players found. Change the body of shouldSave to alter this behaviour.
+ */
+
+// Settings
+const cookie = process.env.COOKIE || '' // Roblox account .ROBLOSECURITY cookie
+const outputFile = 'players.json' // Output file name
+const options = {
+  group: 0, // Group ID
+  all: true, // Get all members of group - NOTE: Overrides roleset option
+  roleset: [1, 2, 3], // Array of roleset IDs - NOTE: This is not the same as role number
+  limit: -1, // Save limit - NOTE: When <= 0 there is no limit
+  sortOrder: 'Asc' // Sort order: "Asc" or "Desc"
+}
+
+function shouldSave (player) {
+  /*
+  if (player.username === "Bob") {
+    return true // Save Bob
+  } else if (player.username.toLowerCase().includes("bot")) {
+    return true // Save users with username containing "bot"
+  } else if (player.userId > 1000000000) {
+    return true // Save users with userId over 1 billion
+  }
+
+  return false
+  */
+
+  return true // Save all players found
+}
+
+// Dependencies
+const noblox = require('noblox.js')
+const js = require('JSONStream')
+const fs = require('fs')
+
+// Main
+const stream = js.stringify('[\n  ', ',\n  ', '\n]\n')
+const output = fs.createWriteStream(`./${outputFile}`)
+stream.pipe(output)
+
+noblox.setCookie(cookie)
+  .then(async () => {
+    console.time('Time taken')
+
+    const getRolesOptions = {
+      group: options.group
+    }
+
+    const groupRoles = await noblox.getRoles(getRolesOptions)
+    let targetRoles = []
+
+    if (options.all) {
+      targetRoles = groupRoles
+    } else {
+      for (const role of groupRoles) {
+        if (options.roleset.includes(role.id)) {
+          targetRoles.push(role)
+        }
+
+        if (targetRoles.length === options.roleset.length) {
+          break
+        }
+      }
+    }
+
+    if (targetRoles.length === 0) {
+      console.error('No roles matching the roleset IDs were found.')
+
+      return
+    }
+
+    options.roleset = targetRoles.map((role) => {
+      return role.id
+    })
+
+    let totalPlayers = 0
+
+    for (const role of targetRoles) {
+      totalPlayers += role.memberCount
+    }
+
+    if (options.limit > 0) {
+      totalPlayers = Math.min(options.limit, totalPlayers)
+    }
+
+    if (totalPlayers >= 10000) {
+      console.log(`Fetching ${totalPlayers} players, this will take a while...`)
+    } else if (totalPlayers >= 2000) {
+      console.log(`Fetching ${totalPlayers} players, this may take a while...`)
+    } else {
+      console.log(`Fetching ${totalPlayers} players...`)
+    }
+
+    const getPlayersOptions = {
+      group: options.group,
+      limit: 100,
+      sortOrder: options.sortOrder,
+      rolesetId: options.roleset
+    }
+
+    const groupPlayers = await noblox.getPlayers(getPlayersOptions)
+
+    console.log(`Writing ${totalPlayers} players to file...`)
+
+    for (const player of groupPlayers) {
+      if (shouldSave(player)) {
+        stream.write(player)
+      }
+    }
+
+    stream.end()
+
+    console.log(`Done, check ${outputFile} file.`)
+    console.timeEnd('Time taken')
+  })

package/examples/saveWall.js

@@ -0,0 +1,96 @@
+/**
+ * About:
+ * Saves wall posts to a JSON file with optional filtering.
+ *
+ * NOTE: By default, this will save all wall posts. Change the body of shouldSave to alter this behaviour.
+ */
+
+// Settings
+const cookie = process.env.COOKIE || '' // Roblox account .ROBLOSECURITY cookie
+const outputFile = 'wall.json' // Output file name
+const options = {
+  group: 0, // Group Id
+  sortOrder: 'Asc' // Sort order: "Asc" or "Desc"
+}
+
+function shouldSave (wallPost) {
+  /*
+  if (wallPost.poster === null) {
+    return true // Save posts from deleted users
+  } else if (wallPost.poster.username === "Bob") {
+    return true // Save posts from Bob
+  } else if (wallPost.body.toLowerCase().includes("noob")) {
+    return true // Save post containing "noob", case insensitive
+  }
+
+  return false
+  */
+
+  return true // Save all posts
+}
+
+// Dependencies
+const noblox = require('noblox.js')
+const logUpdate = require('log-update')
+const js = require('JSONStream')
+const fs = require('fs')
+
+// Main
+const stream = js.stringify('[\n  ', ',\n  ', '\n]\n')
+const output = fs.createWriteStream(`./${outputFile}`)
+stream.pipe(output)
+
+const wallPosts = {
+  found: 0,
+  written: 0,
+  skipped: 0
+}
+
+async function getWallPage (getWallOptions, cursor) {
+  getWallOptions.limit = 100
+  getWallOptions.cursor = cursor || ''
+
+  const wallPage = await noblox.getWall(getWallOptions)
+
+  return wallPage
+}
+
+function streamWallPageData (wallPageData) {
+  for (const wallPost of wallPageData) {
+    if (shouldSave(wallPost)) {
+      stream.write(wallPost)
+      wallPosts.written += 1
+    } else {
+      wallPosts.skipped += 1
+    }
+  }
+}
+
+noblox.setCookie(cookie)
+  .then(async () => {
+    console.time('Time taken')
+
+    const logUpdater = setInterval(() => {
+      logUpdate(`Found: ${wallPosts.found}\nWritten: ${wallPosts.written}\nSkipped: ${wallPosts.skipped}`)
+    }, 100)
+
+    let wallPage = await getWallPage(options)
+    wallPosts.found += wallPage.data.length
+
+    streamWallPageData(wallPage.data)
+
+    while (wallPage.nextPageCursor !== null) {
+      wallPage = await getWallPage(options, wallPage.nextPageCursor)
+      wallPosts.found += wallPage.data.length
+
+      streamWallPageData(wallPage.data)
+    }
+
+    stream.end()
+
+    clearInterval(logUpdater)
+    logUpdate(`Found: ${wallPosts.found}\nWritten: ${wallPosts.written}\nSkipped: ${wallPosts.skipped}`)
+
+    console.log(`Done, check ${outputFile} file.`)
+    console.timeEnd('Time taken')
+  })

package/jsDocsConfig.json

@@ -0,0 +1,55 @@
+{
+    "recurseDepth": 2,
+    
+    "source": {
+        "include": ["./typings", "./lib"], 
+        "includePattern": "\\.(jsx|js|ts|tsx)$"
+    },
+    
+    "opts" : {
+        "encoding": "utf8",
+        "destination": "./docs/",
+        "readme": "./README.md",
+        "recurse": true,
+        "verbose": true,
+        "tutorials": "./tutorials",
+        "template": "better-docs"
+    },
+
+    "plugins": [
+        "node_modules/better-docs/category",
+        "node_modules/better-docs/typescript",
+        "plugins/markdown"
+    ],
+
+    "tags": {
+        "allowUnknownTags": ["optional", "category"]
+    },
+
+    "templates": {
+        "better-docs": {
+            "logo": "./noblox-js-small.png",
+            "title": "noblox.js",
+            "hideGenerator": true,
+            "navLinks": [
+                {
+                    "label": "GitHub",
+                    "href": "https://github.com/noblox/noblox.js"
+                },
+                {
+                    "label": "noblox.js Discord",
+                    "href": "https://discord.gg/R5GVSyTVGv"
+                }
+            ],
+            "trackingCode": "<!-- Global site tag (gtag.js) - Google Analytics -->\n<script async src=\"https://www.googletagmanager.com/gtag/js?id=UA-121100860-3\"></script>\n<script>\n  window.dataLayer = window.dataLayer || [];\n  function gtag(){dataLayer.push(arguments);}\n  gtag('js', new Date());\n\n  gtag('config', 'UA-121100860-3');\n</script>\n"
+        },
+        "search": true,
+        "default": {
+            "staticFiles": {
+                "include": [
+                    "./img"
+                ]
+            }
+        }
+    }
+}

package/lib/accountinformation/getUserSocialLinks.js

@@ -0,0 +1,42 @@
+// Includes
+const http = require('../util/http.js').func
+
+// Args
+exports.required = ['userId']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Get the social link data (promotion channels) associated with a user.
+ * @category AccountInformation
+ * @alias getUserSocialLinks
+ * @param {number} userId - The id of the user.
+ * @returns {Promise<PromotionChannelsResponse>}
+ * @example const noblox = require("noblox.js")
+ * const userSocialLinks = await noblox.getUserSocialLinks(2416399685)
+**/
+
+// Define
+function getUserSocialLinks (userId, jar) {
+  return http({
+    url: `//accountinformation.roblox.com/v1/users/${userId}/promotion-channels`,
+    options: {
+      jar: jar,
+      resolveWithFullResponse: true
+    }
+  })
+    .then(({ statusCode, body }) => {
+      const { errors } = JSON.parse(body)
+      if (statusCode === 200) {
+        return JSON.parse(body)
+      } else if (statusCode === 400) {
+        throw new Error(`${errors[0].message} | userId: ${userId}`)
+      } else {
+        throw new Error(`An unknown error occurred with getUserSocialLinks() | [${statusCode}] userId: ${userId}`)
+      }
+    })
+}
+
+exports.func = function ({ userId, jar }) {
+  return getUserSocialLinks(userId, jar)
+}

package/lib/accountsettings/block.js

@@ -0,0 +1,58 @@
+// Includes
+const http = require('../util/http.js').func
+const getGeneralToken = require('../util/getGeneralToken.js').func
+
+// Args
+exports.required = ['userId']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Block a user.
+ * @category AccountSettings
+ * @alias block
+ * @param {number} userId - The id of the user that is being blocked.
+ * @returns {Promise<void>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * noblox.block(123456)
+**/
+
+// Define
+function block (jar, token, userId) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: `//accountsettings.roblox.com/v1/users/${userId}/block`,
+      options: {
+        method: 'POST',
+        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(', ')}`))
+          }
+        }
+      })
+  })
+}
+
+exports.func = function (args) {
+  const jar = args.jar
+  return getGeneralToken({ jar: jar })
+    .then(function (xcsrf) {
+      return block(jar, xcsrf, args.userId)
+    })
+}

package/lib/accountsettings/unblock.js

@@ -0,0 +1,58 @@
+// Includes
+const http = require('../util/http.js').func
+const getGeneralToken = require('../util/getGeneralToken.js').func
+
+// Args
+exports.required = ['userId']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Unblock a user.
+ * @category AccountSettings
+ * @alias unblock
+ * @param {number} userId - The id of the user.
+ * @returns {Promise<void>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * noblox.unblock(123456)
+**/
+
+// Define
+function unblock (jar, token, userId) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: `//accountsettings.roblox.com/v1/users/${userId}/unblock`,
+      options: {
+        method: 'POST',
+        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(', ')}`))
+          }
+        }
+      })
+  })
+}
+
+exports.func = function (args) {
+  const jar = args.jar
+  return getGeneralToken({ jar: jar })
+    .then(function (xcsrf) {
+      return unblock(jar, xcsrf, args.userId)
+    })
+}