noblox-asset.js 7.4.0

package/lib/games/sendUserNotification.js

@@ -0,0 +1,65 @@
+const http = require('../util/http.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+exports.required = ['universeId', 'userId', 'assetId', 'parameters']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * ☁️ Send a universe notification to a user.
+ * @category Game
+ * @alias sendUserNotification
+ * @param {number} universeId - The id of the universe.
+ * @param {number} userId - The id of the target player.
+ * @param {string} assetId - The asset id of the notification.
+ * @param {UserNotificationPayloadParameters} parameters - The notification parameters.
+ * @returns {Promise<boolean>}
+ * @example const noblox = require("noblox.js")
+ * // Set API key
+ * const parameters = {
+ *      myMessage: { stringValue: "Hello world!" }
+ * }
+ * const assetId = "774d62e5-3414-b84a-89dd-77d96f1a3d33"
+ * noblox.sendUserNotification(4434277335, 1210019099, assetId, parameters)
+ **/
+
+function sendUserNotification (universeId, userId, assetId, parameters, jar) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: `//apis.roblox.com/cloud/v2/users/${userId}/notifications`,
+      options: {
+        json: true,
+        resolveWithFullResponse: true,
+        jar,
+        method: 'POST',
+        body: {
+          source: {
+            universe: `universes/${universeId}`
+          },
+          payload: {
+            type: 'MOMENT',
+            messageId: assetId,
+            parameters
+          }
+        },
+        headers: {
+          'Content-Type': 'application/json'
+        }
+      }
+    }
+
+    return http(httpOpt)
+      .then(function (res) {
+        if (res.statusCode === 200) {
+          resolve(true)
+        } else {
+          reject(new RobloxAPIError(res))
+        }
+      })
+      .catch(reject)
+  })
+}
+
+exports.func = function (args) {
+  return sendUserNotification(args.universeId, args.userId, args.assetId, args.parameters, args.jar)
+}

package/lib/games/updateDeveloperProduct.js

