noblox.ts 4.10.5

package/lib/cache/add.js

@@ -0,0 +1,14 @@
+// Includes
+const levelOneCopy = require('../internal/levelOneCopy.js')
+
+// Define
+module.exports = function (cache, type, index, element) {
+  if (cache[type]) {
+    if (element instanceof Object) {
+      element = levelOneCopy(element)
+    }
+    cache[type].items[index] = { item: element, time: Date.now() / 1000 }
+  } else {
+    return 'Invalid type'
+  }
+}

package/lib/cache/addIf.js

@@ -0,0 +1,26 @@
+// Includes
+const add = require('./add.js')
+const get = require('./get.js')
+
+// Define
+module.exports = function (cache, type, index, callbacks) {
+  const got = get(cache, type, index)
+  const item = got[0]
+  const refresh = got[1]
+  if (item) {
+    callbacks.done(item)
+    if (refresh) {
+      const group = cache[type]
+      group.refresh = false
+      callbacks.add(function (element) {
+        group.refresh = true
+        add(cache, type, index, element)
+      })
+    }
+  } else {
+    callbacks.add(function (element) {
+      add(cache, type, index, element)
+      callbacks.done(element)
+    })
+  }
+}

package/lib/cache/clear.js

@@ -0,0 +1,8 @@
+// Define
+module.exports = function (cache, type, index) {
+  if (cache[type]) {
+    cache[type].items[index].time = null
+  } else {
+    return 'Invalid type'
+  }
+}

package/lib/cache/get.js

@@ -0,0 +1,28 @@
+// Includes
+const levelOneCopy = require('../internal/levelOneCopy.js')
+
+// Define
+module.exports = function (cache, type, index) {
+  if (cache[type]) {
+    const group = cache[type]
+    const cached = group.items[index]
+    if (cached && cached.time) {
+      let passed
+      if (!group.permanent) {
+        passed = Date.now() / 1000 - cached.time
+        if (passed > group.expire) {
+          return false
+        }
+      }
+      let item = cached.item
+      if (item instanceof Object) {
+        item = levelOneCopy(item)
+      }
+      return [item, (group.refresh && ((group.refresh === true && true) || passed > group.refresh))]
+    } else {
+      return false
+    }
+  } else {
+    return 'Invalid type'
+  }
+}

package/lib/cache/index.js

@@ -0,0 +1,17 @@
+// Includes
+const newCache = require('./new.js')
+const add = require('./add.js')
+const addIf = require('./addIf.js')
+const get = require('./get.js')
+const clear = require('./clear.js')
+const wrap = require('./wrap.js')
+
+// Define
+module.exports = {
+  new: newCache,
+  add: add,
+  clear: clear,
+  addIf: addIf,
+  get: get,
+  wrap: wrap
+}

package/lib/cache/new.js

@@ -0,0 +1,12 @@
+// Define
+module.exports = function (types) {
+  const cache = {}
+  for (let i = 0; i < types.length; i++) {
+    const type = types[i]
+    const expireValue = type.expire
+    const permanent = expireValue === true
+    const expire = (permanent || expireValue === false ? 0 : expireValue)
+    cache[type.name] = { items: {}, expire: expire, refresh: type.refresh, permanent: permanent }
+  }
+  return cache
+}

package/lib/cache/wrap.js

@@ -0,0 +1,25 @@
+// Includes
+const addIf = require('./addIf.js')
+const options = require('../options.js')
+
+// Define
+function wrap (type, index, func) {
+  const cache = options.cache
+  const group = cache[type]
+  if (group.expire > 0 || group.permanent) {
+    return new Promise(function (resolve, reject) {
+      addIf(cache, type, index, {
+        done: resolve,
+        add: function (done) {
+          return func().then(done).catch(reject)
+        }
+      })
+    })
+  } else {
+    return func()
+  }
+}
+
+module.exports = function (type, index, func) {
+  return wrap(type, index, func)
+}

