screeps-connectivity 0.12.0 → 0.13.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 0.13.0
+
+### Minor Changes
+
+- 94a6658: Add Discord OAuth login: getDiscordFeature() helper in screeps-connectivity, and a "Login with Discord" button in the web and desktop login forms.
+
+### Patch Changes
+
+- 46b5e2d: Fix Steam/password logins silently expiring after ~5 minutes on screepsmod-auth servers. These logins reconnect via a rotating, TTL-limited session token, but `TokenAuth` was hard-coded to ignore the server-issued `X-Token`, so the client kept replaying the original token until the server expired it — surfacing as a sudden `401` on `/api/user/world-status` (and every other authed request) even while actively using the client.
+
+  `TokenAuth` now accepts `supportsTokenRefresh` (default `false`, preserving durable personal-API-token behavior). The client enables it for Steam/password-derived session tokens so the rotated `X-Token` is adopted on every response, keeping the session alive.
+
 ## 0.12.0
 
 ### Minor Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "screeps-connectivity",
-  "version": "0.12.0",
+  "version": "0.13.0",
   "license": "ISC",
   "type": "module",
   "repository": {

package/src/http/auth/TokenAuth.ts

@@ -2,11 +2,19 @@ import type { AuthStrategy } from './AuthStrategy.js'
 import type { HttpClient } from '../HttpClient.js'
 
 export class TokenAuth implements AuthStrategy {
-  readonly supportsTokenRefresh = false
+  readonly supportsTokenRefresh: boolean
   private readonly token: string
 
-  constructor(opts: { token: string }) {
+  /**
+   * @param opts.supportsTokenRefresh Set true when the token is a rotating,
+   *   TTL-limited session token (e.g. obtained from a screepsmod-auth steam/password
+   *   exchange) so the client adopts the server-issued `X-Token` and the session
+   *   stays alive. Leave false (default) for a durable personal API token, which
+   *   must never be replaced by a server-issued token.
+   */
+  constructor(opts: { token: string; supportsTokenRefresh?: boolean }) {
     this.token = opts.token
+    this.supportsTokenRefresh = opts.supportsTokenRefresh ?? false
   }
 
   async authenticate(_http: HttpClient): Promise<string> {

package/src/http/fetchServerVersion.ts

@@ -1,5 +1,5 @@
 import type { ServerVersion } from '../types/game.js'
-import type { ScreepsmodAuthFeature, ServerFeature, XxscreepsModClientFeature } from '../types/game.js'
+import type { DiscordFeature, ScreepsmodAuthFeature, ServerFeature, XxscreepsModClientFeature } from '../types/game.js'
 import type { ApiAuthMeResponse, ApiAuthModInfoResponse, ApiRegisterCheckResponse } from '../types/api.js'
 import { getFetch } from './fetchFn.js'
 
@@ -193,3 +193,16 @@ export function getScreepsmodAuth(version: ServerVersion): ScreepsmodAuthFeature
 export function getXxscreepsModClientFeature(version: ServerVersion): XxscreepsModClientFeature | undefined {
   return getServerFeature<XxscreepsModClientFeature>(version, 'xxscreeps-mod-client')
 }
+
+/**
+ * Returns the `discord` feature entry (published by `xxscreeps-mod-discord`) if
+ * present, otherwise `undefined`. Use `discordLogin` to gate the "Login with
+ * Discord" button before showing it.
+ *
+ * @example
+ * const discord = getDiscordFeature(version)
+ * if (discord?.discordLogin) showDiscordButton()
+ */
+export function getDiscordFeature(version: ServerVersion): DiscordFeature | undefined {
+  return getServerFeature<DiscordFeature>(version, 'discord')
+}

package/src/index.ts

@@ -33,6 +33,7 @@ export type {
   ServerFeature,
   ScreepsmodAuthFeature,
   XxscreepsModClientFeature,
+  DiscordFeature,
   ShardInfo,
   WorldInfo,
   Badge,
@@ -41,7 +42,7 @@ export type {
   MapVisualEntry,
 } from './types/game.js'
 
-export { fetchServerVersion, fetchAuthModInfo, checkUsername, checkEmail, registerUser, fetchAuthMeWithToken, completeProviderRegistration, getServerFeature, getScreepsmodAuth, getXxscreepsModClientFeature } from './http/fetchServerVersion.js'
+export { fetchServerVersion, fetchAuthModInfo, checkUsername, checkEmail, registerUser, fetchAuthMeWithToken, completeProviderRegistration, getServerFeature, getScreepsmodAuth, getXxscreepsModClientFeature, getDiscordFeature } from './http/fetchServerVersion.js'
 export type { ApiAuthModInfoResponse } from './http/fetchServerVersion.js'
 export type { ApiAuthMeResponse, RoomHistoryChunk, ApiRoomDecorationsResponse, ApiRoomDecorationItem, ApiRoomDecorationDef, ApiRoomDecorationGraphic, ApiRoomDecorationActive, ApiUserOverviewResponse, ApiUserOverviewTotals, ApiUserRoomsResponse, ApiUserStatsResponse, ApiLeaderboardFindResponse, ApiUserMoneyHistoryResponse, ApiMarketOrder, ApiMarketOrdersIndexResponse, ApiMarketOrdersResponse, ApiMarketMyOrdersResponse, ApiMarketStat, ApiMarketStatsResponse, ApiPowerCreep, ApiPowerCreepsListResponse, ApiUserMessage, ApiUserMessagesListResponse, ApiUserMessagesIndexEntry, ApiUserMessagesIndexResponse, ApiUserMessagesUnreadCountResponse, ApiUserFindResponse } from './types/api.js'
 export { ROOM_DECORATIONS_MOCK } from './mocks/roomDecorations.js'

package/src/types/game.ts

@@ -125,6 +125,18 @@ export interface XxscreepsModClientFeature extends ServerFeature {
     steamLogin: boolean
 }
 
+/**
+ * Published by `xxscreeps-mod-discord` at `/api/version` when Discord login is
+ * configured. `discordLogin` gates the UI; `loginUrl` is the OAuth entry point
+ * (a popup navigates there to start the flow).
+ */
+export interface DiscordFeature extends ServerFeature {
+    name: 'discord'
+    version: number
+    discordLogin: boolean
+    loginUrl: string
+}
+
 export interface ServerVersion {
     ok: number
     package: number

package/tests/http/HttpClient.test.ts

@@ -98,6 +98,16 @@ describe('HttpClient', () => {
     expect(http.token).toBe('my-static-token')
   })
 
+  it('DOES update token from x-token header when TokenAuth opts into refresh (session token)', async () => {
+    fetchMock.mockResolvedValue(mockResponse({ ok: 1 }, {
+      headers: { 'content-type': 'application/json', 'x-token': 'rotated' },
+    }))
+    const http = new HttpClient({ url: 'http://test.local', auth: new TokenAuth({ token: 'session-token', supportsTokenRefresh: true }) })
+    http.token = 'session-token'
+    await http.request('GET', '/api/version')
+    expect(http.token).toBe('rotated')
+  })
+
   it('retries once on 401 after re-authenticating', async () => {
     let calls = 0
     fetchMock.mockImplementation(() => {