noblox.js-proxy-agent 4.10.5

package/test/games.test.js

@@ -0,0 +1,212 @@
+const { addDeveloperProduct, checkDeveloperProductName, getGroupGames, configureGamePass, getGameInstances, getGamePasses, getGameSocialLinks, getUniverseInfo, setCookie } = require('../lib')
+
+beforeAll(() => {
+  return new Promise(resolve => {
+    setCookie(process.env.COOKIE).then(() => {
+      resolve()
+    })
+  })
+})
+
+describe('Game Methods', () => {
+  // let newProductId
+
+  it('addDeveloperProduct() adds a developer product to a universe', () => {
+    return addDeveloperProduct(79354837, `${parseInt(Date.now().toString().slice(-6))} Coins`, 5, 'A hefty sum of cash for you and a successful test for me.').then((res) => {
+      // newProductId = res.productId
+
+      return expect(res).toMatchObject({
+        universeId: 79354837,
+        name: expect.any(String), // account for Roblox filters
+        priceInRobux: 5,
+        description: expect.any(String), // account for Roblox filters
+        productId: expect.any(Number)
+      })
+    })
+  })
+
+  it('checkDeveloperProductName() should return if a developer product name is in use within a universe', () => {
+    return checkDeveloperProductName(79354837, '100 Koins').then((res) => {
+      return expect(res).toMatchObject({
+        Success: expect.any(Boolean),
+        Message: expect.any(String)
+      })
+    })
+  })
+
+  it('configureGamePass() should configure a game pass', () => {
+    const randomString = Date.now().toString().substr(-2)
+    return configureGamePass(13925030, `name${randomString}`, 'random description', parseInt(randomString)).then((res) => {
+      return expect(res).toMatchObject({
+        gamePassId: 13925030,
+        name: `name${randomString}`,
+        description: 'random description',
+        price: parseInt(randomString),
+        isForSale: true,
+        iconChanged: false
+      })
+    })
+  })
+
+  // Broken as of v4.14.0
+  // eslint-disable-next-line jest/no-commented-out-tests
+  // it('getDeveloperProducts() should return developer products, given placeId', () => {
+  //   return getDeveloperProducts(166178819).then((res) => {
+  //     return expect(res).toMatchObject({
+  //       DeveloperProducts: expect.any(Array),
+  //       FinalPage: expect.any(Boolean),
+  //       PageSize: expect.any(Number)
+  //     })
+  //   })
+  // })
+
+  it('getGameInstances() should return instances of a game, given placeId', () => {
+    return getGameInstances(142823291, 'Public', 'Asc', 100).then((res) => {
+      return expect(res).toEqual(
+        expect.arrayContaining([
+          expect.objectContaining({
+            id: expect.any(String),
+            maxPlayers: expect.any(Number),
+            playing: expect.any(Number),
+            playerTokens: expect.arrayContaining([
+              expect.any(String)
+            ]),
+            fps: expect.any(Number),
+            ping: expect.any(Number)
+          })
+        ])
+      )
+    })
+  })
+
+  it('getGamePasses() should return an array of game passes, given universeId', () => {
+    return getGamePasses(2615802125).then((res) => {
+      return expect(res).toEqual(
+        expect.arrayContaining([
+          expect.objectContaining({
+            id: expect.any(Number),
+            name: expect.any(String),
+            displayName: expect.any(String),
+            productId: expect.any(Number),
+            price: expect.any(Number)
+          })
+        ])
+      )
+    })
+  })
+
+  it('getGameSocialLinks() should return social link information of a game, given universeId', () => {
+    return getGameSocialLinks(2615802125).then((res) => {
+      return expect(res).toEqual(
+        expect.arrayContaining([
+          expect.objectContaining({
+            id: expect.any(Number),
+            title: expect.any(String),
+            type: expect.any(String),
+            url: expect.any(String)
+          })
+        ])
+      )
+    })
+  })
+
+  it('getGroupGames() returns an array of group games', () => {
+    return getGroupGames({ groupId: 9997719, limit: 1 }).then((res) => {
+      return expect(res[0]).toMatchObject({
+        id: expect.any(Number),
+        name: expect.any(String),
+        description: expect.toBeOneOf([expect.any(String), null]),
+        creator: {
+          id: expect.any(Number),
+          type: expect.any(String)
+        },
+        rootPlace: {
+          id: expect.any(Number),
+          type: expect.any(String)
+        },
+        created: expect.any(Date),
+        updated: expect.any(Date),
+        placeVisits: expect.any(Number)
+      })
+    })
+  })
+
+  it('getUniverseInfo() should return information about universes', () => {
+    return getUniverseInfo(2152417643).then((res) => {
+      return expect(res).toEqual(
+        expect.arrayContaining([
+          expect.objectContaining({
+            id: expect.any(Number),
+            rootPlaceId: expect.any(Number),
+            name: expect.any(String),
+            description: expect.any(String),
+            creator: expect.objectContaining({
+              id: expect.any(Number),
+              name: expect.any(String),
+              type: expect.any(String),
+              isRNVAccount: expect.any(Boolean)
+            }),
+            allowedGearGenres: expect.any(Array),
+            allowedGearCategories: expect.any(Array),
+            isGenreEnforced: expect.any(Boolean),
+            copyingAllowed: expect.any(Boolean),
+            playing: expect.any(Number),
+            visits: expect.any(Number),
+            maxPlayers: expect.any(Number),
+            created: expect.any(Date),
+            updated: expect.any(Date),
+            studioAccessToApisAllowed: expect.any(Boolean),
+            createVipServersAllowed: expect.any(Boolean),
+            universeAvatarType: expect.any(String),
+            genre: expect.any(String),
+            isAllGenre: expect.any(Boolean),
+            isFavoritedByUser: expect.any(Boolean),
+            favoritedCount: expect.any(Number)
+          })
+        ])
+      )
+    })
+  })
+  
+it('getPlaceInfo() should return an array of information about places', () => {
+    return getPlaceInfo(10905034443).then((res) => {
+      return expect(res).toEqual(
+        expect.arrayContaining([
+          expect.objectContaining({
+            placeId: expect.any(Number),
+            name: expect.any(String),
+            sourceName: expect.any(String),
+            sourceDescription: expect.any(String),
+            url: expect.any(String),
+            builder: expect.any(String),
+            builderId: expect.any(Number),
+            hasVerifiedBadge: expect.any(Boolean),
+            isPlayable: expect.any(Boolean),
+            reasonProhibited: expect.any(String),
+            universeId: expect.any(Number),
+            universeRootPlaceId: expect.any(Number),
+            price: expect.any(Number),
+            imageToken: expect.any(String)
+          })
+        ])
+      )
+    })
+  })
+
+  // Dependency on getDeveloperProducts() which is broken as of 4.14.0
+  // eslint-disable-next-line jest/no-commented-out-tests
+  // it('updateDeveloperProduct() should update a developer product with new information', () => {
+  //   return getDeveloperProducts(166178819).then((productsData) => {
+  //     const developerProduct = productsData.DeveloperProducts.filter((product) => product.ProductId === newProductId)[0]
+  //     return updateDeveloperProduct(79354837, developerProduct.DeveloperProductId, `Test${Date.now().toString().slice(-6)}`, 104, 'Currently unit testing.').then((res) => {
+  //       return expect(res).toMatchObject({
+  //         universeId: 79354837,
+  //         name: expect.any(String), // account for Roblox filters
+  //         priceInRobux: 104,
+  //         description: expect.any(String), // account for Roblox filters
+  //         developerProductId: developerProduct.DeveloperProductId
+  //       })
+  //     })
+  //   })
+  // })
+})

