noblox.ts-fetch 4.6.8

package/settings.json

@@ -0,0 +1,107 @@
+{
+  "session_only": true,
+  "session_only_desc": "Minimizes data usage and speed up requests by only saving session cookies, disable if you need other cookies to be saved as well.",
+
+  "maxThreads": 50,
+  "maxThreads_desc": "This is usually used for functions that have to receive a lot of pages at once. Only this amount will be queued up as to preserve memory, make this as high as possible for fastest responses (although it will be somewhat limited by maxSockets).",
+
+  "timeout": 10000,
+  "timeout_desc": "Timeout for http requests. This is necessary for functions that make a very large number of requests, where it is possible some simply won't connect.",
+
+  "event": {
+    "maxRetries": 5,
+    "maxRetries_desc": "Maximum number of consecutive retries after an event times out or fails in some other way.",
+    "timeout": 10000,
+    "timeout_desc": "Maximum time (in milliseconds) a request can take. If your server has extremely high latency you may have to raise this.",
+    "event_desc": "Below is the poll time (in milliseconds) for each of the event functions. A lower number will detect changes much quicker but will stress the network, a higher one does the opposite.",
+    "defaultDelay": 10000,
+    "onAuditLog": 10000,
+    "onWallPost": 10000,
+    "onJoinRequestHandle": 10000,
+    "onJoinRequest": 10000,
+    "onShout": 10000,
+    "onBlurbChange": 10000,
+    "onGroupTransaction": 60000
+  },
+
+  "thumbnail": {
+    "maxRetries": 2,
+    "maxRetries_desc": "Maximum number of retries to retrieve a pending thumbnail, rare, but occurs with uncached users (Roblox's cache)",
+    "retryDelay": 500,
+    "retryDelay_desc": "The time to wait between consecutive retries of retrieving pending thumbnails",
+    "failedUrl": {
+      "pending": "",
+      "blocked": ""
+    },
+    "failedUrl_desc": "The image URL to provide when an asset thumbnail is still pending or has been moderated by Roblox; defaults to Roblox moderation icon via noblox.js's GitHub repo at https://noblox.js.org/moderatedThumbnails/moderatedThumbnail_{size}.png"
+  },
+
+  "queue": {
+    "Message": {
+      "delay": 0,
+      "desc": "Although messages do have a floodcheck, it is not instituted immediately so this is disabled by default. If you are sending a lot of messages set a delay around 10-15 seconds (10000-15000)"
+    }
+  },
+
+  "cache": {
+    "XCSRF": {
+      "expire": 1800,
+      "refresh": false,
+      "desc": "XCSRF tokens expire 30 minutes after being created. Until they expire, however, no new tokens can be made. Sometimes an XCSRF token has already been created for the user so the server doesn't know when to collect a new one. During transitions some requests may use invalid tokens. For now, new XCSRF tokens are automatically retrieved when cached ones get rejected."
+    },
+
+    "Verify": {
+      "expire": 7200,
+      "refresh": 3600,
+      "desc": "Verification tokens seem to last extremely long times."
+     },
+
+    "Roles": {
+      "expire": 600,
+      "refresh": true,
+      "desc": "This should be fine unless your group changes its ranks often."
+     },
+
+    "RolesetId": {
+      "expire": 86400,
+      "refresh": false,
+      "desc": "Disable this completely if you don't plan on ever changing your exile bot's rank."
+     },
+
+    "Product": {
+      "expire": false,
+      "refresh": false,
+      "desc": "Disabled by default for security (price checks). If you are only working with ROBLOX assets, however, you can set this to something high (since ROBLOX product info rarely changes)."
+     },
+
+    "GamePassProduct": {
+      "expire": 86400,
+      "refresh": false,
+      "desc": "This should normally be fine unless the information of GamePasses you are working with changes frequently."
+    },
+
+    "NameFromID": {
+      "expire": false,
+      "refresh": false,
+      "desc": "Caches a user's username based on their ID. It is not on by default because it is an uncontrollable change but the option is there to cache it if you would like."
+     },
+
+    "IDFromName": {
+      "expire": true,
+      "refresh": false,
+      "desc": "Permanent cache for a user's ID based on their name. There is no reason this would ever change (changing names would re-match it and old names cannot be reused by other accounts). Only disable if you want this to match current names only."
+     },
+
+     "SenderID": {
+       "expire": true,
+       "refresh": false,
+       "desc": "Permanent cache for the sender's user ID. This should literally never change."
+     },
+
+    "Rank": {
+      "expire": false,
+      "refresh": false,
+      "desc": "Caches rank by user ID. Changes cannot be anticipated so this is not enabled by default."
+     }
+  }
+}

