noblox.ts 4.10.5

package/lib/party/onPartyJoinedGame.js

@@ -0,0 +1,53 @@
+const events = require('events')
+
+const onNotification = require('../client/onNotification.js').func
+
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 An event for when a party joins a game.
+ * @category Party
+ * @alias onPartyJoinedGame
+ * @returns An EventEmitter that emits when a party joins a game.
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * const partyJoinedGame = noblox.onPartyJoinedGame()
+ * partyJoinedGame.on("data", function(data) {
+ *  console.log("Party joined game! ", data)
+ * })
+ * partyJoinedGame.on("error", function(err) {
+ *  console.error("Something went wrong: ", err)
+ *  // Handle error as needed
+ * })
+**/
+
+exports.func = (args) => {
+  const jar = args.jar
+  const newEvent = new events.EventEmitter()
+  const notifications = onNotification({ jar: jar })
+
+  notifications.on('data', (name, message) => {
+    if (name === 'PartyNotifications' && message.Type === 'PartyJoinedGame') {
+      newEvent.emit('data', {
+        PartyId: message.PartyId,
+        PartyType: message.PartyType
+      })
+    }
+  })
+
+  notifications.on('error', (err) => {
+    newEvent.emit('error', err)
+  })
+
+  notifications.on('connect', () => {
+    newEvent.emit('connect')
+  })
+
+  notifications.on('close', (internal) => {
+    if (internal) return
+    notifications.emit('close', true)
+  })
+
+  return newEvent
+}

package/lib/party/onPartyLeftGame.js

@@ -0,0 +1,53 @@
+const events = require('events')
+
+const onNotification = require('../client/onNotification.js').func
+
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 An event for when a party leaves a game.
+ * @category Party
+ * @alias onPartyLeftGame
+ * @returns An EventEmitter that emits when a party leaves a game.
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * const partyLeftGame = noblox.onPartyLeftGame()
+ * partyLeftGame.on("data", function(data) {
+ *  console.log("Party left game! ", data)
+ * })
+ * partyLeftGame.on("error", function(err) {
+ *  console.error("Something went wrong: ", err)
+ *  // Handle error as needed
+ * })
+**/
+
+exports.func = (args) => {
+  const jar = args.jar
+  const newEvent = new events.EventEmitter()
+  const notifications = onNotification({ jar: jar })
+
+  notifications.on('data', (name, message) => {
+    if (name === 'PartyNotifications' && message.Type === 'PartyLeftGame') {
+      newEvent.emit('data', {
+        PartyId: message.PartyId,
+        PartyType: message.PartyType
+      })
+    }
+  })
+
+  notifications.on('error', (err) => {
+    newEvent.emit('error', err)
+  })
+
+  notifications.on('connect', () => {
+    newEvent.emit('connect')
+  })
+
+  notifications.on('close', (internal) => {
+    if (internal) return
+    notifications.emit('close', true)
+  })
+
+  return newEvent
+}

package/lib/party/onPartySelfJoined.js

@@ -0,0 +1,53 @@
+const events = require('events')
+
+const onNotification = require('../client/onNotification.js').func
+
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 An event for when you join a party.
+ * @category Party
+ * @alias onPartySelfJoined
+ * @returns An EventEmitter that emits when you join a party.
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * const joinedParty = noblox.onPartySelfJoined()
+ * joinedParty.on("data", function(data) {
+ *  console.log("You joined a party! ", data)
+ * })
+ * joinedParty.on("error", function(err) {
+ *  console.error("Something went wrong: ", err)
+ *  // Handle error as needed
+ * })
+**/
+
+exports.func = (args) => {
+  const jar = args.jar
+  const newEvent = new events.EventEmitter()
+  const notifications = onNotification({ jar: jar })
+
+  notifications.on('data', (name, message) => {
+    if (name === 'PartyNotifications' && message.Type === 'IJoinedParty') {
+      newEvent.emit('data', {
+        PartyId: message.PartyId,
+        PartyType: message.PartyType
+      })
+    }
+  })
+
+  notifications.on('error', (err) => {
+    newEvent.emit('error', err)
+  })
+
+  notifications.on('connect', () => {
+    newEvent.emit('connect')
+  })
+
+  notifications.on('close', (internal) => {
+    if (internal) return
+    notifications.emit('close', true)
+  })
+
+  return newEvent
+}

