BREAKING CHANGE: Groups methods overhaul

lib/groups/getPrimaryGroup.js

@@ -0,0 +1,37 @@
+// Includes
+const http = require('../util/http.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+// Args
+exports.required = ['userId']
+exports.optional = []
+
+// Docs
+/**
+ * ✅Gets the specified user's primary group.
+ * @category User
+ * @alias getPrimaryGroup
+ * @param {number} userId - The ID of the user.
+ * @returns {Promise<Group>}
+ * @example const noblox = require("noblox.js")
+ * const primaryGroup = await noblox.getPrimaryGroup(1)
+**/
+
+// Define
+exports.func = async function (args) {
+  const { userId } = args
+
+  const response = await http({
+    url: `https://groups.roblox.com/v1/users/${userId}/groups/primary/role`,
+    options: {
+      json: true,
+      resolveWithFullResponse: true
+    }
+  })
+
+  if (response.statusCode !== 200) {
+    throw new RobloxAPIError(response)
+  }
+
+  return response.body
+}

lib/groups/getUserGroups.js

@@ -0,0 +1,37 @@
+// Includes
+const http = require('../util/http.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+// Args
+exports.required = ['userId']
+exports.optional = []
+
+// Docs
+/**
+ * ✅ Get the groups of a user.
+ * @category User
+ * @alias getUserGroups
+ * @param {number} userId - The id of the user.
+ * @returns {Promise<GroupMemberInfo[]>}
+ * @example const noblox = require("noblox.js")
+ * let groups = await noblox.getGroups(123456)
+**/
+
+// Define
+exports.func = async function (args) {
+  const { userId } = args
+
+  const response = await http({
+    url: `https://groups.roblox.com/v2/users/${userId}/groups/roles?includeLocked=true`,
+    options: {
+      json: true,
+      resolveWithFullResponse: true
+    }
+  })
+
+  if (response.statusCode !== 200) {
+    throw new RobloxAPIError(response)
+  }
+
+  return response.body.data
+}

lib/groups/multigetPartialGroups.js

@@ -0,0 +1,44 @@
+// Includes
+const http = require('../util/http.js').func
+const RobloxAPIError = require('../util/apiError')
+
+// Args
+exports.required = ['groupIds']
+exports.optional = []
+
+// Docs
+/**
+ * ✅ Gets partial info of multiple groups.
+ * @category Group
+ * @alias multigetPartialGroups
+ * @param {number[]} groupIds - Array of group IDs.
+ * @returns {Promise<GroupMultigetPartial[]>}
+ * @example const noblox = require("noblox.js")
+ * const groupsInfo = await noblox.multigetPartialGroups([1,2,3])
+**/
+
+exports.func = async function (args) {
+  const { groupIds } = args
+
+  if (!Array.isArray(groupIds)) throw TypeError('Group IDs must be an array')
+
+  const response = await http({
+    url: `https://groups.roblox.com/v2/groups?groupIds=${groupIds.join(',')}`,
+    options: {
+      json: true,
+      resolveWithFullResponse: true
+    }
+  })
+
+  if (response.statusCode !== 200) {
+    throw new RobloxAPIError(response)
+  }
+
+  const { data } = response.body
+
+  for (let i = 0, len = data.length; i < len; i++) {
+    data[i].created = new Date(data[i].created)
+  }
+
+  return data
+}

lib/index.js

@@ -109,20 +109,22 @@ noblox.getAuditLog = require('./groups/getAuditLog.js')
 noblox.getGroup = require('./groups/getGroup.js')
 noblox.getGroupPayoutEligibility = require('./economy/getGroupPayoutEligibility.js')
 noblox.getGroupSocialLinks = require('./groups/getGroupSocialLinks.js')
-noblox.getGroups = require('./groups/getGroups.js')
 noblox.getJoinRequest = require('./groups/getJoinRequest.js')
 noblox.getJoinRequests = require('./groups/getJoinRequests.js')
 noblox.getPlayers = require('./groups/getPlayers.js')
+noblox.getPrimaryGroup = require('./groups/getPrimaryGroup.js')
 noblox.getRankInGroup = require('./groups/getRankInGroup.js')
 noblox.getRankNameInGroup = require('./groups/getRankNameInGroup.js')
 noblox.getRole = require('./groups/getRole.js')
 noblox.getRolePermissions = require('./groups/getRolePermissions.js')
 noblox.getRoles = require('./groups/getRoles.js')
 noblox.getShout = require('./groups/getShout.js')
+noblox.getUserGroups = require('./groups/getUserGroups.js')
 noblox.getWall = require('./groups/getWall.js')
 noblox.groupPayout = require('./groups/groupPayout.js')
 noblox.handleJoinRequest = require('./groups/handleJoinRequest.js')
 noblox.leaveGroup = require('./groups/leaveGroup.js')
+noblox.multigetPartialGroups = require('./groups/multigetPartialGroups.js')
 noblox.onAuditLog = require('./groups/onAuditLog.js')
 noblox.onJoinRequest = require('./groups/onJoinRequest.js')
 noblox.onJoinRequestHandle = require('./groups/onJoinRequestHandle.js')

lib/thumbnails/getLogo.js

@@ -1,56 +1,61 @@
-// Includes
-const http = require('../util/http.js').func
-const RobloxAPIError = require('../util/apiError.js')
-
-// Args
-exports.required = ['group']
-exports.optional = ['size', 'circular', 'format']
-
-// Docs
-/**
- * ✅ Get the group's logo.
- * @category Group
- * @alias getLogo
- * @param {number} group - The id of the group.
- * @param {GroupIconSize=} [size=150x150] - The size of the logo.
- * @param {boolean=} [circular=false] - Get the circular version of the logo.
- * @param {GroupIconFormat=} [format=Png] - The file format of the logo.
- * @returns {Promise<string>}
- * @example const noblox = require("noblox.js")
- * const logo = await noblox.getLogo(1)
-**/
-
-// Define
-function getLogo (group, size, circular, format) {
-  const httpOpt = {
-    url: '//thumbnails.roblox.com/v1/groups/icons',
-    options: {
-      qs: {
-        groupIds: group,
-        size: size || '150x150',
-        format: format || 'Png',
-        isCircular: circular
-      },
-      json: true,
-      resolveWithFullResponse: true
-    }
-  }
-  return http(httpOpt)
-    .then(function (res) {
-      if (res.statusCode !== 200) {
-        throw new RobloxAPIError(res)
-      }
-
-      const thumbnailData = res.body.data[0]
-
-      if (thumbnailData.state !== 'Completed') {
-        throw new Error('The requested image has not been approved. Status: ' + thumbnailData.state)
-      }
-
-      return thumbnailData.imageUrl
-    })
-}
-
-exports.func = function (args) {
-  return getLogo(args.group)
-}
+// Includes
+const http = require('../util/http.js').func
+const RobloxAPIError = require('../util/apiError.js')
+
+// Args
+exports.required = ['group']
+exports.optional = ['size', 'circular', 'format']
+
+// Docs
+/**
+ * ✅ Get the group's logo.
+ * @category Group
+ * @alias getLogo
+ * @param {number || number[]} group - The id(s) of the group.
+ * @param {GroupIconSize=} [size=150x150] - The size of the logo.
+ * @param {boolean=} [circular=false] - Get the circular version of the logo.
+ * @param {GroupIconFormat=} [format=Png] - The file format of the logo.
+ * @returns {Promise<string> || Promise<string[]>}
+ * @example const noblox = require("noblox.js")
+ * const logo = await noblox.getLogo(1)
+**/
+
+// Define
+function getLogo (group, size, circular, format) {
+  const groupIds = Array.isArray(group) ? group.join(',') : group
+  const httpOpt = {
+    url: '//thumbnails.roblox.com/v1/groups/icons',
+    options: {
+      qs: {
+        groupIds,
+        size: size || '150x150',
+        format: format || 'Png',
+        isCircular: circular
+      },
+      json: true,
+      resolveWithFullResponse: true
+    }
+  }
+  return http(httpOpt)
+    .then(function (res) {
+      if (res.statusCode !== 200) {
+        throw new RobloxAPIError(res)
+      }
+
+      const urls = []
+
+      for (const thumb of res.body.data) {
+        if (thumb.state !== 'Completed') {
+          throw new Error(`The requested image for group ${thumb.targetId} has not been approved. State: ${thumb.state}`)
+        }
+
+        urls.push(thumb.imageUrl)
+      }
+
+      return urls.length > 1 ? urls : urls.at(0)
+    })
+}
+
+exports.func = function (args) {
+  return getLogo(args.group)
+}