noblox-asset.js 7.4.0

package/lib/economy/onGroupTransaction.js

@@ -0,0 +1,74 @@
+// Includes
+const shortPoll = require('../util/shortPoll.js').func
+const getGroupTransactions = require('./getGroupTransactions.js').func
+
+// Args
+exports.required = ['groupId', 'transactionType']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 An event for when a group transaction is made, for example a purchase. This event has a rate of one request per 60
+ * sec, which is more than the typical 10 seconds. This is due to the unusually low rate limit on the transactions
+ * endpoint.
+ *
+ * Note: The `created` field returned by this event will always have 0 milliseconds. This is due to a quirk on Roblox's side:
+ * These millisecond values fluctuate, meaning the event can misfire. Removing them avoids this problem.
+ * @category Group
+ * @alias onGroupTransaction
+ * @param {number} groupId - The id of the group.
+ * @param {("Sale" | "Purchase" | "AffiliateSale" | "DevEx" | "GroupPayout" | "AdImpressionPayout")} transactionType - The transaction type.
+ * @returns An EventEmitter that emits when a transaction is made.
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * const transactionEvent = noblox.onGroupTransaction(1)
+ * transactionEvent.on("data", function(data) {
+ *  console.log("New Transaction!", data)
+ * })
+ * transactionEvent.on("error", function(err) {
+ *  console.error("Something went wrong: ", err)
+ *  // Handle error as needed
+ * })
+ **/
+
+// Define
+exports.func = function (args) {
+  let empty = true
+  return shortPoll({
+    getLatest: function (latest) {
+      return getGroupTransactions({ group: args.groupId, jar: args.jar, transactionType: args.transactionType })
+        .then(function (transactions) {
+          const given = []
+          // This method works much in the same way as onAuditLog. We remove some of the precision from transaction dates
+          // Because Roblox has a habit of being imprecise and varying the milliseconds of a given transaction/log item
+          // across different requests - and this causes duplicate fires.
+          if (transactions) {
+            for (const key in transactions) {
+              if (Object.prototype.hasOwnProperty.call(transactions, key)) {
+                const date = transactions[key].created
+                date.setMilliseconds(0)
+
+                if (date > latest) {
+                  latest = date
+                  given.push(transactions[key])
+                }
+                empty = false
+              } else if (!empty) {
+                const date = new Date()
+                date.setMilliseconds(0)
+
+                given.push({ date })
+                latest = date
+                empty = true
+              }
+            }
+            return {
+              latest,
+              data: given
+            }
+          }
+        })
+    },
+    delay: 'onGroupTransaction'
+  })
+}

package/lib/friends/acceptFriendRequest.js

@@ -0,0 +1,54 @@
+// Includes
+const http = require('../util/http.js').func
+const getGeneralToken = require('../util/getGeneralToken.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+// Args
+exports.required = ['userId']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Accept a user's friend request.
+ * @category User
+ * @alias acceptFriendRequest
+ * @param {number} userId - The id of the user.
+ * @returns {Promise<void>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * noblox.acceptFriendRequest(123456)
+**/
+
+// Define
+function acceptFriendRequest (jar, token, userId) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: `//friends.roblox.com/v1/users/${userId}/accept-friend-request`,
+      options: {
+        method: 'POST',
+        jar,
+        headers: {
+          'X-CSRF-TOKEN': token,
+          'Content-Type': 'application/json'
+        },
+        resolveWithFullResponse: true
+      }
+    }
+    return http(httpOpt)
+      .then(function (res) {
+        if (res.statusCode === 200) {
+          resolve()
+        } else {
+          reject(new RobloxAPIError(res))
+        }
+      })
+  })
+}
+
+exports.func = function (args) {
+  const jar = args.jar
+  return getGeneralToken({ jar })
+    .then(function (xcsrf) {
+      return acceptFriendRequest(jar, xcsrf, args.userId)
+    })
+}

package/lib/friends/declineAllFriendRequests.js

@@ -0,0 +1,52 @@
+// Includes
+const http = require('../util/http.js').func
+const getGeneralToken = require('../util/getGeneralToken.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+// Args
+exports.required = []
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Decline all incoming friend requests.
+ * @category User
+ * @alias declineAllFriendRequests
+ * @returns {Promise<void>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * noblox.declineAllFriendRequests()
+**/
+
+// Define
+function declineAllFriendRequests (jar, token) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: '//friends.roblox.com/v1/user/friend-requests/decline-all',
+      options: {
+        method: 'POST',
+        jar,
+        headers: {
+          'X-CSRF-TOKEN': token
+        },
+        resolveWithFullResponse: true
+      }
+    }
+    return http(httpOpt)
+      .then(function (res) {
+        if (res.statusCode === 200) {
+          resolve()
+        } else {
+          reject(new RobloxAPIError(res))
+        }
+      })
+  })
+}
+
+exports.func = function (args) {
+  const jar = args.jar
+  return getGeneralToken({ jar })
+    .then(function (xcsrf) {
+      return declineAllFriendRequests(jar, xcsrf)
+    })
+}

