@pinta365/blizzard_api 0.3.5 → 0.3.7

package/README.md

@@ -1,10 +1,13 @@
-# BLIZZARD_API
+# BLIZZARD API
 
 [![JSR Version](https://jsr.io/badges/@pinta365/blizzard-api)](https://jsr.io/@pinta365/blizzard-api)
 
 Start of what will cover the whole Blizzard Battle.net API when its done.
 
-Link to the module on [JSR](https://jsr.io/@pinta365/blizzard-api)
+Available as:
+
+- ESM module: [JSR](https://jsr.io/@pinta365/blizzard-api)
+- CommonJS module: [NPM](https://www.npmjs.com/package/@pinta365/blizzard_api)
 
 ## WORK IN PROGRESS
 
@@ -19,6 +22,7 @@ to implement authorization code flow also.
 | **World of Warcraft:** Profile APIs           | ✅     |                           |
 |                                               |        |                           |
 | **World of Warcraft Classic:** Game Data APIs |        |                           |
+| **World of Warcraft Classic:** Profile APIs   |        |                           |
 |                                               |        |                           |
 | **Diablo III:** Community APIs                | ✅     | Missing profile endpoints |
 | **Diablo III:** Game Data APIs                | ✅     |                           |
@@ -28,7 +32,25 @@ to implement authorization code flow also.
 | **StarCraft II:** Community APIs              |        |                           |
 | **StarCraft II:** Game Data APIs              | ✅     |                           |
 
-## Example
+## ⚡️ Quickstart
+
+**Installation**
+
+```bash
+# Deno
+deno add @pinta365/blizzard-api
+
+# Bun
+bunx jsr add @pinta365/blizzard-api
+
+# Node.js
+npx jsr add @pinta365/blizzard-api
+
+# NPM (CommonJS)
+npm install @pinta365/blizzard_api --save
+```
+
+**Basic Usage (ESM)**
 
 ```javascript
 import * as blizzardAPI from "@pinta365/blizzard-api";
@@ -43,12 +65,16 @@ blizzardAPI.setup({
     locale: "en_GB",
 });
 
-try {
-    const sword = await blizzardAPI.wow.item(33791);
-    console.log(sword);
-} catch (error) {
-    console.log(error);
-}
+const sword = await blizzardAPI.wow.item(33791);
+console.log(sword);
+```
+
+**Basic Usage (CommonJS)**
+
+```javascript
+const blizzardAPI = require("@pinta365/blizzard_api");
+
+// Use blizzardAPI the same way as in the previous example.
 ```
 
 ## Issues

package/esm/mod.d.ts

@@ -2,4 +2,5 @@ import { authenticate, setup } from "./src/shared/index.js";
 import * as wow from "./src/wow/index.js";
 import * as hearthstone from "./src/hearthstone/index.js";
 import * as sc2 from "./src/starcraft2/index.js";
-export { authenticate, hearthstone, sc2, setup, wow };
+import * as errors from "./src/shared/errors.js";
+export { authenticate, errors, hearthstone, sc2, setup, wow };

package/esm/mod.js

@@ -2,4 +2,5 @@ import { authenticate, setup } from "./src/shared/index.js";
 import * as wow from "./src/wow/index.js";
 import * as hearthstone from "./src/hearthstone/index.js";
 import * as sc2 from "./src/starcraft2/index.js";
-export { authenticate, hearthstone, sc2, setup, wow };
+import * as errors from "./src/shared/errors.js";
+export { authenticate, errors, hearthstone, sc2, setup, wow };

package/esm/src/shared/request.js

@@ -39,5 +39,8 @@ export async function request(requestOptions) {
     if (response.ok) {
         return await response.json();
     }
-    throw new APIError("Problem fetching data from API", response.status, response.statusText);
+    const errorData = await response.json();
+    const statusCode = errorData.code || response.status;
+    const errorMessage = JSON.stringify(errorData) || "Problem fetching data from API";
+    throw new APIError(errorMessage, statusCode, response.statusText);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pinta365/blizzard_api",
-  "version": "0.3.5",
+  "version": "0.3.7",
   "description": "TS library to interact with the Blizzard Battle.net API. World of Warcraft, World of Warcraft Classic, StarCraft 2, Diablo 3, Hearthstone.",
   "keywords": [
     "blizzard",

package/script/mod.d.ts

@@ -2,4 +2,5 @@ import { authenticate, setup } from "./src/shared/index.js";
 import * as wow from "./src/wow/index.js";
 import * as hearthstone from "./src/hearthstone/index.js";
 import * as sc2 from "./src/starcraft2/index.js";
-export { authenticate, hearthstone, sc2, setup, wow };
+import * as errors from "./src/shared/errors.js";
+export { authenticate, errors, hearthstone, sc2, setup, wow };

package/script/mod.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.wow = exports.setup = exports.sc2 = exports.hearthstone = exports.authenticate = void 0;
+exports.wow = exports.setup = exports.sc2 = exports.hearthstone = exports.errors = exports.authenticate = void 0;
 const index_js_1 = require("./src/shared/index.js");
 Object.defineProperty(exports, "authenticate", { enumerable: true, get: function () { return index_js_1.authenticate; } });
 Object.defineProperty(exports, "setup", { enumerable: true, get: function () { return index_js_1.setup; } });
@@ -33,3 +33,5 @@ const hearthstone = __importStar(require("./src/hearthstone/index.js"));
 exports.hearthstone = hearthstone;
 const sc2 = __importStar(require("./src/starcraft2/index.js"));
 exports.sc2 = sc2;
+const errors = __importStar(require("./src/shared/errors.js"));
+exports.errors = errors;

package/script/src/shared/request.js

@@ -42,6 +42,9 @@ async function request(requestOptions) {
     if (response.ok) {
         return await response.json();
     }
-    throw new errors_js_1.APIError("Problem fetching data from API", response.status, response.statusText);
+    const errorData = await response.json();
+    const statusCode = errorData.code || response.status;
+    const errorMessage = JSON.stringify(errorData) || "Problem fetching data from API";
+    throw new errors_js_1.APIError(errorMessage, statusCode, response.statusText);
 }
 exports.request = request;