Node.js build (form-data) rejects WHATWG Blob — TypeScript types should accept Buffer

[lfgcampos]

Problem:

The TypeScript type AddAttachment declares value: string | Blob | Readable, which leads users to pass a WHATWG Blob. However, the Node.js bundle (dist/TestRail.node.js) injects const FormData = require('form-data') at the top, so it always uses the form-data npm package — which does not support WHATWG Blob. Passing a Blob causes TypeError: source.on is not a function because form-data mistakes the Blob for a Node.js stream.

---

Fix suggestion:

Either add Buffer to the AddAttachment type for the Node.js build, or document that the form-data package is used under the hood and that Blob must be converted to a Buffer or Readable stream before passing to attachment methods.

[dlenroc]

Thanks for opening this.

This was originally intentional to support both browser and Node.js environments, but it’s now unnecessary and confusing. Dependencies will be removed in the next major release in favor of built-in WHATWG APIs, which will also eliminate runtime differences.

---

Current options:

If you want to use Node.js Blob, configure client to use native implementations instead of node-fetch/form-data:

import TestRail from '@dlenroc/testrail'

const api = new TestRail({
  host: '...',
  username: '...',
  password: '...',
  implementations: { fetch, Blob, AbortController, FormData }
})

await api.addAttachmentToResult(resultId, new Blob(['Hello World']))

await api.addAttachmentToResult(resultId, {
  name: 'file-name',
  value: new Blob(['Hello World'])
})

Alternatively, avoid Blob and use a Readable stream:

await api.addAttachmentToResult(resultId, {
  name: 'inputs.txt',
  value: fs.createReadStream('input.txt', { encoding: 'utf8' })
})

[lfgcampos]

Thanks for the quick reply - and yes, it is already working with Readable on my use case!

Just wanted to fire an issue anyway :)