package/lib/party/onPartySelfLeft.js

@@ -0,0 +1,53 @@
+const events = require('events')
+
+const onNotification = require('../client/onNotification.js').func
+
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 An event for when you leave a party.
+ * @category Party
+ * @alias onPartySelfLeft
+ * @returns An EventEmitter that emits when you leave a party.
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * const leftParty = noblox.onPartySelfLeft()
+ * leftParty.on("data", function(data) {
+ *  console.log("You left a party! ", data)
+ * })
+ * leftParty.on("error", function(err) {
+ *  console.error("Something went wrong: ", err)
+ *  // Handle error as needed
+ * })
+**/
+
+exports.func = (args) => {
+  const jar = args.jar
+  const newEvent = new events.EventEmitter()
+  const notifications = onNotification({ jar: jar })
+
+  notifications.on('data', (name, message) => {
+    if (name === 'PartyNotifications' && message.Type === 'ILeftParty') {
+      newEvent.emit('data', {
+        PartyId: message.PartyId,
+        PartyType: message.PartyType
+      })
+    }
+  })
+
+  notifications.on('error', (err) => {
+    newEvent.emit('error', err)
+  })
+
+  notifications.on('connect', () => {
+    newEvent.emit('connect')
+  })
+
+  notifications.on('close', (internal) => {
+    if (internal) return
+    notifications.emit('close', true)
+  })
+
+  return newEvent
+}

package/lib/party/onPartyUserJoined.js

@@ -0,0 +1,53 @@
+const events = require('events')
+
+const onNotification = require('../client/onNotification.js').func
+
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 An event for when someone joins a party.
+ * @category Party
+ * @alias onPartyUserJoined
+ * @returns An EventEmitter that emits when someone joins a party.
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * const partyJoined = noblox.onPartyUserJoined()
+ * partyJoined.on("data", function(data) {
+ *  console.log("Someone joined a party! ", data)
+ * })
+ * partyJoined.on("error", function(err) {
+ *  console.error("Something went wrong: ", err)
+ *  // Handle error as needed
+ * })
+**/
+
+exports.func = (args) => {
+  const jar = args.jar
+  const newEvent = new events.EventEmitter()
+  const notifications = onNotification({ jar: jar })
+
+  notifications.on('data', (name, message) => {
+    if (name === 'PartyNotifications' && message.Type === 'PartyUserJoined') {
+      newEvent.emit('data', {
+        PartyId: message.PartyId,
+        PartyType: message.PartyType
+      })
+    }
+  })
+
+  notifications.on('error', (err) => {
+    newEvent.emit('error', err)
+  })
+
+  notifications.on('connect', () => {
+    newEvent.emit('connect')
+  })
+
+  notifications.on('close', (internal) => {
+    if (internal) return
+    notifications.emit('close', true)
+  })
+
+  return newEvent
+}

package/lib/party/onPartyUserLeft.js

@@ -0,0 +1,53 @@
+const events = require('events')
+
+const onNotification = require('../client/onNotification.js').func
+
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 An event for when someone leaves a party.
+ * @category Party
+ * @alias onPartyUserLeft
+ * @returns An EventEmitter that emits when someone leaves a party.
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * const partyLeft = noblox.onPartyUserLeft()
+ * partyLeft.on("data", function(data) {
+ *  console.log("Someone left party! ", data)
+ * })
+ * partyLeft.on("error", function(err) {
+ *  console.error("Something went wrong: ", err)
+ *  // Handle error as needed
+ * })
+**/
+
+exports.func = (args) => {
+  const jar = args.jar
+  const newEvent = new events.EventEmitter()
+  const notifications = onNotification({ jar: jar })
+
+  notifications.on('data', (name, message) => {
+    if (name === 'PartyNotifications' && message.Type === 'PartyUserLeft') {
+      newEvent.emit('data', {
+        PartyId: message.PartyId,
+        PartyType: message.PartyType
+      })
+    }
+  })
+
+  notifications.on('error', (err) => {
+    newEvent.emit('error', err)
+  })
+
+  notifications.on('connect', () => {
+    newEvent.emit('connect')
+  })
+
+  notifications.on('close', (internal) => {
+    if (internal) return
+    notifications.emit('close', true)
+  })
+
+  return newEvent
+}

package/lib/premiumfeatures/getPremium.js

