feat: specific option to pass in the header, and type-safe definition based on the option

[gabrielmfern]

this is a stacked change on #599. The idea for this is that users can pass in if they want then permissive or strict validation on an option, so the usage would be like:

const response = resend.batch.send(..., { batchValidation: 'permissive' });

// Should always be an array, even if empty.
console.log(response.data.errors)

This options also allows us to use typescript's inference on type parameters to automatically change the return type to not have the errors when batchValidation is 'strict'.

---

Summary by cubic

Adds a batchValidation option to Batch.send/create that sets the x-batch-validation header automatically. Responses are now type-safe: errors are only present when using permissive mode.

• New Features

  • Add CreateBatchRequestOptions.batchValidation ('strict' | 'permissive', default 'strict').
  • Automatically sets x-batch-validation header based on the option.
  • Generic response typing: errors are available only in permissive mode; no client-side stripping.

• Migration

  • Use { batchValidation: 'permissive' } to get partial failures with an errors[] array. Default behavior stays strict.

[cubic-dev-ai]

5 issues found across 2 files

_{React with 👍 or 👎 to teach cubic. You can also tag @cubic-dev-ai to give feedback, ask questions, or re-run the review.}

[pkg-pr-new]

Open in StackBlitz

npm i https://pkg.pr.new/resend/resend-node/resend@605

commit: db2a1b9

[pedro-stramantinoli]

Nice!!