package/lib/chat/addUsersToConversation.js

@@ -0,0 +1,61 @@
+const http = require('../util/http.js').func
+const getGeneralToken = require('../util/getGeneralToken.js').func
+
+exports.required = ['conversationId', 'userIds']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Add users to a conversation.
+ * @category Chat
+ * @alias addUsersToConversation
+ * @param {number} conversationId - The id of the conversation.
+ * @param {Array<number>} userIds - The userIds of the users to add.
+ * @returns {Promise<ConversationAddResponse>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * noblox.addUsersToConversation(1, [1, 2, 3])
+**/
+
+function addUsersToConversation (conversationId, userIds, jar, token) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: '//chat.roblox.com/v2/add-to-conversation',
+      options: {
+        method: 'POST',
+        jar: jar,
+        headers: {
+          'X-CSRF-TOKEN': token
+        },
+        json: {
+          conversationId: conversationId,
+          participantUserIds: userIds
+        },
+        resolveWithFullResponse: true
+      }
+    }
+    return http(httpOpt).then((res) => {
+      if (res.statusCode === 200) {
+        if (!res.body.resultType === 'Success') {
+          reject(new Error(res.body.statusMessage))
+        } else {
+          resolve(res.body)
+        }
+      } else {
+        let error = 'An unknown error has occurred.'
+        if (res.body && res.body.errors) {
+          error = res.body.errors.map((e) => e.message).join('\n')
+        }
+        reject(new Error(error))
+      }
+    }).catch(error => reject(error))
+  })
+}
+
+exports.func = (args) => {
+  const jar = args.jar
+
+  return getGeneralToken({ jar: jar }).then((xcsrf) => {
+    return addUsersToConversation(args.conversationId, args.userIds, jar, xcsrf)
+  })
+}

package/lib/chat/chatSettings.js

