@blizzard-api/d3 1.0.1 → 1.0.3

package/README.md

@@ -70,6 +70,6 @@ const client = await createBlizzardApiClient({
 //Response will automatically be typed with the appropriate values
 const response = await client.sendRequest(d3.commodities());
 
-console.log(response.data);
-                      ^ typeof AuctionHouseCommoditiesResponse
+console.log(response);
+                ^ typeof AuctionHouseCommoditiesResponse
 ```

package/dist/index.d.ts

@@ -21,7 +21,16 @@ interface Quest {
     slug: string;
 }
 
+/**
+ * Returns the act information for the specified act ID.
+ * @param actId The ID of the act.
+ * @returns The act resource. See {@link ActResponse}.
+ */
 declare function act(actId: number): Resource<ActResponse>;
+/**
+ * Returns the index of acts.
+ * @returns The act index resource. See {@link ActIndexResponse}.
+ */
 declare function actIndex(): Resource<ActIndexResponse>;
 
 interface ArtisanResponse {
@@ -66,7 +75,18 @@ interface Training {
     tiers: Array<Tier>;
 }
 
+/**
+ * Returns the artisan information for the specified artisan slug.
+ * @param artisanSlug The slug of the artisan.
+ * @returns The artisan resource. See {@link ArtisanResponse}.
+ */
 declare function artisan(artisanSlug: string): Resource<ArtisanResponse>;
+/**
+ * Returns the recipe information for the specified artisan and recipe slugs.
+ * @param artisanSlug The slug of the artisan.
+ * @param recipeSlug The slug of the recipe.
+ * @returns The recipe resource. See {@link RecipeResponse}.
+ */
 declare function recipe(artisanSlug: string, recipeSlug: string): Resource<RecipeResponse>;
 
 interface CharacterClassResponse {
@@ -105,7 +125,18 @@ interface SkillCategory {
     slug: string;
 }
 
+/**
+ * Returns the character class information for the specified character class slug.
+ * @param characterClassSlug The slug of the character class.
+ * @returns The character class resource. See {@link CharacterClassResponse}.
+ */
 declare function characterClass(characterClassSlug: string): Resource<CharacterClassResponse>;
+/**
+ * Returns the skill information for the specified character class and skill slugs.
+ * @param characterClassSlug The slug of the character class.
+ * @param skillSlug The slug of the skill.
+ * @returns The skill resource. See {@link SkillResponse}.
+ */
 declare function skill(characterClassSlug: string, skillSlug: string): Resource<SkillResponse>;
 
 interface FollowerResponse {
@@ -125,6 +156,11 @@ interface Skill$1 {
     tooltipUrl: string;
 }
 
+/**
+ * Returns the follower information for the specified follower slug.
+ * @param followerSlug The slug of the follower.
+ * @returns The follower resource. See {@link FollowerResponse}.
+ */
 declare function follower(followerSlug: string): Resource<FollowerResponse>;
 
 /**
@@ -232,11 +268,41 @@ interface Self {
     href: string;
 }
 
+/**
+ * Returns the era information for the specified era ID.
+ * @param id The ID of the era.
+ * @returns The era resource. See {@link EraResponse}.
+ */
 declare function era(id: number): Resource<EraResponse>;
+/**
+ * Returns the era index.
+ * @returns The era index resource. See {@link EraIndexResponse}.
+ */
 declare function eraIndex(): Resource<EraIndexResponse>;
+/**
+ * Returns the era leaderboard for the specified era ID and leaderboard.
+ * @param id The ID of the era.
+ * @param leaderboard The name of the leaderboard.
+ * @returns The era leaderboard resource. See {@link EraLeaderboardResponse}.
+ */
 declare function eraLeaderboard(id: number, leaderboard: string): Resource<EraLeaderboardResponse>;
+/**
+ * Returns the season information for the specified season ID.
+ * @param id The ID of the season.
+ * @returns The season resource. See {@link SeasonResponse}.
+ */
 declare function season(id: number): Resource<SeasonResponse>;
+/**
+ * Returns the season index.
+ * @returns The season index resource. See {@link SeasonIndexResponse}.
+ */
 declare function seasonIndex(): Resource<SeasonIndexResponse>;
+/**
+ * Returns the season leaderboard for the specified season ID and leaderboard.
+ * @param id The ID of the season.
+ * @param leaderboard The name of the leaderboard.
+ * @returns The season leaderboard resource. See {@link SeasonLeaderboardResponse}.
+ */
 declare function seasonLeaderboard(id: number, leaderboard: string): Resource<SeasonLeaderboardResponse>;
 
 interface ItemTypeIndexResponse {
@@ -252,7 +318,16 @@ interface ItemTypeResponse {
     slug: string;
 }
 
+/**
+ * Returns the item type information for the specified item type slug.
+ * @param itemTypeSlug The slug of the item type, example: "sword2h"
+ * @returns The item type resource. See {@link ItemTypeResponse}.
+ */
 declare function itemType(itemTypeSlug: string): Resource<Array<ItemTypeResponse>>;
+/**
+ * Returns the item type index.
+ * @returns The item type index resource. See {@link ItemTypeIndexResponse}.
+ */
 declare function itemTypeIndex(): Resource<Array<ItemTypeIndexResponse>>;
 
 interface Attributes$1 {
@@ -296,6 +371,11 @@ interface Type {
     twoHanded: boolean;
 }
 
+/**
+ * Returns the item information for the specified item slug and ID.
+ * @param itemSlugAndId The slug and ID of the item, example: "corrupted-ashbringer-Unique_Sword_2H_104_x1".
+ * @returns The item resource. See {@link ItemResponse}.
+ */
 declare function item(itemSlugAndId: string): Resource<ItemResponse>;
 
 interface AccountHeroFollowerItemsResponse {
@@ -611,9 +691,32 @@ interface TimePlayed {
     wizard: number;
 }
 
+/**
+ * Returns the account information for the specified battle tag.
+ * @param battleTag The battle tag of the account.
+ * @returns The account resource. See {@link AccountResponse}.
+ */
 declare function account(battleTag: string): Resource<AccountResponse>;
+/**
+ * Returns the hero information for the specified battle tag and hero ID.
+ * @param battleTag The battle tag of the account.
+ * @param heroId The ID of the hero.
+ * @returns The hero resource. See {@link AccountHeroResponse}.
+ */
 declare function accountHero(battleTag: string, heroId: number): Resource<AccountHeroResponse>;
+/**
+ * Returns the follower items for the specified battle tag and hero ID.
+ * @param battleTag The battle tag of the account.
+ * @param heroId The ID of the hero.
+ * @returns The follower items resource. See {@link AccountHeroFollowerItemsResponse}.
+ */
 declare function accountHeroFollowerItems(battleTag: string, heroId: number): Resource<AccountHeroFollowerItemsResponse>;
+/**
+ * Returns the items for the specified battle tag and hero ID.
+ * @param battleTag The battle tag of the account.
+ * @param heroId The ID of the hero.
+ * @returns The hero items resource. See {@link AccountHeroResponse}.
+ */
 declare function accountHeroItems(battleTag: string, heroId: number): Resource<AccountHeroResponse>;
 
 declare const d3: {

package/dist/index.js

@@ -150,7 +150,8 @@ var d3 = {
   seasonIndex,
   seasonLeaderboard
 };
+var src_default = d3;
 
-export { account, accountHero, accountHeroFollowerItems, accountHeroItems, act, actIndex, artisan, characterClass, d3, d3 as default, era, eraIndex, eraLeaderboard, follower, item, itemType, itemTypeIndex, recipe, season, seasonIndex, seasonLeaderboard, skill };
+export { account, accountHero, accountHeroFollowerItems, accountHeroItems, act, actIndex, artisan, characterClass, d3, src_default as default, era, eraIndex, eraLeaderboard, follower, item, itemType, itemTypeIndex, recipe, season, seasonIndex, seasonLeaderboard, skill };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/base.ts","../src/act/act.ts","../src/artisan-and-recipe/artisan-and-recipe.ts","../src/character-class-and-skill/character-class-and-skill.ts","../src/follower/follower.ts","../src/game-data/game-data.ts","../src/item-type/item-type.ts","../src/item/item.ts","../src/profile/profile.ts","../src/index.ts"],"names":[],"mappings":";AAAO,IAAM,IAAO,GAAA,SAAA,CAAA;AAEb,IAAM,WAAc,GAAA,CAAA,UAAA,CAAA,CAAA;AAGpB,IAAM,YAAe,GAAA,CAAA,OAAA,CAAA,CAAA;;;ACDrB,SAAS,IAAI,KAAsC,EAAA;AACxD,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,EAAG,IAAI,CAAA,KAAA,EAAQ,KAAK,CAAA,CAAA;AAAA,GAC5B,CAAA;AACF,CAAA;AAEO,SAAS,QAAuC,GAAA;AACrD,EAAO,OAAA;AAAA,IACL,IAAA,EAAM,GAAG,IAAI,CAAA,IAAA,CAAA;AAAA,GACf,CAAA;AACF,CAAA;;;ACVO,SAAS,QAAQ,WAAgD,EAAA;AACtE,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,EAAG,IAAI,CAAA,SAAA,EAAY,WAAW,CAAA,CAAA;AAAA,GACtC,CAAA;AACF,CAAA;AAEO,SAAS,MAAA,CAAO,aAAqB,UAA8C,EAAA;AACxF,EAAO,OAAA;AAAA,IACL,MAAM,CAAG,EAAA,IAAI,CAAY,SAAA,EAAA,WAAW,WAAW,UAAU,CAAA,CAAA;AAAA,GAC3D,CAAA;AACF,CAAA;;;ACVO,SAAS,eAAe,kBAA8D,EAAA;AAC3F,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,EAAG,IAAI,CAAA,iBAAA,EAAoB,kBAAkB,CAAA,CAAA;AAAA,GACrD,CAAA;AACF,CAAA;AAEO,SAAS,KAAA,CAAM,oBAA4B,SAA4C,EAAA;AAC5F,EAAO,OAAA;AAAA,IACL,MAAM,CAAG,EAAA,IAAI,CAAS,MAAA,EAAA,kBAAkB,UAAU,SAAS,CAAA,CAAA;AAAA,GAC7D,CAAA;AACF,CAAA;;;ACVO,SAAS,SAAS,YAAkD,EAAA;AACzE,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,EAAG,IAAI,CAAA,UAAA,EAAa,YAAY,CAAA,CAAA;AAAA,GACxC,CAAA;AACF,CAAA;;;ACGO,SAAS,IAAI,EAAmC,EAAA;AACrD,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,EAAG,YAAY,CAAA,KAAA,EAAQ,EAAE,CAAA,CAAA;AAAA,GACjC,CAAA;AACF,CAAA;AAEO,SAAS,QAAuC,GAAA;AACrD,EAAO,OAAA;AAAA,IACL,IAAA,EAAM,GAAG,YAAY,CAAA,IAAA,CAAA;AAAA,GACvB,CAAA;AACF,CAAA;AAEO,SAAS,cAAA,CAAe,IAAY,WAAuD,EAAA;AAChG,EAAO,OAAA;AAAA,IACL,MAAM,CAAG,EAAA,YAAY,CAAQ,KAAA,EAAA,EAAE,gBAAgB,WAAW,CAAA,CAAA;AAAA,GAC5D,CAAA;AACF,CAAA;AAEO,SAAS,OAAO,EAAsC,EAAA;AAC3D,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,EAAG,YAAY,CAAA,QAAA,EAAW,EAAE,CAAA,CAAA;AAAA,GACpC,CAAA;AACF,CAAA;AAEO,SAAS,WAA6C,GAAA;AAC3D,EAAO,OAAA;AAAA,IACL,IAAA,EAAM,GAAG,YAAY,CAAA,OAAA,CAAA;AAAA,GACvB,CAAA;AACF,CAAA;AAEO,SAAS,iBAAA,CAAkB,IAAY,WAA0D,EAAA;AACtG,EAAO,OAAA;AAAA,IACL,MAAM,CAAG,EAAA,YAAY,CAAW,QAAA,EAAA,EAAE,gBAAgB,WAAW,CAAA,CAAA;AAAA,GAC/D,CAAA;AACF,CAAA;;;ACzCO,SAAS,SAAS,YAAyD,EAAA;AAChF,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,EAAG,IAAI,CAAA,WAAA,EAAc,YAAY,CAAA,CAAA;AAAA,GACzC,CAAA;AACF,CAAA;AAEO,SAAS,aAAwD,GAAA;AACtE,EAAO,OAAA;AAAA,IACL,IAAA,EAAM,GAAG,IAAI,CAAA,UAAA,CAAA;AAAA,GACf,CAAA;AACF,CAAA;;;ACVO,SAAS,KAAK,aAA+C,EAAA;AAClE,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,EAAG,IAAI,CAAA,MAAA,EAAS,aAAa,CAAA,CAAA;AAAA,GACrC,CAAA;AACF,CAAA;;;ACJO,SAAS,QAAQ,SAA8C,EAAA;AACpE,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,EAAG,WAAW,CAAA,CAAA,EAAI,SAAS,CAAA,CAAA;AAAA,GACnC,CAAA;AACF,CAAA;AAEO,SAAS,WAAA,CAAY,WAAmB,MAA+C,EAAA;AAC5F,EAAO,OAAA;AAAA,IACL,MAAM,CAAG,EAAA,WAAW,CAAI,CAAA,EAAA,SAAS,SAAS,MAAM,CAAA,CAAA;AAAA,GAClD,CAAA;AACF,CAAA;AAEO,SAAS,wBAAA,CACd,WACA,MAC4C,EAAA;AAC5C,EAAO,OAAA;AAAA,IACL,MAAM,CAAG,EAAA,WAAW,CAAI,CAAA,EAAA,SAAS,SAAS,MAAM,CAAA,eAAA,CAAA;AAAA,GAClD,CAAA;AACF,CAAA;AAEO,SAAS,gBAAA,CAAiB,WAAmB,MAA+C,EAAA;AACjG,EAAO,OAAA;AAAA,IACL,MAAM,CAAG,EAAA,WAAW,CAAI,CAAA,EAAA,SAAS,SAAS,MAAM,CAAA,MAAA,CAAA;AAAA,GAClD,CAAA;AACF,CAAA;;;ACpBA,IAAM,EAAK,GAAA;AAAA;AAAA,EAET,GAAA;AAAA,EACA,QAAA;AAAA;AAAA,EAEA,OAAA;AAAA,EACA,MAAA;AAAA;AAAA,EAEA,QAAA;AAAA;AAAA,EAEA,cAAA;AAAA,EACA,KAAA;AAAA;AAAA,EAEA,QAAA;AAAA,EACA,aAAA;AAAA;AAAA,EAEA,IAAA;AAAA;AAAA,EAEA,OAAA;AAAA,EACA,WAAA;AAAA,EACA,wBAAA;AAAA,EACA,gBAAA;AAAA;AAAA,EAEA,GAAA;AAAA,EACA,QAAA;AAAA,EACA,cAAA;AAAA,EACA,MAAA;AAAA,EACA,WAAA;AAAA,EACA,iBAAA;AACF","file":"index.js","sourcesContent":["export const base = 'd3/data';\r\n\r\nexport const profileBase = `d3/profile`;\r\n\r\n//Why is the game data APIs base root the reverse of the regular base?\r\nexport const gameDataBase = `data/d3`;\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","import type { Resource } from '@blizzard-api/core';\r\nimport { base } from '../base';\r\nimport type { ActIndexResponse, ActResponse } from './types';\r\n\r\nexport function act(actId: number): Resource<ActResponse> {\r\n  return {\r\n    path: `${base}/act/${actId}`,\r\n  };\r\n}\r\n\r\nexport function actIndex(): Resource<ActIndexResponse> {\r\n  return {\r\n    path: `${base}/act`,\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { base } from '../base';\r\nimport type { ArtisanResponse, RecipeResponse } from './types';\r\n\r\nexport function artisan(artisanSlug: string): Resource<ArtisanResponse> {\r\n  return {\r\n    path: `${base}/artisan/${artisanSlug}`,\r\n  };\r\n}\r\n\r\nexport function recipe(artisanSlug: string, recipeSlug: string): Resource<RecipeResponse> {\r\n  return {\r\n    path: `${base}/artisan/${artisanSlug}/recipe/${recipeSlug}`,\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { base } from '../base';\r\nimport type { CharacterClassResponse, SkillResponse } from './types';\r\n\r\nexport function characterClass(characterClassSlug: string): Resource<CharacterClassResponse> {\r\n  return {\r\n    path: `${base}/character-class/${characterClassSlug}`,\r\n  };\r\n}\r\n\r\nexport function skill(characterClassSlug: string, skillSlug: string): Resource<SkillResponse> {\r\n  return {\r\n    path: `${base}/hero/${characterClassSlug}/skill/${skillSlug}`,\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { base } from '../base';\r\nimport type { FollowerResponse } from './types';\r\n\r\nexport function follower(followerSlug: string): Resource<FollowerResponse> {\r\n  return {\r\n    path: `${base}/follower/${followerSlug}`,\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { gameDataBase } from '../base';\r\nimport type {\r\n  EraIndexResponse,\r\n  EraLeaderboardResponse,\r\n  EraResponse,\r\n  SeasonIndexResponse,\r\n  SeasonLeaderboardResponse,\r\n  SeasonResponse,\r\n} from './types';\r\n\r\nexport function era(id: number): Resource<EraResponse> {\r\n  return {\r\n    path: `${gameDataBase}/era/${id}`,\r\n  };\r\n}\r\n\r\nexport function eraIndex(): Resource<EraIndexResponse> {\r\n  return {\r\n    path: `${gameDataBase}/era`,\r\n  };\r\n}\r\n\r\nexport function eraLeaderboard(id: number, leaderboard: string): Resource<EraLeaderboardResponse> {\r\n  return {\r\n    path: `${gameDataBase}/era/${id}/leaderboard/${leaderboard}`,\r\n  };\r\n}\r\n\r\nexport function season(id: number): Resource<SeasonResponse> {\r\n  return {\r\n    path: `${gameDataBase}/season/${id}`,\r\n  };\r\n}\r\n\r\nexport function seasonIndex(): Resource<SeasonIndexResponse> {\r\n  return {\r\n    path: `${gameDataBase}/season`,\r\n  };\r\n}\r\n\r\nexport function seasonLeaderboard(id: number, leaderboard: string): Resource<SeasonLeaderboardResponse> {\r\n  return {\r\n    path: `${gameDataBase}/season/${id}/leaderboard/${leaderboard}`,\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { base } from '../base';\r\nimport type { ItemTypeIndexResponse, ItemTypeResponse } from './types';\r\n\r\nexport function itemType(itemTypeSlug: string): Resource<Array<ItemTypeResponse>> {\r\n  return {\r\n    path: `${base}/item-type/${itemTypeSlug}`,\r\n  };\r\n}\r\n\r\nexport function itemTypeIndex(): Resource<Array<ItemTypeIndexResponse>> {\r\n  return {\r\n    path: `${base}/item-type`,\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { base } from '../base';\r\nimport type { ItemResponse } from './types';\r\n\r\nexport function item(itemSlugAndId: string): Resource<ItemResponse> {\r\n  return {\r\n    path: `${base}/item/${itemSlugAndId}`,\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { profileBase } from '../base';\r\nimport type { AccountHeroFollowerItemsResponse, AccountHeroResponse, AccountResponse } from './types';\r\n\r\nexport function account(battleTag: string): Resource<AccountResponse> {\r\n  return {\r\n    path: `${profileBase}/${battleTag}`,\r\n  };\r\n}\r\n\r\nexport function accountHero(battleTag: string, heroId: number): Resource<AccountHeroResponse> {\r\n  return {\r\n    path: `${profileBase}/${battleTag}/hero/${heroId}`,\r\n  };\r\n}\r\n\r\nexport function accountHeroFollowerItems(\r\n  battleTag: string,\r\n  heroId: number,\r\n): Resource<AccountHeroFollowerItemsResponse> {\r\n  return {\r\n    path: `${profileBase}/${battleTag}/hero/${heroId}/follower-items`,\r\n  };\r\n}\r\n\r\nexport function accountHeroItems(battleTag: string, heroId: number): Resource<AccountHeroResponse> {\r\n  return {\r\n    path: `${profileBase}/${battleTag}/hero/${heroId}/items`,\r\n  };\r\n}\r\n","import { act, actIndex } from './act/act';\r\nimport { artisan, recipe } from './artisan-and-recipe/artisan-and-recipe';\r\nimport { characterClass, skill } from './character-class-and-skill/character-class-and-skill';\r\nimport { follower } from './follower/follower';\r\nimport { era, eraIndex, eraLeaderboard, season, seasonIndex, seasonLeaderboard } from './game-data/game-data';\r\nimport { itemType, itemTypeIndex } from './item-type/item-type';\r\nimport { item } from './item/item';\r\nimport { account, accountHero, accountHeroFollowerItems, accountHeroItems } from './profile/profile';\r\n\r\nconst d3 = {\r\n  //Act\r\n  act,\r\n  actIndex,\r\n  //Artisan and Recipe\r\n  artisan,\r\n  recipe,\r\n  //Follower\r\n  follower,\r\n  //Character Class and Skill\r\n  characterClass,\r\n  skill,\r\n  //Item Type\r\n  itemType,\r\n  itemTypeIndex,\r\n  //Item\r\n  item,\r\n  //Profile\r\n  account,\r\n  accountHero,\r\n  accountHeroFollowerItems,\r\n  accountHeroItems,\r\n  //Game Data\r\n  era,\r\n  eraIndex,\r\n  eraLeaderboard,\r\n  season,\r\n  seasonIndex,\r\n  seasonLeaderboard,\r\n};\r\nexport { d3, d3 as default };\r\n\r\n//Act\r\nexport * from './act/act';\r\nexport type * from './act/types';\r\n//Artisan and Recipe\r\nexport * from './artisan-and-recipe/artisan-and-recipe';\r\nexport type * from './artisan-and-recipe/types';\r\n//Character Class and Skill\r\nexport * from './character-class-and-skill/character-class-and-skill';\r\nexport type * from './character-class-and-skill/types';\r\n//Follower\r\nexport * from './follower/follower';\r\nexport type * from './follower/types';\r\n//Game Data\r\nexport * from './game-data/game-data';\r\nexport type * from './game-data/types';\r\n//Item\r\nexport * from './item/item';\r\nexport type * from './item/types';\r\n//Item Type\r\nexport * from './item-type/item-type';\r\nexport type * from './item-type/types';\r\n//Profile\r\nexport * from './profile/profile';\r\nexport type * from './profile/types';\r\n"]}
+{"version":3,"sources":["../src/base.ts","../src/act/act.ts","../src/artisan-and-recipe/artisan-and-recipe.ts","../src/character-class-and-skill/character-class-and-skill.ts","../src/follower/follower.ts","../src/game-data/game-data.ts","../src/item-type/item-type.ts","../src/item/item.ts","../src/profile/profile.ts","../src/index.ts"],"names":[],"mappings":";AAAO,IAAM,IAAO,GAAA,SAAA,CAAA;AAEb,IAAM,WAAc,GAAA,CAAA,UAAA,CAAA,CAAA;AAGpB,IAAM,YAAe,GAAA,CAAA,OAAA,CAAA,CAAA;;;ACIrB,SAAS,IAAI,KAAsC,EAAA;AACxD,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,EAAG,IAAI,CAAA,KAAA,EAAQ,KAAK,CAAA,CAAA;AAAA,GAC5B,CAAA;AACF,CAAA;AAMO,SAAS,QAAuC,GAAA;AACrD,EAAO,OAAA;AAAA,IACL,IAAA,EAAM,GAAG,IAAI,CAAA,IAAA,CAAA;AAAA,GACf,CAAA;AACF,CAAA;;;ACdO,SAAS,QAAQ,WAAgD,EAAA;AACtE,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,EAAG,IAAI,CAAA,SAAA,EAAY,WAAW,CAAA,CAAA;AAAA,GACtC,CAAA;AACF,CAAA;AAQO,SAAS,MAAA,CAAO,aAAqB,UAA8C,EAAA;AACxF,EAAO,OAAA;AAAA,IACL,MAAM,CAAG,EAAA,IAAI,CAAY,SAAA,EAAA,WAAW,WAAW,UAAU,CAAA,CAAA;AAAA,GAC3D,CAAA;AACF,CAAA;;;AChBO,SAAS,eAAe,kBAA8D,EAAA;AAC3F,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,EAAG,IAAI,CAAA,iBAAA,EAAoB,kBAAkB,CAAA,CAAA;AAAA,GACrD,CAAA;AACF,CAAA;AAQO,SAAS,KAAA,CAAM,oBAA4B,SAA4C,EAAA;AAC5F,EAAO,OAAA;AAAA,IACL,MAAM,CAAG,EAAA,IAAI,CAAS,MAAA,EAAA,kBAAkB,UAAU,SAAS,CAAA,CAAA;AAAA,GAC7D,CAAA;AACF,CAAA;;;AChBO,SAAS,SAAS,YAAkD,EAAA;AACzE,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,EAAG,IAAI,CAAA,UAAA,EAAa,YAAY,CAAA,CAAA;AAAA,GACxC,CAAA;AACF,CAAA;;;ACGO,SAAS,IAAI,EAAmC,EAAA;AACrD,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,EAAG,YAAY,CAAA,KAAA,EAAQ,EAAE,CAAA,CAAA;AAAA,GACjC,CAAA;AACF,CAAA;AAMO,SAAS,QAAuC,GAAA;AACrD,EAAO,OAAA;AAAA,IACL,IAAA,EAAM,GAAG,YAAY,CAAA,IAAA,CAAA;AAAA,GACvB,CAAA;AACF,CAAA;AAQO,SAAS,cAAA,CAAe,IAAY,WAAuD,EAAA;AAChG,EAAO,OAAA;AAAA,IACL,MAAM,CAAG,EAAA,YAAY,CAAQ,KAAA,EAAA,EAAE,gBAAgB,WAAW,CAAA,CAAA;AAAA,GAC5D,CAAA;AACF,CAAA;AAOO,SAAS,OAAO,EAAsC,EAAA;AAC3D,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,EAAG,YAAY,CAAA,QAAA,EAAW,EAAE,CAAA,CAAA;AAAA,GACpC,CAAA;AACF,CAAA;AAMO,SAAS,WAA6C,GAAA;AAC3D,EAAO,OAAA;AAAA,IACL,IAAA,EAAM,GAAG,YAAY,CAAA,OAAA,CAAA;AAAA,GACvB,CAAA;AACF,CAAA;AAQO,SAAS,iBAAA,CAAkB,IAAY,WAA0D,EAAA;AACtG,EAAO,OAAA;AAAA,IACL,MAAM,CAAG,EAAA,YAAY,CAAW,QAAA,EAAA,EAAE,gBAAgB,WAAW,CAAA,CAAA;AAAA,GAC/D,CAAA;AACF,CAAA;;;AClEO,SAAS,SAAS,YAAyD,EAAA;AAChF,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,EAAG,IAAI,CAAA,WAAA,EAAc,YAAY,CAAA,CAAA;AAAA,GACzC,CAAA;AACF,CAAA;AAMO,SAAS,aAAwD,GAAA;AACtE,EAAO,OAAA;AAAA,IACL,IAAA,EAAM,GAAG,IAAI,CAAA,UAAA,CAAA;AAAA,GACf,CAAA;AACF,CAAA;;;ACdO,SAAS,KAAK,aAA+C,EAAA;AAClE,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,EAAG,IAAI,CAAA,MAAA,EAAS,aAAa,CAAA,CAAA;AAAA,GACrC,CAAA;AACF,CAAA;;;ACJO,SAAS,QAAQ,SAA8C,EAAA;AACpE,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,EAAG,WAAW,CAAA,CAAA,EAAI,SAAS,CAAA,CAAA;AAAA,GACnC,CAAA;AACF,CAAA;AAQO,SAAS,WAAA,CAAY,WAAmB,MAA+C,EAAA;AAC5F,EAAO,OAAA;AAAA,IACL,MAAM,CAAG,EAAA,WAAW,CAAI,CAAA,EAAA,SAAS,SAAS,MAAM,CAAA,CAAA;AAAA,GAClD,CAAA;AACF,CAAA;AAQO,SAAS,wBAAA,CACd,WACA,MAC4C,EAAA;AAC5C,EAAO,OAAA;AAAA,IACL,MAAM,CAAG,EAAA,WAAW,CAAI,CAAA,EAAA,SAAS,SAAS,MAAM,CAAA,eAAA,CAAA;AAAA,GAClD,CAAA;AACF,CAAA;AAQO,SAAS,gBAAA,CAAiB,WAAmB,MAA+C,EAAA;AACjG,EAAO,OAAA;AAAA,IACL,MAAM,CAAG,EAAA,WAAW,CAAI,CAAA,EAAA,SAAS,SAAS,MAAM,CAAA,MAAA,CAAA;AAAA,GAClD,CAAA;AACF,CAAA;;;AC3CA,IAAM,EAAK,GAAA;AAAA;AAAA,EAET,GAAA;AAAA,EACA,QAAA;AAAA;AAAA,EAEA,OAAA;AAAA,EACA,MAAA;AAAA;AAAA,EAEA,QAAA;AAAA;AAAA,EAEA,cAAA;AAAA,EACA,KAAA;AAAA;AAAA,EAEA,QAAA;AAAA,EACA,aAAA;AAAA;AAAA,EAEA,IAAA;AAAA;AAAA,EAEA,OAAA;AAAA,EACA,WAAA;AAAA,EACA,wBAAA;AAAA,EACA,gBAAA;AAAA;AAAA,EAEA,GAAA;AAAA,EACA,QAAA;AAAA,EACA,cAAA;AAAA,EACA,MAAA;AAAA,EACA,WAAA;AAAA,EACA,iBAAA;AACF,EAAA;AACA,IAAO,WAAQ,GAAA","file":"index.js","sourcesContent":["export const base = 'd3/data';\r\n\r\nexport const profileBase = `d3/profile`;\r\n\r\n//Why is the game data APIs base root the reverse of the regular base?\r\nexport const gameDataBase = `data/d3`;\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","import type { Resource } from '@blizzard-api/core';\r\nimport { base } from '../base';\r\nimport type { ActIndexResponse, ActResponse } from './types';\r\n\r\n/**\r\n * Returns the act information for the specified act ID.\r\n * @param actId The ID of the act.\r\n * @returns The act resource. See {@link ActResponse}.\r\n */\r\nexport function act(actId: number): Resource<ActResponse> {\r\n  return {\r\n    path: `${base}/act/${actId}`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the index of acts.\r\n * @returns The act index resource. See {@link ActIndexResponse}.\r\n */\r\nexport function actIndex(): Resource<ActIndexResponse> {\r\n  return {\r\n    path: `${base}/act`,\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { base } from '../base';\r\nimport type { ArtisanResponse, RecipeResponse } from './types';\r\n\r\n/**\r\n * Returns the artisan information for the specified artisan slug.\r\n * @param artisanSlug The slug of the artisan.\r\n * @returns The artisan resource. See {@link ArtisanResponse}.\r\n */\r\nexport function artisan(artisanSlug: string): Resource<ArtisanResponse> {\r\n  return {\r\n    path: `${base}/artisan/${artisanSlug}`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the recipe information for the specified artisan and recipe slugs.\r\n * @param artisanSlug The slug of the artisan.\r\n * @param recipeSlug The slug of the recipe.\r\n * @returns The recipe resource. See {@link RecipeResponse}.\r\n */\r\nexport function recipe(artisanSlug: string, recipeSlug: string): Resource<RecipeResponse> {\r\n  return {\r\n    path: `${base}/artisan/${artisanSlug}/recipe/${recipeSlug}`,\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { base } from '../base';\r\nimport type { CharacterClassResponse, SkillResponse } from './types';\r\n\r\n/**\r\n * Returns the character class information for the specified character class slug.\r\n * @param characterClassSlug The slug of the character class.\r\n * @returns The character class resource. See {@link CharacterClassResponse}.\r\n */\r\nexport function characterClass(characterClassSlug: string): Resource<CharacterClassResponse> {\r\n  return {\r\n    path: `${base}/character-class/${characterClassSlug}`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the skill information for the specified character class and skill slugs.\r\n * @param characterClassSlug The slug of the character class.\r\n * @param skillSlug The slug of the skill.\r\n * @returns The skill resource. See {@link SkillResponse}.\r\n */\r\nexport function skill(characterClassSlug: string, skillSlug: string): Resource<SkillResponse> {\r\n  return {\r\n    path: `${base}/hero/${characterClassSlug}/skill/${skillSlug}`,\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { base } from '../base';\r\nimport type { FollowerResponse } from './types';\r\n\r\n/**\r\n * Returns the follower information for the specified follower slug.\r\n * @param followerSlug The slug of the follower.\r\n * @returns The follower resource. See {@link FollowerResponse}.\r\n */\r\nexport function follower(followerSlug: string): Resource<FollowerResponse> {\r\n  return {\r\n    path: `${base}/follower/${followerSlug}`,\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { gameDataBase } from '../base';\r\nimport type {\r\n  EraIndexResponse,\r\n  EraLeaderboardResponse,\r\n  EraResponse,\r\n  SeasonIndexResponse,\r\n  SeasonLeaderboardResponse,\r\n  SeasonResponse,\r\n} from './types';\r\n\r\n/**\r\n * Returns the era information for the specified era ID.\r\n * @param id The ID of the era.\r\n * @returns The era resource. See {@link EraResponse}.\r\n */\r\nexport function era(id: number): Resource<EraResponse> {\r\n  return {\r\n    path: `${gameDataBase}/era/${id}`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the era index.\r\n * @returns The era index resource. See {@link EraIndexResponse}.\r\n */\r\nexport function eraIndex(): Resource<EraIndexResponse> {\r\n  return {\r\n    path: `${gameDataBase}/era`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the era leaderboard for the specified era ID and leaderboard.\r\n * @param id The ID of the era.\r\n * @param leaderboard The name of the leaderboard.\r\n * @returns The era leaderboard resource. See {@link EraLeaderboardResponse}.\r\n */\r\nexport function eraLeaderboard(id: number, leaderboard: string): Resource<EraLeaderboardResponse> {\r\n  return {\r\n    path: `${gameDataBase}/era/${id}/leaderboard/${leaderboard}`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the season information for the specified season ID.\r\n * @param id The ID of the season.\r\n * @returns The season resource. See {@link SeasonResponse}.\r\n */\r\nexport function season(id: number): Resource<SeasonResponse> {\r\n  return {\r\n    path: `${gameDataBase}/season/${id}`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the season index.\r\n * @returns The season index resource. See {@link SeasonIndexResponse}.\r\n */\r\nexport function seasonIndex(): Resource<SeasonIndexResponse> {\r\n  return {\r\n    path: `${gameDataBase}/season`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the season leaderboard for the specified season ID and leaderboard.\r\n * @param id The ID of the season.\r\n * @param leaderboard The name of the leaderboard.\r\n * @returns The season leaderboard resource. See {@link SeasonLeaderboardResponse}.\r\n */\r\nexport function seasonLeaderboard(id: number, leaderboard: string): Resource<SeasonLeaderboardResponse> {\r\n  return {\r\n    path: `${gameDataBase}/season/${id}/leaderboard/${leaderboard}`,\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { base } from '../base';\r\nimport type { ItemTypeIndexResponse, ItemTypeResponse } from './types';\r\n\r\n/**\r\n * Returns the item type information for the specified item type slug.\r\n * @param itemTypeSlug The slug of the item type, example: \"sword2h\"\r\n * @returns The item type resource. See {@link ItemTypeResponse}.\r\n */\r\nexport function itemType(itemTypeSlug: string): Resource<Array<ItemTypeResponse>> {\r\n  return {\r\n    path: `${base}/item-type/${itemTypeSlug}`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the item type index.\r\n * @returns The item type index resource. See {@link ItemTypeIndexResponse}.\r\n */\r\nexport function itemTypeIndex(): Resource<Array<ItemTypeIndexResponse>> {\r\n  return {\r\n    path: `${base}/item-type`,\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { base } from '../base';\r\nimport type { ItemResponse } from './types';\r\n\r\n/**\r\n * Returns the item information for the specified item slug and ID.\r\n * @param itemSlugAndId The slug and ID of the item, example: \"corrupted-ashbringer-Unique_Sword_2H_104_x1\".\r\n * @returns The item resource. See {@link ItemResponse}.\r\n */\r\nexport function item(itemSlugAndId: string): Resource<ItemResponse> {\r\n  return {\r\n    path: `${base}/item/${itemSlugAndId}`,\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { profileBase } from '../base';\r\nimport type { AccountHeroFollowerItemsResponse, AccountHeroResponse, AccountResponse } from './types';\r\n\r\n/**\r\n * Returns the account information for the specified battle tag.\r\n * @param battleTag The battle tag of the account.\r\n * @returns The account resource. See {@link AccountResponse}.\r\n */\r\nexport function account(battleTag: string): Resource<AccountResponse> {\r\n  return {\r\n    path: `${profileBase}/${battleTag}`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the hero information for the specified battle tag and hero ID.\r\n * @param battleTag The battle tag of the account.\r\n * @param heroId The ID of the hero.\r\n * @returns The hero resource. See {@link AccountHeroResponse}.\r\n */\r\nexport function accountHero(battleTag: string, heroId: number): Resource<AccountHeroResponse> {\r\n  return {\r\n    path: `${profileBase}/${battleTag}/hero/${heroId}`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the follower items for the specified battle tag and hero ID.\r\n * @param battleTag The battle tag of the account.\r\n * @param heroId The ID of the hero.\r\n * @returns The follower items resource. See {@link AccountHeroFollowerItemsResponse}.\r\n */\r\nexport function accountHeroFollowerItems(\r\n  battleTag: string,\r\n  heroId: number,\r\n): Resource<AccountHeroFollowerItemsResponse> {\r\n  return {\r\n    path: `${profileBase}/${battleTag}/hero/${heroId}/follower-items`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the items for the specified battle tag and hero ID.\r\n * @param battleTag The battle tag of the account.\r\n * @param heroId The ID of the hero.\r\n * @returns The hero items resource. See {@link AccountHeroResponse}.\r\n */\r\nexport function accountHeroItems(battleTag: string, heroId: number): Resource<AccountHeroResponse> {\r\n  return {\r\n    path: `${profileBase}/${battleTag}/hero/${heroId}/items`,\r\n  };\r\n}\r\n","import { act, actIndex } from './act/act';\r\nimport { artisan, recipe } from './artisan-and-recipe/artisan-and-recipe';\r\nimport { characterClass, skill } from './character-class-and-skill/character-class-and-skill';\r\nimport { follower } from './follower/follower';\r\nimport { era, eraIndex, eraLeaderboard, season, seasonIndex, seasonLeaderboard } from './game-data/game-data';\r\nimport { itemType, itemTypeIndex } from './item-type/item-type';\r\nimport { item } from './item/item';\r\nimport { account, accountHero, accountHeroFollowerItems, accountHeroItems } from './profile/profile';\r\n\r\nconst d3 = {\r\n  //Act\r\n  act,\r\n  actIndex,\r\n  //Artisan and Recipe\r\n  artisan,\r\n  recipe,\r\n  //Follower\r\n  follower,\r\n  //Character Class and Skill\r\n  characterClass,\r\n  skill,\r\n  //Item Type\r\n  itemType,\r\n  itemTypeIndex,\r\n  //Item\r\n  item,\r\n  //Profile\r\n  account,\r\n  accountHero,\r\n  accountHeroFollowerItems,\r\n  accountHeroItems,\r\n  //Game Data\r\n  era,\r\n  eraIndex,\r\n  eraLeaderboard,\r\n  season,\r\n  seasonIndex,\r\n  seasonLeaderboard,\r\n};\r\nexport default d3;\r\nexport { d3 };\r\n\r\n//Act\r\nexport * from './act/act';\r\nexport type * from './act/types';\r\n//Artisan and Recipe\r\nexport * from './artisan-and-recipe/artisan-and-recipe';\r\nexport type * from './artisan-and-recipe/types';\r\n//Character Class and Skill\r\nexport * from './character-class-and-skill/character-class-and-skill';\r\nexport type * from './character-class-and-skill/types';\r\n//Follower\r\nexport * from './follower/follower';\r\nexport type * from './follower/types';\r\n//Game Data\r\nexport * from './game-data/game-data';\r\nexport type * from './game-data/types';\r\n//Item\r\nexport * from './item/item';\r\nexport type * from './item/types';\r\n//Item Type\r\nexport * from './item-type/item-type';\r\nexport type * from './item-type/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/d3",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "license": "MIT",
   "author": "Putro",
   "description": "A series of helpers to interact with the Diablo 3 Blizzard API",
@@ -34,10 +34,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",