noblox.ts 4.10.5

package/lib/asset/deleteFromInventory.js

@@ -0,0 +1,69 @@
+// Includes
+const http = require('../util/http.js').func
+const getGeneralToken = require('../util/getGeneralToken.js').func
+
+// Args
+exports.required = ['assetId']
+exports.optional = ['jar']
+
+// Docs
+/**
+ * 🔐 Removes an asset from the authenticated user's inventory; throws an error if the item is not owned.
+ * @category Asset
+ * @alias deleteFromInventory
+ * @param {number} assetId - The id of the asset.
+ * @returns {Promise<void>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * await noblox.deleteFromInventory(144075659)
+**/
+
+// Define
+function deleteFromInventory (jar, assetId, xcsrf) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: 'https://www.roblox.com/asset/delete-from-inventory',
+      options: {
+        method: 'POST',
+        resolveWithFullResponse: true,
+        body: `assetId=${assetId}`,
+        jar: jar,
+        headers: {
+          'X-CSRF-TOKEN': xcsrf,
+          'content-type': 'application/x-www-form-urlencoded; charset=UTF-8'
+        }
+      }
+    }
+
+    return http(httpOpt)
+      .then(function (res) {
+        const responseData = typeof res.body === 'string' ? JSON.parse(res.body) : res.body
+        // Roblox likes to error here with 200 status codes too with inconsistency
+        if (res.statusCode === 200) {
+          let error = 'An unknown error has occurred.'
+          if (responseData && !responseData.isValid) {
+            error = responseData.error
+            reject(new Error(error))
+          } else if (responseData && responseData.isValid) {
+            resolve()
+          }
+        } else {
+          let error = 'An unknown error has occurred.'
+          if (responseData && responseData.errors) {
+            error = responseData.errors.map((e) => e.message).join('\n')
+          }
+          reject(new Error(error))
+        }
+      })
+      .catch(error => reject(error))
+  })
+}
+
+// Define
+exports.func = function (args) {
+  const jar = args.jar
+  return getGeneralToken({ jar: jar })
+    .then(function (xcsrf) {
+      return deleteFromInventory(jar, args.assetId, xcsrf)
+    })
+}

package/lib/asset/getGamePassProductInfo.js

@@ -0,0 +1,51 @@
+// Includes
+const http = require('../util/http.js').func
+const cache = require('../cache')
+
+// Args
+exports.required = ['gamepass']
+
+// Docs
+/**
+ * ✅ Get the info of an gamepass.
+ * @category Asset
+ * @param {number} gamePassId - The id of the asset.
+ * @returns {Promise<GamePassProductInfo>}
+ * @example const noblox = require("noblox.js")
+ * const gamePassInfo = await noblox.getGamePassProductInfo(2919875)
+**/
+
+// Define
+function getGamePassProductInfo (gamepass) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: `//apis.roblox.com/game-passes/v1/game-passes/${gamepass}/product-info`,
+      options: {
+        resolveWithFullResponse: true,
+        method: 'GET'
+      }
+    }
+
+    return http(httpOpt)
+      .then(function (res) {
+        const data = JSON.parse(res.body)
+
+        if (res.statusCode === 200) {
+          resolve(data)
+        } else {
+          const errors = data.errors.map((e) => e.message)
+
+          reject(new Error(`${res.statusCode} ${errors.join(', ')}`))
+        }
+      })
+      .catch(error => reject(error))
+  })
+}
+
+exports.func = function (args) {
+  const gamepass = args.gamepass
+
+  return cache.wrap('GamePassProduct', gamepass, function () {
+    return getGamePassProductInfo(gamepass)
+  })
+}

package/lib/asset/getProductInfo.js

