Header support for requests

[dagohan]

Hi 👋, awesome job on covering the battle-net API!

I checked if there is support to add headers to the requests, but couldn't find it and traced how requests are generated to here:

blizzard.js/src/core/index.ts

Lines 80 to 93 in 7e2aa4a

	public prepareResourceRequest(
	resource: Resource<{ [key: string]: string | number | boolean }>,
	args?: Partial<ClientOptions>,
	): [string, AxiosRequestConfig] {
	const config = { ...this.defaults, ...args }
	const endpoint = getEndpoint(config.origin, config.locale)
	const namespace = resource.namespace ? { 'Battlenet-Namespace': `${resource.namespace}-${endpoint.origin}` } : {}
	const request: AxiosRequestConfig = {
	headers: {
	'User-Agent': this.ua,
	'Content-Type': 'application/json',
	Authorization: `bearer ${config.token}`,
	...namespace,
	},

It is relying on default headers (also dynamically sets Battlenet-Namespace based on the resource) but other than that the user does not have any control over it.

I think it would be beneficial to allow users to pass optional headers to any resource. For example, some requests can potentially return large response bodies and the user might want to avoid this if the resource has not been updated between the previously observed state. Blizzard API supports If-Modified-Since header for such purpose but it is not possible to utilize it behind blizzard.js's abstraction.

[benweier]

Thanks @dagohan this is a really good point you make. This was in the previous version but I didn't bring it over during the Typescript rewrite.

How do you feel about something like this

wow.characterProfile({ name: string, realm: string }, headers: { [key: string]: string })

Some API methods accept no arguments (mainly for "index" endpoints) so the first argument would become undefined | null

wow.achievements(undefined, headers: { [key: string]: string })
wow.achievements(null, headers: { [key: string]: string })

I think I had the foresight to also anticipate if an empty object is passed so this would also work for "index" endpoints

wow.achievements({}, headers: { [key: string]: string })

[benweier]

@dagohan 4.2.0 has been published with support for headers

[dagohan]

wow, I didn't expect such quick reply & development. Thanks a lot @benweier, appreciated the support a lot 👍

[benweier]

No problem, I'm still on holidays so I had the free time to focus on such a sensible feature request :)