@@ -0,0 +1,51 @@
+// Includes
+const http = require('../util/http.js').func
+
+// Args
+exports.required = ['userId']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Gets whether or not a user has premium.
+ * @category User
+ * @alias getPremium
+ * @param {number} userId - The id of the user.
+ * @returns {Promise<boolean>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * const hasPremium = await noblox.getPremium(123456)
+ **/
+
+// Define
+function getPremium (jar, userId) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: `https://premiumfeatures.roblox.com/v1/users/${userId}/validate-membership`,
+      options: {
+        method: 'GET',
+        jar: jar,
+        resolveWithFullResponse: true
+      }
+    }
+    return http(httpOpt)
+      .then(function (res) {
+        if (res.statusCode === 200) {
+          resolve(res.body === 'true')
+        } 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 getPremium(jar, args.userId)
+}

package/lib/presence/getPresences.js

@@ -0,0 +1,63 @@
+// Includes
+const http = require('../util/http.js').func
+const getGeneralToken = require('../util/getGeneralToken.js').func
+
+// Args
+exports.required = ['userIds']
+exports.optional = []
+
+// Docs
+/**
+ * 🔐 Get the presence status of users.
+ * @category Presence
+ * @alias getPresences
+ * @param {Array<number>} userIds - An array of userIds.
+ * @returns {Promise<Presences>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * const presences = await noblox.getPresences([1, 2, 3])
+**/
+
+// Define
+function getPresences (userIds, jar, xcsrf) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: '//presence.roblox.com/v1/presence/users',
+      options: {
+        method: 'POST',
+        resolveWithFullResponse: true,
+        jar: jar,
+        headers: {
+          'X-CSRF-TOKEN': xcsrf,
+          'Content-Type': 'application/json'
+        },
+        body: JSON.stringify({
+          userIds
+        })
+      }
+    }
+
+    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(responseData)
+        }
+      })
+      .catch(error => reject(error))
+  })
+}
+
+exports.func = function (args) {
+  const jar = args.jar
+  return getGeneralToken({ jar: jar })
+    .then(function (xcsrf) {
+      return getPresences(args.userIds, args.jar, xcsrf)
+    })
+}

package/lib/privatemessages/getMessages.js

@@ -0,0 +1,60 @@
+// Includes
+const http = require('../util/http.js').func
+// Args
+exports.required = []
+exports.optional = ['pageNumber', 'pageSize', 'messageTab', 'jar']
+
+// Docs
+/**
+ * 🔐 Get the messages of the authenticated user.
+ * @category User
+ * @alias getMessages
+ * @param {number=} [pageNumber=0] - The number of the current page.
+ * @param {number=} [pageSize=25] - The size of the current page.
+ * @param {("Inbox" | "Sent" | "Archive")=} [messageTab=Inbox] - The tab of the messages being fetched (Inbox, Sent, Archive)
+ * @returns {Promise<PrivateMessagesPage>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * let messages = await noblox.getMessages(1, 10, "Inbox"))
+**/
+
+// Define
+function getMessages (jar, token, pageNumber, pageSize, messageTab) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: `//privatemessages.roblox.com/v1/messages?pageNumber=${pageNumber}&pageSize=${pageSize}&messageTab=${messageTab}`,
+      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(', ')}`))
+          }
+        }
+      })
+  })
+}
+
+exports.func = function (args) {
+  const jar = args.jar
+  const pageNumber = (args.pageNumber && args.pageNumber.toString()) || '0'
+  const pageSize = (args.pageSize && args.pageSize.toString()) || '25'
+  const messageTab = args.messageTab || 'Inbox'
+  if (!['Inbox', 'Sent', 'Archive'].includes(messageTab)) {
+    return new Promise((resolve, reject) => {
+      reject(new Error('messageTab must be Inbox, Sent, or Archive'))
+    })
+  }
+  return getMessages(jar, pageNumber, pageSize, messageTab)
+}

package/lib/privatemessages/message.js

@@ -0,0 +1,80 @@
+// Includes
+const http = require('../util/http.js').func
+const queue = require('../internal/queue.js')
+const getGeneralToken = require('../util/getGeneralToken.js').func
+const getHash = require('../util/getHash.js').func
+const getSenderId = require('../util/getSenderUserId.js').func
+
+// Args
+exports.required = ['recipient', 'subject', 'body']
+exports.optional = ['replyMessageId', 'includePreviousMessage', 'jar']
+
+// Docs
+/**
+ * 🔐 Send a message. NOTE: Roblox blocks web servers and proxies from sending messages.
+ * @category User
+ * @alias message
+ * @param {number} recipient - The id of the user.
+ * @param {string} subject - The subject of the message.
+ * @param {string} body - The body of the message.
+ * @param {number=} replyMessageId - The messageId to reply to.
+ * @param {boolean=} [includePreviousMessage=false] - The previous or next page cursor.
+ * @returns {Promise<void>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * noblox.message(1, "A subject", "A body", 1234, true)
+**/
+
+// Define
+function message (jar, token, senderId, recipient, subject, body, replyMessageId, includePreviousMessage) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: '//privatemessages.roblox.com/v1/messages/send',
+      options: {
+        method: 'POST',
+        jar: jar,
+        headers: {
+          'X-CSRF-TOKEN': token,
+          'Content-Type': 'application/json'
+        },
+        body: JSON.stringify({
+          userId: senderId,
+          recipientId: recipient,
+          subject,
+          body,
+          replyMessageId,
+          includePreviousMessage
+        }),
+        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(', ')}`))
+          }
+        }
+      })
+  })
+}
+
+exports.func = function (args) {
+  const jar = args.jar
+  return queue('Message', getHash({ jar: jar }), function () {
+    return getGeneralToken({ jar: jar })
+      .then(function (xcsrf) {
+        return getSenderId({ jar: jar }).then((senderId) => {
+          return message(jar, xcsrf, senderId, args.recipient, args.subject, args.body, args.replyMessageId, args.includePreviousMessage)
+        })
+      })
+  }, function () {
+    return true
+  })
+}