@@ -0,0 +1,33 @@
+const http = require('../util/http.js').func
+
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Get the chat settings.
+ * @category Chat
+ * @alias chatSettings
+ * @returns {Promise<ChatSettings>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * const settings = await noblox.chatSettings()
+**/
+
+exports.func = (args) => {
+  const jar = args.jar
+
+  return http({
+    url: '//chat.roblox.com/v2/chat-settings',
+    options: {
+      method: 'GET',
+      jar: jar,
+      resolveWithFullResponse: true
+    }
+  }).then((res) => {
+    if (res.statusCode !== 200) {
+      throw new Error('You are not logged in')
+    } else {
+      return JSON.parse(res.body)
+    }
+  })
+}

package/lib/chat/getChatMessages.js

@@ -0,0 +1,40 @@
+const http = require('../util/http.js').func
+
+exports.required = ['conversationId']
+exports.optional = ['pageSize', 'exclusiveStartMessageId', 'jar']
+
+// Docs
+/**
+ * 🔐 Get the chat messages for a conversation.
+ * @category Chat
+ * @alias getChatMessages
+ * @param {number} conversationId - The id of the conversation.
+ * @param {number=} [pageSize=100] - The size of the page.
+ * @param {string=} exclusiveStartMessageId - The messageId to start at.
+ * @returns {Promise<ChatMessage[]>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * const messages = await noblox.getChatMessages(1, 25)
+**/
+
+exports.func = (args) => {
+  const jar = args.jar
+  const conversationId = parseInt(args.conversationId) ? parseInt(args.conversationId) : 0
+  const pageSize = parseInt(args.pageSize) ? parseInt(args.pageSize) : 100
+  const startMessageId = typeof (args.exclusiveStartMessageId) === 'string' ? args.exclusiveStartMessageId : ''
+
+  return http({
+    url: '//chat.roblox.com/v2/get-messages?conversationId=' + conversationId + '&pageSize=' + pageSize + '&exclusiveStartMessageId=' + startMessageId,
+    options: {
+      method: 'GET',
+      jar: jar,
+      resolveWithFullResponse: true
+    }
+  }).then((res) => {
+    if (res.statusCode !== 200) {
+      throw new Error('You are not logged in')
+    } else {
+      return JSON.parse(res.body)
+    }
+  })
+}

package/lib/chat/getConversations.js

@@ -0,0 +1,43 @@
+const http = require('../util/http.js').func
+
+exports.required = ['conversationIds']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Get conversation details for the conversationIds specified in the parameters
+ * @category Chat
+ * @alias getConversations
+ * @param {Array<number>} conversationIds - An array with the ids of the conversations.
+ * @returns {Promise<ChatConversation[]>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * const conversations = await noblox.getConversations([1, 2, 3])
+**/
+
+exports.func = (args) => {
+  const jar = args.jar
+  const conversationIds = typeof (args.conversationIds) === 'object' ? args.conversationIds : []
+
+  return http({
+    url: '//chat.roblox.com/v2/get-conversations?conversationIds=' + conversationIds.join('&conversationIds='),
+    options: {
+      method: 'GET',
+      jar: jar,
+      resolveWithFullResponse: true
+    }
+  }).then((res) => {
+    if (res.statusCode !== 200) {
+      throw new Error('You are not logged in')
+    } else {
+      let response = JSON.parse(res.body)
+
+      response = response.map((entry) => {
+        entry.lastUpdated = new Date(entry.lastUpdated)
+        return entry
+      })
+
+      return response
+    }
+  })
+}

package/lib/chat/getRolloutSettings.js

@@ -0,0 +1,35 @@
+const http = require('../util/http.js').func
+
+exports.optional = ['featureNames', 'jar']
+
+// Docs
+/**
+ * 🔐 Get the rollout settings.
+ * @category Chat
+ * @alias getRolloutSettings
+ * @param {Array<string>=} featureNames - The names of the features rolling out.
+ * @returns {Promise<GetRolloutSettingsResult>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * const settings = await noblox.getRolloutSettings(['LuaChat', 'Party'])
+**/
+
+exports.func = (args) => {
+  const jar = args.jar
+  const featureNames = typeof (args.featureNames) === 'object' ? args.featureNames : []
+
+  return http({
+    url: '//chat.roblox.com/v2/get-rollout-settings?featureNames=' + featureNames.join('&featureNames='),
+    options: {
+      method: 'GET',
+      jar: jar,
+      resolveWithFullResponse: true
+    }
+  }).then((res) => {
+    if (res.statusCode !== 200) {
+      throw new Error('You are not logged in')
+    } else {
+      return JSON.parse(res.body)
+    }
+  })
+}

package/lib/chat/getUnreadConversationCount.js

@@ -0,0 +1,33 @@
+const http = require('../util/http.js').func
+
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Get the number of unread conversations.
+ * @category Chat
+ * @alias getUnreadConversationCount
+ * @returns {Promise<GetUnreadConversationCountResult>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * const unreadConversationCount = noblox.getUnreadConversationCount()
+**/
+
+exports.func = (args) => {
+  const jar = args.jar
+
+  return http({
+    url: '//chat.roblox.com/v2/get-unread-conversation-count',
+    options: {
+      method: 'GET',
+      jar: jar,
+      resolveWithFullResponse: true
+    }
+  }).then((res) => {
+    if (res.statusCode !== 200) {
+      throw new Error('You are not logged in')
+    } else {
+      return JSON.parse(res.body)
+    }
+  })
+}

package/lib/chat/getUnreadMessages.js

@@ -0,0 +1,38 @@
+const http = require('../util/http.js').func
+
+exports.required = ['conversationIds']
+exports.optional = ['pageSize', 'jar']
+
+// Docs
+/**
+ * 🔐 Returns unread messages in the given conversations
+ * @category Chat
+ * @alias getUnreadMessages
+ * @param {Array<number>} conversationIds - The IDs of the conversations you want unread messages from.
+ * @param {number} pageSize - Number of messages to return on each page.
+ * @returns {Promise<ChatConversationWithMessages[]>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * noblox.getUnreadMessages([8212952828])
+**/
+
+exports.func = (args) => {
+  const jar = args.jar
+  const conversationIds = typeof (args.conversationIds) === 'object' ? args.conversationIds : []
+  const pageSize = parseInt(args.pageSize) ? parseInt(args.pageSize) : 30
+
+  return http({
+    url: '//chat.roblox.com/v2/get-unread-messages?pageSize=' + pageSize + '&conversationIds=' + conversationIds.join('&conversationIds='),
+    options: {
+      method: 'GET',
+      jar: jar,
+      resolveWithFullResponse: true
+    }
+  }).then((res) => {
+    if (res.statusCode !== 200) {
+      throw new Error('You are not logged in')
+    } else {
+      return JSON.parse(res.body)
+    }
+  })
+}

package/lib/chat/getUserConversations.js

@@ -0,0 +1,37 @@
+const http = require('../util/http.js').func
+
+exports.optional = ['pageNumber', 'pageSize', 'jar']
+
+// Docs
+/**
+ * 🔐 Get your conversations.
+ * @category Chat
+ * @alias getUserConversations
+ * @param {number=} pageNumber - The page index.
+ * @param {number=} pageSize - The size of each page.
+ * @returns {Promise<ChatConversation[]>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * const conversations = await noblox.getUserConversations()
+**/
+
+exports.func = (args) => {
+  const jar = args.jar
+  const pageNumber = parseInt(args.pageNumber) ? parseInt(args.pageNumber) : 1
+  const pageSize = parseInt(args.pageSize) ? parseInt(args.pageSize) : 30
+
+  return http({
+    url: '//chat.roblox.com/v2/get-user-conversations?pageNumber=' + pageNumber + '&pageSize=' + pageSize,
+    options: {
+      method: 'GET',
+      jar: jar,
+      resolveWithFullResponse: true
+    }
+  }).then((res) => {
+    if (res.statusCode !== 200) {
+      throw new Error('You are not logged in')
+    } else {
+      return JSON.parse(res.body)
+    }
+  })
+}

package/lib/chat/markChatAsRead.js

@@ -0,0 +1,52 @@
+const http = require('../util/http.js').func
+const getGeneralToken = require('../util/getGeneralToken.js').func
+
+exports.required = ['conversationId', 'endMessageId']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Mark a chat as read.
+ * @category Chat
+ * @alias markChatAsRead
+ * @param {number} conversationId - The id of the conversation.
+ * @param {string} endMessageId - The last message to read.
+ * @returns {Promise<void>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * noblox.markChatAsRead(8212952828, 'e775e103-876f-4332-84ab-1ea14f326d39')
+**/
+
+const nextFunction = (jar, token, conversationId, endMessageId) => {
+  return http({
+    url: '//chat.roblox.com/v2/mark-as-read',
+    options: {
+      method: 'POST',
+      jar: jar,
+      headers: {
+        'X-CSRF-TOKEN': token
+      },
+      json: {
+        conversationId: conversationId,
+        endMessageId: endMessageId
+      },
+      resolveWithFullResponse: true
+    }
+  }).then((res) => {
+    if (res.statusCode === 200) {
+      if (!res.body.resultType === 'Success') {
+        throw new Error(res.body.statusMessage)
+      }
+    } else {
+      throw new Error('Mark as read failed')
+    }
+  })
+}
+
+exports.func = (args) => {
+  const jar = args.jar
+
+  return getGeneralToken({ jar: jar }).then((xcsrf) => {
+    return nextFunction(jar, xcsrf, args.conversationId, args.endMessageId)
+  })
+}

package/lib/chat/markChatAsSeen.js

@@ -0,0 +1,50 @@
+const http = require('../util/http.js').func
+const getGeneralToken = require('../util/getGeneralToken.js').func
+
+exports.required = ['conversationIds']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Mark chats as seen.
+ * @category Chat
+ * @alias markChatAsSeen
+ * @param {Array<number>} conversationIds - An array with conversationIds.
+ * @returns {Promise<void>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * noblox.markChatAsSeen([1, 2, 3])
+**/
+
+const nextFunction = (jar, token, conversationIds) => {
+  return http({
+    url: '//chat.roblox.com/v2/mark-as-seen',
+    options: {
+      method: 'POST',
+      jar: jar,
+      headers: {
+        'X-CSRF-TOKEN': token
+      },
+      json: {
+        conversationsToMarkSeen: conversationIds
+      },
+      resolveWithFullResponse: true
+    }
+  }).then((res) => {
+    if (res.statusCode === 200) {
+      if (!res.body.resultType === 'Success') {
+        throw new Error(res.body.statusMessage)
+      }
+    } else {
+      throw new Error('Mark as seen failed')
+    }
+  })
+}
+
+exports.func = (args) => {
+  const jar = args.jar
+
+  return getGeneralToken({ jar: jar }).then((xcsrf) => {
+    return nextFunction(jar, xcsrf, args.conversationIds)
+  })
+}

package/lib/chat/multiGetLatestMessages.js

@@ -0,0 +1,37 @@
+const http = require('../util/http.js').func
+
+exports.required = ['conversationIds']
+exports.optional = ['pageSize', 'jar']
+
+// Docs
+/**
+ * 🔐 Get multiple of the latest messages.
+ * @category Chat
+ * @alias multiGetLatestMessages
+ * @param {Array<number>} conversationIds - An array with the conversationIds.
+ * @returns {Promise<ChatConversationWithMessages[]>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * const recentMessages = await noblox.multiGetLatestMessages([1, 2, 3])
+**/
+
+exports.func = (args) => {
+  const jar = args.jar
+  const conversationIds = typeof (args.conversationIds) === 'object' ? args.conversationIds : []
+  const pageSize = parseInt(args.pageSize) ? parseInt(args.pageSize) : 30
+
+  return http({
+    url: '//chat.roblox.com/v2/multi-get-latest-messages?pageSize=' + pageSize + '&conversationIds=' + conversationIds.join('&conversationIds='),
+    options: {
+      method: 'GET',
+      jar: jar,
+      resolveWithFullResponse: true
+    }
+  }).then((res) => {
+    if (res.statusCode !== 200) {
+      throw new Error('You are not logged in')
+    } else {
+      return JSON.parse(res.body)
+    }
+  })
+}

package/lib/chat/onNewConversation.js

@@ -0,0 +1,50 @@
+const events = require('events')
+
+const onNotification = require('../client/onNotification.js').func
+
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 An event for when a conversation is created.
+ * @category Chat
+ * @alias onNewConversation
+ * @returns An EventEmitter that emits when a conversation is created.
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * const conversationEvent = noblox.onNewConversation()
+ * conversationEvent.on("data", function(data) {
+ *  console.log("New conversation! ", data)
+ * })
+ * conversationEvent.on("error", function(err) {
+ *  console.error("Something went wrong: ", err)
+ *  // Handle error as needed
+ * })
+**/
+
+exports.func = (args) => {
+  const jar = args.jar
+  const onChatEvent = new events.EventEmitter()
+  const notifications = onNotification({ jar: jar })
+
+  notifications.on('data', (name, message) => {
+    if (name === 'ChatNotifications' && message.Type === 'NewConversation') {
+      onChatEvent.emit('data', message.ConversationId)
+    }
+  })
+
+  notifications.on('error', (err) => {
+    onChatEvent.emit('error', err)
+  })
+
+  notifications.on('connect', () => {
+    onChatEvent.emit('connect')
+  })
+
+  notifications.on('close', (internal) => {
+    if (internal) return
+    notifications.emit('close', true)
+  })
+
+  return onChatEvent
+}