noblox.js - npm Package Compare versions

Comparing version 4.6.5 to 4.7.0

examples/revertRanks.js

@@ -16,3 +16,3 @@ // Revert player ranks to their original rank in a certain range.
     const pages = []
-    for (const i = startPage; i <= endPage; i++) {
+    for (let i = startPage; i <= endPage; i++) {
       pages.push(i)
@@ -30,3 +30,3 @@ }
       const original = {}
-      for (const i = 0; i < logs.length; i++) {
+      for (let i = 0; i < logs.length; i++) {
         const log = logs[i]
@@ -33,0 +33,0 @@ if (log.date > afterDate) {

lib/group/setRank.js

@@ -62,2 +62,5 @@ // Includes
     } else {
+      if (typeof opt.rank !== 'number') {
+        throw new Error('setRank: Rank number must be a number')
+      }
       opt.rank = rank
@@ -64,0 +67,0 @@ }

package.json

 {
   "name": "noblox.js",
-  "version": "4.6.5",
+  "version": "4.7.0",
   "description": "A Node.js wrapper for ROBLOX. (original from sentanos)",
@@ -5,0 +5,0 @@ "main": "lib/index.js",

typings/index.d.ts

@@ -10,3 +10,3 @@ // Type definitions for noblox.js@4.6.0
     /**
-     * request 
+     * request
      */
@@ -274,3 +274,3 @@ interface CookieJar
 
-    interface ChatMessageSetConversationUniverseEventBased 
+    interface ChatMessageSetConversationUniverseEventBased
     {
@@ -382,2 +382,36 @@ actorUserId: number;
 
+    interface PlaceInformation {
+        AssetId: number;
+        Name: string;
+        Description: string;
+        Created: Date;
+        Updated: Date;
+        FavoritedCount: number;
+        Url: string;
+        ReportAbuseAbsoluteUrl: string;
+        IsFavoritedByUser: boolean;
+        IsFavoritesUnavailable: boolean;
+        UserCanManagePlace: boolean;
+        VisitedCount: number,
+        MaxPlayers: number,
+        Builder: string,
+        BuilderId: number,
+        BuilderAbsoluteUrl: string
+        IsPlayable: boolean,
+        ReasonProhibited: string,
+        ReasonProhibitedMessage: string,
+        IsCopyingAllowed: boolean,
+        PlayButtonType: string,
+        AssetGenre: string,
+        AssetGenreViewModel: { DisplayName: string, Id: number },
+        OnlineCount: number,
+        UniverseId: number,
+        UniverseRootPlaceId: number,
+        TotalUpVotes: number,
+        TotalDownVotes: number,
+        OverridesDefaultAvatar: boolean,
+        UsePortraitMode: boolean,
+        Price: number
+    }
+
     interface DeveloperProductAddResult
@@ -427,5 +461,5 @@ {
         id: number;
-        description: string;    
+        description: string;
     }
-    
+
     interface GroupPostsPermissions
@@ -509,3 +543,3 @@ {
     {
-        userId: number; 
+        userId: number;
         username: string;
@@ -581,3 +615,3 @@ displayName: string;
 
-    interface GroupJoinRequester 
+    interface GroupJoinRequester
     {
@@ -781,2 +815,59 @@ userId: number;
 
+	interface playerThumbnailData{
+		targetId: number;
+		state: string;
+		imageUrl: string;
+	}
+
+    /// Badges
+
+    interface BadgeAwarder {
+        id: number;
+        type: string;
+    }
+
+    interface BadgeStatistics {
+        pastDayAwardedCount: number;
+        awardedCount: number;
+        winRatePercentage: number;
+    }
+
+    interface BadgeUniverse {
+        id: number;
+        name: string;
+        rootPlaceId: number;
+    }
+
+    //
+    interface PlayerBadges {
+        id: number;
+        name: string;
+        description: string|null;
+        displayName: string;
+        displayDescription: string|null;
+        enabled: boolean;
+        iconImageId: number;
+        displayIconImageId: number;
+        awarder: BadgeAwarder;
+        statistics: BadgeStatistics;
+        created: Date;
+        updated: Date;
+    }
+    //
+
+    interface BadgeInfo {
+        id: number;
+        name: string;
+        description: string|null;
+        displayName: string;
+        displayDescription: string|null;
+        enabled: boolean;
+        iconImageId: number;
+        displayIconImageId: number;
+        created: Date;
+        updated: Date;
+        statistics: BadgeStatistics
+        awardingUniverse: BadgeUniverse
+    }
+
     /// Utility
@@ -818,3 +909,3 @@
     {
-        latest: number; 
+        latest: number;
         data: object;
@@ -857,3 +948,3 @@ repeat?: boolean;
     function avatarRules(option?: "playerAvatarTypes" | "scales" | "wearableAssetTypes" | "bodyColorsPalette" | "basicBodyColorsPalette" | "minimumDeltaEBodyColorDifference" | "proportionsAndBodyTypeEnabledForUser" | "defaultClothingAssetLists" | "bundlesEnabledForUser" | "emotesEnabledForUser" | undefined, jar?: CookieJar): Promise<AvatarRules>;
-    
+
     function avatarRules(option: "playerAvatarTypes", jar?: CookieJar): Promise<string[]>;
@@ -875,3 +966,3 @@ function avatarRules(option: "scales", jar?: CookieJar): Promise<AvatarRulesScales>;
     function getCurrentAvatar(option?: "scales" | "playerAvatarType" | "bodyColors" | "assets" | "defaultShirtApplied" | "defaultPantsApplied" | undefined, jar?: CookieJar): Promise<AvatarInfo>;
-    
+
     function getCurrentAvatar(option: "scales", jar?: CookieJar): Promise<AvatarScale>;
@@ -947,6 +1038,14 @@ function getCurrentAvatar(option: "playerAvatarType", jar?: CookieJar): Promise<PlayerAvatarType>;
      * @param placeId The place whose game instances are being fetched.
-     * @param startIndex The index to start from in regards to server list. 
+     * @param startIndex The index to start from in regards to server list.
      */
     function getGameInstances(placeId: number, startIndex: number): Promise<GameInstances>;
 
+    function getGameBadges(universeId: number, limit?: Limit, cursor?: string, sortOrder?: SortOrder): Promise<BadgeInfo>
+
+    /**
+     * Returns information about the place in question, such as Description, name etc. Varies based on whether or not you're logged in.
+     * @param placeId The place whose information is being fetched.
+     */
+    function getPlaceInfo(placeId: number): Promise<PlaceInformation>;
+
     // You can create a developer product, but the productId returned does not match the actual developer product id needed by the endpoints.
@@ -959,3 +1058,3 @@ // It's strange, but the edit link on the product page has the id that Roblox wants so you can edit dev products.
      * Checks to see if the provided `produceName` is able to be used on `productId`.
-     * 
+     *
      * NOTE: You actually need a valid `productId` and `universeId` otherwise, the http request returns a `404 Not Found` response.
@@ -1132,3 +1231,3 @@ */
      * Logs into the user account with a provided `username` and `password`. On success -, stores the account cookie in `jar`.
-     * 
+     *
      * NOTE: Usage of this function is deprecated as of v4.6.0 and calling requires passing the robot test.
@@ -1188,3 +1287,3 @@ */
 
-    
+
     /**
@@ -1214,2 +1313,7 @@ * Gets the transaction history of the logged in user or of the user specified by the jar.
     /**
+     * Gets the badges of a user.
+    */
+    function getPlayerBadges(userId: number, limit?: Limit, cursor?: string, sortOrder?: SortOrder): Promise<PlayerBadges>
+
+    /**
      * Gets a brief overview of a user.
@@ -1220,2 +1324,7 @@ */
     /**
+     * Gets the thumbnail of an array of users.
+     */
+    function getPlayerThumbnail(userIds: number | number[], size: number, format?: string, isCircular?: boolean): Promise<playerThumbnailData[]>;
+
+    /**
      * Gets the presence statuses of the specified users
@@ -1507,3 +1616,3 @@ */
      * This function emits all join requests and waits until all of them have been resolved by firing the `handle` event with the request and either true or false. You can also pass a third argument `callback` to handle to execute once the join request has been handled. Once all requests on a page have been resolved, the next page is collected. Make sure that all join requests are handled in some way. Because this function has to wait for input, it does handle timeouts but does them within the function as opposed to within shortPoll.
-     * 
+     *
      * To accept all new users that aren't on a blacklist and send them a message, for example:
@@ -1579,2 +1688,15 @@ * ```javascript
     function onNotification(jar?: CookieJar): OnNotificationEventEmitter;
+
+
+    /// Badges
+
+    /**
+     * Gets information about a badge.
+     */
+    function getBadgeInfo(badgeId: number): Promise<BadgeInfo>
+
+    /**
+     * Updates badge information.
+     */
+    function updateBadgeInfo(badgeId: number, name?: string, description?: string, enabled?: boolean, jar?: CookieJar): Promise<void>
 }

No alert changes

Improved metrics

Total package byte prevSize

271399

increased by4.45%

Number of package files

168

increased by3.7%

Lines of code

6980

increased by5.53%

No dependency changes