@blizzard-api/sc2 1.0.4 → 1.0.5

package/dist/index.d.ts

@@ -1,5 +1,11 @@
-import { Resource } from '@blizzard-api/core';
+import { Resource } from "@blizzard-api/core";
 
+//#region src/account/account.d.ts
+/**
+* Returns the player information for the specified account ID.
+* @param accountId The account ID
+* @returns The player resource. See {@link Resource}.
+*/
 /**
  * Returns the player information for the specified account ID.
  * @param accountId The account ID
@@ -7,46 +13,52 @@ import { Resource } from '@blizzard-api/core';
  */
 declare function player(accountId: string): Resource<Array<unknown>>;
 
+//#endregion
+//#region src/base.d.ts
 /**
  * Base interface for Blizzard API responses.
  */
 interface ResponseBase {
-    _links: {
-        self: {
-            href: string;
-        };
+  _links: {
+    self: {
+      href: string;
     };
+  };
 }
 type StarcraftRegion = 'cn' | 'eu' | 'kr' | 'tw' | 'us';
 
+//#endregion
+//#region src/ladder/types.d.ts
 interface GrandmasterLeaderboardResponse {
-    ladderTeams: Array<LadderTeam>;
+  ladderTeams: Array<LadderTeam>;
 }
 interface SeasonResponse {
-    endDate: string;
-    number: number;
-    seasonId: number;
-    startDate: string;
-    year: number;
+  endDate: string;
+  number: number;
+  seasonId: number;
+  startDate: string;
+  year: number;
 }
 interface LadderTeam {
-    joinTimestamp: number;
-    losses: number;
-    mmr: number;
-    points: number;
-    previousRank: number;
-    teamMembers: Array<TeamMember>;
-    wins: number;
+  joinTimestamp: number;
+  losses: number;
+  mmr: number;
+  points: number;
+  previousRank: number;
+  teamMembers: Array<TeamMember>;
+  wins: number;
 }
 interface TeamMember {
-    clanTag?: string;
-    displayName: string;
-    favoriteRace: 'protoss' | 'random' | 'terran' | 'zerg';
-    id: string;
-    realm: number;
-    region: number;
+  clanTag?: string;
+  displayName: string;
+  favoriteRace: 'protoss' | 'random' | 'terran' | 'zerg';
+  id: string;
+  realm: number;
+  region: number;
 }
 
+//#endregion
+//#region src/ladder/ladder.d.ts
 /**
  * Returns the grandmaster leaderboard for the specified region.
  * @param regionId The region ID
@@ -60,29 +72,33 @@ declare function grandmasterLeaderboard(regionId: StarcraftRegion): Resource<Gra
  */
 declare function season(regionId: StarcraftRegion): Resource<SeasonResponse>;
 
+//#endregion
+//#region src/league/types.d.ts
 interface LeagueDataResponse extends ResponseBase {
-    key: Key;
-    tier: Array<Tier>;
+  key: Key;
+  tier: Array<Tier>;
 }
 type StarcraftLeagueId = 'bronze' | 'diamond' | 'gold' | 'grandmaster' | 'master' | 'platinum' | 'silver';
 type StarcraftLeagueQueue = 'hots-1v1' | 'hots-2v2' | 'hots-3v3' | 'hots-4v4' | 'lotv-1v1' | 'lotv-2v2' | 'lotv-3v3' | 'lotv-4v4' | 'lotv-archon' | 'wol-1v1' | 'wol-2v2' | 'wol-3v3' | 'wol-4v4';
 type StarcraftLeagueTeamType = 'arranged' | 'random';
 interface Division {
-    id: number;
-    ladder_id: number;
-    member_count: number;
+  id: number;
+  ladder_id: number;
+  member_count: number;
 }
 interface Key {
-    league_id: number;
-    queue_id: number;
-    season_id: number;
-    team_type: number;
+  league_id: number;
+  queue_id: number;
+  season_id: number;
+  team_type: number;
 }
 interface Tier {
-    division: Array<Division>;
-    id: number;
+  division: Array<Division>;
+  id: number;
 }
 
+//#endregion
+//#region src/league/league.d.ts
 /**
  * Returns the league data for the specified season, queue, team type, and league.
  * @param seasonId The season ID
@@ -93,131 +109,135 @@ interface Tier {
  */
 declare function getLeagueData(seasonId: string, queueId: StarcraftLeagueQueue, teamType: StarcraftLeagueTeamType, leagueId: StarcraftLeagueId): Resource<LeagueDataResponse>;
 
+//#endregion
+//#region src/legacy/types.d.ts
 interface LegacyAchievementsResponse {
-    achievements: Array<Achievement$1>;
-    categories: Array<Category$1>;
+  achievements: Array<Achievement$1>;
+  categories: Array<Category$1>;
 }
 interface LegacyLaddersResponse {
-    currentSeason: Array<unknown>;
-    previousSeason: Array<unknown>;
-    showcasePlacement: Array<unknown>;
+  currentSeason: Array<unknown>;
+  previousSeason: Array<unknown>;
+  showcasePlacement: Array<unknown>;
 }
 interface LegacyMatchHistoryResponse {
-    matches: Array<Match>;
+  matches: Array<Match>;
 }
 interface LegacyProfileResponse {
-    achievements: Achievements;
-    campaign: Campaign;
-    career: Career;
-    clanName: string;
-    clanTag: string;
-    displayName: string;
-    id: string;
-    portrait: Icon;
-    profilePath: string;
-    realm: number;
-    rewards: Rewards;
-    season: Season;
-    swarmLevels: SwarmLevels;
+  achievements: Achievements;
+  campaign: Campaign;
+  career: Career;
+  clanName: string;
+  clanTag: string;
+  displayName: string;
+  id: string;
+  portrait: Icon;
+  profilePath: string;
+  realm: number;
+  rewards: Rewards;
+  season: Season;
+  swarmLevels: SwarmLevels;
 }
 interface LegacyRewardsResponse {
-    animations: Array<Animation>;
-    portraits: Array<Animation>;
-    protossDecals: Array<Animation>;
-    skins: Array<Animation>;
-    terranDecals: Array<Animation>;
-    zergDecals: Array<Animation>;
+  animations: Array<Animation>;
+  portraits: Array<Animation>;
+  protossDecals: Array<Animation>;
+  skins: Array<Animation>;
+  terranDecals: Array<Animation>;
+  zergDecals: Array<Animation>;
 }
 interface Achievement$1 {
-    achievementId: string;
-    categoryId: string;
-    description: string;
-    icon: Icon;
-    points: number;
-    title: string;
+  achievementId: string;
+  categoryId: string;
+  description: string;
+  icon: Icon;
+  points: number;
+  title: string;
 }
 interface Achievements {
-    achievements: Array<{
-        achievementId: string;
-        completionDate: number;
-    }>;
-    points: Points;
+  achievements: Array<{
+    achievementId: string;
+    completionDate: number;
+  }>;
+  points: Points;
 }
 interface Animation {
-    achievementId: string;
-    command?: '/dance';
-    icon: Icon;
-    id: string;
-    name?: string;
-    title: string;
+  achievementId: string;
+  command?: '/dance';
+  icon: Icon;
+  id: string;
+  name?: string;
+  title: string;
 }
 interface Campaign {
-    hots: string;
-    wol: string;
+  hots: string;
+  wol: string;
 }
 interface Career {
-    careerTotalGames: number;
-    highest1v1Rank: string;
-    highestTeamRank: string;
-    primaryRace: string;
-    protossWins: number;
-    seasonTotalGames: number;
-    terranWins: number;
-    zergWins: number;
+  careerTotalGames: number;
+  highest1v1Rank: string;
+  highestTeamRank: string;
+  primaryRace: string;
+  protossWins: number;
+  seasonTotalGames: number;
+  terranWins: number;
+  zergWins: number;
 }
 interface Category$1 {
-    categoryId: string;
-    children?: Array<Category$1>;
-    featuredAchievementId: string;
-    title: string;
+  categoryId: string;
+  children?: Array<Category$1>;
+  featuredAchievementId: string;
+  title: string;
 }
 interface Icon {
-    h: number;
-    offset: number;
-    url: string;
-    w: number;
-    x: number;
-    y: number;
+  h: number;
+  offset: number;
+  url: string;
+  w: number;
+  x: number;
+  y: number;
 }
 interface Match {
-    date: number;
-    decision: 'Left' | 'Loss' | 'Win';
-    map: string;
-    speed: 'Fast' | 'Faster';
-    type: '2v2' | '3v3' | 'Co-Op' | 'Custom';
+  date: number;
+  decision: 'Left' | 'Loss' | 'Win';
+  map: string;
+  speed: 'Fast' | 'Faster';
+  type: '2v2' | '3v3' | 'Co-Op' | 'Custom';
 }
 interface Points {
-    categoryPoints: Record<string, number>;
-    totalPoints: number;
+  categoryPoints: Record<string, number>;
+  totalPoints: number;
 }
 interface Rewards {
-    earned: Array<string>;
-    selected: Array<string>;
+  earned: Array<string>;
+  selected: Array<string>;
 }
 interface Season {
-    seasonId: number;
-    seasonNumber: number;
-    seasonYear: number;
-    stats: Array<Stat>;
-    totalGamesThisSeason: number;
+  seasonId: number;
+  seasonNumber: number;
+  seasonYear: number;
+  stats: Array<Stat>;
+  totalGamesThisSeason: number;
 }
 interface Stat {
-    games: number;
-    type: string;
-    wins: number;
+  games: number;
+  type: string;
+  wins: number;
 }
 interface SwarmLevels {
-    level: number;
-    protoss: SwarmLevelsByRace;
-    terran: SwarmLevelsByRace;
-    zerg: SwarmLevelsByRace;
+  level: number;
+  protoss: SwarmLevelsByRace;
+  terran: SwarmLevelsByRace;
+  zerg: SwarmLevelsByRace;
 }
 interface SwarmLevelsByRace {
-    currentLevelXP: number;
-    level: number;
-    totalLevelXP: number;
+  currentLevelXP: number;
+  level: number;
+  totalLevelXP: number;
 }
 
+//#endregion
+//#region src/legacy/legacy.d.ts
 /**
  * Returns the legacy achievements for the specified region.
  * @param regionId The region ID for Starcraft.
@@ -262,75 +282,79 @@ declare function legacyProfile(regionId: StarcraftRegion, realmId: 1 | 2, profil
  */
 declare function legacyRewards(regionId: StarcraftRegion): Resource<LegacyRewardsResponse>;
 
+//#endregion
+//#region src/profile/types.d.ts
 interface LadderResponse {
-    allLadderMemberships: Array<unknown>;
-    ladderTeams: Array<unknown>;
-    ranksAndPools: Array<unknown>;
+  allLadderMemberships: Array<unknown>;
+  ladderTeams: Array<unknown>;
+  ranksAndPools: Array<unknown>;
 }
 interface LadderSummaryResponse {
-    allLadderMemberships: Array<unknown>;
-    placementMatches: Array<unknown>;
-    showCaseEntries: Array<unknown>;
+  allLadderMemberships: Array<unknown>;
+  placementMatches: Array<unknown>;
+  showCaseEntries: Array<unknown>;
 }
 interface MetadataResponse {
-    avatarUrl: string;
-    name: string;
-    profileId: string;
-    profileUrl: string;
-    realmId: number;
-    regionId: number;
+  avatarUrl: string;
+  name: string;
+  profileId: string;
+  profileUrl: string;
+  realmId: number;
+  regionId: number;
 }
 interface StaticProfileResponse {
-    achievements: Array<Achievement>;
-    categories: Array<Category>;
-    criteria: Array<Criterion>;
-    rewards: Array<Reward>;
+  achievements: Array<Achievement>;
+  categories: Array<Category>;
+  criteria: Array<Criterion>;
+  rewards: Array<Reward>;
 }
 interface Achievement {
-    categoryId: string;
-    chainAchievementIds: Array<string>;
-    chainRewardSize: number;
-    criteriaIds?: Array<string>;
-    description: string;
-    flags: number;
-    id: string;
-    imageUrl: string;
-    isChained: boolean;
-    points: number;
-    title: string;
-    uiOrderHint: number;
+  categoryId: string;
+  chainAchievementIds: Array<string>;
+  chainRewardSize: number;
+  criteriaIds?: Array<string>;
+  description: string;
+  flags: number;
+  id: string;
+  imageUrl: string;
+  isChained: boolean;
+  points: number;
+  title: string;
+  uiOrderHint: number;
 }
 interface Category {
-    childrenCategoryIds: Array<string>;
-    featuredAchievementId: string;
-    id: string;
-    medalTiers?: Array<number>;
-    name: string;
-    parentCategoryId: null | string;
-    points: number;
-    uiOrderHint: number;
+  childrenCategoryIds: Array<string>;
+  featuredAchievementId: string;
+  id: string;
+  medalTiers?: Array<number>;
+  name: string;
+  parentCategoryId: null | string;
+  points: number;
+  uiOrderHint: number;
 }
 interface Criterion {
-    achievementId: string;
-    description: string;
-    evaluationClass: 'Achv' | 'Clnt' | 'S2Gm' | 'Sunk' | 'Trny';
-    flags: number;
-    id: string;
-    necessaryQuantity: number;
-    uiOrderHint: number;
+  achievementId: string;
+  description: string;
+  evaluationClass: 'Achv' | 'Clnt' | 'S2Gm' | 'Sunk' | 'Trny';
+  flags: number;
+  id: string;
+  necessaryQuantity: number;
+  uiOrderHint: number;
 }
 interface Reward {
-    achievementId?: string;
-    command?: '/dance';
-    flags: number;
-    id: string;
-    imageUrl: string;
-    isSkin: boolean;
-    name: string;
-    uiOrderHint: number;
-    unlockableType: string;
+  achievementId?: string;
+  command?: '/dance';
+  flags: number;
+  id: string;
+  imageUrl: string;
+  isSkin: boolean;
+  name: string;
+  uiOrderHint: number;
+  unlockableType: string;
 }
 
+//#endregion
+//#region src/profile/profile.d.ts
 /**
  * Returns the ladder information for the specified profile and ladder.
  * @param regionId The region ID for Starcraft.
@@ -371,22 +395,26 @@ declare function profile(regionId: StarcraftRegion, realmId: 1 | 2, profileId: n
  */
 declare function staticProfile(regionId: StarcraftRegion): Resource<StaticProfileResponse>;
 
+//#endregion
+//#region src/index.d.ts
 declare const sc2: {
-    player: typeof player;
-    grandmasterLeaderboard: typeof grandmasterLeaderboard;
-    season: typeof season;
-    getLeagueData: typeof getLeagueData;
-    legacyAchievements: typeof legacyAchievements;
-    legacyLadder: typeof legacyLadder;
-    legacyLadders: typeof legacyLadders;
-    legacyMatchHistory: typeof legacyMatchHistory;
-    legacyProfile: typeof legacyProfile;
-    legacyRewards: typeof legacyRewards;
-    ladder: typeof ladder;
-    ladderSummary: typeof ladderSummary;
-    metadata: typeof metadata;
-    profile: typeof profile;
-    staticProfile: typeof staticProfile;
+  player: typeof player;
+  grandmasterLeaderboard: typeof grandmasterLeaderboard;
+  season: typeof season;
+  getLeagueData: typeof getLeagueData;
+  legacyAchievements: typeof legacyAchievements;
+  legacyLadder: typeof legacyLadder;
+  legacyLadders: typeof legacyLadders;
+  legacyMatchHistory: typeof legacyMatchHistory;
+  legacyProfile: typeof legacyProfile;
+  legacyRewards: typeof legacyRewards;
+  ladder: typeof ladder;
+  ladderSummary: typeof ladderSummary;
+  metadata: typeof metadata;
+  profile: typeof profile;
+  staticProfile: typeof staticProfile;
 };
 
-export { type GrandmasterLeaderboardResponse, type LadderResponse, type LadderSummaryResponse, type LeagueDataResponse, type LegacyAchievementsResponse, type LegacyLaddersResponse, type LegacyMatchHistoryResponse, type LegacyProfileResponse, type LegacyRewardsResponse, type MetadataResponse, type SeasonResponse, type StarcraftLeagueId, type StarcraftLeagueQueue, type StarcraftLeagueTeamType, type StaticProfileResponse, sc2 as default, getLeagueData, grandmasterLeaderboard, ladder, ladderSummary, legacyAchievements, legacyLadder, legacyLadders, legacyMatchHistory, legacyProfile, legacyRewards, metadata, player, profile, sc2, season, staticProfile };
+//#endregion
+export { GrandmasterLeaderboardResponse, LadderResponse, LadderSummaryResponse, LeagueDataResponse, LegacyAchievementsResponse, LegacyLaddersResponse, LegacyMatchHistoryResponse, LegacyProfileResponse, LegacyRewardsResponse, MetadataResponse, SeasonResponse, StarcraftLeagueId, StarcraftLeagueQueue, StarcraftLeagueTeamType, StaticProfileResponse, sc2 as default, getLeagueData, grandmasterLeaderboard, ladder, ladderSummary, legacyAchievements, legacyLadder, legacyLadders, legacyMatchHistory, legacyProfile, legacyRewards, metadata, player, profile, sc2, season, staticProfile };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,150 +1,294 @@
-// src/account/account.ts
+//#region src/account/account.ts
+/**
+
+* Returns the player information for the specified account ID.
+
+* @param accountId The account ID
+
+* @returns The player resource. See {@link Resource}.
+
+*/
 function player(accountId) {
-  return {
-    path: `/sc2/player/${accountId}`
-  };
+	return { path: `/sc2/player/${accountId}` };
 }
 
-// src/base.ts
-var starcraftRegion = {
-  cn: 5,
-  eu: 2,
-  kr: 3,
-  tw: 3,
-  us: 1
+//#endregion
+//#region src/base.ts
+const starcraftRegion = {
+	cn: 5,
+	eu: 2,
+	kr: 3,
+	tw: 3,
+	us: 1
 };
 
-// src/ladder/ladder.ts
+//#endregion
+//#region src/ladder/ladder.ts
+/**
+
+* Returns the grandmaster leaderboard for the specified region.
+
+* @param regionId The region ID
+
+* @returns The grandmaster leaderboard resource. See {@link GrandmasterLeaderboardResponse}.
+
+*/
 function grandmasterLeaderboard(regionId) {
-  return {
-    path: `/sc2/ladder/grandmaster/${starcraftRegion[regionId]}`
-  };
+	return { path: `/sc2/ladder/grandmaster/${starcraftRegion[regionId]}` };
 }
+/**
+
+* Returns the season information for the specified region.
+
+* @param regionId The region ID
+
+* @returns The season resource. See {@link SeasonResponse}.
+
+*/
 function season(regionId) {
-  return {
-    path: `/sc2/ladder/season/${starcraftRegion[regionId]}`
-  };
+	return { path: `/sc2/ladder/season/${starcraftRegion[regionId]}` };
 }
 
-// src/league/league.ts
-var starcraftLeagueQueue = {
-  "hots-1v1": 101,
-  "hots-2v2": 102,
-  "hots-3v3": 103,
-  "hots-4v4": 104,
-  "lotv-1v1": 201,
-  "lotv-2v2": 202,
-  "lotv-3v3": 203,
-  "lotv-4v4": 204,
-  "lotv-archon": 206,
-  "wol-1v1": 1,
-  "wol-2v2": 2,
-  "wol-3v3": 3,
-  "wol-4v4": 4
+//#endregion
+//#region src/league/league.ts
+const starcraftLeagueQueue = {
+	"hots-1v1": 101,
+	"hots-2v2": 102,
+	"hots-3v3": 103,
+	"hots-4v4": 104,
+	"lotv-1v1": 201,
+	"lotv-2v2": 202,
+	"lotv-3v3": 203,
+	"lotv-4v4": 204,
+	"lotv-archon": 206,
+	"wol-1v1": 1,
+	"wol-2v2": 2,
+	"wol-3v3": 3,
+	"wol-4v4": 4
 };
-var starcraftLeagueTeam = {
-  arranged: 0,
-  random: 1
+const starcraftLeagueTeam = {
+	arranged: 0,
+	random: 1
 };
-var starcraftLeagueId = {
-  bronze: 0,
-  diamond: 4,
-  gold: 2,
-  grandmaster: 6,
-  master: 5,
-  platinum: 3,
-  silver: 1
+const starcraftLeagueId = {
+	bronze: 0,
+	diamond: 4,
+	gold: 2,
+	grandmaster: 6,
+	master: 5,
+	platinum: 3,
+	silver: 1
 };
+/**
+
+* Returns the league data for the specified season, queue, team type, and league.
+
+* @param seasonId The season ID
+
+* @param queueId The queue ID
+
+* @param teamType The team type
+
+* @param leagueId The league ID
+
+* @returns The league data resource. See {@link LeagueDataResponse}.
+
+*/
 function getLeagueData(seasonId, queueId, teamType, leagueId) {
-  return {
-    path: `/data/sc2/league/${seasonId}/${starcraftLeagueQueue[queueId]}/${starcraftLeagueTeam[teamType]}/${starcraftLeagueId[leagueId]}`
-  };
+	return { path: `/data/sc2/league/${seasonId}/${starcraftLeagueQueue[queueId]}/${starcraftLeagueTeam[teamType]}/${starcraftLeagueId[leagueId]}` };
 }
 
-// src/legacy/legacy.ts
+//#endregion
+//#region src/legacy/legacy.ts
+/**
+
+* Returns the legacy achievements for the specified region.
+
+* @param regionId The region ID for Starcraft.
+
+* @returns A resource representing the legacy achievements. See {@link LegacyAchievementsResponse}
+
+*/
 function legacyAchievements(regionId) {
-  return {
-    path: `/sc2/legacy/data/achievements/${starcraftRegion[regionId]}`
-  };
+	return { path: `/sc2/legacy/data/achievements/${starcraftRegion[regionId]}` };
 }
+/**
+
+* Returns the ladder information for the specified ladder.
+
+* @param regionId The region ID for Starcraft.
+
+* @param ladderId The ID of the ladder.
+
+* @returns A resource representing the ladder. See {@link LadderResponse}
+
+*/
 function legacyLadder(regionId, ladderId) {
-  return {
-    path: `/sc2/legacy/ladder/${starcraftRegion[regionId]}/${ladderId}`
-  };
+	return { path: `/sc2/legacy/ladder/${starcraftRegion[regionId]}/${ladderId}` };
 }
+/**
+
+* Returns the ladders for the specified profile.
+
+* @param regionId The region ID for Starcraft.
+
+* @param realmId 1 or 2
+
+* @param profileId The ID of the profile.
+
+* @returns A resource representing the ladders for the given profile. See {@link LegacyLaddersResponse}
+
+*/
 function legacyLadders(regionId, realmId, profileId) {
-  return {
-    path: `/sc2/legacy/profile/${starcraftRegion[regionId]}/${realmId}/${profileId}/ladders`
-  };
+	return { path: `/sc2/legacy/profile/${starcraftRegion[regionId]}/${realmId}/${profileId}/ladders` };
 }
+/**
+
+* Returns the match history for the specified profile.
+
+* @param regionId The region ID for Starcraft.
+
+* @param realmId 1 or 2
+
+* @param profileId The ID of the profile.
+
+* @returns A resource representing the match history for the given profile. See {@link LegacyMatchHistoryResponse}
+
+*/
 function legacyMatchHistory(regionId, realmId, profileId) {
-  return {
-    path: `/sc2/legacy/profile/${starcraftRegion[regionId]}/${realmId}/${profileId}/matches`
-  };
+	return { path: `/sc2/legacy/profile/${starcraftRegion[regionId]}/${realmId}/${profileId}/matches` };
 }
+/**
+
+* Returns the profile for the specified profile.
+
+* @param regionId The region ID for Starcraft.
+
+* @param realmId 1 or 2
+
+* @param profileId The ID of the profile.
+
+* @returns A resource representing the profile for the given ID. See {@link LegacyProfileResponse}
+
+*/
 function legacyProfile(regionId, realmId, profileId) {
-  return {
-    path: `/sc2/legacy/profile/${starcraftRegion[regionId]}/${realmId}/${profileId}`
-  };
+	return { path: `/sc2/legacy/profile/${starcraftRegion[regionId]}/${realmId}/${profileId}` };
 }
+/**
+
+* Returns the rewards for the specified region.
+
+* @param regionId The region ID for Starcraft.
+
+* @returns A resource representing the rewards for the given region. See {@link LegacyRewardsResponse}
+
+*/
 function legacyRewards(regionId) {
-  return {
-    path: `/sc2/legacy/data/rewards/${starcraftRegion[regionId]}`
-  };
+	return { path: `/sc2/legacy/data/rewards/${starcraftRegion[regionId]}` };
 }
 
-// src/profile/profile.ts
+//#endregion
+//#region src/profile/profile.ts
+/**
+
+* Returns the ladder information for the specified profile and ladder.
+
+* @param regionId The region ID for Starcraft.
+
+* @param realmId 1 or 2
+
+* @param profileId The ID of the profile.
+
+* @param ladderId The ID of the ladder.
+
+* @returns A resource representing the ladder. See {@link LadderResponse}
+
+*/
 function ladder(regionId, realmId, profileId, ladderId) {
-  return {
-    path: `/sc2/profile/${starcraftRegion[regionId]}/${realmId}/${profileId}/ladder/${ladderId}`
-  };
+	return { path: `/sc2/profile/${starcraftRegion[regionId]}/${realmId}/${profileId}/ladder/${ladderId}` };
 }
+/**
+
+* Returns the ladder summary information for the specified profile.
+
+* @param regionId The region ID for Starcraft.
+
+* @param realmId 1 or 2
+
+* @param profileId The ID of the profile.
+
+* @returns A resource representing the ladder summary. See {@link LadderSummaryResponse}
+
+*/
 function ladderSummary(regionId, realmId, profileId) {
-  return {
-    path: `/sc2/profile/${starcraftRegion[regionId]}/${realmId}/${profileId}/ladder/summary`
-  };
+	return { path: `/sc2/profile/${starcraftRegion[regionId]}/${realmId}/${profileId}/ladder/summary` };
 }
+/**
+
+* Returns the metadata information for the specified profile.
+
+* @param regionId The region ID for Starcraft.
+
+* @param realmId 1 or 2
+
+* @param profileId The ID of the profile.
+
+* @returns A resource representing the metadata. See {@link MetadataResponse}
+
+*/
 function metadata(regionId, realmId, profileId) {
-  return {
-    path: `/sc2/metadata/profile/${starcraftRegion[regionId]}/${realmId}/${profileId}`
-  };
+	return { path: `/sc2/metadata/profile/${starcraftRegion[regionId]}/${realmId}/${profileId}` };
 }
+/**
+
+* Returns the profile information for the specified profile.
+
+* @param regionId The region ID for Starcraft.
+
+* @param realmId 1 or 2
+
+* @param profileId The ID of the profile.
+
+* @returns A resource representing the profile. See {@link MetadataResponse}
+
+*/
 function profile(regionId, realmId, profileId) {
-  return {
-    path: `/sc2/profile/${starcraftRegion[regionId]}/${realmId}/${profileId}`
-  };
+	return { path: `/sc2/profile/${starcraftRegion[regionId]}/${realmId}/${profileId}` };
 }
+/**
+
+*
+
+* @param regionId The region ID for Starcraft.
+
+* @returns A resource representing the static profile. See {@link StaticProfileResponse}
+
+*/
 function staticProfile(regionId) {
-  return {
-    path: `/sc2/static/profile/${starcraftRegion[regionId]}`
-  };
+	return { path: `/sc2/static/profile/${starcraftRegion[regionId]}` };
 }
 
-// src/index.ts
-var sc2 = {
-  //Account
-  player,
-  //Ladder
-  grandmasterLeaderboard,
-  season,
-  //League
-  getLeagueData,
-  //Legacy
-  legacyAchievements,
-  legacyLadder,
-  legacyLadders,
-  legacyMatchHistory,
-  legacyProfile,
-  legacyRewards,
-  //Profile
-  ladder,
-  ladderSummary,
-  metadata,
-  profile,
-  staticProfile
+//#endregion
+//#region src/index.ts
+const sc2 = {
+	player,
+	grandmasterLeaderboard,
+	season,
+	getLeagueData,
+	legacyAchievements,
+	legacyLadder,
+	legacyLadders,
+	legacyMatchHistory,
+	legacyProfile,
+	legacyRewards,
+	ladder,
+	ladderSummary,
+	metadata,
+	profile,
+	staticProfile
 };
 var src_default = sc2;
 
+//#endregion
 export { src_default as default, getLeagueData, grandmasterLeaderboard, ladder, ladderSummary, legacyAchievements, legacyLadder, legacyLadders, legacyMatchHistory, legacyProfile, legacyRewards, metadata, player, profile, sc2, season, staticProfile };
-//# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/account/account.ts","../src/base.ts","../src/ladder/ladder.ts","../src/league/league.ts","../src/legacy/legacy.ts","../src/profile/profile.ts","../src/index.ts"],"names":[],"mappings":";AAOO,SAAS,OAAO,SAA6C,EAAA;AAClE,EAAO,OAAA;AAAA,IACL,IAAA,EAAM,eAAe,SAAS,CAAA;AAAA,GAChC;AACF;;;ACGO,IAAM,eAAmD,GAAA;AAAA,EAC9D,EAAI,EAAA,CAAA;AAAA,EACJ,EAAI,EAAA,CAAA;AAAA,EACJ,EAAI,EAAA,CAAA;AAAA,EACJ,EAAI,EAAA,CAAA;AAAA,EACJ,EAAI,EAAA;AACN,CAAA;;;ACXO,SAAS,uBAAuB,QAAqE,EAAA;AAC1G,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,wBAAA,EAA2B,eAAgB,CAAA,QAAQ,CAAC,CAAA;AAAA,GAC5D;AACF;AAOO,SAAS,OAAO,QAAqD,EAAA;AAC1E,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,mBAAA,EAAsB,eAAgB,CAAA,QAAQ,CAAC,CAAA;AAAA,GACvD;AACF;;;ACrBA,IAAM,oBAA6D,GAAA;AAAA,EACjE,UAAY,EAAA,GAAA;AAAA,EACZ,UAAY,EAAA,GAAA;AAAA,EACZ,UAAY,EAAA,GAAA;AAAA,EACZ,UAAY,EAAA,GAAA;AAAA,EACZ,UAAY,EAAA,GAAA;AAAA,EACZ,UAAY,EAAA,GAAA;AAAA,EACZ,UAAY,EAAA,GAAA;AAAA,EACZ,UAAY,EAAA,GAAA;AAAA,EACZ,aAAe,EAAA,GAAA;AAAA,EACf,SAAW,EAAA,CAAA;AAAA,EACX,SAAW,EAAA,CAAA;AAAA,EACX,SAAW,EAAA,CAAA;AAAA,EACX,SAAW,EAAA;AACb,CAAA;AAEA,IAAM,mBAA+D,GAAA;AAAA,EACnE,QAAU,EAAA,CAAA;AAAA,EACV,MAAQ,EAAA;AACV,CAAA;AAEA,IAAM,iBAAuD,GAAA;AAAA,EAC3D,MAAQ,EAAA,CAAA;AAAA,EACR,OAAS,EAAA,CAAA;AAAA,EACT,IAAM,EAAA,CAAA;AAAA,EACN,WAAa,EAAA,CAAA;AAAA,EACb,MAAQ,EAAA,CAAA;AAAA,EACR,QAAU,EAAA,CAAA;AAAA,EACV,MAAQ,EAAA;AACV,CAAA;AAUO,SAAS,aACd,CAAA,QAAA,EACA,OACA,EAAA,QAAA,EACA,QAC8B,EAAA;AAC9B,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,iBAAA,EAAoB,QAAQ,CAAA,CAAA,EAAI,qBAAqB,OAAO,CAAC,CAAI,CAAA,EAAA,mBAAA,CAAoB,QAAQ,CAAC,CAAI,CAAA,EAAA,iBAAA,CAAkB,QAAQ,CAAC,CAAA;AAAA,GACrI;AACF;;;ACpCO,SAAS,mBAAmB,QAAiE,EAAA;AAClG,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,8BAAA,EAAiC,eAAgB,CAAA,QAAQ,CAAC,CAAA;AAAA,GAClE;AACF;AAQO,SAAS,YAAA,CAAa,UAA2B,QAAqC,EAAA;AAC3F,EAAO,OAAA;AAAA,IACL,MAAM,CAAsB,mBAAA,EAAA,eAAA,CAAgB,QAAQ,CAAC,IAAI,QAAQ,CAAA;AAAA,GACnE;AACF;AASO,SAAS,aAAA,CACd,QACA,EAAA,OAAA,EACA,SACiC,EAAA;AACjC,EAAO,OAAA;AAAA,IACL,IAAA,EAAM,uBAAuB,eAAgB,CAAA,QAAQ,CAAC,CAAI,CAAA,EAAA,OAAO,IAAI,SAAS,CAAA,QAAA;AAAA,GAChF;AACF;AASO,SAAS,kBAAA,CACd,QACA,EAAA,OAAA,EACA,SACsC,EAAA;AACtC,EAAO,OAAA;AAAA,IACL,IAAA,EAAM,uBAAuB,eAAgB,CAAA,QAAQ,CAAC,CAAI,CAAA,EAAA,OAAO,IAAI,SAAS,CAAA,QAAA;AAAA,GAChF;AACF;AASO,SAAS,aAAA,CACd,QACA,EAAA,OAAA,EACA,SACiC,EAAA;AACjC,EAAO,OAAA;AAAA,IACL,IAAA,EAAM,uBAAuB,eAAgB,CAAA,QAAQ,CAAC,CAAI,CAAA,EAAA,OAAO,IAAI,SAAS,CAAA;AAAA,GAChF;AACF;AAOO,SAAS,cAAc,QAA4D,EAAA;AACxF,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,yBAAA,EAA4B,eAAgB,CAAA,QAAQ,CAAC,CAAA;AAAA,GAC7D;AACF;;;ACjFO,SAAS,MACd,CAAA,QAAA,EACA,OACA,EAAA,SAAA,EACA,QAC0B,EAAA;AAC1B,EAAO,OAAA;AAAA,IACL,IAAA,EAAM,CAAgB,aAAA,EAAA,eAAA,CAAgB,QAAQ,CAAC,IAAI,OAAO,CAAA,CAAA,EAAI,SAAS,CAAA,QAAA,EAAW,QAAQ,CAAA;AAAA,GAC5F;AACF;AASO,SAAS,aAAA,CACd,QACA,EAAA,OAAA,EACA,SACiC,EAAA;AACjC,EAAO,OAAA;AAAA,IACL,IAAA,EAAM,gBAAgB,eAAgB,CAAA,QAAQ,CAAC,CAAI,CAAA,EAAA,OAAO,IAAI,SAAS,CAAA,eAAA;AAAA,GACzE;AACF;AASO,SAAS,QAAA,CAAS,QAA2B,EAAA,OAAA,EAAgB,SAA+C,EAAA;AACjH,EAAO,OAAA;AAAA,IACL,IAAA,EAAM,yBAAyB,eAAgB,CAAA,QAAQ,CAAC,CAAI,CAAA,EAAA,OAAO,IAAI,SAAS,CAAA;AAAA,GAClF;AACF;AASO,SAAS,OAAA,CAAQ,QAA2B,EAAA,OAAA,EAAgB,SAA+C,EAAA;AAChH,EAAO,OAAA;AAAA,IACL,IAAA,EAAM,gBAAgB,eAAgB,CAAA,QAAQ,CAAC,CAAI,CAAA,EAAA,OAAO,IAAI,SAAS,CAAA;AAAA,GACzE;AACF;AAOO,SAAS,cAAc,QAA4D,EAAA;AACxF,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,oBAAA,EAAuB,eAAgB,CAAA,QAAQ,CAAC,CAAA;AAAA,GACxD;AACF;;;AC9DA,IAAM,GAAM,GAAA;AAAA;AAAA,EAEV,MAAA;AAAA;AAAA,EAEA,sBAAA;AAAA,EACA,MAAA;AAAA;AAAA,EAEA,aAAA;AAAA;AAAA,EAEA,kBAAA;AAAA,EACA,YAAA;AAAA,EACA,aAAA;AAAA,EACA,kBAAA;AAAA,EACA,aAAA;AAAA,EACA,aAAA;AAAA;AAAA,EAEA,MAAA;AAAA,EACA,aAAA;AAAA,EACA,QAAA;AAAA,EACA,OAAA;AAAA,EACA;AACF;AACA,IAAO,WAAQ,GAAA","file":"index.js","sourcesContent":["import type { Resource } from '@blizzard-api/core';\r\n\r\n/**\r\n * Returns the player information for the specified account ID.\r\n * @param accountId The account ID\r\n * @returns The player resource. See {@link Resource}.\r\n */\r\nexport function player(accountId: string): Resource<Array<unknown>> {\r\n  return {\r\n    path: `/sc2/player/${accountId}`,\r\n  };\r\n}\r\n","/**\r\n * Base interface for Blizzard API responses.\r\n */\r\nexport interface ResponseBase {\r\n  _links: {\r\n    self: {\r\n      href: string;\r\n    };\r\n  };\r\n}\r\n\r\n//The region (1=US, 2=EU, 3=KO and TW, 5=CN).\r\nexport type StarcraftRegion = 'cn' | 'eu' | 'kr' | 'tw' | 'us';\r\n\r\nexport const starcraftRegion: Record<StarcraftRegion, number> = {\r\n  cn: 5,\r\n  eu: 2,\r\n  kr: 3,\r\n  tw: 3,\r\n  us: 1,\r\n};\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { starcraftRegion, type StarcraftRegion } from '../base';\r\nimport type { GrandmasterLeaderboardResponse, SeasonResponse } from './types';\r\n\r\n/**\r\n * Returns the grandmaster leaderboard for the specified region.\r\n * @param regionId The region ID\r\n * @returns The grandmaster leaderboard resource. See {@link GrandmasterLeaderboardResponse}.\r\n */\r\nexport function grandmasterLeaderboard(regionId: StarcraftRegion): Resource<GrandmasterLeaderboardResponse> {\r\n  return {\r\n    path: `/sc2/ladder/grandmaster/${starcraftRegion[regionId]}`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the season information for the specified region.\r\n * @param regionId The region ID\r\n * @returns The season resource. See {@link SeasonResponse}.\r\n */\r\nexport function season(regionId: StarcraftRegion): Resource<SeasonResponse> {\r\n  return {\r\n    path: `/sc2/ladder/season/${starcraftRegion[regionId]}`,\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport type { LeagueDataResponse, StarcraftLeagueId, StarcraftLeagueQueue, StarcraftLeagueTeamType } from './types';\r\n\r\nconst starcraftLeagueQueue: Record<StarcraftLeagueQueue, number> = {\r\n  'hots-1v1': 101,\r\n  'hots-2v2': 102,\r\n  'hots-3v3': 103,\r\n  'hots-4v4': 104,\r\n  'lotv-1v1': 201,\r\n  'lotv-2v2': 202,\r\n  'lotv-3v3': 203,\r\n  'lotv-4v4': 204,\r\n  'lotv-archon': 206,\r\n  'wol-1v1': 1,\r\n  'wol-2v2': 2,\r\n  'wol-3v3': 3,\r\n  'wol-4v4': 4,\r\n};\r\n\r\nconst starcraftLeagueTeam: Record<StarcraftLeagueTeamType, number> = {\r\n  arranged: 0,\r\n  random: 1,\r\n};\r\n\r\nconst starcraftLeagueId: Record<StarcraftLeagueId, number> = {\r\n  bronze: 0,\r\n  diamond: 4,\r\n  gold: 2,\r\n  grandmaster: 6,\r\n  master: 5,\r\n  platinum: 3,\r\n  silver: 1,\r\n};\r\n\r\n/**\r\n * Returns the league data for the specified season, queue, team type, and league.\r\n * @param seasonId The season ID\r\n * @param queueId The queue ID\r\n * @param teamType The team type\r\n * @param leagueId The league ID\r\n * @returns The league data resource. See {@link LeagueDataResponse}.\r\n */\r\nexport function getLeagueData(\r\n  seasonId: string,\r\n  queueId: StarcraftLeagueQueue,\r\n  teamType: StarcraftLeagueTeamType,\r\n  leagueId: StarcraftLeagueId,\r\n): Resource<LeagueDataResponse> {\r\n  return {\r\n    path: `/data/sc2/league/${seasonId}/${starcraftLeagueQueue[queueId]}/${starcraftLeagueTeam[teamType]}/${starcraftLeagueId[leagueId]}`,\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { starcraftRegion, type StarcraftRegion } from '../base';\r\nimport type {\r\n  LegacyAchievementsResponse,\r\n  LegacyLaddersResponse,\r\n  LegacyMatchHistoryResponse,\r\n  LegacyProfileResponse,\r\n  LegacyRewardsResponse,\r\n} from './types';\r\n\r\n/**\r\n * Returns the legacy achievements for the specified region.\r\n * @param regionId The region ID for Starcraft.\r\n * @returns A resource representing the legacy achievements. See {@link LegacyAchievementsResponse}\r\n */\r\nexport function legacyAchievements(regionId: StarcraftRegion): Resource<LegacyAchievementsResponse> {\r\n  return {\r\n    path: `/sc2/legacy/data/achievements/${starcraftRegion[regionId]}`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the ladder information for the specified ladder.\r\n * @param regionId The region ID for Starcraft.\r\n * @param ladderId The ID of the ladder.\r\n * @returns A resource representing the ladder. See {@link LadderResponse}\r\n */\r\nexport function legacyLadder(regionId: StarcraftRegion, ladderId: number): Resource<unknown> {\r\n  return {\r\n    path: `/sc2/legacy/ladder/${starcraftRegion[regionId]}/${ladderId}`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the ladders for the specified profile.\r\n * @param regionId The region ID for Starcraft.\r\n * @param realmId 1 or 2\r\n * @param profileId The ID of the profile.\r\n * @returns A resource representing the ladders for the given profile. See {@link LegacyLaddersResponse}\r\n */\r\nexport function legacyLadders(\r\n  regionId: StarcraftRegion,\r\n  realmId: 1 | 2,\r\n  profileId: number,\r\n): Resource<LegacyLaddersResponse> {\r\n  return {\r\n    path: `/sc2/legacy/profile/${starcraftRegion[regionId]}/${realmId}/${profileId}/ladders`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the match history for the specified profile.\r\n * @param regionId The region ID for Starcraft.\r\n * @param realmId 1 or 2\r\n * @param profileId The ID of the profile.\r\n * @returns A resource representing the match history for the given profile. See {@link LegacyMatchHistoryResponse}\r\n */\r\nexport function legacyMatchHistory(\r\n  regionId: StarcraftRegion,\r\n  realmId: 1 | 2,\r\n  profileId: number,\r\n): Resource<LegacyMatchHistoryResponse> {\r\n  return {\r\n    path: `/sc2/legacy/profile/${starcraftRegion[regionId]}/${realmId}/${profileId}/matches`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the profile for the specified profile.\r\n * @param regionId The region ID for Starcraft.\r\n * @param realmId 1 or 2\r\n * @param profileId The ID of the profile.\r\n * @returns A resource representing the profile for the given ID. See {@link LegacyProfileResponse}\r\n */\r\nexport function legacyProfile(\r\n  regionId: StarcraftRegion,\r\n  realmId: 1 | 2,\r\n  profileId: number,\r\n): Resource<LegacyProfileResponse> {\r\n  return {\r\n    path: `/sc2/legacy/profile/${starcraftRegion[regionId]}/${realmId}/${profileId}`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the rewards for the specified region.\r\n * @param regionId The region ID for Starcraft.\r\n * @returns A resource representing the rewards for the given region. See {@link LegacyRewardsResponse}\r\n */\r\nexport function legacyRewards(regionId: StarcraftRegion): Resource<LegacyRewardsResponse> {\r\n  return {\r\n    path: `/sc2/legacy/data/rewards/${starcraftRegion[regionId]}`,\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { starcraftRegion, type StarcraftRegion } from '../base';\r\nimport type { LadderResponse, LadderSummaryResponse, MetadataResponse, StaticProfileResponse } from './types';\r\n\r\n/**\r\n * Returns the ladder information for the specified profile and ladder.\r\n * @param regionId The region ID for Starcraft.\r\n * @param realmId 1 or 2\r\n * @param profileId The ID of the profile.\r\n * @param ladderId The ID of the ladder.\r\n * @returns A resource representing the ladder. See {@link LadderResponse}\r\n */\r\nexport function ladder(\r\n  regionId: StarcraftRegion,\r\n  realmId: 1 | 2,\r\n  profileId: number,\r\n  ladderId: number,\r\n): Resource<LadderResponse> {\r\n  return {\r\n    path: `/sc2/profile/${starcraftRegion[regionId]}/${realmId}/${profileId}/ladder/${ladderId}`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the ladder summary information for the specified profile.\r\n * @param regionId The region ID for Starcraft.\r\n * @param realmId 1 or 2\r\n * @param profileId The ID of the profile.\r\n * @returns A resource representing the ladder summary. See {@link LadderSummaryResponse}\r\n */\r\nexport function ladderSummary(\r\n  regionId: StarcraftRegion,\r\n  realmId: 1 | 2,\r\n  profileId: number,\r\n): Resource<LadderSummaryResponse> {\r\n  return {\r\n    path: `/sc2/profile/${starcraftRegion[regionId]}/${realmId}/${profileId}/ladder/summary`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the metadata information for the specified profile.\r\n * @param regionId The region ID for Starcraft.\r\n * @param realmId 1 or 2\r\n * @param profileId The ID of the profile.\r\n * @returns A resource representing the metadata. See {@link MetadataResponse}\r\n */\r\nexport function metadata(regionId: StarcraftRegion, realmId: 1 | 2, profileId: number): Resource<MetadataResponse> {\r\n  return {\r\n    path: `/sc2/metadata/profile/${starcraftRegion[regionId]}/${realmId}/${profileId}`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the profile information for the specified profile.\r\n * @param regionId The region ID for Starcraft.\r\n * @param realmId 1 or 2\r\n * @param profileId The ID of the profile.\r\n * @returns A resource representing the profile. See {@link MetadataResponse}\r\n */\r\nexport function profile(regionId: StarcraftRegion, realmId: 1 | 2, profileId: number): Resource<MetadataResponse> {\r\n  return {\r\n    path: `/sc2/profile/${starcraftRegion[regionId]}/${realmId}/${profileId}`,\r\n  };\r\n}\r\n\r\n/**\r\n *\r\n * @param regionId The region ID for Starcraft.\r\n * @returns A resource representing the static profile. See {@link StaticProfileResponse}\r\n */\r\nexport function staticProfile(regionId: StarcraftRegion): Resource<StaticProfileResponse> {\r\n  return {\r\n    path: `/sc2/static/profile/${starcraftRegion[regionId]}`,\r\n  };\r\n}\r\n","import { player } from './account/account';\r\nimport { grandmasterLeaderboard, season } from './ladder/ladder';\r\nimport { getLeagueData } from './league/league';\r\nimport {\r\n  legacyAchievements,\r\n  legacyLadder,\r\n  legacyLadders,\r\n  legacyMatchHistory,\r\n  legacyProfile,\r\n  legacyRewards,\r\n} from './legacy/legacy';\r\nimport { ladder, ladderSummary, metadata, profile, staticProfile } from './profile/profile';\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/account';\r\n//Ladder\r\nexport * from './ladder/ladder';\r\nexport type * from './ladder/types';\r\n//League\r\nexport * from './league/league';\r\nexport type * from './league/types';\r\n//Legacy\r\nexport * from './legacy/legacy';\r\nexport type * from './legacy/types';\r\n//Profile\r\nexport * from './profile/profile';\r\nexport type * from './profile/types';\r\n"]}
+{"version":3,"file":"index.js","names":["accountId: string","starcraftRegion: Record<StarcraftRegion, number>","regionId: StarcraftRegion","starcraftLeagueQueue: Record<StarcraftLeagueQueue, number>","starcraftLeagueTeam: Record<StarcraftLeagueTeamType, number>","starcraftLeagueId: Record<StarcraftLeagueId, number>","seasonId: string","queueId: StarcraftLeagueQueue","teamType: StarcraftLeagueTeamType","leagueId: StarcraftLeagueId","regionId: StarcraftRegion","ladderId: number","realmId: 1 | 2","profileId: number","regionId: StarcraftRegion","realmId: 1 | 2","profileId: number","ladderId: number"],"sources":["../src/account/account.ts","../src/base.ts","../src/ladder/ladder.ts","../src/league/league.ts","../src/legacy/legacy.ts","../src/profile/profile.ts","../src/index.ts"],"sourcesContent":["import type { Resource } from '@blizzard-api/core';\r\n\r\n/**\r\n * Returns the player information for the specified account ID.\r\n * @param accountId The account ID\r\n * @returns The player resource. See {@link Resource}.\r\n */\r\nexport function player(accountId: string): Resource<Array<unknown>> {\r\n  return {\r\n    path: `/sc2/player/${accountId}`,\r\n  };\r\n}\r\n","/**\r\n * Base interface for Blizzard API responses.\r\n */\r\nexport interface ResponseBase {\r\n  _links: {\r\n    self: {\r\n      href: string;\r\n    };\r\n  };\r\n}\r\n\r\n//The region (1=US, 2=EU, 3=KO and TW, 5=CN).\r\nexport type StarcraftRegion = 'cn' | 'eu' | 'kr' | 'tw' | 'us';\r\n\r\nexport const starcraftRegion: Record<StarcraftRegion, number> = {\r\n  cn: 5,\r\n  eu: 2,\r\n  kr: 3,\r\n  tw: 3,\r\n  us: 1,\r\n};\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { starcraftRegion, type StarcraftRegion } from '../base';\r\nimport type { GrandmasterLeaderboardResponse, SeasonResponse } from './types';\r\n\r\n/**\r\n * Returns the grandmaster leaderboard for the specified region.\r\n * @param regionId The region ID\r\n * @returns The grandmaster leaderboard resource. See {@link GrandmasterLeaderboardResponse}.\r\n */\r\nexport function grandmasterLeaderboard(regionId: StarcraftRegion): Resource<GrandmasterLeaderboardResponse> {\r\n  return {\r\n    path: `/sc2/ladder/grandmaster/${starcraftRegion[regionId]}`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the season information for the specified region.\r\n * @param regionId The region ID\r\n * @returns The season resource. See {@link SeasonResponse}.\r\n */\r\nexport function season(regionId: StarcraftRegion): Resource<SeasonResponse> {\r\n  return {\r\n    path: `/sc2/ladder/season/${starcraftRegion[regionId]}`,\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport type { LeagueDataResponse, StarcraftLeagueId, StarcraftLeagueQueue, StarcraftLeagueTeamType } from './types';\r\n\r\nconst starcraftLeagueQueue: Record<StarcraftLeagueQueue, number> = {\r\n  'hots-1v1': 101,\r\n  'hots-2v2': 102,\r\n  'hots-3v3': 103,\r\n  'hots-4v4': 104,\r\n  'lotv-1v1': 201,\r\n  'lotv-2v2': 202,\r\n  'lotv-3v3': 203,\r\n  'lotv-4v4': 204,\r\n  'lotv-archon': 206,\r\n  'wol-1v1': 1,\r\n  'wol-2v2': 2,\r\n  'wol-3v3': 3,\r\n  'wol-4v4': 4,\r\n};\r\n\r\nconst starcraftLeagueTeam: Record<StarcraftLeagueTeamType, number> = {\r\n  arranged: 0,\r\n  random: 1,\r\n};\r\n\r\nconst starcraftLeagueId: Record<StarcraftLeagueId, number> = {\r\n  bronze: 0,\r\n  diamond: 4,\r\n  gold: 2,\r\n  grandmaster: 6,\r\n  master: 5,\r\n  platinum: 3,\r\n  silver: 1,\r\n};\r\n\r\n/**\r\n * Returns the league data for the specified season, queue, team type, and league.\r\n * @param seasonId The season ID\r\n * @param queueId The queue ID\r\n * @param teamType The team type\r\n * @param leagueId The league ID\r\n * @returns The league data resource. See {@link LeagueDataResponse}.\r\n */\r\nexport function getLeagueData(\r\n  seasonId: string,\r\n  queueId: StarcraftLeagueQueue,\r\n  teamType: StarcraftLeagueTeamType,\r\n  leagueId: StarcraftLeagueId,\r\n): Resource<LeagueDataResponse> {\r\n  return {\r\n    path: `/data/sc2/league/${seasonId}/${starcraftLeagueQueue[queueId]}/${starcraftLeagueTeam[teamType]}/${starcraftLeagueId[leagueId]}`,\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { starcraftRegion, type StarcraftRegion } from '../base';\r\nimport type {\r\n  LegacyAchievementsResponse,\r\n  LegacyLaddersResponse,\r\n  LegacyMatchHistoryResponse,\r\n  LegacyProfileResponse,\r\n  LegacyRewardsResponse,\r\n} from './types';\r\n\r\n/**\r\n * Returns the legacy achievements for the specified region.\r\n * @param regionId The region ID for Starcraft.\r\n * @returns A resource representing the legacy achievements. See {@link LegacyAchievementsResponse}\r\n */\r\nexport function legacyAchievements(regionId: StarcraftRegion): Resource<LegacyAchievementsResponse> {\r\n  return {\r\n    path: `/sc2/legacy/data/achievements/${starcraftRegion[regionId]}`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the ladder information for the specified ladder.\r\n * @param regionId The region ID for Starcraft.\r\n * @param ladderId The ID of the ladder.\r\n * @returns A resource representing the ladder. See {@link LadderResponse}\r\n */\r\nexport function legacyLadder(regionId: StarcraftRegion, ladderId: number): Resource<unknown> {\r\n  return {\r\n    path: `/sc2/legacy/ladder/${starcraftRegion[regionId]}/${ladderId}`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the ladders for the specified profile.\r\n * @param regionId The region ID for Starcraft.\r\n * @param realmId 1 or 2\r\n * @param profileId The ID of the profile.\r\n * @returns A resource representing the ladders for the given profile. See {@link LegacyLaddersResponse}\r\n */\r\nexport function legacyLadders(\r\n  regionId: StarcraftRegion,\r\n  realmId: 1 | 2,\r\n  profileId: number,\r\n): Resource<LegacyLaddersResponse> {\r\n  return {\r\n    path: `/sc2/legacy/profile/${starcraftRegion[regionId]}/${realmId}/${profileId}/ladders`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the match history for the specified profile.\r\n * @param regionId The region ID for Starcraft.\r\n * @param realmId 1 or 2\r\n * @param profileId The ID of the profile.\r\n * @returns A resource representing the match history for the given profile. See {@link LegacyMatchHistoryResponse}\r\n */\r\nexport function legacyMatchHistory(\r\n  regionId: StarcraftRegion,\r\n  realmId: 1 | 2,\r\n  profileId: number,\r\n): Resource<LegacyMatchHistoryResponse> {\r\n  return {\r\n    path: `/sc2/legacy/profile/${starcraftRegion[regionId]}/${realmId}/${profileId}/matches`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the profile for the specified profile.\r\n * @param regionId The region ID for Starcraft.\r\n * @param realmId 1 or 2\r\n * @param profileId The ID of the profile.\r\n * @returns A resource representing the profile for the given ID. See {@link LegacyProfileResponse}\r\n */\r\nexport function legacyProfile(\r\n  regionId: StarcraftRegion,\r\n  realmId: 1 | 2,\r\n  profileId: number,\r\n): Resource<LegacyProfileResponse> {\r\n  return {\r\n    path: `/sc2/legacy/profile/${starcraftRegion[regionId]}/${realmId}/${profileId}`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the rewards for the specified region.\r\n * @param regionId The region ID for Starcraft.\r\n * @returns A resource representing the rewards for the given region. See {@link LegacyRewardsResponse}\r\n */\r\nexport function legacyRewards(regionId: StarcraftRegion): Resource<LegacyRewardsResponse> {\r\n  return {\r\n    path: `/sc2/legacy/data/rewards/${starcraftRegion[regionId]}`,\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { starcraftRegion, type StarcraftRegion } from '../base';\r\nimport type { LadderResponse, LadderSummaryResponse, MetadataResponse, StaticProfileResponse } from './types';\r\n\r\n/**\r\n * Returns the ladder information for the specified profile and ladder.\r\n * @param regionId The region ID for Starcraft.\r\n * @param realmId 1 or 2\r\n * @param profileId The ID of the profile.\r\n * @param ladderId The ID of the ladder.\r\n * @returns A resource representing the ladder. See {@link LadderResponse}\r\n */\r\nexport function ladder(\r\n  regionId: StarcraftRegion,\r\n  realmId: 1 | 2,\r\n  profileId: number,\r\n  ladderId: number,\r\n): Resource<LadderResponse> {\r\n  return {\r\n    path: `/sc2/profile/${starcraftRegion[regionId]}/${realmId}/${profileId}/ladder/${ladderId}`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the ladder summary information for the specified profile.\r\n * @param regionId The region ID for Starcraft.\r\n * @param realmId 1 or 2\r\n * @param profileId The ID of the profile.\r\n * @returns A resource representing the ladder summary. See {@link LadderSummaryResponse}\r\n */\r\nexport function ladderSummary(\r\n  regionId: StarcraftRegion,\r\n  realmId: 1 | 2,\r\n  profileId: number,\r\n): Resource<LadderSummaryResponse> {\r\n  return {\r\n    path: `/sc2/profile/${starcraftRegion[regionId]}/${realmId}/${profileId}/ladder/summary`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the metadata information for the specified profile.\r\n * @param regionId The region ID for Starcraft.\r\n * @param realmId 1 or 2\r\n * @param profileId The ID of the profile.\r\n * @returns A resource representing the metadata. See {@link MetadataResponse}\r\n */\r\nexport function metadata(regionId: StarcraftRegion, realmId: 1 | 2, profileId: number): Resource<MetadataResponse> {\r\n  return {\r\n    path: `/sc2/metadata/profile/${starcraftRegion[regionId]}/${realmId}/${profileId}`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the profile information for the specified profile.\r\n * @param regionId The region ID for Starcraft.\r\n * @param realmId 1 or 2\r\n * @param profileId The ID of the profile.\r\n * @returns A resource representing the profile. See {@link MetadataResponse}\r\n */\r\nexport function profile(regionId: StarcraftRegion, realmId: 1 | 2, profileId: number): Resource<MetadataResponse> {\r\n  return {\r\n    path: `/sc2/profile/${starcraftRegion[regionId]}/${realmId}/${profileId}`,\r\n  };\r\n}\r\n\r\n/**\r\n *\r\n * @param regionId The region ID for Starcraft.\r\n * @returns A resource representing the static profile. See {@link StaticProfileResponse}\r\n */\r\nexport function staticProfile(regionId: StarcraftRegion): Resource<StaticProfileResponse> {\r\n  return {\r\n    path: `/sc2/static/profile/${starcraftRegion[regionId]}`,\r\n  };\r\n}\r\n","import { player } from './account/account';\r\nimport { grandmasterLeaderboard, season } from './ladder/ladder';\r\nimport { getLeagueData } from './league/league';\r\nimport {\r\n  legacyAchievements,\r\n  legacyLadder,\r\n  legacyLadders,\r\n  legacyMatchHistory,\r\n  legacyProfile,\r\n  legacyRewards,\r\n} from './legacy/legacy';\r\nimport { ladder, ladderSummary, metadata, profile, staticProfile } from './profile/profile';\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/account';\r\n//Ladder\r\nexport * from './ladder/ladder';\r\nexport type * from './ladder/types';\r\n//League\r\nexport * from './league/league';\r\nexport type * from './league/types';\r\n//Legacy\r\nexport * from './legacy/legacy';\r\nexport type * from './legacy/types';\r\n//Profile\r\nexport * from './profile/profile';\r\nexport type * from './profile/types';\r\n"],"mappings":";;;;;;;;;;AAOA,SAAgB,OAAOA,WAA6C;AAClE,QAAO,EACL,OAAO,cAAc,UAAU,EAChC;AACF;;;;ACGD,MAAaC,kBAAmD;CAC9D,IAAI;CACJ,IAAI;CACJ,IAAI;CACJ,IAAI;CACJ,IAAI;AACL;;;;;;;;;;;;;ACXD,SAAgB,uBAAuBC,UAAqE;AAC1G,QAAO,EACL,OAAO,0BAA0B,gBAAgB,UAAU,EAC5D;AACF;;;;;;;;;;AAOD,SAAgB,OAAOA,UAAqD;AAC1E,QAAO,EACL,OAAO,qBAAqB,gBAAgB,UAAU,EACvD;AACF;;;;ACrBD,MAAMC,uBAA6D;CACjE,YAAY;CACZ,YAAY;CACZ,YAAY;CACZ,YAAY;CACZ,YAAY;CACZ,YAAY;CACZ,YAAY;CACZ,YAAY;CACZ,eAAe;CACf,WAAW;CACX,WAAW;CACX,WAAW;CACX,WAAW;AACZ;AAED,MAAMC,sBAA+D;CACnE,UAAU;CACV,QAAQ;AACT;AAED,MAAMC,oBAAuD;CAC3D,QAAQ;CACR,SAAS;CACT,MAAM;CACN,aAAa;CACb,QAAQ;CACR,UAAU;CACV,QAAQ;AACT;;;;;;;;;;;;;;;;AAUD,SAAgB,cACdC,UACAC,SACAC,UACAC,UAC8B;AAC9B,QAAO,EACL,OAAO,mBAAmB,SAAS,GAAG,qBAAqB,SAAS,GAAG,oBAAoB,UAAU,GAAG,kBAAkB,UAAU,EACrI;AACF;;;;;;;;;;;;;ACpCD,SAAgB,mBAAmBC,UAAiE;AAClG,QAAO,EACL,OAAO,gCAAgC,gBAAgB,UAAU,EAClE;AACF;;;;;;;;;;;;AAQD,SAAgB,aAAaA,UAA2BC,UAAqC;AAC3F,QAAO,EACL,OAAO,qBAAqB,gBAAgB,UAAU,GAAG,SAAS,EACnE;AACF;;;;;;;;;;;;;;AASD,SAAgB,cACdD,UACAE,SACAC,WACiC;AACjC,QAAO,EACL,OAAO,sBAAsB,gBAAgB,UAAU,GAAG,QAAQ,GAAG,UAAU,UAChF;AACF;;;;;;;;;;;;;;AASD,SAAgB,mBACdH,UACAE,SACAC,WACsC;AACtC,QAAO,EACL,OAAO,sBAAsB,gBAAgB,UAAU,GAAG,QAAQ,GAAG,UAAU,UAChF;AACF;;;;;;;;;;;;;;AASD,SAAgB,cACdH,UACAE,SACAC,WACiC;AACjC,QAAO,EACL,OAAO,sBAAsB,gBAAgB,UAAU,GAAG,QAAQ,GAAG,UAAU,EAChF;AACF;;;;;;;;;;AAOD,SAAgB,cAAcH,UAA4D;AACxF,QAAO,EACL,OAAO,2BAA2B,gBAAgB,UAAU,EAC7D;AACF;;;;;;;;;;;;;;;;;;;ACjFD,SAAgB,OACdI,UACAC,SACAC,WACAC,UAC0B;AAC1B,QAAO,EACL,OAAO,eAAe,gBAAgB,UAAU,GAAG,QAAQ,GAAG,UAAU,UAAU,SAAS,EAC5F;AACF;;;;;;;;;;;;;;AASD,SAAgB,cACdH,UACAC,SACAC,WACiC;AACjC,QAAO,EACL,OAAO,eAAe,gBAAgB,UAAU,GAAG,QAAQ,GAAG,UAAU,iBACzE;AACF;;;;;;;;;;;;;;AASD,SAAgB,SAASF,UAA2BC,SAAgBC,WAA+C;AACjH,QAAO,EACL,OAAO,wBAAwB,gBAAgB,UAAU,GAAG,QAAQ,GAAG,UAAU,EAClF;AACF;;;;;;;;;;;;;;AASD,SAAgB,QAAQF,UAA2BC,SAAgBC,WAA+C;AAChH,QAAO,EACL,OAAO,eAAe,gBAAgB,UAAU,GAAG,QAAQ,GAAG,UAAU,EACzE;AACF;;;;;;;;;;AAOD,SAAgB,cAAcF,UAA4D;AACxF,QAAO,EACL,OAAO,sBAAsB,gBAAgB,UAAU,EACxD;AACF;;;;AC9DD,MAAM,MAAM;CAEV;CAEA;CACA;CAEA;CAEA;CACA;CACA;CACA;CACA;CACA;CAEA;CACA;CACA;CACA;CACA;AACD;AACD,kBAAe"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blizzard-api/sc2",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "license": "MIT",
   "author": "Putro",
   "description": "A series of helpers to interact with the Starcraft II Blizzard API",
@@ -32,14 +32,14 @@
   ],
   "dependencies": {},
   "peerDependencies": {
-    "@blizzard-api/core": "2.1.0"
+    "@blizzard-api/core": "2.1.1"
   },
   "devDependencies": {
-    "@blizzard-api/core": "2.1.0"
+    "@blizzard-api/core": "2.1.1"
   },
   "scripts": {
-    "build": "tsup",
-    "dev": "tsup --watch",
+    "build": "tsdown",
+    "dev": "tsdown --watch",
     "test": "vitest run",
     "test:coverage": "pnpm test -- --coverage",
     "test:watch": "vitest watch"