@@ -0,0 +1,56 @@
+const http = require('../util/http.js').func
+const getGeneralToken = require('../util/getGeneralToken.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+exports.required = ['universeId', 'productId', 'priceInRobux']
+exports.optional = ['name', 'description', 'jar']
+
+// Docs
+/**
+ * 🔐 Update a developer product.
+ * @category Game
+ * @alias updateDeveloperProduct
+ * @param {number} universeId - The id of the universe.
+ * @param {number} productId - The id of the product.
+ * @param {number} priceInRobux - The new price of the product.
+ * @param {string=} name - The new name of the product.
+ * @param {string=} description - The new description of the product.
+ * @returns {Promise<void>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * noblox.updateDeveloperProduct(1, 2, 10, "An Updated Developer Product", "My new updated product.")
+**/
+
+function updateDeveloperProduct (universeId, productId, priceInRobux, name, description, jar, token) {
+  return new Promise((resolve, reject) => {
+    return http({
+      url: `//apis.roblox.com/developer-products/v1/universes/${universeId}/developerproducts/${productId}/update`,
+      options: {
+        method: 'POST',
+        jar,
+        headers: {
+          'X-CSRF-TOKEN': token
+        },
+        json: {
+          Name: name,
+          Description: description,
+          PriceInRobux: priceInRobux
+        },
+        resolveWithFullResponse: true
+      }
+    }).then((res) => {
+      if (res.statusCode === 200) {
+        resolve(res.body)
+      } else {
+        reject(new RobloxAPIError(res))
+      }
+    }).catch(reject)
+  })
+}
+
+exports.func = function ({ universeId, productId, priceInRobux, name, description, jar }) {
+  return getGeneralToken({ jar })
+    .then((token) => {
+      return updateDeveloperProduct(universeId, productId, priceInRobux, name, description, jar, token)
+    })
+}

package/lib/groups/banFromGroup.js

@@ -0,0 +1,47 @@
+// Includes
+const http = require('../util/http.js')
+const getGeneralToken = require('../util/getGeneralToken.js')
+const RobloxAPIError = require('../util/apiError.js')
+
+// Args
+exports.required = ['groupId', 'userId']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Bans a user from the specified group.
+ * @alias banFromGroup
+ * @param {number} groupId - The ID of the group
+ * @param {number} userId - The ID of the target user
+ * @returns {Promise<GroupBan>}
+ * @example const noblox = require("noblox.js")
+ * // Log in
+ * await noblox.banFromGroup(1, 2)
+**/
+
+// Define
+exports.func = async function (args) {
+  const { groupId, jar, userId } = args
+  const token = await getGeneralToken({ jar })
+
+  const response = await http({
+    url: `//groups.roblox.com/v1/groups/${groupId}/bans/${userId}`,
+    options: {
+      method: 'POST',
+      jar,
+      headers: {
+        'x-csrf-token': token
+      },
+      resolveWithFullResponse: true
+    }
+  })
+
+  if (response.statusCode !== 200) {
+    throw new RobloxAPIError(response)
+  }
+
+  const body = JSON.parse(response.body)
+  body.created = new Date(body.created)
+
+  return body
+}

package/lib/groups/changeRank.js

@@ -0,0 +1,59 @@
+// Includes
+const setRank = require('./setRank.js').func
+const getRoles = require('./getRoles.js').func
+const getRankNameInGroup = require('./getRankNameInGroup.js').func
+
+// Args
+exports.required = ['group', 'target', 'change']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Change a user's rank.
+ * @category Group
+ * @alias changeRank
+ * @param {number} groupId - The id of the group.
+ * @param {number} target - The userId of the target.
+ * @param {number} change - The change in rank (1 = one rank higher, -1 = one rank lower)
+ * @returns {Promise<ChangeRankResult>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * noblox.changeRank(1, 2, -1)
+**/
+
+// Define
+exports.func = function (args) {
+  const group = args.group
+  const target = args.target
+  const amount = args.change
+  const jar = args.jar
+  return getRankNameInGroup({ group, userId: target })
+    .then(function (rank) {
+      if (rank === 'Guest') {
+        throw new Error('Target user is not in group')
+      }
+      return getRoles({ group })
+        .then(function (roles) {
+          for (let i = 0; i < roles.length; i++) {
+            const role = roles[i]
+            const thisRank = role.name
+
+            if (thisRank === rank) {
+              const change = i + amount
+              const found = roles[change]
+
+              if (!found) {
+                throw new Error('Rank change is out of range')
+              } else if (found.name === 'Guest' || found.rank === 0) {
+                throw new Error('Group members cannot be demoted to guest.')
+              }
+
+              return setRank({ group, target, rank: found.id, jar })
+                .then(function () {
+                  return { newRole: found, oldRole: role }
+                })
+            }
+          }
+        })
+    })
+}

package/lib/groups/deleteWallPost.js

@@ -0,0 +1,59 @@
+// Includes
+const http = require('../util/http.js').func
+const getGeneralToken = require('../util/getGeneralToken.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+// Args
+exports.required = ['group', ['postId', 'post']]
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Delete a wall post.
+ * @category Group
+ * @alias deleteWallPost
+ * @param {number} group - The id of the group.
+ * @param {number} postId - The id of the post to delete.
+ * @returns {Promise<void>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * noblox.deleteWallPost(1, 2)
+**/
+
+// Define
+function deleteWallPost (jar, token, group, postId) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: `//groups.roblox.com/v1/groups/${group}/wall/posts/${postId}`,
+      options: {
+        method: 'DELETE',
+        jar,
+        headers: {
+          'X-CSRF-TOKEN': token
+        },
+        resolveWithFullResponse: true
+      }
+    }
+    return http(httpOpt)
+      .then(function (res) {
+        if (res.statusCode === 200) {
+          resolve()
+        } else {
+          reject(new RobloxAPIError(res))
+        }
+      }).catch(error => reject(error))
+  })
+}
+
+exports.func = function (args) {
+  const group = args.group
+  const jar = args.jar
+  return getGeneralToken({ jar })
+    .then(function (xcsrf) {
+      if (args.post) {
+        return deleteWallPost(jar, xcsrf, group, args.post.id)
+      } else {
+        return deleteWallPost(jar, xcsrf, group, args.postId)
+      }
+    })
+}

package/lib/groups/deleteWallPostsByUser.js

@@ -0,0 +1,55 @@
+// Includes
+const http = require('../util/http.js').func
+const getGeneralToken = require('../util/getGeneralToken.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+// Args
+exports.required = ['group', 'userId']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Removes all wall posts sent by the provided user.
+ * @category Group
+ * @alias deleteWallPostsByUser
+ * @param {number} group - The id of the group.
+ * @param {number} userId - The userId of the user having their posts removed.
+ * @returns {Promise<void>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * noblox.deleteWallPostsByUser(1, 2)
+ **/
+
+function deleteWallPostsByUser (group, userId, jar, xcsrf) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: `https://groups.roblox.com/v1/groups/${group}/wall/users/${userId}/posts`,
+      options: {
+        method: 'DELETE',
+        resolveWithFullResponse: true,
+        jar,
+        headers: {
+          'X-CSRF-TOKEN': xcsrf
+        }
+      }
+    }
+
+    return http(httpOpt)
+      .then(function (res) {
+        if (res.statusCode !== 200) {
+          reject(new RobloxAPIError(res))
+        } else {
+          resolve()
+        }
+      }).catch(error => reject(error))
+  })
+}
+
+// Define
+exports.func = function (args) {
+  const jar = args.jar
+  return getGeneralToken({ jar })
+    .then(function (xcsrf) {
+      return deleteWallPostsByUser(args.group, args.userId, args.jar, xcsrf)
+    })
+}

