@blizzard-api/hs 3.1.1 → 3.2.0

package/README.md

@@ -1,75 +1,75 @@
-# @blizzard-api/hs
-
-This package aims to make it easier for you to integrate with the Blizzard Battle.net API, specifically for Diablo 3.
-
-## Installation
-
-```sh
-npm i @blizzard-api/core @blizzard-api/hs
-```
-
-## Usage
-
-You can get paths, namespaces, parameters and more for a specific endpoint by calling it from the `hs` export.
-
-```ts
-import { hs } from "@blizzard-api/hs"
-//or
-import hs from "@blizzard-api/hs"
-
-const season = hs.allMetadata(123);
-        ^ Resource<AllMetadataResponse>
-```
-
-If you don't want to use the exported hs object, you can also access the functions directly:
-
-```ts
-import { allMetadata } from "@blizzard-api/hs"
-
-const seasonI = season(123);
-        ^ Resource<AllMetadataResponse>
-```
-
-### Types
-
-If you need the response types, they are also exported with "Response" appended, so to get the response type from the above code, you can import it like this:
-
-```ts
-import type { SeasonResponse } from '@blizzard-api/hs';
-```
-
-If you simply want to use the existing object, you can use the helper, `ExtractResourceType`, from `@blizzard-api/core` like so:
-
-```ts
-import { hs } from "@blizzard-api/hs"
-
-const season = hs.allMetadata();
-        ^ Resource<AllMetadataResponse>
-
-type AllMetadataResponse = ExtractResourceType<typeof season>;
-```
-
-## Notes on Types
-
-The types are manually created from using the Blizzard API documentation, and are as accurate as possible with smoke testing each endpoint. However, no-one is perfect so there is likely to be some discrepancies. If you encounter any issues with the types from this package, please open an issue or a pull request.
-
-### Client
-
-While this package is made to function on it's own, it performs even better when combined with `@blizzard-api/client` where you can easily request data combining the two libraries.
-
-```ts
-import { createBlizzardApiClient } from '@blizzard-api/client';
-import { hs } from '@blizzard-api/hs';
-
-const client = await createBlizzardApiClient({
-  key: 'environment.blizzardClientId',
-  secret: 'environment.blizzardClientSecret',
-  origin: 'eu',
-});
-
-//Response will automatically be typed with the appropriate values
-const response = await client.sendRequest(hs.allMetadata());
-
-console.log(response);
-                ^ typeof AllMetadataResponse
-```
+# @blizzard-api/hs
+
+This package aims to make it easier for you to integrate with the Blizzard Battle.net API, specifically for Diablo 3.
+
+## Installation
+
+```sh
+npm i @blizzard-api/core @blizzard-api/hs
+```
+
+## Usage
+
+You can get paths, namespaces, parameters and more for a specific endpoint by calling it from the `hs` export.
+
+```ts
+import { hs } from "@blizzard-api/hs"
+//or
+import hs from "@blizzard-api/hs"
+
+const season = hs.allMetadata(123);
+        ^ Resource<AllMetadataResponse>
+```
+
+If you don't want to use the exported hs object, you can also access the functions directly:
+
+```ts
+import { allMetadata } from "@blizzard-api/hs"
+
+const seasonI = season(123);
+        ^ Resource<AllMetadataResponse>
+```
+
+### Types
+
+If you need the response types, they are also exported with "Response" appended, so to get the response type from the above code, you can import it like this:
+
+```ts
+import type { SeasonResponse } from '@blizzard-api/hs';
+```
+
+If you simply want to use the existing object, you can use the helper, `ExtractResourceType`, from `@blizzard-api/core` like so:
+
+```ts
+import { hs } from "@blizzard-api/hs"
+
+const season = hs.allMetadata();
+        ^ Resource<AllMetadataResponse>
+
+type AllMetadataResponse = ExtractResourceType<typeof season>;
+```
+
+## Notes on Types
+
+The types are manually created from using the Blizzard API documentation, and are as accurate as possible with smoke testing each endpoint. However, no-one is perfect so there is likely to be some discrepancies. If you encounter any issues with the types from this package, please open an issue or a pull request.
+
+### Client
+
+While this package is made to function on it's own, it performs even better when combined with `@blizzard-api/client` where you can easily request data combining the two libraries.
+
+```ts
+import { createBlizzardApiClient } from '@blizzard-api/client';
+import { hs } from '@blizzard-api/hs';
+
+const client = await createBlizzardApiClient({
+  key: 'environment.blizzardClientId',
+  secret: 'environment.blizzardClientSecret',
+  origin: 'eu',
+});
+
+//Response will automatically be typed with the appropriate values
+const response = await client.sendRequest(hs.allMetadata());
+
+console.log(response);
+                ^ typeof AllMetadataResponse
+```

