noblox.ts 4.10.5

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)
+          })
+        ])
+      })
+    })
+  })
+})

package/test/privatemessages.test.js

@@ -0,0 +1,33 @@
+const { getMessages, setCookie } = require('../lib')
+
+beforeAll(() => {
+  return new Promise(resolve => {
+    setCookie(process.env.COOKIE).then(() => {
+      resolve()
+    })
+  })
+})
+
+describe('Private Messages Methods', () => {
+  it('getMessages() returns the logged in user\'s messages', () => {
+    return getMessages().then((res) => {
+      return expect(res).toMatchObject({
+        totalCollectionSize: expect.any(Number),
+        totalPages: expect.any(Number),
+        pageNumber: expect.any(Number),
+        collection: expect.arrayContaining([
+          expect.objectContaining({
+            id: expect.any(Number),
+            sender: expect.any(Object),
+            recipient: expect.any(Object),
+            subject: expect.any(String),
+            body: expect.any(String),
+            created: expect.any(String),
+            updated: expect.any(String),
+            isRead: expect.any(Boolean)
+          })
+        ])
+      })
+    })
+  })
+})

package/test/thumbnails.test.js

@@ -0,0 +1,53 @@
+const { getLogo, getPlayerThumbnail, getThumbnails, setCookie } = require('../lib')
+
+beforeAll(() => {
+  return new Promise(resolve => {
+    setCookie(process.env.COOKIE).then(() => {
+      resolve()
+    })
+  })
+})
+
+describe('Thumbnails Methods', () => {
+  it('getLogo() returns a image URL for a group', () => {
+    return getLogo(4591072).then(() => {
+      return expect.any(String)
+    })
+  })
+
+  it('getPlayerThumbnail() returns a player\'s thumbnail', () => {
+    return getPlayerThumbnail(55549140, 60).then((res) => {
+      return expect(res).toEqual(
+        expect.arrayContaining([
+          expect.objectContaining({
+            targetId: expect.any(Number),
+            state: expect.any(String),
+            imageUrl: expect.any(String)
+          })
+        ])
+      )
+    })
+  })
+
+  it('getThumbnails() returns player/asset thumbnails', () => {
+    return getThumbnails([
+      {
+        type: 'AvatarHeadShot',
+        token: '4C32C300ABC60ABD344ABCFB3841E778',
+        size: '150x150'
+      }
+    ]).then((res) => {
+      return expect(res).toEqual(
+        expect.arrayContaining([
+          expect.objectContaining({
+            errorCode: expect.any(Number),
+            errorMessage: expect.any(String),
+            targetId: expect.any(Number),
+            state: expect.any(String),
+            imageUrl: expect.any(String)
+          })
+        ])
+      )
+    })
+  })
+})

package/test/users.test.js

@@ -0,0 +1,68 @@
+const { getBlurb, getIdFromUsername, getPlayerInfo, getUsernameFromId, setCookie } = require('../lib')
+
+beforeAll(() => {
+  return new Promise(resolve => {
+    setCookie(process.env.COOKIE).then(() => {
+      resolve()
+    })
+  })
+})
+
+describe('Users Methods', () => {
+  it('getBlurb() returns a user\'s blurb', () => {
+    return getBlurb(55549140).then((res) => {
+      return expect(res).toEqual(expect.any(String))
+    })
+  })
+
+  it('getIdFromUsername() returns a user\'s ID given their username', () => {
+    return getIdFromUsername('ROBLOX').then((res) => {
+      return expect(res).toEqual(expect.any(Number))
+    })
+  })
+
+  it('getIdFromUsername() returns several IDs given several usernames', () => {
+    return getIdFromUsername(['qxest', 'builderman']).then((res) => {
+      return expect(res).toEqual(
+        expect.arrayContaining([expect.toBeOneOf([expect.any(Number), null])])
+      )
+    })
+  })
+
+  it('getIdFromUsername() returns null when given username that doesn\'t exist', () => {
+    return getIdFromUsername('x').then((res) => {
+      return expect(res).toBeNull()
+    })
+  })
+
+  it('getIdFromUsername() returns null when given usernames that don\'t exist', () => {
+    return getIdFromUsername(['p', 'a']).then((res) => {
+      return expect(res).toEqual(
+        expect.arrayContaining([null])
+      )
+    })
+  })
+
+  it('getPlayerInfo() returns information on the specified user', () => {
+    return getPlayerInfo(55549140).then((res) => {
+      return expect(res).toMatchObject({
+        username: expect.any(String),
+        blurb: expect.any(String),
+        joinDate: expect.any(Date),
+        age: expect.any(Number),
+        friendCount: expect.any(Number),
+        followerCount: expect.any(Number),
+        followingCount: expect.any(Number),
+        oldNames: expect.any(Array),
+        isBanned: expect.any(Boolean),
+        displayName: expect.any(String)
+      })
+    })
+  })
+
+  it('getUsernameFromId() returns a player\'s username given an ID', () => {
+    return getUsernameFromId(1).then((res) => {
+      return expect(res).toEqual(expect.any(String))
+    })
+  })
+})