@blizzard-api/sc2 3.1.2 → 3.2.0

package/README.md

@@ -1,75 +1,75 @@
-# @blizzard-api/sc2
-
-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/sc2
-```
-
-## Usage
-
-You can get paths, namespaces, parameters and more for a specific endpoint by calling it from the `sc2` export.
-
-```ts
-import { sc2 } from "@blizzard-api/sc2"
-//or
-import sc2 from "@blizzard-api/sc2"
-
-const season = sc2.season(123);
-        ^ { endDate: string; number: number; seasonId: number; startDate: string; year: number; }
-```
-
-If you don't want to use the exported sc2 object, you can also access the functions directly:
-
-```ts
-import { season } from "@blizzard-api/sc2"
-
-const seasonI = season(123);
-        ^ { endDate: string; number: number; seasonId: number; startDate: string; year: number; }
-```
-
-### 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/sc2';
-```
-
-If you simply want to use the existing object, you can use the helper, `ExtractResourceType`, from `@blizzard-api/core` like so:
-
-```ts
-import { sc2 } from "@blizzard-api/sc2"
-
-const season = sc2.season("eu");
-        ^ { endDate: string; number: number; seasonId: number; startDate: string; year: number; }
-
-type SeasonResponse = 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 { sc2 } from '@blizzard-api/sc2';
-
-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(sc2.season("eu"));
-
-console.log(response);
-                ^ typeof SeasonResponse
-```
+# @blizzard-api/sc2
+
+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/sc2
+```
+
+## Usage
+
+You can get paths, namespaces, parameters and more for a specific endpoint by calling it from the `sc2` export.
+
+```ts
+import { sc2 } from "@blizzard-api/sc2"
+//or
+import sc2 from "@blizzard-api/sc2"
+
+const season = sc2.season(123);
+        ^ { endDate: string; number: number; seasonId: number; startDate: string; year: number; }
+```
+
+If you don't want to use the exported sc2 object, you can also access the functions directly:
+
+```ts
+import { season } from "@blizzard-api/sc2"
+
+const seasonI = season(123);
+        ^ { endDate: string; number: number; seasonId: number; startDate: string; year: number; }
+```
+
+### 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/sc2';
+```
+
+If you simply want to use the existing object, you can use the helper, `ExtractResourceType`, from `@blizzard-api/core` like so:
+
+```ts
+import { sc2 } from "@blizzard-api/sc2"
+
+const season = sc2.season("eu");
+        ^ { endDate: string; number: number; seasonId: number; startDate: string; year: number; }
+
+type SeasonResponse = 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 { sc2 } from '@blizzard-api/sc2';
+
+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(sc2.season("eu"));
+
+console.log(response);
+                ^ typeof SeasonResponse
+```

package/dist/account/index.d.ts

@@ -5,7 +5,6 @@ import { Resource } from "@blizzard-api/core";
  * @param accountId The account ID
  * @returns The player resource. See {@link Resource}.
  */
-declare function player(accountId: string): Resource<Array<unknown>>;
+export declare function player(accountId: string): Resource<Array<unknown>>;
 //#endregion
-export { player };
 //# sourceMappingURL=index.d.ts.map

package/dist/{index-BtQ6VqOV.d.ts → index-6S3wZC_n.d.ts}