package/dist/cards/index.d.ts

@@ -1,2 +1,2 @@
-import { n as fetchOneCard, t as cardSearch } from "../index-D6Vnhl2r.js";
+import { n as fetchOneCard, t as cardSearch } from "../index-DN5jIXcl.js";
 export { cardSearch, fetchOneCard };

package/dist/decks/index.d.ts

@@ -1,2 +1,2 @@
-import { t as getDeck } from "../index-DctpuvUj.js";
+import { t as getDeck } from "../index-BqB5vnYO.js";
 export { getDeck };

package/dist/decks/index.js

@@ -12,7 +12,8 @@ function getDeck(options) {
 	return {
 		parameters: {
 			hero: options.hero?.toString(),
-			ids: options.ids?.join(",")
+			ids: options.ids?.join(","),
+			sideboardCards: Array.isArray(options.sideboardCards) ? options.sideboardCards.join(",") : options.sideboardCards
 		},
 		path: "hearthstone/deck"
 	};

package/dist/decks/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../../src/decks/index.ts"],"sourcesContent":["import type { Resource } from '@blizzard-api/core';\nimport type { DeckResponse, DeckSearchParameters } from './types';\n\n/**\n * Returns a deck based on the code provided.\n * @param options The options for fetching a deck.\n * @returns The deck resource. See {@link DeckResponse}.\n */\nexport function getDeck(\n  options: { code: string } | { hero?: number | string; ids: Array<number | string> },\n): Resource<DeckResponse, DeckSearchParameters> {\n  if ('code' in options) {\n    return {\n      parameters: {\n        code: encodeURI(options.code),\n      },\n      path: 'hearthstone/deck',\n    };\n  }\n\n  return {\n    parameters: {\n      hero: options.hero?.toString(),\n      ids: options.ids?.join(','),\n    },\n    path: 'hearthstone/deck',\n  };\n}\n"],"mappings":";;;;;;AAQA,SAAgB,QACd,SAC8C;CAC9C,IAAI,UAAU,SACZ,OAAO;EACL,YAAY,EACV,MAAM,UAAU,QAAQ,IAAI,EAC9B;EACA,MAAM;CACR;CAGF,OAAO;EACL,YAAY;GACV,MAAM,QAAQ,MAAM,SAAS;GAC7B,KAAK,QAAQ,KAAK,KAAK,GAAG;EAC5B;EACA,MAAM;CACR;AACF"}
+{"version":3,"file":"index.js","names":[],"sources":["../../src/decks/index.ts"],"sourcesContent":["import type { Resource } from '@blizzard-api/core';\nimport type { DeckResponse, DeckSearchParameters } from './types';\n\n/**\n * Returns a deck based on the code provided.\n * @param options The options for fetching a deck.\n * @returns The deck resource. See {@link DeckResponse}.\n */\nexport function getDeck(\n  options:\n    | { code: string }\n    | {\n        hero?: number | string;\n        ids: Array<number | string>;\n        //Undocumented parameter used for sideboard cards for Zilliax Deluxe 3000 and E.T.C., Band Manager.\n        sideboardCards?: `${number}:${number}` | Array<`${number}:${number}`>;\n      },\n): Resource<DeckResponse, DeckSearchParameters> {\n  if ('code' in options) {\n    return {\n      parameters: {\n        code: encodeURI(options.code),\n      },\n      path: 'hearthstone/deck',\n    };\n  }\n\n  return {\n    parameters: {\n      hero: options.hero?.toString(),\n      ids: options.ids?.join(','),\n      sideboardCards: Array.isArray(options.sideboardCards) ? options.sideboardCards.join(',') : options.sideboardCards,\n    },\n    path: 'hearthstone/deck',\n  };\n}\n"],"mappings":";;;;;;AAQA,SAAgB,QACd,SAQ8C;CAC9C,IAAI,UAAU,SACZ,OAAO;EACL,YAAY,EACV,MAAM,UAAU,QAAQ,IAAI,EAC9B;EACA,MAAM;CACR;CAGF,OAAO;EACL,YAAY;GACV,MAAM,QAAQ,MAAM,SAAS;GAC7B,KAAK,QAAQ,KAAK,KAAK,GAAG;GAC1B,gBAAgB,MAAM,QAAQ,QAAQ,cAAc,IAAI,QAAQ,eAAe,KAAK,GAAG,IAAI,QAAQ;EACrG;EACA,MAAM;CACR;AACF"}

package/dist/{index-DctpuvUj.d.ts → index-BqB5vnYO.d.ts}

@@ -15,6 +15,7 @@ type DeckSearchParameters = {
 } | {
   hero?: string;
   ids: string;
+  sideboardCards?: string;
 };
 interface Card {
   armor?: number;
@@ -88,7 +89,8 @@ declare function getDeck(options: {
 } | {
   hero?: number | string;
   ids: Array<number | string>;
+  sideboardCards?: `${number}:${number}` | Array<`${number}:${number}`>;
 }): Resource<DeckResponse, DeckSearchParameters>;
 //#endregion
 export { DeckResponse as n, DeckSearchParameters as r, getDeck as t };
-//# sourceMappingURL=index-DctpuvUj.d.ts.map
+//# sourceMappingURL=index-BqB5vnYO.d.ts.map

package/dist/{index-D6Vnhl2r.d.ts → index-DN5jIXcl.d.ts}

@@ -35,6 +35,7 @@ interface FetchOneCardResponse {
   collectible: number;
   copyOfCardId?: Array<number>;
   cropImage: null | string;
+  factionId?: Array<number>;
   flavorText: Record<Locales, string> | string;
   health?: number;
   id: number;
@@ -88,6 +89,7 @@ interface Card {
   armor?: number;
   artistName: null | string;
   attack?: number;
+  bannedFromSideboard?: number;
   battlegrounds?: Battlegrounds;
   cardSetId: number;
   cardTypeId: number;
@@ -96,6 +98,7 @@ interface Card {
   collectible: number;
   copyOfCardId?: Array<number>;
   cropImage: null | string;
+  factionId?: Array<number>;
   flavorText: string;
   health?: number;
   id: number;
@@ -112,9 +115,21 @@ interface Card {
   name: string;
   parentId?: number;
   rarityId: null | number;
+  runeCost?: {
+    blood: number;
+    frost: number;
+    unholy: number;
+  };
+  sideboard?: {
+    maxSideboardCards: number;
+    sideboardCardsCountAsMax: boolean;
+    sideboardIgnoresClass: boolean;
+    sideboardSubset: string;
+  };
   slug: string;
   spellSchoolId?: number;
   text: string;
+  touristClassId?: number;
 }
 interface MercenaryHero {
   collectible: number;
@@ -157,4 +172,4 @@ declare function fetchOneCard(id: string, options?: {
 }>;
 //#endregion
 export { CardSearchResponse as a, CardSearchParameters as i, fetchOneCard as n, FetchOneCardResponse as o, BlizzardCardSearchParameters as r, GameMode as s, cardSearch as t };
-//# sourceMappingURL=index-D6Vnhl2r.d.ts.map
+//# sourceMappingURL=index-DN5jIXcl.d.ts.map

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { a as SearchOptions, i as CardBackSearchResponse, n as fetchOneCardBack, o as SingleCardBackSearchResponse, r as CardBackSearchParameters, s as SortOptions, t as cardBackSearch } from "./index-DISoZUa9.js";
-import { a as CardSearchResponse, i as CardSearchParameters, n as fetchOneCard, o as FetchOneCardResponse, r as BlizzardCardSearchParameters, s as GameMode, t as cardSearch } from "./index-D6Vnhl2r.js";
-import { n as DeckResponse, r as DeckSearchParameters, t as getDeck } from "./index-DctpuvUj.js";
+import { a as CardSearchResponse, i as CardSearchParameters, n as fetchOneCard, o as FetchOneCardResponse, r as BlizzardCardSearchParameters, s as GameMode, t as cardSearch } from "./index-DN5jIXcl.js";
+import { n as DeckResponse, r as DeckSearchParameters, t as getDeck } from "./index-BqB5vnYO.js";
 import { i as SpecificMetadataResponse, n as specificMetadata, r as AllMetadataResponse, t as allMetadata } from "./index-hPXfx360.js";
 //#region src/index.d.ts
 declare const hs: {

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["import { cardBackSearch, fetchOneCardBack } from './card-backs/index';\r\nimport { cardSearch, fetchOneCard } from './cards/index';\r\nimport { getDeck } from './decks/index';\r\nimport { allMetadata, specificMetadata } from './metadata/index';\r\n\r\nconst hs = {\r\n  //Card Backs\r\n  cardBackSearch,\r\n  fetchOneCardBack,\r\n  //Cards\r\n  cardSearch,\r\n  fetchOneCard,\r\n  //Decks\r\n  getDeck,\r\n  //Metadata\r\n  allMetadata,\r\n  specificMetadata,\r\n};\r\nexport default hs;\r\nexport { hs };\r\n\r\n//Card Backs\r\nexport * from './card-backs/index';\r\nexport type * from './card-backs/types';\r\n//Cards\r\nexport * from './cards/index';\r\nexport type * from './cards/types';\r\n//Decks\r\nexport * from './decks/index';\r\nexport type * from './decks/types';\r\n//Metadata\r\nexport * from './metadata/index';\r\nexport type * from './metadata/types';\r\n"],"mappings":";;;;;AAKA,MAAM,KAAK;CAET;CACA;CAEA;CACA;CAEA;CAEA;CACA;AACF"}
+{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["import { cardBackSearch, fetchOneCardBack } from './card-backs/index';\nimport { cardSearch, fetchOneCard } from './cards/index';\nimport { getDeck } from './decks/index';\nimport { allMetadata, specificMetadata } from './metadata/index';\n\nconst hs = {\n  //Card Backs\n  cardBackSearch,\n  fetchOneCardBack,\n  //Cards\n  cardSearch,\n  fetchOneCard,\n  //Decks\n  getDeck,\n  //Metadata\n  allMetadata,\n  specificMetadata,\n};\nexport default hs;\nexport { hs };\n\n//Card Backs\nexport * from './card-backs/index';\nexport type * from './card-backs/types';\n//Cards\nexport * from './cards/index';\nexport type * from './cards/types';\n//Decks\nexport * from './decks/index';\nexport type * from './decks/types';\n//Metadata\nexport * from './metadata/index';\nexport type * from './metadata/types';\n"],"mappings":";;;;;AAKA,MAAM,KAAK;CAET;CACA;CAEA;CACA;CAEA;CAEA;CACA;AACF"}

package/package.json

@@ -1,18 +1,28 @@
 {
   "name": "@blizzard-api/hs",
-  "version": "3.1.1",
+  "version": "3.2.0",
+  "description": "A series of helpers to interact with the Hearthstone Blizzard API",
+  "keywords": [
+    "api",
+    "battle.net",
+    "battlenet",
+    "blizzard",
+    "bnet",
+    "hearthstone",
+    "hs"
+  ],
   "license": "MIT",
   "author": "Putro",
-  "description": "A series of helpers to interact with the Hearthstone Blizzard API",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/Pewtro/blizzard-api.git",
     "directory": "packages/hs"
   },
+  "files": [
+    "dist"
+  ],
   "type": "module",
-  "engines": {
-    "node": "^22.13.0 || ^24 || ^26"
-  },
+  "sideEffects": false,
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "exports": {
@@ -27,25 +37,15 @@
       "default": "./dist/*/index.js"
     }
   },
-  "files": [
-    "dist"
-  ],
-  "sideEffects": false,
-  "keywords": [
-    "blizzard",
-    "battlenet",
-    "battle.net",
-    "bnet",
-    "api",
-    "hs",
-    "hearthstone"
-  ],
   "dependencies": {},
+  "devDependencies": {
+    "@blizzard-api/core": "4.1.3"
+  },
   "peerDependencies": {
-    "@blizzard-api/core": "4.1.2"
+    "@blizzard-api/core": "4.1.3"
   },
-  "devDependencies": {
-    "@blizzard-api/core": "4.1.2"
+  "engines": {
+    "node": "^22.13.0 || ^24 || ^26"
   },
   "scripts": {
     "build": "tsdown",