feat: add mapping userid <-> steamid

Author: niekcandaele

lib/handleSteamId.ts

@@ -0,0 +1,30 @@
+/**
+ * A20 introduces more platforms, which means player IDs can be a bit wonky. 
+ */
+export function handleSteamId(data: Record<string, any> | Array<Record<string, any>>): Record<string, any> {
+
+  if (Array.isArray(data)) {
+    return data.map(handleSteamId);
+  }
+
+  if (data.players && Array.isArray(data.players)) {
+    return {
+      ...data,
+      players: data.players.map(handleSteamId)
+    };
+  }
+
+  const newData = { ...data };
+
+  if (data.userid && data.userid.includes('Steam_')) {
+    newData.steamid = data.userid.replace('Steam_', '');
+    newData.userid = data.userid;
+  }
+
+  if (data.steamid && data.steamid.includes('Steam_')) {
+    newData.steamid = newData.steamid.replace('Steam_', '');
+    newData.userid = newData.steamid;
+  } 
+
+  return newData;
+}

lib/index.ts

@@ -2,6 +2,7 @@ import fetch, { RequestInit } from 'node-fetch';
 import { stringify } from 'qs';
 import { ParsedUrlQueryInput } from 'querystring';
 
+import { handleSteamId } from './handleSteamId';
 import * as responses from './responses';
 
 export interface SdtdServer {
@@ -43,7 +44,7 @@ async function fetchJson(server: SdtdServer, url: string, qs: ParsedUrlQueryInpu
     }).then(response => {
         const contentType = response.headers.get("content-type");
         if (contentType && contentType.indexOf("application/json") !== -1) {
-            return response.json();
+            return response.json().then(handleSteamId);
         } else {
             return response.text();
         }
@@ -82,7 +83,7 @@ export async function getPlayerInventory(server: SdtdServer, steamId: string, fe
     return fetchJson(server, `/api/getplayerinventory`, { adminuser: server.adminUser,admintoken: server.adminToken, steamid: steamId, userid: `Steam_${steamId}` }, fetchOpts);
 }
 
-export async function getPlayerInventories(server: SdtdServer, fetchOpts?: RequestInit): Promise<responses.GetLog> {
+export async function getPlayerInventories(server: SdtdServer, fetchOpts?: RequestInit): Promise<Array<responses.InventoryResponse>> {
     return fetchJson(server, `/api/getplayerinventories`, { adminuser: server.adminUser,admintoken: server.adminToken }, fetchOpts);
 }
 

lib/responses.ts

@@ -19,6 +19,7 @@ export interface Position {
 
 export interface OnlinePlayerResponse {
     steamid: string,
+    userid: string,
     entityid: number,
     ip: string,
     name: string,
@@ -72,6 +73,8 @@ export interface CommandEntry {
 
 export interface InventoryResponse {
     playername: string,
+    userid: string,
+    steamid: string,
     bag: Array<any>, // eslint-disable-line
     belt: Array<any>, // eslint-disable-line
     equipment: PlayerEquipment
@@ -115,6 +118,7 @@ export interface PlayerNotOnline {
 
 export interface PlayerLocation {
     steamid: string,
+    userid: string,
     name: string,
     online: boolean,
     position: Position

test/getOnlinePlayers.test.ts

@@ -17,6 +17,8 @@ describe('/api/getOnlinePlayers', async () => {
             const playerStats = response[0];
 
             chai.expect(playerStats.steamid).to.be.a('string').and.to.be.not.empty;
+            chai.expect(playerStats.steamid).to.not.contain('Steam_');
+            chai.expect(playerStats.userid).to.be.a('string').and.to.be.not.empty;
             chai.expect(playerStats.name).to.be.a('string').and.to.be.not.empty;
             chai.expect(playerStats.entityid).to.be.a('number').and.to.be.not.equal(0);
         }

test/getPlayerInventories.test.ts

@@ -1,11 +1,23 @@
 'use strict';
-import g from './_globals';
 import * as chai from 'chai';
-import { getPlayerInventories } from '../lib/index';
+
+import { getPlayerInventories } from '../lib';
+import g from './_globals';
 
 describe('/api/getPlayerInventories', async () => {
     it('Returns expected info', async () => {
         const response = await getPlayerInventories(g.getTestServer());
         chai.expect(response).to.be.a('array');
+        chai.expect(response).to.have.length(1);
+
+        for (const player of response) {
+            chai.expect(player.playername).to.be.a('string');
+            chai.expect(player.steamid).to.be.a('string');
+            chai.expect(player.steamid).to.not.contain('Steam_');
+            chai.expect(player.bag).to.be.a('array');
+            chai.expect(player.belt).to.be.a('array');
+        }
+
+
     });
 });

test/getPlayerInventory.test.ts

@@ -1,12 +1,15 @@
 'use strict';
-import g from './_globals';
 import * as chai from 'chai';
-import { getPlayerInventory } from '../lib/index';
+
+import { getPlayerInventory } from '../lib';
+import g from './_globals';
 
 describe('/api/getPlayerInventory', async () => {
     it('Returns a playername, bag, belt and equipment', async () => {
         const response = await getPlayerInventory(g.getTestServer(), process.env.TESTPLAYER as string);
         chai.expect(response.playername).to.be.a('string');
+        chai.expect(response.steamid).to.be.a('string');
+        chai.expect(response.steamid).to.not.contain('Steam_');
         chai.expect(response.bag).to.be.a('array');
         chai.expect(response.belt).to.be.a('array');
     });

test/getPlayerList.test.ts

@@ -1,7 +1,8 @@
 'use strict';
-import g from './_globals';
 import * as chai from 'chai';
-import { getPlayerList } from '../lib/index';
+
+import { getPlayerList } from '../lib';
+import g from './_globals';
 
 describe('/api/getPlayerList', async () => {
     it('Returns expected output', async () => {
@@ -10,6 +11,15 @@ describe('/api/getPlayerList', async () => {
         chai.expect(response.totalUnfiltered).to.be.a('number');
         chai.expect(response.firstResult).to.be.a('number');
         chai.expect(response.players).to.be.a('array');
+        chai.expect(response.players).to.have.lengthOf(response.total);
+        chai.expect(response.players).to.have.lengthOf(1);
+
+        for (const player of response.players) {
+            chai.expect(player.name).to.be.a('string');
+            chai.expect(player.steamid).to.be.a('string');
+            chai.expect(player.steamid).to.not.contain('Steam_');
+        }
+
     });
     it('Limits response if rowsPerPage is given', async () => {
         const response = await getPlayerList(g.getTestServer(), 1);

test/getPlayersLocation.test.ts

@@ -1,7 +1,8 @@
 'use strict';
-import g from './_globals';
 import * as chai from 'chai';
-import { getPlayersLocation } from '../lib/index';
+
+import { getPlayersLocation } from '../lib';
+import g from './_globals';
 
 
 describe('/api/getPlayersLocation', async () => {
@@ -13,8 +14,13 @@ describe('/api/getPlayersLocation', async () => {
         const response = await getPlayersLocation(g.getTestServer(), true);
         chai.expect(response).to.be.a('array');
         chai.expect(response).to.have.length.greaterThan(0);
-        chai.expect(response[0].steamid).to.be.a("string");
-        chai.expect(response[0].name).to.be.a("string");
-        chai.expect(response[0].online).to.be.a("boolean");
+
+        for (const player of response) {
+            chai.expect(player.steamid).to.be.a("string");
+            chai.expect(player.steamid).to.not.contain('Steam_');
+            chai.expect(player.userid).to.be.a("string");
+            chai.expect(player.name).to.be.a("string");
+            chai.expect(player.online).to.be.a("boolean");
+        }
     });
 });