package/lib/groups/demote.js

@@ -0,0 +1,25 @@
+// Includes
+const changeRank = require('./changeRank.js').func
+
+// Args
+exports.required = ['group', 'target']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Demote a user.
+ * @category Group
+ * @alias demote
+ * @param {number} group - The id of the group.
+ * @param {number} target - The userId of the user being demoted.
+ * @returns {Promise<ChangeRankResult>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * noblox.demote(1, 2)
+**/
+
+// Define
+exports.func = function (args) {
+  args.change = -1
+  return changeRank(args)
+}

package/lib/groups/exile.js

@@ -0,0 +1,55 @@
+// Includes
+const http = require('../util/http.js').func
+const getGeneralToken = require('../util/getGeneralToken.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+// Args
+exports.required = ['group', 'target']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Exile a user from a group.
+ * @category Group
+ * @alias exile
+ * @param {number} group - The id of the group.
+ * @param {number} target - The userId of the user being exiled.
+ * @returns {Promise<void>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * noblox.exile(1, 2)
+**/
+
+function exileUser (group, target, jar, xcsrf) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: `https://groups.roblox.com/v1/groups/${group}/users/${target}`,
+      options: {
+        method: 'DELETE',
+        resolveWithFullResponse: true,
+        jar,
+        headers: {
+          'X-CSRF-TOKEN': xcsrf
+        }
+      }
+    }
+
+    return http(httpOpt)
+      .then(function (res) {
+        if (res.statusCode !== 200) {
+          reject(new RobloxAPIError(res))
+        } else {
+          resolve()
+        }
+      }).catch(error => reject(error))
+  })
+}
+
+// Define
+exports.func = function (args) {
+  const jar = args.jar
+  return getGeneralToken({ jar })
+    .then(function (xcsrf) {
+      return exileUser(args.group, args.target, args.jar, xcsrf)
+    })
+}

package/lib/groups/getAuditLog.js

@@ -0,0 +1,64 @@
+// Includes
+const http = require('../util/http.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+exports.required = ['group']
+exports.optional = ['actionType', 'userId', 'sortOrder', 'limit', 'cursor', 'jar']
+
+// Docs
+/**
+ * 🔐 Get the audit log for the group.
+ * @category Group
+ * @alias getAuditLog
+ * @param {number} group - The id of the group.
+ * @param {("DeletePost" | "RemoveMember" | "AcceptJoinRequest" | "DeclineJoinRequest" | "PostStatus" | "ChangeRank" | "BuyAd" | "SendAllyRequest" | "CreateEnemy" | "AcceptAllyRequest" | "DeclineAllyRequest" | "DeleteAlly" | "DeleteEnemy" | "AddGroupPlace" | "RemoveGroupPlace" | "CreateItems" | "ConfigureItems" | "SpendGroupFunds" | "ChangeOwner" | "Delete" | "AdjustCurrencyAmounts" | "Abandon" | "Claim" | "Rename" | "ChangeDescription" | "InviteToClan" | "KickFromClan" | "CancelClanInvite" | "BuyClan" | "CreateGroupAsset" | "UpdateGroupAsset" | "ConfigureGroupAsset" | "RevertGroupAsset" | "CreateGroupDeveloperProduct" | "ConfigureGroupGame" | "Lock" | "Unlock" | "CreateGamePass" | "CreateBadge" | "ConfigureBadge" | "SavePlace" | "PublishPlace")=} actionType - The action type to filter for.
+ * @param {number=} userId - The user's id to filter for.
+ * @param {SortOrder=} sortOrder - The order to sort the logs by.
+ * @param {Limit=} limit - The maximum logs per a page.
+ * @param {string=} cursor - The cursor for the page.
+ * @returns {Promise<AuditPage>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * const rankLogs = await noblox.getAuditLog(1, "ChangeRank", 2, "Asc")
+**/
+
+function getAuditLog (group, actionType, userId, sortOrder, limit, cursor, jar) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: `https://groups.roblox.com/v1/groups/${group}/audit-log?actionType=${actionType}&cursor=${cursor}&limit=${limit}&sortOrder=${sortOrder}&userId=${userId}`,
+      options: {
+        method: 'GET',
+        resolveWithFullResponse: true,
+        jar
+      }
+    }
+
+    return http(httpOpt)
+      .then(function (res) {
+        const responseData = JSON.parse(res.body)
+        if (res.statusCode !== 200) {
+          reject(new RobloxAPIError(res))
+        } else {
+          responseData.data = responseData.data.map((entry) => {
+            // We need to set milliseconds to 0 because Roblox does this fascinating thing
+            // Where they vary the ms value on each request, for an existing action.
+            entry.created = new Date(entry.created)
+            entry.created.setMilliseconds(0)
+            return entry
+          })
+          resolve(responseData)
+        }
+      }).catch(error => reject(error))
+  })
+}
+
+// Define
+exports.func = function (args) {
+  const jar = args.jar
+  const actionType = args.actionType || ''
+  const userId = args.userId || ''
+  const sortOrder = args.sortOrder || 'Asc'
+  const limit = args.limit || (100).toString()
+  const cursor = args.cursor || ''
+  return getAuditLog(args.group, actionType, userId, sortOrder, limit, cursor, jar)
+}

