screeps-connectivity 0.6.0 → 0.7.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.7.0
+
+### Minor Changes
+
+- 69d132d: Add an account Overview page (GCL/GPL rings, lifetime stats, per-room minimap previews) and a public Profile page with routing between them; optional dashboard endpoints (`user/overview`, `user/rooms`) now fail silently on servers that don't implement them.
+
 ## 0.6.0
 
 ### Minor Changes

package/package.json

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

package/src/http/HttpClient.ts

@@ -16,6 +16,14 @@ export interface RateLimitInfo {
   reset: number
 }
 
+export interface RequestOptions {
+  /** Internal: marks the post-auth retry so a second 401 doesn't loop. */
+  isRetry?: boolean
+  /** Suppress user-facing surfacing of failures (the http:error event carries the
+   *  flag through). Use for optional endpoints the caller handles gracefully. */
+  silent?: boolean
+}
+
 export class HttpClient extends EventTarget {
   readonly baseUrl: string
   private readonly authStrategy: AuthStrategy
@@ -79,7 +87,7 @@ export class HttpClient extends EventTarget {
     this.token = token
   }
 
-  async request<T>(method: string, path: string, body?: Record<string, unknown>, isRetry = false): Promise<T> {
+  async request<T>(method: string, path: string, body?: Record<string, unknown>, opts: RequestOptions = {}): Promise<T> {
     this.logger.log(method, path)
     const url = new URL(path.startsWith('/') ? path.slice(1) : path, this.baseUrl)
     const headers: Record<string, string> = {}
@@ -115,9 +123,9 @@ export class HttpClient extends EventTarget {
 
     this.updateRateLimit(path, res)
 
-    if (res.status === 401 && !isRetry && !this.authenticating) {
+    if (res.status === 401 && !opts.isRetry && !this.authenticating) {
       await this.authenticate()
-      return this.request<T>(method, path, body, true)
+      return this.request<T>(method, path, body, { ...opts, isRetry: true })
     }
 
     // 304: some servers (e.g. private Screeps) send a body with 304 — treat it as success
@@ -125,7 +133,7 @@ export class HttpClient extends EventTarget {
       let body = ''
       try { body = await res.text() } catch { /* ignore */ }
       const error = new Error(`HTTP ${res.status}: ${body}`)
-      this.emit('http:error', { method, path, status: res.status, error })
+      this.emit('http:error', { method, path, status: res.status, error, silent: opts.silent })
       throw error
     }
 
@@ -135,7 +143,7 @@ export class HttpClient extends EventTarget {
 
     if (typeof data['error'] === 'string') {
       const error = new Error(`Screeps API error: ${data['error']}`)
-      this.emit('http:error', { method, path, status: res.status, error })
+      this.emit('http:error', { method, path, status: res.status, error, silent: opts.silent })
       throw error
     }
 

package/src/http/endpoints/user.ts

@@ -3,6 +3,8 @@ import type {
   ApiUserBranchesResponse,
   ApiUserFindResponse,
   ApiUserMoneyHistoryResponse,
+  ApiUserOverviewResponse,
+  ApiUserRoomsResponse,
 } from '../../types/api.js'
 import { createUserMessagesEndpoints, type UserMessagesEndpoints } from './user-messages.js'
 
@@ -30,8 +32,8 @@ export interface UserEndpoints {
   }
   console(expression: string, shard?: string | null): Promise<unknown>
   stats(interval: number): Promise<unknown>
-  rooms(id: string): Promise<unknown>
-  overview(interval: number, statName: string): Promise<unknown>
+  rooms(id: string): Promise<ApiUserRoomsResponse>
+  overview(interval: number, statName: string): Promise<ApiUserOverviewResponse>
   worldStatus(): Promise<{ ok: number; status: 'normal' | 'lost' | 'empty' }>
   worldStartRoom(shard?: string | null): Promise<unknown>
   find(query: { username: string } | { id: string }): Promise<ApiUserFindResponse>
@@ -73,8 +75,11 @@ export function createUserEndpoints(http: HttpClient): UserEndpoints {
     },
     console: (expression, shard) => http.request('POST', '/api/user/console', withShard({ expression }, shard)),
     stats: (interval) => http.request('GET', '/api/user/stats', { interval }),
-    rooms: (id) => http.request('GET', '/api/user/rooms', { id }),
-    overview: (interval, statName) => http.request('GET', '/api/user/overview', { interval, statName }),
+    // Best-effort dashboard data: not every server implements these, and the
+    // Overview page degrades gracefully (zeros / no tiles), so a failure here
+    // shouldn't raise a user-facing error toast — mark them silent.
+    rooms: (id) => http.request('GET', '/api/user/rooms', { id }, { silent: true }),
+    overview: (interval, statName) => http.request('GET', '/api/user/overview', { interval, statName }, { silent: true }),
     worldStatus: () => http.request('GET', '/api/user/world-status'),
     worldStartRoom: (shard) => http.request('GET', '/api/user/world-start-room', withShard({}, shard)),
     find: (query) => http.request('GET', '/api/user/find', query as Record<string, unknown>),

package/src/index.ts

@@ -40,7 +40,7 @@ export type {
 
 export { fetchServerVersion, fetchAuthModInfo, checkUsername, checkEmail, registerUser, getServerFeature, getScreepsmodAuth } from './http/fetchServerVersion.js'
 export type { ApiAuthModInfoResponse } from './http/fetchServerVersion.js'
-export type { RoomHistoryChunk, ApiRoomDecorationsResponse, ApiRoomDecorationItem, ApiRoomDecorationDef, ApiRoomDecorationGraphic, ApiRoomDecorationActive } from './types/api.js'
+export type { RoomHistoryChunk, ApiRoomDecorationsResponse, ApiRoomDecorationItem, ApiRoomDecorationDef, ApiRoomDecorationGraphic, ApiRoomDecorationActive, ApiUserOverviewResponse, ApiUserOverviewTotals, ApiUserRoomsResponse } from './types/api.js'
 export { ROOM_DECORATIONS_MOCK } from './mocks/roomDecorations.js'
 
 export { badgeToSvg } from './badge/index.js'

package/src/types/api.ts

@@ -21,11 +21,38 @@ export interface ApiAuthMeResponse {
   username: string
   cpu: number
   gcl: number
+  /** Raw accumulated power points; Global Power Level derives from this. Absent on servers without the power system. */
+  power?: number
   credits: number
   badge: import('./game.js').Badge
   password: boolean
 }
 
+/** Per-stat lifetime totals over the requested interval — the values behind the Overview stat tiles. Individual fields may be absent on servers that don't track that stat. */
+export interface ApiUserOverviewTotals {
+  energyControl?: number
+  energyHarvested?: number
+  energyConstruction?: number
+  energyCreeps?: number
+  creepsProduced?: number
+  creepsLost?: number
+  powerProcessed?: number
+}
+
+/** Response of GET /api/user/overview. Only `totals` is consumed by the Overview tiles; per-room time series (shards/stats) are omitted until the room band is built. */
+export interface ApiUserOverviewResponse {
+  ok: number
+  totals?: ApiUserOverviewTotals
+  statsMax?: number
+}
+
+/** Response of GET /api/user/rooms?id=<userId> — the rooms a user owns. Multishard servers key by shard; single-shard servers may return a flat list. */
+export interface ApiUserRoomsResponse {
+  ok: number
+  shards?: Record<string, string[]>
+  rooms?: string[]
+}
+
 export interface ApiAuthQueryTokenResponse {
   ok: number
   token: { full: boolean }

package/src/types/events.ts

@@ -68,6 +68,9 @@ export interface HttpClientEvents {
         path: string
         status: number
         error: Error
+        // Set when the request opted out of user-facing error surfacing (e.g. an
+        // optional endpoint whose failure the caller handles gracefully).
+        silent?: boolean
     }
     'http:tokenRefresh': {
         token: string

package/src/types/game.ts

@@ -66,6 +66,8 @@ export interface UserInfo {
     email: string
     cpu: number
     gcl: number
+    /** Raw accumulated power points; Global Power Level derives from this. Absent on servers without the power system. */
+    power?: number
     credits: number
     badge: Badge
     /** True when the account has a password set. Absent for password-less accounts (e.g. Steam-only logins). Only present for the authenticated user's own info. */