screeps-connectivity 0.12.0 → 0.13.1

package/CHANGELOG.md

@@ -1,5 +1,34 @@
 # Changelog
 
+## 0.13.1
+
+### Patch Changes
+
+- 661a53f: Don't show the "Connection lost" modal after an intentional disconnect. A guest hitting Login (or any user logging out) tore the session down synchronously, but the socket's async `onclose` still fired `server:disconnected` with `willReconnect: false`, which re-raised a fatal session error over the login screen. The disconnected event now carries an `intentional` flag so the client can distinguish a user-initiated close from a genuinely lost connection.
+- 9bc39f8: History viewer fixes and a couple of supporting connectivity additions:
+
+  - Render terrain when reloading directly into history mode. Terrain loading was gated behind the room-subscription effect, which is skipped in history mode, so a fresh reload into a `#tick=` URL showed no terrain. Terrain/decoration loading now runs independently of history mode.
+  - Open the history view at the start of the previous, fully-written chunk instead of the current tick (whose chunk isn't flushed yet), avoiding an immediate 404 + fallback round-trip.
+  - Suppress the red failure toast when a history chunk is missing (404). `roomHistory` requests are now `silent`, and the viewer shows an in-room "No data available for this tick" hint instead, prompting the user to pick another tick from the timeline.
+  - During playback, skip to the start of the next chunk when the current chunk is missing, instead of re-fetching the same non-existent file on every tick.
+  - Expose `serverData.historyKeepTicks` (non-official field from the xxscreeps history mod) on the version types, used to size the history timeline's replayable range (falls back to a default window when absent).
+  - HTTP errors thrown by `HttpClient` now carry a `status` property so callers can distinguish a 404 from other failures.
+  - Dev-only: proxy `/room-history` to `VITE_PROXY_TARGET` in the Vite dev server.
+
+- 1e85697: Accept the xxscreeps `{ error: "actually, it was fine" }` sentinel (returned with status 200 by the `create-construction` route to signal success) as a successful response instead of throwing.
+
+## 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.1",
   "license": "ISC",
   "type": "module",
   "repository": {

package/src/http/HttpClient.ts

@@ -11,6 +11,12 @@ import { createRegisterEndpoints, type RegisterEndpoints } from './endpoints/reg
 import type { HttpClientEvents } from '../types/events.js'
 import type { Subscription } from '../subscription/index.js'
 
+/** xxscreeps' /api/game/create-construction route returns this in an { error }
+ *  field with status 200 to signal success. Official Screeps inserts the site
+ *  directly and returns an id, but xxscreeps returns this fake error and relies
+ *  on the room socket to show the site next tick. It is not a real error. */
+const XXSCREEPS_FALSE_ERROR = 'actually, it was fine'
+
 export interface RateLimitInfo {
   limit: number
   remaining: number
@@ -133,7 +139,8 @@ export class HttpClient extends EventTarget {
     if (!res.ok && res.status !== 304) {
       let body = ''
       try { body = await res.text() } catch { /* ignore */ }
-      const error = new Error(`HTTP ${res.status}: ${body}`)
+      const error = new Error(`HTTP ${res.status}: ${body}`) as Error & { status?: number }
+      error.status = res.status
       this.emit('http:error', { method, path, status: res.status, error, silent: opts.silent })
       throw error
     }
@@ -142,6 +149,13 @@ export class HttpClient extends EventTarget {
 
     const data = await res.json() as Record<string, unknown>
 
+    // xxscreeps' create-construction route returns { error: 'actually, it was
+    // fine' } with status 200 to signal success (see XXSCREEPS_FALSE_ERROR).
+    // Treat this sentinel as success, not an error.
+    if (data['error'] === XXSCREEPS_FALSE_ERROR) {
+      delete data['error']
+    }
+
     if (typeof data['error'] === 'string') {
       const error = new Error(`Screeps API error: ${data['error']}`)
       this.emit('http:error', { method, path, status: res.status, error, silent: opts.silent })

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/endpoints/game.ts

@@ -98,9 +98,11 @@ export function createGameEndpoints(http: HttpClient, decorationsMock?: ApiRoomD
     addObjectIntent: (id, room, name, intent, shard) => http.request('POST', '/api/game/add-object-intent', withShard({ _id: id, room, name, intent }, shard)),
     addGlobalIntent: (name, intent) => http.request('POST', '/api/game/add-global-intent', { name, intent }),
     roomHistory: (room, time, shard) =>
+      // silent: a missing chunk 404s while history is still being written; the caller
+      // handles that gracefully, so don't surface a global "request failed" toast.
       shard
-        ? http.request('GET', `/room-history/${encodeURIComponent(shard)}/${encodeURIComponent(room)}/${time}.json`)
-        : http.request('GET', '/room-history', { room, time }),
+        ? http.request('GET', `/room-history/${encodeURIComponent(shard)}/${encodeURIComponent(room)}/${time}.json`, undefined, { silent: true })
+        : http.request('GET', '/room-history', { room, time }, { silent: true }),
     setNotifyWhenAttacked: (id, enabled) => http.request('POST', '/api/game/set-notify-when-attacked', { _id: id, enabled }),
     createInvader: (room, x, y, size, type, boosted) => http.request('POST', '/api/game/create-invader', { room, x, y, size, type, ...(boosted != null ? { boosted } : {}) }),
     removeInvader: (id) => http.request('POST', '/api/game/remove-invader', { _id: id }),

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/socket/SocketClient.ts

@@ -79,7 +79,7 @@ export class SocketClient {
         this.authed = false
         this.authSub?.dispose()
         this.authSub = null
-        this.emit('disconnected', { willReconnect: this.reconnecting })
+        this.emit('disconnected', { willReconnect: this.reconnecting, intentional: this._intentionalClose })
         void this.scheduleReconnect()
       }
       this.ws.onerror = (err) => {

package/src/stores/ServerStore.ts

@@ -29,8 +29,8 @@ export class ServerStore extends TypedStore<ServerStoreEvents> {
       this.emit('server:connected', {})
     }))
     this.socketSubs.push(socket.on('disconnected', (data) => {
-      const d = data as { willReconnect: boolean }
-      this.emit('server:disconnected', { willReconnect: d.willReconnect })
+      const d = data as { willReconnect: boolean; intentional?: boolean }
+      this.emit('server:disconnected', { willReconnect: d.willReconnect, intentional: d.intentional ?? false })
     }))
     this.socketSubs.push(socket.on('socket:error', (data) => {
       this.emit('server:error', { error: data instanceof Error ? data : new Error(String(data)) })

package/src/types/api.ts

@@ -102,6 +102,13 @@ export interface ApiVersionResponse {
   users: number
   serverData: {
     historyChunkSize: number
+    /**
+     * Retention window for room history, in ticks. Non-official field added by the
+     * xxscreeps history mod. When present, the earliest replayable tick is roughly
+     * `currentTick - historyKeepTicks`; a value of `0` means history is kept forever
+     * (unbounded). Absent on servers without the mod.
+     */
+    historyKeepTicks?: number
     features: Array<{ name: string }>
     shards: string[]
     customObjectTypes?: unknown

package/src/types/events.ts

@@ -47,7 +47,7 @@ export interface UserStoreEvents {
 
 export interface ServerStoreEvents {
     'server:connected': Record<string, never>
-    'server:disconnected': { willReconnect: boolean }
+    'server:disconnected': { willReconnect: boolean; intentional: boolean }
     'server:error': { error: Error }
     'server:version': ServerVersion
     'server:shards': ShardInfo[]

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
@@ -133,6 +145,14 @@ export interface ServerVersion {
     users: number
     serverData: {
         historyChunkSize: number
+        /**
+         * Retention window for room history, in ticks. Non-official field added by the
+         * xxscreeps history mod. When present, the earliest replayable tick is roughly
+         * `currentTick - historyKeepTicks`; a value of `0` means history is kept forever
+         * (unbounded). Absent on servers without the mod — callers should fall back to a
+         * sensible default in that case.
+         */
+        historyKeepTicks?: number
         features: ServerFeature[]
         shards: Array<string | null>
         welcomeText?: string

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(() => {
@@ -195,6 +205,16 @@ describe('HttpClient', () => {
     await expect(http.request('GET', '/api/game/create-flag')).rejects.toThrow('Screeps API error: invalid params')
   })
 
+  it('treats the xxscreeps "actually, it was fine" sentinel as success', async () => {
+    fetchMock.mockResolvedValue(mockResponse({ error: 'actually, it was fine' }))
+    const http = new HttpClient({ url: 'http://test.local', auth: new TokenAuth({ token: 't' }) })
+    const errorHandler = vi.fn()
+    http.on('http:error', errorHandler)
+    const res = await http.request<{ error?: string }>('POST', '/api/game/create-construction')
+    expect(res.error).toBeUndefined()
+    expect(errorHandler).not.toHaveBeenCalled()
+  })
+
   it('emits http:error on 200 with error in response body', async () => {
     fetchMock.mockResolvedValue(mockResponse({ ok: 0, error: 'flags limit exceeded' }))
     const http = new HttpClient({ url: 'http://test.local', auth: new TokenAuth({ token: 't' }) })

package/tests/socket/SocketClient.test.ts

@@ -141,4 +141,15 @@ describe('SocketClient', () => {
     client.disconnect()
     expect(willReconnect).toBe(false)
   })
+
+  it('disconnected event is flagged intentional when disconnect() is called', async () => {
+    const client = makeClient()
+    const _ws = await connectClient(client)
+    let intentional: boolean | undefined
+    client.on('disconnected', (data) => {
+      intentional = (data as { intentional: boolean }).intentional
+    })
+    client.disconnect()
+    expect(intentional).toBe(true)
+  })
 })