package/lib/friends/declineFriendRequest.js

@@ -0,0 +1,54 @@
+// Includes
+const http = require('../util/http.js').func
+const getGeneralToken = require('../util/getGeneralToken.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+// Args
+exports.required = ['userId']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Decline a user's friend request.
+ * @category User
+ * @alias declineFriendRequest
+ * @param {number} userId - The id of the user that sent the friend request that is being declined.
+ * @returns {Promise<void>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * noblox.declineFriendRequest(123456)
+**/
+
+// Define
+function declineFriendRequest (jar, token, userId) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: `//friends.roblox.com/v1/users/${userId}/decline-friend-request`,
+      options: {
+        method: 'POST',
+        jar,
+        headers: {
+          'X-CSRF-TOKEN': token,
+          'Content-Type': 'application/json'
+        },
+        resolveWithFullResponse: true
+      }
+    }
+    return http(httpOpt)
+      .then(function (res) {
+        if (res.statusCode === 200) {
+          resolve()
+        } else {
+          reject(new RobloxAPIError(res))
+        }
+      })
+  })
+}
+
+exports.func = function (args) {
+  const jar = args.jar
+  return getGeneralToken({ jar })
+    .then(function (xcsrf) {
+      return declineFriendRequest(jar, xcsrf, args.userId)
+    })
+}

package/lib/friends/getFollowerCount.js

@@ -0,0 +1,35 @@
+// Includes
+const http = require('../util/http.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+// Args
+exports.required = ['userId']
+
+// Docs
+/**
+ * ✅ Gets the number of followers a user has.
+ * @category User
+ * @alias getFollowerCount
+ * @param { number } userId
+ * @returns Promise<number>
+ * @example const noblox = require("noblox.js")
+ * const numberOfFollowers = await noblox.getFollowerCount(55549140)
+**/
+
+// Define
+exports.func = function (args) {
+  const httpOpt = {
+    url: `//friends.roblox.com/v1/users/${args.userId}/followers/count`,
+    options: {
+      json: true,
+      method: 'GET',
+      resolveWithFullResponse: true
+    }
+  }
+
+  return http(httpOpt).then(function (res) {
+    if (res.statusCode === 200) { return res.body.count }
+
+    throw new RobloxAPIError(res)
+  })
+}

package/lib/friends/getFollowers.js

@@ -0,0 +1,56 @@
+// Includes
+const http = require('../util/http.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+// Args
+exports.required = ['userId']
+exports.optional = ['sortOrder', 'limit', 'cursor', 'jar']
+
+// Docs
+/**
+ * ✅ Get a user's followers.
+ * @category User
+ * @alias getFollowers
+ * @param {number} userId - The id of the user whose followers are being returned.
+ * @param {Limit=} [limit=10] - The amount of followers being fetched each request.
+ * @param {SortOrder=} [sortOrder=Asc] - The order that the data should be sorted by (Asc or Desc)
+ * @param {string=} cursor - The cursor for the previous or next page.
+ * @returns {Promise<FollowersPage>}
+ * @example const noblox = require("noblox.js")
+ * let followers = await noblox.getFollowers(123456, "Asc", 10)
+**/
+
+// Define
+function getFollowers (jar, userId, sortOrder, limit, cursor) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: `//friends.roblox.com/v1/users/${userId}/followers?limit=${limit}&sortOrder=${sortOrder}&cursor=${cursor}`,
+      options: {
+        method: 'GET',
+        jar,
+        resolveWithFullResponse: true
+      }
+    }
+    return http(httpOpt)
+      .then(function (res) {
+        if (res.statusCode === 200) {
+          const response = JSON.parse(res.body)
+          response.data = response.data.map((entry) => {
+            entry.created = new Date(entry.created)
+            return entry
+          })
+          resolve(response)
+        } else {
+          reject(new RobloxAPIError(res))
+        }
+      })
+  })
+}
+
+exports.func = function (args) {
+  const jar = args.jar
+  const sortOrder = args.sortOrder || 'Asc'
+  const limit = args.limit || (10).toString()
+  const cursor = args.cursor || ''
+  return getFollowers(jar, args.userId, sortOrder, limit, cursor)
+}

package/lib/friends/getFollowingCount.js

