@blizzard-api/client 1.0.10 → 2.0.0

package/README.md

@@ -4,14 +4,11 @@ This package provides a client that is meant to be used together with one or mor
 
 Currently available packages are:
 
-- `@blizzard-api/d3`
-- `@blizzard-api/wow`
 - `@blizzard-api/classic-wow`
-
-Planned packages are:
-
+- `@blizzard-api/d3`
 - `@blizzard-api/hs`
 - `@blizzard-api/sc2`
+- `@blizzard-api/wow`
 
 ## Installation
 

package/dist/index.js

@@ -1,5 +1,5 @@
-import { setTimeout } from 'timers';
-import { stringify } from 'querystring';
+import { setTimeout } from 'node:timers';
+import { stringify } from 'node:querystring';
 import { getBlizzardApi } from '@blizzard-api/core';
 import axios, { isAxiosError, AxiosError } from 'axios';
 

package/package.json

@@ -1,25 +1,21 @@
 {
   "name": "@blizzard-api/client",
-  "version": "1.0.10",
+  "version": "2.0.0",
   "license": "MIT",
   "author": "Putro",
   "description": "A node.js axios client to integrate with the blizzard battle.net api.",
   "repository": "https://github.com/Pewtro/blizzard-api/tree/main/packages/client",
   "type": "module",
   "engines": {
-    "node": "^18.18 || ^20.9 || ^21.1 || ^22"
+    "node": "^18.18 || >=20.9"
   },
-  "main": "./dist/index.cjs",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "exports": {
     "import": {
+      "@blizzard-api/client-local": "./src/index.ts",
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
-    },
-    "require": {
-      "types": "./dist/index.d.cts",
-      "default": "./dist/index.cjs"
     }
   },
   "files": [
@@ -47,14 +43,15 @@
     "axios": "1.7.7"
   },
   "peerDependencies": {
-    "@blizzard-api/core": "1.2.1"
+    "@blizzard-api/core": "2.0.0"
   },
   "devDependencies": {
-    "@blizzard-api/classic-wow": "1.1.6",
-    "@blizzard-api/core": "1.2.1",
-    "@blizzard-api/d3": "0.1.5",
-    "@blizzard-api/sc2": "0.1.0",
-    "@blizzard-api/wow": "1.2.1"
+    "@blizzard-api/classic-wow": "2.0.0",
+    "@blizzard-api/core": "2.0.0",
+    "@blizzard-api/d3": "1.0.0",
+    "@blizzard-api/hs": "1.0.0",
+    "@blizzard-api/sc2": "1.0.0",
+    "@blizzard-api/wow": "2.0.0"
   },
   "scripts": {
     "build": "tsup",

package/dist/index.cjs

@@ -1,207 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var timers = require('timers');
-var querystring = require('querystring');
-var core = require('@blizzard-api/core');
-var axios = require('axios');
-
-function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
-
-var axios__default = /*#__PURE__*/_interopDefault(axios);
-
-// src/client/create-client.ts
-var BlizzardApiClient = class {
-  axios = axios__default.default.create();
-  defaults;
-  /**
-   * Get an access token.
-   * @param options The access token request arguments. See {@link AccessTokenRequestArguments}.
-   * @returns The access token. See {@link AccessToken}.
-   * @example
-   * const response = await client.getAccessToken();
-   * const { access_token, token_type, expires_in, sub } = response.data;
-   * console.log(access_token, token_type, expires_in, sub);
-   * // => 'access'
-   * // => 'bearer'
-   * // => 86399
-   * // => 'client-id'
-   */
-  getAccessToken = async (options) => {
-    const { key, origin, secret } = { ...this.defaults, ...options };
-    return this.axios.post(`https://${origin}.battle.net/oauth/token`, void 0, {
-      auth: {
-        password: secret,
-        username: key
-      },
-      headers: {
-        "Content-Type": "application/json"
-      },
-      params: {
-        grant_type: "client_credentials"
-      }
-    });
-  };
-  /**
-   * Refresh the access token.
-   * @param options The access token request arguments. See {@link AccessTokenRequestArguments}.
-   * @returns The access token. See {@link AccessToken}.
-   * @example
-   * const response = await client.refreshAccessToken();
-   * const { access_token, token_type, expires_in, sub } = response.data;
-   * console.log(access_token, token_type, expires_in, sub);
-   * // => 'access'
-   * // => 'bearer'
-   * // => 86399
-   * // => 'client-id'
-   */
-  refreshAccessToken = async (options) => {
-    const response = await this.getAccessToken(options);
-    this.setAccessToken(response.data.access_token);
-    return response;
-  };
-  /**
-   * Set the access token.
-   * @param token The access token.
-   */
-  setAccessToken = (token) => {
-    this.defaults.token = token;
-  };
-  /**
-   * Validate an access token.
-   * @param options The validate access token arguments. See {@link ValidateAccessTokenArguments}.
-   * @returns The response from the Blizzard API. See {@link ValidateAccessTokenResponse}.
-   * @example
-   * const response = await client.validateAccessToken({ token: 'access' });
-   * console.log(response.data.client_id);
-   * // => 'client-id'
-   */
-  validateAccessToken = async (options) => {
-    const { origin, token } = { ...this.defaults, ...options };
-    if (!token) {
-      throw new Error("No token has been set previously or been passed to the validateAccessToken method.");
-    }
-    return await this.axios.post(
-      `https://${origin}.battle.net/oauth/check_token`,
-      querystring.stringify({ token }),
-      {
-        headers: {
-          "Content-Type": "application/x-www-form-urlencoded"
-        }
-      }
-    );
-  };
-  constructor(options) {
-    const { locale, origin } = core.getBlizzardApi(options.origin, options.locale);
-    this.defaults = {
-      key: options.key,
-      locale,
-      origin,
-      secret: options.secret,
-      token: options.token
-    };
-  }
-  /**
-   * Get the request configuration.
-   * @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.
-   * @returns The request configuration.
-   */
-  getRequestConfig(resource, options, headers) {
-    const config = { ...this.defaults, ...options };
-    const endpoint = core.getBlizzardApi(config.origin, config.locale);
-    const namespace = resource.namespace ? { "Battlenet-Namespace": `${resource.namespace}-${endpoint.origin}` } : void 0;
-    return {
-      headers: {
-        ...headers,
-        ...namespace,
-        Authorization: `Bearer ${config.token}`,
-        "Content-Type": "application/json"
-      },
-      params: {
-        locale: endpoint.locale,
-        ...resource.parameters
-      }
-    };
-  }
-  /**
-   * Get the request URL.
-   * @param resource The resource to fetch. See {@link Resource}.
-   * @param options Client options. See {@link ClientOptions}.
-   * @returns The request URL.
-   */
-  getRequestUrl(resource, options) {
-    const config = { ...this.defaults, ...options };
-    const endpoint = core.getBlizzardApi(config.origin, config.locale);
-    const backslashSeparator = resource.path.startsWith("/") ? "" : "/";
-    return `${endpoint.hostname}${backslashSeparator}${resource.path}`;
-  }
-  /**
-   * Send a request to the Blizzard API.
-   * @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.
-   * @returns The response from the Blizzard API. See {@link ResourceResponse}.
-   */
-  async sendRequest(resource, options, headers) {
-    const url = this.getRequestUrl(resource, options);
-    const config = this.getRequestConfig(resource, options, headers);
-    try {
-      return await this.axios.get(url, config);
-    } catch (error) {
-      if (axios.isAxiosError(error)) {
-        throw new axios.AxiosError(error.message, error.code);
-      }
-      throw error;
-    }
-  }
-};
-
-// src/client/create-client.ts
-var getTokenExpiration = (expiresIn) => expiresIn * 1e3 - 6e4;
-var createBlizzardApiClient = async (options, onTokenRefresh = true) => {
-  const { key, secret, token } = options;
-  if (!key) {
-    throw new Error(`Client missing 'key' parameter`);
-  }
-  if (!secret) {
-    throw new Error(`Client missing 'secret' parameter`);
-  }
-  const client = new BlizzardApiClient(options);
-  const refreshToken = async () => {
-    const response = await client.getAccessToken();
-    client.setAccessToken(response.data.access_token);
-    if (typeof onTokenRefresh === "function") {
-      onTokenRefresh?.(response.data);
-    }
-    const timeout = timers.setTimeout(() => void refreshToken(), getTokenExpiration(response.data.expires_in));
-    timeout.unref();
-  };
-  if (!onTokenRefresh) {
-    return client;
-  }
-  if (token) {
-    try {
-      const validatedToken = await client.validateAccessToken({ token });
-      const expiry = getTokenExpiration(validatedToken.data.exp);
-      if (expiry - Date.now() < 6e4) {
-        await refreshToken();
-      } else {
-        const timeout = timers.setTimeout(() => void refreshToken(), expiry - Date.now());
-        timeout.unref();
-      }
-    } catch {
-      await refreshToken();
-    }
-  } else {
-    await refreshToken();
-  }
-  return client;
-};
-
-exports.createBlizzardApiClient = createBlizzardApiClient;
-exports.default = createBlizzardApiClient;
-//# sourceMappingURL=index.cjs.map
-//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/client/client.ts","../src/client/create-client.ts"],"names":["axios","stringify","getBlizzardApi","isAxiosError","AxiosError","setTimeout"],"mappings":";;;;;;;;;;;;;;AA4BO,IAAM,oBAAN,MAAsD;AAAA,EACnD,KAAA,GAAQA,uBAAM,MAAO,EAAA,CAAA;AAAA,EAEtB,QAAA,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAqBA,cAAA,GAAiB,OAAO,OAA+E,KAAA;AAC5G,IAAM,MAAA,EAAE,GAAK,EAAA,MAAA,EAAQ,MAAO,EAAA,GAAI,EAAE,GAAG,IAAA,CAAK,QAAU,EAAA,GAAG,OAAQ,EAAA,CAAA;AAC/D,IAAA,OAAO,KAAK,KAAM,CAAA,IAAA,CAAkB,CAAW,QAAA,EAAA,MAAM,2BAA2B,KAAW,CAAA,EAAA;AAAA,MACzF,IAAM,EAAA;AAAA,QACJ,QAAU,EAAA,MAAA;AAAA,QACV,QAAU,EAAA,GAAA;AAAA,OACZ;AAAA,MACA,OAAS,EAAA;AAAA,QACP,cAAgB,EAAA,kBAAA;AAAA,OAClB;AAAA,MACA,MAAQ,EAAA;AAAA,QACN,UAAY,EAAA,oBAAA;AAAA,OACd;AAAA,KACD,CAAA,CAAA;AAAA,GACH,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeO,kBAAA,GAAqB,OAAO,OAA+E,KAAA;AAChH,IAAA,MAAM,QAAW,GAAA,MAAM,IAAK,CAAA,cAAA,CAAe,OAAO,CAAA,CAAA;AAClD,IAAK,IAAA,CAAA,cAAA,CAAe,QAAS,CAAA,IAAA,CAAK,YAAY,CAAA,CAAA;AAC9C,IAAO,OAAA,QAAA,CAAA;AAAA,GACT,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMO,cAAA,GAAiB,CAAC,KAAwB,KAAA;AAC/C,IAAA,IAAA,CAAK,SAAS,KAAQ,GAAA,KAAA,CAAA;AAAA,GACxB,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWO,mBAAA,GAAsB,OAC3B,OACwD,KAAA;AACxD,IAAM,MAAA,EAAE,QAAQ,KAAM,EAAA,GAAI,EAAE,GAAG,IAAA,CAAK,QAAU,EAAA,GAAG,OAAQ,EAAA,CAAA;AAEzD,IAAA,IAAI,CAAC,KAAO,EAAA;AACV,MAAM,MAAA,IAAI,MAAM,oFAAoF,CAAA,CAAA;AAAA,KACtG;AAEA,IAAO,OAAA,MAAM,KAAK,KAAM,CAAA,IAAA;AAAA,MACtB,WAAW,MAAM,CAAA,6BAAA,CAAA;AAAA,MACjBC,qBAAA,CAAU,EAAE,KAAA,EAAO,CAAA;AAAA,MACnB;AAAA,QACE,OAAS,EAAA;AAAA,UACP,cAAgB,EAAA,mCAAA;AAAA,SAClB;AAAA,OACF;AAAA,KACF,CAAA;AAAA,GACF,CAAA;AAAA,EAEA,YAAY,OAAwB,EAAA;AAClC,IAAM,MAAA,EAAE,QAAQ,MAAO,EAAA,GAAIC,oBAAe,OAAQ,CAAA,MAAA,EAAQ,QAAQ,MAAM,CAAA,CAAA;AACxE,IAAA,IAAA,CAAK,QAAW,GAAA;AAAA,MACd,KAAK,OAAQ,CAAA,GAAA;AAAA,MACb,MAAA;AAAA,MACA,MAAA;AAAA,MACA,QAAQ,OAAQ,CAAA,MAAA;AAAA,MAChB,OAAO,OAAQ,CAAA,KAAA;AAAA,KACjB,CAAA;AAAA,GACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASO,gBAAA,CACL,QACA,EAAA,OAAA,EACA,OACA,EAAA;AACA,IAAA,MAAM,SAAS,EAAE,GAAG,IAAK,CAAA,QAAA,EAAU,GAAG,OAAQ,EAAA,CAAA;AAC9C,IAAA,MAAM,QAAW,GAAAA,mBAAA,CAAe,MAAO,CAAA,MAAA,EAAQ,OAAO,MAAM,CAAA,CAAA;AAE5D,IAAA,MAAM,SAAY,GAAA,QAAA,CAAS,SACvB,GAAA,EAAE,qBAAuB,EAAA,CAAA,EAAG,QAAS,CAAA,SAAS,CAAI,CAAA,EAAA,QAAA,CAAS,MAAM,CAAA,CAAA,EACjE,GAAA,KAAA,CAAA,CAAA;AAEJ,IAAO,OAAA;AAAA,MACL,OAAS,EAAA;AAAA,QACP,GAAG,OAAA;AAAA,QACH,GAAG,SAAA;AAAA,QACH,aAAA,EAAe,CAAU,OAAA,EAAA,MAAA,CAAO,KAAK,CAAA,CAAA;AAAA,QACrC,cAAgB,EAAA,kBAAA;AAAA,OAClB;AAAA,MACA,MAAQ,EAAA;AAAA,QACN,QAAQ,QAAS,CAAA,MAAA;AAAA,QACjB,GAAG,QAAS,CAAA,UAAA;AAAA,OACd;AAAA,KACF,CAAA;AAAA,GACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQO,aAAA,CACL,UACA,OACA,EAAA;AACA,IAAA,MAAM,SAAS,EAAE,GAAG,IAAK,CAAA,QAAA,EAAU,GAAG,OAAQ,EAAA,CAAA;AAC9C,IAAA,MAAM,QAAW,GAAAA,mBAAA,CAAe,MAAO,CAAA,MAAA,EAAQ,OAAO,MAAM,CAAA,CAAA;AAE5D,IAAA,MAAM,qBAAqB,QAAS,CAAA,IAAA,CAAK,UAAW,CAAA,GAAG,IAAI,EAAK,GAAA,GAAA,CAAA;AAEhE,IAAA,OAAO,GAAG,QAAS,CAAA,QAAQ,GAAG,kBAAkB,CAAA,EAAG,SAAS,IAAI,CAAA,CAAA,CAAA;AAAA,GAClE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAa,WAAA,CACX,QACA,EAAA,OAAA,EACA,OACoC,EAAA;AACpC,IAAA,MAAM,GAAM,GAAA,IAAA,CAAK,aAAc,CAAA,QAAA,EAAU,OAAO,CAAA,CAAA;AAChD,IAAA,MAAM,MAAS,GAAA,IAAA,CAAK,gBAAiB,CAAA,QAAA,EAAU,SAAS,OAAO,CAAA,CAAA;AAE/D,IAAI,IAAA;AACF,MAAA,OAAO,MAAM,IAAA,CAAK,KAAM,CAAA,GAAA,CAAO,KAAK,MAAM,CAAA,CAAA;AAAA,aACnC,KAAO,EAAA;AACd,MAAI,IAAAC,kBAAA,CAAa,KAAK,CAAG,EAAA;AACvB,QAAA,MAAM,IAAIC,gBAAA,CAAW,KAAM,CAAA,OAAA,EAAS,MAAM,IAAI,CAAA,CAAA;AAAA,OAChD;AACA,MAAM,MAAA,KAAA,CAAA;AAAA,KACR;AAAA,GACF;AACF,CAAA,CAAA;;;AC7MA,IAAM,kBAAqB,GAAA,CAAC,SAAsB,KAAA,SAAA,GAAY,GAAO,GAAA,GAAA,CAAA;AAQ9D,IAAM,uBAA0B,GAAA,OACrC,OACA,EAAA,cAAA,GAA2D,IAC5B,KAAA;AAC/B,EAAA,MAAM,EAAE,GAAA,EAAK,MAAQ,EAAA,KAAA,EAAU,GAAA,OAAA,CAAA;AAC/B,EAAA,IAAI,CAAC,GAAK,EAAA;AACR,IAAM,MAAA,IAAI,MAAM,CAAgC,8BAAA,CAAA,CAAA,CAAA;AAAA,GAClD;AACA,EAAA,IAAI,CAAC,MAAQ,EAAA;AACX,IAAM,MAAA,IAAI,MAAM,CAAmC,iCAAA,CAAA,CAAA,CAAA;AAAA,GACrD;AAEA,EAAM,MAAA,MAAA,GAAS,IAAI,iBAAA,CAAkB,OAAO,CAAA,CAAA;AAE5C,EAAA,MAAM,eAAe,YAAY;AAC/B,IAAM,MAAA,QAAA,GAAW,MAAM,MAAA,CAAO,cAAe,EAAA,CAAA;AAE7C,IAAO,MAAA,CAAA,cAAA,CAAe,QAAS,CAAA,IAAA,CAAK,YAAY,CAAA,CAAA;AAEhD,IAAI,IAAA,OAAO,mBAAmB,UAAY,EAAA;AACxC,MAAA,cAAA,GAAiB,SAAS,IAAI,CAAA,CAAA;AAAA,KAChC;AAGA,IAAM,MAAA,OAAA,GAAUC,iBAAW,CAAA,MAAM,KAAK,YAAA,IAAgB,kBAAmB,CAAA,QAAA,CAAS,IAAK,CAAA,UAAU,CAAC,CAAA,CAAA;AAClG,IAAA,OAAA,CAAQ,KAAM,EAAA,CAAA;AAAA,GAChB,CAAA;AAGA,EAAA,IAAI,CAAC,cAAgB,EAAA;AACnB,IAAO,OAAA,MAAA,CAAA;AAAA,GACT;AAEA,EAAA,IAAI,KAAO,EAAA;AACT,IAAI,IAAA;AAEF,MAAA,MAAM,iBAAiB,MAAM,MAAA,CAAO,mBAAoB,CAAA,EAAE,OAAO,CAAA,CAAA;AACjE,MAAA,MAAM,MAAS,GAAA,kBAAA,CAAmB,cAAe,CAAA,IAAA,CAAK,GAAG,CAAA,CAAA;AAEzD,MAAA,IAAI,MAAS,GAAA,IAAA,CAAK,GAAI,EAAA,GAAI,GAAQ,EAAA;AAChC,QAAA,MAAM,YAAa,EAAA,CAAA;AAAA,OACd,MAAA;AAEL,QAAM,MAAA,OAAA,GAAUA,kBAAW,MAAM,KAAK,cAAgB,EAAA,MAAA,GAAS,IAAK,CAAA,GAAA,EAAK,CAAA,CAAA;AAEzE,QAAA,OAAA,CAAQ,KAAM,EAAA,CAAA;AAAA,OAChB;AAAA,KACM,CAAA,MAAA;AAEN,MAAA,MAAM,YAAa,EAAA,CAAA;AAAA,KACrB;AAAA,GACK,MAAA;AAEL,IAAA,MAAM,YAAa,EAAA,CAAA;AAAA,GACrB;AAEA,EAAO,OAAA,MAAA,CAAA;AACT","file":"index.cjs","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 type { AxiosResponse } from 'axios';\r\nimport axios, { AxiosError, isAxiosError } from 'axios';\r\nimport type {\r\n  AccessToken,\r\n  AccessTokenRequestArguments,\r\n  ClientOptions,\r\n  IBlizzardApiClient,\r\n  ValidateAccessTokenArguments,\r\n  ValidateAccessTokenResponse,\r\n} from './types';\r\n\r\n/**\r\n * A Blizzard API client.\r\n * @implements IBlizzardApiClient\r\n * @class\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 implements IBlizzardApiClient {\r\n  private axios = axios.create();\r\n\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  /**\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.data;\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<AxiosResponse<AccessToken>> => {\r\n    const { key, origin, secret } = { ...this.defaults, ...options };\r\n    return this.axios.post<AccessToken>(`https://${origin}.battle.net/oauth/token`, undefined, {\r\n      auth: {\r\n        password: secret,\r\n        username: key,\r\n      },\r\n      headers: {\r\n        'Content-Type': 'application/json',\r\n      },\r\n      params: {\r\n        grant_type: 'client_credentials',\r\n      },\r\n    });\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.data;\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<AxiosResponse<AccessToken>> => {\r\n    const response = await this.getAccessToken(options);\r\n    this.setAccessToken(response.data.access_token);\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   * 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.data.client_id);\r\n   * // => 'client-id'\r\n   */\r\n  public validateAccessToken = async (\r\n    options?: ValidateAccessTokenArguments,\r\n  ): Promise<AxiosResponse<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    return await this.axios.post<ValidateAccessTokenResponse>(\r\n      `https://${origin}.battle.net/oauth/check_token`,\r\n      stringify({ token }),\r\n      {\r\n        headers: {\r\n          'Content-Type': 'application/x-www-form-urlencoded',\r\n        },\r\n      },\r\n    );\r\n  };\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  }\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.\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    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    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      params: {\r\n        locale: endpoint.locale,\r\n        ...resource.parameters,\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.\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<AxiosResponse<T>> {\r\n    const url = this.getRequestUrl(resource, options);\r\n    const config = this.getRequestConfig(resource, options, headers);\r\n\r\n    try {\r\n      return await this.axios.get<T>(url, config);\r\n    } catch (error) {\r\n      if (isAxiosError(error)) {\r\n        throw new AxiosError(error.message, error.code);\r\n      }\r\n      throw error;\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.data.access_token);\r\n\r\n    if (typeof onTokenRefresh === 'function') {\r\n      onTokenRefresh?.(response.data);\r\n    }\r\n\r\n    //Schedule a refresh of the token\r\n    const timeout = setTimeout(() => void refreshToken(), getTokenExpiration(response.data.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.data.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"]}

package/dist/index.d.cts

@@ -1,238 +0,0 @@
-import { Origins, Locales, Resource, ResourceResponse } from '@blizzard-api/core';
-import { AxiosResponse } from 'axios';
-
-/**
- * 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¨
- * @interface AccessToken
- * @property access_token The access token.
- * @property token_type The type of token.
- * @property expires_in The time in seconds until  the token expires.
- * @property sub The subject (unique user identifier) of the token.
- * @example
- * const response: AccessToken = {
- *  access_token: 'access-token',
- *  token_type: 'bearer',
- *  expires_in: 86399,
- *  sub: 'client-id',
- * };
- */
-interface AccessToken {
-    access_token: string;
-    expires_in: number;
-    sub?: string;
-    token_type: 'bearer';
-}
-/**
- * An access token request.
- * @see https://develop.battle.net/documentation/guides/using-oauth/client-credentials-flow
- * @interface AccessTokenRequestArguments
- * @property origin The region to request the access token from.
- * @property key The client ID.
- * @property secret The client secret.
- * @example
- * const request: AccessTokenRequestArguments = {
- *  origin: 'eu',
- *  key: 'client',
- *  secret: 'secret'
- * };
- */
-interface AccessTokenRequestArguments {
-    key?: string;
-    origin?: Origins;
-    secret?: string;
-}
-/**
- * Validate an access token.
- * @see https://develop.battle.net/documentation/guides/using-oauth/client-credentials-flow
- * @interface ValidateAccessTokenArguments
- * @property origin The region to validate the access token from.
- * @property token The access token to validate.
- * @example
- * const request: ValidateAccessTokenArguments = {
- *  origin: 'eu',
- *  token: 'access'
- * };
- */
-interface ValidateAccessTokenArguments {
-    origin?: Origins;
-    token?: string;
-}
-/**
- * A response from validating an access token.
- * @see https://develop.battle.net/documentation/guides/using-oauth/client-credentials-flow
- * @interface ValidateAccessTokenResponse
- * @property scope The scope of the token.
- * @property account_authorities The account authorities.
- * @property exp The expiration time of the token.
- * @property client_authorities The client authorities.
- * @property authorities The authorities.
- * @property client_id The client ID.
- * @example
- * const response: ValidateAccessTokenResponse = {
- *  scope: ['wow.profile'],
- *  account_authorities: [],
- *  exp: 1617000000,
- *  client_authorities: [],
- *  authorities: ['wow.profile'],
- *  client_id: 'client'
- * };
- */
-interface ValidateAccessTokenResponse {
-    account_authorities: Array<unknown>;
-    authorities: Array<string>;
-    client_authorities: Array<unknown>;
-    client_id: string;
-    exp: number;
-    scope: Array<string>;
-}
-/**
- * A client configuration object.
- * @interface ClientOptions
- * @property key The client ID.
- * @property secret The client secret.
- * @property origin The region of the Blizzard API.
- * @property locale The locale of the Blizzard API.
- * @property token The access token.
- * @example
- * const options: ClientOptions = {
- *  key: 'client',
- *  secret: 'secret',
- *  origin: 'eu',
- *  locale: 'en_GB',
- *  token: 'access'
- * };
- */
-interface ClientOptions {
-    key: string;
-    locale?: Locales;
-    origin: Origins;
-    secret: string;
-    token?: string;
-}
-/**
- * A Blizzard API client.
- * @interface IBlizzardApiClient
- * @property getAccessToken Get an access token.
- * @property setAccessToken Set an access token.
- * @property refreshAccessToken Refresh an access token.
- * @property validateAccessToken Validate an access token.
- */
-interface IBlizzardApiClient {
-    getAccessToken: (options: AccessTokenRequestArguments) => Promise<AxiosResponse<AccessToken>>;
-    refreshAccessToken: (options: AccessTokenRequestArguments) => Promise<AxiosResponse<AccessToken>>;
-    setAccessToken: (token: string) => void;
-    validateAccessToken: (options: ValidateAccessTokenArguments) => Promise<AxiosResponse<ValidateAccessTokenResponse>>;
-}
-
-/**
- * A Blizzard API client.
- * @implements IBlizzardApiClient
- * @class
- * @classdesc A client to interact with the Blizzard API.
- * @example
- * const client = new BlizzardApiClient({
- *  key: 'client',
- *  secret: 'secret',
- *  origin: 'eu',
- *  locale: 'en_GB',
- *  token: 'access'
- * });
- */
-declare class BlizzardApiClient implements IBlizzardApiClient {
-    private axios;
-    defaults: {
-        key: string;
-        locale: Locales;
-        origin: Origins;
-        secret: string;
-        token?: string;
-    };
-    /**
-     * Get an access token.
-     * @param options The access token request arguments. See {@link AccessTokenRequestArguments}.
-     * @returns The access token. See {@link AccessToken}.
-     * @example
-     * const response = await client.getAccessToken();
-     * const { access_token, token_type, expires_in, sub } = response.data;
-     * console.log(access_token, token_type, expires_in, sub);
-     * // => 'access'
-     * // => 'bearer'
-     * // => 86399
-     * // => 'client-id'
-     */
-    getAccessToken: (options?: AccessTokenRequestArguments) => Promise<AxiosResponse<AccessToken>>;
-    /**
-     * Refresh the access token.
-     * @param options The access token request arguments. See {@link AccessTokenRequestArguments}.
-     * @returns The access token. See {@link AccessToken}.
-     * @example
-     * const response = await client.refreshAccessToken();
-     * const { access_token, token_type, expires_in, sub } = response.data;
-     * console.log(access_token, token_type, expires_in, sub);
-     * // => 'access'
-     * // => 'bearer'
-     * // => 86399
-     * // => 'client-id'
-     */
-    refreshAccessToken: (options?: AccessTokenRequestArguments) => Promise<AxiosResponse<AccessToken>>;
-    /**
-     * Set the access token.
-     * @param token The access token.
-     */
-    setAccessToken: (token: string) => void;
-    /**
-     * Validate an access token.
-     * @param options The validate access token arguments. See {@link ValidateAccessTokenArguments}.
-     * @returns The response from the Blizzard API. See {@link ValidateAccessTokenResponse}.
-     * @example
-     * const response = await client.validateAccessToken({ token: 'access' });
-     * console.log(response.data.client_id);
-     * // => 'client-id'
-     */
-    validateAccessToken: (options?: ValidateAccessTokenArguments) => Promise<AxiosResponse<ValidateAccessTokenResponse>>;
-    constructor(options: ClientOptions);
-    /**
-     * Get the request configuration.
-     * @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.
-     * @returns The request configuration.
-     */
-    getRequestConfig<T, Protected extends boolean = false>(resource: Resource<T, object, Protected>, options?: Partial<ClientOptions>, headers?: Record<string, string>): {
-        headers: {
-            Authorization: string;
-            'Content-Type': string;
-            'Battlenet-Namespace'?: string | undefined;
-        };
-        params: {
-            locale: "de_DE" | "en_GB" | "en_US" | "es_ES" | "es_MX" | "fr_FR" | "it_IT" | "ko_KR" | "multi" | "pt_BR" | "pt_PT" | "ru_RU" | "zh_CN" | "zh_TW";
-        };
-    };
-    /**
-     * Get the request URL.
-     * @param resource The resource to fetch. See {@link Resource}.
-     * @param options Client options. See {@link ClientOptions}.
-     * @returns The request URL.
-     */
-    getRequestUrl<T, Protected extends boolean = false>(resource: Resource<T, object, Protected>, options?: Partial<ClientOptions>): string;
-    /**
-     * Send a request to the Blizzard API.
-     * @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.
-     * @returns The response from the Blizzard API. See {@link ResourceResponse}.
-     */
-    sendRequest<T, Protected extends boolean = false>(resource: Resource<T, object, Protected>, options?: Partial<ClientOptions>, headers?: Record<string, string>): ResourceResponse<AxiosResponse<T>>;
-}
-
-/**
- * Create a new Blizzard API client.
- * @param options Client options, see {@link ClientOptions} & https://develop.battle.net/documentation/guides/getting-started
- * @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.
- * @returns A new Blizzard API client.
- */
-declare const createBlizzardApiClient: (options: ClientOptions, onTokenRefresh?: ((token: AccessToken) => void) | boolean) => Promise<BlizzardApiClient>;
-
-export { type AccessToken, type AccessTokenRequestArguments, type ClientOptions, type IBlizzardApiClient, type ValidateAccessTokenArguments, type ValidateAccessTokenResponse, createBlizzardApiClient, createBlizzardApiClient as default };