@blizzard-api/client - npm Package Compare versions

Comparing version 2.2.0 to 2.2.1

dist/index.d.ts

@@ -5,15 +5,4 @@ import { Locales, Origins, Resource, ResourceResponse, getBlizzardApi } from "@blizzard-api/core";
 //#region src/client/types.d.ts
+
 /**
-* An access token response from the Blizzard API.
-* @see https://develop.battle.net/documentation/guides/using-oauth
-* @see https://develop.battle.net/documentation/guides/using-oauth/client-credentials-flow¨
-* @example
-* const response: AccessToken = {
-*  access_token: 'access-token',
-*  token_type: 'bearer',
-*  expires_in: 86399,
-*  sub: 'client-id',
-* };
-*/
-/**
  * An access token response from the Blizzard API.
@@ -112,3 +101,4 @@ * @see https://develop.battle.net/documentation/guides/using-oauth
   scope: Array<string>;
-} //#endregion
+}
+//#endregion
 //#region src/client/client.d.ts
@@ -213,3 +203,2 @@ /**
 }
-
 //#endregion
@@ -224,5 +213,4 @@ //#region src/client/create-client.d.ts
 declare const createBlizzardApiClient: (options: ClientOptions, onTokenRefresh?: ((token: AccessToken) => void) | boolean) => Promise<BlizzardApiClient>;
-
 //#endregion
 export { AccessToken, AccessTokenRequestArguments, AxiosCompatability, ClientOptions, ValidateAccessTokenArguments, ValidateAccessTokenResponse, createBlizzardApiClient, createBlizzardApiClient as default };
 //# sourceMappingURL=index.d.ts.map

dist/index.js

@@ -31,2 +31,4 @@ import { setTimeout } from "node:timers";
 var BlizzardApiClient = class {
+	defaults;
+	ky;
 	constructor(options) {
@@ -33,0 +35,0 @@ const { locale, origin } = getBlizzardApi(options.origin, options.locale);

dist/index.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"index.js","names":["options: ClientOptions","options?: AccessTokenRequestArguments","token: string","options?: ValidateAccessTokenArguments","resource: Resource<T, object, Protected>","options?: Partial<ClientOptions>","headers?: Record<string, string>","expiresIn: number","options: ClientOptions","onTokenRefresh: ((token: AccessToken) => void) | boolean"],"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  AxiosCompatability,\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<AxiosCompatability<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 {\r\n      data: response,\r\n      ...response,\r\n    };\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 (\r\n    options?: AccessTokenRequestArguments,\r\n  ): Promise<AxiosCompatability<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 (\r\n    options?: ValidateAccessTokenArguments,\r\n  ): Promise<AxiosCompatability<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 {\r\n      data: response,\r\n      ...response,\r\n    };\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<AxiosCompatability<T>> {\r\n    const url = this.getRequestUrl(resource, options);\r\n    const config = this.getRequestConfig(resource, options, headers);\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      searchParams: { ...config.searchParams, ...Object.entries(options?.kyOptions?.searchParams ?? {}) },\r\n    });\r\n    const data = await response.json();\r\n\r\n    return {\r\n      data,\r\n      ...data,\r\n    };\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":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyBA,IAAa,oBAAb,MAA+B;CAW7B,YAAYA,SAAwB;EAClC,MAAM,EAAE,QAAQ,QAAQ,GAAG,eAAe,QAAQ,QAAQ,QAAQ,OAAO;AACzE,OAAK,WAAW;GACd,KAAK,QAAQ;GACL;GACA;GACR,QAAQ,QAAQ;GAChB,OAAO,QAAQ;EAChB;AACD,OAAK,KAAK,GAAG,OAAO,QAAQ,UAAU;CACvC;;;;;;;;;;;;;;;;;;;;;;;;;;CAeD,iBAAwB,OAAOC,YAAoF;EACjH,MAAM,EAAE,KAAK,QAAQ,QAAQ,GAAG;GAAE,GAAG,KAAK;GAAU,GAAG;EAAS;EAChE,MAAM,YAAY,OAAO,MAAM,EAAE,IAAI,GAAG,OAAO,EAAE,CAAC,SAAS,SAAS;EACpE,MAAM,WAAW,MAAM,KAAK,GACzB,MAAmB,UAAU,OAAO,0BAA0B;GAC7D,SAAS;IACP,gBAAgB,QAAQ,UAAU;IAClC,gBAAgB;GACjB;GACD,cAAc,EACZ,YAAY,qBACb;EACF,EAAC,CACD,MAAM;AAET,SAAO;GACL,MAAM;GACN,GAAG;EACJ;CACF;;;;;;;;CAMD,iBAAwB,CAACC,UAAwB;AAC/C,OAAK,SAAS,QAAQ;CACvB;;;;;;;;;;;;;;;;;;;;;;;;;;CAeD,qBAA4B,OAC1BD,YAC6C;EAC7C,MAAM,WAAW,MAAM,KAAK,eAAe,QAAQ;AACnD,OAAK,eAAe,SAAS,aAAa;AAC1C,SAAO;CACR;;;;;;;;;;;;;;;;;;CAWD,sBAA6B,OAC3BE,YAC6D;EAC7D,MAAM,EAAE,QAAQ,OAAO,GAAG;GAAE,GAAG,KAAK;GAAU,GAAG;EAAS;AAE1D,OAAK,MACH,OAAM,IAAI,MAAM;EAGlB,MAAM,WAAW,MAAM,KAAK,GACzB,MAAmC,UAAU,OAAO,gCAAgC;GACnF,MAAM,UAAU,EAAE,MAAO,EAAC;GAC1B,SAAS,EACP,gBAAgB,oCACjB;EACF,EAAC,CACD,MAAM;AAET,SAAO;GACL,MAAM;GACN,GAAG;EACJ;CACF;;;;;;;;;;;;;;CASD,iBACEC,UACAC,SACAC,SAQA;EACA,MAAM,SAAS;GAAE,GAAG,KAAK;GAAU,GAAG;EAAS;EAC/C,MAAM,WAAW,eAAe,OAAO,QAAQ,OAAO,OAAO;EAE7D,MAAM,YAAY,SAAS,YACvB,EAAE,wBAAwB,EAAE,SAAS,UAAU,GAAG,SAAS,OAAO,EAAG;EAGzE,MAAM,aAAa,SAAS;AAC5B,MAAI,YACF;QAAK,MAAM,OAAO,OAAO,KAAK,WAAW,CACvC,KAAI,WAAW,gBACb,QAAO,WAAW;EAErB;AAGH,SAAO;GACL,SAAS;IACP,GAAG;IACH,GAAG;IACH,gBAAgB,SAAS,OAAO,MAAM;IACtC,gBAAgB;GACjB;GACD,cAAc;IACZ,GAAG;IACH,QAAQ,SAAS;GAClB;EACF;CACF;;;;;;;;;;;;CAQD,cACEF,UACAC,SACA;EACA,MAAM,SAAS;GAAE,GAAG,KAAK;GAAU,GAAG;EAAS;EAC/C,MAAM,WAAW,eAAe,OAAO,QAAQ,OAAO,OAAO;EAE7D,MAAM,qBAAqB,SAAS,KAAK,WAAW,IAAI,GAAG,KAAK;AAEhE,UAAQ,EAAE,SAAS,SAAS,EAAE,mBAAmB,EAAE,SAAS,KAAK;CAClE;;;;;;;;;;;;;;CASD,MAAa,YACXD,UACAC,SACAC,SACyC;EACzC,MAAM,MAAM,KAAK,cAAc,UAAU,QAAQ;EACjD,MAAM,SAAS,KAAK,iBAAiB,UAAU,SAAS,QAAQ;EAEhE,MAAM,WAAW,MAAM,KAAK,GAAG,IAAO,KAAK;GACzC,GAAG,SAAS;GACZ,SAAS;IACP,GAAG,OAAO;IACV,GAAG,SAAS,WAAW;GACxB;GACD,cAAc;IAAE,GAAG,OAAO;IAAc,GAAG,OAAO,QAAQ,SAAS,WAAW,gBAAgB,CAAE,EAAC;GAAE;EACpG,EAAC;EACF,MAAM,OAAO,MAAM,SAAS,MAAM;AAElC,SAAO;GACL;GACA,GAAG;EACJ;CACF;AACF;;;;AC5OD,MAAM,qBAAqB,CAACC,cAAsB,YAAY,MAAO;;;;;;;;;;;;AAQrE,MAAa,0BAA0B,OACrCC,SACAC,iBAA2D,SAC5B;CAC/B,MAAM,EAAE,KAAK,QAAQ,OAAO,GAAG;AAC/B,MAAK,IACH,OAAM,IAAI,OAAO;AAEnB,MAAK,OACH,OAAM,IAAI,OAAO;CAGnB,MAAM,SAAS,IAAI,kBAAkB;CAErC,MAAM,eAAe,YAAY;EAC/B,MAAM,WAAW,MAAM,OAAO,gBAAgB;AAE9C,SAAO,eAAe,SAAS,aAAa;AAE5C,aAAW,mBAAmB,WAC5B,kBAAiB,SAAS;EAI5B,MAAM,UAAU,WAAW,WAAW,cAAc,EAAE,mBAAmB,SAAS,WAAW,CAAC;AAC9F,UAAQ,OAAO;CAChB;AAGD,MAAK,eACH,QAAO;AAGT,KAAI,MACF,KAAI;EAEF,MAAM,iBAAiB,MAAM,OAAO,oBAAoB,EAAE,MAAO,EAAC;EAClE,MAAM,SAAS,mBAAmB,eAAe,IAAI;AAErD,MAAI,SAAS,KAAK,KAAK,GAAG,IACxB,OAAM,cAAc;OACf;GAEL,MAAM,UAAU,WAAW,WAAW,cAAc,EAAE,SAAS,KAAK,KAAK,CAAC;AAE1E,WAAQ,OAAO;EAChB;CACF,QAAO;AAEN,QAAM,cAAc;CACrB;KAGD,OAAM,cAAc;AAGtB,QAAO;AACR"}
+{"version":3,"file":"index.js","names":["options: ClientOptions","options?: AccessTokenRequestArguments","token: string","options?: ValidateAccessTokenArguments","resource: Resource<T, object, Protected>","options?: Partial<ClientOptions>","headers?: Record<string, string>","expiresIn: number","options: ClientOptions","onTokenRefresh: ((token: AccessToken) => void) | boolean"],"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  AxiosCompatability,\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<AxiosCompatability<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 {\r\n      data: response,\r\n      ...response,\r\n    };\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 (\r\n    options?: AccessTokenRequestArguments,\r\n  ): Promise<AxiosCompatability<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 (\r\n    options?: ValidateAccessTokenArguments,\r\n  ): Promise<AxiosCompatability<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 {\r\n      data: response,\r\n      ...response,\r\n    };\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<AxiosCompatability<T>> {\r\n    const url = this.getRequestUrl(resource, options);\r\n    const config = this.getRequestConfig(resource, options, headers);\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      searchParams: { ...config.searchParams, ...Object.entries(options?.kyOptions?.searchParams ?? {}) },\r\n    });\r\n    const data = await response.json();\r\n\r\n    return {\r\n      data,\r\n      ...data,\r\n    };\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":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyBA,IAAa,oBAAb,MAA+B;CAC7B,AAAO;CAQP,AAAQ;CAER,YAAYA,SAAwB;EAClC,MAAM,EAAE,QAAQ,QAAQ,GAAG,eAAe,QAAQ,QAAQ,QAAQ,OAAO;EACzE,KAAK,WAAW;GACd,KAAK,QAAQ;GACL;GACA;GACR,QAAQ,QAAQ;GAChB,OAAO,QAAQ;EAChB;EACD,KAAK,KAAK,GAAG,OAAO,QAAQ,UAAU;CACvC;;;;;;;;;;;;;;;;;;;;;;;;;;CAeD,AAAO,iBAAiB,OAAOC,YAAoF;EACjH,MAAM,EAAE,KAAK,QAAQ,QAAQ,GAAG;GAAE,GAAG,KAAK;GAAU,GAAG;EAAS;EAChE,MAAM,YAAY,OAAO,KAAK,GAAG,IAAI,CAAC,EAAE,QAAQ,CAAC,CAAC,SAAS,SAAS;EACpE,MAAM,WAAW,MAAM,KAAK,GACzB,KAAkB,CAAC,QAAQ,EAAE,OAAO,uBAAuB,CAAC,EAAE;GAC7D,SAAS;IACP,eAAe,CAAC,MAAM,EAAE,WAAW;IACnC,gBAAgB;GACjB;GACD,cAAc,EACZ,YAAY,qBACb;EACF,EAAC,CACD,MAAM;AAET,SAAO;GACL,MAAM;GACN,GAAG;EACJ;CACF;;;;;;;;CAMD,AAAO,iBAAiB,CAACC,UAAwB;EAC/C,KAAK,SAAS,QAAQ;CACvB;;;;;;;;;;;;;;;;;;;;;;;;;;CAeD,AAAO,qBAAqB,OAC1BD,YAC6C;EAC7C,MAAM,WAAW,MAAM,KAAK,eAAe,QAAQ;EACnD,KAAK,eAAe,SAAS,aAAa;AAC1C,SAAO;CACR;;;;;;;;;;;;;;;;;;CAWD,AAAO,sBAAsB,OAC3BE,YAC6D;EAC7D,MAAM,EAAE,QAAQ,OAAO,GAAG;GAAE,GAAG,KAAK;GAAU,GAAG;EAAS;AAE1D,MAAI,CAAC,MACH,OAAM,IAAI,MAAM;EAGlB,MAAM,WAAW,MAAM,KAAK,GACzB,KAAkC,CAAC,QAAQ,EAAE,OAAO,6BAA6B,CAAC,EAAE;GACnF,MAAM,UAAU,EAAE,MAAO,EAAC;GAC1B,SAAS,EACP,gBAAgB,oCACjB;EACF,EAAC,CACD,MAAM;AAET,SAAO;GACL,MAAM;GACN,GAAG;EACJ;CACF;;;;;;;;;;;;;;CASD,AAAO,iBACLC,UACAC,SACAC,SAQA;EACA,MAAM,SAAS;GAAE,GAAG,KAAK;GAAU,GAAG;EAAS;EAC/C,MAAM,WAAW,eAAe,OAAO,QAAQ,OAAO,OAAO;EAE7D,MAAM,YAAY,SAAS,YACvB,EAAE,uBAAuB,GAAG,SAAS,UAAU,CAAC,EAAE,SAAS,QAAQ,CAAE,IACrE;EAEJ,MAAM,aAAa,SAAS;AAC5B,MAAI,YACF;QAAK,MAAM,OAAO,OAAO,KAAK,WAAW,CACvC,KAAI,WAAW,SAAS,QACtB,OAAO,WAAW;EAErB;AAGH,SAAO;GACL,SAAS;IACP,GAAG;IACH,GAAG;IACH,eAAe,CAAC,OAAO,EAAE,OAAO,OAAO;IACvC,gBAAgB;GACjB;GACD,cAAc;IACZ,GAAG;IACH,QAAQ,SAAS;GAClB;EACF;CACF;;;;;;;;;;;;CAQD,AAAO,cACLF,UACAC,SACA;EACA,MAAM,SAAS;GAAE,GAAG,KAAK;GAAU,GAAG;EAAS;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,MAAM;CACnE;;;;;;;;;;;;;;CASD,MAAa,YACXD,UACAC,SACAC,SACyC;EACzC,MAAM,MAAM,KAAK,cAAc,UAAU,QAAQ;EACjD,MAAM,SAAS,KAAK,iBAAiB,UAAU,SAAS,QAAQ;EAEhE,MAAM,WAAW,MAAM,KAAK,GAAG,IAAO,KAAK;GACzC,GAAG,SAAS;GACZ,SAAS;IACP,GAAG,OAAO;IACV,GAAG,SAAS,WAAW;GACxB;GACD,cAAc;IAAE,GAAG,OAAO;IAAc,GAAG,OAAO,QAAQ,SAAS,WAAW,gBAAgB,CAAE,EAAC;GAAE;EACpG,EAAC;EACF,MAAM,OAAO,MAAM,SAAS,MAAM;AAElC,SAAO;GACL;GACA,GAAG;EACJ;CACF;AACF;;;;AC5OD,MAAM,qBAAqB,CAACC,cAAsB,YAAY,MAAO;;;;;;;;;;;;AAQrE,MAAa,0BAA0B,OACrCC,SACAC,iBAA2D,SAC5B;CAC/B,MAAM,EAAE,KAAK,QAAQ,OAAO,GAAG;AAC/B,KAAI,CAAC,IACH,OAAM,IAAI,MAAM,CAAC,8BAA8B,CAAC;AAElD,KAAI,CAAC,OACH,OAAM,IAAI,MAAM,CAAC,iCAAiC,CAAC;CAGrD,MAAM,SAAS,IAAI,kBAAkB;CAErC,MAAM,eAAe,YAAY;EAC/B,MAAM,WAAW,MAAM,OAAO,gBAAgB;EAE9C,OAAO,eAAe,SAAS,aAAa;AAE5C,MAAI,OAAO,mBAAmB,YAC5B,iBAAiB,SAAS;EAI5B,MAAM,UAAU,WAAW,MAAM,KAAK,cAAc,EAAE,mBAAmB,SAAS,WAAW,CAAC;EAC9F,QAAQ,OAAO;CAChB;AAGD,KAAI,CAAC,eACH,QAAO;AAGT,KAAI,MACF,KAAI;EAEF,MAAM,iBAAiB,MAAM,OAAO,oBAAoB,EAAE,MAAO,EAAC;EAClE,MAAM,SAAS,mBAAmB,eAAe,IAAI;AAErD,MAAI,SAAS,KAAK,KAAK,GAAG,KACxB,MAAM,cAAc;OACf;GAEL,MAAM,UAAU,WAAW,MAAM,KAAK,cAAc,EAAE,SAAS,KAAK,KAAK,CAAC;GAE1E,QAAQ,OAAO;EAChB;CACF,QAAO;EAEN,MAAM,cAAc;CACrB;MAGD,MAAM,cAAc;AAGtB,QAAO;AACR"}

package.json

 {
   "name": "@blizzard-api/client",
-  "version": "2.2.0",
+  "version": "2.2.1",
   "license": "MIT",
@@ -43,3 +43,3 @@ "author": "Putro",
   "dependencies": {
-    "ky": "1.8.1"
+    "ky": "1.8.2"
   },
@@ -55,3 +55,3 @@ "peerDependencies": {
     "@blizzard-api/sc2": "1.0.5",
-    "@blizzard-api/wow": "2.0.5"
+    "@blizzard-api/wow": "2.1.0"
   },
@@ -58,0 +58,0 @@ "scripts": {

New alerts

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Fixed alerts

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

32481

-0.51%

Lines of code

432

-2.04%

Dependency changes

• + Added

  ky@1.8.2
  (transitive)

• - Removed

  ky@1.8.1
  (transitive)

• Updated

  ky@1.8.2