package/test/accountinformation.test.js

@@ -0,0 +1,27 @@
+const { getUserSocialLinks, setCookie } = require('../lib')
+
+beforeAll(() => {
+  return new Promise(resolve => {
+    setCookie(process.env.COOKIE).then(() => {
+      resolve()
+    })
+  })
+})
+
+describe('Account Information Methods', () => {
+  it('getUserSocialLinks() returns a player\'s promotion channel links', () => {
+    return getUserSocialLinks(2416399685).then((res) => {
+      return expect(res).toMatchObject({
+        facebook: expect.toBeOneOf([expect.any(String), null]),
+        twitter: expect.toBeOneOf([expect.any(String), null]),
+        youtube: expect.toBeOneOf([expect.any(String), null]),
+        twitch: expect.toBeOneOf([expect.any(String), null]),
+        guilded: expect.toBeOneOf([expect.any(String), null])
+      })
+    })
+  })
+
+  it('getUserSocialLinks() doesn\'t return a player\'s promotion channel links and errors when user is invalid', async () => {
+    return await expect(getUserSocialLinks(-5)).rejects.toThrow()
+  })
+})

package/test/accountsettings.test.js

@@ -0,0 +1,27 @@
+const { block, unblock, setCookie } = require('../lib')
+
+beforeAll(() => {
+  return new Promise(resolve => {
+    setCookie(process.env.COOKIE).then(() => {
+      resolve()
+    })
+  })
+})
+
+describe('Account Settings Methods', () => {
+  it('block() blocks a user on Roblox', async () => {
+    await expect(block(4397833)).resolves.not.toThrow()
+  })
+
+  it('block() errors when you try to block a blocked user on Roblox', async () => {
+    await expect(block(4397833)).rejects.toThrow()
+  })
+
+  it('unblock() unblocks a user on Roblox', async () => {
+    await expect(unblock(4397833)).resolves.not.toThrow()
+  })
+
+  it('block() errors when you try to unblock an unblocked user on Roblox', async () => {
+    await expect(unblock(4397833)).rejects.toThrow()
+  })
+})

package/test/asset.test.js

