noblox-asset.js 7.4.0

package/lib/chat/onNewMessageBySelf.js

@@ -0,0 +1,50 @@
+const events = require('events')
+
+const onNotification = require('../client/onNotification.js').func
+
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 An event for when you send a new message.
+ * @category Chat
+ * @alias onNewMessageBySelf
+ * @returns An EventEmitter that emits when you send a new message.
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * const messageSent = noblox.onNewMessageBySelf()
+ * messageSent.on("data", function(data) {
+ *  console.log("Sent chat message! ", data)
+ * })
+ * messageSent.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 })
+
+  notifications.on('data', (name, message) => {
+    if (name === 'ChatNotifications' && message.Type === 'NewMessageBySelf') {
+      newEvent.emit('data', message.ConversationId)
+    }
+  })
+
+  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/chat/onUserOnline.js

@@ -0,0 +1,50 @@
+const events = require('events')
+
+const onNotification = require('../client/onNotification.js').func
+
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 An event for when someone comes online.
+ * @category Chat
+ * @alias onUserOnline
+ * @returns An EventEmitter that emits when someone comes online.
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * const userOnlineEvent = noblox.onUserOnline()
+ * userOnlineEvent.on("data", function(data) {
+ *  console.log("User online! ", data)
+ * })
+ * userOnlineEvent.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 })
+
+  notifications.on('data', (name, message) => {
+    if (name === 'PresenceNotifications' && message.Type === 'UserOnline') {
+      newEvent.emit('data', message.UserId)
+    }
+  })
+
+  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/chat/onUserTyping.js

@@ -0,0 +1,54 @@
+const events = require('events')
+
+const onNotification = require('../client/onNotification.js').func
+
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 An event for when someone starts typing in a chat.
+ * @category Chat
+ * @alias onUserTyping
+ * @returns An EventEmitter that emits when someone starts typing in a chat.
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * const userTyping = noblox.onUserTyping()
+ * userTyping.on("data", function(data) {
+ *  console.log("User typing! ", data)
+ * })
+ * userTyping.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 })
+
+  notifications.on('data', (name, message) => {
+    if (name === 'ChatNotifications' && message.Type === 'ParticipantTyping') {
+      newEvent.emit('data', {
+        UserId: message.UserId,
+        ConversationId: message.ConversationId,
+        IsTyping: message.IsTyping
+      })
+    }
+  })
+
+  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/chat/removeFromGroupConversation.js

@@ -0,0 +1,59 @@
+const http = require('../util/http.js').func
+const getGeneralToken = require('../util/getGeneralToken.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+exports.required = ['conversationId', 'userId']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Remove a user from the group conversation.
+ * @category Chat
+ * @alias removeFromGroupConversation
+ * @param {number} conversationId - The id of the conversation.
+ * @param {number} userId - The id of the user.
+ * @returns {Promise<ConversationRemoveResponse>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * noblox.removeFromGroupConversation(1, 2)
+**/
+
+function removeFromGroupConversation (conversationId, userId, jar, token) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: '//chat.roblox.com/v2/remove-from-conversation',
+      options: {
+        method: 'POST',
+        jar,
+        headers: {
+          'X-CSRF-TOKEN': token
+        },
+        json: {
+          conversationId,
+          participantUserId: userId
+        },
+        resolveWithFullResponse: true
+      }
+    }
+
+    return http(httpOpt).then((res) => {
+      if (res.statusCode === 200) {
+        if (!res.body.resultType === 'Success') {
+          reject(new RobloxAPIError(res))
+        } else {
+          resolve(res.body)
+        }
+      } else {
+        reject(new RobloxAPIError(res))
+      }
+    }).catch(error => reject(error))
+  })
+}
+
+exports.func = (args) => {
+  const jar = args.jar
+
+  return getGeneralToken({ jar }).then((xcsrf) => {
+    return removeFromGroupConversation(args.conversationId, args.userId, jar, xcsrf)
+  })
+}

package/lib/chat/renameGroupConversation.js