@@ -0,0 +1,35 @@
+// Includes
+const http = require('../util/http.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+// Args
+exports.required = ['userId']
+
+// Docs
+/**
+ * ✅ Gets the number of users a user is following.
+ * @category User
+ * @alias getFollowingCount
+ * @param { number } userId
+ * @returns Promise<number>
+ * @example const noblox = require("noblox.js")
+ * const numberOfFollowings = await noblox.getFollowingCount(55549140)
+**/
+
+// Define
+exports.func = function (args) {
+  const httpOpt = {
+    url: `//friends.roblox.com/v1/users/${args.userId}/followings/count`,
+    options: {
+      json: true,
+      method: 'GET',
+      resolveWithFullResponse: true
+    }
+  }
+
+  return http(httpOpt).then(function (res) {
+    if (res.statusCode === 200) { return res.body.count }
+
+    throw new RobloxAPIError(res)
+  })
+}

package/lib/friends/getFollowings.js

@@ -0,0 +1,56 @@
+// Includes
+const http = require('../util/http.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+// Args
+exports.required = ['userId']
+exports.optional = ['sortOrder', 'limit', 'cursor', 'jar']
+
+// Docs
+/**
+ * ✅ Get the users followed by the user.
+ * @category User
+ * @alias getFollowings
+ * @param {number} userId - The id of the user.
+ * @param {Limit=} [limit=10] - The amount of users fetched by each request (10, 25, 50, 100)
+ * @param {SortOrder=} [sortOrder=Asc] - The order that the returned data will be sorted by (Asc or Desc)
+ * @param {string=} cursor - The previous or next page's cursor.
+ * @returns {Promise<FollowingsPage>}
+ * @example const noblox = require("noblox.js")
+ * let following = await noblox.getFollowings(123456, "Asc", 50)
+**/
+
+// Define
+function getFollowings (jar, userId, sortOrder, limit, cursor) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: `//friends.roblox.com/v1/users/${userId}/followings?limit=${limit}&sortOrder=${sortOrder}&cursor=${cursor}`,
+      options: {
+        method: 'GET',
+        jar,
+        resolveWithFullResponse: true
+      }
+    }
+    return http(httpOpt)
+      .then(function (res) {
+        if (res.statusCode === 200) {
+          const response = JSON.parse(res.body)
+          response.data = response.data.map((entry) => {
+            entry.created = new Date(entry.created)
+            return entry
+          })
+          resolve(response)
+        } else {
+          reject(new RobloxAPIError(res))
+        }
+      })
+  })
+}
+
+exports.func = function (args) {
+  const jar = args.jar
+  const sortOrder = args.sortOrder || 'Asc'
+  const limit = args.limit || (10).toString()
+  const cursor = args.cursor || ''
+  return getFollowings(jar, args.userId, sortOrder, limit, cursor)
+}

package/lib/friends/getFriendCount.js

@@ -0,0 +1,35 @@
+// Includes
+const http = require('../util/http.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+// Args
+exports.required = ['userId']
+
+// Docs
+/**
+ * ✅ Gets the number of friends a user has.
+ * @category User
+ * @alias getFriendCount
+ * @param { number } userId
+ * @returns Promise<number>
+ * @example const noblox = require("noblox.js")
+ * const numberOfFriends = await noblox.getFriendCount(55549140)
+**/
+
+// Define
+exports.func = function (args) {
+  const httpOpt = {
+    url: `//friends.roblox.com/v1/users/${args.userId}/friends/count`,
+    options: {
+      json: true,
+      method: 'GET',
+      resolveWithFullResponse: true
+    }
+  }
+
+  return http(httpOpt).then(function (res) {
+    if (res.statusCode === 200) { return res.body.count }
+
+    throw new RobloxAPIError(res)
+  })
+}

package/lib/friends/getFriendRequests.js

@@ -0,0 +1,51 @@
+// Includes
+const http = require('../util/http.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+// Args
+exports.required = []
+exports.optional = ['sortOrder', 'limit', 'cursor', 'jar']
+
+// Docs
+/**
+ * 🔐 Get the friend requests of the authenticated user.
+ * @category User
+ * @alias getFriendRequests
+ * @param {SortOrder=} [sortOrder=Asc] - The order of the returned data (Asc or Desc)
+ * @param {Limit=} [limit=10] - The number of users returned by each request.
+ * @param {string=} cursor - The previous or next page's cursor.
+ * @returns {Promise<FriendRequestsPage>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * let friendRequests = await noblox.getFriendRequests({sortOrder: "Desc", limit: 100})
+**/
+
+// Define
+function getFriendsRequests (args) {
+  return new Promise((resolve, reject) => {
+    const jar = args.jar
+    const httpOpt = {
+      url: '//friends.roblox.com/v1/my/friends/requests',
+      options: {
+        method: 'GET',
+        jar,
+        resolveWithFullResponse: true
+      }
+    }
+    return http(httpOpt)
+      .then(function (res) {
+        if (res.statusCode === 200) {
+          const response = JSON.parse(res.body)
+          response.data = response.data.map((entry) => {
+            entry.created = new Date(entry.created)
+            return entry
+          })
+          resolve(response)
+        } else {
+          reject(new RobloxAPIError(res))
+        }
+      })
+  })
+}
+
+exports.func = getFriendsRequests

package/lib/friends/getFriends.js

@@ -0,0 +1,48 @@
+// Includes
+const http = require('../util/http.js').func
+const RobloxAPIError = require('../util/apiError.js')
+// Args
+exports.required = ['userId']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * ✅ Get the friends of a user
+ * @category User
+ * @alias getFriends
+ * @param {number} userId - The id of the user whose friends are being returned.
+ * @returns {Promise<Friends>}
+ * @example const noblox = require("noblox.js")
+ * let friends = await noblox.getFriends(123456)
+**/
+
+// Define
+function getFriends (jar, userId) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: `//friends.roblox.com/v1/users/${userId}/friends`,
+      options: {
+        method: 'GET',
+        jar,
+        resolveWithFullResponse: true
+      }
+    }
+    return http(httpOpt)
+      .then(function (res) {
+        if (res.statusCode === 200) {
+          const response = JSON.parse(res.body)
+          response.data = response.data.map((entry) => {
+            entry.created = new Date(entry.created)
+            return entry
+          })
+          resolve(response)
+        } else {
+          reject(new RobloxAPIError(res))
+        }
+      })
+  })
+}
+
+exports.func = function (args) {
+  return getFriends(args.jar, args.userId)
+}

