Fixed tag fetching, now requires Steam login (#60)

Author: NikkelM

README.md

@@ -48,6 +48,14 @@ The schema can be found in the `config.schema.json` file and used within your `c
 
 *NOTE: The script will test your provided `config.json` against this schema, so make sure your configuration is valid.*
 
+Note that *only if* you want to fetch tag data, Steam requires you to be authenticated with your Steam account.
+For this, provide your Steam account name and password in the `steamUser` property of the configuration file.
+The integration does not transmit this data over the internet, everything is done locally.
+If you have Steam Guard enabled, you will also need to provide the Steam Guard code when running the integration.
+
+Once you have authenticated once, the integration will store a local refresh token for ~200 days before you need to log in again.
+You can then replace the `accountName` and `password` with the `useRefreshToken` property set to `true`, which will make the integration use the stored refresh token to authenticate you to the Steam API.
+
 ### Properties
 
 The following is a list of all configuration items, their defaults and the values they can take.
@@ -114,6 +122,18 @@ If true, the integration will always update entries in the Notion database that
 | `boolean` | `false` | `true` or `false` | No |
 </details>
 
+<details>
+<summary><code>steamUser</code></summary>
+
+Login details to authenticate to your Steam account. This is required to be able to fetch tag data. If you have Steam Guard enabled, you will need to provide the Steam Guard code when running the app. Once logged in, the integration will store a local refresh token for ~200 days before you need to log in again. The integration does not transmit any of your login details anywhere, they are used internally to authenticate yourself to the Steam API. If you do not want to fetch tag data, you do not need to provide this property!
+
+| Type | Default value | Possible values | Required |
+|---|---|---|---|
+| `useRefreshToken` | `true` | `true` only | Yes, if you want to use an already stored refresh token. This requires a previous login using `accountName` and `password`. |
+| `accountName` | `<steamAccountName>` | Your Steam account name | Yes, if you do not already have a stored refresh token and set `useRefreshToken` to `true`. |
+| `password` | `<steamAccountPassword>` | Your Steam account password | Yes, if you do not already have a stored refresh token and set `useRefreshToken` to `true`. |
+</details>
+
 <details>
 <summary><code>gameProperties</code></summary>
 
@@ -143,7 +163,8 @@ Which game properties should be fetched when a new Steam game is detected, and t
 	},
 	"tags": {
 		"enabled": true,
-		"notionProperty": "Tags"
+		"notionProperty": "Tags",
+		"tagLanguage": "english"
 	}
 }
 ```
@@ -347,7 +368,7 @@ The name of the Notion property to set the user review score in.
 <details>
 <summary><code>tags</code></summary>
 
-The user-defined tags of the game as they can be seen on the store page. The database field in Notion must be of type `Multi-select`.
+Requires Steam login! Provide accountName and password in the top-level `steamUser` property! The user-defined tags of the game as they can be seen on the store page. The database field in Notion must be of type `Multi-select`.
 
 | Type | Default value | Possible values | Required |
 |---|---|---|---|
@@ -357,7 +378,7 @@ The user-defined tags of the game as they can be seen on the store page. The dat
 "tags": {
 	"enabled": true,
 	"notionProperty": "Tags",
-	"language": "english"
+	"tagLanguage": "english"
 }
 ```
 
@@ -379,13 +400,13 @@ The name of the Notion property to set the tags in. This field must be of type `
 |---|---|---|---|
 | `string` | `"Tags"` | A valid Notion property name | Yes |
 
-<h4><code>language</code></h4>
+<h4><code>tagLanguage</code></h4>
 
 The language of the tags, e.g. "english" or "spanish".
 
 | Type | Default value | Possible values | Required |
 |---|---|---|---|
-| `string` | `"english"` | Valid language names. Invalid names return an error from the Steam API. | Yes |
+| `string` | `"english"` | Valid full language names. Invalid names return an error from the Steam API. | Yes |
 
 </details>
 

config.default.json

@@ -6,6 +6,10 @@
 	"steamAppIdProperty": "Steam App ID",
 	"forceReset": false,
 	"alwaysUpdate": false,
+	"steamUser": {
+		"accountName": "<steamAccountName>",
+		"password": "<steamPassword>"
+	},
 	"gameProperties": {
 		"gameName": {
 			"enabled": true,

config.schema.json

@@ -41,6 +41,50 @@
 			"type": "boolean",
 			"default": false
 		},
+		"steamUser": {
+			"description": "Login details to authenticate to your Steam account. This is required to be able to fetch tag data. If you have Steam Guard enabled, you will need to provide the Steam Guard code when running the app. Once logged in, the integration will store a local refresh token for ~200 days before you need to log in again. The integration does not transmit any of your login details anywhere, they are used internally to authenticate yourself to the Steam API. If you do not want to fetch tag data, you do not need to provide this property!",
+			"type": "object",
+			"default": {
+				"accountName": "<steamAccountName>",
+				"password": "<steamAccountPassword>"
+			},
+			"additionalProperties": false,
+			"properties": {
+				"useRefreshToken": {
+					"description": "If true, the integration will try to use the refresh token stored in the local database to authenticate to your Steam account. You can only set this to \"true\" if you have previously logged in using \"accountName\" and \"password\", and the refresh token is still valid.",
+					"type": "boolean",
+					"default": false
+				},
+				"accountName": {
+					"description": "Your Steam account name.",
+					"type": "string",
+					"default": "<steamAccountName>"
+				},
+				"password": {
+					"description": "Your Steam account password.",
+					"type": "string",
+					"default": "<steamAccountPassword>"
+				}
+			},
+			"oneOf": [
+				{
+					"required": [
+						"accountName",
+						"password"
+					]
+				},
+				{
+					"properties": {
+						"useRefreshToken": {
+							"const": true
+						}
+					},
+					"required": [
+						"useRefreshToken"
+					]
+				}
+			]
+		},
 		"gameProperties": {
 			"description": "Which game properties should be fetched when a new Steam game is detected, and the name of the corresponding field in the Notion database.",
 			"type": "object",
@@ -69,7 +113,8 @@
 				},
 				"tags": {
 					"enabled": true,
-					"notionProperty": "Tags"
+					"notionProperty": "Tags",
+					"tagLanguage": "english"
 				},
 				"gameDescription": {
 					"enabled": true,
@@ -227,30 +272,30 @@
 							"type": "string",
 							"default": "percentage",
 							"oneOf": [
-									{
-										"const": "percentage",
-										"title": "Notion database field type: \"Number\". A percentage value formatted as a float from 0.00-1.00."
-									},
-									{
-										"const": "sentiment",
-										"title": "Notion database field type: \"Select\". A sentiment value such as \"Overwhelmingly Positive\" or \"Mixed\"."
-									},
-									{
-										"const": "total",
-										"title": "Notion database field type: \"Number\". The total number of reviews submitted for the game, across all languages."
-									},
-									{
-										"const": "positive",
-										"title": "Notion database field type: \"Number\". The total number of positive reviews submitted for the game, across all languages."
-									},
-									{
-										"const": "negative",
-										"title": "Notion database field type: \"Number\". The total number of negative reviews submitted for the game, across all languages."
-									},
-									{
-										"const": "positive/negative",
-										"title": "Notion database field type: \"Text\". The total number of positive and negative reviews submitted for the game, across all languages, formatted as \"{numPositive} positive / {numNegative} negative\"."
-									}
+								{
+									"const": "percentage",
+									"title": "Notion database field type: \"Number\". A percentage value formatted as a float from 0.00-1.00."
+								},
+								{
+									"const": "sentiment",
+									"title": "Notion database field type: \"Select\". A sentiment value such as \"Overwhelmingly Positive\" or \"Mixed\"."
+								},
+								{
+									"const": "total",
+									"title": "Notion database field type: \"Number\". The total number of reviews submitted for the game, across all languages."
+								},
+								{
+									"const": "positive",
+									"title": "Notion database field type: \"Number\". The total number of positive reviews submitted for the game, across all languages."
+								},
+								{
+									"const": "negative",
+									"title": "Notion database field type: \"Number\". The total number of negative reviews submitted for the game, across all languages."
+								},
+								{
+									"const": "positive/negative",
+									"title": "Notion database field type: \"Text\". The total number of positive and negative reviews submitted for the game, across all languages, formatted as \"{numPositive} positive / {numNegative} negative\"."
+								}
 							]
 						},
 						"notionProperty": {
@@ -266,7 +311,7 @@
 					]
 				},
 				"tags": {
-					"description": "The user-defined tags of the game as they can be seen on the store page. The database field in Notion must be of type \"Multi-select\".",
+					"description": "Requires Steam login! Provide \"accountName\" and \"password\" in the top-level \"steamUser\" property, \"refreshToken\" if you already logged in before! The user-defined tags of the game as they can be seen on the store page. The database field in Notion must be of type \"Multi-select\".",
 					"type": "object",
 					"default": {
 						"enabled": true,
@@ -456,5 +501,29 @@
 		"updateInterval",
 		"steamAppIdProperty",
 		"gameProperties"
+	],
+	"allOf": [
+		{
+			"if": {
+				"properties": {
+					"gameProperties": {
+						"properties": {
+							"tags": {
+								"properties": {
+									"enabled": {
+										"const": true
+									}
+								}
+							}
+						}
+					}
+				}
+			},
+			"then": {
+				"required": [
+					"steamUser"
+				]
+			}
+		}
 	]
 }

index.js

@@ -93,7 +93,7 @@ async function updateNotionDatabase() {
 				// Get info about the game's review score from the reviews API, if required
 				const appInfoReviews = reviewAPIRequired
 					? await getSteamReviewScoreDirect(steamAppId)
-					: null; 
+					: null;
 
 				let notionProperties = await getGameProperties(appInfoDirect, appInfoSteamUser[steamAppId], appInfoReviews, steamAppId);
 
@@ -106,7 +106,7 @@ async function updateNotionDatabase() {
 			}
 		}
 	}