package/test/groups.test.js

@@ -0,0 +1,311 @@
+const { changeRank, demote, getAuditLog, getGroup, getGroups, getGroupSocialLinks, getJoinRequests, getPlayers, getRankInGroup, getRankNameInGroup, getRole, getRolePermissions, getRoles, getShout, getWall, promote, searchGroups, setRank, shout, setCookie } = require('../lib')
+
+beforeAll(() => {
+  return new Promise(resolve => {
+    setCookie(process.env.COOKIE).then(() => {
+      resolve()
+    })
+  })
+})
+
+describe('Groups Methods', () => {
+  it('changeRank() changes rank of a user', () => {
+    return changeRank(4591072, 857710783, 1).then((res) => {
+      setTimeout(async () => {
+        await changeRank(4591072, 857710783, -1)
+      }, 1000)
+      return expect(res).toMatchObject({
+        newRole: expect.any(Object),
+        oldRole: expect.any(Object)
+      })
+    })
+  })
+
+  it('promote() promotes a user', () => {
+    return promote(4591072, 857710783).then((res) => {
+      return expect(res).toMatchObject({
+        newRole: expect.objectContaining({
+          name: expect.any(String),
+          rank: expect.any(Number),
+          id: expect.any(Number)
+        }),
+        oldRole: expect.objectContaining({
+          name: expect.any(String),
+          rank: expect.any(Number),
+          id: expect.any(Number)
+        })
+      })
+    })
+  })
+
+  it('demote() demotes a user', () => {
+    return demote(4591072, 857710783).then((res) => {
+      return expect(res).toMatchObject({
+        newRole: expect.objectContaining({
+          name: expect.any(String),
+          rank: expect.any(Number),
+          id: expect.any(Number)
+        }),
+        oldRole: expect.objectContaining({
+          name: expect.any(String),
+          rank: expect.any(Number),
+          id: expect.any(Number)
+        })
+      })
+    })
+  })
+
+  it('getAuditLog() returns a group\'s audit logs', () => {
+    return getAuditLog({ group: 4591072, limit: 10 }).then(res => {
+      return expect(res).toMatchObject({
+        previousPageCursor: expect.toBeOneOf([expect.any(String), null]),
+        nextPageCursor: expect.toBeOneOf([expect.any(String), null]),
+        data: expect.arrayContaining([
+          expect.objectContaining({
+            actor: expect.objectContaining({
+              user: expect.objectContaining({
+                hasVerifiedBadge: expect.any(Boolean),
+                userId: expect.any(Number),
+                username: expect.any(String),
+                displayName: expect.any(String)
+              }),
+              role: expect.objectContaining({
+                id: expect.any(Number),
+                name: expect.any(String),
+                rank: expect.any(Number)
+              })
+            }),
+            actionType: expect.any(String),
+            description: expect.any(Object),
+            created: expect.any(Date)
+          })
+        ])
+      })
+    })
+  })
+
+  it('getGroup() returns information on a group', () => {
+    return getGroup(4591072).then((res) => {
+      return expect(res).toMatchObject({
+        id: expect.any(Number),
+        name: expect.any(String),
+        description: expect.any(String),
+        owner: {
+          userId: expect.any(Number),
+          username: expect.any(String),
+          hasVerifiedBadge: expect.any(Boolean),
+          displayName: expect.any(String)
+        },
+        shout: expect.objectContaining({
+          body: expect.any(String),
+          poster: expect.objectContaining({
+            hasVerifiedBadge: expect.any(Boolean),
+            userId: expect.any(Number),
+            username: expect.any(String),
+            displayName: expect.any(String)
+          }),
+          created: expect.any(Date),
+          updated: expect.any(Date)
+        }),
+        memberCount: expect.any(Number),
+        isBuildersClubOnly: expect.any(Boolean),
+        publicEntryAllowed: expect.any(Boolean),
+        hasVerifiedBadge: expect.any(Boolean)
+      })
+    })
+  })
+
+  it('getGroups() should return groups the specified user is in', async () => {
+    return getGroups(55549140).then((res) => {
+      return expect(res).toEqual(
+        expect.arrayContaining([
+          expect.objectContaining({
+            Id: expect.any(Number),
+            Name: expect.any(String),
+            EmblemUrl: expect.any(String),
+            MemberCount: expect.any(Number),
+            Rank: expect.any(Number),
+            Role: expect.any(String),
+            RoleId: expect.any(Number),
+            IsPrimary: expect.any(Boolean)
+          })
+        ])
+      )
+    })
+  })
+
+  it('getGroupSocialLinks() should return social link information of a game, given universeId', () => {
+    return getGroupSocialLinks(9997719).then((res) => {
+      return expect(res).toEqual(
+        expect.arrayContaining([
+          expect.objectContaining({
+            id: expect.any(Number),
+            title: expect.any(String),
+            type: expect.any(String),
+            url: expect.any(String)
+          })
+        ])
+      )
+    })
+  })
+
+  // TODO: getJoinRequest, would require being able to request to join a group
+
+  it('getJoinRequests() returns a list of players that want to join a group', () => {
+    return getJoinRequests(4591072).then((res) => {
+      return expect(res).toMatchObject({
+        previousPageCursor: expect.toBeOneOf([expect.any(String), null]),
+        nextPageCursor: expect.toBeOneOf([expect.any(String), null]),
+        data: expect.any(Array)
+      })
+    })
+  })
+
+  it('getPlayers() returns a list of players in a group', () => {
+    return getPlayers(4591072, [30820744]).then((res) => {
+      return expect(res).toEqual(
+        expect.arrayContaining([
+          expect.objectContaining({
+            userId: expect.any(Number),
+            username: expect.any(String)
+          })
+        ])
+      )
+    })
+  })
+
+  it('getRankInGroup() returns a number reflecting a user\'s rank in a group (0-255)', () => {
+    return getRankInGroup(4591072, 55549140).then((res) => {
+      return expect(res).toEqual(expect.any(Number))
+    })
+  })
+
+  it('getRankNameInGroup() returns a number reflecting a user\'s rank name in a group', () => {
+    return getRankNameInGroup(4591072, 55549140).then((res) => {
+      return expect(res).toEqual(expect.any(String))
+    })
+  })
+
+  it('getRole() returns a role that matches the provided rank', () => {
+    return getRole(4591072, 255).then((res) => {
+      return expect(res).toMatchObject({
+        name: expect.any(String),
+        rank: expect.any(Number),
+        memberCount: expect.any(Number),
+        ID: expect.any(Number)
+      })
+    })
+  })
+
+  it('getRolePermissions() returns permissions given to a role by a group', () => {
+    return getRolePermissions(4591072, 30820744).then((res) => {
+      return expect(res).toMatchObject({
+        groupId: expect.any(Number),
+        role: expect.any(Object),
+        permissions: expect.any(Object)
+      })
+    })
+  })
+
+  it('getRoles() returns the roles in a group', () => {
+    return getRoles(4591072).then((res) => {
+      return expect(res).toEqual(
+        expect.arrayContaining([
+          expect.objectContaining({
+            name: expect.any(String),
+            rank: expect.any(Number),
+            memberCount: expect.any(Number),
+            ID: expect.any(Number)
+          })
+        ])
+      )
+    })
+  })
+
+  it('getShout() returns the current shout on a group', () => {
+    return getShout(4591072).then((res) => {
+      return expect(res).toMatchObject({
+        body: expect.any(String),
+        poster: {
+          userId: expect.any(Number),
+          username: expect.any(String)
+        },
+        created: expect.any(String),
+        updated: expect.any(String)
+      })
+    })
+  })
+
+  it('getWall() returns the latest messages on the group wall', () => {
+    return getWall(4591072).then((res) => {
+      return expect(res).toMatchObject({
+        previousPageCursor: expect.toBeOneOf([expect.any(String), null]),
+        nextPageCursor: expect.toBeOneOf([expect.any(String), null]),
+        data: expect.arrayContaining([
+          expect.objectContaining({
+            id: expect.any(Number),
+            poster: expect.toBeOneOf([expect.any(Object), null]),
+            body: expect.any(String),
+            created: expect.any(Date),
+            updated: expect.any(Date)
+          })
+        ])
+      })
+    })
+  })
+
+  // PASS: groupPayout, costs Robux to test
+
+  // PASS: handleJoinRequest, would require being able to request to join a group
+
+  // PASS: leaveGroup, would require being able to request to join a group
+
+  it('searchGroups() returns groups that match the query', () => {
+    return searchGroups('noblox.js').then((res) => {
+      return expect(res).toEqual(
+        expect.arrayContaining([expect.objectContaining({
+          id: expect.any(Number),
+          name: expect.any(String),
+          description: expect.any(String),
+          memberCount: expect.any(Number),
+          publicEntryAllowed: expect.any(Boolean),
+          created: expect.any(Date),
+          updated: expect.any(Date)
+        })]))
+    })
+  })
+
+  // PASS: setGroupDescription -- skip this, do not own group
+
+  // PASS: setGroupName -- skip this, costs Robux
+
+  it('setRank() should set a player\'s rank to the specified rank', () => {
+    return changeRank(4591072, 857710783, 2).then(() => {
+      return setRank(4591072, 857710783, 1).then((res) => {
+        return expect(res).toMatchObject({
+          name: expect.any(String),
+          rank: expect.any(Number),
+          memberCount: expect.any(Number),
+          ID: expect.any(Number)
+        })
+      })
+    })
+  })
+
+  it('shout() should post a message to the group\'s shout', () => {
+    return shout(4591072, 'This is a noblox.js test!').then((res) => {
+      setTimeout(async () => {
+        await shout(4591072, '')
+      }, 1000)
+      return expect(res).toMatchObject({
+        body: expect.any(String),
+        poster: {
+          userId: expect.any(Number),
+          username: expect.any(String)
+        },
+        created: expect.any(String),
+        updated: expect.any(String)
+      })
+    })
+  })
+})