@@ -0,0 +1,56 @@
+// Includes
+const http = require('../util/http.js').func
+const cache = require('../cache')
+
+// Args
+exports.required = ['asset']
+
+// Docs
+/**
+ * ✅ Get the info of an asset.
+ * @category Asset
+ * @param {number} assetId - The id of the asset.
+ * @returns {Promise<ProductInfo>}
+ * @example const noblox = require("noblox.js")
+ * const productInfo = await noblox.getProductInfo(1117747196)
+**/
+
+// Define
+function getProductInfo (asset) {
+  return new Promise((resolve, reject) => {
+    const httpOpt = {
+      url: `//economy.roblox.com/v2/assets/${asset}/details`,
+      options: {
+        resolveWithFullResponse: true,
+        method: 'GET'
+      }
+    }
+    return http(httpOpt)
+      .then(function (res) {
+        if (res.statusCode === 200) {
+          resolve(JSON.parse(res.body))
+        } else {
+          // Sourced from: https://stackoverflow.com/a/32278428
+          const isAnObject = (val) => !!(val instanceof Array || val instanceof Object)
+
+          const body = isAnObject(res.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(', ')}`))
+          } else {
+            reject(new Error(`${res.statusCode} ${res.body}`))
+          }
+        }
+      })
+      .catch(error => reject(error))
+  })
+}
+
+exports.func = function (args) {
+  const asset = args.asset
+  return cache.wrap('Product', asset, function () {
+    return getProductInfo(asset)
+  })
+}

package/lib/asset/uploadAnimation.js

@@ -0,0 +1,103 @@
+// Includes
+const http = require('../util/http.js').func
+const getGeneralToken = require('../util/getGeneralToken').func
+const configureItem = require('../develop/configureItem.js').func
+
+// Args
+exports.required = ['data']
+exports.optional = ['itemOptions', 'assetId', 'jar']
+
+// Docs
+/**
+ * 🔐 Upload an animation, either as a new asset or by overwriting an existing animation.
+ * @category Asset
+ * @alias uploadAnimation
+ * @param {string | Stream} data - The rbxm file containing the KeyframeSequence.
+ * @param {object=} itemOptions - The options for the upload. Only optional if assetId is not provided.
+ * @param {string=} itemOptions.name - The name of the animation.
+ * @param {string=} itemOptions.description - The description for the animation.
+ * @param {boolean=} itemOptions.copyLocked - If the animation is copy-locked.
+ * @param {boolean=} itemOptions.allowComments - If comments are allowed.
+ * @param {number=} itemOptions.groupId - The group to upload the animation to. This is ignored if the assetId is provided.
+ * @param {number=} assetId - An existing assetId to overwrite.
+ * @returns {Promise<number>}
+ * @example const noblox = require("noblox.js")
+ * const fs = require("fs")
+ * // Login using your cookie
+ * const assetId = await noblox.uploadAnimation(fs.readFileSync("./KeyframeSequence.rbxm"), {
+ *  name: "A cool animation",
+ *  description: "This is a very cool animation",
+ *  copyLocked: false, //The asset is allowed to be copied.
+ *  allowComments: false
+ * }, 7132858975)
+**/
+
+// Define
+function upload (data, itemOptions, assetId, jar, token) {
+  const httpOpt = {
+    url: assetId ? `//www.roblox.com/ide/publish/uploadexistinganimation?assetID=${assetId}&isGamesAsset=False` : '//www.roblox.com/ide/publish/uploadnewanimation?AllID=1',
+    options: {
+      resolveWithFullResponse: true,
+      method: 'POST',
+      jar: jar,
+      body: data,
+      headers: {
+        'X-CSRF-TOKEN': token,
+        'Content-Type': 'application/xml',
+        'User-Agent': 'RobloxStudio/WinInet RobloxApp/0.483.1.425021 (GlobalDist; RobloxDirectDownload)'
+      }
+    }
+  }
+
+  if (!assetId && itemOptions) {
+    const copyLocked = itemOptions.copyLocked
+    const allowComments = itemOptions.allowComments
+    httpOpt.url += '&assetTypeName=Animation&genreTypeId=1&name=' +
+      itemOptions.name +
+      '&description=' +
+      (itemOptions.description || '') +
+      '&ispublic=' +
+      (copyLocked != null ? !copyLocked : false) +
+      '&allowComments=' +
+      (allowComments != null ? allowComments : true) +
+      '&groupId=' +
+      (itemOptions.groupId || '')
+  } else if (!assetId) {
+    throw new Error('ItemOptions is required for new assets.')
+  }
+
+  return http(httpOpt)
+    .then(function (res) {
+      if (res.statusCode === 200) {
+        const resultId = assetId || Number(res.body)
+
+        if (assetId && itemOptions) {
+          const copyLocked = itemOptions.copyLocked
+          const allowComments = itemOptions.allowComments
+
+          return configureItem({
+            id: resultId,
+            name: itemOptions.name,
+            description: itemOptions.description,
+            enableComments: (allowComments != null ? allowComments : true),
+            sellForRobux: (copyLocked != null ? !copyLocked : false)
+          }).then(function () {
+            return resultId
+          })
+        } else {
+          return resultId
+        }
+      } else {
+        throw new Error('Animation upload failed, confirm that all item options, asset options, and upload data are valid.')
+      }
+    })
+}
+
+exports.func = function (args) {
+  const jar = args.jar
+  return getGeneralToken({
+    jar
+  }).then(function (token) {
+    return upload(args.data, args.itemOptions, args.assetId, args.jar, token)
+  })
+}

package/lib/asset/uploadItem.js

@@ -0,0 +1,83 @@
+// Includes
+const http = require('../util/http.js').func
+const getVerification = require('../util/getVerification.js').func
+
+// Args
+exports.required = ['name', 'assetType', 'file']
+exports.optional = ['groupId', 'jar']
+
+// Docs
+/**
+ * 🔐 Upload an item.
+ * @category Asset
+ * @alias uploadItem
+ * @param {string} name - The name of the asset.
+ * @param {number} assetType - The [id for the asset type]{@link https://developer.roblox.com/en-us/api-reference/enum/AssetType}.
+ * @param {ReadStream} file - The read stream for the asset being uploaded.
+ * @param {number=} groupId - The group to upload the asset to.
+ * @returns {Promise<UploadItemResponse>}
+ * @example const noblox = require("noblox.js")
+ * const fs = require("fs")
+ * // Login using your cookie
+ * await noblox.uploadItem("A cool decal.", 13, fs.createReadStream("./Image.png"))
+**/
+
+// Define
+function uploadItem (jar, file, name, assetType, groupId) {
+  return new Promise((resolve, reject) => {
+    return getVerification({
+      url: 'https://www.roblox.com/build/upload',
+      options: {
+        jar: jar
+      }
+    }).then(function (ver) {
+      const data = {
+        name: name,
+        assetTypeId: assetType,
+        groupId: groupId || '',
+        __RequestVerificationToken: ver.inputs.__RequestVerificationToken,
+        file: {
+          value: file,
+          options: {
+            filename: 'Image.png',
+            contentType: 'image/png'
+          }
+        }
+      }
+      return http({
+        url: '//www.roblox.com/build/upload',
+        options: {
+          method: 'POST',
+          verification: ver.header,
+          formData: data,
+          resolveWithFullResponse: true,
+          jar: jar
+        }
+      }).then(function (res) {
+        if (res.statusCode === 302) {
+          const location = res.headers.location
+          const errMsg = location.match('uploadedId=(.*)$')
+          const match = location.match(/\d+$/)
+          if (match) {
+            const id = parseInt(match[0], 10)
+            if (location.indexOf('/build/upload') === -1) {
+              reject(new Error('Unknown redirect: ' + location))
+            }
+            resolve(id)
+          } else if (errMsg) {
+            reject(new Error('Upload error: ' + decodeURI(errMsg[1])))
+          } else {
+            reject(new Error('Match error. Original: ' + location))
+          }
+        } else {
+          reject(new Error('Unknown upload error'))
+        }
+      })
+    })
+      .catch(error => reject(error))
+  })
+}
+
+exports.func = function (args) {
+  return uploadItem(args.jar, args.file, args.name, args.assetType, args.groupId)
+}

package/lib/asset/uploadModel.js

@@ -0,0 +1,90 @@
+// Includes
+const http = require('../util/http.js').func
+const getGeneralToken = require('../util/getGeneralToken').func
+
+// Args
+exports.required = ['data']
+exports.optional = ['itemOptions', 'assetId', 'jar']
+
+// Docs
+/**
+ * 🔐 Upload a model.
+ * @category Asset
+ * @alias uploadModel
+ * @param {string | Stream} data - The model data.
+ * @param {object=} itemOptions - The options for the upload.
+ * @param {string=} itemOptions.name - The name of the model.
+ * @param {string=} itemOptions.description - The description for the model.
+ * @param {boolean=} itemOptions.copyLocked - If the model is copy-locked.
+ * @param {boolean=} itemOptions.allowComments - If comments are allowed.
+ * @param {number=} itemOptions.groupId - The group to upload the model to.
+ * @param {number=} assetId - An existing assetId to overwrite.
+ * @returns {Promise<UploadModelResponse>}
+ * @example const noblox = require("noblox.js")
+ * const fs = require("fs")
+ * // Login using your cookie
+ * noblox.uploadModel(fs.readFileSync("./model.rbxm"), {
+ *  name: "A cool model",
+ *  description: "This is a very cool model",
+ *  copyLocked: false, //The asset is allowed to be copied.
+ *  allowComments: false,
+ *  groupId: 1
+ * }, 1117747196)
+**/
+
+// Define
+function upload (data, itemOptions, assetId, jar, token) {
+  const httpOpt = {
+    url: '//data.roblox.com/Data/Upload.ashx?json=1&assetid=' + (assetId || 0),
+    options: {
+      resolveWithFullResponse: true,
+      method: 'POST',
+      jar: jar,
+      body: data,
+      headers: {
+        'X-CSRF-TOKEN': token,
+        'Content-Type': 'application/xml'
+      }
+    }
+  }
+  if (itemOptions) {
+    const copyLocked = itemOptions.copyLocked
+    const allowComments = itemOptions.allowComments
+    httpOpt.url += '&type=Model&genreTypeId=1&name=' +
+      itemOptions.name +
+      '&description=' +
+      (itemOptions.description || '') +
+      '&ispublic=' +
+      (copyLocked != null ? !copyLocked : false) +
+      '&allowComments=' +
+      (allowComments != null ? allowComments : true) +
+      '&groupId=' +
+      (itemOptions.groupId || '')
+  } else if (!assetId) {
+    throw new Error('ItemOptions is required for new assets.')
+  }
+  return http(httpOpt)
+    .then(function (res) {
+      if (res.statusCode === 200) {
+        const body = res.body
+        let parsed
+        try {
+          parsed = JSON.parse(body)
+        } catch (e) {
+          throw new Error('Could not parse JSON, returned body:' + body)
+        }
+        return parsed
+      } else {
+        throw new Error('Upload failed, confirm that all item options, asset options, and upload data are valid.')
+      }
+    })
+}
+
+exports.func = function (args) {
+  const jar = args.jar
+  return getGeneralToken({
+    jar
+  }).then(function (token) {
+    return upload(args.data, args.itemOptions, args.assetId, args.jar, token)
+  })
+}

package/lib/avatar/avatarRules.js

@@ -0,0 +1,38 @@
+const http = require('../util/http.js').func
+
+exports.optional = ['option', 'jar']
+
+// Docs
+/**
+ * ✅ Get the avatar rules.
+ * @category Avatar
+ * @alias avatarRules
+ * @param {string=} option - A specific rule to filter for.
+ * @returns {Promise<AvatarRules>}
+ * @example const noblox = require("noblox.js")
+ * const avatarRules = await noblox.avatarRules()
+**/
+
+exports.func = (args) => {
+  const jar = args.jar
+  const option = args.option
+
+  return http({
+    url: '//avatar.roblox.com/v1/avatar-rules',
+    options: {
+      method: 'GET',
+      jar: jar,
+      followRedirect: false,
+      resolveWithFullResponse: true
+    }
+  }).then((res) => {
+    if (res.statusCode === 200) {
+      const json = JSON.parse(res.body)
+      const result = (option ? json[option] : json)
+
+      return result
+    } else {
+      throw new Error('Error fetching avatar rules')
+    }
+  })
+}

package/lib/avatar/currentlyWearing.js

@@ -0,0 +1,32 @@
+const http = require('../util/http.js').func
+
+exports.required = ['userId']
+
+// Docs
+/**
+ * ✅ Get the assets a given user is wearing.
+ * @category Avatar
+ * @alias currentlyWearing
+ * @param {number} userId - The user's userId.
+ * @returns {Promise<AssetIdList>}
+ * @example const noblox = require("noblox.js")
+ * const wearingAssets = await noblox.currentlyWearing(1)
+**/
+
+exports.func = (args) => {
+  const userId = args.userId
+
+  return http({
+    url: '//avatar.roblox.com/v1/users/' + userId + '/currently-wearing',
+    options: {
+      method: 'GET',
+      resolveWithFullResponse: true
+    }
+  }).then((res) => {
+    if (res.statusCode === 200) {
+      return JSON.parse(res.body)
+    } else {
+      throw new Error('User does not exist')
+    }
+  })
+}

package/lib/avatar/getAvatar.js

@@ -0,0 +1,35 @@
+const http = require('../util/http.js').func
+
+exports.required = ['userId']
+
+// Docs
+/**
+ * ✅ Get a user's avatar.
+ * @category Avatar
+ * @alias getAvatar
+ * @param {number} userId - The user's userId.
+ * @returns {Promise<AvatarInfo>}
+ * @example const noblox = require("noblox.js")
+ * const avatar = await noblox.getAvatar(1)
+**/
+
+const getAvatar = (userId) => {
+  return http({
+    url: '//avatar.roblox.com/v1/users/' + userId + '/avatar',
+    options: {
+      method: 'GET',
+      resolveWithFullResponse: true
+    }
+  }).then((res) => {
+    if (res.statusCode === 200) {
+      return JSON.parse(res.body)
+    } else {
+      throw new Error('User does not exist')
+    }
+  })
+}
+
+exports.func = (args) => {
+  const userId = args.userId
+  return getAvatar(userId)
+}

package/lib/avatar/getCurrentAvatar.js

@@ -0,0 +1,37 @@
+const http = require('../util/http.js').func
+
+exports.optional = ['option', 'jar']
+
+// Docs
+/**
+ * 🔐 Gets your current avatar.
+ * @category Avatar
+ * @alias getCurrentAvatar
+ * @param {number=} option - The name of a parameter on the avatar.
+ * @returns {Promise<AvatarInfo>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * const avatar = await noblox.getCurrentAvatar()
+*/
+
+exports.func = (args) => {
+  const jar = args.jar
+  const option = args.option
+
+  return http({
+    url: '//avatar.roblox.com/v1/avatar',
+    options: {
+      method: 'GET',
+      jar: jar,
+      followRedirect: false,
+      resolveWithFullResponse: true
+    }
+  }).then((res) => {
+    if (res.statusCode !== 200) {
+      throw new Error('You are not logged in')
+    } else {
+      const json = JSON.parse(res.body)
+      return (option ? json[option] : json)
+    }
+  })
+}

package/lib/avatar/getRecentItems.js

@@ -0,0 +1,37 @@
+const http = require('../util/http.js').func
+
+exports.optional = ['listType', 'jar']
+
+// Docs
+/**
+ * 🔐 Get assets you've recently worn.
+ * @category Avatar
+ * @alias getRecentItems
+ * @param {number=} listType - A type of item. Ex: Shirt, All
+ * @returns {Promise<AssetRecentItemsResult>}
+ * @example const noblox = require("noblox.js")
+ * // Login using your cookie
+ * const recentlyWorn = await noblox.getRecentItems("All")
+**/
+
+exports.func = (args) => {
+  const jar = args.jar
+  const listType = typeof (args.listType) === 'string' ? args.listType : 'All'
+
+  return http({
+    url: '//avatar.roblox.com/v1/recent-items/' + listType + '/list',
+    options: {
+      method: 'GET',
+      jar: jar,
+      resolveWithFullResponse: true
+    }
+  }).then((res) => {
+    if (res.statusCode === 401) {
+      throw new Error('You are not logged in')
+    } else if (res.statusCode === 400) {
+      throw new Error('Invalid list type')
+    } else {
+      return JSON.parse(res.body)
+    }
+  })
+}

package/lib/avatar/outfitDetails.js

@@ -0,0 +1,32 @@
+const http = require('../util/http.js').func
+
+exports.required = ['outfitId']
+
+// Docs
+/**
+ * ✅ Get the details of an outfit.
+ * @category Avatar
+ * @alias outfitDetails
+ * @param {number} outfitId - The id of the outfit.
+ * @returns {Promise<AvatarOutfitDetails>}
+ * @example const noblox = require("noblox.js")
+ * const outfit = await noblox.outfitDetails(111)
+**/
+
+exports.func = (args) => {
+  const outfitId = args.outfitId
+
+  return http({
+    url: '//avatar.roblox.com/v1/outfits/' + outfitId + '/details',
+    options: {
+      method: 'GET',
+      resolveWithFullResponse: true
+    }
+  }).then((res) => {
+    if (res.statusCode === 200) {
+      return JSON.parse(res.body)
+    } else {
+      throw new Error('Outfit does not exist')
+    }
+  })
+}