@lgriffin/esi.ts 4.0.0 → 5.1.0

package/CHANGELOG.md

@@ -0,0 +1,174 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [5.1.0] - 2026-06-26
+
+### Added
+
+- **`noUncheckedIndexedAccess`** compiler flag — array/record indexing now returns `T | undefined`, catching unguarded index access at compile time
+- **`noImplicitReturns`** compiler flag — all function code paths must explicitly return a value
+- **`noImplicitOverride`** compiler flag — `override` keyword required when overriding base class methods
+- **`tsconfig.test.json`** — separate TypeScript config for tests, relaxing `noUncheckedIndexedAccess` for test utility patterns
+
+### Changed
+
+- `RateLimiter` token cost lookup inlined (removed unnecessary `Record` indirection)
+- Jest configs (`jest.unit.config.cjs`, `jest.integration.config.cjs`) now use `tsconfig.test.json`
+
+### Fixed
+
+- Unguarded indexed access in `ApiRequestHandler`, `CircuitBreaker`, `RateLimiter`, and `headersUtil`
+
+## [5.0.0] - 2026-06-26
+
+### Breaking Changes
+
+- **Removed `SovereigntyClient.getSovereigntyMap()`** — sunset ESI endpoint; use `getSovereigntySystems()` instead
+- **Removed `SovereigntyClient.getSovereigntyStructures()`** — sunset ESI endpoint; use `getSovereigntySystems()` instead
+
+### Added
+
+- **Dependabot** — automated weekly dependency update PRs with grouped ESLint and testing ecosystems
+- **CodeQL Analysis** — GitHub-native security scanning workflow
+- **Commitlint** — conventional commit message validation via husky hook
+- **Version consistency script** — `npm run validate:versions` checks `package.json` matches `constants.ts`
+- **`npm run check:all`** — comprehensive validation including ESI endpoint and version checks
+- Coverage and npm download badges in README
+- `.editorconfig`, `.nvmrc`, `CONTRIBUTING.md`, `SECURITY.md`
+- ClientRegistry test coverage for all 35 client types
+
+### Fixed
+
+- **POST body format** for asset and contact endpoints — request body was incorrectly structured
+- **POST body format** for `/universe/ids` and `/universe/names` — same issue
+- **Circuit breaker** now treats HTTP 420/429 rate-limit responses as failures
+- **configManager** uses `require.resolve` instead of `process.cwd()` fallback for reliable path resolution
+- **User-Agent version** — ESI requests were sending `esi.ts/3.4.0` instead of current version
+- **Compatibility date** — updated from `2025-12-16` to `2026-05-19` (Equinox)
+- TypeScript badge in README updated from 5.0+ to 6.0+
+
+### Removed
+
+- `src/TODO` — fully completed roadmap
+- `jest.improved.config.cjs` — dead config matching zero test files
+- `docs/` — generated TypeDoc output removed from git tracking (CI builds as artifact)
+- Unused `getHeaders` test helper
+
+### Changed
+
+- `package.json`: added `keywords`, `homepage`, `bugs` URLs, `files` includes README/LICENSE/CHANGELOG
+- Moved `docs/architecture.md` to `guides/ARCHITECTURE.md`
+- Updated `guides/TESTING.md` and `guides/DOCUMENTATION.md` to current state
+- Test coverage raised from 75% to 91%+
+
+### Dependencies
+
+- `@typescript-eslint/eslint-plugin`: 7.18.0 → 8.x
+- `@typescript-eslint/parser`: 7.18.0 → 8.x
+- `@types/node`: 18.x → 26.x
+- `@commitlint/cli`: 19.x → 21.x
+- `eslint-config-prettier`: 9.x → 10.x
+- `lint-staged`: 16.x → 17.x
+- `jest-junit`: 16.x → 17.x
+- GitHub Actions: checkout v4→v7, setup-node v4→v6, upload-artifact v4→v7, codeql-action v3→v4, gh-pages v3→v4, action-gh-release v1→v3
+
+## [4.1.1] - 2026-06-08
+
+### Changed
+
+- **TypeScript 5.9 → 6.0** — upgraded to TypeScript 6.0.3, the last version before the Go-based TS7 compiler
+- `tsconfig.json`: added explicit `moduleResolution: "bundler"` (TS6 changed the default from `node` to `bundler`)
+- `tsconfig.json`: added explicit `rootDir: "./src"` (TS6 requires this when emitting)
+- `tsconfig.json`: removed `esModuleInterop: true` (always-on in TS6)
+
+## [4.1.0] - 2026-06-08
+
+### Added
+
+- **Equinox ESI compliance** — new endpoints and types for the [Equinox expansion](https://developers.eveonline.com/blog/equinox-on-esi-structures-sovereignty-and-access-lists) (compatibility date 2026-05-19)
+- **`SovereigntyClient.getSovereigntySystems()`** — combined sovereignty systems route with separate ADM indices (`military_index`, `industry_index`, `strategic_index`), occupancy data, and anchored structures in a single response
+- **`SkyhooksClient`** — new domain client with `getSovereigntyHubs()`, `getOrbitalSkyhooks()`, and `getRaidableSkyhooks()` endpoints for Upwell sovereignty structures
+- **`MercenaryClient`** — new domain client with `getMercenaryDens()` and `getMercenaryTacticalOperations()` endpoints for mercenary content
+- **`AccessListsClient`** — new domain client with `getAccessList(id)` for reading access list (ACL) contents including character, corporation, and alliance entries
+- `TestDataFactory` methods for all new Equinox types: `createSovereigntySystem()`, `createSovereigntyHub()`, `createOrbitalSkyhook()`, `createRaidableSkyhook()`, `createMercenaryDen()`, `createMercenaryTacticalOperation()`, `createAccessListEntry()`
+- TDD and BDD test coverage for all new endpoints
+
+### Changed
+
+- `SovereigntyClient.getSovereigntyMap()` and `getSovereigntyStructures()` marked as deprecated — use `getSovereigntySystems()` instead
+- Domain client count increased from 32 to 35
+
+### Dependencies
+
+- `ts-jest`: 29.4.9 → 29.4.11
+- `eslint-plugin-prettier`: 5.5.5 → 5.5.6
+
+## [4.0.0] - 2026-05-15
+
+### Breaking Changes
+
+- **Removed `RateLimiter.getInstance()` singleton** - Create instances with `new RateLimiter()` instead
+- **Removed global cache/circuit breaker functions** - `initializeETagCache()`, `getETagCache()`, `resetETagCache()`, `initializeCircuitBreaker()`, `getCircuitBreaker()`, `resetCircuitBreaker()` are no longer exported from `ApiRequestHandler`
+- Each `EsiClient` and `ApiClientBuilder` now creates its own `RateLimiter`, `ETagCacheManager`, and `CircuitBreaker` instances
+
+### Added
+
+- **`BaseEsiClient` base class** — eliminates ~650 lines of repeated constructor/field/`withMetadata()` boilerplate across all 33 domain clients
+- **`RequestDeduplicator`** — coalesces concurrent identical GET requests into a single in-flight fetch, sharing the result across all callers (enabled by default; disable with `enableRequestDeduplication: false`)
+- **`EsiDiagnostics` API** — `client.diagnostics` accessor for cache/circuit-breaker stats, moved out of the main `EsiClient` API surface
+- **`fetchPages()` async generator** — memory-efficient page-by-page iteration over paginated ESI responses
+- **Request timeouts** — `config.timeout` now wired to `AbortController` (default 30s); previously the field existed but was never connected to `fetch()` calls
+- **`EsiError` retry helpers** — `isTimeout()`, `retryable` getter, and `isRetryable()` guard for smarter consumer retry logic
+- **`RateLimiterConfig`** — `minDelayMs` and `decelerationThreshold` exposed via `EsiClientConfig` for consumer-tunable rate limiting
+- TypeScript declaration files (`.d.ts`) now emitted with builds
+- `exports` field in `package.json` for modern Node.js module resolution
+- `engines` field specifying Node.js >= 18.0.0
+- `publishConfig` with public access for scoped package
+- `RateLimiter`, `ETagCacheManager`, and `CircuitBreaker` classes exported from main index
+- `ApiClientBuilder.setRateLimiter()`, `.setCache()`, `.setCircuitBreaker()` builder methods
+- `validateBaseUrl()` for SSRF protection — validates ESI host allowlist and HTTPS
+- `unsafeAllowCustomHost` config option to bypass base URL validation
+- URL sanitization in `EsiError` — sensitive query params (`token`, `access_token`, `api_key`) are redacted
+- Path parameters encoded with `encodeURIComponent()` for defense-in-depth
+- URL assertions in all client unit tests — every test now verifies the correct endpoint URL
+- Endpoint definition contract tests — 1800+ tests validating path templates, params, methods
+- Test coverage for `RequestDeduplicator`, `EsiDiagnostics`, `AsyncPaginationIterator`, and extended `EsiError` tests
+- `CHANGELOG.md` following Keep a Changelog format
+- Changelog validation step in release workflow
+
+### Fixed
+
+- `.d.ts` files not generated during build (`declaration: true` added to `tsconfig.json`)
+- Release pipeline CNAME placeholder removed from GitHub Pages deployment
+- `ContractsClient.ts` test file renamed to `.test.ts` so Jest actually runs it
+
+### Changed
+
+- `RateLimiter` constructor is now public
+- Cache, rate limiter, and circuit breaker are instance-based per client (no global shared state)
+- `ApiClientBuilder.build()` auto-creates a `RateLimiter` if none was explicitly set
+- `api-responses.ts` (1366 lines) split into 29 domain-specific type files with barrel re-export for backward compatibility
+- `RateLimiter` uses `logWarn` instead of `console.warn` for consistent observability
+- Reduced allocations and deduplicated fetch/sleep logic across core modules
+
+## [3.4.0] - 2026-04-29
+
+### Added
+
+- ESI response header best practices documentation
+- Dogma test coverage (10 TDD + 9 BDD tests)
+- Gated authenticated integration tests (32 tests across 14 endpoint groups)
+- EVE SSO token creator for local integration testing
+- Search endpoint `categories` query parameter
+
+### Fixed
+
+- 3 industry endpoint paths (`corporation` -> `corporations`) for mining routes
+- Pagination middleware bypass: pages 2+ now route through request pipeline
+- Consolidated duplicate alliance contact endpoints

package/LICENSE

@@ -1,26 +1,26 @@
-GNU GENERAL PUBLIC LICENSE
-Version 3, 29 June 2007
-
-Copyright (C) 2024 lgriffin
-
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License
-along with this program.  If not, see <https://www.gnu.org/licenses/>.
-
----
-
-EVE Online and the EVE logo are the registered trademarks of CCP hf. All rights are reserved worldwide. 
-All other trademarks are the property of their respective owners. 
-EVE Online, the EVE logo, EVE and all associated logos and designs are the intellectual property of CCP hf. 
-All artwork, screenshots, characters, vehicles, storylines, world facts or other recognizable features of the intellectual property relating to these trademarks are likewise the intellectual property of CCP hf.
-
-This software is not affiliated with or endorsed by CCP hf.
+GNU GENERAL PUBLIC LICENSE
+Version 3, 29 June 2007
+
+Copyright (C) 2024 lgriffin
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+---
+
+EVE Online and the EVE logo are the registered trademarks of CCP hf. All rights are reserved worldwide. 
+All other trademarks are the property of their respective owners. 
+EVE Online, the EVE logo, EVE and all associated logos and designs are the intellectual property of CCP hf. 
+All artwork, screenshots, characters, vehicles, storylines, world facts or other recognizable features of the intellectual property relating to these trademarks are likewise the intellectual property of CCP hf.
+
+This software is not affiliated with or endorsed by CCP hf.