package/test/inventory.test.js

@@ -0,0 +1,98 @@
+const { getCollectibles, getInventory, getInventoryById, getOwnership, getUAIDs, setCookie } = require('../lib')
+
+beforeAll(() => {
+  return new Promise(resolve => {
+    setCookie(process.env.COOKIE).then(() => {
+      resolve()
+    })
+  })
+})
+
+describe('Inventory Methods', () => {
+  it('getCollectibles() should return a user\'s collectibles.', async () => {
+    return getCollectibles(55549140).then((res) => {
+      return expect(res).toEqual(
+        expect.arrayContaining([
+          expect.objectContaining({
+            userAssetId: expect.any(Number),
+            serialNumber: expect.toBeOneOf([expect.any(Number), null]),
+            assetId: expect.any(Number),
+            name: expect.any(String),
+            recentAveragePrice: expect.any(Number),
+            originalPrice: expect.toBeOneOf([expect.any(Number), null]),
+            assetStock: expect.toBeOneOf([expect.any(Number), null]),
+            buildersClubMembershipType: expect.any(Number)
+          })
+        ])
+      )
+    })
+  })
+
+  it('getInventory() returns a user\'s inventory', () => {
+    return getInventory(55549140, ['Shirt']).then((res) => {
+      return expect(res).toEqual(
+        expect.arrayContaining([
+          expect.objectContaining({
+            assetId: expect.any(Number),
+            name: expect.any(String),
+            assetType: expect.any(String),
+            created: expect.any(Date)
+          })
+        ])
+      )
+    })
+  })
+
+  it('getInventoryById() returns items in a user\'s inventory fitting the specified assetTypeId', () => {
+    return getInventoryById(55549140, 8).then((res) => {
+      return expect(res).toEqual(
+        expect.arrayContaining([
+          expect.objectContaining({
+            assetName: expect.any(String),
+            userAssetId: expect.any(Number),
+            assetId: expect.any(Number),
+            owner: expect.objectContaining({
+              userId: expect.any(Number),
+              username: expect.any(String)
+            }),
+            created: expect.any(Date),
+            updated: expect.any(Date)
+          })
+        ])
+      )
+    })
+  })
+
+  it('getOwnership() [ASSET] returns if a player owns the specified asset', () => {
+    return getOwnership(55549140, 1900419889).then((res) => {
+      return expect(res).toBe(true)
+    })
+  })
+
+  it('getOwnership() [GAMEPASS] returns if a player owns the specified game pass', () => {
+    return getOwnership(55549140, 1537467, 'GamePass').then((res) => {
+      return expect(res).toBe(true)
+    })
+  })
+
+  it('getOwnership() [BADGE] returns if a player owns the specified badge', () => {
+    return getOwnership(55549140, 176332932, 'Badge').then((res) => {
+      return expect(res).toBe(true)
+    })
+  })
+
+  it('getOwnership() [BUNDLE] returns if a player owns the specified bundle', () => {
+    return getOwnership(55549140, 79, 'Bundle').then((res) => {
+      return expect(res).toBe(true)
+    })
+  })
+
+  it('getUAIDs() returns a user specific asset IDs given an ID', () => {
+    return getUAIDs(80231025, [1974901902, 4255053867, 2705893733, 1532395]).then((res) => {
+      return expect(res).toMatchObject({
+        uaids: expect.any(Array),
+        failedIds: expect.any(Array)
+      })
+    })
+  })
+})