@@ -0,0 +1,81 @@
+const { buy, deleteFromInventory, getGamePassProductInfo, getProductInfo, uploadAnimation, uploadItem, uploadModel, setCookie, getOwnership, getCurrentUser } = require('../lib')
+const fs = require('fs')
+
+beforeAll(() => {
+  return new Promise(resolve => {
+    setCookie(process.env.COOKIE).then(() => {
+      resolve()
+    })
+  })
+})
+
+describe('Asset Methods', () => {
+  it('deleteFromInventory() successfully deletes an item from user\'s inventory', async () => {
+    await getOwnership(await getCurrentUser('UserId'), 1778181).then((res) => {
+      if (!res) return buy(1778181)
+    })
+    return await expect(deleteFromInventory(1778181)).resolves.not.toThrow()
+  })
+
+  it('deleteFromInventory() errors when it tries to delete an item from user\'s inventory that isn\'t there', async () => {
+    return await expect(deleteFromInventory(1778181)).rejects.toThrow()
+  })
+
+  it('getGamePassProductInfo() successfully returns a gamepass\'s information', () => {
+    return getGamePassProductInfo(2919875).then((res) => {
+      return expect(res).toMatchObject({
+        Name: expect.any(String),
+        Description: expect.any(String),
+        Creator: expect.any(Object),
+        PriceInRobux: expect.toBeOneOf([expect.any(Number), null])
+      })
+    })
+  })
+
+  it('getGamePassProductInfo() errors when returning a product\'s information that does not exist', async () => {
+    return await expect(getGamePassProductInfo(0)).rejects.toThrow()
+  })
+
+  it('getProductInfo() successfully returns a product\'s information', () => {
+    return getProductInfo(1989194006).then((res) => {
+      return expect(res).toMatchObject({
+        AssetId: expect.any(Number),
+        ProductId: expect.any(Number),
+        Name: expect.any(String),
+        Description: expect.any(String),
+        Creator: expect.any(Object),
+        PriceInRobux: expect.toBeOneOf([expect.any(Number), null])
+      })
+    })
+  })
+
+  it('getProductInfo() errors when returning a product\'s information that does not exist', async () => {
+    return await expect(getProductInfo(3)).rejects.toThrow()
+  })
+
+  it('uploadAnimation() uploads an animation', () => {
+    return uploadAnimation(fs.createReadStream('./test/assets/KeyframeSequence.rbxm'), { name: 'noblox', description: 'A noblox test!', copyLocked: true, allowComments: false }).then((res) => {
+      return expect(res).toEqual(expect.any(Number))
+    })
+  })
+
+  it('uploadAnimation() errors when no options are provided', async () => {
+    await expect(uploadAnimation(fs.createReadStream('./test/assets/KeyframeSequence.rbxm'))).rejects.toThrow()
+  })
+
+  it('uploadItem() uploads an image', async () => {
+    await expect(uploadItem('noblox', 13, fs.createReadStream('./img/noblox-js.png'))).resolves.not.toThrow()
+  })
+
+  it('uploadModel() uploads a model', async () => {
+    await expect(uploadModel(fs.createReadStream('./test/assets/Great-White-Shark-Fin.rbxm'), {
+      name: 'Shark Fin',
+      description: 'Uploaded via noblox',
+      copyLocked: true
+    })).resolves.not.toThrow()
+  })
+
+  it('uploadModel() errors when no options are provided', async () => {
+    await expect(uploadModel(fs.createReadStream('./test/assets/Great-White-Shark-Fin.rbxm'))).rejects.toThrow()
+  })
+})

package/test/avatar.test.js