@@ -0,0 +1,58 @@
+const http = require('../util/http.js').func
+const getGeneralToken = require('../util/getGeneralToken.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+exports.required = ['conversationId', 'title']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Rename a group conversation.
+ * @category Chat
+ * @alias renameGroupConversation
+ * @param {number} conversationId - The id of the conversation.
+ * @param {string} title - The new title of the group.
+ * @returns {Promise<ConversationRenameResponse>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * noblox.renameGroupConversation(1, "A cool group.")
+**/
+
+function renameGroupConversation (conversationId, newTitle, jar, token) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: '//chat.roblox.com/v2/rename-group-conversation',
+      options: {
+        method: 'POST',
+        jar,
+        headers: {
+          'X-CSRF-TOKEN': token
+        },
+        json: {
+          conversationId,
+          newTitle
+        },
+        resolveWithFullResponse: true
+      }
+    }
+    return http(httpOpt).then((res) => {
+      if (res.statusCode === 200) {
+        if (!res.body.resultType === 'Success') {
+          reject(new RobloxAPIError(res))
+        } else {
+          resolve(res.body)
+        }
+      } else {
+        reject(new RobloxAPIError(res))
+      }
+    }).catch(error => reject(error))
+  })
+}
+
+exports.func = (args) => {
+  const jar = args.jar
+
+  return getGeneralToken({ jar }).then((xcsrf) => {
+    return renameGroupConversation(args.conversationId, args.title, jar, xcsrf)
+  })
+}

package/lib/chat/sendChatMessage.js

@@ -0,0 +1,58 @@
+const http = require('../util/http.js').func
+const getGeneralToken = require('../util/getGeneralToken.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+exports.required = ['conversationId', 'message']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Send a message in a chat.
+ * @category Chat
+ * @alias sendChatMessage
+ * @param {number} conversationId - The id of the conversation.
+ * @param {string} message - The message to send.
+ * @returns {Promise<SendChatResponse>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * noblox.sendChatMessage(1, "Hello world!")
+**/
+
+function sendChatMessage (conversationId, messageText, jar, token) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: '//chat.roblox.com/v2/send-message',
+      options: {
+        method: 'POST',
+        jar,
+        headers: {
+          'X-CSRF-TOKEN': token
+        },
+        json: {
+          conversationId,
+          message: messageText
+        },
+        resolveWithFullResponse: true
+      }
+    }
+    return http(httpOpt).then((res) => {
+      if (res.statusCode === 200) {
+        if (!res.body.resultType === 'Success') {
+          reject(new RobloxAPIError(res))
+        } else {
+          resolve(res.body)
+        }
+      } else {
+        reject(new RobloxAPIError(res))
+      }
+    }).catch(error => reject(error))
+  })
+}
+
+exports.func = (args) => {
+  const jar = args.jar
+
+  return getGeneralToken({ jar }).then((xcsrf) => {
+    return sendChatMessage(args.conversationId, args.message, jar, xcsrf)
+  })
+}

package/lib/chat/setChatUserTyping.js

@@ -0,0 +1,58 @@
+const http = require('../util/http.js').func
+const getGeneralToken = require('../util/getGeneralToken.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+exports.required = ['conversationId', 'isTyping']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Trigger the typing action in a conversation.
+ * @category Chat
+ * @alias setChatUserTyping
+ * @param {number} conversationId - The id of the conversation.
+ * @param {boolean} isTyping - If the user is typing.
+ * @returns {Promise<UpdateTypingResponse>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * noblox.setChatUserTyping(1, true)
+**/
+
+function setChatUserTyping (conversationId, isTyping, jar, token) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: '//chat.roblox.com/v2/update-user-typing-status',
+      options: {
+        method: 'POST',
+        jar,
+        headers: {
+          'X-CSRF-TOKEN': token
+        },
+        json: {
+          conversationId,
+          isTyping
+        },
+        resolveWithFullResponse: true
+      }
+    }
+    return http(httpOpt).then((res) => {
+      if (res.statusCode === 200) {
+        if (!res.body.resultType === 'Success') {
+          reject(new RobloxAPIError(res))
+        } else {
+          resolve(res.body)
+        }
+      } else {
+        reject(new RobloxAPIError(res))
+      }
+    }).catch(error => reject(error))
+  })
+}
+
+exports.func = (args) => {
+  const jar = args.jar
+
+  return getGeneralToken({ jar }).then((xcsrf) => {
+    return setChatUserTyping(args.conversationId, args.isTyping, jar, xcsrf)
+  })
+}

package/lib/chat/start121Conversation.js

