@blizzard-api/sc2 1.0.1 → 1.0.2

package/dist/index.d.ts

@@ -1,5 +1,10 @@
 import { Resource } from '@blizzard-api/core';
 
+/**
+ * Returns the player information for the specified account ID.
+ * @param accountId The account ID
+ * @returns The player resource. See {@link Resource}.
+ */
 declare function player(accountId: string): Resource<Array<unknown>>;
 
 /**
@@ -42,7 +47,17 @@ interface TeamMember {
     region: number;
 }
 
+/**
+ * Returns the grandmaster leaderboard for the specified region.
+ * @param regionId The region ID
+ * @returns The grandmaster leaderboard resource. See {@link GrandmasterLeaderboardResponse}.
+ */
 declare function grandmasterLeaderboard(regionId: StarcraftRegion): Resource<GrandmasterLeaderboardResponse>;
+/**
+ * Returns the season information for the specified region.
+ * @param regionId The region ID
+ * @returns The season resource. See {@link SeasonResponse}.
+ */
 declare function season(regionId: StarcraftRegion): Resource<SeasonResponse>;
 
 interface LeagueDataResponse extends ResponseBase {
@@ -68,6 +83,14 @@ interface Tier {
     id: number;
 }
 
+/**
+ * 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}.
+ */
 declare function getLeagueData(seasonId: string, queueId: StarcraftLeagueQueue, teamType: StarcraftLeagueTeamType, leagueId: StarcraftLeagueId): Resource<LeagueDataResponse>;
 
 interface LegacyAchievementsResponse {
@@ -195,11 +218,48 @@ interface SwarmLevelsByRace {
     totalLevelXP: number;
 }
 
+/**
+ * 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}
+ */
 declare function legacyAchievements(regionId: StarcraftRegion): Resource<LegacyAchievementsResponse>;
+/**
+ * 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}
+ */
 declare function legacyLadder(regionId: StarcraftRegion, ladderId: number): Resource<unknown>;
+/**
+ * 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}
+ */
 declare function legacyLadders(regionId: StarcraftRegion, realmId: 1 | 2, profileId: number): Resource<LegacyLaddersResponse>;
+/**
+ * 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}
+ */
 declare function legacyMatchHistory(regionId: StarcraftRegion, realmId: 1 | 2, profileId: number): Resource<LegacyMatchHistoryResponse>;
+/**
+ * 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}
+ */
 declare function legacyProfile(regionId: StarcraftRegion, realmId: 1 | 2, profileId: number): Resource<LegacyProfileResponse>;
+/**
+ * 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}
+ */
 declare function legacyRewards(regionId: StarcraftRegion): Resource<LegacyRewardsResponse>;
 
 interface LadderResponse {
@@ -271,10 +331,44 @@ interface Reward {
     unlockableType: string;
 }
 
+/**
+ * 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}
+ */
 declare function ladder(regionId: StarcraftRegion, realmId: 1 | 2, profileId: number, ladderId: number): Resource<LadderResponse>;
+/**
+ * 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}
+ */
 declare function ladderSummary(regionId: StarcraftRegion, realmId: 1 | 2, profileId: number): Resource<LadderSummaryResponse>;
+/**
+ * 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}
+ */
 declare function metadata(regionId: StarcraftRegion, realmId: 1 | 2, profileId: number): Resource<MetadataResponse>;
+/**
+ * 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}
+ */
 declare function profile(regionId: StarcraftRegion, realmId: 1 | 2, profileId: number): Resource<MetadataResponse>;
+/**
+ *
+ * @param regionId The region ID for Starcraft.
+ * @returns A resource representing the static profile. See {@link StaticProfileResponse}
+ */
 declare function staticProfile(regionId: StarcraftRegion): Resource<StaticProfileResponse>;
 
 declare const sc2: {

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":";AAEO,SAAS,OAAO,SAA6C,EAAA;AAClE,EAAO,OAAA;AAAA,IACL,IAAA,EAAM,eAAe,SAAS,CAAA,CAAA;AAAA,GAChC,CAAA;AACF,CAAA;;;ACQO,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,CAAA;AACN,CAAA,CAAA;;;AChBO,SAAS,uBAAuB,QAAqE,EAAA;AAC1G,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,wBAAA,EAA2B,eAAgB,CAAA,QAAQ,CAAC,CAAA,CAAA;AAAA,GAC5D,CAAA;AACF,CAAA;AAEO,SAAS,OAAO,QAAqD,EAAA;AAC1E,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,mBAAA,EAAsB,eAAgB,CAAA,QAAQ,CAAC,CAAA,CAAA;AAAA,GACvD,CAAA;AACF,CAAA;;;ACXA,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,CAAA;AACb,CAAA,CAAA;AAEA,IAAM,mBAA+D,GAAA;AAAA,EACnE,QAAU,EAAA,CAAA;AAAA,EACV,MAAQ,EAAA,CAAA;AACV,CAAA,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,CAAA;AACV,CAAA,CAAA;AAEO,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,CAAA;AAAA,GACrI,CAAA;AACF,CAAA;;;ACjCO,SAAS,mBAAmB,QAAiE,EAAA;AAClG,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,8BAAA,EAAiC,eAAgB,CAAA,QAAQ,CAAC,CAAA,CAAA;AAAA,GAClE,CAAA;AACF,CAAA;AAEO,SAAS,YAAA,CAAa,UAA2B,QAAqC,EAAA;AAC3F,EAAO,OAAA;AAAA,IACL,MAAM,CAAsB,mBAAA,EAAA,eAAA,CAAgB,QAAQ,CAAC,IAAI,QAAQ,CAAA,CAAA;AAAA,GACnE,CAAA;AACF,CAAA;AAEO,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,CAAA;AAAA,GAChF,CAAA;AACF,CAAA;AAEO,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,CAAA;AAAA,GAChF,CAAA;AACF,CAAA;AAEO,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,CAAA;AAAA,GAChF,CAAA;AACF,CAAA;AAEO,SAAS,cAAc,QAA4D,EAAA;AACxF,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,yBAAA,EAA4B,eAAgB,CAAA,QAAQ,CAAC,CAAA,CAAA;AAAA,GAC7D,CAAA;AACF,CAAA;;;ACpDO,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,CAAA;AAAA,GAC5F,CAAA;AACF,CAAA;AAEO,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,CAAA;AAAA,GACzE,CAAA;AACF,CAAA;AAEO,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,CAAA;AAAA,GAClF,CAAA;AACF,CAAA;AAEO,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,CAAA;AAAA,GACzE,CAAA;AACF,CAAA;AAEO,SAAS,cAAc,QAA4D,EAAA;AACxF,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,oBAAA,EAAuB,eAAgB,CAAA,QAAQ,CAAC,CAAA,CAAA;AAAA,GACxD,CAAA;AACF,CAAA;;;AC5BA,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,aAAA;AACF","file":"index.js","sourcesContent":["import type { Resource } from '@blizzard-api/core';\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\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\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\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\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\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\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\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\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\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\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\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\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\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\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 { sc2 as default, 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,"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,CAAA;AAAA,GAChC,CAAA;AACF,CAAA;;;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,CAAA;AACN,CAAA,CAAA;;;ACXO,SAAS,uBAAuB,QAAqE,EAAA;AAC1G,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,wBAAA,EAA2B,eAAgB,CAAA,QAAQ,CAAC,CAAA,CAAA;AAAA,GAC5D,CAAA;AACF,CAAA;AAOO,SAAS,OAAO,QAAqD,EAAA;AAC1E,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,mBAAA,EAAsB,eAAgB,CAAA,QAAQ,CAAC,CAAA,CAAA;AAAA,GACvD,CAAA;AACF,CAAA;;;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,CAAA;AACb,CAAA,CAAA;AAEA,IAAM,mBAA+D,GAAA;AAAA,EACnE,QAAU,EAAA,CAAA;AAAA,EACV,MAAQ,EAAA,CAAA;AACV,CAAA,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,CAAA;AACV,CAAA,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,CAAA;AAAA,GACrI,CAAA;AACF,CAAA;;;ACpCO,SAAS,mBAAmB,QAAiE,EAAA;AAClG,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,8BAAA,EAAiC,eAAgB,CAAA,QAAQ,CAAC,CAAA,CAAA;AAAA,GAClE,CAAA;AACF,CAAA;AAQO,SAAS,YAAA,CAAa,UAA2B,QAAqC,EAAA;AAC3F,EAAO,OAAA;AAAA,IACL,MAAM,CAAsB,mBAAA,EAAA,eAAA,CAAgB,QAAQ,CAAC,IAAI,QAAQ,CAAA,CAAA;AAAA,GACnE,CAAA;AACF,CAAA;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,CAAA;AAAA,GAChF,CAAA;AACF,CAAA;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,CAAA;AAAA,GAChF,CAAA;AACF,CAAA;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,CAAA;AAAA,GAChF,CAAA;AACF,CAAA;AAOO,SAAS,cAAc,QAA4D,EAAA;AACxF,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,yBAAA,EAA4B,eAAgB,CAAA,QAAQ,CAAC,CAAA,CAAA;AAAA,GAC7D,CAAA;AACF,CAAA;;;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,CAAA;AAAA,GAC5F,CAAA;AACF,CAAA;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,CAAA;AAAA,GACzE,CAAA;AACF,CAAA;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,CAAA;AAAA,GAClF,CAAA;AACF,CAAA;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,CAAA;AAAA,GACzE,CAAA;AACF,CAAA;AAOO,SAAS,cAAc,QAA4D,EAAA;AACxF,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,oBAAA,EAAuB,eAAgB,CAAA,QAAQ,CAAC,CAAA,CAAA;AAAA,GACxD,CAAA;AACF,CAAA;;;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,aAAA;AACF","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 { sc2 as default, 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"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blizzard-api/sc2",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "license": "MIT",
   "author": "Putro",
   "description": "A series of helpers to interact with the Starcraft II Blizzard API",
@@ -32,10 +32,10 @@
   ],
   "dependencies": {},
   "peerDependencies": {
-    "@blizzard-api/core": "2.0.1"
+    "@blizzard-api/core": "2.0.2"
   },
   "devDependencies": {
-    "@blizzard-api/core": "2.0.1"
+    "@blizzard-api/core": "2.0.2"
   },
   "scripts": {
     "build": "tsup",