package/test/itemconfiguration.test.js

@@ -0,0 +1,24 @@
+const { getGroupAssets, setCookie } = require('../lib')
+
+beforeAll(() => {
+  return new Promise(resolve => {
+    setCookie(process.env.COOKIE).then(() => {
+      resolve()
+    })
+  })
+})
+
+describe('Item Configuration Methods', () => {
+  it('getGroupAssets() returns an array of group assets', () => {
+    return getGroupAssets({ groupId: 4591072, assetType: 'Shirt', limit: 1 }).then((res) => {
+      return expect(res).toEqual(
+        expect.arrayContaining([
+          expect.objectContaining({
+            assetId: expect.any(Number),
+            name: expect.any(String)
+          })
+        ])
+      )
+    })
+  })
+})

package/test/premiumfeatures.test.js

@@ -0,0 +1,17 @@
+const { getPremium, setCookie } = require('../lib')
+
+beforeAll(() => {
+  return new Promise(resolve => {
+    setCookie(process.env.COOKIE).then(() => {
+      resolve()
+    })
+  })
+})
+
+describe('Premium Features Methods', () => {
+  it('getPremium() returns a player\'s premium state', () => {
+    return getPremium(55549140).then((res) => {
+      return expect(res).toEqual(expect.any(Boolean))
+    })
+  })
+})

package/test/presence.test.js

@@ -0,0 +1,25 @@
+const { getPresences, setCookie } = require('../lib')
+
+beforeAll(() => {
+  return new Promise(resolve => {
+    setCookie(process.env.COOKIE).then(() => {
+      resolve()
+    })
+  })
+})
+
+describe('Presence Methods', () => {
+  it('getPresences() returns presences of the userIds provided', () => {
+    return getPresences([55549140]).then((res) => {
+      return expect(res).toMatchObject({
+        userPresences: expect.arrayContaining([
+          expect.objectContaining({
+            userPresenceType: expect.any(Number),
+            userId: expect.any(Number),
+            lastOnline: expect.any(String)
+          })
+        ])
+      })
+    })
+  })
+})