Skip to content

SafeShape v3.4.0

Choose a tag to compare

@github-actions github-actions released this 02 Oct 09:03
· 22 commits to main since this release

SafeShape 3.4.0 adds an API contract workflow without breaking existing 3.3.x APIs or snapshot defaults.

  • Endpoint catalogs: immutable httpEndpoint and apiContract describe methods, paths, request sections and status-specific responses.
  • Validated fetch clients: createApiClient validates requests and responses, preserves warnings, supports AbortSignal, and returns typed results by HTTP status. Use @safe-shape/api/client for browsers.
  • OpenAPI 3.1: toOpenApi and safeToOpenApi export JSON Schema components and recursive references. Unsupported semantics produce structured errors without partial documents.
  • API compatibility: snapshots check request and response compatibility, route changes and response status changes against existing clients.
  • CLI: api export, api snapshot and api check, with stable JSON results and explicit exit codes.
  • All nine packages use version 3.4.0; EN/RU documentation and examples include the new workflow.
npm install safe-shape@3.4.0

The transport supports JSON and explicit wire schemas. Cookies, multipart, automatic retries and server routing are outside this release. Existing core, HTTP and tooling calls require no migration. Node >=20.10 and ESM remain required.

Validation: 307 workspace tests; build, typecheck, documentation, examples, installed consumers, quality and migration checks; dependency audits with zero vulnerabilities; CI on Node 20.10.0 and 24. An independent developer walkthrough was not performed.

API reference · Русская документация · Release evidence