types: allow any return value for error

[sirlancelot]

Checklist

• run npm run test && npm run benchmark --if-present
• tests and/or benchmarks are included
• documentation is changed or added
• commit message and code follows the Developer's Certification of Origin
  and the Code of conduct

Description

The return value of the errorResponse config option function gets passed directly to reply.send and as such can support a wide range of possible values. Since the documentation encourages using this option to supply one's own error shape, it shouldn't make assumptions about the type, so I've set it to unknown in order to fix the type error I get when supplying my own error shape.

[Copilot]

Copilot wasn't able to review any files in this pull request.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[is2ei]

LGTM!

[Fdawgs]

Thanks @sirlancelot, could you please add an associated test?

[is2ei]

@sirlancelot

Sorry for requesting changes after approving.

Could you add more test cases in addition to the existing string-based fixture using err.message? Since we now support returning unknown instead of string, it would be helpful to cover those cases as well.

For example:
https://github.com/sirlancelot/fastify-bearer-auth/blob/patch-1/types/index.test-d.ts#L6-L13

const pluginOptions: FastifyBearerAuthOptions = {
  keys: new Set(['foo']),
  auth: (_key: string, _req: FastifyRequest) => { return true },
  errorResponse: (err: Error) => { return { error: err.message } },
  contentType: '',
  bearerType: '',
  addHook: false
}

[sirlancelot]

I'm not exactly sure what sort of testing is possible for unknown types. I think that's the point of unknown. All errors in JavaScript start out as unknown or any, depending on configuration, it's up to the implementation to determine what type it actually is.

[is2ei]

@sirlancelot

Thanks for your reply.

How about adding a test case using primitive types?
This would ensure that the return value accepts types other than just string.