package/lib/privatemessages/onMessage.js

@@ -0,0 +1,88 @@
+// Dependencies
+const events = require('events')
+
+// Includes
+const onNotification = require('../client/onNotification.js').func
+const getMessages = require('./getMessages.js').func
+
+// Args
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 An event for when a user sends you a message via. the older 'email-like' message system. To receive chat messages,
+ * see the `onNewMessage` method.
+ * @see [onNewMessage()](global.html#onNewMessage).
+ * @category User
+ * @alias onMessage
+ * @returns An EventEmitter that emits when a user sends you a message.
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * const messageEvent = noblox.onMessage()
+ * messageEvent.on("data", function(data) {
+ *  console.log("New message! ", data)
+ * })
+ * messageEvent.on("error", function(err) {
+ *  console.error("Something went wrong: ", err)
+ *  // Handle error as needed
+ * })
+**/
+
+// Define
+exports.func = function (args) {
+  const jar = args.jar
+  const onMessage = new events.EventEmitter()
+  let waitingForRequest = false
+  let latest
+  getMessages({ jar: jar, messageTab: 'Inbox', pageNumber: 0 })
+    .then(function (initial) {
+      latest = initial.collection[0] ? initial.collection[0].id : 0
+      const notifications = onNotification({ jar: jar })
+      notifications.on('data', function (name, message) {
+        if (name === 'NotificationStream' && message.Type === 'NewNotification') {
+          if (waitingForRequest) {
+            waitingForRequest = false
+          } else {
+            getMessages({
+              jar: jar,
+              messageTab: 'Inbox',
+              pageNumber: 0
+            })
+              .then(function (inbox) {
+                const messages = inbox.collection
+                for (let i = messages.length - 1; i >= 0; i--) {
+                  const message = messages[i]
+                  const id = message.id
+                  if (id > latest) {
+                    latest = id
+                    onMessage.emit('data', message)
+                  }
+                }
+              })
+          }
+        } else if (name === 'FriendshipNotifications' && message.Type === 'FriendshipRequested') {
+          waitingForRequest = true
+        }
+      })
+      notifications.on('error', function (err) {
+        onMessage.emit('error', err)
+      })
+      notifications.on('connect', function () {
+        onMessage.emit('connect')
+      })
+      notifications.on('close', function (internal) {
+        if (internal) {
+          return
+        }
+        onMessage.emit('close', true)
+      })
+      onMessage.on('close', function (internal) {
+        if (internal) {
+          return
+        }
+        notifications.emit('close', true)
+      })
+    })
+
+  return onMessage
+}