@@ -0,0 +1,51 @@
+const http = require('../util/http.js').func
+const getGeneralToken = require('../util/getGeneralToken.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+exports.required = ['userId']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Start a conversation with another user.
+ * @category Chat
+ * @alias start121Conversation
+ * @param {number} userId - The id of the user.
+ * @returns {Promise<void>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * noblox.start121Conversation(1)
+**/
+
+const nextFunction = (jar, token, userId) => {
+  return http({
+    url: '//chat.roblox.com/v2/start-one-to-one-conversation',
+    options: {
+      method: 'POST',
+      jar,
+      headers: {
+        'X-CSRF-TOKEN': token
+      },
+      json: {
+        participantUserId: userId
+      },
+      resolveWithFullResponse: true
+    }
+  }).then((res) => {
+    if (res.statusCode === 200) {
+      if (!res.body.resultType === 'Success') {
+        throw new RobloxAPIError(res)
+      }
+    } else {
+      throw new RobloxAPIError(res)
+    }
+  })
+}
+
+exports.func = (args) => {
+  const jar = args.jar
+
+  return getGeneralToken({ jar }).then((xcsrf) => {
+    return nextFunction(jar, xcsrf, args.userId)
+  })
+}

package/lib/chat/startCloudEditConversation.js

@@ -0,0 +1,51 @@
+const http = require('../util/http.js').func
+const getGeneralToken = require('../util/getGeneralToken.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+exports.required = ['placeId']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Start a Cloud Edit/Team Create conversation.
+ * @category Chat
+ * @alias startCloudEditConversation
+ * @param {number} placeId - The id of the place.
+ * @returns {Promise<void>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * noblox.startCloudEditConversation(1117747196)
+**/
+
+const nextFunction = (jar, token, placeId) => {
+  return http({
+    url: '//chat.roblox.com/v2/start-cloud-edit-conversation',
+    options: {
+      method: 'POST',
+      jar,
+      headers: {
+        'X-CSRF-TOKEN': token
+      },
+      json: {
+        placeId
+      },
+      resolveWithFullResponse: true
+    }
+  }).then((res) => {
+    if (res.statusCode === 200) {
+      if (!res.body.resultType === 'Success') {
+        throw new RobloxAPIError(res)
+      }
+    } else {
+      throw new RobloxAPIError(res)
+    }
+  })
+}
+
+exports.func = (args) => {
+  const jar = args.jar
+
+  return getGeneralToken({ jar }).then((xcsrf) => {
+    return nextFunction(jar, xcsrf, args.placeId)
+  })
+}

package/lib/chat/startGroupConversation.js

@@ -0,0 +1,59 @@
+const http = require('../util/http.js').func
+const getGeneralToken = require('../util/getGeneralToken.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+exports.required = ['userIds', 'title']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Start a group conversation.
+ * @category Chat
+ * @alias startGroupConversation
+ * @param {Array<number>} userIds - An array of userIds to add.
+ * @param {string} title - The title of the group.
+ * @returns {Promise<StartGroupConversationResponse>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * noblox.startGroupConversation([1, 2, 3], "A group conversation.")
+**/
+
+function startGroupConversation (userIds, chatTitle, jar, token) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: '//chat.roblox.com/v2/start-group-conversation',
+      options: {
+        method: 'POST',
+        jar,
+        headers: {
+          'X-CSRF-TOKEN': token
+        },
+        json: {
+          participantUserIds: userIds,
+          title: chatTitle
+        },
+        resolveWithFullResponse: true
+      }
+    }
+
+    return http(httpOpt).then((res) => {
+      if (res.statusCode === 200) {
+        if (!res.body.resultType === 'Success') {
+          reject(new RobloxAPIError(res))
+        } else {
+          resolve(res.body)
+        }
+      } else {
+        reject(new RobloxAPIError(res))
+      }
+    }).catch(error => reject(error))
+  })
+}
+
+exports.func = (args) => {
+  const jar = args.jar
+
+  return getGeneralToken({ jar }).then((xcsrf) => {
+    return startGroupConversation(args.userIds, args.title, jar, xcsrf)
+  })
+}

package/lib/client/onNotification.js

@@ -0,0 +1,86 @@
+// Dependencies
+const signalR = require('@microsoft/signalr')
+const events = require('events')
+
+// Includes
+const getSession = require('../util/getSession.js').func
+const settings = require('../../settings.json')
+
+// Args
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 An event for when you get a notification.
+ * @category Client
+ * @alias onNotification
+ * @returns An EventEmitter that emits when you get a notification.
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * const notification = noblox.onNotification()
+ * notification.on("data", function(data) {
+ *  console.log("New notification! ", data)
+ * })
+ * notification.on("error", function(err) {
+ *  console.error("Something went wrong: ", err)
+ *  // Handle error as needed
+ * })
+**/
+
+// Define
+exports.func = function (args) {
+  const max = settings.event.maxRetries
+  const notifications = new events.EventEmitter()
+  function connect (retries) {
+    if (typeof args.jar === 'string') {
+      args.jar = { session: args.jar }
+    }
+    const session = getSession({ jar: args.jar })
+    let userNotificationConnection = null
+
+    userNotificationConnection = new signalR.HubConnectionBuilder()
+      .withUrl('https://realtime-signalr.roblox.com/userhub', {
+        transport: signalR.HttpTransportType.WebSockets,
+        skipNegotiation: true,
+        headers: {
+          Cookie: '.ROBLOSECURITY=' + session + ';'
+        }
+      })
+      .build()
+
+    userNotificationConnection.on('notification', function (name, message) {
+      notifications.emit('data', name, JSON.parse(message))
+    })
+
+    notifications.on('close', userNotificationConnection.stop)
+
+    userNotificationConnection.disconnected = function (err) {
+      notifications.emit('error', new Error('Connection failed: ' + err.message))
+      if (retries !== -1) {
+        if (retries > max) {
+          notifications.emit('close', new Error('Max retries reached'))
+        } else {
+          setTimeout(connect, 5000, retries + 1)
+        }
+      }
+    }
+
+    userNotificationConnection.error = function (err) {
+      notifications.emit('error', err)
+    }
+
+    userNotificationConnection.connected = function (connection) {
+      notifications.emit('connect', connection)
+    }
+
+    userNotificationConnection.reconnecting = function () {
+      setTimeout(connect, 5000, 0)
+      notifications.emit('error', new Error('Lost connection, reconnecting'))
+      return true // Abort reconnection
+    }
+
+    userNotificationConnection.start()
+  }
+  connect(-1)
+  return notifications
+}

package/lib/client/setAPIKey.js

@@ -0,0 +1,18 @@
+const options = require('../options.js')
+
+exports.required = ['apiKey']
+
+// Docs
+/**
+ * 🔑 Sign in with an API key.
+ * @category Client
+ * @alias setAPIKey
+ * @param {string} apiKey - The api key to sign in with.
+ * @returns {Promise<boolean>}
+ * @example const noblox = require("noblox.js")
+ * noblox.setAPIKey("A3H+1rfQj0Kwz0CsSO2ciuT/e/ZHekahvehGG3PPmFOASZx1")
+**/
+
+exports.func = function (args) {
+  options.jar.apiKey = args.apiKey
+}

package/lib/client/setCookie.js

@@ -0,0 +1,38 @@
+const options = require('../options.js')
+const getAuthenticatedUser = require('../util/getAuthenticatedUser.js').func
+
+exports.required = ['cookie']
+exports.optional = ['validate']
+
+// Docs
+/**
+ * 🔑 Sign in with a cookie.
+ * @category Client
+ * @alias setCookie
+ * @param {string} cookie - The cookie to sign in with.
+ * @param {boolean=} [validate=true] - Whether to validate the cookie or not.
+ * @returns {Promise<AuthenticatedUserData>}
+ * @example const noblox = require("noblox.js")
+ * noblox.setCookie("cookie").then(function() {
+ *   //your code here
+ * })
+**/
+
+exports.func = async function (args) {
+  // verify it
+  if (!args.cookie.toLowerCase().includes('warning:-')) {
+    console.error('Warning: No Roblox warning detected in provided cookie. Ensure you include the entire .ROBLOSECURITY warning.')
+  }
+  if (args.validate === false) {
+    options.jar.session = args.cookie
+    return false
+  }
+  try {
+    const res = await getAuthenticatedUser({ jar: { session: args.cookie } })
+    options.jar.session = args.cookie
+    return res
+  } catch (error) {
+    console.error('Failed to validate cookie: Are you sure the cookie is valid?\nEnsure you include the full cookie, including warning text.')
+    throw new Error(error)
+  }
+}