package/lib/friends/onFriendRequest.js

@@ -0,0 +1,58 @@
+// Dependencies
+const events = require('events')
+
+// Includes
+const onNotification = require('../client/onNotification.js').func
+
+// Args
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 An event for when a user sends you a friend request.
+ * @category User
+ * @alias onFriendRequest
+ * @returns An EventEmitter that emits when a user sends you a friend request.
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ *
+ * const friendRequestEvent = noblox.onFriendRequest()
+ * friendRequestEvent.on("data", function(data) {
+ *  console.log("New friend request! ", data)
+ * })
+ * friendRequestEvent.on("error", function(err) {
+ *  console.error("Something went wrong: ", err)
+ *  // Handle error as needed
+ * })
+**/
+
+// Define
+exports.func = function (args) {
+  const jar = args.jar
+  const onFriendRequest = new events.EventEmitter()
+  const notifications = onNotification({ jar })
+  notifications.on('data', function (name, message) {
+    if (name === 'FriendshipNotifications' && message.Type === 'FriendshipRequested') {
+      onFriendRequest.emit('data', message.EventArgs.UserId1)
+    }
+  })
+  notifications.on('error', function (err) {
+    onFriendRequest.emit('error', err)
+  })
+  notifications.on('connect', function () {
+    onFriendRequest.emit('connect')
+  })
+  notifications.on('close', function (internal) {
+    if (internal) {
+      return
+    }
+    onFriendRequest.emit('close', true)
+  })
+  onFriendRequest.on('close', function (internal) {
+    if (internal) {
+      return
+    }
+    notifications.emit('close', true)
+  })
+  return onFriendRequest
+}

package/lib/friends/removeFriend.js

@@ -0,0 +1,53 @@
+// Includes
+const http = require('../util/http.js').func
+const getGeneralToken = require('../util/getGeneralToken.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+// Args
+exports.required = ['userId']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Remove a user from your friends list.
+ * @category User
+ * @alias removeFriend
+ * @param {number} userId - The id of the user.
+ * @returns {Promise<void>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * noblox.removeFriend(123456)
+**/
+
+// Define
+function removeFriend (jar, token, userId) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: `//friends.roblox.com/v1/users/${userId}/unfriend`,
+      options: {
+        method: 'POST',
+        jar,
+        headers: {
+          'X-CSRF-TOKEN': token
+        },
+        resolveWithFullResponse: true
+      }
+    }
+    return http(httpOpt)
+      .then(function (res) {
+        if (res.statusCode === 200) {
+          resolve()
+        } else {
+          reject(new RobloxAPIError(res))
+        }
+      })
+  })
+}
+
+exports.func = function (args) {
+  const jar = args.jar
+  return getGeneralToken({ jar })
+    .then(function (xcsrf) {
+      return removeFriend(jar, xcsrf, args.userId)
+    })
+}