@lgriffin/esi.ts 6.1.0 → 8.0.0

package/CHANGELOG.md

@@ -5,7 +5,90 @@ 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]
+## [7.4.0] - 2026-07-17
+
+### Added
+
+- **`withSafeMode()` on all domain clients** — mirrors existing `withMetadata()`, surfaces the `EsiResult<T>` discriminated union (`{ ok: true, data, meta } | { ok: false, error }`) without needing to call `createClient()` directly
+- **`responseSchema` on `routeEndpoints`** — was the only endpoint file without runtime response validation; now validated with `z.looseObject({ route: z.array(z.number()) })`
+
+### Changed
+
+- **ESLint 8 → 10 flat config migration** — replaced `.eslintrc.cjs` with `eslint.config.mjs`, switched to unified `typescript-eslint` package, dropped `eslint-plugin-prettier` (redundant with lint-staged)
+- **jest-fetch-mock 3 → 4** — updated null-body status mocks (204/304) to use `new Response(null, ...)` per Fetch spec
+- Updated 11 minor/patch dependencies: @commitlint/cli, @microsoft/api-extractor, @redocly/cli, @types/node, @typescript-eslint/*, eslint-plugin-sonarjs, fast-check, knip, prettier, typedoc
+
+### Fixed
+
+- CI: aligned `codeql.yml` branch targets to `[master, main, develop]`
+- CI: pinned `jest-coverage-comment@main` → `@v1.0.34` (supply-chain risk)
+- CI: added schema drift and generated types freshness checks to release pipeline
+
+### Deprecated
+
+- `AllianceClient.getContacts()` — use `ContactsClient.getAllianceContacts()` instead
+- `AllianceClient.getContactLabels()` — use `ContactsClient.getAllianceContactLabels()` instead
+
+## [7.3.0] - 2026-07-14
+
+### Added
+
+- **`EsiResult<T>` discriminated union** and `safeMode` option for error-safe API calls
+- **Branded ID types** (16 types) for type-safe ESI entity references
+- **Expanded type-level tests** with tsd for error guards, endpoints, and domain types
+- **Compile-time spec-to-Zod type alignment checks**
+- **Schema drift detection** as a blocking CI check
+- **Comprehensive testing gap closure** (+1233 tests)
+
+### Fixed
+
+- Resolved three CI jobs failing with continue-on-error
+- Normalized CRLF in API surface check
+- Fixed schemathesis report permissions and `--url` flag
+- Fixed API surface ordering issues
+- Added missing `system_id` to `MarketOrderSchema` test data
+
+## [7.2.0] - 2026-07-08
+
+### Added
+
+- **Contract testing infrastructure** — deep validation of all endpoint definitions against the live ESI OpenAPI spec (`npm run contract:live`). Checks path parameter alignment, required query params, request body consistency, auth requirements, response schema coverage, HTTP methods, pagination metadata, and deprecation sync. 8 contract validation categories with known-exception tracking.
+- **Property-based fuzz testing** with [fast-check](https://github.com/dubzzz/fast-check) — 601 tests fuzzing `validatePathParam()`, `validateQueryParam()`, `buildEndpointPath()`, and all Zod schemas with random/adversarial inputs (`npm run fuzz`)
+- **OpenAPI spec snapshot & diff** — `npm run contract:snapshot` saves a baseline; `npm run contract:diff` detects breaking changes via [oasdiff](https://github.com/Tufin/oasdiff) (Docker)
+- **Consumer type tests** with [tsd](https://github.com/tsdjs/tsd) — verifies public API type correctness (`npm run test:types`)
+- **Prism mock server** — `npm run mock:esi` starts a spec-conformant ESI mock on port 4010 via [@stoplight/prism-cli](https://stoplight.io/open-source/prism)
+- **Schemathesis fuzz runner** — `npm run fuzz:api` runs Schemathesis against the Prism mock (Docker, weekly CI)
+- Contract and fuzz test CI jobs added to `ci.yml` quality gate
+- Weekly spec drift detection job added to `maintenance.yml`
+- `jest.contract.config.cjs` and `jest.fuzz.config.cjs` test configurations
+
+### Dependencies
+
+- Added `fast-check` (dev) — property-based testing framework
+- Added `@stoplight/prism-cli` (dev) — OpenAPI mock server
+- Added `tsd` (dev) — TypeScript type testing
+
+## [7.1.0] - 2026-07-08
+
+### Added
+
+- **Redocly CLI integration** — lints the live ESI OpenAPI spec for structural validity and best-practice compliance (`npm run validate:spec`). Catches spec breakage from CCP before it breaks generated types, cache TTLs, or scopes. Baseline: 0 errors, 328 warnings (all known CCP spec issues).
+- `redocly.yaml` config with tuned rulesets for ESI — structural rules as errors, CCP spec quirks as warnings
+- `validate:spec` npm script added to `check:all` pipeline
+
+## [7.0.0] - 2026-07-08
+
+### Breaking Changes
+
+- **Swagger 2.0 → OpenAPI 3.1 migration** — all generated types, cache TTLs, scopes, and rate limit groups are now sourced from the ESI OpenAPI 3.1 spec (`/meta/openapi.json`) instead of the deprecated Swagger 2.0 spec (`/latest/swagger.json`). See [esi-issues#1490](https://github.com/esi/esi-issues/issues/1490).
+- **Generated interface names changed** — `EsiSpec` namespace types now use OpenAPI schema names (e.g., `AllianceDetail` instead of `GetAlliancesAllianceIdOk`). These are generated types; hand-written consumer types are unchanged.
+- **Cache TTL metadata key** — internally changed from `x-cached-seconds` to `x-cache-age`. No consumer-facing impact (cache behavior is identical).
+
+### Changed
+
+- Single OpenAPI spec fetch instead of dual Swagger + OpenAPI fetches
+- Updated all scripts, tests, and documentation to reference OpenAPI spec
+- Generated types now include 161 interfaces (up from 147), 126 cache TTLs, 70 scopes
 
 ## [6.1.0] - 2026-07-07
 

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.