Prepare v5.14.0

.example/options.json

@@ -446,6 +446,9 @@
         },
         "steamApis": {
             "enable": false
+        },
+        "expressLoad": {
+            "enable": false
         }
     },
     "discordChat": {

package.json

@@ -64,7 +64,7 @@
         "semver": "^7.7.2",
         "socket.io-client": "^4.8.1",
         "steam-totp": "^2.1.2",
-        "steam-user": "^5.2.2",
+        "steam-user": "^5.2.3",
         "steamid": "^2.1.0",
         "url": "^0.11.4",
         "valid-url": "^1.0.9",

src/classes/CommandParser.ts

@@ -17,7 +17,12 @@ export default class CommandParser {
 
     static parseParams(paramString: string): UnknownDictionaryKnownValues {
         const params: UnknownDictionaryKnownValues = parseJSON(
-            '{"' + paramString.replace(/"/g, '\\"').replace(/&/g, '","').replace(/=/g, '":"') + '"}'
+            '{"' +
+                paramString
+                    .replace(/"/g, '\\"')
+                    .replace(/&(?!&)(?=[^&=]+=[^&]*)/g, '","') // Split only valid key-value pairs
+                    .replace(/=/g, '":"') +
+                '"}'
         );
 
         const parsed: UnknownDictionaryKnownValues = {};

src/classes/Commands/Commands.ts

@@ -218,6 +218,8 @@ export default class Commands {
                 this.manager.TF2GCCommand(steamID, message, command as TF2GC);
             } else if (['name', 'avatar'].includes(command) && isAdmin) {
                 this.manager.nameAvatarCommand(steamID, message, command as NameAvatar, prefix);
+            } else if (command === 'changename' && isAdmin) {
+                this.manager.changeNameCommand(steamID, message, prefix);
             } else if (['block', 'unblock'].includes(command) && isAdmin) {
                 this.manager.blockUnblockCommand(steamID, message, command as BlockUnblock);
             } else if (['blockedlist', 'blocklist', 'blist'].includes(command) && isAdmin) {

src/classes/Commands/sub-classes/Help.ts

@@ -116,7 +116,7 @@ export default class HelpCommands {
                         `haltstatus - Get the info whether the bot is paused or not ⏯`,
                         `refreshautokeys - Refresh the bot's autokeys settings  `,
                         `refreshlist - Refresh sell listings 🔄`,
-                        `name <new_name> - Change the bot's name    `,
+                        `changeName name=<new_name> - Change the bot's name    `,
                         `avatar <image_URL> - Change the bot's avatar   `,
                         `donatebptf (sku|name|defindex)=<a>&amount=<integer> - Donate to backpack.tf (https://backpack.tf/donate) 💰`,
                         `premium months=<integer> - Purchase backpack.tf premium using keys (https://backpack.tf/premium/subscribe) 👑`,

src/classes/Commands/sub-classes/Manager.ts

@@ -245,30 +245,18 @@ export default class ManagerCommands {
             'https://steamcdn-a.akamaihd.net/steamcommunity/public/images/avatars/f5/f57685d33224e32436f366d1acb4a1769bdfa60f_full.jpg';
         const input = CommandParser.removeCommand(message);
 
-        if (!input || input === `!${command}`) {
-            return this.bot.sendMessage(
-                steamID,
-                `❌ You forgot to add ${command === 'name' ? 'a name' : 'an image url'}. Example: "!${
-                    command === 'name' ? 'name IdiNium' : `avatar ${example}`
-                } "`
-            );
-        }
-
         if (command === 'name') {
-            this.bot.community.editProfile(
-                {
-                    name: input
-                },
-                err => {
-                    if (err) {
-                        log.warn('Error while changing name: ', err);
-                        return this.bot.sendMessage(steamID, `❌ Error while changing name: ${err.message}`);
-                    }
-
-                    this.bot.sendMessage(steamID, '✅ Successfully changed name.');
-                }
+            this.bot.sendMessage(
+                steamID,
+                `The ${prefix}name command has been updated to ${prefix}changeName. Please use the new command going forward!`
             );
         } else {
+            if (!input || input === `!${command}`) {
+                return this.bot.sendMessage(
+                    steamID,
+                    `❌ You forgot to add an image url'. Example: "!${`avatar ${example}`} "`
+                );
+            }
             if (!validUrl.isUri(input)) {
                 return this.bot.sendMessage(steamID, `❌ Your url is not valid. Example: "${prefix}avatar ${example}"`);
             }
@@ -284,6 +272,41 @@ export default class ManagerCommands {
         }
     }
 
+    changeNameCommand(steamID: SteamID, message: string, prefix: string): void {
+        const params = CommandParser.parseParams(CommandParser.removeCommand(message));
+        const inputName = params.name as string;
+
+        if (inputName !== undefined) {
+            if (params.i_am_sure !== 'yes_i_am') {
+                return this.bot.sendMessage(
+                    steamID,
+                    `⚠️ Are you sure that you want to change your bot's name?` +
+                        `\nChanging the name will result in a trading cooldown for a few hours on your bot's account` +
+                        `\nIf yes, retry by sending ${prefix}changeName name=${inputName}&i_am_sure=yes_i_am`
+                );
+            } else {
+                this.bot.community.editProfile(
+                    {
+                        name: inputName
+                    },
+                    err => {
+                        if (err) {
+                            log.warn('Error while changing name: ', err);
+                            return this.bot.sendMessage(steamID, `❌ Error while changing name: ${err.message}`);
+                        }
+
+                        this.bot.sendMessage(steamID, '✅ Successfully changed name.');
+                    }
+                );
+            }
+        } else {
+            return this.bot.sendMessage(
+                steamID,
+                `⚠️ Missing name property. Example: "${prefix}changeName name=IdiNium`
+            );
+        }
+    }
+
     blockedListCommand(steamID: SteamID): void {
         if (this.isSendingBlockedList) {
             return;

src/classes/InventoryApis/ExpressLoad.ts

@@ -0,0 +1,24 @@
+import { UnknownDictionaryKnownValues } from 'src/types/common';
+import Bot from '../Bot';
+import InventoryApi from './InventoryApi';
+
+export default class ExpressLoad extends InventoryApi {
+    constructor(bot: Bot) {
+        super(bot, 'expressLoad');
+    }
+
+    protected getURLAndParams(
+        steamID: string,
+        appID: number,
+        contextID: string
+    ): [string, UnknownDictionaryKnownValues] {
+        return [`https://api.express-load.com/inventory/${steamID}/${appID}/${contextID}`, {}];
+    }
+
+    protected getHeaders(): UnknownDictionaryKnownValues {
+        return {
+            'X-API-KEY': this.getApiKey(),
+            'User-Agent': 'TF2Autobot'
+        };
+    }
+}

src/classes/InventoryApis/InventoryApi.ts

@@ -31,6 +31,11 @@ export default class InventoryApi {
         return ['', {}];
     }
 
+    // This method may be defined by a class extending InventoryAPI
+    protected getHeaders(): UnknownDictionaryKnownValues {
+        return {};
+    }
+
     // Adapted from node-steamcommunity
     public getUserInventoryContents(
         userID: SteamID | string,
@@ -58,6 +63,8 @@ export default class InventoryApi {
             return;
         }
 
+        const headers = this.getHeaders();
+
         let pos = 1;
         get([], []);
 
@@ -67,7 +74,8 @@ export default class InventoryApi {
                 params: {
                     ...apiCallParams,
                     start_assetid: start
-                }
+                },
+                headers: headers
             }).then(
                 response => {
                     const result = response.data as GetUserInventoryContentsResult;

src/classes/InventoryGetter.ts

@@ -2,6 +2,7 @@ import SteamID from 'steamid';
 import { EconItem } from '@tf2autobot/tradeoffer-manager';
 
 import Bot from './Bot';
+import ExpressLoad from './InventoryApis/ExpressLoad';
 import InventoryApi from './InventoryApis/InventoryApi';
 import SteamSupply from './InventoryApis/SteamSupply';
 import SteamApis from './InventoryApis/SteamApis';
@@ -10,7 +11,7 @@ export default class InventoryGetter {
     private readonly inventoryApis: InventoryApi[];
 
     constructor(private readonly bot: Bot) {
-        this.inventoryApis = [new SteamSupply(this.bot), new SteamApis(this.bot)];
+        this.inventoryApis = [new SteamSupply(this.bot), new SteamApis(this.bot), new ExpressLoad(this.bot)];
     }
 
     getUserInventoryContents(

src/classes/Options.ts

@@ -494,6 +494,9 @@ export const DEFAULTS: JsonOptions = {
         },
         steamApis: {
             enable: false
+        },
+        expressLoad: {
+            enable: false
         }
     },
 
@@ -1612,6 +1615,7 @@ interface ManualReview extends OnlyEnable {
 interface InventoryApis {
     steamSupply?: OnlyEnable;
     steamApis?: OnlyEnable;
+    expressLoad?: OnlyEnable;
 }
 
 // ------------ Discord Chat ---------------
@@ -2195,6 +2199,7 @@ export default interface Options extends JsonOptions {
     discordBotToken?: string;
     steamSupplyApiKey?: string;
     steamApisApiKey?: string;
+    expressLoadApiKey?: string;
 
     admins?: adminData[];
     keep?: string[];
@@ -2512,6 +2517,7 @@ export function loadOptions(options?: Options): Options {
         discordBotToken: getOption('discordBotToken', '', String, incomingOptions),
         steamSupplyApiKey: getOption('steamsupplyApiKey', '', String, incomingOptions),
         steamApisApiKey: getOption('steamapisApiKey', '', String, incomingOptions),
+        expressLoadApiKey: getOption('expressloadApiKey', '', String, incomingOptions),
 
         admins: getOption('admins', [], jsonParseAdminData, incomingOptions),
         keep: getOption('keep', [], jsonParseArray, incomingOptions),

src/classes/__tests__/CommandParser.ts

@@ -38,3 +38,17 @@ it('can parse item id commands', () => {
     const params = CommandParser.parseParams(CommandParser.removeCommand(message));
     expect(params).toEqual({ id: 10151297782, intent: 'sell', sell: { keys: 1 } });
 });
+
+it('can parse values with &', () => {
+    let message = '!changeName name=Buying spells & hats&i_am_sure=i_am_sure';
+    let params = CommandParser.parseParams(CommandParser.removeCommand(message));
+    expect(params).toEqual({ name: 'Buying spells & hats', i_am_sure: 'i_am_sure' });
+
+    message = `!test key1=value1&key2=value2&&key3=3`;
+    params = CommandParser.parseParams(CommandParser.removeCommand(message));
+    expect(params).toEqual({ key1: 'value1', key2: 'value2&', key3: 3 });
+
+    message = `!test key1=value1&key2=&value2&&key3=[value3]`;
+    params = CommandParser.parseParams(CommandParser.removeCommand(message));
+    expect(params).toEqual({ key1: 'value1', key2: '&value2&', key3: ['value3'] });
+});

src/schemas/options-json/options.ts

@@ -1525,9 +1525,12 @@ export const optionsSchema: jsonschema.Schema = {
                 },
                 steamApis: {
                     $ref: '#/definitions/only-enable'
+                },
+                expressLoad: {
+                    $ref: '#/definitions/only-enable'
                 }
             },
-            required: ['steamSupply', 'steamApis'],
+            required: ['steamSupply', 'steamApis', 'expressLoad'],
             additionalProperties: false
         },
         discordChat: {

template.ecosystem.json

@@ -28,6 +28,7 @@
                 "DISCORD_BOT_TOKEN": "",
                 "STEAMSUPPLY_API_KEY": "",
                 "STEAMAPIS_API_KEY": "",
+                "EXPRESSLOAD_API_KEY": "",
 
                 "ADMINS": [{ "steam": "<your steamid 64>", "discord": null }],
                 "KEEP": ["<steamid of person to keep in friendslist>"],

template.env

@@ -15,6 +15,7 @@ MPTF_API_KEY=""
 DISCORD_BOT_TOKEN=""
 STEAMSUPPLY_API_KEY=""
 STEAMAPIS_API_KEY=""
+EXPRESSLOAD_API_KEY=""
 
 ADMINS=[{ "steam": "<your steamid 64>", "discord": null }]
 KEEP=["<steamid of person to keep in friendslist>"]