@@ -1,4 +1,4 @@
-import { t as StarcraftRegion } from "./regions-pSiIWRj6.js";
+import { t as StarcraftRegion } from "./regions-D_uWPFaI.js";
 import { Resource } from "@blizzard-api/core";
 //#region src/ladder/types.d.ts
 interface GrandmasterLeaderboardResponse {
@@ -44,4 +44,4 @@ declare function grandmasterLeaderboard(regionId: StarcraftRegion): Resource<Gra
 declare function season(regionId: StarcraftRegion): Resource<SeasonResponse>;
 //#endregion
 export { SeasonResponse as i, season as n, GrandmasterLeaderboardResponse as r, grandmasterLeaderboard as t };
-//# sourceMappingURL=index-BtQ6VqOV.d.ts.map
+//# sourceMappingURL=index-6S3wZC_n.d.ts.map

package/dist/{index-BBcAaWfH.d.ts → index-CYQKcybk.d.ts}

@@ -1,4 +1,4 @@
-import { t as StarcraftRegion } from "./regions-pSiIWRj6.js";
+import { t as StarcraftRegion } from "./regions-D_uWPFaI.js";
 import { Resource } from "@blizzard-api/core";
 //#region src/profile/types.d.ts
 interface LadderResponse {
@@ -154,7 +154,7 @@ interface ProfileSwarmLevels {
 }
 interface Reward {
   achievementId?: string;
-  command?: '/dance';
+  command?: '/dance' | (string & {});
   flags: number;
   id: string;
   imageUrl: string;
@@ -212,4 +212,4 @@ declare function profile(regionId: StarcraftRegion, realmId: 1 | 2, profileId: n
 declare function staticProfile(regionId: StarcraftRegion): Resource<StaticProfileResponse>;
 //#endregion
 export { staticProfile as a, MetadataResponse as c, profile as i, ProfileResponse as l, ladderSummary as n, LadderResponse as o, metadata as r, LadderSummaryResponse as s, ladder as t, StaticProfileResponse as u };
-//# sourceMappingURL=index-BBcAaWfH.d.ts.map
+//# sourceMappingURL=index-CYQKcybk.d.ts.map

package/dist/{index-Dxs7pfrO.d.ts → index-Ca9LHu8M.d.ts}

@@ -1,4 +1,4 @@
-import { t as StarcraftRegion } from "./regions-pSiIWRj6.js";
+import { t as StarcraftRegion } from "./regions-D_uWPFaI.js";
 import { Resource } from "@blizzard-api/core";
 //#region src/legacy/types.d.ts
 interface LegacyAchievementsResponse {
@@ -56,7 +56,7 @@ interface Achievements {
 }
 interface Animation {
   achievementId: string;
-  command?: '/dance';
+  command?: '/dance' | (string & {});
   icon: Icon;
   id: string;
   name?: string;
@@ -225,4 +225,4 @@ declare function legacyProfile(regionId: StarcraftRegion, realmId: 1 | 2, profil
 declare function legacyRewards(regionId: StarcraftRegion): Resource<LegacyRewardsResponse>;
 //#endregion
 export { legacyProfile as a, LegacyLaddersResponse as c, LegacyRewardsResponse as d, SingleLegacyLadderResponse as f, legacyMatchHistory as i, LegacyMatchHistoryResponse as l, legacyLadder as n, legacyRewards as o, legacyLadders as r, LegacyAchievementsResponse as s, legacyAchievements as t, LegacyProfileResponse as u };
-//# sourceMappingURL=index-Dxs7pfrO.d.ts.map
+//# sourceMappingURL=index-Ca9LHu8M.d.ts.map

package/dist/index.d.ts

@@ -1,8 +1,9 @@
 import { player } from "./account/index.js";
-import { i as SeasonResponse, n as season, r as GrandmasterLeaderboardResponse, t as grandmasterLeaderboard } from "./index-BtQ6VqOV.js";
+import { n as starcraftRegion, t as StarcraftRegion } from "./regions-D_uWPFaI.js";
+import { i as SeasonResponse, n as season, r as GrandmasterLeaderboardResponse, t as grandmasterLeaderboard } from "./index-6S3wZC_n.js";
 import { a as StarcraftLeagueTeamType, i as StarcraftLeagueQueue, n as LeagueDataResponse, r as StarcraftLeagueId, t as getLeagueData } from "./index-BawvMD5r.js";
-import { a as legacyProfile, c as LegacyLaddersResponse, d as LegacyRewardsResponse, f as SingleLegacyLadderResponse, i as legacyMatchHistory, l as LegacyMatchHistoryResponse, n as legacyLadder, o as legacyRewards, r as legacyLadders, s as LegacyAchievementsResponse, t as legacyAchievements, u as LegacyProfileResponse } from "./index-Dxs7pfrO.js";
-import { a as staticProfile, c as MetadataResponse, i as profile, l as ProfileResponse, n as ladderSummary, o as LadderResponse, r as metadata, s as LadderSummaryResponse, t as ladder, u as StaticProfileResponse } from "./index-BBcAaWfH.js";
+import { a as legacyProfile, c as LegacyLaddersResponse, d as LegacyRewardsResponse, f as SingleLegacyLadderResponse, i as legacyMatchHistory, l as LegacyMatchHistoryResponse, n as legacyLadder, o as legacyRewards, r as legacyLadders, s as LegacyAchievementsResponse, t as legacyAchievements, u as LegacyProfileResponse } from "./index-Ca9LHu8M.js";
+import { a as staticProfile, c as MetadataResponse, i as profile, l as ProfileResponse, n as ladderSummary, o as LadderResponse, r as metadata, s as LadderSummaryResponse, t as ladder, u as StaticProfileResponse } from "./index-CYQKcybk.js";
 //#region src/index.d.ts
 declare const sc2: {
   player: typeof player;
@@ -20,7 +21,8 @@ declare const sc2: {
   metadata: typeof metadata;
   profile: typeof profile;
   staticProfile: typeof staticProfile;
+  starcraftRegion: Record<StarcraftRegion, number>;
 };
 //#endregion
-export { type GrandmasterLeaderboardResponse, type LadderResponse, type LadderSummaryResponse, type LeagueDataResponse, type LegacyAchievementsResponse, type LegacyLaddersResponse, type LegacyMatchHistoryResponse, type LegacyProfileResponse, type LegacyRewardsResponse, type MetadataResponse, type ProfileResponse, type SeasonResponse, type SingleLegacyLadderResponse, type StarcraftLeagueId, type StarcraftLeagueQueue, type StarcraftLeagueTeamType, type StaticProfileResponse, sc2 as default, sc2, getLeagueData, grandmasterLeaderboard, ladder, ladderSummary, legacyAchievements, legacyLadder, legacyLadders, legacyMatchHistory, legacyProfile, legacyRewards, metadata, player, profile, season, staticProfile };
+export { type GrandmasterLeaderboardResponse, type LadderResponse, type LadderSummaryResponse, type LeagueDataResponse, type LegacyAchievementsResponse, type LegacyLaddersResponse, type LegacyMatchHistoryResponse, type LegacyProfileResponse, type LegacyRewardsResponse, type MetadataResponse, type ProfileResponse, type SeasonResponse, type SingleLegacyLadderResponse, type StarcraftLeagueId, type StarcraftLeagueQueue, type StarcraftLeagueTeamType, StarcraftRegion, type StaticProfileResponse, sc2 as default, sc2, getLeagueData, grandmasterLeaderboard, ladder, ladderSummary, legacyAchievements, legacyLadder, legacyLadders, legacyMatchHistory, legacyProfile, legacyRewards, metadata, player, profile, season, starcraftRegion, staticProfile };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,4 +1,5 @@
 import { player } from "./account/index.js";
+import { t as starcraftRegion } from "./regions-WKmRG-YC.js";
 import { grandmasterLeaderboard, season } from "./ladder/index.js";
 import { getLeagueData } from "./league/index.js";
 import { legacyAchievements, legacyLadder, legacyLadders, legacyMatchHistory, legacyProfile, legacyRewards } from "./legacy/index.js";
@@ -19,9 +20,10 @@ const sc2 = {
 	ladderSummary,
 	metadata,
 	profile,
-	staticProfile
+	staticProfile,
+	starcraftRegion
 };
 //#endregion
-export { sc2 as default, sc2, getLeagueData, grandmasterLeaderboard, ladder, ladderSummary, legacyAchievements, legacyLadder, legacyLadders, legacyMatchHistory, legacyProfile, legacyRewards, metadata, player, profile, season, staticProfile };
+export { sc2 as default, sc2, getLeagueData, grandmasterLeaderboard, ladder, ladderSummary, legacyAchievements, legacyLadder, legacyLadders, legacyMatchHistory, legacyProfile, legacyRewards, metadata, player, profile, season, starcraftRegion, staticProfile };
 
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["import { player } from './account/index';\r\nimport { grandmasterLeaderboard, season } from './ladder/index';\r\nimport { getLeagueData } from './league/index';\r\nimport {\r\n  legacyAchievements,\r\n  legacyLadder,\r\n  legacyLadders,\r\n  legacyMatchHistory,\r\n  legacyProfile,\r\n  legacyRewards,\r\n} from './legacy/index';\r\nimport { ladder, ladderSummary, metadata, profile, staticProfile } from './profile/index';\r\n\r\nconst sc2 = {\r\n  //Account\r\n  player,\r\n  //Ladder\r\n  grandmasterLeaderboard,\r\n  season,\r\n  //League\r\n  getLeagueData,\r\n  //Legacy\r\n  legacyAchievements,\r\n  legacyLadder,\r\n  legacyLadders,\r\n  legacyMatchHistory,\r\n  legacyProfile,\r\n  legacyRewards,\r\n  //Profile\r\n  ladder,\r\n  ladderSummary,\r\n  metadata,\r\n  profile,\r\n  staticProfile,\r\n};\r\nexport default sc2;\r\nexport { sc2 };\r\n\r\n//Account\r\nexport * from './account/index';\r\n//Ladder\r\nexport * from './ladder/index';\r\nexport type * from './ladder/types';\r\n//League\r\nexport * from './league/index';\r\nexport type * from './league/types';\r\n//Legacy\r\nexport * from './legacy/index';\r\nexport type * from './legacy/types';\r\n//Profile\r\nexport * from './profile/index';\r\nexport type * from './profile/types';\r\n"],"mappings":";;;;;;AAaA,MAAM,MAAM;CAEV;CAEA;CACA;CAEA;CAEA;CACA;CACA;CACA;CACA;CACA;CAEA;CACA;CACA;CACA;CACA;AACF"}
+{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["import { player } from './account/index';\nimport { grandmasterLeaderboard, season } from './ladder/index';\nimport { getLeagueData } from './league/index';\nimport {\n  legacyAchievements,\n  legacyLadder,\n  legacyLadders,\n  legacyMatchHistory,\n  legacyProfile,\n  legacyRewards,\n} from './legacy/index';\nimport { ladder, ladderSummary, metadata, profile, staticProfile } from './profile/index';\nimport { starcraftRegion } from './regions';\n\nconst sc2 = {\n  //Account\n  player,\n  //Ladder\n  grandmasterLeaderboard,\n  season,\n  //League\n  getLeagueData,\n  //Legacy\n  legacyAchievements,\n  legacyLadder,\n  legacyLadders,\n  legacyMatchHistory,\n  legacyProfile,\n  legacyRewards,\n  //Profile\n  ladder,\n  ladderSummary,\n  metadata,\n  profile,\n  staticProfile,\n  //Regions\n  starcraftRegion,\n};\nexport default sc2;\nexport { sc2 };\n\n//Account\nexport * from './account/index';\n//Ladder\nexport * from './ladder/index';\nexport type * from './ladder/types';\n//League\nexport * from './league/index';\nexport type * from './league/types';\n//Legacy\nexport * from './legacy/index';\nexport type * from './legacy/types';\n//Profile\nexport * from './profile/index';\nexport type * from './profile/types';\n//Regions\nexport * from './regions';\n"],"mappings":";;;;;;;AAcA,MAAM,MAAM;CAEV;CAEA;CACA;CAEA;CAEA;CACA;CACA;CACA;CACA;CACA;CAEA;CACA;CACA;CACA;CACA;CAEA;AACF"}

package/dist/ladder/index.d.ts

@@ -1,2 +1,2 @@
-import { n as season, t as grandmasterLeaderboard } from "../index-BtQ6VqOV.js";
+import { n as season, t as grandmasterLeaderboard } from "../index-6S3wZC_n.js";
 export { grandmasterLeaderboard, season };

package/dist/legacy/index.d.ts

@@ -1,2 +1,2 @@
-import { a as legacyProfile, i as legacyMatchHistory, n as legacyLadder, o as legacyRewards, r as legacyLadders, t as legacyAchievements } from "../index-Dxs7pfrO.js";
+import { a as legacyProfile, i as legacyMatchHistory, n as legacyLadder, o as legacyRewards, r as legacyLadders, t as legacyAchievements } from "../index-Ca9LHu8M.js";
 export { legacyAchievements, legacyLadder, legacyLadders, legacyMatchHistory, legacyProfile, legacyRewards };

package/dist/profile/index.d.ts

@@ -1,2 +1,2 @@
-import { a as staticProfile, i as profile, n as ladderSummary, r as metadata, t as ladder } from "../index-BBcAaWfH.js";
+import { a as staticProfile, i as profile, n as ladderSummary, r as metadata, t as ladder } from "../index-CYQKcybk.js";
 export { ladder, ladderSummary, metadata, profile, staticProfile };

package/dist/regions-D_uWPFaI.d.ts

@@ -0,0 +1,6 @@
+//#region src/regions.d.ts
+type StarcraftRegion = 'cn' | 'eu' | 'kr' | 'tw' | 'us';
+declare const starcraftRegion: Record<StarcraftRegion, number>;
+//#endregion
+export { starcraftRegion as n, StarcraftRegion as t };
+//# sourceMappingURL=regions-D_uWPFaI.d.ts.map

package/package.json

@@ -1,18 +1,28 @@
 {
   "name": "@blizzard-api/sc2",
-  "version": "3.1.2",
+  "version": "3.2.0",
+  "description": "A series of helpers to interact with the Starcraft II Blizzard API",
+  "keywords": [
+    "api",
+    "battle.net",
+    "battlenet",
+    "blizzard",
+    "bnet",
+    "sc2",
+    "starcraft"
+  ],
   "license": "MIT",
   "author": "Putro",
-  "description": "A series of helpers to interact with the Starcraft II Blizzard API",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/Pewtro/blizzard-api.git",
     "directory": "packages/sc2"
   },
+  "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",
-    "starcraft",
-    "sc2"
-  ],
   "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",

package/dist/regions-pSiIWRj6.d.ts

@@ -1,5 +0,0 @@
-//#region src/regions.d.ts
-type StarcraftRegion = 'cn' | 'eu' | 'kr' | 'tw' | 'us';
-//#endregion
-export { StarcraftRegion as t };
-//# sourceMappingURL=regions-pSiIWRj6.d.ts.map