Merge pull request #33 from Roblox-Indie-Wikis/development

Release version 1.4.0

Author: SomeMWDev

.github/dependabot.yml

@@ -0,0 +1,14 @@
+version: 2
+updates:
+  - package-ecosystem: "composer"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/workflows/ci.yml

@@ -20,8 +20,11 @@ jobs:
           - mw: 'REL1_43'
             php: 8.1
             experimental: false
-          - mw: 'master'
+          - mw: 'REL1_44'
             php: 8.1
+            experimental: false
+          - mw: 'master'
+            php: 8.3
             experimental: true
 
     runs-on: ubuntu-latest

.github/workflows/lint-check.yml

@@ -12,7 +12,7 @@ jobs:
       - name: Installing PHP
         uses: shivammathur/setup-php@master
         with:
-          php-version: '8.0'
+          php-version: '8.1'
       - name: Get Composer Cache Directory 2
         id: composer-cache
         run: |

README.md

@@ -24,6 +24,10 @@ Live Examples:
 > Miraheze users may use ManageWiki to install this extension. Search for 'RobloxAPI' in *Special:ManageWiki/extensions*
 > and install it with a click.
 
+Requirements:
+* MediaWiki 1.42 or higher
+* PHP 8.1.0 or higher
+
 1. Download the repository using the following
    link: [Download ZIP](https://github.com/Roblox-Indie-Wikis/mediawiki-extensions-RobloxAPI/archive/master.zip)
 2. Place the files in a directory called `RobloxAPI` in your `extensions/` folder.

SECURITY.md

@@ -4,12 +4,13 @@
 
 * MediaWiki: >= 1.42.x (until 1.42 reaches EOL)
 
-| Version | Supported | Notes             |
-|---------|-----------|-------------------|
-| 1.3.0   | ✅         | Latest release    |
-| 1.2.0   | ✅         | Upgrade to 1.3.0  |
-| 1.1.0   | ❌         | Use 1.2.0 instead |
-| 1.0.0   | ❌         | Use 1.2.0 instead |
+| Version | Supported | Notes            |
+|---------|-----------|------------------|
+| 1.4.0   | ✅         | Latest release   |
+| 1.3.0   | ✅         | Upgrade to 1.4.0 |
+| 1.2.0   | ❌         |                  |
+| 1.1.0   | ❌         |                  |
+| 1.0.0   | ❌         |                  |
 
 ## Reporting a Vulnerability
 

USAGE.md

@@ -21,6 +21,10 @@
         + [userInfo](#userinfo)
         + [assetDetails](#assetdetails)
         + [groupRolesList](#grouproleslist)
+        + [gameNameDescription](#gamenamedescription)
+        + [universeInfo](#universeinfo)
+        + [userGames](#usergames)
+        + [userPlaceVisits](#userplacevisits)
     * [Handling JSON data](#handling-json-data)
         + [JSON keys](#json-keys)
         + [Pretty-printing JSON data](#pretty-printing-json-data)
@@ -57,7 +61,7 @@ specified in the `key=value` format.
 
 ### gameData
 
-Provides information about a game/place in the [JSON format](#Handling-JSON-data).
+Provides information about a game/place in the [JSON format](#handling-json-data).
 
 #### Example
 
@@ -150,7 +154,7 @@ Get the user ID of a user:
 
 ### userAvatarThumbnail
 
-Provides data about a user's avatar thumbnail in the [JSON format](#Handling-JSON-data).
+Provides data about a user's avatar thumbnail in the [JSON format](#handling-json-data).
 
 #### Example
 
@@ -203,7 +207,11 @@ Get the URL of the user avatar thumbnail of builderman (ID 156):
 
 ### assetThumbnail
 
-Provides the data about an asset thumbnail in the [JSON format](#Handling-JSON-data).
+> [!WARNING]
+> Roblox enforces a stricter rate limit on the API used for this than on the other APIs.
+> It is in general recommended to use it at most once per page.
+
+Provides the data about an asset thumbnail in the [JSON format](#handling-json-data).
 
 #### Example
 
@@ -229,6 +237,10 @@ Get the data about the asset thumbnail of the asset with ID 102611803:
 
 ### assetThumbnailUrl
 
+> [!WARNING]
+> Roblox enforces a stricter rate limit on the API used for this than on the other APIs.
+> It is in general recommended to use it at most once per page.
+
 Provides the URL of an asset thumbnail. Allows [embedding](#Embedding-images-from-the-Roblox-CDN) the asset image.
 Requires [assetThumbnail](#assetThumbnail) to be enabled.
 
@@ -256,7 +268,7 @@ Get the URL of the asset thumbnail of the asset with ID 102611803:
 
 ### gameIcon
 
-Provides the data about a game icon in the [JSON format](#Handling-JSON-data).
+Provides the data about a game icon in the [JSON format](#handling-json-data).
 
 #### Example
 
@@ -311,7 +323,7 @@ Get the URL of the game icon of the game with ID 132813250731469:
 
 ### groupRoles
 
-Provides all group roles a user has in all groups they have joined in the [JSON format](#Handling-JSON-data).
+Provides all group roles a user has in all groups they have joined in the [JSON format](#handling-json-data).
 
 [Official API documentation](https://groups.roblox.com//docs/index.html?urls.primaryName=Groups%20Api%20v1#operations-Membership-get_v1_users__userId__groups_roles)
 
@@ -351,7 +363,7 @@ Get the name of the rank of the user with ID `4182456156` in the group with ID `
 
 ### groupData
 
-Provides data about a group in the [JSON format](#Handling-JSON-data).
+Provides data about a group in the [JSON format](#handling-json-data).
 
 [Official API documentation](https://groups.roblox.com//docs/index.html?urls.primaryName=Groups%20Api%20v1#operations-Groups-get_v1_groups__groupId_)
 
@@ -396,7 +408,7 @@ Get the formatted number of members in a group:
 
 ### badgeInfo
 
-Provides information about a badge in the [JSON format](#Handling-JSON-data).
+Provides information about a badge in the [JSON format](#handling-json-data).
 
 #### Example
 
@@ -414,7 +426,7 @@ Get all JSON data of a badge:
 
 ### userInfo
 
-Provides information about a user in the [JSON format](#Handling-JSON-data).
+Provides information about a user in the [JSON format](#handling-json-data).
 
 #### Example
 
@@ -432,7 +444,7 @@ Get all JSON data of a user:
 
 ### assetDetails
 
-Provides information about an asset in the [JSON format](#Handling-JSON-data).
+Provides information about an asset in the [JSON format](#handling-json-data).
 
 #### Example
 
@@ -450,7 +462,7 @@ Get all JSON data of an asset:
 
 ### groupRolesList
 
-Provides a list of roles in a group in the [JSON format](#Handling-JSON-data).
+Provides a list of roles in a group in the [JSON format](#handling-json-data).
 
 #### Example
 
@@ -468,7 +480,7 @@ Get the roles of a group:
 
 ### gameNameDescription
 
-Provides the name and description of a game in all supported languages in the [JSON format](#Handling-JSON-data).
+Provides the name and description of a game in all supported languages in the [JSON format](#handling-json-data).
 
 #### Example
 
@@ -492,7 +504,7 @@ Get the description of a game in English:
 
 ### universeInfo
 
-Provides info about a universe in the [JSON format](#Handling-JSON-data).
+Provides info about a universe in the [JSON format](#handling-json-data).
 
 #### Example
 
@@ -514,6 +526,60 @@ Get the privacy type of a universe:
 |--------------|----------------------------------------------|------------|
 | `UniverseId` | The [universe ID](#universe-id) of the game. | Numeric ID |
 
+### userGames
+
+Provides a list of games a user has created in the [JSON format](#handling-json-data).
+
+Note that it is not possible to get more than 50 games.
+
+#### Example
+
+Get the list of games a user has created:
+
+```
+{{#robloxAPI: userGames | 1995870730 }}
+```
+
+#### Required Arguments
+
+| Name     | Description              | Type       |
+|----------|--------------------------|------------|
+| `UserId` | The user ID of the user. | Numeric ID |
+
+#### Optional Arguments
+
+| Name         | Description                            | Type                      | Default |
+|--------------|----------------------------------------|---------------------------|---------|
+| `limit`      | The maximum number of games to return. | Numeric ID (10, 25 or 50) | `50`    |
+| `sort_order` | The order to sort the games.           | String (`Asc`, `Desc`)    | `Asc`   |
+
+### userPlaceVisits
+
+Provides the number of visits of all places a user has created.
+
+Note that due to performance reasons, only the views of the first 50 places of the user are returned.
+
+#### Example
+
+Get the number of visits of all places a user has created:
+
+```
+{{#robloxAPI: userPlaceVisits | 1995870730 }}
+```
+
+#### Required Arguments
+
+| Name     | Description              | Type       |
+|----------|--------------------------|------------|
+| `UserId` | The user ID of the user. | Numeric ID |
+
+#### Optional Arguments
+
+| Name         | Description                                                                                                                       | Type                      | Default |
+|--------------|-----------------------------------------------------------------------------------------------------------------------------------|---------------------------|---------|
+| `limit`      | The maximum number of games to consider in the calculation.                                                                       | Numeric ID (10, 25 or 50) | `50`    |
+| `sort_order` | The order to sort the games. This is used by the api and may change the results if the user has more games than the limit allows. | String (`Asc`, `Desc`)    | `Asc`   |
+
 ## Handling JSON data
 
 ### JSON keys
@@ -633,9 +699,10 @@ Default caching expiries:
 | Data source           | Expiry            |
 |-----------------------|-------------------|
 | `*` (default)         | 600 (10 minutes)  |
-| `userAvatarThumbnail` | 3600 (1 hour)     |
-| `groupData`           | 3600 (1 hour)     |
+| `assetThumbnail`      | 7200 (2 hours)    |
 | `badgeInfo`           | 1800 (30 minutes) |
+| `groupData`           | 3600 (1 hour)     |
+| `userAvatarThumbnail` | 3600 (1 hour)     |
 | `userId`              | 86400 (24 hours)  |
 | `userInfo`            | 86400 (24 hours)  |
 
@@ -653,8 +720,6 @@ $wgRobloxAPICachingExpiries = [
 ];
 ```
 
-In this example, all other data sources will have a cache expiry time of 60 seconds.
-
 ### `$wgRobloxAPIAllowedArguments`
 
 An array of allowed arguments per argument type. If empty, all arguments for the type are allowed. Any argument types

extension.json

@@ -1,6 +1,6 @@
 {
 	"name": "RobloxAPI",
-	"version": "1.3.0",
+	"version": "1.4.0",
 	"author": [
 		"SomeRandomDeveloper"
 	],
@@ -39,17 +39,20 @@
 				"assetDetails",
 				"groupRolesList",
 				"gameNameDescription",
-				"universeInfo"
+				"universeInfo",
+				"userGames",
+				"userPlaceVisits"
 			],
 			"merge_strategy": "provide_default",
 			"description": "The data sources that should be enabled and available."
 		},
 		"RobloxAPICachingExpiries": {
 			"value": {
 				"*": 600,
-				"userAvatarThumbnail": 3600,
-				"groupData": 3600,
+				"assetThumbnail": 7200,
 				"badgeInfo": 1800,
+				"groupData": 3600,
+				"userAvatarThumbnail": 3600,
 				"userId": 86400,
 				"userInfo": 86400
 			},
@@ -85,11 +88,15 @@
 	},
 	"HookHandlers": {
 		"RobloxAPIHooks": {
-			"class": "MediaWiki\\Extension\\RobloxAPI\\Hooks"
+			"class": "MediaWiki\\Extension\\RobloxAPI\\Hooks",
+			"services": [
+				"ConfigFactory"
+			]
 		}
 	},
 	"Hooks": {
-		"ParserFirstCallInit": "RobloxAPIHooks"
+		"ParserFirstCallInit": "RobloxAPIHooks",
+		"ParserTestGlobals": "RobloxAPIHooks"
 	},
 	"MessagesDirs": {
 		"RobloxAPI": [

i18n/en.json

@@ -24,5 +24,7 @@
 	"robloxapi-error-invalid-thumbnail-format": "Invalid thumbnail format '$1'! Possible values are 'Webp' and 'Png'.",
 	"robloxapi-error-invalid-boolean": "Invalid boolean value '$1'! Must be 'true' or 'false'.",
 	"robloxapi-error-invalid-return-policy": "Invalid return policy '$1'! Must be 'PlaceHolder', 'ForcePlaceHolder', 'AutoGenerated', or 'ForceAutoGenerated'.",
-	"robloxapi-error-too-many-required-args": "The argument '$1' exceeds the maximum number of required arguments for this data source! Please refer to the documentation."
+	"robloxapi-error-too-many-required-args": "The argument '$1' exceeds the maximum number of required arguments for this data source! Please refer to the documentation.",
+	"robloxapi-error-invalid-user-games-limit": "Invalid limit '$1'! Must be 10, 25 or 50.",
+	"robloxapi-error-invalid-sort-order": "Invalid sort order '$1'! Must be 'Asc' or 'Desc'."
 }

i18n/qqq.json

@@ -24,5 +24,7 @@
 	"robloxapi-error-invalid-thumbnail-format": "Error message shown when an invalid thumbnail format is provided. $1 is the invalid format. Possible values are 'Webp' and 'Png'",
 	"robloxapi-error-invalid-boolean": "Error message shown when an invalid boolean value is provided. $1 is the invalid value. Must be 'true' or 'false'",
 	"robloxapi-error-invalid-return-policy": "Error message shown when an invalid return policy is provided. $1 is the invalid policy. Must be 'PlaceHolder', 'ForcePlaceHolder', 'AutoGenerated', or 'ForceAutoGenerated'",
-	"robloxapi-error-too-many-required-args": "Error message shown when too many required arguments are provided to a data source. $1 is the argument that exceeds the maximum number of required arguments"
+	"robloxapi-error-too-many-required-args": "Error message shown when too many required arguments are provided to a data source. $1 is the argument that exceeds the maximum number of required arguments",
+	"robloxapi-error-invalid-user-games-limit": "Error message shown when an invalid limit is provided for the user games data source. $1 is the invalid limit. Must be 10, 25 or 50",
+	"robloxapi-error-invalid-sort-order": "Error message shown when an invalid sort order is provided. $1 is the invalid sort order. Must be 'Asc' or 'Desc'"
 }