package/lib/groups/getGroup.js

@@ -0,0 +1,50 @@
+// Includes
+const http = require('../util/http.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+// Args
+exports.required = ['groupId']
+exports.optional = []
+
+// Docs
+/**
+ * ✅ Get a group's info.
+ * @category Group
+ * @alias getGroup
+ * @param {number} groupId - The id of the group.
+ * @returns {Promise<Group>}
+ * @example const noblox = require("noblox.js")
+ * const groupInfo = await noblox.getGroup(1)
+**/
+
+// Define
+function getGroup (groupId) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: `//groups.roblox.com/v1/groups/${groupId}`,
+      options: {
+        method: 'GET',
+        resolveWithFullResponse: true
+      }
+    }
+    return http(httpOpt)
+      .then(function (res) {
+        if (res.statusCode === 200) {
+          const body = JSON.parse(res.body)
+
+          if (body.shout) {
+            body.shout.created = new Date(body.shout.created)
+            body.shout.updated = new Date(body.shout.updated)
+          }
+
+          resolve(body)
+        } else {
+          reject(new RobloxAPIError(res))
+        }
+      }).catch(error => reject(error))
+  })
+}
+
+exports.func = function (args) {
+  return getGroup(args.groupId)
+}

package/lib/groups/getGroupBans.js

@@ -0,0 +1,37 @@
+// Includes
+const getPageResults = require('../util/getPageResults.js').func
+
+// Args
+exports.required = ['groupId']
+exports.optional = ['limit', 'sortOrder', 'pageCursor', 'jar']
+
+// Docs
+/**
+ * 🔐 Gets bans of a group
+ * @category Group
+ * @alias getGroupBans
+ * @param {number} groupId - The ID of the group
+ * @param {number=} limit - The number of bans to fetch maximum per page
+ * @param {SortOrder=} sortOrder - The order to sort the bans
+ * @param {string=} pageCursor - The next or previous page's cursor
+ * @returns {Promise<GroupBan[]>}
+ * @example const noblox = require("noblox.js")
+ * await noblox.getGroupBans({ groupId: 1, limit: 100, sortOrder: "Desc" })
+**/
+
+// Define
+exports.func = async function (args) {
+  let { groupId, jar, limit, pageCursor, sortOrder } = args
+  limit ||= 100
+  sortOrder ||= 'Desc'
+
+  return await getPageResults({
+    url: `//groups.roblox.com/v1/groups/${groupId}/bans`,
+    query: {
+      sortOrder
+    },
+    pageCursor,
+    limit,
+    jar
+  })
+}

package/lib/groups/getGroupSocialLinks.js

@@ -0,0 +1,41 @@
+// Includes
+const http = require('../util/http.js').func
+
+const RobloxAPIError = require('../util/apiError.js')
+// Args
+exports.required = ['groupId']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Get the social link data associated with a group.
+ * @category Group
+ * @alias getGroupSocialLinks
+ * @param {number} groupId - The id of the group.
+ * @returns {Promise<SocialLinkResponse[]>}
+ * @example const noblox = require("noblox.js")
+ * const groupSocialLinks = await noblox.getGroupSocialLinks(9997719)
+**/
+
+// Define
+function getGroupSocialLinks (groupId, jar) {
+  return http({
+    url: `//groups.roblox.com/v1/groups/${groupId}/social-links`,
+    options: {
+      jar,
+      resolveWithFullResponse: true
+    }
+  })
+    .then((res) => {
+      const { data } = JSON.parse(res.body)
+      if (res.statusCode === 200 && data) {
+        return data
+      } else {
+        throw new RobloxAPIError(res)
+      }
+    })
+}
+
+exports.func = function ({ groupId, jar }) {
+  return getGroupSocialLinks(groupId, jar)
+}