@blizzard-api/client 5.1.1 → 5.2.0

package/dist/index.js

@@ -27,7 +27,11 @@ var BlizzardApiClient = class {
 			secret: options.secret,
 			token: options.token
 		};
-		this.ky = ky.create(options.kyOptions);
+		const kyOptions = {
+			timeout: 15e3,
+			...options.kyOptions
+		};
+		this.ky = ky.create(kyOptions);
 	}
 	/**
 	* Get an access token.
@@ -129,7 +133,6 @@ var BlizzardApiClient = class {
 		const config = this.getRequestConfig(resource, options);
 		for (const [key, value] of Object.entries(config.searchParams)) url.searchParams.set(key, String(value));
 		const response = await this.ky.get(url, {
-			timeout: 15e3,
 			...options?.kyOptions,
 			headers: {
 				...config.headers,

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 } 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   * 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   * @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  ): {\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    // Build a new object with the defined parameters so we never mutate the\r\n    // caller's resource, which may be reused across requests.\r\n    const parameters: Record<string, unknown> = {};\r\n    if (resource.parameters) {\r\n      for (const [key, value] of Object.entries(resource.parameters as Record<string, unknown>)) {\r\n        if (value !== undefined) {\r\n          parameters[key] = value;\r\n        }\r\n      }\r\n    }\r\n\r\n    return {\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   * 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   * 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   * @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  ): Promise<T | undefined> {\r\n    const url = new URL(this.getRequestUrl(resource, options));\r\n    const config = this.getRequestConfig(resource, options);\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      timeout: 15_000,\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;\r\n    }\r\n    const data = await response.json();\r\n\r\n    return data;\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   * 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","//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\n/**\r\n * How long before a token's actual expiry it should be refreshed, in milliseconds.\r\n * This buffer avoids using a token that could expire mid-request.\r\n */\r\nconst REFRESH_BUFFER_MS = 60_000;\r\n\r\n/**\r\n * Calculate the delay (in milliseconds) to wait before refreshing a token, based on the\r\n * token's remaining lifetime.\r\n * @param lifetimeInSeconds The token's lifetime in seconds, as returned in the `expires_in`\r\n * field when requesting a new access token.\r\n * @returns The delay in milliseconds before the token should be refreshed.\r\n */\r\nconst getRefreshDelayFromLifetime = (lifetimeInSeconds: number): number => lifetimeInSeconds * 1000 - REFRESH_BUFFER_MS;\r\n\r\n/**\r\n * Calculate the delay (in milliseconds) to wait before refreshing a token, based on the\r\n * token's absolute expiry time.\r\n * @param expiryInSeconds The token's expiry as a Unix timestamp in seconds, as returned in the\r\n * `exp` field when validating an existing access token.\r\n * @returns The delay in milliseconds before the token should be refreshed. May be negative if the\r\n * token is already within its refresh buffer or expired.\r\n */\r\nconst getRefreshDelayFromExpiry = (expiryInSeconds: number): number =>\r\n  expiryInSeconds * 1000 - REFRESH_BUFFER_MS - Date.now();\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  //Schedule a token refresh after the given delay, without keeping the process alive.\r\n  const scheduleRefresh = (delayInMilliseconds: number) => {\r\n    const timeout = setTimeout(() => void refreshToken(), delayInMilliseconds);\r\n    //Unref the timeout so the process can exit while a refresh is pending.\r\n    timeout.unref();\r\n  };\r\n\r\n  const refreshToken = async () => {\r\n    const response = await client.refreshAccessToken();\r\n\r\n    if (typeof onTokenRefresh === 'function') {\r\n      onTokenRefresh(response);\r\n    }\r\n\r\n    scheduleRefresh(getRefreshDelayFromLifetime(response.expires_in));\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 refreshDelay = getRefreshDelayFromExpiry(validatedToken.exp);\r\n      //If the token is already within its refresh buffer, refresh it now\r\n      if (refreshDelay < REFRESH_BUFFER_MS) {\r\n        await refreshToken();\r\n      } else {\r\n        //Otherwise schedule a refresh for when the token nears expiry\r\n        scheduleRefresh(refreshDelay);\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,MAAM;EACxE,KAAK,WAAW;GACd,KAAK,QAAQ;GACL;GACA;GACR,QAAQ,QAAQ;GAChB,OAAO,QAAQ;EACjB;EACA,KAAK,KAAK,GAAG,OAAO,QAAQ,SAAS;CACvC;;;;;;;;;;;;;;CAeA,iBAAwB,OAAO,YAAgE;EAC7F,MAAM,EAAE,KAAK,QAAQ,WAAW;GAAE,GAAG,KAAK;GAAU,GAAG;EAAQ;EAC/D,MAAM,YAAY,OAAO,KAAK,GAAG,IAAI,GAAG,QAAQ,CAAC,CAAC,SAAS,QAAQ;EAanE,OAAO,MAZgB,KAAK,GACzB,KAAkB,WAAW,OAAO,0BAA0B;GAC7D,SAAS;IACP,eAAe,SAAS;IACxB,gBAAgB;GAClB;GACA,cAAc,EACZ,YAAY,qBACd;EACF,CAAC,CAAC,CACD,KAAK;CAGV;;;;;;;CAQA,iBACE,UACA,SAQA;EACA,MAAM,SAAS;GAAE,GAAG,KAAK;GAAU,GAAG;EAAQ;EAC9C,MAAM,WAAW,eAAe,OAAO,QAAQ,OAAO,MAAM;EAE5D,MAAM,YAAY,SAAS,YACvB,EAAE,uBAAuB,GAAG,SAAS,UAAU,GAAG,SAAS,SAAS,IACpE,KAAA;EAIJ,MAAM,aAAsC,CAAC;EAC7C,IAAI,SAAS,YACN;QAAA,MAAM,CAAC,KAAK,UAAU,OAAO,QAAQ,SAAS,UAAqC,GACtF,IAAI,UAAU,KAAA,GACZ,WAAW,OAAO;EAAA;EAKxB,OAAO;GACL,SAAS;IACP,GAAG;IACH,eAAe,UAAU,OAAO;IAChC,gBAAgB;GAClB;GACA,cAAc;IACZ,GAAG;IACH,QAAQ,SAAS;GACnB;EACF;CACF;;;;;;;CAQA,cACE,UACA,SACA;EACA,MAAM,SAAS;GAAE,GAAG,KAAK;GAAU,GAAG;EAAQ;EAC9C,MAAM,WAAW,eAAe,OAAO,QAAQ,OAAO,MAAM;EAE5D,MAAM,qBAAqB,SAAS,KAAK,WAAW,GAAG,IAAI,KAAK;EAEhE,OAAO,GAAG,SAAS,WAAW,qBAAqB,SAAS;CAC9D;;;;;;;;;;;;;;CAeA,qBAA4B,OAAO,YAAgE;EACjG,MAAM,WAAW,MAAM,KAAK,eAAe,OAAO;EAClD,KAAK,eAAe,SAAS,YAAY;EACzC,OAAO;CACT;;;;;;;CAOA,MAAa,YACX,UACA,SACwB;EACxB,MAAM,MAAM,IAAI,IAAI,KAAK,cAAc,UAAU,OAAO,CAAC;EACzD,MAAM,SAAS,KAAK,iBAAiB,UAAU,OAAO;EAEtD,KAAK,MAAM,CAAC,KAAK,UAAU,OAAO,QAAQ,OAAO,YAAY,GAC3D,IAAI,aAAa,IAAI,KAAK,OAAO,KAAK,CAAC;EAGzC,MAAM,WAAW,MAAM,KAAK,GAAG,IAAO,KAAK;GACzC,SAAS;GACT,GAAG,SAAS;GACZ,SAAS;IACP,GAAG,OAAO;IACV,GAAG,SAAS,WAAW;GACzB;EACF,CAAC;EAMD,IAAI,SAAS,WAAW,OAAO,SAAS,QAAQ,IAAI,gBAAgB,MAAM,KACxE;EAIF,OAAO,MAFY,SAAS,KAAK;CAGnC;;;;;CAMA,kBAAyB,UAAwB;EAC/C,KAAK,SAAS,QAAQ;CACxB;;;;;;;;;;CAWA,sBAA6B,OAAO,YAAiF;EACnH,MAAM,EAAE,QAAQ,UAAU;GAAE,GAAG,KAAK;GAAU,GAAG;EAAQ;EAEzD,IAAI,CAAC,OACH,MAAM,IAAI,MAAM,oFAAoF;EAYtG,OAAO,MATgB,KAAK,GACzB,KAAkC,WAAW,OAAO,gCAAgC;GACnF,MAAM,UAAU,EAAE,MAAM,CAAC;GACzB,SAAS,EACP,gBAAgB,oCAClB;EACF,CAAC,CAAC,CACD,KAAK;CAGV;AACF;;;;;;;AClOA,MAAM,oBAAoB;;;;;;;;AAS1B,MAAM,+BAA+B,sBAAsC,oBAAoB,MAAO;;;;;;;;;AAUtG,MAAM,6BAA6B,oBACjC,kBAAkB,MAAO,oBAAoB,KAAK,IAAI;;;;;;;AAQxD,MAAa,0BAA0B,OACrC,SACA,iBAA2D,SAC5B;CAC/B,MAAM,EAAE,KAAK,QAAQ,UAAU;CAC/B,IAAI,CAAC,KACH,MAAM,IAAI,MAAM,gCAAgC;CAElD,IAAI,CAAC,QACH,MAAM,IAAI,MAAM,mCAAmC;CAGrD,MAAM,SAAS,IAAI,kBAAkB,OAAO;CAG5C,MAAM,mBAAmB,wBAAgC;EAGvD,iBAFiC,KAAK,aAAa,GAAG,mBAEhD,CAAC,CAAC,MAAM;CAChB;CAEA,MAAM,eAAe,YAAY;EAC/B,MAAM,WAAW,MAAM,OAAO,mBAAmB;EAEjD,IAAI,OAAO,mBAAmB,YAC5B,eAAe,QAAQ;EAGzB,gBAAgB,4BAA4B,SAAS,UAAU,CAAC;CAClE;CAGA,IAAI,CAAC,gBACH,OAAO;CAGT,IAAI,OACF,IAAI;EAEF,MAAM,iBAAiB,MAAM,OAAO,oBAAoB,EAAE,MAAM,CAAC;EACjE,MAAM,eAAe,0BAA0B,eAAe,GAAG;EAEjE,IAAI,eAAe,mBACjB,MAAM,aAAa;OAGnB,gBAAgB,YAAY;CAEhC,QAAQ;EAEN,MAAM,aAAa;CACrB;MAGA,MAAM,aAAa;CAGrB,OAAO;AACT"}
+{"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    const kyOptions = {\r\n      timeout: 15_000,\r\n      ...options.kyOptions,\r\n    };\r\n    this.ky = ky.create(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   * 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   * @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  ): {\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    // Build a new object with the defined parameters so we never mutate the\r\n    // caller's resource, which may be reused across requests.\r\n    const parameters: Record<string, unknown> = {};\r\n    if (resource.parameters) {\r\n      for (const [key, value] of Object.entries(resource.parameters as Record<string, unknown>)) {\r\n        if (value !== undefined) {\r\n          parameters[key] = value;\r\n        }\r\n      }\r\n    }\r\n\r\n    return {\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   * 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   * 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   * @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  ): Promise<T | undefined> {\r\n    const url = new URL(this.getRequestUrl(resource, options));\r\n    const config = this.getRequestConfig(resource, options);\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;\r\n    }\r\n    const data = await response.json();\r\n\r\n    return data;\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   * 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","//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\n/**\r\n * How long before a token's actual expiry it should be refreshed, in milliseconds.\r\n * This buffer avoids using a token that could expire mid-request.\r\n */\r\nconst REFRESH_BUFFER_MS = 60_000;\r\n\r\n/**\r\n * Calculate the delay (in milliseconds) to wait before refreshing a token, based on the\r\n * token's remaining lifetime.\r\n * @param lifetimeInSeconds The token's lifetime in seconds, as returned in the `expires_in`\r\n * field when requesting a new access token.\r\n * @returns The delay in milliseconds before the token should be refreshed.\r\n */\r\nconst getRefreshDelayFromLifetime = (lifetimeInSeconds: number): number => lifetimeInSeconds * 1000 - REFRESH_BUFFER_MS;\r\n\r\n/**\r\n * Calculate the delay (in milliseconds) to wait before refreshing a token, based on the\r\n * token's absolute expiry time.\r\n * @param expiryInSeconds The token's expiry as a Unix timestamp in seconds, as returned in the\r\n * `exp` field when validating an existing access token.\r\n * @returns The delay in milliseconds before the token should be refreshed. May be negative if the\r\n * token is already within its refresh buffer or expired.\r\n */\r\nconst getRefreshDelayFromExpiry = (expiryInSeconds: number): number =>\r\n  expiryInSeconds * 1000 - REFRESH_BUFFER_MS - Date.now();\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  //Schedule a token refresh after the given delay, without keeping the process alive.\r\n  const scheduleRefresh = (delayInMilliseconds: number) => {\r\n    const timeout = setTimeout(() => void refreshToken(), delayInMilliseconds);\r\n    //Unref the timeout so the process can exit while a refresh is pending.\r\n    timeout.unref();\r\n  };\r\n\r\n  const refreshToken = async () => {\r\n    const response = await client.refreshAccessToken();\r\n\r\n    if (typeof onTokenRefresh === 'function') {\r\n      onTokenRefresh(response);\r\n    }\r\n\r\n    scheduleRefresh(getRefreshDelayFromLifetime(response.expires_in));\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 refreshDelay = getRefreshDelayFromExpiry(validatedToken.exp);\r\n      //If the token is already within its refresh buffer, refresh it now\r\n      if (refreshDelay < REFRESH_BUFFER_MS) {\r\n        await refreshToken();\r\n      } else {\r\n        //Otherwise schedule a refresh for when the token nears expiry\r\n        scheduleRefresh(refreshDelay);\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,MAAM;EACxE,KAAK,WAAW;GACd,KAAK,QAAQ;GACL;GACA;GACR,QAAQ,QAAQ;GAChB,OAAO,QAAQ;EACjB;EACA,MAAM,YAAY;GAChB,SAAS;GACT,GAAG,QAAQ;EACb;EACA,KAAK,KAAK,GAAG,OAAO,SAAS;CAC/B;;;;;;;;;;;;;;CAeA,iBAAwB,OAAO,YAAgE;EAC7F,MAAM,EAAE,KAAK,QAAQ,WAAW;GAAE,GAAG,KAAK;GAAU,GAAG;EAAQ;EAC/D,MAAM,YAAY,OAAO,KAAK,GAAG,IAAI,GAAG,QAAQ,CAAC,CAAC,SAAS,QAAQ;EAanE,OAAO,MAZgB,KAAK,GACzB,KAAkB,WAAW,OAAO,0BAA0B;GAC7D,SAAS;IACP,eAAe,SAAS;IACxB,gBAAgB;GAClB;GACA,cAAc,EACZ,YAAY,qBACd;EACF,CAAC,CAAC,CACD,KAAK;CAGV;;;;;;;CAQA,iBACE,UACA,SAQA;EACA,MAAM,SAAS;GAAE,GAAG,KAAK;GAAU,GAAG;EAAQ;EAC9C,MAAM,WAAW,eAAe,OAAO,QAAQ,OAAO,MAAM;EAE5D,MAAM,YAAY,SAAS,YACvB,EAAE,uBAAuB,GAAG,SAAS,UAAU,GAAG,SAAS,SAAS,IACpE,KAAA;EAIJ,MAAM,aAAsC,CAAC;EAC7C,IAAI,SAAS,YACN;QAAA,MAAM,CAAC,KAAK,UAAU,OAAO,QAAQ,SAAS,UAAqC,GACtF,IAAI,UAAU,KAAA,GACZ,WAAW,OAAO;EAAA;EAKxB,OAAO;GACL,SAAS;IACP,GAAG;IACH,eAAe,UAAU,OAAO;IAChC,gBAAgB;GAClB;GACA,cAAc;IACZ,GAAG;IACH,QAAQ,SAAS;GACnB;EACF;CACF;;;;;;;CAQA,cACE,UACA,SACA;EACA,MAAM,SAAS;GAAE,GAAG,KAAK;GAAU,GAAG;EAAQ;EAC9C,MAAM,WAAW,eAAe,OAAO,QAAQ,OAAO,MAAM;EAE5D,MAAM,qBAAqB,SAAS,KAAK,WAAW,GAAG,IAAI,KAAK;EAEhE,OAAO,GAAG,SAAS,WAAW,qBAAqB,SAAS;CAC9D;;;;;;;;;;;;;;CAeA,qBAA4B,OAAO,YAAgE;EACjG,MAAM,WAAW,MAAM,KAAK,eAAe,OAAO;EAClD,KAAK,eAAe,SAAS,YAAY;EACzC,OAAO;CACT;;;;;;;CAQA,MAAa,YACX,UACA,SACwB;EACxB,MAAM,MAAM,IAAI,IAAI,KAAK,cAAc,UAAU,OAAO,CAAC;EACzD,MAAM,SAAS,KAAK,iBAAiB,UAAU,OAAO;EAEtD,KAAK,MAAM,CAAC,KAAK,UAAU,OAAO,QAAQ,OAAO,YAAY,GAC3D,IAAI,aAAa,IAAI,KAAK,OAAO,KAAK,CAAC;EAGzC,MAAM,WAAW,MAAM,KAAK,GAAG,IAAO,KAAK;GACzC,GAAG,SAAS;GACZ,SAAS;IACP,GAAG,OAAO;IACV,GAAG,SAAS,WAAW;GACzB;EACF,CAAC;EAMD,IAAI,SAAS,WAAW,OAAO,SAAS,QAAQ,IAAI,gBAAgB,MAAM,KACxE;EAIF,OAAO,MAFY,SAAS,KAAK;CAGnC;;;;;CAMA,kBAAyB,UAAwB;EAC/C,KAAK,SAAS,QAAQ;CACxB;;;;;;;;;;CAWA,sBAA6B,OAAO,YAAiF;EACnH,MAAM,EAAE,QAAQ,UAAU;GAAE,GAAG,KAAK;GAAU,GAAG;EAAQ;EAEzD,IAAI,CAAC,OACH,MAAM,IAAI,MAAM,oFAAoF;EAYtG,OAAO,MATgB,KAAK,GACzB,KAAkC,WAAW,OAAO,gCAAgC;GACnF,MAAM,UAAU,EAAE,MAAM,CAAC;GACzB,SAAS,EACP,gBAAgB,oCAClB;EACF,CAAC,CAAC,CACD,KAAK;CAGV;AACF;;;;;;;ACtOA,MAAM,oBAAoB;;;;;;;;AAS1B,MAAM,+BAA+B,sBAAsC,oBAAoB,MAAO;;;;;;;;;AAUtG,MAAM,6BAA6B,oBACjC,kBAAkB,MAAO,oBAAoB,KAAK,IAAI;;;;;;;AAQxD,MAAa,0BAA0B,OACrC,SACA,iBAA2D,SAC5B;CAC/B,MAAM,EAAE,KAAK,QAAQ,UAAU;CAC/B,IAAI,CAAC,KACH,MAAM,IAAI,MAAM,gCAAgC;CAElD,IAAI,CAAC,QACH,MAAM,IAAI,MAAM,mCAAmC;CAGrD,MAAM,SAAS,IAAI,kBAAkB,OAAO;CAG5C,MAAM,mBAAmB,wBAAgC;EAGvD,iBAFiC,KAAK,aAAa,GAAG,mBAEhD,CAAC,CAAC,MAAM;CAChB;CAEA,MAAM,eAAe,YAAY;EAC/B,MAAM,WAAW,MAAM,OAAO,mBAAmB;EAEjD,IAAI,OAAO,mBAAmB,YAC5B,eAAe,QAAQ;EAGzB,gBAAgB,4BAA4B,SAAS,UAAU,CAAC;CAClE;CAGA,IAAI,CAAC,gBACH,OAAO;CAGT,IAAI,OACF,IAAI;EAEF,MAAM,iBAAiB,MAAM,OAAO,oBAAoB,EAAE,MAAM,CAAC;EACjE,MAAM,eAAe,0BAA0B,eAAe,GAAG;EAEjE,IAAI,eAAe,mBACjB,MAAM,aAAa;OAGnB,gBAAgB,YAAY;CAEhC,QAAQ;EAEN,MAAM,aAAa;CACrB;MAGA,MAAM,aAAa;CAGrB,OAAO;AACT"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blizzard-api/client",
-  "version": "5.1.1",
+  "version": "5.2.0",
   "license": "MIT",
   "author": "Putro",
   "description": "A node.js client to integrate with the blizzard battle.net api.",
@@ -51,12 +51,12 @@
     "@blizzard-api/core": "4.1.2"
   },
   "devDependencies": {
-    "@blizzard-api/classic-wow": "4.0.5",
+    "@blizzard-api/classic-wow": "4.1.0",
     "@blizzard-api/core": "4.1.2",
     "@blizzard-api/d3": "3.1.1",
     "@blizzard-api/hs": "3.1.1",
     "@blizzard-api/sc2": "3.1.2",
-    "@blizzard-api/wow": "4.0.8"
+    "@blizzard-api/wow": "4.1.0"
   },
   "scripts": {
     "build": "tsdown",