@blizzard-api/client 3.0.2 → 4.0.0

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { Locales, Origins, Resource, ResourceResponse, getBlizzardApi } from "@blizzard-api/core";
+import { Locales, Origins, Resource, getBlizzardApi } from "@blizzard-api/core";
 import { Options } from "ky";
 
 //#region src/client/types.d.ts
@@ -185,9 +185,9 @@ declare class BlizzardApiClient {
    * @param resource The resource to fetch. See {@link Resource}.
    * @param options Client options. See {@link ClientOptions}.
    * @param headers Additional headers to include in the request. This is deprecated and should be passed into the kyOptions as part of the client options instead.
-   * @returns The response from the Blizzard API. See {@link ResourceResponse}.
+   * @returns The response from the Blizzard API.
    */
-  sendRequest<T, Protected extends boolean = false>(resource: Resource<T, object, Protected>, options?: Partial<ClientOptions>, headers?: Record<string, string>): ResourceResponse<T>;
+  sendRequest<T, Protected extends boolean = false>(resource: Resource<T, object, Protected>, options?: Partial<ClientOptions>, headers?: Record<string, string>): Promise<T>;
 }
 //#endregion
 //#region src/client/create-client.d.ts

package/dist/index.js

@@ -152,26 +152,21 @@ var BlizzardApiClient = class {
 	* @param resource The resource to fetch. See {@link Resource}.
 	* @param options Client options. See {@link ClientOptions}.
 	* @param headers Additional headers to include in the request. This is deprecated and should be passed into the kyOptions as part of the client options instead.
-	* @returns The response from the Blizzard API. See {@link ResourceResponse}.
+	* @returns The response from the Blizzard API.
 	*/
 	async sendRequest(resource, options, headers) {
-		const url = this.getRequestUrl(resource, options);
+		const url = new URL(this.getRequestUrl(resource, options));
 		const config = this.getRequestConfig(resource, options, headers);
-		const kyHeaders = {};
-		for (const value of Object.entries(options?.kyOptions?.headers ?? {})) Object.assign(kyHeaders, value);
-		const kySearchParameters = {};
-		for (const value of Object.entries(options?.kyOptions?.searchParams ?? {})) Object.assign(kySearchParameters, value);
-		return await (await this.ky.get(url, {
+		for (const [key, value] of Object.entries(config.searchParams)) url.searchParams.set(key, String(value));
+		const response = await this.ky.get(url, {
 			...options?.kyOptions,
 			headers: {
 				...config.headers,
-				...kyHeaders
-			},
-			searchParams: {
-				...config.searchParams,
-				...kySearchParameters
+				...options?.kyOptions?.headers
 			}
-		})).json();
+		});
+		if (response.status === 204 || response.headers.get("Content-Length") === "0") return {};
+		return await response.json();
 	}
 };
 //#endregion

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../src/client/client.ts","../src/client/create-client.ts"],"sourcesContent":["import { stringify } from 'node:querystring';\r\nimport { getBlizzardApi } from '@blizzard-api/core';\r\nimport type { Locales, Origins, Resource, ResourceResponse } from '@blizzard-api/core';\r\nimport ky from 'ky';\r\nimport type {\r\n  AccessToken,\r\n  AccessTokenRequestArguments,\r\n  ClientOptions,\r\n  ValidateAccessTokenArguments,\r\n  ValidateAccessTokenResponse,\r\n} from './types';\r\n\r\n/**\r\n * A Blizzard API client.\r\n * @classdesc A client to interact with the Blizzard API.\r\n * @example\r\n * const client = new BlizzardApiClient({\r\n *  key: 'client',\r\n *  secret: 'secret',\r\n *  origin: 'eu',\r\n *  locale: 'en_GB',\r\n *  token: 'access'\r\n * });\r\n */\r\nexport class BlizzardApiClient {\r\n  public defaults: {\r\n    key: string;\r\n    locale: Locales;\r\n    origin: Origins;\r\n    secret: string;\r\n    token?: string;\r\n  };\r\n\r\n  private ky;\r\n\r\n  constructor(options: ClientOptions) {\r\n    const { locale, origin } = getBlizzardApi(options.origin, options.locale);\r\n    this.defaults = {\r\n      key: options.key,\r\n      locale: locale,\r\n      origin: origin,\r\n      secret: options.secret,\r\n      token: options.token,\r\n    };\r\n    this.ky = ky.create(options.kyOptions);\r\n  }\r\n\r\n  /**\r\n   * Get an access token.\r\n   * @param options The access token request arguments. See {@link AccessTokenRequestArguments}.\r\n   * @returns The access token. See {@link AccessToken}.\r\n   * @example\r\n   * const response = await client.getAccessToken();\r\n   * const { access_token, token_type, expires_in, sub } = response;\r\n   * console.log(access_token, token_type, expires_in, sub);\r\n   * // => 'access'\r\n   * // => 'bearer'\r\n   * // => 86399\r\n   * // => 'client-id'\r\n   */\r\n  public getAccessToken = async (options?: AccessTokenRequestArguments): Promise<AccessToken> => {\r\n    const { key, origin, secret } = { ...this.defaults, ...options };\r\n    const basicAuth = Buffer.from(`${key}:${secret}`).toString('base64');\r\n    const response = await this.ky\r\n      .post<AccessToken>(`https://${origin}.battle.net/oauth/token`, {\r\n        headers: {\r\n          Authorization: `Basic ${basicAuth}`,\r\n          'Content-Type': 'application/json',\r\n        },\r\n        searchParams: {\r\n          grant_type: 'client_credentials',\r\n        },\r\n      })\r\n      .json();\r\n\r\n    return response;\r\n  };\r\n\r\n  /**\r\n   * Set the access token.\r\n   * @param token The access token.\r\n   */\r\n  public setAccessToken = (token: string): void => {\r\n    this.defaults.token = token;\r\n  };\r\n\r\n  /**\r\n   * Refresh the access token.\r\n   * @param options The access token request arguments. See {@link AccessTokenRequestArguments}.\r\n   * @returns The access token. See {@link AccessToken}.\r\n   * @example\r\n   * const response = await client.refreshAccessToken();\r\n   * const { access_token, token_type, expires_in, sub } = response;\r\n   * console.log(access_token, token_type, expires_in, sub);\r\n   * // => 'access'\r\n   * // => 'bearer'\r\n   * // => 86399\r\n   * // => 'client-id'\r\n   */\r\n  public refreshAccessToken = async (options?: AccessTokenRequestArguments): Promise<AccessToken> => {\r\n    const response = await this.getAccessToken(options);\r\n    this.setAccessToken(response.access_token);\r\n    return response;\r\n  };\r\n\r\n  /**\r\n   * Validate an access token.\r\n   * @param options The validate access token arguments. See {@link ValidateAccessTokenArguments}.\r\n   * @returns The response from the Blizzard API. See {@link ValidateAccessTokenResponse}.\r\n   * @example\r\n   * const response = await client.validateAccessToken({ token: 'access' });\r\n   * console.log(response.client_id);\r\n   * // => 'client-id'\r\n   */\r\n  public validateAccessToken = async (options?: ValidateAccessTokenArguments): Promise<ValidateAccessTokenResponse> => {\r\n    const { origin, token } = { ...this.defaults, ...options };\r\n\r\n    if (!token) {\r\n      throw new Error('No token has been set previously or been passed to the validateAccessToken method.');\r\n    }\r\n\r\n    const response = await this.ky\r\n      .post<ValidateAccessTokenResponse>(`https://${origin}.battle.net/oauth/check_token`, {\r\n        body: stringify({ token }),\r\n        headers: {\r\n          'Content-Type': 'application/x-www-form-urlencoded',\r\n        },\r\n      })\r\n      .json();\r\n\r\n    return response;\r\n  };\r\n\r\n  /**\r\n   * Get the request configuration.\r\n   * @param resource The resource to fetch. See {@link Resource}.\r\n   * @param options Client options. See {@link ClientOptions}.\r\n   * @param headers Additional headers to include in the request. This is deprecated and should be passed into the kyOptions as part of the client options instead.\r\n   * @returns The request configuration.\r\n   */\r\n  public getRequestConfig<T, Protected extends boolean = false>(\r\n    resource: Resource<T, object, Protected>,\r\n    options?: Partial<ClientOptions>,\r\n    headers?: Record<string, string>,\r\n  ): {\r\n    headers: Record<string, string> & {\r\n      Authorization: `Bearer ${string}`;\r\n      'Battlenet-Namespace'?: string;\r\n      'Content-Type': 'application/json';\r\n    };\r\n    searchParams: Record<string, unknown> & { locale: ReturnType<typeof getBlizzardApi>['locale'] };\r\n  } {\r\n    const config = { ...this.defaults, ...options };\r\n    const endpoint = getBlizzardApi(config.origin, config.locale);\r\n\r\n    const namespace = resource.namespace\r\n      ? { 'Battlenet-Namespace': `${resource.namespace}-${endpoint.origin}` }\r\n      : undefined;\r\n\r\n    const parameters = resource.parameters as Record<string, unknown>;\r\n    if (parameters) {\r\n      for (const key of Object.keys(parameters)) {\r\n        if (parameters[key] === undefined) {\r\n          delete parameters[key];\r\n        }\r\n      }\r\n    }\r\n\r\n    return {\r\n      headers: {\r\n        ...headers,\r\n        ...namespace,\r\n        Authorization: `Bearer ${config.token}`,\r\n        'Content-Type': 'application/json',\r\n      },\r\n      searchParams: {\r\n        ...parameters,\r\n        locale: endpoint.locale,\r\n      },\r\n    };\r\n  }\r\n\r\n  /**\r\n   * Get the request URL.\r\n   * @param resource The resource to fetch. See {@link Resource}.\r\n   * @param options Client options. See {@link ClientOptions}.\r\n   * @returns The request URL.\r\n   */\r\n  public getRequestUrl<T, Protected extends boolean = false>(\r\n    resource: Resource<T, object, Protected>,\r\n    options?: Partial<ClientOptions>,\r\n  ) {\r\n    const config = { ...this.defaults, ...options };\r\n    const endpoint = getBlizzardApi(config.origin, config.locale);\r\n\r\n    const backslashSeparator = resource.path.startsWith('/') ? '' : '/';\r\n\r\n    return `${endpoint.hostname}${backslashSeparator}${resource.path}`;\r\n  }\r\n\r\n  /**\r\n   * Send a request to the Blizzard API.\r\n   * @param resource The resource to fetch. See {@link Resource}.\r\n   * @param options Client options. See {@link ClientOptions}.\r\n   * @param headers Additional headers to include in the request. This is deprecated and should be passed into the kyOptions as part of the client options instead.\r\n   * @returns The response from the Blizzard API. See {@link ResourceResponse}.\r\n   */\r\n  public async sendRequest<T, Protected extends boolean = false>(\r\n    resource: Resource<T, object, Protected>,\r\n    options?: Partial<ClientOptions>,\r\n    headers?: Record<string, string>,\r\n  ): ResourceResponse<T> {\r\n    const url = this.getRequestUrl(resource, options);\r\n    const config = this.getRequestConfig(resource, options, headers);\r\n\r\n    const kyHeaders = {};\r\n    for (const value of Object.entries(options?.kyOptions?.headers ?? {})) {\r\n      Object.assign(kyHeaders, value);\r\n    }\r\n\r\n    const kySearchParameters = {};\r\n    for (const value of Object.entries(options?.kyOptions?.searchParams ?? {})) {\r\n      Object.assign(kySearchParameters, value);\r\n    }\r\n\r\n    const response = await this.ky.get<T>(url, {\r\n      ...options?.kyOptions,\r\n      headers: {\r\n        ...config.headers,\r\n        ...kyHeaders,\r\n      },\r\n      searchParams: { ...config.searchParams, ...kySearchParameters },\r\n    });\r\n    const data = await response.json();\r\n\r\n    return data;\r\n  }\r\n}\r\n","//We have to explicitly import setTimeout because of https://github.com/electron/electron/issues/21162#issuecomment-554792447\r\nimport { setTimeout } from 'node:timers';\r\nimport { BlizzardApiClient } from './client';\r\nimport type { AccessToken, ClientOptions } from './types';\r\n\r\nconst getTokenExpiration = (expiresIn: number) => expiresIn * 1000 - 60_000;\r\n\r\n/**\r\n * Create a new Blizzard API client.\r\n * @param options Client options, see {@link ClientOptions} & https://develop.battle.net/documentation/guides/getting-started\r\n * @param onTokenRefresh Callback function to handle token refresh. If set to `true`, the client will automatically refresh the token. If set to `false`, the client will not refresh the token. If set to a function, the function will be called with the new token.\r\n * @returns A new Blizzard API client.\r\n */\r\nexport const createBlizzardApiClient = async (\r\n  options: ClientOptions,\r\n  onTokenRefresh: ((token: AccessToken) => void) | boolean = true,\r\n): Promise<BlizzardApiClient> => {\r\n  const { key, secret, token } = options;\r\n  if (!key) {\r\n    throw new Error(`Client missing 'key' parameter`);\r\n  }\r\n  if (!secret) {\r\n    throw new Error(`Client missing 'secret' parameter`);\r\n  }\r\n\r\n  const client = new BlizzardApiClient(options);\r\n\r\n  const refreshToken = async () => {\r\n    const response = await client.getAccessToken();\r\n\r\n    client.setAccessToken(response.access_token);\r\n\r\n    if (typeof onTokenRefresh === 'function') {\r\n      onTokenRefresh?.(response);\r\n    }\r\n\r\n    //Schedule a refresh of the token\r\n    const timeout = setTimeout(() => void refreshToken(), getTokenExpiration(response.expires_in));\r\n    timeout.unref();\r\n  };\r\n\r\n  //If tokenRefresh is false, return the client without refreshing the token\r\n  if (!onTokenRefresh) {\r\n    return client;\r\n  }\r\n\r\n  if (token) {\r\n    try {\r\n      //If token is set, validate the token\r\n      const validatedToken = await client.validateAccessToken({ token });\r\n      const expiry = getTokenExpiration(validatedToken.exp);\r\n      //If token is expiring in less than 60 seconds, refresh the token\r\n      if (expiry - Date.now() < 60_000) {\r\n        await refreshToken();\r\n      } else {\r\n        //If token is not expiring, schedule a refresh\r\n        const timeout = setTimeout(() => void refreshToken(), expiry - Date.now());\r\n        //Unref the timeout so the process can exit\r\n        timeout.unref();\r\n      }\r\n    } catch {\r\n      //If token is invalid, refresh the token\r\n      await refreshToken();\r\n    }\r\n  } else {\r\n    //If token is not set, refresh the token\r\n    await refreshToken();\r\n  }\r\n\r\n  return client;\r\n};\r\n"],"mappings":";;;;;;;;;;;;;;;;;AAwBA,IAAa,oBAAb,MAA+B;CAC7B;CAQA;CAEA,YAAY,SAAwB;EAClC,MAAM,EAAE,QAAQ,WAAW,eAAe,QAAQ,QAAQ,QAAQ,OAAO;AACzE,OAAK,WAAW;GACd,KAAK,QAAQ;GACL;GACA;GACR,QAAQ,QAAQ;GAChB,OAAO,QAAQ;GAChB;AACD,OAAK,KAAK,GAAG,OAAO,QAAQ,UAAU;;;;;;;;;;;;;;;CAgBxC,iBAAwB,OAAO,YAAgE;EAC7F,MAAM,EAAE,KAAK,QAAQ,WAAW;GAAE,GAAG,KAAK;GAAU,GAAG;GAAS;EAChE,MAAM,YAAY,OAAO,KAAK,GAAG,IAAI,GAAG,SAAS,CAAC,SAAS,SAAS;AAapE,SAZiB,MAAM,KAAK,GACzB,KAAkB,WAAW,OAAO,0BAA0B;GAC7D,SAAS;IACP,eAAe,SAAS;IACxB,gBAAgB;IACjB;GACD,cAAc,EACZ,YAAY,sBACb;GACF,CAAC,CACD,MAAM;;;;;;CASX,kBAAyB,UAAwB;AAC/C,OAAK,SAAS,QAAQ;;;;;;;;;;;;;;;CAgBxB,qBAA4B,OAAO,YAAgE;EACjG,MAAM,WAAW,MAAM,KAAK,eAAe,QAAQ;AACnD,OAAK,eAAe,SAAS,aAAa;AAC1C,SAAO;;;;;;;;;;;CAYT,sBAA6B,OAAO,YAAiF;EACnH,MAAM,EAAE,QAAQ,UAAU;GAAE,GAAG,KAAK;GAAU,GAAG;GAAS;AAE1D,MAAI,CAAC,MACH,OAAM,IAAI,MAAM,qFAAqF;AAYvG,SATiB,MAAM,KAAK,GACzB,KAAkC,WAAW,OAAO,gCAAgC;GACnF,MAAM,UAAU,EAAE,OAAO,CAAC;GAC1B,SAAS,EACP,gBAAgB,qCACjB;GACF,CAAC,CACD,MAAM;;;;;;;;;CAYX,iBACE,UACA,SACA,SAQA;EACA,MAAM,SAAS;GAAE,GAAG,KAAK;GAAU,GAAG;GAAS;EAC/C,MAAM,WAAW,eAAe,OAAO,QAAQ,OAAO,OAAO;EAE7D,MAAM,YAAY,SAAS,YACvB,EAAE,uBAAuB,GAAG,SAAS,UAAU,GAAG,SAAS,UAAU,GACrE,KAAA;EAEJ,MAAM,aAAa,SAAS;AAC5B,MAAI;QACG,MAAM,OAAO,OAAO,KAAK,WAAW,CACvC,KAAI,WAAW,SAAS,KAAA,EACtB,QAAO,WAAW;;AAKxB,SAAO;GACL,SAAS;IACP,GAAG;IACH,GAAG;IACH,eAAe,UAAU,OAAO;IAChC,gBAAgB;IACjB;GACD,cAAc;IACZ,GAAG;IACH,QAAQ,SAAS;IAClB;GACF;;;;;;;;CASH,cACE,UACA,SACA;EACA,MAAM,SAAS;GAAE,GAAG,KAAK;GAAU,GAAG;GAAS;EAC/C,MAAM,WAAW,eAAe,OAAO,QAAQ,OAAO,OAAO;EAE7D,MAAM,qBAAqB,SAAS,KAAK,WAAW,IAAI,GAAG,KAAK;AAEhE,SAAO,GAAG,SAAS,WAAW,qBAAqB,SAAS;;;;;;;;;CAU9D,MAAa,YACX,UACA,SACA,SACqB;EACrB,MAAM,MAAM,KAAK,cAAc,UAAU,QAAQ;EACjD,MAAM,SAAS,KAAK,iBAAiB,UAAU,SAAS,QAAQ;EAEhE,MAAM,YAAY,EAAE;AACpB,OAAK,MAAM,SAAS,OAAO,QAAQ,SAAS,WAAW,WAAW,EAAE,CAAC,CACnE,QAAO,OAAO,WAAW,MAAM;EAGjC,MAAM,qBAAqB,EAAE;AAC7B,OAAK,MAAM,SAAS,OAAO,QAAQ,SAAS,WAAW,gBAAgB,EAAE,CAAC,CACxE,QAAO,OAAO,oBAAoB,MAAM;AAa1C,SAFa,OARI,MAAM,KAAK,GAAG,IAAO,KAAK;GACzC,GAAG,SAAS;GACZ,SAAS;IACP,GAAG,OAAO;IACV,GAAG;IACJ;GACD,cAAc;IAAE,GAAG,OAAO;IAAc,GAAG;IAAoB;GAChE,CAAC,EAC0B,MAAM;;;;;ACpOtC,MAAM,sBAAsB,cAAsB,YAAY,MAAO;;;;;;;AAQrE,MAAa,0BAA0B,OACrC,SACA,iBAA2D,SAC5B;CAC/B,MAAM,EAAE,KAAK,QAAQ,UAAU;AAC/B,KAAI,CAAC,IACH,OAAM,IAAI,MAAM,iCAAiC;AAEnD,KAAI,CAAC,OACH,OAAM,IAAI,MAAM,oCAAoC;CAGtD,MAAM,SAAS,IAAI,kBAAkB,QAAQ;CAE7C,MAAM,eAAe,YAAY;EAC/B,MAAM,WAAW,MAAM,OAAO,gBAAgB;AAE9C,SAAO,eAAe,SAAS,aAAa;AAE5C,MAAI,OAAO,mBAAmB,WAC5B,kBAAiB,SAAS;AAIZ,mBAAiB,KAAK,cAAc,EAAE,mBAAmB,SAAS,WAAW,CAAC,CACtF,OAAO;;AAIjB,KAAI,CAAC,eACH,QAAO;AAGT,KAAI,MACF,KAAI;EAGF,MAAM,SAAS,oBADQ,MAAM,OAAO,oBAAoB,EAAE,OAAO,CAAC,EACjB,IAAI;AAErD,MAAI,SAAS,KAAK,KAAK,GAAG,IACxB,OAAM,cAAc;MAGJ,kBAAiB,KAAK,cAAc,EAAE,SAAS,KAAK,KAAK,CAAC,CAElE,OAAO;SAEX;AAEN,QAAM,cAAc;;KAItB,OAAM,cAAc;AAGtB,QAAO"}
+{"version":3,"file":"index.js","names":[],"sources":["../src/client/client.ts","../src/client/create-client.ts"],"sourcesContent":["import { stringify } from 'node:querystring';\r\nimport { getBlizzardApi } from '@blizzard-api/core';\r\nimport type { Locales, Origins, Resource } from '@blizzard-api/core';\r\nimport ky from 'ky';\r\nimport type {\r\n  AccessToken,\r\n  AccessTokenRequestArguments,\r\n  ClientOptions,\r\n  ValidateAccessTokenArguments,\r\n  ValidateAccessTokenResponse,\r\n} from './types';\r\n\r\n/**\r\n * A Blizzard API client.\r\n * @classdesc A client to interact with the Blizzard API.\r\n * @example\r\n * const client = new BlizzardApiClient({\r\n *  key: 'client',\r\n *  secret: 'secret',\r\n *  origin: 'eu',\r\n *  locale: 'en_GB',\r\n *  token: 'access'\r\n * });\r\n */\r\nexport class BlizzardApiClient {\r\n  public defaults: {\r\n    key: string;\r\n    locale: Locales;\r\n    origin: Origins;\r\n    secret: string;\r\n    token?: string;\r\n  };\r\n\r\n  private ky;\r\n\r\n  constructor(options: ClientOptions) {\r\n    const { locale, origin } = getBlizzardApi(options.origin, options.locale);\r\n    this.defaults = {\r\n      key: options.key,\r\n      locale: locale,\r\n      origin: origin,\r\n      secret: options.secret,\r\n      token: options.token,\r\n    };\r\n    this.ky = ky.create(options.kyOptions);\r\n  }\r\n\r\n  /**\r\n   * Get an access token.\r\n   * @param options The access token request arguments. See {@link AccessTokenRequestArguments}.\r\n   * @returns The access token. See {@link AccessToken}.\r\n   * @example\r\n   * const response = await client.getAccessToken();\r\n   * const { access_token, token_type, expires_in, sub } = response;\r\n   * console.log(access_token, token_type, expires_in, sub);\r\n   * // => 'access'\r\n   * // => 'bearer'\r\n   * // => 86399\r\n   * // => 'client-id'\r\n   */\r\n  public getAccessToken = async (options?: AccessTokenRequestArguments): Promise<AccessToken> => {\r\n    const { key, origin, secret } = { ...this.defaults, ...options };\r\n    const basicAuth = Buffer.from(`${key}:${secret}`).toString('base64');\r\n    const response = await this.ky\r\n      .post<AccessToken>(`https://${origin}.battle.net/oauth/token`, {\r\n        headers: {\r\n          Authorization: `Basic ${basicAuth}`,\r\n          'Content-Type': 'application/json',\r\n        },\r\n        searchParams: {\r\n          grant_type: 'client_credentials',\r\n        },\r\n      })\r\n      .json();\r\n\r\n    return response;\r\n  };\r\n\r\n  /**\r\n   * Set the access token.\r\n   * @param token The access token.\r\n   */\r\n  public setAccessToken = (token: string): void => {\r\n    this.defaults.token = token;\r\n  };\r\n\r\n  /**\r\n   * Refresh the access token.\r\n   * @param options The access token request arguments. See {@link AccessTokenRequestArguments}.\r\n   * @returns The access token. See {@link AccessToken}.\r\n   * @example\r\n   * const response = await client.refreshAccessToken();\r\n   * const { access_token, token_type, expires_in, sub } = response;\r\n   * console.log(access_token, token_type, expires_in, sub);\r\n   * // => 'access'\r\n   * // => 'bearer'\r\n   * // => 86399\r\n   * // => 'client-id'\r\n   */\r\n  public refreshAccessToken = async (options?: AccessTokenRequestArguments): Promise<AccessToken> => {\r\n    const response = await this.getAccessToken(options);\r\n    this.setAccessToken(response.access_token);\r\n    return response;\r\n  };\r\n\r\n  /**\r\n   * Validate an access token.\r\n   * @param options The validate access token arguments. See {@link ValidateAccessTokenArguments}.\r\n   * @returns The response from the Blizzard API. See {@link ValidateAccessTokenResponse}.\r\n   * @example\r\n   * const response = await client.validateAccessToken({ token: 'access' });\r\n   * console.log(response.client_id);\r\n   * // => 'client-id'\r\n   */\r\n  public validateAccessToken = async (options?: ValidateAccessTokenArguments): Promise<ValidateAccessTokenResponse> => {\r\n    const { origin, token } = { ...this.defaults, ...options };\r\n\r\n    if (!token) {\r\n      throw new Error('No token has been set previously or been passed to the validateAccessToken method.');\r\n    }\r\n\r\n    const response = await this.ky\r\n      .post<ValidateAccessTokenResponse>(`https://${origin}.battle.net/oauth/check_token`, {\r\n        body: stringify({ token }),\r\n        headers: {\r\n          'Content-Type': 'application/x-www-form-urlencoded',\r\n        },\r\n      })\r\n      .json();\r\n\r\n    return response;\r\n  };\r\n\r\n  /**\r\n   * Get the request configuration.\r\n   * @param resource The resource to fetch. See {@link Resource}.\r\n   * @param options Client options. See {@link ClientOptions}.\r\n   * @param headers Additional headers to include in the request. This is deprecated and should be passed into the kyOptions as part of the client options instead.\r\n   * @returns The request configuration.\r\n   */\r\n  public getRequestConfig<T, Protected extends boolean = false>(\r\n    resource: Resource<T, object, Protected>,\r\n    options?: Partial<ClientOptions>,\r\n    headers?: Record<string, string>,\r\n  ): {\r\n    headers: Record<string, string> & {\r\n      Authorization: `Bearer ${string}`;\r\n      'Battlenet-Namespace'?: string;\r\n      'Content-Type': 'application/json';\r\n    };\r\n    searchParams: Record<string, unknown> & { locale: ReturnType<typeof getBlizzardApi>['locale'] };\r\n  } {\r\n    const config = { ...this.defaults, ...options };\r\n    const endpoint = getBlizzardApi(config.origin, config.locale);\r\n\r\n    const namespace = resource.namespace\r\n      ? { 'Battlenet-Namespace': `${resource.namespace}-${endpoint.origin}` }\r\n      : undefined;\r\n\r\n    const parameters = resource.parameters as Record<string, unknown>;\r\n    if (parameters) {\r\n      for (const key of Object.keys(parameters)) {\r\n        if (parameters[key] === undefined) {\r\n          delete parameters[key];\r\n        }\r\n      }\r\n    }\r\n\r\n    return {\r\n      headers: {\r\n        ...headers,\r\n        ...namespace,\r\n        Authorization: `Bearer ${config.token}`,\r\n        'Content-Type': 'application/json',\r\n      },\r\n      searchParams: {\r\n        ...parameters,\r\n        locale: endpoint.locale,\r\n      },\r\n    };\r\n  }\r\n\r\n  /**\r\n   * Get the request URL.\r\n   * @param resource The resource to fetch. See {@link Resource}.\r\n   * @param options Client options. See {@link ClientOptions}.\r\n   * @returns The request URL.\r\n   */\r\n  public getRequestUrl<T, Protected extends boolean = false>(\r\n    resource: Resource<T, object, Protected>,\r\n    options?: Partial<ClientOptions>,\r\n  ) {\r\n    const config = { ...this.defaults, ...options };\r\n    const endpoint = getBlizzardApi(config.origin, config.locale);\r\n\r\n    const backslashSeparator = resource.path.startsWith('/') ? '' : '/';\r\n\r\n    return `${endpoint.hostname}${backslashSeparator}${resource.path}`;\r\n  }\r\n\r\n  /**\r\n   * Send a request to the Blizzard API.\r\n   * @param resource The resource to fetch. See {@link Resource}.\r\n   * @param options Client options. See {@link ClientOptions}.\r\n   * @param headers Additional headers to include in the request. This is deprecated and should be passed into the kyOptions as part of the client options instead.\r\n   * @returns The response from the Blizzard API.\r\n   */\r\n  public async sendRequest<T, Protected extends boolean = false>(\r\n    resource: Resource<T, object, Protected>,\r\n    options?: Partial<ClientOptions>,\r\n    headers?: Record<string, string>,\r\n  ): Promise<T> {\r\n    const url = new URL(this.getRequestUrl(resource, options));\r\n    const config = this.getRequestConfig(resource, options, headers);\r\n\r\n    for (const [key, value] of Object.entries(config.searchParams)) {\r\n      url.searchParams.set(key, String(value));\r\n    }\r\n\r\n    const response = await this.ky.get<T>(url, {\r\n      ...options?.kyOptions,\r\n      headers: {\r\n        ...config.headers,\r\n        ...options?.kyOptions?.headers,\r\n      },\r\n    });\r\n\r\n    // Some endpoints return a 204 status code with no content,\r\n    // while others return a 200 status code with an empty body.\r\n    // To handle both cases, we check for a 204 status code or a Content-Length header of 0\r\n    // before attempting to parse the response as JSON.\r\n    if (response.status === 204 || response.headers.get('Content-Length') === '0') {\r\n      return {} as T;\r\n    }\r\n    const data = await response.json();\r\n\r\n    return data;\r\n  }\r\n}\r\n","//We have to explicitly import setTimeout because of https://github.com/electron/electron/issues/21162#issuecomment-554792447\r\nimport { setTimeout } from 'node:timers';\r\nimport { BlizzardApiClient } from './client';\r\nimport type { AccessToken, ClientOptions } from './types';\r\n\r\nconst getTokenExpiration = (expiresIn: number) => expiresIn * 1000 - 60_000;\r\n\r\n/**\r\n * Create a new Blizzard API client.\r\n * @param options Client options, see {@link ClientOptions} & https://develop.battle.net/documentation/guides/getting-started\r\n * @param onTokenRefresh Callback function to handle token refresh. If set to `true`, the client will automatically refresh the token. If set to `false`, the client will not refresh the token. If set to a function, the function will be called with the new token.\r\n * @returns A new Blizzard API client.\r\n */\r\nexport const createBlizzardApiClient = async (\r\n  options: ClientOptions,\r\n  onTokenRefresh: ((token: AccessToken) => void) | boolean = true,\r\n): Promise<BlizzardApiClient> => {\r\n  const { key, secret, token } = options;\r\n  if (!key) {\r\n    throw new Error(`Client missing 'key' parameter`);\r\n  }\r\n  if (!secret) {\r\n    throw new Error(`Client missing 'secret' parameter`);\r\n  }\r\n\r\n  const client = new BlizzardApiClient(options);\r\n\r\n  const refreshToken = async () => {\r\n    const response = await client.getAccessToken();\r\n\r\n    client.setAccessToken(response.access_token);\r\n\r\n    if (typeof onTokenRefresh === 'function') {\r\n      onTokenRefresh?.(response);\r\n    }\r\n\r\n    //Schedule a refresh of the token\r\n    const timeout = setTimeout(() => void refreshToken(), getTokenExpiration(response.expires_in));\r\n    timeout.unref();\r\n  };\r\n\r\n  //If tokenRefresh is false, return the client without refreshing the token\r\n  if (!onTokenRefresh) {\r\n    return client;\r\n  }\r\n\r\n  if (token) {\r\n    try {\r\n      //If token is set, validate the token\r\n      const validatedToken = await client.validateAccessToken({ token });\r\n      const expiry = getTokenExpiration(validatedToken.exp);\r\n      //If token is expiring in less than 60 seconds, refresh the token\r\n      if (expiry - Date.now() < 60_000) {\r\n        await refreshToken();\r\n      } else {\r\n        //If token is not expiring, schedule a refresh\r\n        const timeout = setTimeout(() => void refreshToken(), expiry - Date.now());\r\n        //Unref the timeout so the process can exit\r\n        timeout.unref();\r\n      }\r\n    } catch {\r\n      //If token is invalid, refresh the token\r\n      await refreshToken();\r\n    }\r\n  } else {\r\n    //If token is not set, refresh the token\r\n    await refreshToken();\r\n  }\r\n\r\n  return client;\r\n};\r\n"],"mappings":";;;;;;;;;;;;;;;;;AAwBA,IAAa,oBAAb,MAA+B;CAC7B;CAQA;CAEA,YAAY,SAAwB;EAClC,MAAM,EAAE,QAAQ,WAAW,eAAe,QAAQ,QAAQ,QAAQ,OAAO;AACzE,OAAK,WAAW;GACd,KAAK,QAAQ;GACL;GACA;GACR,QAAQ,QAAQ;GAChB,OAAO,QAAQ;GAChB;AACD,OAAK,KAAK,GAAG,OAAO,QAAQ,UAAU;;;;;;;;;;;;;;;CAgBxC,iBAAwB,OAAO,YAAgE;EAC7F,MAAM,EAAE,KAAK,QAAQ,WAAW;GAAE,GAAG,KAAK;GAAU,GAAG;GAAS;EAChE,MAAM,YAAY,OAAO,KAAK,GAAG,IAAI,GAAG,SAAS,CAAC,SAAS,SAAS;AAapE,SAAO,MAZgB,KAAK,GACzB,KAAkB,WAAW,OAAO,0BAA0B;GAC7D,SAAS;IACP,eAAe,SAAS;IACxB,gBAAgB;IACjB;GACD,cAAc,EACZ,YAAY,sBACb;GACF,CAAC,CACD,MAAM;;;;;;CASX,kBAAyB,UAAwB;AAC/C,OAAK,SAAS,QAAQ;;;;;;;;;;;;;;;CAgBxB,qBAA4B,OAAO,YAAgE;EACjG,MAAM,WAAW,MAAM,KAAK,eAAe,QAAQ;AACnD,OAAK,eAAe,SAAS,aAAa;AAC1C,SAAO;;;;;;;;;;;CAYT,sBAA6B,OAAO,YAAiF;EACnH,MAAM,EAAE,QAAQ,UAAU;GAAE,GAAG,KAAK;GAAU,GAAG;GAAS;AAE1D,MAAI,CAAC,MACH,OAAM,IAAI,MAAM,qFAAqF;AAYvG,SAAO,MATgB,KAAK,GACzB,KAAkC,WAAW,OAAO,gCAAgC;GACnF,MAAM,UAAU,EAAE,OAAO,CAAC;GAC1B,SAAS,EACP,gBAAgB,qCACjB;GACF,CAAC,CACD,MAAM;;;;;;;;;CAYX,iBACE,UACA,SACA,SAQA;EACA,MAAM,SAAS;GAAE,GAAG,KAAK;GAAU,GAAG;GAAS;EAC/C,MAAM,WAAW,eAAe,OAAO,QAAQ,OAAO,OAAO;EAE7D,MAAM,YAAY,SAAS,YACvB,EAAE,uBAAuB,GAAG,SAAS,UAAU,GAAG,SAAS,UAAU,GACrE,KAAA;EAEJ,MAAM,aAAa,SAAS;AAC5B,MAAI;QACG,MAAM,OAAO,OAAO,KAAK,WAAW,CACvC,KAAI,WAAW,SAAS,KAAA,EACtB,QAAO,WAAW;;AAKxB,SAAO;GACL,SAAS;IACP,GAAG;IACH,GAAG;IACH,eAAe,UAAU,OAAO;IAChC,gBAAgB;IACjB;GACD,cAAc;IACZ,GAAG;IACH,QAAQ,SAAS;IAClB;GACF;;;;;;;;CASH,cACE,UACA,SACA;EACA,MAAM,SAAS;GAAE,GAAG,KAAK;GAAU,GAAG;GAAS;EAC/C,MAAM,WAAW,eAAe,OAAO,QAAQ,OAAO,OAAO;EAE7D,MAAM,qBAAqB,SAAS,KAAK,WAAW,IAAI,GAAG,KAAK;AAEhE,SAAO,GAAG,SAAS,WAAW,qBAAqB,SAAS;;;;;;;;;CAU9D,MAAa,YACX,UACA,SACA,SACY;EACZ,MAAM,MAAM,IAAI,IAAI,KAAK,cAAc,UAAU,QAAQ,CAAC;EAC1D,MAAM,SAAS,KAAK,iBAAiB,UAAU,SAAS,QAAQ;AAEhE,OAAK,MAAM,CAAC,KAAK,UAAU,OAAO,QAAQ,OAAO,aAAa,CAC5D,KAAI,aAAa,IAAI,KAAK,OAAO,MAAM,CAAC;EAG1C,MAAM,WAAW,MAAM,KAAK,GAAG,IAAO,KAAK;GACzC,GAAG,SAAS;GACZ,SAAS;IACP,GAAG,OAAO;IACV,GAAG,SAAS,WAAW;IACxB;GACF,CAAC;AAMF,MAAI,SAAS,WAAW,OAAO,SAAS,QAAQ,IAAI,iBAAiB,KAAK,IACxE,QAAO,EAAE;AAIX,SAAO,MAFY,SAAS,MAAM;;;;;ACrOtC,MAAM,sBAAsB,cAAsB,YAAY,MAAO;;;;;;;AAQrE,MAAa,0BAA0B,OACrC,SACA,iBAA2D,SAC5B;CAC/B,MAAM,EAAE,KAAK,QAAQ,UAAU;AAC/B,KAAI,CAAC,IACH,OAAM,IAAI,MAAM,iCAAiC;AAEnD,KAAI,CAAC,OACH,OAAM,IAAI,MAAM,oCAAoC;CAGtD,MAAM,SAAS,IAAI,kBAAkB,QAAQ;CAE7C,MAAM,eAAe,YAAY;EAC/B,MAAM,WAAW,MAAM,OAAO,gBAAgB;AAE9C,SAAO,eAAe,SAAS,aAAa;AAE5C,MAAI,OAAO,mBAAmB,WAC5B,kBAAiB,SAAS;AAIZ,mBAAiB,KAAK,cAAc,EAAE,mBAAmB,SAAS,WAAW,CACtF,CAAC,OAAO;;AAIjB,KAAI,CAAC,eACH,QAAO;AAGT,KAAI,MACF,KAAI;EAGF,MAAM,SAAS,oBAAmB,MADL,OAAO,oBAAoB,EAAE,OAAO,CAAC,EACjB,IAAI;AAErD,MAAI,SAAS,KAAK,KAAK,GAAG,IACxB,OAAM,cAAc;MAGJ,kBAAiB,KAAK,cAAc,EAAE,SAAS,KAAK,KAAK,CAElE,CAAC,OAAO;SAEX;AAEN,QAAM,cAAc;;KAItB,OAAM,cAAc;AAGtB,QAAO"}