@@ -0,0 +1,164 @@
+const { avatarRules, currentlyWearing, getAvatar, getCurrentAvatar, getRecentItems, outfitDetails, outfits, redrawAvatar, removeAssetId, setAvatarBodyColors, setAvatarScales, setPlayerAvatarType, setWearingAssets, wearAssetId, setCookie } = require('../lib')
+
+beforeAll(() => {
+  return new Promise(resolve => {
+    setCookie(process.env.COOKIE).then(() => {
+      resolve()
+    })
+  })
+})
+
+describe('Avatar Methods', () => {
+  it('avatarRules() returns avatar rules from Roblox', () => {
+    return avatarRules().then((rules) => {
+      expect(rules).toMatchObject({
+        playerAvatarTypes: expect.any(Array),
+        scales: expect.any(Object),
+        wearableAssetTypes: expect.any(Array),
+        bodyColorsPalette: expect.any(Array),
+        basicBodyColorsPalette: expect.any(Array),
+        minimumDeltaEBodyColorDifference: expect.any(Number),
+        proportionsAndBodyTypeEnabledForUser: expect.any(Boolean),
+        defaultClothingAssetLists: expect.any(Object),
+        bundlesEnabledForUser: expect.any(Boolean),
+        emotesEnabledForUser: expect.any(Boolean)
+      })
+    })
+  })
+
+  it('currentlyWearing() returns an array containing which assets are being worn by a user', () => {
+    return currentlyWearing(1).then((res) => {
+      expect(res).toMatchObject({
+        assetIds: expect.any(Array)
+      })
+    })
+  })
+
+  it('getAvatar() returns avatar information on a user', () => {
+    return getAvatar(1).then((res) => {
+      expect(res).toMatchObject({
+        scales: expect.any(Object),
+        playerAvatarType: expect.any(String),
+        bodyColors: expect.any(Object),
+        assets: expect.any(Array),
+        defaultShirtApplied: expect.any(Boolean),
+        defaultPantsApplied: expect.any(Boolean),
+        emotes: expect.any(Array)
+      })
+    })
+  })
+
+  it('getCurrentAvatar() returns avatar information for logged in user', () => {
+    return getCurrentAvatar().then((res) => {
+      expect(res).toMatchObject({
+        scales: expect.any(Object),
+        playerAvatarType: expect.any(String),
+        bodyColors: expect.any(Object),
+        assets: expect.any(Array),
+        defaultShirtApplied: expect.any(Boolean),
+        defaultPantsApplied: expect.any(Boolean),
+        emotes: expect.any(Array)
+      })
+    })
+  })
+
+  it('getRecentItems() returns recently worn items for logged in user', () => {
+    return getRecentItems('Accessories').then((res) => {
+      expect(res).toMatchObject({
+        data: expect.any(Array),
+        total: expect.any(Number)
+      })
+    })
+  })
+
+  it('outfitDetails() returns information on a created outfit (costume)', () => {
+    return outfitDetails(19461896).then((res) => {
+      expect(res).toMatchObject({
+        id: expect.any(Number),
+        name: expect.any(String),
+        assets: expect.any(Array),
+        bodyColors: expect.any(Object),
+        scale: expect.any(Object),
+        playerAvatarType: expect.any(String),
+        isEditable: expect.any(Boolean)
+      })
+    })
+  })
+
+  it('outfits() returns a user\'s oufits', () => {
+    return outfits(1).then((res) => {
+      expect(res).toMatchObject({
+        filteredCount: expect.any(Number),
+        data: expect.any(Array),
+        total: expect.any(Number)
+      })
+    })
+  })
+
+  it('redrawAvatar() redraws logged in user\'s avatar or gets flood checked', () => {
+    return redrawAvatar().catch((err) => {
+      // eslint-disable-next-line jest/no-conditional-expect
+      expect(() => { throw new Error(err) }).toThrow('Redraw avatar floodchecked')
+    })
+  })
+
+  it('removeAssetId() takes off a worn asset on logged in user\'s avatar', async () => {
+    await expect(removeAssetId(1989194006)).resolves.not.toThrow()
+  })
+
+  it('setAvatarBodyColors() sets body colors to selected colors', () => {
+    return setAvatarBodyColors(194, 37, 194, 194, 102, 102).then(() => {
+      return getCurrentAvatar().then((res) => {
+        expect(res.bodyColors).toEqual({
+          headColorId: 194,
+          torsoColorId: 37,
+          rightArmColorId: 194,
+          leftArmColorId: 194,
+          rightLegColorId: 102,
+          leftLegColorId: 102
+        })
+      })
+    })
+  })
+
+  it('setAvatarScales() sets avatar scales', () => {
+    return setAvatarScales(1, 1, 1, 1, 0, 0).then(() => {
+      return getCurrentAvatar().then((res) => {
+        expect(res.scales).toEqual({
+          height: 1,
+          width: 1,
+          head: 1,
+          depth: 1,
+          proportion: 0,
+          bodyType: 0
+        })
+      })
+    })
+  })
+
+  it('setPlayerAvatarType() sets avatar body type', () => {
+    return setPlayerAvatarType('R6').then(() => {
+      return getCurrentAvatar().then((res) => {
+        expect(res.playerAvatarType).toBe('R6')
+      })
+    })
+  })
+
+  it('setWearingAssets() sets the player worn asset ID list to whatever is provided', async () => {
+    await expect(setWearingAssets([63690008,
+      86498048,
+      86500008,
+      86500036,
+      86500054,
+      86500064,
+      86500078,
+      144075659,
+      144076358,
+      144076760
+    ])).resolves.not.toThrow()
+  })
+
+  it('wearAssetId() wears the asset ID provided on the currently logged in user\'s avatar', async () => {
+    await expect(wearAssetId(1989194006)).resolves.not.toThrow()
+  })
+})