-	
+
 	// Only update the last updated time if there were no errors during execution and we didn't hit the Steam API request limit
 	// This makes sure that we can find the games that had errors or that we had to omit again the next time
 	if (!hadError && !hitSteamAPILimit) {
@@ -124,4 +124,4 @@ async function updateNotionDatabase() {
 		// Run this method again in `updateInterval` milliseconds
 		setTimeout(main, updateInterval);
 	}
-}
+}

js/steamAPI.js

@@ -1,9 +1,40 @@
 import SteamUser from 'steam-user';
+import { CONFIG, addRefreshTokenToLocalDatabase, getRefreshTokenFromLocalDatabase, steamUserLoginRequired } from './utils.js';
 
 // ---------- Steam API ----------
 
-let steamClient = new SteamUser();
-steamClient.logOn();
+let steamUserConfig = {};
+
+if (steamUserLoginRequired) {
+	let refreshToken = await getRefreshTokenFromLocalDatabase();
+	if (refreshToken) {
+		steamUserConfig = {
+			refreshToken: refreshToken,
+		};
+	} else
+	if (CONFIG.steamUser.accountName && CONFIG.steamUser.password) {
+		steamUserConfig = {
+			accountName: CONFIG.steamUser.accountName,
+			password: CONFIG.steamUser.password,
+		}
+	} else {
+		console.error("\"steamUser.useRefreshToken\" was provided in the config, but no refresh token found in local database. \"steamUser.accountName\" and \"steamUser.password\" are required in the config, but they were not provided!");
+		process.exit(1);
+	}
+} else {
+	steamUserConfig = {
+		anonymous: true
+	};
+}
+
+let steamClient = new SteamUser({ renewRefreshTokens: true });
+
+steamClient.on('refreshToken', async function (refreshToken) {
+	await addRefreshTokenToLocalDatabase(refreshToken);
+});
+
+console.log("Logging in to Steam", steamUserConfig.anonymous ? "anonymously..." : (steamUserConfig.accountName ? `as ${steamUserConfig.accountName}...` : "using a refresh token..."));
+steamClient.logOn(steamUserConfig);
 await new Promise(resolve => steamClient.on('loggedOn', resolve));
 
 // Gets app info directly from the Steam store API
@@ -54,13 +85,13 @@ export async function getSteamAppInfoSteamUser(appIds) {
 // Gets the current review score data for a game from the Steam reviews API
 export async function getSteamReviewScoreDirect(appId) {
 	const result = await fetch(`https://store.steampowered.com/appreviews/${appId}?json=1&language=all`)
-	.then(response => response.json())
-	.then(data => {
-		if (data?.success) {
-			return data.query_summary;
-		}
-		return null;
-	});
+		.then(response => response.json())
+		.then(data => {
+			if (data?.success) {
+				return data.query_summary;
+			}
+			return null;
+		});
 
 	return result;
 }
@@ -77,10 +108,10 @@ export async function getSteamTagNames(storeTags, tagLanguage) {
 			const result = Object.keys(response.tags).map(function (key) {
 				return response.tags[key].name;
 			});
-	
+
 			resolve(result);
 		} catch (error) {
-			console.log("Retrieving tag names failed. The most likely cause is that the language you provided is invalid and does not yield any results from the Steam API.");
+			console.log("Retrieving tag names failed! The most likely cause is that you have not provided the \"steamUser\" property and are not authenticated, or the provided \"tagLanguage\" is invalid.");
 			resolve(["Retrieving tags failed"]);
 		}
 	});