v0.8.0

[diego-aquino]

v0.8.0 is here! 🎉

Features

• ⚙️ OpenAPI type generation: Zimic now can automatically generate types from OpenAPI specs using the new zimic typegen CLI! This is great to keep your application and interceptor types in sync with the target service. Take a look at the zimic typegen API reference for more information.

• 🔢 Strict HTTP status codes: as of v0.8, status codes are validated against the official RFC 9110 spec and can be imported as HttpStatusCode, HttpStatusCode.Information, HttpStatusCode.Success, HttpStatusCode.Redirection, HttpStatusCode.ClientError, and HttpStatusCode.ServerError from zimic/http.

  ⚠️ This is a breaking change if you are using non-standard status codes. In that case, we recommend refactoring your implementation to use valid codes as defined in RFC 9110.

Refactoring

• 📦 Export improvements: v0.8 introduces many improvements to the modules exported by Zimic! This marks a step forward in the stability of Zimic's public API.

  ⚠️ This is a breaking change. In summary, some modules have been moved, the namespace http is now called httpInterceptor, and the utility runCommand was removed. Check out the migration guide for more information about to migrate.

Fixes

• 🔧 Post-install script in ESM: previously, Zimic's post-install script would cause import errors when using ES modules in Vitest v2. This release fixes it.
• 🔧 RPC cancellation when a remote interceptor is stopped: in rare cases up to v0.7, interceptor servers could become stuck, waiting for an RPC reply from a remote interceptor that was already stopped. This would continue until the timeout of 5 minutes was reached. v0.8 implements a mechanism to cancel pending RPCs when an interceptor is stopped.

Credits

Huge thanks to @diego-aquino for helping!

Full Changelog: v0.7.1...v0.8.0

• chore: bump the npm group with 14 updates by @dependabot in chore: bump the npm group with 14 updates #237
• build: incremental type checking by @diego-aquino in build: incremental type checking #241
• chore(ci): latest node 22 (Consider re-enabling the latest Node.js 22 version on CI #239) by @diego-aquino in chore(ci): latest node 22 (#239) #242
• docs(#zimic): update package description by @diego-aquino in docs(#zimic): update package description #243
• feat(#zimic): open api typegen (Interceptor schema typegen from OpenAPI #66) by @diego-aquino in feat(#zimic): open api typegen (#66) #244
• chore: bump the npm group with 12 updates by @dependabot in chore: bump the npm group with 12 updates #249
• fix(#zimic): generate path references by @diego-aquino in fix(#zimic): generate path references #251
• feat(#zimic): export typegen resources (Export programmatic typegen utilities #250) by @diego-aquino in feat(#zimic): export typegen resources (#250) #254
• build(#zimic): improve build config by @diego-aquino in build(#zimic): improve build config #255
• refactor(#zimic)!: export improvements (Export improvements #240) by @diego-aquino in refactor(#zimic)!: export improvements (#240) #256
• docs(#zimic): v0.8.0 (v0.8.0 documentation #88) by @diego-aquino in docs(#zimic): v0.8.0 (#88) #257
• feat(#zimic): support to URLs in typegen (Support URLs as inputs to zimic typegen openapi #247) by @diego-aquino in feat(#zimic): support to URLs in typegen (#247) #259
• fix(#zimic): exclude webhooks from generated types (Remove webhooks from the generated types #253) by @diego-aquino in fix(#zimic): exclude webhooks from generated types (#253) #260
• test: verify typegen with popular services (Verify typegen in zimic-test-client using specs from popular services #258) by @diego-aquino in test: verify typegen with popular services (#258) #261
• chore(ci): remove cache cancellation on conflict by @diego-aquino in chore(ci): remove cache cancellation on conflict #262
• chore(#zimic)!: remove runCommand and CommandError (Remove runCommand and CommandError from zimic/interceptor/server #263) by @diego-aquino in chore(#zimic)!: remove runCommand and CommandError (#263) #268
• refactor(#release): replace zx by execa (Replace zx by execa in @zimic/release #267) by @diego-aquino in refactor(#release): replace zx by execa (#267) #269
• chore: bump the npm group with 6 updates by @dependabot in chore: bump the npm group with 6 updates #270
• feat(#zimic): support non-numeric openapi status codes (Support default response status codes in typegen #272) by @diego-aquino in feat(#zimic): support non-numeric openapi status codes (#272) #274
• docs(#zimic): document breaking change guidelines (Document possible breaking changes while not v1 #266) by @diego-aquino in docs(#zimic): document breaking change guidelines (#266) #275
• chore(ci): comments after release (Add action to comment on issues and pull requests when they are deployed #246) by @diego-aquino in chore(ci): comments after release (#246) #276
• docs(#zimic): add readme badges (Add README.md badges #265) by @diego-aquino in docs(#zimic): add readme badges (#265) #277
• fix(ci): correctly find milestone by tag in release action (Add action to comment on issues and pull requests when they are deployed #246) by @diego-aquino in fix(ci): correctly find milestone by tag in release action (#246) #279
• chore(ci): remove release comment job (Add action to comment on issues and pull requests when they are deployed #246) by @diego-aquino in chore(ci): remove release comment job (#246) #280
• docs(examples): create typegen example (Create new example using OpenAPI typegen #245) by @diego-aquino in docs(examples): create typegen example (#245) #281
• chore(ci): comments after release (Add action to comment on issues and pull requests when they are deployed #246) by @diego-aquino in chore(ci): comments after release (#246) #282
• test(zimic-test-client): add missing await's by @diego-aquino in test(zimic-test-client): add missing await's #285
• chore: bump @tanstack/react-query from 5.50.1 to 5.51.1 in the npm group by @dependabot in chore: bump @tanstack/react-query from 5.50.1 to 5.51.1 in the npm group #283
• refactor(examples): stop interceptor after on ready command by @diego-aquino in refactor(examples): stop interceptor after on ready command #286
• fix(#zimic): skip remote clearing if web socket client is not running by @diego-aquino in fix(#zimic): skip remote clearing if web socket client is not running #287
• fix(#zimic): abort waiting for a web socket reply when worker was stopped (Abort waiting for a web socket reply in interceptor servers when worker was stopped #289) by @diego-aquino in fix(#zimic): abort waiting for a web socket reply when worker was stopped (#289) #288
• fix(#zimic): log connection refused error when starting an interceptor in Node.js by @diego-aquino in fix(#zimic): log connection refused error when starting an interceptor in Node.js #290
• chore(release): v0.8.0 by @diego-aquino in chore(release): v0.8.0 #291

---

This discussion was created from the release v0.8.0.