package/test/badges.test.js

@@ -0,0 +1,96 @@
+const { getAwardedTimestamps, getBadgeInfo, getGameBadges, getPlayerBadges, setCookie } = require('../lib')
+
+beforeAll(() => {
+  return new Promise(resolve => {
+    setCookie(process.env.COOKIE).then(() => {
+      resolve()
+    })
+  })
+})
+
+describe('Badges Methods', () => {
+  it('getAwardedTimestamps() returns when badges were awarded to a player', () => {
+    return getAwardedTimestamps(64679301, [459405541]).then((res) => {
+      return expect(res).toMatchObject({
+        data: expect.any(Array)
+      })
+    })
+  })
+
+  it('getBadgeInfo() returns information on the provided badge ID', () => {
+    return getBadgeInfo(459405541).then((res) => {
+      return expect(res).toMatchObject({
+        id: expect.any(Number),
+        name: expect.any(String),
+        description: expect.any(String),
+        enabled: expect.any(Boolean),
+        iconImageId: expect.any(Number),
+        created: expect.any(Date),
+        updated: expect.any(Date),
+        statistics: expect.any(Object),
+        awardingUniverse: expect.any(Object)
+      })
+    })
+  })
+
+  it('getGameBadges() returns information on the badges in a game', () => {
+    return getGameBadges(66654135).then((res) => {
+      return expect(res).toEqual(
+        expect.arrayContaining([
+          expect.objectContaining({
+            id: expect.any(Number),
+            name: expect.any(String),
+            description: expect.any(String),
+            displayName: expect.any(String),
+            displayDescription: expect.any(String),
+            enabled: expect.any(Boolean),
+            iconImageId: expect.any(Number),
+            displayIconImageId: expect.any(Number),
+            created: expect.any(Date),
+            updated: expect.any(Date),
+            statistics: expect.objectContaining({
+              pastDayAwardedCount: expect.any(Number),
+              awardedCount: expect.any(Number),
+              winRatePercentage: expect.any(Number)
+            }),
+            awardingUniverse: expect.objectContaining({
+              id: expect.any(Number),
+              name: expect.any(String),
+              rootPlaceId: expect.any(Number)
+            })
+          })
+        ])
+      )
+    })
+  })
+
+  it('getPlayerBadges() returns information on badges a player has earned', () => {
+    return getPlayerBadges(55549140, 10).then((res) => {
+      return expect(res).toEqual(
+        expect.arrayContaining([
+          expect.objectContaining({
+            id: expect.any(Number),
+            name: expect.any(String),
+            description: expect.any(String),
+            displayName: expect.any(String),
+            displayDescription: expect.any(String),
+            enabled: expect.any(Boolean),
+            iconImageId: expect.any(Number),
+            displayIconImageId: expect.any(Number),
+            awarder: expect.objectContaining({
+              id: expect.any(Number),
+              type: expect.any(String)
+            }),
+            statistics: expect.objectContaining({
+              pastDayAwardedCount: expect.any(Number),
+              awardedCount: expect.any(Number),
+              winRatePercentage: expect.any(Number)
+            }),
+            created: expect.any(Date),
+            updated: expect.any(Date)
+          })
+        ])
+      )
+    })
+  })
+})

package/test/chat.test.js