package/package.json

@@ -1,19 +1,23 @@
 {
   "name": "@blizzard-api/client",
-  "version": "3.0.2",
+  "version": "4.0.0",
   "license": "MIT",
   "author": "Putro",
   "description": "A node.js client to integrate with the blizzard battle.net api.",
-  "repository": "https://github.com/Pewtro/blizzard-api/tree/main/packages/client",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Pewtro/blizzard-api.git",
+    "directory": "packages/client"
+  },
   "type": "module",
   "engines": {
-    "node": "^20.19.0 || ^22.13.0 || >=24"
+    "node": "^22.13.0 || ^24 || ^26"
   },
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "exports": {
     "import": {
-      "@blizzard-api/client-local": "./src/index.ts",
+      "@blizzard-api/source": "./src/index.ts",
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
     }
@@ -40,18 +44,18 @@
     "hearthstone"
   ],
   "dependencies": {
-    "ky": "1.14.3"
+    "ky": "2.0.2"
   },
   "peerDependencies": {
-    "@blizzard-api/core": "3.0.2"
+    "@blizzard-api/core": "4.0.0"
   },
   "devDependencies": {
-    "@blizzard-api/classic-wow": "3.0.4",
-    "@blizzard-api/d3": "2.0.2",
-    "@blizzard-api/hs": "2.0.2",
-    "@blizzard-api/sc2": "2.0.2",
-    "@blizzard-api/wow": "3.0.5",
-    "@blizzard-api/core": "3.0.2"
+    "@blizzard-api/classic-wow": "4.0.0",
+    "@blizzard-api/core": "4.0.0",
+    "@blizzard-api/d3": "3.0.0",
+    "@blizzard-api/hs": "3.0.0",
+    "@blizzard-api/sc2": "3.0.0",
+    "@blizzard-api/wow": "4.0.0"
   },
   "scripts": {
     "build": "tsdown",