@@ -0,0 +1,104 @@
+const { addUsersToConversation, chatSettings, getChatMessages, getConversations, getRolloutSettings, getUnreadConversationCount, getUnreadMessages, getUserConversations, markChatAsRead, markChatAsSeen, multiGetLatestMessages, removeFromGroupConversation, renameGroupConversation, sendChatMessage, setChatUserTyping, start121Conversation, startGroupConversation, setCookie } = require('../lib')
+
+beforeAll(() => {
+  return new Promise(resolve => {
+    setCookie(process.env.COOKIE).then(() => {
+      resolve()
+    })
+  })
+})
+
+describe('Chat Methods', () => {
+  let newConversationId
+
+  it('addUsersToConversation() adds additional user(s) to form a group chat', () => {
+    return addUsersToConversation(8212952828, [3187412077]).then((res) => {
+      if (res && res.conversationId) newConversationId = res.conversationId
+
+      expect(res).toEqual(
+        expect.objectContaining({
+          conversationId: expect.any(Number)
+        })
+      )
+    })
+  })
+
+  it('chatSettings() returns chat settings', () => {
+    return chatSettings().then((res) => {
+      expect(res).toMatchObject({
+        chatEnabled: expect.any(Boolean),
+        isActiveChatUser: expect.any(Boolean)
+      })
+    })
+  })
+
+  it('getChatMessages() returns chat messages', async () => {
+    await expect(getChatMessages(8212952828)).resolves.not.toThrow()
+  })
+
+  it('getConversations() returns chat conversations that fit the provided IDs', async () => {
+    await expect(getConversations([8212952828])).resolves.not.toThrow()
+  })
+
+  it('getRolloutSettings() returns rollout settings for chat features', async () => {
+    await expect(getRolloutSettings(['LuaChat', 'Party'])).resolves.not.toThrow()
+  })
+
+  it('getUnreadConversationCount() returns number of unread conversations', () => {
+    return getUnreadConversationCount().then((res) => {
+      expect(res).toMatchObject({
+        count: expect.any(Number)
+      })
+    })
+  })
+
+  it('getUnreadMessages() returns unread messages in a given conversation', async () => {
+    await expect(getUnreadMessages([8212952828])).resolves.not.toThrow()
+  })
+
+  it('getUserConversations() returns all conversations the logged in user is in', async () => {
+    await expect(getUserConversations()).resolves.not.toThrow()
+  })
+
+  it('markChatAsRead() marks a conversation\'s messages as read to the specified message', async () => {
+    await expect(markChatAsRead(8212952828, 'e775e103-876f-4332-84ab-1ea14f326d39')).resolves.not.toThrow()
+  })
+
+  it('markChatAsSeen() marks the conversations provided as seen', async () => {
+    await expect(markChatAsSeen([8212952828])).resolves.not.toThrow()
+  })
+
+  it('multiGetLatestMessages() returns the latest messages corresponding to the given list of conversation IDs', async () => {
+    await expect(multiGetLatestMessages([8212952828])).resolves.not.toThrow()
+  })
+
+  it('removeFromGroupConversation() removes a user from a given conversation', async () => {
+    await expect(removeFromGroupConversation(newConversationId, 3187412077)).resolves.not.toThrow()
+  })
+
+  it('renameGroupConversation() renames a group conversation', async () => {
+    await expect(renameGroupConversation(newConversationId, 'noblox testing')).resolves.not.toThrow()
+  })
+
+  it('sendChatMessage() sends a chat message with provided content', async () => {
+    await expect(sendChatMessage(newConversationId, 'This is a test.')).resolves.not.toThrow()
+  })
+
+  it('setChatUserTyping() toggles typing status', async () => {
+    return setChatUserTyping(newConversationId, false).then((res) => {
+      expect(res).toMatchObject({ resultType: 'Success' })
+    })
+  })
+
+  it('start121Conversation() starts a conversation with another user', async () => {
+    await expect(start121Conversation(3187412077)).resolves.not.toThrow()
+  })
+
+  // TODO: startCloudEditConversation
+
+  it('startGroupConversation() opens a conversation with multiple people in it', () => {
+    return startGroupConversation([55549140, 3187412077], 'noblox test 2').then((res) => {
+      expect(res).toMatchObject({ resultType: 'Success' })
+    })
+  })
+})